src/xmlpatterns/api/qxmlformatter.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 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 #ifndef QXMLFORMATTER_H
  43 #define QXMLFORMATTER_H
  44
  45 #include <QtXmlPatterns/QXmlSerializer>
  46
  47 QT_BEGIN_HEADER
  48
  49 QT_BEGIN_NAMESPACE
  50
  51 QT_MODULE(XmlPatterns)
  52
  53 class QIODevice;
  54 class QTextCodec;
  55 class QXmlQuery;
  56 class QXmlFormatterPrivate;
  57
  58 class Q_XMLPATTERNS_EXPORT QXmlFormatter : public QXmlSerializer
  59 {
  60 public:
  61     QXmlFormatter(const QXmlQuery &query,
  62                   QIODevice *outputDevice);
  63
  64     virtual void characters(const QStringRef &value);
  65     virtual void comment(const QString &value);
  66     virtual void startElement(const QXmlName &name);
  67     virtual void endElement();
  68
  69     virtual void attribute(const QXmlName &name,
  70                            const QStringRef &value);
  71     virtual void processingInstruction(const QXmlName &name,
  72                                        const QString &value);
  73     virtual void atomicValue(const QVariant &value);
  74     virtual void startDocument();
  75     virtual void endDocument();
  76     virtual void startOfSequence();
  77     virtual void endOfSequence();
  78
  79     int indentationDepth() const;
  80     void setIndentationDepth(int depth);
  81
  82     /* The members below are internal, not part of the public API, and
  83      * unsupported. Using them leads to undefined behavior. */
  84     virtual void item(const QPatternist::Item &item);
  85 private:
  86     inline void startFormattingContent();
  87     Q_DECLARE_PRIVATE(QXmlFormatter)
  88 };
  89
  90 QT_END_NAMESPACE
  91
  92 QT_END_HEADER
  93
  94 #endif