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