Base class for all notifications. More...

#include <Notification.h>

Inheritance diagram for Notifications::Notification:

Public Types
enum	Importance : quint8 { Info = 1<<1 , Info_Navigation = 1<<2 , Warning = 1<<3 , Warning_Navigation = 1<<4 , Alert = 1<<5 }
	Importance classification. More...

enum	TextBodyAction : quint8 { None , OpenMapsAndDataPage , OpenTrafficReceiverPage }
	Text body action. More...

Signals
void	button1TextChanged ()
	Notification signal.

void	button2TextChanged ()
	Notification signal.

void	reactionTimeChanged ()
	Notification signal.

void	spokenTextChanged ()
	Notification signal.

void	textChanged ()
	Notification signal.

void	textBodyActionChanged ()
	Notification signal.

Public Member Functions
	Notification (QString _title, Notifications::Notification::Importance _importance=Notifications::Notification::Info, QObject *parent=nullptr)
	Standard constructor.

	~Notification () override=default
	Standard destructor.

QString	button1Text () const
	Getter function for property of the same name.

QString	button2Text () const
	Getter function for property of the same name.

Notifications::Notification::Importance	importance () const
	Getter function for property of the same name.

Units::Timespan	reactionTime () const
	Getter function for property of the same name.

QString	spokenText () const
	Getter function for property of the same name.

QString	text () const
	Getter function for property of the same name.

Notifications::Notification::TextBodyAction	textBodyAction () const
	Getter function for property of the same name.

QString	title () const
	Getter function for property of the same name.

void	setButton1Text (const QString &newButton1Text)
	Setter function for property of the same name.

void	setButton2Text (const QString &newButton2Text)
	Setter function for property of the same name.

void	setReactionTime (Units::Timespan newReactionTime)
	Setter function for property of the same name.

void	setSpokenText (const QString &newSpokenText)
	Setter function for property of the same name.

void	setText (const QString &newText)
	Setter function for property of the same name.

void	setTextBodyAction (Notifications::Notification::TextBodyAction newTextBodyAction)
	Setter function for property of the same name.

virtual Q_INVOKABLE void	onButton1Clicked ()
	Mouse click handler.

virtual Q_INVOKABLE void	onButton2Clicked ()
	Mouse click handler.

Properties
QString	button1Text
	Text for first button.

QString	button2Text
	Text for second button.

Notifications::Notification::Importance	importance
	Importance of the notification.

Units::Timespan	reactionTime
	Time left to avert negative consequences.

QString	spokenText
	Spoken text message for the notification.

QString	text
	Text body of the notification.

Notifications::Notification::TextBodyAction	textBodyAction
	Text body action.

QString	title
	Title of the notification.

Detailed Description

Base class for all notifications.

This is the base class for all notifications. This notifications sets button1Text to "Dismiss", button2Text to "Empty" and reacts to clicks with a deleteLater(). More elaborate notifications can inherit from this class and re-implement some of the virtual methods.

Note: Instance of this class may safely call deleteLater() at any time to indicate that the notification is no longer relevant.

Definition at line 43 of file Notification.h.

Member Enumeration Documentation

◆ Importance

enum Notifications::Notification::Importance : quint8

Importance classification.

Enumerator
Info	Generic information, "Map updates available".
Info_Navigation	Information pertaining to navigation, "Top of descent reached".
Warning	Generic warning, "Traffic data receiver inop".
Warning_Navigation	Serious warning, "Prohibited Airspace 1 minutes ahead".
Alert	Alert. Immediate action is required to avoid accident or serious rule infringion.

Definition at line 50 of file Notification.h.

◆ TextBodyAction

enum Notifications::Notification::TextBodyAction : quint8

Text body action.

Describes the action that the GUI should take then the text body of this notification is clicked.

Enumerator
None	No action.
OpenMapsAndDataPage	Open the page 'maps and data'.
OpenTrafficReceiverPage	Open the page 'traffic receiver'.

Definition at line 64 of file Notification.h.

Constructor & Destructor Documentation

◆ Notification()

Notifications::Notification::Notification	(	QString	_title,
		Notifications::Notification::Importance	_importance = Notifications::Notification::Info,
		QObject *	parent = nullptr )

explicit

Standard constructor.

The constructor sets a time that calls deleteLater() after five minutes. This way, notifications are never shown permanently.

Parameters

_title	Notification title
_importance	Notification importance
parent	The standard QObject parent pointer

Member Function Documentation

◆ button1Text()

QString Notifications::Notification::button1Text ( ) const

inlinenodiscard

Getter function for property of the same name.

Returns: Property button1Text

Definition at line 172 of file Notification.h.

◆ button2Text()

QString Notifications::Notification::button2Text ( ) const

inlinenodiscard

Getter function for property of the same name.

Returns: Property button1Text

Definition at line 178 of file Notification.h.

◆ importance()

Notifications::Notification::Importance Notifications::Notification::importance ( ) const

inlinenodiscard

Getter function for property of the same name.

Returns: Property importance

Definition at line 184 of file Notification.h.

◆ onButton1Clicked()

virtual Q_INVOKABLE void Notifications::Notification::onButton1Clicked ( )

virtual

