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

akonadi

  • akonadi
agentinstance.h
1 /*
2  Copyright (c) 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_AGENTINSTANCE_H
21 #define AKONADI_AGENTINSTANCE_H
22 
23 #include "akonadi_export.h"
24 
25 #include <QtCore/QList>
26 #include <QtCore/QMetaType>
27 #include <QtCore/QSharedDataPointer>
28 
29 class QString;
30 class QStringList;
31 class QWidget;
32 
33 namespace Akonadi
34 {
35 
36 class AgentType;
37 
62 class AKONADI_EXPORT AgentInstance
63 {
64  friend class AgentManager;
65  friend class AgentManagerPrivate;
66 
67  public:
71  typedef QList<AgentInstance> List;
72 
76  enum Status {
77  Idle = 0,
78  Running,
79  Broken,
80  NotConfigured
81  };
82 
86  AgentInstance();
87 
91  AgentInstance( const AgentInstance &other );
92 
96  ~AgentInstance();
97 
101  bool isValid() const;
102 
106  AgentType type() const;
107 
111  QString identifier() const;
112 
116  QString name() const;
117 
121  void setName( const QString &name );
122 
126  Status status() const;
127 
131  QString statusMessage() const;
132 
137  int progress() const;
138 
142  bool isOnline() const;
143 
147  void setIsOnline( bool online );
148 
154  void configure( QWidget *parent = 0 );
155 
159  void synchronize();
160 
164  void synchronizeCollectionTree();
165 
169  AgentInstance& operator=( const AgentInstance &other );
170 
174  bool operator==( const AgentInstance &other ) const;
175 
180  void abortCurrentTask() const;
181 
185  void reconfigure() const;
186 
190  void restart() const;
191 
192  private:
193  //@cond PRIVATE
194  class Private;
195  QSharedDataPointer<Private> d;
196  //@endcond
197 };
198 
199 }
200 
201 Q_DECLARE_TYPEINFO( Akonadi::AgentInstance, Q_MOVABLE_TYPE );
202 
203 Q_DECLARE_METATYPE( Akonadi::AgentInstance )
204 
205 #endif
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Sat Jul 13 2013 01:27:31 by doxygen 1.8.3.1 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
  • Modules
  • Related Pages

kdepimlibs-4.10.5 API Reference

Skip menu "kdepimlibs-4.10.5 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