Canvas Toolkit
← Class index

CDockArea

Widgets · extends CWidget

Implements the dock area widget.

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

Declared members

static readonly Spacing = 2;
constructor(parent?: CWidget | null);

Creates a new instance.

centralWidget(): CWidget | null;

Provides central widget behavior.

setCentralWidget(widget: CWidget | null): void;

Sets the central widget.

addDockWidget(position: CDockWidgetArea, widget: CDockWidget): void;

Adds dock widget.

removeDockWidget(widget: CDockWidget): void;

Removes dock widget.

dockWidgets(position: CDockWidgetArea): readonly CDockWidget[];

Provides dock widgets behavior.

dockWidgetArea(widget: CDockWidget): CDockWidgetArea | null;

Provides dock widget area behavior.

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

Provides dock area at behavior.

setDockPreview(widget: CDockWidget, area: CDockWidgetArea | null): void;

Sets the dock preview.

clearDockPreview(): void;

Clears dock preview.

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.