LibreOffice
LibreOffice 4.2 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
List of all members
OfficeResourceLoader Singleton Reference

describes a XResourceBundleLoader which provides access to the OpenOffice.org resource files. More...

import"OfficeResourceLoader.idl";

Inheritance diagram for OfficeResourceLoader:
XResourceBundleLoader XInterface

Additional Inherited Members

- Public Member Functions inherited from XResourceBundleLoader
com::sun::star::resource::XResourceBundle loadBundle_Default ([in] string aBaseName) raises ( com::sun::star::resource::MissingResourceException )
 loads the appropriate resource bundle. More...
 
com::sun::star::resource::XResourceBundle loadBundle ([in] string abaseName, [in] com::sun::star::lang::Locale aLocale) raises ( com::sun::star::resource::MissingResourceException )
 loads the appropriate resource bundle subclass. 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

describes a XResourceBundleLoader which provides access to the OpenOffice.org resource files.

An OpenOffice.org installation comes with a number of resource files in an proprietary format, located inside the installation's program/resource directory. The OfficeResourceLoader singleton (available at a component context as value with the key /singletons/com.sun.star.resource.OfficeResourceLoader), provides access to some types of resources within those files.

Clients have to specify the resource file base name in the call to XResourceBundleLoader::loadBundle() resp. XResourceBundleLoader::loadBundle_Default() method. The loader will extent this base name so that the resulting name conforms to the OpenOffice.org resource file naming conventions, and look up the respective resource file, for the requested locale, in OpenOffice.org's installation.

The lookup process uses the fallback mechanism as described at the XResourceBundle interface, except that Locale.getDefault() is not used.

Resource keys, as passed to the XResourceBundle::getDirectElement() or com::sun::star::container::XNameAccess::getByName(), have the following format: <resource_type>:<numeric_identifier>, where <resource_type> specifies the type of the requested resource (see below) and <numeric_identifier> is the numeric identifier of the resource.

The following resource types are currently supported:

Since the numeric resource identifiers are highly build-dependent (e.g. can change with any next OpenOffice.org build), you are strongly discouraged from using the OfficeResoureLoader service in a component which targets more than one particular OpenOffice.org build.

Since
OOo 2.0.3

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