FBMultiLangManager Class Reference

FBMultiLangManager Class Reference

#include <mobu-python-api.h>

Class Description

Language manager.

The class FBMultiLangManager indicates the supported languages and allows to query and change the current language. The support for localization is done using conversion tables from internal names to language specific names, so that they can be used in the GUI and other human readable contexts.

Warning
At this time, changing the current language will not affect the GUI. Only calls to functions 'FBGetMultiLangText()' will be affected.

The following sample code lists the names of the supported languages: Python sample code:

from pyfbsdk import *
lManager = FBMultiLangManager()
print 'Current localization language: ', lManager.GetCurrentLanguage()
print 'Supported languages:'
for lLanguage in lManager.Languages:
print ' ', lLanguage

C++ sample code:

FBTrace( "Current localization language: %s\n", lManager.GetCurrentLanguage());
FBTrace( "Supported languages:\n" );
int lIdx = 0;
while( lIdx < lManager.Languages.GetCount())
{
FBTrace( " %s\n", lManager.Languages[lIdx++] );
}
+ Inheritance diagram for FBMultiLangManager:

Public Member Functions

bool SetCurrentLanguage (FBMultiLangManager arg1, str arg2)
 Set the current language. More...
 
 __reduce__ ()
 
 __init__ (object arg1)
 
str GetCurrentLanguage (FBMultiLangManager arg1)
 Obtain the current language. More...
 

Public Attributes

ORSDK2018::FBStringList Languages
 List of available languages. More...
 

Member Function Documentation

__init__ ( object  arg1)

Python Docstring:

__init__( (object)arg1) -> None 

C++ Constructors:
The reference documentation for the following C++ symbols may contain additional relevant information.

__reduce__ ( )
str GetCurrentLanguage ( FBMultiLangManager  arg1)

Obtain the current language.

Python Docstring:

GetCurrentLanguage( (FBMultiLangManager)arg1) -> str 

C++ Signature:

const char * GetCurrentLanguage() 

Query the current language used for the GUI.

Returns
Will return the string associated with the current language used.
bool SetCurrentLanguage ( FBMultiLangManager  arg1,
str  arg2 
)

Set the current language.

Python Docstring:

SetCurrentLanguage( (FBMultiLangManager)arg1, (str)arg2) -> bool 

C++ Signature:

bool SetCurrentLanguage(const char * pLanguage) 

Change the current language to another available language.

Parameters
pLanguageThe string corresponding to the desired language, as defined in property Languages.
Returns
Indicate if the change of language was successful.
Warning
Setting the current language will affect the lookup done with the functions FBGetMultiLangText, but will not have any effect on the GUI.

Member Data Documentation

ORSDK2018::FBStringList Languages

List of available languages.

Warning
This list should not be modified. Changes to its value will not affect the languages supported.