QSignalMapper Class

Description détaillée

Cette classe regroupe un ensemble de signaux sans paramètre et les réémet avec des paramètres de type entier, chaîne de caractères ou widget correspondant à l’objet qui a envoyé le signal. Notez que dans la plupart des cas, vous pouvez utiliser des lambdas pour transmettre des paramètres personnalisés aux slots. Cette méthode est moins gourmande en ressources et simplifie le code.

La classe prend en charge le mappage de chaînes de caractères, d’entiers, d’objets et de widgets particuliers à des objets spécifiques à l’aide de la fonction ` setMapping()`. Les signaux des objets peuvent alors être connectés au slot ` map()`, qui émettra un signal (il peut s’agir de ` mappedInt()`, ` mappedString()` ou ` mappedObject()`) avec une valeur associée à l’objet émetteur d’origine. Les mappages peuvent être supprimés ultérieurement à l’aide de ` removeMappings()`.

Exemple : supposons que nous souhaitions créer un widget personnalisé contenant un groupe de boutons (comme une palette d’outils). Une approche consiste à connecter le signal ` clicked() ` de chaque bouton à son propre slot personnalisé ; mais dans cet exemple, nous souhaitons connecter tous les boutons à un seul slot et paramétrer ce slot en fonction du bouton sur lequel l’utilisateur a cliqué.

Voici la définition d’un widget personnalisé simple doté d’un seul signal, ` clicked()`, qui est émis avec le texte du bouton sur lequel on a cliqué :

class ButtonWidget : public QWidget
{
    Q_OBJECT

public:
    ButtonWidget(const QStringList &texts, QWidget *parent = nullptr);

signals:
    void clicked(const QString &text);

private:
    QSignalMapper *signalMapper;
};

La seule fonction que nous devons implémenter est le constructeur :

ButtonWidget::ButtonWidget(const QStringList &texts, QWidget *parent)
    : QWidget(parent)
{
    signalMapper = new QSignalMapper(this);

    QGridLayout *gridLayout = new QGridLayout(this);
    for (int i = 0; i < texts.size(); ++i) {
        QPushButton *button = new QPushButton(texts[i]);
        connect(button, &QPushButton::clicked, signalMapper, qOverload<>(&QSignalMapper::map));
        signalMapper->setMapping(button, texts[i]);
        gridLayout->addWidget(button, i / 3, i % 3);
    }

    connect(signalMapper, &QSignalMapper::mappedString,
            this, &ButtonWidget::clicked);
}

Une liste de textes est transmise au constructeur. Un mappeur de signaux est créé et, pour chaque texte de la liste, un ` QPushButton ` est généré. Nous connectons le signal ` clicked() ` de chaque bouton au slot ` map()` du mappeur de signaux, puis nous créons dans ce dernier un mappage entre chaque bouton et le texte correspondant. Enfin, nous connectons le signal ` mappedString()` du mappeur de signaux au signal ` clicked() ` du widget personnalisé. Lorsque l’utilisateur clique sur un bouton, le widget personnalisé émet un seul signal ` clicked() ` dont l’argument est le texte du bouton sur lequel l’utilisateur a cliqué.

Cette classe était surtout utile avant que les fonctions lambda puissent être utilisées comme slots. L’exemple ci-dessus peut être réécrit de manière plus simple sans QSignalMapper en se connectant à une fonction lambda.

ButtonWidget::ButtonWidget(const QStringList &texts, QWidget *parent)
    : QWidget(parent)
{
    QGridLayout *gridLayout = new QGridLayout(this);
    for (int i = 0; i < texts.size(); ++i) {
        QString text = texts[i];
        QPushButton *button = new QPushButton(text);
        connect(button, &QPushButton::clicked, [this, text] { clicked(text); });
        gridLayout->addWidget(button, i / 3, i % 3);
    }
}