Struct FocusInfoTree

pub struct FocusInfoTree { /* private fields */ }

A WidgetInfoTree wrapper for querying focus info out of the widget tree.

Implementations

impl FocusInfoTree

pub fn new( tree: WidgetInfoTree, focus_disabled_widgets: bool, focus_hidden_widgets: bool, ) -> Self

Wrap a widget_info reference to enable focus info querying.

See the FOCUS.focus_disabled_widgets and FOCUS.focus_hidden_widgets config for more details on the parameters.

pub fn tree(&self) -> &WidgetInfoTree

Full widget info.

pub fn focus_disabled_widgets(&self) -> bool

If DISABLED widgets are focusable in this tree.

See the FOCUS.focus_disabled_widgets config for more details.

pub fn focus_hidden_widgets(&self) -> bool

If Hidden widgets are focusable in this tree.

See the FOCUS.focus_hidden_widgets config for more details.

pub fn root(&self) -> WidgetFocusInfo

Reference to the root widget in the tree.

The root is usually a focusable focus scope but it may not be. This is the only method that returns a WidgetFocusInfo that may not be focusable.

pub fn focusable_root(&self) -> Option<WidgetFocusInfo>

Reference the focusable widget closest to the window root.

When the window root is not focusable, but a descendant widget is, this method returns the focusable closest to the root counting previous siblings then parents.

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

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

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

Reference to the first focusable widget or parent in the tree.

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

If the tree info contains the widget and it is focusable.

Trait Implementations

impl Clone for FocusInfoTree

fn clone(&self) -> FocusInfoTree

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FocusInfoTree

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

Formats the value using the given formatter.