Класс 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.

[signal] void QAbstractItemDelegate::closeEditor(QWidget *editor, QAbstractItemDelegate::EndEditHint hint = NoHint)

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

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

См. также EndEditHint.

[signal] void QAbstractItemDelegate::commitData(QWidget *editor)

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

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

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

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

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

[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] 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, которые были обработаны успешно, соответствующее всплывающее окно может отобразиться в зависимости от конфигурации системы пользователя.

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

См. также 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. Если элемент имеет внутренний макет, редактор будет отформатирован соответствующим образом. Обратите внимание, что индекс содержит информацию о используемой модели.

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