KI18n 5.109.0
Public Member Functions | Static Public Member Functions | List of all members
KLocalizedString

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.
 
KLocalizedStringoperator= (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.
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ KLocalizedString() [1/2]

KLocalizedString::KLocalizedString ( )
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.

See also
isEmpty

◆ KLocalizedString() [2/2]

KLocalizedString::KLocalizedString ( const KLocalizedString rhs)

Copy constructor.

◆ ~KLocalizedString()

KLocalizedString::~KLocalizedString ( )

Destructor.

Member Function Documentation

◆ addDomainLocaleDir()

static void KLocalizedString::addDomainLocaleDir ( const QByteArray &  domain,
const QString &  path 
)
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.

Parameters
thedomain to load resources from \path the full file path to the locale directory

◆ applicationDomain()

static QByteArray KLocalizedString::applicationDomain ( )
static

Get the application's main translation domain.

Returns the domain set by setApplicationDomain.

◆ availableApplicationTranslations()

static QSet< QString > KLocalizedString::availableApplicationTranslations ( )
static
Since
5.0

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).

Returns
set of language codes for existing translation catalogs
See also
setApplicationDomain

◆ availableDomainTranslations()

static QSet< QString > KLocalizedString::availableDomainTranslations ( const QByteArray &  domain)
static
Since
5.0

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).

Parameters
domainquery for translations of a specific domain, if an empty QByteArray is passed, an empty set will be returned
Returns
set of language codes for existing translation catalogs
See also
setApplicationDomain
availableApplicationTranslations

◆ clearLanguages()

static void KLocalizedString::clearLanguages ( )
static

Clear override languages.

This clears the override languages, going back to those provided by the locale.

See also
setLanguages
languages

◆ ignoreMarkup()

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.

Returns
updated KLocalizedString

◆ inContext()

KLocalizedString KLocalizedString::inContext ( const QString &  key,
const QString &  value 
) const

Add dynamic context to the message.

See dyn_ctxt for use cases.

Parameters
keycontext key
valuecontext value
Returns
updated KLocalizedString

◆ isApplicationTranslatedInto()

static bool KLocalizedString::isApplicationTranslatedInto ( const QString &  language)
static

Check whether the translation catalog file in the given language for the set application translation domain exists.

Parameters
languagethe language code to check
Returns
true if the translation catalog for language exits, false otherwise
See also
setApplicationDomain

◆ isEmpty()

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.

Returns
true if the message is empty, false otherwise

◆ languages()

static QStringList KLocalizedString::languages ( )
static

Get the languages for which translations will be made.

Returned languages are ordered with decreasing priority.

Returns
languages ordered list of language codes
See also
setLanguages
clearLanguages
Since
5.20.0

◆ localizedFilePath()

static QString KLocalizedString::localizedFilePath ( const QString &  filePath)
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.

Parameters
filePathpath to the original file
Returns
path to the localized file if found, original path otherwise

◆ operator=()

KLocalizedString & KLocalizedString::operator= ( const KLocalizedString rhs)

Assignment operator.

◆ relaxSubs()

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.

Returns
updated KLocalizedString

◆ removeAcceleratorMarker()

static QString KLocalizedString::removeAcceleratorMarker ( const QString &  label)
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.

Parameters
labelUI label which may contain an accelerator marker
Returns
label without the accelerator marker

◆ setApplicationDomain()

static void KLocalizedString::setApplicationDomain ( const char *  domain)
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.

Parameters
domainthe translation domain of the application

◆ setLanguages()

static void KLocalizedString::setLanguages ( const QStringList &  languages)
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.

Parameters
languagesordered list of language codes
See also
setLocale
clearLanguages
languages

◆ subs() [1/10]

KLocalizedString KLocalizedString::subs ( const KLocalizedString a,
int  fieldWidth = 0,
QChar  fillChar = QLatin1Char(' ') 
) const

Substitute another KLocalizedString into the message.

Parameters
athe argument
fieldWidthwidth of the formatted field, padded by spaces. Positive value aligns right, negative aligns left
fillCharthe character used to fill up the empty places when field width is greater than argument width
Returns
updated KLocalizedString

◆ subs() [2/10]

KLocalizedString KLocalizedString::subs ( const QString &  a,
int  fieldWidth = 0,
QChar  fillChar = QLatin1Char(' ') 
) const

Substitute a QString argument into the message.

Parameters
athe argument
fieldWidthwidth of the formatted field, padded by spaces. Positive value aligns right, negative aligns left
fillCharthe character used to fill up the empty places when field width is greater than argument width
Returns
updated KLocalizedString

◆ subs() [3/10]

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.

Parameters
athe argument
fieldWidthwidth of the formatted field, padded by spaces. Positive value aligns right, negative aligns left
formattype of floating point formatting, like in QString::arg
precisionnumber of digits after the decimal separator
fillCharthe character used to fill up the empty places when field width is greater than argument width
Returns
updated KLocalizedString

