LibreOffice 5.3 SDK API Reference
A service to support the substitution and resubstitution of path variables. More...
|Public Member Functions inherited from XStringSubstitution|
|string||substituteVariables ([in] string aText, [in] boolean bSubstRequired) raises ( com::sun::star::container::NoSuchElementException )|
|Exchanges variables inside a given text with a substitution text defined for the variables. More...|
|string||reSubstituteVariables ([in] string aText)|
|Tries to replace parts of aText with variables that represents these sub strings. More...|
|string||getSubstituteVariableValue ([in] string variable) raises (::com::sun::star::container::NoSuchElementException )|
|Returns the current value of a variable. More...|
|Public Member Functions inherited from XInterface|
|any||queryInterface ([in] type aType)|
|queries for a new interface to an existing UNO object. More...|
|increases the reference counter by one. More...|
|decreases the reference counter by one. More...|
A service to support the substitution and resubstitution of path variables.
A path variable must be specified with the following syntax: "$("<variable-name>")". Path variables are not case sensitive and are always provided as a UCB-compliant URLs (for example: "file:///c:/temp" or "file:///usr/install"). This is mandatory to support an optional remote file system.
There is a set of variables that have pre-defined values:
Attention: Most predefined variables describe an absolute path. The only exceptions are: $(username), $(langid) and $(vlang). Therefore the service implementation should only substitute variables which are located at the start of a provided path string or are part of a multi-path. This special service is not designed to be a text substiution but shall provide (a) valid substituted path(s).