• TestAction
  • TestAction Class

    A test class to demonstrate improved multi-property signal documentation. More...

    Header: #include <TestAction>

    Properties

    Public Functions

    TestAction(QObject *parent = nullptr)
    bool isCheckable() const
    bool isEnabled() const
    bool isVisible() const
    void setCheckable(bool checkable)
    void setEnabled(bool enabled)
    void setText(const QString &text)
    void setVisible(bool visible)
    QString text() const

    Signals

    void changed()
    void singlePropertySignal()

    Detailed Description

    This class has properties with different notification patterns.

    Property Documentation

    checkable : bool

    This property holds whether the action is checkable

    This property determines if the action can be toggled.

    Access functions:

    bool isCheckable() const
    void setCheckable(bool checkable)

    Notifier signal:

    void singlePropertySignal()

    enabled : bool

    This property holds whether the action is enabled

    This property determines if the action can be triggered.

    Access functions:

    bool isEnabled() const
    void setEnabled(bool enabled)

    Notifier signal:

    void changed()

    text : QString

    This property holds the action's display text

    This property holds the text that is displayed for the action.

    Access functions:

    QString text() const
    void setText(const QString &text)

    Notifier signal:

    void changed()

    visible : bool

    This property holds whether the action is visible

    This property determines if the action is shown in UI.

    Access functions:

    bool isVisible() const
    void setVisible(bool visible)

    Notifier signal:

    void changed()

    Member Function Documentation

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

    Constructs a TestAction with the given parent.

    [signal] void TestAction::changed()

    This signal is emitted when certain properties of the action change. The properties that trigger this signal are enabled, visible, and text.

    Note: Notifier signal for properties enabled, text, and visible.

    [signal] void TestAction::singlePropertySignal()

    This signal is emitted when the checkable property changes.

    Note: Notifier signal for property checkable.