comparison: finch/gntxfer.h
finch/gntxfer.h
- changeset 42678
- 0b9b81b6ff18
- parent 42677
- 66b49e545c53
- child 42679
- 192a8112562f
equal
deleted
inserted
replaced
| 42677:66b49e545c53 | 42678:0b9b81b6ff18 |
|---|---|
| 1 /* | |
| 2 * finch | |
| 3 * | |
| 4 * Finch is the legal property of its developers, whose names are too numerous | |
| 5 * to list here. Please refer to the COPYRIGHT file distributed with this | |
| 6 * source distribution. | |
| 7 * | |
| 8 * This program is free software; you can redistribute it and/or modify | |
| 9 * it under the terms of the GNU General Public License as published by | |
| 10 * the Free Software Foundation; either version 2 of the License, or | |
| 11 * (at your option) any later version. | |
| 12 * | |
| 13 * This program is distributed in the hope that it will be useful, | |
| 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 16 * GNU General Public License for more details. | |
| 17 * | |
| 18 * You should have received a copy of the GNU General Public License | |
| 19 * along with this program; if not, write to the Free Software | |
| 20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA | |
| 21 */ | |
| 22 | |
| 23 #if !defined(FINCH_GLOBAL_HEADER_INSIDE) && !defined(FINCH_COMPILATION) | |
| 24 # error "only <finch.h> may be included directly" | |
| 25 #endif | |
| 26 | |
| 27 #ifndef FINCH_XFER_H | |
| 28 #define FINCH_XFER_H | |
| 29 | |
| 30 #include <purple.h> | |
| 31 | |
| 32 /**************************************************************************/ | |
| 33 /* GNT File Transfer Dialog API */ | |
| 34 /**************************************************************************/ | |
| 35 | |
| 36 /** | |
| 37 * finch_xfer_dialog_new: | |
| 38 * | |
| 39 * Creates a new file transfer dialog. | |
| 40 */ | |
| 41 void finch_xfer_dialog_new(void); | |
| 42 | |
| 43 /** | |
| 44 * finch_xfer_dialog_destroy: | |
| 45 * | |
| 46 * Destroys a file transfer dialog. | |
| 47 */ | |
| 48 void finch_xfer_dialog_destroy(void); | |
| 49 | |
| 50 /** | |
| 51 * finch_xfer_dialog_show: | |
| 52 * | |
| 53 * Displays the file transfer dialog given. | |
| 54 * If dialog is %NULL, displays the default dialog, creating one if necessary | |
| 55 */ | |
| 56 void finch_xfer_dialog_show(void); | |
| 57 | |
| 58 /** | |
| 59 * finch_xfer_dialog_hide: | |
| 60 * | |
| 61 * Hides the file transfer dialog. | |
| 62 */ | |
| 63 void finch_xfer_dialog_hide(void); | |
| 64 | |
| 65 /** | |
| 66 * finch_xfer_dialog_add_xfer: | |
| 67 * @xfer: The file transfer. | |
| 68 * | |
| 69 * Adds a file transfer to the dialog. | |
| 70 */ | |
| 71 void finch_xfer_dialog_add_xfer(PurpleXfer *xfer); | |
| 72 | |
| 73 /** | |
| 74 * finch_xfer_dialog_remove_xfer: | |
| 75 * @xfer: The file transfer. | |
| 76 * | |
| 77 * Removes a file transfer from the dialog. | |
| 78 */ | |
| 79 void finch_xfer_dialog_remove_xfer(PurpleXfer *xfer); | |
| 80 | |
| 81 /** | |
| 82 * finch_xfer_dialog_cancel_xfer: | |
| 83 * @xfer: The file transfer that was cancelled. | |
| 84 * | |
| 85 * Indicate in a file transfer dialog that a transfer was cancelled. | |
| 86 */ | |
| 87 void finch_xfer_dialog_cancel_xfer(PurpleXfer *xfer); | |
| 88 | |
| 89 /** | |
| 90 * finch_xfer_dialog_update_xfer: | |
| 91 * @xfer: The file transfer. | |
| 92 * | |
| 93 * Updates the information for a transfer in the dialog. | |
| 94 */ | |
| 95 void finch_xfer_dialog_update_xfer(PurpleXfer *xfer); | |
| 96 | |
| 97 /**************************************************************************/ | |
| 98 /* GNT File Transfer API */ | |
| 99 /**************************************************************************/ | |
| 100 | |
| 101 /** | |
| 102 * finch_xfers_init: | |
| 103 * | |
| 104 * Initializes the GNT file transfer system. | |
| 105 */ | |
| 106 void finch_xfers_init(void); | |
| 107 | |
| 108 /** | |
| 109 * finch_xfers_uninit: | |
| 110 * | |
| 111 * Uninitializes the GNT file transfer system. | |
| 112 */ | |
| 113 void finch_xfers_uninit(void); | |
| 114 | |
| 115 /** | |
| 116 * finch_xfers_get_ui_ops: | |
| 117 * | |
| 118 * Returns the UI operations structure for the GNT file transfer UI. | |
| 119 * | |
| 120 * Returns: The GNT file transfer UI operations structure. | |
| 121 */ | |
| 122 PurpleXferUiOps *finch_xfers_get_ui_ops(void); | |
| 123 | |
| 124 #endif /* FINCH_XFER_H */ | |
| 125 |
