StelGui Class Reference

Main class for the GUI based on QGraphicView. More...

#include <StelGui.hpp>

Public Slots
void	setFlagShowFlipButtons (bool b)
	Define whether the buttons toggling image flip should be visible. More...
void	setFlagShowNebulaBackgroundButton (bool b)
	Define whether the button toggling nebulae background should be visible. More...
bool	getAutoHideHorizontalButtonBar () const
	Get the auto-hide status of the horizontal toolbar. More...
void	setAutoHideHorizontalButtonBar (bool b)
	Set the auto-hide status of the horizontal toolbar. More...
bool	getAutoHideVerticalButtonBar () const
	Get the auto-hide status of the vertical toolbar. More...
void	setAutoHideVerticalButtonBar (bool b)
	Set the auto-hide status of the vertical toolbar. More...
void	setScriptKeys (bool b)
	change keys when a script is running / not running More...
void	increaseScriptSpeed ()
void	decreaseScriptSpeed ()
void	setRealScriptSpeed ()
void	stopScript ()
void	pauseScript ()
void	resumeScript ()
void	setGuiVisible (bool)
	Hide or show the GUI. Public so it can be called from scripts. More...

Public Member Functions
virtual void	init (QGraphicsWidget *topLevelGraphicsWidget, StelAppGraphicsWidget *stelAppGraphicsWidget)
	Initialize the StelGui object. More...
void	update ()
StelStyle	getStelStyle () const
void	loadStyle (const QString &fileName)
	Load a Qt style sheet to define the widgets style. More...
class QProgressBar *	addProgressBar ()
	Add a new progress bar in the lower right corner of the screen. More...
BottomStelBar *	getButtonBar () const
	Get the button bar at the bottom of the screensetDateTime. More...
class LeftStelBar *	getWindowsButtonBar () const
	Get the button bar of the left of the screen. More...
class SkyGui *	getSkyGui () const
	Get the SkyGui instance (useful for adding other interface elements). More...
bool	getFlagShowFlipButtons () const
	Get whether the buttons toggling image flip are visible. More...
bool	getFlagShowNebulaBackgroundButton () const
	Get whether the button toggling nebulae background is visible. More...
bool	initComplete (void) const
	returns true if the gui has complted init process. More...
virtual void	forceRefreshGui ()
	Used to force a refreshing of the GUI elements such as the button bars. More...
virtual void	setVisible (bool b)
	Show whether the GUI is visible. More...
virtual bool	getVisible () const
	Get the current visible status of the GUI. More...
virtual bool	isCurrentlyUsed () const
	Show wether the Gui is currently used. More...
virtual void	setInfoTextFilters (const StelObject::InfoStringGroup &aflags)
	Get a pointer on the info panel used to display selected object info. More...
virtual const StelObject::InfoStringGroup &	getInfoTextFilters () const
virtual QAction *	getGuiAction (const QString &actionName)
Public Member Functions inherited from StelGuiBase
virtual void	setStelStyle (const QString &section)=0
	Load color scheme matchin the section name. More...

Additional Inherited Members
Protected Member Functions inherited from StelGuiBase
void	updateI18n ()
	Translate all texts to the new Locale. More...
Protected Attributes inherited from StelGuiBase
class StelAppGraphicsWidget *	stelAppGraphicsWidget

Detailed Description

Main class for the GUI based on QGraphicView.

It manages the various qt configuration windows, the buttons bars, the list of QAction/shortcuts.

Definition at line 50 of file StelGui.hpp.

Member Function Documentation

class QProgressBar* StelGui::addProgressBar ( )

virtual

Add a new progress bar in the lower right corner of the screen.

When the progress bar is deleted with removeProgressBar() the layout is automatically rearranged.

Returns

a pointer to the progress bar

Implements StelGuiBase.

virtual void StelGui::forceRefreshGui ( )

virtual

Used to force a refreshing of the GUI elements such as the button bars.

Reimplemented from StelGuiBase.

bool StelGui::getAutoHideHorizontalButtonBar ( ) const

slot

Get the auto-hide status of the horizontal toolbar.

bool StelGui::getAutoHideVerticalButtonBar ( ) const

slot

Get the auto-hide status of the vertical toolbar.

BottomStelBar* StelGui::getButtonBar

(

)

const

Get the button bar at the bottom of the screensetDateTime.

bool StelGui::getFlagShowFlipButtons

(

)

const

Get whether the buttons toggling image flip are visible.

bool StelGui::getFlagShowNebulaBackgroundButton

(

)

const

Get whether the button toggling nebulae background is visible.

class SkyGui* StelGui::getSkyGui

(

)

const

Get the SkyGui instance (useful for adding other interface elements).

It will return a valid object only if called after init().

virtual bool StelGui::getVisible ( ) const

virtual

Get the current visible status of the GUI.

Implements StelGuiBase.

class LeftStelBar* StelGui::getWindowsButtonBar

(

)

const

Get the button bar of the left of the screen.

virtual void StelGui::init ( QGraphicsWidget *  topLevelGraphicsWidget, StelAppGraphicsWidget *  stelAppGraphicsWidget  )

virtual

Initialize the StelGui object.

Reimplemented from StelGuiBase.

bool StelGui::initComplete

(

void

)

const

returns true if the gui has complted init process.

virtual bool StelGui::isCurrentlyUsed ( ) const

virtual

Show wether the Gui is currently used.

This can then be used to optimize the rendering to increase reactivity.

Implements StelGuiBase.

void StelGui::loadStyle

(

const QString &

fileName

)

Load a Qt style sheet to define the widgets style.

void StelGui::setAutoHideHorizontalButtonBar ( bool  b )

slot

Set the auto-hide status of the horizontal toolbar.

When set to true, the horizontal toolbar will auto-hide itself, only making an appearance when the mouse is nearby. When false, it will remain on screen.

Parameters

b	to hide or not to hide

void StelGui::setAutoHideVerticalButtonBar ( bool  b )

slot

Set the auto-hide status of the vertical toolbar.

When set to true, the vertical toolbar will auto-hide itself, only making an appearance when the mouse is nearby. When false, it will remain on screen.

Parameters

b	to hide or not to hide

void StelGui::setFlagShowFlipButtons ( bool  b )

slot

Define whether the buttons toggling image flip should be visible.

void StelGui::setFlagShowNebulaBackgroundButton ( bool  b )

slot

Define whether the button toggling nebulae background should be visible.

void StelGui::setGuiVisible ( bool  )

slot

Hide or show the GUI. Public so it can be called from scripts.

virtual void StelGui::setInfoTextFilters ( const StelObject::InfoStringGroup &  aflags )

virtual

Get a pointer on the info panel used to display selected object info.

Implements StelGuiBase.

void StelGui::setScriptKeys ( bool  b )

slot

change keys when a script is running / not running

virtual void StelGui::setVisible ( bool  b )

virtual

Show whether the GUI is visible.

Parameters

b	when true, GUI will be shown, else it will be hidden.

Implements StelGuiBase.

---

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

• gui/StelGui.hpp