TSdlLocale
A record to provide locale data.
Locale data is split into a spoken language, like English, and an optional country, like Canada. The language will be in ISO-639 format (so English would be 'en'), and the country, if not empty, will be an ISO-3166 country code (so Canada would be 'CA').
Definition
Unit: Neslib.Sdl3.Additional
Properties
| Name | Description |
|---|---|
| Country | A country, like 'US' for America. Can be empty. |
| Language | A language name, like 'en' for English. |
| PreferredLocales | Report the user's preferred locales. |
Property Descriptions
Country
A country, like 'US' for America. Can be empty.
property Country: String read FCountry
Type: String
Language
A language name, like 'en' for English.
property Language: String read FLanguage
Type: String
PreferredLocales
Report the user's preferred locales.
Language strings are (lowercase) ISO-639 language specifiers (such as 'en' for English, 'de' for German, etc). Country strings are (uppercase) ISO-3166 country codes (such as 'US' for the United States, 'CA' for Canada, etc). Country might be empty if there's no specific guidance on them (so you might get {'en', 'US'} for American English, but {'en', ''} means "English language, generically"). Language strings are never empty.
Please note that not all of these strings are 2 characters; some are three or more.
The returned list of locales are in the order of the user's preference. For example, a German citizen that is fluent in US English and knows enough Japanese to navigate around Tokyo might have a list like: [ {'de', ''}, {'en', 'US'}, {'jp', ''} ]. Someone from England might prefer British English (where "color" is spelled "colour", etc), but will settle for anything like it: [ {'en', 'GB'}, {'en', ''} ].
This property returns an empty array when the platform does not supply this information at all.
This might be a "slow" call that has to query the operating system. It's best to ask for this once and save the results. However, this list can change, usually because the user has changed a system preference outside of your program; SDL will send an TSdlEventKind.LocaleChanged event in this case, if possible, and you can call this function again to get an updated copy of preferred locales.
class property PreferredLocales: TArray<TSdlLocale> read GetPreferredLocales
Type: TArray<TSdlLocale>