- Qt 6.8
- Qt Widgets
- C++ Classes
- QTreeWidgetItem
- Qt 6.8.1 Reference Documentation

# QTreeWidgetItem Class

The QTreeWidgetItem class provides an item for use with the QTreeWidget convenience class. More...

Header: | `#include <QTreeWidgetItem>`
CMake: | `find_package(Qt6 REQUIRED COMPONENTS Widgets)` `target_link_libraries(mytarget PRIVATE Qt6::Widgets)`
qmake: | `QT += widgets`

- List of all members, including inherited members
- Deprecated members

## Public Types

enum | ChildIndicatorPolicy { ShowIndicator, DontShowIndicator, DontShowIndicatorWhenChildless }
enum | ItemType { Type, UserType }

## Public Functions

| QTreeWidgetItem(int type = Type)
| QTreeWidgetItem(QTreeWidget *parent, int type = Type)
| QTreeWidgetItem(QTreeWidgetItem *parent, int type = Type)
| QTreeWidgetItem(const QStringList &strings, int type = Type)
| QTreeWidgetItem(QTreeWidget *parent, QTreeWidgetItem *preceding, int type = Type)
| QTreeWidgetItem(QTreeWidget *parent, const QStringList &strings, int type = Type)
| QTreeWidgetItem(QTreeWidgetItem *parent, QTreeWidgetItem *preceding, int type = Type)
| QTreeWidgetItem(QTreeWidgetItem *parent, const QStringList &strings, int type = Type)
| QTreeWidgetItem(const QTreeWidgetItem &other)
virtual | ~QTreeWidgetItem()
void | addChild(QTreeWidgetItem *child)
void | addChildren(const QList<QTreeWidgetItem *> &children)
QBrush | background(int column) const
Qt::CheckState | checkState(int column) const
QTreeWidgetItem * | child(int index) const
int | childCount() const
QTreeWidgetItem::ChildIndicatorPolicy | childIndicatorPolicy() const
virtual QTreeWidgetItem * | clone() const
int | columnCount() const
virtual QVariant | data(int column, int role) const
Qt::ItemFlags | flags() const
QFont | font(int column) const
QBrush | foreground(int column) const
QIcon | icon(int column) const
int | indexOfChild(QTreeWidgetItem *child) const
void | insertChild(int index, QTreeWidgetItem *child)
void | insertChildren(int index, const QList<QTreeWidgetItem *> &children)
bool | isDisabled() const
bool | isExpanded() const
bool | isFirstColumnSpanned() const
bool | isHidden() const
bool | isSelected() const
QTreeWidgetItem * | parent() const
virtual void | read(QDataStream &in)
void | removeChild(QTreeWidgetItem *child)
void | setBackground(int column, const QBrush &brush)
void | setCheckState(int column, Qt::CheckState state)
void | setChildIndicatorPolicy(QTreeWidgetItem::ChildIndicatorPolicy policy)
virtual void | setData(int column, int role, const QVariant &value)
void | setDisabled(bool disabled)
void | setExpanded(bool expand)
void | setFirstColumnSpanned(bool span)
void | setFlags(Qt::ItemFlags flags)
void | setFont(int column, const QFont &font)
void | setForeground(int column, const QBrush &brush)
void | setHidden(bool hide)
void | setIcon(int column, const QIcon &icon)
void | setSelected(bool select)
void | setSizeHint(int column, const QSize &size)
void | setStatusTip(int column, const QString &statusTip)
void | setText(int column, const QString &text)
`(since 6.4)` void | setTextAlignment(int column, Qt::Alignment alignment)
void | setToolTip(int column, const QString &toolTip)
void | setWhatsThis(int column, const QString &whatsThis)
QSize | sizeHint(int column) const
void | sortChildren(int column, Qt::SortOrder order)
QString | statusTip(int column) const
QTreeWidgetItem * | takeChild(int index)
QList<QTreeWidgetItem *> | takeChildren()
QString | text(int column) const
int | textAlignment(int column) const
QString | toolTip(int column) const
QTreeWidget * | treeWidget() const
int | type() const
QString | whatsThis(int column) const
virtual void | write(QDataStream &out) const
virtual bool | operator<(const QTreeWidgetItem &other) const
QTreeWidgetItem & | operator=(const QTreeWidgetItem &other)

## Protected Functions

void | emitDataChanged()

## Related Non-Members

QDataStream & | operator<<(QDataStream &out, const QTreeWidgetItem &item)
QDataStream & | operator>>(QDataStream &in, QTreeWidgetItem &item)

## Detailed Description

Tree widget items are used to hold rows of information for tree widgets. Rows usually contain several columns of data, each of which can contain a text label and an icon.

The QTreeWidgetItem class is a convenience class that replaces the QListViewItem class in Qt 3. It provides an item for use with the QTreeWidget class.

Items are usually constructed with a parent that is either a QTreeWidget (for top-level items) or a QTreeWidgetItem (for items on lower levels of the tree). For example, the following code constructs a top-level item to represent cities of the world, and adds a entry for Oslo as a child item:

         QTreeWidgetItem *cities = new QTreeWidgetItem(treeWidget);
         cities->setText(0, tr("Cities"));
         QTreeWidgetItem *osloItem = new QTreeWidgetItem(cities);
         osloItem->setText(0, tr("Oslo"));
         osloItem->setText(1, tr("Yes"));

Items can be added in a particular order by specifying the item they follow when they are constructed:

         QTreeWidgetItem *planets = new QTreeWidgetItem(treeWidget, cities);
         planets->setText(0, tr("Planets"));

Each column in an item can have its own background brush which is set with the setBackground() function. The current background brush can be found with background(). The text label for each column can be rendered with its own font and brush. These are specified with the setFont() and setForeground() functions, and read with font() and foreground().

The main difference between top-level items and those in lower levels of the tree is that a top-level item has no parent(). This information can be used to tell the difference between items, and is useful to know when inserting and removing items from the tree. Children of an item can be removed with takeChild() and inserted at a given index in the list of children with the insertChild() function.

By default, items are enabled, selectable, checkable, and can be the source of a drag and drop operation. Each item's flags can be changed by calling setFlags() with the appropriate value (see Qt::ItemFlags). Checkable items can be checked and unchecked with the setCheckState() function. The corresponding checkState() function indicates whether the item is currently checked.

### Subclassing

When subclassing QTreeWidgetItem to provide custom items, it is possible to define new types for them so that they can be distinguished from standard items. The constructors for subclasses that require this feature need to call the base class constructor with a new type value equal to or greater than UserType.

See also QTreeWidget, QTreeWidgetItemIterator, Model/View Programming, QListWidgetItem, and QTableWidgetItem.

## Member Type Documentation

### enum QTreeWidgetItem::ChildIndicatorPolicy

Constant | Value | Description
--- | --- | ---
`QTreeWidgetItem::ShowIndicator` | `0` | The controls for expanding and collapsing will be shown for this item even if there are no children.
`QTreeWidgetItem::DontShowIndicator` | `1` | The controls for expanding and collapsing will never be shown even if there are children. If the node is forced open the user will not be able to expand or collapse the item.
`QTreeWidgetItem::DontShowIndicatorWhenChildless` | `2` | The controls for expanding and collapsing will be shown if the item contains children.

### enum QTreeWidgetItem::ItemType

This enum describes the types that are used to describe tree widget items.

Constant | Value | Description
--- | --- | ---
`QTreeWidgetItem::Type` | `0` | The default type for tree widget items.
`QTreeWidgetItem::UserType` | `1000` | The minimum value for custom types. Values below UserType are reserved by Qt.

You can define new user types in QTreeWidgetItem subclasses to ensure that custom items are treated specially; for example, when items are sorted.

See also type().

## Member Function Documentation

### `[explicit]` QTreeWidgetItem::QTreeWidgetItem(int type = Type)

Constructs a tree widget item of the specified type. The item must be inserted into a tree widget.

See also type().

### `[explicit]` QTreeWidgetItem::QTreeWidgetItem(QTreeWidget *parent, int type = Type)

Constructs a tree widget item of the specified type and appends it to the items in the given parent.

See also type().

