Struct AccessNode 

pub struct AccessNode { /* private fields */ }

A node of the accessibility tree: a widget, or a part of one (such as a dock’s tab).

Bits a node does not support are not asked of it: AccessNode::add_action says which requests it handles.

Implementations

impl AccessNode

pub fn new(role: Role) -> Self

A node with role.

pub fn set_role(&mut self, role: Role)

Sets what the node is.

pub fn set_label(&mut self, label: impl Into<String>)

Sets its name, such as a button’s text. Static text goes in set_value.

pub fn set_value(&mut self, value: impl Into<String>)

Sets its text content: a label’s text, a text input’s text.

pub fn set_bounds(&mut self, bounds: Rect)

Sets where it is, in physical pixels from the window’s top-left corner (a widget’s node starts with the widget’s rectangle).

pub fn add_action(&mut self, action: AccessAction)

Says it handles action.

pub fn set_selected(&mut self, selected: bool)

Sets whether it is the chosen one of its kind, such as the shown tab.

pub fn set_checked(&mut self, checked: bool)

Sets whether it is on, for something that is on or off (a check menu item).

pub fn set_expanded(&mut self, expanded: bool)

Sets whether what it opens is open, for something that opens more (a menu title, an item with a submenu).

pub fn checked(&self) -> Option<bool>

Whether it is on, if it is something that is on or off.

pub fn expanded(&self) -> Option<bool>

Whether what it opens is open, if it opens something.

pub fn set_disabled(&mut self, disabled: bool)

Sets whether it is unavailable.

pub fn set_focused_part(&mut self, part: u32)

Says which of its parts has keyboard focus while the widget does (such as a dock’s chosen tab), so assistive technology reads that part rather than the whole widget.

pub fn focused_part(&self) -> Option<u32>

The part with keyboard focus while the widget has it.

pub fn push_part(&mut self, part: u32, node: AccessNode)

Adds node as a part of this one, numbered part: a piece that is not a widget of its own, such as a tab of a dock. Requests for it come to the widget with that number. Parts come before the widget’s children. Numbers must be unique within the widget, at any depth, and at most MAX_PART; a part breaking either rule is left out. Keep a part’s number while it lasts (number by identity, not by position), or a screen reader tracking it follows another one.

pub fn role(&self) -> Role

What the node is.

pub fn label(&self) -> Option<&str>

Its name.

pub fn value(&self) -> Option<&str>

Its text content.

pub fn bounds(&self) -> Rect

Where it is, in physical pixels.

pub fn has_action(&self, action: AccessAction) -> bool

Whether it handles action.

pub fn actions(&self) -> impl Iterator<Item = AccessAction> + '_

The actions it handles.

pub fn selected(&self) -> Option<bool>

Whether it is the chosen one of its kind, if that applies.

pub fn is_disabled(&self) -> bool

Whether it is unavailable.

pub fn clips_children(&self) -> bool

Whether it cuts off its children where they leave its bounds (it scrolls or clips), so children outside it are off screen.

pub fn set_clips_children(&mut self, clips: bool)

Sets whether it cuts off its children where they leave its bounds (a widget’s node starts with this set when its style clips or scrolls).

pub fn set_placeholder(&mut self, placeholder: impl Into<String>)

Sets the hint shown while it is empty, such as a text input’s placeholder.

pub fn placeholder(&self) -> Option<&str>

The hint shown while it is empty.

pub fn children(&self) -> &[AccessId]

Its children in the tree, in order (filled in by the Ui).

Trait Implementations

impl Clone for AccessNode

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AccessNode

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

Formats the value using the given formatter.

impl Default for AccessNode

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for AccessNode

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AccessNode