set_mshape ( : : WindowHandle, Cursor : )

Set the current mouse pointer shape.

set_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_mshape. The mouse pointer shape given by Cursor is used if the mouse pointer enters the window, irrespective of which window is the output window at present.


Parameters

WindowHandle (input_control)
window -> integer
Window identifier.

Cursor (input_control)
string -> string
Mouse pointer name.
Default value: 'arrow'


Result

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


Parallelization Information

set_mshape is reentrant, local, and processed without parallelization.


Possible Predecessors

open_window, open_textwindow, query_mshape, get_mshape


See also

get_mshape, query_mshape


Module

Foundation



Copyright © 1996-2008 MVTec Software GmbH