This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Combo Widget Mapper Example#

The Combo Widget Mapper example shows how to use a custom delegate to map information from a model to specific widgets on a form.


We create a Window class with an almost identical user interface, except that, instead of providing a spin box so that each person’s age can be entered, we provide a combo box to allow their addresses to be classified as “Home”, “Work” or “Other”.

Window Class Definition#

The class provides a constructor, a slot to keep the buttons up to date, and a private function to set up the model:

class Window(QWidget):

# public
    Window(QWidget parent = None)
# private slots
    def updateButtons(row):
# private
    def setupModel():
    nameLabel = QLabel()
    addressLabel = QLabel()
    typeLabel = QLabel()
    nameEdit = QLineEdit()
    addressEdit = QTextEdit()
    typeComboBox = QComboBox()
    nextButton = QPushButton()
    previousButton = QPushButton()
    model = QStandardItemModel()
    typeModel = QStringListModel()
    mapper = QDataWidgetMapper()

In addition to the QDataWidgetMapper object and the controls used to make up the user interface, we use a QStandardItemModel to hold our data and a QStringListModel to hold information about the types of address that can be applied to each person’s data.

Window Class Implementation#

The constructor of the Window class can be explained in three parts. In the first part, we set up the widgets used for the user interface:

def __init__(self, parent):

    nameLabel = QLabel(tr("Name:"))
    nameEdit = QLineEdit()
    addressLabel = QLabel(tr("Address:"))
    addressEdit = QTextEdit()
    typeLabel = QLabel(tr("Type:"))
    typeComboBox = QComboBox()
    nextButton = QPushButton(tr("Next"))
    previousButton = QPushButton(tr("Previous"))

Note that we set up the mapping the combo box in the same way as for other widgets, but that we apply its own model to it so that it will display data from its own model, the typeModel, rather than from the model containing data about each person.

Next, we set up the widget mapper, relating each input widget to a column in the model specified by the call to setModel() :

mapper = QDataWidgetMapper(self)
mapper.addMapping(nameEdit, 0)
mapper.addMapping(addressEdit, 1)
mapper.addMapping(typeComboBox, 2, "currentIndex")

For the combo box, we pass an extra argument to tell the widget mapper which property to relate to values from the model. As a result, the user is able to select an item from the combo box, and the corresponding value stored in the widget’s currentIndex property will be stored in the model.

The rest of the constructor sets up connections and layouts:

layout = QGridLayout()
layout.addWidget(nameLabel, 0, 0, 1, 1)
layout.addWidget(nameEdit, 0, 1, 1, 1)
layout.addWidget(previousButton, 0, 2, 1, 1)
layout.addWidget(addressLabel, 1, 0, 1, 1)
layout.addWidget(addressEdit, 1, 1, 2, 1)
layout.addWidget(nextButton, 1, 2, 1, 1)
layout.addWidget(typeLabel, 3, 0, 1, 1)
layout.addWidget(typeComboBox, 3, 1, 1, 1)
setWindowTitle(tr("Delegate Widget Mapper"))

The model is initialized in the window’s setupModel() function. Here, we create a standard model with 5 rows and 3 columns. In each row, we insert a name, address, and a value that indicates the type of address. The address types are stored in a string list model.

def setupModel(self):

    items = QStringList()
    items << tr("Home") << tr("Work") << tr("Other")
    typeModel = QStringListModel(items, self)
    model = QStandardItemModel(5, 3, self)
    names = QStringList()
    names << "Alice" << "Bob" << "Carol" << "Donald" << "Emma"
    addresses = QStringList()
    addresses << "<qt>123 Main Street<br/>Market Town</qt>"
              << "<qt>PO Box 32<br/>Mail Handling Service"
                 "<br/>Service City</qt>"
              << "<qt>The Lighthouse<br/>Remote Island</qt>"
              << "<qt>47338 Park Avenue<br/>Big City</qt>"
              << "<qt>Research Station<br/>Base Camp<br/>Big Mountain</qt>"
    types = QStringList()
    types << "0" << "1" << "2" << "0" << "2"
    for row in range(0, 5):
      item = QStandardItem(names[row])
      model.setItem(row, 0, item)
      item = QStandardItem(addresses[row])
      model.setItem(row, 1, item)
      item = QStandardItem(types[row])
      model.setItem(row, 2, item)

As we insert each row into the model, like a record in a database, we store values that correspond to items in typeModel for each person’s address type. When the widget mapper reads these values from the final column of each row, it will need to use them as references to values in typeModel, as shown in the following diagram. This is where the delegate is used.


We show the implementation of the updateButtons() slot for completeness:

def updateButtons(self, row):

    previousButton.setEnabled(row > 0)
    nextButton.setEnabled(row < model.rowCount() - 1)

Summary and Further Reading#

The use of a separate model for the combo box provides a menu of choices that are separate from the data stored in the main model. Using a named mapping that relates the combo box’s currentIndex property to a column in the model effectively allows us to store a look-up value in the model.

However, when reading the model outside the context of the widget mapper, we need to know about the typeModel to make sense of these look-up values. It would be useful to be able to store both the data and the choices held by the typeModel in one place. This is covered by the SQL Widget Mapper Example.

Example project @ code.qt.io