glib-2.0/gio/gloadableicon.h

0001 /* GIO - GLib Input, Output and Streaming Library
0002  *
0003  * Copyright (C) 2006-2007 Red Hat, Inc.
0004  *
0005  * SPDX-License-Identifier: LGPL-2.1-or-later
0006  *
0007  * This library is free software; you can redistribute it and/or
0008  * modify it under the terms of the GNU Lesser General Public
0009  * License as published by the Free Software Foundation; either
0010  * version 2.1 of the License, or (at your option) any later version.
0011  *
0012  * This library is distributed in the hope that it will be useful,
0013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0015  * Lesser General Public License for more details.
0016  *
0017  * You should have received a copy of the GNU Lesser General
0018  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
0019  *
0020  * Author: Alexander Larsson <alexl@redhat.com>
0021  */
0022
0023 #ifndef __G_LOADABLE_ICON_H__
0024 #define __G_LOADABLE_ICON_H__
0025
0026 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
0027 #error "Only <gio/gio.h> can be included directly."
0028 #endif
0029
0030 #include <gio/giotypes.h>
0031
0032 G_BEGIN_DECLS
0033
0034 #define G_TYPE_LOADABLE_ICON            (g_loadable_icon_get_type ())
0035 #define G_LOADABLE_ICON(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_LOADABLE_ICON, GLoadableIcon))
0036 #define G_IS_LOADABLE_ICON(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_LOADABLE_ICON))
0037 #define G_LOADABLE_ICON_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_LOADABLE_ICON, GLoadableIconIface))
0038
0039 typedef struct _GLoadableIconIface          GLoadableIconIface;
0040
0041 /**
0042  * GLoadableIconIface:
0043  * @g_iface: The parent interface.
0044  * @load: Loads an icon.
0045  * @load_async: Loads an icon asynchronously.
0046  * @load_finish: Finishes an asynchronous icon load.
0047  *
0048  * Interface for icons that can be loaded as a stream.
0049  **/
0050 struct _GLoadableIconIface
0051 {
0052   GTypeInterface g_iface;
0053
0054   /* Virtual Table */
0055
0056   GInputStream * (* load)        (GLoadableIcon       *icon,
0057                                   int                  size,
0058                                   char               **type,
0059                                   GCancellable        *cancellable,
0060                                   GError             **error);
0061   void           (* load_async)  (GLoadableIcon       *icon,
0062                                   int                  size,
0063                                   GCancellable        *cancellable,
0064                                   GAsyncReadyCallback  callback,
0065                                   gpointer             user_data);
0066   GInputStream * (* load_finish) (GLoadableIcon       *icon,
0067                                   GAsyncResult        *res,
0068                                   char               **type,
0069                                   GError             **error);
0070 };
0071
0072 GIO_AVAILABLE_IN_ALL
0073 GType         g_loadable_icon_get_type    (void) G_GNUC_CONST;
0074
0075 GIO_AVAILABLE_IN_ALL
0076 GInputStream *g_loadable_icon_load        (GLoadableIcon        *icon,
0077                        int                   size,
0078                        char                **type,
0079                        GCancellable         *cancellable,
0080                        GError              **error);
0081 GIO_AVAILABLE_IN_ALL
0082 void          g_loadable_icon_load_async  (GLoadableIcon        *icon,
0083                        int                   size,
0084                        GCancellable         *cancellable,
0085                        GAsyncReadyCallback   callback,
0086                        gpointer              user_data);
0087 GIO_AVAILABLE_IN_ALL
0088 GInputStream *g_loadable_icon_load_finish (GLoadableIcon        *icon,
0089                        GAsyncResult         *res,
0090                        char                **type,
0091                        GError              **error);
0092
0093 G_END_DECLS
0094
0095 #endif /* __G_LOADABLE_ICON_H__ */