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

StelSkyCultureMgr Class Reference

Manage sky cultures for stellarium. More...

#include <StelSkyCultureMgr.hpp>

List of all members.

Public Slots

QString getCurrentSkyCultureNameI18 () const
bool setCurrentSkyCultureNameI18 (const QString &cultureName)
QString getCurrentSkyCultureID ()
bool setCurrentSkyCultureID (const QString &id)
QString getDefaultSkyCultureID ()
bool setDefaultSkyCultureID (const QString &id)
QString getSkyCultureListEnglish (void)
QStringList getSkyCultureListI18 (void)
QStringList getSkyCultureListIDs (void)

Public Member Functions

void init ()
StelSkyCulture getSkyCulture () const


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

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

StelSkyCulture StelSkyCultureMgr::getSkyCulture (  )  const [inline]

Get the current sky culture.

QString StelSkyCultureMgr::getCurrentSkyCultureNameI18 (  )  const [slot]

Get the current sky culture translated name.

bool StelSkyCultureMgr::setCurrentSkyCultureNameI18 ( const QString &  cultureName  )  [inline, slot]

Set the sky culture from i18n name.

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

QString StelSkyCultureMgr::getCurrentSkyCultureID (  )  [inline, slot]

Get the current sky culture ID.

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.

QString StelSkyCultureMgr::getDefaultSkyCultureID (  )  [inline, slot]

Get the default sky culture ID.

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.

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.


Generated on Mon Mar 22 09:55:39 2010 for Stellarium by  doxygen 1.5.5