offapi/com/sun/star/util/XNumberFormatter.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: XNumberFormatter.idl,v $
  10  * $Revision: 1.11 $
  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_XNumberFormatter_idl__
  31 #define __com_sun_star_util_XNumberFormatter_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_util_XNumberFormatsSupplier_idl__
  42 #include <com/sun/star/util/XNumberFormatsSupplier.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_util_NotNumericException_idl__
  46 #include <com/sun/star/util/NotNumericException.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.
  61  */
  62 published interface XNumberFormatter: com::sun::star::uno::XInterface
  63 {
  64     //-------------------------------------------------------------------------
  65
  66     /** attaches an <type>XNumberFormatsSupplier</type> to this
  67         <type>NumberFormatter</type>.
  68
  69         <p>This <type>NumberFormatter</type> will only use the <type>NumberFormats</type>
  70         specified in the attached <type>XNumberFormatsSupplier</type>. Without an attached
  71         <type>XNumberFormatsSupplier</type>, no formatting is possible.</p>
  72      */
  73     void attachNumberFormatsSupplier( [in] com::sun::star::util::XNumberFormatsSupplier xSupplier );
  74
  75     //-------------------------------------------------------------------------
  76
  77     /** @returns
  78                 the attached <type>XNumberFormatsSupplier</type>.
  79      */
  80     com::sun::star::util::XNumberFormatsSupplier getNumberFormatsSupplier();
  81
  82     //-------------------------------------------------------------------------
  83
  84     /** detects the number format in a string which contains a formatted number.
  85      */
  86     long detectNumberFormat( [in] long nKey,
  87              [in] string aString )
  88             raises( com::sun::star::util::NotNumericException );
  89
  90     //-------------------------------------------------------------------------
  91
  92     /** converts a string which contains a formatted number into a number.
  93
  94         <p>If this is a text format, the string will not be converted.</p>
  95      */
  96     double convertStringToNumber( [in] long nKey,
  97              [in] string aString )
  98             raises( com::sun::star::util::NotNumericException );
  99
 100     //-------------------------------------------------------------------------
 101
 102     /** converts a number into a string.
 103      */
 104     string convertNumberToString( [in] long nKey,
 105              [in] double fValue );
 106
 107     //-------------------------------------------------------------------------
 108
 109     /** @returns
 110                 the color which is specified for the given value in the number format,
 111                 which is otherwise the value of <var>aDefaultColor</var>.
 112      */
 113     com::sun::star::util::Color queryColorForNumber( [in] long nKey,
 114              [in] double fValue,
 115              [in] com::sun::star::util::Color aDefaultColor );
 116
 117     //-------------------------------------------------------------------------
 118
 119     /** converts a string into another string.
 120      */
 121     string formatString( [in] long nKey,
 122              [in] string aString );
 123
 124     //-------------------------------------------------------------------------
 125
 126     /** @returns
 127                 the color which is specified for the given string in the number format,
 128                 which is otherwise the value of <var>aDefaultColor</var>.
 129      */
 130     com::sun::star::util::Color queryColorForString( [in] long nKey,
 131              [in] string aString,
 132              [in] com::sun::star::util::Color aDefaultColor );
 133
 134     //-------------------------------------------------------------------------
 135
 136     /** converts a number into a string with the specified format.
 137
 138         <p>This string can always be converted back to a number using the same
 139         format.
 140         </p>
 141      */
 142     string getInputString( [in] long nKey,
 143              [in] double fValue );
 144
 145 };
 146
 147 //=============================================================================
 148
 149 }; }; }; };
 150
 151 #endif
 152