You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
701 lines
26 KiB
701 lines
26 KiB
/*
|
|
* 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
|
|
//
|
|
//=========================================================
|
|
|
|
|
|
/** Abstract base class for KMail's filter actions. All it can do is
|
|
hold a name (ie. type-string). There are several sub-classes that
|
|
inherit form this and are capable of providing parameter handling
|
|
(import/export as string, a widget to allow editing, etc.)
|
|
|
|
@short Abstract base class for KMail's filter actions.
|
|
@author Marc Mutz <Marc@Mutz.com>, based on work by Stefan Taferner <taferner@kde.org>.
|
|
@see KMFilter KMFilterMgr
|
|
*/
|
|
class KMFilterAction
|
|
{
|
|
public:
|
|
/** Possible return codes of process:
|
|
|
|
@li @p ErrorNeedComplete: Could not process because a
|
|
complete message is needed.
|
|
|
|
@li @p GoOn: Go on with applying filter actions.
|
|
|
|
@li @p ErrorButGoOn: There was a non-critical error (e.g. an
|
|
invalid address in the 'forward' action), but the processing
|
|
should continue.
|
|
|
|
@li @p CriticalError: A critical error has occurred during
|
|
processing (e.g. "disk full").
|
|
|
|
*/
|
|
enum ReturnCode { ErrorNeedComplete = 0x1, GoOn = 0x2, ErrorButGoOn = 0x4,
|
|
CriticalError = 0x8 };
|
|
/** Initialize filter action with (english) name @p aName and
|
|
(internationalized) label @p aLabel. */
|
|
KMFilterAction(const char* aName, const TQString aLabel);
|
|
virtual ~KMFilterAction();
|
|
|
|
/** Returns nationalized label, ie. the one which is presented in
|
|
the filter dialog. */
|
|
const TQString label() const { return mLabel; }
|
|
|
|
/** Returns english name, ie. the one under which it is known in the
|
|
config. */
|
|
const TQString name() const { return mName; }
|
|
|
|
/** Execute action on given message. Returns @p CriticalError if a
|
|
critical error has occurred (eg. disk full), @p ErrorButGoOn if
|
|
there was a non-critical error (e.g. invalid address in
|
|
'forward' action), @p ErrorNeedComplete if a complete message
|
|
is required, @p GoOn if the message shall be processed by
|
|
further filters and @p Ok otherwise.
|
|
*/
|
|
virtual ReturnCode process(KMMessage* msg) const = 0;
|
|
|
|
/** Execute an action on given message asynchronously.
|
|
Emits a result signal on completion.
|
|
*/
|
|
virtual void processAsync(KMMessage* msg) const;
|
|
|
|
/** Determines if the action depends on the body of the message
|
|
*/
|
|
virtual bool requiresBody(KMMsgBase* msgBase) const;
|
|
|
|
/** Determines whether this action is valid. But this is just a
|
|
quick test. Eg., actions that have a mail address as parameter
|
|
shouldn't try real address validation, but only check if the
|
|
string representation is empty. */
|
|
virtual bool isEmpty() const { return FALSE; }
|
|
|
|
/** Creates a widget for setting the filter action parameter. Also
|
|
sets the value of the widget. */
|
|
virtual TQWidget* createParamWidget(TQWidget* parent) const;
|
|
|
|
/** The filter action shall set it's parameter from the widget's
|
|
contents. It is allowed that the value is read by the action
|
|
before this function is called. */
|
|
virtual void applyParamWidgetValue(TQWidget* paramWidget);
|
|
|
|
/** The filter action shall set it's widget's contents from it's
|
|
parameter. */
|
|
virtual void setParamWidgetValue(TQWidget* paramWidget) const;
|
|
|
|
/** The filter action shall clear it's parameter widget's
|
|
contents. */
|
|
virtual void clearParamWidget(TQWidget* paramWidget) const;
|
|
|
|
/** Read extra arguments from given string. */
|
|
virtual void argsFromString(const TQString argsStr) = 0;
|
|
|
|
/** Return extra arguments as string. Must not contain newlines. */
|
|
virtual const TQString argsAsString() const = 0;
|
|
|
|
/** Returns a translated string describing this filter for visualization
|
|
purposes, e.g. in the filter log. */
|
|
virtual const TQString displayString() const = 0;
|
|
|
|
/** Called from the filter when a folder is removed. Tests if the
|
|
folder @p aFolder is used and changes to @p aNewFolder in this
|
|
case. Returns TRUE if a change was made. */
|
|
virtual bool folderRemoved(KMFolder* aFolder, KMFolder* aNewFolder);
|
|
|
|
/** Static function that creates a filter action of this type. */
|
|
static KMFilterAction* newAction();
|
|
|
|
/** Temporarily open folder. Will be closed by the next
|
|
KMFilterMgr::cleanup() call. */
|
|
static int tempOpenFolder(KMFolder* aFolder);
|
|
|
|
/** Automates the sending of MDNs from filter actions. */
|
|
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
|
|
//
|
|
//=========================================================
|
|
|
|
|
|
/** Abstract base class for KMail's filter actions that need no
|
|
parameter, e.g. "Confirm Delivery". Creates an (empty) TQWidget as
|
|
parameter widget. A subclass of this must provide at least
|
|
implementations for the following methods:
|
|
|
|
@li virtual KMFilterAction::ReturnCodes KMFilterAction::process
|
|
@li static KMFilterAction::newAction
|
|
|
|
@short Abstract base class for filter actions with no parameter.
|
|
@author Marc Mutz <Marc@Mutz.com>, based upon work by Stefan Taferner <taferner@kde.org>
|
|
@see KMFilterAction KMFilter
|
|
|
|
*/
|
|
class KMFilterActionWithNone : public KMFilterAction
|
|
{
|
|
public:
|
|
/** Initialize filter action with (english) name @p aName. This is
|
|
the name under which this action is known in the config file. */
|
|
KMFilterActionWithNone(const char* aName, const TQString aLabel);
|
|
|
|
/** Read extra arguments from given string. This type of filter
|
|
action has no parameters, so this is a no-op. */
|
|
virtual void argsFromString(const TQString) {};
|
|
|
|
/** Return extra arguments as string. Must not contain newlines. We
|
|
return TQString(), because we have no parameter. */
|
|
virtual const TQString argsAsString() const { return TQString(); }
|
|
|
|
/** Returns a translated string describing this filter for visualization
|
|
purposes, e.g. in the filter log. */
|
|
virtual const TQString displayString() const;
|
|
};
|
|
|
|
|
|
//=========================================================
|
|
//
|
|
// class KMFilterActionWithString
|
|
//
|
|
//=========================================================
|
|
|
|
|
|
/** Abstract base class for KMail's filter actions that need a
|
|
free-form parameter, e.g. 'set transport' or 'set reply to'. Can
|
|
create a TQLineEdit as parameter widget. A subclass of this
|
|
must provide at least implementations for the following methods:
|
|
|
|
@li virtual KMFilterAction::ReturnCodes KMFilterAction::process
|
|
@li static KMFilterAction::newAction
|
|
|
|
@short Abstract base class for filter actions with a free-form string as parameter.
|
|
@author Marc Mutz <Marc@Mutz.com>, based upon work by Stefan Taferner <taferner@kde.org>
|
|
@see KMFilterAction KMFilter
|
|
|
|
*/
|
|
class KMFilterActionWithString : public KMFilterAction
|
|
{
|
|
public:
|
|
/** Initialize filter action with (english) name @p aName. This is
|
|
the name under which this action is known in the config file. */
|
|
KMFilterActionWithString(const char* aName, const TQString aLabel);
|
|
|
|
/** Determines whether this action is valid. But this is just a
|
|
quick test. Eg., actions that have a mail address as parameter
|
|
shouldn't try real address validation, but only check if the
|
|
string representation is empty. */
|
|
virtual bool isEmpty() const { return mParameter.stripWhiteSpace().isEmpty(); }
|
|
|
|
/** Creates a widget for setting the filter action parameter. Also
|
|
sets the value of the widget. */
|
|
virtual TQWidget* createParamWidget(TQWidget* parent) const;
|
|
|
|
/** The filter action shall set it's parameter from the widget's
|
|
contents. It is allowed that the value is read by the action
|
|
before this function is called. */
|
|
virtual void applyParamWidgetValue(TQWidget* paramWidget);
|
|
|
|
/** The filter action shall set it's widget's contents from it's
|
|
parameter. */
|
|
virtual void setParamWidgetValue(TQWidget* paramWidget) const;
|
|
|
|
/** The filter action shall clear it's parameter widget's
|
|
contents. */
|
|
virtual void clearParamWidget(TQWidget* paramWidget) const;
|
|
|
|
/** Read extra arguments from given string. */
|
|
virtual void argsFromString(const TQString argsStr);
|
|
|
|
/** Return extra arguments as string. Must not contain newlines. */
|
|
virtual const TQString argsAsString() const;
|
|
|
|
/** Returns a translated string describing this filter for visualization
|
|
purposes, e.g. in the filter log. */
|
|
virtual const TQString displayString() const;
|
|
|
|
protected:
|
|
TQString mParameter;
|
|
};
|
|
|
|
//=========================================================
|
|
//
|
|
// class KMFilterActionWithUOID
|
|
//
|
|
//=========================================================
|
|
|
|
|
|
/** Abstract base class for KMail's filter actions that need a
|
|
parameter that has a UOID, e.g. "set identity". A subclass of this
|
|
must provide at least implementations for the following methods:
|
|
|
|
@li virtual KMFilterAction::ReturnCodes KMFilterAction::process
|
|
@li static KMFilterAction::newAction
|
|
@li the *ParamWidget* methods.
|
|
|
|
@short Abstract base class for filter actions with a free-form string as parameter.
|
|
@author Marc Mutz <Marc@Mutz.com>, based upon work by Stefan Taferner <taferner@kde.org>
|
|
@see KMFilterAction KMFilter
|
|
|
|
*/
|
|
class KMFilterActionWithUOID : public KMFilterAction
|
|
{
|
|
public:
|
|
/** Initialize filter action with (english) name @p aName. This is
|
|
the name under which this action is known in the config file. */
|
|
KMFilterActionWithUOID(const char* aName, const TQString aLabel);
|
|
|
|
/** Determines whether this action is valid. But this is just a
|
|
quick test. Eg., actions that have a mail address as parameter
|
|
shouldn't try real address validation, but only check if the
|
|
string representation is empty. */
|
|
virtual bool isEmpty() const { return mParameter == 0; }
|
|
|
|
/** Read extra arguments from given string. */
|
|
virtual void argsFromString(const TQString argsStr);
|
|
|
|
/** Return extra arguments as string. Must not contain newlines. */
|
|
virtual const TQString argsAsString() const;
|
|
|
|
/** Returns a translated string describing this filter for visualization
|
|
purposes, e.g. in the filter log. */
|
|
virtual const TQString displayString() const;
|
|
|
|
protected:
|
|
uint mParameter;
|
|
};
|
|
|
|
//=========================================================
|
|
//
|
|
// class KMFilterActionWithStringList
|
|
//
|
|
//=========================================================
|
|
|
|
|
|
/** Abstract base class for KMail's filter actions that need a
|
|
parameter which can be chosen from a fixed set, e.g. 'set
|
|
identity'. Can create a TQComboBox as parameter widget. A
|
|
subclass of this must provide at least implementations for the
|
|
following methods:
|
|
|
|
@li virtual KMFilterAction::ReturnCodes KMFilterAction::process
|
|
@li static KMFilterAction::newAction
|
|
|
|
Additionally, it's constructor should populate the
|
|
TQStringList @p mParameterList with the valid parameter
|
|
strings. The combobox will then contain be populated automatically
|
|
with those strings. The default string will be the first one.
|
|
|
|
@short Abstract base class for filter actions with a fixed set of string parameters.
|
|
@author Marc Mutz <Marc@Mutz.com>, based upon work by Stefan Taferner <taferner@kde.org>
|
|
@see KMFilterActionWithString KMFilterActionWithFolder KMFilterAction KMFilter
|
|
|
|
*/
|
|
class KMFilterActionWithStringList : public KMFilterActionWithString
|
|
{
|
|
public:
|
|
/** Initialize filter action with (english) name @p aName. This is
|
|
the name under which this action is known in the config file. */
|
|
KMFilterActionWithStringList(const char* aName, const TQString aLabel);
|
|
|
|
/** Creates a widget for setting the filter action parameter. Also
|
|
sets the value of the widget. */
|
|
virtual TQWidget* createParamWidget(TQWidget* parent) const;
|
|
|
|
/** The filter action shall set it's parameter from the widget's
|
|
contents. It is allowed that the value is read by the action
|
|
before this function is called. */
|
|
virtual void applyParamWidgetValue(TQWidget* paramWidget);
|
|
|
|
/** The filter action shall set it's widget's contents from it's
|
|
parameter. */
|
|
virtual void setParamWidgetValue(TQWidget* paramWidget) const;
|
|
|
|
/** The filter action shall clear it's parameter widget's
|
|
contents. */
|
|
virtual void clearParamWidget(TQWidget* paramWidget) const;
|
|
|
|
/** Read extra arguments from given string. */
|
|
virtual void argsFromString(const TQString argsStr);
|
|
|
|
protected:
|
|
TQStringList mParameterList;
|
|
};
|
|
|
|
|
|
//=========================================================
|
|
//
|
|
// class KMFilterActionWithFolder
|
|
//
|
|
//=========================================================
|
|
|
|
|
|
/** Abstract base class for KMail's filter actions that need a
|
|
mail folder as parameter, e.g. 'move into folder'. Can
|
|
create a TQComboBox as parameter widget. A subclass of this
|
|
must provide at least implementations for the following methods:
|
|
|
|
@li virtual KMFilterAction::ReturnCodes KMFilterAction::process
|
|
@li static KMFilterAction::newAction
|
|
|
|
@short Abstract base class for filter actions with a mail folder as parameter.
|
|
@author Marc Mutz <Marc@Mutz.com>, based upon work by Stefan Taferner <taferner@kde.org>
|
|
@see KMFilterActionWithStringList KMFilterAction KMFilter
|
|
|
|
*/
|
|
|
|
class KMFilterActionWithFolder : public KMFilterAction
|
|
{
|
|
public:
|
|
/** Initialize filter action with (english) name @p aName. This is
|
|
the name under which this action is known in the config file. */
|
|
KMFilterActionWithFolder(const char* aName, const TQString aLabel);
|
|
|
|
/** Determines whether this action is valid. But this is just a
|
|
quick test. Eg., actions that have a mail address as parameter
|
|
shouldn't try real address validation, but only check if the
|
|
string representation is empty. */
|
|
virtual bool isEmpty() const { return (!mFolder && mFolderName.isEmpty()); }
|
|
|
|
/** Creates a widget for setting the filter action parameter. Also
|
|
sets the value of the widget. */
|
|
virtual TQWidget* createParamWidget(TQWidget* parent) const;
|
|
|
|
/** The filter action shall set it's parameter from the widget's
|
|
contents. It is allowed that the value is read by the action
|
|
before this function is called. */
|
|
virtual void applyParamWidgetValue(TQWidget* paramWidget);
|
|
|
|
/** The filter action shall set it's widget's contents from it's
|
|
parameter. */
|
|
virtual void setParamWidgetValue(TQWidget* paramWidget) const;
|
|
|
|
/** The filter action shall clear it's parameter widget's
|
|
contents. */
|
|
virtual void clearParamWidget(TQWidget* paramWidget) const;
|
|
|
|
/** Read extra arguments from given string. */
|
|
virtual void argsFromString(const TQString argsStr);
|
|
|
|
/** Return extra arguments as string. Must not contain newlines. */
|
|
virtual const TQString argsAsString() const;
|
|
|
|
/** Returns a translated string describing this filter for visualization
|
|
purposes, e.g. in the filter log. */
|
|
virtual const TQString displayString() const;
|
|
|
|
/** Called from the filter when a folder is removed. Tests if the
|
|
folder @p aFolder is used and changes to @p aNewFolder in this
|
|
case. Returns TRUE if a change was made. */
|
|
virtual bool folderRemoved(KMFolder* aFolder, KMFolder* aNewFolder);
|
|
|
|
protected:
|
|
TQGuardedPtr<KMFolder> mFolder;
|
|
TQString mFolderName;
|
|
};
|
|
|
|
//=========================================================
|
|
//
|
|
// class KMFilterActionWithAddress
|
|
//
|
|
//=========================================================
|
|
|
|
|
|
/** Abstract base class for KMail's filter actions that need a mail
|
|
address as parameter, e.g. 'forward to'. Can create a
|
|
TQComboBox (capable of completion from the address book) as
|
|
parameter widget. A subclass of this must provide at least
|
|
implementations for the following methods:
|
|
|
|
@li virtual KMFilterAction::ReturnCodes KMFilterAction::process
|
|
@li static KMFilterAction::newAction
|
|
|
|
@short Abstract base class for filter actions with a mail address as parameter.
|
|
@author Marc Mutz <Marc@Mutz.com>, based upon work by Stefan Taferner <taferner@kde.org>
|
|
@see KMFilterActionWithString KMFilterAction KMFilter
|
|
|
|
*/
|
|
class KMFilterActionWithAddress : public KMFilterActionWithString
|
|
{
|
|
public:
|
|
/** Initialize filter action with (english) name @p aName. This is
|
|
the name under which this action is known in the config file. */
|
|
KMFilterActionWithAddress(const char* aName, const TQString aLabel);
|
|
|
|
/** Creates a widget for setting the filter action parameter. Also
|
|
sets the value of the widget. */
|
|
virtual TQWidget* createParamWidget(TQWidget* parent) const;
|
|
|
|
/** The filter action shall set it's parameter from the widget's
|
|
contents. It is allowed that the value is read by the action
|
|
before this function is called. */
|
|
virtual void applyParamWidgetValue(TQWidget* paramWidget);
|
|
|
|
/** The filter action shall set it's widget's contents from it's
|
|
parameter. */
|
|
virtual void setParamWidgetValue(TQWidget* paramWidget) const;
|
|
|
|
/** The filter action shall clear it's parameter widget's
|
|
contents. */
|
|
virtual void clearParamWidget(TQWidget* paramWidget) const;
|
|
};
|
|
|
|
//=========================================================
|
|
//
|
|
// class KMFilterActionWithCommand
|
|
//
|
|
//=========================================================
|
|
|
|
|
|
/** Abstract base class for KMail's filter actions that need a command
|
|
line as parameter, e.g. 'forward to'. Can create a TQLineEdit
|
|
(are there better widgets in the depths of the tdelibs?) as
|
|
parameter widget. A subclass of this must provide at least
|
|
implementations for the following methods:
|
|
|
|
@li virtual KMFilterAction::ReturnCodes KMFilterAction::process
|
|
@li static KMFilterAction::newAction
|
|
|
|
The implementation of KMFilterAction::process should take the
|
|
command line specified in mParameter, make all required
|
|
modifications and stream the resulting command line into @p
|
|
mProcess. Then you can start the command with @p mProcess.start().
|
|
|
|
@short Abstract base class for filter actions with a command line as parameter.
|
|
@author Marc Mutz <Marc@Mutz.com>, based upon work by Stefan Taferner <taferner@kde.org>
|
|
@see KMFilterActionWithString KMFilterAction KMFilter TDEProcess
|
|
|
|
*/
|
|
class KMFilterActionWithUrl : public KMFilterAction
|
|
{
|
|
public:
|
|
/** Initialize filter action with (english) name @p aName. This is
|
|
the name under which this action is known in the config file. */
|
|
KMFilterActionWithUrl(const char* aName, const TQString aLabel);
|
|
~KMFilterActionWithUrl();
|
|
/** Determines whether this action is valid. But this is just a
|
|
quick test. Eg., actions that have a mail address as parameter
|
|
shouldn't try real address validation, but only check if the
|
|
string representation is empty. */
|
|
virtual bool isEmpty() const { return mParameter.stripWhiteSpace().isEmpty(); }
|
|
|
|
/** Creates a widget for setting the filter action parameter. Also
|
|
sets the value of the widget. */
|
|
virtual TQWidget* createParamWidget(TQWidget* parent) const;
|
|
|
|
/** The filter action shall set it's parameter from the widget's
|
|
contents. It is allowed that the value is read by the action
|
|
before this function is called. */
|
|
virtual void applyParamWidgetValue(TQWidget* paramWidget);
|
|
|
|
/** The filter action shall set it's widget's contents from it's
|
|
parameter. */
|
|
virtual void setParamWidgetValue(TQWidget* paramWidget) const;
|
|
|
|
/** The filter action shall clear it's parameter widget's
|
|
contents. */
|
|
virtual void clearParamWidget(TQWidget* paramWidget) const;
|
|
|
|
/** Read extra arguments from given string. */
|
|
virtual void argsFromString(const TQString argsStr);
|
|
|
|
/** Return extra arguments as string. Must not contain newlines. */
|
|
virtual const TQString argsAsString() const;
|
|
|
|
/** Returns a translated string describing this filter for visualization
|
|
purposes, e.g. in the filter log. */
|
|
virtual const TQString displayString() const;
|
|
|
|
protected:
|
|
TQString mParameter;
|
|
};
|
|
|
|
|
|
class KMFilterActionWithCommand : public KMFilterActionWithUrl
|
|
{
|
|
public:
|
|
/** Initialize filter action with (english) name @p aName. This is
|
|
the name under which this action is known in the config file. */
|
|
KMFilterActionWithCommand(const char* aName, const TQString aLabel);
|
|
|
|
/** Creates a widget for setting the filter action parameter. Also
|
|
sets the value of the widget. */
|
|
virtual TQWidget* createParamWidget(TQWidget* parent) const;
|
|
|
|
/** The filter action shall set it's parameter from the widget's
|
|
contents. It is allowed that the value is read by the action
|
|
before this function is called. */
|
|
virtual void applyParamWidgetValue(TQWidget* paramWidget);
|
|
|
|
/** The filter action shall set it's widget's contents from it's
|
|
parameter. */
|
|
virtual void setParamWidgetValue(TQWidget* paramWidget) const;
|
|
|
|
/** The filter action shall clear it's parameter widget's
|
|
contents. */
|
|
virtual void clearParamWidget(TQWidget* paramWidget) const;
|
|
|
|
/** Substitutes various placeholders for data from the message
|
|
resp. for filenames containing that data. Currently, only %n is
|
|
supported, where n in an integer >= 0. %n gets substituted for
|
|
the name of a tempfile holding the n'th message part, with n=0
|
|
meaning the body of the message. */
|
|
virtual TQString substituteCommandLineArgsFor( KMMessage *aMsg, TQPtrList<KTempFile> & aTempFileList ) const;
|
|
|
|
virtual ReturnCode genericProcess( KMMessage * aMsg, bool filtering ) const;
|
|
};
|
|
|
|
|
|
|
|
class KMFilterActionWithTest : public KMFilterAction
|
|
{
|
|
public:
|
|
/** Initialize filter action with (english) name @p aName. This is
|
|
the name under which this action is known in the config file. */
|
|
KMFilterActionWithTest(const char* aName, const TQString aLabel);
|
|
~KMFilterActionWithTest();
|
|
/** Determines whether this action is valid. But this is just a
|
|
quick test. Eg., actions that have a mail address as parameter
|
|
shouldn't try real address validation, but only check if the
|
|
string representation is empty. */
|
|
virtual bool isEmpty() const { return mParameter.stripWhiteSpace().isEmpty(); }
|
|
|
|
/** Creates a widget for setting the filter action parameter. Also
|
|
sets the value of the widget. */
|
|
virtual TQWidget* createParamWidget(TQWidget* parent) const;
|
|
|
|
/** The filter action shall set it's parameter from the widget's
|
|
contents. It is allowed that the value is read by the action
|
|
before this function is called. */
|
|
virtual void applyParamWidgetValue(TQWidget* paramWidget);
|
|
|
|
/** The filter action shall set it's widget's contents from it's
|
|
parameter. */
|
|
virtual void setParamWidgetValue(TQWidget* paramWidget) const;
|
|
|
|
/** The filter action shall clear it's parameter widget's
|
|
contents. */
|
|
virtual void clearParamWidget(TQWidget* paramWidget) const;
|
|
|
|
/** Read extra arguments from given string. */
|
|
virtual void argsFromString(const TQString argsStr);
|
|
|
|
/** Return extra arguments as string. Must not contain newlines. */
|
|
virtual const TQString argsAsString() const;
|
|
|
|
/** Returns a translated string describing this filter for visualization
|
|
purposes, e.g. in the filter log. */
|
|
virtual const TQString displayString() const;
|
|
|
|
protected:
|
|
TQString mParameter;
|
|
};
|
|
|
|
|
|
typedef KMFilterAction* (*KMFilterActionNewFunc)(void);
|
|
|
|
|
|
//-----------------------------------------------------------------------------
|
|
/** Auxiliary struct to KMFilterActionDict. */
|
|
struct KMFilterActionDesc
|
|
{
|
|
TQString label, name;
|
|
KMFilterActionNewFunc create;
|
|
};
|
|
|
|
/** Dictionary that contains a list of all registered filter actions
|
|
with their creation functions. They are hard-coded into the
|
|
constructor. If you want to add a new KMFilterAction, make
|
|
sure you add the details of it in init, too.
|
|
|
|
You will be able to find a description of a KMFilterAction by
|
|
looking up either it's (english) name or it's (i18n) label:
|
|
<pre>
|
|
KMFilterActionDict dict;
|
|
// get name of the action with label "move into folder":
|
|
dict[i18n("move into folder")]->name; // == "transfer"
|
|
// create one such action:
|
|
KMFilterAction *action = dict["transfer"]->create();
|
|
</pre>
|
|
|
|
You can iterate over all known filter actions by using list.
|
|
|
|
@short List of known KMFilterAction-types.
|
|
@author Marc Mutz <Marc@Mutz.com>, based on work by Stefan Taferner <taferner@kde.org>
|
|
@see KMFilterAction KMFilterActionDesc KMFilter
|
|
|
|
*/
|
|
class KMFilterActionDict: public TQDict<KMFilterActionDesc>
|
|
{
|
|
public:
|
|
KMFilterActionDict();
|
|
|
|
/** Overloaded member function, provided for convenience. Thin
|
|
wrapper around TQDict::insert and TQPtrList::insert.
|
|
Inserts the resulting KMFilterActionDesc
|
|
thrice: First with the name, then with the label as key into the
|
|
TQDict, then into the TQPtrList. For that, it creates an
|
|
instance of the action internally and deletes it again after
|
|
querying it for name and label. */
|
|
void insert(KMFilterActionNewFunc aNewFunc);
|
|
|
|
/** Provides read-only access to a list of all known filter
|
|
actions. */
|
|
const TQPtrList<KMFilterActionDesc>& list() const { return mList; }
|
|
|
|
protected:
|
|
/** Populate the dictionary with all known KMFilterAction
|
|
types. Called automatically from the constructor. */
|
|
virtual void init(void);
|
|
|
|
private:
|
|
TQPtrList<KMFilterActionDesc> mList;
|
|
};
|
|
|
|
#endif /*kmfilteraction_h*/
|