klocalizedstring.h File Reference

#include <ki18n_export.h>
#include <QChar>
#include <QLatin1Char>
#include <QSet>
#include <QString>
#include <QStringList>
#include <memory>
#include <kuitsetup.h>
#include <klocalizedcontext.h>

Include dependency graph for klocalizedstring.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	KLocalizedString

Macros
#define	I18N_NOOP(text)   text
#define	I18N_NOOP2(context, text)   text
#define	I18N_NOOP2_NOSTRIP(context, text)   context, text
#define	I18NC_NOOP(context, text)   context, text

Functions
QString	i18n (const char *text, const TYPE &arg...)
QString	i18nc (const char *context, const char *text, const TYPE &arg...)
QString	i18ncp (const char *context, const char *singular, const char *plural, const TYPE &arg...)
QString	i18nd (const char *domain, const char *text, const TYPE &arg...)
QString	i18ndc (const char *domain, const char *context, const char *text, const TYPE &arg...)
QString	i18ndcp (const char *domain, const char *context, const char *singular, const char *plural, const TYPE &arg...)
QString	i18ndp (const char *domain, const char *singular, const char *plural, const TYPE &arg...)
QString	i18np (const char *singular, const char *plural, const TYPE &arg...)
KLocalizedString KI18N_EXPORT	ki18n (const char *text)
KLocalizedString KI18N_EXPORT	ki18nc (const char *context, const char *text)
KLocalizedString KI18N_EXPORT	ki18ncp (const char *context, const char *singular, const char *plural)
KLocalizedString KI18N_EXPORT	ki18nd (const char *domain, const char *text)
KLocalizedString KI18N_EXPORT	ki18ndc (const char *domain, const char *context, const char *text)
KLocalizedString KI18N_EXPORT	ki18ndcp (const char *domain, const char *context, const char *singular, const char *plural)
KLocalizedString KI18N_EXPORT	ki18ndp (const char *domain, const char *singular, const char *plural)
KLocalizedString KI18N_EXPORT	ki18np (const char *singular, const char *plural)
KLocalizedString KI18N_EXPORT	kxi18n (const char *text)
KLocalizedString KI18N_EXPORT	kxi18nc (const char *context, const char *text)
KLocalizedString KI18N_EXPORT	kxi18ncp (const char *context, const char *singular, const char *plural)
KLocalizedString KI18N_EXPORT	kxi18nd (const char *domain, const char *text)
KLocalizedString KI18N_EXPORT	kxi18ndc (const char *domain, const char *context, const char *text)
KLocalizedString KI18N_EXPORT	kxi18ndcp (const char *domain, const char *context, const char *singular, const char *plural)
KLocalizedString KI18N_EXPORT	kxi18ndp (const char *domain, const char *singular, const char *plural)
KLocalizedString KI18N_EXPORT	kxi18np (const char *singular, const char *plural)
QString	tr2i18n (const char *text, const char *comment=nullptr)
QString	tr2i18nd (const char *domain, const char *text, const char *comment=nullptr)
QString	tr2xi18n (const char *text, const char *comment=nullptr)
QString	tr2xi18nd (const char *domain, const char *text, const char *comment=nullptr)
QString	xi18n (const char *text, const TYPE &arg...)
QString	xi18nc (const char *context, const char *text, const TYPE &arg...)
QString	xi18ncp (const char *context, const char *singular, const char *plural, const TYPE &arg...)
QString	xi18nd (const char *domain, const char *text, const TYPE &arg...)
QString	xi18ndc (const char *domain, const char *context, const char *text, const TYPE &arg...)
QString	xi18ndcp (const char *domain, const char *context, const char *singular, const char *plural, const TYPE &arg...)
QString	xi18ndp (const char *domain, const char *singular, const char *plural, const TYPE &arg...)
QString	xi18np (const char *singular, const char *plural, const TYPE &arg...)

Macro Definition Documentation

I18N_NOOP

#define I18N_NOOP

(

text

)

text

Wrap string for extraction.

See i18n_noop for use cases.

Deprecated:

since 5.89, use kli18n() instead.

Definition at line 41 of file klocalizedstring.h.

I18N_NOOP2

#define I18N_NOOP2	(		context,
			text
	)		text

Wrap string with context for extraction, discarding context.

WARNING: this means you'll need to pass the exact same context when calling i18nc() later on. Do not make typos... The preferred solution is to use I18NC_NOOP and store both context and text. I18NC_NOOP2 exists for cases where storing the context is not possible.

Deprecated:

between 5.0 and 5.64, re-enabled in 5.65, re-deprecated in 5.89, use kli18nc() instead.

Definition at line 69 of file klocalizedstring.h.

