Класс 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) |
| виртуальный | ~QListWidgetItem() |
| QBrush | background() const |
| Qt::CheckState | checkState() const |
| виртуальный QListWidgetItem * | clone() const |
| виртуальный 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 |
| виртуальный void | read(QDataStream &in) |
| void | setBackground(const QBrush &brush) |
| void | setCheckState(Qt::CheckState state) |
| виртуальный 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 |
| виртуальный void | write(QDataStream &out) const |
| виртуальный 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().
Элементы списка обычно используются для отображения text() и icon(). Они устанавливаются с помощью функций 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 со значением value. Переопределите эту функцию, если вам нужны дополнительные роли или специальное поведение для определённых ролей.
Примечание: По умолчанию реализация считает Qt::EditRole и Qt::DisplayRole как ссылку на одни и те же данные.
См. также Qt::ItemDataRole и data().
void QListWidgetItem::setFlags(Qt::ItemFlags flags)
Устанавливает флаги элемента списка для flags.
См. также flags() и Qt::ItemFlags.
void QListWidgetItem::setFont(const QFont &font)
Устанавливает шрифт, используемый при отрисовке элемента, на заданный 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.
См. также 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. Для работы с этой функцией необходимо включить mouseTracking в QListWidget.
См. также statusTip(), setToolTip(), setWhatsThis() и QWidget::setMouseTracking().
void QListWidgetItem::setText(const QString &text)
Устанавливает текст для элемента списка виджета на заданный 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.0/qlistwidgetitem.html