TSdlTextEditingCandidatesEvent

Keyboard IME candidates event structure (Event.TextCandidates.* )

Definition

type TSdlTextEditingCandidatesEvent = record ... end;

Name	Description
Candidates	Array of candidates, or nil if there are no candidates available
CandidatesPtr	Pointer to the list of candidates, or nil if there are no candidates available
IsHorizontal	True if the list is horizontal, False if it's vertical
Kind	Event kind (TSdlEventKind.TextEditingCandidates)
NumCandidates	The number of strings in `CandidatesPtr` and `Candidates`
SelectedCandidate	The index of the selected candidate, or -1 if no candidate is selected
Timestamp	In nanoseconds, populated using SdlGetTicksNS
Window	The window with keyboard focus, if any
WindowID	The ID of the window with keyboard focus, if any

Array of candidates, or nil if there are no candidates available

property Candidates: TArray<String> read GetCandidates

Type: TArray<String>

Pointer to the list of candidates, or nil if there are no candidates available

property CandidatesPtr: PPUTF8Char read FHandle.candidates

Type: PPUTF8Char

True if the list is horizontal, False if it's vertical

property IsHorizontal: Boolean read FHandle.horizontal

Type: Boolean

Event kind (TSdlEventKind.TextEditingCandidates)

property Kind: TSdlEventKind read GetKind

Type: TSdlEventKind

The number of strings in CandidatesPtr and Candidates

property NumCandidates: Integer read FHandle.num_candidates

Type: Integer

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

property SelectedCandidate: Integer read FHandle.selected_candidate

Type: Integer

In nanoseconds, populated using SdlGetTicksNS

property Timestamp: UInt64 read FHandle.timestamp

Type: UInt64

The window with keyboard focus, if any

property Window: TSdlWindow read GetWindow

Type: TSdlWindow

The ID of the window with keyboard focus, if any

property WindowID: TSdlWindowID read FHandle.windowID

Type: TSdlWindowID