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 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  24 #error "Only <gio/gio.h> can be included directly."
  25 #endif
  26
  27 #ifndef __G_LOADABLE_ICON_H__
  28 #define __G_LOADABLE_ICON_H__
  29
  30 #include <glib-object.h>
  31 #include <gio/gicon.h>
  32 #include <gio/ginputstream.h>
  33
  34 G_BEGIN_DECLS
  35
  36 #define G_TYPE_LOADABLE_ICON            (g_loadable_icon_get_type ())
  37 #define G_LOADABLE_ICON(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_LOADABLE_ICON, GLoadableIcon))
  38 #define G_IS_LOADABLE_ICON(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_LOADABLE_ICON))
  39 #define G_LOADABLE_ICON_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_LOADABLE_ICON, GLoadableIconIface))
  40
  41 /**
  42  * GLoadableIcon:
  43  *
  44  * Generic interface for all kinds of icons that can be loaded as a stream to an image file.
  45  **/
  46 typedef struct _GLoadableIcon                   GLoadableIcon; /* Dummy typedef */
  47 typedef struct _GLoadableIconIface              GLoadableIconIface;
  48
  49 /**
  50  * GLoadableIconIface:
  51  * @g_iface: The parent interface.
  52  * @load: Loads an icon.
  53  * @load_async: Loads an icon asynchronously.
  54  * @load_finish: Finishes an asynchronous icon load.
  55  *
  56  **/
  57 struct _GLoadableIconIface
  58 {
  59   GTypeInterface g_iface;
  60
  61   /* Virtual Table */
  62
  63   GInputStream * (*load)        (GLoadableIcon      *icon,
  64                                  int                 size,
  65                                  char              **type,
  66                                  GCancellable       *cancellable,
  67                                  GError            **error);
  68   void           (*load_async)  (GLoadableIcon      *icon,
  69                                  int                 size,
  70                                  GCancellable       *cancellable,
  71                                  GAsyncReadyCallback callback,
  72                                  gpointer            user_data);
  73   GInputStream * (*load_finish) (GLoadableIcon      *icon,
  74                                   GAsyncResult      *res,
  75                                   char             **type,
  76                                   GError           **error);
  77 };
  78
  79 GType g_loadable_icon_get_type (void) G_GNUC_CONST;
  80
  81
  82 GInputStream *g_loadable_icon_load        (GLoadableIcon        *icon,
  83                                            int                   size,
  84                                            char                **type,
  85                                            GCancellable         *cancellable,
  86                                            GError              **error);
  87 void          g_loadable_icon_load_async  (GLoadableIcon        *icon,
  88                                            int                   size,
  89                                            GCancellable         *cancellable,
  90                                            GAsyncReadyCallback   callback,
  91                                            gpointer              user_data);
  92 GInputStream *g_loadable_icon_load_finish (GLoadableIcon        *icon,
  93                                            GAsyncResult         *res,
  94                                            char                **type,
  95                                            GError              **error);
  96
  97 G_END_DECLS
  98
  99 #endif /* __G_LOADABLE_ICON_H__ */