set_mshapeT_set_mshapeSetMshapeSetMshapeset_mshape (Operator)

Name

set_mshapeT_set_mshapeSetMshapeSetMshapeset_mshape — Set the current mouse pointer shape.

Warning

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

Signature

set_mshape( : : WindowHandle, Cursor : )

Description

set_mshapeset_mshapeSetMshapeSetMshapeset_mshape sets the shape of the mouse pointer for the window. A list of the names of all available mouse pointer shapes can be obtained by calling query_mshapequery_mshapeQueryMshapeQueryMshapequery_mshape. The mouse pointer shape given by CursorCursorCursorcursorcursor is used if the mouse pointer enters the window, irrespective of which window is the output window at present.

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 → (handle)

Window handle.

CursorCursorCursorcursorcursor (input_control) string → (string)

Mouse pointer name.

Default: 'arrow' "arrow" "arrow" "arrow" "arrow"

Result

set_mshapeset_mshapeSetMshapeSetMshapeset_mshape returns the value 2 ( H_MSG_TRUE) if the mouse pointer shape CursorCursorCursorcursorcursor is defined for this window. Otherwise, an exception is raised.

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowopen_window, query_mshapequery_mshapeQueryMshapeQueryMshapequery_mshape, get_mshapeget_mshapeGetMshapeGetMshapeget_mshape

Module

Foundation

Operators