blob: 27fb555de27d30ee45acec5cb6ea2cc6a4bedbd3 (
plain)
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
|
/****************************************************************************
**
** Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtXmlPatterns of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the either Technology Preview License Agreement or the
** Beta Release License Agreement.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain
** additional rights. These rights are described in the Nokia Qt LGPL
** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
** package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://www.qtsoftware.com/contact.
** $QT_END_LICENSE$
**
****************************************************************************/
//
// W A R N I N G
// -------------
//
// This file is not part of the Qt API. It exists purely as an
// implementation detail. This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
#ifndef Patternist_XsdAnnotation_H
#define Patternist_XsdAnnotation_H
#include "qderivedstring_p.h"
#include "qxsdapplicationinformation_p.h"
#include "qxsddocumentation_p.h"
QT_BEGIN_HEADER
QT_BEGIN_NAMESPACE
namespace QPatternist
{
/**
* @short Represents a XSD annotation object.
*
* This class represents the <em>annotation</em> object of a XML schema as described
* <a href="http://www.w3.org/TR/xmlschema11-1/#cAnnotations">here</a>.
*
* @ingroup Patternist_schema
* @author Tobias Koenig <tobias.koenig@trolltech.com>
*/
class XsdAnnotation : public NamedSchemaComponent
{
public:
typedef QExplicitlySharedDataPointer<XsdAnnotation> Ptr;
typedef QList<XsdAnnotation::Ptr> List;
/**
* Sets the @p id of the annotation.
*/
void setId(const DerivedString<TypeID>::Ptr &id);
/**
* Returns the @p id of the annotation.
*/
DerivedString<TypeID>::Ptr id() const;
/**
* Adds an application @p information to the annotation.
*
* The application information is meant to be interpreted by
* a software system, e.g. other parts of the XML processor pipeline.
*/
void addApplicationInformation(const XsdApplicationInformation::Ptr &information);
/**
* Returns the list of all application information of the annotation.
*/
XsdApplicationInformation::List applicationInformation() const;
/**
* Adds a @p documentation to the annotation.
*
* The documentation is meant to be read by human being, e.g. additional
* constraints or information about schema components.
*/
void addDocumentation(const XsdDocumentation::Ptr &documentation);
/**
* Returns the list of all documentations of the annotation.
*/
XsdDocumentation::List documentation() const;
private:
DerivedString<TypeID>::Ptr m_id;
XsdApplicationInformation::List m_applicationInformation;
XsdDocumentation::List m_documentations;
};
}
QT_END_NAMESPACE
QT_END_HEADER
#endif
|
