1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
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.
52 #ifndef Patternist_XsdParticle_H
53 #define Patternist_XsdParticle_H
55 #include <private/qnamedschemacomponent_p.h>
56 #include <private/qxsdterm_p.h>
58 #include <QtCore/QList>
67 * @short Represents a XSD particle object.
69 * This class represents the <em>particle</em> object of a XML schema as described
70 * <a href="http://www.w3.org/TR/xmlschema11-1/#cParticles">here</a>.
72 * It contains information about the number of occurrence and a reference to
73 * either an <em>element</em> object, a <em>group</em> object or an <em>any</em> object.
75 * @see <a href="http://www.w3.org/Submission/2004/SUBM-xmlschema-api-20040309/xml-schema-api.html#Interface-XSParticle">XML Schema API reference</a>
76 * @ingroup Patternist_schema
77 * @author Tobias Koenig <tobias.koenig@nokia.com>
79 class XsdParticle : public NamedSchemaComponent
82 typedef QExplicitlySharedDataPointer<XsdParticle> Ptr;
83 typedef QList<XsdParticle::Ptr> List;
86 * Creates a new particle object.
91 * Sets the minimum @p occurrence of the particle.
93 * @see <a href="http://www.w3.org/TR/xmlschema11-1/#p-min_occurs">Minimum Occurrence Definition</a>
95 void setMinimumOccurs(unsigned int occurrence);
98 * Returns the minimum occurrence of the particle.
100 unsigned int minimumOccurs() const;
103 * Sets the maximum @p occurrence of the particle.
105 * @see <a href="http://www.w3.org/TR/xmlschema11-1/#p-max_occurs">Maximum Occurrence Definition</a>
107 void setMaximumOccurs(unsigned int occurrence);
110 * Returns the maximum occurrence of the particle.
112 * @note This value has only a meaning if maximumOccursUnbounded is @c false.
114 unsigned int maximumOccurs() const;
117 * Sets whether the maximum occurrence of the particle is unbounded.
119 * @see <a href="http://www.w3.org/TR/xmlschema11-1/#p-max_occurs">Maximum Occurrence Definition</a>
121 void setMaximumOccursUnbounded(bool unbounded);
124 * Returns whether the maximum occurrence of the particle is unbounded.
126 bool maximumOccursUnbounded() const;
129 * Sets the @p term of the particle.
131 * The term can be an element, a model group or an element wildcard.
133 * @see <a href="http://www.w3.org/TR/xmlschema11-1/#p-term">Term Definition</a>
135 void setTerm(const XsdTerm::Ptr &term);
138 * Returns the term of the particle.
140 XsdTerm::Ptr term() const;
143 unsigned int m_minimumOccurs;
144 unsigned int m_maximumOccurs;
145 bool m_maximumOccursUnbounded;