Класс QStandardItem

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

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

Открытые типы

Открытые функции

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

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

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

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

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

По умолчанию элементы включены, редактируемы, выбираемы, могут содержать флажки и могут использоваться как источник, так и цель перетаскивания. Флаги каждого элемента можно изменить, вызвав setFlags(). Элементы, которые могут содержать флажки, могут быть отмечены и отмечены с помощью функции setCheckState(). Соответствующая функция checkState() указывает, отмечен ли элемент в данный момент.

Вы можете хранить данные, специфичные для приложения, в элементе, вызвав setData().

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

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

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

Дочерние элементы элемента можно отсортировать, вызвав sortChildren().

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Создаёт элемент с заданным icon и text.

QStandardItem::QStandardItem(const QString &text)

Создаёт элемент с заданным text.

QStandardItem::QStandardItem()

Создаёт элемент.

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

Присваивает данные и флаги other данному элементу. Обратите внимание, что type() и 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().

[since 5.12] 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, если данных для роли нет.

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

[protected] void QStandardItem::emitDataChanged()

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

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

См. также 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().

[since 5.6] 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().

[since 5.6] bool QStandardItem::isUserTristate() const

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

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

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

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

QStandardItemModel *QStandardItem::model() const

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

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

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

[virtual, since 6.0] void QStandardItem::multiData(QModelRoleDataSpan roleDataSpan) const

Заполняет область roleDataSpan данными из этого элемента.

Реализация по умолчанию просто вызывает data() для каждого роли в области.

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

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

QStandardItem *QStandardItem::parent() const

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

См. также 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().

[since 5.6] 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. При необходимости количество строк и столбцов увеличивается для размещения элемента.

См. также 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::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().

[since 5.6] 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 без удаления элементов столбца и возвращает список указателей на удаленные элементы. Для элементов в столбце, которые не были установлены, соответствующие указатели в списке будут nullptr.

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

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

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

См. также 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 и переопределить эту функцию.