src/xmlpatterns/api/qabstractxmlpullprovider_p.h
changeset 0 1918ee327afb
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     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 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    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 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