#include <e32std.h>
| class TLocale |
| Public Member Enumerations | |
|---|---|
| enum | anonymous { EFlagNegativeLoseSpace, EFlagNegativeCurrencySymbolOpposite } |
| enum | TDeviceTimeState { EDeviceUserTime, ENITZNetworkTimeSync } |
| enum | TNegativeCurrencyFormat { ELeadingMinusSign, EInBrackets, ETrailingMinusSign, EInterveningMinusSign } |
Sets and gets the system's locale settings.
Symbian OS maintains the locale information internally. On construction, this object is initialized with the system information for all locale items.
Flags for negative currency values formatting
Indicates how the device universal time is maintained
Indicates how negative currency values are formatted.
| TBool | AmPmSpaceBetween | ( | ) | const [inline] |
Tests whether or not a space is inserted between the time and the preceding or trailing am/pm text.
Returns: True if a space is inserted between the time and am/pm text; false if not.
| TLocalePos | AmPmSymbolPosition | ( | ) | const [inline] |
Gets the am/pm text position (before or after the time value).
Returns: The am/pm text position (0 before, 1 after).
| TClockFormat | ClockFormat | ( | ) | const [inline] |
Gets the clock display format.
Returns: The clock display format.
| 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.
Returns: The country code.
| TInt | CurrencyDecimalPlaces | ( | ) | const [inline] |
Gets the number of decimal places to which currency values are set.
Returns: The number of decimal places.
| TBool | CurrencyNegativeInBrackets | ( | ) | const [inline] |
Gets whether negative currency values are enclosed in brackets rather than being preceded by a minus sign.
This is deprecated, use NegativeCurrencyFormat() instead.
See also: TLocale::NegativeCurrencyFormat
Returns: 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.
| TBool | 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().
See also: TLocale::SetNegativeLoseSpace
Returns: True if a space is inserted; false if not.
| TLocalePos | CurrencySymbolPosition | ( | ) | const [inline] |
Gets the currency symbol position.
For negative currency values, this position may be reversed using SetNegativeCurrencySymbolOpposite().
Returns: The currency symbol position.
| TBool | CurrencyTriadsAllowed | ( | ) | const [inline] |
Gets whether triads are allowed in currency values. Triads are groups of three digits separated by the thousands separator.
Returns: True if triads are allowed; false if not.
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.
| Parameter | Description |
|---|---|
| aIndex | An index indicating which of the four separators is being accessed. This must be a value between zero and three inclusive. |
Returns: A date separator character as determined by the value of aIndex.
| TUint | DaylightSaving | ( | ) | const [inline] |
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.
See also: TLocale::QueryHomeHasDaylightSavingOn TDaylightSavingZone
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.
Returns: 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.
| TChar | DecimalSeparator | ( | ) | const [inline] |
Gets the character used to separate a whole number from its fractional part.
Returns: The character used as the decimal separator.
| TDeviceTimeState | DeviceTime | ( | ) | const [inline] |
Gets the device time state.
DeprecatedUse the timezone server to coordinate automatic time adjustment.
Returns: The device time state.
| TDigitType | DigitType | ( | ) | const [inline] |
Gets the number mode stored in the locale.
Returns: The number mode for the locale.
| IMPORT_C void | FormatCurrency | ( | TDes & | aText, |
| TDesOverflow & | aOverflowHandler, | |||
| TInt | aAmount | |||
| ) | ||||
| IMPORT_C void | FormatCurrency | ( | TDes & | aText, |
| TDesOverflow & | aOverflowHandler, | |||
| TInt64 | aAmount | |||
| ) | ||||
| 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.
Returns: The daylight saving zone in which the home city is located.
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
| Parameter | Description |
|---|---|
| aIndex | An index into the customisable part of the language downgrade path. Between zero and two inclusive. |
Returns: The language at the specified index.
| TNegativeCurrencyFormat | NegativeCurrencyFormat | ( | ) | const [inline] |
Gets the negative currency format.
Returns: How negative currency values are formatted.
| TBool | 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()).
See also: TLocale::SetCurrencySymbolPosition
Returns: True, if the currency symbol position for negative currency values is the opposite of the position set by SetCurrencySymbolPosition(); false, otherwise.
| TBool | NegativeLoseSpace | ( | ) | const [inline] |
Gets whether negative currency values lose the space between the currency symbol and the value.
Returns: True, if negative currency values lose the space between the value and the symbol; false, if not.
| TBool | 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.
Returns: True if home daylight saving is set; false if not.
| void | SetAmPmSpaceBetween | ( | TBool | aSpace | ) | [inline] |
Sets whether a space is inserted between the time and the preceding or trailing am/pm text.
| void | SetAmPmSymbolPosition | ( | TLocalePos | aPos | ) | [inline] |
Sets the am/pm text position (before or after the time value).
| void | SetClockFormat | ( | TClockFormat | aFormat | ) | [inline] |
Sets the clock display format.
| Parameter | Description |
|---|---|
| aFormat | The clock display format. |
| void | SetCountryCode | ( | TInt | 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.
See also: TLocale::CountryCode
| Parameter | Description |
|---|---|
| aCode | The country code. |
| void | SetCurrencyDecimalPlaces | ( | TInt | aPlaces | ) | [inline] |
Sets the number of decimal places to which currency values should be set.
| Parameter | Description |
|---|---|
| aPlaces | The number of decimal places. |
| void | SetCurrencyNegativeInBrackets | ( | TBool | aBool | ) | [inline] |
Sets whether negative currency values are enclosed in brackets rather than being preceded by a minus sign.
This is deprecated, use SetNegativeCurrencyFormat() instead.
See also: TLocale::SetNegativeCurrencyFormat
| Parameter | Description |
|---|---|
| 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. |
| void | SetCurrencySpaceBetween | ( | TBool | aSpace | ) | [inline] |
Sets whether a space is inserted between the currency symbol and the currency amount.
| Parameter | Description |
|---|---|
| aSpace | ETrue if a space is inserted; EFalse if not. |
| void | SetCurrencySymbolPosition | ( | TLocalePos | aPos | ) | [inline] |
Sets the currency symbol position.
| Parameter | Description |
|---|---|
| aPos | The currency symbol position. |
| void | SetCurrencyTriadsAllowed | ( | TBool | aBool | ) | [inline] |
Sets whether triads are allowed in currency values.
| Parameter | Description |
|---|---|
| aBool | ETrue if triads are allowed; EFalse if triads not allowed. |
| void | SetDateFormat | ( | TDateFormat | aFormat | ) | [inline] |
Sets the date format.
| Parameter | Description |
|---|---|
| aFormat | The date format to be used. |
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.
| Parameter | Description |
|---|---|
| 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. |
| void | SetDecimalSeparator | ( | const TChar & | aChar | ) | [inline] |
Sets the character to be used to separate a whole number from its fractional part.
| Parameter | Description |
|---|---|
| aChar | The character to be used as the decimal separator. |
| void | SetDeviceTime | ( | TDeviceTimeState | aState | ) | [inline] |
Sets the device time state.
DeprecatedUse the timezone server to coordinate automatic time adjustment.
| Parameter | Description |
|---|---|
| aState | The device time state. |
| void | SetDigitType | ( | TDigitType | aDigitType | ) | [inline] |
Sets the number mode for the locale.
| Parameter | Description |
|---|---|
| aDigitType | The number mode to be set. |
Sets a language in the customisable part of the language downgrade path.
See also: BaflUtils::NearestLanguageFile BaflUtils::GetDowngradePath
| Parameter | Description |
|---|---|
| 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. |
| void | SetNegativeCurrencyFormat | ( | TNegativeCurrencyFormat | aNegativeCurrencyFormat | ) | [inline] |
Sets the negative currency format.
| Parameter | Description |
|---|---|
| aNegativeCurrencyFormat | How negative currency values are formatted. |
| void | SetNegativeCurrencySymbolOpposite | ( | TBool | 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()).
See also: TLocale::SetCurrencySymbolPosition
| Parameter | Description |
|---|---|
| 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. |
| void | SetNegativeLoseSpace | ( | TBool | aBool | ) | [inline] |
Sets whether negative currency values lose the space between the currency symbol and the value.
| Parameter | Description |
|---|---|
| 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. |
| void | SetStartOfWeek | ( | TDay | aDay | ) | [inline] |
Sets the day which is considered to be the first day of the week.
| Parameter | Description |
|---|---|
| aDay | The first day of the week. |
| 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.
| Parameter | Description |
|---|---|
| aChar | The character to be used as the thousands separator. |
| void | SetTimeFormat | ( | TTimeFormat | aFormat | ) | [inline] |
Sets the time format (12 or 24 hour).
| Parameter | Description |
|---|---|
| aFormat | The time format. |
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.
| Parameter | Description |
|---|---|
| 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. |
| void | SetUnitsDistanceLong | ( | TUnitsFormat | aFormat | ) | [inline] |
Sets the units of measurement for long distances.
Long distances are those which would normally be represented by either miles or kilometres.
| Parameter | Description |
|---|---|
| aFormat | Units of measurement for long distances. |
| void | SetUnitsDistanceShort | ( | TUnitsFormat | 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.
| Parameter | Description |
|---|---|
| aFormat | Units of measurement for short distances. |
| void | SetUnitsGeneral | ( | TUnitsFormat | 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.
| Parameter | Description |
|---|---|
| aFormat | General units of measurement. |
| void | SetWorkDays | ( | TUint | aMask | ) | [inline] |
Sets the days of the week which are considered as working days.
| Parameter | Description |
|---|---|
| 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. |
| TDay | StartOfWeek | ( | ) | const [inline] |
Gets the day which is considered the first day of the week.
Returns: The first day of the week.
| TChar | 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.
Returns: The character used as the thousands separator.
| TTimeFormat | TimeFormat | ( | ) | const [inline] |
Gets the time format (12 or 24 hour).
Returns: The time format.
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.
| Parameter | Description |
|---|---|
| aIndex | An index indicating which of the four separators is being accessed. This must be a value between zero and three inclusive. |
Returns: A time separator character as determined by the value of aIndex.
| TUnitsFormat | 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.
Returns: Units of measurement for long distances.
| TUnitsFormat | 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.
Returns: Units of measurement for short distances.
| TUnitsFormat | UnitsGeneral | ( | ) | const [inline] |
Gets the general units of measurement.
This function should be used when both short and long distances use the same units of measurement.
Returns: General units of measurement.
| TTimeIntervalSeconds | UniversalTimeOffset | ( | ) | const [inline] |
Gets the locale's universal time offset.
DeprecatedUse User::UTCOffset to get the current offset inclusive of daylight savings time. This function returns the same value, for compatibility.
Returns: Offset in seconds from universal time. Time zones east of universal time have positive offsets. Time zones west of universal time have negative offsets.
| TUint | WorkDays | ( | ) | const [inline] |
Gets a bit mask representing the days of the week which are considered as working days.
Returns: A bit mask of seven bits indicating (by being set) which days are workdays. The least significant bit corresponds to Monday, the next bit to Tuesday and so on.