gcn::Input Class Reference

#include <input.h>

Inheritance diagram for gcn::Input:

Public Member Functions
virtual	~Input ()
virtual bool	isKeyQueueEmpty ()=0
virtual KeyInput	dequeueKeyInput ()=0
virtual bool	isMouseQueueEmpty ()=0
virtual MouseInput	dequeueMouseInput ()=0
virtual void	_pollInput ()=0

Detailed Description

Inputs base class. Contains basic Input functions every implemented input class should have. Input classes should inherit from this class and implements it's functions.

See also

SDLInput, AllegroInput

Constructor & Destructor Documentation

~Input()

virtual gcn::Input::~Input ( )

inlinevirtual

Destructor.

Member Function Documentation

_pollInput()

virtual void gcn::Input::_pollInput ( )

pure virtual

Polls all exsisting input. It exists for Input implementation compatibility. It is used internally by the library.

Implemented in gcn::SDLInput.

dequeueKeyInput()

virtual KeyInput gcn::Input::dequeueKeyInput ( )

pure virtual

Dequeues the key input queue.

Returns

a KeyInput object.

See also

KeyInput

Implemented in gcn::SDLInput.

dequeueMouseInput()

virtual MouseInput gcn::Input::dequeueMouseInput ( )

pure virtual

Dequeues the mouse input queue.

Returns

a MouseInput object.

See also

MouseInput

Implemented in gcn::SDLInput.

isKeyQueueEmpty()

virtual bool gcn::Input::isKeyQueueEmpty ( )

pure virtual

Checks whether the key queue is empty or not.

Returns

true if the key queue is empty.

Implemented in gcn::SDLInput.

isMouseQueueEmpty()

virtual bool gcn::Input::isMouseQueueEmpty ( )

pure virtual

Checks whether the mouse queue is empyt or not.

Returns

true if the mouse queue is empty.

Implemented in gcn::SDLInput.

---

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

• src/guichan/include/guichan/input.h