gcn::KeyListener Class Reference
#include <keylistener.h>
Public Member Functions | |
| virtual | ~KeyListener () |
| virtual bool | keyPress (const Key &key) |
| virtual bool | keyRelease (const Key &key) |
| virtual void | hotKeyPress (const Key &key) |
| virtual void | hotKeyRelease (const Key &key) |
Protected Member Functions | |
| KeyListener () | |
Detailed Description
Key listeners base class. Inorder to use this class you must inherit from it and implements it's functions. KeyListeners listen for key events on a Widgets. When a Widget recives a key event, the corresponding function in all it's key listeners will be called. Only focused Widgets will generate key events.
- See also:
- Widget::addKeyListener
Definition at line 74 of file keylistener.h.
Constructor & Destructor Documentation
| virtual gcn::KeyListener::~KeyListener | ( | ) | [inline, virtual] |
Destructor
Definition at line 81 of file keylistener.h.
| gcn::KeyListener::KeyListener | ( | ) | [inline, protected] |
Constructor.
You should not be able to make an instance of KeyListener, therefore its constructor is protected. To use KeyListener you must inherit from this class and implement it's functions.
Definition at line 111 of file keylistener.h.
Member Function Documentation
| virtual bool gcn::KeyListener::keyPress | ( | const Key & | key | ) | [inline, virtual] |
Called if a key is pressed when the widget has keyboard focus. If a key is held down the widget will generate multiple key presses.
- Parameters:
-
key the key pressed.
Reimplemented in gcn::Button, gcn::CheckBox, gcn::DropDown, gcn::ListBox, gcn::RadioButton, gcn::Slider, gcn::TextBox, and gcn::TextField.
Definition at line 90 of file keylistener.h.
| virtual bool gcn::KeyListener::keyRelease | ( | const Key & | key | ) | [inline, virtual] |
Called if a key is released when the widget has keyboard focus.
- Parameters:
-
key the key released.
Reimplemented in gcn::Button.
Definition at line 97 of file keylistener.h.
| virtual void gcn::KeyListener::hotKeyPress | ( | const Key & | key | ) | [inline, virtual] |
Definition at line 99 of file keylistener.h.
| virtual void gcn::KeyListener::hotKeyRelease | ( | const Key & | key | ) | [inline, virtual] |
Definition at line 100 of file keylistener.h.
The documentation for this class was generated from the following file:
