src/xmlpatterns/schema/qxsdmodelgroup_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  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 <private/qxsdparticle_p.h>
  56 #include <private/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