Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 85 insertions, 0 deletions

diff --git a/offapi/com/sun/star/ucb/XFileIdentifierConverter.idl b/offapi/com/sun/star/ucb/XFileIdentifierConverter.idl
new file mode 100644
index 000000000..618cfa33b
--- /dev/null
+++ b/offapi/com/sun/star/ucb/XFileIdentifierConverter.idl
@@ -0,0 +1,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 choose 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: */