Skip to content

get_tshapeGetTshapeGetTshapeget_tshapeT_get_tshape🔗

Short description🔗

get_tshapeGetTshapeGetTshapeget_tshapeT_get_tshape — Get the shape of the text cursor.

Warning🔗

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

Signature🔗

get_tshape( window WindowHandle, out string TextCursor )void GetTshape( const HTuple& WindowHandle, HTuple* TextCursor )static void HOperatorSet.GetTshape( HTuple windowHandle, out HTuple textCursor )def get_tshape( window_handle: HHandle ) -> str

Herror T_get_tshape( const Htuple WindowHandle, Htuple* TextCursor )

HString HWindow::GetTshape( ) const

string HWindow.GetTshape( )

Description🔗

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

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

Execution information🔗

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🔗

WindowHandlewindowHandlewindow_handle (input_control) window → (handle)HTuple (HHandle)HWindow, HTuple (IntPtr)HHandleHtuple (handle)

Window handle.

TextCursortextCursortext_cursor (output_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Name of the current text cursor.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

open_windowOpenWindow, set_fontSetFont

Possible successors

set_tshapeSetTshape, set_tpositionSetTposition, write_stringWriteString, read_stringReadString, read_charReadChar

See also

set_tshapeSetTshape, query_tshapeQueryTshape, write_stringWriteString, read_stringReadString

Module🔗

Foundation