Stellarium 0.13.0
List of all members | Public Slots | Public Member Functions
StelSkyCultureMgr Class Reference

Manage sky cultures for stellarium. More...

#include <StelSkyCultureMgr.hpp>

Public Slots

QString getCurrentSkyCultureEnglishName () const
 Get the current sky culture English name. More...
 
QString getCurrentSkyCultureNameI18 () const
 Get the current sky culture translated name. More...
 
bool setCurrentSkyCultureNameI18 (const QString &cultureName)
 Set the sky culture from i18n name. More...
 
QString getCurrentSkyCultureID ()
 Get the current sky culture ID. More...
 
bool setCurrentSkyCultureID (const QString &id)
 Set the current sky culture from the ID. More...
 
QString getDefaultSkyCultureID ()
 Get the default sky culture ID. More...
 
bool setDefaultSkyCultureID (const QString &id)
 Set the default sky culture from the ID. More...
 
QString getSkyCultureListEnglish (void)
 Get a list of sky culture names in English. More...
 
QStringList getSkyCultureListI18 (void)
 Get a list of sky culture names in the current language. More...
 
QStringList getSkyCultureListIDs (void)
 Get a list of sky culture IDs. More...
 

Public Member Functions

void init ()
 Initialize the StelSkyCultureMgr object. More...
 
StelSkyCulture getSkyCulture () const
 Get the current sky culture. More...
 

Detailed Description

Manage sky cultures for stellarium.

Different human cultures have used different names for stars, and visualised different constellations in the sky (and in different parts of the sky). In the installation data directory and user data directory are the "skycultures" sub-directory containing one sub-directory per sky culture. This sub-directory name is that we refer to as sky culture ID here.

Author
Fabien Chereau

Member Function Documentation

QString StelSkyCultureMgr::getCurrentSkyCultureEnglishName ( ) const
slot

Get the current sky culture English name.

QString StelSkyCultureMgr::getCurrentSkyCultureID ( )
inlineslot

Get the current sky culture ID.

QString StelSkyCultureMgr::getCurrentSkyCultureNameI18 ( ) const
slot

Get the current sky culture translated name.

QString StelSkyCultureMgr::getDefaultSkyCultureID ( )
inlineslot

Get the default sky culture ID.

StelSkyCulture StelSkyCultureMgr::getSkyCulture ( ) const
inline

Get the current sky culture.

QString StelSkyCultureMgr::getSkyCultureListEnglish ( void  )
slot

Get a list of sky culture names in English.

Returns
A new-line delimited list of English sky culture names.
QStringList StelSkyCultureMgr::getSkyCultureListI18 ( void  )
slot

Get a list of sky culture names in the current language.

Returns
A list of translated sky culture names.
QStringList StelSkyCultureMgr::getSkyCultureListIDs ( void  )
slot

Get a list of sky culture IDs.

void StelSkyCultureMgr::init ( )

Initialize the StelSkyCultureMgr object.

Gets the default sky culture name from the application's settings, sets that sky culture by calling setCurrentSkyCultureID().

bool StelSkyCultureMgr::setCurrentSkyCultureID ( const QString &  id)
slot

Set the current sky culture from the ID.

Parameters
idthe sky culture ID.
Returns
true on success; else false.
bool StelSkyCultureMgr::setCurrentSkyCultureNameI18 ( const QString &  cultureName)
inlineslot

Set the sky culture from i18n name.

Returns
true on success; false and doesn't change if skyculture is invalid.
bool StelSkyCultureMgr::setDefaultSkyCultureID ( const QString &  id)
slot

Set the default sky culture from the ID.

Parameters
idthe sky culture ID.
Returns
true on success; else false.