Please note that the recommended version of Scilab is 2023.1.0. This page might be outdated.
See the recommended documentation of this function
event handler functions
Prototype of functions which may be used as event handler.
window number if the event occurred in an axe with a figure type parent. (DEPRECATED)
handle of the axe's parent where the event occurred.
X coordinate in pixels of the mouse pointer when the events occurred.
Y coordinate in pixels of the mouse pointer when the events occurred.
number corresponding to the event type.
When the event handler mode is enable, Scilab will call the specified event handler function each time an event occurs in the graphic window. The event handler function must comply with the above prototype. Each time an event occurred, the function is called and its four parameters are set accordingly to the window number, mouse position and type of event.
ibut parameter takes one of the following value depending on event type:
Left mouse button has been pressed
Middle mouse button has been pressed
Right mouse button has been pressed
Left mouse button has been clicked
Middle mouse button has been clicked
Right mouse button has been clicked
Left mouse button has been double-clicked
Middle mouse button has been double-clicked
Right mouse button has been double-clicked
Left mouse button has been released
Middle mouse button has been released
Right mouse button has been released
mouse pointer has moved
- ibut > =32
key with ascii code ascii(ibut) has been pressed
- ibut < =-32
key with ascii code ascii(-ibut) has been released
- ibut > =1000+32
key with ascii code ascii(ibut-1000) has been pressed while CTRL key pressed
graphic window has been closed
Unmanaged event; it could be a drag and drop or a fast click and move
For example, let say that the name of the event handler function is fooHandler for window number 0. A left click in the window at position [100,150] (in pixels) will be equivalent as calling fooHandler( 0, 100, 150, 3 ).
See figure_properties or seteventhandler for information on how to specify the event_handler name.
function my_eventhandler(win, x, y, ibut) if ibut==-1000 then return,end [x,y]=xchange(x,y,'i2f') gcf().info_message = msprintf('Event code %d at mouse position is (%f,%f)',ibut,x,y); endfunction plot2d() fig = gcf() ; fig.event_handler = 'my_eventhandler' ; fig.event_handler_enable = "on" ; //now: // - move the mouse over the graphic window // - press and release keys shifted or not with Ctrl pressed or not // - press button, wait a little release // - press and release button // - double-click button fig.event_handler_enable = "off" ; //suppress the event handler
- figure_properties — description of the graphics figure entity properties
- seteventhandler — set an event handler for the current graphic window
- xgetmouse — get the mouse events and current position
- xclick — Wait for a mouse click or an event in a graphic window.
|Report an issue|
|<< edit_curv||interaction||locate >>|