UI_Keyboard.h

Go to the documentation of this file.

#ifndef __UI_Keyboard_h__
#define __UI_Keyboard_h__

#include "UI_KeyBindings.h"

enum UI_Keyboard : int
{
    UI_KEY_INVALID = 0,

    // Values of 0x00000001 through 0x0010FFFF represent unicode code points.
    //
    // We provide enumerators for a very small subset of these here.  Which
    // values in this range are actually used will depend on the keyboard
    // layout.  We generally use the upper-case code point for any code point
    // that is considered lower-case.
    //
    // Some of the keys representing control characters have special values
    // that differ from their unicode code point.

    UI_KEY_A     = 0x41,
    UI_KEY_B     = 0x42,
    UI_KEY_C     = 0x43,
    UI_KEY_D     = 0x44,
    UI_KEY_E     = 0x45,
    UI_KEY_F     = 0x46,
    UI_KEY_G     = 0x47,
    UI_KEY_H     = 0x48,
    UI_KEY_I     = 0x49,
    UI_KEY_J     = 0x4A,
    UI_KEY_K     = 0x4B,
    UI_KEY_L     = 0x4C,
    UI_KEY_M     = 0x4D,
    UI_KEY_N     = 0x4E,
    UI_KEY_O     = 0x4F,
    UI_KEY_P     = 0x50,
    UI_KEY_Q     = 0x51,
    UI_KEY_R     = 0x52,
    UI_KEY_S     = 0x53,
    UI_KEY_T     = 0x54,
    UI_KEY_U     = 0x55,
    UI_KEY_V     = 0x56,
    UI_KEY_W     = 0x57,
    UI_KEY_X     = 0x58,
    UI_KEY_Y     = 0x59,
    UI_KEY_Z     = 0x5A,
    UI_KEY_ZERO  = 0x30,
    UI_KEY_ONE   = 0x31,
    UI_KEY_TWO   = 0x32,
    UI_KEY_THREE = 0x33,
    UI_KEY_FOUR  = 0x34,
    UI_KEY_FIVE  = 0x35,
    UI_KEY_SIX   = 0x36,
    UI_KEY_SEVEN = 0x37,
    UI_KEY_EIGHT = 0x38,
    UI_KEY_NINE  = 0x39,

    UI_KEY_SEMICOLON    = 0x3B,
    UI_KEY_PERIOD       = 0x2E,
    UI_KEY_COMMA        = 0x2C,
    UI_KEY_SLASH        = 0x2F,
    UI_KEY_QUOTE        = 0x27,
    UI_KEY_ACCENTGRAVE  = 0x60, // really UI_KEY_LEFTQUOTE
    UI_KEY_MINUS        = 0x2D,
    UI_KEY_PLUS         = 0x2B,
    UI_KEY_VIRGULE      = 0xB4, // TODO: this is Qt::Key_acute, not a "virgule"?
    UI_KEY_BACKSLASH    = 0x5C,
    UI_KEY_EQUAL        = 0x3D,
    UI_KEY_LEFTBRACKET  = 0x5B,
    UI_KEY_RIGHTBRACKET = 0x5D,

    // Values for special keys not represented by a unicode code point start
    // at 0x00110000.  These must also be covered by the CHARACTER_BITS mask
    // (0x001FFFFF).

    UI_KEY_BREAK        = 0x00110000,
    UI_KEY_SETUP        = 0x00110001,
    UI_KEY_CAPSLOCK     = 0x00110002,

    UI_KEY_LEFTALT      = 0x00110003,
    UI_KEY_RIGHTALT     = 0x00110004,
    UI_KEY_LEFTCTRL     = 0x00110005,
    UI_KEY_RIGHTCTRL    = 0x00110006,
    UI_KEY_RIGHTSHIFT   = 0x00110007,
    UI_KEY_LEFTSHIFT    = 0x00110008,
    UI_KEY_COMMAND      = 0x00110009, /* OSX Only */

