Operator Reference

HALCON Operator Reference / Graphics / Mouse
ClassesClasses | | Operators

get_mshapeT_get_mshapeGetMshapeGetMshapeget_mshape (Operator)

get_mshapeT_get_mshapeGetMshapeGetMshapeget_mshape — Query the current mouse pointer shape.

Warning

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

Signature

get_mshape( : : WindowHandle : Cursor)

Herror T_get_mshape(const Htuple WindowHandle, Htuple* Cursor)

void GetMshape(const HTuple& WindowHandle, HTuple* Cursor)

HString HWindow::GetMshape() const

static void HOperatorSet.GetMshape(HTuple windowHandle, out HTuple cursor)

string HWindow.GetMshape()

def get_mshape(window_handle: HHandle) -> str

Description

get_mshapeget_mshapeGetMshapeGetMshapeget_mshape returns the name of the pointer shape set for the window. The mouse pointer shape can be used in the operator set_mshapeset_mshapeSetMshapeSetMshapeset_mshape.

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.

CursorCursorCursorcursorcursor (output_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Mouse pointer name.

Result

get_mshapeget_mshapeGetMshapeGetMshapeget_mshape returns the value 2 ( H_MSG_TRUE) .

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowopen_window, query_mshapequery_mshapeQueryMshapeQueryMshapequery_mshape

Possible Successors

set_mshapeset_mshapeSetMshapeSetMshapeset_mshape

See also

set_mshapeset_mshapeSetMshapeSetMshapeset_mshape, query_mshapequery_mshapeQueryMshapeQueryMshapequery_mshape

Module

Foundation

ClassesClasses | | Operators