Skip to content

query_tshapeQueryTshapeQueryTshapequery_tshapeT_query_tshape🔗

Short description🔗

query_tshapeQueryTshapeQueryTshapequery_tshapeT_query_tshape — Query all shapes available for text cursors.

Warning🔗

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

Signature🔗

query_tshape( window WindowHandle, out string TextCursor )void QueryTshape( const HTuple& WindowHandle, HTuple* TextCursor )static void HOperatorSet.QueryTshape( HTuple windowHandle, out HTuple textCursor )def query_tshape( window_handle: HHandle ) -> Sequence[str]

Herror T_query_tshape( const Htuple WindowHandle, Htuple* TextCursor )

HTuple HWindow::QueryTshape( ) const

HTuple HWindow.QueryTshape( )

Description🔗

query_tshapeQueryTshape queries the available shapes of text cursors for the output window. The retrieved shapes can be used by the operator set_tshapeSetTshape.

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-array → (string)HTuple (HString)HTuple (string)Sequence[str]Htuple (char*)

Names of the available text cursors.

Result🔗

query_tshapeQueryTshape returns 2 (H_MSG_TRUE).

Combinations with other operators🔗

Combinations

Possible predecessors

open_windowOpenWindow

Possible successors

set_tshapeSetTshape, write_stringWriteString, read_stringReadString

See also

set_tshapeSetTshape, get_shapeGetShape, set_tpositionSetTposition, write_stringWriteString, read_stringReadString

Module🔗

Foundation