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

The desktop's activities, from an IActivityBackend (Plasma's is PhosphorWorkspaces::Plasma's). More...

#include <PhosphorWorkspaces/ActivityManager.h>

Inheritance diagram for PhosphorWorkspaces::ActivityManager:
[legend]

Signals

void currentActivityChanged (const QString &activityId)
void activitiesChanged ()

Public Member Functions

 ActivityManager (QObject *parent=nullptr)
 No backend: unavailable.
 ActivityManager (std::unique_ptr< IActivityBackend > backend, QObject *parent=nullptr)
 Activities from backend, owned from here on.
 ~ActivityManager () override
bool init ()
void start ()
void stop ()
QString currentActivity () const
 The last activity the service reported.
bool isAvailable () const
 Whether this manager has activities to report at all: it has a backend.
QStringList activities () const
QString activityName (const QString &activityId) const
QString activityIcon (const QString &activityId) const

Static Public Member Functions

static QString currentActivityOrEmpty (const ActivityManager *manager)
 Returns manager's current activity, or an empty string when manager is null OR has no activities (isAvailable).

Detailed Description

The desktop's activities, from an IActivityBackend (Plasma's is PhosphorWorkspaces::Plasma's).

Without one the manager is unavailable and reports no activity.

Constructor & Destructor Documentation

◆ ActivityManager() [1/2]

PhosphorWorkspaces::ActivityManager::ActivityManager ( QObject * parent = nullptr)
explicit

No backend: unavailable.

◆ ActivityManager() [2/2]

PhosphorWorkspaces::ActivityManager::ActivityManager ( std::unique_ptr< IActivityBackend > backend,
QObject * parent = nullptr )
explicit

Activities from backend, owned from here on.

Null is the same as the constructor above.

◆ ~ActivityManager()

PhosphorWorkspaces::ActivityManager::~ActivityManager ( )
override

Member Function Documentation

◆ activities()

QStringList PhosphorWorkspaces::ActivityManager::activities ( ) const

◆ activitiesChanged

void PhosphorWorkspaces::ActivityManager::activitiesChanged ( )
signal

◆ activityIcon()

QString PhosphorWorkspaces::ActivityManager::activityIcon ( const QString & activityId) const

◆ activityName()

QString PhosphorWorkspaces::ActivityManager::activityName ( const QString & activityId) const

◆ currentActivity()

QString PhosphorWorkspaces::ActivityManager::currentActivity ( ) const

The last activity the service reported.

Kept through a service outage rather than cleared, so a restart of the service is not a switch. Empty only before the service has named one.

◆ currentActivityChanged

void PhosphorWorkspaces::ActivityManager::currentActivityChanged ( const QString & activityId)
signal

◆ currentActivityOrEmpty()

QString PhosphorWorkspaces::ActivityManager::currentActivityOrEmpty ( const ActivityManager * manager)
static

Returns manager's current activity, or an empty string when manager is null OR has no activities (isAvailable).

Centralises the (mgr && isAvailable()) ? mgr->currentActivity() : QString() guard shared by the daemon's context-resolution sites.

◆ init()

bool PhosphorWorkspaces::ActivityManager::init ( )

◆ isAvailable()

bool PhosphorWorkspaces::ActivityManager::isAvailable ( ) const

Whether this manager has activities to report at all: it has a backend.

Activities are a property of the desktop, not of the moment, so this stays true through an outage of the activity service.

◆ start()

void PhosphorWorkspaces::ActivityManager::start ( )

◆ stop()

void PhosphorWorkspaces::ActivityManager::stop ( )

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