offapi/com/sun/star/util/NumberFormatProperties.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 #ifndef __com_sun_star_util_NumberFormatProperties_idl__
  28 #define __com_sun_star_util_NumberFormatProperties_idl__
  29
  30 #ifndef __com_sun_star_lang_Locale_idl__
  31 #include <com/sun/star/lang/Locale.idl>
  32 #endif
  33
  34
  35 //=============================================================================
  36
  37  module com {  module sun {  module star {  module util {
  38
  39 //=============================================================================
  40
  41 /** contains properties specifying the behavior of a <type>NumberFormatter</type>.
  42
  43     @see NumberFormatter
  44  */
  45 published service NumberFormatProperties
  46 {
  47     //-------------------------------------------------------------------------
  48
  49     /** contains the format string of the number format.
  50      */
  51     [readonly, property] string FormatString;
  52
  53     //-------------------------------------------------------------------------
  54
  55     /** contains the locale of the number format.
  56      */
  57     [readonly, property] com::sun::star::lang::Locale Locale;
  58
  59     //-------------------------------------------------------------------------
  60
  61     /** contains the type of the number format.
  62
  63         @see NumberFormat
  64      */
  65     [readonly, property] short Type;
  66
  67     //-------------------------------------------------------------------------
  68
  69     /** contains a comment regarding the number format for
  70         display to the user.
  71      */
  72     [property] string Comment;
  73
  74 };
  75
  76 //=============================================================================
  77
  78 }; }; }; };
  79
  80 #endif
  81