blob: 0f210ea1251bccc8883eb945cf9ea5ba239c3124 (
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
|
/* -*- 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_ucb_XFileIdentifierConverter_idl__
#define __com_sun_star_ucb_XFileIdentifierConverter_idl__
#include <com/sun/star/uno/XInterface.idl>
module com { module sun { module star { module ucb {
/** specifies methods to convert between (file) URLs and file paths in system
dependent notation.
@version 1.0
*/
published interface XFileIdentifierConverter : com::sun::star::uno::XInterface
{
/** Get information about the "locality" of a file content provider.
<p>The returned information can be used to chose the "best" among a
number of file content providers implementing this interface.
@param BaseURL
the base (file) URL used to specify a file content provider.
@returns
an appropriate value representing the "locality" of the specified file
content provider. Generally, higher (non-negative) numbers denote
file content providers that are more "local", and negative numbers
denote content providers that are not file content providers at all.
As a convention (and to keep this useful), values should be restricted
to the range from -1 to +10, inclusive.
*/
long getFileProviderLocality( [in] string BaseURL );
/** converts a file path in system dependent notation to a (file) URL.
@param BaseURL
the base (file) URL relative to which the file path shall be
interpreted.
@param SystemPath
a file path in system dependent notation.
@returns
the URL corresponding to the file path, or an empty string if the file
path cannot be converted into a URL.
*/
string getFileURLFromSystemPath( [in] string BaseURL,
[in] string SystemPath );
/** converts a (file) URL to a file path in system dependent notation.
@param URL
a (file) URL.
@returns
the file path corresponding to the URL, or an empty string if the URL
cannot be converted into a file path.
*/
string getSystemPathFromFileURL( [in] string URL );
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