### `[explicit]` QTreeWidgetItem::QTreeWidgetItem(QTreeWidgetItem *parent, int type = Type)

Constructs a tree widget item and append it to the given parent.

See also type().

### `[explicit]` QTreeWidgetItem::QTreeWidgetItem(const QStringList &strings, int type = Type)

Constructs a tree widget item of the specified type. The item must be inserted into a tree widget. The given list of strings will be set as the item text for each column in the item.

See also type().

### QTreeWidgetItem::QTreeWidgetItem(QTreeWidget *parent, QTreeWidgetItem *preceding, int type = Type)

Constructs a tree widget item of the specified type and inserts it into the given parent after the preceding item.

See also type().

### QTreeWidgetItem::QTreeWidgetItem(QTreeWidget *parent, const QStringList &strings, int type = Type)

Constructs a tree widget item of the specified type and appends it to the items in the given parent. The given list of strings will be set as the item text for each column in the item.

See also type().

### QTreeWidgetItem::QTreeWidgetItem(QTreeWidgetItem *parent, QTreeWidgetItem *preceding, int type = Type)

Constructs a tree widget item of the specified type that is inserted into the parent after the preceding child item.

See also type().

### QTreeWidgetItem::QTreeWidgetItem(QTreeWidgetItem *parent, const QStringList &strings, int type = Type)

Constructs a tree widget item and append it to the given parent. The given list of strings will be set as the item text for each column in the item.

See also type().

### QTreeWidgetItem::QTreeWidgetItem(const QTreeWidgetItem &other)

Constructs a copy of other. Note that type() and treeWidget() are not copied.

This function is useful when reimplementing clone().

See also data() and flags().

### `[virtual noexcept]` QTreeWidgetItem::~QTreeWidgetItem()

Destroys this tree widget item.

The item will be removed from QTreeWidgets to which it has been added. This makes it safe to delete an item at any time.

### void QTreeWidgetItem::addChild(QTreeWidgetItem *child)

Appends the child item to the list of children.

See also insertChild() and takeChild().

### void QTreeWidgetItem::addChildren(const QList<QTreeWidgetItem *> &children)

Appends the given list of children to the item.

See also insertChildren() and takeChildren().

### QBrush QTreeWidgetItem::background(int column) const

Returns the brush used to render the background of the specified column.

See also setBackground() and foreground().

### Qt::CheckState QTreeWidgetItem::checkState(int column) const

Returns the check state of the label in the given column.

See also setCheckState() and Qt::CheckState.

### QTreeWidgetItem *QTreeWidgetItem::child(int index) const

Returns the item at the given index in the list of the item's children.

See also parent().

### int QTreeWidgetItem::childCount() const

Returns the number of child items.

### QTreeWidgetItem::ChildIndicatorPolicy QTreeWidgetItem::childIndicatorPolicy() const

Returns the item indicator policy. This policy decides when the tree branch expand/collapse indicator is shown.

See also setChildIndicatorPolicy().

### `[virtual]` QTreeWidgetItem *QTreeWidgetItem::clone() const

Creates a deep copy of the item and of its children.

### int QTreeWidgetItem::columnCount() const

Returns the number of columns in the item.

### `[virtual]` QVariant QTreeWidgetItem::data(int column, int role) const

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

See also setData().

### `[protected]` void QTreeWidgetItem::emitDataChanged()

Causes the model associated with this item to emit a dataChanged() signal for this item.

You normally only need to call this function if you have subclassed QTreeWidgetItem and reimplemented data() and/or setData().

See also setData().

### Qt::ItemFlags QTreeWidgetItem::flags() const

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

The default value for flags is Qt::ItemIsSelectable | Qt::ItemIsUserCheckable | Qt::ItemIsEnabled | Qt::ItemIsDragEnabled | Qt::ItemIsDropEnabled.

See also setFlags().

### QFont QTreeWidgetItem::font(int column) const

Returns the font used to render the text in the specified column.

See also setFont().

### QBrush QTreeWidgetItem::foreground(int column) const

Returns the brush used to render the foreground (e.g. text) of the specified column. Setting a default-constructed brush will let the view use the default color from the style.

See also setForeground() and background().

