QLocale Class Reference

 #include <QLocale>

 QLocale egyptian(QLocale::Arabic, QLocale::Egypt);
 QString s1 = egyptian.toString(1.571429E+07, 'e');
 QString s2 = egyptian.toString(10);

 double d = egyptian.toDouble(s1);
 int i = egyptian.toInt(s2);

 QLocale::setDefault(QLocale(QLocale::Hebrew, QLocale::Israel));
 QLocale hebrew; // Constructs a default QLocale
 QString s1 = hebrew.toString(15714.3, 'e');

 bool ok;
 double d;

 QLocale::setDefault(QLocale::C);
 d = QString("1234,56").toDouble(&ok);   // ok == false
 d = QString("1234.56").toDouble(&ok);   // ok == true, d == 1234.56

 QLocale::setDefault(QLocale::German);
 d = QString("1234,56").toDouble(&ok);   // ok == true, d == 1234.56
 d = QString("1234.56").toDouble(&ok);   // ok == true, d == 1234.56

 QLocale::setDefault(QLocale(QLocale::English, QLocale::UnitedStates));
 str = QString("%1 %L2 %L3")
       .arg(12345).arg(12345).arg(12345, 0, 16);
 // str == "12345 12,345 3039"

 QLocale korean("ko");
 QLocale swiss("de_CH");

Member Function Documentation

QLocale::QLocale ()

Constructs a QLocale object initialized with the default locale. If no default locale was set using setDefaultLocale(), this locale will be the same as the one returned by system().

See also setDefault().

QLocale::QLocale ( const QString & name )

Constructs a QLocale object with the specified name, which has the format "language[_script][_country][.codeset][@modifier]" or "C", where:

• language is a lowercase, two-letter, ISO 639 language code,
• script is a titlecase, four-letter, ISO 15924 script code,
• country is an uppercase, two- or three-letter, ISO 3166 country code (also "419" as defined by United Nations),
• and codeset and modifier are ignored.

The separator can be either underscore or a minus sign.

If the string violates the locale format, or language is not a valid ISO 369 code, the "C" locale is used instead. If country is not present, or is not a valid ISO 3166 code, the most appropriate country is chosen for the specified language.

The language, script and country codes are converted to their respective Language, Script and Country enums. After this conversion is performed the constructor behaves exactly like QLocale(Country, Script, Language).

This constructor is much slower than QLocale(Country, Script, Language).

See also bcp47Name().

QLocale::QLocale ( Language language, Country country = AnyCountry )

Constructs a QLocale object with the specified language and country.

• If the language/country pair is found in the database, it is used.
• If the language is found but the country is not, or if the country is AnyCountry, the language is used with the most appropriate available country (for example, Germany for German),
• If neither the language nor the country are found, QLocale defaults to the default locale (see setDefault()).

The language and country that are actually used can be queried using language() and country().

See also setDefault(), language(), and country().

QLocale::QLocale ( Language language, Script script, Country country )

Constructs a QLocale object with the specified language, script and country.

• If the language/script/country is found in the database, it is used.
• If both script is AnyScript and country is AnyCountry, the language is used with the most appropriate available script and country (for example, Germany for German),
• If either script is AnyScript or country is AnyCountry, the language is used with the first locale that matches the given script and country.
• If neither the language nor the country are found, QLocale defaults to the default locale (see setDefault()).

The language, script and country that are actually used can be queried using language(), script() and country().

This function was introduced in Qt 4.8.

See also setDefault(), language(), script(), and country().

QLocale::QLocale ( const QLocale & other )

Constructs a QLocale object as a copy of other.

QString QLocale::amText () const

Returns the localized name of the "AM" suffix for times specified using the conventions of the 12-hour clock.

This function was introduced in Qt 4.5.

See also pmText().

QString QLocale::bcp47Name () const

Returns the dash-separated language, script and country (and possibly other BCP47 fields) of this locale as a string.

Unlike the uiLanguages() the returned value of the bcp47Name() represents the locale name of the QLocale data but not the language the user-interface should be in.

This function tries to conform the locale name to BCP47.

This function was introduced in Qt 4.8.

See also language(), country(), script(), and uiLanguages().

QLocale QLocale::c () [static]

Returns a QLocale object initialized to the "C" locale.

See also system().

Country QLocale::country () const

Returns the country of this locale.

See also language(), script(), countryToString(), and bcp47Name().

QString QLocale::countryToString ( Country country ) [static]

Returns a QString containing the name of country.

See also languageToString(), scriptToString(), country(), and bcp47Name().

QString QLocale::createSeparatedList ( const QStringList & list ) const

