Enum atspi::accessible::Role

source ·

pub enum Role {
Show 129 variants    Invalid,
    AcceleratorLabel,
    Alert,
    Animation,
    Arrow,
    Calendar,
    Canvas,
    CheckBox,
    CheckMenuItem,
    ColorChooser,
    ColumnHeader,
    ComboBox,
    DateEditor,
    DesktopIcon,
    DesktopFrame,
    Dial,
    Dialog,
    DirectoryPane,
    DrawingArea,
    FileChooser,
    Filler,
    FocusTraversable,
    FontChooser,
    Frame,
    GlassPane,
    HTMLContainer,
    Icon,
    Image,
    InternalFrame,
    Label,
    LayeredPane,
    List,
    ListItem,
    Menu,
    MenuBar,
    MenuItem,
    OptionPane,
    PageTab,
    PageTabList,
    Panel,
    PasswordText,
    PopupMenu,
    ProgressBar,
    PushButton,
    RadioButton,
    RadioMenuItem,
    RootPane,
    RowHeader,
    ScrollBar,
    ScrollPane,
    Separator,
    Slider,
    SpinButton,
    SplitPane,
    StatusBar,
    Table,
    TableCell,
    TableColumnHeader,
    TableRowHeader,
    TearoffMenuItem,
    Terminal,
    Text,
    ToggleButton,
    ToolBar,
    ToolTip,
    Tree,
    TreeTable,
    Unknown,
    Viewport,
    Window,
    Extended,
    Header,
    Footer,
    Paragraph,
    Ruler,
    Application,
    Autocomplete,
    Editbar,
    Embedded,
    Entry,
    CHART,
    Caption,
    DocumentFrame,
    Heading,
    Page,
    Section,
    RedundantObject,
    Form,
    Link,
    InputMethodWindow,
    TableRow,
    TreeItem,
    DocumentSpreadsheet,
    DocumentPresentation,
    DocumentText,
    DocumentWeb,
    DocumentEmail,
    Comment,
    ListBox,
    Grouping,
    ImageMap,
    Notification,
    InfoBar,
    LevelBar,
    TitleBar,
    BlockQuote,
    Audio,
    Video,
    Definition,
    Article,
    Landmark,
    Log,
    Marquee,
    Math,
    Rating,
    Timer,
    Static,
    MathFraction,
    MathRoot,
    Subscript,
    Superscript,
    DescriptionList,
    DescriptionTerm,
    DescriptionValue,
    Footnote,
    ContentDeletion,
    ContentInsertion,
    Mark,
    Suggestion,
}

Expand description

An accessible object role. To think of it in terms of HTML, any semantic element likely has a corollary in this enum. For example:

Variants

`Invalid`

An invalid role used for either an invalid deserialization, or when trying to match for any possible role. TODO: confirm

`AcceleratorLabel`

Unknown role TODO

`Alert`

Alert: this is triggered in a web browser through the alert(…); function.

`Animation`

Animation: unknown use TODO

`Arrow`

Arrow: unknown use TODO

`Calendar`

Calendar: a calendar widget, or in HTML terms, <input type="datetime-local">

`Canvas`

A canvas on which any direct rendering may be called. In web terms, this would be the <canvas> element.

`CheckBox`

A (multiple) checkbox. In HTML terms, <input type="checkbox">, note that there is a different role for radio buttons and for multiple select dropdowns.

`CheckMenuItem`

CheckMenuItem: unknown use. TODO

`ColorChooser`

ColorChooser: a color picker input. In HTML terms, <input type="color">

`ColumnHeader`

Column header: in HTML terms, a <th>.

`ComboBox`

A multiple select dropdown menu.

`DateEditor`

Date editor: unknown use case. TODO

`DesktopIcon`

A desktop icon: on Windows this would be the “Recycle Bin”, or “My Computer” on your desktop. On Linux this would be similar to any applications showing on your desktop.

`DesktopFrame`

The frame within all windows live. A DesktopFrame will generally share siblings with others of the same type if you use multiple desktops.

`Dial`

Dial: unknown use case. TODO

`Dialog`

Dialog: a pop-up dialog. In HTML terms, the <dialog> tag.

`DirectoryPane`

Directory pane: unknown use case.

`DrawingArea`

`FileChooser`

File chooser: this is a window which will display when

`Filler`

Filter: unknown use: TODO.

`FocusTraversable`

Focus traversable: TODO

`FontChooser`

Font chooser: TODO, but obvious?

`Frame`

Frame: generally the parent of InternalFrame.

`GlassPane`

Glass pane? TODO

`HTMLContainer`

Constraining container of which only HTML resides in. This is useful during structural navigation calls to bound the search area to only HTML elements of the page.

`Icon`

TODO: icon

`Image`

An image. In HTML, this would be the tag, or it could be an image embedded within a non-web application.

`InternalFrame`

Internal frame: this is the constraining role for a graphical window. This is a good bounding role for finding things from within an application.

`Label`

A label, which is generally associated with an item with a different role. In HTML terms, this would be a <label for="X"> being attached to whatever <Y id="X"> is.

`LayeredPane`

Layered pane? TODO

`List`

List: a list with Self::ListItem contained within it. In HTML, this would be the same as the <ul> or <ol> elements.

`ListItem`

ListItem: a list’s item. This would be the same as an <li> in HTML terms.

`Menu`

`MenuBar`

`MenuItem`

`OptionPane`

`PageTab`

`PageTabList`

`Panel`

`PasswordText`

A password input, like <input type="password">.

`PopupMenu`

`ProgressBar`

Progress bar: this indicates progress of some process, and generally is indicated by successively higher-pitched beeps on a screen reader as it is updated to a more and more highly completed state. In HTML this would be the same as tag.

`PushButton`

PushButton: this is what everybody else calls a button. In HTML, <button>

`RadioButton`

Radio button: a multiple-choice, single-selection option. In HTML: <input type="radio">.

`RadioMenuItem`

`RootPane`

Root pane: the mother of ALL panes. This is the pane from which all other panes descend. If you wanted to, for some reason, search within a bound of the entire active desktop, this would be your bounding pane.

`RowHeader`

Row header: a heading to a row. In HTML this would be the same as without the additional role=“…” attribute, the header will still be recognized as a column header.

`ScrollBar`

A scroll bar itself: the item you may click on and scroll up and down.

`ScrollPane`

A scroll pane: the pane in which the scrollable content is contained within.

`Separator`

Separator: commonly used in desktop applications to pad out the interface. This also is the same as the

element in HTML.

`Slider`

Slider: a slider to control a granular value like volume, pitch, or speed.

`SpinButton`

spin button: ? TODO

`SplitPane`

Split pane: ? TODO

`StatusBar`

Status bar: ? TODO

`Table`

Table: a table. This may hold any tabular data with rows and columns. This would be the same as the

element in HTML.

TableCell
A table cell: this may hold a singular piece of data at a row+column combo. This is the same as <td> in HTML.

TableColumnHeader
The column header of a table, represented in HTML as a <th>

TableRowHeader
The row heading of a table, represented in HTML as a <th scope="row">.

TearoffMenuItem
Terminal
A virtual terminal like MATE Terminal, Foot, or st.

Text
ToggleButton
ToolBar
ToolTip
Tree
The root of a tree, which may have many sub trees and tree items (leafs).

TreeTable
Unknown
When the role cannot be accurately reported, this role will be set.

Viewport
Window
A window itself, not the same thing as a Pane or a Frame, which are both contained within a Window.

Extended
Header
A header with upfront information about a document, site, or application. The same as
in HTML.

Footer
A footer with additional (usually optional) information about a web page, document, or application. The same as
in HTML.

Paragraph
A paragraph of text: the same as
in HTML.

Ruler
A horizontal line between two items. Usually a <hr> in HTML.

Application
Autocomplete
Editbar
Embedded
Entry
CHART
Caption
DocumentFrame
Heading
Heading: this is a heading with a level (usually 1-6). This is represented by
through
in HTML.

Page
Section
Section: pieces of grouped content for semantic purposes. This is the same as the
tag in HTML.

RedundantObject
Form
Form: a form where a user will input information and send the form out (usually to an online service). The same as the element in HTML.

Link
Link: a hyperlink that leads to a new destination. The same as the tag in HTML.

InputMethodWindow
TableRow
Table row: a row of table data. This is the same as the <tr> tag from HTML.

TreeItem
A leaf or node within a tree.

DocumentSpreadsheet
A spreadsheet document (almost exclusively used by LibreofficeCalc).

DocumentPresentation
A presentation document (almost exclusively used by LibreofficePresent).

DocumentText
A text document (almost exclusively used by LibreofficeWriter).

DocumentWeb
A web document, used for any web browser.

DocumentEmail
An email document, used primarily by Thunderbird.

Comment
ListBox
Grouping
ImageMap
Notification
Notification: this is generally displayed and made accessible by a notification daemon. For example dunst.

InfoBar
LevelBar
TitleBar
BlockQuote
Block quote: when a quote is longer than around one full sentence, a block-style quote often make more sense. This is the same as the <blockquote> HTML tag.

Audio
Audio: a role which can play sound. In HTML: <audio>

Video
Video: a role which can play a video (with optional sound). In HTML: <video>

Definition
Article
Landmark
Log
Marquee
Math
Math: a special role for when math equations appear. This is the same as the <math> tag in HTML, indicating embedded MathML.

Rating
A rating system, generally out of five stars, but it does not need to be that way. There is not tag nor role for this in HTML, however.

Timer
Static
MathFraction
MathRoot
Subscript
Superscript
DescriptionList
A list with Term/Value subitems. This is the same as <dl> in HTML.

DescriptionTerm
An item (usually inside a Self::DescriptionList) that has a term as its content. The same as the <dt> tag in HTML.

DescriptionValue
An item (usually inside a Self::DescriptionList) that has a term’s value as its content. This is the same as a <dd> tag in HTML.

Footnote
ContentDeletion
ContentInsertion
Mark
Suggestion
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<'de> Deserialize<'de> for Role
source
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source
impl Display for Role
source
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. 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 PartialEq<Role> for Role
source
fn eq(&self, other: &Role) -> bool
This method tests for self and other values to be equal, and is used by ==. Read more
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. Read more
source
impl Serialize for Role
source
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,
Serialize this value into the given Serde serializer. Read more
source
impl Type for Role
source
fn signature() -> Signature<'static>
Get the signature for the implementing type. 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 Twhere
    T: 'static + ?Sized,
source
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source
impl<T> Borrow<T> for Twhere
    T: ?Sized,
const: unstable · source
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source
impl<T> BorrowMut<T> for Twhere
    T: ?Sized,
const: unstable · source
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<'de, T> DynamicDeserialize<'de> for Twhere
    T: Type + Deserialize<'de> + ?Sized,
type Deserializer = PhantomData<T>
A DeserializeSeed implementation for this type.
fn deserializer_for_signature<S>(
    signature: S
) -> Result<<T as DynamicDeserialize<'de>>::Deserializer, Error>where
    S: TryInto<Signature<'de>>,
    <S as TryInto<Signature<'de>>>::Error: Into<Error>,
Get a deserializer compatible with this signature.
impl<T> DynamicType for Twhere
    T: Type + ?Sized,
fn dynamic_signature(&self) -> Signature<'_>
Get the signature for the implementing type. Read more
source
impl<T> From<T> for T
const: unstable · source
fn from(t: T) -> T
Returns the argument unchanged.

source
impl<T> Instrument for T
source
fn instrument(self, span: Span) -> Instrumented<Self>
Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source
fn in_current_span(self) -> Instrumented<Self>
Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source
impl<T, U> Into<U> for Twhere
    U: From<T>,
const: unstable · 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 Twhere
    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> ToString for Twhere
    T: Display + ?Sized,
source
default fn to_string(&self) -> String
Converts the given value to a String. Read more
source
impl<T, U> TryFrom<U> for Twhere
    U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
const: unstable · source
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.
source
impl<T, U> TryInto<U> for Twhere
    U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
const: unstable · source
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.
impl<V, T> VZip<V> for Twhere
    V: MultiLane<T>,
fn vzip(self) -> V
source
impl<T> WithSubscriber for T
source
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
    S: Into<Dispatch>,
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source
impl<T> DeserializeOwned for Twhere
    T: for<'de> Deserialize<'de>,

Enum atspi::accessible::Role

. Non-semantic elements like , and will not be represented here, and this information is not passed through via the atspi library. TODO: add examples for GTK/Qt libraries in addition to HTML examples.

Variants

Invalid

AcceleratorLabel

Alert

Animation

Arrow

Calendar

Canvas

CheckBox

CheckMenuItem

ColorChooser

ColumnHeader

ComboBox

DateEditor

DesktopIcon

DesktopFrame

Dial

Dialog

DirectoryPane

DrawingArea

FileChooser

Filler

FocusTraversable

FontChooser

Frame

GlassPane

HTMLContainer

Icon

Image

InternalFrame

Label

LayeredPane

List

ListItem

Menu

MenuBar

MenuItem

OptionPane

PageTab

PageTabList

Panel

PasswordText

PopupMenu

ProgressBar

PushButton

RadioButton

RadioMenuItem

RootPane

RowHeader

ScrollBar

ScrollPane

Separator

Slider

SpinButton

SplitPane

StatusBar

Table

TableCell

TableColumnHeader

TableRowHeader

TearoffMenuItem

Terminal

Text

ToggleButton

ToolBar

ToolTip

Tree

TreeTable

Unknown

Viewport

Window

Extended

Header

Footer

Paragraph

Ruler

Application

Autocomplete

. Non-semantic elements like ,
and will not be represented here, and this information is not passed through via the atspi library. TODO: add examples for GTK/Qt libraries in addition to HTML examples.