libempathy/empathy-ft-handler.h

   1 /*
   2  * empathy-ft-handler.h - Header for EmpathyFTHandler
   3  * Copyright (C) 2009 Collabora Ltd.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  18  *
  19  * Author: Cosimo Cecchi <cosimo.cecchi@collabora.co.uk>
  20  */
  21
  22 /* empathy-ft-handler.h */
  23
  24 #ifndef __EMPATHY_FT_HANDLER_H__
  25 #define __EMPATHY_FT_HANDLER_H__
  26
  27 #include <glib-object.h>
  28 #include <gio/gio.h>
  29
  30 #include "empathy-tp-file.h"
  31 #include "empathy-contact.h"
  32
  33 G_BEGIN_DECLS
  34
  35 #define EMPATHY_TYPE_FT_HANDLER empathy_ft_handler_get_type()
  36 #define EMPATHY_FT_HANDLER(obj) \
  37   (G_TYPE_CHECK_INSTANCE_CAST ((obj), EMPATHY_TYPE_FT_HANDLER, EmpathyFTHandler))
  38 #define EMPATHY_FT_HANDLER_CLASS(klass) \
  39   (G_TYPE_CHECK_CLASS_CAST ((klass), EMPATHY_TYPE_FT_HANDLER, EmpathyFTHandlerClass))
  40 #define EMPATHY_IS_FT_HANDLER(obj) \
  41   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), EMPATHY_TYPE_FT_HANDLER))
  42 #define EMPATHY_IS_FT_HANDLER_CLASS(klass) \
  43   (G_TYPE_CHECK_CLASS_TYPE ((klass), EMPATHY_TYPE_FT_HANDLER))
  44 #define EMPATHY_FT_HANDLER_GET_CLASS(obj) \
  45   (G_TYPE_INSTANCE_GET_CLASS ((obj), EMPATHY_TYPE_FT_HANDLER, EmpathyFTHandlerClass))
  46
  47 typedef struct {
  48   GObject parent;
  49   gpointer priv;
  50 } EmpathyFTHandler;
  51
  52 typedef struct {
  53   GObjectClass parent_class;
  54 } EmpathyFTHandlerClass;
  55
  56 typedef void (* EmpathyFTHandlerReadyCallback) (EmpathyFTHandler *handler,
  57                                                 GError *error,
  58                                                 gpointer user_data);
  59
  60 GType empathy_ft_handler_get_type (void);
  61
  62 /* public methods */
  63 void empathy_ft_handler_new_outgoing (EmpathyContact *contact,
  64     GFile *source, EmpathyFTHandlerReadyCallback callback,
  65     gpointer user_data);
  66
  67 void empathy_ft_handler_new_incoming (EmpathyTpFile *tp_file,
  68     EmpathyFTHandlerReadyCallback callback, gpointer user_data);
  69 void empathy_ft_handler_incoming_set_destination (EmpathyFTHandler *handler,
  70     GFile *destination);
  71
  72 void empathy_ft_handler_start_transfer (EmpathyFTHandler *handler);
  73 void empathy_ft_handler_cancel_transfer (EmpathyFTHandler *handler);
  74
  75 /* properties of the transfer */
  76 const char * empathy_ft_handler_get_filename (EmpathyFTHandler *handler);
  77 const char * empathy_ft_handler_get_content_type (EmpathyFTHandler *handler);
  78 EmpathyContact * empathy_ft_handler_get_contact (EmpathyFTHandler *handler);
  79 GFile * empathy_ft_handler_get_gfile (EmpathyFTHandler *handler);
  80 gboolean empathy_ft_handler_is_incoming (EmpathyFTHandler *handler);
  81 guint64 empathy_ft_handler_get_transferred_bytes (EmpathyFTHandler *handler);
  82 guint64 empathy_ft_handler_get_total_bytes (EmpathyFTHandler *handler);
  83 gboolean empathy_ft_handler_is_completed (EmpathyFTHandler *handler);
  84 gboolean empathy_ft_handler_is_cancelled (EmpathyFTHandler *handler);
  85
  86 G_END_DECLS
  87
  88 #endif /* __EMPATHY_FT_HANDLER_H__ */