Atspi.Role
Description: Reference for Atspi.Role

### Enumeration

# AtspiRole

since: 2.0

#### Declaration

    enum Atspi.Role

#### Description [src]

Enumeration used by interface `AtspiAccessible` to specify the role of an `AtspiAccessible` object.

Available since: 2.0

#### Members

`ATSPI_ROLE_INVALID`

  A role indicating an error condition, such as uninitialized Role data.

  - Value: `0`
  - Nickname: `invalid`
  - Available since: 2.0
`ATSPI_ROLE_ACCELERATOR_LABEL`

  Object is a label indicating the keyboard accelerators for the parent.

  - Value: `1`
  - Nickname: `accelerator-label`
  - Available since: 2.0
`ATSPI_ROLE_ALERT`

  Object is used to alert the user about something.

  - Value: `2`
  - Nickname: `alert`
  - Available since: 2.0
`ATSPI_ROLE_ANIMATION`

  Object contains a dynamic or moving image of some kind.

  - Value: `3`
  - Nickname: `animation`
  - Available since: 2.0
`ATSPI_ROLE_ARROW`

  Object is a 2d directional indicator.

  - Value: `4`
  - Nickname: `arrow`
  - Available since: 2.0
`ATSPI_ROLE_CALENDAR`

  Object contains one or more dates, usually arranged into a 2d list.

  - Value: `5`
  - Nickname: `calendar`
  - Available since: 2.0
`ATSPI_ROLE_CANVAS`

  Object that can be drawn into and is used to trap events.

  - Value: `6`
  - Nickname: `canvas`
  - Available since: 2.0
`ATSPI_ROLE_CHECK_BOX`

  A choice that can be checked or unchecked and provides a separate indicator for the current state.

  - Value: `7`
  - Nickname: `check-box`
  - Available since: 2.0
`ATSPI_ROLE_CHECK_MENU_ITEM`

  A menu item that behaves like a check box. See `ATSPI_ROLE_CHECK_BOX`.

  - Value: `8`
  - Nickname: `check-menu-item`
  - Available since: 2.0
`ATSPI_ROLE_COLOR_CHOOSER`

  A specialized dialog that lets the user choose a color.

  - Value: `9`
  - Nickname: `color-chooser`
  - Available since: 2.0
`ATSPI_ROLE_COLUMN_HEADER`

  The header for a column of data.

  - Value: `10`
  - Nickname: `column-header`
  - Available since: 2.0
`ATSPI_ROLE_COMBO_BOX`

  A list of choices the user can select from.

  - Value: `11`
  - Nickname: `combo-box`
  - Available since: 2.0
`ATSPI_ROLE_DATE_EDITOR`

  An object which allows entry of a date.

  - Value: `12`
  - Nickname: `date-editor`
  - Available since: 2.0
`ATSPI_ROLE_DESKTOP_ICON`

  An inconifed internal frame within a DESKTOP_FRAME.

  - Value: `13`
  - Nickname: `desktop-icon`
  - Available since: 2.0
`ATSPI_ROLE_DESKTOP_FRAME`

  A pane that supports internal frames and iconified versions of those internal frames.

  - Value: `14`
  - Nickname: `desktop-frame`
  - Available since: 2.0
`ATSPI_ROLE_DIAL`

  An object that allows a value to be changed via rotating a visual element, or which displays a value via such a rotating element.

  - Value: `15`
  - Nickname: `dial`
  - Available since: 2.0
`ATSPI_ROLE_DIALOG`

  A top level window with title bar and a border.

  - Value: `16`
  - Nickname: `dialog`
  - Available since: 2.0
`ATSPI_ROLE_DIRECTORY_PANE`

  A pane that allows the user to navigate through and select the contents of a directory.

  - Value: `17`
  - Nickname: `directory-pane`
  - Available since: 2.0
`ATSPI_ROLE_DRAWING_AREA`

  An object used for drawing custom user interface elements.

  - Value: `18`
  - Nickname: `drawing-area`
  - Available since: 2.0
