diff options
Diffstat (limited to 'offapi/com/sun/star/util/XOfficeInstallationDirectories.idl')
-rw-r--r-- | offapi/com/sun/star/util/XOfficeInstallationDirectories.idl | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/offapi/com/sun/star/util/XOfficeInstallationDirectories.idl b/offapi/com/sun/star/util/XOfficeInstallationDirectories.idl new file mode 100644 index 0000000000..5451a44f69 --- /dev/null +++ b/offapi/com/sun/star/util/XOfficeInstallationDirectories.idl @@ -0,0 +1,95 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * 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 . + */ + +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 OOo 2.0 + */ +published interface XOfficeInstallationDirectories : com::sun::star::uno::XInterface +{ + /** returns the absolute URL containing the directory of the current office + installation (for example "file:///opt/LibreOffice") + + @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 (for example + "file:///home/kso/.config/libreoffice/4") + + @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 absolute URL is requested. In case the URL does + not contain the opaque relocation placeholder used by + <code>makeRelocatableURL</code>, the input URL will be returned + unchanged. + + @returns + The absolute URL. + */ + string makeAbsoluteURL( [in] string URL ); +}; + +}; }; }; }; + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |