Home | History | Annotate | Download | only in gio 
      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 (at) 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 <gio/giotypes.h>
     31 
     32 G_BEGIN_DECLS
     33 
     34 #define G_TYPE_LOADABLE_ICON            (g_loadable_icon_get_type ())
     35 #define G_LOADABLE_ICON(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_LOADABLE_ICON, GLoadableIcon))
     36 #define G_IS_LOADABLE_ICON(obj)	        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_LOADABLE_ICON))
     37 #define G_LOADABLE_ICON_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_LOADABLE_ICON, GLoadableIconIface))
     38 
     39 /**
     40  * GLoadableIcon:
     41  *
     42  * Generic type for all kinds of icons that can be loaded
     43  * as a stream.
     44  **/
     45 typedef struct _GLoadableIconIface    		GLoadableIconIface;
     46 
     47 /**
     48  * GLoadableIconIface:
     49  * @g_iface: The parent interface.
     50  * @load: Loads an icon.
     51  * @load_async: Loads an icon asynchronously.
     52  * @load_finish: Finishes an asynchronous icon load.
     53  *
     54  * Interface for icons that can be loaded as a stream.
     55  **/
     56 struct _GLoadableIconIface
     57 {
     58   GTypeInterface g_iface;
     59 
     60   /* Virtual Table */
     61 
     62   GInputStream * (* load)        (GLoadableIcon       *icon,
     63                                   int                  size,
     64                                   char               **type,
     65                                   GCancellable        *cancellable,
     66                                   GError             **error);
     67   void           (* load_async)  (GLoadableIcon       *icon,
     68                                   int                  size,
     69                                   GCancellable        *cancellable,
     70                                   GAsyncReadyCallback  callback,
     71                                   gpointer             user_data);
     72   GInputStream * (* load_finish) (GLoadableIcon       *icon,
     73                                   GAsyncResult        *res,
     74                                   char               **type,
     75                                   GError             **error);
     76 };
     77 
     78 GType         g_loadable_icon_get_type    (void) G_GNUC_CONST;
     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__ */
     98