This class manages notifications and presents them to the GUI. More...

#include <NotificationManager.h>

Inheritance diagram for Notifications::NotificationManager:

Signals
void	currentVisualNotificationChanged ()
	Notification signal.

void	speakerChanged ()
	Notification signal.

void	toastPosted (QString text)
	Indicates that the GUI should show a toast.

Public Member Functions
	NotificationManager (QObject *parent=nullptr)
	Standard constructor.

void	deferredInitialization () override
	Non-constructor initialization.

	~NotificationManager () override=default
	Standard destructor.

Notifications::Notification *	currentVisualNotification () const
	Getter function for property of the same name.

QTextToSpeech *	speaker () const
	Getter function for property of the same name.

Q_INVOKABLE void	addTestNotification ()
	Issue test notification.

Q_INVOKABLE void	voiceTest ()
	Voice test.

void	waitForSpeechEngine ()
	Wait until speech engine is fully constructed.

Public Member Functions inherited from GlobalObject
	GlobalObject (QObject *parent=nullptr)
	Standard constructor.

	~GlobalObject () override=default
	Standard deconstructor.

Properties
Notifications::Notification *	currentVisualNotification
	Most important notification to be shown in the GUI.

QTextToSpeech *	speaker
	Pointer to QTextToSpeech.

Additional Inherited Members
Static Public Member Functions inherited from GlobalObject
static void	clear ()
	Deletes all globally defined objects.

static Q_INVOKABLE bool	canConstruct ()
	Indicates if the static methods are ready to be used.

static Q_INVOKABLE Navigation::Clock *	clock ()
	Pointer to appplication-wide static Navigation::Clock instance.

static Q_INVOKABLE DataManagement::DataManager *	dataManager ()
	Pointer to appplication-wide static GeoMaps::DataManager instance.

static Q_INVOKABLE DemoRunner *	demoRunner ()
	Pointer to appplication-wide static DemoRunner instance.

static Q_INVOKABLE Traffic::FlarmnetDB *	flarmnetDB ()
	Pointer to appplication-wide static FlarmnetDB instance.

static Q_INVOKABLE Platform::FileExchange_Abstract *	fileExchange ()
	Pointer to appplication-wide static FileExchange instance.

static Q_INVOKABLE GeoMaps::GeoMapProvider *	geoMapProvider ()
	Pointer to appplication-wide static GeoMaps::GeoMapProvider instance.

static Q_INVOKABLE GlobalSettings *	globalSettings ()
	Pointer to appplication-wide static Settings instance.

static Q_INVOKABLE Librarian *	librarian ()
	Pointer to appplication-wide static librarian instance.

static Q_INVOKABLE Platform::PlatformAdaptor_Abstract *	platformAdaptor ()
	Pointer to appplication-wide static PlatformAdaptor instance.

static Q_INVOKABLE Sensors *	sensors ()
	Pointer to appplication-wide static Navigation::Clock instance.

static Q_INVOKABLE Navigation::Navigator *	navigator ()
	Pointer to appplication-wide static Navigation::Navigator instance.

static Q_INVOKABLE Traffic::PasswordDB *	passwordDB ()
	Pointer to appplication-wide static PasswordDB instance.

static Q_INVOKABLE Positioning::PositionProvider *	positionProvider ()
	Pointer to appplication-wide static PositionProvider instance.

static Q_INVOKABLE NOTAM::NOTAMProvider *	notamProvider ()
	Pointer to appplication-wide static notification manager instance.

static Q_INVOKABLE Notifications::NotificationManager *	notificationManager ()
	Pointer to appplication-wide static notification manager instance.

static Q_INVOKABLE QNetworkAccessManager *	networkAccessManager ()
	Pointer to appplication-wide static QNetworkAccessManager instance.

static Q_INVOKABLE DataManagement::SSLErrorHandler *	sslErrorHandler ()
	Pointer to appplication-wide static QNetworkAccessManager instance.

static Q_INVOKABLE Traffic::TrafficDataProvider *	trafficDataProvider ()
	Pointer to appplication-wide static TrafficDataProvider instance.

static Q_INVOKABLE GeoMaps::WaypointLibrary *	waypointLibrary ()
	Pointer to appplication-wide static WaypointLibrary instance.

static Q_INVOKABLE Weather::WeatherDataProvider *	weatherDataProvider ()
	Pointer to appplication-wide static WeatherDataProvider instance.

Detailed Description

This class manages notifications and presents them to the GUI.

This class manages notifications. It watches the global objects in the app, creates notifications, sorts them according to importance, and presents the most important notification to the GUI.

Definition at line 41 of file NotificationManager.h.

Constructor & Destructor Documentation

◆ NotificationManager()

Notifications::NotificationManager::NotificationManager ( QObject * parent = nullptr )

explicit

Standard constructor.

Parameters

parent The standard QObject parent pointer

Member Function Documentation

◆ currentVisualNotification()

Notifications::Notification * Notifications::NotificationManager::currentVisualNotification ( ) const

nodiscard

Getter function for property of the same name.

Returns: Property currentNotification

◆ deferredInitialization()

void Notifications::NotificationManager::deferredInitialization ( )

overridevirtual

Non-constructor initialization.

This method is called by the static methods that create global instances immediately after the constructor returns. This class can be re-implemented to perform initialization steps that refer to other singleton objects.

Reimplemented from GlobalObject.

◆ speaker()

QTextToSpeech * Notifications::NotificationManager::speaker ( ) const

inlinenodiscard

Getter function for property of the same name.

Returns: Property speaker

Definition at line 114 of file NotificationManager.h.

Property Documentation

◆ currentVisualNotification

Notifications::Notification* Notifications::NotificationManager::currentVisualNotification

read

Most important notification to be shown in the GUI.

This property holds the most important notification, or nullptr if there is no notification. The notifications are owned by this NotificationManager and have ownership set to QQmlEngine::CppOwnership.

Note: The notification objects returned here can be deleted anytime, so it is wise to store the result in a QPointer that tracks deletion.

Definition at line 87 of file NotificationManager.h.

◆ speaker

QTextToSpeech* Notifications::NotificationManager::speaker

read

Pointer to QTextToSpeech.

This property holds a pointer to the text-to-speech engine. Until the engine is initialized, the property holds a nullptr.

Note: The objects returned here is owned by C++ and can be deleted anytime, so it is wise to store the result in a QPointer that tracks deletion.

Definition at line 97 of file NotificationManager.h.

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

/home/runner/work/enroute/enroute/src/notification/NotificationManager.h

Signals

Public Member Functions

Properties

Additional Inherited Members