Stellarium  0.90.0
Public Types | Public Member Functions | Static Public Member Functions
StelLocaleMgr Class Reference

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

#include <StelLocaleMgr.hpp>

Public Types

enum  STimeFormat { STime24h, STime12h, STimeSystemDefault }
 The time display format. More...
 
enum  SDateFormat { SDateMMDDYYYY, SDateDDMMYYYY, SDateSystemDefault, SDateYYYYMMDD }
 The date display format. More...
 

Public Member Functions

void init ()
 Initialize object. More...
 
QString getAppLanguage () const
 Get the application language currently used for GUI etc. More...
 
void setAppLanguage (const QString &newAppLangName, bool refreshAll=true)
 Set the application language. More...
 
const StelTranslatorgetAppStelTranslator () const
 Get the StelTranslator object currently used for global application.
 
bool isAppRTL () const
 Get the type (RTL or LTR) of application language currently used for GUI etc.
 
QString getSkyLanguage () const
 Get the language currently used for sky objects. More...
 
void setSkyLanguage (const QString &newSkyLangName, bool refreshAll=true)
 Set the sky language and reload the sky object names with the new translation. More...
 
const StelTranslatorgetSkyTranslator () const
 Get a reference to the StelTranslator object currently used for sky objects.
 
const StelTranslatorgetPlanetaryFeaturesTranslator () const
 Get a reference to the StelTranslator object currently used for planetary features.
 
bool isSkyRTL () const
 Get the type (RTL or LTR) of language currently used for sky objects.
 
QString getTimeFormatStr (void) const
 Get the format string which describes the current time format. More...
 
void setTimeFormatStr (const QString &tf)
 Set the time format from a format string. More...
 
QString getDateFormatStr (void) const
 Get the format string which describes the current date format. More...
 
void setDateFormatStr (const QString &df)
 
QString getQtDateFormatStr (void) const
 Get the format string which describes the current date format (Qt style).
 
QString getPrintableDateLocal (double JD) const
 Get a localized, formatted string representation of the date component of a Julian date.
 
QString getPrintableTimeLocal (double JD) const
 Get a localized, formatted string representation of the time component of a Julian date.
 
QString getPrintableTimeZoneLocal (double JD) const
 Get a localized, formatted string representation of the time zone of a Julian date.
 
QString getISO8601TimeLocal (double JD) const
 Return the time in ISO 8601 format that is : Y-m-dTH:M:S. More...
 
double getJdFromISO8601TimeLocal (const QString &str, bool *ok) 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. More...
 

Static Public Member Functions

static QString countryCodeToString (const QString &countryCode)
 Convert a 2 letter country code to string. Returns empty string if countryCode unknown.
 
static QString countryNameToCode (const QString &countryName)
 Convert a countryName to 2 letter country code. Returns "??" if not found.
 
static QStringList getAllCountryNames ()
 Return an alphabetically ordered list of all the known country names.
 

Detailed Description

Author
Fabien Chereau

Member Enumeration Documentation

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
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.

Member Function Documentation

QString StelLocaleMgr::getAppLanguage ( ) const
inline

This function has no permanent effect on the global locale.

Returns
the abbreviated name of the language (e.g "fr").
QString StelLocaleMgr::getDateFormatStr ( void  ) const
inline

Valid values:

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

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

QString StelLocaleMgr::getISO8601TimeLocal ( double  JD) const
Parameters
JDthe time and date expressed as a Julian date value.
double StelLocaleMgr::getJdFromISO8601TimeLocal ( const QString &  str,
bool *  ok 
) const
Parameters
strthe local time in ISO 8601 format.
okset to false if the string was an invalid date.
QString StelLocaleMgr::getSkyLanguage ( ) const

This function has no permanent effect on the global locale.

Returns
the name of the language (e.g fr).
QString StelLocaleMgr::getTimeFormatStr ( void  ) const
inline

Valid values are:

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

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

void StelLocaleMgr::init ( )

This process includes:

  • Setting the sky and application languages
  • Setting the time and date formats
  • Setting up the time zone
void StelLocaleMgr::setAppLanguage ( const QString &  newAppLangName,
bool  refreshAll = true 
)

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

Parameters
newAppLangNamethe abbreviated name of the language (e.g fr).
void StelLocaleMgr::setSkyLanguage ( const QString &  newSkyLangName,
bool  refreshAll = true 
)

This function has no permanent effect on the global locale.

Parameters
newSkyLangNameThe abbreviated name of the locale (e.g fr) to use for sky object labels.
void StelLocaleMgr::setTimeFormatStr ( const QString &  tf)
inline
Parameters
tfvalues are the same as the return values for getTimeFormatStr().