OpenOffice.org BASIC Guide - OpenOffice.org wiki

Events
The Assign Action dialog lists all of the available Events. To assign a macro to an event:
1. Select the event
2. Click Macro...
3. Browse to and select the macro you want to assign
4. Click OK
Parameters
The occurrence of a particular event is not always enough for an appropriate response. Additional information
may be required. For example, to process a mouse click, you may need the screen position where the mouse
button was pressed.
In OpenOffice.org Basic, you can use object parameters to provide more information about an event to a
procedure, for example:
Sub ProcessEvent(Event As Object)
End Sub
The structure and properties of the Event object depend on the type of event that triggers the procedure call.
Regardless of the type of event, all objects provide access to the relevant control element and its model. The
control element can be reached using Event.Source and its model using Event.Source.Model.
You can use these properties to trigger an event within an event handler.
Mouse Events
OpenOffice.org Basic recognizes the following mouse events:
Mouse moved
user moves mouse
Mouse moved while key pressed
user drags mouse while holding down a key
Mouse button pressed
user presses a mouse button
Note – This event is also used for notifying requests for a popup context menu on the control. In this case, the
member PopupTrigger of the event passed to your macro function will be TRUE. In particular, if such a request
is made by pressing the right mouse button on the control, the event will be fired twice: once for the popup menu
request, and once for the real mouse event. If you are interested in only the mouse click, your macro should
ignore all calls where PopupTrigger is TRUE.
Mouse button released
user releases a mouse button
Mouse outside
user moves mouse outside of the current window
The structure of the associated event objects is defined in the com.sun.star.awt.MouseEvent structure which
provides the following information:
158 OpenOffice.org 3.2 BASIC Guide · March 2010