Returns a string that represents a join of a given list of strings with a separator defined by the locale.

This function was introduced in Qt 4.8.

QString QLocale::currencySymbol ( CurrencySymbolFormat format = CurrencySymbol ) const

Returns a currency symbol according to the format.

This function was introduced in Qt 4.8.

QString QLocale::dateFormat ( FormatType format = LongFormat ) const

Returns the date format used for the current locale.

If format is LongFormat the format will be a long version. Otherwise it uses a shorter version.

This function was introduced in Qt 4.1.

See also QDate::toString() and QDate::fromString().

QString QLocale::dateTimeFormat ( FormatType format = LongFormat ) const

Returns the date time format used for the current locale.

If format is ShortFormat the format will be a short version. Otherwise it uses a longer version.

This function was introduced in Qt 4.4.

See also QDateTime::toString() and QDateTime::fromString().

QString QLocale::dayName ( int day, FormatType type = LongFormat ) const

Returns the localized name of the day (where 1 represents Monday, 2 represents Tuesday and so on), in the format specified by type.

This function was introduced in Qt 4.2.

See also monthName() and standaloneDayName().

QChar QLocale::decimalPoint () const

Returns the decimal point character of this locale.

This function was introduced in Qt 4.1.

QChar QLocale::exponential () const

Returns the exponential character of this locale.

This function was introduced in Qt 4.1.

Qt::DayOfWeek QLocale::firstDayOfWeek () const

Returns the first day of the week according to the current locale.

This function was introduced in Qt 4.8.

QChar QLocale::groupSeparator () const

Returns the group separator character of this locale.

This function was introduced in Qt 4.1.

Language QLocale::language () const

Returns the language of this locale.

See also script(), country(), languageToString(), and bcp47Name().

QString QLocale::languageToString ( Language language ) [static]

Returns a QString containing the name of language.

See also countryToString(), scriptToString(), and bcp47Name().

QList<QLocale> QLocale::matchingLocales ( QLocale::Language language, QLocale::Script script, QLocale::Country country ) [static]

Returns a list of valid locale objects that match the given language, script and country.

Getting a list of all locales: QList<QLocale> allLocales = QLocale::matchingLocales(QLocale::AnyLanguage, QLocale::AnyScript, QLocale::AnyCountry);

This function was introduced in Qt 4.8.

MeasurementSystem QLocale::measurementSystem () const

Returns the measurement system for the locale.

This function was introduced in Qt 4.4.

QString QLocale::monthName ( int month, FormatType type = LongFormat ) const

Returns the localized name of month, in the format specified by type.

This function was introduced in Qt 4.2.

See also dayName() and standaloneMonthName().

QString QLocale::name () const

Returns the language and country of this locale as a string of the form "language_country", where language is a lowercase, two-letter ISO 639 language code, and country is an uppercase, two- or three-letter ISO 3166 country code.

Note that even if QLocale object was constructed with an explicit script, name() will not contain it for compatibility reasons. Use bcp47Name() instead if you need a full locale name.

See also QLocale(), language(), script(), country(), and bcp47Name().

QString QLocale::nativeCountryName () const

Returns a native name of the country for the locale. For example "España" for Spanish/Spain locale.

This function was introduced in Qt 4.8.

See also nativeLanguageName() and countryToString().

QString QLocale::nativeLanguageName () const

Returns a native name of the language for the locale. For example "Schwiizertüütsch" for Swiss-German locale.

This function was introduced in Qt 4.8.

See also nativeCountryName() and languageToString().

QChar QLocale::negativeSign () const

Returns the negative sign character of this locale.

This function was introduced in Qt 4.1.

NumberOptions QLocale::numberOptions () const

Returns the options related to number conversions for this QLocale instance.

By default, no options are set for the standard locales.

This function was introduced in Qt 4.2.

See also setNumberOptions().

QChar QLocale::percent () const

Returns the percent character of this locale.

This function was introduced in Qt 4.1.

QString QLocale::pmText () const

Returns the localized name of the "PM" suffix for times specified using the conventions of the 12-hour clock.

This function was introduced in Qt 4.5.

See also amText().

QChar QLocale::positiveSign () const

Returns the positive sign character of this locale.

This function was introduced in Qt 4.5.

QString QLocale::quoteString ( const QString & str, QuotationStyle style = StandardQuotation ) const

Returns str quoted according to the current locale using the given quotation style.

This function was introduced in Qt 4.8.

QString QLocale::quoteString ( const QStringRef & str, QuotationStyle style = StandardQuotation ) const

This is an overloaded function.

This function was introduced in Qt 4.8.

Script QLocale::script () const

