xref: /aoo42x/main/offapi/com/sun/star/resource/XResourceBundleLoader.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * 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