From cc29364f06178f8f6b457384f2ec37a042bd9d43 Mon Sep 17 00:00:00 2001 From: tpearson Date: Wed, 1 Sep 2010 00:37:02 +0000 Subject: * Massive set of changes to bring in all fixes and enhancements from the Enterprise PIM branch * Ensured that the Trinity changes were applied on top of those enhancements, and any redundancy removed * Added journal read support to the CalDAV resource * Fixed CalDAV resource to use events URL for tasks and journals when separate URL checkbox unchecked git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdepim@1170461 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- libkcal/attachmenthandler.h | 178 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 178 insertions(+) create mode 100644 libkcal/attachmenthandler.h (limited to 'libkcal/attachmenthandler.h') diff --git a/libkcal/attachmenthandler.h b/libkcal/attachmenthandler.h new file mode 100644 index 00000000..6116f15a --- /dev/null +++ b/libkcal/attachmenthandler.h @@ -0,0 +1,178 @@ +/* + This file is part of the kcal library. + + Copyright (c) 2010 Klar�lvdalens Datakonsult AB, a KDAB Group company + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Library General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Library General Public License for more details. + + You should have received a copy of the GNU Library General Public License + along with this library; see the file COPYING.LIB. If not, write to + the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, + Boston, MA 02110-1301, USA. +*/ +/** + @file + This file is part of the API for handling calendar data and provides + static functions for dealing with calendar incidence attachments. + + @author Allen Winter \ +*/ + +#ifndef KCAL_ATTACHMENTHANDLER_H +#define KCAL_ATTACHMENTHANDLER_H + +class TQString; +class TQWidget; + +namespace KCal { + +class Attachment; +class Incidence; +class ScheduleMessage; + +/** + @brief + Provides methods to handle incidence attachments. + + Includes functions to view and save attachments. +*/ +namespace AttachmentHandler { + + /** + Finds the attachment in the user's calendar, by @p attachmentName and @p incidence. + + @param parent is the parent widget for the dialogs used in this function. + @param attachmentName is the name of the attachment + @param incidence is a pointer to a valid Incidence object containing the attachment. + + @return a pointer to the Attachment object located; 0 if no such attachment could be found. + */ + Attachment *find( TQWidget *parent, const TQString &attachmentName, Incidence *incidence ); + + /** + Finds the attachment in the user's calendar, by @p attachmentName and a scheduler message; + in other words, this function is intended to retrieve attachments from calendar invitations. + + @param parent is the parent widget for the dialogs used in this function. + @param attachmentName is the name of the attachment + @param message is a pointer to a valid ScheduleMessage object containing the attachment. + + @return a pointer to the Attachment object located; 0 if no such attachment could be found. + */ + Attachment *find( TQWidget *parent, const TQString &attachmentName, ScheduleMessage *message ); + + /** + Finds the attachment in the user's calendar, by @p attachmentName and @p uid. + + @param parent is the parent widget for the dialogs used in this function. + @param attachmentName is the name of the attachment + @param uid is a TQString containing a UID of the incidence containing the attachment. + + @return a pointer to the Attachment object located; 0 if no such attachment could be found. + */ + Attachment *find( TQWidget *parent, const TQString &attachmentName, const TQString &uid ); + + /** + Launches a viewer on the specified attachment. + + @param parent is the parent widget for the dialogs used in this function. + @param attachment is a pointer to a valid Attachment object. + + @return true if the viewer program successfully launched; false otherwise. + */ + bool view( TQWidget *parent, Attachment *attachment ); + + /** + Launches a viewer on the specified attachment. + + @param parent is the parent widget for the dialogs used in this function. + @param attachmentName is the name of the attachment + @param incidence is a pointer to a valid Incidence object containing the attachment. + + @return true if the attachment could be found and the viewer program successfully launched; + false otherwise. + */ + bool view( TQWidget *parent, const TQString &attachmentName, Incidence *incidence ); + + /** + Launches a viewer on the specified attachment. + + @param parent is the parent widget for the dialogs used in this function. + @param attachmentName is the name of the attachment + @param uid is a TQString containing a UID of the incidence containing the attachment. + + @return true if the attachment could be found and the viewer program successfully launched; + false otherwise. + */ + bool view( TQWidget *parent, const TQString &attachmentName, const TQString &uid ); + + /** + Launches a viewer on the specified attachment. + + @param parent is the parent widget for the dialogs used in this function. + @param attachmentName is the name of the attachment + @param message is a pointer to a valid ScheduleMessage object containing the attachment. + + @return true if the attachment could be found and the viewer program successfully launched; + false otherwise. + */ + bool view( TQWidget *parent, const TQString &attachmentName, ScheduleMessage *message ); + + /** + Saves the specified attachment to a file of the user's choice. + + @param parent is the parent widget for the dialogs used in this function. + @param attachment is a pointer to a valid Attachment object. + + @return true if the save operation was successful; false otherwise. + */ + bool saveAs( TQWidget *parent, Attachment *attachment ); + + /** + Saves the specified attachment to a file of the user's choice. + + @param parent is the parent widget for the dialogs used in this function. + @param attachmentName is the name of the attachment + @param incidence is a pointer to a valid Incidence object containing the attachment. + + @return true if the attachment could be found and the save operation was successful; + false otherwise. + */ + bool saveAs( TQWidget *parent, const TQString &attachmentName, Incidence *incidence ); + + /** + Saves the specified attachment to a file of the user's choice. + + @param parent is the parent widget for the dialogs used in this function. + @param attachmentName is the name of the attachment + @param uid is a TQString containing a UID of the incidence containing the attachment. + + @return true if the attachment could be found and the save operation was successful; + false otherwise. + */ + bool saveAs( TQWidget *parent, const TQString &attachmentName, const TQString &uid ); + + /** + Saves the specified attachment to a file of the user's choice. + + @param parent is the parent widget for the dialogs used in this function. + @param attachmentName is the name of the attachment + @param message is a pointer to a valid ScheduleMessage object containing the attachment. + + @return true if the attachment could be found and the save operation was successful; + false otherwise. + */ + bool saveAs( TQWidget *parent, const TQString &attachmentName, ScheduleMessage *message ); +} + +} + +#endif -- cgit v1.2.3