LibreOffice
LibreOffice 6.4 SDK API Reference
Public Member Functions | List of all members
XOfficeInstallationDirectories Interface Referencepublished

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. More...

import"XOfficeInstallationDirectories.idl";

Inheritance diagram for XOfficeInstallationDirectories:
XInterface OfficeInstallationDirectories theOfficeInstallationDirectories

Public Member Functions

string getOfficeInstallationDirectoryURL ()
 returns the absolute URL containing the directory of the current office installation (for example "file:///opt/LibreOffice") More...
 
string getOfficeUserDataDirectoryURL ()
 returns the absolute URL containing the directory where the current office installation expects its user data (for example "file:///home/kso/.config/libreoffice/4") More...
 
string makeRelocatableURL ([in] string URL)
 calculates a relocatable URL from the given URL. More...
 
string makeAbsoluteURL ([in] string URL)
 the counterpart of makeRelocatableURL. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

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.

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

Member Function Documentation

◆ getOfficeInstallationDirectoryURL()

string getOfficeInstallationDirectoryURL ( )

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.

◆ getOfficeUserDataDirectoryURL()

string getOfficeUserDataDirectoryURL ( )

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.

◆ makeAbsoluteURL()

string makeAbsoluteURL ( [in] string  URL)

the counterpart of makeRelocatableURL.

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 makeRelocatableURL, the respective placeholder will be replaced by an absolute reference to the current office installation directory or office user data directory.

Parameters
URLThe URL for that an absolute URL is requested. In case the URL does not contain the opaque relocation placeholder used by makeRelocatableURL, the input URL will be returned unchanged.
Returns
The absolute URL.

◆ makeRelocatableURL()

string makeRelocatableURL ( [in] string  URL)

calculates a relocatable URL from the given URL.

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. makeRelocatableURL must be used in order to re-replace the placeholder by an absolute reference.

Parameters
URLThe 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.

The documentation for this interface was generated from the following file: