<html> <head> <title>Interface XVndSunStarScriptUrl</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XVndSunStarScriptUrl-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">uri</a> :: </p> </td> </tr> <tr> <td class="title">interface XVndSunStarScriptUrl</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>represents absolute “vnd.sun.star.script” URLs. </dd> <dd><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> </dd> <dt><b>Since </b></dt> <dd>OOo 2.0 </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#getName">getName</a></td> <td class="imsum_right">returns the name part of this URL. </td> </tr> <tr> <td class="imsum_left"><a href="#setName">setName</a></td> <td class="imsum_right">sets the name part of this URL. </td> </tr> <tr> <td class="imsum_left"><a href="#hasParameter">hasParameter</a></td> <td class="imsum_right">returns whether this URL has a parameter with a given key. </td> </tr> <tr> <td class="imsum_left"><a href="#getParameter">getParameter</a></td> <td class="imsum_right">returns the value of a parameter with a given key. </td> </tr> <tr> <td class="imsum_left"><a href="#setParameter">setParameter</a></td> <td class="imsum_right">sets the value of a parameter with a given key. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="getName" class="membertitle">getName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getName</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the name part of this URL. </dd> <dt><b>Returns</b></dt> <dd>the non-escaped value of the name part. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setName" class="membertitle">setName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setName</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> name )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the name part of this URL. </dd> <dt><b>Parameter name</b></dt> <dd>specifies the non-escaped new name part of the URL. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IllegalArgumentException if <arg>name</arg> is empty </dd> <dt><b>Since </b></dt> <dd>OOo 3.0 </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="hasParameter" class="membertitle">hasParameter</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>hasParameter</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> key );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns whether this URL has a parameter with a given key. </dd> <dt><b>Parameter key</b></dt> <dd>a non-escaped key. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if this URL has at least one parameter with the given key. In particular, if <code>key</code> is an empty <code>string</code>, <b>false</b> is returned. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getParameter" class="membertitle">getParameter</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getParameter</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> key );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the value of a parameter with a given key. </dd> <dt><b>Parameter key</b></dt> <dd>a non-escaped key. </dd> <dt><b>Returns</b></dt> <dd>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 <code>string</code>, an empty <code>string</code> is returned. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setParameter" class="membertitle">setParameter</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setParameter</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> key,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> value )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the value of a parameter with a given key. </dd> <dt><b>Parameter key</b></dt> <dd>a non-escaped key </dd> <dt><b>Parameter value</b></dt> <dd>the non-escaped value to be set for the parameter. If there already is a parameter with this key, the value of its first appearance will be replaced. Otherwise, a parameter with the given key/value will be appended. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IllegalArgumentException if <arg>key</arg> is empty </dd> <dt><b>Since </b></dt> <dd>OOo 3.0 </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
