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>

List of all members.

Public Slots

void requestAbort ()

Signals

void statusMsg (const QString &)
void statusProgressEnable (bool)
void statusProgressPercent (unsigned long)
void resetRequested ()
void signalAbortRequested ()
void signalUsingSSL (bool)

Public Member Functions

void setStatusMsg (const QString &)
void setStatusMsgWithTimestamp (const QString &message)
void setStatusMsgTransmissionCompleted (int numMessages, int numBytes=-1, int numBytesRead=-1, int numBytesToRead=-1, bool mLeaveOnServer=false)
void setStatusMsgTransmissionCompleted (const QString &account, int numMessages, int numBytes=-1, int numBytesRead=-1, int numBytesToRead=-1, bool mLeaveOnServer=false)
void setStatusProgressEnable (const QString &, bool)
void setStatusProgressPercent (const QString &, unsigned long)
void setUsingSSL (bool)
bool abortRequested ()
void reset ()

Static Public Member Functions

KMBroadcastStatusinstance ()

Protected Attributes

bool abortRequested_
QMap< QString, unsigned long > ids

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 32 of file kmbroadcaststatus.h.


Member Function Documentation

KMBroadcastStatus * KMBroadcastStatus::instance  )  [static]
 

Return the instance of the singleton object for this class.

Definition at line 35 of file kmbroadcaststatus.cpp.

Referenced by KMHeaders::setFolderInfoStatus().

void KMBroadcastStatus::setStatusMsg const QString &   ) 
 

Emit an update status bar signal.

Definition at line 52 of file kmbroadcaststatus.cpp.

References statusMsg().

Referenced by KMHeaders::setFolderInfoStatus(), and setStatusMsgWithTimestamp().

void KMBroadcastStatus::setStatusMsgWithTimestamp const QString &  message  ) 
 

Sets a status bar message with timestamp.

Definition at line 57 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
 

Sets a transmission completed status bar message.

Definition at line 66 of file kmbroadcaststatus.cpp.

References setStatusMsgWithTimestamp(), and statusMsg().

void KMBroadcastStatus::setStatusProgressEnable const QString &  ,
bool 
 

Emit an enable progress widget(s) in status bar(s) signal.

Definition at line 145 of file kmbroadcaststatus.cpp.

References setStatusProgressPercent(), and statusProgressEnable().

void KMBroadcastStatus::setStatusProgressPercent const QString &  ,
unsigned  long
 

Emit an update progress widget(s) percent completed signal.

Definition at line 157 of file kmbroadcaststatus.cpp.

References statusProgressPercent().

Referenced by setStatusProgressEnable().

void KMBroadcastStatus::setUsingSSL bool   ) 
 

Set if the acccount checking is using ssl.

Definition at line 47 of file kmbroadcaststatus.cpp.

bool KMBroadcastStatus::abortRequested  ) 
 

Returns true IFF the user has requested the current operation (the one whose progress is being shown) should be aborted.

Needs to be periodically polled in the implementation of the operation.

Definition at line 178 of file kmbroadcaststatus.cpp.

void KMBroadcastStatus::reset  ) 
 

Set the state of the abort requested variable to false.

Definition at line 171 of file kmbroadcaststatus.cpp.

References resetRequested().

void KMBroadcastStatus::statusMsg const QString &   )  [signal]
 

Emitted when setStatusMsg is called.

Referenced by setStatusMsg(), and setStatusMsgTransmissionCompleted().

void KMBroadcastStatus::statusProgressEnable bool   )  [signal]
 

Emitted when setStatusProgressEnable is called.

Referenced by setStatusProgressEnable().

void KMBroadcastStatus::statusProgressPercent unsigned  long  )  [signal]
 

Emitted when setStatusProgressPercent is called.

Referenced by setStatusProgressPercent().

void KMBroadcastStatus::resetRequested  )  [signal]
 

Emitted when reset is called.

Referenced by reset().

void KMBroadcastStatus::signalAbortRequested  )  [signal]
 

Emitted when user wants to abort the connection.

Referenced by requestAbort().

void KMBroadcastStatus::requestAbort  )  [slot]
 

Set the state of the abort requested variable to return.

Definition at line 183 of file kmbroadcaststatus.cpp.

References signalAbortRequested().


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.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Mon Apr 26 23:23:25 2004 by doxygen 1.3.6-20040222 written by Dimitri van Heesch, © 1997-2003