`ATSPI_ROLE_FILE_CHOOSER`

  A specialized dialog that displays the files in the directory and lets the user select a file, browse a different directory, or specify a filename.

  - Value: `19`
  - Nickname: `file-chooser`
  - Available since: 2.0
`ATSPI_ROLE_FILLER`

  A object that fills up space in a user interface.

  - Value: `20`
  - Nickname: `filler`
  - Available since: 2.0
`ATSPI_ROLE_FOCUS_TRAVERSABLE`

  Don’t use, reserved for future use.

  - Value: `21`
  - Nickname: `focus-traversable`
  - Available since: 2.0
`ATSPI_ROLE_FONT_CHOOSER`

  Allows selection of a display font.

  - Value: `22`
  - Nickname: `font-chooser`
  - Available since: 2.0
`ATSPI_ROLE_FRAME`

  A top level window with a title bar, border, menubar, etc.

  - Value: `23`
  - Nickname: `frame`
  - Available since: 2.0
`ATSPI_ROLE_GLASS_PANE`

  A pane that is guaranteed to be painted on top of all panes beneath it.

  - Value: `24`
  - Nickname: `glass-pane`
  - Available since: 2.0
`ATSPI_ROLE_HTML_CONTAINER`

  A document container for HTML, whose children represent the document content.

  - Value: `25`
  - Nickname: `html-container`
  - Available since: 2.0
`ATSPI_ROLE_ICON`

  A small fixed size picture, typically used to decorate components.

  - Value: `26`
  - Nickname: `icon`
  - Available since: 2.0
`ATSPI_ROLE_IMAGE`

  An image, typically static.

  - Value: `27`
  - Nickname: `image`
  - Available since: 2.0
`ATSPI_ROLE_INTERNAL_FRAME`

  A frame-like object that is clipped by a desktop pane.

  - Value: `28`
  - Nickname: `internal-frame`
  - Available since: 2.0
`ATSPI_ROLE_LABEL`

  An object used to present an icon or short string in an interface.

  - Value: `29`
  - Nickname: `label`
  - Available since: 2.0
`ATSPI_ROLE_LAYERED_PANE`

  A specialized pane that allows its children to be drawn in layers, providing a form of stacking order.

  - Value: `30`
  - Nickname: `layered-pane`
  - Available since: 2.0
`ATSPI_ROLE_LIST`

  An object that presents a list of objects to the user and allows the user to select one or more of them.

  - Value: `31`
  - Nickname: `list`
  - Available since: 2.0
`ATSPI_ROLE_LIST_ITEM`

  An object that represents an element of a list.

  - Value: `32`
  - Nickname: `list-item`
  - Available since: 2.0
`ATSPI_ROLE_MENU`

  An object usually found inside a menu bar that contains a list of actions the user can choose from.

  - Value: `33`
  - Nickname: `menu`
  - Available since: 2.0
`ATSPI_ROLE_MENU_BAR`

  An object usually drawn at the top of the primary dialog box of an application that contains a list of menus the user can choose from.

  - Value: `34`
  - Nickname: `menu-bar`
  - Available since: 2.0
`ATSPI_ROLE_MENU_ITEM`

  An object usually contained in a menu that presents an action the user can choose.

  - Value: `35`
  - Nickname: `menu-item`
  - Available since: 2.0
`ATSPI_ROLE_OPTION_PANE`

  A specialized pane whose primary use is inside a dialog.

  - Value: `36`
  - Nickname: `option-pane`
  - Available since: 2.0
`ATSPI_ROLE_PAGE_TAB`

  An object that is a child of a page tab list.

  - Value: `37`
  - Nickname: `page-tab`
  - Available since: 2.0
`ATSPI_ROLE_PAGE_TAB_LIST`

  An object that presents a series of panels (or page tabs), one at a time,through some mechanism provided by the object.

  - Value: `38`
  - Nickname: `page-tab-list`
  - Available since: 2.0
`ATSPI_ROLE_PANEL`

  A generic container that is often used to group objects.

  - Value: `39`
  - Nickname: `panel`
  - Available since: 2.0
`ATSPI_ROLE_PASSWORD_TEXT`

  A text object uses for passwords, or other places where the text content is not shown visibly to the user.

  - Value: `40`
  - Nickname: `password-text`
  - Available since: 2.0
