MWS_SRX644: migrate branch mws_srx644 -> HEAD

1 files changed, 138 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 000000000000..f85e9924f8a6
--- /dev/null
+++ b/offapi/com/sun/star/util/PathSubstitution.idl
@@ -0,0 +1,138 @@
+/*************************************************************************
+ *
+ *  $RCSfile: PathSubstitution.idl,v $
+ *
+ *  $Revision: 1.4 $
+ *
+ *  last change: $Author: hr $ $Date: 2003-03-26 13:58:10 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_util_PathSubstitution_idl__
+#define __com_sun_star_util_PathSubstitution_idl__
+
+#ifndef __com_sun_star_util_XStringSubstitution_idl__
+#include <com/sun/star/util/XStringSubstitution.idl>
+#endif
+
+#ifndef __com_sun_star_container_XNameContainer_idl__
+#include <com/sun/star/container/XNameContainer.idl>
+#endif
+
+#ifndef __com_sun_star_container_XContainerListener_idl__
+#include <com/sun/star/container/XContainerListener.idl>
+#endif
+
+//=============================================================================
+
+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 synatx: "$("&lt;variable-name&gt;")".
+    Path variables are not case sensitive and are always provided as a UCB-complient URL's
+    (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>$(lang)</dt>
+    <dd>The country code used by the Office, like 01=english, 49=german.</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>
+*/
+
+service PathSubstitution
+{
+    //-------------------------------------------------------------------------
+    /** Interface to exchange path variables with defined paths and to resubstitute paths with path variables.
+
+        <p>
+        To resubstitute path variables the caller must provide pathes as UCB-compliant URL's.
+        </p>
+    */
+    interface com::sun::star::util::XStringSubstitution;
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif