plasma-framework/service.h
Pino Toscano 3ad723c617 fixup of CamelCase includes in public headers:
- QtModule/QClass for Qt includes
- KDE/KClass for KDE includes

svn path=/trunk/KDE/kdebase/workspace/libs/plasma/; revision=809478
2008-05-18 23:18:59 +00:00

188 lines
5.8 KiB
C++

/*
* Copyright 2008 Aaron Seigo <aseigo@kde.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Library General Public License as
* published by the Free Software Foundation; either version 2, 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 Library 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 PLASMA_SERVICE_H
#define PLASMA_SERVICE_H
#include <QtCore/QMap>
#include <QtCore/QObject>
#include <QtCore/QVariant>
#include <KDE/KConfigGroup>
class QIODevice;
namespace Plasma
{
class ServiceJob;
/**
* @brief This class provides a generic API for write access to settings or services.
*
* Plasma::Service allows interaction with a "destination", the definition of which
* depends on the Service itself. For a network settings Service this might be a
* profile name ("Home", "Office", "Road Warrior") while a web based Service this
* might be a username ("aseigo", "stranger65").
*
* A Service provides one or more operations, each of which provides some sort
* of interaction with the destination. Operations are described using config
* XML which is used to create a KConfig object with one group per operation.
* The group names are used as the operation names, and the defined items in
* the group are the parameters available to be set when using that operation.
*
* A service is started with a KConfigGroup (representing a ready to be serviced
* operation) and automatically deletes itself after completion and signaling
* success or failure. See KJob for more information on this part of the process.
*
* Services may either be loaded "stand alone" from plugins, or from a DataEngine
* by passing in a source name to be used as the destination.
*
* Sample use might look like:
*
* Plasma::DataEngine *twitter = dataEngine("twitter");
* Plasma::Service *service = twitter.serviceForSource("aseigo");
* KConfigGroup op = service->operationParameters("update");
* op.writeEntry("tweet", "Hacking on plasma!");
* Plasma::ServiceJob *job = service->startOperation(op);
* connect(job, SIGNAL(finished(KJob*)), this, SLOT(jobCompeted()));
*/
class Service : public QObject
{
Q_OBJECT
public:
/**
* Destructor
*/
~Service();
/**
* Used to load a given service from a plugin.
*
* @param name the plugin name of the service to load
* @param parent the parent object, if any, for the service
*
* @return a Service object, guaranteed to be not null.
*/
static Service* load(const QString &name, QObject *parent = 0);
/**
* Sets the destination for this Service to operate on
*
* @arg destination specific to each Service, this sets which
* target or address for ServiceJobs to operate on
*/
void setDestination(const QString &destination);
/**
* @return the target destination, if any, that this service is associated with
*/
QString destination() const;
/**
* @return the possible operations for this profile
*/
QStringList operationList() const;
/**
* Retrieves the parameters for a given operation
*
* @param operation the operation to retrieve parameters for
* @return KConfigGroup containing the parameters
*/
KConfigGroup operationParameters(const QString &operation);
/**
* Called to create a ServiceJob which is associated with a given
* operation and parameter set.
*
* @return a started ServiceJob; the consumer may connect to relevant
* signals before returning to the event loop
*/
ServiceJob* startOperation(const KConfigGroup &parameters);
/**
* The name of this service
*/
QString name() const;
Q_SIGNALS:
void finished(ServiceJob* job);
protected:
/**
* Default constructor
*
* @arg parent the parent object for this service
*/
explicit Service(QObject *parent = 0);
/**
* Constructor for plugin loading
*/
Service(QObject *parent, const QVariantList &args);
/**
* Called when a job should be created by the Service.
*
* @param operation which operation to work on
* @param parameters the parameters set by the user for the operation
* @return a ServiceJob that can be started and monitored by the consumer
*/
virtual ServiceJob* createJob(const QString &operation,
QMap<QString, QVariant> &parameters) = 0;
/**
* By default this is based on the file in plasma/services/name.operations, but can be
* reimplented to use a different mechanism.
*
* It should result in a call to setOperationsScheme(QIODevice *);
*/
virtual void registerOperationsScheme();
/**
* Sets the XML used to define the operation schema for
* this Service.
*/
void setOperationsScheme(QIODevice *xml);
/**
* Sets the name of the Service; useful for Services not loaded from plugins,
* which use the plugin name for this.
*
* @arg name the name to use for this service
*/
void setName(const QString &name);
private:
Q_PRIVATE_SLOT(d, void jobFinished(KJob*))
class Private;
Private * const d;
};
} // namespace Plasma
#define K_EXPORT_PLASMA_SERVICE(libname, classname) \
K_PLUGIN_FACTORY(factory, registerPlugin<classname>();) \
K_EXPORT_PLUGIN(factory("plasma_service_" #libname))
#endif // multiple inclusion guard