1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_util_PathSettings_idl__
25#define __com_sun_star_util_PathSettings_idl__
26
27#ifndef __com_sun_star_beans_XPropertySet_idl__
28#include <com/sun/star/beans/XPropertySet.idl>
29#endif
30
31#ifndef __com_sun_star_beans_XFastPropertySet_idl__
32#include <com/sun/star/beans/XFastPropertySet.idl>
33#endif
34
35#ifndef __com_sun_star_beans_XMultiPropertySet_idl__
36#include <com/sun/star/beans/XMultiPropertySet.idl>
37#endif
38
39//=============================================================================
40
41module com {  module sun {  module star {  module  util {
42
43//=============================================================================
44
45/** Supports read/write access and listener for the paths properties that
46    the Office uses.
47	<p>
48	The property names of the Office paths/directories are an exactly match
49	to the configuration entries found in the file
50	(org/openoffice/Office/Common.xml).<br>
51	This service supports the usage of path variables to define
52	paths that a relative to other office or system directories.
53	See <type>PathSubstitution</type>
54	</p>
55
56    @since OOo 1.1.2
57 */
58published service PathSettings
59{
60  /** Main interface to have access to the path properties. */
61  interface com::sun::star::beans::XPropertySet;
62
63  /** An extension to the <type scope="com::sun::star::beans">XPropertySet</type> interface.
64      The get and set methods use handles to access the property values
65	  instead of character strings. */
66  interface com::sun::star::beans::XFastPropertySet;
67
68  /** Provides access to multiple properties of this service with a
69      single call. */
70  interface com::sun::star::beans::XMultiPropertySet;
71
72  /** Specifies the directory that contains spreadsheet add-ins which use
73      the old add-in API */
74  [property] string Addin;
75
76  /** The settings of the AutoCorrect dialog. The value can be more than
77      one path separated by a semicolon.
78  */
79  [property] string AutoCorrect;
80
81  /**The directory which contains the AutoText modules. The value can be more than
82      one path separated by a semicolon.*/
83  [property] string AutoText;
84
85  /** Automatic backup copies of documents are stored here. */
86  [property] string Backup;
87
88  /** The Basic files, used by the AutoPilots, can be found here. The value can be more than
89      one path separated by a semicolon.*/
90  [property] string Basic;
91
92  /** This directory contains the icons for the toolbars. */
93  [property] string Bitmap;
94
95  /** The configuration files are located here. This entry cannot be changed
96      by the user in Office user interface. */
97  [property] string Config;
98
99  /** The provided dictionaries are stored here. */
100  [property] string Dictionary;
101
102  /** Path to save folder bookmarks */
103  [property] string Favorite;
104
105  /** Specifies the directory where all the filters are stored. */
106  [property] string Filter;
107
108  /** Specifies the directories which contains the Gallery
109      database and multimedia files. The value can be more than
110      one path separated by a semicolon.*/
111  [property] string Gallery;
112
113  /** This directory is displayed when the dialog for opening a graphic
114      or for saving a new graphic is called. */
115  [property] string Graphic;
116
117  /** The path to the Office help files. */
118  [property] string Help;
119
120  /** The files that are necessary for the spellcheck are saved here. */
121  [property] string Linguistic;
122
123  /** This is the path for the modules. */
124  [property] string Module;
125
126  /** This is the path to the palette files *.SOB to *.SOF containing
127      user-defined colors and patterns. */
128  [property] string Palette;
129
130  /** Plugins are saved in these directories. The value can be more than
131      one path separated by a semicolon.*/
132  [property] string Plugin;
133
134  /** Mail, News files and other information (for example, about FTP Server)
135      are stored here.*/
136  [property] string Storage;
137
138  /** The base url to the office temp-files */
139  [property] string Temp;
140
141  /** The templates originate from these folders and sub-folders. The value
142      can be more than one path separated by a semicolon.*/
143  [property] string Template;
144
145  /** Global directories to look for user interface configuration files. The
146      user interface configuration will be merged with user settings stored
147	  in the directory specified by <var>UserConfig</var>. The value can be more
148	  than one path separated by a semicolon.*/
149  [property] string UIConfig;
150
151  /** Specifies the folder with the user settings. */
152  [property] string UserConfig;
153
154  /** The custom dictionaries are contained here.
155   * @deprecated
156   * */
157  [property] string UserDictionary;
158
159  /** The path of the work folder can be modified according to the
160      user's needs. The path specified here can be seen in the Open
161	  or Save dialog. */
162  [property] string Work;
163};
164
165//=============================================================================
166
167}; }; }; };
168
169#endif
170