Attributes

Allowed Values

Allowed values in a slider.

Pseudoclass: AXAllowedValues

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

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

Value type: Array

Discussion

This attribute is an array of the allowed values for a slider or other widget that displays a range of values, but that can only be set to a subset of values within that range. For example, a slider that allowed users to select multiples of five from zero to twenty would have an array with the numbers 0, 5, 10, 15, and 20 as the value of this attribute.

Required for Roles

Optional for Roles

AM/PM Field

AM/PM field of a time field element.

Pseudoclass: AXAMPMField

Cocoa constant: (none defined)

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

Value type: UI Element

Required for Roles

Cancel Button

Accessibility object representing the window’s cancel button (if any).

Pseudoclass: AXCancelButton

Cocoa constant: NSAccessibilityCancelButtonAttribute (Available in OS X v10.3 and later.)

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

Value type: UI Element

Optional for Roles

Children

Child elements in an accessibility hierarchy.

Pseudoclass: AXChildren

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

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

Value type: Array

Required for Roles

Optional for Roles

Clear Button

Accessibility object representing the clear button in a search field.

Pseudoclass: AXClearButton

Cocoa constant: NSAccessibilityClearButtonAttribute (Available in OS X v10.3 and later.)

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

Value type: UI Element

Required for Roles

Close Button

Accessibility object representing a window’s close button.

Pseudoclass: AXCloseButton

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

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

Value type: UI Element

Required for Roles

Column Count

Number of columns in a grid.

Pseudoclass: AXColumnCount

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

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

Value type: Number

Required for Roles

Optional for Roles

Column Header UI Elements

Column headers of a table or an outline.

Pseudoclass: AXColumnHeaderUIElements

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

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

Value type: Array

Optional for Roles

Column Index Range

Range that specifies the column index and column span of the cell.

Pseudoclass: AXColumnIndexRange

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

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

Value type: Range

Discussion

The location of the range is the index, and the length is the column span. For example, a cell located at column 5 with a column span of 3 reports the range (5, 3).

Required for Roles

Column Titles

Elements that represent column titles.

Pseudoclass: AXColumnTitles

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

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

Value type: Array

Required for Roles

Columns

Columns of a table.

Pseudoclass: AXColumns

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

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

Value type: Array

Required for Roles

Contents

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

Pseudoclass: AXContents

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

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

Value type: Array

Required for Roles

Optional for Roles

Critical Value

Value above which a critical warning is indicated.

Pseudoclass: AXCriticalValue

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

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

Value type:

Discussion

For example, a level indicator displaying a disk becoming too full. The level indicator’s color typically changes to red to indicate that the critical value has been met or exceeded. This attribute allows accessibility clients to determine that the threshold has been reached, and then report accordingly.

Required for Roles

Day Field

Day field of a date field element.

Pseudoclass: AXDayField

Cocoa constant: (none defined)

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

Value type: UI Element

Required for Roles

Decrement Button

Accessibility object representing the down arrow.

Pseudoclass: AXDecrementButton

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

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

Value type: UI Element

Discussion

The decrement button is used for decrementing a stepper control.

Required for Roles

Default Button

Accessibility object representing the default button of a window or sheet.

Pseudoclass: AXDefaultButton

Cocoa constant: NSAccessibilityDefaultButtonAttribute (Available in OS X v10.3 and later.)

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

Value type: UI Element

Optional for Roles

Description

Localized, human-intelligible string that describes what a UI element does.

Pseudoclass: AXDescription

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

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

Value type: String

Discussion

The purpose of the element, not including the role, described in a way that is slightly more specific than the value of the AXRoleDescription attribute, but shorter than value of the AXHelp attribute. Often used to describe images or buttons with images and no title. A description is usually short and uses neither capitalization nor punctuation.

Required for Roles

Optional for Roles

Disclosed By Row

Row by which a row is disclosed.

Pseudoclass: AXDisclosedByRow

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

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

Value type: UI Element

Required for Roles

Disclosed Rows

Rows that are disclosed by this row.

Pseudoclass: AXDisclosedRows

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

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

Value type: Array

Required for Roles

Disclosing

Flag that indicates whether a row is disclosing other rows.

Pseudoclass: AXDisclosing

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

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

Value type: Boolean

Required for Roles

Disclosure Level

Depth of a row in a disclosure hierarchy.

Pseudoclass: AXDisclosureLevel

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

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

Value type: Number

