• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • akonadi
agentmanager.h
1/*
2 Copyright (c) 2006-2008 Tobias Koenig <tokoe@kde.org>
3
4 This library is free software; you can redistribute it and/or modify it
5 under the terms of the GNU Library General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or (at your
7 option) any later version.
8
9 This library is distributed in the hope that it will be useful, but WITHOUT
10 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
12 License for more details.
13
14 You should have received a copy of the GNU Library General Public License
15 along with this library; see the file COPYING.LIB. If not, write to the
16 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17 02110-1301, USA.
18*/
19
20#ifndef AKONADI_AGENTMANAGER_H
21#define AKONADI_AGENTMANAGER_H
22
23#include "akonadi_export.h"
24
25#include <akonadi/agenttype.h>
26#include <akonadi/agentinstance.h>
27
28#include <QtCore/QObject>
29
30namespace Akonadi {
31
32class AgentManagerPrivate;
33class Collection;
34
55class AKONADI_EXPORT AgentManager : public QObject
56{
57 friend class AgentInstance;
58 friend class AgentInstanceCreateJobPrivate;
59 friend class AgentManagerPrivate;
60
61 Q_OBJECT
62
63public:
67 static AgentManager *self();
68
72 ~AgentManager();
73
77 AgentType::List types() const;
78
83 AgentType type(const QString &identifier) const;
84
88 AgentInstance::List instances() const;
89
98 AgentInstance instance(const QString &identifier) const;
99
103 void removeInstance(const AgentInstance &instance);
104
110 void synchronizeCollection(const Collection &collection);
111
120 void synchronizeCollection(const Collection &collection, bool recursive);
121
122Q_SIGNALS:
128 void typeAdded(const Akonadi::AgentType &type);
129
135 void typeRemoved(const Akonadi::AgentType &type);
136
142 void instanceAdded(const Akonadi::AgentInstance &instance);
143
149 void instanceRemoved(const Akonadi::AgentInstance &instance);
150
157 void instanceStatusChanged(const Akonadi::AgentInstance &instance);
158
165 void instanceProgressChanged(const Akonadi::AgentInstance &instance);
166
172 void instanceNameChanged(const Akonadi::AgentInstance &instance);
173
180 void instanceError(const Akonadi::AgentInstance &instance, const QString &message);
181
188 void instanceWarning(const Akonadi::AgentInstance &instance, const QString &message);
189
197 void instanceOnline(const Akonadi::AgentInstance &instance, bool online);
198
199private:
200 //@cond PRIVATE
201 AgentManager();
202
203 AgentManagerPrivate *const d;
204
205 Q_PRIVATE_SLOT(d, void agentTypeAdded(const QString &))
206 Q_PRIVATE_SLOT(d, void agentTypeRemoved(const QString &))
207 Q_PRIVATE_SLOT(d, void agentInstanceAdded(const QString &))
208 Q_PRIVATE_SLOT(d, void agentInstanceRemoved(const QString &))
209 Q_PRIVATE_SLOT(d, void agentInstanceStatusChanged(const QString &, int, const QString &))
210 Q_PRIVATE_SLOT(d, void agentInstanceProgressChanged(const QString &, uint, const QString &))
211 Q_PRIVATE_SLOT(d, void agentInstanceNameChanged(const QString &, const QString &))
212 Q_PRIVATE_SLOT(d, void agentInstanceWarning(const QString &, const QString &))
213 Q_PRIVATE_SLOT(d, void agentInstanceError(const QString &, const QString &))
214 Q_PRIVATE_SLOT(d, void agentInstanceOnlineChanged(const QString &, bool))
215 Q_PRIVATE_SLOT(d, void serviceOwnerChanged(const QString &, const QString &, const QString &))
216 //@endcond
217};
218
219}
220
221#endif
Akonadi::AgentInstance
A representation of an agent instance.
Definition agentinstance.h:63
Akonadi::AgentInstance::List
QList< AgentInstance > List
Describes a list of agent instances.
Definition agentinstance.h:71
Akonadi::AgentManagerPrivate
Definition agentmanager_p.h:38
Akonadi::AgentManager
Provides an interface to retrieve agent types and manage agent instances.
Definition agentmanager.h:56
Akonadi::AgentManager::instanceProgressChanged
void instanceProgressChanged(const Akonadi::AgentInstance &instance)
This signal is emitted whenever the progress of an agent instance has changed.
Akonadi::AgentManager::typeAdded
void typeAdded(const Akonadi::AgentType &type)
This signal is emitted whenever a new agent type was installed on the system.
Akonadi::AgentManager::instanceRemoved
void instanceRemoved(const Akonadi::AgentInstance &instance)
This signal is emitted whenever an agent instance was removed.
Akonadi::AgentManager::instanceNameChanged
void instanceNameChanged(const Akonadi::AgentInstance &instance)
This signal is emitted whenever the name of the agent instance has changed.
Akonadi::AgentManager::typeRemoved
void typeRemoved(const Akonadi::AgentType &type)
This signal is emitted whenever an agent type was removed from the system.
Akonadi::AgentManager::instanceAdded
void instanceAdded(const Akonadi::AgentInstance &instance)
This signal is emitted whenever a new agent instance was created.
Akonadi::AgentManager::instanceOnline
void instanceOnline(const Akonadi::AgentInstance &instance, bool online)
This signal is emitted whenever the online state of an agent changed.
Akonadi::AgentManager::instanceWarning
void instanceWarning(const Akonadi::AgentInstance &instance, const QString &message)
This signal is emitted whenever the agent instance raised a warning.
Akonadi::AgentManager::instanceStatusChanged
void instanceStatusChanged(const Akonadi::AgentInstance &instance)
This signal is emitted whenever the status of an agent instance has changed.
Akonadi::AgentManager::instanceError
void instanceError(const Akonadi::AgentInstance &instance, const QString &message)
This signal is emitted whenever the agent instance raised an error.
Akonadi::AgentType
A representation of an agent type.
Definition agenttype.h:59
Akonadi::AgentType::List
QList< AgentType > List
Describes a list of agent types.
Definition agenttype.h:67
Akonadi::Collection
Represents a collection of PIM items.
Definition collection.h:76
Akonadi
FreeBusyManager::Singleton.
Definition actionstatemanager_p.h:28
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

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

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
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