src/events/SDL_keyboard_c.h
author Sam Lantinga <slouken@libsdl.org>
Sat, 10 Jun 2006 09:11:59 +0000
branchSDL-1.3
changeset 1673 624e1412fbba
child 1674 7688a73b25b1
permissions -rw-r--r--
Keyboard code update in progress
     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     SDLMod modstate;
    35     Uint8 keystate[SDLK_LAST];
    36 
    37     struct
    38     {
    39         int firsttime;          /* if we check against the delay or repeat value */
    40         int delay;              /* the delay before we start repeating */
    41         int interval;           /* the delay between key repeat events */
    42         Uint32 timestamp;       /* the time the first keydown event occurred */
    43 
    44         SDL_Event evt;          /* the event we are supposed to repeat */
    45     } keyrepeat;
    46 
    47     void *driverdata;
    48 };
    49 
    50 
    51 /* Initialize the keyboard subsystem */
    52 extern int SDL_KeyboardInit(void);
    53 
    54 /* Get the keyboard at an index */
    55 extern SDL_Keyboard *SDL_GetKeyboard(int index);
    56 
    57 /* Add a keyboard, possibly reattaching at a particular index (or -1),
    58    returning the index of the keyboard, or -1 if there was an error.
    59  */
    60 extern int SDL_AddKeyboard(const SDL_Keyboard * keyboard, int index);
    61 
    62 /* Remove a keyboard at an index, clearing the slot for later */
    63 extern void SDL_DelKeyboard(int index);
    64 
    65 /* Clear the state of a keyboard at an index */
    66 extern void SDL_ResetKeyboard(int index);
    67 
    68 /* Send a keyboard event for a keyboard at an index */
    69 extern int SDL_SendKeyboardKey(int index, Uint8 state,
    70                                const SDL_keysym * keysym);
    71 
    72 /* Shutdown the keyboard subsystem */
    73 extern void SDL_KeyboardQuit(void);
    74 
    75 #endif /* _SDL_keyboard_c_h */
    76 
    77 /* vi: set ts=4 sw=4 expandtab: */