Module: Atk::Role

Defined in:

Constant Summary collapse


Invalid role

0 or :invalid

A label which represents an accelerator

1 or :accelerator_label

An object which is an alert to the user. Assistive Technologies typically respond to ATK_ROLE_ALERT by reading the entire onscreen contents of containers advertising this role. Should be used for warning dialogs, etc.

2 or :alert

An object which is an animated image

3 or :animation

An arrow in one of the four cardinal directions

4 or :arrow

An object that displays a calendar and allows the user to select a date

5 or :calendar

An object that can be drawn into and is used to trap events

6 or :canvas

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

7 or :check_box

A menu item with a check box

8 or :check_menu_item

A specialized dialog that lets the user choose a color

9 or :color_chooser

The header for a column of data

10 or :column_header

A collapsible list of choices the user can select from

11 or :combo_box

An object whose purpose is to allow a user to edit a date

12 or :date_editor

An inconifed internal frame within a DESKTOP_PANE

13 or :desktop_icon

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

14 or :desktop_frame

An object whose purpose is to allow a user to set a value

15 or :dial

A top level window with title bar and a border

16 or :dialog

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

17 or :directory_pane

An object used for drawing custom user interface elements

18 or :drawing_area

A specialized dialog that lets the user choose a file

19 or :file_chooser

A object that fills up space in a user interface

20 or :filler

A specialized dialog that lets the user choose a font

21 or :font_chooser

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

22 or :frame

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

23 or :glass_pane

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

24 or :html_container

A small fixed size picture, typically used to decorate components

25 or :icon

An object whose primary purpose is to display an image

26 or :image

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

27 or :internal_frame

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

28 or :label

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

29 or :layered_pane

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

30 or :list

An object that represents an element of a list

31 or :list_item
32 or :menu
33 or :menu_bar
34 or :menu_item

A specialized pane whose primary use is inside a DIALOG

35 or :option_pane

An object that is a child of a page tab list

36 or :page_tab

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

37 or :page_tab_list

A generic container that is often used to group objects

38 or :panel

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

39 or :password_text
40 or :popup_menu

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

41 or :progress_bar

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

42 or :push_button

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

43 or :radio_button

A check menu item which belongs to a group. At each instant exactly one of the radio menu items from a group is selected

44 or :radio_menu_item

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

45 or :root_pane

The header for a row of data

46 or :row_header

An object usually used to allow a user to incrementally view a large amount of data.

47 or :scroll_bar

An object that allows a user to incrementally view a large amount of information

48 or :scroll_pane

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

49 or :separator

An object that allows the user to select from a bounded range

50 or :slider

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

51 or :split_pane

An object used to get an integer or floating point number from the user

52 or :spin_button

An object which reports messages of minor importance to the user

53 or :statusbar

An object used to represent information in terms of rows and columns

54 or :table

A cell in a table

55 or :table_cell

The header for a column of a table

56 or :table_column_header

The header for a row of a table

57 or :table_row_header

A menu item used to tear off and reattach its menu

58 or :tear_off_menu_item

An object that represents an accessible terminal. (Since: 0.6)

59 or :terminal

An interactive widget that supports multiple lines of text and optionally accepts user input, but whose purpose is not to solicit user input. Thus ATK_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 ATK_ROLE_ENTRY and ATK_ROLE_PASSWORD_TEXT. For generic objects which display a brief amount of textual information, see ATK_ROLE_STATIC.

60 or :text

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

61 or :toggle_button

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

62 or :tool_bar

An object that provides information about another object

63 or :tool_tip

An object used to represent hierarchical information to the user

64 or :tree

An object capable of expanding and collapsing rows as well as showing multiple columns of data. (Since: 0.7)

65 or :tree_table

The object contains some Accessible information, but its role is not known

66 or :unknown

An object usually used in a scroll pane

67 or :viewport

A top level window with no title or border.

68 or :window

An object that serves as a document header. (Since: 1.1.1)

69 or :header
70 or :footer

An object which is contains a paragraph of text content. (Since: 1.1.1)

71 or :paragraph

An object which describes margins and tab stops, etc. for text objects which it controls (should have CONTROLLER_FOR relation to such). (Since: 1.1.1)

72 or :ruler

