1/****************************************************************************
2**
3** Copyright (C) 2015 The Qt Company Ltd.
4** Contact: http://www.qt.io/licensing/
5**
6** This file is part of the QtVersit module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL21$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see http://www.qt.io/terms-conditions. For further
15** information use the contact form at http://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 2.1 or version 3 as published by the Free
20** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22** following information to ensure the GNU Lesser General Public License
23** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25**
26** As a special exception, The Qt Company gives you certain additional
27** rights. These rights are described in The Qt Company LGPL Exception
28** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29**
30** $QT_END_LICENSE$
31**
32****************************************************************************/
33
34#ifndef QVERSITDOCUMENT_H
35#define QVERSITDOCUMENT_H
36
37#include <QtCore/qlist.h>
38#include <QtCore/qshareddata.h>
39
40#include <QtVersit/qversitdocument.h>
41#include <QtVersit/qversitproperty.h>
42
43QT_BEGIN_NAMESPACE_VERSIT
44
45class QVersitProperty;
46
47class QVersitDocumentPrivate;
48class Q_VERSIT_EXPORT QVersitDocument
49{
50public:
51 enum VersitType {
52 InvalidType,
53 VCard21Type, // vCard version 2.1
54 VCard30Type, // vCard version 3.0 (RFC 2426)
55 VCard40Type, // vCard version 4.0
56 ICalendar20Type // iCalendar version 2.0 (RFC 2445/5545)
57 };
58
59 QVersitDocument();
60 QVersitDocument(const QVersitDocument& other);
61 QVersitDocument(VersitType type);
62 ~QVersitDocument();
63
64 QVersitDocument& operator=(const QVersitDocument& other);
65 bool operator==(const QVersitDocument& other) const;
66 bool operator!=(const QVersitDocument& other) const;
67
68 // Metadata about the versit document
69 // The type determines the format for serialization
70 void setType(VersitType type);
71 VersitType type() const;
72
73 // The componentType is the value of the BEGIN property
74 void setComponentType(QString componentType);
75 QString componentType() const;
76
77 // The content
78 void addProperty(const QVersitProperty& property);
79 void removeProperty(const QVersitProperty& property);
80 void removeProperties(const QString& name);
81 void setProperties(const QList<QVersitProperty>& properties);
82 QList<QVersitProperty> properties() const;
83
84 void addSubDocument(const QVersitDocument& subdocument);
85 void removeSubDocument(const QVersitDocument& subdocument);
86 void setSubDocuments(const QList<QVersitDocument>& documents);
87 QList<QVersitDocument> subDocuments() const;
88
89 bool isEmpty() const;
90 void clear();
91
92private:
93
94 QSharedDataPointer<QVersitDocumentPrivate> d;
95};
96
97Q_VERSIT_EXPORT uint qHash(const QVersitDocument& key);
98#ifndef QT_NO_DEBUG_STREAM
99Q_VERSIT_EXPORT QDebug operator<<(QDebug dbg, const QVersitDocument& property);
100#endif
101
102QT_END_NAMESPACE_VERSIT
103
104Q_DECLARE_METATYPE(QTVERSIT_PREPEND_NAMESPACE(QVersitDocument))
105
106#endif // QVERSITDOCUMENT_H
107

source code of qtpim/src/versit/qversitdocument.h