src/xmlpatterns/schema/qxsdterm_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   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 Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/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 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  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_XsdTerm_H
  53 #define Patternist_XsdTerm_H
  54
  55 #include <private/qnamedschemacomponent_p.h>
  56 #include <private/qxsdannotated_p.h>
  57
  58 QT_BEGIN_HEADER
  59
  60 QT_BEGIN_NAMESPACE
  61
  62 namespace QPatternist
  63 {
  64     /**
  65      * @short A base class for all particles of a model group.
  66      *
  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.
  70      *
  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>
  74      */
  75     class XsdTerm : public NamedSchemaComponent, public XsdAnnotated
  76     {
  77         public:
  78             typedef QExplicitlySharedDataPointer<XsdTerm> Ptr;
  79
  80             /**
  81              * Returns @c true if the term is an element, @c false otherwise.
  82              */
  83             virtual bool isElement() const;
  84
  85             /**
  86              * Returns @c true if the term is a model group (group tag), @c false otherwise.
  87              */
  88             virtual bool isModelGroup() const;
  89
  90             /**
  91              * Returns @c true if the term is a wildcard (any tag), @c false otherwise.
  92              */
  93             virtual bool isWildcard() const;
  94
  95             /**
  96              * Returns @c true if the term is a reference, @c false otherwise.
  97              *
  98              * @note The reference term is only used internally as helper during type resolving.
  99              */
 100             virtual bool isReference() const;
 101
 102         protected:
 103             /**
 104              * This constructor only exists to ensure this class is subclassed.
 105              */
 106             inline XsdTerm() {};
 107     };
 108 }
 109
 110 QT_END_NAMESPACE
 111
 112 QT_END_HEADER
 113
 114 #endif