Troll Print Example

Files:

• linguist/trollprint/mainwindow.cpp
• linguist/trollprint/mainwindow.h
• linguist/trollprint/printpanel.cpp
• linguist/trollprint/printpanel.h
• linguist/trollprint/main.cpp
• linguist/trollprint/trollprint.pro

Troll Print is an example application that lets the user choose printer settings. It comes in two versions: English and Portuguese.

We've included a translation file, trollprint_pt.ts, which contains some Portuguese translations for this example.

We will consider two releases of the same application: Troll Print 1.0 and 1.1. We will learn to reuse the translations created for one release in a subsequent release. (In this tutorial, you need to edit some source files. It's probably best to copy all the files to a new temporary directory and work from there.)

See the Qt Linguist manual for more information about translating Qt application.

Line by Line Walkthrough

The PrintPanel class is defined in printpanel.h.

 class PrintPanel : public QWidget
 {
     Q_OBJECT

PrintPanel is a QWidget. It needs the Q_OBJECT macro for tr() to work properly.

The implementation file is printpanel.cpp.

 PrintPanel::PrintPanel(QWidget *parent)
     : QWidget(parent)
 {
 /*
     QLabel *label = new QLabel(tr("<b>TROLL PRINT</b>"));
     label->setAlignment(Qt::AlignCenter);
 */

Some of the code is commented out in Troll Print 1.0; you will uncomment it later, for Troll Print 1.1.

     twoSidedGroupBox = new QGroupBox(tr("2-sided"));
     twoSidedEnabledRadio = new QRadioButton(tr("Enabled"));
     twoSidedDisabledRadio = new QRadioButton(tr("Disabled"));
     twoSidedDisabledRadio->setChecked(true);

     colorsGroupBox = new QGroupBox(tr("Colors"));
     colorsEnabledRadio = new QRadioButton(tr("Enabled"));
     colorsDisabledRadio = new QRadioButton(tr("Disabled"));

Notice the two occurrences of tr("Enabled") and of tr("Disabled") in PrintPanel. Since both "Enabled"s and "Disabled"s appear in the same context Qt Linguist will only display one occurrence of each and will use the same translations for the duplicates that it doesn't display. Whilst this is a useful timesaver, in some languages, such as Portuguese, the second occurrence requires a separate translation. We will see how Qt Linguist can be made to display all the occurrences for separate translation shortly.

The header file for MainWindow, mainwindow.h, contains no surprises. In the implementation, mainwindow.cpp, we have some user-visible source texts that must be marked for translation.

     setWindowTitle(tr("Troll Print 1.0"));

We must translate the window title.

 void MainWindow::createActions()
 {
     exitAct = new QAction(tr("E&xit"), this);
     exitAct->setShortcut(tr("Ctrl+Q", "Quit"));
     connect(exitAct, SIGNAL(triggered()), this, SLOT(close()));

     aboutAct = new QAction(tr("&About"), this);
     aboutAct->setShortcut(Qt::Key_F1);
     connect(aboutAct, SIGNAL(triggered()), this, SLOT(about()));

     aboutQtAct = new QAction(tr("About &Qt"), this);
     connect(aboutQtAct, SIGNAL(triggered()), qApp, SLOT(aboutQt()));
 }

 void MainWindow::createMenus()
 {
     QMenu *fileMenu = menuBar()->addMenu(tr("&File"));
     fileMenu->addAction(exitAct);

     menuBar()->addSeparator();

     QMenu *helpMenu = menuBar()->addMenu(tr("&Help"));
     helpMenu->addAction(aboutAct);
     helpMenu->addAction(aboutQtAct);
 }

We also need to translate the actions and menus. Note that the two argument form of tr() is used for the keyboard accelerator, "Ctrl+Q", since the second argument is the only clue the translator has to indicate what function that accelerator will perform.

     QTranslator translator;
     translator.load(QString("trollprint_") + locale);
     app.installTranslator(&translator);

The main() function in main.cpp is the same as the one in the Arrow Pad example. In particular, it chooses a translation file based on the current locale.

Running Troll Print 1.0 in English and in Portuguese

We will use the translations in the trollprint_pt.ts file that is provided.

Set the LANG environment variable to pt, and then run trollprint. You should still see the English version. Now run lrelease, e.g. lrelease trollprint.pro, and then run the example again. Now you should see the Portuguese edition (Troll Imprimir 1.0):

Whilst the translation has appeared correctly, it is in fact wrong. In good Portuguese, the second occurrence of "Enabled" should be "Ativadas", not "Ativado" and the ending for the second translation of "Disabled" must change similarly too.

If you open trollprint_pt.ts using Qt Linguist, you will see that there is just one occurrence of "Enabled" and of "Disabled" in the translation source file, even though there are two of each in the source code. This is because Qt Linguist tries to minimize the translator's work by using the same translation for duplicate source texts. In cases such as this where an identical translation is wrong, the programmer must disambiguate the duplicate occurrences. This is easily achieved by using the two argument form of tr().

We can easily determine which file must be changed because the translator's "context" is in fact the class name for the class where the texts that must be changed appears. In this case the file is printpanel.cpp, where there are four lines to change. Add the second argument "two-sided" in the appropriate tr() calls to the first pair of radio buttons:

 twoSidedEnabledRadio = new QRadioButton(tr("Enabled", "two-sided"));
 twoSidedDisabledRadio = new QRadioButton(tr("Disabled", "two-sided"));

and add the second argument "colors" in the appropriate tr() calls for the second pair of radio buttons:

 colorsEnabledRadio = new QRadioButton(tr("Enabled", "colors"), colors);
 colorsDisabledRadio = new QRadioButton(tr("Disabled", "colors"), colors);

Now run lupdate and open trollprint_pt.ts with Qt Linguist. You should now see two changes.

First, the translation source file now contains three "Enabled", "Disabled" pairs. The first pair is marked "(obs.)" signifying that they are obsolete. This is because these texts appeared in tr() calls that have been replaced by new calls with two arguments. The second pair has "two-sided" as their comment, and the third pair has "colors" as their comment. The comments are shown in the Source text and comments area in Qt Linguist.

Second, the translation text "Ativado" and "Desativado" have been automatically used as translations for the new "Enabled" and "Disabled" texts, again to minimize the translator's work. Of course in this case these are not correct for the second occurrence of each word, but they provide a good starting point.

Change the second "Ativado" into "Ativadas" and the second "Desativado" into "Desativadas", then save and quit. Run lrelease to obtain an up-to-date binary trollprint_pt.qm file, and run Troll Print (or rather Troll Imprimir).

The second argument to tr() calls, called "comments" in Qt Linguist, distinguish between identical source texts that occur in the same context (class). They are also useful in other cases to give clues to the translator, and in the case of Ctrl key accelerators are the only means of conveying the function performed by the accelerator to the translator.

An additional way of helping the translator is to provide information on how to navigate to the particular part of the application that contains the source texts they must translate. This helps them see the context in which the translation appears and also helps them to find and test the translations. This can be achieved by using a TRANSLATOR comment in the source code:

 /*
    TRANSLATOR MainWindow

    In this application the whole application is a MainWindow.
    Choose Help|About from the menu bar to see some text
    belonging to MainWindow.

    ...

Try adding these comments to some source files, particularly to dialog classes, describing the navigation necessary to reach the dialogs. You could also add them to the example files, e.g. mainwindow.cpp and printpanel.cpp are appropriate files. Run lupdate and then start Qt Linguist and load in trollprint_pt.ts. You should see the comments in the Source text and comments area as you browse through the list of source texts.

Sometimes, particularly with large programs, it can be difficult for the translator to find their translations and check that they're correct. Comments that provide good navigation information can save them time:

 /*
    TRANSLATOR ZClientErrorDialog

    Choose Client|Edit to reach the Client Edit dialog, then choose
    Client Specification from the drop down list at the top and pick
    client Bartel Leendert van der Waerden. Now check the Profile
    checkbox and then click the Start Processing button. You should
    now see a pop up window with the text "Error: Name too long!".
    This window is a ZClientErrorDialog.

Troll Print 1.1

We'll now prepare release 1.1 of Troll Print. Start your favorite text editor and follow these steps:

• Uncomment the two lines that create a QLabel with the text "<b>TROLL PRINT</b>" in printpanel.cpp.
• Word-tidying: Replace "2-sided" by "Two-sided" in printpanel.cpp.
• Replace "1.0" with "1.1" everywhere it occurs in mainwindow.cpp.
• Update the copyright year to 1999-2000 in mainwindow.cpp.

(Of course the version number and copyright year would be consts or #defines in a real application.)

Once finished, run lupdate, then open trollprint_pt.ts in Qt Linguist. The following items are of special interest:

• MainWindow
  • Troll Print 1.0 - marked "(obs.)", obsolete
  • About Troll Print 1.0 - marked "(obs.)", obsolete
  • Troll Print 1.0. Copyright 1999 Software, Inc. - marked obsolete
  • Troll Print 1.1 - automatically translated as "Troll Imprimir 1.1"
  • About Troll Print 1.1 - automatically translated as "Troll Imprimir 1.1"
  • Troll Print 1.1. Copyright 1999-2000 Software, Inc. - automatically translated as "Troll Imprimir 1.1. Copyright 1999-2000 Software, Inc."
• PrintPanel
  • 2-sided - marked "(obs.)", obsolete
  • <b>TROLL PRINT</b> - unmarked, i.e. untranslated
  • Two-sided - unmarked, i.e. untranslated.

Notice that lupdate works hard behind the scenes to make revisions easier, and it's pretty smart with numbers.

Go over the translations in MainWindow and mark these as "done". Translate "<b>TROLL PRINT</b>" as "<b>TROLL IMPRIMIR</b>". When you're translating "Two-sided", press the Guess Again button to translate "Two-sided", but change the "2" into "Dois".

Save and quit, then run lrelease. The Portuguese version should look like this:

Choose Ajuda|Sobre (Help|About) to see the about box.

If you choose Ajuda|Sobre Qt (Help|About Qt), you'll get an English dialog. Oops! Qt itself needs to be translated. See Internationalization with Qt for details.

Now set LANG=en to get the original English version: