include/SDL_keyboard.h
author Sam Lantinga <slouken@libsdl.org>
Sat, 10 Jun 2006 09:11:59 +0000
branchSDL-1.3
changeset 1673 624e1412fbba
parent 1668 4da1ee79c9af
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 
    23 /**
    24  * \file SDL_keyboard.h
    25  *
    26  * Include file for SDL keyboard event handling
    27  */
    28 
    29 #ifndef _SDL_keyboard_h
    30 #define _SDL_keyboard_h
    31 
    32 #include "SDL_stdinc.h"
    33 #include "SDL_error.h"
    34 #include "SDL_keysym.h"
    35 
    36 #include "begin_code.h"
    37 /* Set up for C function definitions, even when using C++ */
    38 #ifdef __cplusplus
    39 /* *INDENT-OFF* */
    40 extern "C" {
    41 /* *INDENT-ON* */
    42 #endif
    43 
    44 /**
    45  * \struct SDL_keysym
    46  *
    47  * \brief The SDL keysym structure, used in key events.
    48  */
    49 typedef struct SDL_keysym
    50 {
    51     Uint8 scancode;             /**< keyboard specific scancode */
    52     SDLKey sym;                 /**< SDL virtual keysym */
    53     SDLMod mod;                 /**< current key modifiers */
    54 } SDL_keysym;
    55 
    56 /* Function prototypes */
    57 
    58 /**
    59  * \fn int SDL_GetNumKeyboards(void)
    60  *
    61  * \brief Get the number of keyboard input devices available.
    62  *
    63  * \sa SDL_SelectKeyboard()
    64  */
    65 extern DECLSPEC int SDLCALL SDL_GetNumKeyboards(void);
    66 
    67 /**
    68  * \fn int SDL_SelectKeyboard(int index)
    69  *
    70  * \brief Set the index of the currently selected keyboard.
    71  *
    72  * \return The index of the previously selected keyboard.
    73  *
    74  * \note You can query the currently selected keyboard by passing an index of -1.
    75  *
    76  * \sa SDL_GetNumKeyboards()
    77  */
    78 extern DECLSPEC int SDLCALL SDL_SelectKeyboard(int index);
    79 
    80 /**
    81  * \fn int SDL_EnableUNICODE(int enable)
    82  *
    83  * \brief Enable/Disable UNICODE translation of keyboard input.
    84  *
    85  * \param enable 1 to enable translation, 0 to disable translation, -1 to query translation
    86  *
    87  * \return The previous state of keyboard translation
    88  *
    89  * \note This translation has some overhead, so translation defaults off.
    90  */
    91 extern DECLSPEC int SDLCALL SDL_EnableUNICODE(int enable);
    92 
    93 /**
    94  * \fn int SDL_EnableKeyRepeat(int delay, int interval)
    95  * 
    96  * \brief Enable keyboard repeat for the selected keyboard.
    97  *
    98  * \param delay The initial delay in milliseconds between the time when a
    99  *              key is pressed and keyboard repeat begins.  Setting a delay
   100  *              of 0 will disable keyboard repeat.
   101  * \param interval The time in milliseconds between keyboard repeat events.
   102  *
   103  * \return 0 on success, or -1 if there was an error.
   104  *
   105  * \note Keyboard repeat defaults to off.
   106  */
   107 #define SDL_DEFAULT_REPEAT_DELAY	500
   108 #define SDL_DEFAULT_REPEAT_INTERVAL	30
   109  /**/
   110     extern DECLSPEC int SDLCALL SDL_EnableKeyRepeat(int delay, int interval);
   111 
   112 /**
   113  * \fn void SDL_GetKeyRepeat(int *delay, int *interval)
   114  *
   115  * \brief Get the current keyboard repeat setting for the selected keyboard.
   116  */
   117 extern DECLSPEC void SDLCALL SDL_GetKeyRepeat(int *delay, int *interval);
   118 
   119 /**
   120  * \fn Uint8 *SDL_GetKeyState(int *numkeys)
   121  *
   122  * \brief Get a snapshot of the current state of the selected keyboard.
   123  *
   124  * \return An array of keystates, indexed by the SDLK_* syms.
   125  *
   126  * Example:
   127  * 	Uint8 *keystate = SDL_GetKeyState(NULL);
   128  *	if ( keystate[SDLK_RETURN] ) ... <RETURN> is pressed.
   129  */
   130 extern DECLSPEC Uint8 *SDLCALL SDL_GetKeyState(int *numkeys);
   131 
   132 /**
   133  * \fn SDLMod SDL_GetModState(void)
   134  *
   135  * \brief Get the current key modifier state for the selected keyboard.
   136  */
   137 extern DECLSPEC SDLMod SDLCALL SDL_GetModState(void);
   138 
   139 /**
   140  * \fn void SDL_SetModState(SDLMod modstate)
   141  *
   142  * \brief Set the current key modifier state for the selected keyboard.
   143  *
   144  * \note This does not change the keyboard state, only the key modifier flags.
   145  */
   146 extern DECLSPEC void SDLCALL SDL_SetModState(SDLMod modstate);
   147 
   148 /**
   149  * \fn const char *SDL_GetKeyName(SDLKey key)
   150  * 
   151  * \brief Get the name of an SDL virtual keysym
   152  */
   153 extern DECLSPEC const char *SDLCALL SDL_GetKeyName(SDLKey key);
   154 
   155 
   156 /* Ends C function definitions when using C++ */
   157 #ifdef __cplusplus
   158 /* *INDENT-OFF* */
   159 }
   160 /* *INDENT-ON* */
   161 #endif
   162 #include "close_code.h"
   163 
   164 #endif /* _SDL_keyboard_h */
   165 
   166 /* vi: set ts=4 sw=4 expandtab: */