set_drawing_object_callback — Add a callback function to a drawing object.
set_drawing_object_callback( : : DrawHandle, DrawObjectEvent, CallbackFunction : )
set_drawing_object_callback adds the callback function
CallbackFunction to be called on the event(s) defined in
DrawObjectEvent to the drawing object DrawHandle.
An event is an action, i.e., a user interaction with the
mouse or a call to a HALCON operator, e.g.,
attach_drawing_object_to_window), that changes the current state of a
given drawing object. The operator set_drawing_object_callback allows
to define how to react to those events.
The following predefined events are available:
The corresponding callback will be called right after the object has been attached to the HALCON window and is ready for interaction.
The corresponding callback will be called right after the object has been detached from the window and is no longer available for interaction.
The corresponding callback will be called right after the object has been dragged with mouse interaction.
The corresponding callback will be called right after the object has been resized with mouse interaction.
The corresponding callback will be called right after the object has been selected with mouse interaction.
It is possible to specify a particular callback for each desired event.
Then the input parameters DrawObjectEvent and CallbackFunction
must have the same length. It is also possible to use the same callback
for different events. Then DrawObjectEvent has an
arbitrary length and CallbackFunction contains one single value.
The callback is an integer of long type containing a pointer to a C function with the following signature:
Herror HDrawObjectCallback(Hphandle DrawHandle, Hphandle WindowHandle, char* type)
On Windows systems, the __stdcall naming convention is used:
Herror __stdcall HDrawObjectCallback(Hphandle DrawHandle, Hphandle WindowHandle, char* type)
The first parameter of the callback function contains the handle to the draw object that generated the event, the second one contains the handle of the window where the interaction took place. Finally, the third parameter indicates which event occurred.
No graphical operator should be called within the callback, like for example
disp_obj, for otherwise a deadlock may occur.
DrawHandle (input_control) drawing_object → (handle)
Handle of the drawing object.
DrawObjectEvent (input_control) string(-array) → (string)
Events to be captured.
Suggested values: 'on_resize', 'on_drag', 'on_attach', 'on_detach', 'on_select'
CallbackFunction (input_control) pointer(-array) → (integer)
Callback functions.
set_drawing_object_callback returns 2 (
H_MSG_TRUE)
, if DrawHandle is valid.
Otherwise an exception is raised.
attach_drawing_object_to_window
close_window,
clear_drawing_object,
detach_drawing_object_from_window,
get_drawing_object_iconic,
get_drawing_object_params
create_drawing_object_rectangle1,
attach_drawing_object_to_window,
detach_drawing_object_from_window
Foundation