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
slouken@1673
     1
/*
slouken@1673
     2
    SDL - Simple DirectMedia Layer
slouken@1673
     3
    Copyright (C) 1997-2006 Sam Lantinga
slouken@1673
     4
slouken@1673
     5
    This library is free software; you can redistribute it and/or
slouken@1673
     6
    modify it under the terms of the GNU Lesser General Public
slouken@1673
     7
    License as published by the Free Software Foundation; either
slouken@1673
     8
    version 2.1 of the License, or (at your option) any later version.
slouken@1673
     9
slouken@1673
    10
    This library is distributed in the hope that it will be useful,
slouken@1673
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@1673
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@1673
    13
    Lesser General Public License for more details.
slouken@1673
    14
slouken@1673
    15
    You should have received a copy of the GNU Lesser General Public
slouken@1673
    16
    License along with this library; if not, write to the Free Software
slouken@1673
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
slouken@1673
    18
slouken@1673
    19
    Sam Lantinga
slouken@1673
    20
    slouken@libsdl.org
slouken@1673
    21
*/
slouken@1673
    22
#include "SDL_config.h"
slouken@1673
    23
slouken@1673
    24
#ifndef _SDL_keyboard_c_h
slouken@1673
    25
#define _SDL_keyboard_c_h
slouken@1673
    26
slouken@1673
    27
typedef struct SDL_Keyboard SDL_Keyboard;
slouken@1673
    28
slouken@1673
    29
struct SDL_Keyboard
slouken@1673
    30
{
slouken@1673
    31
    /* Free the keyboard when it's time */
slouken@1673
    32
    void (*FreeKeyboard) (SDL_Keyboard * keyboard);
slouken@1673
    33
slouken@1673
    34
    SDLMod modstate;
slouken@1673
    35
    Uint8 keystate[SDLK_LAST];
slouken@1673
    36
slouken@1673
    37
    struct
slouken@1673
    38
    {
slouken@1673
    39
        int firsttime;          /* if we check against the delay or repeat value */
slouken@1673
    40
        int delay;              /* the delay before we start repeating */
slouken@1673
    41
        int interval;           /* the delay between key repeat events */
slouken@1673
    42
        Uint32 timestamp;       /* the time the first keydown event occurred */
slouken@1673
    43
slouken@1673
    44
        SDL_Event evt;          /* the event we are supposed to repeat */
slouken@1673
    45
    } keyrepeat;
slouken@1673
    46
slouken@1673
    47
    void *driverdata;
slouken@1673
    48
};
slouken@1673
    49
slouken@1673
    50
slouken@1673
    51
/* Initialize the keyboard subsystem */
slouken@1673
    52
extern int SDL_KeyboardInit(void);
slouken@1673
    53
slouken@1673
    54
/* Get the keyboard at an index */
slouken@1673
    55
extern SDL_Keyboard *SDL_GetKeyboard(int index);
slouken@1673
    56
slouken@1673
    57
/* Add a keyboard, possibly reattaching at a particular index (or -1),
slouken@1673
    58
   returning the index of the keyboard, or -1 if there was an error.
slouken@1673
    59
 */
slouken@1673
    60
extern int SDL_AddKeyboard(const SDL_Keyboard * keyboard, int index);
slouken@1673
    61
slouken@1673
    62
/* Remove a keyboard at an index, clearing the slot for later */
slouken@1673
    63
extern void SDL_DelKeyboard(int index);
slouken@1673
    64
slouken@1673
    65
/* Clear the state of a keyboard at an index */
slouken@1673
    66
extern void SDL_ResetKeyboard(int index);
slouken@1673
    67
slouken@1673
    68
/* Send a keyboard event for a keyboard at an index */
slouken@1673
    69
extern int SDL_SendKeyboardKey(int index, Uint8 state,
slouken@1673
    70
                               const SDL_keysym * keysym);
slouken@1673
    71
slouken@1673
    72
/* Shutdown the keyboard subsystem */
slouken@1673
    73
extern void SDL_KeyboardQuit(void);
slouken@1673
    74
slouken@1673
    75
#endif /* _SDL_keyboard_c_h */
slouken@1673
    76
slouken@1673
    77
/* vi: set ts=4 sw=4 expandtab: */