### QIcon QTreeWidgetItem::icon(int column) const

Returns the icon that is displayed in the specified column.

See also setIcon() and iconSize.

### int QTreeWidgetItem::indexOfChild(QTreeWidgetItem *child) const

Returns the index of the given child in the item's list of children.

### void QTreeWidgetItem::insertChild(int index, QTreeWidgetItem *child)

Inserts the child item at index in the list of children.

If the child has already been inserted somewhere else it won't be inserted again.

### void QTreeWidgetItem::insertChildren(int index, const QList<QTreeWidgetItem *> &children)

Inserts the given list of children into the list of the item children at index .

Children that have already been inserted somewhere else won't be inserted.

### bool QTreeWidgetItem::isDisabled() const

Returns `true` if the item is disabled; otherwise returns `false`.

See also setFlags().

### bool QTreeWidgetItem::isExpanded() const

Returns `true` if the item is expanded, otherwise returns `false`.

See also setExpanded().

### bool QTreeWidgetItem::isFirstColumnSpanned() const

Returns `true` if the item is spanning all the columns in a row; otherwise returns `false`.

See also setFirstColumnSpanned().

### bool QTreeWidgetItem::isHidden() const

Returns `true` if the item is hidden, otherwise returns `false`.

See also setHidden().

### bool QTreeWidgetItem::isSelected() const

Returns `true` if the item is selected, otherwise returns `false`.

See also setSelected().

### QTreeWidgetItem *QTreeWidgetItem::parent() const

Returns the item's parent.

See also child().

### `[virtual]` void QTreeWidgetItem::read(QDataStream &in)

Reads the item from stream in. This only reads data into a single item.

See also write().

### void QTreeWidgetItem::removeChild(QTreeWidgetItem *child)

Removes the given item indicated by child. The removed item will not be deleted.

### void QTreeWidgetItem::setBackground(int column, const QBrush &brush)

Sets the background brush of the label in the given column to the specified brush. Setting a default-constructed brush will let the view use the default color from the style.

Note: If Qt Style Sheets are used on the same widget as setBackground(), style sheets will take precedence if the settings conflict.

See also background() and setForeground().

### void QTreeWidgetItem::setCheckState(int column, Qt::CheckState state)

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

See also checkState().

### void QTreeWidgetItem::setChildIndicatorPolicy(QTreeWidgetItem::ChildIndicatorPolicy policy)

Sets the item indicator policy. This policy decides when the tree branch expand/collapse indicator is shown. The default value is DontShowIndicatorWhenChildless.

See also childIndicatorPolicy().

### `[virtual]` void QTreeWidgetItem::setData(int column, int role, const QVariant &value)

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 Qt::ItemDataRole enum.

Note: The default implementation treats Qt::EditRole and Qt::DisplayRole as referring to the same data.

See also data().

### void QTreeWidgetItem::setDisabled(bool disabled)

Disables the item if disabled is true; otherwise enables the item.

See also isDisabled() and setFlags().

### void QTreeWidgetItem::setExpanded(bool expand)

Expands the item if expand is true, otherwise collapses the item.

Warning: The QTreeWidgetItem must be added to the QTreeWidget before calling this function.

See also isExpanded().

### void QTreeWidgetItem::setFirstColumnSpanned(bool span)

Sets the first section to span all columns if span is true; otherwise all item sections are shown.

See also isFirstColumnSpanned().

### void QTreeWidgetItem::setFlags(Qt::ItemFlags flags)

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.

See also flags().

### void QTreeWidgetItem::setFont(int column, const QFont &font)

Sets the font used to display the text in the given column to the given font.

See also font(), setText(), and setForeground().

### void QTreeWidgetItem::setForeground(int column, const QBrush &brush)

Sets the foreground brush of the label in the given column to the specified brush.

See also foreground() and setBackground().

### void QTreeWidgetItem::setHidden(bool hide)

Hides the item if hide is true, otherwise shows the item.

Note: A call to this function has no effect if the item is not currently in a view. In particular, calling `setHidden(true)` on an item and only then adding it to a view will result in a visible item.

See also isHidden().

### void QTreeWidgetItem::setIcon(int column, const QIcon &icon)

