kmfilter.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 kmfilter_h
#define kmfilter_h
 
#include "kmsearchpattern.h"
#include "kmpopheaders.h"
 
#include <tdeshortcut.h>
 
#include <tqptrlist.h>
 
class TQString;
class TDEConfig;
class KMMessage;
class KMFilterAction;
class KMFolder;
 
// maximum number of filter actions per filter
const int FILTER_MAX_ACTIONS = 8;
 
 
class KMFilter
{
public:
  enum ReturnCode { NoResult, GoOn, CriticalError };
 
  enum AccountType { All, ButImap, Checked };
 
  KMFilter( TDEConfig* aConfig=0 , bool popFilter = false);
 
  KMFilter( const KMFilter & other );
 
  ~KMFilter() {}
 
  TQString name() const {
    return mPattern.name();
  }
 
  ReturnCode execActions( KMMessage* msg, bool& stopIt ) const ;
 
  bool requiresBody(KMMsgBase* msgBase);
 
  KMPopFilterAction action();
 
  void setAction(const KMPopFilterAction aAction);
 
  void writeConfig( TDEConfig* config ) const;
 
  void readConfig( TDEConfig* config );
 
  void purify();
 
  bool isEmpty() const;
 
  TQPtrList<KMFilterAction>* actions() { return &mActions; }
 
  const TQPtrList<KMFilterAction>* actions() const { return &mActions; }
 
  KMSearchPattern* pattern() { return &mPattern; }
 
  const KMSearchPattern* pattern() const { return &mPattern; }
 
  void setApplyOnOutbound( bool aApply=true ) { bApplyOnOutbound = aApply; }
 
  bool applyOnOutbound() const { return bApplyOnOutbound; }
 
  void setApplyOnInbound( bool aApply=true ) { bApplyOnInbound = aApply; }
 
  bool applyOnInbound() const { return bApplyOnInbound; }
 
  void setApplyOnExplicit( bool aApply=true ) { bApplyOnExplicit = aApply; }
 
  bool applyOnExplicit() const { return bApplyOnExplicit; }
 
  void setApplicability( AccountType aApply=All ) { mApplicability = aApply; }
 
  AccountType applicability() const { return mApplicability; }
 
  void setApplyOnAccount( uint id, bool aApply=true );
 
  bool applyOnAccount( uint id ) const;
 
  void setStopProcessingHere( bool aStop ) { bStopProcessingHere = aStop; }
  bool stopProcessingHere() const { return bStopProcessingHere; }
 
  void setConfigureShortcut( bool aShort ) {
    bConfigureShortcut = aShort;
    bConfigureToolbar = bConfigureToolbar && bConfigureShortcut;
  }
 
  bool configureShortcut() const { return bConfigureShortcut; }
 
  void setConfigureToolbar( bool aTool ) {
    bConfigureToolbar = aTool && bConfigureShortcut;
  }
 
  bool configureToolbar() const { return bConfigureToolbar; }
 
  void setShortcut( const TDEShortcut & shortcut ) { mShortcut = shortcut; };
 
  const TDEShortcut & shortcut() const { return mShortcut; }
 
  void setIcon( TQString icon ) { mIcon = icon; }
 
  TQString icon() const { return mIcon; }
 
  bool folderRemoved( KMFolder* aFolder, KMFolder* aNewFolder );
 
#ifndef NDEBUG
  const TQString asString() const;
#endif
 
  bool isPopFilter() const {
    return bPopFilter;
  }
 
  void setAutoNaming( bool useAutomaticNames ) {
    bAutoNaming = useAutomaticNames;
  }
 
  bool isAutoNaming() const { return bAutoNaming; }
 
private:
  KMSearchPattern mPattern;
  TQPtrList<KMFilterAction> mActions;
  TQValueList<int> mAccounts;
  KMPopFilterAction mAction;
  TQString mIcon;
  TDEShortcut mShortcut;
  bool bPopFilter : 1;
  bool bApplyOnInbound : 1;
  bool bApplyOnOutbound : 1;
  bool bApplyOnExplicit : 1;
  bool bStopProcessingHere : 1;
  bool bConfigureShortcut : 1;
  bool bConfigureToolbar : 1;
  bool bAutoNaming : 1;
  AccountType mApplicability;
};
 
#endif /*kmfilter_h*/