Stellarium 0.13.2
List of all members | Public Types | Public Slots | Signals | Public Member Functions | Protected Member Functions | Protected Attributes
HelpDialog Class Reference

Public Types

enum  UpdateState {
  Updating, CompleteNoUpdates, CompleteUpdates, DownloadError,
  OtherError
}
 Used for keeping for track of the download/update status. More...
 

Public Slots

void retranslate ()
 
void updateJSON (void)
 Download JSON from web recources described in the module section of the module.ini file and update the local JSON file. More...
 
- Public Slots inherited from StelDialog
virtual void retranslate ()=0
 Retranslate the content of the dialog. More...
 
void setVisible (bool)
 On the first call with "true" populates the window contents. More...
 
void close ()
 Closes the window (the window widget is not deleted, just not visible). More...
 

Signals

void updateStateChanged (HelpDialog::UpdateState state)
 
- Signals inherited from StelDialog
void visibleChanged (bool)
 

Public Member Functions

 HelpDialog (QObject *parent)
 
void styleChanged ()
 Notify that the application style changed. More...
 
bool getUpdatesEnabled (void)
 get whether or not the plugin will try to update data from the internet More...
 
void setUpdatesEnabled (bool b)
 set whether or not the plugin will try to update data from the internet More...
 
UpdateState getUpdateState (void)
 Get the current updateState. More...
 
QString getLatestVersionFromJson (void)
 Get the version from the "latestVersion" value in the updates.json file. More...
 
int getRequiredOpenGLVersionFromJson (void)
 
void setUpdatesMessage (bool hasUpdates, QString version="", int OpenGL=0)
 
QString getUpdatesMessage ()
 
- Public Member Functions inherited from StelDialog
 StelDialog (QObject *parent=NULL)
 
bool visible () const
 

Protected Member Functions

virtual void createDialogContent ()
 Initialize the dialog widgets and connect the signals/slots. More...
 

Protected Attributes

Ui_helpDialogForm * ui
 
- Protected Attributes inherited from StelDialog
QWidget * dialog
 The main dialog. More...
 
class CustomProxy * proxy
 

Additional Inherited Members

- Properties inherited from StelDialog
bool visible
 

Detailed Description

Definition at line 34 of file HelpDialog.hpp.

Member Enumeration Documentation

Used for keeping for track of the download/update status.

Enumerator
Updating 

Update in progress.

CompleteNoUpdates 

Update completed, there we no updates.

CompleteUpdates 

Update completed, there were updates.

DownloadError 

Error during download phase.

OtherError 

Other error.

Definition at line 40 of file HelpDialog.hpp.

Member Function Documentation

virtual void HelpDialog::createDialogContent ( )
protectedvirtual

Initialize the dialog widgets and connect the signals/slots.

Implements StelDialog.

QString HelpDialog::getLatestVersionFromJson ( void  )

Get the version from the "latestVersion" value in the updates.json file.

Returns
version string, e.g. "0.12.4"
bool HelpDialog::getUpdatesEnabled ( void  )
inline

get whether or not the plugin will try to update data from the internet

Returns
true if updates are set to be done, false otherwise

Definition at line 56 of file HelpDialog.hpp.

UpdateState HelpDialog::getUpdateState ( void  )
inline

Get the current updateState.

Definition at line 61 of file HelpDialog.hpp.

void HelpDialog::setUpdatesEnabled ( bool  b)
inline

set whether or not the plugin will try to update data from the internet

Parameters
bif true, updates will be enabled, else they will be disabled

Definition at line 59 of file HelpDialog.hpp.

void HelpDialog::styleChanged ( )

Notify that the application style changed.

void HelpDialog::updateJSON ( void  )
slot

Download JSON from web recources described in the module section of the module.ini file and update the local JSON file.

void HelpDialog::updateStateChanged ( HelpDialog::UpdateState  state)
signal
Parameters
statethe new update state.

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