a5::Mouse Class Reference [Mouse]

Object representing a mouse. More...

#include <Mouse.hpp>

Inheritance diagram for a5::Mouse:

List of all members.

Classes
class	Cursor
	Mouse cursor. More...
class	Event
	Mouse event object. More...
class	State
	Mouse state. More...
Public Types
enum	Button {   Invalid = 0,   Left = 1,   Right = 2,   Middle = 3 }
enum	Axis {   X,   Y,   Z,   W }
Public Member Functions
	Mouse ()
	Creates a Mouse.
a5::Mouse::State	GetState () const
	Takes a snapshot of the current state of the mouse.
void	SetState (a5::Display &display, a5::Mouse::State state)
	Restores the coordinates to a previous State.
bool	SetCursor (Display &display, Cursor &cursor)
	Changes the mouse cursor image.
std::auto_ptr< a5::Event >	Handle (ALLEGRO_EVENT *raw_event) const
	Processes Allegro event messages in to A5SES Events.
void	SetEventSource (ALLEGRO_EVENT_SOURCE *event_source)
	Points the Allegro event source towards this object.
	operator ALLEGRO_EVENT_SOURCE * () const
	Returns a pointer to the Allegro event source.

---

Detailed Description

Object representing a mouse.

---

Constructor & Destructor Documentation

a5::Mouse::Mouse

(

)

Creates a Mouse.

---

Member Function Documentation

a5::Mouse::State a5::Mouse::GetState

(

)

const

Takes a snapshot of the current state of the mouse.

void a5::Mouse::SetState	(	a5::Display &	display,
		a5::Mouse::State	state
	)

Restores the coordinates to a previous State.

bool a5::Mouse::SetCursor	(	Display &	display,
		Cursor &	cursor
	)

Changes the mouse cursor image.

std::auto_ptr<a5::Event> a5::Mouse::Handle

(

ALLEGRO_EVENT *

raw_event

)

const [virtual]

Processes Allegro event messages in to A5SES Events.

Implements a5::Event_Source.

void a5::Event_Source::SetEventSource

(

ALLEGRO_EVENT_SOURCE *

event_source

)

[inherited]

Points the Allegro event source towards this object.

a5::Event_Source::operator ALLEGRO_EVENT_SOURCE *

(

)

const [inherited]

Returns a pointer to the Allegro event source.