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
74 static guint cell_renderer_signals[LAST_SIGNAL] = { 0 };
78 gtk_cell_renderer_get_type (void)
80 static GType cell_type = 0;
84 static const GTypeInfo cell_info =
86 sizeof (GtkCellRendererClass),
88 NULL, /* base_finalize */
89 (GClassInitFunc) gtk_cell_renderer_class_init,
90 NULL, /* class_finalize */
91 NULL, /* class_data */
92 sizeof (GtkCellRenderer),
94 (GInstanceInitFunc) gtk_cell_renderer_init,
95 NULL, /* value_table */
98 cell_type = g_type_register_static (GTK_TYPE_OBJECT, "GtkCellRenderer",
99 &cell_info, G_TYPE_FLAG_ABSTRACT);
106 gtk_cell_renderer_init (GtkCellRenderer *cell)
108 cell->mode = GTK_CELL_RENDERER_MODE_INERT;
109 cell->visible = TRUE;
116 cell->sensitive = TRUE;
117 cell->is_expander = FALSE;
118 cell->is_expanded = FALSE;
122 gtk_cell_renderer_class_init (GtkCellRendererClass *class)
124 GObjectClass *object_class = G_OBJECT_CLASS (class);
126 object_class->get_property = gtk_cell_renderer_get_property;
127 object_class->set_property = gtk_cell_renderer_set_property;
129 class->render = NULL;
130 class->get_size = NULL;
133 * GtkCellRenderer::editing-canceled:
134 * @renderer: the object which received the signal
136 * This signal gets emitted when the user cancels the process of editing a
137 * cell. For example, an editable cell renderer could be written to cancel
138 * editing when the user presses Escape.
140 * 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,
154 * GtkCellRenderer::editing-started:
155 * @renderer: the object which received the signal
156 * @editable: the #GtkCellEditable
157 * @path: the path identifying the edited cell
159 * This signal gets emitted when a cell starts to be edited.
160 * The indended use of this signal is to do special setup
161 * on @editable, e.g. adding a #GtkEntryCompletion or setting
162 * up additional columns in a #GtkComboBox.
164 * Note that GTK+ doesn't guarantee that cell renderers will
165 * continue to use the same kind of widget for editing in future
166 * releases, therefore you should check the type of @editable
167 * before doing any specific setup, as in the following example:
169 * <informalexample><programlisting>
171 * text_editing_started (GtkCellRenderer *cell,
172 * GtkCellEditable *editable,
176 * if (GTK_IS_ENTRY (editable))
178 * GtkEntry *entry = GTK_ENTRY (editable);
180 * /* ... create a GtkEntryCompletion *<!-- -->/
182 * gtk_entry_set_completion (entry, completion);
185 * </programlisting></informalexample>
189 cell_renderer_signals[EDITING_STARTED] =
190 g_signal_new ("editing-started",
191 G_OBJECT_CLASS_TYPE (object_class),
193 G_STRUCT_OFFSET (GtkCellRendererClass, editing_started),
195 _gtk_marshal_VOID__OBJECT_STRING,
197 GTK_TYPE_CELL_EDITABLE,
200 g_object_class_install_property (object_class,
202 g_param_spec_enum ("mode",
204 P_("Editable mode of the CellRenderer"),
205 GTK_TYPE_CELL_RENDERER_MODE,
206 GTK_CELL_RENDERER_MODE_INERT,
210 g_object_class_install_property (object_class,
212 g_param_spec_boolean ("visible",
214 P_("Display the cell"),
217 g_object_class_install_property (object_class,
219 g_param_spec_boolean ("sensitive",
221 P_("Display the cell sensitive"),
225 g_object_class_install_property (object_class,
227 g_param_spec_float ("xalign",
236 g_object_class_install_property (object_class,
238 g_param_spec_float ("yalign",
247 g_object_class_install_property (object_class,
249 g_param_spec_uint ("xpad",
258 g_object_class_install_property (object_class,
260 g_param_spec_uint ("ypad",
269 g_object_class_install_property (object_class,
271 g_param_spec_int ("width",
273 P_("The fixed width"),
280 g_object_class_install_property (object_class,
282 g_param_spec_int ("height",
284 P_("The fixed height"),
291 g_object_class_install_property (object_class,
293 g_param_spec_boolean ("is_expander",
295 P_("Row has children"),
301 g_object_class_install_property (object_class,
303 g_param_spec_boolean ("is_expanded",
305 P_("Row is an expander row, and is expanded"),
310 g_object_class_install_property (object_class,
311 PROP_CELL_BACKGROUND,
312 g_param_spec_string ("cell_background",
313 P_("Cell background color name"),
314 P_("Cell background color as a string"),
318 g_object_class_install_property (object_class,
319 PROP_CELL_BACKGROUND_GDK,
320 g_param_spec_boxed ("cell_background_gdk",
321 P_("Cell background color"),
322 P_("Cell background color as a GdkColor"),
324 G_PARAM_READABLE | G_PARAM_WRITABLE));
327 #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))
329 ADD_SET_PROP ("cell_background_set", PROP_CELL_BACKGROUND_SET,
330 P_("Cell background set"),
331 P_("Whether this tag affects the cell background color"));
333 g_type_class_add_private (object_class, sizeof (GtkCellRendererPrivate));
337 gtk_cell_renderer_get_property (GObject *object,
342 GtkCellRenderer *cell = GTK_CELL_RENDERER (object);
343 GtkCellRendererPrivate *priv = GTK_CELL_RENDERER_GET_PRIVATE (object);
348 g_value_set_enum (value, cell->mode);
351 g_value_set_boolean (value, cell->visible);
354 g_value_set_boolean (value, cell->sensitive);
357 g_value_set_float (value, cell->xalign);
360 g_value_set_float (value, cell->yalign);
363 g_value_set_uint (value, cell->xpad);
366 g_value_set_uint (value, cell->ypad);
369 g_value_set_int (value, cell->width);
372 g_value_set_int (value, cell->height);
374 case PROP_IS_EXPANDER:
375 g_value_set_boolean (value, cell->is_expander);
377 case PROP_IS_EXPANDED:
378 g_value_set_boolean (value, cell->is_expanded);
380 case PROP_CELL_BACKGROUND_GDK:
384 color.red = priv->cell_background.red;
385 color.green = priv->cell_background.green;
386 color.blue = priv->cell_background.blue;
388 g_value_set_boxed (value, &color);
391 case PROP_CELL_BACKGROUND_SET:
392 g_value_set_boolean (value, cell->cell_background_set);
394 case PROP_CELL_BACKGROUND:
396 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
403 gtk_cell_renderer_set_property (GObject *object,
408 GtkCellRenderer *cell = GTK_CELL_RENDERER (object);
413 cell->mode = g_value_get_enum (value);
416 cell->visible = g_value_get_boolean (value);
419 cell->sensitive = g_value_get_boolean (value);
422 cell->xalign = g_value_get_float (value);
425 cell->yalign = g_value_get_float (value);
428 cell->xpad = g_value_get_uint (value);
431 cell->ypad = g_value_get_uint (value);
434 cell->width = g_value_get_int (value);
437 cell->height = g_value_get_int (value);
439 case PROP_IS_EXPANDER:
440 cell->is_expander = g_value_get_boolean (value);
442 case PROP_IS_EXPANDED:
443 cell->is_expanded = g_value_get_boolean (value);
445 case PROP_CELL_BACKGROUND:
449 if (!g_value_get_string (value))
450 set_cell_bg_color (cell, NULL);
451 else if (gdk_color_parse (g_value_get_string (value), &color))
452 set_cell_bg_color (cell, &color);
454 g_warning ("Don't know color `%s'", g_value_get_string (value));
456 g_object_notify (object, "cell_background_gdk");
459 case PROP_CELL_BACKGROUND_GDK:
460 set_cell_bg_color (cell, g_value_get_boxed (value));
462 case PROP_CELL_BACKGROUND_SET:
463 cell->cell_background_set = g_value_get_boolean (value);
466 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
472 set_cell_bg_color (GtkCellRenderer *cell,
475 GtkCellRendererPrivate *priv = GTK_CELL_RENDERER_GET_PRIVATE (cell);
479 if (!cell->cell_background_set)
481 cell->cell_background_set = TRUE;
482 g_object_notify (G_OBJECT (cell), "cell_background_set");
485 priv->cell_background.red = color->red;
486 priv->cell_background.green = color->green;
487 priv->cell_background.blue = color->blue;
491 if (cell->cell_background_set)
493 cell->cell_background_set = FALSE;
494 g_object_notify (G_OBJECT (cell), "cell_background_set");
500 * gtk_cell_renderer_get_size:
501 * @cell: a #GtkCellRenderer
502 * @widget: the widget the renderer is rendering to
503 * @cell_area: The area a cell will be allocated, or %NULL
504 * @x_offset: location to return x offset of cell relative to @cell_area, or %NULL
505 * @y_offset: location to return y offset of cell relative to @cell_area, or %NULL
506 * @width: location to return width needed to render a cell, or %NULL
507 * @height: location to return height needed to render a cell, or %NULL
509 * Obtains the width and height needed to render the cell. Used by view widgets
510 * to determine the appropriate size for the cell_area passed to
511 * gtk_cell_renderer_render(). If @cell_area is not %NULL, fills in the x and y
512 * offsets (if set) of the cell relative to this location. Please note that the
513 * values set in @width and @height, as well as those in @x_offset and @y_offset
514 * are inclusive of the xpad and ypad properties.
517 gtk_cell_renderer_get_size (GtkCellRenderer *cell,
519 GdkRectangle *cell_area,
525 gint *real_width = width;
526 gint *real_height = height;
528 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
529 g_return_if_fail (GTK_CELL_RENDERER_GET_CLASS (cell)->get_size != NULL);
531 if (width && cell->width != -1)
534 *width = cell->width;
536 if (height && cell->height != -1)
539 *height = cell->height;
542 GTK_CELL_RENDERER_GET_CLASS (cell)->get_size (cell,
552 * gtk_cell_renderer_render:
553 * @cell: a #GtkCellRenderer
554 * @window: a #GdkDrawable to draw to
555 * @widget: the widget owning @window
556 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
557 * @cell_area: area normally rendered by a cell renderer
558 * @expose_area: area that actually needs updating
559 * @flags: flags that affect rendering
561 * Invokes the virtual render function of the #GtkCellRenderer. The three
562 * passed-in rectangles are areas of @window. Most renderers will draw within
563 * @cell_area; the xalign, yalign, xpad, and ypad fields of the #GtkCellRenderer
564 * should be honored with respect to @cell_area. @background_area includes the
565 * blank space around the cell, and also the area containing the tree expander;
566 * so the @background_area rectangles for all cells tile to cover the entire
567 * @window. @expose_area is a clip rectangle.
571 gtk_cell_renderer_render (GtkCellRenderer *cell,
574 GdkRectangle *background_area,
575 GdkRectangle *cell_area,
576 GdkRectangle *expose_area,
577 GtkCellRendererState flags)
579 gboolean selected = FALSE;
580 GtkCellRendererPrivate *priv = GTK_CELL_RENDERER_GET_PRIVATE (cell);
582 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
583 g_return_if_fail (GTK_CELL_RENDERER_GET_CLASS (cell)->render != NULL);
585 selected = (flags & GTK_CELL_RENDERER_SELECTED) == GTK_CELL_RENDERER_SELECTED;
587 if (cell->cell_background_set && !selected)
592 color.red = priv->cell_background.red;
593 color.green = priv->cell_background.green;
594 color.blue = priv->cell_background.blue;
596 gc = gdk_gc_new (window);
597 gdk_gc_set_rgb_fg_color (gc, &color);
598 gdk_draw_rectangle (window, gc, TRUE,
599 background_area->x, background_area->y,
600 background_area->width, background_area->height);
604 GTK_CELL_RENDERER_GET_CLASS (cell)->render (cell,
614 * gtk_cell_renderer_activate:
615 * @cell: a #GtkCellRenderer
616 * @event: a #GdkEvent
617 * @widget: widget that received the event
618 * @path: widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath
619 * @background_area: background area as passed to @gtk_cell_renderer_render
620 * @cell_area: cell area as passed to @gtk_cell_renderer_render
621 * @flags: render flags
623 * Passes an activate event to the cell renderer for possible processing. Some
624 * cell renderers may use events; for example, #GtkCellRendererToggle toggles
625 * when it gets a mouse click.
627 * Return value: %TRUE if the event was consumed/handled
630 gtk_cell_renderer_activate (GtkCellRenderer *cell,
634 GdkRectangle *background_area,
635 GdkRectangle *cell_area,
636 GtkCellRendererState flags)
638 g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell), FALSE);
640 if (cell->mode != GTK_CELL_RENDERER_MODE_ACTIVATABLE)
643 if (GTK_CELL_RENDERER_GET_CLASS (cell)->activate == NULL)
646 return GTK_CELL_RENDERER_GET_CLASS (cell)->activate (cell,
656 * gtk_cell_renderer_start_editing:
657 * @cell: a #GtkCellRenderer
658 * @event: a #GdkEvent
659 * @widget: widget that received the event
660 * @path: widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath
661 * @background_area: background area as passed to @gtk_cell_renderer_render
662 * @cell_area: cell area as passed to @gtk_cell_renderer_render
663 * @flags: render flags
665 * Passes an activate event to the cell renderer for possible processing.
667 * Return value: A new #GtkCellEditable, or %NULL
670 gtk_cell_renderer_start_editing (GtkCellRenderer *cell,
674 GdkRectangle *background_area,
675 GdkRectangle *cell_area,
676 GtkCellRendererState flags)
679 GtkCellEditable *editable;
681 g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell), NULL);
683 if (cell->mode != GTK_CELL_RENDERER_MODE_EDITABLE)
686 if (GTK_CELL_RENDERER_GET_CLASS (cell)->start_editing == NULL)
690 editable = GTK_CELL_RENDERER_GET_CLASS (cell)->start_editing (cell,
699 cell_renderer_signals[EDITING_STARTED], 0,
706 * gtk_cell_renderer_set_fixed_size:
707 * @cell: A #GtkCellRenderer
708 * @width: the width of the cell renderer, or -1
709 * @height: the height of the cell renderer, or -1
711 * Sets the renderer size to be explicit, independent of the properties set.
714 gtk_cell_renderer_set_fixed_size (GtkCellRenderer *cell,
718 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
719 g_return_if_fail (width >= -1 && height >= -1);
721 if ((width != cell->width) || (height != cell->height))
723 g_object_freeze_notify (G_OBJECT (cell));
725 if (width != cell->width)
728 g_object_notify (G_OBJECT (cell), "width");
731 if (height != cell->height)
733 cell->height = height;
734 g_object_notify (G_OBJECT (cell), "height");
737 g_object_thaw_notify (G_OBJECT (cell));
742 * gtk_cell_renderer_get_fixed_size:
743 * @cell: A #GtkCellRenderer
744 * @width: location to fill in with the fixed width of the widget, or %NULL
745 * @height: location to fill in with the fixed height of the widget, or %NULL
747 * Fills in @width and @height with the appropriate size of @cell.
750 gtk_cell_renderer_get_fixed_size (GtkCellRenderer *cell,
754 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
757 (* width) = cell->width;
759 (* height) = cell->height;
763 * gtk_cell_renderer_editing_canceled:
764 * @cell: A #GtkCellRenderer
766 * Causes the cell renderer to emit the "editing-canceled" signal. This
767 * function is for use only by implementations of cell renderers that need to
768 * notify the client program that an editing process was canceled and the
769 * changes were not committed.
774 gtk_cell_renderer_editing_canceled (GtkCellRenderer *cell)
776 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
778 g_signal_emit (cell, cell_renderer_signals[EDITING_CANCELED], 0);