summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/resource/XResourceBundleLoader.idl
blob: c8ef8d6b63636c9ea5b4741d80f2e9b51252229f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XResourceBundleLoader.idl,v $
 * $Revision: 1.9 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_resource_XResourceBundleLoader_idl__
#define __com_sun_star_resource_XResourceBundleLoader_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_resource_XResourceBundle_idl__
#include <com/sun/star/resource/XResourceBundle.idl>
#endif

#ifndef __com_sun_star_resource_MissingResourceException_idl__
#include <com/sun/star/resource/MissingResourceException.idl>
#endif

#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif


//=============================================================================

module com {  module sun {  module star {  module resource {

//=============================================================================

/** makes it possible to load resource bundles.

    <p>The search algorithm is specified in the documentation of
    <type>XResourceBundle</type>. The implementations must follow
    the name scheme, but it is allowed to search in several locations.

    @see MissingResourceException
    @see XResourceBundle
    @see Locale
 */
published interface XResourceBundleLoader: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** loads the appropriate resource bundle.
     */
    com::sun::star::resource::XResourceBundle loadBundle_Default( [in] string aBaseName )
            raises( com::sun::star::resource::MissingResourceException );

    //-------------------------------------------------------------------------

    /** loads the appropriate resource bundle subclass.
     */
    com::sun::star::resource::XResourceBundle loadBundle( [in] string abaseName,
             [in] com::sun::star::lang::Locale aLocale )
            raises( com::sun::star::resource::MissingResourceException );

};

//=============================================================================

}; }; }; };

#endif