____                _       __
    / __ )____  _____   | |     / /___ ___________
   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  )
 /_____/\____/____/     |__/|__/\__,_/_/  /____/

       A futuristic real-time strategy game.
          This file is part of Bos Wars.
(C) Copyright 2001-2007 by the Bos Wars and Stratagus Project. Distributed under the "GNU General Public License"

gcn::Input Class Reference

#include <input.h>

Inheritance diagram for gcn::Input:

gcn::SDLInput

List of all members.

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

Definition at line 71 of file input.h.


Constructor & Destructor Documentation

virtual gcn::Input::~Input (  )  [inline, virtual]

Destructor.

Definition at line 78 of file input.h.


Member Function Documentation

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.

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::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::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::SDLInput.

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

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.

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


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

Generated on Sat Feb 21 00:28:26 2009 for Bos Wars by  doxygen 1.5.6