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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
/*************************************************************************
*
* $RCSfile: fileidentifierconverter.hxx,v $
*
* $Revision: 1.5 $
*
* last change: $Author: vg $ $Date: 2005-02-16 15:44:41 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef _UCBHELPER_FILEIDENTIFIERCONVERTER_HXX_
#define _UCBHELPER_FILEIDENTIFIERCONVERTER_HXX_
#ifndef _COM_SUN_STAR_UNO_REFERENCE_HXX_
#include <com/sun/star/uno/Reference.hxx>
#endif
#ifndef _COM_SUN_STAR_UNO_RUNTIMEEXCEPTION_HPP_
#include <com/sun/star/uno/RuntimeException.hpp>
#endif
#ifndef _SAL_TYPES_H_
#include <sal/types.h>
#endif
#ifndef INCLUDED_UCBHELPERDLLAPI_H
#include "ucbhelper/ucbhelperdllapi.h"
#endif
namespace com { namespace sun { namespace star { namespace ucb {
class XContentProviderManager;
} } } }
namespace rtl { class OUString; }
namespace ucb {
//============================================================================
/** Get a 'root' URL for the most 'local' file content provider.
@descr
The result can be used as the rBaseURL parameter of
ucb::getFileURLFromSystemPath().
@param rManager
A content provider manager. Must not be null.
@returns
either a 'root' URL for the most 'local' file content provider, or an
empty string, if no such URL can meaningfully be constructed.
*/
UCBHELPER_DLLPUBLIC rtl::OUString getLocalFileURL(
com::sun::star::uno::Reference<
com::sun::star::ucb::XContentProviderManager > const &
rManager)
SAL_THROW((com::sun::star::uno::RuntimeException));
//============================================================================
/** Using a specific content provider manager, convert a file path in system
dependent notation to a (file) URL.
@param rManager
A content provider manager. Must not be null.
@param rBaseURL
See the corresponding parameter of
com::sun::star::ucb::XFileIdentifierConverter::getFileURLFromSystemPath().
@param rURL
See the corresponding parameter of
com::sun::star::ucb::XFileIdentifierConverter::getFileURLFromSystemPath().
@returns
a URL, if the content provider registered at the content provider manager
that is responsible for the base URL returns a URL when calling
com::sun::star::ucb::XFileIdentiferConverter::getFileURLFromSystemPath()
on it. Otherwise, an empty string is returned.
@see
com::sun::star::ucb::XFileIdentiferConverter::getFileURLFromSystemPath().
*/
UCBHELPER_DLLPUBLIC rtl::OUString
getFileURLFromSystemPath(
com::sun::star::uno::Reference<
com::sun::star::ucb::XContentProviderManager > const &
rManager,
rtl::OUString const & rBaseURL,
rtl::OUString const & rSystemPath)
SAL_THROW((com::sun::star::uno::RuntimeException));
//============================================================================
/** Using a specific content provider manager, convert a (file) URL to a
file path in system dependent notation.
@param rManager
A content provider manager. Must not be null.
@param rURL
See the corresponding parameter of
com::sun::star::ucb::XFileIdentiferConverter::getSystemPathFromFileURL().
@returns
a system path, if the content provider registered at the content provider
manager that is responsible for the base URL returns a system path when
calling
com::sun::star::ucb::XFileIdentiferConverter::getSystemPathFromFileURL()
on it. Otherwise, an empty string is returned.
@see
com::sun::star::ucb::XFileIdentiferConverter::getSystemPathFromFileURL().
*/
UCBHELPER_DLLPUBLIC rtl::OUString
getSystemPathFromFileURL(
com::sun::star::uno::Reference<
com::sun::star::ucb::XContentProviderManager > const &
rManager,
rtl::OUString const & rURL)
SAL_THROW((com::sun::star::uno::RuntimeException));
}
#endif // _UCBHELPER_FILEIDENTIFIERCONVERTER_HXX_
|
