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
|
/* -*- 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 _UCBHELPER_FILEIDENTIFIERCONVERTER_HXX_
#define _UCBHELPER_FILEIDENTIFIERCONVERTER_HXX_
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/uno/RuntimeException.hpp>
#include <sal/types.h>
#include "ucbhelper/ucbhelperdllapi.h"
namespace com { namespace sun { namespace star { namespace ucb {
class XUniversalContentBroker;
} } } }
namespace rtl { class OUString; }
namespace ucbhelper {
//============================================================================
/** Get a 'root' URL for the most 'local' file content provider.
@descr
The result can be used as the rBaseURL parameter of
ucb::getFileURLFromSystemPath().
@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 OUString getLocalFileURL()
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 OUString
getFileURLFromSystemPath(
com::sun::star::uno::Reference<
com::sun::star::ucb::XUniversalContentBroker > const &
rUcb,
OUString const & rBaseURL,
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 OUString
getSystemPathFromFileURL(
com::sun::star::uno::Reference<
com::sun::star::ucb::XUniversalContentBroker > const &
rUcb,
OUString const & rURL)
SAL_THROW((com::sun::star::uno::RuntimeException));
}
#endif // _UCBHELPER_FILEIDENTIFIERCONVERTER_HXX_
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
