Carbon


TETextBox

Header: TextEdit.h Carbon status: Not Recommended

Draws the indicated text in a given rectangle, with the specified alignment.

void TETextBox (
    const void *text, 
    SInt32 length, 
    const Rect *box, 
    SInt16 just
);
Parameter descriptions
text

A pointer to the text to be drawn.

length

The number of bytes comprising the text.

box

A pointer to the rectangle where the text is to be drawn. The rectangle is specified in local coordinates (of the current graphics port) and must be at least as wide as the first character drawn. (A good rule of thumb is to make the rectangle at least 20 pixels wide.)

just

The kind of justification (alignment) used for the specified text.

DISCUSSION

The TETextBox function provides you with an easy way to display static text to a user. It creates its own monostyled edit structure, which it deletes when finished with it, so you cannot edit the text it draws. The TETextBox function breaks a line of text correctly. You can specify how text is aligned in the box using any of the “Text Alignment Constants”.

AVAILABILITY

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


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