KDE 4.2 API Reference libkdepim
KPIM::BroadcastStatus Class Reference
#include <broadcaststatus.h>
Detailed Description
Provides a singleton which broadcasts status messages by emitting signals.Interested mainwindows can connect to the statusMsg() signal and update statusBars or whatever they use for showing status.
Definition at line 40 of file broadcaststatus.h.
Public Slots | |
| void | reset () |
| void | setStatusMsg (const QString &message) |
| void | setTransientStatusMsg (const QString &msg) |
Signals | |
| void | statusMsg (const QString &) |
Public Member Functions | |
| void | setStatusMsgTransmissionCompleted (const QString &account, int numMessages, int numBytes=-1, int numBytesRead=-1, int numBytesToRead=-1, bool mLeaveOnServer=false, KPIM::ProgressItem *progressItem=0) |
| void | setStatusMsgTransmissionCompleted (int numMessages, int numBytes=-1, int numBytesRead=-1, int numBytesToRead=-1, bool mLeaveOnServer=false, KPIM::ProgressItem *progressItem=0) |
| void | setStatusMsgWithTimestamp (const QString &message) |
| QString | statusMsg () const |
| virtual | ~BroadcastStatus () |
Static Public Member Functions | |
| static BroadcastStatus * | instance () |
Protected Member Functions | |
| BroadcastStatus () | |
Protected Attributes | |
| QString | mStatusMsg |
| bool | mTransientActive |
Static Protected Attributes | |
| static BroadcastStatus * | instance_ = 0 |
Constructor & Destructor Documentation
| KPIM::BroadcastStatus::~BroadcastStatus | ( | ) | [virtual] |
Definition at line 52 of file broadcaststatus.cpp.
| KPIM::BroadcastStatus::BroadcastStatus | ( | ) | [protected] |
Definition at line 47 of file broadcaststatus.cpp.
Member Function Documentation
| BroadcastStatus * KPIM::BroadcastStatus::instance | ( | ) | [static] |
Return the instance of the singleton object for this class.
Definition at line 39 of file broadcaststatus.cpp.
| void KPIM::BroadcastStatus::reset | ( | ) | [slot] |
Reset the status message to what ever non-transient message was last active or has since been set.
Definition at line 168 of file broadcaststatus.cpp.
| void KPIM::BroadcastStatus::setStatusMsg | ( | const QString & | message | ) | [slot] |
Emit an update status bar signal.
It's a slot so it can be hooked up to other signals.
Definition at line 57 of file broadcaststatus.cpp.
| void KPIM::BroadcastStatus::setStatusMsgTransmissionCompleted | ( | const QString & | account, | |
| int | numMessages, | |||
| int | numBytes = -1, |
|||
| int | numBytesRead = -1, |
|||
| int | numBytesToRead = -1, |
|||
| bool | mLeaveOnServer = false, |
|||
| KPIM::ProgressItem * | progressItem = 0 | |||
| ) |
Definition at line 112 of file broadcaststatus.cpp.
| void KPIM::BroadcastStatus::setStatusMsgTransmissionCompleted | ( | int | numMessages, | |
| int | numBytes = -1, |
|||
| int | numBytesRead = -1, |
|||
| int | numBytesToRead = -1, |
|||
| bool | mLeaveOnServer = false, |
|||
| KPIM::ProgressItem * | progressItem = 0 | |||
| ) |
Sets a transmission completed status bar message.
Definition at line 72 of file broadcaststatus.cpp.
| void KPIM::BroadcastStatus::setStatusMsgWithTimestamp | ( | const QString & | message | ) |
| void KPIM::BroadcastStatus::setTransientStatusMsg | ( | const QString & | msg | ) | [slot] |
Set a status message that will go away again with the next call of reset().
Definition at line 162 of file broadcaststatus.cpp.
| void KPIM::BroadcastStatus::statusMsg | ( | const QString & | ) | [signal] |
Emitted when setStatusMsg is called.
| QString KPIM::BroadcastStatus::statusMsg | ( | ) | const [inline] |
Return the last status message from setStatusMsg().
Definition at line 52 of file broadcaststatus.h.
Member Data Documentation
KPIM::BroadcastStatus * KPIM::BroadcastStatus::instance_ = 0 [static, protected] |
Definition at line 99 of file broadcaststatus.h.
QString KPIM::BroadcastStatus::mStatusMsg [protected] |
Definition at line 97 of file broadcaststatus.h.
bool KPIM::BroadcastStatus::mTransientActive [protected] |
Definition at line 98 of file broadcaststatus.h.
The documentation for this class was generated from the following files:
