query_mshape (Operator)

Name

query_mshape — Query all available mouse pointer shapes.

Synopsis

query_mshape( : : WindowHandle : ShapeNames)

Description

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

Parameters

WindowHandle (input_control)	window → (integer)
Window identifier.

ShapeNames (output_control)	string-array → (string)
Available mouse pointer names.

Result

query_mshape returns the value 2 (H_MSG_TRUE).

Parallelization Information

query_mshape is reentrant, local, and processed without parallelization.

Possible Predecessors

open_window, open_textwindow, get_mshape

Possible Successors

set_mshape

See also

set_mshape, get_mshape

Module

Foundation