| /************************************************************** |
| * |
| * 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_XOfficeInstallationDirectories_idl__ |
| #define __com_sun_star_util_XOfficeInstallationDirectories_idl__ |
| |
| #ifndef __com_sun_star_uno_XInterface_idl__ |
| #include <com/sun/star/uno/XInterface.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 must be made persistent and re-read |
| later. In many cases, storing the reference directly would destroy the |
| relocatability of an office installation. |
| |
| @since OpenOffice 2.0 |
| */ |
| published interface XOfficeInstallationDirectories : com::sun::star::uno::XInterface |
| { |
| //------------------------------------------------------------------------ |
| /** returns the absolute URL containing the directory of the current office |
| installation (e.g. "file:///opt/OpenOffice.org".) |
| |
| @returns |
| the absolute URL containing the directory of the current office |
| installation. |
| */ |
| string getOfficeInstallationDirectoryURL(); |
| |
| //------------------------------------------------------------------------ |
| /** returns the absolute URL containing the directory where the current |
| office installation expects its user data (e.g. |
| "file:///home/kso/.openoffice.org".) |
| |
| @returns |
| the absolute URL containing the directory of the current office |
| user data. |
| */ |
| string getOfficeUserDataDirectoryURL(); |
| |
| //------------------------------------------------------------------------ |
| /** calculates a relocatable URL from the given URL. |
| |
| <p>If the given URL contains an absolute reference to the current office |
| installation directory or office user data directory, this method will |
| replace the absolute reference by an opaque placeholder string. |
| <code>makeRelocatableURL</code> must be used in order to re-replace the |
| placeholder by an absolute reference. |
| |
| @param URL |
| The URL for that a relocatable URL is requested. In case the URL does |
| not contain a reference to the current office installation or to the office |
| user data directory, the input URL will be returned unchanged. |
| |
| @returns |
| The relocatable URL. |
| */ |
| string makeRelocatableURL( [in] string URL ); |
| |
| //------------------------------------------------------------------------ |
| /** the counterpart of <code>makeRelocatableURL</code>. |
| |
| <p>If the given URL contains a placeholder for an absolute reference to |
| the current office installation directory or for the office user data |
| directory, that was created using <code>makeRelocatableURL</code>, the |
| respective placeholder will be replaced by an absolute reference to the |
| current office installation directory or office user data directory. |
| |
| @param URL |
| The URL for that an absolaute URL is requested. In case the URL does |
| not contain the opaque relocation placholder used by |
| <code>makeRelocatableURL</code>, the input URL will be returned |
| unchanged. |
| |
| @returns |
| The absolute URL. |
| */ |
| string makeAbsoluteURL( [in] string URL ); |
| }; |
| |
| }; }; }; }; |
| |
| #endif |