| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #ifndef __com_sun_star_resource_OfficeResourceLoader_idl__ |
| #define __com_sun_star_resource_OfficeResourceLoader_idl__ |
| |
| #ifndef __com_sun_star_resource_XResourceBundleLoader_idl__ |
| #include <com/sun/star/resource/XResourceBundleLoader.idl> |
| #endif |
| |
| //============================================================================= |
| module com { module sun { module star { module resource { |
| //============================================================================= |
| |
| /** describes a <type>XResourceBundleLoader</type> which provides access to the OpenOffice.org |
| resource files. |
| |
| <p>An OpenOffice.org installation comes with a number of resource files in an proprietary |
| format, located insisde the installation's program/resource directory. The <type>OfficeResoureLoader</type> |
| singleton (available at a component context as value with the key |
| <code>/singletons/com.sun.star.resource.OfficeResourceLoader</code>), provides access to some |
| types of resources within those files.</p> |
| |
| <p>Clients have to specifiy the resource file base name in the call to |
| <member>XResourceBundleLoader::loadBundle</member> resp. <member>XResourceBundleLoader::loadBundle_Default</member> |
| 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.</p> |
| |
| <p>The lookup process uses the fallback mechanism as described at the <type>XResourceBundle</type> interface, |
| except that <code>Locale.getDefault()</code> is not used.</p> |
| |
| <p>Resource keys, as passed to the <member>XResourceBundle::getDirectElement</member> or |
| <member scope="com::sun::star::container">XNameAccess::getByName</member>, have the following format: |
| <code><resource_type>:<numeric_identifier></code>, where <code><resource_type> specifies |
| the type of the requested resource (see below) and <code><numeric_identifier></code> is the numeric |
| identifier of the resource.</p> |
| |
| <p>The following resource types are currently supported: |
| <ul> |
| <li><em>string</em>: denotes a string resource</li> |
| </ul> |
| </p> |
| |
| <p>Since the numeric resource identifiers are highly build-dependent (e.g. can change with any next |
| OpenOffice.org build), you are <strong>strongly</strong> discouraged from using the <type>OfficeResoureLoader</type> |
| service in a component which targets more than one particular OpenOffice.org build.</p> |
| |
| @since OpenOffice 2.0.3 |
| */ |
| singleton OfficeResourceLoader : XResourceBundleLoader; |
| |
| //============================================================================= |
| }; }; }; }; |
| //============================================================================= |
| |
| #endif |