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 #endif /* G_OS_WIN32 */
38 #include "gtkicontheme.h"
39 #include "gtkiconfactory.h"
40 #include "gtkiconcache.h"
41 #include "gtkbuiltincache.h"
44 #include "gtksettings.h"
45 #include "gtkprivate.h"
48 #define DEFAULT_THEME_NAME "hicolor"
53 ICON_THEME_DIR_SCALABLE,
54 ICON_THEME_DIR_THRESHOLD,
55 ICON_THEME_DIR_UNTHEMED
58 /* In reverse search order: */
62 ICON_SUFFIX_XPM = 1 << 0,
63 ICON_SUFFIX_SVG = 1 << 1,
64 ICON_SUFFIX_PNG = 1 << 2,
65 HAS_ICON_FILE = 1 << 3
69 struct _GtkIconThemePrivate
71 guint custom_theme : 1;
72 guint is_screen_singleton : 1;
73 guint pixbuf_supports_svg : 1;
74 guint themes_valid : 1;
75 guint check_reload : 1;
76 guint loading_themes : 1;
83 /* A list of all the themes needed to look up icons.
84 * In search order, without duplicates
87 GHashTable *unthemed_icons;
89 /* Note: The keys of this hashtable are owned by the
90 * themedir and unthemed hashtables.
92 GHashTable *all_icons;
94 /* GdkScreen for the icon theme (may be NULL)
98 /* time when we last stat:ed for theme changes */
102 gulong reset_styles_idle;
107 /* Information about the source
111 /* System codepage version of filename, for DLL ABI backward
112 * compatibility functions.
116 /* Cache pixbuf (if there is any) */
117 GdkPixbuf *cache_pixbuf;
121 /* Information about the directory where
122 * the source was found
124 IconThemeDirType dir_type;
128 /* Parameters influencing the scaled icon
131 gboolean raw_coordinates;
133 /* Cached information if we go ahead and try to load
148 /* In search order */
154 IconThemeDirType type;
168 GHashTable *icon_data;
174 char *no_svg_filename;
186 time_t mtime; /* 0 == not existing or not a dir */
191 static void gtk_icon_theme_finalize (GObject *object);
192 static void theme_dir_destroy (IconThemeDir *dir);
194 static void theme_destroy (IconTheme *theme);
195 static GtkIconInfo *theme_lookup_icon (IconTheme *theme,
196 const char *icon_name,
199 gboolean use_default_icons);
200 static void theme_list_icons (IconTheme *theme,
203 static void theme_list_contexts (IconTheme *theme,
204 GHashTable *contexts);
205 static void theme_subdir_load (GtkIconTheme *icon_theme,
207 GKeyFile *theme_file,
209 static void do_theme_change (GtkIconTheme *icon_theme);
211 static void blow_themes (GtkIconTheme *icon_themes);
212 static gboolean rescan_themes (GtkIconTheme *icon_themes);
214 static void icon_data_free (GtkIconData *icon_data);
215 static void load_icon_data (IconThemeDir *dir,
219 static IconSuffix theme_dir_get_icon_suffix (IconThemeDir *dir,
220 const gchar *icon_name,
221 gboolean *has_icon_file);
224 static GtkIconInfo *icon_info_new (void);
225 static GtkIconInfo *icon_info_new_builtin (BuiltinIcon *icon);
227 static IconSuffix suffix_from_name (const char *name);
229 static BuiltinIcon *find_builtin_icon (const gchar *icon_name,
231 gint *min_difference_p,
232 gboolean *has_larger_p);
234 static guint signal_changed = 0;
236 static GHashTable *icon_theme_builtin_icons;
238 /* also used in gtkiconfactory.c */
239 GtkIconCache *_builtin_cache = NULL;
240 static GList *builtin_dirs = NULL;
242 G_DEFINE_TYPE (GtkIconTheme, gtk_icon_theme, G_TYPE_OBJECT)
245 * gtk_icon_theme_new:
247 * Creates a new icon theme object. Icon theme objects are used
248 * to lookup up an icon by name in a particular icon theme.
249 * Usually, you'll want to use gtk_icon_theme_get_default()
250 * or gtk_icon_theme_get_for_screen() rather than creating
251 * a new icon theme object for scratch.
253 * Return value: the newly created #GtkIconTheme object.
258 gtk_icon_theme_new (void)
260 return g_object_new (GTK_TYPE_ICON_THEME, NULL);
264 * gtk_icon_theme_get_default:
266 * Gets the icon theme for the default screen. See
267 * gtk_icon_theme_get_for_screen().
269 * Return value: A unique #GtkIconTheme associated with
270 * the default screen. This icon theme is associated with
271 * the screen and can be used as long as the screen
272 * is open. Do not ref or unref it.
277 gtk_icon_theme_get_default (void)
279 return gtk_icon_theme_get_for_screen (gdk_screen_get_default ());
283 * gtk_icon_theme_get_for_screen:
284 * @screen: a #GdkScreen
286 * Gets the icon theme object associated with @screen; if this
287 * function has not previously been called for the given
288 * screen, a new icon theme object will be created and
289 * associated with the screen. Icon theme objects are
290 * fairly expensive to create, so using this function
291 * is usually a better choice than calling than gtk_icon_theme_new()
292 * and setting the screen yourself; by using this function
293 * a single icon theme object will be shared between users.
295 * Return value: A unique #GtkIconTheme associated with
296 * the given screen. This icon theme is associated with
297 * the screen and can be used as long as the screen
298 * is open. Do not ref or unref it.
303 gtk_icon_theme_get_for_screen (GdkScreen *screen)
305 GtkIconTheme *icon_theme;
307 g_return_val_if_fail (GDK_IS_SCREEN (screen), NULL);
308 g_return_val_if_fail (!screen->closed, NULL);
310 icon_theme = g_object_get_data (G_OBJECT (screen), "gtk-icon-theme");
313 GtkIconThemePrivate *priv;
315 icon_theme = gtk_icon_theme_new ();
316 gtk_icon_theme_set_screen (icon_theme, screen);
318 priv = icon_theme->priv;
319 priv->is_screen_singleton = TRUE;
321 g_object_set_data (G_OBJECT (screen), I_("gtk-icon-theme"), icon_theme);
328 gtk_icon_theme_class_init (GtkIconThemeClass *klass)
330 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
332 gobject_class->finalize = gtk_icon_theme_finalize;
335 * GtkIconTheme::changed
336 * @icon_theme: the icon theme
338 * Emitted when the current icon theme is switched or GTK+ detects
339 * that a change has occurred in the contents of the current
342 signal_changed = g_signal_new (I_("changed"),
343 G_TYPE_FROM_CLASS (klass),
345 G_STRUCT_OFFSET (GtkIconThemeClass, changed),
347 g_cclosure_marshal_VOID__VOID,
350 g_type_class_add_private (klass, sizeof (GtkIconThemePrivate));
354 /* Callback when the display that the icon theme is attached to
355 * is closed; unset the screen, and if it's the unique theme
356 * for the screen, drop the reference
359 display_closed (GdkDisplay *display,
361 GtkIconTheme *icon_theme)
363 GtkIconThemePrivate *priv = icon_theme->priv;
364 GdkScreen *screen = priv->screen;
365 gboolean was_screen_singleton = priv->is_screen_singleton;
367 if (was_screen_singleton)
369 g_object_set_data (G_OBJECT (screen), I_("gtk-icon-theme"), NULL);
370 priv->is_screen_singleton = FALSE;
373 gtk_icon_theme_set_screen (icon_theme, NULL);
375 if (was_screen_singleton)
377 g_object_unref (icon_theme);
382 update_current_theme (GtkIconTheme *icon_theme)
384 #define theme_changed(_old, _new) \
385 ((_old && !_new) || (!_old && _new) || \
386 (_old && _new && strcmp (_old, _new) != 0))
387 GtkIconThemePrivate *priv = icon_theme->priv;
389 if (!priv->custom_theme)
392 gchar *fallback_theme = NULL;
393 gboolean changed = FALSE;
397 GtkSettings *settings = gtk_settings_get_for_screen (priv->screen);
398 g_object_get (settings,
399 "gtk-icon-theme-name", &theme,
400 "gtk-fallback-icon-theme", &fallback_theme, NULL);
403 /* ensure that the current theme (even when just the default)
404 * is searched before any fallback theme
406 if (!theme && fallback_theme)
407 theme = g_strdup (DEFAULT_THEME_NAME);
409 if (theme_changed (priv->current_theme, theme))
411 g_free (priv->current_theme);
412 priv->current_theme = theme;
418 if (theme_changed (priv->fallback_theme, fallback_theme))
420 g_free (priv->fallback_theme);
421 priv->fallback_theme = fallback_theme;
425 g_free (fallback_theme);
428 do_theme_change (icon_theme);
433 /* Callback when the icon theme GtkSetting changes
436 theme_changed (GtkSettings *settings,
438 GtkIconTheme *icon_theme)
440 update_current_theme (icon_theme);
444 unset_screen (GtkIconTheme *icon_theme)
446 GtkIconThemePrivate *priv = icon_theme->priv;
447 GtkSettings *settings;
452 settings = gtk_settings_get_for_screen (priv->screen);
453 display = gdk_screen_get_display (priv->screen);
455 g_signal_handlers_disconnect_by_func (display,
456 (gpointer) display_closed,
458 g_signal_handlers_disconnect_by_func (settings,
459 (gpointer) theme_changed,
467 * gtk_icon_theme_set_screen:
468 * @icon_theme: a #GtkIconTheme
469 * @screen: a #GdkScreen
471 * Sets the screen for an icon theme; the screen is used
472 * to track the user's currently configured icon theme,
473 * which might be different for different screens.
478 gtk_icon_theme_set_screen (GtkIconTheme *icon_theme,
481 GtkIconThemePrivate *priv;
482 GtkSettings *settings;
485 g_return_if_fail (GTK_ICON_THEME (icon_theme));
486 g_return_if_fail (screen == NULL || GDK_IS_SCREEN (screen));
488 priv = icon_theme->priv;
490 unset_screen (icon_theme);
494 display = gdk_screen_get_display (screen);
495 settings = gtk_settings_get_for_screen (screen);
497 priv->screen = screen;
499 g_signal_connect (display, "closed",
500 G_CALLBACK (display_closed), icon_theme);
501 g_signal_connect (settings, "notify::gtk-icon-theme-name",
502 G_CALLBACK (theme_changed), icon_theme);
503 g_signal_connect (settings, "notify::gtk-fallback-icon-theme-name",
504 G_CALLBACK (theme_changed), icon_theme);
507 update_current_theme (icon_theme);
510 /* Checks whether a loader for SVG files has been registered
514 pixbuf_supports_svg (void)
518 static gint found_svg = -1;
523 formats = gdk_pixbuf_get_formats ();
526 for (tmp_list = formats; tmp_list && !found_svg; tmp_list = tmp_list->next)
528 gchar **mime_types = gdk_pixbuf_format_get_mime_types (tmp_list->data);
531 for (mime_type = mime_types; *mime_type && !found_svg; mime_type++)
533 if (strcmp (*mime_type, "image/svg") == 0)
537 g_strfreev (mime_types);
540 g_slist_free (formats);
546 gtk_icon_theme_init (GtkIconTheme *icon_theme)
548 GtkIconThemePrivate *priv;
549 const gchar * const *xdg_data_dirs;
552 priv = g_type_instance_get_private ((GTypeInstance *)icon_theme,
553 GTK_TYPE_ICON_THEME);
554 icon_theme->priv = priv;
556 priv->custom_theme = FALSE;
558 xdg_data_dirs = g_get_system_data_dirs ();
559 for (i = 0; xdg_data_dirs[i]; i++) ;
561 priv->search_path_len = 2 * i + 2;
563 priv->search_path = g_new (char *, priv->search_path_len);
566 priv->search_path[i++] = g_build_filename (g_get_home_dir (), ".icons", NULL);
567 priv->search_path[i++] = g_build_filename (g_get_user_data_dir (), "icons", NULL);
569 for (j = 0; xdg_data_dirs[j]; j++)
570 priv->search_path[i++] = g_build_filename (xdg_data_dirs[j], "icons", NULL);
572 for (j = 0; xdg_data_dirs[j]; j++)
573 priv->search_path[i++] = g_build_filename (xdg_data_dirs[j], "pixmaps", NULL);
575 priv->themes_valid = FALSE;
577 priv->unthemed_icons = NULL;
579 priv->pixbuf_supports_svg = pixbuf_supports_svg ();
583 free_dir_mtime (IconThemeDirMtime *dir_mtime)
585 if (dir_mtime->cache)
586 _gtk_icon_cache_unref (dir_mtime->cache);
588 g_free (dir_mtime->dir);
589 g_slice_free (IconThemeDirMtime, dir_mtime);
594 reset_styles_idle (gpointer user_data)
596 GtkIconTheme *icon_theme;
597 GtkIconThemePrivate *priv;
599 icon_theme = GTK_ICON_THEME (user_data);
600 priv = icon_theme->priv;
602 if (priv->screen && priv->is_screen_singleton)
604 GtkSettings *settings = gtk_settings_get_for_screen (priv->screen);
605 gtk_rc_reset_styles (settings);
608 priv->reset_styles_idle = 0;
614 do_theme_change (GtkIconTheme *icon_theme)
616 GtkIconThemePrivate *priv = icon_theme->priv;
618 if (!priv->themes_valid)
622 g_print ("change to icon theme \"%s\"\n", priv->current_theme));
623 blow_themes (icon_theme);
624 g_signal_emit (icon_theme, signal_changed, 0);
626 if (!priv->reset_styles_idle)
627 priv->reset_styles_idle =
628 gdk_threads_add_idle_full (GTK_PRIORITY_RESIZE - 2,
629 reset_styles_idle, icon_theme, NULL);
633 blow_themes (GtkIconTheme *icon_theme)
635 GtkIconThemePrivate *priv = icon_theme->priv;
637 if (priv->themes_valid)
639 g_hash_table_destroy (priv->all_icons);
640 g_list_foreach (priv->themes, (GFunc)theme_destroy, NULL);
641 g_list_free (priv->themes);
642 g_list_foreach (priv->dir_mtimes, (GFunc)free_dir_mtime, NULL);
643 g_list_free (priv->dir_mtimes);
644 g_hash_table_destroy (priv->unthemed_icons);
647 priv->unthemed_icons = NULL;
648 priv->dir_mtimes = NULL;
649 priv->all_icons = NULL;
650 priv->themes_valid = FALSE;
654 gtk_icon_theme_finalize (GObject *object)
656 GtkIconTheme *icon_theme;
657 GtkIconThemePrivate *priv;
660 icon_theme = GTK_ICON_THEME (object);
661 priv = icon_theme->priv;
663 if (priv->reset_styles_idle)
665 g_source_remove (priv->reset_styles_idle);
666 priv->reset_styles_idle = 0;
669 unset_screen (icon_theme);
671 g_free (priv->current_theme);
672 priv->current_theme = NULL;
674 for (i = 0; i < priv->search_path_len; i++)
675 g_free (priv->search_path[i]);
677 g_free (priv->search_path);
678 priv->search_path = NULL;
680 blow_themes (icon_theme);
682 G_OBJECT_CLASS (gtk_icon_theme_parent_class)->finalize (object);
686 * gtk_icon_theme_set_search_path:
687 * @icon_theme: a #GtkIconTheme
688 * @path: array of directories that are searched for icon themes
689 * @n_elements: number of elements in @path.
691 * Sets the search path for the icon theme object. When looking
692 * for an icon theme, GTK+ will search for a subdirectory of
693 * one or more of the directories in @path with the same name
694 * as the icon theme. (Themes from multiple of the path elements
695 * are combined to allow themes to be extended by adding icons
696 * in the user's home directory.)
698 * In addition if an icon found isn't found either in the current
699 * icon theme or the default icon theme, and an image file with
700 * the right name is found directly in one of the elements of
701 * @path, then that image will be used for the icon name.
702 * (This is legacy feature, and new icons should be put
703 * into the default icon theme, which is called DEFAULT_THEME_NAME,
704 * rather than directly on the icon path.)
709 gtk_icon_theme_set_search_path (GtkIconTheme *icon_theme,
713 GtkIconThemePrivate *priv;
716 g_return_if_fail (GTK_IS_ICON_THEME (icon_theme));
718 priv = icon_theme->priv;
719 for (i = 0; i < priv->search_path_len; i++)
720 g_free (priv->search_path[i]);
722 g_free (priv->search_path);
724 priv->search_path = g_new (gchar *, n_elements);
725 priv->search_path_len = n_elements;
727 for (i = 0; i < priv->search_path_len; i++)
728 priv->search_path[i] = g_strdup (path[i]);
730 do_theme_change (icon_theme);
735 * gtk_icon_theme_get_search_path:
736 * @icon_theme: a #GtkIconTheme
737 * @path: location to store a list of icon theme path directories or %NULL
738 * The stored value should be freed with g_strfreev().
739 * @n_elements: location to store number of elements
742 * Gets the current search path. See gtk_icon_theme_set_search_path().
747 gtk_icon_theme_get_search_path (GtkIconTheme *icon_theme,
751 GtkIconThemePrivate *priv;
754 g_return_if_fail (GTK_IS_ICON_THEME (icon_theme));
756 priv = icon_theme->priv;
759 *n_elements = priv->search_path_len;
763 *path = g_new (gchar *, priv->search_path_len + 1);
764 for (i = 0; i < priv->search_path_len; i++)
765 (*path)[i] = g_strdup (priv->search_path[i]);
771 * gtk_icon_theme_append_search_path:
772 * @icon_theme: a #GtkIconTheme
773 * @path: directory name to append to the icon path
775 * Appends a directory to the search path.
776 * See gtk_icon_theme_set_search_path().
781 gtk_icon_theme_append_search_path (GtkIconTheme *icon_theme,
784 GtkIconThemePrivate *priv;
786 g_return_if_fail (GTK_IS_ICON_THEME (icon_theme));
787 g_return_if_fail (path != NULL);
789 priv = icon_theme->priv;
791 priv->search_path_len++;
793 priv->search_path = g_renew (gchar *, priv->search_path, priv->search_path_len);
794 priv->search_path[priv->search_path_len-1] = g_strdup (path);
796 do_theme_change (icon_theme);
800 * gtk_icon_theme_prepend_search_path:
801 * @icon_theme: a #GtkIconTheme
802 * @path: directory name to prepend to the icon path
804 * Prepends a directory to the search path.
805 * See gtk_icon_theme_set_search_path().
810 gtk_icon_theme_prepend_search_path (GtkIconTheme *icon_theme,
813 GtkIconThemePrivate *priv;
816 g_return_if_fail (GTK_IS_ICON_THEME (icon_theme));
817 g_return_if_fail (path != NULL);
819 priv = icon_theme->priv;
821 priv->search_path_len++;
822 priv->search_path = g_renew (gchar *, priv->search_path, priv->search_path_len);
824 for (i = priv->search_path_len - 1; i > 0; i--)
825 priv->search_path[i] = priv->search_path[i - 1];
827 priv->search_path[0] = g_strdup (path);
829 do_theme_change (icon_theme);
833 * gtk_icon_theme_set_custom_theme:
834 * @icon_theme: a #GtkIconTheme
835 * @theme_name: name of icon theme to use instead of configured theme,
836 * or %NULL to unset a previously set custom theme
838 * Sets the name of the icon theme that the #GtkIconTheme object uses
839 * overriding system configuration. This function cannot be called
840 * on the icon theme objects returned from gtk_icon_theme_get_default()
841 * and gtk_icon_theme_get_for_screen().
846 gtk_icon_theme_set_custom_theme (GtkIconTheme *icon_theme,
847 const gchar *theme_name)
849 GtkIconThemePrivate *priv;
851 g_return_if_fail (GTK_IS_ICON_THEME (icon_theme));
853 priv = icon_theme->priv;
855 g_return_if_fail (!priv->is_screen_singleton);
857 if (theme_name != NULL)
859 priv->custom_theme = TRUE;
860 if (!priv->current_theme || strcmp (theme_name, priv->current_theme) != 0)
862 g_free (priv->current_theme);
863 priv->current_theme = g_strdup (theme_name);
865 do_theme_change (icon_theme);
870 if (priv->custom_theme)
872 priv->custom_theme = FALSE;
874 update_current_theme (icon_theme);
880 insert_theme (GtkIconTheme *icon_theme, const char *theme_name)
886 GtkIconThemePrivate *priv;
887 IconTheme *theme = NULL;
889 GKeyFile *theme_file;
890 GError *error = NULL;
891 IconThemeDirMtime *dir_mtime;
892 struct stat stat_buf;
894 priv = icon_theme->priv;
896 for (l = priv->themes; l != NULL; l = l->next)
899 if (strcmp (theme->name, theme_name) == 0)
903 for (i = 0; i < priv->search_path_len; i++)
905 path = g_build_filename (priv->search_path[i],
908 dir_mtime = g_slice_new (IconThemeDirMtime);
909 dir_mtime->cache = NULL;
910 dir_mtime->dir = path;
911 if (g_stat (path, &stat_buf) == 0 && S_ISDIR (stat_buf.st_mode))
912 dir_mtime->mtime = stat_buf.st_mtime;
914 dir_mtime->mtime = 0;
916 priv->dir_mtimes = g_list_prepend (priv->dir_mtimes, dir_mtime);
918 priv->dir_mtimes = g_list_reverse (priv->dir_mtimes);
921 for (i = 0; i < priv->search_path_len && !theme_file; i++)
923 path = g_build_filename (priv->search_path[i],
927 if (g_file_test (path, G_FILE_TEST_IS_REGULAR))
929 theme_file = g_key_file_new ();
930 g_key_file_set_list_separator (theme_file, ',');
931 g_key_file_load_from_file (theme_file, path, 0, &error);
934 g_key_file_free (theme_file);
936 g_error_free (error);
943 if (theme_file || strcmp (theme_name, DEFAULT_THEME_NAME) == 0)
945 theme = g_new0 (IconTheme, 1);
946 theme->name = g_strdup (theme_name);
947 priv->themes = g_list_prepend (priv->themes, theme);
950 if (theme_file == NULL)
953 theme->display_name =
954 g_key_file_get_locale_string (theme_file, "Icon Theme", "Name", NULL, NULL);
955 if (!theme->display_name)
956 g_warning ("Theme file for %s has no name\n", theme_name);
958 dirs = g_key_file_get_string_list (theme_file, "Icon Theme", "Directories", NULL, NULL);
961 g_warning ("Theme file for %s has no directories\n", theme_name);
962 priv->themes = g_list_remove (priv->themes, theme);
963 g_free (theme->name);
964 g_free (theme->display_name);
966 g_key_file_free (theme_file);
971 g_key_file_get_locale_string (theme_file,
972 "Icon Theme", "Comment",
975 g_key_file_get_string (theme_file,
976 "Icon Theme", "Example",
980 for (i = 0; dirs[i] != NULL; i++)
981 theme_subdir_load (icon_theme, theme, theme_file, dirs[i]);
985 theme->dirs = g_list_reverse (theme->dirs);
987 themes = g_key_file_get_string_list (theme_file,
994 for (i = 0; themes[i] != NULL; i++)
995 insert_theme (icon_theme, themes[i]);
1000 g_key_file_free (theme_file);
1004 free_unthemed_icon (UnthemedIcon *unthemed_icon)
1006 g_free (unthemed_icon->svg_filename);
1007 g_free (unthemed_icon->no_svg_filename);
1008 g_slice_free (UnthemedIcon, unthemed_icon);
1012 strip_suffix (const char *filename)
1016 dot = strrchr (filename, '.');
1019 return g_strdup (filename);
1021 return g_strndup (filename, dot - filename);
1025 load_themes (GtkIconTheme *icon_theme)
1027 GtkIconThemePrivate *priv;
1032 UnthemedIcon *unthemed_icon;
1033 IconSuffix old_suffix, new_suffix;
1035 IconThemeDirMtime *dir_mtime;
1036 struct stat stat_buf;
1038 priv = icon_theme->priv;
1040 priv->all_icons = g_hash_table_new (g_str_hash, g_str_equal);
1042 if (priv->current_theme)
1043 insert_theme (icon_theme, priv->current_theme);
1045 /* Always look in the "default" icon theme, and in a fallback theme */
1046 if (priv->fallback_theme)
1047 insert_theme (icon_theme, priv->fallback_theme);
1048 insert_theme (icon_theme, DEFAULT_THEME_NAME);
1049 priv->themes = g_list_reverse (priv->themes);
1052 priv->unthemed_icons = g_hash_table_new_full (g_str_hash, g_str_equal,
1053 g_free, (GDestroyNotify)free_unthemed_icon);
1055 for (base = 0; base < icon_theme->priv->search_path_len; base++)
1057 dir = icon_theme->priv->search_path[base];
1059 dir_mtime = g_slice_new (IconThemeDirMtime);
1060 priv->dir_mtimes = g_list_append (priv->dir_mtimes, dir_mtime);
1062 dir_mtime->dir = g_strdup (dir);
1063 dir_mtime->mtime = 0;
1064 dir_mtime->cache = NULL;
1066 if (g_stat (dir, &stat_buf) != 0 || !S_ISDIR (stat_buf.st_mode))
1068 dir_mtime->mtime = stat_buf.st_mtime;
1070 dir_mtime->cache = _gtk_icon_cache_new_for_path (dir);
1071 if (dir_mtime->cache != NULL)
1074 gdir = g_dir_open (dir, 0, NULL);
1078 while ((file = g_dir_read_name (gdir)))
1080 new_suffix = suffix_from_name (file);
1082 if (new_suffix != ICON_SUFFIX_NONE)
1087 abs_file = g_build_filename (dir, file, NULL);
1088 base_name = strip_suffix (file);
1090 if ((unthemed_icon = g_hash_table_lookup (priv->unthemed_icons,
1093 if (new_suffix == ICON_SUFFIX_SVG)
1095 if (unthemed_icon->svg_filename)
1098 unthemed_icon->svg_filename = abs_file;
1102 if (unthemed_icon->no_svg_filename)
1104 old_suffix = suffix_from_name (unthemed_icon->no_svg_filename);
1105 if (new_suffix > old_suffix)
1107 g_free (unthemed_icon->no_svg_filename);
1108 unthemed_icon->no_svg_filename = abs_file;
1114 unthemed_icon->no_svg_filename = abs_file;
1121 unthemed_icon = g_slice_new0 (UnthemedIcon);
1123 if (new_suffix == ICON_SUFFIX_SVG)
1124 unthemed_icon->svg_filename = abs_file;
1126 unthemed_icon->no_svg_filename = abs_file;
1128 g_hash_table_insert (priv->unthemed_icons,
1131 g_hash_table_insert (priv->all_icons,
1139 priv->themes_valid = TRUE;
1141 g_get_current_time(&tv);
1142 priv->last_stat_time = tv.tv_sec;
1146 _gtk_icon_theme_ensure_builtin_cache (void)
1148 static gboolean initialized = FALSE;
1150 static IconThemeDir dirs[5] =
1152 { ICON_THEME_DIR_THRESHOLD, 0, 16, 16, 16, 2, NULL, "16", NULL, NULL, NULL },
1153 { ICON_THEME_DIR_THRESHOLD, 0, 20, 20, 20, 2, NULL, "20", NULL, NULL, NULL },
1154 { ICON_THEME_DIR_THRESHOLD, 0, 24, 24, 24, 2, NULL, "24", NULL, NULL, NULL },
1155 { ICON_THEME_DIR_THRESHOLD, 0, 32, 32, 32, 2, NULL, "32", NULL, NULL, NULL },
1156 { ICON_THEME_DIR_THRESHOLD, 0, 48, 48, 48, 2, NULL, "48", NULL, NULL, NULL }
1164 _builtin_cache = _gtk_icon_cache_new ((gchar *)builtin_icons);
1166 for (i = 0; i < G_N_ELEMENTS (dirs); i++)
1169 dir->cache = _gtk_icon_cache_ref (_builtin_cache);
1171 builtin_dirs = g_list_append (builtin_dirs, dir);
1177 ensure_valid_themes (GtkIconTheme *icon_theme)
1179 GtkIconThemePrivate *priv = icon_theme->priv;
1181 gboolean was_valid = priv->themes_valid;
1183 if (priv->loading_themes)
1185 priv->loading_themes = TRUE;
1187 _gtk_icon_theme_ensure_builtin_cache ();
1189 if (priv->themes_valid)
1191 g_get_current_time (&tv);
1193 if (ABS (tv.tv_sec - priv->last_stat_time) > 5 &&
1194 rescan_themes (icon_theme))
1195 blow_themes (icon_theme);
1198 if (!priv->themes_valid)
1200 load_themes (icon_theme);
1204 g_signal_emit (icon_theme, signal_changed, 0);
1206 if (!priv->check_reload && priv->screen)
1208 static GdkAtom atom_iconthemes = GDK_NONE;
1209 GdkEvent *event = gdk_event_new (GDK_CLIENT_EVENT);
1212 if (!atom_iconthemes)
1213 atom_iconthemes = gdk_atom_intern_static_string ("_GTK_LOAD_ICONTHEMES");
1215 for (i = 0; i < 5; i++)
1216 event->client.data.l[i] = 0;
1217 event->client.data_format = 32;
1218 event->client.message_type = atom_iconthemes;
1220 gdk_screen_broadcast_client_message (priv->screen, event);
1225 priv->loading_themes = FALSE;
1228 static GtkIconInfo *
1229 choose_icon (GtkIconTheme *icon_theme,
1230 const gchar *icon_names[],
1232 GtkIconLookupFlags flags)
1234 GtkIconThemePrivate *priv;
1236 GtkIconInfo *icon_info = NULL;
1237 UnthemedIcon *unthemed_icon = NULL;
1239 gboolean use_builtin;
1242 priv = icon_theme->priv;
1244 if (flags & GTK_ICON_LOOKUP_NO_SVG)
1246 else if (flags & GTK_ICON_LOOKUP_FORCE_SVG)
1249 allow_svg = priv->pixbuf_supports_svg;
1251 use_builtin = flags & GTK_ICON_LOOKUP_USE_BUILTIN;
1253 ensure_valid_themes (icon_theme);
1255 for (l = priv->themes; l; l = l->next)
1257 IconTheme *theme = l->data;
1259 for (i = 0; icon_names[i]; i++)
1261 icon_info = theme_lookup_icon (theme, icon_names[i], size, allow_svg, use_builtin);
1267 for (i = 0; icon_names[i]; i++)
1269 unthemed_icon = g_hash_table_lookup (priv->unthemed_icons, icon_names[i]);
1276 icon_info = icon_info_new ();
1278 /* A SVG icon, when allowed, beats out a XPM icon, but not
1282 unthemed_icon->svg_filename &&
1283 (!unthemed_icon->no_svg_filename ||
1284 suffix_from_name (unthemed_icon->no_svg_filename) != ICON_SUFFIX_PNG))
1285 icon_info->filename = g_strdup (unthemed_icon->svg_filename);
1286 else if (unthemed_icon->no_svg_filename)
1287 icon_info->filename = g_strdup (unthemed_icon->no_svg_filename);
1289 icon_info->cp_filename = g_locale_from_utf8 (icon_info->filename,
1290 -1, NULL, NULL, NULL);
1293 icon_info->dir_type = ICON_THEME_DIR_UNTHEMED;
1298 icon_info->desired_size = size;
1301 static gboolean check_for_default_theme = TRUE;
1302 char *default_theme_path;
1303 gboolean found = FALSE;
1306 if (check_for_default_theme)
1308 check_for_default_theme = FALSE;
1310 for (i = 0; !found && i < priv->search_path_len; i++)
1312 default_theme_path = g_build_filename (priv->search_path[i],
1316 found = g_file_test (default_theme_path, G_FILE_TEST_IS_REGULAR);
1317 g_free (default_theme_path);
1321 g_warning (_("Could not find the icon '%s'. The '%s' theme\n"
1322 "was not found either, perhaps you need to install it.\n"
1323 "You can get a copy from:\n"
1325 icon_names[0], DEFAULT_THEME_NAME, "http://icon-theme.freedesktop.org/releases");
1335 * gtk_icon_theme_lookup_icon:
1336 * @icon_theme: a #GtkIconTheme
1337 * @icon_name: the name of the icon to lookup
1338 * @size: desired icon size
1339 * @flags: flags modifying the behavior of the icon lookup
1341 * Looks up a named icon and returns a structure containing
1342 * information such as the filename of the icon. The icon
1343 * can then be rendered into a pixbuf using
1344 * gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon()
1345 * combines these two steps if all you need is the pixbuf.)
1347 * Return value: a #GtkIconInfo structure containing information
1348 * about the icon, or %NULL if the icon wasn't found. Free with
1349 * gtk_icon_info_free()
1354 gtk_icon_theme_lookup_icon (GtkIconTheme *icon_theme,
1355 const gchar *icon_name,
1357 GtkIconLookupFlags flags)
1361 g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), NULL);
1362 g_return_val_if_fail (icon_name != NULL, NULL);
1363 g_return_val_if_fail ((flags & GTK_ICON_LOOKUP_NO_SVG) == 0 ||
1364 (flags & GTK_ICON_LOOKUP_FORCE_SVG) == 0, NULL);
1366 GTK_NOTE (ICONTHEME,
1367 g_print ("gtk_icon_theme_lookup_icon %s\n", icon_name));
1369 if (flags & GTK_ICON_LOOKUP_GENERIC_FALLBACK)
1376 for (p = icon_name; *p; p++)
1380 names = g_new (gchar *, dashes + 2);
1381 names[0] = g_strdup (icon_name);
1382 for (i = 1; i <= dashes; i++)
1384 names[i] = g_strdup (names[i - 1]);
1385 p = strrchr (names[i], '-');
1388 names[dashes + 1] = NULL;
1390 info = choose_icon (icon_theme, names, size, flags);
1398 names[0] = icon_name;
1401 info = choose_icon (icon_theme, names, size, flags);
1408 * gtk_icon_theme_choose_icon:
1409 * @icon_theme: a #GtkIconTheme
1410 * @icon_names: %NULL-terminated array of icon names to lookup
1411 * @size: desired icon size
1412 * @flags: flags modifying the behavior of the icon lookup
1414 * Looks up a named icon and returns a structure containing
1415 * information such as the filename of the icon. The icon
1416 * can then be rendered into a pixbuf using
1417 * gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon()
1418 * combines these two steps if all you need is the pixbuf.)
1420 * If @icon_names contains more than one name, this function
1421 * tries them all in the given order before falling back to
1422 * inherited icon themes.
1424 * Return value: a #GtkIconInfo structure containing information
1425 * about the icon, or %NULL if the icon wasn't found. Free with
1426 * gtk_icon_info_free()
1431 gtk_icon_theme_choose_icon (GtkIconTheme *icon_theme,
1432 const gchar *icon_names[],
1434 GtkIconLookupFlags flags)
1436 g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), NULL);
1437 g_return_val_if_fail (icon_names != NULL, NULL);
1438 g_return_val_if_fail ((flags & GTK_ICON_LOOKUP_NO_SVG) == 0 ||
1439 (flags & GTK_ICON_LOOKUP_FORCE_SVG) == 0, NULL);
1441 return choose_icon (icon_theme, icon_names, size, flags);
1446 gtk_icon_theme_error_quark (void)
1448 return g_quark_from_static_string ("gtk-icon-theme-error-quark");
1452 * gtk_icon_theme_load_icon:
1453 * @icon_theme: a #GtkIconTheme
1454 * @icon_name: the name of the icon to lookup
1455 * @size: the desired icon size. The resulting icon may not be
1456 * exactly this size; see gtk_icon_info_load_icon().
1457 * @flags: flags modifying the behavior of the icon lookup
1458 * @error: Location to store error information on failure, or %NULL.
1460 * Looks up an icon in an icon theme, scales it to the given size
1461 * and renders it into a pixbuf. This is a convenience function;
1462 * if more details about the icon are needed, use
1463 * gtk_icon_theme_lookup_icon() followed by gtk_icon_info_load_icon().
1465 * Note that you probably want to listen for icon theme changes and
1466 * update the icon. This is usually done by connecting to the
1467 * GtkWidget::style-set signal. If for some reason you do not want to
1468 * update the icon when the icon theme changes, you should consider
1469 * using gdk_pixbuf_copy() to make a private copy of the pixbuf
1470 * returned by this function. Otherwise GTK+ may need to keep the old
1471 * icon theme loaded, which would be a waste of memory.
1473 * Return value: the rendered icon; this may be a newly created icon
1474 * or a new reference to an internal icon, so you must not modify
1475 * the icon. Use g_object_unref() to release your reference to the
1476 * icon. %NULL if the icon isn't found.
1481 gtk_icon_theme_load_icon (GtkIconTheme *icon_theme,
1482 const gchar *icon_name,
1484 GtkIconLookupFlags flags,
1487 GtkIconInfo *icon_info;
1488 GdkPixbuf *pixbuf = NULL;
1490 g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), NULL);
1491 g_return_val_if_fail (icon_name != NULL, NULL);
1492 g_return_val_if_fail ((flags & GTK_ICON_LOOKUP_NO_SVG) == 0 ||
1493 (flags & GTK_ICON_LOOKUP_FORCE_SVG) == 0, NULL);
1494 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1496 icon_info = gtk_icon_theme_lookup_icon (icon_theme, icon_name, size,
1497 flags | GTK_ICON_LOOKUP_USE_BUILTIN);
1500 g_set_error (error, GTK_ICON_THEME_ERROR, GTK_ICON_THEME_NOT_FOUND,
1501 _("Icon '%s' not present in theme"), icon_name);
1505 pixbuf = gtk_icon_info_load_icon (icon_info, error);
1506 gtk_icon_info_free (icon_info);
1512 * gtk_icon_theme_has_icon:
1513 * @icon_theme: a #GtkIconTheme
1514 * @icon_name: the name of an icon
1516 * Checks whether an icon theme includes an icon
1517 * for a particular name.
1519 * Return value: %TRUE if @icon_theme includes an
1520 * icon for @icon_name.
1525 gtk_icon_theme_has_icon (GtkIconTheme *icon_theme,
1526 const char *icon_name)
1528 GtkIconThemePrivate *priv;
1531 g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), FALSE);
1533 priv = icon_theme->priv;
1535 ensure_valid_themes (icon_theme);
1537 for (l = priv->dir_mtimes; l; l = l->next)
1539 IconThemeDirMtime *dir_mtime = l->data;
1540 GtkIconCache *cache = dir_mtime->cache;
1542 if (cache && _gtk_icon_cache_has_icon (cache, icon_name))
1546 if (g_hash_table_lookup_extended (priv->all_icons,
1547 icon_name, NULL, NULL))
1550 if (_builtin_cache &&
1551 _gtk_icon_cache_has_icon (_builtin_cache, icon_name))
1554 if (icon_theme_builtin_icons &&
1555 g_hash_table_lookup_extended (icon_theme_builtin_icons,
1556 icon_name, NULL, NULL))
1563 add_size (gpointer key,
1567 gint **res_p = user_data;
1569 **res_p = GPOINTER_TO_INT (key);
1575 * gtk_icon_theme_get_icon_sizes:
1576 * @icon_theme: a #GtkIconTheme
1577 * @icon_name: the name of an icon
1579 * Returns an array of integers describing the sizes at which
1580 * the icon is available without scaling. A size of -1 means
1581 * that the icon is available in a scalable format. The array
1582 * is zero-terminated.
1584 * Return value: An newly allocated array describing the sizes at
1585 * which the icon is available. The array should be freed with g_free()
1586 * when it is no longer needed.
1591 gtk_icon_theme_get_icon_sizes (GtkIconTheme *icon_theme,
1592 const char *icon_name)
1594 GList *l, *d, *icons;
1598 GtkIconThemePrivate *priv;
1600 g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), NULL);
1602 priv = icon_theme->priv;
1604 ensure_valid_themes (icon_theme);
1606 sizes = g_hash_table_new (g_direct_hash, g_direct_equal);
1608 for (l = priv->themes; l; l = l->next)
1610 IconTheme *theme = l->data;
1611 for (d = theme->dirs; d; d = d->next)
1613 IconThemeDir *dir = d->data;
1615 suffix = theme_dir_get_icon_suffix (dir, icon_name, NULL);
1616 if (suffix != ICON_SUFFIX_NONE)
1618 if (suffix == ICON_SUFFIX_SVG)
1619 g_hash_table_insert (sizes, GINT_TO_POINTER (-1), NULL);
1621 g_hash_table_insert (sizes, GINT_TO_POINTER (dir->size), NULL);
1626 for (d = builtin_dirs; d; d = d->next)
1628 IconThemeDir *dir = d->data;
1630 suffix = theme_dir_get_icon_suffix (dir, icon_name, NULL);
1631 if (suffix != ICON_SUFFIX_NONE)
1633 if (suffix == ICON_SUFFIX_SVG)
1634 g_hash_table_insert (sizes, GINT_TO_POINTER (-1), NULL);
1636 g_hash_table_insert (sizes, GINT_TO_POINTER (dir->size), NULL);
1640 if (icon_theme_builtin_icons)
1642 icons = g_hash_table_lookup (icon_theme_builtin_icons, icon_name);
1646 BuiltinIcon *icon = icons->data;
1648 g_hash_table_insert (sizes, GINT_TO_POINTER (icon->size), NULL);
1649 icons = icons->next;
1653 r = result = g_new0 (gint, g_hash_table_size (sizes) + 1);
1655 g_hash_table_foreach (sizes, add_size, &r);
1656 g_hash_table_destroy (sizes);
1662 add_key_to_hash (gpointer key,
1666 GHashTable *hash = user_data;
1668 g_hash_table_insert (hash, key, NULL);
1672 add_key_to_list (gpointer key,
1676 GList **list = user_data;
1678 *list = g_list_prepend (*list, g_strdup (key));
1682 * gtk_icon_theme_list_icons:
1683 * @icon_theme: a #GtkIconTheme
1684 * @context: a string identifying a particular type of icon,
1685 * or %NULL to list all icons.
1687 * Lists the icons in the current icon theme. Only a subset
1688 * of the icons can be listed by providing a context string.
1689 * The set of values for the context string is system dependent,
1690 * but will typically include such values as "Applications" and
1693 * Return value: a #GList list holding the names of all the
1694 * icons in the theme. You must first free each element
1695 * in the list with g_free(), then free the list itself
1696 * with g_list_free().
1701 gtk_icon_theme_list_icons (GtkIconTheme *icon_theme,
1702 const char *context)
1704 GtkIconThemePrivate *priv;
1707 GQuark context_quark;
1709 priv = icon_theme->priv;
1711 ensure_valid_themes (icon_theme);
1715 context_quark = g_quark_try_string (context);
1723 icons = g_hash_table_new (g_str_hash, g_str_equal);
1728 theme_list_icons (l->data, icons, context_quark);
1732 if (context_quark == 0)
1733 g_hash_table_foreach (priv->unthemed_icons,
1739 g_hash_table_foreach (icons,
1743 g_hash_table_destroy (icons);
1749 * gtk_icon_theme_list_contexts:
1750 * @icon_theme: a #GtkIconTheme
1752 * Gets the list of contexts available within the current
1753 * hierarchy of icon themes
1755 * Return value: a #GList list holding the names of all the
1756 * contexts in the theme. You must first free each element
1757 * in the list with g_free(), then free the list itself
1758 * with g_list_free().
1763 gtk_icon_theme_list_contexts (GtkIconTheme *icon_theme)
1765 GtkIconThemePrivate *priv;
1766 GHashTable *contexts;
1769 priv = icon_theme->priv;
1771 ensure_valid_themes (icon_theme);
1773 contexts = g_hash_table_new (g_str_hash, g_str_equal);
1778 theme_list_contexts (l->data, contexts);
1784 g_hash_table_foreach (contexts,
1788 g_hash_table_destroy (contexts);
1794 * gtk_icon_theme_get_example_icon_name:
1795 * @icon_theme: a #GtkIconTheme
1797 * Gets the name of an icon that is representative of the
1798 * current theme (for instance, to use when presenting
1799 * a list of themes to the user.)
1801 * Return value: the name of an example icon or %NULL.
1802 * Free with g_free().
1807 gtk_icon_theme_get_example_icon_name (GtkIconTheme *icon_theme)
1809 GtkIconThemePrivate *priv;
1813 g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), NULL);
1815 priv = icon_theme->priv;
1817 ensure_valid_themes (icon_theme);
1824 return g_strdup (theme->example);
1834 rescan_themes (GtkIconTheme *icon_theme)
1836 GtkIconThemePrivate *priv;
1837 IconThemeDirMtime *dir_mtime;
1840 struct stat stat_buf;
1843 priv = icon_theme->priv;
1845 for (d = priv->dir_mtimes; d != NULL; d = d->next)
1847 dir_mtime = d->data;
1849 stat_res = g_stat (dir_mtime->dir, &stat_buf);
1851 /* dir mtime didn't change */
1852 if (stat_res == 0 &&
1853 S_ISDIR (stat_buf.st_mode) &&
1854 dir_mtime->mtime == stat_buf.st_mtime)
1856 /* didn't exist before, and still doesn't */
1857 if (dir_mtime->mtime == 0 &&
1858 (stat_res != 0 || !S_ISDIR (stat_buf.st_mode)))
1864 g_get_current_time (&tv);
1865 priv->last_stat_time = tv.tv_sec;
1871 * gtk_icon_theme_rescan_if_needed:
1872 * @icon_theme: a #GtkIconTheme
1874 * Checks to see if the icon theme has changed; if it has, any
1875 * currently cached information is discarded and will be reloaded
1876 * next time @icon_theme is accessed.
1878 * Return value: %TRUE if the icon theme has changed and needed
1884 gtk_icon_theme_rescan_if_needed (GtkIconTheme *icon_theme)
1888 g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), FALSE);
1890 retval = rescan_themes (icon_theme);
1892 do_theme_change (icon_theme);
1898 theme_destroy (IconTheme *theme)
1900 g_free (theme->display_name);
1901 g_free (theme->comment);
1902 g_free (theme->name);
1903 g_free (theme->example);
1905 g_list_foreach (theme->dirs, (GFunc)theme_dir_destroy, NULL);
1906 g_list_free (theme->dirs);
1912 theme_dir_destroy (IconThemeDir *dir)
1915 _gtk_icon_cache_unref (dir->cache);
1917 g_hash_table_destroy (dir->icons);
1920 g_hash_table_destroy (dir->icon_data);
1922 g_free (dir->subdir);
1927 theme_dir_size_difference (IconThemeDir *dir, int size, gboolean *smaller)
1932 case ICON_THEME_DIR_FIXED:
1933 *smaller = size < dir->size;
1934 return abs (size - dir->size);
1936 case ICON_THEME_DIR_SCALABLE:
1937 *smaller = size < dir->min_size;
1938 if (size < dir->min_size)
1939 return dir->min_size - size;
1940 if (size > dir->max_size)
1941 return size - dir->max_size;
1944 case ICON_THEME_DIR_THRESHOLD:
1945 min = dir->size - dir->threshold;
1946 max = dir->size + dir->threshold;
1947 *smaller = size < min;
1954 case ICON_THEME_DIR_UNTHEMED:
1955 g_assert_not_reached ();
1958 g_assert_not_reached ();
1963 string_from_suffix (IconSuffix suffix)
1967 case ICON_SUFFIX_XPM:
1969 case ICON_SUFFIX_SVG:
1971 case ICON_SUFFIX_PNG:
1974 g_assert_not_reached();
1980 suffix_from_name (const char *name)
1984 if (g_str_has_suffix (name, ".png"))
1985 retval = ICON_SUFFIX_PNG;
1986 else if (g_str_has_suffix (name, ".svg"))
1987 retval = ICON_SUFFIX_SVG;
1988 else if (g_str_has_suffix (name, ".xpm"))
1989 retval = ICON_SUFFIX_XPM;
1991 retval = ICON_SUFFIX_NONE;
1997 best_suffix (IconSuffix suffix,
2000 if ((suffix & ICON_SUFFIX_PNG) != 0)
2001 return ICON_SUFFIX_PNG;
2002 else if (allow_svg && ((suffix & ICON_SUFFIX_SVG) != 0))
2003 return ICON_SUFFIX_SVG;
2004 else if ((suffix & ICON_SUFFIX_XPM) != 0)
2005 return ICON_SUFFIX_XPM;
2007 return ICON_SUFFIX_NONE;
2012 theme_dir_get_icon_suffix (IconThemeDir *dir,
2013 const gchar *icon_name,
2014 gboolean *has_icon_file)
2020 suffix = (IconSuffix)_gtk_icon_cache_get_icon_flags (dir->cache,
2025 *has_icon_file = suffix & HAS_ICON_FILE;
2027 suffix = suffix & ~HAS_ICON_FILE;
2030 suffix = GPOINTER_TO_UINT (g_hash_table_lookup (dir->icons, icon_name));
2032 GTK_NOTE (ICONTHEME,
2033 g_print ("get_icon_suffix%s %u\n", dir->cache ? " (cached)" : "", suffix));
2038 static GtkIconInfo *
2039 theme_lookup_icon (IconTheme *theme,
2040 const char *icon_name,
2043 gboolean use_builtin)
2046 IconThemeDir *dir, *min_dir;
2048 int min_difference, difference;
2049 BuiltinIcon *closest_builtin = NULL;
2050 gboolean smaller, has_larger, match;
2053 min_difference = G_MAXINT;
2058 /* Builtin icons are logically part of the default theme and
2059 * are searched before other subdirectories of the default theme.
2061 if (strcmp (theme->name, DEFAULT_THEME_NAME) == 0 && use_builtin)
2063 closest_builtin = find_builtin_icon (icon_name,
2068 if (min_difference == 0)
2069 return icon_info_new_builtin (closest_builtin);
2071 dirs = builtin_dirs;
2081 GTK_NOTE (ICONTHEME,
2082 g_print ("theme_lookup_icon dir %s\n", dir->dir));
2083 suffix = theme_dir_get_icon_suffix (dir, icon_name, NULL);
2084 if (best_suffix (suffix, allow_svg) != ICON_SUFFIX_NONE)
2086 difference = theme_dir_size_difference (dir, size, &smaller);
2088 if (difference == 0)
2090 if (dir->type == ICON_THEME_DIR_SCALABLE)
2092 /* don't pick scalable if we already found
2093 * a matching non-scalable dir
2103 /* for a matching non-scalable dir keep
2104 * going and look for a closer match
2106 difference = abs (size - dir->size);
2107 if (!match || difference < min_difference)
2110 min_difference = difference;
2113 if (difference == 0)
2122 if (difference < min_difference || smaller)
2124 min_difference = difference;
2126 has_larger = smaller;
2131 if (difference < min_difference && smaller)
2133 min_difference = difference;
2142 if (l == NULL && dirs == builtin_dirs)
2151 GtkIconInfo *icon_info = icon_info_new ();
2152 gboolean has_icon_file = FALSE;
2154 suffix = theme_dir_get_icon_suffix (min_dir, icon_name, &has_icon_file);
2155 suffix = best_suffix (suffix, allow_svg);
2156 g_assert (suffix != ICON_SUFFIX_NONE);
2160 file = g_strconcat (icon_name, string_from_suffix (suffix), NULL);
2161 icon_info->filename = g_build_filename (min_dir->dir, file, NULL);
2164 icon_info->cp_filename = g_locale_from_utf8 (icon_info->filename,
2165 -1, NULL, NULL, NULL);
2170 icon_info->filename = NULL;
2172 icon_info->cp_filename = NULL;
2176 if (min_dir->icon_data != NULL)
2177 icon_info->data = g_hash_table_lookup (min_dir->icon_data, icon_name);
2179 if (icon_info->data == NULL && min_dir->cache != NULL)
2181 icon_info->data = _gtk_icon_cache_get_icon_data (min_dir->cache, icon_name, min_dir->subdir);
2182 if (icon_info->data)
2184 if (min_dir->icon_data == NULL)
2185 min_dir->icon_data = g_hash_table_new_full (g_str_hash, g_str_equal,
2186 g_free, (GDestroyNotify)icon_data_free);
2188 g_hash_table_replace (min_dir->icon_data, g_strdup (icon_name), icon_info->data);
2192 if (icon_info->data == NULL && has_icon_file)
2194 gchar *icon_file_name, *icon_file_path;
2196 icon_file_name = g_strconcat (icon_name, ".icon", NULL);
2197 icon_file_path = g_build_filename (min_dir->dir, icon_file_name, NULL);
2199 if (g_file_test (icon_file_path, G_FILE_TEST_IS_REGULAR))
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);
2204 load_icon_data (min_dir, icon_file_path, icon_file_name);
2206 icon_info->data = g_hash_table_lookup (min_dir->icon_data, icon_name);
2208 g_free (icon_file_name);
2209 g_free (icon_file_path);
2214 icon_info->cache_pixbuf = _gtk_icon_cache_get_icon (min_dir->cache, icon_name,
2218 icon_info->dir_type = min_dir->type;
2219 icon_info->dir_size = min_dir->size;
2220 icon_info->threshold = min_dir->threshold;
2225 if (closest_builtin)
2226 return icon_info_new_builtin (closest_builtin);
2232 theme_list_icons (IconTheme *theme,
2236 GList *l = theme->dirs;
2243 if (context == dir->context ||
2248 _gtk_icon_cache_add_icons (dir->cache,
2255 g_hash_table_foreach (dir->icons,
2265 theme_list_contexts (IconTheme *theme,
2266 GHashTable *contexts)
2268 GList *l = theme->dirs;
2270 const char *context;
2276 context = g_quark_to_string (dir->context);
2277 g_hash_table_replace (contexts, context, NULL);
2284 load_icon_data (IconThemeDir *dir, const char *path, const char *name)
2286 GKeyFile *icon_file;
2294 GError *error = NULL;
2298 icon_file = g_key_file_new ();
2299 g_key_file_set_list_separator (icon_file, ',');
2300 g_key_file_load_from_file (icon_file, path, 0, &error);
2303 g_error_free (error);
2304 g_key_file_free (icon_file);
2309 base_name = strip_suffix (name);
2311 data = g_slice_new0 (GtkIconData);
2312 g_hash_table_replace (dir->icon_data, base_name, data);
2314 ivalues = g_key_file_get_integer_list (icon_file,
2315 "Icon Data", "EmbeddedTextRectangle",
2321 data->has_embedded_rect = TRUE;
2322 data->x0 = ivalues[0];
2323 data->y0 = ivalues[1];
2324 data->x1 = ivalues[2];
2325 data->y1 = ivalues[3];
2331 str = g_key_file_get_string (icon_file, "Icon Data", "AttachPoints", NULL);
2334 split = g_strsplit (str, "|", -1);
2336 data->n_attach_points = g_strv_length (split);
2337 data->attach_points = g_new (GdkPoint, data->n_attach_points);
2340 while (split[i] != NULL && i < data->n_attach_points)
2342 split_point = strchr (split[i], ',');
2347 data->attach_points[i].x = atoi (split[i]);
2348 data->attach_points[i].y = atoi (split_point);
2357 data->display_name = g_key_file_get_locale_string (icon_file,
2358 "Icon Data", "DisplayName",
2360 g_key_file_free (icon_file);
2365 scan_directory (GtkIconThemePrivate *icon_theme,
2366 IconThemeDir *dir, char *full_dir)
2371 GTK_NOTE (ICONTHEME,
2372 g_print ("scanning directory %s\n", full_dir));
2373 dir->icons = g_hash_table_new_full (g_str_hash, g_str_equal,
2376 gdir = g_dir_open (full_dir, 0, NULL);
2381 while ((name = g_dir_read_name (gdir)))
2385 IconSuffix suffix, hash_suffix;
2387 if (g_str_has_suffix (name, ".icon"))
2389 if (dir->icon_data == NULL)
2390 dir->icon_data = g_hash_table_new_full (g_str_hash, g_str_equal,
2391 g_free, (GDestroyNotify)icon_data_free);
2393 path = g_build_filename (full_dir, name, NULL);
2394 if (g_file_test (path, G_FILE_TEST_IS_REGULAR))
2395 load_icon_data (dir, path, name);
2402 suffix = suffix_from_name (name);
2403 if (suffix == ICON_SUFFIX_NONE)
2406 base_name = strip_suffix (name);
2408 hash_suffix = GPOINTER_TO_INT (g_hash_table_lookup (dir->icons, base_name));
2409 g_hash_table_replace (icon_theme->all_icons, base_name, NULL);
2410 g_hash_table_replace (dir->icons, base_name, GUINT_TO_POINTER (hash_suffix| suffix));
2417 theme_subdir_load (GtkIconTheme *icon_theme,
2419 GKeyFile *theme_file,
2425 IconThemeDirType type;
2426 char *context_string;
2433 GError *error = NULL;
2434 IconThemeDirMtime *dir_mtime;
2436 size = g_key_file_get_integer (theme_file, subdir, "Size", &error);
2439 g_error_free (error);
2440 g_warning ("Theme directory %s of theme %s has no size field\n",
2441 subdir, theme->name);
2445 type = ICON_THEME_DIR_THRESHOLD;
2446 type_string = g_key_file_get_string (theme_file, subdir, "Type", NULL);
2449 if (strcmp (type_string, "Fixed") == 0)
2450 type = ICON_THEME_DIR_FIXED;
2451 else if (strcmp (type_string, "Scalable") == 0)
2452 type = ICON_THEME_DIR_SCALABLE;
2453 else if (strcmp (type_string, "Threshold") == 0)
2454 type = ICON_THEME_DIR_THRESHOLD;
2456 g_free (type_string);
2460 context_string = g_key_file_get_string (theme_file, subdir, "Context", NULL);
2463 context = g_quark_from_string (context_string);
2464 g_free (context_string);
2467 max_size = g_key_file_get_integer (theme_file, subdir, "MaxSize", &error);
2472 g_error_free (error);
2476 min_size = g_key_file_get_integer (theme_file, subdir, "MinSize", &error);
2481 g_error_free (error);
2485 threshold = g_key_file_get_integer (theme_file, subdir, "Threshold", &error);
2490 g_error_free (error);
2494 for (d = icon_theme->priv->dir_mtimes; d; d = d->next)
2496 dir_mtime = (IconThemeDirMtime *)d->data;
2498 if (dir_mtime->mtime == 0)
2499 continue; /* directory doesn't exist */
2501 full_dir = g_build_filename (dir_mtime->dir, subdir, NULL);
2503 /* First, see if we have a cache for the directory */
2504 if (dir_mtime->cache != NULL || g_file_test (full_dir, G_FILE_TEST_IS_DIR))
2506 if (dir_mtime->cache == NULL)
2508 /* This will return NULL if the cache doesn't exist or is outdated */
2509 dir_mtime->cache = _gtk_icon_cache_new_for_path (dir_mtime->dir);
2512 dir = g_new (IconThemeDir, 1);
2514 dir->context = context;
2516 dir->min_size = min_size;
2517 dir->max_size = max_size;
2518 dir->threshold = threshold;
2519 dir->dir = full_dir;
2520 dir->icon_data = NULL;
2521 dir->subdir = g_strdup (subdir);
2522 if (dir_mtime->cache != NULL)
2523 dir->cache = _gtk_icon_cache_ref (dir_mtime->cache);
2527 scan_directory (icon_theme->priv, dir, full_dir);
2530 theme->dirs = g_list_prepend (theme->dirs, dir);
2538 icon_data_free (GtkIconData *icon_data)
2540 g_free (icon_data->attach_points);
2541 g_free (icon_data->display_name);
2542 g_slice_free (GtkIconData, icon_data);
2549 gtk_icon_info_get_type (void)
2551 static GType our_type = 0;
2554 our_type = g_boxed_type_register_static (I_("GtkIconInfo"),
2555 (GBoxedCopyFunc) gtk_icon_info_copy,
2556 (GBoxedFreeFunc) gtk_icon_info_free);
2562 static GtkIconInfo *
2563 icon_info_new (void)
2565 GtkIconInfo *icon_info = g_slice_new0 (GtkIconInfo);
2567 icon_info->scale = -1.;
2572 static GtkIconInfo *
2573 icon_info_new_builtin (BuiltinIcon *icon)
2575 GtkIconInfo *icon_info = icon_info_new ();
2577 icon_info->cache_pixbuf = g_object_ref (icon->pixbuf);
2578 icon_info->dir_type = ICON_THEME_DIR_THRESHOLD;
2579 icon_info->dir_size = icon->size;
2580 icon_info->threshold = 2;
2586 * gtk_icon_info_copy:
2587 * @icon_info: a #GtkIconInfo
2589 * Make a copy of a #GtkIconInfo.
2591 * Return value: the new GtkIconInfo
2596 gtk_icon_info_copy (GtkIconInfo *icon_info)
2600 g_return_val_if_fail (icon_info != NULL, NULL);
2602 copy = memcpy (g_slice_new (GtkIconInfo), icon_info, sizeof (GtkIconInfo));
2603 if (copy->cache_pixbuf)
2604 g_object_ref (copy->cache_pixbuf);
2606 g_object_ref (copy->pixbuf);
2607 if (copy->load_error)
2608 copy->load_error = g_error_copy (copy->load_error);
2610 copy->filename = g_strdup (copy->filename);
2612 if (copy->cp_filename)
2613 copy->cp_filename = g_strdup (copy->cp_filename);
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 g_free (icon_info->filename);
2634 g_free (icon_info->cp_filename);
2636 if (icon_info->pixbuf)
2637 g_object_unref (icon_info->pixbuf);
2638 if (icon_info->cache_pixbuf)
2639 g_object_unref (icon_info->cache_pixbuf);
2641 g_slice_free (GtkIconInfo, icon_info);
2645 * gtk_icon_info_get_base_size:
2646 * @icon_info: a #GtkIconInfo
2648 * Gets the base size for the icon. The base size
2649 * is a size for the icon that was specified by
2650 * the icon theme creator. This may be different
2651 * than the actual size of image; an example of
2652 * this is small emblem icons that can be attached
2653 * to a larger icon. These icons will be given
2654 * the same base size as the larger icons to which
2655 * they are attached.
2657 * Return value: the base size, or 0, if no base
2658 * size is known for the icon.
2663 gtk_icon_info_get_base_size (GtkIconInfo *icon_info)
2665 g_return_val_if_fail (icon_info != NULL, 0);
2667 return icon_info->dir_size;
2671 * gtk_icon_info_get_filename:
2672 * @icon_info: a #GtkIconInfo
2674 * Gets the filename for the icon. If the
2675 * %GTK_ICON_LOOKUP_USE_BUILTIN flag was passed
2676 * to gtk_icon_theme_lookup_icon(), there may be
2677 * no filename if a builtin icon is returned; in this
2678 * case, you should use gtk_icon_info_get_builtin_pixbuf().
2680 * Return value: the filename for the icon, or %NULL
2681 * if gtk_icon_info_get_builtin_pixbuf() should
2682 * be used instead. The return value is owned by
2683 * GTK+ and should not be modified or freed.
2687 G_CONST_RETURN gchar *
2688 gtk_icon_info_get_filename (GtkIconInfo *icon_info)
2690 g_return_val_if_fail (icon_info != NULL, NULL);
2692 return icon_info->filename;
2696 * gtk_icon_info_get_builtin_pixbuf:
2697 * @icon_info: a #GtkIconInfo structure
2699 * Gets the built-in image for this icon, if any. To allow
2700 * GTK+ to use built in icon images, you must pass the
2701 * %GTK_ICON_LOOKUP_USE_BUILTIN to
2702 * gtk_icon_theme_lookup_icon().
2704 * Return value: the built-in image pixbuf, or %NULL. No
2705 * extra reference is added to the returned pixbuf, so if
2706 * you want to keep it around, you must use g_object_ref().
2707 * The returned image must not be modified.
2712 gtk_icon_info_get_builtin_pixbuf (GtkIconInfo *icon_info)
2714 g_return_val_if_fail (icon_info != NULL, NULL);
2716 if (icon_info->filename)
2719 return icon_info->cache_pixbuf;
2723 load_svg_at_size (const gchar *filename,
2727 GdkPixbuf *pixbuf = NULL;
2728 GdkPixbufLoader *loader = NULL;
2729 gchar *contents = NULL;
2732 if (!g_file_get_contents (filename,
2733 &contents, &length, error))
2736 loader = gdk_pixbuf_loader_new_with_type ("svg", error);
2740 gdk_pixbuf_loader_set_size (loader, size, size);
2742 if (!gdk_pixbuf_loader_write (loader, contents, length, error))
2744 gdk_pixbuf_loader_close (loader, NULL);
2748 if (!gdk_pixbuf_loader_close (loader, error))
2751 pixbuf = g_object_ref (gdk_pixbuf_loader_get_pixbuf (loader));
2755 g_object_unref (loader);
2761 /* This function contains the complicatd logic for deciding
2762 * on the size at which to load the icon and loading it at
2766 icon_info_ensure_scale_and_pixbuf (GtkIconInfo *icon_info,
2767 gboolean scale_only)
2769 int image_width, image_height;
2770 GdkPixbuf *source_pixbuf;
2772 /* First check if we already succeeded have the necessary
2773 * information (or failed earlier)
2775 if (scale_only && icon_info->scale >= 0)
2778 if (icon_info->pixbuf)
2781 if (icon_info->load_error)
2784 /* SVG icons are a special case - we just immediately scale them
2785 * to the desired size
2787 if (icon_info->filename && g_str_has_suffix (icon_info->filename, ".svg"))
2789 icon_info->scale = icon_info->desired_size / 1000.;
2794 icon_info->pixbuf = load_svg_at_size (icon_info->filename,
2795 icon_info->desired_size,
2796 &icon_info->load_error);
2798 return icon_info->pixbuf != NULL;
2801 /* In many cases, the scale can be determined without actual access
2802 * to the icon file. This is generally true when we have a size
2803 * for the directory where the icon is; the image size doesn't
2804 * matter in that case.
2806 if (icon_info->dir_type == ICON_THEME_DIR_FIXED)
2807 icon_info->scale = 1.0;
2808 else if (icon_info->dir_type == ICON_THEME_DIR_THRESHOLD)
2810 if (icon_info->desired_size >= icon_info->dir_size - icon_info->threshold &&
2811 icon_info->desired_size <= icon_info->dir_size + icon_info->threshold)
2812 icon_info->scale = 1.0;
2813 else if (icon_info->dir_size > 0)
2814 icon_info->scale =(gdouble) icon_info->desired_size / icon_info->dir_size;
2816 else if (icon_info->dir_type == ICON_THEME_DIR_SCALABLE)
2818 if (icon_info->dir_size > 0)
2819 icon_info->scale = (gdouble) icon_info->desired_size / icon_info->dir_size;
2822 if (icon_info->scale >= 0. && scale_only)
2825 /* At this point, we need to actually get the icon; either from the
2826 * builtin image or by loading the file
2828 if (icon_info->cache_pixbuf)
2829 source_pixbuf = g_object_ref (icon_info->cache_pixbuf);
2833 source_pixbuf = gdk_pixbuf_new_from_file (icon_info->filename,
2834 &icon_info->load_error);
2839 /* Do scale calculations that depend on the image size
2841 image_width = gdk_pixbuf_get_width (source_pixbuf);
2842 image_height = gdk_pixbuf_get_height (source_pixbuf);
2844 if (icon_info->scale < 0.0)
2846 gint image_size = MAX (image_width, image_height);
2848 icon_info->scale = icon_info->desired_size / (gdouble)image_size;
2850 icon_info->scale = 1.0;
2852 if (icon_info->dir_type == ICON_THEME_DIR_UNTHEMED)
2853 icon_info->scale = MIN (icon_info->scale, 1.0);
2856 /* We don't short-circuit out here for scale_only, since, now
2857 * we've loaded the icon, we might as well go ahead and finish
2858 * the job. This is a bit of a waste when we scale here
2859 * and never get the final pixbuf; at the cost of a bit of
2860 * extra complexity, we could keep the source pixbuf around
2861 * but not actually scale it until needed.
2864 if (icon_info->scale == 1.0)
2865 icon_info->pixbuf = source_pixbuf;
2868 icon_info->pixbuf = gdk_pixbuf_scale_simple (source_pixbuf,
2869 0.5 + image_width * icon_info->scale,
2870 0.5 + image_height * icon_info->scale,
2871 GDK_INTERP_BILINEAR);
2872 g_object_unref (source_pixbuf);
2879 * gtk_icon_info_load_icon:
2880 * @icon_info: a #GtkIconInfo structure from gtk_icon_theme_lookup_icon()
2881 * @error: location to store error information on failure, or %NULL.
2883 * Renders an icon previously looked up in an icon theme using
2884 * gtk_icon_theme_lookup_icon(); the size will be based on the size
2885 * passed to gtk_icon_theme_lookup_icon(). Note that the resulting
2886 * pixbuf may not be exactly this size; an icon theme may have icons
2887 * that differ slightly from their nominal sizes, and in addition GTK+
2888 * will avoid scaling icons that it considers sufficiently close to the
2889 * requested size or for which the source image would have to be scaled
2890 * up too far. (This maintains sharpness.)
2892 * Return value: the rendered icon; this may be a newly created icon
2893 * or a new reference to an internal icon, so you must not modify
2894 * the icon. Use g_object_unref() to release your reference to the
2900 gtk_icon_info_load_icon (GtkIconInfo *icon_info,
2903 g_return_val_if_fail (icon_info != NULL, NULL);
2905 g_return_val_if_fail (icon_info != NULL, NULL);
2906 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2908 if (!icon_info_ensure_scale_and_pixbuf (icon_info, FALSE))
2910 if (icon_info->load_error)
2911 g_propagate_error (error, icon_info->load_error);
2914 GTK_ICON_THEME_ERROR,
2915 GTK_ICON_THEME_NOT_FOUND,
2916 _("Failed to load icon"));
2921 return g_object_ref (icon_info->pixbuf);
2925 * gtk_icon_info_set_raw_coordinates:
2926 * @icon_info: a #GtkIconInfo
2927 * @raw_coordinates: whether the coordinates of embedded rectangles
2928 * and attached points should be returned in their original
2931 * Sets whether the coordinates returned by gtk_icon_info_get_embedded_rect()
2932 * and gtk_icon_info_get_attach_points() should be returned in their
2933 * original form as specified in the icon theme, instead of scaled
2934 * appropriately for the pixbuf returned by gtk_icon_info_load_icon().
2936 * Raw coordinates are somewhat strange; they are specified to be with
2937 * respect to the unscaled pixmap for PNG and XPM icons, but for SVG
2938 * icons, they are in a 1000x1000 coordinate space that is scaled
2939 * to the final size of the icon. You can determine if the icon is an SVG
2940 * icon by using gtk_icon_info_get_filename(), and seeing if it is non-%NULL
2941 * and ends in '.svg'.
2943 * This function is provided primarily to allow compatibility wrappers
2944 * for older API's, and is not expected to be useful for applications.
2949 gtk_icon_info_set_raw_coordinates (GtkIconInfo *icon_info,
2950 gboolean raw_coordinates)
2952 g_return_if_fail (icon_info != NULL);
2954 icon_info->raw_coordinates = raw_coordinates != FALSE;
2957 /* Scale coordinates from the icon data prior to returning
2961 icon_info_scale_point (GtkIconInfo *icon_info,
2967 if (icon_info->raw_coordinates)
2974 if (!icon_info_ensure_scale_and_pixbuf (icon_info, TRUE))
2977 *x_out = 0.5 + x * icon_info->scale;
2978 *y_out = 0.5 + y * icon_info->scale;
2985 * gtk_icon_info_get_embedded_rect:
2986 * @icon_info: a #GtkIconInfo
2987 * @rectangle: #GdkRectangle in which to store embedded
2988 * rectangle coordinates; coordinates are only stored
2989 * when this function returns %TRUE.
2991 * Gets the coordinates of a rectangle within the icon
2992 * that can be used for display of information such
2993 * as a preview of the contents of a text file.
2994 * See gtk_icon_info_set_raw_coordinates() for further
2995 * information about the coordinate system.
2997 * Return value: %TRUE if the icon has an embedded rectangle
3002 gtk_icon_info_get_embedded_rect (GtkIconInfo *icon_info,
3003 GdkRectangle *rectangle)
3005 g_return_val_if_fail (icon_info != NULL, FALSE);
3007 if (icon_info->data && icon_info->data->has_embedded_rect &&
3008 icon_info_ensure_scale_and_pixbuf (icon_info, TRUE))
3010 gint scaled_x0, scaled_y0;
3011 gint scaled_x1, scaled_y1;
3015 icon_info_scale_point (icon_info,
3016 icon_info->data->x0, icon_info->data->y0,
3017 &scaled_x0, &scaled_y0);
3018 icon_info_scale_point (icon_info,
3019 icon_info->data->x1, icon_info->data->y1,
3020 &scaled_x1, &scaled_y1);
3022 rectangle->x = scaled_x0;
3023 rectangle->y = scaled_y0;
3024 rectangle->width = scaled_x1 - rectangle->x;
3025 rectangle->height = scaled_y1 - rectangle->y;
3035 * gtk_icon_info_get_attach_points:
3036 * @icon_info: a #GtkIconInfo
3037 * @points: location to store pointer to an array of points, or %NULL
3038 * free the array of points with g_free().
3039 * @n_points: location to store the number of points in @points, or %NULL
3041 * Fetches the set of attach points for an icon. An attach point
3042 * is a location in the icon that can be used as anchor points for attaching
3043 * emblems or overlays to the icon.
3045 * Return value: %TRUE if there are any attach points for the icon.
3050 gtk_icon_info_get_attach_points (GtkIconInfo *icon_info,
3054 g_return_val_if_fail (icon_info != NULL, FALSE);
3056 if (icon_info->data && icon_info->data->n_attach_points &&
3057 icon_info_ensure_scale_and_pixbuf (icon_info, TRUE))
3063 *points = g_new (GdkPoint, icon_info->data->n_attach_points);
3064 for (i = 0; i < icon_info->data->n_attach_points; i++)
3065 icon_info_scale_point (icon_info,
3066 icon_info->data->attach_points[i].x,
3067 icon_info->data->attach_points[i].y,
3073 *n_points = icon_info->data->n_attach_points;
3089 * gtk_icon_info_get_display_name:
3090 * @icon_info: a #GtkIconInfo
3092 * Gets the display name for an icon. A display name is a
3093 * string to be used in place of the icon name in a user
3094 * visible context like a list of icons.
3096 * Return value: the display name for the icon or %NULL, if
3097 * the icon doesn't have a specified display name. This value
3098 * is owned @icon_info and must not be modified or free.
3102 G_CONST_RETURN gchar *
3103 gtk_icon_info_get_display_name (GtkIconInfo *icon_info)
3105 g_return_val_if_fail (icon_info != NULL, NULL);
3107 if (icon_info->data)
3108 return icon_info->data->display_name;
3119 * gtk_icon_theme_add_builtin_icon:
3120 * @icon_name: the name of the icon to register
3121 * @size: the size at which to register the icon (different
3122 * images can be registered for the same icon name
3123 * at different sizes.)
3124 * @pixbuf: #GdkPixbuf that contains the image to use
3127 * Registers a built-in icon for icon theme lookups. The idea
3128 * of built-in icons is to allow an application or library
3129 * that uses themed icons to function requiring files to
3130 * be present in the file system. For instance, the default
3131 * images for all of GTK+'s stock icons are registered
3134 * In general, if you use gtk_icon_theme_add_builtin_icon()
3135 * you should also install the icon in the icon theme, so
3136 * that the icon is generally available.
3138 * This function will generally be used with pixbufs loaded
3139 * via gdk_pixbuf_new_from_inline().
3144 gtk_icon_theme_add_builtin_icon (const gchar *icon_name,
3148 BuiltinIcon *default_icon;
3152 g_return_if_fail (icon_name != NULL);
3153 g_return_if_fail (GDK_IS_PIXBUF (pixbuf));
3155 if (!icon_theme_builtin_icons)
3156 icon_theme_builtin_icons = g_hash_table_new (g_str_hash, g_str_equal);
3158 icons = g_hash_table_lookup (icon_theme_builtin_icons, icon_name);
3160 key = g_strdup (icon_name);
3162 key = (gpointer)icon_name; /* Won't get stored */
3164 default_icon = g_new (BuiltinIcon, 1);
3165 default_icon->size = size;
3166 default_icon->pixbuf = g_object_ref (pixbuf);
3167 icons = g_slist_prepend (icons, default_icon);
3169 /* Replaces value, leaves key untouched
3171 g_hash_table_insert (icon_theme_builtin_icons, key, icons);
3174 /* Look up a builtin icon; the min_difference_p and
3175 * has_larger_p out parameters allow us to combine
3176 * this lookup with searching through the actual directories
3177 * of the "hicolor" icon theme. See theme_lookup_icon()
3178 * for how they are used.
3180 static BuiltinIcon *
3181 find_builtin_icon (const gchar *icon_name,
3183 gint *min_difference_p,
3184 gboolean *has_larger_p)
3186 GSList *icons = NULL;
3187 gint min_difference = G_MAXINT;
3188 gboolean has_larger = FALSE;
3189 BuiltinIcon *min_icon = NULL;
3191 if (!icon_theme_builtin_icons)
3194 icons = g_hash_table_lookup (icon_theme_builtin_icons, icon_name);
3198 BuiltinIcon *default_icon = icons->data;
3199 int min, max, difference;
3202 min = default_icon->size - 2;
3203 max = default_icon->size + 2;
3204 smaller = size < min;
3206 difference = min - size;
3207 else if (size > max)
3208 difference = size - max;
3212 if (difference == 0)
3214 min_icon = default_icon;
3220 if (difference < min_difference || smaller)
3222 min_difference = difference;
3223 min_icon = default_icon;
3224 has_larger = smaller;
3229 if (difference < min_difference && smaller)
3231 min_difference = difference;
3232 min_icon = default_icon;
3236 icons = icons->next;
3239 if (min_difference_p)
3240 *min_difference_p = min_difference;
3242 *has_larger_p = has_larger;
3248 _gtk_icon_theme_check_reload (GdkDisplay *display)
3252 GtkIconTheme *icon_theme;
3254 n_screens = gdk_display_get_n_screens (display);
3256 for (i = 0; i < n_screens; i++)
3258 screen = gdk_display_get_screen (display, i);
3260 icon_theme = g_object_get_data (G_OBJECT (screen), "gtk-icon-theme");
3263 icon_theme->priv->check_reload = TRUE;
3264 ensure_valid_themes (icon_theme);
3265 icon_theme->priv->check_reload = FALSE;
3272 /* DLL ABI stability backward compatibility versions */
3274 #undef gtk_icon_theme_set_search_path
3277 gtk_icon_theme_set_search_path (GtkIconTheme *icon_theme,
3278 const gchar *path[],
3281 const gchar **utf8_path;
3284 utf8_path = g_new (const gchar *, n_elements);
3286 for (i = 0; i < n_elements; i++)
3287 utf8_path[i] = g_locale_to_utf8 (path[i], -1, NULL, NULL, NULL);
3289 gtk_icon_theme_set_search_path_utf8 (icon_theme, utf8_path, n_elements);
3291 for (i = 0; i < n_elements; i++)
3292 g_free ((gchar *) utf8_path[i]);
3297 #undef gtk_icon_theme_get_search_path
3300 gtk_icon_theme_get_search_path (GtkIconTheme *icon_theme,
3306 gtk_icon_theme_get_search_path_utf8 (icon_theme, path, &n);
3313 for (i = 0; i < n; i++)
3315 gchar *tem = (*path)[i];
3317 (*path)[i] = g_locale_from_utf8 ((*path)[i], -1, NULL, NULL, NULL);
3323 #undef gtk_icon_theme_append_search_path
3326 gtk_icon_theme_append_search_path (GtkIconTheme *icon_theme,
3329 gchar *utf8_path = g_locale_from_utf8 (path, -1, NULL, NULL, NULL);
3331 gtk_icon_theme_append_search_path_utf8 (icon_theme, utf8_path);
3336 #undef gtk_icon_theme_prepend_search_path
3339 gtk_icon_theme_prepend_search_path (GtkIconTheme *icon_theme,
3342 gchar *utf8_path = g_locale_from_utf8 (path, -1, NULL, NULL, NULL);
3344 gtk_icon_theme_prepend_search_path_utf8 (icon_theme, utf8_path);
3349 #undef gtk_icon_info_get_filename
3351 G_CONST_RETURN gchar *
3352 gtk_icon_info_get_filename (GtkIconInfo *icon_info)
3354 g_return_val_if_fail (icon_info != NULL, NULL);
3356 return icon_info->cp_filename;
3361 #define __GTK_ICON_THEME_C__
3362 #include "gtkaliasdef.c"