gio/gloadableicon.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   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 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
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 #ifndef __G_LOADABLE_ICON_H__
  24 #define __G_LOADABLE_ICON_H__
  25
  26 #include <glib-object.h>
  27 #include <gio/gicon.h>
  28 #include <gio/ginputstream.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define G_TYPE_LOADABLE_ICON            (g_loadable_icon_get_type ())
  33 #define G_LOADABLE_ICON(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_LOADABLE_ICON, GLoadableIcon))
  34 #define G_IS_LOADABLE_ICON(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_LOADABLE_ICON))
  35 #define G_LOADABLE_ICON_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_LOADABLE_ICON, GLoadableIconIface))
  36
  37 /**
  38  * GLoadableIcon:
  39  *
  40  * Dummy type for subclassing loadable icon types.
  41  **/
  42 typedef struct _GLoadableIcon                   GLoadableIcon; /* Dummy typedef */
  43 typedef struct _GLoadableIconIface              GLoadableIconIface;
  44
  45 /**
  46  * GLoadableIconIface:
  47  * @g_iface: The parent interface.
  48  * @load: Loads an icon.
  49  * @load_async: Loads an icon asynchronously.
  50  * @load_finish: Finishes an asynchronous icon load.
  51  *
  52  * GLoadableIconIface is used for implementing loadable icon types,
  53  * for implementations that need to load an icon.
  54  **/
  55 struct _GLoadableIconIface
  56 {
  57   GTypeInterface g_iface;
  58
  59   /* Virtual Table */
  60
  61   GInputStream * (*load)        (GLoadableIcon      *icon,
  62                                  int                 size,
  63                                  char              **type,
  64                                  GCancellable       *cancellable,
  65                                  GError            **error);
  66   void           (*load_async)  (GLoadableIcon      *icon,
  67                                  int                 size,
  68                                  GCancellable       *cancellable,
  69                                  GAsyncReadyCallback callback,
  70                                  gpointer            user_data);
  71   GInputStream * (*load_finish) (GLoadableIcon      *icon,
  72                                   GAsyncResult      *res,
  73                                   char             **type,
  74                                   GError           **error);
  75 };
  76
  77 GType g_loadable_icon_get_type (void) G_GNUC_CONST;
  78
  79
  80 GInputStream *g_loadable_icon_load        (GLoadableIcon        *icon,
  81                                            int                   size,
  82                                            char                **type,
  83                                            GCancellable         *cancellable,
  84                                            GError              **error);
  85 void          g_loadable_icon_load_async  (GLoadableIcon        *icon,
  86                                            int                   size,
  87                                            GCancellable         *cancellable,
  88                                            GAsyncReadyCallback   callback,
  89                                            gpointer              user_data);
  90 GInputStream *g_loadable_icon_load_finish (GLoadableIcon        *icon,
  91                                            GAsyncResult         *res,
  92                                            char                **type,
  93                                            GError              **error);
  94
  95 G_END_DECLS
  96
  97 #endif /* __G_LOADABLE_ICON_H__ */