set_tshapeT_set_tshapeSetTshapeSetTshapeset_tshape (Operator)

Name

set_tshapeT_set_tshapeSetTshapeSetTshapeset_tshape — Set the shape of the text cursor.

Warning

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

Signature

set_tshape( : : WindowHandle, TextCursor : )

Description

set_tshapeset_tshapeSetTshapeSetTshapeset_tshape 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_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 (input_control) string → (string)

Name of cursor shape.

Default: 'invisible' "invisible" "invisible" "invisible" "invisible"

Result

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

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowopen_window, query_tshapequery_tshapeQueryTshapeQueryTshapequery_tshape, get_tshapeget_tshapeGetTshapeGetTshapeget_tshape

Possible Successors

write_stringwrite_stringWriteStringWriteStringwrite_string, read_stringread_stringReadStringReadStringread_string

Module

Foundation

Operators