Skip to content

set_mshapeSetMshapeSetMshapeset_mshapeT_set_mshape🔗

Short description🔗

set_mshapeSetMshapeSetMshapeset_mshapeT_set_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( window WindowHandle, string Cursor )void SetMshape( const HTuple& WindowHandle, const HTuple& Cursor )static void HOperatorSet.SetMshape( HTuple windowHandle, HTuple cursor )def set_mshape( window_handle: HHandle, cursor: str ) -> None

Herror T_set_mshape( const Htuple WindowHandle, const Htuple Cursor )

void HWindow::SetMshape( const HString& Cursor ) const

void HWindow::SetMshape( const char* Cursor ) const

void HWindow::SetMshape( const wchar_t* Cursor ) const (Windows only)

void HWindow.SetMshape( string cursor )

Description🔗

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

Execution information🔗

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🔗

WindowHandlewindowHandlewindow_handle (input_control) window → (handle)HTuple (HHandle)HWindow, HTuple (IntPtr)HHandleHtuple (handle)

Window handle.

Cursorcursorcursor (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Mouse pointer name.

Default: 'arrow'"arrow"

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

open_windowOpenWindow, query_mshapeQueryMshape, get_mshapeGetMshape

See also

get_mshapeGetMshape, query_mshapeQueryMshape

Module🔗

Foundation