src/xmlpatterns/type/qnamedschemacomponent_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   8 **
   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.
  17 **
  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.
  21 **
  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.
  29 **
  30 ** Other Usage
  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.
  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_NamedSchemaComponent_H
  53 #define Patternist_NamedSchemaComponent_H
  54
  55 #include <private/qnamepool_p.h>
  56 #include <private/qschemacomponent_p.h>
  57 #include <QXmlName>
  58
  59 QT_BEGIN_HEADER
  60
  61 QT_BEGIN_NAMESPACE
  62
  63 namespace QPatternist
  64 {
  65     /**
  66      * @short Base class for all named components that can appear in a W3C XML Schema.
  67      *
  68      * @ingroup Patternist_types
  69      * @author Tobias Koenig <tobias.koenig@nokia.com>
  70      */
  71     class NamedSchemaComponent : public SchemaComponent
  72     {
  73         public:
  74             typedef QExplicitlySharedDataPointer<NamedSchemaComponent> Ptr;
  75
  76             /**
  77              * Describes the blocking constraints that are given by the 'block' attributes.
  78              */
  79             enum BlockingConstraint
  80             {
  81                 RestrictionConstraint = 1,
  82                 ExtensionConstraint = 2,
  83                 SubstitutionConstraint = 4
  84             };
  85             Q_DECLARE_FLAGS(BlockingConstraints, BlockingConstraint)
  86
  87             /**
  88              * Creates a new named schema component.
  89              */
  90             NamedSchemaComponent();
  91
  92             /**
  93              * Destroys the named schema component.
  94              */
  95             virtual ~NamedSchemaComponent();
  96
  97             /**
  98              * Sets the @p name of the schema component.
  99              */
 100             void setName(const QXmlName &name);
 101
 102             /**
 103              * Returns the name of the schema component.
 104              *
 105              * @param namePool The name pool the name belongs to.
 106              */
 107             virtual QXmlName name(const NamePool::Ptr &namePool) const;
 108
 109             /**
 110              * Returns the display name of the schema component.
 111              *
 112              * @param namePool The name pool the name belongs to.
 113              */
 114             virtual QString displayName(const NamePool::Ptr &namePool) const;
 115
 116         private:
 117             QXmlName m_name;
 118     };
 119
 120     Q_DECLARE_OPERATORS_FOR_FLAGS(NamedSchemaComponent::BlockingConstraints)
 121 }
 122
 123 QT_END_NAMESPACE
 124
 125 QT_END_HEADER
 126
 127 #endif