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)
	~AttachmentHandler ()
KCalCore::Attachment::Ptr	find (const QString &attachmentName, const KCalCore::Incidence::Ptr &incidence)
KCalCore::Attachment::Ptr	find (const QString &attachmentName, const KCalCore::ScheduleMessage::Ptr &message)
bool	saveAs (const KCalCore::Attachment::Ptr &attachment)
bool	saveAs (const QString &attachmentName, const KCalCore::Incidence::Ptr &incidence)
void	saveAs (const QString &attachmentName, const QString &uid)
bool	saveAs (const QString &attachmentName, const KCalCore::ScheduleMessage::Ptr &message)
bool	view (const KCalCore::Attachment::Ptr &attachment)
bool	view (const QString &attachmentName, const KCalCore::Incidence::Ptr &incidence)
void	view (const QString &attachmentName, const QString &uid)
bool	view (const QString &attachmentName, const KCalCore::ScheduleMessage::Ptr &message)

Detailed Description

Provides methods to handle incidence attachments.

Includes functions to view and save attachments.

Definition at line 48 of file attachmenthandler.h.

Constructor & Destructor Documentation

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.

CalendarSupport::AttachmentHandler::~AttachmentHandler

(

)

Definition at line 71 of file attachmenthandler.cpp.

Member Function Documentation

KCalCore::Attachment::Ptr CalendarSupport::AttachmentHandler::find	(	const QString &	attachmentName,
		const KCalCore::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.

KCalCore::Attachment::Ptr CalendarSupport::AttachmentHandler::find	(	const QString &	attachmentName,
		const KCalCore::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.

bool CalendarSupport::AttachmentHandler::saveAs

(

const KCalCore::Attachment::Ptr &

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.

bool CalendarSupport::AttachmentHandler::saveAs	(	const QString &	attachmentName,
		const KCalCore::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.

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 258 of file attachmenthandler.cpp.

bool CalendarSupport::AttachmentHandler::saveAs	(	const QString &	attachmentName,
		const KCalCore::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.

void CalendarSupport::AttachmentHandler::saveAsFinished ( const QString &  uid, const QString &  attachmentName, bool  success  )

signal

bool CalendarSupport::AttachmentHandler::view

(

const KCalCore::Attachment::Ptr &

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.

bool CalendarSupport::AttachmentHandler::view	(	const QString &	attachmentName,
		const KCalCore::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.

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 196 of file attachmenthandler.cpp.

bool CalendarSupport::AttachmentHandler::view	(	const QString &	attachmentName,
		const KCalCore::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.

void CalendarSupport::AttachmentHandler::viewFinished ( const QString &  uid, const QString &  attachmentName, bool  success  )

signal

---

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

• attachmenthandler.h
• attachmenthandler.cpp