Returns the script of this locale.

This function was introduced in Qt 4.8.

See also language(), country(), languageToString(), scriptToString(), and bcp47Name().

QString QLocale::scriptToString ( Script script ) [static]

Returns a QString containing the name of script.

This function was introduced in Qt 4.8.

See also languageToString(), countryToString(), script(), and bcp47Name().

void QLocale::setDefault ( const QLocale & locale ) [static]

Sets the global default locale to locale. These values are used when a QLocale object is constructed with no arguments. If this function is not called, the system's locale is used.

Warning: In a multithreaded application, the default locale should be set at application startup, before any non-GUI threads are created.

Warning: This function is not reentrant.

See also system() and c().

void QLocale::setNumberOptions ( NumberOptions options )

Sets the options related to number conversions for this QLocale instance.

This function was introduced in Qt 4.2.

See also numberOptions().

QString QLocale::standaloneDayName ( int day, FormatType type = LongFormat ) const

Returns the localized name of the day (where 1 represents Monday, 2 represents Tuesday and so on) that is used as a standalone text, in the format specified by type.

If the locale information does not specify the standalone day name then return value is the same as in dayName().

This function was introduced in Qt 4.5.

See also dayName() and standaloneMonthName().

QString QLocale::standaloneMonthName ( int month, FormatType type = LongFormat ) const

Returns the localized name of month that is used as a standalone text, in the format specified by type.

If the locale information doesn't specify the standalone month name then return value is the same as in monthName().

This function was introduced in Qt 4.5.

See also monthName() and standaloneDayName().

QLocale QLocale::system () [static]

Returns a QLocale object initialized to the system locale.

On Windows and Mac, this locale will use the decimal/grouping characters and date/time formats specified in the system configuration panel.

See also c().

Qt::LayoutDirection QLocale::textDirection () const

Returns the text direction of the language.

This function was introduced in Qt 4.7.

QString QLocale::timeFormat ( FormatType format = LongFormat ) const

Returns the time format used for the current locale.

If format is LongFormat the format will be a long version. Otherwise it uses a shorter version.

This function was introduced in Qt 4.1.

See also QTime::toString() and QTime::fromString().

QString QLocale::toCurrencyString ( qlonglong value, const QString & symbol = QString() ) const

Returns a localized string representation of value as a currency. If the symbol is provided it is used instead of the default currency symbol.

This function was introduced in Qt 4.8.

See also currencySymbol().

QString QLocale::toCurrencyString ( short value, const QString & symbol = QString() ) const

This is an overloaded function.

This function was introduced in Qt 4.8.

QString QLocale::toCurrencyString ( ushort value, const QString & symbol = QString() ) const

This is an overloaded function.

This function was introduced in Qt 4.8.

QString QLocale::toCurrencyString ( int value, const QString & symbol = QString() ) const

This is an overloaded function.

This function was introduced in Qt 4.8.

QString QLocale::toCurrencyString ( uint value, const QString & symbol = QString() ) const

This is an overloaded function.

This function was introduced in Qt 4.8.

QString QLocale::toCurrencyString ( float value, const QString & symbol = QString() ) const

This is an overloaded function.

This function was introduced in Qt 4.8.

QString QLocale::toCurrencyString ( qulonglong value, const QString & symbol = QString() ) const

This is an overloaded function.

This function was introduced in Qt 4.8.

QString QLocale::toCurrencyString ( double value, const QString & symbol = QString() ) const

This is an overloaded function.

This function was introduced in Qt 4.8.

QDate QLocale::toDate ( const QString & string, FormatType format = LongFormat ) const

Parses the date string given in string and returns the date. The format of the date string is chosen according to the format parameter (see dateFormat()).

If the date could not be parsed, returns an invalid date.

This function was introduced in Qt 4.4.

See also dateFormat(), toTime(), toDateTime(), and QDate::fromString().

QDate QLocale::toDate ( const QString & string, const QString & format ) const

Parses the date string given in string and returns the date. See QDate::fromString() for information on the expressions that can be used with this function.

This function searches month names and the names of the days of the week in the current locale.

If the date could not be parsed, returns an invalid date.

This function was introduced in Qt 4.4.

See also dateFormat(), toTime(), toDateTime(), and QDate::fromString().

QDateTime QLocale::toDateTime ( const QString & string, FormatType format = LongFormat ) const

Parses the date/time string given in string and returns the time. The format of the date/time string is chosen according to the format parameter (see dateTimeFormat()).

If the string could not be parsed, returns an invalid QDateTime.

This function was introduced in Qt 4.4.

See also dateTimeFormat(), toTime(), toDate(), and QDateTime::fromString().

QDateTime QLocale::toDateTime ( const QString & string, const QString & format ) const

Parses the date/time string given in string and returns the time. See QDateTime::fromString() for information on the expressions that can be used with this function.

Note: The month and day names used must be given in the user's local language.

If the string could not be parsed, returns an invalid QDateTime.

This function was introduced in Qt 4.4.

See also dateTimeFormat(), toTime(), toDate(), and QDateTime::fromString().

double QLocale::toDouble ( const QString & s, bool * ok = 0 ) const

Returns the double represented by the localized string s, or 0.0 if the conversion failed.

If ok is not 0, reports failure by setting *ok to false and success by setting *ok to true.

Unlike QString::toDouble(), this function does not fall back to the "C" locale if the string cannot be interpreted in this locale.

 bool ok;
 double d;

 QLocale c(QLocale::C);
 d = c.toDouble( "1234.56", &ok );  // ok == true, d == 1234.56
 d = c.toDouble( "1,234.56", &ok ); // ok == true, d == 1234.56
 d = c.toDouble( "1234,56", &ok );  // ok == false

 QLocale german(QLocale::German);
 d = german.toDouble( "1234,56", &ok );  // ok == true, d == 1234.56
 d = german.toDouble( "1.234,56", &ok ); // ok == true, d == 1234.56
 d = german.toDouble( "1234.56", &ok );  // ok == false

 d = german.toDouble( "1.234", &ok );    // ok == true, d == 1234.0

Notice that the last conversion returns 1234.0, because '.' is the thousands group separator in the German locale.

This function ignores leading and trailing whitespace.

See also toFloat(), toInt(), and toString().

float QLocale::toFloat ( const QString & s, bool * ok = 0 ) const

Returns the float represented by the localized string s, or 0.0 if the conversion failed.

If ok is not 0, reports failure by setting *ok to false and success by setting *ok to true.

This function ignores leading and trailing whitespace.

See also toDouble(), toInt(), and toString().

int QLocale::toInt ( const QString & s, bool * ok = 0, int base = 0 ) const

Returns the int represented by the localized string s, using base base. If base is 0 the base is determined automatically using the following rules: If the string begins with "0x", it is assumed to be hexadecimal; if it begins with "0", it is assumed to be octal; otherwise it is assumed to be decimal.

If the conversion fails the function returns 0.

If ok is not 0, failure is reported by setting *ok to false, and success by setting *ok to true.

This function ignores leading and trailing whitespace.

See also toUInt() and toString().

qlonglong QLocale::toLongLong ( const QString & s, bool * ok = 0, int base = 0 ) const

Returns the long long int represented by the localized string s, using base base. If base is 0 the base is determined automatically using the following rules: If the string begins with "0x", it is assumed to be hexadecimal; if it begins with "0", it is assumed to be octal; otherwise it is assumed to be decimal.

If the conversion fails the function returns 0.

If ok is not 0, failure is reported by setting *ok to false, and success by setting *ok to true.

This function ignores leading and trailing whitespace.

See also toInt(), toULongLong(), toDouble(), and toString().

QString QLocale::toLower ( const QString & str ) const

Returns a lowercase copy of str.

This function was introduced in Qt 4.8.

short QLocale::toShort ( const QString & s, bool * ok = 0, int base = 0 ) const

Returns the short int represented by the localized string s, using base base. If base is 0 the base is determined automatically using the following rules: If the string begins with "0x", it is assumed to be hexadecimal; if it begins with "0", it is assumed to be octal; otherwise it is assumed to be decimal.

If the conversion fails the function returns 0.

If ok is not 0, failure is reported by setting *ok to false, and success by setting *ok to true.

This function ignores leading and trailing whitespace.

See also toUShort() and toString().

QString QLocale::toString ( qlonglong i ) const

Returns a localized string representation of i.

See also toLongLong().

QString QLocale::toString ( const QDate & date, const QString & format ) const

Returns a localized string representation of the given date in the specified format. If format is an empty string, an empty string is returned.

QString QLocale::toString ( const QDate & date, FormatType format = LongFormat ) const

Returns a localized string representation of the given date according to the specified format.

QString QLocale::toString ( const QTime & time, const QString & format ) const

Returns a localized string representation of the given time according to the specified format. If format is an empty string, an empty string is returned.

QString QLocale::toString ( const QTime & time, FormatType format = LongFormat ) const

Returns a localized string representation of the given time in the specified format.

QString QLocale::toString ( const QDateTime & dateTime, FormatType format = LongFormat ) const

Returns a localized string representation of the given dateTime according to the specified format.

This function was introduced in Qt 4.4.

