1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_util_XURLTransformer_idl__
24cdf0e10cSrcweir#define __com_sun_star_util_XURLTransformer_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_util_URL_idl__
31cdf0e10cSrcweir#include <com/sun/star/util/URL.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir
35cdf0e10cSrcweir//=============================================================================
36cdf0e10cSrcweir
37cdf0e10cSrcweirmodule com {  module sun {  module star {  module util {
38cdf0e10cSrcweir
39cdf0e10cSrcweir//=============================================================================
40cdf0e10cSrcweir
41cdf0e10cSrcweir/** supports parsing and assembling of URLs
42cdf0e10cSrcweir
43cdf0e10cSrcweir    @see URL
44cdf0e10cSrcweir    @see URLTransformer
45cdf0e10cSrcweir */
46cdf0e10cSrcweirpublished interface XURLTransformer: com::sun::star::uno::XInterface
47cdf0e10cSrcweir{
48cdf0e10cSrcweir	//-------------------------------------------------------------------------
49cdf0e10cSrcweir	/** parses the string in <member>URL::Complete</member> which should contain
50cdf0e10cSrcweir        a syntactically complete URL.
51cdf0e10cSrcweir
52cdf0e10cSrcweir        <p>
53cdf0e10cSrcweir		The implementation is allowed to correct minor failures in <member>URL::Complete</member>
54cdf0e10cSrcweir		if the meaning of the URL remain unchanged. Parts of the URL are stored in the other
55cdf0e10cSrcweir		fields of <var>aURL</var>.
56cdf0e10cSrcweir		</p>
57cdf0e10cSrcweir
58cdf0e10cSrcweir        @param aURL
59cdf0e10cSrcweir                the URL which include the complete string notation and will contain
60cdf0e10cSrcweir                all parsed parts of it after finishing this call. <member>URL::Complete</member>
61cdf0e10cSrcweir				can be overwritten if the implementation corrected minor failures.
62cdf0e10cSrcweir
63cdf0e10cSrcweir        @returns
64cdf0e10cSrcweir			<TRUE/> if parsing was successfully (means if given URL was syntactically correct)
65cdf0e10cSrcweir            or <FALSE/> otherwhise.
66cdf0e10cSrcweir	 */
67cdf0e10cSrcweir	boolean parseStrict( [inout] com::sun::star::util::URL aURL );
68cdf0e10cSrcweir
69cdf0e10cSrcweir	//-------------------------------------------------------------------------
70cdf0e10cSrcweir	/** parses the string in <member>URL::Complete</member>, which may contain
71cdf0e10cSrcweir		a syntactically complete URL or is specified by the provided protocol
72cdf0e10cSrcweir
73cdf0e10cSrcweir        <p>
74cdf0e10cSrcweir		The implementation can use smart functions to correct or interpret
75cdf0e10cSrcweir		<member>URL::Complete</member> if it is not a syntactically complete URL.
76cdf0e10cSrcweir		The parts of the URL are stored in the other fields of <var>aURL</var>.
77cdf0e10cSrcweir		</p>
78cdf0e10cSrcweir
79cdf0e10cSrcweir        @param aURL
80cdf0e10cSrcweir                the URL which include the string notation and will contain
81cdf0e10cSrcweir                all parsed parts of it after finishing this call. This includes
82cdf0e10cSrcweir				<member>URL::Complete</member>.
83cdf0e10cSrcweir
84cdf0e10cSrcweir        @param sSmartProtocol
85cdf0e10cSrcweir                optional information which protocol specification should be used to parse
86cdf0e10cSrcweir				member<member>URL::Complete</member>. If empty the implementation can use a
87cdf0e10cSrcweir				protocol which fit best.
88cdf0e10cSrcweir
89cdf0e10cSrcweir        @returns
90cdf0e10cSrcweir				<TRUE/> if parsing was successful (means if <member>URL::Complete</member> could
91cdf0e10cSrcweir				be syntactically correct) or <FALSE/> otherwise.
92cdf0e10cSrcweir	 */
93cdf0e10cSrcweir    boolean parseSmart(
94cdf0e10cSrcweir        [inout] com::sun::star::util::URL aURL,
95cdf0e10cSrcweir        [in] string sSmartProtocol );
96cdf0e10cSrcweir
97cdf0e10cSrcweir	//-------------------------------------------------------------------------
98cdf0e10cSrcweir    /** assembles the parts of the URL specified by <var>aURL</var> and
99cdf0e10cSrcweir        stores it into <member>URL::Complete</member>
100cdf0e10cSrcweir
101cdf0e10cSrcweir        @param aURL
102cdf0e10cSrcweir                the URL which contains alls neccessary information in a structured form. The
103cdf0e10cSrcweir                member <member>URL::Complete</member> contains the URL in string notation after
104cdf0e10cSrcweir				the operation finished successfully. Otherwise the content of <member>URL::complete</member>
105cdf0e10cSrcweir				is not defined.
106cdf0e10cSrcweir
107cdf0e10cSrcweir        @returns
108cdf0e10cSrcweir			<TRUE/> if assembling was successfully or <FALSE/> otherwise.
109cdf0e10cSrcweir	 */
110cdf0e10cSrcweir	boolean assemble( [inout] com::sun::star::util::URL aURL );
111cdf0e10cSrcweir
112cdf0e10cSrcweir	//-------------------------------------------------------------------------
113cdf0e10cSrcweir    /** returns a representation of the URL for UI purposes only
114cdf0e10cSrcweir
115cdf0e10cSrcweir        <p>
116cdf0e10cSrcweir        Sometimes it can be usefull to show an URL on an user interface
117cdf0e10cSrcweir        in a more "human readable" form. Such URL can't be used on any API
118cdf0e10cSrcweir        call, but make it easier for the user to understand it.
119cdf0e10cSrcweir        </p>
120cdf0e10cSrcweir
121cdf0e10cSrcweir        @param aURL
122cdf0e10cSrcweir                URL in structured form which should be shown at the UI
123cdf0e10cSrcweir
124cdf0e10cSrcweir        @param bWithPassword
125cdf0e10cSrcweir                specifies whether the password will be included in the encoding
126cdf0e10cSrcweir                or not. Usually passwords should never be shown at the user
127cdf0e10cSrcweir                interface.
128cdf0e10cSrcweir
129cdf0e10cSrcweir        @returns
130cdf0e10cSrcweir				a string representing the <var>aURL</var> if it is syntactically correct. A empty string if <var>aURL</var>
131cdf0e10cSrcweir				is not syntactically correct.
132cdf0e10cSrcweir	 */
133cdf0e10cSrcweir    string getPresentation(
134cdf0e10cSrcweir        [in] com::sun::star::util::URL aURL,
135cdf0e10cSrcweir        [in] boolean bWithPassword );
136cdf0e10cSrcweir};
137cdf0e10cSrcweir
138cdf0e10cSrcweir//=============================================================================
139cdf0e10cSrcweir
140cdf0e10cSrcweir}; }; }; };
141cdf0e10cSrcweir
142cdf0e10cSrcweir#endif
143