`ATSPI_ROLE_POPUP_MENU`

  A temporary window that is usually used to offer the user a list of choices, and then hides when the user selects one of those choices.

  - Value: `41`
  - Nickname: `popup-menu`
  - Available since: 2.0
`ATSPI_ROLE_PROGRESS_BAR`

  An object used to indicate how much of a task has been completed.

  - Value: `42`
  - Nickname: `progress-bar`
  - Available since: 2.0
`ATSPI_ROLE_PUSH_BUTTON`

  An object the user can manipulate to tell the application to do something.

  - Value: `43`
  - Nickname: `push-button`
  - Available since: 2.0
`ATSPI_ROLE_RADIO_BUTTON`

  A specialized check box that will cause other radio buttons in the same group to become unchecked when this one is checked.

  - Value: `44`
  - Nickname: `radio-button`
  - Available since: 2.0
`ATSPI_ROLE_RADIO_MENU_ITEM`

  Object is both a menu item and a “radio button” . See `ATSPI_ROLE_RADIO_BUTTON`.

  - Value: `45`
  - Nickname: `radio-menu-item`
  - Available since: 2.0
`ATSPI_ROLE_ROOT_PANE`

  A specialized pane that has a glass pane and a layered pane as its children.

  - Value: `46`
  - Nickname: `root-pane`
  - Available since: 2.0
`ATSPI_ROLE_ROW_HEADER`

  The header for a row of data.

  - Value: `47`
  - Nickname: `row-header`
  - Available since: 2.0
`ATSPI_ROLE_SCROLL_BAR`

  An object usually used to allow a user to incrementally view a large amount of data by moving the bounds of a viewport along a one-dimensional axis.

  - Value: `48`
  - Nickname: `scroll-bar`
  - Available since: 2.0
`ATSPI_ROLE_SCROLL_PANE`

  An object that allows a user to incrementally view a large amount of information. `ATSPI_ROLE_SCROLL_PANE` objects are usually accompanied by `ATSPI_ROLE_SCROLL_BAR` controllers, on which the `ATSPI_RELATION_CONTROLLER_FOR` and `ATSPI_RELATION_CONTROLLED_BY` reciprocal relations are set. See #atspi_get_relation_set.

  - Value: `49`
  - Nickname: `scroll-pane`
  - Available since: 2.0
`ATSPI_ROLE_SEPARATOR`

  An object usually contained in a menu to provide a visible and logical separation of the contents in a menu.

  - Value: `50`
  - Nickname: `separator`
  - Available since: 2.0
`ATSPI_ROLE_SLIDER`

  An object that allows the user to select from a bounded range. Unlike `ATSPI_ROLE_SCROLL_BAR`, `ATSPI_ROLE_SLIDER` objects need not control ‘viewport’-like objects.

  - Value: `51`
  - Nickname: `slider`
  - Available since: 2.0
`ATSPI_ROLE_SPIN_BUTTON`

  An object which allows one of a set of choices to be selected, and which displays the current choice.

  - Value: `52`
  - Nickname: `spin-button`
  - Available since: 2.0
`ATSPI_ROLE_SPLIT_PANE`

  A specialized panel that presents two other panels at the same time.

  - Value: `53`
  - Nickname: `split-pane`
  - Available since: 2.0
`ATSPI_ROLE_STATUS_BAR`

  Object displays non-quantitative status information (c.f. `ATSPI_ROLE_PROGRESS_BAR`)

  - Value: `54`
  - Nickname: `status-bar`
  - Available since: 2.0
`ATSPI_ROLE_TABLE`

  An object used to repesent information in terms of rows and columns.

  - Value: `55`
  - Nickname: `table`
  - Available since: 2.0
`ATSPI_ROLE_TABLE_CELL`

  A ‘cell’ or discrete child within a Table. Note: Table cells need not have `ATSPI_ROLE_TABLE_CELL`, other `AtspiRoleType` values are valid as well.

  - Value: `56`
  - Nickname: `table-cell`
  - Available since: 2.0
