AIStringFormatUtilsSuite Struct Reference
[API Suite List]

This suite provides support for the ai::NumberFormat and ai::Locale classes in plug-ins. More...

#include <AIStringFormatUtils.h>

Public Attributes
AIAPI AIErr(*	GetLocaleString )(const ai::LocaleID id, ai::AutoBuffer< char > &locale)
	Retrieves the language and region code string for a locale object.
AIAPI AIErr(*	GetLocaleID )(const char *locale, ai::LocaleID &id)
	Retrieves the locale object identifier for a language and region code string.
AIAPI AIErr(*	Initialize )(ai::NumberFormat &format, const ai::LocaleID locale)
	Initializes a `ai::NumberFormat` object for a locale.
AIAPI AIErr(*	InitializeDefaultInstance )(ai::NumberFormat &format)
	Initializes `ai::NumberFormat` object with the default system setting for number formatting, using the factory method `ai::NumberFormat::getFormat`.
AIAPI AIErr(*	Copy )(ai::NumberFormat &format, const ai::NumberFormat &format2)
	Copies one number format object into another.
AIAPI AIErr(*	Destroy )(ai::NumberFormat &format)
	Deletes the contents of a number format object.
AIAPI AIErr(*	RealToString )(ai::NumberFormat &format, const float value, const ai::int32 precision, AIBoolean padToPrecision, ai::UnicodeString &str)
	Formats a float value into a string using a `ai::NumberFormat` object.
AIAPI AIErr(*	IntegerToString )(ai::NumberFormat &format, const ai::int32 value, ai::UnicodeString &str)
	Formats an integer value into a string using a `ai::NumberFormat` object.
AIAPI AIErr(*	DoubleToString )(ai::NumberFormat &format, const double value, const ai::int32 precision, AIBoolean padToPrecision, ai::UnicodeString &str)
	Formats a double value into a string using a `ai::NumberFormat` object.
AIAPI AIErr(*	StringToReal )(ai::NumberFormat &format, const ai::UnicodeString &str, float &value)
	Parses a string into a float value using a `ai::NumberFormat` object.
AIAPI AIErr(*	StringToInteger )(ai::NumberFormat &format, const ai::UnicodeString &str, ai::int32 &value)
	Parses a string into an integer value using a `ai::NumberFormat` object.
AIAPI AIErr(*	StringToDouble )(ai::NumberFormat &format, const ai::UnicodeString &str, double &value)
	Parses a input string into a double value.
AIAPI AIErr(*	GetDecimalSeparator )(ai::NumberFormat &format, ai::UnicodeString &str)
	Retrieves the decimal separator character used by the locale of a `ai::NumberFormat` object.
AIAPI AIErr(*	GetThousandsSeparator )(ai::NumberFormat &format, ai::UnicodeString &str)
	Retrieves the thousands separator character used by the locale of a `ai::NumberFormat` object.

Detailed Description

This suite provides support for the ai::NumberFormat and ai::Locale classes in plug-ins.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIStringFormatUtilsSuite and kAIStringFormatUtilsVersion.

Member Data Documentation

AIAPI AIErr(* AIStringFormatUtilsSuite::Copy)(ai::NumberFormat &format, const ai::NumberFormat &format2)

Copies one number format object into another.

If the source format object is empty or uninitialized, empties the destination format object.

Parameters:

	format	The destination format object.
	format2	The source format object.

AIAPI AIErr(* AIStringFormatUtilsSuite::Destroy)(ai::NumberFormat &format)

Deletes the contents of a number format object.

Parameters:

format

The format object.

AIAPI AIErr(* AIStringFormatUtilsSuite::DoubleToString)(ai::NumberFormat &format, const double value, const ai::int32 precision, AIBoolean padToPrecision, ai::UnicodeString &str)

Formats a double value into a string using a ai::NumberFormat object.

Parameters:

	format	The number format object.
	value	The numeric value to be formatted.
	precision	The maximum number of digits allowed after the decimal point. If the precision of `value` is bigger than this, applies input rounding.
	padToPrecision	If true, and if the precision of the input value is less than `precision`, pad with zeroes after the decimal place so that the number of digits after the decimal in the formatted string matches the precision.
	str	[out] A buffer in which to return the formatted string.

