Класс QStandardItem

Класс QStandardItem предоставляет элемент для использования с классом QStandardItemModel. Подробнее...

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

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

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

Защищенные функции

Защищенные переменные

Связанные нечлены

Подробное описание

Класс QStandardItem предоставляет элемент для использования с классом QStandardItemModel.

Элементы обычно содержат текст, значки или флажки.

Каждый элемент может иметь свою собственную кисть фона, которая устанавливается функцией setBackground(). Текущая кисть фона может быть найдена с помощью background(). Текстовая метка для каждого элемента может быть отображена с помощью своего шрифта и кисти. Они задаются функциями setFont() и setForeground(), и считываются с помощью font() и foreground().

По умолчанию элементы включены, редактируемы, выбираемы, отмечаемы и могут использоваться как источник, так и цель операции перетаскивания.

Каждый элемент может иметь свою собственную таблицу дочерних элементов, что позволяет создавать иерархии элементов.

Размеры таблицы дочерних элементов могут быть установлены с помощью setRowCount() и setColumnCount(). Элементы могут быть размещены в таблице дочерних элементов с помощью setChild(). Получить указатель на дочерний элемент с помощью child(). Новые строки и столбцы дочерних элементов также можно вставить с помощью insertRow() и insertColumn(), или добавить с помощью appendRow() и appendColumn(). При использовании функций добавления и вставки размеры таблицы дочерних элементов будут увеличиваться по мере необходимости.

Существующую строку дочерних элементов можно удалить с помощью removeRow() или takeRow(); соответственно, столбец можно удалить с помощью removeColumn() или takeColumn().

Дочерние элементы элемента могут быть отсортированы с помощью вызова sortChildren().

Наследование

При наследовании от QStandardItem для предоставления пользовательских элементов можно определять новые типы для них, чтобы их можно было отличать от базового класса. Функция type() должна быть переопределена для возврата нового значения типа, равного или большего UserType.

Переопределите data() и setData(), если вы хотите выполнить пользовательскую обработку запросов данных и/или контролировать, как данные элемента представлены.

Переопределите clone(), если вы хотите, чтобы QStandardItemModel мог создавать экземпляры вашего пользовательского класса элемента по требованию (см. QStandardItemModel::setItemPrototype()).

Переопределите read() и write(), если вы хотите управлять тем, как элементы представлены в их сериализованной форме.

Переопределите operator<(), если вы хотите управлять семантикой сравнения элементов. operator<() определяет порядок сортировки при сортировке элементов с помощью sortChildren() или с помощью QStandardItemModel::sort().

См. также QStandardItemModel, Элементы представления элементов и Программирование моделей/представлений.

Документация типов членов

перечисление QStandardItem::ItemType

Это перечисление описывает типы, используемые для описания стандартных элементов.

Вы можете определять новые пользовательские типы в подклассах QStandardItem, чтобы обеспечить специальное обращение с пользовательскими элементами, например, при сортировке.

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

Документация по членам-функциям

QStandardItem::QStandardItem()

Конструирует элемент.

QStandardItem::QStandardItem(const QString &text)

Конструирует элемент с заданным текстом text.

QStandardItem::QStandardItem(const QIcon &icon, const QString &text)

Конструирует элемент с заданным значком icon и текстом text.

QStandardItem::QStandardItem(int rows, int columns = 1)

Конструирует элемент с rows строками и columns столбцами дочерних элементов.

[protected] QStandardItem::QStandardItem(const QStandardItem &other)

Конструирует копию other. Обратите внимание, что model() не копируется.

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

[virtual] QStandardItem::~QStandardItem()

Деструктор элемента. Это приводит к уничтожению дочерних элементов элемента.

QString QStandardItem::accessibleDescription() const

Возвращает описание элемента для вспомогательных технологий.

Описание доступности используется вспомогательными технологиями (например, для пользователей, которые не могут использовать обычные средства взаимодействия).

См. также setAccessibleDescription() и accessibleText().

QString QStandardItem::accessibleText() const

Возвращает доступный текст элемента.

Доступный текст используется вспомогательными технологиями (например, для пользователей, которые не могут использовать обычные средства взаимодействия).

См. также setAccessibleText() и accessibleDescription().

void QStandardItem::appendColumn(const QList<QStandardItem *> &items)

Добавляет столбец, содержащий элементы items. При необходимости количество строк увеличивается до размера items.

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