Sets the icon to be displayed in the given column to icon.

See also icon(), setText(), and iconSize.

### void QTreeWidgetItem::setSelected(bool select)

Sets the selected state of the item to select.

See also isSelected().

### void QTreeWidgetItem::setSizeHint(int column, const QSize &size)

Sets the size hint for the tree item in the given column to be size. If no size hint is set or size is invalid, the item delegate will compute the size hint based on the item data.

See also sizeHint().

### void QTreeWidgetItem::setStatusTip(int column, const QString &statusTip)

Sets the status tip for the given column to the given statusTip. QTreeWidget mouse tracking needs to be enabled for this feature to work.

See also statusTip(), setToolTip(), and setWhatsThis().

### void QTreeWidgetItem::setText(int column, const QString &text)

Sets the text to be displayed in the given column to the given text.

See also text(), setFont(), and setForeground().

### `[since 6.4]` void QTreeWidgetItem::setTextAlignment(int column, Qt::Alignment alignment)

Sets the text alignment for the label in the given column to the alignment specified.

This function was introduced in Qt 6.4.

See also textAlignment().

### void QTreeWidgetItem::setToolTip(int column, const QString &toolTip)

Sets the tooltip for the given column to toolTip.

See also toolTip(), setStatusTip(), and setWhatsThis().

### void QTreeWidgetItem::setWhatsThis(int column, const QString &whatsThis)

Sets the "What's This?" help for the given column to whatsThis.

See also whatsThis(), setStatusTip(), and setToolTip().

### QSize QTreeWidgetItem::sizeHint(int column) const

Returns the size hint set for the tree item in the given column (see QSize).

See also setSizeHint().

### void QTreeWidgetItem::sortChildren(int column, Qt::SortOrder order)

Sorts the children of the item using the given order, by the values in the given column.

Note: This function does nothing if the item is not associated with a QTreeWidget.

### QString QTreeWidgetItem::statusTip(int column) const

Returns the status tip for the contents of the given column.

See also setStatusTip().

### QTreeWidgetItem *QTreeWidgetItem::takeChild(int index)

Removes the item at index and returns it, otherwise return 0.

### QList<QTreeWidgetItem *> QTreeWidgetItem::takeChildren()

Removes the list of children and returns it, otherwise returns an empty list.

### QString QTreeWidgetItem::text(int column) const

Returns the text in the specified column.

See also setText().

### int QTreeWidgetItem::textAlignment(int column) const

Returns the text alignment for the label in the given column.

Note: This function returns an int for historical reasons. It will be corrected to return Qt::Alignment in Qt 7.

See also setTextAlignment() and Qt::Alignment.

### QString QTreeWidgetItem::toolTip(int column) const

Returns the tool tip for the given column.

See also setToolTip().

### QTreeWidget *QTreeWidgetItem::treeWidget() const

Returns the tree widget that contains the item.

### int QTreeWidgetItem::type() const

Returns the type passed to the QTreeWidgetItem constructor.

### QString QTreeWidgetItem::whatsThis(int column) const

Returns the "What's This?" help for the contents of the given column.

See also setWhatsThis().

### `[virtual]` void QTreeWidgetItem::write(QDataStream &out) const

Writes the item to stream out. This only writes data from one single item.

See also read().

### `[virtual]` bool QTreeWidgetItem::operator<(const QTreeWidgetItem &other) const

Returns `true` if the text in the item is less than the text in the other item, otherwise returns `false`.

### QTreeWidgetItem &QTreeWidgetItem::operator=(const QTreeWidgetItem &other)

Assigns other's data and flags to this item. Note that type() and treeWidget() are not copied.

This function is useful when reimplementing clone().

See also data() and flags().

## Related Non-Members

### QDataStream &operator<<(QDataStream &out, const QTreeWidgetItem &item)

Writes the tree widget item item to stream out.

This operator uses QTreeWidgetItem::write().

See also Serializing Qt Data Types.

### QDataStream &operator>>(QDataStream &in, QTreeWidgetItem &item)

Reads a tree widget item from stream in into item.

This operator uses QTreeWidgetItem::read().

See also Serializing Qt Data Types.