offapi/com/sun/star/util/OfficeInstallationDirectories.idl

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