nodeguy/website/docs/api/generated/classes/qtreewidget.md

id	title	sidebar_label
qtreewidget	QTreeWidget	QTreeWidget

Creates a tree view that uses a predefined tree model.

This class is a JS wrapper around Qt's QTreeWidget 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`);
const item4 = new QTreeWidgetItem();
item4.setText(0, `item-4`);
const item5 = new QTreeWidgetItem();
item5.setText(0, `item-5`);
const item6 = new QTreeWidgetItem();
item6.setText(0, `item-6`);

tree.addTopLevelItem(item1);
tree.insertTopLevelItems(0, [item2, item3]);
tree.addTopLevelItems([item4, item5]);
tree.insertTopLevelItem(2, item6);

// 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

↳ QAbstractScrollArea‹QTreeWidgetSignals›

↳ QTreeWidget

Index

Constructors

• constructor

Properties

• _rawInlineStyle
• actions
• itemWidgets
• layout
• native
• nodeChildren
• nodeParent
• topLevelItems
• type
• viewportWidget

Methods

• activateWindow
• addAction
• addEventListener
• addTopLevelItem
• addTopLevelItems
• adjustSize
• close
• currentItem
• findItems
• font
• frameRect
• frameShadow
• frameShape
• frameStyle
• frameWidth
• geometry
• getFlexNode
• hasMouseTracking
• hide
• inherits
• insertTopLevelItem
• insertTopLevelItems
• isEnabled
• isVisible
• lineWidth
• lower
• midLineWidth
• move
• objectName
• pos
• property
• raise
• removeEventListener
• repaint
• repolish
• resize
• selectedItems
• setAttribute
• setColumnCount
• setContextMenuPolicy
• setCursor
• setEnabled
• setFixedSize
• setFlexNodeSizeControlled
• setFont
• setFrameRect
• setFrameShadow
• setFrameShape
• setFrameStyle
• setGeometry
• setHeaderHidden
• setHeaderLabel
• setHeaderLabels
• setHorizontalScrollBarPolicy
• setInlineStyle
• setItemWidget
• setLayout
• setLineWidth
• setMaximumSize
• setMidLineWidth
• setMinimumSize
• setMouseTracking
• setNodeParent
• setObjectName
• setProperty
• setSortingEnabled
• setStyleSheet
• setVerticalScrollBarPolicy
• setViewport
• setWindowFlag
• setWindowIcon
• setWindowOpacity
• setWindowState
• setWindowTitle
• show
• showFullScreen
• showMaximized
• showMinimized
• showNormal
• size
• styleSheet
• testAttribute
• update
• updateGeometry
• viewport
• windowOpacity
• windowState
• windowTitle

Constructors

constructor

+ new QTreeWidget(): QTreeWidget

Overrides NodeWidget.constructor

Returns: QTreeWidget

+ new QTreeWidget(parent: NodeWidget‹any›): QTreeWidget

Overrides NodeWidget.constructor

Parameters:

Name	Type
parent	NodeWidget‹any›

Returns: QTreeWidget

Properties

_rawInlineStyle

• _rawInlineStyle: string = ""

Inherited from QMenu._rawInlineStyle

---

actions

• actions: Set‹QAction›

Inherited from QMenu.actions

---

itemWidgets

• itemWidgets: Map‹QTreeWidgetItem, QWidget›

---

Optional layout

• layout? : NodeLayout‹QTreeWidgetSignals›

Inherited from QMenu.layout

---

native

• native: NativeElement

Overrides Component.native

---

nodeChildren

• nodeChildren: Set‹Component›

Inherited from Component.nodeChildren

---

Optional nodeParent

• nodeParent? : Component

Inherited from Component.nodeParent

---

topLevelItems

• topLevelItems: Set‹QTreeWidgetItem›

---

type

• type: string = "widget"

Inherited from QMenu.type

---

Optional viewportWidget

• viewportWidget? : NodeWidget‹any›

Inherited from QAbstractScrollArea.viewportWidget

Methods

activateWindow

▸ activateWindow(): void

Inherited from QMenu.activateWindow

Returns: void

---

addAction

▸ addAction(action: QAction | string): QAction

Inherited from QMenu.addAction

Parameters:

Name	Type
action	QAction | string

Returns: QAction

---

addEventListener

▸ addEventListener<SignalType>(signalType: SignalType, callback: QTreeWidgetSignals[SignalType]): void

Inherited from EventWidget.addEventListener

Type parameters:

▪ SignalType: keyof QTreeWidgetSignals

Parameters:

Name	Type	Description
signalType	SignalType	SignalType is a signal from the widgets signals interface.
callback	QTreeWidgetSignals[SignalType]	Corresponding callback for the signal as mentioned in the widget's signal interface

Returns: void

void

For example in the case of QPushButton:

const button = new QPushButton();
button.addEventListener('clicked',(checked)=>console.log("clicked"));
// here clicked is a value from QPushButtonSignals interface

▸ addEventListener(eventType: WidgetEventTypes, callback: function): void

Inherited from EventWidget.addEventListener

Parameters:

▪ eventType: WidgetEventTypes

▪ callback: function

For example in the case of QPushButton:

const button = new QPushButton();
button.addEventListener(WidgetEventTypes.HoverEnter,()=>console.log("hovered"));

▸ (event?: NativeRawPointer‹"QEvent"›): void

Parameters:

Name	Type
event?	NativeRawPointer‹"QEvent"›

Returns: void

---

addTopLevelItem

▸ addTopLevelItem(item: QTreeWidgetItem): void

Parameters:

Name	Type
item	QTreeWidgetItem

Returns: void

---

addTopLevelItems

▸ addTopLevelItems(items: QTreeWidgetItem[]): void

Parameters:

Name	Type
items	QTreeWidgetItem[]

Returns: void

---

adjustSize

▸ adjustSize(): void

Inherited from QMenu.adjustSize

Returns: void

---

close

▸ close(): boolean

Inherited from QMenu.close

Returns: boolean

---

currentItem

▸ currentItem(): QTreeWidgetItem

Returns the current item in the tree widget.

Returns: QTreeWidgetItem

---

findItems

▸ findItems(text: string, flags: MatchFlag, column: number): QTreeWidgetItem[]

Parameters:

Name	Type
text	string
flags	MatchFlag
column	number

Returns: QTreeWidgetItem[]

---

font

▸ font(): QFont

Inherited from QMenu.font

Returns: QFont

---

frameRect

▸ frameRect(): QRect

Inherited from NodeFrame.frameRect

Returns: QRect

---

frameShadow

▸ frameShadow(): Shadow

Inherited from NodeFrame.frameShadow

Returns: Shadow

---

frameShape

▸ frameShape(): Shape

Inherited from NodeFrame.frameShape

Returns: Shape

---

frameStyle

▸ frameStyle(): number

Inherited from NodeFrame.frameStyle

Returns: number

---

frameWidth

▸ frameWidth(): number

Inherited from NodeFrame.frameWidth

Returns: number

---

geometry

▸ geometry(): QRect

Inherited from QMenu.geometry

Returns: QRect

---

getFlexNode

▸ getFlexNode(): FlexNode

Inherited from YogaWidget.getFlexNode

Returns: FlexNode

---

hasMouseTracking

▸ hasMouseTracking(): boolean

Inherited from QMenu.hasMouseTracking

Returns: boolean

---

hide

▸ hide(): void

Inherited from QMenu.hide

Returns: void

---

inherits

▸ inherits(className: string): boolean

Inherited from NodeObject.inherits

Parameters:

Name	Type
className	string

Returns: boolean

---

insertTopLevelItem

▸ insertTopLevelItem(index: number, item: QTreeWidgetItem): void

Parameters:

Name	Type
index	number
item	QTreeWidgetItem

Returns: void

---

insertTopLevelItems

▸ insertTopLevelItems(index: number, items: QTreeWidgetItem[]): void

Parameters:

Name	Type
index	number
items	QTreeWidgetItem[]

Returns: void

---

isEnabled

▸ isEnabled(): boolean

Inherited from QMenu.isEnabled

Returns: boolean

---

isVisible

▸ isVisible(): boolean

Inherited from QMenu.isVisible

Returns: boolean

---

lineWidth

▸ lineWidth(): number

Inherited from NodeFrame.lineWidth

Returns: number

---

lower

▸ lower(): void

Inherited from QMenu.lower

Returns: void

---

midLineWidth

▸ midLineWidth(): number

Inherited from NodeFrame.midLineWidth

Returns: number

---

move

▸ move(x: number, y: number): void

Inherited from QMenu.move

Parameters:

Name	Type
x	number
y	number

Returns: void

---

objectName

▸ objectName(): string

Inherited from NodeObject.objectName

Returns: string

---

pos

▸ pos(): object

Inherited from QMenu.pos

Returns: object

• x: number

• y: number

---

property

▸ property(name: string): QVariant

Inherited from NodeObject.property

Parameters:

Name	Type
name	string

Returns: QVariant

---

raise

▸ raise(): void

Inherited from QMenu.raise

Returns: void

---

removeEventListener

▸ removeEventListener<SignalType>(signalType: SignalType, callback: QTreeWidgetSignals[SignalType]): void

Inherited from EventWidget.removeEventListener

Type parameters:

▪ SignalType: keyof QTreeWidgetSignals

Parameters:

Name	Type
signalType	SignalType
callback	QTreeWidgetSignals[SignalType]

Returns: void

▸ removeEventListener(eventType: WidgetEventTypes, callback: function): void

Inherited from EventWidget.removeEventListener

Parameters:

▪ eventType: WidgetEventTypes

▪ callback: function

▸ (event?: NativeRawPointer‹"QEvent"›): void

Parameters:

Name	Type
event?	NativeRawPointer‹"QEvent"›

Returns: void

---

repaint

▸ repaint(): void

Inherited from QMenu.repaint

Returns: void

---

repolish

▸ repolish(): void

Inherited from QMenu.repolish

Returns: void

---

resize

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

Inherited from QMenu.resize

Parameters:

Name	Type
width	number
height	number

Returns: void

---

selectedItems

▸ selectedItems(): QTreeWidgetItem[]

Returns: QTreeWidgetItem[]

---

setAttribute

▸ setAttribute(attribute: WidgetAttribute, switchOn: boolean): void

Inherited from QMenu.setAttribute

Parameters:

Name	Type
attribute	WidgetAttribute
switchOn	boolean

Returns: void

---

setColumnCount

▸ setColumnCount(columnCount: number): void

Sets the column count of this QTreeWidget.

Parameters:

Name	Type	Description
columnCount	number	The number of columns.

Returns: void

---

setContextMenuPolicy

▸ setContextMenuPolicy(contextMenuPolicy: ContextMenuPolicy): void

Inherited from QMenu.setContextMenuPolicy

Parameters:

Name	Type
contextMenuPolicy	ContextMenuPolicy

Returns: void

---

setCursor

▸ setCursor(cursor: CursorShape | QCursor): void

Inherited from QMenu.setCursor

Parameters:

Name	Type
cursor	CursorShape | QCursor

Returns: void

---

setEnabled

▸ setEnabled(enabled: boolean): void

Inherited from QMenu.setEnabled

Parameters:

Name	Type
enabled	boolean

Returns: void

---

setFixedSize

▸ setFixedSize(width: number, height: number): void

Inherited from QMenu.setFixedSize

Parameters:

Name	Type
width	number
height	number

Returns: void

---

setFlexNodeSizeControlled

▸ setFlexNodeSizeControlled(isSizeControlled: boolean): void

