Serial Studio 1.1.6
A dashboard software for your embedded projects
Misc::ModuleManager Class Reference

The ModuleManager class. More...

#include <ModuleManager.h>

Inheritance diagram for Misc::ModuleManager:
Inheritance graph
Collaboration diagram for Misc::ModuleManager:
Collaboration graph

Public Slots

void onQuit ()
 
void hideSplashscreen ()
 

Public Member Functions

 ModuleManager ()
 
void configureUpdater ()
 
void registerQmlTypes ()
 
bool autoUpdaterEnabled ()
 
void initializeQmlInterface ()
 
QQmlApplicationEngine * engine ()
 

Private Attributes

QSplashScreen m_splash
 
QQmlApplicationEngine m_engine
 

Detailed Description

The ModuleManager class.

The ModuleManager class is in charge of initializing all the C++ modules that are part of Serial Studio in the correct order.

Also, the class configures the QML rendering engine during application startup and displays a splash screen to entretain the user while the user interface is loaded.

Constructor & Destructor Documentation

◆ ModuleManager()

Misc::ModuleManager::ModuleManager ( )

Configures the application font, creates a splash screen and configures application signals/slots to destroy singleton classes before the application quits.

Member Function Documentation

◆ autoUpdaterEnabled()

bool Misc::ModuleManager::autoUpdaterEnabled ( )

Enables or disables the auto-updater system (QSimpleUpdater).

To disable QSimpleUpdater, you need to add DEFINES += DISABLE_QSU in the qmake project file. This option is provided for package managers, users are expected to update the application using the same package manager they used for installing it.

◆ configureUpdater()

void Misc::ModuleManager::configureUpdater ( )

Sets the default options for QSimpleUpdater, which are:

  • Notify user when a new update is found
  • Do not notify user when we finish checking for updates
  • Do not close application if update is found

◆ engine()

QQmlApplicationEngine * Misc::ModuleManager::engine ( )

Returns a pointer to the QML application engine

◆ hideSplashscreen

void Misc::ModuleManager::hideSplashscreen ( )
slot

Hides the splash screen widget

◆ initializeQmlInterface()

void Misc::ModuleManager::initializeQmlInterface ( )

Initializes all the application modules, registers them with the QML engine and loads the "main.qml" file as the root QML file.

◆ onQuit

void Misc::ModuleManager::onQuit ( )
slot

Calls the functions needed to safely quit the application

◆ registerQmlTypes()

void Misc::ModuleManager::registerQmlTypes ( )

Register custom QML types, for the moment, we have:

Member Data Documentation

◆ m_engine

QQmlApplicationEngine Misc::ModuleManager::m_engine
private

◆ m_splash

QSplashScreen Misc::ModuleManager::m_splash
private

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