Struct SDL_TextEditingCandidatesEvent 

#[repr(C)]
pub struct SDL_TextEditingCandidatesEvent {
    pub type: SDL_EventType,
    pub reserved: Uint32,
    pub timestamp: Uint64,
    pub windowID: SDL_WindowID,
    pub candidates: *const *const c_char,
    pub num_candidates: Sint32,
    pub selected_candidate: Sint32,
    pub horizontal: bool,
    pub padding1: Uint8,
    pub padding2: Uint8,
    pub padding3: Uint8,
}

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

Availability

This struct is available since SDL 3.2.0.

Notes for sdl3-sys

This struct has padding fields which shouldn’t be accessed directly; use struct update syntax with e.g. ..Default::default() for manual construction.

Fields

type: SDL_EventType

SDL_EVENT_TEXT_EDITING_CANDIDATES

reserved: Uint32

timestamp: Uint64

In nanoseconds, populated using SDL_GetTicksNS()

windowID: SDL_WindowID

The window with keyboard focus, if any

candidates: *const *const c_char

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

num_candidates: Sint32

The number of strings in candidates

selected_candidate: Sint32

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

horizontal: bool

true if the list is horizontal, false if it’s vertical

padding1: Uint8

👎Deprecated: padding fields are exempt from semver; init with ..Default::default()

padding2: Uint8

👎Deprecated: padding fields are exempt from semver; init with ..Default::default()

padding3: Uint8

👎Deprecated: padding fields are exempt from semver; init with ..Default::default()

Trait Implementations

impl Clone for SDL_TextEditingCandidatesEvent

fn clone(&self) -> SDL_TextEditingCandidatesEvent

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SDL_TextEditingCandidatesEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SDL_TextEditingCandidatesEvent

fn default() -> Self

Initialize all fields to zero

impl Copy for SDL_TextEditingCandidatesEvent