src/xmlpatterns/schema/qxsdalternative_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  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_XsdAlternative_H
  53 #define Patternist_XsdAlternative_H
  54
  55 #include <private/qnamedschemacomponent_p.h>
  56 #include <private/qschematype_p.h>
  57 #include <private/qxsdannotated_p.h>
  58 #include <private/qxsdxpathexpression_p.h>
  59
  60 #include <QtCore/QList>
  61
  62 QT_BEGIN_HEADER
  63
  64 QT_BEGIN_NAMESPACE
  65
  66 namespace QPatternist
  67 {
  68     /**
  69      * @short Represents a XSD alternative object.
  70      *
  71      * @ingroup Patternist_schema
  72      * @author Tobias Koenig <tobias.koenig@nokia.com>
  73      */
  74     class XsdAlternative : public NamedSchemaComponent, public XsdAnnotated
  75     {
  76         public:
  77             typedef QExplicitlySharedDataPointer<XsdAlternative> Ptr;
  78             typedef QList<XsdAlternative::Ptr> List;
  79
  80             /**
  81              * Sets the xpath @p test of the alternative.
  82              *
  83              * @see <a href="http://www.w3.org/TR/xmlschema11-1/#tac-test">Test Definition</a>
  84              */
  85             void setTest(const XsdXPathExpression::Ptr &test);
  86
  87             /**
  88              * Returns the xpath test of the alternative.
  89              */
  90             XsdXPathExpression::Ptr test() const;
  91
  92             /**
  93              * Sets the @p type of the alternative.
  94              *
  95              * @see <a href="http://www.w3.org/TR/xmlschema11-1/#tac-type_definition">Type Definition</a>
  96              */
  97             void setType(const SchemaType::Ptr &type);
  98
  99             /**
 100              * Returns the type of the alternative.
 101              */
 102             SchemaType::Ptr type() const;
 103
 104         private:
 105             XsdXPathExpression::Ptr m_test;
 106             SchemaType::Ptr         m_type;
 107     };
 108 }
 109
 110 QT_END_NAMESPACE
 111
 112 QT_END_HEADER
 113
 114 #endif