kmfilteraction.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 kmfilteraction_h
#define kmfilteraction_h
 
#include <kmime_mdn.h>
 
#include <tqstring.h>
#include <tqstringlist.h>
#include <tqdict.h>
#include <tqptrlist.h>
#include <tqvaluelist.h>
#include <tqguardedptr.h>
#include <tqwidget.h>
 
class KMMsgBase;
class KMMessage;
class TQWidget;
class KMFolder;
class KTempFile;
 
//=========================================================
//
// class KMFilterAction
//
//=========================================================
 
 
class KMFilterAction
{
public:
  enum ReturnCode { ErrorNeedComplete = 0x1, GoOn = 0x2, ErrorButGoOn = 0x4,
            CriticalError = 0x8 };
  KMFilterAction(const char* aName, const TQString aLabel);
  virtual ~KMFilterAction();
 
  const TQString label() const { return mLabel; }
 
  const TQString name() const { return mName; }
 
  virtual ReturnCode process(KMMessage* msg) const = 0;
 
  virtual void processAsync(KMMessage* msg) const;
 
  virtual bool requiresBody(KMMsgBase* msgBase) const;
 
  virtual bool isEmpty() const { return FALSE; }
 
  virtual TQWidget* createParamWidget(TQWidget* parent) const;
 
  virtual void applyParamWidgetValue(TQWidget* paramWidget);
 
  virtual void setParamWidgetValue(TQWidget* paramWidget) const;
 
  virtual void clearParamWidget(TQWidget* paramWidget) const;
 
  virtual void argsFromString(const TQString argsStr) = 0;
 
  virtual const TQString argsAsString() const = 0;
 
  virtual const TQString displayString() const = 0;
 
  virtual bool folderRemoved(KMFolder* aFolder, KMFolder* aNewFolder);
 
  static KMFilterAction* newAction();
 
  static int tempOpenFolder(KMFolder* aFolder);
 
  static void sendMDN( KMMessage * msg, KMime::MDN::DispositionType d,
               const TQValueList<KMime::MDN::DispositionModifier> & m
               =TQValueList<KMime::MDN::DispositionModifier>() );
 
private:
  TQString mName;
  TQString mLabel;
};
 
//=========================================================
//
// class KMFilterActionWithNone
//
//=========================================================
 
 
class KMFilterActionWithNone : public KMFilterAction
{
public:
  KMFilterActionWithNone(const char* aName, const TQString aLabel);
 
  virtual void argsFromString(const TQString) {};
 
  virtual const TQString argsAsString() const { return TQString(); }
 
  virtual const TQString displayString() const;
};
 
 
//=========================================================
//
// class KMFilterActionWithString
//
//=========================================================
 
 
class KMFilterActionWithString : public KMFilterAction
{
public:
  KMFilterActionWithString(const char* aName, const TQString aLabel);
 
  virtual bool isEmpty() const { return mParameter.stripWhiteSpace().isEmpty(); }
 
  virtual TQWidget* createParamWidget(TQWidget* parent) const;
 
  virtual void applyParamWidgetValue(TQWidget* paramWidget);
 
  virtual void setParamWidgetValue(TQWidget* paramWidget) const;
 
  virtual void clearParamWidget(TQWidget* paramWidget) const;
 
  virtual void argsFromString(const TQString argsStr);
 
  virtual const TQString argsAsString() const;
 
  virtual const TQString displayString() const;
 
protected:
  TQString mParameter;
};
 
//=========================================================
//
// class KMFilterActionWithUOID
//
//=========================================================
 
 
class KMFilterActionWithUOID : public KMFilterAction
{
public:
  KMFilterActionWithUOID(const char* aName, const TQString aLabel);
 
  virtual bool isEmpty() const { return mParameter == 0; }
 
  virtual void argsFromString(const TQString argsStr);
 
  virtual const TQString argsAsString() const;
 
  virtual const TQString displayString() const;
 
protected:
  uint mParameter;
};
 
//=========================================================
//
// class KMFilterActionWithStringList
//
//=========================================================
 
 
class KMFilterActionWithStringList : public KMFilterActionWithString
{
public:
  KMFilterActionWithStringList(const char* aName, const TQString aLabel);
 
  virtual TQWidget* createParamWidget(TQWidget* parent) const;
 
  virtual void applyParamWidgetValue(TQWidget* paramWidget);
 
  virtual void setParamWidgetValue(TQWidget* paramWidget) const;
 
  virtual void clearParamWidget(TQWidget* paramWidget) const;
 
