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

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/



#ifndef __com_sun_star_util_OfficeInstallationDirectories_idl__
#define __com_sun_star_util_OfficeInstallationDirectories_idl__

#ifndef __com_sun_star_util_XOfficeInstallationDirectories_idl__
#include <com/sun/star/util/XOfficeInstallationDirectories.idl>
#endif

//============================================================================

module com {  module sun {  module star {  module  util {

//============================================================================

/** encapsulates access to the current office installation directory and
    office user data directory, provides functionality to create URLs
    containing relocatable (not absolute) references to the current office
    installation directory and user data directory and vice versa.

    <p>This functionality is useful when data containing references to the
    current office installation directory or user data directory must be made
    persistent and re-read later. In many cases, storing the reference
    directly would destroy the relocatability of an office installation and the
    possibility to share one office user data directory among parallel office
    installtions.

    @since OpenOffice 2.0
 */
published service OfficeInstallationDirectories
{
  /** provides access to the current office installation directories (office
      base installation and user data).
    */
  interface com::sun::star::util::XOfficeInstallationDirectories;
};

//============================================================================

/** A singleton that provides access to the current office installation
    directories.

    @see OfficeInstallationDirectories
*/
published singleton theOfficeInstallationDirectories
{
    service com::sun::star::util::OfficeInstallationDirectories;
};

//============================================================================

}; }; }; };

#endif