Класс QListWidget

Класс QListWidget предоставляет виджет списка на основе элементов. Подробнее...

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

Свойства

• count : const int
• currentRow : int
• sortingEnabled : bool

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

Переопределённые открытые функции

Открытые слоты

Сигналы

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

Реализованные защищённые функции

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

QListWidget — это удобный класс, предоставляющий вид списка, аналогичный тому, что предоставляет QListView, но с классическим интерфейсом на основе элементов для добавления и удаления элементов. QListWidget использует внутреннюю модель для управления каждым элементом QListWidgetItem в списке.

Для более гибкого виджета списка используйте класс QListView со стандартной моделью.

Список виджетов создаётся так же, как и другие виджеты:

    QListWidget *listWidget = new QListWidget(this);

Режим выбора (selectionMode()) виджета списка определяет, сколько элементов в списке можно выбрать одновременно и можно ли создавать сложные выборки элементов. Это можно установить с помощью функции setSelectionMode().

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

    new QListWidgetItem(tr("Oak"), listWidget);
    new QListWidgetItem(tr("Fir"), listWidget);
    new QListWidgetItem(tr("Pine"), listWidget);

Если вам нужно вставить новый элемент в список в определённой позиции, то он должен быть создан без родительского виджета. Затем для размещения его в списке необходимо использовать функцию insertItem(). Виджет списка возьмёт на себя владение элементом.

    QListWidgetItem *newItem = new QListWidgetItem;
    newItem->setText(itemText);
    listWidget->insertItem(row, newItem);

Для нескольких элементов вместо этого можно использовать insertItems(). Количество элементов в списке определяется функцией count(). Для удаления элементов из списка используйте takeItem().

Текущий элемент в списке можно найти с помощью currentItem(), и изменить с помощью setCurrentItem(). Пользователь также может изменить текущий элемент, перемещаясь с помощью клавиатуры или нажимая на другой элемент. Когда текущий элемент изменяется, с новым текущим элементом и элементом, который был текущим ранее, генерируется сигнал currentItemChanged().

См. также QListWidgetItem, QListView, QTreeView, Модель/Представление Программирование и Пример диалога вкладки.

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

QListWidget::QListWidget(QWidget *parent = nullptr)

Конструирует пустой QListWidget с заданным parent.

[slot] void QListWidget::clear()

Удаляет все элементы и выделения в представлении.

Предупреждение: Все элементы будут навсегда удалены.

[signal] void QListWidget::currentItemChanged(QListWidgetItem *current, QListWidgetItem *previous)

Этот сигнал генерируется всякий раз, когда меняется текущий элемент.

previous — элемент, который ранее имел фокус; current — новый текущий элемент.

[signal] void QListWidget::currentRowChanged(int currentRow)

Этот сигнал генерируется всякий раз, когда меняется текущий элемент.

currentRow — строка текущего элемента. Если текущего элемента нет, currentRow равно -1.

Примечание: Сигнал-уведомление для свойства currentRow.

[signal] void QListWidget::currentTextChanged(const QString &currentText)

Этот сигнал генерируется всякий раз, когда меняется текущий элемент.

currentText — текстовые данные в текущем элементе. Если текущего элемента нет, currentText недействительно.

[signal] void QListWidget::itemActivated(QListWidgetItem *item)

Этот сигнал генерируется, когда элемент item активируется. Элемент item активируется, когда пользователь нажимает или дважды нажимает на него, в зависимости от конфигурации системы. Он также активируется, когда пользователь нажимает клавишу активации (в Windows и X11 это клавиша Возврат, в Mac OS X — Command+O).

[signal] void QListWidget::itemChanged(QListWidgetItem *item)

Этот сигнал генерируется всякий раз, когда данные элемента item изменяются.

[signal] void QListWidget::itemClicked(QListWidgetItem *item)

Этот сигнал генерируется с указанным элементом item, когда кнопка мыши нажимается на элемент в виджете.

См. также itemPressed() и itemDoubleClicked().

[signal] void QListWidget::itemDoubleClicked(QListWidgetItem *item)

