include/comphelper/getexpandeduri.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  */
   9
  10 #ifndef INCLUDED_COMPHELPER_GETEXPANDEDURI_HXX
  11 #define INCLUDED_COMPHELPER_GETEXPANDEDURI_HXX
  12
  13 #include <sal/config.h>
  14
  15 #include <comphelper/comphelperdllapi.h>
  16 #include <rtl/ustring.hxx>
  17
  18 namespace com::sun::star::uno
  19 {
  20 class XComponentContext;
  21 }
  22 namespace com::sun::star::uno
  23 {
  24 template <typename> class Reference;
  25 }
  26
  27 namespace comphelper
  28 {
  29 /**
  30    A helper function to expand vnd.sun.star.expand URLs.
  31
  32    If the given URI is a vnd.sun.star.expand URL, it is expanded (using the
  33    given component context's com.sun.star.util.theMacroExpander); otherwise it
  34    is returned unchanged.
  35 */
  36 COMPHELPER_DLLPUBLIC OUString getExpandedUri(
  37     css::uno::Reference<css::uno::XComponentContext> const& context, OUString const& uri);
  38 }
  39
  40 #endif
  41
  42 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */