LogBook Class Reference

This is an example of a plug-in which can be dynamically loaded into stellarium.

#include <LogBook.hpp>

Public Slots
void	enableLogBook (bool b)
	This method is called with we detect that our hot key is pressed. More...
void	setConfigDialogVisible (bool b)
void	setTargetsDialogVisible (bool b)

Public Member Functions
virtual bool	configureGui (bool show=true)
	Detect or show the configuration GUI elements for the module. More...
virtual void	draw (StelCore *core)
	Execute all the drawing functions for this module. 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...
const StelStyle	getModuleStyleSheet (const StelStyle &style)
	Returns the module-specific style sheet. More...
virtual void	init ()
	Initialize itself. More...
virtual void	setStelStyle (const QString &section)
virtual void	update (double)
	Update the module with respect to the time. More...
Public Member Functions inherited from StelModule
virtual void	deinit ()
	Called before the module will be delete, and before the openGL context is suppressed. More...
virtual QString	getModuleVersion () const
	Get the version of the module, default is stellarium main version.
virtual QString	getAuthorName () const
	Get the name of the module author.
virtual QString	getAuthorEmail () const
	Get the email adress of the module author.
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...
virtual bool	handlePinch (qreal scale, bool started)
	Handle pinch gesture 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...
Protected Member Functions inherited from StelModule
class StelAction *	addAction (const QString &id, const QString &groupId, const QString &text, QObject *target, const char *slot, const QString &shortcut="", const QString &altShortcut="")
	convenience methods to add an action (call to slot) to the StelActionMgr object. More...
class StelAction *	addAction (const QString &id, const QString &groupId, const QString &text, const char *slot, const QString &shortcut="", const QString &altShortcut="")
	convenience methods to add an action (call to own slot) to the StelActionMgr object. More...

Member Function Documentation

configureGui()

virtual bool LogBook::configureGui ( bool  show = true )

virtual

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.

draw()

virtual void LogBook::draw ( StelCore *  core )

virtual

Parameters

core	the core to use for the drawing

Reimplemented from StelModule.

enableLogBook

void LogBook::enableLogBook ( bool  b )

slot

It handles determining if we should do anything - based on a selected object - and painting labes to the screen.

getCallOrder()

virtual double LogBook::getCallOrder ( StelModuleActionName  actionName ) const

virtual

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.

getModuleStyleSheet()

const StelStyle LogBook::getModuleStyleSheet

(

const StelStyle &

style

)

The main StelStyle instance should be passed.

init()

virtual void LogBook::init ( )

virtual

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

Implements StelModule.

update()

virtual void LogBook::update ( double  deltaTime )

inlinevirtual

Parameters

deltaTime

the time increment in second since last call.

Implements StelModule.