gio/gicon.c

   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@redhat.com>
  21  */
  22
  23 #include <config.h>
  24 #include "gicon.h"
  25
  26 #include "glibintl.h"
  27
  28 #include "gioalias.h"
  29
  30 /**
  31  * SECTION:gicon
  32  * @short_description: Interface for icons
  33  * @include: gio/gio.h
  34  *
  35  * #GIcon is a very minimal interface for icons. It provides functions
  36  * for checking the equality of two icons and hashing of icons.
  37  *
  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).
  41  *
  42  * To obtain a hash of a #GIcon, see g_icon_hash().
  43  *
  44  * To check if two #GIcons are equal, see g_icon_equal().
  45  **/
  46
  47 static void g_icon_base_init (gpointer g_class);
  48 static void g_icon_class_init (gpointer g_class,
  49                                gpointer class_data);
  50
  51 GType
  52 g_icon_get_type (void)
  53 {
  54   static GType icon_type = 0;
  55
  56   if (! icon_type)
  57     {
  58       static const GTypeInfo icon_info =
  59       {
  60         sizeof (GIconIface), /* class_size */
  61         g_icon_base_init,   /* base_init */
  62         NULL,           /* base_finalize */
  63         g_icon_class_init,
  64         NULL,           /* class_finalize */
  65         NULL,           /* class_data */
  66         0,
  67         0,              /* n_preallocs */
  68         NULL
  69       };
  70
  71       icon_type =
  72         g_type_register_static (G_TYPE_INTERFACE, I_("GIcon"),
  73                                 &icon_info, 0);
  74
  75       g_type_interface_add_prerequisite (icon_type, G_TYPE_OBJECT);
  76     }
  77
  78   return icon_type;
  79 }
  80
  81 static void
  82 g_icon_class_init (gpointer g_class,
  83                    gpointer class_data)
  84 {
  85 }
  86
  87 static void
  88 g_icon_base_init (gpointer g_class)
  89 {
  90 }
  91
  92 /**
  93  * g_icon_hash:
  94  * @icon: #gconstpointer to an icon object.
  95  *
  96  * Gets a hash for an icon.
  97  *
  98  * Returns: a #guint containing a hash for the @icon, suitable for
  99  * use in a #GHashTable or similar data structure.
 100  **/
 101 guint
 102 g_icon_hash (gconstpointer icon)
 103 {
 104   GIconIface *iface;
 105
 106   g_return_val_if_fail (G_IS_ICON (icon), 0);
 107
 108   iface = G_ICON_GET_IFACE (icon);
 109
 110   return (* iface->hash) ((GIcon *)icon);
 111 }
 112
 113 /**
 114  * g_icon_equal:
 115  * @icon1: pointer to the first #GIcon.
 116  * @icon2: pointer to the second #GIcon.
 117  *
 118  * Checks if two icons are equal.
 119  *
 120  * Returns: %TRUE if @icon1 is equal to @icon2. %FALSE otherwise.
 121  **/
 122 gboolean
 123 g_icon_equal (GIcon *icon1,
 124               GIcon *icon2)
 125 {
 126   GIconIface *iface;
 127
 128   if (icon1 == NULL && icon2 == NULL)
 129     return TRUE;
 130
 131   if (icon1 == NULL || icon2 == NULL)
 132     return FALSE;
 133
 134   if (G_TYPE_FROM_INSTANCE (icon1) != G_TYPE_FROM_INSTANCE (icon2))
 135     return FALSE;
 136
 137   iface = G_ICON_GET_IFACE (icon1);
 138
 139   return (* iface->equal) (icon1, icon2);
 140 }
 141
 142 #define __G_ICON_C__
 143 #include "gioaliasdef.c"