void QStandardItem::appendRow(const QList<QStandardItem *> &items)

Добавляет строку, содержащую элементы items. При необходимости количество столбцов увеличивается до размера items.

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

void QStandardItem::appendRow(QStandardItem *item)

Это перегруженная функция.

Добавляет строку, содержащую элемент item.

При создании списка или дерева, имеющего только один столбец, эта функция предоставляет удобный способ добавления одного нового элемента.

void QStandardItem::appendRows(const QList<QStandardItem *> &items)

Добавляет строки, содержащие элементы items. Количество столбцов не изменится.

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

QBrush QStandardItem::background() const

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

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

Qt::CheckState QStandardItem::checkState() const

Возвращает состояние выбора элемента.

См. также setCheckState() и isCheckable().

QStandardItem *QStandardItem::child(int row, int column = 0) const

Возвращает дочерний элемент в (row, column), если он задан; в противном случае возвращает nullptr.

См. также setChild(), takeChild() и parent().

void QStandardItem::clearData()

Удаляет все данные из всех ролей, ранее заданных.

Функция была введена в Qt 5.12.

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

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

Возвращает копию этого элемента. Дочерние элементы элемента не копируются.

При наследовании от QStandardItem вы можете переопределить эту функцию, чтобы предоставить QStandardItemModel фабрику, которую он может использовать для создания новых элементов по требованию.

См. также QStandardItemModel::setItemPrototype() и operator=().

int QStandardItem::column() const

Возвращает столбец, в котором находится элемент в таблице дочерних элементов родительского элемента, или -1, если у элемента нет родителя.

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

int QStandardItem::columnCount() const

Возвращает количество столбцов дочерних элементов, имеющихся у элемента.

См. также setColumnCount() и rowCount().

[virtual] QVariant QStandardItem::data(int role = Qt::UserRole + 1) const

Возвращает данные элемента для данной роли role или недопустимый QVariant, если для роли нет данных.

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

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

[protected] void QStandardItem::emitDataChanged()

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

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

Функция была введена в Qt 4.4.

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

Qt::ItemFlags QStandardItem::flags() const

Возвращает флаги элемента.

Флаги элемента определяют, как пользователь может взаимодействовать с элементом.

По умолчанию элементы включены, редактируемы, выбираемы, выбираемы для опции и могут использоваться как источник, так и целевой объект операции перетаскивания.

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

QFont QStandardItem::font() const

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

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

QBrush QStandardItem::foreground() const

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

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

bool QStandardItem::hasChildren() const

Возвращает true если у этого элемента есть дочерние элементы; в противном случае возвращает false.

См. также rowCount(), columnCount() и child().

QIcon QStandardItem::icon() const

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

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

QModelIndex QStandardItem::index() const

Возвращает QModelIndex, связанный с этим элементом.

Когда вам нужно вызвать функциональность элемента в API, основанном на QModelIndex (например, QAbstractItemView), вы можете вызвать эту функцию, чтобы получить индекс, соответствующий расположению элемента в модели.

Если элемент не связан с моделью, возвращается недействительный QModelIndex.

См. также model() и QStandardItemModel::itemFromIndex().

void QStandardItem::insertColumn(int column, const QList<QStandardItem *> &items)

Вставляет столбец в позиции column, содержащий элементы items. При необходимости количество строк увеличивается до размера items.

См. также insertColumns() и insertRow().

void QStandardItem::insertColumns(int column, int count)

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

См. также insertColumn() и insertRows().

void QStandardItem::insertRow(int row, const QList<QStandardItem *> &items)

Вставляет строку в позицию row, содержащую элементы items. При необходимости количество столбцов увеличивается до размера items.

См. также insertRows() и insertColumn().

void QStandardItem::insertRow(int row, QStandardItem *item)

Это перегруженный метод.

Вставляет строку в позицию row, содержащую элемент item.

При создании списка или дерева с одним столбцом этот метод предоставляет удобный способ вставки одного нового элемента.

void QStandardItem::insertRows(int row, const QList<QStandardItem *> &items)

Вставляет элементы items в позицию row. Количество столбцов не изменяется.

См. также insertRow() и insertColumn().

void QStandardItem::insertRows(int row, int count)

Вставляет count строк дочерних элементов в строку row.

См. также insertRow() и insertColumns().

bool QStandardItem::isAutoTristate() const

Возвращает значение, указывающее, является ли элемент трехсостоятельным и контролируется QTreeWidget.

