Herror ::set_tposition (
    const HTuple &WindowHandle,
    const HTuple &Row,
    const HTuple &Column
)
void HWindow::SetTposition (
    const HTuple &Row,
    const HTuple &Column
) const

Set the position of the text cursor.

::set_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 coordinate system of the window and has to be valid for the window size and font. 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_string, ::read_string) or by an explicit change of position by (::set_tposition, ::new_line). In order to stop the display of the cursor, the operator ::set_tshape with the parameter "invisible" can be used.


Attention

If a string starting at the given position does not fit into the window an exception handling will be raised. This exception handling can be avoided by set_check('~text').


Parameters

WindowHandle (input_control)
window -> HTuple.long
Window identifier.

Row (input_control)
point.y -> HTuple.long
Row index of text cursor position.
Default value: 24

Column (input_control)
point.x -> HTuple.long
Column index of text cursor position.
Default value: 12


Result

::set_tposition returns H_MSG_TRUE if the window is valid and the values of the parameters are valid. Otherwise an exception handling is raised.


Possible Predecessors

::open_window, ::open_textwindow


Possible Successors

::set_tshape, ::write_string, ::read_string


Alternatives

::new_line


See also

::read_string, ::set_tshape, ::write_string


Module

System



Copyright © 1996-2002 MVTec Software GmbH