Albert
Loading...
Searching...
No Matches
albert::Notification Class Referencefinal

#include <albert/notification.h>

Inheritance diagram for albert::Notification:

Detailed Description

The notification class.

This is basically a wrapper around the QNotification class.

See also
https://github.com/QtCommunity/QNotification

Signals

void activated ()
 Emitted when the notification is activated.
 

Public Member Functions

 Notification (const QString &title={}, const QString &text={}, QObject *parent=nullptr)
 
 ~Notification ()
 
const QString & title () const
 The title of the notification.
 
void setTitle (const QString &title)
 Set the title of the notification.
 
const QString & text () const
 The text of the notification.
 
void setText (const QString &text)
 Set the text of the notification.
 
void send ()
 Send the notification to the notification server.
 
void dismiss ()
 Dismiss the notification.
 

Friends

class ALBERT_NO_EXPORT QNotificationManager
 

Constructor & Destructor Documentation

◆ Notification()

albert::Notification::Notification ( const QString &  title = {},
const QString &  text = {},
QObject *  parent = nullptr 
)

◆ ~Notification()

albert::Notification::~Notification ( )

Member Function Documentation

◆ activated

void albert::Notification::activated ( )
signal

Emitted when the notification is activated.

I.e. the user clicked on the notification.

◆ dismiss()

void albert::Notification::dismiss ( )

Dismiss the notification.

This will remove the notification from the notification server.

◆ send()

void albert::Notification::send ( )

Send the notification to the notification server.

This will add the notification to the notification server and present it to the user (Subject to the users settings).

◆ setText()

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

Set the text of the notification.

Parameters
textThe text of the notification.

◆ setTitle()

void albert::Notification::setTitle ( const QString &  title)

Set the title of the notification.

Parameters
titleThe title of the notification.

◆ text()

const QString & albert::Notification::text ( ) const

The text of the notification.

Returns
The text of the notification.

◆ title()

const QString & albert::Notification::title ( ) const

The title of the notification.

Returns
The title of the notification.

Friends And Related Symbol Documentation

◆ QNotificationManager

friend class ALBERT_NO_EXPORT QNotificationManager
friend

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