2 * Copyright (C) 2000 Red Hat, Inc. Jonathan Blandford
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.
20 #include "gtkcellrenderer.h"
22 #include "gtktreeprivate.h"
24 static void gtk_cell_renderer_init (GtkCellRenderer *cell);
25 static void gtk_cell_renderer_class_init (GtkCellRendererClass *class);
26 static void gtk_cell_renderer_get_property (GObject *object,
30 static void gtk_cell_renderer_set_property (GObject *object,
34 static void set_cell_bg_color (GtkCellRenderer *cell,
51 PROP_CELL_BACKGROUND_GDK,
52 PROP_CELL_BACKGROUND_SET
56 gtk_cell_renderer_get_type (void)
58 static GType cell_type = 0;
62 static const GTypeInfo cell_info =
64 sizeof (GtkCellRendererClass),
66 NULL, /* base_finalize */
67 (GClassInitFunc) gtk_cell_renderer_class_init,
68 NULL, /* class_finalize */
69 NULL, /* class_data */
70 sizeof (GtkCellRenderer),
72 (GInstanceInitFunc) gtk_cell_renderer_init,
73 NULL, /* value_table */
76 cell_type = g_type_register_static (GTK_TYPE_OBJECT, "GtkCellRenderer",
77 &cell_info, G_TYPE_FLAG_ABSTRACT);
84 gtk_cell_renderer_init (GtkCellRenderer *cell)
86 GtkCellRendererInfo *cellinfo;
88 cell->mode = GTK_CELL_RENDERER_MODE_INERT;
97 cellinfo = g_new0 (GtkCellRendererInfo, 1);
98 g_object_set_data_full (G_OBJECT (cell),
99 GTK_CELL_RENDERER_INFO_KEY, cellinfo, g_free);
103 gtk_cell_renderer_class_init (GtkCellRendererClass *class)
105 GObjectClass *object_class = G_OBJECT_CLASS (class);
107 object_class->get_property = gtk_cell_renderer_get_property;
108 object_class->set_property = gtk_cell_renderer_set_property;
110 class->render = NULL;
111 class->get_size = NULL;
113 g_object_class_install_property (object_class,
115 g_param_spec_enum ("mode",
117 _("Editable mode of the CellRenderer"),
118 GTK_TYPE_CELL_RENDERER_MODE,
119 GTK_CELL_RENDERER_MODE_INERT,
123 g_object_class_install_property (object_class,
125 g_param_spec_boolean ("visible",
127 _("Display the cell"),
132 g_object_class_install_property (object_class,
134 g_param_spec_float ("xalign",
143 g_object_class_install_property (object_class,
145 g_param_spec_float ("yalign",
154 g_object_class_install_property (object_class,
156 g_param_spec_uint ("xpad",
165 g_object_class_install_property (object_class,
167 g_param_spec_uint ("ypad",
176 g_object_class_install_property (object_class,
178 g_param_spec_int ("width",
180 _("The fixed width"),
187 g_object_class_install_property (object_class,
189 g_param_spec_int ("height",
191 _("The fixed height"),
198 g_object_class_install_property (object_class,
200 g_param_spec_boolean ("is_expander",
202 _("Row has children"),
208 g_object_class_install_property (object_class,
210 g_param_spec_boolean ("is_expanded",
212 _("Row is an expander row, and is expanded"),
217 g_object_class_install_property (object_class,
218 PROP_CELL_BACKGROUND,
219 g_param_spec_string ("cell_background",
220 _("Cell background color name"),
221 _("Cell background color as a string"),
225 g_object_class_install_property (object_class,
226 PROP_CELL_BACKGROUND_GDK,
227 g_param_spec_boxed ("cell_background_gdk",
228 _("Cell background color"),
229 _("Cell background color as a GdkColor"),
231 G_PARAM_READABLE | G_PARAM_WRITABLE));
234 #define ADD_SET_PROP(propname, propval, nick, blurb) g_object_class_install_property (object_class, propval, g_param_spec_boolean (propname, nick, blurb, FALSE, G_PARAM_READABLE | G_PARAM_WRITABLE))
236 ADD_SET_PROP ("cell_background_set", PROP_CELL_BACKGROUND_SET,
237 _("Cell background set"),
238 _("Whether this tag affects the cell background color"));
242 gtk_cell_renderer_get_property (GObject *object,
247 GtkCellRenderer *cell = GTK_CELL_RENDERER (object);
248 GtkCellRendererInfo *cellinfo;
250 cellinfo = g_object_get_data (object,
251 GTK_CELL_RENDERER_INFO_KEY);
256 g_value_set_enum (value, cell->mode);
259 g_value_set_boolean (value, cell->visible);
262 g_value_set_float (value, cell->xalign);
265 g_value_set_float (value, cell->yalign);
268 g_value_set_uint (value, cell->xpad);
271 g_value_set_uint (value, cell->ypad);
274 g_value_set_int (value, cell->width);
277 g_value_set_int (value, cell->height);
279 case PROP_IS_EXPANDER:
280 g_value_set_boolean (value, cell->is_expander);
282 case PROP_IS_EXPANDED:
283 g_value_set_boolean (value, cell->is_expanded);
285 case PROP_CELL_BACKGROUND_GDK:
289 color.red = cellinfo->cell_background.red;
290 color.green = cellinfo->cell_background.green;
291 color.blue = cellinfo->cell_background.blue;
293 g_value_set_boxed (value, &color);
296 case PROP_CELL_BACKGROUND_SET:
297 g_value_set_boolean (value, cell->cell_background_set);
299 case PROP_CELL_BACKGROUND:
301 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
308 gtk_cell_renderer_set_property (GObject *object,
313 GtkCellRenderer *cell = GTK_CELL_RENDERER (object);
318 cell->mode = g_value_get_enum (value);
321 cell->visible = g_value_get_boolean (value);
324 cell->xalign = g_value_get_float (value);
327 cell->yalign = g_value_get_float (value);
330 cell->xpad = g_value_get_uint (value);
333 cell->ypad = g_value_get_uint (value);
336 cell->width = g_value_get_int (value);
339 cell->height = g_value_get_int (value);
341 case PROP_IS_EXPANDER:
342 cell->is_expander = g_value_get_boolean (value);
344 case PROP_IS_EXPANDED:
345 cell->is_expanded = g_value_get_boolean (value);
347 case PROP_CELL_BACKGROUND:
351 if (!g_value_get_string (value))
352 set_cell_bg_color (cell, NULL);
353 else if (gdk_color_parse (g_value_get_string (value), &color))
354 set_cell_bg_color (cell, &color);
356 g_warning ("Don't know color `%s'", g_value_get_string (value));
358 g_object_notify (object, "cell_background_gdk");
361 case PROP_CELL_BACKGROUND_GDK:
362 set_cell_bg_color (cell, g_value_get_boxed (value));
364 case PROP_CELL_BACKGROUND_SET:
365 cell->cell_background_set = g_value_get_boolean (value);
368 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
374 set_cell_bg_color (GtkCellRenderer *cell,
377 GtkCellRendererInfo *cellinfo;
379 cellinfo = g_object_get_data (G_OBJECT (cell),
380 GTK_CELL_RENDERER_INFO_KEY);
384 if (!cell->cell_background_set)
386 cell->cell_background_set = TRUE;
387 g_object_notify (G_OBJECT (cell), "cell_background_set");
390 cellinfo->cell_background.red = color->red;
391 cellinfo->cell_background.green = color->green;
392 cellinfo->cell_background.blue = color->blue;
396 if (cell->cell_background_set)
398 cell->cell_background_set = FALSE;
399 g_object_notify (G_OBJECT (cell), "cell_background_set");
405 * gtk_cell_renderer_get_size:
406 * @cell: a #GtkCellRenderer
407 * @widget: the widget the renderer is rendering to
408 * @cell_area: The area a cell will be allocated, or %NULL
409 * @x_offset: location to return x offset of cell relative to @cell_area, or %NULL
410 * @y_offset: location to return y offset of cell relative to @cell_area, or %NULL
411 * @width: location to return width needed to render a cell, or %NULL
412 * @height: location to return height needed to render a cell, or %NULL
414 * Obtains the width and height needed to render the cell. Used by view widgets
415 * to determine the appropriate size for the cell_area passed to
416 * gtk_cell_renderer_render(). If @cell_area is not %NULL, fills in the x and y
417 * offsets (if set) of the cell relative to this location. Please note that the
418 * values set in @width and @height, as well as those in @x_offset and @y_offset
419 * are inclusive of the xpad and ypad properties.
422 gtk_cell_renderer_get_size (GtkCellRenderer *cell,
424 GdkRectangle *cell_area,
430 gint *real_width = width;
431 gint *real_height = height;
433 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
434 g_return_if_fail (GTK_CELL_RENDERER_GET_CLASS (cell)->get_size != NULL);
436 if (width && cell->width != -1)
439 *width = cell->width;
441 if (height && cell->height != -1)
444 *height = cell->height;
447 GTK_CELL_RENDERER_GET_CLASS (cell)->get_size (cell,
457 * gtk_cell_renderer_render:
458 * @cell: a #GtkCellRenderer
459 * @window: a #GdkDrawable to draw to
460 * @widget: the widget owning @window
461 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
462 * @cell_area: area normally rendered by a cell renderer
463 * @expose_area: area that actually needs updating
464 * @flags: flags that affect rendering
466 * Invokes the virtual render function of the #GtkCellRenderer. The three
467 * passed-in rectangles are areas of @window. Most renderers will draw within
468 * @cell_area; the xalign, yalign, xpad, and ypad fields of the #GtkCellRenderer
469 * should be honored with respect to @cell_area. @background_area includes the
470 * blank space around the cell, and also the area containing the tree expander;
471 * so the @background_area rectangles for all cells tile to cover the entire
472 * @window. @expose_area is a clip rectangle.
476 gtk_cell_renderer_render (GtkCellRenderer *cell,
479 GdkRectangle *background_area,
480 GdkRectangle *cell_area,
481 GdkRectangle *expose_area,
482 GtkCellRendererState flags)
484 gboolean selected = FALSE;
485 GtkCellRendererInfo *cellinfo;
487 cellinfo = g_object_get_data (G_OBJECT (cell),
488 GTK_CELL_RENDERER_INFO_KEY);
490 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
491 g_return_if_fail (GTK_CELL_RENDERER_GET_CLASS (cell)->render != NULL);
493 selected = (flags & GTK_CELL_RENDERER_SELECTED) == GTK_CELL_RENDERER_SELECTED;
495 if (cell->cell_background_set && !selected)
500 color.red = cellinfo->cell_background.red;
501 color.green = cellinfo->cell_background.green;
502 color.blue = cellinfo->cell_background.blue;
504 gc = gdk_gc_new (window);
505 gdk_gc_set_rgb_fg_color (gc, &color);
506 gdk_draw_rectangle (window, gc, TRUE,
507 background_area->x, background_area->y,
508 background_area->width, background_area->height);
512 GTK_CELL_RENDERER_GET_CLASS (cell)->render (cell,
522 * gtk_cell_renderer_activate:
523 * @cell: a #GtkCellRenderer
524 * @event: a #GdkEvent
525 * @widget: widget that received the event
526 * @path: widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath
527 * @background_area: background area as passed to @gtk_cell_renderer_render
528 * @cell_area: cell area as passed to @gtk_cell_renderer_render
529 * @flags: render flags
531 * Passes an activate event to the cell renderer for possible processing. Some
532 * cell renderers may use events; for example, #GtkCellRendererToggle toggles
533 * when it gets a mouse click.
535 * Return value: %TRUE if the event was consumed/handled
538 gtk_cell_renderer_activate (GtkCellRenderer *cell,
542 GdkRectangle *background_area,
543 GdkRectangle *cell_area,
544 GtkCellRendererState flags)
546 g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell), FALSE);
548 if (cell->mode != GTK_CELL_RENDERER_MODE_ACTIVATABLE)
551 if (GTK_CELL_RENDERER_GET_CLASS (cell)->activate == NULL)
554 return GTK_CELL_RENDERER_GET_CLASS (cell)->activate (cell,
564 * gtk_cell_renderer_start_editing:
565 * @cell: a #GtkCellRenderer
566 * @event: a #GdkEvent
567 * @widget: widget that received the event
568 * @path: widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath
569 * @background_area: background area as passed to @gtk_cell_renderer_render
570 * @cell_area: cell area as passed to @gtk_cell_renderer_render
571 * @flags: render flags
573 * Passes an activate event to the cell renderer for possible processing.
575 * Return value: A new #GtkCellEditable, or %NULL
578 gtk_cell_renderer_start_editing (GtkCellRenderer *cell,
582 GdkRectangle *background_area,
583 GdkRectangle *cell_area,
584 GtkCellRendererState flags)
587 g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell), NULL);
589 if (cell->mode != GTK_CELL_RENDERER_MODE_EDITABLE)
592 if (GTK_CELL_RENDERER_GET_CLASS (cell)->start_editing == NULL)
596 return GTK_CELL_RENDERER_GET_CLASS (cell)->start_editing (cell,
606 * gtk_cell_renderer_set_fixed_size:
607 * @cell: A #GtkCellRenderer
608 * @width: the width of the cell renderer, or -1
609 * @height: the height of the cell renderer, or -1
611 * Sets the renderer size to be explicit, independent of the properties set.
614 gtk_cell_renderer_set_fixed_size (GtkCellRenderer *cell,
618 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
619 g_return_if_fail (width >= -1 && height >= -1);
621 if ((width != cell->width) || (height != cell->height))
623 g_object_freeze_notify (G_OBJECT (cell));
625 if (width != cell->width)
628 g_object_notify (G_OBJECT (cell), "width");
631 if (height != cell->height)
633 cell->height = height;
634 g_object_notify (G_OBJECT (cell), "height");
637 g_object_thaw_notify (G_OBJECT (cell));
642 * gtk_cell_renderer_get_fixed_size:
643 * @cell: A #GtkCellRenderer
644 * @width: location to fill in with the fixed width of the widget, or %NULL
645 * @height: location to fill in with the fixed height of the widget, or %NULL
647 * Fills in @width and @height with the appropriate size of @cell.
650 gtk_cell_renderer_get_fixed_size (GtkCellRenderer *cell,
654 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
657 (* width) = cell->width;
659 (* height) = cell->height;