• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

KDECore

  • kdecore
  • auth
HelperProxy.h
Go to the documentation of this file.
1/*
2* Copyright (C) 2008 Nicola Gigante <nicola.gigante@gmail.com>
3*
4* This program is free software; you can redistribute it and/or modify
5* it under the terms of the GNU Lesser General Public License as published by
6* the Free Software Foundation; either version 2.1 of the License, or
7* (at your option) any later version.
8*
9* This program is distributed in the hope that it will be useful,
10* but WITHOUT ANY WARRANTY; without even the implied warranty of
11* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12* GNU General Public License for more details.
13*
14* You should have received a copy of the GNU Lesser General Public License
15* along with this program; if not, write to the
16* Free Software Foundation, Inc.,
17* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA .
18*/
19
20#ifndef HELPER_PROXY_H
21#define HELPER_PROXY_H
22
23#include <QObject>
24#include <QMap>
25#include <QString>
26#include <QVariant>
27
28#include "kauthaction.h"
29#include "kauthactionreply.h"
30#include "kauthactionwatcher.h"
31
32namespace KAuth
33{
34
35class HelperProxy : public QObject
36{
37 Q_OBJECT
38
39public:
40 virtual ~HelperProxy();
41
42 // Application-side methods
43 virtual bool executeActions(const QList<QPair<QString, QVariantMap> > &list, const QString &helperID) = 0;
44 virtual ActionReply executeAction(const QString &action, const QString &helperID, const QVariantMap &arguments) = 0;
45 virtual Action::AuthStatus authorizeAction(const QString &action, const QString &helperID) = 0;
46 virtual void stopAction(const QString &action, const QString &helperID) = 0;
47
48 // Helper-side methods
49 virtual bool initHelper(const QString &name) = 0;
50 virtual void setHelperResponder(QObject *o) = 0;
51 virtual bool hasToStopAction() = 0;
52 virtual void sendDebugMessage(int level, const char *msg) = 0;
53 virtual void sendProgressStep(int step) = 0;
54 virtual void sendProgressStep(const QVariantMap &step) = 0;
55
56signals:
57 void actionStarted(const QString &action);
58 void actionPerformed(const QString &action, ActionReply reply);
59 void progressStep(const QString &action, int progress);
60 void progressStep(const QString &action, const QVariantMap &data);
61};
62
63} // namespace KAuth
64
65Q_DECLARE_INTERFACE(KAuth::HelperProxy, "org.kde.auth.HelperProxy/0.1")
66
67#endif
KAuth::ActionReply
Class that encapsulates a reply coming from the helper after executing an action.
Definition: kauthactionreply.h:371
KAuth::Action::AuthStatus
AuthStatus
The three values returned by authorization methods.
Definition: kauthaction.h:78
KAuth::HelperProxy
Definition: HelperProxy.h:36
KAuth::HelperProxy::progressStep
void progressStep(const QString &action, int progress)
KAuth::HelperProxy::initHelper
virtual bool initHelper(const QString &name)=0
KAuth::HelperProxy::stopAction
virtual void stopAction(const QString &action, const QString &helperID)=0
KAuth::HelperProxy::actionPerformed
void actionPerformed(const QString &action, ActionReply reply)
KAuth::HelperProxy::sendProgressStep
virtual void sendProgressStep(const QVariantMap &step)=0
KAuth::HelperProxy::executeActions
virtual bool executeActions(const QList< QPair< QString, QVariantMap > > &list, const QString &helperID)=0
KAuth::HelperProxy::sendProgressStep
virtual void sendProgressStep(int step)=0
KAuth::HelperProxy::authorizeAction
virtual Action::AuthStatus authorizeAction(const QString &action, const QString &helperID)=0
KAuth::HelperProxy::progressStep
void progressStep(const QString &action, const QVariantMap &data)
KAuth::HelperProxy::hasToStopAction
virtual bool hasToStopAction()=0
KAuth::HelperProxy::setHelperResponder
virtual void setHelperResponder(QObject *o)=0
KAuth::HelperProxy::sendDebugMessage
virtual void sendDebugMessage(int level, const char *msg)=0
KAuth::HelperProxy::executeAction
virtual ActionReply executeAction(const QString &action, const QString &helperID, const QVariantMap &arguments)=0
KAuth::HelperProxy::~HelperProxy
virtual ~HelperProxy()
Definition: HelperProxy.cpp:26
KAuth::HelperProxy::actionStarted
void actionStarted(const QString &action)
QList
Definition: kaboutdata.h:33
QObject
QPair
QString
kauthaction.h
kauthactionreply.h
kauthactionwatcher.h
KAuth
Definition: AuthBackend.cpp:24
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KDECore

Skip menu "KDECore"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal