1 /* GtkIconTheme - a loader for icon themes
2 * gtk-icon-theme.c Copyright (C) 2002, 2003 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.
22 #include <sys/types.h>
30 #include <glib/gstdio.h>
34 #define S_ISDIR(mode) ((mode)&_S_IFDIR)
36 #define WIN32_MEAN_AND_LEAN
38 #include "win32/gdkwin32.h"
39 #endif /* G_OS_WIN32 */
41 #include "gtkicontheme.h"
43 #include "gtkiconfactory.h"
44 #include "gtkiconcache.h"
45 #include "gtkbuiltincache.h"
48 #include "gtknumerableiconprivate.h"
49 #include "gtksettings.h"
50 #include "gtkprivate.h"
52 #define DEFAULT_THEME_NAME "hicolor"
57 ICON_THEME_DIR_SCALABLE,
58 ICON_THEME_DIR_THRESHOLD,
59 ICON_THEME_DIR_UNTHEMED
62 /* In reverse search order: */
66 ICON_SUFFIX_XPM = 1 << 0,
67 ICON_SUFFIX_SVG = 1 << 1,
68 ICON_SUFFIX_PNG = 1 << 2,
69 HAS_ICON_FILE = 1 << 3
73 struct _GtkIconThemePrivate
75 guint custom_theme : 1;
76 guint is_screen_singleton : 1;
77 guint pixbuf_supports_svg : 1;
78 guint themes_valid : 1;
79 guint check_reload : 1;
80 guint loading_themes : 1;
87 /* A list of all the themes needed to look up icons.
88 * In search order, without duplicates
91 GHashTable *unthemed_icons;
93 /* Note: The keys of this hashtable are owned by the
94 * themedir and unthemed hashtables.
96 GHashTable *all_icons;
98 /* GdkScreen for the icon theme (may be NULL)
102 /* time when we last stat:ed for theme changes */
106 gulong reset_styles_idle;
111 /* Information about the source
114 GLoadableIcon *loadable;
115 GSList *emblem_infos;
117 /* Cache pixbuf (if there is any) */
118 GdkPixbuf *cache_pixbuf;
122 /* Information about the directory where
123 * the source was found
125 IconThemeDirType dir_type;
129 /* Parameters influencing the scaled icon
132 guint raw_coordinates : 1;
133 guint forced_size : 1;
135 /* Cached information if we go ahead and try to load
141 gboolean emblems_applied;
153 /* In search order */
159 IconThemeDirType type;
174 GHashTable *icon_data;
180 char *no_svg_filename;
192 time_t mtime; /* 0 == not existing or not a dir */
197 static void gtk_icon_theme_finalize (GObject *object);
198 static void theme_dir_destroy (IconThemeDir *dir);
200 static void theme_destroy (IconTheme *theme);
201 static GtkIconInfo *theme_lookup_icon (IconTheme *theme,
202 const char *icon_name,
205 gboolean use_default_icons);
206 static void theme_list_icons (IconTheme *theme,
209 static void theme_list_contexts (IconTheme *theme,
210 GHashTable *contexts);
211 static void theme_subdir_load (GtkIconTheme *icon_theme,
213 GKeyFile *theme_file,
215 static void do_theme_change (GtkIconTheme *icon_theme);
217 static void blow_themes (GtkIconTheme *icon_themes);
218 static gboolean rescan_themes (GtkIconTheme *icon_themes);
220 static void icon_data_free (GtkIconData *icon_data);
221 static void load_icon_data (IconThemeDir *dir,
225 static IconSuffix theme_dir_get_icon_suffix (IconThemeDir *dir,
226 const gchar *icon_name,
227 gboolean *has_icon_file);
230 static GtkIconInfo *icon_info_new (void);
231 static GtkIconInfo *icon_info_new_builtin (BuiltinIcon *icon);
233 static IconSuffix suffix_from_name (const char *name);
235 static BuiltinIcon *find_builtin_icon (const gchar *icon_name,
237 gint *min_difference_p,
238 gboolean *has_larger_p);
240 static guint signal_changed = 0;
242 static GHashTable *icon_theme_builtin_icons;
244 /* also used in gtkiconfactory.c */
245 GtkIconCache *_builtin_cache = NULL;
246 static GList *builtin_dirs = NULL;
248 G_DEFINE_TYPE (GtkIconTheme, gtk_icon_theme, G_TYPE_OBJECT)
251 * gtk_icon_theme_new:
253 * Creates a new icon theme object. Icon theme objects are used
254 * to lookup up an icon by name in a particular icon theme.
255 * Usually, you'll want to use gtk_icon_theme_get_default()
256 * or gtk_icon_theme_get_for_screen() rather than creating
257 * a new icon theme object for scratch.
259 * Return value: the newly created #GtkIconTheme object.
264 gtk_icon_theme_new (void)
266 return g_object_new (GTK_TYPE_ICON_THEME, NULL);
270 * gtk_icon_theme_get_default:
272 * Gets the icon theme for the default screen. See
273 * gtk_icon_theme_get_for_screen().
275 * Return value: (transfer none): A unique #GtkIconTheme associated with
276 * the default screen. This icon theme is associated with
277 * the screen and can be used as long as the screen
278 * is open. Do not ref or unref it.
283 gtk_icon_theme_get_default (void)
285 return gtk_icon_theme_get_for_screen (gdk_screen_get_default ());
289 * gtk_icon_theme_get_for_screen:
290 * @screen: a #GdkScreen
292 * Gets the icon theme object associated with @screen; if this
293 * function has not previously been called for the given
294 * screen, a new icon theme object will be created and
295 * associated with the screen. Icon theme objects are
296 * fairly expensive to create, so using this function
297 * is usually a better choice than calling than gtk_icon_theme_new()
298 * and setting the screen yourself; by using this function
299 * a single icon theme object will be shared between users.
301 * Return value: (transfer none): A unique #GtkIconTheme associated with
302 * the given screen. This icon theme is associated with
303 * the screen and can be used as long as the screen
304 * is open. Do not ref or unref it.
309 gtk_icon_theme_get_for_screen (GdkScreen *screen)
311 GtkIconTheme *icon_theme;
313 g_return_val_if_fail (GDK_IS_SCREEN (screen), NULL);
315 icon_theme = g_object_get_data (G_OBJECT (screen), "gtk-icon-theme");
318 GtkIconThemePrivate *priv;
320 icon_theme = gtk_icon_theme_new ();
321 gtk_icon_theme_set_screen (icon_theme, screen);
323 priv = icon_theme->priv;
324 priv->is_screen_singleton = TRUE;
326 g_object_set_data (G_OBJECT (screen), I_("gtk-icon-theme"), icon_theme);
333 gtk_icon_theme_class_init (GtkIconThemeClass *klass)
335 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
337 gobject_class->finalize = gtk_icon_theme_finalize;
340 * GtkIconTheme::changed
341 * @icon_theme: the icon theme
343 * Emitted when the current icon theme is switched or GTK+ detects
344 * that a change has occurred in the contents of the current
347 signal_changed = g_signal_new (I_("changed"),
348 G_TYPE_FROM_CLASS (klass),
350 G_STRUCT_OFFSET (GtkIconThemeClass, changed),
352 g_cclosure_marshal_VOID__VOID,
355 g_type_class_add_private (klass, sizeof (GtkIconThemePrivate));
359 /* Callback when the display that the icon theme is attached to
360 * is closed; unset the screen, and if it's the unique theme
361 * for the screen, drop the reference
364 display_closed (GdkDisplay *display,
366 GtkIconTheme *icon_theme)
368 GtkIconThemePrivate *priv = icon_theme->priv;
369 GdkScreen *screen = priv->screen;
370 gboolean was_screen_singleton = priv->is_screen_singleton;
372 if (was_screen_singleton)
374 g_object_set_data (G_OBJECT (screen), I_("gtk-icon-theme"), NULL);
375 priv->is_screen_singleton = FALSE;
378 gtk_icon_theme_set_screen (icon_theme, NULL);
380 if (was_screen_singleton)
382 g_object_unref (icon_theme);
387 update_current_theme (GtkIconTheme *icon_theme)
389 #define theme_changed(_old, _new) \
390 ((_old && !_new) || (!_old && _new) || \
391 (_old && _new && strcmp (_old, _new) != 0))
392 GtkIconThemePrivate *priv = icon_theme->priv;
394 if (!priv->custom_theme)
397 gchar *fallback_theme = NULL;
398 gboolean changed = FALSE;
402 GtkSettings *settings = gtk_settings_get_for_screen (priv->screen);
403 g_object_get (settings,
404 "gtk-icon-theme-name", &theme,
405 "gtk-fallback-icon-theme", &fallback_theme, NULL);
408 /* ensure that the current theme (even when just the default)
409 * is searched before any fallback theme
411 if (!theme && fallback_theme)
412 theme = g_strdup (DEFAULT_THEME_NAME);
414 if (theme_changed (priv->current_theme, theme))
416 g_free (priv->current_theme);
417 priv->current_theme = theme;
423 if (theme_changed (priv->fallback_theme, fallback_theme))
425 g_free (priv->fallback_theme);
426 priv->fallback_theme = fallback_theme;
430 g_free (fallback_theme);
433 do_theme_change (icon_theme);
438 /* Callback when the icon theme GtkSetting changes
441 theme_changed (GtkSettings *settings,
443 GtkIconTheme *icon_theme)
445 update_current_theme (icon_theme);
449 unset_screen (GtkIconTheme *icon_theme)
451 GtkIconThemePrivate *priv = icon_theme->priv;
452 GtkSettings *settings;
457 settings = gtk_settings_get_for_screen (priv->screen);
458 display = gdk_screen_get_display (priv->screen);
460 g_signal_handlers_disconnect_by_func (display,
461 (gpointer) display_closed,
463 g_signal_handlers_disconnect_by_func (settings,
464 (gpointer) theme_changed,
472 * gtk_icon_theme_set_screen:
473 * @icon_theme: a #GtkIconTheme
474 * @screen: a #GdkScreen
476 * Sets the screen for an icon theme; the screen is used
477 * to track the user's currently configured icon theme,
478 * which might be different for different screens.
483 gtk_icon_theme_set_screen (GtkIconTheme *icon_theme,
486 GtkIconThemePrivate *priv;
487 GtkSettings *settings;
490 g_return_if_fail (GTK_ICON_THEME (icon_theme));
491 g_return_if_fail (screen == NULL || GDK_IS_SCREEN (screen));
493 priv = icon_theme->priv;
495 unset_screen (icon_theme);
499 display = gdk_screen_get_display (screen);
500 settings = gtk_settings_get_for_screen (screen);
502 priv->screen = screen;
504 g_signal_connect (display, "closed",
505 G_CALLBACK (display_closed), icon_theme);
506 g_signal_connect (settings, "notify::gtk-icon-theme-name",
507 G_CALLBACK (theme_changed), icon_theme);
508 g_signal_connect (settings, "notify::gtk-fallback-icon-theme-name",
509 G_CALLBACK (theme_changed), icon_theme);
512 update_current_theme (icon_theme);
515 /* Checks whether a loader for SVG files has been registered
519 pixbuf_supports_svg (void)
523 static gint found_svg = -1;
528 formats = gdk_pixbuf_get_formats ();
531 for (tmp_list = formats; tmp_list && !found_svg; tmp_list = tmp_list->next)
533 gchar **mime_types = gdk_pixbuf_format_get_mime_types (tmp_list->data);
536 for (mime_type = mime_types; *mime_type && !found_svg; mime_type++)
538 if (strcmp (*mime_type, "image/svg") == 0)
542 g_strfreev (mime_types);
545 g_slist_free (formats);
551 gtk_icon_theme_init (GtkIconTheme *icon_theme)
553 GtkIconThemePrivate *priv;
554 const gchar * const *xdg_data_dirs;
557 priv = G_TYPE_INSTANCE_GET_PRIVATE (icon_theme,
559 GtkIconThemePrivate);
560 icon_theme->priv = priv;
562 priv->custom_theme = FALSE;
564 xdg_data_dirs = g_get_system_data_dirs ();
565 for (i = 0; xdg_data_dirs[i]; i++) ;
567 priv->search_path_len = 2 * i + 2;
569 priv->search_path = g_new (char *, priv->search_path_len);
572 priv->search_path[i++] = g_build_filename (g_get_home_dir (), ".icons", NULL);
573 priv->search_path[i++] = g_build_filename (g_get_user_data_dir (), "icons", NULL);
575 for (j = 0; xdg_data_dirs[j]; j++)
576 priv->search_path[i++] = g_build_filename (xdg_data_dirs[j], "icons", NULL);
578 for (j = 0; xdg_data_dirs[j]; j++)
579 priv->search_path[i++] = g_build_filename (xdg_data_dirs[j], "pixmaps", NULL);
581 priv->themes_valid = FALSE;
583 priv->unthemed_icons = NULL;
585 priv->pixbuf_supports_svg = pixbuf_supports_svg ();
589 free_dir_mtime (IconThemeDirMtime *dir_mtime)
591 if (dir_mtime->cache)
592 _gtk_icon_cache_unref (dir_mtime->cache);
594 g_free (dir_mtime->dir);
595 g_slice_free (IconThemeDirMtime, dir_mtime);
600 reset_styles_idle (gpointer user_data)
602 GtkIconTheme *icon_theme;
603 GtkIconThemePrivate *priv;
605 icon_theme = GTK_ICON_THEME (user_data);
606 priv = icon_theme->priv;
608 if (priv->screen && priv->is_screen_singleton)
609 gtk_style_context_reset_widgets (priv->screen);
611 priv->reset_styles_idle = 0;
617 do_theme_change (GtkIconTheme *icon_theme)
619 GtkIconThemePrivate *priv = icon_theme->priv;
621 if (!priv->themes_valid)
625 g_print ("change to icon theme \"%s\"\n", priv->current_theme));
626 blow_themes (icon_theme);
627 g_signal_emit (icon_theme, signal_changed, 0);
629 if (!priv->reset_styles_idle)
630 priv->reset_styles_idle =
631 gdk_threads_add_idle_full (GTK_PRIORITY_RESIZE - 2,
632 reset_styles_idle, icon_theme, NULL);
636 blow_themes (GtkIconTheme *icon_theme)
638 GtkIconThemePrivate *priv = icon_theme->priv;
640 if (priv->themes_valid)
642 g_hash_table_destroy (priv->all_icons);
643 g_list_foreach (priv->themes, (GFunc)theme_destroy, NULL);
644 g_list_free (priv->themes);
645 g_list_foreach (priv->dir_mtimes, (GFunc)free_dir_mtime, NULL);
646 g_list_free (priv->dir_mtimes);
647 g_hash_table_destroy (priv->unthemed_icons);
650 priv->unthemed_icons = NULL;
651 priv->dir_mtimes = NULL;
652 priv->all_icons = NULL;
653 priv->themes_valid = FALSE;
657 gtk_icon_theme_finalize (GObject *object)
659 GtkIconTheme *icon_theme;
660 GtkIconThemePrivate *priv;
663 icon_theme = GTK_ICON_THEME (object);
664 priv = icon_theme->priv;
666 if (priv->reset_styles_idle)
668 g_source_remove (priv->reset_styles_idle);
669 priv->reset_styles_idle = 0;
672 unset_screen (icon_theme);
674 g_free (priv->current_theme);
675 priv->current_theme = NULL;
677 for (i = 0; i < priv->search_path_len; i++)
678 g_free (priv->search_path[i]);
680 g_free (priv->search_path);
681 priv->search_path = NULL;
683 blow_themes (icon_theme);
685 G_OBJECT_CLASS (gtk_icon_theme_parent_class)->finalize (object);
689 * gtk_icon_theme_set_search_path:
690 * @icon_theme: a #GtkIconTheme
691 * @path: (array length=n_elements) (element-type filename): array of
692 * directories that are searched for icon themes
693 * @n_elements: number of elements in @path.
695 * Sets the search path for the icon theme object. When looking
696 * for an icon theme, GTK+ will search for a subdirectory of
697 * one or more of the directories in @path with the same name
698 * as the icon theme. (Themes from multiple of the path elements
699 * are combined to allow themes to be extended by adding icons
700 * in the user's home directory.)
702 * In addition if an icon found isn't found either in the current
703 * icon theme or the default icon theme, and an image file with
704 * the right name is found directly in one of the elements of
705 * @path, then that image will be used for the icon name.
706 * (This is legacy feature, and new icons should be put
707 * into the default icon theme, which is called DEFAULT_THEME_NAME,
708 * rather than directly on the icon path.)
713 gtk_icon_theme_set_search_path (GtkIconTheme *icon_theme,
717 GtkIconThemePrivate *priv;
720 g_return_if_fail (GTK_IS_ICON_THEME (icon_theme));
722 priv = icon_theme->priv;
723 for (i = 0; i < priv->search_path_len; i++)
724 g_free (priv->search_path[i]);
726 g_free (priv->search_path);
728 priv->search_path = g_new (gchar *, n_elements);
729 priv->search_path_len = n_elements;
731 for (i = 0; i < priv->search_path_len; i++)
732 priv->search_path[i] = g_strdup (path[i]);
734 do_theme_change (icon_theme);
739 * gtk_icon_theme_get_search_path:
740 * @icon_theme: a #GtkIconTheme
741 * @path: (allow-none) (array length=n_elements) (element-type filename) (out):
742 * location to store a list of icon theme path directories or %NULL.
743 * The stored value should be freed with g_strfreev().
744 * @n_elements: location to store number of elements in @path, or %NULL
746 * Gets the current search path. See gtk_icon_theme_set_search_path().
751 gtk_icon_theme_get_search_path (GtkIconTheme *icon_theme,
755 GtkIconThemePrivate *priv;
758 g_return_if_fail (GTK_IS_ICON_THEME (icon_theme));
760 priv = icon_theme->priv;
763 *n_elements = priv->search_path_len;
767 *path = g_new (gchar *, priv->search_path_len + 1);
768 for (i = 0; i < priv->search_path_len; i++)
769 (*path)[i] = g_strdup (priv->search_path[i]);
775 * gtk_icon_theme_append_search_path:
776 * @icon_theme: a #GtkIconTheme
777 * @path: (type filename): directory name to append to the icon path
779 * Appends a directory to the search path.
780 * See gtk_icon_theme_set_search_path().
785 gtk_icon_theme_append_search_path (GtkIconTheme *icon_theme,
788 GtkIconThemePrivate *priv;
790 g_return_if_fail (GTK_IS_ICON_THEME (icon_theme));
791 g_return_if_fail (path != NULL);
793 priv = icon_theme->priv;
795 priv->search_path_len++;
797 priv->search_path = g_renew (gchar *, priv->search_path, priv->search_path_len);
798 priv->search_path[priv->search_path_len-1] = g_strdup (path);
800 do_theme_change (icon_theme);
804 * gtk_icon_theme_prepend_search_path:
805 * @icon_theme: a #GtkIconTheme
806 * @path: (type filename): directory name to prepend to the icon path
808 * Prepends a directory to the search path.
809 * See gtk_icon_theme_set_search_path().
814 gtk_icon_theme_prepend_search_path (GtkIconTheme *icon_theme,
817 GtkIconThemePrivate *priv;
820 g_return_if_fail (GTK_IS_ICON_THEME (icon_theme));
821 g_return_if_fail (path != NULL);
823 priv = icon_theme->priv;
825 priv->search_path_len++;
826 priv->search_path = g_renew (gchar *, priv->search_path, priv->search_path_len);
828 for (i = priv->search_path_len - 1; i > 0; i--)
829 priv->search_path[i] = priv->search_path[i - 1];
831 priv->search_path[0] = g_strdup (path);
833 do_theme_change (icon_theme);
837 * gtk_icon_theme_set_custom_theme:
838 * @icon_theme: a #GtkIconTheme
839 * @theme_name: (allow-none): name of icon theme to use instead of
840 * configured theme, or %NULL to unset a previously set custom theme
842 * Sets the name of the icon theme that the #GtkIconTheme object uses
843 * overriding system configuration. This function cannot be called
844 * on the icon theme objects returned from gtk_icon_theme_get_default()
845 * and gtk_icon_theme_get_for_screen().
850 gtk_icon_theme_set_custom_theme (GtkIconTheme *icon_theme,
851 const gchar *theme_name)
853 GtkIconThemePrivate *priv;
855 g_return_if_fail (GTK_IS_ICON_THEME (icon_theme));
857 priv = icon_theme->priv;
859 g_return_if_fail (!priv->is_screen_singleton);
861 if (theme_name != NULL)
863 priv->custom_theme = TRUE;
864 if (!priv->current_theme || strcmp (theme_name, priv->current_theme) != 0)
866 g_free (priv->current_theme);
867 priv->current_theme = g_strdup (theme_name);
869 do_theme_change (icon_theme);
874 if (priv->custom_theme)
876 priv->custom_theme = FALSE;
878 update_current_theme (icon_theme);
884 insert_theme (GtkIconTheme *icon_theme, const char *theme_name)
890 GtkIconThemePrivate *priv;
891 IconTheme *theme = NULL;
893 GKeyFile *theme_file;
894 GError *error = NULL;
895 IconThemeDirMtime *dir_mtime;
896 struct stat stat_buf;
898 priv = icon_theme->priv;
900 for (l = priv->themes; l != NULL; l = l->next)
903 if (strcmp (theme->name, theme_name) == 0)
907 for (i = 0; i < priv->search_path_len; i++)
909 path = g_build_filename (priv->search_path[i],
912 dir_mtime = g_slice_new (IconThemeDirMtime);
913 dir_mtime->cache = NULL;
914 dir_mtime->dir = path;
915 if (g_stat (path, &stat_buf) == 0 && S_ISDIR (stat_buf.st_mode))
916 dir_mtime->mtime = stat_buf.st_mtime;
918 dir_mtime->mtime = 0;
920 priv->dir_mtimes = g_list_prepend (priv->dir_mtimes, dir_mtime);
922 priv->dir_mtimes = g_list_reverse (priv->dir_mtimes);
925 for (i = 0; i < priv->search_path_len && !theme_file; i++)
927 path = g_build_filename (priv->search_path[i],
931 if (g_file_test (path, G_FILE_TEST_IS_REGULAR))
933 theme_file = g_key_file_new ();
934 g_key_file_set_list_separator (theme_file, ',');
935 g_key_file_load_from_file (theme_file, path, 0, &error);
938 g_key_file_free (theme_file);
940 g_error_free (error);
947 if (theme_file || strcmp (theme_name, DEFAULT_THEME_NAME) == 0)
949 theme = g_new0 (IconTheme, 1);
950 theme->name = g_strdup (theme_name);
951 priv->themes = g_list_prepend (priv->themes, theme);
954 if (theme_file == NULL)
957 theme->display_name =
958 g_key_file_get_locale_string (theme_file, "Icon Theme", "Name", NULL, NULL);
959 if (!theme->display_name)
960 g_warning ("Theme file for %s has no name\n", theme_name);
962 dirs = g_key_file_get_string_list (theme_file, "Icon Theme", "Directories", NULL, NULL);
965 g_warning ("Theme file for %s has no directories\n", theme_name);
966 priv->themes = g_list_remove (priv->themes, theme);
967 g_free (theme->name);
968 g_free (theme->display_name);
970 g_key_file_free (theme_file);
975 g_key_file_get_locale_string (theme_file,
976 "Icon Theme", "Comment",
979 g_key_file_get_string (theme_file,
980 "Icon Theme", "Example",
984 for (i = 0; dirs[i] != NULL; i++)
985 theme_subdir_load (icon_theme, theme, theme_file, dirs[i]);
989 theme->dirs = g_list_reverse (theme->dirs);
991 themes = g_key_file_get_string_list (theme_file,
998 for (i = 0; themes[i] != NULL; i++)
999 insert_theme (icon_theme, themes[i]);
1001 g_strfreev (themes);
1004 g_key_file_free (theme_file);
1008 free_unthemed_icon (UnthemedIcon *unthemed_icon)
1010 g_free (unthemed_icon->svg_filename);
1011 g_free (unthemed_icon->no_svg_filename);
1012 g_slice_free (UnthemedIcon, unthemed_icon);
1016 strip_suffix (const char *filename)
1020 dot = strrchr (filename, '.');
1023 return g_strdup (filename);
1025 return g_strndup (filename, dot - filename);
1029 load_themes (GtkIconTheme *icon_theme)
1031 GtkIconThemePrivate *priv;
1036 UnthemedIcon *unthemed_icon;
1037 IconSuffix old_suffix, new_suffix;
1039 IconThemeDirMtime *dir_mtime;
1040 struct stat stat_buf;
1042 priv = icon_theme->priv;
1044 priv->all_icons = g_hash_table_new (g_str_hash, g_str_equal);
1046 if (priv->current_theme)
1047 insert_theme (icon_theme, priv->current_theme);
1049 /* Always look in the "default" icon theme, and in a fallback theme */
1050 if (priv->fallback_theme)
1051 insert_theme (icon_theme, priv->fallback_theme);
1052 insert_theme (icon_theme, DEFAULT_THEME_NAME);
1053 priv->themes = g_list_reverse (priv->themes);
1056 priv->unthemed_icons = g_hash_table_new_full (g_str_hash, g_str_equal,
1057 g_free, (GDestroyNotify)free_unthemed_icon);
1059 for (base = 0; base < icon_theme->priv->search_path_len; base++)
1061 dir = icon_theme->priv->search_path[base];
1063 dir_mtime = g_slice_new (IconThemeDirMtime);
1064 priv->dir_mtimes = g_list_append (priv->dir_mtimes, dir_mtime);
1066 dir_mtime->dir = g_strdup (dir);
1067 dir_mtime->mtime = 0;
1068 dir_mtime->cache = NULL;
1070 if (g_stat (dir, &stat_buf) != 0 || !S_ISDIR (stat_buf.st_mode))
1072 dir_mtime->mtime = stat_buf.st_mtime;
1074 dir_mtime->cache = _gtk_icon_cache_new_for_path (dir);
1075 if (dir_mtime->cache != NULL)
1078 gdir = g_dir_open (dir, 0, NULL);
1082 while ((file = g_dir_read_name (gdir)))
1084 new_suffix = suffix_from_name (file);
1086 if (new_suffix != ICON_SUFFIX_NONE)
1091 abs_file = g_build_filename (dir, file, NULL);
1092 base_name = strip_suffix (file);
1094 if ((unthemed_icon = g_hash_table_lookup (priv->unthemed_icons,
1097 if (new_suffix == ICON_SUFFIX_SVG)
1099 if (unthemed_icon->svg_filename)
1102 unthemed_icon->svg_filename = abs_file;
1106 if (unthemed_icon->no_svg_filename)
1108 old_suffix = suffix_from_name (unthemed_icon->no_svg_filename);
1109 if (new_suffix > old_suffix)
1111 g_free (unthemed_icon->no_svg_filename);
1112 unthemed_icon->no_svg_filename = abs_file;
1118 unthemed_icon->no_svg_filename = abs_file;
1125 unthemed_icon = g_slice_new0 (UnthemedIcon);
1127 if (new_suffix == ICON_SUFFIX_SVG)
1128 unthemed_icon->svg_filename = abs_file;
1130 unthemed_icon->no_svg_filename = abs_file;
1132 g_hash_table_insert (priv->unthemed_icons,
1135 g_hash_table_insert (priv->all_icons,
1143 priv->themes_valid = TRUE;
1145 g_get_current_time(&tv);
1146 priv->last_stat_time = tv.tv_sec;
1150 _gtk_icon_theme_ensure_builtin_cache (void)
1152 static gboolean initialized = FALSE;
1154 static IconThemeDir dirs[5] =
1156 { ICON_THEME_DIR_THRESHOLD, 0, 16, 16, 16, 2, NULL, "16", -1, NULL, NULL, NULL },
1157 { ICON_THEME_DIR_THRESHOLD, 0, 20, 20, 20, 2, NULL, "20", -1, NULL, NULL, NULL },
1158 { ICON_THEME_DIR_THRESHOLD, 0, 24, 24, 24, 2, NULL, "24", -1, NULL, NULL, NULL },
1159 { ICON_THEME_DIR_THRESHOLD, 0, 32, 32, 32, 2, NULL, "32", -1, NULL, NULL, NULL },
1160 { ICON_THEME_DIR_THRESHOLD, 0, 48, 48, 48, 2, NULL, "48", -1, NULL, NULL, NULL }
1168 _builtin_cache = _gtk_icon_cache_new ((gchar *)builtin_icons);
1170 for (i = 0; i < G_N_ELEMENTS (dirs); i++)
1173 dir->cache = _gtk_icon_cache_ref (_builtin_cache);
1174 dir->subdir_index = _gtk_icon_cache_get_directory_index (dir->cache, dir->subdir);
1176 builtin_dirs = g_list_append (builtin_dirs, dir);
1182 ensure_valid_themes (GtkIconTheme *icon_theme)
1184 GtkIconThemePrivate *priv = icon_theme->priv;
1186 gboolean was_valid = priv->themes_valid;
1188 if (priv->loading_themes)
1190 priv->loading_themes = TRUE;
1192 _gtk_icon_theme_ensure_builtin_cache ();
1194 if (priv->themes_valid)
1196 g_get_current_time (&tv);
1198 if (ABS (tv.tv_sec - priv->last_stat_time) > 5 &&
1199 rescan_themes (icon_theme))
1200 blow_themes (icon_theme);
1203 if (!priv->themes_valid)
1205 load_themes (icon_theme);
1209 g_signal_emit (icon_theme, signal_changed, 0);
1213 priv->loading_themes = FALSE;
1216 static GtkIconInfo *
1217 choose_icon (GtkIconTheme *icon_theme,
1218 const gchar *icon_names[],
1220 GtkIconLookupFlags flags)
1222 GtkIconThemePrivate *priv;
1224 GtkIconInfo *icon_info = NULL;
1225 UnthemedIcon *unthemed_icon = NULL;
1227 gboolean use_builtin;
1230 priv = icon_theme->priv;
1232 if (flags & GTK_ICON_LOOKUP_NO_SVG)
1234 else if (flags & GTK_ICON_LOOKUP_FORCE_SVG)
1237 allow_svg = priv->pixbuf_supports_svg;
1239 use_builtin = flags & GTK_ICON_LOOKUP_USE_BUILTIN;
1241 ensure_valid_themes (icon_theme);
1243 for (l = priv->themes; l; l = l->next)
1245 IconTheme *theme = l->data;
1247 for (i = 0; icon_names[i]; i++)
1249 icon_info = theme_lookup_icon (theme, icon_names[i], size, allow_svg, use_builtin);
1255 for (i = 0; icon_names[i]; i++)
1257 unthemed_icon = g_hash_table_lookup (priv->unthemed_icons, icon_names[i]);
1262 /* Still not found an icon, check if reference to a Win32 resource */
1268 resources = g_strsplit (icon_names[0], ",", 0);
1271 wchar_t *wfile = g_utf8_to_utf16 (resources[0], -1, NULL, NULL, NULL);
1272 ExtractIconExW (wfile, resources[1] ? atoi (resources[1]) : 0, &hIcon, NULL, 1);
1278 icon_info = icon_info_new ();
1279 icon_info->cache_pixbuf = gdk_win32_icon_to_pixbuf_libgtk_only (hIcon);
1280 DestroyIcon (hIcon);
1281 icon_info->dir_type = ICON_THEME_DIR_UNTHEMED;
1282 icon_info->dir_size = size;
1284 g_strfreev (resources);
1290 icon_info = icon_info_new ();
1292 /* A SVG icon, when allowed, beats out a XPM icon, but not
1296 unthemed_icon->svg_filename &&
1297 (!unthemed_icon->no_svg_filename ||
1298 suffix_from_name (unthemed_icon->no_svg_filename) != ICON_SUFFIX_PNG))
1299 icon_info->filename = g_strdup (unthemed_icon->svg_filename);
1300 else if (unthemed_icon->no_svg_filename)
1301 icon_info->filename = g_strdup (unthemed_icon->no_svg_filename);
1303 icon_info->dir_type = ICON_THEME_DIR_UNTHEMED;
1304 icon_info->dir_size = size;
1310 icon_info->desired_size = size;
1311 icon_info->forced_size = (flags & GTK_ICON_LOOKUP_FORCE_SIZE) != 0;
1315 static gboolean check_for_default_theme = TRUE;
1316 char *default_theme_path;
1317 gboolean found = FALSE;
1320 if (check_for_default_theme)
1322 check_for_default_theme = FALSE;
1324 for (i = 0; !found && i < priv->search_path_len; i++)
1326 default_theme_path = g_build_filename (priv->search_path[i],
1330 found = g_file_test (default_theme_path, G_FILE_TEST_IS_REGULAR);
1331 g_free (default_theme_path);
1336 g_warning (_("Could not find the icon '%s'. The '%s' theme\n"
1337 "was not found either, perhaps you need to install it.\n"
1338 "You can get a copy from:\n"
1340 icon_names[0], DEFAULT_THEME_NAME, "http://icon-theme.freedesktop.org/releases");
1350 * gtk_icon_theme_lookup_icon:
1351 * @icon_theme: a #GtkIconTheme
1352 * @icon_name: the name of the icon to lookup
1353 * @size: desired icon size
1354 * @flags: flags modifying the behavior of the icon lookup
1356 * Looks up a named icon and returns a structure containing
1357 * information such as the filename of the icon. The icon
1358 * can then be rendered into a pixbuf using
1359 * gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon()
1360 * combines these two steps if all you need is the pixbuf.)
1362 * Return value: a #GtkIconInfo structure containing information
1363 * about the icon, or %NULL if the icon wasn't found. Free with
1364 * gtk_icon_info_free()
1369 gtk_icon_theme_lookup_icon (GtkIconTheme *icon_theme,
1370 const gchar *icon_name,
1372 GtkIconLookupFlags flags)
1376 g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), NULL);
1377 g_return_val_if_fail (icon_name != NULL, NULL);
1378 g_return_val_if_fail ((flags & GTK_ICON_LOOKUP_NO_SVG) == 0 ||
1379 (flags & GTK_ICON_LOOKUP_FORCE_SVG) == 0, NULL);
1381 GTK_NOTE (ICONTHEME,
1382 g_print ("gtk_icon_theme_lookup_icon %s\n", icon_name));
1384 if (flags & GTK_ICON_LOOKUP_GENERIC_FALLBACK)
1391 for (p = (gchar *) icon_name; *p; p++)
1395 names = g_new (gchar *, dashes + 2);
1396 names[0] = g_strdup (icon_name);
1397 for (i = 1; i <= dashes; i++)
1399 names[i] = g_strdup (names[i - 1]);
1400 p = strrchr (names[i], '-');
1403 names[dashes + 1] = NULL;
1405 info = choose_icon (icon_theme, (const gchar **) names, size, flags);
1411 const gchar *names[2];
1413 names[0] = icon_name;
1416 info = choose_icon (icon_theme, names, size, flags);
1423 * gtk_icon_theme_choose_icon:
1424 * @icon_theme: a #GtkIconTheme
1425 * @icon_names: (array zero-terminated=1): %NULL-terminated array of
1426 * icon names to lookup
1427 * @size: desired icon size
1428 * @flags: flags modifying the behavior of the icon lookup
1430 * Looks up a named icon and returns a structure containing
1431 * information such as the filename of the icon. The icon
1432 * can then be rendered into a pixbuf using
1433 * gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon()
1434 * combines these two steps if all you need is the pixbuf.)
1436 * If @icon_names contains more than one name, this function
1437 * tries them all in the given order before falling back to
1438 * inherited icon themes.
1440 * Return value: a #GtkIconInfo structure containing information
1441 * about the icon, or %NULL if the icon wasn't found. Free with
1442 * gtk_icon_info_free()
1447 gtk_icon_theme_choose_icon (GtkIconTheme *icon_theme,
1448 const gchar *icon_names[],
1450 GtkIconLookupFlags flags)
1452 g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), NULL);
1453 g_return_val_if_fail (icon_names != NULL, NULL);
1454 g_return_val_if_fail ((flags & GTK_ICON_LOOKUP_NO_SVG) == 0 ||
1455 (flags & GTK_ICON_LOOKUP_FORCE_SVG) == 0, NULL);
1457 return choose_icon (icon_theme, icon_names, size, flags);
1462 gtk_icon_theme_error_quark (void)
1464 return g_quark_from_static_string ("gtk-icon-theme-error-quark");
1468 * gtk_icon_theme_load_icon:
1469 * @icon_theme: a #GtkIconTheme
1470 * @icon_name: the name of the icon to lookup
1471 * @size: the desired icon size. The resulting icon may not be
1472 * exactly this size; see gtk_icon_info_load_icon().
1473 * @flags: flags modifying the behavior of the icon lookup
1474 * @error: (allow-none): Location to store error information on failure,
1477 * Looks up an icon in an icon theme, scales it to the given size
1478 * and renders it into a pixbuf. This is a convenience function;
1479 * if more details about the icon are needed, use
1480 * gtk_icon_theme_lookup_icon() followed by gtk_icon_info_load_icon().
1482 * Note that you probably want to listen for icon theme changes and
1483 * update the icon. This is usually done by connecting to the
1484 * GtkWidget::style-set signal. If for some reason you do not want to
1485 * update the icon when the icon theme changes, you should consider
1486 * using gdk_pixbuf_copy() to make a private copy of the pixbuf
1487 * returned by this function. Otherwise GTK+ may need to keep the old
1488 * icon theme loaded, which would be a waste of memory.
1490 * Return value: (transfer full): the rendered icon; this may be a
1491 * newly created icon or a new reference to an internal icon, so
1492 * you must not modify the icon. Use g_object_unref() to release
1493 * your reference to the icon. %NULL if the icon isn't found.
1498 gtk_icon_theme_load_icon (GtkIconTheme *icon_theme,
1499 const gchar *icon_name,
1501 GtkIconLookupFlags flags,
1504 GtkIconInfo *icon_info;
1505 GdkPixbuf *pixbuf = NULL;
1507 g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), NULL);
1508 g_return_val_if_fail (icon_name != NULL, NULL);
1509 g_return_val_if_fail ((flags & GTK_ICON_LOOKUP_NO_SVG) == 0 ||
1510 (flags & GTK_ICON_LOOKUP_FORCE_SVG) == 0, NULL);
1511 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1513 icon_info = gtk_icon_theme_lookup_icon (icon_theme, icon_name, size,
1514 flags | GTK_ICON_LOOKUP_USE_BUILTIN);
1517 g_set_error (error, GTK_ICON_THEME_ERROR, GTK_ICON_THEME_NOT_FOUND,
1518 _("Icon '%s' not present in theme"), icon_name);
1522 pixbuf = gtk_icon_info_load_icon (icon_info, error);
1523 gtk_icon_info_free (icon_info);
1529 * gtk_icon_theme_has_icon:
1530 * @icon_theme: a #GtkIconTheme
1531 * @icon_name: the name of an icon
1533 * Checks whether an icon theme includes an icon
1534 * for a particular name.
1536 * Return value: %TRUE if @icon_theme includes an
1537 * icon for @icon_name.
1542 gtk_icon_theme_has_icon (GtkIconTheme *icon_theme,
1543 const char *icon_name)
1545 GtkIconThemePrivate *priv;
1548 g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), FALSE);
1549 g_return_val_if_fail (icon_name != NULL, FALSE);
1551 priv = icon_theme->priv;
1553 ensure_valid_themes (icon_theme);
1555 for (l = priv->dir_mtimes; l; l = l->next)
1557 IconThemeDirMtime *dir_mtime = l->data;
1558 GtkIconCache *cache = dir_mtime->cache;
1560 if (cache && _gtk_icon_cache_has_icon (cache, icon_name))
1564 if (g_hash_table_lookup_extended (priv->all_icons,
1565 icon_name, NULL, NULL))
1568 if (_builtin_cache &&
1569 _gtk_icon_cache_has_icon (_builtin_cache, icon_name))
1572 if (icon_theme_builtin_icons &&
1573 g_hash_table_lookup_extended (icon_theme_builtin_icons,
1574 icon_name, NULL, NULL))
1581 add_size (gpointer key,
1585 gint **res_p = user_data;
1587 **res_p = GPOINTER_TO_INT (key);
1593 * gtk_icon_theme_get_icon_sizes:
1594 * @icon_theme: a #GtkIconTheme
1595 * @icon_name: the name of an icon
1597 * Returns an array of integers describing the sizes at which
1598 * the icon is available without scaling. A size of -1 means
1599 * that the icon is available in a scalable format. The array
1600 * is zero-terminated.
1602 * Return value: (array zero-terminated=1): An newly allocated array
1603 * describing the sizes at which the icon is available. The array
1604 * should be freed with g_free() when it is no longer needed.
1609 gtk_icon_theme_get_icon_sizes (GtkIconTheme *icon_theme,
1610 const char *icon_name)
1612 GList *l, *d, *icons;
1616 GtkIconThemePrivate *priv;
1618 g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), NULL);
1620 priv = icon_theme->priv;
1622 ensure_valid_themes (icon_theme);
1624 sizes = g_hash_table_new (g_direct_hash, g_direct_equal);
1626 for (l = priv->themes; l; l = l->next)
1628 IconTheme *theme = l->data;
1629 for (d = theme->dirs; d; d = d->next)
1631 IconThemeDir *dir = d->data;
1633 if (dir->type != ICON_THEME_DIR_SCALABLE && g_hash_table_lookup_extended (sizes, GINT_TO_POINTER (dir->size), NULL, NULL))
1636 suffix = theme_dir_get_icon_suffix (dir, icon_name, NULL);
1637 if (suffix != ICON_SUFFIX_NONE)
1639 if (suffix == ICON_SUFFIX_SVG)
1640 g_hash_table_insert (sizes, GINT_TO_POINTER (-1), NULL);
1642 g_hash_table_insert (sizes, GINT_TO_POINTER (dir->size), NULL);
1647 for (d = builtin_dirs; d; d = d->next)
1649 IconThemeDir *dir = d->data;
1651 if (dir->type != ICON_THEME_DIR_SCALABLE && g_hash_table_lookup_extended (sizes, GINT_TO_POINTER (dir->size), NULL, NULL))
1654 suffix = theme_dir_get_icon_suffix (dir, icon_name, NULL);
1655 if (suffix != ICON_SUFFIX_NONE)
1657 if (suffix == ICON_SUFFIX_SVG)
1658 g_hash_table_insert (sizes, GINT_TO_POINTER (-1), NULL);
1660 g_hash_table_insert (sizes, GINT_TO_POINTER (dir->size), NULL);
1664 if (icon_theme_builtin_icons)
1666 icons = g_hash_table_lookup (icon_theme_builtin_icons, icon_name);
1670 BuiltinIcon *icon = icons->data;
1672 g_hash_table_insert (sizes, GINT_TO_POINTER (icon->size), NULL);
1673 icons = icons->next;
1677 r = result = g_new0 (gint, g_hash_table_size (sizes) + 1);
1679 g_hash_table_foreach (sizes, add_size, &r);
1680 g_hash_table_destroy (sizes);
1686 add_key_to_hash (gpointer key,
1690 GHashTable *hash = user_data;
1692 g_hash_table_insert (hash, key, NULL);
1696 add_key_to_list (gpointer key,
1700 GList **list = user_data;
1702 *list = g_list_prepend (*list, g_strdup (key));
1706 * gtk_icon_theme_list_icons:
1707 * @icon_theme: a #GtkIconTheme
1708 * @context: (allow-none): a string identifying a particular type of
1709 * icon, or %NULL to list all icons.
1711 * Lists the icons in the current icon theme. Only a subset
1712 * of the icons can be listed by providing a context string.
1713 * The set of values for the context string is system dependent,
1714 * but will typically include such values as "Applications" and
1717 * Return value: (element-type utf8) (transfer full): a #GList list
1718 * holding the names of all the icons in the theme. You must first
1719 * free each element in the list with g_free(), then free the list
1720 * itself with g_list_free().
1725 gtk_icon_theme_list_icons (GtkIconTheme *icon_theme,
1726 const char *context)
1728 GtkIconThemePrivate *priv;
1731 GQuark context_quark;
1733 priv = icon_theme->priv;
1735 ensure_valid_themes (icon_theme);
1739 context_quark = g_quark_try_string (context);
1747 icons = g_hash_table_new (g_str_hash, g_str_equal);
1752 theme_list_icons (l->data, icons, context_quark);
1756 if (context_quark == 0)
1757 g_hash_table_foreach (priv->unthemed_icons,
1763 g_hash_table_foreach (icons,
1767 g_hash_table_destroy (icons);
1773 * gtk_icon_theme_list_contexts:
1774 * @icon_theme: a #GtkIconTheme
1776 * Gets the list of contexts available within the current
1777 * hierarchy of icon themes
1779 * Return value: (element-type utf8) (transfer full): a #GList list
1780 * holding the names of all the contexts in the theme. You must first
1781 * free each element in the list with g_free(), then free the list
1782 * itself with g_list_free().
1787 gtk_icon_theme_list_contexts (GtkIconTheme *icon_theme)
1789 GtkIconThemePrivate *priv;
1790 GHashTable *contexts;
1793 priv = icon_theme->priv;
1795 ensure_valid_themes (icon_theme);
1797 contexts = g_hash_table_new (g_str_hash, g_str_equal);
1802 theme_list_contexts (l->data, contexts);
1808 g_hash_table_foreach (contexts,
1812 g_hash_table_destroy (contexts);
1818 * gtk_icon_theme_get_example_icon_name:
1819 * @icon_theme: a #GtkIconTheme
1821 * Gets the name of an icon that is representative of the
1822 * current theme (for instance, to use when presenting
1823 * a list of themes to the user.)
1825 * Return value: the name of an example icon or %NULL.
1826 * Free with g_free().
1831 gtk_icon_theme_get_example_icon_name (GtkIconTheme *icon_theme)
1833 GtkIconThemePrivate *priv;
1837 g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), NULL);
1839 priv = icon_theme->priv;
1841 ensure_valid_themes (icon_theme);
1848 return g_strdup (theme->example);
1858 rescan_themes (GtkIconTheme *icon_theme)
1860 GtkIconThemePrivate *priv;
1861 IconThemeDirMtime *dir_mtime;
1864 struct stat stat_buf;
1867 priv = icon_theme->priv;
1869 for (d = priv->dir_mtimes; d != NULL; d = d->next)
1871 dir_mtime = d->data;
1873 stat_res = g_stat (dir_mtime->dir, &stat_buf);
1875 /* dir mtime didn't change */
1876 if (stat_res == 0 &&
1877 S_ISDIR (stat_buf.st_mode) &&
1878 dir_mtime->mtime == stat_buf.st_mtime)
1880 /* didn't exist before, and still doesn't */
1881 if (dir_mtime->mtime == 0 &&
1882 (stat_res != 0 || !S_ISDIR (stat_buf.st_mode)))
1888 g_get_current_time (&tv);
1889 priv->last_stat_time = tv.tv_sec;
1895 * gtk_icon_theme_rescan_if_needed:
1896 * @icon_theme: a #GtkIconTheme
1898 * Checks to see if the icon theme has changed; if it has, any
1899 * currently cached information is discarded and will be reloaded
1900 * next time @icon_theme is accessed.
1902 * Return value: %TRUE if the icon theme has changed and needed
1908 gtk_icon_theme_rescan_if_needed (GtkIconTheme *icon_theme)
1912 g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), FALSE);
1914 retval = rescan_themes (icon_theme);
1916 do_theme_change (icon_theme);
1922 theme_destroy (IconTheme *theme)
1924 g_free (theme->display_name);
1925 g_free (theme->comment);
1926 g_free (theme->name);
1927 g_free (theme->example);
1929 g_list_foreach (theme->dirs, (GFunc)theme_dir_destroy, NULL);
1930 g_list_free (theme->dirs);
1936 theme_dir_destroy (IconThemeDir *dir)
1939 _gtk_icon_cache_unref (dir->cache);
1941 g_hash_table_destroy (dir->icons);
1944 g_hash_table_destroy (dir->icon_data);
1946 g_free (dir->subdir);
1951 theme_dir_size_difference (IconThemeDir *dir, int size, gboolean *smaller)
1956 case ICON_THEME_DIR_FIXED:
1957 *smaller = size < dir->size;
1958 return abs (size - dir->size);
1960 case ICON_THEME_DIR_SCALABLE:
1961 *smaller = size < dir->min_size;
1962 if (size < dir->min_size)
1963 return dir->min_size - size;
1964 if (size > dir->max_size)
1965 return size - dir->max_size;
1968 case ICON_THEME_DIR_THRESHOLD:
1969 min = dir->size - dir->threshold;
1970 max = dir->size + dir->threshold;
1971 *smaller = size < min;
1978 case ICON_THEME_DIR_UNTHEMED:
1979 g_assert_not_reached ();
1982 g_assert_not_reached ();
1987 string_from_suffix (IconSuffix suffix)
1991 case ICON_SUFFIX_XPM:
1993 case ICON_SUFFIX_SVG:
1995 case ICON_SUFFIX_PNG:
1998 g_assert_not_reached();
2004 suffix_from_name (const char *name)
2008 if (g_str_has_suffix (name, ".png"))
2009 retval = ICON_SUFFIX_PNG;
2010 else if (g_str_has_suffix (name, ".svg"))
2011 retval = ICON_SUFFIX_SVG;
2012 else if (g_str_has_suffix (name, ".xpm"))
2013 retval = ICON_SUFFIX_XPM;
2015 retval = ICON_SUFFIX_NONE;
2021 best_suffix (IconSuffix suffix,
2024 if ((suffix & ICON_SUFFIX_PNG) != 0)
2025 return ICON_SUFFIX_PNG;
2026 else if (allow_svg && ((suffix & ICON_SUFFIX_SVG) != 0))
2027 return ICON_SUFFIX_SVG;
2028 else if ((suffix & ICON_SUFFIX_XPM) != 0)
2029 return ICON_SUFFIX_XPM;
2031 return ICON_SUFFIX_NONE;
2036 theme_dir_get_icon_suffix (IconThemeDir *dir,
2037 const gchar *icon_name,
2038 gboolean *has_icon_file)
2044 suffix = (IconSuffix)_gtk_icon_cache_get_icon_flags (dir->cache,
2049 *has_icon_file = suffix & HAS_ICON_FILE;
2051 suffix = suffix & ~HAS_ICON_FILE;
2054 suffix = GPOINTER_TO_UINT (g_hash_table_lookup (dir->icons, icon_name));
2056 GTK_NOTE (ICONTHEME,
2057 g_print ("get_icon_suffix%s %u\n", dir->cache ? " (cached)" : "", suffix));
2062 static GtkIconInfo *
2063 theme_lookup_icon (IconTheme *theme,
2064 const char *icon_name,
2067 gboolean use_builtin)
2070 IconThemeDir *dir, *min_dir;
2072 int min_difference, difference;
2073 BuiltinIcon *closest_builtin = NULL;
2074 gboolean smaller, has_larger, match;
2077 min_difference = G_MAXINT;
2082 /* Builtin icons are logically part of the default theme and
2083 * are searched before other subdirectories of the default theme.
2085 if (use_builtin && strcmp (theme->name, DEFAULT_THEME_NAME) == 0)
2087 closest_builtin = find_builtin_icon (icon_name,
2092 if (min_difference == 0)
2093 return icon_info_new_builtin (closest_builtin);
2095 dirs = builtin_dirs;
2105 GTK_NOTE (ICONTHEME,
2106 g_print ("theme_lookup_icon dir %s\n", dir->dir));
2107 suffix = theme_dir_get_icon_suffix (dir, icon_name, NULL);
2108 if (best_suffix (suffix, allow_svg) != ICON_SUFFIX_NONE)
2110 difference = theme_dir_size_difference (dir, size, &smaller);
2112 if (difference == 0)
2114 if (dir->type == ICON_THEME_DIR_SCALABLE)
2116 /* don't pick scalable if we already found
2117 * a matching non-scalable dir
2127 /* for a matching non-scalable dir keep
2128 * going and look for a closer match
2130 difference = abs (size - dir->size);
2131 if (!match || difference < min_difference)
2134 min_difference = difference;
2137 if (difference == 0)
2146 if (difference < min_difference || smaller)
2148 min_difference = difference;
2150 has_larger = smaller;
2155 if (difference < min_difference && smaller)
2157 min_difference = difference;
2166 if (l == NULL && dirs == builtin_dirs)
2175 GtkIconInfo *icon_info = icon_info_new ();
2176 gboolean has_icon_file = FALSE;
2178 suffix = theme_dir_get_icon_suffix (min_dir, icon_name, &has_icon_file);
2179 suffix = best_suffix (suffix, allow_svg);
2180 g_assert (suffix != ICON_SUFFIX_NONE);
2184 file = g_strconcat (icon_name, string_from_suffix (suffix), NULL);
2185 icon_info->filename = g_build_filename (min_dir->dir, file, NULL);
2190 icon_info->filename = NULL;
2193 if (min_dir->icon_data != NULL)
2194 icon_info->data = g_hash_table_lookup (min_dir->icon_data, icon_name);
2196 if (icon_info->data == NULL && min_dir->cache != NULL)
2198 icon_info->data = _gtk_icon_cache_get_icon_data (min_dir->cache, icon_name, min_dir->subdir_index);
2199 if (icon_info->data)
2201 if (min_dir->icon_data == NULL)
2202 min_dir->icon_data = g_hash_table_new_full (g_str_hash, g_str_equal,
2203 g_free, (GDestroyNotify)icon_data_free);
2205 g_hash_table_replace (min_dir->icon_data, g_strdup (icon_name), icon_info->data);
2209 if (icon_info->data == NULL && has_icon_file)
2211 gchar *icon_file_name, *icon_file_path;
2213 icon_file_name = g_strconcat (icon_name, ".icon", NULL);
2214 icon_file_path = g_build_filename (min_dir->dir, icon_file_name, NULL);
2216 if (g_file_test (icon_file_path, G_FILE_TEST_IS_REGULAR))
2218 if (min_dir->icon_data == NULL)
2219 min_dir->icon_data = g_hash_table_new_full (g_str_hash, g_str_equal,
2220 g_free, (GDestroyNotify)icon_data_free);
2221 load_icon_data (min_dir, icon_file_path, icon_file_name);
2223 icon_info->data = g_hash_table_lookup (min_dir->icon_data, icon_name);
2225 g_free (icon_file_name);
2226 g_free (icon_file_path);
2231 icon_info->cache_pixbuf = _gtk_icon_cache_get_icon (min_dir->cache, icon_name,
2232 min_dir->subdir_index);
2235 icon_info->dir_type = min_dir->type;
2236 icon_info->dir_size = min_dir->size;
2237 icon_info->threshold = min_dir->threshold;
2242 if (closest_builtin)
2243 return icon_info_new_builtin (closest_builtin);
2249 theme_list_icons (IconTheme *theme,
2253 GList *l = theme->dirs;
2260 if (context == dir->context ||
2265 _gtk_icon_cache_add_icons (dir->cache,
2272 g_hash_table_foreach (dir->icons,
2282 theme_list_contexts (IconTheme *theme,
2283 GHashTable *contexts)
2285 GList *l = theme->dirs;
2287 const char *context;
2293 context = g_quark_to_string (dir->context);
2294 g_hash_table_replace (contexts, (gpointer) context, NULL);
2301 load_icon_data (IconThemeDir *dir, const char *path, const char *name)
2303 GKeyFile *icon_file;
2311 GError *error = NULL;
2315 icon_file = g_key_file_new ();
2316 g_key_file_set_list_separator (icon_file, ',');
2317 g_key_file_load_from_file (icon_file, path, 0, &error);
2320 g_error_free (error);
2321 g_key_file_free (icon_file);
2326 base_name = strip_suffix (name);
2328 data = g_slice_new0 (GtkIconData);
2329 g_hash_table_replace (dir->icon_data, base_name, data);
2331 ivalues = g_key_file_get_integer_list (icon_file,
2332 "Icon Data", "EmbeddedTextRectangle",
2338 data->has_embedded_rect = TRUE;
2339 data->x0 = ivalues[0];
2340 data->y0 = ivalues[1];
2341 data->x1 = ivalues[2];
2342 data->y1 = ivalues[3];
2348 str = g_key_file_get_string (icon_file, "Icon Data", "AttachPoints", NULL);
2351 split = g_strsplit (str, "|", -1);
2353 data->n_attach_points = g_strv_length (split);
2354 data->attach_points = g_new (GdkPoint, data->n_attach_points);
2357 while (split[i] != NULL && i < data->n_attach_points)
2359 split_point = strchr (split[i], ',');
2364 data->attach_points[i].x = atoi (split[i]);
2365 data->attach_points[i].y = atoi (split_point);
2374 data->display_name = g_key_file_get_locale_string (icon_file,
2375 "Icon Data", "DisplayName",
2377 g_key_file_free (icon_file);
2382 scan_directory (GtkIconThemePrivate *icon_theme,
2383 IconThemeDir *dir, char *full_dir)
2388 GTK_NOTE (ICONTHEME,
2389 g_print ("scanning directory %s\n", full_dir));
2390 dir->icons = g_hash_table_new_full (g_str_hash, g_str_equal,
2393 gdir = g_dir_open (full_dir, 0, NULL);
2398 while ((name = g_dir_read_name (gdir)))
2402 IconSuffix suffix, hash_suffix;
2404 if (g_str_has_suffix (name, ".icon"))
2406 if (dir->icon_data == NULL)
2407 dir->icon_data = g_hash_table_new_full (g_str_hash, g_str_equal,
2408 g_free, (GDestroyNotify)icon_data_free);
2410 path = g_build_filename (full_dir, name, NULL);
2411 if (g_file_test (path, G_FILE_TEST_IS_REGULAR))
2412 load_icon_data (dir, path, name);
2419 suffix = suffix_from_name (name);
2420 if (suffix == ICON_SUFFIX_NONE)
2423 base_name = strip_suffix (name);
2425 hash_suffix = GPOINTER_TO_INT (g_hash_table_lookup (dir->icons, base_name));
2426 g_hash_table_replace (icon_theme->all_icons, base_name, NULL);
2427 g_hash_table_replace (dir->icons, base_name, GUINT_TO_POINTER (hash_suffix| suffix));
2434 theme_subdir_load (GtkIconTheme *icon_theme,
2436 GKeyFile *theme_file,
2442 IconThemeDirType type;
2443 char *context_string;
2450 GError *error = NULL;
2451 IconThemeDirMtime *dir_mtime;
2453 size = g_key_file_get_integer (theme_file, subdir, "Size", &error);
2456 g_error_free (error);
2457 g_warning ("Theme directory %s of theme %s has no size field\n",
2458 subdir, theme->name);
2462 type = ICON_THEME_DIR_THRESHOLD;
2463 type_string = g_key_file_get_string (theme_file, subdir, "Type", NULL);
2466 if (strcmp (type_string, "Fixed") == 0)
2467 type = ICON_THEME_DIR_FIXED;
2468 else if (strcmp (type_string, "Scalable") == 0)
2469 type = ICON_THEME_DIR_SCALABLE;
2470 else if (strcmp (type_string, "Threshold") == 0)
2471 type = ICON_THEME_DIR_THRESHOLD;
2473 g_free (type_string);
2477 context_string = g_key_file_get_string (theme_file, subdir, "Context", NULL);
2480 context = g_quark_from_string (context_string);
2481 g_free (context_string);
2484 max_size = g_key_file_get_integer (theme_file, subdir, "MaxSize", &error);
2489 g_error_free (error);
2493 min_size = g_key_file_get_integer (theme_file, subdir, "MinSize", &error);
2498 g_error_free (error);
2502 threshold = g_key_file_get_integer (theme_file, subdir, "Threshold", &error);
2507 g_error_free (error);
2511 for (d = icon_theme->priv->dir_mtimes; d; d = d->next)
2513 dir_mtime = (IconThemeDirMtime *)d->data;
2515 if (dir_mtime->mtime == 0)
2516 continue; /* directory doesn't exist */
2518 full_dir = g_build_filename (dir_mtime->dir, subdir, NULL);
2520 /* First, see if we have a cache for the directory */
2521 if (dir_mtime->cache != NULL || g_file_test (full_dir, G_FILE_TEST_IS_DIR))
2523 if (dir_mtime->cache == NULL)
2525 /* This will return NULL if the cache doesn't exist or is outdated */
2526 dir_mtime->cache = _gtk_icon_cache_new_for_path (dir_mtime->dir);
2529 dir = g_new (IconThemeDir, 1);
2531 dir->context = context;
2533 dir->min_size = min_size;
2534 dir->max_size = max_size;
2535 dir->threshold = threshold;
2536 dir->dir = full_dir;
2537 dir->icon_data = NULL;
2538 dir->subdir = g_strdup (subdir);
2539 if (dir_mtime->cache != NULL)
2541 dir->cache = _gtk_icon_cache_ref (dir_mtime->cache);
2542 dir->subdir_index = _gtk_icon_cache_get_directory_index (dir->cache, dir->subdir);
2547 dir->subdir_index = -1;
2548 scan_directory (icon_theme->priv, dir, full_dir);
2551 theme->dirs = g_list_prepend (theme->dirs, dir);
2559 icon_data_free (GtkIconData *icon_data)
2561 g_free (icon_data->attach_points);
2562 g_free (icon_data->display_name);
2563 g_slice_free (GtkIconData, icon_data);
2570 G_DEFINE_BOXED_TYPE (GtkIconInfo, gtk_icon_info,
2574 static GtkIconInfo *
2575 icon_info_new (void)
2577 GtkIconInfo *icon_info = g_slice_new0 (GtkIconInfo);
2579 icon_info->scale = -1.;
2580 icon_info->ref_count = 1;
2585 static GtkIconInfo *
2586 icon_info_new_builtin (BuiltinIcon *icon)
2588 GtkIconInfo *icon_info = icon_info_new ();
2590 icon_info->cache_pixbuf = g_object_ref (icon->pixbuf);
2591 icon_info->dir_type = ICON_THEME_DIR_THRESHOLD;
2592 icon_info->dir_size = icon->size;
2593 icon_info->threshold = 2;
2599 * gtk_icon_info_copy:
2600 * @icon_info: a #GtkIconInfo
2602 * Make a copy of a #GtkIconInfo.
2604 * Return value: the new GtkIconInfo
2609 gtk_icon_info_copy (GtkIconInfo *icon_info)
2612 g_return_val_if_fail (icon_info != NULL, NULL);
2614 icon_info->ref_count++;
2620 * gtk_icon_info_free:
2621 * @icon_info: a #GtkIconInfo
2623 * Free a #GtkIconInfo and associated information
2628 gtk_icon_info_free (GtkIconInfo *icon_info)
2630 g_return_if_fail (icon_info != NULL);
2632 icon_info->ref_count--;
2633 if (icon_info->ref_count > 0)
2636 g_free (icon_info->filename);
2637 if (icon_info->loadable)
2638 g_object_unref (icon_info->loadable);
2639 g_slist_foreach (icon_info->emblem_infos, (GFunc)gtk_icon_info_free, NULL);
2640 g_slist_free (icon_info->emblem_infos);
2641 if (icon_info->pixbuf)
2642 g_object_unref (icon_info->pixbuf);
2643 if (icon_info->cache_pixbuf)
2644 g_object_unref (icon_info->cache_pixbuf);
2646 g_slice_free (GtkIconInfo, icon_info);
2650 * gtk_icon_info_get_base_size:
2651 * @icon_info: a #GtkIconInfo
2653 * Gets the base size for the icon. The base size
2654 * is a size for the icon that was specified by
2655 * the icon theme creator. This may be different
2656 * than the actual size of image; an example of
2657 * this is small emblem icons that can be attached
2658 * to a larger icon. These icons will be given
2659 * the same base size as the larger icons to which
2660 * they are attached.
2662 * Return value: the base size, or 0, if no base
2663 * size is known for the icon.
2668 gtk_icon_info_get_base_size (GtkIconInfo *icon_info)
2670 g_return_val_if_fail (icon_info != NULL, 0);
2672 return icon_info->dir_size;
2676 * gtk_icon_info_get_filename:
2677 * @icon_info: a #GtkIconInfo
2679 * Gets the filename for the icon. If the
2680 * %GTK_ICON_LOOKUP_USE_BUILTIN flag was passed
2681 * to gtk_icon_theme_lookup_icon(), there may be
2682 * no filename if a builtin icon is returned; in this
2683 * case, you should use gtk_icon_info_get_builtin_pixbuf().
2685 * Return value: (type filename): the filename for the icon, or %NULL
2686 * if gtk_icon_info_get_builtin_pixbuf() should be used instead. The
2687 * return value is owned by GTK+ and should not be modified or freed.
2691 G_CONST_RETURN gchar *
2692 gtk_icon_info_get_filename (GtkIconInfo *icon_info)
2694 g_return_val_if_fail (icon_info != NULL, NULL);
2696 return icon_info->filename;
2700 * gtk_icon_info_get_builtin_pixbuf:
2701 * @icon_info: a #GtkIconInfo structure
2703 * Gets the built-in image for this icon, if any. To allow
2704 * GTK+ to use built in icon images, you must pass the
2705 * %GTK_ICON_LOOKUP_USE_BUILTIN to
2706 * gtk_icon_theme_lookup_icon().
2708 * Return value: (transfer none): the built-in image pixbuf, or %NULL. No
2709 * extra reference is added to the returned pixbuf, so if
2710 * you want to keep it around, you must use g_object_ref().
2711 * The returned image must not be modified.
2716 gtk_icon_info_get_builtin_pixbuf (GtkIconInfo *icon_info)
2718 g_return_val_if_fail (icon_info != NULL, NULL);
2720 if (icon_info->filename)
2723 return icon_info->cache_pixbuf;
2726 static gboolean icon_info_ensure_scale_and_pixbuf (GtkIconInfo*, gboolean);
2728 /* Combine the icon with all emblems, the first emblem is placed
2729 * in the southeast corner. Scale emblems to be at most 3/4 of the
2730 * size of the icon itself.
2733 apply_emblems (GtkIconInfo *info)
2735 GdkPixbuf *icon = NULL;
2739 if (info->emblem_infos == NULL)
2742 if (info->emblems_applied)
2745 w = gdk_pixbuf_get_width (info->pixbuf);
2746 h = gdk_pixbuf_get_height (info->pixbuf);
2748 for (l = info->emblem_infos, pos = 0; l; l = l->next, pos++)
2750 GtkIconInfo *emblem_info = l->data;
2752 if (icon_info_ensure_scale_and_pixbuf (emblem_info, FALSE))
2754 GdkPixbuf *emblem = emblem_info->pixbuf;
2756 gint x = 0, y = 0; /* silence compiler */
2759 ew = gdk_pixbuf_get_width (emblem);
2760 eh = gdk_pixbuf_get_height (emblem);
2792 icon = gdk_pixbuf_copy (info->pixbuf);
2797 gdk_pixbuf_composite (emblem, icon, x, y, ew, eh, x, y,
2798 scale, scale, GDK_INTERP_BILINEAR, 255);
2804 g_object_unref (info->pixbuf);
2805 info->pixbuf = icon;
2808 info->emblems_applied = TRUE;
2811 /* This function contains the complicated logic for deciding
2812 * on the size at which to load the icon and loading it at
2816 icon_info_ensure_scale_and_pixbuf (GtkIconInfo *icon_info,
2817 gboolean scale_only)
2819 int image_width, image_height;
2820 GdkPixbuf *source_pixbuf;
2823 /* First check if we already succeeded have the necessary
2824 * information (or failed earlier)
2826 if (scale_only && icon_info->scale >= 0)
2829 if (icon_info->pixbuf)
2831 apply_emblems (icon_info);
2835 if (icon_info->load_error)
2838 /* SVG icons are a special case - we just immediately scale them
2839 * to the desired size
2841 if (icon_info->filename && !icon_info->loadable)
2845 file = g_file_new_for_path (icon_info->filename);
2846 icon_info->loadable = G_LOADABLE_ICON (g_file_icon_new (file));
2847 g_object_unref (file);
2851 if (G_IS_FILE_ICON (icon_info->loadable))
2854 GFileInfo *file_info;
2855 const gchar *content_type;
2857 file = g_file_icon_get_file (G_FILE_ICON (icon_info->loadable));
2858 file_info = g_file_query_info (file,
2859 G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE,
2860 G_FILE_QUERY_INFO_NONE,
2864 content_type = g_file_info_get_content_type (file_info);
2866 if (content_type && strcmp (content_type, "image/svg+xml") == 0)
2869 g_object_unref (file_info);
2875 GInputStream *stream;
2877 icon_info->scale = icon_info->desired_size / 1000.;
2882 stream = g_loadable_icon_load (icon_info->loadable,
2883 icon_info->desired_size,
2885 &icon_info->load_error);
2888 icon_info->pixbuf = gdk_pixbuf_new_from_stream_at_scale (stream,
2889 icon_info->desired_size,
2890 icon_info->desired_size,
2893 &icon_info->load_error);
2894 g_object_unref (stream);
2897 if (!icon_info->pixbuf)
2900 apply_emblems (icon_info);
2905 /* In many cases, the scale can be determined without actual access
2906 * to the icon file. This is generally true when we have a size
2907 * for the directory where the icon is; the image size doesn't
2908 * matter in that case.
2910 if (icon_info->forced_size)
2911 icon_info->scale = -1;
2912 else if (icon_info->dir_type == ICON_THEME_DIR_FIXED)
2913 icon_info->scale = 1.0;
2914 else if (icon_info->dir_type == ICON_THEME_DIR_THRESHOLD)
2916 if (icon_info->desired_size >= icon_info->dir_size - icon_info->threshold &&
2917 icon_info->desired_size <= icon_info->dir_size + icon_info->threshold)
2918 icon_info->scale = 1.0;
2919 else if (icon_info->dir_size > 0)
2920 icon_info->scale =(gdouble) icon_info->desired_size / icon_info->dir_size;
2922 else if (icon_info->dir_type == ICON_THEME_DIR_SCALABLE)
2924 if (icon_info->dir_size > 0)
2925 icon_info->scale = (gdouble) icon_info->desired_size / icon_info->dir_size;
2928 if (icon_info->scale >= 0. && scale_only)
2931 /* At this point, we need to actually get the icon; either from the
2932 * builtin image or by loading the file
2934 source_pixbuf = NULL;
2935 if (icon_info->cache_pixbuf)
2936 source_pixbuf = g_object_ref (icon_info->cache_pixbuf);
2939 GInputStream *stream;
2941 stream = g_loadable_icon_load (icon_info->loadable,
2942 icon_info->desired_size,
2944 &icon_info->load_error);
2947 source_pixbuf = gdk_pixbuf_new_from_stream (stream,
2949 &icon_info->load_error);
2950 g_object_unref (stream);
2957 /* Do scale calculations that depend on the image size
2959 image_width = gdk_pixbuf_get_width (source_pixbuf);
2960 image_height = gdk_pixbuf_get_height (source_pixbuf);
2962 if (icon_info->scale < 0.0)
2964 gint image_size = MAX (image_width, image_height);
2966 icon_info->scale = (gdouble)icon_info->desired_size / (gdouble)image_size;
2968 icon_info->scale = 1.0;
2970 if (icon_info->dir_type == ICON_THEME_DIR_UNTHEMED &&
2971 !icon_info->forced_size)
2972 icon_info->scale = MIN (icon_info->scale, 1.0);
2975 /* We don't short-circuit out here for scale_only, since, now
2976 * we've loaded the icon, we might as well go ahead and finish
2977 * the job. This is a bit of a waste when we scale here
2978 * and never get the final pixbuf; at the cost of a bit of
2979 * extra complexity, we could keep the source pixbuf around
2980 * but not actually scale it until needed.
2982 if (icon_info->scale == 1.0)
2983 icon_info->pixbuf = source_pixbuf;
2986 icon_info->pixbuf = gdk_pixbuf_scale_simple (source_pixbuf,
2987 0.5 + image_width * icon_info->scale,
2988 0.5 + image_height * icon_info->scale,
2989 GDK_INTERP_BILINEAR);
2990 g_object_unref (source_pixbuf);
2993 apply_emblems (icon_info);
2999 * gtk_icon_info_load_icon:
3000 * @icon_info: a #GtkIconInfo structure from gtk_icon_theme_lookup_icon()
3001 * @error: (allow-none): location to store error information on failure,
3004 * Renders an icon previously looked up in an icon theme using
3005 * gtk_icon_theme_lookup_icon(); the size will be based on the size
3006 * passed to gtk_icon_theme_lookup_icon(). Note that the resulting
3007 * pixbuf may not be exactly this size; an icon theme may have icons
3008 * that differ slightly from their nominal sizes, and in addition GTK+
3009 * will avoid scaling icons that it considers sufficiently close to the
3010 * requested size or for which the source image would have to be scaled
3011 * up too far. (This maintains sharpness.). This behaviour can be changed
3012 * by passing the %GTK_ICON_LOOKUP_FORCE_SIZE flag when obtaining
3013 * the #GtkIconInfo. If this flag has been specified, the pixbuf
3014 * returned by this function will be scaled to the exact size.
3016 * Return value: (transfer full): the rendered icon; this may be a newly
3017 * created icon or a new reference to an internal icon, so you must
3018 * not modify the icon. Use g_object_unref() to release your reference
3024 gtk_icon_info_load_icon (GtkIconInfo *icon_info,
3027 g_return_val_if_fail (icon_info != NULL, NULL);
3028 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
3030 if (!icon_info_ensure_scale_and_pixbuf (icon_info, FALSE))
3032 if (icon_info->load_error)
3033 g_propagate_error (error, icon_info->load_error);
3035 g_set_error_literal (error,
3036 GTK_ICON_THEME_ERROR,
3037 GTK_ICON_THEME_NOT_FOUND,
3038 _("Failed to load icon"));
3043 return g_object_ref (icon_info->pixbuf);
3047 gdk_color_to_css (GdkColor *color)
3049 return g_strdup_printf ("rgb(%d,%d,%d)",
3056 gdk_rgba_to_css (const GdkRGBA *color)
3058 /* drop alpha for now, since librsvg does not understand rgba() */
3059 return g_strdup_printf ("rgb(%d,%d,%d)",
3060 (gint)(color->red * 255),
3061 (gint)(color->green * 255),
3062 (gint)(color->blue * 255));
3066 _gtk_icon_info_load_symbolic_internal (GtkIconInfo *icon_info,
3067 const gchar *css_fg,
3068 const gchar *css_success,
3069 const gchar *css_warning,
3070 const gchar *css_error,
3073 GInputStream *stream;
3076 gchar *success, *warning, *err;
3078 /* css_fg can't possibly have failed, otherwise
3079 * that would mean we have a broken style */
3080 g_return_val_if_fail (css_fg != NULL, NULL);
3082 success = warning = err = NULL;
3086 GdkColor success_default_color = { 0, 0x4e00, 0x9a00, 0x0600 };
3087 success = gdk_color_to_css (&success_default_color);
3091 GdkColor warning_default_color = { 0, 0xf500, 0x7900, 0x3e00 };
3092 warning = gdk_color_to_css (&warning_default_color);
3096 GdkColor error_default_color = { 0, 0xcc00, 0x0000, 0x0000 };
3097 err = gdk_color_to_css (&error_default_color);
3101 data = g_strconcat ("<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n"
3102 "<svg version=\"1.1\"\n"
3103 " xmlns=\"http://www.w3.org/2000/svg\"\n"
3104 " xmlns:xi=\"http://www.w3.org/2001/XInclude\"\n"
3107 " <style type=\"text/css\">\n"
3109 " fill: ", css_fg," !important;\n"
3112 " fill: ", css_warning ? css_warning : warning," !important;\n"
3115 " fill: ", css_error ? css_error : err," !important;\n"
3118 " fill: ", css_success ? css_success : success," !important;\n"
3121 " <xi:include href=\"", icon_info->filename, "\"/>\n"
3128 stream = g_memory_input_stream_new_from_data (data, -1, g_free);
3129 pixbuf = gdk_pixbuf_new_from_stream_at_scale (stream,
3130 icon_info->desired_size,
3131 icon_info->desired_size,
3135 g_object_unref (stream);
3141 * gtk_icon_info_load_symbolic:
3142 * @icon_info: a #GtkIconInfo
3143 * @fg: a #GdkRGBA representing the foreground color of the icon
3144 * @success_color: (allow-none): a #GdkRGBA representing the warning color
3145 * of the icon or %NULL to use the default color
3146 * @warning_color: (allow-none): a #GdkRGBA representing the warning color
3147 * of the icon or %NULL to use the default color
3148 * @error_color: (allow-none): a #GdkRGBA representing the error color
3149 * of the icon or %NULL to use the default color (allow-none)
3150 * @was_symbolic: (out) (allow-none): a #gboolean, returns whether the
3151 * loaded icon was a symbolic one and whether the @fg color was
3153 * @error: (allow-none): location to store error information on failure,
3156 * Loads an icon, modifying it to match the system colours for the foreground,
3157 * success, warning and error colors provided. If the icon is not a symbolic
3158 * one, the function will return the result from gtk_icon_info_load_icon().
3160 * This allows loading symbolic icons that will match the system theme.
3162 * Unless you are implementing a widget, you will want to use
3163 * g_themed_icon_new_with_default_fallbacks() to load the icon.
3165 * As implementation details, the icon loaded needs to be of SVG type,
3166 * contain the "symbolic" term as the last component of the icon name,
3167 * and use the 'fg', 'success', 'warning' and 'error' CSS styles in the
3170 * See the <ulink url="http://www.freedesktop.org/wiki/SymbolicIcons">Symbolic Icons spec</ulink>
3171 * for more information about symbolic icons.
3173 * Return value: (transfer full): a #GdkPixbuf representing the loaded icon
3178 gtk_icon_info_load_symbolic (GtkIconInfo *icon_info,
3180 const GdkRGBA *success_color,
3181 const GdkRGBA *warning_color,
3182 const GdkRGBA *error_color,
3183 gboolean *was_symbolic,
3192 g_return_val_if_fail (fg != NULL, NULL);
3194 if (!icon_info->filename ||
3195 !g_str_has_suffix (icon_info->filename, "-symbolic.svg"))
3198 *was_symbolic = FALSE;
3199 return gtk_icon_info_load_icon (icon_info, error);
3203 *was_symbolic = TRUE;
3205 css_fg = gdk_rgba_to_css (fg);
3207 css_success = css_warning = css_error = NULL;
3210 css_warning = gdk_rgba_to_css (warning_color);
3213 css_error = gdk_rgba_to_css (error_color);
3216 css_success = gdk_rgba_to_css (success_color);
3218 pixbuf = _gtk_icon_info_load_symbolic_internal (icon_info,
3219 css_fg, css_success,
3220 css_warning, css_error,
3223 g_free (css_warning);
3224 g_free (css_success);
3231 * gtk_icon_info_load_symbolic_for_context:
3232 * @icon_info: a #GtkIconInfo
3233 * @context: a #GtkStyleContext
3234 * @was_symbolic: (out) (allow-none): a #gboolean, returns whether the
3235 * loaded icon was a symbolic one and whether the @fg color was
3237 * @error: (allow-none): location to store error information on failure,
3240 * Loads an icon, modifying it to match the system colors for the foreground,
3241 * success, warning and error colors provided. If the icon is not a symbolic
3242 * one, the function will return the result from gtk_icon_info_load_icon().
3243 * This function uses the regular foreground color and the symbolic colors
3244 * with the names "success_color", "warning_color" and "error_color" from
3247 * This allows loading symbolic icons that will match the system theme.
3249 * See gtk_icon_info_load_symbolic() for more details.
3251 * Return value: (transfer full): a #GdkPixbuf representing the loaded icon
3256 gtk_icon_info_load_symbolic_for_context (GtkIconInfo *icon_info,
3257 GtkStyleContext *context,
3258 gboolean *was_symbolic,
3262 GdkRGBA *color = NULL;
3264 gchar *css_fg = NULL, *css_success;
3265 gchar *css_warning, *css_error;
3266 GtkStateFlags state;
3268 if (!icon_info->filename ||
3269 !g_str_has_suffix (icon_info->filename, "-symbolic.svg"))
3272 *was_symbolic = FALSE;
3273 return gtk_icon_info_load_icon (icon_info, error);
3277 *was_symbolic = TRUE;
3279 state = gtk_style_context_get_state (context);
3280 gtk_style_context_get (context, state, "color", &color, NULL);
3283 css_fg = gdk_rgba_to_css (color);
3284 gdk_rgba_free (color);
3287 css_success = css_warning = css_error = NULL;
3289 if (gtk_style_context_lookup_color (context, "success_color", &rgba))
3290 css_success = gdk_rgba_to_css (&rgba);
3292 if (gtk_style_context_lookup_color (context, "warning_color", &rgba))
3293 css_warning = gdk_rgba_to_css (&rgba);
3295 if (gtk_style_context_lookup_color (context, "error_color", &rgba))
3296 css_error = gdk_rgba_to_css (&rgba);
3298 pixbuf = _gtk_icon_info_load_symbolic_internal (icon_info,
3299 css_fg, css_success,
3300 css_warning, css_error,
3304 g_free (css_success);
3305 g_free (css_warning);
3312 * gtk_icon_info_load_symbolic_for_style:
3313 * @icon_info: a #GtkIconInfo
3314 * @style: a #GtkStyle to take the colors from
3315 * @state: the widget state to use for colors
3316 * @was_symbolic: (out) (allow-none): a #gboolean, returns whether the
3317 * loaded icon was a symbolic one and whether the @fg color was
3319 * @error: (allow-none): location to store error information on failure,
3322 * Loads an icon, modifying it to match the system colours for the foreground,
3323 * success, warning and error colors provided. If the icon is not a symbolic
3324 * one, the function will return the result from gtk_icon_info_load_icon().
3326 * This allows loading symbolic icons that will match the system theme.
3328 * See gtk_icon_info_load_symbolic() for more details.
3330 * Return value: (transfer full): a #GdkPixbuf representing the loaded icon
3334 * Deprecated: 3.0: Use gtk_icon_info_load_symbolic_for_context() instead
3337 gtk_icon_info_load_symbolic_for_style (GtkIconInfo *icon_info,
3340 gboolean *was_symbolic,
3344 GdkColor success_color;
3345 GdkColor warning_color;
3346 GdkColor error_color;
3348 gchar *css_fg, *css_success;
3349 gchar *css_warning, *css_error;
3351 if (!icon_info->filename ||
3352 !g_str_has_suffix (icon_info->filename, "-symbolic.svg"))
3355 *was_symbolic = FALSE;
3356 return gtk_icon_info_load_icon (icon_info, error);
3360 *was_symbolic = TRUE;
3362 fg = &style->fg[state];
3363 css_fg = gdk_color_to_css (fg);
3365 css_success = css_warning = css_error = NULL;
3367 if (gtk_style_lookup_color (style, "success_color", &success_color))
3368 css_success = gdk_color_to_css (&success_color);
3370 if (gtk_style_lookup_color (style, "warning_color", &warning_color))
3371 css_warning = gdk_color_to_css (&warning_color);
3373 if (gtk_style_lookup_color (style, "error_color", &error_color))
3374 css_error = gdk_color_to_css (&error_color);
3376 pixbuf = _gtk_icon_info_load_symbolic_internal (icon_info,
3377 css_fg, css_success,
3378 css_warning, css_error,
3382 g_free (css_success);
3383 g_free (css_warning);
3390 * gtk_icon_info_set_raw_coordinates:
3391 * @icon_info: a #GtkIconInfo
3392 * @raw_coordinates: whether the coordinates of embedded rectangles
3393 * and attached points should be returned in their original
3396 * Sets whether the coordinates returned by gtk_icon_info_get_embedded_rect()
3397 * and gtk_icon_info_get_attach_points() should be returned in their
3398 * original form as specified in the icon theme, instead of scaled
3399 * appropriately for the pixbuf returned by gtk_icon_info_load_icon().
3401 * Raw coordinates are somewhat strange; they are specified to be with
3402 * respect to the unscaled pixmap for PNG and XPM icons, but for SVG
3403 * icons, they are in a 1000x1000 coordinate space that is scaled
3404 * to the final size of the icon. You can determine if the icon is an SVG
3405 * icon by using gtk_icon_info_get_filename(), and seeing if it is non-%NULL
3406 * and ends in '.svg'.
3408 * This function is provided primarily to allow compatibility wrappers
3409 * for older API's, and is not expected to be useful for applications.
3414 gtk_icon_info_set_raw_coordinates (GtkIconInfo *icon_info,
3415 gboolean raw_coordinates)
3417 g_return_if_fail (icon_info != NULL);
3419 icon_info->raw_coordinates = raw_coordinates != FALSE;
3422 /* Scale coordinates from the icon data prior to returning
3426 icon_info_scale_point (GtkIconInfo *icon_info,
3432 if (icon_info->raw_coordinates)
3439 if (!icon_info_ensure_scale_and_pixbuf (icon_info, TRUE))
3442 *x_out = 0.5 + x * icon_info->scale;
3443 *y_out = 0.5 + y * icon_info->scale;
3450 * gtk_icon_info_get_embedded_rect:
3451 * @icon_info: a #GtkIconInfo
3452 * @rectangle: (out): #GdkRectangle in which to store embedded
3453 * rectangle coordinates; coordinates are only stored
3454 * when this function returns %TRUE.
3456 * Gets the coordinates of a rectangle within the icon
3457 * that can be used for display of information such
3458 * as a preview of the contents of a text file.
3459 * See gtk_icon_info_set_raw_coordinates() for further
3460 * information about the coordinate system.
3462 * Return value: %TRUE if the icon has an embedded rectangle
3467 gtk_icon_info_get_embedded_rect (GtkIconInfo *icon_info,
3468 GdkRectangle *rectangle)
3470 g_return_val_if_fail (icon_info != NULL, FALSE);
3472 if (icon_info->data && icon_info->data->has_embedded_rect &&
3473 icon_info_ensure_scale_and_pixbuf (icon_info, TRUE))
3475 gint scaled_x0, scaled_y0;
3476 gint scaled_x1, scaled_y1;
3480 icon_info_scale_point (icon_info,
3481 icon_info->data->x0, icon_info->data->y0,
3482 &scaled_x0, &scaled_y0);
3483 icon_info_scale_point (icon_info,
3484 icon_info->data->x1, icon_info->data->y1,
3485 &scaled_x1, &scaled_y1);
3487 rectangle->x = scaled_x0;
3488 rectangle->y = scaled_y0;
3489 rectangle->width = scaled_x1 - rectangle->x;
3490 rectangle->height = scaled_y1 - rectangle->y;
3500 * gtk_icon_info_get_attach_points:
3501 * @icon_info: a #GtkIconInfo
3502 * @points: (allow-none) (array length=n_points) (out): location to store pointer to an array of points, or %NULL
3503 * free the array of points with g_free().
3504 * @n_points: (allow-none): location to store the number of points in @points, or %NULL
3506 * Fetches the set of attach points for an icon. An attach point
3507 * is a location in the icon that can be used as anchor points for attaching
3508 * emblems or overlays to the icon.
3510 * Return value: %TRUE if there are any attach points for the icon.
3515 gtk_icon_info_get_attach_points (GtkIconInfo *icon_info,
3519 g_return_val_if_fail (icon_info != NULL, FALSE);
3521 if (icon_info->data && icon_info->data->n_attach_points &&
3522 icon_info_ensure_scale_and_pixbuf (icon_info, TRUE))
3528 *points = g_new (GdkPoint, icon_info->data->n_attach_points);
3529 for (i = 0; i < icon_info->data->n_attach_points; i++)
3530 icon_info_scale_point (icon_info,
3531 icon_info->data->attach_points[i].x,
3532 icon_info->data->attach_points[i].y,
3538 *n_points = icon_info->data->n_attach_points;
3554 * gtk_icon_info_get_display_name:
3555 * @icon_info: a #GtkIconInfo
3557 * Gets the display name for an icon. A display name is a
3558 * string to be used in place of the icon name in a user
3559 * visible context like a list of icons.
3561 * Return value: the display name for the icon or %NULL, if
3562 * the icon doesn't have a specified display name. This value
3563 * is owned @icon_info and must not be modified or free.
3567 G_CONST_RETURN gchar *
3568 gtk_icon_info_get_display_name (GtkIconInfo *icon_info)
3570 g_return_val_if_fail (icon_info != NULL, NULL);
3572 if (icon_info->data)
3573 return icon_info->data->display_name;
3584 * gtk_icon_theme_add_builtin_icon:
3585 * @icon_name: the name of the icon to register
3586 * @size: the size at which to register the icon (different
3587 * images can be registered for the same icon name
3588 * at different sizes.)
3589 * @pixbuf: #GdkPixbuf that contains the image to use
3592 * Registers a built-in icon for icon theme lookups. The idea
3593 * of built-in icons is to allow an application or library
3594 * that uses themed icons to function requiring files to
3595 * be present in the file system. For instance, the default
3596 * images for all of GTK+'s stock icons are registered
3599 * In general, if you use gtk_icon_theme_add_builtin_icon()
3600 * you should also install the icon in the icon theme, so
3601 * that the icon is generally available.
3603 * This function will generally be used with pixbufs loaded
3604 * via gdk_pixbuf_new_from_inline().
3609 gtk_icon_theme_add_builtin_icon (const gchar *icon_name,
3613 BuiltinIcon *default_icon;
3617 g_return_if_fail (icon_name != NULL);
3618 g_return_if_fail (GDK_IS_PIXBUF (pixbuf));
3620 if (!icon_theme_builtin_icons)
3621 icon_theme_builtin_icons = g_hash_table_new (g_str_hash, g_str_equal);
3623 icons = g_hash_table_lookup (icon_theme_builtin_icons, icon_name);
3625 key = g_strdup (icon_name);
3627 key = (gpointer)icon_name; /* Won't get stored */
3629 default_icon = g_new (BuiltinIcon, 1);
3630 default_icon->size = size;
3631 default_icon->pixbuf = g_object_ref (pixbuf);
3632 icons = g_slist_prepend (icons, default_icon);
3634 /* Replaces value, leaves key untouched
3636 g_hash_table_insert (icon_theme_builtin_icons, key, icons);
3639 /* Look up a builtin icon; the min_difference_p and
3640 * has_larger_p out parameters allow us to combine
3641 * this lookup with searching through the actual directories
3642 * of the "hicolor" icon theme. See theme_lookup_icon()
3643 * for how they are used.
3645 static BuiltinIcon *
3646 find_builtin_icon (const gchar *icon_name,
3648 gint *min_difference_p,
3649 gboolean *has_larger_p)
3651 GSList *icons = NULL;
3652 gint min_difference = G_MAXINT;
3653 gboolean has_larger = FALSE;
3654 BuiltinIcon *min_icon = NULL;
3656 if (!icon_theme_builtin_icons)
3659 icons = g_hash_table_lookup (icon_theme_builtin_icons, icon_name);
3663 BuiltinIcon *default_icon = icons->data;
3664 int min, max, difference;
3667 min = default_icon->size - 2;
3668 max = default_icon->size + 2;
3669 smaller = size < min;
3671 difference = min - size;
3672 else if (size > max)
3673 difference = size - max;
3677 if (difference == 0)
3679 min_icon = default_icon;
3685 if (difference < min_difference || smaller)
3687 min_difference = difference;
3688 min_icon = default_icon;
3689 has_larger = smaller;
3694 if (difference < min_difference && smaller)
3696 min_difference = difference;
3697 min_icon = default_icon;
3701 icons = icons->next;
3704 if (min_difference_p)
3705 *min_difference_p = min_difference;
3707 *has_larger_p = has_larger;
3713 _gtk_icon_theme_check_reload (GdkDisplay *display)
3717 GtkIconTheme *icon_theme;
3719 n_screens = gdk_display_get_n_screens (display);
3721 for (i = 0; i < n_screens; i++)
3723 screen = gdk_display_get_screen (display, i);
3725 icon_theme = g_object_get_data (G_OBJECT (screen), "gtk-icon-theme");
3728 icon_theme->priv->check_reload = TRUE;
3729 ensure_valid_themes (icon_theme);
3730 icon_theme->priv->check_reload = FALSE;
3737 * gtk_icon_theme_lookup_by_gicon:
3738 * @icon_theme: a #GtkIconTheme
3739 * @icon: the #GIcon to look up
3740 * @size: desired icon size
3741 * @flags: flags modifying the behavior of the icon lookup
3743 * Looks up an icon and returns a structure containing
3744 * information such as the filename of the icon.
3745 * The icon can then be rendered into a pixbuf using
3746 * gtk_icon_info_load_icon().
3748 * Return value: a #GtkIconInfo structure containing
3749 * information about the icon, or %NULL if the icon
3750 * wasn't found. Free with gtk_icon_info_free()
3755 gtk_icon_theme_lookup_by_gicon (GtkIconTheme *icon_theme,
3758 GtkIconLookupFlags flags)
3762 g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), NULL);
3763 g_return_val_if_fail (G_IS_ICON (icon), NULL);
3765 if (G_IS_LOADABLE_ICON (icon))
3767 info = icon_info_new ();
3768 info->loadable = G_LOADABLE_ICON (g_object_ref (icon));
3770 info->dir_type = ICON_THEME_DIR_UNTHEMED;
3771 info->dir_size = size;
3772 info->desired_size = size;
3773 info->threshold = 2;
3774 info->forced_size = (flags & GTK_ICON_LOOKUP_FORCE_SIZE) != 0;
3778 else if (G_IS_THEMED_ICON (icon))
3780 const gchar **names;
3782 names = (const gchar **)g_themed_icon_get_names (G_THEMED_ICON (icon));
3783 info = gtk_icon_theme_choose_icon (icon_theme, names, size, flags);
3787 else if (G_IS_EMBLEMED_ICON (icon))
3789 GIcon *base, *emblem;
3791 GtkIconInfo *emblem_info;
3793 if (GTK_IS_NUMERABLE_ICON (icon))
3794 _gtk_numerable_icon_set_background_icon_size (GTK_NUMERABLE_ICON (icon), size / 2);
3796 base = g_emblemed_icon_get_icon (G_EMBLEMED_ICON (icon));
3797 info = gtk_icon_theme_lookup_by_gicon (icon_theme, base, size, flags);
3800 list = g_emblemed_icon_get_emblems (G_EMBLEMED_ICON (icon));
3801 for (l = list; l; l = l->next)
3803 emblem = g_emblem_get_icon (G_EMBLEM (l->data));
3804 /* always force size for emblems */
3805 emblem_info = gtk_icon_theme_lookup_by_gicon (icon_theme, emblem, size / 2, flags | GTK_ICON_LOOKUP_FORCE_SIZE);
3807 info->emblem_infos = g_slist_prepend (info->emblem_infos, emblem_info);
3813 else if (GDK_IS_PIXBUF (icon))
3817 pixbuf = GDK_PIXBUF (icon);
3819 if ((flags & GTK_ICON_LOOKUP_FORCE_SIZE) != 0)
3821 gint width, height, max;
3825 width = gdk_pixbuf_get_width (pixbuf);
3826 height = gdk_pixbuf_get_height (pixbuf);
3827 max = MAX (width, height);
3828 scale = (gdouble) size / (gdouble) max;
3830 scaled = gdk_pixbuf_scale_simple (pixbuf,
3831 0.5 + width * scale,
3832 0.5 + height * scale,
3833 GDK_INTERP_BILINEAR);
3835 info = gtk_icon_info_new_for_pixbuf (icon_theme, scaled);
3837 g_object_unref (scaled);
3841 info = gtk_icon_info_new_for_pixbuf (icon_theme, pixbuf);
3851 * gtk_icon_info_new_for_pixbuf:
3852 * @icon_theme: a #GtkIconTheme
3853 * @pixbuf: the pixbuf to wrap in a #GtkIconInfo
3855 * Creates a #GtkIconInfo for a #GdkPixbuf.
3857 * Returns: a #GtkIconInfo
3862 gtk_icon_info_new_for_pixbuf (GtkIconTheme *icon_theme,
3867 g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), NULL);
3868 g_return_val_if_fail (GDK_IS_PIXBUF (pixbuf), NULL);
3870 info = icon_info_new ();
3871 info->pixbuf = g_object_ref (pixbuf);
3873 info->dir_type = ICON_THEME_DIR_UNTHEMED;