Struct zng_app::widget::info::WidgetPath

pub struct WidgetPath { /* private fields */ }

Full address of a widget.

The path is reference counted, cloning this struct does not alloc.

Implementations

impl WidgetPath

pub fn new(window_id: WindowId, path: Arc<Vec<WidgetId>>) -> WidgetPath

New custom widget path.

pub fn into_parts(self) -> (WindowId, Arc<Vec<WidgetId>>)

Into internal parts.

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 WidgetPath

fn clone(&self) -> WidgetPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WidgetPath

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

Formats the value using the given formatter.

impl Display for WidgetPath

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

Formats the value using the given formatter.

impl From<InteractionPath> for WidgetPath

fn from(p: InteractionPath) -> Self

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 WidgetPath

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

Paths are equal if they share the same window and widget paths.

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 WidgetPath

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) -> Self::WidgetIter<'_>

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

impl Eq for WidgetPath