TLocale Class Reference

)

[inline]

Member Function Documentation

AmPmSpaceBetween ( )

AmPmSpaceBetween

(

)

const [inline]

Tests whether or not a space is inserted between the time and the preceding or trailing am/pm text.

Return Value: True if a space is inserted between the time and am/pm text; false if not.

AmPmSymbolPosition ( )

AmPmSymbolPosition

(

)

const [inline]

Gets the am/pm text position (before or after the time value).

Return Value: The am/pm text position (0 before, 1 after).

ClockFormat ( )

TClockFormat

ClockFormat

(

)

const [inline]

Gets the clock display format.

Return Value: The clock display format.

CountryCode ( )

TInt

CountryCode

(

)

const [inline]

Gets the code which is used to select country-specific locale data.

The country code is the code used as the international dialling prefix. This code is also used to identify a country by the dialling software.

Return Value: The country code.

CurrencyDecimalPlaces ( )

TInt

CurrencyDecimalPlaces

(

)

const [inline]

Gets the number of decimal places to which currency values are set.

Return Value: The number of decimal places.

CurrencyNegativeInBrackets ( )

CurrencyNegativeInBrackets

(

)

const [inline]

Deprecated

Gets whether negative currency values are enclosed in brackets rather than being preceded by a minus sign.

This is deprecated, use NegativeCurrencyFormat() instead.

Return Value: True if negative currency is enclosed in brackets and has no minus sign; false if negative currency has a minus sign and is not enclosed in brackets.

CurrencySpaceBetween ( )

CurrencySpaceBetween

(

)

const [inline]

Gets whether or not a space is inserted between the currency symbol and the currency value.

For negative currency values, the space can be removed using SetNegativeLoseSpace().

CurrencySymbolPosition ( )

CurrencySymbolPosition

(

)

const [inline]

Gets the currency symbol position.

For negative currency values, this position may be reversed using SetNegativeCurrencySymbolOpposite().

Return Value: The currency symbol position.

CurrencyTriadsAllowed ( )

CurrencyTriadsAllowed

(

)

const [inline]

Gets whether triads are allowed in currency values. Triads are groups of three digits separated by the thousands separator.

Return Value: True if triads are allowed; false if not.

DateFormat ( )

TDateFormat

DateFormat

(

)

const [inline]

Gets the date format.

Return Value: The date format.

DateSeparator ( TInt )

DateSeparator

(

aIndex

)

const [inline]

Gets one of the four characters used to separate the day, month and year components of the date.

If the four separators are represented by S0, S1, S2 and S3 and the three date components are represented by XX, YY and ZZ, then the separators are located: S0 XX S1 YY S2 ZZ S3.

Parameters
aIndex	An index indicating which of the four separators is being accessed. This must be a value between zero and three inclusive.

Return Value: A date separator character as determined by the value of aIndex.

DaylightSaving ( )

TUint

DaylightSaving

(

)

const [inline]

Deprecated

Gets the zones in which daylight saving is in effect.

If daylight saving is in effect, one hour is added to the time.

Use TLocale::QueryHomeHasDaylightSavingOn() to find out whether daylight saving is in effect for the home city. This is because the daylight saving setting for the home city may differ from that of the zone in which home is located.

Use the timezone server to retrieve information on timezones and DST. This method will always indicate that DST is inactive, in order to preserve compatibility.

Return Value: A bit mask in which the three least significant bits are defined, indicating which of the three daylight saving zones are adjusted for daylight saving. These bits represent: Northern (non-European countries in the northern hemisphere), Southern (southern hemisphere), and European.

DecimalSeparator ( )

DecimalSeparator

(

)

const [inline]

Gets the character used to separate a whole number from its fractional part.

Return Value: The character used as the decimal separator.

DeviceTime ( )

TDeviceTimeState

DeviceTime

(

)

const [inline]

Gets the device time state.

DeprecatedUse the timezone server to coordinate automatic time adjustment.

Return Value: The device time state.

DigitType ( )

TDigitType

DigitType

(

)

const [inline]

Gets the number mode stored in the locale.

Return Value: The number mode for the locale.

FormatCurrency ( TDes &, TInt )

IMPORT_C void	FormatCurrency	(	TDes &	aText,
			TInt	aAmount
		)

Renders a currency value as text, based on the locale's currency and numeric format settings.

These settings include the currency symbol, the symbol's position and the way negative values are formatted.

Parameters
aText	On return, contains the currency value as text, formatted according to the locale's currency format settings.
aAmount	The currency value to be formatted.

Panic Codes
USER	11, if aText is not long enough to hold the formatted value.

FormatCurrency ( TDes &, TInt64 )

IMPORT_C void	FormatCurrency	(	TDes &	aText,
			TInt64	aAmount
		)

Renders a currency value as text, based on the locale's currency and numeric format settings.

These settings include the currency symbol, the symbol's position and the way negative values are formatted.

Parameters
aText	On return, contains the currency value as text, formatted according to the locale's currency format settings.
aAmount	The currency value to be formatted.

Panic Codes
USER	11, if aText is not long enough to hold the formatted value.

FormatCurrency ( TDes &, TDesOverflow &, TInt )

IMPORT_C void	FormatCurrency	(	TDes &	aText,
			TDesOverflow &	aOverflowHandler,
			TInt	aAmount
		)

Renders a currency value as text, based on the locale's currency and numeric format settings.

These settings include the currency symbol, the symbol's position and the way negative values are formatted. If aText is not long enough to hold the formatted currency value, the overflow handler's Overflow() function is called.

Parameters
aText	On return, contains the currency value as text, formatted according to the locale's currency format settings.
aOverflowHandler	An object derived from TDesOverflow which handles descriptor overflows.
aAmount	The currency value to be formatted.

FormatCurrency ( TDes &, TDesOverflow &, TInt64 )

IMPORT_C void	FormatCurrency	(	TDes &	aText,
			TDesOverflow &	aOverflowHandler,
			TInt64	aAmount
		)

Renders a currency value as text, based on the locale's currency and numeric format settings.

Parameters
aText	On return, contains the currency value as text, formatted according to the locale's currency format settings.
aOverflowHandler	An object derived from TDesOverflow which handles descriptor overflows.
aAmount	The currency value to be formatted.

HomeDaylightSavingZone ( )

TDaylightSavingZone

HomeDaylightSavingZone

(

)

const [inline]

Gets the daylight saving zone in which the home city is located.

DeprecatedUse the timezone server to retrieve information on timezones and DST.

Return Value: The daylight saving zone in which the home city is located.

LanguageDowngrade ( TInt )

TLanguage

LanguageDowngrade

(

aIndex

)

const [inline]

Gets the language that is stored at the specified index into the customisable part of the language downgrade path.

The second, third and fourth languages in the language downgrade path can be customised. These can be enquired using this function. The first language in the path is always the language of the current locale, as returned by User::Language().

The languages in the downgrade path are used in turn by the BaflUtils::NearestLanguageFile() function to find the best matching language-specific version of a language-neutral filename.

The full language downgrade path can be retrieved using BaflUtils::GetDowngradePath().

See also: BaflUtils::NearestLanguageFile BaflUtils::GetDowngradePath

Parameters
aIndex	An index into the customisable part of the language downgrade path. Between zero and two inclusive.

Return Value: The language at the specified index.

NegativeCurrencyFormat ( )

TNegativeCurrencyFormat

NegativeCurrencyFormat

(

)

const [inline]

Gets the negative currency format.

Return Value: How negative currency values are formatted.

NegativeCurrencySymbolOpposite ( )

NegativeCurrencySymbolOpposite

(

)

const [inline]

Gets whether in negative currency values, the position of the currency symbol is set to be the opposite of the position used for non-negative values (before or after the value, as set by SetCurrencySymbolPosition()).

Return Value: True, if the currency symbol position for negative currency values is the opposite of the position set by SetCurrencySymbolPosition(); false, otherwise.

NegativeLoseSpace ( )

NegativeLoseSpace

(

)

const [inline]

Gets whether negative currency values lose the space between the currency symbol and the value.

Return Value: True, if negative currency values lose the space between the value and the symbol; false, if not.

QueryHomeHasDaylightSavingOn ( )

QueryHomeHasDaylightSavingOn

(

)

const [inline]

Tests whether or not daylight saving is set for the home city.

DeprecatedUse the timezone server to retrieve information on timezones and DST. This method will always indicate that DST is inactive, in order to preserve compatibility.

Return Value: True if home daylight saving is set; false if not.

Refresh ( )

IMPORT_C void

Refresh

(

)

Refreshes the contents of this object with the system's locale settings.

RegionCode ( )

TInt

RegionCode

(

)

const [inline]

Set ( )

IMPORT_C TInt

Set

(

)

const

Transfers the locale settings from this object to the system. Note that the timezone offset and daylight savings flags are ignored as setting these through TLocale is no longer supported.

After this function has been called, other applications may use the new settings for newly-constructed TLocale objects, or if they use TLocale::Refresh(), to refresh their settings from the system copy.

Capability
WriteDeviceData

SetAmPmSpaceBetween ( TBool )

void

SetAmPmSpaceBetween

(

aSpace

)

[inline]

