* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
-#include "gtkiconfactory.h"
-#include "stock-icons/gtkstockpixbufs.h"
-#include "gtkstock.h"
-#include "gtkintl.h"
+#include <config.h>
#include <stdlib.h>
#include <errno.h>
-#include <ctype.h>
#include <string.h>
+#include <pango/pango-utils.h> /* For pango_scan_* */
+#include "gtkiconfactory.h"
+#include "gtkiconcache.h"
+#include "gtkdebug.h"
+#include "gtkicontheme.h"
+#include "gtksettings.h"
+#include "gtkstock.h"
+#include "gtkwidget.h"
+#include "gtkintl.h"
+#include "gtkalias.h"
+
+
+static GSList *all_icon_factories = NULL;
+
+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;
+
+#ifdef G_OS_WIN32
+ /* System codepage version of filename, for DLL ABI backward
+ * compatibility functions.
+ */
+ gchar *cp_filename;
+#endif
+};
-static gpointer parent_class = NULL;
-static void gtk_icon_factory_init (GtkIconFactory *icon_factory);
-static void gtk_icon_factory_class_init (GtkIconFactoryClass *klass);
static void gtk_icon_factory_finalize (GObject *object);
static void get_default_icons (GtkIconFactory *icon_factory);
+static void icon_source_clear (GtkIconSource *source);
-GType
-gtk_icon_factory_get_type (void)
-{
- static GType object_type = 0;
+static GtkIconSize icon_size_register_intern (const gchar *name,
+ gint width,
+ gint height);
- if (!object_type)
- {
- static const GTypeInfo object_info =
- {
- sizeof (GtkIconFactoryClass),
- (GBaseInitFunc) NULL,
- (GBaseFinalizeFunc) NULL,
- (GClassInitFunc) gtk_icon_factory_class_init,
- NULL, /* class_finalize */
- NULL, /* class_data */
- sizeof (GtkIconFactory),
- 0, /* n_preallocs */
- (GInstanceInitFunc) gtk_icon_factory_init,
- };
-
- object_type = g_type_register_static (G_TYPE_OBJECT,
- "GtkIconFactory",
- &object_info, 0);
- }
-
- return object_type;
-}
+#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 (GtkIconFactory, gtk_icon_factory, G_TYPE_OBJECT)
static void
gtk_icon_factory_init (GtkIconFactory *factory)
{
factory->icons = g_hash_table_new (g_str_hash, g_str_equal);
+ all_icon_factories = g_slist_prepend (all_icon_factories, factory);
}
static void
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
- parent_class = g_type_class_peek_parent (klass);
-
object_class->finalize = gtk_icon_factory_finalize;
}
{
GtkIconFactory *factory = GTK_ICON_FACTORY (object);
+ all_icon_factories = g_slist_remove (all_icon_factories, factory);
+
g_hash_table_foreach (factory->icons, free_icon_set, NULL);
g_hash_table_destroy (factory->icons);
- G_OBJECT_CLASS (parent_class)->finalize (object);
+ 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 #GtkIconSet<!-- -->s; 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<!-- -->s 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.
+ *
+ * Return value: a new #GtkIconFactory
+ **/
GtkIconFactory*
gtk_icon_factory_new (void)
{
- return GTK_ICON_FACTORY (g_object_new (GTK_TYPE_ICON_FACTORY, NULL));
+ 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.
+ *
+ **/
void
gtk_icon_factory_add (GtkIconFactory *factory,
const gchar *stock_id,
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.
+ *
+ * Return value: icon set of @stock_id.
+ **/
GtkIconSet *
gtk_icon_factory_lookup (GtkIconFactory *factory,
const gchar *stock_id)
static GtkIconFactory *gtk_default_icons = NULL;
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.
+ *
+ **/
void
gtk_icon_factory_add_default (GtkIconFactory *factory)
{
g_return_if_fail (GTK_IS_ICON_FACTORY (factory));
- g_object_ref (G_OBJECT (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.
+ *
+ **/
void
gtk_icon_factory_remove_default (GtkIconFactory *factory)
{
default_factories = g_slist_remove (default_factories, factory);
- g_object_unref (G_OBJECT (factory));
+ g_object_unref (factory);
+}
+
+void
+_gtk_icon_factory_ensure_default_icons (void)
+{
+ if (gtk_default_icons == NULL)
+ {
+ gtk_default_icons = gtk_icon_factory_new ();
+
+ get_default_icons (gtk_default_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.
+ *
+ *
+ * Return value: a #GtkIconSet, or %NULL
+ **/
GtkIconSet *
gtk_icon_factory_lookup_default (const gchar *stock_id)
{
if (icon_set)
return icon_set;
-
+
tmp_list = g_slist_next (tmp_list);
}
- if (gtk_default_icons == NULL)
- {
- gtk_default_icons = gtk_icon_factory_new ();
-
- get_default_icons (gtk_default_icons);
- }
+ _gtk_icon_factory_ensure_default_icons ();
return gtk_icon_factory_lookup (gtk_default_icons, stock_id);
}
-static GtkIconSet *
-sized_icon_set_from_inline (const guchar *inline_data,
- const gchar *size)
-{
- GtkIconSet *set;
-
- GtkIconSource source = { NULL, NULL, 0, 0, NULL,
- TRUE, TRUE, FALSE };
-
- source.size = (gchar*) size;
-
- set = gtk_icon_set_new ();
-
- source.pixbuf = gdk_pixbuf_new_from_inline (inline_data, FALSE, -1, NULL);
-
- g_assert (source.pixbuf);
-
- gtk_icon_set_add_source (set, &source);
-
- g_object_unref (G_OBJECT (source.pixbuf));
-
- return set;
-}
-
-static GtkIconSet *
-unsized_icon_set_from_inline (const guchar *inline_data)
+static void
+register_stock_icon (GtkIconFactory *factory,
+ const gchar *stock_id)
{
- GtkIconSet *set;
-
- /* This icon can be used for any direction/state/size */
- GtkIconSource source = { NULL, NULL, 0, 0, 0,
- TRUE, TRUE, TRUE };
-
- set = gtk_icon_set_new ();
-
- source.pixbuf = gdk_pixbuf_new_from_inline (inline_data, FALSE, -1, NULL);
-
- g_assert (source.pixbuf);
+ 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 *)stock_id;
gtk_icon_set_add_source (set, &source);
-
- g_object_unref (G_OBJECT (source.pixbuf));
-
- return set;
-}
-
-static void
-add_sized (GtkIconFactory *factory,
- const guchar *inline_data,
- const gchar *size,
- const gchar *stock_id)
-{
- GtkIconSet *set;
-
- set = sized_icon_set_from_inline (inline_data, size);
gtk_icon_factory_add (factory, stock_id, set);
-
gtk_icon_set_unref (set);
}
static void
-add_unsized (GtkIconFactory *factory,
- const guchar *inline_data,
- const gchar *stock_id)
+register_bidi_stock_icon (GtkIconFactory *factory,
+ const gchar *stock_id,
+ const gchar *stock_id_ltr,
+ const gchar *stock_id_rtl)
{
- GtkIconSet *set;
+ 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 *)stock_id_ltr;
+ source.direction = GTK_TEXT_DIR_LTR;
+ gtk_icon_set_add_source (set, &source);
- set = unsized_icon_set_from_inline (inline_data);
+ source.type = GTK_ICON_SOURCE_STATIC_ICON_NAME;
+ source.source.icon_name = (gchar *)stock_id_rtl;
+ 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);
}
{
/* KEEP IN SYNC with gtkstock.c */
- add_sized (factory, dialog_error, GTK_ICON_SIZE_DIALOG, GTK_STOCK_DIALOG_ERROR);
- add_sized (factory, dialog_info, GTK_ICON_SIZE_DIALOG, GTK_STOCK_DIALOG_INFO);
- add_sized (factory, dialog_question, GTK_ICON_SIZE_DIALOG, GTK_STOCK_DIALOG_QUESTION);
- add_sized (factory, dialog_warning, GTK_ICON_SIZE_DIALOG, GTK_STOCK_DIALOG_WARNING);
-
- add_sized (factory, stock_button_apply, GTK_ICON_SIZE_BUTTON, GTK_STOCK_BUTTON_APPLY);
- add_sized (factory, stock_button_ok, GTK_ICON_SIZE_BUTTON, GTK_STOCK_BUTTON_OK);
- add_sized (factory, stock_button_cancel, GTK_ICON_SIZE_BUTTON, GTK_STOCK_BUTTON_CANCEL);
- add_sized (factory, stock_button_close, GTK_ICON_SIZE_BUTTON, GTK_STOCK_BUTTON_CLOSE);
- add_sized (factory, stock_button_yes, GTK_ICON_SIZE_BUTTON, GTK_STOCK_BUTTON_YES);
- add_sized (factory, stock_button_no, GTK_ICON_SIZE_BUTTON, GTK_STOCK_BUTTON_NO);
-
- add_unsized (factory, stock_close, GTK_STOCK_CLOSE);
- add_unsized (factory, stock_exit, GTK_STOCK_QUIT);
- add_unsized (factory, stock_help, GTK_STOCK_HELP);
- add_unsized (factory, stock_new, GTK_STOCK_NEW);
- add_unsized (factory, stock_open, GTK_STOCK_OPEN);
- add_unsized (factory, stock_save, GTK_STOCK_SAVE);
+ register_stock_icon (factory, GTK_STOCK_DIALOG_AUTHENTICATION);
+ register_stock_icon (factory, GTK_STOCK_DIALOG_ERROR);
+ register_stock_icon (factory, GTK_STOCK_DIALOG_INFO);
+ register_stock_icon (factory, GTK_STOCK_DIALOG_QUESTION);
+ register_stock_icon (factory, GTK_STOCK_DIALOG_WARNING);
+ register_stock_icon (factory, GTK_STOCK_DND);
+ register_stock_icon (factory, GTK_STOCK_DND_MULTIPLE);
+ register_stock_icon (factory, GTK_STOCK_APPLY);
+ register_stock_icon (factory, GTK_STOCK_CANCEL);
+ register_stock_icon (factory, GTK_STOCK_NO);
+ register_stock_icon (factory, GTK_STOCK_OK);
+ register_stock_icon (factory, GTK_STOCK_YES);
+ register_stock_icon (factory, GTK_STOCK_CLOSE);
+ register_stock_icon (factory, GTK_STOCK_ADD);
+ register_stock_icon (factory, GTK_STOCK_JUSTIFY_CENTER);
+ register_stock_icon (factory, GTK_STOCK_JUSTIFY_FILL);
+ register_stock_icon (factory, GTK_STOCK_JUSTIFY_LEFT);
+ register_stock_icon (factory, GTK_STOCK_JUSTIFY_RIGHT);
+ register_stock_icon (factory, GTK_STOCK_GOTO_BOTTOM);
+ register_stock_icon (factory, GTK_STOCK_CDROM);
+ register_stock_icon (factory, GTK_STOCK_CONVERT);
+ register_stock_icon (factory, GTK_STOCK_COPY);
+ register_stock_icon (factory, GTK_STOCK_CUT);
+ register_stock_icon (factory, GTK_STOCK_GO_DOWN);
+ register_stock_icon (factory, GTK_STOCK_EXECUTE);
+ register_stock_icon (factory, GTK_STOCK_QUIT);
+ register_bidi_stock_icon (factory,
+ GTK_STOCK_GOTO_FIRST,
+ GTK_STOCK_GOTO_FIRST "-ltr",
+ GTK_STOCK_GOTO_FIRST "-rtl");
+ register_stock_icon (factory, GTK_STOCK_SELECT_FONT);
+ register_stock_icon (factory, GTK_STOCK_FULLSCREEN);
+ register_stock_icon (factory, GTK_STOCK_LEAVE_FULLSCREEN);
+ register_stock_icon (factory, GTK_STOCK_HARDDISK);
+ register_stock_icon (factory, GTK_STOCK_HELP);
+ register_stock_icon (factory, GTK_STOCK_HOME);
+ register_stock_icon (factory, GTK_STOCK_INFO);
+ register_bidi_stock_icon (factory,
+ GTK_STOCK_JUMP_TO,
+ GTK_STOCK_JUMP_TO "-ltr",
+ GTK_STOCK_JUMP_TO "-rtl");
+ register_bidi_stock_icon (factory,
+ GTK_STOCK_GOTO_LAST,
+ GTK_STOCK_GOTO_LAST "-ltr",
+ GTK_STOCK_GOTO_LAST "-rtl");
+ register_bidi_stock_icon (factory,
+ GTK_STOCK_GO_BACK,
+ GTK_STOCK_GO_BACK "-ltr",
+ GTK_STOCK_GO_BACK "-rtl");
+ register_stock_icon (factory, GTK_STOCK_MISSING_IMAGE);
+ register_stock_icon (factory, GTK_STOCK_NETWORK);
+ register_stock_icon (factory, GTK_STOCK_NEW);
+ register_stock_icon (factory, GTK_STOCK_OPEN);
+ register_stock_icon (factory, GTK_STOCK_ORIENTATION_PORTRAIT);
+ register_stock_icon (factory, GTK_STOCK_ORIENTATION_LANDSCAPE);
+ register_stock_icon (factory, GTK_STOCK_ORIENTATION_REVERSE_PORTRAIT);
+ register_stock_icon (factory, GTK_STOCK_ORIENTATION_REVERSE_LANDSCAPE);
+ register_stock_icon (factory, GTK_STOCK_PASTE);
+ register_stock_icon (factory, GTK_STOCK_PREFERENCES);
+ register_stock_icon (factory, GTK_STOCK_PRINT);
+ register_stock_icon (factory, GTK_STOCK_PRINT_PREVIEW);
+ register_stock_icon (factory, GTK_STOCK_PROPERTIES);
+ register_bidi_stock_icon (factory,
+ GTK_STOCK_REDO,
+ GTK_STOCK_REDO "-ltr",
+ GTK_STOCK_REDO "-rtl");
+ register_stock_icon (factory, GTK_STOCK_REMOVE);
+ register_stock_icon (factory, GTK_STOCK_REFRESH);
+ register_bidi_stock_icon (factory,
+ GTK_STOCK_REVERT_TO_SAVED,
+ GTK_STOCK_REVERT_TO_SAVED "-ltr",
+ GTK_STOCK_REVERT_TO_SAVED "-rtl");
+ register_bidi_stock_icon (factory,
+ GTK_STOCK_GO_FORWARD,
+ GTK_STOCK_GO_FORWARD "-ltr",
+ GTK_STOCK_GO_FORWARD "-rtl");
+ register_stock_icon (factory, GTK_STOCK_SAVE);
+ register_stock_icon (factory, GTK_STOCK_FLOPPY);
+ register_stock_icon (factory, GTK_STOCK_SAVE_AS);
+ register_stock_icon (factory, GTK_STOCK_FIND);
+ register_stock_icon (factory, GTK_STOCK_FIND_AND_REPLACE);
+ register_stock_icon (factory, GTK_STOCK_SORT_DESCENDING);
+ register_stock_icon (factory, GTK_STOCK_SORT_ASCENDING);
+ register_stock_icon (factory, GTK_STOCK_SPELL_CHECK);
+ register_stock_icon (factory, GTK_STOCK_STOP);
+ register_stock_icon (factory, GTK_STOCK_BOLD);
+ register_stock_icon (factory, GTK_STOCK_ITALIC);
+ register_stock_icon (factory, GTK_STOCK_STRIKETHROUGH);
+ register_stock_icon (factory, GTK_STOCK_UNDERLINE);
+ register_bidi_stock_icon (factory,
+ GTK_STOCK_INDENT,
+ GTK_STOCK_INDENT "-ltr",
+ GTK_STOCK_INDENT "-rtl");
+ register_bidi_stock_icon (factory,
+ GTK_STOCK_UNINDENT,
+ GTK_STOCK_UNINDENT "-ltr",
+ GTK_STOCK_UNINDENT "-rtl");
+ register_stock_icon (factory, GTK_STOCK_GOTO_TOP);
+ register_stock_icon (factory, GTK_STOCK_DELETE);
+ register_bidi_stock_icon (factory,
+ GTK_STOCK_UNDELETE,
+ GTK_STOCK_UNDELETE "-ltr",
+ GTK_STOCK_UNDELETE "-rtl");
+ register_bidi_stock_icon (factory,
+ GTK_STOCK_UNDO,
+ GTK_STOCK_UNDO "-ltr",
+ GTK_STOCK_UNDO "-rtl");
+ register_stock_icon (factory, GTK_STOCK_GO_UP);
+ register_stock_icon (factory, GTK_STOCK_FILE);
+ register_stock_icon (factory, GTK_STOCK_DIRECTORY);
+ register_stock_icon (factory, GTK_STOCK_ABOUT);
+ register_stock_icon (factory, GTK_STOCK_CONNECT);
+ register_stock_icon (factory, GTK_STOCK_DISCONNECT);
+ register_stock_icon (factory, GTK_STOCK_EDIT);
+ register_bidi_stock_icon (factory,
+ GTK_STOCK_MEDIA_FORWARD,
+ GTK_STOCK_MEDIA_FORWARD "-ltr",
+ GTK_STOCK_MEDIA_FORWARD "-rtl");
+ register_bidi_stock_icon (factory,
+ GTK_STOCK_MEDIA_NEXT,
+ GTK_STOCK_MEDIA_NEXT "-ltr",
+ GTK_STOCK_MEDIA_NEXT "-rtl");
+ register_stock_icon (factory, GTK_STOCK_MEDIA_PAUSE);
+ register_bidi_stock_icon (factory,
+ GTK_STOCK_MEDIA_PLAY,
+ GTK_STOCK_MEDIA_PLAY "-ltr",
+ GTK_STOCK_MEDIA_PLAY "-rtl");
+ register_bidi_stock_icon (factory,
+ GTK_STOCK_MEDIA_PREVIOUS,
+ GTK_STOCK_MEDIA_PREVIOUS "-ltr",
+ GTK_STOCK_MEDIA_PREVIOUS "-rtl");
+ register_stock_icon (factory, GTK_STOCK_MEDIA_RECORD);
+ register_bidi_stock_icon (factory,
+ GTK_STOCK_MEDIA_REWIND,
+ GTK_STOCK_MEDIA_REWIND "-ltr",
+ GTK_STOCK_MEDIA_REWIND "-rtl");
+ register_stock_icon (factory, GTK_STOCK_MEDIA_STOP);
+ register_stock_icon (factory, GTK_STOCK_INDEX);
+ register_stock_icon (factory, GTK_STOCK_ZOOM_100);
+ register_stock_icon (factory, GTK_STOCK_ZOOM_IN);
+ register_stock_icon (factory, GTK_STOCK_ZOOM_OUT);
+ register_stock_icon (factory, GTK_STOCK_ZOOM_FIT);
+ register_stock_icon (factory, GTK_STOCK_SELECT_ALL);
+ register_stock_icon (factory, GTK_STOCK_CLEAR);
+ register_stock_icon (factory, GTK_STOCK_SELECT_COLOR);
+ register_stock_icon (factory, GTK_STOCK_COLOR_PICKER);
}
-/* Sizes */
-
-static GHashTable *icon_sizes = NULL;
+/************************************************************
+ * Icon size handling *
+ ************************************************************/
typedef struct _IconSize IconSize;
struct _IconSize
{
+ gint size;
gchar *name;
- gboolean is_alias;
-
- union
- {
- gchar *target;
- struct
- {
- gint width;
- gint height;
- } size;
- } d;
+ gint width;
+ gint height;
};
-static IconSize*
-icon_size_new (const gchar *name)
+typedef struct _IconAlias IconAlias;
+
+struct _IconAlias
{
- IconSize *is;
+ gchar *name;
+ gint target;
+};
- is = g_new0 (IconSize, 1);
+typedef struct _SettingsIconSize SettingsIconSize;
- is->name = g_strdup (name);
+struct _SettingsIconSize
+{
+ gint width;
+ gint height;
+};
- return is;
-}
+static GHashTable *icon_aliases = NULL;
+static IconSize *icon_sizes = NULL;
+static gint icon_sizes_allocated = 0;
+static gint icon_sizes_used = 0;
static void
-icon_size_free (IconSize *is)
+init_icon_sizes (void)
{
- g_free (is->name);
-
- if (is->is_alias)
- g_free (is->d.target);
+ if (icon_sizes == NULL)
+ {
+#define NUM_BUILTIN_SIZES 7
+ gint i;
- g_free (is);
+ 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 = 20;
+ icon_sizes[GTK_ICON_SIZE_BUTTON].height = 20;
+
+ 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 = 18;
+ icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].height = 18;
+
+ 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 void
-icon_size_insert (IconSize *is)
+free_settings_sizes (gpointer data)
+{
+ g_array_free (data, TRUE);
+}
+
+static GArray *
+get_settings_sizes (GtkSettings *settings,
+ gboolean *created)
{
- gpointer old_key, old_value;
+ GArray *settings_sizes;
+ static GQuark sizes_quark = 0;
- /* Remove old ones */
- if (g_hash_table_lookup_extended (icon_sizes,
- is->name,
- &old_key, &old_value))
+ if (!sizes_quark)
+ sizes_quark = g_quark_from_static_string ("gtk-icon-sizes");
+
+ settings_sizes = g_object_get_qdata (G_OBJECT (settings), sizes_quark);
+ if (!settings_sizes)
{
- g_hash_table_remove (icon_sizes, is->name);
- icon_size_free (old_value);
+ settings_sizes = g_array_new (FALSE, FALSE, sizeof (SettingsIconSize));
+ g_object_set_qdata_full (G_OBJECT (settings), sizes_quark,
+ settings_sizes, free_settings_sizes);
+ if (created)
+ *created = TRUE;
}
-
- g_hash_table_insert (icon_sizes,
- is->name, is);
+ return settings_sizes;
}
-static IconSize*
-icon_size_lookup (const gchar *name)
+static void
+icon_size_set_for_settings (GtkSettings *settings,
+ const gchar *size_name,
+ gint width,
+ gint height)
{
- IconSize *is;
+ GtkIconSize size;
+ GArray *settings_sizes;
+ SettingsIconSize *settings_size;
- is = g_hash_table_lookup (icon_sizes,
- name);
+ g_return_if_fail (size_name != NULL);
- while (is && is->is_alias)
+ size = gtk_icon_size_from_name (size_name);
+ if (size == GTK_ICON_SIZE_INVALID)
+ /* Reserve a place */
+ size = icon_size_register_intern (size_name, -1, -1);
+
+ settings_sizes = get_settings_sizes (settings, NULL);
+ if (size >= settings_sizes->len)
{
- is = g_hash_table_lookup (icon_sizes,
- is->d.target);
+ SettingsIconSize unset = { -1, -1 };
+ gint i;
+ for (i = settings_sizes->len; i <= size; i++)
+ g_array_append_val (settings_sizes, unset);
}
- return is;
+ settings_size = &g_array_index (settings_sizes, SettingsIconSize, size);
+
+ settings_size->width = width;
+ settings_size->height = height;
}
-static void
-icon_size_add (const gchar *name,
- gint width,
- gint height)
+/* Like pango_parse_word, but accept - as well
+ */
+static gboolean
+scan_icon_size_name (const char **pos, GString *out)
{
- IconSize *is;
-
- is = icon_size_new (name);
- is->d.size.width = width;
- is->d.size.height = height;
+ const char *p = *pos;
+
+ while (g_ascii_isspace (*p))
+ p++;
- icon_size_insert (is);
+ if (!((*p >= 'A' && *p <= 'Z') ||
+ (*p >= 'a' && *p <= 'z') ||
+ *p == '_' || *p == '-'))
+ return FALSE;
+
+ g_string_truncate (out, 0);
+ g_string_append_c (out, *p);
+ p++;
+
+ while ((*p >= 'A' && *p <= 'Z') ||
+ (*p >= 'a' && *p <= 'z') ||
+ (*p >= '0' && *p <= '9') ||
+ *p == '_' || *p == '-')
+ {
+ g_string_append_c (out, *p);
+ p++;
+ }
+
+ *pos = p;
+
+ return TRUE;
}
static void
-icon_alias_add (const gchar *name,
- const gchar *target)
+icon_size_setting_parse (GtkSettings *settings,
+ const gchar *icon_size_string)
{
- IconSize *is;
-
- is = icon_size_new (name);
- is->is_alias = TRUE;
+ GString *name_buf = g_string_new (NULL);
+ const gchar *p = icon_size_string;
+
+ while (pango_skip_space (&p))
+ {
+ gint width, height;
+
+ if (!scan_icon_size_name (&p, name_buf))
+ goto err;
+
+ if (!pango_skip_space (&p))
+ goto err;
+
+ if (*p != '=')
+ goto err;
+
+ p++;
+
+ if (!pango_scan_int (&p, &width))
+ goto err;
+
+ if (!pango_skip_space (&p))
+ goto err;
+
+ if (*p != ',')
+ goto err;
- is->d.target = g_strdup (target);
+ p++;
- icon_size_insert (is);
+ if (!pango_scan_int (&p, &height))
+ goto err;
+
+ if (width > 0 && height > 0)
+ {
+ icon_size_set_for_settings (settings, name_buf->str,
+ width, height);
+ }
+ else
+ {
+ g_warning ("Invalid size in gtk-icon-sizes: %d,%d\n", width, height);
+ }
+
+ pango_skip_space (&p);
+ if (*p == '\0')
+ break;
+ if (*p == ':')
+ p++;
+ else
+ goto err;
+ }
+
+ g_string_free (name_buf, TRUE);
+ return;
+
+ err:
+ g_warning ("Error parsing gtk-icon-sizes string:\n\t'%s'", icon_size_string);
+ g_string_free (name_buf, TRUE);
}
static void
-init_icon_sizes (void)
+icon_size_set_all_from_settings (GtkSettings *settings)
{
- if (icon_sizes == NULL)
- {
- icon_sizes = g_hash_table_new (g_str_hash, g_str_equal);
+ GArray *settings_sizes;
+ gchar *icon_size_string;
+
+ /* Reset old settings */
+ settings_sizes = get_settings_sizes (settings, NULL);
+ g_array_set_size (settings_sizes, 0);
- icon_size_add (GTK_ICON_SIZE_MENU, 16, 16);
- icon_size_add (GTK_ICON_SIZE_BUTTON, 24, 24);
- icon_size_add (GTK_ICON_SIZE_SMALL_TOOLBAR, 18, 18);
- icon_size_add (GTK_ICON_SIZE_LARGE_TOOLBAR, 24, 24);
- icon_size_add (GTK_ICON_SIZE_DIALOG, 48, 48);
+ g_object_get (settings,
+ "gtk-icon-sizes", &icon_size_string,
+ NULL);
+
+ if (icon_size_string)
+ {
+ icon_size_setting_parse (settings, icon_size_string);
+ g_free (icon_size_string);
}
}
-gboolean
-gtk_icon_size_lookup (const gchar *alias,
- gint *widthp,
- gint *heightp)
+static void
+icon_size_settings_changed (GtkSettings *settings,
+ GParamSpec *pspec)
{
- IconSize *is;
+ icon_size_set_all_from_settings (settings);
+
+ gtk_rc_reset_styles (settings);
+}
+
+static void
+icon_sizes_init_for_settings (GtkSettings *settings)
+{
+ g_signal_connect (settings,
+ "notify::gtk-icon-sizes",
+ G_CALLBACK (icon_size_settings_changed),
+ NULL);
- g_return_val_if_fail (alias != NULL, FALSE);
+ icon_size_set_all_from_settings (settings);
+}
+
+static gboolean
+icon_size_lookup_intern (GtkSettings *settings,
+ GtkIconSize size,
+ gint *widthp,
+ gint *heightp)
+{
+ GArray *settings_sizes;
+ gint width_for_settings = -1;
+ gint height_for_settings = -1;
init_icon_sizes ();
-
- is = icon_size_lookup (alias);
- if (is == NULL)
+ if (size >= icon_sizes_used)
+ return FALSE;
+
+ if (size == GTK_ICON_SIZE_INVALID)
return FALSE;
+ if (settings)
+ {
+ gboolean initial = FALSE;
+
+ settings_sizes = get_settings_sizes (settings, &initial);
+ if (initial)
+ icon_sizes_init_for_settings (settings);
+
+ if (size < settings_sizes->len)
+ {
+ SettingsIconSize *settings_size;
+
+ settings_size = &g_array_index (settings_sizes, SettingsIconSize, size);
+
+ width_for_settings = settings_size->width;
+ height_for_settings = settings_size->height;
+ }
+ }
+
if (widthp)
- *widthp = is->d.size.width;
+ *widthp = width_for_settings >= 0 ? width_for_settings : icon_sizes[size].width;
if (heightp)
- *heightp = is->d.size.height;
+ *heightp = height_for_settings >= 0 ? height_for_settings : icon_sizes[size].height;
return TRUE;
}
-void
-gtk_icon_size_register (const gchar *alias,
- gint width,
- gint height)
+/**
+ * gtk_icon_size_lookup_for_settings:
+ * @settings: a #GtkSettings object, used to determine
+ * which set of user preferences to used.
+ * @size: an icon size
+ * @width: location to store icon width
+ * @height: 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() 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.
+ *
+ * Return value: %TRUE if @size was a valid size
+ *
+ * Since: 2.2
+ **/
+gboolean
+gtk_icon_size_lookup_for_settings (GtkSettings *settings,
+ GtkIconSize size,
+ gint *width,
+ gint *height)
{
- g_return_if_fail (alias != NULL);
- g_return_if_fail (width > 0);
- g_return_if_fail (height > 0);
+ g_return_val_if_fail (GTK_IS_SETTINGS (settings), FALSE);
+
+ return icon_size_lookup_intern (settings, size, width, height);
+}
+
+/**
+ * gtk_icon_size_lookup:
+ * @size: an icon size
+ * @width: location to store icon width
+ * @height: location to store icon height
+ *
+ * Obtains the pixel size of a semantic icon size, possibly
+ * modified by user preferences for the default #GtkSettings.
+ * (See gtk_icon_size_lookup_for_settings().)
+ * Normally @size would be
+ * #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc. This function
+ * isn't normally needed, gtk_widget_render_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.
+ *
+ * Return value: %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 gtk_icon_size_lookup_for_settings (gtk_settings_get_default (),
+ size, widthp, heightp);
+}
+
+static GtkIconSize
+icon_size_register_intern (const gchar *name,
+ gint width,
+ gint height)
+{
+ IconAlias *old_alias;
+ GtkIconSize size;
init_icon_sizes ();
- icon_size_add (alias, width, height);
+ 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: integer value representing the size
+ *
+ **/
+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: 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.
+ *
+ **/
void
gtk_icon_size_register_alias (const gchar *alias,
- const gchar *target)
+ GtkIconSize target)
{
+ IconAlias *ia;
+
g_return_if_fail (alias != NULL);
- g_return_if_fail (target != NULL);
init_icon_sizes ();
- icon_alias_add (alias, target);
+ if (!icon_size_lookup_intern (NULL, 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.
+ * @returns: the icon size with the given name.
+ *
+ * Looks up the icon size associated with @name.
+ **/
+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: a #GtkIconSize.
+ * @returns: the name of the given icon size.
+ *
+ * Gets the canonical name of the given icon size. The returned string
+ * is statically allocated and should not be freed.
+ **/
+G_CONST_RETURN gchar*
+gtk_icon_size_get_name (GtkIconSize size)
+{
+ if (size >= icon_sizes_used)
+ return NULL;
+ else
+ return icon_sizes[size].name;
}
+/************************************************************/
+
/* Icon Set */
-/* Clear icon set contents, drop references to all contained
- * GdkPixbuf objects and forget all GtkIconSources. Used to
- * recycle an icon set.
- */
static GdkPixbuf *find_in_cache (GtkIconSet *icon_set,
GtkStyle *style,
GtkTextDirection direction,
GtkStateType state,
- const gchar *size);
+ GtkIconSize size);
static void add_to_cache (GtkIconSet *icon_set,
GtkStyle *style,
GtkTextDirection direction,
GtkStateType state,
- const gchar *size,
+ GtkIconSize size,
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,
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() 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.
+ *
+ * Return value: a new #GtkIconSet
+ **/
GtkIconSet*
gtk_icon_set_new (void)
{
return icon_set;
}
-GtkIconSet*
-gtk_icon_set_ref (GtkIconSet *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.
+ *
+ * Return value: a new #GtkIconSet
+ **/
+GtkIconSet *
+gtk_icon_set_new_from_pixbuf (GdkPixbuf *pixbuf)
{
- g_return_val_if_fail (icon_set != NULL, NULL);
- g_return_val_if_fail (icon_set->ref_count > 0, NULL);
+ 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.
+ *
+ * Return value: @icon_set.
+ **/
+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.
+ **/
void
gtk_icon_set_unref (GtkIconSet *icon_set)
{
tmp_list = g_slist_next (tmp_list);
}
+ g_slist_free (icon_set->sources);
clear_cache (icon_set, TRUE);
}
}
-GtkIconSet*
-gtk_icon_set_copy (GtkIconSet *icon_set)
+GType
+gtk_icon_set_get_type (void)
+{
+ static GType our_type = 0;
+
+ if (our_type == 0)
+ our_type = g_boxed_type_register_static (I_("GtkIconSet"),
+ (GBoxedCopyFunc) gtk_icon_set_ref,
+ (GBoxedFreeFunc) gtk_icon_set_unref);
+
+ return our_type;
+}
+
+/**
+ * gtk_icon_set_copy:
+ * @icon_set: a #GtkIconSet
+ *
+ * Copies @icon_set by value.
+ *
+ * Return value: a new #GtkIconSet identical to the first.
+ **/
+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 (NULL, rhs, &r_w, &r_h);
+ icon_size_lookup_intern (NULL, 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 || (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,
+ GtkStyle *style,
+ GtkTextDirection direction,
+ GtkStateType state,
+ GtkIconSize size,
+ GtkWidget *widget,
+ const char *detail)
+{
+ 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;
+
+ if (widget && gtk_widget_has_screen (widget))
+ screen = gtk_widget_get_screen (widget);
+ else if (style && style->colormap)
+ screen = gdk_colormap_get_screen (style->colormap);
+ else
+ {
+ screen = gdk_screen_get_default ();
+ GTK_NOTE (MULTIHEAD,
+ g_warning ("Using the default screen for gtk_icon_source_render_icon()"));
+ }
+
+ 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 == -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);
+
+ tmp_pixbuf = gtk_icon_theme_load_icon (icon_theme,
+ icon_source->source.icon_name,
+ pixel_size, 0,
+ &error);
+
+ if (!tmp_pixbuf)
+ {
+ g_warning ("Error loading theme icon for stock: %s", error->message);
+ 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_style_render_icon (style, &tmp_source,
+ direction, state, -1,
+ widget, detail);
+
+ 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,
+ GtkStyle *style,
+ GtkTextDirection direction,
+ GtkStateType state,
+ GtkIconSize size,
+ GtkWidget *widget,
+ const char *detail)
+{
+ 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_style_render_icon (style, source,
+ direction, state, size,
+ widget, detail);
+ if (!pixbuf)
+ {
+ g_warning ("Failed to render icon");
+ failed = g_slist_prepend (failed, source);
+ }
+ break;
+ case GTK_ICON_SOURCE_ICON_NAME:
+ case GTK_ICON_SOURCE_STATIC_ICON_NAME:
+ pixbuf = render_icon_name_pixbuf (source, style,
+ direction, state, size,
+ widget, detail);
+ 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 (GtkStyle *style,
+ GtkTextDirection direction,
+ GtkStateType state,
+ GtkIconSize size,
+ GtkWidget *widget,
+ const char *detail)
+{
+ /* 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)
+ {
+ GdkPixbuf *pixbuf;
+
+ _gtk_icon_theme_ensure_builtin_cache ();
+
+ pixbuf = _gtk_icon_cache_get_icon (_builtin_cache,
+ GTK_STOCK_MISSING_IMAGE,
+ "24");
+ gtk_icon_source_set_pixbuf (&fallback_source, pixbuf);
+ g_object_unref (pixbuf);
+ }
+
+ return gtk_style_render_icon (style,
+ &fallback_source,
+ direction,
+ state,
+ size,
+ widget,
+ detail);
+}
+
+/**
+ * gtk_icon_set_render_icon:
+ * @icon_set: a #GtkIconSet
+ * @style: a #GtkStyle associated with @widget, or %NULL
+ * @direction: text direction
+ * @state: widget state
+ * @size: icon size. A size of (GtkIconSize)-1
+ * means render at the size of the source and don't scale.
+ * @widget: widget that will display the icon, or %NULL.
+ * The only use that is typically made of this
+ * is to determine the appropriate #GdkScreen.
+ * @detail: 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.
+ *
+ * Return value: a #GdkPixbuf to be displayed
+ **/
+GdkPixbuf*
+gtk_icon_set_render_icon (GtkIconSet *icon_set,
+ GtkStyle *style,
+ GtkTextDirection direction,
+ GtkStateType state,
+ GtkIconSize size,
+ GtkWidget *widget,
+ const char *detail)
+{
+ GdkPixbuf *icon;
+
+ g_return_val_if_fail (icon_set != NULL, NULL);
+ g_return_val_if_fail (style == NULL || GTK_IS_STYLE (style), NULL);
+
+ if (icon_set->sources == NULL)
+ return render_fallback_image (style, direction, state, size, widget, detail);
+
+ if (detail == NULL)
+ {
+ icon = find_in_cache (icon_set, style, direction,
+ state, size);
+
+ if (icon)
+ {
+ g_object_ref (icon);
+ return icon;
+ }
+ }
+
+
+ icon = find_and_render_icon_source (icon_set, style, direction, state, size,
+ widget, detail);
+
+ if (icon == NULL)
+ icon = render_fallback_image (style, direction, state, size, widget, detail);
+
+ if (detail == NULL)
+ add_to_cache (icon_set, style, direction, state, size, icon);
+
+ 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.
+ *
+ **/
+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: 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().
+ *
+ **/
+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.
+ *
+ * Return value: a new #GtkIconSource
+ **/
+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.
+ *
+ * Return value: a new #GtkIconSource
+ **/
+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);
+#ifdef G_OS_WIN32
+ copy->cp_filename = g_strdup (copy->cp_filename);
+#endif
+ 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.
+ **/
+void
+gtk_icon_source_free (GtkIconSource *source)
+{
+ g_return_if_fail (source != NULL);
+
+ icon_source_clear (source);
+ g_free (source);
+}
+
+GType
+gtk_icon_source_get_type (void)
+{
+ static GType our_type = 0;
+
+ if (our_type == 0)
+ our_type = g_boxed_type_register_static ("GtkIconSource",
+ (GBoxedCopyFunc) gtk_icon_source_copy,
+ (GBoxedFreeFunc) gtk_icon_source_free);
+
+ return our_type;
+}
+
+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;
+#ifdef G_OS_WIN32
+ g_free (source->cp_filename);
+ source->cp_filename = NULL;
+#endif
+ 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: 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.
+ **/
+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);
+#ifdef G_OS_WIN32
+ source->cp_filename = g_locale_from_utf8 (filename, -1, NULL, NULL, NULL);
+#endif
+ }
+}
+
+/**
+ * gtk_icon_source_set_icon_name
+ * @source: a #GtkIconSource
+ * @icon_name: 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.
+ **/
+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.
+ **/
+void
+gtk_icon_source_set_pixbuf (GtkIconSource *source,
+ GdkPixbuf *pixbuf)
{
- GtkIconSet *copy;
- GSList *tmp_list;
+ g_return_if_fail (source != NULL);
+ g_return_if_fail (pixbuf == NULL || GDK_IS_PIXBUF (pixbuf));
- copy = gtk_icon_set_new ();
+ if (source->type == GTK_ICON_SOURCE_PIXBUF &&
+ source->source.pixbuf == pixbuf)
+ return;
- tmp_list = icon_set->sources;
- while (tmp_list != NULL)
+ icon_source_clear (source);
+
+ if (pixbuf != NULL)
{
- copy->sources = g_slist_prepend (copy->sources,
- gtk_icon_source_copy (tmp_list->data));
-
- tmp_list = g_slist_next (tmp_list);
+ source->type = GTK_ICON_SOURCE_PIXBUF;
+ source->source.pixbuf = g_object_ref (pixbuf);
}
+}
- copy->sources = g_slist_reverse (copy->sources);
+/**
+ * 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.
+ *
+ * Return value: image filename. This string must not be modified
+ * or freed.
+ **/
+G_CONST_RETURN gchar*
+gtk_icon_source_get_filename (const GtkIconSource *source)
+{
+ g_return_val_if_fail (source != NULL, NULL);
- copy->cache = copy_cache (icon_set, copy);
- copy->cache_size = icon_set->cache_size;
- copy->cache_serial = icon_set->cache_serial;
-
- return copy;
+ if (source->type == GTK_ICON_SOURCE_FILENAME)
+ return source->source.filename;
+ else
+ return NULL;
}
-
-static gboolean
-sizes_equivalent (const gchar *rhs, const gchar *lhs)
+/**
+ * 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.
+ *
+ * Return value: icon name. This string must not be modified or freed.
+ **/
+G_CONST_RETURN gchar*
+gtk_icon_source_get_icon_name (const GtkIconSource *source)
{
- gint r_w, r_h, l_w, l_h;
-
- gtk_icon_size_lookup (rhs, &r_w, &r_h);
- gtk_icon_size_lookup (lhs, &l_w, &l_h);
+ g_return_val_if_fail (source != NULL, NULL);
- return r_w == l_w && r_h == l_h;
+ if (source->type == GTK_ICON_SOURCE_ICON_NAME ||
+ source->type == GTK_ICON_SOURCE_STATIC_ICON_NAME)
+ return source->source.icon_name;
+ else
+ return NULL;
}
-static GtkIconSource*
-find_and_prep_icon_source (GtkIconSet *icon_set,
- GtkTextDirection direction,
- GtkStateType state,
- const gchar *size)
+/**
+ * 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.
+ *
+ * Return value: source pixbuf
+ **/
+GdkPixbuf*
+gtk_icon_source_get_pixbuf (const GtkIconSource *source)
{
- GtkIconSource *source;
- GSList *tmp_list;
+ 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.
+ *
+ **/
+void
+gtk_icon_source_set_direction_wildcarded (GtkIconSource *source,
+ gboolean setting)
+{
+ g_return_if_fail (source != NULL);
- /* 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 || (sizes_equivalent (size, s->size))))
- {
- source = s;
- break;
- }
-
- tmp_list = g_slist_next (tmp_list);
- }
+ source->any_direction = setting != FALSE;
+}
- if (source == NULL)
- return NULL;
-
- if (source->pixbuf == NULL)
- {
- GError *error;
- gchar *full;
-
- g_assert (source->filename);
+/**
+ * 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.
+ **/
+void
+gtk_icon_source_set_state_wildcarded (GtkIconSource *source,
+ gboolean setting)
+{
+ g_return_if_fail (source != NULL);
- if (*source->filename != G_DIR_SEPARATOR)
- full = gtk_rc_find_pixmap_in_path (NULL, source->filename);
- else
- full = g_strdup (source->filename);
+ source->any_state = setting != FALSE;
+}
- error = NULL;
- source->pixbuf = gdk_pixbuf_new_from_file (full, &error);
- g_free (full);
-
- if (source->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);
-
- /* Try to fall back to other sources */
- if (icon_set->sources != NULL)
- return find_and_prep_icon_source (icon_set,
- direction,
- state,
- size);
- else
- return NULL;
- }
- }
+/**
+ * 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.
+ **/
+void
+gtk_icon_source_set_size_wildcarded (GtkIconSource *source,
+ gboolean setting)
+{
+ g_return_if_fail (source != NULL);
- return source;
+ source->any_size = setting != FALSE;
}
-GdkPixbuf*
-gtk_icon_set_render_icon (GtkIconSet *icon_set,
- GtkStyle *style,
- GtkTextDirection direction,
- GtkStateType state,
- const gchar *size,
- GtkWidget *widget,
- const char *detail)
+/**
+ * gtk_icon_source_get_size_wildcarded:
+ * @source: a #GtkIconSource
+ *
+ * Gets the value set by gtk_icon_source_set_size_wildcarded().
+ *
+ * Return value: %TRUE if this icon source is a base for any icon size variant
+ **/
+gboolean
+gtk_icon_source_get_size_wildcarded (const GtkIconSource *source)
{
- GdkPixbuf *icon;
- GtkIconSource *source;
+ g_return_val_if_fail (source != NULL, TRUE);
- /* FIXME conceivably, everywhere this function
- * returns NULL, we should return some default
- * dummy icon like a question mark or the image icon
- * from netscape
- */
-
- g_return_val_if_fail (icon_set != NULL, NULL);
- g_return_val_if_fail (GTK_IS_STYLE (style), NULL);
+ return source->any_size;
+}
- if (icon_set->sources == NULL)
- return NULL;
-
- icon = find_in_cache (icon_set, style, direction,
- state, size);
+/**
+ * gtk_icon_source_get_state_wildcarded:
+ * @source: a #GtkIconSource
+ *
+ * Gets the value set by gtk_icon_source_set_state_wildcarded().
+ *
+ * Return value: %TRUE if this icon source is a base for any widget state variant
+ **/
+gboolean
+gtk_icon_source_get_state_wildcarded (const GtkIconSource *source)
+{
+ g_return_val_if_fail (source != NULL, TRUE);
- if (icon)
- {
- g_object_ref (G_OBJECT (icon));
- return icon;
- }
+ return source->any_state;
+}
-
- source = find_and_prep_icon_source (icon_set, direction, state, size);
+/**
+ * gtk_icon_source_get_direction_wildcarded:
+ * @source: a #GtkIconSource
+ *
+ * Gets the value set by gtk_icon_source_set_direction_wildcarded().
+ *
+ * Return value: %TRUE if this icon source is a base for any text direction variant
+ **/
+gboolean
+gtk_icon_source_get_direction_wildcarded (const GtkIconSource *source)
+{
+ g_return_val_if_fail (source != NULL, TRUE);
- if (source == NULL)
- return NULL;
+ return source->any_direction;
+}
- g_assert (source->pixbuf != NULL);
-
- icon = gtk_style_render_icon (style,
- source,
- direction,
- state,
- size,
- widget,
- detail);
+/**
+ * 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.
+ *
+ **/
+void
+gtk_icon_source_set_direction (GtkIconSource *source,
+ GtkTextDirection direction)
+{
+ g_return_if_fail (source != NULL);
- if (icon == NULL)
- {
- g_warning ("Theme engine failed to render icon");
- return NULL;
- }
-
- add_to_cache (icon_set, style, direction, state, size, icon);
-
- return icon;
+ source->direction = direction;
}
-/* 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)
+/**
+ * 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.
+ *
+ **/
+void
+gtk_icon_source_set_state (GtkIconSource *source,
+ GtkStateType state)
{
- const GtkIconSource *a = ap;
- const GtkIconSource *b = bp;
+ g_return_if_fail (source != NULL);
- 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;
+ source->state = state;
}
+/**
+ * gtk_icon_source_set_size:
+ * @source: a #GtkIconSource
+ * @size: 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.
+ *
+ **/
void
-gtk_icon_set_add_source (GtkIconSet *icon_set,
- const GtkIconSource *source)
+gtk_icon_source_set_size (GtkIconSource *source,
+ GtkIconSize size)
{
- g_return_if_fail (icon_set != NULL);
g_return_if_fail (source != NULL);
- if (source->pixbuf == NULL &&
- source->filename == NULL)
- {
- g_warning ("Useless GtkIconSource contains NULL filename and pixbuf");
- return;
- }
-
- icon_set->sources = g_slist_insert_sorted (icon_set->sources,
- gtk_icon_source_copy (source),
- icon_source_compare);
+ source->size = size;
}
-GtkIconSource *
-gtk_icon_source_copy (const GtkIconSource *source)
+/**
+ * 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 <emphasis>not</emphasis>
+ * wildcarded.
+ *
+ * Return value: text direction this source matches
+ **/
+GtkTextDirection
+gtk_icon_source_get_direction (const GtkIconSource *source)
{
- GtkIconSource *copy;
-
- g_return_val_if_fail (source != NULL, NULL);
+ g_return_val_if_fail (source != NULL, 0);
- copy = g_new (GtkIconSource, 1);
+ return source->direction;
+}
- *copy = *source;
-
- copy->filename = g_strdup (source->filename);
- copy->size = g_strdup (source->size);
- if (copy->pixbuf)
- g_object_ref (G_OBJECT (copy->pixbuf));
+/**
+ * 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 <emphasis>not</emphasis>
+ * wildcarded.
+ *
+ * Return value: widget state this source matches
+ **/
+GtkStateType
+gtk_icon_source_get_state (const GtkIconSource *source)
+{
+ g_return_val_if_fail (source != NULL, 0);
- return copy;
+ return source->state;
}
-void
-gtk_icon_source_free (GtkIconSource *source)
+/**
+ * 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 <emphasis>not</emphasis> wildcarded.
+ *
+ * Return value: icon size this source matches.
+ **/
+GtkIconSize
+gtk_icon_source_get_size (const GtkIconSource *source)
{
- g_return_if_fail (source != NULL);
-
- g_free ((char*) source->filename);
- g_free ((char*) source->size);
- if (source->pixbuf)
- g_object_unref (G_OBJECT (source->pixbuf));
+ g_return_val_if_fail (source != NULL, 0);
- g_free (source);
+ return source->size;
}
-/* Note that the logical maximum is 20 per GtkTextDirection, so we could
- * eventually set this to >20 to never throw anything out.
- */
#define NUM_CACHED_ICONS 8
typedef struct _CachedIcon CachedIcon;
GtkStyle *style;
GtkTextDirection direction;
GtkStateType state;
- gchar *size;
+ GtkIconSize size;
GdkPixbuf *pixbuf;
};
ensure_cache_up_to_date (GtkIconSet *icon_set)
{
if (icon_set->cache_serial != cache_serial)
- clear_cache (icon_set, TRUE);
+ {
+ clear_cache (icon_set, TRUE);
+ icon_set->cache_serial = cache_serial;
+ }
}
static void
cached_icon_free (CachedIcon *icon)
{
- g_free (icon->size);
- g_object_unref (G_OBJECT (icon->pixbuf));
+ g_object_unref (icon->pixbuf);
+
+ if (icon->style)
+ g_object_unref (icon->style);
g_free (icon);
}
GtkStyle *style,
GtkTextDirection direction,
GtkStateType state,
- const gchar *size)
+ GtkIconSize size)
{
GSList *tmp_list;
GSList *prev;
if (icon->style == style &&
icon->direction == direction &&
icon->state == state &&
- strcmp (icon->size, size) == 0)
+ icon->size == size)
{
if (prev)
{
GtkStyle *style,
GtkTextDirection direction,
GtkStateType state,
- const gchar *size,
+ GtkIconSize size,
GdkPixbuf *pixbuf)
{
CachedIcon *icon;
ensure_cache_up_to_date (icon_set);
-
- g_object_ref (G_OBJECT (pixbuf));
+
+ g_object_ref (pixbuf);
/* We have to ref the style, since if the style was finalized
* its address could be reused by another style, creating a
*/
if (style)
- g_object_ref (G_OBJECT (style));
-
+ g_object_ref (style);
icon = g_new (CachedIcon, 1);
icon_set->cache = g_slist_prepend (icon_set->cache, icon);
+ icon_set->cache_size++;
icon->style = style;
icon->direction = direction;
icon->state = state;
- icon->size = g_strdup (size);
+ icon->size = size;
icon->pixbuf = pixbuf;
if (icon->style)
if (icon_set->cache_size >= NUM_CACHED_ICONS)
{
/* Remove oldest item in the cache */
-
GSList *tmp_list;
tmp_list = icon_set->cache;
clear_cache (GtkIconSet *icon_set,
gboolean style_detach)
{
- GSList *tmp_list;
+ GSList *cache, *tmp_list;
GtkStyle *last_style = NULL;
- tmp_list = icon_set->cache;
+ 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;
tmp_list = g_slist_next (tmp_list);
}
- g_slist_free (icon_set->cache);
- icon_set->cache = NULL;
- icon_set->cache_size = 0;
+ g_slist_free (cache);
}
static GSList*
*icon_copy = *icon;
if (icon_copy->style)
- attach_to_style (copy_recipient, icon_copy->style);
+ {
+ attach_to_style (copy_recipient, icon_copy->style);
+ g_object_ref (icon_copy->style);
+ }
- g_object_ref (G_OBJECT (icon_copy->pixbuf));
+ g_object_ref (icon_copy->pixbuf);
- icon_copy->size = g_strdup (icon->size);
+ icon_copy->size = icon->size;
copy = g_slist_prepend (copy, icon_copy);
{
++cache_serial;
}
+
+static void
+listify_foreach (gpointer key, gpointer value, gpointer data)
+{
+ GSList **list = data;
+
+ *list = g_slist_prepend (*list, key);
+}
+
+static GSList *
+g_hash_table_get_keys (GHashTable *table)
+{
+ GSList *list = NULL;
+
+ g_hash_table_foreach (table, listify_foreach, &list);
+
+ return list;
+}
+
+/**
+ * _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.
+ *
+ * Return value: List of ids in icon factories
+ **/
+GSList*
+_gtk_icon_factory_list_ids (void)
+{
+ GSList *tmp_list;
+ GSList *ids;
+
+ ids = NULL;
+
+ _gtk_icon_factory_ensure_default_icons ();
+
+ tmp_list = all_icon_factories;
+ while (tmp_list != NULL)
+ {
+ GSList *these_ids;
+
+ GtkIconFactory *factory = GTK_ICON_FACTORY (tmp_list->data);
+
+ these_ids = g_hash_table_get_keys (factory->icons);
+
+ ids = g_slist_concat (ids, these_ids);
+
+ tmp_list = g_slist_next (tmp_list);
+ }
+
+ return ids;
+}
+
+#ifdef G_OS_WIN32
+
+/* DLL ABI stability backward compatibility versions */
+
+#undef gtk_icon_source_set_filename
+
+void
+gtk_icon_source_set_filename (GtkIconSource *source,
+ const gchar *filename)
+{
+ gchar *utf8_filename = g_locale_to_utf8 (filename, -1, NULL, NULL, NULL);
+
+ gtk_icon_source_set_filename_utf8 (source, utf8_filename);
+
+ g_free (utf8_filename);
+}
+
+#undef gtk_icon_source_get_filename
+
+G_CONST_RETURN 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->cp_filename;
+ else
+ return NULL;
+}
+
+#endif
+
+#define __GTK_ICON_FACTORY_C__
+#include "gtkaliasdef.c"