QTreeWidgetItem

Creates an item for QTreeWidget.

This class is a JS wrapper around Qt's QTreeWidgetItem class

Example

const { QMainWindow, QTreeWidgetItem, QTreeWidget } = require("@nodegui/nodegui");

const win = new QMainWindow();
const tree = new QTreeWidget();

const item1 = new QTreeWidgetItem();
item1.setText(0, `item-1`);
const item2 = new QTreeWidgetItem();
item2.setText(0, `item-2`);
const item3 = new QTreeWidgetItem();
item3.setText(0, `item-3`);

tree.addTopLevelItem(item1);
tree.addTopLevelItem(item2);
tree.addTopLevelItem(item3);

// Add children to item1
const c1item1 = new QTreeWidgetItem(item1);
c1item1.setText(0, `c1item1`);
const c1item2 = new QTreeWidgetItem(item1);
c1item2.setText(0, `c1item1`);

win.setCentralWidget(tree);
win.show();
(global as any).win = win;

Hierarchy

• Component

  ↳ QTreeWidgetItem

Index

Constructors

• constructor

Properties

• items
• native

Methods

• addChild
• child
• childCount
• data
• flags
• icon
• isHidden
• parent
• setCheckState
• setData
• setExpanded
• setFlags
• setHidden
• setIcon
• setSelected
• setText
• text

Constructors

constructor

+ new QTreeWidgetItem(): QTreeWidgetItem

Overrides Component.constructor

Returns: QTreeWidgetItem

+ new QTreeWidgetItem(parent: QTreeWidgetItem, strings?: string[]): QTreeWidgetItem

Overrides Component.constructor

Parameters:

Name	Type
parent	QTreeWidgetItem
strings?	string[]

Returns: QTreeWidgetItem

+ new QTreeWidgetItem(parent: QTreeWidget, strings?: string[]): QTreeWidgetItem

Overrides Component.constructor

Parameters:

Name	Type
parent	QTreeWidget
strings?	string[]

Returns: QTreeWidgetItem

+ new QTreeWidgetItem(native: NativeElement): QTreeWidgetItem

Overrides Component.constructor

Parameters:

Name	Type
native	NativeElement

Returns: QTreeWidgetItem

+ new QTreeWidgetItem(strings: string[]): QTreeWidgetItem

Overrides Component.constructor

Parameters:

Name	Type
strings	string[]

Returns: QTreeWidgetItem

Properties

items

• items: Set‹NativeElement | Component›

---

native

• native: NativeElement | null

Inherited from Component.native

Methods

addChild

▸ addChild(childItem: QTreeWidgetItem): void

Adds the specified child to this QTreeWidgetItem.

Parameters:

Name	Type	Description
childItem	QTreeWidgetItem	The child to add.

Returns: void

---

child

▸ child(index: number): QTreeWidgetItem | undefined

Parameters:

Name	Type
index	number

Returns: QTreeWidgetItem | undefined

---

childCount

▸ childCount(): number

Returns: number

---

data

▸ data(column: number, role: ItemDataRole): QVariant

Returns the value for the item's column and role.

Parameters:

Name	Type	Description
column	number	The column.
role	ItemDataRole	The role.

Returns: QVariant

---

flags

▸ flags(): ItemFlag

Returns the flags used to describe the item. These determine whether the item can be checked, edited, and selected.

Returns: ItemFlag

---

icon

▸ icon(column: number): QIcon

Returns the icon object for the item.

Parameters:

Name	Type
column	number

Returns: QIcon

---

isHidden

▸ isHidden(): boolean

Returns: boolean

---

parent

▸ parent(): QTreeWidgetItem | undefined

Returns: QTreeWidgetItem | undefined

---

setCheckState

▸ setCheckState(column: number, state: CheckState): void

Sets the item in the given column check state to be state.

Parameters:

Name	Type	Description
column	number	The column.
state	CheckState	The check state.

Returns: void

---

setData

▸ setData(column: number, role: ItemDataRole, value: QVariantType): void

Sets the value for the item's column and role to the given value. The role describes the type of data specified by value, and is defined by the ItemDataRole enum.

Parameters:

Name	Type	Description
column	number	The column.
role	ItemDataRole	The role.
value	QVariantType	The value.

Returns: void

---

setExpanded

▸ setExpanded(expanded: boolean): void

Parameters:

Name	Type
expanded	boolean

Returns: void

---

setFlags

▸ setFlags(flags: ItemFlag): void

Sets the flags for the item to the given flags. These determine whether the item can be selected or modified. This is often used to disable an item.

Parameters:

Name	Type	Description
flags	ItemFlag	The flags.

Returns: void

---

setHidden

▸ setHidden(hide: boolean): void

Parameters:

Name	Type
hide	boolean

Returns: void

---

setIcon

▸ setIcon(column: number, icon: QIcon): void

Sets the icon for the item.

Parameters:

Name	Type	Description
column	number	-
icon	QIcon	The icon object

Returns: void

---

setSelected

▸ setSelected(selected: boolean): void

Parameters:

Name	Type
selected	boolean

Returns: void

---

setText

▸ setText(column: number, text: string): void

Parameters:

Name	Type
column	number
text	string

Returns: void

---

text

▸ text(column: number): string

Parameters:

Name	Type
column	number

Returns: string