Skip to content

send_mouse_drag_eventSendMouseDragEventSendMouseDragEventsend_mouse_drag_eventT_send_mouse_drag_event🔗

Short description🔗

send_mouse_drag_eventSendMouseDragEventSendMouseDragEventsend_mouse_drag_eventT_send_mouse_drag_event — Send an event to a buffer window signaling a mouse drag event.

Signature🔗

send_mouse_drag_event( window WindowHandle, point.y Row, point.x Column, integer Button, out string Processed )void SendMouseDragEvent( const HTuple& WindowHandle, const HTuple& Row, const HTuple& Column, const HTuple& Button, HTuple* Processed )static void HOperatorSet.SendMouseDragEvent( HTuple windowHandle, HTuple row, HTuple column, HTuple button, out HTuple processed )def send_mouse_drag_event( window_handle: HHandle, row: Union[float, int], column: Union[float, int], button: int ) -> str

Herror T_send_mouse_drag_event( const Htuple WindowHandle, const Htuple Row, const Htuple Column, const Htuple Button, Htuple* Processed )

HString HWindow::SendMouseDragEvent( const HTuple& Row, const HTuple& Column, Hlong Button ) const

HString HWindow::SendMouseDragEvent( Hlong Row, Hlong Column, Hlong Button ) const

static HString HDrawingObject::SendMouseDragEvent( const HWindow& WindowHandle, const HTuple& Row, const HTuple& Column, Hlong Button )

static HString HDrawingObject::SendMouseDragEvent( const HWindow& WindowHandle, Hlong Row, Hlong Column, Hlong Button )

string HWindow.SendMouseDragEvent( HTuple row, HTuple column, int button )

string HWindow.SendMouseDragEvent( int row, int column, int button )

static string HDrawingObject.SendMouseDragEvent( HWindow windowHandle, HTuple row, HTuple column, int button )

static string HDrawingObject.SendMouseDragEvent( HWindow windowHandle, int row, int column, int button )

Description🔗

send_mouse_drag_eventSendMouseDragEvent sends an event at the position (Rowrowrow, Columncolumncolumn) to the buffer window WindowHandlewindowHandlewindow_handle, signaling that the mouse button encoded by Buttonbuttonbutton is been dragged. Please refer to get_mbuttonGetMbutton to see how to encode Buttonbuttonbutton.

If the event could be processed, send_mouse_drag_eventSendMouseDragEvent returns 'true'"true" in Processedprocessedprocessed. If no action for the event could be determined (e.g., because there is no drawing object below the mouse position), 'false'"false" is returned in Processedprocessedprocessed. In this case the caller may determine an action for the event.

The operators send_mouse_down_eventSendMouseDownEvent, send_mouse_up_eventSendMouseUpEvent, send_mouse_drag_eventSendMouseDragEvent and send_mouse_double_click_eventSendMouseDoubleClickEvent are the only means to manipulate drawing objects in buffer windows.

Attention🔗

send_mouse_drag_eventSendMouseDragEvent depends on the library libcanvas, which might not be available on embedded systems.

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 of the buffer window.

Rowrowrow (input_control) point.y → (integer / real)HTuple (Hlong / double)HTuple (int / long / double)Union[float, int]Htuple (Hlong / double)

Row coordinate of the mouse cursor in the image coordinate system.

Columncolumncolumn (input_control) point.x → (integer / real)HTuple (Hlong / double)HTuple (int / long / double)Union[float, int]Htuple (Hlong / double)

Column coordinate of the mouse cursor in the image coordinate system.

Buttonbuttonbutton (input_control) integer → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Mouse button(s) pressed.

Processedprocessedprocessed (output_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

‘true’, if HALCON processed the event.

Result🔗

send_mouse_drag_eventSendMouseDragEvent returns the value 2 (H_MSG_TRUE) if the window handle WindowHandlewindowHandlewindow_handle corresponds to a window of valid type, and the event is properly encoded. Otherwise, an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

open_windowOpenWindow

See also

send_mouse_up_eventSendMouseUpEvent, send_mouse_down_eventSendMouseDownEvent, send_mouse_double_click_eventSendMouseDoubleClickEvent, open_windowOpenWindow

Module🔗

Foundation