KLocale Class Reference
KLocale provides support for country specific stuff like the national language. class for supporting locale settings and national language. More...
#include <klocale.h>
Collaboration diagram for KLocale:

Public Types | |
enum | SignPosition { ParensAround = 0, BeforeQuantityMoney = 1, AfterQuantityMoney = 2, BeforeMoney = 3, AfterMoney = 4 } |
enum | ReadDateFlags { NormalFormat = 1, ShortFormat = 2 } |
enum | ReadTimeFlags { WithSeconds = 0, WithoutSeconds = 1 } |
enum | MeasureSystem { Metric, Imperial } |
Public Member Functions | |
KLocale (const QString &catalog, KConfig *config=0) | |
KLocale (const KLocale &rhs) | |
KLocale & | operator= (const KLocale &rhs) |
~KLocale () | |
QString | translate (const char *index) const |
QString | translate (const char *comment, const char *fallback) const |
QString | translate (const char *singular, const char *plural, unsigned long n) const |
bool | setEncoding (int mibEnum) |
bool | setLanguage (const QString &language) |
bool | setLanguage (const QStringList &languages) |
bool | setCountry (const QString &country) |
QString | decimalSymbol () const |
QString | thousandsSeparator () const |
QString | currencySymbol () const |
QString | monetaryDecimalSymbol () const |
QString | monetaryThousandsSeparator () const |
QString | positiveSign () const |
QString | negativeSign () const |
int | fracDigits () const |
bool | positivePrefixCurrencySymbol () const |
bool | negativePrefixCurrencySymbol () const |
SignPosition | positiveMonetarySignPosition () const |
SignPosition | negativeMonetarySignPosition () const |
QString | formatMoney (double num, const QString ¤cy=QString::null, int digits=-1) const |
QString | formatNumber (double num, int precision=-1) const |
QString | formatLong (long num) const |
bool | nounDeclension () const |
QString | formatDate (const QDate &pDate, bool shortFormat=false) const |
bool | dateMonthNamePossessive () const |
QString | formatTime (const QTime &pTime, bool includeSecs, bool isDuration) const |
QString | formatTime (const QTime &pTime, bool includeSecs=false) const |
bool | use12Clock () const |
bool | weekStartsMonday () const KDE_DEPRECATED |
int | weekStartDay () const |
QString | monthName (int i, bool shortName=false) const KDE_DEPRECATED |
QString | monthNamePossessive (int i, bool shortName=false) const KDE_DEPRECATED |
QString | weekDayName (int i, bool shortName=false) const KDE_DEPRECATED |
const KCalendarSystem * | calendar () const |
QString | calendarType () const |
void | setCalendar (const QString &calendarType) |
QString | formatDateTime (const QDateTime &pDateTime, bool shortFormat=true, bool includeSecs=false) const |
double | readMoney (const QString &numStr, bool *ok=0) const |
double | readNumber (const QString &numStr, bool *ok=0) const |
QDate | readDate (const QString &str, bool *ok=0) const |
QDate | readDate (const QString &intstr, const QString &fmt, bool *ok=0) const |
QDate | readDate (const QString &str, ReadDateFlags flags, bool *ok=0) const |
QTime | readTime (const QString &str, bool *ok=0) const |
QTime | readTime (const QString &str, ReadTimeFlags flags, bool *ok=0) const |
QString | language () const |
QString | country () const |
QStringList | languagesTwoAlpha () const |
QStringList | languageList () const |
const char * | encoding () const |
int | encodingMib () const |
QTextCodec * | codecForEncoding () const |
int | fileEncodingMib () const |
void | setDateFormat (const QString &format) |
void | setDateFormatShort (const QString &format) |
void | setDateMonthNamePossessive (bool possessive) |
void | setTimeFormat (const QString &format) |
void | setWeekStartsMonday (bool start) KDE_DEPRECATED |
void | setWeekStartDay (int day) |
QString | dateFormat () const |
QString | dateFormatShort () const |
QString | timeFormat () const |
void | setDecimalSymbol (const QString &symbol) |
void | setThousandsSeparator (const QString &separator) |
void | setPositiveSign (const QString &sign) |
void | setNegativeSign (const QString &sign) |
void | setPositiveMonetarySignPosition (SignPosition signpos) |
void | setNegativeMonetarySignPosition (SignPosition signpos) |
void | setPositivePrefixCurrencySymbol (bool prefix) |
void | setNegativePrefixCurrencySymbol (bool prefix) |
void | setFracDigits (int digits) |
void | setMonetaryThousandsSeparator (const QString &separator) |
void | setMonetaryDecimalSymbol (const QString &symbol) |
void | setCurrencySymbol (const QString &symbol) |
int | pageSize () const |
void | setPageSize (int paperFormat) |
MeasureSystem | measureSystem () const |
void | setMeasureSystem (MeasureSystem value) |
void | insertCatalogue (const QString &catalog) |
void | removeCatalogue (const QString &catalog) |
void | setActiveCatalogue (const QString &catalog) |
QString | translateQt (const char *context, const char *sourceText, const char *message) const |
QStringList | allLanguagesTwoAlpha () const |
QString | twoAlphaToLanguageName (const QString &code) const |
QStringList | allCountriesTwoAlpha () const |
QString | twoAlphaToCountryName (const QString &code) const |
QString | formatMoney (const QString &numStr) const KDE_DEPRECATED |
QString | formatNumber (const QString &numStr) const KDE_DEPRECATED |
QString | languages () const KDE_DEPRECATED |
bool | setCharset (const QString &charset) KDE_DEPRECATED |
QString | charset () const KDE_DEPRECATED |
Static Public Member Functions | |
void | splitLocale (const QString &str, QString &language, QString &country, QString &charset) |
void | setMainCatalogue (const char *catalog) |
QString | langLookup (const QString &fname, const char *rtype="html") |
QString | defaultLanguage () |
QString | defaultCountry () |
QString | _initLanguage (KConfigBase *config) |
Static Protected Member Functions | |
void | initInstance () |
Related Functions | |
(Note that these are not member functions.) | |
I18N_NOOP(x) | |
I18N_NOOP2(comment, x) | |
QString | i18n (const char *text) |
QString | i18n (const char *comment, const char *text) |
QString | i18n (const char *singular, const char *plural, unsigned long n) |
QString | tr2i18n (const char *message, const char *=0) |
Detailed Description
KLocale provides support for country specific stuff like the national language. class for supporting locale settings and national language.KLocale supports translating, as well as specifying the format for numbers, currency, time, and date.
- Author:
- Stephan Kulow <coolo@kde.org>, Preston Brown <pbrown@kde.org>, Hans Petter Bieker <bieker@kde.org>, Lukas Tinkl <lukas.tinkl@suse.cz>
Definition at line 114 of file klocale.h.
Member Enumeration Documentation
|
Various positions for where to place the positive or negative sign when they are related to a monetary value. Definition at line 257 of file klocale.h. Referenced by negativeMonetarySignPosition(), and positiveMonetarySignPosition(). |
|
The Metric system will give you information in mm, while the Imperial system will give you information in inches. Definition at line 972 of file klocale.h. Referenced by measureSystem(). |
Constructor & Destructor Documentation
|
Constructs a KLocale with the given catalog name. The constructor looks for an entry Locale/Language in the configuration file. If no config file is specified, it will also look for languages using the environment variables (KDE_LANG, LC_MESSAGES, LC_ALL, LANG), as well as the global configuration fie. If we were not able to use non of the specified languages, the default language (en_US) will be used. If you specify a configuration file, it has to be valid until the KLocale object is destroyed.
References KInstance::config(), and KGlobal::instance(). |
|
Copy constructor. Definition at line 2243 of file klocale.cpp. |
|
Destructor. Definition at line 686 of file klocale.cpp. |
Member Function Documentation
|
Assignment operator. Definition at line 2250 of file klocale.cpp. References d, m_country, m_currencySymbol, m_dateFormat, m_dateFormatShort, m_decimalSymbol, m_fracDigits, m_language, m_monetaryDecimalSymbol, m_monetaryThousandsSeparator, m_negativeMonetarySignPosition, m_negativePrefixCurrencySymbol, m_negativeSign, m_positiveMonetarySignPosition, m_positivePrefixCurrencySymbol, m_positiveSign, m_thousandsSeparator, and m_timeFormat. |
|
Translates the string into the corresponding string in the national language, if available. If not, returns the string itself. There is a KDE wide message file that contains the most often used phrases, so we can avoid duplicating the translation of these phrases. If a phrase is not found in the catalog given to the constructor, it will search in the system catalog. This makes it possible to override some phrases for your needs. The argument must be an UTF-8 encoded string (If you only use characters that are in US-ASCII you're on the safe side. But for e.g. german umlauts or french accents should be recoded to UTF-8)
Referenced by formatDateTime(), formatTime(), monthName(), monthNamePossessive(), readTime(), KCalendarSystemJalali::weekDayName(), and KCalendarSystem::weekDayName(). |
|
Translates the string into the corresponding string in the national language, if available. The real contents of the string is in the argument fallback, but the meaning of it is coded into the argument index. In some cases you'll need this function, when english is too ambiguous to express it. Most of the times the translators will tell you if it can't be translated as it, but think of cases as "New", where the translations differs depending on what is New. Or simple cases as "Open", that can be used to express something is open or it can be used to express that you want something to open... There are tons of such examples. If translate("Open") is not enough to translate it well, use translate("To Open", "Open") or translate("Is Open", "Open"). The english user will see "Open" in both cases, but the translated version may vary. Of course you can also use i18n()
References endl(). |
|
Used to get the correct, translated singular or plural of a word.
References endl(). |
|
Changes the current encoding.
|
|
Changes the current language. The current language will be left unchanged if failed. It will force a reload of the country specific configuration as well.
|
|
Changes the list of prefed languages for the locale. The first valid language in the list will be used, or the default (en_US) language will be used if non of the specified languages were available.
References defaultLanguage(), and languageList(). |
|
Changes the current country. The current country will be left unchanged if failed. It will force a reload of the country specific configuration.
|
|
Returns what a decimal point should look like ("." or "," etc.) according to the current locale or user settings.
Referenced by formatNumber(), and readNumber(). |
|
Returns what the thousands separator should look like ("," or "." etc.) according to the current locale or user settings.
Referenced by formatNumber(), and readNumber(). |
|
Returns what the symbol denoting currency in the current locale as as defined by user settings should look like.
Referenced by formatMoney(), and readMoney(). |
|
Returns what a decimal point should look like ("." or "," etc.) for monetary values, according to the current locale or user settings.
Referenced by formatMoney(), and readMoney(). |
|
Returns what a thousands separator for monetary values should look like ("," or " " etc.) according to the current locale or user settings.
Referenced by formatMoney(), and readMoney(). |
|
Returns what a positive sign should look like ("+", " ", etc.) according to the current locale or user settings.
Referenced by formatMoney(), and formatNumber(). |
|
Returns what a negative sign should look like ("-", etc.) according to the current locale or user settings.
Referenced by formatMoney(), formatNumber(), readMoney(), and readNumber(). |
|
The number of fractional digits to include in numeric/monetary values (usually 2).
Referenced by formatMoney(). |
|
If and only if the currency symbol precedes a positive value, this will be true.
Referenced by formatMoney(). |
|
If and only if the currency symbol precedes a negative value, this will be true.
Referenced by formatMoney(). |
|
Returns the position of a positive sign in relation to a monetary value.
References SignPosition. Referenced by formatMoney(). |
|
Denotes where to place a negative sign in relation to a monetary value.
References SignPosition. Referenced by formatMoney(), and readMoney(). |
|
Given a double, converts that to a numeric string containing the localized monetary equivalent. e.g. given 123456, return "$ 123,456.00".
References currencySymbol(), fracDigits(), monetaryDecimalSymbol(), monetaryThousandsSeparator(), negativeMonetarySignPosition(), negativePrefixCurrencySymbol(), negativeSign(), positiveMonetarySignPosition(), positivePrefixCurrencySymbol(), and positiveSign(). Referenced by formatMoney(). |
|
Given a double, converts that to a numeric string containing the localized numeric equivalent. e.g. given 123456.78F, return "123,456.78" (for some European country). If precision isn't specified, 2 is used.
References decimalSymbol(), negativeSign(), positiveSign(), and thousandsSeparator(). Referenced by formatLong(), and formatNumber(). |
|
Given an integer, converts that to a numeric string containing the localized numeric equivalent. e.g. given 123456L, return "123,456" (for some European country).
References formatNumber(). |
|
Use this to determine whether nouns are declined in locale's language. This property should remain read-only (no setter function)
|
|
Returns a string formatted to the current locale's conventions regarding dates.
References calendar(), dateFormat(), dateFormatShort(), KCalendarSystem::month(), monthName(), monthNamePossessive(), weekDayName(), and KCalendarSystem::year(). Referenced by formatDateTime(). |
|
Use this to determine whether in dates a possessive form of month name is preferred ("of January" rather than "January").
|
|
Returns a string formatted to the current locale's conventions regarding times.
References timeFormat(), and translate(). Referenced by formatDateTime(), and formatTime(). |
|
Returns a string formatted to the current locale's conventions regarding times.
References formatTime(). |
|
Use this to determine if the user wants a 12 hour clock.
References timeFormat(). |
|
Please use the weekStartDay method instead. Use this to determine if the user wants the week to start on Monday.
|
|
Use this to determine which day is the first day of the week.
|
|
Returns a string containing the name of the month name used in the Gregorian calendar.
#include <kcalendarsystem.h>
References translate(). Referenced by formatDate(). |
|
Returns a string containing the possessive form of the month name used in the Gregorian calendar. ("of January", "of February", etc.) It's needed in long format dates in some languages.
#include <kcalendarsystem.h>
References translate(). Referenced by formatDate(). |
|
References calendar(), and KCalendarSystem::weekDayName(). Referenced by formatDate(). |
|
Returns a pointer to the calendar system object.
References KCalendarSystemFactory::create(). Referenced by formatDate(), readDate(), and weekDayName(). |
|
Returns the name of the calendar system that is currently being used by the system.
|
|
Changes the current calendar system to the calendar specified. Currently "gregorian" and "hijri" are supported. If the calendar system specified is not found, gregorian will be used.
|
|
Returns a string formated to the current locale's conventions regarding both date and time.
References formatDate(), formatTime(), and translate(). |
|
Converts a localized monetary string to a double.
References currencySymbol(), monetaryDecimalSymbol(), monetaryThousandsSeparator(), negativeMonetarySignPosition(), and negativeSign(). |
|
Converts a localized numeric string to a double.
References decimalSymbol(), negativeSign(), and thousandsSeparator(). |
|
Converts a localized date string to a QDate. The bool pointed by ok will be invalid if the date entered was not valid.
Referenced by readDate(). |
|
Converts a localized date string to a QDate, using the specified format. You will usually not want to use this method. Definition at line 1448 of file klocale.cpp. References calendar(), KCalendarSystem::dayStringToInteger(), KCalendarSystem::monthName(), KCalendarSystem::monthNamePossessive(), KCalendarSystem::monthStringToInteger(), KCalendarSystem::setYMD(), KCalendarSystem::weekDayName(), KCalendarSystem::year(), and KCalendarSystem::yearStringToInteger(). |
|
Converts a localized date string to a QDate.
This method is stricter than readDate(str,&ok): it will either accept a date in full format or a date in short format, depending on
References dateFormat(), dateFormatShort(), and readDate(). |
|
Converts a localized time string to a QTime.
This method will try to parse it with seconds, then without seconds. The bool pointed to by
|
|
Converts a localized time string to a QTime. This method is stricter than readTime(str,&ok): it will either accept a time with seconds or a time without seconds. Use this method when the format is known by the application.
References timeFormat(), and translate(). |
|
Returns the language used by this object. The domain AND the library translation must be available in this language. defaultLanguage() is returned by default, if no other available.
Referenced by KConfigBase::setLocale(). |
|
Returns the country code of the country where the user lives. defaultCountry() is returned by default, if no other available.
|
|
Returns the preferred languages as ISO 639-1 codes. This means that information about country is removed. If the internal language code might be represented by more than one 639-1 code, they will all be listed (but only once). If the selected languages are "nn, nb, pt_BR", you will get: "nn, no, nb, pt".
References KConfigBase::hasKey(), languageList(), KConfigBase::readListEntry(), and KConfigBase::setGroup(). |
|
Returns the languages selected by user. The codes returned here is the internal language codes.
Referenced by langLookup(), languagesTwoAlpha(), and setLanguage(). |
|
Returns the user's preferred encoding.
References codecForEncoding(). |
|
Returns the user's preferred encoding.
References codecForEncoding(). |
|
Returns the user's preferred encoding. Should never be NULL.
Referenced by KCharsets::codecForName(), encoding(), encodingMib(), and fileEncodingMib(). |
|
Returns the file encoding.
References codecForEncoding(). |
|
Changes the current date format. The format of the date is a string which contains variables that will be replaced:
|
|
Changes the current short date format. The format of the date is a string which contains variables that will be replaced:
|
|
Changes the form of month name used in dates.
|
|
Changes the current time format. The format of the time is string a which contains variables that will be replaced:
|
|
Please use setWeekStartDay instead. Changes how KLocale defines the first day in week.
|
|
Changes how KLocale defines the first day in week.
|
|
Returns the currently selected date format.
Referenced by formatDate(), and readDate(). |
|
Returns the currently selected short date format.
Referenced by formatDate(), and readDate(). |
|
Returns the currently selected time format.
Referenced by formatTime(), readTime(), and use12Clock(). |
|
Changes the symbol used to identify the decimal pointer.
|
|
Changes the separator used to group digits when formating numbers.
|
|
Changes the sign used to identify a positive number. Normally this is left blank.
|
|
Changes the sign used to identify a negative number.
|
|
Changes the sign position used for positive monetary values.
|
|
Changes the sign position used for negative monetary values.
|
|
Changes the position where the currency symbol should be printed for positive monetary values.
|
|
Changes the position where the currency symbol should be printed for negative monetary values.
|
|
Changes the number of digits used when formating numbers.
|
|
Changes the separator used to group digits when formating monetary values.
|
|
Changes the symbol used to identify the decimal pointer for monetary values.
|
|
Changes the current currency symbol.
|
|
Returns the preferred page size for printing.
|
|
Changes the preferred page size when printing.
|
|
Returns which measuring system we use.
References MeasureSystem. |
|
Changes the preferred measuring system.
|
|
Adds another catalog to search for translation lookup. This function is useful for extern libraries and/or code, that provide there own messages. If the catalog does not exist for the chosen language, it will be ignored and en_US will be used.
|
|
Removes a catalog for translation lookup.
|
|
Sets the active catalog for translation lookup.
Referenced by KGlobal::setActiveInstance(). |
|
Translates a message as a QTranslator is supposed to. The parameters are similar to i18n(), but the result value has other semantics (it can be QString::null)
References endl(). |
|
Returns list of all known ISO 639-1 codes.
|
|
Convert a ISO 639-1 code to a human readable form.
|
|
Returns list of all known country codes.
References KGlobal::dirs(), and KStandardDirs::findAllResources(). |
|
Convert a country code to a human readable form.
|
|
Returns the parts of the parameter str understood as language setting the format is language_COUNTRY.charset.
|
|
Use this as main catalog for *all* KLocales, if not the appname will be used. This function is best to be the very first instruction in your program's main function as it only has an effect before the first KLocale object is created.
|
|
Finds localized resource in resourceDir( rtype ) + <lang> + fname.
References defaultLanguage(), KGlobal::dirs(), endl(), languageList(), KGlobal::locale(), and KStandardDirs::resourceDirs(). |
|
Returns the name of the internal language.
Referenced by langLookup(), setLanguage(), and KConfigBase::setLocale(). |
|
Returns the name of the default country.
|
|
References formatMoney(). |
|
References formatNumber(). |
|
|
|
|
|
|
Friends And Related Function Documentation
|
I18N_NOOP marks a string to be translated without translating it. Do not use this unless you know you need it. http://developer.kde.org/documentation/other/developer-faq.html#q2.11.2 Definition at line 48 of file klocale.h. |
|
If the string is too ambiguous to be translated well to a non-english language, use this instead of I18N_NOOP to separate lookup string and english. Warning: you need to call i18n( comment, stringVar ) later on, not just i18n( stringVar ). Definition at line 58 of file klocale.h. |
|
i18n is the function that does everything you need to translate a string. You just wrap around every user visible string a i18n call to get a QString with the string in the user's preferred language. The argument must be an UTF-8 encoded string (If you only use characters that are in US-ASCII, you're on the safe side. But for e.g. german umlauts or french accents should be recoded to UTF-8) Definition at line 1813 of file klocale.cpp. References KGlobal::locale(). |
|
If the string is too ambiguous to be translated well to a non-english language, use this form of i18n to separate lookup string and english text.
References KGlobal::locale(). |
|
If you want to handle plural forms, use this form of i18n. The plural has to contain a n where n fits into.
References KGlobal::locale(). |
|
Qt3's uic generates i18n( "msg", "comment" ) calls which conflict with our i18n method. We use uic -tr tr2i18n to redirect to the right i18n() function Definition at line 98 of file klocale.h. |
The documentation for this class was generated from the following files: