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 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, write to the 17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330, 18 * Boston, MA 02111-1307, USA. 19 * 20 * Author: Alexander Larsson <alexl (at) redhat.com> 21 */ 22 23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION) 24 #error "Only <gio/gio.h> can be included directly." 25 #endif 26 27 #ifndef __G_ICON_H__ 28 #define __G_ICON_H__ 29 30 #include <gio/giotypes.h> 31 32 G_BEGIN_DECLS 33 34 #define G_TYPE_ICON (g_icon_get_type ()) 35 #define G_ICON(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_ICON, GIcon)) 36 #define G_IS_ICON(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_ICON)) 37 #define G_ICON_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_ICON, GIconIface)) 38 39 /** 40 * GIcon: 41 * 42 * An abstract type that specifies an icon. 43 **/ 44 typedef struct _GIconIface GIconIface; 45 46 /** 47 * GIconIface: 48 * @g_iface: The parent interface. 49 * @hash: A hash for a given #GIcon. 50 * @equal: Checks if two #GIcon<!-- -->s are equal. 51 * @to_tokens: Serializes a #GIcon into tokens. The tokens must not 52 * contain any whitespace. Don't implement if the #GIcon can't be 53 * serialized (Since 2.20). 54 * @from_tokens: Constructs a #GIcon from tokens. Set the #GError if 55 * the tokens are malformed. Don't implement if the #GIcon can't be 56 * serialized (Since 2.20). 57 * 58 * GIconIface is used to implement GIcon types for various 59 * different systems. See #GThemedIcon and #GLoadableIcon for 60 * examples of how to implement this interface. 61 */ 62 struct _GIconIface 63 { 64 GTypeInterface g_iface; 65 66 /* Virtual Table */ 67 68 guint (* hash) (GIcon *icon); 69 gboolean (* equal) (GIcon *icon1, 70 GIcon *icon2); 71 gboolean (* to_tokens) (GIcon *icon, 72 GPtrArray *tokens, 73 gint *out_version); 74 GIcon * (* from_tokens) (gchar **tokens, 75 gint num_tokens, 76 gint version, 77 GError **error); 78 }; 79 80 GType g_icon_get_type (void) G_GNUC_CONST; 81 82 guint g_icon_hash (gconstpointer icon); 83 gboolean g_icon_equal (GIcon *icon1, 84 GIcon *icon2); 85 gchar *g_icon_to_string (GIcon *icon); 86 GIcon *g_icon_new_for_string (const gchar *str, 87 GError **error); 88 89 G_END_DECLS 90 91 #endif /* __G_ICON_H__ */ 92
