/************************************************************************* * * $RCSfile: PathSettings.idl,v $ * * $Revision: 1.5 $ * * last change: $Author: rt $ $Date: 2003-04-17 10:19:55 $ * * 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_PathSettings_idl__ #define __com_sun_star_util_PathSettings_idl__ #ifndef __com_sun_star_beans_XPropertySet_idl__ #include #endif #ifndef __com_sun_star_beans_XFastPropertySet_idl__ #include #endif #ifndef __com_sun_star_beans_XMultiPropertySet_idl__ #include #endif //============================================================================= module com { module sun { module star { module util { //============================================================================= /** Supports read/write access and listener for the paths properties that the Office uses.

The property names of the Office paths/directories are an exactly match to the configuration entries found in the file (org/openoffice/Office/Common.xml).
This service supports the usage of path variables to define paths that a relative to other office or system directories. See PathSubstitution

@since #107627# */ service PathSettings { /** Main interface to have access to the path properties. */ interface com::sun::star::beans::XPropertySet; /** An extension to the XPropertySet interface. The get and set methods use handles to access the property values instead of character strings. */ interface com::sun::star::beans::XFastPropertySet; /** Provides access to multiple properties of this service with a single call. */ interface com::sun::star::beans::XMultiPropertySet; /** Specifies the directory that contains spreadsheet add-ins which use the old add-in API */ [property] string Addin; /** The settings of the AutoCorrect dialog. The value can be more than one path separated by a semicolon. */ [property] string AutoCorrect; /**The directory which contains the AutoText modules. The value can be more than one path separated by a semicolon.*/ [property] string AutoText; /** Automatic backup copies of documents are stored here. */ [property] string Backup; /** The Basic files, used by the AutoPilots, can be found here. The value can be more than one path separated by a semicolon.*/ [property] string Basic; /** This directory contains the icons for the toolbars. */ [property] string Bitmap; /** The configuration files are located here. This entry cannot be changed by the user in Office user interface. */ [property] string Config; /** The provided dictionaries are stored here. */ [property] string Dictionary; /** Path to save folder bookmarks */ [property] string Favorite; /** Specifies the directory where all the filters are stored. */ [property] string Filter; /** Specifies the directories which contains the Gallery database and multimedia files. The value can be more than one path separated by a semicolon.*/ [property] string Gallery; /** This directory is displayed when the dialog for opening a graphic or for saving a new graphic is called. */ [property] string Graphic; /** The path to the Office help files. */ [property] string Help; /** The files that are necessary for the spellcheck are saved here. */ [property] string Linguistic; /** This is the path for the modules. */ [property] string Module; /** This is the path to the palette files *.SOB to *.SOF containing user-defined colors and patterns. */ [property] string Palette; /** Plugins are saved in these directories. The value can be more than one path separated by a semicolon.*/ [property] string Plugin; /** Mail, News files and other information (for example, about FTP Server) are stored here.*/ [property] string Storage; /** The base url to the office temp-files */ [property] string Temp; /** The templates originate from these folders and sub-folders. The value can be more than one path separated by a semicolon.*/ [property] string Template; /** Global directories to look for user interface configuration files. The user interface configuration will be merged with user settings stored in the directory specified by UserConfig. The value can be more than one path separated by a semicolon.*/ [property] string UIConfig; /** Specifies the folder with the user settings. */ [property] string UserConfig; /** The custom dictionaries are contained here. */ [property] string UserDictionary; /** The path of the work folder can be modified according to the user's needs. The path specified here can be seen in the Open or Save dialog. */ [property] string Work; }; //============================================================================= }; }; }; }; #endif