Notificator Class Reference

Cross-platform desktop notification client. More...

#include <notificator.h>

Inheritance diagram for Notificator:

Collaboration diagram for Notificator:

Public Types
enum	Class { Information , Warning , Critical }

Public Slots
void	notify (Class cls, const QString &title, const QString &text, const QIcon &icon=QIcon(), int millisTimeout=10000)
	Show notification message.

Public Member Functions
	Notificator (const QString &programName, QSystemTrayIcon *trayIcon, QWidget *parent)
	Create a new notificator.
	~Notificator ()

Private Types
enum	Mode { None , Freedesktop , QSystemTray , UserNotificationCenter }

Private Member Functions
void	notifySystray (Class cls, const QString &title, const QString &text, int millisTimeout)

Private Attributes
QWidget *	parent
QString	programName
Mode	mode {None}
QSystemTrayIcon *	trayIcon

Detailed Description

Cross-platform desktop notification client.

Definition at line 22 of file notificator.h.

Member Enumeration Documentation

Class

enum Notificator::Class

Enumerator
Information	Informational message.
Warning	Notify user of potential problem.
Critical	An error occurred.

Definition at line 34 of file notificator.h.

Mode

enum Notificator::Mode

private

Enumerator
None	Ignore informational notifications, and show a modal pop-up dialog for Critical notifications.
Freedesktop	Use DBus org.freedesktop.Notifications.
QSystemTray	Use QSystemTrayIcon::showMessage().
UserNotificationCenter	Use the 10.8+ User Notification Center (Mac only).

Definition at line 55 of file notificator.h.

Constructor & Destructor Documentation

Notificator()

Notificator::Notificator	(	const QString &	programName,
		QSystemTrayIcon *	trayIcon,
		QWidget *	parent )

Create a new notificator.

Note

Ownership of trayIcon is not transferred to this object.

Definition at line 33 of file notificator.cpp.

Here is the call graph for this function:

~Notificator()

Notificator::~Notificator

(

)

Definition at line 59 of file notificator.cpp.

Member Function Documentation

notify

void Notificator::notify ( Class cls, const QString & title, const QString & text, const QIcon & icon = QIcon(), int millisTimeout = 10000 )

slot

Show notification message.

Parameters

[in]	cls	general message class
[in]	title	title shown with message
[in]	text	message content
[in]	icon	optional icon to show with message
[in]	millisTimeout	notification timeout in milliseconds (defaults to 10 seconds)

Note

Platform implementations are free to ignore any of the provided fields except for text.

Definition at line 218 of file notificator.cpp.

Here is the call graph for this function:

notifySystray()

void Notificator::notifySystray ( Class cls, const QString & title, const QString & text, int millisTimeout )

private

Definition at line 198 of file notificator.cpp.

Here is the caller graph for this function:

Member Data Documentation

mode

Mode Notificator::mode {None}

private

Definition at line 62 of file notificator.h.

parent

QWidget* Notificator::parent

private

Definition at line 54 of file notificator.h.

programName

QString Notificator::programName

private

Definition at line 61 of file notificator.h.

trayIcon

QSystemTrayIcon* Notificator::trayIcon

private

Definition at line 63 of file notificator.h.

---

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

• src/qt/notificator.h
• src/qt/notificator.cpp