get_tshape ( : : WindowHandle : TextCursor )

Get the shape of the text cursor.

get_tshape queries the shape of the text cursor for the output window. A new cursor shape is set by the operator set_tshape.

A text cursor marks the current position for text output (which can also be invisible). It is different from the mouse cursor (although both will be called "cursor" if the context makes misconceptions impossible). The available shapes for the text cursor can be queried with query_tshape.


Parameters

WindowHandle (input_control)
window -> integer
Window identifier.

TextCursor (output_control)
string -> string
Name of the current text cursor.


Result

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


Parallelization Information

get_tshape is reentrant, local, and processed without parallelization.


Possible Predecessors

open_window, open_textwindow, set_font


Possible Successors

set_tshape, set_tposition, write_string, read_string, read_char


See also

set_tshape, query_tshape, write_string, read_string


Module

System



Copyright © 1996-2005 MVTec Software GmbH