offapi/com/sun/star/util/PathSubstitution.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: PathSubstitution.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_util_PathSubstitution_idl__
  32 #define __com_sun_star_util_PathSubstitution_idl__
  33
  34 #ifndef __com_sun_star_util_XStringSubstitution_idl__
  35 #include <com/sun/star/util/XStringSubstitution.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_container_XNameContainer_idl__
  39 #include <com/sun/star/container/XNameContainer.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_container_XContainerListener_idl__
  43 #include <com/sun/star/container/XContainerListener.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module  util {
  49
  50 //=============================================================================
  51
  52 /** A service to support the substitution and resubstitution of path variables.
  53
  54     <p>
  55     A path variable must be specified with the following synatx: "$("&lt;variable-name&gt;")".
  56     Path variables are not case sensitive and are always provided as a UCB-complient URL's
  57     (for example: "file:///c:/temp" or "file:///usr/install"). This is mandatory to support an
  58     optional remote file system.<br>
  59     A user defined list of path variables is supported. This list is stored     in the Office
  60     configuration file (org/openoffice/Office/Substitution.xml). Please have a  look at the
  61     schema definition file which configuration structure this file uses.<br>
  62     There is also a set of variables that have pre-defined values:
  63     </p>
  64     <dl>
  65     <dt>$(inst)</dt>
  66     <dd>Installation path of the Office Basis layer.</dd>
  67     <dt>$(prog)</dt>
  68     <dd>Program path of the Office Basis layer.</dd>
  69     <dt>$(brandbaseurl)</dt>
  70     <dd>Installation path of the the Office Brand layer.</dd>
  71     <dt>$(user)</dt>
  72     <dd>The user installation directory.</dd>
  73     <dt>$(work)</dt>
  74     <dd>The work directory of the user. Under Windows this would be the
  75     "MyDocuments" subdirectory. Under Unix this would be the home-directory</dd>
  76     <dt>$(home)</dt>
  77     <dd>The home directory of the user. Under Unix this would be the home-
  78         directory. Under Windows this would be the "Documents and Settings\<username>"
  79         subdirectory.</dd>
  80     <dt>$(temp)</dt>
  81     <dd>The current temporary directory.</dd>
  82     <dt>$(path)</dt>
  83     <dd>The value of PATH environment variable.</dd>
  84     <dt>$(lang)</dt>
  85     <dd>The country code used by the Office, like 01=english, 49=german.</dd>
  86     <dt>$(langid)</dt>
  87     <dd>The language code used by the Office, like 0x0009=english, 0x0409=english us.</dd>
  88     <dt>$(vlang)</dt>
  89     <dd>The language used by the Office as a string. Like "german" for a german Office.</dd>
  90     </dl>
  91
  92     @since OOo 1.1.2
  93 */
  94
  95 published service PathSubstitution
  96 {
  97     //-------------------------------------------------------------------------
  98     /** Interface to exchange path variables with defined paths and to resubstitute paths with path variables.
  99
 100         <p>
 101         To resubstitute path variables the caller must provide pathes as UCB-compliant URL's.
 102         </p>
 103     */
 104     interface com::sun::star::util::XStringSubstitution;
 105 };
 106
 107 //=============================================================================
 108
 109 }; }; }; };
 110
 111 #endif