C++ Essence Library 0.1.0
A Utility Library for Modern C++ Programming
Loading...
Searching...
No Matches
essence::globalization::abstract::translator Class Reference

A translator for retrieving texts in multi-languages. More...

#include <translator.hpp>

Public Member Functions

template<typename T >
requires (!std::same_as<std::decay_t<T>, translator>)
 translator (T &&value)
 
std::uint32_t version () const
 Gets the version of the translator.
 
io::abstract::virtual_fs_operator virtual_fs () const
 Gets the underlying virtual filesystem operator.
 
void set_virtual_fs (io::abstract::virtual_fs_operator fs_operator) const
 Sets the underlying virtual filesystem operator.
 
abi::string working_directory () const
 Gets the working directory.
 
void set_working_directory (std::string_view directory) const
 Sets the working directory.
 
abi::string language () const
 Gets the current language.
 
void set_language (std::string_view name) const
 Sets the current language.
 
abi::string get_text (std::string_view name) const
 Gets a text in the current language.
 

Detailed Description

A translator for retrieving texts in multi-languages.

Member Function Documentation

◆ get_text()

abi::string essence::globalization::abstract::translator::get_text ( std::string_view name) const
inlinenodiscard

Gets a text in the current language.

Parameters
nameThe unique name of the text.
Returns
The text or the name if not exists.

◆ language()

abi::string essence::globalization::abstract::translator::language ( ) const
inlinenodiscard

Gets the current language.

Returns
The current language.

◆ set_language()

void essence::globalization::abstract::translator::set_language ( std::string_view name) const
inline

Sets the current language.

Parameters
nameThe current language.

◆ set_virtual_fs()

void essence::globalization::abstract::translator::set_virtual_fs ( io::abstract::virtual_fs_operator fs_operator) const
inline

Sets the underlying virtual filesystem operator.

Parameters
fs_operatorThe virtual filesystem operator.

◆ set_working_directory()

void essence::globalization::abstract::translator::set_working_directory ( std::string_view directory) const
inline

Sets the working directory.

Parameters
directoryThe working directory.

◆ version()

std::uint32_t essence::globalization::abstract::translator::version ( ) const
inlinenodiscard

Gets the version of the translator.

Returns
The version.

◆ virtual_fs()

io::abstract::virtual_fs_operator essence::globalization::abstract::translator::virtual_fs ( ) const
inlinenodiscard

Gets the underlying virtual filesystem operator.

Returns
The virtual filesystem operator.

◆ working_directory()

abi::string essence::globalization::abstract::translator::working_directory ( ) const
inlinenodiscard

Gets the working directory.

Returns
The working directory.

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