KI18n 5.109.0
|
Class for producing and handling localized messages. More...
#include <KLocalizedString>
Public Member Functions | |
KLocalizedString () | |
Construct an empty message. | |
KLocalizedString (const KLocalizedString &rhs) | |
Copy constructor. | |
~KLocalizedString () | |
Destructor. | |
KLocalizedString | ignoreMarkup () const |
Do not resolve KUIT markup. | |
KLocalizedString | inContext (const QString &key, const QString &value) const |
Add dynamic context to the message. | |
bool | isEmpty () const |
Check whether the message is empty. | |
KLocalizedString & | operator= (const KLocalizedString &rhs) |
Assignment operator. | |
KLocalizedString | relaxSubs () const |
Relax matching between placeholders and arguments. | |
KLocalizedString | subs (const KLocalizedString &a, int fieldWidth=0, QChar fillChar=QLatin1Char(' ')) const |
Substitute another KLocalizedString into the message. | |
KLocalizedString | subs (const QString &a, int fieldWidth=0, QChar fillChar=QLatin1Char(' ')) const |
Substitute a QString argument into the message. | |
KLocalizedString | subs (double a, int fieldWidth=0, char format='g', int precision=-1, QChar fillChar=QLatin1Char(' ')) const |
Substitute a double argument into the message. | |
KLocalizedString | subs (int a, int fieldWidth=0, int base=10, QChar fillChar=QLatin1Char(' ')) const |
Substitute an int argument into the message. | |
KLocalizedString | subs (long a, int fieldWidth=0, int base=10, QChar fillChar=QLatin1Char(' ')) const |
Substitute a long argument into the message. | |
KLocalizedString | subs (QChar a, int fieldWidth=0, QChar fillChar=QLatin1Char(' ')) const |
Substitute a QChar argument into the message. | |
KLocalizedString | subs (qlonglong a, int fieldWidth=0, int base=10, QChar fillChar=QLatin1Char(' ')) const |
Substitute a long long argument into the message. | |
KLocalizedString | subs (qulonglong a, int fieldWidth=0, int base=10, QChar fillChar=QLatin1Char(' ')) const |
Substitute an unsigned long long argument into the message. | |
KLocalizedString | subs (uint a, int fieldWidth=0, int base=10, QChar fillChar=QLatin1Char(' ')) const |
Substitute an unsigned int argument into the message. | |
KLocalizedString | subs (ulong a, int fieldWidth=0, int base=10, QChar fillChar=QLatin1Char(' ')) const |
Substitute an unsigned long argument into the message. | |
QString | toString () const |
Finalize the translation. | |
QString | toString (const char *domain) const |
Like toString , but look for translation in the given domain. | |
QString | toString (const QStringList &languages) const |
Like toString , but look for translation only in given languages. | |
QString | toString (Kuit::VisualFormat format) const |
Like toString , but resolve KUIT markup into given visual format. | |
QByteArray | untranslatedText () const |
Returns the untranslated text. | |
KLocalizedString | withDomain (const char *domain) const |
Indicate to look for translation in the given domain. | |
KLocalizedString | withFormat (Kuit::VisualFormat format) const |
Indicate to resolve KUIT markup into given visual format. | |
KLocalizedString | withLanguages (const QStringList &languages) const |
Indicate to look for translation only in given languages. | |
Static Public Member Functions | |
static void | addDomainLocaleDir (const QByteArray &domain, const QString &path) |
Load locales for a domain from a specific location This is useful for resources which have their translation files outside of the usual $XDG_DATA_DIRS/locales location. | |
static QByteArray | applicationDomain () |
Get the application's main translation domain. | |
static QSet< QString > | availableApplicationTranslations () |
static QSet< QString > | availableDomainTranslations (const QByteArray &domain) |
static void | clearLanguages () |
Clear override languages. | |
static bool | isApplicationTranslatedInto (const QString &language) |
Check whether the translation catalog file in the given language for the set application translation domain exists. | |
static QStringList | languages () |
Get the languages for which translations will be made. | |
static QString | localizedFilePath (const QString &filePath) |
Find a path to the localized file for the given original path. | |
static QString | removeAcceleratorMarker (const QString &label) |
Remove accelerator marker from a UI text label. | |
static void | setApplicationDomain (const char *domain) |
Set the given domain as application's main domain. | |
static void | setLanguages (const QStringList &languages) |
Set the languages for which translations will be made. | |
Class for producing and handling localized messages.
KLocalizedString
handles translation and argument substitution and formatting of user-visible text.
KLocalizedString
instances are usually not constructed directly, but through one of the wrapper *i18n*
calls.
For detailed information on how to use KI18n functions please refer to prg_guide.
|
explicit |
Construct an empty message.
Direct construction is used when another KLocalizedString
instance, obtained by one of ki18n*
calls, should later be assigned to directly constructed instance. Before the assignment happens, directly constructed instance is not valid for finalization by toString
methods.
KLocalizedString::KLocalizedString | ( | const KLocalizedString & | rhs | ) |
Copy constructor.
KLocalizedString::~KLocalizedString | ( | ) |
Destructor.
|
static |
Load locales for a domain from a specific location This is useful for resources which have their translation files outside of the usual $XDG_DATA_DIRS/locales location.
the | domain to load resources from \path the full file path to the locale directory |
|
static |
Get the application's main translation domain.
Returns the domain set by setApplicationDomain
.
|
static |
Get the languages for which there exists the translation catalog file for the set application translation domain.
The application domain is set by setApplicationDomain
. If the application domain was not set, empty set is returned. If the application domain was set, the language set will always contain at least the source code language (en_US
).
|
static |
Get the languages for which a translation catalog file for the passed translation domain exists.
If the translation domain was not specified in the domain parameter an empty set is returned.
If the application domain was set, the language set will always contain at least the source code language (en_US
).
domain | query for translations of a specific domain, if an empty QByteArray is passed, an empty set will be returned |
|
static |
Clear override languages.
This clears the override languages, going back to those provided by the locale.
KLocalizedString KLocalizedString::ignoreMarkup | ( | ) | const |
Do not resolve KUIT markup.
If the message is markup-aware (constructed by one of *xi18n*
calls), this function can be used to make it non-markup-aware. This may be useful for debugging markup.
KLocalizedString
KLocalizedString KLocalizedString::inContext | ( | const QString & | key, |
const QString & | value | ||
) | const |
Add dynamic context to the message.
See dyn_ctxt for use cases.
key | context key |
value | context value |
KLocalizedString
|
static |
Check whether the translation catalog file in the given language for the set application translation domain exists.
language | the language code to check |
true
if the translation catalog for language
exits, false
otherwise bool KLocalizedString::isEmpty | ( | ) | const |
Check whether the message is empty.
The message is considered empty if the object was constructed via the default constructor.
Empty messages are not valid for finalization. The behavior of calling toString
on them is undefined. In debug mode, an error mark may appear in the returned string.
true
if the message is empty, false
otherwise
|
static |
Get the languages for which translations will be made.
Returned languages are ordered with decreasing priority.
|
static |
Find a path to the localized file for the given original path.
This is intended mainly for non-text resources (images, sounds, etc). Text resources should be handled in more specific ways.
Possible localized paths are checked in turn by priority of set languages, in form of <dirname>/l10n/<lang>/<basename>
, where <dirname>
and <basename>
are those of the original path, and <lang>
is the language code.
filePath | path to the original file |
KLocalizedString & KLocalizedString::operator= | ( | const KLocalizedString & | rhs | ) |
Assignment operator.
KLocalizedString KLocalizedString::relaxSubs | ( | ) | const |
Relax matching between placeholders and arguments.
Normally the placeholders should start from %1 and have no gaps, and on finalization there must be exactly as many arguments supplied through subs
methods as there are unique plaecholders. If this is not satisfied, in debug mode warnings are printed and the finalized string may contain error marks.
This method relaxes the placeholder-argument matching, such that there must only be an argument available for every present unique placeholder (taking placeholder numbers to be 1-based indices into the argument list). This can come useful in some situations.
KLocalizedString
|
static |
Remove accelerator marker from a UI text label.
Accelerator marker is not always a plain ampersand (&), so it is not enough to just remove it by QString::remove
. The label may contain escaped markers ("&&") which must be resolved and skipped, as well as CJK-style markers ("Foo (&F)") where the whole parenthesis construct should be removed. Therefore always use this function to remove accelerator marker from UI labels.
label | UI label which may contain an accelerator marker |
|
static |
Set the given domain as application's main domain.
This function must be called in applications, in order to have any translations at all. It should never be called in libraries. This allows to check whether the application is translated into a given language, so that if it is not, translations from underlying libraries will not appear even if they are translated. This prevents mixing of translated and untranslated text in the user interface.
This function should be called right after creating the instance of QCoreApplication or one of its subclasses. At that time the locale setup has been made, including what is hooked into the QCoreApplication startup, like KXMLGUI's language switching support. So the initialisation done by this function sees all the data it should.
domain | the translation domain of the application |
|
static |
Set the languages for which translations will be made.
This overrides the languages provided by the locale. Languages should be ordered with decreasing priority.
languages | ordered list of language codes |
KLocalizedString KLocalizedString::subs | ( | const KLocalizedString & | a, |
int | fieldWidth = 0 , |
||
QChar | fillChar = QLatin1Char(' ') |
||
) | const |
Substitute another KLocalizedString
into the message.
a | the argument |
fieldWidth | width of the formatted field, padded by spaces. Positive value aligns right, negative aligns left |
fillChar | the character used to fill up the empty places when field width is greater than argument width |
KLocalizedString
KLocalizedString KLocalizedString::subs | ( | const QString & | a, |
int | fieldWidth = 0 , |
||
QChar | fillChar = QLatin1Char(' ') |
||
) | const |
Substitute a QString
argument into the message.
a | the argument |
fieldWidth | width of the formatted field, padded by spaces. Positive value aligns right, negative aligns left |
fillChar | the character used to fill up the empty places when field width is greater than argument width |
KLocalizedString
KLocalizedString KLocalizedString::subs | ( | double | a, |
int | fieldWidth = 0 , |
||
char | format = 'g' , |
||
int | precision = -1 , |
||
QChar | fillChar = QLatin1Char(' ') |
||
) | const |
Substitute a double argument into the message.
a | the argument |
fieldWidth | width of the formatted field, padded by spaces. Positive value aligns right, negative aligns left |
format | type of floating point formatting, like in QString::arg |
precision | number of digits after the decimal separator |
fillChar | the character used to fill up the empty places when field width is greater than argument width |
KLocalizedString
KLocalizedString KLocalizedString::subs | ( | int | a, |
int | fieldWidth = 0 , |
||
int | base = 10 , |
||
QChar | fillChar = QLatin1Char(' ') |
||
) | const |
Substitute an int argument into the message.
a | the argument |
fieldWidth | width of the formatted field, padded by spaces. Positive value aligns right, negative aligns left |
base | the radix used to represent the number as a string. Valid values range from 2 to 36 |
fillChar | the character used to fill up the empty places when field width is greater than argument width |
KLocalizedString
KLocalizedString KLocalizedString::subs | ( | long | a, |
int | fieldWidth = 0 , |
||
int | base = 10 , |
||
QChar | fillChar = QLatin1Char(' ') |
||
) | const |
Substitute a long argument into the message.
a | the argument |
fieldWidth | width of the formatted field, padded by spaces. Positive value aligns right, negative aligns left |
base | the radix used to represent the number as a string. Valid values range from 2 to 36 |
fillChar | the character used to fill up the empty places when field width is greater than argument width |
KLocalizedString
KLocalizedString KLocalizedString::subs | ( | QChar | a, |
int | fieldWidth = 0 , |
||
QChar | fillChar = QLatin1Char(' ') |
||
) | const |
Substitute a QChar
argument into the message.
a | the argument |
fieldWidth | width of the formatted field, padded by spaces. Positive value aligns right, negative aligns left |
fillChar | the character used to fill up the empty places when field width is greater than argument width |
KLocalizedString
KLocalizedString KLocalizedString::subs | ( | qlonglong | a, |
int | fieldWidth = 0 , |
||
int | base = 10 , |
||
QChar | fillChar = QLatin1Char(' ') |
||
) | const |
Substitute a long long argument into the message.
a | the argument |
fieldWidth | width of the formatted field, padded by spaces. Positive value aligns right, negative aligns left |
base | the radix used to represent the number as a string. Valid values range from 2 to 36 |
fillChar | the character used to fill up the empty places when field width is greater than argument width |
KLocalizedString
KLocalizedString KLocalizedString::subs | ( | qulonglong | a, |
int | fieldWidth = 0 , |
||
int | base = 10 , |
||
QChar | fillChar = QLatin1Char(' ') |
||
) | const |
Substitute an unsigned long long argument into the message.
a | the argument |
fieldWidth | width of the formatted field, padded by spaces. Positive value aligns right, negative aligns left |
base | the radix used to represent the number as a string. Valid values range from 2 to 36 |
fillChar | the character used to fill up the empty places when field width is greater than argument width |
KLocalizedString
KLocalizedString KLocalizedString::subs | ( | uint | a, |
int | fieldWidth = 0 , |
||
int | base = 10 , |
||
QChar | fillChar = QLatin1Char(' ') |
||
) | const |
Substitute an unsigned int argument into the message.
a | the argument |
fieldWidth | width of the formatted field, padded by spaces. Positive value aligns right, negative aligns left |
base | the radix used to represent the number as a string. Valid values range from 2 to 36 |
fillChar | the character used to fill up the empty places when field width is greater than argument width |
KLocalizedString
KLocalizedString KLocalizedString::subs | ( | ulong | a, |
int | fieldWidth = 0 , |
||
int | base = 10 , |
||
QChar | fillChar = QLatin1Char(' ') |
||
) | const |
Substitute an unsigned long argument into the message.
a | the argument |
fieldWidth | width of the formatted field, padded by spaces. Positive value aligns right, negative aligns left |
base | the radix used to represent the number as a string. Valid values range from 2 to 36 |
fillChar | the character used to fill up the empty places when field width is greater than argument width |
KLocalizedString
QString KLocalizedString::toString | ( | ) | const |
Finalize the translation.
Creates translated QString
, with placeholders substituted by arguments given by KLocalizedString::subs
methods. Translated text is searched for and arguments are formatted based on the global locale.
If there was any mismatch between placeholders and arguments, in debug mode the returned string may contain error marks.
QString KLocalizedString::toString | ( | const char * | domain | ) | const |
Like toString
, but look for translation in the given domain.
Given domain overrides any set earlier using withDomain
.
domain | the translation domain |
QString KLocalizedString::toString | ( | const QStringList & | languages | ) | const |
Like toString
, but look for translation only in given languages.
Given languages override languages defined by the global locale, and any languages set earlier using withLanguages
. If languages
is empty, original message is returned.
languages | list of language codes (by decreasing priority) |
QString KLocalizedString::toString | ( | Kuit::VisualFormat | format | ) | const |
Like toString
, but resolve KUIT markup into given visual format.
Given visual format overrides that implied by the context UI marker or set earlier using withFormat
. If the message is not markup-aware, this is same as toString
without arguments.
format | the target visual format |
QByteArray KLocalizedString::untranslatedText | ( | ) | const |
Returns the untranslated text.
KLocalizedString KLocalizedString::withDomain | ( | const char * | domain | ) | const |
Indicate to look for translation in the given domain.
domain | the translation domain |
KLocalizedString
KLocalizedString KLocalizedString::withFormat | ( | Kuit::VisualFormat | format | ) | const |
Indicate to resolve KUIT markup into given visual format.
If the message is not markup-aware, this has no effect.
format | the target visual format |
KLocalizedString
KLocalizedString KLocalizedString::withLanguages | ( | const QStringList & | languages | ) | const |
Indicate to look for translation only in given languages.
languages | list of language codes (by decreasing priority) |
KLocalizedString