Struct accesskit::Node

pub struct Node { /* private fields */ }

A single accessible object. A complete UI is represented as a tree of these.

For brevity, and to make more of the documentation usable in bindings to other languages, documentation of getter methods is written as if documenting fields in a struct, and such methods are referred to as properties.

Implementations

impl Node

pub fn role(&self) -> Role

impl Node

pub fn supports_action(&self, action: Action) -> bool

impl Node

pub fn is_hovered(&self) -> bool

pub fn is_hidden(&self) -> bool

Exclude this node and its descendants from the tree presented to assistive technologies, and from hit testing.

pub fn is_linked(&self) -> bool

pub fn is_multiselectable(&self) -> bool

pub fn is_required(&self) -> bool

pub fn is_visited(&self) -> bool

pub fn is_busy(&self) -> bool

pub fn is_live_atomic(&self) -> bool

pub fn is_modal(&self) -> bool

If a dialog box is marked as explicitly modal.

pub fn is_touch_transparent(&self) -> bool

This element allows touches to be passed through when a screen reader is in touch exploration mode, e.g. a virtual keyboard normally behaves this way.

pub fn is_read_only(&self) -> bool

Use for a textbox that allows focus/selection but not input.

pub fn is_disabled(&self) -> bool

Use for a control or group of controls that disallows input.

pub fn is_bold(&self) -> bool

pub fn is_italic(&self) -> bool

pub fn clips_children(&self) -> bool

Indicates that this node clips its children, i.e. may have overflow: hidden or clip children by default.

pub fn is_line_breaking_object(&self) -> bool

Indicates whether this node causes a hard line-break (e.g. block level elements, or <br>).

pub fn is_page_breaking_object(&self) -> bool

Indicates whether this node causes a page break.

pub fn is_spelling_error(&self) -> bool

pub fn is_grammar_error(&self) -> bool

pub fn is_search_match(&self) -> bool

pub fn is_suggestion(&self) -> bool

impl Node

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

impl Node

pub fn controls(&self) -> &[NodeId]

impl Node

pub fn details(&self) -> &[NodeId]

impl Node

pub fn described_by(&self) -> &[NodeId]

impl Node

pub fn flow_to(&self) -> &[NodeId]

impl Node

pub fn labelled_by(&self) -> &[NodeId]

impl Node

pub fn owns(&self) -> &[NodeId]

As with the aria-owns property in ARIA, this property should be set only if the nodes referenced in the property are not descendants of the owning node in the AccessKit tree. In the common case, where the owned nodes are direct children or indirect descendants, this property is unnecessary.

impl Node

pub fn radio_group(&self) -> &[NodeId]

On radio buttons this should be set to a list of all of the buttons in the same group as this one, including this radio button itself.

impl Node

pub fn active_descendant(&self) -> Option<NodeId>

impl Node

pub fn error_message(&self) -> Option<NodeId>

impl Node

pub fn in_page_link_target(&self) -> Option<NodeId>

impl Node

pub fn member_of(&self) -> Option<NodeId>

impl Node

pub fn next_on_line(&self) -> Option<NodeId>

impl Node

pub fn previous_on_line(&self) -> Option<NodeId>

impl Node

pub fn popup_for(&self) -> Option<NodeId>

impl Node

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

impl Node

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

impl Node

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

impl Node

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

A single character, usually part of this node’s name, that can be pressed, possibly along with a platform-specific modifier, to perform this node’s default action. For menu items, the access key is only active while the menu is active, in contrast with keyboard_shortcut; a single menu item may in fact have both properties.

impl Node

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

A way for application authors to identify this node for automated testing purpose. The value must be unique among this node’s siblings.

impl Node

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

impl Node

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

Only present when different from parent.

impl Node

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

impl Node

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

Inner HTML of an element. Only used for a top-level math element, to support third-party math accessibility products that parse MathML.

impl Node

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

A keystroke or sequence of keystrokes, complete with any required modifiers(s), that will perform this node’s default action. The value of this property should be in a human-friendly format.

impl Node

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

Only present when different from parent.

impl Node

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

If a text input has placeholder text, it should be exposed through this property rather than name.

impl Node

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

An optional string that may override an assistive technology’s description of the node’s role. Only provide this for custom control types. The value of this property should be in a human-friendly, localized format.

impl Node

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

An optional string that may override an assistive technology’s description of the node’s state, replacing default strings such as “checked” or “selected”. Note that most platform accessibility APIs and assistive technologies do not support this feature.

impl Node

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

If a node’s only accessible name comes from a tooltip, it should be exposed through this property rather than name.

impl Node

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

impl Node

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

impl Node

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

impl Node

pub fn scroll_x(&self) -> Option<f64>

impl Node

pub fn scroll_x_min(&self) -> Option<f64>

impl Node

pub fn scroll_x_max(&self) -> Option<f64>

impl Node

pub fn scroll_y(&self) -> Option<f64>

impl Node

pub fn scroll_y_min(&self) -> Option<f64>

impl Node

pub fn scroll_y_max(&self) -> Option<f64>

impl Node

pub fn numeric_value(&self) -> Option<f64>

impl Node

pub fn min_numeric_value(&self) -> Option<f64>

impl Node

pub fn max_numeric_value(&self) -> Option<f64>

impl Node

pub fn numeric_value_step(&self) -> Option<f64>

impl Node

pub fn numeric_value_jump(&self) -> Option<f64>

impl Node

pub fn font_size(&self) -> Option<f64>

Font size is in pixels.

impl Node

pub fn font_weight(&self) -> Option<f64>

Font weight can take on any arbitrary numeric value. Increments of 100 in range [0, 900] represent keywords such as light, normal, bold, etc.

