Canvas Toolkit
← Class index

CDockWidget

Widgets · extends CWidget

Implements the dock widget widget.

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

Declared members

static readonly TitleBarHeight = 24;
static readonly CloseButtonWidth = 24;
static readonly DefaultWidth = 100;
static readonly DefaultHeight = 80;
readonly topLevelChanged: CSignal<[boolean]>;

Signal emitted when top level changes.

readonly dockLocationChanged: CSignal<[CDockWidgetArea]>;

Signal emitted when dock location changes.

constructor(title?: string, parent?: CWidget | null);

Creates a new instance.

title(): string;

Provides title behavior.

workspaceId(): string;

Provides workspace id behavior.

setWorkspaceId(id: string): void;

Sets the workspace id.

setTitle(title: string): void;

Sets the title.

widget(): CWidget | null;

Provides widget behavior.

setWidget(widget: CWidget | null): void;

Sets the widget.

isClosable(): boolean;

Returns whether the closable condition is active.

setClosable(closable: boolean): void;

Sets the closable.

isFloating(): boolean;

Returns whether the floating condition is active.

isMovable(): boolean;

Returns whether the movable condition is active.

setMovable(movable: boolean): void;

Sets the movable.

lastDockArea(): CDockWidgetArea;

Provides last dock area behavior.

setFloatingState(floating: boolean): void;

Sets the floating state.

setDockWidgetArea(area: CDockWidgetArea): void;

Sets the dock widget area.

dockWidth(): number;

Provides dock width behavior.

setDockWidth(width: number): void;

Sets the dock width.

dockHeight(): number;

Provides dock height behavior.

setDockHeight(height: number): void;

Sets the dock height.

mainWindow(): CMainWindow | null;

Provides main window behavior.

setMainWindow(mainWindow: CMainWindow | null): void;

Sets the main window.

sizeHint(): CSize;

Returns the preferred size of the widget.

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

Sets the geometry.

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

Provides resize behavior.

protected paintEvent(painter: CPainter): void;

Handles the paint event.

protected mousePressEvent(event: CMouseEvent): void;

Handles the mouse press event.

protected mouseMoveEvent(event: CMouseEvent): void;

Handles the mouse move event.

protected mouseReleaseEvent(event: CMouseEvent): void;

Handles the mouse release event.

protected mouseLeaveEvent(event: CMouseEvent): void;

Handles the mouse leave event.