CrystalSpace

Public API Reference

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

iMouseDriver Struct Reference
[Event handling]

Generic Mouse Driver. More...

#include <iutil/csinput.h>

Inheritance diagram for iMouseDriver:

iBase csMouseDriver List of all members.

Public Member Functions

virtual void SetDoubleClickTime (int iTime, size_t iDist)=0
 Set double-click mouse parameters.
virtual void Reset ()=0
 Call to release all mouse buttons * (when focus switches from application window, for example).
virtual int GetLastX ()=0
 Query last mouse X position.
virtual int GetLastY ()=0
 Query last mouse Y position.
virtual bool GetLastButton (int button)=0
 Query the last known mouse button state. Button numbers start at 1.
virtual void DoButton (int button, bool down, int x, int y)=0
 Call this to add a 'mouse button down/up' event to queue.
virtual void DoMotion (int x, int y)=0
 Call this to add a 'mouse moved' event to queue.

Detailed Description

Generic Mouse Driver.

The mouse driver listens for mouse-related events from the event queue and records state information about recent events. It is responsible for synthesizing double-click events when it detects that two mouse-down events have occurred for the same mouse button within a short interval. Mouse button numbers start at 1. The left mouse button is 1, the right is 2, the middle 3, and so on. Typically, one instance of this object is available from the shared-object registry (iObjectRegistry) under the name "crystalspace.driver.input.generic.mouse".

Main creators of instances implementing this interface:

Main ways to get pointers to this interface:

Definition at line 186 of file csinput.h.


Member Function Documentation

virtual void iMouseDriver::DoButton int  button,
bool  down,
int  x,
int  y
[pure virtual]
 

Call this to add a 'mouse button down/up' event to queue.

Button numbers start at one.

Implemented in csMouseDriver.

virtual void iMouseDriver::DoMotion int  x,
int  y
[pure virtual]
 

Call this to add a 'mouse moved' event to queue.

Implemented in csMouseDriver.

virtual bool iMouseDriver::GetLastButton int  button  )  [pure virtual]
 

Query the last known mouse button state. Button numbers start at 1.

Implemented in csMouseDriver.

virtual int iMouseDriver::GetLastX  )  [pure virtual]
 

Query last mouse X position.

Implemented in csMouseDriver.

virtual int iMouseDriver::GetLastY  )  [pure virtual]
 

Query last mouse Y position.

Implemented in csMouseDriver.

virtual void iMouseDriver::Reset  )  [pure virtual]
 

Call to release all mouse buttons * (when focus switches from application window, for example).

Implemented in csMouseDriver.

Referenced by csMouseDriver::LostFocus().

virtual void iMouseDriver::SetDoubleClickTime int  iTime,
size_t  iDist
[pure virtual]
 

Set double-click mouse parameters.

Implemented in csMouseDriver.


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