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_XsdDocumentation_H
51#define Patternist_XsdDocumentation_H
52
53#include <private/qanytype_p.h>
54#include <private/qanyuri_p.h>
55#include <private/qderivedstring_p.h>
56#include <private/qnamedschemacomponent_p.h>
57
58QT_BEGIN_NAMESPACE
59
60namespace QPatternist
61{
62 /**
63 * @short Represents a XSD documentation object.
64 *
65 * This class represents the <em>documentation</em> component of an <em>annotation</em> object
66 * of a XML schema as described <a href="http://www.w3.org/TR/xmlschema11-1/#cAnnotations">here</a>.
67 *
68 * @ingroup Patternist_schema
69 * @author Tobias Koenig <tobias.koenig@nokia.com>
70 */
71 class XsdDocumentation : public NamedSchemaComponent
72 {
73 public:
74 typedef QExplicitlySharedDataPointer<XsdDocumentation> Ptr;
75 typedef QList<XsdDocumentation::Ptr> List;
76
77 /**
78 * Creates a new documentation object.
79 */
80 XsdDocumentation();
81
82 /**
83 * Destroys the documentation object.
84 */
85 ~XsdDocumentation();
86
87 /**
88 * Sets the @p source of the documentation.
89 *
90 * The source points to an URL that contains more
91 * information.
92 */
93 void setSource(const AnyURI::Ptr &source);
94
95 /**
96 * Returns the source of the documentation.
97 */
98 AnyURI::Ptr source() const;
99
100 /**
101 * Sets the @p language of the documentation.
102 */
103 void setLanguage(const DerivedString<TypeLanguage>::Ptr &language);
104
105 /**
106 * Returns the language of the documentation.
107 */
108 DerivedString<TypeLanguage>::Ptr language() const;
109
110 /**
111 * Sets the @p content of the documentation.
112 *
113 * The content can be of abritrary type.
114 */
115 void setContent(const QString &content);
116
117 /**
118 * Returns the content of the documentation.
119 */
120 QString content() const;
121
122 private:
123 AnyURI::Ptr m_source;
124 DerivedString<TypeLanguage>::Ptr m_language;
125 QString m_content;
126 };
127}
128
129QT_END_NAMESPACE
130
131#endif
132

source code of qtxmlpatterns/src/xmlpatterns/schema/qxsddocumentation_p.h