1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_ucb_XFileIdentifierConverter_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_ucb_XFileIdentifierConverter_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski//============================================================================= 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module ucb { 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski//============================================================================= 35*b1cdbd2cSJim Jagielski/** specifies methods to convert between (file) URLs and file paths in system 36*b1cdbd2cSJim Jagielski dependent notation. 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski @version 1.0 39*b1cdbd2cSJim Jagielski @author Andreas Bille 40*b1cdbd2cSJim Jagielski*/ 41*b1cdbd2cSJim Jagielskipublished interface XFileIdentifierConverter : com::sun::star::uno::XInterface 42*b1cdbd2cSJim Jagielski{ 43*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 44*b1cdbd2cSJim Jagielski /** Get information about the 'locality' of a file content provider. 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski <p>The returned information can be used to chose the 'best' among a 47*b1cdbd2cSJim Jagielski number of file content providers implementing this interface. 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski @param BaseURL 50*b1cdbd2cSJim Jagielski the base (file) URL used to specify a file content provider. 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski @returns 53*b1cdbd2cSJim Jagielski an appropriat value representing the 'locality' of the specified file 54*b1cdbd2cSJim Jagielski content provider. Generally, higher (non-negative) numbers denote 55*b1cdbd2cSJim Jagielski file content providers that are more 'local', and negative numbers 56*b1cdbd2cSJim Jagielski denote content providers that are not file content providers at all. 57*b1cdbd2cSJim Jagielski As a convention (and to keep this useful), values should be restricted 58*b1cdbd2cSJim Jagielski to the range from -1 to +10, inclusive. 59*b1cdbd2cSJim Jagielski */ 60*b1cdbd2cSJim Jagielski long getFileProviderLocality( [in] string BaseURL ); 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 63*b1cdbd2cSJim Jagielski /** converts a file path in system dependent notation to a (file) URL. 64*b1cdbd2cSJim Jagielski 65*b1cdbd2cSJim Jagielski @param BaseURL 66*b1cdbd2cSJim Jagielski the base (file) URL relative to which the file path shall be 67*b1cdbd2cSJim Jagielski interpreted. 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski @param SystemPath 70*b1cdbd2cSJim Jagielski a file path in system dependent notation. 71*b1cdbd2cSJim Jagielski 72*b1cdbd2cSJim Jagielski @returns 73*b1cdbd2cSJim Jagielski the URL corresponding to the file path, or an empty string if the file 74*b1cdbd2cSJim Jagielski path cannot be converted into a URL. 75*b1cdbd2cSJim Jagielski */ 76*b1cdbd2cSJim Jagielski string getFileURLFromSystemPath( [in] string BaseURL, 77*b1cdbd2cSJim Jagielski [in] string SystemPath ); 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 80*b1cdbd2cSJim Jagielski /** converts a (file) URL to a file path in system dependent notation. 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski @param URL 83*b1cdbd2cSJim Jagielski a (file) URL. 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski @returns 86*b1cdbd2cSJim Jagielski the file path corresponding to the URL, or an empty string if the URL 87*b1cdbd2cSJim Jagielski cannot be converted into a file path. 88*b1cdbd2cSJim Jagielski */ 89*b1cdbd2cSJim Jagielski string getSystemPathFromFileURL( [in] string URL ); 90*b1cdbd2cSJim Jagielski}; 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski//============================================================================= 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski}; }; }; }; 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski#endif 97