Akonadi::FilterActionJob Class Reference

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

#include <filteractionjob.h>

Inherits TransactionSequence.

List of all members.

Public Member Functions
	FilterActionJob (const Collection &collection, FilterAction *functor, QObject *parent=0)
	FilterActionJob (const Item::List &items, FilterAction *functor, QObject *parent=0)
	FilterActionJob (const Item &item, 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* ) ) );

See also:

FilterAction

Author:

Constantin Berzan <exit3219@gmail.com>

Since:

4.4

Definition at line 125 of file filteractionjob.h.

---

Constructor & Destructor Documentation

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

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

Parameters:

	item	The item to act on. The item is not re-fetched.
	functor	The FilterAction to use.
	parent	The parent object.

Definition at line 92 of file filteractionjob.cpp.

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

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

Parameters:

	items	The items to act on. The items are not re-fetched.
	functor	The FilterAction to use.
	parent	The parent object.

Definition at line 99 of file filteractionjob.cpp.

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

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

Parameters:

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

Definition at line 106 of file filteractionjob.cpp.

FilterActionJob::~FilterActionJob

(

)

Destroys the filter action job.

Definition at line 115 of file filteractionjob.cpp.

---

The documentation for this class was generated from the following files:

• filteractionjob.h
• filteractionjob.cpp