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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_resource_XResourceBundleLoader_idl__
  20 #define __com_sun_star_resource_XResourceBundleLoader_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/resource/XResourceBundle.idl>
  25
  26 #include <com/sun/star/resource/MissingResourceException.idl>
  27
  28 #include <com/sun/star/lang/Locale.idl>
  29
  30
  31
  32 module com {  module sun {  module star {  module resource {
  33
  34
  35 /** makes it possible to load resource bundles.
  36
  37     <p>The search algorithm is specified in the documentation of
  38     XResourceBundle. The implementations must follow
  39     the name scheme, but it is allowed to search in several locations.
  40
  41     @see MissingResourceException
  42     @see XResourceBundle
  43     @see Locale
  44  */
  45 published interface XResourceBundleLoader: com::sun::star::uno::XInterface
  46 {
  47
  48     /** loads the appropriate resource bundle.
  49      */
  50     com::sun::star::resource::XResourceBundle loadBundle_Default( [in] string aBaseName )
  51             raises( com::sun::star::resource::MissingResourceException );
  52
  53
  54     /** loads the appropriate resource bundle subclass.
  55      */
  56     com::sun::star::resource::XResourceBundle loadBundle( [in] string abaseName,
  57              [in] com::sun::star::lang::Locale aLocale )
  58             raises( com::sun::star::resource::MissingResourceException );
  59
  60 };
  61
  62
  63 }; }; }; };
  64
  65 #endif
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */