slouken@0: /*
slouken@0:     SDL - Simple DirectMedia Layer
slouken@2859:     Copyright (C) 1997-2009 Sam Lantinga
slouken@0: 
slouken@0:     This library is free software; you can redistribute it and/or
slouken@1312:     modify it under the terms of the GNU Lesser General Public
slouken@0:     License as published by the Free Software Foundation; either
slouken@1312:     version 2.1 of the License, or (at your option) any later version.
slouken@0: 
slouken@0:     This library is distributed in the hope that it will be useful,
slouken@0:     but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@0:     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@1312:     Lesser General Public License for more details.
slouken@0: 
slouken@1312:     You should have received a copy of the GNU Lesser General Public
slouken@1312:     License along with this library; if not, write to the Free Software
slouken@1312:     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
slouken@0: 
slouken@0:     Sam Lantinga
slouken@251:     slouken@libsdl.org
slouken@0: */
slouken@0: 
slouken@1895: /**
slouken@1895:  * \file SDL_keyboard.h
slouken@1895:  *
slouken@1895:  * Include file for SDL keyboard event handling
slouken@1895:  */
slouken@0: 
slouken@0: #ifndef _SDL_keyboard_h
slouken@0: #define _SDL_keyboard_h
slouken@0: 
slouken@1356: #include "SDL_stdinc.h"
slouken@1358: #include "SDL_error.h"
slouken@0: #include "SDL_keysym.h"
slouken@0: 
slouken@0: #include "begin_code.h"
slouken@0: /* Set up for C function definitions, even when using C++ */
slouken@0: #ifdef __cplusplus
slouken@1895: /* *INDENT-OFF* */
slouken@0: extern "C" {
slouken@1895: /* *INDENT-ON* */
slouken@0: #endif
slouken@0: 
slouken@1895: /**
slouken@1895:  * \struct SDL_keysym
slouken@1895:  *
slouken@1895:  * \brief The SDL keysym structure, used in key events.
slouken@0:  */
slouken@1895: typedef struct SDL_keysym
slouken@1895: {
slouken@2303:     SDL_scancode scancode;      /**< SDL physical key code - see ::SDL_scancode for details */
slouken@2268:     SDLKey sym;                 /**< SDL virtual key code - see ::SDLKey for details */
slouken@1895:     Uint16 mod;                 /**< current key modifiers */
slouken@1895:     Uint32 unicode;             /**< OBSOLETE, use SDL_TextInputEvent instead */
slouken@0: } SDL_keysym;
slouken@0: 
slouken@1895: /* Function prototypes */
slouken@0: 
slouken@1895: /**
slouken@1895:  * \fn int SDL_GetNumKeyboards(void)
slouken@1895:  *
slouken@1895:  * \brief Get the number of keyboard input devices available.
slouken@1895:  *
slouken@1895:  * \sa SDL_SelectKeyboard()
slouken@1895:  */
slouken@1895: extern DECLSPEC int SDLCALL SDL_GetNumKeyboards(void);
slouken@1895: 
slouken@1895: /**
slouken@1895:  * \fn int SDL_SelectKeyboard(int index)
slouken@1895:  *
slouken@1895:  * \brief Set the index of the currently selected keyboard.
slouken@1895:  *
slouken@1895:  * \return The index of the previously selected keyboard.
slouken@1895:  *
slouken@1895:  * \note You can query the currently selected keyboard by passing an index of -1.
slouken@1895:  *
slouken@1895:  * \sa SDL_GetNumKeyboards()
slouken@1895:  */
slouken@1895: extern DECLSPEC int SDLCALL SDL_SelectKeyboard(int index);
slouken@1895: 
slouken@1895: /**
slouken@2303:  * \fn Uint8 *SDL_GetKeyboardState(int *numkeys)
slouken@1895:  *
slouken@1895:  * \brief Get a snapshot of the current state of the selected keyboard.
slouken@1895:  *
slouken@2268:  * \param numkeys if non-NULL, receives the length of the returned array.
slouken@2268:  *
slouken@2303:  * \return An array of key states. Indexes into this array are obtained by using ::SDL_scancode values.
slouken@1895:  *
slouken@1895:  * Example:
slouken@2303:  * 	Uint8 *state = SDL_GetKeyboardState(NULL);
slouken@2303:  *	if ( state[SDL_SCANCODE_RETURN)] ) ... <RETURN> is pressed.
slouken@0:  */
slouken@2303: extern DECLSPEC Uint8 *SDLCALL SDL_GetKeyboardState(int *numkeys);
slouken@0: 
slouken@1895: /**
slouken@1895:  * \fn SDLMod SDL_GetModState(void)
slouken@1895:  *
slouken@1895:  * \brief Get the current key modifier state for the selected keyboard.
slouken@0:  */
slouken@337: extern DECLSPEC SDLMod SDLCALL SDL_GetModState(void);
slouken@0: 
slouken@1895: /**
slouken@1895:  * \fn void SDL_SetModState(SDLMod modstate)
slouken@1895:  *
slouken@1895:  * \brief Set the current key modifier state for the selected keyboard.
slouken@1895:  *
slouken@1895:  * \note This does not change the keyboard state, only the key modifier flags.
slouken@0:  */
slouken@337: extern DECLSPEC void SDLCALL SDL_SetModState(SDLMod modstate);
slouken@0: 
slouken@1895: /**
slouken@2303:  * \fn SDLKey SDL_GetKeyFromScancode(SDL_scancode scancode)
slouken@1895:  * 
slouken@2303:  * \brief Get the key code corresponding to the given scancode according to the current keyboard layout.
slouken@2268:  *
slouken@2268:  * See ::SDLKey for details.
slouken@2268:  *
slouken@2268:  * \sa SDL_GetKeyName()
slouken@0:  */
slouken@2303: extern DECLSPEC SDLKey SDLCALL SDL_GetKeyFromScancode(SDL_scancode scancode);
slouken@2268: 
slouken@2268: /**
slouken@2303:  * \fn SDL_scancode SDL_GetScancodeFromKey(SDLKey key)
slouken@2303:  * 
slouken@2303:  * \brief Get the scancode corresponding to the given key code according to the current keyboard layout.
slouken@2303:  *
slouken@2303:  * See ::SDL_scancode for details.
slouken@2303:  *
slouken@2303:  * \sa SDL_GetScancodeName()
slouken@2303:  */
slouken@2303: extern DECLSPEC SDL_scancode SDLCALL SDL_GetScancodeFromKey(SDLKey key);
slouken@2303: 
slouken@2303: /**
slouken@2303:  * \fn const char *SDL_GetScancodeName(SDL_scancode scancode)
slouken@2303:  * 
slouken@2303:  * \brief Get a human-readable name for a scancode.
slouken@2303:  *
slouken@2303:  * \return A pointer to a UTF-8 string that stays valid at least until the next call to this function. If you need it around any longer, you must copy it.  If the scancode doesn't have a name, this function returns "".
slouken@2303:  *
slouken@2303:  * \sa SDL_scancode
slouken@2303:  */
slouken@2303: extern DECLSPEC const char *SDLCALL SDL_GetScancodeName(SDL_scancode
slouken@2303:                                                         scancode);
slouken@2303: 
slouken@2303: /**
slouken@2303:  * \fn const char *SDL_GetKeyName(SDLKey key)
slouken@2268:  * 
slouken@2268:  * \brief Get a human-readable name for a key.
slouken@2268:  *
slouken@2303:  * \return A pointer to a UTF-8 string that stays valid at least until the next call to this function. If you need it around any longer, you must copy it.  If the key doesn't have a name, this function returns "".
slouken@2268:  *
slouken@2268:  * \sa SDLKey
slouken@2268:  */
slouken@2303: extern DECLSPEC const char *SDLCALL SDL_GetKeyName(SDLKey key);
slouken@0: 
slouken@3280: /**
slouken@3280:  * \fn void SDL_StartTextInput(void)
slouken@3280:  *
slouken@3280:  * \brief Start accepting Unicode text input events.
slouken@3280:  *
slouken@3280:  * \sa SDL_StopTextInput()
slouken@3280:  * \sa SDL_SetTextInputRect()
slouken@3280:  */
slouken@3280: extern DECLSPEC void SDLCALL SDL_StartTextInput(void);
slouken@3280: 
slouken@3280: /**
slouken@3280:  * \fn void SDL_StopTextInput(void)
slouken@3280:  *
slouken@3280:  * \brief Stop receiving any text input events.
slouken@3280:  *
slouken@3280:  * \sa SDL_StartTextInput()
slouken@3280:  */
slouken@3280: extern DECLSPEC void SDLCALL SDL_StopTextInput(void);
slouken@3280: 
slouken@3280: /**
slouken@3280:  * \fn void SDL_SetTextInputRect(SDL_Rect *rect)
slouken@3280:  *
slouken@3280:  * \brief Set the rectangle used to type Unicode text inputs.
slouken@3280:  *
slouken@3280:  * \sa SDL_StartTextInput()
slouken@3280:  */
slouken@3280: extern DECLSPEC void SDLCALL SDL_SetTextInputRect(SDL_Rect *rect);
slouken@3280: 
slouken@0: 
slouken@0: /* Ends C function definitions when using C++ */
slouken@0: #ifdef __cplusplus
slouken@1895: /* *INDENT-OFF* */
slouken@0: }
slouken@1895: /* *INDENT-ON* */
slouken@0: #endif
slouken@0: #include "close_code.h"
slouken@0: 
slouken@0: #endif /* _SDL_keyboard_h */
slouken@1895: 
slouken@1895: /* vi: set ts=4 sw=4 expandtab: */