File indexing completed on 2024-04-28 15:18:47

 /*
     This file is part of the KDE libraries
     SPDX-FileCopyrightText: 2009-2012 Dario Freddi <drf@kde.org>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef KAUTH_OBJECTDECORATOR_H
 #define KAUTH_OBJECTDECORATOR_H
 
 // Qt
 #include <QObject>
 // KAuthCore
 #include <KAuth/Action>
 // lib
 #include "kauth_export.h"
 // Std
 #include <memory>
 
 namespace KAuth
 {
 class ObjectDecoratorPrivate;
 
 /**
  * @class ObjectDecorator objectdecorator.h <KAuth/ObjectDecorator>
  *
  * @brief A decorator to add auth features to a button or an action
  *
  * @author Dario Freddi <drf@kde.org>
  */
 class KAUTH_EXPORT ObjectDecorator : public QObject
 {
     Q_OBJECT
 public:
     /**
      * Instantiate a new decorator attached to an object
      *
      * @param parent The parent object this decorator will be attached to
      */
     explicit ObjectDecorator(QObject *parent);
 
     /**
      * Destructs the decorator
      */
     ~ObjectDecorator() override;
 
     /**
      * Returns the action object associated with this decorator,
      * or an invalid action if it does not have one.
      *
      * @returns the KAuth::Action associated with this decorator.
      */
     KAuth::Action authAction() const;
 
     /**
      * Sets the action object associated with this decorator
      *
      * By setting a KAuth::Action, this decorator will become associated with it, and
      * whenever the action or button it is attached to gets clicked, it will trigger the
      * authorization and execution process for the action.
      * Pass an invalid action to this function to disassociate the decorator.
      *
      * @param action the KAuth::Action to associate with this decorator.
      */
     void setAuthAction(const KAuth::Action &action);
 
     /**
      * Sets the action object associated with this decorator
      *
      * Overloaded member to allow creating the action by name
      *
      * @param actionName the name of the action to associate
      */
     void setAuthAction(const QString &actionName);
 
 Q_SIGNALS:
     /**
      * Signal emitted when the action is authorized
      *
      * If the decorator needs authorization, whenever the user triggers it,
      * the authorization process automatically begins.
      * If it succeeds, this signal is emitted. The KAuth::Action object is provided for convenience
      * if you have multiple Action objects, but of course it's always the same set with
      * setAuthAction().
      *
      * WARNING: If your button or action needs authorization you should connect eventual slots
      * processing stuff to this signal, and NOT clicked/triggered. Clicked/triggered will be emitted
      * even if the user has not been authorized
      *
      * @param action The object set with setAuthAction()
      */
     void authorized(const KAuth::Action &action);
 
 private:
     friend class ObjectDecoratorPrivate;
     std::unique_ptr<ObjectDecoratorPrivate> const d;
 
     Q_PRIVATE_SLOT(d, void slotActivated())
     Q_PRIVATE_SLOT(d, void authStatusChanged(KAuth::Action::AuthStatus))
 };
 
 } // namespace KAuth
 
 #endif // KAUTH_OBJECTDECORATOR_H