knode/knfoldermanager.h

   1 /*
   2     KNode, the KDE newsreader
   3     Copyright (c) 1999-2005 the KNode authors.
   4     See file AUTHORS for details
   5
   6     This program is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10     You should have received a copy of the GNU General Public License
  11     along with this program; if not, write to the Free Software Foundation,
  12     Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, US
  13 */
  14
  15 #ifndef KNFOLDERMANAGER_H
  16 #define KNFOLDERMANAGER_H
  17
  18 #include "knfolder.h"
  19
  20 #include <QList>
  21 #include <QObject>
  22
  23 class KNArticleManager;
  24 class KNCleanUp;
  25
  26
  27 /** Folder manager. */
  28 class KNFolderManager : public QObject
  29 {
  30   Q_OBJECT
  31
  32   public:
  33     KNFolderManager(KNArticleManager *a);
  34     ~KNFolderManager();
  35
  36     //folder access
  37     void setCurrentFolder( KNFolder::Ptr f );
  38     KNFolder::Ptr currentFolder() const { return c_urrentFolder; }
  39     bool hasCurrentFolder() const         { return (c_urrentFolder!=0); }
  40     KNFolder::Ptr folder( int id );
  41     KNFolder::List folders() const { return mFolderList; }
  42
  43     /// Returns the root folder.
  44     KNFolder::Ptr root() const { return mFolderList[0]; }
  45     /// Returns the drafts folder.
  46     KNFolder::Ptr drafts() const { return mFolderList[1]; }
  47     /// Returns the outbox folder.
  48     KNFolder::Ptr outbox() const { return mFolderList[2]; }
  49     /// Returns the sent folder.
  50     KNFolder::Ptr sent() const { return mFolderList[3]; }
  51
  52     //header loading
  53     bool loadHeaders( KNFolder::Ptr f );
  54     bool unloadHeaders( KNFolder::Ptr f, bool force = true );
  55     bool loadDrafts()                     { return loadHeaders(drafts()); }
  56     bool loadOutbox()                     { return loadHeaders(outbox()); }
  57     bool loadSent()                       { return loadHeaders(sent()); }
  58
  59     // returns the new folder
  60     KNFolder::Ptr newFolder( KNFolder::Ptr p );
  61     bool deleteFolder( KNFolder::Ptr f );
  62     void emptyFolder( KNFolder::Ptr f );
  63
  64     /**
  65       Returns true if the folder @p f can be moved under
  66       a new parent @p p.
  67     */
  68     bool canMoveFolder( KNFolder::Ptr f, KNFolder::Ptr p );
  69     /**
  70       Move the folder @p f to a new parent @p p.
  71       @returns false if the move is not possible.
  72     */
  73     bool moveFolder( KNFolder::Ptr f, KNFolder::Ptr p );
  74
  75     //unsent articles
  76     int unsentForAccount(int accId);
  77
  78     //compacting
  79     void compactFolder( KNFolder::Ptr f );
  80     void compactAll(KNCleanUp *cup);
  81     void compactAll();
  82
  83     // import + export
  84     void importFromMBox( KNFolder::Ptr f );
  85     void exportToMBox( KNFolder::Ptr f );
  86
  87     //synchronization
  88     void syncFolders();
  89
  90   signals:
  91     // signals for the collection tree to update the UI
  92     /**
  93      * Emitted when a folder is added.
  94      */
  95     void folderAdded( KNFolder::Ptr f );
  96     /**
  97      * Emitted when a folder is removed.
  98      */
  99     void folderRemoved( KNFolder::Ptr f );
 100     void folderActivated( KNFolder::Ptr f );
 101
 102   protected:
 103     int loadCustomFolders();
 104
 105     KNFolder::Ptr c_urrentFolder;
 106     KNFolder::List mFolderList;
 107     int l_astId;
 108     KNArticleManager *a_rtManager;
 109
 110 };
 111
 112 #endif