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>
32 * @short_description: Interface for icons
35 * #GIcon is a very minimal interface for icons. It provides functions
36 * for checking the equality of two icons and hashing of icons.
38 * #GIcon does not provide the actual pixmap for the icon as this is out
39 * of GIO's scope, however implementations of #GIcon may contain the name
40 * of an icon (see #GThemedIcon), or the path to an icon (see #GLoadableIcon).
42 * To obtain a hash of a #GIcon, see g_icon_hash().
44 * To check if two #GIcons are equal, see g_icon_equal().
47 static void g_icon_base_init (gpointer g_class
);
48 static void g_icon_class_init (gpointer g_class
,
52 g_icon_get_type (void)
54 static volatile gsize g_define_type_id__volatile
= 0;
56 if (g_once_init_enter (&g_define_type_id__volatile
))
58 const GTypeInfo icon_info
=
60 sizeof (GIconIface
), /* class_size */
61 g_icon_base_init
, /* base_init */
62 NULL
, /* base_finalize */
64 NULL
, /* class_finalize */
65 NULL
, /* class_data */
70 GType g_define_type_id
=
71 g_type_register_static (G_TYPE_INTERFACE
, I_("GIcon"),
74 g_type_interface_add_prerequisite (g_define_type_id
, G_TYPE_OBJECT
);
76 g_once_init_leave (&g_define_type_id__volatile
, g_define_type_id
);
79 return g_define_type_id__volatile
;
83 g_icon_class_init (gpointer g_class
,
89 g_icon_base_init (gpointer g_class
)
95 * @icon: #gconstpointer to an icon object.
97 * Gets a hash for an icon.
99 * Returns: a #guint containing a hash for the @icon, suitable for
100 * use in a #GHashTable or similar data structure.
103 g_icon_hash (gconstpointer icon
)
107 g_return_val_if_fail (G_IS_ICON (icon
), 0);
109 iface
= G_ICON_GET_IFACE (icon
);
111 return (* iface
->hash
) ((GIcon
*)icon
);
116 * @icon1: pointer to the first #GIcon.
117 * @icon2: pointer to the second #GIcon.
119 * Checks if two icons are equal.
121 * Returns: %TRUE if @icon1 is equal to @icon2. %FALSE otherwise.
124 g_icon_equal (GIcon
*icon1
,
129 if (icon1
== NULL
&& icon2
== NULL
)
132 if (icon1
== NULL
|| icon2
== NULL
)
135 if (G_TYPE_FROM_INSTANCE (icon1
) != G_TYPE_FROM_INSTANCE (icon2
))
138 iface
= G_ICON_GET_IFACE (icon1
);
140 return (* iface
->equal
) (icon1
, icon2
);
144 #include "gioaliasdef.c"