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;
119 gtk_cell_renderer_class_init (GtkCellRendererClass *class)
121 GObjectClass *object_class = G_OBJECT_CLASS (class);
123 object_class->get_property = gtk_cell_renderer_get_property;
124 object_class->set_property = gtk_cell_renderer_set_property;
126 class->render = NULL;
127 class->get_size = NULL;
130 * GtkCellRenderer::editing-canceled:
131 * @renderer: the object which received the signal
133 * This signal gets emitted when the user cancels the process of editing a
134 * cell. For example, an editable cell renderer could be written to cancel
135 * editing when the user presses Escape.
137 * See also: gtk_cell_renderer_editing_canceled()
142 cell_renderer_signals[EDITING_CANCELED] =
143 g_signal_new ("editing-canceled",
144 G_OBJECT_CLASS_TYPE (object_class),
146 G_STRUCT_OFFSET (GtkCellRendererClass, editing_canceled),
148 _gtk_marshal_VOID__VOID,
151 g_object_class_install_property (object_class,
153 g_param_spec_enum ("mode",
155 P_("Editable mode of the CellRenderer"),
156 GTK_TYPE_CELL_RENDERER_MODE,
157 GTK_CELL_RENDERER_MODE_INERT,
161 g_object_class_install_property (object_class,
163 g_param_spec_boolean ("visible",
165 P_("Display the cell"),
168 g_object_class_install_property (object_class,
170 g_param_spec_boolean ("sensitive",
172 P_("Display the cell sensitive"),
176 g_object_class_install_property (object_class,
178 g_param_spec_float ("xalign",
187 g_object_class_install_property (object_class,
189 g_param_spec_float ("yalign",
198 g_object_class_install_property (object_class,
200 g_param_spec_uint ("xpad",
209 g_object_class_install_property (object_class,
211 g_param_spec_uint ("ypad",
220 g_object_class_install_property (object_class,
222 g_param_spec_int ("width",
224 P_("The fixed width"),
231 g_object_class_install_property (object_class,
233 g_param_spec_int ("height",
235 P_("The fixed height"),
242 g_object_class_install_property (object_class,
244 g_param_spec_boolean ("is_expander",
246 P_("Row has children"),
252 g_object_class_install_property (object_class,
254 g_param_spec_boolean ("is_expanded",
256 P_("Row is an expander row, and is expanded"),
261 g_object_class_install_property (object_class,
262 PROP_CELL_BACKGROUND,
263 g_param_spec_string ("cell_background",
264 P_("Cell background color name"),
265 P_("Cell background color as a string"),
269 g_object_class_install_property (object_class,
270 PROP_CELL_BACKGROUND_GDK,
271 g_param_spec_boxed ("cell_background_gdk",
272 P_("Cell background color"),
273 P_("Cell background color as a GdkColor"),
275 G_PARAM_READABLE | G_PARAM_WRITABLE));
278 #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))
280 ADD_SET_PROP ("cell_background_set", PROP_CELL_BACKGROUND_SET,
281 P_("Cell background set"),
282 P_("Whether this tag affects the cell background color"));
284 g_type_class_add_private (object_class, sizeof (GtkCellRendererPrivate));
288 gtk_cell_renderer_get_property (GObject *object,
293 GtkCellRenderer *cell = GTK_CELL_RENDERER (object);
294 GtkCellRendererPrivate *priv = GTK_CELL_RENDERER_GET_PRIVATE (object);
299 g_value_set_enum (value, cell->mode);
302 g_value_set_boolean (value, cell->visible);
305 g_value_set_boolean (value, cell->sensitive);
308 g_value_set_float (value, cell->xalign);
311 g_value_set_float (value, cell->yalign);
314 g_value_set_uint (value, cell->xpad);
317 g_value_set_uint (value, cell->ypad);
320 g_value_set_int (value, cell->width);
323 g_value_set_int (value, cell->height);
325 case PROP_IS_EXPANDER:
326 g_value_set_boolean (value, cell->is_expander);
328 case PROP_IS_EXPANDED:
329 g_value_set_boolean (value, cell->is_expanded);
331 case PROP_CELL_BACKGROUND_GDK:
335 color.red = priv->cell_background.red;
336 color.green = priv->cell_background.green;
337 color.blue = priv->cell_background.blue;
339 g_value_set_boxed (value, &color);
342 case PROP_CELL_BACKGROUND_SET:
343 g_value_set_boolean (value, cell->cell_background_set);
345 case PROP_CELL_BACKGROUND:
347 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
354 gtk_cell_renderer_set_property (GObject *object,
359 GtkCellRenderer *cell = GTK_CELL_RENDERER (object);
364 cell->mode = g_value_get_enum (value);
367 cell->visible = g_value_get_boolean (value);
370 cell->sensitive = g_value_get_boolean (value);
373 cell->xalign = g_value_get_float (value);
376 cell->yalign = g_value_get_float (value);
379 cell->xpad = g_value_get_uint (value);
382 cell->ypad = g_value_get_uint (value);
385 cell->width = g_value_get_int (value);
388 cell->height = g_value_get_int (value);
390 case PROP_IS_EXPANDER:
391 cell->is_expander = g_value_get_boolean (value);
393 case PROP_IS_EXPANDED:
394 cell->is_expanded = g_value_get_boolean (value);
396 case PROP_CELL_BACKGROUND:
400 if (!g_value_get_string (value))
401 set_cell_bg_color (cell, NULL);
402 else if (gdk_color_parse (g_value_get_string (value), &color))
403 set_cell_bg_color (cell, &color);
405 g_warning ("Don't know color `%s'", g_value_get_string (value));
407 g_object_notify (object, "cell_background_gdk");
410 case PROP_CELL_BACKGROUND_GDK:
411 set_cell_bg_color (cell, g_value_get_boxed (value));
413 case PROP_CELL_BACKGROUND_SET:
414 cell->cell_background_set = g_value_get_boolean (value);
417 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
423 set_cell_bg_color (GtkCellRenderer *cell,
426 GtkCellRendererPrivate *priv = GTK_CELL_RENDERER_GET_PRIVATE (cell);
430 if (!cell->cell_background_set)
432 cell->cell_background_set = TRUE;
433 g_object_notify (G_OBJECT (cell), "cell_background_set");
436 priv->cell_background.red = color->red;
437 priv->cell_background.green = color->green;
438 priv->cell_background.blue = color->blue;
442 if (cell->cell_background_set)
444 cell->cell_background_set = FALSE;
445 g_object_notify (G_OBJECT (cell), "cell_background_set");
451 * gtk_cell_renderer_get_size:
452 * @cell: a #GtkCellRenderer
453 * @widget: the widget the renderer is rendering to
454 * @cell_area: The area a cell will be allocated, or %NULL
455 * @x_offset: location to return x offset of cell relative to @cell_area, or %NULL
456 * @y_offset: location to return y offset of cell relative to @cell_area, or %NULL
457 * @width: location to return width needed to render a cell, or %NULL
458 * @height: location to return height needed to render a cell, or %NULL
460 * Obtains the width and height needed to render the cell. Used by view widgets
461 * to determine the appropriate size for the cell_area passed to
462 * gtk_cell_renderer_render(). If @cell_area is not %NULL, fills in the x and y
463 * offsets (if set) of the cell relative to this location. Please note that the
464 * values set in @width and @height, as well as those in @x_offset and @y_offset
465 * are inclusive of the xpad and ypad properties.
468 gtk_cell_renderer_get_size (GtkCellRenderer *cell,
470 GdkRectangle *cell_area,
476 gint *real_width = width;
477 gint *real_height = height;
479 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
480 g_return_if_fail (GTK_CELL_RENDERER_GET_CLASS (cell)->get_size != NULL);
482 if (width && cell->width != -1)
485 *width = cell->width;
487 if (height && cell->height != -1)
490 *height = cell->height;
493 GTK_CELL_RENDERER_GET_CLASS (cell)->get_size (cell,
503 * gtk_cell_renderer_render:
504 * @cell: a #GtkCellRenderer
505 * @window: a #GdkDrawable to draw to
506 * @widget: the widget owning @window
507 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
508 * @cell_area: area normally rendered by a cell renderer
509 * @expose_area: area that actually needs updating
510 * @flags: flags that affect rendering
512 * Invokes the virtual render function of the #GtkCellRenderer. The three
513 * passed-in rectangles are areas of @window. Most renderers will draw within
514 * @cell_area; the xalign, yalign, xpad, and ypad fields of the #GtkCellRenderer
515 * should be honored with respect to @cell_area. @background_area includes the
516 * blank space around the cell, and also the area containing the tree expander;
517 * so the @background_area rectangles for all cells tile to cover the entire
518 * @window. @expose_area is a clip rectangle.
522 gtk_cell_renderer_render (GtkCellRenderer *cell,
525 GdkRectangle *background_area,
526 GdkRectangle *cell_area,
527 GdkRectangle *expose_area,
528 GtkCellRendererState flags)
530 gboolean selected = FALSE;
531 GtkCellRendererPrivate *priv = GTK_CELL_RENDERER_GET_PRIVATE (cell);
533 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
534 g_return_if_fail (GTK_CELL_RENDERER_GET_CLASS (cell)->render != NULL);
536 selected = (flags & GTK_CELL_RENDERER_SELECTED) == GTK_CELL_RENDERER_SELECTED;
538 if (cell->cell_background_set && !selected)
543 color.red = priv->cell_background.red;
544 color.green = priv->cell_background.green;
545 color.blue = priv->cell_background.blue;
547 gc = gdk_gc_new (window);
548 gdk_gc_set_rgb_fg_color (gc, &color);
549 gdk_draw_rectangle (window, gc, TRUE,
550 background_area->x, background_area->y,
551 background_area->width, background_area->height);
555 GTK_CELL_RENDERER_GET_CLASS (cell)->render (cell,
565 * gtk_cell_renderer_activate:
566 * @cell: a #GtkCellRenderer
567 * @event: a #GdkEvent
568 * @widget: widget that received the event
569 * @path: widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath
570 * @background_area: background area as passed to @gtk_cell_renderer_render
571 * @cell_area: cell area as passed to @gtk_cell_renderer_render
572 * @flags: render flags
574 * Passes an activate event to the cell renderer for possible processing. Some
575 * cell renderers may use events; for example, #GtkCellRendererToggle toggles
576 * when it gets a mouse click.
578 * Return value: %TRUE if the event was consumed/handled
581 gtk_cell_renderer_activate (GtkCellRenderer *cell,
585 GdkRectangle *background_area,
586 GdkRectangle *cell_area,
587 GtkCellRendererState flags)
589 g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell), FALSE);
591 if (cell->mode != GTK_CELL_RENDERER_MODE_ACTIVATABLE)
594 if (GTK_CELL_RENDERER_GET_CLASS (cell)->activate == NULL)
597 return GTK_CELL_RENDERER_GET_CLASS (cell)->activate (cell,
607 * gtk_cell_renderer_start_editing:
608 * @cell: a #GtkCellRenderer
609 * @event: a #GdkEvent
610 * @widget: widget that received the event
611 * @path: widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath
612 * @background_area: background area as passed to @gtk_cell_renderer_render
613 * @cell_area: cell area as passed to @gtk_cell_renderer_render
614 * @flags: render flags
616 * Passes an activate event to the cell renderer for possible processing.
618 * Return value: A new #GtkCellEditable, or %NULL
621 gtk_cell_renderer_start_editing (GtkCellRenderer *cell,
625 GdkRectangle *background_area,
626 GdkRectangle *cell_area,
627 GtkCellRendererState flags)
630 g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell), NULL);
632 if (cell->mode != GTK_CELL_RENDERER_MODE_EDITABLE)
635 if (GTK_CELL_RENDERER_GET_CLASS (cell)->start_editing == NULL)
639 return GTK_CELL_RENDERER_GET_CLASS (cell)->start_editing (cell,
649 * gtk_cell_renderer_set_fixed_size:
650 * @cell: A #GtkCellRenderer
651 * @width: the width of the cell renderer, or -1
652 * @height: the height of the cell renderer, or -1
654 * Sets the renderer size to be explicit, independent of the properties set.
657 gtk_cell_renderer_set_fixed_size (GtkCellRenderer *cell,
661 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
662 g_return_if_fail (width >= -1 && height >= -1);
664 if ((width != cell->width) || (height != cell->height))
666 g_object_freeze_notify (G_OBJECT (cell));
668 if (width != cell->width)
671 g_object_notify (G_OBJECT (cell), "width");
674 if (height != cell->height)
676 cell->height = height;
677 g_object_notify (G_OBJECT (cell), "height");
680 g_object_thaw_notify (G_OBJECT (cell));
685 * gtk_cell_renderer_get_fixed_size:
686 * @cell: A #GtkCellRenderer
687 * @width: location to fill in with the fixed width of the widget, or %NULL
688 * @height: location to fill in with the fixed height of the widget, or %NULL
690 * Fills in @width and @height with the appropriate size of @cell.
693 gtk_cell_renderer_get_fixed_size (GtkCellRenderer *cell,
697 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
700 (* width) = cell->width;
702 (* height) = cell->height;
706 * gtk_cell_renderer_editing_canceled:
707 * @cell: A #GtkCellRenderer
709 * Causes the cell renderer to emit the "editing-canceled" signal. This
710 * function is for use only by implementations of cell renderers that need to
711 * notify the client program that an editing process was canceled and the
712 * changes were not committed.
717 gtk_cell_renderer_editing_canceled (GtkCellRenderer *cell)
719 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
721 g_signal_emit (cell, cell_renderer_signals[EDITING_CANCELED], 0);