Akonadi::TodoPurger Class Reference

#include <todopurger.h>

Inherits QObject.

Signals
void	todosPurged (bool success, int numDeleted, int numIgnored)

Public Member Functions
	TodoPurger (QObject *parent=0)
QString	lastError () const
void	purgeCompletedTodos ()
void	setCalendar (const CalendarBase::Ptr &calendar)
void	setIncidenceChager (IncidenceChanger *changer)

Detailed Description

Class to delete completed to-dos.

Author

Sérgio Martins iamse.nosp@m.rgio.nosp@m.@gmai.nosp@m.l.co.nosp@m.m

Since

4.12

Definition at line 38 of file todopurger.h.

Member Function Documentation

QString TodoPurger::lastError

(

)

const

Use this after receiving the an unsuccessful todosPurged() signal to get a i18n error message.

Definition at line 172 of file todopurger.cpp.

void TodoPurger::purgeCompletedTodos

(

)

Deletes completed to-dos.

A to-do with uncomplete children won't be deleted.

See also

purgeCompletedTodos()

Definition at line 160 of file todopurger.cpp.

void TodoPurger::setCalendar

(

const CalendarBase::Ptr &

calendar

)

Sets the calendar to be used for retrieving the to-do hierarchy.

If you don't call this method, an internal FetchJobCalendar will be created. Use this if you want to reuse an existing calendar, for performance reasons for example.

Definition at line 154 of file todopurger.cpp.

void TodoPurger::setIncidenceChager

(

IncidenceChanger *

changer

)

Sets an IncidenceChanger.

If you don't call this method, an internal IncidenceChanger will be created. Use this if you want more control over the deletion operations, like iTip management, ACL, undo/redo support.

Definition at line 145 of file todopurger.cpp.

void Akonadi::TodoPurger::todosPurged ( bool  success, int  numDeleted, int  numIgnored  )

signal

Emitted when purging completed to-dos finished.

Parameters

success

True if the operation could be completed.

See also

lastError()

Parameters

numDeleted	Number of to-dos that were deleted.
numIgnored	Number of completed to-dos that weren't deleted because they are read-only or have uncomplete or read-only children.

---

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

• todopurger.h
• todopurger.cpp