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