set_tshapeset_tshapeset_tshapeSetTshapeSetTshape (Operator)

Name

set_tshapeset_tshapeset_tshapeSetTshapeSetTshape — Set the shape of the text cursor.

Signature

Description

set_tshapeset_tshapeset_tshapeSetTshapeSetTshape 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_tshapequery_tshapequery_tshapeQueryTshapeQueryTshape.

Parallelization

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: local (may only be called from the same thread in which the window, model, or tool instance was created).
• Processed without parallelization.

Parameters

Result

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

Possible Predecessors

open_windowopen_windowopen_windowOpenWindowOpenWindow, open_textwindowopen_textwindowopen_textwindowOpenTextwindowOpenTextwindow, query_tshapequery_tshapequery_tshapeQueryTshapeQueryTshape, get_tshapeget_tshapeget_tshapeGetTshapeGetTshape

Possible Successors

write_stringwrite_stringwrite_stringWriteStringWriteString, read_stringread_stringread_stringReadStringReadString

See also

get_tshapeget_tshapeget_tshapeGetTshapeGetTshape, query_tshapequery_tshapequery_tshapeQueryTshapeQueryTshape, write_stringwrite_stringwrite_stringWriteStringWriteString, read_stringread_stringread_stringReadStringReadString

Module

Foundation