include/SDL_system.h
author Sam Lantinga <slouken@libsdl.org>
Sun, 04 Nov 2012 21:53:28 -0800
changeset 6654 2ecfb25be1e2
parent 6646 dd32cce44d3c
child 6683 b1124b32b07d
permissions -rw-r--r--
Synchronized the on-screen keyboard state with whether we are accepting text input.
The functions to show/hide/toggle the on-screen keyboard have been folded into the text input state.
Calling SDL_StartTextInput() will automatically show the on-screen keyboard if it's available.
Calling SDL_StopTextInput() will automatically hide the on-screen keyboard if it's available.
There is a new API function SDL_IsTextInputActive() which will return whether text input is currently active.
Text input is disabled by default, you must call SDL_StartTextInput() when you are ready to accept text input.
SDL_HasScreenKeyboardSupport() no longer needs to be passed a window.
The iPhone-specific on-screen keyboard functions have been removed.
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2012 Sam Lantinga <slouken@libsdl.org>
     4 
     5   This software is provided 'as-is', without any express or implied
     6   warranty.  In no event will the authors be held liable for any damages
     7   arising from the use of this software.
     8 
     9   Permission is granted to anyone to use this software for any purpose,
    10   including commercial applications, and to alter it and redistribute it
    11   freely, subject to the following restrictions:
    12 
    13   1. The origin of this software must not be misrepresented; you must not
    14      claim that you wrote the original software. If you use this software
    15      in a product, an acknowledgment in the product documentation would be
    16      appreciated but is not required.
    17   2. Altered source versions must be plainly marked as such, and must not be
    18      misrepresented as being the original software.
    19   3. This notice may not be removed or altered from any source distribution.
    20 */
    21 
    22 /**
    23  *  \file SDL_system.h
    24  *  
    25  *  Include file for platform specific SDL API functions
    26  */
    27 
    28 #ifndef _SDL_system_h
    29 #define _SDL_system_h
    30 
    31 #include "SDL_stdinc.h"
    32 
    33 #if __IPHONEOS__
    34 #include "SDL_video.h"
    35 #include "SDL_keyboard.h"
    36 #endif
    37 
    38 #include "begin_code.h"
    39 /* Set up for C function definitions, even when using C++ */
    40 #ifdef __cplusplus
    41 /* *INDENT-OFF* */
    42 extern "C" {
    43 /* *INDENT-ON* */
    44 #endif
    45 
    46 /* Platform specific functions for iOS */
    47 #if __IPHONEOS__
    48 
    49 extern DECLSPEC int SDLCALL SDL_iPhoneSetAnimationCallback(SDL_Window * window, int interval, void (*callback)(void*), void *callbackParam);
    50 extern DECLSPEC void SDLCALL SDL_iPhoneSetEventPump(SDL_bool enabled);
    51 
    52 #endif /* __IPHONEOS__ */
    53 
    54 
    55 /* Platform specific functions for Android */
    56 #if __ANDROID__
    57 
    58 /* Get the JNI environment for the current thread
    59    This returns JNIEnv*, but the prototype is void* so we don't need jni.h
    60  */
    61 extern DECLSPEC void * SDLCALL SDL_AndroidGetJNIEnv();
    62 
    63 /* Get the SDL Activity object for the application
    64    This returns jobject, but the prototype is void* so we don't need jni.h
    65  */
    66 extern DECLSPEC void * SDLCALL SDL_AndroidGetActivity();
    67 
    68 /* See the official Android developer guide for more information:
    69    http://developer.android.com/guide/topics/data/data-storage.html
    70 */
    71 #define SDL_ANDROID_EXTERNAL_STORAGE_READ   0x01
    72 #define SDL_ANDROID_EXTERNAL_STORAGE_WRITE  0x02
    73 
    74 /* Get the path used for internal storage for this application.
    75    This path is unique to your application and cannot be written to
    76    by other applications.
    77  */
    78 extern DECLSPEC const char * SDLCALL SDL_AndroidGetInternalStoragePath();
    79 
    80 /* Get the current state of external storage, a bitmask of these values:
    81     SDL_ANDROID_EXTERNAL_STORAGE_READ
    82     SDL_ANDROID_EXTERNAL_STORAGE_WRITE
    83    If external storage is currently unavailable, this will return 0.
    84 */
    85 extern DECLSPEC int SDLCALL SDL_AndroidGetExternalStorageState();
    86 
    87 /* Get the path used for external storage for this application.
    88    This path is unique to your application, but is public and can be
    89    written to by other applications.
    90  */
    91 extern DECLSPEC const char * SDLCALL SDL_AndroidGetExternalStoragePath();
    92 
    93 #endif /* __ANDROID__ */
    94 
    95 
    96 /* Ends C function definitions when using C++ */
    97 #ifdef __cplusplus
    98 /* *INDENT-OFF* */
    99 }
   100 /* *INDENT-ON* */
   101 #endif
   102 #include "close_code.h"
   103 
   104 #endif /* _SDL_system_h */
   105 
   106 /* vi: set ts=4 sw=4 expandtab: */