kmail

listjob.h

Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2004 Carsten Burghardt <burghardt@kde.org>
00003  *
00004  *  This program is free software; you can redistribute it and/or modify
00005  *  it under the terms of the GNU General Public License as published by
00006  *  the Free Software Foundation; version 2 of the License
00007  *
00008  *  This program is distributed in the hope that it will be useful,
00009  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00010  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00011  *  GNU General Public License for more details.
00012  *
00013  *  You should have received a copy of the GNU General Public License
00014  *  along with this program; if not, write to the Free Software
00015  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
00016  *
00017  *  In addition, as a special exception, the copyright holders give
00018  *  permission to link the code of this program with any edition of
00019  *  the Qt library by Trolltech AS, Norway (or with modified versions
00020  *  of Qt that use the same license as Qt), and distribute linked
00021  *  combinations including the two.  You must obey the GNU General
00022  *  Public License in all respects for all of the code used other than
00023  *  Qt.  If you modify this file, you may extend this exception to
00024  *  your version of the file, but you are not obligated to do so.  If
00025  *  you do not wish to do so, delete this exception statement from
00026  *  your version.
00027  */
00028 #ifndef LISTJOB_H
00029 #define LISTJOB_H
00030 
00031 #include "folderjob.h"
00032 #include "imapaccountbase.h"
00033 
00034 class KMFolderImap;
00035 class KMFolderCachedImap;
00036 class KMAcctImap;
00037 class KMAcctCachedImap;
00038 class FolderStorage;
00039 class KURL;
00040 
00041 namespace KIO {
00042   class Job;
00043 }
00044 
00045 namespace KPIM {
00046   class ProgressItem;
00047 }
00048 
00049 namespace KMail {
00050 
00054 class ListJob : public FolderJob
00055 {
00056   Q_OBJECT
00057 public:
00068   ListJob( ImapAccountBase* account, ImapAccountBase::ListType type,
00069            FolderStorage* storage = 0, const QString& path = QString::null,
00070            bool complete = false, KPIM::ProgressItem* item = 0 );
00071 
00072   virtual ~ListJob();
00073 
00079   void setHonorLocalSubscription( bool value );
00080 
00086   bool honorLocalSubscription() const;
00087 
00088   virtual void execute();
00089 
00091   void setPath( const QString& path ) { mPath = path; }
00092 
00094   void setStorage( FolderStorage* st ) { mStorage = st; }
00095 
00097   void setComplete( bool complete ) { mComplete = complete; }
00098 
00100   void setParentProgressItem( KPIM::ProgressItem* it ) {
00101     mParentProgressItem = it; }
00102 
00104   void setNamespace( const QString& ns ) { mNamespace = ns; }
00105 
00106 protected slots:
00111   void slotListResult( KIO::Job* job );
00112 
00116   void slotListEntries( KIO::Job* job, const KIO::UDSEntryList& uds );
00117 
00121   void slotConnectionResult( int errorCode, const QString& errorMsg );
00122 
00123 signals:
00127   void receivedFolders( const QStringList&, const QStringList&,
00128       const QStringList&, const QStringList&, const ImapAccountBase::jobData& );
00129 
00130 protected:
00131   FolderStorage* mStorage;
00132   ImapAccountBase* mAccount;
00133   ImapAccountBase::ListType mType;
00134   bool mComplete;
00135   bool mHonorLocalSubscription;
00136   QString mPath;
00137   QStringList mSubfolderNames, mSubfolderPaths,
00138               mSubfolderMimeTypes, mSubfolderAttributes;
00139   KPIM::ProgressItem* mParentProgressItem;
00140   QString mNamespace;
00141 };
00142 
00143 } // namespace
00144 
00145 #endif /* LISTJOB_H */
00146