kmfoldermgr.h

/* KMail Folder Manager
 *
 */
#ifndef kmfoldermgr_h
#define kmfoldermgr_h
 
#include <tqstring.h>
#include <tqvaluelist.h>
#include <tqobject.h>
#include <tqguardedptr.h>
 
#include "kmfolderdir.h"
 
class KMFolder;
 
class KMFolderMgr: public TQObject
{
  TQ_OBJECT
  
 
public:
  KMFolderMgr(const TQString& basePath, KMFolderDirType dirType = KMStandardDir);
  virtual ~KMFolderMgr();

  TQString basePath() const { return mBasePath; }

  virtual void setBasePath(const TQString&);

  KMFolderRootDir& dir();

  virtual KMFolder* find(const TQString& folderName, bool foldersOnly=true);

  virtual KMFolder* findIdString(const TQString& folderId,
     const uint id = 0, KMFolderDir *dir = 0);

  virtual KMFolder* findOrCreate(const TQString& folderName, bool sysFldr=true,
      const uint id = 0);

  virtual KMFolder* findById(const uint id);
 
  virtual void        getFolderURLS( TQStringList& flist,
                                     const TQString& prefix=TQString(),
                                     KMFolderDir *adir=0 );
  virtual KMFolder*   getFolderByURL( const TQString& vpath,
                                      const TQString& prefix=TQString(),
                                      KMFolderDir *adir=0 );

  virtual KMFolder* createFolder(const TQString& fName, bool sysFldr=false,
                 KMFolderType aFolderType=KMFolderTypeMbox,
                 KMFolderDir *aFolderDir = 0);

  virtual void remove(KMFolder* obsoleteFolder);

  virtual void contentsChanged(void);

  virtual void reload(void);

  virtual void createFolderList( TQStringList *str,
                 TQValueList<TQGuardedPtr<KMFolder> > *folders );

  virtual void createFolderList( TQStringList *str,
                 TQValueList<TQGuardedPtr<KMFolder> > *folders,
                 KMFolderDir *adir,
                 const TQString& prefix,
                 bool i18nized=false );

  virtual void createI18nFolderList( TQStringList *str,
                 TQValueList<TQGuardedPtr<KMFolder> > *folders );

  void syncAllFolders( KMFolderDir *adir = 0 );

  void compactAllFolders( bool immediate, KMFolderDir *adir = 0 );

  void expireAllFolders( bool immediate, KMFolderDir *adir = 0 );

  void quiet(bool);

  int folderCount(KMFolderDir *dir=0);

  void tryReleasingFolder(KMFolder* folder, KMFolderDir *Dir=0);

  uint createId();

  void moveFolder( KMFolder* folder, KMFolderDir* newParent );

  void renameFolder( KMFolder* folder, const TQString& newName, 
      KMFolderDir* newParent = 0 );
  
  void copyFolder( KMFolder* folder, KMFolderDir* newParent );

  KMFolder* parentFolder( KMFolder* folder );
 
public slots:
  void compactAll() { compactAllFolders( true ); }

  void expireAll();

  void removeFolderAux(KMFolder* obsoleteFolder, bool success);

  void slotRenameDone( TQString newName, bool success );
 
signals:
  void changed();

  void folderRemoved(KMFolder*);

  void folderAdded(KMFolder*);

  void folderInvalidated(KMFolder*);

  void msgAdded(KMFolder*, TQ_UINT32);

  void msgRemoved(KMFolder*, TQ_UINT32);

  void msgChanged(KMFolder*, TQ_UINT32, int delta);

  void msgHeaderChanged(KMFolder*, int idx);

  void folderMoveOrCopyOperationFinished();
 
protected:

  void removeFolder(KMFolder* aFolder);

  void removeDirAux(KMFolderDir* aFolderDir);
 
  TQString mBasePath;
  KMFolderRootDir mDir;
  int mQuiet;
  bool mChanged;
  KMFolder* mRemoveOrig;
};
 
#endif /*kmfoldermgr_h*/