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 unset_image_properties (GtkCellRendererPixbuf *cell)
289 GtkCellRendererPixbufPrivate *priv;
291 priv = GTK_CELL_RENDERER_PIXBUF_GET_PRIVATE (cell);
295 g_free (priv->stock_id);
296 priv->stock_id = NULL;
297 g_object_notify (G_OBJECT (cell), "stock-id");
301 g_free (priv->icon_name);
302 priv->icon_name = NULL;
303 g_object_notify (G_OBJECT (cell), "icon-name");
307 g_object_unref (cell->pixbuf);
309 g_object_notify (G_OBJECT (cell), "pixbuf");
313 g_object_unref (priv->gicon);
315 g_object_notify (G_OBJECT (cell), "gicon");
320 gtk_cell_renderer_pixbuf_set_property (GObject *object,
325 GtkCellRendererPixbuf *cellpixbuf = GTK_CELL_RENDERER_PIXBUF (object);
326 GtkCellRendererPixbufPrivate *priv;
328 priv = GTK_CELL_RENDERER_PIXBUF_GET_PRIVATE (object);
333 unset_image_properties (cellpixbuf);
334 cellpixbuf->pixbuf = (GdkPixbuf *) g_value_dup_object (value);
336 case PROP_PIXBUF_EXPANDER_OPEN:
337 if (cellpixbuf->pixbuf_expander_open)
338 g_object_unref (cellpixbuf->pixbuf_expander_open);
339 cellpixbuf->pixbuf_expander_open = (GdkPixbuf*) g_value_dup_object (value);
341 case PROP_PIXBUF_EXPANDER_CLOSED:
342 if (cellpixbuf->pixbuf_expander_closed)
343 g_object_unref (cellpixbuf->pixbuf_expander_closed);
344 cellpixbuf->pixbuf_expander_closed = (GdkPixbuf*) g_value_dup_object (value);
347 unset_image_properties (cellpixbuf);
348 priv->stock_id = g_value_dup_string (value);
350 case PROP_STOCK_SIZE:
351 priv->stock_size = g_value_get_uint (value);
353 case PROP_STOCK_DETAIL:
354 g_free (priv->stock_detail);
355 priv->stock_detail = g_value_dup_string (value);
358 unset_image_properties (cellpixbuf);
359 priv->icon_name = g_value_dup_string (value);
361 case PROP_FOLLOW_STATE:
362 priv->follow_state = g_value_get_boolean (value);
365 unset_image_properties (cellpixbuf);
366 priv->gicon = (GIcon *) g_value_dup_object (value);
369 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
375 * gtk_cell_renderer_pixbuf_new:
377 * Creates a new #GtkCellRendererPixbuf. Adjust rendering
378 * parameters using object properties. Object properties can be set
379 * globally (with g_object_set()). Also, with #GtkTreeViewColumn, you
380 * can bind a property to a value in a #GtkTreeModel. For example, you
381 * can bind the "pixbuf" property on the cell renderer to a pixbuf value
382 * in the model, thus rendering a different image in each row of the
385 * Return value: the new cell renderer
388 gtk_cell_renderer_pixbuf_new (void)
390 return g_object_new (GTK_TYPE_CELL_RENDERER_PIXBUF, NULL);
394 gtk_cell_renderer_pixbuf_create_stock_pixbuf (GtkCellRendererPixbuf *cellpixbuf,
397 GtkCellRendererPixbufPrivate *priv;
399 priv = GTK_CELL_RENDERER_PIXBUF_GET_PRIVATE (cellpixbuf);
401 if (cellpixbuf->pixbuf)
402 g_object_unref (cellpixbuf->pixbuf);
404 cellpixbuf->pixbuf = gtk_widget_render_icon (widget,
409 g_object_notify (G_OBJECT (cellpixbuf), "pixbuf");
413 gtk_cell_renderer_pixbuf_create_themed_pixbuf (GtkCellRendererPixbuf *cellpixbuf,
416 GtkCellRendererPixbufPrivate *priv;
418 GtkIconTheme *icon_theme;
419 GtkSettings *settings;
421 GError *error = NULL;
423 priv = GTK_CELL_RENDERER_PIXBUF_GET_PRIVATE (cellpixbuf);
425 if (cellpixbuf->pixbuf)
427 g_object_unref (cellpixbuf->pixbuf);
428 cellpixbuf->pixbuf = NULL;
431 screen = gtk_widget_get_screen (GTK_WIDGET (widget));
432 icon_theme = gtk_icon_theme_get_for_screen (screen);
433 settings = gtk_settings_get_for_screen (screen);
435 if (!gtk_icon_size_lookup_for_settings (settings,
439 g_warning ("Invalid icon size %u\n", priv->stock_size);
444 cellpixbuf->pixbuf = gtk_icon_theme_load_icon (icon_theme,
447 GTK_ICON_LOOKUP_USE_BUILTIN,
449 else if (priv->gicon)
453 info = gtk_icon_theme_lookup_by_gicon (icon_theme,
456 GTK_ICON_LOOKUP_USE_BUILTIN);
459 g_set_error (&error, GTK_ICON_THEME_ERROR, GTK_ICON_THEME_NOT_FOUND,
460 _("Icon not present in theme"));
464 cellpixbuf->pixbuf = gtk_icon_info_load_icon (info, &error);
465 gtk_icon_info_free (info);
469 if (!cellpixbuf->pixbuf)
471 g_warning ("could not load image: %s\n", error->message);
472 g_error_free (error);
475 g_object_notify (G_OBJECT (cellpixbuf), "pixbuf");
479 create_colorized_pixbuf (GdkPixbuf *src,
483 gint width, height, has_alpha, src_row_stride, dst_row_stride;
484 gint red_value, green_value, blue_value;
485 guchar *target_pixels;
486 guchar *original_pixels;
491 red_value = new_color->red / 255.0;
492 green_value = new_color->green / 255.0;
493 blue_value = new_color->blue / 255.0;
495 dest = gdk_pixbuf_new (gdk_pixbuf_get_colorspace (src),
496 gdk_pixbuf_get_has_alpha (src),
497 gdk_pixbuf_get_bits_per_sample (src),
498 gdk_pixbuf_get_width (src),
499 gdk_pixbuf_get_height (src));
501 has_alpha = gdk_pixbuf_get_has_alpha (src);
502 width = gdk_pixbuf_get_width (src);
503 height = gdk_pixbuf_get_height (src);
504 src_row_stride = gdk_pixbuf_get_rowstride (src);
505 dst_row_stride = gdk_pixbuf_get_rowstride (dest);
506 target_pixels = gdk_pixbuf_get_pixels (dest);
507 original_pixels = gdk_pixbuf_get_pixels (src);
509 for (i = 0; i < height; i++) {
510 pixdest = target_pixels + i*dst_row_stride;
511 pixsrc = original_pixels + i*src_row_stride;
512 for (j = 0; j < width; j++) {
513 *pixdest++ = (*pixsrc++ * red_value) >> 8;
514 *pixdest++ = (*pixsrc++ * green_value) >> 8;
515 *pixdest++ = (*pixsrc++ * blue_value) >> 8;
517 *pixdest++ = *pixsrc++;
526 gtk_cell_renderer_pixbuf_get_size (GtkCellRenderer *cell,
528 GdkRectangle *cell_area,
534 GtkCellRendererPixbuf *cellpixbuf = (GtkCellRendererPixbuf *) cell;
535 GtkCellRendererPixbufPrivate *priv;
536 gint pixbuf_width = 0;
537 gint pixbuf_height = 0;
541 priv = GTK_CELL_RENDERER_PIXBUF_GET_PRIVATE (cell);
543 if (!cellpixbuf->pixbuf)
546 gtk_cell_renderer_pixbuf_create_stock_pixbuf (cellpixbuf, widget);
547 else if (priv->icon_name || priv->gicon)
548 gtk_cell_renderer_pixbuf_create_themed_pixbuf (cellpixbuf, widget);
551 if (cellpixbuf->pixbuf)
553 pixbuf_width = gdk_pixbuf_get_width (cellpixbuf->pixbuf);
554 pixbuf_height = gdk_pixbuf_get_height (cellpixbuf->pixbuf);
556 if (cellpixbuf->pixbuf_expander_open)
558 pixbuf_width = MAX (pixbuf_width, gdk_pixbuf_get_width (cellpixbuf->pixbuf_expander_open));
559 pixbuf_height = MAX (pixbuf_height, gdk_pixbuf_get_height (cellpixbuf->pixbuf_expander_open));
561 if (cellpixbuf->pixbuf_expander_closed)
563 pixbuf_width = MAX (pixbuf_width, gdk_pixbuf_get_width (cellpixbuf->pixbuf_expander_closed));
564 pixbuf_height = MAX (pixbuf_height, gdk_pixbuf_get_height (cellpixbuf->pixbuf_expander_closed));
567 calc_width = (gint) cell->xpad * 2 + pixbuf_width;
568 calc_height = (gint) cell->ypad * 2 + pixbuf_height;
570 if (cell_area && pixbuf_width > 0 && pixbuf_height > 0)
574 *x_offset = (((gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL) ?
575 (1.0 - cell->xalign) : cell->xalign) *
576 (cell_area->width - calc_width));
577 *x_offset = MAX (*x_offset, 0);
581 *y_offset = (cell->yalign *
582 (cell_area->height - calc_height));
583 *y_offset = MAX (*y_offset, 0);
588 if (x_offset) *x_offset = 0;
589 if (y_offset) *y_offset = 0;
596 *height = calc_height;
600 gtk_cell_renderer_pixbuf_render (GtkCellRenderer *cell,
603 GdkRectangle *background_area,
604 GdkRectangle *cell_area,
605 GdkRectangle *expose_area,
606 GtkCellRendererState flags)
609 GtkCellRendererPixbuf *cellpixbuf = (GtkCellRendererPixbuf *) cell;
610 GtkCellRendererPixbufPrivate *priv;
612 GdkPixbuf *invisible = NULL;
613 GdkPixbuf *colorized = NULL;
614 GdkRectangle pix_rect;
615 GdkRectangle draw_rect;
618 priv = GTK_CELL_RENDERER_PIXBUF_GET_PRIVATE (cell);
620 gtk_cell_renderer_pixbuf_get_size (cell, widget, cell_area,
626 pix_rect.x += cell_area->x + cell->xpad;
627 pix_rect.y += cell_area->y + cell->ypad;
628 pix_rect.width -= cell->xpad * 2;
629 pix_rect.height -= cell->ypad * 2;
631 if (!gdk_rectangle_intersect (cell_area, &pix_rect, &draw_rect) ||
632 !gdk_rectangle_intersect (expose_area, &draw_rect, &draw_rect))
635 pixbuf = cellpixbuf->pixbuf;
637 if (cell->is_expander)
639 if (cell->is_expanded &&
640 cellpixbuf->pixbuf_expander_open != NULL)
641 pixbuf = cellpixbuf->pixbuf_expander_open;
642 else if (!cell->is_expanded &&
643 cellpixbuf->pixbuf_expander_closed != NULL)
644 pixbuf = cellpixbuf->pixbuf_expander_closed;
650 if (GTK_WIDGET_STATE (widget) == GTK_STATE_INSENSITIVE || !cell->sensitive)
652 GtkIconSource *source;
654 source = gtk_icon_source_new ();
655 gtk_icon_source_set_pixbuf (source, pixbuf);
656 /* The size here is arbitrary; since size isn't
657 * wildcarded in the source, it isn't supposed to be
658 * scaled by the engine function
660 gtk_icon_source_set_size (source, GTK_ICON_SIZE_SMALL_TOOLBAR);
661 gtk_icon_source_set_size_wildcarded (source, FALSE);
663 invisible = gtk_style_render_icon (widget->style,
665 gtk_widget_get_direction (widget),
666 GTK_STATE_INSENSITIVE,
670 "gtkcellrendererpixbuf");
672 gtk_icon_source_free (source);
676 else if (priv->follow_state &&
677 (flags & (GTK_CELL_RENDERER_SELECTED|GTK_CELL_RENDERER_PRELIT)) != 0)
681 if ((flags & GTK_CELL_RENDERER_SELECTED) != 0)
683 if (GTK_WIDGET_HAS_FOCUS (widget))
684 state = GTK_STATE_SELECTED;
686 state = GTK_STATE_ACTIVE;
689 state = GTK_STATE_PRELIGHT;
691 colorized = create_colorized_pixbuf (pixbuf,
692 &widget->style->base[state]);
697 cr = gdk_cairo_create (window);
699 gdk_cairo_set_source_pixbuf (cr, pixbuf, pix_rect.x, pix_rect.y);
700 gdk_cairo_rectangle (cr, &draw_rect);
706 g_object_unref (invisible);
709 g_object_unref (colorized);
712 #define __GTK_CELL_RENDERER_PIXBUF_C__
713 #include "gtkaliasdef.c"