summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/uri/XVndSunStarScriptUrl.idl
blob: af6f4c0a5b4f66234f7463cf26142017b18b7792 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XVndSunStarScriptUrl.idl,v $
 *
 *  $Revision: 1.6 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-09 16:39:43 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#ifndef __com_sun_star_uri_XVndSunStarScriptUrl_idl__
#define __com_sun_star_uri_XVndSunStarScriptUrl_idl__

#include <com/sun/star/uno/XInterface.idl>

module com { module sun { module star { module uri {

/**
   represents absolute &ldquo;vnd.sun.star.script&rdquo; URLs.

   <p>These URLs are of the form<br/>
   &emsp;<var>vnd-sun-star-script-url</var> =
   <code>"VND.SUN.STAR.SCRIPT:"</code> <var>name</var> [<code>"?"</code>
   <var>parameter</var> *(<code>"&"</code> <var>parameter</var>)]<br/>
   &emsp;<var>name</var> = 1*<var>schar</var><br/>
   &emsp;<var>parameter</var> = <var>key</var> <code>"="</code>
   <var>value</var><br/>
   &emsp;<var>key</var> = 1*<var>schar</var><br/>
   &emsp;<var>value</var> = *<var>schar</var><br/>
   &emsp;<var>schar</var> = <var>unreserved</var> / <var>escaped</var> /
   <code>"$"</code> / <code>"+"</code> / <code>","</code> / <code>":"</code> /
   <code>";"</code> / <code>"@"</code> / <code>"["</code> /
   <code>"]"</code><br/>
   See <a href="http://www.ietf.org/rfc/rfc2396.txt">RFC&nbsp;2396</a>,
   <a href="http://www.ietf.org/rfc/rfc2732.txt">RFC&nbsp;2732</a>, and
   <a href="http://www.ietf.org/rfc/rfc2234.txt">RFC&nbsp;2234</a> for
   details.</p>

   <p>The names, keys, and values are arbitrary Unicode strings (non-empty
   Unicode strings in the case of names and keys), encoded as UTF-8 byte
   sequences.  It is an error if any of them does not represent a valid UTF-8
   byte sequence.  Keys are compared for equality character-by-character,
   without considering case folding or normalization.  There may be multiple
   parameters with equal keys.</p>

   @since OOo 2.0.0
 */
interface XVndSunStarScriptUrl: com::sun::star::uno::XInterface {
    /**
       returns the name part of this URL.

       @returns
       the non-escaped value of the name part.
     */
    string getName();

    /**
       returns whether this URL has a parameter with a given key.

       @param key
       a non-escaped key.

       @returns
       <TRUE/> if this URL has at least one parameter with the given key.  In
       particular, if <code>key</code> is an empty <atom>string</atom>, <FALSE/>
       is returned.
     */
    boolean hasParameter([in] string key);

    /**
       returns the value of a parameter with a given key.

       @param key
       a non-escaped key.

       @returns
       the non-escaped value of the first parameter with the given key.  If
       there is no parameter with the given key, or if <code>key</code> is an
       empty <atom>string</atom>, an empty <atom>string</atom> is returned.
     */
    string getParameter([in] string key);
};

}; }; }; };

#endif