    UI_KEY_ESC          = 0x0011000A,
    UI_KEY_TAB          = 0x0011000B,
    UI_KEY_ENTER        = 0x0011000C,
    UI_KEY_SPACE        = 0x0011000D,
    UI_KEY_LINEFEED     = 0x0011000E,
    UI_KEY_BACKSPACE    = 0x0011000F,

    UI_KEY_LEFTARROW    = 0x00110010,
    UI_KEY_DOWNARROW    = 0x00110011,
    UI_KEY_RIGHTARROW   = 0x00110012,
    UI_KEY_UPARROW      = 0x00110013,

    UI_KEY_F1           = 0x00110014,
    UI_KEY_F2           = 0x00110015,
    UI_KEY_F3           = 0x00110016,
    UI_KEY_F4           = 0x00110017,
    UI_KEY_F5           = 0x00110018,
    UI_KEY_F6           = 0x00110019,
    UI_KEY_F7           = 0x0011001A,
    UI_KEY_F8           = 0x0011001B,
    UI_KEY_F9           = 0x0011001C,
    UI_KEY_F10          = 0x0011001D,
    UI_KEY_F11          = 0x0011001E,
    UI_KEY_F12          = 0x0011001F,
    UI_KEY_F13          = 0x00110020,
    UI_KEY_F14          = 0x00110021,
    UI_KEY_F15          = 0x00110022,
    UI_KEY_F16          = 0x00110023,
    UI_KEY_F17          = 0x00110024,
    UI_KEY_F18          = 0x00110025,
    UI_KEY_F19          = 0x00110026,
    UI_KEY_F20          = 0x00110027,
    UI_KEY_F21          = 0x00110028,
    UI_KEY_F22          = 0x00110029,
    UI_KEY_F23          = 0x0011002A,
    UI_KEY_F24          = 0x0011002B,
    UI_KEY_F25          = 0x0011002C,
    UI_KEY_F26          = 0x0011002D,
    UI_KEY_F27          = 0x0011002E,
    UI_KEY_F28          = 0x0011002F,
    UI_KEY_F29          = 0x00110030,
    UI_KEY_F30          = 0x00110031,
    UI_KEY_F31          = 0x00110032,
    UI_KEY_F32          = 0x00110033,
    UI_KEY_F33          = 0x00110034,
    UI_KEY_F34          = 0x00110035,
    UI_KEY_F35          = 0x00110036,

    UI_KEY_PRINTSCREEN  = 0x00110037,
    UI_KEY_SCROLLLOCK   = 0x00110038,
    UI_KEY_PAUSE        = 0x00110039,

    UI_KEY_INSERT       = 0x0011003A,
    UI_KEY_HOME         = 0x0011003B,
    UI_KEY_PAGEUP       = 0x0011003C,
    UI_KEY_DELETE       = 0x0011003D,
    UI_KEY_END          = 0x0011003E,
    UI_KEY_PAGEDOWN     = 0x0011003F,
    UI_KEY_CLEAR        = 0x00110040,

    UI_KEY_NUMLOCK      = 0x00110041,
    UI_KEY_PAD0         = 0x00110042,
    UI_KEY_PAD1         = 0x00110043,
    UI_KEY_PAD2         = 0x00110044,
    UI_KEY_PAD3         = 0x00110045,
    UI_KEY_PAD4         = 0x00110046,
    UI_KEY_PAD5         = 0x00110047,
    UI_KEY_PAD6         = 0x00110048,
    UI_KEY_PAD7         = 0x00110049,
    UI_KEY_PAD8         = 0x0011004A,
    UI_KEY_PAD9         = 0x0011004B,
    UI_KEY_PADPERIOD    = 0x0011004C,
    UI_KEY_PADMINUS     = 0x0011004D,
    UI_KEY_PADVIRGULE   = 0x0011004E,
    UI_KEY_PADASTER     = 0x0011004F,
    UI_KEY_PADPLUS      = 0x00110050,
    UI_KEY_PADSLASH     = 0x00110051,
};

// The following sentinel should only be used for validity checks, not for
// allocating fixed size arrays.
#define UI_KEY_MAX      UI_KEY_PADSLASH

#endif