libkcal
KCal::AttachmentHandler Namespace Reference
Detailed Description
Provides methods to handle incidence attachments.Includes functions to view and save attachments.
Functions | |
Attachment * | find (QWidget *parent, const QString &attachmentName, Incidence *incidence) |
Attachment * | find (QWidget *parent, const QString &attachmentName, ScheduleMessage *message) |
Attachment * | find (QWidget *parent, const QString &attachmentName, const QString &uid) |
bool | view (QWidget *parent, Attachment *attachment) |
bool | view (QWidget *parent, const QString &attachmentName, Incidence *incidence) |
bool | view (QWidget *parent, const QString &attachmentName, const QString &uid) |
bool | view (QWidget *parent, const QString &attachmentName, ScheduleMessage *message) |
bool | saveAs (QWidget *parent, Attachment *attachment) |
bool | saveAs (QWidget *parent, const QString &attachmentName, Incidence *incidence) |
bool | saveAs (QWidget *parent, const QString &attachmentName, const QString &uid) |
bool | saveAs (QWidget *parent, const QString &attachmentName, ScheduleMessage *message) |
Function Documentation
Attachment * KCal::AttachmentHandler::find | ( | QWidget * | parent, | |
const QString & | attachmentName, | |||
const QString & | 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 QString 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 89 of file attachmenthandler.cpp.
Attachment * KCal::AttachmentHandler::find | ( | QWidget * | parent, | |
const QString & | 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 111 of file attachmenthandler.cpp.
Attachment * KCal::AttachmentHandler::find | ( | QWidget * | parent, | |
const QString & | 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 50 of file attachmenthandler.cpp.
bool KCal::AttachmentHandler::saveAs | ( | QWidget * | parent, | |
const QString & | 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 251 of file attachmenthandler.cpp.
bool KCal::AttachmentHandler::saveAs | ( | QWidget * | parent, | |
const QString & | attachmentName, | |||
const QString & | 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 QString 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 246 of file attachmenthandler.cpp.
bool KCal::AttachmentHandler::saveAs | ( | QWidget * | parent, | |
const QString & | 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 240 of file attachmenthandler.cpp.
bool KCal::AttachmentHandler::saveAs | ( | QWidget * | 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 202 of file attachmenthandler.cpp.
bool KCal::AttachmentHandler::view | ( | QWidget * | parent, | |
const QString & | 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 196 of file attachmenthandler.cpp.
bool KCal::AttachmentHandler::view | ( | QWidget * | parent, | |
const QString & | attachmentName, | |||
const QString & | 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 QString 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 191 of file attachmenthandler.cpp.
bool KCal::AttachmentHandler::view | ( | QWidget * | parent, | |
const QString & | 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 186 of file attachmenthandler.cpp.
bool KCal::AttachmentHandler::view | ( | QWidget * | 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 160 of file attachmenthandler.cpp.