KDECore

DBusHelperProxy.h

00001 /*
00002 *   Copyright (C) 2008 Nicola Gigante <nicola.gigante@gmail.com>
00003 *
00004 *   This program is free software; you can redistribute it and/or modify
00005 *   it under the terms of the GNU Lesser General Public License as published by
00006 *   the Free Software Foundation; either version 2.1 of the License, or
00007 *   (at your option) any later version.
00008 *
00009 *   This program is distributed in the hope that it will be useful,
00010 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
00011 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00012 *   GNU General Public License for more details.
00013 *
00014 *   You should have received a copy of the GNU Lesser General Public License
00015 *   along with this program; if not, write to the
00016 *   Free Software Foundation, Inc.,
00017 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA .
00018 */
00019 
00020 #ifndef DBUS_HELPER_PROXY_H
00021 #define DBUS_HELPER_PROXY_H
00022 
00023 #include <QObject>
00024 #include <QVariant>
00025 #include "HelperProxy.h"
00026 #include "kauthactionreply.h"
00027 
00028 namespace KAuth
00029 {
00030 
00031 class DBusHelperProxy : public HelperProxy
00032 {
00033     Q_OBJECT
00034     Q_INTERFACES(KAuth::HelperProxy)
00035 
00036     QObject *responder;
00037     QString m_name;
00038     QString m_currentAction;
00039     bool m_stopRequest;
00040     QList<QString> m_actionsInProgress;
00041 
00042     enum SignalType {
00043         ActionStarted, // The blob argument is empty
00044         ActionPerformed, // The blob argument contains the ActionReply
00045         DebugMessage, // The blob argument contains the debug level and the message (in this order)
00046         ProgressStepIndicator, // The blob argument contains the step indicator
00047         ProgressStepData    // The blob argument contains the QVariantMap
00048     };
00049 
00050 public:
00051     DBusHelperProxy() : responder(NULL), m_stopRequest(false) {}
00052 
00053     virtual bool executeActions(const QList<QPair<QString, QVariantMap> > &list, const QString &helperID);
00054     virtual ActionReply executeAction(const QString &action, const QString &helperID, const QVariantMap &arguments);
00055     virtual void stopAction(const QString &action, const QString &helperID);
00056 
00057     virtual bool initHelper(const QString &name);
00058     virtual void setHelperResponder(QObject *o);
00059     virtual bool hasToStopAction();
00060     virtual void sendDebugMessage(int level, const char *msg);
00061     virtual void sendProgressStep(int step);
00062     virtual void sendProgressStep(const QVariantMap &data);
00063 
00064 public slots:
00065     void stopAction(const QString &action);
00066     void performActions(QByteArray blob, const QByteArray &callerID);
00067     QByteArray performAction(const QString &action, const QByteArray &callerID, QByteArray arguments);
00068 
00069 signals:
00070     void remoteSignal(int type, const QString &action, const QByteArray &blob); // This signal is sent from the helper to the app
00071 
00072 private slots:
00073     void remoteSignalReceived(int type, const QString &action, QByteArray blob);
00074 };
00075 
00076 } // namespace Auth
00077 
00078 #endif
KDECore

DBusHelperProxy.h

KDECore

kdelibs
