summaryrefslogtreecommitdiff
path: root/src/xmlpatterns/api/qabstracturiresolver.cpp
diff options
context:
space:
mode:
authorQt by Nokia <qt-info@nokia.com>2011-04-27 12:05:43 +0200
committeraxis <qt-info@nokia.com>2011-04-27 12:05:43 +0200
commite1b2c9deb5943faae2b29be6a5c006f75bb73f06 (patch)
treefc79e45367c0a8fc71185e9afc33f7503a58653c /src/xmlpatterns/api/qabstracturiresolver.cpp
downloadqtxmlpatterns-e1b2c9deb5943faae2b29be6a5c006f75bb73f06.tar.gz
Initial import from the monolithic Qt.
This is the beginning of revision history for this module. If you want to look at revision history older than this, please refer to the Qt Git wiki for how to use Git history grafting. At the time of writing, this wiki is located here: http://qt.gitorious.org/qt/pages/GitIntroductionWithQt If you have already performed the grafting and you don't see any history beyond this commit, try running "git log" with the "--follow" argument. Branched from the monolithic repo, Qt master branch, at commit 896db169ea224deb96c59ce8af800d019de63f12
Diffstat (limited to 'src/xmlpatterns/api/qabstracturiresolver.cpp')
-rw-r--r--src/xmlpatterns/api/qabstracturiresolver.cpp111
1 files changed, 111 insertions, 0 deletions
diff --git a/src/xmlpatterns/api/qabstracturiresolver.cpp b/src/xmlpatterns/api/qabstracturiresolver.cpp
new file mode 100644
index 0000000..baa65b3
--- /dev/null
+++ b/src/xmlpatterns/api/qabstracturiresolver.cpp
@@ -0,0 +1,111 @@
+/****************************************************************************
+**
+** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (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 Technology Preview License Agreement accompanying
+** this package.
+**
+** 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.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QUrl>
+
+#include "qabstracturiresolver.h"
+
+QT_BEGIN_NAMESPACE
+
+/*!
+ \class QAbstractUriResolver
+ \brief The QAbstractUriResolver class is a callback interface for resolving Uniform Resource Identifiers.
+ \since 4.4
+ \reentrant
+ \ingroup xml-tools
+
+ A Uniform Resource Identifier (URI) is a string that uniquely
+ identifies a resource. URIs are versatile global identifiers. It is
+ often useful to transform a URI that identifies something logical
+ into a URI that locates something physical (a URL), or to simply map
+ a URI to a different URI. QAbstractUriResolver::resolve() provides
+ this functionality.
+
+ For example, one could write a QAbstractUriResolver subclass that
+ rewrites library ISBN number URIs as book title URLs, e.g.,
+ \e{urn:isbn:0-345-33973-8} would be rewritten as
+ \e{file:///books/returnOfTheKing.doc}. Or a QAbstractUriResolver
+ subclass could be written for a web browser to let the web browser
+ protect the user's private files by mapping incoming requests for
+ them to null URIs.
+
+ \sa {http://en.wikipedia.org/wiki/Uniform_Resource_Identifier}
+*/
+
+/*!
+ Constructs a QAbstractUriResolver with the specified \a parent.
+ */
+QAbstractUriResolver::QAbstractUriResolver(QObject *parent) : QObject(parent)
+{
+}
+
+/*!
+ Destructor.
+ */
+QAbstractUriResolver::~QAbstractUriResolver()
+{
+}
+
+/*!
+ \fn QUrl QAbstractUriResolver::resolve(const QUrl &relative, const QUrl &baseURI) const
+
+ Returns the \a relative URI resolved using the \a baseURI.
+
+ The caller guarantees that both \a relative and \a baseURI are
+ valid, and that \a baseURI is absolute. \a relative can be relative,
+ absolute, or empty.
+
+ The returned QUrl can be a default constructed QUrl. If it is not a
+ default constructed QUrl, it will be absolute and valid. If a default
+ constructed QUrl is returned, it means the \a relative URI was not
+ accepted to be resolved.
+
+ If the reimplemented resolve() function decides it has nothing to do
+ about resolving the \a relative URI, it should simply return the \a
+ relative URI resolved against the \a baseURI, i.e.:
+
+ \snippet doc/src/snippets/code/src_xmlpatterns_api_qabstracturiresolver.cpp 0
+
+ \sa QUrl::isRelative(), QUrl::isValid()
+ */
+
+QT_END_NAMESPACE
+