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

One system-tray item. More...

#include <PhosphorServiceSni/StatusNotifierItem.h>

Inheritance diagram for PhosphorServiceSni::StatusNotifierItem:
[legend]

Public Types

enum class  Status { Passive , Active , NeedsAttention }

Public Slots

void activate (int x, int y)
void secondaryActivate (int x, int y)
void contextMenu (int x, int y)
void scroll (int delta, const QString &orientation)

Signals

void idChanged ()
void titleChanged ()
void categoryChanged ()
void statusChanged ()
void iconChanged ()
void toolTipChanged ()
void menuPathChanged ()
void validChanged ()

Public Member Functions

 StatusNotifierItem (const QString &dbusService, const QString &dbusPath, QObject *parent=nullptr)
 dbusService is the unique bus name, dbusPath the object path.
 ~StatusNotifierItem () override
QString id () const
QString title () const
QString category () const
Status status () const
QImage iconImage () const
QImage overlayIconImage () const
QImage attentionIconImage () const
QString toolTipTitle () const
QString toolTipBody () const
QString menuPath () const
bool itemIsMenu () const
QString dbusService () const
QString dbusPath () const
bool isValid () const
void setPreferredIconSize (int size)
 Preferred render size in logical pixels.
int preferredIconSize () const

Detailed Description

One system-tray item.

Owned by StatusNotifierHost. Wraps the DBus proxy + property cache + icon resolution. The host populates these from RegisteredStatusNotifierItems and refreshes them in response to per-item NewXxx signals.

Member Enumeration Documentation

◆ Status

Enumerator
Passive 

Item is dormant: could be hidden in an overflow.

Active 

Item is meaningful: show it normally.

NeedsAttention 

Use the attention icon + maybe animate.

Constructor & Destructor Documentation

◆ StatusNotifierItem()

PhosphorServiceSni::StatusNotifierItem::StatusNotifierItem ( const QString & dbusService,
const QString & dbusPath,
QObject * parent = nullptr )

dbusService is the unique bus name, dbusPath the object path.

Watchers produce the canonical "uniqueName/object/path" concatenation; splitting it into the two args is the host's job. The item itself only ever sees the split form.

◆ ~StatusNotifierItem()

PhosphorServiceSni::StatusNotifierItem::~StatusNotifierItem ( )
override

Member Function Documentation

◆ activate

void PhosphorServiceSni::StatusNotifierItem::activate ( int x,
int y )
slot

◆ attentionIconImage()

QImage PhosphorServiceSni::StatusNotifierItem::attentionIconImage ( ) const
nodiscard

◆ category()

QString PhosphorServiceSni::StatusNotifierItem::category ( ) const
nodiscard

◆ categoryChanged

void PhosphorServiceSni::StatusNotifierItem::categoryChanged ( )
signal

◆ contextMenu

void PhosphorServiceSni::StatusNotifierItem::contextMenu ( int x,
int y )
slot

◆ dbusPath()

QString PhosphorServiceSni::StatusNotifierItem::dbusPath ( ) const
nodiscard

◆ dbusService()

QString PhosphorServiceSni::StatusNotifierItem::dbusService ( ) const
nodiscard

◆ iconChanged

void PhosphorServiceSni::StatusNotifierItem::iconChanged ( )
signal

◆ iconImage()

QImage PhosphorServiceSni::StatusNotifierItem::iconImage ( ) const
nodiscard

◆ id()

QString PhosphorServiceSni::StatusNotifierItem::id ( ) const
nodiscard

◆ idChanged

void PhosphorServiceSni::StatusNotifierItem::idChanged ( )
signal

◆ isValid()

bool PhosphorServiceSni::StatusNotifierItem::isValid ( ) const
nodiscard

◆ itemIsMenu()

bool PhosphorServiceSni::StatusNotifierItem::itemIsMenu ( ) const
nodiscard

◆ menuPath()

QString PhosphorServiceSni::StatusNotifierItem::menuPath ( ) const
nodiscard

◆ menuPathChanged

void PhosphorServiceSni::StatusNotifierItem::menuPathChanged ( )
signal

◆ overlayIconImage()

QImage PhosphorServiceSni::StatusNotifierItem::overlayIconImage ( ) const
nodiscard

◆ preferredIconSize()

int PhosphorServiceSni::StatusNotifierItem::preferredIconSize ( ) const
nodiscard

◆ scroll

void PhosphorServiceSni::StatusNotifierItem::scroll ( int delta,
const QString & orientation )
slot

◆ secondaryActivate

void PhosphorServiceSni::StatusNotifierItem::secondaryActivate ( int x,
int y )
slot

◆ setPreferredIconSize()

void PhosphorServiceSni::StatusNotifierItem::setPreferredIconSize ( int size)

Preferred render size in logical pixels.

Passed through to the icon resolver so we don't upscale a 16x16 themed icon when the panel asks for 24x24 (XDG spec ranks "next-size-up" higher than "scaled current size"). Q_INVOKABLE so QML delegates can configure render size on the item directly (e.g. via Component.onCompleted: trayItem.setPreferredIconSize(36)).

◆ status()

Status PhosphorServiceSni::StatusNotifierItem::status ( ) const
nodiscard

◆ statusChanged

void PhosphorServiceSni::StatusNotifierItem::statusChanged ( )
signal

◆ title()

QString PhosphorServiceSni::StatusNotifierItem::title ( ) const
nodiscard

◆ titleChanged

void PhosphorServiceSni::StatusNotifierItem::titleChanged ( )
signal

◆ toolTipBody()

QString PhosphorServiceSni::StatusNotifierItem::toolTipBody ( ) const
nodiscard

◆ toolTipChanged

void PhosphorServiceSni::StatusNotifierItem::toolTipChanged ( )
signal

◆ toolTipTitle()

QString PhosphorServiceSni::StatusNotifierItem::toolTipTitle ( ) const
nodiscard

◆ validChanged

void PhosphorServiceSni::StatusNotifierItem::validChanged ( )
signal

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