Roles

Application

Role for the application itself.

Pseudoclass: AXApplication

Cocoa constant: NSAccessibilityApplicationRole (Available in OS X v10.2 and later.)

Carbon constant: kAXApplicationRole (Available in OS X v10.2 and later.)

Discussion

Each application has only one AXApplication element. It is the root of the application’s accessibility hierarchy. It is the only accessibility element in an application that does not have a parent element.

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Focused UI Element

UI element that currently has keyboard focus in an application. Must not be settable.

Focused Window

Window that currently has keyboard focus in an application. Must not be settable.

Frontmost

Flag that indicates whether an application is frontmost. Must be settable.

Hidden

Flag that indicates whether an application is hidden. Must be settable.

Main Window

Main window of an application. Must not be settable.

Menu Bar

Menu bar for an application. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Title

Visible text title of an element. Must not be settable.

Windows

Windows of an application. Must not be settable.

Optional Attributes

Description

Localized, human-intelligible string that describes what a UI element does. Must not be settable.

Help

Help text for a UI element. Must not be settable.

Linked UI Elements

UI elements having some relationship to an element. Must not be settable.

Notifications

Application Activated

Posted after the application is activated.

Application Deactivated

Posted after the application is deactivated.

Application Hidden

Posted after the application is hidden.

Application Shown

Posted after the application is shown.

Focused UI Element Changed

Posted after a UI element gains focus.

Focused Window Changed

Posted after a key window changes.

Main Window Changed

Posted after an application’s main window changes.

Browser

Role for a browser.

Pseudoclass: AXBrowser

Cocoa constant: NSAccessibilityBrowserRole (Available in OS X v10.2 and later.)

Carbon constant: kAXBrowserRole (Available in OS X v10.2 and later.)

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Column Titles

Elements that represent column titles. Must not be settable.

Columns

Columns of a table. Must not be settable.

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Horizontal Scroll Bar

Accessibility object representing a scroll view’s horizontal scroll bar. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Visible Columns

Currently visible columns. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Help

Help text for a UI element. Must not be settable.

Busy Indicator

Role for an element that displays indeterminate progress.

Pseudoclass: AXBusyIndicator

Cocoa constant: NSAccessibilityBusyIndicatorRole (Available in OS X v10.2 and later.)

Carbon constant: kAXBusyIndicatorRole (Available in OS X v10.2 and later.)

Required Attributes

Focused

Flag that indicates whether an element has keyboard focus. Must not be settable.

Orientation

Horizontal or vertical orientation of an element—for example, a list, ruler, scroll bar, or splitter bar. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Value

The element’s value. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Help

Help text for a UI element. Must not be settable.

Button

Role for a button element.

Pseudoclass: AXButton

Cocoa constant: NSAccessibilityButtonRole (Available in OS X v10.2 and later.)

Carbon constant: kAXButtonRole (Available in OS X v10.2 and later.)

Subroles: Close Button, Decrement Arrow, Decrement Page, Full Screen Button, Increment Arrow, Increment Page, Minimize Button, Sort Button, Toolbar Button, Zoom Button

Required Attributes

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Title

Visible text title of an element. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Description

Localized, human-intelligible string that describes what a UI element does. Must not be settable.

Help

Help text for a UI element. Must not be settable.

Actions

Press

Simulates clicking an element—for example, a button.

Cell

Role for an element that represents a cell in an cell-based table or outline.

Pseudoclass: AXCell

Cocoa constant: NSAccessibilityCellRole (Available in OS X v10.6 and later.)

Carbon constant: kAXCellRole (Available in OS X v10.6 and later.)

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Column Index Range

Range that specifies the column index and column span of the cell. Must not be settable.

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Row Index Range

Range that specifies the row index and row span of the cell. Must not be settable.

Selected

Flag that indicates whether a UI element is selected. May be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Help

Help text for a UI element. Must not be settable.

Checkbox

Role for a checkbox element.

Pseudoclass: AXCheckBox

Cocoa constant: NSAccessibilityCheckBoxRole (Available in OS X v10.2 and later.)

Carbon constant: kAXCheckBoxRole (Available in OS X v10.2 and later.)

Discussion

This role can be used for any element that has the same on/off behavior as a checkbox.

Required Attributes

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. Must be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Title

Visible text title of an element. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Value

The element’s value. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Description

Localized, human-intelligible string that describes what a UI element does. Must not be settable.

Help

Help text for a UI element. Must not be settable.

Actions

Press

Simulates clicking an element—for example, a button.

Color Well

Role for a color well.

Pseudoclass: AXColorWell

Cocoa constant: NSAccessibilityColorWellRole (Available in OS X v10.2 and later.)

Carbon constant: kAXColorWellRole (Available in OS X v10.2 and later.)

Required Attributes

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Value

The element’s value. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Help

Help text for a UI element. Must not be settable.

Actions

Press

Simulates clicking an element—for example, a button.

Column

Role for a column.

Pseudoclass: AXColumn

Cocoa constant: NSAccessibilityColumnRole (Available in OS X v10.2 and later.)

Carbon constant: kAXColumnRole (Available in OS X v10.2 and later.)

Required Attributes

Index

Index of a row or column being represented. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Rows

The table’s rows. Must not be settable.

Selected

Flag that indicates whether a UI element is selected. May be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. May be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Visible Rows

Currently visible rows. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Header

Accessibility object representing the headers of a browser, a table, or an outline. Must not be settable.

Combo Box

Role for a combo box.

Pseudoclass: AXComboBox

Cocoa constant: NSAccessibilityComboBoxRole (Available in OS X v10.2 and later.)

Carbon constant: kAXComboBoxRole (Available in OS X v10.2 and later.)

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Expanded

Flag that indicates whether an element such as a list is displayed (disclosed). May be settable.

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Number Of Characters

Number of characters in an editable text field. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Selected Text

Currently selected text of a UI element. May be settable.

Selected Text Range

Position and length (in characters) of a selected portion of text in the UI element. May be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Value

The element’s value. May be settable.

Visible Character Range

Range of characters that are scrolled into view in an editable text element. May be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Attributed String For Range

Attributed string for the specified portion of the text associated with the currently selected item. Must not be settable.

Bounds For Range

Rectangle that bounds a range of text. Must not be settable.

Description

Localized, human-intelligible string that describes what a UI element does. Must not be settable.

Help

Help text for a UI element. Must not be settable.

Insertion Point Line Number

Number of the line that currently has the insertion point. Must not be settable.

Line For Index

The line number for the given text index. Must not be settable.

Placeholder Value

Placeholder value displayed when an element is empty. Must not be settable.

Range For Index

The full range of characters. Must not be settable.

Range For Line

The range of characters. Must not be settable.

Range For Position

The range of the composed character sequence at the given text index. Must not be settable.

RTF For Range

Rich Text Format (RTF) data for the range. Must not be settable.

String For Range

The substring. Must not be settable.

Style Range For Index

The full range of characters, which have the same style. Must not be settable.

Title UI Element

UI element that represents another element’s static text title. Must not be settable.

Actions

Confirm

Simulates pressing Return in an element—for example, a text field.

Date Field

Role for a date field element.

Pseudoclass: AXDateField

Cocoa constant: (none defined)

Carbon constant: kAXDateFieldRole (Available in OS X v10.3 and later.)

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Day Field

Day field of a date field element. Must not be settable.

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Incrementor

Stepper control (the little arrows) of a time field or date field. Must not be settable.

Month Field

Month field of a date field element. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Value

The element’s value. Must not be settable.

Window

Window containing the current element. Must not be settable.

Year Field

Year field of a date field. Must not be settable.

Optional Attributes

Help

Help text for a UI element. Must not be settable.

Disclosure Triangle

Role for a disclosure triangle.

Pseudoclass: AXDisclosureTriangle

Cocoa constant: NSAccessibilityDisclosureTriangleRole (Available in OS X v10.5 and later.)

Carbon constant: kAXDisclosureTriangleRole (Available in OS X v10.4 and later.)

Required Attributes

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Value

The element’s value. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Help

Help text for a UI element. Must not be settable.

Actions

Press

Simulates clicking an element—for example, a button.

Dock Item

Role for a Dock item.

Pseudoclass: AXDockItem

Cocoa constant: (none defined)

Carbon constant: kAXDockItemRole (Available in OS X v10.4 and later.)

Subroles: Application Dock Item, Dock Extra Dock Item, Document Dock Item, Folder Dock Item, Minimized Window Dock Item, Separator Dock Item, Trash Dock Item, URL Dock Item

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Shown Menu UI Element

Accessibility object representing the Dock item’s Dock menu. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Subrole

Subtype or specialization of a role. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Optional Attributes

Help

Help text for a UI element. Must not be settable.

Actions

Press

Simulates clicking an element—for example, a button.

Show Menu

Simulates showing a menu by clicking it.

Drawer

Role for a drawer.

Pseudoclass: AXDrawer

Cocoa constant: NSAccessibilityDrawerRole (Available in OS X v10.2 and later.)

Carbon constant: kAXDrawerRole (Available in OS X v10.2 and later.)

Discussion

Drawers—along with sheets and windows—are top-level UI elements

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. May be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Description

Localized, human-intelligible string that describes what a UI element does. Must not be settable.

Actions

Raise

Simulates bringing a window forward by clicking in its title bar.

Notifications

Drawer Created

Posted after a drawer has appeared.

Grid

Role for a user interface that contains child elements arranged in a 2D grid.

Pseudoclass: AXGrid

Cocoa constant: NSAccessibilityGridRole (Available in OS X v10.5 and later.)

Carbon constant: kAXGridRole (Available in OS X v10.5 and later.)

Discussion

The child elements must be reported in the order that they appear in the grid. The row and column count indicate the size of each axis of the grid, and the AXOrderedByRow attribute indicates whether the children are reported row-by-row instead of column-by-column.

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Column Count

Number of columns in a grid. Must not be settable.

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Ordered By Row

Indicates whether the grid orders its elements by row (true) or by column (false). Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Row Count

Number of rows in a grid. Must not be settable.

Selected Children

Currently selected child elements of a UI element. May be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Visible Children

Currently visible child elements of a UI element. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Help

Help text for a UI element. Must not be settable.

Group

Role for an element that groups subelements.

Pseudoclass: AXGroup

Cocoa constant: NSAccessibilityGroupRole (Available in OS X v10.2 and later.)

Carbon constant: kAXGroupRole (Available in OS X v10.2 and later.)

Discussion

This role represents a relatively generic group; for example, an NSBox in Cocoa will report itself as an AXGroup. There are more specific roles for groups of tabs, radio buttons, and split views.

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Contents

Accessibility objects representing the contents of an element—for example, a table or list displayed in a scroll area. Must not be settable.

Description

Localized, human-intelligible string that describes what a UI element does. Must not be settable.

Help

Help text for a UI element. Must not be settable.

Title

Visible text title of an element. Must not be settable.

Title UI Element

UI element that represents another element’s static text title. Must not be settable.

Grow Area

Role for a window’s grow (resize) area.

Pseudoclass: AXGrowArea

Cocoa constant: NSAccessibilityGrowAreaRole (Available in OS X v10.2 and later.)

Carbon constant: kAXGrowAreaRole (Available in OS X v10.2 and later.)

Required Attributes

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Window

Window containing the current element. Must not be settable.

Handle

Role for an element that operates on its parent element by resizing it, rotating it, and so on.

Pseudoclass: AXHandle

Cocoa constant: NSAccessibilityHandleRole (Available in OS X v10.6 and later.)

Carbon constant: kAXHandleRole (Available in OS X v10.6 and later.)

Discussion

The value of a handle’s AXDescription attribute typically describes its function or position. Assistive applications move the handle by setting the value of the AXPosition attribute.

Required Attributes

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. May be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Description

Localized, human-intelligible string that describes what a UI element does. Must not be settable.

Help

Help text for a UI element. Must not be settable.

Help Tag

Role for a help tag.

Pseudoclass: AXHelpTag

Cocoa constant: NSAccessibilityHelpTagRole (Available in OS X v10.4 and later.)

Carbon constant: kAXHelpTagRole (Available in OS X v10.4 and later.)

Required Attributes

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Title

Visible text title of an element. Must not be settable.

Image

Role for an element that is an image.

Pseudoclass: AXImage

Cocoa constant: NSAccessibilityImageRole (Available in OS X v10.2 and later.)

Carbon constant: kAXImageRole (Available in OS X v10.2 and later.)

Subroles: Text Attachment

Required Attributes

Description

Localized, human-intelligible string that describes what a UI element does. Must not be settable.

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Filename

Filename associated with an element. Must not be settable.

Help

Help text for a UI element. Must not be settable.

Title

Visible text title of an element. Must not be settable.

URL

URL or path associated with an element. Must not be settable.

Notifications

Value Changed

Posted after a UI element’s value changes.

Incrementor

Role for a stepper control (the little arrows).

Pseudoclass: AXIncrementor

Cocoa constant: NSAccessibilityIncrementorRole (Available in OS X v10.2 and later.)

Carbon constant: kAXIncrementorRole (Available in OS X v10.2 and later.)

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Decrement Button

Accessibility object representing the down arrow. Must not be settable.

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Increment Button

Accessibility object representing the up arrow. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Help

Help text for a UI element. Must not be settable.

Actions

Decrement

Decrements the value of an element to the next allowed value.

Increment

Increments the value of an element to the next allowed value.

Layout Area

Role for an element that allows for the layout of its child elements.

Pseudoclass: AXLayoutArea

Cocoa constant: NSAccessibilityLayoutAreaRole (Available in OS X v10.6 and later.)

Carbon constant: kAXLayoutAreaRole (Available in OS X v10.6 and later.)

Discussion

For example, the document area in a drawing, page layout, or presentation application.

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. Must be settable.

Handles

Accessibility objects representing the resize handles of a layout element Must not be settable.

Horizontal Unit Description

Localized description of the unit of measurement used by the user interface element for measurements along the horizontal axis. Must not be settable.

Horizontal Units

Unit of measurement used by the user interface element for measurement along the horizontal axis . Must not be settable.

Layout Point For Screen Point

The point, in the coordinates of the layout area, for the given point in screen coordinates. Must not be settable.

Layout Size For Screen Size

The size, in the coordinates of the layout area, for the given size in screen coordinates. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Screen Point For Layout Point

The point, in screen coordinates, for the given point in user coordinates. Must not be settable.

Screen Size For Layout Size

The size, in screen units, for the given size in units of a layout area. Must not be settable.

Selected Children

Currently selected child elements of a UI element. May be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Vertical Unit Description

Localized description of the unit of measurement used by the user interface element for measurements along the vertical axis. Must not be settable.

Vertical Units

Unit of measurement used by the user interface element for measurement along the vertical axis. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Help

Help text for a UI element. Must not be settable.

Layout Item

Role for a movable or resizable element in a layout area.

Pseudoclass: AXLayoutItem

Cocoa constant: NSAccessibilityLayoutItemRole (Available in OS X v10.6 and later.)

Carbon constant: kAXLayoutItemRole (Available in OS X v10.6 and later.)

Discussion

A layout item may have child items—for example, an editable text area.

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. Must be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Help

Help text for a UI element. Must not be settable.

Level Indicator

Role for a level indicator.

Pseudoclass: AXLevelIndicator

Cocoa constant: NSAccessibilityLevelIndicatorRole (Available in OS X v10.6 and later.)

Carbon constant: kAXLevelIndicatorRole (Available in OS X v10.6 and later.)

Discussion

Examples include indicators of disk space usage in a file system browser and sound level an audio application. These UI elements often change color to indicate that a warning or critical value has been reached which is exposed through the AXWarningValue and AXCriticalValue attributes. If there is an array of allowed values, the UI element is a discrete indicator; if there are no allowed values, it is a continuous indicator. Level indicators are typically not editable.

Required Attributes

Allowed Values

Allowed values in a slider. Must not be settable.

Critical Value

Value above which a critical warning is indicated. Must not be settable.

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Max Value

Maximum value that this element can display. Must not be settable.

Min Value

Minimum value that an element can display. Must not be settable.

Orientation

Horizontal or vertical orientation of an element—for example, a list, ruler, scroll bar, or splitter bar. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Value

The element’s value. May be settable.

Warning Value

Value above which a warning is indicated. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Help

Help text for a UI element. Must not be settable.

Link

Role for a link.

Pseudoclass: AXLink

Cocoa constant: NSAccessibilityLinkRole (Available in OS X v10.4 and later.)

Carbon constant: (none defined)

Subroles: Text Link

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Selected

Flag that indicates whether a UI element is selected. May be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Title

Visible text title of an element. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Help

Help text for a UI element. Must not be settable.

URL

URL or path associated with an element. Must not be settable.

Actions

Press

Simulates clicking an element—for example, a button.

List

Role for an element that is a list of elements.

Pseudoclass: AXList

Cocoa constant: NSAccessibilityListRole (Available in OS X v10.2 and later.)

Carbon constant: kAXListRole (Available in OS X v10.2 and later.)

Subroles: Content List, Definition List, Process Switcher List

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Orientation

Horizontal or vertical orientation of an element—for example, a list, ruler, scroll bar, or splitter bar. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Selected Children

Currently selected child elements of a UI element. May be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Visible Children

Currently visible child elements of a UI element. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Help

Help text for a UI element. Must not be settable.

Matte Role

Role for a matte.

Pseudoclass: AXMatte

Cocoa constant: NSAccessibilityMatteRole (Available in OS X v10.4 and later.)

Carbon constant: kAXMatteRole (Available in OS X v10.4 and later.)

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Matte Content UI Element

UI element that is clipped by a matte region. Must not be settable.

Matte Hole

Bounds of a matte hole, in screen coordinates. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Title

Visible text title of an element. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Help

Help text for a UI element. Must not be settable.

Menu

Role for a menu.

Pseudoclass: AXMenu

Cocoa constant: NSAccessibilityMenuRole (Available in OS X v10.2 and later.)

Carbon constant: kAXMenuRole (Available in OS X v10.2 and later.)

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Selected Children

Currently selected child elements of a UI element. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Title UI Element

UI element that represents another element’s static text title. Must not be settable.

Visible Children

Currently visible child elements of a UI element. Must not be settable.

Actions

Cancel

Cancels an operation.

Press

Simulates clicking an element—for example, a button.

Menu Bar

Role for a menu bar.

Pseudoclass: AXMenuBar

Cocoa constant: NSAccessibilityMenuBarRole (Available in OS X v10.2 and later.)

Carbon constant: kAXMenuBarRole (Available in OS X v10.2 and later.)

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Selected Children

Currently selected child elements of a UI element. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Visible Children

Currently visible child elements of a UI element. Must not be settable.

Optional Attributes

Title UI Element

UI element that represents another element’s static text title. Must not be settable.

Actions

Cancel

Cancels an operation.

Menu Bar Item

Role for a menu bar item.

Pseudoclass: AXMenuBarItem

Cocoa constant: (none defined)

Carbon constant: kAXMenuBarItemRole (Available in OS X v10.3 and later.)

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Selected

Flag that indicates whether a UI element is selected. May be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Title

Visible text title of an element. Must not be settable.

Optional Attributes

Help

Help text for a UI element. Must not be settable.

Serves As Title For UI Elements

Elements for which this element serves as the title. Must not be settable.

Actions

Cancel

Cancels an operation.

Press

Simulates clicking an element—for example, a button.

Menu Button

Role for a menu button.

Pseudoclass: AXMenuButton

Cocoa constant: NSAccessibilityMenuButtonRole (Available in OS X v10.2 and later.)

Carbon constant: kAXMenuButtonRole (Available in OS X v10.2 and later.)

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Title

Visible text title of an element. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Description

Localized, human-intelligible string that describes what a UI element does. Must not be settable.

Help

Help text for a UI element. Must not be settable.

Actions

Press

Simulates clicking an element—for example, a button.

Show Menu

Simulates showing a menu by clicking it.

Menu Item

Role for a menu item.

Pseudoclass: AXMenuItem

Cocoa constant: NSAccessibilityMenuItemRole (Available in OS X v10.2 and later.)

Carbon constant: kAXMenuItemRole (Available in OS X v10.2 and later.)

Required Attributes

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Menu Item Command Character

Keyboard shortcut for a menu item. Must not be settable.

Menu Item Command Glyph

Number of the glyph displayed for the keyboard shortcut. Must not be settable.

Menu Item Command Modifiers

Bit field that describes the modifier keys associated with a menu item. Must not be settable.

Menu Item Command Virtual Key

Key code for the physical key associated with a menu item. Must not be settable.

Menu Item Mark Character

Symbol displayed next to this element—for example, a bullet or checkmark. Must not be settable.

Menu Item Primary UI Element

UI element that displays the menu in which a menu item is contained. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Selected

Flag that indicates whether a UI element is selected. May be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Title

Visible text title of an element. Must not be settable.

Optional Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Help

Help text for a UI element. Must not be settable.

Selected Children

Currently selected child elements of a UI element. May be settable.

Serves As Title For UI Elements

Elements for which this element serves as the title. Must not be settable.

Visible Children

Currently visible child elements of a UI element. Must not be settable.

Actions

Cancel

Cancels an operation.

Press

Simulates clicking an element—for example, a button.

Outline

Role for an outline.

Pseudoclass: AXOutline

Cocoa constant: NSAccessibilityOutlineRole (Available in OS X v10.2 and later.)

Carbon constant: kAXOutlineRole (Available in OS X v10.2 and later.)

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Columns

Columns of a table. Must not be settable.

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Header

Accessibility object representing the headers of a browser, a table, or an outline. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Rows

The table’s rows. Must not be settable.

Selected Columns

Currently selected columns of a table. May be settable.

Selected Rows

Currently selected rows of a table May be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Visible Columns

Currently visible columns. Must not be settable.

Visible Rows

Currently visible rows. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Cell For Column And Row

Cell for the given column and row, taking column and row spans into account. Must not be settable.

Description

Localized, human-intelligible string that describes what a UI element does. Must not be settable.

Help

Help text for a UI element. Must not be settable.

Linked UI Elements

UI elements having some relationship to an element. Must not be settable.

Selected Cells

Array of the selected cells. May be settable.

Visible Cells

Array of the visible cells in a table or outline view. May be settable.

Pop-Up Button

Role for a pop-up button.

Pseudoclass: AXPopUpButton

Cocoa constant: NSAccessibilityPopUpButtonRole (Available in OS X v10.2 and later.)

Carbon constant: kAXPopUpButtonRole (Available in OS X v10.2 and later.)

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Value

The element’s value. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Help

Help text for a UI element. Must not be settable.

Actions

Press

Simulates clicking an element—for example, a button.

Show Menu

Simulates showing a menu by clicking it.

Popover

Role for a popover.

Pseudoclass: AXPopover

Cocoa constant: NSAccessibilityPopoverRole (Available in OS X v10.7 and later.)

Carbon constant: kAXPopoverRole (Available in OS X v10.7 and later.)

Discussion

The parent of a popover should be the UI element that originated the popover. For example, if pressing a button presents a popover, the popover should be a child of the button.

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Description

Localized, human-intelligible string that describes what a UI element does. Must not be settable.

Help

Help text for a UI element. Must not be settable.

Title UI Element

UI element that represents another element’s static text title. Must not be settable.

Actions

Cancel

Cancels an operation.

Notifications

UI Element Destroyed

Posted after a UI element is destroyed.

Progress Indicator

Role for an element that displays determinate progress.

Pseudoclass: AXProgressIndicator

Cocoa constant: NSAccessibilityProgressIndicatorRole (Available in OS X v10.2 and later.)

Carbon constant: kAXProgressIndicatorRole (Available in OS X v10.2 and later.)

Required Attributes

Focused

Flag that indicates whether an element has keyboard focus. Must not be settable.

Max Value

Maximum value that this element can display. Must not be settable.

Min Value

Minimum value that an element can display. Must not be settable.

Orientation

Horizontal or vertical orientation of an element—for example, a list, ruler, scroll bar, or splitter bar. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Value

The element’s value. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Help

Help text for a UI element. Must not be settable.

Radio Button

Role for a radio button.

Pseudoclass: AXRadioButton

Cocoa constant: NSAccessibilityRadioButtonRole (Available in OS X v10.2 and later.)

Carbon constant: kAXRadioButtonRole (Available in OS X v10.2 and later.)

Required Attributes

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Title

Visible text title of an element. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Value

The element’s value. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Description

Localized, human-intelligible string that describes what a UI element does. Must not be settable.

Help

Help text for a UI element. Must not be settable.

Actions

Press

Simulates clicking an element—for example, a button.

Radio Group

Role for a radio button group.

Pseudoclass: AXRadioGroup

Cocoa constant: NSAccessibilityRadioGroupRole (Available in OS X v10.2 and later.)

Carbon constant: kAXRadioGroupRole (Available in OS X v10.2 and later.)

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Value

The element’s value. Must not be settable.

Visible Children

Currently visible child elements of a UI element. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Help

Help text for a UI element. Must not be settable.

Relevance Indicator

Role for a relevance indicator.

Pseudoclass: AXRelevanceIndicator

Cocoa constant: NSAccessibilityRelevanceIndicatorRole (Available in OS X v10.2 and later.)

Carbon constant: kAXRelevanceIndicatorRole (Available in OS X v10.2 and later.)

Required Attributes

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Max Value

Maximum value that this element can display. Must not be settable.

Min Value

Minimum value that an element can display. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Value

The element’s value. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Help

Help text for a UI element. Must not be settable.

Row

Role for a row.

Pseudoclass: AXRow

Cocoa constant: NSAccessibilityRowRole (Available in OS X v10.2 and later.)

Carbon constant: kAXRowRole (Available in OS X v10.2 and later.)

Subroles: Outline Row, Table Row

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Index

Index of a row or column being represented. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Selected

Flag that indicates whether a UI element is selected. May be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Subrole

Subtype or specialization of a role. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Visible Children

Currently visible child elements of a UI element. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Help

Help text for a UI element. Must not be settable.

Ruler

Role for a ruler.

Pseudoclass: AXRuler

Cocoa constant: NSAccessibilityRulerRole (Available in OS X v10.4 and later.)

Carbon constant: kAXRulerRole (Available in OS X v10.4 and later.)

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. Must not be settable.

Marker UI Elements

Marker UI elements related to a ruler. Must not be settable.

Orientation

Horizontal or vertical orientation of an element—for example, a list, ruler, scroll bar, or splitter bar. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Unit Description

Localized description of a ruler’s units. Must not be settable.

Units

Ruler unit type—for example, inches. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Help

Help text for a UI element. Must not be settable.

Actions

Press

Simulates clicking an element—for example, a button.

Ruler Marker

Role for a ruler marker.

Pseudoclass: AXRulerMarker

Cocoa constant: NSAccessibilityRulerMarkerRole (Available in OS X v10.4 and later.)

Carbon constant: kAXRulerMarkerRole (Available in OS X v10.4 and later.)

Required Attributes

Marker Type

Ruler marker type—for example, a left tab stop. Must not be settable.

Marker Type Description

Description of a ruler marker type. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Value

The element’s value. May be settable.

Actions

Delete

Deletes the value of an element.

Scroll Area

