get_tshapeT_get_tshapeGetTshapeGetTshapeget_tshape (Operator)

Name

get_tshapeT_get_tshapeGetTshapeGetTshapeget_tshape — Get the shape of the text cursor.

Warning

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

Signature

get_tshape( : : WindowHandle : TextCursor)

Description

get_tshapeget_tshapeGetTshapeGetTshapeget_tshape queries the shape of the text cursor for the output window. A new cursor shape is set by the operator set_tshapeset_tshapeSetTshapeSetTshapeset_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_tshapequery_tshapeQueryTshapeQueryTshapequery_tshape.

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

WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control) window → (handle)

Window handle.

TextCursorTextCursorTextCursortextCursortext_cursor (output_control) string → (string)

Name of the current text cursor.

Result

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

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowopen_window, set_fontset_fontSetFontSetFontset_font

Possible Successors

set_tshapeset_tshapeSetTshapeSetTshapeset_tshape, set_tpositionset_tpositionSetTpositionSetTpositionset_tposition, write_stringwrite_stringWriteStringWriteStringwrite_string, read_stringread_stringReadStringReadStringread_string, read_charread_charReadCharReadCharread_char

Module

Foundation

Operators