Mouse click handler.

This method is called whenever the user clicks on the first button in the GUI representation of this notification. This implementation calls deleteLater(). Reimplement this method for proper reaction to GUI events.

◆ onButton2Clicked()

virtual Q_INVOKABLE void Notifications::Notification::onButton2Clicked ( )

virtual

Mouse click handler.

This method is called whenever the user clicks on the first button in the GUI representation of this notification. This implementation calls deleteLater(). Reimplement this method for proper reaction to GUI events.

◆ reactionTime()

Units::Timespan Notifications::Notification::reactionTime ( ) const

inlinenodiscard

Getter function for property of the same name.

Returns: Property reactionTime

Definition at line 190 of file Notification.h.

◆ setButton1Text()

void Notifications::Notification::setButton1Text ( const QString & newButton1Text )

Setter function for property of the same name.

Parameters

newButton1Text Property button1Text

◆ setButton2Text()

void Notifications::Notification::setButton2Text ( const QString & newButton2Text )

Setter function for property of the same name.

Parameters

newButton2Text Property button1Text

◆ setReactionTime()

void Notifications::Notification::setReactionTime ( Units::Timespan newReactionTime )

Setter function for property of the same name.

Parameters

newReactionTime Property reactionTime

◆ setSpokenText()

void Notifications::Notification::setSpokenText ( const QString & newSpokenText )

Setter function for property of the same name.

Parameters

newSpokenText Property reactionTime

◆ setText()

void Notifications::Notification::setText ( const QString & newText )

Setter function for property of the same name.

Parameters

newText Property text

◆ setTextBodyAction()

void Notifications::Notification::setTextBodyAction ( Notifications::Notification::TextBodyAction newTextBodyAction )

Setter function for property of the same name.

Parameters

newTextBodyAction Property textBodyAction

◆ spokenText()

QString Notifications::Notification::spokenText ( ) const

nodiscard

Getter function for property of the same name.

Returns: Property spokenText

◆ text()

QString Notifications::Notification::text ( ) const

inlinenodiscard

Getter function for property of the same name.

Returns: Property text

Definition at line 202 of file Notification.h.

◆ textBodyAction()

Notifications::Notification::TextBodyAction Notifications::Notification::textBodyAction ( ) const

inlinenodiscard

Getter function for property of the same name.

Returns: Property textBodyAction

Definition at line 208 of file Notification.h.

◆ title()

QString Notifications::Notification::title ( ) const

inlinenodiscard

Getter function for property of the same name.

Returns: Property title

Definition at line 214 of file Notification.h.

Property Documentation

◆ button1Text

QString Notifications::Notification::button1Text

readwrite

Text for first button.

This is the text string for the first button in the notification GUI. If empty, the button is invisible. The importance is initialized with an empty string.

Definition at line 109 of file Notification.h.

◆ button2Text

QString Notifications::Notification::button2Text

readwrite

Text for second button.

This is the text string for the second button in the notification GUI. If empty, the button is invisible. The importance is initialized with an empty string.

Definition at line 117 of file Notification.h.

◆ importance

Notifications::Notification::Importance Notifications::Notification::importance

read

Importance of the notification.

The importance is used to choose the notification that is most relevant to the pilot. The importance is initialized with "Info".

Definition at line 124 of file Notification.h.

◆ reactionTime

Units::Timespan Notifications::Notification::reactionTime

readwrite

Time left to avert negative consequences.

This property holds the time that the pilot has in order to avert potential negative consequences. This data is used to choose the notification that is most relevant to the pilot. The importance is initialized with qNaN.

Definition at line 133 of file Notification.h.

◆ spokenText

QString Notifications::Notification::spokenText

readwrite

Spoken text message for the notification.

This property holds a text announcement which is spoken. When set to empty, a message is generated from the title and text properties. This property is initialized with an empty string

Definition at line 141 of file Notification.h.

◆ text

QString Notifications::Notification::text

readwrite

Text body of the notification.

This property holds the text body, which can be empty.

Definition at line 147 of file Notification.h.

◆ textBodyAction

Notifications::Notification::TextBodyAction Notifications::Notification::textBodyAction

readwrite

Text body action.

This property describes the action the that GUI should take when the text body is clicked. This property is initialized to 'None'.

Definition at line 154 of file Notification.h.

◆ title

QString Notifications::Notification::title

read

Title of the notification.

This property holds the title, which should never be empty. This property is initialized with an enbarrassing placeholder string.

Definition at line 161 of file Notification.h.

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

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

Public Types

Signals

Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ Importance

◆ TextBodyAction

Constructor & Destructor Documentation

◆ Notification()

Member Function Documentation

◆ button1Text()

◆ button2Text()

◆ importance()

◆ onButton1Clicked()

◆ onButton2Clicked()

◆ reactionTime()

◆ setButton1Text()

◆ setButton2Text()

◆ setReactionTime()

◆ setSpokenText()

◆ setText()

◆ setTextBodyAction()

◆ spokenText()

◆ text()

◆ textBodyAction()

◆ title()

Property Documentation

◆ button1Text

◆ button2Text

◆ importance

◆ reactionTime

◆ spokenText

◆ text

◆ textBodyAction

◆ title