mirror
/
SDL
mirror of https://github.com/libsdl-org/SDL.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Added some documentation to the SDL_EVENT_TEXT_EDITING event

This commit is contained in:
Sam Lantinga 2024-06-24 17:13:56 -07:00
parent 01ae067504
commit 377014c430
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
include/SDL3/SDL_events.h
View File

@ -317,6 +317,8 @@ typedef struct SDL_KeyboardEvent
/** /**
* Keyboard text editing event structure (event.edit.*) * Keyboard text editing event structure (event.edit.*)
* *
* The start cursor is the position, in UTF-8 characters, where new typing will be inserted into the editing text. The length is the number of UTF-8 characters that will be replaced by new typing.
*
* The text string follows the SDL_GetStringRule. * The text string follows the SDL_GetStringRule.
* *
* \since This struct is available since SDL 3.0.0. * \since This struct is available since SDL 3.0.0.
@ -328,8 +330,8 @@ typedef struct SDL_TextEditingEvent
Uint64 timestamp; /**< In nanoseconds, populated using SDL_GetTicksNS() */ Uint64 timestamp; /**< In nanoseconds, populated using SDL_GetTicksNS() */
SDL_WindowID windowID; /**< The window with keyboard focus, if any */ SDL_WindowID windowID; /**< The window with keyboard focus, if any */
const char *text; /**< The editing text */ const char *text; /**< The editing text */
Sint32 start; /**< The start cursor of selected editing text */ Sint32 start; /**< The start cursor of selected editing text, or -1 if not set */
Sint32 length; /**< The length of selected editing text */ Sint32 length; /**< The length of selected editing text, or -1 if not set */
} SDL_TextEditingEvent; } SDL_TextEditingEvent;
/** /**