1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir#ifndef __com_sun_star_resource_OfficeResourceLoader_idl__
25cdf0e10cSrcweir#define __com_sun_star_resource_OfficeResourceLoader_idl__
26cdf0e10cSrcweir
27cdf0e10cSrcweir#ifndef __com_sun_star_resource_XResourceBundleLoader_idl__
28cdf0e10cSrcweir#include <com/sun/star/resource/XResourceBundleLoader.idl>
29cdf0e10cSrcweir#endif
30cdf0e10cSrcweir
31cdf0e10cSrcweir//=============================================================================
32cdf0e10cSrcweirmodule com { module sun { module star { module resource {
33cdf0e10cSrcweir//=============================================================================
34cdf0e10cSrcweir
35cdf0e10cSrcweir/** describes a <type>XResourceBundleLoader</type> which provides access to the OpenOffice.org
36cdf0e10cSrcweir    resource files.
37cdf0e10cSrcweir
38cdf0e10cSrcweir    <p>An OpenOffice.org installation comes with a number of resource files in an proprietary
39cdf0e10cSrcweir    format, located insisde the installation's program/resource directory. The <type>OfficeResoureLoader</type>
40cdf0e10cSrcweir    singleton (available at a component context as value with the key
41cdf0e10cSrcweir    <code>/singletons/com.sun.star.resource.OfficeResourceLoader</code>), provides access to some
42cdf0e10cSrcweir    types of resources within those files.</p>
43cdf0e10cSrcweir
44cdf0e10cSrcweir    <p>Clients have to specifiy the resource file base name in the call to
45cdf0e10cSrcweir    <member>XResourceBundleLoader::loadBundle</member> resp. <member>XResourceBundleLoader::loadBundle_Default</member>
46cdf0e10cSrcweir    method. The loader will extent this base name so that the resulting name conforms to the OpenOffice.org
47cdf0e10cSrcweir    resource file naming conventions, and look up the respective resource file, for the requested locale,
48cdf0e10cSrcweir    in OpenOffice.org's installation.</p>
49cdf0e10cSrcweir
50cdf0e10cSrcweir    <p>The lookup process uses the fallback mechanism as described at the <type>XResourceBundle</type> interface,
51cdf0e10cSrcweir    except that <code>Locale.getDefault()</code> is not used.</p>
52cdf0e10cSrcweir
53cdf0e10cSrcweir    <p>Resource keys, as passed to the <member>XResourceBundle::getDirectElement</member> or
54cdf0e10cSrcweir    <member scope="com::sun::star::container">XNameAccess::getByName</member>, have the following format:
55cdf0e10cSrcweir    <code>&lt;resource_type&gt;:&lt;numeric_identifier&gt;</code>, where <code>&lt;resource_type&gt; specifies
56cdf0e10cSrcweir    the type of the requested resource (see below) and <code>&lt;numeric_identifier&gt;</code> is the numeric
57cdf0e10cSrcweir    identifier of the resource.</p>
58cdf0e10cSrcweir
59cdf0e10cSrcweir    <p>The following resource types are currently supported:
60cdf0e10cSrcweir    <ul>
61cdf0e10cSrcweir        <li><em>string</em>: denotes a string resource</li>
62cdf0e10cSrcweir    </ul>
63cdf0e10cSrcweir    </p>
64cdf0e10cSrcweir
65cdf0e10cSrcweir    <p>Since the numeric resource identifiers are highly build-dependent (e.g. can change with any next
66cdf0e10cSrcweir    OpenOffice.org build), you are <strong>strongly</strong> discouraged from using the <type>OfficeResoureLoader</type>
67cdf0e10cSrcweir    service in a component which targets more than one particular OpenOffice.org build.</p>
68cdf0e10cSrcweir
69cdf0e10cSrcweir    @since OOo 2.0.3
70cdf0e10cSrcweir*/
71cdf0e10cSrcweirsingleton OfficeResourceLoader : XResourceBundleLoader;
72cdf0e10cSrcweir
73cdf0e10cSrcweir//=============================================================================
74cdf0e10cSrcweir}; }; }; };
75cdf0e10cSrcweir//=============================================================================
76cdf0e10cSrcweir
77cdf0e10cSrcweir#endif
78