1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
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.
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.
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.
20 * Author: Alexander Larsson <alexl@redhat.com>
24 #include "gasyncresult.h"
25 #include "gsimpleasyncresult.h"
27 #include "gloadableicon.h"
33 * SECTION:gloadableicon
34 * @short_description: Loadable Icons
36 * @see_also: #GIcon, #GThemedIcon
38 * Extends the #GIcon interface and adds the ability to
39 * load icons from streams.
42 static void g_loadable_icon_real_load_async (GLoadableIcon
*icon
,
44 GCancellable
*cancellable
,
45 GAsyncReadyCallback callback
,
47 static GInputStream
*g_loadable_icon_real_load_finish (GLoadableIcon
*icon
,
51 static void g_loadable_icon_base_init (gpointer g_class
);
52 static void g_loadable_icon_class_init (gpointer g_class
,
56 g_loadable_icon_get_type (void)
58 static volatile gsize g_define_type_id__volatile
= 0;
60 if (g_once_init_enter (&g_define_type_id__volatile
))
62 const GTypeInfo loadable_icon_info
=
64 sizeof (GLoadableIconIface
), /* class_size */
65 g_loadable_icon_base_init
, /* base_init */
66 NULL
, /* base_finalize */
67 g_loadable_icon_class_init
,
68 NULL
, /* class_finalize */
69 NULL
, /* class_data */
74 GType g_define_type_id
=
75 g_type_register_static (G_TYPE_INTERFACE
, I_("GLoadableIcon"),
76 &loadable_icon_info
, 0);
78 g_type_interface_add_prerequisite (g_define_type_id
, G_TYPE_ICON
);
80 g_once_init_leave (&g_define_type_id__volatile
, g_define_type_id
);
83 return g_define_type_id__volatile
;
87 g_loadable_icon_class_init (gpointer g_class
,
90 GLoadableIconIface
*iface
= g_class
;
92 iface
->load_async
= g_loadable_icon_real_load_async
;
93 iface
->load_finish
= g_loadable_icon_real_load_finish
;
97 g_loadable_icon_base_init (gpointer g_class
)
102 * g_loadable_icon_load:
103 * @icon: a #GLoadableIcon.
105 * @type: a location to store the type of the loaded icon, %NULL to ignore.
106 * @cancellable: optional #GCancellable object, %NULL to ignore.
107 * @error: a #GError location to store the error occuring, or %NULL to
110 * Loads a loadable icon. For the asynchronous version of this function,
111 * see g_loadable_icon_load_async().
113 * Returns: a #GInputStream to read the icon from.
116 g_loadable_icon_load (GLoadableIcon
*icon
,
119 GCancellable
*cancellable
,
122 GLoadableIconIface
*iface
;
124 g_return_val_if_fail (G_IS_LOADABLE_ICON (icon
), NULL
);
126 iface
= G_LOADABLE_ICON_GET_IFACE (icon
);
128 return (* iface
->load
) (icon
, size
, type
, cancellable
, error
);
132 * g_loadable_icon_load_async:
133 * @icon: a #GLoadableIcon.
135 * @cancellable: optional #GCancellable object, %NULL to ignore.
136 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
137 * @user_data: the data to pass to callback function
139 * Loads an icon asynchronously. To finish this function, see
140 * g_loadable_icon_load_finish(). For the synchronous, blocking
141 * version of this function, see g_loadable_icon_load().
144 g_loadable_icon_load_async (GLoadableIcon
*icon
,
146 GCancellable
*cancellable
,
147 GAsyncReadyCallback callback
,
150 GLoadableIconIface
*iface
;
152 g_return_if_fail (G_IS_LOADABLE_ICON (icon
));
154 iface
= G_LOADABLE_ICON_GET_IFACE (icon
);
156 (* iface
->load_async
) (icon
, size
, cancellable
, callback
, user_data
);
160 * g_loadable_icon_load_finish:
161 * @icon: a #GLoadableIcon.
162 * @res: a #GAsyncResult.
163 * @type: a location to store the type of the loaded icon, %NULL to ignore.
164 * @error: a #GError location to store the error occuring, or %NULL to
167 * Finishes an asynchronous icon load started in g_loadable_icon_load_async().
169 * Returns: a #GInputStream to read the icon from.
172 g_loadable_icon_load_finish (GLoadableIcon
*icon
,
177 GLoadableIconIface
*iface
;
179 g_return_val_if_fail (G_IS_LOADABLE_ICON (icon
), NULL
);
180 g_return_val_if_fail (G_IS_ASYNC_RESULT (res
), NULL
);
182 if (G_IS_SIMPLE_ASYNC_RESULT (res
))
184 GSimpleAsyncResult
*simple
= G_SIMPLE_ASYNC_RESULT (res
);
185 if (g_simple_async_result_propagate_error (simple
, error
))
189 iface
= G_LOADABLE_ICON_GET_IFACE (icon
);
191 return (* iface
->load_finish
) (icon
, res
, type
, error
);
194 /********************************************
195 * Default implementation of async load *
196 ********************************************/
201 GInputStream
*stream
;
205 load_data_free (LoadData
*data
)
208 g_object_unref (data
->stream
);
214 load_async_thread (GSimpleAsyncResult
*res
,
216 GCancellable
*cancellable
)
218 GLoadableIconIface
*iface
;
219 GInputStream
*stream
;
221 GError
*error
= NULL
;
224 data
= g_simple_async_result_get_op_res_gpointer (res
);
226 iface
= G_LOADABLE_ICON_GET_IFACE (object
);
227 stream
= iface
->load (G_LOADABLE_ICON (object
), data
->size
, &type
, cancellable
, &error
);
231 g_simple_async_result_set_from_error (res
, error
);
232 g_error_free (error
);
236 data
->stream
= stream
;
244 g_loadable_icon_real_load_async (GLoadableIcon
*icon
,
246 GCancellable
*cancellable
,
247 GAsyncReadyCallback callback
,
250 GSimpleAsyncResult
*res
;
253 res
= g_simple_async_result_new (G_OBJECT (icon
), callback
, user_data
, g_loadable_icon_real_load_async
);
254 data
= g_new0 (LoadData
, 1);
255 g_simple_async_result_set_op_res_gpointer (res
, data
, (GDestroyNotify
) load_data_free
);
256 g_simple_async_result_run_in_thread (res
, load_async_thread
, 0, cancellable
);
257 g_object_unref (res
);
260 static GInputStream
*
261 g_loadable_icon_real_load_finish (GLoadableIcon
*icon
,
266 GSimpleAsyncResult
*simple
= G_SIMPLE_ASYNC_RESULT (res
);
269 g_warn_if_fail (g_simple_async_result_get_source_tag (simple
) == g_loadable_icon_real_load_async
);
271 data
= g_simple_async_result_get_op_res_gpointer (simple
);
279 return g_object_ref (data
->stream
);
282 #define __G_LOADABLE_ICON_C__
283 #include "gioaliasdef.c"