kmail Library API Documentation

KMBroadcastStatus Class Reference

When KMail is running it is possible to have multiple KMMainWin open at the same time. More...

#include <kmbroadcaststatus.h>

Inheritance diagram for KMBroadcastStatus:

Inheritance graph
[legend]
Collaboration diagram for KMBroadcastStatus:

Collaboration graph
[legend]
List of all members.

Signals

void statusMsg (const QString &)

Public Member Functions

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

KMBroadcastStatusinstance ()

Protected Attributes

QString mStatusMsg

Static Protected Attributes

KMBroadcastStatusinstance_ = 0

Detailed Description

When KMail is running it is possible to have multiple KMMainWin open at the same time.

We want certain messages/information to be displayed in all active KMMainWins. KMBroadcastStatus make this possible, it defines a singleton object that broadcasts status messages by emitting signals. All KMMainWins connect up these signals to appropriate slots for updating their status bar.

Definition at line 27 of file kmbroadcaststatus.h.


Member Function Documentation

KMBroadcastStatus * KMBroadcastStatus::instance  )  [static]
 

Return the instance of the singleton object for this class.

Definition at line 25 of file kmbroadcaststatus.cpp.

void KMBroadcastStatus::setStatusMsg const QString message  ) 
 

Emit an update status bar signal.

Definition at line 36 of file kmbroadcaststatus.cpp.

References statusMsg().

Referenced by setStatusMsgWithTimestamp().

QString KMBroadcastStatus::statusMsg  )  const [inline]
 

Return the last status message from setStatusMsg().

Definition at line 39 of file kmbroadcaststatus.h.

Referenced by setStatusMsg().

void KMBroadcastStatus::setStatusMsgWithTimestamp const QString message  ) 
 

Sets a status bar message with timestamp.

Definition at line 42 of file kmbroadcaststatus.cpp.

References setStatusMsg().

Referenced by setStatusMsgTransmissionCompleted().

void KMBroadcastStatus::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 51 of file kmbroadcaststatus.cpp.

References setStatusMsgWithTimestamp().

void KMBroadcastStatus::statusMsg const QString  )  [signal]
 

Emitted when setStatusMsg is called.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kmail Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Mar 23 22:44:00 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003