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 GType loadable_icon_type = 0;
60 if (! loadable_icon_type)
62 static 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 */
76 g_type_register_static (G_TYPE_INTERFACE, I_("GLoadableIcon"),
77 &loadable_icon_info, 0);
79 g_type_interface_add_prerequisite (loadable_icon_type, G_TYPE_ICON);
82 return loadable_icon_type;
86 g_loadable_icon_class_init (gpointer g_class,
89 GLoadableIconIface *iface = g_class;
91 iface->load_async = g_loadable_icon_real_load_async;
92 iface->load_finish = g_loadable_icon_real_load_finish;
96 g_loadable_icon_base_init (gpointer g_class)
101 * g_loadable_icon_load:
102 * @icon: a #GLoadableIcon.
104 * @type: a location to store the type of the loaded icon, %NULL to ignore.
105 * @cancellable: optional #GCancellable object, %NULL to ignore.
106 * @error: a #GError location to store the error occuring, or %NULL to
109 * Loads a loadable icon. For the asynchronous version of this function,
110 * see g_loadable_icon_load_async().
112 * Returns: a #GInputStream to read the icon from.
115 g_loadable_icon_load (GLoadableIcon *icon,
118 GCancellable *cancellable,
121 GLoadableIconIface *iface;
123 g_return_val_if_fail (G_IS_LOADABLE_ICON (icon), NULL);
125 iface = G_LOADABLE_ICON_GET_IFACE (icon);
127 return (* iface->load) (icon, size, type, cancellable, error);
131 * g_loadable_icon_load_async:
132 * @icon: a #GLoadableIcon.
134 * @cancellable: optional #GCancellable object, %NULL to ignore.
135 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
136 * @user_data: the data to pass to callback function
138 * Loads an icon asynchronously. To finish this function, see
139 * g_loadable_icon_load_finish(). For the synchronous, blocking
140 * version of this function, see g_loadable_icon_load().
143 g_loadable_icon_load_async (GLoadableIcon *icon,
145 GCancellable *cancellable,
146 GAsyncReadyCallback callback,
149 GLoadableIconIface *iface;
151 g_return_if_fail (G_IS_LOADABLE_ICON (icon));
153 iface = G_LOADABLE_ICON_GET_IFACE (icon);
155 (* iface->load_async) (icon, size, cancellable, callback, user_data);
159 * g_loadable_icon_load_finish:
160 * @icon: a #GLoadableIcon.
161 * @res: a #GAsyncResult.
162 * @type: a location to store the type of the loaded icon, %NULL to ignore.
163 * @error: a #GError location to store the error occuring, or %NULL to
166 * Finishes an asynchronous icon load started in g_loadable_icon_load_async().
168 * Returns: a #GInputStream to read the icon from.
171 g_loadable_icon_load_finish (GLoadableIcon *icon,
176 GLoadableIconIface *iface;
178 g_return_val_if_fail (G_IS_LOADABLE_ICON (icon), NULL);
179 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
181 if (G_IS_SIMPLE_ASYNC_RESULT (res))
183 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
184 if (g_simple_async_result_propagate_error (simple, error))
188 iface = G_LOADABLE_ICON_GET_IFACE (icon);
190 return (* iface->load_finish) (icon, res, type, error);
193 /********************************************
194 * Default implementation of async load *
195 ********************************************/
200 GInputStream *stream;
204 load_data_free (LoadData *data)
207 g_object_unref (data->stream);
213 load_async_thread (GSimpleAsyncResult *res,
215 GCancellable *cancellable)
217 GLoadableIconIface *iface;
218 GInputStream *stream;
220 GError *error = NULL;
223 data = g_simple_async_result_get_op_res_gpointer (res);
225 iface = G_LOADABLE_ICON_GET_IFACE (object);
226 stream = iface->load (G_LOADABLE_ICON (object), data->size, &type, cancellable, &error);
230 g_simple_async_result_set_from_error (res, error);
231 g_error_free (error);
235 data->stream = stream;
243 g_loadable_icon_real_load_async (GLoadableIcon *icon,
245 GCancellable *cancellable,
246 GAsyncReadyCallback callback,
249 GSimpleAsyncResult *res;
252 res = g_simple_async_result_new (G_OBJECT (icon), callback, user_data, g_loadable_icon_real_load_async);
253 data = g_new0 (LoadData, 1);
254 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify) load_data_free);
255 g_simple_async_result_run_in_thread (res, load_async_thread, 0, cancellable);
256 g_object_unref (res);
259 static GInputStream *
260 g_loadable_icon_real_load_finish (GLoadableIcon *icon,
265 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
268 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_loadable_icon_real_load_async);
270 data = g_simple_async_result_get_op_res_gpointer (simple);
278 return g_object_ref (data->stream);
281 #define __G_LOADABLE_ICON_C__
282 #include "gioaliasdef.c"