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 module com { module sun { module star { module uri {
  21
  22 /**
  23    represents absolute &ldquo;vnd.sun.star.script&rdquo; URLs.
  24
  25    <p>These URLs are of the form<br/>
  26    &nbsp;&nbsp;&nbsp;<var>vnd-sun-star-script-url</var> =
  27    <code>"VND.SUN.STAR.SCRIPT:"</code> <var>name</var> [<code>"?"</code>
  28    <var>parameter</var> *(<code>"&"</code> <var>parameter</var>)]<br/>
  29    &nbsp;&nbsp;&nbsp;<var>name</var> = 1*<var>schar</var><br/>
  30    &nbsp;&nbsp;&nbsp;<var>parameter</var> = <var>key</var> <code>"="</code>
  31    <var>value</var><br/>
  32    &nbsp;&nbsp;&nbsp;<var>key</var> = 1*<var>schar</var><br/>
  33    &nbsp;&nbsp;&nbsp;<var>value</var> = *<var>schar</var><br/>
  34    &nbsp;&nbsp;&nbsp;<var>schar</var> = <var>unreserved</var> / <var>escaped</var> /
  35    <code>"$"</code> / <code>"+"</code> / <code>","</code> / <code>":"</code> /
  36    <code>";"</code> / <code>"@"</code> / <code>"["</code> /
  37    <code>"]"</code><br/>
  38    See <a href="http://www.ietf.org/rfc/rfc3986.txt">RFC&nbsp;3986</a>
  39    <a href="http://www.ietf.org/rfc/rfc2234.txt">RFC&nbsp;2234</a> for
  40    details.</p>
  41
  42    <p>The names, keys, and values are arbitrary Unicode strings (non-empty
  43    Unicode strings in the case of names and keys), encoded as UTF-8 byte
  44    sequences.  It is an error if any of them does not represent a valid UTF-8
  45    byte sequence.  Keys are compared for equality character-by-character,
  46    without considering case folding or normalization.  There may be multiple
  47    parameters with equal keys.</p>
  48
  49    @since OOo 2.0
  50  */
  51 published interface XVndSunStarScriptUrl: com::sun::star::uno::XInterface {
  52     /**
  53        returns the name part of this URL.
  54
  55        @returns
  56        the non-escaped value of the name part.
  57      */
  58     string getName();
  59
  60     /**
  61         sets the name part of this URL.
  62
  63         @param name
  64         specifies the non-escaped new name part of the URL.
  65
  66         @throws ::com::sun::star::lang::IllegalArgumentException
  67         if name is empty
  68
  69         @since OOo 3.0
  70     */
  71     void   setName([in] string name)
  72         raises ( ::com::sun::star::lang::IllegalArgumentException );
  73
  74     /**
  75        returns whether this URL has a parameter with a given key.
  76
  77        @param key
  78        a non-escaped key.
  79
  80        @returns
  81        `TRUE` if this URL has at least one parameter with the given key.  In
  82        particular, if <code>key</code> is an empty `string`, `FALSE`
  83        is returned.
  84      */
  85     boolean hasParameter([in] string key);
  86
  87     /**
  88        returns the value of a parameter with a given key.
  89
  90        @param key
  91        a non-escaped key.
  92
  93        @returns
  94        the non-escaped value of the first parameter with the given key.  If
  95        there is no parameter with the given key, or if <code>key</code> is an
  96        empty `string`, an empty `string` is returned.
  97      */
  98     string getParameter([in] string key);
  99
 100     /**
 101         sets the value of a parameter with a given key.
 102
 103         @param key
 104         a non-escaped key
 105
 106         @param value
 107         the non-escaped value to be set for the parameter. If there already is a
 108         parameter with this key, the value of its first appearance will be replaced.
 109         Otherwise, a parameter with the given key/value will be appended.
 110
 111         @throws ::com::sun::star::lang::IllegalArgumentException
 112         if key is empty
 113
 114         @since OOo 3.0
 115     */
 116     void setParameter( [in] string key, [in] string value )
 117         raises ( ::com::sun::star::lang::IllegalArgumentException );
 118 };
 119
 120 }; }; }; };
 121
 122 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */