Akonadi

core/agenttype.h
1 /*
2  Copyright (c) 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_AGENTTYPE_H
21 #define AKONADI_AGENTTYPE_H
22 
23 #include "akonadicore_export.h"
24 
25 #include <QMetaType>
26 #include <QSharedDataPointer>
27 
28 class QIcon;
29 class QString;
30 class QStringList;
31 class QVariant;
33 
34 namespace Akonadi
35 {
36 
57 class AKONADICORE_EXPORT AgentType
58 {
59  friend class AgentManager;
60  friend class AgentManagerPrivate;
61 
62 public:
67 
71  AgentType();
72 
76  AgentType(const AgentType &other);
77 
81  ~AgentType();
82 
86  Q_REQUIRED_RESULT bool isValid() const;
87 
91  Q_REQUIRED_RESULT QString identifier() const;
92 
96  Q_REQUIRED_RESULT QString name() const;
97 
101  Q_REQUIRED_RESULT QString description() const;
102 
106  Q_REQUIRED_RESULT QString iconName() const;
107 
111  Q_REQUIRED_RESULT QIcon icon() const;
112 
116  Q_REQUIRED_RESULT QStringList mimeTypes() const;
117 
121  Q_REQUIRED_RESULT QStringList capabilities() const;
122 
127  Q_REQUIRED_RESULT QVariantMap customProperties() const;
128 
133  AgentType &operator=(const AgentType &other);
134 
139  bool operator==(const AgentType &other) const;
140 
141 private:
142  //@cond PRIVATE
143  class Private;
145  //@endcond
146 };
147 
148 }
149 
150 Q_DECLARE_TYPEINFO(Akonadi::AgentType, Q_MOVABLE_TYPE);
151 
152 Q_DECLARE_METATYPE(Akonadi::AgentType)
153 
154 #endif
typedef QVariantMap
Provides an interface to retrieve agent types and manage agent instances.
QVector< AgentType > List
Describes a list of agent types.
A representation of an agent type.
Helper integration between Akonadi and Qt.
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sat Jun 6 2020 23:09:04 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.