get_tshapeT_get_tshapeGetTshapeGetTshapeget_tshape (Operator)
Name
get_tshapeT_get_tshapeGetTshapeGetTshapeget_tshape — Get the shape of the text cursor.
Warning
get_tshapeget_tshapeGetTshapeGetTshapeGetTshapeget_tshape is obsolete and is only provided for
reasons of backward compatibility.
Signature
Description
get_tshapeget_tshapeGetTshapeGetTshapeGetTshapeget_tshape queries the shape of the text cursor for the
output window. A new cursor shape is set by the operator
set_tshapeset_tshapeSetTshapeSetTshapeSetTshapeset_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_tshapeQueryTshapeQueryTshapeQueryTshapequery_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
WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control) window → HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Window handle.
TextCursorTextCursorTextCursorTextCursortextCursortext_cursor (output_control) string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Name of the current text cursor.
Result
get_tshapeget_tshapeGetTshapeGetTshapeGetTshapeget_tshape returns 2 (H_MSG_TRUE) if the window is valid. Otherwise an
exception is raised.
Possible Predecessors
open_windowopen_windowOpenWindowOpenWindowOpenWindowopen_window,
set_fontset_fontSetFontSetFontSetFontset_font
Possible Successors
set_tshapeset_tshapeSetTshapeSetTshapeSetTshapeset_tshape,
set_tpositionset_tpositionSetTpositionSetTpositionSetTpositionset_tposition,
write_stringwrite_stringWriteStringWriteStringWriteStringwrite_string,
read_stringread_stringReadStringReadStringReadStringread_string,
read_charread_charReadCharReadCharReadCharread_char
See also
set_tshapeset_tshapeSetTshapeSetTshapeSetTshapeset_tshape,
query_tshapequery_tshapeQueryTshapeQueryTshapeQueryTshapequery_tshape,
write_stringwrite_stringWriteStringWriteStringWriteStringwrite_string,
read_stringread_stringReadStringReadStringReadStringread_string
Module
Foundation