Этот сигнал генерируется с указанным элементом item, когда кнопка мыши дважды нажимается на элемент в виджете.

См. также itemClicked() и itemPressed().

[signal] void QListWidget::itemEntered(QListWidgetItem *item)

Этот сигнал генерируется, когда указатель мыши входит в элемент. Элемент item — это введённый элемент. Этот сигнал генерируется только при включенном отслеживании мыши (mouseTracking) или при нажатии кнопки мыши при перемещении в элемент.

См. также QWidget::setMouseTracking().

[signal] void QListWidget::itemPressed(QListWidgetItem *item)

Этот сигнал генерируется с указанным элементом item, когда кнопка мыши нажимается на элемент в виджете.

См. также itemClicked() и itemDoubleClicked().

[signal] void QListWidget::itemSelectionChanged()

Этот сигнал излучается всякий раз, когда изменяется выделение.

См. также selectedItems(), QListWidgetItem::isSelected() и currentItemChanged().

[slot] void QListWidget::scrollToItem(const QListWidgetItem *item, QAbstractItemView::ScrollHint hint = EnsureVisible)

Прокручивает представление при необходимости, чтобы обеспечить видимость item.

hint указывает, где item должен находиться после операции.

[virtual] QListWidget::~QListWidget()

Удаляет виджет списка и все его элементы.

void QListWidget::addItem(const QString &label)

Вставляет элемент с текстом label в конец виджета списка.

void QListWidget::addItem(QListWidgetItem *item)

Вставляет item в конец виджета списка.

Предупреждение: QListWidgetItem может быть добавлен в QListWidget только один раз. Добавление одного и того же QListWidgetItem несколько раз в QListWidget приведёт к неопределённому поведению.

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

void QListWidget::addItems(const QStringList &labels)

Вставляет элементы с текстом labels в конец виджета списка.

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

void QListWidget::closePersistentEditor(QListWidgetItem *item)

Закрывает постоянный редактор для данного item.

См. также openPersistentEditor() и isPersistentEditorOpen().

QListWidgetItem *QListWidget::currentItem() const

Возвращает текущий элемент.

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

[override virtual] void QListWidget::dropEvent(QDropEvent *event)

Переопределяет: QListView::dropEvent(QDropEvent *e).

[virtual protected] bool QListWidget::dropMimeData(int index, const QMimeData *data, Qt::DropAction action)

Обрабатывает data, предоставленные внешней операцией перетаскивания, которая закончилась заданным action в данном index. Возвращает true если data и action могут быть обработаны моделью; в противном случае возвращает false.

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

void QListWidget::editItem(QListWidgetItem *item)

Начинает редактирование item, если он редактируемый.

[override virtual protected] bool QListWidget::event(QEvent *e)

Переопределяет: QListView::event(QEvent *e).

QList<QListWidgetItem *> QListWidget::findItems(const QString &text, Qt::MatchFlags flags) const

Ищет элементы с текстом, соответствующим строке text, используя заданные flags.

[protected] QModelIndex QListWidget::indexFromItem(const QListWidgetItem *item) const

Возвращает QModelIndex, связанную с данным item.

Примечание: В версиях Qt до 5.10 эта функция принимала не-const item.

void QListWidget::insertItem(int row, QListWidgetItem *item)

Вставляет item в позицию в списке, задаваемую row.

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

void QListWidget::insertItem(int row, const QString &label)

Вставляет элемент с текстом label в виджет списка в позиции, задаваемой row.

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

void QListWidget::insertItems(int row, const QStringList &labels)

Вставляет элементы из списка labels в список, начиная с заданного row.

См. также insertItem() и addItem().

bool QListWidget::isPersistentEditorOpen(QListWidgetItem *item) const

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

Эта функция была введена в Qt 5.10.

См. также openPersistentEditor() и closePersistentEditor().

QListWidgetItem *QListWidget::item(int row) const

Возвращает элемент, занимающий данную row в списке, если он задан; в противном случае возвращает nullptr.

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

QListWidgetItem *QListWidget::itemAt(const QPoint &p) const

