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.
bool	getFlagShowFlipButtons () const
	Get whether the buttons toggling image flip are visible.
void	setFlagShowNebulaBackgroundButton (bool b)
	Define whether the button toggling nebulae background should be visible.
bool	getFlagShowNebulaBackgroundButton () const
	Get whether the button toggling nebulae background is visible.
void	setFlagShowToastSurveyButton (bool b)
	Define whether the button toggling TOAST survey should be visible.
bool	getFlagShowToastSurveyButton () const
	Get whether the button toggling TOAST survey is visible.
void	setFlagShowBookmarksButton (bool b)
	Define whether the button toggling bookmarks should be visible.
bool	getFlagShowBookmarksButton () const
	Get whether the button toggling bookmarks is visible.
void	setFlagShowICRSGridButton (bool b)
	Define whether the button toggling ICRS grid should be visible.
bool	getFlagShowICRSGridButton () const
	Get whether the button toggling ICRS grid is visible.
void	setFlagShowGalacticGridButton (bool b)
	Define whether the button toggling galactic grid should be visible.
bool	getFlagShowGalacticGridButton () const
	Get whether the button toggling galactic grid is visible.
void	setFlagShowEclipticGridButton (bool b)
	Define whether the button toggling ecliptic grid should be visible.
bool	getFlagShowEclipticGridButton () const
	Get whether the button toggling ecliptic grid is visible.
void	setFlagShowConstellationBoundariesButton (bool b)
	Define whether the button toggling constellation boundaries should be visible.
bool	getFlagShowConstellationBoundariesButton () const
	Get whether the button toggling constellation boundaries is visible.
bool	getAutoHideHorizontalButtonBar () const
	Get the auto-hide status of the horizontal toolbar.
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.
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
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.

Signals
void	visibleChanged (bool b)
void	autoHideHorizontalButtonBarChanged (bool b)
void	autoHideVerticalButtonBarChanged (bool b)
void	flagShowFlipButtonsChanged (bool b)
void	flagShowNebulaBackgroundButtonChanged (bool b)
void	flagShowToastSurveyButtonChanged (bool b)
void	flagShowBookmarksButtonChanged (bool b)
void	flagShowICRSGridButtonChanged (bool b)
void	flagShowGalacticGridButtonChanged (bool b)
void	flagShowEclipticGridButtonChanged (bool b)
void	flagShowConstellationBoundariesButtonChanged (bool b)

Public Member Functions
virtual void	init (QGraphicsWidget *topLevelGraphicsWidget)
	Initialize the StelGui object.
void	update ()
StelStyle	getStelStyle () const
void	loadStyle (const QString &fileName)
	Load a Qt style sheet to define the widgets style.
BottomStelBar *	getButtonBar () const
	Get the button bar at the bottom of the screen.
class LeftStelBar *	getWindowsButtonBar () const
	Get the button bar of the left of the screen.
class SkyGui *	getSkyGui () const
	Get the SkyGui instance (useful for adding other interface elements). More...
bool	initComplete (void) const
	returns true if the gui has completed init process.
virtual void	forceRefreshGui ()
	Used to force a refreshing of the GUI elements such as the button bars.
virtual void	setVisible (bool b)
	Show whether the GUI is visible. More...
virtual bool	getVisible () const
	Get the current visible status of the GUI.
virtual bool	getAstroCalcVisible ()
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.
virtual const StelObject::InfoStringGroup &	getInfoTextFilters () const
Public Member Functions inherited from StelGuiBase
virtual void	setStelStyle (const QString &section)=0
	Load color scheme matchin the section name.

Properties
bool	visible
bool	autoHideHorizontalButtonBar
bool	autoHideVerticalButtonBar
bool	flagShowFlipButtons
bool	flagShowNebulaBackgroundButton
bool	flagShowToastSurveyButton
bool	flagShowBookmarksButton
bool	flagShowICRSGridButton
bool	flagShowGalacticGridButton
bool	flagShowEclipticGridButton
bool	flagShowConstellationBoundariesButton

Friends
class	ViewDialog

Detailed Description

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

Member Function Documentation

class SkyGui* StelGui::getSkyGui

(

)

const

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

virtual bool StelGui::isCurrentlyUsed ( ) const

virtual

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

Implements StelGuiBase.

void StelGui::setAutoHideHorizontalButtonBar ( bool  b )

slot

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

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

virtual void StelGui::setVisible ( bool  b )

virtual

Parameters

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

Implements StelGuiBase.