106 lines
3.8 KiB
Text
106 lines
3.8 KiB
Text
/*************************************************************************
|
|
*
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
*
|
|
* Copyright 2008 by Sun Microsystems, Inc.
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* $RCSfile: XVndSunStarScriptUrl.idl,v $
|
|
* $Revision: 1.7 $
|
|
*
|
|
* This file is part of OpenOffice.org.
|
|
*
|
|
* OpenOffice.org is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License version 3
|
|
* only, as published by the Free Software Foundation.
|
|
*
|
|
* OpenOffice.org 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 version 3 for more details
|
|
* (a copy is included in the LICENSE file that accompanied this code).
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* version 3 along with OpenOffice.org. If not, see
|
|
* <http://www.openoffice.org/license.html>
|
|
* for a copy of the LGPLv3 License.
|
|
*
|
|
************************************************************************/
|
|
|
|
#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 “vnd.sun.star.script” URLs.
|
|
|
|
<p>These URLs are of the form<br/>
|
|
 <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/>
|
|
 <var>name</var> = 1*<var>schar</var><br/>
|
|
 <var>parameter</var> = <var>key</var> <code>"="</code>
|
|
<var>value</var><br/>
|
|
 <var>key</var> = 1*<var>schar</var><br/>
|
|
 <var>value</var> = *<var>schar</var><br/>
|
|
 <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 2396</a>,
|
|
<a href="http://www.ietf.org/rfc/rfc2732.txt">RFC 2732</a>, and
|
|
<a href="http://www.ietf.org/rfc/rfc2234.txt">RFC 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
|