Required for Roles

Document

URL or path for the document displayed in a window.

Pseudoclass: AXDocument

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

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

Value type: String

Optional for Roles

Edited

Flag that indicates whether a UI element has unsaved changes.

Pseudoclass: AXEdited

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

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

Value type: Boolean

Required for Roles

Enabled

Flag that indicates whether a user can interact with a UI element.

Pseudoclass: AXEnabled

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

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

Value type: Boolean

Required for Roles

Optional for Roles

Expanded

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

Pseudoclass: AXExpanded

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

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

Value type: Boolean

Required for Roles

Filename

Filename associated with an element.

Pseudoclass: AXFilename

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

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

Value type: String

Optional for Roles

Focused

Flag that indicates whether an element has keyboard focus.

Pseudoclass: AXFocused

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

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

Value type: Boolean

Required for Roles

Optional for Roles

Focused Application

Application that currently has keyboard focus.

Pseudoclass: AXFocusedApplication

Cocoa constant: (none defined)

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

Value type: UI Element

Required for Roles

Focused UI Element

UI element that currently has keyboard focus in an application.

Pseudoclass: AXFocusedUIElement

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

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

Value type: UI Element

Required for Roles

Focused Window

Window that currently has keyboard focus in an application.

Pseudoclass: AXFocusedWindow

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

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

Value type: UI Element

Required for Roles

Frontmost

Flag that indicates whether an application is frontmost.

Pseudoclass: AXFrontmost

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

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

Value type: Boolean

Discussion

When settable, the value can be set to true, but not to false. Note that frontmost does not always mean that the application or its children have focus.

Required for Roles

Full Screen Button

Accessibility object representing the full-screen button of a window.

Pseudoclass: AXFullScreenButton

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

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

Value type: UI Element

Optional for Roles

Grow Area

Accessibility object representing the grow area element of a window or sheet.

Pseudoclass: AXGrowArea

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

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

Value type: UI Element

Optional for Roles

Handles

Accessibility objects representing the resize handles of a layout element

Pseudoclass: AXHandles

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

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

Value type: Array

Required for Roles

Header

Accessibility object representing the headers of a browser, a table, or an outline.

Pseudoclass: AXHeader

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

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

Value type: UI Element

Required for Roles

Optional for Roles

Help

Help text for a UI element.

Pseudoclass: AXHelp

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

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

Value type: String

Discussion

This is often the same information that would be provided in an element’s help tag.

Optional for Roles

Hidden

Flag that indicates whether an application is hidden.

Pseudoclass: AXHidden

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

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

Value type: Boolean

Discussion

When settable, the value can be set to true, but not to false.

Required for Roles

Optional for Roles

Horizontal Scroll Bar

Accessibility object representing a scroll view’s horizontal scroll bar.

Pseudoclass: AXHorizontalScrollBar

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

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

Value type: UI Element

Required for Roles

Optional for Roles

Horizontal Unit Description

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

Pseudoclass: AXHorizontalUnitDescription

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

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

Value type: String

Required for Roles

Horizontal Units

Unit of measurement used by the user interface element for measurement along the horizontal axis .

Pseudoclass: AXHorizontalUnits

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

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

Value type: String

Required for Roles

Hour Field

Hours field of a time field element.

Pseudoclass: AXHourField

Cocoa constant: (none defined)

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

Value type: UI Element

Required for Roles

Identifier

Persistent identifier.

Pseudoclass: AXIdentifier

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

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

Value type: String

Discussion

An identifier should be provided only if the same UI element reports the same identifier across multiple launches of the application. The identifier is not necessarily unique.

Increment Button

Accessibility object representing the up arrow.

Pseudoclass: AXIncrementButton

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

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

Value type: UI Element

Discussion

The increment button is used for incrementing a stepper control.

Required for Roles

Incrementor

Stepper control (the little arrows) of a time field or date field.

Pseudoclass: AXIncrementor

Cocoa constant: (none defined)

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

Value type: UI Element

Required for Roles

Index

Index of a row or column being represented.

Pseudoclass: AXIndex

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

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

Value type: Number

Required for Roles

Insertion Point Line Number

Number of the line that currently has the insertion point.

Pseudoclass: AXInsertionPointLineNumber

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

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

Value type: Number

Optional for Roles

Is Application Running

Flag that indicates whether an application is running, as represented in the Dock.

Pseudoclass: AXIsApplicationRunning

