Default constructor.

It constructs the object with the system's locale settings.

A single copy of the locale information is maintained by the system. This copy may be refreshed under application control with TLocale::Refresh(), and the settings may be saved to the system with TLocale::Set(). However, the settings are never updated by the system apart from under application control. This enables applications to guarantee that consistent locale information is used.

TLocale::Refresh() TLocale::Set()

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

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

Gets the clock display format.

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.

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

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

This is deprecated, use NegativeCurrencyFormat() instead.

TLocale::NegativeCurrencyFormat

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().

TLocale::SetNegativeLoseSpace

Gets the currency symbol position.

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

TLocale::SetNegativeCurrencySymbolOpposite

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

Gets the date format.

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.

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.

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

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

Gets the device time state.

Use the timezone server to coordinate automatic time adjustment.

Gets the number mode stored in the locale.

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.

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.

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.

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.

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

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

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().

BaflUtils::NearestLanguageFile BaflUtils::GetDowngradePath

Gets the negative currency format.

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()).

TLocale::SetCurrencySymbolPosition

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

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

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.

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

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.

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

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

Sets the clock display format.

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.

TLocale::CountryCode

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

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

This is deprecated, use SetNegativeCurrencyFormat() instead.

TLocale::SetNegativeCurrencyFormat

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

Sets the currency symbol position.

Sets whether triads are allowed in currency values.

Sets the date format.

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.

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

Sets the device time state.

Use the timezone server to coordinate automatic time adjustment.

Sets the number mode for the locale.

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

BaflUtils::NearestLanguageFile BaflUtils::GetDowngradePath

Sets the negative currency format.

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()).

TLocale::SetCurrencySymbolPosition

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

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

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.

Sets the time format (12 or 24 hour).

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.

Sets the units of measurement for long distances.

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

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.

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

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

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

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.

Gets the time format (12 or 24 hour).

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.

Gets the units of measurement for long distances.

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

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.

Gets the general units of measurement.

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

Gets the locale's universal time offset.

Use User::UTCOffset to get the current offset inclusive of daylight savings time. This function returns the same value, for compatibility.

Gets a bit mask representing the days of the week which are considered as working days.

Flags for negative currency values formatting

Indicates how the device universal time is maintained

Indicates how negative currency values are formatted.