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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_util_URL_idl__
#define __com_sun_star_util_URL_idl__
module com { module sun { module star { module util {
/** represents the structure of an Uniform Resource Locator.
<p>
If the structure represents a valid URL or not depends on prior usage of
the functions of <type>XURLTransformer</type>. Only after one of the functions
returned <TRUE/> this can be assumed.</br>
It is not necessary to set all of the fields; either <member>URL::Complete</member>
or (some of) the others are set. Additionally, most of the other
fields, like <member>URL::Host</member>, <member>URL::Port</member>,
<member>URL::User</member>, <member>URL::Password</member>,
or <member>URL::Mark</member>, are optional.
@see XURLTransformer
</p>
*/
published struct URL
{
/** contains the string representation of the complete URL, for example,
http://www.sun.de:8080/pub/test/foo.txt?a=b#xyz
<p>
It is used as a central input/output or input parameter for the interfaces of
<type>XURLTransformer</type>. The usage of one of the <type>XURLTransformer</type>
function is mandatory to validate the URL. It cannot be assumed that
<member>URL::Complete</member> represents always a valid URL!
</p>
*/
string Complete;
/** contains the URL without a mark and without arguments, for example,
http://www.sun.de:8080/pub/test/foo.txt
*/
string Main;
/** contains the protocol (scheme) of the URL, for example, "http"
*/
string Protocol;
/** contains the user-identifier of the URL, for example, "me"
*/
string User;
/** contains the users password of the URL, for example, "pass"
*/
string Password;
/** contains the server part of the URL, for example, "www.sun.de"
*/
string Server;
/** contains the port at the server of the URL, for example, "8080"
*/
short Port;
/** contains all segments but the last one of the hierarchical path of the URL, for example, "/pub/test/"
*/
string Path;
/** contains the last segment of the hierarchical path of the URL, for the above example, "foo.txt"
<p>
<strong>Attention:</strong>A service implementing the <type>XURLTransformer</type> interface
will normally not detect if the last segment is a folder or a file. So it is possible that
the last segment describes a folder. If you want to be sure that a file URL that references
a folder will be correctly put into the URL fields you should append a "/" at the end of the
hierarchical path.
</p>
*/
string Name;
/** contains the arguments part of the URL, for example, "a=b"
*/
string Arguments;
/** contains the mark part of the URL, for example, "xyz"
*/
string Mark;
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|