Carbon


ATSUGetRunStyle

Header: ATSUnicode.h Carbon status: Supported

Finds the previously set style run information for a given text location and the range of text that shares this information.

OSStatus ATSUGetRunStyle (
    ATSUTextLayout iTextLayout, 
    UniCharArrayOffset iOffset, 
    ATSUStyle *oStyle, 
    UniCharArrayOffset *oRunStart, 
    UniCharCount *oRunLength
);
Parameter descriptions
iTextLayout

A reference to an initialized text layout object whose style run information you wish to determine. You cannot pass NULL for this parameter.

iOffset

The edge offset in backing store memory that corresponds to the beginning of the text whose style run information you want to determine. To specify the beginning of the text buffer, pass the constant kATSUFromTextBeginning, described in “Text Offset Constant”. If the specified range of text is outside the text buffer, ATSUGetRunStyle returns the result code kATSUInvalidTextRangeErr.

oStyle

On return, a pointer to the style run information that is shared by the range of text specified by the oRunStart and oRunLength parameters. If you pass a text location in the iOffset parameter that is at a style run boundary, ATSUGetRunStyle passes back the style run information of the next style run in the oStyle parameter.

oRunStart

On return, a pointer to the edge offset in backing store memory that corresponds to the beginning of the style run that shares the same style run information as the text location specified in the iOffset parameter. Note that the style run does not necessarily share the same unset attribute values as iOffset.

oRunLength

On return, a pointer to the length of the text sharing the same style run attributes, font features, and font variations as the text location specified in the iOffset parameter. Note that the style run does not necessarily share the same unset attribute values as iOffset.

function result

A result code.

DISCUSSION

The ATSUGetRunStyle function finds those previously set style run attribute, font feature, and font variation values that are continuous for a given text location. It passes back the range of text that shares this information. If you want to determine all shared style run information, including unset attributes, font features, and font variatoins, call the function ATSUGetContinuousAttributes instead.

If only one style run is set in the text layout object, and it does not cover the entire text layout object, ATSUGetRunStyle uses the style run information for the iOffset parameter to set the style run information for the remaining text.

VERSION NOTES

Available beginning with ATSUI 1.0.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.5 or later.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)