offapi/com/sun/star/util/XNumberFormatPreviewer.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: XNumberFormatPreviewer.idl,v $
  10  * $Revision: 1.10 $
  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_XNumberFormatPreviewer_idl__
  31 #define __com_sun_star_util_XNumberFormatPreviewer_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_util_Color_idl__
  38 #include <com/sun/star/util/Color.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_lang_Locale_idl__
  42 #include <com/sun/star/lang/Locale.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_util_MalformedNumberFormatException_idl__
  46 #include <com/sun/star/util/MalformedNumberFormatException.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_util_Color_idl__
  50 #include <com/sun/star/util/Color.idl>
  51 #endif
  52
  53
  54 //=============================================================================
  55
  56  module com {  module sun {  module star {  module util {
  57
  58 //=============================================================================
  59
  60 /** represents a number formatter which can preview number
  61     formats without inserting them.
  62
  63     @see NumberFormatter
  64  */
  65 published interface XNumberFormatPreviewer: com::sun::star::uno::XInterface
  66 {
  67     //-------------------------------------------------------------------------
  68
  69     /** formats a value using a format string, without inserting a
  70         number format into the list.
  71
  72         @param aFormat
  73             is the format string that is used for formatting.
  74
  75         @param fValue
  76             is the value that is formatted.
  77
  78         @param nLocale
  79             is the locale that is used to interpret the format string.
  80
  81         @param bAllowEnglish
  82             specifies if English language number format strings are accepted
  83             in addition to those from the selected locale.
  84
  85         @returns
  86             the formatted string.
  87
  88         @throws com::sun::star::util::MalformedNumberFormatException
  89             if the format string is invalid.
  90
  91      */
  92     string convertNumberToPreviewString( [in] string aFormat,
  93              [in] double fValue,
  94              [in] com::sun::star::lang::Locale nLocale,
  95              [in] boolean bAllowEnglish )
  96             raises( com::sun::star::util::MalformedNumberFormatException );
  97
  98     //-------------------------------------------------------------------------
  99
 100     /** returns the color which is to be used for a number.
 101
 102         @param aFormat
 103             is the format string that is used for formatting.
 104
 105         @param fValue
 106             is the value that is formatted.
 107
 108         @param nLocale
 109             is the locale that is used to interpret the format string.
 110
 111         @param bAllowEnglish
 112             specifies if English language number format strings are accepted
 113             in addition to those from the selected locale.
 114
 115         @param aDefaultColor
 116             is the color that should be returned if no color is set by
 117             the number format.
 118
 119         @returns
 120             the color that should used to output the formatted string.
 121
 122         @throws com::sun::star::util::MalformedNumberFormatException
 123             if the format string is invalid.
 124
 125      */
 126     com::sun::star::util::Color queryPreviewColorForNumber( [in] string aFormat,
 127              [in] double fValue,
 128              [in] com::sun::star::lang::Locale nLocale,
 129              [in] boolean bAllowEnglish,
 130              [in] com::sun::star::util::Color aDefaultColor )
 131             raises( com::sun::star::util::MalformedNumberFormatException );
 132
 133 };
 134
 135 //=============================================================================
 136
 137 }; }; }; };
 138
 139 #endif
 140