GluonEngine::KeyboardInputComponent Class Reference

#include <keyboardinputcomponent.h>

Inheritance diagram for GluonEngine::KeyboardInputComponent:
GluonEngine::Component GluonCore::GluonObject QObject

List of all members.

Public Types

enum  KeyName {
  UNKNOWN, ESC, ONE, TWO,
  THREE, FOUR, FIVE, SIX,
  SEVEN, EIGHT, NINE, ZERO,
  MINUS, EQUAL, BACKSPACE, TAB,
  Q, W, E, R,
  T, Y, U, I,
  O, P, LEFT_BRACKET, RIGHT_BRACKET,
  ENTER, LEFT_CONTROL, A, S,
  D, F, G, H,
  J, K, L, SEMICOLON,
  APOSTROPHE, GRAVE, LEFT_SHIFT, BACKSLASH,
  Z, X, C, V,
  B, N, M, COMMA,
  PUNCTUATION, SLASH, RIGHT_SHIFT, KEYPAD_ASTERISK,
  LEFT_ALT, SPACE, CAPSLOCK, F_ONE,
  F_TWO, F_THREE, F_FOUR, F_FIVE,
  F_SIX, F_SEVEN, F_EIGHT, F_NINE,
  F_TEN, NUM_LOCK, SCROLL_LOCK, KEYPAD_SEVEN,
  KEYPAD_EIGHT, KEYPAD_NINE, KEYPAD_MINUSE, KEYPAD_FOUR,
  KEYPAD_FIVE, KEYPAD_SIX, KEYPAD_PLUS, KEYPAD_ONE,
  KEYPAD_TWO, KEYPAD_THREE, KEYPAD_ZERO, KEYPAD_PUNCTUATION,
  KEY_UNUSED_0, ZENKAKUHANKAKU = 85, ONEZEROTWOND, F_ELEVEN,
  F_TWELVE, R_ZERO, KATAKANA, HIRAGANA,
  HENKAN, KATAKANAHIRAGANA, MUHENKAN, KEYPAD_JPCOMMA,
  KEYPAD_ENTER, RIGHT_CTRL, KEYPAD_SLASH, SYSRQ,
  RIGHT_ALT, LINEFEED, HOME, UP_ARROW,
  PAGEUP, LEFT_ARROW, RIGHT_ARROW, END,
  DOWN_ARROW, PAGEDOWN, INSERT, DELETE,
  MACRO, MUTE, VOLUME_DOWN, VOLUME_UP,
  POWER, KEYPAD_EQUAL, KEYPAD_PLUS_AND_MINUS, PAUSE,
  KEY_UNUSED_1, KEYPAD_COMMA = 121, HANGUEL, HANJA,
  YEN, LEFT_META, RIGHT_META, COMPOSE,
  STOP, AGAIN, PROPS, UNDO,
  FRONT, COPY, OPEN, PASTE,
  FIND, CUT, HELP, MENU,
  CALC, SETUP, SLEEP, WAKEUP,
  FILE, SEND_FILE, DELETE_FILE, X_FER,
  PROG_ONE, PROG_TWO, WWW, MSDOS,
  COFFEE, DIRECTION, CYCLE_WINDOWS, MAIL,
  BOOKMARKS, COMPUTER, BACK, FORWARD,
  CLOSE_CD, EJECT_CD, EJECT_AND_CLOSE_CD, NEXT_SONG,
  PLAY_PAUSE, PREVIOUS_SONG, STOP_CD, RECORD,
  REWIND, PHONE, ISOKEY, CONFIG,
  HOMEPAGE, REFRESH, EXIT, MOVE,
  EDIT, SCROLLUP, SCROLLDOWN, KEYPAD_LEFT_PARENTHESE,
  KEYPAD_RIGHT_PARENTHESE, KEY_UNUSED_2, KEY_UNUSED_3, KEY_UNUSED_4,
  KEY_UNUSED_5, F_THIRTEEN = 183, F_FOURTEEN, F_FIFTEEN,
  F_SIXTEEN, F_SEVENTEEN, F_EIGHTTEEN, F_NINETEEN,
  F_TWENTY, F_TWENTYONE, F_TWENTYTWO, F_TWENTYTHREE,
  F_TWENTYFOUR, KEY_UNUSED_6, KEY_UNUSED_7, KEY_UNUSED_8,
  KEY_UNUSED_9, PLAY_CD = 200, PAUSE_CD, PROG_THREE,
  PROG_FOUR, KEY_UNUSED_10, SUSPEND = 205, CLOSE,
  PLAY, FASTFORWARD, BASS_BOOST, PRINT,
  HP, CAMERA, SOUND, QUESTION,
  EMAIL, CHAT, SEARCH, CONNECT,
  FINANCE, SPORT, SHOP, ALT_ERASE,
  CANCEL, BRIGHTNESS_DOWN, BRIGHTNESS_UP, MEDIA,
  SWITCH_VIDEOMODE, KB_ILLUM_TOGGLE, KB_ILLUM_DOWN, KB_ILLUM_UP,
  BUTTON_ZERO = 256, BUTTON_ONE, BUTTON_TWO, BUTTON_THREE,
  BUTTON_FOUR, BUTTON_FIVE, BUTTON_SIX, BUTTON_SEVEN,
  BUTTON_EIGHT, BUTTON_NINE, MOUSE_LEFT_BUTTON = 272, MOUSE_RIGHT_BUTTON,
  MOUSE_MIDDLE_BUTTON, MOUSE_BUTTON_FOUR, MOUSE_BUTTON_FIVE, MOUSE_BUTTON_SIX,
  MOUSE_BUTTON_SEVEN, MOUSE_BUTTON_EIGHT, TRIGGER = 288, THUMB_BUTTON_ONE,
  THUMB_BUTTON_TWO, TOP_BUTTON_ONE, TOP_BUTTON_TWO, PINKIE_BUTTON,
  BASE_BUTTON_ONE, BASE_BUTTON_TWO, BASE_BUTTON_THREE, BASE_BUTTON_FOUR,
  BASE_BUTTON_FIVE, BASE_BUTTON_SIX, BUTTON_DEAD = 303, BUTTON_A,
  BUTTON_B, BUTTON_C, BUTTON_X, BUTTON_Y,
  BUTTON_Z, BUTTON_TL_ONE, BUTTON_TR_ONE, BUTTON_TL_TWO,
  BUTTON_TR_TWO, BUTTON_SELECT, BUTTON_START, BUTTON_MODE,
  BUTTON_THUMB_LEFT, BUTTON_THUMB_RIGHT, TOOL_PEN = 320, TOOL_RUBBER,
  TOOL_BRUSH, TOOL_PENCIL, TOOL_AIRBRUSH, TOOL_FINGER,
  TOOL_MOUSE, TOOL_LENS, TOUCH = 330, STYLUS,
  STYLUS_TWO, DOUBLETAB, TRIPLETAB, GEAR_UP = 336,
  GEAR_DOWN, OK = 352, SELECT, GOTO,
  CLEAR, POWER_TWO, OPTION, INFO,
  TIME, VENDOR, ARCHIVE, PROGRAM,
  CHANNEL, FAVORITES, EPG, PVR,
  MHP, LANGUAGE, TITLE, SUBTITLE,
  ANGLE, ZOOM, MODE, KEYBOARD,
  SCREEN, PC, TV, TV_TWO,
  VCR, VCR_TWO, SAT, SAT_TWO,
  CD, TAPE, RADIO, TUNER,
  PLAYER, TEXT, DVD, AUX,
  MP_THREE, AUDIO, VIDEO, DIRECTORY,
  LIST, MEMO, CALENDAR, RED,
  GREEN, YELLOW, BLUE, CHANNEL_UP,
  CHANNEL_DOWN, FIRST, LAST, AB,
  NEXT, RESTART, SLOW, SHUFFLE,
  BREAK, PREVIOUS, DIGITS, TEEN,
  TWEN, DELEOL = 448, DELEOS, INSLINE,
  DELLINE, FN = 464, FN_ESC, FN_F_ONE,
  FN_F_TWO, FN_F_THREE, FN_F_FOUR, FN_F_FIVE,
  FN_F_SIX, FN_F_SEVEN, FN_F_EIGHT, FN_F_NINE,
  FN_F_TEN, FN_F_ELEVEN, FN_F_TWELVE, FN_ONE,
  FN_TWO, FN_D, FN_E, FN_F,
  FN_S, FN_B
}

