keyevent.h

Go to the documentation of this file.

 
#pragma once
 
#include <promeki/core/event.h>
#include <promeki/core/string.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class KeyEvent : public Event {
        public:
                static const Type KeyPress;
                static const Type KeyRelease;
 
                enum Key {
                        Key_Unknown = 0,
                        // Printable ASCII range handled by char value
                        Key_Space = 32,
                        // Control keys
                        Key_Escape = 256,
                        Key_Enter,
                        Key_Tab,
                        Key_Backspace,
                        Key_Insert,
                        Key_Delete,
                        Key_Home,
                        Key_End,
                        Key_PageUp,
                        Key_PageDown,
                        // Arrow keys
                        Key_Up,
                        Key_Down,
                        Key_Left,
                        Key_Right,
                        // Function keys
                        Key_F1, Key_F2, Key_F3, Key_F4,
                        Key_F5, Key_F6, Key_F7, Key_F8,
                        Key_F9, Key_F10, Key_F11, Key_F12
                };
 
                enum Modifier : uint8_t {
                        NoModifier    = 0x00,
                        ShiftModifier = 0x01,
                        CtrlModifier  = 0x02,
                        AltModifier   = 0x04,
                        MetaModifier  = 0x08
                };
 
                KeyEvent(Type type, Key key, uint8_t modifiers = NoModifier,
                         const String &text = String())
                        : Event(type), _key(key), _modifiers(modifiers), _text(text) {}
 
                Key key() const { return _key; }
 
                uint8_t modifiers() const { return _modifiers; }
 
                const String &text() const { return _text; }
 
                bool isShift() const { return _modifiers & ShiftModifier; }
 
                bool isCtrl() const { return _modifiers & CtrlModifier; }
 
                bool isAlt() const { return _modifiers & AltModifier; }
 
                bool isMeta() const { return _modifiers & MetaModifier; }
 
                static String keyName(Key key);
 
                static String modifierString(uint8_t modifiers);
 
        private:
                Key             _key;
                uint8_t         _modifiers;
                String          _text;
};
 
PROMEKI_NAMESPACE_END