`ATSPI_ROLE_TABLE_COLUMN_HEADER`

  An object which labels a particular column in an `AtspiTable`.

  - Value: `57`
  - Nickname: `table-column-header`
  - Available since: 2.0
`ATSPI_ROLE_TABLE_ROW_HEADER`

  An object which labels a particular row in a `AtspiTable`. `AtspiTable` rows and columns may also be labelled via the `ATSPI_RELATION_LABEL_FOR`/`ATSPI_RELATION_LABELLED_BY` relationships. See #atspi_get_relation_set.

  - Value: `58`
  - Nickname: `table-row-header`
  - Available since: 2.0
`ATSPI_ROLE_TEAROFF_MENU_ITEM`

  Object allows menu to be removed from menubar and shown in its own window.

  - Value: `59`
  - Nickname: `tearoff-menu-item`
  - Available since: 2.0
`ATSPI_ROLE_TERMINAL`

  An object that emulates a terminal.

  - Value: `60`
  - Nickname: `terminal`
  - Available since: 2.0
`ATSPI_ROLE_TEXT`

  An interactive widget that supports multiple lines of text and optionally accepts user input, but whose purpose is not to solicit user input. Thus `ATSPI_ROLE_TEXT` is appropriate for the text view in a plain text editor but inappropriate for an input field in a dialog box or web form. For widgets whose purpose is to solicit input from the user, see `ATSPI_ROLE_ENTRY` and `ATSPI_ROLE_PASSWORD_TEXT`. For generic objects which display a brief amount of textual information, see `ATSPI_ROLE_STATIC`.

  - Value: `61`
  - Nickname: `text`
  - Available since: 2.0
`ATSPI_ROLE_TOGGLE_BUTTON`

  A specialized push button that can be checked or unchecked, but does not procide a separate indicator for the current state.

  - Value: `62`
  - Nickname: `toggle-button`
  - Available since: 2.0
`ATSPI_ROLE_TOOL_BAR`

  A bar or palette usually composed of push buttons or toggle buttons.

  - Value: `63`
  - Nickname: `tool-bar`
  - Available since: 2.0
`ATSPI_ROLE_TOOL_TIP`

  An object that provides information about another object.

  - Value: `64`
  - Nickname: `tool-tip`
  - Available since: 2.0
`ATSPI_ROLE_TREE`

  An object used to repsent hierarchical information to the user.

  - Value: `65`
  - Nickname: `tree`
  - Available since: 2.0
`ATSPI_ROLE_TREE_TABLE`

  An object that presents both tabular and hierarchical info to the user.

  - Value: `66`
  - Nickname: `tree-table`
  - Available since: 2.0
`ATSPI_ROLE_UNKNOWN`

  The object contains some `AtspiAccessible` information, but its role is not known.

  - Value: `67`
  - Nickname: `unknown`
  - Available since: 2.0
`ATSPI_ROLE_VIEWPORT`

  An object usually used in a scroll pane, or to otherwise clip a larger object or content renderer to a specific onscreen viewport.

  - Value: `68`
  - Nickname: `viewport`
  - Available since: 2.0
`ATSPI_ROLE_WINDOW`

  A top level window with no title or border.

  - Value: `69`
  - Nickname: `window`
  - Available since: 2.0
`ATSPI_ROLE_EXTENDED`

  Means that the role for this item is known, but not included in the core enumeration. Deprecated since 2.24.

  - Value: `70`
  - Nickname: `extended`
  - Available since: 2.0
`ATSPI_ROLE_HEADER`

  An object that serves as a document header.

  - Value: `71`
  - Nickname: `header`
  - Available since: 2.0
`ATSPI_ROLE_FOOTER`

  An object that serves as a document footer.

  - Value: `72`
  - Nickname: `footer`
  - Available since: 2.0
`ATSPI_ROLE_PARAGRAPH`

  An object which is contains a single paragraph of text content. See also `ATSPI_ROLE_TEXT`.

  - Value: `73`
  - Nickname: `paragraph`
  - Available since: 2.0
`ATSPI_ROLE_RULER`

  An object which describes margins and tab stops, etc. for text objects which it controls (should have `ATSPI_RELATION_CONTROLLER_FOR` relation to such).

  - Value: `74`
  - Nickname: `ruler`
  - Available since: 2.0
`ATSPI_ROLE_APPLICATION`

  An object corresponding to the toplevel accessible of an application, which may contain `ATSPI_ROLE_FRAME` objects or other accessible objects. Children of objects with the #ATSPI_ROLE_DESKTOP_FRAME role are generally `ATSPI_ROLE_APPLICATION` objects.

  - Value: `75`
  - Nickname: `application`
  - Available since: 2.0
`ATSPI_ROLE_AUTOCOMPLETE`

  The object is a dialog or list containing items for insertion into an entry widget, for instance a list of words for completion of a text entry.

  - Value: `76`
  - Nickname: `autocomplete`
  - Available since: 2.0
`ATSPI_ROLE_EDITBAR`

  The object is an editable text object in a toolbar.

  - Value: `77`
  - Nickname: `editbar`
  - Available since: 2.0
`ATSPI_ROLE_EMBEDDED`

  The object is an embedded component container. This role is a “grouping” hint that the contained objects share a context which is different from the container in which this accessible is embedded. In particular, it is used for some kinds of document embedding, and for embedding of out-of-process component, “panel applets”, etc.

  - Value: `78`
  - Nickname: `embedded`
  - Available since: 2.0
`ATSPI_ROLE_ENTRY`

  The object is a component whose textual content may be entered or modified by the user, provided `ATSPI_STATE_EDITABLE` is present. A readonly `ATSPI_ROLE_ENTRY` object (i.e. where `ATSPI_STATE_EDITABLE` is not present) implies a read-only ‘text field’ in a form, as opposed to a title, label, or caption.

  - Value: `79`
  - Nickname: `entry`
  - Available since: 2.0
`ATSPI_ROLE_CHART`

  The object is a graphical depiction of quantitative data. It may contain multiple subelements whose attributes and/or description may be queried to obtain both the quantitative data and information about how the data is being presented. The `ATSPI_LABELLED_BY` relation is particularly important in interpreting objects of this type, as is the accessible description property. See `ATSPI_ROLE_CAPTION`.

  - Value: `80`
  - Nickname: `chart`
  - Available since: 2.0
`ATSPI_ROLE_CAPTION`

  The object contains descriptive information, usually textual, about another user interface element such as a table, chart, or image.

  - Value: `81`
  - Nickname: `caption`
  - Available since: 2.0
`ATSPI_ROLE_DOCUMENT_FRAME`

  The object is a visual frame or container which contains a view of document content. `AtspiDocument` frames may occur within another `AtspiDocument` instance, in which case the second document may be said to be embedded in the containing instance. HTML frames are often ATSPI_ROLE_DOCUMENT_FRAME: Either this object, or a singleton descendant, should implement the `AtspiDocument` interface.

  - Value: `82`
  - Nickname: `document-frame`
  - Available since: 2.0
`ATSPI_ROLE_HEADING`

  The object serves as a heading for content which follows it in a document. The ‘heading level’ of the heading, if availabe, may be obtained by querying the object’s attributes.

  - Value: `83`
  - Nickname: `heading`
  - Available since: 2.0
`ATSPI_ROLE_PAGE`

  The object is a containing instance which encapsulates a page of information. `ATSPI_ROLE_PAGE` is used in documents and content which support a paginated navigation model.

  - Value: `84`
  - Nickname: `page`
  - Available since: 2.0
`ATSPI_ROLE_SECTION`

  The object is a containing instance of document content which constitutes a particular ‘logical’ section of the document. The type of content within a section, and the nature of the section division itself, may be obtained by querying the object’s attributes. Sections may be nested.

  - Value: `85`
  - Nickname: `section`
  - Available since: 2.0
`ATSPI_ROLE_REDUNDANT_OBJECT`

  The object is redundant with another object in the hierarchy, and is exposed for purely technical reasons. Objects of this role should be ignored by clients, if they are encountered at all.

  - Value: `86`
  - Nickname: `redundant-object`
  - Available since: 2.0
