pidgin/gtkxfer.h

branch
soc.2013.gobjectification.plugins
changeset 37017
8e2b68c79fa1
parent 35038
c29644627f31
child 37021
04c99b24db84
equal deleted inserted replaced
37016:48f85579cc4c 37017:8e2b68c79fa1
44 /*@{*/ 44 /*@{*/
45 45
46 /** 46 /**
47 * Creates a new file transfer dialog. 47 * Creates a new file transfer dialog.
48 * 48 *
49 * @return The new dialog. 49 * Returns: The new dialog.
50 */ 50 */
51 PidginXferDialog *pidgin_xfer_dialog_new(void); 51 PidginXferDialog *pidgin_xfer_dialog_new(void);
52 52
53 /** 53 /**
54 * Destroys a file transfer dialog. 54 * Destroys a file transfer dialog.
55 * 55 *
56 * @param dialog The file transfer dialog. 56 * @dialog: The file transfer dialog.
57 */ 57 */
58 void pidgin_xfer_dialog_destroy(PidginXferDialog *dialog); 58 void pidgin_xfer_dialog_destroy(PidginXferDialog *dialog);
59 59
60 /** 60 /**
61 * Displays the file transfer dialog given. 61 * Displays the file transfer dialog given.
62 * If dialog is @c NULL, displays the default dialog, creating one if necessary 62 * If dialog is @c NULL, displays the default dialog, creating one if necessary
63 * 63 *
64 * @param dialog The file transfer dialog to show. 64 * @dialog: The file transfer dialog to show.
65 */ 65 */
66 void pidgin_xfer_dialog_show(PidginXferDialog *dialog); 66 void pidgin_xfer_dialog_show(PidginXferDialog *dialog);
67 67
68 /** 68 /**
69 * Hides the file transfer dialog. 69 * Hides the file transfer dialog.
70 * 70 *
71 * @param dialog The file transfer dialog to hide. 71 * @dialog: The file transfer dialog to hide.
72 */ 72 */
73 void pidgin_xfer_dialog_hide(PidginXferDialog *dialog); 73 void pidgin_xfer_dialog_hide(PidginXferDialog *dialog);
74 74
75 /** 75 /**
76 * Adds a file transfer to the dialog. 76 * Adds a file transfer to the dialog.
77 * 77 *
78 * @param dialog The file transfer dialog. 78 * @dialog: The file transfer dialog.
79 * @param xfer The file transfer. 79 * @xfer: The file transfer.
80 */ 80 */
81 void pidgin_xfer_dialog_add_xfer(PidginXferDialog *dialog, PurpleXfer *xfer); 81 void pidgin_xfer_dialog_add_xfer(PidginXferDialog *dialog, PurpleXfer *xfer);
82 82
83 /** 83 /**
84 * Removes a file transfer from the dialog. 84 * Removes a file transfer from the dialog.
85 * 85 *
86 * @param dialog The file transfer dialog. 86 * @dialog: The file transfer dialog.
87 * @param xfer The file transfer. 87 * @xfer: The file transfer.
88 */ 88 */
89 void pidgin_xfer_dialog_remove_xfer(PidginXferDialog *dialog, 89 void pidgin_xfer_dialog_remove_xfer(PidginXferDialog *dialog,
90 PurpleXfer *xfer); 90 PurpleXfer *xfer);
91 91
92 /** 92 /**
93 * Indicate in a file transfer dialog that a transfer was cancelled. 93 * Indicate in a file transfer dialog that a transfer was cancelled.
94 * 94 *
95 * @param dialog The file transfer dialog. 95 * @dialog: The file transfer dialog.
96 * @param xfer The file transfer that was cancelled. 96 * @xfer: The file transfer that was cancelled.
97 */ 97 */
98 void pidgin_xfer_dialog_cancel_xfer(PidginXferDialog *dialog, 98 void pidgin_xfer_dialog_cancel_xfer(PidginXferDialog *dialog,
99 PurpleXfer *xfer); 99 PurpleXfer *xfer);
100 100
101 /** 101 /**
102 * Updates the information for a transfer in the dialog. 102 * Updates the information for a transfer in the dialog.
103 * 103 *
104 * @param dialog The file transfer dialog. 104 * @dialog: The file transfer dialog.
105 * @param xfer The file transfer. 105 * @xfer: The file transfer.
106 */ 106 */
107 void pidgin_xfer_dialog_update_xfer(PidginXferDialog *dialog, 107 void pidgin_xfer_dialog_update_xfer(PidginXferDialog *dialog,
108 PurpleXfer *xfer); 108 PurpleXfer *xfer);
109 109
110 /*@}*/ 110 /*@}*/
125 void pidgin_xfers_uninit(void); 125 void pidgin_xfers_uninit(void);
126 126
127 /** 127 /**
128 * Sets pidgin's main file transfer dialog. 128 * Sets pidgin's main file transfer dialog.
129 * 129 *
130 * @param dialog The main dialog. 130 * @dialog: The main dialog.
131 */ 131 */
132 void pidgin_set_xfer_dialog(PidginXferDialog *dialog); 132 void pidgin_set_xfer_dialog(PidginXferDialog *dialog);
133 133
134 /** 134 /**
135 * Returns pirgin's main file transfer dialog. 135 * Returns pirgin's main file transfer dialog.
136 * 136 *
137 * @return The main dialog. 137 * Returns: The main dialog.
138 */ 138 */
139 PidginXferDialog *pidgin_get_xfer_dialog(void); 139 PidginXferDialog *pidgin_get_xfer_dialog(void);
140 140
141 /** 141 /**
142 * Returns the UI operations structure for the GTK+ file transfer UI. 142 * Returns the UI operations structure for the GTK+ file transfer UI.
143 * 143 *
144 * @return The GTK+ file transfer UI operations structure. 144 * Returns: The GTK+ file transfer UI operations structure.
145 */ 145 */
146 PurpleXferUiOps *pidgin_xfers_get_ui_ops(void); 146 PurpleXferUiOps *pidgin_xfers_get_ui_ops(void);
147 147
148 /*@}*/ 148 /*@}*/
149 149

mercurial