set_tpositionT_set_tpositionSetTpositionSetTpositionset_tposition (Operator)

Name

set_tpositionT_set_tpositionSetTpositionSetTpositionset_tposition — Set the position of the text cursor.

Signature

set_tposition( : : WindowHandle, Row, Column : )

Description

set_tpositionset_tpositionSetTpositionSetTpositionset_tposition sets the position of the text cursor in the output window. The reference position is the upper left corner of an upper case character.

The position is measured in the image coordinate system. The position of the text cursor can be marked, e.g., by an underscore. The next text output in this window starts at the cursor position. The left end of the baseline for writing the following text string (not considering descenders) is placed on this position.

The position is changed by the output or input of text (write_stringwrite_stringWriteStringWriteStringwrite_string, read_stringread_stringReadStringReadStringread_string) or by an explicit change of position by (set_tpositionset_tpositionSetTpositionSetTpositionset_tposition, new_linenew_lineNewLineNewLinenew_line). In order to stop the display of the cursor, the operator set_tshapeset_tshapeSetTshapeSetTshapeset_tshape with the parameter ”invisible” can be used.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control) window → (handle)

Window handle.

RowRowRowrowrow (input_control) point.y → (integer)

Row index of text cursor position.

Default: 24

ColumnColumnColumncolumncolumn (input_control) point.x → (integer)

Column index of text cursor position.

Default: 12

Result

set_tpositionset_tpositionSetTpositionSetTpositionset_tposition returns 2 ( H_MSG_TRUE) if the window is valid. Otherwise an exception is raised.