Qt wiki will be updated on October 12th 2023 starting at 11:30 AM (EEST) and the maintenance will last around 2-3 hours. During the maintenance the site will be unavailable.

PushButton Based On Action: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
No edit summary
 
m (Sorted includes)
 
(7 intermediate revisions by 5 users not shown)
Line 1: Line 1:
=Creating a QPushButton component configured by a QAction=
{{LangSwitch}}
[[Category:HowTo]]
[[Category:snippets]]
{{DocLink|QPushButton}} does not allow itself to be configured by a {{DocLink|QAction}}. In the case when you need to share a QAction among different components like menus, buttons, and so on, you can simply extend the QPushButton class with code similar to the following:


QPushButton does not allow itself to be configured by a QAction. In the case when you need to share a QAction among different components like menus, buttons, and so on, you can simply extend the QPushButton class with code similar to the following:
<code>
#ifndef ACTIONBUTTON_H
#define ACTIONBUTTON_H
 
#include <QAction>
#include <QPushButton>
 
/*!
* An extension of a QPushButton that supports QAction.
* This class represents a QPushButton extension that can be
* connected to an action and that configures itself depending
* on the status of the action.
* When the action changes its state, the button reflects
* such changes, and when the button is clicked the action
* is triggered.
*/
class ActionButton : public QPushButton
{
    Q_OBJECT
private:
    // The action associated to this button.
    QAction *actionOwner = nullptr;
 
public:
    // Default constructor. Parent the widget parent of this button
    explicit ActionButton(QWidget *parent = nullptr);
 
    /*!
    * Set the action owner of this button, that is the action
    * associated to the button. The button is configured immediately
    * depending on the action status and the button and the action
    * are connected together so that when the action is changed the button
    * is updated and when the button is clicked the action is triggered.
    * action the action to associate to this button
    */
    void setAction(QAction *action);
 
public slots:
    /*!
    * Update the button status depending on a change
    * on the action status. This slot is invoked each time the action
    * "changed" signal is emitted.
    */
    void updateButtonStatusFromAction();
};
 
#endif // ACTIONBUTTON_H
</code>


The idea is to extend QPushButton and to provide a ''setAction'' method that will immediately configure the button itself with the action data. After that, the button will connect to the action, so that when the button is clicked the action is triggered and vice-versa: when the action is changed the button is re-configured.
The idea is to extend QPushButton and to provide a ''setAction'' method that will immediately configure the button itself with the action data. After that, the button will connect to the action, so that when the button is clicked the action is triggered and vice-versa: when the action is changed the button is re-configured.
Line 7: Line 57:
The following is the implementation:
The following is the implementation:


===Categories:===
<code>
#include "actionbutton.h"
 
ActionButton::ActionButton(QWidget *parent) :
    QPushButton(parent)
{}
 
void ActionButton::setAction(QAction *action)
{
    // if I've got already an action associated to the button
    // remove all connections
    if (actionOwner && actionOwner != action) {
        disconnect(actionOwner, &QAction::changed,
                  this, &ActionButton::updateButtonStatusFromAction);
        disconnect(this, &ActionButton::clicked,
                  actionOwner, &QAction::trigger);
    }
 
    // store the action
    actionOwner = action;
 
    // configure the button
    updateButtonStatusFromAction();
 
    // connect the action and the button
    // so that when the action is changed the
    // button is changed too!
    connect(action, &QAction::changed,
            this, &ActionButton::updateButtonStatusFromAction);
 
    // connect the button to the slot that forwards the
    // signal to the action
    connect(this, &ActionButton::clicked,
            actionOwner, &QAction::trigger);
}


* [[:Category:HowTo|HowTo]]
void ActionButton::updateButtonStatusFromAction()
* [[:Category:snippets|snippets]]
{
    if (!actionOwner)
        return;
    setText(actionOwner->text());
    setStatusTip(actionOwner->statusTip());
    setToolTip(actionOwner->toolTip());
    setIcon(actionOwner->icon());
    setEnabled(actionOwner->isEnabled());
    setCheckable(actionOwner->isCheckable());
    setChecked(actionOwner->isChecked());
}
</code>

Latest revision as of 18:53, 26 April 2018

En Ar Bg De El Es Fa Fi Fr Hi Hu It Ja Kn Ko Ms Nl Pl Pt Ru Sq Th Tr Uk Zh

QPushButton does not allow itself to be configured by a QAction. In the case when you need to share a QAction among different components like menus, buttons, and so on, you can simply extend the QPushButton class with code similar to the following:

#ifndef ACTIONBUTTON_H
#define ACTIONBUTTON_H

#include <QAction>
#include <QPushButton>

/*!
 * An extension of a QPushButton that supports QAction.
 * This class represents a QPushButton extension that can be
 * connected to an action and that configures itself depending
 * on the status of the action.
 * When the action changes its state, the button reflects
 * such changes, and when the button is clicked the action
 * is triggered.
 */
class ActionButton : public QPushButton
{
    Q_OBJECT
private:
    // The action associated to this button.
    QAction *actionOwner = nullptr;

public:
    // Default constructor. Parent the widget parent of this button
    explicit ActionButton(QWidget *parent = nullptr);

    /*!
     * Set the action owner of this button, that is the action
     * associated to the button. The button is configured immediately
     * depending on the action status and the button and the action
     * are connected together so that when the action is changed the button
     * is updated and when the button is clicked the action is triggered.
     * action the action to associate to this button
     */
    void setAction(QAction *action);

public slots:
    /*!
     * Update the button status depending on a change
     * on the action status. This slot is invoked each time the action
     * "changed" signal is emitted.
     */
    void updateButtonStatusFromAction();
};

#endif // ACTIONBUTTON_H

The idea is to extend QPushButton and to provide a setAction method that will immediately configure the button itself with the action data. After that, the button will connect to the action, so that when the button is clicked the action is triggered and vice-versa: when the action is changed the button is re-configured.

The following is the implementation:

#include "actionbutton.h"

ActionButton::ActionButton(QWidget *parent) :
    QPushButton(parent)
{}

void ActionButton::setAction(QAction *action)
{
    // if I've got already an action associated to the button
    // remove all connections
    if (actionOwner && actionOwner != action) {
        disconnect(actionOwner, &QAction::changed,
                   this, &ActionButton::updateButtonStatusFromAction);
        disconnect(this, &ActionButton::clicked,
                   actionOwner, &QAction::trigger);
    }

    // store the action
    actionOwner = action;

    // configure the button
    updateButtonStatusFromAction();

    // connect the action and the button
    // so that when the action is changed the
    // button is changed too!
    connect(action, &QAction::changed,
            this, &ActionButton::updateButtonStatusFromAction);

    // connect the button to the slot that forwards the
    // signal to the action
    connect(this, &ActionButton::clicked,
            actionOwner, &QAction::trigger);
}

void ActionButton::updateButtonStatusFromAction()
{
    if (!actionOwner)
        return;
    setText(actionOwner->text());
    setStatusTip(actionOwner->statusTip());
    setToolTip(actionOwner->toolTip());
    setIcon(actionOwner->icon());
    setEnabled(actionOwner->isEnabled());
    setCheckable(actionOwner->isCheckable());
    setChecked(actionOwner->isChecked());
}