Значение по умолчанию — false.

Этот метод был добавлен в Qt 5.6.

См. также setAutoTristate(), isCheckable() и checkState().

bool QStandardItem::isCheckable() const

Возвращает значение, указывающее, можно ли пользователю отмечать элемент.

Значение по умолчанию — false.

См. также setCheckable(), checkState(), isUserTristate() и isAutoTristate().

bool QStandardItem::isDragEnabled() const

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

Значение по умолчанию — true.

Обратите внимание, что перетаскивание элементов должно быть разрешено в представлении для работы перетаскивания; см. QAbstractItemView::dragEnabled.

См. также setDragEnabled(), isDropEnabled() и flags().

bool QStandardItem::isDropEnabled() const

Возвращает значение, указывающее, разрешено ли размещение элемента. Если для элемента разрешено размещение, он может использоваться в качестве цели размещения.

Значение по умолчанию — true.

См. также setDropEnabled(), isDragEnabled() и flags().

bool QStandardItem::isEditable() const

Возвращает значение, указывающее, можно ли редактировать элемент пользователем.

Когда элемент редактируемый (и активный), пользователь может редактировать его, вызвав один из триггеров редактирования представления; см. QAbstractItemView::editTriggers.

Значение по умолчанию — true.

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

bool QStandardItem::isEnabled() const

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

Когда элемент активен, пользователь может с ним взаимодействовать. Возможные типы взаимодействия задаются другими флагами элемента, такими как isEditable() и isSelectable().

Значение по умолчанию — true.

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

bool QStandardItem::isSelectable() const

Возвращает значение, указывающее, можно ли выбрать элемент пользователем.

Значение по умолчанию — true.

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

bool QStandardItem::isUserTristate() const

Возвращает значение, указывающее, является ли элемент трехсостоятельным, то есть если ли он отмечается тремя отдельными состояниями и пользователь может переключаться между всеми тремя состояниями.

Значение по умолчанию — false.

Этот метод был добавлен в Qt 5.6.

См. также setUserTristate(), isCheckable() и checkState().

QStandardItemModel *QStandardItem::model() const

Возвращает QStandardItemModel, к которому относится этот элемент.

Если элемент не является дочерним элементом другого элемента, принадлежащего модели, этот метод возвращает nullptr.

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

QStandardItem *QStandardItem::parent() const

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

Примечание: Для элементов верхнего уровня parent() возвращает nullptr. Чтобы получить родительский элемент для элемента верхнего уровня, используйте QStandardItemModel::invisibleRootItem() вместо этого.

См. также child() и QStandardItemModel::invisibleRootItem().

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

Считывает элемент из потока in. Считываются только данные и флаги элемента, а не дочерние элементы.

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

void QStandardItem::removeColumn(int column)

Удаляет заданный column. Элементы, которые были в столбце, удаляются.

См. также takeColumn(), removeColumns() и removeRow().

void QStandardItem::removeColumns(int column, int count)

Удаляет count столбцов в столбце column. Элементы, которые были в этих столбцах, удаляются.

См. также removeColumn() и removeRows().

void QStandardItem::removeRow(int row)

Удаляет заданную row. Элементы, которые были в строке, удаляются.

См. также takeRow(), removeRows() и removeColumn().

void QStandardItem::removeRows(int row, int count)

Удаляет count строк в строке row. Элементы, которые были в этих строках, удаляются.

См. также removeRow() и removeColumn().

int QStandardItem::row() const

Возвращает строку, в которой расположен элемент в таблице дочерних элементов родительского элемента, или -1, если элемент не имеет родителя.

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

int QStandardItem::rowCount() const

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

См. также setRowCount() и columnCount().

void QStandardItem::setAccessibleDescription(const QString &accessibleDescription)

Устанавливает описание элемента для использования вспомогательными технологиями (например, для пользователей, которые не могут использовать стандартные методы взаимодействия), к строке, заданной в accessibleDescription.

См. также accessibleDescription() и setAccessibleText().

void QStandardItem::setAccessibleText(const QString &accessibleText)

Устанавливает доступный текст элемента в строку, указанную в accessibleText.

Доступный текст используется средствами вспомогательной технологии (например, для пользователей, которые не могут использовать стандартные способы взаимодействия).

См. также accessibleText() и setAccessibleDescription().

void QStandardItem::setAutoTristate(bool tristate)

