/****************************************************************************

**

** Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtXmlPatterns module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

//

//  W A R N I N G

//  -------------

//

// This file is not part of the Qt API.  It exists purely as an

// implementation detail.  This header file may change from version to

// version without notice, or even be removed.

//

// We mean it.

#ifndef QABSTRACTXMLPULLPROVIDER_H

#define QABSTRACTXMLPULLPROVIDER_H

#include <QtCore/QtGlobal>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

class QXmlItem;

class QXmlName;

class QString;

class QVariant;

template<typename Key, typename Value> class QHash;

namespace QPatternist

{

    class AbstractXmlPullProviderPrivate;

    class AbstractXmlPullProvider

    {

    public:

        AbstractXmlPullProvider();

        virtual ~AbstractXmlPullProvider();

        enum Event

        {

            StartOfInput            = 1,

            AtomicValue             = 1 << 1,

            StartDocument           = 1 << 2,

            EndDocument             = 1 << 3,

            StartElement            = 1 << 4,

            EndElement              = 1 << 5,

            Text                    = 1 << 6,

            ProcessingInstruction   = 1 << 7,

            Comment                 = 1 << 8,

            Attribute               = 1 << 9,

            Namespace               = 1 << 10,

            EndOfInput              = 1 << 11

        };

        virtual Event next() = 0;

        virtual Event current() const = 0;

        virtual QXmlName name() const = 0;

        virtual QVariant atomicValue() const = 0;

        virtual QString stringValue() const = 0;

        virtual QHash<QXmlName, QString> attributes() = 0;

        virtual QHash<QXmlName, QXmlItem> attributeItems() = 0;

        /* *** The functions below are internal. */

    private:

        Q_DISABLE_COPY(AbstractXmlPullProvider)

        AbstractXmlPullProviderPrivate *d;

    };

}

QT_END_NAMESPACE

QT_END_HEADER

#endif