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

mailtransport

  • Akonadi
  • FilterActionJob
Public Member Functions | Protected Member Functions | List of all members
Akonadi::FilterActionJob Class Reference

#include <filteractionjob_p.h>

Inherits TransactionSequence.

Public Member Functions

 FilterActionJob (const Collection &collection, FilterAction *functor, QObject *parent=0)
 
 FilterActionJob (const Item &item, FilterAction *functor, QObject *parent=0)
 
 FilterActionJob (const Item::List &items, FilterAction *functor, QObject *parent=0)
 
 ~FilterActionJob ()
 

Protected Member Functions

virtual void doStart ()
 

Detailed Description

Job to filter and apply an action on a set of items.

This jobs filters through a set of items, and applies an action to the items which are accepted by the filter. The filter and action are provided by a functor class derived from FilterAction.

For example, a MarkAsRead action/filter may be used to mark all messages in a folder as read.

FilterActionJob *mjob = new FilterActionJob( LocalFolders::self()->outbox(),
new ClearErrorAction, this );
connect( mjob, SIGNAL( result( KJob* ) ), this, SLOT( massModifyResult( KJob* ) ) );
Akonadi::FilterActionJob
Job to filter and apply an action on a set of items.
Definition filteractionjob_p.h:132
Akonadi::FilterActionJob::FilterActionJob
FilterActionJob(const Item &item, FilterAction *functor, QObject *parent=0)
Creates a filter action job to act on a single item.
Definition filteractionjob.cpp:91
See also
FilterAction
Author
Constantin Berzan exit3.nosp@m.219@.nosp@m.gmail.nosp@m..com
Since
4.4

Definition at line 131 of file filteractionjob_p.h.

Constructor & Destructor Documentation

◆ FilterActionJob() [1/3]

FilterActionJob::FilterActionJob ( const Item & item,
FilterAction * functor,
QObject * parent = 0 )

Creates a filter action job to act on a single item.

Parameters
itemThe item to act on. The item is not re-fetched.
functorThe FilterAction to use.
parentThe parent object.

Definition at line 91 of file filteractionjob.cpp.

◆ FilterActionJob() [2/3]

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

Creates a filter action job to act on a set of items.

Parameters
itemsThe items to act on. The items are not re-fetched.
functorThe FilterAction to use.
parentThe parent object.

Definition at line 98 of file filteractionjob.cpp.

◆ FilterActionJob() [3/3]

FilterActionJob::FilterActionJob ( const Collection & collection,
FilterAction * functor,
QObject * parent = 0 )

Creates a filter action job to act on items in a collection.

Parameters
collectionThe collection to act on. The items of the collection are fetched using functor->fetchScope().
functorThe FilterAction to use.
parentThe parent object.

Definition at line 105 of file filteractionjob.cpp.

◆ ~FilterActionJob()

FilterActionJob::~FilterActionJob ( )

Destroys the filter action job.

Definition at line 114 of file filteractionjob.cpp.

Member Function Documentation

◆ doStart()

void FilterActionJob::doStart ( )
protectedvirtual

Definition at line 119 of file filteractionjob.cpp.


The documentation for this class was generated from the following files:
  • filteractionjob_p.h
  • filteractionjob.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 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