Qt 4.8
qxmlformatter.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 
42 #ifndef QXMLFORMATTER_H
43 #define QXMLFORMATTER_H
44 
45 #include <QtXmlPatterns/QXmlSerializer>
46 
48 
50 
51 QT_MODULE(XmlPatterns)
52 
53 class QIODevice;
54 class QTextCodec;
55 class QXmlQuery;
57 
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();
88 };
89 
91 
93 
94 #endif
The QVariant class acts like a union for the most common Qt data types.
Definition: qvariant.h:92
virtual void attribute(const QXmlName &name, const QStringRef &value)
Reimplemented Function
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
#define QT_MODULE(x)
Definition: qglobal.h:2783
virtual void characters(const QStringRef &value)
Reimplemented Function
virtual void comment(const QString &value)
Reimplemented Function
#define QT_BEGIN_HEADER
Definition: qglobal.h:136
The QString class provides a Unicode character string.
Definition: qstring.h:83
virtual void endDocument()
Reimplemented Function
virtual void endElement()
Reimplemented Function
virtual void processingInstruction(const QXmlName &name, const QString &value)
Reimplemented Function
virtual void startOfSequence()
Reimplemented Function
#define QT_BEGIN_NAMESPACE
This macro expands to.
Definition: qglobal.h:89
The QXmlSerializer class is an implementation of QAbstractXmlReceiver for transforming XQuery output ...
const char * name
virtual void item(const QPatternist::Item &item)
The QStringRef class provides a thin wrapper around QString substrings.
Definition: qstring.h:1099
The QXmlName class represents the name of an XML node, in an efficient, namespace-aware way...
Definition: qxmlname.h:58
Represents an item in the XPath 2.0 Data Model.
Definition: qitem_p.h:182
#define Q_XMLPATTERNS_EXPORT
Definition: qglobal.h:1459
virtual void endOfSequence()
Reimplemented Function
virtual void atomicValue(const QVariant &value)
Reimplemented Function
The QXmlFormatter class is an implementation of QXmlSerializer for transforming XQuery output into fo...
Definition: qxmlformatter.h:58
virtual void startDocument()
Reimplemented Function
#define Q_DECLARE_PRIVATE(Class)
Definition: qglobal.h:2467
The QTextCodec class provides conversions between text encodings.
Definition: qtextcodec.h:62
The QIODevice class is the base interface class of all I/O devices in Qt.
Definition: qiodevice.h:66
#define QT_END_HEADER
Definition: qglobal.h:137
virtual void startElement(const QXmlName &name)
Reimplemented Function
The QXmlQuery class performs XQueries on XML data, or on non-XML data modeled to look like XML...
Definition: qxmlquery.h:79