Enum accesskit::Role

source ·
#[repr(u8)]
pub enum Role {
Show 189 variants Unknown = 0, InlineTextBox = 1, Cell = 2, StaticText = 3, Image = 4, Link = 5, Row = 6, ListItem = 7, ListMarker = 8, TreeItem = 9, ListBoxOption = 10, MenuItem = 11, MenuListOption = 12, Paragraph = 13, GenericContainer = 14, CheckBox = 15, RadioButton = 16, TextInput = 17, Button = 18, DefaultButton = 19, Pane = 20, RowHeader = 21, ColumnHeader = 22, Column = 23, RowGroup = 24, List = 25, Table = 26, TableHeaderContainer = 27, LayoutTableCell = 28, LayoutTableRow = 29, LayoutTable = 30, Switch = 31, ToggleButton = 32, Menu = 33, MultilineTextInput = 34, SearchInput = 35, DateInput = 36, DateTimeInput = 37, WeekInput = 38, MonthInput = 39, TimeInput = 40, EmailInput = 41, NumberInput = 42, PasswordInput = 43, PhoneNumberInput = 44, UrlInput = 45, Abbr = 46, Alert = 47, AlertDialog = 48, Application = 49, Article = 50, Audio = 51, Banner = 52, Blockquote = 53, Canvas = 54, Caption = 55, Caret = 56, Code = 57, ColorWell = 58, ComboBox = 59, EditableComboBox = 60, Complementary = 61, Comment = 62, ContentDeletion = 63, ContentInsertion = 64, ContentInfo = 65, Definition = 66, DescriptionList = 67, DescriptionListDetail = 68, DescriptionListTerm = 69, Details = 70, Dialog = 71, Directory = 72, DisclosureTriangle = 73, Document = 74, EmbeddedObject = 75, Emphasis = 76, Feed = 77, FigureCaption = 78, Figure = 79, Footer = 80, FooterAsNonLandmark = 81, Form = 82, Grid = 83, Group = 84, Header = 85, HeaderAsNonLandmark = 86, Heading = 87, Iframe = 88, IframePresentational = 89, ImeCandidate = 90, Keyboard = 91, Legend = 92, LineBreak = 93, ListBox = 94, Log = 95, Main = 96, Mark = 97, Marquee = 98, Math = 99, MenuBar = 100, MenuItemCheckBox = 101, MenuItemRadio = 102, MenuListPopup = 103, Meter = 104, Navigation = 105, Note = 106, PluginObject = 107, Portal = 108, Pre = 109, ProgressIndicator = 110, RadioGroup = 111, Region = 112, RootWebArea = 113, Ruby = 114, RubyAnnotation = 115, ScrollBar = 116, ScrollView = 117, Search = 118, Section = 119, Slider = 120, SpinButton = 121, Splitter = 122, Status = 123, Strong = 124, Suggestion = 125, SvgRoot = 126, Tab = 127, TabList = 128, TabPanel = 129, Term = 130, Time = 131, Timer = 132, TitleBar = 133, Toolbar = 134, Tooltip = 135, Tree = 136, TreeGrid = 137, Video = 138, WebView = 139, Window = 140, PdfActionableHighlight = 141, PdfRoot = 142, GraphicsDocument = 143, GraphicsObject = 144, GraphicsSymbol = 145, DocAbstract = 146, DocAcknowledgements = 147, DocAfterword = 148, DocAppendix = 149, DocBackLink = 150, DocBiblioEntry = 151, DocBibliography = 152, DocBiblioRef = 153, DocChapter = 154, DocColophon = 155, DocConclusion = 156, DocCover = 157, DocCredit = 158, DocCredits = 159, DocDedication = 160, DocEndnote = 161, DocEndnotes = 162, DocEpigraph = 163, DocEpilogue = 164, DocErrata = 165, DocExample = 166, DocFootnote = 167, DocForeword = 168, DocGlossary = 169, DocGlossRef = 170, DocIndex = 171, DocIntroduction = 172, DocNoteRef = 173, DocNotice = 174, DocPageBreak = 175, DocPageFooter = 176, DocPageHeader = 177, DocPageList = 178, DocPart = 179, DocPreface = 180, DocPrologue = 181, DocPullquote = 182, DocQna = 183, DocSubtitle = 184, DocTip = 185, DocToc = 186, ListGrid = 187, Terminal = 188,
}
Expand description

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 = 0

§

InlineTextBox = 1

§

Cell = 2

§

StaticText = 3

§

Image = 4

§

Row = 6

§

ListItem = 7

§

ListMarker = 8

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

§

TreeItem = 9

§

ListBoxOption = 10

§

MenuItem = 11

§

MenuListOption = 12

§

Paragraph = 13

§

GenericContainer = 14

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 = 15

§

RadioButton = 16

§

TextInput = 17

§

Button = 18

§

DefaultButton = 19

§

Pane = 20

§

RowHeader = 21

§

ColumnHeader = 22

§

Column = 23

§

RowGroup = 24

§

List = 25

§

