send_mouse_double_click_eventT_send_mouse_double_click_eventSendMouseDoubleClickEventSendMouseDoubleClickEvent (Operator)

Name

send_mouse_double_click_eventT_send_mouse_double_click_eventSendMouseDoubleClickEventSendMouseDoubleClickEvent — Send an event to a buffer window signaling a mouse double click event.

Signature

Description

send_mouse_double_click_eventsend_mouse_double_click_eventSendMouseDoubleClickEventSendMouseDoubleClickEventSendMouseDoubleClickEvent sends an event at the position (RowRowRowRowrow, ColumnColumnColumnColumncolumn) to the buffer window WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle, signaling that the mouse button encoded by ButtonButtonButtonButtonbutton has been double clicked. Please refer to get_mbuttonget_mbuttonGetMbuttonGetMbuttonGetMbutton to see how to encode ButtonButtonButtonButtonbutton.

The purpose of this operator is to select a drawing object in a situation where multiple drawing objects are stacked on top of each other in a buffer window. If the double click happens on either one of the markers of the object border of the active object the object below is selected. To simplify the interaction with the drawing object, the coordinates RowRowRowRowrow and ColumnColumnColumnColumncolumn are given in the image coordinate system. To convert window coordinates into image coordinates, the operator convert_coordinates_window_to_imageconvert_coordinates_window_to_imageConvertCoordinatesWindowToImageConvertCoordinatesWindowToImageConvertCoordinatesWindowToImage can be used.

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

The operators send_mouse_down_eventsend_mouse_down_eventSendMouseDownEventSendMouseDownEventSendMouseDownEvent, send_mouse_up_eventsend_mouse_up_eventSendMouseUpEventSendMouseUpEventSendMouseUpEvent, send_mouse_drag_eventsend_mouse_drag_eventSendMouseDragEventSendMouseDragEventSendMouseDragEvent and send_mouse_double_click_eventsend_mouse_double_click_eventSendMouseDoubleClickEventSendMouseDoubleClickEventSendMouseDoubleClickEvent are the only means to manipulate drawing objects in buffer windows.

Attention

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

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

Result

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

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindow

See also

send_mouse_up_eventsend_mouse_up_eventSendMouseUpEventSendMouseUpEventSendMouseUpEvent, send_mouse_down_eventsend_mouse_down_eventSendMouseDownEventSendMouseDownEventSendMouseDownEvent, open_windowopen_windowOpenWindowOpenWindowOpenWindow

Module

Foundation