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"
36 * SECTION:gemblemedicon
37 * @short_description: Icon with emblems
39 * @see_also: #GIcon, #GLoadableIcon, #GThemedIcon, #GEmblem
41 * #GEmblemedIcon is an implementation of #GIcon that supports
42 * adding an emblem to an icon. Adding multiple emblems to an
43 * icon is ensured via g_emblemed_icon_add_emblem().
45 * Note that #GEmblemedIcon allows no control over the position
46 * of the emblems. See also #GEmblem for more information.
49 static void g_emblemed_icon_icon_iface_init (GIconIface *iface);
53 GObject parent_instance;
59 struct _GEmblemedIconClass
61 GObjectClass parent_class;
64 G_DEFINE_TYPE_WITH_CODE (GEmblemedIcon, g_emblemed_icon, G_TYPE_OBJECT,
65 G_IMPLEMENT_INTERFACE (G_TYPE_ICON,
66 g_emblemed_icon_icon_iface_init))
70 g_emblemed_icon_finalize (GObject *object)
72 GEmblemedIcon *emblemed;
74 emblemed = G_EMBLEMED_ICON (object);
76 g_object_unref (emblemed->icon);
77 g_list_foreach (emblemed->emblems, (GFunc) g_object_unref, NULL);
78 g_list_free (emblemed->emblems);
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:
98 * @emblem: (allow-none): a #GEmblem, or %NULL
100 * Creates a new emblemed icon for @icon with the emblem @emblem.
102 * Returns: (transfer full): 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);
115 emblemed = G_EMBLEMED_ICON (g_object_new (G_TYPE_EMBLEMED_ICON, NULL));
116 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: (transfer full): 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: (element-type utf8) (transfer none): a #GList of #GEmblem <!-- -->s that
150 * is owned by @emblemed
156 g_emblemed_icon_get_emblems (GEmblemedIcon *emblemed)
158 g_return_val_if_fail (G_IS_EMBLEMED_ICON (emblemed), NULL);
160 return emblemed->emblems;
164 * g_emblemed_icon_clear_emblems:
165 * @emblemed: a #GEmblemedIcon
167 * Removes all the emblems from @icon.
172 g_emblemed_icon_clear_emblems (GEmblemedIcon *emblemed)
174 g_return_if_fail (G_IS_EMBLEMED_ICON (emblemed));
176 if (emblemed->emblems == NULL)
179 g_list_free_full (emblemed->emblems, g_object_unref);
180 emblemed->emblems = NULL;
184 g_emblem_comp (GEmblem *a,
187 guint hash_a = g_icon_hash (G_ICON (a));
188 guint hash_b = g_icon_hash (G_ICON (b));
200 * g_emblemed_icon_add_emblem:
201 * @emblemed: a #GEmblemedIcon
202 * @emblem: a #GEmblem
204 * Adds @emblem to the #GList of #GEmblem <!-- -->s.
209 g_emblemed_icon_add_emblem (GEmblemedIcon *emblemed,
212 g_return_if_fail (G_IS_EMBLEMED_ICON (emblemed));
213 g_return_if_fail (G_IS_EMBLEM (emblem));
215 g_object_ref (emblem);
216 emblemed->emblems = g_list_insert_sorted (emblemed->emblems, emblem,
217 (GCompareFunc) g_emblem_comp);
221 g_emblemed_icon_hash (GIcon *icon)
223 GEmblemedIcon *emblemed = G_EMBLEMED_ICON (icon);
225 guint hash = g_icon_hash (emblemed->icon);
227 for (list = emblemed->emblems; list != NULL; list = list->next)
228 hash ^= g_icon_hash (G_ICON (list->data));
234 g_emblemed_icon_equal (GIcon *icon1,
237 GEmblemedIcon *emblemed1 = G_EMBLEMED_ICON (icon1);
238 GEmblemedIcon *emblemed2 = G_EMBLEMED_ICON (icon2);
239 GList *list1, *list2;
241 if (!g_icon_equal (emblemed1->icon, emblemed2->icon))
244 list1 = emblemed1->emblems;
245 list2 = emblemed2->emblems;
247 while (list1 && list2)
249 if (!g_icon_equal (G_ICON (list1->data), G_ICON (list2->data)))
256 return list1 == NULL && list2 == NULL;
260 g_emblemed_icon_to_tokens (GIcon *icon,
264 GEmblemedIcon *emblemed_icon = G_EMBLEMED_ICON (icon);
268 /* GEmblemedIcons are encoded as
270 * <encoded_icon> [<encoded_emblem_icon>]*
273 g_return_val_if_fail (out_version != NULL, FALSE);
277 s = g_icon_to_string (emblemed_icon->icon);
281 g_ptr_array_add (tokens, s);
283 for (l = emblemed_icon->emblems; l != NULL; l = l->next)
285 GIcon *emblem_icon = G_ICON (l->data);
287 s = g_icon_to_string (emblem_icon);
291 g_ptr_array_add (tokens, s);
298 g_emblemed_icon_from_tokens (gchar **tokens,
303 GEmblemedIcon *emblemed_icon;
306 emblemed_icon = NULL;
312 G_IO_ERROR_INVALID_ARGUMENT,
313 _("Can't handle version %d of GEmblemedIcon encoding"),
322 G_IO_ERROR_INVALID_ARGUMENT,
323 _("Malformed number of tokens (%d) in GEmblemedIcon encoding"),
328 emblemed_icon = g_object_new (G_TYPE_EMBLEMED_ICON, NULL);
329 emblemed_icon->icon = g_icon_new_for_string (tokens[0], error);
330 if (emblemed_icon->icon == NULL)
333 for (n = 1; n < num_tokens; n++)
337 emblem = g_icon_new_for_string (tokens[n], error);
341 if (!G_IS_EMBLEM (emblem))
343 g_set_error_literal (error,
345 G_IO_ERROR_INVALID_ARGUMENT,
346 _("Expected a GEmblem for GEmblemedIcon"));
347 g_object_unref (emblem);
351 emblemed_icon->emblems = g_list_append (emblemed_icon->emblems, emblem);
354 return G_ICON (emblemed_icon);
357 if (emblemed_icon != NULL)
358 g_object_unref (emblemed_icon);
363 g_emblemed_icon_icon_iface_init (GIconIface *iface)
365 iface->hash = g_emblemed_icon_hash;
366 iface->equal = g_emblemed_icon_equal;
367 iface->to_tokens = g_emblemed_icon_to_tokens;
368 iface->from_tokens = g_emblemed_icon_from_tokens;