libkdepim
KPIM::BroadcastStatus Class Reference
Provides a singleton which broadcasts status messages by emitting signals. More...
#include <broadcaststatus.h>
Inherits QObject.
Public Slots | |
void | setStatusMsg (const TQString &message) |
void | setTransientStatusMsg (const TQString &msg) |
void | reset () |
Signals | |
void | statusMsg (const TQString &) |
Public Member Functions | |
TQString | statusMsg () const |
void | setStatusMsgWithTimestamp (const TQString &message) |
void | setStatusMsgTransmissionCompleted (int numMessages, int numBytes=-1, int numBytesRead=-1, int numBytesToRead=-1, bool mLeaveOnServer=false, KPIM::ProgressItem *progressItem=0) |
void | setStatusMsgTransmissionCompleted (const TQString &account, int numMessages, int numBytes=-1, int numBytesRead=-1, int numBytesToRead=-1, bool mLeaveOnServer=false, KPIM::ProgressItem *progressItem=0) |
Static Public Member Functions | |
static BroadcastStatus * | instance () |
Protected Attributes | |
TQString | mStatusMsg |
bool | mTransientActive |
Static Protected Attributes | |
static BroadcastStatus * | instance_ = 0 |
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 32 of file broadcaststatus.h.
Member Function Documentation
BroadcastStatus * KPIM::BroadcastStatus::instance | ( | ) | [static] |
Return the instance of the singleton object for this class.
Definition at line 31 of file broadcaststatus.cpp.
TQString KPIM::BroadcastStatus::statusMsg | ( | ) | const [inline] |
Return the last status message from setStatusMsg().
Definition at line 44 of file broadcaststatus.h.
void KPIM::BroadcastStatus::setStatusMsgWithTimestamp | ( | const TQString & | message | ) |
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 65 of file broadcaststatus.cpp.
void KPIM::BroadcastStatus::setStatusMsg | ( | const TQString & | message | ) | [slot] |
Emit an update status bar signal.
It's a slot so it can be hooked up to other signals.
Definition at line 49 of file broadcaststatus.cpp.
void KPIM::BroadcastStatus::setTransientStatusMsg | ( | const TQString & | msg | ) | [slot] |
Set a status message that will go away again with the next call of reset().
Definition at line 150 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 156 of file broadcaststatus.cpp.
void KPIM::BroadcastStatus::statusMsg | ( | const TQString & | ) | [signal] |
Emitted when setStatusMsg is called.
The documentation for this class was generated from the following files: