Qt 4.8
qxmlquery.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 QXMLQUERY_H
43 #define QXMLQUERY_H
44 
45 #include <QtCore/QUrl>
46 #include <QtXmlPatterns/QAbstractXmlNodeModel>
47 #include <QtXmlPatterns/QAbstractXmlReceiver>
48 #include <QtXmlPatterns/QXmlNamePool>
49 
52 
53 QT_MODULE(XmlPatterns)
54 
57 class QIODevice;
59 class QXmlName;
60 class QXmlNodeIndex;
61 class QXmlQueryPrivate;
62 class QXmlResultItems;
63 class QXmlSerializer;
64 
65 /* The members in the namespace QPatternistSDK are internal, not part of the public API, and
66  * unsupported. Using them leads to undefined behavior. */
67 namespace QPatternistSDK
68 {
69  class TestCase;
70 }
71 
72 namespace QPatternist
73 {
74  class XsdSchemaParser;
75  class XsdValidatingInstanceReader;
76  class VariableLoader;
77 }
78 
80 {
81 public:
83  {
84  XQuery10 = 1,
85  XSLT20 = 2,
86  XmlSchema11IdentityConstraintSelector = 1024,
87  XmlSchema11IdentityConstraintField = 2048,
88  XPath20 = 4096
89  };
90 
91  QXmlQuery();
92  QXmlQuery(const QXmlQuery &other);
93  QXmlQuery(const QXmlNamePool &np);
94  QXmlQuery(QueryLanguage queryLanguage,
95  const QXmlNamePool &np = QXmlNamePool());
96  ~QXmlQuery();
97  QXmlQuery &operator=(const QXmlQuery &other);
98 
99  void setMessageHandler(QAbstractMessageHandler *messageHandler);
101 
102  void setQuery(const QString &sourceCode, const QUrl &documentURI = QUrl());
103  void setQuery(QIODevice *sourceCode, const QUrl &documentURI = QUrl());
104  void setQuery(const QUrl &queryURI, const QUrl &baseURI = QUrl());
105 
106  QXmlNamePool namePool() const;
107 
108  void bindVariable(const QXmlName &name, const QXmlItem &value);
109  void bindVariable(const QString &localName, const QXmlItem &value);
110 
111  void bindVariable(const QXmlName &name, QIODevice *);
112  void bindVariable(const QString &localName, QIODevice *);
113  void bindVariable(const QXmlName &name, const QXmlQuery &query);
114  void bindVariable(const QString &localName, const QXmlQuery &query);
115 
116  bool isValid() const;
117 
118  void evaluateTo(QXmlResultItems *result) const;
119  bool evaluateTo(QAbstractXmlReceiver *callback) const;
120  bool evaluateTo(QStringList *target) const;
121  bool evaluateTo(QIODevice *target) const;
122  bool evaluateTo(QString *output) const;
123 
124  void setUriResolver(const QAbstractUriResolver *resolver);
125  const QAbstractUriResolver *uriResolver() const;
126 
127  void setFocus(const QXmlItem &item);
128  bool setFocus(const QUrl &documentURI);
129  bool setFocus(QIODevice *document);
130  bool setFocus(const QString &focus);
131 
132  void setInitialTemplateName(const QXmlName &name);
133  void setInitialTemplateName(const QString &name);
134  QXmlName initialTemplateName() const;
135 
136  void setNetworkAccessManager(QNetworkAccessManager *newManager);
137  QNetworkAccessManager *networkAccessManager() const;
138 
139  QueryLanguage queryLanguage() const;
140 private:
141  friend class QXmlName;
142  friend class QXmlSerializer;
143  friend class QPatternistSDK::TestCase;
147  template<typename TInputType> friend bool setFocusHelper(QXmlQuery *const queryInstance,
148  const TInputType &focusValue);
150 };
151 
154 
155 #endif
static void callback(AuServer *, AuEventHandlerRec *, AuEvent *e, AuPointer p)
Definition: qsound_x11.cpp:170
#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
QueryLanguage
Specifies whether you want QXmlQuery to interpret the input to setQuery() as an XQuery or as an XSLT ...
Definition: qxmlquery.h:82
The QXmlResultItems class iterates through the results of evaluating an XQuery in QXmlQuery...
The QXmlItem class contains either an XML node or an atomic value.
The QUrl class provides a convenient interface for working with URLs.
Definition: qurl.h:61
The QString class provides a Unicode character string.
Definition: qstring.h:83
The QXmlNamePool class is a table of shared strings referenced by instances of QXmlName.
Definition: qxmlnamepool.h:69
The QAbstractUriResolver class is a callback interface for resolving Uniform Resource Identifiers...
#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
The QStringList class provides a list of strings.
Definition: qstringlist.h:66
The namespace for the internal API of QtXmlPatterns.
QXmlQueryPrivate * d
Definition: qxmlquery.h:149
The QNetworkAccessManager class allows the application to send network requests and receive replies...
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...
#define Q_XMLPATTERNS_EXPORT
Definition: qglobal.h:1459
The QAbstractMessageHandler class provides a callback interface for handling messages.
static void messageHandler(QtMsgType type, const char *msg)
Definition: qtestlog.cpp:121
Implements the parsing of XML schema file.
The validating schema instance reader.
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