2006-07-10 21:04:37 +00:00
|
|
|
/*
|
2011-04-08 13:03:26 -07:00
|
|
|
Simple DirectMedia Layer
|
2011-12-31 09:28:07 -05:00
|
|
|
Copyright (C) 1997-2012 Sam Lantinga <slouken@libsdl.org>
|
2011-04-08 13:03:26 -07:00
|
|
|
|
|
|
|
This software is provided 'as-is', without any express or implied
|
|
|
|
warranty. In no event will the authors be held liable for any damages
|
|
|
|
arising from the use of this software.
|
|
|
|
|
|
|
|
Permission is granted to anyone to use this software for any purpose,
|
|
|
|
including commercial applications, and to alter it and redistribute it
|
|
|
|
freely, subject to the following restrictions:
|
|
|
|
|
|
|
|
1. The origin of this software must not be misrepresented; you must not
|
|
|
|
claim that you wrote the original software. If you use this software
|
|
|
|
in a product, an acknowledgment in the product documentation would be
|
|
|
|
appreciated but is not required.
|
|
|
|
2. Altered source versions must be plainly marked as such, and must not be
|
|
|
|
misrepresented as being the original software.
|
|
|
|
3. This notice may not be removed or altered from any source distribution.
|
2006-07-10 21:04:37 +00:00
|
|
|
*/
|
|
|
|
#include "SDL_config.h"
|
|
|
|
|
|
|
|
#ifndef _SDL_keyboard_c_h
|
|
|
|
#define _SDL_keyboard_c_h
|
|
|
|
|
2011-02-16 15:46:12 -08:00
|
|
|
#include "SDL_keycode.h"
|
2006-07-10 21:04:37 +00:00
|
|
|
#include "SDL_events.h"
|
|
|
|
|
|
|
|
/* Initialize the keyboard subsystem */
|
|
|
|
extern int SDL_KeyboardInit(void);
|
|
|
|
|
2010-05-09 20:47:22 -07:00
|
|
|
/* Clear the state of the keyboard */
|
|
|
|
extern void SDL_ResetKeyboard(void);
|
2006-07-10 21:04:37 +00:00
|
|
|
|
2008-02-05 07:19:23 +00:00
|
|
|
/* Get the default keymap */
|
2011-02-07 10:40:21 -08:00
|
|
|
extern void SDL_GetDefaultKeymap(SDL_Keycode * keymap);
|
2008-02-05 07:19:23 +00:00
|
|
|
|
2010-05-09 20:47:22 -07:00
|
|
|
/* Set the mapping of scancode to key codes */
|
2011-02-07 10:40:21 -08:00
|
|
|
extern void SDL_SetKeymap(int start, SDL_Keycode * keys, int length);
|
2008-02-05 07:19:23 +00:00
|
|
|
|
Date: Thu, 05 Jul 2007 14:02:33 -0700
From: Sam Lantinga
Subject: SDL 1.3 keyboard plan
After lots of discussion with Christian, this is what we came up with:
> So, to sum up...
> SDLK_* become the physical keys, starting at > (1<<21)
> We create a macro SDLK_INDEX(X)
> We have two functions SDL_GetLayoutKey(SDLKey) and SDL_GetKeyName()
> SDL_GetLayoutKey maps to UCS4 for printable characters, and SDLK* for
non-printable characters
> and does so based on the OS's current keyboard layout
> SDL_GetKeyName() handles both SDLK_* and UCS4, converting UCS4 to UTF-8 and
converting SDLK_* into our names, which are UTF-8 for printable characters.
> WASD folks use SDLK_*, and 'I' folks use SDL_GetLayoutKey(SDLK_*)
Here is the patch he came up with, and his e-mail about it:
Date: Fri, 17 Aug 2007 19:50:28 +0200
From: Christian Walther
Subject: Re: SDL 1.3 keyboard plan
> Sounds great, go ahead and send me a patch.
Here goes! Thanks for having a look. Don't hesitate to comment if
anything does not conform to your ideas.
One caveat: Committing this now may break compilability of some video
drivers - specifically, if they use any of the SDLK_* codes that were
obsoleted and moved into SDL_compat.h. I only tried Cocoa (which did
break, but is already fixed) and X11 (which didn't, but then its key
handling is #iffed out). If that's a problem, it may need to go into
a branch.
-Christian
--HG--
extra : convert_revision : svn%3Ac70aab31-4412-0410-b14c-859654838e24/trunk%402630
2007-08-19 14:52:52 +00:00
|
|
|
/* Set a platform-dependent key name, overriding the default platform-agnostic
|
|
|
|
name. Encoded as UTF-8. The string is not copied, thus the pointer given to
|
|
|
|
this function must stay valid forever (or at least until the call to
|
|
|
|
VideoQuit()). */
|
2011-02-07 09:37:11 -08:00
|
|
|
extern void SDL_SetScancodeName(SDL_Scancode scancode, const char *name);
|
Date: Thu, 05 Jul 2007 14:02:33 -0700
From: Sam Lantinga
Subject: SDL 1.3 keyboard plan
After lots of discussion with Christian, this is what we came up with:
> So, to sum up...
> SDLK_* become the physical keys, starting at > (1<<21)
> We create a macro SDLK_INDEX(X)
> We have two functions SDL_GetLayoutKey(SDLKey) and SDL_GetKeyName()
> SDL_GetLayoutKey maps to UCS4 for printable characters, and SDLK* for
non-printable characters
> and does so based on the OS's current keyboard layout
> SDL_GetKeyName() handles both SDLK_* and UCS4, converting UCS4 to UTF-8 and
converting SDLK_* into our names, which are UTF-8 for printable characters.
> WASD folks use SDLK_*, and 'I' folks use SDL_GetLayoutKey(SDLK_*)
Here is the patch he came up with, and his e-mail about it:
Date: Fri, 17 Aug 2007 19:50:28 +0200
From: Christian Walther
Subject: Re: SDL 1.3 keyboard plan
> Sounds great, go ahead and send me a patch.
Here goes! Thanks for having a look. Don't hesitate to comment if
anything does not conform to your ideas.
One caveat: Committing this now may break compilability of some video
drivers - specifically, if they use any of the SDLK_* codes that were
obsoleted and moved into SDL_compat.h. I only tried Cocoa (which did
break, but is already fixed) and X11 (which didn't, but then its key
handling is #iffed out). If that's a problem, it may need to go into
a branch.
-Christian
--HG--
extra : convert_revision : svn%3Ac70aab31-4412-0410-b14c-859654838e24/trunk%402630
2007-08-19 14:52:52 +00:00
|
|
|
|
2006-07-10 21:04:37 +00:00
|
|
|
/* Set the keyboard focus window */
|
2010-05-09 20:47:22 -07:00
|
|
|
extern void SDL_SetKeyboardFocus(SDL_Window * window);
|
2006-07-10 21:04:37 +00:00
|
|
|
|
2010-05-09 20:47:22 -07:00
|
|
|
/* Send a keyboard key event */
|
2011-02-07 09:37:11 -08:00
|
|
|
extern int SDL_SendKeyboardKey(Uint8 state, SDL_Scancode scancode);
|
2006-07-10 21:04:37 +00:00
|
|
|
|
2010-05-09 20:47:22 -07:00
|
|
|
/* Send keyboard text input */
|
|
|
|
extern int SDL_SendKeyboardText(const char *text);
|
2006-07-10 21:04:37 +00:00
|
|
|
|
2009-09-19 13:29:40 +00:00
|
|
|
/* Send editing text for selected range from start to end */
|
2010-05-09 20:47:22 -07:00
|
|
|
extern int SDL_SendEditingText(const char *text, int start, int end);
|
2009-09-19 13:29:40 +00:00
|
|
|
|
2006-07-10 21:04:37 +00:00
|
|
|
/* Shutdown the keyboard subsystem */
|
|
|
|
extern void SDL_KeyboardQuit(void);
|
|
|
|
|
|
|
|
#endif /* _SDL_keyboard_c_h */
|
|
|
|
|
|
|
|
/* vi: set ts=4 sw=4 expandtab: */
|