KDE 4.4 API Reference KDECore
KLocale Class Reference
KLocale provides support for country specific stuff like the national language. More...
#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 68 of file klocale.h.
Member Enumeration Documentation
These binary units are used in KDE by the formatByteSize() functions.
NOTE: There are several different units standards: 1) SI (i.e. metric), powers-of-10. 2) IEC, powers-of-2, with specific units KiB, MiB, etc. 3) JEDEC, powers-of-2, used for solid state memory sizing which is why you see flash cards labels as e.g. 4GB. These (ab)use the metric units. Although JEDEC only defines KB, MB, GB, if JEDEC is selected all units will be powers-of-2 with metric prefixes for clarity in the event of sizes larger than 1024 GB.
Although 3 different dialects are possible this enum only uses metric names since adding all 3 different names of essentially the same unit would be pointless. Use BinaryUnitDialect to control the exact units returned.
- Since:
- 4.4
- See also:
- binaryUnitDialect
- Enumerator:
This enum chooses what dialect is used for binary units.
Note: Although JEDEC abuses the metric prefixes and can therefore be confusing, it has been used to describe *memory* sizes for quite some time and programs should therefore use either Default, JEDEC, or IEC 60027-2 for memory sizes.
On the other hand network transmission rates are typically in metric so Default, Metric, or IEC (which is unambiguous) should be chosen.
Normally choosing DefaultBinaryUnits is the best option as that uses the user's selection for units.
- Since:
- 4.4
- See also:
- binaryUnitDialect
- setBinaryUnitDialect
| enum KLocale::DateFormat |
Format for date string.
- Enumerator:
| enum KLocale::DigitSet |
- Since:
- 4.3
The set of digit characters used to display and enter numbers.
Flags for readDate().
Flags for the old version of readTime().
- Deprecated:
- replaced by TimeFormatOptions
Various positions for where to place the positive or negative sign when they are related to a monetary value.
- Enumerator:
- Since:
- 4.4
Format flags for readLocaleTime() and formatLocaleTime()
- Enumerator:
Additional processing options for readLocaleTime().
- Remarks:
- This is currently used as an enum but declared as a flag to be extensible
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 Language in the group Locale in the configuration file.
If no configuration 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 a configuration file with a Locale group detailing locale-related preferences (such as language and formatting options)
Definition at line 298 of file klocale.cpp.
| KLocale::KLocale | ( | const QString & | catalog, | |
| const QString & | language, | |||
| const QString & | country = QString(), |
|||
| KConfig * | config = 0 | |||
| ) |
Constructs a KLocale with the given catalog name.
Allows you to override the language and, optionally, the country of this locale.
- Parameters:
-
catalog the name of the main language file language the language for the locale country the country for the locale config a configuration file with a Locale group detailing locale-related preferences (such as date and time formatting options)
Definition at line 303 of file klocale.cpp.
| KLocale::KLocale | ( | const KLocale & | rhs | ) |
Copy constructor.
Definition at line 2563 of file klocale.cpp.
| KLocale::~KLocale | ( | ) | [virtual] |
Destructor.
Definition at line 750 of file klocale.cpp.
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 2515 of file klocale.cpp.
| QList< KLocale::DigitSet > KLocale::allDigitSetsList | ( | ) | const |
- Since:
- 4.3
Provides list of all known digit set identifiers.
- Returns:
- list of all digit set identifiers
- See also:
- DigitSet
- digitSetToName
Definition at line 920 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 2498 of file klocale.cpp.
| KLocale::BinaryUnitDialect KLocale::binaryUnitDialect | ( | ) | const |
Returns the user's default binary unit dialect.
- Since:
- 4.4
- Returns:
- User's default binary unit dialect
- See also:
- BinaryUnitDialect
Definition at line 1497 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 2554 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 2549 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
- encodingMib
Definition at line 2479 of file klocale.cpp.
| QString KLocale::convertDigits | ( | const QString & | str, | |
| DigitSet | digitSet, | |||
| bool | ignoreContext = false | |||
| ) | const |
- Since:
- 4.3
Convert all digits in the string to the given digit set.
Conversion is normally not performed if the given digit set is not appropriate in the current locale and language context. Unconditional conversion may be requested by setting ignoreContext to true.
- Parameters:
-
str the string to convert digitSet the digit set identifier ignoreContext unconditional conversion if true
- Returns:
- string with converted digits
- See also:
- DigitSet
Definition at line 971 of file klocale.cpp.
| void KLocale::copyCatalogsTo | ( | KLocale * | locale | ) |
Copies the catalogs of this object to an other KLocale object.
- Parameters:
-
locale the destination KLocale object
Definition at line 2579 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 671 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:
-
country the country code
- Returns:
- the human readable and localized form of the country name
- See also:
- country
- allCountriesList
Definition at line 2529 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 1052 of file klocale.cpp.
| QString KLocale::dateFormat | ( | ) | const |
Returns the currently selected date format.
- Returns:
- Current date format.
- See also:
- setDateFormat()
Definition at line 2336 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 2341 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 1016 of file klocale.cpp.
| KLocale::DigitSet KLocale::dateTimeDigitSet | ( | ) | const |
- Since:
- 4.3
Returns the identifier of the digit set used to display dates and time.
- Returns:
- the digit set identifier
- See also:
- DigitSet
- digitSetToName
Definition at line 2649 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 1042 of file klocale.cpp.
| QString KLocale::defaultCountry | ( | ) | [static] |
Returns the name of the default country.
- Returns:
- Name of the default country
Definition at line 2440 of file klocale.cpp.
| QString KLocale::defaultLanguage | ( | ) | [static] |
Returns the name of the internal language.
- Returns:
- Name of the default language
Definition at line 2434 of file klocale.cpp.
| KLocale::DigitSet KLocale::digitSet | ( | ) | const |
- Since:
- 4.3
Returns the identifier of the digit set used to display numbers.
- Returns:
- the digit set identifier
- See also:
- DigitSet
- digitSetToName
Definition at line 2629 of file klocale.cpp.
- Since:
- 4.3
Convert a digit set identifier to a human readable, localized name.
- Parameters:
-
digitSet the digit set identifier withDigits whether to add the digits themselves to the name
- Returns:
- the human readable and localized name of the digit set
- See also:
- DigitSet
Definition at line 944 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
- encodingMib
Definition at line 2450 of file klocale.cpp.
| int KLocale::encodingMib | ( | ) | const |
Returns the user's preferred encoding.
- Returns:
- The Mib of the preferred encoding
- See also:
- encoding
- codecForEncoding
Definition at line 2467 of file klocale.cpp.
| int KLocale::fileEncodingMib | ( | ) | const |
Returns the file encoding.
- Returns:
- The Mib of the file encoding
- See also:
- QFile::encodeName
- QFile::decodeName
Definition at line 2472 of file klocale.cpp.
| QString KLocale::formatByteSize | ( | double | size, | |
| int | precision, | |||
| BinaryUnitDialect | dialect = KLocale::DefaultBinaryDialect, |
|||
| BinarySizeUnits | specificUnit = KLocale::DefaultBinaryUnits | |||
| ) | const |
Converts size from bytes to the appropriate string representation using the binary unit dialect dialect and the specific units .
Example: formatByteSize(1000, unit, KLocale::BinaryUnitKilo) returns: for KLocale::MetricBinaryUnits, "1.0 kB", for KLocale::IECBinaryUnits, "0.9 KiB", for KLocale::JEDECBinaryUnits, "0.9 KB".
- Parameters:
-
size size in bytes precision number of places after the decimal point to use. KDE uses 1 by default so when in doubt use 1. dialect binary unit standard to use. Use DefaultBinaryUnits to use the localized user selection unless you need to use a specific unit type (such as displaying a flash memory size in JEDEC). specificUnit specific unit size to use in result. Use DefaultBinarySize to automatically select a unit that will return a sanely-sized number.
- Returns:
- converted size as a translated string including the units. E.g. "1.23 KiB", "2 GB" (JEDEC), "4.2 kB" (Metric).
- Since:
- 4.4
Definition at line 1429 of file klocale.cpp.
Converts size from bytes to the string representation using the user's default binary unit dialect.
The default unit dialect is IEC 60027-2.
Example: formatByteSize(1024) returns "1.0 KiB" by default.
- Parameters:
-
size size in bytes
- Returns:
- converted size as a string - e.g. 123.4 KiB , 12.0 MiB
- See also:
- BinaryUnitDialect
Definition at line 1492 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 1573 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 2163 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 includeSecs if true, the string will include the seconds part of the time; otherwise, the seconds will be omitted
- Returns:
- the date and time as a string
Definition at line 2154 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 1510 of file klocale.cpp.
| QString KLocale::formatLocaleTime | ( | const QTime & | pTime, | |
| TimeFormatOptions | options = KLocale::TimeDefault | |||
| ) | const |
- Since:
- 4.4
Returns a string formatted to the current locale's conventions regarding times.
- Parameters:
-
pTime the time to be formatted option format option to use when formatting the time
- Returns:
- The time as a string
Definition at line 2009 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 1197 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 1125 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 1298 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 1190 of file klocale.cpp.
| QString KLocale::formatTime | ( | const QTime & | pTime, | |
| bool | includeSecs = false, |
|||
| bool | isDuration = false | |||
| ) | const |
- Deprecated:
- replaced by formatLocaleTime()
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 1997 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 1077 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 676 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 592 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 2198 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 666 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
- languageList
- allLanguagesList
Definition at line 2506 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 2105 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 2586 of file klocale.cpp.
| KLocale::MeasureSystem KLocale::measureSystem | ( | ) | const |
Returns which measuring system we use.
- Returns:
- The preferred measuring system
Definition at line 2424 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 1057 of file klocale.cpp.
| KLocale::DigitSet KLocale::monetaryDigitSet | ( | ) | const |
- Since:
- 4.3
Retuns the digit set used to display monetary values.
- Returns:
- the digit set identifier
- See also:
- DigitSet
- digitSetToName
Definition at line 2639 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 1062 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 1097 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 1087 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 1072 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 1011 of file klocale.cpp.
Assignment operator.
Definition at line 2569 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 2413 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 1092 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 1082 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 1067 of file klocale.cpp.
| QString KLocale::prettyFormatDuration | ( | unsigned long | mSec | ) | const |
Given a number of milliseconds, converts that to a pretty string containing the localized equivalent.
e.g. given prettyFormatDuration(60001) returns "1 minute" given prettyFormatDuration(62005) returns "1 minute and 2 seconds" given prettyFormatDuration(90060000) returns "1 day and 1 hour"
- Parameters:
-
mSec Time duration in milliseconds
- Returns:
- converted duration as a string. Units not interesting to the user, for example seconds or minutes when the first unit is day, are not returned because they are irrelevant. The same applies for seconds when the first unit is hour.
- Since:
- 4.2
Definition at line 1539 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 okis 0, it will be ignored
- Returns:
- The string converted to a QDate
Definition at line 1772 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 1777 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 okis 0, it will be ignored
- Returns:
- The string converted to a QDate
Definition at line 1767 of file klocale.cpp.
| QTime KLocale::readLocaleTime | ( | const QString & | str, | |
| bool * | ok = 0, |
|||
| TimeFormatOptions | options = KLocale::TimeDefault, |
|||
| TimeProcessingOptions | processing = ProcessNonStrict | |||
| ) | const |
- Since:
- 4.4
Converts a localized time string to a QTime. This method is stricter than readTime(str, &ok) in that it will either accept a time with seconds or a time without seconds.
- Parameters:
-
str the string we want to convert ok the boolean that is set to false if it's not a valid time. If okis 0, it will be ignored.option format option to apply when formatting the time processing if set to ProcessStrict, checking will be strict and the read time string has to have the exact time format specified. If set toProcessNonStrictprocessing the time is lax and spaces in the time string can be left out.
- Returns:
- The string converted to a QTime
Definition at line 1847 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 okis 0, it will be ignored
- Returns:
- The string converted to a double
Definition at line 1651 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 okis 0, it will be ignored
- Returns:
- The string converted to a double
Definition at line 1584 of file klocale.cpp.
| QTime KLocale::readTime | ( | const QString & | str, | |
| ReadTimeFlags | flags, | |||
| bool * | ok = 0 | |||
| ) | const |
- Deprecated:
- replaced readLocaleTime()
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 okis 0, it will be ignored
- Returns:
- The string converted to a QTime
Definition at line 1790 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 okis 0, it will be ignored
- Returns:
- The string converted to a QTime
Definition at line 1782 of file klocale.cpp.
- Since:
- 4.2
Removes 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:
-
label UI label which may contain an accelerator marker
- Returns:
- label without the accelerator marker
Definition at line 2619 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 727 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 740 of file klocale.cpp.
| void KLocale::setBinaryUnitDialect | ( | BinaryUnitDialect | newDialect | ) |
Sets newDialect to be the default dialect for this locale (and only this locale).
Newly created KLocale objects will continue to default to the user's choice.
- Parameters:
-
newDialect the new dialect to set as default for this locale object.
- Since:
- 4.4
Definition at line 1502 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 2541 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 config a configuration file with a Locale group detailing locale-related preferences (such as date and time formatting)
- Returns:
trueon success,falseon failure
Definition at line 514 of file klocale.cpp.
| void KLocale::setCurrencySymbol | ( | const QString & | symbol | ) |
Changes the current currency symbol.
- Parameters:
-
symbol The new currency symbol
Definition at line 2408 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. "2004" for "2004")
- y with the lower 2 digits of the year (e.g. "04" for "2004")
- 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)
Everything else in the format string will be taken as is. For example, March 20th 1989 with the format "%y:%m:%d" results in "89:03:20".
- Parameters:
-
format The new date format
Definition at line 2292 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)
Everything else in the format string will be taken as is. For example, March 20th 1989 with the format "%y:%m:%d" results in "89:03:20".
- Parameters:
-
format The new short date format
Definition at line 2297 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 2302 of file klocale.cpp.
| void KLocale::setDateTimeDigitSet | ( | DigitSet | digitSet | ) |
- Since:
- 4.3
Set digit characters used to display dates and time.
- Parameters:
-
digitSet the digit set identifier
- See also:
- DigitSet
Definition at line 2644 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 2351 of file klocale.cpp.
| void KLocale::setDigitSet | ( | DigitSet | digitSet | ) |
- Since:
- 4.3
Changes the set of digit characters used to display numbers.
- Parameters:
-
digitSet the digit set identifier
- See also:
- DigitSet
Definition at line 2624 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 2484 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 2392 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 549 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 config a configuration file with a Locale group detailing locale-related preferences (such as date and time formatting)
- Returns:
- true on success
Definition at line 527 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 1578 of file klocale.cpp.
| void KLocale::setMeasureSystem | ( | MeasureSystem | value | ) |
Changes the preferred measuring system.
- Returns:
- value The preferred measuring system
Definition at line 2429 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 2403 of file klocale.cpp.
| void KLocale::setMonetaryDigitSet | ( | DigitSet | digitSet | ) |
- Since:
- 4.3
Set digit characters used to display monetary values.
- Parameters:
-
digitSet the digit set identifier
- See also:
- DigitSet
Definition at line 2634 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 2397 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 2377 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 2387 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 2367 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 2418 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 2372 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 2382 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 2362 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 2356 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")
Everything else in the format string will be taken as is. For example, 5.23pm with the format "%H:%M" results in "17:23".
- Parameters:
-
format The new time format
Definition at line 2307 of file klocale.cpp.
| void KLocale::setWeekDayOfPray | ( | int | day | ) |
Changes how KLocale defines the day reserved for religious observance.
- Since:
- 4.2
- Parameters:
-
day day of the week for religious observance (None=0,Monday=1..Sunday=7) as integer
Definition at line 2330 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 2312 of file klocale.cpp.
| void KLocale::setWorkingWeekEndDay | ( | int | day | ) |
Changes how KLocale defines the last working day in week.
- Since:
- 4.2
- Parameters:
-
day last working day of the week (Monday=1..Sunday=7) as integer
Definition at line 2324 of file klocale.cpp.
| void KLocale::setWorkingWeekStartDay | ( | int | day | ) |
Changes how KLocale defines the first working day in week.
- Since:
- 4.2
- Parameters:
-
day first working day of the week (Monday=1..Sunday=7) as integer
Definition at line 2318 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 625 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 1047 of file klocale.cpp.
| QString KLocale::timeFormat | ( | ) | const |
Returns the currently selected time format.
- Returns:
- Current time format.
- See also:
- setTimeFormat()
Definition at line 2346 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 857 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 850 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 844 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 838 of file klocale.cpp.
Raw translation from message catalogs.
Never use this directly to get message translations. See the i18n and ki18n family of 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 832 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 2096 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 2445 of file klocale.cpp.
| int KLocale::weekDayOfPray | ( | ) | const |
Use this to determine which day is reserved for religious observance.
- Since:
- 4.2
- Returns:
- day number (None = 0, Monday = 1, ..., Sunday = 7)
Definition at line 1036 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 1021 of file klocale.cpp.
| int KLocale::workingWeekEndDay | ( | ) | const |
Use this to determine which day is the last working day of the week.
- Since:
- 4.2
- Returns:
- an integer (Monday=1..Sunday=7)
Definition at line 1031 of file klocale.cpp.
| int KLocale::workingWeekStartDay | ( | ) | const |
Use this to determine which day is the first working day of the week.
- Since:
- 4.2
- Returns:
- an integer (Monday=1..Sunday=7)
Definition at line 1026 of file klocale.cpp.
The documentation for this class was generated from the following files:
