• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

mailtransport

  • mailtransport
filteractionjob_p.h
1/*
2 Copyright (c) 2009 Constantin Berzan <exit3219@gmail.com>
3
4 This library is free software; you can redistribute it and/or modify it
5 under the terms of the GNU Library General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or (at your
7 option) any later version.
8
9 This library is distributed in the hope that it will be useful, but WITHOUT
10 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
12 License for more details.
13
14 You should have received a copy of the GNU Library General Public License
15 along with this library; see the file COPYING.LIB. If not, write to the
16 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17 02110-1301, USA.
18*/
19
20#ifndef MAILTRANSPORT_FILTERACTIONJOB_P_H
21#define MAILTRANSPORT_FILTERACTIONJOB_P_H
22
23#include <mailtransport/mailtransport_export.h>
24
25#include <akonadi/item.h>
26#include <akonadi/transactionsequence.h>
27
28namespace Akonadi {
29
30class Collection;
31class ItemFetchScope;
32class Job;
33
34class FilterActionJob;
35
75class MAILTRANSPORT_EXPORT FilterAction
76{
77 public:
83 virtual ~FilterAction();
84
92 virtual Akonadi::ItemFetchScope fetchScope() const = 0;
93
98 virtual bool itemAccepted( const Akonadi::Item &item ) const = 0;
99
106 virtual Akonadi::Job *itemAction( const Akonadi::Item &item,
107 Akonadi::FilterActionJob *parent ) const = 0;
108};
109
131class MAILTRANSPORT_EXPORT FilterActionJob : public TransactionSequence
132{
133 Q_OBJECT
134
135 public:
143 FilterActionJob( const Item &item, FilterAction *functor, QObject *parent = 0 );
144
152 FilterActionJob( const Item::List &items, FilterAction *functor, QObject *parent = 0 );
153
162 FilterActionJob( const Collection &collection, FilterAction *functor, QObject *parent = 0 );
163
167 ~FilterActionJob();
168
169 protected:
170 /* reimpl */
171 virtual void doStart();
172
173 private:
174 //@cond PRIVATE
175 class Private;
176 Private *const d;
177
178 Q_PRIVATE_SLOT( d, void fetchResult( KJob* ) )
179 //@endcond
180};
181
182} // namespace Akonadi
183
184#endif // AKONADI_FILTERACTIONJOB_H
Akonadi::FilterActionJob
Job to filter and apply an action on a set of items.
Definition: filteractionjob_p.h:132
Akonadi::FilterAction
Base class for a filter/action for FilterActionJob.
Definition: filteractionjob_p.h:76
Akonadi::FilterAction::itemAccepted
virtual bool itemAccepted(const Akonadi::Item &item) const =0
Returns true if the item is accepted by the filter and should be acted upon by the FilterActionJob.
Akonadi::FilterAction::fetchScope
virtual Akonadi::ItemFetchScope fetchScope() const =0
Returns an ItemFetchScope to use if the FilterActionJob needs to fetch the items from a collection.
Akonadi::FilterAction::itemAction
virtual Akonadi::Job * itemAction(const Akonadi::Item &item, Akonadi::FilterActionJob *parent) const =0
Returns a job to act on the item.
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

mailtransport

Skip menu "mailtransport"
  • Main Page
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal