CalendarSupport::AttachmentHandler
#include <attachmenthandler.h>
Signals | |
void | saveAsFinished (const QString &uid, const QString &attachmentName, bool success) |
void | viewFinished (const QString &uid, const QString &attachmentName, bool success) |
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()
|
explicit |
Constructs an AttachmentHandler.
- Parameters
-
parent is the parent widget for the dialogs used by this class.
Definition at line 64 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 72 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 112 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 208 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 240 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 258 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 245 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 159 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 186 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 203 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 191 of file attachmenthandler.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:16:32 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.