Stellarium  23.4
Public Slots | Signals | Public Member Functions | Properties | Friends
StelGui Class Reference

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

#include <StelGui.hpp>

Public Slots

void setFlagUseButtonsBackground (bool b)
 Set the state of the flag of usage background for GUI buttons.
 
void setFlagUseKineticScrolling (bool b)
 Set the state of the flag for kinetic scrolling.
 
void setFlagEnableFocusOnDaySpinner (bool b)
 Set the state of the flag for enable focus on day spinner in Date and Time dialog.
 
void setFlagShowQuitButton (bool b)
 Define whether the button for exit should be visible.
 
void setFlagShowFlipButtons (bool b)
 Define whether the buttons toggling image flip should be visible.
 
void setFlagShowNebulaBackgroundButton (bool b)
 Define whether the button toggling nebulae background should be visible.
 
void setFlagShowDSSButton (bool b)
 Define whether the button toggling DSS survey (TOAST) should be visible.
 
void setFlagShowCardinalButton (bool b)
 Define whether the button toggling cardinal should be visible.
 
void setFlagShowCompassButton (bool b)
 Define whether the button toggling compass marks should be visible.
 
void setFlagShowHiPSButton (bool b)
 Define whether the button toggling HiPS surveys should be visible.
 
void setFlagShowGotoSelectedObjectButton (bool b)
 Define whether the button for centering on selected object should be visible. If not, user can still press SPACE to center.
 
void setFlagShowNightmodeButton (bool b)
 Define whether the button toggling nightmode should be visible in addition to the Ctrl+N hotkey.
 
void setFlagShowFullscreenButton (bool b)
 Define whether the button toggling fullscreen view should be visible in addition to F11 hotkey.
 
void setFlagShowObsListButton (bool b)
 Define whether the button toggling observing list should be visible.
 
void setFlagShowICRSGridButton (bool b)
 Define whether the button toggling ICRS grid should be visible.
 
void setFlagShowGalacticGridButton (bool b)
 Define whether the button toggling galactic grid should be visible.
 
void setFlagShowEclipticGridButton (bool b)
 Define whether the button toggling ecliptic grid should be visible.
 
void setFlagShowConstellationBoundariesButton (bool b)
 Define whether the button toggling constellation boundaries should be visible.
 
void setFlagShowAsterismLinesButton (bool b)
 Define whether the button toggling asterism lines should be visible.
 
void setFlagShowAsterismLabelsButton (bool b)
 Define whether the button toggling asterism labels should be visible.
 
void setAutoHideHorizontalButtonBar (bool b)
 Set the auto-hide status of the horizontal toolbar. More...
 
void setAutoHideVerticalButtonBar (bool b)
 Set the auto-hide status of the vertical toolbar. More...
 
void setGuiVisible (bool)
 Hide or show the GUI. Public so it can be called from scripts.
 
void displayAllInfo ()
 
void displayDefaultInfo ()
 
void displayShortInfo ()
 
void displayNoneInfo ()
 
void displayCustomInfo ()
 

Signals

void visibleChanged (bool b)
 
void autoHideHorizontalButtonBarChanged (bool b)
 
void autoHideVerticalButtonBarChanged (bool b)
 
void flagUseButtonsBackgroundChanged (bool b)
 
void flagUseKineticScrollingChanged (bool b)
 
void flagEnableFocusOnDaySpinnerChanged (bool b)
 
void flagShowQuitButtonChanged (bool b)
 
void flagShowFlipButtonsChanged (bool b)
 
void flagShowNebulaBackgroundButtonChanged (bool b)
 
void flagShowDSSButtonChanged (bool b)
 
void flagShowHiPSButtonChanged (bool b)
 
void flagShowGotoSelectedObjectButtonChanged (bool b)
 
void flagShowNightmodeButtonChanged (bool b)
 
void flagShowFullscreenButtonChanged (bool b)
 
void flagShowObsListButtonChanged (bool b)
 
void flagShowICRSGridButtonChanged (bool b)
 
void flagShowGalacticGridButtonChanged (bool b)
 
void flagShowEclipticGridButtonChanged (bool b)
 
void flagShowConstellationBoundariesButtonChanged (bool b)
 
void flagShowAsterismLinesButtonChanged (bool b)
 
void flagShowAsterismLabelsButtonChanged (bool b)
 
void flagShowCardinalButtonChanged (bool b)
 
void flagShowCompassButtonChanged (bool b)
 
void infoStringChanged ()
 
void guiStyleChanged (const QString &style)
 
void htmlStyleChanged (const QString &style)
 

Public Member Functions

void init (QGraphicsWidget *topLevelGraphicsWidget) override
 Initialize the StelGui object.
 
void update ()
 
StelStyle getStelStyle () const
 
BottomStelBargetButtonBar () const
 Get the button bar at the bottom of the screen.
 
