include/SDL_keysym.h
branchSDL-1.3
changeset 1673 624e1412fbba
parent 1662 782fd950bd46
--- a/include/SDL_keysym.h	Fri Jun 09 07:06:12 2006 +0000
+++ b/include/SDL_keysym.h	Sat Jun 10 09:11:59 2006 +0000
@@ -27,12 +27,16 @@
 #ifndef _SDL_keysym_h
 #define _SDL_keysym_h
 
-/* What we really want is a mapping of every raw key on the keyboard.
-   To support international keyboards, we use the range 0xA1 - 0xFF
-   as international virtual keycodes.  We'll follow in the footsteps of X11...
-   The names of the keys
+/**
+ * \enum SDLKey
+ *
+ * \brief The SDL virtual key representation
+ *
+ * The SDLKey represents the unmodified character printed on the key
+ * for the current keyboard layout.  The first 255 characters are used
+ * unchanged from Latin-1, e.g. a key with 'a' on it will have the value "a".
+ * The rest of the keys are named below, and fall into the range above 255.
  */
-
 typedef enum
 {
     /* The keyboard syms have been cleverly chosen to map to ASCII */
@@ -114,104 +118,6 @@
     SDLK_DELETE = 127,
     /* End of ASCII mapped keysyms */
 
-    /* International keyboard syms */
-    SDLK_WORLD_0 = 160,         /* 0xA0 */
-    SDLK_WORLD_1 = 161,
-    SDLK_WORLD_2 = 162,
-    SDLK_WORLD_3 = 163,
-    SDLK_WORLD_4 = 164,
-    SDLK_WORLD_5 = 165,
-    SDLK_WORLD_6 = 166,
-    SDLK_WORLD_7 = 167,
-    SDLK_WORLD_8 = 168,
-    SDLK_WORLD_9 = 169,
-    SDLK_WORLD_10 = 170,
-    SDLK_WORLD_11 = 171,
-    SDLK_WORLD_12 = 172,
-    SDLK_WORLD_13 = 173,
-    SDLK_WORLD_14 = 174,
-    SDLK_WORLD_15 = 175,
-    SDLK_WORLD_16 = 176,
-    SDLK_WORLD_17 = 177,
-    SDLK_WORLD_18 = 178,
-    SDLK_WORLD_19 = 179,
-    SDLK_WORLD_20 = 180,
-    SDLK_WORLD_21 = 181,
-    SDLK_WORLD_22 = 182,
-    SDLK_WORLD_23 = 183,
-    SDLK_WORLD_24 = 184,
-    SDLK_WORLD_25 = 185,
-    SDLK_WORLD_26 = 186,
-    SDLK_WORLD_27 = 187,
-    SDLK_WORLD_28 = 188,
-    SDLK_WORLD_29 = 189,
-    SDLK_WORLD_30 = 190,
-    SDLK_WORLD_31 = 191,
-    SDLK_WORLD_32 = 192,
-    SDLK_WORLD_33 = 193,
-    SDLK_WORLD_34 = 194,
-    SDLK_WORLD_35 = 195,
-    SDLK_WORLD_36 = 196,
-    SDLK_WORLD_37 = 197,
-    SDLK_WORLD_38 = 198,
-    SDLK_WORLD_39 = 199,
-    SDLK_WORLD_40 = 200,
-    SDLK_WORLD_41 = 201,
-    SDLK_WORLD_42 = 202,
-    SDLK_WORLD_43 = 203,
-    SDLK_WORLD_44 = 204,
-    SDLK_WORLD_45 = 205,
-    SDLK_WORLD_46 = 206,
-    SDLK_WORLD_47 = 207,
-    SDLK_WORLD_48 = 208,
-    SDLK_WORLD_49 = 209,
-    SDLK_WORLD_50 = 210,
-    SDLK_WORLD_51 = 211,
-    SDLK_WORLD_52 = 212,
-    SDLK_WORLD_53 = 213,
-    SDLK_WORLD_54 = 214,
-    SDLK_WORLD_55 = 215,
-    SDLK_WORLD_56 = 216,
-    SDLK_WORLD_57 = 217,
-    SDLK_WORLD_58 = 218,
-    SDLK_WORLD_59 = 219,
-    SDLK_WORLD_60 = 220,
-    SDLK_WORLD_61 = 221,
-    SDLK_WORLD_62 = 222,
-    SDLK_WORLD_63 = 223,
-    SDLK_WORLD_64 = 224,
-    SDLK_WORLD_65 = 225,
-    SDLK_WORLD_66 = 226,
-    SDLK_WORLD_67 = 227,
-    SDLK_WORLD_68 = 228,
-    SDLK_WORLD_69 = 229,
-    SDLK_WORLD_70 = 230,
-    SDLK_WORLD_71 = 231,
-    SDLK_WORLD_72 = 232,
-    SDLK_WORLD_73 = 233,
-    SDLK_WORLD_74 = 234,
-    SDLK_WORLD_75 = 235,
-    SDLK_WORLD_76 = 236,
-    SDLK_WORLD_77 = 237,
-    SDLK_WORLD_78 = 238,
-    SDLK_WORLD_79 = 239,
-    SDLK_WORLD_80 = 240,
-    SDLK_WORLD_81 = 241,
-    SDLK_WORLD_82 = 242,
-    SDLK_WORLD_83 = 243,
-    SDLK_WORLD_84 = 244,
-    SDLK_WORLD_85 = 245,
-    SDLK_WORLD_86 = 246,
-    SDLK_WORLD_87 = 247,
-    SDLK_WORLD_88 = 248,
-    SDLK_WORLD_89 = 249,
-    SDLK_WORLD_90 = 250,
-    SDLK_WORLD_91 = 251,
-    SDLK_WORLD_92 = 252,
-    SDLK_WORLD_93 = 253,
-    SDLK_WORLD_94 = 254,
-    SDLK_WORLD_95 = 255,        /* 0xFF */
-
     /* Numeric keypad */
     SDLK_KP0 = 256,
     SDLK_KP1 = 257,
@@ -271,10 +177,10 @@
     SDLK_LALT = 308,
     SDLK_RMETA = 309,
     SDLK_LMETA = 310,
-    SDLK_LSUPER = 311,          /* Left "Windows" key */
-    SDLK_RSUPER = 312,          /* Right "Windows" key */
-    SDLK_MODE = 313,            /* "Alt Gr" key */
-    SDLK_COMPOSE = 314,         /* Multi-key compose key */
+    SDLK_LSUPER = 311,          /**< Left "Windows" key */
+    SDLK_RSUPER = 312,          /**< Right "Windows" key */
+    SDLK_MODE = 313,            /**< "Alt Gr" key */
+    SDLK_COMPOSE = 314,         /**< Multi-key compose key */
 
     /* Miscellaneous function keys */
     SDLK_HELP = 315,
@@ -282,16 +188,20 @@
     SDLK_SYSREQ = 317,
     SDLK_BREAK = 318,
     SDLK_MENU = 319,
-    SDLK_POWER = 320,           /* Power Macintosh power key */
-    SDLK_EURO = 321,            /* Some european keyboards */
-    SDLK_UNDO = 322,            /* Atari keyboard has Undo */
+    SDLK_POWER = 320,           /**< Power Macintosh power key */
+    SDLK_EURO = 321,            /**< Some european keyboards */
+    SDLK_UNDO = 322,            /**< Atari keyboard has Undo */
 
     /* Add any other keys here */
 
     SDLK_LAST
 } SDLKey;
 
-/* Enumeration of valid key mods (possibly OR'd together) */
+/**
+ * \enum SDLMod
+ *
+ * \brief Enumeration of valid key mods (possibly OR'd together)
+ */
 typedef enum
 {
     KMOD_NONE = 0x0000,