Canvas Toolkit
← Class index

CSplashScreen

Widgets · extends CWidget

A frameless, non-modal startup window. Yield to the event loop while loading.

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

Declared members

readonly messageChanged: CSignal<[string]>;
constructor(pixmap?: CPixmap | null);

Creates a hidden splash, sized to its image or to a 400 x 240 fallback.

pixmap(): CPixmap | null;
message(): string;
setPixmap(pixmap: CPixmap | null): void;

Replaces the background image and adopts its natural dimensions.

sizeHint(): CSize;
showMessage(message: string, alignment?: CAlignment, color?: CColor | string): void;

Displays startup text. Colors may be CColor values or CSS color strings.

clearMessage(): void;
setVisible(visible: boolean): void;

Uses the existing window stack; no modal scope or focus change is introduced.

close(): void;
fadeOut(duration?: number): void;

Fades out over duration milliseconds. Zero/invalid durations hide immediately.

render(painter: CPainter): void;

Fades this window and all its contents without changing other windows.

finish(mainWindow: CWidget, duration?: number): void;

Shows the main window, then fades out. Pass zero for immediate dismissal.

destroy(): void;
protected paintEvent(painter: CPainter): void;
protected drawContents(painter: CPainter): void;

Subclasses can customize the text layer while retaining the background.

protected mousePressEvent(event: CMouseEvent): void;

Like a conventional splash screen, a left click dismisses the startup image.