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 module com { module sun { module star { module util {
  21     published interface XMacroExpander;
  22 }; }; }; };
  23
  24 module com { module sun { module star { module uri {
  25
  26 /**
  27    represents absolute &ldquo;vnd.sun.star.expand&rdquo; URLs.
  28
  29    <p>These URLs are of the form<br/>
  30    &nbsp;&nbsp;&nbsp;<var>vnd-sun-star-expand-url</var> =
  31    <code>"VND.SUN.STAR.EXPAND:"</code> <var>opaque_part</var><br/>
  32    where the <var>opaque_part</var> is a UTF-8 string as described in
  33    <a href="http://udk.openoffice.org/common/man/concept/micro_deployment.html">
  34    Bootstrap Arguments and Micro Deployment</a>.  See
  35    <a href="http://www.ietf.org/rfc/rfc3986.txt">RFC&nbsp;3986</a>
  36    <a href="http://www.ietf.org/rfc/rfc2234.txt">RFC&nbsp;2234</a> for
  37    details.</p>
  38
  39    @since OOo 2.3
  40  */
  41 published interface XVndSunStarExpandUrl {
  42     /**
  43        returns the expanded content of this URL.
  44
  45        @param expander
  46        a macro expander; must not be `NULL`.
  47
  48        @returns
  49        the expanded content of this URL.
  50
  51        @throws com::sun::star::lang::IllegalArgumentException
  52        if calling com::sun::star::util::XMacroExpander::expandMacros() on
  53        <code>expander</code> raises any such exception.
  54      */
  55     string expand([in] com::sun::star::util::XMacroExpander expander)
  56         raises (com::sun::star::lang::IllegalArgumentException);
  57 };
  58
  59 }; }; }; };
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */