src/xmlpatterns/api/qabstracturiresolver.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 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 #include <QUrl>
  43
  44 #include "qabstracturiresolver.h"
  45
  46 QT_BEGIN_NAMESPACE
  47
  48 /*!
  49   \class QAbstractUriResolver
  50   \brief The QAbstractUriResolver class is a callback interface for resolving Uniform Resource Identifiers.
  51   \since 4.4
  52   \reentrant
  53   \ingroup xml-tools
  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
  60   this functionality.
  61
  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
  68   them to null URIs.
  69
  70   \sa {http://en.wikipedia.org/wiki/Uniform_Resource_Identifier}
  71 */
  72
  73 /*!
  74   Constructs a QAbstractUriResolver with the specified \a parent.
  75  */
  76 QAbstractUriResolver::QAbstractUriResolver(QObject *parent) : QObject(parent)
  77 {
  78 }
  79
  80 /*!
  81   Destructor.
  82  */
  83 QAbstractUriResolver::~QAbstractUriResolver()
  84 {
  85 }
  86
  87 /*!
  88   \fn QUrl QAbstractUriResolver::resolve(const QUrl &relative, const QUrl &baseURI) const
  89
  90   Returns the \a relative URI resolved using the \a baseURI.
  91
  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,
  94   absolute, or empty.
  95
  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.
 100
 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.:
 104
 105   \snippet code/src_xmlpatterns_api_qabstracturiresolver.cpp 0
 106
 107   \sa QUrl::isRelative(), QUrl::isValid()
 108  */
 109
 110 QT_END_NAMESPACE
 111