Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KLocale Class Reference

class for supporting locale settings and national language More...

#include <klocale.h>

List of all members.

Public Types

enum  SignPosition
enum  MeasureSystem

Public Methods

 KLocale (const QString &catalogue, KConfig *config=0)
 KLocale (const KLocale &rhs)
KLocale & operator= (const KLocale &rhs)
 ~KLocale ()
QString translate (const char *index) const
QString translate (const char *index, const char *fallback) const
QString translate (const char *singular, const char *plural, unsigned long n) const
bool setCharset (const QString &charset)
bool setEncoding (int mibEnum)
bool setLanguage (const QString &language)
bool setLanguage (const QStringList &languages)
bool setCountry (const QString &country)
QString decimalSymbol () const
QString thousandsSeparator () const
QString currencySymbol () const
QString monetaryDecimalSymbol () const
QString monetaryThousandsSeparator () const
QString positiveSign () const
QString negativeSign () const
int fracDigits () const
bool positivePrefixCurrencySymbol () const
bool negativePrefixCurrencySymbol () const
SignPosition positiveMonetarySignPosition () const
SignPosition negativeMonetarySignPosition () const
QString formatMoney (double num, const QString &currency=QString::null, int digits=-1) const
QString formatMoney (const QString &numStr) const
QString formatNumber (double num, int precision=-1) const
QString formatNumber (const QString &numStr) const
bool nounDeclension () const
QString formatDate (const QDate &pDate, bool shortFormat=false) const
bool dateMonthNamePossessive () const
QString formatTime (const QTime &pTime, bool includeSecs=false) const
bool use12Clock () const
bool weekStartsMonday () const
int weekStartDay () const
QString monthName (int i, bool shortName=false) const
QString monthNamePossessive (int i, bool shortName=false) const
QString weekDayName (int i, bool shortName=false) const
QString formatDateTime (const QDateTime &pDateTime, bool shortFormat=true, bool includeSecs=false) const
double readMoney (const QString &numStr, bool *ok=0) const
double readNumber (const QString &numStr, bool *ok=0) const
QDate readDate (const QString &str, bool *ok=0) const
QDate readDate (const QString &intstr, const QString &fmt, bool *ok=0) const
QTime readTime (const QString &str, bool *ok=0) const
QString language () const
QString country () const
QString languages () const
QStringList languagesTwoAlpha () const
QStringList languageList () const
QString charset () const
const char * encoding () const
int encodingMib () const
QTextCodec * codecForEncoding () const
void setDateFormat (const QString &format)
void setDateFormatShort (const QString &format)
void setDateMonthNamePossessive (bool possessive)
void setTimeFormat (const QString &format)
void setWeekStartsMonday (bool start)
void setWeekStartDay (int day)
QString dateFormat () const
QString dateFormatShort () const
QString timeFormat () const
void setDecimalSymbol (const QString &symbol)
void setThousandsSeparator (const QString &separator)
void setPositiveSign (const QString &sign)
void setNegativeSign (const QString &sign)
void setPositiveMonetarySignPosition (SignPosition signpos)
void setNegativeMonetarySignPosition (SignPosition signpos)
void setPositivePrefixCurrencySymbol (bool prefix)
void setNegativePrefixCurrencySymbol (bool prefix)
void setFracDigits (int digits)
void setMonetaryThousandsSeparator (const QString &separator)
void setMonetaryDecimalSymbol (const QString &symbol)
void setCurrencySymbol (const QString &symbol)
int pageSize () const
void setPageSize (int paperFormat)
MeasureSystem measureSystem () const
void setMeasureSystem (MeasureSystem value)
void insertCatalogue (const QString &catalogue)
void removeCatalogue (const QString &catalogue)
void setActiveCatalogue (const QString &catalogue)
QString translateQt (const char *context, const char *sourceText, const char *message) const
QStringList allLanguagesTwoAlpha () const
QString twoAlphaToLanguageName (const QString &code) const
QStringList allCountriesTwoAlpha () const
QString twoAlphaToCountryName (const QString &code) const

Static Public Methods

void splitLocale (const QString &str, QString &language, QString &country, QString &charset)
void setMainCatalogue (const char *catalogue)
QString langLookup (const QString &fname, const char *rtype="html")
QString defaultLanguage ()
QString defaultCountry ()


Detailed Description

class for supporting locale settings and national language

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.

