filteraction.h

Go to the documentation of this file.

/*
 * 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 MAILCOMMON_FILTERACTION_H
#define MAILCOMMON_FILTERACTION_H

#include "mailcommon_export.h"
#include "search/searchpattern.h"

#include "filter/itemcontext.h"

#include <Akonadi/Collection>
#include <Akonadi/Item>

#include <KMime/MDN>
#include <KMime/KMimeMessage>

#include <QtCore/QList>
#include <QtCore/QObject>

class QWidget;

namespace MailCommon {

class MAILCOMMON_EXPORT FilterAction : public QObject
{
    Q_OBJECT
public:

    enum ReturnCode {
        ErrorNeedComplete = 0x1, 
        GoOn = 0x2,              
        ErrorButGoOn = 0x4,      
        CriticalError = 0x8      
    };


    FilterAction( const QString &name, const QString &label, QObject *parent = 0 );

    virtual ~FilterAction();

    QString label() const;

    QString name() const;

    virtual QStringList sieveRequires() const;

    virtual QString sieveCode() const;

    virtual ReturnCode process( ItemContext &context, bool applyOnOutbound ) const = 0;

    virtual SearchRule::RequiredPart requiredPart() const = 0;
    virtual bool isEmpty() const;

    virtual QString informationAboutNotValidAction() const;

    virtual QWidget *createParamWidget( QWidget *parent ) const;

    virtual void applyParamWidgetValue( QWidget *paramWidget );

    virtual void setParamWidgetValue( QWidget *paramWidget ) const;

    virtual void clearParamWidget( QWidget *paramWidget ) const;

    virtual void argsFromString( const QString &argsStr ) = 0;

    virtual bool argsFromStringInteractive( const QString &argsStr, const QString &filterName );

    virtual QString argsAsStringReal() const;

    virtual QString argsAsString() const = 0;

    virtual QString displayString() const = 0;

    virtual bool folderRemoved( const Akonadi::Collection &aFolder,
                                const Akonadi::Collection &aNewFolder );

    static FilterAction *newAction();

    static void sendMDN( const Akonadi::Item &item,
                         KMime::MDN::DispositionType d,
                         const QList<KMime::MDN::DispositionModifier> &m =
            QList<KMime::MDN::DispositionModifier>() );

signals:
    void filterActionModified();

private:
    QString mName;
    QString mLabel;
};

}

#endif