AXTextAttributedString.h

Overview

This header file contains definitions of constants used with accessibility objects that represent attributed strings. An attributed string is an association of a range of characters and their attributes, such as color and font. If an accessibility object represents an attributed string, the value of its kAXParameterizedAttributeStringAttribute attribute is an attributed string object (a CFAttributedStringRef or an NSAttributedString) that uses the constants defined in this header file to define its attributes.

Groups

Font

text attribute keys

Group members:

kAXFontFamilyKey

Optional key of the kAXFontTextAttribute dictionary for the font family name in a CFStringRef.

kAXFontNameKey

Required key of the kAXFontTextAttribute dictionary for the font name in a CFStringRef.

kAXFontSizeKey

Required key of the kAXFontTextAttribute dictionary for the font size in a CFNumberRef.

kAXUnderlineStyleNone

Values that describe the style of underlining (used with the kAXUnderlineTextAttribute attribute).

kAXVisibleNameKey

Optional key of the kAXFontTextAttribute dictionary for the font display name in a CFStringRef.

Constants

An AXUIElementRef value for the accessibility object representing the text attachment.

extern CFStringRef kAXAttachmentTextAttribute;  

Availability

Available in Mac OS X v10.4 and later.

A CGColorRef value that describes the background color.

extern CFStringRef kAXBackgroundColorTextAttribute;  

Availability

Available in Mac OS X v10.4 and later.

Optional key of the kAXFontTextAttribute dictionary for the font family name in a CFStringRef.

extern CFStringRef kAXFontFamilyKey;  

Availability

Available in Mac OS X v10.4 and later.

Required key of the kAXFontTextAttribute dictionary for the font name in a CFStringRef.

extern CFStringRef kAXFontNameKey;  

Availability

Available in Mac OS X v10.4 and later.

Required key of the kAXFontTextAttribute dictionary for the font size in a CFNumberRef.

extern CFStringRef kAXFontSizeKey;  

Availability

Available in Mac OS X v10.4 and later.

A dictionary (a CFDictionaryRef) of two or more font keys.

extern CFStringRef kAXFontTextAttribute;  

Discussion

The dictionary associated with this attribute must contain the kAXFontNameKey and kAXFontSizeKey font keys. It may also contain the kAXFontFamilyKey and kAXVisibleNameKey font keys.

Availability

Available in Mac OS X v10.4 and later.

A CGColorRef value that describes the foreground color.

extern CFStringRef kAXForegroundColorTextAttribute;  

Availability

Available in Mac OS X v10.4 and later.

An AXUIElementRef value used to access the object to which the specified range of text links.

extern CFStringRef kAXLinkTextAttribute;  

Availability

Available in Mac OS X v10.4 and later.

A CFBooleanRef value that indicates whether the text is misspelled.

extern CFStringRef kAXMisspelledTextAttribute;  

Availability

Available in Mac OS X v10.4 and later.

A CFStringRef value that indicates the language in which the text will be spoken aloud by the system.

extern CFStringRef kAXNaturalLanguageTextAttribute;  

Availability

Available in Mac OS X v10.4 and later.

A CFStringRef value that indicates the string that will replace the text.

extern CFStringRef kAXReplacementStringTextAttribute;  

Availability

Available in Mac OS X v10.4 and later.

A CFBooleanRef value that indicates whether the text displays shadow.

extern CFStringRef kAXShadowTextAttribute;  

Availability

Available in Mac OS X v10.4 and later.

A CGColorRef value that describes the color of the strikethrough.

extern CFStringRef kAXStrikethroughColorTextAttribute;  

Availability

Available in Mac OS X v10.4 and later.

A CFBooleanRef value that indicates whether the text displays strikethrough.

extern CFStringRef kAXStrikethroughTextAttribute;  

Availability

Available in Mac OS X v10.4 and later.

A CFNumberRef value that indicates whether the text is superscript (value > 0) or subscript (value < 0).

extern CFStringRef kAXSuperscriptTextAttribute;  

Availability

Available in Mac OS X v10.4 and later.

A CGColorRef value that describes the color of the underlining.

extern CFStringRef kAXUnderlineColorTextAttribute;  

Availability

Available in Mac OS X v10.4 and later.

A CFNumberRef value that describes the underline style (see AXUnderlineStyle for possible values).

extern CFStringRef kAXUnderlineTextAttribute;  

Availability

Available in Mac OS X v10.4 and later.

Optional key of the kAXFontTextAttribute dictionary for the font display name in a CFStringRef.

extern CFStringRef kAXVisibleNameKey;  

Availability

Available in Mac OS X v10.4 and later.

Enumerations

Values that describe the style of underlining (used with the kAXUnderlineTextAttribute attribute).

enum { 
    kAXUnderlineStyleNone = 0x0, 
    kAXUnderlineStyleSingle = 0x1, 
    kAXUnderlineStyleThick = 0x2, 
    kAXUnderlineStyleDouble = 0x9 
};  

Availability

Available in Mac OS X v10.4 and later.

Did this document help you? Yes: Tell us what works for you. It’s good, but: Report typos, inaccuracies, and so forth. It wasn’t helpful: Tell us what would have helped.