Класс QDataWidgetMapper

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

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

Открытые типы

Свойства

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

• 1 свойство унаследовано от QObject

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

• 34 открытые функции унаследованы от QObject

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

• 1 открытый слот унаследован от QObject

Сигналы

• 2 сигнала унаследованы от QObject

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

• 1 открытая переменная унаследована от QObject
• 10 статические открытые члены унаследованы от QObject
• 9 защищенные функции унаследованы от QObject
• 2 защищенные переменные унаследованы от QObject

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

Класс QDataWidgetMapper обеспечивает сопоставление части модели данных с виджетами.

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.

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

enum QDataWidgetMapper::SubmitPolicy

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

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

QDataWidgetMapper::QDataWidgetMapper(QObject *parent = nullptr)

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

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

[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);

Примечания:

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

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

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

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

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

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

void QDataWidgetMapper::clearMapping()

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

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

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

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

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

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

QAbstractItemDelegate *QDataWidgetMapper::itemDelegate() const

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

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

QByteArray QDataWidgetMapper::mappedPropertyName(QWidget *widget) const

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

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

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

int QDataWidgetMapper::mappedSection(QWidget *widget) const

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

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

QWidget *QDataWidgetMapper::mappedWidgetAt(int section) const

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

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

QAbstractItemModel *QDataWidgetMapper::model() const

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

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

void QDataWidgetMapper::removeMapping(QWidget *widget)

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

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

[slot] void QDataWidgetMapper::revert()

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

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

QModelIndex QDataWidgetMapper::rootIndex() const

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

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

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

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

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

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

QDataWidgetMapper *mapper = new QDataWidgetMapper();
connect(myTableView->selectionModel(), SIGNAL(currentRowChanged(QModelIndex,QModelIndex)),
        mapper, SLOT(setCurrentModelIndex(QModelIndex)));

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

void QDataWidgetMapper::setItemDelegate(QAbstractItemDelegate *delegate)

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

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

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

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

void QDataWidgetMapper::setModel(QAbstractItemModel *model)

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

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

void QDataWidgetMapper::setRootIndex(const QModelIndex &index)

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

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

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