Describes the role of an object.
These are the built-in enumerated roles that UI components can have in ATK. Other roles may be added at runtime, so an AtkRole >= Atk::ROLE_LAST_DEFINED is not necessarily an error.
Value | Symbolic name | Description |
| 0 | Atk::ROLE_INVALID | Invalid role |
| 1 | Atk::ROLE_ACCEL_LABEL | A label which represents an accelerator |
| 2 | Atk::ROLE_ALERT | An object which is an alert to the user |
| 3 | Atk::ROLE_ANIMATION | An object which is an animated image |
| 4 | Atk::ROLE_ARROW | An arrow in one of the four cardinal directions |
| 5 | Atk::ROLE_CALENDAR | An object that displays a calendar and allows the user to select a date |
| 6 | Atk::ROLE_CANVAS | An object that can be drawn into and is used to trap events |
| 7 | Atk::ROLE_CHECK_BOX | A choice that can be checked or unchecked and provides a separate indicator for the current state |
| 8 | Atk::ROLE_CHECK_MENU_ITEM | A menu item with a check box |
| 9 | Atk::ROLE_COLOR_CHOOSER | A specialized dialog that lets the user choose a color |
| 10 | Atk::ROLE_COLUMN_HEADER | The header for a column of data |
| 11 | Atk::ROLE_COMBO_BOX | A list of choices the user can select from |
| 12 | Atk::ROLE_DATE_EDITOR | An object whose purpose is to allow a user to edit a date |
| 13 | Atk::ROLE_DESKTOP_ICON | An inconifed internal frame within a DESKTOP_PANE |
| 14 | Atk::ROLE_DESKTOP_FRAME | A pane that supports internal frames and iconified versions of those internal frames |
| 15 | Atk::ROLE_DIAL | An object whose purpose is to allow a user to set a value |
| 16 | Atk::ROLE_DIALOG | A top level window with title bar and a border |
| 17 | Atk::ROLE_DIRECTORY_PANE | A pane that allows the user to navigate through and select the contents of a directory |
| 18 | Atk::ROLE_DRAWING_AREA | An object used for drawing custom user interface elements |
| 19 | Atk::ROLE_FILE_CHOOSER | A specialized dialog that lets the user choose a file |
| 20 | Atk::ROLE_FILLER | A object that fills up space in a user interface |
| 21 | Atk::ROLE_FONT_CHOOSER | A specialized dialog that lets the user choose a font |
| 22 | Atk::ROLE_FRAME | A top level window with a title bar, border, menubar, etc. |
| 23 | Atk::ROLE_GLASS_PANE | A pane that is guaranteed to be painted on top of all panes beneath it |
| 24 | Atk::ROLE_HTML_CONTAINER | A document container for HTML, whose children represent the document content |
| 25 | Atk::ROLE_ICON | A small fixed size picture, typically used to decorate components |
| 26 | Atk::ROLE_IMAGE | An object whose primary purpose is to display an image |
| 27 | Atk::ROLE_INTERNAL_FRAME | A frame-like object that is clipped by a desktop pane |
| 28 | Atk::ROLE_LABEL | An object used to present an icon or short string in an interface |
| 29 | Atk::ROLE_LAYERED_PANE | A specialized pane that allows its children to be drawn in layers, providing a form of stacking order |
| 30 | Atk::ROLE_LIST | An object that presents a list of objects to the user and allows the user to select one or more of them |
| 31 | Atk::ROLE_LIST_ITEM | An object that represents an element of a list |
| 32 | Atk::ROLE_MENU | An object usually found inside a menu bar that contains a list of actions the user can choose from |
| 33 | Atk::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 |
| 34 | Atk::ROLE_MENU_ITEM | An object usually contained in a menu that presents an action the user can choose |
| 35 | Atk::ROLE_OPTION_PANE | A specialized pane whose primary use is inside a DIALOG |
| 36 | Atk::ROLE_PAGE_TAB | An object that is a child of a page tab list |
| 37 | Atk::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 |
| 38 | Atk::ROLE_PANEL | A generic container that is often used to group objects |
| 39 | Atk::ROLE_PASSWORD_TEXT | A text object uses for passwords, or other places where the text content is not shown visibly to the user |
| 40 | Atk::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 |
| 41 | Atk::ROLE_PROGRESS_BAR | An object used to indicate how much of a task has been completed |
| 42 | Atk::ROLE_PUSH_BUTTON | An object the user can manipulate to tell the application to do something |
| 43 | Atk::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 |
| 44 | Atk::ROLE_RADIO_MENU_ITEM | A check menu item which belongs to a group. At each instant exactly one of the radio menu items from a group is selected |
| 45 | Atk::ROLE_ROOT_PANE | A specialized pane that has a glass pane and a layered pane as its children |
| 46 | Atk::ROLE_ROW_HEADER | The header for a row of data |
| 47 | Atk::ROLE_SCROLL_BAR | An object usually used to allow a user to incrementally view a large amount of data. |
| 48 | Atk::ROLE_SCROLL_PANE | An object that allows a user to incrementally view a large amount of information |
| 49 | Atk::ROLE_SEPARATOR | An object usually contained in a menu to provide a visible and logical separation of the contents in a menu |
| 50 | Atk::ROLE_SLIDER | An object that allows the user to select from a bounded range |
| 51 | Atk::ROLE_SPLIT_PANE | A specialized panel that presents two other panels at the same time |
| 52 | Atk::ROLE_SPIN_BUTTON | An object used to get an integer or floating point number from the user |
| 53 | Atk::ROLE_STATUSBAR | An object which reports messages of minor importance to the user |
| 54 | Atk::ROLE_TABLE | An object used to represent information in terms of rows and columns |
| 55 | Atk::ROLE_TABLE_CELL | A cell in a table |
| 56 | Atk::ROLE_TABLE_COLUMN_HEADER | The header for a column of a table |
| 57 | Atk::ROLE_TABLE_ROW_HEADER | The header for a row of a table |
| 58 | Atk::ROLE_TEAR_OFF_MENU_ITEM | A menu item used to tear off and reattach its menu |
| 59 | Atk::ROLE_TERMINAL | An object that represents an accessible terminal |
| 60 | Atk::ROLE_TEXT | An object that presents text to the user |
| 61 | Atk::ROLE_TOGGLE_BUTTON | A specialized push button that can be checked or unchecked, but does not provide a separate indicator for the current state |
| 62 | Atk::ROLE_TOOL_BAR | A bar or palette usually composed of push buttons or toggle buttons |
| 63 | Atk::ROLE_TOOL_TIP | An object that provides information about another object |
| 64 | Atk::ROLE_TREE | An object used to represent hierarchical information to the user |
| 65 | Atk::ROLE_TREE_TABLE | An object capable of expanding and collapsing rows as well as showing multiple columns of data |
| 66 | Atk::ROLE_UNKNOWN | The object contains some Accessible information, but its role is not known |
| 67 | Atk::ROLE_VIEWPORT | An object usually used in a scroll pane |
| 68 | Atk::ROLE_WINDOW | A top level window with no title or border. |
| 69 | Atk::ROLE_HEADER | An object that serves as a document header. |
| 70 | Atk::ROLE_FOOTER | An object that serves as a document footer. |
| 71 | Atk::ROLE_PARAGRAPH | An object which is contains a paragraph of text content. |
| 72 | Atk::ROLE_RULER | An object which describes margins and tab stops, etc. for text objects which it controls (should have CONTROLLER_FOR relation to such). |
| 73 | Atk::ROLE_APPLICATION | The object is an application object, which may contain Atk::ROLE_FRAME objects or other types of accessibles. |
| 74 | Atk::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. |
| 75 | Atk::ROLE_EDITBAR | The object is an editable text object in a toolbar |
| 76 | Atk::ROLE_EMBEDDED | 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. |
| 77 | Atk::ROLE_LAST_DEFINED | not a valid role, used for finding end of enumeration |