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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_util_theOfficeInstallationDirectories_idl__
  21 #define __com_sun_star_util_theOfficeInstallationDirectories_idl__
  22
  23 #include <com/sun/star/util/XOfficeInstallationDirectories.idl>
  24
  25
  26 module com {  module sun {  module star {  module  util {
  27
  28
  29 /** encapsulates access to the current office installation directory and
  30     office user data directory, provides functionality to create URLs
  31     containing relocatable (not absolute) references to the current office
  32     installation directory and user data directory and vice versa.
  33
  34     <p>This functionality is useful when data containing references to the
  35     current office installation directory or user data directory must be made
  36     persistent and re-read later. In many cases, storing the reference
  37     directly would destroy the relocatability of an office installation and the
  38     possibility to share one office user data directory among parallel office
  39     installations.
  40  */
  41 published singleton theOfficeInstallationDirectories : XOfficeInstallationDirectories;
  42
  43
  44 }; }; }; };
  45
  46 #endif
  47
  48 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */