set_tshape ( : : WindowHandle, TextCursor : )

Set the shape of the text cursor.

set_tshape sets the shape and the display mode of the text cursor of the output window.

A text cursor marks the current position for text output. 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 (input_control)
string -> string
Name of cursor shape.
Default value: 'invisible'


Result

get_tshape returns 2 (H_MSG_TRUE) if the window is valid and the given cursor shape is defined for this window. Otherwise an exception handling is raised.


Parallelization Information

set_tshape is reentrant, local, and processed without parallelization.


Possible Predecessors

open_window, open_textwindow, query_tshape, get_tshape


Possible Successors

write_string, read_string


See also

get_tshape, query_tshape, write_string, read_string


Module

System



Copyright © 1996-2005 MVTec Software GmbH