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 <com/sun/star/uno/Reference.hxx>
  16 #include <comphelper/comphelperdllapi.h>
  17 #include <rtl/ustring.hxx>
  18 #include <sal/types.h>
  19
  20 namespace com { namespace sun { namespace star { namespace uno {
  21     class XComponentContext;
  22 } } } }
  23
  24 namespace comphelper {
  25
  26 /**
  27    A helper function to expand vnd.sun.star.expand URLs.
  28
  29    If the given URI is a vnd.sun.star.expand URL, it is expanded (using the
  30    given component context's com.sun.star.util.theMacroExpander); otherwise it
  31    is returned unchanged.
  32 */
  33 COMPHELPER_DLLPUBLIC OUString getExpandedUri(
  34     css::uno::Reference<css::uno::XComponentContext> const & context,
  35     OUString const & uri);
  36
  37 }
  38
  39 #endif
  40
  41 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */