CalendarSupport::AttachmentHandler Class Reference

#include <attachmenthandler.h>

Inheritance diagram for CalendarSupport::AttachmentHandler:

Signals
void	saveAsFinished (const QString &uid, const QString &attachmentName, bool success)
void	viewFinished (const QString &uid, const QString &attachmentName, bool success)

Public Member Functions
	AttachmentHandler (QWidget *parent)
KCalendarCore::Attachment	find (const QString &attachmentName, const KCalendarCore::Incidence::Ptr &incidence)
KCalendarCore::Attachment	find (const QString &attachmentName, const KCalendarCore::ScheduleMessage::Ptr &message)
bool	saveAs (const KCalendarCore::Attachment &attachment)
bool	saveAs (const QString &attachmentName, const KCalendarCore::Incidence::Ptr &incidence)
bool	saveAs (const QString &attachmentName, const KCalendarCore::ScheduleMessage::Ptr &message)
void	saveAs (const QString &attachmentName, const QString &uid)
bool	view (const KCalendarCore::Attachment &attachment)
bool	view (const QString &attachmentName, const KCalendarCore::Incidence::Ptr &incidence)
bool	view (const QString &attachmentName, const KCalendarCore::ScheduleMessage::Ptr &message)
void	view (const QString &attachmentName, const QString &uid)
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

Provides methods to handle incidence attachments.

Includes functions to view and save attachments.

Definition at line 38 of file attachmenthandler.h.

Constructor & Destructor Documentation

AttachmentHandler()

CalendarSupport::AttachmentHandler::AttachmentHandler ( QWidget * parent )

explicit

Constructs an AttachmentHandler.

Parameters

parent

is the parent widget for the dialogs used by this class.

Definition at line 66 of file attachmenthandler.cpp.

Member Function Documentation

find() [1/2]

Attachment CalendarSupport::AttachmentHandler::find	(	const QString &	attachmentName,
		const KCalendarCore::Incidence::Ptr &	incidence )

Finds the attachment in the user's calendar, by attachmentName and incidence.

Parameters

attachmentName	is the name of the attachment
incidence	is a pointer to a valid Incidence object containing the attachment.

Returns

a pointer to the Attachment object located; 0 if no such attachment could be found.

Definition at line 74 of file attachmenthandler.cpp.

find() [2/2]

Attachment CalendarSupport::AttachmentHandler::find	(	const QString &	attachmentName,
		const KCalendarCore::ScheduleMessage::Ptr &	message )

Finds the attachment in the user's calendar, by attachmentName and a scheduler message; in other words, this function is intended to retrieve attachments from calendar invitations.

Parameters

attachmentName	is the name of the attachment
message	is a pointer to a valid ScheduleMessage object containing the attachment.

Returns

a pointer to the Attachment object located; 0 if no such attachment could be found.

Definition at line 114 of file attachmenthandler.cpp.

saveAs() [1/4]

bool CalendarSupport::AttachmentHandler::saveAs

(

const KCalendarCore::Attachment &

attachment

)

Saves the specified attachment to a file of the user's choice.

Parameters

attachment

is a pointer to a valid Attachment object.

Returns

true if the save operation was successful; false otherwise.

Definition at line 210 of file attachmenthandler.cpp.

saveAs() [2/4]

bool CalendarSupport::AttachmentHandler::saveAs	(	const QString &	attachmentName,
		const KCalendarCore::Incidence::Ptr &	incidence )

Saves the specified attachment to a file of the user's choice.

Parameters

attachmentName	is the name of the attachment
incidence	is a pointer to a valid Incidence object containing the attachment.

Returns

true if the attachment could be found and the save operation was successful; false otherwise.

Definition at line 242 of file attachmenthandler.cpp.

saveAs() [3/4]

bool CalendarSupport::AttachmentHandler::saveAs	(	const QString &	attachmentName,
		const KCalendarCore::ScheduleMessage::Ptr &	message )

Saves the specified attachment to a file of the user's choice.

Parameters

attachmentName	is the name of the attachment
message	is a pointer to a valid ScheduleMessage object containing the attachment.

Returns

true if the attachment could be found and the save operation was successful; false otherwise.

Definition at line 260 of file attachmenthandler.cpp.

saveAs() [4/4]

void CalendarSupport::AttachmentHandler::saveAs	(	const QString &	attachmentName,
		const QString &	uid )

Saves the specified attachment to a file of the user's choice.

Parameters

attachmentName	is the name of the attachment
uid	is a QString containing a UID of the incidence containing the attachment.

This function is async, it will return immediately. Listen to signal saveAsFinished() if you're interested on the success of this operation.

Definition at line 247 of file attachmenthandler.cpp.

view() [1/4]

bool CalendarSupport::AttachmentHandler::view

(

const KCalendarCore::Attachment &

attachment

)

Launches a viewer on the specified attachment.

Parameters

attachment

is a pointer to a valid Attachment object.

Returns

true if the viewer program successfully launched; false otherwise.

Definition at line 161 of file attachmenthandler.cpp.

view() [2/4]

bool CalendarSupport::AttachmentHandler::view	(	const QString &	attachmentName,
		const KCalendarCore::Incidence::Ptr &	incidence )

Launches a viewer on the specified attachment.

Parameters

attachmentName	is the name of the attachment
incidence	is a pointer to a valid Incidence object containing the attachment.

Returns

true if the attachment could be found and the viewer program successfully launched; false otherwise.

Definition at line 188 of file attachmenthandler.cpp.

view() [3/4]

bool CalendarSupport::AttachmentHandler::view	(	const QString &	attachmentName,
		const KCalendarCore::ScheduleMessage::Ptr &	message )

Launches a viewer on the specified attachment.

Parameters

attachmentName	is the name of the attachment
message	is a pointer to a valid ScheduleMessage object containing the attachment.

Returns

true if the attachment could be found and the viewer program successfully launched; false otherwise.

Definition at line 205 of file attachmenthandler.cpp.

view() [4/4]

void CalendarSupport::AttachmentHandler::view	(	const QString &	attachmentName,
		const QString &	uid )

Launches a viewer on the specified attachment.

Parameters

attachmentName	is the name of the attachment
uid	is a QString containing a UID of the incidence containing the attachment.

This function is async and will return immediately. Listen to signal viewFinished() if you're interested on the success of this operation.

Definition at line 193 of file attachmenthandler.cpp.

---

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

• attachmenthandler.h
• attachmenthandler.cpp