zng_app::widget::info

Struct WidgetInfoTree

source
pub struct WidgetInfoTree(/* private fields */);
Expand description

A tree of WidgetInfo.

The tree is behind an Arc pointer so cloning and storing this type is very cheap.

Instantiated using WidgetInfoBuilder.

Implementations§

source§

impl WidgetInfoTree

source

pub fn access_enabled(&self) -> AccessEnabled

If this tree contains accessibility information.

If accessibility is enabled for the window and will stay enabled for its lifetime.

source

pub fn to_access_tree(&self) -> AccessTree

Build an access tree from the info tree.

If not access_enabled returns a placeholder tree with only the root node.

source

pub fn to_access_updates(&self, prev_tree: &Self) -> Option<AccessTreeUpdate>

Build partial or full access trees for updated widgets.

Returns None if not access_enabled or no access info has changed. The focused value is always set to the root ID, it must be changed to the correct focused widget.

This is usually called by window implementers just after the next frame after info rebuild. Note that these updates will also include to_access_updates_bounds.

source

pub fn to_access_updates_bounds(&self) -> Option<AccessTreeUpdate>

Build partial access trees for widgets that changed transform, size or visibility.

Returns None if not access_enabled or no transform/visibility changed. The focused value is always set to the root ID, it must be changed to the correct focused widget.

This is usually called by window implementers after each frame that is not to_access_updates.

source§

impl WidgetInfoTree

source

pub fn wgt(window_id: WindowId, root_id: WidgetId) -> Self

Blank window that contains only the root widget taking no space.

source

pub fn stats(&self) -> WidgetInfoTreeStats

Statistics abound the info tree.

source

pub fn scale_factor(&self) -> Factor

Scale factor of the last rendered frame.

source

pub fn view_process_gen(&self) -> ViewProcessGen

View-process generation.

Is ViewProcessGen::INVALID before first render and in headless apps.

source

pub fn build_meta(&self) -> StateMapRef<'_, WidgetInfoMeta>

Custom metadata associated with the tree during info build.

Any widget (that was not reused) can have inserted metadata.

source

pub fn root(&self) -> WidgetInfo

Reference to the root widget in the tree.

source

pub fn all_widgets(&self) -> TreeIter

All widgets including root.

source

pub fn window_id(&self) -> WindowId

Id of the window that owns all widgets represented in the tree.

source

pub fn get(&self, widget_id: impl Into<WidgetId>) -> Option<WidgetInfo>

Reference to the widget in the tree, if it is present.

source

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

If the tree contains the widget.

source

pub fn get_or_parent(&self, path: &WidgetPath) -> Option<WidgetInfo>

Reference to the widget or first parent that is present.

source

pub fn is_rendered(&self) -> bool

If the widgets in this tree have been rendered at least once, after the first render the widget bounds info are always up-to-date and spatial queries can be made on the widgets.

source

pub fn out_of_bounds(&self) -> impl ExactSizeIterator<Item = WidgetInfo>

Iterator over all widgets with inner-bounds not fully contained by their parent inner bounds.

source

pub fn spatial_bounds(&self) -> PxRect

Gets the bounds box that envelops all widgets, including the out-of-bounds widgets.

source

pub fn len(&self) -> usize

Total number of widgets in the tree.

Is never zero, every tree has at least the root widget.

Trait Implementations§

source§

impl Clone for WidgetInfoTree

source§

fn clone(&self) -> WidgetInfoTree

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for WidgetInfoTree

source§

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

Formats the value using the given formatter. Read more
source§

impl PartialEq for WidgetInfoTree

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

impl Eq for WidgetInfoTree

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> AnyVarValue for T
where T: VarValue,

source§

fn as_any(&self) -> &(dyn Any + 'static)

Access to dyn Any methods.
source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Access to mut dyn Any methods.
source§

fn clone_boxed(&self) -> Box<dyn AnyVarValue>

Clone the value.
source§

fn clone_boxed_var(&self) -> Box<dyn AnyVar>

Clone the value into a new boxed LocalVar<Self>.
source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Access to Box<dyn Any> methods.
source§

fn eq_any(&self, other: &(dyn AnyVarValue + 'static)) -> bool

Gets if self equals other.
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> IntoVar<T> for T
where T: VarValue,

source§

type Var = LocalVar<T>

Variable type that will wrap the T value. Read more
source§

fn into_var(self) -> <T as IntoVar<T>>::Var

Converts the source value into a var.
source§

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>
where Self: Sized,

Converts into BoxedVar<T>. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<T> IntoValue<T> for T
where T: VarValue,

source§

impl<T> StateValue for T
where T: Any + Send + Sync,

source§

impl<T> VarValue for T
where T: Debug + Clone + PartialEq + Any + Send + Sync,