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

#include <qtranslator.h>

Inheritance diagram for QTranslator:

Collaboration diagram for QTranslator:

Public Member Functions
	QTranslator (QObject *parent=nullptr)

	~QTranslator ()

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

virtual bool	isEmpty () const

QString	language () const

QString	filePath () const

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

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

bool	load (const uchar *data, int len, const QString &directory=QString())

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)

virtual	~QObject ()

virtual bool	event (QEvent *event)

virtual bool	eventFilter (QObject watched, QEvent event)

QString	objectName () const

void	setObjectName (const QString &name)

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const

bool	isWindowType () const

bool	signalsBlocked () const noexcept

bool	blockSignals (bool b) noexcept

QThread *	thread () const

void	moveToThread (QThread *thread)

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)

template<typename T >
T	findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

const QObjectList &	children () const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const

void	dumpObjectInfo () const

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const

bool	inherits (const char *classname) const

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()

Signals inherited from QObject
void	destroyed (QObject *=nullptr)

void	objectNameChanged (const QString &objectName, QPrivateSignal)

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Member Functions inherited from QObject
QObject *	sender () const

int	senderSignalIndex () const

int	receivers (const char *signal) const

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Properties inherited from QObject
QString	objectName
	the name of this object More...

Related Functions inherited from QObject
template< class T > T	qobject_cast (const QObject *object)

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList

Detailed Description

The QTranslator class provides internationalization support for text output.

\inmodule QtCore

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 \l{Qt Linguist}.

The most common use of QTranslator is to: load a translation file, and install it using QCoreApplication::installTranslator().

Here's an example main() function using the QTranslator:

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.

Definition at line 54 of file qtranslator.h.

Constructor & Destructor Documentation

◆ QTranslator()

QTranslator::QTranslator ( QObject * parent = nullptr )

explicit

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

Definition at line 416 of file qtranslator.cpp.

◆ ~QTranslator()

QTranslator::~QTranslator ( )

Destroys the object and frees any allocated resources.

Definition at line 425 of file qtranslator.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ filePath()

QString QTranslator::filePath ( ) const

Since: 5.15

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.

Definition at line 1151 of file qtranslator.cpp.

◆ isEmpty()

bool QTranslator::isEmpty ( ) const

virtual

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

Reimplemented in QTestTranslator, and TransformTranslator.

Definition at line 1124 of file qtranslator.cpp.

Here is the caller graph for this function:

◆ language()

QString QTranslator::language ( ) const

Since: 5.15

Returns the target language as stored in the translation file.

Definition at line 1136 of file qtranslator.cpp.

◆ load() [1/3]

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

Since: 4.8

Loads filename + prefix + \l{QLocale::uiLanguages()}{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:

\list 1

File name without suffix appended.
File name with ui language part after a "_" character stripped and suffix.
File name with ui language part stripped without suffix appended.
File name with ui language part stripped further, etc. \endlist

For example, an application running in the locale with the following \l{QLocale::uiLanguages()}{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:

\list 1

/opt/foolib/foo.es.qm
/opt/foolib/foo.es
/opt/foolib/foo.fr_CA.qm
/opt/foolib/foo.fr_CA
/opt/foolib/foo.fr.qm
/opt/foolib/foo.fr
/opt/foolib/foo.de.qm
/opt/foolib/foo.de
/opt/foolib/foo.qm
/opt/foolib/foo.
/opt/foolib/foo \endlist

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

Definition at line 759 of file qtranslator.cpp.

◆ load() [2/3]

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 \l{QDir::}{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:

\list 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. \endlist

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:

\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 \endlist

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

Definition at line 478 of file qtranslator.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ load() [3/3]

bool QTranslator::load	(	const uchar *	data,
		int	len,
		const QString &	directory = `QString()`
	)

Definition at line 783 of file qtranslator.cpp.

◆ translate()

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

virtual

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.

Note: Incomplete translations may result in unexpected behavior: If no translation for (context, sourceText, "") is provided, the method might in this case actually return a translation for a different disambiguation.

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 programmatically insert translations into a QTranslator, this function can be reimplemented.

See also: load()

Reimplemented in TransformTranslator, and QTestTranslator.

Definition at line 1113 of file qtranslator.cpp.

Here is the caller graph for this function:

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QTranslator()

◆ ~QTranslator()

Member Function Documentation

◆ filePath()

◆ isEmpty()

◆ language()

◆ load() [1/3]

◆ load() [2/3]

◆ load() [3/3]

◆ translate()