Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Header Files   Compound Members   File Members  

DecimalFormatSymbols Class Reference

This class represents the set of symbols needed by DecimalFormat to format numbers. More...

#include <dcfmtsym.h>

List of all members.


Public Members

 DecimalFormatSymbols (const Locale& locale, UErrorCode& status)
Create a DecimalFormatSymbols object for the given locale. More...

 DecimalFormatSymbols ( UErrorCode& status)
Create a DecimalFormatSymbols object for the default locale. More...

 DecimalFormatSymbols (const DecimalFormatSymbols&)
Copy constructor. More...

DecimalFormatSymbols& operator= (const DecimalFormatSymbols&)
Assignment operator. More...

 ~DecimalFormatSymbols ()
Destructor. More...

bool_t operator== (const DecimalFormatSymbols& other) const
Return true if another object is semantically equal to this one. More...

bool_t operator!= (const DecimalFormatSymbols& other) const
Return true if another object is semantically unequal to this one. More...

UChar getZeroDigit (void) const
character used for zero. More...

void setZeroDigit (UChar zeroDigit)
character used for zero. More...

UChar getGroupingSeparator (void) const
character used for thousands separator. More...

void setGroupingSeparator (UChar groupingSeparator)
character used for thousands separator. More...

UChar getDecimalSeparator (void) const
character used for decimal sign. More...

void setDecimalSeparator (UChar decimalSeparator)
character used for decimal sign. More...

UChar getPerMill (void) const
character used for per mill sign. More...

void setPerMill (UChar perMill)
character used for per mill sign. More...

UChar getPercent (void) const
character used for percent sign. More...

void setPercent (UChar percent)
character used for percent sign. More...

UChar getDigit (void) const
character used for a digit in a pattern. More...

void setDigit (UChar digit)
character used for a digit in a pattern. More...

UChar getPatternSeparator (void) const
character used to separate positive and negative subpatterns in a pattern. More...

void setPatternSeparator (UChar patternSeparator)
character used to separate positive and negative subpatterns in a pattern. More...

UnicodeStringgetInfinity (UnicodeString& result) const
character used to represent infinity. More...

void setInfinity (const UnicodeString& infinity)
character used to represent infinity. More...

UnicodeStringgetNaN (UnicodeString& result) const
character used to represent NaN. More...

void setNaN (const UnicodeString& NaN)
character used to represent NaN. More...

UChar getPlusSign (void) const
character used to represent plus sign. More...

void setPlusSign (UChar minusSign)
character used to represent plus sign. More...

UChar getMinusSign (void) const
character used to represent minus sign. More...

void setMinusSign (UChar minusSign)
character used to represent minus sign. More...

UChar getExponentialSymbol (void) const
character used to represent exponential. More...

void setExponentialSymbol (UChar exponential)
character used to represent exponential. More...

UnicodeStringgetCurrencySymbol (UnicodeString& result) const
The string denoting the local currency. More...

void setCurrencySymbol (const UnicodeString& currency)
The string denoting the local currency. More...

UnicodeStringgetInternationalCurrencySymbol (UnicodeString& result) const
The international string denoting the local currency. More...

void setInternationalCurrencySymbol (const UnicodeString& currency)
The international string denoting the local currency. More...

UChar getMonetaryDecimalSeparator (void) const
The monetary decimal separator. More...

void setMonetaryDecimalSeparator (UChar sep)
The monetary decimal separator. More...

UChar getPadEscape (void) const
Return the character used to pad numbers out to a specified width. More...

void setPadEscape (UChar c)
Set the character used to pad numbers out to a specified width. More...


Detailed Description

This class represents the set of symbols needed by DecimalFormat to format numbers.

DecimalFormat creates for itself an instance of DecimalFormatSymbols from its locale data. If you need to change any of these symbols, you can get the DecimalFormatSymbols object from your DecimalFormat and modify it.

