icculus/SDL-audio-capture: include/SDL_keyboard.h@d3baf5ac4e37 (annotated)

0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1	/*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	2	SDL - Simple DirectMedia Layer
2859 99210400e8b9 Updated copyright date Sam Lantinga <slouken@libsdl.org> parents: 2303 diff changeset	3	Copyright (C) 1997-2009 Sam Lantinga
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	4
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	5	This library is free software; you can redistribute it and/or
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 911 diff changeset	6	modify it under the terms of the GNU Lesser General Public
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	7	License as published by the Free Software Foundation; either
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 911 diff changeset	8	version 2.1 of the License, or (at your option) any later version.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	9
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	10	This library is distributed in the hope that it will be useful,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	11	but WITHOUT ANY WARRANTY; without even the implied warranty of
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	12	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 911 diff changeset	13	Lesser General Public License for more details.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	14
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 911 diff changeset	15	You should have received a copy of the GNU Lesser General Public
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 911 diff changeset	16	License along with this library; if not, write to the Free Software
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 911 diff changeset	17	Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	18
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	19	Sam Lantinga
251 b8688cfdc232 Updated the headers with the correct e-mail address Sam Lantinga <slouken@libsdl.org> parents: 0 diff changeset	20	slouken@libsdl.org
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	21	*/
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	22
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1507 diff changeset	23	/**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	24	* \file SDL_keyboard.h
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	25	*
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	26	* Include file for SDL keyboard event handling
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1507 diff changeset	27	*/
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	28
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	29	#ifndef _SDL_keyboard_h
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	30	#define _SDL_keyboard_h
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	31
1356 67114343400d * empty log message * Sam Lantinga <slouken@libsdl.org> parents: 1312 diff changeset	32	#include "SDL_stdinc.h"
1358 c71e05b4dc2e More header massaging... works great on Windows. ;-) Sam Lantinga <slouken@libsdl.org> parents: 1356 diff changeset	33	#include "SDL_error.h"
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	34	#include "SDL_keysym.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	35
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	36	#include "begin_code.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	37	/* Set up for C function definitions, even when using C++ */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	38	#ifdef __cplusplus
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1507 diff changeset	39	/* INDENT-OFF */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	40	extern "C" {
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1507 diff changeset	41	/* INDENT-ON */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	42	#endif
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	43
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1507 diff changeset	44	/**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	45	* \brief The SDL keysym structure, used in key events.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	46	*/
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1507 diff changeset	47	typedef struct SDL_keysym
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1507 diff changeset	48	{
2303 d87417504c75 First pass implementation of new SDL scancode concept, as discussed with Sam Lantinga <slouken@libsdl.org> parents: 2268 diff changeset	49	SDL_scancode scancode; /*< SDL physical key code - see ::SDL_scancode for details /
2268 4baee598306d Date: Thu, 05 Jul 2007 14:02:33 -0700 Sam Lantinga <slouken@libsdl.org> parents: 2129 diff changeset	50	SDLKey sym; /*< SDL virtual key code - see ::SDLKey for details /
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1507 diff changeset	51	Uint16 mod; /*< current key modifiers /
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	52	Uint32 unicode; /*< \deprecated use SDL_TextInputEvent instead /
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	53	} SDL_keysym;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	54
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1507 diff changeset	55	/* Function prototypes */
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1507 diff changeset	56
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1507 diff changeset	57	/**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	58	* \brief Get the number of keyboard input devices available.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	59	*
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	60	* \sa SDL_SelectKeyboard()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1507 diff changeset	61	*/
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1507 diff changeset	62	extern DECLSPEC int SDLCALL SDL_GetNumKeyboards(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	63
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1507 diff changeset	64	/**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	65	* \brief Set the index of the currently selected keyboard.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	66	*
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	67	* \return The index of the previously selected keyboard.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	68	*
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	69	* \note You can query the currently selected keyboard by passing an index of -1.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	70	*
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	71	* \sa SDL_GetNumKeyboards()
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1507 diff changeset	72	*/
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1507 diff changeset	73	extern DECLSPEC int SDLCALL SDL_SelectKeyboard(int index);
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1507 diff changeset	74
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1507 diff changeset	75	/**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	76	* \brief Get a snapshot of the current state of the selected keyboard.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	77	*
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	78	* \param numkeys if non-NULL, receives the length of the returned array.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	79	*
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	80	* \return An array of key states. Indexes into this array are obtained by using ::SDL_scancode values.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	81	*
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	82	* \b Example:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	83	* \code
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	84	* Uint8 *state = SDL_GetKeyboardState(NULL);
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	85	* if ( state[SDL_SCANCODE_RETURN] ) {
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	86	* printf("<RETURN> is pressed.\n");
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	87	* }
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	88	* \endcode
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	89	*/
2303 d87417504c75 First pass implementation of new SDL scancode concept, as discussed with Sam Lantinga <slouken@libsdl.org> parents: 2268 diff changeset	90	extern DECLSPEC Uint8 SDLCALL SDL_GetKeyboardState(int numkeys);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	91
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1507 diff changeset	92	/**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	93	* \brief Get the current key modifier state for the selected keyboard.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	94	*/
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	95	extern DECLSPEC SDLMod SDLCALL SDL_GetModState(void);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	96
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1507 diff changeset	97	/**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	98	* \brief Set the current key modifier state for the selected keyboard.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	99	*
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	100	* \note This does not change the keyboard state, only the key modifier flags.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	101	*/
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	102	extern DECLSPEC void SDLCALL SDL_SetModState(SDLMod modstate);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	103
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1507 diff changeset	104	/**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	105	* \brief Get the key code corresponding to the given scancode according to the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	106	* current keyboard layout.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	107	*
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	108	* See ::SDLKey for details.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	109	*
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	110	* \sa SDL_GetKeyName()
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	111	*/
2303 d87417504c75 First pass implementation of new SDL scancode concept, as discussed with Sam Lantinga <slouken@libsdl.org> parents: 2268 diff changeset	112	extern DECLSPEC SDLKey SDLCALL SDL_GetKeyFromScancode(SDL_scancode scancode);
d87417504c75 First pass implementation of new SDL scancode concept, as discussed with Sam Lantinga <slouken@libsdl.org> parents: 2268 diff changeset	113
d87417504c75 First pass implementation of new SDL scancode concept, as discussed with Sam Lantinga <slouken@libsdl.org> parents: 2268 diff changeset	114	/**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	115	* \brief Get the scancode corresponding to the given key code according to the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	116	* current keyboard layout.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	117	*
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	118	* See ::SDL_scancode for details.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	119	*
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	120	* \sa SDL_GetScancodeName()
2303 d87417504c75 First pass implementation of new SDL scancode concept, as discussed with Sam Lantinga <slouken@libsdl.org> parents: 2268 diff changeset	121	*/
d87417504c75 First pass implementation of new SDL scancode concept, as discussed with Sam Lantinga <slouken@libsdl.org> parents: 2268 diff changeset	122	extern DECLSPEC SDL_scancode SDLCALL SDL_GetScancodeFromKey(SDLKey key);
2268 4baee598306d Date: Thu, 05 Jul 2007 14:02:33 -0700 Sam Lantinga <slouken@libsdl.org> parents: 2129 diff changeset	123
4baee598306d Date: Thu, 05 Jul 2007 14:02:33 -0700 Sam Lantinga <slouken@libsdl.org> parents: 2129 diff changeset	124	/**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	125	* \brief Get a human-readable name for a scancode.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	126	*
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	127	* \return A pointer to a UTF-8 string that stays valid at least until the next
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	128	* call to this function. If you need it around any longer, you must
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	129	* copy it. If the scancode doesn't have a name, this function returns
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	130	* an empty string ("").
2303 d87417504c75 First pass implementation of new SDL scancode concept, as discussed with Sam Lantinga <slouken@libsdl.org> parents: 2268 diff changeset	131	*
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	132	* \sa SDL_scancode
2303 d87417504c75 First pass implementation of new SDL scancode concept, as discussed with Sam Lantinga <slouken@libsdl.org> parents: 2268 diff changeset	133	*/
d87417504c75 First pass implementation of new SDL scancode concept, as discussed with Sam Lantinga <slouken@libsdl.org> parents: 2268 diff changeset	134	extern DECLSPEC const char *SDLCALL SDL_GetScancodeName(SDL_scancode
d87417504c75 First pass implementation of new SDL scancode concept, as discussed with Sam Lantinga <slouken@libsdl.org> parents: 2268 diff changeset	135	scancode);
d87417504c75 First pass implementation of new SDL scancode concept, as discussed with Sam Lantinga <slouken@libsdl.org> parents: 2268 diff changeset	136
d87417504c75 First pass implementation of new SDL scancode concept, as discussed with Sam Lantinga <slouken@libsdl.org> parents: 2268 diff changeset	137	/**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	138	* \brief Get a human-readable name for a key.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	139	*
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	140	* \return A pointer to a UTF-8 string that stays valid at least until the next
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	141	* call to this function. If you need it around any longer, you must
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	142	* copy it. If the key doesn't have a name, this function returns an
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	143	* empty string ("").
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	144	*
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	145	* \sa SDLKey
2268 4baee598306d Date: Thu, 05 Jul 2007 14:02:33 -0700 Sam Lantinga <slouken@libsdl.org> parents: 2129 diff changeset	146	*/
2303 d87417504c75 First pass implementation of new SDL scancode concept, as discussed with Sam Lantinga <slouken@libsdl.org> parents: 2268 diff changeset	147	extern DECLSPEC const char *SDLCALL SDL_GetKeyName(SDLKey key);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	148
3280 00cace2d9080 Merged a cleaned up version of Jiang's code changes from Google Summer of Code 2009 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	149	/**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	150	* \brief Start accepting Unicode text input events.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	151	*
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	152	* \sa SDL_StopTextInput()
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	153	* \sa SDL_SetTextInputRect()
3280 00cace2d9080 Merged a cleaned up version of Jiang's code changes from Google Summer of Code 2009 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	154	*/
00cace2d9080 Merged a cleaned up version of Jiang's code changes from Google Summer of Code 2009 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	155	extern DECLSPEC void SDLCALL SDL_StartTextInput(void);
00cace2d9080 Merged a cleaned up version of Jiang's code changes from Google Summer of Code 2009 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	156
00cace2d9080 Merged a cleaned up version of Jiang's code changes from Google Summer of Code 2009 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	157	/**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	158	* \brief Stop receiving any text input events.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	159	*
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	160	* \sa SDL_StartTextInput()
3280 00cace2d9080 Merged a cleaned up version of Jiang's code changes from Google Summer of Code 2009 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	161	*/
00cace2d9080 Merged a cleaned up version of Jiang's code changes from Google Summer of Code 2009 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	162	extern DECLSPEC void SDLCALL SDL_StopTextInput(void);
00cace2d9080 Merged a cleaned up version of Jiang's code changes from Google Summer of Code 2009 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	163
00cace2d9080 Merged a cleaned up version of Jiang's code changes from Google Summer of Code 2009 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	164	/**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	165	* \brief Set the rectangle used to type Unicode text inputs.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	166	*
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3280 diff changeset	167	* \sa SDL_StartTextInput()
3280 00cace2d9080 Merged a cleaned up version of Jiang's code changes from Google Summer of Code 2009 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	168	*/
00cace2d9080 Merged a cleaned up version of Jiang's code changes from Google Summer of Code 2009 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	169	extern DECLSPEC void SDLCALL SDL_SetTextInputRect(SDL_Rect *rect);
00cace2d9080 Merged a cleaned up version of Jiang's code changes from Google Summer of Code 2009 Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	170
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	171
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	172	/* Ends C function definitions when using C++ */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	173	#ifdef __cplusplus
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1507 diff changeset	174	/* INDENT-OFF */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	175	}
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1507 diff changeset	176	/* INDENT-ON */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	177	#endif
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	178	#include "close_code.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	179
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	180	#endif /* _SDL_keyboard_h */
1895 c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1507 diff changeset	181
c121d94672cb SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head. Sam Lantinga <slouken@libsdl.org> parents: 1507 diff changeset	182	/* vi: set ts=4 sw=4 expandtab: */

author	Sam Lantinga <slouken@libsdl.org>
	Mon, 19 Oct 2009 13:31:58 +0000
changeset 3407	d3baf5ac4e37
parent 3280	00cace2d9080
child 3697	f7b03b6838cb
permissions	-rw-r--r--