src/events/SDL_keyboard_c.h
author Sam Lantinga <slouken@libsdl.org>
Thu, 15 Apr 2010 22:14:26 -0700
changeset 4434 5c64052fb476
parent 3697 f7b03b6838cb
child 4465 3e69e077cb95
permissions -rw-r--r--
changeset: 4433:25667ea797fa
tag: tip
user: Jiang Jiang <gzjjgod@gmail.com>
date: Thu Apr 15 12:01:46 2010 +0800
summary: Add windowID to text editing event
slouken@1895
     1
/*
slouken@1895
     2
    SDL - Simple DirectMedia Layer
slouken@3697
     3
    Copyright (C) 1997-2010 Sam Lantinga
slouken@1895
     4
slouken@1895
     5
    This library is free software; you can redistribute it and/or
slouken@1895
     6
    modify it under the terms of the GNU Lesser General Public
slouken@1895
     7
    License as published by the Free Software Foundation; either
slouken@1895
     8
    version 2.1 of the License, or (at your option) any later version.
slouken@1895
     9
slouken@1895
    10
    This library is distributed in the hope that it will be useful,
slouken@1895
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@1895
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@1895
    13
    Lesser General Public License for more details.
slouken@1895
    14
slouken@1895
    15
    You should have received a copy of the GNU Lesser General Public
slouken@1895
    16
    License along with this library; if not, write to the Free Software
slouken@1895
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
slouken@1895
    18
slouken@1895
    19
    Sam Lantinga
slouken@1895
    20
    slouken@libsdl.org
slouken@1895
    21
*/
slouken@1895
    22
#include "SDL_config.h"
slouken@1895
    23
slouken@1895
    24
#ifndef _SDL_keyboard_c_h
slouken@1895
    25
#define _SDL_keyboard_c_h
slouken@1895
    26
slouken@1895
    27
#include "SDL_keysym.h"
slouken@1895
    28
#include "SDL_events.h"
slouken@1895
    29
slouken@1895
    30
typedef struct SDL_Keyboard SDL_Keyboard;
slouken@1895
    31
slouken@1895
    32
struct SDL_Keyboard
slouken@1895
    33
{
slouken@1895
    34
    /* Free the keyboard when it's time */
slouken@1895
    35
    void (*FreeKeyboard) (SDL_Keyboard * keyboard);
slouken@1895
    36
slouken@1895
    37
    /* Data common to all keyboards */
slouken@3685
    38
    SDL_Window *focus;
slouken@1895
    39
    Uint16 modstate;
slouken@2307
    40
    Uint8 keystate[SDL_NUM_SCANCODES];
slouken@2303
    41
    SDLKey keymap[SDL_NUM_SCANCODES];
slouken@1895
    42
slouken@1895
    43
    void *driverdata;
slouken@1895
    44
};
slouken@1895
    45
slouken@1895
    46
/* Initialize the keyboard subsystem */
slouken@1895
    47
extern int SDL_KeyboardInit(void);
slouken@1895
    48
slouken@1895
    49
/* Get the keyboard at an index */
slouken@1895
    50
extern SDL_Keyboard *SDL_GetKeyboard(int index);
slouken@1895
    51
slouken@1895
    52
/* Add a keyboard, possibly reattaching at a particular index (or -1),
slouken@1895
    53
   returning the index of the keyboard, or -1 if there was an error.
slouken@1895
    54
 */
slouken@1895
    55
extern int SDL_AddKeyboard(const SDL_Keyboard * keyboard, int index);
slouken@1895
    56
slouken@1895
    57
/* Remove a keyboard at an index, clearing the slot for later */
slouken@1895
    58
extern void SDL_DelKeyboard(int index);
slouken@1895
    59
slouken@1895
    60
/* Clear the state of a keyboard at an index */
slouken@1895
    61
extern void SDL_ResetKeyboard(int index);
slouken@1895
    62
slouken@2303
    63
/* Get the default keymap */
slouken@2303
    64
extern void SDL_GetDefaultKeymap(SDLKey * keymap);
slouken@2303
    65
slouken@2303
    66
/* Set the mapping of scancode to key codes for this keyboard */
slouken@2303
    67
extern void SDL_SetKeymap(int index, int start, SDLKey * keys, int length);
slouken@2303
    68
slouken@2268
    69
/* Set a platform-dependent key name, overriding the default platform-agnostic
slouken@2268
    70
   name. Encoded as UTF-8. The string is not copied, thus the pointer given to
slouken@2268
    71
   this function must stay valid forever (or at least until the call to
slouken@2268
    72
   VideoQuit()). */
slouken@2303
    73
extern void SDL_SetScancodeName(SDL_scancode scancode, const char *name);
slouken@2268
    74
slouken@1895
    75
/* Set the keyboard focus window */
slouken@3685
    76
extern void SDL_SetKeyboardFocus(int index, SDL_Window * window);
slouken@1895
    77
slouken@1895
    78
/* Send a keyboard event for a keyboard at an index */
slouken@2303
    79
extern int SDL_SendKeyboardKey(int index, Uint8 state, SDL_scancode scancode);
slouken@1895
    80
slouken@1895
    81
/* Send keyboard text input for a keyboard at an index */
slouken@1895
    82
extern int SDL_SendKeyboardText(int index, const char *text);
slouken@1895
    83
slouken@3280
    84
/* Send editing text for selected range from start to end */
slouken@4434
    85
extern int SDL_SendEditingText(int index, const char *text, int start, int end);
slouken@3280
    86
slouken@1895
    87
/* Shutdown the keyboard subsystem */
slouken@1895
    88
extern void SDL_KeyboardQuit(void);
slouken@1895
    89
slouken@1895
    90
#endif /* _SDL_keyboard_c_h */
slouken@1895
    91
slouken@1895
    92
/* vi: set ts=4 sw=4 expandtab: */