SDL 3.0
SDL_TextEditingCandidatesEvent Struct Reference

#include <SDL_events.h>

Data Fields

SDL_EventType type
 
Uint32 reserved
 
Uint64 timestamp
 
SDL_WindowID windowID
 
const char *const * candidates
 
Sint32 num_candidates
 
Sint32 selected_candidate
 
SDL_bool horizontal
 

Detailed Description

Keyboard IME candidates event structure (event.edit_candidates.*)

Since
This struct is available since SDL 3.0.0.

Definition at line 373 of file SDL_events.h.

Field Documentation

◆ candidates

const char* const* SDL_TextEditingCandidatesEvent::candidates

The list of candidates, or NULL if there are no candidates available

Definition at line 379 of file SDL_events.h.

◆ horizontal

SDL_bool SDL_TextEditingCandidatesEvent::horizontal

SDL_TRUE if the list is horizontal, SDL_FALSE if it's vertical

Definition at line 382 of file SDL_events.h.

◆ num_candidates

Sint32 SDL_TextEditingCandidatesEvent::num_candidates

The number of strings in candidates

Definition at line 380 of file SDL_events.h.

◆ reserved

Uint32 SDL_TextEditingCandidatesEvent::reserved

Definition at line 376 of file SDL_events.h.

◆ selected_candidate

Sint32 SDL_TextEditingCandidatesEvent::selected_candidate

The index of the selected candidate, or -1 if no candidate is selected

Definition at line 381 of file SDL_events.h.

◆ timestamp

Uint64 SDL_TextEditingCandidatesEvent::timestamp

In nanoseconds, populated using SDL_GetTicksNS()

Definition at line 377 of file SDL_events.h.

◆ type

SDL_EventType SDL_TextEditingCandidatesEvent::type

SDL_EVENT_TEXT_EDITING_CANDIDATES

Definition at line 375 of file SDL_events.h.

◆ windowID

SDL_WindowID SDL_TextEditingCandidatesEvent::windowID

The window with keyboard focus, if any

Definition at line 378 of file SDL_events.h.


The documentation for this struct was generated from the following file: