src/events/SDL_keyboard_c.h
changeset 1895 c121d94672cb
child 2129 047245361002
equal deleted inserted replaced
1894:c69cee13dd76 1895:c121d94672cb
       
     1 /*
       
     2     SDL - Simple DirectMedia Layer
       
     3     Copyright (C) 1997-2006 Sam Lantinga
       
     4 
       
     5     This library is free software; you can redistribute it and/or
       
     6     modify it under the terms of the GNU Lesser General Public
       
     7     License as published by the Free Software Foundation; either
       
     8     version 2.1 of the License, or (at your option) any later version.
       
     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
       
    13     Lesser General Public License for more details.
       
    14 
       
    15     You should have received a copy of the GNU Lesser General Public
       
    16     License along with this library; if not, write to the Free Software
       
    17     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
       
    18 
       
    19     Sam Lantinga
       
    20     slouken@libsdl.org
       
    21 */
       
    22 #include "SDL_config.h"
       
    23 
       
    24 #ifndef _SDL_keyboard_c_h
       
    25 #define _SDL_keyboard_c_h
       
    26 
       
    27 #include "SDL_keysym.h"
       
    28 #include "SDL_events.h"
       
    29 
       
    30 typedef struct SDL_Keyboard SDL_Keyboard;
       
    31 
       
    32 struct SDL_Keyboard
       
    33 {
       
    34     /* Free the keyboard when it's time */
       
    35     void (*FreeKeyboard) (SDL_Keyboard * keyboard);
       
    36 
       
    37     /* Data common to all keyboards */
       
    38     SDL_WindowID focus;
       
    39     Uint16 modstate;
       
    40     Uint8 keystate[SDLK_LAST];
       
    41 
       
    42     struct
       
    43     {
       
    44         int firsttime;          /* if we check against the delay or repeat value */
       
    45         int delay;              /* the delay before we start repeating */
       
    46         int interval;           /* the delay between key repeat events */
       
    47         Uint32 timestamp;       /* the time the first keydown event occurred */
       
    48 
       
    49         SDL_Event evt;          /* the event we are supposed to repeat */
       
    50     } repeat;
       
    51 
       
    52     void *driverdata;
       
    53 };
       
    54 
       
    55 /* Used by the OS keyboard code to detect whether or not to do UNICODE */
       
    56 #ifndef DEFAULT_UNICODE_TRANSLATION
       
    57 #define DEFAULT_UNICODE_TRANSLATION 0   /* Default off because of overhead */
       
    58 #endif
       
    59 extern int SDL_TranslateUNICODE;
       
    60 
       
    61 /* Initialize the keyboard subsystem */
       
    62 extern int SDL_KeyboardInit(void);
       
    63 
       
    64 /* Get the keyboard at an index */
       
    65 extern SDL_Keyboard *SDL_GetKeyboard(int index);
       
    66 
       
    67 /* Add a keyboard, possibly reattaching at a particular index (or -1),
       
    68    returning the index of the keyboard, or -1 if there was an error.
       
    69  */
       
    70 extern int SDL_AddKeyboard(const SDL_Keyboard * keyboard, int index);
       
    71 
       
    72 /* Remove a keyboard at an index, clearing the slot for later */
       
    73 extern void SDL_DelKeyboard(int index);
       
    74 
       
    75 /* Clear the state of a keyboard at an index */
       
    76 extern void SDL_ResetKeyboard(int index);
       
    77 
       
    78 /* Set the keyboard focus window */
       
    79 extern void SDL_SetKeyboardFocus(int index, SDL_WindowID windowID);
       
    80 
       
    81 /* Send a keyboard event for a keyboard at an index */
       
    82 extern int SDL_SendKeyboardKey(int index, Uint8 state, Uint8 scancode,
       
    83                                SDLKey key);
       
    84 
       
    85 /* Send keyboard text input for a keyboard at an index */
       
    86 extern int SDL_SendKeyboardText(int index, const char *text);
       
    87 
       
    88 /* Used by the event loop to queue pending keyboard repeat events */
       
    89 extern void SDL_CheckKeyRepeat(void);
       
    90 
       
    91 /* Shutdown the keyboard subsystem */
       
    92 extern void SDL_KeyboardQuit(void);
       
    93 
       
    94 #endif /* _SDL_keyboard_c_h */
       
    95 
       
    96 /* vi: set ts=4 sw=4 expandtab: */