src/events/SDL_keyboard_c.h
author Sam Lantinga <slouken@libsdl.org>
Sun, 11 Jun 2006 05:27:10 +0000
branchSDL-1.3
changeset 1674 7688a73b25b1
parent 1673 624e1412fbba
child 1720 a1ebb17f9c52
permissions -rw-r--r--
Finishing up keyboard code revamp, at least for now...
     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 typedef struct SDL_Keyboard SDL_Keyboard;
    28 
    29 struct SDL_Keyboard
    30 {
    31     /* Free the keyboard when it's time */
    32     void (*FreeKeyboard) (SDL_Keyboard * keyboard);
    33 
    34     /* Data common to all keyboards */
    35     SDL_WindowID focus;
    36     Uint16 modstate;
    37     Uint8 keystate[SDLK_LAST];
    38 
    39     struct
    40     {
    41         int firsttime;          /* if we check against the delay or repeat value */
    42         int delay;              /* the delay before we start repeating */
    43         int interval;           /* the delay between key repeat events */
    44         Uint32 timestamp;       /* the time the first keydown event occurred */
    45 
    46         SDL_Event evt;          /* the event we are supposed to repeat */
    47     } repeat;
    48 
    49     void *driverdata;
    50 };
    51 
    52 /* Used by the OS keyboard code to detect whether or not to do UNICODE */
    53 #ifndef DEFAULT_UNICODE_TRANSLATION
    54 #define DEFAULT_UNICODE_TRANSLATION 0   /* Default off because of overhead */
    55 #endif
    56 extern int SDL_TranslateUNICODE;
    57 
    58 /* Initialize the keyboard subsystem */
    59 extern int SDL_KeyboardInit(void);
    60 
    61 /* Get the keyboard at an index */
    62 extern SDL_Keyboard *SDL_GetKeyboard(int index);
    63 
    64 /* Add a keyboard, possibly reattaching at a particular index (or -1),
    65    returning the index of the keyboard, or -1 if there was an error.
    66  */
    67 extern int SDL_AddKeyboard(const SDL_Keyboard * keyboard, int index);
    68 
    69 /* Remove a keyboard at an index, clearing the slot for later */
    70 extern void SDL_DelKeyboard(int index);
    71 
    72 /* Clear the state of a keyboard at an index */
    73 extern void SDL_ResetKeyboard(int index);
    74 
    75 /* Send a keyboard event for a keyboard at an index */
    76 extern int SDL_SendKeyboardKey(int index, SDL_WindowID windowID, Uint8 state,
    77                                SDL_keysym * keysym);
    78 
    79 /* Used by the event loop to queue pending keyboard repeat events */
    80 extern void SDL_CheckKeyRepeat(void);
    81 
    82 /* Shutdown the keyboard subsystem */
    83 extern void SDL_KeyboardQuit(void);
    84 
    85 #endif /* _SDL_keyboard_c_h */
    86 
    87 /* vi: set ts=4 sw=4 expandtab: */