1 /* GTK - The GTK+ 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/.
31 #include "gtkiconfactory.h"
32 #include "gtkiconcache.h"
34 #include "gtkicontheme.h"
35 #include "gtksettings.h"
37 #include "gtkwidget.h"
39 #include "gtkbuildable.h"
40 #include "gtkbuilderprivate.h"
44 static GSList *all_icon_factories = NULL;
47 GTK_ICON_SOURCE_EMPTY,
48 GTK_ICON_SOURCE_ICON_NAME,
49 GTK_ICON_SOURCE_STATIC_ICON_NAME,
50 GTK_ICON_SOURCE_FILENAME,
51 GTK_ICON_SOURCE_PIXBUF
56 GtkIconSourceType type;
64 GdkPixbuf *filename_pixbuf;
66 GtkTextDirection direction;
70 /* If TRUE, then the parameter is wildcarded, and the above
71 * fields should be ignored. If FALSE, the parameter is
72 * specified, and the above fields should be valid.
74 guint any_direction : 1;
79 /* System codepage version of filename, for DLL ABI backward
80 * compatibility functions.
88 gtk_icon_factory_buildable_init (GtkBuildableIface *iface);
90 static gboolean gtk_icon_factory_buildable_custom_tag_start (GtkBuildable *buildable,
94 GMarkupParser *parser,
96 static void gtk_icon_factory_buildable_custom_tag_end (GtkBuildable *buildable,
100 gpointer *user_data);
101 static void gtk_icon_factory_finalize (GObject *object);
102 static void get_default_icons (GtkIconFactory *icon_factory);
103 static void icon_source_clear (GtkIconSource *source);
105 static GtkIconSize icon_size_register_intern (const gchar *name,
109 #define GTK_ICON_SOURCE_INIT(any_direction, any_state, any_size) \
110 { GTK_ICON_SOURCE_EMPTY, { NULL }, NULL, \
112 any_direction, any_state, any_size }
114 G_DEFINE_TYPE_WITH_CODE (GtkIconFactory, gtk_icon_factory, G_TYPE_OBJECT,
115 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
116 gtk_icon_factory_buildable_init))
119 gtk_icon_factory_init (GtkIconFactory *factory)
121 factory->icons = g_hash_table_new (g_str_hash, g_str_equal);
122 all_icon_factories = g_slist_prepend (all_icon_factories, factory);
126 gtk_icon_factory_class_init (GtkIconFactoryClass *klass)
128 GObjectClass *object_class = G_OBJECT_CLASS (klass);
130 object_class->finalize = gtk_icon_factory_finalize;
134 gtk_icon_factory_buildable_init (GtkBuildableIface *iface)
136 iface->custom_tag_start = gtk_icon_factory_buildable_custom_tag_start;
137 iface->custom_tag_end = gtk_icon_factory_buildable_custom_tag_end;
141 free_icon_set (gpointer key, gpointer value, gpointer data)
144 gtk_icon_set_unref (value);
148 gtk_icon_factory_finalize (GObject *object)
150 GtkIconFactory *factory = GTK_ICON_FACTORY (object);
152 all_icon_factories = g_slist_remove (all_icon_factories, factory);
154 g_hash_table_foreach (factory->icons, free_icon_set, NULL);
156 g_hash_table_destroy (factory->icons);
158 G_OBJECT_CLASS (gtk_icon_factory_parent_class)->finalize (object);
162 * gtk_icon_factory_new:
164 * Creates a new #GtkIconFactory. An icon factory manages a collection
165 * of #GtkIconSet<!-- -->s; a #GtkIconSet manages a set of variants of a
166 * particular icon (i.e. a #GtkIconSet contains variants for different
167 * sizes and widget states). Icons in an icon factory are named by a
168 * stock ID, which is a simple string identifying the icon. Each
169 * #GtkStyle has a list of #GtkIconFactory<!-- -->s derived from the current
170 * theme; those icon factories are consulted first when searching for
171 * an icon. If the theme doesn't set a particular icon, GTK+ looks for
172 * the icon in a list of default icon factories, maintained by
173 * gtk_icon_factory_add_default() and
174 * gtk_icon_factory_remove_default(). Applications with icons should
175 * add a default icon factory with their icons, which will allow
176 * themes to override the icons for the application.
178 * Return value: a new #GtkIconFactory
181 gtk_icon_factory_new (void)
183 return g_object_new (GTK_TYPE_ICON_FACTORY, NULL);
187 * gtk_icon_factory_add:
188 * @factory: a #GtkIconFactory
189 * @stock_id: icon name
190 * @icon_set: icon set
192 * Adds the given @icon_set to the icon factory, under the name
193 * @stock_id. @stock_id should be namespaced for your application,
194 * e.g. "myapp-whatever-icon". Normally applications create a
195 * #GtkIconFactory, then add it to the list of default factories with
196 * gtk_icon_factory_add_default(). Then they pass the @stock_id to
197 * widgets such as #GtkImage to display the icon. Themes can provide
198 * an icon with the same name (such as "myapp-whatever-icon") to
199 * override your application's default icons. If an icon already
200 * existed in @factory for @stock_id, it is unreferenced and replaced
201 * with the new @icon_set.
205 gtk_icon_factory_add (GtkIconFactory *factory,
206 const gchar *stock_id,
207 GtkIconSet *icon_set)
209 gpointer old_key = NULL;
210 gpointer old_value = NULL;
212 g_return_if_fail (GTK_IS_ICON_FACTORY (factory));
213 g_return_if_fail (stock_id != NULL);
214 g_return_if_fail (icon_set != NULL);
216 g_hash_table_lookup_extended (factory->icons, stock_id,
217 &old_key, &old_value);
219 if (old_value == icon_set)
222 gtk_icon_set_ref (icon_set);
224 /* GHashTable key memory management is so fantastically broken. */
226 g_hash_table_insert (factory->icons, old_key, icon_set);
228 g_hash_table_insert (factory->icons, g_strdup (stock_id), icon_set);
231 gtk_icon_set_unref (old_value);
235 * gtk_icon_factory_lookup:
236 * @factory: a #GtkIconFactory
237 * @stock_id: an icon name
239 * Looks up @stock_id in the icon factory, returning an icon set
240 * if found, otherwise %NULL. For display to the user, you should
241 * use gtk_style_lookup_icon_set() on the #GtkStyle for the
242 * widget that will display the icon, instead of using this
243 * function directly, so that themes are taken into account.
245 * Return value: icon set of @stock_id.
248 gtk_icon_factory_lookup (GtkIconFactory *factory,
249 const gchar *stock_id)
251 g_return_val_if_fail (GTK_IS_ICON_FACTORY (factory), NULL);
252 g_return_val_if_fail (stock_id != NULL, NULL);
254 return g_hash_table_lookup (factory->icons, stock_id);
257 static GtkIconFactory *gtk_default_icons = NULL;
258 static GSList *default_factories = NULL;
261 * gtk_icon_factory_add_default:
262 * @factory: a #GtkIconFactory
264 * Adds an icon factory to the list of icon factories searched by
265 * gtk_style_lookup_icon_set(). This means that, for example,
266 * gtk_image_new_from_stock() will be able to find icons in @factory.
267 * There will normally be an icon factory added for each library or
268 * application that comes with icons. The default icon factories
269 * can be overridden by themes.
273 gtk_icon_factory_add_default (GtkIconFactory *factory)
275 g_return_if_fail (GTK_IS_ICON_FACTORY (factory));
277 g_object_ref (factory);
279 default_factories = g_slist_prepend (default_factories, factory);
283 * gtk_icon_factory_remove_default:
284 * @factory: a #GtkIconFactory previously added with gtk_icon_factory_add_default()
286 * Removes an icon factory from the list of default icon
287 * factories. Not normally used; you might use it for a library that
288 * can be unloaded or shut down.
292 gtk_icon_factory_remove_default (GtkIconFactory *factory)
294 g_return_if_fail (GTK_IS_ICON_FACTORY (factory));
296 default_factories = g_slist_remove (default_factories, factory);
298 g_object_unref (factory);
302 _gtk_icon_factory_ensure_default_icons (void)
304 if (gtk_default_icons == NULL)
306 gtk_default_icons = gtk_icon_factory_new ();
308 get_default_icons (gtk_default_icons);
313 * gtk_icon_factory_lookup_default:
314 * @stock_id: an icon name
316 * Looks for an icon in the list of default icon factories. For
317 * display to the user, you should use gtk_style_lookup_icon_set() on
318 * the #GtkStyle for the widget that will display the icon, instead of
319 * using this function directly, so that themes are taken into
323 * Return value: a #GtkIconSet, or %NULL
326 gtk_icon_factory_lookup_default (const gchar *stock_id)
330 g_return_val_if_fail (stock_id != NULL, NULL);
332 tmp_list = default_factories;
333 while (tmp_list != NULL)
335 GtkIconSet *icon_set =
336 gtk_icon_factory_lookup (GTK_ICON_FACTORY (tmp_list->data),
342 tmp_list = g_slist_next (tmp_list);
345 _gtk_icon_factory_ensure_default_icons ();
347 return gtk_icon_factory_lookup (gtk_default_icons, stock_id);
351 register_stock_icon (GtkIconFactory *factory,
352 const gchar *stock_id)
354 GtkIconSet *set = gtk_icon_set_new ();
355 GtkIconSource source = GTK_ICON_SOURCE_INIT (TRUE, TRUE, TRUE);
357 source.type = GTK_ICON_SOURCE_STATIC_ICON_NAME;
358 source.source.icon_name = (gchar *)stock_id;
359 gtk_icon_set_add_source (set, &source);
361 gtk_icon_factory_add (factory, stock_id, set);
362 gtk_icon_set_unref (set);
366 register_bidi_stock_icon (GtkIconFactory *factory,
367 const gchar *stock_id,
368 const gchar *stock_id_ltr,
369 const gchar *stock_id_rtl)
371 GtkIconSet *set = gtk_icon_set_new ();
372 GtkIconSource source = GTK_ICON_SOURCE_INIT (FALSE, TRUE, TRUE);
374 source.type = GTK_ICON_SOURCE_STATIC_ICON_NAME;
375 source.source.icon_name = (gchar *)stock_id_ltr;
376 source.direction = GTK_TEXT_DIR_LTR;
377 gtk_icon_set_add_source (set, &source);
379 source.type = GTK_ICON_SOURCE_STATIC_ICON_NAME;
380 source.source.icon_name = (gchar *)stock_id_rtl;
381 source.direction = GTK_TEXT_DIR_RTL;
382 gtk_icon_set_add_source (set, &source);
384 gtk_icon_factory_add (factory, stock_id, set);
385 gtk_icon_set_unref (set);
389 get_default_icons (GtkIconFactory *factory)
391 /* KEEP IN SYNC with gtkstock.c */
393 register_stock_icon (factory, GTK_STOCK_DIALOG_AUTHENTICATION);
394 register_stock_icon (factory, GTK_STOCK_DIALOG_ERROR);
395 register_stock_icon (factory, GTK_STOCK_DIALOG_INFO);
396 register_stock_icon (factory, GTK_STOCK_DIALOG_QUESTION);
397 register_stock_icon (factory, GTK_STOCK_DIALOG_WARNING);
398 register_stock_icon (factory, GTK_STOCK_DND);
399 register_stock_icon (factory, GTK_STOCK_DND_MULTIPLE);
400 register_stock_icon (factory, GTK_STOCK_APPLY);
401 register_stock_icon (factory, GTK_STOCK_CANCEL);
402 register_stock_icon (factory, GTK_STOCK_NO);
403 register_stock_icon (factory, GTK_STOCK_OK);
404 register_stock_icon (factory, GTK_STOCK_YES);
405 register_stock_icon (factory, GTK_STOCK_CLOSE);
406 register_stock_icon (factory, GTK_STOCK_ADD);
407 register_stock_icon (factory, GTK_STOCK_JUSTIFY_CENTER);
408 register_stock_icon (factory, GTK_STOCK_JUSTIFY_FILL);
409 register_stock_icon (factory, GTK_STOCK_JUSTIFY_LEFT);
410 register_stock_icon (factory, GTK_STOCK_JUSTIFY_RIGHT);
411 register_stock_icon (factory, GTK_STOCK_GOTO_BOTTOM);
412 register_stock_icon (factory, GTK_STOCK_CDROM);
413 register_stock_icon (factory, GTK_STOCK_CONVERT);
414 register_stock_icon (factory, GTK_STOCK_COPY);
415 register_stock_icon (factory, GTK_STOCK_CUT);
416 register_stock_icon (factory, GTK_STOCK_GO_DOWN);
417 register_stock_icon (factory, GTK_STOCK_EXECUTE);
418 register_stock_icon (factory, GTK_STOCK_QUIT);
419 register_bidi_stock_icon (factory,
420 GTK_STOCK_GOTO_FIRST,
421 GTK_STOCK_GOTO_FIRST "-ltr",
422 GTK_STOCK_GOTO_FIRST "-rtl");
423 register_stock_icon (factory, GTK_STOCK_SELECT_FONT);
424 register_stock_icon (factory, GTK_STOCK_FULLSCREEN);
425 register_stock_icon (factory, GTK_STOCK_LEAVE_FULLSCREEN);
426 register_stock_icon (factory, GTK_STOCK_HARDDISK);
427 register_stock_icon (factory, GTK_STOCK_HELP);
428 register_stock_icon (factory, GTK_STOCK_HOME);
429 register_stock_icon (factory, GTK_STOCK_INFO);
430 register_bidi_stock_icon (factory,
432 GTK_STOCK_JUMP_TO "-ltr",
433 GTK_STOCK_JUMP_TO "-rtl");
434 register_bidi_stock_icon (factory,
436 GTK_STOCK_GOTO_LAST "-ltr",
437 GTK_STOCK_GOTO_LAST "-rtl");
438 register_bidi_stock_icon (factory,
440 GTK_STOCK_GO_BACK "-ltr",
441 GTK_STOCK_GO_BACK "-rtl");
442 register_stock_icon (factory, GTK_STOCK_MISSING_IMAGE);
443 register_stock_icon (factory, GTK_STOCK_NETWORK);
444 register_stock_icon (factory, GTK_STOCK_NEW);
445 register_stock_icon (factory, GTK_STOCK_OPEN);
446 register_stock_icon (factory, GTK_STOCK_ORIENTATION_PORTRAIT);
447 register_stock_icon (factory, GTK_STOCK_ORIENTATION_LANDSCAPE);
448 register_stock_icon (factory, GTK_STOCK_ORIENTATION_REVERSE_PORTRAIT);
449 register_stock_icon (factory, GTK_STOCK_ORIENTATION_REVERSE_LANDSCAPE);
450 register_stock_icon (factory, GTK_STOCK_PAGE_SETUP);
451 register_stock_icon (factory, GTK_STOCK_PASTE);
452 register_stock_icon (factory, GTK_STOCK_PREFERENCES);
453 register_stock_icon (factory, GTK_STOCK_PRINT);
454 register_stock_icon (factory, GTK_STOCK_PRINT_ERROR);
455 register_stock_icon (factory, GTK_STOCK_PRINT_PREVIEW);
456 register_stock_icon (factory, GTK_STOCK_PRINT_REPORT);
457 register_stock_icon (factory, GTK_STOCK_PRINT_WARNING);
458 register_stock_icon (factory, GTK_STOCK_PROPERTIES);
459 register_bidi_stock_icon (factory,
461 GTK_STOCK_REDO "-ltr",
462 GTK_STOCK_REDO "-rtl");
463 register_stock_icon (factory, GTK_STOCK_REMOVE);
464 register_stock_icon (factory, GTK_STOCK_REFRESH);
465 register_bidi_stock_icon (factory,
466 GTK_STOCK_REVERT_TO_SAVED,
467 GTK_STOCK_REVERT_TO_SAVED "-ltr",
468 GTK_STOCK_REVERT_TO_SAVED "-rtl");
469 register_bidi_stock_icon (factory,
470 GTK_STOCK_GO_FORWARD,
471 GTK_STOCK_GO_FORWARD "-ltr",
472 GTK_STOCK_GO_FORWARD "-rtl");
473 register_stock_icon (factory, GTK_STOCK_SAVE);
474 register_stock_icon (factory, GTK_STOCK_FLOPPY);
475 register_stock_icon (factory, GTK_STOCK_SAVE_AS);
476 register_stock_icon (factory, GTK_STOCK_FIND);
477 register_stock_icon (factory, GTK_STOCK_FIND_AND_REPLACE);
478 register_stock_icon (factory, GTK_STOCK_SORT_DESCENDING);
479 register_stock_icon (factory, GTK_STOCK_SORT_ASCENDING);
480 register_stock_icon (factory, GTK_STOCK_SPELL_CHECK);
481 register_stock_icon (factory, GTK_STOCK_STOP);
482 register_stock_icon (factory, GTK_STOCK_BOLD);
483 register_stock_icon (factory, GTK_STOCK_ITALIC);
484 register_stock_icon (factory, GTK_STOCK_STRIKETHROUGH);
485 register_stock_icon (factory, GTK_STOCK_UNDERLINE);
486 register_bidi_stock_icon (factory,
488 GTK_STOCK_INDENT "-ltr",
489 GTK_STOCK_INDENT "-rtl");
490 register_bidi_stock_icon (factory,
492 GTK_STOCK_UNINDENT "-ltr",
493 GTK_STOCK_UNINDENT "-rtl");
494 register_stock_icon (factory, GTK_STOCK_GOTO_TOP);
495 register_stock_icon (factory, GTK_STOCK_DELETE);
496 register_bidi_stock_icon (factory,
498 GTK_STOCK_UNDELETE "-ltr",
499 GTK_STOCK_UNDELETE "-rtl");
500 register_bidi_stock_icon (factory,
502 GTK_STOCK_UNDO "-ltr",
503 GTK_STOCK_UNDO "-rtl");
504 register_stock_icon (factory, GTK_STOCK_GO_UP);
505 register_stock_icon (factory, GTK_STOCK_FILE);
506 register_stock_icon (factory, GTK_STOCK_DIRECTORY);
507 register_stock_icon (factory, GTK_STOCK_ABOUT);
508 register_stock_icon (factory, GTK_STOCK_CONNECT);
509 register_stock_icon (factory, GTK_STOCK_DISCONNECT);
510 register_stock_icon (factory, GTK_STOCK_EDIT);
511 register_bidi_stock_icon (factory,
512 GTK_STOCK_MEDIA_FORWARD,
513 GTK_STOCK_MEDIA_FORWARD "-ltr",
514 GTK_STOCK_MEDIA_FORWARD "-rtl");
515 register_bidi_stock_icon (factory,
516 GTK_STOCK_MEDIA_NEXT,
517 GTK_STOCK_MEDIA_NEXT "-ltr",
518 GTK_STOCK_MEDIA_NEXT "-rtl");
519 register_stock_icon (factory, GTK_STOCK_MEDIA_PAUSE);
520 register_bidi_stock_icon (factory,
521 GTK_STOCK_MEDIA_PLAY,
522 GTK_STOCK_MEDIA_PLAY "-ltr",
523 GTK_STOCK_MEDIA_PLAY "-rtl");
524 register_bidi_stock_icon (factory,
525 GTK_STOCK_MEDIA_PREVIOUS,
526 GTK_STOCK_MEDIA_PREVIOUS "-ltr",
527 GTK_STOCK_MEDIA_PREVIOUS "-rtl");
528 register_stock_icon (factory, GTK_STOCK_MEDIA_RECORD);
529 register_bidi_stock_icon (factory,
530 GTK_STOCK_MEDIA_REWIND,
531 GTK_STOCK_MEDIA_REWIND "-ltr",
532 GTK_STOCK_MEDIA_REWIND "-rtl");
533 register_stock_icon (factory, GTK_STOCK_MEDIA_STOP);
534 register_stock_icon (factory, GTK_STOCK_INDEX);
535 register_stock_icon (factory, GTK_STOCK_ZOOM_100);
536 register_stock_icon (factory, GTK_STOCK_ZOOM_IN);
537 register_stock_icon (factory, GTK_STOCK_ZOOM_OUT);
538 register_stock_icon (factory, GTK_STOCK_ZOOM_FIT);
539 register_stock_icon (factory, GTK_STOCK_SELECT_ALL);
540 register_stock_icon (factory, GTK_STOCK_CLEAR);
541 register_stock_icon (factory, GTK_STOCK_SELECT_COLOR);
542 register_stock_icon (factory, GTK_STOCK_COLOR_PICKER);
545 /************************************************************
546 * Icon size handling *
547 ************************************************************/
549 typedef struct _IconSize IconSize;
560 typedef struct _IconAlias IconAlias;
568 typedef struct _SettingsIconSize SettingsIconSize;
570 struct _SettingsIconSize
576 static GHashTable *icon_aliases = NULL;
577 static IconSize *icon_sizes = NULL;
578 static gint icon_sizes_allocated = 0;
579 static gint icon_sizes_used = 0;
582 init_icon_sizes (void)
584 if (icon_sizes == NULL)
586 #define NUM_BUILTIN_SIZES 7
589 icon_aliases = g_hash_table_new (g_str_hash, g_str_equal);
591 icon_sizes = g_new (IconSize, NUM_BUILTIN_SIZES);
592 icon_sizes_allocated = NUM_BUILTIN_SIZES;
593 icon_sizes_used = NUM_BUILTIN_SIZES;
595 icon_sizes[GTK_ICON_SIZE_INVALID].size = 0;
596 icon_sizes[GTK_ICON_SIZE_INVALID].name = NULL;
597 icon_sizes[GTK_ICON_SIZE_INVALID].width = 0;
598 icon_sizes[GTK_ICON_SIZE_INVALID].height = 0;
600 /* the name strings aren't copied since we don't ever remove
601 * icon sizes, so we don't need to know whether they're static.
602 * Even if we did I suppose removing the builtin sizes would be
606 icon_sizes[GTK_ICON_SIZE_MENU].size = GTK_ICON_SIZE_MENU;
607 icon_sizes[GTK_ICON_SIZE_MENU].name = "gtk-menu";
608 icon_sizes[GTK_ICON_SIZE_MENU].width = 16;
609 icon_sizes[GTK_ICON_SIZE_MENU].height = 16;
611 icon_sizes[GTK_ICON_SIZE_BUTTON].size = GTK_ICON_SIZE_BUTTON;
612 icon_sizes[GTK_ICON_SIZE_BUTTON].name = "gtk-button";
613 icon_sizes[GTK_ICON_SIZE_BUTTON].width = 20;
614 icon_sizes[GTK_ICON_SIZE_BUTTON].height = 20;
616 icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].size = GTK_ICON_SIZE_SMALL_TOOLBAR;
617 icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].name = "gtk-small-toolbar";
618 icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].width = 18;
619 icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].height = 18;
621 icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].size = GTK_ICON_SIZE_LARGE_TOOLBAR;
622 icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].name = "gtk-large-toolbar";
623 icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].width = 24;
624 icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].height = 24;
626 icon_sizes[GTK_ICON_SIZE_DND].size = GTK_ICON_SIZE_DND;
627 icon_sizes[GTK_ICON_SIZE_DND].name = "gtk-dnd";
628 icon_sizes[GTK_ICON_SIZE_DND].width = 32;
629 icon_sizes[GTK_ICON_SIZE_DND].height = 32;
631 icon_sizes[GTK_ICON_SIZE_DIALOG].size = GTK_ICON_SIZE_DIALOG;
632 icon_sizes[GTK_ICON_SIZE_DIALOG].name = "gtk-dialog";
633 icon_sizes[GTK_ICON_SIZE_DIALOG].width = 48;
634 icon_sizes[GTK_ICON_SIZE_DIALOG].height = 48;
636 g_assert ((GTK_ICON_SIZE_DIALOG + 1) == NUM_BUILTIN_SIZES);
638 /* Alias everything to itself. */
639 i = 1; /* skip invalid size */
640 while (i < NUM_BUILTIN_SIZES)
642 gtk_icon_size_register_alias (icon_sizes[i].name, icon_sizes[i].size);
647 #undef NUM_BUILTIN_SIZES
652 free_settings_sizes (gpointer data)
654 g_array_free (data, TRUE);
658 get_settings_sizes (GtkSettings *settings,
661 GArray *settings_sizes;
662 static GQuark sizes_quark = 0;
665 sizes_quark = g_quark_from_static_string ("gtk-icon-sizes");
667 settings_sizes = g_object_get_qdata (G_OBJECT (settings), sizes_quark);
670 settings_sizes = g_array_new (FALSE, FALSE, sizeof (SettingsIconSize));
671 g_object_set_qdata_full (G_OBJECT (settings), sizes_quark,
672 settings_sizes, free_settings_sizes);
677 return settings_sizes;
681 icon_size_set_for_settings (GtkSettings *settings,
682 const gchar *size_name,
687 GArray *settings_sizes;
688 SettingsIconSize *settings_size;
690 g_return_if_fail (size_name != NULL);
692 size = gtk_icon_size_from_name (size_name);
693 if (size == GTK_ICON_SIZE_INVALID)
694 /* Reserve a place */
695 size = icon_size_register_intern (size_name, -1, -1);
697 settings_sizes = get_settings_sizes (settings, NULL);
698 if (size >= settings_sizes->len)
700 SettingsIconSize unset = { -1, -1 };
703 for (i = settings_sizes->len; i <= size; i++)
704 g_array_append_val (settings_sizes, unset);
707 settings_size = &g_array_index (settings_sizes, SettingsIconSize, size);
709 settings_size->width = width;
710 settings_size->height = height;
713 /* Like pango_parse_word, but accept - as well
716 scan_icon_size_name (const char **pos, GString *out)
718 const char *p = *pos;
720 while (g_ascii_isspace (*p))
723 if (!((*p >= 'A' && *p <= 'Z') ||
724 (*p >= 'a' && *p <= 'z') ||
725 *p == '_' || *p == '-'))
728 g_string_truncate (out, 0);
729 g_string_append_c (out, *p);
732 while ((*p >= 'A' && *p <= 'Z') ||
733 (*p >= 'a' && *p <= 'z') ||
734 (*p >= '0' && *p <= '9') ||
735 *p == '_' || *p == '-')
737 g_string_append_c (out, *p);
747 icon_size_setting_parse (GtkSettings *settings,
748 const gchar *icon_size_string)
750 GString *name_buf = g_string_new (NULL);
751 const gchar *p = icon_size_string;
753 while (pango_skip_space (&p))
757 if (!scan_icon_size_name (&p, name_buf))
760 if (!pango_skip_space (&p))
768 if (!pango_scan_int (&p, &width))
771 if (!pango_skip_space (&p))
779 if (!pango_scan_int (&p, &height))
782 if (width > 0 && height > 0)
784 icon_size_set_for_settings (settings, name_buf->str,
789 g_warning ("Invalid size in gtk-icon-sizes: %d,%d\n", width, height);
792 pango_skip_space (&p);
801 g_string_free (name_buf, TRUE);
805 g_warning ("Error parsing gtk-icon-sizes string:\n\t'%s'", icon_size_string);
806 g_string_free (name_buf, TRUE);
810 icon_size_set_all_from_settings (GtkSettings *settings)
812 GArray *settings_sizes;
813 gchar *icon_size_string;
815 /* Reset old settings */
816 settings_sizes = get_settings_sizes (settings, NULL);
817 g_array_set_size (settings_sizes, 0);
819 g_object_get (settings,
820 "gtk-icon-sizes", &icon_size_string,
823 if (icon_size_string)
825 icon_size_setting_parse (settings, icon_size_string);
826 g_free (icon_size_string);
831 icon_size_settings_changed (GtkSettings *settings,
834 icon_size_set_all_from_settings (settings);
836 gtk_rc_reset_styles (settings);
840 icon_sizes_init_for_settings (GtkSettings *settings)
842 g_signal_connect (settings,
843 "notify::gtk-icon-sizes",
844 G_CALLBACK (icon_size_settings_changed),
847 icon_size_set_all_from_settings (settings);
851 icon_size_lookup_intern (GtkSettings *settings,
856 GArray *settings_sizes;
857 gint width_for_settings = -1;
858 gint height_for_settings = -1;
862 if (size == (GtkIconSize)-1)
865 if (size >= icon_sizes_used)
868 if (size == GTK_ICON_SIZE_INVALID)
873 gboolean initial = FALSE;
875 settings_sizes = get_settings_sizes (settings, &initial);
877 icon_sizes_init_for_settings (settings);
879 if (size < settings_sizes->len)
881 SettingsIconSize *settings_size;
883 settings_size = &g_array_index (settings_sizes, SettingsIconSize, size);
885 width_for_settings = settings_size->width;
886 height_for_settings = settings_size->height;
891 *widthp = width_for_settings >= 0 ? width_for_settings : icon_sizes[size].width;
894 *heightp = height_for_settings >= 0 ? height_for_settings : icon_sizes[size].height;
900 * gtk_icon_size_lookup_for_settings:
901 * @settings: a #GtkSettings object, used to determine
902 * which set of user preferences to used.
903 * @size: an icon size
904 * @width: location to store icon width
905 * @height: location to store icon height
907 * Obtains the pixel size of a semantic icon size, possibly
908 * modified by user preferences for a particular
909 * #GtkSettings. Normally @size would be
910 * #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc. This function
911 * isn't normally needed, gtk_widget_render_icon() is the usual
912 * way to get an icon for rendering, then just look at the size of
913 * the rendered pixbuf. The rendered pixbuf may not even correspond to
914 * the width/height returned by gtk_icon_size_lookup(), because themes
915 * are free to render the pixbuf however they like, including changing
918 * Return value: %TRUE if @size was a valid size
923 gtk_icon_size_lookup_for_settings (GtkSettings *settings,
928 g_return_val_if_fail (GTK_IS_SETTINGS (settings), FALSE);
930 return icon_size_lookup_intern (settings, size, width, height);
934 * gtk_icon_size_lookup:
935 * @size: an icon size
936 * @width: location to store icon width
937 * @height: location to store icon height
939 * Obtains the pixel size of a semantic icon size, possibly
940 * modified by user preferences for the default #GtkSettings.
941 * (See gtk_icon_size_lookup_for_settings().)
942 * Normally @size would be
943 * #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc. This function
944 * isn't normally needed, gtk_widget_render_icon() is the usual
945 * way to get an icon for rendering, then just look at the size of
946 * the rendered pixbuf. The rendered pixbuf may not even correspond to
947 * the width/height returned by gtk_icon_size_lookup(), because themes
948 * are free to render the pixbuf however they like, including changing
951 * Return value: %TRUE if @size was a valid size
954 gtk_icon_size_lookup (GtkIconSize size,
959 g_warning ("gtk_icon_size_lookup ()) is not multihead safe"));
961 return gtk_icon_size_lookup_for_settings (gtk_settings_get_default (),
962 size, widthp, heightp);
966 icon_size_register_intern (const gchar *name,
970 IconAlias *old_alias;
975 old_alias = g_hash_table_lookup (icon_aliases, name);
976 if (old_alias && icon_sizes[old_alias->target].width > 0)
978 g_warning ("Icon size name '%s' already exists", name);
979 return GTK_ICON_SIZE_INVALID;
984 size = old_alias->target;
988 if (icon_sizes_used == icon_sizes_allocated)
990 icon_sizes_allocated *= 2;
991 icon_sizes = g_renew (IconSize, icon_sizes, icon_sizes_allocated);
994 size = icon_sizes_used++;
997 gtk_icon_size_register_alias (name, size);
999 icon_sizes[size].size = size;
1000 icon_sizes[size].name = g_strdup (name);
1003 icon_sizes[size].width = width;
1004 icon_sizes[size].height = height;
1010 * gtk_icon_size_register:
1011 * @name: name of the icon size
1012 * @width: the icon width
1013 * @height: the icon height
1015 * Registers a new icon size, along the same lines as #GTK_ICON_SIZE_MENU,
1016 * etc. Returns the integer value for the size.
1018 * Returns: integer value representing the size
1022 gtk_icon_size_register (const gchar *name,
1026 g_return_val_if_fail (name != NULL, 0);
1027 g_return_val_if_fail (width > 0, 0);
1028 g_return_val_if_fail (height > 0, 0);
1030 return icon_size_register_intern (name, width, height);
1034 * gtk_icon_size_register_alias:
1035 * @alias: an alias for @target
1036 * @target: an existing icon size
1038 * Registers @alias as another name for @target.
1039 * So calling gtk_icon_size_from_name() with @alias as argument
1040 * will return @target.
1044 gtk_icon_size_register_alias (const gchar *alias,
1049 g_return_if_fail (alias != NULL);
1053 if (!icon_size_lookup_intern (NULL, target, NULL, NULL))
1054 g_warning ("gtk_icon_size_register_alias: Icon size %u does not exist", target);
1056 ia = g_hash_table_lookup (icon_aliases, alias);
1059 if (icon_sizes[ia->target].width > 0)
1061 g_warning ("gtk_icon_size_register_alias: Icon size name '%s' already exists", alias);
1065 ia->target = target;
1070 ia = g_new (IconAlias, 1);
1071 ia->name = g_strdup (alias);
1072 ia->target = target;
1074 g_hash_table_insert (icon_aliases, ia->name, ia);
1079 * gtk_icon_size_from_name:
1080 * @name: the name to look up.
1081 * @returns: the icon size with the given name.
1083 * Looks up the icon size associated with @name.
1086 gtk_icon_size_from_name (const gchar *name)
1092 ia = g_hash_table_lookup (icon_aliases, name);
1094 if (ia && icon_sizes[ia->target].width > 0)
1097 return GTK_ICON_SIZE_INVALID;
1101 * gtk_icon_size_get_name:
1102 * @size: a #GtkIconSize.
1103 * @returns: the name of the given icon size.
1105 * Gets the canonical name of the given icon size. The returned string
1106 * is statically allocated and should not be freed.
1108 G_CONST_RETURN gchar*
1109 gtk_icon_size_get_name (GtkIconSize size)
1111 if (size >= icon_sizes_used)
1114 return icon_sizes[size].name;
1117 /************************************************************/
1122 static GdkPixbuf *find_in_cache (GtkIconSet *icon_set,
1124 GtkTextDirection direction,
1127 static void add_to_cache (GtkIconSet *icon_set,
1129 GtkTextDirection direction,
1133 /* Clear icon set contents, drop references to all contained
1134 * GdkPixbuf objects and forget all GtkIconSources. Used to
1135 * recycle an icon set.
1137 static void clear_cache (GtkIconSet *icon_set,
1138 gboolean style_detach);
1139 static GSList* copy_cache (GtkIconSet *icon_set,
1140 GtkIconSet *copy_recipient);
1141 static void attach_to_style (GtkIconSet *icon_set,
1143 static void detach_from_style (GtkIconSet *icon_set,
1145 static void style_dnotify (gpointer data);
1153 /* Cache of the last few rendered versions of the icon. */
1161 static guint cache_serial = 0;
1166 * Creates a new #GtkIconSet. A #GtkIconSet represents a single icon
1167 * in various sizes and widget states. It can provide a #GdkPixbuf
1168 * for a given size and state on request, and automatically caches
1169 * some of the rendered #GdkPixbuf objects.
1171 * Normally you would use gtk_widget_render_icon() instead of
1172 * using #GtkIconSet directly. The one case where you'd use
1173 * #GtkIconSet is to create application-specific icon sets to place in
1174 * a #GtkIconFactory.
1176 * Return value: a new #GtkIconSet
1179 gtk_icon_set_new (void)
1181 GtkIconSet *icon_set;
1183 icon_set = g_new (GtkIconSet, 1);
1185 icon_set->ref_count = 1;
1186 icon_set->sources = NULL;
1187 icon_set->cache = NULL;
1188 icon_set->cache_size = 0;
1189 icon_set->cache_serial = cache_serial;
1195 * gtk_icon_set_new_from_pixbuf:
1196 * @pixbuf: a #GdkPixbuf
1198 * Creates a new #GtkIconSet with @pixbuf as the default/fallback
1199 * source image. If you don't add any additional #GtkIconSource to the
1200 * icon set, all variants of the icon will be created from @pixbuf,
1201 * using scaling, pixelation, etc. as required to adjust the icon size
1202 * or make the icon look insensitive/prelighted.
1204 * Return value: a new #GtkIconSet
1207 gtk_icon_set_new_from_pixbuf (GdkPixbuf *pixbuf)
1211 GtkIconSource source = GTK_ICON_SOURCE_INIT (TRUE, TRUE, TRUE);
1213 g_return_val_if_fail (pixbuf != NULL, NULL);
1215 set = gtk_icon_set_new ();
1217 gtk_icon_source_set_pixbuf (&source, pixbuf);
1218 gtk_icon_set_add_source (set, &source);
1219 gtk_icon_source_set_pixbuf (&source, NULL);
1227 * @icon_set: a #GtkIconSet.
1229 * Increments the reference count on @icon_set.
1231 * Return value: @icon_set.
1234 gtk_icon_set_ref (GtkIconSet *icon_set)
1236 g_return_val_if_fail (icon_set != NULL, NULL);
1237 g_return_val_if_fail (icon_set->ref_count > 0, NULL);
1239 icon_set->ref_count += 1;
1245 * gtk_icon_set_unref:
1246 * @icon_set: a #GtkIconSet
1248 * Decrements the reference count on @icon_set, and frees memory
1249 * if the reference count reaches 0.
1252 gtk_icon_set_unref (GtkIconSet *icon_set)
1254 g_return_if_fail (icon_set != NULL);
1255 g_return_if_fail (icon_set->ref_count > 0);
1257 icon_set->ref_count -= 1;
1259 if (icon_set->ref_count == 0)
1261 GSList *tmp_list = icon_set->sources;
1262 while (tmp_list != NULL)
1264 gtk_icon_source_free (tmp_list->data);
1266 tmp_list = g_slist_next (tmp_list);
1268 g_slist_free (icon_set->sources);
1270 clear_cache (icon_set, TRUE);
1277 gtk_icon_set_get_type (void)
1279 static GType our_type = 0;
1282 our_type = g_boxed_type_register_static (I_("GtkIconSet"),
1283 (GBoxedCopyFunc) gtk_icon_set_ref,
1284 (GBoxedFreeFunc) gtk_icon_set_unref);
1290 * gtk_icon_set_copy:
1291 * @icon_set: a #GtkIconSet
1293 * Copies @icon_set by value.
1295 * Return value: a new #GtkIconSet identical to the first.
1298 gtk_icon_set_copy (GtkIconSet *icon_set)
1303 copy = gtk_icon_set_new ();
1305 tmp_list = icon_set->sources;
1306 while (tmp_list != NULL)
1308 copy->sources = g_slist_prepend (copy->sources,
1309 gtk_icon_source_copy (tmp_list->data));
1311 tmp_list = g_slist_next (tmp_list);
1314 copy->sources = g_slist_reverse (copy->sources);
1316 copy->cache = copy_cache (icon_set, copy);
1317 copy->cache_size = icon_set->cache_size;
1318 copy->cache_serial = icon_set->cache_serial;
1324 sizes_equivalent (GtkIconSize lhs,
1327 /* We used to consider sizes equivalent if they were
1328 * the same pixel size, but we don't have the GtkSettings
1329 * here, so we can't do that. Plus, it's not clear that
1330 * it is right... it was just a workaround for the fact
1331 * that we register icons by logical size, not pixel size.
1337 gint r_w, r_h, l_w, l_h;
1339 icon_size_lookup_intern (NULL, rhs, &r_w, &r_h);
1340 icon_size_lookup_intern (NULL, lhs, &l_w, &l_h);
1342 return r_w == l_w && r_h == l_h;
1346 static GtkIconSource *
1347 find_best_matching_source (GtkIconSet *icon_set,
1348 GtkTextDirection direction,
1353 GtkIconSource *source;
1356 /* We need to find the best icon source. Direction matters more
1357 * than state, state matters more than size. icon_set->sources
1358 * is sorted according to wildness, so if we take the first
1359 * match we find it will be the least-wild match (if there are
1360 * multiple matches for a given "wildness" then the RC file contained
1361 * dumb stuff, and we end up with an arbitrary matching source)
1365 tmp_list = icon_set->sources;
1366 while (tmp_list != NULL)
1368 GtkIconSource *s = tmp_list->data;
1370 if ((s->any_direction || (s->direction == direction)) &&
1371 (s->any_state || (s->state == state)) &&
1372 (s->any_size || size == (GtkIconSize)-1 || (sizes_equivalent (size, s->size))))
1374 if (!g_slist_find (failed, s))
1381 tmp_list = g_slist_next (tmp_list);
1388 ensure_filename_pixbuf (GtkIconSet *icon_set,
1389 GtkIconSource *source)
1391 if (source->filename_pixbuf == NULL)
1393 GError *error = NULL;
1395 source->filename_pixbuf = gdk_pixbuf_new_from_file (source->source.filename, &error);
1397 if (source->filename_pixbuf == NULL)
1399 /* Remove this icon source so we don't keep trying to
1402 g_warning (_("Error loading icon: %s"), error->message);
1403 g_error_free (error);
1405 icon_set->sources = g_slist_remove (icon_set->sources, source);
1407 gtk_icon_source_free (source);
1417 render_icon_name_pixbuf (GtkIconSource *icon_source,
1419 GtkTextDirection direction,
1426 GdkPixbuf *tmp_pixbuf;
1427 GtkIconSource tmp_source;
1429 GtkIconTheme *icon_theme;
1430 GtkSettings *settings;
1431 gint width, height, pixel_size;
1432 gint *sizes, *s, dist;
1433 GError *error = NULL;
1435 if (widget && gtk_widget_has_screen (widget))
1436 screen = gtk_widget_get_screen (widget);
1437 else if (style && style->colormap)
1438 screen = gdk_colormap_get_screen (style->colormap);
1441 screen = gdk_screen_get_default ();
1442 GTK_NOTE (MULTIHEAD,
1443 g_warning ("Using the default screen for gtk_icon_source_render_icon()"));
1446 icon_theme = gtk_icon_theme_get_for_screen (screen);
1447 settings = gtk_settings_get_for_screen (screen);
1449 if (!gtk_icon_size_lookup_for_settings (settings, size, &width, &height))
1451 if (size == (GtkIconSize)-1)
1453 /* Find an available size close to 48
1455 sizes = gtk_icon_theme_get_icon_sizes (icon_theme, icon_source->source.icon_name);
1457 width = height = 48;
1458 for (s = sizes; *s; s++)
1462 width = height = 48;
1469 width = height = *s;
1477 width = height = *s;
1487 g_warning ("Invalid icon size %u\n", size);
1488 width = height = 24;
1492 pixel_size = MIN (width, height);
1494 tmp_pixbuf = gtk_icon_theme_load_icon (icon_theme,
1495 icon_source->source.icon_name,
1501 g_warning ("Error loading theme icon '%s' for stock: %s",
1502 icon_source->source.icon_name, error->message);
1503 g_error_free (error);
1507 tmp_source = *icon_source;
1508 tmp_source.type = GTK_ICON_SOURCE_PIXBUF;
1509 tmp_source.source.pixbuf = tmp_pixbuf;
1511 pixbuf = gtk_style_render_icon (style, &tmp_source,
1512 direction, state, -1,
1516 g_warning ("Failed to render icon");
1518 g_object_unref (tmp_pixbuf);
1524 find_and_render_icon_source (GtkIconSet *icon_set,
1526 GtkTextDirection direction,
1532 GSList *failed = NULL;
1533 GdkPixbuf *pixbuf = NULL;
1535 /* We treat failure in two different ways:
1537 * A) If loading a source that specifies a filename fails,
1538 * we treat that as permanent, and remove the source
1539 * from the GtkIconSet. (in ensure_filename_pixbuf ()
1540 * B) If loading a themed icon fails, or scaling an icon
1541 * fails, we treat that as transient and will try
1542 * again next time the icon falls out of the cache
1543 * and we need to recreate it.
1545 while (pixbuf == NULL)
1547 GtkIconSource *source = find_best_matching_source (icon_set, direction, state, size, failed);
1552 switch (source->type)
1554 case GTK_ICON_SOURCE_FILENAME:
1555 if (!ensure_filename_pixbuf (icon_set, source))
1558 case GTK_ICON_SOURCE_PIXBUF:
1559 pixbuf = gtk_style_render_icon (style, source,
1560 direction, state, size,
1564 g_warning ("Failed to render icon");
1565 failed = g_slist_prepend (failed, source);
1568 case GTK_ICON_SOURCE_ICON_NAME:
1569 case GTK_ICON_SOURCE_STATIC_ICON_NAME:
1570 pixbuf = render_icon_name_pixbuf (source, style,
1571 direction, state, size,
1574 failed = g_slist_prepend (failed, source);
1576 case GTK_ICON_SOURCE_EMPTY:
1577 g_assert_not_reached ();
1581 g_slist_free (failed);
1586 extern GtkIconCache *_builtin_cache;
1589 render_fallback_image (GtkStyle *style,
1590 GtkTextDirection direction,
1596 /* This icon can be used for any direction/state/size */
1597 static GtkIconSource fallback_source = GTK_ICON_SOURCE_INIT (TRUE, TRUE, TRUE);
1599 if (fallback_source.type == GTK_ICON_SOURCE_EMPTY)
1604 _gtk_icon_theme_ensure_builtin_cache ();
1606 index = _gtk_icon_cache_get_directory_index (_builtin_cache, "24");
1607 pixbuf = _gtk_icon_cache_get_icon (_builtin_cache,
1608 GTK_STOCK_MISSING_IMAGE,
1610 gtk_icon_source_set_pixbuf (&fallback_source, pixbuf);
1611 g_object_unref (pixbuf);
1614 return gtk_style_render_icon (style,
1624 * gtk_icon_set_render_icon:
1625 * @icon_set: a #GtkIconSet
1626 * @style: a #GtkStyle associated with @widget, or %NULL
1627 * @direction: text direction
1628 * @state: widget state
1629 * @size: icon size. A size of (GtkIconSize)-1
1630 * means render at the size of the source and don't scale.
1631 * @widget: widget that will display the icon, or %NULL.
1632 * The only use that is typically made of this
1633 * is to determine the appropriate #GdkScreen.
1634 * @detail: detail to pass to the theme engine, or %NULL.
1635 * Note that passing a detail of anything but %NULL
1636 * will disable caching.
1638 * Renders an icon using gtk_style_render_icon(). In most cases,
1639 * gtk_widget_render_icon() is better, since it automatically provides
1640 * most of the arguments from the current widget settings. This
1641 * function never returns %NULL; if the icon can't be rendered
1642 * (perhaps because an image file fails to load), a default "missing
1643 * image" icon will be returned instead.
1645 * Return value: a #GdkPixbuf to be displayed
1648 gtk_icon_set_render_icon (GtkIconSet *icon_set,
1650 GtkTextDirection direction,
1658 g_return_val_if_fail (icon_set != NULL, NULL);
1659 g_return_val_if_fail (style == NULL || GTK_IS_STYLE (style), NULL);
1661 if (icon_set->sources == NULL)
1662 return render_fallback_image (style, direction, state, size, widget, detail);
1666 icon = find_in_cache (icon_set, style, direction,
1671 g_object_ref (icon);
1677 icon = find_and_render_icon_source (icon_set, style, direction, state, size,
1681 icon = render_fallback_image (style, direction, state, size, widget, detail);
1684 add_to_cache (icon_set, style, direction, state, size, icon);
1689 /* Order sources by their "wildness", so that "wilder" sources are
1690 * greater than "specific" sources; for determining ordering,
1691 * direction beats state beats size.
1695 icon_source_compare (gconstpointer ap, gconstpointer bp)
1697 const GtkIconSource *a = ap;
1698 const GtkIconSource *b = bp;
1700 if (!a->any_direction && b->any_direction)
1702 else if (a->any_direction && !b->any_direction)
1704 else if (!a->any_state && b->any_state)
1706 else if (a->any_state && !b->any_state)
1708 else if (!a->any_size && b->any_size)
1710 else if (a->any_size && !b->any_size)
1717 * gtk_icon_set_add_source:
1718 * @icon_set: a #GtkIconSet
1719 * @source: a #GtkIconSource
1721 * Icon sets have a list of #GtkIconSource, which they use as base
1722 * icons for rendering icons in different states and sizes. Icons are
1723 * scaled, made to look insensitive, etc. in
1724 * gtk_icon_set_render_icon(), but #GtkIconSet needs base images to
1725 * work with. The base images and when to use them are described by
1728 * This function copies @source, so you can reuse the same source immediately
1729 * without affecting the icon set.
1731 * An example of when you'd use this function: a web browser's "Back
1732 * to Previous Page" icon might point in a different direction in
1733 * Hebrew and in English; it might look different when insensitive;
1734 * and it might change size depending on toolbar mode (small/large
1735 * icons). So a single icon set would contain all those variants of
1736 * the icon, and you might add a separate source for each one.
1738 * You should nearly always add a "default" icon source with all
1739 * fields wildcarded, which will be used as a fallback if no more
1740 * specific source matches. #GtkIconSet always prefers more specific
1741 * icon sources to more generic icon sources. The order in which you
1742 * add the sources to the icon set does not matter.
1744 * gtk_icon_set_new_from_pixbuf() creates a new icon set with a
1745 * default icon source based on the given pixbuf.
1749 gtk_icon_set_add_source (GtkIconSet *icon_set,
1750 const GtkIconSource *source)
1752 g_return_if_fail (icon_set != NULL);
1753 g_return_if_fail (source != NULL);
1755 if (source->type == GTK_ICON_SOURCE_EMPTY)
1757 g_warning ("Useless empty GtkIconSource");
1761 icon_set->sources = g_slist_insert_sorted (icon_set->sources,
1762 gtk_icon_source_copy (source),
1763 icon_source_compare);
1767 * gtk_icon_set_get_sizes:
1768 * @icon_set: a #GtkIconSet
1769 * @sizes: return location for array of sizes
1770 * @n_sizes: location to store number of elements in returned array
1772 * Obtains a list of icon sizes this icon set can render. The returned
1773 * array must be freed with g_free().
1777 gtk_icon_set_get_sizes (GtkIconSet *icon_set,
1778 GtkIconSize **sizes,
1782 gboolean all_sizes = FALSE;
1783 GSList *specifics = NULL;
1785 g_return_if_fail (icon_set != NULL);
1786 g_return_if_fail (sizes != NULL);
1787 g_return_if_fail (n_sizes != NULL);
1789 tmp_list = icon_set->sources;
1790 while (tmp_list != NULL)
1792 GtkIconSource *source;
1794 source = tmp_list->data;
1796 if (source->any_size)
1802 specifics = g_slist_prepend (specifics, GINT_TO_POINTER (source->size));
1804 tmp_list = g_slist_next (tmp_list);
1809 /* Need to find out what sizes exist */
1814 *sizes = g_new (GtkIconSize, icon_sizes_used);
1815 *n_sizes = icon_sizes_used - 1;
1818 while (i < icon_sizes_used)
1820 (*sizes)[i - 1] = icon_sizes[i].size;
1828 *n_sizes = g_slist_length (specifics);
1829 *sizes = g_new (GtkIconSize, *n_sizes);
1832 tmp_list = specifics;
1833 while (tmp_list != NULL)
1835 (*sizes)[i] = GPOINTER_TO_INT (tmp_list->data);
1838 tmp_list = g_slist_next (tmp_list);
1842 g_slist_free (specifics);
1847 * gtk_icon_source_new:
1849 * Creates a new #GtkIconSource. A #GtkIconSource contains a #GdkPixbuf (or
1850 * image filename) that serves as the base image for one or more of the
1851 * icons in a #GtkIconSet, along with a specification for which icons in the
1852 * icon set will be based on that pixbuf or image file. An icon set contains
1853 * a set of icons that represent "the same" logical concept in different states,
1854 * different global text directions, and different sizes.
1856 * So for example a web browser's "Back to Previous Page" icon might
1857 * point in a different direction in Hebrew and in English; it might
1858 * look different when insensitive; and it might change size depending
1859 * on toolbar mode (small/large icons). So a single icon set would
1860 * contain all those variants of the icon. #GtkIconSet contains a list
1861 * of #GtkIconSource from which it can derive specific icon variants in
1864 * In the simplest case, #GtkIconSet contains one source pixbuf from
1865 * which it derives all variants. The convenience function
1866 * gtk_icon_set_new_from_pixbuf() handles this case; if you only have
1867 * one source pixbuf, just use that function.
1869 * If you want to use a different base pixbuf for different icon
1870 * variants, you create multiple icon sources, mark which variants
1871 * they'll be used to create, and add them to the icon set with
1872 * gtk_icon_set_add_source().
1874 * By default, the icon source has all parameters wildcarded. That is,
1875 * the icon source will be used as the base icon for any desired text
1876 * direction, widget state, or icon size.
1878 * Return value: a new #GtkIconSource
1881 gtk_icon_source_new (void)
1885 src = g_new0 (GtkIconSource, 1);
1887 src->direction = GTK_TEXT_DIR_NONE;
1888 src->size = GTK_ICON_SIZE_INVALID;
1889 src->state = GTK_STATE_NORMAL;
1891 src->any_direction = TRUE;
1892 src->any_state = TRUE;
1893 src->any_size = TRUE;
1899 * gtk_icon_source_copy:
1900 * @source: a #GtkIconSource
1902 * Creates a copy of @source; mostly useful for language bindings.
1904 * Return value: a new #GtkIconSource
1907 gtk_icon_source_copy (const GtkIconSource *source)
1909 GtkIconSource *copy;
1911 g_return_val_if_fail (source != NULL, NULL);
1913 copy = g_new (GtkIconSource, 1);
1919 case GTK_ICON_SOURCE_EMPTY:
1920 case GTK_ICON_SOURCE_STATIC_ICON_NAME:
1922 case GTK_ICON_SOURCE_ICON_NAME:
1923 copy->source.icon_name = g_strdup (copy->source.icon_name);
1925 case GTK_ICON_SOURCE_FILENAME:
1926 copy->source.filename = g_strdup (copy->source.filename);
1928 copy->cp_filename = g_strdup (copy->cp_filename);
1930 if (copy->filename_pixbuf)
1931 g_object_ref (copy->filename_pixbuf);
1933 case GTK_ICON_SOURCE_PIXBUF:
1934 g_object_ref (copy->source.pixbuf);
1937 g_assert_not_reached();
1944 * gtk_icon_source_free:
1945 * @source: a #GtkIconSource
1947 * Frees a dynamically-allocated icon source, along with its
1948 * filename, size, and pixbuf fields if those are not %NULL.
1951 gtk_icon_source_free (GtkIconSource *source)
1953 g_return_if_fail (source != NULL);
1955 icon_source_clear (source);
1960 gtk_icon_source_get_type (void)
1962 static GType our_type = 0;
1965 our_type = g_boxed_type_register_static (I_("GtkIconSource"),
1966 (GBoxedCopyFunc) gtk_icon_source_copy,
1967 (GBoxedFreeFunc) gtk_icon_source_free);
1973 icon_source_clear (GtkIconSource *source)
1975 switch (source->type)
1977 case GTK_ICON_SOURCE_EMPTY:
1979 case GTK_ICON_SOURCE_ICON_NAME:
1980 g_free (source->source.icon_name);
1982 case GTK_ICON_SOURCE_STATIC_ICON_NAME:
1983 source->source.icon_name = NULL;
1985 case GTK_ICON_SOURCE_FILENAME:
1986 g_free (source->source.filename);
1987 source->source.filename = NULL;
1989 g_free (source->cp_filename);
1990 source->cp_filename = NULL;
1992 if (source->filename_pixbuf)
1993 g_object_unref (source->filename_pixbuf);
1994 source->filename_pixbuf = NULL;
1996 case GTK_ICON_SOURCE_PIXBUF:
1997 g_object_unref (source->source.pixbuf);
1998 source->source.pixbuf = NULL;
2001 g_assert_not_reached();
2004 source->type = GTK_ICON_SOURCE_EMPTY;
2008 * gtk_icon_source_set_filename:
2009 * @source: a #GtkIconSource
2010 * @filename: image file to use
2012 * Sets the name of an image file to use as a base image when creating
2013 * icon variants for #GtkIconSet. The filename must be absolute.
2016 gtk_icon_source_set_filename (GtkIconSource *source,
2017 const gchar *filename)
2019 g_return_if_fail (source != NULL);
2020 g_return_if_fail (filename == NULL || g_path_is_absolute (filename));
2022 if (source->type == GTK_ICON_SOURCE_FILENAME &&
2023 source->source.filename == filename)
2026 icon_source_clear (source);
2028 if (filename != NULL)
2030 source->type = GTK_ICON_SOURCE_FILENAME;
2031 source->source.filename = g_strdup (filename);
2033 source->cp_filename = g_locale_from_utf8 (filename, -1, NULL, NULL, NULL);
2039 * gtk_icon_source_set_icon_name
2040 * @source: a #GtkIconSource
2041 * @icon_name: name of icon to use
2043 * Sets the name of an icon to look up in the current icon theme
2044 * to use as a base image when creating icon variants for #GtkIconSet.
2047 gtk_icon_source_set_icon_name (GtkIconSource *source,
2048 const gchar *icon_name)
2050 g_return_if_fail (source != NULL);
2052 if (source->type == GTK_ICON_SOURCE_ICON_NAME &&
2053 source->source.icon_name == icon_name)
2056 icon_source_clear (source);
2058 if (icon_name != NULL)
2060 source->type = GTK_ICON_SOURCE_ICON_NAME;
2061 source->source.icon_name = g_strdup (icon_name);
2066 * gtk_icon_source_set_pixbuf:
2067 * @source: a #GtkIconSource
2068 * @pixbuf: pixbuf to use as a source
2070 * Sets a pixbuf to use as a base image when creating icon variants
2074 gtk_icon_source_set_pixbuf (GtkIconSource *source,
2077 g_return_if_fail (source != NULL);
2078 g_return_if_fail (pixbuf == NULL || GDK_IS_PIXBUF (pixbuf));
2080 if (source->type == GTK_ICON_SOURCE_PIXBUF &&
2081 source->source.pixbuf == pixbuf)
2084 icon_source_clear (source);
2088 source->type = GTK_ICON_SOURCE_PIXBUF;
2089 source->source.pixbuf = g_object_ref (pixbuf);
2094 * gtk_icon_source_get_filename:
2095 * @source: a #GtkIconSource
2097 * Retrieves the source filename, or %NULL if none is set. The
2098 * filename is not a copy, and should not be modified or expected to
2099 * persist beyond the lifetime of the icon source.
2101 * Return value: image filename. This string must not be modified
2104 G_CONST_RETURN gchar*
2105 gtk_icon_source_get_filename (const GtkIconSource *source)
2107 g_return_val_if_fail (source != NULL, NULL);
2109 if (source->type == GTK_ICON_SOURCE_FILENAME)
2110 return source->source.filename;
2116 * gtk_icon_source_get_icon_name:
2117 * @source: a #GtkIconSource
2119 * Retrieves the source icon name, or %NULL if none is set. The
2120 * icon_name is not a copy, and should not be modified or expected to
2121 * persist beyond the lifetime of the icon source.
2123 * Return value: icon name. This string must not be modified or freed.
2125 G_CONST_RETURN gchar*
2126 gtk_icon_source_get_icon_name (const GtkIconSource *source)
2128 g_return_val_if_fail (source != NULL, NULL);
2130 if (source->type == GTK_ICON_SOURCE_ICON_NAME ||
2131 source->type == GTK_ICON_SOURCE_STATIC_ICON_NAME)
2132 return source->source.icon_name;
2138 * gtk_icon_source_get_pixbuf:
2139 * @source: a #GtkIconSource
2141 * Retrieves the source pixbuf, or %NULL if none is set.
2142 * In addition, if a filename source is in use, this
2143 * function in some cases will return the pixbuf from
2144 * loaded from the filename. This is, for example, true
2145 * for the GtkIconSource passed to the GtkStyle::render_icon()
2146 * virtual function. The reference count on the pixbuf is
2149 * Return value: source pixbuf
2152 gtk_icon_source_get_pixbuf (const GtkIconSource *source)
2154 g_return_val_if_fail (source != NULL, NULL);
2156 if (source->type == GTK_ICON_SOURCE_PIXBUF)
2157 return source->source.pixbuf;
2158 else if (source->type == GTK_ICON_SOURCE_FILENAME)
2159 return source->filename_pixbuf;
2165 * gtk_icon_source_set_direction_wildcarded:
2166 * @source: a #GtkIconSource
2167 * @setting: %TRUE to wildcard the text direction
2169 * If the text direction is wildcarded, this source can be used
2170 * as the base image for an icon in any #GtkTextDirection.
2171 * If the text direction is not wildcarded, then the
2172 * text direction the icon source applies to should be set
2173 * with gtk_icon_source_set_direction(), and the icon source
2174 * will only be used with that text direction.
2176 * #GtkIconSet prefers non-wildcarded sources (exact matches) over
2177 * wildcarded sources, and will use an exact match when possible.
2181 gtk_icon_source_set_direction_wildcarded (GtkIconSource *source,
2184 g_return_if_fail (source != NULL);
2186 source->any_direction = setting != FALSE;
2190 * gtk_icon_source_set_state_wildcarded:
2191 * @source: a #GtkIconSource
2192 * @setting: %TRUE to wildcard the widget state
2194 * If the widget state is wildcarded, this source can be used as the
2195 * base image for an icon in any #GtkStateType. If the widget state
2196 * is not wildcarded, then the state the source applies to should be
2197 * set with gtk_icon_source_set_state() and the icon source will
2198 * only be used with that specific state.
2200 * #GtkIconSet prefers non-wildcarded sources (exact matches) over
2201 * wildcarded sources, and will use an exact match when possible.
2203 * #GtkIconSet will normally transform wildcarded source images to
2204 * produce an appropriate icon for a given state, for example
2205 * lightening an image on prelight, but will not modify source images
2206 * that match exactly.
2209 gtk_icon_source_set_state_wildcarded (GtkIconSource *source,
2212 g_return_if_fail (source != NULL);
2214 source->any_state = setting != FALSE;
2219 * gtk_icon_source_set_size_wildcarded:
2220 * @source: a #GtkIconSource
2221 * @setting: %TRUE to wildcard the widget state
2223 * If the icon size is wildcarded, this source can be used as the base
2224 * image for an icon of any size. If the size is not wildcarded, then
2225 * the size the source applies to should be set with
2226 * gtk_icon_source_set_size() and the icon source will only be used
2227 * with that specific size.
2229 * #GtkIconSet prefers non-wildcarded sources (exact matches) over
2230 * wildcarded sources, and will use an exact match when possible.
2232 * #GtkIconSet will normally scale wildcarded source images to produce
2233 * an appropriate icon at a given size, but will not change the size
2234 * of source images that match exactly.
2237 gtk_icon_source_set_size_wildcarded (GtkIconSource *source,
2240 g_return_if_fail (source != NULL);
2242 source->any_size = setting != FALSE;
2246 * gtk_icon_source_get_size_wildcarded:
2247 * @source: a #GtkIconSource
2249 * Gets the value set by gtk_icon_source_set_size_wildcarded().
2251 * Return value: %TRUE if this icon source is a base for any icon size variant
2254 gtk_icon_source_get_size_wildcarded (const GtkIconSource *source)
2256 g_return_val_if_fail (source != NULL, TRUE);
2258 return source->any_size;
2262 * gtk_icon_source_get_state_wildcarded:
2263 * @source: a #GtkIconSource
2265 * Gets the value set by gtk_icon_source_set_state_wildcarded().
2267 * Return value: %TRUE if this icon source is a base for any widget state variant
2270 gtk_icon_source_get_state_wildcarded (const GtkIconSource *source)
2272 g_return_val_if_fail (source != NULL, TRUE);
2274 return source->any_state;
2278 * gtk_icon_source_get_direction_wildcarded:
2279 * @source: a #GtkIconSource
2281 * Gets the value set by gtk_icon_source_set_direction_wildcarded().
2283 * Return value: %TRUE if this icon source is a base for any text direction variant
2286 gtk_icon_source_get_direction_wildcarded (const GtkIconSource *source)
2288 g_return_val_if_fail (source != NULL, TRUE);
2290 return source->any_direction;
2294 * gtk_icon_source_set_direction:
2295 * @source: a #GtkIconSource
2296 * @direction: text direction this source applies to
2298 * Sets the text direction this icon source is intended to be used
2301 * Setting the text direction on an icon source makes no difference
2302 * if the text direction is wildcarded. Therefore, you should usually
2303 * call gtk_icon_source_set_direction_wildcarded() to un-wildcard it
2304 * in addition to calling this function.
2308 gtk_icon_source_set_direction (GtkIconSource *source,
2309 GtkTextDirection direction)
2311 g_return_if_fail (source != NULL);
2313 source->direction = direction;
2317 * gtk_icon_source_set_state:
2318 * @source: a #GtkIconSource
2319 * @state: widget state this source applies to
2321 * Sets the widget state this icon source is intended to be used
2324 * Setting the widget state on an icon source makes no difference
2325 * if the state is wildcarded. Therefore, you should usually
2326 * call gtk_icon_source_set_state_wildcarded() to un-wildcard it
2327 * in addition to calling this function.
2331 gtk_icon_source_set_state (GtkIconSource *source,
2334 g_return_if_fail (source != NULL);
2336 source->state = state;
2340 * gtk_icon_source_set_size:
2341 * @source: a #GtkIconSource
2342 * @size: icon size this source applies to
2344 * Sets the icon size this icon source is intended to be used
2347 * Setting the icon size on an icon source makes no difference
2348 * if the size is wildcarded. Therefore, you should usually
2349 * call gtk_icon_source_set_size_wildcarded() to un-wildcard it
2350 * in addition to calling this function.
2354 gtk_icon_source_set_size (GtkIconSource *source,
2357 g_return_if_fail (source != NULL);
2359 source->size = size;
2363 * gtk_icon_source_get_direction:
2364 * @source: a #GtkIconSource
2366 * Obtains the text direction this icon source applies to. The return
2367 * value is only useful/meaningful if the text direction is <emphasis>not</emphasis>
2370 * Return value: text direction this source matches
2373 gtk_icon_source_get_direction (const GtkIconSource *source)
2375 g_return_val_if_fail (source != NULL, 0);
2377 return source->direction;
2381 * gtk_icon_source_get_state:
2382 * @source: a #GtkIconSource
2384 * Obtains the widget state this icon source applies to. The return
2385 * value is only useful/meaningful if the widget state is <emphasis>not</emphasis>
2388 * Return value: widget state this source matches
2391 gtk_icon_source_get_state (const GtkIconSource *source)
2393 g_return_val_if_fail (source != NULL, 0);
2395 return source->state;
2399 * gtk_icon_source_get_size:
2400 * @source: a #GtkIconSource
2402 * Obtains the icon size this source applies to. The return value
2403 * is only useful/meaningful if the icon size is <emphasis>not</emphasis> wildcarded.
2405 * Return value: icon size this source matches.
2408 gtk_icon_source_get_size (const GtkIconSource *source)
2410 g_return_val_if_fail (source != NULL, 0);
2412 return source->size;
2415 #define NUM_CACHED_ICONS 8
2417 typedef struct _CachedIcon CachedIcon;
2421 /* These must all match to use the cached pixbuf.
2422 * If any don't match, we must re-render the pixbuf.
2425 GtkTextDirection direction;
2433 ensure_cache_up_to_date (GtkIconSet *icon_set)
2435 if (icon_set->cache_serial != cache_serial)
2437 clear_cache (icon_set, TRUE);
2438 icon_set->cache_serial = cache_serial;
2443 cached_icon_free (CachedIcon *icon)
2445 g_object_unref (icon->pixbuf);
2448 g_object_unref (icon->style);
2454 find_in_cache (GtkIconSet *icon_set,
2456 GtkTextDirection direction,
2463 ensure_cache_up_to_date (icon_set);
2466 tmp_list = icon_set->cache;
2467 while (tmp_list != NULL)
2469 CachedIcon *icon = tmp_list->data;
2471 if (icon->style == style &&
2472 icon->direction == direction &&
2473 icon->state == state &&
2474 (size == (GtkIconSize)-1 || icon->size == size))
2478 /* Move this icon to the front of the list. */
2479 prev->next = tmp_list->next;
2480 tmp_list->next = icon_set->cache;
2481 icon_set->cache = tmp_list;
2484 return icon->pixbuf;
2488 tmp_list = g_slist_next (tmp_list);
2495 add_to_cache (GtkIconSet *icon_set,
2497 GtkTextDirection direction,
2504 ensure_cache_up_to_date (icon_set);
2506 g_object_ref (pixbuf);
2508 /* We have to ref the style, since if the style was finalized
2509 * its address could be reused by another style, creating a
2514 g_object_ref (style);
2516 icon = g_new (CachedIcon, 1);
2517 icon_set->cache = g_slist_prepend (icon_set->cache, icon);
2518 icon_set->cache_size++;
2520 icon->style = style;
2521 icon->direction = direction;
2522 icon->state = state;
2524 icon->pixbuf = pixbuf;
2527 attach_to_style (icon_set, icon->style);
2529 if (icon_set->cache_size >= NUM_CACHED_ICONS)
2531 /* Remove oldest item in the cache */
2534 tmp_list = icon_set->cache;
2536 /* Find next-to-last link */
2537 g_assert (NUM_CACHED_ICONS > 2);
2538 while (tmp_list->next->next)
2539 tmp_list = tmp_list->next;
2541 g_assert (tmp_list != NULL);
2542 g_assert (tmp_list->next != NULL);
2543 g_assert (tmp_list->next->next == NULL);
2545 /* Free the last icon */
2546 icon = tmp_list->next->data;
2548 g_slist_free (tmp_list->next);
2549 tmp_list->next = NULL;
2551 cached_icon_free (icon);
2556 clear_cache (GtkIconSet *icon_set,
2557 gboolean style_detach)
2559 GSList *cache, *tmp_list;
2560 GtkStyle *last_style = NULL;
2562 cache = icon_set->cache;
2563 icon_set->cache = NULL;
2564 icon_set->cache_size = 0;
2566 while (tmp_list != NULL)
2568 CachedIcon *icon = tmp_list->data;
2572 /* simple optimization for the case where the cache
2573 * contains contiguous icons from the same style.
2574 * it's safe to call detach_from_style more than
2575 * once on the same style though.
2577 if (last_style != icon->style)
2579 detach_from_style (icon_set, icon->style);
2580 last_style = icon->style;
2584 cached_icon_free (icon);
2586 tmp_list = g_slist_next (tmp_list);
2589 g_slist_free (cache);
2593 copy_cache (GtkIconSet *icon_set,
2594 GtkIconSet *copy_recipient)
2597 GSList *copy = NULL;
2599 ensure_cache_up_to_date (icon_set);
2601 tmp_list = icon_set->cache;
2602 while (tmp_list != NULL)
2604 CachedIcon *icon = tmp_list->data;
2605 CachedIcon *icon_copy = g_new (CachedIcon, 1);
2609 if (icon_copy->style)
2611 attach_to_style (copy_recipient, icon_copy->style);
2612 g_object_ref (icon_copy->style);
2615 g_object_ref (icon_copy->pixbuf);
2617 icon_copy->size = icon->size;
2619 copy = g_slist_prepend (copy, icon_copy);
2621 tmp_list = g_slist_next (tmp_list);
2624 return g_slist_reverse (copy);
2628 attach_to_style (GtkIconSet *icon_set,
2633 table = g_object_get_qdata (G_OBJECT (style),
2634 g_quark_try_string ("gtk-style-icon-sets"));
2638 table = g_hash_table_new (NULL, NULL);
2639 g_object_set_qdata_full (G_OBJECT (style),
2640 g_quark_from_static_string ("gtk-style-icon-sets"),
2645 g_hash_table_insert (table, icon_set, icon_set);
2649 detach_from_style (GtkIconSet *icon_set,
2654 table = g_object_get_qdata (G_OBJECT (style),
2655 g_quark_try_string ("gtk-style-icon-sets"));
2658 g_hash_table_remove (table, icon_set);
2662 iconsets_foreach (gpointer key,
2666 GtkIconSet *icon_set = key;
2668 /* We only need to remove cache entries for the given style;
2669 * but that complicates things because in destroy notify
2670 * we don't know which style got destroyed, and 95% of the
2671 * time all cache entries will have the same style,
2672 * so this is faster anyway.
2675 clear_cache (icon_set, FALSE);
2679 style_dnotify (gpointer data)
2681 GHashTable *table = data;
2683 g_hash_table_foreach (table, iconsets_foreach, NULL);
2685 g_hash_table_destroy (table);
2688 /* This allows the icon set to detect that its cache is out of date. */
2690 _gtk_icon_set_invalidate_caches (void)
2696 * _gtk_icon_factory_list_ids:
2698 * Gets all known IDs stored in an existing icon factory.
2699 * The strings in the returned list aren't copied.
2700 * The list itself should be freed.
2702 * Return value: List of ids in icon factories
2705 _gtk_icon_factory_list_ids (void)
2712 _gtk_icon_factory_ensure_default_icons ();
2714 tmp_list = all_icon_factories;
2715 while (tmp_list != NULL)
2719 GtkIconFactory *factory = GTK_ICON_FACTORY (tmp_list->data);
2721 these_ids = g_hash_table_get_keys (factory->icons);
2723 ids = g_list_concat (ids, these_ids);
2725 tmp_list = g_slist_next (tmp_list);
2735 } IconFactoryParserData;
2741 GtkTextDirection direction;
2744 } IconSourceParserData;
2747 icon_source_start_element (GMarkupParseContext *context,
2748 const gchar *element_name,
2749 const gchar **names,
2750 const gchar **values,
2755 gchar *stock_id = NULL;
2756 gchar *filename = NULL;
2757 gchar *icon_name = NULL;
2759 gint direction = -1;
2761 IconFactoryParserData *parser_data;
2762 IconSourceParserData *source_data;
2764 GQuark error_domain;
2766 parser_data = (IconFactoryParserData*)user_data;
2768 if (!parser_data->in_source)
2770 if (strcmp (element_name, "sources") != 0)
2772 error_msg = g_strdup_printf ("Unexpected element %s, expected <sources>", element_name);
2773 error_domain = GTK_BUILDER_ERROR_INVALID_TAG;
2776 parser_data->in_source = TRUE;
2781 if (strcmp (element_name, "source") != 0)
2783 error_msg = g_strdup_printf ("Unexpected element %s, expected <source>", element_name);
2784 error_domain = GTK_BUILDER_ERROR_INVALID_TAG;
2789 for (i = 0; names[i]; i++)
2791 if (strcmp (names[i], "stock-id") == 0)
2792 stock_id = g_strdup (values[i]);
2793 else if (strcmp (names[i], "filename") == 0)
2794 filename = g_strdup (values[i]);
2795 else if (strcmp (names[i], "icon-name") == 0)
2796 icon_name = g_strdup (values[i]);
2797 else if (strcmp (names[i], "size") == 0)
2799 if (!_gtk_builder_enum_from_string (GTK_TYPE_ICON_SIZE,
2805 else if (strcmp (names[i], "direction") == 0)
2807 if (!_gtk_builder_enum_from_string (GTK_TYPE_TEXT_DIRECTION,
2813 else if (strcmp (names[i], "state") == 0)
2815 if (!_gtk_builder_enum_from_string (GTK_TYPE_STATE_TYPE,
2823 error_msg = g_strdup_printf ("'%s' is not a valid attribute of <%s>",
2824 names[i], "source");
2825 error_domain = GTK_BUILDER_ERROR_INVALID_ATTRIBUTE;
2832 error_msg = g_strdup_printf ("<source> requires a stock_id");
2833 error_domain = GTK_BUILDER_ERROR_MISSING_ATTRIBUTE;
2837 source_data = g_slice_new (IconSourceParserData);
2838 source_data->stock_id = stock_id;
2839 source_data->filename = filename;
2840 source_data->icon_name = icon_name;
2841 source_data->size = size;
2842 source_data->direction = direction;
2843 source_data->state = state;
2845 parser_data->sources = g_slist_prepend (parser_data->sources, source_data);
2851 gint line_number, char_number;
2853 g_markup_parse_context_get_position (context,
2857 tmp = g_strdup_printf ("%s:%d:%d %s", "input",
2858 line_number, char_number, error_msg);
2860 g_set_error_literal (error,
2875 static const GMarkupParser icon_source_parser =
2877 icon_source_start_element,
2881 gtk_icon_factory_buildable_custom_tag_start (GtkBuildable *buildable,
2882 GtkBuilder *builder,
2884 const gchar *tagname,
2885 GMarkupParser *parser,
2888 g_assert (buildable);
2890 if (strcmp (tagname, "sources") == 0)
2892 IconFactoryParserData *parser_data;
2894 parser_data = g_slice_new0 (IconFactoryParserData);
2895 *parser = icon_source_parser;
2896 *data = parser_data;
2903 gtk_icon_factory_buildable_custom_tag_end (GtkBuildable *buildable,
2904 GtkBuilder *builder,
2906 const gchar *tagname,
2907 gpointer *user_data)
2909 GtkIconFactory *icon_factory;
2911 icon_factory = GTK_ICON_FACTORY (buildable);
2913 if (strcmp (tagname, "sources") == 0)
2915 IconFactoryParserData *parser_data;
2916 GtkIconSource *icon_source;
2917 GtkIconSet *icon_set;
2920 parser_data = (IconFactoryParserData*)user_data;
2922 for (l = parser_data->sources; l; l = l->next)
2924 IconSourceParserData *source_data = l->data;
2926 icon_set = gtk_icon_factory_lookup (icon_factory, source_data->stock_id);
2929 icon_set = gtk_icon_set_new ();
2930 gtk_icon_factory_add (icon_factory, source_data->stock_id, icon_set);
2931 gtk_icon_set_unref (icon_set);
2934 icon_source = gtk_icon_source_new ();
2936 if (source_data->filename)
2939 filename = _gtk_builder_get_absolute_filename (builder, source_data->filename);
2940 gtk_icon_source_set_filename (icon_source, filename);
2943 if (source_data->icon_name)
2944 gtk_icon_source_set_icon_name (icon_source, source_data->icon_name);
2945 if (source_data->size != -1)
2947 gtk_icon_source_set_size (icon_source, source_data->size);
2948 gtk_icon_source_set_size_wildcarded (icon_source, FALSE);
2950 if (source_data->direction != -1)
2952 gtk_icon_source_set_direction (icon_source, source_data->direction);
2953 gtk_icon_source_set_direction_wildcarded (icon_source, FALSE);
2955 if (source_data->state != -1)
2957 gtk_icon_source_set_state (icon_source, source_data->state);
2958 gtk_icon_source_set_state_wildcarded (icon_source, FALSE);
2961 /* Inline source_add() to avoid creating a copy */
2962 g_assert (icon_source->type != GTK_ICON_SOURCE_EMPTY);
2963 icon_set->sources = g_slist_insert_sorted (icon_set->sources,
2965 icon_source_compare);
2967 g_free (source_data->stock_id);
2968 g_free (source_data->filename);
2969 g_free (source_data->icon_name);
2970 g_slice_free (IconSourceParserData, source_data);
2972 g_slist_free (parser_data->sources);
2973 g_slice_free (IconFactoryParserData, parser_data);
2975 /* TODO: Add an attribute/tag to prevent this.
2976 * Usually it's the right thing to do though.
2978 gtk_icon_factory_add_default (icon_factory);
2984 /* DLL ABI stability backward compatibility versions */
2986 #undef gtk_icon_source_set_filename
2989 gtk_icon_source_set_filename (GtkIconSource *source,
2990 const gchar *filename)
2992 gchar *utf8_filename = g_locale_to_utf8 (filename, -1, NULL, NULL, NULL);
2994 gtk_icon_source_set_filename_utf8 (source, utf8_filename);
2996 g_free (utf8_filename);
2999 #undef gtk_icon_source_get_filename
3001 G_CONST_RETURN gchar*
3002 gtk_icon_source_get_filename (const GtkIconSource *source)
3004 g_return_val_if_fail (source != NULL, NULL);
3006 if (source->type == GTK_ICON_SOURCE_FILENAME)
3007 return source->cp_filename;
3014 #define __GTK_ICON_FACTORY_C__
3015 #include "gtkaliasdef.c"