Author:
Stephan Kulow <coolo@kde.org>, Preston Brown <pbrown@kde.org>, Hans Petter Bieker <bieker@kde.org>, Lukas Tinkl <lukas.tinkl@suse.cz>

Definition at line 92 of file klocale.h.


Member Enumeration Documentation

enum KLocale::MeasureSystem
 

The Metric system will give you information in mm, while the Imperial system will give you information in inches.

Definition at line 873 of file klocale.h.

enum KLocale::SignPosition
 

Various positions for where to place the positive or negative sign when they are related to a monetary value.

Definition at line 246 of file klocale.h.


Constructor & Destructor Documentation

KLocale::KLocale (  const QString &    catalogue,
KConfig *    config = 0
) 
 

Constructs a KLocale with the given catalogue name. The constructor looks for an entry Locale/Language in the configuration file. If no config file is specified, it will also look for languages using the environment variables (KDE_LANG, LC_MESSAGES, LC_ALL, LANG), as well as the global configuration fie. If we were not able to use non of the specified languages, the default language (en_US) will be used.

If you specify a configuration file, it has to be valid until the KLocale object is destroyed.

Parameters:
catalogue  The name of the main language file
config  The configuration file to use.

KLocale::KLocale (  const KLocale &    rhs ) 
 

Copy constructor.

KLocale::~KLocale (    ) 
 

Destructor.


Member Function Documentation

QStringList KLocale::allCountriesTwoAlpha (    ) 
 

Returns list of all known country codes.

Returns:
a list of all country codes
Since:
3.1

QStringList KLocale::allLanguagesTwoAlpha (    ) 
 

Returns list of all known ISO 639-1 codes.

Returns:
a list of all language codes
Since:
3.1

QString KLocale::charset (    ) 
 

Deprecated:
Returns the charset name by selected locale. This will be the charset defined in the config file. NOTE: This is no longer the same as encoding. "iso-8859-1" is default

Returns:
Name of the preferred charset for fonts
See also:
encoding

QTextCodec* KLocale::codecForEncoding (    ) 
 

Returns the user's preferred encoding. Should never be NULL.

Returns:
The codec for the preferred encoding
See also:
encoding , encodingMib

QString KLocale::country (    ) 
 

Returns the country code of the country where the user lives. "C" is default, if no other available

Returns:
The country code for the user.

QString KLocale::currencySymbol (    ) 
 

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.

QString KLocale::dateFormat (    ) 
 

Returns the currently selected date format.

Returns:
Current date format.
See also:
setDateFormat()

QString KLocale::dateFormatShort (    ) 
 

Returns the currently selected short date format.

Returns:
Current short date format.
See also:
setDateFormatShort()

bool KLocale::dateMonthNamePossessive (    ) 
 

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

QString KLocale::decimalSymbol (    ) 
 

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.

QString KLocale::defaultCountry (    )  [static]
 

Returns the name of the default country.

Returns:
Name of the default country

QString KLocale::defaultLanguage (    )  [static]
 

Returns the name of the internal language.

Returns:
Name of the default language

const char* KLocale::encoding (    ) 
 

Returns the user's preferred encoding.

Returns:
The name of the preferred encoding
See also:
codecForEncoding , encodingMib

int KLocale::encodingMib (    ) 
 

Returns the user's preferred encoding.

Returns:
The Mib of the preferred encoding
See also:
encoding , codecForEncoding

QString KLocale::formatDate (  const QDate &    pDate,
bool    shortFormat = false
)  const
 

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

QString KLocale::formatDateTime (  const QDateTime &    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.
includeSeconds  using the short date format.
Returns:
The date and time as a string

QString KLocale::formatMoney (  const QString &    numStr )  const
 

Deprecated:
This function differs from the above only in that it can take a QString as the argument for convenience.
Parameters:
numStr  The string you want to reformat.
Returns:
The number of money as a localized string

QString KLocale::formatMoney (  double    num,
const QString &    currency = QString::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()

QString KLocale::formatNumber (  const QString &    numStr )  const
 

Deprecated:
This function differs from the above only in that it can take a QString as the argument for convenience.
Parameters:
numStr  The string you want to convert.
Returns:
The number as a formated string

QString KLocale::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.78, return "123,456.78" (for some European country). If precision isn't specified, 2 is used.

Parameters:
num  The number to convert
precision  Number of fractional digits used.
Returns:
The number as a localized string

QString KLocale::formatTime (  const QTime &    pTime,
bool    includeSecs = false
)  const
 

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

int KLocale::fracDigits (    ) 
 

The number of fractional digits to include in numeric/monetary values (usually 2).

Returns:
Default number of fractional digits used by locale.

void KLocale::insertCatalogue (  const QString &    catalogue ) 
 

Adds another catalogue to search for translation lookup. This function is useful for extern libraries and/or code, that provides its own messages.

If the catalogue does not exist for the chosen language, it will be ignored and en_US will be used.

Parameters:
catalogue  The catalogue to add.

QString KLocale::langLookup (  const QString &    fname,
const char *    rtype = "html"
)  [static]
 

Finds localized resource in resourceDir( rtype ) + <lang> + fname.

Parameters:
fname  relative path to find
rtype  resource type to use

QString KLocale::language (    ) 
 

Returns the language used by this object. The domain AND the library translation must be available in this language. "en_US" is default, if no other available.

Returns:
The currently used language.

QStringList KLocale::languageList (    ) 
 

Returns the languages selected by user. The codes returned here is the internal language codes.

Returns:
List of language codes
See also:
languagesTwoAlpha

QString KLocale::languages (    ) 
 

Deprecated:
Returns the languages selected by user.

Returns:
String containing language codes separated by colons

QStringList KLocale::languagesTwoAlpha (    ) 
 

Returns the preferred languages as ISO 639-1 codes. This means that information about country is removed. If the internal language code might be represented by more than one 639-1 code, they will all be listed (but only once).

If the selected languages are "nn, nb, pt_BR", you will get: "nn, no, nb, pt".

Returns:
List of language codes
See also:
languageList

MeasureSystem KLocale::measureSystem (    ) 
 

Returns which measuring system we use.

Returns:
The preferred measuring system

QString KLocale::monetaryDecimalSymbol (    ) 
 

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.

QString KLocale::monetaryThousandsSeparator (    ) 
 

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.

QString KLocale::monthName (  int    i,
bool    shortName = false
)  const
 

Returns a string containing the name of the month name.

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

QString KLocale::monthNamePossessive (  int    i,
bool    shortName = false
)  const
 

Returns a string containing the possessive form of the month name. ("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

SignPosition KLocale::negativeMonetarySignPosition (    ) 
 

Denotes where to place a negative sign in relation to a monetary value.

Returns:
Where/how to print the negative sign.
See also:
SignPosition

bool KLocale::negativePrefixCurrencySymbol (    ) 
 

If and only if the currency symbol precedes a negative value, this will be true.

Returns:
True if the currency symbol precedes negative numbers.

QString KLocale::negativeSign (    ) 
 

Returns what a negative sign should look like ("-", etc.) according to the current locale or user settings.

Returns:
The negative sign used by locale.

bool KLocale::nounDeclension (    ) 
 

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

KLocale& KLocale::operator= (  const KLocale &    rhs ) 
 

Assignment operator.

int KLocale::pageSize (    ) 
 

Returns the preferred page size for printing.

Returns:
The preferred page size, cast it to QPrinter::PageSize

SignPosition KLocale::positiveMonetarySignPosition (    ) 
 

Returns the position of a positive sign in relation to a monetary value.

Returns:
Where/how to print the positive sign.
See also:
SignPosition

bool KLocale::positivePrefixCurrencySymbol (    ) 
 

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.

QString KLocale::positiveSign (    ) 
 

Returns what a positive sign should look like ("+", " ", etc.) according to the current locale or user settings.

Returns:
The positive sign used by locale.

QDate KLocale::readDate (  const QString &    intstr,
const QString &    fmt,
bool *    ok = 0
)  const
 

Converts a localized date string to a QDate, using the specified format. You will usually not want to use this method.

QDate KLocale::readDate (  const QString &    str,
bool *    ok = 0
)  const
 

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

double KLocale::readMoney (  const QString &    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

double KLocale::readNumber (  const QString &    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

QTime KLocale::readTime (  const QString &    str,
bool *    ok = 0
)  const
 

Converts a localized time string to a QTime. The bool pointed by ok will be 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

void KLocale::removeCatalogue (  const QString &    catalogue ) 
 

Removes a catalog for translation lookup.

Parameters:
catalogue  The catalogue to remove.
See also:
insertCatalogue()

void KLocale::setActiveCatalogue (  const QString &    catalogue ) 
 

Sets the active catalog for translation lookup.

Parameters:
catalogue  The catalogue to activate.

bool KLocale::setCharset (  const QString &    charset ) 
 

Deprecated:
Changes the current charset used for fonts.
Parameters:
charset  The new charset
Returns:
True on success.

bool KLocale::setCountry (  const QString &    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.

void KLocale::setCurrencySymbol (  const QString &    symbol ) 
 

Changes the current currency symbol.

Parameters:
symbol  The new currency symbol

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 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)
  • 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 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 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)
  • 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 KLocale::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 KLocale::setDecimalSymbol (  const QString &    symbol ) 
 

Changes the symbol used to identify the decimal pointer.

Parameters:
symbol  The new decimal symbol.

bool KLocale::setEncoding (  int    mibEnum ) 
 

Changes the current encoding.

Parameters:
mibEnum  The mib of the preferred codec
Returns:
True on success.

void KLocale::setFracDigits (  int    digits ) 
 

Changes the number of digits used when formating numbers.

Parameters:
digits  The default number of digits to use.

bool KLocale::setLanguage (  const QStringList &    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.

bool KLocale::setLanguage (  const QString &    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.

void KLocale::setMainCatalogue (  const char *    catalogue )  [static]
 

Use this to as main catalogue 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 (and this is in common KDE applications quite early).

Parameters:
catalogue  Catalogue to override all other main catalogues.

void KLocale::setMeasureSystem (  MeasureSystem    value ) 
 

Changes the preferred measuring system.

Returns:
value The preferred measuring system

void KLocale::setMonetaryDecimalSymbol (  const QString &    symbol ) 
 

Changes the symbol used to identify the decimal pointer for monetary values.

Parameters:
symbol  The new decimal symbol.

void KLocale::setMonetaryThousandsSeparator (  const QString &    separator ) 
 

Changes the separator used to group digits when formating monetary values.

Parameters:
separator  The new thousands separator.

void KLocale::setNegativeMonetarySignPosition (  SignPosition    signpos ) 
 

Changes the sign position used for negative monetary values.

Parameters:
signpos  The new sign position

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

void KLocale::setNegativeSign (  const QString &    sign ) 
 

Changes the sign used to identify a negative number.

Parameters:
sign  Sign used for negative numbers.

void KLocale::setPageSize (  int    paperFormat ) 
 

Changes the preferred page size when printing.

Parameters:
The  new preferred page size in the format QPrinter::PageSize

void KLocale::setPositiveMonetarySignPosition (  SignPosition    signpos ) 
 

Changes the sign position used for positive monetary values.

Parameters:
signpos  The new sign position

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

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.

void KLocale::setThousandsSeparator (  const QString &    separator ) 
 

Changes the separator used to group digits when formating numbers.

Parameters:
separator  The new thousands separator.

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

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
Since:
3.1

void KLocale::setWeekStartsMonday (  bool    start ) 
 

Deprecated:

Please use setWeekStartDay instead.

Changes how KLocale defines the first day in week.

Parameters:
start  True if Monday is the first day in the week

void KLocale::splitLocale (  const QString &    str,
QString &    language,
QString &    country,
QString &    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.

QString KLocale::thousandsSeparator (    ) 
 

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.

QString KLocale::timeFormat (    ) 
 

Returns the currently selected time format.

Returns:
Current time format.
See also:
setTimeFormat()

QString KLocale::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

QString KLocale::translate (  const char *    index,
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:
index  The lookup text
fallback  the default text, if not found
Returns:
translation

QString KLocale::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 catalogue 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.

QString KLocale::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 QString::null)

Since:
3.1

QString KLocale::twoAlphaToCountryName (  const QString &    code )  const
 

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

QString KLocale::twoAlphaToLanguageName (  const QString &    code )  const
 

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 KLocale::use12Clock (    ) 
 

Use this to determine if the user wants a 12 hour clock.

Returns:
If the user wants 12h clock

QString KLocale::weekDayName (  int    i,
bool    shortName = false
)  const
 

Returns a string containing the name of the week day.

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

int KLocale::weekStartDay (    ) 
 

Use this to determine which day is the first day of the week.

Returns:
an integer (Monday=1..Sunday=7)
Since:
3.1

bool KLocale::weekStartsMonday (    ) 
 

Deprecated:

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


The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:18 2003 for kdelibs by doxygen1.2.18