SoXtMouse Class Reference
[Xt]
Translates and reports events for the mouse device. More...
#include <Inventor/Xt/devices/SoXtMouse.h>
Public Member Functions | |
| SoXtMouse (EventMask mask=SO_XT_ALL_MOUSE_EVENTS) | |
| ~SoXtMouse () | |
| virtual void | enable (SoWidget w, XtEventHandler f, XtPointer data, Window win=(Window) NULL) |
| virtual void | disable (SoWidget w, XtEventHandler f, XtPointer data) |
| virtual const SoEvent * | translateEvent (XAnyEvent *xevent) |
Detailed Description
Translates and reports events for the mouse device.
This class manages events generated by the mouse, including mouse motion (SoLocation2Event), and mouse button press and release events (SoMouseButtonEvent).
SEE ALSO
SoXtDevice, SoLocation2Event, SoMouseButtonEvent
Constructor & Destructor Documentation
| SoXtMouse::SoXtMouse | ( | EventMask | mask = SO_XT_ALL_MOUSE_EVENTS |
) |
Constructor.
To the constructor, pass which mouse messages you are interested in as a bitwise OR of the following values:
ButtonPressMask - Mouse down events
ButtonReleaseMask - Mouse up events
PointerMotionMask - Mouse motion with no buttons
ButtonMotionMask - Mouse motion with buttons pressed
Or simply pass the defined value SO_XT_ALL_MOUSE_EVENTS for all mouse events. The device will only report events of this type for the window it is enabled on.
| SoXtMouse::~SoXtMouse | ( | ) |
Destructor.
Member Function Documentation
| virtual void SoXtMouse::disable | ( | SoWidget | w, | |
| XtEventHandler | f, | |||
| XtPointer | data | |||
| ) | [virtual] |
Disables the device for the passed widget.
Implements SoXtDevice.
| virtual void SoXtMouse::enable | ( | SoWidget | w, | |
| XtEventHandler | f, | |||
| XtPointer | data, | |||
| Window | win = (Window) NULL | |||
| ) | [virtual] |
Enables the device for the passed widget.
When enabled, the callback function f will be invoked when events occur in the window. data is the clientData which will be passed.
Implements SoXtDevice.
| virtual const SoEvent* SoXtMouse::translateEvent | ( | XAnyEvent * | xevent | ) | [virtual] |
Attempts to convert the passed event into an SoEvent.
Returns a pointer to an internal SoEvent object owned by the class. Do not delete this object. If the message was not generated by this device, then NULL is returned.
Implements SoXtDevice.
The documentation for this class was generated from the following file:
- Inventor/Xt/devices/SoXtMouse.h