Bitcoin
Public Types | Public Slots | Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
Notificator Class Reference

#include <notificator.h>

Inheritance 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)
 

Public Member Functions

 Notificator (const QString &programName, QSystemTrayIcon *trayIcon, QWidget *parent)
 
 ~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
 
QSystemTrayIcon * trayIcon
 

Detailed Description

Cross-platform desktop notification client.

Member Enumeration Documentation

◆ Class

Enumerator
Information 

Informational message

Warning 

Notify user of potential problem

Critical 

An error occurred

◆ 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)

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.

◆ ~Notificator()

Notificator::~Notificator ( )

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]clsgeneral message class
[in]titletitle shown with message
[in]textmessage content
[in]iconoptional icon to show with message
[in]millisTimeoutnotification timeout in milliseconds (defaults to 10 seconds)
Note
Platform implementations are free to ignore any of the provided fields except for text.

◆ notifySystray()

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

Member Data Documentation

◆ mode

Mode Notificator::mode
private

◆ parent

QWidget* Notificator::parent
private

◆ programName

QString Notificator::programName
private

◆ trayIcon

QSystemTrayIcon* Notificator::trayIcon
private

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