|  | Home · All Classes · Modules

# QTranslator Class Reference
[QtCore module]

The QTranslator class provides internationalization support for text output. More...

Inherits QObject.

### Methods

- __init__ (self, QObject parent = None)
- bool isEmpty (self)
- bool load (self, QString fileName, QString directory = '', QString searchDelimiters = '', QString suffix = '')
- bool load (self, QLocale locale, QString fileName, QString prefix = '', QString directory = '', QString suffix = '')
- bool loadFromData (self, bytes data)
- QString translate (self, str context, str sourceText, str disambiguation = None)
- QString translate (self, str context, str sourceText, str comment, int n)

## Detailed Description

The QTranslator class provides internationalization support for text output.

An object of this class contains a set of translations from a source language to a target language. QTranslator provides functions to look up translations in a translation file. Translation files are created using Qt Linguist.

The most common use of QTranslator is to: load a translation file, install it using QApplication.installTranslator(), and use it via QObject.tr(). Here's the `main()` function from the Hello tr() example:

     int main(int argc, char *argv[])
     {
         QApplication app(argc, argv);

         QTranslator translator;
         translator.load("hellotr_la");
         app.installTranslator(&translator);

         QPushButton hello(QPushButton.tr("Hello world!"));
         hello.resize(100, 30);

         hello.show();
         return app.exec();
     }

Note that the translator must be created before the application's widgets.

Most applications will never need to do anything else with this class. The other functions provided by this class are useful for applications that work on translator files.

### Looking up Translations

It is possible to look up a translation using translate() (as tr() and QApplication.translate() do). The translate() function takes up to three parameters:

- The context - usually the class name for the tr() caller.
- The source text - usually the argument to tr().
- The disambiguation - an optional string that helps disambiguate different uses of the same text in the same context.

For example, the "Cancel" in a dialog might have "Anuluj" when the program runs in Polish (in this case the source text would be "Cancel"). The context would (normally) be the dialog's class name; there would normally be no comment, and the translated text would be "Anuluj".

But it's not always so simple. The Spanish version of a printer dialog with settings for two-sided printing and binding would probably require both "Activado" and "Activada" as translations for "Enabled". In this case the source text would be "Enabled" in both cases, and the context would be the dialog's class name, but the two items would have disambiguations such as "two-sided printing" for one and "binding" for the other. The disambiguation enables the translator to choose the appropriate gender for the Spanish version, and enables Qt to distinguish between translations.

### Using Multiple Translations

Multiple translation files can be installed in an application. Translations are searched for in the reverse order in which they were installed, so the most recently installed translation file is searched for translations first and the earliest translation file is searched last. The search stops as soon as a translation containing a matching string is found.

This mechanism makes it possible for a specific translation to be "selected" or given priority over the others; simply uninstall the translator from the application by passing it to the QApplication.removeTranslator() function and reinstall it with QApplication.installTranslator(). It will then be the first translation to be searched for matching strings.

## Method Documentation

### QTranslator.__init__ (self, QObject parent = None)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

Constructs an empty message file object with parent parent that is not connected to any file.

### bool QTranslator.isEmpty (self)

Returns true if this translator is empty, otherwise returns false. This function works with stripped and unstripped translation files.

### bool QTranslator.load (self, QString fileName, QString directory = '', QString searchDelimiters = '', QString suffix = '')

Loads filename + suffix (".qm" if the suffix is not specified), which may be an absolute file name or relative to directory. Returns true if the translation is successfully loaded; otherwise returns false.

If directory is not specified, the directory of the application's executable is used (i.e., as applicationDirPath()).

The previous contents of this translator object are discarded.

If the file name does not exist, other file names are tried in the following order:

1. File name without suffix appended.
2. File name with text after a character in search_delimiters stripped ("_." is the default for search_delimiters if it is an empty string) and suffix.
3. File name stripped without suffix appended.
4. File name stripped further, etc.

For example, an application running in the fr_CA locale (French-speaking Canada) might call load("foo.fr_ca", "/opt/foolib"). load() would then try to open the first existing readable file from this list:

1. `/opt/foolib/foo.fr_ca.qm`
2. `/opt/foolib/foo.fr_ca`
3. `/opt/foolib/foo.fr.qm`
4. `/opt/foolib/foo.fr`
5. `/opt/foolib/foo.qm`
6. `/opt/foolib/foo`

### bool QTranslator.load (self, QLocale locale, QString fileName, QString prefix = '', QString directory = '', QString suffix = '')

Loads filename + prefix + ui language name + suffix (".qm" if the suffix is not specified), which may be an absolute file name or relative to directory. Returns true if the translation is successfully loaded; otherwise returns false.

The previous contents of this translator object are discarded.

If the file name does not exist, other file names are tried in the following order:

1. File name without suffix appended.
2. File name with ui language part after a "_" character stripped and suffix.
3. File name with ui language part stripped without suffix appended.
4. File name with ui language part stripped further, etc.

For example, an application running in the locale with the following ui languages - "es", "fr-CA", "de" might call load(QLocale.system(), "foo", ".", "/opt/foolib", ".qm"). load() would replace '-' (dash) with '_' (underscore) in the ui language and then try to open the first existing readable file from this list:

1. `/opt/foolib/foo.es.qm`
2. `/opt/foolib/foo.es`
3. `/opt/foolib/foo.fr_CA.qm`
4. `/opt/foolib/foo.fr_CA`
5. `/opt/foolib/foo.de.qm`
6. `/opt/foolib/foo.de`
7. `/opt/foolib/foo.fr.qm`
8. `/opt/foolib/foo.fr`
9. `/opt/foolib/foo.qm`
10. `/opt/foolib/foo`.
11. `/opt/foolib/foo`

On operating systems where file system is case sensitive, QTranslator also tries to load a lower-cased version of the locale name.

This function was introduced in Qt 4.8.

### bool QTranslator.loadFromData (self, bytes data)

### QString QTranslator.translate (self, str context, str sourceText, str disambiguation = None)

Returns the translation for the key (context, sourceText, disambiguation). If none is found, also tries (context, sourceText, ""). If that still fails, returns an empty string.

If you need to programatically insert translations in to a QTranslator, this function can be reimplemented.

See also load().

### QString QTranslator.translate (self, str context, str sourceText, str comment, int n)

This function overloads translate().

Returns the translation for the key (context, sourceText, disambiguation). If none is found, also tries (context, sourceText, ""). If that still fails, returns an empty string.

If n is not -1, it is used to choose an appropriate form for the translation (e.g. "%n file found" vs. "%n files found").

See also load().