Класс 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 это клавиша Return, в 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 *event).

[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.

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

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

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

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

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

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

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

[override virtual] void QListWidget::setSelectionModel(QItemSelectionModel *selectionModel)

Переопределяет: QAbstractItemView::setSelectionModel(QItemSelectionModel *selectionModel).

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

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

[virtual protected] Qt::DropActions QListWidget::supportedDropActions() const

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

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

QListWidgetItem *QListWidget::takeItem(int row)

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

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

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

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

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