Struct zng::widget::info::InteractionPath

pub struct InteractionPath { /* private fields */ }

Represents a WidgetPath annotated with each widget’s Interactivity.

Implementations

impl InteractionPath

pub fn new<P>(window_id: WindowId, path: P) -> InteractionPath

where P: IntoIterator<Item = (WidgetId, Interactivity)>,

New custom path.

pub fn new_enabled( window_id: WindowId, path: Arc<Vec<WidgetId>>, ) -> InteractionPath

New custom path with all widgets enabled.

pub fn from_enabled(path: WidgetPath) -> InteractionPath

New interactivity path with all widgets enabled.

pub fn as_path(&self) -> &WidgetPath

Dereferences to the path.

pub fn blocked_index(&self) -> Option<usize>

Index of first BLOCKED.

pub fn disabled_index(&self) -> Option<usize>

Index of first DISABLED.

pub fn interaction_path(&self) -> impl DoubleEndedIterator + ExactSizeIterator

Interactivity for each widget, root first.

pub fn interactivity_of(&self, widget_id: WidgetId) -> Option<Interactivity>

Search for the interactivity value associated with the widget in the path.

pub fn interactivity(&self) -> Interactivity

Interactivity of the widget.

pub fn zip(&self) -> impl DoubleEndedIterator + ExactSizeIterator

Zip widgets and interactivity.

pub fn unblocked(self) -> Option<InteractionPath>

Gets the ENABLED or DISABLED part of the path, or none if the widget is blocked at the root.

pub fn enabled(self) -> Option<WidgetPath>

Gets the ENABLED part of the path, or none if the widget is not enabled at the root.

pub fn ancestor_path( &self, ancestor_id: WidgetId, ) -> Option<Cow<'_, InteractionPath>>

Make a path to an ancestor id that is contained in the current path.

pub fn shared_ancestor<'a>( &'a self, other: &'a InteractionPath, ) -> Option<Cow<'a, InteractionPath>>

Get the inner most widget parent shared by both self and other with the same interactivity.

pub fn root_path(&self) -> Cow<'_, InteractionPath>

Gets a path to the root widget of this path.

pub fn sub_path(&self, widget_id: WidgetId) -> Option<Cow<'_, InteractionPath>>

Gets a sub-path up to widget_id (inclusive), or None if the widget is not in the path.

Methods from Deref<Target = WidgetPath>

pub fn window_id(&self) -> WindowId

Id of the window that contains the widgets.

pub fn ancestors(&self) -> &[WidgetId]

Widgets that contain widget_id, root first.

pub fn widget_id(&self) -> WidgetId

The widget.

pub fn parent_id(&self) -> Option<WidgetId>

The widget parent, if it is not the root widget.

pub fn widgets_path(&self) -> &[WidgetId]

ancestors and widget_id, root first.

pub fn contains(&self, widget_id: WidgetId) -> bool

If the widget_id is part of the path.

pub fn ancestor_path( &self, ancestor_id: WidgetId, ) -> Option<Cow<'_, WidgetPath>>

Make a path to an ancestor id that is contained in the current path.

pub fn shared_ancestor<'a>( &'a self, other: &'a WidgetPath, ) -> Option<Cow<'a, WidgetPath>>

Get the inner most widget parent shared by both self and other.

pub fn root_path(&self) -> Cow<'_, WidgetPath>

Gets a path to the root widget of this path.

pub fn sub_path(&self, widget_id: WidgetId) -> Option<Cow<'_, WidgetPath>>

Gets a path to the widget_id of this path.

Trait Implementations

impl Clone for InteractionPath

fn clone(&self) -> InteractionPath

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InteractionPath

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for InteractionPath

type Target = WidgetPath

The resulting type after dereferencing.

fn deref(&self) -> &<InteractionPath as Deref>::Target

Dereferences the value.

impl Display for InteractionPath

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<InteractionPath> for WidgetPath

fn from(p: InteractionPath) -> WidgetPath

Converts to this type from the input type.

impl PartialEq<InteractionPath> for WidgetPath

fn eq(&self, other: &InteractionPath) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<WidgetPath> for InteractionPath

fn eq(&self, other: &WidgetPath) -> bool

Paths are equal if the are the same window, widgets and interactivity.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for InteractionPath

fn eq(&self, other: &InteractionPath) -> bool

Paths are equal if the are the same window, widgets and interactivity.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl WidgetPathProvider for InteractionPath

type WidgetIter<'s> = Rev<Copied<Iter<'s, WidgetId>>>

Output of widget_and_ancestors.

fn window_id(&self) -> WindowId

The window parent.

fn widget_and_ancestors( &self, ) -> <InteractionPath as WidgetPathProvider>::WidgetIter<'_>

Iterate over the widget, parent, grandparent, .., root.

impl Eq for InteractionPath