xref: /aoo41x/main/offapi/com/sun/star/resource/XResourceBundleLoader.idl (revision d1766043)

/**************************************************************
 *
 * 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_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