1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
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 The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#include <QUrl>
41
42#include "qabstracturiresolver.h"
43
44QT_BEGIN_NAMESPACE
45
46/*!
47 \class QAbstractUriResolver
48 \brief The QAbstractUriResolver class is a callback interface for resolving Uniform Resource Identifiers.
49 \since 4.4
50 \reentrant
51 \ingroup xml-tools
52 \inmodule QtXmlPatterns
53 A Uniform Resource Identifier (URI) is a string that uniquely
54 identifies a resource. URIs are versatile global identifiers. It is
55 often useful to transform a URI that identifies something logical
56 into a URI that locates something physical (a URL), or to simply map
57 a URI to a different URI. QAbstractUriResolver::resolve() provides
58 this functionality.
59
60 For example, one could write a QAbstractUriResolver subclass that
61 rewrites library ISBN number URIs as book title URLs, e.g.,
62 \e{urn:isbn:0-345-33973-8} would be rewritten as
63 \e{file:///books/returnOfTheKing.doc}. Or a QAbstractUriResolver
64 subclass could be written for a web browser to let the web browser
65 protect the user's private files by mapping incoming requests for
66 them to null URIs.
67
68 \sa {http://en.wikipedia.org/wiki/Uniform_Resource_Identifier}
69*/
70
71/*!
72 Constructs a QAbstractUriResolver with the specified \a parent.
73 */
74QAbstractUriResolver::QAbstractUriResolver(QObject *parent) : QObject(parent)
75{
76}
77
78/*!
79 Destructor.
80 */
81QAbstractUriResolver::~QAbstractUriResolver()
82{
83}
84
85/*!
86 \fn QUrl QAbstractUriResolver::resolve(const QUrl &relative, const QUrl &baseURI) const
87
88 Returns the \a relative URI resolved using the \a baseURI.
89
90 The caller guarantees that both \a relative and \a baseURI are
91 valid, and that \a baseURI is absolute. \a relative can be relative,
92 absolute, or empty.
93
94 The returned QUrl can be a default constructed QUrl. If it is not a
95 default constructed QUrl, it will be absolute and valid. If a default
96 constructed QUrl is returned, it means the \a relative URI was not
97 accepted to be resolved.
98
99 If the reimplemented resolve() function decides it has nothing to do
100 about resolving the \a relative URI, it should simply return the \a
101 relative URI resolved against the \a baseURI, i.e.:
102
103 \snippet code/src_xmlpatterns_api_qabstracturiresolver.cpp 0
104
105 \sa QUrl::isRelative(), QUrl::isValid()
106 */
107
108QT_END_NAMESPACE
109
110

source code of qtxmlpatterns/src/xmlpatterns/api/qabstracturiresolver.cpp