• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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.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
16  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
17  *
18  * Author: Alexander Larsson <alexl@redhat.com>
19  */
20 
21 #ifndef __G_LOADABLE_ICON_H__
22 #define __G_LOADABLE_ICON_H__
23 
24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
25 #error "Only <gio/gio.h> can be included directly."
26 #endif
27 
28 #include <gio/giotypes.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  * Generic type for all kinds of icons that can be loaded
41  * as a stream.
42  **/
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  * Interface for icons that can be loaded as a stream.
53  **/
54 struct _GLoadableIconIface
55 {
56   GTypeInterface g_iface;
57 
58   /* Virtual Table */
59 
60   GInputStream * (* load)        (GLoadableIcon       *icon,
61                                   int                  size,
62                                   char               **type,
63                                   GCancellable        *cancellable,
64                                   GError             **error);
65   void           (* load_async)  (GLoadableIcon       *icon,
66                                   int                  size,
67                                   GCancellable        *cancellable,
68                                   GAsyncReadyCallback  callback,
69                                   gpointer             user_data);
70   GInputStream * (* load_finish) (GLoadableIcon       *icon,
71                                   GAsyncResult        *res,
72                                   char               **type,
73                                   GError             **error);
74 };
75 
76 GLIB_AVAILABLE_IN_ALL
77 GType         g_loadable_icon_get_type    (void) G_GNUC_CONST;
78 
79 GLIB_AVAILABLE_IN_ALL
80 GInputStream *g_loadable_icon_load        (GLoadableIcon        *icon,
81 					   int                   size,
82 					   char                **type,
83 					   GCancellable         *cancellable,
84 					   GError              **error);
85 GLIB_AVAILABLE_IN_ALL
86 void          g_loadable_icon_load_async  (GLoadableIcon        *icon,
87 					   int                   size,
88 					   GCancellable         *cancellable,
89 					   GAsyncReadyCallback   callback,
90 					   gpointer              user_data);
91 GLIB_AVAILABLE_IN_ALL
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__ */
100