Struct re_viewer::external::egui_kittest::kittest::Node

pub struct Node<'tree> {
    node: Node<'tree>,
    pub(crate) queue: &'tree Mutex<RawMutex, Vec<Event>>,
}

A node in the accessibility tree. This should correspond to a widget or container in the GUI

Fields

node: Node<'tree>

queue: &'tree Mutex<RawMutex, Vec<Event>>

Implementations

impl<'tree> Node<'tree>

pub fn focus(&self)

Request focus for the node via accesskit

pub fn click(&self)

Click the node via accesskit. This will trigger a [accesskit::Action::Click] action

pub fn hover(&self)

Hover the cursor at the node center

pub fn simulate_click(&self)

Simulate a click event at the node center

pub fn type_text(&self, text: impl Into<String>)

Focus the node and type the given text

pub fn key_combination(&self, keys: &[Key])

Press the given keys in combination

For e.g. Key::Control + Key::A this would generate:

• Press Key::Control
• Press Key::A
• Release Key::A
• Release Key::Control

pub fn press_keys(&self, keys: &[Key])

Press the given keys For e.g. Key::Control + Key::A this would generate:

• Press Key::Control
• Release Key::Control
• Press Key::A
• Release Key::A

pub fn key_down(&self, key: Key)

Press the given key

pub fn key_up(&self, key: Key)

Release the given key

pub fn key_press(&self, key: Key)

Press and release the given key

pub fn parent(&self) -> Option<Node<'tree>>

Get the parent of the node

Methods from Deref<Target = Node<'tree>>

pub fn is_focused(&self) -> bool

pub fn is_focused_in_tree(&self) -> bool

pub fn is_focusable(&self) -> bool

pub fn is_root(&self) -> bool

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

pub fn parent(&self) -> Option<Node<'a>>

pub fn filtered_parent( &self, filter: &impl Fn(&Node<'_>) -> FilterResult, ) -> Option<Node<'a>>

pub fn child_ids( &self, ) -> impl DoubleEndedIterator + ExactSizeIterator + FusedIterator

pub fn children( &self, ) -> impl DoubleEndedIterator + ExactSizeIterator + FusedIterator + 'a

pub fn filtered_children( &self, filter: impl Fn(&Node<'_>) -> FilterResult + 'a, ) -> impl DoubleEndedIterator + FusedIterator + 'a

pub fn following_sibling_ids( &self, ) -> impl DoubleEndedIterator + ExactSizeIterator + FusedIterator + 'a

pub fn following_siblings( &self, ) -> impl DoubleEndedIterator + ExactSizeIterator + FusedIterator + 'a

pub fn following_filtered_siblings( &self, filter: impl Fn(&Node<'_>) -> FilterResult + 'a, ) -> impl DoubleEndedIterator + FusedIterator + 'a

pub fn preceding_sibling_ids( &self, ) -> impl DoubleEndedIterator + ExactSizeIterator + FusedIterator + 'a

pub fn preceding_siblings( &self, ) -> impl DoubleEndedIterator + ExactSizeIterator + FusedIterator + 'a

pub fn preceding_filtered_siblings( &self, filter: impl Fn(&Node<'_>) -> FilterResult + 'a, ) -> impl DoubleEndedIterator + FusedIterator + 'a

pub fn deepest_first_filtered_child( &self, filter: &impl Fn(&Node<'_>) -> FilterResult, ) -> Option<Node<'a>>

pub fn deepest_last_filtered_child( &self, filter: &impl Fn(&Node<'_>) -> FilterResult, ) -> Option<Node<'a>>

pub fn is_descendant_of(&self, ancestor: &Node<'_>) -> bool

pub fn direct_transform(&self) -> Affine

Returns the transform defined directly on this node, or the identity transform, without taking into account transforms on ancestors.

pub fn transform(&self) -> Affine

Returns the combined affine transform of this node and its ancestors, up to and including the root of this node’s tree.

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

pub fn has_bounds(&self) -> bool

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

Returns the node’s transformed bounding box relative to the tree’s container (e.g. window).

pub fn node_at_point( &self, point: Point, filter: &impl Fn(&Node<'_>) -> FilterResult, ) -> Option<Node<'a>>

Returns the deepest filtered node, either this node or a descendant, at the given point in this node’s coordinate space.

pub fn id(&self) -> NodeId

pub fn role(&self) -> Role

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

pub fn has_role_description(&self) -> bool

pub fn is_hidden(&self) -> bool

pub fn is_disabled(&self) -> bool

pub fn is_read_only(&self) -> bool

pub fn is_read_only_or_disabled(&self) -> bool

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

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

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

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

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

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

pub fn is_text_input(&self) -> bool

pub fn is_multiline(&self) -> bool

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

pub fn is_clickable(&self) -> bool

pub fn supports_toggle(&self) -> bool

pub fn supports_expand_collapse(&self) -> bool

pub fn is_invocable(&self) -> bool

pub fn supports_increment(&self) -> bool

pub fn supports_decrement(&self) -> bool

pub fn labelled_by(&self) -> impl DoubleEndedIterator + FusedIterator + 'a

pub fn label_comes_from_value(&self) -> bool

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

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

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

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

pub fn has_value(&self) -> bool

pub fn is_read_only_supported(&self) -> bool

pub fn should_have_read_only_state_by_default(&self) -> bool

pub fn live(&self) -> Live

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

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

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

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

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

pub fn index_path(&self) -> Vec<usize>

pub fn relative_index_path(&self, ancestor_id: NodeId) -> Vec<usize>

pub fn supports_text_ranges(&self) -> bool

pub fn document_range(&self) -> Range<'_>

pub fn has_text_selection(&self) -> bool

pub fn text_selection(&self) -> Option<Range<'_>>

pub fn text_selection_focus(&self) -> Option<Position<'_>>

pub fn text_position_at_point(&self, point: Point) -> Position<'_>

Returns the nearest text position to the given point in this node’s coordinate space.

pub fn line_range_from_index(&self, line_index: usize) -> Option<Range<'_>>

pub fn text_position_from_global_usv_index( &self, index: usize, ) -> Option<Position<'_>>

pub fn text_position_from_global_utf16_index( &self, index: usize, ) -> Option<Position<'_>>

Trait Implementations

impl<'tree> Clone for Node<'tree>

fn clone(&self) -> Node<'tree>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Node<'a>

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

Formats the value using the given formatter.

impl<'tree> Deref for Node<'tree>

We should probably add our own methods to query the node state but for now this should work

type Target = Node<'tree>

The resulting type after dereferencing.

fn deref(&self) -> &<Node<'tree> as Deref>::Target

Dereferences the value.

impl<'t, 'n> Queryable<'t, 'n> for Node<'t>

fn node(&'n self) -> Node<'t>

fn query_all( &'node self, by: By<'tree>, ) -> impl DoubleEndedIterator + FusedIterator + 'tree

Query all nodes in the tree where the node matches the given By filter.

fn get_all( &'node self, by: By<'tree>, ) -> impl DoubleEndedIterator + FusedIterator + 'tree

Get all nodes in the tree where the node matches the given By filter. Returns at least one node.

fn query(&'node self, by: By<'tree>) -> Option<Node<'tree>>

Query a single node in the tree where the node matches the given By filter. Returns None if no nodes are found.

fn get(&'node self, by: By<'tree>) -> Node<'tree>

Get a single node in the tree where the node matches the given By filter.

fn query_all_by_label( &'node self, label: &'tree str, ) -> impl DoubleEndedIterator + FusedIterator + 'tree

Query all nodes in the tree where the node label exactly matches given label.

fn get_all_by_label( &'node self, label: &'tree str, ) -> impl DoubleEndedIterator + FusedIterator + 'tree

Get all nodes in the tree where the node label exactly matches given label. Returns at least one node.

fn query_by_label(&'node self, label: &'tree str) -> Option<Node<'tree>>

Query a single node in the tree where the node label exactly matches given label. Returns None if no nodes are found.

fn get_by_label(&'node self, label: &'tree str) -> Node<'tree>

Get a single node in the tree where the node label exactly matches given label.

fn query_all_by_label_contains( &'node self, label: &'tree str, ) -> impl DoubleEndedIterator + FusedIterator + 'tree

Query all nodes in the tree where the node label contains the given substring.

fn get_all_by_label_contains( &'node self, label: &'tree str, ) -> impl DoubleEndedIterator + FusedIterator + 'tree

Get all nodes in the tree where the node label contains the given substring. Returns at least one node.

fn query_by_label_contains( &'node self, label: &'tree str, ) -> Option<Node<'tree>>

Query a single node in the tree where the node label contains the given substring. Returns None if no nodes are found.

fn get_by_label_contains(&'node self, label: &'tree str) -> Node<'tree>

Get a single node in the tree where the node label contains the given substring.

fn query_all_by_role_and_label( &'node self, role: Role, label: &'tree str, ) -> impl DoubleEndedIterator + FusedIterator + 'tree

Query all nodes in the tree where the node role and label exactly match the given role and label.

fn get_all_by_role_and_label( &'node self, role: Role, label: &'tree str, ) -> impl DoubleEndedIterator + FusedIterator + 'tree

Get all nodes in the tree where the node role and label exactly match the given role and label. Returns at least one node.

fn query_by_role_and_label( &'node self, role: Role, label: &'tree str, ) -> Option<Node<'tree>>

Query a single node in the tree where the node role and label exactly match the given role and label. Returns None if no nodes are found.

fn get_by_role_and_label( &'node self, role: Role, label: &'tree str, ) -> Node<'tree>

Get a single node in the tree where the node role and label exactly match the given role and label.

fn query_all_by_role( &'node self, role: Role, ) -> impl DoubleEndedIterator + FusedIterator + 'tree

Query all nodes in the tree where the node role matches the given role.

fn get_all_by_role( &'node self, role: Role, ) -> impl DoubleEndedIterator + FusedIterator + 'tree

Get all nodes in the tree where the node role matches the given role. Returns at least one node.

fn query_by_role(&'node self, role: Role) -> Option<Node<'tree>>

Query a single node in the tree where the node role matches the given role. Returns None if no nodes are found.

fn get_by_role(&'node self, role: Role) -> Node<'tree>

Get a single node in the tree where the node role matches the given role.

fn query_all_by_value( &'node self, value: &'tree str, ) -> impl DoubleEndedIterator + FusedIterator + 'tree

Query all nodes in the tree where the node value exactly matches the given value.

fn get_all_by_value( &'node self, value: &'tree str, ) -> impl DoubleEndedIterator + FusedIterator + 'tree

Get all nodes in the tree where the node value exactly matches the given value. Returns at least one node.

fn query_by_value(&'node self, value: &'tree str) -> Option<Node<'tree>>

Query a single node in the tree where the node value exactly matches the given value. Returns None if no nodes are found.

fn get_by_value(&'node self, value: &'tree str) -> Node<'tree>

Get a single node in the tree where the node value exactly matches the given value.

fn query_all_by( &'node self, f: impl Fn(&Node<'_>) -> bool + 'tree, ) -> impl DoubleEndedIterator + FusedIterator + 'tree

Query all nodes in the tree where the node matches the given predicate.

fn get_all_by( &'node self, f: impl Fn(&Node<'_>) -> bool + 'tree, ) -> impl DoubleEndedIterator + FusedIterator + 'tree

Get all nodes in the tree where the node matches the given predicate. Returns at least one node.

fn query_by( &'node self, f: impl Fn(&Node<'_>) -> bool + 'tree, ) -> Option<Node<'tree>>

Query a single node in the tree where the node matches the given predicate. Returns None if no nodes are found.

fn get_by(&'node self, f: impl Fn(&Node<'_>) -> bool + 'tree) -> Node<'tree>

Get a single node in the tree where the node matches the given predicate.

impl<'tree> Copy for Node<'tree>