From ed5640d8b587fbcfed7dd7967f3de04b37a76f26 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 11:06:44 +0200 Subject: Adding upstream version 4:7.4.7. Signed-off-by: Daniel Baumann --- offapi/com/sun/star/util/PathSubstitution.idl | 84 +++++++++++++++++++++++++++ 1 file changed, 84 insertions(+) create mode 100644 offapi/com/sun/star/util/PathSubstitution.idl (limited to 'offapi/com/sun/star/util/PathSubstitution.idl') 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 +#include +#include + + +module com { module sun { module star { module util { + + +/** A service to support the substitution and resubstitution of path variables. + +

+ A path variable must be specified with the following syntax: "$("<variable-name>")". + 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.
+ There is a set of variables that have pre-defined values: +

+
+
\$(inst)
+
Installation path of the Office.
+
\$(prog)
+
Program path of the Office.
+
\$(user)
+
The user installation directory.
+
\$(work)
+
The work directory of the user. Under Windows this would be the + "MyDocuments" subdirectory. Under Unix this would be the home-directory
+
\$(home)
+
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\\Documents".
+
\$(temp)
+
The current temporary directory.
+
\$(path)
+
The value of PATH environment variable.
+
\$(username)
+
The username (login name) of the currently active user, excluding the domain name on Windows. (Available since LibreOffice 5.2)
+
\$(langid)
+
The language code used by the Office, like 0x0009=English, 0x0409=English US.
+
\$(vlang)
+
The language used by the Office as a string. Like "German" for a German Office.
+
+

+ 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). +

+ + @since OOo 1.1.2 +*/ + +published service PathSubstitution : XStringSubstitution; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ -- cgit v1.2.3