CrystalSpace

Public API Reference

Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

csMouseEventHelper Class Reference

Helper class to conveniently deal with mouse events. More...

#include <csutil/event.h>

List of all members.

Static Public Member Functions

static int GetAxis (const iEvent *event, uint axis)
 Retrieve any axis (basis 1) value.
static uint GetButton (const iEvent *event)
 Retrieve button code.
static bool GetEventData (const iEvent *event, csMouseEventData &data)
 Retrieve event data.
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 (1, 2, ...).
static int GetX (const iEvent *event)
 Retrieve X value of mouse #1.
static int GetY (const iEvent *event)
 Retrieve Y value of mouse #1.


Detailed Description

Helper class to conveniently deal with mouse events.

Definition at line 88 of file event.h.


Member Function Documentation

static int csMouseEventHelper::GetAxis const iEvent event,
uint  axis
[static]
 

Retrieve any axis (basis 1) value.

Referenced by GetX(), and GetY().

static uint csMouseEventHelper::GetButton const iEvent event  )  [static]
 

Retrieve button code.

static bool csMouseEventHelper::GetEventData const iEvent event,
csMouseEventData data
[static]
 

Retrieve event data.

static uint32 csMouseEventHelper::GetModifiers const iEvent event  )  [inline, static]
 

Retrieve modifiers bitmask.

Definition at line 110 of file event.h.

References csKeyEventHelper::GetModifiers(), and csKeyEventHelper::GetModifiersBits().

static void csMouseEventHelper::GetModifiers const iEvent event,
csKeyModifiers modifiers
[inline, static]
 

Retrieve modifier flags.

Definition at line 106 of file event.h.

References csKeyEventHelper::GetModifiers().

static uint csMouseEventHelper::GetNumAxes const iEvent event  )  [static]
 

Retrieve number of axes.

static uint csMouseEventHelper::GetNumber const iEvent event  )  [static]
 

Retrieve mouse number (1, 2, ...).

static int csMouseEventHelper::GetX const iEvent event  )  [inline, static]
 

Retrieve X value of mouse #1.

Definition at line 94 of file event.h.

References GetAxis().

static int csMouseEventHelper::GetY const iEvent event  )  [inline, static]
 

Retrieve Y value of mouse #1.

Definition at line 97 of file event.h.

References GetAxis().


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.4.4