Skip to content

set_tshapeSetTshapeSetTshapeset_tshapeT_set_tshape🔗

Short description🔗

set_tshapeSetTshapeSetTshapeset_tshapeT_set_tshape — Set the shape of the text cursor.

Warning🔗

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

Signature🔗

set_tshape( window WindowHandle, string TextCursor )void SetTshape( const HTuple& WindowHandle, const HTuple& TextCursor )static void HOperatorSet.SetTshape( HTuple windowHandle, HTuple textCursor )def set_tshape( window_handle: HHandle, text_cursor: str ) -> None

Herror T_set_tshape( const Htuple WindowHandle, const Htuple TextCursor )

void HWindow::SetTshape( const HString& TextCursor ) const

void HWindow::SetTshape( const char* TextCursor ) const

void HWindow::SetTshape( const wchar_t* TextCursor ) const (Windows only)

void HWindow.SetTshape( string textCursor )

Description🔗

set_tshapeSetTshape 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_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 (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Name of cursor shape.

Default: 'invisible'"invisible"

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

open_windowOpenWindow, query_tshapeQueryTshape, get_tshapeGetTshape

Possible successors

write_stringWriteString, read_stringReadString

See also

get_tshapeGetTshape, query_tshapeQueryTshape, write_stringWriteString, read_stringReadString

Module🔗

Foundation