Класс QAbstractItemDelegate

Класс QAbstractItemDelegate используется для отображения и редактирования элементов данных из модели. Подробнее...

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

Типы публичного доступа

Функции публичного доступа

Сигналы

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

Класс QAbstractItemDelegate предоставляет интерфейс и общие функции для делегатов в архитектуре модель/представление. Делегаты отображают отдельные элементы в представлениях и обрабатывают редактирование данных модели.

Класс QAbstractItemDelegate является одним из классов модели/представления и входит в фреймворк модели/представления Qt.

Для рендеринга элемента особым способом необходимо реализовать paint() и sizeHint(). Класс QStyledItemDelegate предоставляет стандартные реализации этих функций; если не требуется кастомизированный рендеринг, следует наследоваться от этого класса.

Приведём пример рисования полосы прогресса в элементах; в данном случае для программы управления пакетами.

Создаём класс WidgetDelegate, который наследуется от QStyledItemDelegate. Рисование выполняется в функции paint():

void WidgetDelegate::paint(QPainter *painter, const QStyleOptionViewItem &option,
                           const QModelIndex &index) const
{
    if (index.column() == 1) {
        int progress = index.data().toInt();

        QStyleOptionProgressBar progressBarOption;
        progressBarOption.rect = option.rect;
        progressBarOption.minimum = 0;
        progressBarOption.maximum = 100;
        progressBarOption.progress = progress;
        progressBarOption.text = QString::number(progress) + "%";
        progressBarOption.textVisible = true;

        QApplication::style()->drawControl(QStyle::CE_ProgressBar,
                                           &progressBarOption, painter);
    } else
        QStyledItemDelegate::paint(painter, option, index);

Обратите внимание, что мы используем QStyleOptionProgressBar и инициализируем её члены. Затем мы можем использовать текущий QStyle для рисования.

Для предоставления пользовательского редактирования можно использовать два подхода. Первый подход заключается в создании виджета редактора и его отображении непосредственно поверх элемента. Для этого необходимо переопределить createEditor() для предоставления виджета редактора, setEditorData() для заполнения редактора данными из модели и setModelData() для обновления модели данными из редактора.

Второй подход заключается в непосредственной обработке событий пользователя, переопределяя editorEvent().

См. также Модель/Представление программирование, QStyledItemDelegate, Пример Pixelator, QStyledItemDelegate и QStyle.

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

Перечисление QAbstractItemDelegate::EndEditHint

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

Эти подсказки позволяют делегату влиять на поведение представления:

Обратите внимание, что пользовательские представления могут интерпретировать понятия «следующий» и «предыдущий» по-своему.

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

Хотя модели и представления должны реагировать на эти подсказки соответствующим образом, пользовательские компоненты могут игнорировать любые или все из них, если они не имеют отношения.

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

QAbstractItemDelegate::QAbstractItemDelegate(QObject *parent = nullptr)

Создаёт новый делегат абстрактного элемента с заданным parent.

Закрытие редактораvoid QAbstractItemDelegate::closeEditor(QWidget *editor, QAbstractItemDelegate::EndEditHint hint = NoHint)

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

hint предоставляет способ для делегата влиять на поведение модели и представления после завершения редактирования. Он указывает этим компонентам, какое действие должно быть выполнено далее, чтобы обеспечить комфортный опыт редактирования для пользователя. Например, если EditNextItem указано, представление должно использовать делегат для открытия редактора следующего элемента в модели.

См. также EndEditHint.

Подтвердить данныеvoid QAbstractItemDelegate::commitData(QWidget *editor)

Этот сигнал должен быть испущен, когда виджет editor завершил редактирование данных и хочет записать их обратно в модель.

[signal] void QAbstractItemDelegate::sizeHintChanged(const QModelIndex &index)

Этот сигнал должен быть испущен, когда свойство sizeHint() для index изменилось.

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

[virtual] QAbstractItemDelegate::~QAbstractItemDelegate()

Уничтожает делегат абстрактного элемента.

[virtual] QWidget *QAbstractItemDelegate::createEditor(QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index) const

Возвращает редактор, который будет использоваться для редактирования элемента данных с заданным index. Обратите внимание, что индекс содержит информацию о используемой модели. Родительский виджет редактора задаётся параметром parent, а параметры элемента — параметром option.

Базовая реализация возвращает nullptr. Если вам требуется настраиваемое редактирование, вам нужно переопределить эту функцию.

Возвращаемый виджет редактора должен иметь Qt::StrongFocus; в противном случае, события QMouseEvent, полученные виджетом, будут переданы просмотру. Фоновый цвет просмотра будет виден, если редактор не нарисует свой собственный фон (например, с помощью setAutoFillBackground()).

См. также destroyEditor(), setModelData() и setEditorData().

[virtual, since 5.0] void QAbstractItemDelegate::destroyEditor(QWidget *editor, const QModelIndex &index) const

Вызывается, когда editor больше не нужен для редактирования элемента данных с заданным index и должен быть уничтожен. Стандартное поведение — вызов deleteLater для редактора. Возможно, например, избежать этого удаления, переопределив эту функцию.

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

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

[virtual] bool QAbstractItemDelegate::editorEvent(QEvent *event, QAbstractItemModel *model, const QStyleOptionViewItem &option, const QModelIndex &index)

При запуске редактирования элемента эта функция вызывается с событием event, которое спровоцировало редактирование, моделью model, index элемента и option, используемой для отображения элемента.

События мыши отправляются в editorEvent(), даже если они не запускают редактирование элемента. Это может быть полезно, например, если вы хотите открыть контекстное меню при нажатии правой кнопки мыши на элементе.

Базовая реализация возвращает false (указывающая, что событие не обрабатывалось).

[virtual] bool QAbstractItemDelegate::helpEvent(QHelpEvent *event, QAbstractItemView *view, const QStyleOptionViewItem &option, const QModelIndex &index)

Всякий раз, когда происходит событие справки, эта функция вызывается с событием event, view, option и index, соответствующим элементу, где происходит событие.

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

Для событий QEvent::ToolTip и QEvent::WhatsThis, которые были успешно обработаны, соответствующий всплывающее окно может быть показано в зависимости от конфигурации системы пользователя.

См. также QHelpEvent.

[pure virtual] void QAbstractItemDelegate::paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const

Эта чисто абстрактная функция должна быть переопределена, если вы хотите предоставить настраиваемое отображение. Используйте painter и option стиля, чтобы отобразить элемент, указанный index элемента.

Если вы переопределите эту функцию, вы также должны переопределить sizeHint().

[virtual] void QAbstractItemDelegate::setEditorData(QWidget *editor, const QModelIndex &index) const

Устанавливает содержимое заданного editor в данные для элемента в заданном index. Обратите внимание, что индекс содержит информацию об используемой модели.

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

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

[virtual] void QAbstractItemDelegate::setModelData(QWidget *editor, QAbstractItemModel *model, const QModelIndex &index) const

Устанавливает данные для элемента в заданном index в model в содержимое заданного editor.

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

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

[pure virtual] QSize QAbstractItemDelegate::sizeHint(const QStyleOptionViewItem &option, const QModelIndex &index) const

Эта чисто абстрактная функция должна быть переопределена, если вы хотите предоставить настраиваемое отображение. Параметры задаются параметром option, а элемент модели — параметром index.

Если вы переопределите эту функцию, вы также должны переопределить paint().

[virtual] void QAbstractItemDelegate::updateEditorGeometry(QWidget *editor, const QStyleOptionViewItem &option, const QModelIndex &index) const

Обновляет геометрию editor для элемента с заданным index в соответствии с прямоугольником, указанным в option. Если элемент имеет внутренний макет, редактор будет выстроен соответствующим образом. Обратите внимание, что индекс содержит информацию об используемой модели.

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