Enum Role 

#[non_exhaustive]
pub enum Role {
    Window,
    Dialog,
    Group,
    Generic,
    Toolbar,
    TabBar,
    Tab,
    TabPanel,
    List,
    ListItem,
    Table,
    Row,
    Cell,
    Tree,
    TreeItem,
    Menu,
    MenuItem,
    Button,
    ToggleButton,
    Checkbox,
    RadioButton,
    Switch,
    Slider,
    Separator,
    SpinButton,
    ComboBox,
    TextInput,
    MultilineTextInput,
    Link,
    ProgressBar,
    Spinner,
    Tooltip,
    Image,
    Label,
    StaticText,
    Heading {
        level: u8,
    },
    Paragraph,
    Document,
    Terminal,
    Canvas,
    Unknown,
}

A thin subset of AccessKit’s 182 roles covering the widgets the toolkit supports; unknown/rare cases fall back to Role::Generic.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Window

Dialog

Group

Generic

Prefer returning None from accessibility() for pure layout widgets so they collapse out of the tree; Generic is for a rare container with no richer role that must still appear.

Toolbar

TabBar

Tab

TabPanel

The panel a selected Role::Tab reveals.

List

ListItem

Table

Row

Within a Role::Table or Role::Tree.

Cell

Tree

TreeItem

Use AccessState::expanded.

Menu

MenuItem

Button

ToggleButton

Persistent pressed/unpressed state (use AccessState::checked).

Checkbox

Use AccessState::checked.

RadioButton

Use AccessState::checked.

Switch

Use AccessState::checked.

Slider

Separator

A focusable divider between two panes that moves with the arrow keys; its value is the first pane’s share in percent.

SpinButton

ComboBox

Use AccessState::expanded.

TextInput

MultilineTextInput

Own role because AccessKit distinguishes it from Role::TextInput.

Link

ProgressBar

Determinate, or with AccessState::busy, indeterminate.

Spinner

Tooltip

Image

Supply alt text via name.

Label

A short text label that names another control.

StaticText

Heading

Outline level (1 = top level), for heading navigation.

Fields

level: u8

Paragraph

Document

E.g. the block editor.

Terminal

A terminal transcript and input surface. Unlike a text input, its exposed value is not replaced by Action::SetValue; input is a stream owned by the terminal’s resource/action contract.

Canvas

Unknown

Trait Implementations

impl Clone for Role

fn clone(&self) -> Role

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Role

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

Formats the value using the given formatter.

impl From<Role> for String

fn from(role: Role) -> String

Converts to this type from the input type.

impl Hash for Role

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

where __H: Hasher,

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: &Role) -> 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 Serialize for Role

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Role

impl Eq for Role

impl StructuralPartialEq for Role