Qt 5.8 | Internationalization with Qt

Qt 5.8.0 Reference Documentation

Writing Source Code for Translation

# Internationalization with Qt

The internationalization and localization of an application are the processes of adapting the application to different languages, regional differences and technical requirements of a target market. Internationalization means designing a software application so that it can be adapted to various languages and regions without engineering changes. Localization means adapting internationalized software for a specific region or language by adding locale-specific components (such as date, time, and number formats) and translating text.

#### Relevant Qt Classes and APIs

These classes support internationalizing of Qt applications.

QTextCodec | Conversions between text encodings
QTextDecoder | State-based decoder
QTextEncoder | State-based encoder
QTranslator | Internationalization support for text output
QCollator | Compares strings according to a localized collation algorithm
QCollatorSortKey | Can be used to speed up string collation
QLocale | Converts between numbers and their string representations in various languages

#### Languages and Writing Systems

In some cases internationalization is simple, for example, making a US application accessible to Australian or British users may require little more than a few spelling corrections. But to make a US application usable by Japanese users, or a Korean application usable by German users, will require that the software operate not only in different languages, but use different input techniques, character encodings and presentation conventions.

Qt tries to make internationalization as painless as possible for developers. All input controls and text drawing methods in Qt offer built-in support for all supported languages. The built-in font engine is capable of correctly and attractively rendering text that contains characters from a variety of different writing systems at the same time.

Qt supports most languages in use today, in particular:

- All East Asian languages (Chinese, Japanese and Korean)
- All Western languages (using Latin script)
- Arabic
- Cyrillic languages (Russian, Ukrainian, etc.)
- Greek
- Hebrew
- Thai and Lao
- All scripts in Unicode 6.2 that do not require special processing
- Bengali
- Burmese (Myanmar)
- Devanagari
- Gujarati
- Gurmukhi
- Kannada
- Khmer
- Malayalam
- Tamil
- Telugu
- Tibetan

The list above is supported and will work on all platforms as long as the system has fonts to render these writing systems installed.

On Windows, Linux and Unix with FontConfig (client side font support) the following languages are also supported:

- Dhivehi (Thaana)
- Syriac
- N'Ko

On macOS, the following languages are also supported:

- Oriya
- Sinhala

Many of these writing systems exhibit special features:

- Special line breaking behavior. Some of the Asian languages are written without spaces between words. Line breaking can occur either after every character (with exceptions) as in Chinese, Japanese and Korean, or after logical word boundaries as in Thai.
- Bidirectional writing. Arabic and Hebrew are written from right to left, except for numbers and embedded English text which is written left to right. The exact behavior is defined in the Unicode Technical Annex #9.
- Non-spacing or diacritical marks (accents or umlauts in European languages). Some languages such as Vietnamese make extensive use of these marks and some characters can have more than one mark at the same time to clarify pronunciation.
- Ligatures. In special contexts, some pairs of characters get replaced by a combined glyph forming a ligature. Common examples are the fl and fi ligatures used in typesetting US and European books.

Qt tries to take care of all the special features listed above. You usually don't have to worry about these features so long as you use Qt's input controls (e.g. QLineEdit, QTextEdit, and derived classes or the Quick TextInput item) and Qt's display controls (e.g. QLabel and Qt Quick's Text item).

Support for these writing systems is transparent to the programmer and completely encapsulated in Qt's text engine. This means that you don't need to have any knowledge about the writing system used in a particular language, except for the following small points:

- QPainter::drawText(int x, int y, const QString &str) will always draw the string with its left edge at the position specified with the x, y parameters. This will usually give you left aligned strings. Arabic and Hebrew application strings are usually right aligned, so for these languages use the version of drawText() that takes a QRect since this will align in accordance with the language.
- When you write your own text input controls, use QTextLayout. In some languages (e.g. Arabic or languages from the Indian subcontinent), the width and shape of a glyph changes depending on the surrounding characters, which QTextLayout takes into account. Writing input controls usually requires a certain knowledge of the scripts it is going to be used in. Usually the easiest way is to subclass QLineEdit or QTextEdit.

For more information about how to internationalize source code, see Writing Source Code for Translation and Internationalization and Localization with Qt Quick.

#### Producing Translations

Qt provides excellent support for translating Qt C++ and Qt Quick applications into local languages. Release managers, translators, and developers can use the Qt translation tools to accomplish their tasks.

The Qt translation tools, Qt Linguist, `lupdate`, and `lrelease` are installed in the `bin` subdirectory of the base directory Qt is installed into. For more information about using them, see the Qt Linguist Manual.

Qt itself contains several thousands of strings that will also need to be translated into the languages that you are targeting. You will find a number of translation files in the qttranslations repository. Before you start translating Qt, read the wiki page Translating Qt Into Other Languages.

#### Enabling Translation

Typically, your application's `main()` function will look like this:

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

          QTranslator qtTranslator;
          qtTranslator.load("qt_" + QLocale::system().name(),
                  QLibraryInfo::location(QLibraryInfo::TranslationsPath));
          app.installTranslator(&qtTranslator);

          QTranslator myappTranslator;
          myappTranslator.load("myapp_" + QLocale::system().name());
          app.installTranslator(&myappTranslator);

          ...
          return app.exec();
      }

For a translation-aware application, a QTranslator object is created, then a translation is loaded according to the current locale at runtime, and finally, the translator object is installed into the application.

Note the use of QLibraryInfo::location() to locate the Qt translations. Developers should request the path to the translations at run-time by passing QLibraryInfo::TranslationsPath to this function instead of using the `QTDIR` environment variable in their applications.

#### Support for Encodings

