src/xmlpatterns/api/qabstractxmlpullprovider_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2008 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 QABSTRACTXMLPULLPROVIDER_H
  53 #define QABSTRACTXMLPULLPROVIDER_H
  54
  55 #include <QtCore/QtGlobal>
  56
  57 QT_BEGIN_HEADER
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 class QXmlItem;
  62 class QXmlName;
  63 class QString;
  64 class QVariant;
  65 template<typename Key, typename Value> class QHash;
  66
  67 namespace QPatternist
  68 {
  69     class AbstractXmlPullProviderPrivate;
  70
  71     class AbstractXmlPullProvider
  72     {
  73     public:
  74         AbstractXmlPullProvider();
  75         virtual ~AbstractXmlPullProvider();
  76
  77         enum Event
  78         {
  79             StartOfInput            = 1,
  80             AtomicValue             = 1 << 1,
  81             StartDocument           = 1 << 2,
  82             EndDocument             = 1 << 3,
  83             StartElement            = 1 << 4,
  84             EndElement              = 1 << 5,
  85             Text                    = 1 << 6,
  86             ProcessingInstruction   = 1 << 7,
  87             Comment                 = 1 << 8,
  88             Attribute               = 1 << 9,
  89             Namespace               = 1 << 10,
  90             EndOfInput              = 1 << 11
  91         };
  92
  93         virtual Event next() = 0;
  94         virtual Event current() const = 0;
  95         virtual QXmlName name() const = 0;
  96         virtual QVariant atomicValue() const = 0;
  97         virtual QString stringValue() const = 0;
  98
  99         virtual QHash<QXmlName, QString> attributes() = 0;
 100         virtual QHash<QXmlName, QXmlItem> attributeItems() = 0;
 101
 102         /* *** The functions below are internal. */
 103     private:
 104         Q_DISABLE_COPY(AbstractXmlPullProvider)
 105         AbstractXmlPullProviderPrivate *d;
 106     };
 107 }
 108
 109 QT_END_NAMESPACE
 110
 111 QT_END_HEADER
 112
 113 #endif