comparison src/gtkft.h @ 4553:d03fcb3f4be2

[gaim-migrate @ 4833] We have a brand new file transfer dialog! committer: Tailor Script <tailor@pidgin.im>
author Christian Hammond <chipx86@chipx86.com>
date Fri, 07 Feb 2003 20:55:20 +0000
parents 7521e29658bc
children aa2ceea841b4
comparison
equal deleted inserted replaced
4552:a2f2a717fdf2 4553:d03fcb3f4be2
21 * 21 *
22 */ 22 */
23 #ifndef _GAIM_GTK_FT_H_ 23 #ifndef _GAIM_GTK_FT_H_
24 #define _GAIM_GTK_FT_H_ 24 #define _GAIM_GTK_FT_H_
25 25
26 #include "ft.h"
27
28 /**
29 * A file transfer dialog.
30 *
31 * The structure is opaque, as nobody should be touching anything inside of
32 * it.
33 */
34 struct gaim_gtkxfer_dialog;
35
36 /**************************************************************************/
37 /** @name GTK+ File Transfer Dialog API */
38 /**************************************************************************/
39 /*@{*/
40
41 /**
42 * Creates a new file transfer dialog.
43 *
44 * @return The new dialog.
45 */
46 struct gaim_gtkxfer_dialog *gaim_gtkxfer_dialog_new(void);
47
48 /**
49 * Destroys a file transfer dialog.
50 *
51 * @param dialog The file transfer dialog.
52 */
53 void gaim_gtkxfer_dialog_destroy(struct gaim_gtkxfer_dialog *dialog);
54
55 /**
56 * Displays the file transfer dialog.
57 *
58 * @param dialog The file transfer dialog to show.
59 */
60 void gaim_gtkxfer_dialog_show(struct gaim_gtkxfer_dialog *dialog);
61
62 /**
63 * Hides the file transfer dialog.
64 *
65 * @param dialog The file transfer dialog to hide.
66 */
67 void gaim_gtkxfer_dialog_hide(struct gaim_gtkxfer_dialog *dialog);
68
69 /**
70 * Adds a file transfer to the dialog.
71 *
72 * @param dialog The file transfer dialog.
73 * @param xfer The file transfer.
74 */
75 void gaim_gtkxfer_dialog_add_xfer(struct gaim_gtkxfer_dialog *dialog,
76 struct gaim_xfer *xfer);
77
78 /**
79 * Removes a file transfer from the dialog.
80 *
81 * @param dialog The file transfer dialog.
82 * @param xfer The file transfer.
83 */
84 void gaim_gtkxfer_dialog_remove_xfer(struct gaim_gtkxfer_dialog *dialog,
85 struct gaim_xfer *xfer);
86
87 /**
88 * Indicate in a file transfer dialog that a transfer was canceled.
89 *
90 * @param dialog The file transfer dialog.
91 * @param xfer The file transfer that was canceled.
92 */
93 void gaim_gtkxfer_dialog_cancel_xfer(struct gaim_gtkxfer_dialog *dialog,
94 struct gaim_xfer *xfer);
95
96 /**
97 * Updates the information for a transfer in the dialog.
98 *
99 * @param dialog The file transfer dialog.
100 * @param xfer The file transfer.
101 */
102 void gaim_gtkxfer_dialog_update_xfer(struct gaim_gtkxfer_dialog *dialog,
103 struct gaim_xfer *xfer);
104
105 /*@}*/
106
26 /**************************************************************************/ 107 /**************************************************************************/
27 /** @name GTK+ File Transfer API */ 108 /** @name GTK+ File Transfer API */
28 /**************************************************************************/ 109 /**************************************************************************/
29 /*@{*/ 110 /*@{*/
30 111
31 /** 112 /**
32 * Displays the file transfer dialog. 113 * Sets gaim's main file transfer dialog.
114 *
115 * @param dialog The main dialog.
33 */ 116 */
34 void gaim_gtkxfer_dialog_show(void); 117 void gaim_set_gtkxfer_dialog(struct gaim_gtkxfer_dialog *dialog);
35 118
36 /** 119 /**
37 * Hides the file transfer dialog. 120 * Returns gaim's main file transfer dialog.
121 *
122 * @return The main dialog.
38 */ 123 */
39 void gaim_gtkxfer_dialog_hide(void); 124 struct gaim_gtkxfer_dialog *gaim_get_gtkxfer_dialog(void);
40 125
41 /** 126 /**
42 * Returns the UI operations structure for the GTK+ file transfer UI. 127 * Returns the UI operations structure for the GTK+ file transfer UI.
43 * 128 *
44 * @return The GTK+ file transfer UI operations structure. 129 * @return The GTK+ file transfer UI operations structure.