1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://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 http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://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 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file.  Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
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_XsdNotation_H
53 #define Patternist_XsdNotation_H
54 
55 #include "qanyuri_p.h"
56 #include "qderivedstring_p.h"
57 #include "qnamedschemacomponent_p.h"
58 #include "qxsdannotated_p.h"
59 
60 #include <QtCore/QList>
61 
62 QT_BEGIN_HEADER
63 
64 QT_BEGIN_NAMESPACE
65 
66 namespace QPatternist
67 {
68     /**
69      * @short Represents a XSD notation object, which should not
70      * be confused with the atomic type @c xs:NOTATION.
71      *
72      * This class represents the <em>notation</em> object of a XML schema as described
73      * <a href="http://www.w3.org/TR/xmlschema11-1/#cNotation_Declarations">here</a>.
74      *
75      * @see <a href="http://www.w3.org/Submission/2004/SUBM-xmlschema-api-20040309/xml-schema-api.html#XS-NotationDecl">XML Schema API reference</a>
76      * @ingroup Patternist_schema
77      * @author Tobias Koenig <tobias.koenig@nokia.com>
78      */
79     class XsdNotation : public NamedSchemaComponent, public XsdAnnotated
80     {
81         public:
82             typedef QExplicitlySharedDataPointer<XsdNotation> Ptr;
83             typedef QList<XsdNotation::Ptr> List;
84 
85             /**
86              * Sets the public @p identifier of the notation.
87              *
88              * @see <a href="http://www.w3.org/TR/xmlschema11-1/#nd-public_identifier">Public Identifier Definition</a>
89              */
90             void setPublicId(const DerivedString<TypeToken>::Ptr &identifier);
91 
92             /**
93              * Returns the public identifier of the notation.
94              */
95             DerivedString<TypeToken>::Ptr publicId() const;
96 
97             /**
98              * Sets the system @p identifier of the notation.
99              *
100              * @see <a href="http://www.w3.org/TR/xmlschema11-1/#nd-system_identifier">System Identifier Definition</a>
101              */
102             void setSystemId(const AnyURI::Ptr &identifier);
103 
104             /**
105              * Returns the system identifier of the notation.
106              */
107             AnyURI::Ptr systemId() const;
108 
109         private:
110             DerivedString<TypeToken>::Ptr m_publicId;
111             AnyURI::Ptr m_systemId;
112     };
113 }
114 
115 QT_END_NAMESPACE
116 
117 QT_END_HEADER
118 
119 #endif
120