filteractionjob_p.h

Go to the documentation of this file.

/*
    Copyright (c) 2009 Constantin Berzan <[email protected]>

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public License as published by
    the Free Software Foundation; either version 2 of the License, or (at your
    option) any later version.

    This library 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 Library General Public
    License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to the
    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301, USA.
*/

#ifndef MAILTRANSPORT_FILTERACTIONJOB_P_H
#define MAILTRANSPORT_FILTERACTIONJOB_P_H

#include <mailtransportakonadi_export.h>

#include <item.h>
#include <transactionsequence.h>

namespace Akonadi {
class Collection;
class ItemFetchScope;
class Job;

class FilterActionJob;

class MAILTRANSPORTAKONADI_EXPORT FilterAction
{
public:
    virtual ~FilterAction();

    virtual Akonadi::ItemFetchScope fetchScope() const = 0;

    virtual bool itemAccepted(const Akonadi::Item &item) const = 0;

    virtual Akonadi::Job *itemAction(const Akonadi::Item &item, Akonadi::FilterActionJob *parent) const = 0;
};

class MAILTRANSPORTAKONADI_EXPORT FilterActionJob : public TransactionSequence
{
    Q_OBJECT

public:
    FilterActionJob(const Item &item, FilterAction *functor, QObject *parent = nullptr);

    FilterActionJob(const Item::List &items, FilterAction *functor, QObject *parent = nullptr);

    FilterActionJob(const Collection &collection, FilterAction *functor, QObject *parent = nullptr);

    ~FilterActionJob() override;

protected:
    void doStart() override;

private:
    //@cond PRIVATE
    class Private;
    Private *const d;
    //@endcond
};
} // namespace Akonadi

#endif // AKONADI_FILTERACTIONJOB_H