1 /****************************************************************************
3 ** Copyright (C) 2008 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_XsdTerm_H
53 #define Patternist_XsdTerm_H
55 #include <private/qnamedschemacomponent_p.h>
56 #include <private/qxsdannotated_p.h>
65 * @short A base class for all particles of a model group.
67 * This class is the base class for all particles of a model group
68 * as the <em>element</em>, <em>group</em> or <em>any</em> tag, it is not supposed to
69 * be instantiated directly.
71 * @see <a href="http://www.w3.org/Submission/2004/SUBM-xmlschema-api-20040309/xml-schema-api.html#Interface-XSTerm">XML Schema API reference</a>
72 * @ingroup Patternist_schema
73 * @author Tobias Koenig <tobias.koenig@nokia.com>
75 class XsdTerm : public NamedSchemaComponent, public XsdAnnotated
78 typedef QExplicitlySharedDataPointer<XsdTerm> Ptr;
81 * Returns @c true if the term is an element, @c false otherwise.
83 virtual bool isElement() const;
86 * Returns @c true if the term is a model group (group tag), @c false otherwise.
88 virtual bool isModelGroup() const;
91 * Returns @c true if the term is a wildcard (any tag), @c false otherwise.
93 virtual bool isWildcard() const;
96 * Returns @c true if the term is a reference, @c false otherwise.
98 * @note The reference term is only used internally as helper during type resolving.
100 virtual bool isReference() const;
104 * This constructor only exists to ensure this class is subclassed.