TimeZoneConfiguration Class Reference

Public Member Functions
virtual void	init ()
	Initialize itself. More...
virtual void	deinit ()
	Called before the module will be deleted, and before the renderer is destroyed. More...
virtual void	update (double deltaTime)
	Update the module with respect to the time. More...
virtual double	getCallOrder (StelModuleActionName actionName) const
	Return the value defining the order of call for the given action For example if stars.callOrder[ActionDraw] == 10 and constellation.callOrder[ActionDraw] == 11, the stars module will be drawn before the constellations. More...
virtual bool	configureGui (bool show)
	Detect or show the configuration GUI elements for the module. More...
void	setTimeZone (QString timeZoneString)
	Sets the time zone field in Stellarium's configuration file. More...
QString	readTimeZone ()
	Reads the time zone field in Stellarium's configuration file. More...
void	saveDisplayFormats ()
	Saves the formats used to display date and time in the bottom bar. More...
Public Member Functions inherited from StelModule
virtual void	draw (StelCore *core, class StelRenderer *renderer)
	Execute all the drawing functions for this module. More...
virtual bool	drawPartial (StelCore *core, class StelRenderer *renderer)
	Iterate through the drawing sequence. More...
virtual QString	getModuleVersion () const
	Get the version of the module, default is stellarium main version. More...
virtual QString	getAuthorName () const
	Get the name of the module author. More...
virtual QString	getAuthorEmail () const
	Get the email adress of the module author. More...
virtual void	handleMouseClicks (class QMouseEvent *)
	Handle mouse clicks. More...
virtual void	handleMouseWheel (class QWheelEvent *)
	Handle mouse wheel. More...
virtual bool	handleMouseMoves (int x, int y, Qt::MouseButtons b)
	Handle mouse moves. More...
virtual void	handleKeys (class QKeyEvent *e)
	Handle key events. More...

Additional Inherited Members
Public Types inherited from StelModule
enum	StelModuleSelectAction { AddToSelection, ReplaceSelection, RemoveFromSelection }
	Enum used when selecting objects to define whether to add to, replace, or remove from the existing selection list. More...
enum	StelModuleActionName {   ActionDraw, ActionUpdate, ActionHandleMouseClicks, ActionHandleMouseMoves,   ActionHandleKeys }
	Define the possible action for which an order is defined. More...

Detailed Description

Definition at line 30 of file TimeZoneConfiguration.hpp.

Member Function Documentation

virtual bool TimeZoneConfiguration::configureGui ( bool  show )

virtual

Detect or show the configuration GUI elements for the module.

This is to be used with plugins to display a configuration dialog from the plugin list window.

Parameters

show	if true, make the configuration GUI visible. If false, hide the config GUI if there is one.

Returns

true if the module has a configuration GUI, else false.

Reimplemented from StelModule.

virtual void TimeZoneConfiguration::deinit ( )

virtual

Called before the module will be deleted, and before the renderer is destroyed.

Deinitialize all textures in this method.

Reimplemented from StelModule.

virtual double TimeZoneConfiguration::getCallOrder ( StelModuleActionName  actionName ) const

virtual

Return the value defining the order of call for the given action For example if stars.callOrder[ActionDraw] == 10 and constellation.callOrder[ActionDraw] == 11, the stars module will be drawn before the constellations.

Parameters

actionName

the name of the action for which we want the call order

Returns

the value defining the order. The closer to 0 the earlier the module's action will be called

Reimplemented from StelModule.

virtual void TimeZoneConfiguration::init ( )

virtual

Initialize itself.

If the initialization takes significant time, the progress should be displayed on the loading bar.

Implements StelModule.

QString TimeZoneConfiguration::readTimeZone

(

)

Reads the time zone field in Stellarium's configuration file.

Returns

the contents of the "localization/time_zone" field in Stellarium's configuration file.

void TimeZoneConfiguration::saveDisplayFormats

(

)

Saves the formats used to display date and time in the bottom bar.

void TimeZoneConfiguration::setTimeZone

(

QString

timeZoneString

)

Sets the time zone field in Stellarium's configuration file.

To work, timeZoneString should be a valid value of the TZ environmental variable according to the POSIX format. (See http://www.gnu.org/s/libc/manual/html_node/TZ-Variable.html) Note that Microsoft Windows may use a truncated version of the TZ format. For now, Stellarium needs to be restarted for the new settings to take effect.

virtual void TimeZoneConfiguration::update ( double  deltaTime )

virtual

Update the module with respect to the time.

Parameters

deltaTime

the time increment in second since last call.

Implements StelModule.

---

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

• /home/aw/devel/stellarium/trunk/plugins/TimeZoneConfiguration/src/TimeZoneConfiguration.hpp