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

gcn::Key Class Reference

#include <key.hpp>

List of all members.


Detailed Description

Represents a key or a character.

Definition at line 67 of file key.hpp.

Public Types

enum  {
  SPACE = ' ', TAB = '\t', ENTER = '\n', LEFT_ALT = 1000,
  RIGHT_ALT, LEFT_SHIFT, RIGHT_SHIFT, LEFT_CONTROL,
  RIGHT_CONTROL, LEFT_META, RIGHT_META, LEFT_SUPER,
  RIGHT_SUPER, INSERT, HOME, PAGE_UP,
  DELETE, END, PAGE_DOWN, ESCAPE,
  CAPS_LOCK, BACKSPACE, F1, F2,
  F3, F4, F5, F6,
  F7, F8, F9, F10,
  F11, F12, F13, F14,
  F15, PRINT_SCREEN, SCROLL_LOCK, PAUSE,
  NUM_LOCK, ALT_GR, LEFT, RIGHT,
  UP, DOWN
}
 An enum with key values.

Public Member Functions

 Key ()
 Constructor.
 Key (int value)
 Constructor.
bool isCharacter () const
 Checks whether a key is a character.
bool isNumber () const
 Checks whether a key is a number.
bool isLetter () const
 Checks whether a key is a letter.
bool isShiftPressed () const
 Checks whether shift is pressed.
void setShiftPressed (bool pressed)
 Sets the shift pressed flag.
bool isControlPressed () const
 Checks whether control is pressed.
void setControlPressed (bool pressed)
 Sets the control pressed flag.
bool isAltPressed () const
 Checks whether alt is pressed.
void setAltPressed (bool pressed)
 Sets the alt pressed flag.
bool isMetaPressed () const
 Checks whether meta is pressed.
void setMetaPressed (bool pressed)
 Sets the meta pressed flag.
bool isNumericPad () const
 Checks whether the key was pressed at the numeric pad.
void setNumericPad (bool numpad)
 Sets the numeric pad flag.
int getValue () const
 Gets the value of the key.
void setValue (int value)
 Sets the value of the key.

Protected Attributes

int mValue
bool mShiftPressed
bool mControlPressed
bool mAltPressed
bool mMetaPressed
bool mNumericPad


Constructor & Destructor Documentation

gcn::Key::Key int  value  ) 
 

Constructor.

Parameters:
value the ascii or enum value for the key.

Definition at line 73 of file key.cpp.


Member Function Documentation

int gcn::Key::getValue  )  const
 

Gets the value of the key.

If an ascii value exists it will be returned. Otherwise an enum value will be returned.

Returns:
the value of the key.

Definition at line 158 of file key.cpp.

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

bool gcn::Key::isAltPressed  )  const
 

Checks whether alt is pressed.

Returns:
true if alt was pressed at the same time as the key.

Definition at line 123 of file key.cpp.

bool gcn::Key::isCharacter  )  const
 

Checks whether a key is a character.

Returns:
true if the key is a letter, number or whitespace.

Definition at line 83 of file key.cpp.

bool gcn::Key::isControlPressed  )  const
 

Checks whether control is pressed.

Returns:
true if control was pressed at the same time as the key.

Definition at line 113 of file key.cpp.

bool gcn::Key::isLetter  )  const
 

Checks whether a key is a letter.

Returns:
true if the key is a letter (a-z,A-Z).

Definition at line 95 of file key.cpp.

bool gcn::Key::isMetaPressed  )  const
 

Checks whether meta is pressed.

Returns:
true if meta was pressed at the same time as the key.

Definition at line 133 of file key.cpp.

bool gcn::Key::isNumber  )  const
 

Checks whether a key is a number.

Returns:
true if the key is a number (0-9).

Definition at line 90 of file key.cpp.

bool gcn::Key::isNumericPad  )  const
 

Checks whether the key was pressed at the numeric pad.

Returns:
true if key pressed at the numeric pad.

Definition at line 143 of file key.cpp.

bool gcn::Key::isShiftPressed  )  const
 

Checks whether shift is pressed.

Returns:
true if shift was pressed at the same time as the key.

Definition at line 103 of file key.cpp.

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

void gcn::Key::setAltPressed bool  pressed  ) 
 

Sets the alt pressed flag.

Parameters:
pressed the alt flag value.

Definition at line 128 of file key.cpp.

Referenced by gcn::SDLInput::convertKeyCharacter(), and gcn::AllegroInput::convertToKey().

void gcn::Key::setControlPressed bool  pressed  ) 
 

Sets the control pressed flag.

Parameters:
pressed the control flag value.

Definition at line 118 of file key.cpp.

Referenced by gcn::SDLInput::convertKeyCharacter(), and gcn::AllegroInput::convertToKey().

void gcn::Key::setMetaPressed bool  pressed  ) 
 

Sets the meta pressed flag.

Parameters:
pressed the meta flag value.

Definition at line 138 of file key.cpp.

Referenced by gcn::SDLInput::convertKeyCharacter(), and gcn::AllegroInput::convertToKey().

void gcn::Key::setNumericPad bool  numpad  ) 
 

Sets the numeric pad flag.

Parameters:
numpad the numeric pad flag value.

Definition at line 148 of file key.cpp.

Referenced by gcn::SDLInput::convertKeyCharacter(), and gcn::AllegroInput::convertToKey().

void gcn::Key::setShiftPressed bool  pressed  ) 
 

Sets the shift pressed flag.

Parameters:
pressed the shift flag value.

Definition at line 108 of file key.cpp.

Referenced by gcn::SDLInput::convertKeyCharacter(), and gcn::AllegroInput::convertToKey().

void gcn::Key::setValue int  value  ) 
 

Sets the value of the key.

An ascii value or an enum value.

Parameters:
value the key value.

Definition at line 153 of file key.cpp.

Referenced by gcn::SDLInput::convertKeyCharacter().


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