tdecore
TDELocale Class Reference
TDELocale provides support for country specific stuff like the national language. More...
#include <tdelocale.h>
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 | |
TDELocale (const TQString &catalog, TDEConfig *config=0) | |
TDELocale (const TDELocale &rhs) | |
TDELocale & | operator= (const TDELocale &rhs) |
~TDELocale () | |
TQString | translate (const char *index) const |
TQString | translate (const char *comment, const char *fallback) const |
TQString | translate (const char *singular, const char *plural, unsigned long n) const |
bool | setEncoding (int mibEnum) |
bool | setLanguage (const TQString &language) |
bool | setLanguage (const TQStringList &languages) |
bool | setCountry (const TQString &country) |
TQString | decimalSymbol () const |
TQString | thousandsSeparator () const |
TQString | currencySymbol () const |
TQString | monetaryDecimalSymbol () const |
TQString | monetaryThousandsSeparator () const |
TQString | positiveSign () const |
TQString | negativeSign () const |
int | fracDigits () const |
bool | positivePrefixCurrencySymbol () const |
bool | negativePrefixCurrencySymbol () const |
SignPosition | positiveMonetarySignPosition () const |
SignPosition | negativeMonetarySignPosition () const |
TQString | formatMoney (double num, const TQString ¤cy=TQString::null, int digits=-1) const |
TQString | formatNumber (double num, int precision=-1) const |
TQString | formatNumber (const TQString &numStr) const KDE_DEPRECATED |
TQString | formatNumber (const TQString &numStr, bool round, int precision) const |
TQString | formatLong (long num) const |
bool | nounDeclension () const |
TQString | formatDate (const TQDate &pDate, bool shortFormat=false) const |
bool | dateMonthNamePossessive () const |
TQString | formatTime (const TQTime &pTime, bool includeSecs, bool isDuration) const |
TQString | formatTime (const TQTime &pTime, bool includeSecs=false) const |
bool | use12Clock () const |
bool | weekStartsMonday () const KDE_DEPRECATED |
int | weekStartDay () const |
TQString | monthName (int i, bool shortName=false) const KDE_DEPRECATED |
TQString | monthNamePossessive (int i, bool shortName=false) const KDE_DEPRECATED |
TQString | weekDayName (int i, bool shortName=false) const KDE_DEPRECATED |
const KCalendarSystem * | calendar () const |
TQString | calendarType () const |
void | setCalendar (const TQString &calendarType) |
TQString | formatDateTime (const TQDateTime &pDateTime, bool shortFormat=true, bool includeSecs=false) const |
double | readMoney (const TQString &numStr, bool *ok=0) const |
double | readNumber (const TQString &numStr, bool *ok=0) const |
TQDate | readDate (const TQString &str, bool *ok=0) const |
TQDate | readDate (const TQString &intstr, const TQString &fmt, bool *ok=0) const |
TQDate | readDate (const TQString &str, ReadDateFlags flags, bool *ok=0) const |
TQTime | readTime (const TQString &str, bool *ok=0) const |
TQTime | readTime (const TQString &str, ReadTimeFlags flags, bool *ok=0) const |
TQString | language () const |
TQString | country () const |
TQStringList | languagesTwoAlpha () const |
TQStringList | languageList () const |
const char * | encoding () const |
int | encodingMib () const |
TQTextCodec * | codecForEncoding () const |
int | fileEncodingMib () const |
void | setDateFormat (const TQString &format) |
void | setDateFormatShort (const TQString &format) |
void | setDateMonthNamePossessive (bool possessive) |
void | setTimeFormat (const TQString &format) |
void | setWeekStartsMonday (bool start) KDE_DEPRECATED |
void | setWeekStartDay (int day) |
TQString | dateFormat () const |
TQString | dateFormatShort () const |
TQString | timeFormat () const |
void | setDecimalSymbol (const TQString &symbol) |
void | setThousandsSeparator (const TQString &separator) |
void | setPositiveSign (const TQString &sign) |
void | setNegativeSign (const TQString &sign) |
void | setPositiveMonetarySignPosition (SignPosition signpos) |
void | setNegativeMonetarySignPosition (SignPosition signpos) |
void | setPositivePrefixCurrencySymbol (bool prefix) |
void | setNegativePrefixCurrencySymbol (bool prefix) |
void | setFracDigits (int digits) |
void | setMonetaryThousandsSeparator (const TQString &separator) |
void | setMonetaryDecimalSymbol (const TQString &symbol) |
void | setCurrencySymbol (const TQString &symbol) |
int | pageSize () const |
void | setPageSize (int paperFormat) |
MeasureSystem | measureSystem () const |
void | setMeasureSystem (MeasureSystem value) |
void | insertCatalogue (const TQString &catalog) |
void | removeCatalogue (const TQString &catalog) |
void | setActiveCatalogue (const TQString &catalog) |
TQString | translateQt (const char *context, const char *sourceText, const char *message) const |
TQStringList | allLanguagesTwoAlpha () const |
TQString | twoAlphaToLanguageName (const TQString &code) const |
TQStringList | allCountriesTwoAlpha () const |
TQString | twoAlphaToCountryName (const TQString &code) const |
TQString | formatMoney (const TQString &numStr) const KDE_DEPRECATED |
TQString | languages () const KDE_DEPRECATED |
bool | setCharset (const TQString &charset) KDE_DEPRECATED |
TQString | charset () const KDE_DEPRECATED |
bool | isApplicationTranslatedInto (const TQString &language) |
Static Public Member Functions | |
static void | splitLocale (const TQString &str, TQString &language, TQString &country, TQString &charset) |
static void | setMainCatalogue (const char *catalog) |
static TQString | langLookup (const TQString &fname, const char *rtype="html") |
static TQString | defaultLanguage () |
static TQString | defaultCountry () |
static TQString | _initLanguage (TDEConfigBase *config) |
Static Protected Member Functions | |
static void | initInstance () |
Friends | |
class | TDEGlobal |
Related Functions | |
(Note that these are not member functions.) | |
I18N_NOOP(x) | |
I18N_NOOP2(comment, x) | |
TQString | i18n (const char *text) |
TQString | i18n (const char *comment, const char *text) |
TQString | i18n (const char *singular, const char *plural, unsigned long n) |
TQString | tr2i18n (const char *message, const char *=0) |
Detailed Description
TDELocale provides support for country specific stuff like the national language.
TDELocale supports translating, as well as specifying the format for numbers, currency, time, and date.
Definition at line 124 of file tdelocale.h.
Member Enumeration Documentation
The Metric system will give you information in mm, while the Imperial system will give you information in inches.
Definition at line 1012 of file tdelocale.h.
Various positions for where to place the positive or negative sign when they are related to a monetary value.
Definition at line 267 of file tdelocale.h.
Constructor & Destructor Documentation
Constructs a TDELocale 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 (TDE_LANG, LC_MESSAGES, LC_ALL, LANG), as well as the global configuration file. If TDELocale 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 TDELocale object is destroyed.
- Parameters:
-
catalog The name of the main language file config The configuration file to use.
Definition at line 84 of file tdelocale.cpp.
TDELocale::TDELocale | ( | const TDELocale & | rhs | ) |
Copy constructor.
TDELocale::~TDELocale | ( | ) |
Destructor.
Definition at line 712 of file tdelocale.cpp.
Member Function Documentation
TQStringList TDELocale::allCountriesTwoAlpha | ( | ) | const |
Returns list of all known country codes.
- Returns:
- a list of all country codes
- Since:
- 3.1
TQStringList TDELocale::allLanguagesTwoAlpha | ( | ) | const |
Returns list of all known ISO 639-1 codes.
- Returns:
- a list of all language codes
- Since:
- 3.1
const KCalendarSystem* TDELocale::calendar | ( | ) | const |
Returns a pointer to the calendar system object.
- Returns:
- the current calendar system instance
- Since:
- 3.2
TQString TDELocale::calendarType | ( | ) | const |
Returns the name of the calendar system that is currently being used by the system.
- Returns:
- the name of the calendar system
- Since:
- 3.2
TQTextCodec* TDELocale::codecForEncoding | ( | ) | const |
Returns the user's preferred encoding.
Should never be NULL.
- Returns:
- The codec for the preferred encoding
- See also:
- encoding
- encodingMib
TQString TDELocale::country | ( | ) | const |
Returns the country code of the country where the user lives.
defaultCountry() is returned by default, if no other available.
- Returns:
- The country code for the user.
Definition at line 559 of file tdelocale.cpp.
TQString TDELocale::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 1043 of file tdelocale.cpp.
TQString TDELocale::dateFormat | ( | ) | const |
TQString TDELocale::dateFormatShort | ( | ) | const |
Returns the currently selected short date format.
- Returns:
- Current short date format.
- See also:
- setDateFormatShort()
bool TDELocale::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
- Since:
- 3.1
Definition at line 1013 of file tdelocale.cpp.
TQString TDELocale::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 1031 of file tdelocale.cpp.
static TQString TDELocale::defaultCountry | ( | ) | [static] |
Returns the name of the default country.
- Returns:
- Name of the default country
static TQString TDELocale::defaultLanguage | ( | ) | [static] |
Returns the name of the internal language.
- Returns:
- Name of the default language
const char* TDELocale::encoding | ( | ) | const |
Returns the user's preferred encoding.
- Returns:
- The name of the preferred encoding
- See also:
- codecForEncoding
- encodingMib
int TDELocale::encodingMib | ( | ) | const |
Returns the user's preferred encoding.
- Returns:
- The Mib of the preferred encoding
- See also:
- encoding
- codecForEncoding
int TDELocale::fileEncodingMib | ( | ) | const |
Returns the file encoding.
- Returns:
- The Mib of the file encoding
- See also:
- TQFile::encodeName
- TQFile::decodeName
Returns a string formatted to the current locale's conventions regarding dates.
- Parameters:
-
pDate The date to be formated. shortFormat True for non text dates.
- Returns:
- The date as a string
Definition at line 1338 of file tdelocale.cpp.
TQString TDELocale::formatDateTime | ( | const TQDateTime & | pDateTime, | |
bool | shortFormat = true , |
|||
bool | includeSecs = false | |||
) | const |
Returns a string formated to the current locale's conventions regarding both date and time.
- Parameters:
-
pDateTime The date and time to be formated. shortFormat using the short date format. includeSecs using the short date format.
- Returns:
- The date and time as a string
Definition at line 1968 of file tdelocale.cpp.
TQString TDELocale::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
- Since:
- 3.2
Definition at line 1203 of file tdelocale.cpp.
TQString TDELocale::formatMoney | ( | double | num, | |
const TQString & | currency = TQString::null , |
|||
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 1130 of file tdelocale.cpp.
- Deprecated:
- use formatMoney(double)
Definition at line 1191 of file tdelocale.cpp.
KDE 4.0: merge with formatNumber(const TQString int)
calls formatNumber(numStr, 2)
Definition at line 1208 of file tdelocale.cpp.
TQString TDELocale::formatNumber | ( | double | num, | |
int | precision = -1 | |||
) | const |
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 TQString, bool, int)
Definition at line 1196 of file tdelocale.cpp.
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 convert round Round fractional digits. precision Number of fractional digits used.
- Returns:
- The number as a localized string
- Since:
- 3.5
Definition at line 1304 of file tdelocale.cpp.
Returns a string formatted to the current locale's conventions regarding times.
- Parameters:
-
pTime The time to be formated. 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 1863 of file tdelocale.cpp.
Returns a string formatted to the current locale's conventions regarding times.
- Parameters:
-
pTime The time to be formated. includeSecs if true, seconds are included in the output, otherwise only hours and minutes are formatted.
- Returns:
- The time as a string
Definition at line 1858 of file tdelocale.cpp.
int TDELocale::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 1073 of file tdelocale.cpp.
void TDELocale::insertCatalogue | ( | const TQString & | 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 645 of file tdelocale.cpp.
Finds localized resource in resourceDir( rtype ) + <lang> + fname.
- Parameters:
-
fname relative path to find rtype resource type to use
Definition at line 2020 of file tdelocale.cpp.
TQString TDELocale::language | ( | ) | const |
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.
- Returns:
- The currently used language.
Definition at line 554 of file tdelocale.cpp.
TQStringList TDELocale::languageList | ( | ) | const |
Returns the languages selected by user.
The codes returned here is the internal language codes.
- Returns:
- List of language codes
- See also:
- languagesTwoAlpha
Definition at line 1963 of file tdelocale.cpp.
TQString TDELocale::languages | ( | ) | const |
- Returns:
- String containing language codes separated by colons
Definition at line 1958 of file tdelocale.cpp.
TQStringList TDELocale::languagesTwoAlpha | ( | ) | const |
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, nb, pt".
- Returns:
- List of language codes
- See also:
- languageList
MeasureSystem TDELocale::measureSystem | ( | ) | const |
Returns which measuring system we use.
- Returns:
- The preferred measuring system
TQString TDELocale::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 1049 of file tdelocale.cpp.
TQString TDELocale::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 1055 of file tdelocale.cpp.
TQString TDELocale::monthName | ( | int | i, | |
bool | shortName = false | |||
) | const |
Returns a string containing the name of the month name used in the Gregorian calendar.
- Parameters:
-
i the month number of the year starting at 1/January. shortName we will return the short version of the string.
- Returns:
- The name of the month
Typically the correct replacement for this deprecated class is calendar()->monthString(), which requires a TQDate (rather than an integer month) or both a month and a year. This will work across different calendars. Note that you also need to add
#include <kcalendarsystem.h>
to the applicable file.
Definition at line 564 of file tdelocale.cpp.
TQString TDELocale::monthNamePossessive | ( | int | i, | |
bool | shortName = false | |||
) | const |
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.
- Parameters:
-
i the month number of the year starting at 1/January. shortName we will return the short version of the string.
- Returns:
- The possessive form of the name of the month
- Since:
- 3.1
Typically the correct replacement for this deprecated class is calendar()->monthNamePossessive(), which requires a TQDate (rather than an integer month) or both a month and a year. This will work across different calendars. Note that you also need to add
#include <kcalendarsystem.h>
to the applicable file.
Definition at line 602 of file tdelocale.cpp.
TDELocale::SignPosition TDELocale::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 tdelocale.cpp.
bool TDELocale::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 1085 of file tdelocale.cpp.
TQString TDELocale::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 1067 of file tdelocale.cpp.
bool TDELocale::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
- Since:
- 3.1
Definition at line 1007 of file tdelocale.cpp.
int TDELocale::pageSize | ( | ) | const |
Returns the preferred page size for printing.
- Returns:
- The preferred page size, cast it to TQPrinter::PageSize
TDELocale::SignPosition TDELocale::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 1091 of file tdelocale.cpp.
bool TDELocale::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 1079 of file tdelocale.cpp.
TQString TDELocale::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 1061 of file tdelocale.cpp.
Converts a localized date string to a TQDate.
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 1597 of file tdelocale.cpp.
Converts a localized date string to a TQDate, using the specified format.
You will usually not want to use this method.
Definition at line 1611 of file tdelocale.cpp.
Converts a localized date string to a TQDate.
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
- Since:
- 3.2
Definition at line 1605 of file tdelocale.cpp.
double TDELocale::readMoney | ( | const TQString & | numStr, | |
bool * | ok = 0 | |||
) | const |
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 1483 of file tdelocale.cpp.
double TDELocale::readNumber | ( | const TQString & | numStr, | |
bool * | ok = 0 | |||
) | const |
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 1418 of file tdelocale.cpp.
Converts a localized time string to a TQTime.
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
- Since:
- 3.2
Definition at line 1750 of file tdelocale.cpp.
Converts a localized time string to a TQTime.
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 1742 of file tdelocale.cpp.
void TDELocale::removeCatalogue | ( | const TQString & | catalog | ) |
Removes a catalog for translation lookup.
- Parameters:
-
catalog The catalog to remove.
- See also:
- insertCatalogue()
Definition at line 694 of file tdelocale.cpp.
void TDELocale::setActiveCatalogue | ( | const TQString & | catalog | ) |
Sets the active catalog for translation lookup.
- Parameters:
-
catalog The catalog to activate.
Definition at line 703 of file tdelocale.cpp.
void TDELocale::setCalendar | ( | const TQString & | 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
- Since:
- 3.2
bool TDELocale::setCharset | ( | const TQString & | charset | ) |
- Returns:
- True
bool TDELocale::setCountry | ( | const TQString & | country | ) |
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 391 of file tdelocale.cpp.
void TDELocale::setCurrencySymbol | ( | const TQString & | symbol | ) |
Changes the current currency symbol.
- Parameters:
-
symbol The new currency symbol
void TDELocale::setDateFormat | ( | const TQString & | format | ) |
Changes the current date format.
The format of the date is a string which contains variables that will be replaced:
- Y with the century (e.g. "19" 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 date format
void TDELocale::setDateFormatShort | ( | const TQString & | 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 century (e.g. "19" 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
void TDELocale::setDateMonthNamePossessive | ( | bool | possessive | ) |
Changes the form of month name used in dates.
- Parameters:
-
possessive True if possessive forms should be used
- Since:
- 3.1
void TDELocale::setDecimalSymbol | ( | const TQString & | symbol | ) |
Changes the symbol used to identify the decimal pointer.
- Parameters:
-
symbol The new decimal symbol.
bool TDELocale::setEncoding | ( | int | mibEnum | ) |
Changes the current encoding.
- Parameters:
-
mibEnum The mib of the preferred codec
- Returns:
- True on success.
void TDELocale::setFracDigits | ( | int | digits | ) |
Changes the number of digits used when formating numbers.
- Parameters:
-
digits The default number of digits to use.
bool TDELocale::setLanguage | ( | const TQString & | language | ) |
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 418 of file tdelocale.cpp.
bool TDELocale::setLanguage | ( | const TQStringList & | languages | ) |
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.
- Parameters:
-
languages The list of language codes.
- Returns:
- True if one of the specified languages were used.
Definition at line 436 of file tdelocale.cpp.
void TDELocale::setMainCatalogue | ( | const char * | catalog | ) | [static] |
Use this as main catalog for *all* TDELocales, 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 TDELocale object is created.
- Parameters:
-
catalog Catalogue to override all other main catalogues.
Definition at line 1413 of file tdelocale.cpp.
void TDELocale::setMeasureSystem | ( | MeasureSystem | value | ) |
Changes the preferred measuring system.
- Returns:
- value The preferred measuring system
void TDELocale::setMonetaryDecimalSymbol | ( | const TQString & | symbol | ) |
Changes the symbol used to identify the decimal pointer for monetary values.
- Parameters:
-
symbol The new decimal symbol.
void TDELocale::setMonetaryThousandsSeparator | ( | const TQString & | separator | ) |
Changes the separator used to group digits when formating monetary values.
- Parameters:
-
separator The new thousands separator.
void TDELocale::setNegativeMonetarySignPosition | ( | SignPosition | signpos | ) |
Changes the sign position used for negative monetary values.
- Parameters:
-
signpos The new sign position
void TDELocale::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
void TDELocale::setNegativeSign | ( | const TQString & | sign | ) |
Changes the sign used to identify a negative number.
- Parameters:
-
sign Sign used for negative numbers.
void TDELocale::setPageSize | ( | int | paperFormat | ) |
Changes the preferred page size when printing.
- Parameters:
-
paperFormat the new preferred page size in the format TQPrinter::PageSize
void TDELocale::setPositiveMonetarySignPosition | ( | SignPosition | signpos | ) |
Changes the sign position used for positive monetary values.
- Parameters:
-
signpos The new sign position
void TDELocale::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
void TDELocale::setPositiveSign | ( | const TQString & | sign | ) |
Changes the sign used to identify a positive number.
Normally this is left blank.
- Parameters:
-
sign Sign used for positive numbers.
void TDELocale::setThousandsSeparator | ( | const TQString & | separator | ) |
Changes the separator used to group digits when formating numbers.
- Parameters:
-
separator The new thousands separator.
void TDELocale::setTimeFormat | ( | const TQString & | 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
void TDELocale::setWeekStartDay | ( | int | day | ) |
Changes how TDELocale defines the first day in week.
- Parameters:
-
day first day of the week (Monday=1..Sunday=7) as integer
- Since:
- 3.1
void TDELocale::setWeekStartsMonday | ( | bool | start | ) |
Please use setWeekStartDay instead.
Changes how TDELocale defines the first day in week.
- Parameters:
-
start True if Monday is the first day in the week
void TDELocale::splitLocale | ( | const TQString & | str, | |
TQString & | language, | |||
TQString & | country, | |||
TQString & | charset | |||
) | [static] |
Returns the parts of the parameter str understood as language setting the format is language_COUNTRY.charset.
- Parameters:
-
str The string to split. language This will be set to the language part of the string. country This will be set to the country part of the string. charset This will be set to the charset part of the string.
Definition at line 521 of file tdelocale.cpp.
TQString TDELocale::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 1037 of file tdelocale.cpp.
TQString TDELocale::timeFormat | ( | ) | const |
TQString TDELocale::translate | ( | const char * | comment, | |
const char * | fallback | |||
) | const |
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()
- Parameters:
-
comment the comment. The lookup text is made out of comment + fallback
fallback the default text, if not found
- Returns:
- translation
Definition at line 774 of file tdelocale.cpp.
TQString TDELocale::translate | ( | const char * | singular, | |
const char * | plural, | |||
unsigned long | n | |||
) | const |
Used to get the correct, translated singular or plural of a word.
- Parameters:
-
singular the singular form of the word, for example "file". plural the plural form of the word. Must contain a "%n" that will be replaced by the number n
, for example "%n files"n the number
- Returns:
- the correct singular or plural for the selected language, depending on n
Definition at line 810 of file tdelocale.cpp.
TQString TDELocale::translate | ( | const char * | index | ) | const |
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)
- Parameters:
-
index The lookup text and default text, if not found.
Definition at line 769 of file tdelocale.cpp.
TQString TDELocale::translateQt | ( | const char * | context, | |
const char * | sourceText, | |||
const char * | message | |||
) | 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 TQString::null)
- Since:
- 3.1
Definition at line 963 of file tdelocale.cpp.
Convert a country code to a human readable form.
- Parameters:
-
code the country code
- Returns:
- the human readable form of the country name
- Since:
- 3.1
Convert a ISO 639-1 code to a human readable form.
- Parameters:
-
code the language ISO 639-1 code
- Returns:
- the human readable form
- Since:
- 3.1
bool TDELocale::use12Clock | ( | ) | const |
Use this to determine if the user wants a 12 hour clock.
- Returns:
- If the user wants 12h clock
Definition at line 1949 of file tdelocale.cpp.
TQString TDELocale::weekDayName | ( | int | i, | |
bool | shortName = false | |||
) | const |
- Deprecated:
- use calendar()->weekDayName
Returns a string containing the name of the week day used in the Gregorian calendar.
- Parameters:
-
i the day number of the week starting at 1/Monday. shortName we will return the short version of the string.
- Returns:
- The name of the day
Definition at line 640 of file tdelocale.cpp.
int TDELocale::weekStartDay | ( | ) | const |
Use this to determine which day is the first day of the week.
- Returns:
- an integer (Monday=1..Sunday=7)
- Since:
- 3.1
Definition at line 1019 of file tdelocale.cpp.
bool TDELocale::weekStartsMonday | ( | ) | const |
Please use the weekStartDay method instead.
Use this to determine if the user wants the week to start on Monday.
- Returns:
- true if the week starts on Monday
Definition at line 1025 of file tdelocale.cpp.
Friends And Related Function Documentation
TQString i18n | ( | const char * | text | ) | [related] |
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 TQString 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 1977 of file tdelocale.cpp.
TQString i18n | ( | const char * | comment, | |
const char * | text | |||
) | [related] |
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.
- See also:
- translate
Definition at line 1985 of file tdelocale.cpp.
TQString i18n | ( | const char * | singular, | |
const char * | plural, | |||
unsigned long | n | |||
) | [related] |
If you want to handle plural forms, use this form of i18n.
- Parameters:
-
singular the singular form of the word, for example "file". plural the plural form of the word. Must contain a "%n" that will be replaced by the number n
, for example "%n files"n the number
- Returns:
- the correct singular or plural for the selected language, depending on n
- See also:
- translate
Definition at line 1993 of file tdelocale.cpp.
I18N_NOOP | ( | x | ) | [related] |
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 52 of file tdelocale.h.
I18N_NOOP2 | ( | comment, | ||
x | ||||
) | [related] |
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 ).
- Since:
- 3.3
Definition at line 63 of file tdelocale.h.
TQString tr2i18n | ( | const char * | message, | |
const char * | = 0 | |||
) | [related] |
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 108 of file tdelocale.h.
The documentation for this class was generated from the following files: