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 /**
  34  * PidginXferDialog:
  35  *
  36  * A file transfer dialog.
  37  *
  38  * The structure is opaque, as nobody should be touching anything inside of
  39  * it.
  40  */
  41 typedef struct _PidginXferDialog PidginXferDialog;
  42
  43 #define PIDGIN_TYPE_XFER_DIALOG (pidgin_xfer_dialog_get_type())
  44
  45 G_BEGIN_DECLS
  46
  47 /**************************************************************************/
  48 /* GTK+ File Transfer Dialog API                                          */
  49 /**************************************************************************/
  50
  51 /**
  52  * pidgin_xfer_dialog_get_type:
  53  *
  54  * Returns: The #GType for the #PidginXferDialog boxed structure.
  55  */
  56 GType pidgin_xfer_dialog_get_type(void);
  57
  58 /**
  59  * pidgin_xfer_dialog_new:
  60  *
  61  * Creates a new file transfer dialog.
  62  *
  63  * Returns: The new dialog.
  64  */
  65 PidginXferDialog *pidgin_xfer_dialog_new(void);
  66
  67 /**
  68  * pidgin_xfer_dialog_destroy:
  69  * @dialog: The file transfer dialog.
  70  *
  71  * Destroys a file transfer dialog.
  72  */
  73 void pidgin_xfer_dialog_destroy(PidginXferDialog *dialog);
  74
  75 /**
  76  * pidgin_xfer_dialog_show:
  77  * @dialog: The file transfer dialog to show.
  78  *
  79  * Displays the file transfer dialog given.
  80  * If dialog is %NULL, displays the default dialog, creating one if necessary
  81  */
  82 void pidgin_xfer_dialog_show(PidginXferDialog *dialog);
  83
  84 /**
  85  * pidgin_xfer_dialog_hide:
  86  * @dialog: The file transfer dialog to hide.
  87  *
  88  * Hides the file transfer dialog.
  89  */
  90 void pidgin_xfer_dialog_hide(PidginXferDialog *dialog);
  91
  92 /**
  93  * pidgin_xfer_dialog_add_xfer:
  94  * @dialog: The file transfer dialog.
  95  * @xfer:   The file transfer.
  96  *
  97  * Adds a file transfer to the dialog.
  98  */
  99 void pidgin_xfer_dialog_add_xfer(PidginXferDialog *dialog, PurpleXfer *xfer);
 100
 101 /**
 102  * pidgin_xfer_dialog_remove_xfer:
 103  * @dialog: The file transfer dialog.
 104  * @xfer:   The file transfer.
 105  *
 106  * Removes a file transfer from the dialog.
 107  */
 108 void pidgin_xfer_dialog_remove_xfer(PidginXferDialog *dialog,
 109                                                                          PurpleXfer *xfer);
 110
 111 /**
 112  * pidgin_xfer_dialog_cancel_xfer:
 113  * @dialog: The file transfer dialog.
 114  * @xfer:   The file transfer that was cancelled.
 115  *
 116  * Indicate in a file transfer dialog that a transfer was cancelled.
 117  */
 118 void pidgin_xfer_dialog_cancel_xfer(PidginXferDialog *dialog,
 119                                                                          PurpleXfer *xfer);
 120
 121 /**
 122  * pidgin_xfer_dialog_update_xfer:
 123  * @dialog: The file transfer dialog.
 124  * @xfer:   The file transfer.
 125  *
 126  * Updates the information for a transfer in the dialog.
 127  */
 128 void pidgin_xfer_dialog_update_xfer(PidginXferDialog *dialog,
 129                                                                          PurpleXfer *xfer);
 130
 131 /**************************************************************************/
 132 /* GTK+ File Transfer API                                                 */
 133 /**************************************************************************/
 134
 135 /**
 136  * pidgin_xfers_init:
 137  *
 138  * Initializes the GTK+ file transfer system.
 139  */
 140 void pidgin_xfers_init(void);
 141
 142 /**
 143  * pidgin_xfers_uninit:
 144  *
 145  * Uninitializes the GTK+ file transfer system.
 146  */
 147 void pidgin_xfers_uninit(void);
 148
 149 /**
 150  * pidgin_set_xfer_dialog:
 151  * @dialog: The main dialog.
 152  *
 153  * Sets pidgin's main file transfer dialog.
 154  */
 155 void pidgin_set_xfer_dialog(PidginXferDialog *dialog);
 156
 157 /**
 158  * pidgin_get_xfer_dialog:
 159  *
 160  * Returns pirgin's main file transfer dialog.
 161  *
 162  * Returns: The main dialog.
 163  */
 164 PidginXferDialog *pidgin_get_xfer_dialog(void);
 165
 166 /**
 167  * pidgin_xfers_get_ui_ops:
 168  *
 169  * Returns the UI operations structure for the GTK+ file transfer UI.
 170  *
 171  * Returns: The GTK+ file transfer UI operations structure.
 172  */
 173 PurpleXferUiOps *pidgin_xfers_get_ui_ops(void);
 174
 175 G_END_DECLS
 176
 177 #endif /* _PIDGINXFER_H_ */