Mercurial > sdl-ios-xcode
annotate include/SDL_keyboard.h @ 1668:4da1ee79c9af SDL-1.3
more tweaking indent options
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Mon, 29 May 2006 04:04:35 +0000 |
| parents | 782fd950bd46 |
| children | 624e1412fbba |
| rev | line source |
|---|---|
| 0 | 1 /* |
| 2 SDL - Simple DirectMedia Layer | |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
3 Copyright (C) 1997-2006 Sam Lantinga |
| 0 | 4 |
| 5 This library is free software; you can redistribute it and/or | |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
6 modify it under the terms of the GNU Lesser General Public |
| 0 | 7 License as published by the Free Software Foundation; either |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
8 version 2.1 of the License, or (at your option) any later version. |
| 0 | 9 |
| 10 This library is distributed in the hope that it will be useful, | |
| 11 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
13 Lesser General Public License for more details. |
| 0 | 14 |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
15 You should have received a copy of the GNU Lesser General Public |
|
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
16 License along with this library; if not, write to the Free Software |
|
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
| 0 | 18 |
| 19 Sam Lantinga | |
|
251
b8688cfdc232
Updated the headers with the correct e-mail address
Sam Lantinga <slouken@libsdl.org>
parents:
0
diff
changeset
|
20 slouken@libsdl.org |
| 0 | 21 */ |
| 22 | |
|
1662
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1507
diff
changeset
|
23 /** |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1507
diff
changeset
|
24 * \file SDL_keyboard.h |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1507
diff
changeset
|
25 * |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1507
diff
changeset
|
26 * Include file for SDL keyboard event handling |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1507
diff
changeset
|
27 */ |
| 0 | 28 |
| 29 #ifndef _SDL_keyboard_h | |
| 30 #define _SDL_keyboard_h | |
| 31 | |
|
1356
67114343400d
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
32 #include "SDL_stdinc.h" |
|
1358
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
33 #include "SDL_error.h" |
| 0 | 34 #include "SDL_keysym.h" |
| 35 | |
| 36 #include "begin_code.h" | |
| 37 /* Set up for C function definitions, even when using C++ */ | |
| 38 #ifdef __cplusplus | |
|
1662
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1507
diff
changeset
|
39 /* *INDENT-OFF* */ |
| 0 | 40 extern "C" { |
|
1662
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1507
diff
changeset
|
41 /* *INDENT-ON* */ |
| 0 | 42 #endif |
| 43 | |
| 44 /* Keysym structure | |
| 45 - The scancode is hardware dependent, and should not be used by general | |
| 46 applications. If no hardware scancode is available, it will be 0. | |
| 47 | |
| 48 - The 'unicode' translated character is only available when character | |
| 49 translation is enabled by the SDL_EnableUNICODE() API. If non-zero, | |
| 50 this is a UNICODE character corresponding to the keypress. If the | |
| 51 high 9 bits of the character are 0, then this maps to the equivalent | |
| 52 ASCII character: | |
| 53 char ch; | |
| 54 if ( (keysym.unicode & 0xFF80) == 0 ) { | |
| 55 ch = keysym.unicode & 0x7F; | |
| 56 } else { | |
| 57 An international character.. | |
| 58 } | |
| 59 */ | |
|
1662
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1507
diff
changeset
|
60 typedef struct SDL_keysym |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1507
diff
changeset
|
61 { |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1507
diff
changeset
|
62 Uint8 scancode; /* hardware specific scancode */ |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1507
diff
changeset
|
63 SDLKey sym; /* SDL virtual keysym */ |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1507
diff
changeset
|
64 SDLMod mod; /* current key modifiers */ |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1507
diff
changeset
|
65 Uint16 unicode; /* translated character */ |
| 0 | 66 } SDL_keysym; |
| 67 | |
| 68 /* This is the mask which refers to all hotkey bindings */ | |
| 69 #define SDL_ALL_HOTKEYS 0xFFFFFFFF | |
| 70 | |
| 71 /* Function prototypes */ | |
| 72 /* | |
| 73 * Enable/Disable UNICODE translation of keyboard input. | |
| 74 * This translation has some overhead, so translation defaults off. | |
| 75 * If 'enable' is 1, translation is enabled. | |
| 76 * If 'enable' is 0, translation is disabled. | |
| 77 * If 'enable' is -1, the translation state is not changed. | |
| 78 * It returns the previous state of keyboard translation. | |
| 79 */ | |
|
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
80 extern DECLSPEC int SDLCALL SDL_EnableUNICODE(int enable); |
| 0 | 81 |
| 82 /* | |
| 83 * Enable/Disable keyboard repeat. Keyboard repeat defaults to off. | |
| 84 * 'delay' is the initial delay in ms between the time when a key is | |
| 85 * pressed, and keyboard repeat begins. | |
| 86 * 'interval' is the time in ms between keyboard repeat events. | |
| 87 */ | |
| 88 #define SDL_DEFAULT_REPEAT_DELAY 500 | |
| 89 #define SDL_DEFAULT_REPEAT_INTERVAL 30 | |
| 90 /* | |
| 91 * If 'delay' is set to 0, keyboard repeat is disabled. | |
| 92 */ | |
|
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
93 extern DECLSPEC int SDLCALL SDL_EnableKeyRepeat(int delay, int interval); |
|
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
94 extern DECLSPEC void SDLCALL SDL_GetKeyRepeat(int *delay, int *interval); |
| 0 | 95 |
| 96 /* | |
| 97 * Get a snapshot of the current state of the keyboard. | |
| 98 * Returns an array of keystates, indexed by the SDLK_* syms. | |
| 99 * Used: | |
| 100 * Uint8 *keystate = SDL_GetKeyState(NULL); | |
| 101 * if ( keystate[SDLK_RETURN] ) ... <RETURN> is pressed. | |
| 102 */ | |
|
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
103 extern DECLSPEC Uint8 *SDLCALL SDL_GetKeyState(int *numkeys); |
| 0 | 104 |
| 105 /* | |
| 106 * Get the current key modifier state | |
| 107 */ | |
|
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
108 extern DECLSPEC SDLMod SDLCALL SDL_GetModState(void); |
| 0 | 109 |
| 110 /* | |
| 111 * Set the current key modifier state | |
| 112 * This does not change the keyboard state, only the key modifier flags. | |
| 113 */ | |
|
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
114 extern DECLSPEC void SDLCALL SDL_SetModState(SDLMod modstate); |
| 0 | 115 |
| 116 /* | |
| 117 * Get the name of an SDL virtual keysym | |
| 118 */ | |
|
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
119 extern DECLSPEC char *SDLCALL SDL_GetKeyName(SDLKey key); |
| 0 | 120 |
| 121 | |
| 122 /* Ends C function definitions when using C++ */ | |
| 123 #ifdef __cplusplus | |
|
1662
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1507
diff
changeset
|
124 /* *INDENT-OFF* */ |
| 0 | 125 } |
|
1662
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1507
diff
changeset
|
126 /* *INDENT-ON* */ |
| 0 | 127 #endif |
| 128 #include "close_code.h" | |
| 129 | |
| 130 #endif /* _SDL_keyboard_h */ | |
|
1662
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1507
diff
changeset
|
131 |
|
782fd950bd46
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.
Sam Lantinga <slouken@libsdl.org>
parents:
1507
diff
changeset
|
132 /* vi: set ts=4 sw=4 expandtab: */ |