KDECore
KLocale Class Reference
#include <klocale.h>
Detailed Description
KLocale provides support for country specific stuff like the national language.KLocale supports translating, as well as specifying the format for numbers, currency, time, and date.
Use KGlobal::locale() to get pointer to the global KLocale object, containing the applications current locale settings.
For example, to format the date May 17, 1995 in the current locale, use:
QString date = KGlobal::locale()->formatDate(QDate(1995,5,17));
Definition at line 67 of file klocale.h.
Public Types | |
enum | DateFormat { ShortDate, LongDate, FancyShortDate, FancyLongDate } |
enum | DateTimeFormatOption { TimeZone = 0x01, Seconds = 0x02 } |
enum | MeasureSystem { Metric, Imperial } |
enum | ReadDateFlags { NormalFormat = 1, ShortFormat = 2 } |
enum | ReadTimeFlags { WithSeconds = 0, WithoutSeconds = 1 } |
enum | SignPosition { ParensAround = 0, BeforeQuantityMoney = 1, AfterQuantityMoney = 2, BeforeMoney = 3, AfterMoney = 4 } |
Public Member Functions | |
QStringList | allCountriesList () const |
QStringList | allLanguagesList () const |
const KCalendarSystem * | calendar () const |
QString | calendarType () const |
QTextCodec * | codecForEncoding () const |
void | copyCatalogsTo (KLocale *locale) |
QString | country () const |
QString | countryCodeToName (const QString &country) const |
QString | currencySymbol () const |
QString | dateFormat () const |
QString | dateFormatShort () const |
bool | dateMonthNamePossessive () const |
QString | decimalSymbol () const |
const QByteArray | encoding () const |
int | encodingMib () const |
int | fileEncodingMib () const |
QString | formatByteSize (double size) const |
QString | formatDate (const QDate &date, DateFormat format=LongDate) const |
QString | formatDateTime (const KDateTime &dateTime, DateFormat format=ShortDate, DateTimeFormatOptions options=0) const |
QString | formatDateTime (const QDateTime &dateTime, DateFormat format=ShortDate, bool includeSecs=false) const |
QString | formatDuration (unsigned long mSec) const |
QString | formatLong (long num) const |
QString | formatMoney (double num, const QString ¤cy=QString(), int digits=-1) const |
QString | formatNumber (const QString &numStr, bool round=true, int precision=2) const |
QString | formatNumber (double num, int precision=-1) const |
QString | formatTime (const QTime &pTime, bool includeSecs=false, bool isDuration=false) const |
int | fracDigits () const |
void | insertCatalog (const QString &catalog) |
bool | isApplicationTranslatedInto (const QString &language) |
KLocale (const KLocale &rhs) | |
KLocale (const QString &catalog, const QString &language, const QString &country=QString(), KConfig *config=0) | |
KLocale (const QString &catalog, KSharedConfig::Ptr config=KSharedConfig::Ptr()) | |
QString | language () const |
QString | languageCodeToName (const QString &language) const |
QStringList | languageList () const |
QString | localizedFilePath (const QString &filePath) const |
MeasureSystem | measureSystem () const |
QString | monetaryDecimalSymbol () const |
QString | monetaryThousandsSeparator () const |
SignPosition | negativeMonetarySignPosition () const |
bool | negativePrefixCurrencySymbol () const |
QString | negativeSign () const |
bool | nounDeclension () const |
KLocale & | operator= (const KLocale &rhs) |
int | pageSize () const |
SignPosition | positiveMonetarySignPosition () const |
bool | positivePrefixCurrencySymbol () const |
QString | positiveSign () const |
QDate | readDate (const QString &str, ReadDateFlags flags, bool *ok=0) const |
QDate | readDate (const QString &intstr, const QString &fmt, bool *ok=0) const |
QDate | readDate (const QString &str, bool *ok=0) const |
double | readMoney (const QString &numStr, bool *ok=0) const |
double | readNumber (const QString &numStr, bool *ok=0) const |
QTime | readTime (const QString &str, ReadTimeFlags flags, bool *ok=0) const |
QTime | readTime (const QString &str, bool *ok=0) const |
void | removeCatalog (const QString &catalog) |
void | setActiveCatalog (const QString &catalog) |
void | setCalendar (const QString &calendarType) |
bool | setCountry (const QString &country, KConfig *config) |
void | setCurrencySymbol (const QString &symbol) |
void | setDateFormat (const QString &format) |
void | setDateFormatShort (const QString &format) |
void | setDateMonthNamePossessive (bool possessive) |
void | setDecimalSymbol (const QString &symbol) |
bool | setEncoding (int mibEnum) |
void | setFracDigits (int digits) |
bool | setLanguage (const QStringList &languages) |
bool | setLanguage (const QString &language, KConfig *config) |
void | setMeasureSystem (MeasureSystem value) |
void | setMonetaryDecimalSymbol (const QString &symbol) |
void | setMonetaryThousandsSeparator (const QString &separator) |
void | setNegativeMonetarySignPosition (SignPosition signpos) |
void | setNegativePrefixCurrencySymbol (bool prefix) |
void | setNegativeSign (const QString &sign) |
void | setPageSize (int paperFormat) |
void | setPositiveMonetarySignPosition (SignPosition signpos) |
void | setPositivePrefixCurrencySymbol (bool prefix) |
void | setPositiveSign (const QString &sign) |
void | setThousandsSeparator (const QString &separator) |
void | setTimeFormat (const QString &format) |
void | setWeekStartDay (int day) |
QString | thousandsSeparator () const |
QString | timeFormat () const |
QString | translateQt (const char *context, const char *sourceText, const char *comment) const |
void | translateRaw (const char *ctxt, const char *singular, const char *plural, unsigned long n, QString *lang, QString *trans) const |
void | translateRaw (const char *singular, const char *plural, unsigned long n, QString *lang, QString *trans) const |
void | translateRaw (const char *ctxt, const char *msg, QString *lang, QString *trans) const |
void | translateRaw (const char *msg, QString *lang, QString *trans) const |
bool | use12Clock () const |
bool | useTranscript () const |
int | weekStartDay () const |
virtual | ~KLocale () |
Static Public Member Functions | |
static QString | defaultCountry () |
static QString | defaultLanguage () |
static QString | langLookup (const QString &fname, const char *rtype="html") |
static void | setMainCatalog (const char *catalog) |
static void | splitLocale (const QString &locale, QString &language, QString &country, QString &modifier, QString &charset) |
Member Enumeration Documentation
enum KLocale::DateFormat |
Format for date string.
- Enumerator:
Flags for readDate().
Flags for readTime().
Various positions for where to place the positive or negative sign when they are related to a monetary value.
- Enumerator:
Constructor & Destructor Documentation
KLocale::KLocale | ( | const QString & | catalog, | |
KSharedConfig::Ptr | config = KSharedConfig::Ptr() | |||
) | [explicit] |
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 file. If KLocale is not able to use any 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.
- Parameters:
-
catalog The name of the main language file config The configuration file to use.
Definition at line 244 of file klocale.cpp.
KLocale::KLocale | ( | const QString & | catalog, | |
const QString & | language, | |||
const QString & | country = QString() , |
|||
KConfig * | config = 0 | |||
) |
Definition at line 249 of file klocale.cpp.
KLocale::KLocale | ( | const KLocale & | rhs | ) |
KLocale::~KLocale | ( | ) | [virtual] |
Member Function Documentation
QStringList KLocale::allCountriesList | ( | ) | const |
Provides list of all known country codes.
Use countryCodeToName(country) to get human readable, localized country names.
- Returns:
- a list of all country codes
- See also:
- countryCodeToName
Definition at line 2250 of file klocale.cpp.
QStringList KLocale::allLanguagesList | ( | ) | const |
Provides list of all known language codes.
Use languageCodeToName(language) to get human readable, localized language names.
- Returns:
- list of all language codes
- See also:
- languageCodeToName
Definition at line 2233 of file klocale.cpp.
const KCalendarSystem * KLocale::calendar | ( | ) | const |
Returns a pointer to the calendar system object.
- Returns:
- the current calendar system instance
Definition at line 2289 of file klocale.cpp.
QString KLocale::calendarType | ( | ) | const |
Returns the name of the calendar system that is currently being used by the system.
- Returns:
- the name of the calendar system
Definition at line 2284 of file klocale.cpp.
QTextCodec * KLocale::codecForEncoding | ( | ) | const |
Returns the user's preferred encoding.
Should never be NULL.
- Returns:
- The codec for the preferred encoding
- See also:
- encoding
Definition at line 2214 of file klocale.cpp.
void KLocale::copyCatalogsTo | ( | KLocale * | locale | ) |
Copies the catalogs of this objct to an other KLocale object.
Definition at line 2314 of file klocale.cpp.
QString KLocale::country | ( | ) | const |
Returns the country code of the country where the user lives.
defaultCountry() is returned by default, if no other available.
Use countryCodeToName(country) to get human readable, localized country names.
- Returns:
- the country code for the user
- See also:
- countryCodeToName
Definition at line 606 of file klocale.cpp.
Convert a known country code to a human readable, localized form.
If an unknown country code is supplied, empty string is returned; this will never happen if the code has been obtained by one of the KLocale methods.
- Parameters:
-
code the country code
- Returns:
- the human readable and localized form of the country name
- See also:
- country
Definition at line 2264 of file klocale.cpp.
QString KLocale::currencySymbol | ( | ) | const |
Returns what the symbol denoting currency in the current locale as as defined by user settings should look like.
- Returns:
- The default currency symbol used by locale.
Definition at line 873 of file klocale.cpp.
QString KLocale::dateFormat | ( | ) | const |
Returns the currently selected date format.
- Returns:
- Current date format.
- See also:
- setDateFormat()
Definition at line 2072 of file klocale.cpp.
QString KLocale::dateFormatShort | ( | ) | const |
Returns the currently selected short date format.
- Returns:
- Current short date format.
- See also:
- setDateFormatShort()
Definition at line 2077 of file klocale.cpp.
bool KLocale::dateMonthNamePossessive | ( | ) | const |
Use this to determine whether in dates a possessive form of month name is preferred ("of January" rather than "January").
- Returns:
- If possessive form should be used
Definition at line 852 of file klocale.cpp.
QString KLocale::decimalSymbol | ( | ) | const |
Returns what a decimal point should look like ("." or "," etc.
) according to the current locale or user settings.
- Returns:
- The decimal symbol used by locale.
Definition at line 863 of file klocale.cpp.
QString KLocale::defaultCountry | ( | ) | [static] |
Returns the name of the default country.
- Returns:
- Name of the default country
Definition at line 2175 of file klocale.cpp.
QString KLocale::defaultLanguage | ( | ) | [static] |
Returns the name of the internal language.
- Returns:
- Name of the default language
Definition at line 2170 of file klocale.cpp.
const QByteArray KLocale::encoding | ( | ) | const |
Returns the user's preferred encoding.
- Returns:
- The name of the preferred encoding
- See also:
- codecForEncoding
Definition at line 2185 of file klocale.cpp.
int KLocale::encodingMib | ( | ) | const |
Returns the user's preferred encoding.
- Returns:
- The Mib of the preferred encoding
- See also:
- encoding
Definition at line 2202 of file klocale.cpp.
int KLocale::fileEncodingMib | ( | ) | const |
Returns the file encoding.
- Returns:
- The Mib of the file encoding
- See also:
- QFile::encodeName
Definition at line 2207 of file klocale.cpp.
Converts size
from bytes to the string representation using the IEC 60027-2 standard.
Example: formatByteSize(1024) returns "1.0 KiB"
- Parameters:
-
size size in bytes
- Returns:
- converted size as a string - e.g. 123.4 KiB , 12.0 MiB
Definition at line 1163 of file klocale.cpp.
QString KLocale::formatDate | ( | const QDate & | date, | |
DateFormat | format = LongDate | |||
) | const |
Returns a string formatted to the current locale's conventions regarding dates.
- Parameters:
-
date the date to be formatted. format category of date format to use
- Returns:
- The date as a string
Definition at line 1226 of file klocale.cpp.
QString KLocale::formatDateTime | ( | const KDateTime & | dateTime, | |
DateFormat | format = ShortDate , |
|||
DateTimeFormatOptions | options = 0 | |||
) | const |
Returns a string formatted to the current locale's conventions regarding both date and time.
- Parameters:
-
dateTime the date and time to be formatted format category of date format to use options additional output options
- Returns:
- The date and time as a string
Definition at line 1911 of file klocale.cpp.
QString KLocale::formatDateTime | ( | const QDateTime & | dateTime, | |
DateFormat | format = ShortDate , |
|||
bool | includeSecs = false | |||
) | const |
Returns a string formatted to the current locale's conventions regarding both date and time.
- Parameters:
-
dateTime the date and time to be formatted format category of date format to use options additional output options
- Returns:
- The date and time as a string
Definition at line 1893 of file klocale.cpp.
QString KLocale::formatDuration | ( | unsigned long | mSec | ) | const |
Given a number of milliseconds, converts that to a string containing the localized equivalent.
e.g. given formatDuration(60000), returns "1.0 minutes"
- Parameters:
-
mSec Time duration in milliseconds
- Returns:
- converted duration as a string - e.g. "5.5 seconds" "23.0 minutes"
Definition at line 1208 of file klocale.cpp.
QString KLocale::formatLong | ( | long | num | ) | const |
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).
- Parameters:
-
num The number to convert
- Returns:
- The number as a localized string
Definition at line 1015 of file klocale.cpp.
QString KLocale::formatMoney | ( | double | num, | |
const QString & | currency = QString() , |
|||
int | digits = -1 | |||
) | const |
Given a double, converts that to a numeric string containing the localized monetary equivalent.
e.g. given 123456, return "$ 123,456.00".
- Parameters:
-
num The number we want to format currency The currency symbol you want. digits Number of fractional digits, or -1 for the default value
- Returns:
- The number of money as a localized string
- See also:
- fracDigits()
Definition at line 946 of file klocale.cpp.
QString KLocale::formatNumber | ( | const QString & | numStr, | |
bool | round = true , |
|||
int | precision = 2 | |||
) | const |
Given a string representing a number, converts that to a numeric string containing the localized numeric equivalent.
e.g. given 123456.78F, return "123,456.78" (for some European country).
- Parameters:
-
numStr The number to format, as a string. round Round fractional digits. (default true) precision Number of fractional digits used for rounding. Unused if round=false. (default 2)
- Returns:
- The number as a localized string
Definition at line 1116 of file klocale.cpp.
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.
This function is a wrapper that is provided for convenience.
- Parameters:
-
num The number to convert precision Number of fractional digits used.
- Returns:
- The number as a localized string
- See also:
- formatNumber(const QString, bool, int)
Definition at line 1008 of file klocale.cpp.
QString KLocale::formatTime | ( | const QTime & | pTime, | |
bool | includeSecs = false , |
|||
bool | isDuration = false | |||
) | const |
Returns a string formatted to the current locale's conventions regarding times.
- Parameters:
-
pTime The time to be formatted. includeSecs if true, seconds are included in the output, otherwise only hours and minutes are formatted. isDuration if true, the given time is a duration, not a clock time. This means "am/pm" shouldn't be displayed.
- Returns:
- The time as a string
Definition at line 1778 of file klocale.cpp.
int KLocale::fracDigits | ( | ) | const |
The number of fractional digits to include in numeric/monetary values (usually 2).
- Returns:
- Default number of fractional digits used by locale.
Definition at line 898 of file klocale.cpp.
void KLocale::insertCatalog | ( | const QString & | catalog | ) |
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.
- Parameters:
-
catalog The catalog to add.
Definition at line 611 of file klocale.cpp.
Checks whether or not the active catalog is found for the given language.
- Parameters:
-
language language to check
Definition at line 528 of file klocale.cpp.
Finds localized resource in resourceDir( rtype ) + <lang> + fname.
Since KDE 4.1, this service is provided in a slightly different form, automatically by e.g. KStandardDirs::locate() and other KDE core classes dealing with paths. For manual use, it is replaced by localizedFilePath().
- Parameters:
-
fname relative path to find rtype resource type to use
- Returns:
- path to localized resource
- See also:
- localizedFilePath
Definition at line 1956 of file klocale.cpp.
QString KLocale::language | ( | ) | const |
Returns the language code 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.
Use languageCodeToName(language) to get human readable, localized language name.
- Returns:
- the currently used language code
- See also:
- languageCodeToName
Definition at line 601 of file klocale.cpp.
Convert a known language code to a human readable, localized form.
If an unknown language code is supplied, empty string is returned; this will never happen if the code has been obtained by one of the KLocale methods.
- Parameters:
-
language the language code
- Returns:
- the human readable and localized form if the code is known, empty otherwise
- See also:
- language
Definition at line 2241 of file klocale.cpp.
QStringList KLocale::languageList | ( | ) | const |
Returns the language codes selected by user, ordered by decreasing priority.
Use languageCodeToName(language) to get human readable, localized language name.
- Returns:
- list of language codes
- See also:
- languageCodeToName
Definition at line 1878 of file klocale.cpp.
- Since:
- 4.1
Tries to find a path to the localized file for the given original path. This is intended mainly for non-text resources (images, sounds, etc.), whereas text resources should be handled in more specific ways.
The possible localized paths are checked in turn by priority of set languages, in form of dirname/l10n/ll/basename, where dirname and basename are those of the original path, and ll is the language code.
KDE core classes which resolve paths internally (e.g. KStandardDirs) will usually perform this lookup behind the scene. In general, you should pipe resource paths through this method only on explicit translators' request, or when a resource is an obvious candidate for localization (e.g. a splash screen or a custom icon with some text drawn on it).
- Parameters:
-
filePath path to the original file
- Returns:
- path to the localized file if found, original path otherwise
Definition at line 2320 of file klocale.cpp.
KLocale::MeasureSystem KLocale::measureSystem | ( | ) | const |
Returns which measuring system we use.
- Returns:
- The preferred measuring system
Definition at line 2160 of file klocale.cpp.
QString KLocale::monetaryDecimalSymbol | ( | ) | const |
Returns what a decimal point should look like ("." or "," etc.
) for monetary values, according to the current locale or user settings.
- Returns:
- The monetary decimal symbol used by locale.
Definition at line 878 of file klocale.cpp.
QString KLocale::monetaryThousandsSeparator | ( | ) | const |
Returns what a thousands separator for monetary values should look like ("," or " " etc.
) according to the current locale or user settings.
- Returns:
- The monetary thousands separator used by locale.
Definition at line 883 of file klocale.cpp.
KLocale::SignPosition KLocale::negativeMonetarySignPosition | ( | ) | const |
Denotes where to place a negative sign in relation to a monetary value.
- Returns:
- Where/how to print the negative sign.
- See also:
- SignPosition
Definition at line 918 of file klocale.cpp.
bool KLocale::negativePrefixCurrencySymbol | ( | ) | const |
If and only if the currency symbol precedes a negative value, this will be true.
- Returns:
- True if the currency symbol precedes negative numbers.
Definition at line 908 of file klocale.cpp.
QString KLocale::negativeSign | ( | ) | const |
Returns what a negative sign should look like ("-", etc.
) according to the current locale or user settings.
- Returns:
- The negative sign used by locale.
Definition at line 893 of file klocale.cpp.
bool KLocale::nounDeclension | ( | ) | const |
Use this to determine whether nouns are declined in locale's language.
This property should remain read-only (no setter function)
- Returns:
- If nouns are declined
Definition at line 847 of file klocale.cpp.
int KLocale::pageSize | ( | ) | const |
Returns the preferred page size for printing.
- Returns:
- The preferred page size, cast it to QPrinter::PageSize
Definition at line 2149 of file klocale.cpp.
KLocale::SignPosition KLocale::positiveMonetarySignPosition | ( | ) | const |
Returns the position of a positive sign in relation to a monetary value.
- Returns:
- Where/how to print the positive sign.
- See also:
- SignPosition
Definition at line 913 of file klocale.cpp.
bool KLocale::positivePrefixCurrencySymbol | ( | ) | const |
If and only if the currency symbol precedes a positive value, this will be true.
- Returns:
- Where to print the currency symbol for positive numbers.
Definition at line 903 of file klocale.cpp.
QString KLocale::positiveSign | ( | ) | const |
Returns what a positive sign should look like ("+", " ", etc.
) according to the current locale or user settings.
- Returns:
- The positive sign used by locale.
Definition at line 888 of file klocale.cpp.
QDate KLocale::readDate | ( | const QString & | str, | |
ReadDateFlags | flags, | |||
bool * | ok = 0 | |||
) | const |
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 flags
.
- Parameters:
-
str the string we want to convert. flags whether the date string is to be in full format or in short format. ok the boolean that is set to false if it's not a valid date. If ok
is 0, it will be ignored
- Returns:
- The string converted to a QDate
Definition at line 1514 of file klocale.cpp.
Converts a localized date string to a QDate, using the specified format.
You will usually not want to use this method.
Definition at line 1520 of file klocale.cpp.
Converts a localized date string to a QDate.
The bool pointed by ok will be invalid if the date entered was not valid.
- Parameters:
-
str the string we want to convert. ok the boolean that is set to false if it's not a valid date. If ok
is 0, it will be ignored
- Returns:
- The string converted to a QDate
Definition at line 1506 of file klocale.cpp.
Converts a localized monetary string to a double.
- Parameters:
-
numStr the string we want to convert. ok the boolean that is set to false if it's not a number. If ok
is 0, it will be ignored
- Returns:
- The string converted to a double
Definition at line 1391 of file klocale.cpp.
Converts a localized numeric string to a double.
- Parameters:
-
numStr the string we want to convert. ok the boolean that is set to false if it's not a number. If ok
is 0, it will be ignored
- Returns:
- The string converted to a double
Definition at line 1326 of file klocale.cpp.
QTime KLocale::readTime | ( | const QString & | str, | |
ReadTimeFlags | flags, | |||
bool * | ok = 0 | |||
) | const |
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.
- Parameters:
-
str the string we want to convert. flags whether the time string is expected to contain seconds or not. ok the boolean that is set to false if it's not a valid time. If ok
is 0, it will be ignored
- Returns:
- The string converted to a QTime
Definition at line 1672 of file klocale.cpp.
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 ok
will be set to false if the time entered was not valid.
- Parameters:
-
str the string we want to convert. ok the boolean that is set to false if it's not a valid time. If ok
is 0, it will be ignored
- Returns:
- The string converted to a QTime
Definition at line 1664 of file klocale.cpp.
void KLocale::removeCatalog | ( | const QString & | catalog | ) |
Removes a catalog for translation lookup.
- Parameters:
-
catalog The catalog to remove.
- See also:
- insertCatalog()
Definition at line 658 of file klocale.cpp.
void KLocale::setActiveCatalog | ( | const QString & | catalog | ) |
Sets the active catalog for translation lookup.
- Parameters:
-
catalog The catalog to activate.
Definition at line 670 of file klocale.cpp.
void KLocale::setCalendar | ( | const QString & | calendarType | ) |
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.
- Parameters:
-
calendarType the name of the calendar type
Definition at line 2276 of file klocale.cpp.
Changes the current country.
The current country will be left unchanged if failed. It will force a reload of the country specific configuration.
- Parameters:
-
country The ISO 3166 country code.
- Returns:
- True on success.
Definition at line 450 of file klocale.cpp.
void KLocale::setCurrencySymbol | ( | const QString & | symbol | ) |
Changes the current currency symbol.
- Parameters:
-
symbol The new currency symbol
Definition at line 2144 of file klocale.cpp.
void KLocale::setDateFormat | ( | const QString & | format | ) |
Changes the current date format.
The format of the date is a string which contains variables that will be replaced:
- Y with the whole year (e.g. "1984" for "1984")
- y with the lower 2 digits of the year (e.g. "84" for "1984")
- n with the month (January="1", December="12")
- m with the month with two digits (January="01", December="12")
- e with the day of the month (e.g. "1" on the first of march)
- d with the day of the month with two digits(e.g. "01" on the first of march)
- b with the short form of the month (e.g. "Jan" for January)
- B with the long form of the month (e.g. "January")
- a with the short form of the weekday (e.g. "Wed" for Wednesday)
- A with the long form of the weekday (e.g. "Wednesday" for Wednesday)
- Parameters:
-
format The new date format
Definition at line 2044 of file klocale.cpp.
void KLocale::setDateFormatShort | ( | const QString & | format | ) |
Changes the current short date format.
The format of the date is a string which contains variables that will be replaced:
- Y with the whole year (e.g. "1984" for "1984")
- y with the lower 2 digits of the year (e.g. "84" for "1984")
- n with the month (January="1", December="12")
- m with the month with two digits (January="01", December="12")
- e with the day of the month (e.g. "1" on the first of march)
- d with the day of the month with two digits(e.g. "01" on the first of march)
- b with the short form of the month (e.g. "Jan" for January)
- B with the long form of the month (e.g. "January")
- a with the short form of the weekday (e.g. "Wed" for Wednesday)
- A with the long form of the weekday (e.g. "Wednesday" for Wednesday)
- Parameters:
-
format The new short date format
Definition at line 2049 of file klocale.cpp.
void KLocale::setDateMonthNamePossessive | ( | bool | possessive | ) |
Changes the form of month name used in dates.
- Parameters:
-
possessive True if possessive forms should be used
Definition at line 2054 of file klocale.cpp.
void KLocale::setDecimalSymbol | ( | const QString & | symbol | ) |
Changes the symbol used to identify the decimal pointer.
- Parameters:
-
symbol The new decimal symbol.
Definition at line 2087 of file klocale.cpp.
bool KLocale::setEncoding | ( | int | mibEnum | ) |
Changes the current encoding.
- Parameters:
-
mibEnum The mib of the preferred codec
- Returns:
- True on success.
Definition at line 2219 of file klocale.cpp.
void KLocale::setFracDigits | ( | int | digits | ) |
Changes the number of digits used when formating numbers.
- Parameters:
-
digits The default number of digits to use.
Definition at line 2128 of file klocale.cpp.
bool KLocale::setLanguage | ( | const QStringList & | languages | ) |
Changes the list of preferred languages for the locale.
The first valid language in the list will be used, or the default language (en_US) if none of the specified languages were available.
- Parameters:
-
languages the list of language codes
- Returns:
- true if one of the specified languages were used
Definition at line 486 of file klocale.cpp.
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.
- Parameters:
-
language the language code
- Returns:
- true on success
Definition at line 463 of file klocale.cpp.
void KLocale::setMainCatalog | ( | const char * | catalog | ) | [static] |
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.
- Parameters:
-
catalog Catalog to override all other main Catalogs.
Definition at line 1321 of file klocale.cpp.
void KLocale::setMeasureSystem | ( | MeasureSystem | value | ) |
Changes the preferred measuring system.
- Returns:
- value The preferred measuring system
Definition at line 2165 of file klocale.cpp.
void KLocale::setMonetaryDecimalSymbol | ( | const QString & | symbol | ) |
Changes the symbol used to identify the decimal pointer for monetary values.
- Parameters:
-
symbol The new decimal symbol.
Definition at line 2139 of file klocale.cpp.
void KLocale::setMonetaryThousandsSeparator | ( | const QString & | separator | ) |
Changes the separator used to group digits when formating monetary values.
- Parameters:
-
separator The new thousands separator.
Definition at line 2133 of file klocale.cpp.
void KLocale::setNegativeMonetarySignPosition | ( | SignPosition | signpos | ) |
Changes the sign position used for negative monetary values.
- Parameters:
-
signpos The new sign position
Definition at line 2113 of file klocale.cpp.
void KLocale::setNegativePrefixCurrencySymbol | ( | bool | prefix | ) |
Changes the position where the currency symbol should be printed for negative monetary values.
- Parameters:
-
prefix True if the currency symbol should be prefixed instead of postfixed
Definition at line 2123 of file klocale.cpp.
void KLocale::setNegativeSign | ( | const QString & | sign | ) |
Changes the sign used to identify a negative number.
- Parameters:
-
sign Sign used for negative numbers.
Definition at line 2103 of file klocale.cpp.
void KLocale::setPageSize | ( | int | paperFormat | ) |
Changes the preferred page size when printing.
- Parameters:
-
paperFormat the new preferred page size in the format QPrinter::PageSize
Definition at line 2154 of file klocale.cpp.
void KLocale::setPositiveMonetarySignPosition | ( | SignPosition | signpos | ) |
Changes the sign position used for positive monetary values.
- Parameters:
-
signpos The new sign position
Definition at line 2108 of file klocale.cpp.
void KLocale::setPositivePrefixCurrencySymbol | ( | bool | prefix | ) |
Changes the position where the currency symbol should be printed for positive monetary values.
- Parameters:
-
prefix True if the currency symbol should be prefixed instead of postfixed
Definition at line 2118 of file klocale.cpp.
void KLocale::setPositiveSign | ( | const QString & | sign | ) |
Changes the sign used to identify a positive number.
Normally this is left blank.
- Parameters:
-
sign Sign used for positive numbers.
Definition at line 2098 of file klocale.cpp.
void KLocale::setThousandsSeparator | ( | const QString & | separator | ) |
Changes the separator used to group digits when formating numbers.
- Parameters:
-
separator The new thousands separator.
Definition at line 2092 of file klocale.cpp.
void KLocale::setTimeFormat | ( | const QString & | format | ) |
Changes the current time format.
The format of the time is string a which contains variables that will be replaced:
- H with the hour in 24h format and 2 digits (e.g. 5pm is "17", 5am is "05")
- k with the hour in 24h format and one digits (e.g. 5pm is "17", 5am is "5")
- I with the hour in 12h format and 2 digits (e.g. 5pm is "05", 5am is "05")
- l with the hour in 12h format and one digits (e.g. 5pm is "5", 5am is "5")
- M with the minute with 2 digits (e.g. the minute of 07:02:09 is "02")
- S with the seconds with 2 digits (e.g. the minute of 07:02:09 is "09")
- p with pm or am (e.g. 17.00 is "pm", 05.00 is "am")
- Parameters:
-
format The new time format
Definition at line 2059 of file klocale.cpp.
void KLocale::setWeekStartDay | ( | int | day | ) |
Changes how KLocale defines the first day in week.
- Parameters:
-
day first day of the week (Monday=1..Sunday=7) as integer
Definition at line 2064 of file klocale.cpp.
void KLocale::splitLocale | ( | const QString & | locale, | |
QString & | language, | |||
QString & | country, | |||
QString & | modifier, | |||
QString & | charset | |||
) | [static] |
Parses locale string into distinct parts.
The format of locale is language_COUNTRY@modifier.CHARSET
- Parameters:
-
locale the locale string to split language set to the language part of the locale country set to the country part of the locale modifier set to the modifer part of the locale charset set to the charset part of the locale
Definition at line 560 of file klocale.cpp.
QString KLocale::thousandsSeparator | ( | ) | const |
Returns what the thousands separator should look like ("," or "." etc.
) according to the current locale or user settings.
- Returns:
- The thousands separator used by locale.
Definition at line 868 of file klocale.cpp.
QString KLocale::timeFormat | ( | ) | const |
Returns the currently selected time format.
- Returns:
- Current time format.
- See also:
- setTimeFormat()
Definition at line 2082 of file klocale.cpp.
QString KLocale::translateQt | ( | const char * | context, | |
const char * | sourceText, | |||
const char * | comment | |||
) | const |
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())
Definition at line 784 of file klocale.cpp.
void KLocale::translateRaw | ( | const char * | ctxt, | |
const char * | singular, | |||
const char * | plural, | |||
unsigned long | n, | |||
QString * | lang, | |||
QString * | trans | |||
) | const |
Raw translation from message catalogs, with given context and singular/plural form.
Context + singular form is used as the lookup key in catalogs.
Never use this directly to get message translations. See i18n* and ki18n* calls related to KLocalizedString.
- Parameters:
-
ctxt the context. Must not be null. Must be UTF-8 encoded. singular the singular form. Must not be null. Must be UTF-8 encoded. plural the plural form. Must not be null. Must be UTF-8 encoded. n number on which the forms are decided. lang language in which the translation was found. If no translation was found, KLocale::defaultLanguage() is reported. If null, the language is not reported. trans raw translation, or original if not found. If no translation was found, original message is reported (either plural or singular, as determined by n
). If null, the translation is not reported.
- See also:
- KLocalizedString
Definition at line 777 of file klocale.cpp.
void KLocale::translateRaw | ( | const char * | singular, | |
const char * | plural, | |||
unsigned long | n, | |||
QString * | lang, | |||
QString * | trans | |||
) | const |
Raw translation from message catalogs, with given singular/plural form.
Singular form is used as the lookup key in catalogs.
Never use this directly to get message translations. See i18n* and ki18n* calls related to KLocalizedString.
- Parameters:
-
singular the singular form. Must not be null. Must be UTF-8 encoded. plural the plural form. Must not be null. Must be UTF-8 encoded. n number on which the forms are decided. lang language in which the translation was found. If no translation was found, KLocale::defaultLanguage() is reported. If null, the language is not reported. trans raw translation, or original if not found. If no translation was found, original message is reported (either plural or singular, as determined by n
). If null, the translation is not reported.
- See also:
- KLocalizedString
Definition at line 771 of file klocale.cpp.
void KLocale::translateRaw | ( | const char * | ctxt, | |
const char * | msg, | |||
QString * | lang, | |||
QString * | trans | |||
) | const |
Raw translation from message catalogs, with given context.
Context + message are used as the lookup key in catalogs.
Never use this directly to get message translations. See i18n* and ki18n* calls related to KLocalizedString.
- Parameters:
-
ctxt the context. Must not be null. Must be UTF-8 encoded. msg the message. Must not be null. Must be UTF-8 encoded. lang language in which the translation was found. If no translation was found, KLocale::defaultLanguage() is reported. If null, the language is not reported. trans raw translation, or original if not found. If no translation was found, original message is reported. If null, the translation is not reported.
- See also:
- KLocalizedString
Definition at line 765 of file klocale.cpp.
Raw translation from message catalogs.
Never use this directly to get message translations. See i18n* and ki18n* calls related to KLocalizedString.
- Parameters:
-
msg the message. Must not be null. Must be UTF-8 encoded. lang language in which the translation was found. If no translation was found, KLocale::defaultLanguage() is reported. If null, the language is not reported. trans raw translation, or original if not found. If no translation was found, original message is reported. If null, the translation is not reported.
- See also:
- KLocalizedString
Definition at line 759 of file klocale.cpp.
bool KLocale::use12Clock | ( | ) | const |
Use this to determine if the user wants a 12 hour clock.
- Returns:
- If the user wants 12h clock
Definition at line 1869 of file klocale.cpp.
bool KLocale::useTranscript | ( | ) | const |
Reports whether evaluation of translation scripts is enabled.
- Returns:
- true if script evaluation is enabled, false otherwise.
Definition at line 2180 of file klocale.cpp.
int KLocale::weekStartDay | ( | ) | const |
Use this to determine which day is the first day of the week.
- Returns:
- an integer (Monday=1..Sunday=7)
Definition at line 857 of file klocale.cpp.
The documentation for this class was generated from the following files: