kmfiltermgr.h

/*
 * kmail: KDE mail client
 * Copyright (c) 1996-1998 Stefan Taferner <taferner@kde.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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.
 *
 */
#ifndef kmfiltermgr_h
#define kmfiltermgr_h
 
#include "kmfilteraction.h" // for KMFilterAction::ReturnCode
#include "kmfolder.h"
 
#include <tqguardedptr.h>
#include <tqobject.h>
 
class KMFilter;
class KMFilterDlg;
template <typename T> class TQValueVector;
template <typename T> class TQValueList;
 
class KMFilterMgr: public TQObject
{
  TQ_OBJECT
  
 
public:
  KMFilterMgr(bool popFilter = false);
  virtual ~KMFilterMgr();

  void clear();
 
  enum FilterSet { NoSet = 0x0, Inbound = 0x1, Outbound = 0x2, Explicit = 0x4,
           All = Inbound|Outbound|Explicit };

  void readConfig(void);

  void writeConfig(bool withSync=true);
  
  void openDialog( TQWidget *parent, bool checkForEmptyFilterList = true );

  void createFilter( const TQCString & field, const TQString & value );
 
  bool beginFiltering(KMMsgBase *msgBase) const;
  int moveMessage(KMMessage *msg) const;
  void endFiltering(KMMsgBase *msgBase) const;

  bool atLeastOneFilterAppliesTo( unsigned int accountID ) const;
  bool atLeastOneIncomingFilterAppliesTo( unsigned int accountID ) const;
  bool atLeastOneOnlineImapFolderTarget();

  const TQString createUniqueName( const TQString & name );

  void appendFilters( const TQValueList<KMFilter*> &filters,
                      bool replaceIfNameExists = false );

  void setFilters( const TQValueList<KMFilter*> &filters );

  const TQValueList<KMFilter*> & filters() const { return mFilters; }

  int process( KMMessage * msg, FilterSet aSet = Inbound,
           bool account = false, uint accountId = 0 );

  int process( KMMessage * msg, const KMFilter * filter );

  int process( TQ_UINT32 serNum, const KMFilter * filter );
 
  void cleanup();
  void ref();
  void deref(bool force = false);

  int tempOpenFolder(KMFolder* aFolder);

  void beginUpdate() {}

  void endUpdate();

#ifndef NDEBUG
  void dump() const;
#endif

  bool folderRemoved(KMFolder* aFolder, KMFolder* aNewFolder);

  void folderCreated(KMFolder*) {}

  void setShowLaterMsgs( bool show ) {
    mShowLater = show;
  }

  bool showLaterMsgs() const {
    return mShowLater;
  }
public slots:
  void slotFolderRemoved( KMFolder *aFolder );
 
signals:
  void filterListUpdated();
 
private:
  int processPop( KMMessage *msg ) const;
  bool isMatching( TQ_UINT32 serNum, const KMFilter *filter );
 
  TQGuardedPtr<KMFilterDlg> mEditDialog;
  TQValueVector<KMFolder *> mOpenFolders;
  TQValueList<KMFilter *> mFilters;
  bool bPopFilter;
  bool mShowLater;
  bool mDirtyBufferedFolderTarget;
  bool mBufferedFolderTarget;
 
  int mRefCount;
};
 
#endif /*kmfiltermgr_h*/