Commit b5d8d2c4 authored by Cosimo Cecchi's avatar Cosimo Cecchi

icon-helper: add GtkIconHelper private object

GtkIconHelper is a helper object to easily obtain a pixbuf from
different icon sources (e.g. a GIcon, an icon name, a stock id, ...).

Code is ported from GtkImage, which will be adapted in the next commit.
parent d462f86a
......@@ -417,6 +417,7 @@ gtk_private_h_sources = \
gtkfontchooserprivate.h \
gtkfontchooserutils.h \
gtkiconcache.h \
gtkiconhelperprivate.h \
gtkimageprivate.h \
gtkimmoduleprivate.h \
gtkimcontextsimpleseqs.h \
......@@ -595,6 +596,7 @@ gtk_base_c_sources = \
gtkiconcache.c \
gtkiconcachevalidator.c \
gtkiconfactory.c \
gtkiconhelper.c \
gtkicontheme.c \
gtkiconview.c \
gtkimage.c \
......
/* GTK - The GIMP Toolkit
* Copyright (C) 2011 Red Hat, Inc.
*
* Authors: Cosimo Cecchi <cosimoc@gnome.org>
*
* 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, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#include "config.h"
#include "gtkiconhelperprivate.h"
G_DEFINE_TYPE (GtkIconHelper, _gtk_icon_helper, G_TYPE_OBJECT)
struct _GtkIconHelperPrivate {
GtkImageType storage_type;
GdkPixbuf *orig_pixbuf;
GdkPixbufAnimation *animation;
GIcon *gicon;
GtkIconSet *icon_set;
gchar *icon_name;
gchar *stock_id;
GtkIconSize icon_size;
gint pixel_size;
gboolean use_fallback;
GdkPixbuf *rendered_pixbuf;
GtkStateFlags last_rendered_state;
};
void
_gtk_icon_helper_clear (GtkIconHelper *self)
{
g_clear_object (&self->priv->gicon);
g_clear_object (&self->priv->orig_pixbuf);
g_clear_object (&self->priv->animation);
g_clear_object (&self->priv->rendered_pixbuf);
if (self->priv->icon_set != NULL)
{
gtk_icon_set_unref (self->priv->icon_set);
self->priv->icon_set = NULL;
}
g_free (self->priv->icon_name);
self->priv->icon_name = NULL;
g_free (self->priv->stock_id);
self->priv->stock_id = NULL;
self->priv->storage_type = GTK_IMAGE_EMPTY;
self->priv->icon_size = GTK_ICON_SIZE_INVALID;
self->priv->pixel_size = -1;
self->priv->last_rendered_state = GTK_STATE_FLAG_NORMAL;
}
void
_gtk_icon_helper_invalidate (GtkIconHelper *self)
{
g_clear_object (&self->priv->rendered_pixbuf);
}
static void
gtk_icon_helper_finalize (GObject *object)
{
GtkIconHelper *self = GTK_ICON_HELPER (object);
_gtk_icon_helper_clear (self);
G_OBJECT_CLASS (_gtk_icon_helper_parent_class)->finalize (object);
}
static void
_gtk_icon_helper_class_init (GtkIconHelperClass *klass)
{
GObjectClass *oclass;
oclass = G_OBJECT_CLASS (klass);
oclass->finalize = gtk_icon_helper_finalize;
g_type_class_add_private (klass, sizeof (GtkIconHelperPrivate));
}
static void
_gtk_icon_helper_init (GtkIconHelper *self)
{
self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self, GTK_TYPE_ICON_HELPER, GtkIconHelperPrivate);
self->priv->storage_type = GTK_IMAGE_EMPTY;
self->priv->icon_size = GTK_ICON_SIZE_INVALID;
self->priv->pixel_size = -1;
self->priv->last_rendered_state = GTK_STATE_FLAG_NORMAL;
}
static void
ensure_icon_size (GtkIconHelper *self,
GtkStyleContext *context,
gint *width_out,
gint *height_out)
{
gint width, height;
GtkSettings *settings;
GdkScreen *screen;
screen = gtk_style_context_get_screen (context);
settings = gtk_settings_get_for_screen (screen);
if (self->priv->pixel_size != -1)
{
width = height = self->priv->pixel_size;
}
else if (!gtk_icon_size_lookup_for_settings (settings,
self->priv->icon_size,
&width, &height))
{
g_warning ("Invalid icon size %d\n", self->priv->icon_size);
width = height = 24;
}
*width_out = width;
*height_out = height;
}
static GdkPixbuf *
ensure_stated_icon_from_info (GtkIconHelper *self,
GtkStyleContext *context,
GtkIconInfo *info)
{
GdkPixbuf *destination = NULL;
gboolean symbolic;
symbolic = FALSE;
if (info)
destination =
gtk_icon_info_load_symbolic_for_context (info,
context,
&symbolic,
NULL);
if (destination == NULL)
{
GtkIconSet *icon_set;
icon_set = gtk_style_context_lookup_icon_set (context, GTK_STOCK_MISSING_IMAGE);
destination =
gtk_icon_set_render_icon_pixbuf (icon_set, context, self->priv->icon_size);
}
else if (!symbolic)
{
GtkIconSource *source;
GdkPixbuf *rendered;
source = gtk_icon_source_new ();
gtk_icon_source_set_pixbuf (source, destination);
/* The size here is arbitrary; since size isn't
* wildcarded in the source, it isn't supposed to be
* scaled by the engine function
*/
gtk_icon_source_set_size (source,
GTK_ICON_SIZE_SMALL_TOOLBAR);
gtk_icon_source_set_size_wildcarded (source, FALSE);
rendered = gtk_render_icon_pixbuf (context, source, (GtkIconSize) -1);
gtk_icon_source_free (source);
g_object_unref (destination);
destination = rendered;
}
return destination;
}
static gboolean
check_invalidate_pixbuf (GtkIconHelper *self,
GtkStyleContext *context)
{
GtkStateFlags state;
state = gtk_style_context_get_state (context);
if ((self->priv->rendered_pixbuf != NULL) &&
(self->priv->last_rendered_state == state))
return FALSE;
self->priv->last_rendered_state = state;
g_clear_object (&self->priv->rendered_pixbuf);
return TRUE;
}
static GtkIconLookupFlags
get_icon_lookup_flags (GtkIconHelper *self)
{
GtkIconLookupFlags flags = GTK_ICON_LOOKUP_USE_BUILTIN;
if (self->priv->use_fallback)
flags |= GTK_ICON_LOOKUP_GENERIC_FALLBACK;
if (self->priv->pixel_size != -1)
flags |= GTK_ICON_LOOKUP_FORCE_SIZE;
return flags;
}
static void
ensure_pixbuf_for_icon_name_or_gicon (GtkIconHelper *self,
GtkStyleContext *context)
{
GtkIconTheme *icon_theme;
gint width, height;
GtkIconInfo *info;
GtkIconLookupFlags flags;
if (!check_invalidate_pixbuf (self, context))
return;
icon_theme = gtk_icon_theme_get_default ();
flags = get_icon_lookup_flags (self);
ensure_icon_size (self, context, &width, &height);
if (self->priv->storage_type == GTK_IMAGE_ICON_NAME &&
self->priv->icon_name != NULL)
{
info = gtk_icon_theme_lookup_icon (icon_theme,
self->priv->icon_name,
MIN (width, height), flags);
}
else if (self->priv->storage_type == GTK_IMAGE_GICON &&
self->priv->gicon != NULL)
{
info = gtk_icon_theme_lookup_by_gicon (icon_theme,
self->priv->gicon,
MIN (width, height), flags);
}
else
{
g_assert_not_reached ();
return;
}
self->priv->rendered_pixbuf = ensure_stated_icon_from_info (self, context, info);
if (info)
gtk_icon_info_free (info);
}
static void
ensure_pixbuf_for_icon_set (GtkIconHelper *self,
GtkStyleContext *context,
GtkIconSet *icon_set)
{
if (!check_invalidate_pixbuf (self, context))
return;
self->priv->rendered_pixbuf =
gtk_icon_set_render_icon_pixbuf (icon_set, context, self->priv->icon_size);
}
GdkPixbuf *
_gtk_icon_helper_ensure_pixbuf (GtkIconHelper *self,
GtkStyleContext *context)
{
GdkPixbuf *pixbuf = NULL;
GtkIconSet *icon_set;
switch (self->priv->storage_type)
{
case GTK_IMAGE_PIXBUF:
pixbuf = g_object_ref (self->priv->orig_pixbuf);
break;
case GTK_IMAGE_STOCK:
icon_set = gtk_style_context_lookup_icon_set (context, self->priv->stock_id);
ensure_pixbuf_for_icon_set (self, context, icon_set);
break;
case GTK_IMAGE_ICON_SET:
icon_set = self->priv->icon_set;
ensure_pixbuf_for_icon_set (self, context, icon_set);
break;
case GTK_IMAGE_ICON_NAME:
case GTK_IMAGE_GICON:
ensure_pixbuf_for_icon_name_or_gicon (self, context);
break;
case GTK_IMAGE_ANIMATION:
case GTK_IMAGE_EMPTY:
default:
pixbuf = NULL;
break;
}
if (pixbuf == NULL &&
self->priv->rendered_pixbuf != NULL)
pixbuf = g_object_ref (self->priv->rendered_pixbuf);
return pixbuf;
}
void
_gtk_icon_helper_get_size (GtkIconHelper *self,
GtkStyleContext *context,
gint *width_out,
gint *height_out)
{
GdkPixbuf *pix;
gint width, height;
width = height = 0;
pix = _gtk_icon_helper_ensure_pixbuf (self, context);
if (pix != NULL)
{
width = gdk_pixbuf_get_width (pix);
height = gdk_pixbuf_get_height (pix);
g_object_unref (pix);
}
else if (self->priv->storage_type == GTK_IMAGE_ANIMATION)
{
width = gdk_pixbuf_animation_get_width (self->priv->animation);
height = gdk_pixbuf_animation_get_height (self->priv->animation);
}
else if (self->priv->icon_size != -1)
{
ensure_icon_size (self, context, &width, &height);
}
if (width_out)
*width_out = width;
if (height_out)
*height_out = height;
}
void
_gtk_icon_helper_set_gicon (GtkIconHelper *self,
GIcon *gicon,
GtkIconSize icon_size)
{
_gtk_icon_helper_clear (self);
if (gicon != NULL)
{
self->priv->storage_type = GTK_IMAGE_GICON;
self->priv->gicon = g_object_ref (gicon);
_gtk_icon_helper_set_icon_size (self, icon_size);
}
}
void
_gtk_icon_helper_set_icon_name (GtkIconHelper *self,
const gchar *icon_name,
GtkIconSize icon_size)
{
_gtk_icon_helper_clear (self);
if (icon_name != NULL)
{
self->priv->storage_type = GTK_IMAGE_ICON_NAME;
self->priv->icon_name = g_strdup (icon_name);
_gtk_icon_helper_set_icon_size (self, icon_size);
}
}
void
_gtk_icon_helper_set_icon_set (GtkIconHelper *self,
GtkIconSet *icon_set,
GtkIconSize icon_size)
{
_gtk_icon_helper_clear (self);
if (icon_set != NULL)
{
self->priv->storage_type = GTK_IMAGE_ICON_SET;
self->priv->icon_set = gtk_icon_set_ref (icon_set);
_gtk_icon_helper_set_icon_size (self, icon_size);
}
}
void
_gtk_icon_helper_set_pixbuf (GtkIconHelper *self,
GdkPixbuf *pixbuf)
{
_gtk_icon_helper_clear (self);
if (pixbuf != NULL)
{
self->priv->storage_type = GTK_IMAGE_PIXBUF;
self->priv->orig_pixbuf = g_object_ref (pixbuf);
}
}
void
_gtk_icon_helper_set_animation (GtkIconHelper *self,
GdkPixbufAnimation *animation)
{
_gtk_icon_helper_clear (self);
if (animation != NULL)
{
self->priv->storage_type = GTK_IMAGE_ANIMATION;
self->priv->animation = g_object_ref (animation);
}
}
void
_gtk_icon_helper_set_stock_id (GtkIconHelper *self,
const gchar *stock_id,
GtkIconSize icon_size)
{
_gtk_icon_helper_clear (self);
if (stock_id != NULL)
{
self->priv->storage_type = GTK_IMAGE_STOCK;
self->priv->stock_id = g_strdup (stock_id);
_gtk_icon_helper_set_icon_size (self, icon_size);
}
}
void
_gtk_icon_helper_set_icon_size (GtkIconHelper *self,
GtkIconSize icon_size)
{
if (self->priv->icon_size != icon_size)
{
self->priv->icon_size = icon_size;
_gtk_icon_helper_invalidate (self);
}
}
void
_gtk_icon_helper_set_pixel_size (GtkIconHelper *self,
gint pixel_size)
{
if (self->priv->pixel_size != pixel_size)
{
self->priv->pixel_size = pixel_size;
_gtk_icon_helper_invalidate (self);
}
}
void
_gtk_icon_helper_set_use_fallback (GtkIconHelper *self,
gboolean use_fallback)
{
if (self->priv->use_fallback != use_fallback)
{
self->priv->use_fallback = use_fallback;
_gtk_icon_helper_invalidate (self);
}
}
GtkImageType
_gtk_icon_helper_get_storage_type (GtkIconHelper *self)
{
return self->priv->storage_type;
}
gboolean
_gtk_icon_helper_get_use_fallback (GtkIconHelper *self)
{
return self->priv->use_fallback;
}
GtkIconSize
_gtk_icon_helper_get_icon_size (GtkIconHelper *self)
{
return self->priv->icon_size;
}
gint
_gtk_icon_helper_get_pixel_size (GtkIconHelper *self)
{
return self->priv->pixel_size;
}
GdkPixbuf *
_gtk_icon_helper_peek_pixbuf (GtkIconHelper *self)
{
g_return_val_if_fail (self->priv->storage_type == GTK_IMAGE_PIXBUF ||
self->priv->storage_type == GTK_IMAGE_EMPTY, NULL);
return self->priv->orig_pixbuf;
}
GIcon *
_gtk_icon_helper_peek_gicon (GtkIconHelper *self)
{
g_return_val_if_fail (self->priv->storage_type == GTK_IMAGE_GICON ||
self->priv->storage_type == GTK_IMAGE_EMPTY, NULL);
return self->priv->gicon;
}
GdkPixbufAnimation *
_gtk_icon_helper_peek_animation (GtkIconHelper *self)
{
g_return_val_if_fail (self->priv->storage_type == GTK_IMAGE_ANIMATION ||
self->priv->storage_type == GTK_IMAGE_EMPTY, NULL);
return self->priv->animation;
}
GtkIconSet *
_gtk_icon_helper_peek_icon_set (GtkIconHelper *self)
{
g_return_val_if_fail (self->priv->storage_type == GTK_IMAGE_ICON_SET ||
self->priv->storage_type == GTK_IMAGE_EMPTY, NULL);
return self->priv->icon_set;
}
const gchar *
_gtk_icon_helper_get_stock_id (GtkIconHelper *self)
{
g_return_val_if_fail (self->priv->storage_type == GTK_IMAGE_STOCK ||
self->priv->storage_type == GTK_IMAGE_EMPTY, NULL);
return self->priv->stock_id;
}
const gchar *
_gtk_icon_helper_get_icon_name (GtkIconHelper *self)
{
g_return_val_if_fail (self->priv->storage_type == GTK_IMAGE_ICON_NAME ||
self->priv->storage_type == GTK_IMAGE_EMPTY, NULL);
return self->priv->icon_name;
}
GtkIconHelper *
_gtk_icon_helper_new (void)
{
return g_object_new (GTK_TYPE_ICON_HELPER, NULL);
}
void
_gtk_icon_helper_draw (GtkIconHelper *self,
GtkStyleContext *context,
cairo_t *cr,
gdouble x,
gdouble y)
{
GdkPixbuf *pixbuf;
pixbuf = _gtk_icon_helper_ensure_pixbuf (self, context);
if (pixbuf != NULL)
{
gtk_render_icon (context, cr, pixbuf, x, y);
g_object_unref (pixbuf);
}
}
gboolean
_gtk_icon_helper_get_is_empty (GtkIconHelper *self)
{
return (self->priv->storage_type == GTK_IMAGE_EMPTY);
}
/* GTK - The GIMP Toolkit
* Copyright (C) 2011 Red Hat, Inc.
*
* Authors: Cosimo Cecchi <cosimoc@gnome.org>
*
* 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, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#ifndef __GTK_ICON_HELPER_H__
#define __GTK_ICON_HELPER_H__
#include <glib-object.h>
#include <gtk/gtk.h>
G_BEGIN_DECLS
#define GTK_TYPE_ICON_HELPER _gtk_icon_helper_get_type()
#define GTK_ICON_HELPER(obj) \
(G_TYPE_CHECK_INSTANCE_CAST ((obj), \
GTK_TYPE_ICON_HELPER, GtkIconHelper))
#define GTK_ICON_HELPER_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST ((klass), \
GTK_TYPE_ICON_HELPER, GtkIconHelperClass))
#define GTK_IS_ICON_HELPER(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
GTK_TYPE_ICON_HELPER))
#define GTK_IS_ICON_HELPER_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE ((klass), \
GTK_TYPE_ICON_HELPER))
#define GTK_ICON_HELPER_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS ((obj), \
GTK_TYPE_ICON_HELPER, GtkIconHelperClass))
typedef struct _GtkIconHelper GtkIconHelper;
typedef struct _GtkIconHelperClass GtkIconHelperClass;
typedef struct _GtkIconHelperPrivate GtkIconHelperPrivate;
struct _GtkIconHelper
{
GObject parent;
GtkIconHelperPrivate *priv;
};
struct _GtkIconHelperClass
{
GObjectClass parent_class;
};
GType _gtk_icon_helper_get_type (void) G_GNUC_CONST;
GtkIconHelper *_gtk_icon_helper_new (void);
void _gtk_icon_helper_clear (GtkIconHelper *self);
void _gtk_icon_helper_invalidate (GtkIconHelper *self);
gboolean _gtk_icon_helper_get_is_empty (GtkIconHelper *self);
void _gtk_icon_helper_set_gicon (GtkIconHelper *self,
GIcon *gicon,
GtkIconSize icon_size);
void _gtk_icon_helper_set_pixbuf (GtkIconHelper *self,
GdkPixbuf *pixbuf);
void _gtk_icon_helper_set_animation (GtkIconHelper *self,
GdkPixbufAnimation *animation);
void _gtk_icon_helper_set_icon_set (GtkIconHelper *self,
GtkIconSet *icon_set,
GtkIconSize icon_size);
void _gtk_icon_helper_set_icon_name (GtkIconHelper *self,
const gchar *icon_name,
GtkIconSize icon_size);
void _gtk_icon_helper_set_stock_id (GtkIconHelper *self,
const gchar *stock_id,
GtkIconSize icon_size);
void _gtk_icon_helper_set_icon_size (GtkIconHelper *self,
GtkIconSize icon_size);
void _gtk_icon_helper_set_pixel_size (GtkIconHelper *self,
gint pixel_size);
void _gtk_icon_helper_set_use_fallback (GtkIconHelper *self,
gboolean use_fallback);
GtkImageType _gtk_icon_helper_get_storage_type (GtkIconHelper *self);
GtkIconSize _gtk_icon_helper_get_icon_size (GtkIconHelper *self);
gint _gtk_icon_helper_get_pixel_size (GtkIconHelper *self);
gboolean _gtk_icon_helper_get_use_fallback (GtkIconHelper *self);
GdkPixbuf *_gtk_icon_helper_peek_pixbuf (GtkIconHelper *self);
GIcon *_gtk_icon_helper_peek_gicon (GtkIconHelper *self);
GtkIconSet *_gtk_icon_helper_peek_icon_set (GtkIconHelper *self);
GdkPixbufAnimation *_gtk_icon_helper_peek_animation (GtkIconHelper *self);
const gchar *_gtk_icon_helper_get_stock_id (GtkIconHelper *self);
const gchar *_gtk_icon_helper_get_icon_name (GtkIconHelper *self);
GdkPixbuf *_gtk_icon_helper_ensure_pixbuf (GtkIconHelper *self,
GtkStyleContext *context);
void _gtk_icon_helper_get_size (GtkIconHelper *self,
GtkStyleContext *context,
gint *width_out,
gint *height_out);
void _gtk_icon_helper_draw (GtkIconHelper *self,
GtkStyleContext *context,
cairo_t *cr,
gdouble x,
gdouble y);
G_END_DECLS
#endif /* __GTK_ICON_HELPER_H__ */
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment