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/.
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;
78 #if defined (G_OS_WIN32) && !defined (_WIN64)
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.
204 gtk_icon_factory_add (GtkIconFactory *factory,
205 const gchar *stock_id,
206 GtkIconSet *icon_set)
208 gpointer old_key = NULL;
209 gpointer old_value = NULL;
211 g_return_if_fail (GTK_IS_ICON_FACTORY (factory));
212 g_return_if_fail (stock_id != NULL);
213 g_return_if_fail (icon_set != NULL);
215 g_hash_table_lookup_extended (factory->icons, stock_id,
216 &old_key, &old_value);
218 if (old_value == icon_set)
221 gtk_icon_set_ref (icon_set);
223 /* GHashTable key memory management is so fantastically broken. */
225 g_hash_table_insert (factory->icons, old_key, icon_set);
227 g_hash_table_insert (factory->icons, g_strdup (stock_id), icon_set);
230 gtk_icon_set_unref (old_value);
234 * gtk_icon_factory_lookup:
235 * @factory: a #GtkIconFactory
236 * @stock_id: an icon name
238 * Looks up @stock_id in the icon factory, returning an icon set
239 * if found, otherwise %NULL. For display to the user, you should
240 * use gtk_style_lookup_icon_set() on the #GtkStyle for the
241 * widget that will display the icon, instead of using this
242 * function directly, so that themes are taken into account.
244 * Return value: icon set of @stock_id.
247 gtk_icon_factory_lookup (GtkIconFactory *factory,
248 const gchar *stock_id)
250 g_return_val_if_fail (GTK_IS_ICON_FACTORY (factory), NULL);
251 g_return_val_if_fail (stock_id != NULL, NULL);
253 return g_hash_table_lookup (factory->icons, stock_id);
256 static GtkIconFactory *gtk_default_icons = NULL;
257 static GSList *default_factories = NULL;
260 * gtk_icon_factory_add_default:
261 * @factory: a #GtkIconFactory
263 * Adds an icon factory to the list of icon factories searched by
264 * gtk_style_lookup_icon_set(). This means that, for example,
265 * gtk_image_new_from_stock() will be able to find icons in @factory.
266 * There will normally be an icon factory added for each library or
267 * application that comes with icons. The default icon factories
268 * can be overridden by themes.
271 gtk_icon_factory_add_default (GtkIconFactory *factory)
273 g_return_if_fail (GTK_IS_ICON_FACTORY (factory));
275 g_object_ref (factory);
277 default_factories = g_slist_prepend (default_factories, factory);
281 * gtk_icon_factory_remove_default:
282 * @factory: a #GtkIconFactory previously added with gtk_icon_factory_add_default()
284 * Removes an icon factory from the list of default icon
285 * factories. Not normally used; you might use it for a library that
286 * can be unloaded or shut down.
289 gtk_icon_factory_remove_default (GtkIconFactory *factory)
291 g_return_if_fail (GTK_IS_ICON_FACTORY (factory));
293 default_factories = g_slist_remove (default_factories, factory);
295 g_object_unref (factory);
299 _gtk_icon_factory_ensure_default_icons (void)
301 if (gtk_default_icons == NULL)
303 gtk_default_icons = gtk_icon_factory_new ();
305 get_default_icons (gtk_default_icons);
310 * gtk_icon_factory_lookup_default:
311 * @stock_id: an icon name
313 * Looks for an icon in the list of default icon factories. For
314 * display to the user, you should use gtk_style_lookup_icon_set() on
315 * the #GtkStyle for the widget that will display the icon, instead of
316 * using this function directly, so that themes are taken into
319 * Return value: a #GtkIconSet, or %NULL
322 gtk_icon_factory_lookup_default (const gchar *stock_id)
326 g_return_val_if_fail (stock_id != NULL, NULL);
328 tmp_list = default_factories;
329 while (tmp_list != NULL)
331 GtkIconSet *icon_set =
332 gtk_icon_factory_lookup (GTK_ICON_FACTORY (tmp_list->data),
338 tmp_list = g_slist_next (tmp_list);
341 _gtk_icon_factory_ensure_default_icons ();
343 return gtk_icon_factory_lookup (gtk_default_icons, stock_id);
347 register_stock_icon (GtkIconFactory *factory,
348 const gchar *stock_id)
350 GtkIconSet *set = gtk_icon_set_new ();
351 GtkIconSource source = GTK_ICON_SOURCE_INIT (TRUE, TRUE, TRUE);
353 source.type = GTK_ICON_SOURCE_STATIC_ICON_NAME;
354 source.source.icon_name = (gchar *)stock_id;
355 gtk_icon_set_add_source (set, &source);
357 gtk_icon_factory_add (factory, stock_id, set);
358 gtk_icon_set_unref (set);
362 register_bidi_stock_icon (GtkIconFactory *factory,
363 const gchar *stock_id,
364 const gchar *stock_id_ltr,
365 const gchar *stock_id_rtl)
367 GtkIconSet *set = gtk_icon_set_new ();
368 GtkIconSource source = GTK_ICON_SOURCE_INIT (FALSE, TRUE, TRUE);
370 source.type = GTK_ICON_SOURCE_STATIC_ICON_NAME;
371 source.source.icon_name = (gchar *)stock_id_ltr;
372 source.direction = GTK_TEXT_DIR_LTR;
373 gtk_icon_set_add_source (set, &source);
375 source.type = GTK_ICON_SOURCE_STATIC_ICON_NAME;
376 source.source.icon_name = (gchar *)stock_id_rtl;
377 source.direction = GTK_TEXT_DIR_RTL;
378 gtk_icon_set_add_source (set, &source);
380 gtk_icon_factory_add (factory, stock_id, set);
381 gtk_icon_set_unref (set);
385 get_default_icons (GtkIconFactory *factory)
387 /* KEEP IN SYNC with gtkstock.c */
389 register_stock_icon (factory, GTK_STOCK_DIALOG_AUTHENTICATION);
390 register_stock_icon (factory, GTK_STOCK_DIALOG_ERROR);
391 register_stock_icon (factory, GTK_STOCK_DIALOG_INFO);
392 register_stock_icon (factory, GTK_STOCK_DIALOG_QUESTION);
393 register_stock_icon (factory, GTK_STOCK_DIALOG_WARNING);
394 register_stock_icon (factory, GTK_STOCK_DND);
395 register_stock_icon (factory, GTK_STOCK_DND_MULTIPLE);
396 register_stock_icon (factory, GTK_STOCK_APPLY);
397 register_stock_icon (factory, GTK_STOCK_CANCEL);
398 register_stock_icon (factory, GTK_STOCK_NO);
399 register_stock_icon (factory, GTK_STOCK_OK);
400 register_stock_icon (factory, GTK_STOCK_YES);
401 register_stock_icon (factory, GTK_STOCK_CLOSE);
402 register_stock_icon (factory, GTK_STOCK_ADD);
403 register_stock_icon (factory, GTK_STOCK_JUSTIFY_CENTER);
404 register_stock_icon (factory, GTK_STOCK_JUSTIFY_FILL);
405 register_stock_icon (factory, GTK_STOCK_JUSTIFY_LEFT);
406 register_stock_icon (factory, GTK_STOCK_JUSTIFY_RIGHT);
407 register_stock_icon (factory, GTK_STOCK_GOTO_BOTTOM);
408 register_stock_icon (factory, GTK_STOCK_CDROM);
409 register_stock_icon (factory, GTK_STOCK_CONVERT);
410 register_stock_icon (factory, GTK_STOCK_COPY);
411 register_stock_icon (factory, GTK_STOCK_CUT);
412 register_stock_icon (factory, GTK_STOCK_GO_DOWN);
413 register_stock_icon (factory, GTK_STOCK_EXECUTE);
414 register_stock_icon (factory, GTK_STOCK_QUIT);
415 register_bidi_stock_icon (factory,
416 GTK_STOCK_GOTO_FIRST,
417 GTK_STOCK_GOTO_FIRST "-ltr",
418 GTK_STOCK_GOTO_FIRST "-rtl");
419 register_stock_icon (factory, GTK_STOCK_SELECT_FONT);
420 register_stock_icon (factory, GTK_STOCK_FULLSCREEN);
421 register_stock_icon (factory, GTK_STOCK_LEAVE_FULLSCREEN);
422 register_stock_icon (factory, GTK_STOCK_HARDDISK);
423 register_stock_icon (factory, GTK_STOCK_HELP);
424 register_stock_icon (factory, GTK_STOCK_HOME);
425 register_stock_icon (factory, GTK_STOCK_INFO);
426 register_bidi_stock_icon (factory,
428 GTK_STOCK_JUMP_TO "-ltr",
429 GTK_STOCK_JUMP_TO "-rtl");
430 register_bidi_stock_icon (factory,
432 GTK_STOCK_GOTO_LAST "-ltr",
433 GTK_STOCK_GOTO_LAST "-rtl");
434 register_bidi_stock_icon (factory,
436 GTK_STOCK_GO_BACK "-ltr",
437 GTK_STOCK_GO_BACK "-rtl");
438 register_stock_icon (factory, GTK_STOCK_MISSING_IMAGE);
439 register_stock_icon (factory, GTK_STOCK_NETWORK);
440 register_stock_icon (factory, GTK_STOCK_NEW);
441 register_stock_icon (factory, GTK_STOCK_OPEN);
442 register_stock_icon (factory, GTK_STOCK_ORIENTATION_PORTRAIT);
443 register_stock_icon (factory, GTK_STOCK_ORIENTATION_LANDSCAPE);
444 register_stock_icon (factory, GTK_STOCK_ORIENTATION_REVERSE_PORTRAIT);
445 register_stock_icon (factory, GTK_STOCK_ORIENTATION_REVERSE_LANDSCAPE);
446 register_stock_icon (factory, GTK_STOCK_PAGE_SETUP);
447 register_stock_icon (factory, GTK_STOCK_PASTE);
448 register_stock_icon (factory, GTK_STOCK_PREFERENCES);
449 register_stock_icon (factory, GTK_STOCK_PRINT);
450 register_stock_icon (factory, GTK_STOCK_PRINT_ERROR);
451 register_stock_icon (factory, GTK_STOCK_PRINT_PAUSED);
452 register_stock_icon (factory, GTK_STOCK_PRINT_PREVIEW);
453 register_stock_icon (factory, GTK_STOCK_PRINT_REPORT);
454 register_stock_icon (factory, GTK_STOCK_PRINT_WARNING);
455 register_stock_icon (factory, GTK_STOCK_PROPERTIES);
456 register_bidi_stock_icon (factory,
458 GTK_STOCK_REDO "-ltr",
459 GTK_STOCK_REDO "-rtl");
460 register_stock_icon (factory, GTK_STOCK_REMOVE);
461 register_stock_icon (factory, GTK_STOCK_REFRESH);
462 register_bidi_stock_icon (factory,
463 GTK_STOCK_REVERT_TO_SAVED,
464 GTK_STOCK_REVERT_TO_SAVED "-ltr",
465 GTK_STOCK_REVERT_TO_SAVED "-rtl");
466 register_bidi_stock_icon (factory,
467 GTK_STOCK_GO_FORWARD,
468 GTK_STOCK_GO_FORWARD "-ltr",
469 GTK_STOCK_GO_FORWARD "-rtl");
470 register_stock_icon (factory, GTK_STOCK_SAVE);
471 register_stock_icon (factory, GTK_STOCK_FLOPPY);
472 register_stock_icon (factory, GTK_STOCK_SAVE_AS);
473 register_stock_icon (factory, GTK_STOCK_FIND);
474 register_stock_icon (factory, GTK_STOCK_FIND_AND_REPLACE);
475 register_stock_icon (factory, GTK_STOCK_SORT_DESCENDING);
476 register_stock_icon (factory, GTK_STOCK_SORT_ASCENDING);
477 register_stock_icon (factory, GTK_STOCK_SPELL_CHECK);
478 register_stock_icon (factory, GTK_STOCK_STOP);
479 register_stock_icon (factory, GTK_STOCK_BOLD);
480 register_stock_icon (factory, GTK_STOCK_ITALIC);
481 register_stock_icon (factory, GTK_STOCK_STRIKETHROUGH);
482 register_stock_icon (factory, GTK_STOCK_UNDERLINE);
483 register_bidi_stock_icon (factory,
485 GTK_STOCK_INDENT "-ltr",
486 GTK_STOCK_INDENT "-rtl");
487 register_bidi_stock_icon (factory,
489 GTK_STOCK_UNINDENT "-ltr",
490 GTK_STOCK_UNINDENT "-rtl");
491 register_stock_icon (factory, GTK_STOCK_GOTO_TOP);
492 register_stock_icon (factory, GTK_STOCK_DELETE);
493 register_bidi_stock_icon (factory,
495 GTK_STOCK_UNDELETE "-ltr",
496 GTK_STOCK_UNDELETE "-rtl");
497 register_bidi_stock_icon (factory,
499 GTK_STOCK_UNDO "-ltr",
500 GTK_STOCK_UNDO "-rtl");
501 register_stock_icon (factory, GTK_STOCK_GO_UP);
502 register_stock_icon (factory, GTK_STOCK_FILE);
503 register_stock_icon (factory, GTK_STOCK_DIRECTORY);
504 register_stock_icon (factory, GTK_STOCK_ABOUT);
505 register_stock_icon (factory, GTK_STOCK_CONNECT);
506 register_stock_icon (factory, GTK_STOCK_DISCONNECT);
507 register_stock_icon (factory, GTK_STOCK_EDIT);
508 register_stock_icon (factory, GTK_STOCK_CAPS_LOCK_WARNING);
509 register_bidi_stock_icon (factory,
510 GTK_STOCK_MEDIA_FORWARD,
511 GTK_STOCK_MEDIA_FORWARD "-ltr",
512 GTK_STOCK_MEDIA_FORWARD "-rtl");
513 register_bidi_stock_icon (factory,
514 GTK_STOCK_MEDIA_NEXT,
515 GTK_STOCK_MEDIA_NEXT "-ltr",
516 GTK_STOCK_MEDIA_NEXT "-rtl");
517 register_stock_icon (factory, GTK_STOCK_MEDIA_PAUSE);
518 register_bidi_stock_icon (factory,
519 GTK_STOCK_MEDIA_PLAY,
520 GTK_STOCK_MEDIA_PLAY "-ltr",
521 GTK_STOCK_MEDIA_PLAY "-rtl");
522 register_bidi_stock_icon (factory,
523 GTK_STOCK_MEDIA_PREVIOUS,
524 GTK_STOCK_MEDIA_PREVIOUS "-ltr",
525 GTK_STOCK_MEDIA_PREVIOUS "-rtl");
526 register_stock_icon (factory, GTK_STOCK_MEDIA_RECORD);
527 register_bidi_stock_icon (factory,
528 GTK_STOCK_MEDIA_REWIND,
529 GTK_STOCK_MEDIA_REWIND "-ltr",
530 GTK_STOCK_MEDIA_REWIND "-rtl");
531 register_stock_icon (factory, GTK_STOCK_MEDIA_STOP);
532 register_stock_icon (factory, GTK_STOCK_INDEX);
533 register_stock_icon (factory, GTK_STOCK_ZOOM_100);
534 register_stock_icon (factory, GTK_STOCK_ZOOM_IN);
535 register_stock_icon (factory, GTK_STOCK_ZOOM_OUT);
536 register_stock_icon (factory, GTK_STOCK_ZOOM_FIT);
537 register_stock_icon (factory, GTK_STOCK_SELECT_ALL);
538 register_stock_icon (factory, GTK_STOCK_CLEAR);
539 register_stock_icon (factory, GTK_STOCK_SELECT_COLOR);
540 register_stock_icon (factory, GTK_STOCK_COLOR_PICKER);
543 /************************************************************
544 * Icon size handling *
545 ************************************************************/
547 typedef struct _IconSize IconSize;
558 typedef struct _IconAlias IconAlias;
566 typedef struct _SettingsIconSize SettingsIconSize;
568 struct _SettingsIconSize
574 static GHashTable *icon_aliases = NULL;
575 static IconSize *icon_sizes = NULL;
576 static gint icon_sizes_allocated = 0;
577 static gint icon_sizes_used = 0;
580 init_icon_sizes (void)
582 if (icon_sizes == NULL)
584 #define NUM_BUILTIN_SIZES 7
587 icon_aliases = g_hash_table_new (g_str_hash, g_str_equal);
589 icon_sizes = g_new (IconSize, NUM_BUILTIN_SIZES);
590 icon_sizes_allocated = NUM_BUILTIN_SIZES;
591 icon_sizes_used = NUM_BUILTIN_SIZES;
593 icon_sizes[GTK_ICON_SIZE_INVALID].size = 0;
594 icon_sizes[GTK_ICON_SIZE_INVALID].name = NULL;
595 icon_sizes[GTK_ICON_SIZE_INVALID].width = 0;
596 icon_sizes[GTK_ICON_SIZE_INVALID].height = 0;
598 /* the name strings aren't copied since we don't ever remove
599 * icon sizes, so we don't need to know whether they're static.
600 * Even if we did I suppose removing the builtin sizes would be
604 icon_sizes[GTK_ICON_SIZE_MENU].size = GTK_ICON_SIZE_MENU;
605 icon_sizes[GTK_ICON_SIZE_MENU].name = "gtk-menu";
606 icon_sizes[GTK_ICON_SIZE_MENU].width = 16;
607 icon_sizes[GTK_ICON_SIZE_MENU].height = 16;
609 icon_sizes[GTK_ICON_SIZE_BUTTON].size = GTK_ICON_SIZE_BUTTON;
610 icon_sizes[GTK_ICON_SIZE_BUTTON].name = "gtk-button";
611 icon_sizes[GTK_ICON_SIZE_BUTTON].width = 20;
612 icon_sizes[GTK_ICON_SIZE_BUTTON].height = 20;
614 icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].size = GTK_ICON_SIZE_SMALL_TOOLBAR;
615 icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].name = "gtk-small-toolbar";
616 icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].width = 18;
617 icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].height = 18;
619 icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].size = GTK_ICON_SIZE_LARGE_TOOLBAR;
620 icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].name = "gtk-large-toolbar";
621 icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].width = 24;
622 icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].height = 24;
624 icon_sizes[GTK_ICON_SIZE_DND].size = GTK_ICON_SIZE_DND;
625 icon_sizes[GTK_ICON_SIZE_DND].name = "gtk-dnd";
626 icon_sizes[GTK_ICON_SIZE_DND].width = 32;
627 icon_sizes[GTK_ICON_SIZE_DND].height = 32;
629 icon_sizes[GTK_ICON_SIZE_DIALOG].size = GTK_ICON_SIZE_DIALOG;
630 icon_sizes[GTK_ICON_SIZE_DIALOG].name = "gtk-dialog";
631 icon_sizes[GTK_ICON_SIZE_DIALOG].width = 48;
632 icon_sizes[GTK_ICON_SIZE_DIALOG].height = 48;
634 g_assert ((GTK_ICON_SIZE_DIALOG + 1) == NUM_BUILTIN_SIZES);
636 /* Alias everything to itself. */
637 i = 1; /* skip invalid size */
638 while (i < NUM_BUILTIN_SIZES)
640 gtk_icon_size_register_alias (icon_sizes[i].name, icon_sizes[i].size);
645 #undef NUM_BUILTIN_SIZES
650 free_settings_sizes (gpointer data)
652 g_array_free (data, TRUE);
656 get_settings_sizes (GtkSettings *settings,
659 GArray *settings_sizes;
660 static GQuark sizes_quark = 0;
663 sizes_quark = g_quark_from_static_string ("gtk-icon-sizes");
665 settings_sizes = g_object_get_qdata (G_OBJECT (settings), sizes_quark);
668 settings_sizes = g_array_new (FALSE, FALSE, sizeof (SettingsIconSize));
669 g_object_set_qdata_full (G_OBJECT (settings), sizes_quark,
670 settings_sizes, free_settings_sizes);
675 return settings_sizes;
679 icon_size_set_for_settings (GtkSettings *settings,
680 const gchar *size_name,
685 GArray *settings_sizes;
686 SettingsIconSize *settings_size;
688 g_return_if_fail (size_name != NULL);
690 size = gtk_icon_size_from_name (size_name);
691 if (size == GTK_ICON_SIZE_INVALID)
692 /* Reserve a place */
693 size = icon_size_register_intern (size_name, -1, -1);
695 settings_sizes = get_settings_sizes (settings, NULL);
696 if (size >= settings_sizes->len)
698 SettingsIconSize unset = { -1, -1 };
701 for (i = settings_sizes->len; i <= size; i++)
702 g_array_append_val (settings_sizes, unset);
705 settings_size = &g_array_index (settings_sizes, SettingsIconSize, size);
707 settings_size->width = width;
708 settings_size->height = height;
711 /* Like pango_parse_word, but accept - as well
714 scan_icon_size_name (const char **pos, GString *out)
716 const char *p = *pos;
718 while (g_ascii_isspace (*p))
721 if (!((*p >= 'A' && *p <= 'Z') ||
722 (*p >= 'a' && *p <= 'z') ||
723 *p == '_' || *p == '-'))
726 g_string_truncate (out, 0);
727 g_string_append_c (out, *p);
730 while ((*p >= 'A' && *p <= 'Z') ||
731 (*p >= 'a' && *p <= 'z') ||
732 (*p >= '0' && *p <= '9') ||
733 *p == '_' || *p == '-')
735 g_string_append_c (out, *p);
745 icon_size_setting_parse (GtkSettings *settings,
746 const gchar *icon_size_string)
748 GString *name_buf = g_string_new (NULL);
749 const gchar *p = icon_size_string;
751 while (pango_skip_space (&p))
755 if (!scan_icon_size_name (&p, name_buf))
758 if (!pango_skip_space (&p))
766 if (!pango_scan_int (&p, &width))
769 if (!pango_skip_space (&p))
777 if (!pango_scan_int (&p, &height))
780 if (width > 0 && height > 0)
782 icon_size_set_for_settings (settings, name_buf->str,
787 g_warning ("Invalid size in gtk-icon-sizes: %d,%d\n", width, height);
790 pango_skip_space (&p);
799 g_string_free (name_buf, TRUE);
803 g_warning ("Error parsing gtk-icon-sizes string:\n\t'%s'", icon_size_string);
804 g_string_free (name_buf, TRUE);
808 icon_size_set_all_from_settings (GtkSettings *settings)
810 GArray *settings_sizes;
811 gchar *icon_size_string;
813 /* Reset old settings */
814 settings_sizes = get_settings_sizes (settings, NULL);
815 g_array_set_size (settings_sizes, 0);
817 g_object_get (settings,
818 "gtk-icon-sizes", &icon_size_string,
821 if (icon_size_string)
823 icon_size_setting_parse (settings, icon_size_string);
824 g_free (icon_size_string);
829 icon_size_settings_changed (GtkSettings *settings,
832 icon_size_set_all_from_settings (settings);
834 gtk_rc_reset_styles (settings);
838 icon_sizes_init_for_settings (GtkSettings *settings)
840 g_signal_connect (settings,
841 "notify::gtk-icon-sizes",
842 G_CALLBACK (icon_size_settings_changed),
845 icon_size_set_all_from_settings (settings);
849 icon_size_lookup_intern (GtkSettings *settings,
854 GArray *settings_sizes;
855 gint width_for_settings = -1;
856 gint height_for_settings = -1;
860 if (size == (GtkIconSize)-1)
863 if (size >= icon_sizes_used)
866 if (size == GTK_ICON_SIZE_INVALID)
871 gboolean initial = FALSE;
873 settings_sizes = get_settings_sizes (settings, &initial);
876 icon_sizes_init_for_settings (settings);
878 if (size < settings_sizes->len)
880 SettingsIconSize *settings_size;
882 settings_size = &g_array_index (settings_sizes, SettingsIconSize, size);
884 width_for_settings = settings_size->width;
885 height_for_settings = settings_size->height;
890 *widthp = width_for_settings >= 0 ? width_for_settings : icon_sizes[size].width;
893 *heightp = height_for_settings >= 0 ? height_for_settings : icon_sizes[size].height;
899 * gtk_icon_size_lookup_for_settings:
900 * @settings: a #GtkSettings object, used to determine
901 * which set of user preferences to used.
902 * @size: (type int): an icon size
903 * @width: location to store icon width
904 * @height: location to store icon height
906 * Obtains the pixel size of a semantic icon size, possibly
907 * modified by user preferences for a particular
908 * #GtkSettings. Normally @size would be
909 * #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc. This function
910 * isn't normally needed, gtk_widget_render_icon() is the usual
911 * way to get an icon for rendering, then just look at the size of
912 * the rendered pixbuf. The rendered pixbuf may not even correspond to
913 * the width/height returned by gtk_icon_size_lookup(), because themes
914 * are free to render the pixbuf however they like, including changing
917 * Return value: %TRUE if @size was a valid size
922 gtk_icon_size_lookup_for_settings (GtkSettings *settings,
927 g_return_val_if_fail (GTK_IS_SETTINGS (settings), FALSE);
929 return icon_size_lookup_intern (settings, size, width, height);
933 * gtk_icon_size_lookup:
934 * @size: (type int): an icon size
935 * @width: location to store icon width
936 * @height: location to store icon height
938 * Obtains the pixel size of a semantic icon size, possibly
939 * modified by user preferences for the default #GtkSettings.
940 * (See gtk_icon_size_lookup_for_settings().)
941 * Normally @size would be
942 * #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc. This function
943 * isn't normally needed, gtk_widget_render_icon() is the usual
944 * way to get an icon for rendering, then just look at the size of
945 * the rendered pixbuf. The rendered pixbuf may not even correspond to
946 * the width/height returned by gtk_icon_size_lookup(), because themes
947 * are free to render the pixbuf however they like, including changing
950 * Return value: %TRUE if @size was a valid size
953 gtk_icon_size_lookup (GtkIconSize size,
958 g_warning ("gtk_icon_size_lookup ()) is not multihead safe"));
960 return gtk_icon_size_lookup_for_settings (gtk_settings_get_default (),
961 size, widthp, heightp);
965 icon_size_register_intern (const gchar *name,
969 IconAlias *old_alias;
974 old_alias = g_hash_table_lookup (icon_aliases, name);
975 if (old_alias && icon_sizes[old_alias->target].width > 0)
977 g_warning ("Icon size name '%s' already exists", name);
978 return GTK_ICON_SIZE_INVALID;
983 size = old_alias->target;
987 if (icon_sizes_used == icon_sizes_allocated)
989 icon_sizes_allocated *= 2;
990 icon_sizes = g_renew (IconSize, icon_sizes, icon_sizes_allocated);
993 size = icon_sizes_used++;
996 gtk_icon_size_register_alias (name, size);
998 icon_sizes[size].size = size;
999 icon_sizes[size].name = g_strdup (name);
1002 icon_sizes[size].width = width;
1003 icon_sizes[size].height = height;
1009 * gtk_icon_size_register:
1010 * @name: name of the icon size
1011 * @width: the icon width
1012 * @height: the icon height
1014 * Registers a new icon size, along the same lines as #GTK_ICON_SIZE_MENU,
1015 * etc. Returns the integer value for the size.
1017 * Returns: (type int): integer value representing the size
1020 gtk_icon_size_register (const gchar *name,
1024 g_return_val_if_fail (name != NULL, 0);
1025 g_return_val_if_fail (width > 0, 0);
1026 g_return_val_if_fail (height > 0, 0);
1028 return icon_size_register_intern (name, width, height);
1032 * gtk_icon_size_register_alias:
1033 * @alias: an alias for @target
1034 * @target: (type int): an existing icon size
1036 * Registers @alias as another name for @target.
1037 * So calling gtk_icon_size_from_name() with @alias as argument
1038 * will return @target.
1041 gtk_icon_size_register_alias (const gchar *alias,
1046 g_return_if_fail (alias != NULL);
1050 if (!icon_size_lookup_intern (NULL, target, NULL, NULL))
1051 g_warning ("gtk_icon_size_register_alias: Icon size %u does not exist", target);
1053 ia = g_hash_table_lookup (icon_aliases, alias);
1056 if (icon_sizes[ia->target].width > 0)
1058 g_warning ("gtk_icon_size_register_alias: Icon size name '%s' already exists", alias);
1062 ia->target = target;
1067 ia = g_new (IconAlias, 1);
1068 ia->name = g_strdup (alias);
1069 ia->target = target;
1071 g_hash_table_insert (icon_aliases, ia->name, ia);
1076 * gtk_icon_size_from_name:
1077 * @name: the name to look up.
1078 * @returns: the icon size with the given name.
1080 * Looks up the icon size associated with @name.
1082 * Return value: (type int): the icon size
1085 gtk_icon_size_from_name (const gchar *name)
1091 ia = g_hash_table_lookup (icon_aliases, name);
1093 if (ia && icon_sizes[ia->target].width > 0)
1096 return GTK_ICON_SIZE_INVALID;
1100 * gtk_icon_size_get_name:
1101 * @size: (type int): a #GtkIconSize.
1102 * @returns: the name of the given icon size.
1104 * Gets the canonical name of the given icon size. The returned string
1105 * is statically allocated and should not be freed.
1107 G_CONST_RETURN gchar*
1108 gtk_icon_size_get_name (GtkIconSize size)
1110 if (size >= icon_sizes_used)
1113 return icon_sizes[size].name;
1116 /************************************************************/
1121 static GdkPixbuf *find_in_cache (GtkIconSet *icon_set,
1123 GtkTextDirection direction,
1126 static void add_to_cache (GtkIconSet *icon_set,
1128 GtkTextDirection direction,
1132 /* Clear icon set contents, drop references to all contained
1133 * GdkPixbuf objects and forget all GtkIconSources. Used to
1134 * recycle an icon set.
1136 static void clear_cache (GtkIconSet *icon_set,
1137 gboolean style_detach);
1138 static GSList* copy_cache (GtkIconSet *icon_set,
1139 GtkIconSet *copy_recipient);
1140 static void attach_to_style (GtkIconSet *icon_set,
1142 static void detach_from_style (GtkIconSet *icon_set,
1144 static void style_dnotify (gpointer data);
1152 /* Cache of the last few rendered versions of the icon. */
1160 static guint cache_serial = 0;
1165 * Creates a new #GtkIconSet. A #GtkIconSet represents a single icon
1166 * in various sizes and widget states. It can provide a #GdkPixbuf
1167 * for a given size and state on request, and automatically caches
1168 * some of the rendered #GdkPixbuf objects.
1170 * Normally you would use gtk_widget_render_icon() instead of
1171 * using #GtkIconSet directly. The one case where you'd use
1172 * #GtkIconSet is to create application-specific icon sets to place in
1173 * a #GtkIconFactory.
1175 * Return value: a new #GtkIconSet
1178 gtk_icon_set_new (void)
1180 GtkIconSet *icon_set;
1182 icon_set = g_new (GtkIconSet, 1);
1184 icon_set->ref_count = 1;
1185 icon_set->sources = NULL;
1186 icon_set->cache = NULL;
1187 icon_set->cache_size = 0;
1188 icon_set->cache_serial = cache_serial;
1194 * gtk_icon_set_new_from_pixbuf:
1195 * @pixbuf: a #GdkPixbuf
1197 * Creates a new #GtkIconSet with @pixbuf as the default/fallback
1198 * source image. If you don't add any additional #GtkIconSource to the
1199 * icon set, all variants of the icon will be created from @pixbuf,
1200 * using scaling, pixelation, etc. as required to adjust the icon size
1201 * or make the icon look insensitive/prelighted.
1203 * Return value: a new #GtkIconSet
1206 gtk_icon_set_new_from_pixbuf (GdkPixbuf *pixbuf)
1210 GtkIconSource source = GTK_ICON_SOURCE_INIT (TRUE, TRUE, TRUE);
1212 g_return_val_if_fail (pixbuf != NULL, NULL);
1214 set = gtk_icon_set_new ();
1216 gtk_icon_source_set_pixbuf (&source, pixbuf);
1217 gtk_icon_set_add_source (set, &source);
1218 gtk_icon_source_set_pixbuf (&source, NULL);
1226 * @icon_set: a #GtkIconSet.
1228 * Increments the reference count on @icon_set.
1230 * Return value: @icon_set.
1233 gtk_icon_set_ref (GtkIconSet *icon_set)
1235 g_return_val_if_fail (icon_set != NULL, NULL);
1236 g_return_val_if_fail (icon_set->ref_count > 0, NULL);
1238 icon_set->ref_count += 1;
1244 * gtk_icon_set_unref:
1245 * @icon_set: a #GtkIconSet
1247 * Decrements the reference count on @icon_set, and frees memory
1248 * if the reference count reaches 0.
1251 gtk_icon_set_unref (GtkIconSet *icon_set)
1253 g_return_if_fail (icon_set != NULL);
1254 g_return_if_fail (icon_set->ref_count > 0);
1256 icon_set->ref_count -= 1;
1258 if (icon_set->ref_count == 0)
1260 GSList *tmp_list = icon_set->sources;
1261 while (tmp_list != NULL)
1263 gtk_icon_source_free (tmp_list->data);
1265 tmp_list = g_slist_next (tmp_list);
1267 g_slist_free (icon_set->sources);
1269 clear_cache (icon_set, TRUE);
1276 gtk_icon_set_get_type (void)
1278 static GType our_type = 0;
1281 our_type = g_boxed_type_register_static (I_("GtkIconSet"),
1282 (GBoxedCopyFunc) gtk_icon_set_ref,
1283 (GBoxedFreeFunc) gtk_icon_set_unref);
1289 * gtk_icon_set_copy:
1290 * @icon_set: a #GtkIconSet
1292 * Copies @icon_set by value.
1294 * Return value: a new #GtkIconSet identical to the first.
1297 gtk_icon_set_copy (GtkIconSet *icon_set)
1302 copy = gtk_icon_set_new ();
1304 tmp_list = icon_set->sources;
1305 while (tmp_list != NULL)
1307 copy->sources = g_slist_prepend (copy->sources,
1308 gtk_icon_source_copy (tmp_list->data));
1310 tmp_list = g_slist_next (tmp_list);
1313 copy->sources = g_slist_reverse (copy->sources);
1315 copy->cache = copy_cache (icon_set, copy);
1316 copy->cache_size = icon_set->cache_size;
1317 copy->cache_serial = icon_set->cache_serial;
1323 sizes_equivalent (GtkIconSize lhs,
1326 /* We used to consider sizes equivalent if they were
1327 * the same pixel size, but we don't have the GtkSettings
1328 * here, so we can't do that. Plus, it's not clear that
1329 * it is right... it was just a workaround for the fact
1330 * that we register icons by logical size, not pixel size.
1336 gint r_w, r_h, l_w, l_h;
1338 icon_size_lookup_intern (NULL, rhs, &r_w, &r_h);
1339 icon_size_lookup_intern (NULL, lhs, &l_w, &l_h);
1341 return r_w == l_w && r_h == l_h;
1345 static GtkIconSource *
1346 find_best_matching_source (GtkIconSet *icon_set,
1347 GtkTextDirection direction,
1352 GtkIconSource *source;
1355 /* We need to find the best icon source. Direction matters more
1356 * than state, state matters more than size. icon_set->sources
1357 * is sorted according to wildness, so if we take the first
1358 * match we find it will be the least-wild match (if there are
1359 * multiple matches for a given "wildness" then the RC file contained
1360 * dumb stuff, and we end up with an arbitrary matching source)
1364 tmp_list = icon_set->sources;
1365 while (tmp_list != NULL)
1367 GtkIconSource *s = tmp_list->data;
1369 if ((s->any_direction || (s->direction == direction)) &&
1370 (s->any_state || (s->state == state)) &&
1371 (s->any_size || size == (GtkIconSize)-1 || (sizes_equivalent (size, s->size))))
1373 if (!g_slist_find (failed, s))
1380 tmp_list = g_slist_next (tmp_list);
1387 ensure_filename_pixbuf (GtkIconSet *icon_set,
1388 GtkIconSource *source)
1390 if (source->filename_pixbuf == NULL)
1392 GError *error = NULL;
1394 source->filename_pixbuf = gdk_pixbuf_new_from_file (source->source.filename, &error);
1396 if (source->filename_pixbuf == NULL)
1398 /* Remove this icon source so we don't keep trying to
1401 g_warning (_("Error loading icon: %s"), error->message);
1402 g_error_free (error);
1404 icon_set->sources = g_slist_remove (icon_set->sources, source);
1406 gtk_icon_source_free (source);
1416 render_icon_name_pixbuf (GtkIconSource *icon_source,
1418 GtkTextDirection direction,
1425 GdkPixbuf *tmp_pixbuf;
1426 GtkIconSource tmp_source;
1428 GtkIconTheme *icon_theme;
1429 GtkSettings *settings;
1430 gint width, height, pixel_size;
1431 gint *sizes, *s, dist;
1432 GError *error = NULL;
1434 if (widget && gtk_widget_has_screen (widget))
1435 screen = gtk_widget_get_screen (widget);
1436 else if (style && style->colormap)
1437 screen = gdk_colormap_get_screen (style->colormap);
1440 screen = gdk_screen_get_default ();
1441 GTK_NOTE (MULTIHEAD,
1442 g_warning ("Using the default screen for gtk_icon_source_render_icon()"));
1445 icon_theme = gtk_icon_theme_get_for_screen (screen);
1446 settings = gtk_settings_get_for_screen (screen);
1448 if (!gtk_icon_size_lookup_for_settings (settings, size, &width, &height))
1450 if (size == (GtkIconSize)-1)
1452 /* Find an available size close to 48 */
1453 sizes = gtk_icon_theme_get_icon_sizes (icon_theme, icon_source->source.icon_name);
1455 width = height = 48;
1456 for (s = sizes; *s; s++)
1460 width = height = 48;
1467 width = height = *s;
1475 width = height = *s;
1485 g_warning ("Invalid icon size %u\n", size);
1486 width = height = 24;
1490 pixel_size = MIN (width, height);
1492 tmp_pixbuf = gtk_icon_theme_load_icon (icon_theme,
1493 icon_source->source.icon_name,
1499 g_warning ("Error loading theme icon '%s' for stock: %s",
1500 icon_source->source.icon_name, error ? error->message : "");
1502 g_error_free (error);
1506 tmp_source = *icon_source;
1507 tmp_source.type = GTK_ICON_SOURCE_PIXBUF;
1508 tmp_source.source.pixbuf = tmp_pixbuf;
1510 pixbuf = gtk_style_render_icon (style, &tmp_source,
1511 direction, state, -1,
1515 g_warning ("Failed to render icon");
1517 g_object_unref (tmp_pixbuf);
1523 find_and_render_icon_source (GtkIconSet *icon_set,
1525 GtkTextDirection direction,
1531 GSList *failed = NULL;
1532 GdkPixbuf *pixbuf = NULL;
1534 /* We treat failure in two different ways:
1536 * A) If loading a source that specifies a filename fails,
1537 * we treat that as permanent, and remove the source
1538 * from the GtkIconSet. (in ensure_filename_pixbuf ()
1539 * B) If loading a themed icon fails, or scaling an icon
1540 * fails, we treat that as transient and will try
1541 * again next time the icon falls out of the cache
1542 * and we need to recreate it.
1544 while (pixbuf == NULL)
1546 GtkIconSource *source = find_best_matching_source (icon_set, direction, state, size, failed);
1551 switch (source->type)
1553 case GTK_ICON_SOURCE_FILENAME:
1554 if (!ensure_filename_pixbuf (icon_set, source))
1557 case GTK_ICON_SOURCE_PIXBUF:
1558 pixbuf = gtk_style_render_icon (style, source,
1559 direction, state, size,
1563 g_warning ("Failed to render icon");
1564 failed = g_slist_prepend (failed, source);
1567 case GTK_ICON_SOURCE_ICON_NAME:
1568 case GTK_ICON_SOURCE_STATIC_ICON_NAME:
1569 pixbuf = render_icon_name_pixbuf (source, style,
1570 direction, state, size,
1573 failed = g_slist_prepend (failed, source);
1575 case GTK_ICON_SOURCE_EMPTY:
1576 g_assert_not_reached ();
1580 g_slist_free (failed);
1585 extern GtkIconCache *_builtin_cache;
1588 render_fallback_image (GtkStyle *style,
1589 GtkTextDirection direction,
1595 /* This icon can be used for any direction/state/size */
1596 static GtkIconSource fallback_source = GTK_ICON_SOURCE_INIT (TRUE, TRUE, TRUE);
1598 if (fallback_source.type == GTK_ICON_SOURCE_EMPTY)
1603 _gtk_icon_theme_ensure_builtin_cache ();
1605 index = _gtk_icon_cache_get_directory_index (_builtin_cache, "24");
1606 pixbuf = _gtk_icon_cache_get_icon (_builtin_cache,
1607 GTK_STOCK_MISSING_IMAGE,
1609 gtk_icon_source_set_pixbuf (&fallback_source, pixbuf);
1610 g_object_unref (pixbuf);
1613 return gtk_style_render_icon (style,
1623 * gtk_icon_set_render_icon:
1624 * @icon_set: a #GtkIconSet
1625 * @style: (allow-none): a #GtkStyle associated with @widget, or %NULL
1626 * @direction: text direction
1627 * @state: widget state
1628 * @size: (type int): icon size. A size of (GtkIconSize)-1
1629 * means render at the size of the source and don't scale.
1630 * @widget: widget that will display the icon, or %NULL.
1631 * The only use that is typically made of this
1632 * is to determine the appropriate #GdkScreen.
1633 * @detail: detail to pass to the theme engine, or %NULL.
1634 * Note that passing a detail of anything but %NULL
1635 * will disable caching.
1637 * Renders an icon using gtk_style_render_icon(). In most cases,
1638 * gtk_widget_render_icon() is better, since it automatically provides
1639 * most of the arguments from the current widget settings. This
1640 * function never returns %NULL; if the icon can't be rendered
1641 * (perhaps because an image file fails to load), a default "missing
1642 * image" icon will be returned instead.
1644 * Return value: a #GdkPixbuf to be displayed
1647 gtk_icon_set_render_icon (GtkIconSet *icon_set,
1649 GtkTextDirection direction,
1657 g_return_val_if_fail (icon_set != NULL, NULL);
1658 g_return_val_if_fail (style == NULL || GTK_IS_STYLE (style), NULL);
1660 if (icon_set->sources == NULL)
1661 return render_fallback_image (style, direction, state, size, widget, detail);
1665 icon = find_in_cache (icon_set, style, direction,
1670 g_object_ref (icon);
1676 icon = find_and_render_icon_source (icon_set, style, direction, state, size,
1680 icon = render_fallback_image (style, direction, state, size, widget, detail);
1683 add_to_cache (icon_set, style, direction, state, size, icon);
1688 /* Order sources by their "wildness", so that "wilder" sources are
1689 * greater than "specific" sources; for determining ordering,
1690 * direction beats state beats size.
1694 icon_source_compare (gconstpointer ap, gconstpointer bp)
1696 const GtkIconSource *a = ap;
1697 const GtkIconSource *b = bp;
1699 if (!a->any_direction && b->any_direction)
1701 else if (a->any_direction && !b->any_direction)
1703 else if (!a->any_state && b->any_state)
1705 else if (a->any_state && !b->any_state)
1707 else if (!a->any_size && b->any_size)
1709 else if (a->any_size && !b->any_size)
1716 * gtk_icon_set_add_source:
1717 * @icon_set: a #GtkIconSet
1718 * @source: a #GtkIconSource
1720 * Icon sets have a list of #GtkIconSource, which they use as base
1721 * icons for rendering icons in different states and sizes. Icons are
1722 * scaled, made to look insensitive, etc. in
1723 * gtk_icon_set_render_icon(), but #GtkIconSet needs base images to
1724 * work with. The base images and when to use them are described by
1727 * This function copies @source, so you can reuse the same source immediately
1728 * without affecting the icon set.
1730 * An example of when you'd use this function: a web browser's "Back
1731 * to Previous Page" icon might point in a different direction in
1732 * Hebrew and in English; it might look different when insensitive;
1733 * and it might change size depending on toolbar mode (small/large
1734 * icons). So a single icon set would contain all those variants of
1735 * the icon, and you might add a separate source for each one.
1737 * You should nearly always add a "default" icon source with all
1738 * fields wildcarded, which will be used as a fallback if no more
1739 * specific source matches. #GtkIconSet always prefers more specific
1740 * icon sources to more generic icon sources. The order in which you
1741 * add the sources to the icon set does not matter.
1743 * gtk_icon_set_new_from_pixbuf() creates a new icon set with a
1744 * default icon source based on the given pixbuf.
1747 gtk_icon_set_add_source (GtkIconSet *icon_set,
1748 const GtkIconSource *source)
1750 g_return_if_fail (icon_set != NULL);
1751 g_return_if_fail (source != NULL);
1753 if (source->type == GTK_ICON_SOURCE_EMPTY)
1755 g_warning ("Useless empty GtkIconSource");
1759 icon_set->sources = g_slist_insert_sorted (icon_set->sources,
1760 gtk_icon_source_copy (source),
1761 icon_source_compare);
1765 * gtk_icon_set_get_sizes:
1766 * @icon_set: a #GtkIconSet
1767 * @sizes: (array length=n_sizes) (out) (type int): return location
1768 * for array of sizes
1769 * @n_sizes: location to store number of elements in returned array
1771 * Obtains a list of icon sizes this icon set can render. The returned
1772 * array must be freed with g_free().
1775 gtk_icon_set_get_sizes (GtkIconSet *icon_set,
1776 GtkIconSize **sizes,
1780 gboolean all_sizes = FALSE;
1781 GSList *specifics = NULL;
1783 g_return_if_fail (icon_set != NULL);
1784 g_return_if_fail (sizes != NULL);
1785 g_return_if_fail (n_sizes != NULL);
1787 tmp_list = icon_set->sources;
1788 while (tmp_list != NULL)
1790 GtkIconSource *source;
1792 source = tmp_list->data;
1794 if (source->any_size)
1800 specifics = g_slist_prepend (specifics, GINT_TO_POINTER (source->size));
1802 tmp_list = g_slist_next (tmp_list);
1807 /* Need to find out what sizes exist */
1812 *sizes = g_new (GtkIconSize, icon_sizes_used);
1813 *n_sizes = icon_sizes_used - 1;
1816 while (i < icon_sizes_used)
1818 (*sizes)[i - 1] = icon_sizes[i].size;
1826 *n_sizes = g_slist_length (specifics);
1827 *sizes = g_new (GtkIconSize, *n_sizes);
1830 tmp_list = specifics;
1831 while (tmp_list != NULL)
1833 (*sizes)[i] = GPOINTER_TO_INT (tmp_list->data);
1836 tmp_list = g_slist_next (tmp_list);
1840 g_slist_free (specifics);
1845 * gtk_icon_source_new:
1847 * Creates a new #GtkIconSource. A #GtkIconSource contains a #GdkPixbuf (or
1848 * image filename) that serves as the base image for one or more of the
1849 * icons in a #GtkIconSet, along with a specification for which icons in the
1850 * icon set will be based on that pixbuf or image file. An icon set contains
1851 * a set of icons that represent "the same" logical concept in different states,
1852 * different global text directions, and different sizes.
1854 * So for example a web browser's "Back to Previous Page" icon might
1855 * point in a different direction in Hebrew and in English; it might
1856 * look different when insensitive; and it might change size depending
1857 * on toolbar mode (small/large icons). So a single icon set would
1858 * contain all those variants of the icon. #GtkIconSet contains a list
1859 * of #GtkIconSource from which it can derive specific icon variants in
1862 * In the simplest case, #GtkIconSet contains one source pixbuf from
1863 * which it derives all variants. The convenience function
1864 * gtk_icon_set_new_from_pixbuf() handles this case; if you only have
1865 * one source pixbuf, just use that function.
1867 * If you want to use a different base pixbuf for different icon
1868 * variants, you create multiple icon sources, mark which variants
1869 * they'll be used to create, and add them to the icon set with
1870 * gtk_icon_set_add_source().
1872 * By default, the icon source has all parameters wildcarded. That is,
1873 * the icon source will be used as the base icon for any desired text
1874 * direction, widget state, or icon size.
1876 * Return value: a new #GtkIconSource
1879 gtk_icon_source_new (void)
1883 src = g_new0 (GtkIconSource, 1);
1885 src->direction = GTK_TEXT_DIR_NONE;
1886 src->size = GTK_ICON_SIZE_INVALID;
1887 src->state = GTK_STATE_NORMAL;
1889 src->any_direction = TRUE;
1890 src->any_state = TRUE;
1891 src->any_size = TRUE;
1897 * gtk_icon_source_copy:
1898 * @source: a #GtkIconSource
1900 * Creates a copy of @source; mostly useful for language bindings.
1902 * Return value: a new #GtkIconSource
1905 gtk_icon_source_copy (const GtkIconSource *source)
1907 GtkIconSource *copy;
1909 g_return_val_if_fail (source != NULL, NULL);
1911 copy = g_new (GtkIconSource, 1);
1917 case GTK_ICON_SOURCE_EMPTY:
1918 case GTK_ICON_SOURCE_STATIC_ICON_NAME:
1920 case GTK_ICON_SOURCE_ICON_NAME:
1921 copy->source.icon_name = g_strdup (copy->source.icon_name);
1923 case GTK_ICON_SOURCE_FILENAME:
1924 copy->source.filename = g_strdup (copy->source.filename);
1925 #if defined (G_OS_WIN32) && !defined (_WIN64)
1926 copy->cp_filename = g_strdup (copy->cp_filename);
1928 if (copy->filename_pixbuf)
1929 g_object_ref (copy->filename_pixbuf);
1931 case GTK_ICON_SOURCE_PIXBUF:
1932 g_object_ref (copy->source.pixbuf);
1935 g_assert_not_reached();
1942 * gtk_icon_source_free:
1943 * @source: a #GtkIconSource
1945 * Frees a dynamically-allocated icon source, along with its
1946 * filename, size, and pixbuf fields if those are not %NULL.
1949 gtk_icon_source_free (GtkIconSource *source)
1951 g_return_if_fail (source != NULL);
1953 icon_source_clear (source);
1958 gtk_icon_source_get_type (void)
1960 static GType our_type = 0;
1963 our_type = g_boxed_type_register_static (I_("GtkIconSource"),
1964 (GBoxedCopyFunc) gtk_icon_source_copy,
1965 (GBoxedFreeFunc) gtk_icon_source_free);
1971 icon_source_clear (GtkIconSource *source)
1973 switch (source->type)
1975 case GTK_ICON_SOURCE_EMPTY:
1977 case GTK_ICON_SOURCE_ICON_NAME:
1978 g_free (source->source.icon_name);
1980 case GTK_ICON_SOURCE_STATIC_ICON_NAME:
1981 source->source.icon_name = NULL;
1983 case GTK_ICON_SOURCE_FILENAME:
1984 g_free (source->source.filename);
1985 source->source.filename = NULL;
1986 #if defined (G_OS_WIN32) && !defined (_WIN64)
1987 g_free (source->cp_filename);
1988 source->cp_filename = NULL;
1990 if (source->filename_pixbuf)
1991 g_object_unref (source->filename_pixbuf);
1992 source->filename_pixbuf = NULL;
1994 case GTK_ICON_SOURCE_PIXBUF:
1995 g_object_unref (source->source.pixbuf);
1996 source->source.pixbuf = NULL;
1999 g_assert_not_reached();
2002 source->type = GTK_ICON_SOURCE_EMPTY;
2006 * gtk_icon_source_set_filename:
2007 * @source: a #GtkIconSource
2008 * @filename: image file to use
2010 * Sets the name of an image file to use as a base image when creating
2011 * icon variants for #GtkIconSet. The filename must be absolute.
2014 gtk_icon_source_set_filename (GtkIconSource *source,
2015 const gchar *filename)
2017 g_return_if_fail (source != NULL);
2018 g_return_if_fail (filename == NULL || g_path_is_absolute (filename));
2020 if (source->type == GTK_ICON_SOURCE_FILENAME &&
2021 source->source.filename == filename)
2024 icon_source_clear (source);
2026 if (filename != NULL)
2028 source->type = GTK_ICON_SOURCE_FILENAME;
2029 source->source.filename = g_strdup (filename);
2030 #if defined (G_OS_WIN32) && !defined (_WIN64)
2031 source->cp_filename = g_locale_from_utf8 (filename, -1, NULL, NULL, NULL);
2037 * gtk_icon_source_set_icon_name
2038 * @source: a #GtkIconSource
2039 * @icon_name: (allow-none): name of icon to use
2041 * Sets the name of an icon to look up in the current icon theme
2042 * to use as a base image when creating icon variants for #GtkIconSet.
2045 gtk_icon_source_set_icon_name (GtkIconSource *source,
2046 const gchar *icon_name)
2048 g_return_if_fail (source != NULL);
2050 if (source->type == GTK_ICON_SOURCE_ICON_NAME &&
2051 source->source.icon_name == icon_name)
2054 icon_source_clear (source);
2056 if (icon_name != NULL)
2058 source->type = GTK_ICON_SOURCE_ICON_NAME;
2059 source->source.icon_name = g_strdup (icon_name);
2064 * gtk_icon_source_set_pixbuf:
2065 * @source: a #GtkIconSource
2066 * @pixbuf: pixbuf to use as a source
2068 * Sets a pixbuf to use as a base image when creating icon variants
2072 gtk_icon_source_set_pixbuf (GtkIconSource *source,
2075 g_return_if_fail (source != NULL);
2076 g_return_if_fail (pixbuf == NULL || GDK_IS_PIXBUF (pixbuf));
2078 if (source->type == GTK_ICON_SOURCE_PIXBUF &&
2079 source->source.pixbuf == pixbuf)
2082 icon_source_clear (source);
2086 source->type = GTK_ICON_SOURCE_PIXBUF;
2087 source->source.pixbuf = g_object_ref (pixbuf);
2092 * gtk_icon_source_get_filename:
2093 * @source: a #GtkIconSource
2095 * Retrieves the source filename, or %NULL if none is set. The
2096 * filename is not a copy, and should not be modified or expected to
2097 * persist beyond the lifetime of the icon source.
2099 * Return value: image filename. This string must not be modified
2102 G_CONST_RETURN gchar*
2103 gtk_icon_source_get_filename (const GtkIconSource *source)
2105 g_return_val_if_fail (source != NULL, NULL);
2107 if (source->type == GTK_ICON_SOURCE_FILENAME)
2108 return source->source.filename;
2114 * gtk_icon_source_get_icon_name:
2115 * @source: a #GtkIconSource
2117 * Retrieves the source icon name, or %NULL if none is set. The
2118 * icon_name is not a copy, and should not be modified or expected to
2119 * persist beyond the lifetime of the icon source.
2121 * Return value: icon name. This string must not be modified or freed.
2123 G_CONST_RETURN gchar*
2124 gtk_icon_source_get_icon_name (const GtkIconSource *source)
2126 g_return_val_if_fail (source != NULL, NULL);
2128 if (source->type == GTK_ICON_SOURCE_ICON_NAME ||
2129 source->type == GTK_ICON_SOURCE_STATIC_ICON_NAME)
2130 return source->source.icon_name;
2136 * gtk_icon_source_get_pixbuf:
2137 * @source: a #GtkIconSource
2139 * Retrieves the source pixbuf, or %NULL if none is set.
2140 * In addition, if a filename source is in use, this
2141 * function in some cases will return the pixbuf from
2142 * loaded from the filename. This is, for example, true
2143 * for the GtkIconSource passed to the GtkStyle::render_icon()
2144 * virtual function. The reference count on the pixbuf is
2147 * Return value: source pixbuf
2150 gtk_icon_source_get_pixbuf (const GtkIconSource *source)
2152 g_return_val_if_fail (source != NULL, NULL);
2154 if (source->type == GTK_ICON_SOURCE_PIXBUF)
2155 return source->source.pixbuf;
2156 else if (source->type == GTK_ICON_SOURCE_FILENAME)
2157 return source->filename_pixbuf;
2163 * gtk_icon_source_set_direction_wildcarded:
2164 * @source: a #GtkIconSource
2165 * @setting: %TRUE to wildcard the text direction
2167 * If the text direction is wildcarded, this source can be used
2168 * as the base image for an icon in any #GtkTextDirection.
2169 * If the text direction is not wildcarded, then the
2170 * text direction the icon source applies to should be set
2171 * with gtk_icon_source_set_direction(), and the icon source
2172 * will only be used with that text direction.
2174 * #GtkIconSet prefers non-wildcarded sources (exact matches) over
2175 * wildcarded sources, and will use an exact match when possible.
2178 gtk_icon_source_set_direction_wildcarded (GtkIconSource *source,
2181 g_return_if_fail (source != NULL);
2183 source->any_direction = setting != FALSE;
2187 * gtk_icon_source_set_state_wildcarded:
2188 * @source: a #GtkIconSource
2189 * @setting: %TRUE to wildcard the widget state
2191 * If the widget state is wildcarded, this source can be used as the
2192 * base image for an icon in any #GtkStateType. If the widget state
2193 * is not wildcarded, then the state the source applies to should be
2194 * set with gtk_icon_source_set_state() and the icon source will
2195 * only be used with that specific state.
2197 * #GtkIconSet prefers non-wildcarded sources (exact matches) over
2198 * wildcarded sources, and will use an exact match when possible.
2200 * #GtkIconSet will normally transform wildcarded source images to
2201 * produce an appropriate icon for a given state, for example
2202 * lightening an image on prelight, but will not modify source images
2203 * that match exactly.
2206 gtk_icon_source_set_state_wildcarded (GtkIconSource *source,
2209 g_return_if_fail (source != NULL);
2211 source->any_state = setting != FALSE;
2216 * gtk_icon_source_set_size_wildcarded:
2217 * @source: a #GtkIconSource
2218 * @setting: %TRUE to wildcard the widget state
2220 * If the icon size is wildcarded, this source can be used as the base
2221 * image for an icon of any size. If the size is not wildcarded, then
2222 * the size the source applies to should be set with
2223 * gtk_icon_source_set_size() and the icon source will only be used
2224 * with that specific size.
2226 * #GtkIconSet prefers non-wildcarded sources (exact matches) over
2227 * wildcarded sources, and will use an exact match when possible.
2229 * #GtkIconSet will normally scale wildcarded source images to produce
2230 * an appropriate icon at a given size, but will not change the size
2231 * of source images that match exactly.
2234 gtk_icon_source_set_size_wildcarded (GtkIconSource *source,
2237 g_return_if_fail (source != NULL);
2239 source->any_size = setting != FALSE;
2243 * gtk_icon_source_get_size_wildcarded:
2244 * @source: a #GtkIconSource
2246 * Gets the value set by gtk_icon_source_set_size_wildcarded().
2248 * Return value: %TRUE if this icon source is a base for any icon size variant
2251 gtk_icon_source_get_size_wildcarded (const GtkIconSource *source)
2253 g_return_val_if_fail (source != NULL, TRUE);
2255 return source->any_size;
2259 * gtk_icon_source_get_state_wildcarded:
2260 * @source: a #GtkIconSource
2262 * Gets the value set by gtk_icon_source_set_state_wildcarded().
2264 * Return value: %TRUE if this icon source is a base for any widget state variant
2267 gtk_icon_source_get_state_wildcarded (const GtkIconSource *source)
2269 g_return_val_if_fail (source != NULL, TRUE);
2271 return source->any_state;
2275 * gtk_icon_source_get_direction_wildcarded:
2276 * @source: a #GtkIconSource
2278 * Gets the value set by gtk_icon_source_set_direction_wildcarded().
2280 * Return value: %TRUE if this icon source is a base for any text direction variant
2283 gtk_icon_source_get_direction_wildcarded (const GtkIconSource *source)
2285 g_return_val_if_fail (source != NULL, TRUE);
2287 return source->any_direction;
2291 * gtk_icon_source_set_direction:
2292 * @source: a #GtkIconSource
2293 * @direction: text direction this source applies to
2295 * Sets the text direction this icon source is intended to be used
2298 * Setting the text direction on an icon source makes no difference
2299 * if the text direction is wildcarded. Therefore, you should usually
2300 * call gtk_icon_source_set_direction_wildcarded() to un-wildcard it
2301 * in addition to calling this function.
2304 gtk_icon_source_set_direction (GtkIconSource *source,
2305 GtkTextDirection direction)
2307 g_return_if_fail (source != NULL);
2309 source->direction = direction;
2313 * gtk_icon_source_set_state:
2314 * @source: a #GtkIconSource
2315 * @state: widget state this source applies to
2317 * Sets the widget state this icon source is intended to be used
2320 * Setting the widget state on an icon source makes no difference
2321 * if the state is wildcarded. Therefore, you should usually
2322 * call gtk_icon_source_set_state_wildcarded() to un-wildcard it
2323 * in addition to calling this function.
2326 gtk_icon_source_set_state (GtkIconSource *source,
2329 g_return_if_fail (source != NULL);
2331 source->state = state;
2335 * gtk_icon_source_set_size:
2336 * @source: a #GtkIconSource
2337 * @size: (type int): icon size this source applies to
2339 * Sets the icon size this icon source is intended to be used
2342 * Setting the icon size on an icon source makes no difference
2343 * if the size is wildcarded. Therefore, you should usually
2344 * call gtk_icon_source_set_size_wildcarded() to un-wildcard it
2345 * in addition to calling this function.
2348 gtk_icon_source_set_size (GtkIconSource *source,
2351 g_return_if_fail (source != NULL);
2353 source->size = size;
2357 * gtk_icon_source_get_direction:
2358 * @source: a #GtkIconSource
2360 * Obtains the text direction this icon source applies to. The return
2361 * value is only useful/meaningful if the text direction is <emphasis>not</emphasis>
2364 * Return value: text direction this source matches
2367 gtk_icon_source_get_direction (const GtkIconSource *source)
2369 g_return_val_if_fail (source != NULL, 0);
2371 return source->direction;
2375 * gtk_icon_source_get_state:
2376 * @source: a #GtkIconSource
2378 * Obtains the widget state this icon source applies to. The return
2379 * value is only useful/meaningful if the widget state is <emphasis>not</emphasis>
2382 * Return value: widget state this source matches
2385 gtk_icon_source_get_state (const GtkIconSource *source)
2387 g_return_val_if_fail (source != NULL, 0);
2389 return source->state;
2393 * gtk_icon_source_get_size:
2394 * @source: a #GtkIconSource
2396 * Obtains the icon size this source applies to. The return value
2397 * is only useful/meaningful if the icon size is <emphasis>not</emphasis> wildcarded.
2399 * Return value: (type int): icon size this source matches.
2402 gtk_icon_source_get_size (const GtkIconSource *source)
2404 g_return_val_if_fail (source != NULL, 0);
2406 return source->size;
2409 #define NUM_CACHED_ICONS 8
2411 typedef struct _CachedIcon CachedIcon;
2415 /* These must all match to use the cached pixbuf.
2416 * If any don't match, we must re-render the pixbuf.
2419 GtkTextDirection direction;
2427 ensure_cache_up_to_date (GtkIconSet *icon_set)
2429 if (icon_set->cache_serial != cache_serial)
2431 clear_cache (icon_set, TRUE);
2432 icon_set->cache_serial = cache_serial;
2437 cached_icon_free (CachedIcon *icon)
2439 g_object_unref (icon->pixbuf);
2442 g_object_unref (icon->style);
2448 find_in_cache (GtkIconSet *icon_set,
2450 GtkTextDirection direction,
2457 ensure_cache_up_to_date (icon_set);
2460 tmp_list = icon_set->cache;
2461 while (tmp_list != NULL)
2463 CachedIcon *icon = tmp_list->data;
2465 if (icon->style == style &&
2466 icon->direction == direction &&
2467 icon->state == state &&
2468 (size == (GtkIconSize)-1 || icon->size == size))
2472 /* Move this icon to the front of the list. */
2473 prev->next = tmp_list->next;
2474 tmp_list->next = icon_set->cache;
2475 icon_set->cache = tmp_list;
2478 return icon->pixbuf;
2482 tmp_list = g_slist_next (tmp_list);
2489 add_to_cache (GtkIconSet *icon_set,
2491 GtkTextDirection direction,
2498 ensure_cache_up_to_date (icon_set);
2500 g_object_ref (pixbuf);
2502 /* We have to ref the style, since if the style was finalized
2503 * its address could be reused by another style, creating a
2508 g_object_ref (style);
2510 icon = g_new (CachedIcon, 1);
2511 icon_set->cache = g_slist_prepend (icon_set->cache, icon);
2512 icon_set->cache_size++;
2514 icon->style = style;
2515 icon->direction = direction;
2516 icon->state = state;
2518 icon->pixbuf = pixbuf;
2521 attach_to_style (icon_set, icon->style);
2523 if (icon_set->cache_size >= NUM_CACHED_ICONS)
2525 /* Remove oldest item in the cache */
2528 tmp_list = icon_set->cache;
2530 /* Find next-to-last link */
2531 g_assert (NUM_CACHED_ICONS > 2);
2532 while (tmp_list->next->next)
2533 tmp_list = tmp_list->next;
2535 g_assert (tmp_list != NULL);
2536 g_assert (tmp_list->next != NULL);
2537 g_assert (tmp_list->next->next == NULL);
2539 /* Free the last icon */
2540 icon = tmp_list->next->data;
2542 g_slist_free (tmp_list->next);
2543 tmp_list->next = NULL;
2545 cached_icon_free (icon);
2550 clear_cache (GtkIconSet *icon_set,
2551 gboolean style_detach)
2553 GSList *cache, *tmp_list;
2554 GtkStyle *last_style = NULL;
2556 cache = icon_set->cache;
2557 icon_set->cache = NULL;
2558 icon_set->cache_size = 0;
2560 while (tmp_list != NULL)
2562 CachedIcon *icon = tmp_list->data;
2566 /* simple optimization for the case where the cache
2567 * contains contiguous icons from the same style.
2568 * it's safe to call detach_from_style more than
2569 * once on the same style though.
2571 if (last_style != icon->style)
2573 detach_from_style (icon_set, icon->style);
2574 last_style = icon->style;
2578 cached_icon_free (icon);
2580 tmp_list = g_slist_next (tmp_list);
2583 g_slist_free (cache);
2587 copy_cache (GtkIconSet *icon_set,
2588 GtkIconSet *copy_recipient)
2591 GSList *copy = NULL;
2593 ensure_cache_up_to_date (icon_set);
2595 tmp_list = icon_set->cache;
2596 while (tmp_list != NULL)
2598 CachedIcon *icon = tmp_list->data;
2599 CachedIcon *icon_copy = g_new (CachedIcon, 1);
2603 if (icon_copy->style)
2605 attach_to_style (copy_recipient, icon_copy->style);
2606 g_object_ref (icon_copy->style);
2609 g_object_ref (icon_copy->pixbuf);
2611 icon_copy->size = icon->size;
2613 copy = g_slist_prepend (copy, icon_copy);
2615 tmp_list = g_slist_next (tmp_list);
2618 return g_slist_reverse (copy);
2622 attach_to_style (GtkIconSet *icon_set,
2627 table = g_object_get_qdata (G_OBJECT (style),
2628 g_quark_try_string ("gtk-style-icon-sets"));
2632 table = g_hash_table_new (NULL, NULL);
2633 g_object_set_qdata_full (G_OBJECT (style),
2634 g_quark_from_static_string ("gtk-style-icon-sets"),
2639 g_hash_table_insert (table, icon_set, icon_set);
2643 detach_from_style (GtkIconSet *icon_set,
2648 table = g_object_get_qdata (G_OBJECT (style),
2649 g_quark_try_string ("gtk-style-icon-sets"));
2652 g_hash_table_remove (table, icon_set);
2656 iconsets_foreach (gpointer key,
2660 GtkIconSet *icon_set = key;
2662 /* We only need to remove cache entries for the given style;
2663 * but that complicates things because in destroy notify
2664 * we don't know which style got destroyed, and 95% of the
2665 * time all cache entries will have the same style,
2666 * so this is faster anyway.
2669 clear_cache (icon_set, FALSE);
2673 style_dnotify (gpointer data)
2675 GHashTable *table = data;
2677 g_hash_table_foreach (table, iconsets_foreach, NULL);
2679 g_hash_table_destroy (table);
2682 /* This allows the icon set to detect that its cache is out of date. */
2684 _gtk_icon_set_invalidate_caches (void)
2690 * _gtk_icon_factory_list_ids:
2692 * Gets all known IDs stored in an existing icon factory.
2693 * The strings in the returned list aren't copied.
2694 * The list itself should be freed.
2696 * Return value: List of ids in icon factories
2699 _gtk_icon_factory_list_ids (void)
2706 _gtk_icon_factory_ensure_default_icons ();
2708 tmp_list = all_icon_factories;
2709 while (tmp_list != NULL)
2713 GtkIconFactory *factory = GTK_ICON_FACTORY (tmp_list->data);
2715 these_ids = g_hash_table_get_keys (factory->icons);
2717 ids = g_list_concat (ids, these_ids);
2719 tmp_list = g_slist_next (tmp_list);
2729 } IconFactoryParserData;
2735 GtkTextDirection direction;
2738 } IconSourceParserData;
2741 icon_source_start_element (GMarkupParseContext *context,
2742 const gchar *element_name,
2743 const gchar **names,
2744 const gchar **values,
2749 gchar *stock_id = NULL;
2750 gchar *filename = NULL;
2751 gchar *icon_name = NULL;
2753 gint direction = -1;
2755 IconFactoryParserData *parser_data;
2756 IconSourceParserData *source_data;
2758 GQuark error_domain;
2760 parser_data = (IconFactoryParserData*)user_data;
2762 if (!parser_data->in_source)
2764 if (strcmp (element_name, "sources") != 0)
2766 error_msg = g_strdup_printf ("Unexpected element %s, expected <sources>", element_name);
2767 error_domain = GTK_BUILDER_ERROR_INVALID_TAG;
2770 parser_data->in_source = TRUE;
2775 if (strcmp (element_name, "source") != 0)
2777 error_msg = g_strdup_printf ("Unexpected element %s, expected <source>", element_name);
2778 error_domain = GTK_BUILDER_ERROR_INVALID_TAG;
2783 for (i = 0; names[i]; i++)
2785 if (strcmp (names[i], "stock-id") == 0)
2786 stock_id = g_strdup (values[i]);
2787 else if (strcmp (names[i], "filename") == 0)
2788 filename = g_strdup (values[i]);
2789 else if (strcmp (names[i], "icon-name") == 0)
2790 icon_name = g_strdup (values[i]);
2791 else if (strcmp (names[i], "size") == 0)
2793 if (!_gtk_builder_enum_from_string (GTK_TYPE_ICON_SIZE,
2799 else if (strcmp (names[i], "direction") == 0)
2801 if (!_gtk_builder_enum_from_string (GTK_TYPE_TEXT_DIRECTION,
2807 else if (strcmp (names[i], "state") == 0)
2809 if (!_gtk_builder_enum_from_string (GTK_TYPE_STATE_TYPE,
2817 error_msg = g_strdup_printf ("'%s' is not a valid attribute of <%s>",
2818 names[i], "source");
2819 error_domain = GTK_BUILDER_ERROR_INVALID_ATTRIBUTE;
2826 error_msg = g_strdup_printf ("<source> requires a stock_id");
2827 error_domain = GTK_BUILDER_ERROR_MISSING_ATTRIBUTE;
2831 source_data = g_slice_new (IconSourceParserData);
2832 source_data->stock_id = stock_id;
2833 source_data->filename = filename;
2834 source_data->icon_name = icon_name;
2835 source_data->size = size;
2836 source_data->direction = direction;
2837 source_data->state = state;
2839 parser_data->sources = g_slist_prepend (parser_data->sources, source_data);
2845 gint line_number, char_number;
2847 g_markup_parse_context_get_position (context,
2851 tmp = g_strdup_printf ("%s:%d:%d %s", "input",
2852 line_number, char_number, error_msg);
2854 g_set_error_literal (error,
2859 g_warning ("%s", tmp);
2869 static const GMarkupParser icon_source_parser =
2871 icon_source_start_element,
2875 gtk_icon_factory_buildable_custom_tag_start (GtkBuildable *buildable,
2876 GtkBuilder *builder,
2878 const gchar *tagname,
2879 GMarkupParser *parser,
2882 g_assert (buildable);
2884 if (strcmp (tagname, "sources") == 0)
2886 IconFactoryParserData *parser_data;
2888 parser_data = g_slice_new0 (IconFactoryParserData);
2889 *parser = icon_source_parser;
2890 *data = parser_data;
2897 gtk_icon_factory_buildable_custom_tag_end (GtkBuildable *buildable,
2898 GtkBuilder *builder,
2900 const gchar *tagname,
2901 gpointer *user_data)
2903 GtkIconFactory *icon_factory;
2905 icon_factory = GTK_ICON_FACTORY (buildable);
2907 if (strcmp (tagname, "sources") == 0)
2909 IconFactoryParserData *parser_data;
2910 GtkIconSource *icon_source;
2911 GtkIconSet *icon_set;
2914 parser_data = (IconFactoryParserData*)user_data;
2916 for (l = parser_data->sources; l; l = l->next)
2918 IconSourceParserData *source_data = l->data;
2920 icon_set = gtk_icon_factory_lookup (icon_factory, source_data->stock_id);
2923 icon_set = gtk_icon_set_new ();
2924 gtk_icon_factory_add (icon_factory, source_data->stock_id, icon_set);
2925 gtk_icon_set_unref (icon_set);
2928 icon_source = gtk_icon_source_new ();
2930 if (source_data->filename)
2933 filename = _gtk_builder_get_absolute_filename (builder, source_data->filename);
2934 gtk_icon_source_set_filename (icon_source, filename);
2937 if (source_data->icon_name)
2938 gtk_icon_source_set_icon_name (icon_source, source_data->icon_name);
2939 if (source_data->size != -1)
2941 gtk_icon_source_set_size (icon_source, source_data->size);
2942 gtk_icon_source_set_size_wildcarded (icon_source, FALSE);
2944 if (source_data->direction != -1)
2946 gtk_icon_source_set_direction (icon_source, source_data->direction);
2947 gtk_icon_source_set_direction_wildcarded (icon_source, FALSE);
2949 if (source_data->state != -1)
2951 gtk_icon_source_set_state (icon_source, source_data->state);
2952 gtk_icon_source_set_state_wildcarded (icon_source, FALSE);
2955 /* Inline source_add() to avoid creating a copy */
2956 g_assert (icon_source->type != GTK_ICON_SOURCE_EMPTY);
2957 icon_set->sources = g_slist_insert_sorted (icon_set->sources,
2959 icon_source_compare);
2961 g_free (source_data->stock_id);
2962 g_free (source_data->filename);
2963 g_free (source_data->icon_name);
2964 g_slice_free (IconSourceParserData, source_data);
2966 g_slist_free (parser_data->sources);
2967 g_slice_free (IconFactoryParserData, parser_data);
2969 /* TODO: Add an attribute/tag to prevent this.
2970 * Usually it's the right thing to do though.
2972 gtk_icon_factory_add_default (icon_factory);
2976 #if defined (G_OS_WIN32) && !defined (_WIN64)
2978 /* DLL ABI stability backward compatibility versions */
2980 #undef gtk_icon_source_set_filename
2983 gtk_icon_source_set_filename (GtkIconSource *source,
2984 const gchar *filename)
2986 gchar *utf8_filename = g_locale_to_utf8 (filename, -1, NULL, NULL, NULL);
2988 gtk_icon_source_set_filename_utf8 (source, utf8_filename);
2990 g_free (utf8_filename);
2993 #undef gtk_icon_source_get_filename
2995 G_CONST_RETURN gchar*
2996 gtk_icon_source_get_filename (const GtkIconSource *source)
2998 g_return_val_if_fail (source != NULL, NULL);
3000 if (source->type == GTK_ICON_SOURCE_FILENAME)
3001 return source->cp_filename;
3008 #define __GTK_ICON_FACTORY_C__
3009 #include "gtkaliasdef.c"