The QTextCodec class and the facilities in QTextStream make it easy to support many legacy input and output encodings for your users' data. When an application starts, the locale of the machine will determine the 8-bit encoding used when dealing with external 8-bit data. QTextCodec::codecForLocale() returns a codec that can be used to convert between this locale encoding and Unicode.

The application may occasionally require encodings other than the default local 8-bit encoding. For example, an application in a Cyrillic KOI8-R locale (the de-facto standard locale in Russia) might need to output Cyrillic in the ISO 8859-5 encoding. Code for this would be:

      QString string = ...; // some Unicode text

      QTextCodec *codec = QTextCodec::codecForName("ISO 8859-5");
      QByteArray encodedString = codec->fromUnicode(string);

For converting Unicode to local 8-bit encodings, a shortcut is available: the QString::toLocal8Bit() function returns such 8-bit data. Another useful shortcut is QString::toUtf8(), which returns text in the 8-bit UTF-8 encoding: this perfectly preserves Unicode information while looking like plain ASCII if the text is wholly ASCII.

For converting the other way, there are the QString::fromUtf8() and QString::fromLocal8Bit() convenience functions, or the general code, demonstrated by this conversion from ISO 8859-5 Cyrillic to Unicode conversion:

      QByteArray encodedString = ...; // some ISO 8859-5 encoded text

      QTextCodec *codec = QTextCodec::codecForName("ISO 8859-5");
      QString string = codec->toUnicode(encodedString);

Unicode I/O should be used as this maximizes the portability of documents between users around the world. In many cases it is however still necessary to support other encodings as your users will need to process existing documents. The most important additional encoding to support is the one returned by QTextCodec::codecForLocale(), as this is the one the user is most likely to need for communicating with other people and applications (this is the codec used by local8Bit()).

Qt supports most of the more frequently used encodings natively. For a complete list of supported encodings see the QTextCodec documentation.

In some cases and for less frequently used encodings it may be necessary to write your own QTextCodec subclass. Depending on the urgency, it may be useful to contact Qt's technical support team or ask on the `qt-interest` mailing list to see if someone else is already working on supporting the encoding.

#### Localizing Numbers, Dates, Times and Currency

Localization is the process of adapting to local conventions, for example presenting dates and times using the locally preferred formats. For localized numbers, dates, times and currency strings, use the QLocale class.

Localizing images is not recommended. Choose clear icons that are appropriate for all localities, rather than relying on local puns or stretched metaphors. The exception is for images of left and right pointing arrows which may need to be reversed for Arabic and Hebrew locales.

#### Dynamic Translation

Some applications, such as Qt Linguist, must be able to support changes to the user's language settings while they are still running. To make widgets aware of changes to the installed QTranslator objects, reimplement the widget's changeEvent() function to check whether the event is a LanguageChange event, and update the text displayed by widgets using the tr() function in the usual way. For example:

      void MyWidget::changeEvent(QEvent *event)
      {
          if (event->type() == QEvent::LanguageChange) {
              titleLabel->setText(tr("Document Title"));
              ...
              okPushButton->setText(tr("&OK"));
          } else
              QWidget::changeEvent(event);
      }

All other change events should be passed on by calling the default implementation of the function.

The list of installed translators might change in reaction to a LocaleChange event, or the application might provide a user interface that allows the user to change the current application language.

The default event handler for QWidget subclasses responds to the QEvent::LanguageChange event, and will call this function when necessary.

LanguageChange events are posted when a new translation is installed using the QCoreApplication::installTranslator() function. Additionally, other application components can also force widgets to update themselves by posting LanguageChange events to them.

#### System Support

Some of the operating systems and windowing systems that Qt runs on only have limited support for Unicode. The level of support available in the underlying system has some influence on the support that Qt can provide on those platforms, although in general Qt applications need not be too concerned with platform-specific limitations.

##### Unix/X11

- Locale-oriented fonts and input methods. Qt hides these and provides Unicode input and output.
- Filesystem conventions such as UTF-8 are today used by default in most Unix variants. All Qt file functions allow Unicode, but convert filenames to the local 8-bit encoding, as this is the Unix convention (see QFile::setEncodingFunction() to explore alternative encodings).
- File I/O defaults to the local 8-bit encoding, with Unicode options in QTextStream.
- Some older Unix distributions contain only partial support for some locales. For example, if you have a `/usr/share/locale/ja_JP.EUC` directory, this does not necessarily mean you can display Japanese text; you also need to have Japanese fonts installed, and the `/usr/share/locale/ja_JP.EUC` directory needs to be complete. For best results, use complete locales from your system vendor.

##### Linux

- Qt provides full Unicode support, including input methods, fonts, clipboard, drag-and-drop.
- The file system is usually encoded in UTF-8 on all modern Linux distributions and should not pose a problem. File I/O defaults to UTF-8.

##### Windows

- Qt provides full Unicode support, including input methods, fonts, clipboard, drag-and-drop and file names.
- File I/O defaults to Latin1, with Unicode options in QTextStream. Note that some Windows programs do not understand big-endian Unicode text files even though that is the order prescribed by the Unicode Standard in the absence of higher-level protocols.

##### macOS

For details on macOS-specific translation, refer to the Qt for macOS issues document here.

#### Related Pages

Qt Linguist Examples | Using Qt Linguist to internationalize your Qt application
Overview of the Translation Process |
Qt Linguist Manual |
Qt Linguist Manual: Developers |
Qt Linguist Manual: Release Manager |
Qt Linguist Manual: TS File Format |
Qt Linguist Manual: Text ID Based Translations | Text ID based internationalization provides support for large scale projects with many target locales and many texts to translate
Qt Linguist Manual: Translators |
Translation Rules for Plurals | A summary of the translation rules for plurals produced by Qt's i18n tools.
Writing Source Code for Translation | How to write source code in a way that makes it possible for user-visible text to be translated.