forked from amazingfate/loongoffice
d3a19d8eb7
it's unused internally as far as I can see and has very incomplete (and surely some wrong values) from some sort of mid 90s Euro-centric worldview Change-Id: Ibce9e8b76545791ab59b9e11c6ff6e1f33afcb3c
86 lines
3.5 KiB
Plaintext
86 lines
3.5 KiB
Plaintext
/* -*- 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: "$("<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.<br>
|
|
A user defined list of path variables is supported. This list is stored in the Office
|
|
configuration file (org/openoffice/Office/Substitution.xml). Please have a look at the
|
|
schema definition file which configuration structure this file uses.<br>
|
|
There is also 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 "Documents and Settings\<username>"
|
|
subdirectory.</dd>
|
|
<dt>\$(temp)</dt>
|
|
<dd>The current temporary directory.</dd>
|
|
<dt>\$(path)</dt>
|
|
<dd>The value of PATH environment variable.</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: \$(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 substiution 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: */
|