finch/gntxfer.h

   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 #ifndef FINCH_XFER_H
  24 #define FINCH_XFER_H
  25
  26 /**
  27  * SECTION:gntxfer
  28  * @section_id: finch-gntxfer
  29  * @short_description: <filename>gntxfer.h</filename>
  30  * @title: File Transfer UI
  31  */
  32
  33 #include "xfer.h"
  34
  35
  36 /**************************************************************************/
  37 /* GNT File Transfer Dialog API                                           */
  38 /**************************************************************************/
  39
  40 /**
  41  * finch_xfer_dialog_new:
  42  *
  43  * Creates a new file transfer dialog.
  44  */
  45 void finch_xfer_dialog_new(void);
  46
  47 /**
  48  * finch_xfer_dialog_destroy:
  49  *
  50  * Destroys a file transfer dialog.
  51  */
  52 void finch_xfer_dialog_destroy(void);
  53
  54 /**
  55  * finch_xfer_dialog_show:
  56  *
  57  * Displays the file transfer dialog given.
  58  * If dialog is %NULL, displays the default dialog, creating one if necessary
  59  */
  60 void finch_xfer_dialog_show(void);
  61
  62 /**
  63  * finch_xfer_dialog_hide:
  64  *
  65  * Hides the file transfer dialog.
  66  */
  67 void finch_xfer_dialog_hide(void);
  68
  69 /**
  70  * finch_xfer_dialog_add_xfer:
  71  * @xfer:   The file transfer.
  72  *
  73  * Adds a file transfer to the dialog.
  74  */
  75 void finch_xfer_dialog_add_xfer(PurpleXfer *xfer);
  76
  77 /**
  78  * finch_xfer_dialog_remove_xfer:
  79  * @xfer:   The file transfer.
  80  *
  81  * Removes a file transfer from the dialog.
  82  */
  83 void finch_xfer_dialog_remove_xfer(PurpleXfer *xfer);
  84
  85 /**
  86  * finch_xfer_dialog_cancel_xfer:
  87  * @xfer:   The file transfer that was cancelled.
  88  *
  89  * Indicate in a file transfer dialog that a transfer was cancelled.
  90  */
  91 void finch_xfer_dialog_cancel_xfer(PurpleXfer *xfer);
  92
  93 /**
  94  * finch_xfer_dialog_update_xfer:
  95  * @xfer:   The file transfer.
  96  *
  97  * Updates the information for a transfer in the dialog.
  98  */
  99 void finch_xfer_dialog_update_xfer(PurpleXfer *xfer);
 100
 101 /**************************************************************************/
 102 /* GNT  File Transfer API                                                 */
 103 /**************************************************************************/
 104
 105 /**
 106  * finch_xfers_init:
 107  *
 108  * Initializes the GNT file transfer system.
 109  */
 110 void finch_xfers_init(void);
 111
 112 /**
 113  * finch_xfers_uninit:
 114  *
 115  * Uninitializes the GNT file transfer system.
 116  */
 117 void finch_xfers_uninit(void);
 118
 119 /**
 120  * finch_xfers_get_ui_ops:
 121  *
 122  * Returns the UI operations structure for the GNT file transfer UI.
 123  *
 124  * Returns: The GNT file transfer UI operations structure.
 125  */
 126 PurpleXferUiOps *finch_xfers_get_ui_ops(void);
 127
 128 #endif /* FINCH_XFER_H */
 129