I18N_NOOP2_NOSTRIP

#define I18N_NOOP2_NOSTRIP	(		context,
			text
	)		context, text

Wrap string with context for extraction.

Deprecated:

Since 5.0, use I18NC_NOOP.

Definition at line 80 of file klocalizedstring.h.

I18NC_NOOP

#define I18NC_NOOP	(		context,
			text
	)		context, text

Wrap string with context for extraction.

See i18n_noop for use cases.

Deprecated:

since 5.89, use kli18nc() instead.

Definition at line 54 of file klocalizedstring.h.

Function Documentation

i18n()

QString i18n	(	const char *	text,
		const TYPE &	arg...
	)

Translate a string and substitute any arguments.

Parameters

text	string to translate
arg	arguments to insert (0 to 9), admissible types according to KLocalizedString::subs methods

Returns

translated string

i18nc()

QString i18nc	(	const char *	context,
		const char *	text,
		const TYPE &	arg...
	)

Translate a string with context and substitute any arguments.

Parameters

context	context of the string
text	string to translate
arg	arguments to insert (0 to 9), admissible types according to KLocalizedString::subs methods

Returns

translated string

i18ncp()

QString i18ncp	(	const char *	context,
		const char *	singular,
		const char *	plural,
		const TYPE &	arg...
	)

Translate a string with context and plural and substitute any arguments.

Parameters

context	context of the string
singular	singular form of the string to translate
plural	plural form of the string to translate
arg	arguments to insert (0 to 9), admissible types according to KLocalizedString::subs methods

Returns

translated string

i18nd()

QString i18nd	(	const char *	domain,
		const char *	text,
		const TYPE &	arg...
	)

Translate a string from domain and substitute any arguments.

Parameters

domain	domain in which to look for translations
text	string to translate
arg	arguments to insert (0 to 9), admissible types according to KLocalizedString::subs methods

Returns

translated string

i18ndc()

QString i18ndc	(	const char *	domain,
		const char *	context,
		const char *	text,
		const TYPE &	arg...
	)

Translate a string from domain with context and substitute any arguments.

Parameters

domain	domain in which to look for translations
context	context of the string
text	string to translate
arg	arguments to insert (0 to 9), admissible types according to KLocalizedString::subs methods

Returns

translated string

i18ndcp()

QString i18ndcp	(	const char *	domain,
		const char *	context,
		const char *	singular,
		const char *	plural,
		const TYPE &	arg...
	)

Translate a string from domain with context and plural and substitute any arguments.

Parameters

domain	domain in which to look for translations
context	context of the string
singular	singular form of the string to translate
plural	plural form of the string to translate
arg	arguments to insert (0 to 9), admissible types according to KLocalizedString::subs methods

Returns

translated string

i18ndp()

QString i18ndp	(	const char *	domain,
		const char *	singular,
		const char *	plural,
		const TYPE &	arg...
	)

Translate a string from domain with plural and substitute any arguments.

Parameters

domain	domain in which to look for translations
singular	singular form of the string to translate
plural	plural form of the string to translate
arg	arguments to insert (0 to 9), admissible types according to KLocalizedString::subs methods

Returns

translated string

i18np()

QString i18np	(	const char *	singular,
		const char *	plural,
		const TYPE &	arg...
	)

Translate a string with plural and substitute any arguments.

Parameters

singular	singular form of the string to translate
plural	plural form of the string to translate
arg	arguments to insert (0 to 9), admissible types according to KLocalizedString::subs methods

Returns

translated string

ki18n()

KLocalizedString KI18N_EXPORT ki18n

(

const char *

text

)

Create non-finalized translated string.

Parameters

text	string to translate

Returns

non-finalized translated string

Definition at line 1467 of file klocalizedstring.cpp.

ki18nc()

KLocalizedString KI18N_EXPORT ki18nc	(	const char *	context,
		const char *	text
	)

Create non-finalized translated string with context.

Parameters

context	context of the string
text	string to translate

Returns

non-finalized translated string

Definition at line 1472 of file klocalizedstring.cpp.

ki18ncp()

KLocalizedString KI18N_EXPORT ki18ncp	(	const char *	context,
		const char *	singular,
		const char *	plural
	)

Create non-finalized translated string with context and plural.

Parameters

context	context of the string
singular	singular form of the string to translate
plural	plural form of the string to translate

Returns

non-finalized translated string

Definition at line 1482 of file klocalizedstring.cpp.

ki18nd()

KLocalizedString KI18N_EXPORT ki18nd	(	const char *	domain,
		const char *	text
	)

Create non-finalized translated string from domain.

Parameters

domain	domain in which to look for translations
text	string to translate

Returns

non-finalized translated string

Definition at line 1487 of file klocalizedstring.cpp.

ki18ndc()

KLocalizedString KI18N_EXPORT ki18ndc	(	const char *	domain,
		const char *	context,
		const char *	text
	)

Create non-finalized translated string from domain with context.

Parameters

domain	domain in which to look for translations
context	context of the string
text	string to translate

Returns

non-finalized translated string

Definition at line 1492 of file klocalizedstring.cpp.

ki18ndcp()

KLocalizedString KI18N_EXPORT ki18ndcp	(	const char *	domain,
		const char *	context,
		const char *	singular,
		const char *	plural
	)

Create non-finalized translated string from domain with context and plural.

Parameters

domain	domain in which to look for translations
context	context of the string
singular	singular form of the string to translate
plural	plural form of the string to translate

Returns

non-finalized translated string

Definition at line 1502 of file klocalizedstring.cpp.

ki18ndp()

KLocalizedString KI18N_EXPORT ki18ndp	(	const char *	domain,
		const char *	singular,
		const char *	plural
	)

Create non-finalized translated string from domain with plural.

Parameters

domain	domain in which to look for translations
singular	singular form of the string to translate
plural	plural form of the string to translate

Returns

non-finalized translated string

Definition at line 1497 of file klocalizedstring.cpp.

ki18np()

KLocalizedString KI18N_EXPORT ki18np	(	const char *	singular,
		const char *	plural
	)

Create non-finalized translated string with plural.

Parameters

singular	singular form of the string to translate
plural	plural form of the string to translate

Returns

non-finalized translated string

Definition at line 1477 of file klocalizedstring.cpp.

kxi18n()

KLocalizedString KI18N_EXPORT kxi18n

(

const char *

text

)

Create non-finalized markup-aware translated string.

Parameters

text	string to translate

Returns

non-finalized translated string

Definition at line 1507 of file klocalizedstring.cpp.

kxi18nc()

KLocalizedString KI18N_EXPORT kxi18nc	(	const char *	context,
		const char *	text
	)

Create non-finalized markup-aware translated string with context.

Parameters

context	context of the string
text	string to translate

Returns

non-finalized translated string

Definition at line 1512 of file klocalizedstring.cpp.

kxi18ncp()

KLocalizedString KI18N_EXPORT kxi18ncp	(	const char *	context,
		const char *	singular,
		const char *	plural
	)

Create non-finalized markup-aware translated string.

with context and plural.

Parameters

context	context of the string
singular	singular form of the string to translate
plural	plural form of the string to translate

Returns

non-finalized translated string

Definition at line 1522 of file klocalizedstring.cpp.

kxi18nd()

KLocalizedString KI18N_EXPORT kxi18nd	(	const char *	domain,
		const char *	text
	)

Create non-finalized markup-aware translated string from domain.

Parameters

domain	domain in which to look for translations
text	string to translate

Returns

non-finalized translated string

Definition at line 1527 of file klocalizedstring.cpp.

kxi18ndc()

KLocalizedString KI18N_EXPORT kxi18ndc	(	const char *	domain,
		const char *	context,
		const char *	text
	)

Create non-finalized markup-aware translated string from domain with context.

Parameters

domain	domain in which to look for translations
context	context of the string
text	string to translate

Returns

non-finalized translated string

Definition at line 1532 of file klocalizedstring.cpp.

kxi18ndcp()

KLocalizedString KI18N_EXPORT kxi18ndcp	(	const char *	domain,
		const char *	context,
		const char *	singular,
		const char *	plural
	)

Create non-finalized markup-aware translated string from domain with context and plural.

Parameters

domain	domain in which to look for translations
context	context of the string
singular	singular form of the string to translate
plural	plural form of the string to translate

Returns

non-finalized translated string

Definition at line 1542 of file klocalizedstring.cpp.

kxi18ndp()

KLocalizedString KI18N_EXPORT kxi18ndp	(	const char *	domain,
		const char *	singular,
		const char *	plural
	)

Create non-finalized markup-aware translated string from domain with plural.

Parameters

domain	domain in which to look for translations
singular	singular form of the string to translate
plural	plural form of the string to translate

Returns

non-finalized translated string

Definition at line 1537 of file klocalizedstring.cpp.

kxi18np()

KLocalizedString KI18N_EXPORT kxi18np	(	const char *	singular,
		const char *	plural
	)

Create non-finalized markup-aware translated string with plural.

Parameters

singular	singular form of the string to translate
plural	plural form of the string to translate

Returns

non-finalized translated string

Definition at line 1517 of file klocalizedstring.cpp.

tr2i18n()

QString tr2i18n ( const char *  text, const char *  comment = nullptr  )

inline

Redirect Qt's uic-generated translation calls to Ki18n.

Use -tr tr2i18n option to uic to have it redirect calls.

Parameters

text	string to translate
comment	Qt equivalent of disambiguation context

Returns

translated string

Definition at line 1038 of file klocalizedstring.h.

tr2i18nd()

QString tr2i18nd ( const char *  domain, const char *  text, const char *  comment = nullptr  )

inline

Like tr2i18n, but look for translation in a specific domain.

Use -tr tr2i18nd option to uic to have it redirect calls.

Parameters

domain	domain in which to look for translations
text	string to translate
comment	Qt equivalent of disambiguation context

Returns

translated string

Definition at line 1059 of file klocalizedstring.h.

tr2xi18n()

QString tr2xi18n ( const char *  text, const char *  comment = nullptr  )

inline

Like tr2i18n, but when UI strings are KUIT markup-aware.

Use -tr tr2xi18n option to uic to have it redirect calls.

Parameters

text	markup-aware string to translate
comment	Qt equivalent of disambiguation context

Returns

translated string

Definition at line 1079 of file klocalizedstring.h.

tr2xi18nd()

QString tr2xi18nd ( const char *  domain, const char *  text, const char *  comment = nullptr  )

inline

Like tr2xi18n, but look for translation in a specific domain.

Use -tr tr2xi18nd option to uic to have it redirect calls.

Parameters

domain	domain in which to look for translations
text	markup-aware string to translate
comment	Qt equivalent of disambiguation context

Returns

translated string

Definition at line 1100 of file klocalizedstring.h.

xi18n()

QString xi18n	(	const char *	text,
		const TYPE &	arg...
	)

Translate a markup-aware string and substitute any arguments.

Parameters

text	string to translate
arg	arguments to insert (0 to 9), admissible types according to KLocalizedString::subs methods

Returns

translated string

xi18nc()

QString xi18nc	(	const char *	context,
		const char *	text,
		const TYPE &	arg...
	)

Translate a markup-aware string with context and substitute any arguments.

Parameters

context	context of the string
text	string to translate
arg	arguments to insert (0 to 9), admissible types according to KLocalizedString::subs methods

Returns

translated string

xi18ncp()

QString xi18ncp	(	const char *	context,
		const char *	singular,
		const char *	plural,
		const TYPE &	arg...
	)

Translate a markup-aware string with context and plural and substitute any arguments.

Parameters

context	context of the string
singular	singular form of the string to translate
plural	plural form of the string to translate
arg	arguments to insert (0 to 9), admissible types according to KLocalizedString::subs methods

Returns

translated string

xi18nd()

QString xi18nd	(	const char *	domain,
		const char *	text,
		const TYPE &	arg...
	)

Translate a markup-aware string from domain and substitute any arguments.

Parameters

domain	domain in which to look for translations
text	string to translate
arg	arguments to insert (0 to 9), admissible types according to KLocalizedString::subs methods

Returns

translated string

xi18ndc()

QString xi18ndc	(	const char *	domain,
		const char *	context,
		const char *	text,
		const TYPE &	arg...
	)

Translate a markup-aware string from domain with context and substitute any arguments.

Parameters

domain	domain in which to look for translations
context	context of the string
text	string to translate
arg	arguments to insert (0 to 9), admissible types according to KLocalizedString::subs methods

Returns

translated string

xi18ndcp()

QString xi18ndcp	(	const char *	domain,
		const char *	context,
		const char *	singular,
		const char *	plural,
		const TYPE &	arg...
	)

Translate a markup-aware string from domain with context and plural and substitute any arguments.

Parameters

domain	domain in which to look for translations
context	context of the string
singular	singular form of the string to translate
plural	plural form of the string to translate
arg	arguments to insert (0 to 9), admissible types according to KLocalizedString::subs methods

Returns

translated string

xi18ndp()

QString xi18ndp	(	const char *	domain,
		const char *	singular,
		const char *	plural,
		const TYPE &	arg...
	)

Translate a markup-aware string from domain with plural and substitute any arguments.

Parameters

domain	domain in which to look for translations
singular	singular form of the string to translate
plural	plural form of the string to translate
arg	arguments to insert (0 to 9), admissible types according to KLocalizedString::subs methods

Returns

translated string

xi18np()

QString xi18np	(	const char *	singular,
		const char *	plural,
		const TYPE &	arg...
	)

Translate a markup-aware string with plural and substitute any arguments.

Parameters

singular	singular form of the string to translate
plural	plural form of the string to translate
arg	arguments to insert (0 to 9), admissible types according to KLocalizedString::subs methods

Returns

translated string