pidgin/gtkxfer.h

   1 /* pidgin
   2  *
   3  * Pidgin is the legal property of its developers, whose names are too numerous
   4  * to list here.  Please refer to the COPYRIGHT file distributed with this
   5  * source distribution.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  20  */
  21
  22 #ifndef _PIDGINXFER_H_
  23 #define _PIDGINXFER_H_
  24 /**
  25  * SECTION:gtkxfer
  26  * @section_id: pidgin-gtkxfer
  27  * @short_description: <filename>gtkxfer.h</filename>
  28  * @title: File Transfer UI
  29  */
  30
  31 #include "xfer.h"
  32
  33 G_BEGIN_DECLS
  34
  35 /**
  36  * PidginXferDialog:
  37  *
  38  * A file transfer dialog.
  39  *
  40  * The structure is opaque, as nobody should be touching anything inside of
  41  * it.
  42  */
  43 #define PIDGIN_TYPE_XFER_DIALOG (pidgin_xfer_dialog_get_type())
  44 G_DECLARE_FINAL_TYPE(PidginXferDialog, pidgin_xfer_dialog, PIDGIN, XFER_DIALOG,
  45                      GtkDialog)
  46
  47 /**************************************************************************/
  48 /* GTK+ File Transfer Dialog API                                          */
  49 /**************************************************************************/
  50
  51 /**
  52  * pidgin_xfer_dialog_new:
  53  *
  54  * Creates a new file transfer dialog.
  55  *
  56  * Returns: The new dialog.
  57  */
  58 PidginXferDialog *pidgin_xfer_dialog_new(void);
  59
  60 /**
  61  * pidgin_xfer_dialog_destroy:
  62  * @dialog: The file transfer dialog.
  63  *
  64  * Destroys a file transfer dialog.
  65  */
  66 void pidgin_xfer_dialog_destroy(PidginXferDialog *dialog);
  67
  68 /**
  69  * pidgin_xfer_dialog_show:
  70  * @dialog: The file transfer dialog to show.
  71  *
  72  * Displays the file transfer dialog given.
  73  * If dialog is %NULL, displays the default dialog, creating one if necessary
  74  */
  75 void pidgin_xfer_dialog_show(PidginXferDialog *dialog);
  76
  77 /**
  78  * pidgin_xfer_dialog_hide:
  79  * @dialog: The file transfer dialog to hide.
  80  *
  81  * Hides the file transfer dialog.
  82  */
  83 void pidgin_xfer_dialog_hide(PidginXferDialog *dialog);
  84
  85 /**
  86  * pidgin_xfer_dialog_add_xfer:
  87  * @dialog: The file transfer dialog.
  88  * @xfer:   The file transfer.
  89  *
  90  * Adds a file transfer to the dialog.
  91  */
  92 void pidgin_xfer_dialog_add_xfer(PidginXferDialog *dialog, PurpleXfer *xfer);
  93
  94 /**
  95  * pidgin_xfer_dialog_remove_xfer:
  96  * @dialog: The file transfer dialog.
  97  * @xfer:   The file transfer.
  98  *
  99  * Removes a file transfer from the dialog.
 100  */
 101 void pidgin_xfer_dialog_remove_xfer(PidginXferDialog *dialog,
 102                                                                          PurpleXfer *xfer);
 103
 104 /**
 105  * pidgin_xfer_dialog_cancel_xfer:
 106  * @dialog: The file transfer dialog.
 107  * @xfer:   The file transfer that was cancelled.
 108  *
 109  * Indicate in a file transfer dialog that a transfer was cancelled.
 110  */
 111 void pidgin_xfer_dialog_cancel_xfer(PidginXferDialog *dialog,
 112                                                                          PurpleXfer *xfer);
 113
 114 /**
 115  * pidgin_xfer_dialog_update_xfer:
 116  * @dialog: The file transfer dialog.
 117  * @xfer:   The file transfer.
 118  *
 119  * Updates the information for a transfer in the dialog.
 120  */
 121 void pidgin_xfer_dialog_update_xfer(PidginXferDialog *dialog,
 122                                                                          PurpleXfer *xfer);
 123
 124 /**************************************************************************/
 125 /* GTK+ File Transfer API                                                 */
 126 /**************************************************************************/
 127
 128 /**
 129  * pidgin_xfers_init:
 130  *
 131  * Initializes the GTK+ file transfer system.
 132  */
 133 void pidgin_xfers_init(void);
 134
 135 /**
 136  * pidgin_xfers_uninit:
 137  *
 138  * Uninitializes the GTK+ file transfer system.
 139  */
 140 void pidgin_xfers_uninit(void);
 141
 142 /**
 143  * pidgin_set_xfer_dialog:
 144  * @dialog: The main dialog.
 145  *
 146  * Sets pidgin's main file transfer dialog.
 147  */
 148 void pidgin_set_xfer_dialog(PidginXferDialog *dialog);
 149
 150 /**
 151  * pidgin_get_xfer_dialog:
 152  *
 153  * Returns pirgin's main file transfer dialog.
 154  *
 155  * Returns: The main dialog.
 156  */
 157 PidginXferDialog *pidgin_get_xfer_dialog(void);
 158
 159 /**
 160  * pidgin_xfers_get_ui_ops:
 161  *
 162  * Returns the UI operations structure for the GTK+ file transfer UI.
 163  *
 164  * Returns: The GTK+ file transfer UI operations structure.
 165  */
 166 PurpleXferUiOps *pidgin_xfers_get_ui_ops(void);
 167
 168 G_END_DECLS
 169
 170 #endif /* _PIDGINXFER_H_ */