/*
********************************************************************************
-* Copyright (C) 1997-2004, International Business Machines
+* Copyright (C) 1997-2006, International Business Machines
* Corporation and others. All Rights Reserved.
********************************************************************************
*
#define DECIMFMT_H
#include "unicode/utypes.h"
-
+/**
+ * \file
+ * \brief C++ API: Formats decimal numbers.
+ */
+
#if !UCONFIG_NO_FORMATTING
#include "unicode/dcfmtsym.h"
* @param pos On input: an alignment field, if desired.
* On output: the offsets of the alignment field.
* @return Reference to 'appendTo' parameter.
- * @draft ICU 2.8
+ * @stable ICU 2.8
*/
virtual UnicodeString& format(int64_t number,
UnicodeString& appendTo,
* @param appendTo Output parameter to receive result.
* Result is appended to existing contents.
* @return Reference to 'appendTo' parameter.
- * @draft ICU 2.8
+ * @stable ICU 2.8
*/
UnicodeString& format(int64_t number,
UnicodeString& appendTo) const;
* The width is counted in 16-bit code units.
* @return the format width, or zero if no padding is in effect
* @see #setFormatWidth
- * @see #getPadCharacter
+ * @see #getPadCharacterString
* @see #setPadCharacter
* @see #getPadPosition
* @see #setPadPosition
* format(), or zero to disable padding. A negative
* width is equivalent to 0.
* @see #getFormatWidth
- * @see #getPadCharacter
+ * @see #getPadCharacterString
* @see #setPadCharacter
* @see #getPadPosition
* @see #setPadPosition
* padChar.char32At(0) will be used as the pad character.
* @see #setFormatWidth
* @see #getFormatWidth
- * @see #getPadCharacter
+ * @see #getPadCharacterString
* @see #getPadPosition
* @see #setPadPosition
* @stable ICU 2.0
* @see #setFormatWidth
* @see #getFormatWidth
* @see #setPadCharacter
- * @see #getPadCharacter
+ * @see #getPadCharacterString
* @see #setPadPosition
* @see #kPadBeforePrefix
* @see #kPadAfterPrefix
* @see #setFormatWidth
* @see #getFormatWidth
* @see #setPadCharacter
- * @see #getPadCharacter
+ * @see #getPadCharacterString
* @see #getPadPosition
* @see #kPadBeforePrefix
* @see #kPadAfterPrefix
* displayed. This value has no effect unless areSignificantDigitsUsed()
* returns true.
* @return the fewest significant digits that will be shown
- * @draft ICU 3.0
+ * @stable ICU 3.0
*/
int32_t getMinimumSignificantDigits() const;
* displayed. This value has no effect unless areSignificantDigitsUsed()
* returns true.
* @return the most significant digits that will be shown
- * @draft ICU 3.0
+ * @stable ICU 3.0
*/
int32_t getMaximumSignificantDigits() const;
* <code>min</code>, then it is set to <code>min</code>. This
* value has no effect unless areSignificantDigits() returns true.
* @param min the fewest significant digits to be shown
- * @draft ICU 3.0
+ * @stable ICU 3.0
*/
void setMinimumSignificantDigits(int32_t min);
* This value has no effect unless areSignificantDigits() returns
* true.
* @param max the most significant digits to be shown
- * @draft ICU 3.0
+ * @stable ICU 3.0
*/
void setMaximumSignificantDigits(int32_t max);
* Returns true if significant digits are in use, or false if
* integer and fraction digit counts are in use.
* @return true if significant digits are in use
- * @draft ICU 3.0
+ * @stable ICU 3.0
*/
UBool areSignificantDigitsUsed() const;
* fraction digit counts are in use.
* @param useSignificantDigits true to use significant digits, or
* false to use integer and fraction digit counts
- * @draft ICU 3.0
+ * @stable ICU 3.0
*/
void setSignificantDigitsUsed(UBool useSignificantDigits);
* to use. It need not be null-terminated. May be the empty
* string or NULL to indicate no currency.
* @param ec input-output error code
- * @draft ICU 3.0
+ * @stable ICU 3.0
*/
virtual void setCurrency(const UChar* theCurrency, UErrorCode& ec);
/**
* The resource tags we use to retrieve decimal format data from
* locale resource bundles.
- * @stable ICU 2.0
+ * @deprecated ICU 3.4. This string has no public purpose. Please don't use it.
*/
static const char fgNumberPatterns[];
void setCurrencyForSymbols();
- void setCurrencyForLocale(const char* locale, UErrorCode& ec);
-
/**
* Constants.
*/
* this number, it wouldn't make sense anyway, and this is just to make sure
* that someone turning on scientific mode with default settings doesn't
* end up with lots of zeroes.
- * @draft ICU 2.8
+ * @stable ICU 2.8
*/
static const int32_t kMaxScientificIntegerDigits;
};