blob: 4465926bdb0547d23026b5a6c63c8b94cda5cf6c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_util_XURLTransformer_idl__
#define __com_sun_star_util_XURLTransformer_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/util/URL.idl>
module com { module sun { module star { module util {
/** supports parsing and assembling of URLs
@see URL
@see URLTransformer
*/
published interface XURLTransformer: com::sun::star::uno::XInterface
{
/** parses the string in <member>URL::Complete</member> which should contain
a syntactically complete URL.
<p>
The implementation is allowed to correct minor failures in <member>URL::Complete</member>
if the meaning of the URL remain unchanged. Parts of the URL are stored in the other
fields of <var>aURL</var>.
</p>
@param aURL
the URL which include the complete string notation and will contain
all parsed parts of it after finishing this call. <member>URL::Complete</member>
can be overwritten if the implementation corrected minor failures.
@returns
<TRUE/> if parsing was successfully (means if given URL was syntactically correct)
or <FALSE/> otherwise.
*/
boolean parseStrict( [inout] com::sun::star::util::URL aURL );
/** parses the string in <member>URL::Complete</member>, which may contain
a syntactically complete URL or is specified by the provided protocol
<p>
The implementation can use smart functions to correct or interpret
<member>URL::Complete</member> if it is not a syntactically complete URL.
The parts of the URL are stored in the other fields of <var>aURL</var>.
</p>
@param aURL
the URL which include the string notation and will contain
all parsed parts of it after finishing this call. This includes
<member>URL::Complete</member>.
@param sSmartProtocol
optional information which protocol specification should be used to parse
member<member>URL::Complete</member>. If empty the implementation can use a
protocol which fit best.
@returns
<TRUE/> if parsing was successful (means if <member>URL::Complete</member> could
be syntactically correct) or <FALSE/> otherwise.
*/
boolean parseSmart(
[inout] com::sun::star::util::URL aURL,
[in] string sSmartProtocol );
/** assembles the parts of the URL specified by <var>aURL</var> and
stores it into <member>URL::Complete</member>
@param aURL
the URL which contains alls necessary information in a structured form. The
member <member>URL::Complete</member> contains the URL in string notation after
the operation finished successfully. Otherwise the content of <member>URL::complete</member>
is not defined.
@returns
<TRUE/> if assembling was successfully or <FALSE/> otherwise.
*/
boolean assemble( [inout] com::sun::star::util::URL aURL );
/** returns a representation of the URL for UI purposes only
<p>
Sometimes it can be useful to show an URL on an user interface
in a more "human readable" form. Such URL can't be used on any API
call, but make it easier for the user to understand it.
</p>
@param aURL
URL in structured form which should be shown at the UI
@param bWithPassword
specifies whether the password will be included in the encoding
or not. Usually passwords should never be shown at the user
interface.
@returns
a string representing the <var>aURL</var> if it is syntactically correct. A empty string if <var>aURL</var>
is not syntactically correct.
*/
string getPresentation(
[in] com::sun::star::util::URL aURL,
[in] boolean bWithPassword );
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