Table = 26

§

TableHeaderContainer = 27

§

LayoutTableCell = 28

§

LayoutTableRow = 29

§

LayoutTable = 30

§

Switch = 31

§

ToggleButton = 32

§

Menu = 33

§

MultilineTextInput = 34

§

SearchInput = 35

§

DateInput = 36

§

DateTimeInput = 37

§

WeekInput = 38

§

MonthInput = 39

§

TimeInput = 40

§

EmailInput = 41

§

NumberInput = 42

§

PasswordInput = 43

§

PhoneNumberInput = 44

§

UrlInput = 45

§

Abbr = 46

§

Alert = 47

§

AlertDialog = 48

§

Application = 49

§

Article = 50

§

Audio = 51

§

Banner = 52

§

Blockquote = 53

§

Canvas = 54

§

Caption = 55

§

Caret = 56

§

Code = 57

§

ColorWell = 58

§

ComboBox = 59

§

EditableComboBox = 60

§

Complementary = 61

§

Comment = 62

§

ContentDeletion = 63

§

ContentInsertion = 64

§

ContentInfo = 65

§

Definition = 66

§

DescriptionList = 67

§

DescriptionListDetail = 68

§

DescriptionListTerm = 69

§

Details = 70

§

Dialog = 71

§

Directory = 72

§

DisclosureTriangle = 73

§

Document = 74

§

EmbeddedObject = 75

§

Emphasis = 76

§

Feed = 77

§

FigureCaption = 78

§

Figure = 79

§

Footer = 80

§

FooterAsNonLandmark = 81

§

Form = 82

§

Grid = 83

§

Group = 84

§

Header = 85

§

HeaderAsNonLandmark = 86

§

Heading = 87

§

Iframe = 88

§

IframePresentational = 89

§

ImeCandidate = 90

§

Keyboard = 91

§

Legend = 92

§

LineBreak = 93

§

ListBox = 94

§

Log = 95

§

Main = 96

§

Mark = 97

§

Marquee = 98

§

Math = 99

§

MenuBar = 100

§

MenuItemCheckBox = 101

§

MenuItemRadio = 102

§

MenuListPopup = 103

§

Meter = 104

§

Navigation = 105

§

Note = 106

§

PluginObject = 107

§

Portal = 108

§

Pre = 109

§

ProgressIndicator = 110

§

RadioGroup = 111

§

Region = 112

§

RootWebArea = 113

§

Ruby = 114

§

RubyAnnotation = 115

§

ScrollBar = 116

§

ScrollView = 117

§

Search = 118

§

Section = 119

§

Slider = 120

§

SpinButton = 121

§

Splitter = 122

§

Status = 123

§

Strong = 124

§

Suggestion = 125

§

SvgRoot = 126

§

Tab = 127

§

TabList = 128

§

TabPanel = 129

§

Term = 130

§

Time = 131

§

Timer = 132

§

TitleBar = 133

§

Toolbar = 134

§

Tooltip = 135

§

Tree = 136

§

TreeGrid = 137

§

Video = 138

§

WebView = 139

§

Window = 140

§

PdfActionableHighlight = 141

§

PdfRoot = 142

§

GraphicsDocument = 143

§

GraphicsObject = 144

§

GraphicsSymbol = 145

§

DocAbstract = 146

§

DocAcknowledgements = 147

§

DocAfterword = 148

§

DocAppendix = 149

§

DocBiblioEntry = 151

§

DocBibliography = 152

§

DocBiblioRef = 153

§

DocChapter = 154

§

DocColophon = 155

§

DocConclusion = 156

§

DocCover = 157

§

DocCredit = 158

§

DocCredits = 159

§

DocDedication = 160

§

DocEndnote = 161

§

DocEndnotes = 162

§

DocEpigraph = 163

§

DocEpilogue = 164

§

DocErrata = 165

§

DocExample = 166

§

DocFootnote = 167

§

DocForeword = 168

§

DocGlossary = 169

§

DocGlossRef = 170

§

DocIndex = 171

§

DocIntroduction = 172

§

DocNoteRef = 173

§

DocNotice = 174

§

DocPageBreak = 175

§

DocPageFooter = 176

§

DocPageHeader = 177

§

DocPageList = 178

§

DocPart = 179

§

DocPreface = 180

§

DocPrologue = 181

§

DocPullquote = 182

§

DocQna = 183

§

DocSubtitle = 184

§

DocTip = 185

§

DocToc = 186

§

ListGrid = 187

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 = 188

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§

source§

impl Clone for Role

source§

fn clone(&self) -> Role

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Role

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Role

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Hash for Role

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for Role

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Role

source§

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

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

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.
source§

impl PartialOrd for Role

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl Copy for Role

source§

impl Eq for Role

source§

impl StructuralEq for Role

source§

impl StructuralPartialEq for Role

Auto Trait Implementations§

§

impl RefUnwindSafe for Role

§

impl Send for Role

§

impl Sync for Role

§

impl Unpin for Role

§

impl UnwindSafe for Role

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.