Home · All Namespaces · All Classes · Functions · Coding Style · Plugins · File Structure

StelLocaleMgr Class Reference

Manage i18n operations such as message translation and date/time localization. More...

#include <StelLocaleMgr.hpp>

List of all members.

Public Types

enum  STimeFormat { STime24h, STime12h, STimeSystemDefault }
enum  SDateFormat { SDateMMDDYYYY, SDateDDMMYYYY, SDateSystemDefault, SDateYYYYMMDD }
enum  STzFormat { STzCustom, STzGMTShift, STzSystemDefault }

Public Member Functions

void init ()
QString getAppLanguage () const
void setAppLanguage (const QString &newAppLangName)
StelTranslatorgetAppStelTranslator () const
QString getSkyLanguage () const
void setSkyLanguage (const QString &newSkyLangName)
StelTranslatorgetSkyTranslator ()
QString getTimeFormatStr (void) const
void setTimeFormatStr (const QString &tf)
QString getDateFormatStr (void) const
void setDateFormatStr (const QString &df)
void setCustomTimezone (QString tZ)
QString getPrintableDateLocal (double JD) const
QString getPrintableTimeLocal (double JD) const
void setGMTShift (int t)
float getGMTShift (double JD=0) const
void setCustomTzName (const QString &tzname)
QString getCustomTzName (void) const
STzFormat getTzFormat (void) const
QString getISO8601TimeLocal (double JD) const
double getJdFromISO8601TimeLocal (const QString &str) const

Static Public Member Functions

static QString countryCodeToString (const QString &countryCode)
static QStringList getAllCountryNames ()


Detailed Description

Manage i18n operations such as message translation and date/time localization.

Author:
Fabien Chereau

Member Enumeration Documentation

The time display format.

Enumerator:
STime24h  24 hour clock, e.g. "18:22:00"
STime12h  12 hour clock, e.g. "06:22:00 pm"
STimeSystemDefault  use the system default format.

The date display format.

Enumerator:
SDateMMDDYYYY  e.g. "07-05-1998" for July 5th 1998
SDateDDMMYYYY  e.g. "05-07-1998" for July 5th 1998
SDateSystemDefault  Use the system default date format.
SDateYYYYMMDD  e.g. "1998-07-05" for July 5th 1998

Enumerator:
STzCustom  User-specified timezone.
STzGMTShift  GMT + offset.
STzSystemDefault  System default.


Member Function Documentation

void StelLocaleMgr::init (  ) 

Initialize object.

This process includes:

  • Setting the sky and application languages
  • Setting the time and date formats
  • Setting up the time zone

QString StelLocaleMgr::getAppLanguage (  )  const [inline]

Get the application language currently used for GUI etc.

This function has no permanent effect on the global locale.

Returns:
the abbreviated name of the language (e.g "fr").

void StelLocaleMgr::setAppLanguage ( const QString &  newAppLangName  ) 

Set the application language.

This applies to GUI etc. This function has no permanent effect on the global locale.

Parameters:
newAppLangName the abbreviated name of the language (e.g fr).

StelTranslator& StelLocaleMgr::getAppStelTranslator (  )  const

Get the StelTranslator object currently used for global application.

QString StelLocaleMgr::getSkyLanguage (  )  const

Get the language currently used for sky objects.

This function has no permanent effect on the global locale.

Returns:
the name of the language (e.g fr).

void StelLocaleMgr::setSkyLanguage ( const QString &  newSkyLangName  ) 

Set the sky language and reload the sky object names with the new translation.

This function has no permanent effect on the global locale.

Parameters:
newSkyLangName The abbreviated name of the locale (e.g fr) to use for sky object labels.

StelTranslator& StelLocaleMgr::getSkyTranslator (  ) 

Get a reference to the StelTranslator object currently used for sky objects.

QString StelLocaleMgr::getTimeFormatStr ( void   )  const [inline]

Get the format string which describes the current time format.

Valid values are:

  • "system_default"
  • "24h"
  • "12h"

These values correspond to the similarly named values in the STimeFormat enum.

void StelLocaleMgr::setTimeFormatStr ( const QString &  tf  )  [inline]

Set the time format from a format string.

Parameters:
tf values are the same as the return values for getTimeFormatStr().

QString StelLocaleMgr::getDateFormatStr ( void   )  const [inline]

Get the format string which describes the current date format.

Valid values:

  • "mmddyyyy"
  • "ddmmyyyy"
  • "system_default"
  • "yyyymmdd"

These values correspond to the similarly named values in the SDateFormat enum.

void StelLocaleMgr::setCustomTimezone ( QString  tZ  )  [inline]

Set the time zone.

Parameters:
tZ the time zone string as parsed from the TZ environment varibale by the tzset function from libc.

QString StelLocaleMgr::getPrintableDateLocal ( double  JD  )  const

Get a localized, formatted string representation of the date component of a Julian date.

QString StelLocaleMgr::getPrintableTimeLocal ( double  JD  )  const

Get a localized, formatted string representation of the time component of a Julian date.

void StelLocaleMgr::setGMTShift ( int  t  )  [inline]

Get the current time shift at observator time zone with respect to GMT time.

float StelLocaleMgr::getGMTShift ( double  JD = 0  )  const

Get the current time shift in hours at observator time zone with respect to GMT time.

void StelLocaleMgr::setCustomTzName ( const QString &  tzname  ) 

Set the timezone by a TZ-style string (see tzset in the libc manual).

QString StelLocaleMgr::getCustomTzName ( void   )  const [inline]

Get the timezone name (a TZ-style string - see tzset in the libc manual).

STzFormat StelLocaleMgr::getTzFormat ( void   )  const [inline]

Get the current timezone format mode.

QString StelLocaleMgr::getISO8601TimeLocal ( double  JD  )  const

Return the time in ISO 8601 format that is : Y-m-dTH:M:S.

Parameters:
JD the time and date expressed as a Julian date value.

double StelLocaleMgr::getJdFromISO8601TimeLocal ( const QString &  str  )  const

Return the JD time for a local time ISO 8601 format that is: Y-m-dTH:M:S, but Y can be a large number with sign, and Y can be zero.

Parameters:
str the local time in ISO 8601 format

static QString StelLocaleMgr::countryCodeToString ( const QString &  countryCode  )  [static]

Convert a 2 letter country code to string.

static QStringList StelLocaleMgr::getAllCountryNames (  )  [static]

Return a list of all the known country names.


Generated on Mon Mar 9 16:16:16 2009 for Stellarium by  doxygen 1.5.5