Translator.h File Reference

This class is designed for dealing with multi-language text translation in TerraLib. More...

#include "../Config.h"
#include <locale>
#include <string>
#include <map>
#include <vector>

Go to the source code of this file.

Classes
class	te::core::Translator
	This singleton is designed to deal with multi-language text translation in TerraLib. More...

Namespaces
namespace	boost
namespace	boost::locale
namespace	te
	TerraLib.
namespace	te::core

Macros
#define	TE_ADD_TEXT_DOMAIN(domain, dir)
	It adds the given text domain and its directory to the multilingual system.
#define	TE_TR(message)
	It marks a string in order to get translated.
#define	TE_TR_LANGUAGE(locale)
	It sets the locale for the Translator.
#define	TE_TR_PLURAL(message1, message2, n)
	It marks a string in order to get translated according to plural form.

Detailed Description

This class is designed for dealing with multi-language text translation in TerraLib.

Author

Matheus Cavassan Zaglia

Gilberto Ribeiro de Queiroz

Definition in file Translator.h.

Macro Definition Documentation

TE_ADD_TEXT_DOMAIN

#define TE_ADD_TEXT_DOMAIN	(		domain,
			dir )

Value:

((void)0)

It adds the given text domain and its directory to the multilingual system.

Parameters

domain	A given message domain (just a name). A text domain is the name of the catalog used to translate the message.
dir	Where the text domain is located.

Definition at line 247 of file Translator.h.

TE_TR

#define TE_TR

(

message

)

Value:

te::core::Translator::instance().translate(message).c_str()

It marks a string in order to get translated.

Parameters

message

The text to be translated.

Example of usage:

std::cout << TE_TR("My message!");
 
throw Exception(TE_TR("My other message!"));

Definition at line 264 of file Translator.h.

Referenced by te::map::RasterTransform::BandBufferInfo::BandBufferInfo(), te::cl::KMeans< TTRAIN, TCLASSIFY >::classify(), te::rst::PolygonIterator< T >::getIntersectionRanges(), te::map::GroupingByStdDeviation(), te::cl::Dummy< TTRAIN, TCLASSIFY >::initialize(), te::cl::KMeans< TTRAIN, TCLASSIFY >::initialize(), te::common::FactoryDictionary< TFACTORY, TFACTORYKEY, TKEYCOMPARE >::insert(), te::common::AbstractFactory< TPRODUCT, TFACTORYKEY, TKEYCOMPARE >::make(), te::common::ParameterizedAbstractFactory< TPRODUCT, TFACTORYKEY, TPARAM, TKEYCOMPARE >::make(), te::rst::PointSetIterator< T >::PointSetIterator(), te::rst::PolygonIterator< T >::PolygonIterator(), te::rst::PolygonIterator< T >::PolygonIterator(), te::common::FactoryDictionary< TFACTORY, TFACTORYKEY, TKEYCOMPARE >::remove(), and te::cl::KMeans< TTRAIN, TCLASSIFY >::train().

TE_TR_LANGUAGE

#define TE_TR_LANGUAGE

(

locale

)

Value:

te::core::Translator::instance().setLocale(locale)

It sets the locale for the Translator.

Parameters

locale

A string of the new locale.

Definition at line 300 of file Translator.h.

TE_TR_PLURAL

#define TE_TR_PLURAL	(		message1,
			message2,
			n )

Value:

te::core::Translator::instance().translate(message1, message2, n).c_str()

It marks a string in order to get translated according to plural form.

Parameters

message1	The singular form of the text to be translated.
message2	The plural form of the text to be translated.
n	This parameter is used to determine the plural form.

Example of usage:

int n = f(...);
 
std::cout << TE_TR_PLURAL("One Message!", "Two Messages", n);
 
throw Exception(TE_TR_PLURAL("One Message!", "Two Messages", n));

In the above example, the parameter n can be a threshold that helps to choose between the first or the second construction. If your trabslation file is configured with a theashold of 1, indicating that if n > 1 must choose the second construction, the plural versin will be choosed, otherwise, it will choose the singular form (the fisrt one).

Definition at line 291 of file Translator.h.