Класс QDataWidgetMapper

Класс QDataWidgetMapper предоставляет отображение между частью модели данных и виджетами. Подробнее...

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

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

Свойства

• currentIndex : int
• orientation : Qt::Orientation
• submitPolicy : SubmitPolicy

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

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

Сигналы

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

QDataWidgetMapper может использоваться для создания виджетов, осознающих данные, сопоставляя их с секциями модели элементов. Секция — это столбец модели, если ориентация горизонтальная (по умолчанию), в противном случае — строка.

Каждый раз, когда изменяется текущий индекс, каждый виджет обновляется данными из модели с помощью свойства, указанного при создании его сопоставления. Если пользователь редактирует содержимое виджета, изменения считываются с помощью того же свойства и записываются обратно в модель. По умолчанию используется пользовательское свойство каждого виджета для передачи данных между моделью и виджетом. Начиная с Qt 4.3, дополнительная функция addMapping() позволяет использовать вместо пользовательского свойства по умолчанию свойство с именем.

Можно установить делегат элементов для поддержки пользовательских виджетов. По умолчанию используется QItemDelegate для синхронизации модели с виджетами.

Предположим, у нас есть модель элементов с именем model со следующим содержимым:

Следующий код отобразит столбцы модели в виджетах с именами mySpinBox, myLineEdit и myCountryChooser:

QDataWidgetMapper *mapper = new QDataWidgetMapper;
mapper->setModel(model);
mapper->addMapping(mySpinBox, 0);
mapper->addMapping(myLineEdit, 1);
mapper->addMapping(myCountryChooser, 2);
mapper->toFirst();

После вызова toFirst() виджет mySpinBox отобразит значение 1, виджет myLineEdit отобразит Qt Norway, а виджет myCountryChooser отобразит Oslo. Для навигации по модели и обновления виджетов содержимым из модели можно использовать функции навигации toFirst(), toNext(), toPrevious(), toLast() и setCurrentIndex().

Функция setRootIndex() позволяет указать конкретный элемент в модели в качестве корневого индекса — дочерние элементы этого элемента будут сопоставляться с соответствующими виджетами в пользовательском интерфейсе.

QDataWidgetMapper поддерживает две политики отправки, AutoSubmit и ManualSubmit. AutoSubmit обновит модель, как только текущий виджет потеряет фокус, ManualSubmit не обновит модель, пока не будет вызван submit(). ManualSubmit полезна при отображении диалога, который позволяет пользователю отменить все изменения. Кроме того, другие представления, отображающие модель, не обновятся, пока пользователь не завершит все свои изменения и не отправит их.

Обратите внимание, что QDataWidgetMapper отслеживает внешние изменения. Если содержимое модели обновляется в другом модуле приложения, виджеты также обновляются.

См. также QAbstractItemModel и QAbstractItemDelegate.

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

перечисление QDataWidgetMapper::SubmitPolicy

Это перечисление описывает возможные политики отправки, которые поддерживает QDataWidgetMapper.

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

QDataWidgetMapper::QDataWidgetMapper(QObject *parent = nullptr)

Создаёт новый QDataWidgetMapper с родительским объектом parent. По умолчанию ориентация горизонтальная, а политика отправки — AutoSubmit.

См. также setOrientation() и setSubmitPolicy().

[signal] void QDataWidgetMapper::currentIndexChanged(int index)

Этот сигнал излучается после изменения текущего индекса и заполнения всех виджетов новыми данными. index — новый текущий индекс.

Примечание: Сигнал уведомления для свойства currentIndex.

См. также currentIndex() и setCurrentIndex().

[slot] void QDataWidgetMapper::revert()

Заново заполняет все виджеты текущими данными модели. Все неотправленные изменения будут потеряны.

См. также submit() и setSubmitPolicy().

[slot] void QDataWidgetMapper::setCurrentModelIndex(const QModelIndex &index)

Устанавливает текущий индекс в строку index, если ориентация горизонтальная (по умолчанию), иначе в столбец index.

Внутренне вызывает setCurrentIndex(). Этот удобный слот можно подключить к сигналу currentRowChanged() или currentColumnChanged() модели выбора другого представления.

Следующий пример демонстрирует, как обновить все виджеты новыми данными всякий раз, когда меняется выбор QTableView с именем myTableView:

QDataWidgetMapper *mapper = new QDataWidgetMapper;
connect(myTableView->selectionModel(), &QItemSelectionModel::currentRowChanged,
        mapper, &QDataWidgetMapper::setCurrentModelIndex);

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

[slot] bool QDataWidgetMapper::submit()

Отправляет все изменения из сопоставленных виджетов в модель.

Для каждого сопоставленного раздела делегат элемента считывает текущее значение из виджета и устанавливает его в модель. В конечном счёте вызывается метод submit() модели.

Возвращает true , если все значения были отправлены, в противном случае false.

Примечание: Для баз данных, QSqlQueryModel::lastError() можно использовать для получения последней ошибки.

См. также revert() и setSubmitPolicy().

[slot] void QDataWidgetMapper::toFirst()

Заполняет виджеты данными из первой строки модели, если ориентация горизонтальная (по умолчанию), иначе данными из первого столбца.

Это эквивалентно вызову setCurrentIndex(0).

См. также toLast() и setCurrentIndex().

[slot] void QDataWidgetMapper::toLast()

Заполняет виджеты данными из последней строки модели, если ориентация горизонтальная (по умолчанию), иначе данными из последнего столбца.

Внутренне вызывает setCurrentIndex().

См. также toFirst() и setCurrentIndex().

[slot] void QDataWidgetMapper::toNext()

Заполняет виджеты данными из следующей строки модели, если ориентация горизонтальная (по умолчанию), иначе данными из следующего столбца.

Внутренне вызывает setCurrentIndex(). Ничего не делает, если следующей строки в модели нет.

См. также toPrevious() и setCurrentIndex().

[slot] void QDataWidgetMapper::toPrevious()

Заполняет виджеты данными из предыдущей строки модели, если ориентация горизонтальная (по умолчанию), иначе данными из предыдущего столбца.

Внутренне вызывает setCurrentIndex(). Ничего не делает, если предыдущей строки в модели нет.

См. также toNext() и setCurrentIndex().

[virtual] QDataWidgetMapper::~QDataWidgetMapper()

Уничтожает объект.

void QDataWidgetMapper::addMapping(QWidget *widget, int section)

Добавляет сопоставление между widget и section из модели. section — столбец в модели, если ориентация горизонтальная (по умолчанию), иначе — строка.

Для следующего примера мы предполагаем модель myModel, которая имеет два столбца: первый содержит имена людей в группе, а второй — их возраст. Первый столбец сопоставлен с QLineEdit nameLineEdit, а второй — с QSpinBox ageSpinBox:

QDataWidgetMapper *mapper = new QDataWidgetMapper;
mapper->setModel(myModel);
mapper->addMapping(nameLineEdit, 0);
mapper->addMapping(ageSpinBox, 1);

Примечания:

• Если виджет уже сопоставлен с разделом, старое сопоставление будет заменено новым.
• Допускаются только взаимно-однозначные сопоставления между разделами и виджетами. Невозможно сопоставить один раздел с несколькими виджетами или один виджет с несколькими разделами.

См. также removeMapping(), mappedSection() и clearMapping().

void QDataWidgetMapper::addMapping(QWidget *widget, int section, const QByteArray &propertyName)

По существу то же самое, что и addMapping(), но добавляет возможность указать свойство для использования, указав propertyName.

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

void QDataWidgetMapper::clearMapping()

Очищает все сопоставления.

См. также addMapping() и removeMapping().

QAbstractItemDelegate *QDataWidgetMapper::itemDelegate() const

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

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

QByteArray QDataWidgetMapper::mappedPropertyName(QWidget *widget) const

Возвращает имя свойства, используемого при сопоставлении данных с заданным виджетом.

См. также mappedSection(), addMapping() и removeMapping().

int QDataWidgetMapper::mappedSection(QWidget *widget) const

Возвращает раздел, к которому сопоставлен виджет, или -1, если виджет не сопоставлен.

См. также addMapping() и removeMapping().

QWidget *QDataWidgetMapper::mappedWidgetAt(int section) const

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

См. также addMapping() и removeMapping().

QAbstractItemModel *QDataWidgetMapper::model() const

Возвращает текущую модель.

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

void QDataWidgetMapper::removeMapping(QWidget *widget)

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

См. также addMapping() и clearMapping().

QModelIndex QDataWidgetMapper::rootIndex() const

Возвращает текущий индекс корня.

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

void QDataWidgetMapper::setItemDelegate(QAbstractItemDelegate *delegate)

Устанавливает делегата элемента на delegate. Делегат будет использоваться для записи данных из модели в виджет и из виджета в модель с помощью QAbstractItemDelegate::setEditorData() и QAbstractItemDelegate::setModelData().

Любой существующий делегат будет удален, но не удалён. QDataWidgetMapper не принимает на себя владение delegate.

Делегат также определяет, когда применять данные и когда изменять редактор, используя QAbstractItemDelegate::commitData() и QAbstractItemDelegate::closeEditor().

Предупреждение: Не следует использовать один и тот же экземпляр делегата между виджет-мапперами или представлениями. Это может привести к неправильному или неинтуитивному поведению редактирования, так как каждое представление, связанное с данным делегатом, может получить сигнал closeEditor() и попытаться получить доступ к, изменить или закрыть редактор, который уже был закрыт.

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

void QDataWidgetMapper::setModel(QAbstractItemModel *model)

Устанавливает текущую модель на model. Если была установлена другая модель, все сопоставления с этой старой моделью очищаются.

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

void QDataWidgetMapper::setRootIndex(const QModelIndex &index)

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

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