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_NamedSchemaComponent_H
51 #define Patternist_NamedSchemaComponent_H
52 
53 #include <private/qnamepool_p.h>
54 #include <private/qschemacomponent_p.h>
55 #include <QXmlName>
56 
57 QT_BEGIN_NAMESPACE
58 
59 namespace QPatternist
60 {
61     /**
62      * @short Base class for all named components that can appear in a W3C XML Schema.
63      *
64      * @ingroup Patternist_types
65      * @author Tobias Koenig <tobias.koenig@nokia.com>
66      */
67     class NamedSchemaComponent : public SchemaComponent
68     {
69         public:
70             typedef QExplicitlySharedDataPointer<NamedSchemaComponent> Ptr;
71 
72             /**
73              * Describes the blocking constraints that are given by the 'block' attributes.
74              */
75             enum BlockingConstraint
76             {
77                 RestrictionConstraint = 1,
78                 ExtensionConstraint = 2,
79                 SubstitutionConstraint = 4
80             };
81             Q_DECLARE_FLAGS(BlockingConstraints, BlockingConstraint)
82 
83             /**
84              * Creates a new named schema component.
85              */
86             NamedSchemaComponent();
87 
88             /**
89              * Destroys the named schema component.
90              */
91             virtual ~NamedSchemaComponent();
92 
93             /**
94              * Sets the @p name of the schema component.
95              */
96             void setName(const QXmlName &name);
97 
98             /**
99              * Returns the name of the schema component.
100              *
101              * @param namePool The name pool the name belongs to.
102              */
103             virtual QXmlName name(const NamePool::Ptr &namePool) const;
104 
105             /**
106              * Returns the display name of the schema component.
107              *
108              * @param namePool The name pool the name belongs to.
109              */
110             virtual QString displayName(const NamePool::Ptr &namePool) const;
111 
112         private:
113             QXmlName m_name;
114     };
115 
116     Q_DECLARE_OPERATORS_FOR_FLAGS(NamedSchemaComponent::BlockingConstraints)
117 }
118 
119 QT_END_NAMESPACE
120 
121 #endif
122