Canvas Toolkit
← Class index

CMainWindow

Widgets · extends CWidget

Implements the main window widget.

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

Declared members

static readonly WorkspaceStorageKey: string;
constructor(parent?: CWidget | null);

Creates a new instance.

menuBar(): CMenuBar | null;

Provides menu bar behavior.

setMenuBar(menuBar: CMenuBar | null): void;

Sets the menu bar.

addToolBar(toolBar: CToolBar): void;

Adds tool bar.

addToolBar(area: CToolBarArea, toolBar: CToolBar): void;

Adds tool bar.

removeToolBar(toolBar: CToolBar): void;

Removes tool bar.

toolBars(area?: CToolBarArea): readonly CToolBar[];

Provides tool bars behavior.

toolBarArea(toolBar: CToolBar): CToolBarArea | null;

Provides tool bar area behavior.

moveToolBar(toolBar: CToolBar, area: CToolBarArea, index?: number): void;

Provides move tool bar behavior.

beginToolBarDrag(toolBar: CToolBar): void;

Provides begin tool bar drag behavior.

dockToolBar(toolBar: CToolBar, area: CToolBarArea, index?: number): void;

Provides dock tool bar behavior.

toolBarAreaAt(canvasX: number, canvasY: number): CToolBarArea | null;

Provides tool bar area at behavior.

updateToolBarPreview(toolBar: CToolBar, canvasX: number, canvasY: number): void;

Provides update tool bar preview behavior.

clearToolBarPreview(): void;

Clears tool bar preview.

statusBar(): CStatusBar | null;

Provides status bar behavior.

setStatusBar(statusBar: CStatusBar | null): void;

Sets the status bar.

centralWidget(): CWidget | null;

Provides central widget behavior.

setCentralWidget(widget: CWidget | null): void;

Sets the central widget.

addDockWidget(area: CDockWidgetArea, dockWidget: CDockWidget): void;

Adds dock widget.

removeDockWidget(dockWidget: CDockWidget): void;

Removes dock widget.

dockWidgetArea(dockWidget: CDockWidget): CDockWidgetArea | null;

Provides dock widget area behavior.

setDockWidgetFloating(dockWidget: CDockWidget, floating: boolean): void;

Sets the dock widget floating.

dockWidget(dockWidget: CDockWidget, area: CDockWidgetArea): void;

Provides dock widget behavior.

dockAreaAt(dockWidget: CDockWidget, canvasX: number, canvasY: number): CDockWidgetArea | null;

Provides dock area at behavior.

updateDockPreview(dockWidget: CDockWidget, canvasX: number, canvasY: number): void;

Provides update dock preview behavior.

clearDockPreview(): void;

Clears dock preview.

saveState(): string;

Provides save state behavior.

restoreState(serializedState: string): boolean;

Provides restore state behavior.

resetWorkspace(): void;

Provides reset workspace behavior.

render(painter: CPainter): void;

Renders the widget.

setGeometry(x: number, y: number, width: number, height: number): void;

Sets the geometry.

resize(width: number, height: number): void;

Provides resize behavior.

sizeHint(): CSize;

Returns the preferred size of the widget.

protected childVisibilityChanged(_child: CWidget): void;

Handles child visibility changed behavior.

saveWorkspace(): void;

Provides save workspace behavior.

restoreWorkspace(): boolean;

Provides restore workspace behavior.

destroy(): void;

Releases resources owned by the widget.