class LeftStelBargetWindowsButtonBar () const
 Get the button bar of the left of the screen.
 
class SkyGuigetSkyGui () 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.
 
void forceRefreshGui () override
 Used to force a refreshing of the GUI elements such as the button bars.
 
void setVisible (bool b) override
 Show whether the GUI is visible. More...
 
bool getVisible () const override
 Get the current visible status of the GUI.
 
bool getAstroCalcVisible () const
 
bool isCurrentlyUsed () const override
 Show whether the Gui is currently used. More...
 
void setInfoTextFilters (const StelObject::InfoStringGroup &aflags) override
 Get a pointer on the info panel used to display selected object info.
 
const StelObject::InfoStringGroup & getInfoTextFilters () const override
 
bool getFlagUseButtonsBackground () const
 Get the state of the flag of usage background for GUI buttons.
 
bool getFlagUseKineticScrolling () const
 Get the state of the flag for kinetic scrolling.
 
bool getFlagEnableFocusOnDaySpinner () const
 Get the state of the flag for enable focus on day spinner in Date and Time dialog.
 
bool getFlagShowQuitButton () const
 Get whether the exit button is visible.
 
bool getFlagShowFlipButtons () const
 Get whether the buttons toggling image flip are visible.
 
bool getFlagShowNebulaBackgroundButton () const
 Get whether the button toggling nebulae background is visible.
 
bool getFlagShowDSSButton () const
 Get whether the button toggling DSS survey (TOAST) is visible.
 
bool getFlagShowCardinalButton () const
 Get whether the button toggling cardinal is visible.
 
bool getFlagShowCompassButton () const
 Get whether the button toggling compass marks is visible.
 
bool getFlagShowHiPSButton () const
 Get whether the button toggling HiPS surveys is visible.
 
bool getFlagShowGotoSelectedObjectButton () const
 Get whether the button for centering on selected object is visible.
 
bool getFlagShowNightmodeButton () const
 Get whether the button toggling nightmode is visible.
 
bool getFlagShowFullscreenButton () const
 Get whether the button toggling fullscreen view is visible.
 
bool getFlagShowObsListButton () const
 Get whether the button toggling observing list is visible.
 
bool getFlagShowICRSGridButton () const
 Get whether the button toggling ICRS grid is visible.
 
bool getFlagShowGalacticGridButton () const
 Get whether the button toggling galactic grid is visible.
 
bool getFlagShowEclipticGridButton () const
 Get whether the button toggling ecliptic grid is visible.
 
bool getFlagShowConstellationBoundariesButton () const
 Get whether the button toggling constellation boundaries is visible.
 
bool getFlagShowAsterismLinesButton () const
 Get whether the button toggling asterism lines is visible.
 
bool getFlagShowAsterismLabelsButton () const
 Get whether the button toggling asterism labels is visible.
 
bool getAutoHideHorizontalButtonBar () const
 Get the auto-hide status of the horizontal toolbar.
 
bool getAutoHideVerticalButtonBar () const
 Get the auto-hide status of the vertical toolbar.
 
- Public Member Functions inherited from StelGuiBase
virtual void setStelStyle (const QString &section)=0
 Load color scheme matching the section name.
 

Properties

bool visible
 
bool autoHideHorizontalButtonBar
 
bool autoHideVerticalButtonBar
 
bool flagShowQuitButton
 
bool flagShowFlipButtons
 
bool flagShowNebulaBackgroundButton
 
bool flagShowDSSButton
 
bool flagShowHiPSButton
 
bool flagShowGotoSelectedObjectButton
 
bool flagShowNightmodeButton
 
bool flagShowFullscreenButton
 
bool flagShowObsListButton
 
bool flagShowICRSGridButton
 
bool flagShowGalacticGridButton
 
bool flagShowEclipticGridButton
 
bool flagShowConstellationBoundariesButton
 
bool flagShowAsterismLinesButton
 
bool flagShowAsterismLabelsButton
 
bool flagUseButtonsBackground
 
bool flagUseKineticScrolling
 
bool flagEnableFocusOnDaySpinner
 
bool flagShowCardinalButton
 
bool flagShowCompassButton
 

Friends

class ViewDialog
 

Detailed Description

Main class for the GUI based on QGraphicView.

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

Member Function Documentation

◆ getSkyGui()

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

◆ isCurrentlyUsed()

bool StelGui::isCurrentlyUsed ( ) const
overridevirtual

Show whether the Gui is currently used.

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

Implements StelGuiBase.

◆ setAutoHideHorizontalButtonBar

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
bto hide or not to hide

◆ setAutoHideVerticalButtonBar

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
bto hide or not to hide

◆ setVisible()

void StelGui::setVisible ( bool  b)
overridevirtual

Show whether the GUI is visible.

Parameters
bwhen true, GUI will be shown, else it will be hidden.

Implements StelGuiBase.