PFUIElement(Attributes)
IntroductionA category on PFUIElement for attribute properties and methods. DiscussionThe Attributes category on PFUIElement includes two kinds of attributes: nonparameterized attributes and parameterized attributes. The nonparameterized attributes are declared as properties. To use them, you send a The parameterized attributes are implemented as methods. You send them to a receiver with a parameter, and the value returned depends on the value of the parameter. The accessor methods specified by the properties in the Attributes category on PFUIElement return UI element attribute values for attributes having the same name as the property. All attributes declared in the AXAttributeConstants.h and NSAccessibility.h headers are included (except where they are marked obsolete). Note that some attributes appear in only one of those headers. Individual properties are named according to the string value of the attribute, not its constant name in the AXAttributeConstants.h or NSAccessibility.h header. They are classified approximately the same as in AXAttributeConstants.h, which differs in minor ways from the classification in NSAccessibility.h. Classification of attributes is for ease of understanding only and has no functional significance. It can be misleading, because Apple encourages developers to use existing attribute names for custom objects where possible, and they may therefore be used for new purposes. The properties in this category are mostly for convenience. Instead of using them, you can send -valueForAttribute: and -setValue:forAttribute: with the appropriate accessibility API constant from AXAttributeConstants.h (cast to NSString*) or NSAccessibility.h. These two methods use key-value coding to find and send one of these properties by name or, if it is not found, to fall back on a private method that calls the accessibility API directly. The net effect is that the framework will always find all attributes, even new attributes that are added to the accessibility API in future versions of Mac OS X and custom attributes that are implemented by other applications such as the Finder and Safari. You must send -valueForAttribute: and -setValue:forAttribute: instead of a specific property when you don't know in advance which attribute to use, for example, when using a list of attributes obtained from the -nonParameterizedAttributes method. There is a slight efficiency advantage in sending an accessor message instead of using the -valueForAttribute: and -setValue:forAttribute: methods. Either technique will execute any special code, such as bug fixes, that is included in a particular accessor method. All attribute values are Objective-C objects returned autoreleased. See -attributes for information regarding the use of the attribute properties. Methods
AXAttributedStringForRange:Returns the text of the characters in - (NSAttributedString *)AXAttributedStringForRange:(NSValue *)characterRange; ParametersReturn ValueAn NSAttributedString object containing the attributed string of the receiving text object in DiscussionThis is a parameterized attribute method to read text objects. Given a character range in the receiving text object, it returns the characters in that range as an NSAttributedString object, including formatting. The text attributes contained in the dictionary object associated with the attributed string returned by this method are not intended for visual display, but instead to provide information that is useful in the accessibility context. They differ from the text attributes in a standard text system NSAttributedString object and in its CFAttributedString counterpart. The keys are prefixed with "AX" instead of "NS", as in "AXFont" instead of "NSFont", and their contents may differ from the contents of their standard text system analogs. They are declared in the AXTextAttributedString.h header. The accessibility attributed string returned by this method therefore cannot be displayed in a text view without first converting it to a standard attributed string. See -attributedStringFromAXAttributedString: for more information, and use that method to effect the conversion. The See also AXStringForRange: and AXRTFForRange:. AXBoundsForRange:Returns the bounds on the screen enclosing the characters in - (NSValue *)AXBoundsForRange:(NSValue *)characterRange; ParametersReturn ValueAn NSValue object encoding an NSRect struct. DiscussionThis is a parameterized attribute method to read text objects. Given a character range in the receiving text object, it returns the bounds on the screen enclosing the characters. The In the case of a range of characters that encompasses more than one line, the returned bounds encloses all of the characters in the range, in all lines. Use NSValue's AXCellForColumnAndRow:Returns the cell in the receiving cell-based table at the intersection of the column and row in - (PFUIElement *)AXCellForColumnAndRow:(NSArray *)columnAndRowArray; ParametersReturn ValueA PFUIElement object. DiscussionThis is a parameterized attribute method to read cell-based table objects. Given an array containing the column index and the row index in the receiving cell-based table object, it returns the cell object. This method is available, for example, in Apple's Numbers application. Availability: Introduced in Mac OS X v10.6. AXLayoutPointForScreenPoint:Returns the point in the layout area coordinate system corresponding to - (NSValue *)AXLayoutPointForScreenPoint:(NSValue *)screenPoint; ParametersReturn ValueAn NSValue object encoding an NSPoint structure. DiscussionThis is a parameterized attribute method to read cell-based table objects. Given a point on the screen in top-left relative screen coordinates, it returns the corresponding point in the receiving layout area in the layout area's coordinate system. This method is available, for example, in Apple's Numbers application. The units of measurement used in the layout area may differ from those used on the screen. See AXHorizontalUnits and AXVerticalUnits. Use NSValue's Availability: Introduced in Mac OS X v10.6. See also AXScreenPointForLayoutPoint:. AXLayoutSizeForScreenSize:Returns the size in the layout area coordinate system corresponding to - (NSValue *)AXLayoutSizeForScreenSize:(NSValue *)screenSize; ParametersReturn ValueAn NSValue object encoding an NSSize structure. DiscussionThis is a parameterized attribute method to read layout area objects. Given the size on the screen in screen coordinates, it returns the corresponding size of the receiving layout area in the layout area's coordinate system. This method is available, for example, in Apple's Numbers application. The units of measurement used in the layout area may differ from those used on the screen. See AXHorizontalUnits and AXVerticalUnits. Use NSValue's Availability: Introduced in Mac OS X v10.6. See also AXScreenPointForLayoutPoint:. AXLineForIndex:Returns the line index of the line containing the character at - (NSNumber *)AXLineForIndex:(NSNumber *)characterIndex; ParametersReturn ValueAn NSNumber object encoding an integer value. DiscussionThis is a parameterized attribute method to read text objects. Given a character index in the receiving text object, it returns the index of the line of text in which the character appears. This is a common way to use the parameterized text methods: start with a character index, typically obtained by reading the screen to obtain a reference to the glyph under the mouse pointer. See AXRangeForPosition: for information on obtaining the character range of the glyph at a specified screen position. A character's index is its sequential index, counting all characters from the beginning of the text object even if it flows across multiple text containers or views such as pages or columns. It can be important in some circumstances to avoid using character indexes that fall in the middle of a glyph. See -AXRangeForIndex: for information about obtaining the starting character index and length of any glyph. The result returned by this method can be ambiguous when you are attempting to determine the line index of a naked insertion point at See -AXRangeForPosition: for information about obtaining the character index and length of a glyph on the screen for use in a screen reader application. Use NSNumber's AXRangeForIndex:Returns the range of characters in the receiving text object composing the single glyph that contains - (NSValue *)AXRangeForIndex:(NSNumber *)characterIndex; ParametersReturn ValueAn NSValue object encoding an NSRange structure. DiscussionThis is a parameterized attribute method to read text objects. Given a character index in the receiving text object, it returns the range of characters in the receiving text object composing the glyph. This method is based on the premise that a glyph may be composed of one or more characters. Use this method to obtain the character range of a single glyph based on its position within the receiving text view. Use NSValue's AXRangeForLine:Returns the range of characters contained in the line of text at - (NSValue *)AXRangeForLine:(NSNumber *)lineIndex; ParametersReturn ValueAn NSValue object encoding an NSRange structure. DiscussionThis is a parameterized attribute method to read text objects. Given a line index in the receiving text object, it returns the range of characters contained in the line of text. A screen reader typically obtains the line index by first obtaining the character index under the mouse pointer and then calling AXLineForIndex:. Use NSValue's AXRangeForPosition:Returns the range of characters in the receiving text object composing the single glyph located at - (NSValue *)AXRangeForPosition:(NSValue *)glyphPosition; ParametersReturn ValueAn NSValue object encoding an NSRange structure. DiscussionThis method is based on the premise that a glyph may be composed of one or more characters. It can be important to avoid using character indexes that fall in the middle of a glyph. Use this method to obtain the character range of a single glyph based on its position on the screen, for example, the character range of the glyph under the mouse. See -elementAtPoint:withDelegate:error: for information about obtaining the current position of the mouse. In a screen reader application, use the resulting character range returned by this method as a route into the other parameterized methods which take a character index, character range, or (indirectly from the character index) line index as input. The location field of the character range is the character index of the first character of the glyph, and the length field of the character range is the number of characters to the next glyph. Use NSValue's AXRTFForRange:Returns the text of the characters in - (NSData *)AXRTFForRange:(NSValue *)characterRange; ParametersReturn ValueAn NSData object containing the RTF data of the receiving text object in DiscussionThis is a parameterized attribute method to read text objects. Given a character range in the receiving text object, it returns the characters in that range as an NSData object, including formatting. The See also AXStringForRange: and AXAttributedStringForRange:. AXScreenPointForLayoutPoint:Returns the point in top-left relative screen coordinates corresponding to - (NSValue *)AXScreenPointForLayoutPoint:(NSValue *)layoutPoint; ParametersReturn ValueAn NSValue object encoding an NSPoint structure. DiscussionThis is a parameterized attribute method to read cell-based table objects. Given a point in the receiving layout area in the layout area's coordinate system, it returns the corresponding point on the screen in top-left relative screen coordinates. The units of measurement used in the layout area may differ from those used on the screen. See AXHorizontalUnits and AXVerticalUnits. Use NSValue's Availability: Introduced in Mac OS X v10.6. See also AXScreenSizeForLayoutSize:. AXScreenSizeForLayoutSize:Returns the size in screen coordinates corresponding to - (NSValue *)AXScreenSizeForLayoutSize:(NSValue *)layoutSize; ParametersReturn ValueAn NSValue object encoding an NSSize structure. DiscussionThis is a parameterized attribute method to read layout area objects. Given the size of the receiving layout area in the layout area's coordinate systemon, it returns the corresponding size on the screen in screen coordinates. The units of measurement used in the layout area may differ from those used on the screen. See AXHorizontalUnits and AXVerticalUnits. Use NSValue's Availability: Introduced in Mac OS X v10.6. See also AXLayoutSizeForScreenSize:. AXStringForRange:Returns the text of the characters in - (NSString *)AXStringForRange:(NSValue *)characterRange; ParametersReturn ValueAn NSString object. DiscussionThis is a parameterized attribute method to read text objects. Given a character range in the receiving text object, it returns the characters in that range as an NSString object. The See also AXRTFForRange: and AXAttributedStringForrange:. AXStyleRangeForIndex:Returns the range of characters in the receiving text object composing a single style run that contains - (NSValue *)AXStyleRangeForIndex:(NSNumber *)characterIndex; ParametersReturn ValueAn NSValue object encoding an NSRange structure. DiscussionThis is a parameterized attribute method to read text objects. Given a character index in the receiving text object, it returns the range of characters in the receiving text object composing the style run. Use NSValue's Properties
AXAllowedValuesAn array of discrete values that the receiver can assume. @property(readonly) NSArray *AXAllowedValues; Return ValueAn NSArray object containing objects of any type (typically NSNumber). DiscussionThe AXAMPMFieldThe AM/PM field in the receiving clock control. @property(readonly) PFUIElement *AXAMPMField; Return ValueA PFUIElement object. DiscussionThe AXCancelButtonThe receiving window's cancel button. @property(readonly) PFUIElement *AXCancelButton; Return ValueA PFUIElement object, or DiscussionThe AXChildrenThe receiver's children UI elements. @property(readonly) NSArray *AXChildren; Return ValueAn array of PFUIElement objects, or DiscussionAn element's There is a one-to-many relationship between a parent and its children. A child can have only one parent, while a parent can have many children. The AXParent and A parent and its children must match in both directions. That is, a child's parent must have the child as one of its children, and a parent's child must have the parent as its only parent. Any failure of the accessibility containment hierarch to match in both directions is the result of an application bug. The bug may cause an element browser (which looks "up" the hierarchy from the "root" application element through its children) or a screen reader (which looks "down" the hierarchy from a "leaf" element on the screen through its parents) to fail. A surprising number of applications exhibit this bug with respect to some of their elements. See also AXParent. AXClearButtonThe clear button element in the receiving search field. @property(readonly) PFUIElement *AXClearButton; Return ValueA PFUIElement object, or DiscussionThe AXCloseButtonThe close button in the receiving window's title bar. @property(readonly) PFUIElement *AXCloseButton; Return ValueA PFUIElement object, or DiscussionThe AXColumnCountThe number of columns in the receiving grid element. @property(readonly) NSNumber *AXColumnCount; Return ValueAn NSNumber object encoding an integer value, or DiscussionThe Use NSNumber's See also AXRowCount. AXColumnHeaderUIElementsThe receiver's column header UI elements. @property(readonly) NSArray *AXColumnHeaderUIElements; Return ValueAn array of PFUIElement objects, which may be DiscussionAn element's Availability: Introduced in Mac OS X v10.6. AXColumnIndexRangeThe range of the receiver's column indexes. @property(readonly) NSValue *AXColumnIndexRange; Return ValueAn NSValue object encoding an NSRange structure, or DiscussionThe Use NSValue's Availability: Introduced in Mac OS X v10.6. See also AXRowIndexRange. AXColumnsThe columns of the receiving table or outline. @property(readonly) NSArray *AXColumns; Return ValueAn array of PFUIElement objects. DiscussionThe AXColumnTitlesThe receiving browser's column title elements. @property(readonly) NSArray *AXColumnTitles; Return ValueAn array of PFUIElement objects. DiscussionThe AXContentsThe main contents of the receiver. @property(readonly) NSArray *AXContents; Return ValueAn array of PFUIElement objects. DiscussionThe returned UI elements are the main informational elements contained by the receiver, omitting children that represent functional elements such as scrollbars. For example, the contents of a scroll area may be a text entry area or a table but would omit the scroll area's scroll bar or ruler, and the contents of a tab group would omit the tabs (radio buttons) themselves. See also AXNextContents and AXPreviousContents. AXCriticalValueThe receiving level indicator's critical value. @property(readonly) id AXCriticalValue; Return ValueAn object of any value, typically an NSNumber. DiscussionThe Availability: Introduced in Mac OS X v10.6. AXDayFieldThe day field in the receiving clock control. @property(readonly) PFUIElement *AXDayField; Return ValueA PFUIElement object. DiscussionThe AXDecrementButtonThe receiving stepper's decrement button. @property(readonly) PFUIElement *AXDecrementButton; Return ValueA PFUIElement object. DiscussionThe See also AXIncrementButton. AXDefaultButtonThe receiving window's default button. @property(readonly) PFUIElement *AXDefaultButton; Return ValueA PFUIElement object, or DiscussionThe AXDescriptionA localized string specifically describing the receiver. @property(readonly) NSString *AXDescription; Return ValueAn NSString object, or DiscussionAn element's See also AXRole, AXSubrole, AXRoleDescription, and AXHelp. AXDisclosedByRowThe receiving outline child row's parent row. @property(readonly) PFUIElement *AXDisclosedByRow; Return ValueA PFUIElement object. DiscussionThe AXDisclosedRowsThe expanded child rows of the receiving parent outline view row. @property(readonly) NSArray *AXDisclosedRows; Return ValueAn array of PFUIElement objects. DiscussionThe AXDisclosingWhether the receiving outline view row is expanded. @property(readwrite, retain) NSNumber *AXDisclosing; Return ValueAn NSNumber object encoding a BOOL value. DiscussionThe Use NSNumber's To expand the receiver, call AXDisclosureLevelThe indentation level of the receiving outline row. @property(readonly) NSNumber *AXDisclosureLevel; Return ValueAn NSNumber object encoding an integer value. DiscussionThe Use NSNumber's AXDocumentThe receiver's path as a file URL. @property(readonly) NSString *AXDocument; Return ValueAn NSString object, or DiscussionThe See also AXURL and AXFilename. AXEditedWhether the receiver has been edited since it was last saved. @property(readonly) NSNumber *AXEdited; Return ValueAn NSNumber object encoding a BOOL value. DiscussionThe Use NSNumber's AXEnabledWhether the receiver is enabled. @property(readonly) NSNumber *AXEnabled; Return ValueAn NSNumber object encoding a BOOL value. DiscussionAn element is enabled if a user can interact with it. Views, the menu bar, menu bar items, menus, and menu items always have an AXEnabled attribute; windows typically do not. Use NSNumber's AXEnhancedUserInterfaceWhether the receiving application is using enhanced user interface behaviors. @property(readwrite, retain) NSNumber *AXEnhancedUserInterface; Return ValueAn NSNumber object encoding a BOOL value. DiscussionThe Use NSNumber's To cause an application to use enhanced user interface behaviors, call The NSAccessibilityEnhancedUserInterfaceAttribute constant is private Apple API. Use at your own risk. VoiceOver sets this attribute to indicate that it wants subtle changes made to the behavior of an application's user interface that would otherwise interfere with VoiceOver. The effect of setting this attribute is subject to change, and the attribute may disappear in future versions of Mac OS X. Currently, it has to do with keyboard navigation in text fields and tab views. The value of this attribute does not necessarily correlate with VoiceOver being active or inactive. AXExpandedWhether the receiving UI element is expanded. @property(readwrite, retain) NSNumber *AXExpanded; Return ValueAn NSNumber object encoding a BOOL value. DiscussionThe Use NSNumber's To expand the receiver, call AXFilenameThe receiver's file name. @property(readonly) NSString *AXFilename; Return ValueAn NSString object, or DiscussionThe See also AXDocument and AXURL. AXFocusedWhether the receiver has keyboard focus. @property(readwrite, retain) NSNumber *AXFocused; Return ValueAn NSNumber object encoding a BOOL value. DiscussionOnly one element in a window's accessibility containment hierarchy can have keyboard focus at any given time. To access the element having keyboard focus in a specific application no matter what window it is in, use AXFocusedUIElement. To access the window having keyboard focus in a specific application, use AXFocusedWindow. To access the active application system-wide, use AXFocusedApplication. In the case of a window element, the window having keyboard focus need not be the application's main window. To determine if a window is the main window, use AXMain. Keyboard events sent to an application are "typed" into the element currently having keyboard focus, if it is an editable text view or text field (except for command-down keyboard shortcuts, which are always handled by the application itself). Use NSNumber's To assign keyboard focus to the receiver, call AXFocusedApplicationThe receiving system-wide UI element's focused application element. @property(readonly) PFApplicationUIElement *AXFocusedApplication; Return ValueA PFApplicationUIElement object. DiscussionThe See AXFocused for more information. AXFocusedUIElementThe receiving application's focused UI element. @property(readonly) PFUIElement *AXFocusedUIElement; Return ValueA PFUIElement object. DiscussionThe See AXFocused for more information. AXFocusedWindowThe receiving application's key window, the window that has keyboard focus. @property(readonly) PFUIElement *AXFocusedWindow; Return ValueA PFUIElement object. DiscussionThe See AXFocused for more information. AXFrontmostWhether the receiving application is frontmost. @property(readwrite, retain) NSNumber *AXFrontmost; Return ValueAn NSNumber object encoding a BOOL value. DiscussionThe Use NSNumber's To bring an application to the front, call AXFullScreenWhether the receiving window is full screen. @property(readwrite, retain) NSNumber *AXFullScreen; Return ValueAn NSNumber object encoding a BOOL value. DiscussionThe Use NSNumber's To make a window full screen, call The NSAccessibilityFullScreenAttribute constant is private Apple API. Use at your own risk. Availability: Introduced in Mac OS X v10.7. AXFullScreenButtonThe full screen button in the receiving window's title bar. @property(readonly) PFUIElement *AXFullScreenButton; Return ValueA PFUIElement object, or DiscussionThe Availability: Introduced in Mac OS X v10.7. AXGrowAreaThe grow area in the bottom-right corner of the receiving window. @property(readonly) PFUIElement *AXGrowArea; Return ValueA PFUIElement object, or DiscussionThe AXHandlesThe receiver's handle UI elements. @property(readonly) NSArray *AXHandles; Return ValueAn array of PFUIElement objects, or DiscussionAn element's Availability: Introduced in Mac OS X v10.6. AXHeaderThe receiving table or outline column's header element. @property(readonly) PFUIElement *AXHeader; Return ValueA PFUIElement object. DiscussionThe AXHelpA localized string providing helpful information regarding the receiver. @property(readonly) NSString *AXHelp; Return ValueAn NSString object, or DiscussionAn element's See also AXRole, AXSubrole, AXRoleDescription, and AXDescription. AXHiddenWhether the receiving application is hidden. @property(readwrite, retain) NSNumber *AXHidden; Return ValueAn NSNumber object encoding a BOOL value. DiscussionThe Use NSNumber's To hide an application or other hideable UI element, call AXHorizontalScrollBarThe receiving scroller's horizontal scroll bar element. @property(readonly) PFUIElement *AXHorizontalScrollBar; Return ValueA PFUIElement object. DiscussionThe See also AXVerticalScrollBar. AXHorizontalUnitDescriptionA localized string describing the receiver's horizontal units of measurement, suitable for display or speech. @property(readonly) NSString *AXHorizontalUnitDescription; Return ValueAn NSString object. DiscussionAn element's Availability: Introduced in Mac OS X v10.6. See also AXUnitDescription. AXHorizontalUnitsA technical, non-localized string representing the receiver's horizontal units of measurement. @property(readonly) NSString *AXHorizontalUnits; Return ValueAn NSString object. DiscussionThe The accessibility API also provides localizable, human-readable descriptions of the element, suitable for display or speech, in the AXHorizontalUnitDescription attribute. Availability: Introduced in Mac OS X v10.6. See also AXUnits. AXHourFieldThe hour field in the receiving clock control. @property(readonly) PFUIElement *AXHourField; Return ValueA PFUIElement object. DiscussionThe AXIdentifierA string identifying the receiver across application launches. @property(readonly) NSString *AXIdentifier; Return ValueAn NSString object, or DiscussionAn element's Availability: Introduced in Mac OS X v10.7. AXIncrementButtonThe receiving stepper's increment button. @property(readonly) PFUIElement *AXIncrementButton; Return ValueA PFUIElement object. See also AXDecrementButton. DiscussionThe AXIncrementorA stepper UI element. @property(readonly) PFUIElement *AXIncrementor; Return ValueA PFUIElement object. DiscussionThe AXIndexThe index of the receiver. @property(readonly) NSNumber *AXIndex; Return ValueAn NSNumber object encoding an integer value. DiscussionThe Use NSNumber's AXInsertionPointLineNumberThe line index of a naked insertion point in the receiving text object. @property(readonly) NSNumber *AXInsertionPointLineNumber; Return ValueAn NSNumber object encoding an integer value, or DiscussionUse the This attribute returns a line number only if no text is currently selected. It returns To determine the location of the insertion point as a character index, get the starting character index of the current selection range using AXSelectedTextRange. The To determine the line index of the insertion point when the length of the current selection is 0, two steps are required. This is because the character index is the same when there is no text selection and the insertion point is at the end of one wrapped line or the beginning of the next wrapped line (there is no return character separating wrapped lines). First, pass the character index of the current selection range to -AXLineForIndex:, as above, and note the result. Second, to distinguish between a naked insertion point that is located at the end of one wrapped line and one that is located at the beginning of the next wrapped line even though both have the same character index, use this property, Use NSNumber's AXIsApplicationRunningWhether the application represented by the receiving application dock item is running. @property(readonly) NSNumber *AXIsApplicationRunning; Return ValueAn NSNumber object encoding a BOOL value. DiscussionThe Use NSNumber's AXLabelUIElementsThe labels for a slider or similar control. @property(readonly) NSArray *AXLabelUIElements; Return ValueAn NSArray of PFUIElement objects. DiscussionThe AXLabelValueThe value of the receiving label. @property(readonly) NSNumber *AXLabelValue; Return ValueAn NSNumber object encoding an integer or other numeric value. DiscussionThe Use NSNumber's AXLinkedUIElementsThe UI elements that are linked to the receiver. @property(readonly) NSArray *AXLinkedUIElements; Return ValueAn array of PFUIelement objects. DiscussionAn element's AXMainWhether the receiver is the target application's main window. @property(readwrite, retain) NSNumber *AXMain; Return ValueAn NSNumber object encoding a BOOL value. DiscussionThe An application may have a single main window whether it is the active application or not. If the application is inactive, its main window is the window that would be its main window if it were active. The main window need not be the window having keyboard focus. To determine if it is the key window, use AXFocused. To get the application's main window element, use AXMainWindow. To get its key window, the window that has keyboard focus, use AXFocusedWindow. Use NSNumber's To set the receiver to be the target application's main window, call AXMainWindowThe receiving application's main window. @property(readonly) PFUIElement *AXMainWindow; Return ValueA PFUIElement object. DiscussionThe See AXMain for more information. AXMarkerGroupUIElementA group element containing the receiving text ruler's markers. @property(readonly) PFUIElement *AXMarkerGroupUIElement; Return ValueA PFUIElement object. DiscussionThe AXMarkerTypeA technical, non-localized string designating the receiving text ruler marker's type. @property(readonly) NSString *AXMarkerType; Return ValueAn NSString object. DiscussionThe The result can be compared to the string constants See also AXMarkerTypeDescription. AXMarkerTypeDescriptionA localized string describing the receiving text ruler marker, suitable for display or speech. @property(readonly) NSString *AXMarkerTypeDescription; Return ValueAn NSString object. DiscussionThe AXMarkerUIElementsThe receiving text ruler's marker elements. @property(readonly) NSArray *AXMarkerUIElements; Return ValueAn NSArray of PFUIElement objects. DiscussionThe AXMarkerValuesThe values of the receiving text ruler's marker elements. @property(readonly) NSArray *AXMarkerValues; Return ValueAn NSArray of NSString. DiscussionThe AXMatteContentUIElementThe object clipped by the receiving screen matte. @property(readonly) PFUIElement *AXMatteContentUIElement; Return ValueA PFUIElement object. DiscussionThe AXMatteHoleThe bounds of the receiving screen matte's hole in screen coordinates. @property(readonly) NSValue *AXMatteHole; Return ValueAn NSValue object encoding an NSRect structure. DiscussionThe Use NSValue's AXMaxValueThe largest legal value of the receiver. @property(readonly) id AXMaxValue; Return ValueAn object of any type (typically NSNumber), or DiscussionAn element's In conjunction with its See also AXValue and AXMinValue. AXMenuBarThe receiving application's menu bar element. @property(readonly) PFUIElement *AXMenuBar; Return ValueA PFUIElement object. DiscussionThe There are typically two menu bars visible on the screen at a time, the active application's menu bar and the systemUIServer application's menu bar. The latter is located in the top-right corner of the same screen that displays the active application's menu bar. Its children are all of the system's menu extras, such as the clock menu extra. (This does not include a variety of third-party buttons that may appear to the left of the SystemUIServer's menu bar.) AXMenuItemCmdCharThe receiving menu item's keyboard shortcut as a single-character string. @property(readonly) NSString *AXMenuItemCmdChar; Return ValueAn NSString object, an empty string if the receiving menu item does not have a keyboard shortcut that is represented by a character. DiscussionThe AXMenuItemCmdGlyphThe receiving menu item's keyboard shortcut as a glyph code. @property(readonly) NSNumber *AXMenuItemCmdGlyph; Return ValueAn NSNumber object encoding an integer value, or DiscussionThe Glyph codes returned by this method are described in the Carbon Menu Manager documentation and declared in Menus.h in the Carbon HIToolbox framework. They are numbers representing all of the control and function keys on the keyboard. For example, the glyph code for the left arrow key is Use NSNumber's AXMenuItemCmdModifiersThe modifier key combination required by the receiving menu item's keyboard shortcut. @property(readonly) NSNumber *AXMenuItemCmdModifiers; Return ValueAn NSNumber object encoding an integer value, or DiscussionThe The modifier key combination is the Modifier Key Mask described in the Carbon Menu Manager documentation and declared in Menus.h in the Carbon HIToolbox framework. It is a number representing a particular combination of modifier keys. The number is based on the combination of bits in a 4-bit bit field where bit 0 is the Shift key, Use NSNumber's AXMenuItemCmdVirtualKeyThe receiving menu item's keyboard shortcut as a virtual key code. @property(readonly) NSNumber *AXMenuItemCmdVirtualKey; Return ValueAn NSNumber object encoding an integer value, or DiscussionThe Virtual key codes returned by this method are the keycodes described in Inside Macintosh Volume V. They are the same keycodes returned by NSEvent's -keyCode method. They are hardware-independent numbers representing specific keys on the keyboard. They are generally used to represent keyboard shortcuts only when there is more than one key that returns the same character or glyph code. Use NSNumber's AXMenuItemMarkCharThe receiving menu item's mark character. @property(readonly) NSString *AXMenuItemMarkChar; Return ValueAn NSString object, or an empty string if the mark character is not currently set because the menu is closed or the receiving menu item does not have a mark character. DiscussionThe Many applications set a menu item's mark character only as the menu is being opened. For this reason, it may not be possible to obtain the mark character except by first opening the menu. The PFAssistive framework does not do this automatically, but a client can do it by sending -activateApplication and then sending -performAction: to perform an AXPress action on the menu to open it. AXMenuItemPrimaryUIElementThe receiving menu item's primary menu item element. @property(readonly) PFUIElement *AXMenuItemPrimaryUIElement; Return ValueA PFUIElement object, or DiscussionThe AXMinimizeButtonThe minimize button in the receiving window's title bar. @property(readonly) PFUIElement *AXMinimizeButton; Return ValueA PFUIElement object, or DiscussionThe AXMinimizedWhether the receiving window is minimized to the Dock. @property(readwrite, retain) NSNumber *AXMinimized; Return ValueAn NSNumber object encoding a BOOL value. DiscussionThe Use NSNumber's To minimize a window, call AXMinuteFieldThe minute field in the receiving clock control. @property(readonly) PFUIElement *AXMinuteField; Return ValueA PFUIElement object. DiscussionThe AXMinValueThe smallest legal value of the receiver. @property(readonly) id AXMinValue; Return ValueAn object of any type (typically NSNumber), or DiscussionAn element's In conjunction with its See also AXValue and AXMaxValue. AXModalWhether the receiver is a modal window. @property(readonly) NSNumber *AXModal; Return ValueAn NSNumber object encoding a BOOL value. DiscussionThe Use NSNumber's AXMonthFieldThe month field in the receiving clock control. @property(readonly) PFUIElement *AXMonthField; Return ValueA PFUIElement object. DiscussionThe AXNextContentsThe contents of the subview following the splitter bar in a split group or a similar divider. @property(readonly) id AXNextContents; Return ValueAn array of PFUIElement objects. DiscussionThe AXNumberOfCharactersThe number of characters in the receiver's text. @property(readonly) NSNumber *AXNumberOfCharacters; Return ValueAn NSNumber object encoding an integer value, or DiscussionThe Use NSNumber's AXOrderedByRowWhether the receiving grid element is ordered by rows. @property(readonly) NSNumber *AXOrderedByRow; Return ValueAn NSNumber object encoding a BOOL value. DiscussionThe Use NSNumber's AXOrientationA technical, non-localized string designating the receiver's orientation on the screen. @property(readonly) NSString *AXOrientation; Return ValueAn NSString object. DiscussionThe The result can be compared to the string constants AXOverflowButtonThe receiving toolbar's overflow button element. @property(readonly) PFUIElement *AXOverflowButton; Return ValueA PFUIElement object. DiscussionThe AXParentThe receiver's parent UI element. @property(readonly) PFUIElement *AXParent; Return ValueA PFUIElement or PFApplicationUIElement object, or DiscussionAn element's The This property returns See the AXChildren property for requirements regarding the relationship between a parent and its children. AXPlaceholderValueThe string that appears in a text field or similar element as its placeholder. @property(readonly) NSString *AXPlaceholderValue; Return ValueAn NSString object. DiscussionThe Availability: Introduced in Mac OS X v10.6. AXPositionThe receiver's position on the screen. @property(readwrite, retain) NSValue *AXPosition; Return ValueAn NSValue object encoding an NSPoint structure. DiscussionAn element's screen position in the accessibility API is its top-left corner in global top-left relative screen coordinates, where {0.0, 0.0} is the top-left corner of the screen displaying the menu bar and values increase in magnitude to the right and downwards. Use NSValue's To set the receiver's position, call AXPreviousContentsThe contents of the subview preceding the splitter bar in a split group or a similar divider. @property(readonly) id AXPreviousContents; Return ValueAn array of PFUIElement objects. DiscussionThe AXProxyThe proxy icon in the receiving window's title bar representing the window's document. @property(readonly) PFUIElement *AXProxy; Return ValueA PFUIElement object, or DiscussionThe AXRoleA technical, non-localized string representing the receiver's role. @property(readonly) NSString *AXRole; Return ValueAn NSString object. DiscussionThe The accessibility API also provides localizable, human-readable descriptions of the element, suitable for display or speech, in the AXRoleDescription attribute and in the more verbose AXDescription attribute indicating the exact function or purpose of a specific element. All elements have an See also AXHelp. AXRoleDescriptionA localized string describing the receiver's role or subrole, suitable for display or speech. @property(readonly) NSString *AXRoleDescription; Return ValueAn NSString object. DiscussionAn element's See also AXRole, AXSubrole, AXDescription, and AXHelp. AXRowCountThe number of rows in the receiving grid element. @property(readonly) NSNumber *AXRowCount; Return ValueAn NSNumber object encoding an integer value, or DiscussionThe Use NSNumber's See also AXColumnCount. AXRowHeaderUIElementsThe receiver's row header UI elements. @property(readonly) NSArray *AXRowHeaderUIElements; Return ValueAn array of PFUIElement objects, which may be DiscussionAn element's Availability: Introduced in Mac OS X v10.6. AXRowIndexRangeThe range of the receiver's row indexes. @property(readonly) NSValue *AXRowIndexRange; Return ValueAn NSValue object encoding an NSRange structure, or DiscussionThe Use NSValue's Availability: Introduced in Mac OS X v10.6. See also AXColumnIndexRange. AXRowsThe rows of the receiving table or outline. @property(readonly) NSArray *AXRows; Return ValueAn array of PFUIElement objects. DiscussionThe AXSearchButtonThe search button element in the receiving search field. @property(readonly) PFUIElement *AXSearchButton; Return ValueA PFUIElement object. DiscussionThe AXSearchMenuThe search pop-up menu element in the receiving search field. @property(readonly) PFUIElement *AXSearchMenu; Return ValueA PFUIElement object. DiscussionThe AXSecondFieldThe second field in the receiving clock control. @property(readonly) PFUIElement *AXSecondField; Return ValueA PFUIElement object. DiscussionThe AXSelectedWhether the receiver is selected. @property(readwrite, retain) NSNumber *AXSelected; Return ValueAn NSNumber object encoding a BOOL value. DiscussionThe Use NSNumber's To select the receiver, call AXSelectedCellsThe receiving cell-based table's selected cell UI elements. @property(readwrite, retain) NSArray *AXSelectedCells; Return ValueAn array of PFUIElement objects, which may be empty, or DiscussionAn element's To change the selection in the user interface, call Availability: Introduced in Mac OS X v10.6. AXSelectedChildrenThe receiver's selected children UI elements. @property(readwrite, retain) NSArray *AXSelectedChildren; Return ValueAn array of PFUIElement objects, which may be empty, or DiscussionAn element's To change the selection in the user interface, call AXSelectedColumnsThe selected columns of the receiving table or outline. @property(readwrite, retain) NSArray *AXSelectedColumns; Return ValueAn array of PFUIElement objects. DiscussionThe Prior to Mac OS X 10.6 Snow Leopard, this attribute incorrectly returned the selected column indexes. To change the selection in the user interface, call AXSelectedRowsThe selected rows of the receiving table or outline. @property(readwrite, retain) NSArray *AXSelectedRows; Return ValueAn array of PFUIElement objects. DiscussionThe To change the selection in the user interface, call AXSelectedTextThe receiver's selected text. @property(readwrite, retain) NSString *AXSelectedText; Return ValueAn NSString object, or DiscussionThe To set the receiver's selected text, call See also AXSelectedTextRange and AXSelectedTextRanges. AXSelectedTextRangeThe range of the receiver's text selection. @property(readwrite, retain) NSValue *AXSelectedTextRange; Return ValueAn NSValue object encoding an NSRange structure, or DiscussionThe Use NSValue's To set the receiver's selected text range, call See also AXSelectedText and AXSelectedTextRanges. AXSelectedTextRangesThe ranges of the receiver's noncontiguous multiple text selections. @property(readwrite, retain) NSArray *AXSelectedTextRanges; Return ValueAn NSArray object containing NSValue objects encoding noncontiguous NSRange structures, or DiscussionThe Use NSValue's To set the receiver's selected text ranges, call See also AXSelectedText and AXSelectedTextRange. AXServesAsTitleForUIElementsThe UI elements for which the receiver serves as title. @property(readonly) id AXServesAsTitleForUIElements; Return ValueAn array of PFUIelement objects. DiscussionThe This attribute is rarely available because to implement it application developers must provide it in code; it cannot be set in Interface Builder. Apple documentation indicates that it is used in AXMenuItem and AXMenuBarItem elements only. The AXSharedCharacterRangeThe range of characters in a larger text object that are contained in the receiving text view, which shares the text object with other text view elements. @property(readonly) NSValue *AXSharedCharacterRange; Return ValueAn NSValue object encoding an NSRange structure. DiscussionThe Use NSValue's AXSharedTextUIElementsAn array containing all of the text view elements that share a larger text object, a portion of which is contained in the receiving text view. @property(readonly) NSArray *AXSharedTextUIElements; Return ValueAn array of PFUIelement objects. DiscussionThe AXShownMenuUIElementThe menu element currently being displayed. @property(readonly) PFUIElement *AXShownMenuUIElement; Return ValueA PFUIElement object. DiscussionThe AXSizeThe receiver's size on the screen. @property(readwrite, retain) NSValue *AXSize; Return ValueAn NSValue object encoding an NSSize structure. DiscussionAn element's size on the screen is its horizontal and vertical dimensions. Use NSValue's To set the receiver's position, call AXSortDirectionA technical, non-localized string designating the receiving column's sort direction. @property(readwrite, retain) NSString *AXSortDirection; Return ValueAn NSString object. DiscussionThe The result can be compared to the string constants To set the sort direction, call AXSplittersThe splitter bar elements in the receiving split group. @property(readonly) NSArray *AXSplitters; Return ValueAn array of PFUIElement objects. DiscussionThe splitter bar elements are also children of the split group. AXSubroleA technical, non-localized string representing the receiver's subrole. @property(readonly) NSString *AXSubrole; Return ValueAn NSString object, or DiscussionSome elements have an When an element has a subrole, its AXRoleDescription attribute typically reflects the subrole rather than the role. See also AXRole, AXRoleDescription, AXDescription, and AXHelp. AXTabsThe receiving tab group's tab elements. @property(readonly) NSArray *AXTabs; Return ValueAn array of PFUIElement objects. DiscussionThe AXTextInputMarkedRangeThe marked range of a text input session from an input manager. @property(readonly) NSValue *AXTextInputMarkedRange; Return ValueAn NSValue object encoding an NSRange structure. DiscussionThe Use NSValue's The NSAccessibilityTextInputMarkedRangeAttribute constant is private Apple API. Use at your own risk. AXTitleA localized string that is the receiver's title. @property(readonly) NSString *AXTitle; Return ValueAn NSString object, or DiscussionMany elements have Elements are often associated with a separate UI element in the visual interface that serves as their title, such as a static text field. See AXTitleUIElement for more information. AXTitleUIElementA separate UI element that serves as the receiver's title. @property(readonly) PFUIElement *AXTitleUIElement; Return ValueA PFUIElement object. DiscussionAn element's The AXToolbarButtonThe toolbar button in the receiving window's title bar. @property(readonly) PFUIElement *AXToolbarButton; Return ValueA PFUIElement object, or DiscussionThe AXTopLevelUIElementThe top-level UI element containing the receiver. @property(readonly) PFUIElement *AXTopLevelUIElement; Return ValueA PFUIElement object. DiscussionThe The AXUnitDescriptionA localized string describing the receiving text ruler's units of measurement, suitable for display or speech. @property(readonly) NSString *AXUnitDescription; Return ValueAn NSString object. DiscussionThe See also AXUnits. AXUnitsA technical, non-localized string representing the receiving text ruler's units of measurement. @property(readonly) NSString *AXUnits; Return ValueAn NSString object. DiscussionThe The result can be compared to the string constants See also AXUnitDescription. AXURLThe receiver's associated file URL. @property(readonly) NSURL *AXURL; Return ValueAn NSURL object representing the file URL associated with the receiver, or DiscussionThe See also AXDocument and AXFilename>. AXValueThe receiver's value. @property(readwrite, retain) id AXValue; Return ValueAn object of any type, or DiscussionAn element typically has a value attribute if a user can modify it by interacting with it on the screen. In addition, many elements have values even though they are not modifiable by a user, such as a static text field. The value can be almost any type, but it is always the same type for any given element. For example, a text field's value is the text it contains, a scroll bar's value is a real number between 0.0 and 1.0 representing the position of its thumb, and a checkbox's value is an integer, either 1 or 0 depending on whether it is checked. To set the receiver's value, call See also AXValueDescription. AXValueDescriptionA localized string describing the receiver's value, suitable for display or speech. @property(readonly) id AXValueDescription; Return ValueAn NSString object, or DiscussionAn element's See also AXValue. AXValueIncrementThe magnitude of each increment of the receiver's value. @property(readonly) id AXValueIncrement; Return ValueAn object of any type (typically NSNumber). DiscussionThe AXValueWrapsWhether the receiver wraps; that is, if stepping in one direction eventually returns the receiver to its initial value. @property(readonly) NSNumber *AXValueWraps; Return ValueAn NSNumber object encoding a BOOL value. DiscussionThe AXValueWraps attribute applies to a stepper and similar elements, returning whether its value wraps around to its minimum value when the maximum value is exceeded, and vice versa. Use NSNumber's AXVerticalScrollBarThe receiving scroller's vertical scroll bar element. @property(readonly) PFUIElement *AXVerticalScrollBar; Return ValueA PFUIElement object. See also AXHorizontalScrollBar. DiscussionThe AXVerticalUnitDescriptionA localized string describing the receiver's vertical units of measurement, suitable for display or speech. @property(readonly) NSString *AXVerticalUnitDescription; Return ValueAn NSString object. DiscussionAn element's Availability: Introduced in Mac OS X v10.6. See also AXUnitDescription. AXVerticalUnitsA technical, non-localized string representing the receiver's vertical units of measurement. @property(readonly) NSString *AXVerticalUnits; Return ValueAn NSString object. DiscussionThe The accessibility API also provides localizable, human-readable descriptions of the element, suitable for display or speech, in the AXVerticalUnitDescription attribute. Availability: Introduced in Mac OS X v10.6. See also AXUnits. AXVisibleCellsThe receiving cell-based table's visible cell UI elements. @property(readwrite, retain) NSArray *AXVisibleCells; Return ValueAn array of PFUIElement objects, which may be empty, or DiscussionAn element's Availability: Introduced in Mac OS X v10.6. AXVisibleCharacterRangeThe range of the receiver's visible text. @property(readwrite, retain) NSValue *AXVisibleCharacterRange; Return ValueAn NSValue object encoding an NSRange structure, or DiscussionThe Use NSValue's To set the receiver's visible character range, call AXVisibleChildrenThe receiver's visible children UI elements. @property(readonly) NSArray *AXVisibleChildren; Return ValueAn array of PFUIElement objects, or DiscussionAn element's AXVisibleColumnsThe visible columns of the receiving table or outline. @property(readonly) NSArray *AXVisibleColumns; Return ValueAn array of PFUIElement objects. DiscussionThe AXVisibleRowsThe visible rows of the receiving table or outline. @property(readonly) NSArray *AXVisibleRows; Return ValueAn array of PFUIElement objects. DiscussionThe AXWarningValueThe receiving level indicator's warning value. @property(readonly) id AXWarningValue; Return ValueAn object of any value, typically an NSNumber. DiscussionThe Availability: Introduced in Mac OS X v10.6. AXWindowThe window UI element containing the receiver. @property(readonly) PFUIElement *AXWindow; Return ValueA PFUIElement object. DiscussionThe The Returns the window from which a sheet or drawer opens if the receiver is a sheet or a drawer, not the window containing the views in the sheet or drawer. AXWindowsThe receiving application's open window elements. @property(readonly) NSArray *AXWindows; Return ValueAn array of PFUIElement objects. DiscussionThe AXYearFieldThe year field in the receiving clock control. @property(readonly) PFUIElement *AXYearField; Return ValueA PFUIElement object. DiscussionThe AXZoomButtonThe zoom button in the receiving window's title bar. @property(readonly) PFUIElement *AXZoomButton; Return ValueA PFUIElement object, or DiscussionThe |