Home · All Namespaces · All Classes · Functions · Coding Style · Scripting · Plugins · File Structure

StelGui Class Reference

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

#include <StelGui.hpp>

Inherits StelGuiBase.

List of all members.

Public Slots

void setFlagShowFlipButtons (bool b)
void setFlagShowNebulaBackgroundButton (bool b)
bool getAutoHideHorizontalButtonBar () const
void setAutoHideHorizontalButtonBar (bool b)
bool getAutoHideVerticalButtonBar () const
void setAutoHideVerticalButtonBar (bool b)
void setScriptKeys (bool b)
void increaseScriptSpeed ()
void decreaseScriptSpeed ()
void setRealScriptSpeed ()
void setGuiVisible (bool)

Public Member Functions

virtual void init (QGraphicsWidget *topLevelGraphicsWidget, StelAppGraphicsWidget *stelAppGraphicsWidget)
void update ()
virtual void updateI18n ()
virtual void setStelStyle (const StelStyle &style)
void loadStyle (const QString &fileName)
class QProgressBar * addProgressBar ()
BottomStelBar * getButtonBar ()
class LeftStelBar * getWindowsButtonBar ()
bool getFlagShowFlipButtons ()
bool getFlagShowNebulaBackgroundButton ()
bool initComplete (void)
virtual void forceRefreshGui ()
virtual void setVisible (bool b)
virtual bool getVisible () const
virtual bool isCurrentlyUsed () const
virtual void setInfoTextFilters (const StelObject::InfoStringGroup &aflags)
virtual const
StelObject::InfoStringGroup
getInfoTextFilters () const
virtual QAction * addGuiActions (const QString &actionName, const QString &text, const QString &shortCut, const QString &helpGroup, bool checkable=true, bool autoRepeat=false)


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.


Member Function Documentation

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

Initialize the StelGui object.

Reimplemented from StelGuiBase.

virtual void StelGui::updateI18n (  )  [virtual]

Translate all texts to the new Locale.

Reimplemented from StelGuiBase.

virtual void StelGui::setStelStyle ( const StelStyle style  )  [virtual]

Load color scheme from the given ini file and section name.

Implements StelGuiBase.

void StelGui::loadStyle ( const QString &  fileName  ) 

Load a Qt style sheet to define the widgets style.

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.

BottomStelBar* StelGui::getButtonBar (  ) 

Get the button bar at the bottom of the screen.

class LeftStelBar* StelGui::getWindowsButtonBar (  ) 

Get the button bar of the left of the screen.

bool StelGui::getFlagShowFlipButtons (  )  [inline]

Get whether the buttons toggling image flip are visible.

bool StelGui::getFlagShowNebulaBackgroundButton (  )  [inline]

Get whether the button toggling nebulae background is visible.

bool StelGui::initComplete ( void   )  [inline]

returns true if the gui has complted init process.

virtual void StelGui::forceRefreshGui (  )  [virtual]

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

Reimplemented from StelGuiBase.

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.

virtual bool StelGui::getVisible (  )  const [virtual]

Get the current visible status of the GUI.

Implements StelGuiBase.

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.

virtual void StelGui::setInfoTextFilters ( const StelObject::InfoStringGroup aflags  )  [virtual]

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

Implements StelGuiBase.

virtual QAction* StelGui::addGuiActions ( const QString &  actionName,
const QString &  text,
const QString &  shortCut,
const QString &  helpGroup,
bool  checkable = true,
bool  autoRepeat = false 
) [virtual]

Add a new action managed by the GUI.

This method should be used to add new shortcuts to the program

Parameters:
actionName qt object name. Used as a reference for later uses
text the text to display when hovering, or in the help window
shortCut the qt shortcut to use
helpGroup hint on how to group the text in the help window
checkable whether the action should be checkable
autoRepeat whether the action should be autorepeated

Reimplemented from StelGuiBase.

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.

bool StelGui::getAutoHideHorizontalButtonBar (  )  const [slot]

Get the auto-hide status of the horizontal toolbar.

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

bool StelGui::getAutoHideVerticalButtonBar (  )  const [slot]

Get the auto-hide status of the vertical toolbar.

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::setScriptKeys ( bool  b  )  [slot]

change keys when a script is running / not running

void StelGui::setGuiVisible ( bool   )  [slot]

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


Generated on Mon Mar 22 09:55:38 2010 for Stellarium by  doxygen 1.5.5