kauthaction.h

Go to the documentation of this file.

/*
*   Copyright (C) 2008 Nicola Gigante <nicola.gigante@gmail.com>
*   Copyright (C) 2009 Dario Freddi <drf@kde.org>
*
*   This program is free software; you can redistribute it and/or modify
*   it under the terms of the GNU Lesser General Public License as published by
*   the Free Software Foundation; either version 2.1 of the License, or
*   (at your option) any later version.
*
*   This program is distributed in the hope that it will be useful,
*   but WITHOUT ANY WARRANTY; without even the implied warranty of
*   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*   GNU General Public License for more details.
*
*   You should have received a copy of the GNU Lesser General Public License
*   along with this program; if not, write to the
*   Free Software Foundation, Inc.,
*   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA .
*/

#ifndef ACTION_H
#define ACTION_H

#include <QtCore/QString>
#include <QtCore/QVariant>
#include <QtCore/QHash>

#include <kdecore_export.h>

#include "kauthactionreply.h"

namespace KAuth
{

class ActionWatcher;

class KDECORE_EXPORT Action
{
    class Private;
    Private * const d;

public:
    enum AuthStatus {
        Denied, 
        Error, 
        Invalid, 
        Authorized, 
        AuthRequired, 
        UserCancelled 
    };

    Action();

    Action(const Action &action);

    Action(const QString &name);

    Action(const QString &name, const QString &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);

    void setDetails(const QString &details);

    QString details() const;

    bool isValid() const;

    QString helperID() const;

    void setHelperID(const QString &id);

    bool hasHelper() const;

    ActionWatcher *watcher();

    void setArguments(const QVariantMap &arguments);

    QVariantMap arguments() const;

    void addArgument(const QString &key, const QVariant &value);

    AuthStatus authorize() const;

    AuthStatus earlyAuthorize() const;

    AuthStatus status() const;

    ActionReply execute() const;

    ActionReply execute(const QString &helperID) const;

    void setExecutesAsync(bool async);
    bool executesAsync() const;

    static bool executeActions(const QList<Action> &actions, QList<Action> *deniedActions, const QString &helperId);

    static bool executeActions(const QList<Action> &actions, QList<Action> *deniedActions, const QString &helperId,
                               QWidget *parent);

    void stop();

    void stop(const QString &helperID);

    void setParentWidget(QWidget *parent);

    QWidget *parentWidget() const;
};

} // namespace Auth

#endif