Класс QItemSelectionModel
Класс QItemSelectionModel отслеживает выбранные элементы в представлении. Подробнее...
| Заголовок: | #include <QItemSelectionModel> |
| CMake: | find_package(Qt6 COMPONENTS Core REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Core) |
| qmake: | QT += core |
| Наследуется от: | QObject |
Типы
| Перечисление | SelectionFlag { NoUpdate, Clear, Select, Deselect, Toggle, …, ClearAndSelect } |
| Флаги | SelectionFlags |
Свойства
- selectedIndexes : const QModelIndexList
Публичные функции
| QItemSelectionModel(QAbstractItemModel *model, QObject *parent) | |
| QItemSelectionModel(QAbstractItemModel *model = nullptr) | |
| виртуальный | ~QItemSelectionModel() |
| bool | columnIntersectsSelection(int column, const QModelIndex &parent = QModelIndex()) const |
| QModelIndex | currentIndex() const |
| bool | hasSelection() const |
| bool | isColumnSelected(int column, const QModelIndex &parent = QModelIndex()) const |
| bool | isRowSelected(int row, const QModelIndex &parent = QModelIndex()) const |
| bool | isSelected(const QModelIndex &index) const |
| const QAbstractItemModel * | model() const |
| QAbstractItemModel * | model() |
| bool | rowIntersectsSelection(int row, const QModelIndex &parent = QModelIndex()) const |
| QModelIndexList | selectedColumns(int row = 0) const |
| QModelIndexList | selectedIndexes() const |
| QModelIndexList | selectedRows(int column = 0) const |
| const QItemSelection | selection() const |
| void | setModel(QAbstractItemModel *model) |
Слот
| виртуальный void | clear() |
| виртуальный void | clearCurrentIndex() |
| void | clearSelection() |
| виртуальный void | reset() |
| виртуальный void | select(const QItemSelection &selection, QItemSelectionModel::SelectionFlags command) |
| виртуальный void | select(const QModelIndex &index, QItemSelectionModel::SelectionFlags command) |
| виртуальный void | setCurrentIndex(const QModelIndex &index, QItemSelectionModel::SelectionFlags command) |
Сигналы
| void | currentChanged(const QModelIndex ¤t, const QModelIndex &previous) |
| void | currentColumnChanged(const QModelIndex ¤t, const QModelIndex &previous) |
| void | currentRowChanged(const QModelIndex ¤t, const QModelIndex &previous) |
| void | modelChanged(QAbstractItemModel *model) |
| void | selectionChanged(const QItemSelection &selected, const QItemSelection &deselected) |
Защищенные функции
| void | emitSelectionChanged(const QItemSelection &newSelection, const QItemSelection &oldSelection) |
Подробное описание
QItemSelectionModel отслеживает выбранные элементы в представлении или в нескольких представлениях на одном и том же модели. Он также отслеживает текущий выбранный элемент в представлении.
Класс QItemSelectionModel является одним из классов модели/представления и входит в модель/представление фреймворк Qt.
Выбранные элементы хранятся в виде диапазонов. При необходимости изменения выбранных элементов используйте select(), указав либо QItemSelection, либо QModelIndex и QItemSelectionModel::SelectionFlag.
Класс QItemSelectionModel использует двухслойный подход к управлению выделением, работая как с выбранными элементами, которые были подтверждены, так и с элементами, которые являются частью текущего выделения. Текущие выбранные элементы являются частью текущего интерактивного выделения (например, при выделении резиновой полосой или с помощью клавиши Shift).
Для обновления текущих выбранных элементов используйте побитовое ИЛИ QItemSelectionModel::Current и любые другие SelectionFlags. Если вы опустите QItemSelectionModel::Current, будет создано новое текущее выделение, а предыдущее будет добавлено ко всему выделению. Все функции работают с обоими слоями; например, selecteditems() вернёт элементы из обоих слоёв.
Примечание: Начиная с 5.5, model, hasSelection и currentIndex являются свойствами метаобъекта.
См. также Модели/представление программирование, QAbstractItemModel и Пример графика.
Документация по типу члена
Перечисление QItemSelectionModel::SelectionFlagФлаги QItemSelectionModel::SelectionFlags
Это перечисление описывает способ обновления модели выделения.
| Постоянная | Значение | Описание |
|---|---|---|
QItemSelectionModel::NoUpdate |
0x0000 |
Выбор не будет осуществлён. |
QItemSelectionModel::Clear |
0x0001 |
Выбранный список будет очищен. |
QItemSelectionModel::Select |
0x0002 |
Все указанные индексы будут выбраны. |
QItemSelectionModel::Deselect |
0x0004 |
Все указанные индексы будут сняты с выбора. |
QItemSelectionModel::Toggle |
0x0008 |
Все указанные индексы будут выбраны или сняты с выбора в зависимости от их текущего состояния. |
QItemSelectionModel::Current |
0x0010 |
Текущий выбор будет обновлён. |
QItemSelectionModel::Rows |
0x0020 |
Все индексы будут развернуты для охвата строк. |
QItemSelectionModel::Columns |
0x0040 |
Все индексы будут развернуты для охвата столбцов. |
QItemSelectionModel::SelectCurrent |
Select | Current |
Комбинация Select и Current для удобства. |
QItemSelectionModel::ToggleCurrent |
Toggle | Current |
Комбинация Toggle и Current для удобства. |
QItemSelectionModel::ClearAndSelect |
Clear | Select |
Комбинация Clear и Select для удобства. |
Тип SelectionFlags — это псевдоним для QFlags<SelectionFlag>. Он хранит логическое ИЛИ комбинацию значений SelectionFlag.
Документация по свойствам
[read-only, since 5.5] selectedIndexes : const QModelIndexList
Это свойство было добавлено в Qt 5.5.
Функции доступа:
| QModelIndexList | selectedIndexes() const |
Сигнал уведомления:
| void | selectionChanged(const QItemSelection &selected, const QItemSelection &deselected) |
Документация по функциям-членам
QItemSelectionModel::QItemSelectionModel(QAbstractItemModel *model, QObject *parent)
Создаёт модель выбора, которая работает с указанной моделью элементов model с parent.
QItemSelectionModel::QItemSelectionModel(QAbstractItemModel *model = nullptr)
Создаёт модель выбора, которая работает с указанной моделью элементов model.
[virtual slot] void QItemSelectionModel::clear()
Очищает модель выбора. Издаёт selectionChanged() и currentChanged().
[virtual slot] void QItemSelectionModel::clearCurrentIndex()
Очищает текущий индекс. Издаёт currentChanged().
[slot] void QItemSelectionModel::clearSelection()
Очищает выбор в модели выбора. Издаёт selectionChanged().
[signal] void QItemSelectionModel::currentChanged(const QModelIndex ¤t, const QModelIndex &previous)
Этот сигнал издаётся всякий раз, когда текущий элемент изменяется. Предыдущий индекс модели элемента заменяется текущим индексом в качестве текущего элемента выбора.
Обратите внимание, что этот сигнал не будет издан при перезагрузке модели элементов.
См. также currentIndex(), setCurrentIndex() и selectionChanged().
[signal] void QItemSelectionModel::currentColumnChanged(const QModelIndex ¤t, const QModelIndex &previous)
Этот сигнал издаётся, если текущий элемент изменяется, и его столбец отличается от столбца предыдущего текущего элемента.
Обратите внимание, что этот сигнал не будет издан при перезагрузке модели элементов.
См. также currentChanged(), currentRowChanged(), currentIndex() и setCurrentIndex().
[signal] void QItemSelectionModel::currentRowChanged(const QModelIndex ¤t, const QModelIndex &previous)
Этот сигнал издаётся, если текущий элемент изменяется, и его строка отличается от строки предыдущего текущего элемента.
Обратите внимание, что этот сигнал не будет издан при перезагрузке модели элементов.
См. также currentChanged(), currentColumnChanged(), currentIndex() и setCurrentIndex().
[signal, since 5.5] void QItemSelectionModel::modelChanged(QAbstractItemModel *model)
Этот сигнал издаётся, когда модель model успешно установлена с помощью setModel().
Эта функция была добавлена в Qt 5.5.
См. также model() и setModel().
[virtual slot] void QItemSelectionModel::reset()
Очищает модель выбора. Не издаёт никаких сигналов.
[virtual slot] void QItemSelectionModel::select(const QItemSelection &selection, QItemSelectionModel::SelectionFlags command)
Выбирает элемент selection, используя указанную command, и издаёт selectionChanged().
См. также QItemSelectionModel::SelectionFlag.
[virtual slot] void QItemSelectionModel::select(const QModelIndex &index, QItemSelectionModel::SelectionFlags command)
Выбирает элемент модели index, используя указанную command, и издаёт selectionChanged().
См. также QItemSelectionModel::SelectionFlags.
[signal] void QItemSelectionModel::selectionChanged(const QItemSelection &selected, const QItemSelection &deselected)
Этот сигнал издаётся всякий раз, когда выбор изменяется. Изменение выбора представлено как выбор элементов deselected и выбор элементов selected.
Обратите внимание, что текущий индекс изменяется независимо от выбора. Также обратите внимание, что этот сигнал не будет издан при перезагрузке модели элементов.
Примечание: Сигнал уведомления для свойства selectedIndexes.
См. также select() и currentChanged().
[virtual slot] void QItemSelectionModel::setCurrentIndex(const QModelIndex &index, QItemSelectionModel::SelectionFlags command)
Устанавливает элемент модели index в качестве текущего элемента и издаёт currentChanged(). Текущий элемент используется для навигации с помощью клавиатуры и индикации фокуса; он независим от любых выбранных элементов, хотя выбранный элемент также может быть текущим.
В зависимости от указанной command, index также может стать частью текущего выбора.
См. также currentIndex() и select().
[virtual] QItemSelectionModel::~QItemSelectionModel()
Удаляет модель выбора.
bool QItemSelectionModel::columnIntersectsSelection(int column, const QModelIndex &parent = QModelIndex()) const
Возвращает true если в столбце с заданным родительским элементом выбраны какие-либо элементы.
Примечание: Начиная с Qt 5.15, значение по умолчанию для parent — пустой индекс модели.
Примечание: Данную функцию можно вызвать через систему метаобъектов и из QML. См. Q_INVOKABLE.
QModelIndex QItemSelectionModel::currentIndex() const
Возвращает индекс элемента модели для текущего элемента или недействительный индекс, если текущего элемента нет.
См. также setCurrentIndex().
[protected] void QItemSelectionModel::emitSelectionChanged(const QItemSelection &newSelection, const QItemSelection &oldSelection)
Сравнивает два выделения newSelection и oldSelection и излучает selectionChanged() со значениями для невыбранных и выбранных элементов.
bool QItemSelectionModel::hasSelection() const
Возвращает true если модель выделения содержит какие-либо диапазоны выделения; в противном случае возвращает false.
bool QItemSelectionModel::isColumnSelected(int column, const QModelIndex &parent = QModelIndex()) const
Возвращает true если все элементы выделены в столбце с заданным родительским элементом.
Обратите внимание, что эта функция обычно быстрее, чем вызов isSelected() для всех элементов в том же столбце, и что невыбираемые элементы игнорируются.
Примечание: Начиная с Qt 5.15, значение по умолчанию для parent — пустой индекс модели.
Примечание: Данную функцию можно вызвать через систему метаобъектов и из QML. См. Q_INVOKABLE.
bool QItemSelectionModel::isRowSelected(int row, const QModelIndex &parent = QModelIndex()) const
Возвращает true если все элементы выделены в строке с заданным родительским элементом.
Обратите внимание, что эта функция обычно быстрее, чем вызов isSelected() для всех элементов в той же строке, и что невыбираемые элементы игнорируются.
Примечание: Начиная с Qt 5.15, значение по умолчанию для parent — пустой индекс модели.
Примечание: Данную функцию можно вызвать через систему метаобъектов и из QML. См. Q_INVOKABLE.
bool QItemSelectionModel::isSelected(const QModelIndex &index) const
Возвращает true если заданный индекс элемента модели index выбран.
Примечание: Данную функцию можно вызвать через систему метаобъектов и из QML. См. Q_INVOKABLE.
const QAbstractItemModel *QItemSelectionModel::model() const
Возвращает модель элементов, на которой работает модель выделения.
См. также setModel().
[since 5.5] QAbstractItemModel *QItemSelectionModel::model()
Возвращает модель элементов, на которой работает модель выделения.
Эта функция была добавлена в Qt 5.5.
bool QItemSelectionModel::rowIntersectsSelection(int row, const QModelIndex &parent = QModelIndex()) const
Возвращает true если в строке с заданным родительским элементом выбраны какие-либо элементы.
Примечание: Начиная с Qt 5.15, значение по умолчанию для parent — пустой индекс модели.
Примечание: Данную функцию можно вызвать через систему метаобъектов и из QML. См. Q_INVOKABLE.
QModelIndexList QItemSelectionModel::selectedColumns(int row = 0) const
Возвращает индексы в заданной строке для столбцов, где все строки выбраны.
Примечание: Данную функцию можно вызвать через систему метаобъектов и из QML. См. Q_INVOKABLE.
См. также selectedIndexes() и selectedRows().
QModelIndexList QItemSelectionModel::selectedIndexes() const
Возвращает список всех индексов выбранных элементов модели. Список не содержит дубликатов и не отсортирован.
Примечание: Функция-получатель для свойства selectedIndexes.
QModelIndexList QItemSelectionModel::selectedRows(int column = 0) const
Возвращает индексы в заданном столбце для строк, где все столбцы выбраны.
Примечание: Данную функцию можно вызвать через систему метаобъектов и из QML. См. Q_INVOKABLE.
См. также selectedIndexes() и selectedColumns().
const QItemSelection QItemSelectionModel::selection() const
Возвращает диапазоны выделения, хранящиеся в модели выделения.
[since 5.5] void QItemSelectionModel::setModel(QAbstractItemModel *model)
Устанавливает модель в model. Сигнал modelChanged() будет излучен.
Эта функция была добавлена в Qt 5.5.
См. также model() и modelChanged().
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.0/qitemselectionmodel.html