Carbon


ATSUTextDeleted

Header: ATSUnicode.h Carbon status: Supported

Indicates the location in physical memory of deleted text.

OSStatus ATSUTextDeleted (
    ATSUTextLayout iTextLayout, 
    UniCharArrayOffset iDeletedRangeStart, 
    UniCharCount iDeletedRangeLength
);
Parameter descriptions
iTextLayout

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

iDeletedRangeStart

The edge offset corresponding to the beginning of the range of deleted text. You may pass a value outside the range of text being operated on if the deletion occurs outside the range. To specify the beginning of the text buffer, pass the constant kATSUFromTextBeginning, described in “Text Offset and Length Constants”. To indicate the entire text buffer, pass kATSUFromTextBeginning in this parameter and the constant kATSUToTextEnd in the iDeletedRangeLength parameter. If the specified range of text is outside the text buffer, ATSUTextDeleted returns the result code kATSUInvalidTextRangeErr.

iDeletedRangeLength

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 iDeletedRangeStart parameter. f the specified range of text is outside the text buffer, ATSUTextDeleted returns the result code kATSUInvalidTextRangeErr.

function result

A result code.

DISCUSSION

The ATSUTextDeleted function shortens or removes the style run containing the deletion point and the total length of the text range by the amount of the text deletion. If the deletion point is between two style runs, the first style run is removed. It also removes any soft line breaks that fall within the deleted text. ATSUTextDeleted then updates drawing caches.

ATSUTextDeleted does not change the memory location or the edge offset of the text. It shifts the text after the deleted text by the appropriate offset (iDeletedRangeStart +iDeletedRangeLength).

You are responsible for making sure that the corresponding text is deleted from the text buffer. You are also responsible for disposing of the memory associated with style runs that have been removed by calling the function ATSUDisposeStyle.

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)