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