Cocoa constant: (none defined)

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

Value type: Boolean

Required for Roles

Label UI Elements

Accessibility objects representing tick marks along a UI element—for example, along a slider.

Pseudoclass: AXLabelUIElements

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

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

Value type: Array

Discussion

A slider often has stated values at particular tick marks. The value of this attribute is an array of UI elements that contain the labels for these tick marks.

Label Value

Accessibility object representing the values of a label.

Pseudoclass: AXLabelValue

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

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

Value type: Number

Discussion

A slider often has labels associated with particular tick marks. The AXLabelUIElements attribute contains the UI elements that serve as the label.

Linked UI Elements

UI elements having some relationship to an element.

Pseudoclass: AXLinkedUIElements

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

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

Value type: Array

Discussion

For example, the contents of a list item that are displayed in another pane or window.

Optional for Roles

Main

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

Pseudoclass: AXMain

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

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

Value type: Boolean

Required for Roles

Main Window

Main window of an application.

Pseudoclass: AXMainWindow

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

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

Value type: UI Element

Required for Roles

Marker Group UI Element

UI element that groups markers—for example, the tab well of a ruler.

Pseudoclass: AXMarkerGroupUIElement

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

Carbon constant: (none defined)

Value type: UI Element

Discussion

This attribute is not currently used by any role.

Marker Type

Ruler marker type—for example, a left tab stop.

Pseudoclass: AXMarkerType

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

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

Value type: String

Required for Roles

Marker Type Description

Description of a ruler marker type.

Pseudoclass: AXMarkerTypeDescription

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

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

Value type: String

Required for Roles

Marker UI Elements

Marker UI elements related to a ruler.

Pseudoclass: AXMarkerUIElements

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

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

Value type: Array

Required for Roles

Marker Values

Positional values of a ruler marker on a ruler.

Pseudoclass: AXMarkerValues

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

Carbon constant: (none defined)

Value type: Array

Discussion

This attribute is not currently used by any role. See the AXMarkerUIElements attribute.

Matte Content UI Element

UI element that is clipped by a matte region.

Pseudoclass: AXMatteContentUIElement

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

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

Value type: UI Element

Required for Roles

Matte Hole

Bounds of a matte hole, in screen coordinates.

Pseudoclass: AXMatteHole

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

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

Value type: Rect

Required for Roles

Max Value

Maximum value that this element can display.

Pseudoclass: AXMaxValue

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

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

Value type: Number

Required for Roles

Optional for Roles

Menu Bar

Menu bar for an application.

Pseudoclass: AXMenuBar

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

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

Value type: UI Element

Required for Roles

Menu Item Command Character

Keyboard shortcut for a menu item.

Pseudoclass: AXMenuItemCmdChar

Cocoa constant: (none defined)

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

Value type: String

Discussion

If a menu item has a keyboard shortcut, this string represents that character. Otherwise, this is the empty string.

Required for Roles

Menu Item Command Glyph

Number of the glyph displayed for the keyboard shortcut.

Pseudoclass: AXMenuItemCmdGlyph

Cocoa constant: (none defined)

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

Value type: Number

Discussion

This attribute is only used for nonalphanumeric keyboard shortcuts, such as Return and Delete. For a list of glyph numbers, see Menu.h

Required for Roles

Menu Item Command Modifiers

Bit field that describes the modifier keys associated with a menu item.

Pseudoclass: AXMenuItemCmdModifiers

Cocoa constant: (none defined)

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

Value type: Number

Required for Roles

Menu Item Command Virtual Key

Key code for the physical key associated with a menu item.

Pseudoclass: AXMenuItemCmdVirtualKey

Cocoa constant: (none defined)

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

Value type: Number

Required for Roles

Menu Item Mark Character

Symbol displayed next to this element—for example, a bullet or checkmark.

Pseudoclass: AXMenuItemMarkChar

Cocoa constant: (none defined)

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

Value type: String

Required for Roles

Menu Item Primary UI Element

UI element that displays the menu in which a menu item is contained.

Pseudoclass: AXMenuItemPrimaryUIElement

Cocoa constant: (none defined)

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

Value type: UI Element

Discussion

This attribute is attached to a menu item if it is a dynamic menu.

Required for Roles

Min Value

Minimum value that an element can display.

Pseudoclass: AXMinValue

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

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

Value type: Number

Required for Roles

Optional for Roles

Minimize Button

Accessibility object that represents a window’s minimize button.

