KLocalizedTranslator Class Reference

#include <KLocalizedTranslator>

Inheritance diagram for KLocalizedTranslator:

Public Member Functions
	KLocalizedTranslator (QObject *parent=nullptr)
void	addContextToMonitor (const QString &context)
void	removeContextToMonitor (const QString &context)
void	setTranslationDomain (const QString &translationDomain)
QString	translate (const char *context, const char *sourceText, const char *disambiguation=nullptr, int n=-1) const override
Public Member Functions inherited from QTranslator
	QTranslator (QObject *parent)
QString	filePath () const const
virtual bool	isEmpty () const const
QString	language () const const
bool	load (const QLocale &locale, const QString &filename, const QString &prefix, const QString &directory, const QString &suffix)
bool	load (const QString &filename, const QString &directory, const QString &search_delimiters, const QString &suffix)
bool	load (const uchar *data, int len, const QString &directory)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

A QTranslator using KLocalizedString for translations.

This class allows to translate strings in Qt's translation system with KLocalizedString. An example is the translation of a dynamically loaded user interface through QUILoader.

To use this Translator install it in the QCoreApplication and provide the translation domain to be used. The Translator can operate for multiple contexts, those needs to be specified.

Example for translating a UI loaded through QUILoader:

// create translator and install in QCoreApplication
KLocalizedTranslator *translator = new KLocalizedTranslator(this);
QCoreApplication::instance()->installTranslator(translator);
translator->setTranslationDomain(QStringLiteral("MyAppsDomain"));
 
// create the QUILoader
QUiLoader *loader = new QUiLoader(this);
loader->setLanguageChangeEnabled(true);
 
// load the UI
QFile uiFile(QStringLiteral("/path/to/userInterface.ui"));
uiFile.open(QFile::ReadOnly);
QWidget *loadedWidget = loader->load(&uiFile, this);
uiFile.close();
 
// the object name of the loaded UI is the context in this case
translator->addContextToMonitor(loadedWidget->objectName());
 
// send a LanguageChange event, this will re-translate using our translator
QEvent le(QEvent::LanguageChange);
QCoreApplication::sendEvent(loadedWidget, &le);

Since

5.0

Definition at line 55 of file klocalizedtranslator.h.

Constructor & Destructor Documentation

KLocalizedTranslator()

KLocalizedTranslator::KLocalizedTranslator ( QObject * parent = nullptr )

explicit

Definition at line 20 of file klocalizedtranslator.cpp.

~KLocalizedTranslator()

KLocalizedTranslator::~KLocalizedTranslator ( )

virtual

Definition at line 26 of file klocalizedtranslator.cpp.

Member Function Documentation

addContextToMonitor()

void KLocalizedTranslator::addContextToMonitor

(

const QString &

context

)

Adds a context for which this Translator should be active.

The Translator only translates texts with a context matching one of the monitored contexts. If the context is not monitored, the translate() method delegates to the base class.

Parameters

context

The context for which the Translator should be active

See also

removeContextToMonitor

Definition at line 35 of file klocalizedtranslator.cpp.

removeContextToMonitor()

void KLocalizedTranslator::removeContextToMonitor

(

const QString &

context

)

Stop translating for the given context.

Parameters

context

The context for which the Translator should no longer be active

See also

addContextToMonitor

Definition at line 40 of file klocalizedtranslator.cpp.

setTranslationDomain()

void KLocalizedTranslator::setTranslationDomain

(

const QString &

translationDomain

)

Sets the translationDomain to be used.

The translation domain is required. Without the translation domain any invocation of translate() will be delegated to the base class.

Parameters

translationDomain

The translation domain to be used.

Definition at line 30 of file klocalizedtranslator.cpp.

translate()

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

overridevirtual

Reimplemented from QTranslator.

Definition at line 45 of file klocalizedtranslator.cpp.

---

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

• klocalizedtranslator.h
• klocalizedtranslator.cpp