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