pidgin/gtkft.h

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