An interface for objects which can translate project strings. More...

Inheritance diagram for QgsProjectTranslator:

Public Member Functions
virtual	~QgsProjectTranslator ()=default

virtual QString	translate (const QString &context, const QString &sourceText, const char *disambiguation=nullptr, int n=-1) const =0
	Translates a string using the Qt QTranslator mechanism.

Detailed Description

An interface for objects which can translate project strings.

Definition at line 29 of file qgsprojecttranslator.h.

Constructor & Destructor Documentation

virtual QgsProjectTranslator::~QgsProjectTranslator ( )

virtualdefault

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

pure virtual

Translates a string using the Qt QTranslator mechanism.

This function can be called from wherever the QgsReadWriteContext is available.

Parameters

context	describes the context of the translation, eg the corresponding map layer
sourceText	the identifier of the text to translate (usually the original untranslated string)
disambiguation	optional string providing additional context for the translation
n	optional "object count", which can alter the translation to account for plural forms

Returns: the translated string. In the case that there is no QTranslator available, the sourceText will be returned unchanged.

Implemented in QgsProject.

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