Public Member Functions

Q_INVOKABLE KeyboardInputComponent (QObject *parent=0)
virtual QString category () const
Q_INVOKABLE bool isActionHeld ()
Q_INVOKABLE bool isActionStarted ()
Q_INVOKABLE bool isActionStopped ()
virtual void initialize ()
virtual void start ()
virtual void update (int elapsedMilliseconds)
virtual void stop ()
KeyName keyCode () const
void setKeyCode (KeyName newKeyCode)

Properties

KeyName keyCode

Detailed Description

Definition at line 36 of file keyboardinputcomponent.h.

Member Enumeration Documentation

enum GluonEngine::KeyboardInputComponent::KeyName
Enumerator:
UNKNOWN 
ESC 
ONE 
TWO 
THREE 
FOUR 
FIVE 
SIX 
SEVEN 
EIGHT 
NINE 
ZERO 
MINUS 
EQUAL 
BACKSPACE 
TAB 
Q 
W 
E 
R 
T 
Y 
U 
I 
O 
P 
LEFT_BRACKET 
RIGHT_BRACKET 
ENTER 
LEFT_CONTROL 
A 
S 
D 
F 
G 
H 
J 
K 
L 
SEMICOLON 
APOSTROPHE 
GRAVE 
LEFT_SHIFT 
BACKSLASH 
Z 
X 
C 
V 
B 
N 
M 
COMMA 
PUNCTUATION 
SLASH 
RIGHT_SHIFT 
KEYPAD_ASTERISK 
LEFT_ALT 
SPACE 
CAPSLOCK 
F_ONE 
F_TWO 
F_THREE 
F_FOUR 
F_FIVE 
F_SIX 
F_SEVEN 
F_EIGHT 
F_NINE 
F_TEN 
NUM_LOCK 
SCROLL_LOCK 
KEYPAD_SEVEN 
KEYPAD_EIGHT 
KEYPAD_NINE 
KEYPAD_MINUSE 
KEYPAD_FOUR 
KEYPAD_FIVE 
KEYPAD_SIX 
KEYPAD_PLUS 
KEYPAD_ONE 
KEYPAD_TWO 
KEYPAD_THREE 
KEYPAD_ZERO 
KEYPAD_PUNCTUATION 
KEY_UNUSED_0 
ZENKAKUHANKAKU 
ONEZEROTWOND 
F_ELEVEN 
F_TWELVE 
R_ZERO 
KATAKANA 
HIRAGANA 
HENKAN 
KATAKANAHIRAGANA 
MUHENKAN 
KEYPAD_JPCOMMA 
KEYPAD_ENTER 
RIGHT_CTRL 
KEYPAD_SLASH 
SYSRQ 
RIGHT_ALT 
LINEFEED 
HOME 
UP_ARROW 
PAGEUP 
LEFT_ARROW 
RIGHT_ARROW 
END 
DOWN_ARROW 
PAGEDOWN 
INSERT 
DELETE 
MACRO 
MUTE 
VOLUME_DOWN 
VOLUME_UP 
POWER 
KEYPAD_EQUAL 
KEYPAD_PLUS_AND_MINUS 
PAUSE 
KEY_UNUSED_1 
KEYPAD_COMMA 
HANGUEL 
HANJA 
YEN 
LEFT_META 
RIGHT_META 
COMPOSE 
STOP 
AGAIN 
PROPS 
UNDO 
FRONT 
COPY 
OPEN 
PASTE 
FIND 
CUT 
HELP 
MENU 
CALC 
SETUP 
SLEEP 
WAKEUP 
FILE 
SEND_FILE 
DELETE_FILE 
X_FER 
PROG_ONE 
PROG_TWO 
WWW 
MSDOS 
COFFEE 
DIRECTION 
CYCLE_WINDOWS 
MAIL 
BOOKMARKS 
COMPUTER 
BACK 
FORWARD 
CLOSE_CD 
EJECT_CD 
EJECT_AND_CLOSE_CD 
NEXT_SONG 
PLAY_PAUSE 
PREVIOUS_SONG 
STOP_CD 
RECORD 
REWIND 
PHONE 
ISOKEY 
CONFIG 
HOMEPAGE 
REFRESH 
EXIT 
MOVE 
EDIT 
SCROLLUP 
SCROLLDOWN 
KEYPAD_LEFT_PARENTHESE 
KEYPAD_RIGHT_PARENTHESE 
KEY_UNUSED_2 
KEY_UNUSED_3 
KEY_UNUSED_4 
KEY_UNUSED_5 
F_THIRTEEN 
F_FOURTEEN 
F_FIFTEEN 
F_SIXTEEN 
F_SEVENTEEN 
F_EIGHTTEEN 
F_NINETEEN 
F_TWENTY 
F_TWENTYONE 
F_TWENTYTWO 
F_TWENTYTHREE 
F_TWENTYFOUR 
KEY_UNUSED_6 
KEY_UNUSED_7 
KEY_UNUSED_8 
KEY_UNUSED_9 
PLAY_CD 
PAUSE_CD 
PROG_THREE 
PROG_FOUR 
KEY_UNUSED_10 
SUSPEND 
CLOSE 
PLAY 
FASTFORWARD 
BASS_BOOST 
PRINT 
HP 
CAMERA 
SOUND 
QUESTION 
EMAIL 
CHAT 
SEARCH 
CONNECT 
FINANCE 
SPORT 
SHOP 
ALT_ERASE 
CANCEL 
BRIGHTNESS_DOWN 
BRIGHTNESS_UP 
MEDIA 
SWITCH_VIDEOMODE 
KB_ILLUM_TOGGLE 
KB_ILLUM_DOWN 
KB_ILLUM_UP 
BUTTON_ZERO 
BUTTON_ONE 
BUTTON_TWO 
BUTTON_THREE 
BUTTON_FOUR 
BUTTON_FIVE 
BUTTON_SIX 
BUTTON_SEVEN 
BUTTON_EIGHT 
BUTTON_NINE 
MOUSE_LEFT_BUTTON 
MOUSE_RIGHT_BUTTON 
MOUSE_MIDDLE_BUTTON 
MOUSE_BUTTON_FOUR 
MOUSE_BUTTON_FIVE 
MOUSE_BUTTON_SIX 
MOUSE_BUTTON_SEVEN 
MOUSE_BUTTON_EIGHT 
TRIGGER 
THUMB_BUTTON_ONE 
THUMB_BUTTON_TWO 
TOP_BUTTON_ONE 
TOP_BUTTON_TWO 
PINKIE_BUTTON 
BASE_BUTTON_ONE 
BASE_BUTTON_TWO 
BASE_BUTTON_THREE 
BASE_BUTTON_FOUR 
BASE_BUTTON_FIVE 
BASE_BUTTON_SIX 
BUTTON_DEAD 
BUTTON_A 
BUTTON_B 
BUTTON_C 
BUTTON_X 
BUTTON_Y 
BUTTON_Z 
BUTTON_TL_ONE 
BUTTON_TR_ONE 
BUTTON_TL_TWO 
BUTTON_TR_TWO 
BUTTON_SELECT 
BUTTON_START 
BUTTON_MODE 
BUTTON_THUMB_LEFT 
BUTTON_THUMB_RIGHT 
TOOL_PEN 
TOOL_RUBBER 
TOOL_BRUSH 
TOOL_PENCIL 
TOOL_AIRBRUSH 
TOOL_FINGER 
TOOL_MOUSE 
TOOL_LENS 
TOUCH 
STYLUS 
STYLUS_TWO 
DOUBLETAB 
TRIPLETAB 
GEAR_UP 
GEAR_DOWN 
OK 
SELECT 
GOTO 
CLEAR 
POWER_TWO 
OPTION 
INFO 
TIME 
VENDOR 
ARCHIVE 
PROGRAM 
CHANNEL 
FAVORITES 
EPG 
PVR 
MHP 
LANGUAGE 
TITLE 
SUBTITLE 
ANGLE 
ZOOM 
MODE 
KEYBOARD 
SCREEN 
PC 
TV 
TV_TWO 
VCR 
VCR_TWO 
SAT 
SAT_TWO 
CD 
TAPE 
RADIO 
TUNER 
PLAYER 
TEXT 
DVD 
AUX 
MP_THREE 
AUDIO 
VIDEO 
DIRECTORY 
LIST 
MEMO 
CALENDAR 
RED 
GREEN 
YELLOW 
BLUE 
CHANNEL_UP 
CHANNEL_DOWN 
FIRST 
LAST 
AB 
NEXT 
RESTART 
SLOW 
SHUFFLE 
BREAK 
PREVIOUS 
DIGITS 
TEEN 
TWEN 
DELEOL 
DELEOS 
INSLINE 
DELLINE 
FN 
FN_ESC 
FN_F_ONE 
FN_F_TWO 
FN_F_THREE 
FN_F_FOUR 
FN_F_FIVE 
FN_F_SIX 
FN_F_SEVEN 
FN_F_EIGHT 
FN_F_NINE 
FN_F_TEN 
FN_F_ELEVEN 
FN_F_TWELVE 
FN_ONE 
FN_TWO 
FN_D 
FN_E 
FN_F 
FN_S 
FN_B 

