Main Page | Class Hierarchy | Class List | Directories | File List | Class Members | Related Pages

gcn::Input Class Reference

#include <input.hpp>

Inheritance diagram for gcn::Input:

gcn::AllegroInput gcn::SDLInput List of all members.

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

Definition at line 71 of file input.hpp.

Public Member Functions

virtual ~Input ()
 Destructor.
virtual bool isKeyQueueEmpty ()=0
 Checks whether the key queue is empty or not.
virtual KeyInput dequeueKeyInput ()=0
 Dequeues the key input queue.
virtual bool isMouseQueueEmpty ()=0
 Checks whether the mouse queue is empyt or not.
virtual MouseInput dequeueMouseInput ()=0
 Dequeues the mouse input queue.
virtual void _pollInput ()=0
 Polls all exsisting input.


Member Function Documentation

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::AllegroInput, and gcn::SDLInput.

Referenced by gcn::Gui::logic().

virtual KeyInput gcn::Input::dequeueKeyInput  )  [pure virtual]
 

Dequeues the key input queue.

Returns:
a KeyInput object.
See also:
KeyInput

Implemented in gcn::AllegroInput, and gcn::SDLInput.

Referenced by gcn::Gui::logic().

virtual MouseInput gcn::Input::dequeueMouseInput  )  [pure virtual]
 

Dequeues the mouse input queue.

Returns:
a MouseInput object.
See also:
MouseInput

Implemented in gcn::AllegroInput, and gcn::SDLInput.

Referenced by gcn::Gui::logic().

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::AllegroInput, and gcn::SDLInput.

Referenced by gcn::Gui::logic().

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::AllegroInput, and gcn::SDLInput.

Referenced by gcn::Gui::logic().


The documentation for this class was generated from the following file:
Generated on Tue May 17 21:23:26 2005 for Guichan by  doxygen 1.4.1