csMouseEventHelper Class Reference
[Event handling]
Helper class to conveniently deal with mouse events.
More...
#include <csutil/event.h>
Static Public Member Functions | |
static int | GetAxis (const iEvent *event, uint axis) |
retrieve any axis (basis 0) value | |
static uint | GetButton (const iEvent *event) |
retrieve button code | |
static uint32 | GetButtonMask (const iEvent *event) |
Retrieve current button mask. | |
static bool | GetButtonState (const iEvent *event) |
retrieve button state (pressed/released) | |
static bool | GetEventData (const iEvent *event, csMouseEventData &data) |
Retrieve event data. | |
static csMouseEventType | GetEventType (const iEvent *event) |
Retrieve the event type (key up or down.). | |
static uint32 | GetModifiers (const iEvent *event) |
Retrieve modifiers bitmask. | |
static void | GetModifiers (const iEvent *event, csKeyModifiers &modifiers) |
retrieve modifier flags | |
static uint | GetNumAxes (const iEvent *event) |
retrieve number of axes | |
static uint | GetNumber (const iEvent *event) |
retrieve mouse number (0, 1, ...) | |
static int | GetX (const iEvent *event) |
retrieve X value of mouse #0 | |
static int | GetY (const iEvent *event) |
Retrieve Y value of mouse #0. | |
static csEvent * | NewEvent (csRef< iEventNameRegistry > ®, csTicks, csEventID name, csMouseEventType etype, int x, int y, uint32 AxesChanged, uint button, bool buttonstate, uint32 buttonMask, uint32 modifiers) |
Create a new mouse event. |
Detailed Description
Helper class to conveniently deal with mouse events.
Definition at line 91 of file event.h.
Member Function Documentation
|
retrieve any axis (basis 0) value
|
|
retrieve button code
|
|
Retrieve current button mask.
|
|
retrieve button state (pressed/released)
|
|
Retrieve event data.
|
|
Retrieve the event type (key up or down.).
|
|
Retrieve modifiers bitmask.
Definition at line 135 of file event.h. References csKeyEventHelper::GetModifiers(), and csKeyEventHelper::GetModifiersBits(). |
|
retrieve modifier flags
Definition at line 131 of file event.h. References csKeyEventHelper::GetModifiers(). |
|
retrieve number of axes
|
|
retrieve mouse number (0, 1, ...)
|
|
retrieve X value of mouse #0
Definition at line 115 of file event.h. References GetAxis(). |
|
Retrieve Y value of mouse #0.
Definition at line 118 of file event.h. References GetAxis(). |
|
Create a new mouse event.
|
The documentation for this class was generated from the following file:
- csutil/event.h
Generated for Crystal Space by doxygen 1.4.6