gcn::MouseInput Class Reference

#include <mouseinput.h>

Public Types
enum	{   EMPTY = 0, LEFT, RIGHT, MIDDLE,   WHEEL_UP, WHEEL_DOWN, PRESS, RELEASE,   MOTION }

Public Member Functions
	MouseInput ()
	MouseInput (int button, int type, int mousex, int mousey, int timeStamp)
void	setType (int type)
int	getType () const
void	setButton (int button)
int	getButton () const
void	setTimeStamp (int timeStamp)
int	getTimeStamp () const

Public Attributes
int	x
int	y

Protected Attributes
int	mType
int	mButton
int	mTimeStamp

Detailed Description

Internal class representing mouse input. Generally you won't have to bother using this class.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enum with mouse input values.

Enumerator
EMPTY
LEFT
RIGHT
MIDDLE
WHEEL_UP
WHEEL_DOWN
PRESS
RELEASE
MOTION

Constructor & Destructor Documentation

MouseInput() [1/2]

gcn::MouseInput::MouseInput ( )

inline

Constructor.

MouseInput() [2/2]

gcn::MouseInput::MouseInput	(	int	button,
		int	type,
		int	mousex,
		int	mousey,
		int	timeStamp
	)

Constructor.

Parameters

button	the button pressed.
type	the type of input.
mousex	the mouse x coordinate.
mousey	the mouse y coordinate.
timeStamp	the mouse inputs time stamp.

Member Function Documentation

getButton()

int gcn::MouseInput::getButton

(

)

const

Gets the button pressed.

Returns

the button pressed.

getTimeStamp()

int gcn::MouseInput::getTimeStamp

(

)

const

Gets the time stamp of the input.

Returns

the time stamp of the input.

getType()

int gcn::MouseInput::getType

(

)

const

Gets the input type.

Returns

the input type.

setButton()

void gcn::MouseInput::setButton

(

int

button

)

Sets the button pressed.

Parameters

button

the button pressed.

setTimeStamp()

void gcn::MouseInput::setTimeStamp

(

int

timeStamp

)

Sets the timestamp for the input.

Parameters

timeStamp

the timestamp of the input.

setType()

void gcn::MouseInput::setType

(

int

type

)

Sets the input type.

Parameters

type	the type of input.

Member Data Documentation

mButton

int gcn::MouseInput::mButton

protected

mTimeStamp

int gcn::MouseInput::mTimeStamp

protected

mType

int gcn::MouseInput::mType

protected

x

int gcn::MouseInput::x

y

int gcn::MouseInput::y

---

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

• src/guichan/include/guichan/mouseinput.h
• src/guichan/mouseinput.cpp