• OverloadedSignalsSlots
  • TestClass
  • TestClass Class

    Test class for overloaded signals and slots. More...

    Header: #include <TestClass>

    Public Functions

    TestClass(QObject *parent = nullptr)

    Public Slots

    void process(const QString &value)
    void process(int value)

    Signals

    void dataChanged(const QString &value)
    void dataChanged(int value)

    Detailed Description

    This class tests QDoc's generation of connection snippets for overloaded signals and slots.

    Member Function Documentation

    [explicit] TestClass::TestClass(QObject *parent = nullptr)

    Constructs a TestClass with the given parent.

    [signal] void TestClass::dataChanged(const QString &value)

    This signal is emitted when a string value changes.

    Note: This signal is overloaded. To connect to this signal:

    // Connect using qOverload:
    connect(testClass, qOverload(&TestClass::dataChanged),
            receiver, &ReceiverClass::slot);
    
    // Or using a lambda:
    connect(testClass, qOverload(&TestClass::dataChanged),
            this, [](const QString &value) { /* handle dataChanged */ });
    For more examples and approaches, see connecting to overloaded signals.

    [signal] void TestClass::dataChanged(int value)

    This signal is emitted when an integer value changes.

    Note: This signal is overloaded. To connect to this signal:

    // Connect using qOverload:
    connect(testClass, qOverload(&TestClass::dataChanged),
            receiver, &ReceiverClass::slot);
    
    // Or using a lambda:
    connect(testClass, qOverload(&TestClass::dataChanged),
            this, [](int value) { /* handle dataChanged */ });
    For more examples and approaches, see connecting to overloaded signals.

    [slot] void TestClass::process(const QString &value)

    Processes a string value.

    Note: This slot is overloaded. To connect to this slot:

    // Connect using qOverload:
    connect(sender, &SenderClass::signal,
            testClass, qOverload(&TestClass::process));
    
    // Or using a lambda as wrapper:
    connect(sender, &SenderClass::signal,
            testClass, [receiver = testClass](const QString &value) { receiver->process(value); });
    For more examples and approaches, see connecting to overloaded slots.

    [slot] void TestClass::process(int value)

    Processes an integer value.

    Note: This slot is overloaded. To connect to this slot:

    // Connect using qOverload:
    connect(sender, &SenderClass::signal,
            testClass, qOverload(&TestClass::process));
    
    // Or using a lambda as wrapper:
    connect(sender, &SenderClass::signal,
            testClass, [receiver = testClass](int value) { receiver->process(value); });
    For more examples and approaches, see connecting to overloaded slots.