Класс 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() и Классы делегата.

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