offapi/com/sun/star/util/NumberFormatsSupplier.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: NumberFormatsSupplier.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
  31 #ifndef __com_sun_star_util_NumberFormatsSupplier_idl__
  32 #define __com_sun_star_util_NumberFormatsSupplier_idl__
  33
  34 #ifndef __com_sun_star_util_XNumberFormatsSupplier_idl__
  35 #include <com/sun/star/util/XNumberFormatsSupplier.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_lang_XInitialization_idl__
  39 #include <com/sun/star/lang/XInitialization.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module util {
  45
  46 //=============================================================================
  47
  48 /** provides an supplier of number formats
  49
  50     @see NumberFormats
  51     @see NumberFormatter
  52
  53     @since OOo 1.1.2
  54 */
  55 published service NumberFormatsSupplier
  56 {
  57     /** used to initialize the component when instantiating.
  58
  59         <p>In the <member scope="com::sun::star::lang">XInitialization::initialize</member> method, you can
  60         pass a <type scope="com::sun::star::lang">Locale</type> to specify the default locale of the
  61         number formats supplier.</p>
  62
  63         <p>The component should be initialized only once, after it has been instantiated, and before it
  64         has been used.<br/>
  65         If you initialize it a second time (or after you used it), it is up to implementation
  66         how this is handled.</p>
  67     */
  68     interface com::sun::star::lang::XInitialization;
  69
  70     /** allows access to the number formats supplied by the component.
  71     */
  72     interface XNumberFormatsSupplier;
  73 };
  74
  75 //=============================================================================
  76
  77 }; }; }; };
  78
  79 #endif
  80