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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: OfficeInstallationDirectories.idl,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_util_OfficeInstallationDirectories_idl__
  32 #define __com_sun_star_util_OfficeInstallationDirectories_idl__
  33
  34 #ifndef __com_sun_star_util_XOfficeInstallationDirectories_idl__
  35 #include <com/sun/star/util/XOfficeInstallationDirectories.idl>
  36 #endif
  37
  38 //============================================================================
  39
  40 module com {  module sun {  module star {  module  util {
  41
  42 //============================================================================
  43
  44 /** encapsulates access to the current office installation directory and
  45     office user data directory, provides functionality to create URLs
  46     containing relocatable (not absolute) references to the current office
  47     installation directory and user data directory and vice versa.
  48
  49     <p>This functionality is useful when data containing references to the
  50     current office installation directory or user data directory must be made
  51     persistent and re-read later. In many cases, storing the reference
  52     directly would destroy the relocatability of an office installation and the
  53     possibility to share one office user data directory among parallel office
  54     installtions.
  55
  56     @since OOo 2.0.0
  57  */
  58 service OfficeInstallationDirectories
  59 {
  60   /** provides access to the current office installation directories (office
  61       base installation and user data).
  62     */
  63   interface com::sun::star::util::XOfficeInstallationDirectories;
  64 };
  65
  66 //============================================================================
  67
  68 /** A singleton that provides access to the current office installation
  69     directories.
  70
  71     @see OfficeInstallationDirectories
  72 */
  73 singleton theOfficeInstallationDirectories
  74 {
  75     service com::sun::star::util::OfficeInstallationDirectories;
  76 };
  77
  78 //============================================================================
  79
  80 }; }; }; };
  81
  82 #endif