1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
44 #include "qabstracturiresolver.h"
49 \class QAbstractUriResolver
50 \brief The QAbstractUriResolver class is a callback interface for resolving Uniform Resource Identifiers.
54 \inmodule QtXmlPatterns
55 A Uniform Resource Identifier (URI) is a string that uniquely
56 identifies a resource. URIs are versatile global identifiers. It is
57 often useful to transform a URI that identifies something logical
58 into a URI that locates something physical (a URL), or to simply map
59 a URI to a different URI. QAbstractUriResolver::resolve() provides
62 For example, one could write a QAbstractUriResolver subclass that
63 rewrites library ISBN number URIs as book title URLs, e.g.,
64 \e{urn:isbn:0-345-33973-8} would be rewritten as
65 \e{file:///books/returnOfTheKing.doc}. Or a QAbstractUriResolver
66 subclass could be written for a web browser to let the web browser
67 protect the user's private files by mapping incoming requests for
70 \sa {http://en.wikipedia.org/wiki/Uniform_Resource_Identifier}
74 Constructs a QAbstractUriResolver with the specified \a parent.
76 QAbstractUriResolver::QAbstractUriResolver(QObject *parent) : QObject(parent)
83 QAbstractUriResolver::~QAbstractUriResolver()
88 \fn QUrl QAbstractUriResolver::resolve(const QUrl &relative, const QUrl &baseURI) const
90 Returns the \a relative URI resolved using the \a baseURI.
92 The caller guarantees that both \a relative and \a baseURI are
93 valid, and that \a baseURI is absolute. \a relative can be relative,
96 The returned QUrl can be a default constructed QUrl. If it is not a
97 default constructed QUrl, it will be absolute and valid. If a default
98 constructed QUrl is returned, it means the \a relative URI was not
99 accepted to be resolved.
101 If the reimplemented resolve() function decides it has nothing to do
102 about resolving the \a relative URI, it should simply return the \a
103 relative URI resolved against the \a baseURI, i.e.:
105 \snippet doc/src/snippets/code/src_xmlpatterns_api_qabstracturiresolver.cpp 0
107 \sa QUrl::isRelative(), QUrl::isValid()