get_tposition ( : : WindowHandle : Row, Column )

Get cursor position.

get_tposition queries the current position of the text cursor in the output window. The position is measured in the coordinate system of the window (in pixels for text windows). 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_string, read_string) or by an explicit change of position by (set_tposition, new_line).


Attention

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


Parameters

WindowHandle (input_control)
window -> integer
Window identifier.

Row (output_control)
point.y -> integer
Row index of text cursor position.

Column (output_control)
point.x -> integer
Column index of text cursor position.


Result

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


Parallelization Information

get_tposition is reentrant, local, and processed without parallelization.


Possible Predecessors

open_window, open_textwindow, set_font


Possible Successors

set_tposition, write_string, read_string, read_char


See also

new_line, read_string, set_tposition, write_string, set_check


Module

Foundation



Copyright © 1996-2008 MVTec Software GmbH