QTranslator Class Reference

#include <qtranslator.h>

Inheritance diagram for QTranslator:

[legend]Collaboration diagram for QTranslator:

[legend]List of all members.

---

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 {linguist/hellotr}{Hello tr()} example:

linguist/hellotr/main.cpp main( }

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.

It is possible to lookup 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 comment - an optional comment 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 disambiguating comments such as "two-sided printing" for one and "binding" for the other. The comment enables the translator to choose the appropriate gender for the Spanish version, and enables Qt to distinguish between translations.

See also:

QApplication::installTranslator(), QApplication::removeTranslator(), QObject::tr(), QApplication::translate(), {I18N Example}, {Hello tr() Example}, {Arrow Pad Example}, {Troll Print Example}

Definition at line 38 of file qtranslator.h.

Public Member Functions
	QTranslator (QObject *parent=0)
	~QTranslator ()
virtual QString	translate (const char *context, const char *sourceText, const char *comment=0) const
QString	translate (const char *context, const char *sourceText, const char *comment, int n) const
virtual bool	isEmpty () const
bool	load (const QString &filename, const QString &directory=QString(), const QString &search_delimiters=QString(), const QString &suffix=QString())
bool	load (const uchar *data, int len)

---

Constructor & Destructor Documentation

QTranslator::QTranslator

(

QObject *

parent = 0

)

[explicit]

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

Definition at line 289 of file qtranslator.cpp.

    : QObject(*new QTranslatorPrivate, parent)
{
}

QTranslator::~QTranslator

(

)

Destroys the object and frees any allocated resources.

Definition at line 310 of file qtranslator.cpp.

References d, QCoreApplication::instance(), and QCoreApplication::removeTranslator().

{
    if (QCoreApplication::instance())
        QCoreApplication::instance()->removeTranslator(this);
    Q_D(QTranslator);
    d->clear();
}

Here is the call graph for this function:

---

Member Function Documentation

QString QTranslator::translate	(	const char *	context,
		const char *	sourceText,
		const char *	comment = 0
	)			const [virtual]

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

See also:

load()

Definition at line 745 of file qtranslator.cpp.

References d.

Referenced by LanguageChooser::languageName(), translate(), and QCoreApplication::translate().

{
    Q_D(const QTranslator);
    return d->do_translate(context, sourceText, comment, -1);
}

QString QTranslator::translate	(	const char *	context,
		const char *	sourceText,
		const char *	comment,
		int	n
	)			const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Returns the translation for the key (context, sourceText, comment). 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()

Definition at line 764 of file qtranslator.cpp.

References d, and translate().

{
    Q_D(const QTranslator);
    // this step is necessary because the 3-parameter translate() overload is virtual
    if (n == -1)
        return translate(context, sourceText, comment);
    return d->do_translate(context, sourceText, comment, n);
}

Here is the call graph for this function:

bool QTranslator::isEmpty

(

)

const [virtual]

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

Definition at line 778 of file qtranslator.cpp.

References d.

Referenced by QCoreApplication::installTranslator().

{
    Q_D(const QTranslator);
    return !d->unmapPointer && !d->unmapLength && !d->messageArray &&
           !d->offsetArray && !d->contextArray;
}

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.

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. 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. File name stripped without suffix appended. 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 /opt/foolib/foo.fr_ca /opt/foolib/foo.fr.qm /opt/foolib/foo.fr /opt/foolib/foo.qm /opt/foolib/foo

Definition at line 353 of file qtranslator.cpp.

References d, QFile::encodeName(), QString::fromLatin1(), i, int, isLetter(), QString::isNull(), l, QString::lastIndexOf(), QString::length(), MAP_FAILED, MAP_FILE, QFile::open(), ptr, QIODevice::read(), QIODevice::ReadOnly, QFile::size(), QString::size(), and QString::startsWith().

Referenced by LanguageChooser::checkBoxToggled(), QDesigner::initialize(), LanguageChooser::languageName(), TrPreviewTool::loadTranslation(), and main().

{
    Q_D(QTranslator);
    d->clear();

    QString prefix;

    const int l = filename.size();
    if (!((l > 0 && filename[0] == QLatin1Char('/'))
#ifdef Q_WS_WIN
          || (l >= 2 && filename[0].isLetter() && filename[1] == QLatin1Char(':'))
          || (l >= 1 && filename[0] == QLatin1Char('\\'))
#endif
            )) {
        prefix = directory;
    }

    if (prefix.length()) {
        if (prefix[int(prefix.length()-1)] != QLatin1Char('/'))
            prefix += QLatin1Char('/');
    }

    QString fname = filename;
    QString realname;
    QString delims;
    delims = search_delimiters.isNull() ? QString::fromLatin1("_.") : search_delimiters;

    for (;;) {
        QFileInfo fi;

        realname = prefix + fname + (suffix.isNull() ? QString::fromLatin1(".qm") : suffix);
        fi.setFile(realname);
        if (fi.isReadable())
            break;

        realname = prefix + fname;
        fi.setFile(realname);
        if (fi.isReadable())
            break;

        int rightmost = 0;
        for (int i = 0; i < (int)delims.length(); i++) {
            int k = fname.lastIndexOf(delims[i]);
            if (k > rightmost)
                rightmost = k;
        }

        // no truncations? fail
        if (rightmost == 0)
            return false;

        fname.truncate(rightmost);
    }

    // realname is now the fully qualified name of a readable file.

    bool ok = false;

#ifdef QT_USE_MMAP

#ifndef MAP_FILE
#define MAP_FILE 0
#endif
#ifndef MAP_FAILED
#define MAP_FAILED -1
#endif

    int fd = -1;
    if (!realname.startsWith(QLatin1Char(':')))
        fd = QT_OPEN(QFile::encodeName(realname), O_RDONLY,
#if defined(Q_OS_WIN)
                     _S_IREAD | _S_IWRITE
#else
                     0666
#endif
            );
    if (fd >= 0) {
        struct stat st;
        if (!fstat(fd, &st)) {
            char *ptr;
            ptr = reinterpret_cast<char *>(
                mmap(0, st.st_size,             // any address, whole file
                     PROT_READ,                 // read-only memory
                     MAP_FILE | MAP_PRIVATE,    // swap-backed map from file
                     fd, 0));                   // from offset 0 of fd
            if (ptr && ptr != reinterpret_cast<char *>(MAP_FAILED)) {
                d->used_mmap = true;
                d->unmapPointer = ptr;
                d->unmapLength = st.st_size;
                ok = true;
            }
        }
        ::close(fd);
    }
#endif // QT_USE_MMAP

    if (!ok) {
        QFile file(realname);
        d->unmapLength = file.size();
        if (!d->unmapLength)
            return false;
        d->unmapPointer = new char[d->unmapLength];

        if (file.open(QIODevice::ReadOnly))
            ok = (d->unmapLength == (uint)file.read(d->unmapPointer, d->unmapLength));

        if (!ok) {
            delete [] d->unmapPointer;
            d->unmapPointer = 0;
            d->unmapLength = 0;
            return false;
        }
    }

    return d->do_load(reinterpret_cast<const uchar *>(d->unmapPointer), d->unmapLength);
}

Here is the call graph for this function:

bool QTranslator::load	(	const uchar *	data,
		int	len
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

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.

Definition at line 482 of file qtranslator.cpp.

References d.

{
    Q_D(QTranslator);
    d->clear();
    return d->do_load(data, len);
}

---

The documentation for this class was generated from the following files:

• src/corelib/kernel/qtranslator.h
• src/corelib/kernel/qtranslator.cpp

---