libkdepim Library API Documentation

KPIM::BroadcastStatus Class Reference

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

#include <broadcaststatus.h>

Inheritance diagram for KPIM::BroadcastStatus:

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

BroadcastStatusinstance ()

Protected Attributes

QString mStatusMsg
bool mTransientActive

Static Protected Attributes

BroadcastStatusinstance_ = 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.

Definition at line 30 of file broadcaststatus.h.


Member Function Documentation

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

Return the instance of the singleton object for this class.

Definition at line 31 of file broadcaststatus.cpp.

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

Return the last status message from setStatusMsg().

Definition at line 42 of file broadcaststatus.h.

Referenced by reset(), setStatusMsg(), setStatusMsgTransmissionCompleted(), and setTransientStatusMsg().

void KPIM::BroadcastStatus::setStatusMsgWithTimestamp const QString message  ) 
 

Sets a status bar message with timestamp.

Definition at line 56 of file broadcaststatus.cpp.

References setStatusMsg().

Referenced by setStatusMsgTransmissionCompleted().

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

References setStatusMsgWithTimestamp(), and statusMsg().

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

References statusMsg().

Referenced by setStatusMsgWithTimestamp().

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

References statusMsg().

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

References statusMsg().

void KPIM::BroadcastStatus::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 libkdepim Library Version 3.3.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Fri Oct 1 15:18:56 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003