udkapi/com/sun/star/uri/XVndSunStarExpandUrl.idl

   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  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_uri_XVndSunStarExpandUrl_idl__
  21 #define __com_sun_star_uri_XVndSunStarExpandUrl_idl__
  22
  23 #include <com/sun/star/lang/IllegalArgumentException.idl>
  24 #include <com/sun/star/uno/XInterface.idl>
  25
  26 module com { module sun { module star { module util {
  27     published interface XMacroExpander;
  28 }; }; }; };
  29
  30 module com { module sun { module star { module uri {
  31
  32 /**
  33    represents absolute &ldquo;vnd.sun.star.expand&rdquo; URLs.
  34
  35    <p>These URLs are of the form<br/>
  36    &nbsp;&nbsp;&nbsp;<var>vnd-sun-star-expand-url</var> =
  37    <code>"VND.SUN.STAR.EXPAND:"</code> <var>opaque_part</var><br/>
  38    where the <var>opaque_part</var> is an UTF-8 string as described in
  39    <a href="http://udk.openoffice.org/common/man/concept/micro_deployment.html">
  40    Bootstrap Arguments and Micro Deployment</a>.  See
  41    <a href="http://www.ietf.org/rfc/rfc2396.txt">RFC&nbsp;2396</a>,
  42    <a href="http://www.ietf.org/rfc/rfc2732.txt">RFC&nbsp;2732</a>, and
  43    <a href="http://www.ietf.org/rfc/rfc2234.txt">RFC&nbsp;2234</a> for
  44    details.</p>
  45
  46    @since OOo 2.3
  47  */
  48 published interface XVndSunStarExpandUrl {
  49     /**
  50        returns the expanded content of this URL.
  51
  52        @param expander
  53        a macro expander; must not be `NULL`.
  54
  55        @returns
  56        the expanded content of this URL.
  57
  58        @throws com::sun::star::lang::IllegalArgumentException
  59        if calling com::sun::star::util::XMacroExpander::expandMacros() on
  60        <code>expander</code> raises any such exception.
  61      */
  62     string expand([in] com::sun::star::util::XMacroExpander expander)
  63         raises (com::sun::star::lang::IllegalArgumentException);
  64 };
  65
  66 }; }; }; };
  67
  68 #endif
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */