udkapi/com/sun/star/uri/XVndSunStarScriptUrl.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_uri_XVndSunStarScriptUrl_idl__
  21 #define __com_sun_star_uri_XVndSunStarScriptUrl_idl__
  22
  23 #include <com/sun/star/lang/IllegalArgumentException.idl>
  24 #include <com/sun/star/uno/XInterface.idl>
  25
  26 module com { module sun { module star { module uri {
  27
  28 /**
  29    represents absolute &ldquo;vnd.sun.star.script&rdquo; URLs.
  30
  31    <p>These URLs are of the form<br/>
  32    &nbsp;&nbsp;&nbsp;<var>vnd-sun-star-script-url</var> =
  33    <code>"VND.SUN.STAR.SCRIPT:"</code> <var>name</var> [<code>"?"</code>
  34    <var>parameter</var> *(<code>"&"</code> <var>parameter</var>)]<br/>
  35    &nbsp;&nbsp;&nbsp;<var>name</var> = 1*<var>schar</var><br/>
  36    &nbsp;&nbsp;&nbsp;<var>parameter</var> = <var>key</var> <code>"="</code>
  37    <var>value</var><br/>
  38    &nbsp;&nbsp;&nbsp;<var>key</var> = 1*<var>schar</var><br/>
  39    &nbsp;&nbsp;&nbsp;<var>value</var> = *<var>schar</var><br/>
  40    &nbsp;&nbsp;&nbsp;<var>schar</var> = <var>unreserved</var> / <var>escaped</var> /
  41    <code>"$"</code> / <code>"+"</code> / <code>","</code> / <code>":"</code> /
  42    <code>";"</code> / <code>"@"</code> / <code>"["</code> /
  43    <code>"]"</code><br/>
  44    See <a href="http://www.ietf.org/rfc/rfc2396.txt">RFC&nbsp;2396</a>,
  45    <a href="http://www.ietf.org/rfc/rfc2732.txt">RFC&nbsp;2732</a>, and
  46    <a href="http://www.ietf.org/rfc/rfc2234.txt">RFC&nbsp;2234</a> for
  47    details.</p>
  48
  49    <p>The names, keys, and values are arbitrary Unicode strings (non-empty
  50    Unicode strings in the case of names and keys), encoded as UTF-8 byte
  51    sequences.  It is an error if any of them does not represent a valid UTF-8
  52    byte sequence.  Keys are compared for equality character-by-character,
  53    without considering case folding or normalization.  There may be multiple
  54    parameters with equal keys.</p>
  55
  56    @since OOo 2.0
  57  */
  58 published interface XVndSunStarScriptUrl: com::sun::star::uno::XInterface {
  59     /**
  60        returns the name part of this URL.
  61
  62        @returns
  63        the non-escaped value of the name part.
  64      */
  65     string getName();
  66
  67     /**
  68         sets the name part of this URL.
  69
  70         @param name
  71         specifies the non-escaped new name part of the URL.
  72
  73         @throws ::com::sun::star::lang::IllegalArgumentException
  74         if name is empty
  75
  76         @since OOo 3.0
  77     */
  78     void   setName([in] string name)
  79         raises ( ::com::sun::star::lang::IllegalArgumentException );
  80
  81     /**
  82        returns whether this URL has a parameter with a given key.
  83
  84        @param key
  85        a non-escaped key.
  86
  87        @returns
  88        `TRUE` if this URL has at least one parameter with the given key.  In
  89        particular, if <code>key</code> is an empty `string`, `FALSE`
  90        is returned.
  91      */
  92     boolean hasParameter([in] string key);
  93
  94     /**
  95        returns the value of a parameter with a given key.
  96
  97        @param key
  98        a non-escaped key.
  99
 100        @returns
 101        the non-escaped value of the first parameter with the given key.  If
 102        there is no parameter with the given key, or if <code>key</code> is an
 103        empty `string`, an empty `string` is returned.
 104      */
 105     string getParameter([in] string key);
 106
 107     /**
 108         sets the value of a parameter with a given key.
 109
 110         @param key
 111         a non-escaped key
 112
 113         @param value
 114         the non-escaped value to be set for the parameter. If there already is a
 115         parameter with this key, the value of its first appearance will be replaced.
 116         Otherwise, a parameter with the given key/value will be appended.
 117
 118         @throws ::com::sun::star::lang::IllegalArgumentException
 119         if key is empty
 120
 121         @since OOo 3.0
 122     */
 123     void setParameter( [in] string key, [in] string value )
 124         raises ( ::com::sun::star::lang::IllegalArgumentException );
 125 };
 126
 127 }; }; }; };
 128
 129 #endif
 130
 131 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */