Canvas Toolkit
← Class index

CCompleter

Widgets · extends CObject

Provides popup completion for a line editor.

import { CCompleter } from "canvas-toolkit-lib";

Declared members

static readonly MaxVisibleItems = 10;
readonly activated: CSignal<[string]>;
readonly highlighted: CSignal<[string]>;
constructor(source?: string[] | CAbstractItemModel | null, parent?: CObject | null);
widget(): CLineEdit | null;
setWidget(widget: CLineEdit | null): void;
model(): CAbstractItemModel | null;
setModel(model: CAbstractItemModel | null): void;
stringList(): string[];
setStringList(strings: string[]): void;
completionColumn(): number;
setCompletionColumn(column: number): void;
caseSensitivity(): CCompleterCaseSensitivity;
setCaseSensitivity(sensitivity: CCompleterCaseSensitivity): void;
completionFilter(): ((value: string) => boolean) | null;

Additional filtering applied to both string and model sources.

setCompletionFilter(filter: ((value: string) => boolean) | null): void;
completionPrefix(): string;
completionCount(): number;
currentCompletion(): string;
popup(): CPopupWidget;
listWidget(): CListWidget;
complete(prefix?: string): void;
hidePopup(): void;
handleKeyEvent(event: CKeyEvent): boolean;

Handles completion navigation keys sent by the associated editor.

destroy(): void;