Класс QListWidgetItem
Класс QListWidgetItem предоставляет элемент для использования с классом представления элементов QListWidget. Подробнее...
| Заголовок: | #include <QListWidgetItem> |
| CMake: | find_package(Qt6 COMPONENTS Widgets REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Widgets) |
| qmake: | QT += widgets |
Типы публичного доступа
| перечисление | ItemType { Type, UserType } |
Функции публичного доступа
| QListWidgetItem(const QListWidgetItem &other) | |
| QListWidgetItem(const QIcon &icon, const QString &text, QListWidget *parent = nullptr, int type = Type) | |
| QListWidgetItem(const QString &text, QListWidget *parent = nullptr, int type = Type) | |
| QListWidgetItem(QListWidget *parent = nullptr, int type = Type) | |
| QListWidgetItem & | operator=(const QListWidgetItem &other) |
| virtual | ~QListWidgetItem() |
| QBrush | background() const |
| Qt::CheckState | checkState() const |
| virtual QListWidgetItem * | clone() const |
| virtual QVariant | data(int role) const |
| Qt::ItemFlags | flags() const |
| QFont | font() const |
| QBrush | foreground() const |
| QIcon | icon() const |
| bool | isHidden() const |
| bool | isSelected() const |
| QListWidget * | listWidget() const |
| virtual void | read(QDataStream &in) |
| void | setBackground(const QBrush &brush) |
| void | setCheckState(Qt::CheckState state) |
| virtual void | setData(int role, const QVariant &value) |
| void | setFlags(Qt::ItemFlags flags) |
| void | setFont(const QFont &font) |
| void | setForeground(const QBrush &brush) |
| void | setHidden(bool hide) |
| void | setIcon(const QIcon &icon) |
| void | setSelected(bool select) |
| void | setSizeHint(const QSize &size) |
| void | setStatusTip(const QString &statusTip) |
| void | setText(const QString &text) |
| void | setTextAlignment(int alignment) |
| void | setToolTip(const QString &toolTip) |
| void | setWhatsThis(const QString &whatsThis) |
| QSize | sizeHint() const |
| QString | statusTip() const |
| QString | text() const |
| int | textAlignment() const |
| QString | toolTip() const |
| int | type() const |
| QString | whatsThis() const |
| virtual void | write(QDataStream &out) const |
| virtual bool | operator<(const QListWidgetItem &other) const |
Связанные нечлены
| QDataStream & | operator<<(QDataStream &out, const QListWidgetItem &item) |
| QDataStream & | operator>>(QDataStream &in, QListWidgetItem &item) |
Подробное описание
QListWidgetItem представляет собой отдельный элемент в QListWidget. Каждый элемент может содержать несколько фрагментов информации и отображать их соответствующим образом.
Утилитарные классы представления элементов используют классический интерфейс на основе элементов, а не чисто модельно-видовое подхода. Для более гибкого виджета списка используйте класс QListView со стандартной моделью.
Элементы списка могут быть вставлены автоматически в список при их создании, если указать виджет списка:
new QListWidgetItem(tr("Hazel"), listWidget); В качестве альтернативы элементы списка также могут быть созданы без родительского виджета и впоследствии вставлены в список с помощью QListWidget::insertItem().
Элементы списка обычно используются для отображения текста() и иконки(). Они устанавливаются с помощью функций setText() и setIcon(). Внешний вид текста можно настроить с помощью setFont(), setForeground() и setBackground(). Выравнивание текста в элементах списка можно настроить с помощью функции setTextAlignment(). Подсказки, подсказки состояния и подсказки «Что это?» можно добавить к элементам списка с помощью setToolTip(), setStatusTip() и setWhatsThis().
По умолчанию элементы активны, выбираемы, могут быть помечены и могут быть источником операций перетаскивания.
Флаги каждого элемента могут быть изменены вызовом setFlags() с соответствующим значением (см. Qt::ItemFlags). Элементы с возможностью выбора могут быть выбраны, убраны с выбора и частично выбраны с помощью функции setCheckState(). Соответствующая функция checkState() указывает текущее состояние выбора элемента.
Функция isHidden() может быть использована для определения, скрыт ли элемент. Для скрытия элемента используйте setHidden().
Наследование
При наследовании от QListWidgetItem для предоставления пользовательских элементов можно определять новые типы для них, что позволяет отличать их от стандартных элементов. Для подклассов, требующих этой функции, убедитесь, что в конструкторе вызывается конструктор базового класса со значением нового типа, равным или большим, чем UserType, в вашем конструкторе.
См. также QListWidget, Программирование моделей/представлений, QTreeWidgetItem и QTableWidgetItem.
Документация по типам членов
перечисление QListWidgetItem::ItemType
Это перечисление описывает типы, используемые для описания элементов списка.
| Константа | Значение | Описание |
|---|---|---|
QListWidgetItem::Type |
0 |
Типичный тип для элементов списка. |
QListWidgetItem::UserType |
1000 |
Минимальное значение для пользовательских типов. Значения ниже UserType зарезервированы Qt. |
Вы можете определить новые пользовательские типы в подклассах QListWidgetItem, чтобы гарантировать, что пользовательские элементы будут обрабатываться особым образом.
См. также type().
Документация по функциям членов
QListWidgetItem::QListWidgetItem(const QListWidgetItem &other)
Создает копию other. Обратите внимание, что type() и listWidget() не копируются.
Эта функция полезна при переопределении clone().
QListWidgetItem::QListWidgetItem(const QIcon &icon, const QString &text, QListWidget *parent = nullptr, int type = Type)
Создаёт пустой элемент виджета списка указанного type с заданным icon, text и parent. Если родитель не указан, элемент необходимо будет вставить в виджет списка с помощью QListWidget::insertItem().
Этот конструктор вставляет элемент в модель родителя, переданного в конструктор. Если модель отсортирована, поведение вставки не определено, так как модель вызовет метод оператора '<' для элемента, который на этом этапе ещё не создан. Чтобы избежать неопределённого поведения, рекомендуется не указывать родителя и вместо этого использовать QListWidget::insertItem().
См. также type().
QListWidgetItem::QListWidgetItem(const QString &text, QListWidget *parent = nullptr, int type = Type)
Создаёт пустой элемент виджета списка указанного type с заданным text и parent. Если родитель не указан, элемент необходимо будет вставить в виджет списка с помощью QListWidget::insertItem().
Этот конструктор вставляет элемент в модель родителя, переданного в конструктор. Если модель отсортирована, поведение вставки не определено, так как модель вызовет метод оператора '<' для элемента, который на этом этапе ещё не создан. Чтобы избежать неопределённого поведения, рекомендуется не указывать родителя и вместо этого использовать QListWidget::insertItem().
См. также type().
QListWidgetItem::QListWidgetItem(QListWidget *parent = nullptr, int type = Type)
Создаёт пустой элемент виджета списка указанного type с заданным parent. Если parent не указан, элемент необходимо будет вставить в виджет списка с помощью QListWidget::insertItem().
Этот конструктор вставляет элемент в модель родителя, переданного в конструктор. Если модель отсортирована, поведение вставки не определено, так как модель вызовет метод оператора '<' для элемента, который на этом этапе ещё не создан. Чтобы избежать неопределённого поведения, рекомендуется не указывать родителя и вместо этого использовать QListWidget::insertItem().
См. также type().
QListWidgetItem &QListWidgetItem::operator=(const QListWidgetItem &other)
Присваивает данные и флаги other этому элементу. Обратите внимание, что type() и listWidget() не копируются.
Эта функция полезна при переопределении clone().
[virtual] QListWidgetItem::~QListWidgetItem()
Удаляет элемент списка.
QBrush QListWidgetItem::background() const
Возвращает кисть, используемую для отображения фона элемента списка.
См. также setBackground() и foreground().
Qt::CheckState QListWidgetItem::checkState() const
Возвращает состояние выбора элемента списка (см. Qt::CheckState).
См. также setCheckState() и flags().
[virtual] QListWidgetItem *QListWidgetItem::clone() const
Создаёт точную копию элемента.
[virtual] QVariant QListWidgetItem::data(int role) const
Возвращает данные элемента для данного role. Переопределите эту функцию, если вам нужны дополнительные роли или специальное поведение для определённых ролей.
См. также Qt::ItemDataRole и setData().
Qt::ItemFlags QListWidgetItem::flags() const
Возвращает флаги элемента для этого элемента (см. Qt::ItemFlags).
См. также setFlags().
QFont QListWidgetItem::font() const
Возвращает шрифт, используемый для отображения текста этого элемента списка.
См. также setFont().
QBrush QListWidgetItem::foreground() const
Возвращает кисть, используемую для отображения переднего плана элемента списка (например, текста).
См. также setForeground() и background().
QIcon QListWidgetItem::icon() const
Возвращает значок элемента списка.
См. также setIcon() и iconSize.
bool QListWidgetItem::isHidden() const
Возвращает true если элемент скрыт; в противном случае возвращает false.
См. также setHidden().
bool QListWidgetItem::isSelected() const
Возвращает true если элемент выбран; в противном случае возвращает false.
См. также setSelected().
QListWidget *QListWidgetItem::listWidget() const
Возвращает виджет списка, содержащий элемент.
[virtual] void QListWidgetItem::read(QDataStream &in)
Читает элемент из потока in.
См. также write().
void QListWidgetItem::setBackground(const QBrush &brush)
Устанавливает кисть фона элемента списка на заданную brush. Установка кисти по умолчанию позволит представлению использовать цвет по умолчанию из стиля.
См. также background() и setForeground().
void QListWidgetItem::setCheckState(Qt::CheckState state)
Устанавливает состояние выбора элемента списка в state.
См. также checkState().
[virtual] void QListWidgetItem::setData(int role, const QVariant &value)
Устанавливает данные для заданного role в заданное значение. Переопределите эту функцию, если вам нужны дополнительные роли или специальное поведение для определённых ролей.
Примечание: По умолчанию реализация рассматривает Qt::EditRole и Qt::DisplayRole как относящиеся к тем же данным.
См. также Qt::ItemDataRole и data().
void QListWidgetItem::setFlags(Qt::ItemFlags flags)
Устанавливает флаги элемента списка для элемента списка в flags.
См. также flags() и Qt::ItemFlags.
void QListWidgetItem::setFont(const QFont &font)
Устанавливает шрифт, используемый при отрисовке элемента, на заданный шрифт.
См. также font().
void QListWidgetItem::setForeground(const QBrush &brush)
Устанавливает кисть переднего плана элемента списка на заданную brush. Установка кисти, созданной по умолчанию, позволит представлению использовать цвет по умолчанию из стиля.
См. также foreground() и setBackground().
void QListWidgetItem::setHidden(bool hide)
Скрывает элемент, если hide равно true; в противном случае отображает элемент.
См. также isHidden().
void QListWidgetItem::setIcon(const QIcon &icon)
Устанавливает значок для элемента списка на заданный значок.
См. также icon(), text() и iconSize.
void QListWidgetItem::setSelected(bool select)
Устанавливает состояние выделения элемента на select.
См. также isSelected().
void QListWidgetItem::setSizeHint(const QSize &size)
Устанавливает размер подсказки для элемента списка в size. Если размер подсказки не установлен или size недействителен, делегат элемента вычислит размер подсказки на основе данных элемента.
См. также sizeHint().
void QListWidgetItem::setStatusTip(const QString &statusTip)
Устанавливает подсказку состояния для элемента списка на текст, указанный в statusTip. Для работы этой функции необходимо включить отслеживание мыши в QListWidget.
См. также statusTip(), setToolTip(), setWhatsThis() и QWidget::setMouseTracking().
void QListWidgetItem::setText(const QString &text)
Устанавливает текст для элемента списка виджета в заданный текст.
См. также text().
void QListWidgetItem::setTextAlignment(int alignment)
Устанавливает выравнивание текста элемента списка в alignment.
См. также textAlignment() и Qt::AlignmentFlag.
void QListWidgetItem::setToolTip(const QString &toolTip)
Устанавливает всплывающую подсказку для элемента списка на текст, указанный в toolTip.
См. также toolTip(), setStatusTip() и setWhatsThis().
void QListWidgetItem::setWhatsThis(const QString &whatsThis)
Устанавливает помощь "Что это?" для элемента списка на текст, указанный в whatsThis.
См. также whatsThis(), setStatusTip() и setToolTip().
QSize QListWidgetItem::sizeHint() const
Возвращает размер подсказки, установленный для элемента списка.
См. также setSizeHint().
QString QListWidgetItem::statusTip() const
Возвращает подсказку состояния элемента списка.
См. также setStatusTip().
QString QListWidgetItem::text() const
Возвращает текст элемента списка.
См. также setText().
int QListWidgetItem::textAlignment() const
Возвращает выравнивание текста для элемента списка.
См. также setTextAlignment() и Qt::AlignmentFlag.
QString QListWidgetItem::toolTip() const
Возвращает всплывающую подсказку элемента списка.
См. также setToolTip(), statusTip() и whatsThis().
int QListWidgetItem::type() const
Возвращает тип, переданный конструктору QListWidgetItem.
QString QListWidgetItem::whatsThis() const
Возвращает текст справки "Что это?" элемента списка.
См. также setWhatsThis(), statusTip() и toolTip().
[virtual] void QListWidgetItem::write(QDataStream &out) const
Записывает элемент в поток out.
См. также read().
[virtual] bool QListWidgetItem::operator<(const QListWidgetItem &other) const
Возвращает true если текст этого элемента меньше, чем текст элемента other; в противном случае возвращает false.
Связанные нечленные функции
QDataStream &operator<<(QDataStream &out, const QListWidgetItem &item)
Записывает элемент списка item в поток out.
Этот оператор использует QListWidgetItem::write().
См. также Сериализация типов данных Qt.
QDataStream &operator>>(QDataStream &in, QListWidgetItem &item)
Считывает элемент списка из потока in в item.
Этот оператор использует QListWidgetItem::read().
См. также Сериализация типов данных Qt.
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.2/qlistwidgetitem.html