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.
21 #include "gtkcellrenderer.h"
23 #include "gtkmarshalers.h"
24 #include "gtktreeprivate.h"
26 static void gtk_cell_renderer_init (GtkCellRenderer *cell);
27 static void gtk_cell_renderer_class_init (GtkCellRendererClass *class);
28 static void gtk_cell_renderer_get_property (GObject *object,
32 static void gtk_cell_renderer_set_property (GObject *object,
36 static void set_cell_bg_color (GtkCellRenderer *cell,
40 #define GTK_CELL_RENDERER_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_CELL_RENDERER, GtkCellRendererPrivate))
42 typedef struct _GtkCellRendererPrivate GtkCellRendererPrivate;
43 struct _GtkCellRendererPrivate
45 GdkColor cell_background;
63 PROP_CELL_BACKGROUND_GDK,
64 PROP_CELL_BACKGROUND_SET
73 static guint cell_renderer_signals[LAST_SIGNAL] = { 0 };
77 gtk_cell_renderer_get_type (void)
79 static GType cell_type = 0;
83 static const GTypeInfo cell_info =
85 sizeof (GtkCellRendererClass),
87 NULL, /* base_finalize */
88 (GClassInitFunc) gtk_cell_renderer_class_init,
89 NULL, /* class_finalize */
90 NULL, /* class_data */
91 sizeof (GtkCellRenderer),
93 (GInstanceInitFunc) gtk_cell_renderer_init,
94 NULL, /* value_table */
97 cell_type = g_type_register_static (GTK_TYPE_OBJECT, "GtkCellRenderer",
98 &cell_info, G_TYPE_FLAG_ABSTRACT);
105 gtk_cell_renderer_init (GtkCellRenderer *cell)
107 cell->mode = GTK_CELL_RENDERER_MODE_INERT;
108 cell->visible = TRUE;
115 cell->sensitive = TRUE;
116 cell->is_expander = FALSE;
117 cell->is_expanded = FALSE;
121 gtk_cell_renderer_class_init (GtkCellRendererClass *class)
123 GObjectClass *object_class = G_OBJECT_CLASS (class);
125 object_class->get_property = gtk_cell_renderer_get_property;
126 object_class->set_property = gtk_cell_renderer_set_property;
128 class->render = NULL;
129 class->get_size = NULL;
132 * GtkCellRenderer::editing-canceled:
133 * @renderer: the object which received the signal
135 * This signal gets emitted when the user cancels the process of editing a
136 * cell. For example, an editable cell renderer could be written to cancel
137 * editing when the user presses Escape.
139 * See also: gtk_cell_renderer_editing_canceled()
144 cell_renderer_signals[EDITING_CANCELED] =
145 g_signal_new ("editing-canceled",
146 G_OBJECT_CLASS_TYPE (object_class),
148 G_STRUCT_OFFSET (GtkCellRendererClass, editing_canceled),
150 _gtk_marshal_VOID__VOID,
153 g_object_class_install_property (object_class,
155 g_param_spec_enum ("mode",
157 P_("Editable mode of the CellRenderer"),
158 GTK_TYPE_CELL_RENDERER_MODE,
159 GTK_CELL_RENDERER_MODE_INERT,
163 g_object_class_install_property (object_class,
165 g_param_spec_boolean ("visible",
167 P_("Display the cell"),
170 g_object_class_install_property (object_class,
172 g_param_spec_boolean ("sensitive",
174 P_("Display the cell sensitive"),
178 g_object_class_install_property (object_class,
180 g_param_spec_float ("xalign",
189 g_object_class_install_property (object_class,
191 g_param_spec_float ("yalign",
200 g_object_class_install_property (object_class,
202 g_param_spec_uint ("xpad",
211 g_object_class_install_property (object_class,
213 g_param_spec_uint ("ypad",
222 g_object_class_install_property (object_class,
224 g_param_spec_int ("width",
226 P_("The fixed width"),
233 g_object_class_install_property (object_class,
235 g_param_spec_int ("height",
237 P_("The fixed height"),
244 g_object_class_install_property (object_class,
246 g_param_spec_boolean ("is_expander",
248 P_("Row has children"),
254 g_object_class_install_property (object_class,
256 g_param_spec_boolean ("is_expanded",
258 P_("Row is an expander row, and is expanded"),
263 g_object_class_install_property (object_class,
264 PROP_CELL_BACKGROUND,
265 g_param_spec_string ("cell_background",
266 P_("Cell background color name"),
267 P_("Cell background color as a string"),
271 g_object_class_install_property (object_class,
272 PROP_CELL_BACKGROUND_GDK,
273 g_param_spec_boxed ("cell_background_gdk",
274 P_("Cell background color"),
275 P_("Cell background color as a GdkColor"),
277 G_PARAM_READABLE | G_PARAM_WRITABLE));
280 #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))
282 ADD_SET_PROP ("cell_background_set", PROP_CELL_BACKGROUND_SET,
283 P_("Cell background set"),
284 P_("Whether this tag affects the cell background color"));
286 g_type_class_add_private (object_class, sizeof (GtkCellRendererPrivate));
290 gtk_cell_renderer_get_property (GObject *object,
295 GtkCellRenderer *cell = GTK_CELL_RENDERER (object);
296 GtkCellRendererPrivate *priv = GTK_CELL_RENDERER_GET_PRIVATE (object);
301 g_value_set_enum (value, cell->mode);
304 g_value_set_boolean (value, cell->visible);
307 g_value_set_boolean (value, cell->sensitive);
310 g_value_set_float (value, cell->xalign);
313 g_value_set_float (value, cell->yalign);
316 g_value_set_uint (value, cell->xpad);
319 g_value_set_uint (value, cell->ypad);
322 g_value_set_int (value, cell->width);
325 g_value_set_int (value, cell->height);
327 case PROP_IS_EXPANDER:
328 g_value_set_boolean (value, cell->is_expander);
330 case PROP_IS_EXPANDED:
331 g_value_set_boolean (value, cell->is_expanded);
333 case PROP_CELL_BACKGROUND_GDK:
337 color.red = priv->cell_background.red;
338 color.green = priv->cell_background.green;
339 color.blue = priv->cell_background.blue;
341 g_value_set_boxed (value, &color);
344 case PROP_CELL_BACKGROUND_SET:
345 g_value_set_boolean (value, cell->cell_background_set);
347 case PROP_CELL_BACKGROUND:
349 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
356 gtk_cell_renderer_set_property (GObject *object,
361 GtkCellRenderer *cell = GTK_CELL_RENDERER (object);
366 cell->mode = g_value_get_enum (value);
369 cell->visible = g_value_get_boolean (value);
372 cell->sensitive = g_value_get_boolean (value);
375 cell->xalign = g_value_get_float (value);
378 cell->yalign = g_value_get_float (value);
381 cell->xpad = g_value_get_uint (value);
384 cell->ypad = g_value_get_uint (value);
387 cell->width = g_value_get_int (value);
390 cell->height = g_value_get_int (value);
392 case PROP_IS_EXPANDER:
393 cell->is_expander = g_value_get_boolean (value);
395 case PROP_IS_EXPANDED:
396 cell->is_expanded = g_value_get_boolean (value);
398 case PROP_CELL_BACKGROUND:
402 if (!g_value_get_string (value))
403 set_cell_bg_color (cell, NULL);
404 else if (gdk_color_parse (g_value_get_string (value), &color))
405 set_cell_bg_color (cell, &color);
407 g_warning ("Don't know color `%s'", g_value_get_string (value));
409 g_object_notify (object, "cell_background_gdk");
412 case PROP_CELL_BACKGROUND_GDK:
413 set_cell_bg_color (cell, g_value_get_boxed (value));
415 case PROP_CELL_BACKGROUND_SET:
416 cell->cell_background_set = g_value_get_boolean (value);
419 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
425 set_cell_bg_color (GtkCellRenderer *cell,
428 GtkCellRendererPrivate *priv = GTK_CELL_RENDERER_GET_PRIVATE (cell);
432 if (!cell->cell_background_set)
434 cell->cell_background_set = TRUE;
435 g_object_notify (G_OBJECT (cell), "cell_background_set");
438 priv->cell_background.red = color->red;
439 priv->cell_background.green = color->green;
440 priv->cell_background.blue = color->blue;
444 if (cell->cell_background_set)
446 cell->cell_background_set = FALSE;
447 g_object_notify (G_OBJECT (cell), "cell_background_set");
453 * gtk_cell_renderer_get_size:
454 * @cell: a #GtkCellRenderer
455 * @widget: the widget the renderer is rendering to
456 * @cell_area: The area a cell will be allocated, or %NULL
457 * @x_offset: location to return x offset of cell relative to @cell_area, or %NULL
458 * @y_offset: location to return y offset of cell relative to @cell_area, or %NULL
459 * @width: location to return width needed to render a cell, or %NULL
460 * @height: location to return height needed to render a cell, or %NULL
462 * Obtains the width and height needed to render the cell. Used by view widgets
463 * to determine the appropriate size for the cell_area passed to
464 * gtk_cell_renderer_render(). If @cell_area is not %NULL, fills in the x and y
465 * offsets (if set) of the cell relative to this location. Please note that the
466 * values set in @width and @height, as well as those in @x_offset and @y_offset
467 * are inclusive of the xpad and ypad properties.
470 gtk_cell_renderer_get_size (GtkCellRenderer *cell,
472 GdkRectangle *cell_area,
478 gint *real_width = width;
479 gint *real_height = height;
481 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
482 g_return_if_fail (GTK_CELL_RENDERER_GET_CLASS (cell)->get_size != NULL);
484 if (width && cell->width != -1)
487 *width = cell->width;
489 if (height && cell->height != -1)
492 *height = cell->height;
495 GTK_CELL_RENDERER_GET_CLASS (cell)->get_size (cell,
505 * gtk_cell_renderer_render:
506 * @cell: a #GtkCellRenderer
507 * @window: a #GdkDrawable to draw to
508 * @widget: the widget owning @window
509 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
510 * @cell_area: area normally rendered by a cell renderer
511 * @expose_area: area that actually needs updating
512 * @flags: flags that affect rendering
514 * Invokes the virtual render function of the #GtkCellRenderer. The three
515 * passed-in rectangles are areas of @window. Most renderers will draw within
516 * @cell_area; the xalign, yalign, xpad, and ypad fields of the #GtkCellRenderer
517 * should be honored with respect to @cell_area. @background_area includes the
518 * blank space around the cell, and also the area containing the tree expander;
519 * so the @background_area rectangles for all cells tile to cover the entire
520 * @window. @expose_area is a clip rectangle.
524 gtk_cell_renderer_render (GtkCellRenderer *cell,
527 GdkRectangle *background_area,
528 GdkRectangle *cell_area,
529 GdkRectangle *expose_area,
530 GtkCellRendererState flags)
532 gboolean selected = FALSE;
533 GtkCellRendererPrivate *priv = GTK_CELL_RENDERER_GET_PRIVATE (cell);
535 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
536 g_return_if_fail (GTK_CELL_RENDERER_GET_CLASS (cell)->render != NULL);
538 selected = (flags & GTK_CELL_RENDERER_SELECTED) == GTK_CELL_RENDERER_SELECTED;
540 if (cell->cell_background_set && !selected)
545 color.red = priv->cell_background.red;
546 color.green = priv->cell_background.green;
547 color.blue = priv->cell_background.blue;
549 gc = gdk_gc_new (window);
550 gdk_gc_set_rgb_fg_color (gc, &color);
551 gdk_draw_rectangle (window, gc, TRUE,
552 background_area->x, background_area->y,
553 background_area->width, background_area->height);
557 GTK_CELL_RENDERER_GET_CLASS (cell)->render (cell,
567 * gtk_cell_renderer_activate:
568 * @cell: a #GtkCellRenderer
569 * @event: a #GdkEvent
570 * @widget: widget that received the event
571 * @path: widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath
572 * @background_area: background area as passed to @gtk_cell_renderer_render
573 * @cell_area: cell area as passed to @gtk_cell_renderer_render
574 * @flags: render flags
576 * Passes an activate event to the cell renderer for possible processing. Some
577 * cell renderers may use events; for example, #GtkCellRendererToggle toggles
578 * when it gets a mouse click.
580 * Return value: %TRUE if the event was consumed/handled
583 gtk_cell_renderer_activate (GtkCellRenderer *cell,
587 GdkRectangle *background_area,
588 GdkRectangle *cell_area,
589 GtkCellRendererState flags)
591 g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell), FALSE);
593 if (cell->mode != GTK_CELL_RENDERER_MODE_ACTIVATABLE)
596 if (GTK_CELL_RENDERER_GET_CLASS (cell)->activate == NULL)
599 return GTK_CELL_RENDERER_GET_CLASS (cell)->activate (cell,
609 * gtk_cell_renderer_start_editing:
610 * @cell: a #GtkCellRenderer
611 * @event: a #GdkEvent
612 * @widget: widget that received the event
613 * @path: widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath
614 * @background_area: background area as passed to @gtk_cell_renderer_render
615 * @cell_area: cell area as passed to @gtk_cell_renderer_render
616 * @flags: render flags
618 * Passes an activate event to the cell renderer for possible processing.
620 * Return value: A new #GtkCellEditable, or %NULL
623 gtk_cell_renderer_start_editing (GtkCellRenderer *cell,
627 GdkRectangle *background_area,
628 GdkRectangle *cell_area,
629 GtkCellRendererState flags)
632 g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell), NULL);
634 if (cell->mode != GTK_CELL_RENDERER_MODE_EDITABLE)
637 if (GTK_CELL_RENDERER_GET_CLASS (cell)->start_editing == NULL)
641 return GTK_CELL_RENDERER_GET_CLASS (cell)->start_editing (cell,
651 * gtk_cell_renderer_set_fixed_size:
652 * @cell: A #GtkCellRenderer
653 * @width: the width of the cell renderer, or -1
654 * @height: the height of the cell renderer, or -1
656 * Sets the renderer size to be explicit, independent of the properties set.
659 gtk_cell_renderer_set_fixed_size (GtkCellRenderer *cell,
663 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
664 g_return_if_fail (width >= -1 && height >= -1);
666 if ((width != cell->width) || (height != cell->height))
668 g_object_freeze_notify (G_OBJECT (cell));
670 if (width != cell->width)
673 g_object_notify (G_OBJECT (cell), "width");
676 if (height != cell->height)
678 cell->height = height;
679 g_object_notify (G_OBJECT (cell), "height");
682 g_object_thaw_notify (G_OBJECT (cell));
687 * gtk_cell_renderer_get_fixed_size:
688 * @cell: A #GtkCellRenderer
689 * @width: location to fill in with the fixed width of the widget, or %NULL
690 * @height: location to fill in with the fixed height of the widget, or %NULL
692 * Fills in @width and @height with the appropriate size of @cell.
695 gtk_cell_renderer_get_fixed_size (GtkCellRenderer *cell,
699 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
702 (* width) = cell->width;
704 (* height) = cell->height;
708 * gtk_cell_renderer_editing_canceled:
709 * @cell: A #GtkCellRenderer
711 * Causes the cell renderer to emit the "editing-canceled" signal. This
712 * function is for use only by implementations of cell renderers that need to
713 * notify the client program that an editing process was canceled and the
714 * changes were not committed.
719 gtk_cell_renderer_editing_canceled (GtkCellRenderer *cell)
721 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
723 g_signal_emit (cell, cell_renderer_signals[EDITING_CANCELED], 0);