Akonadi::ITIPHandler Class Reference

#include <itiphandler.h>

Inheritance diagram for Akonadi::ITIPHandler:

Public Types
enum	Result { ResultError , ResultSuccess , ResultCancelled }
Public Types inherited from QObject
typedef	QObjectList

Signals
void	informationPublished (Akonadi::ITIPHandler::Result, const QString &errorMessage)
void	iTipMessageProcessed (Akonadi::ITIPHandler::Result result, const QString &errorMessage)
void	iTipMessageSent (Akonadi::ITIPHandler::Result, const QString &errorMessage)
void	sentAsICalendar (Akonadi::ITIPHandler::Result, const QString &errorMessage)

Public Member Functions
	ITIPHandler (ITIPHandlerComponentFactory *factory, QObject *parent)
	ITIPHandler (QObject *parent=nullptr)
	~ITIPHandler () override
Akonadi::CalendarBase::Ptr	calendar () const
void	processiTIPMessage (const QString &receiver, const QString &iCal, const QString &type)
void	publishInformation (const KCalendarCore::Incidence::Ptr &incidence, QWidget *parentWidget=nullptr)
void	sendAsICalendar (const KCalendarCore::Incidence::Ptr &incidence, QWidget *parentWidget=nullptr)
void	sendiTIPMessage (KCalendarCore::iTIPMethod method, const KCalendarCore::Incidence::Ptr &incidence, QWidget *parentWidget=nullptr)
void	setCalendar (const Akonadi::CalendarBase::Ptr &calendar)
void	setGroupwareUiDelegate (GroupwareUiDelegate *delegate)
void	setShowDialogsOnError (bool enable)
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
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

Handles sending of iTip messages as well as processing incoming ones.

Since

4.11

Definition at line 260 of file itiphandler.h.

Member Enumeration Documentation

Result

enum Akonadi::ITIPHandler::Result

Enumerator
ResultError	An unexpected error occurred.
ResultSuccess	The invitation was successfully handled.
ResultCancelled	User cancelled the operation. Since 4.12

Definition at line 264 of file itiphandler.h.

Constructor & Destructor Documentation

ITIPHandler() [1/2]

ITIPHandler::ITIPHandler ( QObject * parent = nullptr )

explicit

Creates a new ITIPHandler instance.

creates a default ITIPHandlerComponentFactory object.

Definition at line 72 of file itiphandler.cpp.

ITIPHandler() [2/2]

ITIPHandler::ITIPHandler ( ITIPHandlerComponentFactory * factory, QObject * parent )

explicit

Create a new ITIPHandler instance.

Parameters

factory

is set to 0 a new factory is created.

Since

4.15

Definition at line 79 of file itiphandler.cpp.

~ITIPHandler()

ITIPHandler::~ITIPHandler ( )

overridedefault

Destroys this instance.

Member Function Documentation

calendar()

Akonadi::CalendarBase::Ptr ITIPHandler::calendar

(

)

const

Returns the calendar used by this itip handler.

Definition at line 388 of file itiphandler.cpp.

informationPublished

void Akonadi::ITIPHandler::informationPublished ( Akonadi::ITIPHandler::Result , const QString & errorMessage )

signal

Signal emitted after an incidence was published with publishInformation()

iTipMessageProcessed

void Akonadi::ITIPHandler::iTipMessageProcessed ( Akonadi::ITIPHandler::Result result, const QString & errorMessage )

signal

Sent after processing an incoming iTip message.

Parameters

result	success of the operation.
errorMessage	translated error message suitable for user dialogs. Empty if the operation was successful

iTipMessageSent

void Akonadi::ITIPHandler::iTipMessageSent ( Akonadi::ITIPHandler::Result , const QString & errorMessage )

signal

Signal emitted after an iTip message was sent through sendiTIPMessage()

processiTIPMessage()

void ITIPHandler::processiTIPMessage	(	const QString &	receiver,
		const QString &	iCal,
		const QString &	type )

Processes a received iTip message.

Parameters

receiver
iCal
type

See also

iTipMessageProcessed()

Definition at line 88 of file itiphandler.cpp.

publishInformation()

void ITIPHandler::publishInformation	(	const KCalendarCore::Incidence::Ptr &	incidence,
		QWidget *	parentWidget = nullptr )

Publishes incidence incidence.

A publish dialog will prompt the user to input recipients.

See also

rfc2446 3.2.1

Definition at line 289 of file itiphandler.cpp.

sendAsICalendar()

void ITIPHandler::sendAsICalendar	(	const KCalendarCore::Incidence::Ptr &	incidence,
		QWidget *	parentWidget = nullptr )

Sends an e-mail with the incidence attached as iCalendar source.

A dialog will prompt the user to input recipients.

Definition at line 326 of file itiphandler.cpp.

sendiTIPMessage()

void ITIPHandler::sendiTIPMessage	(	KCalendarCore::iTIPMethod	method,
		const KCalendarCore::Incidence::Ptr &	incidence,
		QWidget *	parentWidget = nullptr )

Sends an iTip message.

Parameters

method	iTip method
incidence	Incidence for which we're sending the iTip message. Should contain a list of attendees.
parentWidget

Definition at line 244 of file itiphandler.cpp.

sentAsICalendar

void Akonadi::ITIPHandler::sentAsICalendar ( Akonadi::ITIPHandler::Result , const QString & errorMessage )

signal

Signal emitted after an incidence was sent with sendAsICalendar()

setCalendar()

void ITIPHandler::setCalendar

(

const Akonadi::CalendarBase::Ptr &

calendar

)

Sets the calendar that the itip handler should use.

The calendar should already be loaded.

If none is set, a FetchJobCalendar will be created internally.

Definition at line 376 of file itiphandler.cpp.

setGroupwareUiDelegate()

void ITIPHandler::setGroupwareUiDelegate

(

GroupwareUiDelegate *

delegate

)

Sets the UI delegate to edit counter proposals.

Definition at line 371 of file itiphandler.cpp.

setShowDialogsOnError()

void ITIPHandler::setShowDialogsOnError

(

bool

enable

)

Sets if the ITIP handler should show dialogs on error.

Default is true, for compatibility reasons, but this will change in KDE5. TODO_KDE5: use message delegates

Since

4.12

Definition at line 383 of file itiphandler.cpp.

---

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

• itiphandler.h
• itiphandler.cpp