Класс QSignalMapper

Класс QSignalMapper объединяет сигналы от идентифицируемых отправителей. Подробнее...

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

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

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

Сигналы

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

Этот класс собирает набор сигналов без параметров и повторно излучает их с целыми числами, строками или параметрами виджетов, соответствующими объекту, который отправил сигнал. Обратите внимание, что в большинстве случаев вы можете использовать лямбда-функции для передачи пользовательских параметров в слоты. Это менее затратно и упростит код.

Класс поддерживает сопоставление определённых строк или целых чисел с определёнными объектами с помощью setMapping(). Сигналы объектов затем могут быть подключены к слоту map(), который излучит сигнал mapped() со строкой или целым числом, связанными с исходным объектом-отправителем. Сопоставления могут быть удалены позже с помощью removeMappings().

Пример: Предположим, что мы хотим создать пользовательский виджет, содержащий группу кнопок (например, палитру инструментов). Один из подходов — подключить сигнал каждой кнопки к собственному пользовательскому слоту; но в этом примере мы хотим подключить все кнопки к одному слоту и параметризовать слот кнопкой, которая была нажата.

Вот определение простого пользовательского виджета, у которого есть один сигнал, clicked(), который излучается со значением текста нажатой кнопки:

class ButtonWidget : public QWidget
{
    Q_OBJECT

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

signals:
    void clicked(const QString &text);

private:
    QSignalMapper *signalMapper;
};

Единственная функция, которую нам нужно реализовать, — это конструктор:

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

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

    connect(signalMapper, SIGNAL(mapped(QString)),
            this, SIGNAL(clicked(QString)));

    setLayout(gridLayout);
}

В конструктор передаётся список текстов. Создаётся объект QSignalMapper, и для каждого текста в списке создаётся кнопка QPushButton. Мы подключаем сигнал clicked() каждой кнопки к слоту map() маппера сигналов и создаём сопоставление в маппере сигналов от каждой кнопки к тексту этой кнопки. Наконец, мы подключаем сигнал mapped() маппера сигналов к сигналу clicked() пользовательского виджета. Когда пользователь нажимает кнопку, пользовательский виджет излучит единственный сигнал clicked(), аргументом которого является текст кнопки, которую нажал пользователь.

Этот класс был в основном полезен до того, как лямбда-функции могли использоваться в качестве слотов. Приведённый выше пример можно переписать проще без QSignalMapper, подключив его к лямбда-функции.

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

См. также QObject, QButtonGroup и QActionGroup.

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

QSignalMapper::QSignalMapper(QObject *parent = nullptr)

Создаёт QSignalMapper с родителем parent.

[slot] void QSignalMapper::map(QObject *sender)

Этот слот излучает сигналы на основе объекта sender.

[slot] void QSignalMapper::map()

Этот слот излучает сигналы на основе объекта, который отправил сигналы.

[signal] void QSignalMapper::mapped(QObject *object)

Этот сигнал излучается, когда map() получает сигнал от объекта, у которого установлено сопоставление с объектом. Объект, предоставленный методом map(), передаётся в object.

Примечание: Сигнал mapped перегружен в этом классе. Для подключения к этому сигналу с помощью синтаксиса указателя на функцию Qt предоставляет удобную вспомогательную функцию, как показано в этом примере:

connect(signalMapper, QOverload<QObject *>::of(&QSignalMapper::mapped),
    [=](QObject *object){ /* ... */ });

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

[signal] void QSignalMapper::mapped(QWidget *widget)

Этот сигнал излучается, когда map() получает сигнал от объекта, у которого установлено сопоставление с виджетом. Сопоставленный виджет объекта передаётся в widget.

Примечание: Сигнал mapped перегружен в этом классе. Для подключения к этому сигналу с помощью синтаксиса указателя на функцию Qt предоставляет удобную вспомогательную функцию, как показано в этом примере:

connect(signalMapper, QOverload<QWidget *>::of(&QSignalMapper::mapped),
    [=](QWidget *widget){ /* ... */ });

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

[signal] void QSignalMapper::mapped(const QString &text)

Этот сигнал излучается, когда map() получает сигнал от объекта, у которого установлено строковое сопоставление. Сопоставленная строка объекта передаётся в text.

Примечание: Сигнал mapped перегружен в этом классе. Для подключения к этому сигналу с помощью синтаксиса указателя на функцию Qt предоставляет удобную вспомогательную функцию, как показано в этом примере:

connect(signalMapper, QOverload<const QString &>::of(&QSignalMapper::mapped),
    [=](const QString &text){ /* ... */ });

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

[signal] void QSignalMapper::mapped(int i)

Этот сигнал излучается, когда map() получает сигнал от объекта, у которого установлено целочисленное сопоставление. Сопоставленное целое число объекта передаётся в i.

Примечание: Сигнал mapped перегружен в этом классе. Для подключения к этому сигналу с помощью синтаксиса указателя на функцию Qt предоставляет удобную вспомогательную функцию, как показано в этом примере:

connect(signalMapper, QOverload<int>::of(&QSignalMapper::mapped),
    [=](int i){ /* ... */ });

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

[virtual] QSignalMapper::~QSignalMapper()

Уничтожает QSignalMapper.

QObject *QSignalMapper::mapping(int id) const

Возвращает объект QObject-отправителя, связанный с id.

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

QObject *QSignalMapper::mapping(const QString &id) const

Эта функция перегружает mapping().

QObject *QSignalMapper::mapping(QWidget *widget) const

Эта функция перегружает mapping().

Возвращает объект QObject-отправителя, связанный с widget.

QObject *QSignalMapper::mapping(QObject *object) const

Эта функция перегружает mapping().

Возвращает отправителя QObject, который связан с объектом object.

void QSignalMapper::removeMappings(QObject *sender)

Удаляет все сопоставления для sender.

Это делается автоматически при уничтожении сопоставленных объектов.

Примечание: Это не отсоединяет никакие сигналы. Если sender не уничтожается, то это необходимо сделать явно, если требуется.

void QSignalMapper::setMapping(QObject *sender, int id)

Добавляет сопоставление, чтобы при поступлении сигнала map() от данного sender, излучался сигнал mapped(id).

Для каждого отправителя может быть максимум один целочисленный идентификатор.

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

void QSignalMapper::setMapping(QObject *sender, const QString &text)

Добавляет сопоставление, чтобы при поступлении сигнала map() от sender, излучался сигнал mapped(text).

Для каждого отправителя может быть максимум один текст.

void QSignalMapper::setMapping(QObject *sender, QWidget *widget)

Добавляет сопоставление, чтобы при поступлении сигнала map() от sender, излучался сигнал mapped(widget).

Для каждого отправителя может быть максимум один виджет.

void QSignalMapper::setMapping(QObject *sender, QObject *object)

Добавляет сопоставление, чтобы при поступлении сигнала map() от sender, излучался сигнал mapped(object).

Для каждого отправителя может быть максимум один объект.