Canvas Toolkit
← Class index

CTreeWidget

Widgets · extends CTreeView

Implements the tree widget widget.

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

Declared members

readonly currentItemChanged: CSignal<[CTreeWidgetItem | null, CTreeWidgetItem | null]>;

Signal emitted when current item changes.

constructor(parent?: CWidget | null);

Creates a new instance.

addTopLevelItem(item: CTreeWidgetItem): void;

Adds top level item.

insertTopLevelItem(index: number, item: CTreeWidgetItem): void;

Inserts top level item.

takeTopLevelItem(index: number): CTreeWidgetItem | null;

Removes and returns top level item.

topLevelItem(index: number): CTreeWidgetItem | null;

Provides top level item behavior.

topLevelItemCount(): number;

Provides top level item count behavior.

indexOfTopLevelItem(item: CTreeWidgetItem): number;

Provides index of top level item behavior.

setHeaderLabels(labels: string[]): void;

Sets the header labels.

currentItem(): CTreeWidgetItem | null;

Returns the current item.

setCurrentItem(item: CTreeWidgetItem | null, column?: number): void;

Sets the current item.

selectedItems(): CTreeWidgetItem[];

Returns the selected items.

itemFromIndex(index: CModelIndex): CTreeWidgetItem | null;

Provides item from index behavior.

indexFromItem(item: CTreeWidgetItem, column?: number): CModelIndex;

Provides index from item behavior.