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...
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@1674
    34
    /* Data common to all keyboards */
slouken@1674
    35
    SDL_WindowID focus;
slouken@1674
    36
    Uint16 modstate;
slouken@1673
    37
    Uint8 keystate[SDLK_LAST];
slouken@1673
    38
slouken@1673
    39
    struct
slouken@1673
    40
    {
slouken@1673
    41
        int firsttime;          /* if we check against the delay or repeat value */
slouken@1673
    42
        int delay;              /* the delay before we start repeating */
slouken@1673
    43
        int interval;           /* the delay between key repeat events */
slouken@1673
    44
        Uint32 timestamp;       /* the time the first keydown event occurred */
slouken@1673
    45
slouken@1673
    46
        SDL_Event evt;          /* the event we are supposed to repeat */
slouken@1674
    47
    } repeat;
slouken@1673
    48
slouken@1673
    49
    void *driverdata;
slouken@1673
    50
};
slouken@1673
    51
slouken@1674
    52
/* Used by the OS keyboard code to detect whether or not to do UNICODE */
slouken@1674
    53
#ifndef DEFAULT_UNICODE_TRANSLATION
slouken@1674
    54
#define DEFAULT_UNICODE_TRANSLATION 0   /* Default off because of overhead */
slouken@1674
    55
#endif
slouken@1674
    56
extern int SDL_TranslateUNICODE;
slouken@1673
    57
slouken@1673
    58
/* Initialize the keyboard subsystem */
slouken@1673
    59
extern int SDL_KeyboardInit(void);
slouken@1673
    60
slouken@1673
    61
/* Get the keyboard at an index */
slouken@1673
    62
extern SDL_Keyboard *SDL_GetKeyboard(int index);
slouken@1673
    63
slouken@1673
    64
/* Add a keyboard, possibly reattaching at a particular index (or -1),
slouken@1673
    65
   returning the index of the keyboard, or -1 if there was an error.
slouken@1673
    66
 */
slouken@1673
    67
extern int SDL_AddKeyboard(const SDL_Keyboard * keyboard, int index);
slouken@1673
    68
slouken@1673
    69
/* Remove a keyboard at an index, clearing the slot for later */
slouken@1673
    70
extern void SDL_DelKeyboard(int index);
slouken@1673
    71
slouken@1673
    72
/* Clear the state of a keyboard at an index */
slouken@1673
    73
extern void SDL_ResetKeyboard(int index);
slouken@1673
    74
slouken@1673
    75
/* Send a keyboard event for a keyboard at an index */
slouken@1674
    76
extern int SDL_SendKeyboardKey(int index, SDL_WindowID windowID, Uint8 state,
slouken@1674
    77
                               SDL_keysym * keysym);
slouken@1674
    78
slouken@1674
    79
/* Used by the event loop to queue pending keyboard repeat events */
slouken@1674
    80
extern void SDL_CheckKeyRepeat(void);
slouken@1673
    81
slouken@1673
    82
/* Shutdown the keyboard subsystem */
slouken@1673
    83
extern void SDL_KeyboardQuit(void);
slouken@1673
    84
slouken@1673
    85
#endif /* _SDL_keyboard_c_h */
slouken@1673
    86
slouken@1673
    87
/* vi: set ts=4 sw=4 expandtab: */