`ATSPI_ROLE_FORM`

  The object is a containing instance of document content which has within it components with which the user can interact in order to input information; i.e. the object is a container for pushbuttons, comboboxes, text input fields, and other ‘GUI’ components. `ATSPI_ROLE_FORM` should not, in general, be used for toplevel GUI containers or dialogs, but should be reserved for ‘GUI’ containers which occur within document content, for instance within Web documents, presentations, or text documents. Unlike other GUI containers and dialogs which occur inside application instances, `ATSPI_ROLE_FORM` containers’ components are associated with the current document, rather than the current foreground application or viewer instance.

  - Value: `87`
  - Nickname: `form`
  - Available since: 2.0
`ATSPI_ROLE_LINK`

  The object is a hypertext anchor, i.e. a “link” in a hypertext document. Such objects are distinct from ‘inline’ content which may also use the `AtspiHypertext`/`AtspiHyperlink` interfacesto indicate the range/location within a text object where an inline or embedded object lies.

  - Value: `88`
  - Nickname: `link`
  - Available since: 2.0
`ATSPI_ROLE_INPUT_METHOD_WINDOW`

  The object is a window or similar viewport which is used to allow composition or input of a ‘complex character’, in other words it is an “input method window”.

  - Value: `89`
  - Nickname: `input-method-window`
  - Available since: 2.0
`ATSPI_ROLE_TABLE_ROW`

  A row in a table.

  - Value: `90`
  - Nickname: `table-row`
  - Available since: 2.0
`ATSPI_ROLE_TREE_ITEM`

  An object that represents an element of a tree.

  - Value: `91`
  - Nickname: `tree-item`
  - Available since: 2.0
`ATSPI_ROLE_DOCUMENT_SPREADSHEET`

  A document frame which contains a spreadsheet.

  - Value: `92`
  - Nickname: `document-spreadsheet`
  - Available since: 2.0
`ATSPI_ROLE_DOCUMENT_PRESENTATION`

  A document frame which contains a presentation or slide content.

  - Value: `93`
  - Nickname: `document-presentation`
  - Available since: 2.0
`ATSPI_ROLE_DOCUMENT_TEXT`

  A document frame which contains textual content, such as found in a word processing application.

  - Value: `94`
  - Nickname: `document-text`
  - Available since: 2.0
`ATSPI_ROLE_DOCUMENT_WEB`

  A document frame which contains HTML or other markup suitable for display in a web browser.

  - Value: `95`
  - Nickname: `document-web`
  - Available since: 2.0
`ATSPI_ROLE_DOCUMENT_EMAIL`

  A document frame which contains email content to be displayed or composed either in plain text or HTML.

  - Value: `96`
  - Nickname: `document-email`
  - Available since: 2.0
`ATSPI_ROLE_COMMENT`

  An object found within a document and designed to present a comment, note, or other annotation. In some cases, this object might not be visible until activated.

  - Value: `97`
  - Nickname: `comment`
  - Available since: 2.0
`ATSPI_ROLE_LIST_BOX`

  A non-collapsible list of choices the user can select from.

  - Value: `98`
  - Nickname: `list-box`
  - Available since: 2.0
`ATSPI_ROLE_GROUPING`

  A group of related widgets. This group typically has a label.

  - Value: `99`
  - Nickname: `grouping`
  - Available since: 2.0
`ATSPI_ROLE_IMAGE_MAP`

  An image map object. Usually a graphic with multiple hotspots, where each hotspot can be activated resulting in the loading of another document or section of a document.

  - Value: `100`
  - Nickname: `image-map`
  - Available since: 2.0
`ATSPI_ROLE_NOTIFICATION`

  A transitory object designed to present a message to the user, typically at the desktop level rather than inside a particular application.

  - Value: `101`
  - Nickname: `notification`
  - Available since: 2.0
`ATSPI_ROLE_INFO_BAR`

  An object designed to present a message to the user within an existing window.

  - Value: `102`
  - Nickname: `info-bar`
  - Available since: 2.0