◆ subs() [4/10]

KLocalizedString KLocalizedString::subs ( int  a,
int  fieldWidth = 0,
int  base = 10,
QChar  fillChar = QLatin1Char(' ') 
) const

Substitute an int argument into the message.

Parameters
athe argument
fieldWidthwidth of the formatted field, padded by spaces. Positive value aligns right, negative aligns left
basethe radix used to represent the number as a string. Valid values range from 2 to 36
fillCharthe character used to fill up the empty places when field width is greater than argument width
Returns
updated KLocalizedString

◆ subs() [5/10]

KLocalizedString KLocalizedString::subs ( long  a,
int  fieldWidth = 0,
int  base = 10,
QChar  fillChar = QLatin1Char(' ') 
) const

Substitute a long argument into the message.

Parameters
athe argument
fieldWidthwidth of the formatted field, padded by spaces. Positive value aligns right, negative aligns left
basethe radix used to represent the number as a string. Valid values range from 2 to 36
fillCharthe character used to fill up the empty places when field width is greater than argument width
Returns
updated KLocalizedString

◆ subs() [6/10]

KLocalizedString KLocalizedString::subs ( QChar  a,
int  fieldWidth = 0,
QChar  fillChar = QLatin1Char(' ') 
) const

Substitute a QChar argument into the message.

Parameters
athe argument
fieldWidthwidth of the formatted field, padded by spaces. Positive value aligns right, negative aligns left
fillCharthe character used to fill up the empty places when field width is greater than argument width
Returns
updated KLocalizedString

◆ subs() [7/10]

KLocalizedString KLocalizedString::subs ( qlonglong  a,
int  fieldWidth = 0,
int  base = 10,
QChar  fillChar = QLatin1Char(' ') 
) const

Substitute a long long argument into the message.

Parameters
athe argument
fieldWidthwidth of the formatted field, padded by spaces. Positive value aligns right, negative aligns left
basethe radix used to represent the number as a string. Valid values range from 2 to 36
fillCharthe character used to fill up the empty places when field width is greater than argument width
Returns
updated KLocalizedString

◆ subs() [8/10]

KLocalizedString KLocalizedString::subs ( qulonglong  a,
int  fieldWidth = 0,
int  base = 10,
QChar  fillChar = QLatin1Char(' ') 
) const

Substitute an unsigned long long argument into the message.

Parameters
athe argument
fieldWidthwidth of the formatted field, padded by spaces. Positive value aligns right, negative aligns left
basethe radix used to represent the number as a string. Valid values range from 2 to 36
fillCharthe character used to fill up the empty places when field width is greater than argument width
Returns
updated KLocalizedString

◆ subs() [9/10]

KLocalizedString KLocalizedString::subs ( uint  a,
int  fieldWidth = 0,
int  base = 10,
QChar  fillChar = QLatin1Char(' ') 
) const

Substitute an unsigned int argument into the message.

Parameters
athe argument
fieldWidthwidth of the formatted field, padded by spaces. Positive value aligns right, negative aligns left
basethe radix used to represent the number as a string. Valid values range from 2 to 36
fillCharthe character used to fill up the empty places when field width is greater than argument width
Returns
updated KLocalizedString

◆ subs() [10/10]

KLocalizedString KLocalizedString::subs ( ulong  a,
int  fieldWidth = 0,
int  base = 10,
QChar  fillChar = QLatin1Char(' ') 
) const

Substitute an unsigned long argument into the message.

Parameters
athe argument
fieldWidthwidth of the formatted field, padded by spaces. Positive value aligns right, negative aligns left
basethe radix used to represent the number as a string. Valid values range from 2 to 36
fillCharthe character used to fill up the empty places when field width is greater than argument width
Returns
updated KLocalizedString

◆ toString() [1/4]

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.

Returns
finalized translation

◆ toString() [2/4]

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.

Parameters
domainthe translation domain
Returns
finalized translation

◆ toString() [3/4]

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.

Parameters
languageslist of language codes (by decreasing priority)
Returns
finalized translation

◆ toString() [4/4]

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.

Parameters
formatthe target visual format
Returns
finalized translation

◆ untranslatedText()

QByteArray KLocalizedString::untranslatedText ( ) const

Returns the untranslated text.

Since
5.64

◆ withDomain()

KLocalizedString KLocalizedString::withDomain ( const char *  domain) const

Indicate to look for translation in the given domain.

Parameters
domainthe translation domain
Returns
updated KLocalizedString

◆ withFormat()

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.

Parameters
formatthe target visual format
Returns
updated KLocalizedString

◆ withLanguages()

KLocalizedString KLocalizedString::withLanguages ( const QStringList &  languages) const

Indicate to look for translation only in given languages.

Parameters
languageslist of language codes (by decreasing priority)
Returns
updated KLocalizedString