1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
/*
Copyright (c) 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_AGENTTYPE_H
#define AKONADI_AGENTTYPE_H
#include "akonadi_export.h"
#include <QtCore/QList>
#include <QtCore/QMetaType>
#include <QtCore/QSharedDataPointer>
class QIcon;
class QString;
class QStringList;
namespace Akonadi
{
/**
* @short A representation of an agent type.
*
* The agent type is a representation of an available agent, that can
* be started as an agent instance.
* It provides all information about the type.
*
* All available agent types can be retrieved from the AgentManager.
*
* @code
*
* Akonadi::AgentType::List types = Akonadi::AgentManager::self()->types();
* foreach ( const Akonadi::AgentType &type, types ) {
* qDebug() << "Name:" << type.name() << "(" << type.identifier() << ")";
* }
*
* @endcode
*
* @author Tobias Koenig <tokoe@kde.org>
*/
class AKONADI_EXPORT AgentType
{
friend class AgentManager;
friend class AgentManagerPrivate;
public:
/**
* Describes a list of agent types.
*/
typedef QList<AgentType> List;
/**
* Creates a new agent type.
*/
AgentType();
/**
* Creates an agent type from an @p other agent type.
*/
AgentType( const AgentType &other );
/**
* Destroys the agent type.
*/
~AgentType();
/**
* Returns whether the agent type is valid.
*/
bool isValid() const;
/**
* Returns the unique identifier of the agent type.
*/
QString identifier() const;
/**
* Returns the i18n'ed name of the agent type.
*/
QString name() const;
/**
* Returns the description of the agent type.
*/
QString description() const;
/**
* Returns the name of the icon of the agent type.
*/
QString iconName() const;
/**
* Returns the icon of the agent type.
*/
QIcon icon() const;
/**
* Returns the list of supported mime types of the agent type.
*/
QStringList mimeTypes() const;
/**
* Returns the list of supported capabilities of the agent type.
*/
QStringList capabilities() const;
/**
* @internal
*/
AgentType& operator=( const AgentType &other );
/**
* @internal
*/
bool operator==( const AgentType &other ) const;
private:
//@cond PRIVATE
class Private;
QSharedDataPointer<Private> d;
//@endcond
};
}
Q_DECLARE_TYPEINFO( Akonadi::AgentType, Q_MOVABLE_TYPE );
Q_DECLARE_METATYPE( Akonadi::AgentType )
#endif
|