CProgressDialog
Dialog that displays progress for a long-running operation and optionally allows cancellation.
import { CProgressDialog } from "canvas-toolkit-lib";Declared members
static readonly DefaultWidth = 360;static readonly DefaultHeight = 120;static readonly Margin = 12;static readonly Spacing = 6;readonly canceled: CSignal<[]>;Emitted when the operation is canceled.
constructor(labelText?: string, cancelButton?: boolean, minimum?: number, maximum?: number, parent?: CWidget | null);Creates a progress dialog. @param labelText Text describing the operation. @param cancelButton Whether to show a Cancel button. @param minimum Minimum progress value. @param maximum Maximum progress value. @param parent Optional parent widget.
labelText(): string;Returns the operation label text. @returns Current label text.
setLabelText(text: string): void;Sets the operation label text. @param text New label text.
minimum(): number;Returns the minimum progress value. @returns Minimum value.
setMinimum(minimum: number): void;Sets the minimum progress value. @param minimum Minimum value.
maximum(): number;Returns the maximum progress value. @returns Maximum value.
setMaximum(maximum: number): void;Sets the maximum progress value. @param maximum Maximum value.
setRange(minimum: number, maximum: number): void;Sets the progress range. @param minimum Minimum value. @param maximum Maximum value.
value(): number;Returns the current progress value. @returns Current value.
setValue(value: number): void;Sets the current progress value. @param value New progress value.
autoClose(): boolean;Returns whether completion automatically accepts and closes the dialog. @returns `true` when auto-close is enabled.
setAutoClose(autoClose: boolean): void;Enables or disables automatic closing on completion. @param autoClose `true` to close automatically at the maximum value.
wasCanceled(): boolean;Returns whether the user canceled the operation. @returns `true` if cancellation was requested.
cancel(): void;Marks the operation as canceled, emits `canceled`, and rejects the dialog.