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_OfficeInstallationDirectories_idl__
25#define __com_sun_star_util_OfficeInstallationDirectories_idl__
26
27#ifndef __com_sun_star_util_XOfficeInstallationDirectories_idl__
28#include <com/sun/star/util/XOfficeInstallationDirectories.idl>
29#endif
30
31//============================================================================
32
33module com {  module sun {  module star {  module  util {
34
35//============================================================================
36
37/** encapsulates access to the current office installation directory and
38    office user data directory, provides functionality to create URLs
39    containing relocatable (not absolute) references to the current office
40    installation directory and user data directory and vice versa.
41
42    <p>This functionality is useful when data containing references to the
43    current office installation directory or user data directory must be made
44    persistent and re-read later. In many cases, storing the reference
45    directly would destroy the relocatability of an office installation and the
46    possibility to share one office user data directory among parallel office
47    installtions.
48
49    @since OpenOffice 2.0
50 */
51published service OfficeInstallationDirectories
52{
53  /** provides access to the current office installation directories (office
54      base installation and user data).
55    */
56  interface com::sun::star::util::XOfficeInstallationDirectories;
57};
58
59//============================================================================
60
61/** A singleton that provides access to the current office installation
62    directories.
63
64    @see OfficeInstallationDirectories
65*/
66published singleton theOfficeInstallationDirectories
67{
68    service com::sun::star::util::OfficeInstallationDirectories;
69};
70
71//============================================================================
72
73}; }; }; };
74
75#endif
76