offapi/com/sun/star/ucb/XFileIdentifierConverter.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com { module sun { module star { module ucb {
  22
  23 /** specifies methods to convert between (file) URLs and file paths in system
  24     dependent notation.
  25
  26     @version    1.0
  27 */
  28 published interface XFileIdentifierConverter : com::sun::star::uno::XInterface
  29 {
  30     /** Get information about the "locality" of a file content provider.
  31
  32         <p>The returned information can be used to choose the "best" among a
  33         number of file content providers implementing this interface.
  34
  35         @param BaseURL
  36         the base (file) URL used to specify a file content provider.
  37
  38         @returns
  39         an appropriate value representing the "locality" of the specified file
  40         content provider.   Generally, higher (non-negative) numbers denote
  41         file content providers that are more "local", and negative numbers
  42         denote content providers that are not file content providers at all.
  43         As a convention (and to keep this useful), values should be restricted
  44         to the range from -1 to +10, inclusive.
  45      */
  46     long getFileProviderLocality( [in] string BaseURL );
  47
  48     /** converts a file path in system dependent notation to a (file) URL.
  49
  50         @param BaseURL
  51         the base (file) URL relative to which the file path shall be
  52         interpreted.
  53
  54         @param SystemPath
  55         a file path in system dependent notation.
  56
  57         @returns
  58         the URL corresponding to the file path, or an empty string if the file
  59         path cannot be converted into a URL.
  60     */
  61     string getFileURLFromSystemPath( [in] string BaseURL,
  62                                      [in] string SystemPath );
  63
  64     /** converts a (file) URL to a file path in system dependent notation.
  65
  66         @param URL
  67         a (file) URL.
  68
  69         @returns
  70         the file path corresponding to the URL, or an empty string if the URL
  71         cannot be converted into a file path.
  72     */
  73     string getSystemPathFromFileURL( [in] string URL );
  74 };
  75
  76
  77 }; }; }; };
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */