finch/gntft.h

   1 /**
   2  * @file gntft.h GNT File Transfer UI
   3  * @ingroup finch
   4  */
   5
   6 /* finch
   7  *
   8  * Finch 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 _FINCHFT_H_
  27 #define _FINCHFT_H_
  28
  29 #include "ft.h"
  30
  31
  32 /**************************************************************************/
  33 /** @name GNT File Transfer Dialog API                                    */
  34 /**************************************************************************/
  35 /*@{*/
  36
  37 /**
  38  * Creates a new file transfer dialog.
  39  *
  40  * @return The new dialog.
  41  */
  42 void finch_xfer_dialog_new(void);
  43
  44 /**
  45  * Destroys a file transfer dialog.
  46  */
  47 void finch_xfer_dialog_destroy(void);
  48
  49 /**
  50  * Displays the file transfer dialog given.
  51  * If dialog is @c NULL, displays the default dialog, creating one if necessary
  52  */
  53 void finch_xfer_dialog_show(void);
  54
  55 /**
  56  * Hides the file transfer dialog.
  57  */
  58 void finch_xfer_dialog_hide();
  59
  60 /**
  61  * Adds a file transfer to the dialog.
  62  *
  63  * @param xfer   The file transfer.
  64  */
  65 void finch_xfer_dialog_add_xfer(PurpleXfer *xfer);
  66
  67 /**
  68  * Removes a file transfer from the dialog.
  69  *
  70  * @param xfer   The file transfer.
  71  */
  72 void finch_xfer_dialog_remove_xfer(PurpleXfer *xfer);
  73
  74 /**
  75  * Indicate in a file transfer dialog that a transfer was canceled.
  76  *
  77  * @param xfer   The file transfer that was canceled.
  78  */
  79 void finch_xfer_dialog_cancel_xfer(PurpleXfer *xfer);
  80
  81 /**
  82  * Updates the information for a transfer in the dialog.
  83  *
  84  * @param xfer   The file transfer.
  85  */
  86 void finch_xfer_dialog_update_xfer(PurpleXfer *xfer);
  87
  88 /*@}*/
  89
  90 /**************************************************************************/
  91 /** @name GNT  File Transfer API                                          */
  92 /**************************************************************************/
  93 /*@{*/
  94
  95 /**
  96  * Initializes the GNT file transfer system.
  97  */
  98 void finch_xfers_init(void);
  99
 100 /**
 101  * Uninitializes the GNT file transfer system.
 102  */
 103 void finch_xfers_uninit(void);
 104
 105 /**
 106  * Returns the UI operations structure for the GNT file transfer UI.
 107  *
 108  * @return The GNT file transfer UI operations structure.
 109  */
 110 PurpleXferUiOps *finch_xfers_get_ui_ops(void);
 111
 112 /*@}*/
 113
 114 #endif /* _FINCHFT_H_ */