Возвращает указатель на элемент в координатах p. Координаты относительны к области просмотра виджета списка viewport().

QListWidgetItem *QListWidget::itemAt(int x, int y) const

Это перегруженная функция.

Возвращает указатель на элемент в координатах (x, y). Координаты относительны к области просмотра виджета списка viewport().

[protected] QListWidgetItem *QListWidget::itemFromIndex(const QModelIndex &index) const

Возвращает указатель на QListWidgetItem, связанный с данной index.

QWidget *QListWidget::itemWidget(QListWidgetItem *item) const

Возвращает виджет, отображаемый в данном item.

Эта функция была введена в Qt 4.1.

См. также setItemWidget() и removeItemWidget().

[protected] QList<QListWidgetItem *> QListWidget::items(const QMimeData *data) const

Возвращает список указателей на элементы, содержащиеся в объекте data. Если объект не был создан QListWidget в том же процессе, список пуст.

[virtual protected] QMimeData *QListWidget::mimeData(const QList<QListWidgetItem *> items) const

Возвращает объект, содержащий сериализованное описание указанных items. Формат описания элементов получен из функции mimeTypes().

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

[virtual protected] QStringList QListWidget::mimeTypes() const

Возвращает список MIME-типов, которые могут использоваться для описания списка элементов виджета списка.

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

void QListWidget::openPersistentEditor(QListWidgetItem *item)

Открывает редактор для данного item. Редактор остаётся открытым после редактирования.

См. также closePersistentEditor() и isPersistentEditorOpen().

void QListWidget::removeItemWidget(QListWidgetItem *item)

Удаляет виджет, установленный для данного элемента item.

Чтобы полностью удалить элемент (строку) из списка, удалите сам элемент или используйте takeItem().

Эта функция была добавлена в Qt 4.3.

См. также itemWidget() и setItemWidget().

int QListWidget::row(const QListWidgetItem *item) const

Возвращает строку, содержащую данный элемент item.

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

QList<QListWidgetItem *> QListWidget::selectedItems() const

Возвращает список всех выделенных элементов в списке.

void QListWidget::setCurrentItem(QListWidgetItem *item)

Устанавливает текущий элемент в item.

Если режим выбора не NoSelection, элемент также будет выделен.

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

void QListWidget::setCurrentItem(QListWidgetItem *item, QItemSelectionModel::SelectionFlags command)

Устанавливает текущий элемент в item, используя заданную command.

Эта функция была добавлена в Qt 4.4.

void QListWidget::setCurrentRow(int row, QItemSelectionModel::SelectionFlags command)

Устанавливает текущую строку в заданную row, используя заданную command.

Эта функция была добавлена в Qt 4.4.

Примечание: Функция-сеттер для свойства currentRow.

void QListWidget::setItemWidget(QListWidgetItem *item, QWidget *widget)

Устанавливает widget для отображения в данном элементе item.

Эта функция должна использоваться только для отображения статического содержимого вместо элемента списка. Если вы хотите отображать динамическое пользовательское содержимое или реализовывать пользовательский редактор виджета, используйте QListView и подкласс QStyledItemDelegate вместо этого.

Эта функция была добавлена в Qt 4.1.

См. также itemWidget(), removeItemWidget(), и Классы-делегаты.

void QListWidget::setSelectionModel(QItemSelectionModel *selectionModel)

Реализует: QAbstractItemView::setSelectionModel(QItemSelectionModel *selectionModel).

void QListWidget::sortItems(Qt::SortOrder order = Qt::AscendingOrder)

Сортирует все элементы в списке в соответствии с указанным order.

Qt::DropActions QListWidget::supportedDropActions() const

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

См. также Qt::DropActions.

QListWidgetItem *QListWidget::takeItem(int row)

Удаляет и возвращает элемент из заданной row в списке; в противном случае возвращает значение NULL.

Элементы, удаленные из списка, не будут управляться Qt и должны быть удалены вручную.

См. также insertItem() и addItem().

QRect QListWidget::visualItemRect(const QListWidgetItem *item) const

Возвращает прямоугольник на области просмотра, занимаемый элементом item.