Akonadi::TodoPurger Class Reference

#include <todopurger.h>

Inheritance diagram for Akonadi::TodoPurger:

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)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

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