Carbon


TEScroll

Header: TextEdit.h Carbon status: Not Recommended

Scrolls the text within the view rectangle of the specified edit structure by the designated number of pixels.

void TEScroll (
    SInt16 dh, 
    SInt16 dv, 
    TEHandle hTE
);
Parameter descriptions
dh

The distance in pixels that the text is to be scrolled horizontally. A positive value moves the text to the right; a negative value moves the text to the left.

dv

The distance in pixels that the text is to be scrolled vertically. A positive value moves the text down; a negative value moves the text up.

hTE

A handle to the edit structure whose text is to be scrolled.

DISCUSSION

The TEScroll function updates the text on the screen automatically to reflect the new scroll position. The destination rectangle is offset by the amount scrolled. The TEScroll and TEPinScroll functions behave the same, except that TEPinScroll stops scrolling when the last line of text is scrolled into view.

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)