offapi/com/sun/star/util/NumberFormatsSupplier.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_util_NumberFormatsSupplier_idl__
  29 #define __com_sun_star_util_NumberFormatsSupplier_idl__
  30
  31 #ifndef __com_sun_star_util_XNumberFormatsSupplier_idl__
  32 #include <com/sun/star/util/XNumberFormatsSupplier.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_lang_XInitialization_idl__
  36 #include <com/sun/star/lang/XInitialization.idl>
  37 #endif
  38
  39 //=============================================================================
  40
  41  module com {  module sun {  module star {  module util {
  42
  43 //=============================================================================
  44
  45 /** provides an supplier of number formats
  46
  47     @see NumberFormats
  48     @see NumberFormatter
  49
  50     @since OOo 1.1.2
  51 */
  52 published service NumberFormatsSupplier
  53 {
  54     /** used to initialize the component when instantiating.
  55
  56         <p>In the <member scope="com::sun::star::lang">XInitialization::initialize</member> method, you can
  57         pass a <type scope="com::sun::star::lang">Locale</type> to specify the default locale of the
  58         number formats supplier.</p>
  59
  60         <p>The component should be initialized only once, after it has been instantiated, and before it
  61         has been used.<br/>
  62         If you initialize it a second time (or after you used it), it is up to implementation
  63         how this is handled.</p>
  64     */
  65     interface com::sun::star::lang::XInitialization;
  66
  67     /** allows access to the number formats supplied by the component.
  68     */
  69     interface XNumberFormatsSupplier;
  70 };
  71
  72 //=============================================================================
  73
  74 }; }; }; };
  75
  76 #endif
  77