folderjob.h

/*
 *
 *  This file is part of KMail, the KDE mail client.
 *  Copyright (c) 2003 Zack Rusin <zack@kde.org>
 *
 *  KMail is free software; you can redistribute it and/or modify it
 *  under the terms of the GNU General Public License, version 2, as
 *  published by the Free Software Foundation.
 *
 *  KMail is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 *  In addition, as a special exception, the copyright holders give
 *  permission to link the code of this program with any edition of
 *  the TQt library by Trolltech AS, Norway (or with modified versions
 *  of TQt that use the same license as TQt), and distribute linked
 *  combinations including the two.  You must obey the GNU General
 *  Public License in all respects for all of the code used other than
 *  TQt.  If you modify this file, you may extend this exception to
 *  your version of the file, but you are not obligated to do so.  If
 *  you do not wish to do so, delete this exception statement from
 *  your version.
 */
 
#ifndef FOLDERJOB_H
#define FOLDERJOB_H
 
#include "kmmessage.h"
 
#include <tqobject.h>
#include <tqptrlist.h>
#include <tqstring.h>
 
class KMFolder;
 
namespace KMail {
 
class FolderJob : public TQObject
{
  TQ_OBJECT
  
 
public:
  enum JobType { tListMessages, tGetFolder, tCreateFolder, tExpungeFolder,
         tDeleteMessage, tGetMessage, tPutMessage, tAddSubfolders,
         tDeleteFolders, tCheckUidValidity, tRenameFolder,
                 tCopyMessage, tMoveMessage, tOther /* used by subclasses */ };
  FolderJob( KMMessage *msg, JobType jt = tGetMessage, KMFolder *folder = 0,
        TQString partSpecifier = TQString() );

  FolderJob( const TQPtrList<KMMessage>& msgList, const TQString& sets,
         JobType jt = tGetMessage, KMFolder *folder = 0 );
  FolderJob( JobType jt );
  virtual ~FolderJob();
 
  TQPtrList<KMMessage> msgList() const;
  void start();

  virtual void kill();

  int error() const { return mErrorCode; }

  bool isCancellable() const { return mCancellable; }

  void setCancellable( bool b ) { mCancellable = b; }
 
  void setPassiveDestructor( bool passive ) { mPassiveDestructor = passive; }
  bool passiveDestructor() { return mPassiveDestructor; }
 
signals:
  void messageRetrieved( KMMessage * );

  void messageUpdated( KMMessage *, TQString );

  void messageStored( KMMessage * );

  void messageCopied( TQPtrList<KMMessage> );

  void messageCopied( KMMessage * );

  void finished();

  void result( KMail::FolderJob* job );

  void progress( unsigned long bytesDownloaded, unsigned long bytesTotal );
 
private:
  void init();
 
protected:
  virtual void execute()=0;
 
  TQPtrList<KMMessage> mMsgList;
  JobType             mType;
  TQString             mSets;
  KMFolder*           mSrcFolder;
  KMFolder*           mDestFolder;
  TQString             mPartSpecifier;
  int                 mErrorCode;
 
  //finished() won't be emitted when this is set
  bool                mPassiveDestructor;
  bool                mStarted;
  bool                mCancellable;
};
 
}
 
#endif