author Sam Lantinga <>
Wed, 03 Oct 2012 20:49:16 -0700
changeset 6555 f2c03c06d987
parent 6464 ab55284b389f
child 6642 b716011e53ce
permissions -rw-r--r--
Fixed bug 1614 - SDL for Android does not implement TextInput API

Andrey Isakov 2012-10-03 08:30:25 PDT

I've found out in the process of porting one OS project to Android/SDL2 that
there is no support for TextInput events/APIs on Android.
So I implemented some kind of initial support of that feature, and at the very
least it seems to work fine with latin chars input with soft and hardware
keyboards on my Moto Milestone2. I've also tried playing around with more
complex IMEs, like japanese, logging the process and it seemed to work too. I'm
not sure since the app itself I am working on does not have support for
non-latin input.

The main point of the patch is to place a fake input view in the region
specified by SDL_SetTextInputRect and create a custom InputConnection for it.
The reason to make it a separate view is to support Android's pan&scan on input
feature properly. For details please refer to
Even though the manual states that SetTextInputRect is used to determine the
IME variants position, I thought this would be a proper use for this too.
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2012 Sam Lantinga <>
     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.
     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:
    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 #include "SDL_config.h"
    23 /* Set up for C function definitions, even when using C++ */
    24 #ifdef __cplusplus
    25 /* *INDENT-OFF* */
    26 extern "C" {
    27 /* *INDENT-ON* */
    28 #endif
    30 #include "SDL_rect.h"
    32 /* Interface from the SDL library into the Android Java activity */
    33 extern SDL_bool Android_JNI_CreateContext(int majorVersion, int minorVersion);
    34 extern void Android_JNI_SwapWindow();
    35 extern void Android_JNI_SetActivityTitle(const char *title);
    36 extern SDL_bool Android_JNI_GetAccelerometerValues(float values[3]);
    37 extern int Android_JNI_ShowTextInput(SDL_Rect *inputRect);
    39 // Audio support
    40 extern int Android_JNI_OpenAudioDevice(int sampleRate, int is16Bit, int channelCount, int desiredBufferFrames);
    41 extern void* Android_JNI_GetAudioBuffer();
    42 extern void Android_JNI_WriteAudioBuffer();
    43 extern void Android_JNI_CloseAudioDevice();
    45 #include "SDL_rwops.h"
    47 int Android_JNI_FileOpen(SDL_RWops* ctx, const char* fileName, const char* mode);
    48 long Android_JNI_FileSeek(SDL_RWops* ctx, long offset, int whence);
    49 size_t Android_JNI_FileRead(SDL_RWops* ctx, void* buffer, size_t size, size_t maxnum);
    50 size_t Android_JNI_FileWrite(SDL_RWops* ctx, const void* buffer, size_t size, size_t num);
    51 int Android_JNI_FileClose(SDL_RWops* ctx);
    53 /* Clipboard support */
    54 int Android_JNI_SetClipboardText(const char* text);
    55 char* Android_JNI_GetClipboardText();
    56 SDL_bool Android_JNI_HasClipboardText();
    58 /* Power support */
    59 int Android_JNI_GetPowerInfo(int* plugged, int* charged, int* battery, int* seconds, int* percent);
    61 // Threads
    62 #include <jni.h>
    63 static void Android_JNI_ThreadDestroyed(void*);
    64 JNIEnv *Android_JNI_GetEnv(void);
    65 int Android_JNI_SetupThread(void);
    67 // Generic messages
    68 int Android_JNI_SendMessage(int command, int param);
    70 /* Ends C function definitions when using C++ */
    71 #ifdef __cplusplus
    72 /* *INDENT-OFF* */
    73 }
    74 /* *INDENT-ON* */
    75 #endif
    77 /* vi: set ts=4 sw=4 expandtab: */