vtkMRMLI18N Class Reference

Class that provide internationalization (i18n) features, such as language translation or region-specific units and date formatting. More...

#include <Libs/MRML/Core/vtkMRMLI18N.h>

Inheritance diagram for vtkMRMLI18N:

Collaboration diagram for vtkMRMLI18N:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual vtkMRMLTranslator *	GetTranslator ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) override
void	SetTranslator (vtkMRMLTranslator *translator)

Static Public Member Functions
static std::string	Format (const std::string &text, const char *arg1=nullptr, const char *arg2=nullptr, const char *arg3=nullptr, const char *arg4=nullptr, const char *arg5=nullptr, const char *arg6=nullptr, const char *arg7=nullptr, const char *arg8=nullptr, const char *arg9=nullptr)
static vtkMRMLI18N *	GetInstance ()
	Return the singleton instance with no reference counting.
static int	IsTypeOf (const char *type)
static vtkMRMLI18N *	New ()
static vtkMRMLI18N *	SafeDownCast (vtkObject *o)
static std::string	Translate (const char *context, const char *sourceText, const char *disambiguation=nullptr, int n=-1)
	Translate message with the current translator.

Protected Types
typedef vtkMRMLI18N	Self

Protected Member Functions
void	operator= (const vtkMRMLI18N &)
	vtkMRMLI18N ()
	vtkMRMLI18N (const vtkMRMLI18N &)
	~vtkMRMLI18N () override

Static Protected Member Functions
static void	classFinalize ()
static void	classInitialize ()
	Singleton management functions.

Protected Attributes
vtkMRMLTranslator *	Translator { nullptr }

Friends
class	vtkMRMLI18NInitialize

Detailed Description

Class that provide internationalization (i18n) features, such as language translation or region-specific units and date formatting.

Definition at line 32 of file vtkMRMLI18N.h.

Member Typedef Documentation

Self

typedef vtkMRMLI18N vtkMRMLI18N::Self

protected

Definition at line 91 of file vtkMRMLI18N.h.

Superclass

typedef vtkObject vtkMRMLI18N::Superclass

Definition at line 35 of file vtkMRMLI18N.h.

Constructor & Destructor Documentation

vtkMRMLI18N() [1/2]

vtkMRMLI18N::vtkMRMLI18N ( )

protected

~vtkMRMLI18N()

vtkMRMLI18N::~vtkMRMLI18N ( )

overrideprotected

vtkMRMLI18N() [2/2]

vtkMRMLI18N::vtkMRMLI18N ( const vtkMRMLI18N & )

protected

Member Function Documentation

classFinalize()

static void vtkMRMLI18N::classFinalize ( )

staticprotected

classInitialize()

static void vtkMRMLI18N::classInitialize ( )

staticprotected

Singleton management functions.

Format()

static std::string vtkMRMLI18N::Format ( const std::string & text, const char * arg1 = nullptr, const char * arg2 = nullptr, const char * arg3 = nullptr, const char * arg4 = nullptr, const char * arg5 = nullptr, const char * arg6 = nullptr, const char * arg7 = nullptr, const char * arg8 = nullptr, const char * arg9 = nullptr )

static

Replace placeholders in strings, following Qt internationalization conventions.

Accepted placeholders in the input string: %1, %2, %3, ..., %9. Use %% instead of a single % to prevent replacement. For example "some %%3 thing" will result in "some %3 thing" (and will not be replaced by the third replacement string argument).

Example usage:

std::string displayableText = vtkMRMLI18N::Format(
  vtkMRMLTr("vtkMRMLVolumeArchetypeStorageNode", "Cannot read '%1' file as a volume of type '%2'."),
  filename.c_str(),
  volumeType.c_str());

GetClassName()

virtual const char * vtkMRMLI18N::GetClassName ( )

virtual

GetInstance()

static vtkMRMLI18N * vtkMRMLI18N::GetInstance ( )

static

Return the singleton instance with no reference counting.

GetTranslator()

virtual vtkMRMLTranslator * vtkMRMLI18N::GetTranslator ( )

virtual

Get translator object that can translate text that is displayed to the user to the currently chosen language.

IsA()

virtual int vtkMRMLI18N::IsA ( const char * type )

virtual

IsTypeOf()

static int vtkMRMLI18N::IsTypeOf ( const char * type )

static

New()

static vtkMRMLI18N * vtkMRMLI18N::New ( )

static

This is a singleton pattern New. There will only be ONE reference to a vtkMRMLI18N object per process. Clients that call this must call Delete on the object so that the reference counting will work. The single instance will be unreferenced when the program exits.

operator=()

void vtkMRMLI18N::operator= ( const vtkMRMLI18N & )

protected

PrintSelf()

void vtkMRMLI18N::PrintSelf ( ostream & os, vtkIndent indent )

override

SafeDownCast()

static vtkMRMLI18N * vtkMRMLI18N::SafeDownCast ( vtkObject * o )

static

SetTranslator()

void vtkMRMLI18N::SetTranslator

(

vtkMRMLTranslator *

translator

)

Set translator object. This class takes ownership of the translator and it releases it when the process quits.

Translate()

static std::string vtkMRMLI18N::Translate ( const char * context, const char * sourceText, const char * disambiguation = nullptr, int n = -1 )

static

Translate message with the current translator.

Friends And Related Symbol Documentation

vtkMRMLI18NInitialize

friend class vtkMRMLI18NInitialize

friend

Definition at line 90 of file vtkMRMLI18N.h.

Member Data Documentation

Translator

vtkMRMLTranslator* vtkMRMLI18N::Translator { nullptr }

protected

Definition at line 93 of file vtkMRMLI18N.h.

---

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

• Libs/MRML/Core/vtkMRMLI18N.h