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

is the interface for binding programmatic names to aliases. More...

import"XLocalizedAliases.idl";

Inheritance diagram for XLocalizedAliases:
XInterface DatabaseAccessContext

Public Member Functions

void bindAlias ([in]string programmaticName, [in]com::sun::star::lang::Locale locale, [in]string alias) raises (com::sun::star::container::ElementExistException)
 registers an alias for a programmatic name. More...
 
void unbindAlias ([in]com::sun::star::lang::Locale locale, [in]string alias) raises (com::sun::star::container::NoSuchElementException)
 revokes an alias for a programmatic name. More...
 
string lookupAlias ([in]com::sun::star::lang::Locale locale, [in]string Alias) raises (com::sun::star::container::NoSuchElementException)
 retrieves a registered programmatic name identified by an alias. More...
 
string lookupProgrammatic ([in]com::sun::star::lang::Locale locale, [in]string programmatic) raises (com::sun::star::container::NoSuchElementException)
 retrieves a given alias for a programmatic name. More...
 
void unbindAliases ([in]string programmaticName) raises (com::sun::star::container::NoSuchElementException)
 removes all aliases for a programmatic name. More...
 
void rebindAliases ([in]string currentProgrammatic, [in]string newProgrammatic) raises (com::sun::star::container::NoSuchElementException, com::sun::star::container::ElementExistException)
 rebinds all aliases registered to a given URL to a new one. More...
 
void renameAlias ([in]com::sun::star::lang::Locale locale, [in]string oldName, [in]string aNewName) raises (com::sun::star::container::NoSuchElementException, com::sun::star::container::ElementExistException)
 renames an alias for a programmatic name. More...
 
sequence< AliasProgrammaticPairlistAliases ([in]com::sun::star::lang::Locale locale)
 retrieves a list of all registered aliases for a certain language. 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

is the interface for binding programmatic names to aliases.

Aliases can be provided in several locales for the same programmatic name.

Member Function Documentation

◆ bindAlias()

void bindAlias ( [in] string  programmaticName,
[in] com::sun::star::lang::Locale  locale,
[in] string  alias 
)
raises (com::sun::star::container::ElementExistException
)

registers an alias for a programmatic name.

◆ listAliases()

sequence<AliasProgrammaticPair> listAliases ( [in] com::sun::star::lang::Locale  locale)

retrieves a list of all registered aliases for a certain language.

Parameters
localespecifies the locale scope.
Returns
a sequence of registered pair of alias and programmatic name.

◆ lookupAlias()

string lookupAlias ( [in] com::sun::star::lang::Locale  locale,
[in] string  Alias 
)
raises (com::sun::star::container::NoSuchElementException
)

retrieves a registered programmatic name identified by an alias.

◆ lookupProgrammatic()

string lookupProgrammatic ( [in] com::sun::star::lang::Locale  locale,
[in] string  programmatic 
)
raises (com::sun::star::container::NoSuchElementException
)

retrieves a given alias for a programmatic name.

◆ rebindAliases()

void rebindAliases ( [in] string  currentProgrammatic,
[in] string  newProgrammatic 
)
raises (com::sun::star::container::NoSuchElementException,
com::sun::star::container::ElementExistException
)

rebinds all aliases registered to a given URL to a new one.

◆ renameAlias()

void renameAlias ( [in] com::sun::star::lang::Locale  locale,
[in] string  oldName,
[in] string  aNewName 
)
raises (com::sun::star::container::NoSuchElementException,
com::sun::star::container::ElementExistException
)

renames an alias for a programmatic name.

◆ unbindAlias()

void unbindAlias ( [in] com::sun::star::lang::Locale  locale,
[in] string  alias 
)
raises (com::sun::star::container::NoSuchElementException
)

revokes an alias for a programmatic name.

◆ unbindAliases()

void unbindAliases ( [in] string  programmaticName)
raises (com::sun::star::container::NoSuchElementException
)

removes all aliases for a programmatic name.


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