Mercurial > pidgin
annotate finch/gntft.h @ 19912:e65dcf11c5d0
Added hints to gtkstatusbox.c
author | Gabriel Schulhof <nix@go-nix.ca> |
---|---|
date | Thu, 16 Aug 2007 21:36:17 +0000 |
parents | 36b09c6f7957 |
children | 44b4e8bd759b |
rev | line source |
---|---|
15817 | 1 /** |
2 * @file gntft.h GNT File Transfer UI | |
16194
0f0832c13fcb
Rename the Doxygen group from gntui to finch and define the finch group
Richard Laager <rlaager@wiktel.com>
parents:
15870
diff
changeset
|
3 * @ingroup finch |
15817 | 4 * |
15870
66dff3dfdea6
Re-sed the copyright notices so they don't all talk about Purple.
Richard Laager <rlaager@wiktel.com>
parents:
15822
diff
changeset
|
5 * finch |
15817 | 6 * |
15870
66dff3dfdea6
Re-sed the copyright notices so they don't all talk about Purple.
Richard Laager <rlaager@wiktel.com>
parents:
15822
diff
changeset
|
7 * Finch is the legal property of its developers, whose names are too numerous |
15817 | 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 */ | |
15822 | 25 #ifndef _FINCHFT_H_ |
26 #define _FINCHFT_H_ | |
15817 | 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 void finch_xfer_dialog_destroy(void); | |
47 | |
48 /** | |
49 * Displays the file transfer dialog given. | |
50 * If dialog is @c NULL, displays the default dialog, creating one if necessary | |
51 */ | |
52 void finch_xfer_dialog_show(void); | |
53 | |
54 /** | |
55 * Hides the file transfer dialog. | |
56 */ | |
57 void finch_xfer_dialog_hide(); | |
58 | |
59 /** | |
60 * Adds a file transfer to the dialog. | |
61 * | |
62 * @param xfer The file transfer. | |
63 */ | |
15822 | 64 void finch_xfer_dialog_add_xfer(PurpleXfer *xfer); |
15817 | 65 |
66 /** | |
67 * Removes a file transfer from the dialog. | |
68 * | |
69 * @param xfer The file transfer. | |
70 */ | |
15822 | 71 void finch_xfer_dialog_remove_xfer(PurpleXfer *xfer); |
15817 | 72 |
73 /** | |
74 * Indicate in a file transfer dialog that a transfer was canceled. | |
75 * | |
76 * @param xfer The file transfer that was canceled. | |
77 */ | |
15822 | 78 void finch_xfer_dialog_cancel_xfer(PurpleXfer *xfer); |
15817 | 79 |
80 /** | |
81 * Updates the information for a transfer in the dialog. | |
82 * | |
83 * @param xfer The file transfer. | |
84 */ | |
15822 | 85 void finch_xfer_dialog_update_xfer(PurpleXfer *xfer); |
15817 | 86 |
87 /*@}*/ | |
88 | |
89 /**************************************************************************/ | |
90 /** @name GNT File Transfer API */ | |
91 /**************************************************************************/ | |
92 /*@{*/ | |
93 | |
94 /** | |
95 * Initializes the GNT file transfer system. | |
96 */ | |
97 void finch_xfers_init(void); | |
98 | |
99 /** | |
100 * Uninitializes the GNT file transfer system. | |
101 */ | |
102 void finch_xfers_uninit(void); | |
103 | |
104 /** | |
105 * Returns the UI operations structure for the GNT file transfer UI. | |
106 * | |
107 * @return The GNT file transfer UI operations structure. | |
108 */ | |
15822 | 109 PurpleXferUiOps *finch_xfers_get_ui_ops(void); |
15817 | 110 |
111 /*@}*/ | |
112 | |
15822 | 113 #endif /* _FINCHFT_H_ */ |