Canvas Toolkit
← Class index

CSplitter

Widgets · extends CWidget

Implements the splitter widget.

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

Declared members

readonly splitterMoved: CSignal<[number, number]>;

Public splitter moved member.

constructor(orientation?: COrientation, parent?: CWidget | null);

Creates a new instance.

orientation(): COrientation;

Provides orientation behavior.

setOrientation(orientation: COrientation): void;

Sets the orientation.

addWidget(widget: CWidget): void;

Adds widget.

insertWidget(index: number, widget: CWidget): void;

Inserts widget.

replaceWidget(index: number, widget: CWidget): CWidget | null;

Provides replace widget behavior.

count(): number;

Provides count behavior.

widget(index: number): CWidget | null;

Provides widget behavior.

indexOf(widget: CWidget): number;

Provides index of behavior.

handle(index: number): CSplitterHandle | null;

Provides handle behavior.

handleWidth(): number;

Provides handle width behavior.

childrenCollapsible(): boolean;

Provides children collapsible behavior.

setChildrenCollapsible(collapsible: boolean): void;

Sets the children collapsible.

isCollapsible(index: number): boolean;

Returns whether the collapsible condition is active.

setCollapsible(index: number, collapsible: boolean): void;

Sets the collapsible.

sizes(): number[];

Provides sizes behavior.

setSizes(sizes: number[]): void;

Sets the sizes.

setStretchFactor(index: number, stretch: number): void;

Sets the stretch factor.

moveSplitter(pos: number, index: number): void;

Provides move splitter behavior.

closestLegalPosition(pos: number, index: number): number;

Provides closest legal position behavior.

sizeHint(): CSize;

Returns the preferred size of the widget.

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

Sets the geometry.

protected childVisibilityChanged(child: CWidget): void;

Handles child visibility changed behavior.