mirror of
https://bitbucket.org/smil3y/kde-playground.git
synced 2025-02-23 18:32:51 +00:00
221 lines
7 KiB
C++
221 lines
7 KiB
C++
/*
|
|
Copyright (c) 2006-2008 Tobias Koenig <tokoe@kde.org>
|
|
|
|
This library 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 of the License, or (at your
|
|
option) any later version.
|
|
|
|
This library 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 Library General Public
|
|
License for more details.
|
|
|
|
You should have received a copy of the GNU Library General Public License
|
|
along with this library; see the file COPYING.LIB. If not, write to the
|
|
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
|
02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef AKONADI_AGENTMANAGER_H
|
|
#define AKONADI_AGENTMANAGER_H
|
|
|
|
#include "akonadi_export.h"
|
|
|
|
#include <akonadi/agenttype.h>
|
|
#include <akonadi/agentinstance.h>
|
|
|
|
#include <QtCore/QObject>
|
|
|
|
namespace Akonadi {
|
|
|
|
class AgentManagerPrivate;
|
|
class Collection;
|
|
|
|
/**
|
|
* @short Provides an interface to retrieve agent types and manage agent instances.
|
|
*
|
|
* This singleton class can be used to create or remove agent instances or trigger
|
|
* synchronization of collections. Furthermore it provides information about status
|
|
* changes of the agents.
|
|
*
|
|
* @code
|
|
*
|
|
* Akonadi::AgentManager *manager = Akonadi::AgentManager::self();
|
|
*
|
|
* Akonadi::AgentType::List types = manager->types();
|
|
* foreach ( const Akonadi::AgentType& type, types ) {
|
|
* qDebug() << "Type:" << type.name() << type.description();
|
|
* }
|
|
*
|
|
* @endcode
|
|
*
|
|
* @author Tobias Koenig <tokoe@kde.org>
|
|
*/
|
|
class AKONADI_EXPORT AgentManager : public QObject
|
|
{
|
|
friend class AgentInstance;
|
|
friend class AgentInstanceCreateJobPrivate;
|
|
friend class AgentManagerPrivate;
|
|
|
|
Q_OBJECT
|
|
|
|
public:
|
|
/**
|
|
* Returns the global instance of the agent manager.
|
|
*/
|
|
static AgentManager *self();
|
|
|
|
/**
|
|
* Destroys the agent manager.
|
|
*/
|
|
~AgentManager();
|
|
|
|
/**
|
|
* Returns the list of all available agent types.
|
|
*/
|
|
AgentType::List types() const;
|
|
|
|
/**
|
|
* Returns the agent type with the given @p identifier or
|
|
* an invalid agent type if the identifier does not exist.
|
|
*/
|
|
AgentType type(const QString &identifier) const;
|
|
|
|
/**
|
|
* Returns the list of all available agent instances.
|
|
*/
|
|
AgentInstance::List instances() const;
|
|
|
|
/**
|
|
* Returns the agent instance with the given @p identifier or
|
|
* an invalid agent instance if the identifier does not exist.
|
|
*
|
|
* Note that because a resource is a special case of an agent, the
|
|
* identifier of a resource is the same as that of its agent instance.
|
|
* @param identifier identifier to choose the agent instance
|
|
*/
|
|
AgentInstance instance(const QString &identifier) const;
|
|
|
|
/**
|
|
* Removes the given agent @p instance.
|
|
*/
|
|
void removeInstance(const AgentInstance &instance);
|
|
|
|
/**
|
|
* Trigger a synchronization of the given collection by its owning resource agent.
|
|
*
|
|
* @param collection The collection to synchronize.
|
|
*/
|
|
void synchronizeCollection(const Collection &collection);
|
|
|
|
/**
|
|
* Trigger a synchronization of the given collection by its owning resource agent.
|
|
*
|
|
* @param collection The collection to synchronize.
|
|
* @param recursive If true, the sub-collections are also synchronized
|
|
*
|
|
* @since 4.6
|
|
*/
|
|
void synchronizeCollection(const Collection &collection, bool recursive);
|
|
|
|
Q_SIGNALS:
|
|
/**
|
|
* This signal is emitted whenever a new agent type was installed on the system.
|
|
*
|
|
* @param type The new agent type.
|
|
*/
|
|
void typeAdded(const Akonadi::AgentType &type);
|
|
|
|
/**
|
|
* This signal is emitted whenever an agent type was removed from the system.
|
|
*
|
|
* @param type The removed agent type.
|
|
*/
|
|
void typeRemoved(const Akonadi::AgentType &type);
|
|
|
|
/**
|
|
* This signal is emitted whenever a new agent instance was created.
|
|
*
|
|
* @param instance The new agent instance.
|
|
*/
|
|
void instanceAdded(const Akonadi::AgentInstance &instance);
|
|
|
|
/**
|
|
* This signal is emitted whenever an agent instance was removed.
|
|
*
|
|
* @param instance The removed agent instance.
|
|
*/
|
|
void instanceRemoved(const Akonadi::AgentInstance &instance);
|
|
|
|
/**
|
|
* This signal is emitted whenever the status of an agent instance has
|
|
* changed.
|
|
*
|
|
* @param instance The agent instance that status has changed.
|
|
*/
|
|
void instanceStatusChanged(const Akonadi::AgentInstance &instance);
|
|
|
|
/**
|
|
* This signal is emitted whenever the progress of an agent instance has
|
|
* changed.
|
|
*
|
|
* @param instance The agent instance that progress has changed.
|
|
*/
|
|
void instanceProgressChanged(const Akonadi::AgentInstance &instance);
|
|
|
|
/**
|
|
* This signal is emitted whenever the name of the agent instance has changed.
|
|
*
|
|
* @param instance The agent instance that name has changed.
|
|
*/
|
|
void instanceNameChanged(const Akonadi::AgentInstance &instance);
|
|
|
|
/**
|
|
* This signal is emitted whenever the agent instance raised an error.
|
|
*
|
|
* @param instance The agent instance that raised the error.
|
|
* @param message The i18n'ed error message.
|
|
*/
|
|
void instanceError(const Akonadi::AgentInstance &instance, const QString &message);
|
|
|
|
/**
|
|
* This signal is emitted whenever the agent instance raised a warning.
|
|
*
|
|
* @param instance The agent instance that raised the warning.
|
|
* @param message The i18n'ed warning message.
|
|
*/
|
|
void instanceWarning(const Akonadi::AgentInstance &instance, const QString &message);
|
|
|
|
/**
|
|
* This signal is emitted whenever the online state of an agent changed.
|
|
*
|
|
* @param instance The agent instance that changed its online state.
|
|
* @param online The new online state.
|
|
* @since 4.2
|
|
*/
|
|
void instanceOnline(const Akonadi::AgentInstance &instance, bool online);
|
|
|
|
private:
|
|
//@cond PRIVATE
|
|
AgentManager();
|
|
|
|
AgentManagerPrivate *const d;
|
|
|
|
Q_PRIVATE_SLOT(d, void agentTypeAdded(const QString &))
|
|
Q_PRIVATE_SLOT(d, void agentTypeRemoved(const QString &))
|
|
Q_PRIVATE_SLOT(d, void agentInstanceAdded(const QString &))
|
|
Q_PRIVATE_SLOT(d, void agentInstanceRemoved(const QString &))
|
|
Q_PRIVATE_SLOT(d, void agentInstanceStatusChanged(const QString &, int, const QString &))
|
|
Q_PRIVATE_SLOT(d, void agentInstanceProgressChanged(const QString &, uint, const QString &))
|
|
Q_PRIVATE_SLOT(d, void agentInstanceNameChanged(const QString &, const QString &))
|
|
Q_PRIVATE_SLOT(d, void agentInstanceWarning(const QString &, const QString &))
|
|
Q_PRIVATE_SLOT(d, void agentInstanceError(const QString &, const QString &))
|
|
Q_PRIVATE_SLOT(d, void agentInstanceOnlineChanged(const QString &, bool))
|
|
Q_PRIVATE_SLOT(d, void serviceOwnerChanged(const QString &, const QString &, const QString &))
|
|
//@endcond
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|