1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_uri_XVndSunStarExpandUrl_idl__
29#define __com_sun_star_uri_XVndSunStarExpandUrl_idl__
30
31#include "com/sun/star/lang/IllegalArgumentException.idl"
32#include "com/sun/star/uno/XInterface.idl"
33
34module com { module sun { module star { module util {
35    published interface XMacroExpander;
36}; }; }; };
37
38module com { module sun { module star { module uri {
39
40/**
41   represents absolute &ldquo;vnd.sun.star.expand&rdquo; URLs.
42
43   <p>These URLs are of the form<br/>
44   &emsp;<var>vnd-sun-star-expand-url</var> =
45   <code>"VND.SUN.STAR.EXPAND:"</code> <var>opaque_part</var><br/>
46   where the <var>opaque_part</var> is an UTF-8 string as described in
47   <a href="http://udk.openoffice.org/common/man/concept/micro_deployment.html">
48   <cite>Bootstrap Arguments and Micro Deployment</cite></a>.  See
49   <a href="http://www.ietf.org/rfc/rfc2396.txt">RFC&nbsp;2396</a>,
50   <a href="http://www.ietf.org/rfc/rfc2732.txt">RFC&nbsp;2732</a>, and
51   <a href="http://www.ietf.org/rfc/rfc2234.txt">RFC&nbsp;2234</a> for
52   details.</p>
53
54   @since OOo 2.3
55 */
56published interface XVndSunStarExpandUrl {
57    /**
58       returns the expanded content of this URL.
59
60       @param expander
61       a macro expander; must not be <NULL/>.
62
63       @returns
64       the expanded content of this URL.
65
66       @throws com::sun::star::lang::IllegalArgumentException
67       if calling <member
68       scope="com::sun::star::util">XMacroExpander::expandMacros</member> on
69       <code>expander</code> raises any such exception.
70     */
71    string expand([in] com::sun::star::util::XMacroExpander expander)
72        raises (com::sun::star::lang::IllegalArgumentException);
73};
74
75}; }; }; };
76
77#endif
78