Added comments gsoc2008_iphone
authorHolmes Futrell <hfutrell@umail.ucsb.edu>
Sat, 16 Aug 2008 00:10:15 +0000
branchgsoc2008_iphone
changeset 24477683a2e0e5e9
parent 2446 69ca51fd121d
child 2448 e060950cbf30
Added comments
src/video/uikit/keyinfotable.h
     1.1 --- a/src/video/uikit/keyinfotable.h	Sat Aug 16 00:09:54 2008 +0000
     1.2 +++ b/src/video/uikit/keyinfotable.h	Sat Aug 16 00:10:15 2008 +0000
     1.3 @@ -1,10 +1,23 @@
     1.4  /*
     1.5 - *  scancodes_iphoneos.h
     1.6 - *  SDLiPhoneOS
     1.7 - *
     1.8 - *  Created by Holmes Futrell on 7/25/08.
     1.9 - *  Copyright 2008 __MyCompanyName__. All rights reserved.
    1.10 - *
    1.11 + SDL - Simple DirectMedia Layer
    1.12 + Copyright (C) 1997-2006 Sam Lantinga
    1.13 + 
    1.14 + This library is free software; you can redistribute it and/or
    1.15 + modify it under the terms of the GNU Lesser General Public
    1.16 + License as published by the Free Software Foundation; either
    1.17 + version 2.1 of the License, or (at your option) any later version.
    1.18 + 
    1.19 + This library is distributed in the hope that it will be useful,
    1.20 + but WITHOUT ANY WARRANTY; without even the implied warranty of
    1.21 + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    1.22 + Lesser General Public License for more details.
    1.23 + 
    1.24 + You should have received a copy of the GNU Lesser General Public
    1.25 + License along with this library; if not, write to the Free Software
    1.26 + Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    1.27 + 
    1.28 + Sam Lantinga
    1.29 + slouken@libsdl.org
    1.30   */
    1.31  
    1.32  #ifndef _UIKIT_KeyInfo
    1.33 @@ -12,6 +25,13 @@
    1.34  
    1.35  #include "SDL_scancode.h"
    1.36  
    1.37 +/*
    1.38 +	This file is used by the keyboard code in SDL_uikitview.m to convert between characters
    1.39 +	passed in from the iPhone's virtual keyboard, and tuples of SDL_scancodes and SDL_keymods.
    1.40 +	For example unicharToUIKeyInfoTable['a'] would give you the scan code and keymod for lower
    1.41 +	case a.
    1.42 +*/
    1.43 +
    1.44  typedef struct {
    1.45  	SDL_scancode code;
    1.46  	Uint16 mod;