KPIM::BroadcastStatus Class Reference

#include <broadcaststatus.h>

Inheritance diagram for KPIM::BroadcastStatus:

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

Signals
void	statusMsg (const QString &)

Public Member Functions
virtual	~BroadcastStatus ()
void	setStatusMsgTransmissionCompleted (int numMessages, int numBytes=-1, int numBytesRead=-1, int numBytesToRead=-1, bool mLeaveOnServer=false, KPIM::ProgressItem *progressItem=0)
void	setStatusMsgTransmissionCompleted (const QString &account, 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

Static Public Member Functions
static BroadcastStatus *	instance ()

Protected Member Functions
	BroadcastStatus ()

Protected Attributes
QString	mStatusMsg
bool	mTransientActive

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.

Constructor & Destructor Documentation

KPIM::BroadcastStatus::~BroadcastStatus ( )

virtual

Definition at line 58 of file broadcaststatus.cpp.

KPIM::BroadcastStatus::BroadcastStatus ( )

protected

Definition at line 53 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 44 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 174 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 63 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 78 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 118 of file broadcaststatus.cpp.

void KPIM::BroadcastStatus::setStatusMsgWithTimestamp

(

const QString &

message

)

Sets a status bar message with timestamp.

Definition at line 71 of file broadcaststatus.cpp.

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 168 of file broadcaststatus.cpp.

QString KPIM::BroadcastStatus::statusMsg ( ) const

inline

Return the last status message from setStatusMsg()

Definition at line 52 of file broadcaststatus.h.

void KPIM::BroadcastStatus::statusMsg ( const QString &  )

signal

Emitted when setStatusMsg is called.

Member Data Documentation

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:

• broadcaststatus.h
• broadcaststatus.cpp