Carbon


TXNSetTXNObjectControls

Header: MacTextEditor.h Carbon status: Supported

Sets formatting and privileges attributes (such as justification, line direction, tab values, and read-only status) that apply to the entire text object.

OSStatus TXNSetTXNObjectControls (
    TXNObject iTXNObject, 
    Boolean iClearAll, 
    ItemCount iControlCount, 
    TXNControlTag iControlTags[], 
    TXNControlData iControlData[]
);
Parameter descriptions
iTXNObject

A variable of type TXNObject. Pass the text object that identifies the document for which you want to set formatting and privileges attributes.

iClearAll

A Boolean value. If you set this to true all formatting and privileges attributes are reset to their default value.

iControlCount

A variable of type ItemCount. You use this to specify the number of items in the iControlTags array.

iControlTags

An array of values of type TXNControlTag. You fill the array with “Formatting and Privileges Constants” values that specify the kind of information you want set.

iControlData

An array of TXNControlData unions that specify the type of information being set.

function result

A result code.

DISCUSSION

On systems that use Apple Type Services for Unicode Imaging (ATSUI), the ATSUI line control attribute tags can be passed to this function in the iControlTag parameter. This is the case for all the ATSUI tags except kATSULineRotationTag. ATSUI tags are applied to the entire text object.

AVAILABILITY

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


© 2000 Apple Computer, Inc. (Last Updated 7/17/2000)