TextUserInterface Class Reference

The Text User Interface (TUI) plugin replaces the old (pre-0.10 series) text user interface. More...

#include <TextUserInterface.hpp>

Public Slots
void	setTuiMenuActive (bool tActive)
	Show/hide the TUI menu.
void	setTuiDateTime (bool tDateTime)
	Show/hide the TUI date time display.
bool	getTuiDateTime ()
void	setTuiObjInfo (bool tObjInfo)
	Show/hide the selected object's short object information.
bool	getTuiObjInfo ()
void	setTuiGravityUi (bool tGravityUi)
	Set Gravity text for the TUI text.
void	setLightPollutionLevel (int level)
	Set light pollution level.

Signals
void	flagShowDateTimeChanged (bool)
void	flagShowObjInfoChanged (bool)

Public Member Functions
virtual void	init () Q_DECL_OVERRIDE
	Initialize itself. More...
virtual void	draw (StelCore *core) Q_DECL_OVERRIDE
	Execute all the drawing functions for this module. More...
virtual double	getCallOrder (StelModuleActionName actionName) const Q_DECL_OVERRIDE
	Return the value defining the order of call for the given action For example if stars.callOrder[ActionDraw] == 10 and constellation.callOrder[ActionDraw] == 11, the stars module will be drawn before the constellations. More...
virtual void	handleKeys (class QKeyEvent *event) Q_DECL_OVERRIDE
	Handle key events. More...
void	loadConfiguration (void)
	Loads the module's configuration from the config file.
Public Member Functions inherited from StelModule
	StelModule ()
	Constructor. Every derived class MUST call setObjectName(className) in its constructor.
virtual void	deinit ()
	Called before the module will be deleted, and before the OpenGL context is suppressed. More...
virtual QSettings *	getSettings ()
	Return module-specific settings. More...
virtual void	update (double deltaTime)
	Update the module with respect to the time. More...
virtual QString	getModuleVersion () const
	Get the version of the module, default is stellarium main version.
virtual QString	getAuthorName () const
	Get the name of the module author.
virtual QString	getAuthorEmail () const
	Get the email address of the module author.
virtual void	handleMouseClicks (class QMouseEvent *)
	Handle mouse clicks. More...
virtual void	handleMouseWheel (class QWheelEvent *)
	Handle mouse wheel. More...
virtual bool	handleMouseMoves (int x, int y, Qt::MouseButtons b)
	Handle mouse moves. More...
virtual bool	handlePinch (qreal scale, bool started)
	Handle pinch gesture events. More...
virtual bool	configureGui (bool show=true)
	Detect or show the configuration GUI elements for the module. More...

Properties
bool	tuiDateTime
bool	tuiObjInfo

Additional Inherited Members
Public Types inherited from StelModule
enum	StelModuleSelectAction { AddToSelection , ReplaceSelection , RemoveFromSelection }
	Enum used when selecting objects to define whether to add to, replace, or remove from the existing selection list. More...
enum	StelModuleActionName {   ActionDraw , ActionUpdate , ActionHandleMouseClicks , ActionHandleMouseMoves ,   ActionHandleKeys }
	Define the possible action for which an order is defined. More...
Protected Member Functions inherited from StelModule
class StelAction *	addAction (const QString &id, const QString &groupId, const QString &text, QObject *target, const char *slot, const QString &shortcut="", const QString &altShortcut="")
	convenience methods to add an action (call to slot) to the StelActionMgr object. More...
class StelAction *	addAction (const QString &id, const QString &groupId, const QString &text, const char *slot, const QString &shortcut="", const QString &altShortcut="")
	convenience methods to add an action (call to own slot) to the StelActionMgr object. More...
StelAction *	addAction (const QString &id, const QString &groupId, const QString &text, QObject *contextObject, std::function< void()> lambda, const QString &shortcut="", const QString &altShortcut="")
	convenience methods to add an action (call to Lambda functor) to the StelActionMgr object. More...

Detailed Description

The Text User Interface (TUI) plugin replaces the old (pre-0.10 series) text user interface.

It used to be activated with M until the 0.14 series, but was changed to Alt-T for 0.15 and later (to be consistent with the Ctrl-T hiding of the GUI).

Member Function Documentation

draw()

virtual void TextUserInterface::draw ( StelCore *  core )

virtual

Execute all the drawing functions for this module.

Parameters

core	the core to use for the drawing

Reimplemented from StelModule.

getCallOrder()

virtual double TextUserInterface::getCallOrder ( StelModuleActionName  actionName ) const

virtual

Return the value defining the order of call for the given action For example if stars.callOrder[ActionDraw] == 10 and constellation.callOrder[ActionDraw] == 11, the stars module will be drawn before the constellations.

Parameters

actionName

the name of the action for which we want the call order

Returns

the value defining the order. The closer to 0 the earlier the module's action will be called

Reimplemented from StelModule.

handleKeys()

virtual void TextUserInterface::handleKeys ( class QKeyEvent *  e )

virtual

Handle key events.

Please note that most of the interactions will be done through the GUI module.

Parameters

e	the Key event

Returns

set the event as accepted if it was intercepted

Reimplemented from StelModule.

init()

virtual void TextUserInterface::init ( )

virtual

Initialize itself.

If the initialization takes significant time, the progress should be displayed on the loading bar.

Implements StelModule.