  virtual void argsFromString(const TQString argsStr);
 
protected:
  TQStringList mParameterList;
};
 
 
//=========================================================
//
// class KMFilterActionWithFolder
//
//=========================================================
 
 
class KMFilterActionWithFolder : public KMFilterAction
{
public:
  KMFilterActionWithFolder(const char* aName, const TQString aLabel);
 
  virtual bool isEmpty() const { return (!mFolder && mFolderName.isEmpty()); }
 
  virtual TQWidget* createParamWidget(TQWidget* parent) const;
 
  virtual void applyParamWidgetValue(TQWidget* paramWidget);
 
  virtual void setParamWidgetValue(TQWidget* paramWidget) const;
 
  virtual void clearParamWidget(TQWidget* paramWidget) const;
 
  virtual void argsFromString(const TQString argsStr);
 
  virtual const TQString argsAsString() const;
 
  virtual const TQString displayString() const;
 
  virtual bool folderRemoved(KMFolder* aFolder, KMFolder* aNewFolder);
 
protected:
  TQGuardedPtr<KMFolder> mFolder;
  TQString mFolderName;
};
 
//=========================================================
//
// class KMFilterActionWithAddress
//
//=========================================================
 
 
class KMFilterActionWithAddress : public KMFilterActionWithString
{
public:
  KMFilterActionWithAddress(const char* aName, const TQString aLabel);
 
  virtual TQWidget* createParamWidget(TQWidget* parent) const;
 
  virtual void applyParamWidgetValue(TQWidget* paramWidget);
 
  virtual void setParamWidgetValue(TQWidget* paramWidget) const;
 
  virtual void clearParamWidget(TQWidget* paramWidget) const;
};
 
//=========================================================
//
// class KMFilterActionWithCommand
//
//=========================================================
 
 
class KMFilterActionWithUrl : public KMFilterAction
{
public:
    KMFilterActionWithUrl(const char* aName, const TQString aLabel);
    ~KMFilterActionWithUrl();
  virtual bool isEmpty() const { return mParameter.stripWhiteSpace().isEmpty(); }
 
  virtual TQWidget* createParamWidget(TQWidget* parent) const;
 
  virtual void applyParamWidgetValue(TQWidget* paramWidget);
 
  virtual void setParamWidgetValue(TQWidget* paramWidget) const;
 
  virtual void clearParamWidget(TQWidget* paramWidget) const;
 
  virtual void argsFromString(const TQString argsStr);
 
  virtual const TQString argsAsString() const;
 
  virtual const TQString displayString() const;
 
protected:
  TQString mParameter;
};
 
 
class KMFilterActionWithCommand : public KMFilterActionWithUrl
{
public:
  KMFilterActionWithCommand(const char* aName, const TQString aLabel);
 
  virtual TQWidget* createParamWidget(TQWidget* parent) const;
 
  virtual void applyParamWidgetValue(TQWidget* paramWidget);
 
  virtual void setParamWidgetValue(TQWidget* paramWidget) const;
 
  virtual void clearParamWidget(TQWidget* paramWidget) const;
 
  virtual TQString substituteCommandLineArgsFor( KMMessage *aMsg, TQPtrList<KTempFile> & aTempFileList  ) const;
 
  virtual ReturnCode genericProcess( KMMessage * aMsg, bool filtering ) const;
};
 
 
 
class KMFilterActionWithTest : public KMFilterAction
{
public:
  KMFilterActionWithTest(const char* aName, const TQString aLabel);
    ~KMFilterActionWithTest();
  virtual bool isEmpty() const { return mParameter.stripWhiteSpace().isEmpty(); }
 
  virtual TQWidget* createParamWidget(TQWidget* parent) const;
 
  virtual void applyParamWidgetValue(TQWidget* paramWidget);
 
  virtual void setParamWidgetValue(TQWidget* paramWidget) const;
 
  virtual void clearParamWidget(TQWidget* paramWidget) const;
 
  virtual void argsFromString(const TQString argsStr);
 
  virtual const TQString argsAsString() const;
 
  virtual const TQString displayString() const;
 
protected:
  TQString mParameter;
};
 
 
typedef KMFilterAction* (*KMFilterActionNewFunc)(void);
 
 
//-----------------------------------------------------------------------------
struct KMFilterActionDesc
{
  TQString label, name;
  KMFilterActionNewFunc create;
};
 
class KMFilterActionDict: public TQDict<KMFilterActionDesc>
{
public:
  KMFilterActionDict();
 
  void insert(KMFilterActionNewFunc aNewFunc);
 
  const TQPtrList<KMFilterActionDesc>& list() const { return mList; }
 
protected:
  virtual void init(void);
 
private:
  TQPtrList<KMFilterActionDesc> mList;
};
 
#endif /*kmfilteraction_h*/