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. More...

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

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

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

Private Attributes
QWidget *	parent
QString	programName
Mode	mode
QSystemTrayIcon *	trayIcon

Detailed Description

Cross-platform desktop notification client.

Definition at line 15 of file notificator.h.

Member Enumeration Documentation

enum Notificator::Class

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

Definition at line 27 of file notificator.h.

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 QSystemTray::showMessage.
Growl12	Use the Growl 1.2 notification system (Mac only)
Growl13	Use the Growl 1.3 notification system (Mac only)
UserNotificationCenter	Use the 10.8+ User Notification Center (Mac only)

Definition at line 48 of file notificator.h.

Constructor & Destructor Documentation

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

Create a new notificator.

Note

Ownership of trayIcon is not transferred to this object.

Definition at line 27 of file notificator.cpp.

Notificator::~Notificator

(

)

Definition at line 73 of file notificator.cpp.

Member Function Documentation

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 288 of file notificator.cpp.

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

private

Definition at line 220 of file notificator.cpp.

Member Data Documentation

Mode Notificator::mode

private

Definition at line 57 of file notificator.h.

QWidget* Notificator::parent

private

Definition at line 47 of file notificator.h.

QString Notificator::programName

private

Definition at line 56 of file notificator.h.

QSystemTrayIcon* Notificator::trayIcon

private

Definition at line 58 of file notificator.h.

---

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

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