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), \
  38    EMPATHY_TYPE_FT_HANDLER, EmpathyFTHandler))
  39 #define EMPATHY_FT_HANDLER_CLASS(klass) \
  40   (G_TYPE_CHECK_CLASS_CAST ((klass), \
  41    EMPATHY_TYPE_FT_HANDLER, EmpathyFTHandlerClass))
  42 #define EMPATHY_IS_FT_HANDLER(obj) \
  43   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), EMPATHY_TYPE_FT_HANDLER))
  44 #define EMPATHY_IS_FT_HANDLER_CLASS(klass) \
  45   (G_TYPE_CHECK_CLASS_TYPE ((klass), EMPATHY_TYPE_FT_HANDLER))
  46 #define EMPATHY_FT_HANDLER_GET_CLASS(obj) \
  47   (G_TYPE_INSTANCE_GET_CLASS ((obj), \
  48    EMPATHY_TYPE_FT_HANDLER, EmpathyFTHandlerClass))
  49
  50 typedef struct {
  51   GObject parent;
  52   gpointer priv;
  53 } EmpathyFTHandler;
  54
  55 typedef struct {
  56   GObjectClass parent_class;
  57 } EmpathyFTHandlerClass;
  58
  59 /**
  60  * EmpathyFTHandlerReadyCallback:
  61  * @handler: the handler which is now ready
  62  * @error: a #GError if the operation failed, or %NULL
  63  * @user_data: user data passed to the callback
  64  */
  65 typedef void (* EmpathyFTHandlerReadyCallback) (EmpathyFTHandler *handler,
  66     GError *error,
  67     gpointer user_data);
  68
  69 GType empathy_ft_handler_get_type (void);
  70
  71 /* public methods */
  72 void empathy_ft_handler_new_outgoing (EmpathyContact *contact,
  73     GFile *source,
  74     EmpathyFTHandlerReadyCallback callback,
  75     gpointer user_data);
  76
  77 void empathy_ft_handler_new_incoming (EmpathyTpFile *tp_file,
  78     EmpathyFTHandlerReadyCallback callback,
  79     gpointer user_data);
  80 void empathy_ft_handler_incoming_set_destination (EmpathyFTHandler *handler,
  81     GFile *destination);
  82
  83 void empathy_ft_handler_start_transfer (EmpathyFTHandler *handler);
  84 void empathy_ft_handler_cancel_transfer (EmpathyFTHandler *handler);
  85
  86 /* properties of the transfer */
  87 const char * empathy_ft_handler_get_filename (EmpathyFTHandler *handler);
  88 const char * empathy_ft_handler_get_content_type (EmpathyFTHandler *handler);
  89 EmpathyContact * empathy_ft_handler_get_contact (EmpathyFTHandler *handler);
  90 GFile * empathy_ft_handler_get_gfile (EmpathyFTHandler *handler);
  91 gboolean empathy_ft_handler_get_use_hash (EmpathyFTHandler *handler);
  92 gboolean empathy_ft_handler_is_incoming (EmpathyFTHandler *handler);
  93 guint64 empathy_ft_handler_get_transferred_bytes (EmpathyFTHandler *handler);
  94 guint64 empathy_ft_handler_get_total_bytes (EmpathyFTHandler *handler);
  95 gboolean empathy_ft_handler_is_completed (EmpathyFTHandler *handler);
  96 gboolean empathy_ft_handler_is_cancelled (EmpathyFTHandler *handler);
  97
  98 G_END_DECLS
  99
 100 #endif /* __EMPATHY_FT_HANDLER_H__ */