CX_STATE_LOCALE
Class hierarchy
- CX_CLASS
- CX_EXPANDABLE
- CX_LOCALE
- CX_STATE_LOCALE
- CX_LOCALE
- CX_EXPANDABLE
Description:
A state locale is used to manage all information specific to the federal states. By default, all settings are "set to zero", which means that the data of the (mandatory) higher-level country locale is returned in case of access. If a new federal state is to be included in the file CX_ROOTDIR\SYSTEM\LOCALES .TXT, the entry must begin with the keyword "STATE". This is followed by the definitions of the individual pieces of information. The stateCode and countryCode must be entered to identify the State-Locale unambiguously. The following list shows all information contained in a state locale and what the default setting looks like. The information in the file is given by the field name followed by an "=" and the desired setting.
The changeover times from winter to summer time and vice versa are coded as periodic dates. By default they are undefined, as is all other information, so that when these data are accessed, the changeover times of the country are returned. In addition to this, federal state public holidays can be defined for a federal state.
Code example:
Define(InsertLocale)
Var(tmpLocale)
-> tmpLocale
tmpLocale ifnot
{
CreateTransObject(CX_COUNTRY_LOCALE)
}
else
{
tmpLocale Type case
CX_COUNTRY_LOCALE: CreateTransObject(CX_STATE_LOCALE)
CX_LOCALE:
CX_STATE_LOCALE : CreateTransObject(CX_LOCALE)
default: cancel
endCase
Dup tmpLocale Insert(sublocales)
}
-> systemLocale
systemLocale FillObox(, LocalesTree)
systemLocale Select(, LocalesTree)
systemLocale SendMsg(EDIT_LOCALE_NAME)
// systemLocale DrainWindow
;
Function | MA* | Parameters | Return | Brief description |
---|---|---|---|---|
AllHolidays/AllHolidayObjects | (OBJECT, OBJECT, INTEGER) | COLL | delivers all holidays in one period | |
BaseCentury | INTEGER | provides current century | ||
BaseCenturyMA | * | Current century input/output | ||
CodeMap | INTEGER | get the codepage | ||
CodeMapMA | * | Codepage input/output | ||
Country | STRING | get the country name | ||
CountryCode | INTEGER | get a country code | ||
CountryCodeMA | * | the country code input/output | ||
CountryMA | * | Country name input/output | ||
CurrencyUnitPrecedes | INTEGER | Shows by means of a truth value whether a currency unit should be displayed before the value or after the value. If the value is set to 1, the unit is displayed before the value. | ||
CurrencyUnitPrecedesMA | * | Position of a currency unit input/output. | ||
CurrencyUnitSeparation | INTEGER | Shows by means of a truth value whether a space should be displayed between a currency unit and the value (no matter in which order). | ||
CurrencyUnitSeparationMA | * | Space between a currency unit input/output | ||
DateFormat | INTEGER | returns the current date format | ||
DateFormatMA | * | Date format input/output | ||
DateSeparator | STRING | get the separator for a date | ||
DateSeparatorMA | * | Separator for a date input/output | ||
DecimalSeparator | STRING | get the separator for decimal numbers | ||
DecimalSeparatorMA | * | Separator for decimal numbers input/output | ||
DiallingPrefix | STRING | - obsolete/ deprecated - | ||
DiallingPrefixMA | * | - obsolete/ deprecated - | ||
EndTimeZone | INTEGER | provides the end time zone of the country in minutes off the CET | ||
EndTimeZoneMA | * | End time zone of the country Input/output | ||
FirstDayOfWeek | INTEGER | delivers the first day of the week | ||
FirstDayOfWeekMA | * | First day of the week Input/output | ||
FractionSeparator | STRING | provides the separator for numerator and denominator for fractions | ||
FractionSeparatorMA | * | Separator for numerator and denominator for fractions input/output | ||
Grouping | STRING | returns the formatting character that indicates after how many digits a thousand separator is inserted in a number | ||
GroupingMA | * | Formatting characters for thousands separator into a number Input/output | ||
InsertHoliday | insert a new holiday | |||
IntCurrencySymbol | STRING | provides the international currency symbol | ||
IntCurrencySymbolMA | * | International currency symbol Input/output | ||
IsAnniversary | (OBJECT) | INTEGER | tests whether a day is a commemoration day | |
IsDateType | (OBJECT, INTEGER) | INTEGER | tests whether a date is a special day off | |
IsHoliday | (OBJECT) | INTEGER | tests whether a day is a public holiday | |
IsTerm | (OBJECT) | INTEGER | tests whether a day is an appointment | |
IsVacation | (OBJECT) | INTEGER | tests whether a day is a holiday | |
Language | MLSTRING | get the name of the language as multiple string | ||
LanguageMA | * | Name of the language Input/Output | ||
LanguagePos | INTEGER | returns the system number of the national language | ||
LanguagePosMA | * | System number of the national language Input/output | ||
LocaleCode | STRING | get the abbreviation of the country name | ||
LocaleCodeMA | * | Abbreviation of the country name Input/output | ||
LocaleName | STRING | current local name ( country name) | ||
MLLocaleName | MLSTRING | current local name (country name) as multilingual text | ||
MLSpecialNameOfDay | INTEGER, CX_DATE | MLSTRING | Returns certain multilingual (holiday) names of the day of a date | |
NegativeSign | STRING | returns the minus sign | ||
NegativeSignMA | * | Minus sign input/output | ||
NegSignPrecedes | INTEGER | Shows with the help of a truth value whether the minus sign comes before the number. If not, it is behind the number. | ||
NegSignPrecedesMA | * | the position of the minus sign input/output | ||
NegSpaceSeparation | INTEGER | Shows with the help of a truth value whether there should be a space between the sign and the number | ||
NegSpaceSeparationMA | * | a space between the sign and the number Input/Output | ||
NewHoliday | CX_HOLIDAY | a new holiday is created and the locale object is added | ||
NonCurrencyUnitPrecedes | INTEGER | Shows by means of a truth value whether a non-currency unit should be displayed before or after the value of aCX_VALUE. If the value is 1, the unit is displayed before the value. | ||
NonCurrencyUnitPrecedesMA | * | Position of a non-currency unit of aCX_VALUE. Input/output. | ||
NonCurrencyUnitSeparation | INTEGER | Shows with the help of a truth value whether a space should be displayed between a non-currency unit and the value (in whatever order) of a CX_VALUE. | ||
NonCurrencyUnitSeparationMA | * | Controls spaces between the value and a non-currency unit of a CX_VALUE | ||
NumPrecision | INTEGER | returns the number of decimal places | ||
NumPrecisionMA | * | Number of decimal places input/output | ||
PathOfLocale | COLL | the complete path of a locale | ||
PositiveSign | STRING | get the plus sign | ||
PositiveSignMA | * | Plus sign input/output | ||
PosSignPrecedes | INTEGER | Shows with the help of a truth value whether the plus sign comes before the number. If not, it is behind the number. | ||
PosSignPrecedesMA | * | the position of the plus sign input/output | ||
PosSpaceSeparation | INTEGER | Shows with the help of a truth value whether there should be a space between the sign and the number | ||
PosSpaceSeparationMA | * | a space between the sign and the number Input/Output | ||
RawHolidays | COLL | delivers all holidays | ||
RemoveHoliday | CX_HOLIDAY | A public holiday is deleted | ||
SortedHolidays | INTEGER, INTEGER | COLL | Returns all holidays in the following order | |
SpecialNameOfDay | (OBJECT, INTEGER) | STRING | get a specific multilingual (holiday) name of the day of a date | |
SpecialMLNameOfDay | (OBJECT, INTEGER) | MLSTRING | get a specific multilingual (holiday) name of the day of a date | |
string | INTEGER | CX_STRING | Returns the string representation of the object | |
SummerWinterChangeDate | INTEGER | provides the month in which the changeover from summer to winter time takes place | ||
SummerWinterChangeDayDescription | INTEGER | provides the day of the week when the changeover from summer to winter time takes place | ||
SummerWinterChangeTime | STRING | provides the changeover time from summer to winter time | ||
ThousandsSeparator | STRING | get the separator for thousands of characters | ||
ThousandsSeparatorMA | * | Separator for thousands of characters Input/output | ||
TimeFormat | INTEGER | get the time format | ||
TimeFormatMA | * | Time format input/output | ||
TimeSeparator | STRING | get the separator for a time specification | ||
TimeSeparatorMA | * | Separator for a time input/output | ||
TimeZone | INTEGER | returns the start time zone of the country in minute deviation from the CET | ||
TimeZoneMA | * | Start time zone of the country in minute deviation from the CET input/output | ||
UnknownPartOfDate | STRING | returns the character for unknown parts of an incomplete date | ||
UnknownPartOfDateMA | * | Character for unknown components of an incomplete date Input/output | ||
WinterSummerChangeDate | INTEGER | provides the month in which the changeover from winter to summer time takes place | ||
WinterSummerChangeDayDescription | INTEGER | provides the day of the week when the changeover from winter to summer time takes place | ||
WinterSummerChangeTime | STRING | provides the changeover time from winter to summer time | ||
WorkingDays | INTEGER | provides the working days of the country | ||
WorkingDaysMA | * | Working days of the country Input/output |
Data field | Type | Reference class | I* | Brief description |
---|---|---|---|---|
countryCode | CHAR | Country code of the superordinate country | ||
name | MULTIPLE_STRING | Name of the federal state | ||
sublocales | COLL | CX_CLASS | subordinate locale | |
pos1 | SHORT | running no. of this weekday in month | ||
day1 | SHORT | Day of the week when the changeover from winter to summer time takes place | ||
languagePos | CHAR | System number of the regional language | ||
workingDays | CHAR | working days of the federal state: 0 = undefined, 1 = Monday, 2 = Tuesday, 4 = Wednesday, 8 = Thursday, 16 = Friday, 32 = Saturday, 64 = Sunday | ||
pos2 | SHORT | running no. of this weekday in month | ||
day2 | SHORT | Day of the week when the changeover from summer to winter time takes place | ||
gran1 | SHORT | Reference area | ||
language | MULTIPLE_STRING | Name of the language within the region as multiple string | ||
freq1 | SHORT | Frequency | ||
timeZone | SHORT | Time zone in which the region is located | ||
gran2 | SHORT | Reference area | ||
freq2 | SHORT | Frequency | ||
date1 | INTEGER | Month in which the changeover from winter to summer time takes place | ||
sysLocale | STRING | Locale of the C-Standard Lib. | ||
upperLocale | POINTER | CX_CLASS | superordinate locale | |
changeTime1 | STRING | Changeover time from winter to summer time | ||
date2 | INTEGER | Month in which the changeover from summer to winter time takes place | ||
stateCode | CHAR | State code | ||
changeTime2 | STRING | Changeover time from summer to winter time | ||
endTimeZone | SHORT | End time zone of the country in minutes off the CET |
Module | Brief description |
---|---|
locales.mod | Location-specific data Editing module |
setlocal.mod | Location selection basic module |
wrldclck.mod | World clock basic module |