Brief Index      Full Index      I.M. Reference

Move_String_Cursor


Functions

void Move_String_Cursor (HC_KEY key, int row, int column)

Function Documentation

void Move_String_Cursor ( HC_KEY  key,
int  row,
int  column 
)

Changes the position of a previously created String Cursor.

Parameters:
key - Identifier returned by a previous call to KInsert_String_Cursor() .
row - The row offset to which the cursor should be. This should always be specified as zero.
column - The column offset to which the cursor should be moved. The first column is at offset zero.

DETAILS

String cursors are often used during terminal emulation, or when prompting the user and waiting for a keyboard reply. They indicate where the "active" character or position is, according to the running program.

String cursors are commonly used during "string" events, and the system will move them automatically. You will not usually need to move string cursors yourself.

NOTES

A string cursor will (also) be moved by a Scroll, but is unmoved and unaffected by any Edit.

If the row/column position specified is not within the bounds of the text an error is generated.

RESTRICTIONS

See also:
KInsert_String_Cursor, Insert_Text, KInsert_Text_With_Encoding, Scroll_Text.

Main Index
Brief Index      Full Index      I.M. Functions