/* GTK - The GIMP Toolkit * Copyright (C) 2000 Red Hat, Inc. * 2008 Johan Dahlin * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library. If not, see . */ /* * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS * file for a list of people on the GTK+ Team. See the ChangeLog * files for a list of changes. These files are distributed with * GTK+ at ftp://ftp.gtk.org/pub/gtk/. */ #include "config.h" #define GDK_DISABLE_DEPRECATION_WARNINGS #include #include #include #include "gtkcssenumvalueprivate.h" #include "gtkiconfactory.h" #include "gtkiconcache.h" #include "gtkdebug.h" #include "gtkicontheme.h" #include "gtksettingsprivate.h" #include "deprecated/gtkstock.h" #include "gtkwidget.h" #include "gtkintl.h" #include "gtkbuildable.h" #include "gtkbuilderprivate.h" #include "gtktypebuiltins.h" #include "gtkstyle.h" #include "gtkstylecontextprivate.h" /** * SECTION:gtkiconfactory * @Short_description: Manipulating stock icons * @Title: Themeable Stock Images * * Browse the available stock icons using * the “gtk3-demo” application. * * An icon factory manages a collection of #GtkIconSet; a #GtkIconSet manages a * set of variants of a particular icon (i.e. a #GtkIconSet contains variants for * different sizes and widget states). Icons in an icon factory are named by a * stock ID, which is a simple string identifying the icon. Each #GtkStyle has a * list of #GtkIconFactory derived from the current theme; those icon factories * are consulted first when searching for an icon. If the theme doesn’t set a * particular icon, GTK+ looks for the icon in a list of default icon factories, * maintained by gtk_icon_factory_add_default() and * gtk_icon_factory_remove_default(). Applications with icons should add a default * icon factory with their icons, which will allow themes to override the icons * for the application. * * To display an icon, always use gtk_style_lookup_icon_set() on the widget that * will display the icon, or the convenience function * gtk_widget_render_icon(). These functions take the theme into account when * looking up the icon to use for a given stock ID. * * # GtkIconFactory as GtkBuildable # {#GtkIconFactory-BUILDER-UI} * * GtkIconFactory supports a custom element, which can contain * multiple elements. The following attributes are allowed: * * - stock-id * * The stock id of the source, a string. This attribute is * mandatory * * - filename * * The filename of the source, a string. This attribute is * optional * * - icon-name * * The icon name for the source, a string. This attribute is * optional. * * - size * * Size of the icon, a #GtkIconSize enum value. This attribute is * optional. * * - direction * * Direction of the source, a #GtkTextDirection enum value. This * attribute is optional. * * - state * * State of the source, a #GtkStateType enum value. This * attribute is optional. * * * ## A #GtkIconFactory UI definition fragment. ## * * |[ * * * * * * * * * apple-red * True * * * * ]| */ static GSList *all_icon_factories = NULL; struct _GtkIconFactoryPrivate { GHashTable *icons; }; typedef enum { GTK_ICON_SOURCE_EMPTY, GTK_ICON_SOURCE_ICON_NAME, GTK_ICON_SOURCE_STATIC_ICON_NAME, GTK_ICON_SOURCE_FILENAME, GTK_ICON_SOURCE_PIXBUF } GtkIconSourceType; struct _GtkIconSource { GtkIconSourceType type; union { gchar *icon_name; gchar *filename; GdkPixbuf *pixbuf; } source; GdkPixbuf *filename_pixbuf; GtkTextDirection direction; GtkStateType state; GtkIconSize size; /* If TRUE, then the parameter is wildcarded, and the above * fields should be ignored. If FALSE, the parameter is * specified, and the above fields should be valid. */ guint any_direction : 1; guint any_state : 1; guint any_size : 1; }; static void gtk_icon_factory_buildable_init (GtkBuildableIface *iface); static gboolean gtk_icon_factory_buildable_custom_tag_start (GtkBuildable *buildable, GtkBuilder *builder, GObject *child, const gchar *tagname, GMarkupParser *parser, gpointer *data); static void gtk_icon_factory_buildable_custom_tag_end (GtkBuildable *buildable, GtkBuilder *builder, GObject *child, const gchar *tagname, gpointer *user_data); static void gtk_icon_factory_finalize (GObject *object); static void get_default_icons (GtkIconFactory *icon_factory); static void icon_source_clear (GtkIconSource *source); static GtkIconSize icon_size_register_intern (const gchar *name, gint width, gint height); #define GTK_ICON_SOURCE_INIT(any_direction, any_state, any_size) \ { GTK_ICON_SOURCE_EMPTY, { NULL }, NULL, \ 0, 0, 0, \ any_direction, any_state, any_size } G_DEFINE_TYPE_WITH_CODE (GtkIconFactory, gtk_icon_factory, G_TYPE_OBJECT, G_ADD_PRIVATE (GtkIconFactory) G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE, gtk_icon_factory_buildable_init)) static void gtk_icon_factory_init (GtkIconFactory *factory) { GtkIconFactoryPrivate *priv; factory->priv = gtk_icon_factory_get_instance_private (factory); priv = factory->priv; priv->icons = g_hash_table_new (g_str_hash, g_str_equal); all_icon_factories = g_slist_prepend (all_icon_factories, factory); } static void gtk_icon_factory_class_init (GtkIconFactoryClass *klass) { GObjectClass *object_class = G_OBJECT_CLASS (klass); object_class->finalize = gtk_icon_factory_finalize; } static void gtk_icon_factory_buildable_init (GtkBuildableIface *iface) { iface->custom_tag_start = gtk_icon_factory_buildable_custom_tag_start; iface->custom_tag_end = gtk_icon_factory_buildable_custom_tag_end; } static void free_icon_set (gpointer key, gpointer value, gpointer data) { g_free (key); gtk_icon_set_unref (value); } static void gtk_icon_factory_finalize (GObject *object) { GtkIconFactory *factory = GTK_ICON_FACTORY (object); GtkIconFactoryPrivate *priv = factory->priv; all_icon_factories = g_slist_remove (all_icon_factories, factory); g_hash_table_foreach (priv->icons, free_icon_set, NULL); g_hash_table_destroy (priv->icons); G_OBJECT_CLASS (gtk_icon_factory_parent_class)->finalize (object); } /** * gtk_icon_factory_new: * * Creates a new #GtkIconFactory. An icon factory manages a collection * of #GtkIconSets; a #GtkIconSet manages a set of variants of a * particular icon (i.e. a #GtkIconSet contains variants for different * sizes and widget states). Icons in an icon factory are named by a * stock ID, which is a simple string identifying the icon. Each * #GtkStyle has a list of #GtkIconFactorys derived from the current * theme; those icon factories are consulted first when searching for * an icon. If the theme doesn’t set a particular icon, GTK+ looks for * the icon in a list of default icon factories, maintained by * gtk_icon_factory_add_default() and * gtk_icon_factory_remove_default(). Applications with icons should * add a default icon factory with their icons, which will allow * themes to override the icons for the application. * * Returns: a new #GtkIconFactory * * Deprecated: 3.10: Use #GtkIconTheme instead. */ GtkIconFactory* gtk_icon_factory_new (void) { return g_object_new (GTK_TYPE_ICON_FACTORY, NULL); } /** * gtk_icon_factory_add: * @factory: a #GtkIconFactory * @stock_id: icon name * @icon_set: icon set * * Adds the given @icon_set to the icon factory, under the name * @stock_id. @stock_id should be namespaced for your application, * e.g. “myapp-whatever-icon”. Normally applications create a * #GtkIconFactory, then add it to the list of default factories with * gtk_icon_factory_add_default(). Then they pass the @stock_id to * widgets such as #GtkImage to display the icon. Themes can provide * an icon with the same name (such as "myapp-whatever-icon") to * override your application’s default icons. If an icon already * existed in @factory for @stock_id, it is unreferenced and replaced * with the new @icon_set. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ void gtk_icon_factory_add (GtkIconFactory *factory, const gchar *stock_id, GtkIconSet *icon_set) { GtkIconFactoryPrivate *priv = factory->priv; gpointer old_key = NULL; gpointer old_value = NULL; g_return_if_fail (GTK_IS_ICON_FACTORY (factory)); g_return_if_fail (stock_id != NULL); g_return_if_fail (icon_set != NULL); g_hash_table_lookup_extended (priv->icons, stock_id, &old_key, &old_value); if (old_value == icon_set) return; gtk_icon_set_ref (icon_set); /* GHashTable key memory management is so fantastically broken. */ if (old_key) g_hash_table_insert (priv->icons, old_key, icon_set); else g_hash_table_insert (priv->icons, g_strdup (stock_id), icon_set); if (old_value) gtk_icon_set_unref (old_value); } /** * gtk_icon_factory_lookup: * @factory: a #GtkIconFactory * @stock_id: an icon name * * Looks up @stock_id in the icon factory, returning an icon set * if found, otherwise %NULL. For display to the user, you should * use gtk_style_lookup_icon_set() on the #GtkStyle for the * widget that will display the icon, instead of using this * function directly, so that themes are taken into account. * * Returns: (transfer none): icon set of @stock_id. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ GtkIconSet * gtk_icon_factory_lookup (GtkIconFactory *factory, const gchar *stock_id) { GtkIconFactoryPrivate *priv; g_return_val_if_fail (GTK_IS_ICON_FACTORY (factory), NULL); g_return_val_if_fail (stock_id != NULL, NULL); priv = factory->priv; return g_hash_table_lookup (priv->icons, stock_id); } static GSList *default_factories = NULL; /** * gtk_icon_factory_add_default: * @factory: a #GtkIconFactory * * Adds an icon factory to the list of icon factories searched by * gtk_style_lookup_icon_set(). This means that, for example, * gtk_image_new_from_stock() will be able to find icons in @factory. * There will normally be an icon factory added for each library or * application that comes with icons. The default icon factories * can be overridden by themes. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ void gtk_icon_factory_add_default (GtkIconFactory *factory) { g_return_if_fail (GTK_IS_ICON_FACTORY (factory)); g_object_ref (factory); default_factories = g_slist_prepend (default_factories, factory); } /** * gtk_icon_factory_remove_default: * @factory: a #GtkIconFactory previously added with gtk_icon_factory_add_default() * * Removes an icon factory from the list of default icon * factories. Not normally used; you might use it for a library that * can be unloaded or shut down. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ void gtk_icon_factory_remove_default (GtkIconFactory *factory) { g_return_if_fail (GTK_IS_ICON_FACTORY (factory)); default_factories = g_slist_remove (default_factories, factory); g_object_unref (factory); } static GtkIconFactory * _gtk_icon_factory_get_default_icons (void) { static GtkIconFactory *default_icons = NULL; GtkIconFactory *icons = NULL; GdkScreen *screen = gdk_screen_get_default (); if (screen) icons = g_object_get_data (G_OBJECT (screen), "gtk-default-icons"); if (icons == NULL) { if (default_icons == NULL) { default_icons = gtk_icon_factory_new (); get_default_icons (default_icons); } if (screen) g_object_set_data_full (G_OBJECT (screen), I_("gtk-default-icons"), default_icons, g_object_unref); icons = default_icons; } return icons; } /** * gtk_icon_factory_lookup_default: * @stock_id: an icon name * * Looks for an icon in the list of default icon factories. For * display to the user, you should use gtk_style_lookup_icon_set() on * the #GtkStyle for the widget that will display the icon, instead of * using this function directly, so that themes are taken into * account. * * Returns: (transfer none): a #GtkIconSet, or %NULL * * Deprecated: 3.10: Use #GtkIconTheme instead. */ GtkIconSet * gtk_icon_factory_lookup_default (const gchar *stock_id) { GSList *tmp_list; GtkIconFactory *default_icons; g_return_val_if_fail (stock_id != NULL, NULL); tmp_list = default_factories; while (tmp_list != NULL) { GtkIconSet *icon_set = gtk_icon_factory_lookup (GTK_ICON_FACTORY (tmp_list->data), stock_id); if (icon_set) return icon_set; tmp_list = g_slist_next (tmp_list); } default_icons = _gtk_icon_factory_get_default_icons (); if (default_icons) return gtk_icon_factory_lookup (default_icons, stock_id); else return NULL; } static void register_stock_icon (GtkIconFactory *factory, const gchar *stock_id, const gchar *icon_name) { GtkIconSet *set = gtk_icon_set_new (); GtkIconSource source = GTK_ICON_SOURCE_INIT (TRUE, TRUE, TRUE); source.type = GTK_ICON_SOURCE_STATIC_ICON_NAME; source.source.icon_name = (gchar *)icon_name; source.direction = GTK_TEXT_DIR_NONE; gtk_icon_set_add_source (set, &source); gtk_icon_factory_add (factory, stock_id, set); gtk_icon_set_unref (set); } static void register_bidi_stock_icon (GtkIconFactory *factory, const gchar *stock_id, const gchar *icon_name) { GtkIconSet *set = gtk_icon_set_new (); GtkIconSource source = GTK_ICON_SOURCE_INIT (FALSE, TRUE, TRUE); source.type = GTK_ICON_SOURCE_STATIC_ICON_NAME; source.source.icon_name = (gchar *)icon_name; source.direction = GTK_TEXT_DIR_LTR; gtk_icon_set_add_source (set, &source); source.type = GTK_ICON_SOURCE_STATIC_ICON_NAME; source.source.icon_name = (gchar *)icon_name; source.direction = GTK_TEXT_DIR_RTL; gtk_icon_set_add_source (set, &source); gtk_icon_factory_add (factory, stock_id, set); gtk_icon_set_unref (set); } static void get_default_icons (GtkIconFactory *factory) { /* KEEP IN SYNC with gtkstock.c */ register_stock_icon (factory, GTK_STOCK_DIALOG_AUTHENTICATION, "dialog-password"); register_stock_icon (factory, GTK_STOCK_DIALOG_ERROR, "dialog-error"); register_stock_icon (factory, GTK_STOCK_DIALOG_INFO, "dialog-information"); register_stock_icon (factory, GTK_STOCK_DIALOG_QUESTION, "dialog-question"); register_stock_icon (factory, GTK_STOCK_DIALOG_WARNING, "dialog-warning"); register_stock_icon (factory, GTK_STOCK_DND, GTK_STOCK_DND); register_stock_icon (factory, GTK_STOCK_DND_MULTIPLE, GTK_STOCK_DND_MULTIPLE); register_stock_icon (factory, GTK_STOCK_APPLY, GTK_STOCK_APPLY); register_stock_icon (factory, GTK_STOCK_CANCEL, GTK_STOCK_CANCEL); register_stock_icon (factory, GTK_STOCK_NO, GTK_STOCK_NO); register_stock_icon (factory, GTK_STOCK_OK, GTK_STOCK_OK); register_stock_icon (factory, GTK_STOCK_YES, GTK_STOCK_YES); register_stock_icon (factory, GTK_STOCK_CLOSE, "window-close"); register_stock_icon (factory, GTK_STOCK_ADD, "list-add"); register_stock_icon (factory, GTK_STOCK_JUSTIFY_CENTER, "format-justify-center"); register_stock_icon (factory, GTK_STOCK_JUSTIFY_FILL, "format-justify-fill"); register_stock_icon (factory, GTK_STOCK_JUSTIFY_LEFT, "format-justify-left"); register_stock_icon (factory, GTK_STOCK_JUSTIFY_RIGHT, "format-justify-right"); register_stock_icon (factory, GTK_STOCK_GOTO_BOTTOM, "go-bottom"); register_stock_icon (factory, GTK_STOCK_CDROM, "media-optical"); register_stock_icon (factory, GTK_STOCK_CONVERT, GTK_STOCK_CONVERT); register_stock_icon (factory, GTK_STOCK_COPY, "edit-copy"); register_stock_icon (factory, GTK_STOCK_CUT, "edit-cut"); register_stock_icon (factory, GTK_STOCK_GO_DOWN, "go-down"); register_stock_icon (factory, GTK_STOCK_EXECUTE, "system-run"); register_stock_icon (factory, GTK_STOCK_QUIT, "application-exit"); register_bidi_stock_icon (factory, GTK_STOCK_GOTO_FIRST, "go-first"); register_stock_icon (factory, GTK_STOCK_SELECT_FONT, GTK_STOCK_SELECT_FONT); register_stock_icon (factory, GTK_STOCK_FULLSCREEN, "view-fullscreen"); register_stock_icon (factory, GTK_STOCK_LEAVE_FULLSCREEN, "view-restore"); register_stock_icon (factory, GTK_STOCK_HARDDISK, "drive-harddisk"); register_stock_icon (factory, GTK_STOCK_HELP, "help-contents"); register_stock_icon (factory, GTK_STOCK_HOME, "go-home"); register_stock_icon (factory, GTK_STOCK_INFO, "dialog-information"); register_bidi_stock_icon (factory, GTK_STOCK_JUMP_TO, "go-jump"); register_bidi_stock_icon (factory, GTK_STOCK_GOTO_LAST, "go-last"); register_bidi_stock_icon (factory, GTK_STOCK_GO_BACK, "go-previous"); register_stock_icon (factory, GTK_STOCK_MISSING_IMAGE, "image-missing"); register_stock_icon (factory, GTK_STOCK_NETWORK, "network-idle"); register_stock_icon (factory, GTK_STOCK_NEW, "document-new"); register_stock_icon (factory, GTK_STOCK_OPEN, "document-open"); register_stock_icon (factory, GTK_STOCK_ORIENTATION_PORTRAIT, GTK_STOCK_ORIENTATION_PORTRAIT); register_stock_icon (factory, GTK_STOCK_ORIENTATION_LANDSCAPE, GTK_STOCK_ORIENTATION_LANDSCAPE); register_stock_icon (factory, GTK_STOCK_ORIENTATION_REVERSE_PORTRAIT, GTK_STOCK_ORIENTATION_REVERSE_PORTRAIT); register_stock_icon (factory, GTK_STOCK_ORIENTATION_REVERSE_LANDSCAPE, GTK_STOCK_ORIENTATION_REVERSE_LANDSCAPE); register_stock_icon (factory, GTK_STOCK_PAGE_SETUP, GTK_STOCK_PAGE_SETUP); register_stock_icon (factory, GTK_STOCK_PASTE, "edit-paste"); register_stock_icon (factory, GTK_STOCK_PREFERENCES, GTK_STOCK_PREFERENCES); register_stock_icon (factory, GTK_STOCK_PRINT, "document-print"); register_stock_icon (factory, GTK_STOCK_PRINT_ERROR, "printer-error"); register_stock_icon (factory, GTK_STOCK_PRINT_PAUSED, "printer-paused"); register_stock_icon (factory, GTK_STOCK_PRINT_PREVIEW, "document-print-preview"); register_stock_icon (factory, GTK_STOCK_PRINT_REPORT, "printer-info"); register_stock_icon (factory, GTK_STOCK_PRINT_WARNING, "printer-warning"); register_stock_icon (factory, GTK_STOCK_PROPERTIES, "document-properties"); register_bidi_stock_icon (factory, GTK_STOCK_REDO, "edit-redo"); register_stock_icon (factory, GTK_STOCK_REMOVE, "list-remove"); register_stock_icon (factory, GTK_STOCK_REFRESH, "view-refresh"); register_bidi_stock_icon (factory, GTK_STOCK_REVERT_TO_SAVED, "document-revert"); register_bidi_stock_icon (factory, GTK_STOCK_GO_FORWARD, "go-next"); register_stock_icon (factory, GTK_STOCK_SAVE, "document-save"); register_stock_icon (factory, GTK_STOCK_FLOPPY, "media-floppy"); register_stock_icon (factory, GTK_STOCK_SAVE_AS, "document-save-as"); register_stock_icon (factory, GTK_STOCK_FIND, "edit-find"); register_stock_icon (factory, GTK_STOCK_FIND_AND_REPLACE, "edit-find-replace"); register_stock_icon (factory, GTK_STOCK_SORT_DESCENDING, "view-sort-descending"); register_stock_icon (factory, GTK_STOCK_SORT_ASCENDING, "view-sort-ascending"); register_stock_icon (factory, GTK_STOCK_SPELL_CHECK, "tools-check-spelling"); register_stock_icon (factory, GTK_STOCK_STOP, "process-stop"); register_stock_icon (factory, GTK_STOCK_BOLD, "format-text-bold"); register_stock_icon (factory, GTK_STOCK_ITALIC, "format-text-italic"); register_stock_icon (factory, GTK_STOCK_STRIKETHROUGH, "format-text-strikethrough"); register_stock_icon (factory, GTK_STOCK_UNDERLINE, "format-text-underline"); register_bidi_stock_icon (factory, GTK_STOCK_INDENT, "format-indent-more"); register_bidi_stock_icon (factory, GTK_STOCK_UNINDENT, "format-indent-less"); register_stock_icon (factory, GTK_STOCK_GOTO_TOP, "go-top"); register_stock_icon (factory, GTK_STOCK_DELETE, "edit-delete"); register_bidi_stock_icon (factory, GTK_STOCK_UNDELETE, GTK_STOCK_UNDELETE); register_bidi_stock_icon (factory, GTK_STOCK_UNDO, "edit-undo"); register_stock_icon (factory, GTK_STOCK_GO_UP, "go-up"); register_stock_icon (factory, GTK_STOCK_FILE, "text-x-generic"); register_stock_icon (factory, GTK_STOCK_DIRECTORY, "folder"); register_stock_icon (factory, GTK_STOCK_ABOUT, "help-about"); register_stock_icon (factory, GTK_STOCK_CONNECT, GTK_STOCK_CONNECT); register_stock_icon (factory, GTK_STOCK_DISCONNECT, GTK_STOCK_DISCONNECT); register_stock_icon (factory, GTK_STOCK_EDIT, GTK_STOCK_EDIT); register_stock_icon (factory, GTK_STOCK_CAPS_LOCK_WARNING, GTK_STOCK_CAPS_LOCK_WARNING); register_bidi_stock_icon (factory, GTK_STOCK_MEDIA_FORWARD, "media-seek-forward"); register_bidi_stock_icon (factory, GTK_STOCK_MEDIA_NEXT, "media-skip-forward"); register_stock_icon (factory, GTK_STOCK_MEDIA_PAUSE, "media-playback-pause"); register_bidi_stock_icon (factory, GTK_STOCK_MEDIA_PLAY, "media-playback-start"); register_bidi_stock_icon (factory, GTK_STOCK_MEDIA_PREVIOUS, "media-skip-backward"); register_stock_icon (factory, GTK_STOCK_MEDIA_RECORD, "media-record"); register_bidi_stock_icon (factory, GTK_STOCK_MEDIA_REWIND, "media-seek-backward"); register_stock_icon (factory, GTK_STOCK_MEDIA_STOP, "media-playback-stop"); register_stock_icon (factory, GTK_STOCK_INDEX, GTK_STOCK_INDEX); register_stock_icon (factory, GTK_STOCK_ZOOM_100, "zoom-original"); register_stock_icon (factory, GTK_STOCK_ZOOM_IN, "zoom-in"); register_stock_icon (factory, GTK_STOCK_ZOOM_OUT, "zoom-out"); register_stock_icon (factory, GTK_STOCK_ZOOM_FIT, "zoom-fit-best"); register_stock_icon (factory, GTK_STOCK_SELECT_ALL, "edit-select-all"); register_stock_icon (factory, GTK_STOCK_CLEAR, "edit-clear"); register_stock_icon (factory, GTK_STOCK_SELECT_COLOR, GTK_STOCK_SELECT_COLOR); register_stock_icon (factory, GTK_STOCK_COLOR_PICKER, GTK_STOCK_COLOR_PICKER); } /************************************************************ * Icon size handling * ************************************************************/ typedef struct _IconSize IconSize; struct _IconSize { gint size; gchar *name; gint width; gint height; }; typedef struct _IconAlias IconAlias; struct _IconAlias { gchar *name; gint target; }; static GHashTable *icon_aliases = NULL; static IconSize *icon_sizes = NULL; static gint icon_sizes_allocated = 0; static gint icon_sizes_used = 0; static void init_icon_sizes (void) { if (icon_sizes == NULL) { #define NUM_BUILTIN_SIZES 7 gint i; icon_aliases = g_hash_table_new (g_str_hash, g_str_equal); icon_sizes = g_new (IconSize, NUM_BUILTIN_SIZES); icon_sizes_allocated = NUM_BUILTIN_SIZES; icon_sizes_used = NUM_BUILTIN_SIZES; icon_sizes[GTK_ICON_SIZE_INVALID].size = 0; icon_sizes[GTK_ICON_SIZE_INVALID].name = NULL; icon_sizes[GTK_ICON_SIZE_INVALID].width = 0; icon_sizes[GTK_ICON_SIZE_INVALID].height = 0; /* the name strings aren't copied since we don't ever remove * icon sizes, so we don't need to know whether they're static. * Even if we did I suppose removing the builtin sizes would be * disallowed. */ icon_sizes[GTK_ICON_SIZE_MENU].size = GTK_ICON_SIZE_MENU; icon_sizes[GTK_ICON_SIZE_MENU].name = "gtk-menu"; icon_sizes[GTK_ICON_SIZE_MENU].width = 16; icon_sizes[GTK_ICON_SIZE_MENU].height = 16; icon_sizes[GTK_ICON_SIZE_BUTTON].size = GTK_ICON_SIZE_BUTTON; icon_sizes[GTK_ICON_SIZE_BUTTON].name = "gtk-button"; icon_sizes[GTK_ICON_SIZE_BUTTON].width = 16; icon_sizes[GTK_ICON_SIZE_BUTTON].height = 16; icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].size = GTK_ICON_SIZE_SMALL_TOOLBAR; icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].name = "gtk-small-toolbar"; icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].width = 16; icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].height = 16; icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].size = GTK_ICON_SIZE_LARGE_TOOLBAR; icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].name = "gtk-large-toolbar"; icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].width = 24; icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].height = 24; icon_sizes[GTK_ICON_SIZE_DND].size = GTK_ICON_SIZE_DND; icon_sizes[GTK_ICON_SIZE_DND].name = "gtk-dnd"; icon_sizes[GTK_ICON_SIZE_DND].width = 32; icon_sizes[GTK_ICON_SIZE_DND].height = 32; icon_sizes[GTK_ICON_SIZE_DIALOG].size = GTK_ICON_SIZE_DIALOG; icon_sizes[GTK_ICON_SIZE_DIALOG].name = "gtk-dialog"; icon_sizes[GTK_ICON_SIZE_DIALOG].width = 48; icon_sizes[GTK_ICON_SIZE_DIALOG].height = 48; g_assert ((GTK_ICON_SIZE_DIALOG + 1) == NUM_BUILTIN_SIZES); /* Alias everything to itself. */ i = 1; /* skip invalid size */ while (i < NUM_BUILTIN_SIZES) { gtk_icon_size_register_alias (icon_sizes[i].name, icon_sizes[i].size); ++i; } #undef NUM_BUILTIN_SIZES } } static gboolean icon_size_lookup_intern (GtkIconSize size, gint *widthp, gint *heightp) { init_icon_sizes (); if (size == (GtkIconSize)-1) return FALSE; if (size >= icon_sizes_used) return FALSE; if (size == GTK_ICON_SIZE_INVALID) return FALSE; if (widthp) *widthp = icon_sizes[size].width; if (heightp) *heightp = icon_sizes[size].height; return TRUE; } /** * gtk_icon_size_lookup_for_settings: * @settings: a #GtkSettings object, used to determine * which set of user preferences to used. * @size: (type int): an icon size * @width: (out) (allow-none): location to store icon width * @height: (out) (allow-none): location to store icon height * * Obtains the pixel size of a semantic icon size, possibly * modified by user preferences for a particular * #GtkSettings. Normally @size would be * #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc. This function * isn’t normally needed, gtk_widget_render_icon_pixbuf() is the usual * way to get an icon for rendering, then just look at the size of * the rendered pixbuf. The rendered pixbuf may not even correspond to * the width/height returned by gtk_icon_size_lookup(), because themes * are free to render the pixbuf however they like, including changing * the usual size. * * Returns: %TRUE if @size was a valid size * * Since: 2.2 * * Deprecated: 3.10: Use gtk_icon_size_lookup() instead. */ gboolean gtk_icon_size_lookup_for_settings (GtkSettings *settings, GtkIconSize size, gint *width, gint *height) { g_return_val_if_fail (GTK_IS_SETTINGS (settings), FALSE); return icon_size_lookup_intern (size, width, height); } /** * gtk_icon_size_lookup: * @size: (type int): an icon size * @width: (out) (allow-none): location to store icon width * @height: (out) (allow-none): location to store icon height * * Obtains the pixel size of a semantic icon size @size: * #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc. This function * isn’t normally needed, gtk_icon_theme_load_icon() is the usual * way to get an icon for rendering, then just look at the size of * the rendered pixbuf. The rendered pixbuf may not even correspond to * the width/height returned by gtk_icon_size_lookup(), because themes * are free to render the pixbuf however they like, including changing * the usual size. * * Returns: %TRUE if @size was a valid size */ gboolean gtk_icon_size_lookup (GtkIconSize size, gint *widthp, gint *heightp) { GTK_NOTE (MULTIHEAD, g_warning ("gtk_icon_size_lookup ()) is not multihead safe")); return icon_size_lookup_intern (size, widthp, heightp); } static GtkIconSize icon_size_register_intern (const gchar *name, gint width, gint height) { IconAlias *old_alias; GtkIconSize size; init_icon_sizes (); old_alias = g_hash_table_lookup (icon_aliases, name); if (old_alias && icon_sizes[old_alias->target].width > 0) { g_warning ("Icon size name '%s' already exists", name); return GTK_ICON_SIZE_INVALID; } if (old_alias) { size = old_alias->target; } else { if (icon_sizes_used == icon_sizes_allocated) { icon_sizes_allocated *= 2; icon_sizes = g_renew (IconSize, icon_sizes, icon_sizes_allocated); } size = icon_sizes_used++; /* alias to self. */ gtk_icon_size_register_alias (name, size); icon_sizes[size].size = size; icon_sizes[size].name = g_strdup (name); } icon_sizes[size].width = width; icon_sizes[size].height = height; return size; } /** * gtk_icon_size_register: * @name: name of the icon size * @width: the icon width * @height: the icon height * * Registers a new icon size, along the same lines as #GTK_ICON_SIZE_MENU, * etc. Returns the integer value for the size. * * Returns: (type int): integer value representing the size * * Deprecated: 3.10: Use #GtkIconTheme instead. */ GtkIconSize gtk_icon_size_register (const gchar *name, gint width, gint height) { g_return_val_if_fail (name != NULL, 0); g_return_val_if_fail (width > 0, 0); g_return_val_if_fail (height > 0, 0); return icon_size_register_intern (name, width, height); } /** * gtk_icon_size_register_alias: * @alias: an alias for @target * @target: (type int): an existing icon size * * Registers @alias as another name for @target. * So calling gtk_icon_size_from_name() with @alias as argument * will return @target. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ void gtk_icon_size_register_alias (const gchar *alias, GtkIconSize target) { IconAlias *ia; g_return_if_fail (alias != NULL); init_icon_sizes (); if (!icon_size_lookup_intern (target, NULL, NULL)) g_warning ("gtk_icon_size_register_alias: Icon size %u does not exist", target); ia = g_hash_table_lookup (icon_aliases, alias); if (ia) { if (icon_sizes[ia->target].width > 0) { g_warning ("gtk_icon_size_register_alias: Icon size name '%s' already exists", alias); return; } ia->target = target; } if (!ia) { ia = g_new (IconAlias, 1); ia->name = g_strdup (alias); ia->target = target; g_hash_table_insert (icon_aliases, ia->name, ia); } } /** * gtk_icon_size_from_name: * @name: the name to look up. * * Looks up the icon size associated with @name. * * Returns: (type int): the icon size * * Deprecated: 3.10: Use #GtkIconTheme instead. */ GtkIconSize gtk_icon_size_from_name (const gchar *name) { IconAlias *ia; init_icon_sizes (); ia = g_hash_table_lookup (icon_aliases, name); if (ia && icon_sizes[ia->target].width > 0) return ia->target; else return GTK_ICON_SIZE_INVALID; } /** * gtk_icon_size_get_name: * @size: (type int): a #GtkIconSize. * * Gets the canonical name of the given icon size. The returned string * is statically allocated and should not be freed. * * Returns: the name of the given icon size. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ const gchar* gtk_icon_size_get_name (GtkIconSize size) { if (size >= icon_sizes_used) return NULL; else return icon_sizes[size].name; } /************************************************************/ /* Icon Set */ static GdkPixbuf *find_in_cache (GtkIconSet *icon_set, GtkStyleContext *style_context, GtkTextDirection direction, GtkStateType state, GtkIconSize size, gint scale, GtkCssImageEffect effect); static void add_to_cache (GtkIconSet *icon_set, GtkStyleContext *style_context, GtkTextDirection direction, GtkStateType state, GtkIconSize size, gint scale, GtkCssImageEffect effect, GdkPixbuf *pixbuf); /* Clear icon set contents, drop references to all contained * GdkPixbuf objects and forget all GtkIconSources. Used to * recycle an icon set. */ static void clear_cache (GtkIconSet *icon_set, gboolean style_detach); static GSList* copy_cache (GtkIconSet *icon_set, GtkIconSet *copy_recipient); static void attach_to_style (GtkIconSet *icon_set, GtkStyleContext *style_context); static void detach_from_style (GtkIconSet *icon_set, GtkStyleContext *style_context); static void style_dnotify (gpointer data); struct _GtkIconSet { guint ref_count; GSList *sources; /* Cache of the last few rendered versions of the icon. */ GSList *cache; guint cache_size; guint cache_serial; }; static guint cache_serial = 0; /** * gtk_icon_set_new: * * Creates a new #GtkIconSet. A #GtkIconSet represents a single icon * in various sizes and widget states. It can provide a #GdkPixbuf * for a given size and state on request, and automatically caches * some of the rendered #GdkPixbuf objects. * * Normally you would use gtk_widget_render_icon_pixbuf() instead of * using #GtkIconSet directly. The one case where you’d use * #GtkIconSet is to create application-specific icon sets to place in * a #GtkIconFactory. * * Returns: a new #GtkIconSet * * Deprecated: 3.10: Use #GtkIconTheme instead. */ GtkIconSet* gtk_icon_set_new (void) { GtkIconSet *icon_set; icon_set = g_new (GtkIconSet, 1); icon_set->ref_count = 1; icon_set->sources = NULL; icon_set->cache = NULL; icon_set->cache_size = 0; icon_set->cache_serial = cache_serial; return icon_set; } /** * gtk_icon_set_new_from_pixbuf: * @pixbuf: a #GdkPixbuf * * Creates a new #GtkIconSet with @pixbuf as the default/fallback * source image. If you don’t add any additional #GtkIconSource to the * icon set, all variants of the icon will be created from @pixbuf, * using scaling, pixelation, etc. as required to adjust the icon size * or make the icon look insensitive/prelighted. * * Returns: a new #GtkIconSet * * Deprecated: 3.10: Use #GtkIconTheme instead. */ GtkIconSet * gtk_icon_set_new_from_pixbuf (GdkPixbuf *pixbuf) { GtkIconSet *set; GtkIconSource source = GTK_ICON_SOURCE_INIT (TRUE, TRUE, TRUE); g_return_val_if_fail (pixbuf != NULL, NULL); set = gtk_icon_set_new (); gtk_icon_source_set_pixbuf (&source, pixbuf); gtk_icon_set_add_source (set, &source); gtk_icon_source_set_pixbuf (&source, NULL); return set; } /** * gtk_icon_set_ref: * @icon_set: a #GtkIconSet. * * Increments the reference count on @icon_set. * * Returns: @icon_set. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ GtkIconSet* gtk_icon_set_ref (GtkIconSet *icon_set) { g_return_val_if_fail (icon_set != NULL, NULL); g_return_val_if_fail (icon_set->ref_count > 0, NULL); icon_set->ref_count += 1; return icon_set; } /** * gtk_icon_set_unref: * @icon_set: a #GtkIconSet * * Decrements the reference count on @icon_set, and frees memory * if the reference count reaches 0. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ void gtk_icon_set_unref (GtkIconSet *icon_set) { g_return_if_fail (icon_set != NULL); g_return_if_fail (icon_set->ref_count > 0); icon_set->ref_count -= 1; if (icon_set->ref_count == 0) { GSList *tmp_list = icon_set->sources; while (tmp_list != NULL) { gtk_icon_source_free (tmp_list->data); tmp_list = g_slist_next (tmp_list); } g_slist_free (icon_set->sources); clear_cache (icon_set, TRUE); g_free (icon_set); } } G_DEFINE_BOXED_TYPE (GtkIconSet, gtk_icon_set, gtk_icon_set_ref, gtk_icon_set_unref) /** * gtk_icon_set_copy: * @icon_set: a #GtkIconSet * * Copies @icon_set by value. * * Returns: a new #GtkIconSet identical to the first. * * Deprecated: 3.10: Use #GtkIconTheme instead. **/ GtkIconSet* gtk_icon_set_copy (GtkIconSet *icon_set) { GtkIconSet *copy; GSList *tmp_list; copy = gtk_icon_set_new (); tmp_list = icon_set->sources; while (tmp_list != NULL) { copy->sources = g_slist_prepend (copy->sources, gtk_icon_source_copy (tmp_list->data)); tmp_list = g_slist_next (tmp_list); } copy->sources = g_slist_reverse (copy->sources); copy->cache = copy_cache (icon_set, copy); copy->cache_size = icon_set->cache_size; copy->cache_serial = icon_set->cache_serial; return copy; } static gboolean sizes_equivalent (GtkIconSize lhs, GtkIconSize rhs) { /* We used to consider sizes equivalent if they were * the same pixel size, but we don't have the GtkSettings * here, so we can't do that. Plus, it's not clear that * it is right... it was just a workaround for the fact * that we register icons by logical size, not pixel size. */ #if 1 return lhs == rhs; #else gint r_w, r_h, l_w, l_h; icon_size_lookup_intern (rhs, &r_w, &r_h); icon_size_lookup_intern (lhs, &l_w, &l_h); return r_w == l_w && r_h == l_h; #endif } static GtkIconSource * find_best_matching_source (GtkIconSet *icon_set, GtkTextDirection direction, GtkStateType state, GtkIconSize size, GSList *failed) { GtkIconSource *source; GSList *tmp_list; /* We need to find the best icon source. Direction matters more * than state, state matters more than size. icon_set->sources * is sorted according to wildness, so if we take the first * match we find it will be the least-wild match (if there are * multiple matches for a given "wildness" then the RC file contained * dumb stuff, and we end up with an arbitrary matching source) */ source = NULL; tmp_list = icon_set->sources; while (tmp_list != NULL) { GtkIconSource *s = tmp_list->data; if ((s->any_direction || (s->direction == direction)) && (s->any_state || (s->state == state)) && (s->any_size || size == (GtkIconSize)-1 || (sizes_equivalent (size, s->size)))) { if (!g_slist_find (failed, s)) { source = s; break; } } tmp_list = g_slist_next (tmp_list); } return source; } static gboolean ensure_filename_pixbuf (GtkIconSet *icon_set, GtkIconSource *source) { if (source->filename_pixbuf == NULL) { GError *error = NULL; source->filename_pixbuf = gdk_pixbuf_new_from_file (source->source.filename, &error); if (source->filename_pixbuf == NULL) { /* Remove this icon source so we don't keep trying to * load it. */ g_warning ("Error loading icon: %s", error->message); g_error_free (error); icon_set->sources = g_slist_remove (icon_set->sources, source); gtk_icon_source_free (source); return FALSE; } } return TRUE; } static GdkPixbuf * render_icon_name_pixbuf (GtkIconSource *icon_source, GtkStyleContext *context, GtkIconSize size, gint scale) { GdkPixbuf *pixbuf; GdkPixbuf *tmp_pixbuf; GtkIconSource tmp_source; GdkScreen *screen; GtkIconTheme *icon_theme; GtkSettings *settings; gint width, height, pixel_size; gint *sizes, *s, dist; GError *error = NULL; screen = gtk_style_context_get_screen (context); icon_theme = gtk_icon_theme_get_for_screen (screen); settings = gtk_settings_get_for_screen (screen); if (!gtk_icon_size_lookup_for_settings (settings, size, &width, &height)) { if (size == (GtkIconSize)-1) { /* Find an available size close to 48 */ sizes = gtk_icon_theme_get_icon_sizes (icon_theme, icon_source->source.icon_name); dist = 1000; width = height = 48; for (s = sizes; *s; s++) { if (*s == -1) { width = height = 48; break; } if (*s < 48) { if (48 - *s < dist) { width = height = *s; dist = 48 - *s; } } else { if (*s - 48 < dist) { width = height = *s; dist = *s - 48; } } } g_free (sizes); } else { g_warning ("Invalid icon size %u\n", size); width = height = 24; } } pixel_size = MIN (width, height); if (icon_source->direction != GTK_TEXT_DIR_NONE) { gchar *suffix[3] = { NULL, "-ltr", "-rtl" }; gchar *names[3]; GtkIconInfo *info; names[0] = g_strconcat (icon_source->source.icon_name, suffix[icon_source->direction], NULL); names[1] = icon_source->source.icon_name; names[2] = NULL; info = gtk_icon_theme_choose_icon_for_scale (icon_theme, (const char **) names, pixel_size, scale, GTK_ICON_LOOKUP_USE_BUILTIN); g_free (names[0]); if (info) { tmp_pixbuf = gtk_icon_info_load_icon (info, &error); g_object_unref (info); } else tmp_pixbuf = NULL; } else { tmp_pixbuf = gtk_icon_theme_load_icon_for_scale (icon_theme, icon_source->source.icon_name, pixel_size, scale, 0, &error); } if (!tmp_pixbuf) { g_warning ("Error loading theme icon '%s' for stock: %s", icon_source->source.icon_name, error ? error->message : ""); if (error) g_error_free (error); return NULL; } tmp_source = *icon_source; tmp_source.type = GTK_ICON_SOURCE_PIXBUF; tmp_source.source.pixbuf = tmp_pixbuf; pixbuf = gtk_render_icon_pixbuf (context, &tmp_source, -1); if (!pixbuf) g_warning ("Failed to render icon"); g_object_unref (tmp_pixbuf); return pixbuf; } static GdkPixbuf * find_and_render_icon_source (GtkIconSet *icon_set, GtkStyleContext *context, GtkTextDirection direction, GtkStateType state, GtkIconSize size, gint scale) { GSList *failed = NULL; GdkPixbuf *pixbuf = NULL; /* We treat failure in two different ways: * * A) If loading a source that specifies a filename fails, * we treat that as permanent, and remove the source * from the GtkIconSet. (in ensure_filename_pixbuf () * B) If loading a themed icon fails, or scaling an icon * fails, we treat that as transient and will try * again next time the icon falls out of the cache * and we need to recreate it. */ while (pixbuf == NULL) { GtkIconSource *source = find_best_matching_source (icon_set, direction, state, size, failed); if (source == NULL) break; switch (source->type) { case GTK_ICON_SOURCE_FILENAME: if (!ensure_filename_pixbuf (icon_set, source)) break; /* Fall through */ case GTK_ICON_SOURCE_PIXBUF: pixbuf = gtk_render_icon_pixbuf (context, source, size); if (!pixbuf) { g_warning ("Failed to render icon"); failed = g_slist_prepend (failed, source); } if (scale != 1) { GdkPixbuf *tmp = pixbuf; pixbuf = gdk_pixbuf_scale_simple (pixbuf, gdk_pixbuf_get_width (pixbuf) * scale, gdk_pixbuf_get_height (pixbuf) * scale, GDK_INTERP_BILINEAR); g_object_unref (tmp); } break; case GTK_ICON_SOURCE_ICON_NAME: case GTK_ICON_SOURCE_STATIC_ICON_NAME: pixbuf = render_icon_name_pixbuf (source, context, size, scale); if (!pixbuf) failed = g_slist_prepend (failed, source); break; case GTK_ICON_SOURCE_EMPTY: g_assert_not_reached (); } } g_slist_free (failed); return pixbuf; } extern GtkIconCache *_builtin_cache; static GdkPixbuf* render_fallback_image (GtkStyleContext *context, GtkTextDirection direction, GtkStateType state, GtkIconSize size) { /* This icon can be used for any direction/state/size */ static GtkIconSource fallback_source = GTK_ICON_SOURCE_INIT (TRUE, TRUE, TRUE); if (fallback_source.type == GTK_ICON_SOURCE_EMPTY) { gint index; GdkPixbuf *pixbuf; _gtk_icon_theme_ensure_builtin_cache (); index = _gtk_icon_cache_get_directory_index (_builtin_cache, "24"); pixbuf = _gtk_icon_cache_get_icon (_builtin_cache, "image-missing", index); g_return_val_if_fail(pixbuf != NULL, NULL); gtk_icon_source_set_pixbuf (&fallback_source, pixbuf); g_object_unref (pixbuf); } return gtk_render_icon_pixbuf (context, &fallback_source, size); } static GdkPixbuf* gtk_icon_set_render_icon_pixbuf_for_scale (GtkIconSet *icon_set, GtkStyleContext *context, GtkIconSize size, gint scale) { GdkPixbuf *icon = NULL; GtkStateFlags flags = 0; GtkStateType state; GtkTextDirection direction; GtkCssImageEffect effect; g_return_val_if_fail (icon_set != NULL, NULL); g_return_val_if_fail (GTK_IS_STYLE_CONTEXT (context), NULL); flags = gtk_style_context_get_state (context); if (flags & GTK_STATE_FLAG_INSENSITIVE) state = GTK_STATE_INSENSITIVE; else if (flags & GTK_STATE_FLAG_PRELIGHT) state = GTK_STATE_PRELIGHT; else state = GTK_STATE_NORMAL; G_GNUC_BEGIN_IGNORE_DEPRECATIONS; direction = gtk_style_context_get_direction (context); G_GNUC_END_IGNORE_DEPRECATIONS; effect = _gtk_css_image_effect_value_get (_gtk_style_context_peek_property (context, GTK_CSS_PROPERTY_GTK_IMAGE_EFFECT)); if (icon_set->sources) { icon = find_in_cache (icon_set, context, direction, state, size, scale, effect); if (icon) return g_object_ref (icon); } if (icon_set->sources) icon = find_and_render_icon_source (icon_set, context, direction, state, size, scale); if (icon == NULL) icon = render_fallback_image (context, direction, state, size); add_to_cache (icon_set, context, direction, state, size, scale, effect, icon); return icon; } /** * gtk_icon_set_render_icon_pixbuf: * @icon_set: a #GtkIconSet * @context: a #GtkStyleContext * @size: (type int): icon size. A size of (GtkIconSize)-1 * means render at the size of the source and don’t scale. * * Renders an icon using gtk_render_icon_pixbuf(). In most cases, * gtk_widget_render_icon_pixbuf() is better, since it automatically provides * most of the arguments from the current widget settings. This * function never returns %NULL; if the icon can’t be rendered * (perhaps because an image file fails to load), a default "missing * image" icon will be returned instead. * * Returns: (transfer full): a #GdkPixbuf to be displayed * * Since: 3.0 * * Deprecated: 3.10: Use #GtkIconTheme instead. */ GdkPixbuf * gtk_icon_set_render_icon_pixbuf (GtkIconSet *icon_set, GtkStyleContext *context, GtkIconSize size) { g_return_val_if_fail (icon_set != NULL, NULL); g_return_val_if_fail (GTK_IS_STYLE_CONTEXT (context), NULL); return gtk_icon_set_render_icon_pixbuf_for_scale (icon_set, context, size, 1); } /** * gtk_icon_set_render_icon_surface: * @icon_set: a #GtkIconSet * @context: a #GtkStyleContext * @size: (type int): icon size. A size of (GtkIconSize)-1 * means render at the size of the source and don’t scale. * @scale: the window scale to render for * @for_window: (allow-none): #GdkWindow to optimize drawing for, or %NULL * * Renders an icon using gtk_render_icon_pixbuf() and converts it to a * cairo surface. * * This function never returns %NULL; if the icon can’t be rendered * (perhaps because an image file fails to load), a default "missing * image" icon will be returned instead. * * Returns: (transfer full): a #cairo_surface_t to be displayed * * Since: 3.10 * * Deprecated: 3.10: Use #GtkIconTheme instead. */ cairo_surface_t * gtk_icon_set_render_icon_surface (GtkIconSet *icon_set, GtkStyleContext *context, GtkIconSize size, gint scale, GdkWindow *for_window) { GdkPixbuf *pixbuf; cairo_surface_t *surface; pixbuf = gtk_icon_set_render_icon_pixbuf_for_scale (icon_set, context, size, scale); surface = gdk_cairo_surface_create_from_pixbuf (pixbuf, scale, for_window); g_object_unref (pixbuf); return surface; } /** * gtk_icon_set_render_icon: * @icon_set: a #GtkIconSet * @style: (allow-none): a #GtkStyle associated with @widget, or %NULL * @direction: text direction * @state: widget state * @size: (type int): icon size. A size of (GtkIconSize)-1 * means render at the size of the source and don’t scale. * @widget: (allow-none): widget that will display the icon, or %NULL. * The only use that is typically made of this * is to determine the appropriate #GdkScreen. * @detail: (allow-none): detail to pass to the theme engine, or %NULL. * Note that passing a detail of anything but %NULL * will disable caching. * * Renders an icon using gtk_style_render_icon(). In most cases, * gtk_widget_render_icon() is better, since it automatically provides * most of the arguments from the current widget settings. This * function never returns %NULL; if the icon can’t be rendered * (perhaps because an image file fails to load), a default "missing * image" icon will be returned instead. * * Returns: (transfer full): a #GdkPixbuf to be displayed * * Deprecated: 3.0: Use gtk_icon_set_render_icon_pixbuf() instead */ GdkPixbuf* gtk_icon_set_render_icon (GtkIconSet *icon_set, GtkStyle *style, GtkTextDirection direction, GtkStateType state, GtkIconSize size, GtkWidget *widget, const char *detail) { GdkPixbuf *icon; GtkStyleContext *context = NULL; GtkStateFlags flags = 0; g_return_val_if_fail (icon_set != NULL, NULL); G_GNUC_BEGIN_IGNORE_DEPRECATIONS; g_return_val_if_fail (style == NULL || GTK_IS_STYLE (style), NULL); if (style && gtk_style_has_context (style)) { g_object_get (style, "context", &context, NULL); /* g_object_get returns a refed object */ if (context) g_object_unref (context); } else if (widget) { context = gtk_widget_get_style_context (widget); } if (!context) return render_fallback_image (context, direction, state, size); gtk_style_context_save (context); switch (state) { case GTK_STATE_PRELIGHT: flags |= GTK_STATE_FLAG_PRELIGHT; break; case GTK_STATE_INSENSITIVE: flags |= GTK_STATE_FLAG_INSENSITIVE; break; default: break; } gtk_style_context_set_state (context, flags); gtk_style_context_set_direction (context, direction); G_GNUC_END_IGNORE_DEPRECATIONS; icon = gtk_icon_set_render_icon_pixbuf (icon_set, context, size); gtk_style_context_restore (context); return icon; } /* Order sources by their "wildness", so that "wilder" sources are * greater than “specific” sources; for determining ordering, * direction beats state beats size. */ static int icon_source_compare (gconstpointer ap, gconstpointer bp) { const GtkIconSource *a = ap; const GtkIconSource *b = bp; if (!a->any_direction && b->any_direction) return -1; else if (a->any_direction && !b->any_direction) return 1; else if (!a->any_state && b->any_state) return -1; else if (a->any_state && !b->any_state) return 1; else if (!a->any_size && b->any_size) return -1; else if (a->any_size && !b->any_size) return 1; else return 0; } /** * gtk_icon_set_add_source: * @icon_set: a #GtkIconSet * @source: a #GtkIconSource * * Icon sets have a list of #GtkIconSource, which they use as base * icons for rendering icons in different states and sizes. Icons are * scaled, made to look insensitive, etc. in * gtk_icon_set_render_icon(), but #GtkIconSet needs base images to * work with. The base images and when to use them are described by * a #GtkIconSource. * * This function copies @source, so you can reuse the same source immediately * without affecting the icon set. * * An example of when you’d use this function: a web browser’s "Back * to Previous Page" icon might point in a different direction in * Hebrew and in English; it might look different when insensitive; * and it might change size depending on toolbar mode (small/large * icons). So a single icon set would contain all those variants of * the icon, and you might add a separate source for each one. * * You should nearly always add a “default” icon source with all * fields wildcarded, which will be used as a fallback if no more * specific source matches. #GtkIconSet always prefers more specific * icon sources to more generic icon sources. The order in which you * add the sources to the icon set does not matter. * * gtk_icon_set_new_from_pixbuf() creates a new icon set with a * default icon source based on the given pixbuf. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ void gtk_icon_set_add_source (GtkIconSet *icon_set, const GtkIconSource *source) { g_return_if_fail (icon_set != NULL); g_return_if_fail (source != NULL); if (source->type == GTK_ICON_SOURCE_EMPTY) { g_warning ("Useless empty GtkIconSource"); return; } icon_set->sources = g_slist_insert_sorted (icon_set->sources, gtk_icon_source_copy (source), icon_source_compare); } /** * gtk_icon_set_get_sizes: * @icon_set: a #GtkIconSet * @sizes: (array length=n_sizes) (out) (type int): return location * for array of sizes * @n_sizes: location to store number of elements in returned array * * Obtains a list of icon sizes this icon set can render. The returned * array must be freed with g_free(). * * Deprecated: 3.10: Use #GtkIconTheme instead. */ void gtk_icon_set_get_sizes (GtkIconSet *icon_set, GtkIconSize **sizes, gint *n_sizes) { GSList *tmp_list; gboolean all_sizes = FALSE; GSList *specifics = NULL; g_return_if_fail (icon_set != NULL); g_return_if_fail (sizes != NULL); g_return_if_fail (n_sizes != NULL); tmp_list = icon_set->sources; while (tmp_list != NULL) { GtkIconSource *source; source = tmp_list->data; if (source->any_size) { all_sizes = TRUE; break; } else specifics = g_slist_prepend (specifics, GINT_TO_POINTER (source->size)); tmp_list = g_slist_next (tmp_list); } if (all_sizes) { /* Need to find out what sizes exist */ gint i; init_icon_sizes (); *sizes = g_new (GtkIconSize, icon_sizes_used); *n_sizes = icon_sizes_used - 1; i = 1; while (i < icon_sizes_used) { (*sizes)[i - 1] = icon_sizes[i].size; ++i; } } else { gint i; *n_sizes = g_slist_length (specifics); *sizes = g_new (GtkIconSize, *n_sizes); i = 0; tmp_list = specifics; while (tmp_list != NULL) { (*sizes)[i] = GPOINTER_TO_INT (tmp_list->data); ++i; tmp_list = g_slist_next (tmp_list); } } g_slist_free (specifics); } /** * gtk_icon_source_new: * * Creates a new #GtkIconSource. A #GtkIconSource contains a #GdkPixbuf (or * image filename) that serves as the base image for one or more of the * icons in a #GtkIconSet, along with a specification for which icons in the * icon set will be based on that pixbuf or image file. An icon set contains * a set of icons that represent “the same” logical concept in different states, * different global text directions, and different sizes. * * So for example a web browser’s “Back to Previous Page” icon might * point in a different direction in Hebrew and in English; it might * look different when insensitive; and it might change size depending * on toolbar mode (small/large icons). So a single icon set would * contain all those variants of the icon. #GtkIconSet contains a list * of #GtkIconSource from which it can derive specific icon variants in * the set. * * In the simplest case, #GtkIconSet contains one source pixbuf from * which it derives all variants. The convenience function * gtk_icon_set_new_from_pixbuf() handles this case; if you only have * one source pixbuf, just use that function. * * If you want to use a different base pixbuf for different icon * variants, you create multiple icon sources, mark which variants * they’ll be used to create, and add them to the icon set with * gtk_icon_set_add_source(). * * By default, the icon source has all parameters wildcarded. That is, * the icon source will be used as the base icon for any desired text * direction, widget state, or icon size. * * Returns: a new #GtkIconSource * * Deprecated: 3.10: Use #GtkIconTheme instead. */ GtkIconSource* gtk_icon_source_new (void) { GtkIconSource *src; src = g_new0 (GtkIconSource, 1); src->direction = GTK_TEXT_DIR_NONE; src->size = GTK_ICON_SIZE_INVALID; src->state = GTK_STATE_NORMAL; src->any_direction = TRUE; src->any_state = TRUE; src->any_size = TRUE; return src; } /** * gtk_icon_source_copy: * @source: a #GtkIconSource * * Creates a copy of @source; mostly useful for language bindings. * * Returns: a new #GtkIconSource * * Deprecated: 3.10: Use #GtkIconTheme instead. */ GtkIconSource* gtk_icon_source_copy (const GtkIconSource *source) { GtkIconSource *copy; g_return_val_if_fail (source != NULL, NULL); copy = g_new (GtkIconSource, 1); *copy = *source; switch (copy->type) { case GTK_ICON_SOURCE_EMPTY: case GTK_ICON_SOURCE_STATIC_ICON_NAME: break; case GTK_ICON_SOURCE_ICON_NAME: copy->source.icon_name = g_strdup (copy->source.icon_name); break; case GTK_ICON_SOURCE_FILENAME: copy->source.filename = g_strdup (copy->source.filename); if (copy->filename_pixbuf) g_object_ref (copy->filename_pixbuf); break; case GTK_ICON_SOURCE_PIXBUF: g_object_ref (copy->source.pixbuf); break; default: g_assert_not_reached(); } return copy; } /** * gtk_icon_source_free: * @source: a #GtkIconSource * * Frees a dynamically-allocated icon source, along with its * filename, size, and pixbuf fields if those are not %NULL. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ void gtk_icon_source_free (GtkIconSource *source) { g_return_if_fail (source != NULL); icon_source_clear (source); g_free (source); } G_DEFINE_BOXED_TYPE (GtkIconSource, gtk_icon_source, gtk_icon_source_copy, gtk_icon_source_free) static void icon_source_clear (GtkIconSource *source) { switch (source->type) { case GTK_ICON_SOURCE_EMPTY: break; case GTK_ICON_SOURCE_ICON_NAME: g_free (source->source.icon_name); /* fall thru */ case GTK_ICON_SOURCE_STATIC_ICON_NAME: source->source.icon_name = NULL; break; case GTK_ICON_SOURCE_FILENAME: g_free (source->source.filename); source->source.filename = NULL; if (source->filename_pixbuf) g_object_unref (source->filename_pixbuf); source->filename_pixbuf = NULL; break; case GTK_ICON_SOURCE_PIXBUF: g_object_unref (source->source.pixbuf); source->source.pixbuf = NULL; break; default: g_assert_not_reached(); } source->type = GTK_ICON_SOURCE_EMPTY; } /** * gtk_icon_source_set_filename: * @source: a #GtkIconSource * @filename: (type filename): image file to use * * Sets the name of an image file to use as a base image when creating * icon variants for #GtkIconSet. The filename must be absolute. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ void gtk_icon_source_set_filename (GtkIconSource *source, const gchar *filename) { g_return_if_fail (source != NULL); g_return_if_fail (filename == NULL || g_path_is_absolute (filename)); if (source->type == GTK_ICON_SOURCE_FILENAME && source->source.filename == filename) return; icon_source_clear (source); if (filename != NULL) { source->type = GTK_ICON_SOURCE_FILENAME; source->source.filename = g_strdup (filename); } } /** * gtk_icon_source_set_icon_name: * @source: a #GtkIconSource * @icon_name: (allow-none): name of icon to use * * Sets the name of an icon to look up in the current icon theme * to use as a base image when creating icon variants for #GtkIconSet. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ void gtk_icon_source_set_icon_name (GtkIconSource *source, const gchar *icon_name) { g_return_if_fail (source != NULL); if (source->type == GTK_ICON_SOURCE_ICON_NAME && source->source.icon_name == icon_name) return; icon_source_clear (source); if (icon_name != NULL) { source->type = GTK_ICON_SOURCE_ICON_NAME; source->source.icon_name = g_strdup (icon_name); } } /** * gtk_icon_source_set_pixbuf: * @source: a #GtkIconSource * @pixbuf: pixbuf to use as a source * * Sets a pixbuf to use as a base image when creating icon variants * for #GtkIconSet. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ void gtk_icon_source_set_pixbuf (GtkIconSource *source, GdkPixbuf *pixbuf) { g_return_if_fail (source != NULL); g_return_if_fail (pixbuf == NULL || GDK_IS_PIXBUF (pixbuf)); if (source->type == GTK_ICON_SOURCE_PIXBUF && source->source.pixbuf == pixbuf) return; icon_source_clear (source); if (pixbuf != NULL) { source->type = GTK_ICON_SOURCE_PIXBUF; source->source.pixbuf = g_object_ref (pixbuf); } } /** * gtk_icon_source_get_filename: * @source: a #GtkIconSource * * Retrieves the source filename, or %NULL if none is set. The * filename is not a copy, and should not be modified or expected to * persist beyond the lifetime of the icon source. * * Returns: (type filename): image filename. This string must not * be modified or freed. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ const gchar* gtk_icon_source_get_filename (const GtkIconSource *source) { g_return_val_if_fail (source != NULL, NULL); if (source->type == GTK_ICON_SOURCE_FILENAME) return source->source.filename; else return NULL; } /** * gtk_icon_source_get_icon_name: * @source: a #GtkIconSource * * Retrieves the source icon name, or %NULL if none is set. The * icon_name is not a copy, and should not be modified or expected to * persist beyond the lifetime of the icon source. * * Returns: icon name. This string must not be modified or freed. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ const gchar* gtk_icon_source_get_icon_name (const GtkIconSource *source) { g_return_val_if_fail (source != NULL, NULL); if (source->type == GTK_ICON_SOURCE_ICON_NAME || source->type == GTK_ICON_SOURCE_STATIC_ICON_NAME) return source->source.icon_name; else return NULL; } /** * gtk_icon_source_get_pixbuf: * @source: a #GtkIconSource * * Retrieves the source pixbuf, or %NULL if none is set. * In addition, if a filename source is in use, this * function in some cases will return the pixbuf from * loaded from the filename. This is, for example, true * for the GtkIconSource passed to the #GtkStyle render_icon() * virtual function. The reference count on the pixbuf is * not incremented. * * Returns: (transfer none): source pixbuf * * Deprecated: 3.10: Use #GtkIconTheme instead. */ GdkPixbuf* gtk_icon_source_get_pixbuf (const GtkIconSource *source) { g_return_val_if_fail (source != NULL, NULL); if (source->type == GTK_ICON_SOURCE_PIXBUF) return source->source.pixbuf; else if (source->type == GTK_ICON_SOURCE_FILENAME) return source->filename_pixbuf; else return NULL; } /** * gtk_icon_source_set_direction_wildcarded: * @source: a #GtkIconSource * @setting: %TRUE to wildcard the text direction * * If the text direction is wildcarded, this source can be used * as the base image for an icon in any #GtkTextDirection. * If the text direction is not wildcarded, then the * text direction the icon source applies to should be set * with gtk_icon_source_set_direction(), and the icon source * will only be used with that text direction. * * #GtkIconSet prefers non-wildcarded sources (exact matches) over * wildcarded sources, and will use an exact match when possible. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ void gtk_icon_source_set_direction_wildcarded (GtkIconSource *source, gboolean setting) { g_return_if_fail (source != NULL); source->any_direction = setting != FALSE; } /** * gtk_icon_source_set_state_wildcarded: * @source: a #GtkIconSource * @setting: %TRUE to wildcard the widget state * * If the widget state is wildcarded, this source can be used as the * base image for an icon in any #GtkStateType. If the widget state * is not wildcarded, then the state the source applies to should be * set with gtk_icon_source_set_state() and the icon source will * only be used with that specific state. * * #GtkIconSet prefers non-wildcarded sources (exact matches) over * wildcarded sources, and will use an exact match when possible. * * #GtkIconSet will normally transform wildcarded source images to * produce an appropriate icon for a given state, for example * lightening an image on prelight, but will not modify source images * that match exactly. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ void gtk_icon_source_set_state_wildcarded (GtkIconSource *source, gboolean setting) { g_return_if_fail (source != NULL); source->any_state = setting != FALSE; } /** * gtk_icon_source_set_size_wildcarded: * @source: a #GtkIconSource * @setting: %TRUE to wildcard the widget state * * If the icon size is wildcarded, this source can be used as the base * image for an icon of any size. If the size is not wildcarded, then * the size the source applies to should be set with * gtk_icon_source_set_size() and the icon source will only be used * with that specific size. * * #GtkIconSet prefers non-wildcarded sources (exact matches) over * wildcarded sources, and will use an exact match when possible. * * #GtkIconSet will normally scale wildcarded source images to produce * an appropriate icon at a given size, but will not change the size * of source images that match exactly. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ void gtk_icon_source_set_size_wildcarded (GtkIconSource *source, gboolean setting) { g_return_if_fail (source != NULL); source->any_size = setting != FALSE; } /** * gtk_icon_source_get_size_wildcarded: * @source: a #GtkIconSource * * Gets the value set by gtk_icon_source_set_size_wildcarded(). * * Returns: %TRUE if this icon source is a base for any icon size variant * * Deprecated: 3.10: Use #GtkIconTheme instead. */ gboolean gtk_icon_source_get_size_wildcarded (const GtkIconSource *source) { g_return_val_if_fail (source != NULL, TRUE); return source->any_size; } /** * gtk_icon_source_get_state_wildcarded: * @source: a #GtkIconSource * * Gets the value set by gtk_icon_source_set_state_wildcarded(). * * Returns: %TRUE if this icon source is a base for any widget state variant * * Deprecated: 3.10: Use #GtkIconTheme instead. */ gboolean gtk_icon_source_get_state_wildcarded (const GtkIconSource *source) { g_return_val_if_fail (source != NULL, TRUE); return source->any_state; } /** * gtk_icon_source_get_direction_wildcarded: * @source: a #GtkIconSource * * Gets the value set by gtk_icon_source_set_direction_wildcarded(). * * Returns: %TRUE if this icon source is a base for any text direction variant * * Deprecated: 3.10: Use #GtkIconTheme instead. */ gboolean gtk_icon_source_get_direction_wildcarded (const GtkIconSource *source) { g_return_val_if_fail (source != NULL, TRUE); return source->any_direction; } /** * gtk_icon_source_set_direction: * @source: a #GtkIconSource * @direction: text direction this source applies to * * Sets the text direction this icon source is intended to be used * with. * * Setting the text direction on an icon source makes no difference * if the text direction is wildcarded. Therefore, you should usually * call gtk_icon_source_set_direction_wildcarded() to un-wildcard it * in addition to calling this function. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ void gtk_icon_source_set_direction (GtkIconSource *source, GtkTextDirection direction) { g_return_if_fail (source != NULL); source->direction = direction; } /** * gtk_icon_source_set_state: * @source: a #GtkIconSource * @state: widget state this source applies to * * Sets the widget state this icon source is intended to be used * with. * * Setting the widget state on an icon source makes no difference * if the state is wildcarded. Therefore, you should usually * call gtk_icon_source_set_state_wildcarded() to un-wildcard it * in addition to calling this function. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ void gtk_icon_source_set_state (GtkIconSource *source, GtkStateType state) { g_return_if_fail (source != NULL); source->state = state; } /** * gtk_icon_source_set_size: * @source: a #GtkIconSource * @size: (type int): icon size this source applies to * * Sets the icon size this icon source is intended to be used * with. * * Setting the icon size on an icon source makes no difference * if the size is wildcarded. Therefore, you should usually * call gtk_icon_source_set_size_wildcarded() to un-wildcard it * in addition to calling this function. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ void gtk_icon_source_set_size (GtkIconSource *source, GtkIconSize size) { g_return_if_fail (source != NULL); source->size = size; } /** * gtk_icon_source_get_direction: * @source: a #GtkIconSource * * Obtains the text direction this icon source applies to. The return * value is only useful/meaningful if the text direction is not * wildcarded. * * Returns: text direction this source matches * * Deprecated: 3.10: Use #GtkIconTheme instead. */ GtkTextDirection gtk_icon_source_get_direction (const GtkIconSource *source) { g_return_val_if_fail (source != NULL, 0); return source->direction; } /** * gtk_icon_source_get_state: * @source: a #GtkIconSource * * Obtains the widget state this icon source applies to. The return * value is only useful/meaningful if the widget state is not * wildcarded. * * Returns: widget state this source matches * * Deprecated: 3.10: Use #GtkIconTheme instead. */ GtkStateType gtk_icon_source_get_state (const GtkIconSource *source) { g_return_val_if_fail (source != NULL, 0); return source->state; } /** * gtk_icon_source_get_size: * @source: a #GtkIconSource * * Obtains the icon size this source applies to. The return value * is only useful/meaningful if the icon size is not wildcarded. * * Returns: (type int): icon size this source matches. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ GtkIconSize gtk_icon_source_get_size (const GtkIconSource *source) { g_return_val_if_fail (source != NULL, 0); return source->size; } #define NUM_CACHED_ICONS 8 typedef struct _CachedIcon CachedIcon; struct _CachedIcon { /* These must all match to use the cached pixbuf. * If any don't match, we must re-render the pixbuf. */ GtkStyleContext *style; GtkTextDirection direction; GtkStateType state; GtkIconSize size; gint scale; GtkCssImageEffect effect; GdkPixbuf *pixbuf; }; static void ensure_cache_up_to_date (GtkIconSet *icon_set) { if (icon_set->cache_serial != cache_serial) { clear_cache (icon_set, TRUE); icon_set->cache_serial = cache_serial; } } static void cached_icon_free (CachedIcon *icon) { g_object_unref (icon->pixbuf); g_object_unref (icon->style); g_free (icon); } static GdkPixbuf * find_in_cache (GtkIconSet *icon_set, GtkStyleContext *style_context, GtkTextDirection direction, GtkStateType state, GtkIconSize size, gint scale, GtkCssImageEffect effect) { GSList *tmp_list; GSList *prev; ensure_cache_up_to_date (icon_set); prev = NULL; tmp_list = icon_set->cache; while (tmp_list != NULL) { CachedIcon *icon = tmp_list->data; if (icon->style == style_context && icon->direction == direction && icon->state == state && icon->effect == effect && (size == (GtkIconSize)-1 || icon->size == size)) { if (prev) { /* Move this icon to the front of the list. */ prev->next = tmp_list->next; tmp_list->next = icon_set->cache; icon_set->cache = tmp_list; } return icon->pixbuf; } prev = tmp_list; tmp_list = g_slist_next (tmp_list); } return NULL; } static void add_to_cache (GtkIconSet *icon_set, GtkStyleContext *style_context, GtkTextDirection direction, GtkStateType state, GtkIconSize size, gint scale, GtkCssImageEffect effect, GdkPixbuf *pixbuf) { CachedIcon *icon; ensure_cache_up_to_date (icon_set); g_object_ref (pixbuf); icon = g_new (CachedIcon, 1); icon_set->cache = g_slist_prepend (icon_set->cache, icon); icon_set->cache_size++; icon->style = g_object_ref (style_context); icon->direction = direction; icon->state = state; icon->size = size; icon->scale = scale; icon->effect = effect; icon->pixbuf = pixbuf; attach_to_style (icon_set, icon->style); if (icon_set->cache_size >= NUM_CACHED_ICONS) { /* Remove oldest item in the cache */ GSList *tmp_list; tmp_list = icon_set->cache; /* Find next-to-last link */ g_assert (NUM_CACHED_ICONS > 2); while (tmp_list->next->next) tmp_list = tmp_list->next; g_assert (tmp_list != NULL); g_assert (tmp_list->next != NULL); g_assert (tmp_list->next->next == NULL); /* Free the last icon */ icon = tmp_list->next->data; g_slist_free (tmp_list->next); tmp_list->next = NULL; cached_icon_free (icon); } } static void clear_cache (GtkIconSet *icon_set, gboolean style_detach) { GSList *cache, *tmp_list; GtkStyleContext *last_style = NULL; cache = icon_set->cache; icon_set->cache = NULL; icon_set->cache_size = 0; tmp_list = cache; while (tmp_list != NULL) { CachedIcon *icon = tmp_list->data; if (style_detach) { /* simple optimization for the case where the cache * contains contiguous icons from the same style. * it's safe to call detach_from_style more than * once on the same style though. */ if (last_style != icon->style) { detach_from_style (icon_set, icon->style); last_style = icon->style; } } cached_icon_free (icon); tmp_list = g_slist_next (tmp_list); } g_slist_free (cache); } static GSList* copy_cache (GtkIconSet *icon_set, GtkIconSet *copy_recipient) { GSList *tmp_list; GSList *copy = NULL; ensure_cache_up_to_date (icon_set); tmp_list = icon_set->cache; while (tmp_list != NULL) { CachedIcon *icon = tmp_list->data; CachedIcon *icon_copy = g_new (CachedIcon, 1); *icon_copy = *icon; attach_to_style (copy_recipient, icon_copy->style); g_object_ref (icon_copy->style); g_object_ref (icon_copy->pixbuf); icon_copy->size = icon->size; copy = g_slist_prepend (copy, icon_copy); tmp_list = g_slist_next (tmp_list); } return g_slist_reverse (copy); } static void attach_to_style (GtkIconSet *icon_set, GtkStyleContext *style_context) { GHashTable *table; table = g_object_get_qdata (G_OBJECT (style_context), g_quark_try_string ("gtk-style-icon-sets")); if (table == NULL) { table = g_hash_table_new (NULL, NULL); g_object_set_qdata_full (G_OBJECT (style_context), g_quark_from_static_string ("gtk-style-icon-sets"), table, style_dnotify); } g_hash_table_insert (table, icon_set, icon_set); } static void detach_from_style (GtkIconSet *icon_set, GtkStyleContext *style_context) { GHashTable *table; table = g_object_get_qdata (G_OBJECT (style_context), g_quark_try_string ("gtk-style-icon-sets")); if (table != NULL) g_hash_table_remove (table, icon_set); } static void iconsets_foreach (gpointer key, gpointer value, gpointer user_data) { GtkIconSet *icon_set = key; /* We only need to remove cache entries for the given style; * but that complicates things because in destroy notify * we don't know which style got destroyed, and 95% of the * time all cache entries will have the same style, * so this is faster anyway. */ clear_cache (icon_set, FALSE); } static void style_dnotify (gpointer data) { GHashTable *table = data; g_hash_table_foreach (table, iconsets_foreach, NULL); g_hash_table_destroy (table); } /* This allows the icon set to detect that its cache is out of date. */ void _gtk_icon_set_invalidate_caches (void) { ++cache_serial; } /** * _gtk_icon_factory_list_ids: * * Gets all known IDs stored in an existing icon factory. * The strings in the returned list aren’t copied. * The list itself should be freed. * * Returns: List of ids in icon factories * * Deprecated: 3.10: Use #GtkIconTheme instead. */ GList* _gtk_icon_factory_list_ids (void) { GSList *tmp_list; GList *ids; ids = NULL; _gtk_icon_factory_get_default_icons (); tmp_list = all_icon_factories; while (tmp_list != NULL) { GList *these_ids; GtkIconFactory *factory = GTK_ICON_FACTORY (tmp_list->data); GtkIconFactoryPrivate *priv = factory->priv; these_ids = g_hash_table_get_keys (priv->icons); ids = g_list_concat (ids, these_ids); tmp_list = g_slist_next (tmp_list); } return ids; } typedef struct { GSList *sources; gboolean in_source; } IconFactoryParserData; typedef struct { gchar *stock_id; gchar *filename; gchar *icon_name; GtkTextDirection direction; GtkIconSize size; GtkStateType state; } IconSourceParserData; static void icon_source_start_element (GMarkupParseContext *context, const gchar *element_name, const gchar **names, const gchar **values, gpointer user_data, GError **error) { gint i; gchar *stock_id = NULL; gchar *filename = NULL; gchar *icon_name = NULL; gint size = -1; gint direction = -1; gint state = -1; IconFactoryParserData *parser_data; IconSourceParserData *source_data; gchar *error_msg; GQuark error_domain; parser_data = (IconFactoryParserData*)user_data; if (!parser_data->in_source) { if (strcmp (element_name, "sources") != 0) { error_msg = g_strdup_printf ("Unexpected element %s, expected ", element_name); error_domain = GTK_BUILDER_ERROR_INVALID_TAG; goto error; } parser_data->in_source = TRUE; return; } else { if (strcmp (element_name, "source") != 0) { error_msg = g_strdup_printf ("Unexpected element %s, expected ", element_name); error_domain = GTK_BUILDER_ERROR_INVALID_TAG; goto error; } } for (i = 0; names[i]; i++) { if (strcmp (names[i], "stock-id") == 0) stock_id = g_strdup (values[i]); else if (strcmp (names[i], "filename") == 0) filename = g_strdup (values[i]); else if (strcmp (names[i], "icon-name") == 0) icon_name = g_strdup (values[i]); else if (strcmp (names[i], "size") == 0) { if (!_gtk_builder_enum_from_string (GTK_TYPE_ICON_SIZE, values[i], &size, error)) return; } else if (strcmp (names[i], "direction") == 0) { if (!_gtk_builder_enum_from_string (GTK_TYPE_TEXT_DIRECTION, values[i], &direction, error)) return; } else if (strcmp (names[i], "state") == 0) { if (!_gtk_builder_enum_from_string (GTK_TYPE_STATE_TYPE, values[i], &state, error)) return; } else { error_msg = g_strdup_printf ("'%s' is not a valid attribute of <%s>", names[i], "source"); error_domain = GTK_BUILDER_ERROR_INVALID_ATTRIBUTE; goto error; } } if (!stock_id) { error_msg = g_strdup_printf (" requires a stock_id"); error_domain = GTK_BUILDER_ERROR_MISSING_ATTRIBUTE; goto error; } source_data = g_slice_new (IconSourceParserData); source_data->stock_id = stock_id; source_data->filename = filename; source_data->icon_name = icon_name; source_data->size = size; source_data->direction = direction; source_data->state = state; parser_data->sources = g_slist_prepend (parser_data->sources, source_data); return; error: { gchar *tmp; gint line_number, char_number; g_markup_parse_context_get_position (context, &line_number, &char_number); tmp = g_strdup_printf ("%s:%d:%d %s", "input", line_number, char_number, error_msg); g_set_error_literal (error, GTK_BUILDER_ERROR, error_domain, tmp); g_free (tmp); g_free (stock_id); g_free (filename); g_free (icon_name); return; } } static const GMarkupParser icon_source_parser = { icon_source_start_element, }; static gboolean gtk_icon_factory_buildable_custom_tag_start (GtkBuildable *buildable, GtkBuilder *builder, GObject *child, const gchar *tagname, GMarkupParser *parser, gpointer *data) { g_assert (buildable); if (strcmp (tagname, "sources") == 0) { IconFactoryParserData *parser_data; parser_data = g_slice_new0 (IconFactoryParserData); *parser = icon_source_parser; *data = parser_data; return TRUE; } return FALSE; } static void gtk_icon_factory_buildable_custom_tag_end (GtkBuildable *buildable, GtkBuilder *builder, GObject *child, const gchar *tagname, gpointer *user_data) { GtkIconFactory *icon_factory; icon_factory = GTK_ICON_FACTORY (buildable); if (strcmp (tagname, "sources") == 0) { IconFactoryParserData *parser_data; GtkIconSource *icon_source; GtkIconSet *icon_set; GSList *l; parser_data = (IconFactoryParserData*)user_data; for (l = parser_data->sources; l; l = l->next) { IconSourceParserData *source_data = l->data; icon_set = gtk_icon_factory_lookup (icon_factory, source_data->stock_id); if (!icon_set) { icon_set = gtk_icon_set_new (); gtk_icon_factory_add (icon_factory, source_data->stock_id, icon_set); gtk_icon_set_unref (icon_set); } icon_source = gtk_icon_source_new (); if (source_data->filename) { gchar *filename; filename = _gtk_builder_get_absolute_filename (builder, source_data->filename); gtk_icon_source_set_filename (icon_source, filename); g_free (filename); } if (source_data->icon_name) gtk_icon_source_set_icon_name (icon_source, source_data->icon_name); if (source_data->size != -1) { gtk_icon_source_set_size (icon_source, source_data->size); gtk_icon_source_set_size_wildcarded (icon_source, FALSE); } if (source_data->direction != -1) { gtk_icon_source_set_direction (icon_source, source_data->direction); gtk_icon_source_set_direction_wildcarded (icon_source, FALSE); } if (source_data->state != -1) { gtk_icon_source_set_state (icon_source, source_data->state); gtk_icon_source_set_state_wildcarded (icon_source, FALSE); } /* Inline source_add() to avoid creating a copy */ g_assert (icon_source->type != GTK_ICON_SOURCE_EMPTY); icon_set->sources = g_slist_insert_sorted (icon_set->sources, icon_source, icon_source_compare); g_free (source_data->stock_id); g_free (source_data->filename); g_free (source_data->icon_name); g_slice_free (IconSourceParserData, source_data); } g_slist_free (parser_data->sources); g_slice_free (IconFactoryParserData, parser_data); /* TODO: Add an attribute/tag to prevent this. * Usually it's the right thing to do though. */ gtk_icon_factory_add_default (icon_factory); } }