impl Node

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

impl Node

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

impl Node

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

impl Node

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

impl Node

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

impl Node

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

impl Node

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

impl Node

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

impl Node

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

impl Node

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

For Role::ColorWell, specifies the selected color in RGBA.

impl Node

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

Background color in RGBA.

impl Node

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

Foreground color in RGBA.

impl Node

pub fn overline(&self) -> Option<TextDecoration>

impl Node

pub fn strikethrough(&self) -> Option<TextDecoration>

impl Node

pub fn underline(&self) -> Option<TextDecoration>

impl Node

pub fn character_lengths(&self) -> &[u8]

For inline text. The length (non-inclusive) of each character in UTF-8 code units (bytes). The sum of these lengths must equal the length of value, also in bytes.

A character is defined as the smallest unit of text that can be selected. This isn’t necessarily a single Unicode scalar value (code point). This is why AccessKit can’t compute the lengths of the characters from the text itself; this information must be provided by the text editing implementation.

If this node is the last text box in a line that ends with a hard line break, that line break should be included at the end of this node’s value as either a CRLF or LF; in both cases, the line break should be counted as a single character for the sake of this slice. When the caret is at the end of such a line, the focus of the text selection should be on the line break, not after it.

impl Node

pub fn word_lengths(&self) -> &[u8]

For inline text. The length of each word in characters, as defined in character_lengths. The sum of these lengths must equal the length of character_lengths.

The end of each word is the beginning of the next word; there are no characters that are not considered part of a word. Trailing whitespace is typically considered part of the word that precedes it, while a line’s leading whitespace is considered its own word. Whether punctuation is considered a separate word or part of the preceding word depends on the particular text editing implementation. Some editors may have their own definition of a word; for example, in an IDE, words may correspond to programming language tokens.

Not all assistive technologies require information about word boundaries, and not all platform accessibility APIs even expose this information, but for assistive technologies that do use this information, users will get unpredictable results if the word boundaries exposed by the accessibility tree don’t match the editor’s behavior. This is why AccessKit does not determine word boundaries itself.

impl Node

pub fn character_positions(&self) -> Option<&[f32]>

For inline text. This is the position of each character within the node’s bounding box, in the direction given by text_direction, in the coordinate space of this node.

When present, the length of this slice should be the same as the length of character_lengths, including for lines that end with a hard line break. The position of such a line break should be the position where an end-of-paragraph marker would be rendered.

This property is optional. Without it, AccessKit can’t support some use cases, such as screen magnifiers that track the caret position or screen readers that display a highlight cursor. However, most text functionality still works without this information.

impl Node

pub fn character_widths(&self) -> Option<&[f32]>

For inline text. This is the advance width of each character, in the direction given by text_direction, in the coordinate space of this node.

When present, the length of this slice should be the same as the length of character_lengths, including for lines that end with a hard line break. The width of such a line break should be non-zero if selecting the line break by itself results in a visible highlight (as in Microsoft Word), or zero if not (as in Windows Notepad).

This property is optional. Without it, AccessKit can’t support some use cases, such as screen magnifiers that track the caret position or screen readers that display a highlight cursor. However, most text functionality still works without this information.

impl Node

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

Whether this node is expanded, collapsed, or neither.

Setting this to false means the node is collapsed; omitting it means this state isn’t applicable.

impl Node

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

Indicates whether this node is selected or unselected.

The absence of this flag (as opposed to a false setting) means that the concept of “selected” doesn’t apply. When deciding whether to set the flag to false or omit it, consider whether it would be appropriate for a screen reader to announce “not selected”. The ambiguity of this flag in platform accessibility APIs has made extraneous “not selected” announcements a common annoyance.

impl Node

pub fn invalid(&self) -> Option<Invalid>

pub fn toggled(&self) -> Option<Toggled>

pub fn live(&self) -> Option<Live>

pub fn default_action_verb(&self) -> Option<DefaultActionVerb>

pub fn text_direction(&self) -> Option<TextDirection>

pub fn orientation(&self) -> Option<Orientation>

pub fn sort_direction(&self) -> Option<SortDirection>

pub fn aria_current(&self) -> Option<AriaCurrent>

pub fn auto_complete(&self) -> Option<AutoComplete>

pub fn has_popup(&self) -> Option<HasPopup>

pub fn list_style(&self) -> Option<ListStyle>

The list style type. Only available on list items.

pub fn text_align(&self) -> Option<TextAlign>

pub fn vertical_offset(&self) -> Option<VerticalOffset>

impl Node

pub fn transform(&self) -> Option<&Affine>

An affine transform to apply to any coordinates within this node and its descendants, including the bounds property of this node. The combined transforms of this node and its ancestors define the coordinate space of this node. /// This should be None if it would be set to the identity transform, which should be the case for most nodes.

AccessKit expects the final transformed coordinates to be relative to the origin of the tree’s container (e.g. window), in physical pixels, with the y coordinate being top-down.

pub fn bounds(&self) -> Option<Rect>

The bounding box of this node, in the node’s coordinate space. This property does not affect the coordinate space of either this node or its descendants; only the transform property affects that. This, along with the recommendation that most nodes should have a transform of None, implies that the bounds property of most nodes should be in the coordinate space of the nearest ancestor with a non-None transform, or if there is no such ancestor, the tree’s container (e.g. window).

pub fn text_selection(&self) -> Option<&TextSelection>

impl Node

pub fn custom_actions(&self) -> &[CustomAction]

Trait Implementations

impl Clone for Node

fn clone(&self) -> Node

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Node

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

Formats the value using the given formatter.

impl PartialEq for Node

fn eq(&self, other: &Node) -> 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 StructuralPartialEq for Node