libkdepim/broadcaststatus.h

   1 /*
   2   broadcaststatus.h
   3
   4   This file is part of libkdepim.
   5
   6   Copyright (C) 2000 Don Sanders <sanders@kde.org>
   7
   8   This program is free software; you can redistribute it and/or modify
   9   it under the terms of the GNU General Public License as published by
  10   the Free Software Foundation; either version 2 of the License, or
  11   (at your option) any later version.
  12
  13   This program is distributed in the hope that it will be useful,
  14   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16   GNU General Public License for more details.
  17
  18   You should have received a copy of the GNU General Public License along
  19   with this program; if not, write to the Free Software Foundation, Inc.,
  20   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21 */
  22
  23 #ifndef KDEPIM_BROADCASTSTATUS_H
  24 #define KDEPIM_BROADCASTSTATUS_H
  25
  26 #include "kdepim_export.h"
  27 #include <QObject>
  28
  29 #undef None
  30
  31 namespace KPIM {
  32
  33 class ProgressItem;
  34
  35 /**
  36    Provides a singleton which broadcasts status messages by emitting
  37    signals. Interested mainwindows can connect to the statusMsg()
  38    signal and update statusBars or whatever they use for showing status.
  39 */
  40 class KDEPIM_EXPORT BroadcastStatus : public QObject
  41 {
  42
  43   Q_OBJECT
  44
  45   public:
  46     virtual ~BroadcastStatus();
  47
  48     /** Return the instance of the singleton object for this class */
  49     static BroadcastStatus *instance();
  50
  51     /** Return the last status message from setStatusMsg() */
  52     QString statusMsg() const { return mStatusMsg; }
  53
  54     /** Sets a status bar message with timestamp */
  55     void setStatusMsgWithTimestamp( const QString &message );
  56
  57     /** Sets a transmission completed status bar message */
  58     void setStatusMsgTransmissionCompleted( int numMessages,
  59                                             int numBytes = -1,
  60                                             int numBytesRead = -1,
  61                                             int numBytesToRead = -1,
  62                                             bool mLeaveOnServer = false,
  63                                             KPIM::ProgressItem *progressItem = 0 );
  64     void setStatusMsgTransmissionCompleted( const QString &account,
  65                                             int numMessages,
  66                                             int numBytes = -1,
  67                                             int numBytesRead = -1,
  68                                             int numBytesToRead = -1,
  69                                             bool mLeaveOnServer = false,
  70                                             KPIM::ProgressItem *progressItem = 0 );
  71
  72   public Q_SLOTS:
  73     /**
  74       Emit an update status bar signal. It's a slot so it can be hooked up
  75       to other signals.
  76     */
  77     void setStatusMsg( const QString &message );
  78
  79     /**
  80       Set a status message that will go away again with the next call of
  81       reset().
  82     */
  83     void setTransientStatusMsg( const QString &msg );
  84
  85     /**
  86       Reset the status message to what ever non-transient message was last
  87       active or has since been set.
  88      */
  89     void reset();
  90
  91   Q_SIGNALS:
  92     /** Emitted when setStatusMsg is called. */
  93     void statusMsg( const QString & );
  94
  95   protected:
  96     BroadcastStatus();
  97     QString mStatusMsg;
  98     bool mTransientActive;
  99 };
 100
 101 }
 102
 103 #endif