1 | /**************************************************************************** |
2 | ** |
3 | ** Copyright (C) 2016 The Qt Company Ltd. |
4 | ** Contact: https://www.qt.io/licensing/ |
5 | ** |
6 | ** This file is part of the QtXmlPatterns module of the Qt Toolkit. |
7 | ** |
8 | ** $QT_BEGIN_LICENSE:LGPL$ |
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 https://www.qt.io/terms-conditions. For further |
15 | ** information use the contact form at https://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 3 as published by the Free Software |
20 | ** Foundation and appearing in the file LICENSE.LGPL3 included in the |
21 | ** packaging of this file. Please review the following information to |
22 | ** ensure the GNU Lesser General Public License version 3 requirements |
23 | ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. |
24 | ** |
25 | ** GNU General Public License Usage |
26 | ** Alternatively, this file may be used under the terms of the GNU |
27 | ** General Public License version 2.0 or (at your option) the GNU General |
28 | ** Public license version 3 or any later version approved by the KDE Free |
29 | ** Qt Foundation. The licenses are as published by the Free Software |
30 | ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 |
31 | ** included in the packaging of this file. Please review the following |
32 | ** information to ensure the GNU General Public License requirements will |
33 | ** be met: https://www.gnu.org/licenses/gpl-2.0.html and |
34 | ** https://www.gnu.org/licenses/gpl-3.0.html. |
35 | ** |
36 | ** $QT_END_LICENSE$ |
37 | ** |
38 | ****************************************************************************/ |
39 | |
40 | // |
41 | // W A R N I N G |
42 | // ------------- |
43 | // |
44 | // This file is not part of the Qt API. It exists purely as an |
45 | // implementation detail. This header file may change from version to |
46 | // version without notice, or even be removed. |
47 | // |
48 | // We mean it. |
49 | |
50 | #ifndef Patternist_XsdAnnotation_H |
51 | #define Patternist_XsdAnnotation_H |
52 | |
53 | #include <private/qderivedstring_p.h> |
54 | #include <private/qxsdapplicationinformation_p.h> |
55 | #include <private/qxsddocumentation_p.h> |
56 | |
57 | QT_BEGIN_NAMESPACE |
58 | |
59 | namespace QPatternist |
60 | { |
61 | /** |
62 | * @short Represents a XSD annotation object. |
63 | * |
64 | * This class represents the <em>annotation</em> object of a XML schema as described |
65 | * <a href="http://www.w3.org/TR/xmlschema11-1/#cAnnotations">here</a>. |
66 | * |
67 | * @ingroup Patternist_schema |
68 | * @author Tobias Koenig <tobias.koenig@nokia.com> |
69 | */ |
70 | class XsdAnnotation : public NamedSchemaComponent |
71 | { |
72 | public: |
73 | typedef QExplicitlySharedDataPointer<XsdAnnotation> Ptr; |
74 | typedef QList<XsdAnnotation::Ptr> List; |
75 | |
76 | /** |
77 | * Sets the @p id of the annotation. |
78 | */ |
79 | void setId(const DerivedString<TypeID>::Ptr &id); |
80 | |
81 | /** |
82 | * Returns the @p id of the annotation. |
83 | */ |
84 | DerivedString<TypeID>::Ptr id() const; |
85 | |
86 | /** |
87 | * Adds an application @p information to the annotation. |
88 | * |
89 | * The application information is meant to be interpreted by |
90 | * a software system, e.g. other parts of the XML processor pipeline. |
91 | */ |
92 | void addApplicationInformation(const XsdApplicationInformation::Ptr &information); |
93 | |
94 | /** |
95 | * Returns the list of all application information of the annotation. |
96 | */ |
97 | XsdApplicationInformation::List applicationInformation() const; |
98 | |
99 | /** |
100 | * Adds a @p documentation to the annotation. |
101 | * |
102 | * The documentation is meant to be read by human being, e.g. additional |
103 | * constraints or information about schema components. |
104 | */ |
105 | void addDocumentation(const XsdDocumentation::Ptr &documentation); |
106 | |
107 | /** |
108 | * Returns the list of all documentations of the annotation. |
109 | */ |
110 | XsdDocumentation::List documentation() const; |
111 | |
112 | private: |
113 | DerivedString<TypeID>::Ptr m_id; |
114 | XsdApplicationInformation::List m_applicationInformation; |
115 | XsdDocumentation::List m_documentations; |
116 | }; |
117 | } |
118 | |
119 | QT_END_NAMESPACE |
120 | |
121 | #endif |
122 | |