StelGuiBase Class Reference

Abstract class defining the base interface for all GUIs. More...

#include <StelGuiBase.hpp>

List of all members.

Public Member Functions
virtual void	init (QGraphicsWidget *topLevelGraphicsWidget, class StelAppGraphicsWidget *stelAppGraphicsWidget)
virtual void	setStelStyle (const QString &section)=0
	Load color scheme matchin the section name.
virtual void	setInfoTextFilters (const StelObject::InfoStringGroup &aflags)=0
	Get a pointer on the info panel used to display selected object info.
virtual const StelObject::InfoStringGroup &	getInfoTextFilters () const =0
virtual class QProgressBar *	addProgressBar ()=0
	Add a new progress bar in the lower right corner of the screen.
virtual QAction *	addGuiActions (const QString &actionName, const QString &text, const QString &shortCut, const QString &helpGroup, bool checkable=true, bool autoRepeat=false, bool global=false)
	Add a new action managed by the GUI.
virtual QAction *	getGuiActions (const QString &actionName)
	Get a pointer on an action managed by the GUI.
virtual void	forceRefreshGui ()
virtual void	setVisible (bool b)=0
	Show whether the GUI is visible.
virtual bool	getVisible () const =0
	Get the current visible status of the GUI.
virtual bool	isCurrentlyUsed () const =0
	Show wether the Gui is currently used.
Protected Member Functions
void	updateI18n ()
	Translate all texts to the new Locale.
Protected Attributes
class StelAppGraphicsWidget *	stelAppGraphicsWidget

---

Detailed Description

Abstract class defining the base interface for all GUIs.

---

Member Function Documentation

virtual QAction* StelGuiBase::addGuiActions	(	const QString &	actionName,
		const QString &	text,
		const QString &	shortCut,
		const QString &	helpGroup,
		bool	checkable = true,
		bool	autoRepeat = false,
		bool	global = 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
	global	whether the action should be global (affect in dialogs)

Reimplemented in StelGui.

virtual class QProgressBar* StelGuiBase::addProgressBar

(

)

[pure virtual]

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

When the progress bar is deleted the layout is automatically rearranged.

Returns:

a pointer to the progress bar.

Implemented in StelGui, and StelNoGui.

virtual QAction* StelGuiBase::getGuiActions

(

const QString &

actionName

)

[virtual]

Get a pointer on an action managed by the GUI.

Parameters:

actionName

qt object name for this action

Returns:

a pointer on the QAction object or NULL if don't exist

Reimplemented in StelNoGui.

virtual bool StelGuiBase::getVisible

(

)

const [pure virtual]

Get the current visible status of the GUI.

Implemented in StelGui, and StelNoGui.

virtual bool StelGuiBase::isCurrentlyUsed

(

)

const [pure virtual]

Show wether the Gui is currently used.

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

Implemented in StelGui, and StelNoGui.

virtual void StelGuiBase::setInfoTextFilters

(

const StelObject::InfoStringGroup &

aflags

)

[pure virtual]

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

Implemented in StelGui, and StelNoGui.

virtual void StelGuiBase::setStelStyle

(

const QString &

section

)

[pure virtual]

Load color scheme matchin the section name.

Implemented in StelNoGui.

virtual void StelGuiBase::setVisible

(

bool

b

)

[pure virtual]

Show whether the GUI is visible.

Parameters:

b

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

Implemented in StelGui, and StelNoGui.

void StelGuiBase::updateI18n

(

)

[protected]

Translate all texts to the new Locale.

Reimplemented in StelNoGui.