Brief Index      Full Index      I.M. Reference

KInsert_String_Cursor


Functions

HC_KEY KInsert_String_Cursor (HC_KEY text_key, int row, int column)

Function Documentation

HC_KEY KInsert_String_Cursor ( HC_KEY  text_key,
int  row,
int  column 
)

Places a cursor into a text string.

Parameters:
text_key - Identifier returned by a previous call to KInsert_Text() or KInsert_Text_With_Encoding().
row  - The row number in which the cursor should be initially stationed. For now, this should always be specified as zero.
column  - The column offset at which the cursor should be initially stationed. The first columnis at offset zero.
Returns:
cursor_key

DETAILS

A cursor suitable for marking a position in a text string is generated on the screen. The cursor_key should be saved and may be used later in calls to Move_String_Cursor() or Enable_String_Events() .

A string cursor will be moved by a scroll, but is normally unmoved and unaffected by any Edit. String cursors are commonly used to echo user string input automatically.

NOTES

The cursor is firmly attached to the original text; if the text primitive is deleted, the cursor will be also.

Only the key-returning form of the "Insert" is provided since cursors are not very useful without a means of changing them.

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

RESTRICTIONS

See also:
Enable_String_Events, Move_String_Cursor, Show_String_Cursor, Insert_Text, KInsert_Text_With_Encoding, Scroll_Text()

Main Index
Brief Index      Full Index      I.M. Functions