Класс QTreeWidgetItem

Класс QTreeWidgetItem предоставляет элемент для использования с удобным классом QTreeWidget. Подробнее...

• Список всех членов, включая наследуемые
• Устаревшие члены

Публичные типы

Публичные функции

Protected Functions

Related Non-Members

Detailed Description

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

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

This enum was introduced or modified in Qt 4.3.

enum QTreeWidgetItem::ItemType

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

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

QTreeWidgetItem::QTreeWidgetItem(int type = Type)

Создаёт элемент дерева указанного типа type. Элемент должен быть вставлен в дерево.

See also type().

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

Создаёт элемент дерева указанного типа type. Элемент должен быть вставлен в дерево. Данный список строк strings будет установлен как текст элемента для каждого столбца в элементе.

See also type().

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

Создаёт элемент дерева указанного типа type и добавляет его к элементам в заданном parent.

See also type().

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

Создаёт элемент дерева указанного типа type и добавляет его к элементам в заданном parent. Данный список строк strings будет установлен как текст элемента для каждого столбца в элементе.

See also type().

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

Создаёт элемент дерева указанного типа type и вставляет его в заданный parent после элемента preceding.

See also type().

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

Создаёт элемент дерева и добавляет его к заданному parent.

See also type().

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

Создаёт элемент дерева и добавляет его к заданному parent. Заданный список strings будет установлен как текст элемента для каждого столбца в элементе.

См. также type().

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

Создаёт элемент дерева заданного type, который вставляется в parent после элемента дочернего preceding.

См. также type().

QTreeWidgetItem::QTreeWidgetItem(const QTreeWidgetItem &other)

Создаёт копию other. Обратите внимание, что type() и treeWidget() не копируются.

Эта функция полезна при переопределении clone().

Эта функция была добавлена в Qt 4.1.

См. также data() и flags().

[virtual] QTreeWidgetItem::~QTreeWidgetItem()

Удаляет этот элемент дерева.

Элемент будет удалён из QTreeWidget, к которому он был добавлен. Это делает безопасным удаление элемента в любое время.

void QTreeWidgetItem::addChild(QTreeWidgetItem *child)

Добавляет элемент child в список дочерних элементов.

См. также insertChild() и takeChild().

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

Добавляет заданный список children к элементу.

Эта функция была добавлена в Qt 4.1.

См. также insertChildren() и takeChildren().

QBrush QTreeWidgetItem::background(int column) const

Возвращает кисть, используемую для отрисовки фона указанного column.

Эта функция была добавлена в Qt 4.2.

См. также setBackground() и foreground().

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

Возвращает состояние выбора метки в заданном column.

См. также setCheckState() и Qt::CheckState.

QTreeWidgetItem *QTreeWidgetItem::child(int index) const

Возвращает элемент по заданному index в списке дочерних элементов элемента.

См. также parent().

int QTreeWidgetItem::childCount() const

Возвращает количество дочерних элементов.

QTreeWidgetItem::ChildIndicatorPolicy QTreeWidgetItem::childIndicatorPolicy() const

Возвращает политику индикатора дочерних элементов. Эта политика определяет, когда отображается индикатор развёртывания/сворачивания ветви дерева.

См. также setChildIndicatorPolicy().

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

Создаёт глубокую копию элемента и его дочерних элементов.

int QTreeWidgetItem::columnCount() const

Возвращает количество столбцов в элементе.

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

Возвращает значение для столбца column и роли role элемента.

См. также setData().

[protected] void QTreeWidgetItem::emitDataChanged()

Заставляет модель, связанную с этим элементом, излучать сигнал dataChanged() для этого элемента.

Обычно вам нужно вызывать эту функцию только в том случае, если вы переопределили QTreeWidgetItem и переопределили data() и/или setData().

Эта функция была добавлена в Qt 4.5.

См. также setData().

Qt::ItemFlags QTreeWidgetItem::flags() const

Возвращает флаги, используемые для описания элемента. Они определяют, может ли элемент быть отмечен, изменён и выбран.

Значение по умолчанию для флагов — Qt::ItemIsSelectable | Qt::ItemIsUserCheckable | Qt::ItemIsEnabled | Qt::ItemIsDragEnabled | Qt::ItemIsDropEnabled.

См. также setFlags().

QFont QTreeWidgetItem::font(int column) const

Возвращает шрифт, используемый для отображения текста в указанном column.

См. также setFont().

QBrush QTreeWidgetItem::foreground(int column) const

Возвращает кисть, используемую для отрисовки переднего плана (например, текста) указанного column.

Эта функция была добавлена в Qt 4.2.

См. также setForeground() и background().

QIcon QTreeWidgetItem::icon(int column) const

Возвращает значок, отображаемый в указанном column.

См. также setIcon() и iconSize.

int QTreeWidgetItem::indexOfChild(QTreeWidgetItem *child) const

Возвращает индекс данного child в списке дочерних элементов элемента.

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

Вставляет элемент child в index в списке дочерних элементов.

Если элемент уже вставлен где-то ещё, он не будет вставлен снова.

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

Вставляет заданный список children в список дочерних элементов элемента по index.

Элементы, которые уже вставлены где-то ещё, не будут вставлены.

Эта функция была добавлена в Qt 4.1.

bool QTreeWidgetItem::isDisabled() const

Возвращает true если элемент отключён; в противном случае возвращает false.

Эта функция была добавлена в Qt 4.3.

См. также setFlags().

bool QTreeWidgetItem::isExpanded() const

Возвращает true если элемент развернут, в противном случае возвращает false.

Эта функция была добавлена в Qt 4.2.

См. также setExpanded().

bool QTreeWidgetItem::isFirstColumnSpanned() const

Возвращает true если элемент охватывает все столбцы в строке; в противном случае возвращает false.

Эта функция была добавлена в Qt 4.3.

См. также setFirstColumnSpanned().

bool QTreeWidgetItem::isHidden() const

Возвращает true если элемент скрыт, в противном случае возвращает false.

Эта функция была добавлена в Qt 4.2.

См. также setHidden().

bool QTreeWidgetItem::isSelected() const

Возвращает true если элемент выбран, в противном случае возвращает false.

Эта функция была добавлена в Qt 4.2.

См. также setSelected().

QTreeWidgetItem *QTreeWidgetItem::parent() const

Возвращает родительский элемент.

См. также child().

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

Считывает элемент из потока in. Это считывает данные только в один элемент.

См. также write().

void QTreeWidgetItem::removeChild(QTreeWidgetItem *child)

Удаляет указанный элемент child. Удаленный элемент не будет удалён.

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

Устанавливает кисть фона метки в заданном column на указанную brush.

Эта функция была добавлена в Qt 4.2.

См. также background() и setForeground().

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

Устанавливает состояние отметки элемента в заданном column на state.

См. также checkState().

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

Устанавливает политику индикатора элемента. Эта политика определяет, когда отображается индикатор разворачивания/сворачивания ветви дерева. Значение по умолчанию — ShowForChildren.

См. также childIndicatorPolicy().

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

Устанавливает значение для элемента в заданном column и role на заданное value.

role описывает тип данных, заданных value, и определён перечислением Qt::ItemDataRole.

Примечание: По умолчанию реализация рассматривает Qt::EditRole и Qt::DisplayRole как относящиеся к одним и тем же данным.

См. также data().

void QTreeWidgetItem::setDisabled(bool disabled)

Отключает элемент, если disabled равно true; в противном случае включает элемент.

Эта функция была добавлена в Qt 4.3.

См. также isDisabled() и setFlags().

void QTreeWidgetItem::setExpanded(bool expand)

Разворачивает элемент, если expand равно true, иначе сворачивает элемент.

Предупреждение: QTreeWidgetItem должен быть добавлен в QTreeWidget перед вызовом этой функции.

Эта функция была добавлена в Qt 4.2.

См. также isExpanded().

void QTreeWidgetItem::setFirstColumnSpanned(bool span)

Устанавливает первый раздел, чтобы он охватывал все столбцы, если span равно true; в противном случае показываются все разделы элемента.

Эта функция была добавлена в Qt 4.3.

См. также isFirstColumnSpanned().

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

Устанавливает флаги для элемента на заданные flags. Они определяют, может ли элемент быть выбран или изменён. Часто используется для отключения элемента.

