1 /****************************************************************************
3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
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 Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
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 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
40 ****************************************************************************/
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.
52 #ifndef Patternist_XsdDocumentation_H
53 #define Patternist_XsdDocumentation_H
55 #include <private/qanytype_p.h>
56 #include <private/qanyuri_p.h>
57 #include <private/qderivedstring_p.h>
58 #include <private/qnamedschemacomponent_p.h>
67 * @short Represents a XSD documentation object.
69 * This class represents the <em>documentation</em> component of an <em>annotation</em> object
70 * of a XML schema as described <a href="http://www.w3.org/TR/xmlschema11-1/#cAnnotations">here</a>.
72 * @ingroup Patternist_schema
73 * @author Tobias Koenig <tobias.koenig@nokia.com>
75 class XsdDocumentation : public NamedSchemaComponent
78 typedef QExplicitlySharedDataPointer<XsdDocumentation> Ptr;
79 typedef QList<XsdDocumentation::Ptr> List;
82 * Creates a new documentation object.
87 * Destroys the documentation object.
92 * Sets the @p source of the documentation.
94 * The source points to an URL that contains more
97 void setSource(const AnyURI::Ptr &source);
100 * Returns the source of the documentation.
102 AnyURI::Ptr source() const;
105 * Sets the @p language of the documentation.
107 void setLanguage(const DerivedString<TypeLanguage>::Ptr &language);
110 * Returns the language of the documentation.
112 DerivedString<TypeLanguage>::Ptr language() const;
115 * Sets the @p content of the documentation.
117 * The content can be of abritrary type.
119 void setContent(const QString &content);
122 * Returns the content of the documentation.
124 QString content() const;
127 AnyURI::Ptr m_source;
128 DerivedString<TypeLanguage>::Ptr m_language;