Operator Reference

query_mshapeT_query_mshapeQueryMshapeQueryMshapequery_mshape (Operator)

query_mshapeT_query_mshapeQueryMshapeQueryMshapequery_mshape — Query all available mouse pointer shapes.

Warning

This operator does not work in an HDevelop graphics window opened with dev_open_window.

Signature

query_mshape( : : WindowHandle : ShapeNames)

Herror T_query_mshape(const Htuple WindowHandle, Htuple* ShapeNames)

void QueryMshape(const HTuple& WindowHandle, HTuple* ShapeNames)

HTuple HWindow::QueryMshape() const

static void HOperatorSet.QueryMshape(HTuple windowHandle, out HTuple shapeNames)

HTuple HWindow.QueryMshape()

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

Description

query_mshapequery_mshapeQueryMshapeQueryMshapequery_mshape returns the names of all available mouse pointer shapes for the window. These can be used in the operator set_mshapeset_mshapeSetMshapeSetMshapeset_mshape. If no mouse pointers are available, the empty tuple is returned.

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 HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

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

Available mouse pointer names.

Result

query_mshapequery_mshapeQueryMshapeQueryMshapequery_mshape returns the value 2 ( H_MSG_TRUE) .

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowopen_window, get_mshapeget_mshapeGetMshapeGetMshapeget_mshape

Possible Successors

set_mshapeset_mshapeSetMshapeSetMshapeset_mshape

See also

set_mshapeset_mshapeSetMshapeSetMshapeset_mshape, get_mshapeget_mshapeGetMshapeGetMshapeget_mshape

Module

Foundation