merge the formfield patch from ooo-build
[ooovba.git] / offapi / com / sun / star / ucb / XFileIdentifierConverter.idl
blobc0d2e72a91e297078c3510fe2332ac368d26c64b
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: XFileIdentifierConverter.idl,v $
10 * $Revision: 1.10 $
12 * This file is part of OpenOffice.org.
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
29 ************************************************************************/
30 #ifndef __com_sun_star_ucb_XFileIdentifierConverter_idl__
31 #define __com_sun_star_ucb_XFileIdentifierConverter_idl__
33 #ifndef __com_sun_star_uno_XInterface_idl__
34 #include <com/sun/star/uno/XInterface.idl>
35 #endif
37 //=============================================================================
39 module com { module sun { module star { module ucb {
41 //=============================================================================
42 /** specifies methods to convert between (file) URLs and file paths in system
43 dependent notation.
45 @version 1.0
46 @author Andreas Bille
48 published interface XFileIdentifierConverter : com::sun::star::uno::XInterface
50 //-------------------------------------------------------------------------
51 /** Get information about the 'locality' of a file content provider.
53 <p>The returned information can be used to chose the 'best' among a
54 number of file content providers implementing this interface.
56 @param BaseURL
57 the base (file) URL used to specify a file content provider.
59 @returns
60 an appropriat value representing the 'locality' of the specified file
61 content provider. Generally, higher (non-negative) numbers denote
62 file content providers that are more 'local', and negative numbers
63 denote content providers that are not file content providers at all.
64 As a convention (and to keep this useful), values should be restricted
65 to the range from -1 to +10, inclusive.
67 long getFileProviderLocality( [in] string BaseURL );
69 //-------------------------------------------------------------------------
70 /** converts a file path in system dependent notation to a (file) URL.
72 @param BaseURL
73 the base (file) URL relative to which the file path shall be
74 interpreted.
76 @param SystemPath
77 a file path in system dependent notation.
79 @returns
80 the URL corresponding to the file path, or an empty string if the file
81 path cannot be converted into a URL.
83 string getFileURLFromSystemPath( [in] string BaseURL,
84 [in] string SystemPath );
86 //-------------------------------------------------------------------------
87 /** converts a (file) URL to a file path in system dependent notation.
89 @param URL
90 a (file) URL.
92 @returns
93 the file path corresponding to the URL, or an empty string if the URL
94 cannot be converted into a file path.
96 string getSystemPathFromFileURL( [in] string URL );
99 //=============================================================================
101 }; }; }; };
103 #endif