summaryrefslogtreecommitdiffstats
path: root/src/xmlpatterns/api/qxmlquery.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/xmlpatterns/api/qxmlquery.h')
-rw-r--r--src/xmlpatterns/api/qxmlquery.h147
1 files changed, 147 insertions, 0 deletions
diff --git a/src/xmlpatterns/api/qxmlquery.h b/src/xmlpatterns/api/qxmlquery.h
new file mode 100644
index 0000000000..138819c087
--- /dev/null
+++ b/src/xmlpatterns/api/qxmlquery.h
@@ -0,0 +1,147 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: Qt Software Information (qt-info@nokia.com)
+**
+** This file is part of the QtXmlPatterns module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the either Technology Preview License Agreement or the
+** Beta Release License Agreement.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain
+** additional rights. These rights are described in the Nokia Qt LGPL
+** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
+** package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at qt-sales@nokia.com.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QXMLQUERY_H
+#define QXMLQUERY_H
+
+#include <QtCore/QUrl>
+#include <QtXmlPatterns/QAbstractXmlNodeModel>
+#include <QtXmlPatterns/QAbstractXmlReceiver>
+#include <QtXmlPatterns/QXmlNamePool>
+
+QT_BEGIN_HEADER
+QT_BEGIN_NAMESPACE
+
+QT_MODULE(XmlPatterns)
+
+class QAbstractMessageHandler;
+class QAbstractUriResolver;
+class QIODevice;
+class QNetworkAccessManager;
+class QXmlName;
+class QXmlNodeIndex;
+class QXmlQueryPrivate;
+class QXmlResultItems;
+class QXmlSerializer;
+
+/* The members in the namespace QPatternistSDK are internal, not part of the public API, and
+ * unsupported. Using them leads to undefined behavior. */
+namespace QPatternistSDK
+{
+ class TestCase;
+}
+
+namespace QPatternist
+{
+ class VariableLoader;
+};
+
+class Q_XMLPATTERNS_EXPORT QXmlQuery
+{
+public:
+ enum QueryLanguage
+ {
+ XQuery10 = 1,
+ XSLT20 = 2
+ };
+
+ QXmlQuery();
+ QXmlQuery(const QXmlQuery &other);
+ QXmlQuery(const QXmlNamePool &np);
+ QXmlQuery(QueryLanguage queryLanguage,
+ const QXmlNamePool &np = QXmlNamePool());
+ ~QXmlQuery();
+ QXmlQuery &operator=(const QXmlQuery &other);
+
+ void setMessageHandler(QAbstractMessageHandler *messageHandler);
+ QAbstractMessageHandler *messageHandler() const;
+
+ void setQuery(const QString &sourceCode, const QUrl &documentURI = QUrl());
+ void setQuery(QIODevice *sourceCode, const QUrl &documentURI = QUrl());
+ void setQuery(const QUrl &queryURI, const QUrl &baseURI = QUrl());
+
+ QXmlNamePool namePool() const;
+
+ void bindVariable(const QXmlName &name, const QXmlItem &value);
+ void bindVariable(const QString &localName, const QXmlItem &value);
+
+ void bindVariable(const QXmlName &name, QIODevice *);
+ void bindVariable(const QString &localName, QIODevice *);
+ void bindVariable(const QXmlName &name, const QXmlQuery &query);
+ void bindVariable(const QString &localName, const QXmlQuery &query);
+
+ bool isValid() const;
+
+ void evaluateTo(QXmlResultItems *result) const;
+ bool evaluateTo(QAbstractXmlReceiver *callback) const;
+ bool evaluateTo(QStringList *target) const;
+ bool evaluateTo(QIODevice *target) const;
+ bool evaluateTo(QString *output) const;
+
+ void setUriResolver(const QAbstractUriResolver *resolver);
+ const QAbstractUriResolver *uriResolver() const;
+
+ void setFocus(const QXmlItem &item);
+ bool setFocus(const QUrl &documentURI);
+ bool setFocus(QIODevice *document);
+
+ void setInitialTemplateName(const QXmlName &name);
+ void setInitialTemplateName(const QString &name);
+ QXmlName initialTemplateName() const;
+
+ void setNetworkAccessManager(QNetworkAccessManager *newManager);
+ QNetworkAccessManager *networkAccessManager() const;
+
+ QueryLanguage queryLanguage() const;
+private:
+ friend class QXmlName;
+ friend class QXmlSerializer;
+ friend class QPatternistSDK::TestCase;
+ friend class QPatternist::VariableLoader;
+ template<typename TInputType> friend bool setFocusHelper(QXmlQuery *const queryInstance,
+ const TInputType &focusValue);
+ QXmlQueryPrivate *d;
+};
+
+QT_END_NAMESPACE
+QT_END_HEADER
+
+#endif