diff options
Diffstat (limited to 'libkdepim/broadcaststatus.h')
-rw-r--r-- | libkdepim/broadcaststatus.h | 93 |
1 files changed, 93 insertions, 0 deletions
diff --git a/libkdepim/broadcaststatus.h b/libkdepim/broadcaststatus.h new file mode 100644 index 000000000..e15ca87db --- /dev/null +++ b/libkdepim/broadcaststatus.h @@ -0,0 +1,93 @@ +/* + broadcaststatus.h + + This file is part of KDEPIM. + + Copyright (C) 2000 Don Sanders <sanders@kde.org> + + License GPL +*/ + +#ifndef __kpim_broadcast_status_h +#define __kpim_broadcast_status_h + +#include <qobject.h> +#include <qmap.h> + +#include <kdepimmacros.h> + +#undef None + +namespace KPIM { + +class ProgressItem; + +/** + 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. + */ + + +class KDE_EXPORT BroadcastStatus : public QObject +{ + + Q_OBJECT + +public: + virtual ~BroadcastStatus(); + + /** Return the instance of the singleton object for this class */ + static BroadcastStatus *instance(); + + /** Return the last status message from setStatusMsg() */ + QString statusMsg() const { return mStatusMsg; } + /** Sets a status bar message with timestamp */ + void setStatusMsgWithTimestamp( const QString& message ); + /** Sets a transmission completed status bar message */ + void setStatusMsgTransmissionCompleted( int numMessages, + int numBytes = -1, + int numBytesRead = -1, + int numBytesToRead = -1, + bool mLeaveOnServer = false, + KPIM::ProgressItem* progressItem = 0 ); // set the same status in this progress item + void setStatusMsgTransmissionCompleted( const QString& account, + int numMessages, + int numBytes = -1, + int numBytesRead = -1, + int numBytesToRead = -1, + bool mLeaveOnServer = false, + KPIM::ProgressItem* progressItem = 0 ); // set the same status in this progress item + +public slots: + /** Emit an update status bar signal. It's a slot so it can be hooked up + to other signals. */ + void setStatusMsg( const QString& message ); + + /** + Set a status message that will go away again with the next call of + reset(). + */ + void setTransientStatusMsg( const QString& msg ); + /** + Reset the status message to what ever non-transient message was last + active or has since been set. + */ + void reset(); + +signals: + + /** Emitted when setStatusMsg is called. */ + void statusMsg( const QString& ); + +protected: + + BroadcastStatus(); + QString mStatusMsg; + bool mTransientActive; + static BroadcastStatus* instance_; +}; + + +} +#endif |