get_tshapeT_get_tshapeGetTshapeGetTshape (Operator)

Name

get_tshapeT_get_tshapeGetTshapeGetTshape — Get the shape of the text cursor.

Warning

get_tshapeget_tshapeGetTshapeGetTshapeGetTshape is obsolete and is only provided for reasons of backward compatibility.

Signature

get_tshape( : : WindowHandle : TextCursor)

Description

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

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_tshapeQueryTshapeQueryTshapeQueryTshape.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control) window → (handle)

Window handle.

TextCursorTextCursorTextCursorTextCursortextCursor (output_control) string → (string)

Name of the current text cursor.

Result

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

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindow, set_fontset_fontSetFontSetFontSetFont

Possible Successors

set_tshapeset_tshapeSetTshapeSetTshapeSetTshape, set_tpositionset_tpositionSetTpositionSetTpositionSetTposition, write_stringwrite_stringWriteStringWriteStringWriteString, read_stringread_stringReadStringReadStringReadString, read_charread_charReadCharReadCharReadChar

Module

Foundation

Operators