Main class of the RemoteControl plug-in, implementing the StelModule interface. More...

#include <RemoteControl.hpp>

Inheritance diagram for RemoteControl:

Collaboration diagram for RemoteControl:

Public Slots
void	setFlagEnabled (bool b)
	Starts/stops the web server. More...

void	setFlagAutoStart (bool b)
	If true, the server is automatically started when init() is called. More...

void	setFlagUsePassword (bool b)
	If true, the password from setPassword() is required for all web requests. More...

void	setPassword (const QString &password)
	Sets the password that is optionally enabled with setFlagUsePassword(). More...

void	setPort (const int port)
	Sets the port where the server listens. More...

void	loadSettings ()
	Load the plug-in's settings from the configuration file. More...

void	saveSettings ()
	Save the plug-in's settings to the configuration file. More...

void	restoreDefaultSettings ()
	Restore the plug-in's settings to the default state. More...

void	startServer ()
	Starts the HTTP server using the current settings and begins handling requests. More...

void	stopServer ()
	Stops the HTTP server gracefully. More...

Signals
void	flagEnabledChanged (bool val)

void	flagAutoStartChanged (bool val)

void	flagUsePasswordChanged (bool val)

void	portChanged (int val)

void	passwordChanged (const QString &val)

Public Member Functions
virtual void	init ()
	Initialize itself. More...

virtual void	update (double deltaTime)
	Update the module with respect to the time. More...

virtual void	draw (StelCore *core)
	Execute all the drawing functions for this module. More...

virtual double	getCallOrder (StelModuleActionName actionName) const
	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 (QKeyEvent *event)
	Handle key events. More...

virtual bool	configureGui (bool show=true)
	Detect or show the configuration GUI elements for the module. More...

bool	getFlagEnabled () const

bool	getFlagAutoStart () const

bool	getFlagUsePassword () const

QString	getPassword () const

int	getPort () const

Public Member Functions inherited from StelModule
virtual void	deinit ()
	Called before the module will be delete, and before the openGL context is suppressed. More...

virtual QString	getModuleVersion () const
	Get the version of the module, default is stellarium main version. More...

virtual QString	getAuthorName () const
	Get the name of the module author. More...

virtual QString	getAuthorEmail () const
	Get the email adress of the module author. More...

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

Properties
bool	enabled
	Determines if the web server is running, and can be used to start/stop the server. More...

bool	autoStart
	If true, the server is automatically started when init() is called. More...

bool	usePassword
	If true, the password set with setPassword() is required for all requests. More...

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

Detailed Description

Main class of the RemoteControl plug-in, implementing the StelModule interface.

Manages the settings and the starting/stopping of the QtWebApp web server. The RequestHandler class is used for request processing.

Author: Florian Schaukowitsch

Definition at line 43 of file RemoteControl.hpp.

Member Function Documentation

virtual bool RemoteControl::configureGui ( bool show = true )

virtual

Detect or show the configuration GUI elements for the module.

This is to be used with plugins to display a configuration dialog from the plugin list window.

Parameters

show	if true, make the configuration GUI visible. If false, hide the config GUI if there is one.

Returns: true if the module has a configuration GUI, else false.

Reimplemented from StelModule.

virtual void RemoteControl::draw ( StelCore * core )

virtual

Execute all the drawing functions for this module.

Parameters

core	the core to use for the drawing

Reimplemented from StelModule.

virtual double RemoteControl::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.

virtual void RemoteControl::handleKeys ( QKeyEvent * e )

inlinevirtual

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.

Definition at line 72 of file RemoteControl.hpp.

virtual void RemoteControl::init ( )

virtual

Initialize itself.

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

Implements StelModule.

void RemoteControl::loadSettings ( )

slot

Load the plug-in's settings from the configuration file.

Settings are kept in the "RemoteControl" section in Stellarium's configuration file. If no such section exists, it will load default values.

See also: saveSettings(), restoreDefaultSettings()

void RemoteControl::restoreDefaultSettings ( )

slot

Restore the plug-in's settings to the default state.

Replace the plug-in's settings in Stellarium's configuration file with the default values and re-load them. Uses internally loadSettings() and saveSettings().

void RemoteControl::saveSettings ( )

slot

Save the plug-in's settings to the configuration file.

See also: loadSettings(), restoreDefaultSettings()

void RemoteControl::setFlagAutoStart ( bool b )

slot

If true, the server is automatically started when init() is called.

void RemoteControl::setFlagEnabled ( bool b )

slot

Starts/stops the web server.

void RemoteControl::setFlagUsePassword ( bool b )

slot

If true, the password from setPassword() is required for all web requests.

void RemoteControl::setPassword ( const QString & password )

slot

Sets the password that is optionally enabled with setFlagUsePassword().

The password is required by RequestHandler for all HTTP requests. Basic HTTP auth is used, without a user name.

void RemoteControl::setPort ( const int port )

slot

Sets the port where the server listens.

Must be done before startServer() is called, or restart the server to use the new setting.

void RemoteControl::startServer ( )

slot

Starts the HTTP server using the current settings and begins handling requests.

Uses the RequestHandler class for processing.

See also: RequestHandler

void RemoteControl::stopServer ( )

slot

Stops the HTTP server gracefully.

virtual void RemoteControl::update ( double deltaTime )

virtual

Update the module with respect to the time.

Parameters

deltaTime the time increment in second since last call.

Implements StelModule.

Property Documentation

bool RemoteControl::autoStart

readwrite

If true, the server is automatically started when init() is called.

Definition at line 55 of file RemoteControl.hpp.

bool RemoteControl::enabled

readwrite

Determines if the web server is running, and can be used to start/stop the server.

Definition at line 50 of file RemoteControl.hpp.

bool RemoteControl::usePassword

readwrite

If true, the password set with setPassword() is required for all requests.

The password is passed on to the RequestHandler.

Definition at line 61 of file RemoteControl.hpp.

The documentation for this class was generated from the following file:

/home/aw/devel/stellarium/0.15/plugins/RemoteControl/src/RemoteControl.hpp

Public Slots

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation