get_tpositionget_tpositionGetTpositionGetTposition (Operator)

Name

get_tpositionget_tpositionGetTpositionGetTposition — Get cursor position.

Signature

get_tposition( : : WindowHandle : Row, Column)

Description

get_tpositionget_tpositionGetTpositionGetTpositionGetTposition queries the current position of the text cursor in the output window. The position is measured in the image coordinate system. The next output of text in this window starts at the cursor position. The left end of the baseline for writing the next string (not considering descenders) is placed on this position. The position is changed by the output or input of text (write_stringwrite_stringWriteStringWriteStringWriteString, read_stringread_stringReadStringReadStringReadString) or by an explicit change of position by (set_tpositionset_tpositionSetTpositionSetTpositionSetTposition, new_linenew_lineNewLineNewLineNewLine).

Attention

If the output text does not fit completely into the window, an exception is raised. This can be avoided by set_check('~text')set_check("~text")SetCheck("~text")SetCheck("~text")SetCheck("~text").

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

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control) window → (integer)

Window handle.

RowRowRowRowrow (output_control) point.y → (integer)

Row index of text cursor position.

ColumnColumnColumnColumncolumn (output_control) point.x → (integer)

Column index of text cursor position.

Result

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

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindow, set_fontset_fontSetFontSetFontSetFont

Possible Successors

set_tpositionset_tpositionSetTpositionSetTpositionSetTposition, write_stringwrite_stringWriteStringWriteStringWriteString, read_stringread_stringReadStringReadStringReadString, read_charread_charReadCharReadCharReadChar

See also

new_linenew_lineNewLineNewLineNewLine, read_stringread_stringReadStringReadStringReadString, set_tpositionset_tpositionSetTpositionSetTpositionSetTposition, write_stringwrite_stringWriteStringWriteStringWriteString, set_checkset_checkSetCheckSetCheckSetCheck

Module

Foundation