Pseudoclass: AXMinimizeButton

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

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

Value type: UI Element

Required for Roles

Minimized

Flag that indicates whether a window is currently minimized in the Dock.

Pseudoclass: AXMinimized

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

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

Value type: Boolean

Required for Roles

Minute Field

Minutes field of a time field element.

Pseudoclass: AXMinuteField

Cocoa constant: (none defined)

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

Value type: UI Element

Required for Roles

Modal

Flag that indicates whether the window represented by an element is modal.

Pseudoclass: AXModal

Cocoa constant: NSAccessibilityModalAttribute (Available in OS X v10.3 and later.)

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

Value type: Boolean

Optional for Roles

Month Field

Month field of a date field element.

Pseudoclass: AXMonthField

Cocoa constant: (none defined)

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

Value type: UI Element

Required for Roles

Next Contents

Objects on one the following side of a splitter bar.

Pseudoclass: AXNextContents

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

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

Value type: Array

Discussion

This attribute represents the contents following the current divider element, such as a subview adjacent to a split view’s splitter element.

Required for Roles

Number Of Characters

Number of characters in an editable text field.

Pseudoclass: AXNumberOfCharacters

Cocoa constant: NSAccessibilityNumberOfCharactersAttribute (Available in OS X v10.3 and later.)

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

Value type: Number

Discussion

This value may not be the same as the number of bytes.

Required for Roles

Ordered By Row

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

Pseudoclass: AXOrderedByRow

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

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

Value type: Boolean

Required for Roles

Orientation

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

Pseudoclass: AXOrientation

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

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

Value type: String

Discussion

The element’s orientation can have the value NSAccessibilityHorizontalOrientationValue or NSAccessibilityVerticalOrientationValue.

Required for Roles

Overflow Button

Accessibility object representing the overflow button (if any) of a toolbar.

Pseudoclass: AXOverflowButton

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

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

Value type: UI Element

Optional for Roles

Parent

Closest accessible container of a UI element.

Pseudoclass: AXParent

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

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

Value type: UI Element

Discussion

In terms of the accessibility hierarchy, this value indicates an element’s parent.

Required for Roles

Placeholder Value

Placeholder value displayed when an element is empty.

Pseudoclass: AXPlaceholderValue

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

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

Value type: String

Discussion

For example, the text displayed in an empty text field.

Optional for Roles

Position

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

Pseudoclass: AXPosition

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

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

Value type: Point

Required for Roles

Previous Contents

Objects on the preceding side of a splitter bar element.

Pseudoclass: AXPreviousContents

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

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

Value type: Array

Discussion

This attribute represents the contents preceding the current divider element, such as a subview adjacent to a split view’s splitter element.

Required for Roles

Proxy

Accessibility object representing a window’s document proxy element.

Pseudoclass: AXProxy

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

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

Value type: UI Element

Optional for Roles

Role

Basic type of an element.

Pseudoclass: AXRole

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

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

Value type: String

Required for Roles

Role Description

Localized, human-intelligible description of an element’s role.

Pseudoclass: AXRoleDescription

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

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

Value type: String

Discussion

An assistive application can present this description to its users—for example, a radio button.

Required for Roles

Row Count

Number of rows in a grid.

Pseudoclass: AXRowCount

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

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

Value type: Number

Required for Roles

Optional for Roles

Row Header UI Elements

Array of UI elements that represent the row headers of a table or an outline.

Pseudoclass: AXRowHeaderUIElements

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

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

Value type: Array

Discussion

For example, the row headers of a spreadsheet.

Optional for Roles

Row Index Range

Range that specifies the row index and row span of the cell.

Pseudoclass: AXRowIndexRange

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

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

Value type: Range

Discussion

The location of the range is the index, and the length is the row span. For example, a cell located at row 3 with a row span of 2 reports the range (3, 2).

Required for Roles

Rows

The table’s rows.

Pseudoclass: AXRows

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

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

Value type: Array

Required for Roles

Search Button

Accessibility object representing the search button in a search field.

Pseudoclass: AXSearchButton

Cocoa constant: NSAccessibilitySearchButtonAttribute (Available in OS X v10.3 and later.)

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

Value type: UI Element

Required for Roles

Search Menu

Accessibility object representing the menu in a search field.

Pseudoclass: AXSearchMenu

Cocoa constant: NSAccessibilitySearchMenuAttribute (Available in OS X v10.3 and later.)

Carbon constant: (none defined)

Value type: UI Element

Second Field

Seconds field of a time field element.

Pseudoclass: AXSecondField

Cocoa constant: (none defined)

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

Value type: UI Element

Required for Roles

Selected

Flag that indicates whether a UI element is selected.

Pseudoclass: AXSelected

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

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

Value type: Boolean

Required for Roles

Selected Cells

Array of the selected cells.

Pseudoclass: AXSelectedCells

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

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

Value type: Array

Discussion

This attribute is optional for elements with the AXTable role, but it is required for cell-based tables.

Optional for Roles

Selected Children

Currently selected child elements of a UI element.

Pseudoclass: AXSelectedChildren

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

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

Value type: Array

Required for Roles

Optional for Roles

Selected Columns

Currently selected columns of a table.

Pseudoclass: AXSelectedColumns

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

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

Value type: Array

Required for Roles

Selected Rows

Currently selected rows of a table

Pseudoclass: AXSelectedRows

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

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

Value type: Array

Required for Roles

Selected Text

Currently selected text of a UI element.

Pseudoclass: AXSelectedText

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

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

Value type: String

Required for Roles

Selected Text Range

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

Pseudoclass: AXSelectedTextRange

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

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

Value type: Range

Discussion

If the length of the selection is zero, the location of the range indicates the location of the insertion point. If the interface supports noncontiguous text selection, this attribute returns the first selection, and AXSelectedTextRanges contains all of the selections.

Required for Roles

Selected Text Ranges

Ranges of selected text.

Pseudoclass: AXSelectedTextRanges

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

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

Value type: Array

Discussion

This attribute supports text areas that allow noncontiguous text selection. The first range in the array is the same as what the AXSelectedTextRange attribute returns.

Optional for Roles

Serves As Title For UI Elements

Elements for which this element serves as the title.

Pseudoclass: AXServesAsTitleForUIElements

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

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

Value type: Array

Optional for Roles

Shared Character Range

Range of shared text displayed by a text area.

Pseudoclass: AXSharedCharacterRange

Cocoa constant: NSAccessibilitySharedCharacterRangeAttribute (Available in OS X v10.3 and later.)

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

Value type: Range

Discussion

When text flows between UI elements—for example, two columns on a single page—all of the UI elements share the same underlying text value, even though each UI element displays only part of it.

Optional for Roles

Shared Text UI Elements

UI elements with which the text of an element is shared.

Pseudoclass: AXSharedTextUIElements

Cocoa constant: NSAccessibilitySharedTextUIElementsAttribute (Available in OS X v10.3 and later.)

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

Value type: Array

Discussion

When text flows between UI elements—for example two columns on a single page—all of the UI elements share the same underlying text value, even though each UI element displays only part of it.

Optional for Roles

Shown Menu

Menu that is currently being displayed.

Pseudoclass: AXShownMenu

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

Carbon constant: (none defined)

Value type: UI Element

Shown Menu UI Element

Accessibility object representing the Dock item’s Dock menu.

Pseudoclass: AXShownMenuUIElement

Cocoa constant: (none defined)

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

Value type: UI Element

Discussion

If the Dock menu is hidden, the value is NULL.

Required for Roles

Size

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

Pseudoclass: AXSize

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

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

Value type: Size

Required for Roles

Sort Direction

Sort direction of a column.

Pseudoclass: AXSortDirection

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

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

Value type: String

Required for Roles

Splitters

Splitter bars in a split group.

Pseudoclass: AXSplitters

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

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

Value type: Array

Required for Roles

Subrole

Subtype or specialization of a role.

Pseudoclass: AXSubrole

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

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

Value type: String

Required for Roles

Optional for Roles

Tabs

Tab controls in a tab view.

Pseudoclass: AXTabs

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

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

Value type: Array

Required for Roles

Title

Visible text title of an element.

Pseudoclass: AXTitle

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

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

Value type: String

Discussion

A localized, human-intelligible string that is the visible text of a UI element. Applications are an exception in which the value should be the name of the application.

Required for Roles

Optional for Roles

Title UI Element

UI element that represents another element’s static text title.

Pseudoclass: AXTitleUIElement

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

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

Value type: UI Element

Required for Roles

Optional for Roles

Toolbar Button

Accessibility object representing the button that hides and reveals a window’s toolbar.

Pseudoclass: AXToolbarButton

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

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

Value type: UI Element

