|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies). |
|
4 ** All rights reserved. |
|
5 ** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 ** |
|
7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit. |
|
8 ** |
|
9 ** $QT_BEGIN_LICENSE:LGPL$ |
|
10 ** No Commercial Usage |
|
11 ** This file contains pre-release code and may not be distributed. |
|
12 ** You may use this file in accordance with the terms and conditions |
|
13 ** contained in the Technology Preview License Agreement accompanying |
|
14 ** this package. |
|
15 ** |
|
16 ** GNU Lesser General Public License Usage |
|
17 ** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 ** General Public License version 2.1 as published by the Free Software |
|
19 ** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 ** packaging of this file. Please review the following information to |
|
21 ** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 ** |
|
24 ** In addition, as a special exception, Nokia gives you certain additional |
|
25 ** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 ** |
|
28 ** If you have questions regarding the use of this file, please contact |
|
29 ** Nokia at qt-info@nokia.com. |
|
30 ** |
|
31 ** |
|
32 ** |
|
33 ** |
|
34 ** |
|
35 ** |
|
36 ** |
|
37 ** |
|
38 ** $QT_END_LICENSE$ |
|
39 ** |
|
40 ****************************************************************************/ |
|
41 |
|
42 // |
|
43 // W A R N I N G |
|
44 // ------------- |
|
45 // |
|
46 // This file is not part of the Qt API. It exists purely as an |
|
47 // implementation detail. This header file may change from version to |
|
48 // version without notice, or even be removed. |
|
49 // |
|
50 // We mean it. |
|
51 |
|
52 #ifndef Patternist_XsdAnnotation_H |
|
53 #define Patternist_XsdAnnotation_H |
|
54 |
|
55 #include "qderivedstring_p.h" |
|
56 #include "qxsdapplicationinformation_p.h" |
|
57 #include "qxsddocumentation_p.h" |
|
58 |
|
59 QT_BEGIN_HEADER |
|
60 |
|
61 QT_BEGIN_NAMESPACE |
|
62 |
|
63 namespace QPatternist |
|
64 { |
|
65 /** |
|
66 * @short Represents a XSD annotation object. |
|
67 * |
|
68 * This class represents the <em>annotation</em> object of a XML schema as described |
|
69 * <a href="http://www.w3.org/TR/xmlschema11-1/#cAnnotations">here</a>. |
|
70 * |
|
71 * @ingroup Patternist_schema |
|
72 * @author Tobias Koenig <tobias.koenig@nokia.com> |
|
73 */ |
|
74 class XsdAnnotation : public NamedSchemaComponent |
|
75 { |
|
76 public: |
|
77 typedef QExplicitlySharedDataPointer<XsdAnnotation> Ptr; |
|
78 typedef QList<XsdAnnotation::Ptr> List; |
|
79 |
|
80 /** |
|
81 * Sets the @p id of the annotation. |
|
82 */ |
|
83 void setId(const DerivedString<TypeID>::Ptr &id); |
|
84 |
|
85 /** |
|
86 * Returns the @p id of the annotation. |
|
87 */ |
|
88 DerivedString<TypeID>::Ptr id() const; |
|
89 |
|
90 /** |
|
91 * Adds an application @p information to the annotation. |
|
92 * |
|
93 * The application information is meant to be interpreted by |
|
94 * a software system, e.g. other parts of the XML processor pipeline. |
|
95 */ |
|
96 void addApplicationInformation(const XsdApplicationInformation::Ptr &information); |
|
97 |
|
98 /** |
|
99 * Returns the list of all application information of the annotation. |
|
100 */ |
|
101 XsdApplicationInformation::List applicationInformation() const; |
|
102 |
|
103 /** |
|
104 * Adds a @p documentation to the annotation. |
|
105 * |
|
106 * The documentation is meant to be read by human being, e.g. additional |
|
107 * constraints or information about schema components. |
|
108 */ |
|
109 void addDocumentation(const XsdDocumentation::Ptr &documentation); |
|
110 |
|
111 /** |
|
112 * Returns the list of all documentations of the annotation. |
|
113 */ |
|
114 XsdDocumentation::List documentation() const; |
|
115 |
|
116 private: |
|
117 DerivedString<TypeID>::Ptr m_id; |
|
118 XsdApplicationInformation::List m_applicationInformation; |
|
119 XsdDocumentation::List m_documentations; |
|
120 }; |
|
121 } |
|
122 |
|
123 QT_END_NAMESPACE |
|
124 |
|
125 QT_END_HEADER |
|
126 |
|
127 #endif |