См. также flags().

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

Устанавливает шрифт для отображения текста в заданном column на заданный font.

См. также font(), setText() и setForeground().

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

Устанавливает кисть переднего плана метки в заданном column на указанную brush.

Эта функция была добавлена в Qt 4.2.

См. также foreground() и setBackground().

void QTreeWidgetItem::setHidden(bool hide)

Скрывает элемент, если hide равно true, иначе показывает элемент.

Примечание: Вызов этой функции не имеет эффекта, если элемент в данный момент не находится в представлении. В частности, вызов setHidden(true) над элементом и только затем добавление его в представление приведет к отображению элемента.

Эта функция была добавлена в Qt 4.2.

См. также isHidden().

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

Устанавливает иконку для отображения в заданном column на icon.

См. также icon(), setText() и iconSize.

void QTreeWidgetItem::setSelected(bool select)

Устанавливает состояние выбора элемента на select.

Эта функция была добавлена в Qt 4.2.

См. также isSelected().

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

Устанавливает размер подсказки для элемента дерева в заданном column на size. Если размер подсказки не установлен, делегат элемента вычислит размер подсказки на основе данных элемента.

Эта функция была добавлена в Qt 4.1.

См. также sizeHint().

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

Устанавливает подсказку состояния для данного column на заданную statusTip. Для работы с отслеживанием мыши в QTreeWidget необходимо включить эту функцию.

См. также statusTip(), setToolTip() и setWhatsThis().

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

Устанавливает текст для отображения в заданном column на заданный text.

См. также text(), setFont() и setForeground().

void QTreeWidgetItem::setTextAlignment(int column, int alignment)

Устанавливает выравнивание текста для метки в заданном column на указанное alignment (см. Qt::AlignmentFlag).

См. также textAlignment().

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

Устанавливает всплывающую подсказку для данного column на toolTip.

См. также toolTip(), setStatusTip() и setWhatsThis().

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

Устанавливает подсказку "Что это?" для данного column на whatsThis.

См. также whatsThis(), setStatusTip() и setToolTip().

QSize QTreeWidgetItem::sizeHint(int column) const

Возвращает установленную подсказку размера для элемента дерева в заданном column (см. QSize).

Эта функция была добавлена в Qt 4.1.

См. также setSizeHint().

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

Сортирует потомков элемента, используя заданный order, по значениям в заданном column.

Примечание: Эта функция ничего не делает, если элемент не связан с QTreeWidget.

Эта функция была добавлена в Qt 4.2.

QString QTreeWidgetItem::statusTip(int column) const

Возвращает подсказку состояния для содержимого заданного column.

См. также setStatusTip().

QTreeWidgetItem *QTreeWidgetItem::takeChild(int index)

Удаляет элемент в index и возвращает его, иначе возвращает 0.

QList<QTreeWidgetItem *> QTreeWidgetItem::takeChildren()

Удаляет список дочерних элементов и возвращает его, в противном случае возвращает пустой список.

Эта функция была добавлена в Qt 4.1.

QString QTreeWidgetItem::text(int column) const

Возвращает текст в указанном column.

См. также setText().

int QTreeWidgetItem::textAlignment(int column) const

Возвращает выравнивание текста для метки в заданном column (см. Qt::AlignmentFlag).

См. также setTextAlignment().

QString QTreeWidgetItem::toolTip(int column) const

Возвращает всплывающую подсказку для заданного column.

См. также setToolTip().

QTreeWidget *QTreeWidgetItem::treeWidget() const

Возвращает виджет дерева, содержащий элемент.

int QTreeWidgetItem::type() const

Возвращает тип, переданный конструктору QTreeWidgetItem.

QString QTreeWidgetItem::whatsThis(int column) const

Возвращает справку «Что это?» для содержимого заданного column.

См. также setWhatsThis().

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

Записывает элемент в поток out. Это записывает данные только из одного элемента.

См. также read().

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

Возвращает true если текст в элементе меньше текста в элементе other, в противном случае возвращает false.

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

Присваивает данные и флаги other этому элементу. Обратите внимание, что type() и treeWidget() не копируются.

Эта функция полезна при переопределении clone().

См. также data() и flags().