kmail

folderjob.h

Go to the documentation of this file.
00001 /*  -*- mode: C++; c-file-style: "gnu" -*-
00002  *
00003  *  This file is part of KMail, the KDE mail client.
00004  *  Copyright (c) 2003 Zack Rusin <zack@kde.org>
00005  *
00006  *  KMail is free software; you can redistribute it and/or modify it
00007  *  under the terms of the GNU General Public License, version 2, as
00008  *  published by the Free Software Foundation.
00009  *
00010  *  KMail is distributed in the hope that it will be useful, but
00011  *  WITHOUT ANY WARRANTY; without even the implied warranty of
00012  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013  *  General Public License for more details.
00014  *
00015  *  You should have received a copy of the GNU General Public License
00016  *  along with this program; if not, write to the Free Software
00017  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
00018  *
00019  *  In addition, as a special exception, the copyright holders give
00020  *  permission to link the code of this program with any edition of
00021  *  the Qt library by Trolltech AS, Norway (or with modified versions
00022  *  of Qt that use the same license as Qt), and distribute linked
00023  *  combinations including the two.  You must obey the GNU General
00024  *  Public License in all respects for all of the code used other than
00025  *  Qt.  If you modify this file, you may extend this exception to
00026  *  your version of the file, but you are not obligated to do so.  If
00027  *  you do not wish to do so, delete this exception statement from
00028  *  your version.
00029  */
00030 
00031 #ifndef FOLDERJOB_H
00032 #define FOLDERJOB_H
00033 
00034 #include "kmmessage.h"
00035 
00036 #include <qobject.h>
00037 #include <qptrlist.h>
00038 #include <qstring.h>
00039 
00040 class KMFolder;
00041 
00042 namespace KMail {
00043 
00044 class FolderJob : public QObject
00045 {
00046   Q_OBJECT
00047 
00048 public:
00049   enum JobType { tListMessages, tGetFolder, tCreateFolder, tExpungeFolder,
00050          tDeleteMessage, tGetMessage, tPutMessage, tAddSubfolders,
00051          tDeleteFolders, tCheckUidValidity, tRenameFolder,
00052                  tCopyMessage, tMoveMessage, tOther /* used by subclasses */ };
00057   FolderJob( KMMessage *msg, JobType jt = tGetMessage, KMFolder *folder = 0,
00058         QString partSpecifier = QString::null );
00059 
00065   FolderJob( const QPtrList<KMMessage>& msgList, const QString& sets,
00066          JobType jt = tGetMessage, KMFolder *folder = 0 );
00072   FolderJob( JobType jt );
00073   virtual ~FolderJob();
00074 
00075   QPtrList<KMMessage> msgList() const;
00079   void start();
00080 
00086   virtual void kill();
00087 
00092   int error() const { return mErrorCode; }
00093 
00097   bool isCancellable() const { return mCancellable; }
00098 
00105   void setCancellable( bool b ) { mCancellable = b; }
00106 
00107   void setPassiveDestructor( bool passive ) { mPassiveDestructor = passive; }
00108   bool passiveDestructor() { return mPassiveDestructor; }
00109 
00110 signals:
00115   void messageRetrieved( KMMessage * );
00116 
00120   void messageUpdated( KMMessage *, QString );
00121 
00126   void messageStored( KMMessage * );
00127 
00133   void messageCopied( QPtrList<KMMessage> );
00134 
00140   void messageCopied( KMMessage * );
00141 
00145   void finished();
00146 
00153   void result( KMail::FolderJob* job );
00154 
00160   void progress( unsigned long bytesDownloaded, unsigned long bytesTotal );
00161 
00162 private:
00163   void init();
00164 
00165 protected:
00170   virtual void execute()=0;
00171 
00172   QPtrList<KMMessage> mMsgList;
00173   JobType             mType;
00174   QString             mSets;
00175   KMFolder*           mSrcFolder;
00176   KMFolder*           mDestFolder;
00177   QString             mPartSpecifier;
00178   int                 mErrorCode;
00179 
00180   //finished() won't be emitted when this is set
00181   bool                mPassiveDestructor;
00182   bool                mStarted;
00183   bool                mCancellable;
00184 };
00185 
00186 }
00187 
00188 #endif