QTreeWidgetItem Class

     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"));

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

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.

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.

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.

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.

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.

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.

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().