include/SDL_keyboard.h
author Sam Lantinga <slouken@libsdl.org>
Mon, 10 Jul 2006 21:04:37 +0000
changeset 1895 c121d94672cb
parent 1507 1ff64ad478b2
child 2129 047245361002
permissions -rw-r--r--
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
     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     Uint8 padding[3];           /**< alignment padding */
    53     Uint16 sym;                 /**< SDL virtual keysym */
    54     Uint16 mod;                 /**< current key modifiers */
    55     Uint32 unicode;             /**< OBSOLETE, use SDL_TextInputEvent instead */
    56 } SDL_keysym;
    57 
    58 /* Function prototypes */
    59 
    60 /**
    61  * \fn int SDL_GetNumKeyboards(void)
    62  *
    63  * \brief Get the number of keyboard input devices available.
    64  *
    65  * \sa SDL_SelectKeyboard()
    66  */
    67 extern DECLSPEC int SDLCALL SDL_GetNumKeyboards(void);
    68 
    69 /**
    70  * \fn int SDL_SelectKeyboard(int index)
    71  *
    72  * \brief Set the index of the currently selected keyboard.
    73  *
    74  * \return The index of the previously selected keyboard.
    75  *
    76  * \note You can query the currently selected keyboard by passing an index of -1.
    77  *
    78  * \sa SDL_GetNumKeyboards()
    79  */
    80 extern DECLSPEC int SDLCALL SDL_SelectKeyboard(int index);
    81 
    82 /**
    83  * \fn int SDL_EnableUNICODE(int enable)
    84  *
    85  * \brief Enable/Disable UNICODE translation of keyboard input.
    86  *
    87  * \param enable 1 to enable translation, 0 to disable translation, -1 to query translation
    88  *
    89  * \return The previous state of keyboard translation
    90  *
    91  * \note This translation has some overhead, so translation defaults off.
    92  */
    93 extern DECLSPEC int SDLCALL SDL_EnableUNICODE(int enable);
    94 
    95 /**
    96  * \fn int SDL_EnableKeyRepeat(int delay, int interval)
    97  * 
    98  * \brief Enable keyboard repeat for the selected keyboard.
    99  *
   100  * \param delay The initial delay in milliseconds between the time when a
   101  *              key is pressed and keyboard repeat begins.  Setting a delay
   102  *              of 0 will disable keyboard repeat.
   103  * \param interval The time in milliseconds between keyboard repeat events.
   104  *
   105  * \return 0 on success, or -1 if there was an error.
   106  *
   107  * \note Keyboard repeat defaults to off.
   108  */
   109 #define SDL_DEFAULT_REPEAT_DELAY	500
   110 #define SDL_DEFAULT_REPEAT_INTERVAL	30
   111  /**/
   112     extern DECLSPEC int SDLCALL SDL_EnableKeyRepeat(int delay, int interval);
   113 
   114 /**
   115  * \fn void SDL_GetKeyRepeat(int *delay, int *interval)
   116  *
   117  * \brief Get the current keyboard repeat setting for the selected keyboard.
   118  */
   119 extern DECLSPEC void SDLCALL SDL_GetKeyRepeat(int *delay, int *interval);
   120 
   121 /**
   122  * \fn Uint8 *SDL_GetKeyState(int *numkeys)
   123  *
   124  * \brief Get a snapshot of the current state of the selected keyboard.
   125  *
   126  * \return An array of keystates, indexed by the SDLK_* syms.
   127  *
   128  * Example:
   129  * 	Uint8 *keystate = SDL_GetKeyState(NULL);
   130  *	if ( keystate[SDLK_RETURN] ) ... <RETURN> is pressed.
   131  */
   132 extern DECLSPEC Uint8 *SDLCALL SDL_GetKeyState(int *numkeys);
   133 
   134 /**
   135  * \fn SDLMod SDL_GetModState(void)
   136  *
   137  * \brief Get the current key modifier state for the selected keyboard.
   138  */
   139 extern DECLSPEC SDLMod SDLCALL SDL_GetModState(void);
   140 
   141 /**
   142  * \fn void SDL_SetModState(SDLMod modstate)
   143  *
   144  * \brief Set the current key modifier state for the selected keyboard.
   145  *
   146  * \note This does not change the keyboard state, only the key modifier flags.
   147  */
   148 extern DECLSPEC void SDLCALL SDL_SetModState(SDLMod modstate);
   149 
   150 /**
   151  * \fn const char *SDL_GetKeyName(SDLKey key)
   152  * 
   153  * \brief Get the name of an SDL virtual keysym
   154  */
   155 extern DECLSPEC const char *SDLCALL SDL_GetKeyName(SDLKey key);
   156 
   157 
   158 /* Ends C function definitions when using C++ */
   159 #ifdef __cplusplus
   160 /* *INDENT-OFF* */
   161 }
   162 /* *INDENT-ON* */
   163 #endif
   164 #include "close_code.h"
   165 
   166 #endif /* _SDL_keyboard_h */
   167 
   168 /* vi: set ts=4 sw=4 expandtab: */