sdl-ios-xcode: touchTest/Iphone Test/touchTestIPhone2/touchTestIPhone/include/SDL

annotate touchTest/Iphone Test/touchTestIPhone2/touchTestIPhone/include/SDL_keyboard.h @ 4691:73f5c530afac

Fixed hgIgnore to ignore test/gesturetest

author	Jim Grandpre <jim.tla@gmail.com>
date	Thu, 19 Aug 2010 13:49:11 -0400
parents	31607094315c
children

rev	line source
4677 31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	1 /*
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	2 SDL - Simple DirectMedia Layer
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	3 Copyright (C) 1997-2010 Sam Lantinga
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	4
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	5 This library is free software; you can redistribute it and/or
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	6 modify it under the terms of the GNU Lesser General Public
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	7 License as published by the Free Software Foundation; either
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	8 version 2.1 of the License, or (at your option) any later version.
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	9
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	10 This library is distributed in the hope that it will be useful,
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	11 but WITHOUT ANY WARRANTY; without even the implied warranty of
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	13 Lesser General Public License for more details.
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	14
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	15 You should have received a copy of the GNU Lesser General Public
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	16 License along with this library; if not, write to the Free Software
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	18
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	19 Sam Lantinga
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	20 slouken@libsdl.org
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	21 */
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	22
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	23 /**
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	24 * \file SDL_keyboard.h
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	25 *
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	26 * Include file for SDL keyboard event handling
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	27 */
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	28
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	29 #ifndef _SDL_keyboard_h
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	30 #define _SDL_keyboard_h
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	31
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	32 #include "SDL_stdinc.h"
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	33 #include "SDL_error.h"
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	34 #include "SDL_keysym.h"
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	35 #include "SDL_video.h"
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	36
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	37 #include "begin_code.h"
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	38 /* Set up for C function definitions, even when using C++ */
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	39 #ifdef __cplusplus
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	40 /* INDENT-OFF */
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	41 extern "C" {
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	42 /* INDENT-ON */
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	43 #endif
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	44
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	45 /**
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	46 * \brief The SDL keysym structure, used in key events.
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	47 */
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	48 typedef struct SDL_keysym
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	49 {
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	50 SDL_scancode scancode; /*< SDL physical key code - see ::SDL_scancode for details /
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	51 SDLKey sym; /*< SDL virtual key code - see ::SDLKey for details /
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	52 Uint16 mod; /*< current key modifiers /
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	53 Uint32 unicode; /*< \deprecated use SDL_TextInputEvent instead /
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	54 } SDL_keysym;
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	55
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	56 /* Function prototypes */
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	57
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	58 /**
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	59 * \brief Get the window which currently has keyboard focus.
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	60 */
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	61 extern DECLSPEC SDL_Window * SDLCALL SDL_GetKeyboardFocus(void);
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	62
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	63 /**
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	64 * \brief Get a snapshot of the current state of the keyboard.
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	65 *
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	66 * \param numkeys if non-NULL, receives the length of the returned array.
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	67 *
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	68 * \return An array of key states. Indexes into this array are obtained by using ::SDL_scancode values.
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	69 *
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	70 * \b Example:
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	71 * \code
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	72 * Uint8 *state = SDL_GetKeyboardState(NULL);
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	73 * if ( state[SDL_SCANCODE_RETURN] ) {
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	74 * printf("<RETURN> is pressed.\n");
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	75 * }
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	76 * \endcode
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	77 */
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	78 extern DECLSPEC Uint8 SDLCALL SDL_GetKeyboardState(int numkeys);
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	79
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	80 /**
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	81 * \brief Get the current key modifier state for the keyboard.
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	82 */
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	83 extern DECLSPEC SDLMod SDLCALL SDL_GetModState(void);
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	84
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	85 /**
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	86 * \brief Set the current key modifier state for the keyboard.
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	87 *
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	88 * \note This does not change the keyboard state, only the key modifier flags.
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	89 */
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	90 extern DECLSPEC void SDLCALL SDL_SetModState(SDLMod modstate);
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	91
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	92 /**
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	93 * \brief Get the key code corresponding to the given scancode according
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	94 * to the current keyboard layout.
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	95 *
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	96 * See ::SDLKey for details.
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	97 *
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	98 * \sa SDL_GetKeyName()
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	99 */
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	100 extern DECLSPEC SDLKey SDLCALL SDL_GetKeyFromScancode(SDL_scancode scancode);
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	101
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	102 /**
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	103 * \brief Get the scancode corresponding to the given key code according to the
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	104 * current keyboard layout.
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	105 *
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	106 * See ::SDL_scancode for details.
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	107 *
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	108 * \sa SDL_GetScancodeName()
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	109 */
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	110 extern DECLSPEC SDL_scancode SDLCALL SDL_GetScancodeFromKey(SDLKey key);
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	111
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	112 /**
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	113 * \brief Get a human-readable name for a scancode.
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	114 *
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	115 * \return A pointer to a UTF-8 string that stays valid at least until the next
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	116 * call to this function. If you need it around any longer, you must
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	117 * copy it. If the scancode doesn't have a name, this function returns
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	118 * an empty string ("").
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	119 *
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	120 * \sa SDL_scancode
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	121 */
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	122 extern DECLSPEC const char *SDLCALL SDL_GetScancodeName(SDL_scancode
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	123 scancode);
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	124
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	125 /**
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	126 * \brief Get a human-readable name for a key.
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	127 *
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	128 * \return A pointer to a UTF-8 string that stays valid at least until the next
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	129 * call to this function. If you need it around any longer, you must
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	130 * copy it. If the key doesn't have a name, this function returns an
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	131 * empty string ("").
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	132 *
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	133 * \sa SDLKey
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	134 */
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	135 extern DECLSPEC const char *SDLCALL SDL_GetKeyName(SDLKey key);
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	136
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	137 /**
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	138 * \brief Start accepting Unicode text input events.
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	139 *
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	140 * \sa SDL_StopTextInput()
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	141 * \sa SDL_SetTextInputRect()
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	142 */
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	143 extern DECLSPEC void SDLCALL SDL_StartTextInput(void);
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	144
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	145 /**
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	146 * \brief Stop receiving any text input events.
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	147 *
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	148 * \sa SDL_StartTextInput()
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	149 */
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	150 extern DECLSPEC void SDLCALL SDL_StopTextInput(void);
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	151
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	152 /**
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	153 * \brief Set the rectangle used to type Unicode text inputs.
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	154 *
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	155 * \sa SDL_StartTextInput()
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	156 */
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	157 extern DECLSPEC void SDLCALL SDL_SetTextInputRect(SDL_Rect *rect);
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	158
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	159
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	160 /* Ends C function definitions when using C++ */
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	161 #ifdef __cplusplus
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	162 /* INDENT-OFF */
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	163 }
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	164 /* INDENT-ON */
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	165 #endif
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	166 #include "close_code.h"
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	167
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	168 #endif /* _SDL_keyboard_h */
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	169
31607094315c Added Iphone project. Iphone multi-touch is now functional. jimtla parents: diff changeset	170 /* vi: set ts=4 sw=4 expandtab: */

Mercurial > sdl-ios-xcode

annotate touchTest/Iphone Test/touchTestIPhone2/touchTestIPhone/include/SDL_keyboard.h @ 4691:73f5c530afac