1 | /* |
2 | Copyright (c) 2014 Christian Mollekopf <mollekopf@kolabsys.com> |
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_TAG_H |
21 | #define AKONADI_TAG_H |
22 | |
23 | #include "akonadi_export.h" |
24 | #include <QString> |
25 | |
26 | namespace Akonadi { |
27 | class Tag; |
28 | } |
29 | |
30 | AKONADI_EXPORT uint qHash(const Akonadi::Tag &); |
31 | |
32 | #include <akonadi/attributeentity.h> |
33 | #include <QVector> |
34 | #include <QSharedPointer> |
35 | #include <KUrl> |
36 | #include <QDebug> |
37 | |
38 | namespace Akonadi { |
39 | |
40 | /** |
41 | * An Akonadi Tag. |
42 | */ |
43 | class AKONADI_EXPORT Tag : public AttributeEntity |
44 | { |
45 | public: |
46 | typedef QList<Tag> List; |
47 | typedef qint64 Id; |
48 | |
49 | /** |
50 | * The PLAIN type has the following properties: |
51 | * * gid == displayName |
52 | * * immutable |
53 | * * no hierarchy (no parent) |
54 | * |
55 | * PLAIN tags are general purpose tags that are easy to map by backends. |
56 | */ |
57 | static const char *PLAIN; |
58 | |
59 | Tag(); |
60 | explicit Tag(Id id); |
61 | /** |
62 | * Creates a PLAIN tag |
63 | */ |
64 | explicit Tag(const QString &name); |
65 | |
66 | Tag(const Tag &other); |
67 | |
68 | ~Tag(); |
69 | |
70 | Tag &operator=(const Tag &); |
71 | //Avoid slicing |
72 | AttributeEntity &operator=(const AttributeEntity &); |
73 | bool operator==(const Tag &) const; |
74 | |
75 | static Tag fromUrl(const KUrl &url); |
76 | |
77 | /** |
78 | * Returns the url of the tag. |
79 | */ |
80 | KUrl url() const; |
81 | |
82 | /** |
83 | * Sets the unique @p identifier of the tag. |
84 | */ |
85 | void setId(Id identifier); |
86 | |
87 | /** |
88 | * Returns the unique identifier of the tag. |
89 | */ |
90 | Id id() const; |
91 | |
92 | void setGid(const QByteArray &gid) const; |
93 | QByteArray gid() const; |
94 | |
95 | void setRemoteId(const QByteArray &remoteId) const; |
96 | QByteArray remoteId() const; |
97 | |
98 | void setType(const QByteArray &type) const; |
99 | QByteArray type() const; |
100 | |
101 | void setName(const QString &name); |
102 | QString name() const; |
103 | |
104 | void setParent(const Tag &parent); |
105 | Tag parent() const; |
106 | |
107 | bool isValid() const; |
108 | |
109 | /** |
110 | * Returns true if the tag is immutable (cannot be modified after creation). |
111 | * Note that the immutability does not affect the attributes. |
112 | */ |
113 | bool isImmutable() const; |
114 | |
115 | private: |
116 | class Private; |
117 | QSharedPointer<Private> d; |
118 | }; |
119 | |
120 | } |
121 | |
122 | AKONADI_EXPORT QDebug &operator<<(QDebug &debug, const Akonadi::Tag &tag); |
123 | |
124 | Q_DECLARE_METATYPE(Akonadi::Tag) |
125 | Q_DECLARE_METATYPE(Akonadi::Tag::List) |
126 | Q_DECLARE_METATYPE(QSet<Akonadi::Tag>) |
127 | |
128 | #endif |
129 | |