Brief Index      Full Index      I.M. Reference

Scroll_Text


Functions

void Scroll_Text (HC_KEY key, int left_scroll, int up_scroll)

Function Documentation

void Scroll_Text ( HC_KEY  key,
int  left_scroll,
int  up_scroll 
)

To shift text around as you would on a scrolling alphanumeric terminal screen.

Parameters:
key - The identifier returned by a previous KInsert_Text() or KInsert_Text_With_Encoding() .
left_scroll - The amount the string or the block should be shifted to the left. Can also be negative, to give a right shift.
up_scroll - For future compatibility, specify as zero.

DETAILS

Columns and rows are shifted the specified distance within the original text string. Characters that are shifted "off the edge" of the original are discarded---when (if) you scroll back again, you will need to manually reinsert them. Characters that are shifted "onto the edge" start out filled with blanks.

NOTES

String Cursors, if any, scroll with their characters.

RESTRICTIONS

See also:
Insert_Text, Insert_Text_With_Encoding, Edit_Text, Move_String_Cursor, Set_Text_Font, Set_Text_Spacing.

Main Index
Brief Index      Full Index      I.M. Functions