Optional for Roles

Top-Level UI Element

A UI element’s containing window, sheet, or drawer.

Pseudoclass: AXTopLevelUIElement

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

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

Value type: UI Element

Discussion

The value of this attribute should be equivalent to walking up the accessibility parent hierarchy until the first top-level UI element is found. This is very much like the AXWindow attribute, except that the value of this attribute can be an element with an AXSheet or AXDrawer role.

Required for Roles

Optional for Roles

Unit Description

Localized description of a ruler’s units.

Pseudoclass: AXUnitDescription

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

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

Value type: String

Required for Roles

Units

Ruler unit type—for example, inches.

Pseudoclass: AXUnits

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

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

Value type: String

Required for Roles

URL

URL or path associated with an element.

Pseudoclass: AXURL

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

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

Value type: URL

Required for Roles

Optional for Roles

Value

The element’s value.

Pseudoclass: AXValue

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

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

Value type:

Discussion

This is a general-purpose attribute.

Required for Roles

Optional for Roles

Value Description

String that best describes the current value of an element.

Pseudoclass: AXValueDescription

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

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

Value type: String

Discussion

The string should be localized, lowercase, and as brief as possible to convey the information. For example, a slider that lets the user set an amount of time might report a more meaningful value description of “3 minutes”, which would be used instead of the raw numeric value of the slider.

Optional for Roles

Value Increment

Amount a value will change in one action on a given element.

Pseudoclass: AXValueIncrement

Cocoa constant: (none defined)

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

Value type: Number

Value Wraps

Flag that indicates whether maximum value and minimum value wrap around.

Pseudoclass: AXValueWraps

Cocoa constant: (none defined)

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

Value type: Boolean

Discussion

If this attribute is true, incrementing when the value is at its maximum will set the value to its minimum, and decrementing when the value is at its minimum will set the value to its maximum.

Vertical Scroll Bar

Accessibility object representing the vertical scroll bar in a scroll view.

Pseudoclass: AXVerticalScrollBar

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

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

Value type: UI Element

Optional for Roles

Vertical Unit Description

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

Pseudoclass: AXVerticalUnitDescription

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

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

Value type: String

Required for Roles

Vertical Units

Unit of measurement used by the user interface element for measurement along the vertical axis.

Pseudoclass: AXVerticalUnits

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

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

Value type: String

Required for Roles

Visible Cells

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

Pseudoclass: AXVisibleCells

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

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

Value type: Array

Discussion

This attribute is optional for elements with the AXTable role, but it is required for cell-based tables.

Optional for Roles

Visible Character Range

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

Pseudoclass: AXVisibleCharacterRange

Cocoa constant: NSAccessibilityVisibleCharacterRangeAttribute (Available in OS X v10.3 and later.)

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

Value type: Range

Discussion

This attribute returns ranges for entire lines; for example, characters that are horizontally clipped will be included in the range. When this attribute can be set by an accessibility client, setting the range should act as if the user had scrolled that range of text into view. Note this value may not be the same as the range of bytes.

Required for Roles

Visible Children

Currently visible child elements of a UI element.

Pseudoclass: AXVisibleChildren

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

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

Value type: Array

Required for Roles

Optional for Roles

Visible Columns

Currently visible columns.

Pseudoclass: AXVisibleColumns

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

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

Value type: Array

Required for Roles

Visible Rows

Currently visible rows.

Pseudoclass: AXVisibleRows

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

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

Value type: Array

Required for Roles

Warning Value

Value above which a warning is indicated.

Pseudoclass: AXWarningValue

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

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

Value type:

Discussion

For example, a level indicator displaying a disk becoming too full. The level indicator’s color typically changes to yellow to indicate that the warning value has been met or exceeded. This attribute allows accessibility clients to determine that the threshold has been reached, and report it accordingly.

Required for Roles

Window

Window containing the current element.

Pseudoclass: AXWindow

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

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

Value type: UI Element

Required for Roles

Optional for Roles

Windows

Windows of an application.

Pseudoclass: AXWindows

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

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

Value type: Array

Discussion

This includes the main window as well as all other windows.

Required for Roles

Year Field

Year field of a date field.

Pseudoclass: AXYearField

Cocoa constant: (none defined)

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

Value type: UI Element

Required for Roles

Zoom Button

Accessibility object representing the zoom button.

Pseudoclass: AXZoomButton

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

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

Value type: UI Element

Required for Roles