Role for a scroll view.

Pseudoclass: AXScrollArea

Cocoa constant: NSAccessibilityScrollAreaRole (Available in OS X v10.2 and later.)

Carbon constant: kAXScrollAreaRole (Available in OS X v10.2 and later.)

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Contents

Accessibility objects representing the contents of an element—for example, a table or list displayed in a scroll area. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Help

Help text for a UI element. Must not be settable.

Horizontal Scroll Bar

Accessibility object representing a scroll view’s horizontal scroll bar. Must not be settable.

Vertical Scroll Bar

Accessibility object representing the vertical scroll bar in a scroll view. Must not be settable.

Scroll Bar

Role for a scroll bar.

Pseudoclass: AXScrollBar

Cocoa constant: NSAccessibilityScrollBarRole (Available in OS X v10.2 and later.)

Carbon constant: kAXScrollBarRole (Available in OS X v10.2 and later.)

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Orientation

Horizontal or vertical orientation of an element—for example, a list, ruler, scroll bar, or splitter bar. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Value

The element’s value. May be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Help

Help text for a UI element. Must not be settable.

Hidden

Flag that indicates whether an application is hidden. May be settable.

Max Value

Maximum value that this element can display. Must not be settable.

Min Value

Minimum value that an element can display. Must not be settable.

Sheet

Role for a sheet.

Pseudoclass: AXSheet

Cocoa constant: NSAccessibilitySheetRole (Available in OS X v10.2 and later.)

Carbon constant: kAXSheetRole (Available in OS X v10.2 and later.)

Discussion

Sheets—along with windows and drawers—are top-level UI elements.

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. May be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. May be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Cancel Button

Accessibility object representing the window’s cancel button (if any). Must not be settable.

Default Button

Accessibility object representing the default button of a window or sheet. Must not be settable.

Description

Localized, human-intelligible string that describes what a UI element does. Must not be settable.

Grow Area

Accessibility object representing the grow area element of a window or sheet. Must not be settable.

Actions

Raise

Simulates bringing a window forward by clicking in its title bar.

Slider

Role for a slider.

Pseudoclass: AXSlider

Cocoa constant: NSAccessibilitySliderRole (Available in OS X v10.2 and later.)

Carbon constant: kAXSliderRole (Available in OS X v10.2 and later.)

Subroles: Rating Indicator, Timeline

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Max Value

Maximum value that this element can display. Must not be settable.

Min Value

Minimum value that an element can display. Must not be settable.

Orientation

Horizontal or vertical orientation of an element—for example, a list, ruler, scroll bar, or splitter bar. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Value

The element’s value. May be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Allowed Values

Allowed values in a slider. Must not be settable.

Help

Help text for a UI element. Must not be settable.

Actions

Decrement

Decrements the value of an element to the next allowed value.

Increment

Increments the value of an element to the next allowed value.

Sort Button

Role for a sort button.

Pseudoclass: AXSortButton

Cocoa constant: NSAccessibilitySortButtonRole (Available in OS X v10.4 and later.) (Deprecated in OS X v10.6.)

Carbon constant: (none defined)

Discussion

Deprecated in favor of using a button role with a sort button subrole.

Required Attributes

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Sort Direction

Sort direction of a column. Must not be settable.

Title

Visible text title of an element. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Help

Help text for a UI element. Must not be settable.

Actions

Press

Simulates clicking an element—for example, a button.

Split Group

Role for a split view group.

Pseudoclass: AXSplitGroup

Cocoa constant: NSAccessibilitySplitGroupRole (Available in OS X v10.2 and later.)

Carbon constant: kAXSplitGroupRole (Available in OS X v10.2 and later.)

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Splitters

Splitter bars in a split group. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Help

Help text for a UI element. Must not be settable.

Splitter

Role for a splitter bar of a split view.

Pseudoclass: AXSplitter

Cocoa constant: NSAccessibilitySplitterRole (Available in OS X v10.2 and later.)

Carbon constant: kAXSplitterRole (Available in OS X v10.2 and later.)

Required Attributes

Focused

Flag that indicates whether an element has keyboard focus. Must not be settable.

Max Value

Maximum value that this element can display. Must not be settable.

Min Value

Minimum value that an element can display. Must not be settable.

Next Contents

Objects on one the following side of a splitter bar. Must not be settable.

Orientation

Horizontal or vertical orientation of an element—for example, a list, ruler, scroll bar, or splitter bar. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Previous Contents

Objects on the preceding side of a splitter bar element. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Value

The element’s value. May be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Help

Help text for a UI element. Must not be settable.

Static Text

Role for text whose values are static and so cannot be set by an assistive application.

Pseudoclass: AXStaticText

Cocoa constant: NSAccessibilityStaticTextRole (Available in OS X v10.2 and later.)

Carbon constant: kAXStaticTextRole (Available in OS X v10.2 and later.)

Required Attributes

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. Must not be settable.

Number Of Characters

Number of characters in an editable text field. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Selected Text

Currently selected text of a UI element. Must not be settable.

Selected Text Range

Position and length (in characters) of a selected portion of text in the UI element. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Value

The element’s value. Must not be settable.

Visible Character Range

Range of characters that are scrolled into view in an editable text element. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Attributed String For Range

Attributed string for the specified portion of the text associated with the currently selected item. Must not be settable.

Bounds For Range

Rectangle that bounds a range of text. Must not be settable.

Children

Child elements in an accessibility hierarchy. Must not be settable.

Help

Help text for a UI element. Must not be settable.

Insertion Point Line Number

Number of the line that currently has the insertion point. Must not be settable.

