src/events/SDL_keyboard_c.h
author Sam Lantinga <slouken@libsdl.org>
Fri, 15 Feb 2013 08:47:44 -0800
changeset 6885 700f1b25f77f
parent 6138 4c64952a58fb
child 7778 a571a9947869
permissions -rw-r--r--
Happy New Year!
slouken@1895
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@6885
     3
  Copyright (C) 1997-2013 Sam Lantinga <slouken@libsdl.org>
slouken@1895
     4
slouken@5535
     5
  This software is provided 'as-is', without any express or implied
slouken@5535
     6
  warranty.  In no event will the authors be held liable for any damages
slouken@5535
     7
  arising from the use of this software.
slouken@1895
     8
slouken@5535
     9
  Permission is granted to anyone to use this software for any purpose,
slouken@5535
    10
  including commercial applications, and to alter it and redistribute it
slouken@5535
    11
  freely, subject to the following restrictions:
slouken@1895
    12
slouken@5535
    13
  1. The origin of this software must not be misrepresented; you must not
slouken@5535
    14
     claim that you wrote the original software. If you use this software
slouken@5535
    15
     in a product, an acknowledgment in the product documentation would be
slouken@5535
    16
     appreciated but is not required.
slouken@5535
    17
  2. Altered source versions must be plainly marked as such, and must not be
slouken@5535
    18
     misrepresented as being the original software.
slouken@5535
    19
  3. This notice may not be removed or altered from any source distribution.
slouken@1895
    20
*/
slouken@1895
    21
#include "SDL_config.h"
slouken@1895
    22
slouken@1895
    23
#ifndef _SDL_keyboard_c_h
slouken@1895
    24
#define _SDL_keyboard_c_h
slouken@1895
    25
slouken@5326
    26
#include "SDL_keycode.h"
slouken@1895
    27
#include "SDL_events.h"
slouken@1895
    28
slouken@1895
    29
/* Initialize the keyboard subsystem */
slouken@1895
    30
extern int SDL_KeyboardInit(void);
slouken@1895
    31
slouken@4465
    32
/* Clear the state of the keyboard */
slouken@4465
    33
extern void SDL_ResetKeyboard(void);
slouken@1895
    34
slouken@2303
    35
/* Get the default keymap */
slouken@5220
    36
extern void SDL_GetDefaultKeymap(SDL_Keycode * keymap);
slouken@2303
    37
slouken@4465
    38
/* Set the mapping of scancode to key codes */
slouken@5220
    39
extern void SDL_SetKeymap(int start, SDL_Keycode * keys, int length);
slouken@2303
    40
slouken@2268
    41
/* Set a platform-dependent key name, overriding the default platform-agnostic
slouken@2268
    42
   name. Encoded as UTF-8. The string is not copied, thus the pointer given to
slouken@2268
    43
   this function must stay valid forever (or at least until the call to
slouken@2268
    44
   VideoQuit()). */
slouken@5218
    45
extern void SDL_SetScancodeName(SDL_Scancode scancode, const char *name);
slouken@2268
    46
slouken@1895
    47
/* Set the keyboard focus window */
slouken@4465
    48
extern void SDL_SetKeyboardFocus(SDL_Window * window);
slouken@1895
    49
slouken@4465
    50
/* Send a keyboard key event */
slouken@5218
    51
extern int SDL_SendKeyboardKey(Uint8 state, SDL_Scancode scancode);
slouken@1895
    52
slouken@4465
    53
/* Send keyboard text input */
slouken@4465
    54
extern int SDL_SendKeyboardText(const char *text);
slouken@1895
    55
slouken@3280
    56
/* Send editing text for selected range from start to end */
slouken@4465
    57
extern int SDL_SendEditingText(const char *text, int start, int end);
slouken@3280
    58
slouken@1895
    59
/* Shutdown the keyboard subsystem */
slouken@1895
    60
extern void SDL_KeyboardQuit(void);
slouken@1895
    61
slouken@1895
    62
#endif /* _SDL_keyboard_c_h */
slouken@1895
    63
slouken@1895
    64
/* vi: set ts=4 sw=4 expandtab: */