QSignalMapper#

The QSignalMapper class bundles signals from identifiable senders. More…

Synopsis#

Functions#

def mapping (object)
def mapping (text)
def mapping (id)
def removeMappings (sender)
def setMapping (sender, object)
def setMapping (sender, text)
def setMapping (sender, id)

Slots#

def map ()
def map (sender)

Signals#

def mappedInt (arg__1)
def mappedObject (arg__1)
def mappedString (arg__1)

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

Warning

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

This class collects a set of parameterless signals, and re-emits them with integer, string or widget parameters corresponding to the object that sent the signal. Note that in most cases you can use lambdas for passing custom parameters to slots. This is less costly and will simplify the code.

The class supports the mapping of particular strings, integers, objects and widgets with particular objects using setMapping() . The objects’ signals can then be connected to the map() slot which will emit a signal (it could be mappedInt() , mappedString() and mappedObject() ) with a value associated with the original signalling object. Mappings can be removed later using removeMappings() .

Example: Suppose we want to create a custom widget that contains a group of buttons (like a tool palette). One approach is to connect each button’s clicked() signal to its own custom slot; but in this example we want to connect all the buttons to a single slot and parameterize the slot by the button that was clicked.

Here’s the definition of a simple custom widget that has a single signal, clicked(), which is emitted with the text of the button that was clicked:

class ButtonWidget(QWidget):

    Q_OBJECT
# public
    ButtonWidget(QStringList texts, QWidget parent = None)
# signals
    def clicked(text):
# private
    signalMapper = QSignalMapper()

The only function that we need to implement is the constructor:

def __init__(self, texts, parent):
    super().__init__(parent)

    signalMapper = QSignalMapper(self)
    gridLayout = QGridLayout(self)
    for i in range(0, texts.size()):
        button = QPushButton(texts[i])
        button.clicked.connect(signalMapper, qOverload<>(&QSignalMapper::map))
    signalMapper.setMapping(button, texts[i])
    gridLayout.addWidget(button, i / 3, i % 3)

signalMapper.mappedString.connect(
self.clicked)

A list of texts is passed to the constructor. A signal mapper is constructed and for each text in the list a QPushButton is created. We connect each button’s clicked() signal to the signal mapper’s map() slot, and create a mapping in the signal mapper from each button to the button’s text. Finally we connect the signal mapper’s mappedString() signal to the custom widget’s clicked() signal. When the user clicks a button, the custom widget will emit a single clicked() signal whose argument is the text of the button the user clicked.

This class was mostly useful before lambda functions could be used as slots. The example above can be rewritten simpler without QSignalMapper by connecting to a lambda function.

def __init__(self, texts, parent):
    super().__init__(parent)

    gridLayout = QGridLayout(self)
    for i in range(0, texts.size()):
        text = texts[i]
        button = QPushButton(text)
        button.clicked.connect([this, text] { clicked(text); })
        gridLayout.addWidget(button, i / 3, i % 3)