The object is an application object, which may contain ATK_ROLE_FRAME objects or other types of accessibles. The root accessible of any application’s ATK hierarchy should have ATK_ROLE_APPLICATION. (Since: 1.1.4)

73 or :application

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. (Since: 1.3)

74 or :autocomplete

The object is an editable text object in a toolbar. (Since: 1.5)

75 or :edit_bar

The object is an embedded container within a document or panel. This role is a grouping “hint” indicating that the contained objects share a context. (Since: 1.7.2)

76 or :embedded

The object is a component whose textual content may be entered or modified by the user, provided ATK_STATE_EDITABLE is present. (Since: 1.11)

77 or :entry

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 LABELLED_BY relation is particularly important in interpreting objects of this type, as is the accessible-description property. (Since: 1.11)

78 or :chart

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

79 or :caption

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

80 or :document_frame

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.

81 or :heading

The object is a containing instance which encapsulates a page of information. ATK_ROLE_PAGE is used in documents and content which support a paginated navigation model. (Since: 1.11)

82 or :page

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. (Since: 1.11)

83 or :section

The object is redundant with another object in the hierarchy, and is exposed for purely technical reasons. Objects of this role should normally be ignored by clients. (Since: 1.11)

84 or :redundant_object

The object is a container for form controls, for instance as part of a web form or user-input form within a document. This role is primarily a tag/convenience for clients when navigating complex documents, it is not expected that ordinary GUI containers will always have ATK_ROLE_FORM. (Since: 1.12.0)

85 or :form
86 or :link

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.” (Since: 1.12.1)

87 or :input_method_window

A row in a table. (Since: 2.1.0)

88 or :table_row

An object that represents an element of a tree. (Since: 2.1.0)

89 or :tree_item

A document frame which contains a spreadsheet. (Since: 2.1.0)

90 or :document_spreadsheet

A document frame which contains a presentation or slide content. (Since: 2.1.0)

91 or :document_presentation

A document frame which contains textual content, such as found in a word processing application. (Since: 2.1.0)

92 or :document_text

A document frame which contains HTML or other markup suitable for display in a web browser. (Since: 2.1.0)

93 or :document_web

A document frame which contains email content to be displayed or composed either in plain text or HTML. (Since: 2.1.0)

94 or :document_email

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. (Since: 2.1.0)

95 or :comment

A non-collapsible list of choices the user can select from. (Since: 2.1.0)

96 or :list_box

A group of related widgets. This group typically has a label. (Since: 2.1.0)

97 or :grouping

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. (Since: 2.1.0)

98 or :image_map

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

99 or :notification

An object designed to present a message to the user within an existing window. (Since: 2.1.0)

100 or :info_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.7.3)

101 or :level_bar

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

102 or :title_bar

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

103 or :block_quote

An object which represents an audio element. (Since: 2.12)

104 or :audio

An object which represents a video element. (Since: 2.12)

105 or :video

A definition of a term or concept. (Since: 2.12)

106 or :definition

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)

107 or :article

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)

108 or :landmark

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)

109 or :log

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)

110 or :marquee

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

111 or :math

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 AtkValue. (Since: 2.12)

112 or :rating

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)

113 or :timer

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

114 or :description_list

An object that represents a term or phrase with a corresponding definition. (Since: 2.12)

115 or :description_term

An object that represents the description, definition or value of a term. (Since: 2.12)

116 or :description_value

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 %ATK_ROLE_STATIC is appropriate include the message displayed in a message box and an image used as an alternative means to display text. %ATK_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. Implementors should expose the displayed information through the accessible name of the object. If doing so seems inappropriate, it may indicate that a different role should be used. For labels which describe another widget, see %ATK_ROLE_LABEL. For text views, see %ATK_ROLE_TEXT. For generic containers, see %ATK_ROLE_PANEL. For objects whose role is not known by the implementor, see %ATK_ROLE_UNKNOWN. (Since: 2.16)

117 or :static

An object that represents a mathematical fraction. (Since: 2.16)

118 or :math_fraction

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

119 or :math_root

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

120 or :subscript

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

121 or :superscript

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

122 or :footnote

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

123 or :content_deletion

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

124 or :content_insertion

not a valid role, used for finding end of the enumeration

125 or :last_defined