Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
PhosphorServiceNotifications::Notification Class Reference

One live notification, decoded from an org.freedesktop.Notifications Notify call. More...

#include <PhosphorServiceNotifications/Notification.h>

Inheritance diagram for PhosphorServiceNotifications::Notification:
[legend]

Public Types

enum  Urgency { Low = 0 , Normal = 1 , Critical = 2 }
 Spec urgency levels (the urgency hint, a byte). More...

Signals

void changed ()
 Emitted once per replaces_id update: the server re-applies the full field set in place (a replacing Notify re-specifies the notification, so this fires even if the new values happen to match the old).

Public Member Functions

uint id () const
QString appName () const
QString appIcon () const
QString summary () const
QString body () const
QStringList actions () const
Urgency urgency () const
QString category () const
QString desktopEntry () const
QImage image () const
bool hasImage () const
bool resident () const
bool transient () const
bool suppressSound () const
int value () const
 The value hint (a progress percentage by convention), or -1 when absent.
int expireTimeout () const
 The raw expire_timeout from Notify (-1 server-default, 0 never, >0 ms).
QDateTime timestamp () const
 When the notification was first received (does not move on replace).
QVariantMap hints () const

Detailed Description

One live notification, decoded from an org.freedesktop.Notifications Notify call.

Owned by NotificationServer (which is its parent and sole mutator: the setters are private and NotificationServer is a friend). A notification is mutable for its whole life: a Notify carrying a replaces_id updates the matching object in place rather than allocating a new one, so every field except id can change and is reported through the single changed() signal.

The object decodes the spec hint set into typed fields. image is the rich notification image (from the image-data / image-path hints), decoded once here so no consumer re-derives the fiddly (iiibiiay) struct; the raw hint map stays available via hints() for advanced bindings. The body's optional markup is stored raw: this library never renders.

Member Enumeration Documentation

◆ Urgency

Spec urgency levels (the urgency hint, a byte).

Enumerator
Low 
Normal 
Critical 

Member Function Documentation

◆ actions()

QStringList PhosphorServiceNotifications::Notification::actions ( ) const
inlinenodiscard

◆ appIcon()

QString PhosphorServiceNotifications::Notification::appIcon ( ) const
inlinenodiscard

◆ appName()

QString PhosphorServiceNotifications::Notification::appName ( ) const
inlinenodiscard

◆ body()

QString PhosphorServiceNotifications::Notification::body ( ) const
inlinenodiscard

◆ category()

QString PhosphorServiceNotifications::Notification::category ( ) const
inlinenodiscard

◆ changed

void PhosphorServiceNotifications::Notification::changed ( )
signal

Emitted once per replaces_id update: the server re-applies the full field set in place (a replacing Notify re-specifies the notification, so this fires even if the new values happen to match the old).

◆ desktopEntry()

QString PhosphorServiceNotifications::Notification::desktopEntry ( ) const
inlinenodiscard

◆ expireTimeout()

int PhosphorServiceNotifications::Notification::expireTimeout ( ) const
inlinenodiscard

The raw expire_timeout from Notify (-1 server-default, 0 never, >0 ms).

◆ hasImage()

bool PhosphorServiceNotifications::Notification::hasImage ( ) const
inlinenodiscard

◆ hints()

QVariantMap PhosphorServiceNotifications::Notification::hints ( ) const
inlinenodiscard

◆ id()

uint PhosphorServiceNotifications::Notification::id ( ) const
inlinenodiscard

◆ image()

QImage PhosphorServiceNotifications::Notification::image ( ) const
inlinenodiscard

◆ resident()

bool PhosphorServiceNotifications::Notification::resident ( ) const
inlinenodiscard

◆ summary()

QString PhosphorServiceNotifications::Notification::summary ( ) const
inlinenodiscard

◆ suppressSound()

bool PhosphorServiceNotifications::Notification::suppressSound ( ) const
inlinenodiscard

◆ timestamp()

QDateTime PhosphorServiceNotifications::Notification::timestamp ( ) const
inlinenodiscard

When the notification was first received (does not move on replace).

◆ transient()

bool PhosphorServiceNotifications::Notification::transient ( ) const
inlinenodiscard

◆ urgency()

Urgency PhosphorServiceNotifications::Notification::urgency ( ) const
inlinenodiscard

◆ value()

int PhosphorServiceNotifications::Notification::value ( ) const
inlinenodiscard

The value hint (a progress percentage by convention), or -1 when absent.

Stored as sent; the server does not clamp it.


The documentation for this class was generated from the following file:
  • phosphor-service-notifications/include/PhosphorServiceNotifications/Notification.h