QTranslator Class

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

     QTranslator translator;
     // look up e.g. :/i18n/myapp_de.qm
     if (translator.load(QLocale(), QLatin1String("myapp"), QLatin1String("_"), QLatin1String(":/i18n")))
         QCoreApplication::installTranslator(&translator);

     QPushButton hello(QCoreApplication::translate("main", "Hello world!"));
     hello.resize(100, 30);

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

Member Function Documentation

QTranslator::QTranslator(QObject *parent = nullptr)

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

[virtual] QTranslator::~QTranslator()

Destroys the object and frees any allocated resources.

QString QTranslator::filePath() const

Returns the path of the loaded translation file.

The file path is empty if no translation was loaded yet, the loading failed, or if the translation was not loaded from a file.

This function was introduced in Qt 5.15.

[virtual] bool QTranslator::isEmpty() const

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

QString QTranslator::language() const

Returns the target language as stored in the translation file.

This function was introduced in Qt 5.15.

bool QTranslator::load(const QString &filename, const QString &directory = QString(), const QString &search_delimiters = QString(), const QString &suffix = QString())

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 current directory is used (i.e., as currentPath()).

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

Usually, it is better to use the QTranslator::load(const QLocale &, const QString &, const QString &, const QString &, const QString &) function instead, because it uses QLocale::uiLanguages() and not simply the locale name, which refers to the formatting of dates and numbers and not necessarily the UI language.

bool QTranslator::load(const QLocale &locale, const QString &filename, const QString &prefix = QString(), const QString &directory = QString(), const QString &suffix = QString())

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(), "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.fr.qm
6. /opt/foolib/foo.fr
7. /opt/foolib/foo.de.qm
8. /opt/foolib/foo.de
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::load(const uchar *data, int len, const QString &directory = QString())

This function overloads load().

Loads the QM file data data of length len into the translator.

The data is not copied. The caller must be able to guarantee that data will not be deleted or modified.

directory is only used to specify the base directory when loading the dependencies of a QM file. If the file does not have dependencies, this argument is ignored.

[virtual] QString QTranslator::translate(const char *context, const char *sourceText, const char *disambiguation = nullptr, int n = -1) const

Returns the translation for the key (context, sourceText, disambiguation). If none is found, also tries (context, sourceText, ""). If that still fails, returns a null 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").

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

See also load().