StelSkyCultureMgr Class Reference

Manage sky cultures for stellarium. More...

#include <StelSkyCultureMgr.hpp>

Public Slots
QString	getCurrentSkyCultureEnglishName () const
	Get the current sky culture English name.
QString	getCurrentSkyCultureNameI18 () const
	Get the current sky culture translated name.
bool	setCurrentSkyCultureNameI18 (const QString &cultureName)
	Set the sky culture from i18n name. More...
QString	getCurrentSkyCultureID () const
	Get the current sky culture ID.
bool	setCurrentSkyCultureID (const QString &id)
	Set the current sky culture from the ID. More...
int	getCurrentSkyCultureBoundariesIdx () const
	Get the type of boundaries of the current sky culture Config option: info/boundaries Keys: More...
int	getCurrentSkyCultureClassificationIdx () const
	Get the classification index for the current sky culture Config option: info/classification Possible values: More...
QString	getCurrentSkyCultureHtmlClassification () const
QString	getCurrentSkyCultureHtmlReferences () const
QString	getCurrentSkyCultureHtmlDescription () const
	Returns a localized HTML description for the current sky culture. More...
QString	getDefaultSkyCultureID ()
	Get the default sky culture ID.
bool	setDefaultSkyCultureID (const QString &id)
	Set the default sky culture from the ID. More...
QString	getSkyCultureListEnglish (void) const
	Get a list of sky culture names in English. More...
QStringList	getSkyCultureListI18 (void) const
	Get a list of sky culture names in the current language. More...
QStringList	getSkyCultureListIDs (void) const
	Get a list of sky culture IDs.
QMap< QString, StelSkyCulture >	getDirToNameMap () const
	Returns a map from sky culture IDs/folders to sky culture names.

Signals
void	defaultSkyCultureChanged (const QString &id)
	Emitted whenever the default sky culture changed. More...
void	currentSkyCultureChanged (const QString &id)
	Emitted when the current sky culture changes.

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

Properties
QString	currentSkyCultureID
QString	defaultSkyCultureID

Detailed Description

In the installation data directory and user data directory are the "skycultures" sub-directories 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

defaultSkyCultureChanged

void StelSkyCultureMgr::defaultSkyCultureChanged ( const QString &  id )

signal

See also

setDefaultSkyCultureID

getCurrentSkyCultureBoundariesIdx

int StelSkyCultureMgr::getCurrentSkyCultureBoundariesIdx ( ) const

slot

• none (-1; using by default)
• generic (0)
• own (1)

getCurrentSkyCultureClassificationIdx

int StelSkyCultureMgr::getCurrentSkyCultureClassificationIdx ( ) const

slot

• scientific (1)
• traditional (2; using by default)
• personal (3)
• single (4)

getCurrentSkyCultureHtmlClassification

QString StelSkyCultureMgr::getCurrentSkyCultureHtmlClassification ( ) const

slot

Returns

a localized HTML description of the classification for the current sky culture

getCurrentSkyCultureHtmlDescription

QString StelSkyCultureMgr::getCurrentSkyCultureHtmlDescription ( ) const

slot

Returns

a HTML description of the current sky culture, suitable for display

getCurrentSkyCultureHtmlReferences

QString StelSkyCultureMgr::getCurrentSkyCultureHtmlReferences ( ) const

slot

Returns

a localized HTML description of the references for the current sky culture

getSkyCultureListEnglish

QString StelSkyCultureMgr::getSkyCultureListEnglish ( void  ) const

slot

Returns

A new-line delimited list of English sky culture names.

getSkyCultureListI18

QStringList StelSkyCultureMgr::getSkyCultureListI18 ( void  ) const

slot

Returns

A list of translated sky culture names.

init()

void StelSkyCultureMgr::init

(

)

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

setCurrentSkyCultureID

bool StelSkyCultureMgr::setCurrentSkyCultureID ( const QString &  id )

slot

Parameters

id	the sky culture ID.

Returns

true on success; else false.

setCurrentSkyCultureNameI18

bool StelSkyCultureMgr::setCurrentSkyCultureNameI18 ( const QString &  cultureName )

slot

Returns

true on success; false and doesn't change if skyculture is invalid.

setDefaultSkyCultureID

bool StelSkyCultureMgr::setDefaultSkyCultureID ( const QString &  id )

slot

Parameters

id	the sky culture ID.

Returns

true on success; else false.