get_tshapeget_tshapeget_tshapeGetTshapeGetTshape (Operator)

Name

get_tshapeget_tshapeget_tshapeGetTshapeGetTshape — Get the shape of the text cursor.

Signature

Description

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

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_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. Otherwise an exception is raised.

Possible Predecessors

open_windowopen_windowopen_windowOpenWindowOpenWindow, open_textwindowopen_textwindowopen_textwindowOpenTextwindowOpenTextwindow, set_fontset_fontset_fontSetFontSetFont

Possible Successors

set_tshapeset_tshapeset_tshapeSetTshapeSetTshape, set_tpositionset_tpositionset_tpositionSetTpositionSetTposition, write_stringwrite_stringwrite_stringWriteStringWriteString, read_stringread_stringread_stringReadStringReadString, read_charread_charread_charReadCharReadChar

See also

set_tshapeset_tshapeset_tshapeSetTshapeSetTshape, query_tshapequery_tshapequery_tshapeQueryTshapeQueryTshape, write_stringwrite_stringwrite_stringWriteStringWriteString, read_stringread_stringread_stringReadStringReadString

Module

Foundation