Класс QListWidgetItem
Класс QListWidgetItem предоставляет элемент для использования с классом представления элементов QListWidget. Подробнее...
| Заголовок: | #include <QListWidgetItem> |
| qmake: | QT += widgets |
Типы public
| перечисление | ItemType { Type, UserType } |
Функции public
| QListWidgetItem(QListWidget *parent = nullptr, int type = Type) | |
| QListWidgetItem(const QString &text, QListWidget *parent = nullptr, int type = Type) | |
| QListWidgetItem(const QIcon &icon, const QString &text, QListWidget *parent = nullptr, int type = Type) | |
| QListWidgetItem(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 |
| QListWidgetItem & | operator=(const QListWidgetItem &other) |
Связанные нечлены
| QDataStream & | operator<<(QDataStream &out, const QListWidgetItem &item) |
| QDataStream & | operator>>(QDataStream &in, QListWidgetItem &item) |
Подробное описание
Класс QListWidgetItem предоставляет элемент для использования с классом представления элементов QListWidget.
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(QListWidget *parent = nullptr, int type = Type)
Создает пустой элемент виджета списка указанного type с заданным parent. Если 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(const QIcon &icon, const QString &text, QListWidget *parent = nullptr, int type = Type)
Создает пустой элемент виджета списка заданного type с заданным icon, text и parent. Если родитель не указан, элемент необходимо вставить в виджет списка с помощью QListWidget::insertItem().
Этот конструктор вставляет элемент в модель родителя, переданного в конструктор. Если модель отсортирована, поведение вставки неопределено, поскольку модель вызовет метод '<' оператора на элементе, который на данном этапе еще не построен. Чтобы избежать неопределённого поведения, рекомендуется не указывать родителя и вместо этого использовать QListWidget::insertItem().
См. также type().
QListWidgetItem::QListWidgetItem(const QListWidgetItem &other)
Создает копию other. Обратите внимание, что type() и listWidget() не копируются.
Эта функция полезна при переопределении clone().
Эта функция была введена в Qt 4.1.
[virtual] QListWidgetItem::~QListWidgetItem()
Удаляет элемент списка.
QBrush QListWidgetItem::background() const
Возвращает кисть, используемую для отображения фона элемента списка.
Эта функция была введена в Qt 4.2.
См. также 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
Возвращает кисть, используемую для отображения переднего плана элемента списка (например, текста).
Эта функция была введена в Qt 4.2.
См. также setForeground() и background().
QIcon QListWidgetItem::icon() const
Возвращает значок элемента списка.
См. также setIcon() и iconSize.
bool QListWidgetItem::isHidden() const
Возвращает true если элемент скрыт; в противном случае возвращает false.
Эта функция была введена в Qt 4.2.
См. также setHidden().
bool QListWidgetItem::isSelected() const
Возвращает true если элемент выбран; в противном случае возвращает false.
Эта функция была введена в Qt 4.2.
См. также setSelected().
QListWidget *QListWidgetItem::listWidget() const
Возвращает виджет списка, содержащий элемент.
[virtual] void QListWidgetItem::read(QDataStream &in)
Считывает элемент из потока in.
См. также write().
void QListWidgetItem::setBackground(const QBrush &brush)
Устанавливает кисть фона элемента списка заданной brush.
Эта функция была введена в Qt 4.2.
См. также 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.
Эта функция была добавлена в Qt 4.2.
См. также foreground() и setBackground().
void QListWidgetItem::setHidden(bool hide)
Скрывает элемент, если hide равно true; в противном случае отображает элемент.
Эта функция была добавлена в Qt 4.2.
См. также isHidden().
void QListWidgetItem::setIcon(const QIcon &icon)
Устанавливает значок для элемента списка на заданный icon.
См. также icon(), text() и iconSize.
void QListWidgetItem::setSelected(bool select)
Устанавливает выбранное состояние элемента на select.
Эта функция была добавлена в Qt 4.2.
См. также isSelected().
void QListWidgetItem::setSizeHint(const QSize &size)
Устанавливает подсказку размера для элемента списка на size. Если подсказка размера не задана, делегат элемента вычислит подсказку размера на основе данных элемента.
Эта функция была добавлена в Qt 4.1.
См. также sizeHint().
void QListWidgetItem::setStatusTip(const QString &statusTip)
Устанавливает подсказку состояния для элемента списка на текст, указанный в statusTip. Для работы этой функции необходимо включить отслеживание мыши 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
Возвращает подсказку размера, установленную для элемента списка.
Эта функция была добавлена в Qt 4.1.
См. также 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().
void QListWidgetItem::write(QDataStream &out) const
Записывает элемент в поток out.
См. также read().
bool QListWidgetItem::operator<(const QListWidgetItem &other) const
Возвращает true, если текст этого элемента меньше, чем текст элемента other; в противном случае возвращает false.
QListWidgetItem &QListWidgetItem::operator=(const QListWidgetItem &other)
Присваивает данные и флаги other этому элементу. Обратите внимание, что type() и listWidget() не копируются.
Эта функция полезна при переопределении clone().
Связанные нечленные функции
QDataStream &operator<<(QDataStream &out, const QListWidgetItem &item)
Записывает элемент списка item в поток out.
Этот оператор использует QListWidgetItem::write().
См. также Сериализация типов данных Qt.
QDataStream &operator>>(QDataStream &in, QListWidgetItem &item)
Считывает элемент списка из потока in в item.
Этот оператор использует QListWidgetItem::read().
См. также Сериализация типов данных Qt.