ICU-529 Described replacement functions for the deprecated functions.

X-SVN-Rev: 2493
This commit is contained in:
George Rhoten 2000-09-22 22:56:03 +00:00
parent 229efe01a9
commit d416e2ffa9
2 changed files with 43 additions and 41 deletions

View File

@ -13,10 +13,12 @@
* 03/18/97 clhuang Updated per C++ implementation.
* 03/27/97 helena Updated to pass the simple test after code review.
* 08/26/97 aliu Added currency/intl currency symbol support.
* 07/22/98 stephen Changed to match C++ style
* 07/22/98 stephen Changed to match C++ style
* currencySymbol -> fCurrencySymbol
* Constants changed from CAPS to kCaps
* 06/24/99 helena Integrated Alan's NF enhancements and Java2 bug fixes
* 09/22/00 grhoten Marked deprecation tags with a pointer to replacement
* functions.
********************************************************************************
*/
@ -62,8 +64,8 @@
* 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.
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
class U_I18N_API DecimalFormatSymbols {
public:
/**
@ -179,14 +181,14 @@ public:
* character used for zero. Different for Arabic, etc.
* This function returns only the first code unit of the symbol string,
* unlike getSymbol().
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
UChar getZeroDigit(void) const;
/**
* character used for zero. Different for Arabic, etc.
* This function can set only a one-code unit symbol,
* unlike setSymbol().
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
void setZeroDigit(UChar zeroDigit);
@ -194,14 +196,14 @@ public:
* character used for thousands separator. Different for French, etc.
* This function returns only the first code unit of the symbol string,
* unlike getSymbol().
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
UChar getGroupingSeparator(void) const;
/**
* character used for thousands separator. Different for French, etc.
* This function can set only a one-code unit symbol,
* unlike setSymbol().
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
void setGroupingSeparator(UChar groupingSeparator);
@ -209,14 +211,14 @@ public:
* character used for decimal sign. Different for French, etc.
* This function returns only the first code unit of the symbol string,
* unlike getSymbol().
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
UChar getDecimalSeparator(void) const;
/**
* character used for decimal sign. Different for French, etc.
* This function can set only a one-code unit symbol,
* unlike setSymbol().
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
void setDecimalSeparator(UChar decimalSeparator);
@ -224,14 +226,14 @@ public:
* character used for per mill sign. Different for Arabic, etc.
* This function returns only the first code unit of the symbol string,
* unlike getSymbol().
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
UChar getPerMill(void) const;
/**
* character used for per mill sign. Different for Arabic, etc.
* This function can set only a one-code unit symbol,
* unlike setSymbol().
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
void setPerMill(UChar permill);
@ -239,14 +241,14 @@ public:
* character used for percent sign. Different for Arabic, etc.
* This function returns only the first code unit of the symbol string,
* unlike getSymbol().
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
UChar getPercent(void) const;
/**
* character used for percent sign. Different for Arabic, etc.
* This function can set only a one-code unit symbol,
* unlike setSymbol().
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
void setPercent(UChar percent);
@ -254,14 +256,14 @@ public:
* character used for a digit in a pattern.
* This function returns only the first code unit of the symbol string,
* unlike getSymbol().
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
UChar getDigit(void) const;
/**
* character used for a digit in a pattern.
* This function can set only a one-code unit symbol,
* unlike setSymbol().
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
void setDigit(UChar digit);
@ -270,7 +272,7 @@ public:
* in a pattern.
* This function returns only the first code unit of the symbol string,
* unlike getSymbol().
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
UChar getPatternSeparator(void) const;
/**
@ -278,47 +280,47 @@ public:
* in a pattern.
* This function can set only a one-code unit symbol,
* unlike setSymbol().
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
void setPatternSeparator(UChar patternSeparator);
/**
* character used to represent infinity. Almost always left
* unchanged.
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
UnicodeString& getInfinity(UnicodeString& result) const;
/**
* character used to represent infinity. Almost always left
* unchanged.
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
void setInfinity(const UnicodeString& infinity);
/**
* Checks to see if text at offset represents the inifinity string.
* @return the number of characters used to represent infinity when
* text starts with the inifinity string, otherwise it returns 0.
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
int32_t compareInfinity(const UnicodeString& text, UTextOffset offset) const;
/**
* character used to represent NaN (Not A Number). Almost always left
* unchanged.
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
UnicodeString& getNaN(UnicodeString& result) const;
/**
* character used to represent NaN. Almost always left
* unchanged.
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
void setNaN(const UnicodeString& NaN);
/**
* Checks to see if text at offset represents the NaN string.
* @return the number of characters used to represent NaN when
* text starts with the NaN string, otherwise it returns 0.
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
int32_t compareNaN(const UnicodeString& text, UTextOffset offset) const;
@ -326,14 +328,14 @@ public:
* character used to represent plus sign
* This function returns only the first code unit of the symbol string,
* unlike getSymbol().
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
UChar getPlusSign(void) const;
/**
* character used to represent plus sign
* This function can set only a one-code unit symbol,
* unlike setSymbol().
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
void setPlusSign(UChar minusSign);
@ -343,7 +345,7 @@ public:
* minusSign to the positive format.
* This function returns only the first code unit of the symbol string,
* unlike getSymbol().
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
UChar getMinusSign(void) const;
/**
@ -352,7 +354,7 @@ public:
* minusSign to the positive format.
* This function can set only a one-code unit symbol,
* unlike setSymbol().
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
void setMinusSign(UChar minusSign);
@ -361,7 +363,7 @@ public:
* unchanged.
* This function returns only the first code unit of the symbol string,
* unlike getSymbol().
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
UChar getExponentialSymbol(void) const;
/**
@ -369,18 +371,18 @@ public:
* unchanged.
* This function can set only a one-code unit symbol,
* unlike setSymbol().
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
void setExponentialSymbol(UChar exponential);
/**
* The string denoting the local currency.
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
UnicodeString& getCurrencySymbol(UnicodeString& result) const;
/**
* The string denoting the local currency.
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
void setCurrencySymbol(const UnicodeString& currency);
/**
@ -388,18 +390,18 @@ public:
* @return the number of characters used to represent Currency Symbol when
* text starts with the Currency Symbol string, otherwise it returns
* 0.
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
int32_t compareCurrencySymbol(const UnicodeString& text, UTextOffset offset) const;
/**
* The international string denoting the local currency.
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
UnicodeString& getInternationalCurrencySymbol(UnicodeString& result) const;
/**
* The international string denoting the local currency.
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
void setInternationalCurrencySymbol(const UnicodeString& currency);
/**
@ -408,7 +410,7 @@ public:
* @return the number of characters used to represent International
* Currency Symbol when text starts with the International Currency
* Symbol string, otherwise it returns 0.
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
int32_t compareInternationalCurrencySymbol(const UnicodeString& text, UTextOffset offset) const;
@ -416,14 +418,14 @@ public:
* The monetary decimal separator.
* This function returns only the first code unit of the symbol string,
* unlike getSymbol().
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
UChar getMonetaryDecimalSeparator(void) const;
/**
* The monetary decimal separator.
* This function can set only a one-code unit symbol,
* unlike setSymbol().
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
void setMonetaryDecimalSeparator(UChar sep);
@ -439,7 +441,7 @@ public:
* @see DecimalFormat#getFormatWidth
* @see DecimalFormat#getPadPosition
* @see DecimalFormat#getPadCharacter
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
UChar getPadEscape(void) const;
@ -454,7 +456,7 @@ public:
* @see DecimalFormat#setFormatWidth
* @see DecimalFormat#setPadPosition
* @see DecimalFormat#setPadCharacter
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
void setPadEscape(UChar c);

View File

@ -529,7 +529,7 @@ unum_toPattern( const UNumberFormat* fmt,
#define UNFSYMBOLSMAXSIZE 10
/** The UNumberFormatSymbols struct
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
struct UNumberFormatSymbols{
/** The decimal separator */
@ -574,7 +574,7 @@ typedef struct UNumberFormatSymbols UNumberFormatSymbols;
* @param fmt The formatter to query.
* @param syms A pointer to a UNumberFormatSymbols to receive the symbols associated with fmt.
* @see unum_setSymbols
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
U_CAPI void
unum_getSymbols( const UNumberFormat *fmt,
@ -588,7 +588,7 @@ unum_getSymbols( const UNumberFormat *fmt,
* @param symbolsToSet The UNumberFormatSymbols to associate with fmt.
* @param status A pointer to an UErrorCode to receive any errors.
* @see unum_getSymbols
* @deprecated remove after 2000-dec-31
* @deprecated remove after 2000-dec-31. See UNumberFormatSymbol and unum_getSymbol() for a replacement.
*/
U_CAPI void
unum_setSymbols( UNumberFormat* fmt,