QString QLocale::toString ( const QDateTime & dateTime, const QString & format ) const

Returns a localized string representation of the given dateTime according to the specified format. If format is an empty string, an empty string is returned.

This function was introduced in Qt 4.4.

QString QLocale::toString ( short i ) const

This is an overloaded function.

See also toShort().

QString QLocale::toString ( ushort i ) const

This is an overloaded function.

See also toUShort().

QString QLocale::toString ( int i ) const

This is an overloaded function.

See also toInt().

QString QLocale::toString ( uint i ) const

This is an overloaded function.

See also toUInt().

QString QLocale::toString ( float i, char f = 'g', int prec = 6 ) const

This is an overloaded function.

f and prec have the same meaning as in QString::number(double, char, int).

See also toDouble().

QString QLocale::toString ( qulonglong i ) const

This is an overloaded function.

See also toULongLong().

QString QLocale::toString ( double i, char f = 'g', int prec = 6 ) const

This is an overloaded function.

f and prec have the same meaning as in QString::number(double, char, int).

See also toDouble().

QTime QLocale::toTime ( const QString & string, FormatType format = LongFormat ) const

Parses the time string given in string and returns the time. The format of the time string is chosen according to the format parameter (see timeFormat()).

If the time could not be parsed, returns an invalid time.

This function was introduced in Qt 4.4.

See also timeFormat(), toDate(), toDateTime(), and QTime::fromString().

QTime QLocale::toTime ( const QString & string, const QString & format ) const

Parses the time string given in string and returns the time. See QTime::fromString() for information on what is a valid format string.

If the time could not be parsed, returns an invalid time.

This function was introduced in Qt 4.4.

See also timeFormat(), toDate(), toDateTime(), and QTime::fromString().

uint QLocale::toUInt ( const QString & s, bool * ok = 0, int base = 0 ) const

Returns the unsigned int represented by the localized string s, using base base. If base is 0 the base is determined automatically using the following rules: If the string begins with "0x", it is assumed to be hexadecimal; if it begins with "0", it is assumed to be octal; otherwise it is assumed to be decimal.

If the conversion fails the function returns 0.

If ok is not 0, failure is reported by setting *ok to false, and success by setting *ok to true.

This function ignores leading and trailing whitespace.

See also toInt() and toString().

qlonglong QLocale::toULongLong ( const QString & s, bool * ok = 0, int base = 0 ) const

Returns the unsigned long long int represented by the localized string s, using base base. If base is 0 the base is determined automatically using the following rules: If the string begins with "0x", it is assumed to be hexadecimal; if it begins with "0", it is assumed to be octal; otherwise it is assumed to be decimal.

If the conversion fails the function returns 0.

If ok is not 0, failure is reported by setting *ok to false, and success by setting *ok to true.

This function ignores leading and trailing whitespace.

See also toLongLong(), toInt(), toDouble(), and toString().

ushort QLocale::toUShort ( const QString & s, bool * ok = 0, int base = 0 ) const

Returns the unsigned short int represented by the localized string s, using base base. If base is 0 the base is determined automatically using the following rules: If the string begins with "0x", it is assumed to be hexadecimal; if it begins with "0", it is assumed to be octal; otherwise it is assumed to be decimal.

If the conversion fails the function returns 0.

If ok is not 0, failure is reported by setting *ok to false, and success by setting *ok to true.

This function ignores leading and trailing whitespace.

See also toShort() and toString().

QString QLocale::toUpper ( const QString & str ) const

Returns an uppercase copy of str.

This function was introduced in Qt 4.8.

QStringList QLocale::uiLanguages () const

Returns an ordered list of locale names for translation purposes in preference order.

The return value represents locale names that the user expects to see the UI translation in.

Most like you do not need to use this function directly, but just pass the QLocale object to the QTranslator::load() function.

The first item in the list is the most preferred one.

This function was introduced in Qt 4.8.

See also QTranslator and bcp47Name().

QList<Qt::DayOfWeek> QLocale::weekdays () const

Returns a list of days that are considered weekdays according to the current locale.

This function was introduced in Qt 4.8.

QChar QLocale::zeroDigit () const

Returns the zero digit character of this locale.

This function was introduced in Qt 4.1.

bool QLocale::operator!= ( const QLocale & other ) const

Returns true if the QLocale object is not the same as the other locale specified; otherwise returns false.

QLocale & QLocale::operator= ( const QLocale & other )

Assigns other to this QLocale object and returns a reference to this QLocale object.

bool QLocale::operator== ( const QLocale & other ) const

Returns true if the QLocale object is the same as the other locale specified; otherwise returns false.