Xrb::EventKey Class Reference
Baseclass for all keyboard events. More...
#include <xrb_input_events.hpp>
Public Member Functions | |
| EventKey (Key::Code code, Key::Modifier modifier, Float time, EventType event_type) | |
| Constructs an EventKey with the given parameters. | |
| virtual | ~EventKey ()=0 |
| Pure virtual destructor. | |
| virtual bool | IsKeyEvent () const |
| Override of Event::IsKeyEvent to indicate that this is, indeed, a key event. | |
| Key::Code | KeyCode () const |
| Returns the Xrb::Key::Code enum for this key event. | |
| Key::Modifier | KeyModifier () const |
| Returns the Xrb::Key::Modifier flags for this key event. | |
| bool | IsEitherAltKeyPressed () const |
| Returns true iff either left or right alt keys were pressed when this key event was generated. | |
| bool | IsEitherControlKeyPressed () const |
| Returns true iff either left or right control keys were pressed when this key event was generated. | |
| bool | IsEitherShiftKeyPressed () const |
| Returns true iff either left or right shift keys were pressed when this key event was generated. | |
| char | ModifiedAscii () const |
| Returns the ascii code of the key event, modified by capslock, numlock, and shift key modifiers. | |
| virtual bool | IsKeyDownEvent () const |
| Returns true iff this is a key down event. | |
| virtual bool | IsKeyUpEvent () const |
| Returns true iff this is a key up event. | |
| virtual bool | IsKeyRepeatEvent () const |
| Returns true iff this is a key repeat event. | |
Detailed Description
Baseclass for all keyboard events.Provides accessors for checking if any of the key modifiers (shift, control, alt) were active during this event. Provides accessors for retrieving the key code via enumerated Xrb::Key::Code as well as text-oriented ASCII codes.
Definition at line 46 of file xrb_input_events.hpp.
Constructor & Destructor Documentation
| Xrb::EventKey::~EventKey | ( | ) | [pure virtual] |
Pure virtual destructor.
EventKey is an abstract baseclass.
Definition at line 81 of file xrb_input_events.cpp.
Member Function Documentation
| virtual bool Xrb::EventKey::IsKeyDownEvent | ( | ) | const [inline, virtual] |
Returns true iff this is a key down event.
Virtual method for subclasses to override to indicate if they are a key down event.
Reimplemented in Xrb::EventKeyDown.
Definition at line 97 of file xrb_input_events.hpp.
Referenced by Xrb::Dialog::ProcessKeyEvent().
| virtual bool Xrb::EventKey::IsKeyUpEvent | ( | ) | const [inline, virtual] |
Returns true iff this is a key up event.
Virtual method for subclasses to override to indicate if they are a key up event.
Reimplemented in Xrb::EventKeyUp.
Definition at line 102 of file xrb_input_events.hpp.
| virtual bool Xrb::EventKey::IsKeyRepeatEvent | ( | ) | const [inline, virtual] |
Returns true iff this is a key repeat event.
Virtual method for subclasses to override to indicate if they are a key repeat event.
Reimplemented in Xrb::EventKeyRepeat.
Definition at line 107 of file xrb_input_events.hpp.
The documentation for this class was generated from the following files:
