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_ICON_H__ 22 #define __G_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_ICON (g_icon_get_type ()) 33 #define G_ICON(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_ICON, GIcon)) 34 #define G_IS_ICON(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_ICON)) 35 #define G_ICON_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_ICON, GIconIface)) 36 37 /** 38 * GIcon: 39 * 40 * An abstract type that specifies an icon. 41 **/ 42 typedef struct _GIconIface GIconIface; 43 44 /** 45 * GIconIface: 46 * @g_iface: The parent interface. 47 * @hash: A hash for a given #GIcon. 48 * @equal: Checks if two #GIcons are equal. 49 * @to_tokens: Serializes a #GIcon into tokens. The tokens must not 50 * contain any whitespace. Don't implement if the #GIcon can't be 51 * serialized (Since 2.20). 52 * @from_tokens: Constructs a #GIcon from tokens. Set the #GError if 53 * the tokens are malformed. Don't implement if the #GIcon can't be 54 * serialized (Since 2.20). 55 * @serialize: Serializes a #GIcon into a #GVariant. Since: 2.38 56 * 57 * GIconIface is used to implement GIcon types for various 58 * different systems. See #GThemedIcon and #GLoadableIcon for 59 * examples of how to implement this interface. 60 */ 61 struct _GIconIface 62 { 63 GTypeInterface g_iface; 64 65 /* Virtual Table */ 66 67 guint (* hash) (GIcon *icon); 68 gboolean (* equal) (GIcon *icon1, 69 GIcon *icon2); 70 gboolean (* to_tokens) (GIcon *icon, 71 GPtrArray *tokens, 72 gint *out_version); 73 GIcon * (* from_tokens) (gchar **tokens, 74 gint num_tokens, 75 gint version, 76 GError **error); 77 78 GVariant * (* serialize) (GIcon *icon); 79 }; 80 81 GLIB_AVAILABLE_IN_ALL 82 GType g_icon_get_type (void) G_GNUC_CONST; 83 84 GLIB_AVAILABLE_IN_ALL 85 guint g_icon_hash (gconstpointer icon); 86 GLIB_AVAILABLE_IN_ALL 87 gboolean g_icon_equal (GIcon *icon1, 88 GIcon *icon2); 89 GLIB_AVAILABLE_IN_ALL 90 gchar *g_icon_to_string (GIcon *icon); 91 GLIB_AVAILABLE_IN_ALL 92 GIcon *g_icon_new_for_string (const gchar *str, 93 GError **error); 94 95 GLIB_AVAILABLE_IN_2_38 96 GVariant * g_icon_serialize (GIcon *icon); 97 GLIB_AVAILABLE_IN_2_38 98 GIcon * g_icon_deserialize (GVariant *value); 99 100 G_END_DECLS 101 102 #endif /* __G_ICON_H__ */ 103