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"
43 static GSList *all_icon_factories = NULL;
45 struct _GtkIconFactoryPriv
51 GTK_ICON_SOURCE_EMPTY,
52 GTK_ICON_SOURCE_ICON_NAME,
53 GTK_ICON_SOURCE_STATIC_ICON_NAME,
54 GTK_ICON_SOURCE_FILENAME,
55 GTK_ICON_SOURCE_PIXBUF
60 GtkIconSourceType type;
68 GdkPixbuf *filename_pixbuf;
70 GtkTextDirection direction;
74 /* If TRUE, then the parameter is wildcarded, and the above
75 * fields should be ignored. If FALSE, the parameter is
76 * specified, and the above fields should be valid.
78 guint any_direction : 1;
82 #if defined (G_OS_WIN32) && !defined (_WIN64)
83 /* System codepage version of filename, for DLL ABI backward
84 * compatibility functions.
92 gtk_icon_factory_buildable_init (GtkBuildableIface *iface);
94 static gboolean gtk_icon_factory_buildable_custom_tag_start (GtkBuildable *buildable,
98 GMarkupParser *parser,
100 static void gtk_icon_factory_buildable_custom_tag_end (GtkBuildable *buildable,
103 const gchar *tagname,
104 gpointer *user_data);
105 static void gtk_icon_factory_finalize (GObject *object);
106 static void get_default_icons (GtkIconFactory *icon_factory);
107 static void icon_source_clear (GtkIconSource *source);
109 static GtkIconSize icon_size_register_intern (const gchar *name,
113 #define GTK_ICON_SOURCE_INIT(any_direction, any_state, any_size) \
114 { GTK_ICON_SOURCE_EMPTY, { NULL }, NULL, \
116 any_direction, any_state, any_size }
118 G_DEFINE_TYPE_WITH_CODE (GtkIconFactory, gtk_icon_factory, G_TYPE_OBJECT,
119 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
120 gtk_icon_factory_buildable_init))
123 gtk_icon_factory_init (GtkIconFactory *factory)
125 GtkIconFactoryPriv *priv;
127 factory->priv = G_TYPE_INSTANCE_GET_PRIVATE (factory,
128 GTK_TYPE_ICON_FACTORY,
130 priv = factory->priv;
132 priv->icons = g_hash_table_new (g_str_hash, g_str_equal);
133 all_icon_factories = g_slist_prepend (all_icon_factories, factory);
137 gtk_icon_factory_class_init (GtkIconFactoryClass *klass)
139 GObjectClass *object_class = G_OBJECT_CLASS (klass);
141 object_class->finalize = gtk_icon_factory_finalize;
143 g_type_class_add_private (klass, sizeof (GtkIconFactoryPriv));
147 gtk_icon_factory_buildable_init (GtkBuildableIface *iface)
149 iface->custom_tag_start = gtk_icon_factory_buildable_custom_tag_start;
150 iface->custom_tag_end = gtk_icon_factory_buildable_custom_tag_end;
154 free_icon_set (gpointer key, gpointer value, gpointer data)
157 gtk_icon_set_unref (value);
161 gtk_icon_factory_finalize (GObject *object)
163 GtkIconFactory *factory = GTK_ICON_FACTORY (object);
164 GtkIconFactoryPriv *priv = factory->priv;
166 all_icon_factories = g_slist_remove (all_icon_factories, factory);
168 g_hash_table_foreach (priv->icons, free_icon_set, NULL);
170 g_hash_table_destroy (priv->icons);
172 G_OBJECT_CLASS (gtk_icon_factory_parent_class)->finalize (object);
176 * gtk_icon_factory_new:
178 * Creates a new #GtkIconFactory. An icon factory manages a collection
179 * of #GtkIconSet<!-- -->s; a #GtkIconSet manages a set of variants of a
180 * particular icon (i.e. a #GtkIconSet contains variants for different
181 * sizes and widget states). Icons in an icon factory are named by a
182 * stock ID, which is a simple string identifying the icon. Each
183 * #GtkStyle has a list of #GtkIconFactory<!-- -->s derived from the current
184 * theme; those icon factories are consulted first when searching for
185 * an icon. If the theme doesn't set a particular icon, GTK+ looks for
186 * the icon in a list of default icon factories, maintained by
187 * gtk_icon_factory_add_default() and
188 * gtk_icon_factory_remove_default(). Applications with icons should
189 * add a default icon factory with their icons, which will allow
190 * themes to override the icons for the application.
192 * Return value: a new #GtkIconFactory
195 gtk_icon_factory_new (void)
197 return g_object_new (GTK_TYPE_ICON_FACTORY, NULL);
201 * gtk_icon_factory_add:
202 * @factory: a #GtkIconFactory
203 * @stock_id: icon name
204 * @icon_set: icon set
206 * Adds the given @icon_set to the icon factory, under the name
207 * @stock_id. @stock_id should be namespaced for your application,
208 * e.g. "myapp-whatever-icon". Normally applications create a
209 * #GtkIconFactory, then add it to the list of default factories with
210 * gtk_icon_factory_add_default(). Then they pass the @stock_id to
211 * widgets such as #GtkImage to display the icon. Themes can provide
212 * an icon with the same name (such as "myapp-whatever-icon") to
213 * override your application's default icons. If an icon already
214 * existed in @factory for @stock_id, it is unreferenced and replaced
215 * with the new @icon_set.
218 gtk_icon_factory_add (GtkIconFactory *factory,
219 const gchar *stock_id,
220 GtkIconSet *icon_set)
222 GtkIconFactoryPriv *priv = factory->priv;
223 gpointer old_key = NULL;
224 gpointer old_value = NULL;
226 g_return_if_fail (GTK_IS_ICON_FACTORY (factory));
227 g_return_if_fail (stock_id != NULL);
228 g_return_if_fail (icon_set != NULL);
230 g_hash_table_lookup_extended (priv->icons, stock_id,
231 &old_key, &old_value);
233 if (old_value == icon_set)
236 gtk_icon_set_ref (icon_set);
238 /* GHashTable key memory management is so fantastically broken. */
240 g_hash_table_insert (priv->icons, old_key, icon_set);
242 g_hash_table_insert (priv->icons, g_strdup (stock_id), icon_set);
245 gtk_icon_set_unref (old_value);
249 * gtk_icon_factory_lookup:
250 * @factory: a #GtkIconFactory
251 * @stock_id: an icon name
253 * Looks up @stock_id in the icon factory, returning an icon set
254 * if found, otherwise %NULL. For display to the user, you should
255 * use gtk_style_lookup_icon_set() on the #GtkStyle for the
256 * widget that will display the icon, instead of using this
257 * function directly, so that themes are taken into account.
259 * Return value: icon set of @stock_id.
262 gtk_icon_factory_lookup (GtkIconFactory *factory,
263 const gchar *stock_id)
265 GtkIconFactoryPriv *priv;
267 g_return_val_if_fail (GTK_IS_ICON_FACTORY (factory), NULL);
268 g_return_val_if_fail (stock_id != NULL, NULL);
270 priv = factory->priv;
272 return g_hash_table_lookup (priv->icons, stock_id);
275 static GtkIconFactory *gtk_default_icons = NULL;
276 static GSList *default_factories = NULL;
279 * gtk_icon_factory_add_default:
280 * @factory: a #GtkIconFactory
282 * Adds an icon factory to the list of icon factories searched by
283 * gtk_style_lookup_icon_set(). This means that, for example,
284 * gtk_image_new_from_stock() will be able to find icons in @factory.
285 * There will normally be an icon factory added for each library or
286 * application that comes with icons. The default icon factories
287 * can be overridden by themes.
290 gtk_icon_factory_add_default (GtkIconFactory *factory)
292 g_return_if_fail (GTK_IS_ICON_FACTORY (factory));
294 g_object_ref (factory);
296 default_factories = g_slist_prepend (default_factories, factory);
300 * gtk_icon_factory_remove_default:
301 * @factory: a #GtkIconFactory previously added with gtk_icon_factory_add_default()
303 * Removes an icon factory from the list of default icon
304 * factories. Not normally used; you might use it for a library that
305 * can be unloaded or shut down.
308 gtk_icon_factory_remove_default (GtkIconFactory *factory)
310 g_return_if_fail (GTK_IS_ICON_FACTORY (factory));
312 default_factories = g_slist_remove (default_factories, factory);
314 g_object_unref (factory);
318 _gtk_icon_factory_ensure_default_icons (void)
320 if (gtk_default_icons == NULL)
322 gtk_default_icons = gtk_icon_factory_new ();
324 get_default_icons (gtk_default_icons);
329 * gtk_icon_factory_lookup_default:
330 * @stock_id: an icon name
332 * Looks for an icon in the list of default icon factories. For
333 * display to the user, you should use gtk_style_lookup_icon_set() on
334 * the #GtkStyle for the widget that will display the icon, instead of
335 * using this function directly, so that themes are taken into
338 * Return value: a #GtkIconSet, or %NULL
341 gtk_icon_factory_lookup_default (const gchar *stock_id)
345 g_return_val_if_fail (stock_id != NULL, NULL);
347 tmp_list = default_factories;
348 while (tmp_list != NULL)
350 GtkIconSet *icon_set =
351 gtk_icon_factory_lookup (GTK_ICON_FACTORY (tmp_list->data),
357 tmp_list = g_slist_next (tmp_list);
360 _gtk_icon_factory_ensure_default_icons ();
362 return gtk_icon_factory_lookup (gtk_default_icons, stock_id);
366 register_stock_icon (GtkIconFactory *factory,
367 const gchar *stock_id)
369 GtkIconSet *set = gtk_icon_set_new ();
370 GtkIconSource source = GTK_ICON_SOURCE_INIT (TRUE, TRUE, TRUE);
372 source.type = GTK_ICON_SOURCE_STATIC_ICON_NAME;
373 source.source.icon_name = (gchar *)stock_id;
374 gtk_icon_set_add_source (set, &source);
376 gtk_icon_factory_add (factory, stock_id, set);
377 gtk_icon_set_unref (set);
381 register_bidi_stock_icon (GtkIconFactory *factory,
382 const gchar *stock_id,
383 const gchar *stock_id_ltr,
384 const gchar *stock_id_rtl)
386 GtkIconSet *set = gtk_icon_set_new ();
387 GtkIconSource source = GTK_ICON_SOURCE_INIT (FALSE, TRUE, TRUE);
389 source.type = GTK_ICON_SOURCE_STATIC_ICON_NAME;
390 source.source.icon_name = (gchar *)stock_id_ltr;
391 source.direction = GTK_TEXT_DIR_LTR;
392 gtk_icon_set_add_source (set, &source);
394 source.type = GTK_ICON_SOURCE_STATIC_ICON_NAME;
395 source.source.icon_name = (gchar *)stock_id_rtl;
396 source.direction = GTK_TEXT_DIR_RTL;
397 gtk_icon_set_add_source (set, &source);
399 gtk_icon_factory_add (factory, stock_id, set);
400 gtk_icon_set_unref (set);
404 get_default_icons (GtkIconFactory *factory)
406 /* KEEP IN SYNC with gtkstock.c */
408 register_stock_icon (factory, GTK_STOCK_DIALOG_AUTHENTICATION);
409 register_stock_icon (factory, GTK_STOCK_DIALOG_ERROR);
410 register_stock_icon (factory, GTK_STOCK_DIALOG_INFO);
411 register_stock_icon (factory, GTK_STOCK_DIALOG_QUESTION);
412 register_stock_icon (factory, GTK_STOCK_DIALOG_WARNING);
413 register_stock_icon (factory, GTK_STOCK_DND);
414 register_stock_icon (factory, GTK_STOCK_DND_MULTIPLE);
415 register_stock_icon (factory, GTK_STOCK_APPLY);
416 register_stock_icon (factory, GTK_STOCK_CANCEL);
417 register_stock_icon (factory, GTK_STOCK_NO);
418 register_stock_icon (factory, GTK_STOCK_OK);
419 register_stock_icon (factory, GTK_STOCK_YES);
420 register_stock_icon (factory, GTK_STOCK_CLOSE);
421 register_stock_icon (factory, GTK_STOCK_ADD);
422 register_stock_icon (factory, GTK_STOCK_JUSTIFY_CENTER);
423 register_stock_icon (factory, GTK_STOCK_JUSTIFY_FILL);
424 register_stock_icon (factory, GTK_STOCK_JUSTIFY_LEFT);
425 register_stock_icon (factory, GTK_STOCK_JUSTIFY_RIGHT);
426 register_stock_icon (factory, GTK_STOCK_GOTO_BOTTOM);
427 register_stock_icon (factory, GTK_STOCK_CDROM);
428 register_stock_icon (factory, GTK_STOCK_CONVERT);
429 register_stock_icon (factory, GTK_STOCK_COPY);
430 register_stock_icon (factory, GTK_STOCK_CUT);
431 register_stock_icon (factory, GTK_STOCK_GO_DOWN);
432 register_stock_icon (factory, GTK_STOCK_EXECUTE);
433 register_stock_icon (factory, GTK_STOCK_QUIT);
434 register_bidi_stock_icon (factory,
435 GTK_STOCK_GOTO_FIRST,
436 GTK_STOCK_GOTO_FIRST "-ltr",
437 GTK_STOCK_GOTO_FIRST "-rtl");
438 register_stock_icon (factory, GTK_STOCK_SELECT_FONT);
439 register_stock_icon (factory, GTK_STOCK_FULLSCREEN);
440 register_stock_icon (factory, GTK_STOCK_LEAVE_FULLSCREEN);
441 register_stock_icon (factory, GTK_STOCK_HARDDISK);
442 register_stock_icon (factory, GTK_STOCK_HELP);
443 register_stock_icon (factory, GTK_STOCK_HOME);
444 register_stock_icon (factory, GTK_STOCK_INFO);
445 register_bidi_stock_icon (factory,
447 GTK_STOCK_JUMP_TO "-ltr",
448 GTK_STOCK_JUMP_TO "-rtl");
449 register_bidi_stock_icon (factory,
451 GTK_STOCK_GOTO_LAST "-ltr",
452 GTK_STOCK_GOTO_LAST "-rtl");
453 register_bidi_stock_icon (factory,
455 GTK_STOCK_GO_BACK "-ltr",
456 GTK_STOCK_GO_BACK "-rtl");
457 register_stock_icon (factory, GTK_STOCK_MISSING_IMAGE);
458 register_stock_icon (factory, GTK_STOCK_NETWORK);
459 register_stock_icon (factory, GTK_STOCK_NEW);
460 register_stock_icon (factory, GTK_STOCK_OPEN);
461 register_stock_icon (factory, GTK_STOCK_ORIENTATION_PORTRAIT);
462 register_stock_icon (factory, GTK_STOCK_ORIENTATION_LANDSCAPE);
463 register_stock_icon (factory, GTK_STOCK_ORIENTATION_REVERSE_PORTRAIT);
464 register_stock_icon (factory, GTK_STOCK_ORIENTATION_REVERSE_LANDSCAPE);
465 register_stock_icon (factory, GTK_STOCK_PAGE_SETUP);
466 register_stock_icon (factory, GTK_STOCK_PASTE);
467 register_stock_icon (factory, GTK_STOCK_PREFERENCES);
468 register_stock_icon (factory, GTK_STOCK_PRINT);
469 register_stock_icon (factory, GTK_STOCK_PRINT_ERROR);
470 register_stock_icon (factory, GTK_STOCK_PRINT_PAUSED);
471 register_stock_icon (factory, GTK_STOCK_PRINT_PREVIEW);
472 register_stock_icon (factory, GTK_STOCK_PRINT_REPORT);
473 register_stock_icon (factory, GTK_STOCK_PRINT_WARNING);
474 register_stock_icon (factory, GTK_STOCK_PROPERTIES);
475 register_bidi_stock_icon (factory,
477 GTK_STOCK_REDO "-ltr",
478 GTK_STOCK_REDO "-rtl");
479 register_stock_icon (factory, GTK_STOCK_REMOVE);
480 register_stock_icon (factory, GTK_STOCK_REFRESH);
481 register_bidi_stock_icon (factory,
482 GTK_STOCK_REVERT_TO_SAVED,
483 GTK_STOCK_REVERT_TO_SAVED "-ltr",
484 GTK_STOCK_REVERT_TO_SAVED "-rtl");
485 register_bidi_stock_icon (factory,
486 GTK_STOCK_GO_FORWARD,
487 GTK_STOCK_GO_FORWARD "-ltr",
488 GTK_STOCK_GO_FORWARD "-rtl");
489 register_stock_icon (factory, GTK_STOCK_SAVE);
490 register_stock_icon (factory, GTK_STOCK_FLOPPY);
491 register_stock_icon (factory, GTK_STOCK_SAVE_AS);
492 register_stock_icon (factory, GTK_STOCK_FIND);
493 register_stock_icon (factory, GTK_STOCK_FIND_AND_REPLACE);
494 register_stock_icon (factory, GTK_STOCK_SORT_DESCENDING);
495 register_stock_icon (factory, GTK_STOCK_SORT_ASCENDING);
496 register_stock_icon (factory, GTK_STOCK_SPELL_CHECK);
497 register_stock_icon (factory, GTK_STOCK_STOP);
498 register_stock_icon (factory, GTK_STOCK_BOLD);
499 register_stock_icon (factory, GTK_STOCK_ITALIC);
500 register_stock_icon (factory, GTK_STOCK_STRIKETHROUGH);
501 register_stock_icon (factory, GTK_STOCK_UNDERLINE);
502 register_bidi_stock_icon (factory,
504 GTK_STOCK_INDENT "-ltr",
505 GTK_STOCK_INDENT "-rtl");
506 register_bidi_stock_icon (factory,
508 GTK_STOCK_UNINDENT "-ltr",
509 GTK_STOCK_UNINDENT "-rtl");
510 register_stock_icon (factory, GTK_STOCK_GOTO_TOP);
511 register_stock_icon (factory, GTK_STOCK_DELETE);
512 register_bidi_stock_icon (factory,
514 GTK_STOCK_UNDELETE "-ltr",
515 GTK_STOCK_UNDELETE "-rtl");
516 register_bidi_stock_icon (factory,
518 GTK_STOCK_UNDO "-ltr",
519 GTK_STOCK_UNDO "-rtl");
520 register_stock_icon (factory, GTK_STOCK_GO_UP);
521 register_stock_icon (factory, GTK_STOCK_FILE);
522 register_stock_icon (factory, GTK_STOCK_DIRECTORY);
523 register_stock_icon (factory, GTK_STOCK_ABOUT);
524 register_stock_icon (factory, GTK_STOCK_CONNECT);
525 register_stock_icon (factory, GTK_STOCK_DISCONNECT);
526 register_stock_icon (factory, GTK_STOCK_EDIT);
527 register_stock_icon (factory, GTK_STOCK_CAPS_LOCK_WARNING);
528 register_bidi_stock_icon (factory,
529 GTK_STOCK_MEDIA_FORWARD,
530 GTK_STOCK_MEDIA_FORWARD "-ltr",
531 GTK_STOCK_MEDIA_FORWARD "-rtl");
532 register_bidi_stock_icon (factory,
533 GTK_STOCK_MEDIA_NEXT,
534 GTK_STOCK_MEDIA_NEXT "-ltr",
535 GTK_STOCK_MEDIA_NEXT "-rtl");
536 register_stock_icon (factory, GTK_STOCK_MEDIA_PAUSE);
537 register_bidi_stock_icon (factory,
538 GTK_STOCK_MEDIA_PLAY,
539 GTK_STOCK_MEDIA_PLAY "-ltr",
540 GTK_STOCK_MEDIA_PLAY "-rtl");
541 register_bidi_stock_icon (factory,
542 GTK_STOCK_MEDIA_PREVIOUS,
543 GTK_STOCK_MEDIA_PREVIOUS "-ltr",
544 GTK_STOCK_MEDIA_PREVIOUS "-rtl");
545 register_stock_icon (factory, GTK_STOCK_MEDIA_RECORD);
546 register_bidi_stock_icon (factory,
547 GTK_STOCK_MEDIA_REWIND,
548 GTK_STOCK_MEDIA_REWIND "-ltr",
549 GTK_STOCK_MEDIA_REWIND "-rtl");
550 register_stock_icon (factory, GTK_STOCK_MEDIA_STOP);
551 register_stock_icon (factory, GTK_STOCK_INDEX);
552 register_stock_icon (factory, GTK_STOCK_ZOOM_100);
553 register_stock_icon (factory, GTK_STOCK_ZOOM_IN);
554 register_stock_icon (factory, GTK_STOCK_ZOOM_OUT);
555 register_stock_icon (factory, GTK_STOCK_ZOOM_FIT);
556 register_stock_icon (factory, GTK_STOCK_SELECT_ALL);
557 register_stock_icon (factory, GTK_STOCK_CLEAR);
558 register_stock_icon (factory, GTK_STOCK_SELECT_COLOR);
559 register_stock_icon (factory, GTK_STOCK_COLOR_PICKER);
562 /************************************************************
563 * Icon size handling *
564 ************************************************************/
566 typedef struct _IconSize IconSize;
577 typedef struct _IconAlias IconAlias;
585 typedef struct _SettingsIconSize SettingsIconSize;
587 struct _SettingsIconSize
593 static GHashTable *icon_aliases = NULL;
594 static IconSize *icon_sizes = NULL;
595 static gint icon_sizes_allocated = 0;
596 static gint icon_sizes_used = 0;
599 init_icon_sizes (void)
601 if (icon_sizes == NULL)
603 #define NUM_BUILTIN_SIZES 7
606 icon_aliases = g_hash_table_new (g_str_hash, g_str_equal);
608 icon_sizes = g_new (IconSize, NUM_BUILTIN_SIZES);
609 icon_sizes_allocated = NUM_BUILTIN_SIZES;
610 icon_sizes_used = NUM_BUILTIN_SIZES;
612 icon_sizes[GTK_ICON_SIZE_INVALID].size = 0;
613 icon_sizes[GTK_ICON_SIZE_INVALID].name = NULL;
614 icon_sizes[GTK_ICON_SIZE_INVALID].width = 0;
615 icon_sizes[GTK_ICON_SIZE_INVALID].height = 0;
617 /* the name strings aren't copied since we don't ever remove
618 * icon sizes, so we don't need to know whether they're static.
619 * Even if we did I suppose removing the builtin sizes would be
623 icon_sizes[GTK_ICON_SIZE_MENU].size = GTK_ICON_SIZE_MENU;
624 icon_sizes[GTK_ICON_SIZE_MENU].name = "gtk-menu";
625 icon_sizes[GTK_ICON_SIZE_MENU].width = 16;
626 icon_sizes[GTK_ICON_SIZE_MENU].height = 16;
628 icon_sizes[GTK_ICON_SIZE_BUTTON].size = GTK_ICON_SIZE_BUTTON;
629 icon_sizes[GTK_ICON_SIZE_BUTTON].name = "gtk-button";
630 icon_sizes[GTK_ICON_SIZE_BUTTON].width = 20;
631 icon_sizes[GTK_ICON_SIZE_BUTTON].height = 20;
633 icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].size = GTK_ICON_SIZE_SMALL_TOOLBAR;
634 icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].name = "gtk-small-toolbar";
635 icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].width = 18;
636 icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].height = 18;
638 icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].size = GTK_ICON_SIZE_LARGE_TOOLBAR;
639 icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].name = "gtk-large-toolbar";
640 icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].width = 24;
641 icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].height = 24;
643 icon_sizes[GTK_ICON_SIZE_DND].size = GTK_ICON_SIZE_DND;
644 icon_sizes[GTK_ICON_SIZE_DND].name = "gtk-dnd";
645 icon_sizes[GTK_ICON_SIZE_DND].width = 32;
646 icon_sizes[GTK_ICON_SIZE_DND].height = 32;
648 icon_sizes[GTK_ICON_SIZE_DIALOG].size = GTK_ICON_SIZE_DIALOG;
649 icon_sizes[GTK_ICON_SIZE_DIALOG].name = "gtk-dialog";
650 icon_sizes[GTK_ICON_SIZE_DIALOG].width = 48;
651 icon_sizes[GTK_ICON_SIZE_DIALOG].height = 48;
653 g_assert ((GTK_ICON_SIZE_DIALOG + 1) == NUM_BUILTIN_SIZES);
655 /* Alias everything to itself. */
656 i = 1; /* skip invalid size */
657 while (i < NUM_BUILTIN_SIZES)
659 gtk_icon_size_register_alias (icon_sizes[i].name, icon_sizes[i].size);
664 #undef NUM_BUILTIN_SIZES
669 free_settings_sizes (gpointer data)
671 g_array_free (data, TRUE);
675 get_settings_sizes (GtkSettings *settings,
678 GArray *settings_sizes;
679 static GQuark sizes_quark = 0;
682 sizes_quark = g_quark_from_static_string ("gtk-icon-sizes");
684 settings_sizes = g_object_get_qdata (G_OBJECT (settings), sizes_quark);
687 settings_sizes = g_array_new (FALSE, FALSE, sizeof (SettingsIconSize));
688 g_object_set_qdata_full (G_OBJECT (settings), sizes_quark,
689 settings_sizes, free_settings_sizes);
694 return settings_sizes;
698 icon_size_set_for_settings (GtkSettings *settings,
699 const gchar *size_name,
704 GArray *settings_sizes;
705 SettingsIconSize *settings_size;
707 g_return_if_fail (size_name != NULL);
709 size = gtk_icon_size_from_name (size_name);
710 if (size == GTK_ICON_SIZE_INVALID)
711 /* Reserve a place */
712 size = icon_size_register_intern (size_name, -1, -1);
714 settings_sizes = get_settings_sizes (settings, NULL);
715 if (size >= settings_sizes->len)
717 SettingsIconSize unset = { -1, -1 };
720 for (i = settings_sizes->len; i <= size; i++)
721 g_array_append_val (settings_sizes, unset);
724 settings_size = &g_array_index (settings_sizes, SettingsIconSize, size);
726 settings_size->width = width;
727 settings_size->height = height;
730 /* Like pango_parse_word, but accept - as well
733 scan_icon_size_name (const char **pos, GString *out)
735 const char *p = *pos;
737 while (g_ascii_isspace (*p))
740 if (!((*p >= 'A' && *p <= 'Z') ||
741 (*p >= 'a' && *p <= 'z') ||
742 *p == '_' || *p == '-'))
745 g_string_truncate (out, 0);
746 g_string_append_c (out, *p);
749 while ((*p >= 'A' && *p <= 'Z') ||
750 (*p >= 'a' && *p <= 'z') ||
751 (*p >= '0' && *p <= '9') ||
752 *p == '_' || *p == '-')
754 g_string_append_c (out, *p);
764 icon_size_setting_parse (GtkSettings *settings,
765 const gchar *icon_size_string)
767 GString *name_buf = g_string_new (NULL);
768 const gchar *p = icon_size_string;
770 while (pango_skip_space (&p))
774 if (!scan_icon_size_name (&p, name_buf))
777 if (!pango_skip_space (&p))
785 if (!pango_scan_int (&p, &width))
788 if (!pango_skip_space (&p))
796 if (!pango_scan_int (&p, &height))
799 if (width > 0 && height > 0)
801 icon_size_set_for_settings (settings, name_buf->str,
806 g_warning ("Invalid size in gtk-icon-sizes: %d,%d\n", width, height);
809 pango_skip_space (&p);
818 g_string_free (name_buf, TRUE);
822 g_warning ("Error parsing gtk-icon-sizes string:\n\t'%s'", icon_size_string);
823 g_string_free (name_buf, TRUE);
827 icon_size_set_all_from_settings (GtkSettings *settings)
829 GArray *settings_sizes;
830 gchar *icon_size_string;
832 /* Reset old settings */
833 settings_sizes = get_settings_sizes (settings, NULL);
834 g_array_set_size (settings_sizes, 0);
836 g_object_get (settings,
837 "gtk-icon-sizes", &icon_size_string,
840 if (icon_size_string)
842 icon_size_setting_parse (settings, icon_size_string);
843 g_free (icon_size_string);
848 icon_size_settings_changed (GtkSettings *settings,
851 icon_size_set_all_from_settings (settings);
853 gtk_rc_reset_styles (settings);
857 icon_sizes_init_for_settings (GtkSettings *settings)
859 g_signal_connect (settings,
860 "notify::gtk-icon-sizes",
861 G_CALLBACK (icon_size_settings_changed),
864 icon_size_set_all_from_settings (settings);
868 icon_size_lookup_intern (GtkSettings *settings,
873 GArray *settings_sizes;
874 gint width_for_settings = -1;
875 gint height_for_settings = -1;
879 if (size == (GtkIconSize)-1)
882 if (size >= icon_sizes_used)
885 if (size == GTK_ICON_SIZE_INVALID)
890 gboolean initial = FALSE;
892 settings_sizes = get_settings_sizes (settings, &initial);
895 icon_sizes_init_for_settings (settings);
897 if (size < settings_sizes->len)
899 SettingsIconSize *settings_size;
901 settings_size = &g_array_index (settings_sizes, SettingsIconSize, size);
903 width_for_settings = settings_size->width;
904 height_for_settings = settings_size->height;
909 *widthp = width_for_settings >= 0 ? width_for_settings : icon_sizes[size].width;
912 *heightp = height_for_settings >= 0 ? height_for_settings : icon_sizes[size].height;
918 * gtk_icon_size_lookup_for_settings:
919 * @settings: a #GtkSettings object, used to determine
920 * which set of user preferences to used.
921 * @size: (type int): an icon size
922 * @width: location to store icon width
923 * @height: location to store icon height
925 * Obtains the pixel size of a semantic icon size, possibly
926 * modified by user preferences for a particular
927 * #GtkSettings. Normally @size would be
928 * #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc. This function
929 * isn't normally needed, gtk_widget_render_icon() is the usual
930 * way to get an icon for rendering, then just look at the size of
931 * the rendered pixbuf. The rendered pixbuf may not even correspond to
932 * the width/height returned by gtk_icon_size_lookup(), because themes
933 * are free to render the pixbuf however they like, including changing
936 * Return value: %TRUE if @size was a valid size
941 gtk_icon_size_lookup_for_settings (GtkSettings *settings,
946 g_return_val_if_fail (GTK_IS_SETTINGS (settings), FALSE);
948 return icon_size_lookup_intern (settings, size, width, height);
952 * gtk_icon_size_lookup:
953 * @size: (type int): an icon size
954 * @width: location to store icon width
955 * @height: location to store icon height
957 * Obtains the pixel size of a semantic icon size, possibly
958 * modified by user preferences for the default #GtkSettings.
959 * (See gtk_icon_size_lookup_for_settings().)
960 * Normally @size would be
961 * #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc. This function
962 * isn't normally needed, gtk_widget_render_icon() is the usual
963 * way to get an icon for rendering, then just look at the size of
964 * the rendered pixbuf. The rendered pixbuf may not even correspond to
965 * the width/height returned by gtk_icon_size_lookup(), because themes
966 * are free to render the pixbuf however they like, including changing
969 * Return value: %TRUE if @size was a valid size
972 gtk_icon_size_lookup (GtkIconSize size,
977 g_warning ("gtk_icon_size_lookup ()) is not multihead safe"));
979 return gtk_icon_size_lookup_for_settings (gtk_settings_get_default (),
980 size, widthp, heightp);
984 icon_size_register_intern (const gchar *name,
988 IconAlias *old_alias;
993 old_alias = g_hash_table_lookup (icon_aliases, name);
994 if (old_alias && icon_sizes[old_alias->target].width > 0)
996 g_warning ("Icon size name '%s' already exists", name);
997 return GTK_ICON_SIZE_INVALID;
1002 size = old_alias->target;
1006 if (icon_sizes_used == icon_sizes_allocated)
1008 icon_sizes_allocated *= 2;
1009 icon_sizes = g_renew (IconSize, icon_sizes, icon_sizes_allocated);
1012 size = icon_sizes_used++;
1014 /* alias to self. */
1015 gtk_icon_size_register_alias (name, size);
1017 icon_sizes[size].size = size;
1018 icon_sizes[size].name = g_strdup (name);
1021 icon_sizes[size].width = width;
1022 icon_sizes[size].height = height;
1028 * gtk_icon_size_register:
1029 * @name: name of the icon size
1030 * @width: the icon width
1031 * @height: the icon height
1033 * Registers a new icon size, along the same lines as #GTK_ICON_SIZE_MENU,
1034 * etc. Returns the integer value for the size.
1036 * Returns: (type int): integer value representing the size
1039 gtk_icon_size_register (const gchar *name,
1043 g_return_val_if_fail (name != NULL, 0);
1044 g_return_val_if_fail (width > 0, 0);
1045 g_return_val_if_fail (height > 0, 0);
1047 return icon_size_register_intern (name, width, height);
1051 * gtk_icon_size_register_alias:
1052 * @alias: an alias for @target
1053 * @target: (type int): an existing icon size
1055 * Registers @alias as another name for @target.
1056 * So calling gtk_icon_size_from_name() with @alias as argument
1057 * will return @target.
1060 gtk_icon_size_register_alias (const gchar *alias,
1065 g_return_if_fail (alias != NULL);
1069 if (!icon_size_lookup_intern (NULL, target, NULL, NULL))
1070 g_warning ("gtk_icon_size_register_alias: Icon size %u does not exist", target);
1072 ia = g_hash_table_lookup (icon_aliases, alias);
1075 if (icon_sizes[ia->target].width > 0)
1077 g_warning ("gtk_icon_size_register_alias: Icon size name '%s' already exists", alias);
1081 ia->target = target;
1086 ia = g_new (IconAlias, 1);
1087 ia->name = g_strdup (alias);
1088 ia->target = target;
1090 g_hash_table_insert (icon_aliases, ia->name, ia);
1095 * gtk_icon_size_from_name:
1096 * @name: the name to look up.
1098 * Looks up the icon size associated with @name.
1100 * Return value: (type int): the icon size
1103 gtk_icon_size_from_name (const gchar *name)
1109 ia = g_hash_table_lookup (icon_aliases, name);
1111 if (ia && icon_sizes[ia->target].width > 0)
1114 return GTK_ICON_SIZE_INVALID;
1118 * gtk_icon_size_get_name:
1119 * @size: (type int): a #GtkIconSize.
1120 * @returns: the name of the given icon size.
1122 * Gets the canonical name of the given icon size. The returned string
1123 * is statically allocated and should not be freed.
1125 G_CONST_RETURN gchar*
1126 gtk_icon_size_get_name (GtkIconSize size)
1128 if (size >= icon_sizes_used)
1131 return icon_sizes[size].name;
1134 /************************************************************/
1139 static GdkPixbuf *find_in_cache (GtkIconSet *icon_set,
1141 GtkTextDirection direction,
1144 static void add_to_cache (GtkIconSet *icon_set,
1146 GtkTextDirection direction,
1150 /* Clear icon set contents, drop references to all contained
1151 * GdkPixbuf objects and forget all GtkIconSources. Used to
1152 * recycle an icon set.
1154 static void clear_cache (GtkIconSet *icon_set,
1155 gboolean style_detach);
1156 static GSList* copy_cache (GtkIconSet *icon_set,
1157 GtkIconSet *copy_recipient);
1158 static void attach_to_style (GtkIconSet *icon_set,
1160 static void detach_from_style (GtkIconSet *icon_set,
1162 static void style_dnotify (gpointer data);
1170 /* Cache of the last few rendered versions of the icon. */
1178 static guint cache_serial = 0;
1183 * Creates a new #GtkIconSet. A #GtkIconSet represents a single icon
1184 * in various sizes and widget states. It can provide a #GdkPixbuf
1185 * for a given size and state on request, and automatically caches
1186 * some of the rendered #GdkPixbuf objects.
1188 * Normally you would use gtk_widget_render_icon() instead of
1189 * using #GtkIconSet directly. The one case where you'd use
1190 * #GtkIconSet is to create application-specific icon sets to place in
1191 * a #GtkIconFactory.
1193 * Return value: a new #GtkIconSet
1196 gtk_icon_set_new (void)
1198 GtkIconSet *icon_set;
1200 icon_set = g_new (GtkIconSet, 1);
1202 icon_set->ref_count = 1;
1203 icon_set->sources = NULL;
1204 icon_set->cache = NULL;
1205 icon_set->cache_size = 0;
1206 icon_set->cache_serial = cache_serial;
1212 * gtk_icon_set_new_from_pixbuf:
1213 * @pixbuf: a #GdkPixbuf
1215 * Creates a new #GtkIconSet with @pixbuf as the default/fallback
1216 * source image. If you don't add any additional #GtkIconSource to the
1217 * icon set, all variants of the icon will be created from @pixbuf,
1218 * using scaling, pixelation, etc. as required to adjust the icon size
1219 * or make the icon look insensitive/prelighted.
1221 * Return value: a new #GtkIconSet
1224 gtk_icon_set_new_from_pixbuf (GdkPixbuf *pixbuf)
1228 GtkIconSource source = GTK_ICON_SOURCE_INIT (TRUE, TRUE, TRUE);
1230 g_return_val_if_fail (pixbuf != NULL, NULL);
1232 set = gtk_icon_set_new ();
1234 gtk_icon_source_set_pixbuf (&source, pixbuf);
1235 gtk_icon_set_add_source (set, &source);
1236 gtk_icon_source_set_pixbuf (&source, NULL);
1244 * @icon_set: a #GtkIconSet.
1246 * Increments the reference count on @icon_set.
1248 * Return value: @icon_set.
1251 gtk_icon_set_ref (GtkIconSet *icon_set)
1253 g_return_val_if_fail (icon_set != NULL, NULL);
1254 g_return_val_if_fail (icon_set->ref_count > 0, NULL);
1256 icon_set->ref_count += 1;
1262 * gtk_icon_set_unref:
1263 * @icon_set: a #GtkIconSet
1265 * Decrements the reference count on @icon_set, and frees memory
1266 * if the reference count reaches 0.
1269 gtk_icon_set_unref (GtkIconSet *icon_set)
1271 g_return_if_fail (icon_set != NULL);
1272 g_return_if_fail (icon_set->ref_count > 0);
1274 icon_set->ref_count -= 1;
1276 if (icon_set->ref_count == 0)
1278 GSList *tmp_list = icon_set->sources;
1279 while (tmp_list != NULL)
1281 gtk_icon_source_free (tmp_list->data);
1283 tmp_list = g_slist_next (tmp_list);
1285 g_slist_free (icon_set->sources);
1287 clear_cache (icon_set, TRUE);
1294 gtk_icon_set_get_type (void)
1296 static GType our_type = 0;
1299 our_type = g_boxed_type_register_static (I_("GtkIconSet"),
1300 (GBoxedCopyFunc) gtk_icon_set_ref,
1301 (GBoxedFreeFunc) gtk_icon_set_unref);
1307 * gtk_icon_set_copy:
1308 * @icon_set: a #GtkIconSet
1310 * Copies @icon_set by value.
1312 * Return value: a new #GtkIconSet identical to the first.
1315 gtk_icon_set_copy (GtkIconSet *icon_set)
1320 copy = gtk_icon_set_new ();
1322 tmp_list = icon_set->sources;
1323 while (tmp_list != NULL)
1325 copy->sources = g_slist_prepend (copy->sources,
1326 gtk_icon_source_copy (tmp_list->data));
1328 tmp_list = g_slist_next (tmp_list);
1331 copy->sources = g_slist_reverse (copy->sources);
1333 copy->cache = copy_cache (icon_set, copy);
1334 copy->cache_size = icon_set->cache_size;
1335 copy->cache_serial = icon_set->cache_serial;
1341 sizes_equivalent (GtkIconSize lhs,
1344 /* We used to consider sizes equivalent if they were
1345 * the same pixel size, but we don't have the GtkSettings
1346 * here, so we can't do that. Plus, it's not clear that
1347 * it is right... it was just a workaround for the fact
1348 * that we register icons by logical size, not pixel size.
1354 gint r_w, r_h, l_w, l_h;
1356 icon_size_lookup_intern (NULL, rhs, &r_w, &r_h);
1357 icon_size_lookup_intern (NULL, lhs, &l_w, &l_h);
1359 return r_w == l_w && r_h == l_h;
1363 static GtkIconSource *
1364 find_best_matching_source (GtkIconSet *icon_set,
1365 GtkTextDirection direction,
1370 GtkIconSource *source;
1373 /* We need to find the best icon source. Direction matters more
1374 * than state, state matters more than size. icon_set->sources
1375 * is sorted according to wildness, so if we take the first
1376 * match we find it will be the least-wild match (if there are
1377 * multiple matches for a given "wildness" then the RC file contained
1378 * dumb stuff, and we end up with an arbitrary matching source)
1382 tmp_list = icon_set->sources;
1383 while (tmp_list != NULL)
1385 GtkIconSource *s = tmp_list->data;
1387 if ((s->any_direction || (s->direction == direction)) &&
1388 (s->any_state || (s->state == state)) &&
1389 (s->any_size || size == (GtkIconSize)-1 || (sizes_equivalent (size, s->size))))
1391 if (!g_slist_find (failed, s))
1398 tmp_list = g_slist_next (tmp_list);
1405 ensure_filename_pixbuf (GtkIconSet *icon_set,
1406 GtkIconSource *source)
1408 if (source->filename_pixbuf == NULL)
1410 GError *error = NULL;
1412 source->filename_pixbuf = gdk_pixbuf_new_from_file (source->source.filename, &error);
1414 if (source->filename_pixbuf == NULL)
1416 /* Remove this icon source so we don't keep trying to
1419 g_warning (_("Error loading icon: %s"), error->message);
1420 g_error_free (error);
1422 icon_set->sources = g_slist_remove (icon_set->sources, source);
1424 gtk_icon_source_free (source);
1434 render_icon_name_pixbuf (GtkIconSource *icon_source,
1436 GtkTextDirection direction,
1443 GdkPixbuf *tmp_pixbuf;
1444 GtkIconSource tmp_source;
1446 GtkIconTheme *icon_theme;
1447 GtkSettings *settings;
1448 gint width, height, pixel_size;
1449 gint *sizes, *s, dist;
1450 GError *error = NULL;
1452 if (widget && gtk_widget_has_screen (widget))
1453 screen = gtk_widget_get_screen (widget);
1454 else if (style && style->colormap)
1455 screen = gdk_colormap_get_screen (style->colormap);
1458 screen = gdk_screen_get_default ();
1459 GTK_NOTE (MULTIHEAD,
1460 g_warning ("Using the default screen for gtk_icon_source_render_icon()"));
1463 icon_theme = gtk_icon_theme_get_for_screen (screen);
1464 settings = gtk_settings_get_for_screen (screen);
1466 if (!gtk_icon_size_lookup_for_settings (settings, size, &width, &height))
1468 if (size == (GtkIconSize)-1)
1470 /* Find an available size close to 48 */
1471 sizes = gtk_icon_theme_get_icon_sizes (icon_theme, icon_source->source.icon_name);
1473 width = height = 48;
1474 for (s = sizes; *s; s++)
1478 width = height = 48;
1485 width = height = *s;
1493 width = height = *s;
1503 g_warning ("Invalid icon size %u\n", size);
1504 width = height = 24;
1508 pixel_size = MIN (width, height);
1510 tmp_pixbuf = gtk_icon_theme_load_icon (icon_theme,
1511 icon_source->source.icon_name,
1517 g_warning ("Error loading theme icon '%s' for stock: %s",
1518 icon_source->source.icon_name, error ? error->message : "");
1520 g_error_free (error);
1524 tmp_source = *icon_source;
1525 tmp_source.type = GTK_ICON_SOURCE_PIXBUF;
1526 tmp_source.source.pixbuf = tmp_pixbuf;
1528 pixbuf = gtk_style_render_icon (style, &tmp_source,
1529 direction, state, -1,
1533 g_warning ("Failed to render icon");
1535 g_object_unref (tmp_pixbuf);
1541 find_and_render_icon_source (GtkIconSet *icon_set,
1543 GtkTextDirection direction,
1549 GSList *failed = NULL;
1550 GdkPixbuf *pixbuf = NULL;
1552 /* We treat failure in two different ways:
1554 * A) If loading a source that specifies a filename fails,
1555 * we treat that as permanent, and remove the source
1556 * from the GtkIconSet. (in ensure_filename_pixbuf ()
1557 * B) If loading a themed icon fails, or scaling an icon
1558 * fails, we treat that as transient and will try
1559 * again next time the icon falls out of the cache
1560 * and we need to recreate it.
1562 while (pixbuf == NULL)
1564 GtkIconSource *source = find_best_matching_source (icon_set, direction, state, size, failed);
1569 switch (source->type)
1571 case GTK_ICON_SOURCE_FILENAME:
1572 if (!ensure_filename_pixbuf (icon_set, source))
1575 case GTK_ICON_SOURCE_PIXBUF:
1576 pixbuf = gtk_style_render_icon (style, source,
1577 direction, state, size,
1581 g_warning ("Failed to render icon");
1582 failed = g_slist_prepend (failed, source);
1585 case GTK_ICON_SOURCE_ICON_NAME:
1586 case GTK_ICON_SOURCE_STATIC_ICON_NAME:
1587 pixbuf = render_icon_name_pixbuf (source, style,
1588 direction, state, size,
1591 failed = g_slist_prepend (failed, source);
1593 case GTK_ICON_SOURCE_EMPTY:
1594 g_assert_not_reached ();
1598 g_slist_free (failed);
1603 extern GtkIconCache *_builtin_cache;
1606 render_fallback_image (GtkStyle *style,
1607 GtkTextDirection direction,
1613 /* This icon can be used for any direction/state/size */
1614 static GtkIconSource fallback_source = GTK_ICON_SOURCE_INIT (TRUE, TRUE, TRUE);
1616 if (fallback_source.type == GTK_ICON_SOURCE_EMPTY)
1621 _gtk_icon_theme_ensure_builtin_cache ();
1623 index = _gtk_icon_cache_get_directory_index (_builtin_cache, "24");
1624 pixbuf = _gtk_icon_cache_get_icon (_builtin_cache,
1625 GTK_STOCK_MISSING_IMAGE,
1627 gtk_icon_source_set_pixbuf (&fallback_source, pixbuf);
1628 g_object_unref (pixbuf);
1631 return gtk_style_render_icon (style,
1641 * gtk_icon_set_render_icon:
1642 * @icon_set: a #GtkIconSet
1643 * @style: (allow-none): a #GtkStyle associated with @widget, or %NULL
1644 * @direction: text direction
1645 * @state: widget state
1646 * @size: (type int): icon size. A size of (GtkIconSize)-1
1647 * means render at the size of the source and don't scale.
1648 * @widget: (allow-none): widget that will display the icon, or %NULL.
1649 * The only use that is typically made of this
1650 * is to determine the appropriate #GdkScreen.
1651 * @detail: (allow-none): detail to pass to the theme engine, or %NULL.
1652 * Note that passing a detail of anything but %NULL
1653 * will disable caching.
1655 * Renders an icon using gtk_style_render_icon(). In most cases,
1656 * gtk_widget_render_icon() is better, since it automatically provides
1657 * most of the arguments from the current widget settings. This
1658 * function never returns %NULL; if the icon can't be rendered
1659 * (perhaps because an image file fails to load), a default "missing
1660 * image" icon will be returned instead.
1662 * Return value: a #GdkPixbuf to be displayed
1665 gtk_icon_set_render_icon (GtkIconSet *icon_set,
1667 GtkTextDirection direction,
1675 g_return_val_if_fail (icon_set != NULL, NULL);
1676 g_return_val_if_fail (style == NULL || GTK_IS_STYLE (style), NULL);
1678 if (icon_set->sources == NULL)
1679 return render_fallback_image (style, direction, state, size, widget, detail);
1683 icon = find_in_cache (icon_set, style, direction,
1688 g_object_ref (icon);
1694 icon = find_and_render_icon_source (icon_set, style, direction, state, size,
1698 icon = render_fallback_image (style, direction, state, size, widget, detail);
1701 add_to_cache (icon_set, style, direction, state, size, icon);
1706 /* Order sources by their "wildness", so that "wilder" sources are
1707 * greater than "specific" sources; for determining ordering,
1708 * direction beats state beats size.
1712 icon_source_compare (gconstpointer ap, gconstpointer bp)
1714 const GtkIconSource *a = ap;
1715 const GtkIconSource *b = bp;
1717 if (!a->any_direction && b->any_direction)
1719 else if (a->any_direction && !b->any_direction)
1721 else if (!a->any_state && b->any_state)
1723 else if (a->any_state && !b->any_state)
1725 else if (!a->any_size && b->any_size)
1727 else if (a->any_size && !b->any_size)
1734 * gtk_icon_set_add_source:
1735 * @icon_set: a #GtkIconSet
1736 * @source: a #GtkIconSource
1738 * Icon sets have a list of #GtkIconSource, which they use as base
1739 * icons for rendering icons in different states and sizes. Icons are
1740 * scaled, made to look insensitive, etc. in
1741 * gtk_icon_set_render_icon(), but #GtkIconSet needs base images to
1742 * work with. The base images and when to use them are described by
1745 * This function copies @source, so you can reuse the same source immediately
1746 * without affecting the icon set.
1748 * An example of when you'd use this function: a web browser's "Back
1749 * to Previous Page" icon might point in a different direction in
1750 * Hebrew and in English; it might look different when insensitive;
1751 * and it might change size depending on toolbar mode (small/large
1752 * icons). So a single icon set would contain all those variants of
1753 * the icon, and you might add a separate source for each one.
1755 * You should nearly always add a "default" icon source with all
1756 * fields wildcarded, which will be used as a fallback if no more
1757 * specific source matches. #GtkIconSet always prefers more specific
1758 * icon sources to more generic icon sources. The order in which you
1759 * add the sources to the icon set does not matter.
1761 * gtk_icon_set_new_from_pixbuf() creates a new icon set with a
1762 * default icon source based on the given pixbuf.
1765 gtk_icon_set_add_source (GtkIconSet *icon_set,
1766 const GtkIconSource *source)
1768 g_return_if_fail (icon_set != NULL);
1769 g_return_if_fail (source != NULL);
1771 if (source->type == GTK_ICON_SOURCE_EMPTY)
1773 g_warning ("Useless empty GtkIconSource");
1777 icon_set->sources = g_slist_insert_sorted (icon_set->sources,
1778 gtk_icon_source_copy (source),
1779 icon_source_compare);
1783 * gtk_icon_set_get_sizes:
1784 * @icon_set: a #GtkIconSet
1785 * @sizes: (array length=n_sizes) (out) (type int): return location
1786 * for array of sizes
1787 * @n_sizes: location to store number of elements in returned array
1789 * Obtains a list of icon sizes this icon set can render. The returned
1790 * array must be freed with g_free().
1793 gtk_icon_set_get_sizes (GtkIconSet *icon_set,
1794 GtkIconSize **sizes,
1798 gboolean all_sizes = FALSE;
1799 GSList *specifics = NULL;
1801 g_return_if_fail (icon_set != NULL);
1802 g_return_if_fail (sizes != NULL);
1803 g_return_if_fail (n_sizes != NULL);
1805 tmp_list = icon_set->sources;
1806 while (tmp_list != NULL)
1808 GtkIconSource *source;
1810 source = tmp_list->data;
1812 if (source->any_size)
1818 specifics = g_slist_prepend (specifics, GINT_TO_POINTER (source->size));
1820 tmp_list = g_slist_next (tmp_list);
1825 /* Need to find out what sizes exist */
1830 *sizes = g_new (GtkIconSize, icon_sizes_used);
1831 *n_sizes = icon_sizes_used - 1;
1834 while (i < icon_sizes_used)
1836 (*sizes)[i - 1] = icon_sizes[i].size;
1844 *n_sizes = g_slist_length (specifics);
1845 *sizes = g_new (GtkIconSize, *n_sizes);
1848 tmp_list = specifics;
1849 while (tmp_list != NULL)
1851 (*sizes)[i] = GPOINTER_TO_INT (tmp_list->data);
1854 tmp_list = g_slist_next (tmp_list);
1858 g_slist_free (specifics);
1863 * gtk_icon_source_new:
1865 * Creates a new #GtkIconSource. A #GtkIconSource contains a #GdkPixbuf (or
1866 * image filename) that serves as the base image for one or more of the
1867 * icons in a #GtkIconSet, along with a specification for which icons in the
1868 * icon set will be based on that pixbuf or image file. An icon set contains
1869 * a set of icons that represent "the same" logical concept in different states,
1870 * different global text directions, and different sizes.
1872 * So for example a web browser's "Back to Previous Page" icon might
1873 * point in a different direction in Hebrew and in English; it might
1874 * look different when insensitive; and it might change size depending
1875 * on toolbar mode (small/large icons). So a single icon set would
1876 * contain all those variants of the icon. #GtkIconSet contains a list
1877 * of #GtkIconSource from which it can derive specific icon variants in
1880 * In the simplest case, #GtkIconSet contains one source pixbuf from
1881 * which it derives all variants. The convenience function
1882 * gtk_icon_set_new_from_pixbuf() handles this case; if you only have
1883 * one source pixbuf, just use that function.
1885 * If you want to use a different base pixbuf for different icon
1886 * variants, you create multiple icon sources, mark which variants
1887 * they'll be used to create, and add them to the icon set with
1888 * gtk_icon_set_add_source().
1890 * By default, the icon source has all parameters wildcarded. That is,
1891 * the icon source will be used as the base icon for any desired text
1892 * direction, widget state, or icon size.
1894 * Return value: a new #GtkIconSource
1897 gtk_icon_source_new (void)
1901 src = g_new0 (GtkIconSource, 1);
1903 src->direction = GTK_TEXT_DIR_NONE;
1904 src->size = GTK_ICON_SIZE_INVALID;
1905 src->state = GTK_STATE_NORMAL;
1907 src->any_direction = TRUE;
1908 src->any_state = TRUE;
1909 src->any_size = TRUE;
1915 * gtk_icon_source_copy:
1916 * @source: a #GtkIconSource
1918 * Creates a copy of @source; mostly useful for language bindings.
1920 * Return value: a new #GtkIconSource
1923 gtk_icon_source_copy (const GtkIconSource *source)
1925 GtkIconSource *copy;
1927 g_return_val_if_fail (source != NULL, NULL);
1929 copy = g_new (GtkIconSource, 1);
1935 case GTK_ICON_SOURCE_EMPTY:
1936 case GTK_ICON_SOURCE_STATIC_ICON_NAME:
1938 case GTK_ICON_SOURCE_ICON_NAME:
1939 copy->source.icon_name = g_strdup (copy->source.icon_name);
1941 case GTK_ICON_SOURCE_FILENAME:
1942 copy->source.filename = g_strdup (copy->source.filename);
1943 #if defined (G_OS_WIN32) && !defined (_WIN64)
1944 copy->cp_filename = g_strdup (copy->cp_filename);
1946 if (copy->filename_pixbuf)
1947 g_object_ref (copy->filename_pixbuf);
1949 case GTK_ICON_SOURCE_PIXBUF:
1950 g_object_ref (copy->source.pixbuf);
1953 g_assert_not_reached();
1960 * gtk_icon_source_free:
1961 * @source: a #GtkIconSource
1963 * Frees a dynamically-allocated icon source, along with its
1964 * filename, size, and pixbuf fields if those are not %NULL.
1967 gtk_icon_source_free (GtkIconSource *source)
1969 g_return_if_fail (source != NULL);
1971 icon_source_clear (source);
1976 gtk_icon_source_get_type (void)
1978 static GType our_type = 0;
1981 our_type = g_boxed_type_register_static (I_("GtkIconSource"),
1982 (GBoxedCopyFunc) gtk_icon_source_copy,
1983 (GBoxedFreeFunc) gtk_icon_source_free);
1989 icon_source_clear (GtkIconSource *source)
1991 switch (source->type)
1993 case GTK_ICON_SOURCE_EMPTY:
1995 case GTK_ICON_SOURCE_ICON_NAME:
1996 g_free (source->source.icon_name);
1998 case GTK_ICON_SOURCE_STATIC_ICON_NAME:
1999 source->source.icon_name = NULL;
2001 case GTK_ICON_SOURCE_FILENAME:
2002 g_free (source->source.filename);
2003 source->source.filename = NULL;
2004 #if defined (G_OS_WIN32) && !defined (_WIN64)
2005 g_free (source->cp_filename);
2006 source->cp_filename = NULL;
2008 if (source->filename_pixbuf)
2009 g_object_unref (source->filename_pixbuf);
2010 source->filename_pixbuf = NULL;
2012 case GTK_ICON_SOURCE_PIXBUF:
2013 g_object_unref (source->source.pixbuf);
2014 source->source.pixbuf = NULL;
2017 g_assert_not_reached();
2020 source->type = GTK_ICON_SOURCE_EMPTY;
2024 * gtk_icon_source_set_filename:
2025 * @source: a #GtkIconSource
2026 * @filename: image file to use
2028 * Sets the name of an image file to use as a base image when creating
2029 * icon variants for #GtkIconSet. The filename must be absolute.
2032 gtk_icon_source_set_filename (GtkIconSource *source,
2033 const gchar *filename)
2035 g_return_if_fail (source != NULL);
2036 g_return_if_fail (filename == NULL || g_path_is_absolute (filename));
2038 if (source->type == GTK_ICON_SOURCE_FILENAME &&
2039 source->source.filename == filename)
2042 icon_source_clear (source);
2044 if (filename != NULL)
2046 source->type = GTK_ICON_SOURCE_FILENAME;
2047 source->source.filename = g_strdup (filename);
2048 #if defined (G_OS_WIN32) && !defined (_WIN64)
2049 source->cp_filename = g_locale_from_utf8 (filename, -1, NULL, NULL, NULL);
2055 * gtk_icon_source_set_icon_name
2056 * @source: a #GtkIconSource
2057 * @icon_name: (allow-none): name of icon to use
2059 * Sets the name of an icon to look up in the current icon theme
2060 * to use as a base image when creating icon variants for #GtkIconSet.
2063 gtk_icon_source_set_icon_name (GtkIconSource *source,
2064 const gchar *icon_name)
2066 g_return_if_fail (source != NULL);
2068 if (source->type == GTK_ICON_SOURCE_ICON_NAME &&
2069 source->source.icon_name == icon_name)
2072 icon_source_clear (source);
2074 if (icon_name != NULL)
2076 source->type = GTK_ICON_SOURCE_ICON_NAME;
2077 source->source.icon_name = g_strdup (icon_name);
2082 * gtk_icon_source_set_pixbuf:
2083 * @source: a #GtkIconSource
2084 * @pixbuf: pixbuf to use as a source
2086 * Sets a pixbuf to use as a base image when creating icon variants
2090 gtk_icon_source_set_pixbuf (GtkIconSource *source,
2093 g_return_if_fail (source != NULL);
2094 g_return_if_fail (pixbuf == NULL || GDK_IS_PIXBUF (pixbuf));
2096 if (source->type == GTK_ICON_SOURCE_PIXBUF &&
2097 source->source.pixbuf == pixbuf)
2100 icon_source_clear (source);
2104 source->type = GTK_ICON_SOURCE_PIXBUF;
2105 source->source.pixbuf = g_object_ref (pixbuf);
2110 * gtk_icon_source_get_filename:
2111 * @source: a #GtkIconSource
2113 * Retrieves the source filename, or %NULL if none is set. The
2114 * filename is not a copy, and should not be modified or expected to
2115 * persist beyond the lifetime of the icon source.
2117 * Return value: image filename. This string must not be modified
2120 G_CONST_RETURN gchar*
2121 gtk_icon_source_get_filename (const GtkIconSource *source)
2123 g_return_val_if_fail (source != NULL, NULL);
2125 if (source->type == GTK_ICON_SOURCE_FILENAME)
2126 return source->source.filename;
2132 * gtk_icon_source_get_icon_name:
2133 * @source: a #GtkIconSource
2135 * Retrieves the source icon name, or %NULL if none is set. The
2136 * icon_name is not a copy, and should not be modified or expected to
2137 * persist beyond the lifetime of the icon source.
2139 * Return value: icon name. This string must not be modified or freed.
2141 G_CONST_RETURN gchar*
2142 gtk_icon_source_get_icon_name (const GtkIconSource *source)
2144 g_return_val_if_fail (source != NULL, NULL);
2146 if (source->type == GTK_ICON_SOURCE_ICON_NAME ||
2147 source->type == GTK_ICON_SOURCE_STATIC_ICON_NAME)
2148 return source->source.icon_name;
2154 * gtk_icon_source_get_pixbuf:
2155 * @source: a #GtkIconSource
2157 * Retrieves the source pixbuf, or %NULL if none is set.
2158 * In addition, if a filename source is in use, this
2159 * function in some cases will return the pixbuf from
2160 * loaded from the filename. This is, for example, true
2161 * for the GtkIconSource passed to the GtkStyle::render_icon()
2162 * virtual function. The reference count on the pixbuf is
2165 * Return value: source pixbuf
2168 gtk_icon_source_get_pixbuf (const GtkIconSource *source)
2170 g_return_val_if_fail (source != NULL, NULL);
2172 if (source->type == GTK_ICON_SOURCE_PIXBUF)
2173 return source->source.pixbuf;
2174 else if (source->type == GTK_ICON_SOURCE_FILENAME)
2175 return source->filename_pixbuf;
2181 * gtk_icon_source_set_direction_wildcarded:
2182 * @source: a #GtkIconSource
2183 * @setting: %TRUE to wildcard the text direction
2185 * If the text direction is wildcarded, this source can be used
2186 * as the base image for an icon in any #GtkTextDirection.
2187 * If the text direction is not wildcarded, then the
2188 * text direction the icon source applies to should be set
2189 * with gtk_icon_source_set_direction(), and the icon source
2190 * will only be used with that text direction.
2192 * #GtkIconSet prefers non-wildcarded sources (exact matches) over
2193 * wildcarded sources, and will use an exact match when possible.
2196 gtk_icon_source_set_direction_wildcarded (GtkIconSource *source,
2199 g_return_if_fail (source != NULL);
2201 source->any_direction = setting != FALSE;
2205 * gtk_icon_source_set_state_wildcarded:
2206 * @source: a #GtkIconSource
2207 * @setting: %TRUE to wildcard the widget state
2209 * If the widget state is wildcarded, this source can be used as the
2210 * base image for an icon in any #GtkStateType. If the widget state
2211 * is not wildcarded, then the state the source applies to should be
2212 * set with gtk_icon_source_set_state() and the icon source will
2213 * only be used with that specific state.
2215 * #GtkIconSet prefers non-wildcarded sources (exact matches) over
2216 * wildcarded sources, and will use an exact match when possible.
2218 * #GtkIconSet will normally transform wildcarded source images to
2219 * produce an appropriate icon for a given state, for example
2220 * lightening an image on prelight, but will not modify source images
2221 * that match exactly.
2224 gtk_icon_source_set_state_wildcarded (GtkIconSource *source,
2227 g_return_if_fail (source != NULL);
2229 source->any_state = setting != FALSE;
2234 * gtk_icon_source_set_size_wildcarded:
2235 * @source: a #GtkIconSource
2236 * @setting: %TRUE to wildcard the widget state
2238 * If the icon size is wildcarded, this source can be used as the base
2239 * image for an icon of any size. If the size is not wildcarded, then
2240 * the size the source applies to should be set with
2241 * gtk_icon_source_set_size() and the icon source will only be used
2242 * with that specific size.
2244 * #GtkIconSet prefers non-wildcarded sources (exact matches) over
2245 * wildcarded sources, and will use an exact match when possible.
2247 * #GtkIconSet will normally scale wildcarded source images to produce
2248 * an appropriate icon at a given size, but will not change the size
2249 * of source images that match exactly.
2252 gtk_icon_source_set_size_wildcarded (GtkIconSource *source,
2255 g_return_if_fail (source != NULL);
2257 source->any_size = setting != FALSE;
2261 * gtk_icon_source_get_size_wildcarded:
2262 * @source: a #GtkIconSource
2264 * Gets the value set by gtk_icon_source_set_size_wildcarded().
2266 * Return value: %TRUE if this icon source is a base for any icon size variant
2269 gtk_icon_source_get_size_wildcarded (const GtkIconSource *source)
2271 g_return_val_if_fail (source != NULL, TRUE);
2273 return source->any_size;
2277 * gtk_icon_source_get_state_wildcarded:
2278 * @source: a #GtkIconSource
2280 * Gets the value set by gtk_icon_source_set_state_wildcarded().
2282 * Return value: %TRUE if this icon source is a base for any widget state variant
2285 gtk_icon_source_get_state_wildcarded (const GtkIconSource *source)
2287 g_return_val_if_fail (source != NULL, TRUE);
2289 return source->any_state;
2293 * gtk_icon_source_get_direction_wildcarded:
2294 * @source: a #GtkIconSource
2296 * Gets the value set by gtk_icon_source_set_direction_wildcarded().
2298 * Return value: %TRUE if this icon source is a base for any text direction variant
2301 gtk_icon_source_get_direction_wildcarded (const GtkIconSource *source)
2303 g_return_val_if_fail (source != NULL, TRUE);
2305 return source->any_direction;
2309 * gtk_icon_source_set_direction:
2310 * @source: a #GtkIconSource
2311 * @direction: text direction this source applies to
2313 * Sets the text direction this icon source is intended to be used
2316 * Setting the text direction on an icon source makes no difference
2317 * if the text direction is wildcarded. Therefore, you should usually
2318 * call gtk_icon_source_set_direction_wildcarded() to un-wildcard it
2319 * in addition to calling this function.
2322 gtk_icon_source_set_direction (GtkIconSource *source,
2323 GtkTextDirection direction)
2325 g_return_if_fail (source != NULL);
2327 source->direction = direction;
2331 * gtk_icon_source_set_state:
2332 * @source: a #GtkIconSource
2333 * @state: widget state this source applies to
2335 * Sets the widget state this icon source is intended to be used
2338 * Setting the widget state on an icon source makes no difference
2339 * if the state is wildcarded. Therefore, you should usually
2340 * call gtk_icon_source_set_state_wildcarded() to un-wildcard it
2341 * in addition to calling this function.
2344 gtk_icon_source_set_state (GtkIconSource *source,
2347 g_return_if_fail (source != NULL);
2349 source->state = state;
2353 * gtk_icon_source_set_size:
2354 * @source: a #GtkIconSource
2355 * @size: (type int): icon size this source applies to
2357 * Sets the icon size this icon source is intended to be used
2360 * Setting the icon size on an icon source makes no difference
2361 * if the size is wildcarded. Therefore, you should usually
2362 * call gtk_icon_source_set_size_wildcarded() to un-wildcard it
2363 * in addition to calling this function.
2366 gtk_icon_source_set_size (GtkIconSource *source,
2369 g_return_if_fail (source != NULL);
2371 source->size = size;
2375 * gtk_icon_source_get_direction:
2376 * @source: a #GtkIconSource
2378 * Obtains the text direction this icon source applies to. The return
2379 * value is only useful/meaningful if the text direction is <emphasis>not</emphasis>
2382 * Return value: text direction this source matches
2385 gtk_icon_source_get_direction (const GtkIconSource *source)
2387 g_return_val_if_fail (source != NULL, 0);
2389 return source->direction;
2393 * gtk_icon_source_get_state:
2394 * @source: a #GtkIconSource
2396 * Obtains the widget state this icon source applies to. The return
2397 * value is only useful/meaningful if the widget state is <emphasis>not</emphasis>
2400 * Return value: widget state this source matches
2403 gtk_icon_source_get_state (const GtkIconSource *source)
2405 g_return_val_if_fail (source != NULL, 0);
2407 return source->state;
2411 * gtk_icon_source_get_size:
2412 * @source: a #GtkIconSource
2414 * Obtains the icon size this source applies to. The return value
2415 * is only useful/meaningful if the icon size is <emphasis>not</emphasis> wildcarded.
2417 * Return value: (type int): icon size this source matches.
2420 gtk_icon_source_get_size (const GtkIconSource *source)
2422 g_return_val_if_fail (source != NULL, 0);
2424 return source->size;
2427 #define NUM_CACHED_ICONS 8
2429 typedef struct _CachedIcon CachedIcon;
2433 /* These must all match to use the cached pixbuf.
2434 * If any don't match, we must re-render the pixbuf.
2437 GtkTextDirection direction;
2445 ensure_cache_up_to_date (GtkIconSet *icon_set)
2447 if (icon_set->cache_serial != cache_serial)
2449 clear_cache (icon_set, TRUE);
2450 icon_set->cache_serial = cache_serial;
2455 cached_icon_free (CachedIcon *icon)
2457 g_object_unref (icon->pixbuf);
2460 g_object_unref (icon->style);
2466 find_in_cache (GtkIconSet *icon_set,
2468 GtkTextDirection direction,
2475 ensure_cache_up_to_date (icon_set);
2478 tmp_list = icon_set->cache;
2479 while (tmp_list != NULL)
2481 CachedIcon *icon = tmp_list->data;
2483 if (icon->style == style &&
2484 icon->direction == direction &&
2485 icon->state == state &&
2486 (size == (GtkIconSize)-1 || icon->size == size))
2490 /* Move this icon to the front of the list. */
2491 prev->next = tmp_list->next;
2492 tmp_list->next = icon_set->cache;
2493 icon_set->cache = tmp_list;
2496 return icon->pixbuf;
2500 tmp_list = g_slist_next (tmp_list);
2507 add_to_cache (GtkIconSet *icon_set,
2509 GtkTextDirection direction,
2516 ensure_cache_up_to_date (icon_set);
2518 g_object_ref (pixbuf);
2520 /* We have to ref the style, since if the style was finalized
2521 * its address could be reused by another style, creating a
2526 g_object_ref (style);
2528 icon = g_new (CachedIcon, 1);
2529 icon_set->cache = g_slist_prepend (icon_set->cache, icon);
2530 icon_set->cache_size++;
2532 icon->style = style;
2533 icon->direction = direction;
2534 icon->state = state;
2536 icon->pixbuf = pixbuf;
2539 attach_to_style (icon_set, icon->style);
2541 if (icon_set->cache_size >= NUM_CACHED_ICONS)
2543 /* Remove oldest item in the cache */
2546 tmp_list = icon_set->cache;
2548 /* Find next-to-last link */
2549 g_assert (NUM_CACHED_ICONS > 2);
2550 while (tmp_list->next->next)
2551 tmp_list = tmp_list->next;
2553 g_assert (tmp_list != NULL);
2554 g_assert (tmp_list->next != NULL);
2555 g_assert (tmp_list->next->next == NULL);
2557 /* Free the last icon */
2558 icon = tmp_list->next->data;
2560 g_slist_free (tmp_list->next);
2561 tmp_list->next = NULL;
2563 cached_icon_free (icon);
2568 clear_cache (GtkIconSet *icon_set,
2569 gboolean style_detach)
2571 GSList *cache, *tmp_list;
2572 GtkStyle *last_style = NULL;
2574 cache = icon_set->cache;
2575 icon_set->cache = NULL;
2576 icon_set->cache_size = 0;
2578 while (tmp_list != NULL)
2580 CachedIcon *icon = tmp_list->data;
2584 /* simple optimization for the case where the cache
2585 * contains contiguous icons from the same style.
2586 * it's safe to call detach_from_style more than
2587 * once on the same style though.
2589 if (last_style != icon->style)
2591 detach_from_style (icon_set, icon->style);
2592 last_style = icon->style;
2596 cached_icon_free (icon);
2598 tmp_list = g_slist_next (tmp_list);
2601 g_slist_free (cache);
2605 copy_cache (GtkIconSet *icon_set,
2606 GtkIconSet *copy_recipient)
2609 GSList *copy = NULL;
2611 ensure_cache_up_to_date (icon_set);
2613 tmp_list = icon_set->cache;
2614 while (tmp_list != NULL)
2616 CachedIcon *icon = tmp_list->data;
2617 CachedIcon *icon_copy = g_new (CachedIcon, 1);
2621 if (icon_copy->style)
2623 attach_to_style (copy_recipient, icon_copy->style);
2624 g_object_ref (icon_copy->style);
2627 g_object_ref (icon_copy->pixbuf);
2629 icon_copy->size = icon->size;
2631 copy = g_slist_prepend (copy, icon_copy);
2633 tmp_list = g_slist_next (tmp_list);
2636 return g_slist_reverse (copy);
2640 attach_to_style (GtkIconSet *icon_set,
2645 table = g_object_get_qdata (G_OBJECT (style),
2646 g_quark_try_string ("gtk-style-icon-sets"));
2650 table = g_hash_table_new (NULL, NULL);
2651 g_object_set_qdata_full (G_OBJECT (style),
2652 g_quark_from_static_string ("gtk-style-icon-sets"),
2657 g_hash_table_insert (table, icon_set, icon_set);
2661 detach_from_style (GtkIconSet *icon_set,
2666 table = g_object_get_qdata (G_OBJECT (style),
2667 g_quark_try_string ("gtk-style-icon-sets"));
2670 g_hash_table_remove (table, icon_set);
2674 iconsets_foreach (gpointer key,
2678 GtkIconSet *icon_set = key;
2680 /* We only need to remove cache entries for the given style;
2681 * but that complicates things because in destroy notify
2682 * we don't know which style got destroyed, and 95% of the
2683 * time all cache entries will have the same style,
2684 * so this is faster anyway.
2687 clear_cache (icon_set, FALSE);
2691 style_dnotify (gpointer data)
2693 GHashTable *table = data;
2695 g_hash_table_foreach (table, iconsets_foreach, NULL);
2697 g_hash_table_destroy (table);
2700 /* This allows the icon set to detect that its cache is out of date. */
2702 _gtk_icon_set_invalidate_caches (void)
2708 * _gtk_icon_factory_list_ids:
2710 * Gets all known IDs stored in an existing icon factory.
2711 * The strings in the returned list aren't copied.
2712 * The list itself should be freed.
2714 * Return value: List of ids in icon factories
2717 _gtk_icon_factory_list_ids (void)
2724 _gtk_icon_factory_ensure_default_icons ();
2726 tmp_list = all_icon_factories;
2727 while (tmp_list != NULL)
2730 GtkIconFactory *factory = GTK_ICON_FACTORY (tmp_list->data);
2731 GtkIconFactoryPriv *priv = factory->priv;
2733 these_ids = g_hash_table_get_keys (priv->icons);
2735 ids = g_list_concat (ids, these_ids);
2737 tmp_list = g_slist_next (tmp_list);
2747 } IconFactoryParserData;
2753 GtkTextDirection direction;
2756 } IconSourceParserData;
2759 icon_source_start_element (GMarkupParseContext *context,
2760 const gchar *element_name,
2761 const gchar **names,
2762 const gchar **values,
2767 gchar *stock_id = NULL;
2768 gchar *filename = NULL;
2769 gchar *icon_name = NULL;
2771 gint direction = -1;
2773 IconFactoryParserData *parser_data;
2774 IconSourceParserData *source_data;
2776 GQuark error_domain;
2778 parser_data = (IconFactoryParserData*)user_data;
2780 if (!parser_data->in_source)
2782 if (strcmp (element_name, "sources") != 0)
2784 error_msg = g_strdup_printf ("Unexpected element %s, expected <sources>", element_name);
2785 error_domain = GTK_BUILDER_ERROR_INVALID_TAG;
2788 parser_data->in_source = TRUE;
2793 if (strcmp (element_name, "source") != 0)
2795 error_msg = g_strdup_printf ("Unexpected element %s, expected <source>", element_name);
2796 error_domain = GTK_BUILDER_ERROR_INVALID_TAG;
2801 for (i = 0; names[i]; i++)
2803 if (strcmp (names[i], "stock-id") == 0)
2804 stock_id = g_strdup (values[i]);
2805 else if (strcmp (names[i], "filename") == 0)
2806 filename = g_strdup (values[i]);
2807 else if (strcmp (names[i], "icon-name") == 0)
2808 icon_name = g_strdup (values[i]);
2809 else if (strcmp (names[i], "size") == 0)
2811 if (!_gtk_builder_enum_from_string (GTK_TYPE_ICON_SIZE,
2817 else if (strcmp (names[i], "direction") == 0)
2819 if (!_gtk_builder_enum_from_string (GTK_TYPE_TEXT_DIRECTION,
2825 else if (strcmp (names[i], "state") == 0)
2827 if (!_gtk_builder_enum_from_string (GTK_TYPE_STATE_TYPE,
2835 error_msg = g_strdup_printf ("'%s' is not a valid attribute of <%s>",
2836 names[i], "source");
2837 error_domain = GTK_BUILDER_ERROR_INVALID_ATTRIBUTE;
2844 error_msg = g_strdup_printf ("<source> requires a stock_id");
2845 error_domain = GTK_BUILDER_ERROR_MISSING_ATTRIBUTE;
2849 source_data = g_slice_new (IconSourceParserData);
2850 source_data->stock_id = stock_id;
2851 source_data->filename = filename;
2852 source_data->icon_name = icon_name;
2853 source_data->size = size;
2854 source_data->direction = direction;
2855 source_data->state = state;
2857 parser_data->sources = g_slist_prepend (parser_data->sources, source_data);
2863 gint line_number, char_number;
2865 g_markup_parse_context_get_position (context,
2869 tmp = g_strdup_printf ("%s:%d:%d %s", "input",
2870 line_number, char_number, error_msg);
2872 g_set_error_literal (error,
2877 g_warning ("%s", tmp);
2887 static const GMarkupParser icon_source_parser =
2889 icon_source_start_element,
2893 gtk_icon_factory_buildable_custom_tag_start (GtkBuildable *buildable,
2894 GtkBuilder *builder,
2896 const gchar *tagname,
2897 GMarkupParser *parser,
2900 g_assert (buildable);
2902 if (strcmp (tagname, "sources") == 0)
2904 IconFactoryParserData *parser_data;
2906 parser_data = g_slice_new0 (IconFactoryParserData);
2907 *parser = icon_source_parser;
2908 *data = parser_data;
2915 gtk_icon_factory_buildable_custom_tag_end (GtkBuildable *buildable,
2916 GtkBuilder *builder,
2918 const gchar *tagname,
2919 gpointer *user_data)
2921 GtkIconFactory *icon_factory;
2923 icon_factory = GTK_ICON_FACTORY (buildable);
2925 if (strcmp (tagname, "sources") == 0)
2927 IconFactoryParserData *parser_data;
2928 GtkIconSource *icon_source;
2929 GtkIconSet *icon_set;
2932 parser_data = (IconFactoryParserData*)user_data;
2934 for (l = parser_data->sources; l; l = l->next)
2936 IconSourceParserData *source_data = l->data;
2938 icon_set = gtk_icon_factory_lookup (icon_factory, source_data->stock_id);
2941 icon_set = gtk_icon_set_new ();
2942 gtk_icon_factory_add (icon_factory, source_data->stock_id, icon_set);
2943 gtk_icon_set_unref (icon_set);
2946 icon_source = gtk_icon_source_new ();
2948 if (source_data->filename)
2951 filename = _gtk_builder_get_absolute_filename (builder, source_data->filename);
2952 gtk_icon_source_set_filename (icon_source, filename);
2955 if (source_data->icon_name)
2956 gtk_icon_source_set_icon_name (icon_source, source_data->icon_name);
2957 if (source_data->size != -1)
2959 gtk_icon_source_set_size (icon_source, source_data->size);
2960 gtk_icon_source_set_size_wildcarded (icon_source, FALSE);
2962 if (source_data->direction != -1)
2964 gtk_icon_source_set_direction (icon_source, source_data->direction);
2965 gtk_icon_source_set_direction_wildcarded (icon_source, FALSE);
2967 if (source_data->state != -1)
2969 gtk_icon_source_set_state (icon_source, source_data->state);
2970 gtk_icon_source_set_state_wildcarded (icon_source, FALSE);
2973 /* Inline source_add() to avoid creating a copy */
2974 g_assert (icon_source->type != GTK_ICON_SOURCE_EMPTY);
2975 icon_set->sources = g_slist_insert_sorted (icon_set->sources,
2977 icon_source_compare);
2979 g_free (source_data->stock_id);
2980 g_free (source_data->filename);
2981 g_free (source_data->icon_name);
2982 g_slice_free (IconSourceParserData, source_data);
2984 g_slist_free (parser_data->sources);
2985 g_slice_free (IconFactoryParserData, parser_data);
2987 /* TODO: Add an attribute/tag to prevent this.
2988 * Usually it's the right thing to do though.
2990 gtk_icon_factory_add_default (icon_factory);
2994 #if defined (G_OS_WIN32) && !defined (_WIN64)
2996 /* DLL ABI stability backward compatibility versions */
2998 #undef gtk_icon_source_set_filename
3001 gtk_icon_source_set_filename (GtkIconSource *source,
3002 const gchar *filename)
3004 gchar *utf8_filename = g_locale_to_utf8 (filename, -1, NULL, NULL, NULL);
3006 gtk_icon_source_set_filename_utf8 (source, utf8_filename);
3008 g_free (utf8_filename);
3011 #undef gtk_icon_source_get_filename
3013 G_CONST_RETURN gchar*
3014 gtk_icon_source_get_filename (const GtkIconSource *source)
3016 g_return_val_if_fail (source != NULL, NULL);
3018 if (source->type == GTK_ICON_SOURCE_FILENAME)
3019 return source->cp_filename;