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=nullptr)
QString	lastError () const
void	purgeCompletedTodos ()
void	setCalendar (const CalendarBase::Ptr &calendar)
void	setIncidenceChager (IncidenceChanger *changer)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
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)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

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 27 of file todopurger.h.

Constructor & Destructor Documentation

TodoPurger()

TodoPurger::TodoPurger ( QObject * parent = nullptr )

explicit

Definition at line 123 of file todopurger.cpp.

Member Function Documentation

lastError()

QString TodoPurger::lastError ( ) const

nodiscard

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

Definition at line 160 of file todopurger.cpp.

purgeCompletedTodos()

void TodoPurger::purgeCompletedTodos

(

)

Deletes completed to-dos.

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

See also

purgeCompletedTodos()

Definition at line 146 of file todopurger.cpp.

setCalendar()

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 140 of file todopurger.cpp.

setIncidenceChager()

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 131 of file todopurger.cpp.

todosPurged

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 incomplete or read-only children.

---

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

• todopurger.h
• todopurger.cpp