Manage sky cultures for stellarium. More...

#include <StelSkyCultureMgr.hpp>

Inheritance diagram for StelSkyCultureMgr:

Collaboration diagram for StelSkyCultureMgr:

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 () const
	Get the current sky culture ID. More...

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 Possible values: none (-1; using by default) generic (0) own (1) More...

QString	getCurrentSkyCultureHtmlDescription () const
	Returns a localized HTML description for the current sky culture. 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...

QMap< QString, StelSkyCulture >	getDirToNameMap () const
	Returns a map from sky culture IDs/folders to sky culture names. More...

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

Public Member Functions
void	init ()
	Initialize the StelSkyCultureMgr object. More...

StelSkyCulture	getSkyCulture () const
	Get the current sky culture. More...

Properties
QString	currentSkyCultureID

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

Definition at line 49 of file StelSkyCultureMgr.hpp.

Member Function Documentation

void StelSkyCultureMgr::currentSkyCultureChanged ( const QString & id )

signal

Emitted when the current sky culture changes.

void StelSkyCultureMgr::defaultSkyCultureChanged ( const QString & id )

signal

Emitted whenever the default sky culture changed.

See also: setDefaultSkyCultureID

int StelSkyCultureMgr::getCurrentSkyCultureBoundariesIdx ( ) const

slot

Get the type of boundaries of the current sky culture Config option: info/boundaries Possible values: none (-1; using by default) generic (0) own (1)

QString StelSkyCultureMgr::getCurrentSkyCultureEnglishName ( ) const

slot

Get the current sky culture English name.

QString StelSkyCultureMgr::getCurrentSkyCultureHtmlDescription ( ) const

slot

Returns a localized HTML description for the current sky culture.

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

QString StelSkyCultureMgr::getCurrentSkyCultureID ( ) const

inlineslot

Get the current sky culture ID.

Definition at line 79 of file StelSkyCultureMgr.hpp.

QString StelSkyCultureMgr::getCurrentSkyCultureNameI18 ( ) const

slot

Get the current sky culture translated name.

QString StelSkyCultureMgr::getDefaultSkyCultureID ( )

inlineslot

Get the default sky culture ID.

Definition at line 98 of file StelSkyCultureMgr.hpp.

QMap<QString, StelSkyCulture> StelSkyCultureMgr::getDirToNameMap ( ) const

inlineslot

Returns a map from sky culture IDs/folders to sky culture names.

Definition at line 116 of file StelSkyCultureMgr.hpp.

StelSkyCulture StelSkyCultureMgr::getSkyCulture ( ) const

inline

Get the current sky culture.

Definition at line 67 of file StelSkyCultureMgr.hpp.

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

id	the sky culture ID.

Returns: true on success; else false.

bool StelSkyCultureMgr::setCurrentSkyCultureNameI18 ( const QString & cultureName )

slot

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

id	the sky culture ID.

Returns: true on success; else false.

The documentation for this class was generated from the following file:

/home/aw/devel/stellarium/0.15/src/core/StelSkyCultureMgr.hpp

Public Slots

Signals

Public Member Functions

Properties

Detailed Description

Member Function Documentation