INTEGRATION: CWS sb12 (1.1.2); FILE ADDED

2004/01/14 12:39:12 sb 1.1.2.2: #i19971# Modified syntax of vnd.sun.star.script URLs.
2003/12/17 16:13:21 sb 1.1.2.1: #i19971# URI processing.

1 files changed, 135 insertions, 0 deletions

diff --git a/udkapi/com/sun/star/uri/XVndSunStarScriptUrl.idl b/udkapi/com/sun/star/uri/XVndSunStarScriptUrl.idl
new file mode 100644
index 000000000000..295efa216766
--- /dev/null
+++ b/udkapi/com/sun/star/uri/XVndSunStarScriptUrl.idl
@@ -0,0 +1,135 @@
+/*************************************************************************
+ *
+ *  $RCSfile: XVndSunStarScriptUrl.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: kz $ $Date: 2004-01-19 18:20:34 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 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
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (the "License"); You may not use this file
+ *  except in compliance with the License. You may obtain a copy of the
+ *  License at http://www.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2003 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#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>
+ */
+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