`ATSPI_ROLE_LEVEL_BAR`

  A bar that serves as a level indicator to, for instance, show the strength of a password or the state of a battery. `Since`: 2.8

  - Value: `103`
  - Nickname: `level-bar`
  - Available since: 2.0
`ATSPI_ROLE_TITLE_BAR`

  A bar that serves as the title of a window or a dialog. `Since`: 2.12

  - Value: `104`
  - Nickname: `title-bar`
  - Available since: 2.0
`ATSPI_ROLE_BLOCK_QUOTE`

  An object which contains a text section that is quoted from another source. `Since`: 2.12

  - Value: `105`
  - Nickname: `block-quote`
  - Available since: 2.0
`ATSPI_ROLE_AUDIO`

  An object which represents an audio element. `Since`: 2.12

  - Value: `106`
  - Nickname: `audio`
  - Available since: 2.0
`ATSPI_ROLE_VIDEO`

  An object which represents a video element. `Since`: 2.12

  - Value: `107`
  - Nickname: `video`
  - Available since: 2.0
`ATSPI_ROLE_DEFINITION`

  A definition of a term or concept. `Since`: 2.12

  - Value: `108`
  - Nickname: `definition`
  - Available since: 2.0
`ATSPI_ROLE_ARTICLE`

  A section of a page that consists of a composition that forms an independent part of a document, page, or site. Examples: A blog entry, a news story, a forum post. `Since`: 2.12

  - Value: `109`
  - Nickname: `article`
  - Available since: 2.0
`ATSPI_ROLE_LANDMARK`

  A region of a web page intended as a navigational landmark. This is designed to allow Assistive Technologies to provide quick navigation among key regions within a document. `Since`: 2.12

  - Value: `110`
  - Nickname: `landmark`
  - Available since: 2.0
`ATSPI_ROLE_LOG`

  A text widget or container holding log content, such as chat history and error logs. In this role there is a relationship between the arrival of new items in the log and the reading order. The log contains a meaningful sequence and new information is added only to the end of the log, not at arbitrary points. `Since`: 2.12

  - Value: `111`
  - Nickname: `log`
  - Available since: 2.0
`ATSPI_ROLE_MARQUEE`

  A container where non-essential information changes frequently. Common usages of marquee include stock tickers and ad banners. The primary difference between a marquee and a log is that logs usually have a meaningful order or sequence of important content changes. `Since`: 2.12

  - Value: `112`
  - Nickname: `marquee`
  - Available since: 2.0
`ATSPI_ROLE_MATH`

  A text widget or container that holds a mathematical expression. `Since`: 2.12

  - Value: `113`
  - Nickname: `math`
  - Available since: 2.0
`ATSPI_ROLE_RATING`

  A widget whose purpose is to display a rating, such as the number of stars associated with a song in a media player. Objects of this role should also implement AtspiValue. `Since`: 2.12

  - Value: `114`
  - Nickname: `rating`
  - Available since: 2.0
`ATSPI_ROLE_TIMER`

  An object containing a numerical counter which indicates an amount of elapsed time from a start point, or the time remaining until an end point. `Since`: 2.12

  - Value: `115`
  - Nickname: `timer`
  - Available since: 2.0
`ATSPI_ROLE_STATIC`

  A generic non-container object whose purpose is to display a brief amount of information to the user and whose role is known by the implementor but lacks semantic value for the user. Examples in which `ATSPI_ROLE_STATIC` is appropriate include the message displayed in a message box and an image used as an alternative means to display text. `ATSPI_ROLE_STATIC` should not be applied to widgets which are traditionally interactive, objects which display a significant amount of content, or any object which has an accessible relation pointing to another object. The displayed information, as a general rule, should be exposed through the accessible name of the object. For labels which describe another widget, see `ATSPI_ROLE_LABEL`. For text views, see `ATSPI_ROLE_TEXT`. For generic containers, see `ATSPI_ROLE_PANEL`. For objects whose role is not known by the implementor, see `ATSPI_ROLE_UNKNOWN`. `Since`: 2.16.

  - Value: `116`
  - Nickname: `static`
  - Available since: 2.0
