Class InputUIState

A data transfer object for the UI state.

Index

Constructors

Properties

candidatePageCount candidatePageIndex candidates composingBuffer cursorIndex tooltip

Constructors

constructor

new InputUIState(
    composingBuffer: ComposingBufferText[],
    cursorIndex: number,
    candidates: CandidateWrapper[],
    tooltip: string,
    candidatePageCount: number,
    candidatePageIndex: number,
): InputUIState
Parameters
- composingBuffer: ComposingBufferText[]
- cursorIndex: number
- candidates: CandidateWrapper[]
- tooltip: string
- candidatePageCount: number
- candidatePageIndex: number
Returns InputUIState
- Defined in McBopomofo/InputUI.ts:54

Properties

`Readonly`candidatePageCount

candidatePageCount: number

The total pages of the candidates,

`Readonly`candidatePageIndex

candidatePageIndex: number

The current page index of the candidates,

`Readonly`candidates

candidates: CandidateWrapper[]

The current page of the candidates.

`Readonly`composingBuffer

composingBuffer: ComposingBufferText[]

Represents the composing buffer.

`Readonly`cursorIndex

cursorIndex: number

The index of the cursor in the composing buffer.

`Readonly`tooltip

tooltip: string

The tooltip.