QtBase
v6.3.1
|
The QTreeWidgetItem class provides an item for use with the QTreeWidget convenience class. More...
#include <qtreewidget.h>
Public Types | |
enum | ItemType { Type = 0 , UserType = 1000 } |
enum | ChildIndicatorPolicy { ShowIndicator , DontShowIndicator , DontShowIndicatorWhenChildless } |
Protected Member Functions | |
void | emitDataChanged () |
Friends | |
class | QTreeModel |
class | QTreeWidget |
class | QTreeWidgetPrivate |
class | QTreeWidgetItemIterator |
class | QTreeWidgetItemPrivate |
Related Functions | |
(Note that these are not member functions.) | |
QDataStream & | operator<< (QDataStream &out, const QTreeWidgetItem &item) |
QDataStream & | operator>> (QDataStream &in, QTreeWidgetItem &item) |
The QTreeWidgetItem class provides an item for use with the QTreeWidget convenience class.
\inmodule QtWidgets
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:
Items can be added in a particular order by specifying the item they follow when they are constructed:
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 \l{Qt::ItemFlags}). Checkable items can be checked and unchecked with the setCheckState() function. The corresponding checkState() function indicates whether the item is currently checked.
Definition at line 58 of file qtreewidget.h.
\value ShowIndicator The controls for expanding and collapsing will be shown for this item even if there are no children. \value DontShowIndicator 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. \value DontShowIndicatorWhenChildless The controls for expanding and collapsing will be shown if the item contains children.
Enumerator | |
---|---|
ShowIndicator | |
DontShowIndicator | |
DontShowIndicatorWhenChildless |
Definition at line 97 of file qtreewidget.h.
This enum describes the types that are used to describe tree widget items.
\value Type The default type for tree widget items. \value UserType 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.
Enumerator | |
---|---|
Type | |
UserType |
Definition at line 66 of file qtreewidget.h.
|
explicit |
Constructs a tree widget item of the specified type. The item must be inserted into a tree widget.
Definition at line 1390 of file qtreewidget.cpp.
|
explicit |
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.
Definition at line 1400 of file qtreewidget.cpp.
|
explicit |
Constructs a tree widget item of the specified type and appends it to the items in the given parent.
Definition at line 1416 of file qtreewidget.cpp.
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.
Definition at line 1436 of file qtreewidget.cpp.
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.
Definition at line 1456 of file qtreewidget.cpp.
|
explicit |
Constructs a tree widget item and append it to the given parent.
Definition at line 1472 of file qtreewidget.cpp.
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.
Definition at line 1485 of file qtreewidget.cpp.
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.
Definition at line 1502 of file qtreewidget.cpp.
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().
Definition at line 1912 of file qtreewidget.cpp.
|
virtual |
Destroys this tree widget item.
The item will be removed from \l{QTreeWidget}s to which it has been added. This makes it safe to delete an item at any time.
Definition at line 1519 of file qtreewidget.cpp.
void QTreeWidgetItem::addChild | ( | QTreeWidgetItem * | child | ) |
Appends the child item to the list of children.
Definition at line 1943 of file qtreewidget.cpp.
void QTreeWidgetItem::addChildren | ( | const QList< QTreeWidgetItem * > & | children | ) |
Appends the given list of children to the item.
Definition at line 2046 of file qtreewidget.cpp.
|
inline |
Returns the brush used to render the background of the specified column.
Definition at line 137 of file qtreewidget.h.
|
inline |
Returns the check state of the label in the given column.
Definition at line 147 of file qtreewidget.h.
|
inline |
Returns the item at the given index in the list of the item's children.
Definition at line 169 of file qtreewidget.h.
|
inline |
Returns the number of child items.
Definition at line 175 of file qtreewidget.h.
QTreeWidgetItem::ChildIndicatorPolicy QTreeWidgetItem::childIndicatorPolicy | ( | ) | const |
Returns the item indicator policy. This policy decides when the tree branch expand/collapse indicator is shown.
Definition at line 1628 of file qtreewidget.cpp.
|
virtual |
Creates a deep copy of the item and of its children.
Definition at line 1567 of file qtreewidget.cpp.
|
inline |
Returns the number of columns in the item.
Definition at line 176 of file qtreewidget.h.
|
virtual |
Returns the value for the item's column and role.
Definition at line 1825 of file qtreewidget.cpp.
|
protected |
Causes the model associated with this item to emit a \l{QAbstractItemModel::dataChanged()}{dataChanged}() signal for this item.
You normally only need to call this function if you have subclassed QTreeWidgetItem and reimplemented data() and/or setData().
Definition at line 2240 of file qtreewidget.cpp.
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.
Definition at line 1732 of file qtreewidget.cpp.
|
inline |
Returns the font used to render the text in the specified column.
Definition at line 128 of file qtreewidget.h.
|
inline |
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.
Definition at line 142 of file qtreewidget.h.
|
inline |
Returns the icon that is displayed in the specified column.
Definition at line 108 of file qtreewidget.h.
|
inline |
Returns the index of the given child in the item's list of children.
Definition at line 239 of file qtreewidget.h.
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.
Definition at line 1956 of file qtreewidget.cpp.
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.
Definition at line 2058 of file qtreewidget.cpp.
|
inline |
Returns true
if the item is disabled; otherwise returns false
.
Definition at line 377 of file qtreewidget.h.
bool QTreeWidgetItem::isExpanded | ( | ) | const |
Returns true
if the item is expanded, otherwise returns false
.
Definition at line 1114 of file qtreewidget.cpp.
bool QTreeWidgetItem::isFirstColumnSpanned | ( | ) | const |
Returns true
if the item is spanning all the columns in a row; otherwise returns false
.
Definition at line 1149 of file qtreewidget.cpp.
bool QTreeWidgetItem::isHidden | ( | ) | const |
Returns true
if the item is hidden, otherwise returns false
.
Definition at line 1075 of file qtreewidget.cpp.
bool QTreeWidgetItem::isSelected | ( | ) | const |
Returns true
if the item is selected, otherwise returns false
.
Definition at line 1035 of file qtreewidget.cpp.
|
virtual |
Returns true
if the text in the item is less than the text in the other item, otherwise returns false
.
Definition at line 1855 of file qtreewidget.cpp.
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().
Definition at line 1929 of file qtreewidget.cpp.
|
inline |
Returns the item's parent.
Definition at line 168 of file qtreewidget.h.
|
virtual |
Reads the item from stream in. This only reads data into a single item.
Definition at line 1870 of file qtreewidget.cpp.
void QTreeWidgetItem::removeChild | ( | QTreeWidgetItem * | child | ) |
Removes the given item indicated by child. The removed item will not be deleted.
Definition at line 1998 of file qtreewidget.cpp.
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.
Definition at line 139 of file qtreewidget.h.
|
inline |
Sets the item in the given column check state to be state.
Definition at line 149 of file qtreewidget.h.
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.
Definition at line 1610 of file qtreewidget.cpp.
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.
Definition at line 1747 of file qtreewidget.cpp.
|
inline |
Disables the item if disabled is true; otherwise enables the item.
Definition at line 374 of file qtreewidget.h.
void QTreeWidgetItem::setExpanded | ( | bool | expand | ) |
Expands the item if expand is true, otherwise collapses the item.
Definition at line 1097 of file qtreewidget.cpp.
void QTreeWidgetItem::setFirstColumnSpanned | ( | bool | span | ) |
Sets the first section to span all columns if span is true; otherwise all item sections are shown.
Definition at line 1132 of file qtreewidget.cpp.
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.
Definition at line 1641 of file qtreewidget.cpp.
Sets the font used to display the text in the given column to the given font.
Definition at line 236 of file qtreewidget.h.
Sets the foreground brush of the label in the given column to the specified brush.
Definition at line 144 of file qtreewidget.h.
void QTreeWidgetItem::setHidden | ( | bool | hide | ) |
Hides the item if hide is true, otherwise shows the item.
setHidden(true)
on an item and only then adding it to a view will result in a visible item.Definition at line 1052 of file qtreewidget.cpp.
Sets the icon to be displayed in the given column to icon.
Definition at line 218 of file qtreewidget.h.
void QTreeWidgetItem::setSelected | ( | bool | select | ) |
Sets the selected state of the item to select.
Definition at line 1015 of file qtreewidget.cpp.
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.
Definition at line 154 of file qtreewidget.h.
Sets the status tip for the given column to the given statusTip. QTreeWidget mouse tracking needs to be enabled for this feature to work.
Sets the text to be displayed in the given column to the given text.
Definition at line 215 of file qtreewidget.h.
|
inline |
Sets the text alignment for the label in the given column to the alignment specified (see \l{Qt::AlignmentFlag}).
Definition at line 134 of file qtreewidget.h.
|
inline |
Returns the size hint set for the tree item in the given column (see \l{QSize}).
Definition at line 152 of file qtreewidget.h.
|
inline |
Sorts the children of the item using the given order, by the values in the given column.
Definition at line 189 of file qtreewidget.h.
|
inline |
Returns the status tip for the contents of the given column.
Definition at line 112 of file qtreewidget.h.
QTreeWidgetItem * QTreeWidgetItem::takeChild | ( | int | index | ) |
Removes the item at index and returns it, otherwise return 0.
Definition at line 2006 of file qtreewidget.cpp.
QList< QTreeWidgetItem * > QTreeWidgetItem::takeChildren | ( | ) |
Removes the list of children and returns it, otherwise returns an empty list.
Definition at line 2111 of file qtreewidget.cpp.
|
inline |
Returns the text in the specified column.
Definition at line 104 of file qtreewidget.h.
|
inline |
Returns the text alignment for the label in the given column (see \l{Qt::AlignmentFlag}).
Definition at line 132 of file qtreewidget.h.
|
inline |
Returns the tree widget that contains the item.
Definition at line 80 of file qtreewidget.h.
|
inline |
Returns the type passed to the QTreeWidgetItem constructor.
Definition at line 188 of file qtreewidget.h.
|
virtual |
Writes the item to stream out. This only writes data from one single item.
Definition at line 1896 of file qtreewidget.cpp.
|
related |
Writes the tree widget item item to stream out.
This operator uses QTreeWidgetItem::write().
Definition at line 2285 of file qtreewidget.cpp.
|
related |
Reads a tree widget item from stream in into item.
This operator uses QTreeWidgetItem::read().
Definition at line 2300 of file qtreewidget.cpp.
|
friend |
Definition at line 60 of file qtreewidget.h.
|
friend |
Definition at line 61 of file qtreewidget.h.
|
friend |
Definition at line 63 of file qtreewidget.h.
|
friend |
Definition at line 64 of file qtreewidget.h.
|
friend |
Definition at line 62 of file qtreewidget.h.