1 /* gtkcellrendererpixbuf.c
2 * Copyright (C) 2000 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
22 #include "gtkcellrendererpixbuf.h"
23 #include "gtkiconfactory.h"
24 #include "gtkicontheme.h"
26 #include "gtkprivate.h"
29 static void gtk_cell_renderer_pixbuf_get_property (GObject *object,
33 static void gtk_cell_renderer_pixbuf_set_property (GObject *object,
37 static void gtk_cell_renderer_pixbuf_finalize (GObject *object);
38 static void gtk_cell_renderer_pixbuf_create_stock_pixbuf (GtkCellRendererPixbuf *cellpixbuf,
40 static void gtk_cell_renderer_pixbuf_get_size (GtkCellRenderer *cell,
42 GdkRectangle *rectangle,
47 static void gtk_cell_renderer_pixbuf_render (GtkCellRenderer *cell,
50 GdkRectangle *background_area,
51 GdkRectangle *cell_area,
52 GdkRectangle *expose_area,
53 GtkCellRendererState flags);
59 PROP_PIXBUF_EXPANDER_OPEN,
60 PROP_PIXBUF_EXPANDER_CLOSED,
70 #define GTK_CELL_RENDERER_PIXBUF_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_CELL_RENDERER_PIXBUF, GtkCellRendererPixbufPrivate))
72 typedef struct _GtkCellRendererPixbufPrivate GtkCellRendererPixbufPrivate;
73 struct _GtkCellRendererPixbufPrivate
76 GtkIconSize stock_size;
78 gboolean follow_state;
83 G_DEFINE_TYPE (GtkCellRendererPixbuf, gtk_cell_renderer_pixbuf, GTK_TYPE_CELL_RENDERER)
86 gtk_cell_renderer_pixbuf_init (GtkCellRendererPixbuf *cellpixbuf)
88 GtkCellRendererPixbufPrivate *priv;
90 priv = GTK_CELL_RENDERER_PIXBUF_GET_PRIVATE (cellpixbuf);
91 priv->stock_size = GTK_ICON_SIZE_MENU;
95 gtk_cell_renderer_pixbuf_class_init (GtkCellRendererPixbufClass *class)
97 GObjectClass *object_class = G_OBJECT_CLASS (class);
98 GtkCellRendererClass *cell_class = GTK_CELL_RENDERER_CLASS (class);
100 object_class->finalize = gtk_cell_renderer_pixbuf_finalize;
102 object_class->get_property = gtk_cell_renderer_pixbuf_get_property;
103 object_class->set_property = gtk_cell_renderer_pixbuf_set_property;
105 cell_class->get_size = gtk_cell_renderer_pixbuf_get_size;
106 cell_class->render = gtk_cell_renderer_pixbuf_render;
108 g_object_class_install_property (object_class,
110 g_param_spec_object ("pixbuf",
112 P_("The pixbuf to render"),
114 GTK_PARAM_READWRITE));
116 g_object_class_install_property (object_class,
117 PROP_PIXBUF_EXPANDER_OPEN,
118 g_param_spec_object ("pixbuf-expander-open",
119 P_("Pixbuf Expander Open"),
120 P_("Pixbuf for open expander"),
122 GTK_PARAM_READWRITE));
124 g_object_class_install_property (object_class,
125 PROP_PIXBUF_EXPANDER_CLOSED,
126 g_param_spec_object ("pixbuf-expander-closed",
127 P_("Pixbuf Expander Closed"),
128 P_("Pixbuf for closed expander"),
130 GTK_PARAM_READWRITE));
132 g_object_class_install_property (object_class,
134 g_param_spec_string ("stock-id",
136 P_("The stock ID of the stock icon to render"),
138 GTK_PARAM_READWRITE));
140 g_object_class_install_property (object_class,
142 g_param_spec_uint ("stock-size",
144 P_("The GtkIconSize value that specifies the size of the rendered icon"),
148 GTK_PARAM_READWRITE));
150 g_object_class_install_property (object_class,
152 g_param_spec_string ("stock-detail",
154 P_("Render detail to pass to the theme engine"),
156 GTK_PARAM_READWRITE));
160 * GtkCellRendererPixbuf:icon-name:
162 * The name of the themed icon to display.
163 * This property only has an effect if not overridden by "stock_id"
164 * or "pixbuf" properties.
168 g_object_class_install_property (object_class,
170 g_param_spec_string ("icon-name",
172 P_("The name of the icon from the icon theme"),
174 GTK_PARAM_READWRITE));
177 * GtkCellRendererPixbuf:follow-state:
179 * Specifies whether the rendered pixbuf should be colorized
180 * according to the #GtkCellRendererState.
184 g_object_class_install_property (object_class,
186 g_param_spec_boolean ("follow-state",
188 P_("Whether the rendered pixbuf should be "
189 "colorized according to the state"),
191 GTK_PARAM_READWRITE));
194 * GtkCellRendererPixbuf:gicon:
196 * The GIcon representing the icon to display.
197 * If the icon theme is changed, the image will be updated
202 g_object_class_install_property (object_class,
204 g_param_spec_object ("gicon",
206 P_("The GIcon being displayed"),
208 GTK_PARAM_READWRITE));
212 g_type_class_add_private (object_class, sizeof (GtkCellRendererPixbufPrivate));
216 gtk_cell_renderer_pixbuf_finalize (GObject *object)
218 GtkCellRendererPixbuf *cellpixbuf = GTK_CELL_RENDERER_PIXBUF (object);
219 GtkCellRendererPixbufPrivate *priv;
221 priv = GTK_CELL_RENDERER_PIXBUF_GET_PRIVATE (object);
223 if (cellpixbuf->pixbuf)
224 g_object_unref (cellpixbuf->pixbuf);
225 if (cellpixbuf->pixbuf_expander_open)
226 g_object_unref (cellpixbuf->pixbuf_expander_open);
227 if (cellpixbuf->pixbuf_expander_closed)
228 g_object_unref (cellpixbuf->pixbuf_expander_closed);
230 g_free (priv->stock_id);
231 g_free (priv->stock_detail);
232 g_free (priv->icon_name);
235 g_object_unref (priv->gicon);
237 G_OBJECT_CLASS (gtk_cell_renderer_pixbuf_parent_class)->finalize (object);
241 gtk_cell_renderer_pixbuf_get_property (GObject *object,
246 GtkCellRendererPixbuf *cellpixbuf = GTK_CELL_RENDERER_PIXBUF (object);
247 GtkCellRendererPixbufPrivate *priv;
249 priv = GTK_CELL_RENDERER_PIXBUF_GET_PRIVATE (object);
254 g_value_set_object (value, cellpixbuf->pixbuf);
256 case PROP_PIXBUF_EXPANDER_OPEN:
257 g_value_set_object (value, cellpixbuf->pixbuf_expander_open);
259 case PROP_PIXBUF_EXPANDER_CLOSED:
260 g_value_set_object (value, cellpixbuf->pixbuf_expander_closed);
263 g_value_set_string (value, priv->stock_id);
265 case PROP_STOCK_SIZE:
266 g_value_set_uint (value, priv->stock_size);
268 case PROP_STOCK_DETAIL:
269 g_value_set_string (value, priv->stock_detail);
271 case PROP_FOLLOW_STATE:
272 g_value_set_boolean (value, priv->follow_state);
275 g_value_set_string (value, priv->icon_name);
278 g_value_set_object (value, priv->gicon);
281 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
287 gtk_cell_renderer_pixbuf_set_property (GObject *object,
292 GtkCellRendererPixbuf *cellpixbuf = GTK_CELL_RENDERER_PIXBUF (object);
293 GtkCellRendererPixbufPrivate *priv;
295 priv = GTK_CELL_RENDERER_PIXBUF_GET_PRIVATE (object);
300 if (cellpixbuf->pixbuf)
301 g_object_unref (cellpixbuf->pixbuf);
302 cellpixbuf->pixbuf = (GdkPixbuf*) g_value_dup_object (value);
303 if (cellpixbuf->pixbuf)
307 g_free (priv->stock_id);
308 priv->stock_id = NULL;
309 g_object_notify (object, "stock-id");
313 g_free (priv->icon_name);
314 priv->icon_name = NULL;
315 g_object_notify (object, "icon-name");
319 g_object_unref (priv->gicon);
321 g_object_notify (object, "gicon");
325 case PROP_PIXBUF_EXPANDER_OPEN:
326 if (cellpixbuf->pixbuf_expander_open)
327 g_object_unref (cellpixbuf->pixbuf_expander_open);
328 cellpixbuf->pixbuf_expander_open = (GdkPixbuf*) g_value_dup_object (value);
330 case PROP_PIXBUF_EXPANDER_CLOSED:
331 if (cellpixbuf->pixbuf_expander_closed)
332 g_object_unref (cellpixbuf->pixbuf_expander_closed);
333 cellpixbuf->pixbuf_expander_closed = (GdkPixbuf*) g_value_dup_object (value);
338 if (cellpixbuf->pixbuf)
340 g_object_unref (cellpixbuf->pixbuf);
341 cellpixbuf->pixbuf = NULL;
342 g_object_notify (object, "pixbuf");
344 g_free (priv->stock_id);
346 priv->stock_id = g_value_dup_string (value);
349 if (cellpixbuf->pixbuf)
351 g_object_unref (cellpixbuf->pixbuf);
352 cellpixbuf->pixbuf = NULL;
353 g_object_notify (object, "pixbuf");
357 g_free (priv->icon_name);
358 priv->icon_name = NULL;
359 g_object_notify (object, "icon-name");
363 g_object_unref (priv->gicon);
365 g_object_notify (object, "gicon");
369 case PROP_STOCK_SIZE:
370 priv->stock_size = g_value_get_uint (value);
372 case PROP_STOCK_DETAIL:
373 g_free (priv->stock_detail);
374 priv->stock_detail = g_value_dup_string (value);
379 if (cellpixbuf->pixbuf)
381 g_object_unref (cellpixbuf->pixbuf);
382 cellpixbuf->pixbuf = NULL;
383 g_object_notify (object, "pixbuf");
385 g_free (priv->icon_name);
387 priv->icon_name = g_value_dup_string (value);
390 if (cellpixbuf->pixbuf)
392 g_object_unref (cellpixbuf->pixbuf);
393 cellpixbuf->pixbuf = NULL;
394 g_object_notify (object, "pixbuf");
398 g_free (priv->stock_id);
399 priv->stock_id = NULL;
400 g_object_notify (object, "stock-id");
404 g_object_unref (priv->gicon);
406 g_object_notify (object, "gicon");
410 case PROP_FOLLOW_STATE:
411 priv->follow_state = g_value_get_boolean (value);
416 if (cellpixbuf->pixbuf)
418 g_object_unref (cellpixbuf->pixbuf);
419 cellpixbuf->pixbuf = NULL;
420 g_object_notify (object, "pixbuf");
422 g_object_unref (priv->gicon);
424 priv->gicon = (GIcon *) g_value_dup_object (value);
427 if (cellpixbuf->pixbuf)
429 g_object_unref (cellpixbuf->pixbuf);
430 cellpixbuf->pixbuf = NULL;
431 g_object_notify (object, "pixbuf");
435 g_free (priv->stock_id);
436 priv->stock_id = NULL;
437 g_object_notify (object, "stock-id");
441 g_free (priv->icon_name);
442 priv->icon_name = NULL;
443 g_object_notify (object, "icon-name");
448 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
454 * gtk_cell_renderer_pixbuf_new:
456 * Creates a new #GtkCellRendererPixbuf. Adjust rendering
457 * parameters using object properties. Object properties can be set
458 * globally (with g_object_set()). Also, with #GtkTreeViewColumn, you
459 * can bind a property to a value in a #GtkTreeModel. For example, you
460 * can bind the "pixbuf" property on the cell renderer to a pixbuf value
461 * in the model, thus rendering a different image in each row of the
464 * Return value: the new cell renderer
467 gtk_cell_renderer_pixbuf_new (void)
469 return g_object_new (GTK_TYPE_CELL_RENDERER_PIXBUF, NULL);
473 gtk_cell_renderer_pixbuf_create_stock_pixbuf (GtkCellRendererPixbuf *cellpixbuf,
476 GtkCellRendererPixbufPrivate *priv;
478 priv = GTK_CELL_RENDERER_PIXBUF_GET_PRIVATE (cellpixbuf);
480 if (cellpixbuf->pixbuf)
481 g_object_unref (cellpixbuf->pixbuf);
483 cellpixbuf->pixbuf = gtk_widget_render_icon (widget,
488 g_object_notify (G_OBJECT (cellpixbuf), "pixbuf");
492 gtk_cell_renderer_pixbuf_create_themed_pixbuf (GtkCellRendererPixbuf *cellpixbuf,
495 GtkCellRendererPixbufPrivate *priv;
497 GtkIconTheme *icon_theme;
498 GtkSettings *settings;
502 priv = GTK_CELL_RENDERER_PIXBUF_GET_PRIVATE (cellpixbuf);
504 if (cellpixbuf->pixbuf)
506 g_object_unref (cellpixbuf->pixbuf);
507 cellpixbuf->pixbuf = NULL;
510 screen = gtk_widget_get_screen (GTK_WIDGET (widget));
511 icon_theme = gtk_icon_theme_get_for_screen (screen);
512 settings = gtk_settings_get_for_screen (screen);
514 if (!gtk_icon_size_lookup_for_settings (settings,
518 g_warning ("Invalid icon size %u\n", priv->stock_size);
523 info = gtk_icon_theme_lookup_icon (icon_theme,
526 GTK_ICON_LOOKUP_USE_BUILTIN);
527 else if (priv->gicon)
528 info = gtk_icon_theme_lookup_by_gicon (icon_theme,
531 GTK_ICON_LOOKUP_USE_BUILTIN);
539 style = gtk_widget_get_style (GTK_WIDGET (widget));
541 gtk_icon_info_load_symbolic_for_style (info,
546 gtk_icon_info_free (info);
549 g_object_notify (G_OBJECT (cellpixbuf), "pixbuf");
553 create_symbolic_pixbuf (GtkCellRendererPixbuf *cellpixbuf,
557 GtkCellRendererPixbufPrivate *priv;
559 GtkIconTheme *icon_theme;
560 GtkSettings *settings;
565 priv = GTK_CELL_RENDERER_PIXBUF_GET_PRIVATE (cellpixbuf);
567 /* Not a named symbolic icon? */
568 if (priv->icon_name) {
569 if (!g_str_has_suffix (priv->icon_name, "-symbolic"))
571 } else if (priv->gicon) {
572 const gchar * const *names;
573 if (!G_IS_THEMED_ICON (priv->gicon))
575 names = g_themed_icon_get_names (G_THEMED_ICON (priv->gicon));
576 if (names == NULL || !g_str_has_suffix (names[0], "-symbolic"))
582 screen = gtk_widget_get_screen (GTK_WIDGET (widget));
583 icon_theme = gtk_icon_theme_get_for_screen (screen);
584 settings = gtk_settings_get_for_screen (screen);
586 if (!gtk_icon_size_lookup_for_settings (settings,
590 g_warning ("Invalid icon size %u\n", priv->stock_size);
596 info = gtk_icon_theme_lookup_icon (icon_theme,
599 GTK_ICON_LOOKUP_USE_BUILTIN);
600 else if (priv->gicon)
601 info = gtk_icon_theme_lookup_by_gicon (icon_theme,
604 GTK_ICON_LOOKUP_USE_BUILTIN);
612 style = gtk_widget_get_style (GTK_WIDGET (widget));
613 pixbuf = gtk_icon_info_load_symbolic_for_style (info,
616 gtk_icon_info_free (info);
624 create_colorized_pixbuf (GdkPixbuf *src,
628 gint width, height, has_alpha, src_row_stride, dst_row_stride;
629 gint red_value, green_value, blue_value;
630 guchar *target_pixels;
631 guchar *original_pixels;
636 red_value = new_color->red / 255.0;
637 green_value = new_color->green / 255.0;
638 blue_value = new_color->blue / 255.0;
640 dest = gdk_pixbuf_new (gdk_pixbuf_get_colorspace (src),
641 gdk_pixbuf_get_has_alpha (src),
642 gdk_pixbuf_get_bits_per_sample (src),
643 gdk_pixbuf_get_width (src),
644 gdk_pixbuf_get_height (src));
646 has_alpha = gdk_pixbuf_get_has_alpha (src);
647 width = gdk_pixbuf_get_width (src);
648 height = gdk_pixbuf_get_height (src);
649 src_row_stride = gdk_pixbuf_get_rowstride (src);
650 dst_row_stride = gdk_pixbuf_get_rowstride (dest);
651 target_pixels = gdk_pixbuf_get_pixels (dest);
652 original_pixels = gdk_pixbuf_get_pixels (src);
654 for (i = 0; i < height; i++) {
655 pixdest = target_pixels + i*dst_row_stride;
656 pixsrc = original_pixels + i*src_row_stride;
657 for (j = 0; j < width; j++) {
658 *pixdest++ = (*pixsrc++ * red_value) >> 8;
659 *pixdest++ = (*pixsrc++ * green_value) >> 8;
660 *pixdest++ = (*pixsrc++ * blue_value) >> 8;
662 *pixdest++ = *pixsrc++;
671 gtk_cell_renderer_pixbuf_get_size (GtkCellRenderer *cell,
673 GdkRectangle *cell_area,
679 GtkCellRendererPixbuf *cellpixbuf = (GtkCellRendererPixbuf *) cell;
680 GtkCellRendererPixbufPrivate *priv;
681 gint pixbuf_width = 0;
682 gint pixbuf_height = 0;
686 priv = GTK_CELL_RENDERER_PIXBUF_GET_PRIVATE (cell);
688 if (!cellpixbuf->pixbuf)
691 gtk_cell_renderer_pixbuf_create_stock_pixbuf (cellpixbuf, widget);
692 else if (priv->icon_name || priv->gicon)
693 gtk_cell_renderer_pixbuf_create_themed_pixbuf (cellpixbuf, widget);
696 if (cellpixbuf->pixbuf)
698 pixbuf_width = gdk_pixbuf_get_width (cellpixbuf->pixbuf);
699 pixbuf_height = gdk_pixbuf_get_height (cellpixbuf->pixbuf);
701 if (cellpixbuf->pixbuf_expander_open)
703 pixbuf_width = MAX (pixbuf_width, gdk_pixbuf_get_width (cellpixbuf->pixbuf_expander_open));
704 pixbuf_height = MAX (pixbuf_height, gdk_pixbuf_get_height (cellpixbuf->pixbuf_expander_open));
706 if (cellpixbuf->pixbuf_expander_closed)
708 pixbuf_width = MAX (pixbuf_width, gdk_pixbuf_get_width (cellpixbuf->pixbuf_expander_closed));
709 pixbuf_height = MAX (pixbuf_height, gdk_pixbuf_get_height (cellpixbuf->pixbuf_expander_closed));
712 calc_width = (gint) cell->xpad * 2 + pixbuf_width;
713 calc_height = (gint) cell->ypad * 2 + pixbuf_height;
715 if (cell_area && pixbuf_width > 0 && pixbuf_height > 0)
719 *x_offset = (((gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL) ?
720 (1.0 - cell->xalign) : cell->xalign) *
721 (cell_area->width - calc_width));
722 *x_offset = MAX (*x_offset, 0);
726 *y_offset = (cell->yalign *
727 (cell_area->height - calc_height));
728 *y_offset = MAX (*y_offset, 0);
733 if (x_offset) *x_offset = 0;
734 if (y_offset) *y_offset = 0;
741 *height = calc_height;
745 gtk_cell_renderer_pixbuf_render (GtkCellRenderer *cell,
748 GdkRectangle *background_area,
749 GdkRectangle *cell_area,
750 GdkRectangle *expose_area,
751 GtkCellRendererState flags)
754 GtkCellRendererPixbuf *cellpixbuf = (GtkCellRendererPixbuf *) cell;
755 GtkCellRendererPixbufPrivate *priv;
757 GdkPixbuf *invisible = NULL;
758 GdkPixbuf *colorized = NULL;
759 GdkPixbuf *symbolic = NULL;
760 GdkRectangle pix_rect;
761 GdkRectangle draw_rect;
764 priv = GTK_CELL_RENDERER_PIXBUF_GET_PRIVATE (cell);
766 gtk_cell_renderer_pixbuf_get_size (cell, widget, cell_area,
772 pix_rect.x += cell_area->x + cell->xpad;
773 pix_rect.y += cell_area->y + cell->ypad;
774 pix_rect.width -= cell->xpad * 2;
775 pix_rect.height -= cell->ypad * 2;
777 if (!gdk_rectangle_intersect (cell_area, &pix_rect, &draw_rect) ||
778 !gdk_rectangle_intersect (expose_area, &draw_rect, &draw_rect))
781 pixbuf = cellpixbuf->pixbuf;
783 if (cell->is_expander)
785 if (cell->is_expanded &&
786 cellpixbuf->pixbuf_expander_open != NULL)
787 pixbuf = cellpixbuf->pixbuf_expander_open;
788 else if (!cell->is_expanded &&
789 cellpixbuf->pixbuf_expander_closed != NULL)
790 pixbuf = cellpixbuf->pixbuf_expander_closed;
796 if (gtk_widget_get_state (widget) == GTK_STATE_INSENSITIVE || !cell->sensitive)
798 GtkIconSource *source;
800 source = gtk_icon_source_new ();
801 gtk_icon_source_set_pixbuf (source, pixbuf);
802 /* The size here is arbitrary; since size isn't
803 * wildcarded in the source, it isn't supposed to be
804 * scaled by the engine function
806 gtk_icon_source_set_size (source, GTK_ICON_SIZE_SMALL_TOOLBAR);
807 gtk_icon_source_set_size_wildcarded (source, FALSE);
809 invisible = gtk_style_render_icon (widget->style,
811 gtk_widget_get_direction (widget),
812 GTK_STATE_INSENSITIVE,
816 "gtkcellrendererpixbuf");
818 gtk_icon_source_free (source);
822 else if (priv->follow_state &&
823 (flags & (GTK_CELL_RENDERER_SELECTED|GTK_CELL_RENDERER_PRELIT)) != 0)
827 if ((flags & GTK_CELL_RENDERER_SELECTED) != 0)
829 if (gtk_widget_has_focus (widget))
830 state = GTK_STATE_SELECTED;
832 state = GTK_STATE_ACTIVE;
835 state = GTK_STATE_PRELIGHT;
837 symbolic = create_symbolic_pixbuf (cellpixbuf, widget, state);
839 colorized = create_colorized_pixbuf (pixbuf,
840 &widget->style->base[state]);
848 cr = gdk_cairo_create (window);
850 gdk_cairo_set_source_pixbuf (cr, pixbuf, pix_rect.x, pix_rect.y);
851 gdk_cairo_rectangle (cr, &draw_rect);
857 g_object_unref (invisible);
860 g_object_unref (colorized);
863 g_object_unref (symbolic);
866 #define __GTK_CELL_RENDERER_PIXBUF_C__
867 #include "gtkaliasdef.c"