src/xmlpatterns/api/qxmlformatter.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  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
  52 class QIODevice;
  53 class QTextCodec;
  54 class QXmlQuery;
  55 class QXmlFormatterPrivate;
  56
  57 class Q_XMLPATTERNS_EXPORT QXmlFormatter : public QXmlSerializer
  58 {
  59 public:
  60     QXmlFormatter(const QXmlQuery &query,
  61                   QIODevice *outputDevice);
  62
  63     virtual void characters(const QStringRef &value);
  64     virtual void comment(const QString &value);
  65     virtual void startElement(const QXmlName &name);
  66     virtual void endElement();
  67
  68     virtual void attribute(const QXmlName &name,
  69                            const QStringRef &value);
  70     virtual void processingInstruction(const QXmlName &name,
  71                                        const QString &value);
  72     virtual void atomicValue(const QVariant &value);
  73     virtual void startDocument();
  74     virtual void endDocument();
  75     virtual void startOfSequence();
  76     virtual void endOfSequence();
  77
  78     int indentationDepth() const;
  79     void setIndentationDepth(int depth);
  80
  81     /* The members below are internal, not part of the public API, and
  82      * unsupported. Using them leads to undefined behavior. */
  83     virtual void item(const QPatternist::Item &item);
  84 private:
  85     inline void startFormattingContent();
  86     Q_DECLARE_PRIVATE(QXmlFormatter)
  87 };
  88
  89 QT_END_NAMESPACE
  90
  91 QT_END_HEADER
  92
  93 #endif