src/xmlpatterns/schema/qxsduserschematype_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_XsdUserSchemaType_H
  53 #define Patternist_XsdUserSchemaType_H
  54
  55 #include <private/qnamedschemacomponent_p.h>
  56 #include <private/qschematype_p.h>
  57 #include <private/qxsdannotated_p.h>
  58
  59 template<typename N, typename M> class QHash;
  60 template<typename N> class QList;
  61
  62 QT_BEGIN_HEADER
  63
  64 QT_BEGIN_NAMESPACE
  65
  66 namespace QPatternist
  67 {
  68     /**
  69      * @short A base class for all user defined simple and complex types.
  70      *
  71      * This class was introduced to combine the SchemaType class and the
  72      * NamedSchemaComponent class without explicit inheritance.
  73      *
  74      * @ingroup Patternist_schema
  75      * @author Tobias Koenig <tobias.koenig@nokia.com>
  76      */
  77     template<typename TSuperClass>
  78     class XsdUserSchemaType : public TSuperClass, public NamedSchemaComponent, public XsdAnnotated
  79     {
  80         public:
  81             typedef QExplicitlySharedDataPointer<XsdUserSchemaType> Ptr;
  82
  83             /**
  84              * Sets the @p name of the type.
  85              */
  86             void setName(const QXmlName &name);
  87
  88             /**
  89              * Returns the name of the type.
  90              *
  91              * @param namePool The pool the name belongs to.
  92              */
  93             virtual QXmlName name(const NamePool::Ptr &namePool) const;
  94
  95             /**
  96              * Returns the display name of the type.
  97              *
  98              * @param namePool The pool the name belongs to.
  99              */
 100             virtual QString displayName(const NamePool::Ptr &namePool) const;
 101
 102             /**
 103              * Sets the derivation @p constraints of the type.
 104              */
 105             void setDerivationConstraints(const SchemaType::DerivationConstraints &constraints);
 106
 107             /**
 108              * Returns the derivation constraints of the type.
 109              */
 110             SchemaType::DerivationConstraints derivationConstraints() const;
 111
 112         private:
 113             QXmlName                          m_name;
 114             SchemaType::DerivationConstraints m_derivationConstraints;
 115     };
 116
 117     #include "qxsduserschematype.cpp"
 118 }
 119
 120 QT_END_NAMESPACE
 121
 122 QT_END_HEADER
 123
 124 #endif