offapi/com/sun/star/resource/XResourceBundleLoader.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XResourceBundleLoader.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_resource_XResourceBundleLoader_idl__
  31 #define __com_sun_star_resource_XResourceBundleLoader_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_resource_XResourceBundle_idl__
  38 #include <com/sun/star/resource/XResourceBundle.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_resource_MissingResourceException_idl__
  42 #include <com/sun/star/resource/MissingResourceException.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_lang_Locale_idl__
  46 #include <com/sun/star/lang/Locale.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52 module com {  module sun {  module star {  module resource {
  53
  54 //=============================================================================
  55
  56 /** makes it possible to load resource bundles.
  57
  58     <p>The search algorithm is specified in the documentation of
  59     <type>XResourceBundle</type>. The implementations must follow
  60     the name scheme, but it is allowed to search in several locations.
  61
  62     @see MissingResourceException
  63     @see XResourceBundle
  64     @see Locale
  65  */
  66 published interface XResourceBundleLoader: com::sun::star::uno::XInterface
  67 {
  68     //-------------------------------------------------------------------------
  69
  70     /** loads the appropriate resource bundle.
  71      */
  72     com::sun::star::resource::XResourceBundle loadBundle_Default( [in] string aBaseName )
  73             raises( com::sun::star::resource::MissingResourceException );
  74
  75     //-------------------------------------------------------------------------
  76
  77     /** loads the appropriate resource bundle subclass.
  78      */
  79     com::sun::star::resource::XResourceBundle loadBundle( [in] string abaseName,
  80              [in] com::sun::star::lang::Locale aLocale )
  81             raises( com::sun::star::resource::MissingResourceException );
  82
  83 };
  84
  85 //=============================================================================
  86
  87 }; }; }; };
  88
  89 #endif