Enum Role 

pub enum Role {
    None,
    Button,
    Checkbox,
    Radio,
    Switch,
    Slider,
    Tab,
    TabList,
    Link,
    Heading,
    List,
    ListItem,
    Image,
    Dialog,
    Group,
    Window,
    TitleBar,
    StaticText,
    TextInput,
    MultilineTextInput,
    ScrollView,
    Line,
    RadioGroup,
    Menu,
    MenuItem,
    Terminal,
}

What a node is to assistive technology. Most of these a view declares (role prop; schema::ROLES is that list, and the wire order); the ones the core derives from a node’s content and behaviour instead are schema::DERIVED_ONLY, which says what derives each. Every variant is on one list or the other — schema’s every_role_is_declarable_or_derived fails when a new one is on neither.

Variants

None

Decorative: the node and its whole subtree leave the access tree.

Button

Checkbox

Radio

Switch

Slider

Tab

TabList

Link

Heading

List

ListItem

Image

Dialog

Group

Window

The root, named by the window title.

TitleBar

A window="drag" strip.

StaticText

A text node; its content is its name.

TextInput

A single-line editor; the text is its value. Declared on an on_key sink that draws its own text, it makes that sink one.

MultilineTextInput

A multiline editor (see Role::TextInput).

ScrollView

A container that scrolls.

Line

One line of a custom editor (a role="textInput" sink): the text nodes inside it, in order, are that line of the editor’s value, and its caret / selectionAnchor are byte offsets into it. Not a node of its own.

RadioGroup

A set of radios: one Tab stop, arrows moving the checked one.

Menu

A menu: one Tab stop, arrows moving focus without activating.

MenuItem

One item of a menu. A control, so it is focusable by its role and an unnamed one is reported.

Terminal

A cell grid (crate::cells): the screen of a terminal, its rows joined as the value. Derived from the node.

Implementations

impl Role

pub const ALL: [Role; 26]

pub fn name(self) -> &'static str

The camelCase spelling every binding uses.

pub fn parse(name: &str) -> Option<Role>

pub fn is_control(self) -> bool

A control needs a name; one without is reported as a warning.

pub fn is_editor(self) -> bool

An editor role: carries text runs, a caret and a selection.

Trait Implementations

impl Clone for Role

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Role

impl Debug for Role

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

Formats the value using the given formatter.

impl Eq for Role

impl Hash for Role

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Role

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Role