Mercurial > sdl-ios-xcode
annotate include/SDL_keyboard.h @ 1673:624e1412fbba SDL-1.3
Keyboard code update in progress
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Sat, 10 Jun 2006 09:11:59 +0000 |
parents | 4da1ee79c9af |
children | 7688a73b25b1 |
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 | |
1673
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
44 /** |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
45 * \struct SDL_keysym |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
46 * |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
47 * \brief The SDL keysym structure, used in key events. |
0 | 48 */ |
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
|
49 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
|
50 { |
1673
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
51 Uint8 scancode; /**< keyboard specific scancode */ |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
52 SDLKey sym; /**< SDL virtual keysym */ |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
53 SDLMod mod; /**< current key modifiers */ |
0 | 54 } SDL_keysym; |
55 | |
1673
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
56 /* Function prototypes */ |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
57 |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
58 /** |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
59 * \fn int SDL_GetNumKeyboards(void) |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
60 * |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
61 * \brief Get the number of keyboard input devices available. |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
62 * |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
63 * \sa SDL_SelectKeyboard() |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
64 */ |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
65 extern DECLSPEC int SDLCALL SDL_GetNumKeyboards(void); |
0 | 66 |
1673
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
67 /** |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
68 * \fn int SDL_SelectKeyboard(int index) |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
69 * |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
70 * \brief Set the index of the currently selected keyboard. |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
71 * |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
72 * \return The index of the previously selected keyboard. |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
73 * |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
74 * \note You can query the currently selected keyboard by passing an index of -1. |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
75 * |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
76 * \sa SDL_GetNumKeyboards() |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
77 */ |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
78 extern DECLSPEC int SDLCALL SDL_SelectKeyboard(int index); |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
79 |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
80 /** |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
81 * \fn int SDL_EnableUNICODE(int enable) |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
82 * |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
83 * \brief Enable/Disable UNICODE translation of keyboard input. |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
84 * |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
85 * \param enable 1 to enable translation, 0 to disable translation, -1 to query translation |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
86 * |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
87 * \return The previous state of keyboard translation |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
88 * |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
89 * \note This translation has some overhead, so translation defaults off. |
0 | 90 */ |
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
91 extern DECLSPEC int SDLCALL SDL_EnableUNICODE(int enable); |
0 | 92 |
1673
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
93 /** |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
94 * \fn int SDL_EnableKeyRepeat(int delay, int interval) |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
95 * |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
96 * \brief Enable keyboard repeat for the selected keyboard. |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
97 * |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
98 * \param delay The initial delay in milliseconds between the time when a |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
99 * key is pressed and keyboard repeat begins. Setting a delay |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
100 * of 0 will disable keyboard repeat. |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
101 * \param interval The time in milliseconds between keyboard repeat events. |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
102 * |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
103 * \return 0 on success, or -1 if there was an error. |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
104 * |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
105 * \note Keyboard repeat defaults to off. |
0 | 106 */ |
107 #define SDL_DEFAULT_REPEAT_DELAY 500 | |
108 #define SDL_DEFAULT_REPEAT_INTERVAL 30 | |
1673
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
109 /**/ |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
110 extern DECLSPEC int SDLCALL SDL_EnableKeyRepeat(int delay, int interval); |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
111 |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
112 /** |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
113 * \fn void SDL_GetKeyRepeat(int *delay, int *interval) |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
114 * |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
115 * \brief Get the current keyboard repeat setting for the selected keyboard. |
0 | 116 */ |
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
117 extern DECLSPEC void SDLCALL SDL_GetKeyRepeat(int *delay, int *interval); |
0 | 118 |
1673
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
119 /** |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
120 * \fn Uint8 *SDL_GetKeyState(int *numkeys) |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
121 * |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
122 * \brief Get a snapshot of the current state of the selected keyboard. |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
123 * |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
124 * \return An array of keystates, indexed by the SDLK_* syms. |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
125 * |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
126 * Example: |
0 | 127 * Uint8 *keystate = SDL_GetKeyState(NULL); |
128 * if ( keystate[SDLK_RETURN] ) ... <RETURN> is pressed. | |
129 */ | |
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
130 extern DECLSPEC Uint8 *SDLCALL SDL_GetKeyState(int *numkeys); |
0 | 131 |
1673
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
132 /** |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
133 * \fn SDLMod SDL_GetModState(void) |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
134 * |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
135 * \brief Get the current key modifier state for the selected keyboard. |
0 | 136 */ |
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
137 extern DECLSPEC SDLMod SDLCALL SDL_GetModState(void); |
0 | 138 |
1673
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
139 /** |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
140 * \fn void SDL_SetModState(SDLMod modstate) |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
141 * |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
142 * \brief Set the current key modifier state for the selected keyboard. |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
143 * |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
144 * \note This does not change the keyboard state, only the key modifier flags. |
0 | 145 */ |
1668
4da1ee79c9af
more tweaking indent options
Sam Lantinga <slouken@libsdl.org>
parents:
1662
diff
changeset
|
146 extern DECLSPEC void SDLCALL SDL_SetModState(SDLMod modstate); |
0 | 147 |
1673
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
148 /** |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
149 * \fn const char *SDL_GetKeyName(SDLKey key) |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
150 * |
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
151 * \brief Get the name of an SDL virtual keysym |
0 | 152 */ |
1673
624e1412fbba
Keyboard code update in progress
Sam Lantinga <slouken@libsdl.org>
parents:
1668
diff
changeset
|
153 extern DECLSPEC const char *SDLCALL SDL_GetKeyName(SDLKey key); |
0 | 154 |
155 | |
156 /* Ends C function definitions when using C++ */ | |
157 #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
|
158 /* *INDENT-OFF* */ |
0 | 159 } |
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
|
160 /* *INDENT-ON* */ |
0 | 161 #endif |
162 #include "close_code.h" | |
163 | |
164 #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
|
165 |
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
|
166 /* vi: set ts=4 sw=4 expandtab: */ |