Line For Index

The line number for the given text index. Must not be settable.

Range For Index

The full range of characters. Must not be settable.

Range For Line

The range of characters. Must not be settable.

Range For Position

The range of the composed character sequence at the given text index. Must not be settable.

RTF For Range

Rich Text Format (RTF) data for the range. Must not be settable.

String For Range

The substring. Must not be settable.

Style Range For Index

The full range of characters, which have the same style. Must not be settable.

Systemwide

Role for the systemwide accessibility object.

Pseudoclass: AXSystemWide

Cocoa constant: NSAccessibilitySystemWideRole (Available in OS X v10.2 and later.)

Carbon constant: kAXSystemWideRole (Available in OS X v10.2 and later.)

Required Attributes

Focused Application

Application that currently has keyboard focus. Must not be settable.

Focused UI Element

UI element that currently has keyboard focus in an application. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Tab Group

Role for a tab group.

Pseudoclass: AXTabGroup

Cocoa constant: NSAccessibilityTabGroupRole (Available in OS X v10.2 and later.)

Carbon constant: kAXTabGroupRole (Available in OS X v10.2 and later.)

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Contents

Accessibility objects representing the contents of an element—for example, a table or list displayed in a scroll area. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Tabs

Tab controls in a tab view. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Value

The element’s value. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Help

Help text for a UI element. Must not be settable.

Table

Role for a table.

Pseudoclass: AXTable

Cocoa constant: NSAccessibilityTableRole (Available in OS X v10.2 and later.)

Carbon constant: kAXTableRole (Available in OS X v10.2 and later.)

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Columns

Columns of a table. Must not be settable.

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Header

Accessibility object representing the headers of a browser, a table, or an outline. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Rows

The table’s rows. Must not be settable.

Selected Columns

Currently selected columns of a table. Must not be settable.

Selected Rows

Currently selected rows of a table Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Visible Columns

Currently visible columns. Must not be settable.

Visible Rows

Currently visible rows. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Cell For Column And Row

Cell for the given column and row, taking column and row spans into account. Must not be settable.

Column Count

Number of columns in a grid. Must not be settable.

Column Header UI Elements

Column headers of a table or an outline. Must not be settable.

Help

Help text for a UI element. Must not be settable.

Row Count

Number of rows in a grid. Must not be settable.

Row Header UI Elements

Array of UI elements that represent the row headers of a table or an outline. Must not be settable.

Selected Cells

Array of the selected cells. May be settable.

Visible Cells

Array of the visible cells in a table or outline view. May be settable.

Text Area

Role for a text view.

Pseudoclass: AXTextArea

Cocoa constant: NSAccessibilityTextAreaRole (Available in OS X v10.2 and later.)

Carbon constant: kAXTextAreaRole (Available in OS X v10.2 and later.)

Discussion

This role usually denotes a control that is intended to hold larger amounts of text than a text field—for example, an area of text in a word processor.

Required Attributes

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Number Of Characters

Number of characters in an editable text field. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Selected Text

Currently selected text of a UI element. May be settable.

Selected Text Range

Position and length (in characters) of a selected portion of text in the UI element. May be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Value

The element’s value. May be settable.

Visible Character Range

Range of characters that are scrolled into view in an editable text element. May be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Attributed String For Range

Attributed string for the specified portion of the text associated with the currently selected item. Must not be settable.

Bounds For Range

Rectangle that bounds a range of text. Must not be settable.

Children

Child elements in an accessibility hierarchy. Must not be settable.

Description

Localized, human-intelligible string that describes what a UI element does. Must not be settable.

Help

Help text for a UI element. Must not be settable.

Insertion Point Line Number

Number of the line that currently has the insertion point. Must not be settable.

Line For Index

The line number for the given text index. Must not be settable.

Range For Index

The full range of characters. Must not be settable.

Range For Line

The range of characters. Must not be settable.

Range For Position

The range of the composed character sequence at the given text index. Must not be settable.

RTF For Range

Rich Text Format (RTF) data for the range. Must not be settable.

Selected Text Ranges

Ranges of selected text. May be settable.

Shared Character Range

Range of shared text displayed by a text area. Must not be settable.

Shared Text UI Elements

UI elements with which the text of an element is shared. Must not be settable.

String For Range

The substring. Must not be settable.

Style Range For Index

The full range of characters, which have the same style. Must not be settable.

Title UI Element

UI element that represents another element’s static text title. Must not be settable.

Text Field

Role for a text field.

Pseudoclass: AXTextField

Cocoa constant: NSAccessibilityTextFieldRole (Available in OS X v10.2 and later.)

Carbon constant: kAXTextFieldRole (Available in OS X v10.2 and later.)

Subroles: Search Field, Secure Text Field

Required Attributes

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Number Of Characters

Number of characters in an editable text field. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Selected Text

Currently selected text of a UI element. May be settable.

Selected Text Range

Position and length (in characters) of a selected portion of text in the UI element. May be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Value

The element’s value. May be settable.

Visible Character Range

Range of characters that are scrolled into view in an editable text element. May be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Attributed String For Range

Attributed string for the specified portion of the text associated with the currently selected item. Must not be settable.

Bounds For Range

Rectangle that bounds a range of text. Must not be settable.

Children

Child elements in an accessibility hierarchy. Must not be settable.

Description

Localized, human-intelligible string that describes what a UI element does. Must not be settable.

Help

Help text for a UI element. Must not be settable.

Insertion Point Line Number

Number of the line that currently has the insertion point. Must not be settable.

Line For Index

The line number for the given text index. Must not be settable.

