SDL  2.0
SDL_keyboard_c.h
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2016 Sam Lantinga <slouken@libsdl.org>
4 
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.
8 
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:
12 
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_internal.h"
22 
23 #ifndef _SDL_keyboard_c_h
24 #define _SDL_keyboard_c_h
25 
26 #include "SDL_keycode.h"
27 #include "SDL_events.h"
28 
29 /* Initialize the keyboard subsystem */
30 extern int SDL_KeyboardInit(void);
31 
32 /* Clear the state of the keyboard */
33 extern void SDL_ResetKeyboard(void);
34 
35 /* Get the default keymap */
36 extern void SDL_GetDefaultKeymap(SDL_Keycode * keymap);
37 
38 /* Set the mapping of scancode to key codes */
39 extern void SDL_SetKeymap(int start, SDL_Keycode * keys, int length);
40 
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);
46 
47 /* Set the keyboard focus window */
49 
50 /* Send a keyboard key event */
51 extern int SDL_SendKeyboardKey(Uint8 state, SDL_Scancode scancode);
52 
53 /* Send keyboard text input */
54 extern int SDL_SendKeyboardText(const char *text);
55 
56 /* Send editing text for selected range from start to end */
57 extern int SDL_SendEditingText(const char *text, int start, int end);
58 
59 /* Shutdown the keyboard subsystem */
60 extern void SDL_KeyboardQuit(void);
61 
62 /* Convert to UTF-8 */
63 extern char *SDL_UCS4ToUTF8(Uint32 ch, char *dst);
64 
65 /* Toggle on or off pieces of the keyboard mod state. */
66 extern void SDL_ToggleModState(const SDL_Keymod modstate, const SDL_bool toggle);
67 
68 #endif /* _SDL_keyboard_c_h */
69 
70 /* vi: set ts=4 sw=4 expandtab: */
GLenum GLenum dst
uint32_t Uint32
An unsigned 32-bit integer type.
Definition: SDL_stdinc.h:155
void SDL_ResetKeyboard(void)
Definition: SDL_keyboard.c:564
int SDL_SendKeyboardText(const char *text)
Definition: SDL_keyboard.c:774
SDL_Window * window
GLuint GLuint end
Definition: SDL_opengl.h:1564
struct xkb_state * state
GLuint start
Definition: SDL_opengl.h:1564
GLuint const GLchar * name
void SDL_SetKeyboardFocus(SDL_Window *window)
Definition: SDL_keyboard.c:612
Sint32 SDL_Keycode
The SDL virtual key representation.
Definition: SDL_keycode.h:42
char * SDL_UCS4ToUTF8(Uint32 ch, char *dst)
Definition: SDL_keyboard.c:512
SDL_bool
Definition: SDL_stdinc.h:126
void SDL_KeyboardQuit(void)
Definition: SDL_keyboard.c:817
uint8_t Uint8
An unsigned 8-bit integer type.
Definition: SDL_stdinc.h:139
int SDL_KeyboardInit(void)
Definition: SDL_keyboard.c:554
void SDL_GetDefaultKeymap(SDL_Keycode *keymap)
Definition: SDL_keyboard.c:580
int SDL_SendKeyboardKey(Uint8 state, SDL_Scancode scancode)
Definition: SDL_keyboard.c:661
SDL_Keymod
Enumeration of valid key mods (possibly OR&#39;d together).
Definition: SDL_keycode.h:317
void SDL_SetKeymap(int start, SDL_Keycode *keys, int length)
Definition: SDL_keyboard.c:586
static char text[MAX_TEXT_LENGTH]
Definition: testime.c:34
void SDL_SetScancodeName(SDL_Scancode scancode, const char *name)
Definition: SDL_keyboard.c:598
The type used to identify a window.
Definition: SDL_sysvideo.h:71
GLuint GLsizei GLsizei * length
SDL_Scancode
The SDL keyboard scancode representation.
Definition: SDL_scancode.h:43
int SDL_SendEditingText(const char *text, int start, int end)
Definition: SDL_keyboard.c:797
void SDL_ToggleModState(const SDL_Keymod modstate, const SDL_bool toggle)
Definition: SDL_keyboard.c:850