PimCommon::BroadcastStatus Class

The BroadcastStatus class provides a singleton which broadcasts status messages Author: Don Sanders <sanders@kde.org>. More...

Header: #include <PimCommon/BroadcastStatus>
CMake: find_package(KPim6PimCommon REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::PimCommon)
Inherits: QObject

Public Functions

virtual ~BroadcastStatus() override

Public Slots

void reset()
void setStatusMsg(const QString &message)
void setTransientStatusMsg(const QString &msg)

Signals

void statusMsg(const QString &)

Static Public Members

PimCommon::BroadcastStatus *instance()

Protected Functions

Detailed Description

Member Function Documentation

[protected] BroadcastStatus::BroadcastStatus()

Protected constructor for the singleton pattern.

[override virtual noexcept] BroadcastStatus::~BroadcastStatus()

Destructs the BroadcastStatus.

[static] PimCommon::BroadcastStatus *BroadcastStatus::instance()

Returns the singleton instance of BroadcastStatus. @return The singleton instance

[slot] void BroadcastStatus::reset()

Resets the status message to the last non-transient message.

[slot] void BroadcastStatus::setStatusMsg(const QString &message)

Sets a status message to be broadcast. @param message The status message to display

See also statusMsg().

[slot] void BroadcastStatus::setTransientStatusMsg(const QString &msg)

Sets a transient status message that will be reset on the next reset() call. @param msg The transient status message

[signal] void BroadcastStatus::statusMsg(const QString &)

Emitted when a status message is set. @param message The status message

See also setStatusMsg().