Определяет, что элемент является трехсостоятельным и управляется QTreeWidget, если tristate равно true. Это позволяет автоматически управлять состоянием родительских элементов в QTreeWidget (отмечен, если все дочерние элементы отмечены, не отмечен, если все дочерние элементы не отмечены или частично отмечен, если только некоторые дочерние элементы отмечены).

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

См. также isAutoTristate(), setCheckable() и setCheckState().

void QStandardItem::setBackground(const QBrush &brush)

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

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

void QStandardItem::setCheckState(Qt::CheckState state)

Устанавливает состояние проверки элемента в state.

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

void QStandardItem::setCheckable(bool checkable)

Устанавливает, может ли элемент быть отмечен пользователем. Если checkable равно true, элемент может быть отмечен пользователем; в противном случае пользователь не может отметить элемент.

Делегат элемента отобразит проверяемый элемент с флажком рядом с текстом элемента.

См. также isCheckable(), setCheckState(), setUserTristate() и setAutoTristate().

void QStandardItem::setChild(int row, int column, QStandardItem *item)

Устанавливает дочерний элемент в (row, column) в item. Этот элемент (родительский элемент) принимает владение item. При необходимости количество строк и столбцов увеличивается для размещения элемента.

Примечание: Передача нулевого указателя в качестве item удаляет элемент.

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

void QStandardItem::setChild(int row, QStandardItem *item)

Это перегруженный метод.

Устанавливает дочерний элемент в row в item.

void QStandardItem::setColumnCount(int columns)

Устанавливает количество столбцов дочерних элементов в columns. Если это значение меньше columnCount(), данные в нежелательных столбцах удаляются.

См. также columnCount() и setRowCount().

[virtual] void QStandardItem::setData(const QVariant &value, int role = Qt::UserRole + 1)

Устанавливает данные элемента для заданного role в указанное значение value.

Если вы подклассируете QStandardItem и переопределите эту функцию, ваше переопределение должно вызывать emitDataChanged(), если вы не вызываете базовую реализацию setData(). Это обеспечит, что, например, представления, использующие модель, будут уведомлены о изменениях.

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

См. также Qt::ItemDataRole, data() и setFlags().

void QStandardItem::setDragEnabled(bool dragEnabled)

Устанавливает, разрешен ли перетаскивание элемента. Если dragEnabled равно true, элемент может быть перетащен пользователем; в противном случае пользователь не может перетащить элемент.

Обратите внимание, что вам также необходимо убедиться, что перетаскивание элементов разрешено в представлении; см. QAbstractItemView::dragEnabled.

См. также isDragEnabled(), setDropEnabled() и setFlags().

void QStandardItem::setDropEnabled(bool dropEnabled)

Устанавливает, разрешен ли сброс элемента. Если dropEnabled равно true, элемент может быть использован как целевой объект сброса; в противном случае — нет.

Обратите внимание, что вам также необходимо убедиться, что сбросы разрешены в представлении; см. QWidget::acceptDrops; и что модель поддерживает нужные действия сброса; см. QAbstractItemModel::supportedDropActions.

См. также isDropEnabled(), setDragEnabled() и setFlags().

void QStandardItem::setEditable(bool editable)

Устанавливает, может ли элемент быть изменен. Если editable равно true, элемент может быть изменён пользователем; в противном случае пользователь не может изменить элемент.

Как пользователь может изменять элементы в представлении, определяется триггерами редактирования представления; см. QAbstractItemView::editTriggers.

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

void QStandardItem::setEnabled(bool enabled)

Устанавливает, активен ли элемент. Если enabled равно true, элемент активен, что означает, что пользователь может взаимодействовать с элементом; если enabled равно false, пользователь не может взаимодействовать с элементом.

Этот флаг имеет приоритет над другими флагами элемента; например, если элемент не активен, он не может быть выбран пользователем, даже если флаг Qt::ItemIsSelectable был установлен.

См. также isEnabled(), Qt::ItemIsEnabled и setFlags().

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

Устанавливает флаги элемента для элемента в flags.

Флаги элемента определяют, как пользователь может взаимодействовать с элементом. Это часто используется для отключения элемента.

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

void QStandardItem::setFont(const QFont &font)

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

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

void QStandardItem::setForeground(const QBrush &brush)

Устанавливает кисть, используемую для отображения переднего плана элемента (например, текста), в заданную brush.

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

void QStandardItem::setIcon(const QIcon &icon)

Устанавливает значок элемента в указанный icon.

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