Placeholder Value

Placeholder value displayed when an element is empty. Must not be settable.

Range For Index

The full range of characters. Must not be settable.

Range For Line

The range of characters. Must not be settable.

Range For Position

The range of the composed character sequence at the given text index. Must not be settable.

RTF For Range

Rich Text Format (RTF) data for the range. Must not be settable.

String For Range

The substring. Must not be settable.

Style Range For Index

The full range of characters, which have the same style. Must not be settable.

Title UI Element

UI element that represents another element’s static text title. Must not be settable.

Actions

Confirm

Simulates pressing Return in an element—for example, a text field.

Time Field

Role for a time field.

Pseudoclass: AXTimeField

Cocoa constant: (none defined)

Carbon constant: kAXTimeFieldRole (Available in OS X v10.3 and later.)

Required Attributes

AM/PM Field

AM/PM field of a time field element. Must not be settable.

Children

Child elements in an accessibility hierarchy. Must not be settable.

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Hour Field

Hours field of a time field element. Must not be settable.

Incrementor

Stepper control (the little arrows) of a time field or date field. Must not be settable.

Minute Field

Minutes field of a time field element. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Second Field

Seconds field of a time field element. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Value

The element’s value. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Focused

Flag that indicates whether an element has keyboard focus. May be settable.

Toolbar

Role for a toolbar.

Pseudoclass: AXToolbar

Cocoa constant: NSAccessibilityToolbarRole (Available in OS X v10.2 and later.)

Carbon constant: kAXToolbarRole (Available in OS X v10.2 and later.)

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. Must not be settable.

Help

Help text for a UI element. Must not be settable.

Overflow Button

Accessibility object representing the overflow button (if any) of a toolbar. Must not be settable.

Selected Children

Currently selected child elements of a UI element. Must not be settable.

Actions

Show Menu

Simulates showing a menu by clicking it.

Unknown Object

Role for an unknown object type.

Pseudoclass: AXUnknown

Cocoa constant: NSAccessibilityUnknownRole (Available in OS X v10.2 and later.)

Carbon constant: kAXUnknownRole (Available in OS X v10.2 and later.)

Subroles: Unknown Subrole

Required Attributes

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Optional Attributes

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Window

Window containing the current element. Must not be settable.

Value Indicator

Role for a value indicator—for example, the scroller in a scroll bar or the thumb of a slider.

Pseudoclass: AXValueIndicator

Cocoa constant: NSAccessibilityValueIndicatorRole (Available in OS X v10.2 and later.)

Carbon constant: kAXValueIndicatorRole (Available in OS X v10.2 and later.)

Required Attributes

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must not be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must not be settable.

Top-Level UI Element

A UI element’s containing window, sheet, or drawer. Must not be settable.

Value

The element’s value. May be settable.

Window

Window containing the current element. Must not be settable.

Optional Attributes

Enabled

Flag that indicates whether a user can interact with a UI element. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. Must not be settable.

Help

Help text for a UI element. Must not be settable.

Window

Subrole for a window.

Pseudoclass: AXWindow

Cocoa constant: NSAccessibilityWindowRole (Available in OS X v10.2 and later.)

Carbon constant: kAXWindowRole (Available in OS X v10.2 and later.)

Subroles: Dialog, Floating Window, Standard Window, System Dialog, System Floating Window

Discussion

Windows provided by the system always have a subrole as well as a role. Windows—along with sheets and drawers—are top-level UI elements.

Required Attributes

Children

Child elements in an accessibility hierarchy. Must not be settable.

Close Button

Accessibility object representing a window’s close button. Must not be settable.

Focused

Flag that indicates whether an element has keyboard focus. Must not be settable.

Main

Flag that indicates whether a window is the main window of an application. May be settable.

Minimize Button

Accessibility object that represents a window’s minimize button. Must not be settable.

Minimized

Flag that indicates whether a window is currently minimized in the Dock. May be settable.

Parent

Closest accessible container of a UI element. Must not be settable.

Position

Origin, in screen coordinates, of an element’s bounding rectangle. Must be settable.

Role

Basic type of an element. Must not be settable.

Role Description

Localized, human-intelligible description of an element’s role. Must not be settable.

Size

Height and width of an element’s bounding rectangle, in screen coordinates. Must be settable.

Title

Visible text title of an element. Must not be settable.

Zoom Button

Accessibility object representing the zoom button. Must not be settable.

Optional Attributes

Cancel Button

Accessibility object representing the window’s cancel button (if any). Must not be settable.

Default Button

Accessibility object representing the default button of a window or sheet. Must not be settable.

Document

URL or path for the document displayed in a window. Must not be settable.

Full Screen Button

Accessibility object representing the full-screen button of a window. Must not be settable.

Grow Area

Accessibility object representing the grow area element of a window or sheet. Must not be settable.

Modal

Flag that indicates whether the window represented by an element is modal. Must not be settable.

Proxy

Accessibility object representing a window’s document proxy element. Must not be settable.

Subrole

Subtype or specialization of a role. Must not be settable.

Title UI Element

UI element that represents another element’s static text title. Must not be settable.

Toolbar Button

Accessibility object representing the button that hides and reveals a window’s toolbar. Must not be settable.

Actions

Raise

Simulates bringing a window forward by clicking in its title bar.

Notifications

Created

Posted after an object is created.

Moved

Posted after an object moves.

Window Deminiaturized

Posted after a window is restored to full size from the Dock.

Window Miniaturized

Posted after a window is minimized in the Dock.

Window Moved

Posted after a window moves.

Window Resized

Posted after a window changes size.