Definition at line 45 of file keyboardinputcomponent.h.

Constructor & Destructor Documentation

KeyboardInputComponent::KeyboardInputComponent ( QObject *  parent = 0  ) 

Definition at line 33 of file keyboardinputcomponent.cpp.

Member Function Documentation

QString KeyboardInputComponent::category (  )  const [virtual]

Return the category of the component. Meta-data used for filtering and sorting components

Reimplemented from GluonEngine::Component.

Definition at line 44 of file keyboardinputcomponent.cpp.

void KeyboardInputComponent::initialize (  )  [virtual]

The initialize function is called whenever an initialized object is needed. This includes scene changes.

Reimplemented from GluonEngine::Component.

Definition at line 49 of file keyboardinputcomponent.cpp.

bool KeyboardInputComponent::isActionHeld (  ) 

Definition at line 115 of file keyboardinputcomponent.cpp.

bool KeyboardInputComponent::isActionStarted (  ) 

Definition at line 109 of file keyboardinputcomponent.cpp.

bool KeyboardInputComponent::isActionStopped (  ) 

Definition at line 121 of file keyboardinputcomponent.cpp.

KeyName GluonEngine::KeyboardInputComponent::keyCode (  )  const
void KeyboardInputComponent::setKeyCode ( KeyboardInputComponent::KeyName  newKeyCode  ) 

