Qt 4.8
qxmlserializer.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 QXMLSERIALIZER_H
43 #define QXMLSERIALIZER_H
44 
45 #include <QtXmlPatterns/QAbstractXmlReceiver>
46 
48 
50 
51 QT_MODULE(XmlPatterns)
52 
53 class QIODevice;
54 class QTextCodec;
55 class QXmlQuery;
57 
59 {
60 public:
61  QXmlSerializer(const QXmlQuery &query,
62  QIODevice *outputDevice);
63 
64  virtual void namespaceBinding(const QXmlName &nb);
65 
66  virtual void characters(const QStringRef &value);
67  virtual void comment(const QString &value);
68 
69  virtual void startElement(const QXmlName &name);
70 
71  virtual void endElement();
72 
73  virtual void attribute(const QXmlName &name,
74  const QStringRef &value);
75 
76  virtual void processingInstruction(const QXmlName &name,
77  const QString &value);
78 
79  virtual void atomicValue(const QVariant &value);
80 
81  virtual void startDocument();
82  virtual void endDocument();
83  virtual void startOfSequence();
84  virtual void endOfSequence();
85 
86  QIODevice *outputDevice() const;
87 
88  void setCodec(const QTextCodec *codec);
89  const QTextCodec *codec() const;
90 
91  /* The members below are internal, not part of the public API, and
92  * unsupported. Using them leads to undefined behavior. */
93  virtual void item(const QPatternist::Item &item);
94 protected:
96 
97 private:
98  inline bool isBindingInScope(const QXmlName nb) const;
99 
103  enum State
104  {
111 
115  InsideDocumentElement
116  };
117 
122  inline bool atDocumentRoot() const;
123 
128  inline void startContent();
129 
133  void writeEscaped(const QString &toEscape);
134 
138  inline void writeEscapedAttribute(const QString &toEscape);
139 
143  inline void write(const QXmlName &name);
144 
145  inline void write(const char *const chars);
149  inline void write(const QString &content);
150 
152 };
153 
155 
157 
158 #endif
The QVariant class acts like a union for the most common Qt data types.
Definition: qvariant.h:92
double d
Definition: qnumeric_p.h:62
virtual void characters(const QStringRef &value)=0
This callback is called when a text node appears in the XQuery Sequence.
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
#define QT_MODULE(x)
Definition: qglobal.h:2783
#define QT_BEGIN_HEADER
Definition: qglobal.h:136
virtual void attribute(const QXmlName &name, const QStringRef &value)=0
This callback is called when an attribute node appears in the XQuery Sequence.
virtual void startElement(const QXmlName &name)=0
This callback is called when a new element node appears in the XQuery Sequence.
virtual void processingInstruction(const QXmlName &target, const QString &value)=0
This callback is called when a processing instruction appears in the XQuery Sequence.
The QString class provides a Unicode character string.
Definition: qstring.h:83
virtual void comment(const QString &value)=0
This callback is called when a comment node appears in the XQuery Sequence.
virtual void endOfSequence()=0
This callback is called once only, right after the XQuery Sequence ends.
#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 endDocument()=0
This callback is called when the end of a document node appears in the XQuery Sequence.
static QTextCodec * codec(MYSQL *mysql)
Definition: qsql_mysql.cpp:220
virtual void startOfSequence()=0
This callback is called once only, right before the XQuery Sequence begins.
virtual void atomicValue(const QVariant &value)=0
This callback is called when an atomic value appears in the XQuery Sequence.
The State element defines configurations of objects and properties.
The QStringRef class provides a thin wrapper around QString substrings.
Definition: qstring.h:1099
virtual void startDocument()=0
This callback is called when a document node appears in the XQuery Sequence.
The QXmlName class represents the name of an XML node, in an efficient, namespace-aware way...
Definition: qxmlname.h:58
The QAbstractXmlReceiver class provides a callback interface for transforming the output of a QXmlQue...
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 item(const QPatternist::Item &item)
#define Q_DECLARE_PRIVATE(Class)
Definition: qglobal.h:2467
virtual void namespaceBinding(const QXmlName &name)=0
This callback is called when a namespace binding is in scope of an element.
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
The QXmlQuery class performs XQueries on XML data, or on non-XML data modeled to look like XML...
Definition: qxmlquery.h:79
virtual void endElement()=0
This callback is called when the end of an element node appears in the XQuery Sequence.