Adding upstream version 1:7.0.4.upstream/1%7.0.4upstream

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

1 files changed, 84 insertions, 0 deletions

diff --git a/offapi/com/sun/star/util/PathSubstitution.idl b/offapi/com/sun/star/util/PathSubstitution.idl
new file mode 100644
index 000000000..1cee2597c
--- /dev/null
+++ b/offapi/com/sun/star/util/PathSubstitution.idl
@@ -0,0 +1,84 @@
+/* -*- 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_util_PathSubstitution_idl__
+#define __com_sun_star_util_PathSubstitution_idl__
+
+#include <com/sun/star/util/XStringSubstitution.idl>
+#include <com/sun/star/container/XNameContainer.idl>
+#include <com/sun/star/container/XContainerListener.idl>
+
+
+module com {  module sun {  module star {  module  util {
+
+
+/** A service to support the substitution and resubstitution of path variables.
+
+    <p>
+        A path variable must be specified with the following syntax: "$("&lt;variable-name&gt;")".
+        Path variables are not case sensitive and are always provided as a UCB-compliant URLs
+        (for example: "file:///c:/temp" or "file:///usr/install"). This is mandatory to support an
+        optional remote file system.<br>
+        There is a set of variables that have pre-defined values:
+    </p>
+    <dl>
+    <dt>\$(inst)</dt>
+    <dd>Installation path of the Office.</dd>
+    <dt>\$(prog)</dt>
+    <dd>Program path of the Office.</dd>
+    <dt>\$(user)</dt>
+    <dd>The user installation directory.</dd>
+    <dt>\$(work)</dt>
+    <dd>The work directory of the user. Under Windows this would be the
+        "MyDocuments" subdirectory. Under Unix this would be the home-directory</dd>
+    <dt>\$(home)</dt>
+    <dd>The home directory of the user. Under Unix this would be the home-
+        directory. Under Windows this would be the CSIDL_PERSONAL directory,
+        for example "Documents and Settings\<username>\Documents".</dd>
+    <dt>\$(temp)</dt>
+    <dd>The current temporary directory.</dd>
+    <dt>\$(path)</dt>
+    <dd>The value of PATH environment variable.</dd>
+    <dt>\$(username)</dt>
+    <dd>The username (login name) of the currently active user, excluding the domain name on Windows. (Available since LibreOffice 5.2)</dd>
+    <dt>\$(langid)</dt>
+    <dd>The language code used by the Office, like 0x0009=English, 0x0409=English US.</dd>
+    <dt>\$(vlang)</dt>
+    <dd>The language used by the Office as a string. Like "German" for a German Office.</dd>
+    </dl>
+    <p>
+        Attention: Most predefined variables describe an absolute path.
+        The only exceptions are: \$(username), \$(langid) and \$(vlang).
+        Therefore the service implementation should only substitute variables which
+        are located at the start of a provided path string or are part of a multi-path.
+        This special service is not designed to be a text substitution but shall
+        provide (a) valid substituted path(s).
+    </p>
+
+    @since OOo 1.1.2
+*/
+
+published service PathSubstitution : XStringSubstitution;
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */