QDataWidgetMapper Class

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

Member Function Documentation

QDataWidgetMapper::QDataWidgetMapper(QObject *parent = nullptr)

Constructs a new QDataWidgetMapper with parent object parent. By default, the orientation is horizontal and the submit policy is AutoSubmit.

See also setOrientation() and setSubmitPolicy().

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

This signal is emitted after the current index has changed and all widgets were populated with new data. index is the new current index.

Note: Notifier signal for property currentIndex.

See also currentIndex() and setCurrentIndex().

[slot] void QDataWidgetMapper::revert()

Repopulates all widgets with the current data of the model. All unsubmitted changes will be lost.

See also submit() and setSubmitPolicy().

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

Sets the current index to the row of the index if the orientation is horizontal (the default), otherwise to the column of the index.

Calls setCurrentIndex() internally. This convenience slot can be connected to the signal currentRowChanged() or currentColumnChanged() of another view's selection model.

The following example illustrates how to update all widgets with new data whenever the selection of a QTableView named myTableView changes:

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

See also currentIndex().

[slot] bool QDataWidgetMapper::submit()

Submits all changes from the mapped widgets to the model.

For every mapped section, the item delegate reads the current value from the widget and sets it in the model. Finally, the model's submit() method is invoked.

Returns true if all the values were submitted, otherwise false.

Note: For database models, QSqlQueryModel::lastError() can be used to retrieve the last error.

See also revert() and setSubmitPolicy().

[slot] void QDataWidgetMapper::toFirst()

Populates the widgets with data from the first row of the model if the orientation is horizontal (the default), otherwise with data from the first column.

This is equivalent to calling setCurrentIndex(0).

See also toLast() and setCurrentIndex().

[slot] void QDataWidgetMapper::toLast()

Populates the widgets with data from the last row of the model if the orientation is horizontal (the default), otherwise with data from the last column.

Calls setCurrentIndex() internally.

See also toFirst() and setCurrentIndex().

[slot] void QDataWidgetMapper::toNext()

Populates the widgets with data from the next row of the model if the orientation is horizontal (the default), otherwise with data from the next column.

Calls setCurrentIndex() internally. Does nothing if there is no next row in the model.

See also toPrevious() and setCurrentIndex().

[slot] void QDataWidgetMapper::toPrevious()

Populates the widgets with data from the previous row of the model if the orientation is horizontal (the default), otherwise with data from the previous column.

Calls setCurrentIndex() internally. Does nothing if there is no previous row in the model.

See also toNext() and setCurrentIndex().

[virtual] QDataWidgetMapper::~QDataWidgetMapper()

Destroys the object.

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

Adds a mapping between a widget and a section from the model. The section is a column in the model if the orientation is horizontal (the default), otherwise a row.

For the following example, we assume a model myModel that has two columns: the first one contains the names of people in a group, and the second column contains their ages. The first column is mapped to the QLineEdit nameLineEdit, and the second is mapped to the QSpinBox ageSpinBox:

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

Notes:

• If the widget is already mapped to a section, the old mapping will be replaced by the new one.
• Only one-to-one mappings between sections and widgets are allowed. It is not possible to map a single section to multiple widgets, or to map a single widget to multiple sections.

See also removeMapping(), mappedSection(), and clearMapping().

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

Essentially the same as addMapping(), but adds the possibility to specify the property to use specifying propertyName.

This function was introduced in Qt 4.3.

See also addMapping().

void QDataWidgetMapper::clearMapping()

Clears all mappings.

See also addMapping() and removeMapping().

QAbstractItemDelegate *QDataWidgetMapper::itemDelegate() const

Returns the current item delegate.

See also setItemDelegate().

QByteArray QDataWidgetMapper::mappedPropertyName(QWidget *widget) const

Returns the name of the property that is used when mapping data to the given widget.

This function was introduced in Qt 4.3.

See also mappedSection(), addMapping(), and removeMapping().

int QDataWidgetMapper::mappedSection(QWidget *widget) const

Returns the section the widget is mapped to or -1 if the widget is not mapped.

See also addMapping() and removeMapping().

QWidget *QDataWidgetMapper::mappedWidgetAt(int section) const

Returns the widget that is mapped at section, or 0 if no widget is mapped at that section.

See also addMapping() and removeMapping().

QAbstractItemModel *QDataWidgetMapper::model() const

Returns the current model.

See also setModel().

void QDataWidgetMapper::removeMapping(QWidget *widget)

Removes the mapping for the given widget.

See also addMapping() and clearMapping().

QModelIndex QDataWidgetMapper::rootIndex() const

Returns the current root index.

See also setRootIndex().

void QDataWidgetMapper::setItemDelegate(QAbstractItemDelegate *delegate)

Sets the item delegate to delegate. The delegate will be used to write data from the model into the widget and from the widget to the model, using QAbstractItemDelegate::setEditorData() and QAbstractItemDelegate::setModelData().

The delegate also decides when to apply data and when to change the editor, using QAbstractItemDelegate::commitData() and QAbstractItemDelegate::closeEditor().

See also itemDelegate().

void QDataWidgetMapper::setModel(QAbstractItemModel *model)

Sets the current model to model. If another model was set, all mappings to that old model are cleared.

See also model().

void QDataWidgetMapper::setRootIndex(const QModelIndex &index)

Sets the root item to index. This can be used to display a branch of a tree. Pass an invalid model index to display the top-most branch.

See also rootIndex().