Enum bevy::a11y::accesskit::Role

#[repr(u8)]
pub enum Role {
    Unknown,
    InlineTextBox,
    Cell,
    StaticText,
    Image,
    Link,
    Row,
    ListItem,
    ListMarker,
    TreeItem,
    ListBoxOption,
    MenuItem,
    MenuListOption,
    Paragraph,
    GenericContainer,
    CheckBox,
    RadioButton,
    TextInput,
    Button,
    DefaultButton,
    Pane,
    RowHeader,
    ColumnHeader,
    Column,
    RowGroup,
    List,
    Table,
    TableHeaderContainer,
    LayoutTableCell,
    LayoutTableRow,
    LayoutTable,
    Switch,
    ToggleButton,
    Menu,
    MultilineTextInput,
    SearchInput,
    DateInput,
    DateTimeInput,
    WeekInput,
    MonthInput,
    TimeInput,
    EmailInput,
    NumberInput,
    PasswordInput,
    PhoneNumberInput,
    UrlInput,
    Abbr,
    Alert,
    AlertDialog,
    Application,
    Article,
    Audio,
    Banner,
    Blockquote,
    Canvas,
    Caption,
    Caret,
    Code,
    ColorWell,
    ComboBox,
    EditableComboBox,
    Complementary,
    Comment,
    ContentDeletion,
    ContentInsertion,
    ContentInfo,
    Definition,
    DescriptionList,
    DescriptionListDetail,
    DescriptionListTerm,
    Details,
    Dialog,
    Directory,
    DisclosureTriangle,
    Document,
    EmbeddedObject,
    Emphasis,
    Feed,
    FigureCaption,
    Figure,
    Footer,
    FooterAsNonLandmark,
    Form,
    Grid,
    Group,
    Header,
    HeaderAsNonLandmark,
    Heading,
    Iframe,
    IframePresentational,
    ImeCandidate,
    Keyboard,
    Legend,
    LineBreak,
    ListBox,
    Log,
    Main,
    Mark,
    Marquee,
    Math,
    MenuBar,
    MenuItemCheckBox,
    MenuItemRadio,
    MenuListPopup,
    Meter,
    Navigation,
    Note,
    PluginObject,
    Portal,
    Pre,
    ProgressIndicator,
    RadioGroup,
    Region,
    RootWebArea,
    Ruby,
    RubyAnnotation,
    ScrollBar,
    ScrollView,
    Search,
    Section,
    Slider,
    SpinButton,
    Splitter,
    Status,
    Strong,
    Suggestion,
    SvgRoot,
    Tab,
    TabList,
    TabPanel,
    Term,
    Time,
    Timer,
    TitleBar,
    Toolbar,
    Tooltip,
    Tree,
    TreeGrid,
    Video,
    WebView,
    Window,
    PdfActionableHighlight,
    PdfRoot,
    GraphicsDocument,
    GraphicsObject,
    GraphicsSymbol,
    DocAbstract,
    DocAcknowledgements,
    DocAfterword,
    DocAppendix,
    DocBackLink,
    DocBiblioEntry,
    DocBibliography,
    DocBiblioRef,
    DocChapter,
    DocColophon,
    DocConclusion,
    DocCover,
    DocCredit,
    DocCredits,
    DocDedication,
    DocEndnote,
    DocEndnotes,
    DocEpigraph,
    DocEpilogue,
    DocErrata,
    DocExample,
    DocFootnote,
    DocForeword,
    DocGlossary,
    DocGlossRef,
    DocIndex,
    DocIntroduction,
    DocNoteRef,
    DocNotice,
    DocPageBreak,
    DocPageFooter,
    DocPageHeader,
    DocPageList,
    DocPart,
    DocPreface,
    DocPrologue,
    DocPullquote,
    DocQna,
    DocSubtitle,
    DocTip,
    DocToc,
    ListGrid,
    Terminal,
}

The type of an accessibility node.

The majority of these roles come from the ARIA specification. Reference the latest draft for proper usage.

Like the AccessKit schema as a whole, this list is largely taken from Chromium. However, unlike Chromium’s alphabetized list, this list is ordered roughly by expected usage frequency (with the notable exception of Role::Unknown). This is more efficient in serialization formats where integers use a variable-length encoding.

Variants

Unknown

InlineTextBox

Cell

StaticText

Image

Link

Row

ListItem

ListMarker

Contains the bullet, number, or other marker for a list item.

TreeItem

ListBoxOption

MenuItem

MenuListOption

Paragraph

GenericContainer

A generic container that should be ignored by assistive technologies and filtered out of platform accessibility trees. Equivalent to the ARIA none or presentation role, or to an HTML div with no role.

CheckBox

RadioButton

TextInput

Button

DefaultButton

Pane

RowHeader

ColumnHeader

Column

RowGroup

List

Table

TableHeaderContainer

LayoutTableCell

LayoutTableRow

LayoutTable

Switch

ToggleButton

Menu

MultilineTextInput

SearchInput

DateInput

DateTimeInput

WeekInput

MonthInput

TimeInput

EmailInput

NumberInput

PasswordInput

PhoneNumberInput

UrlInput

Abbr

Alert

AlertDialog

Application

Article

Audio

Banner

Blockquote

Canvas

Caption

Caret

Code

ColorWell

ComboBox

EditableComboBox

Complementary

Comment

ContentDeletion

ContentInsertion

ContentInfo

Definition

DescriptionList

DescriptionListDetail

DescriptionListTerm

Details

Dialog

Directory

DisclosureTriangle

Document

EmbeddedObject

Emphasis

Feed

FigureCaption

Figure

Footer

FooterAsNonLandmark

Form

Grid

Group

Header

HeaderAsNonLandmark

Heading

Iframe

IframePresentational

ImeCandidate

Keyboard

Legend

LineBreak

ListBox

Log

Main

Mark

Marquee

Math

MenuBar

MenuItemCheckBox

MenuItemRadio

MenuListPopup

Meter

Navigation

Note

PluginObject

Portal

Pre

ProgressIndicator

RadioGroup

Region

RootWebArea

Ruby

RubyAnnotation

ScrollBar

ScrollView

Search

Section

Slider

SpinButton

Splitter

Status

Strong

Suggestion

SvgRoot

Tab

TabList

TabPanel

Term

Time

Timer

TitleBar

Toolbar

Tooltip

Tree

TreeGrid

Video

WebView

Window

PdfActionableHighlight

PdfRoot

GraphicsDocument

GraphicsObject

GraphicsSymbol

DocAbstract

DocAcknowledgements

DocAfterword

DocAppendix

DocBackLink

DocBiblioEntry

DocBibliography

DocBiblioRef

DocChapter

DocColophon

DocConclusion

DocCover

DocCredit

DocCredits

DocDedication

DocEndnote

DocEndnotes

DocEpigraph

DocEpilogue

DocErrata

DocExample

DocFootnote

DocForeword

DocGlossary

DocGlossRef

DocIndex

DocIntroduction

DocNoteRef

DocNotice

DocPageBreak

DocPageFooter

DocPageHeader

DocPageList

DocPart

DocPreface

DocPrologue

DocPullquote

DocQna

DocSubtitle

DocTip

DocToc

ListGrid

Behaves similar to an ARIA grid but is primarily used by Chromium’s TableView and its subclasses, so they can be exposed correctly on certain platforms.

Terminal

This is just like a multi-line document, but signals that assistive technologies should implement behavior specific to a VT-100-style terminal.

Trait Implementations

impl Clone for Role

fn clone(&self) -> Role

Returns a copy 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 Default for Role

fn default() -> Role

Returns the “default value” for a 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 Ord for Role

fn cmp(&self, other: &Role) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Role> for Role

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Role> for Role

fn partial_cmp(&self, other: &Role) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Role

impl Eq for Role

impl StructuralEq for Role

impl StructuralPartialEq for Role