---
name: "SDL_TextEditingCandidatesEvent"
section: "3type"
platform: "linux"
package: "libsdl3-doc"
version: "3.2.10+ds-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/SDL_TextEditingCandidatesEvent"
---

# SDL\_TextEditingCandidatesEvent(3type)

Keyboard IME candidates event structure (event.edit\_candidates.\*)

## NAME

SDL\_TextEditingCandidatesEvent - Keyboard IME candidates event structure (event.edit\_candidates.\*)

## HEADER FILE

Defined in SDL3/SDL\_events.h

## SYNOPSIS

```
#include "SDL3/SDL.h"
```

**typedef struct SDL\_TextEditingCandidatesEvent** **{**     **SDL\_EventType type;         /\*\*\< SDL\_EVENT\_TEXT\_EDITING\_CANDIDATES \*/**     **Uint32 reserved;**     **Uint64 timestamp;           /\*\*\< In nanoseconds, populated using SDL\_GetTicksNS() \*/**     **SDL\_WindowID windowID;      /\*\*\< The window with keyboard focus, if any \*/**     **const char \* const \*candidates;    /\*\*\< The list of candidates, or NULL if there are no candidates available \*/**     **Sint32 num\_candidates;      /\*\*\< The number of strings in \`candidates\` \*/**     **Sint32 selected\_candidate;  /\*\*\< The index of the selected candidate, or -1 if no candidate is selected \*/**     **bool horizontal;          /\*\*\< true if the list is horizontal, false if it's vertical \*/**     **Uint8 padding1;**     **Uint8 padding2;**     **Uint8 padding3;** **} SDL\_TextEditingCandidatesEvent;**

## AVAILABILITY

This struct is available since SDL 3.2.0.