query_tshapeT_query_tshapeQueryTshapeQueryTshapequery_tshape (Operator)

Name

query_tshapeT_query_tshapeQueryTshapeQueryTshapequery_tshape — Query all shapes available for text cursors.

Warning

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

Signature

query_tshape( : : WindowHandle : TextCursor)

Herror T_query_tshape(const Htuple WindowHandle, Htuple* TextCursor)

void QueryTshape(const HTuple& WindowHandle, HTuple* TextCursor)

HTuple HWindow::QueryTshape() const

static void HOperatorSet.QueryTshape(HTuple windowHandle, out HTuple textCursor)

HTuple HWindow.QueryTshape()

def query_tshape(window_handle: HHandle) -> Sequence[str]

Description

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

Execution Information

Parameters

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control)  window HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

TextCursorTextCursorTextCursorTextCursortextCursortext_cursor (output_control)  string-array HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Names of the available text cursors.

Result

query_tshapequery_tshapeQueryTshapeQueryTshapeQueryTshapequery_tshape returns TRUE.

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindowopen_window

Possible Successors

set_tshapeset_tshapeSetTshapeSetTshapeSetTshapeset_tshape, write_stringwrite_stringWriteStringWriteStringWriteStringwrite_string, read_stringread_stringReadStringReadStringReadStringread_string

See also

set_tshapeset_tshapeSetTshapeSetTshapeSetTshapeset_tshape, get_shapeget_shapeGetShapeGetShapeGetShapeget_shape, set_tpositionset_tpositionSetTpositionSetTpositionSetTpositionset_tposition, write_stringwrite_stringWriteStringWriteStringWriteStringwrite_string, read_stringread_stringReadStringReadStringReadStringread_string

Module

Foundation