1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
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_XsdAnnotation_H
53 #define Patternist_XsdAnnotation_H
55 #include <private/qderivedstring_p.h>
56 #include <private/qxsdapplicationinformation_p.h>
57 #include <private/qxsddocumentation_p.h>
66 * @short Represents a XSD annotation object.
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>.
71 * @ingroup Patternist_schema
72 * @author Tobias Koenig <tobias.koenig@nokia.com>
74 class XsdAnnotation : public NamedSchemaComponent
77 typedef QExplicitlySharedDataPointer<XsdAnnotation> Ptr;
78 typedef QList<XsdAnnotation::Ptr> List;
81 * Sets the @p id of the annotation.
83 void setId(const DerivedString<TypeID>::Ptr &id);
86 * Returns the @p id of the annotation.
88 DerivedString<TypeID>::Ptr id() const;
91 * Adds an application @p information to the annotation.
93 * The application information is meant to be interpreted by
94 * a software system, e.g. other parts of the XML processor pipeline.
96 void addApplicationInformation(const XsdApplicationInformation::Ptr &information);
99 * Returns the list of all application information of the annotation.
101 XsdApplicationInformation::List applicationInformation() const;
104 * Adds a @p documentation to the annotation.
106 * The documentation is meant to be read by human being, e.g. additional
107 * constraints or information about schema components.
109 void addDocumentation(const XsdDocumentation::Ptr &documentation);
112 * Returns the list of all documentations of the annotation.
114 XsdDocumentation::List documentation() const;
117 DerivedString<TypeID>::Ptr m_id;
118 XsdApplicationInformation::List m_applicationInformation;
119 XsdDocumentation::List m_documentations;