Notification. More...

#include <cutehmi/Notification.hpp>

Inheritance diagram for cutehmi::Notification:

Public Types
enum	Type { INFO = 1, WARNING = 2, CRITICAL = 3 }

Signals
void	typeChanged ()
	Type changed signal. More...

void	textChanged ()
	Text changed signal. More...

Public Member Functions
	Notification (const QString &text=QString(), Type type=INFO, QObject *parnt=nullptr)
	Default constructor. More...

	Notification (Type type, const QString &text=QString(), QObject *parent=nullptr)
	Constructor. More...

Type	type () const
	Get type. More...

void	setType (Type type)
	Set type. More...

QString	text () const
	Get text. More...

void	setText (const QString &text)
	Set text. More...

const QDateTime &	dateTime () const
	Get date. More...

std::unique_ptr< Notification >	clone () const
	Cone notification. More...

Public Member Functions inherited from QObject
virtual const QMetaObject *	metaObject () const const

virtual void *	qt_metacast (const char *)

virtual int	qt_metacall (QMetaObject::Call, int, void **)

	QObject (QObject *parent)

virtual	~QObject ()

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

QString	objectName () const const

void	setObjectName (const QString &name)

bool	isWidgetType () const const

bool	isWindowType () const const

bool	signalsBlocked () const const

bool	blockSignals (bool block)

QThread *	thread () const const

void	moveToThread (QThread *targetThread)

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

void	killTimer (int id)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

const QObjectList &	children () const const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectTree ()

void	dumpObjectInfo ()

void	dumpObjectTree () const const

void	dumpObjectInfo () const const

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const const

QList< QByteArray >	dynamicPropertyNames () const const

void	destroyed (QObject *obj)

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

bool	inherits (const char *className) const const

void	deleteLater ()

Static Public Member Functions
static void	Info (const QString &text)
	Add informative notification. More...

static void	Warning (const QString &text)
	Add warning notification. More...

static void	Critical (const QString &text)
	Add critical notification. More...

static void	Critical (const ErrorInfo &errorInfo)
	Add critical notification. More...

Static Public Member Functions inherited from QObject
QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

Properties
Type	type
	Notification type. More...

QString	text
	Notification text. More...

Properties inherited from QObject
	objectName

Additional Inherited Members
Protected Member Functions inherited from QObject
QObject *	sender () const const

int	senderSignalIndex () const const

int	receivers (const char *signal) const const

bool	isSignalConnected (const QMetaMethod &signal) const const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

Detailed Description

Notification.

Notifications are a mean to store information about events that occur to the system. Compared to logs they shall be more concise, accessible and friendly in general. They belong to user space or power-user space rather than developer/expert space. Contrary to log messages, notification messages shall be translatable. Compared to messages they are less intrusive and do not require user action.

Notification objects are designed to work with Notifier and NotificationListModel classes.

Member Enumeration Documentation

◆ Type

enum cutehmi::Notification::Type

Enumerator
INFO	Informative level notification type.
WARNING	Warning level notification type.
CRITICAL	Critical level notification type.

Constructor & Destructor Documentation

◆ Notification() [1/2]

cutehmi::Notification::Notification	(	const QString &	text = `QString()`,
		Notification::Type	type = `INFO`,
		QObject *	parnt = `nullptr`
	)

explicit

Default constructor.

Parameters

text	notification text.
type	notification type.
parent	parent object.

◆ Notification() [2/2]

cutehmi::Notification::Notification	(	Type	type,
		const QString &	text = `QString()`,
		QObject *	parent = `nullptr`
	)

explicit

Constructor.

Parameters

type	notification type.
text	notification text.
parent	parent object.

Deprecated:: Notification(const QString &, Type, QObject *) constructor should be used instead.

Member Function Documentation

◆ clone()

std::unique_ptr< Notification > cutehmi::Notification::clone ( ) const

Cone notification.

Returns: notification clone.

◆ Critical() [1/2]

void cutehmi::Notification::Critical ( const ErrorInfo & errorInfo )

static

Add critical notification.

Convenient function that creates critical notification from ErrorInfo object and adds it to the Notifier.

Parameters

errorInfo ErrorInfo object.

◆ Critical() [2/2]

void cutehmi::Notification::Critical ( const QString & text )

static

Add critical notification.

Convenient function that creates critical notification and adds it to the Notifier.

Parameters

text	notification text.

◆ dateTime()

const QDateTime & cutehmi::Notification::dateTime ( ) const

Get date.

Date is set automatically upon notification creation.

Returns: date of notification.

◆ Info()

void cutehmi::Notification::Info ( const QString & text )

static

Add informative notification.

Convenient function that creates informative notification and adds it to the Notifier.

Parameters

text	notification text.

◆ setText()

void cutehmi::Notification::setText ( const QString & text )

Set text.

Parameters

text	notification text.

◆ setType()

void cutehmi::Notification::setType ( Type type )

Set type.

Parameters

type	notification type.

◆ text()

QString cutehmi::Notification::text ( ) const

Get text.

Returns: notification text.

◆ textChanged

void cutehmi::Notification::textChanged ( )

signal

Text changed signal.

◆ type()

Type cutehmi::Notification::type ( ) const

Get type.

Returns: notification type.

◆ typeChanged

void cutehmi::Notification::typeChanged ( )

signal

Type changed signal.

◆ Warning()

void cutehmi::Notification::Warning ( const QString & text )

static

Add warning notification.

Convenient function that creates warning notification and adds it to the Notifier.

Parameters

text	notification text.

Property Documentation

◆ text

QString cutehmi::Notification::text

readwrite

Notification text.

◆ type

Notification::Type cutehmi::Notification::type

readwrite

Notification type.

Public Types

Signals

Public Member Functions

Static Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ Notification() [1/2]

◆ Notification() [2/2]

Member Function Documentation

◆ clone()

◆ Critical() [1/2]

◆ Critical() [2/2]

◆ dateTime()

◆ Info()

◆ setText()

◆ setType()

◆ text()

◆ textChanged

◆ type()

◆ typeChanged

◆ Warning()

Property Documentation

◆ text

◆ type