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
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Static Public Member Functions
static BroadcastStatus *	instance ()
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)

Protected Member Functions
	BroadcastStatus ()
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)

Protected Attributes
QString	mStatusMsg
bool	mTransientActive

Additional Inherited Members
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

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