This appendix lists many of the roles Mac OS X defines, along with the attributes an object of that role should support. If you must create accessibility objects to represent custom user interface objects in your application, you can use this information to ensure you support the appropriate set of attributes. If you are an assistive application developer, you can use this information to learn what values you can get from objects of different roles.
Because different application frameworks have different ways of implementing the accessibility object, the type of an attribute’s value also differs according to the application framework. For example, a string value in the Carbon accessibility implementation is usually an object of type CFStringRef, whereas in Cocoa, a string is implemented as an NSString. The value types listed in the tables in this appendix are therefore generic, such as string or Boolean. The exception to this is when the value type is an accessibility object. In these cases, in the interests of space, the tables list UIElement instead of Accessibility Object.
The application frameworks also provide different constant names for attributes, roles, actions, and notifications. In Carbon, for example, the radio-button role is defined as the constant kAXRadioButtonRole and the CFString AXRadioButton. In Cocoa, the same role is defined as the constant NSString NSAccessibilityRadioButtonRole. This document, therefore, uses the base of the name, which is common to both frameworks, and displays it as a title. To refer to the radio-button role, for example, this appendix uses the phrase Radio Button. Attribute names are listed in a similar manner.
The application frameworks also differ somewhat in how they define which attributes are required for each role. In general, Cocoa requires all of a role’s required attributes to be present whether or not the value of a particular attribute is NULL in a specific instance of that role. Carbon, on the other hand, sometimes allows a specific instance of a role to leave out a normally required attribute if the value of the attribute would be NULL. Be sure to check the application framework–specific documentation to learn whether you can leave out an attribute whose value is NULL.
Note: All accessibility objects include the Role and Role Description attributes. To conserve space, these attributes are not listed in the role-specific sections below. For more information on these attributes, see “The Role and Role Description Attributes.”
An accessibility object of the application role includes the following attributes as shown in Table B-1:
Attribute | Required | Type | Description |
|---|---|---|---|
Frontmost | Yes | Boolean |
|
Hidden | Yes | Boolean |
|
Main Window | Yes | UIElement | Accessibility object representing the main window |
Focused Window | Yes | UIElement | Accessibility object representing the key window |
Title | Yes | String | Visible title of the application’s main window |
Menu Bar | Yes | UIElement | Accessibility object representing the application’s menu bar |
Windows | Yes | UIElement array | Accessibility objects representing the application’s open windows |
Focused UIElement | Yes | UIElement | Accessibility object representing the object that currently has keyboard focus |
Children | Yes | UIElement array | Accessibility objects representing the application’s children |
An accessibility object of the browser role includes the following attributes as shown in Table B-2:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the browser’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the browser’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the browser’s containing window, sheet, or drawer |
Columns | Yes | UIElement array | Accessibility objects representing the browser’s columns |
Help | No | String | Help-tag text for the browser |
Enabled | Yes | Boolean |
|
Focused | Yes | Boolean |
|
Children | Yes | UIElement array | Accessibility objects representing the columns, titles, and scroll area |
Header | Yes | UIElement | Accessibility object representing the browser’s headers |
Column Titles | Yes | UIElement array | Accessibility objects representing the titles of the columns |
Visible Columns | Yes | UIElement array | Accessibility objects representing currently visible columns |
Selected Columns | Yes | UIElement array | Accessibility objects representing currently selected columns |
Horizontal Scroll Bar | No | UIElement | Accessibility object representing the horizontal scroll bar (if one exists) |
Vertical Scroll Bar | No | UIElement | Accessibility object representing the vertical scroll bar (if one exists) |
An accessibility object of the busy indicator role can represent the indeterminate progress bar or the asynchronous progress indicator (a determinate progress bar is represented by an object of the progress indicator role, discussed in “Progress Indicator Role”). This object includes the following attributes as shown in Table B-3:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the busy indicator’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the busy indicator’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the busy indicator’s containing window, sheet, or drawer |
Help | No | String | Help-tag text for the busy indicator |
Focused | Yes | Boolean |
|
Value | Yes | Boolean |
|
An accessibility object of the button role includes the following attributes as shown in Table B-4:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the button’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the button’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the button’s containing window, sheet, or drawer |
Help | No | String | Help-tag text for the button |
Enabled | Yes | Boolean |
|
Focused | Yes | Boolean |
|
Title | Yes | String | Visible title of the button. Not required if the button does not display a title in its visible interface. |
Subrole | No | String | Type of the button. Required if the button is a close, zoom, minimize, toolbar, or sort button. |
Edited | No | Boolean |
|
Description | No | String | Human-intelligible description of the button. Required if the button does not display a title. |
An accessibility object of the button role supports the following action:
Press. When the press action is performed, the button is selected.
An accessibility object of the button role can have one of the following subroles:
Close Button. The button represents the close button in a window.
Minimize Button. The button represents the minimize button in a window.
Zoom Button. The button represents the zoom button in a window.
Toolbar Button. The button represents the button to hide and reveal the toolbar in a window.
Increment Arrow. The button represents the increment scroll arrow in a scroll bar object.
Decrement Arrow. The button represents the decrement scroll arrow in a scroll bar object.
Increment Page. The button represents the increment-page area of the scroll track in a scroll bar object.
Decrement Page. The button represents the decrement-page area of the scroll track in a scroll bar object.
Sort Button. The button represents a sort button.
An accessibility object of the checkbox role includes the following attributes as shown in Table B-5:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the checkbox’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the checkbox’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the checkbox’s containing window, sheet, or drawer |
Help | No | String | Help-tag text for the checkbox |
Enabled | Yes | Boolean |
|
Focused | Yes | Boolean |
|
Title | Yes | String | Visible title of the checkbox. Not required if the checkbox does not display a title in its visible interface. |
Value | Yes | Number | Value of the checkbox (checked is |
Description | No | String | Human-intelligible description of the checkbox. Required if the checkbox does not display a title. |
An accessibility object of the checkbox role supports the following action:
Press. When the press action is performed, the checkbox is clicked.
An accessibility object of the color well role includes the following attributes as shown in Table B-6:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the color well’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Help | No | String | Help-tag text for the color well |
Window | Yes | UIElement | Accessibility object representing the color well’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the color well’s containing window, sheet, or drawer |
Enabled | Yes | Boolean |
|
Value | Yes | String | RGB value of currently displayed color |
An accessibility object of the color well role can support the following action:
Press. When the press action is performed, the Color Picker window is displayed.
An accessibility object of the combo box role includes the following attributes as shown in Table B-7:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the combo box’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the combo box’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the combo box’s containing window, sheet, or drawer |
Help | No | String | Help-tag text for the combo box |
Enabled | Yes | Boolean |
|
Focused | Yes | Boolean |
|
Value | Yes | String | Text of the currently selected item |
Children | Yes | UIElement array | Accessibility objects representing the disclosure button and (when expanded) the scroll area |
Expanded | Yes | Boolean |
|
Selected Text | No | String | Selected portion of the text of the currently selected item |
Selected Text Range | No | Range value | Position and length (in characters) of the selected portion of the text of the currently selected item |
Number of Characters | No | Number | Number of characters in the selected portion of the text of the currently selected item |
Visible Character Range | No | Range value | Position and length (in characters) of the text of the currently selected item |
Description | Yes | String | Human-intelligible description of the combo box. Not required if the title UIElement attribute is included. |
Title UIElement | No | UIElement | Accessibility object representing the static text that serves as the title for the combo box |
Insertion Point Line Number | No | Number | Line number of current cursor position in combo box |
Note: Combo boxes also support parameterized attributes. See the framework-specific documentation for more information on these attributes.
An accessibility object of the combo box role supports the following action:
Confirm. When the confirm action is performed, the selected list item is displayed in the combo box’s text field.
An accessibility object of the disclosure triangle role includes the following attributes as shown in Table B-8:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the disclosure triangle’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the disclosure triangle’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the disclosure triangle’s containing window, sheet, or drawer |
Help | No | String | Help-tag text for the disclosure triangle |
Enabled | Yes | Boolean |
|
Value | Yes | Number |
|
An accessibility object of the disclosure triangle role supports the following action:
Press. When the press action is performed, the disclosure triangle changes state (from open to closed or from closed to open).
An accessibility object of the Dock item role includes the following attributes as shown in Table B-9:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the Dock item’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Help | No | String | Help-tag text for the Dock item |
Subrole | Yes | String | Type of item represented by the Dock item |
Title | Yes | String | Title displayed when the mouse cursor hovers over the Dock item |
Enabled | Yes | Boolean |
|
Top-Level UIElement | Yes | UIElement | Accessibility object representing the Dock item’s containing object |
Selected | Yes | Boolean |
|
Children | Yes | UIElement array | Accessibility object representing the Dock item’s Dock menu |
Shown Menu UIElement | Yes | UIElement array | Accessibility object representing the Dock item’s Dock menu ( |
URL | Yes | String | File path or URL of item represented by the Dock item |
Is Application Running | Yes | Boolean |
|
An accessibility object of the Dock item role can support the following actions:
Press. When the press action is performed, the item represented by the Dock item is activated.
Show Menu. When the show menu action is performed, the Dock item’s Dock menu is displayed.
An accessibility object of the Dock item role should have one of the following subroles:
Application Dock Item. The Dock item represents an application.
URL Dock Item. The Dock item represents a website.
Minimized Window Dock Item. The Dock item represents a minimized window.
Trash Dock Item. The Dock item represents the Trash.
Document Dock Item. The Dock item represents a document.
Folder Dock Item. The Dock item represents a folder.
Dock Extra Dock Item. The Dock item represents a Dock Extra.
An accessibility object of the drawer role includes the following attributes as shown in Table B-10:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the drawer’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Focused | Yes | Boolean |
|
Children | Yes | UIElement array | Accessibility objects representing the drawer’s children |
Window | Yes | UIElement | Accessibility object representing the drawer’s containing window |
Description | Yes | String | Human-intelligible description of the drawer (required because a drawer doesn’t usually display a title) |
An accessibility object of the drawer role supports the following action:
Raise. When the raise action is performed, this drawer becomes frontmost.
An accessibility object of the group role includes the following attributes as shown in Table B-11:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the group’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the group’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the group’s containing window, sheet, or drawer |
Title | No | String | Visible title of the group |
Help | No | String | Help-tag text for the group |
Focused | Yes | Boolean |
|
Children | Yes | UIElement array | Accessibility objects representing the objects in the group |
Contents | No | UIElement array | Accessibility objects representing the children of the group, excluding ancillary elements such as the title of a box or the scroll bars of a scroll view |
An accessibility object of the grow area role includes the following attributes as shown in Table B-12:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the grow area’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the grow area’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the grow area’s containing window, sheet, or drawer |
An accessibility object of the image role includes the following attributes as shown in Table B-13:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the image’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the image’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the image’s containing window, sheet, or drawer |
Help | No | String | Help-tag text for the image |
Enabled | Yes | Boolean |
|
Focused | Yes | Boolean |
|
Description | Yes | String | Human-intelligible description of the image |
Title | No | String | Required if the image displays a visible title |
An accessibility object of the incrementor role represents the stepper control (the little arrows). This object includes the following attributes as shown in Table B-14:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the incrementor’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the incrementor’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the incrementor’s containing window, sheet, or drawer |
Help | No | String | Help-tag text for the incrementor |
Enabled | Yes | Boolean |
|
Focused | Yes | Boolean |
|
Children | Yes | UIElement array | Accessibility objects representing the up and down arrows in the stepper control |
Increment Button | Yes | UIElement | Accessibility object representing the up arrow |
Decrement Button | Yes | UIElement | Accessibility object representing the down arrow |
An accessibility object of the incrementor role supports the following actions:
Increment. When the increment action is performed, the value in the text field or other view associated with the stepper control increments to the next allowed value.
Decrement. When the decrement action is performed, the value in the text field or other view associated with the stepper control decrements to the next allowed value.
An accessibility object of the list role includes the following attributes as shown in Table B-15:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the list’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the list’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the list’s containing window, sheet, or drawer |
Help | No | String | Help-tag text for the list |
Enabled | Yes | Boolean |
|
Focused | Yes | Boolean |
|
Children | Yes | UIElement array | Accessibility objects representing the members of the list |
Visible Children | Yes | UIElement array | Accessibility objects representing the currently visible members of the list |
Selected Children | Yes | UIElement array | Accessibility objects representing the currently selected members of the list |
Orientation | Yes | String | Horizontal or vertical orientation of the list; see framework-specific reference documentation for string constant definitions |
An accessibility object of the menu role includes the following attributes as shown in Table B-16:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the menu’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Help | No | String | Help-tag text for the menu |
Enabled | Yes | Boolean |
|
Title UIElement | Yes | UIElement | Accessibility object representing the object that serves as title of the menu (such as a menu bar item or menu item) |
Children | Yes | UIElement array | Accessibility object representing the menu items the menu displays |
Selected Children | Yes | UIElement array | Accessibility objects representing currently selected menu items in the menu |
Visible Children | Yes | UIElement array | Accessibility objects representing currently visible menu items in the menu |
An accessibility object of the menu role can support the following actions:
Cancel. When the confirm action is performed, menu tracking is canceled.
Press. When the press action is performed, the selected menu item in the menu is chosen.
An accessibility object of the menu bar item role includes the following attributes as shown in Table B-17:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the menu bar item’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Help | No | String | Help-tag text for the menu bar item |
Enabled | Yes | Boolean |
|
Title | Yes | String | Text title of the menu bar item |
Children | Yes | UIElement array | Accessibility object representing the menu the menu bar item displays |
Selected Children | Yes | UIElement array | Accessibility objects representing currently selected menu items in the menu the menu bar item displays |
Visible Children | Yes | UIElement array | Accessibility objects representing currently visible menu items in the menu the menu bar item displays |
Serves as Title for UIElements | No | UIElement array | The accessibility object representing the menu that is the child of this object |
An accessibility object of the menu bar item role can support the following actions:
Cancel. When the confirm action is performed, menu tracking is canceled.
Press. When the press action is performed, the selected menu item in the menu bar item’s menu is chosen.
An accessibility object of the menu bar role includes the following attributes as shown in Table B-18:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the menu bar’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Help | No | String | Help-tag text for the menu bar |
Enabled | Yes | Boolean |
|
Children | Yes | UIElement array | Accessibility objects representing the menu bar items in the menu bar |
Selected Children | Yes | UIElement array | Accessibility objects representing currently selected menu bar items |
Visible Children | Yes | UIElement array | Accessibility objects representing currently visible menu bar items |
An accessibility object of the menu bar role can support the following action:
Cancel. When the confirm action is performed, menu tracking is canceled.
An accessibility object of the menu button role is a command pop-down menu or an icon or bevel button with a pull-down menu. It includes the following attributes as shown in Table B-19:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the menu button’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the menu button’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the menu button’s containing window, sheet, or drawer |
Help | No | String | Help-tag text for the menu button |
Enabled | Yes | Boolean |
|
Focused | Yes | Boolean |
|
Title | Yes | String | Text of the menu button’s title. Not required if the button does not display a title. |
Children | Yes | UIElement array | Accessibility object representing the menu |
Description | No | String | Human-intelligible description of the button’s function. Required if the button does not display a title. |
An accessibility object of the menu button role supports the following actions:
Press. When the press action is performed, the menu button’s menu items are available for selection.
Show Menu. When the show menu action is performed, the menu button’s menu items are revealed.
An accessibility object of the menu item role includes the following attributes as shown in Table B-20:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the menu item’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Help | No | String | Help-tag text for the menu item |
Enabled | Yes | Boolean |
|
Title | Yes | String | Accessibility object representing the title of the menu item |
Selected | Yes | Boolean |
|
Menu Item Command Character | No | String | Primary key in the keyboard shortcut for the command this menu item represents. Required if applicable. |
Menu Item Command Virtual Key | No | String | Key code associated with the physical key in the keyboard shortcut for the command this menu item represents. Required if applicable. |
Menu Item Command Glyph | No | String | Glyph displayed for a physical key in the keyboard shortcut for the command this menu item represents. Required if applicable. |
Menu Item Command Modifiers | No | String | Integer mask representing the modifier keys held down in the keyboard shortcut for the command this menu item represents. Required if applicable. |
Menu Item Mark Character | No | String | Symbol displayed to the left of this menu item. Required if applicable. |
Menu Item Primary UIElement | No | UIElement | Accessibility object representing the object that displays the menu in which this menu item is contained |
Serves as Title for UIElements | No | UIElement array | The accessibility object representing the menu that is the child of this object |
An accessibility object of the menu item role can support the following actions:
Cancel. When the confirm action is performed, menu tracking is canceled.
Press. When the press action is performed, this menu item is chosen, if selected.
An accessibility object of the outline role includes the following attributes as shown in Table B-21:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the outline’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the outline’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the outline’s containing window, sheet, or drawer |
Columns | Yes | UIElement array | Accessibility objects representing the outline’s columns |
Rows | Yes | UIElement array | Accessibility objects representing the outline’s rows |
Help | No | String | Help-tag text for the outline |
Enabled | Yes | Boolean |
|
Focused | Yes | Boolean |
|
Children | Yes | UIElement array | Accessibility objects representing the columns, rows, and group |
Header | Yes | UIElement | Accessibility object representing the outline headers |
Visible Columns | Yes | UIElement array | Accessibility objects representing currently visible columns |
Selected Columns | Yes | UIElement array | Accessibility objects representing currently selected columns |
Visible Rows | Yes | UIElement array | Accessibility objects representing currently visible rows |
Selected Rows | Yes | UIElement array | Accessibility objects representing currently selected rows |
An accessibility object of the pop-up button role is a pop-up menu. It includes the following attributes as shown in Table B-22:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the pop-up menu’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the pop-up menu’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the pop-up menu’s containing window, sheet, or drawer |
Help | No | String | Help-tag text for the pop-up menu |
Enabled | Yes | Boolean |
|
Focused | Yes | Boolean |
|
Value | Yes | String | Text of the pop-up menu item currently selected |
Children | Yes | UIElement array | Accessibility object representing the menu |
An accessibility object of the pop-up button role supports the following actions:
Press. When the press action is performed, the pop-up menu’s menu items are available for selection.
Show Menu. When the show menu action is performed, the pop-up menu’s menu items are revealed.
An accessibility object of the progress indicator role represents the determinate progress bar (an indeterminate progress bar or asynchronous progress indicator is represented by an object of the busy indicator role, discussed in “Busy Indicator Role”). This object includes the following attributes as shown in Table B-23:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the progress indicator’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the progress indicator’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the progress indicator’s containing window, sheet, or drawer |
Help | No | String | Help-tag text for the progress indicator |
Focused | Yes | Boolean |
|
Value | Yes | Number | The current numerical value associated with the fill of the progress bar |
Min Value | Yes | Number | The smallest numerical value that can be associated with the fill of the progress bar (typically |
Max Value | Yes | Number | The largest numerical value that can be associated with the fill of the progress bar (typically |
An accessibility object of the radio button role includes the following attributes as shown in Table B-24:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the radio button’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the radio button’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the radio button’s containing window, sheet, or drawer |
Help | No | String | Help-tag text for the radio button |
Enabled | Yes | Boolean |
|
Focused | Yes | Boolean |
|
Title | Yes | String | Visible title of the radio button. Not required if the radio button does not display a title in its visible interface. |
Value | Yes | Number | Value of the radio button (on is |
Description | No | String | Human-intelligible description of the radio button. Required if the radio button does not display a title. |
An accessibility object of the button role supports the following action:
Press. When the press action is performed, the button is clicked.
An accessibility object of the radio group role includes the following attributes as shown in Table B-25:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the radio group’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the radio group’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the radio group’s containing window, sheet, or drawer |
Help | No | String | Help-tag text for the radio group |
Enabled | Yes | Boolean |
|
Focused | Yes | Boolean |
|
Children | Yes | UIElement array | Accessibility objects representing the members of the radio group |
Value | Yes | UIElement or UIElement array | Accessibility object representing the currently selected member of the radio group (see Note below for more information) |
Visible Children | Yes | UIElement array | Accessibility objects representing the currently visible members of the radio group |
Note: If more than one member of the radio group is selected, the value attribute contains an array of accessibility objects representing all selected members. If no member is selected, the value attribute contains NULL.
An accessibility object of the relevance indicator role includes the following attributes as shown in Table B-26:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the relevance indicator’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the relevance indicator’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the relevance indicator’s containing window, sheet, or drawer |
Help | No | String | Help-tag text for the relevance indicator |
Enabled | Yes | Boolean |
|
Value | Yes | Number | The current numerical value associated with the relevance displayed |
Min Value | Yes | Number | The smallest numerical value that can be associated with the relevance displayed |
Max Value | Yes | Number | The largest numerical value that can be associated with the relevance displayed |
An accessibility object of the row role includes the following attributes as shown in Table B-27:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the row’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the row’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the row’s containing window, sheet, or drawer |
Children | Yes | UIElement array | Accessibility objects representing the row’s contents |
Visible Children | Yes | UIElement array | Accessibility objects representing the row’s contents that are currently visible (for example, not scrolled out of view) |
Help | No | String | Help-tag text for the row |
Enabled | Yes | Boolean |
|
Focused | Yes | Boolean |
|
Subrole | Yes | String | Type of row |
Index | Yes | Number | Numerical value indicating position of the row |
Selected | Yes | Boolean |
|
Disclosing | No | Boolean |
|
Disclosed Rows | No | UIElement array | Accessibility objects representing the items the row’s disclosure triangle is disclosing |
Disclosed By Row | No | UIElement | Accessibility object representing the row by which this row is disclosed |
Disclosure Level | No | Number | Numerical value indicating how deep this row is in the disclosure hierarchy |
An accessibility object of the row role can have the following subroles:
Table Row. The row is a row in a table.
Outline Row. The row is a row in an outline view.
An accessibility object of the ruler role includes the following attributes as shown in Table B-28:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the ruler’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the ruler’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the ruler’s containing window, sheet, or drawer |
Children | Yes | UIElement array | Accessibility objects representing the ruler’s ruler markers and other children |
Help | No | String | Help-tag text for the ruler |
Focused | Yes | Boolean |
|
Marker UIElements | Yes | UIElement array | Accessibility objects representing the ruler’s ruler markers |
Units | Yes | String | Ruler unit type (such as inches); see framework-specific reference documentation for string constant definitions |
Unit description | Yes | String | Human-intelligible description of the ruler’s unit type |
Orientation | Yes | String | Horizontal or vertical orientation of the ruler; see framework-specific reference documentation for string constant definitions |
An accessibility object of the ruler role supports the following optional action:
Press. When the press action is performed, the ruler can be adjusted.
An accessibility object of the ruler marker role includes the following attributes as shown in Table B-29:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the ruler marker’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the ruler marker’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the ruler marker’s containing window, sheet, or drawer |
Help | No | String | Help-tag text for the ruler marker |
Focused | Yes | Boolean |
|
Marker type | Yes | String | Ruler marker type (such as left tab stop); see framework-specific reference documentation for string constant definitions |
Marker type description | Yes | String | Human-intelligible description of the ruler marker’s unit type |
Value | No | String | The positional value on the ruler of the ruler marker |
An accessibility object of the ruler marker role supports the following optional action:
Delete. When the delete action is performed, the ruler marker is removed from the ruler.
An accessibility object of the scroll area role includes the following attributes as shown in Table B-30:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the scroll area’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the scroll area’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the scroll area’s containing window, sheet, or drawer |
Help | No | String | Help-tag text for the scroll area |
Enabled | Yes | Boolean |
|
Focused | Yes | Boolean |
|
Children | Yes | UIElement array | Accessibility objects representing the table or list and scroll bars |
Contents | Yes | UIElement array | Accessibility objects representing the table or list displayed in the scroll area |
Horizontal Scroll Bar | No | UIElement | Accessibility object representing the horizontal scroll bar (if one exists) |
Vertical Scroll Bar | No | UIElement | Accessibility object representing the vertical scroll bar (if one exists) |
An accessibility object of the scroll bar role includes the following attributes as shown in Table B-31:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the scroll bar’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the scroll bar’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the scroll bar’s containing window, sheet, or drawer |
Help | No | String | Help-tag text for the scroll bar |
Enabled | Yes | Boolean |
|
Focused | Yes | Boolean |
|
Children | Yes | UIElement array | Accessibility objects representing the scroller, scroll track, and scroll arrows (see Note below) |
Value | Yes | Number | Numeric value representing the position of the scroller |
Orientation | Yes | String | Horizontal or vertical orientation of scroll bar; see framework-specific reference documentation for string constant definitions |
Note: A scroll bar’s children include an object of the value indicator role (representing the scroller) and 4 objects of the button role that can have the following subroles: Increment Arrow, Increment Page, Decrement Arrow, or Decrement Page. See “Button Role” for more information.
An accessibility object of the sheet role includes the following attributes as shown in Table B-32:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the sheet’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Focused | Yes | Boolean |
|
Children | Yes | UIElement array | Accessibility objects representing the sheet’s children |
Window | Yes | UIElement | Accessibility object representing the sheet’s containing window |
Grow Area | Yes | UIElement | Accessibility object representing the grow area |
Default | No | UIElement | Accessibility object representing the default button |
Cancel | No | UIElement | Accessibility object representing the Cancel button |
An accessibility objects of the sheet role supports the following action:
Raise. When the raise action is performed, this sheet becomes frontmost.
An accessibility object of the slider role includes the following attributes as shown in Table B-33:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the slider’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the slider’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the slider’s containing window, sheet, or drawer |
Help | No | String | Help-tag text for the slider |
Enabled | Yes | Boolean |
|
Focused | Yes | Boolean |
|
Value | Yes | Number | The value associated with the position of the slider thumb (an object of the value indicator role) |
Children | Yes | UIElement array | Accessibility object representing the slider’s thumb (an object of the value indicator role) |
Min Value | Yes | Number | The smallest numerical value the slider can have |
Max Value | Yes | Number | The largest numerical value the slider can have |
Allowed Values | No | Number array | Array of specific values the slider can have |
An accessibility object of the slider role supports the following actions:
Increment. When the increment action is performed, the slider increments to the next allowed value.
Decrement. When the decrement action is performed, the slider decrements to the next allowed value.
An accessibility object of the split group role includes the following attributes as shown in Table B-34:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the split group’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Help | No | String | Help-tag text for the split group |
Window | Yes | UIElement | Accessibility object representing the split group’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the split group’s containing window, sheet, or drawer |
Focused | Yes | Boolean |
|
Selected | Yes | Boolean |
|
Splitters | Yes | UIElement array | Accessibility objects representing the splitter bars |
An accessibility object of the splitter role is a splitter bar. This object includes the following attributes as shown in Table B-35:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the splitter’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Help | No | String | Help-tag text for the splitter |
Window | Yes | UIElement | Accessibility object representing the splitter’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the splitter’s containing window, sheet, or drawer |
Focused | Yes | Boolean |
|
Value | Yes | Number | Numerical value representing the position of the splitter bar |
Min Value | Yes | Number | Numerical value representing the position of the splitter bar associated with revealing the smallest portion of the view |
Max Value | Yes | Number | Numerical value representing the position of the splitter bar associated with revealing the largest portion of the view |
Previous Contents | Yes | UIElement array | Accessibility objects representing the objects on one side of the splitter bar (side is determined by orientation) |
Next Contents | Yes | UIElement array | Accessibility objects representing the objects on one side of the splitter bar (side is determined by orientation) |
Orientation | Yes | String | Horizontal or vertical orientation of splitter bars; see framework-specific reference documentation for string constant definitions |
An accessibility object of the static text role includes the following attributes as shown in Table B-36:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the static text’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the static text’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the static text’s containing window, sheet, or drawer |
Help | No | String | Help-tag text for the static text |
Enabled | Yes | Boolean |
|
Focused | Yes | Boolean |
|
Value | Yes | String | Text in the static text |
Selected Text | Yes | String | Selected portion of the text in the static text |
Selected Text Range | Yes | Range value | Position and length (in characters) of the selected portion of the text in the static text |
Number of Characters | Yes | Number | Number of characters in the text in the static text |
Visible Character Range | Yes | Range value | Position and length (in characters) of the text in the static text |
Insertion Point Line Number | No | Number | Line number of current cursor position in static text |
An accessibility object of the tab group role includes the following attributes as shown in Table B-37:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the tab group’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the tab group’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the tab group’s containing window, sheet, or drawer |
Tabs | Yes | UIElement array | Accessibility objects representing the tab controls |
Help | No | String | Help-tag text for the tab group |
Focused | Yes | Boolean |
|
Children | Yes | UIElement array | Accessibility objects representing the tab controls and the objects in the currently displayed tab pane |
Value | Yes | UIElement | Accessibility object representing the currently selected tab control |
An accessibility object of the table role includes the following attributes as shown in Table B-38:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the table’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the table’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the table’s containing window, sheet, or drawer |
Columns | Yes | UIElement array | Accessibility objects representing the table’s columns |
Rows | Yes | UIElement array | Accessibility objects representing the table’s rows |
Help | No | String | Help-tag text for the table |
Enabled | Yes | Boolean |
|
Focused | Yes | Boolean |
|
Children | Yes | UIElement array | Accessibility objects representing the columns, rows, and headers |
Header | Yes | UIElement | Accessibility object representing the table headers |
Visible Columns | Yes | UIElement array | Accessibility objects representing currently visible columns |
Selected Columns | Yes | UIElement array | Accessibility objects representing currently selected columns |
Visible Rows | Yes | UIElement array | Accessibility objects representing currently visible rows |
Selected Rows | Yes | UIElement array | Accessibility objects representing currently selected rows |
An accessibility object of the text area role includes the following attributes as shown in Table B-39:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the text area’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the text area’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the text area’s containing window, sheet, or drawer |
Help | No | String | Help-tag text for the text area |
Enabled | Yes | Boolean |
|
Focused | Yes | Boolean |
|
Value | Yes | String | Text in the text area |
Selected Text | Yes | String | Selected portion of the text in the text area |
Selected Text Range | Yes | Range value | Position and length (in characters) of the selected portion of the text in the text area |
Number of Characters | Yes | Number | Number of characters in the text in the text area |
Visible Character Range | Yes | Range value | Position and length (in characters) of the text in the text area |
Description | Yes | String | Human-intelligible description of the text area. Not required if the title UIElement attribute is included. |
Title UIElement | No | UIElement | Accessibility object representing the static text that serves as the title for the text area. Not required if the description attribute is included. |
Insertion Point Line Number | No | Number | Line number of current cursor position in text area |
Shared Text UIElements | No | UIElement array | Accessibility objects representing the objects with which the text of this text area is shared. |
Shared Character Range | No | Range value | Range of shared text this text area displays |
Note: A text area object also supports parameterized attributes. See the framework-specific documentation for more information on these attributes.
An accessibility object of the text area role can support the following action:
Confirm. When the confirm action is performed, the selected portion of the text in the text area can display an editing menu.
An accessibility object of the text field role includes the following attributes as shown in Table B-40:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the text field’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the text field’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the text field’s containing window, sheet, or drawer |
Help | No | String | Help-tag text for the text field |
Enabled | Yes | Boolean |
|
Focused | Yes | Boolean |
|
Value | Yes | String | Text in the text field |
Selected Text | Yes | String | Selected portion of the text in the text field |
Selected Text Range | Yes | Range value | Position and length (in characters) of the selected portion of the text in the text field |
Number of Characters | Yes | Number | Number of characters in the selected portion of the text in the text field |
Visible Character Range | Yes | Range value | Position and length (in characters) of the text in the text field |
Description | Yes | String | Human-intelligible description of the text field. Not required if the title UIElement attribute is included. |
Title UIElement | No | UIElement | Accessibility object representing the static text that serves as the title for the text field |
Insertion Point Line Number | No | Number | Line number of current cursor position in text field |
Subrole | No | String | Type of text field |
Search Button | No | UIElement | Accessibility object representing the search button. Required if the text field is a search field. |
Clear Button | No | UIElement | Accessibility object representing the clear button. Required if the text field is a search field. |
Note: A text field object also supports parameterized attributes. See the framework-specific documentation for more information on these attributes.
An accessibility object of the text field role can support the following action:
Confirm. When the confirm action is performed, the selected portion of the text in the text field can display an editing menu.
An accessibility object of the text field role can have the following subroles:
Search Field. The text field functions as a search field.
Secure Text Field. The text field can accept and obscure sensitive input, such as a password.
An accessibility object of the toolbar role includes the following attributes as shown in Table B-41:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the toolbar’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the toolbar’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the toolbar’s containing window, sheet, or drawer |
Help | No | String | Help-tag text for the toolbar |
Enabled | Yes | Boolean |
|
Children | Yes | UIElement array | Accessibility objects representing the icons and controls in the toolbar |
Overflow Button | No | UIElement | Accessibility object representing which of the toolbar’s children (if any) is the overflow button |
An accessibility object of the unknown role includes the following attributes as shown in Table B-42:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the object’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the object’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the object’s containing window, sheet, or drawer |
Help | No | String | Help-tag text for the image |
Enabled | Yes | Boolean |
|
An accessibility object of the value indicator role generally represents the scroller in a scroll bar or the thumb of a slider. This object includes the following attributes as shown in Table B-43:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the value indicator’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Window | Yes | UIElement | Accessibility object representing the value indicator’s containing window |
Top-Level UIElement | Yes | UIElement | Accessibility object representing the value indicator’s containing window, sheet, or drawer |
Help | No | String | Help-tag text for the value indicator |
Enabled | Yes | Boolean |
|
Focused | Yes | Boolean |
|
Note: The value indicated by an object of the value indicator role is contained in the value attribute of its parent object (for example, the slider or the scroll bar)
An accessibility object of the window role includes the following attributes as shown in Table B-44:
Attribute | Required | Type | Description |
|---|---|---|---|
Parent | Yes | UIElement | Accessibility object representing the window’s parent |
Position | Yes | Point value | Structure containing screen-position coordinates |
Size | Yes | Size value | Structure containing width and height values |
Subrole | Yes | String | Type of the window |
Title | Yes | String | Visible title of the window |
Focused | Yes | Boolean |
|
Children | Yes | UIElement array | Accessibility objects representing the window’s children |
Main | Yes | Boolean |
|
Minimized | Yes | Boolean |
|
Close Button | Yes | UIElement | Accessibility object representing the close button |
Minimize Button | Yes | UIElement | Accessibility object representing the minimize button |
Zoom Button | Yes | UIElement | Accessibility object representing the zoom button |
Grow Area | Yes | UIElement | Accessibility object representing the grow area |
Proxy | No | UIElement | Accessibility object representing a document window’s icon |
Toolbar Button | No | UIElement | Accessibility object representing the toolbar button |
Default | No | UIElement | Accessibility object representing the default button |
Cancel | No | UIElement | Accessibility object representing the Cancel button |
Document | No | String | URL or path for the document displayed in the window |
Modal | No | Boolean |
|
An accessibility object of the window role supports the following action:
Raise. When the raise action is performed, this window becomes frontmost.
An accessibility object of the window role should have one of the following subroles:
Standard Window. The window is a standard application or document window.
Dialog. The window is a modeless dialog, such as a Find dialog.
System Dialog. The window is a system-wide modeless dialog, such as the restart dialog.
Floating Window. The window is a utility or information window, such as the Color Picker window.
System Floating Window. The window is a system-wide utility or information window, such as the About This Mac window.
Last updated: 2008-03-11