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;
62 PROP_CELL_BACKGROUND_GDK,
63 PROP_CELL_BACKGROUND_SET
72 static guint cell_renderer_signals[LAST_SIGNAL] = { 0 };
76 gtk_cell_renderer_get_type (void)
78 static GType cell_type = 0;
82 static const GTypeInfo cell_info =
84 sizeof (GtkCellRendererClass),
86 NULL, /* base_finalize */
87 (GClassInitFunc) gtk_cell_renderer_class_init,
88 NULL, /* class_finalize */
89 NULL, /* class_data */
90 sizeof (GtkCellRenderer),
92 (GInstanceInitFunc) gtk_cell_renderer_init,
93 NULL, /* value_table */
96 cell_type = g_type_register_static (GTK_TYPE_OBJECT, "GtkCellRenderer",
97 &cell_info, G_TYPE_FLAG_ABSTRACT);
104 gtk_cell_renderer_init (GtkCellRenderer *cell)
106 cell->mode = GTK_CELL_RENDERER_MODE_INERT;
107 cell->visible = TRUE;
117 gtk_cell_renderer_class_init (GtkCellRendererClass *class)
119 GObjectClass *object_class = G_OBJECT_CLASS (class);
121 object_class->get_property = gtk_cell_renderer_get_property;
122 object_class->set_property = gtk_cell_renderer_set_property;
124 class->render = NULL;
125 class->get_size = NULL;
128 * GtkCellRenderer::editing-canceled:
130 * This signal gets emitted when the user cancels the process of editing a
131 * cell. For example, an editable cell renderer could be written to cancel
132 * editing when the user presses Escape.
134 * See also: gtk_cell_renderer_editing_canceled()
139 cell_renderer_signals[EDITING_CANCELED] =
140 g_signal_new ("editing-canceled",
141 G_OBJECT_CLASS_TYPE (object_class),
143 G_STRUCT_OFFSET (GtkCellRendererClass, editing_canceled),
145 _gtk_marshal_VOID__VOID,
148 g_object_class_install_property (object_class,
150 g_param_spec_enum ("mode",
152 P_("Editable mode of the CellRenderer"),
153 GTK_TYPE_CELL_RENDERER_MODE,
154 GTK_CELL_RENDERER_MODE_INERT,
158 g_object_class_install_property (object_class,
160 g_param_spec_boolean ("visible",
162 P_("Display the cell"),
167 g_object_class_install_property (object_class,
169 g_param_spec_float ("xalign",
178 g_object_class_install_property (object_class,
180 g_param_spec_float ("yalign",
189 g_object_class_install_property (object_class,
191 g_param_spec_uint ("xpad",
200 g_object_class_install_property (object_class,
202 g_param_spec_uint ("ypad",
211 g_object_class_install_property (object_class,
213 g_param_spec_int ("width",
215 P_("The fixed width"),
222 g_object_class_install_property (object_class,
224 g_param_spec_int ("height",
226 P_("The fixed height"),
233 g_object_class_install_property (object_class,
235 g_param_spec_boolean ("is_expander",
237 P_("Row has children"),
243 g_object_class_install_property (object_class,
245 g_param_spec_boolean ("is_expanded",
247 P_("Row is an expander row, and is expanded"),
252 g_object_class_install_property (object_class,
253 PROP_CELL_BACKGROUND,
254 g_param_spec_string ("cell_background",
255 P_("Cell background color name"),
256 P_("Cell background color as a string"),
260 g_object_class_install_property (object_class,
261 PROP_CELL_BACKGROUND_GDK,
262 g_param_spec_boxed ("cell_background_gdk",
263 P_("Cell background color"),
264 P_("Cell background color as a GdkColor"),
266 G_PARAM_READABLE | G_PARAM_WRITABLE));
269 #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))
271 ADD_SET_PROP ("cell_background_set", PROP_CELL_BACKGROUND_SET,
272 P_("Cell background set"),
273 P_("Whether this tag affects the cell background color"));
275 g_type_class_add_private (object_class, sizeof (GtkCellRendererPrivate));
279 gtk_cell_renderer_get_property (GObject *object,
284 GtkCellRenderer *cell = GTK_CELL_RENDERER (object);
285 GtkCellRendererPrivate *priv = GTK_CELL_RENDERER_GET_PRIVATE (object);
290 g_value_set_enum (value, cell->mode);
293 g_value_set_boolean (value, cell->visible);
296 g_value_set_float (value, cell->xalign);
299 g_value_set_float (value, cell->yalign);
302 g_value_set_uint (value, cell->xpad);
305 g_value_set_uint (value, cell->ypad);
308 g_value_set_int (value, cell->width);
311 g_value_set_int (value, cell->height);
313 case PROP_IS_EXPANDER:
314 g_value_set_boolean (value, cell->is_expander);
316 case PROP_IS_EXPANDED:
317 g_value_set_boolean (value, cell->is_expanded);
319 case PROP_CELL_BACKGROUND_GDK:
323 color.red = priv->cell_background.red;
324 color.green = priv->cell_background.green;
325 color.blue = priv->cell_background.blue;
327 g_value_set_boxed (value, &color);
330 case PROP_CELL_BACKGROUND_SET:
331 g_value_set_boolean (value, cell->cell_background_set);
333 case PROP_CELL_BACKGROUND:
335 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
342 gtk_cell_renderer_set_property (GObject *object,
347 GtkCellRenderer *cell = GTK_CELL_RENDERER (object);
352 cell->mode = g_value_get_enum (value);
355 cell->visible = g_value_get_boolean (value);
358 cell->xalign = g_value_get_float (value);
361 cell->yalign = g_value_get_float (value);
364 cell->xpad = g_value_get_uint (value);
367 cell->ypad = g_value_get_uint (value);
370 cell->width = g_value_get_int (value);
373 cell->height = g_value_get_int (value);
375 case PROP_IS_EXPANDER:
376 cell->is_expander = g_value_get_boolean (value);
378 case PROP_IS_EXPANDED:
379 cell->is_expanded = g_value_get_boolean (value);
381 case PROP_CELL_BACKGROUND:
385 if (!g_value_get_string (value))
386 set_cell_bg_color (cell, NULL);
387 else if (gdk_color_parse (g_value_get_string (value), &color))
388 set_cell_bg_color (cell, &color);
390 g_warning ("Don't know color `%s'", g_value_get_string (value));
392 g_object_notify (object, "cell_background_gdk");
395 case PROP_CELL_BACKGROUND_GDK:
396 set_cell_bg_color (cell, g_value_get_boxed (value));
398 case PROP_CELL_BACKGROUND_SET:
399 cell->cell_background_set = g_value_get_boolean (value);
402 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
408 set_cell_bg_color (GtkCellRenderer *cell,
411 GtkCellRendererPrivate *priv = GTK_CELL_RENDERER_GET_PRIVATE (cell);
415 if (!cell->cell_background_set)
417 cell->cell_background_set = TRUE;
418 g_object_notify (G_OBJECT (cell), "cell_background_set");
421 priv->cell_background.red = color->red;
422 priv->cell_background.green = color->green;
423 priv->cell_background.blue = color->blue;
427 if (cell->cell_background_set)
429 cell->cell_background_set = FALSE;
430 g_object_notify (G_OBJECT (cell), "cell_background_set");
436 * gtk_cell_renderer_get_size:
437 * @cell: a #GtkCellRenderer
438 * @widget: the widget the renderer is rendering to
439 * @cell_area: The area a cell will be allocated, or %NULL
440 * @x_offset: location to return x offset of cell relative to @cell_area, or %NULL
441 * @y_offset: location to return y offset of cell relative to @cell_area, or %NULL
442 * @width: location to return width needed to render a cell, or %NULL
443 * @height: location to return height needed to render a cell, or %NULL
445 * Obtains the width and height needed to render the cell. Used by view widgets
446 * to determine the appropriate size for the cell_area passed to
447 * gtk_cell_renderer_render(). If @cell_area is not %NULL, fills in the x and y
448 * offsets (if set) of the cell relative to this location. Please note that the
449 * values set in @width and @height, as well as those in @x_offset and @y_offset
450 * are inclusive of the xpad and ypad properties.
453 gtk_cell_renderer_get_size (GtkCellRenderer *cell,
455 GdkRectangle *cell_area,
461 gint *real_width = width;
462 gint *real_height = height;
464 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
465 g_return_if_fail (GTK_CELL_RENDERER_GET_CLASS (cell)->get_size != NULL);
467 if (width && cell->width != -1)
470 *width = cell->width;
472 if (height && cell->height != -1)
475 *height = cell->height;
478 GTK_CELL_RENDERER_GET_CLASS (cell)->get_size (cell,
488 * gtk_cell_renderer_render:
489 * @cell: a #GtkCellRenderer
490 * @window: a #GdkDrawable to draw to
491 * @widget: the widget owning @window
492 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
493 * @cell_area: area normally rendered by a cell renderer
494 * @expose_area: area that actually needs updating
495 * @flags: flags that affect rendering
497 * Invokes the virtual render function of the #GtkCellRenderer. The three
498 * passed-in rectangles are areas of @window. Most renderers will draw within
499 * @cell_area; the xalign, yalign, xpad, and ypad fields of the #GtkCellRenderer
500 * should be honored with respect to @cell_area. @background_area includes the
501 * blank space around the cell, and also the area containing the tree expander;
502 * so the @background_area rectangles for all cells tile to cover the entire
503 * @window. @expose_area is a clip rectangle.
507 gtk_cell_renderer_render (GtkCellRenderer *cell,
510 GdkRectangle *background_area,
511 GdkRectangle *cell_area,
512 GdkRectangle *expose_area,
513 GtkCellRendererState flags)
515 gboolean selected = FALSE;
516 GtkCellRendererPrivate *priv = GTK_CELL_RENDERER_GET_PRIVATE (cell);
518 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
519 g_return_if_fail (GTK_CELL_RENDERER_GET_CLASS (cell)->render != NULL);
521 selected = (flags & GTK_CELL_RENDERER_SELECTED) == GTK_CELL_RENDERER_SELECTED;
523 if (cell->cell_background_set && !selected)
528 color.red = priv->cell_background.red;
529 color.green = priv->cell_background.green;
530 color.blue = priv->cell_background.blue;
532 gc = gdk_gc_new (window);
533 gdk_gc_set_rgb_fg_color (gc, &color);
534 gdk_draw_rectangle (window, gc, TRUE,
535 background_area->x, background_area->y,
536 background_area->width, background_area->height);
540 GTK_CELL_RENDERER_GET_CLASS (cell)->render (cell,
550 * gtk_cell_renderer_activate:
551 * @cell: a #GtkCellRenderer
552 * @event: a #GdkEvent
553 * @widget: widget that received the event
554 * @path: widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath
555 * @background_area: background area as passed to @gtk_cell_renderer_render
556 * @cell_area: cell area as passed to @gtk_cell_renderer_render
557 * @flags: render flags
559 * Passes an activate event to the cell renderer for possible processing. Some
560 * cell renderers may use events; for example, #GtkCellRendererToggle toggles
561 * when it gets a mouse click.
563 * Return value: %TRUE if the event was consumed/handled
566 gtk_cell_renderer_activate (GtkCellRenderer *cell,
570 GdkRectangle *background_area,
571 GdkRectangle *cell_area,
572 GtkCellRendererState flags)
574 g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell), FALSE);
576 if (cell->mode != GTK_CELL_RENDERER_MODE_ACTIVATABLE)
579 if (GTK_CELL_RENDERER_GET_CLASS (cell)->activate == NULL)
582 return GTK_CELL_RENDERER_GET_CLASS (cell)->activate (cell,
592 * gtk_cell_renderer_start_editing:
593 * @cell: a #GtkCellRenderer
594 * @event: a #GdkEvent
595 * @widget: widget that received the event
596 * @path: widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath
597 * @background_area: background area as passed to @gtk_cell_renderer_render
598 * @cell_area: cell area as passed to @gtk_cell_renderer_render
599 * @flags: render flags
601 * Passes an activate event to the cell renderer for possible processing.
603 * Return value: A new #GtkCellEditable, or %NULL
606 gtk_cell_renderer_start_editing (GtkCellRenderer *cell,
610 GdkRectangle *background_area,
611 GdkRectangle *cell_area,
612 GtkCellRendererState flags)
615 g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell), NULL);
617 if (cell->mode != GTK_CELL_RENDERER_MODE_EDITABLE)
620 if (GTK_CELL_RENDERER_GET_CLASS (cell)->start_editing == NULL)
624 return GTK_CELL_RENDERER_GET_CLASS (cell)->start_editing (cell,
634 * gtk_cell_renderer_set_fixed_size:
635 * @cell: A #GtkCellRenderer
636 * @width: the width of the cell renderer, or -1
637 * @height: the height of the cell renderer, or -1
639 * Sets the renderer size to be explicit, independent of the properties set.
642 gtk_cell_renderer_set_fixed_size (GtkCellRenderer *cell,
646 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
647 g_return_if_fail (width >= -1 && height >= -1);
649 if ((width != cell->width) || (height != cell->height))
651 g_object_freeze_notify (G_OBJECT (cell));
653 if (width != cell->width)
656 g_object_notify (G_OBJECT (cell), "width");
659 if (height != cell->height)
661 cell->height = height;
662 g_object_notify (G_OBJECT (cell), "height");
665 g_object_thaw_notify (G_OBJECT (cell));
670 * gtk_cell_renderer_get_fixed_size:
671 * @cell: A #GtkCellRenderer
672 * @width: location to fill in with the fixed width of the widget, or %NULL
673 * @height: location to fill in with the fixed height of the widget, or %NULL
675 * Fills in @width and @height with the appropriate size of @cell.
678 gtk_cell_renderer_get_fixed_size (GtkCellRenderer *cell,
682 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
685 (* width) = cell->width;
687 (* height) = cell->height;
691 * gtk_cell_renderer_editing_canceled:
692 * @cell: A #GtkCellRenderer
694 * Causes the cell renderer to emit the "editing-canceled" signal. This
695 * function is for use only by implementations of cell renderers that need to
696 * notify the client program that an editing process was canceled and the
697 * changes were not committed.
702 gtk_cell_renderer_editing_canceled (GtkCellRenderer *cell)
704 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
706 g_signal_emit (cell, cell_renderer_signals[EDITING_CANCELED], 0);