[#util-TranslatedLiteral]
= xref:util.adoc[util]::TranslatedLiteral
:relfileprefix: ../
:mrdocs:

Compile&hyphen;time literal string that can be translated with an optional translation function&period;

== Synopsis

Declared in `&lt;util&sol;translation&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct TranslatedLiteral;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:util/TranslatedLiteral/2constructor.adoc[`TranslatedLiteral`]         [.small]#[constructor]#
| Capture a string literal and the translation function to use for it&period;
| xref:util/TranslatedLiteral/2conversion-09.adoc[`operator bilingual&lowbar;str`] 
| Convert to a bilingual&lowbar;str holding both the original and translated text&period;
| xref:util/TranslatedLiteral/2conversion-04.adoc[`operator std::string`] 
| Convert to a std&colon;&colon;string, applying the translation function when set&period;
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:util/TranslatedLiteral/original.adoc[`original`] 
| The untranslated (English) literal text&period;
| xref:util/TranslatedLiteral/translate_fn.adoc[`translate&lowbar;fn`] 
| Pointer to the translation function to apply, or null for no translation&period;
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:util/operator_plus-0b.adoc[`operator&plus;`]
| Prepend a translated literal to a value of the right operand&apos;s type&period;
| xref:_.adoc[`&colon;&colon;&lowbar;`]
| Translation marker macro helper&colon; return the literal unchanged at compile time&period;
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#