AIAPI AIErr(* AIStringFormatUtilsSuite::GetDecimalSeparator)(ai::NumberFormat &format, ai::UnicodeString &str)

Retrieves the decimal separator character used by the locale of a ai::NumberFormat object.

Parameters:

	format	The number format object.
	str	[out] A buffer in which to return the decimal separator character.

AIAPI AIErr(* AIStringFormatUtilsSuite::GetLocaleID)(const char *locale, ai::LocaleID &id)

Retrieves the locale object identifier for a language and region code string.

Parameters:

	locale	The language and region code string.
	id	[out] A buffer in which to return the locale identifier.

AIAPI AIErr(* AIStringFormatUtilsSuite::GetLocaleString)(const ai::LocaleID id, ai::AutoBuffer< char > &locale)

Retrieves the language and region code string for a locale object.

Parameters:

	id	The locale identifier.
	locale	[out] A buffer in which to return the result string.

AIAPI AIErr(* AIStringFormatUtilsSuite::GetThousandsSeparator)(ai::NumberFormat &format, ai::UnicodeString &str)

Retrieves the thousands separator character used by the locale of a ai::NumberFormat object.

Parameters:

	format	The number format object.
	str	[out] A buffer in which to return the thousands separator character.

AIAPI AIErr(* AIStringFormatUtilsSuite::Initialize)(ai::NumberFormat &format, const ai::LocaleID locale)

Initializes a ai::NumberFormat object for a locale.

Parameters:

	format	The number format object.
	locale	The locale object identifier.

AIAPI AIErr(* AIStringFormatUtilsSuite::InitializeDefaultInstance)(ai::NumberFormat &format)

Initializes ai::NumberFormat object with the default system setting for number formatting, using the factory method ai::NumberFormat::getFormat.

Parameters:

format

The number format object.

AIAPI AIErr(* AIStringFormatUtilsSuite::IntegerToString)(ai::NumberFormat &format, const ai::int32 value, ai::UnicodeString &str)

Formats an integer value into a string using a ai::NumberFormat object.

Parameters:

	format	The number format object.
	value	The numeric value to be formatted.
	str	[out] A buffer in which to return the formatted string.

AIAPI AIErr(* AIStringFormatUtilsSuite::RealToString)(ai::NumberFormat &format, const float value, const ai::int32 precision, AIBoolean padToPrecision, ai::UnicodeString &str)

Formats a float value into a string using a ai::NumberFormat object.

Parameters:

	format	The number format object.
	value	The numeric value to be formatted.
	precision	The maximum number of digits allowed after the decimal point. If the precision of `value` is bigger than this, applies input rounding.
	padToPrecision	If true, and if the precision of the input value is less than `precision`, pad with zeroes after the decimal place so that the number of digits after the decimal in the formatted string matches the precision.
	str	[out] A buffer in which to return the formatted string.

AIAPI AIErr(* AIStringFormatUtilsSuite::StringToDouble)(ai::NumberFormat &format, const ai::UnicodeString &str, double &value)

Parses a input string into a double value.

using a ai::NumberFormat object.

Parameters:

	format	The number format object.
	str	The string to be converted.
	value	[out] A buffer in which to return the numeric value.

Returns:: kBadParameterErr error if the string cannot be parsed into a valid numeric value.

AIAPI AIErr(* AIStringFormatUtilsSuite::StringToInteger)(ai::NumberFormat &format, const ai::UnicodeString &str, ai::int32 &value)

Parses a string into an integer value using a ai::NumberFormat object.

Parameters:

	format	The number format object.
	str	The string to be converted.
	value	[out] A buffer in which to return the numeric value.

Returns:: kBadParameterErr error if the string cannot be parsed into a valid numeric value.

AIAPI AIErr(* AIStringFormatUtilsSuite::StringToReal)(ai::NumberFormat &format, const ai::UnicodeString &str, float &value)

Parses a string into a float value using a ai::NumberFormat object.

Parameters:

	format	The number format object.
	str	The string to be converted.
	value	[out] A buffer in which to return the numeric value.

Returns:: kBadParameterErr error if the string cannot be parsed into a valid numeric value.

The documentation for this struct was generated from the following file:

AIStringFormatUtils.h

AIStringFormatUtilsSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AIStringFormatUtilsSuite Struct Reference
[API Suite List]