Sets whether a space is inserted between the time and the preceding or trailing am/pm text.

SetAmPmSymbolPosition ( TLocalePos )

void

SetAmPmSymbolPosition

(

aPos

)

[inline]

Sets the am/pm text position (before or after the time value).

SetClockFormat ( TClockFormat )

void

SetClockFormat

(

TClockFormat

aFormat

)

[inline]

Sets the clock display format.

Parameters
aFormat	The clock display format.

SetCountryCode ( TInt )

void

SetCountryCode

(

aCode

)

[inline]

Sets the value which is used to select country-specific locale data.

This value can be retrieved by using TLocale::CountryCode(). The country code is the code used as the international dialling prefix. This code is also used to identify a country by the dialling software.

SetCurrencyDecimalPlaces ( TInt )

void

SetCurrencyDecimalPlaces

(

aPlaces

)

[inline]

Sets the number of decimal places to which currency values should be set.

Parameters
aPlaces	The number of decimal places.

SetCurrencyNegativeInBrackets ( TBool )

void

SetCurrencyNegativeInBrackets

(

aBool

)

[inline]

Deprecated

Sets whether negative currency values are enclosed in brackets rather than being preceded by a minus sign.

This is deprecated, use SetNegativeCurrencyFormat() instead.

Parameters
aBool	ETrue, if a negative currency value must be enclosed in brackets without a minus sign; EFalse, if a negative currency value is preceded by a minus sign without any enclosing brackets.

SetCurrencySpaceBetween ( TBool )

void

SetCurrencySpaceBetween

(

aSpace

)

[inline]

Sets whether a space is inserted between the currency symbol and the currency amount.

Parameters
aSpace	ETrue if a space is inserted; EFalse if not.

SetCurrencySymbolPosition ( TLocalePos )

void

SetCurrencySymbolPosition

(

aPos

)

[inline]

Sets the currency symbol position.

Parameters
aPos	The currency symbol position.

SetCurrencyTriadsAllowed ( TBool )

void

SetCurrencyTriadsAllowed

(

aBool

)

[inline]

Sets whether triads are allowed in currency values.

Parameters
aBool	ETrue if triads are allowed; EFalse if triads not allowed.

SetDateFormat ( TDateFormat )

void

SetDateFormat

(

TDateFormat

aFormat

)

[inline]

Sets the date format.

Parameters
aFormat	The date format to be used.

SetDateSeparator ( const TChar &, TInt )

void	SetDateSeparator	(	const TChar &	aChar,
			TInt	aIndex
		)	[inline]

Sets one of the four characters used to separate the day, month and year components of the date.

If the four separators are represented by S0, S1, S2 and S3 and the three date components are represented by XX, YY and ZZ, then the separators are located: S0 XX S1 YY S2 ZZ S3.

Parameters
aChar	A date separator character to be used.
aIndex	An index indicating which of the four separators is being accessed. This must be a value between zero and three inclusive.

SetDecimalSeparator ( const TChar & )

void

SetDecimalSeparator

(

const TChar &

aChar

)

[inline]

Sets the character to be used to separate a whole number from its fractional part.

Parameters
aChar	The character to be used as the decimal separator.

SetDefaults ( )

void

SetDefaults

(

)

SetDeviceTime ( TDeviceTimeState )

void

SetDeviceTime

(

TDeviceTimeState

aState

)

[inline]

Sets the device time state.

DeprecatedUse the timezone server to coordinate automatic time adjustment.

Parameters
aState	The device time state.

SetDigitType ( TDigitType )

void

SetDigitType

(

TDigitType

aDigitType

)

[inline]

Sets the number mode for the locale.

Parameters
aDigitType	The number mode to be set.

SetLanguageDowngrade ( TInt, TLanguage )

void	SetLanguageDowngrade	(	TInt	aIndex,
			TLanguage	aLanguage
		)	[inline]

Sets a language in the customisable part of the language downgrade path.

See also: BaflUtils::NearestLanguageFile BaflUtils::GetDowngradePath

Parameters
aIndex	An index into the customisable part of the path at which to add the language, a value between zero and two.
aLanguage	The language to add. ELangNone is considered to be the last language in the path, no more will be searched, so can be used to specify that no language downgrade is required.

SetNegativeCurrencyFormat ( TNegativeCurrencyFormat )

void

SetNegativeCurrencyFormat

(

TNegativeCurrencyFormat

aNegativeCurrencyFormat

)

[inline]

Sets the negative currency format.

Parameters
aNegativeCurrencyFormat	How negative currency values are formatted.

SetNegativeCurrencySymbolOpposite ( TBool )

void

SetNegativeCurrencySymbolOpposite

(

aBool

)

[inline]

Sets whether the position of the currency symbol for negative currency values should be the opposite of the position used for non-negative values (before or after the value, as set by SetCurrencySymbolPosition()).

Parameters
aBool	ETrue to set the position of the currency symbol in negative currency values to be the opposite of the position as set using SetCurrencySymbolPosition(). EFalse to leave the position unchanged.

SetNegativeLoseSpace ( TBool )

void

SetNegativeLoseSpace

(

aBool

)

[inline]

Sets whether negative currency values lose the space between the currency symbol and the value.

Parameters
aBool	ETrue to set a flag which indicates that negative currency values should lose the space between the value and the symbol. EFalse to unset it.

SetStartOfWeek ( TDay )

void

SetStartOfWeek

(

TDay

aDay

)

[inline]

Sets the day which is considered to be the first day of the week.

Parameters
aDay	The first day of the week.

SetThousandsSeparator ( const TChar & )

void

SetThousandsSeparator

(

const TChar &

aChar

)

[inline]

Sets the character to be used to separate groups of three digits to the left of the decimal separator.

A thousands separator character is only displayed in currency values if currency triads are allowed.

Parameters
aChar	The character to be used as the thousands separator.

SetTimeFormat ( TTimeFormat )

void

SetTimeFormat

(

TTimeFormat

aFormat

)

[inline]

Sets the time format (12 or 24 hour).

Parameters
aFormat	The time format.

SetTimeSeparator ( const TChar &, TInt )

void	SetTimeSeparator	(	const TChar &	aChar,
			TInt	aIndex
		)	[inline]

Sets one of the four characters used to separate the hour, minute and second components of the date.

If the four separators are represented by S0, S1, S2 and S3 and the three time components are represented by XX, YY and ZZ, then the separators are located: S0 XX S1 YY S2 ZZ S3.

Parameters
aChar	A time separator character to be used.
aIndex	An index indicating which of the four separators is being accessed. This must be a value between zero and three inclusive.

SetUnitsDistanceLong ( TUnitsFormat )

void

SetUnitsDistanceLong

(

aFormat

)

[inline]

Sets the units of measurement for long distances.

Long distances are those which would normally be represented by either miles or kilometres.

Parameters
aFormat	Units of measurement for long distances.

SetUnitsDistanceShort ( TUnitsFormat )

void

SetUnitsDistanceShort

(

aFormat

)

[inline]

Sets the units of measurement for short distances.

Short distances are those which would normally be represented by either metres and centimetres or feet and inches.

Parameters
aFormat	Units of measurement for short distances.

SetUnitsGeneral ( TUnitsFormat )

void

SetUnitsGeneral

(

aFormat

)

[inline]

Sets the general units of measurement. This function should be used when both short and long distances use the same units of measurement.

Parameters
aFormat	General units of measurement.

SetWorkDays ( TUint )

void

SetWorkDays

(

TUint

aMask

)

[inline]

Sets the days of the week which are considered as working days.

Parameters
aMask	A bit mask of seven bits indicating (by being set) which days are workdays. The least significant bit corresponds to Monday, the next bit is Tuesday and so on.

StartOfWeek ( )

TDay

StartOfWeek

(

)

const [inline]

Gets the day which is considered the first day of the week.

Return Value: The first day of the week.

ThousandsSeparator ( )

ThousandsSeparator

(

)

const [inline]

Gets the character used to separate groups of three digits to the left of the decimal separator.

A thousands separator character is only displayed in currency values if currency triads are allowed.

Return Value: The character used as the thousands separator.

TimeFormat ( )

TTimeFormat

TimeFormat

(

)

const [inline]

Gets the time format (12 or 24 hour).

Return Value: The time format.

TimeSeparator ( TInt )

TimeSeparator

(

aIndex

)

const [inline]

Gets one of the four characters used to separate the hour, second and minute components of the time.

If the four separators are represented by S0, S1, S2 and S3 and the three time components are represented by XX, YY and ZZ, then the separators are located: S0 XX S1 YY S2 ZZ S3.

Parameters
aIndex	An index indicating which of the four separators is being accessed. This must be a value between zero and three inclusive.

Return Value: A time separator character as determined by the value of aIndex.

UnitsDistanceLong ( )

UnitsDistanceLong

(

)

const [inline]

Gets the units of measurement for long distances.

Long distances are those which would normally be represented by either miles or kilometres.

Return Value: Units of measurement for long distances.

UnitsDistanceShort ( )

UnitsDistanceShort

(

)

const [inline]

Gets the units of measurement for short distances.

Short distances are those which would normally be represented by either metres and centimetres or feet and inches.

Return Value: Units of measurement for short distances.

UnitsGeneral ( )