1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
/*
This file is part of the kcal library.
Copyright (c) 2010 Klar�lvdalens Datakonsult AB, a KDAB Group company <[email protected]>
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 \<[email protected]\>
*/
#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
|