Inherited from YogaWidget.setFlexNodeSizeControlled

sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged).

Parameters:

Name	Type	Description
isSizeControlled	boolean

Returns: void

---

setFont

▸ setFont(font: QFont): void

Inherited from QMenu.setFont

Parameters:

Name	Type
font	QFont

Returns: void

---

setFrameRect

▸ setFrameRect(r: QRect): void

Inherited from NodeFrame.setFrameRect

Parameters:

Name	Type
r	QRect

Returns: void

---

setFrameShadow

▸ setFrameShadow(type: Shadow): void

Inherited from NodeFrame.setFrameShadow

Parameters:

Name	Type
type	Shadow

Returns: void

---

setFrameShape

▸ setFrameShape(type: Shape): void

Inherited from NodeFrame.setFrameShape

Parameters:

Name	Type
type	Shape

Returns: void

---

setFrameStyle

▸ setFrameStyle(style: number): void

Inherited from NodeFrame.setFrameStyle

Parameters:

Name	Type
style	number

Returns: void

---

setGeometry

▸ setGeometry(x: number, y: number, w: number, h: number): void

Inherited from QMenu.setGeometry

Parameters:

Name	Type
x	number
y	number
w	number
h	number

Returns: void

---

setHeaderHidden

▸ setHeaderHidden(hide: boolean): void

Parameters:

Name	Type
hide	boolean

Returns: void

---

setHeaderLabel

▸ setHeaderLabel(label: string): void

Sets the header label.

Parameters:

Name	Type	Description
label	string	The header label.

Returns: void

---

setHeaderLabels

▸ setHeaderLabels(labels: string[]): void

Sets the header labels of the existing columns.

Parameters:

Name	Type	Description
labels	string[]	The header labels for each column.

Returns: void

---

setHorizontalScrollBarPolicy

▸ setHorizontalScrollBarPolicy(policy: ScrollBarPolicy): void

Inherited from QAbstractScrollArea.setHorizontalScrollBarPolicy

Parameters:

Name	Type
policy	ScrollBarPolicy

Returns: void

---

setInlineStyle

▸ setInlineStyle(style: string): void

Inherited from QMenu.setInlineStyle

Parameters:

Name	Type
style	string

Returns: void

---

setItemWidget

▸ setItemWidget(item: QTreeWidgetItem, column: number, widget: QWidget): void

Sets the given widget to be displayed in the cell specified by the given item and column.

Parameters:

Name	Type	Description
item	QTreeWidgetItem	The targeted item.
column	number	The column in which to show the edit widget.
widget	QWidget	The edit widget.

Returns: void

---

setLayout

▸ setLayout(parentLayout: NodeLayout‹QTreeWidgetSignals›): void

Inherited from QMenu.setLayout

Parameters:

Name	Type
parentLayout	NodeLayout‹QTreeWidgetSignals›

Returns: void

---

setLineWidth

▸ setLineWidth(width: number): void

Inherited from NodeFrame.setLineWidth

Parameters:

Name	Type
width	number

Returns: void

---

setMaximumSize

▸ setMaximumSize(maxw: number, maxh: number): void

Inherited from QMenu.setMaximumSize

Parameters:

Name	Type
maxw	number
maxh	number

Returns: void

---

setMidLineWidth

▸ setMidLineWidth(width: number): void

Inherited from NodeFrame.setMidLineWidth

Parameters:

Name	Type
width	number

Returns: void

---

setMinimumSize

▸ setMinimumSize(minw: number, minh: number): void

Inherited from QMenu.setMinimumSize

Parameters:

Name	Type
minw	number
minh	number

Returns: void

---

setMouseTracking

▸ setMouseTracking(isMouseTracked: boolean): void

Inherited from QMenu.setMouseTracking

Parameters:

Name	Type
isMouseTracked	boolean

Returns: void

---

setNodeParent

▸ setNodeParent(parent?: Component): void

