qf/quakeforge
0
0
Fork 0
mirror of https://git.code.sf.net/p/quake/quakeforge synced 2024-12-12 21:52:32 +00:00
Code Issues Projects Releases Packages Wiki Activity
quakeforge/include/QF/keys.h
Bill Currie 32a395a8d5 [dox] Fix up some doxygen issues 
I found a few doxygen related patches in my git stash and while testing
them, found a few doc issues.
2022-04-13 14:17:58 +09:00

415 lines
8.1 KiB
C
Raw Blame History

/*
keys.h
Key definitions and prototypes
Copyright (C) 1996-1997 Id Software, Inc.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to:
Free Software Foundation, Inc.
59 Temple Place - Suite 330
Boston, MA 02111-1307, USA
*/
#ifndef __QF_keys_h
#define __QF_keys_h
#ifndef __QFCC__
# include "QF/qtypes.h"
# include "QF/quakeio.h"
#endif
/** \defgroup input_keybinding Key Binding Sub-system
\ingroup input
*/
///@{
/// these are the key numbers that should be passed to Key_Event
/// FIXME clashes with actual inicode and OS keys
typedef enum {
/* The keyboard syms have been cleverly chosen to map to ASCII */
QFK_UNKNOWN = 0,
QFK_FIRST = 0,
QFK_BACKSPACE = 8,
QFK_TAB = 9,
QFK_CLEAR = 12,
QFK_RETURN = 13,
QFK_PAUSE = 19,
QFK_ESCAPE = 27,
QFK_SPACE = 32,
QFK_EXCLAIM = 33,
QFK_QUOTEDBL = 34,
QFK_HASH = 35,
QFK_DOLLAR = 36,
QFK_PERCENT = 37,
QFK_AMPERSAND = 38,
QFK_QUOTE = 39,
QFK_LEFTPAREN = 40,
QFK_RIGHTPAREN = 41,
QFK_ASTERISK = 42,
QFK_PLUS = 43,
QFK_COMMA = 44,
QFK_MINUS = 45,
QFK_PERIOD = 46,
QFK_SLASH = 47,
QFK_0 = 48,
QFK_1 = 49,
QFK_2 = 50,
QFK_3 = 51,
QFK_4 = 52,
QFK_5 = 53,
QFK_6 = 54,
QFK_7 = 55,
QFK_8 = 56,
QFK_9 = 57,
QFK_COLON = 58,
QFK_SEMICOLON = 59,
QFK_LESS = 60,
QFK_EQUALS = 61,
QFK_GREATER = 62,
QFK_QUESTION = 63,
QFK_AT = 64,
/*
Skip uppercase letters
*/
QFK_LEFTBRACKET = 91,
QFK_BACKSLASH = 92,
QFK_RIGHTBRACKET = 93,
QFK_CARET = 94,
QFK_UNDERSCORE = 95,
QFK_BACKQUOTE = 96,
QFK_a = 97,
QFK_b = 98,
QFK_c = 99,
QFK_d = 100,
QFK_e = 101,
QFK_f = 102,
QFK_g = 103,
QFK_h = 104,
QFK_i = 105,
QFK_j = 106,
QFK_k = 107,
QFK_l = 108,
QFK_m = 109,
QFK_n = 110,
QFK_o = 111,
QFK_p = 112,
QFK_q = 113,
QFK_r = 114,
QFK_s = 115,
QFK_t = 116,
QFK_u = 117,
QFK_v = 118,
QFK_w = 119,
QFK_x = 120,
QFK_y = 121,
QFK_z = 122,
QFK_BRACELEFT = 123,
QFK_BAR = 124,
QFK_BRACERIGHT = 125,
QFK_ASCIITILDE = 126,
QFK_DELETE = 127,
/* End of ASCII mapped keysyms */
/* International keyboard syms */
QFK_WORLD_0 = 160, /* 0xA0 */
QFK_WORLD_1 = 161,
QFK_WORLD_2 = 162,
QFK_WORLD_3 = 163,
QFK_WORLD_4 = 164,
QFK_WORLD_5 = 165,
QFK_WORLD_6 = 166,
QFK_WORLD_7 = 167,
QFK_WORLD_8 = 168,
QFK_WORLD_9 = 169,
QFK_WORLD_10 = 170,
QFK_WORLD_11 = 171,
QFK_WORLD_12 = 172,
QFK_WORLD_13 = 173,
QFK_WORLD_14 = 174,
QFK_WORLD_15 = 175,
QFK_WORLD_16 = 176,
QFK_WORLD_17 = 177,
QFK_WORLD_18 = 178,
QFK_WORLD_19 = 179,
QFK_WORLD_20 = 180,
QFK_WORLD_21 = 181,
QFK_WORLD_22 = 182,
QFK_WORLD_23 = 183,
QFK_WORLD_24 = 184,
QFK_WORLD_25 = 185,
QFK_WORLD_26 = 186,
QFK_WORLD_27 = 187,
QFK_WORLD_28 = 188,
QFK_WORLD_29 = 189,
QFK_WORLD_30 = 190,
QFK_WORLD_31 = 191,
QFK_WORLD_32 = 192,
QFK_WORLD_33 = 193,
QFK_WORLD_34 = 194,
QFK_WORLD_35 = 195,
QFK_WORLD_36 = 196,
QFK_WORLD_37 = 197,
QFK_WORLD_38 = 198,
QFK_WORLD_39 = 199,
QFK_WORLD_40 = 200,
QFK_WORLD_41 = 201,
QFK_WORLD_42 = 202,
QFK_WORLD_43 = 203,
QFK_WORLD_44 = 204,
QFK_WORLD_45 = 205,
QFK_WORLD_46 = 206,
QFK_WORLD_47 = 207,
QFK_WORLD_48 = 208,
QFK_WORLD_49 = 209,
QFK_WORLD_50 = 210,
QFK_WORLD_51 = 211,
QFK_WORLD_52 = 212,
QFK_WORLD_53 = 213,
QFK_WORLD_54 = 214,
QFK_WORLD_55 = 215,
QFK_WORLD_56 = 216,
QFK_WORLD_57 = 217,
QFK_WORLD_58 = 218,
QFK_WORLD_59 = 219,
QFK_WORLD_60 = 220,
QFK_WORLD_61 = 221,
QFK_WORLD_62 = 222,
QFK_WORLD_63 = 223,
QFK_WORLD_64 = 224,
QFK_WORLD_65 = 225,
QFK_WORLD_66 = 226,
QFK_WORLD_67 = 227,
QFK_WORLD_68 = 228,
QFK_WORLD_69 = 229,
QFK_WORLD_70 = 230,
QFK_WORLD_71 = 231,
QFK_WORLD_72 = 232,
QFK_WORLD_73 = 233,
QFK_WORLD_74 = 234,
QFK_WORLD_75 = 235,
QFK_WORLD_76 = 236,
QFK_WORLD_77 = 237,
QFK_WORLD_78 = 238,
QFK_WORLD_79 = 239,
QFK_WORLD_80 = 240,
QFK_WORLD_81 = 241,
QFK_WORLD_82 = 242,
QFK_WORLD_83 = 243,
QFK_WORLD_84 = 244,
QFK_WORLD_85 = 245,
QFK_WORLD_86 = 246,
QFK_WORLD_87 = 247,
QFK_WORLD_88 = 248,
QFK_WORLD_89 = 249,
QFK_WORLD_90 = 250,
QFK_WORLD_91 = 251,
QFK_WORLD_92 = 252,
QFK_WORLD_93 = 253,
QFK_WORLD_94 = 254,
QFK_WORLD_95 = 255, /* 0xFF */
/* Numeric keypad */
QFK_KP0 = 256,
QFK_KP1,
QFK_KP2,
QFK_KP3,
QFK_KP4,
QFK_KP5,
QFK_KP6,
QFK_KP7,
QFK_KP8,
QFK_KP9,
QFK_KP_PERIOD,
QFK_KP_DIVIDE,
QFK_KP_MULTIPLY,
QFK_KP_MINUS,
QFK_KP_PLUS,
QFK_KP_ENTER,
QFK_KP_EQUALS,
/* Arrows + Home/End pad */
QFK_UP,
QFK_DOWN,
QFK_RIGHT,
QFK_LEFT,
QFK_INSERT,
QFK_HOME,
QFK_END,
QFK_PAGEUP,
QFK_PAGEDOWN,
/* Function keys */
QFK_F1,
QFK_F2,
QFK_F3,
QFK_F4,
QFK_F5,
QFK_F6,
QFK_F7,
QFK_F8,
QFK_F9,
QFK_F10,
QFK_F11,
QFK_F12,
QFK_F13,
QFK_F14,
QFK_F15,
QFK_F16,
QFK_F17,
QFK_F18,
QFK_F19,
QFK_F20,
QFK_F21,
QFK_F22,
QFK_F23,
QFK_F24,
QFK_F25,
QFK_F26,
QFK_F27,
QFK_F28,
QFK_F29,
QFK_F30,
QFK_F31,
QFK_F32,
QFK_F33,
QFK_F34,
QFK_F35,
QFK_F36,
QFK_F37,
QFK_F38,
QFK_F39,
QFK_F40,
QFK_F41,
QFK_F42,
QFK_F43,
QFK_F44,
QFK_F45,
QFK_F46,
QFK_F47,
QFK_F48,
/* Key state modifier keys */
QFK_NUMLOCK,
QFK_CAPSLOCK,
QFK_SCROLLOCK,
QFK_RSHIFT,
QFK_LSHIFT,
QFK_RCTRL,
QFK_LCTRL,
QFK_RALT,
QFK_LALT,
QFK_RMETA,
QFK_LMETA,
QFK_LSUPER, /* Left "Windows" key */
QFK_RSUPER, /* Right "Windows" key */
QFK_MODE, /* "Alt Gr" key */
QFK_COMPOSE, /* Multi-key compose key */
/* Miscellaneous function keys */
QFK_HELP,
QFK_PRINT,
QFK_SYSREQ,
QFK_BREAK,
QFK_MENU,
QFK_POWER, /* Power Macintosh power key */
QFK_EURO, /* Some european keyboards */
QFK_UNDO,
/* Japanese keys */
QFK_KANJI, /* Kanji, Kanji convert */
QFK_MUHENKAN, /* Cancel Conversion */
QFK_HENKAN, /* Alias for Henkan_Mode */
QFK_ROMAJI, /* to Romaji */
QFK_HIRAGANA, /* to Hiragana */
QFK_KATAKANA, /* to Katakana */
QFK_HIRAGANA_KATAKANA, /* Hiragana/Katakana toggle */
QFK_ZENKAKU, /* to Zenkaku */
QFK_HANKAKU, /* to Hankaku */
QFK_ZENKAKU_HANKAKU, /* Zenkaku/Hankaku toggle */
QFK_TOUROKU, /* Add to Dictionary */
QFK_MASSYO, /* Delete from Dictionary */
QFK_KANA_LOCK, /* Kana Lock */
QFK_KANA_SHIFT, /* Kana Shift */
QFK_EISU_SHIFT, /* Alphanumeric Shift */
QFK_EISU_TOGGLE, /* Alphanumeric toggle */
QFK_KANJI_BANGOU, /* Codeinput */
QFK_ZEN_KOHO, /* Multiple/All Candidate(s) */
QFK_MAE_KOHO, /* Previous Candidate */
/* some multi-media/browser keys */
QFK_HOMEPAGE,
QFK_SEARCH,
QFK_MAIL,
QFK_FAVORITES,
QFK_AUDIOMUTE,
QFK_AUDIOLOWERVOLUME,
QFK_AUDIORAISEVOLUME,
QFK_AUDIOPLAY,
QFK_CALCULATOR,
QFK_REDO,
QFK_NEW,
QFK_RELOAD,
QFK_OPEN,
QFK_CLOSE,
QFK_REPLY,
QFK_MAILFORWARD,
QFK_SEND,
QFK_SAVE,
QFK_BACK,
QFK_FORWARD,
QFK_LAST
} knum_t;
#ifndef __QFCC__
/** Get the string representation of a key.
Returns a string (a QFK_* name) for the given keynum.
\param keynum The key for which to get the string.
\return The string representation of the key.
*/
const char *Key_KeynumToString (knum_t keynum) __attribute__((pure));
/** Get the keynum for the named key.
Returns a key number to be used to index keybindings[] by looking at
the given string. Single ascii characters return themselves, while
the QFK_* names are matched up.
\param str The name of the key.
\return The named key if valid, otherwise -1
*/
int Key_StringToKeynum (const char *str) __attribute__((pure));
struct progs_s;
//FIXME location
/** Add the Key builtins to the specified progs instance.
*/
void RUA_Key_Init (struct progs_s *pr);
#endif
//FIXME location
void GIB_Key_Init (void);
///@}
#endif//__QF_keys_h
Reference in a new issue View git blame Copy permalink