• Skip to content
  • Skip to link menu
Brand

API Documentation

  1. KDE API Reference
  2. KDE PIM
  3. Akonadi
  • KDE Home
  • Contact Us

Quick Links

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

Class Picker

About

PIM Storage Framework

Maintainer
Daniel Vrátil
Supported platforms
Linux
Community
IRC: #akonadi on Freenode
Mailing list: kde-pim
Use with CMake
find_package(KF5AkonadiCore)
target_link_libraries(yourapp KF5::AkonadiCore)
Use with QMake
QT += AkonadiCore 
Clone
git clone git://anongit.kde.org/akonadi.git
Browse source
Akonadi on cgit.kde.org

Akonadi

  • kde
  • pim
  • akonadi
  • src
  • core
core/agentmanager.h
1 /*
2  Copyright (c) 2006-2008 Tobias Koenig <[email protected]>
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 "akonadicore_export.h"
24 
25 #include "agenttype.h"
26 #include "agentinstance.h"
27 
28 #include <QObject>
29 
30 namespace Akonadi
31 {
32 
33 class AgentManagerPrivate;
34 class Collection;
35 
56 class AKONADICORE_EXPORT AgentManager : public QObject
57 {
58  friend class AgentInstance;
59  friend class AgentInstanceCreateJobPrivate;
60  friend class AgentManagerPrivate;
61 
62  Q_OBJECT
63 
64 public:
68  static AgentManager *self();
69 
73  ~AgentManager();
74 
78  Q_REQUIRED_RESULT AgentType::List types() const;
79 
84  Q_REQUIRED_RESULT AgentType type(const QString &identifier) const;
85 
89  Q_REQUIRED_RESULT AgentInstance::List instances() const;
90 
99  Q_REQUIRED_RESULT AgentInstance instance(const QString &identifier) const;
100 
104  void removeInstance(const AgentInstance &instance);
105 
111  void synchronizeCollection(const Collection &collection);
112 
121  void synchronizeCollection(const Collection &collection, bool recursive);
122 
123 Q_SIGNALS:
129  void typeAdded(const Akonadi::AgentType &type);
130 
136  void typeRemoved(const Akonadi::AgentType &type);
137 
143  void instanceAdded(const Akonadi::AgentInstance &instance);
144 
150  void instanceRemoved(const Akonadi::AgentInstance &instance);
151 
158  void instanceStatusChanged(const Akonadi::AgentInstance &instance);
159 
166  void instanceProgressChanged(const Akonadi::AgentInstance &instance);
167 
173  void instanceNameChanged(const Akonadi::AgentInstance &instance);
174 
181  void instanceError(const Akonadi::AgentInstance &instance, const QString &message);
182 
189  void instanceWarning(const Akonadi::AgentInstance &instance, const QString &message);
190 
198  void instanceOnline(const Akonadi::AgentInstance &instance, bool online);
199 
200 private:
201  //@cond PRIVATE
202  AgentManager();
203 
204  AgentManagerPrivate *const d;
205 
206  Q_PRIVATE_SLOT(d, void agentTypeAdded(const QString &))
207  Q_PRIVATE_SLOT(d, void agentTypeRemoved(const QString &))
208  Q_PRIVATE_SLOT(d, void agentInstanceAdded(const QString &))
209  Q_PRIVATE_SLOT(d, void agentInstanceRemoved(const QString &))
210  Q_PRIVATE_SLOT(d, void agentInstanceStatusChanged(const QString &, int, const QString &))
211  Q_PRIVATE_SLOT(d, void agentInstanceProgressChanged(const QString &, uint, const QString &))
212  Q_PRIVATE_SLOT(d, void agentInstanceNameChanged(const QString &, const QString &))
213  Q_PRIVATE_SLOT(d, void agentInstanceWarning(const QString &, const QString &))
214  Q_PRIVATE_SLOT(d, void agentInstanceError(const QString &, const QString &))
215  Q_PRIVATE_SLOT(d, void agentInstanceOnlineChanged(const QString &, bool))
216  //@endcond
217 };
218 
219 }
220 
221 #endif
Akonadi::AgentManager
Provides an interface to retrieve agent types and manage agent instances.
Definition: core/agentmanager.h:56
Akonadi::Collection
Represents a collection of PIM items.
Definition: collection.h:76
Akonadi::AgentType
A representation of an agent type.
Definition: core/agenttype.h:57
QObject
QString
QVector< AgentType >
Akonadi
Akonadi::AgentInstance
A representation of an agent instance.
Definition: core/agentinstance.h:60
This file is part of the KDE documentation.
Documentation copyright © 1996-2019 The KDE developers.
Generated on Sat Dec 14 2019 02:10:26 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

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