Public API Reference

                 

---

csMouseDriver Class Reference

Generic Mouse Driver. More...

#include <csinput.h>

Inheritance diagram for csMouseDriver:

List of all members.

Public Methods
	csMouseDriver (iObjectRegistry *)
	Initialize mouse interface.
virtual	~csMouseDriver ()
	Destructor.
virtual void	SetDoubleClickTime (int iTime, size_t iDist)
	Set double-click mouse parameters.
virtual void	Reset ()
	Call to release all mouse buttons.
virtual int	GetLastX ()
	Query last mouse X position.
virtual int	GetLastY ()
	Query last mouse Y position.
virtual bool	GetLastButton (int button)
	Query the last known mouse button state.
virtual void	DoButton (int button, bool down, int x, int y)
	Call this to add a 'mouse button down/up' event to queue.
virtual void	DoMotion (int x, int y)
	Call this to add a 'mouse moved' event to queue.
virtual void	LostFocus ()
	Application lost focus.
Public Attributes
csMouseDriver::eiEventHandler	scfiEventHandler
	iEventHandler implementation
Protected Methods
iKeyboardDriver *	GetKeyboardDriver ()
	Get the generic keyboard driver (for checking modifier states).
Protected Attributes
csTicks	LastClickTime
	Last "mouse down" event time.
int	LastClickButton
	Last "mouse down" event button.
int	LastClickX
	Last "mouse down" event position.
int	LastClickY
	Last "mouse down" event position.
int	LastX
	Last mouse position.
int	LastY
	Last mouse position.
bool	Button [CS_MAX_MOUSE_BUTTONS]
	Mouse buttons state.
csTicks	DoubleClickTime
	Mouse double click max interval in 1/1000 seconds.
size_t	DoubleClickDist
	Mouse double click max distance.

---

Detailed Description

Generic Mouse Driver.

Mouse driver should generate events and put them into the event queue. Also it is responsible for generating double-click events.

Definition at line 177 of file csinput.h.

---

Constructor & Destructor Documentation

csMouseDriver::csMouseDriver (  iObjectRegistry *    )

Initialize mouse interface.

virtual csMouseDriver::~csMouseDriver (    )  [virtual]

Destructor.

---

Member Function Documentation

virtual void csMouseDriver::DoButton (  int    button, bool    down, int    x, int    y )  [virtual]

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

virtual void csMouseDriver::DoMotion (  int    x, int    y )  [virtual]

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

iKeyboardDriver* csMouseDriver::GetKeyboardDriver (    )  [protected]

Get the generic keyboard driver (for checking modifier states).

virtual bool csMouseDriver::GetLastButton (  int    button )  [inline, virtual]

Query the last known mouse button state. Implements iMouseDriver. Definition at line 220 of file csinput.h. References CS_MAX_MOUSE_BUTTONS.

virtual int csMouseDriver::GetLastX (    )  [inline, virtual]

Query last mouse X position. Implements iMouseDriver. Definition at line 216 of file csinput.h.

virtual int csMouseDriver::GetLastY (    )  [inline, virtual]

Query last mouse Y position. Implements iMouseDriver. Definition at line 218 of file csinput.h.

virtual void csMouseDriver::LostFocus (    )  [inline, virtual]

Application lost focus. Implements csInputDriver. Definition at line 232 of file csinput.h. References iMouseDriver::Reset().

virtual void csMouseDriver::Reset (    )  [virtual]

Call to release all mouse buttons. Implements iMouseDriver.

virtual void csMouseDriver::SetDoubleClickTime (  int    iTime, size_t    iDist )  [virtual]

Set double-click mouse parameters. Implements iMouseDriver.

---

Member Data Documentation

bool csMouseDriver::Button[CS_MAX_MOUSE_BUTTONS] [protected]

Mouse buttons state. Definition at line 193 of file csinput.h.

size_t csMouseDriver::DoubleClickDist [protected]

Mouse double click max distance. Definition at line 197 of file csinput.h.

csTicks csMouseDriver::DoubleClickTime [protected]

Mouse double click max interval in 1/1000 seconds. Definition at line 195 of file csinput.h.

int csMouseDriver::LastClickButton [protected]

Last "mouse down" event button. Definition at line 187 of file csinput.h.

csTicks csMouseDriver::LastClickTime [protected]

Last "mouse down" event time. Definition at line 185 of file csinput.h.

int csMouseDriver::LastClickX [protected]

Last "mouse down" event position. Definition at line 189 of file csinput.h.

int csMouseDriver::LastClickY [protected]

Last "mouse down" event position. Definition at line 189 of file csinput.h.

int csMouseDriver::LastX [protected]

Last mouse position. Definition at line 191 of file csinput.h.

int csMouseDriver::LastY [protected]

Last mouse position. Definition at line 191 of file csinput.h.

csMouseDriver::eiEventHandler csMouseDriver::scfiEventHandler

iEventHandler implementation

---

The documentation for this class was generated from the following file:

• csutil/csinput.h

---