1/* GIO - GLib Input, Output and Streaming Library
2 *
3 * Copyright (C) 2006-2007 Red Hat, Inc.
4 *
5 * SPDX-License-Identifier: LGPL-2.1-or-later
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General
18 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
19 *
20 * Author: Alexander Larsson <alexl@redhat.com>
21 */
22
23#ifndef __G_LOADABLE_ICON_H__
24#define __G_LOADABLE_ICON_H__
25
26#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
27#error "Only <gio/gio.h> can be included directly."
28#endif
29
30#include <gio/giotypes.h>
31
32G_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
39typedef struct _GLoadableIconIface GLoadableIconIface;
40
41/**
42 * GLoadableIconIface:
43 * @g_iface: The parent interface.
44 * @load: Loads an icon.
45 * @load_async: Loads an icon asynchronously.
46 * @load_finish: Finishes an asynchronous icon load.
47 *
48 * Interface for icons that can be loaded as a stream.
49 **/
50struct _GLoadableIconIface
51{
52 GTypeInterface g_iface;
53
54 /* Virtual Table */
55
56 GInputStream * (* load) (GLoadableIcon *icon,
57 int size,
58 char **type,
59 GCancellable *cancellable,
60 GError **error);
61 void (* load_async) (GLoadableIcon *icon,
62 int size,
63 GCancellable *cancellable,
64 GAsyncReadyCallback callback,
65 gpointer user_data);
66 GInputStream * (* load_finish) (GLoadableIcon *icon,
67 GAsyncResult *res,
68 char **type,
69 GError **error);
70};
71
72GIO_AVAILABLE_IN_ALL
73GType g_loadable_icon_get_type (void) G_GNUC_CONST;
74
75GIO_AVAILABLE_IN_ALL
76GInputStream *g_loadable_icon_load (GLoadableIcon *icon,
77 int size,
78 char **type,
79 GCancellable *cancellable,
80 GError **error);
81GIO_AVAILABLE_IN_ALL
82void g_loadable_icon_load_async (GLoadableIcon *icon,
83 int size,
84 GCancellable *cancellable,
85 GAsyncReadyCallback callback,
86 gpointer user_data);
87GIO_AVAILABLE_IN_ALL
88GInputStream *g_loadable_icon_load_finish (GLoadableIcon *icon,
89 GAsyncResult *res,
90 char **type,
91 GError **error);
92
93G_END_DECLS
94
95#endif /* __G_LOADABLE_ICON_H__ */
96