void QStandardItem::setRowCount(int rows)

Устанавливает количество строк дочерних элементов в rows. Если это значение меньше rowCount(), данные в нежелательных строках удаляются.

См. также rowCount() и setColumnCount().

void QStandardItem::setSelectable(bool selectable)

Устанавливает, может ли элемент быть выбран. Если selectable равно true, элемент может быть выбран пользователем; в противном случае пользователь не может выбрать элемент.

Вы можете управлять поведением выбора и режимом, изменяя свойства представления; см. QAbstractItemView::selectionMode и QAbstractItemView::selectionBehavior.

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

void QStandardItem::setSizeHint(const QSize &size)

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

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

void QStandardItem::setStatusTip(const QString &statusTip)

Устанавливает подсказку состояния элемента в строку, указанную в statusTip.

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

void QStandardItem::setText(const QString &text)

Устанавливает текст элемента в указанный text.

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

void QStandardItem::setTextAlignment(Qt::Alignment alignment)

Устанавливает выравнивание текста элемента в указанное alignment.

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

void QStandardItem::setToolTip(const QString &toolTip)

Устанавливает всплывающую подсказку элемента в строку, указанную в toolTip.

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

void QStandardItem::setUserTristate(bool tristate)

Устанавливает, является ли элемент трехсостоятельным и управляемым пользователем. Если tristate равно true, пользователь может переключаться между тремя состояниями; в противном случае элемент можно переключать в двух состояниях. (Обратите внимание, что это также требует, чтобы элемент был переключаемым; см. isCheckable().)

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

См. также isUserTristate(), setCheckable() и setCheckState().

void QStandardItem::setWhatsThis(const QString &whatsThis)

Устанавливает подсказку «Что это?» для элемента в строку, указанную в whatsThis.

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

QSize QStandardItem::sizeHint() const

Возвращает размер подсказки, установленный для элемента, или недействительный QSize, если размер подсказки не установлен.

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

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

void QStandardItem::sortChildren(int column, Qt::SortOrder order = Qt::AscendingOrder)

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

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

См. также operator<().

QString QStandardItem::statusTip() const

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

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

QStandardItem *QStandardItem::takeChild(int row, int column = 0)

Удаляет дочерний элемент в (row, column) без удаления и возвращает указатель на элемент. Если дочернего элемента в заданном месте не было, функция возвращает nullptr.

Обратите внимание, что эта функция, в отличие от takeRow() и takeColumn(), не влияет на размер таблицы дочерних элементов.

См. также child(), takeRow() и takeColumn().

QList<QStandardItem *> QStandardItem::takeColumn(int column)

Удаляет column без удаления элементов столбца и возвращает список указателей на удаленные элементы. Для элементов в столбце, которые не были установлены, соответствующие указатели в списке будут равны 0.

См. также removeColumn(), insertColumn() и takeRow().

QList<QStandardItem *> QStandardItem::takeRow(int row)

Удаляет row без удаления элементов строки и возвращает список указателей на удаленные элементы. Для элементов в строке, которые не были установлены, соответствующие указатели в списке будут равны 0.

См. также removeRow(), insertRow() и takeColumn().

QString QStandardItem::text() const

Возвращает текст элемента. Это текст, отображаемый пользователю в представлении.

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

Qt::Alignment QStandardItem::textAlignment() const

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

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

QString QStandardItem::toolTip() const

Возвращает всплывающую подсказку элемента.

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

[virtual] int QStandardItem::type() const

Возвращает тип этого элемента. Тип используется для различения пользовательских элементов от базового класса. При наследовании от QStandardItem вы должны переопределить эту функцию и вернуть новое значение, большее или равное UserType.

См. также QStandardItem::Type.

QString QStandardItem::whatsThis() const

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

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

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

Записывает элемент в поток out. Записываются только данные и флаги элемента, а не дочерние элементы.

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

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

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

По умолчанию используется данные для роли сортировки элемента (см. QStandardItemModel::sortRole) для выполнения сравнения, если элемент принадлежит модели; в противном случае используются данные для роли Qt::DisplayRole (text()) для выполнения сравнения.

sortChildren() и QStandardItemModel::sort() используют эту функцию при сортировке элементов. Если вам нужна пользовательская сортировка, вы можете наследоваться от QStandardItem и переопределить эту функцию.

[protected] QStandardItem &QStandardItem::operator=(const QStandardItem &other)

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

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