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.
22 #include "gtkcellrenderer.h"
24 #include "gtkmarshalers.h"
25 #include "gtktreeprivate.h"
27 static void gtk_cell_renderer_init (GtkCellRenderer *cell);
28 static void gtk_cell_renderer_class_init (GtkCellRendererClass *class);
29 static void gtk_cell_renderer_get_property (GObject *object,
33 static void gtk_cell_renderer_set_property (GObject *object,
37 static void set_cell_bg_color (GtkCellRenderer *cell,
41 #define GTK_CELL_RENDERER_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_CELL_RENDERER, GtkCellRendererPrivate))
43 typedef struct _GtkCellRendererPrivate GtkCellRendererPrivate;
44 struct _GtkCellRendererPrivate
46 GdkColor cell_background;
64 PROP_CELL_BACKGROUND_GDK,
65 PROP_CELL_BACKGROUND_SET
75 static guint cell_renderer_signals[LAST_SIGNAL] = { 0 };
79 gtk_cell_renderer_get_type (void)
81 static GType cell_type = 0;
85 static const GTypeInfo cell_info =
87 sizeof (GtkCellRendererClass),
89 NULL, /* base_finalize */
90 (GClassInitFunc) gtk_cell_renderer_class_init,
91 NULL, /* class_finalize */
92 NULL, /* class_data */
93 sizeof (GtkCellRenderer),
95 (GInstanceInitFunc) gtk_cell_renderer_init,
96 NULL, /* value_table */
99 cell_type = g_type_register_static (GTK_TYPE_OBJECT, "GtkCellRenderer",
100 &cell_info, G_TYPE_FLAG_ABSTRACT);
107 gtk_cell_renderer_init (GtkCellRenderer *cell)
109 cell->mode = GTK_CELL_RENDERER_MODE_INERT;
110 cell->visible = TRUE;
117 cell->sensitive = TRUE;
118 cell->is_expander = FALSE;
119 cell->is_expanded = FALSE;
123 gtk_cell_renderer_class_init (GtkCellRendererClass *class)
125 GObjectClass *object_class = G_OBJECT_CLASS (class);
127 object_class->get_property = gtk_cell_renderer_get_property;
128 object_class->set_property = gtk_cell_renderer_set_property;
130 class->render = NULL;
131 class->get_size = NULL;
134 * GtkCellRenderer::editing-canceled:
135 * @renderer: the object which received the signal
137 * This signal gets emitted when the user cancels the process of editing a
138 * cell. For example, an editable cell renderer could be written to cancel
139 * editing when the user presses Escape.
141 * See also: gtk_cell_renderer_editing_canceled()
145 cell_renderer_signals[EDITING_CANCELED] =
146 g_signal_new ("editing-canceled",
147 G_OBJECT_CLASS_TYPE (object_class),
149 G_STRUCT_OFFSET (GtkCellRendererClass, editing_canceled),
151 _gtk_marshal_VOID__VOID,
155 * GtkCellRenderer::editing-started:
156 * @renderer: the object which received the signal
157 * @editable: the #GtkCellEditable
158 * @path: the path identifying the edited cell
160 * This signal gets emitted when a cell starts to be edited.
161 * The indended use of this signal is to do special setup
162 * on @editable, e.g. adding a #GtkEntryCompletion or setting
163 * up additional columns in a #GtkComboBox.
165 * Note that GTK+ doesn't guarantee that cell renderers will
166 * continue to use the same kind of widget for editing in future
167 * releases, therefore you should check the type of @editable
168 * before doing any specific setup, as in the following example:
170 * <informalexample><programlisting>
172 * text_editing_started (GtkCellRenderer *cell,
173 * GtkCellEditable *editable,
177 * if (GTK_IS_ENTRY (editable))
179 * GtkEntry *entry = GTK_ENTRY (editable);
181 * /<!-- -->* ... create a GtkEntryCompletion *<!-- -->/
183 * gtk_entry_set_completion (entry, completion);
186 * </programlisting></informalexample>
190 cell_renderer_signals[EDITING_STARTED] =
191 g_signal_new ("editing-started",
192 G_OBJECT_CLASS_TYPE (object_class),
194 G_STRUCT_OFFSET (GtkCellRendererClass, editing_started),
196 _gtk_marshal_VOID__OBJECT_STRING,
198 GTK_TYPE_CELL_EDITABLE,
201 g_object_class_install_property (object_class,
203 g_param_spec_enum ("mode",
205 P_("Editable mode of the CellRenderer"),
206 GTK_TYPE_CELL_RENDERER_MODE,
207 GTK_CELL_RENDERER_MODE_INERT,
211 g_object_class_install_property (object_class,
213 g_param_spec_boolean ("visible",
215 P_("Display the cell"),
218 g_object_class_install_property (object_class,
220 g_param_spec_boolean ("sensitive",
222 P_("Display the cell sensitive"),
226 g_object_class_install_property (object_class,
228 g_param_spec_float ("xalign",
237 g_object_class_install_property (object_class,
239 g_param_spec_float ("yalign",
248 g_object_class_install_property (object_class,
250 g_param_spec_uint ("xpad",
259 g_object_class_install_property (object_class,
261 g_param_spec_uint ("ypad",
270 g_object_class_install_property (object_class,
272 g_param_spec_int ("width",
274 P_("The fixed width"),
281 g_object_class_install_property (object_class,
283 g_param_spec_int ("height",
285 P_("The fixed height"),
292 g_object_class_install_property (object_class,
294 g_param_spec_boolean ("is_expander",
296 P_("Row has children"),
302 g_object_class_install_property (object_class,
304 g_param_spec_boolean ("is_expanded",
306 P_("Row is an expander row, and is expanded"),
311 g_object_class_install_property (object_class,
312 PROP_CELL_BACKGROUND,
313 g_param_spec_string ("cell_background",
314 P_("Cell background color name"),
315 P_("Cell background color as a string"),
319 g_object_class_install_property (object_class,
320 PROP_CELL_BACKGROUND_GDK,
321 g_param_spec_boxed ("cell_background_gdk",
322 P_("Cell background color"),
323 P_("Cell background color as a GdkColor"),
325 G_PARAM_READABLE | G_PARAM_WRITABLE));
328 #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))
330 ADD_SET_PROP ("cell_background_set", PROP_CELL_BACKGROUND_SET,
331 P_("Cell background set"),
332 P_("Whether this tag affects the cell background color"));
334 g_type_class_add_private (object_class, sizeof (GtkCellRendererPrivate));
338 gtk_cell_renderer_get_property (GObject *object,
343 GtkCellRenderer *cell = GTK_CELL_RENDERER (object);
344 GtkCellRendererPrivate *priv = GTK_CELL_RENDERER_GET_PRIVATE (object);
349 g_value_set_enum (value, cell->mode);
352 g_value_set_boolean (value, cell->visible);
355 g_value_set_boolean (value, cell->sensitive);
358 g_value_set_float (value, cell->xalign);
361 g_value_set_float (value, cell->yalign);
364 g_value_set_uint (value, cell->xpad);
367 g_value_set_uint (value, cell->ypad);
370 g_value_set_int (value, cell->width);
373 g_value_set_int (value, cell->height);
375 case PROP_IS_EXPANDER:
376 g_value_set_boolean (value, cell->is_expander);
378 case PROP_IS_EXPANDED:
379 g_value_set_boolean (value, cell->is_expanded);
381 case PROP_CELL_BACKGROUND_GDK:
385 color.red = priv->cell_background.red;
386 color.green = priv->cell_background.green;
387 color.blue = priv->cell_background.blue;
389 g_value_set_boxed (value, &color);
392 case PROP_CELL_BACKGROUND_SET:
393 g_value_set_boolean (value, cell->cell_background_set);
395 case PROP_CELL_BACKGROUND:
397 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
404 gtk_cell_renderer_set_property (GObject *object,
409 GtkCellRenderer *cell = GTK_CELL_RENDERER (object);
414 cell->mode = g_value_get_enum (value);
417 cell->visible = g_value_get_boolean (value);
420 cell->sensitive = g_value_get_boolean (value);
423 cell->xalign = g_value_get_float (value);
426 cell->yalign = g_value_get_float (value);
429 cell->xpad = g_value_get_uint (value);
432 cell->ypad = g_value_get_uint (value);
435 cell->width = g_value_get_int (value);
438 cell->height = g_value_get_int (value);
440 case PROP_IS_EXPANDER:
441 cell->is_expander = g_value_get_boolean (value);
443 case PROP_IS_EXPANDED:
444 cell->is_expanded = g_value_get_boolean (value);
446 case PROP_CELL_BACKGROUND:
450 if (!g_value_get_string (value))
451 set_cell_bg_color (cell, NULL);
452 else if (gdk_color_parse (g_value_get_string (value), &color))
453 set_cell_bg_color (cell, &color);
455 g_warning ("Don't know color `%s'", g_value_get_string (value));
457 g_object_notify (object, "cell_background_gdk");
460 case PROP_CELL_BACKGROUND_GDK:
461 set_cell_bg_color (cell, g_value_get_boxed (value));
463 case PROP_CELL_BACKGROUND_SET:
464 cell->cell_background_set = g_value_get_boolean (value);
467 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
473 set_cell_bg_color (GtkCellRenderer *cell,
476 GtkCellRendererPrivate *priv = GTK_CELL_RENDERER_GET_PRIVATE (cell);
480 if (!cell->cell_background_set)
482 cell->cell_background_set = TRUE;
483 g_object_notify (G_OBJECT (cell), "cell_background_set");
486 priv->cell_background.red = color->red;
487 priv->cell_background.green = color->green;
488 priv->cell_background.blue = color->blue;
492 if (cell->cell_background_set)
494 cell->cell_background_set = FALSE;
495 g_object_notify (G_OBJECT (cell), "cell_background_set");
501 * gtk_cell_renderer_get_size:
502 * @cell: a #GtkCellRenderer
503 * @widget: the widget the renderer is rendering to
504 * @cell_area: The area a cell will be allocated, or %NULL
505 * @x_offset: location to return x offset of cell relative to @cell_area, or %NULL
506 * @y_offset: location to return y offset of cell relative to @cell_area, or %NULL
507 * @width: location to return width needed to render a cell, or %NULL
508 * @height: location to return height needed to render a cell, or %NULL
510 * Obtains the width and height needed to render the cell. Used by view widgets
511 * to determine the appropriate size for the cell_area passed to
512 * gtk_cell_renderer_render(). If @cell_area is not %NULL, fills in the x and y
513 * offsets (if set) of the cell relative to this location. Please note that the
514 * values set in @width and @height, as well as those in @x_offset and @y_offset
515 * are inclusive of the xpad and ypad properties.
518 gtk_cell_renderer_get_size (GtkCellRenderer *cell,
520 GdkRectangle *cell_area,
526 gint *real_width = width;
527 gint *real_height = height;
529 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
530 g_return_if_fail (GTK_CELL_RENDERER_GET_CLASS (cell)->get_size != NULL);
532 if (width && cell->width != -1)
535 *width = cell->width;
537 if (height && cell->height != -1)
540 *height = cell->height;
543 GTK_CELL_RENDERER_GET_CLASS (cell)->get_size (cell,
553 * gtk_cell_renderer_render:
554 * @cell: a #GtkCellRenderer
555 * @window: a #GdkDrawable to draw to
556 * @widget: the widget owning @window
557 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
558 * @cell_area: area normally rendered by a cell renderer
559 * @expose_area: area that actually needs updating
560 * @flags: flags that affect rendering
562 * Invokes the virtual render function of the #GtkCellRenderer. The three
563 * passed-in rectangles are areas of @window. Most renderers will draw within
564 * @cell_area; the xalign, yalign, xpad, and ypad fields of the #GtkCellRenderer
565 * should be honored with respect to @cell_area. @background_area includes the
566 * blank space around the cell, and also the area containing the tree expander;
567 * so the @background_area rectangles for all cells tile to cover the entire
568 * @window. @expose_area is a clip rectangle.
572 gtk_cell_renderer_render (GtkCellRenderer *cell,
575 GdkRectangle *background_area,
576 GdkRectangle *cell_area,
577 GdkRectangle *expose_area,
578 GtkCellRendererState flags)
580 gboolean selected = FALSE;
581 GtkCellRendererPrivate *priv = GTK_CELL_RENDERER_GET_PRIVATE (cell);
583 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
584 g_return_if_fail (GTK_CELL_RENDERER_GET_CLASS (cell)->render != NULL);
586 selected = (flags & GTK_CELL_RENDERER_SELECTED) == GTK_CELL_RENDERER_SELECTED;
588 if (cell->cell_background_set && !selected)
593 color.red = priv->cell_background.red;
594 color.green = priv->cell_background.green;
595 color.blue = priv->cell_background.blue;
597 gc = gdk_gc_new (window);
598 gdk_gc_set_rgb_fg_color (gc, &color);
599 gdk_draw_rectangle (window, gc, TRUE,
600 background_area->x, background_area->y,
601 background_area->width, background_area->height);
605 GTK_CELL_RENDERER_GET_CLASS (cell)->render (cell,
615 * gtk_cell_renderer_activate:
616 * @cell: a #GtkCellRenderer
617 * @event: a #GdkEvent
618 * @widget: widget that received the event
619 * @path: widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath
620 * @background_area: background area as passed to @gtk_cell_renderer_render
621 * @cell_area: cell area as passed to @gtk_cell_renderer_render
622 * @flags: render flags
624 * Passes an activate event to the cell renderer for possible processing. Some
625 * cell renderers may use events; for example, #GtkCellRendererToggle toggles
626 * when it gets a mouse click.
628 * Return value: %TRUE if the event was consumed/handled
631 gtk_cell_renderer_activate (GtkCellRenderer *cell,
635 GdkRectangle *background_area,
636 GdkRectangle *cell_area,
637 GtkCellRendererState flags)
639 g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell), FALSE);
641 if (cell->mode != GTK_CELL_RENDERER_MODE_ACTIVATABLE)
644 if (GTK_CELL_RENDERER_GET_CLASS (cell)->activate == NULL)
647 return GTK_CELL_RENDERER_GET_CLASS (cell)->activate (cell,
657 * gtk_cell_renderer_start_editing:
658 * @cell: a #GtkCellRenderer
659 * @event: a #GdkEvent
660 * @widget: widget that received the event
661 * @path: widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath
662 * @background_area: background area as passed to @gtk_cell_renderer_render
663 * @cell_area: cell area as passed to @gtk_cell_renderer_render
664 * @flags: render flags
666 * Passes an activate event to the cell renderer for possible processing.
668 * Return value: A new #GtkCellEditable, or %NULL
671 gtk_cell_renderer_start_editing (GtkCellRenderer *cell,
675 GdkRectangle *background_area,
676 GdkRectangle *cell_area,
677 GtkCellRendererState flags)
680 GtkCellEditable *editable;
682 g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell), NULL);
684 if (cell->mode != GTK_CELL_RENDERER_MODE_EDITABLE)
687 if (GTK_CELL_RENDERER_GET_CLASS (cell)->start_editing == NULL)
691 editable = GTK_CELL_RENDERER_GET_CLASS (cell)->start_editing (cell,
700 cell_renderer_signals[EDITING_STARTED], 0,
707 * gtk_cell_renderer_set_fixed_size:
708 * @cell: A #GtkCellRenderer
709 * @width: the width of the cell renderer, or -1
710 * @height: the height of the cell renderer, or -1
712 * Sets the renderer size to be explicit, independent of the properties set.
715 gtk_cell_renderer_set_fixed_size (GtkCellRenderer *cell,
719 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
720 g_return_if_fail (width >= -1 && height >= -1);
722 if ((width != cell->width) || (height != cell->height))
724 g_object_freeze_notify (G_OBJECT (cell));
726 if (width != cell->width)
729 g_object_notify (G_OBJECT (cell), "width");
732 if (height != cell->height)
734 cell->height = height;
735 g_object_notify (G_OBJECT (cell), "height");
738 g_object_thaw_notify (G_OBJECT (cell));
743 * gtk_cell_renderer_get_fixed_size:
744 * @cell: A #GtkCellRenderer
745 * @width: location to fill in with the fixed width of the widget, or %NULL
746 * @height: location to fill in with the fixed height of the widget, or %NULL
748 * Fills in @width and @height with the appropriate size of @cell.
751 gtk_cell_renderer_get_fixed_size (GtkCellRenderer *cell,
755 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
758 (* width) = cell->width;
760 (* height) = cell->height;
764 * gtk_cell_renderer_editing_canceled:
765 * @cell: A #GtkCellRenderer
767 * Causes the cell renderer to emit the "editing-canceled" signal. This
768 * function is for use only by implementations of cell renderers that need to
769 * notify the client program that an editing process was canceled and the
770 * changes were not committed.
775 gtk_cell_renderer_editing_canceled (GtkCellRenderer *cell)
777 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
779 g_signal_emit (cell, cell_renderer_signals[EDITING_CANCELED], 0);