xtd::globalization::translator Class Reference

Inheritance diagram for xtd::globalization::translator:

Definition

Represents translator class. This class cannot be inherited.

Namespace

xtd

Library

xtd.core

Remarks

This class is used to translate an application into different languages.

For more information about internationalization, see Internationalizations.

Examples

The following shows how to use translator with std::locale method, litteral operator _t and translation files.

#include <xtd/xtd>
 
using namespace xtd::globalization;
 
class form1 : public form {
public:
  form1() {
    text("Translator example"_t);
    client_size({500, 300});
    controls().add_range({open_button, close_button, text_label});
    
    open_button.location({10, 10});
    open_button.text("Open"_t);
    
    close_button.location({100, 10});
    close_button.text("Close"_t);
    
    text_label.location({10, 50});
    text_label.auto_size(true);
    text_label.text("The quick brown fox jumps over the lazy dog."_t);
  }
  
private:
  button open_button;
  button close_button;
  label text_label;
};
 
auto main() -> int {
  //culture_info::current_culture(culture_info {"ar-MA"});
  //culture_info::current_culture(culture_info {"es-ES"});
  culture_info::current_culture(culture_info {"fr-FR"});
  //culture_info::current_culture(culture_info {"ru-RU"});
  application::run(form1 {});
}

# Main window caption
key "Translator example"
value "Пример перевода"
 
# Open button text
key "Open"
value "Oткрыто"
 
# Close button text
key "Close"
value "Закрыть"
 
# Label text
key "The quick brown fox jumps over the lazy dog."
value "Быстрый коричневый лис перепрыгивает через ленивого пса."

Public Static Properties
static auto	language () -> xtd::string
	Gets the current application language.
static auto	language (const xtd::string &language) -> void
	Sets the current application language.
static auto	language (xtd::null_ptr) -> void
	Sets the current application language.
static auto	languages () -> xtd::array< xtd::string >
	Gets an array of languages supported by the application.
static auto	system_language () -> xtd::string
	Gets the current system language.

Public Static Methods
static auto	add_value (const xtd::string &language, const xtd::string &key, const xtd::string &value) -> void
	Manually adds a translation for a specified key and language.
static auto	parse_locale (const xtd::string &locale_path) -> bool
	Parses a specified path that contains translations.
static auto	parse_locale (const xtd::string &locale_path, const xtd::string &language) -> bool
	Parses a specified path that contains translations.
static auto	parse_file (const xtd::string &file) -> bool
	Parses a specified file that contains translations for a specified language.
static auto	parse_file (const xtd::string &file, const xtd::string &language) -> bool
	Parses a specified file that contains translations for a specified language.
static auto	translate (const xtd::string &value) noexcept -> xtd::string
	Translates a string into the lganguage specified by the xtd::translate::language property.
static auto	translate (const xtd::string &language, const xtd::string &value) noexcept -> xtd::string
	Translates a string into the specified lganguage.

Member Function Documentation

language() [1/3]

static auto xtd::globalization::translator::language ( ) -> xtd::string

staticnodiscard

Gets the current application language.

Returns

The current application language.

Remarks

By default language is initialized with the current system language.

language() [2/3]

static auto xtd::globalization::translator::language ( const xtd::string & language ) -> void

static

Sets the current application language.

Parameters

language

The current application language.

Remarks

Normally you should use the xtd::globalization::culture_info::current_culture property. This function only exists if you have a good reason to bypass xtd::globalization::culture_info::current_culture.

Warning

If you set the language with this method, and you use the xtd::globalization::culture_info::current_culture property afterwards, translator will use the language initialized with this method and not with xtd::globalization::culture_info::current_culture.

language() [3/3]

static auto xtd::globalization::translator::language ( xtd::null_ptr ) -> void

static

Sets the current application language.

Parameters

language

The current application language.

Remarks

Normally you should use the xtd::globalization::culture_info::current_culture property. This function only exists if you have a good reason to bypass xtd::globalization::culture_info::current_culture.

Warning

If you set the language with this method, and you use the xtd::globalization::culture_info::current_culture property afterwards, translator will use the language initialized with this method and not with xtd::globalization::culture_info::current_culture.

languages()

static auto xtd::globalization::translator::languages ( ) -> xtd::array< xtd::string >

staticnodiscard

Gets an array of languages supported by the application.

Returns

An array of languages supported by the application.

system_language()

static auto xtd::globalization::translator::system_language ( ) -> xtd::string

staticnodiscard

Gets the current system language.

Returns

The current system language.

add_value()

static auto xtd::globalization::translator::add_value ( const xtd::string & language, const xtd::string & key, const xtd::string & value ) -> void

inlinestatic

Manually adds a translation for a specified key and language.

Parameters

language	The language of the key to be translated.
key	The key to be translated. @parama value The translation of the key for the specified language.

Warning

This method should not be used. The translation is normally done automatically. This method is present only if you want to make an instant translation on a very small number of keys. It would not be wise to translate an entire application into different languages with this method.

parse_locale() [1/2]

static auto xtd::globalization::translator::parse_locale ( const xtd::string & locale_path ) -> bool

static

Parses a specified path that contains translations.

Parameters

locale_path

Path that contains translations.

Returns

true if parse succeed; otherwhise false.

Remarks

parse path with xtd::globalization::translator::language() language.

parse_locale() [2/2]

static auto xtd::globalization::translator::parse_locale ( const xtd::string & locale_path, const xtd::string & language ) -> bool

static

Parses a specified path that contains translations.

Parameters

locale_path

Path that contains translations.

Returns

true if parse succeed; otherwhise false.

parse_file() [1/2]

static auto xtd::globalization::translator::parse_file ( const xtd::string & file ) -> bool

static

Parses a specified file that contains translations for a specified language.

Parameters

file	The file that contains translations.

Returns

true if parse succeed; otherwhise false.

Remarks

parse file with xtd::globalization::translator::language() language.

parse_file() [2/2]

static auto xtd::globalization::translator::parse_file ( const xtd::string & file, const xtd::string & language ) -> bool

static

Parses a specified file that contains translations for a specified language.

Parameters

file	The file that contains translations.
language	The language of the translation file.

Returns

true if parse succeed; otherwhise false.

translate() [1/2]

static auto xtd::globalization::translator::translate ( const xtd::string & value ) -> xtd::string

inlinestaticnodiscardnoexcept

Translates a string into the lganguage specified by the xtd::translate::language property.

Returns

The translated string.

Remarks

If no translation is found, the result is the same as the value.

translate() [2/2]

static auto xtd::globalization::translator::translate ( const xtd::string & language, const xtd::string & value ) -> xtd::string

inlinestaticnodiscardnoexcept

Translates a string into the specified lganguage.

Returns

The translated string.

Parameters

language

The language used to translate the value

Remarks

If no translation is found, the result is the same as the value.

---

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

• xtd.core/include/xtd/globalization/translator.hpp