Inherited from Component.setNodeParent

Parameters:

Name	Type
parent?	Component

Returns: void

---

setObjectName

▸ setObjectName(objectName: string): void

Inherited from QMenu.setObjectName

Overrides NodeObject.setObjectName

Parameters:

Name	Type
objectName	string

Returns: void

---

setProperty

▸ setProperty(name: string, value: QVariantType): boolean

Inherited from NodeObject.setProperty

Parameters:

Name	Type
name	string
value	QVariantType

Returns: boolean

---

setSortingEnabled

▸ setSortingEnabled(enable: boolean): void

Sets if columns can be sorted by clicking on its header

Parameters:

Name	Type	Description
enable	boolean	Sorting enabled or disabled

Returns: void

---

setStyleSheet

▸ setStyleSheet(styleSheet: string): void

Inherited from QMenu.setStyleSheet

Parameters:

Name	Type
styleSheet	string

Returns: void

---

setVerticalScrollBarPolicy

▸ setVerticalScrollBarPolicy(policy: ScrollBarPolicy): void

Inherited from QAbstractScrollArea.setVerticalScrollBarPolicy

Parameters:

Name	Type
policy	ScrollBarPolicy

Returns: void

---

setViewport

▸ setViewport(widget: NodeWidget‹any›): void

Inherited from QAbstractScrollArea.setViewport

Parameters:

Name	Type
widget	NodeWidget‹any›

Returns: void

---

setWindowFlag

▸ setWindowFlag(windowType: WindowType, switchOn: boolean): void

Inherited from QMenu.setWindowFlag

Parameters:

Name	Type
windowType	WindowType
switchOn	boolean

Returns: void

---

setWindowIcon

▸ setWindowIcon(icon: QIcon): void

Inherited from QMenu.setWindowIcon

Parameters:

Name	Type
icon	QIcon

Returns: void

---

setWindowOpacity

▸ setWindowOpacity(opacity: number): void

Inherited from QMenu.setWindowOpacity

Parameters:

Name	Type
opacity	number

Returns: void

---

setWindowState

▸ setWindowState(state: WindowState): void

Inherited from QMenu.setWindowState

Parameters:

Name	Type
state	WindowState

Returns: void

---

setWindowTitle

▸ setWindowTitle(title: string): void

Inherited from QMenu.setWindowTitle

Parameters:

Name	Type
title	string

Returns: void

---

show

▸ show(): void

Inherited from QMenu.show

Returns: void

---

showFullScreen

▸ showFullScreen(): void

Inherited from QMenu.showFullScreen

Returns: void

---

showMaximized

▸ showMaximized(): void

Inherited from QMenu.showMaximized

Returns: void

---

showMinimized

▸ showMinimized(): void

Inherited from QMenu.showMinimized

Returns: void

---

showNormal

▸ showNormal(): void

Inherited from QMenu.showNormal

Returns: void

---

size

▸ size(): QSize

Inherited from QMenu.size

Returns: QSize

---

styleSheet

▸ styleSheet(): string

Inherited from QMenu.styleSheet

Returns: string

---

testAttribute

▸ testAttribute(attribute: WidgetAttribute): boolean

Inherited from QMenu.testAttribute

Parameters:

Name	Type
attribute	WidgetAttribute

Returns: boolean

---

update

▸ update(): void

Inherited from QMenu.update

Returns: void

---

updateGeometry

▸ updateGeometry(): void

Inherited from QMenu.updateGeometry

Returns: void

---

viewport

▸ viewport(): QWidget

Inherited from QAbstractScrollArea.viewport

Returns: QWidget

---

windowOpacity

▸ windowOpacity(): number

Inherited from QMenu.windowOpacity

Returns: number

---

windowState

▸ windowState(): number

Inherited from QMenu.windowState

Returns: number

---

windowTitle

▸ windowTitle(): string

Inherited from QMenu.windowTitle

Returns: string