action.h

/*
    SPDX-FileCopyrightText: 2009-2012 Dario Freddi <drf@kde.org>
    SPDX-FileCopyrightText: 2008 Nicola Gigante <nicola.gigante@gmail.com>
    SPDX-FileCopyrightText: 2022 Harald Sitter <sitter@kde.org>
 
    SPDX-License-Identifier: LGPL-2.1-or-later
*/
 
#ifndef KAUTH_ACTION_H
#define KAUTH_ACTION_H
 
#include "kauthcore_export.h"
 
#include <QHash>
#include <QSharedDataPointer>
#include <QString>
#include <QVariant>
 
#if __has_include(<chrono>)
#include <chrono>
#endif
 
namespace KAuth
{
class ExecuteJob;
 
class ActionData;
class KAUTHCORE_EXPORT Action
{
    Q_GADGET
public:
    enum AuthStatus {
        DeniedStatus, 
        ErrorStatus, 
        InvalidStatus, 
        AuthorizedStatus, 
        AuthRequiredStatus, 
        UserCancelledStatus, 
    };
    Q_ENUM(AuthStatus)
 
    enum ExecutionMode {
        ExecuteMode,
        AuthorizeOnlyMode,
    };
    Q_ENUM(ExecutionMode)
 
    
    enum class AuthDetail {
        DetailOther = 0,
        DetailMessage, 
    };
    Q_ENUM(AuthDetail)
 
    
    typedef QMap<AuthDetail, QVariant> DetailsMap;
 
    Action();
 
    Action(const Action &action);
 
    Action(const QString &name);
 
#if KAUTHCORE_ENABLE_DEPRECATED_SINCE(5, 71)
    KAUTHCORE_DEPRECATED_VERSION_BELATED(5, 71, 5, 68, "Use constructor with DetailsMap")
    Action(const QString &name, const QString &details);
#endif
 
    Action(const QString &name, const DetailsMap &details);
 
    ~Action();
 
    Action &operator=(const Action &action);
 
    bool operator==(const Action &action) const;
 
    bool operator!=(const Action &action) const;
 
    QString name() const;
 
    void setName(const QString &name);
 
    int timeout() const;
 
    void setTimeout(int timeout);
 
#if __has_include(<chrono>)
    void setTimeout(std::chrono::milliseconds msec)
    {
        setTimeout(int(msec.count()));
    }
#endif
 
#if KAUTHCORE_ENABLE_DEPRECATED_SINCE(5, 71)
    KAUTHCORE_DEPRECATED_VERSION_BELATED(5, 71, 5, 68, "Use setDetailsV2() with DetailsMap")
    void setDetails(const QString &details);
#endif
 
    void setDetailsV2(const DetailsMap &details);
 
#if KAUTHCORE_ENABLE_DEPRECATED_SINCE(5, 71)
    KAUTHCORE_DEPRECATED_VERSION_BELATED(5, 71, 5, 68, "Use detailsV2() with DetailsMap")
    QString details() const;
#endif
 
    DetailsMap detailsV2() const;
 
    bool isValid() const;
 
    QString helperId() const;
 
    void setHelperId(const QString &id);
 
    bool hasHelper() const;
 
    void setArguments(const QVariantMap &arguments);
 
    QVariantMap arguments() const;
 
    void addArgument(const QString &key, const QVariant &value);
 
    AuthStatus status() const;
 
    ExecuteJob *execute(ExecutionMode mode = ExecuteMode);
 
    void setParentWidget(QWidget *parent);
 
    QWidget *parentWidget() const;
 
private:
    QSharedDataPointer<ActionData> d;
};
 
} // namespace Auth
 
#endif