`ATSPI_ROLE_MATH_FRACTION`

  An object that represents a mathematical fraction. `Since`: 2.16.

  - Value: `117`
  - Nickname: `math-fraction`
  - Available since: 2.0
`ATSPI_ROLE_MATH_ROOT`

  An object that represents a mathematical expression displayed with a radical. `Since`: 2.16.

  - Value: `118`
  - Nickname: `math-root`
  - Available since: 2.0
`ATSPI_ROLE_SUBSCRIPT`

  An object that contains text that is displayed as a subscript. `Since`: 2.16.

  - Value: `119`
  - Nickname: `subscript`
  - Available since: 2.0
`ATSPI_ROLE_SUPERSCRIPT`

  An object that contains text that is displayed as a superscript. `Since`: 2.16.

  - Value: `120`
  - Nickname: `superscript`
  - Available since: 2.0
`ATSPI_ROLE_DESCRIPTION_LIST`

  An object that represents a list of term-value groups. A term-value group represents an individual description and consist of one or more names (`ATSPI_ROLE_DESCRIPTION_TERM`) followed by one or more values (`ATSPI_ROLE_DESCRIPTION_VALUE`). For each list, there should not be more than one group with the same term name. `Since`: 2.26.

  - Value: `121`
  - Nickname: `description-list`
  - Available since: 2.0
`ATSPI_ROLE_DESCRIPTION_TERM`

  An object that represents a term or phrase with a corresponding definition. `Since`: 2.26.

  - Value: `122`
  - Nickname: `description-term`
  - Available since: 2.0
`ATSPI_ROLE_DESCRIPTION_VALUE`

  An object that represents the description, definition, or value of a term. `Since`: 2.26.

  - Value: `123`
  - Nickname: `description-value`
  - Available since: 2.0
`ATSPI_ROLE_FOOTNOTE`

  An object that contains the text of a footnote. `Since`: 2.26.

  - Value: `124`
  - Nickname: `footnote`
  - Available since: 2.0
`ATSPI_ROLE_CONTENT_DELETION`

  Content previously deleted or proposed to be deleted, e.g. in revision history or a content view providing suggestions from reviewers. `Since`: 2.34.

  - Value: `125`
  - Nickname: `content-deletion`
  - Available since: 2.0
`ATSPI_ROLE_CONTENT_INSERTION`

  Content previously inserted or proposed to be inserted, e.g. in revision history or a content view providing suggestions from reviewers. `Since`: 2.34.

  - Value: `126`
  - Nickname: `content-insertion`
  - Available since: 2.0
`ATSPI_ROLE_MARK`

  A run of content that is marked or highlighted, such as for reference purposes, or to call it out as having a special purpose. If the marked content has an associated section in the document elaborating on the reason for the mark, then `ATSPI_RELATION_DETAILS` should be used on the mark to point to that associated section. In addition, the reciprocal relation `ATSPI_RELATION_DETAILS_FOR` should be used on the associated content section to point back to the mark. `Since`: 2.36.

  - Value: `127`
  - Nickname: `mark`
  - Available since: 2.0
`ATSPI_ROLE_SUGGESTION`

  A container for content that is called out as a proposed change from the current version of the document, such as by a reviewer of the content. An object with this role should include children with `ATSPI_ROLE_CONTENT_DELETION` and/or `ATSPI_ROLE_CONTENT_INSERTION`, in any order, to indicate what the actual change is. `Since`: 2.36

  - Value: `128`
  - Nickname: `suggestion`
  - Available since: 2.0
`ATSPI_ROLE_PUSH_BUTTON_MENU`

  A specialized push button to open a menu. `Since` 2.46

  - Value: `129`
  - Nickname: `push-button-menu`
  - Available since: 2.0
`ATSPI_ROLE_LAST_DEFINED`

  Not a valid role, used for finding end of enumeration.

  - Value: `130`
  - Nickname: `last-defined`
  - Available since: 2.0

#### Type functions

###### atspi_role_get_localized_name

Gets the localized description string describing the `AtspiRole` `role`.

since: 2.0

###### atspi_role_get_name

Gets a localizable string that indicates the name of an `AtspiRole`.

since: 2.0