Home · All Classes · Modules

QLocale Class Reference
^{[QtCore module]}

The QLocale class converts between numbers and their string representations in various languages. More...

Types

• enum Country { AnyCountry, Afghanistan, Albania, Algeria, ..., LastCountry }
• enum FormatType { LongFormat, ShortFormat }
• enum Language { C, Abkhazian, Afan, Afar, ..., Chewa }
• enum NumberOption { OmitGroupSeparator, RejectGroupSeparator }
• class NumberOptions

Methods

• __init__ (self)
• __init__ (self, QString name)
• __init__ (self, Language language, Country country = QLocale.AnyCountry)
• __init__ (self, QLocale other)
• Country country (self)
• QString dateFormat (self, FormatType format = QLocale.LongFormat)
• QString dayName (self, int, FormatType format = QLocale.LongFormat)
• QChar decimalPoint (self)
• QChar exponential (self)
• QChar groupSeparator (self)
• Language language (self)
• QString monthName (self, int, FormatType format = QLocale.LongFormat)
• QString name (self)
• QChar negativeSign (self)
• NumberOptions numberOptions (self)
• QChar percent (self)
• setNumberOptions (self, NumberOptions options)
• QString timeFormat (self, FormatType format = QLocale.LongFormat)
• (float, bool ok) toDouble (self, QString s)
• (float, bool ok) toFloat (self, QString s)
• (int, bool ok) toInt (self, QString s, int base = 0)
• (long, bool ok) toLongLong (self, QString s, int base = 0)
• (int, bool ok) toShort (self, QString s, int base = 0)
• QString toString (self, int i)
• QString toString (self, float i, char f = 'g', int prec = 6)
• QString toString (self, long i)
• QString toString (self, unsigned long i)
• QString toString (self, QDate date, QString formatStr)
• QString toString (self, QDate date, FormatType format = QLocale.LongFormat)
• QString toString (self, QTime time, QString formatStr)
• QString toString (self, QTime time, FormatType format = QLocale.LongFormat)
• (unsigned long, bool ok) toUInt (self, QString s, int base = 0)
• (long, bool ok) toULongLong (self, QString s, int base = 0)
• (unsigned long, bool ok) toUShort (self, QString s, int base = 0)
• QChar zeroDigit (self)

Static Methods

• QLocale c ()
• QLocale.Country-list countriesForLanguage (Language lang)
• QString countryToString (Country country)
• QString languageToString (Language language)
• setDefault (QLocale locale)
• QLocale system ()

Special Methods

• bool __eq__ (self, QLocale other)
• bool __ne__ (self, QLocale other)

QLocale is initialized with a language/country pair in its constructor and offers number-to-string and string-to-number conversion functions similar to those in QString.

Example:

 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 supports the concept of a default locale, which is determined from the system's locale settings at application startup. The default locale can be changed by calling the static member setDefault(). Setting the default locale has the following effects:

• If a QLocale object is constructed with the default constructor, it will use the default locale's settings.
• QString.toInt(), QString.toDouble(), etc., interpret the string according to the default locale. If this fails, it falls back on the "C" locale.
• QString.arg() uses the default locale to format a number when its position specifier in the format string contains an 'L', e.g. "%L1".

The following example illustrates how to use QLocale directly:

 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"

When a language/country pair is specified in the constructor, one of three things can happen:

• 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 "C" locale is identical to English/UnitedStates.

Use language() and country() to determine the actual language and country values used.

An alternative method for constructing a QLocale object is by specifying the locale name.

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

This constructor converts the locale name to a language/country pair; it does not use the system locale database.

The double-to-string and string-to-double conversion functions are covered by the following licenses:

See also QString.arg(), QString.toInt(), and QString.toDouble().

Type Documentation

QLocale.Country

This enumerated type is used to specify a country.

See also country().

QLocale.FormatType

This enum describes the types of format that can be used when converting QDate and QTime objects to strings.

QLocale.Language

This enumerated type is used to specify a language.

See also language().

QLocale.NumberOption

This enum defines a set of options for number-to-string and string-to-number conversions. They can be retrieved with numberOptions() and set with setNumberOptions().

The NumberOptions type is a typedef for QFlags<NumberOption>. It stores an OR combination of NumberOption values.

See also setNumberOptions() and numberOptions().

Method Documentation

QLocale.__init__ (self)

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.__init__ (self, QString name)

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

• language is a lowercase, two-letter, ISO 639 language code,
• territory is an uppercase, two-letter, ISO 3166 country code,
• and codeset and modifier are ignored.

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 and country codes are converted to their respective Language and Country enums. After this conversion is performed the constructor behaves exactly like QLocale(Country, Language).

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

See also name().

QLocale.__init__ (self, Language language, Country country = QLocale.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.__init__ (self, QLocale other)

Constructs a QLocale object as a copy of other.

QLocale QLocale.c ()

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

See also system().

QLocale.Country-list QLocale.countriesForLanguage (Language lang)

Returns the list of countries that have entires for language in Qt's locale database. If the result is an empty list, then language is not represented in Qt's locale database.

This function was introduced in Qt 4.3.

Country QLocale.country (self)

Returns the country of this locale.

See also language(), countryToString(), and name().

QString QLocale.countryToString (Country country)

Returns a QString containing the name of country.

See also country() and name().

QString QLocale.dateFormat (self, FormatType format = QLocale.LongFormat)

Returns the date 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.1.

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

QString QLocale.dayName (self, int, FormatType format = QLocale.LongFormat)

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

This function was introduced in Qt 4.2.

See also monthName().

QChar QLocale.decimalPoint (self)

Returns the decimal point character of this locale.

This function was introduced in Qt 4.1.

QChar QLocale.exponential (self)

Returns the exponential character of this locale.

This function was introduced in Qt 4.1.

QChar QLocale.groupSeparator (self)

Returns the group separator character of this locale.

This function was introduced in Qt 4.1.

Language QLocale.language (self)

Returns the language of this locale.

See also country(), languageToString(), and name().

QString QLocale.languageToString (Language language)

Returns a QString containing the name of language.

See also countryToString() and name().

QString QLocale.monthName (self, int, FormatType format = QLocale.LongFormat)

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

This function was introduced in Qt 4.2.

See also dayName().

QString QLocale.name (self)

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-letter ISO 3166 country code.

See also language() and country().

QChar QLocale.negativeSign (self)

Returns the negative sign character of this locale.

This function was introduced in Qt 4.1.

NumberOptions QLocale.numberOptions (self)

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 (self)

Returns the percent character of this locale.

This function was introduced in Qt 4.1.

QLocale.setDefault (QLocale locale)

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().

QLocale.setNumberOptions (self, NumberOptions options)

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

This function was introduced in Qt 4.2.

See also numberOptions().

QLocale QLocale.system ()

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 QTextCodec.locale() and c().

QString QLocale.timeFormat (self, FormatType format = QLocale.LongFormat)

Returns the 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.1.

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

(float, bool ok) QLocale.toDouble (self, QString s)

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, bool ok) QLocale.toFloat (self, QString s)

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, bool ok) QLocale.toInt (self, QString s, int base = 0)

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().

(long, bool ok) QLocale.toLongLong (self, QString s, int base = 0)

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().

(int, bool ok) QLocale.toShort (self, QString s, int base = 0)

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 (self, int i)

Returns a localized string representation of i.

See also toLongLong().

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

This is an overloaded member function, provided for convenience.

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 (self, long i)

This is an overloaded member function, provided for convenience.

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

QString QLocale.toString (self, unsigned long i)

This is an overloaded member function, provided for convenience.

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 (self, QDate date, QString formatStr)

This is an overloaded member function, provided for convenience.

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

QString QLocale.toString (self, QDate date, FormatType format = QLocale.LongFormat)

This is an overloaded member function, provided for convenience.

See also toULongLong().

QString QLocale.toString (self, QTime time, QString formatStr)

This is an overloaded member function, provided for convenience.

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

See also toDouble().

QString QLocale.toString (self, QTime time, FormatType format = QLocale.LongFormat)

This is an overloaded member function, provided for convenience.

See also toShort().

(unsigned long, bool ok) QLocale.toUInt (self, QString s, int base = 0)

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().

(long, bool ok) QLocale.toULongLong (self, QString s, int base = 0)

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().

(unsigned long, bool ok) QLocale.toUShort (self, QString s, int base = 0)

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().

QChar QLocale.zeroDigit (self)

Returns the zero digit character of this locale.

This function was introduced in Qt 4.1.

bool QLocale.__eq__ (self, QLocale other)

bool QLocale.__ne__ (self, QLocale other)