Класс QListWidget

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

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

Свойства

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

• 13 свойств, унаследованных от QListView
• 16 свойств, унаследованных от QAbstractItemView
• 3 свойства, унаследованных от QAbstractScrollArea
• 6 свойств, унаследованных от QFrame
• 59 свойств, унаследованных от QWidget
• 1 свойство, унаследованное от QObject

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

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

• 32 открытых функции, унаследованные от QListView
• 59 открытых функций, унаследованных от QAbstractItemView
• 20 открытых функций, унаследованных от QAbstractScrollArea
• 14 открытых функций, унаследованных от QFrame
• 214 открытых функций, унаследованных от QWidget
• 32 открытых функции, унаследованные от QObject
• 14 открытых функций, унаследованных от QPaintDevice

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

• 9 открытых слотов, унаследованных от QAbstractItemView
• 19 открытых слотов, унаследованных от QWidget
• 1 открытый слот, унаследованный от QObject

Сигналы

• 1 сигнал унаследован от QListView
• 7 сигналов унаследованных от QAbstractItemView
• 3 сигнала унаследованных от QWidget
• 2 сигнала унаследованных от QObject

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

Переопределённые защищённые функции

• 28 защищённых функций унаследованных от QListView
• 37 защищённых функций унаследованных от QAbstractItemView
• 20 защищённых функций унаследованных от QAbstractScrollArea
• 4 защищённых функций унаследованных от QFrame
• 35 защищённых функций унаследованных от QWidget
• 9 защищённых функций унаследованных от QObject
• 1 защищённая функция унаследованная от QPaintDevice

Дополнительные унаследованные члены

• 5 статических публичных членов унаследованных от QWidget
• 11 статических публичных членов унаследованных от QObject
• 9 защищённых слотов унаследованных от QAbstractItemView
• 1 защищённый слот унаследованный от QWidget

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

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

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 = Q_NULLPTR)

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

QListWidget::~QListWidget()

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

void QListWidget::addItem(const QString &label)

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

void QListWidget::addItem(QListWidgetItem *item)

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

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

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

void QListWidget::addItems(const QStringList &labels)

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

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

[slot] void QListWidget::clear()

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

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

void QListWidget::closePersistentEditor(QListWidgetItem *item)

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

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

QListWidgetItem *QListWidget::currentItem() const

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

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

[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 недействителен.

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

Переопределено из QWidget::dropEvent().

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

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

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

void QListWidget::editItem(QListWidgetItem *item)

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

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

Переопределено из QObject::event().

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

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

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

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

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

Вставляет элемент в позицию в списке, заданную строкой.

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

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

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

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

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

Вставляет элементы из списка labels в список, начиная с указанной строки.

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

QListWidgetItem *QListWidget::item(int row) const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[signal] void QListWidget::itemSelectionChanged()

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

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

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().

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

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

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

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

void QListWidget::openPersistentEditor(QListWidgetItem *item)

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

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

void QListWidget::removeItemWidget(QListWidgetItem *item)

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

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

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

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

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

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

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

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

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

hint определяет, где должен располагаться элемент 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 и подкласс QItemDelegate вместо этого.

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

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

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

Переопределено из QAbstractItemView::setSelectionModel().

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

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

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

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

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

QListWidgetItem *QListWidget::takeItem(int row)

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

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

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

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

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