Definition at line 133 of file keyboardinputcomponent.cpp.

void KeyboardInputComponent::start (  )  [virtual]

The start function is run once after each scene change, immediately before the first update

See also:
Game::setCurrentScene, update

Reimplemented from GluonEngine::Component.

Definition at line 56 of file keyboardinputcomponent.cpp.

void KeyboardInputComponent::stop (  )  [virtual]

The stop function is run once when the gameloop is stopped. Use it for removing temporary data between runs. Reimplement this function if you have something that needs cleaning up between runs.

Reimplemented from GluonEngine::Component.

Definition at line 96 of file keyboardinputcomponent.cpp.

void KeyboardInputComponent::update ( int  elapsedMilliseconds  )  [virtual]

The update function is run each time the game logic needs to be updated. Implement this function in inherited classed to allow for updates along with the rest of the GameObject hierarchy. Note that this is only for updating the game logic - any drawing functionality should be put into the draw function.

Parameters:
elapsedMilliseconds The amount of time in milliseconds which has passed since the last update
See also:
Game::runGame, draw

Reimplemented from GluonEngine::Component.

Definition at line 69 of file keyboardinputcomponent.cpp.

Property Documentation

KeyboardInputComponent::KeyName KeyboardInputComponent::keyCode [read, write]

Definition at line 38 of file keyboardinputcomponent.h.

The documentation for this class was generated from the following files:
Generated on Mon Dec 27 13:13:43 2010 for Gluon by  doxygen 1.6.3