*
* @since 2.0
*
- * The %NumberFormatter class is used to format all number formats, including decimal and real numbers, currency, and percentage for any locale. It also provides methods to determine the locales that have number formats and their names. You can write codes completely independent of the locale conventions for decimal points, thousand separators as well as of the specific decimal digits used or whether the number format is a decimal. A normal decimal number can also be displayed as a currency or as a percentage.
+ * The %NumberFormatter class is used to format all number formats, including decimal and real numbers, currency, and percentage
+ * for any locale. It also provides methods to determine the locales that have number formats and their names. You can write
+ * codes completely independent of the locale conventions for decimal points, thousand separators, the specific
+ * decimal digits used, or the number format. A normal decimal number can also be displayed as a currency or as a percentage.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/locales/num_formatter.htm">Number Formatters</a>.
*
* Creates a number formatter for the specified locale.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompNumberFormatterCreateNumberFormatterNPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompNumberFormatterCreateNumberFormatterNPage "here".
* @endif
*
- * @return A pointer to a general number formatter for the specified @c locale, @n
+ * @return A pointer to the general number formatter for the specified @c locale, @n
* else @c null if an error occurs
* @param[in] locale An instance of Locale
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG The specified @c locale is invalid.
+ * @exception E_INVALID_ARG The specified @c locale is invalid.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static NumberFormatter* CreateNumberFormatterN(const Locale& locale);
/**
* @if OSPCOMPAT
- * @page CompNumberFormatterCreateNumberFormatterNPage Compatibility for CreateNumberFormatterN()
- * @section CompNumberFormatterCreateNumberFormatterNIssueSection Issues
- * Implementation of this method in OSP compatible applications has the following issue: @n
- * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid.
- *
- * @section CompNumberFormatterCreateNumberFormatterNSolutionSection Resolutions
- * This issue has been resolved in Tizen.
- * @par When working in Tizen:
- * -# The method returns E_INVALID_ARG if the @c locale is invalid.
+ * @page CompNumberFormatterCreateNumberFormatterNPage Compatibility for CreateNumberFormatterN()
+ * @section CompNumberFormatterCreateNumberFormatterNIssueSection Issues
+ * Implementation of this method in OSP compatible applications has the following issue: @n
+ * -# The method returns @c E_UNSUPPORTED_OPERATION if the @c locale is invalid.
+ *
+ * @section CompNumberFormatterCreateNumberFormatterNSolutionSection Resolutions
+ * This issue has been resolved in Tizen.
+ * @par When working in Tizen:
+ * -# The method returns @c E_INVALID_ARG if the @c locale is invalid.
* @endif
- */
+ */
/**
* Creates a currency formatter for the default locale.
*
* @since 2.0
*
- * @return A pointer to a currency formatter for the default locale, @n
+ * @return A pointer to the currency formatter for the default locale, @n
* else @c null if an error occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* Creates a currency formatter for the specified @c locale.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompNumberFormatterCreateCurrencyFormatterNPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompNumberFormatterCreateCurrencyFormatterNPage "here".
* @endif
*
- * @return A pointer to a currency formatter for the specified @c locale, @n
+ * @return A pointer to the currency formatter for the specified @c locale, @n
* else @c null if an error occurs
- * @param[in] locale An instance of Locale
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG The specified @c locale is invalid.
+ * @param[in] locale An instance of Locale
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_ARG The specified @c locale is invalid.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static NumberFormatter* CreateCurrencyFormatterN(const Locale& locale);
/**
* @if OSPCOMPAT
- * @page CompNumberFormatterCreateCurrencyFormatterNPage Compatibility for CreateCurrencyFormatterN()
- * @section CompNumberFormatterCreateCurrencyFormatterNIssueSection Issues
- * Implementation of this method in OSP compatible applications has the following issue: @n
- * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid.
- *
- * @section CompNumberFormatterCreateCurrencyFormatterNSolutionSection Resolutions
- * This issue has been resolved in Tizen.
+ * @page CompNumberFormatterCreateCurrencyFormatterNPage Compatibility for CreateCurrencyFormatterN()
+ * @section CompNumberFormatterCreateCurrencyFormatterNIssueSection Issues
+ * Implementation of this method in OSP compatible applications has the following issue: @n
+ * -# The method returns @c E_UNSUPPORTED_OPERATION if the @c locale is invalid.
+ *
+ * @section CompNumberFormatterCreateCurrencyFormatterNSolutionSection Resolutions
+ * This issue has been resolved in Tizen.
* @par When working in Tizen:
- * -# The method returns E_INVALID_ARG if the @c locale is invalid.
+ * -# The method returns @c E_INVALID_ARG if the @c locale is invalid.
* @endif
- */
+ */
/**
* Creates a percentage formatter for the system locale.
*
* @since 2.0
*
- * @return A pointer to a percentage formatter for the default locale, @n
+ * @return A pointer to the percentage formatter for the default locale, @n
* else @c null if an error occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* Creates a percentage formatter for the specified @c locale.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompNumberFormatterCreatePercentFormatterNPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompNumberFormatterCreatePercentFormatterNPage "here".
* @endif
*
- * @return A pointer to a percentage formatter for the specified @c locale, @n
+ * @return A pointer to the percentage formatter for the specified @c locale, @n
* else @c null if an error occurs
- * @param[in] locale An instance of Locale
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @param[in] locale An instance of Locale
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_INVALID_ARG The specified @c locale is invalid.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
static NumberFormatter* CreatePercentFormatterN(const Locale& locale);
- /**
+ /**
* @if OSPCOMPAT
- * @page CompNumberFormatterCreatePercentFormatterNPage Compatibility for CreatePercentFormatterN()
- * @section CompNumberFormatterCreatePercentFormatterNIssueSection Issues
- * Implementation of this method in OSP compatible applications has the following issue: @n
- * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid.
- *
- * @section CompNumberFormatterCreatePercentFormatterNSolutionSection Resolutions
- * This issue has been resolved in Tizen.
+ * @page CompNumberFormatterCreatePercentFormatterNPage Compatibility for CreatePercentFormatterN()
+ * @section CompNumberFormatterCreatePercentFormatterNIssueSection Issues
+ * Implementation of this method in OSP compatible applications has the following issue: @n
+ * -# The method returns @c E_UNSUPPORTED_OPERATION if the @c locale is invalid.
+ *
+ * @section CompNumberFormatterCreatePercentFormatterNSolutionSection Resolutions
+ * This issue has been resolved in Tizen.
* @par When working in Tizen:
- * -# The method returns E_INVALID_ARG if the @c locale is invalid.
+ * -# The method returns @c E_INVALID_ARG if the @c locale is invalid.
* @endif
- */
+ */
*
* @return An error code
* @param[in] number The number of type Tizen::Base::Long to format
- * @param[out] str The string to append to the resultant string
+ * @param[out] str The string to append
* @exception E_SUCCESS The method is successful.
*/
virtual result Format(long number, Tizen::Base::String& str) const;
*
* @return An error code
* @param[in] number The number of type Tizen::Base::Double to format
- * @param[out] str The string to append to the resultant string
+ * @param[out] str The string to append
* @exception E_SUCCESS The method is successful.
*/
virtual result Format(double number, Tizen::Base::String& str) const;
* @remarks The initial value is derived in a locale dependent way. @n
* The returned value may be @c null if no valid currency is determined
* or no currency has been set using the SetCurrency() method.
- * @see SetCurrency()
*/
virtual const Currency* GetCurrency(void) const;
/**
- * Sets the currency used by the current number format when formatting currency values.
+ * Sets the currency to be used by the current number format when formatting currency values.
*
- * @since 2.0
+ * @since 2.0
*
- * @param[in] currency The new currency to use by the current number format
+ * @param[in] currency The currency to set
* @remarks This does not update the minimum or maximum number of fractional digits used by the number format.
- * @see GetCurrency()
+ * @see GetCurrency()
*/
virtual void SetCurrency(const Currency& currency);
*
* @param[in] newValue The maximum number of integer digits allowed in the integer portion of a number, @n
* If less than zero, @c 0 is used.
- * @remarks The maximum integer digits must be greater than or equal to the minimum integer digits.
+ * @remarks The maximum integer digits must be greater than or equal to the minimum integer digits.@n
* If the new value for the maximum integer digits is less than the current value of the minimum integer digits,
* the minimum integer digits are also set to the new value.
* @see GetMaxIntegerDigits()
*
* @since 2.0
*
- * @return An integer value representing the minimum number of digits allowed in the integer portion of a number
+ * @return An integer value representing the minimum number of digits
* @see SetMinIntegerDigits()
*/
virtual int GetMinIntegerDigits(void) const;
*
* @since 2.0
*
- * @param[in] newValue The minimum number of integer digits allowed in the integer portion of a number @n
- * If less than zero, @c 0 is used.
- * @remarks The minimum integer digits must be less than or equal to the maximum integer digits.
+ * @param[in] newValue The minimum number of integer digits allowed in the integer portion of a number @n
+ * If less than zero, @c 0 is used.
+ * @remarks The minimum integer digits must be less than or equal to the maximum integer digits. @n
* If the new value for the minimum integer digits exceeds the current value of the maximum integer digits,
* the maximum integer digits are also set to the new value.
* @see GetMinIntegerDigits()
*
* @since 2.0
*
- * @return An integer value representing the maximum number of digits allowed in the fractional portion of a number
+ * @return An integer value representing the maximum number of digits
* @see SetMaxFractionDigits()
*/
virtual int GetMaxFractionDigits(void) const;
*
* @param[in] newValue The maximum number of fractional digits allowed in the fractional portion of a number @n
* If less than zero, @c 0 is used.
- * @remarks The maximum fractional digits must be greater than or equal to the minimum fractional digits.
+ * @remarks The maximum fractional digits must be greater than or equal to the minimum fractional digits. @n
* If the new value for the maximum fractional digits is less than the current value of the minimum fractional digits,
* the minimum fractional digits are also set to the new value.
* @see GetMaxFractionDigits()
*
* @param[in] newValue The minimum number of fractional digits allowed in the fractional portion of a number @n
* If less than zero, @c 0 is used.
- * @remarks The minimum fractional digits must be less than or equal to the maximum fractional digits.
+ * @remarks The minimum fractional digits must be less than or equal to the maximum fractional digits. @n
* If the new value for the minimum fractional digits exceeds the current value of the maximum fraction digits,
* the maximum fraction digits are also set to the new value.
* @see GetMinFractionDigits()
*
* @return @c true if grouping is used in the current instance of %NumberFormatter, @n
* else @c false
- * @remarks For example, in the English locale, with grouping on, the number 1234567
+ * @remarks
+ * - For example, in the English locale, with grouping on, the number 1234567
* might be formatted as "1,234,567".
- * The grouping separator as well as the size of each group is locale dependent
+ * - The grouping separator as well as the size of each group is locale dependent
* and is determined by subclasses of %NumberFormatter.
* @see SetGroupingUsed()
*/
/**
- * Sets the current instance of %NumberFormatter to use or not to use grouping.
+ * Sets the use of grouping in the current instance of %NumberFormatter.
*
* @since 2.0
*
- * @param[in] newValue Set to @c true if grouping is used in the current formatter, @n
+ * @param[in] newValue Set to @c true to use grouping in the current formatter, @n
* else @c false
* @see IsGroupingUsed()
*/
/**
- * Applies the specified pattern to the current instance of %NumberFormatter.
+ * Applies the pattern to the current instance of %NumberFormatter.
*
* @since 2.0
*
* @return An error code
- * @param[in] pattern The new pattern
- * @param[in] localized The localization On/Off flag @n
+ * @param[in] pattern The pattern to apply
+ * @param[in] localized The flag to set the localization on or off @n
* Set to @c true if the pattern is applied with the localized symbols, @n
- * else @c false.
+ * else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c pattern is invalid or its length is @c 0.
*/
/**
- * Sets a new value for the positive prefix of the current instance of %NumberFormatter.
+ * Sets the positive prefix of the current instance of %NumberFormatter.
*
* @since 2.0
*
- * @param[in] newValue The new positive prefix
+ * @param[in] newValue The positive prefix to set
* @see GetPositivePrefix()
*/
void SetPositivePrefix(const Tizen::Base::String& newValue);
/**
- * Sets a new value for the negative prefix of the current instance of %NumberFormatter.
+ * Sets the negative prefix of the current instance of %NumberFormatter.
*
* @since 2.0
*
- * @param[in] newValue The new negative prefix
+ * @param[in] newValue The negative prefix to set
* @see GetNegativePrefix()
*/
void SetNegativePrefix(const Tizen::Base::String& newValue);
/**
- * Sets a new value for the positive suffix of the current instance of %NumberFormatter.
+ * Sets the positive suffix of the current instance of %NumberFormatter.
*
* @since 2.0
*
- * @param[in] newValue The new positive suffix
+ * @param[in] newValue The positive suffix to set
* @see GetPositiveSuffix()
*/
void SetPositiveSuffix(const Tizen::Base::String& newValue);
/**
- * Sets a new value for the negative suffix of the current instance of %NumberFormatter.
+ * Sets the negative suffix of the current instance of %NumberFormatter.
*
* @since 2.0
*
- * @param[in] newValue The new negative suffix
+ * @param[in] newValue The negative suffix to set
* @see GetNegativeSuffix()
*/
void SetNegativeSuffix(const Tizen::Base::String& newValue);
/**
- * Sets a new value for the multiplier for use in percent, per mill, and so on.
+ * Sets the multiplier for use in percent, per mill, and so on.
*
* @since 2.0
*
- * @param[in] newValue The new value for the multiplier
+ * @param[in] newValue The multiplier to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @remarks For example, in percentage, set the suffixes to have "%" and the multiplier to be 100.
* @since 2.0
*
* @return An integer value representing the grouping size
- * @remarks Grouping size is the number of digits between grouping separators in the integer portion of a number. @n
- * For example, in the number "123,456.78", the grouping size is 3.
+ * @remarks The grouping size is the number of digits between the grouping separators in the integer portion of a number. @n
+ * For example, in the number "123,456.78", the grouping size is 3.
* @see SetGroupingSize()
* @see IsGroupingUsed()
*/
/**
- * Sets a new value for the grouping size.
+ * Sets the grouping size.
*
* @since 2.0
*
- * @param[in] newValue The new value for the grouping size
+ * @param[in] newValue The grouping size to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @see GetGroupingSize()
/**
- * Sets the behavior of the decimal separator. @n
+ * Sets the visibility behavior of the decimal separator. @n
* The decimal separator can be set to always appear using this method.
*
* @since 2.0
*
- * @param[in] newValue Set to @c true if the decimal separator is always shown, @n
+ * @param[in] newValue Set to @c true to always show the decimal separator, @n
* else @c false
* @see IsDecimalSeparatorAlwaysShown()
*/
/**
- * Sets the behavior of the plus sign. @n
+ * Sets the visibility behavior of the plus sign. @n
* The plus sign can be set to always appear using this method.
*
* @since 2.0
*
- * @param[in] newValue Set to @c true if the plus sign is always shown, @n
+ * @param[in] newValue Set to @c true to always show the plus sign, @n
* else @c false
* @see IsPositiveSignAlwaysShown()
*/
projects / platform / framework / native / appfw.git / blobdiff