1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
3 /* GIO - GLib Input, Output and Streaming Library
5 * Copyright (C) 2006-2007 Red Hat, Inc.
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General
18 * Public License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20 * Boston, MA 02111-1307, USA.
22 * Author: Matthias Clasen <mclasen@redhat.com>
23 * Clemens N. Buss <cebuzz@gmail.com>
30 #include "gemblemedicon.h"
37 * SECTION:gemblemedicon
38 * @short_description: Icon with emblems
40 * @see_also: #GIcon, #GLoadableIcon, #GThemedIcon, #GEmblem
42 * #GEmblemedIcon is an implementation of #GIcon that supports
43 * adding an emblem to an icon. Adding multiple emblems to an
44 * icon is ensured via g_emblemed_icon_add_emblem().
46 * Note that #GEmblemedIcon allows no control over the position
47 * of the emblems. See also #GEmblem for more information.
50 static void g_emblemed_icon_icon_iface_init (GIconIface *iface);
54 GObject parent_instance;
60 struct _GEmblemedIconClass
62 GObjectClass parent_class;
65 G_DEFINE_TYPE_WITH_CODE (GEmblemedIcon, g_emblemed_icon, G_TYPE_OBJECT,
66 G_IMPLEMENT_INTERFACE (G_TYPE_ICON,
67 g_emblemed_icon_icon_iface_init))
71 g_emblemed_icon_finalize (GObject *object)
73 GEmblemedIcon *emblemed;
75 emblemed = G_EMBLEMED_ICON (object);
77 g_object_unref (emblemed->icon);
78 g_list_foreach (emblemed->emblems, (GFunc) g_object_unref, NULL);
80 (*G_OBJECT_CLASS (g_emblemed_icon_parent_class)->finalize) (object);
84 g_emblemed_icon_class_init (GEmblemedIconClass *klass)
86 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
87 gobject_class->finalize = g_emblemed_icon_finalize;
91 g_emblemed_icon_init (GEmblemedIcon *emblemed)
96 * g_emblemed_icon_new:
100 * Creates a new emblemed icon for @icon with the emblem @emblem.
102 * Returns: a new #GIcon
107 g_emblemed_icon_new (GIcon *icon,
110 GEmblemedIcon *emblemed;
112 g_return_val_if_fail (G_IS_ICON (icon), NULL);
113 g_return_val_if_fail (!G_IS_EMBLEM (icon), NULL);
114 g_return_val_if_fail (G_IS_EMBLEM (emblem), NULL);
116 emblemed = G_EMBLEMED_ICON (g_object_new (G_TYPE_EMBLEMED_ICON, NULL));
117 emblemed->icon = g_object_ref (icon);
119 g_emblemed_icon_add_emblem (emblemed, emblem);
121 return G_ICON (emblemed);
126 * g_emblemed_icon_get_icon:
127 * @emblemed: a #GEmblemedIcon
129 * Gets the main icon for @emblemed.
131 * Returns: a #GIcon that is owned by @emblemed
136 g_emblemed_icon_get_icon (GEmblemedIcon *emblemed)
138 g_return_val_if_fail (G_IS_EMBLEMED_ICON (emblemed), NULL);
140 return emblemed->icon;
144 * g_emblemed_icon_get_emblems:
145 * @emblemed: a #GEmblemedIcon
147 * Gets the list of emblems for the @icon.
149 * Returns: a #GList of #GEmblem <!-- -->s that is owned by @emblemed
155 g_emblemed_icon_get_emblems (GEmblemedIcon *emblemed)
157 g_return_val_if_fail (G_IS_EMBLEMED_ICON (emblemed), NULL);
159 return emblemed->emblems;
164 * g_emblemed_icon_add_emblem:
165 * @emblemed: a #GEmblemedIcon
166 * @emblem: a #GEmblem
168 * Adds @emblem to the #GList of #GEmblem <!-- -->s.
173 g_emblemed_icon_add_emblem (GEmblemedIcon *emblemed,
176 g_return_if_fail (G_IS_EMBLEMED_ICON (emblemed));
177 g_return_if_fail (G_IS_EMBLEM (emblem));
179 g_object_ref (emblem);
180 emblemed->emblems = g_list_append (emblemed->emblems, emblem);
184 g_emblemed_icon_hash (GIcon *icon)
186 GEmblemedIcon *emblemed = G_EMBLEMED_ICON (icon);
188 guint hash = g_icon_hash (emblemed->icon);
190 for (list = emblemed->emblems; list != NULL; list = list->next)
191 hash ^= g_icon_hash (G_ICON (list->data));
197 g_emblem_comp (GEmblem *a,
200 guint hash_a = g_icon_hash (G_ICON (a));
201 guint hash_b = g_icon_hash (G_ICON (b));
213 g_emblemed_icon_equal (GIcon *icon1,
216 GEmblemedIcon *emblemed1 = G_EMBLEMED_ICON (icon1);
217 GEmblemedIcon *emblemed2 = G_EMBLEMED_ICON (icon2);
218 GList *list1, *list2;
220 if (!g_icon_equal (emblemed1->icon, emblemed2->icon))
223 list1 = emblemed1->emblems;
224 list2 = emblemed2->emblems;
226 list1 = g_list_sort (list1, (GCompareFunc) g_emblem_comp);
227 list2 = g_list_sort (list2, (GCompareFunc) g_emblem_comp);
229 while (list1 && list2)
231 if (!g_icon_equal (G_ICON (list1->data), G_ICON (list2->data)))
238 return list1 == NULL && list2 == NULL;
242 g_emblemed_icon_to_tokens (GIcon *icon,
246 GEmblemedIcon *emblemed_icon = G_EMBLEMED_ICON (icon);
250 /* GEmblemedIcons are encoded as
252 * <encoded_icon> [<encoded_emblem_icon>]*
255 g_return_val_if_fail (out_version != NULL, FALSE);
259 s = g_icon_to_string (emblemed_icon->icon);
263 g_ptr_array_add (tokens, s);
265 for (l = emblemed_icon->emblems; l != NULL; l = l->next)
267 GIcon *emblem_icon = G_ICON (l->data);
269 s = g_icon_to_string (emblem_icon);
273 g_ptr_array_add (tokens, s);
280 g_emblemed_icon_from_tokens (gchar **tokens,
285 GEmblemedIcon *emblemed_icon;
288 emblemed_icon = NULL;
294 G_IO_ERROR_INVALID_ARGUMENT,
295 _("Can't handle version %d of GEmblemedIcon encoding"),
304 G_IO_ERROR_INVALID_ARGUMENT,
305 _("Malformed number of tokens (%d) in GEmblemedIcon encoding"),
310 emblemed_icon = g_object_new (G_TYPE_EMBLEMED_ICON, NULL);
311 emblemed_icon->icon = g_icon_new_for_string (tokens[0], error);
312 if (emblemed_icon->icon == NULL)
315 for (n = 1; n < num_tokens; n++)
319 emblem = g_icon_new_for_string (tokens[n], error);
323 if (!G_IS_EMBLEM (emblem))
325 g_set_error_literal (error,
327 G_IO_ERROR_INVALID_ARGUMENT,
328 _("Expected a GEmblem for GEmblemedIcon"));
329 g_object_unref (emblem);
333 emblemed_icon->emblems = g_list_append (emblemed_icon->emblems, emblem);
336 return G_ICON (emblemed_icon);
339 if (emblemed_icon != NULL)
340 g_object_unref (emblemed_icon);
345 g_emblemed_icon_icon_iface_init (GIconIface *iface)
347 iface->hash = g_emblemed_icon_hash;
348 iface->equal = g_emblemed_icon_equal;
349 iface->to_tokens = g_emblemed_icon_to_tokens;
350 iface->from_tokens = g_emblemed_icon_from_tokens;
353 #define __G_EMBLEMED_ICON_C__
354 #include "gioaliasdef.c"