Mercurial > pidgin.yaz
annotate src/ft.h @ 5917:a747e9e0e2cf
[gaim-migrate @ 6349]
2 compile fixes, one from a Herman mistake and one from a Luke-is-using-a-
different-version-of-gettext-that-doesn't-have-as-much-psycho-checking-of-
translation "mistake."
Also, I made it so "Send File" and "Direct IM" do not show up in the
right click menu unless the person is advertising that capability. This
probably should have been done a long time ago.
Also, some not-yet-used code for setting available messages. I'm working
on it. Oh, and I found a new capability in iChat. I don't know what it
does yet.
committer: Tailor Script <tailor@pidgin.im>
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Wed, 18 Jun 2003 02:18:26 +0000 |
parents | 059d95c67cda |
children | 158196b2db19 |
rev | line source |
---|---|
4514 | 1 /** |
2 * @file ft.h The file transfer interface | |
5034
4691c5936c01
[gaim-migrate @ 5377]
Christian Hammond <chipx86@chipx86.com>
parents:
4675
diff
changeset
|
3 * @ingroup core |
4514 | 4 * |
5 * gaim | |
6 * | |
7 * Copyright (C) 2002-2003, Christian Hammond <chipx86@gnupdate.org> | |
8 * | |
9 * This program is free software; you can redistribute it and/or modify | |
10 * it under the terms of the GNU General Public License as published by | |
11 * the Free Software Foundation; either version 2 of the License, or | |
12 * (at your option) any later version. | |
13 * | |
14 * This program is distributed in the hope that it will be useful, | |
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 * GNU General Public License for more details. | |
18 * | |
19 * You should have received a copy of the GNU General Public License | |
20 * along with this program; if not, write to the Free Software | |
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
22 */ | |
23 #ifndef _GAIM_FT_H_ | |
24 #define _GAIM_FT_H_ | |
25 | |
26 /**************************************************************************/ | |
27 /** Data Structures */ | |
28 /**************************************************************************/ | |
4675
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
29 struct gaim_xfer; |
4514 | 30 |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
31 #include "account.h" |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
32 |
4514 | 33 /** |
34 * Types of file transfers. | |
35 */ | |
36 typedef enum | |
37 { | |
38 GAIM_XFER_UNKNOWN = 0, /**< Unknown file transfer type. */ | |
39 GAIM_XFER_SEND, /**< File sending. */ | |
40 GAIM_XFER_RECEIVE /**< File receiving. */ | |
41 | |
42 } GaimXferType; | |
43 | |
44 /** | |
45 * File transfer UI operations. | |
46 * | |
47 * Any UI representing a file transfer must assign a filled-out | |
48 * gaim_xfer_ui_ops structure to the gaim_xfer. | |
49 */ | |
50 struct gaim_xfer_ui_ops | |
51 { | |
5169 | 52 void (*new)(struct gaim_xfer *xfer); |
4514 | 53 void (*destroy)(struct gaim_xfer *xfer); |
54 void (*request_file)(struct gaim_xfer *xfer); | |
55 void (*ask_cancel)(struct gaim_xfer *xfer); | |
56 void (*add_xfer)(struct gaim_xfer *xfer); | |
57 void (*update_progress)(struct gaim_xfer *xfer, double percent); | |
4675
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
58 void (*cancel_local)(struct gaim_xfer *xfer); |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
59 void (*cancel_remote)(struct gaim_xfer *xfer); |
4514 | 60 }; |
61 | |
62 /** | |
63 * A core representation of a file transfer. | |
64 */ | |
65 struct gaim_xfer | |
66 { | |
67 GaimXferType type; /**< The type of transfer. */ | |
68 | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5499
diff
changeset
|
69 GaimAccount *account; /**< The account. */ |
4514 | 70 |
71 char *who; /**< The person on the other end of the | |
72 transfer. */ | |
73 | |
4605 | 74 char *filename; /**< The name sent over the network. */ |
75 char *local_filename; /**< The name on the local hard drive. */ | |
4514 | 76 size_t size; /**< The size of the file. */ |
77 | |
78 FILE *dest_fp; /**< The destination file pointer. */ | |
79 | |
80 char *local_ip; /**< The local IP address. */ | |
81 char *remote_ip; /**< The remote IP address. */ | |
82 int local_port; /**< The local port. */ | |
83 int remote_port; /**< The remote port. */ | |
84 | |
85 int fd; /**< The socket file descriptor. */ | |
86 int watcher; /**< Watcher. */ | |
87 | |
88 size_t bytes_sent; /**< The number of bytes sent. */ | |
89 size_t bytes_remaining; /**< The number of bytes remaining. */ | |
90 | |
4538 | 91 gboolean completed; /**< File Transfer is completed. */ |
92 | |
4514 | 93 /* I/O operations. */ |
94 struct | |
95 { | |
96 void (*init)(struct gaim_xfer *xfer); | |
97 void (*start)(struct gaim_xfer *xfer); | |
98 void (*end)(struct gaim_xfer *xfer); | |
4675
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
99 void (*cancel_send)(struct gaim_xfer *xfer); |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
100 void (*cancel_recv)(struct gaim_xfer *xfer); |
5495
5b678994929b
[gaim-migrate @ 5891]
Herman Bloggs <hermanator12002@yahoo.com>
parents:
5494
diff
changeset
|
101 size_t (*read)(char **buffer, struct gaim_xfer *xfer); |
5b678994929b
[gaim-migrate @ 5891]
Herman Bloggs <hermanator12002@yahoo.com>
parents:
5494
diff
changeset
|
102 size_t (*write)(const char *buffer, size_t size, |
4518
a6be92358df3
[gaim-migrate @ 4796]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
103 struct gaim_xfer *xfer); |
4594 | 104 void (*ack)(struct gaim_xfer *xfer, const char *buffer, |
105 size_t size); | |
4514 | 106 |
107 } ops; | |
108 | |
109 struct gaim_xfer_ui_ops *ui_ops; /**< UI-specific operations. */ | |
110 void *ui_data; /**< UI-specific data. */ | |
111 | |
112 void *data; /**< prpl-specific data. */ | |
113 }; | |
114 | |
115 /**************************************************************************/ | |
116 /** @name File Transfer API */ | |
117 /**************************************************************************/ | |
118 /*@{*/ | |
119 | |
120 /** | |
121 * Creates a new file transfer handle. | |
122 * | |
123 * @param account The account sending or receiving the file. | |
124 * @param type The type of file transfer. | |
125 * @param who The name of the remote user. | |
126 * | |
127 * @return A file transfer handle. | |
128 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5499
diff
changeset
|
129 struct gaim_xfer *gaim_xfer_new(GaimAccount *account, |
4514 | 130 GaimXferType type, const char *who); |
131 | |
132 /** | |
133 * Destroys a file transfer handle. | |
134 * | |
135 * @param xfer The file transfer to destroy. | |
136 */ | |
137 void gaim_xfer_destroy(struct gaim_xfer *xfer); | |
138 | |
139 /** | |
140 * Requests confirmation for a file transfer from the user. | |
141 * | |
142 * @param xfer The file transfer to request confirmation on. | |
143 */ | |
144 void gaim_xfer_request(struct gaim_xfer *xfer); | |
145 | |
146 /** | |
147 * Called if the user accepts the file transfer request. | |
148 * | |
149 * @param xfer The file transfer. | |
150 * @param filename The filename. | |
151 */ | |
152 void gaim_xfer_request_accepted(struct gaim_xfer *xfer, char *filename); | |
153 | |
154 /** | |
155 * Called if the user rejects the file transfer request. | |
156 * | |
157 * @param xfer The file transfer. | |
158 */ | |
159 void gaim_xfer_request_denied(struct gaim_xfer *xfer); | |
160 | |
161 /** | |
162 * Returns the type of file transfer. | |
163 * | |
164 * @param xfer The file transfer. | |
165 * | |
166 * @return The type of the file transfer. | |
167 */ | |
168 GaimXferType gaim_xfer_get_type(const struct gaim_xfer *xfer); | |
169 | |
170 /** | |
171 * Returns the account the file transfer is using. | |
172 * | |
173 * @param xfer The file transfer. | |
174 * | |
175 * @return The account. | |
176 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5499
diff
changeset
|
177 GaimAccount *gaim_xfer_get_account(const struct gaim_xfer *xfer); |
4514 | 178 |
179 /** | |
4539
05476ef20d58
[gaim-migrate @ 4818]
Christian Hammond <chipx86@chipx86.com>
parents:
4538
diff
changeset
|
180 * Returns the completed state for a file transfer. |
05476ef20d58
[gaim-migrate @ 4818]
Christian Hammond <chipx86@chipx86.com>
parents:
4538
diff
changeset
|
181 * |
05476ef20d58
[gaim-migrate @ 4818]
Christian Hammond <chipx86@chipx86.com>
parents:
4538
diff
changeset
|
182 * @param xfer The file transfer. |
05476ef20d58
[gaim-migrate @ 4818]
Christian Hammond <chipx86@chipx86.com>
parents:
4538
diff
changeset
|
183 * |
05476ef20d58
[gaim-migrate @ 4818]
Christian Hammond <chipx86@chipx86.com>
parents:
4538
diff
changeset
|
184 * @return The completed state. |
05476ef20d58
[gaim-migrate @ 4818]
Christian Hammond <chipx86@chipx86.com>
parents:
4538
diff
changeset
|
185 */ |
05476ef20d58
[gaim-migrate @ 4818]
Christian Hammond <chipx86@chipx86.com>
parents:
4538
diff
changeset
|
186 gboolean gaim_xfer_is_completed(const struct gaim_xfer *xfer); |
05476ef20d58
[gaim-migrate @ 4818]
Christian Hammond <chipx86@chipx86.com>
parents:
4538
diff
changeset
|
187 |
05476ef20d58
[gaim-migrate @ 4818]
Christian Hammond <chipx86@chipx86.com>
parents:
4538
diff
changeset
|
188 /** |
4514 | 189 * Returns the name of the file being sent or received. |
190 * | |
191 * @param xfer The file transfer. | |
192 * | |
193 * @return The filename. | |
194 */ | |
195 const char *gaim_xfer_get_filename(const struct gaim_xfer *xfer); | |
196 | |
197 /** | |
198 * Returns the file's destination filename, | |
199 * | |
200 * @param xfer The file transfer. | |
201 * | |
202 * @return The destination filename. | |
203 */ | |
4605 | 204 const char *gaim_xfer_get_local_filename(const struct gaim_xfer *xfer); |
4514 | 205 |
206 /** | |
207 * Returns the number of bytes sent so far. | |
208 * | |
209 * @param xfer The file transfer. | |
210 * | |
211 * @return The number of bytes sent. | |
212 */ | |
213 size_t gaim_xfer_get_bytes_sent(const struct gaim_xfer *xfer); | |
214 | |
215 /** | |
216 * Returns the number of bytes received so far. | |
217 * | |
218 * @param xfer The file transfer. | |
219 * | |
220 * @return The number of bytes received. | |
221 */ | |
222 size_t gaim_xfer_get_bytes_remaining(const struct gaim_xfer *xfer); | |
223 | |
224 /** | |
225 * Returns the size of the file being sent or received. | |
226 * | |
227 * @param xfer The file transfer. | |
228 * | |
229 * @return The total size of the file. | |
230 */ | |
231 size_t gaim_xfer_get_size(const struct gaim_xfer *xfer); | |
232 | |
233 /** | |
234 * Returns the current percentage of progress of the transfer. | |
235 * | |
236 * This is a number between 0 (0%) and 1 (100%). | |
237 * | |
238 * @param xfer The file transfer. | |
239 * | |
240 * @return The percentage complete. | |
241 */ | |
242 double gaim_xfer_get_progress(const struct gaim_xfer *xfer); | |
243 | |
244 /** | |
245 * Returns the local IP address in the file transfer. | |
246 * | |
247 * @param xfer The file transfer. | |
248 * | |
249 * @return The IP address on this end. | |
250 */ | |
251 const char *gaim_xfer_get_local_ip(const struct gaim_xfer *xfer); | |
252 | |
253 /** | |
254 * Returns the local port number in the file transfer. | |
255 * | |
256 * @param xfer The file transfer. | |
257 * | |
258 * @return The port number on this end. | |
259 */ | |
260 unsigned int gaim_xfer_get_local_port(const struct gaim_xfer *xfer); | |
261 | |
262 /** | |
263 * Returns the remote IP address in the file transfer. | |
264 * | |
265 * @param xfer The file transfer. | |
266 * | |
267 * @return The IP address on the other end. | |
268 */ | |
269 const char *gaim_xfer_get_remote_ip(const struct gaim_xfer *xfer); | |
270 | |
271 /** | |
272 * Returns the remote port number in the file transfer. | |
273 * | |
274 * @param xfer The file transfer. | |
275 * | |
276 * @return The port number on the other end. | |
277 */ | |
278 unsigned int gaim_xfer_get_remote_port(const struct gaim_xfer *xfer); | |
279 | |
280 /** | |
4538 | 281 * Sets the completed state for the file transfer. |
282 * | |
283 * @param xfer The file transfer. | |
284 * @param completed The completed state. | |
285 */ | |
286 void gaim_xfer_set_completed(struct gaim_xfer *xfer, gboolean completed); | |
287 | |
288 /** | |
4514 | 289 * Sets the filename for the file transfer. |
290 * | |
291 * @param xfer The file transfer. | |
292 * @param filename The filename. | |
293 */ | |
294 void gaim_xfer_set_filename(struct gaim_xfer *xfer, const char *filename); | |
295 | |
296 /** | |
4605 | 297 * Sets the local filename for the file transfer. |
4514 | 298 * |
299 * @param xfer The file transfer. | |
300 * @param filename The filename | |
301 */ | |
4605 | 302 void gaim_xfer_set_local_filename(struct gaim_xfer *xfer, const char *filename); |
4514 | 303 |
304 /** | |
305 * Sets the size of the file in a file transfer. | |
306 * | |
307 * @param xfer The file transfer. | |
308 * @param size The size of the file. | |
309 */ | |
310 void gaim_xfer_set_size(struct gaim_xfer *xfer, size_t size); | |
311 | |
312 /** | |
313 * Returns the UI operations structure for a file transfer. | |
314 * | |
315 * @param xfer The file transfer. | |
316 * | |
317 * @return The UI operations structure. | |
318 */ | |
319 struct gaim_xfer_ui_ops *gaim_xfer_get_ui_ops(const struct gaim_xfer *xfer); | |
320 | |
321 /** | |
322 * Sets the read function for the file transfer. | |
323 * | |
324 * @param xfer The file transfer. | |
325 * @param fnc The read function. | |
326 */ | |
327 void gaim_xfer_set_read_fnc(struct gaim_xfer *xfer, | |
4518
a6be92358df3
[gaim-migrate @ 4796]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
328 size_t (*fnc)(char **, struct gaim_xfer *)); |
4514 | 329 |
330 /** | |
331 * Sets the write function for the file transfer. | |
332 * | |
333 * @param xfer The file transfer. | |
334 * @param fnc The write function. | |
335 */ | |
336 void gaim_xfer_set_write_fnc(struct gaim_xfer *xfer, | |
4518
a6be92358df3
[gaim-migrate @ 4796]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
337 size_t (*fnc)(const char *, size_t, struct gaim_xfer *)); |
4514 | 338 |
339 /** | |
340 * Sets the acknowledge function for the file transfer. | |
341 * | |
342 * @param xfer The file transfer. | |
343 * @param fnc The acknowledge function. | |
344 */ | |
345 void gaim_xfer_set_ack_fnc(struct gaim_xfer *xfer, | |
4595 | 346 void (*fnc)(struct gaim_xfer *, const char *, size_t)); |
4514 | 347 |
348 /** | |
349 * Sets the transfer initialization function for the file transfer. | |
350 * | |
351 * This function is required, and must call gaim_xfer_start() with | |
352 * the necessary parameters. This will be called if the file transfer | |
353 * is accepted by the user. | |
354 * | |
355 * @param xfer The file transfer. | |
356 * @param fnc The transfer initialization function. | |
357 */ | |
358 void gaim_xfer_set_init_fnc(struct gaim_xfer *xfer, | |
359 void (*fnc)(struct gaim_xfer *)); | |
360 | |
361 /** | |
362 * Sets the start transfer function for the file transfer. | |
363 * | |
364 * @param xfer The file transfer. | |
365 * @param fnc The start transfer function. | |
366 */ | |
367 void gaim_xfer_set_start_fnc(struct gaim_xfer *xfer, | |
368 void (*fnc)(struct gaim_xfer *)); | |
369 | |
370 /** | |
371 * Sets the end transfer function for the file transfer. | |
372 * | |
373 * @param xfer The file transfer. | |
374 * @param fnc The end transfer function. | |
375 */ | |
376 void gaim_xfer_set_end_fnc(struct gaim_xfer *xfer, | |
377 void (*fnc)(struct gaim_xfer *)); | |
378 | |
379 /** | |
4675
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
380 * Sets the cancel send function for the file transfer. |
4514 | 381 * |
382 * @param xfer The file transfer. | |
4675
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
383 * @param fnc The cancel send function. |
4514 | 384 */ |
4675
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
385 void gaim_xfer_set_cancel_send_fnc(struct gaim_xfer *xfer, |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
386 void (*fnc)(struct gaim_xfer *)); |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
387 |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
388 /** |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
389 * Sets the cancel receive function for the file transfer. |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
390 * |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
391 * @param xfer The file transfer. |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
392 * @param fnc The cancel receive function. |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
393 */ |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
394 void gaim_xfer_set_cancel_recv_fnc(struct gaim_xfer *xfer, |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
395 void (*fnc)(struct gaim_xfer *)); |
4514 | 396 |
397 /** | |
398 * Reads in data from a file transfer stream. | |
399 * | |
400 * @param xfer The file transfer. | |
401 * @param buffer The buffer that will be created to contain the data. | |
402 * | |
403 * @return The number of bytes read. | |
404 */ | |
405 size_t gaim_xfer_read(struct gaim_xfer *xfer, char **buffer); | |
406 | |
407 /** | |
408 * Writes data to a file transfer stream. | |
409 * | |
410 * @param xfer The file transfer. | |
411 * @param buffer The buffer to read the data from. | |
412 * @param size The number of bytes to write. | |
413 * | |
414 * @return The number of bytes written. | |
415 */ | |
416 size_t gaim_xfer_write(struct gaim_xfer *xfer, const char *buffer, | |
417 size_t size); | |
418 | |
419 /** | |
420 * Starts a file transfer. | |
421 * | |
422 * Either @a fd must be specified <i>or</i> @a ip and @a port on a | |
423 * file receive transfer. On send, @a fd must be specified, and | |
424 * @a ip and @a port are ignored. | |
425 * | |
426 * @param xfer The file transfer. | |
427 * @param fd The file descriptor for the socket. | |
428 * @param ip The IP address to connect to. | |
429 * @param port The port to connect to. | |
430 */ | |
431 void gaim_xfer_start(struct gaim_xfer *xfer, int fd, const char *ip, | |
432 unsigned int port); | |
433 | |
434 /** | |
435 * Ends a file transfer. | |
436 * | |
437 * @param xfer The file transfer. | |
438 */ | |
439 void gaim_xfer_end(struct gaim_xfer *xfer); | |
440 | |
441 /** | |
4675
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
442 * Cancels a file transfer on the local end. |
4514 | 443 * |
444 * @param xfer The file transfer. | |
445 */ | |
4675
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
446 void gaim_xfer_cancel_local(struct gaim_xfer *xfer); |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
447 |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
448 /** |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
449 * Cancels a file transfer from the remote end. |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
450 * |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
451 * @param xfer The file transfer. |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
452 */ |
3145c5c45877
[gaim-migrate @ 4986]
Christian Hammond <chipx86@chipx86.com>
parents:
4605
diff
changeset
|
453 void gaim_xfer_cancel_remote(struct gaim_xfer *xfer); |
4514 | 454 |
455 /** | |
456 * Displays a file transfer-related error message. | |
457 * | |
5499
c8afb821df3e
[gaim-migrate @ 5895]
Christian Hammond <chipx86@chipx86.com>
parents:
5495
diff
changeset
|
458 * This is a wrapper around gaim_notify_error(), which automatically |
4514 | 459 * specifies a title ("File transfer to <i>user</i> aborted" or |
460 * "File Transfer from <i>user</i> aborted"). | |
461 * | |
462 * @param type The type of file transfer. | |
463 * @param who The user on the other end of the transfer. | |
464 * @param msg The message to display. | |
465 */ | |
466 void gaim_xfer_error(GaimXferType type, const char *who, const char *msg); | |
467 | |
468 /*@}*/ | |
469 | |
470 /**************************************************************************/ | |
471 /** @name UI Registration Functions */ | |
472 /**************************************************************************/ | |
473 /*@{*/ | |
474 | |
475 /** | |
476 * Sets the UI operations structure to be used in all gaim file transfers. | |
477 * | |
478 * @param fnc The function. | |
479 */ | |
480 void gaim_set_xfer_ui_ops(struct gaim_xfer_ui_ops *ops); | |
481 | |
482 /** | |
483 * Returns the UI operations structure to be used in all gaim file transfers. | |
484 * | |
485 * @return The UI operations structure. | |
486 */ | |
487 struct gaim_xfer_ui_ops *gaim_get_xfer_ui_ops(void); | |
488 | |
489 /*@}*/ | |
490 | |
491 #endif /* _GAIM_FT_H_ */ |