Класс QStandardItem

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

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

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

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

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

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

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

Класс 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(), если вы хотите управлять тем, как элементы представлены в их сериализованной форме.

Переопределите 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), если он задан; в противном случае возвращает 0.

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

[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, к которому принадлежит этот элемент.

Если элемент не является потомком другого элемента, принадлежащего модели, функция возвращает 0.

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

QStandardItem *QStandardItem::parent() const

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

Примечание: Для корневых элементов parent() возвращает 0. Чтобы получить родителя корневого элемента, используйте 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. При необходимости количество строк и столбцов увеличивается для размещения элемента.

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

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

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

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

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

void QStandardItem::setColumnCount(int columns)

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

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

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) без удаления его и возвращает указатель на этот элемент. Если элемента в указанной позиции нет, функция возвращает 0.

Обратите внимание, что эта функция, в отличие от 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().

int QStandardItem::type() const

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

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

QString QStandardItem::whatsThis() const

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

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

void QStandardItem::write(QDataStream &out) const

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

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

bool QStandardItem::operator<(const QStandardItem &other) const

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

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

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

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

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

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