offapi/com/sun/star/util/PathSettings.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: PathSettings.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_PathSettings_idl__
  32 #define __com_sun_star_util_PathSettings_idl__
  33
  34 #ifndef __com_sun_star_beans_XPropertySet_idl__
  35 #include <com/sun/star/beans/XPropertySet.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_beans_XFastPropertySet_idl__
  39 #include <com/sun/star/beans/XFastPropertySet.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_beans_XMultiPropertySet_idl__
  43 #include <com/sun/star/beans/XMultiPropertySet.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module  util {
  49
  50 //=============================================================================
  51
  52 /** Supports read/write access and listener for the paths properties that
  53     the Office uses.
  54     <p>
  55     The property names of the Office paths/directories are an exactly match
  56     to the configuration entries found in the file
  57     (org/openoffice/Office/Common.xml).<br>
  58     This service supports the usage of path variables to define
  59     paths that a relative to other office or system directories.
  60     See <type>PathSubstitution</type>
  61     </p>
  62
  63     @since OOo 1.1.2
  64  */
  65 published service PathSettings
  66 {
  67   /** Main interface to have access to the path properties. */
  68   interface com::sun::star::beans::XPropertySet;
  69
  70   /** An extension to the <type scope="com::sun::star::beans">XPropertySet</type> interface.
  71       The get and set methods use handles to access the property values
  72       instead of character strings. */
  73   interface com::sun::star::beans::XFastPropertySet;
  74
  75   /** Provides access to multiple properties of this service with a
  76       single call. */
  77   interface com::sun::star::beans::XMultiPropertySet;
  78
  79   /** Specifies the directory that contains spreadsheet add-ins which use
  80       the old add-in API */
  81   [property] string Addin;
  82
  83   /** The settings of the AutoCorrect dialog. The value can be more than
  84       one path separated by a semicolon.
  85   */
  86   [property] string AutoCorrect;
  87
  88   /**The directory which contains the AutoText modules. The value can be more than
  89       one path separated by a semicolon.*/
  90   [property] string AutoText;
  91
  92   /** Automatic backup copies of documents are stored here. */
  93   [property] string Backup;
  94
  95   /** The Basic files, used by the AutoPilots, can be found here. The value can be more than
  96       one path separated by a semicolon.*/
  97   [property] string Basic;
  98
  99   /** This directory contains the icons for the toolbars. */
 100   [property] string Bitmap;
 101
 102   /** The configuration files are located here. This entry cannot be changed
 103       by the user in Office user interface. */
 104   [property] string Config;
 105
 106   /** The provided dictionaries are stored here. */
 107   [property] string Dictionary;
 108
 109   /** Path to save folder bookmarks */
 110   [property] string Favorite;
 111
 112   /** Specifies the directory where all the filters are stored. */
 113   [property] string Filter;
 114
 115   /** Specifies the directories which contains the Gallery
 116       database and multimedia files. The value can be more than
 117       one path separated by a semicolon.*/
 118   [property] string Gallery;
 119
 120   /** This directory is displayed when the dialog for opening a graphic
 121       or for saving a new graphic is called. */
 122   [property] string Graphic;
 123
 124   /** The path to the Office help files. */
 125   [property] string Help;
 126
 127   /** The files that are necessary for the spellcheck are saved here. */
 128   [property] string Linguistic;
 129
 130   /** This is the path for the modules. */
 131   [property] string Module;
 132
 133   /** This is the path to the palette files *.SOB to *.SOF containing
 134       user-defined colors and patterns. */
 135   [property] string Palette;
 136
 137   /** Plugins are saved in these directories. The value can be more than
 138       one path separated by a semicolon.*/
 139   [property] string Plugin;
 140
 141   /** Mail, News files and other information (for example, about FTP Server)
 142       are stored here.*/
 143   [property] string Storage;
 144
 145   /** The base url to the office temp-files */
 146   [property] string Temp;
 147
 148   /** The templates originate from these folders and sub-folders. The value
 149       can be more than one path separated by a semicolon.*/
 150   [property] string Template;
 151
 152   /** Global directories to look for user interface configuration files. The
 153       user interface configuration will be merged with user settings stored
 154       in the directory specified by <var>UserConfig</var>. The value can be more
 155       than one path separated by a semicolon.*/
 156   [property] string UIConfig;
 157
 158   /** Specifies the folder with the user settings. */
 159   [property] string UserConfig;
 160
 161   /** The custom dictionaries are contained here.
 162    * @deprecated
 163    * */
 164   [property] string UserDictionary;
 165
 166   /** The path of the work folder can be modified according to the
 167       user's needs. The path specified here can be seen in the Open
 168       or Save dialog. */
 169   [property] string Work;
 170 };
 171
 172 //=============================================================================
 173
 174 }; }; }; };
 175
 176 #endif