From 377014c430e60403b9db70bd73b99ed86ac25149 Mon Sep 17 00:00:00 2001 From: Sam Lantinga Date: Mon, 24 Jun 2024 17:13:56 -0700 Subject: [PATCH] Added some documentation to the SDL_EVENT_TEXT_EDITING event --- include/SDL3/SDL_events.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/include/SDL3/SDL_events.h b/include/SDL3/SDL_events.h index fdde915a0..ecd7cf7fd 100644 --- a/include/SDL3/SDL_events.h +++ b/include/SDL3/SDL_events.h @@ -317,6 +317,8 @@ typedef struct SDL_KeyboardEvent /** * 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. * * \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() */ SDL_WindowID windowID; /**< The window with keyboard focus, if any */ const char *text; /**< The editing text */ - Sint32 start; /**< The start cursor of selected editing text */ - Sint32 length; /**< The length 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, or -1 if not set */ } SDL_TextEditingEvent; /**