comparison finch/gntft.h @ 15817:0e3a8505ebbe

renamed gaim-text to finch
author Sean Egan <seanegan@gmail.com>
date Sun, 18 Mar 2007 19:38:15 +0000
parents
children 32c366eeeb99
comparison
equal deleted inserted replaced
15816:317e7613e581 15817:0e3a8505ebbe
1 /**
2 * @file gntft.h GNT File Transfer UI
3 * @ingroup gntui
4 *
5 * gaim
6 *
7 * Gaim is the legal property of its developers, whose names are too numerous
8 * to list here. Please refer to the COPYRIGHT file distributed with this
9 * source distribution.
10 *
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 */
25 #ifndef _GAIM_GNTFT_H_
26 #define _GAIM_GNTFT_H_
27
28 #include "ft.h"
29
30
31 /**************************************************************************/
32 /** @name GNT File Transfer Dialog API */
33 /**************************************************************************/
34 /*@{*/
35
36 /**
37 * Creates a new file transfer dialog.
38 *
39 * @return The new dialog.
40 */
41 void finch_xfer_dialog_new(void);
42
43 /**
44 * Destroys a file transfer dialog.
45 *
46 * @param dialog The file transfer dialog.
47 */
48 void finch_xfer_dialog_destroy(void);
49
50 /**
51 * Displays the file transfer dialog given.
52 * If dialog is @c NULL, displays the default dialog, creating one if necessary
53 *
54 * @param dialog The file transfer dialog to show.
55 */
56 void finch_xfer_dialog_show(void);
57
58 /**
59 * Hides the file transfer dialog.
60 *
61 * @param dialog The file transfer dialog to hide.
62 */
63 void finch_xfer_dialog_hide();
64
65 /**
66 * Adds a file transfer to the dialog.
67 *
68 * @param dialog The file transfer dialog.
69 * @param xfer The file transfer.
70 */
71 void finch_xfer_dialog_add_xfer(GaimXfer *xfer);
72
73 /**
74 * Removes a file transfer from the dialog.
75 *
76 * @param dialog The file transfer dialog.
77 * @param xfer The file transfer.
78 */
79 void finch_xfer_dialog_remove_xfer(GaimXfer *xfer);
80
81 /**
82 * Indicate in a file transfer dialog that a transfer was canceled.
83 *
84 * @param dialog The file transfer dialog.
85 * @param xfer The file transfer that was canceled.
86 */
87 void finch_xfer_dialog_cancel_xfer(GaimXfer *xfer);
88
89 /**
90 * Updates the information for a transfer in the dialog.
91 *
92 * @param dialog The file transfer dialog.
93 * @param xfer The file transfer.
94 */
95 void finch_xfer_dialog_update_xfer(GaimXfer *xfer);
96
97 /*@}*/
98
99 /**************************************************************************/
100 /** @name GNT File Transfer API */
101 /**************************************************************************/
102 /*@{*/
103
104 /**
105 * Initializes the GNT file transfer system.
106 */
107 void finch_xfers_init(void);
108
109 /**
110 * Uninitializes the GNT file transfer system.
111 */
112 void finch_xfers_uninit(void);
113
114 /**
115 * Returns the UI operations structure for the GNT file transfer UI.
116 *
117 * @return The GNT file transfer UI operations structure.
118 */
119 GaimXferUiOps *finch_xfers_get_ui_ops(void);
120
121 /*@}*/
122
123 #endif /* _GAIM_GNTFT_H_ */