A structure that contains keyboard text input event information.
Uint32 |
type |
SDL_EVENT_TEXT_INPUT |
Uint32 |
timestamp |
timestamp of the event |
Uint32 |
windowID |
the window with keyboard focus, if any |
char[32] |
text |
the null-terminated input text in UTF-8 encoding |
SDL_TextInputEvent is a member of the SDL_Event union and is used when an event of type SDL_EVENT_TEXT_INPUT is reported. You would access it through the event's text field.
There is a tutorial.
Detailed explanation (from SDL mailing list by Jiang Jiang <gzjjgod at gmail.com>)
``` In a typical GUI application, the OS will be responsible for telling you the candidate text (via SDL_EVENT_TEXT_EDITING), you can choose how (and where) to show it in your UI. Let's say with an input method I typed "abc" and got unicode character "X", the SDL application will first receive three SDL_EVENT_TEXT_EDITING events with 'a', 'ab' and 'abc', then finally receive SDL_EVENT_TEXT_INPUT event with unicode character 'X'. During this text compositing process, user can press any arbitrary keys such as Function, backspace, both the SDL application and OS input method will receive it and decide whether to deal with these keys or not. For instance when user press backspace, most input methods will delete the last candidate character typed and SDL app will receive a new SDL_EVENT_TEXT_EDITING event (let's say user typed a, b, backspace, c, then the application will receive 4 events containing 'a', 'ab', 'a', 'ac' each).
SDL_SetTextInputRect() gives the OS a hint for where to show the candidate text list, since the OS doesn't know where you want to draw the text you received via SDL_EVENT_TEXT_EDITING event. ```
CategoryStruct, CategoryEvents