Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
KPIM::BroadcastStatus Class Reference

#include <broadcaststatus.h>

Inherits TQObject.

Public Slots

void setStatusMsg (const TQString &message)
 
void setTransienStatusMsg (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

◆ instance()

BroadcastStatus * KPIM::BroadcastStatus::instance ( )
static

Return the instance of the singleton object for this class.

Definition at line 31 of file broadcaststatus.cpp.

◆ reset

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.

◆ setStatusMsg

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.

◆ setStatusMsgTransmissionCompleted()

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.

◆ setStatusMsgWithTimestamp()

void KPIM::BroadcastStatus::setStatusMsgWithTimestamp ( const TQString &  message)

Sets a status bar message with timestamp.

Definition at line 56 of file broadcaststatus.cpp.

◆ setTransienStatusMsg

void KPIM::BroadcastStatus::setTransienStatusMsg ( 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.

◆ statusMsg() [1/2]

TQString KPIM::BroadcastStatus::statusMsg ( ) const
inline

Return the last status message from setStatusMsg()

Definition at line 45 of file broadcaststatus.h.

◆ statusMsg [2/2]

void KPIM::BroadcastStatus::statusMsg ( const TQString &  )
signal

Emitted when setStatusMsg is called.

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