gcn::KeyInput Class Reference

#include <keyinput.hpp>

List of all members.


Detailed Description

Internal class representing keyboard input.

Generally you won't have to bother using this class.

Definition at line 69 of file keyinput.hpp.

Public Types

 EMPTY = 0
 PRESS
 RELEASE
enum  { EMPTY = 0, PRESS, RELEASE }
 Enum with key input values.

Public Member Functions

 KeyInput ()
 Constructor.
 KeyInput (const Key &key, int type)
 Constructor.
void setType (int type)
 Sets the input type.
int getType () const
 Gets the input type.
void setKey (const Key &key)
 Sets the key the input concerns.
const KeygetKey () const
 Gets the key the input concerns.

Protected Attributes

Key mKey
int mType
int mButton


Constructor & Destructor Documentation

gcn::KeyInput::KeyInput ( const Key key,
int  type 
)

Constructor.

Parameters:
key the Key the input concerns.
type the type of input.

Definition at line 65 of file keyinput.cpp.

References mKey, and mType.


Member Function Documentation

const Key & gcn::KeyInput::getKey (  )  const

Gets the key the input concerns.

Returns:
the Key the input concerns.

Definition at line 86 of file keyinput.cpp.

References mKey.

Referenced by gcn::Widget::_keyInputMessage().

int gcn::KeyInput::getType (  )  const

Gets the input type.

Returns:
the input type.

Definition at line 76 of file keyinput.cpp.

References mType.

Referenced by gcn::Widget::_keyInputMessage().

void gcn::KeyInput::setKey ( const Key key  ) 

Sets the key the input concerns.

Parameters:
key the Key the input concerns.

Definition at line 81 of file keyinput.cpp.

References mKey.

Referenced by gcn::SDLInput::pushInput(), gcn::GLUTInput::pushKeyDownInput(), gcn::GLUTInput::pushKeyUpInput(), gcn::GLUTInput::pushSpecialDownInput(), and gcn::GLUTInput::pushSpecialUpInput().

void gcn::KeyInput::setType ( int  type  ) 

Sets the input type.

Parameters:
type the type of input.

Definition at line 71 of file keyinput.cpp.

References mType.

Referenced by gcn::SDLInput::pushInput(), gcn::GLUTInput::pushKeyDownInput(), gcn::GLUTInput::pushKeyUpInput(), gcn::GLUTInput::pushSpecialDownInput(), and gcn::GLUTInput::pushSpecialUpInput().


The documentation for this class was generated from the following files:
Generated on Sat Jul 29 19:38:48 2006 for Guichan by  doxygen 1.4.7