src/xmlpatterns/api/qabstractxmlreceiver.h
changeset 0 1918ee327afb
child 4 3b1da2848fc7
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 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 #ifndef QABSTRACTXMLRECEIVER_H
       
    43 #define QABSTRACTXMLRECEIVER_H
       
    44 
       
    45 #include <QtCore/QVariant>
       
    46 #include <QtCore/QScopedPointer>
       
    47 #include <QtXmlPatterns/QXmlNodeModelIndex>
       
    48 
       
    49 QT_BEGIN_HEADER
       
    50 
       
    51 QT_BEGIN_NAMESPACE
       
    52 
       
    53 QT_MODULE(XmlPatterns)
       
    54 
       
    55 class QAbstractXmlReceiverPrivate;
       
    56 class QXmlName;
       
    57 
       
    58 namespace QPatternist
       
    59 {
       
    60     class Item;
       
    61 }
       
    62 
       
    63 class Q_XMLPATTERNS_EXPORT QAbstractXmlReceiver
       
    64 {
       
    65 public:
       
    66     QAbstractXmlReceiver();
       
    67 
       
    68     virtual ~QAbstractXmlReceiver();
       
    69 
       
    70     virtual void startElement(const QXmlName &name) = 0;
       
    71     virtual void endElement() = 0;
       
    72     virtual void attribute(const QXmlName &name,
       
    73                            const QStringRef &value) = 0;
       
    74     virtual void comment(const QString &value) = 0;
       
    75     virtual void characters(const QStringRef &value) = 0;
       
    76     virtual void startDocument() = 0;
       
    77     virtual void endDocument() = 0;
       
    78 
       
    79     virtual void processingInstruction(const QXmlName &target,
       
    80                                        const QString &value) = 0;
       
    81 
       
    82     virtual void atomicValue(const QVariant &value) = 0;
       
    83     virtual void namespaceBinding(const QXmlName &name) = 0;
       
    84     virtual void startOfSequence() = 0;
       
    85     virtual void endOfSequence() = 0;
       
    86 
       
    87     /* The members below are internal, not part of the public API, and
       
    88      * unsupported. Using them leads to undefined behavior. */
       
    89     virtual void whitespaceOnly(const QStringRef &value);
       
    90     virtual void item(const QPatternist::Item &item);
       
    91 
       
    92 protected:
       
    93     QAbstractXmlReceiver(QAbstractXmlReceiverPrivate *d);
       
    94     QScopedPointer<QAbstractXmlReceiverPrivate> d_ptr;
       
    95 
       
    96     void sendAsNode(const QPatternist::Item &outputItem);
       
    97 private:
       
    98     template<const QXmlNodeModelIndex::Axis axis>
       
    99     void sendFromAxis(const QXmlNodeModelIndex &node);
       
   100     Q_DISABLE_COPY(QAbstractXmlReceiver)
       
   101 };
       
   102 
       
   103 QT_END_NAMESPACE
       
   104 
       
   105 QT_END_HEADER
       
   106 
       
   107 #endif