libkdepim

KPIM::BroadcastStatus Class Reference

#include <broadcaststatus.h>

List of all members.


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


Public Slots

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

Signals

void statusMsg (const QString &)

Public Member Functions

virtual ~BroadcastStatus ()
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 BroadcastStatusinstance ()

Protected Member Functions

 BroadcastStatus ()

Protected Attributes

QString mStatusMsg
bool mTransientActive

Static Protected Attributes

static BroadcastStatusinstance_

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 44 of file broadcaststatus.h.

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

Sets a status bar message with timestamp.

Definition at line 56 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 65 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 49 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 150 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 156 of file broadcaststatus.cpp.

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

Emitted when setStatusMsg is called.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys