libkcal

KCal::AttachmentHandler Namespace Reference

Provides methods to handle incidence attachments. More...

Functions

Attachmentfind (TQWidget *parent, const TQString &attachmentName, Incidence *incidence)
Attachmentfind (TQWidget *parent, const TQString &attachmentName, ScheduleMessage *message)
Attachmentfind (TQWidget *parent, const TQString &attachmentName, const TQString &uid)
bool view (TQWidget *parent, Attachment *attachment)
bool view (TQWidget *parent, const TQString &attachmentName, Incidence *incidence)
bool view (TQWidget *parent, const TQString &attachmentName, const TQString &uid)
bool view (TQWidget *parent, const TQString &attachmentName, ScheduleMessage *message)
bool saveAs (TQWidget *parent, Attachment *attachment)
bool saveAs (TQWidget *parent, const TQString &attachmentName, Incidence *incidence)
bool saveAs (TQWidget *parent, const TQString &attachmentName, const TQString &uid)
bool saveAs (TQWidget *parent, const TQString &attachmentName, ScheduleMessage *message)

Detailed Description

Provides methods to handle incidence attachments.

Includes functions to view and save attachments.


Function Documentation

Attachment * KCal::AttachmentHandler::find ( TQWidget *  parent,
const TQString &  attachmentName,
Incidence *  incidence 
)

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

Parameters:
parent is the parent widget for the dialogs used in this function.
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 38 of file attachmenthandler.cpp.

Attachment * KCal::AttachmentHandler::find ( TQWidget *  parent,
const TQString &  attachmentName,
ScheduleMessage *  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:
parent is the parent widget for the dialogs used in this function.
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 99 of file attachmenthandler.cpp.

Attachment * KCal::AttachmentHandler::find ( TQWidget *  parent,
const TQString &  attachmentName,
const TQString &  uid 
)

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

Parameters:
parent is the parent widget for the dialogs used in this function.
attachmentName is the name of the attachment
uid is a TQString containing a UID of the incidence containing the attachment.
Returns:
a pointer to the Attachment object located; 0 if no such attachment could be found.

Definition at line 77 of file attachmenthandler.cpp.

bool KCal::AttachmentHandler::saveAs ( TQWidget *  parent,
const TQString &  attachmentName,
Incidence *  incidence 
)

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

Parameters:
parent is the parent widget for the dialogs used in this function.
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 228 of file attachmenthandler.cpp.

bool KCal::AttachmentHandler::saveAs ( TQWidget *  parent,
const TQString &  attachmentName,
ScheduleMessage *  message 
)

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

Parameters:
parent is the parent widget for the dialogs used in this function.
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 239 of file attachmenthandler.cpp.

bool KCal::AttachmentHandler::saveAs ( TQWidget *  parent,
Attachment *  attachment 
)

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

Parameters:
parent is the parent widget for the dialogs used in this function.
attachment is a pointer to a valid Attachment object.
Returns:
true if the save operation was successful; false otherwise.

Definition at line 190 of file attachmenthandler.cpp.

bool KCal::AttachmentHandler::saveAs ( TQWidget *  parent,
const TQString &  attachmentName,
const TQString &  uid 
)

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

Parameters:
parent is the parent widget for the dialogs used in this function.
attachmentName is the name of the attachment
uid is a TQString containing a UID of the incidence containing the attachment.
Returns:
true if the attachment could be found and the save operation was successful; false otherwise.

Definition at line 234 of file attachmenthandler.cpp.

bool KCal::AttachmentHandler::view ( TQWidget *  parent,
const TQString &  attachmentName,
ScheduleMessage *  message 
)

Launches a viewer on the specified attachment.

Parameters:
parent is the parent widget for the dialogs used in this function.
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 184 of file attachmenthandler.cpp.

bool KCal::AttachmentHandler::view ( TQWidget *  parent,
Attachment *  attachment 
)

Launches a viewer on the specified attachment.

Parameters:
parent is the parent widget for the dialogs used in this function.
attachment is a pointer to a valid Attachment object.
Returns:
true if the viewer program successfully launched; false otherwise.

Definition at line 148 of file attachmenthandler.cpp.

bool KCal::AttachmentHandler::view ( TQWidget *  parent,
const TQString &  attachmentName,
Incidence *  incidence 
)

Launches a viewer on the specified attachment.

Parameters:
parent is the parent widget for the dialogs used in this function.
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 174 of file attachmenthandler.cpp.

bool KCal::AttachmentHandler::view ( TQWidget *  parent,
const TQString &  attachmentName,
const TQString &  uid 
)

Launches a viewer on the specified attachment.

Parameters:
parent is the parent widget for the dialogs used in this function.
attachmentName is the name of the attachment
uid is a TQString containing a UID of the incidence containing the attachment.
Returns:
true if the attachment could be found and the viewer program successfully launched; false otherwise.

Definition at line 179 of file attachmenthandler.cpp.