1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_uri_XVndSunStarExpandUrl_idl__
25#define __com_sun_star_uri_XVndSunStarExpandUrl_idl__
26
27#include "com/sun/star/lang/IllegalArgumentException.idl"
28#include "com/sun/star/uno/XInterface.idl"
29
30module com { module sun { module star { module util {
31    published interface XMacroExpander;
32}; }; }; };
33
34module com { module sun { module star { module uri {
35
36/**
37   represents absolute “vnd.sun.star.expand” URLs.
38
39   <p>These URLs are of the form<br/>
40   &emsp;<var>vnd-sun-star-expand-url</var> =
41   <code>"VND.SUN.STAR.EXPAND:"</code> <var>opaque_part</var><br/>
42   where the <var>opaque_part</var> is an UTF-8 string as described in
43   <a href="http://udk.openoffice.org/common/man/concept/micro_deployment.html">
44   <cite>Bootstrap Arguments and Micro Deployment</cite></a>.  See
45   <a href="http://www.ietf.org/rfc/rfc2396.txt">RFC&nbsp;2396</a>,
46   <a href="http://www.ietf.org/rfc/rfc2732.txt">RFC&nbsp;2732</a>, and
47   <a href="http://www.ietf.org/rfc/rfc2234.txt">RFC&nbsp;2234</a> for
48   details.</p>
49
50   @since OpenOffice 2.3
51 */
52published interface XVndSunStarExpandUrl {
53    /**
54       returns the expanded content of this URL.
55
56       @param expander
57       a macro expander; must not be <NULL/>.
58
59       @returns
60       the expanded content of this URL.
61
62       @throws com::sun::star::lang::IllegalArgumentException
63       if calling <member
64       scope="com::sun::star::util">XMacroExpander::expandMacros</member> on
65       <code>expander</code> raises any such exception.
66     */
67    string expand([in] com::sun::star::util::XMacroExpander expander)
68        raises (com::sun::star::lang::IllegalArgumentException);
69};
70
71}; }; }; };
72
73#endif
74