Here are the special characters used in the parts of the subpattern, with notes on their usage.

 .       Symbol   Meaning
 .         0      a digit
 .         #      a digit, zero shows as absent
 .         .      placeholder for decimal separator
 .         ,      placeholder for grouping separator.
 .         ;      separates formats.
 .         -      default negative prefix.
 .         %      divide by 100 and show as percentage
 .         X      any other characters can be used in the prefix or suffix
 .         '      used to quote special characters in a prefix or suffix.
  
[Notes]

If there is no explicit negative subpattern, - is prefixed to the positive form. That is, "0.00" alone is equivalent to "0.00;-0.00".

The grouping separator is commonly used for thousands, but in some countries for ten-thousands. The interval is a constant number of digits between the grouping characters, such as 100,000,000 or 1,0000,0000. If you supply a pattern with multiple grouping characters, the interval between the last one and the end of the integer is the one that is used. So "#,##,###,####" == "######,####" == "##,####,####".

This class only handles localized digits where the 10 digits are contiguous in Unicode, from 0 to 9. Other digits sets (such as superscripts) would need a different subclass.


Member Function Documentation

DecimalFormatSymbols::DecimalFormatSymbols (const Locale & locale, UErrorCode & status)

Create a DecimalFormatSymbols object for the given locale.

Parameters:
locale   The locale to get symbols for.
status   Input/output parameter, set to success or failure code upon return.
Stable:

DecimalFormatSymbols::DecimalFormatSymbols (UErrorCode & status)

Create a DecimalFormatSymbols object for the default locale.

This constructor will not fail. If the resource file data is not available, it will use hard-coded last-resort data and set status to U_USING_FALLBACK_ERROR.

Parameters:
status   Input/output parameter, set to success or failure code upon return.
Stable:

DecimalFormatSymbols::DecimalFormatSymbols (const DecimalFormatSymbols &)

Copy constructor.

Stable:

DecimalFormatSymbols & DecimalFormatSymbols::operator= (const DecimalFormatSymbols &)

Assignment operator.

Stable:

DecimalFormatSymbols::~DecimalFormatSymbols ()

Destructor.

Stable:

bool_t DecimalFormatSymbols::operator== (const DecimalFormatSymbols & other) const

Return true if another object is semantically equal to this one.

Stable:

bool_t DecimalFormatSymbols::operator!= (const DecimalFormatSymbols & other) const [inline]

Return true if another object is semantically unequal to this one.

Stable:

UChar DecimalFormatSymbols::getZeroDigit (void) const [inline]

character used for zero.

Different for Arabic, etc.

Draft:

void DecimalFormatSymbols::setZeroDigit (UChar zeroDigit) [inline]

character used for zero.

Different for Arabic, etc.

Draft:

UChar DecimalFormatSymbols::getGroupingSeparator (void) const [inline]

character used for thousands separator.

Different for French, etc.

Draft:

void DecimalFormatSymbols::setGroupingSeparator (UChar groupingSeparator) [inline]

character used for thousands separator.

Different for French, etc.

Draft:

UChar DecimalFormatSymbols::getDecimalSeparator (void) const [inline]

character used for decimal sign.

Different for French, etc.

Draft:

void DecimalFormatSymbols::setDecimalSeparator (UChar decimalSeparator) [inline]

character used for decimal sign.

Different for French, etc.

Draft:

UChar DecimalFormatSymbols::getPerMill (void) const [inline]

character used for per mill sign.

Different for Arabic, etc.

Draft:

void DecimalFormatSymbols::setPerMill (UChar perMill) [inline]

character used for per mill sign.

Different for Arabic, etc.

Draft:

UChar DecimalFormatSymbols::getPercent (void) const [inline]

character used for percent sign.

Different for Arabic, etc.

Draft:

void DecimalFormatSymbols::setPercent (UChar percent) [inline]

character used for percent sign.

Different for Arabic, etc.

Draft:

UChar DecimalFormatSymbols::getDigit (void) const [inline]

character used for a digit in a pattern.

Draft:

void DecimalFormatSymbols::setDigit (UChar digit) [inline]

character used for a digit in a pattern.

Draft:

UChar DecimalFormatSymbols::getPatternSeparator (void) const [inline]

character used to separate positive and negative subpatterns in a pattern.

Draft:

void DecimalFormatSymbols::setPatternSeparator (UChar patternSeparator) [inline]

character used to separate positive and negative subpatterns in a pattern.

Draft:

UnicodeString & DecimalFormatSymbols::getInfinity (UnicodeString & result) const [inline]

character used to represent infinity.

Almost always left unchanged.

Stable:

void DecimalFormatSymbols::setInfinity (const UnicodeString & infinity) [inline]

character used to represent infinity.

Almost always left unchanged.

Stable:

UnicodeString & DecimalFormatSymbols::getNaN (UnicodeString & result) const [inline]

character used to represent NaN.

Almost always left unchanged.

Stable:

void DecimalFormatSymbols::setNaN (const UnicodeString & NaN) [inline]

character used to represent NaN.

Almost always left unchanged.

Stable:

UChar DecimalFormatSymbols::getPlusSign (void) const [inline]

character used to represent plus sign.

Draft:

void DecimalFormatSymbols::setPlusSign (UChar plusSign) [inline]

character used to represent plus sign.

Draft:

UChar DecimalFormatSymbols::getMinusSign (void) const [inline]

character used to represent minus sign.

If no explicit negative format is specified, one is formed by prefixing minusSign to the positive format.

Draft:

void DecimalFormatSymbols::setMinusSign (UChar minusSign) [inline]

character used to represent minus sign.

If no explicit negative format is specified, one is formed by prefixing minusSign to the positive format.

Draft:

UChar DecimalFormatSymbols::getExponentialSymbol (void) const [inline]

character used to represent exponential.

Almost always left unchanged.

Draft:

void DecimalFormatSymbols::setExponentialSymbol (UChar exponential) [inline]

character used to represent exponential.

Almost always left unchanged.

Draft:

UnicodeString & DecimalFormatSymbols::getCurrencySymbol (UnicodeString & result) const [inline]

The string denoting the local currency.

Stable:

void DecimalFormatSymbols::setCurrencySymbol (const UnicodeString & str) [inline]

The string denoting the local currency.

Stable:

UnicodeString & DecimalFormatSymbols::getInternationalCurrencySymbol (UnicodeString & result) const [inline]

The international string denoting the local currency.

Stable:

void DecimalFormatSymbols::setInternationalCurrencySymbol (const UnicodeString & str) [inline]

The international string denoting the local currency.

Stable:

UChar DecimalFormatSymbols::getMonetaryDecimalSeparator (void) const [inline]

The monetary decimal separator.

Draft:

void DecimalFormatSymbols::setMonetaryDecimalSeparator (UChar sep) [inline]

The monetary decimal separator.

Draft:

UChar DecimalFormatSymbols::getPadEscape (void) const [inline]

Return the character used to pad numbers out to a specified width.

This is not the pad character itself; rather, it is the special pattern character preceding the pad character. In the pattern "*_#,##0", '*' is the pad escape, and '_' is the pad character.

Returns:
the character
See also:
setPadEscape() , DecimalFormat::getFormatWidth() , DecimalFormat::getPadPosition() , DecimalFormat::getPadCharacter()
Draft:

void DecimalFormatSymbols::setPadEscape (UChar c) [inline]

Set the character used to pad numbers out to a specified width.

This is not the pad character itself; rather, it is the special pattern character preceding the pad character. In the pattern "*_#,##0", '*' is the pad escape, and '_' is the pad character.

See also:
getPadEscape() , DecimalFormat::setFormatWidth() , DecimalFormat::setPadPosition() , DecimalFormat::setPadCharacter()
Draft:

The documentation for this class was generated from the following file:
Generated at Thu Feb 10 15:30:38 2000 for icu by doxygen 1.0.0 written by Dimitri van Heesch, © 1997-1999