1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 2000 Red Hat, Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
32 #include <pango/pango-utils.h> /* For pango_scan_* */
33 #include "gtkiconfactory.h"
34 #include "stock-icons/gtkstockpixbufs.h"
36 #include "gtkicontheme.h"
37 #include "gtksettings.h"
39 #include "gtkwidget.h"
43 static GSList *all_icon_factories = NULL;
46 GTK_ICON_SOURCE_EMPTY,
47 GTK_ICON_SOURCE_ICON_NAME,
48 GTK_ICON_SOURCE_FILENAME,
49 GTK_ICON_SOURCE_PIXBUF
54 GtkIconSourceType type;
62 GdkPixbuf *filename_pixbuf;
64 GtkTextDirection direction;
68 /* If TRUE, then the parameter is wildcarded, and the above
69 * fields should be ignored. If FALSE, the parameter is
70 * specified, and the above fields should be valid.
72 guint any_direction : 1;
77 /* System codepage version of filename, for DLL ABI backward
78 * compatibility functions.
84 static gpointer parent_class = NULL;
86 static void gtk_icon_factory_init (GtkIconFactory *icon_factory);
87 static void gtk_icon_factory_class_init (GtkIconFactoryClass *klass);
88 static void gtk_icon_factory_finalize (GObject *object);
89 static void get_default_icons (GtkIconFactory *icon_factory);
90 static void icon_source_clear (GtkIconSource *source);
92 static GtkIconSize icon_size_register_intern (const gchar *name,
96 #define GTK_ICON_SOURCE_INIT(any_direction, any_state, any_size) \
97 { GTK_ICON_SOURCE_EMPTY, { NULL }, NULL, \
99 any_direction, any_state, any_size }
102 gtk_icon_factory_get_type (void)
104 static GType icon_factory_type = 0;
106 if (!icon_factory_type)
108 static const GTypeInfo icon_factory_info =
110 sizeof (GtkIconFactoryClass),
111 NULL, /* base_init */
112 NULL, /* base_finalize */
113 (GClassInitFunc) gtk_icon_factory_class_init,
114 NULL, /* class_finalize */
115 NULL, /* class_data */
116 sizeof (GtkIconFactory),
118 (GInstanceInitFunc) gtk_icon_factory_init,
122 g_type_register_static (G_TYPE_OBJECT, "GtkIconFactory",
123 &icon_factory_info, 0);
126 return icon_factory_type;
130 gtk_icon_factory_init (GtkIconFactory *factory)
132 factory->icons = g_hash_table_new (g_str_hash, g_str_equal);
133 all_icon_factories = g_slist_prepend (all_icon_factories, factory);
137 gtk_icon_factory_class_init (GtkIconFactoryClass *klass)
139 GObjectClass *object_class = G_OBJECT_CLASS (klass);
141 parent_class = g_type_class_peek_parent (klass);
143 object_class->finalize = gtk_icon_factory_finalize;
147 free_icon_set (gpointer key, gpointer value, gpointer data)
150 gtk_icon_set_unref (value);
154 gtk_icon_factory_finalize (GObject *object)
156 GtkIconFactory *factory = GTK_ICON_FACTORY (object);
158 all_icon_factories = g_slist_remove (all_icon_factories, factory);
160 g_hash_table_foreach (factory->icons, free_icon_set, NULL);
162 g_hash_table_destroy (factory->icons);
164 G_OBJECT_CLASS (parent_class)->finalize (object);
168 * gtk_icon_factory_new:
170 * Creates a new #GtkIconFactory. An icon factory manages a collection
171 * of #GtkIconSet<!-- -->s; a #GtkIconSet manages a set of variants of a
172 * particular icon (i.e. a #GtkIconSet contains variants for different
173 * sizes and widget states). Icons in an icon factory are named by a
174 * stock ID, which is a simple string identifying the icon. Each
175 * #GtkStyle has a list of #GtkIconFactory<!-- -->s derived from the current
176 * theme; those icon factories are consulted first when searching for
177 * an icon. If the theme doesn't set a particular icon, GTK+ looks for
178 * the icon in a list of default icon factories, maintained by
179 * gtk_icon_factory_add_default() and
180 * gtk_icon_factory_remove_default(). Applications with icons should
181 * add a default icon factory with their icons, which will allow
182 * themes to override the icons for the application.
184 * Return value: a new #GtkIconFactory
187 gtk_icon_factory_new (void)
189 return g_object_new (GTK_TYPE_ICON_FACTORY, NULL);
193 * gtk_icon_factory_add:
194 * @factory: a #GtkIconFactory
195 * @stock_id: icon name
196 * @icon_set: icon set
198 * Adds the given @icon_set to the icon factory, under the name
199 * @stock_id. @stock_id should be namespaced for your application,
200 * e.g. "myapp-whatever-icon". Normally applications create a
201 * #GtkIconFactory, then add it to the list of default factories with
202 * gtk_icon_factory_add_default(). Then they pass the @stock_id to
203 * widgets such as #GtkImage to display the icon. Themes can provide
204 * an icon with the same name (such as "myapp-whatever-icon") to
205 * override your application's default icons. If an icon already
206 * existed in @factory for @stock_id, it is unreferenced and replaced
207 * with the new @icon_set.
211 gtk_icon_factory_add (GtkIconFactory *factory,
212 const gchar *stock_id,
213 GtkIconSet *icon_set)
215 gpointer old_key = NULL;
216 gpointer old_value = NULL;
218 g_return_if_fail (GTK_IS_ICON_FACTORY (factory));
219 g_return_if_fail (stock_id != NULL);
220 g_return_if_fail (icon_set != NULL);
222 g_hash_table_lookup_extended (factory->icons, stock_id,
223 &old_key, &old_value);
225 if (old_value == icon_set)
228 gtk_icon_set_ref (icon_set);
230 /* GHashTable key memory management is so fantastically broken. */
232 g_hash_table_insert (factory->icons, old_key, icon_set);
234 g_hash_table_insert (factory->icons, g_strdup (stock_id), icon_set);
237 gtk_icon_set_unref (old_value);
241 * gtk_icon_factory_lookup:
242 * @factory: a #GtkIconFactory
243 * @stock_id: an icon name
245 * Looks up @stock_id in the icon factory, returning an icon set
246 * if found, otherwise %NULL. For display to the user, you should
247 * use gtk_style_lookup_icon_set() on the #GtkStyle for the
248 * widget that will display the icon, instead of using this
249 * function directly, so that themes are taken into account.
251 * Return value: icon set of @stock_id.
254 gtk_icon_factory_lookup (GtkIconFactory *factory,
255 const gchar *stock_id)
257 g_return_val_if_fail (GTK_IS_ICON_FACTORY (factory), NULL);
258 g_return_val_if_fail (stock_id != NULL, NULL);
260 return g_hash_table_lookup (factory->icons, stock_id);
263 static GtkIconFactory *gtk_default_icons = NULL;
264 static GSList *default_factories = NULL;
267 * gtk_icon_factory_add_default:
268 * @factory: a #GtkIconFactory
270 * Adds an icon factory to the list of icon factories searched by
271 * gtk_style_lookup_icon_set(). This means that, for example,
272 * gtk_image_new_from_stock() will be able to find icons in @factory.
273 * There will normally be an icon factory added for each library or
274 * application that comes with icons. The default icon factories
275 * can be overridden by themes.
279 gtk_icon_factory_add_default (GtkIconFactory *factory)
281 g_return_if_fail (GTK_IS_ICON_FACTORY (factory));
283 g_object_ref (factory);
285 default_factories = g_slist_prepend (default_factories, factory);
289 * gtk_icon_factory_remove_default:
290 * @factory: a #GtkIconFactory previously added with gtk_icon_factory_add_default()
292 * Removes an icon factory from the list of default icon
293 * factories. Not normally used; you might use it for a library that
294 * can be unloaded or shut down.
298 gtk_icon_factory_remove_default (GtkIconFactory *factory)
300 g_return_if_fail (GTK_IS_ICON_FACTORY (factory));
302 default_factories = g_slist_remove (default_factories, factory);
304 g_object_unref (factory);
308 ensure_default_icons (void)
310 if (gtk_default_icons == NULL)
312 gtk_default_icons = gtk_icon_factory_new ();
314 get_default_icons (gtk_default_icons);
319 * gtk_icon_factory_lookup_default:
320 * @stock_id: an icon name
322 * Looks for an icon in the list of default icon factories. For
323 * display to the user, you should use gtk_style_lookup_icon_set() on
324 * the #GtkStyle for the widget that will display the icon, instead of
325 * using this function directly, so that themes are taken into
329 * Return value: a #GtkIconSet, or %NULL
332 gtk_icon_factory_lookup_default (const gchar *stock_id)
336 g_return_val_if_fail (stock_id != NULL, NULL);
338 tmp_list = default_factories;
339 while (tmp_list != NULL)
341 GtkIconSet *icon_set =
342 gtk_icon_factory_lookup (GTK_ICON_FACTORY (tmp_list->data),
348 tmp_list = g_slist_next (tmp_list);
351 ensure_default_icons ();
353 return gtk_icon_factory_lookup (gtk_default_icons, stock_id);
357 register_stock_icon (GtkIconFactory *factory,
358 const gchar *stock_id)
360 GtkIconSet *set = gtk_icon_set_new ();
361 GtkIconSource source = GTK_ICON_SOURCE_INIT (TRUE, TRUE, TRUE);
363 source.type = GTK_ICON_SOURCE_ICON_NAME;
364 source.source.icon_name = (gchar *)stock_id;
365 gtk_icon_set_add_source (set, &source);
367 gtk_icon_factory_add (factory, stock_id, set);
368 gtk_icon_set_unref (set);
372 register_bidi_stock_icon (GtkIconFactory *factory,
373 const gchar *stock_id,
374 const gchar *stock_id_ltr,
375 const gchar *stock_id_rtl)
377 GtkIconSet *set = gtk_icon_set_new ();
378 GtkIconSource source = GTK_ICON_SOURCE_INIT (FALSE, TRUE, TRUE);
380 source.type = GTK_ICON_SOURCE_ICON_NAME;
381 source.source.icon_name = (gchar *)stock_id_ltr;
382 source.direction = GTK_TEXT_DIR_LTR;
383 gtk_icon_set_add_source (set, &source);
385 source.type = GTK_ICON_SOURCE_ICON_NAME;
386 source.source.icon_name = (gchar *)stock_id_rtl;
387 source.direction = GTK_TEXT_DIR_RTL;
388 gtk_icon_set_add_source (set, &source);
390 gtk_icon_factory_add (factory, stock_id, set);
391 gtk_icon_set_unref (set);
395 add_default_image (const gchar *stock_id,
397 const guchar *inline_data)
399 GdkPixbuf *pixbuf = gdk_pixbuf_new_from_inline (-1, inline_data, FALSE, NULL);
402 gtk_icon_theme_add_builtin_icon (stock_id, size, pixbuf);
404 g_object_unref (pixbuf);
408 add_icon (GtkIconFactory *factory,
409 const gchar *stock_id,
411 const guchar *inline_data)
413 register_stock_icon (factory, stock_id);
415 add_default_image (stock_id, size, inline_data);
419 add_icon2 (GtkIconFactory *factory,
420 const gchar *stock_id,
422 const guchar *inline_data1,
424 const guchar *inline_data2)
426 register_stock_icon (factory, stock_id);
428 add_default_image (stock_id, size1, inline_data1);
429 add_default_image (stock_id, size2, inline_data2);
433 add_icon_bidi2 (GtkIconFactory *factory,
434 const gchar *stock_id,
436 const guchar *inline_data_ltr1,
437 const guchar *inline_data_rtl1,
439 const guchar *inline_data_ltr2,
440 const guchar *inline_data_rtl2)
442 gchar *stock_id_ltr = g_strconcat (stock_id, "-ltr", NULL);
443 gchar *stock_id_rtl = g_strconcat (stock_id, "-rtl", NULL);
445 register_bidi_stock_icon (factory, stock_id,
446 stock_id_ltr, stock_id_rtl);
448 add_default_image (stock_id_ltr, size1, inline_data_ltr1);
449 add_default_image (stock_id_ltr, size2, inline_data_ltr2);
451 add_default_image (stock_id_rtl, size1, inline_data_rtl1);
452 add_default_image (stock_id_rtl, size2, inline_data_rtl2);
454 g_free (stock_id_ltr);
455 g_free (stock_id_rtl);
459 get_default_icons (GtkIconFactory *factory)
461 /* KEEP IN SYNC with gtkstock.c */
463 /* Have dialog size */
464 add_icon (factory, GTK_STOCK_DIALOG_AUTHENTICATION, 48, stock_dialog_authentication_48);
465 add_icon (factory, GTK_STOCK_DIALOG_ERROR, 48, stock_dialog_error_48);
466 add_icon (factory, GTK_STOCK_DIALOG_INFO, 48, stock_dialog_info_48);
467 add_icon (factory, GTK_STOCK_DIALOG_QUESTION, 48, stock_dialog_question_48);
468 add_icon (factory, GTK_STOCK_DIALOG_WARNING, 48, stock_dialog_warning_48);
471 add_icon (factory, GTK_STOCK_DND, 32, stock_dnd_32);
472 add_icon (factory, GTK_STOCK_DND_MULTIPLE, 32, stock_dnd_multiple_32);
474 /* Have button sizes */
475 add_icon (factory, GTK_STOCK_APPLY, 20, stock_apply_20);
476 add_icon (factory, GTK_STOCK_CANCEL, 20, stock_cancel_20);
477 add_icon (factory, GTK_STOCK_NO, 20, stock_no_20);
478 add_icon (factory, GTK_STOCK_OK, 20, stock_ok_20);
479 add_icon (factory, GTK_STOCK_YES, 20, stock_yes_20);
481 /* Generic + button sizes */
482 add_icon2 (factory, GTK_STOCK_CLOSE,
486 /* Generic + menu sizes */
487 add_icon2 (factory, GTK_STOCK_ADD,
491 add_icon2 (factory, GTK_STOCK_JUSTIFY_CENTER,
492 16, stock_align_center_16,
493 24, stock_align_center_24);
495 add_icon2 (factory, GTK_STOCK_JUSTIFY_FILL,
496 16, stock_align_justify_16,
497 24, stock_align_justify_24);
499 add_icon2 (factory, GTK_STOCK_JUSTIFY_LEFT,
500 16, stock_align_left_16,
501 24, stock_align_left_24);
503 add_icon2 (factory, GTK_STOCK_JUSTIFY_RIGHT,
504 16, stock_align_right_16,
505 24, stock_align_right_24);
507 add_icon2 (factory, GTK_STOCK_GOTO_BOTTOM,
509 24, stock_bottom_24);
511 add_icon2 (factory, GTK_STOCK_CDROM,
515 add_icon2 (factory, GTK_STOCK_CONVERT,
516 16, stock_convert_16,
517 24, stock_convert_24);
519 add_icon2 (factory, GTK_STOCK_COPY,
523 add_icon2 (factory, GTK_STOCK_CUT,
527 add_icon2 (factory, GTK_STOCK_GO_DOWN,
528 16, stock_down_arrow_16,
529 24, stock_down_arrow_24);
531 add_icon2 (factory, GTK_STOCK_EXECUTE,
535 add_icon2 (factory, GTK_STOCK_QUIT,
539 add_icon_bidi2 (factory, GTK_STOCK_GOTO_FIRST,
540 16, stock_first_16, stock_last_16,
541 24, stock_first_24, stock_last_24);
543 add_icon2 (factory, GTK_STOCK_SELECT_FONT,
547 add_icon2 (factory, GTK_STOCK_HARDDISK,
548 16, stock_harddisk_16,
549 24, stock_harddisk_24);
551 add_icon2 (factory, GTK_STOCK_HELP,
555 add_icon2 (factory, GTK_STOCK_HOME,
559 add_icon_bidi2 (factory, GTK_STOCK_JUMP_TO,
560 16, stock_jump_to_16, stock_jump_to_rtl_16,
561 24, stock_jump_to_24, stock_jump_to_rtl_24);
563 add_icon_bidi2 (factory, GTK_STOCK_GOTO_LAST,
564 16, stock_last_16, stock_first_16,
565 24, stock_last_24, stock_first_24);
567 add_icon_bidi2 (factory, GTK_STOCK_GO_BACK,
568 16, stock_left_arrow_16, stock_right_arrow_16,
569 24, stock_left_arrow_24, stock_right_arrow_24);
571 add_icon2 (factory, GTK_STOCK_MISSING_IMAGE,
572 16, stock_missing_image_16,
573 24, stock_missing_image_24);
575 add_icon2 (factory, GTK_STOCK_NETWORK,
576 16, stock_network_16,
577 24, stock_network_24);
579 add_icon2 (factory, GTK_STOCK_NEW,
583 add_icon2 (factory, GTK_STOCK_OPEN,
587 add_icon2 (factory, GTK_STOCK_PASTE,
591 add_icon2 (factory, GTK_STOCK_PREFERENCES,
592 16, stock_preferences_16,
593 24, stock_preferences_24);
595 add_icon2 (factory, GTK_STOCK_PRINT,
599 add_icon2 (factory, GTK_STOCK_PRINT_PREVIEW,
600 16, stock_print_preview_16,
601 24, stock_print_preview_24);
603 add_icon2 (factory, GTK_STOCK_PROPERTIES,
604 16, stock_properties_16,
605 24, stock_properties_24);
607 add_icon_bidi2 (factory, GTK_STOCK_REDO,
608 16, stock_redo_16, stock_redo_rtl_16,
609 24, stock_redo_24, stock_redo_rtl_24);
611 add_icon2 (factory, GTK_STOCK_REMOVE,
613 24, stock_remove_24);
615 add_icon2 (factory, GTK_STOCK_REFRESH,
616 16, stock_refresh_16,
617 24, stock_refresh_24);
619 add_icon_bidi2 (factory, GTK_STOCK_REVERT_TO_SAVED,
620 16, stock_revert_16, stock_revert_rtl_16,
621 24, stock_revert_24, stock_revert_rtl_24);
623 add_icon_bidi2 (factory, GTK_STOCK_GO_FORWARD,
624 16, stock_right_arrow_16, stock_left_arrow_16,
625 24, stock_right_arrow_24, stock_left_arrow_24);
627 add_icon2 (factory, GTK_STOCK_SAVE,
631 add_icon2 (factory, GTK_STOCK_FLOPPY,
635 add_icon2 (factory, GTK_STOCK_SAVE_AS,
636 16, stock_save_as_16,
637 24, stock_save_as_24);
639 add_icon2 (factory, GTK_STOCK_FIND,
641 24, stock_search_24);
643 add_icon2 (factory, GTK_STOCK_FIND_AND_REPLACE,
644 16, stock_search_replace_16,
645 24, stock_search_replace_24);
647 add_icon2 (factory, GTK_STOCK_SORT_DESCENDING,
648 16, stock_sort_descending_16,
649 24, stock_sort_descending_24);
651 add_icon2 (factory, GTK_STOCK_SORT_ASCENDING,
652 16, stock_sort_ascending_16,
653 24, stock_sort_ascending_24);
655 add_icon2 (factory, GTK_STOCK_SPELL_CHECK,
656 16, stock_spellcheck_16,
657 24, stock_spellcheck_24);
659 add_icon2 (factory, GTK_STOCK_STOP,
663 add_icon2 (factory, GTK_STOCK_BOLD,
664 16, stock_text_bold_16,
665 24, stock_text_bold_24);
667 add_icon2 (factory, GTK_STOCK_ITALIC,
668 16, stock_text_italic_16,
669 24, stock_text_italic_24);
671 add_icon2 (factory, GTK_STOCK_STRIKETHROUGH,
672 16, stock_text_strikethrough_16,
673 24, stock_text_strikethrough_24);
675 add_icon2 (factory, GTK_STOCK_UNDERLINE,
676 16, stock_text_underline_16,
677 24, stock_text_underline_24);
679 add_icon2 (factory, GTK_STOCK_INDENT,
680 16, stock_text_indent_16,
681 24, stock_text_indent_24);
683 add_icon2 (factory, GTK_STOCK_UNINDENT,
684 16, stock_text_unindent_16,
685 24, stock_text_unindent_24);
687 add_icon2 (factory, GTK_STOCK_GOTO_TOP,
691 add_icon2 (factory, GTK_STOCK_DELETE,
695 add_icon_bidi2 (factory, GTK_STOCK_UNDELETE,
696 16, stock_undelete_16, stock_undelete_rtl_16,
697 24, stock_undelete_24, stock_undelete_rtl_24);
699 add_icon_bidi2 (factory, GTK_STOCK_UNDO,
700 16, stock_undo_16, stock_undo_rtl_16,
701 24, stock_undo_24, stock_undo_rtl_24);
703 add_icon2 (factory, GTK_STOCK_GO_UP,
704 16, stock_up_arrow_16,
705 24, stock_up_arrow_24);
707 add_icon2 (factory, GTK_STOCK_FILE,
711 add_icon2 (factory, GTK_STOCK_DIRECTORY,
712 16, stock_directory_16,
713 24, stock_directory_24);
715 add_icon2 (factory, GTK_STOCK_ABOUT,
719 add_icon2 (factory, GTK_STOCK_CONNECT,
720 16, stock_connect_16,
721 24, stock_connect_24);
723 add_icon2 (factory, GTK_STOCK_DISCONNECT,
724 16, stock_disconnect_16,
725 24, stock_disconnect_24);
727 add_icon2 (factory, GTK_STOCK_EDIT,
731 add_icon_bidi2 (factory, GTK_STOCK_MEDIA_FORWARD,
732 16, stock_media_forward_16, stock_media_rewind_16,
733 24, stock_media_forward_24, stock_media_rewind_24);
735 add_icon_bidi2 (factory, GTK_STOCK_MEDIA_NEXT,
736 16, stock_media_next_16, stock_media_previous_16,
737 24, stock_media_next_24, stock_media_previous_24);
739 add_icon2 (factory, GTK_STOCK_MEDIA_PAUSE,
740 16, stock_media_pause_16,
741 24, stock_media_pause_24);
743 add_icon_bidi2 (factory, GTK_STOCK_MEDIA_PLAY,
744 16, stock_media_play_16, stock_media_play_rtl_16,
745 24, stock_media_play_24, stock_media_play_rtl_24);
747 add_icon_bidi2 (factory, GTK_STOCK_MEDIA_PREVIOUS,
748 16, stock_media_previous_16, stock_media_next_16,
749 24, stock_media_previous_24, stock_media_next_24);
751 add_icon2 (factory, GTK_STOCK_MEDIA_RECORD,
752 16, stock_media_record_16,
753 24, stock_media_record_24);
755 add_icon_bidi2 (factory, GTK_STOCK_MEDIA_REWIND,
756 16, stock_media_rewind_16, stock_media_forward_16,
757 24, stock_media_rewind_24, stock_media_forward_24);
759 add_icon2 (factory, GTK_STOCK_MEDIA_STOP,
760 16, stock_media_stop_16,
761 24, stock_media_stop_24);
763 /* Generic size only */
765 add_icon (factory, GTK_STOCK_CLEAR, 24, stock_clear_24);
766 add_icon (factory, GTK_STOCK_SELECT_COLOR, 24, stock_colorselector_24);
767 add_icon (factory, GTK_STOCK_COLOR_PICKER, 25, stock_color_picker_25);
768 add_icon (factory, GTK_STOCK_INDEX, 24, stock_index_24);
769 add_icon (factory, GTK_STOCK_ZOOM_100, 24, stock_zoom_1_24);
770 add_icon (factory, GTK_STOCK_ZOOM_FIT, 24, stock_zoom_fit_24);
771 add_icon (factory, GTK_STOCK_ZOOM_IN, 24, stock_zoom_in_24);
772 add_icon (factory, GTK_STOCK_ZOOM_OUT, 24, stock_zoom_out_24);
775 /************************************************************
776 * Icon size handling *
777 ************************************************************/
779 typedef struct _IconSize IconSize;
790 typedef struct _IconAlias IconAlias;
798 typedef struct _SettingsIconSize SettingsIconSize;
800 struct _SettingsIconSize
806 static GHashTable *icon_aliases = NULL;
807 static IconSize *icon_sizes = NULL;
808 static gint icon_sizes_allocated = 0;
809 static gint icon_sizes_used = 0;
812 init_icon_sizes (void)
814 if (icon_sizes == NULL)
816 #define NUM_BUILTIN_SIZES 7
819 icon_aliases = g_hash_table_new (g_str_hash, g_str_equal);
821 icon_sizes = g_new (IconSize, NUM_BUILTIN_SIZES);
822 icon_sizes_allocated = NUM_BUILTIN_SIZES;
823 icon_sizes_used = NUM_BUILTIN_SIZES;
825 icon_sizes[GTK_ICON_SIZE_INVALID].size = 0;
826 icon_sizes[GTK_ICON_SIZE_INVALID].name = NULL;
827 icon_sizes[GTK_ICON_SIZE_INVALID].width = 0;
828 icon_sizes[GTK_ICON_SIZE_INVALID].height = 0;
830 /* the name strings aren't copied since we don't ever remove
831 * icon sizes, so we don't need to know whether they're static.
832 * Even if we did I suppose removing the builtin sizes would be
836 icon_sizes[GTK_ICON_SIZE_MENU].size = GTK_ICON_SIZE_MENU;
837 icon_sizes[GTK_ICON_SIZE_MENU].name = "gtk-menu";
838 icon_sizes[GTK_ICON_SIZE_MENU].width = 16;
839 icon_sizes[GTK_ICON_SIZE_MENU].height = 16;
841 icon_sizes[GTK_ICON_SIZE_BUTTON].size = GTK_ICON_SIZE_BUTTON;
842 icon_sizes[GTK_ICON_SIZE_BUTTON].name = "gtk-button";
843 icon_sizes[GTK_ICON_SIZE_BUTTON].width = 20;
844 icon_sizes[GTK_ICON_SIZE_BUTTON].height = 20;
846 icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].size = GTK_ICON_SIZE_SMALL_TOOLBAR;
847 icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].name = "gtk-small-toolbar";
848 icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].width = 18;
849 icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].height = 18;
851 icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].size = GTK_ICON_SIZE_LARGE_TOOLBAR;
852 icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].name = "gtk-large-toolbar";
853 icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].width = 24;
854 icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].height = 24;
856 icon_sizes[GTK_ICON_SIZE_DND].size = GTK_ICON_SIZE_DND;
857 icon_sizes[GTK_ICON_SIZE_DND].name = "gtk-dnd";
858 icon_sizes[GTK_ICON_SIZE_DND].width = 32;
859 icon_sizes[GTK_ICON_SIZE_DND].height = 32;
861 icon_sizes[GTK_ICON_SIZE_DIALOG].size = GTK_ICON_SIZE_DIALOG;
862 icon_sizes[GTK_ICON_SIZE_DIALOG].name = "gtk-dialog";
863 icon_sizes[GTK_ICON_SIZE_DIALOG].width = 48;
864 icon_sizes[GTK_ICON_SIZE_DIALOG].height = 48;
866 g_assert ((GTK_ICON_SIZE_DIALOG + 1) == NUM_BUILTIN_SIZES);
868 /* Alias everything to itself. */
869 i = 1; /* skip invalid size */
870 while (i < NUM_BUILTIN_SIZES)
872 gtk_icon_size_register_alias (icon_sizes[i].name, icon_sizes[i].size);
877 #undef NUM_BUILTIN_SIZES
882 free_settings_sizes (gpointer data)
884 g_array_free (data, TRUE);
888 get_settings_sizes (GtkSettings *settings,
891 GArray *settings_sizes;
892 static GQuark sizes_quark = 0;
895 sizes_quark = g_quark_from_static_string ("gtk-icon-sizes");
897 settings_sizes = g_object_get_qdata (G_OBJECT (settings), sizes_quark);
900 settings_sizes = g_array_new (FALSE, FALSE, sizeof (SettingsIconSize));
901 g_object_set_qdata_full (G_OBJECT (settings), sizes_quark,
902 settings_sizes, free_settings_sizes);
907 return settings_sizes;
911 icon_size_set_for_settings (GtkSettings *settings,
912 const gchar *size_name,
917 GArray *settings_sizes;
918 SettingsIconSize *settings_size;
920 g_return_if_fail (size_name != NULL);
922 size = gtk_icon_size_from_name (size_name);
923 if (size == GTK_ICON_SIZE_INVALID)
924 /* Reserve a place */
925 size = icon_size_register_intern (size_name, -1, -1);
927 settings_sizes = get_settings_sizes (settings, NULL);
928 if (size >= settings_sizes->len)
930 SettingsIconSize unset = { -1, -1 };
933 for (i = settings_sizes->len; i <= size; i++)
934 g_array_append_val (settings_sizes, unset);
937 settings_size = &g_array_index (settings_sizes, SettingsIconSize, size);
939 settings_size->width = width;
940 settings_size->height = height;
943 /* Like pango_parse_word, but accept - as well
946 scan_icon_size_name (const char **pos, GString *out)
948 const char *p = *pos;
950 while (g_ascii_isspace (*p))
953 if (!((*p >= 'A' && *p <= 'Z') ||
954 (*p >= 'a' && *p <= 'z') ||
955 *p == '_' || *p == '-'))
958 g_string_truncate (out, 0);
959 g_string_append_c (out, *p);
962 while ((*p >= 'A' && *p <= 'Z') ||
963 (*p >= 'a' && *p <= 'z') ||
964 (*p >= '0' && *p <= '9') ||
965 *p == '_' || *p == '-')
967 g_string_append_c (out, *p);
977 icon_size_setting_parse (GtkSettings *settings,
978 const gchar *icon_size_string)
980 GString *name_buf = g_string_new (NULL);
981 const gchar *p = icon_size_string;
983 while (pango_skip_space (&p))
987 if (!scan_icon_size_name (&p, name_buf))
990 if (!pango_skip_space (&p))
998 if (!pango_scan_int (&p, &width))
1001 if (!pango_skip_space (&p))
1009 if (!pango_scan_int (&p, &height))
1012 if (width > 0 && height > 0)
1014 icon_size_set_for_settings (settings, name_buf->str,
1019 g_warning ("Invalid size in gtk-icon-sizes: %d,%d\n", width, height);
1022 pango_skip_space (&p);
1031 g_string_free (name_buf, TRUE);
1035 g_warning ("Error parsing gtk-icon-sizes string:\n\t'%s'", icon_size_string);
1036 g_string_free (name_buf, TRUE);
1040 icon_size_set_all_from_settings (GtkSettings *settings)
1042 GArray *settings_sizes;
1043 gchar *icon_size_string;
1045 /* Reset old settings */
1046 settings_sizes = get_settings_sizes (settings, NULL);
1047 g_array_set_size (settings_sizes, 0);
1049 g_object_get (settings,
1050 "gtk-icon-sizes", &icon_size_string,
1053 if (icon_size_string)
1055 icon_size_setting_parse (settings, icon_size_string);
1056 g_free (icon_size_string);
1061 icon_size_settings_changed (GtkSettings *settings,
1064 icon_size_set_all_from_settings (settings);
1066 gtk_rc_reset_styles (settings);
1070 icon_sizes_init_for_settings (GtkSettings *settings)
1072 g_signal_connect (settings,
1073 "notify::gtk-icon-sizes",
1074 G_CALLBACK (icon_size_settings_changed),
1077 icon_size_set_all_from_settings (settings);
1081 icon_size_lookup_intern (GtkSettings *settings,
1086 GArray *settings_sizes;
1087 gint width_for_settings = -1;
1088 gint height_for_settings = -1;
1092 if (size >= icon_sizes_used)
1095 if (size == GTK_ICON_SIZE_INVALID)
1100 gboolean initial = FALSE;
1102 settings_sizes = get_settings_sizes (settings, &initial);
1104 icon_sizes_init_for_settings (settings);
1106 if (size < settings_sizes->len)
1108 SettingsIconSize *settings_size;
1110 settings_size = &g_array_index (settings_sizes, SettingsIconSize, size);
1112 width_for_settings = settings_size->width;
1113 height_for_settings = settings_size->height;
1118 *widthp = width_for_settings >= 0 ? width_for_settings : icon_sizes[size].width;
1121 *heightp = height_for_settings >= 0 ? height_for_settings : icon_sizes[size].height;
1127 * gtk_icon_size_lookup_for_settings:
1128 * @settings: a #GtkSettings object, used to determine
1129 * which set of user preferences to used.
1130 * @size: an icon size
1131 * @width: location to store icon width
1132 * @height: location to store icon height
1134 * Obtains the pixel size of a semantic icon size, possibly
1135 * modified by user preferences for a particular
1136 * #GtkSettings. Normally @size would be
1137 * #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc. This function
1138 * isn't normally needed, gtk_widget_render_icon() is the usual
1139 * way to get an icon for rendering, then just look at the size of
1140 * the rendered pixbuf. The rendered pixbuf may not even correspond to
1141 * the width/height returned by gtk_icon_size_lookup(), because themes
1142 * are free to render the pixbuf however they like, including changing
1145 * Return value: %TRUE if @size was a valid size
1150 gtk_icon_size_lookup_for_settings (GtkSettings *settings,
1155 g_return_val_if_fail (GTK_IS_SETTINGS (settings), FALSE);
1157 return icon_size_lookup_intern (settings, size, width, height);
1161 * gtk_icon_size_lookup:
1162 * @size: an icon size
1163 * @width: location to store icon width
1164 * @height: location to store icon height
1166 * Obtains the pixel size of a semantic icon size, possibly
1167 * modified by user preferences for the default #GtkSettings.
1168 * (See gtk_icon_size_lookup_for_settings().)
1169 * Normally @size would be
1170 * #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc. This function
1171 * isn't normally needed, gtk_widget_render_icon() is the usual
1172 * way to get an icon for rendering, then just look at the size of
1173 * the rendered pixbuf. The rendered pixbuf may not even correspond to
1174 * the width/height returned by gtk_icon_size_lookup(), because themes
1175 * are free to render the pixbuf however they like, including changing
1178 * Return value: %TRUE if @size was a valid size
1181 gtk_icon_size_lookup (GtkIconSize size,
1185 GTK_NOTE (MULTIHEAD,
1186 g_warning ("gtk_icon_size_lookup ()) is not multihead safe"));
1188 return gtk_icon_size_lookup_for_settings (gtk_settings_get_default (),
1189 size, widthp, heightp);
1193 icon_size_register_intern (const gchar *name,
1197 IconAlias *old_alias;
1202 old_alias = g_hash_table_lookup (icon_aliases, name);
1203 if (old_alias && icon_sizes[old_alias->target].width > 0)
1205 g_warning ("Icon size name '%s' already exists", name);
1206 return GTK_ICON_SIZE_INVALID;
1211 size = old_alias->target;
1215 if (icon_sizes_used == icon_sizes_allocated)
1217 icon_sizes_allocated *= 2;
1218 icon_sizes = g_renew (IconSize, icon_sizes, icon_sizes_allocated);
1221 size = icon_sizes_used++;
1223 /* alias to self. */
1224 gtk_icon_size_register_alias (name, size);
1226 icon_sizes[size].size = size;
1227 icon_sizes[size].name = g_strdup (name);
1230 icon_sizes[size].width = width;
1231 icon_sizes[size].height = height;
1237 * gtk_icon_size_register:
1238 * @name: name of the icon size
1239 * @width: the icon width
1240 * @height: the icon height
1242 * Registers a new icon size, along the same lines as #GTK_ICON_SIZE_MENU,
1243 * etc. Returns the integer value for the size.
1245 * Returns: integer value representing the size
1249 gtk_icon_size_register (const gchar *name,
1253 g_return_val_if_fail (name != NULL, 0);
1254 g_return_val_if_fail (width > 0, 0);
1255 g_return_val_if_fail (height > 0, 0);
1257 return icon_size_register_intern (name, width, height);
1261 * gtk_icon_size_register_alias:
1262 * @alias: an alias for @target
1263 * @target: an existing icon size
1265 * Registers @alias as another name for @target.
1266 * So calling gtk_icon_size_from_name() with @alias as argument
1267 * will return @target.
1271 gtk_icon_size_register_alias (const gchar *alias,
1276 g_return_if_fail (alias != NULL);
1280 if (!icon_size_lookup_intern (NULL, target, NULL, NULL))
1281 g_warning ("gtk_icon_size_register_alias: Icon size %d does not exist", target);
1283 ia = g_hash_table_lookup (icon_aliases, alias);
1286 if (icon_sizes[ia->target].width > 0)
1288 g_warning ("gtk_icon_size_register_alias: Icon size name '%s' already exists", alias);
1292 ia->target = target;
1297 ia = g_new (IconAlias, 1);
1298 ia->name = g_strdup (alias);
1299 ia->target = target;
1301 g_hash_table_insert (icon_aliases, ia->name, ia);
1306 * gtk_icon_size_from_name:
1307 * @name: the name to look up.
1308 * @returns: the icon size with the given name.
1310 * Looks up the icon size associated with @name.
1313 gtk_icon_size_from_name (const gchar *name)
1319 ia = g_hash_table_lookup (icon_aliases, name);
1321 if (ia && icon_sizes[ia->target].width > 0)
1324 return GTK_ICON_SIZE_INVALID;
1328 * gtk_icon_size_get_name:
1329 * @size: a #GtkIconSize.
1330 * @returns: the name of the given icon size.
1332 * Gets the canonical name of the given icon size. The returned string
1333 * is statically allocated and should not be freed.
1335 G_CONST_RETURN gchar*
1336 gtk_icon_size_get_name (GtkIconSize size)
1338 if (size >= icon_sizes_used)
1341 return icon_sizes[size].name;
1344 /************************************************************/
1349 static GdkPixbuf *find_in_cache (GtkIconSet *icon_set,
1351 GtkTextDirection direction,
1354 static void add_to_cache (GtkIconSet *icon_set,
1356 GtkTextDirection direction,
1360 /* Clear icon set contents, drop references to all contained
1361 * GdkPixbuf objects and forget all GtkIconSources. Used to
1362 * recycle an icon set.
1364 static void clear_cache (GtkIconSet *icon_set,
1365 gboolean style_detach);
1366 static GSList* copy_cache (GtkIconSet *icon_set,
1367 GtkIconSet *copy_recipient);
1368 static void attach_to_style (GtkIconSet *icon_set,
1370 static void detach_from_style (GtkIconSet *icon_set,
1372 static void style_dnotify (gpointer data);
1380 /* Cache of the last few rendered versions of the icon. */
1388 static guint cache_serial = 0;
1393 * Creates a new #GtkIconSet. A #GtkIconSet represents a single icon
1394 * in various sizes and widget states. It can provide a #GdkPixbuf
1395 * for a given size and state on request, and automatically caches
1396 * some of the rendered #GdkPixbuf objects.
1398 * Normally you would use gtk_widget_render_icon() instead of
1399 * using #GtkIconSet directly. The one case where you'd use
1400 * #GtkIconSet is to create application-specific icon sets to place in
1401 * a #GtkIconFactory.
1403 * Return value: a new #GtkIconSet
1406 gtk_icon_set_new (void)
1408 GtkIconSet *icon_set;
1410 icon_set = g_new (GtkIconSet, 1);
1412 icon_set->ref_count = 1;
1413 icon_set->sources = NULL;
1414 icon_set->cache = NULL;
1415 icon_set->cache_size = 0;
1416 icon_set->cache_serial = cache_serial;
1422 * gtk_icon_set_new_from_pixbuf:
1423 * @pixbuf: a #GdkPixbuf
1425 * Creates a new #GtkIconSet with @pixbuf as the default/fallback
1426 * source image. If you don't add any additional #GtkIconSource to the
1427 * icon set, all variants of the icon will be created from @pixbuf,
1428 * using scaling, pixelation, etc. as required to adjust the icon size
1429 * or make the icon look insensitive/prelighted.
1431 * Return value: a new #GtkIconSet
1434 gtk_icon_set_new_from_pixbuf (GdkPixbuf *pixbuf)
1438 GtkIconSource source = GTK_ICON_SOURCE_INIT (TRUE, TRUE, TRUE);
1440 g_return_val_if_fail (pixbuf != NULL, NULL);
1442 set = gtk_icon_set_new ();
1444 gtk_icon_source_set_pixbuf (&source, pixbuf);
1445 gtk_icon_set_add_source (set, &source);
1446 gtk_icon_source_set_pixbuf (&source, NULL);
1454 * @icon_set: a #GtkIconSet.
1456 * Increments the reference count on @icon_set.
1458 * Return value: @icon_set.
1461 gtk_icon_set_ref (GtkIconSet *icon_set)
1463 g_return_val_if_fail (icon_set != NULL, NULL);
1464 g_return_val_if_fail (icon_set->ref_count > 0, NULL);
1466 icon_set->ref_count += 1;
1472 * gtk_icon_set_unref:
1473 * @icon_set: a #GtkIconSet
1475 * Decrements the reference count on @icon_set, and frees memory
1476 * if the reference count reaches 0.
1479 gtk_icon_set_unref (GtkIconSet *icon_set)
1481 g_return_if_fail (icon_set != NULL);
1482 g_return_if_fail (icon_set->ref_count > 0);
1484 icon_set->ref_count -= 1;
1486 if (icon_set->ref_count == 0)
1488 GSList *tmp_list = icon_set->sources;
1489 while (tmp_list != NULL)
1491 gtk_icon_source_free (tmp_list->data);
1493 tmp_list = g_slist_next (tmp_list);
1495 g_slist_free (icon_set->sources);
1497 clear_cache (icon_set, TRUE);
1504 gtk_icon_set_get_type (void)
1506 static GType our_type = 0;
1509 our_type = g_boxed_type_register_static ("GtkIconSet",
1510 (GBoxedCopyFunc) gtk_icon_set_ref,
1511 (GBoxedFreeFunc) gtk_icon_set_unref);
1517 * gtk_icon_set_copy:
1518 * @icon_set: a #GtkIconSet
1520 * Copies @icon_set by value.
1522 * Return value: a new #GtkIconSet identical to the first.
1525 gtk_icon_set_copy (GtkIconSet *icon_set)
1530 copy = gtk_icon_set_new ();
1532 tmp_list = icon_set->sources;
1533 while (tmp_list != NULL)
1535 copy->sources = g_slist_prepend (copy->sources,
1536 gtk_icon_source_copy (tmp_list->data));
1538 tmp_list = g_slist_next (tmp_list);
1541 copy->sources = g_slist_reverse (copy->sources);
1543 copy->cache = copy_cache (icon_set, copy);
1544 copy->cache_size = icon_set->cache_size;
1545 copy->cache_serial = icon_set->cache_serial;
1551 sizes_equivalent (GtkIconSize lhs,
1554 /* We used to consider sizes equivalent if they were
1555 * the same pixel size, but we don't have the GtkSettings
1556 * here, so we can't do that. Plus, it's not clear that
1557 * it is right... it was just a workaround for the fact
1558 * that we register icons by logical size, not pixel size.
1564 gint r_w, r_h, l_w, l_h;
1566 icon_size_lookup_intern (NULL, rhs, &r_w, &r_h);
1567 icon_size_lookup_intern (NULL, lhs, &l_w, &l_h);
1569 return r_w == l_w && r_h == l_h;
1573 static GtkIconSource *
1574 find_best_matching_source (GtkIconSet *icon_set,
1575 GtkTextDirection direction,
1580 GtkIconSource *source;
1583 /* We need to find the best icon source. Direction matters more
1584 * than state, state matters more than size. icon_set->sources
1585 * is sorted according to wildness, so if we take the first
1586 * match we find it will be the least-wild match (if there are
1587 * multiple matches for a given "wildness" then the RC file contained
1588 * dumb stuff, and we end up with an arbitrary matching source)
1592 tmp_list = icon_set->sources;
1593 while (tmp_list != NULL)
1595 GtkIconSource *s = tmp_list->data;
1597 if ((s->any_direction || (s->direction == direction)) &&
1598 (s->any_state || (s->state == state)) &&
1599 (s->any_size || (sizes_equivalent (size, s->size))))
1601 if (!g_slist_find (failed, s))
1608 tmp_list = g_slist_next (tmp_list);
1615 ensure_filename_pixbuf (GtkIconSet *icon_set,
1616 GtkIconSource *source)
1618 if (source->filename_pixbuf == NULL)
1620 GError *error = NULL;
1622 source->filename_pixbuf = gdk_pixbuf_new_from_file (source->source.filename, &error);
1624 if (source->filename_pixbuf == NULL)
1626 /* Remove this icon source so we don't keep trying to
1629 g_warning (_("Error loading icon: %s"), error->message);
1630 g_error_free (error);
1632 icon_set->sources = g_slist_remove (icon_set->sources, source);
1634 gtk_icon_source_free (source);
1644 render_icon_name_pixbuf (GtkIconSource *icon_source,
1646 GtkTextDirection direction,
1653 GdkPixbuf *tmp_pixbuf;
1654 GtkIconSource tmp_source;
1656 GtkIconTheme *icon_theme;
1657 GtkSettings *settings;
1658 gint width, height, pixel_size;
1659 gint *sizes, *s, dist;
1660 GError *error = NULL;
1662 if (widget && gtk_widget_has_screen (widget))
1663 screen = gtk_widget_get_screen (widget);
1664 else if (style && style->colormap)
1665 screen = gdk_colormap_get_screen (style->colormap);
1668 screen = gdk_screen_get_default ();
1669 GTK_NOTE (MULTIHEAD,
1670 g_warning ("Using the default screen for gtk_icon_source_render_icon()"));
1673 icon_theme = gtk_icon_theme_get_for_screen (screen);
1674 settings = gtk_settings_get_for_screen (screen);
1676 if (!gtk_icon_size_lookup_for_settings (settings, size, &width, &height))
1680 /* Find an available size close to 48
1682 sizes = gtk_icon_theme_get_icon_sizes (icon_theme, icon_source->source.icon_name);
1684 width = height = 48;
1685 for (s = sizes; *s; s++)
1689 width = height = 48;
1696 width = height = *s;
1704 width = height = *s;
1714 g_warning ("Invalid icon size %d\n", size);
1715 width = height = 24;
1719 pixel_size = MIN (width, height);
1721 tmp_pixbuf = gtk_icon_theme_load_icon (icon_theme,
1722 icon_source->source.icon_name,
1728 g_warning ("Error loading theme icon for stock: %s", error->message);
1729 g_error_free (error);
1733 tmp_source = *icon_source;
1734 tmp_source.type = GTK_ICON_SOURCE_PIXBUF;
1735 tmp_source.source.pixbuf = tmp_pixbuf;
1737 pixbuf = gtk_style_render_icon (style, &tmp_source,
1738 direction, state, -1,
1742 g_warning ("Failed to render icon");
1744 g_object_unref (tmp_pixbuf);
1750 find_and_render_icon_source (GtkIconSet *icon_set,
1752 GtkTextDirection direction,
1758 GSList *failed = NULL;
1759 GdkPixbuf *pixbuf = NULL;
1761 /* We treat failure in two different ways:
1763 * A) If loading a source that specifies a filename fails,
1764 * we treat that as permanent, and remove the source
1765 * from the GtkIconSet. (in ensure_filename_pixbuf ()
1766 * B) If loading a themed icon fails, or scaling an icon
1767 * fails, we treat that as transient and will try
1768 * again next time the icon falls out of the cache
1769 * and we need to recreate it.
1771 while (pixbuf == NULL)
1773 GtkIconSource *source = find_best_matching_source (icon_set, direction, state, size, failed);
1778 switch (source->type)
1780 case GTK_ICON_SOURCE_FILENAME:
1781 if (!ensure_filename_pixbuf (icon_set, source))
1784 case GTK_ICON_SOURCE_PIXBUF:
1785 pixbuf = gtk_style_render_icon (style, source,
1786 direction, state, size,
1790 g_warning ("Failed to render icon");
1791 failed = g_slist_prepend (failed, source);
1794 case GTK_ICON_SOURCE_ICON_NAME:
1795 pixbuf = render_icon_name_pixbuf (source, style,
1796 direction, state, size,
1799 failed = g_slist_prepend (failed, source);
1801 case GTK_ICON_SOURCE_EMPTY:
1802 g_assert_not_reached ();
1806 g_slist_free (failed);
1812 render_fallback_image (GtkStyle *style,
1813 GtkTextDirection direction,
1819 /* This icon can be used for any direction/state/size */
1820 static GtkIconSource fallback_source = GTK_ICON_SOURCE_INIT (TRUE, TRUE, TRUE);
1822 if (fallback_source.type == GTK_ICON_SOURCE_EMPTY)
1824 GdkPixbuf *pixbuf = gdk_pixbuf_new_from_inline (-1, stock_missing_image_24, FALSE, NULL);
1825 gtk_icon_source_set_pixbuf (&fallback_source, pixbuf);
1826 g_object_unref (pixbuf);
1829 return gtk_style_render_icon (style,
1839 * gtk_icon_set_render_icon:
1840 * @icon_set: a #GtkIconSet
1841 * @style: a #GtkStyle associated with @widget, or %NULL
1842 * @direction: text direction
1843 * @state: widget state
1844 * @size: icon size. A size of (GtkIconSize)-1
1845 * means render at the size of the source and don't scale.
1846 * @widget: widget that will display the icon, or %NULL.
1847 * The only use that is typically made of this
1848 * is to determine the appropriate #GdkScreen.
1849 * @detail: detail to pass to the theme engine, or %NULL.
1850 * Note that passing a detail of anything but %NULL
1851 * will disable caching.
1853 * Renders an icon using gtk_style_render_icon(). In most cases,
1854 * gtk_widget_render_icon() is better, since it automatically provides
1855 * most of the arguments from the current widget settings. This
1856 * function never returns %NULL; if the icon can't be rendered
1857 * (perhaps because an image file fails to load), a default "missing
1858 * image" icon will be returned instead.
1860 * Return value: a #GdkPixbuf to be displayed
1863 gtk_icon_set_render_icon (GtkIconSet *icon_set,
1865 GtkTextDirection direction,
1873 g_return_val_if_fail (icon_set != NULL, NULL);
1874 g_return_val_if_fail (style == NULL || GTK_IS_STYLE (style), NULL);
1876 if (icon_set->sources == NULL)
1877 return render_fallback_image (style, direction, state, size, widget, detail);
1881 icon = find_in_cache (icon_set, style, direction,
1886 g_object_ref (icon);
1892 icon = find_and_render_icon_source (icon_set, style, direction, state, size,
1896 icon = render_fallback_image (style, direction, state, size, widget, detail);
1899 add_to_cache (icon_set, style, direction, state, size, icon);
1904 /* Order sources by their "wildness", so that "wilder" sources are
1905 * greater than "specific" sources; for determining ordering,
1906 * direction beats state beats size.
1910 icon_source_compare (gconstpointer ap, gconstpointer bp)
1912 const GtkIconSource *a = ap;
1913 const GtkIconSource *b = bp;
1915 if (!a->any_direction && b->any_direction)
1917 else if (a->any_direction && !b->any_direction)
1919 else if (!a->any_state && b->any_state)
1921 else if (a->any_state && !b->any_state)
1923 else if (!a->any_size && b->any_size)
1925 else if (a->any_size && !b->any_size)
1932 * gtk_icon_set_add_source:
1933 * @icon_set: a #GtkIconSet
1934 * @source: a #GtkIconSource
1936 * Icon sets have a list of #GtkIconSource, which they use as base
1937 * icons for rendering icons in different states and sizes. Icons are
1938 * scaled, made to look insensitive, etc. in
1939 * gtk_icon_set_render_icon(), but #GtkIconSet needs base images to
1940 * work with. The base images and when to use them are described by
1943 * This function copies @source, so you can reuse the same source immediately
1944 * without affecting the icon set.
1946 * An example of when you'd use this function: a web browser's "Back
1947 * to Previous Page" icon might point in a different direction in
1948 * Hebrew and in English; it might look different when insensitive;
1949 * and it might change size depending on toolbar mode (small/large
1950 * icons). So a single icon set would contain all those variants of
1951 * the icon, and you might add a separate source for each one.
1953 * You should nearly always add a "default" icon source with all
1954 * fields wildcarded, which will be used as a fallback if no more
1955 * specific source matches. #GtkIconSet always prefers more specific
1956 * icon sources to more generic icon sources. The order in which you
1957 * add the sources to the icon set does not matter.
1959 * gtk_icon_set_new_from_pixbuf() creates a new icon set with a
1960 * default icon source based on the given pixbuf.
1964 gtk_icon_set_add_source (GtkIconSet *icon_set,
1965 const GtkIconSource *source)
1967 g_return_if_fail (icon_set != NULL);
1968 g_return_if_fail (source != NULL);
1970 if (source->type == GTK_ICON_SOURCE_EMPTY)
1972 g_warning ("Useless empty GtkIconSource");
1976 icon_set->sources = g_slist_insert_sorted (icon_set->sources,
1977 gtk_icon_source_copy (source),
1978 icon_source_compare);
1982 * gtk_icon_set_get_sizes:
1983 * @icon_set: a #GtkIconSet
1984 * @sizes: return location for array of sizes
1985 * @n_sizes: location to store number of elements in returned array
1987 * Obtains a list of icon sizes this icon set can render. The returned
1988 * array must be freed with g_free().
1992 gtk_icon_set_get_sizes (GtkIconSet *icon_set,
1993 GtkIconSize **sizes,
1997 gboolean all_sizes = FALSE;
1998 GSList *specifics = NULL;
2000 g_return_if_fail (icon_set != NULL);
2001 g_return_if_fail (sizes != NULL);
2002 g_return_if_fail (n_sizes != NULL);
2004 tmp_list = icon_set->sources;
2005 while (tmp_list != NULL)
2007 GtkIconSource *source;
2009 source = tmp_list->data;
2011 if (source->any_size)
2017 specifics = g_slist_prepend (specifics, GINT_TO_POINTER (source->size));
2019 tmp_list = g_slist_next (tmp_list);
2024 /* Need to find out what sizes exist */
2029 *sizes = g_new (GtkIconSize, icon_sizes_used);
2030 *n_sizes = icon_sizes_used - 1;
2033 while (i < icon_sizes_used)
2035 (*sizes)[i - 1] = icon_sizes[i].size;
2043 *n_sizes = g_slist_length (specifics);
2044 *sizes = g_new (GtkIconSize, *n_sizes);
2047 tmp_list = specifics;
2048 while (tmp_list != NULL)
2050 (*sizes)[i] = GPOINTER_TO_INT (tmp_list->data);
2053 tmp_list = g_slist_next (tmp_list);
2057 g_slist_free (specifics);
2062 * gtk_icon_source_new:
2064 * Creates a new #GtkIconSource. A #GtkIconSource contains a #GdkPixbuf (or
2065 * image filename) that serves as the base image for one or more of the
2066 * icons in a #GtkIconSet, along with a specification for which icons in the
2067 * icon set will be based on that pixbuf or image file. An icon set contains
2068 * a set of icons that represent "the same" logical concept in different states,
2069 * different global text directions, and different sizes.
2071 * So for example a web browser's "Back to Previous Page" icon might
2072 * point in a different direction in Hebrew and in English; it might
2073 * look different when insensitive; and it might change size depending
2074 * on toolbar mode (small/large icons). So a single icon set would
2075 * contain all those variants of the icon. #GtkIconSet contains a list
2076 * of #GtkIconSource from which it can derive specific icon variants in
2079 * In the simplest case, #GtkIconSet contains one source pixbuf from
2080 * which it derives all variants. The convenience function
2081 * gtk_icon_set_new_from_pixbuf() handles this case; if you only have
2082 * one source pixbuf, just use that function.
2084 * If you want to use a different base pixbuf for different icon
2085 * variants, you create multiple icon sources, mark which variants
2086 * they'll be used to create, and add them to the icon set with
2087 * gtk_icon_set_add_source().
2089 * By default, the icon source has all parameters wildcarded. That is,
2090 * the icon source will be used as the base icon for any desired text
2091 * direction, widget state, or icon size.
2093 * Return value: a new #GtkIconSource
2096 gtk_icon_source_new (void)
2100 src = g_new0 (GtkIconSource, 1);
2102 src->direction = GTK_TEXT_DIR_NONE;
2103 src->size = GTK_ICON_SIZE_INVALID;
2104 src->state = GTK_STATE_NORMAL;
2106 src->any_direction = TRUE;
2107 src->any_state = TRUE;
2108 src->any_size = TRUE;
2114 * gtk_icon_source_copy:
2115 * @source: a #GtkIconSource
2117 * Creates a copy of @source; mostly useful for language bindings.
2119 * Return value: a new #GtkIconSource
2122 gtk_icon_source_copy (const GtkIconSource *source)
2124 GtkIconSource *copy;
2126 g_return_val_if_fail (source != NULL, NULL);
2128 copy = g_new (GtkIconSource, 1);
2134 case GTK_ICON_SOURCE_EMPTY:
2136 case GTK_ICON_SOURCE_ICON_NAME:
2137 copy->source.icon_name = g_strdup (copy->source.icon_name);
2139 case GTK_ICON_SOURCE_FILENAME:
2140 copy->source.filename = g_strdup (copy->source.filename);
2142 copy->cp_filename = g_strdup (copy->cp_filename);
2144 if (copy->filename_pixbuf)
2145 g_object_ref (copy->filename_pixbuf);
2147 case GTK_ICON_SOURCE_PIXBUF:
2148 g_object_ref (copy->source.pixbuf);
2151 g_assert_not_reached();
2158 * gtk_icon_source_free:
2159 * @source: a #GtkIconSource
2161 * Frees a dynamically-allocated icon source, along with its
2162 * filename, size, and pixbuf fields if those are not %NULL.
2165 gtk_icon_source_free (GtkIconSource *source)
2167 g_return_if_fail (source != NULL);
2169 icon_source_clear (source);
2174 gtk_icon_source_get_type (void)
2176 static GType our_type = 0;
2179 our_type = g_boxed_type_register_static ("GtkIconSource",
2180 (GBoxedCopyFunc) gtk_icon_source_copy,
2181 (GBoxedFreeFunc) gtk_icon_source_free);
2187 icon_source_clear (GtkIconSource *source)
2189 switch (source->type)
2191 case GTK_ICON_SOURCE_EMPTY:
2193 case GTK_ICON_SOURCE_ICON_NAME:
2194 g_free (source->source.icon_name);
2195 source->source.icon_name = NULL;
2197 case GTK_ICON_SOURCE_FILENAME:
2198 g_free (source->source.filename);
2199 source->source.filename = NULL;
2201 g_free (source->cp_filename);
2202 source->cp_filename = NULL;
2204 if (source->filename_pixbuf)
2205 g_object_unref (source->filename_pixbuf);
2206 source->filename_pixbuf = NULL;
2208 case GTK_ICON_SOURCE_PIXBUF:
2209 g_object_unref (source->source.pixbuf);
2210 source->source.pixbuf = NULL;
2213 g_assert_not_reached();
2216 source->type = GTK_ICON_SOURCE_EMPTY;
2220 * gtk_icon_source_set_filename:
2221 * @source: a #GtkIconSource
2222 * @filename: image file to use
2224 * Sets the name of an image file to use as a base image when creating
2225 * icon variants for #GtkIconSet. The filename must be absolute.
2228 gtk_icon_source_set_filename (GtkIconSource *source,
2229 const gchar *filename)
2231 g_return_if_fail (source != NULL);
2232 g_return_if_fail (filename == NULL || g_path_is_absolute (filename));
2234 if (source->type == GTK_ICON_SOURCE_FILENAME &&
2235 source->source.filename == filename)
2238 icon_source_clear (source);
2240 if (filename != NULL)
2242 source->type = GTK_ICON_SOURCE_FILENAME;
2243 source->source.filename = g_strdup (filename);
2245 source->cp_filename = g_locale_from_utf8 (filename, -1, NULL, NULL, NULL);
2251 * gtk_icon_source_set_icon_name
2252 * @source: a #GtkIconSource
2253 * @icon_name: name of icon to use
2255 * Sets the name of an icon to look up in the current icon theme
2256 * to use as a base image when creating icon variants for #GtkIconSet.
2259 gtk_icon_source_set_icon_name (GtkIconSource *source,
2260 const gchar *icon_name)
2262 g_return_if_fail (source != NULL);
2264 if (source->type == GTK_ICON_SOURCE_ICON_NAME &&
2265 source->source.icon_name == icon_name)
2268 icon_source_clear (source);
2270 if (icon_name != NULL)
2272 source->type = GTK_ICON_SOURCE_ICON_NAME;
2273 source->source.icon_name = g_strdup (icon_name);
2278 * gtk_icon_source_set_pixbuf:
2279 * @source: a #GtkIconSource
2280 * @pixbuf: pixbuf to use as a source
2282 * Sets a pixbuf to use as a base image when creating icon variants
2286 gtk_icon_source_set_pixbuf (GtkIconSource *source,
2289 g_return_if_fail (source != NULL);
2290 g_return_if_fail (pixbuf == NULL || GDK_IS_PIXBUF (pixbuf));
2292 if (source->type == GTK_ICON_SOURCE_PIXBUF &&
2293 source->source.pixbuf == pixbuf)
2296 icon_source_clear (source);
2300 source->type = GTK_ICON_SOURCE_PIXBUF;
2301 source->source.pixbuf = g_object_ref (pixbuf);
2306 * gtk_icon_source_get_filename:
2307 * @source: a #GtkIconSource
2309 * Retrieves the source filename, or %NULL if none is set. The
2310 * filename is not a copy, and should not be modified or expected to
2311 * persist beyond the lifetime of the icon source.
2313 * Return value: image filename. This string must not be modified
2316 G_CONST_RETURN gchar*
2317 gtk_icon_source_get_filename (const GtkIconSource *source)
2319 g_return_val_if_fail (source != NULL, NULL);
2321 if (source->type == GTK_ICON_SOURCE_FILENAME)
2322 return source->source.filename;
2328 * gtk_icon_source_get_icon_name:
2329 * @source: a #GtkIconSource
2331 * Retrieves the source icon name, or %NULL if none is set. The
2332 * icon_name is not a copy, and should not be modified or expected to
2333 * persist beyond the lifetime of the icon source.
2335 * Return value: icon name. This string must not be modified or freed.
2337 G_CONST_RETURN gchar*
2338 gtk_icon_source_get_icon_name (const GtkIconSource *source)
2340 g_return_val_if_fail (source != NULL, NULL);
2342 if (source->type == GTK_ICON_SOURCE_ICON_NAME)
2343 return source->source.icon_name;
2349 * gtk_icon_source_get_pixbuf:
2350 * @source: a #GtkIconSource
2352 * Retrieves the source pixbuf, or %NULL if none is set.
2353 * In addition, if a filename source is in use, this
2354 * function in some cases will return the pixbuf from
2355 * loaded from the filename. This is, for example, true
2356 * for the GtkIconSource passed to the GtkStyle::render_icon()
2357 * virtual function. The reference count on the pixbuf is
2360 * Return value: source pixbuf
2363 gtk_icon_source_get_pixbuf (const GtkIconSource *source)
2365 g_return_val_if_fail (source != NULL, NULL);
2367 if (source->type == GTK_ICON_SOURCE_PIXBUF)
2368 return source->source.pixbuf;
2369 else if (source->type == GTK_ICON_SOURCE_FILENAME)
2370 return source->filename_pixbuf;
2376 * gtk_icon_source_set_direction_wildcarded:
2377 * @source: a #GtkIconSource
2378 * @setting: %TRUE to wildcard the text direction
2380 * If the text direction is wildcarded, this source can be used
2381 * as the base image for an icon in any #GtkTextDirection.
2382 * If the text direction is not wildcarded, then the
2383 * text direction the icon source applies to should be set
2384 * with gtk_icon_source_set_direction(), and the icon source
2385 * will only be used with that text direction.
2387 * #GtkIconSet prefers non-wildcarded sources (exact matches) over
2388 * wildcarded sources, and will use an exact match when possible.
2392 gtk_icon_source_set_direction_wildcarded (GtkIconSource *source,
2395 g_return_if_fail (source != NULL);
2397 source->any_direction = setting != FALSE;
2401 * gtk_icon_source_set_state_wildcarded:
2402 * @source: a #GtkIconSource
2403 * @setting: %TRUE to wildcard the widget state
2405 * If the widget state is wildcarded, this source can be used as the
2406 * base image for an icon in any #GtkStateType. If the widget state
2407 * is not wildcarded, then the state the source applies to should be
2408 * set with gtk_icon_source_set_state() and the icon source will
2409 * only be used with that specific state.
2411 * #GtkIconSet prefers non-wildcarded sources (exact matches) over
2412 * wildcarded sources, and will use an exact match when possible.
2414 * #GtkIconSet will normally transform wildcarded source images to
2415 * produce an appropriate icon for a given state, for example
2416 * lightening an image on prelight, but will not modify source images
2417 * that match exactly.
2420 gtk_icon_source_set_state_wildcarded (GtkIconSource *source,
2423 g_return_if_fail (source != NULL);
2425 source->any_state = setting != FALSE;
2430 * gtk_icon_source_set_size_wildcarded:
2431 * @source: a #GtkIconSource
2432 * @setting: %TRUE to wildcard the widget state
2434 * If the icon size is wildcarded, this source can be used as the base
2435 * image for an icon of any size. If the size is not wildcarded, then
2436 * the size the source applies to should be set with
2437 * gtk_icon_source_set_size() and the icon source will only be used
2438 * with that specific size.
2440 * #GtkIconSet prefers non-wildcarded sources (exact matches) over
2441 * wildcarded sources, and will use an exact match when possible.
2443 * #GtkIconSet will normally scale wildcarded source images to produce
2444 * an appropriate icon at a given size, but will not change the size
2445 * of source images that match exactly.
2448 gtk_icon_source_set_size_wildcarded (GtkIconSource *source,
2451 g_return_if_fail (source != NULL);
2453 source->any_size = setting != FALSE;
2457 * gtk_icon_source_get_size_wildcarded:
2458 * @source: a #GtkIconSource
2460 * Gets the value set by gtk_icon_source_set_size_wildcarded().
2462 * Return value: %TRUE if this icon source is a base for any icon size variant
2465 gtk_icon_source_get_size_wildcarded (const GtkIconSource *source)
2467 g_return_val_if_fail (source != NULL, TRUE);
2469 return source->any_size;
2473 * gtk_icon_source_get_state_wildcarded:
2474 * @source: a #GtkIconSource
2476 * Gets the value set by gtk_icon_source_set_state_wildcarded().
2478 * Return value: %TRUE if this icon source is a base for any widget state variant
2481 gtk_icon_source_get_state_wildcarded (const GtkIconSource *source)
2483 g_return_val_if_fail (source != NULL, TRUE);
2485 return source->any_state;
2489 * gtk_icon_source_get_direction_wildcarded:
2490 * @source: a #GtkIconSource
2492 * Gets the value set by gtk_icon_source_set_direction_wildcarded().
2494 * Return value: %TRUE if this icon source is a base for any text direction variant
2497 gtk_icon_source_get_direction_wildcarded (const GtkIconSource *source)
2499 g_return_val_if_fail (source != NULL, TRUE);
2501 return source->any_direction;
2505 * gtk_icon_source_set_direction:
2506 * @source: a #GtkIconSource
2507 * @direction: text direction this source applies to
2509 * Sets the text direction this icon source is intended to be used
2512 * Setting the text direction on an icon source makes no difference
2513 * if the text direction is wildcarded. Therefore, you should usually
2514 * call gtk_icon_source_set_direction_wildcarded() to un-wildcard it
2515 * in addition to calling this function.
2519 gtk_icon_source_set_direction (GtkIconSource *source,
2520 GtkTextDirection direction)
2522 g_return_if_fail (source != NULL);
2524 source->direction = direction;
2528 * gtk_icon_source_set_state:
2529 * @source: a #GtkIconSource
2530 * @state: widget state this source applies to
2532 * Sets the widget state this icon source is intended to be used
2535 * Setting the widget state on an icon source makes no difference
2536 * if the state is wildcarded. Therefore, you should usually
2537 * call gtk_icon_source_set_state_wildcarded() to un-wildcard it
2538 * in addition to calling this function.
2542 gtk_icon_source_set_state (GtkIconSource *source,
2545 g_return_if_fail (source != NULL);
2547 source->state = state;
2551 * gtk_icon_source_set_size:
2552 * @source: a #GtkIconSource
2553 * @size: icon size this source applies to
2555 * Sets the icon size this icon source is intended to be used
2558 * Setting the icon size on an icon source makes no difference
2559 * if the size is wildcarded. Therefore, you should usually
2560 * call gtk_icon_source_set_size_wildcarded() to un-wildcard it
2561 * in addition to calling this function.
2565 gtk_icon_source_set_size (GtkIconSource *source,
2568 g_return_if_fail (source != NULL);
2570 source->size = size;
2574 * gtk_icon_source_get_direction:
2575 * @source: a #GtkIconSource
2577 * Obtains the text direction this icon source applies to. The return
2578 * value is only useful/meaningful if the text direction is <emphasis>not</emphasis>
2581 * Return value: text direction this source matches
2584 gtk_icon_source_get_direction (const GtkIconSource *source)
2586 g_return_val_if_fail (source != NULL, 0);
2588 return source->direction;
2592 * gtk_icon_source_get_state:
2593 * @source: a #GtkIconSource
2595 * Obtains the widget state this icon source applies to. The return
2596 * value is only useful/meaningful if the widget state is <emphasis>not</emphasis>
2599 * Return value: widget state this source matches
2602 gtk_icon_source_get_state (const GtkIconSource *source)
2604 g_return_val_if_fail (source != NULL, 0);
2606 return source->state;
2610 * gtk_icon_source_get_size:
2611 * @source: a #GtkIconSource
2613 * Obtains the icon size this source applies to. The return value
2614 * is only useful/meaningful if the icon size is <emphasis>not</emphasis> wildcarded.
2616 * Return value: icon size this source matches.
2619 gtk_icon_source_get_size (const GtkIconSource *source)
2621 g_return_val_if_fail (source != NULL, 0);
2623 return source->size;
2626 #define NUM_CACHED_ICONS 8
2628 typedef struct _CachedIcon CachedIcon;
2632 /* These must all match to use the cached pixbuf.
2633 * If any don't match, we must re-render the pixbuf.
2636 GtkTextDirection direction;
2644 ensure_cache_up_to_date (GtkIconSet *icon_set)
2646 if (icon_set->cache_serial != cache_serial)
2648 clear_cache (icon_set, TRUE);
2649 icon_set->cache_serial = cache_serial;
2654 cached_icon_free (CachedIcon *icon)
2656 g_object_unref (icon->pixbuf);
2659 g_object_unref (icon->style);
2665 find_in_cache (GtkIconSet *icon_set,
2667 GtkTextDirection direction,
2674 ensure_cache_up_to_date (icon_set);
2677 tmp_list = icon_set->cache;
2678 while (tmp_list != NULL)
2680 CachedIcon *icon = tmp_list->data;
2682 if (icon->style == style &&
2683 icon->direction == direction &&
2684 icon->state == state &&
2689 /* Move this icon to the front of the list. */
2690 prev->next = tmp_list->next;
2691 tmp_list->next = icon_set->cache;
2692 icon_set->cache = tmp_list;
2695 return icon->pixbuf;
2699 tmp_list = g_slist_next (tmp_list);
2706 add_to_cache (GtkIconSet *icon_set,
2708 GtkTextDirection direction,
2715 ensure_cache_up_to_date (icon_set);
2717 g_object_ref (pixbuf);
2719 /* We have to ref the style, since if the style was finalized
2720 * its address could be reused by another style, creating a
2725 g_object_ref (style);
2727 icon = g_new (CachedIcon, 1);
2728 icon_set->cache = g_slist_prepend (icon_set->cache, icon);
2729 icon_set->cache_size++;
2731 icon->style = style;
2732 icon->direction = direction;
2733 icon->state = state;
2735 icon->pixbuf = pixbuf;
2738 attach_to_style (icon_set, icon->style);
2740 if (icon_set->cache_size >= NUM_CACHED_ICONS)
2742 /* Remove oldest item in the cache */
2745 tmp_list = icon_set->cache;
2747 /* Find next-to-last link */
2748 g_assert (NUM_CACHED_ICONS > 2);
2749 while (tmp_list->next->next)
2750 tmp_list = tmp_list->next;
2752 g_assert (tmp_list != NULL);
2753 g_assert (tmp_list->next != NULL);
2754 g_assert (tmp_list->next->next == NULL);
2756 /* Free the last icon */
2757 icon = tmp_list->next->data;
2759 g_slist_free (tmp_list->next);
2760 tmp_list->next = NULL;
2762 cached_icon_free (icon);
2767 clear_cache (GtkIconSet *icon_set,
2768 gboolean style_detach)
2770 GSList *cache, *tmp_list;
2771 GtkStyle *last_style = NULL;
2773 cache = icon_set->cache;
2774 icon_set->cache = NULL;
2775 icon_set->cache_size = 0;
2777 while (tmp_list != NULL)
2779 CachedIcon *icon = tmp_list->data;
2783 /* simple optimization for the case where the cache
2784 * contains contiguous icons from the same style.
2785 * it's safe to call detach_from_style more than
2786 * once on the same style though.
2788 if (last_style != icon->style)
2790 detach_from_style (icon_set, icon->style);
2791 last_style = icon->style;
2795 cached_icon_free (icon);
2797 tmp_list = g_slist_next (tmp_list);
2800 g_slist_free (cache);
2804 copy_cache (GtkIconSet *icon_set,
2805 GtkIconSet *copy_recipient)
2808 GSList *copy = NULL;
2810 ensure_cache_up_to_date (icon_set);
2812 tmp_list = icon_set->cache;
2813 while (tmp_list != NULL)
2815 CachedIcon *icon = tmp_list->data;
2816 CachedIcon *icon_copy = g_new (CachedIcon, 1);
2820 if (icon_copy->style)
2822 attach_to_style (copy_recipient, icon_copy->style);
2823 g_object_ref (icon_copy->style);
2826 g_object_ref (icon_copy->pixbuf);
2828 icon_copy->size = icon->size;
2830 copy = g_slist_prepend (copy, icon_copy);
2832 tmp_list = g_slist_next (tmp_list);
2835 return g_slist_reverse (copy);
2839 attach_to_style (GtkIconSet *icon_set,
2844 table = g_object_get_qdata (G_OBJECT (style),
2845 g_quark_try_string ("gtk-style-icon-sets"));
2849 table = g_hash_table_new (NULL, NULL);
2850 g_object_set_qdata_full (G_OBJECT (style),
2851 g_quark_from_static_string ("gtk-style-icon-sets"),
2856 g_hash_table_insert (table, icon_set, icon_set);
2860 detach_from_style (GtkIconSet *icon_set,
2865 table = g_object_get_qdata (G_OBJECT (style),
2866 g_quark_try_string ("gtk-style-icon-sets"));
2869 g_hash_table_remove (table, icon_set);
2873 iconsets_foreach (gpointer key,
2877 GtkIconSet *icon_set = key;
2879 /* We only need to remove cache entries for the given style;
2880 * but that complicates things because in destroy notify
2881 * we don't know which style got destroyed, and 95% of the
2882 * time all cache entries will have the same style,
2883 * so this is faster anyway.
2886 clear_cache (icon_set, FALSE);
2890 style_dnotify (gpointer data)
2892 GHashTable *table = data;
2894 g_hash_table_foreach (table, iconsets_foreach, NULL);
2896 g_hash_table_destroy (table);
2899 /* This allows the icon set to detect that its cache is out of date. */
2901 _gtk_icon_set_invalidate_caches (void)
2907 listify_foreach (gpointer key, gpointer value, gpointer data)
2909 GSList **list = data;
2911 *list = g_slist_prepend (*list, key);
2915 g_hash_table_get_keys (GHashTable *table)
2917 GSList *list = NULL;
2919 g_hash_table_foreach (table, listify_foreach, &list);
2925 * _gtk_icon_factory_list_ids:
2927 * Gets all known IDs stored in an existing icon factory.
2928 * The strings in the returned list aren't copied.
2929 * The list itself should be freed.
2931 * Return value: List of ids in icon factories
2934 _gtk_icon_factory_list_ids (void)
2941 ensure_default_icons ();
2943 tmp_list = all_icon_factories;
2944 while (tmp_list != NULL)
2948 GtkIconFactory *factory = GTK_ICON_FACTORY (tmp_list->data);
2950 these_ids = g_hash_table_get_keys (factory->icons);
2952 ids = g_slist_concat (ids, these_ids);
2954 tmp_list = g_slist_next (tmp_list);
2962 /* DLL ABI stability backward compatibility versions */
2964 #undef gtk_icon_source_set_filename
2967 gtk_icon_source_set_filename (GtkIconSource *source,
2968 const gchar *filename)
2970 gchar *utf8_filename = g_locale_to_utf8 (filename, -1, NULL, NULL, NULL);
2972 gtk_icon_source_set_filename_utf8 (source, utf8_filename);
2974 g_free (utf8_filename);
2977 #undef gtk_icon_source_get_filename
2979 G_CONST_RETURN gchar*
2980 gtk_icon_source_get_filename (const GtkIconSource *source)
2982 g_return_val_if_fail (source != NULL, NULL);
2984 if (source->type == GTK_ICON_SOURCE_FILENAME)
2985 return source->cp_filename;