Canvas Toolkit
← Class index

CWizardDialog

Dialogs · extends CDialog

A branching wizard with history and a FIFO queue of deferred steps.

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

Declared members

readonly currentIdChanged: CSignal<[number]>;
readonly pageDeferred: CSignal<[number]>;
constructor(parent?: CWidget | null);
sizeHint(): CSize;
transitionsEnabled(): boolean;
setTransitionsEnabled(enabled: boolean): void;
transitionDuration(): number;
setTransitionDuration(duration: number): void;

Milliseconds; zero disables motion while keeping navigation synchronous.

stepListVisible(): boolean;
setStepListVisible(visible: boolean): void;

Hiding the informational step list restores the full page width.

button(role: CWizardButton): CPushButton;
pageIds(): number[];
page(id: number): CWizardPage | null;
currentId(): number;
currentPage(): CWizardPage | null;
visitedIds(): number[];
deferredPageIds(): number[];
startId(): number;
setStartId(id: number): void;
addPage(page: CWizardPage): number;
setPage(id: number, page: CWizardPage): void;

IDs must be unique nonnegative safe integers; a page belongs to only one wizard.

removePage(id: number): CWizardPage | null;

Detaches a page without destroying it. Removing a page restarts navigation.

restart(): void;

Starts a new navigation run; page widgets retain their data.

open(): void;
next(): void;

Advances after successful validation, or accepts on the final remaining step.

accept(): void;

Finish cannot bypass completeness, validation, a normal next step or deferred steps.

back(): void;
skipForNow(): void;
close(): void;
setVisible(visible: boolean): void;
setGeometry(x: number, y: number, width: number, height: number): void;
destroy(): void;