KPIM::BroadcastStatus Class Reference

Provides a singleton which broadcasts status messages by emitting signals. More...

#include <broadcaststatus.h>

Inherits QObject.

List of all members.

Public Slots

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

Signals

void statusMsg (const QString &)

Public Member Functions

QString statusMsg () const
void setStatusMsgWithTimestamp (const QString &message)
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)

Static Public Member Functions

static BroadcastStatus * instance ()

Protected Attributes

QString 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.

Member Function Documentation

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

Return the instance of the singleton object for this class.

QString KPIM::BroadcastStatus::statusMsg ( ) const [inline]

Return the last status message from setStatusMsg().

void KPIM::BroadcastStatus::setStatusMsgWithTimestamp

(

const QString &

message

)

Sets a status bar message with timestamp.

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.

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.

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

Set a status message that will go away again with the next call of reset().

void KPIM::BroadcastStatus::reset ( ) [slot]

Reset the status message to what ever non-transient message was last active or has since been set.

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

Emitted when setStatusMsg is called.

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

broadcaststatus.h
broadcaststatus.cpp

libkdepim

API Docs