LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XExternalUriReferenceTranslator Interface Referencepublished

translates between external and internal URI references. More...

import"XExternalUriReferenceTranslator.idl";

Inheritance diagram for XExternalUriReferenceTranslator:
ExternalUriReferenceTranslator

Public Member Functions

string translateToInternal ([in] string externalUriReference)
 returns the internal counterpart of an external URI reference. More...
 
string translateToExternal ([in] string internalUriReference)
 returns the external counterpart of an internal URI reference. More...
 

Detailed Description

translates between external and internal URI references.

Some URI schemes leave unspecified important aspects of how to interpret URIs of those schemes. For example, it is unspecified for “file” URLs how to map the byte sequences that constitute the path segments of a “file” URL to filenames on a given platform: The UNO environment always assumes that path segments of “file” URLs represent UTF-8–encoded strings (which have to be mapped to filenames in a platform-specific way), while other applications typically assume that path segments of “file” URLs directly represent a platform's byte-sequence filenames. This interface offers methods to translate between such internal URIs (e.g., UTF-8–encoded “file” URLs used within the UNO environment) and external URIs (e.g., byte-sequence–oriented “file” URLs used by other applications). Typically, only “file” URLs are affected by this translation.

Since the translation process is based on URI schemes, relative URI references (that do not include a scheme) are left unmodified by the translation process.

Since
OOo 2.0

Member Function Documentation

string translateToExternal ( [in] string  internalUriReference)

returns the external counterpart of an internal URI reference.

Parameters
internalUriReferencean internal URI reference.
Returns
the external counterpart of the given internal URI reference. An empty string is returned if the given internal URI reference either is an empty string or cannot be converted (for example, because it contains illegal characters).
string translateToInternal ( [in] string  externalUriReference)

returns the internal counterpart of an external URI reference.

Parameters
externalUriReferencean external URI reference.
Returns
the internal counterpart of the given external URI reference. An empty string is returned if the given external URI reference either is an empty string or cannot be converted (for example, because it contains illegal characters).

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