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#ifndef __com_sun_star_util_XURLTransformer_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_util_XURLTransformer_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_util_URL_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/util/URL.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski//============================================================================= 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module util { 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski//============================================================================= 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski/** supports parsing and assembling of URLs 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski @see URL 44*b1cdbd2cSJim Jagielski @see URLTransformer 45*b1cdbd2cSJim Jagielski */ 46*b1cdbd2cSJim Jagielskipublished interface XURLTransformer: com::sun::star::uno::XInterface 47*b1cdbd2cSJim Jagielski{ 48*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 49*b1cdbd2cSJim Jagielski /** parses the string in <member>URL::Complete</member> which should contain 50*b1cdbd2cSJim Jagielski a syntactically complete URL. 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski <p> 53*b1cdbd2cSJim Jagielski The implementation is allowed to correct minor failures in <member>URL::Complete</member> 54*b1cdbd2cSJim Jagielski if the meaning of the URL remain unchanged. Parts of the URL are stored in the other 55*b1cdbd2cSJim Jagielski fields of <var>aURL</var>. 56*b1cdbd2cSJim Jagielski </p> 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski @param aURL 59*b1cdbd2cSJim Jagielski the URL which include the complete string notation and will contain 60*b1cdbd2cSJim Jagielski all parsed parts of it after finishing this call. <member>URL::Complete</member> 61*b1cdbd2cSJim Jagielski can be overwritten if the implementation corrected minor failures. 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski @returns 64*b1cdbd2cSJim Jagielski <TRUE/> if parsing was successfully (means if given URL was syntactically correct) 65*b1cdbd2cSJim Jagielski or <FALSE/> otherwhise. 66*b1cdbd2cSJim Jagielski */ 67*b1cdbd2cSJim Jagielski boolean parseStrict( [inout] com::sun::star::util::URL aURL ); 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 70*b1cdbd2cSJim Jagielski /** parses the string in <member>URL::Complete</member>, which may contain 71*b1cdbd2cSJim Jagielski a syntactically complete URL or is specified by the provided protocol 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski <p> 74*b1cdbd2cSJim Jagielski The implementation can use smart functions to correct or interpret 75*b1cdbd2cSJim Jagielski <member>URL::Complete</member> if it is not a syntactically complete URL. 76*b1cdbd2cSJim Jagielski The parts of the URL are stored in the other fields of <var>aURL</var>. 77*b1cdbd2cSJim Jagielski </p> 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski @param aURL 80*b1cdbd2cSJim Jagielski the URL which include the string notation and will contain 81*b1cdbd2cSJim Jagielski all parsed parts of it after finishing this call. This includes 82*b1cdbd2cSJim Jagielski <member>URL::Complete</member>. 83*b1cdbd2cSJim Jagielski 84*b1cdbd2cSJim Jagielski @param sSmartProtocol 85*b1cdbd2cSJim Jagielski optional information which protocol specification should be used to parse 86*b1cdbd2cSJim Jagielski member<member>URL::Complete</member>. If empty the implementation can use a 87*b1cdbd2cSJim Jagielski protocol which fit best. 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski @returns 90*b1cdbd2cSJim Jagielski <TRUE/> if parsing was successful (means if <member>URL::Complete</member> could 91*b1cdbd2cSJim Jagielski be syntactically correct) or <FALSE/> otherwise. 92*b1cdbd2cSJim Jagielski */ 93*b1cdbd2cSJim Jagielski boolean parseSmart( 94*b1cdbd2cSJim Jagielski [inout] com::sun::star::util::URL aURL, 95*b1cdbd2cSJim Jagielski [in] string sSmartProtocol ); 96*b1cdbd2cSJim Jagielski 97*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 98*b1cdbd2cSJim Jagielski /** assembles the parts of the URL specified by <var>aURL</var> and 99*b1cdbd2cSJim Jagielski stores it into <member>URL::Complete</member> 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski @param aURL 102*b1cdbd2cSJim Jagielski the URL which contains alls neccessary information in a structured form. The 103*b1cdbd2cSJim Jagielski member <member>URL::Complete</member> contains the URL in string notation after 104*b1cdbd2cSJim Jagielski the operation finished successfully. Otherwise the content of <member>URL::complete</member> 105*b1cdbd2cSJim Jagielski is not defined. 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski @returns 108*b1cdbd2cSJim Jagielski <TRUE/> if assembling was successfully or <FALSE/> otherwise. 109*b1cdbd2cSJim Jagielski */ 110*b1cdbd2cSJim Jagielski boolean assemble( [inout] com::sun::star::util::URL aURL ); 111*b1cdbd2cSJim Jagielski 112*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 113*b1cdbd2cSJim Jagielski /** returns a representation of the URL for UI purposes only 114*b1cdbd2cSJim Jagielski 115*b1cdbd2cSJim Jagielski <p> 116*b1cdbd2cSJim Jagielski Sometimes it can be usefull to show an URL on an user interface 117*b1cdbd2cSJim Jagielski in a more "human readable" form. Such URL can't be used on any API 118*b1cdbd2cSJim Jagielski call, but make it easier for the user to understand it. 119*b1cdbd2cSJim Jagielski </p> 120*b1cdbd2cSJim Jagielski 121*b1cdbd2cSJim Jagielski @param aURL 122*b1cdbd2cSJim Jagielski URL in structured form which should be shown at the UI 123*b1cdbd2cSJim Jagielski 124*b1cdbd2cSJim Jagielski @param bWithPassword 125*b1cdbd2cSJim Jagielski specifies whether the password will be included in the encoding 126*b1cdbd2cSJim Jagielski or not. Usually passwords should never be shown at the user 127*b1cdbd2cSJim Jagielski interface. 128*b1cdbd2cSJim Jagielski 129*b1cdbd2cSJim Jagielski @returns 130*b1cdbd2cSJim Jagielski a string representing the <var>aURL</var> if it is syntactically correct. A empty string if <var>aURL</var> 131*b1cdbd2cSJim Jagielski is not syntactically correct. 132*b1cdbd2cSJim Jagielski */ 133*b1cdbd2cSJim Jagielski string getPresentation( 134*b1cdbd2cSJim Jagielski [in] com::sun::star::util::URL aURL, 135*b1cdbd2cSJim Jagielski [in] boolean bWithPassword ); 136*b1cdbd2cSJim Jagielski}; 137*b1cdbd2cSJim Jagielski 138*b1cdbd2cSJim Jagielski//============================================================================= 139*b1cdbd2cSJim Jagielski 140*b1cdbd2cSJim Jagielski}; }; }; }; 141*b1cdbd2cSJim Jagielski 142*b1cdbd2cSJim Jagielski#endif 143