File indexing completed on 2024-04-14 14:55:41

 /*
     This file is part of the Polkit-qt project
     SPDX-FileCopyrightText: 2009 Daniel Nicoletti <dantti85-pk@yahoo.com.br>
     SPDX-FileCopyrightText: 2009 Dario Freddi <drf@kde.org>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef POLKITQT1_GUI_ACTIONBUTTON_H
 #define POLKITQT1_GUI_ACTIONBUTTON_H
 
 #include "polkitqt1-gui-action.h"
 
 class QAbstractButton;
 
 namespace PolkitQt1
 {
 
 namespace Gui
 {
 
 class ActionButtonPrivate;
 /**
  * \class ActionButton polkitqt1-gui-actionbutton.h ActionButton
  * \author Daniel Nicoletti <dantti85-pk@yahoo.com.br>
  * \author Dario Freddi <drf@kde.org>
  *
  * \brief Class used to hold and update a QAbstractButton
  *
  * This class allows you to associate QAbstractButtons
  * (i.e. QPushButton) to a PolicyKit Action. It will update the
  * button properties according to the PolicyKit Action automatically.
  *
  * \note You should connect the activated() signal to receive
  * a notification when the user clicked the button and gets
  * permission to perform the given action. If you set 'noEnabled'
  * to \c true it will be emitted when PolKitResult is NO.
  */
 class POLKITQT1_GUI_EXPORT ActionButton : public Action
 {
     Q_OBJECT
     Q_DECLARE_PRIVATE(ActionButton)
     Q_DISABLE_COPY(ActionButton)
 
 public:
     /**
      * Constructs a new ActionButton. You need to pass this
      * constructor an existing QAbstractButton, whose properties
      * will be modified according to the underlying Action
      * object. As ActionButton inherits from Action, you can
      * define your button's behavior right through this wrapper.
      *
      * \see Action
      *
      * \param button the QAbstractButton to associate to this ActionButton
      * \param actionId the action Id to create the underlying Action
      * \param parent the parent object
      */
     explicit ActionButton(QAbstractButton *button, const QString &actionId = QString(), QObject *parent = nullptr);
     ~ActionButton() override;
 
     /**
      * Sets the button associated to the underlying action.
      *
      * \note If you are calling this function, you're probably
      *       changing the button the action is referring to. If this
      *       is the case, please note that Polkit-Qt does not handle
      *       the previous button's memory, so you should take care of
      *       deleting it yourself (if needed). You can retrieve it by
      *       using button()
      *
      * \see button
      *
      * \param button the new button associated with the underlying action
      */
     void setButton(QAbstractButton *button);
 
     /**
      * Returns the current button
      *
      * \return the button currently associated with the underlying action
      */
     QAbstractButton *button() const;
 
 public Q_SLOTS:
     /**
      * Connect clicked() signals to this slot. This should be
      * manually done, as in some cases we might want
      * to manually call this. Calling this will emit authorized().
      *
      * \note This slot is reentrant which is likely to only be a problem
      * if you are creating an interface to setup PolicyKit policies.
      * \note If you have a checkbox, connect to its' clicked() signal
      * to avoid an infinite loop as this function internally calls setChecked().
      * You can always use the clicked(bool) signal in this class to
      * connect to here.
      * \warning if you use this class take care to not call Action::activate
      * otherwise your checkable buttons won't be properly updated.
      */
     bool activate();
 
 Q_SIGNALS:
     /**
      * Emitted when the abstract button clicked(bool) signal
      * is emitted. This allows you to use qobject_cast<ActionButton *>(sender())
      * in a slot connected to this signal and call activate() on it.
      *
      * \note you will normally want to connect this signal
      * to the activate slot.
      *
      * \param button the button that has been clicked
      * \param checked the checked state, if applicable. Otherwise \c false
      *
      */
     void clicked(QAbstractButton *button, bool checked = false);
 
 protected:
     ActionButton(ActionButtonPrivate &dd, const QString &actionId, QObject *parent = nullptr);
 
     ActionButtonPrivate * const d_ptr;
 
 private:
     Q_PRIVATE_SLOT(d_func(), void updateButton())
     Q_PRIVATE_SLOT(d_func(), void streamClicked(bool))
 };
 
 }
 
 }
 
 #endif