All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2013 Sam Lantinga <slouken@libsdl.org>
5  This software is provided 'as-is', without any express or implied
6  warranty. In no event will the authors be held liable for any damages
7  arising from the use of this software.
9  Permission is granted to anyone to use this software for any purpose,
10  including commercial applications, and to alter it and redistribute it
11  freely, subject to the following restrictions:
13  1. The origin of this software must not be misrepresented; you must not
14  claim that you wrote the original software. If you use this software
15  in a product, an acknowledgment in the product documentation would be
16  appreciated but is not required.
17  2. Altered source versions must be plainly marked as such, and must not be
18  misrepresented as being the original software.
19  3. This notice may not be removed or altered from any source distribution.
20 */
21 #include "SDL_config.h"
23 #ifndef _SDL_keyboard_c_h
24 #define _SDL_keyboard_c_h
26 #include "SDL_keycode.h"
27 #include "SDL_events.h"
29 /* Initialize the keyboard subsystem */
30 extern int SDL_KeyboardInit(void);
32 /* Clear the state of the keyboard */
33 extern void SDL_ResetKeyboard(void);
35 /* Get the default keymap */
36 extern void SDL_GetDefaultKeymap(SDL_Keycode * keymap);
38 /* Set the mapping of scancode to key codes */
39 extern void SDL_SetKeymap(int start, SDL_Keycode * keys, int length);
41 /* Set a platform-dependent key name, overriding the default platform-agnostic
42  name. Encoded as UTF-8. The string is not copied, thus the pointer given to
43  this function must stay valid forever (or at least until the call to
44  VideoQuit()). */
45 extern void SDL_SetScancodeName(SDL_Scancode scancode, const char *name);
47 /* Set the keyboard focus window */
48 extern void SDL_SetKeyboardFocus(SDL_Window * window);
50 /* Send a keyboard key event */
51 extern int SDL_SendKeyboardKey(Uint8 state, SDL_Scancode scancode);
53 /* Send keyboard text input */
54 extern int SDL_SendKeyboardText(const char *text);
56 /* Send editing text for selected range from start to end */
57 extern int SDL_SendEditingText(const char *text, int start, int end);
59 /* Shutdown the keyboard subsystem */
60 extern void SDL_KeyboardQuit(void);
62 #endif /* _SDL_keyboard_c_h */
64 /* vi: set ts=4 sw=4 expandtab: */
void SDL_GetDefaultKeymap(SDL_Keycode *keymap)
Definition: SDL_keyboard.c:579
void SDL_SetKeyboardFocus(SDL_Window *window)
Definition: SDL_keyboard.c:611
GLuint start
Definition: glew.h:1239
EGLImageKHR EGLint * name
Definition: eglext.h:284
int SDL_KeyboardInit(void)
Definition: SDL_keyboard.c:553
Sint32 SDL_Keycode
The SDL virtual key representation.
Definition: SDL_keycode.h:42
int SDL_SendKeyboardKey(Uint8 state, SDL_Scancode scancode)
Definition: SDL_keyboard.c:650
void SDL_SetKeymap(int start, SDL_Keycode *keys, int length)
Definition: SDL_keyboard.c:585
GLsizei GLsizei * length
Definition: gl2ext.h:792
int SDL_SendKeyboardText(const char *text)
Definition: SDL_keyboard.c:784
void SDL_SetScancodeName(SDL_Scancode scancode, const char *name)
Definition: SDL_keyboard.c:597
void SDL_KeyboardQuit(void)
Definition: SDL_keyboard.c:827
uint8_t Uint8
An unsigned 8-bit integer type.
Definition: SDL_stdinc.h:129
void SDL_ResetKeyboard(void)
Definition: SDL_keyboard.c:563
GLuint GLuint end
Definition: glew.h:1239
The SDL keyboard scancode representation.
Definition: SDL_scancode.h:43
int SDL_SendEditingText(const char *text, int start, int length)
Definition: SDL_keyboard.c:807