Qt 4.8
qabstractxmlpullprovider_p.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 //
43 // W A R N I N G
44 // -------------
45 //
46 // This file is not part of the Qt API. It exists purely as an
47 // implementation detail. This header file may change from version to
48 // version without notice, or even be removed.
49 //
50 // We mean it.
51 
52 #ifndef QABSTRACTXMLPULLPROVIDER_H
53 #define QABSTRACTXMLPULLPROVIDER_H
54 
55 #include <QtCore/QtGlobal>
56 
58 
60 
61 class QXmlItem;
62 class QXmlName;
63 class QString;
64 class QVariant;
65 template<typename Key, typename Value> class QHash;
66 
67 namespace QPatternist
68 {
69  class AbstractXmlPullProviderPrivate;
70 
72  {
73  public:
75  virtual ~AbstractXmlPullProvider();
76 
77  enum Event
78  {
80  AtomicValue = 1 << 1,
81  StartDocument = 1 << 2,
82  EndDocument = 1 << 3,
83  StartElement = 1 << 4,
84  EndElement = 1 << 5,
85  Text = 1 << 6,
87  Comment = 1 << 8,
88  Attribute = 1 << 9,
89  Namespace = 1 << 10,
90  EndOfInput = 1 << 11
91  };
92 
93  virtual Event next() = 0;
94  virtual Event current() const = 0;
95  virtual QXmlName name() const = 0;
96  virtual QVariant atomicValue() const = 0;
97  virtual QString stringValue() const = 0;
98 
101 
102  /* *** The functions below are internal. */
103  private:
105  AbstractXmlPullProviderPrivate *d;
106  };
107 }
108 
110 
112 
113 #endif
The QVariant class acts like a union for the most common Qt data types.
Definition: qvariant.h:92
virtual ~AbstractXmlPullProvider()
Destructs this AbstractXmlPullProvider.
virtual QString stringValue() const =0
If current() is Text, the text node&#39;s value is returned.
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
#define QT_BEGIN_HEADER
Definition: qglobal.h:136
AbstractXmlPullProvider()
Constucts a AbstractXmlPullProvider instance.
The QXmlItem class contains either an XML node or an atomic value.
virtual QVariant atomicValue() const =0
If current() event is AtomicValue, the atomic value is returned as a QVariant.
#define Q_DISABLE_COPY(Class)
Disables the use of copy constructors and assignment operators for the given Class.
Definition: qglobal.h:2523
The QString class provides a Unicode character string.
Definition: qstring.h:83
The QHash class is a template class that provides a hash-table-based dictionary.
Definition: qdatastream.h:66
#define QT_BEGIN_NAMESPACE
This macro expands to.
Definition: qglobal.h:89
Base class for all classes representing atomic values.
Definition: qitem_p.h:118
virtual Event current() const =0
Returns the event that next() returned the last time it was called.
virtual QHash< QXmlName, QXmlItem > attributeItems()=0
The namespace for the internal API of QtXmlPatterns.
virtual QHash< QXmlName, QString > attributes()=0
If the current() is Element, the attributes of the element are returned, an empty list of attributes ...
The QXmlName class represents the name of an XML node, in an efficient, namespace-aware way...
Definition: qxmlname.h:58
virtual Event next()=0
Advances this AbstractXmlPullProvider, and returns the new event.
virtual QXmlName name() const =0
If the current event is StartElement, EndElement, ProcessingInstruction, Attribute, or Namespace, the node&#39;s name is returned.
#define QT_END_HEADER
Definition: qglobal.h:137
The Text item allows you to add formatted text to a scene.