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_XsdModelGroup_H
51#define Patternist_XsdModelGroup_H
52
53#include <private/qxsdparticle_p.h>
54#include <private/qxsdterm_p.h>
55
56QT_BEGIN_NAMESPACE
57
58template<typename N> class QList;
59
60namespace QPatternist
61{
62 /**
63 * @short Represents a XSD model group object.
64 *
65 * This class represents the <em>model group</em> object of a XML schema as described
66 * <a href="http://www.w3.org/TR/xmlschema11-1/#cModel_Group_Definitions">here</a>.
67 *
68 * It contains information from either a <em>sequence</em> object, a <em>choice</em> object or an
69 * <em>all</em> object.
70 *
71 * @see <a href="http://www.w3.org/Submission/2004/SUBM-xmlschema-api-20040309/xml-schema-api.html#Interface-XSModelGroup">XML Schema API reference</a>
72 * @ingroup Patternist_schema
73 * @author Tobias Koenig <tobias.koenig@nokia.com>
74 */
75 class XsdModelGroup : public XsdTerm
76 {
77 public:
78 typedef QExplicitlySharedDataPointer<XsdModelGroup> Ptr;
79 typedef QList<XsdModelGroup::Ptr> List;
80
81 /**
82 * Describes the <a href="http://www.w3.org/TR/xmlschema11-1/#mg-compositor">compositor</a> of the model group.
83 */
84 enum ModelCompositor
85 {
86 SequenceCompositor, ///< The model group is a sequence.
87 ChoiceCompositor, ///< The model group is a choice.
88 AllCompositor ///< The model group contains elements only.
89 };
90
91 /**
92 * Creates a new model group object.
93 */
94 XsdModelGroup();
95
96 /**
97 * Returns always @c true, used to avoid dynamic casts.
98 */
99 virtual bool isModelGroup() const;
100
101 /**
102 * Sets the @p compositor of the model group.
103 *
104 * @see ModelCompositor
105 */
106 void setCompositor(ModelCompositor compositor);
107
108 /**
109 * Returns the compositor of the model group.
110 */
111 ModelCompositor compositor() const;
112
113 /**
114 * Sets the list of @p particles of the model group.
115 *
116 * @see <a href="http://www.w3.org/TR/xmlschema11-1/#mg-particles">Particles Definition</a>
117 */
118 void setParticles(const XsdParticle::List &particles);
119
120 /**
121 * Returns the list of particles of the model group.
122 */
123 XsdParticle::List particles() const;
124
125 private:
126 ModelCompositor m_compositor;
127 XsdParticle::List m_particles;
128 };
129}
130
131QT_END_NAMESPACE
132
133#endif
134

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