50 #define LANGUAGE_LIST_FILE "/resource/hbi18n/translations/language_list.txt"

    50 #define LANGUAGE_LIST_FILE "/resource/hb/translations/language_list.txt"

    51 #define LANGUAGE_MAPPINGS_FILE "/resource/hbi18n/translations/locale_mappings.txt"

    51 #define LANGUAGE_MAPPINGS_FILE "/resource/hb/translations/locale_mappings.txt"

    52 #define LANGUAGE_ID_PREFIX "language"

    52 #define LANGUAGE_TRANSLATOR_PATH "/resource/hb/translations/languages"

    53 #define LANGUAGE_TRANSLATOR_PATH "/resource/hbi18n/translations/languages"

    53 #define REGION_TRANSLATOR_PATH "/resource/hb/translations/regions"

    54 

    54 #define COLLATION_TRANSLATOR_PATH "/resource/hb/translations/collations"

    55 #define REGION_LIST_FILE "z:/resource/bootdata/regions.txt"

    55 

    56 #define REGION_ID_PREFIX "region"

    56 #define LANGUAGE_ID_PREFIX "txt_language"

    57 #define REGION_TRANSLATOR_PATH "/resource/hbi18n/translations/regions"

    57 #define REGION_ID_PREFIX "txt_region"

    58 #define REGION_DLL_PREFIX "elocl_reg."

    58 #define COLLATION_ID_PREFIX "txt_collation"

    59 

    59 

    60 #define COLLATION_LIST_FILE "z:/resource/bootdata/collations.txt"

    61 #define COLLATION_ID_PREFIX "collation"

    62 #define COLLATION_TRANSLATOR_PATH "/resource/hbi18n/translations/collations"

    63 #define COLLATION_DLL_PREFIX "elocl_col."

    71     \brief HbLocaleUtil provides functions for quering supported languages, regions and collations and activing them.

    67     \brief The HbLocaleUtil class supports querying the supported languages, regions and collations, and activating them.

    73     Language and collation identifiers typically corresponds with two-letter ISO 639 language code, but for certain languages and collations combination of ISO 639 language code and  ISO 3166 country code id used.

    69     With HbLocaleUtil, you can query the supported languages, regions and 

    74     Region identifiers always corresponds with two-letter ISO 3166 country code.

    70     collations from the device, and the ones currently set in the device. You 

    75     

    71     can then use this data to activate the language, region and collation in the 

    76     HbLocaleUtil also provides functions for converting language, region and collation identifiers to their localised names. 

    72     device; either individually, or as a set determined by the specified 

    73     language.

    74     

    75     HbLocaleUtil returns the data from the device as identifiers. The language 

    76     and collation identifiers typically correspond to two-letter ISO 639 

    77     language codes. However, some languages and collations use a combination of 

    78     an ISO 639 language code and an ISO 3166 country code, separated by an 

    79     underscore character. Region identifiers always correspond to a two-letter 

    80     ISO 3166 country code.

    81     

    82     HbLocaleUtil also provides functions for converting language, region and 

    83     collation identifiers to their localized names. 

    84     

    85     Example:

    86     \snippet{unittest_hblocaleutil/unittest_hblocaleutil.cpp,1}

    87     

    88     

    89     \sa HbStringUtil, HbExtendedLocale

    90     

   101     \brief Reads langauge, region and collation mappings.

   113     \relates HbLocaleUtil

   114     

   115     Reads language, region and collation mappings.

   156 #if defined(Q_OS_SYMBIAN)

   170 /*!

   157 

   171 

   158 /*!

   172     Returns the identifier of the current UI language. Typically the language 

   159     \brief Changes the system UI language.

   173     identifier is an ISO 639 language code, but in some cases, it is a 

   160       

   174     combination of an ISO 639 language code and an ISO 3166 country code. For 

   161     \param dllExtension extension of the locale dll

   175     example, for UK English, this returns "en", and for US English, this returns 

   162     \return true if operation was successful

   176     "en_US".

   163 */

   177     

   164 bool setLocale( const QString &dllExtension )

   178     \attention Only fully implemented on the Symbian platform. For other 

   165 {

   179     platforms, always returns an empty QString.

   166     TExtendedLocale dummy;

   180     

   167     dummy.LoadSystemSettings();

   181     \sa supportedLanguages(), localisedLanguageName(), changeLanguage(), languageRegionMappings()

   168     QString name = QString( "elocl_lan." ).append( dllExtension );

   182 

   169     TPtrC nameptr(name.utf16());

   170     

   171     TInt err = dummy.LoadLocaleAspect( nameptr );

   172     if( err != KErrNone )

   173         return false;

   174     dummy.SaveSystemSettings();

   175     // cause localeprivate update on next qlocale object( glp->m_language_id = 0 )

   176     QSystemLocale dummy2;

   177     return true;

   178 }

   179 #endif //Q_OS_SYMBIAN

   180 

   181 /*!

   182     \brief Return identifier of the current UI language.

   183     

   184     \attention Symbian specific API

   185 

   186     \return Identifier of the language code for Symbian and empty QString for other platforms.

   208     \brief Returns identifiers of languages supported in a device. 

   204     

   209     Language identifier may be two-letter ISO 639 language code or combination of ISO 639 language code and ISO 3166 country code 

   205     Returns the identifiers of the languages supported on the device. Typically 

   210     Ex: Great Britain english it returns "en".

   206     the language identifier is an ISO 639 language code, but in some cases, it 

   211     Ex: For U.S. english it returns "en_US"  

   207     is a combination of an ISO 639 language code and an ISO 3166 country code. 

   212     

   208     For example, for UK English, this returns "en", and for US English, this 

   213     \attention Symbian specific API

   209     returns "en_US".

   214     

   210     

   215     \return identifiers of supported languages for Symbian and empty QStringList for other platforms 

   211     \attention Only fully implemented on the Symbian platform. For other 

   212     platforms, always returns an empty QStringList.

   213     

   214     \sa localisedLanguageName(), currentLanguage(), changeLanguage(), changeLocale()

   215     

   251     \brief Converts two or five letter language identifier code to localised language name. 

   251     

   252     

   252     Returns the localised language name for the specified language identifier. 

   253     \attention Symbian specific API

   253     If the translation fails, returns an empty QString.

   254     

   254     

   255     \param language identifier 

   255     \param language The two- or five-letter language identifier that corresponds to one of the following:

   256     

   256     - An identifier returned by supportedLanguages() or currentLanguage()

   257     \return Symbian - localised name of the language, an empty String if translation fails

   257     - An HbLanguageRegionMapping::languageId string

   258     \return other platforms - empty QString    

   258     

   259     \attention Only fully implemented on the Symbian platform. For other 

   260     platforms, always returns an empty QString.

   261     

   262     \sa changeLanguage(), currentLanguage()

   263  

   290     \brief Changes the system language.  

   295 

   291     The language parameter should correspond with one of the identifiers returned by supportedLanguages(). 

   296     Changes the system language to the one specified in \a language.

   292     

   293     \attention Symbian specific API

   295     \param language identifier of language to set active

   298     \param language The language identifier. This must correspond to an 

   296     

   299     identifier returned by supportedLanguages(), or an 

   297     \return true if language change was successful and false for other platforms

   300     HbLanguageRegionMapping::languageId string.

   301     

   302     \return \c true if successful, otherwise \c false.

   303     

   304     \attention Only fully implemented on the Symbian platform. For other 

   305     platforms, always returns \c false.

   306     

   307     \sa localisedLanguageName(), currentLanguage()

   308     

   312             dllExt = map.languageDllId;

   322             retVal = SysLangUtil::ChangeLanguage(lanCode);

   313             break;

   323             if (!retVal) {

   314         }

   324                 // Never set Language code 0 to HAL

   315     }

   325                 if ( language != 0 ) {

   316     

   326                     HAL::Set( HAL::ELanguageIndex, lanCode );

   317     if (lanCode == -1) {

   327                 }

   318         return false;

   328                 return true;

   319     }

   329             }

   320     

   330             else {

   321     CRepository* commonEngineRepository = 0;

   331                 return false;

   322     TRAPD( err1, commonEngineRepository = CRepository::NewL( KCRUidCommonEngineKeys ) );    

   332             }

   323     if ( err1 != KErrNone ) { 

   333         }

   324         return false;

   334     }        

   325     }

   335     return false;

   326     

   327     if (!setLocale(dllExt)) {

   328         delete commonEngineRepository;

   329         return false;

   330     }

   331         

   332     // Never set Language code 0 to HAL

   333     if ( language !=0 ) {

   334         if ( HAL::Set( HAL::ELanguageIndex, lanCode ) != KErrNone ) {

   335             delete commonEngineRepository;

   336             return false;

   337         }

   338     }

   339     if ( commonEngineRepository->Set( KGSDisplayTxtLang, lanCode ) != KErrNone ) {

   340         delete commonEngineRepository;

   341         return false;

   342     }

   343     delete commonEngineRepository;

   344     return true;

   345 

   352 #if defined(Q_OS_SYMBIAN)  

   342 /*!

   353 /*!

   343     

   354     \brief reads the regions.txt file and reads the list of symbian region codes 

   344     Returns the identifiers of regions supported on the device. The region 

   355 */

   345     identifier is a two-letter ISO 3166 code, for example, "GB" for United 

   356 void readRegions()

   346     Kingdom.

   357 {

   347     

   358     QFile* file = new QFile(REGION_LIST_FILE);

   348     \attention Only fully implemented on the Symbian platform. For other 

   359     if (!file->exists() ) 

   349     platforms, always returns an empty QStringList.

   360     {

   350     

   361         delete file;

   351     \sa localisedRegionName(), currentRegion(), changeRegion()

   362         return;

   352 

   363     }

   364     if (!file->open(QIODevice::ReadOnly | QIODevice::Text))

   365     {

   366         delete file;

   367         return;

   368     } 

   369     QTextStream in(file);

   370     while (!in.atEnd())

   371     {

   372         QString line = in.readLine(256);

   373         if (!line.isEmpty())

   374         {

   375             int regCode = line.toUInt();

   376             regions.append(regCode);

   377         }

   378     }

   379     return;

   380 }

   381 #endif

   382 

   383 /*!

   384     \brief Returns names supported regions in a phone. 

   385     Region names are identified by 2 letter code(ISO 3166 standard).

   386     Ex: For United Kingdom it returns GB 

   387     

   388     \attention Symbian specific API

   389 

   390     \return list of supported regions in a device for Symbian and empty QStringList for other platforms 

   400     if(regions.isEmpty())

   362     QStringList regions; 

   401     {

   363     CArrayFixFlat<TInt>* systemEpocRegionCodes = 0;

   402         readRegions();

   364     TInt error = SysLangUtil::GetInstalledRegions( systemEpocRegionCodes );

   403     }

   365     if ( error != KErrNone ) {

   404     

   366         delete systemEpocRegionCodes;

   405     if(mappingList.isEmpty())

   367         return regions;

   406     {

   368     }

   407         readMappings();

   369     

   408     }

   370     if(mappingList.isEmpty()) {

   409     int regCount = regions.count();

   371         readMappings();

   410     for(int i = 0; i < regCount; i++)

   372     }

   411     {

   373     

   412         int region = regions.at(i);

   374     for (int i = 0; i < systemEpocRegionCodes->Count(); ++i) {

   413         int count = mappingList.count();

   375         int code = systemEpocRegionCodes->At(i);

   414         for (int j = 0; j < count; j++)

   376         for (int j = 0; j < mappingList.count(); ++j) {

   415         {

   377             HbLocaleMapping map = mappingList.at(j);

   416             HbLocaleMapping mapping = mappingList.at(j);

   378             QString dllid = map.regionDllId;

   417             QString regCode = mapping.regionDllId;

   379             bool ok;

   418             if(region == regCode.toUInt())

   380             int symRegionValue = dllid.toInt(&ok,10);

   419             {

   381             if (symRegionValue == code) {

   420                 availRegions.append(mapping.regName);

   382                 availRegions.append(map.regName);

   426 #else

   390 #else 

   432     \brief Converts two letter region identifier to localised region name. 

   396 

   433     

   397     Returns the localised region name for the given two-letter region 

   434     \attention Symbian specific API

   398     identifier. If the translation fails, returns an empty QString.

   435     

   399     

   436     \param region region identifier 

   400     \param region The region identifier that corresponds to one of the following:

   437     

   401     - An identifier returned by supportedRegions() or currentRegion()

   438     \return Symbian - localised name of the region, an empty String if translation fails

   402     - An HbLanguageRegionMapping::regionId string

   439     \return other platforms - empty QString    

   403     

   404     \attention Only fully implemented on the Symbian platform. For other 

   405     platforms, always returns an empty QString.

   406     

   407     \sa currentRegion(), changeRegion()

   408   

   484     \brief Changes the system region.  

   453     Changes the system region to the one specified in \a region.

   485     The region parameter should correspond with one of the identifiers returned by supportedRegions(). 

   454 

   486   

   455     \param region The region identifier. This must correspond to an identifier 

   487     \attention Symbian specific API

   456     returned by supportedRegions(), or an HbLanguageRegionMapping::regionId 

   488 

   457     string.

   489     \param region identifier of region to set active

   458     

   490     

   459     \return \c true if successful, otherwise \c false.

   491     \return true if region change was successful for Symbian and false for other platforms

   460     

   461     \attention Only fully implemented on the Symbian platform. For other 

   462     platforms, always returns \c false.

   463     

   464     \sa localisedRegionName(), currentRegion()

   465     

   496     TExtendedLocale dummy;

   470    

   497     QString regDllName = QString( "elocl_reg." );

   498     

   510             dummy.LoadSystemSettings();

   482             int retVal = -1;

   511             regDllName += mapping.regionDllId;

   483             QString dllid = mapping.regionDllId;

   512             TPtrC nameptr(regDllName.utf16());

   484             bool ok;

   513             TInt err = dummy.LoadLocaleAspect( nameptr );

   485             int regioncode = dllid.toInt(&ok,10);

   514             if( err != KErrNone )

   486             if(!regioncode)

   516             dummy.SaveSystemSettings();

   488             retVal = SysLangUtil::ChangeRegion(regioncode);

   517             // cause localeprivate update on next qlocale object

   489             if(retVal != 0)

   518             QSystemLocale dummy2;

   490                 return false;

   519             return true; 

   491             else

   492                 return true;

   530     \brief Return identifier of the current region.

   503     

   531 

   504     Returns the identifier of the current region. The region identifier is a 

   532     \attention Symbian specific API

   505     two-letter ISO 3166 code, for example, "GB" for United Kingdom.

   533 

   506 

   534     \return identifier of the region for Symbian and empty QString for other platforms

   507     \attention Only fully implemented on the Symbian platform. For other 

   508     platforms, always returns an empty QString.

   509     

   510     \sa supportedRegions(), localisedRegionName(), changeRegion(), languageRegionMappings()

   511 

   558 #if defined(Q_OS_SYMBIAN)      

   535 /*!

   559 /*!

   536     

   560     \brief reads the collations.txt file and reads the list of symbian collation codes 

   537     Returns the identifiers of the collations supported on a device. Typically 

   561 */

   538     the collation identifier is an ISO 639 language code, but in some cases, it 

   562 void readCollations()

   539     is a combination of an ISO 639 language code and an ISO 3166 country code. 

   563 {

   540     For example, for UK English, this returns "en", and for US English, this 

   564     QFile* file = new QFile(COLLATION_LIST_FILE);

   541     returns "en_US".

   565     if (!file->exists() ) 

   542     

   566     {

   543     \attention Only fully implemented on the Symbian platform. For other 

   567         delete file;

   544     platforms, always returns an empty QStringList.

   568         return ;

   545     

   569     }

   546     \sa localisedCollationName(), currentCollation(), changeCollation()

   570     if (!file->open(QIODevice::ReadOnly | QIODevice::Text))

   547  

   571     {

   572         delete file;

   573         return ;

   574     } 

   575     QTextStream in(file);

   576     while (!in.atEnd())

   577     {

   578         QString line = in.readLine(256);

   579         if (!line.isEmpty())

   580         {

   581             int colCode = line.toUInt();

   582             collations.append(colCode);

   583         }

   584     }

   585     return ;

   586 }

   587 #endif

   588 

   589 /*!

   590     \brief Returns identifiers of collations supported in a device. 

   591     Collation identifier may be two-letter ISO 639 language code or combination of ISO 639 language code and ISO 3166 country code 

   592     Ex: Great Britain english it returns "en".

   593     Ex: For U.S. english it returns "en_US"  

   594     

   595     \attention Symbian specific API

   596 

   597     \return identifiers of supported collations for Symbian and empty QStringList for other platforms 

   607     if(collations.isEmpty())

   557     QStringList collations; 

   608     {

   558     CArrayFixFlat<TInt>* systemEpocCollationCodes = 0;

   609         readCollations();

   559     TInt error = SysLangUtil::GetInstalledCollations( systemEpocCollationCodes );

   610     }

   560     if ( error != KErrNone ) {

   611     

   561         delete systemEpocCollationCodes;

   612     if(mappingList.isEmpty())

   562         return collations;

   613     {

   563     }

   614         readMappings();

   564     

   615     }

   565     if(mappingList.isEmpty()) {

   616     int colCount = collations.count();

   566         readMappings();

   617     for(int i = 0; i < colCount; i++)

   567     }

   618     {

   568     

   619         int collation = collations.at(i);

   569     for (int i = 0; i < systemEpocCollationCodes->Count(); ++i) {

   620         int count = mappingList.count();

   570         int code = systemEpocCollationCodes->At(i);

   621         for (int j = 0; j < count; j++)

   571         for (int j = 0; j < mappingList.count(); ++j) {

   622         {

   572             HbLocaleMapping map = mappingList.at(j);

   623             HbLocaleMapping mapping = mappingList.at(j);

   573             bool ok;

   624             QString colCode = mapping.collationDllId;

   574             int symCollatValue = map.collationDllId.toInt(&ok,10);

   625             if(collation == colCode.toUInt())

   575             if (symCollatValue == code) {

   626             {

   576                 availCollations.append(map.collName);

   627                 availCollations.append(mapping.collName);

   633 #else

   584 #else 

   639     \brief Converts collation identifier to localised collation name. 

   590     

   640     

   591     Returns the localised collation name for the given collation identifier. If 

   641     \attention Symbian specific API

   592     the translation fails, returns an empty QString.

   642     

   593     

   643     \param collation region collation identifier 

   594     \param collation The region collation identifier that corresponds to one of the following:

   644     

   595     - An identifier returned by supportedCollations() or currentCollation()

   645     \return Symbian - localised name of the collation, an empty String if translation fails

   596     - An HbLanguageRegionMapping::collationId string

   646     \return other platforms - empty QString    

   597     

   598     \attention Only fully implemented on the Symbian platform. For other 

   599     platforms, always returns an empty QString.

   600     

   601     \sa currentCollation(), changeCollation()

   602   

   691     \brief Changes the system collation.  

   647     

   692     The collation parameter should correspond with one of the identifiers returned by supportedCollations(). 

   648     Changes the system collation to the one specified in \a collation.

   693   

   649     

   694     \attention Symbian specific API

   650     \param collation The collation identifier. This must correspond to an 

   695     

   651     identifier returned by supportedCollations(), or an 

   696     \param collation identifier of collation to set active

   652     HbLanguageRegionMapping::collationId string.

   697     \return true if collation change was successful for Symbian and false for other platforms

   653     

   654     \return \c true if successful, otherwise \c false.

   655     

   656     \attention Only fully implemented on the Symbian platform. For other 

   657     platforms, always returns \c false.

   658     

   659     \sa localisedCollationName(), currentCollation()

   716             dummy.LoadSystemSettings();

   676             int retVal = -1;

   717             colDllName += mapping.collationDllId;

   677             QString dllid = mapping.collationDllId;

   718             TPtrC nameptr(colDllName.utf16());

   678             bool ok;

   719             TInt err = dummy.LoadLocaleAspect( nameptr );

   679             int collCode = dllid.toInt(&ok,10);

   720             if( err != KErrNone )

   680             if(!collCode)

   722             dummy.SaveSystemSettings();

   682             retVal = SysLangUtil::ChangeCollation(collCode);

   723             // cause localeprivate update on next qlocale object

   683             if(retVal != 0)

   724             QSystemLocale dummy2;

   684                 return false;

   725             return true; 

   685             else

   686                 return true;

   736     \brief Return identifier of the current collation.

   697     

   737 

   698     Returns the identifier of the current collation. Typically the collation 

   738     \attention Symbian specific API

   699     identifier is an ISO 639 language code, but in some cases, it is a 

   739     

   700     combination of an ISO 639 language code and an ISO 3166 country code. For 

   740     \return identifier of the collation for Symbian and empty QString for other platforms

   701     example, for UK English, this returns "en", and for US English, this returns 

   702     "en_US".

   703 

   704     \attention Only fully implemented on the Symbian platform. For other 

   705     platforms, always returns an empty QString.

   706     

   707     \sa supportedCollations(), localisedCollationName(), changeCollation(), languageRegionMappings()

   777     \brief Changes the system language, region and collation.  

   744 

   778     The language parameter should correspond with one of the identifiers returned by supportedLanguages(). 

   745     Changes the system language, region and collation as specified by \a 

   779     Proper region and collation is selected automatically according the language.  

   746     language. The region and collation are selected automatically based on the 

   747     specified language.

   748 

   749     \param language The language identifier. This must correspond to an 

   750     identifier returned by supportedLanguages(), or an 

   751     HbLanguageRegionMapping::languageId string.

   781     \attention Symbian specific API

   753     \return \c true if successful, otherwise \c false.

   782     

   754     

   783     \param language identifier of language which language, region and collation settings should set active  

   755     \attention Only fully implemented on the Symbian platform. For other 

   784     

   756     platforms, always returns \c false.

   785     \return Symbian - true if language, region and collation change was successful

   757     

   786     \return other platforms - false    

   758     \sa supportedRegions(), supportedCollations(), languageRegionMappings()

   759