inc/FLclLocale.h

   1 //
   2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   3 //
   4 // Licensed under the Apache License, Version 2.0 (the License);
   5 // you may not use this file except in compliance with the License.
   6 // You may obtain a copy of the License at
   7 //
   8 //     http://www.apache.org/licenses/LICENSE-2.0
   9 //
  10 // Unless required by applicable law or agreed to in writing, software
  11 // distributed under the License is distributed on an "AS IS" BASIS,
  12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 // See the License for the specific language governing permissions and
  14 // limitations under the License.
  15 //
  16
  17 /**
  18  * @file        FLclLocale.h
  19  * @brief       This is the header file for the %Locale class.
  20  *
  21  * This header file contains the declarations of the %Locale class.
  22  */
  23 #ifndef _FLCL_LOCALE_H_
  24 #define _FLCL_LOCALE_H_
  25
  26 #include <FBaseObject.h>
  27 #include <FBaseString.h>
  28
  29 namespace Tizen { namespace Locales
  30 {
  31
  32 /**
  33  * @enum        CalendarType
  34  *
  35  * Defines the calendar type.
  36  *
  37  * @since               2.0
  38  */
  39 enum CalendarType
  40 {
  41         CALENDAR_GREGORIAN,             /**< The calendar type: Gregorian calendar (default) */
  42         CALENDAR_BUDDHIST,              /**< The calendar type: Buddhist calendar (same as Gregorian except for the year)  */
  43         CALENDAR_CHINESE,               /**< The calendar type: Traditional Chinese calendar  */
  44         CALENDAR_COPTIC,                /**< The calendar type: Coptic calendar  */
  45         CALENDAR_ETHIOPIC_AMETE_ALEM,   /**< The calendar type: Ethiopic calendar, Amete Alem (epoch approx. 5493 B.C.E.)  */
  46         CALENDAR_ETHIOPIC,              /**< The calendar type: Ethiopic calendar, Amete Mihret (epoch approx. 8 C.E.)  */
  47         CALENDAR_HEBREW,                /**< The calendar type: TraditionalHebrew calendar  */
  48         CALENDAR_INDIAN,                /**< The calendar type: Indian calendar  */
  49         CALENDAR_ISLAMIC,               /**< The calendar type: Astronomical Arabic calendar  */
  50         CALENDAR_ISLAMIC_CIVIL,         /**< The calendar type: Civil (algorithmic) Arabic calendar  */
  51         CALENDAR_JAPANESE,              /**< The calendar type: Japanese Imperial calendar (same as Gregorian except for the year, with one era for each Emperor)  */
  52         CALENDAR_PERSIAN,               /**< The calendar type: Persian calendar  */
  53         CALENDAR_ROC,                   /**< The calendar type: Republic of China calendar  */
  54         CALENDAR_TAIWAN,                /**< The calendar type: Taiwan calendar  */
  55         CALENDAR_ISO8601,               /**< The calendar type: ISO8601 calendar  */
  56         CALENDAR_COUNT,
  57 };
  58
  59 /**
  60  * @enum        LanguageCode
  61  *
  62  * Defines the ISO 639-2 language code. @n
  63  * This enum represents the ISO 639-2 language codes. @n
  64  * The specific LanguageCode represents the language code with the locale's ISO-15924 abbreviation script code. @n
  65  * The supported ISO-15924 script codes are Arabic, Cyrillic, Latin, Hans, Hant and Gurmukhi.
  66  *
  67  * @since               2.0
  68  */
  69 enum LanguageCode
  70 {
  71         LANGUAGE_INVALID = -1, /**< An invalid language code */
  72         LANGUAGE_AAR, /**< Afar */
  73         LANGUAGE_ABK, /**< Abkhazian */
  74         LANGUAGE_ACE, /**< Achinese */
  75         LANGUAGE_ACH, /**< Acoli */
  76         LANGUAGE_ADA, /**< Adangme */
  77         LANGUAGE_ADY, /**< Adyghe; Adygei */
  78         LANGUAGE_AFA, /**< Afro-Asiatic languages */
  79         LANGUAGE_AFH, /**< Afrihili */
  80         LANGUAGE_AFR, /**< Afrikaans */
  81         LANGUAGE_AIN, /**< Ainu */
  82         LANGUAGE_AKA, /**< Akan */
  83         LANGUAGE_AKK, /**< Akkadian */
  84         LANGUAGE_SQI, /**< Albanian */
  85         LANGUAGE_ALE, /**< Aleut */
  86         LANGUAGE_ALG, /**< Algonquian languages */
  87         LANGUAGE_ALT, /**< Southern Altai */
  88         LANGUAGE_AMH, /**< Amharic */
  89         LANGUAGE_ANG, /**< English, Old (ca.450-1100) */
  90         LANGUAGE_ANP, /**< Angika */
  91         LANGUAGE_APA, /**< Apache languages */
  92         LANGUAGE_ARA, /**< Arabic */
  93         LANGUAGE_ARC, /**< Official Aramaic (700-300 BCE); Imperial Aramaic (700-300 BCE) */
  94         LANGUAGE_ARG, /**< Aragonese */
  95         LANGUAGE_HYE, /**< Armenian */
  96         LANGUAGE_ARN, /**< Mapudungun; Mapuche */
  97         LANGUAGE_ARP, /**< Arapaho */
  98         LANGUAGE_ART, /**< Artificial languages */
  99         LANGUAGE_ARW, /**< Arawak */
 100         LANGUAGE_ASM, /**< Assamese */
 101         LANGUAGE_AST, /**< Asturian; Bable; Leonese; Asturleonese */
 102         LANGUAGE_ATH, /**< Athapascan languages */
 103         LANGUAGE_AUS, /**< Australian languages */
 104         LANGUAGE_AVA, /**< Avaric */
 105         LANGUAGE_AVE, /**< Avestan */
 106         LANGUAGE_AWA, /**< Awadhi */
 107         LANGUAGE_AYM, /**< Aymara */
 108         LANGUAGE_AZE, /**< Azerbaijani */
 109         LANGUAGE_AZE_ARAB, /**< Azerbaijani (Arabic) */
 110         LANGUAGE_AZE_CYRL, /**< Azerbaijani (Cyrillic) */
 111         LANGUAGE_AZE_LATIN, /**< Azerbaijani (Latin) */
 112         LANGUAGE_BAD, /**< Banda languages */
 113         LANGUAGE_BAI, /**< Bamileke languages */
 114         LANGUAGE_BAK, /**< Bashkir */
 115         LANGUAGE_BAL, /**< Baluchi */
 116         LANGUAGE_BAM, /**< Bambara */
 117         LANGUAGE_BAN, /**< Balinese */
 118         LANGUAGE_EUS, /**< Basque */
 119         LANGUAGE_BAS, /**< Basa */
 120         LANGUAGE_BAT, /**< Baltic languages */
 121         LANGUAGE_BEJ, /**< Beja; Bedawiyet */
 122         LANGUAGE_BEL, /**< Belarusian */
 123         LANGUAGE_BEM, /**< Bemba */
 124         LANGUAGE_BEN, /**< Bengali */
 125         LANGUAGE_BER, /**< Berber languages */
 126         LANGUAGE_BHO, /**< Bhojpuri */
 127         LANGUAGE_BIH, /**< Bihari */
 128         LANGUAGE_BIK, /**< Bikol */
 129         LANGUAGE_BIN, /**< Bini; Edo */
 130         LANGUAGE_BIS, /**< Bislama */
 131         LANGUAGE_BLA, /**< Siksika */
 132         LANGUAGE_BNT, /**< Bantu (Other) */
 133         LANGUAGE_BOS, /**< Bosnian */
 134         LANGUAGE_BRA, /**< Braj */
 135         LANGUAGE_BRE, /**< Breton */
 136         LANGUAGE_BTK, /**< Batak languages */
 137         LANGUAGE_BUA, /**< Buriat */
 138         LANGUAGE_BUG, /**< Buginese */
 139         LANGUAGE_BUL, /**< Bulgarian */
 140         LANGUAGE_MYA, /**< Burmese */
 141         LANGUAGE_BYN, /**< Blin; Bilin */
 142         LANGUAGE_CAD, /**< Caddo */
 143         LANGUAGE_CAI, /**< Central American Indian languages */
 144         LANGUAGE_CAR, /**< Galibi Carib */
 145         LANGUAGE_CAT, /**< Catalan; Valencian */
 146         LANGUAGE_CAU, /**< Caucasian languages */
 147         LANGUAGE_CEB, /**< Cebuano */
 148         LANGUAGE_CEL, /**< Celtic languages */
 149         LANGUAGE_CHA, /**< Chamorro */
 150         LANGUAGE_CHB, /**< Chibcha */
 151         LANGUAGE_CHE, /**< Chechen */
 152         LANGUAGE_CHG, /**< Chagatai */
 153         LANGUAGE_ZHO, /**< Chinese */
 154         LANGUAGE_ZHO_HANS, /**< Chinese (Simplified)  */
 155         LANGUAGE_ZHO_HANT, /**< Chinese (Traditional)  */
 156         LANGUAGE_CHK, /**< Chuukese */
 157         LANGUAGE_CHM, /**< Mari */
 158         LANGUAGE_CHN, /**< Chinook jargon */
 159         LANGUAGE_CHO, /**< Choctaw */
 160         LANGUAGE_CHP, /**< Chipewyan; Dene Suline */
 161         LANGUAGE_CHR, /**< Cherokee */
 162         LANGUAGE_CHU, /**< Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic */
 163         LANGUAGE_CHV, /**< Chuvash */
 164         LANGUAGE_CHY, /**< Cheyenne */
 165         LANGUAGE_CMC, /**< Chamic languages */
 166         LANGUAGE_COP, /**< Coptic */
 167         LANGUAGE_COR, /**< Cornish */
 168         LANGUAGE_COS, /**< Corsican */
 169         LANGUAGE_CPE, /**< Creoles and pidgins, English based */
 170         LANGUAGE_CPF, /**< Creoles and pidgins, French-based  */
 171         LANGUAGE_CPP, /**< Creoles and pidgins, Portuguese-based  */
 172         LANGUAGE_CRE, /**< Cree */
 173         LANGUAGE_CRH, /**< Crimean Tatar; Crimean Turkish */
 174         LANGUAGE_CRP, /**< Creoles and pidgins  */
 175         LANGUAGE_CSB, /**< Kashubian */
 176         LANGUAGE_CUS, /**< Cushitic languages */
 177         LANGUAGE_CES, /**< Czech */
 178         LANGUAGE_DAK, /**< Dakota */
 179         LANGUAGE_DAN, /**< Danish */
 180         LANGUAGE_DAR, /**< Dargwa */
 181         LANGUAGE_DAY, /**< Land Dayak languages */
 182         LANGUAGE_DEL, /**< Delaware */
 183         LANGUAGE_DEN, /**< Slave (Athapascan) */
 184         LANGUAGE_DGR, /**< Dogrib */
 185         LANGUAGE_DIN, /**< Dinka */
 186         LANGUAGE_DIV, /**< Divehi; Dhivehi; Maldivian */
 187         LANGUAGE_DOI, /**< Dogri */
 188         LANGUAGE_DRA, /**< Dravidian languages */
 189         LANGUAGE_DSB, /**< Lower Sorbian */
 190         LANGUAGE_DUA, /**< Duala */
 191         LANGUAGE_DUM, /**< Dutch, Middle (ca.1050-1350) */
 192         LANGUAGE_NLD, /**< Dutch; Flemish */
 193         LANGUAGE_DYU, /**< Dyula */
 194         LANGUAGE_DZO, /**< Dzongkha */
 195         LANGUAGE_EFI, /**< Efik */
 196         LANGUAGE_EGY, /**< Egyptian (Ancient) */
 197         LANGUAGE_EKA, /**< Ekajuk */
 198         LANGUAGE_ELX, /**< Elamite */
 199         LANGUAGE_ENG, /**< English */
 200         LANGUAGE_ENM, /**< English, Middle (1100-1500) */
 201         LANGUAGE_EPO, /**< Esperanto */
 202         LANGUAGE_EST, /**< Estonian */
 203         LANGUAGE_EWE, /**< Ewe */
 204         LANGUAGE_EWO, /**< Ewondo */
 205         LANGUAGE_FAN, /**< Fang */
 206         LANGUAGE_FAO, /**< Faroese */
 207         LANGUAGE_FAT, /**< Fanti */
 208         LANGUAGE_FIJ, /**< Fijian */
 209         LANGUAGE_FIL, /**< Filipino; Pilipino */
 210         LANGUAGE_FIN, /**< Finnish */
 211         LANGUAGE_FIU, /**< Finno-Ugrian languages */
 212         LANGUAGE_FON, /**< Fon */
 213         LANGUAGE_FRA, /**< French */
 214         LANGUAGE_FRM, /**< French, Middle (ca.1400-1600) */
 215         LANGUAGE_FRO, /**< French, Old (842-ca.1400) */
 216         LANGUAGE_FRR, /**< Northern Frisian */
 217         LANGUAGE_FRS, /**< Eastern Frisian */
 218         LANGUAGE_FRY, /**< Western Frisian */
 219         LANGUAGE_FUL, /**< Fulah */
 220         LANGUAGE_FUR, /**< Friulian */
 221         LANGUAGE_GAA, /**< Ga */
 222         LANGUAGE_GAY, /**< Gayo */
 223         LANGUAGE_GBA, /**< Gbaya */
 224         LANGUAGE_GEM, /**< Germanic languages */
 225         LANGUAGE_KAT, /**< Georgian */
 226         LANGUAGE_DEU, /**< German */
 227         LANGUAGE_GEZ, /**< Geez */
 228         LANGUAGE_GIL, /**< Gilbertese */
 229         LANGUAGE_GLA, /**< Gaelic; Scottish Gaelic */
 230         LANGUAGE_GLE, /**< Irish */
 231         LANGUAGE_GLG, /**< Galician */
 232         LANGUAGE_GLV, /**< Manx */
 233         LANGUAGE_GMH, /**< German, Middle High (ca.1050-1500) */
 234         LANGUAGE_GOH, /**< German, Old High (ca.750-1050) */
 235         LANGUAGE_GON, /**< Gondi */
 236         LANGUAGE_GOR, /**< Gorontalo */
 237         LANGUAGE_GOT, /**< Gothic */
 238         LANGUAGE_GRB, /**< Grebo */
 239         LANGUAGE_GRC, /**< Greek, Ancient (to 1453) */
 240         LANGUAGE_ELL, /**< Greek, Modern (1453-) */
 241         LANGUAGE_GRN, /**< Guarani */
 242         LANGUAGE_GSW, /**< Swiss German; Alemannic; Alsatian */
 243         LANGUAGE_GUJ, /**< Gujarati */
 244         LANGUAGE_GWI, /**< Gwich'in */
 245         LANGUAGE_HAI, /**< Haida */
 246         LANGUAGE_HAT, /**< Haitian; Haitian Creole */
 247         LANGUAGE_HAU, /**< Hausa */
 248         LANGUAGE_HAU_LATIN, /**< Hausa (Latin) */
 249         LANGUAGE_HAW, /**< Hawaiian */
 250         LANGUAGE_HEB, /**< Hebrew */
 251         LANGUAGE_HER, /**< Herero */
 252         LANGUAGE_HIL, /**< Hiligaynon */
 253         LANGUAGE_HIM, /**< Himachali */
 254         LANGUAGE_HIN, /**< Hindi */
 255         LANGUAGE_HIT, /**< Hittite */
 256         LANGUAGE_HMN, /**< Hmong */
 257         LANGUAGE_HMO, /**< Hiri Motu */
 258         LANGUAGE_HRV, /**< Croatian */
 259         LANGUAGE_HSB, /**< Upper Sorbian */
 260         LANGUAGE_HUN, /**< Hungarian */
 261         LANGUAGE_HUP, /**< Hupa */
 262         LANGUAGE_IBA, /**< Iban */
 263         LANGUAGE_IBO, /**< Igbo */
 264         LANGUAGE_ISL, /**< Icelandic */
 265         LANGUAGE_IDO, /**< Ido */
 266         LANGUAGE_III, /**< Sichuan Yi; Nuosu */
 267         LANGUAGE_IJO, /**< Ijo languages */
 268         LANGUAGE_IKU, /**< Inuktitut */
 269         LANGUAGE_ILE, /**< Interlingue; Occidental */
 270         LANGUAGE_ILO, /**< Iloko */
 271         LANGUAGE_INA, /**< Interlingua (International Auxiliary Language Association) */
 272         LANGUAGE_INC, /**< Indic languages */
 273         LANGUAGE_IND, /**< Indonesian */
 274         LANGUAGE_INE, /**< Indo-European languages */
 275         LANGUAGE_INH, /**< Ingush */
 276         LANGUAGE_IPK, /**< Inupiaq */
 277         LANGUAGE_IRA, /**< Iranian languages */
 278         LANGUAGE_IRO, /**< Iroquoian languages */
 279         LANGUAGE_ITA, /**< Italian */
 280         LANGUAGE_JAV, /**< Javanese */
 281         LANGUAGE_JBO, /**< Lojban */
 282         LANGUAGE_JPN, /**< Japanese */
 283         LANGUAGE_JPR, /**< Judeo-Persian */
 284         LANGUAGE_JRB, /**< Judeo-Arabic */
 285         LANGUAGE_KAA, /**< Kara-Kalpak */
 286         LANGUAGE_KAB, /**< Kabyle */
 287         LANGUAGE_KAC, /**< Kachin; Jingpho */
 288         LANGUAGE_KAL, /**< Kalaallisut; Greenlandic */
 289         LANGUAGE_KAM, /**< Kamba */
 290         LANGUAGE_KAN, /**< Kannada */
 291         LANGUAGE_KAR, /**< Karen languages */
 292         LANGUAGE_KAS, /**< Kashmiri */
 293         LANGUAGE_KAU, /**< Kanuri */
 294         LANGUAGE_KAW, /**< Kawi */
 295         LANGUAGE_KAZ, /**< Kazakh */
 296         LANGUAGE_KAZ_CYRL, /**< Kazakh (Cyrillic)  */
 297         LANGUAGE_KBD, /**< Kabardian */
 298         LANGUAGE_KHA, /**< Khasi */
 299         LANGUAGE_KHI, /**< Khoisan languages */
 300         LANGUAGE_KHM, /**< Central Khmer */
 301         LANGUAGE_KHO, /**< Khotanese; Sakan */
 302         LANGUAGE_KIK, /**< Kikuyu; Gikuyu */
 303         LANGUAGE_KIN, /**< Kinyarwanda */
 304         LANGUAGE_KIR, /**< Kirghiz; Kyrgyz */
 305         LANGUAGE_KMB, /**< Kimbundu */
 306         LANGUAGE_KOK, /**< Konkani */
 307         LANGUAGE_KOM, /**< Komi */
 308         LANGUAGE_KON, /**< Kongo */
 309         LANGUAGE_KOR, /**< Korean */
 310         LANGUAGE_KOS, /**< Kosraean */
 311         LANGUAGE_KPE, /**< Kpelle */
 312         LANGUAGE_KRC, /**< Karachay-Balkar */
 313         LANGUAGE_KRL, /**< Karelian */
 314         LANGUAGE_KRO, /**< Kru languages */
 315         LANGUAGE_KRU, /**< Kurukh */
 316         LANGUAGE_KUA, /**< Kuanyama; Kwanyama */
 317         LANGUAGE_KUM, /**< Kumyk */
 318         LANGUAGE_KUR, /**< Kurdish */
 319         LANGUAGE_KUT, /**< Kutenai */
 320         LANGUAGE_LAD, /**< Ladino */
 321         LANGUAGE_LAH, /**< Lahnda */
 322         LANGUAGE_LAM, /**< Lamba */
 323         LANGUAGE_LAO, /**< Lao */
 324         LANGUAGE_LAT, /**< Latin */
 325         LANGUAGE_LAV, /**< Latvian */
 326         LANGUAGE_LEZ, /**< Lezghian */
 327         LANGUAGE_LIM, /**< Limburgan; Limburger; Limburgish */
 328         LANGUAGE_LIN, /**< Lingala */
 329         LANGUAGE_LIT, /**< Lithuanian */
 330         LANGUAGE_LOL, /**< Mongo */
 331         LANGUAGE_LOZ, /**< Lozi */
 332         LANGUAGE_LTZ, /**< Luxembourgish; Letzeburgesch */
 333         LANGUAGE_LUA, /**< Luba-Lulua */
 334         LANGUAGE_LUB, /**< Luba-Katanga */
 335         LANGUAGE_LUG, /**< Ganda */
 336         LANGUAGE_LUI, /**< Luiseno */
 337         LANGUAGE_LUN, /**< Lunda */
 338         LANGUAGE_LUO, /**< Luo (Kenya and Tanzania) */
 339         LANGUAGE_LUS, /**< Lushai */
 340         LANGUAGE_MKD, /**< Macedonian */
 341         LANGUAGE_MAD, /**< Madurese */
 342         LANGUAGE_MAG, /**< Magahi */
 343         LANGUAGE_MAH, /**< Marshallese */
 344         LANGUAGE_MAI, /**< Maithili */
 345         LANGUAGE_MAK, /**< Makasar */
 346         LANGUAGE_MAL, /**< Malayalam */
 347         LANGUAGE_MAN, /**< Mandingo */
 348         LANGUAGE_MRI, /**< Maori */
 349         LANGUAGE_MAP, /**< Austronesian languages */
 350         LANGUAGE_MAR, /**< Marathi */
 351         LANGUAGE_MAS, /**< Masai */
 352         LANGUAGE_MSA, /**< Malay */
 353         LANGUAGE_MDF, /**< Moksha */
 354         LANGUAGE_MDR, /**< Mandar */
 355         LANGUAGE_MEN, /**< Mende */
 356         LANGUAGE_MGA, /**< Irish, Middle (900-1200) */
 357         LANGUAGE_MIC, /**< Mi'kmaq; Micmac */
 358         LANGUAGE_MIN, /**< Minangkabau */
 359         LANGUAGE_MIS, /**< Uncoded languages */
 360         LANGUAGE_MKH, /**< Mon-Khmer languages */
 361         LANGUAGE_MLG, /**< Malagasy */
 362         LANGUAGE_MLT, /**< Maltese */
 363         LANGUAGE_MNC, /**< Manchu */
 364         LANGUAGE_MNI, /**< Manipuri */
 365         LANGUAGE_MNO, /**< Manobo languages */
 366         LANGUAGE_MOH, /**< Mohawk */
 367         LANGUAGE_MON, /**< Mongolian */
 368         LANGUAGE_MOS, /**< Mossi */
 369         LANGUAGE_MUL, /**< Multiple languages */
 370         LANGUAGE_MUN, /**< Munda languages */
 371         LANGUAGE_MUS, /**< Creek */
 372         LANGUAGE_MWL, /**< Mirandese */
 373         LANGUAGE_MWR, /**< Marwari */
 374         LANGUAGE_MYN, /**< Mayan languages */
 375         LANGUAGE_MYV, /**< Erzya */
 376         LANGUAGE_NAH, /**< Nahuatl languages */
 377         LANGUAGE_NAI, /**< North American Indian languages */
 378         LANGUAGE_NAP, /**< Neapolitan */
 379         LANGUAGE_NAU, /**< Nauru */
 380         LANGUAGE_NAV, /**< Navajo; Navaho */
 381         LANGUAGE_NBL, /**< Ndebele, South; South Ndebele */
 382         LANGUAGE_NDE, /**< Ndebele, North; North Ndebele */
 383         LANGUAGE_NDO, /**< Ndonga */
 384         LANGUAGE_NDS, /**< Low German; Low Saxon; German, Low; Saxon, Low */
 385         LANGUAGE_NEP, /**< Nepali */
 386         LANGUAGE_NEW, /**< Nepal Bhasa; Newari */
 387         LANGUAGE_NIA, /**< Nias */
 388         LANGUAGE_NIC, /**< Niger-Kordofanian languages */
 389         LANGUAGE_NIU, /**< Niuean */
 390         LANGUAGE_NNO, /**< Norwegian Nynorsk; Nynorsk, Norwegian */
 391         LANGUAGE_NOB, /**< Bokmal, Norwegian; Norwegian Bokmal */
 392         LANGUAGE_NOG, /**< Nogai */
 393         LANGUAGE_NON, /**< Norse, Old */
 394         LANGUAGE_NOR, /**< Norwegian */
 395         LANGUAGE_NQO, /**< N'Ko */
 396         LANGUAGE_NSO, /**< Pedi; Sepedi; Northern Sotho */
 397         LANGUAGE_NUB, /**< Nubian languages */
 398         LANGUAGE_NWC, /**< Classical Newari; Old Newari; Classical Nepal Bhasa */
 399         LANGUAGE_NYA, /**< Chichewa; Chewa; Nyanja */
 400         LANGUAGE_NYM, /**< Nyamwezi */
 401         LANGUAGE_NYN, /**< Nyankole */
 402         LANGUAGE_NYO, /**< Nyoro */
 403         LANGUAGE_NZI, /**< Nzima */
 404         LANGUAGE_OCI, /**< Occitan (post 1500); Provencal */
 405         LANGUAGE_OJI, /**< Ojibwa */
 406         LANGUAGE_ORI, /**< Oriya */
 407         LANGUAGE_ORM, /**< Oromo */
 408         LANGUAGE_OSA, /**< Osage */
 409         LANGUAGE_OSS, /**< Ossetian; Ossetic */
 410         LANGUAGE_OTA, /**< Turkish, Ottoman (1500-1928) */
 411         LANGUAGE_OTO, /**< Otomian languages */
 412         LANGUAGE_PAA, /**< Papuan languages */
 413         LANGUAGE_PAG, /**< Pangasinan */
 414         LANGUAGE_PAL, /**< Pahlavi */
 415         LANGUAGE_PAM, /**< Pampanga; Kapampangan */
 416         LANGUAGE_PAN, /**< Panjabi; Punjabi */
 417         LANGUAGE_PAN_ARAB, /**< Panjabi; Punjabi (Arabic)  */
 418         LANGUAGE_PAN_GURU, /**< Panjabi; Punjabi (Gurmukhi)  */
 419         LANGUAGE_PAP, /**< Papiamento */
 420         LANGUAGE_PAU, /**< Palauan */
 421         LANGUAGE_PEO, /**< Persian, Old (ca.600-400 B.C.) */
 422         LANGUAGE_FAS, /**< Persian */
 423         LANGUAGE_PHI, /**< Philippine languages */
 424         LANGUAGE_PHN, /**< Phoenician */
 425         LANGUAGE_PLI, /**< Pali */
 426         LANGUAGE_POL, /**< Polish */
 427         LANGUAGE_PON, /**< Pohnpeian */
 428         LANGUAGE_POR, /**< Portuguese */
 429         LANGUAGE_PRA, /**< Prakrit languages */
 430         LANGUAGE_PRO, /**< Provencal, Old (to 1500) */
 431         LANGUAGE_PUS, /**< Pushto; Pashto */
 432         LANGUAGE_QAA_QTZ, /**< Reserved for local use */
 433         LANGUAGE_QUE, /**< Quechua */
 434         LANGUAGE_RAJ, /**< Rajasthani */
 435         LANGUAGE_RAP, /**< Rapanui */
 436         LANGUAGE_RAR, /**< Rarotongan; Cook Islands Maori */
 437         LANGUAGE_ROA, /**< Romance languages */
 438         LANGUAGE_ROH, /**< Romansh */
 439         LANGUAGE_ROM, /**< Romany */
 440         LANGUAGE_RON, /**< Romanian; Moldavian; Moldovan */
 441         LANGUAGE_RUN, /**< Rundi */
 442         LANGUAGE_RUP, /**< Aromanian; Arumanian; Macedo-Romanian */
 443         LANGUAGE_RUS, /**< Russian */
 444         LANGUAGE_SAD, /**< Sandawe */
 445         LANGUAGE_SAG, /**< Sango */
 446         LANGUAGE_SAH, /**< Yakut */
 447         LANGUAGE_SAI, /**< South American Indian (Other) */
 448         LANGUAGE_SAL, /**< Salishan languages */
 449         LANGUAGE_SAM, /**< Samaritan Aramaic */
 450         LANGUAGE_SAN, /**< Sanskrit */
 451         LANGUAGE_SAS, /**< Sasak */
 452         LANGUAGE_SAT, /**< Santali */
 453         LANGUAGE_SCN, /**< Sicilian */
 454         LANGUAGE_SCO, /**< Scots */
 455         LANGUAGE_SEL, /**< Selkup */
 456         LANGUAGE_SEM, /**< Semitic languages */
 457         LANGUAGE_SGA, /**< Irish, Old (to 900) */
 458         LANGUAGE_SGN, /**< Sign Languages */
 459         LANGUAGE_SHN, /**< Shan */
 460         LANGUAGE_SID, /**< Sidamo */
 461         LANGUAGE_SIN, /**< Sinhala; Sinhalese */
 462         LANGUAGE_SIO, /**< Siouan languages */
 463         LANGUAGE_SIT, /**< Sino-Tibetan languages */
 464         LANGUAGE_SLA, /**< Slavic languages */
 465         LANGUAGE_SLK, /**< Slovak */
 466         LANGUAGE_SLV, /**< Slovenian */
 467         LANGUAGE_SMA, /**< Southern Sami */
 468         LANGUAGE_SME, /**< Northern Sami */
 469         LANGUAGE_SMI, /**< Sami languages */
 470         LANGUAGE_SMJ, /**< Lule Sami */
 471         LANGUAGE_SMN, /**< Inari Sami */
 472         LANGUAGE_SMO, /**< Samoan */
 473         LANGUAGE_SMS, /**< Skolt Sami */
 474         LANGUAGE_SNA, /**< Shona */
 475         LANGUAGE_SND, /**< Sindhi */
 476         LANGUAGE_SNK, /**< Soninke */
 477         LANGUAGE_SOG, /**< Sogdian */
 478         LANGUAGE_SOM, /**< Somali */
 479         LANGUAGE_SON, /**< Songhai languages */
 480         LANGUAGE_SOT, /**< Sotho, Southern */
 481         LANGUAGE_SPA, /**< Spanish; Castilian */
 482         LANGUAGE_SRD, /**< Sardinian */
 483         LANGUAGE_SRN, /**< Sranan Tongo */
 484         LANGUAGE_SRP, /**< Serbian */
 485         LANGUAGE_SRP_CYRL, /**< Serbian (Cyrillic)  */
 486         LANGUAGE_SRP_LATIN, /**< Serbian (Latin)  */
 487         LANGUAGE_SRR, /**< Serer */
 488         LANGUAGE_SSA, /**< Nilo-Saharan languages */
 489         LANGUAGE_SSW, /**< Swati */
 490         LANGUAGE_SUK, /**< Sukuma */
 491         LANGUAGE_SUN, /**< Sundanese */
 492         LANGUAGE_SUS, /**< Susu */
 493         LANGUAGE_SUX, /**< Sumerian */
 494         LANGUAGE_SWA, /**< Swahili */
 495         LANGUAGE_SWE, /**< Swedish */
 496         LANGUAGE_SYC, /**< Classical Syriac */
 497         LANGUAGE_SYR, /**< Syriac */
 498         LANGUAGE_TAH, /**< Tahitian */
 499         LANGUAGE_TAI, /**< Tai languages */
 500         LANGUAGE_TAM, /**< Tamil */
 501         LANGUAGE_TAT, /**< Tatar */
 502         LANGUAGE_TEL, /**< Telugu */
 503         LANGUAGE_TEM, /**< Timne */
 504         LANGUAGE_TER, /**< Tereno */
 505         LANGUAGE_TET, /**< Tetum */
 506         LANGUAGE_TGK, /**< Tajik */
 507         LANGUAGE_TGL, /**< Tagalog */
 508         LANGUAGE_THA, /**< Thai */
 509         LANGUAGE_BOD, /**< Tibetan */
 510         LANGUAGE_TIG, /**< Tigre */
 511         LANGUAGE_TIR, /**< Tigrinya */
 512         LANGUAGE_TIV, /**< Tiv */
 513         LANGUAGE_TKL, /**< Tokelau */
 514         LANGUAGE_TLH, /**< Klingon; tlhIngan-Hol */
 515         LANGUAGE_TLI, /**< Tlingit */
 516         LANGUAGE_TMH, /**< Tamashek */
 517         LANGUAGE_TOG, /**< Tonga (Nyasa) */
 518         LANGUAGE_TON, /**< Tonga (Tonga Islands) */
 519         LANGUAGE_TPI, /**< Tok Pisin */
 520         LANGUAGE_TSI, /**< Tsimshian */
 521         LANGUAGE_TSN, /**< Tswana */
 522         LANGUAGE_TSO, /**< Tsonga */
 523         LANGUAGE_TUK, /**< Turkmen */
 524         LANGUAGE_TUK_CYRL, /**< Turkmen (Cyrillic)  */
 525         LANGUAGE_TUK_LATIN, /**< Turkmen (Latin)  */
 526         LANGUAGE_TUM, /**< Tumbuka */
 527         LANGUAGE_TUP, /**< Tupi languages */
 528         LANGUAGE_TUR, /**< Turkish */
 529         LANGUAGE_TUT, /**< Altaic languages */
 530         LANGUAGE_TVL, /**< Tuvalu */
 531         LANGUAGE_TWI, /**< Twi */
 532         LANGUAGE_TYV, /**< Tuvinian */
 533         LANGUAGE_UDM, /**< Udmurt */
 534         LANGUAGE_UGA, /**< Ugaritic */
 535         LANGUAGE_UIG, /**< Uighur; Uyghur */
 536         LANGUAGE_UKR, /**< Ukrainian */
 537         LANGUAGE_UMB, /**< Umbundu */
 538         LANGUAGE_UND, /**< Undetermined */
 539         LANGUAGE_URD, /**< Urdu */
 540         LANGUAGE_UZB, /**< Uzbek */
 541         LANGUAGE_UZB_ARAB, /**< Uzbek (Arabic) */
 542         LANGUAGE_UZB_CYRL, /**< Uzbek (Cyrillic)  */
 543         LANGUAGE_UZB_LATIN, /**< Uzbek (Latin)  */
 544         LANGUAGE_VAI, /**< Vai */
 545         LANGUAGE_VEN, /**< Venda */
 546         LANGUAGE_VIE, /**< Vietnamese */
 547         LANGUAGE_VLS, /**< Vlaams; Flemish"  */
 548         LANGUAGE_VOL, /**< Volapuk */
 549         LANGUAGE_VOT, /**< Votic */
 550         LANGUAGE_WAK, /**< Wakashan languages */
 551         LANGUAGE_WAL, /**< Walamo */
 552         LANGUAGE_WAR, /**< Waray */
 553         LANGUAGE_WAS, /**< Washo */
 554         LANGUAGE_CYM, /**< Welsh */
 555         LANGUAGE_WEN, /**< Sorbian languages */
 556         LANGUAGE_WLN, /**< Walloon */
 557         LANGUAGE_WOL, /**< Wolof */
 558         LANGUAGE_XAL, /**< Kalmyk; Oirat */
 559         LANGUAGE_XHO, /**< Xhosa */
 560         LANGUAGE_YAO, /**< Yao */
 561         LANGUAGE_YAP, /**< Yapese */
 562         LANGUAGE_YID, /**< Yiddish */
 563         LANGUAGE_YOR, /**< Yoruba */
 564         LANGUAGE_YPK, /**< Yupik languages */
 565         LANGUAGE_ZAP, /**< Zapotec */
 566         LANGUAGE_ZBL, /**< Blissymbols; Blissymbolics; Bliss */
 567         LANGUAGE_ZEN, /**< Zenaga */
 568         LANGUAGE_ZHA, /**< Zhuang; Chuang */
 569         LANGUAGE_ZND, /**< Zande languages */
 570         LANGUAGE_ZUL, /**< Zulu */
 571         LANGUAGE_ZUN, /**< Zuni */
 572         LANGUAGE_ZXX, /**< No linguistic content; Not applicable */
 573         LANGUAGE_ZZA, /**< Zaza; Dimili; Dimli; Kirdki; Kirmanjki; Zazaki */
 574         LANGUAGE_MAX // Language max count
 575 }; // LanguageCode
 576
 577
 578 /**
 579  * @enum        CountryCode
 580  *
 581  * Defines the ISO 3166-1 alpha-2 country code. @n
 582  * This enum represents the ISO 3166-1 alpha-2 country codes.
 583  * The area code for Latin america and the Caribbean represents the ISO 3166-1 numeric-3 code.
 584  *
 585  * @since               2.0
 586  */
 587 enum CountryCode
 588 {
 589     COUNTRY_INVALID = -1, /**< An invalid country code */
 590         COUNTRY_AF, /**< AFGHANISTAN  */
 591         COUNTRY_AX, /**< ALAND ISLANDS */
 592         COUNTRY_AL, /**< ALBANIA */
 593         COUNTRY_DZ, /**< ALGERIA */
 594         COUNTRY_AS, /**< AMERICAN SAMOA */
 595         COUNTRY_AD, /**< ANDORRA */
 596         COUNTRY_AO, /**< ANGOLA */
 597         COUNTRY_AI, /**< ANGUILLA */
 598         COUNTRY_AQ, /**< ANTARCTICA */
 599         COUNTRY_AG, /**< ANTIGUA AND BARBUDA */
 600         COUNTRY_AR, /**< ARGENTINA */
 601         COUNTRY_AM, /**< ARMENIA */
 602         COUNTRY_AW, /**< ARUBA */
 603         COUNTRY_AU, /**< AUSTRALIA */
 604         COUNTRY_AT, /**< AUSTRIA */
 605         COUNTRY_AZ, /**< AZERBAIJAN */
 606         COUNTRY_BS, /**< BAHAMAS */
 607         COUNTRY_BH, /**< BAHRAIN */
 608         COUNTRY_BD, /**< BANGLADESH */
 609         COUNTRY_BB, /**< BARBADOS */
 610         COUNTRY_BY, /**< BELARUS */
 611         COUNTRY_BE, /**< BELGIUM */
 612         COUNTRY_BZ, /**< BELIZE */
 613         COUNTRY_BJ, /**< BENIN */
 614         COUNTRY_BM, /**< BERMUDA */
 615         COUNTRY_BT, /**< BHUTAN */
 616         COUNTRY_BO, /**< BOLIVIA */
 617         COUNTRY_BA, /**< BOSNIA AND HERZEGOVINA */
 618         COUNTRY_BW, /**< BOTSWANA */
 619         COUNTRY_BV, /**< BOUVET ISLAND */
 620         COUNTRY_BR, /**< BRAZIL */
 621         COUNTRY_IO, /**< BRITISH INDIAN OCEAN TERRITORY */
 622         COUNTRY_BN, /**< BRUNEI DARUSSALAM */
 623         COUNTRY_BG, /**< BULGARIA */
 624         COUNTRY_BF, /**< BURKINA FASO */
 625         COUNTRY_BI, /**< BURUNDI */
 626         COUNTRY_KH, /**< CAMBODIA */
 627         COUNTRY_CM, /**< CAMEROON */
 628         COUNTRY_CA, /**< CANADA */
 629         COUNTRY_CV, /**< CAPE VERDE */
 630         COUNTRY_KY, /**< CAYMAN ISLANDS */
 631         COUNTRY_CF, /**< CENTRAL AFRICAN REPUBLIC */
 632         COUNTRY_TD, /**< CHAD */
 633         COUNTRY_CL, /**< CHILE */
 634         COUNTRY_CN, /**< CHINA */
 635         COUNTRY_CX, /**< CHRISTMAS ISLAND */
 636         COUNTRY_CC, /**< COCOS (KEELING) ISLANDS */
 637         COUNTRY_CO, /**< COLOMBIA */
 638         COUNTRY_KM, /**< COMOROS */
 639         COUNTRY_CG, /**< CONGO */
 640         COUNTRY_CD, /**< CONGO, THE DEMOCRATIC REPUBLIC OF THE */
 641         COUNTRY_CK, /**< COOK ISLANDS */
 642         COUNTRY_CR, /**< COSTA RICA */
 643         COUNTRY_CI, /**< COTE D'IVOIRE */
 644         COUNTRY_HR, /**< CROATIA */
 645         COUNTRY_CU, /**< CUBA */
 646         COUNTRY_CY, /**< CYPRUS */
 647         COUNTRY_CZ, /**< CZECH REPUBLIC */
 648         COUNTRY_DK, /**< DENMARK */
 649         COUNTRY_DJ, /**< DJIBOUTI */
 650         COUNTRY_DM, /**< DOMINICA */
 651         COUNTRY_DO, /**< DOMINICAN REPUBLIC */
 652         COUNTRY_EC, /**< ECUADOR */
 653         COUNTRY_EG, /**< EGYPT */
 654         COUNTRY_SV, /**< EL SALVADOR */
 655         COUNTRY_GQ, /**< EQUATORIAL GUINEA */
 656         COUNTRY_ER, /**< ERITREA */
 657         COUNTRY_EE, /**< ESTONIA */
 658         COUNTRY_ET, /**< ETHIOPIA */
 659         COUNTRY_FK, /**< FALKLAND ISLANDS (MALVINAS) */
 660         COUNTRY_FO, /**< FAROE ISLANDS */
 661         COUNTRY_FJ, /**< FIJI */
 662         COUNTRY_FI, /**< FINLAND */
 663         COUNTRY_FR, /**< FRANCE */
 664         COUNTRY_GF, /**< FRENCH GUIANA */
 665         COUNTRY_PF, /**< FRENCH POLYNESIA */
 666         COUNTRY_TF, /**< FRENCH SOUTHERN TERRITORIES */
 667         COUNTRY_GA, /**< GABON  */
 668         COUNTRY_GM, /**< GAMBIA */
 669         COUNTRY_GE, /**< GEORGIA */
 670         COUNTRY_DE, /**< GERMANY */
 671         COUNTRY_GH, /**< GHANA */
 672         COUNTRY_GI, /**< GIBRALTAR */
 673         COUNTRY_GR, /**< GREECE */
 674         COUNTRY_GL, /**< GREENLAND */
 675         COUNTRY_GD, /**< GRENADA */
 676         COUNTRY_GP, /**< GUADELOUPE */
 677         COUNTRY_GU, /**< GUAM */
 678         COUNTRY_GT, /**< GUATEMALA */
 679         COUNTRY_GN, /**< GUINEA */
 680         COUNTRY_GW, /**< GUINEA-BISSAU */
 681         COUNTRY_GY, /**< GUYANA */
 682         COUNTRY_HT, /**< HAITI */
 683         COUNTRY_HM, /**< HEARD ISLAND AND MCDONALD ISLANDS */
 684         COUNTRY_VA, /**< HOLY SEE (VATICAN CITY STATE) */
 685         COUNTRY_HN, /**< HONDURAS */
 686         COUNTRY_HK, /**< HONG KONG */
 687         COUNTRY_HU, /**< HUNGARY */
 688         COUNTRY_IS, /**< ICELAND */
 689         COUNTRY_IN, /**< INDIA */
 690         COUNTRY_ID, /**< INDONESIA */
 691         COUNTRY_IR, /**< IRAN, ISLAMIC REPUBLIC OF */
 692         COUNTRY_IQ, /**< IRAQ */
 693         COUNTRY_IE, /**< IRELAND */
 694         COUNTRY_IL, /**< ISRAEL */
 695         COUNTRY_IT, /**< ITALY */
 696         COUNTRY_JM, /**< JAMAICA */
 697         COUNTRY_JP, /**< JAPAN */
 698         COUNTRY_JO, /**< JORDAN */
 699         COUNTRY_KZ, /**< KAZAKHSTAN */
 700         COUNTRY_KE, /**< KENYA */
 701         COUNTRY_KI, /**< KIRIBATI */
 702         COUNTRY_KP, /**< KOREA, DEMOCRATIC PEOPLE'S REPUBLIC OF */
 703         COUNTRY_KR, /**< KOREA, REPUBLIC OF */
 704         COUNTRY_KW, /**< KUWAIT */
 705         COUNTRY_KG, /**< KYRGYZSTAN */
 706         COUNTRY_LA, /**< LAO PEOPLE'S DEMOCRATIC REPUBLIC  */
 707         COUNTRY_LV, /**< LATVIA */
 708         COUNTRY_LB, /**< LEBANON */
 709         COUNTRY_LS, /**< LESOTHO */
 710         COUNTRY_LR, /**< LIBERIA */
 711         COUNTRY_LY, /**< LIBYAN ARAB JAMAHIRIYA */
 712         COUNTRY_LI, /**< LIECHTENSTEIN */
 713         COUNTRY_LT, /**< LITHUANIA */
 714         COUNTRY_LU, /**< LUXEMBOURG */
 715         COUNTRY_MO, /**< MACAO */
 716         COUNTRY_MK, /**< MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF */
 717         COUNTRY_MG, /**< MADAGASCAR */
 718         COUNTRY_MW, /**< MALAWI */
 719         COUNTRY_MY, /**< MALAYSIA */
 720         COUNTRY_MV, /**< MALDIVES */
 721         COUNTRY_ML, /**< MALI */
 722         COUNTRY_MT, /**< MALTA */
 723         COUNTRY_MH, /**< MARSHALL ISLANDS */
 724         COUNTRY_MQ, /**< MARTINIQUE */
 725         COUNTRY_MR, /**< MAURITANIA */
 726         COUNTRY_MU, /**< MAURITIUS */
 727         COUNTRY_YT, /**< MAYOTTE */
 728         COUNTRY_MX, /**< MEXICO */
 729         COUNTRY_FM, /**< MICRONESIA, FEDERATED STATES OF */
 730         COUNTRY_MD, /**< MOLDOVA, REPUBLIC OF */
 731         COUNTRY_MC, /**< MONACO */
 732         COUNTRY_MN, /**< MONGOLIA */
 733         COUNTRY_MS, /**< MONTSERRAT */
 734         COUNTRY_MA, /**< MOROCCO */
 735         COUNTRY_MZ, /**< MOZAMBIQUE */
 736         COUNTRY_MM, /**< MYANMAR */
 737         COUNTRY_NA, /**< NAMIBIA */
 738         COUNTRY_NR, /**< NAURU */
 739         COUNTRY_NP, /**< NEPAL */
 740         COUNTRY_NL, /**< NETHERLANDS */
 741         COUNTRY_AN, /**< NETHERLANDS ANTILLES */
 742         COUNTRY_NC, /**< NEW CALEDONIA */
 743         COUNTRY_NZ, /**< NEW ZEALAND */
 744         COUNTRY_NI, /**< NICARAGUA */
 745         COUNTRY_NE, /**< NIGER */
 746         COUNTRY_NG, /**< NIGERIA */
 747         COUNTRY_NU, /**< NIUE */
 748         COUNTRY_NF, /**< NORFOLK ISLAND */
 749         COUNTRY_MP, /**< NORTHERN MARIANA ISLANDS */
 750         COUNTRY_NO, /**< NORWAY */
 751         COUNTRY_OM, /**< OMAN */
 752         COUNTRY_PK, /**< PAKISTAN */
 753         COUNTRY_PW, /**< PALAU */
 754         COUNTRY_PS, /**< PALESTINIAN TERRITORY, OCCUPIED */
 755         COUNTRY_PA, /**< PANAMA */
 756         COUNTRY_PG, /**< PAPUA NEW GUINEA */
 757         COUNTRY_PY, /**< PARAGUAY */
 758         COUNTRY_PE, /**< PERU */
 759         COUNTRY_PH, /**< PHILIPPINES */
 760         COUNTRY_PN, /**< PITCAIRN */
 761         COUNTRY_PL, /**< POLAND */
 762         COUNTRY_PT, /**< PORTUGAL */
 763         COUNTRY_PR, /**< PUERTO RICO */
 764         COUNTRY_QA, /**< QATAR */
 765         COUNTRY_RE, /**< REUNION */
 766         COUNTRY_RO, /**< ROMANIA */
 767         COUNTRY_RU, /**< RUSSIAN FEDERATION */
 768         COUNTRY_RW, /**< RWANDA */
 769         COUNTRY_SH, /**< SAINT HELENA  */
 770         COUNTRY_KN, /**< SAINT KITTS AND NEVIS */
 771         COUNTRY_LC, /**< SAINT LUCIA */
 772         COUNTRY_PM, /**< SAINT PIERRE AND MIQUELON */
 773         COUNTRY_VC, /**< SAINT VINCENT AND THE GRENADINES */
 774         COUNTRY_WS, /**< SAMOA */
 775         COUNTRY_SM, /**< SAN MARINO */
 776         COUNTRY_ST, /**< SAO TOME AND PRINCIPE */
 777         COUNTRY_SA, /**< SAUDI ARABIA */
 778         COUNTRY_SN, /**< SENEGAL */
 779         COUNTRY_SC, /**< SEYCHELLES */
 780         COUNTRY_SL, /**< SIERRA LEONE */
 781         COUNTRY_SG, /**< SINGAPORE */
 782         COUNTRY_SK, /**< SLOVAKIA */
 783         COUNTRY_SI, /**< SLOVENIA */
 784         COUNTRY_SB, /**< SOLOMON ISLANDS */
 785         COUNTRY_SO, /**< SOMALIA */
 786         COUNTRY_ZA, /**< SOUTH AFRICA */
 787         COUNTRY_GS, /**< SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS */
 788         COUNTRY_ES, /**< SPAIN */
 789         COUNTRY_LK, /**< SRI LANKA */
 790         COUNTRY_SD, /**< SUDAN */
 791         COUNTRY_SR, /**< SURINAME */
 792         COUNTRY_SJ, /**< SVALBARD AND JAN MAYEN */
 793         COUNTRY_SZ, /**< SWAZILAND */
 794         COUNTRY_SE, /**< SWEDEN */
 795         COUNTRY_CH, /**< SWITZERLAND */
 796         COUNTRY_SY, /**< SYRIAN ARAB REPUBLIC */
 797         COUNTRY_TW, /**< TAIWAN, PROVINCE OF CHINA */
 798         COUNTRY_TJ, /**< TAJIKISTAN */
 799         COUNTRY_TZ, /**< TANZANIA, UNITED REPUBLIC OF */
 800         COUNTRY_TH, /**< THAILAND */
 801         COUNTRY_TL, /**< TIMOR-LESTE */
 802         COUNTRY_TG, /**< TOGO */
 803         COUNTRY_TK, /**< TOKELAU */
 804         COUNTRY_TO, /**< TONGA */
 805         COUNTRY_TT, /**< TRINIDAD AND TOBAGO */
 806         COUNTRY_TN, /**< TUNISIA */
 807         COUNTRY_TR, /**< TURKEY */
 808         COUNTRY_TM, /**< TURKMENISTAN */
 809         COUNTRY_TC, /**< TURKS AND CAICOS ISLANDS */
 810         COUNTRY_TV, /**< TUVALU */
 811         COUNTRY_UG, /**< UGANDA */
 812         COUNTRY_UA, /**< UKRAINE */
 813         COUNTRY_AE, /**< UNITED ARAB EMIRATES */
 814         COUNTRY_GB, /**< UNITED KINGDOM */
 815         COUNTRY_US, /**< UNITED STATES */
 816         COUNTRY_UM, /**< UNITED STATES MINOR OUTLYING ISLANDS */
 817         COUNTRY_UY, /**< URUGUAY */
 818         COUNTRY_UZ, /**< UZBEKISTAN */
 819         COUNTRY_VU, /**< VANUATU */
 820         COUNTRY_VE, /**< VENEZUELA */
 821         COUNTRY_VN, /**< VIET NAM */
 822         COUNTRY_VG, /**< VIRGIN ISLANDS, BRITISH */
 823         COUNTRY_VI, /**< VIRGIN ISLANDS, U.S. */
 824         COUNTRY_WF, /**< WALLIS AND FUTUNA */
 825         COUNTRY_EH, /**< WESTERN SAHARA */
 826         COUNTRY_YE, /**< YEMEN */
 827         COUNTRY_ZM, /**< ZAMBIA */
 828         COUNTRY_ZW, /**< ZIMBABWE */
 829         COUNTRY_RS, /**< SERBIA */
 830         COUNTRY_ME, /**< MONTENEGRO */
 831         COUNTRY_BL, /**< SAINT BARTHELEMY @b Since: @b 2.1  */
 832         COUNTRY_MF, /**< SAINT MARTIN (FRENCH PART) @b Since: @b 2.1 */
 833         COUNTRY_AREA_419, /**< Latin America and the Caribbean @b Since: @b 2.1  */
 834         COUNTRY_MAX    //< Country max count
 835 };
 836
 837
 838 /**
 839  * @class               Locale
 840  * @brief               This class is for the locale identification.
 841  *
 842  * @since               2.0
 843  *
 844  * @final       This class is not intended for extension.
 845  *
 846  * @remarks     For more information on the example codes for the %Locale class, see LocaleManager.
 847  *
 848  * The %Locale class represents a specific geographical, political, or cultural region. @n
 849  * A %Locale object has three attributes:
 850  * - Language Code
 851  * - Country Code
 852  * - Variant Code
 853  *
 854  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/locales/lang_country_codes.htm">Retrieving Language and Country Codes</a>.
 855  *
 856  * @see LanguageCode
 857  * @see CountryCode
 858  * @see LocaleManager
 859  */
 860
 861 class _OSP_EXPORT_ Locale
 862         : public Tizen::Base::Object
 863 {
 864 public:
 865         /**
 866          * Initializes an instance of %Locale with the values of the specified locale. @n
 867          * Copying of objects using this copy constructor is allowed.
 868          *
 869          * @since                               2.0
 870          *
 871          * @param[in]                   otherLocale                     An instance of %Locale
 872          */
 873         Locale(const Locale& otherLocale);
 874
 875         /**
 876          * Initializes an instance of %Locale with the specified language, country, and variant code.
 877          *
 878          * @since                               2.0
 879          *
 880          * @param[in]                   languageCode                    The language code
 881          * @param[in]                   countryCode                             The country code
 882          * @param[in]                   pVariantCodeString              A pointer to the variant code string @n
 883          *                                                                                              It is converted to upper case letters if it is written in lower case letters.
 884          */
 885         Locale(LanguageCode languageCode, CountryCode countryCode, const Tizen::Base::String* pVariantCodeString = null);
 886
 887         /**
 888          * Assigns the value of the specified instance to the current instance of %Locale. @n
 889          * Copying of objects using this copy assignment operator is allowed.
 890          *
 891          * @since                       2.0
 892          *
 893          * @return                      A reference to the current instance of %Locale
 894          * @param[in]           otherLocale                             An instance of %Locale
 895          */
 896         Locale& operator =(const Locale& otherLocale);
 897
 898         /**
 899          * This is the destructor for this class. @n
 900          * This destructor overrides Tizen::Base::Object::~Object().
 901          *
 902          * @since               2.0
 903          */
 904         virtual ~Locale(void);
 905
 906         /**
 907          * Compares the current instance of %Locale with the specified instance of %Locale.
 908          *
 909          * @since                       2.0
 910          *
 911          * @return                      @c true if the value of the specified instance is equal to the value of the current instance, @n
 912          *                                      else @c false
 913          * @param[in]           otherLocale                             An instance of %Locale
 914          */
 915         bool operator ==(const Locale& otherLocale) const;
 916
 917         /**
 918          * Compares the current instance of %Locale with the specified instance of %Locale.
 919          *
 920          * @since               2.0
 921          *
 922          * @return              @c true if the value of the specified instance is not equal to the value of the current instance, @n
 923          *                              else @c false
 924          * @param[in]   otherLocale             An instance of %Locale
 925          */
 926         bool operator !=(const Locale& otherLocale) const;
 927
 928         /**
 929          * Converts the operand @c obj to an object of the %Locale type and compares it with the current instance of %Locale.
 930          *
 931          * @since               2.0
 932          *
 933          * @return              @c true if the value of the current instance is equal to the value of the specified Tizen::Base::Object, @n
 934          *                              else @c false
 935          * @param[in]   obj                             The object to compare with the current instance
 936          * @see                 Tizen::Base::Object::Equals()
 937          */
 938         virtual bool Equals(const Object& obj) const;
 939
 940         /**
 941          * Gets the hash value of the current instance.
 942          *
 943          * @since               2.0
 944          *
 945          * @return              The hash value of the current instance
 946          */
 947         virtual int GetHashCode(void) const;
 948
 949         /**
 950          * Gets the language code (ISO 639-2 code) of the current instance of %Locale.
 951          *
 952          * @since               2.0
 953          *
 954          * @return              The language code enum value of the instance
 955          *
 956          * @remarks             The specific LanguageCode represents the language code with the locale's ISO-15924 abbreviation script code.
 957          */
 958         LanguageCode GetLanguageCode(void) const;
 959
 960         /**
 961          * Gets the country code (ISO 3166-1 alpha-2 code) or the area code (ISO 3166-1 numeric-3 code) of the current instance of %Locale.
 962          *
 963          * @since               2.0
 964          *
 965          * @return              The country code enum value of the instance
 966          */
 967         CountryCode GetCountryCode(void) const;
 968
 969         /**
 970          * Gets the language code (ISO 639-2 code) string of the current instance of %Locale.
 971          *
 972          * @since               2.0
 973          *
 974          * @return              The language code, @n
 975          *                              The specific language code string has the locale's ISO-15924 abbreviation script code.
 976          */
 977         Tizen::Base::String GetLanguageCodeString(void) const;
 978
 979         /**
 980          * Gets the country code (ISO 3166-1 alpha-2 code) or the area code (ISO 3166-1 numeric-3 code) string of the current instance of %Locale.
 981          *
 982          * @since               2.0
 983          *
 984          * @return              The country code @n
 985          *                              else the area code if the country code represents Latin America.
 986          */
 987         Tizen::Base::String GetCountryCodeString(void) const;
 988
 989         /**
 990          * Gets the variant code string of the current instance of %Locale.
 991          *
 992          * @since               2.0
 993          *
 994          * @return              The variant code string in upper case letters even if it was set to lower case letters, @n
 995          *                              else an empty string if the variant is not specified
 996          * @see                 SetVariantCodeString()
 997          */
 998         Tizen::Base::String GetVariantCodeString(void) const;
 999
1000
1001         /**
1002          * Gets the string representing the current instance of %Locale. @n
1003          * The string consists of the values returned by GetLanguageCodeString(), GetCountryCodeString(), and GetVariantCodeString() assembled into a string.
1004          *
1005          * @since                               2.0
1006          *
1007          * @return                              The concatenated string with the language code string, country code string, and variant string @n
1008          *                                              For example, if the language code is ::LANGUAGE_ENG, country code is ::COUNTRY_US, and variant string is empty, @n
1009          *                                              the locale code string is "eng_US".
1010          */
1011         Tizen::Base::String GetLocaleCodeString(void) const;
1012
1013         /**
1014          * Gets the country name of the current instance of %Locale that is appropriate for display. @n
1015          * The name is localized for this locale. For example, if this locale is eng_US, the name is "United States".
1016          *
1017          * @since                               2.0
1018          *
1019          * @return                              An error code
1020          * @param[out]                  countryName                                     The country name of the locale
1021          * @exception                   E_SUCCESS                                       The method is successful.
1022          * @exception                   E_UNSUPPORTED_OPERATION         The current @c locale does not have a country name entry in the database.
1023          */
1024         result GetCountryName(Tizen::Base::String& countryName) const;
1025
1026         /**
1027          * Gets the country name of the current instance of %Locale that is appropriate for display in the specified %Locale. @n
1028          * The country name is localized for the specified locale(@c otherLocale). For example, if
1029          * the current instance of %Locale is fra_FR and the @c otherLocale is eng_US, the name is "France";
1030          * if the current instance is eng_US and the @c otherLocale is fra_FR, the name returned is "Etats-Unis".
1031          *
1032          * @since                                       2.0
1033          *
1034          * @return                                      An error code
1035          * @param[in]                           otherLocale                                     An instance of %Locale to display the country name
1036          * @param[out]                          countryName                                     The country name of the locale
1037          * @exception                           E_SUCCESS                                       The method is successful.
1038          * @exception                           E_UNSUPPORTED_OPERATION         The specified @c locale is not supported, or the current @c locale does not have a country name entry in the database.
1039          */
1040         result GetCountryName(const Locale& otherLocale, Tizen::Base::String& countryName) const;
1041
1042         /**
1043          * Gets the language name of the current instance of %Locale that is appropriate for display. @n
1044          * The name is localized for the locale. For example, if this locale is eng_US, the name is "English".
1045          *
1046          * @since                                       2.0
1047          *
1048          * @return                                      An error code
1049          * @param[out]                          languageName                            The language name of the locale
1050          * @exception                           E_SUCCESS                                       The method is successful.
1051          * @exception                           E_UNSUPPORTED_OPERATION         The current @c locale does not have a country name entry in the database.
1052          */
1053         result GetLanguageName(Tizen::Base::String& languageName) const;
1054
1055         /**
1056          * Gets the language name of the current instance of %Locale that is appropriate for display in the specified %Locale. @n
1057          * The name is localized for the specified locale (@c otherLocale). For example, if
1058          * the current instance is fra_FR and the @c otherLocale is eng_US, the name is "French";
1059          * if the current instance is engUS and the @c otherLocale is fra_FR, the name returned is "anglais".
1060          *
1061          * @since                                       2.0
1062          *
1063          * @return                                      An error code
1064          * @param[in]                           otherLocale                                     An instance of %Locale to display the language name
1065          * @param[out]                          languageName                            The language name of the locale
1066          * @exception                           E_SUCCESS                                       The method is successful.
1067          * @exception                           E_UNSUPPORTED_OPERATION         The specified @c locale is not supported, or the current @c locale does not have country name entry in the database.
1068          */
1069         result GetLanguageName(const Locale& otherLocale, Tizen::Base::String& languageName) const;
1070
1071         /**
1072          * Sets the variant code with the specified variant code string. @n
1073          * The variant code string is converted to upper case letters even if it is set to lower case letters.
1074          *
1075          * @since                                       2.0
1076          *
1077          * @param[in]                           pVariantCode                    The pointer to the variant code
1078          */
1079         void SetVariantCodeString(const Tizen::Base::String* pVariantCode = null);
1080
1081         /**
1082          * Gets the language code equivalent to the specified language code string.
1083          *
1084          * @since                       2.0
1085          *
1086          * @param[in]           languageCodeString                              The language code, @n
1087          *                                                                                                      To get the specified language code with the locale's ISO-15924 abbreviation script code,
1088          *                                                                                                      the form of @c languageCodeString should combine the ISO 639-2 language codes and the locale's
1089          *                                                                                                      ISO-15924 abbreviation script code by "-". @n
1090          *                                                                                                      For example, if the language code is "aze" and the script code is "latn",
1091          *                                                                                                      the @c languageCodeString is "aze-latn", and the language code is @c LANGUAGE_AZE_LATIN.
1092          * @return                      An instance of LanguageCode associated with @c languageCodeString.
1093          */
1094         static LanguageCode StringToLanguageCode(const Tizen::Base::String& languageCodeString);
1095
1096         /**
1097          * Gets the country code equivalent of the specified country code string.
1098          *
1099          * @since                       2.0
1100          *
1101          * @param[in]           countryCodeString                               The country code
1102          * @return                      An instance of CountryCode associated with the @c countryCodeString.
1103          */
1104         static CountryCode StringToCountryCode(const Tizen::Base::String& countryCodeString);
1105
1106         /**
1107          * Gets the language code string equivalent of the specified @c languageCode.
1108          *
1109          * @since                       2.0
1110          *
1111          * @param[in]           languageCode                                    The language code
1112          * @return                      The language code string associated with @c languageCode, @n
1113          *                                      else an empty string if @c languageCode is invalid.
1114          * @see                         StringToLanguageCode()
1115          */
1116         static Tizen::Base::String LanguageCodeToString(LanguageCode languageCode);
1117
1118         /**
1119          * Gets the country code string equivalent of the specified @c countryCode.
1120          *
1121          * @since                       2.0
1122          *
1123          * @param[in]           countryCode                                             The country code
1124          * @return                      The ISO 3166-1 alpha-2 country code string associated with @c countryCode, @n
1125          *                                      else an empty string if @c countryCode is invalid.
1126          */
1127         static Tizen::Base::String CountryCodeToString(CountryCode countryCode);
1128
1129         /**
1130          * Gets the 2-letter language code string equivalent of the specified @c languageCode.
1131          *
1132          * @since                       2.0
1133          *
1134          * @param[in]           languageCode                                    The language code
1135          * @return                      The ISO 639-2 language code string associated with @c languageCode, @n
1136          *                                      or the ISO 639-2 language code string with the ISO-15924 script code if the @c languageCode represents
1137          *                                      the ISO 639-2 language code with the ISO-15924 script code, @n
1138          *                                      else an empty string if @c languageCode is invalid.
1139          */
1140         static Tizen::Base::String LanguageCodeToTwoLetterLanguageCodeString(LanguageCode languageCode);
1141
1142         /**
1143          * Gets the language code equivalent of the specified 2-letter language code string.
1144          *
1145          * @since                       2.0
1146          *
1147          * @param[in]           languageCodeString                              The language code string
1148          * @return                      An instance of LanguageCode associated with @c languageCodeString.
1149          * @see                         StringToLanguageCode()
1150          */
1151         static LanguageCode TwoLetterLanguageCodeStringToLanguageCode(const Tizen::Base::String& languageCodeString);
1152
1153         /**
1154          * Gets the 3-letter country code string equivalent of the specified @c countryCode.
1155          *
1156          * @since                       2.0
1157          *
1158          * @param[in]           countryCode                                             The country code
1159          * @return                      The ISO 3166-1 alpha-3 country code string associated with @c countryCode, @n
1160          *                                      else an empty string if @c countryCode is invalid
1161          * @remarks                     @c COUNTRY_AREA_419 returns an empty string, since it is not defined in the ISO 3166-1 alpha-3.
1162          * @see                         CountryCodeToString()
1163          */
1164         static Tizen::Base::String CountryCodeToThreeLetterCountryCodeString(CountryCode countryCode);
1165
1166         /**
1167          * Gets the country code equivalent of the specified 3-letter country code string.
1168          *
1169          * @since                       2.0
1170          *
1171          * @param[in]           countryCodeString                                The country code string
1172          * @return                      An instance of CountryCode associated with @c countryCodeString.
1173          * @see                         StringToCountryCode()
1174          */
1175         static CountryCode ThreeLetterCountryCodeStringToCountryCode(const Tizen::Base::String& countryCodeString);
1176
1177 private:
1178
1179         LanguageCode __languageCode;
1180         CountryCode __countryCode;
1181
1182         friend class _LocaleImpl;
1183         class _LocaleImpl* __pLocaleImpl;
1184
1185 }; // Locale
1186
1187 }} // Tizen::Locales
1188
1189 #endif //_FLCL_LOCALE_H_