Carbon


ATSUTextInserted

Header: ATSUnicode.h Carbon status: Supported

Indicates the location in physical memory of inserted text.

OSStatus ATSUTextInserted (
    ATSUTextLayout iTextLayout, 
    UniCharArrayOffset iInsertionLocation, 
    UniCharCount iInsertionLength
);
Parameter descriptions
iTextLayout

A reference to an initialized text layout object in which text has been inserted. You cannot pass NULL for this parameter.

iInsertionLocation

The edge offset corresponding to the beginning of the inserted text. You may pass a value outside the range of text being operated on if the insertion occurs outside the range. To specify the beginning of the text buffer, pass the constant kATSUFromTextBeginning, described in “Text Offset and Length Constants”. If the specified range of text is outside the text buffer, ATSUTextInserted returns the result code kATSUInvalidTextRangeErr.

iInsertionLength

The length of the range of deleted text. If you want the length to extend to the end of the text buffer, pass the constant kATSUToTextEnd, described in “Text Offset and Length Constants”. To indicate the entire text buffer, pass kATSUToTextEnd in this parameter and the constant kATSUFromTextBeginning in the iInsertionLocation parameter. If the specified range of text is outside the text buffer, ATSUTextInserted returns the result code kATSUInvalidTextRangeErr.

function result

A result code.

DISCUSSION

The ATSUTextInserted function extends the style run containing the insertion point and the total length of the text range by the amount of the text insertion. If the insertion point is between two style runs, the first style run is extended to include the new text. ATSUTextInserted then updates drawing caches.

ATSUTextInserted does not insert style runs or line breaks; if you wish to do so, call the functions ATSUSetRunStyle and ATSUSetSoftLineBreak, respectively.

ATSUTextInserted does not change the memory location or the edge offset of the text. It shifts the text after the inserted text by the appropriate offset (iInsertionLocation +iInsertionLength).

You are responsible for making sure that the corresponding text is inserted into the text buffer.

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)