1.1 --- a/include/SDL_keysym.h Mon Sep 21 09:27:08 2009 +0000
1.2 +++ b/include/SDL_keysym.h Mon Sep 21 09:38:10 2009 +0000
1.3 @@ -23,14 +23,16 @@
1.4 #ifndef _SDL_keysym_h
1.5 #define _SDL_keysym_h
1.6
1.7 -/* What we really want is a mapping of every raw key on the keyboard.
1.8 - To support international keyboards, we use the range 0xA1 - 0xFF
1.9 - as international virtual keycodes. We'll follow in the footsteps of X11...
1.10 - The names of the keys
1.11 +/** What we really want is a mapping of every raw key on the keyboard.
1.12 + * To support international keyboards, we use the range 0xA1 - 0xFF
1.13 + * as international virtual keycodes. We'll follow in the footsteps of X11...
1.14 + * @brief The names of the keys
1.15 */
1.16 -
1.17 typedef enum {
1.18 - /* The keyboard syms have been cleverly chosen to map to ASCII */
1.19 + /** @name ASCII mapped keysyms
1.20 + * The keyboard syms have been cleverly chosen to map to ASCII
1.21 + */
1.22 + /*@{*/
1.23 SDLK_UNKNOWN = 0,
1.24 SDLK_FIRST = 0,
1.25 SDLK_BACKSPACE = 8,
1.26 @@ -108,8 +110,10 @@
1.27 SDLK_z = 122,
1.28 SDLK_DELETE = 127,
1.29 /* End of ASCII mapped keysyms */
1.30 + /*@}*/
1.31
1.32 - /* International keyboard syms */
1.33 + /** @name International keyboard syms */
1.34 + /*@{*/
1.35 SDLK_WORLD_0 = 160, /* 0xA0 */
1.36 SDLK_WORLD_1 = 161,
1.37 SDLK_WORLD_2 = 162,
1.38 @@ -206,8 +210,10 @@
1.39 SDLK_WORLD_93 = 253,
1.40 SDLK_WORLD_94 = 254,
1.41 SDLK_WORLD_95 = 255, /* 0xFF */
1.42 + /*@}*/
1.43
1.44 - /* Numeric keypad */
1.45 + /** @name Numeric keypad */
1.46 + /*@{*/
1.47 SDLK_KP0 = 256,
1.48 SDLK_KP1 = 257,
1.49 SDLK_KP2 = 258,
1.50 @@ -225,8 +231,10 @@
1.51 SDLK_KP_PLUS = 270,
1.52 SDLK_KP_ENTER = 271,
1.53 SDLK_KP_EQUALS = 272,
1.54 + /*@}*/
1.55
1.56 - /* Arrows + Home/End pad */
1.57 + /** @name Arrows + Home/End pad */
1.58 + /*@{*/
1.59 SDLK_UP = 273,
1.60 SDLK_DOWN = 274,
1.61 SDLK_RIGHT = 275,
1.62 @@ -236,8 +244,10 @@
1.63 SDLK_END = 279,
1.64 SDLK_PAGEUP = 280,
1.65 SDLK_PAGEDOWN = 281,
1.66 + /*@}*/
1.67
1.68 - /* Function keys */
1.69 + /** @name Function keys */
1.70 + /*@{*/
1.71 SDLK_F1 = 282,
1.72 SDLK_F2 = 283,
1.73 SDLK_F3 = 284,
1.74 @@ -253,8 +263,10 @@
1.75 SDLK_F13 = 294,
1.76 SDLK_F14 = 295,
1.77 SDLK_F15 = 296,
1.78 + /*@}*/
1.79
1.80 - /* Key state modifier keys */
1.81 + /** @name Key state modifier keys */
1.82 + /*@{*/
1.83 SDLK_NUMLOCK = 300,
1.84 SDLK_CAPSLOCK = 301,
1.85 SDLK_SCROLLOCK = 302,
1.86 @@ -266,27 +278,30 @@
1.87 SDLK_LALT = 308,
1.88 SDLK_RMETA = 309,
1.89 SDLK_LMETA = 310,
1.90 - SDLK_LSUPER = 311, /* Left "Windows" key */
1.91 - SDLK_RSUPER = 312, /* Right "Windows" key */
1.92 - SDLK_MODE = 313, /* "Alt Gr" key */
1.93 - SDLK_COMPOSE = 314, /* Multi-key compose key */
1.94 + SDLK_LSUPER = 311, /**< Left "Windows" key */
1.95 + SDLK_RSUPER = 312, /**< Right "Windows" key */
1.96 + SDLK_MODE = 313, /**< "Alt Gr" key */
1.97 + SDLK_COMPOSE = 314, /**< Multi-key compose key */
1.98 + /*@}*/
1.99
1.100 - /* Miscellaneous function keys */
1.101 + /** @name Miscellaneous function keys */
1.102 + /*@{*/
1.103 SDLK_HELP = 315,
1.104 SDLK_PRINT = 316,
1.105 SDLK_SYSREQ = 317,
1.106 SDLK_BREAK = 318,
1.107 SDLK_MENU = 319,
1.108 - SDLK_POWER = 320, /* Power Macintosh power key */
1.109 - SDLK_EURO = 321, /* Some european keyboards */
1.110 - SDLK_UNDO = 322, /* Atari keyboard has Undo */
1.111 + SDLK_POWER = 320, /**< Power Macintosh power key */
1.112 + SDLK_EURO = 321, /**< Some european keyboards */
1.113 + SDLK_UNDO = 322, /**< Atari keyboard has Undo */
1.114 + /*@}*/
1.115
1.116 /* Add any other keys here */
1.117
1.118 SDLK_LAST
1.119 } SDLKey;
1.120
1.121 -/* Enumeration of valid key mods (possibly OR'd together) */
1.122 +/** Enumeration of valid key mods (possibly OR'd together) */
1.123 typedef enum {
1.124 KMOD_NONE = 0x0000,
1.125 KMOD_LSHIFT= 0x0001,