2 * Copyright (C) 2002, 2003 Kristian Rietveld <kris@gtk.org>
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 "gtkcellview.h"
23 #include "gtkcelllayout.h"
24 #include "gtkcellareabox.h"
26 #include "gtkcellrenderertext.h"
27 #include "gtkcellrendererpixbuf.h"
28 #include "gtkprivate.h"
29 #include "gtkorientableprivate.h"
30 #include <gobject/gmarshal.h>
31 #include "gtkbuildable.h"
36 * @Short_description: A widget displaying a single row of a GtkTreeModel
39 * A #GtkCellView displays a single row of a #GtkTreeModel using a #GtkCellArea
40 * and #GtkCellAreaContext. A #GtkCellAreaContext can be provided to the
41 * #GtkCellView at construction time in order to keep the cellview in context
42 * of a group of cell views, this ensures that the renderers displayed will
43 * be properly aligned with eachother (like the aligned cells in the menus
46 * #GtkCellView is #GtkOrientable in order to decide in which orientation
47 * the underlying #GtkCellAreaContext should be allocated. Taking the #GtkComboBox
48 * menu as an example, cellviews should be oriented horizontally if the menus are
49 * listed top-to-bottom and thus all share the same width but may have separate
50 * individual heights (left-to-right menus should be allocated vertically since
51 * they all share the same height but may have variable widths).
54 static GObject *gtk_cell_view_constructor (GType type,
55 guint n_construct_properties,
56 GObjectConstructParam *construct_properties);
57 static void gtk_cell_view_get_property (GObject *object,
61 static void gtk_cell_view_set_property (GObject *object,
65 static void gtk_cell_view_finalize (GObject *object);
66 static void gtk_cell_view_dispose (GObject *object);
67 static void gtk_cell_view_size_allocate (GtkWidget *widget,
68 GtkAllocation *allocation);
69 static gboolean gtk_cell_view_draw (GtkWidget *widget,
71 static void gtk_cell_view_set_value (GtkCellView *cell_view,
72 GtkCellRenderer *renderer,
75 static void gtk_cell_view_set_cell_data (GtkCellView *cell_view);
78 static void gtk_cell_view_cell_layout_init (GtkCellLayoutIface *iface);
79 static GtkCellArea *gtk_cell_view_cell_layout_get_area (GtkCellLayout *layout);
83 static void gtk_cell_view_buildable_init (GtkBuildableIface *iface);
84 static gboolean gtk_cell_view_buildable_custom_tag_start (GtkBuildable *buildable,
88 GMarkupParser *parser,
90 static void gtk_cell_view_buildable_custom_tag_end (GtkBuildable *buildable,
96 static GtkSizeRequestMode gtk_cell_view_get_request_mode (GtkWidget *widget);
97 static void gtk_cell_view_get_preferred_width (GtkWidget *widget,
100 static void gtk_cell_view_get_preferred_height (GtkWidget *widget,
103 static void gtk_cell_view_get_preferred_width_for_height (GtkWidget *widget,
107 static void gtk_cell_view_get_preferred_height_for_width (GtkWidget *widget,
112 static void context_size_changed_cb (GtkCellAreaContext *context,
115 static void row_changed_cb (GtkTreeModel *model,
121 struct _GtkCellViewPrivate
124 GtkTreeRowReference *displayed_row;
127 GtkCellAreaContext *context;
129 GtkOrientation orientation;
132 gboolean background_set;
134 gulong size_changed_id;
135 gulong row_changed_id;
137 guint32 draw_sensitive : 1;
138 guint32 fit_model : 1;
141 static GtkBuildableIface *parent_buildable_iface;
149 PROP_BACKGROUND_RGBA,
153 PROP_CELL_AREA_CONTEXT,
158 G_DEFINE_TYPE_WITH_CODE (GtkCellView, gtk_cell_view, GTK_TYPE_WIDGET,
159 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_LAYOUT,
160 gtk_cell_view_cell_layout_init)
161 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
162 gtk_cell_view_buildable_init)
163 G_IMPLEMENT_INTERFACE (GTK_TYPE_ORIENTABLE, NULL));
166 gtk_cell_view_class_init (GtkCellViewClass *klass)
168 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
169 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
171 gobject_class->constructor = gtk_cell_view_constructor;
172 gobject_class->get_property = gtk_cell_view_get_property;
173 gobject_class->set_property = gtk_cell_view_set_property;
174 gobject_class->finalize = gtk_cell_view_finalize;
175 gobject_class->dispose = gtk_cell_view_dispose;
177 widget_class->draw = gtk_cell_view_draw;
178 widget_class->size_allocate = gtk_cell_view_size_allocate;
179 widget_class->get_request_mode = gtk_cell_view_get_request_mode;
180 widget_class->get_preferred_width = gtk_cell_view_get_preferred_width;
181 widget_class->get_preferred_height = gtk_cell_view_get_preferred_height;
182 widget_class->get_preferred_width_for_height = gtk_cell_view_get_preferred_width_for_height;
183 widget_class->get_preferred_height_for_width = gtk_cell_view_get_preferred_height_for_width;
186 g_object_class_override_property (gobject_class, PROP_ORIENTATION, "orientation");
188 g_object_class_install_property (gobject_class,
190 g_param_spec_string ("background",
191 P_("Background color name"),
192 P_("Background color as a string"),
194 GTK_PARAM_WRITABLE));
195 g_object_class_install_property (gobject_class,
197 g_param_spec_boxed ("background-gdk",
198 P_("Background color"),
199 P_("Background color as a GdkColor"),
201 GTK_PARAM_READWRITE));
203 * GtkCellView:background-rgba
205 * The background color as a #GdkRGBA
209 g_object_class_install_property (gobject_class,
210 PROP_BACKGROUND_RGBA,
211 g_param_spec_boxed ("background-rgba",
212 P_("Background RGBA color"),
213 P_("Background color as a GdkRGBA"),
215 GTK_PARAM_READWRITE));
220 * The model for cell view
224 g_object_class_install_property (gobject_class,
226 g_param_spec_object ("model",
227 P_("CellView model"),
228 P_("The model for cell view"),
230 GTK_PARAM_READWRITE));
234 * GtkCellView:cell-area
236 * The #GtkCellArea rendering cells
238 * If no area is specified when creating the cell view with gtk_cell_view_new_with_context()
239 * a horizontally oriented #GtkCellAreaBox will be used.
243 g_object_class_install_property (gobject_class,
245 g_param_spec_object ("cell-area",
247 P_("The GtkCellArea used to layout cells"),
249 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
252 * GtkCellView:cell-area-context
254 * The #GtkCellAreaContext used to compute the geometry of the cell view.
256 * A group of cell views can be assigned the same context in order to
257 * ensure the sizes and cell alignments match across all the views with
260 * #GtkComboBox menus uses this to assign the same context to all cell views
261 * in the menu items for a single menu (each submenu creates its own
262 * context since the size of each submenu does not depend on parent
267 g_object_class_install_property (gobject_class,
268 PROP_CELL_AREA_CONTEXT,
269 g_param_spec_object ("cell-area-context",
270 P_("Cell Area Context"),
271 P_("The GtkCellAreaContext used to "
272 "compute the geometry of the cell view"),
273 GTK_TYPE_CELL_AREA_CONTEXT,
274 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
277 * GtkCellView:draw-sensitive
279 * Whether all cells should be draw as sensitive for this view regardless
280 * of the actual cell properties (used to make menus with submenus appear
281 * sensitive when the items in submenus might be insensitive).
285 g_object_class_install_property (gobject_class,
287 g_param_spec_boolean ("draw-sensitive",
288 P_("Draw Sensitive"),
289 P_("Whether to force cells to be drawn in a "
292 GTK_PARAM_READWRITE));
295 * GtkCellView:fit-model
297 * Whether the view should request enough space to always fit
298 * the size of every row in the model (used by the combo box to
299 * ensure the combo box size doesnt change when different items
304 g_object_class_install_property (gobject_class,
306 g_param_spec_boolean ("fit-model",
308 P_("Whether to request enough space for "
309 "every row in the model"),
311 GTK_PARAM_READWRITE));
314 #define ADD_SET_PROP(propname, propval, nick, blurb) g_object_class_install_property (gobject_class, propval, g_param_spec_boolean (propname, nick, blurb, FALSE, GTK_PARAM_READWRITE))
316 ADD_SET_PROP ("background-set", PROP_BACKGROUND_SET,
317 P_("Background set"),
318 P_("Whether this tag affects the background color"));
320 g_type_class_add_private (gobject_class, sizeof (GtkCellViewPrivate));
324 gtk_cell_view_buildable_init (GtkBuildableIface *iface)
326 parent_buildable_iface = g_type_interface_peek_parent (iface);
327 iface->add_child = _gtk_cell_layout_buildable_add_child;
328 iface->custom_tag_start = gtk_cell_view_buildable_custom_tag_start;
329 iface->custom_tag_end = gtk_cell_view_buildable_custom_tag_end;
333 gtk_cell_view_cell_layout_init (GtkCellLayoutIface *iface)
335 iface->get_area = gtk_cell_view_cell_layout_get_area;
339 gtk_cell_view_constructor (GType type,
340 guint n_construct_properties,
341 GObjectConstructParam *construct_properties)
345 GtkCellViewPrivate *priv;
347 object = G_OBJECT_CLASS (gtk_cell_view_parent_class)->constructor
348 (type, n_construct_properties, construct_properties);
350 view = GTK_CELL_VIEW (object);
355 priv->area = gtk_cell_area_box_new ();
356 g_object_ref_sink (priv->area);
360 priv->context = gtk_cell_area_create_context (priv->area);
362 priv->size_changed_id =
363 g_signal_connect (priv->context, "notify",
364 G_CALLBACK (context_size_changed_cb), view);
370 gtk_cell_view_get_property (GObject *object,
375 GtkCellView *view = GTK_CELL_VIEW (object);
379 case PROP_ORIENTATION:
380 g_value_set_enum (value, view->priv->orientation);
382 case PROP_BACKGROUND_GDK:
386 color.red = (guint) (view->priv->background.red * 65535);
387 color.green = (guint) (view->priv->background.green * 65535);
388 color.blue = (guint) (view->priv->background.blue * 65535);
391 g_value_set_boxed (value, &color);
394 case PROP_BACKGROUND_RGBA:
395 g_value_set_boxed (value, &view->priv->background);
397 case PROP_BACKGROUND_SET:
398 g_value_set_boolean (value, view->priv->background_set);
401 g_value_set_object (value, view->priv->model);
404 g_value_set_object (value, view->priv->area);
406 case PROP_CELL_AREA_CONTEXT:
407 g_value_set_object (value, view->priv->context);
409 case PROP_DRAW_SENSITIVE:
410 g_value_set_boolean (value, view->priv->draw_sensitive);
413 g_value_set_boolean (value, view->priv->fit_model);
416 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
422 gtk_cell_view_set_property (GObject *object,
427 GtkCellView *view = GTK_CELL_VIEW (object);
428 GtkCellViewPrivate *priv = view->priv;
430 GtkCellAreaContext *context;
434 case PROP_ORIENTATION:
435 priv->orientation = g_value_get_enum (value);
437 gtk_cell_area_context_reset (priv->context);
439 _gtk_orientable_set_style_classes (GTK_ORIENTABLE (object));
441 case PROP_BACKGROUND:
445 if (!g_value_get_string (value))
446 gtk_cell_view_set_background_color (view, NULL);
447 else if (gdk_color_parse (g_value_get_string (value), &color))
448 gtk_cell_view_set_background_color (view, &color);
450 g_warning ("Don't know color `%s'", g_value_get_string (value));
452 g_object_notify (object, "background-gdk");
455 case PROP_BACKGROUND_GDK:
456 gtk_cell_view_set_background_color (view, g_value_get_boxed (value));
458 case PROP_BACKGROUND_RGBA:
459 gtk_cell_view_set_background_rgba (view, g_value_get_boxed (value));
461 case PROP_BACKGROUND_SET:
462 view->priv->background_set = g_value_get_boolean (value);
465 gtk_cell_view_set_model (view, g_value_get_object (value));
468 /* Construct-only, can only be assigned once */
469 area = g_value_get_object (value);
473 if (priv->area != NULL)
475 g_warning ("cell-area has already been set, ignoring construct property");
476 g_object_ref_sink (area);
477 g_object_unref (area);
480 priv->area = g_object_ref_sink (area);
483 case PROP_CELL_AREA_CONTEXT:
484 /* Construct-only, can only be assigned once */
485 context = g_value_get_object (value);
489 if (priv->context != NULL)
491 g_warning ("cell-area-context has already been set, ignoring construct property");
492 g_object_ref_sink (context);
493 g_object_unref (context);
496 priv->context = g_object_ref (context);
500 case PROP_DRAW_SENSITIVE:
501 gtk_cell_view_set_draw_sensitive (view, g_value_get_boolean (value));
505 gtk_cell_view_set_fit_model (view, g_value_get_boolean (value));
509 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
515 gtk_cell_view_init (GtkCellView *cellview)
517 GtkCellViewPrivate *priv;
519 cellview->priv = G_TYPE_INSTANCE_GET_PRIVATE (cellview,
522 priv = cellview->priv;
524 gtk_widget_set_has_window (GTK_WIDGET (cellview), FALSE);
526 priv->orientation = GTK_ORIENTATION_HORIZONTAL;
530 gtk_cell_view_finalize (GObject *object)
532 GtkCellView *cellview = GTK_CELL_VIEW (object);
534 if (cellview->priv->displayed_row)
535 gtk_tree_row_reference_free (cellview->priv->displayed_row);
537 G_OBJECT_CLASS (gtk_cell_view_parent_class)->finalize (object);
541 gtk_cell_view_dispose (GObject *object)
543 GtkCellView *cellview = GTK_CELL_VIEW (object);
545 gtk_cell_view_set_model (cellview, NULL);
547 if (cellview->priv->area)
549 g_object_unref (cellview->priv->area);
550 cellview->priv->area = NULL;
553 if (cellview->priv->context)
555 g_signal_handler_disconnect (cellview->priv->context, cellview->priv->size_changed_id);
557 g_object_unref (cellview->priv->context);
558 cellview->priv->context = NULL;
559 cellview->priv->size_changed_id = 0;
562 G_OBJECT_CLASS (gtk_cell_view_parent_class)->dispose (object);
566 gtk_cell_view_size_allocate (GtkWidget *widget,
567 GtkAllocation *allocation)
569 GtkCellView *cellview = GTK_CELL_VIEW (widget);
570 GtkCellViewPrivate *priv = cellview->priv;
571 gint alloc_width, alloc_height;
573 gtk_widget_set_allocation (widget, allocation);
575 gtk_cell_area_context_get_allocation (priv->context, &alloc_width, &alloc_height);
577 /* The first cell view in context is responsible for allocating the context at allocate time
578 * (or the cellview has its own context and is not grouped with any other cell views)
580 * If the cellview is in "fit model" mode, we assume its not in context and needs to
581 * allocate every time.
584 gtk_cell_area_context_allocate (priv->context, allocation->width, allocation->height);
585 else if (alloc_width != allocation->width && priv->orientation == GTK_ORIENTATION_HORIZONTAL)
586 gtk_cell_area_context_allocate (priv->context, allocation->width, -1);
587 else if (alloc_height != allocation->height && priv->orientation == GTK_ORIENTATION_VERTICAL)
588 gtk_cell_area_context_allocate (priv->context, -1, allocation->height);
592 gtk_cell_view_request_model (GtkCellView *cellview,
594 GtkOrientation orientation,
599 GtkCellViewPrivate *priv = cellview->priv;
606 valid = gtk_tree_model_iter_children (priv->model, &iter, parent);
611 gtk_cell_area_apply_attributes (priv->area, priv->model, &iter, FALSE, FALSE);
613 if (orientation == GTK_ORIENTATION_HORIZONTAL)
616 gtk_cell_area_get_preferred_width (priv->area, priv->context,
617 GTK_WIDGET (cellview), &min, &nat);
619 gtk_cell_area_get_preferred_width_for_height (priv->area, priv->context,
620 GTK_WIDGET (cellview), for_size, &min, &nat);
625 gtk_cell_area_get_preferred_height (priv->area, priv->context,
626 GTK_WIDGET (cellview), &min, &nat);
628 gtk_cell_area_get_preferred_height_for_width (priv->area, priv->context,
629 GTK_WIDGET (cellview), for_size, &min, &nat);
632 *minimum_size = MAX (min, *minimum_size);
633 *natural_size = MAX (nat, *natural_size);
635 /* Recurse into children when they exist */
636 gtk_cell_view_request_model (cellview, &iter, orientation, for_size, minimum_size, natural_size);
638 valid = gtk_tree_model_iter_next (priv->model, &iter);
642 static GtkSizeRequestMode
643 gtk_cell_view_get_request_mode (GtkWidget *widget)
645 GtkCellView *cellview = GTK_CELL_VIEW (widget);
646 GtkCellViewPrivate *priv = cellview->priv;
648 return gtk_cell_area_get_request_mode (priv->area);
652 gtk_cell_view_get_preferred_width (GtkWidget *widget,
656 GtkCellView *cellview = GTK_CELL_VIEW (widget);
657 GtkCellViewPrivate *priv = cellview->priv;
659 g_signal_handler_block (priv->context, priv->size_changed_id);
663 gint min = 0, nat = 0;
664 gtk_cell_view_request_model (cellview, NULL, GTK_ORIENTATION_HORIZONTAL, -1, &min, &nat);
668 if (cellview->priv->displayed_row)
669 gtk_cell_view_set_cell_data (cellview);
671 gtk_cell_area_get_preferred_width (priv->area, priv->context, widget, NULL, NULL);
674 gtk_cell_area_context_get_preferred_width (priv->context, minimum_size, natural_size);
676 g_signal_handler_unblock (priv->context, priv->size_changed_id);
680 gtk_cell_view_get_preferred_height (GtkWidget *widget,
684 GtkCellView *cellview = GTK_CELL_VIEW (widget);
685 GtkCellViewPrivate *priv = cellview->priv;
687 g_signal_handler_block (priv->context, priv->size_changed_id);
691 gint min = 0, nat = 0;
692 gtk_cell_view_request_model (cellview, NULL, GTK_ORIENTATION_VERTICAL, -1, &min, &nat);
696 if (cellview->priv->displayed_row)
697 gtk_cell_view_set_cell_data (cellview);
699 gtk_cell_area_get_preferred_height (priv->area, priv->context, widget, NULL, NULL);
702 gtk_cell_area_context_get_preferred_height (priv->context, minimum_size, natural_size);
704 g_signal_handler_unblock (priv->context, priv->size_changed_id);
708 gtk_cell_view_get_preferred_width_for_height (GtkWidget *widget,
713 GtkCellView *cellview = GTK_CELL_VIEW (widget);
714 GtkCellViewPrivate *priv = cellview->priv;
718 gint min = 0, nat = 0;
719 gtk_cell_view_request_model (cellview, NULL, GTK_ORIENTATION_HORIZONTAL, for_size, &min, &nat);
726 if (cellview->priv->displayed_row)
727 gtk_cell_view_set_cell_data (cellview);
729 gtk_cell_area_get_preferred_width_for_height (priv->area, priv->context, widget,
730 for_size, minimum_size, natural_size);
735 gtk_cell_view_get_preferred_height_for_width (GtkWidget *widget,
740 GtkCellView *cellview = GTK_CELL_VIEW (widget);
741 GtkCellViewPrivate *priv = cellview->priv;
745 gint min = 0, nat = 0;
746 gtk_cell_view_request_model (cellview, NULL, GTK_ORIENTATION_VERTICAL, for_size, &min, &nat);
753 if (cellview->priv->displayed_row)
754 gtk_cell_view_set_cell_data (cellview);
756 gtk_cell_area_get_preferred_height_for_width (priv->area, priv->context, widget,
757 for_size, minimum_size, natural_size);
762 gtk_cell_view_draw (GtkWidget *widget,
765 GtkCellView *cellview;
767 GtkCellRendererState state;
769 cellview = GTK_CELL_VIEW (widget);
774 area.width = gtk_widget_get_allocated_width (widget);
775 area.height = gtk_widget_get_allocated_height (widget);
777 /* "blank" background */
778 if (cellview->priv->background_set)
780 gdk_cairo_rectangle (cr, &area);
781 gdk_cairo_set_source_rgba (cr, &cellview->priv->background);
785 /* set cell data (if available) */
786 if (cellview->priv->displayed_row)
787 gtk_cell_view_set_cell_data (cellview);
788 else if (cellview->priv->model)
791 if (gtk_widget_get_state_flags (widget) & GTK_STATE_FLAG_PRELIGHT)
792 state = GTK_CELL_RENDERER_PRELIT;
793 else if (gtk_widget_get_state_flags (widget) & GTK_STATE_FLAG_INSENSITIVE)
794 state = GTK_CELL_RENDERER_INSENSITIVE;
798 /* Render the cells */
799 gtk_cell_area_render (cellview->priv->area, cellview->priv->context,
800 widget, cr, &area, &area, state, FALSE);
806 gtk_cell_view_set_cell_data (GtkCellView *cell_view)
811 g_return_if_fail (cell_view->priv->displayed_row != NULL);
813 path = gtk_tree_row_reference_get_path (cell_view->priv->displayed_row);
817 gtk_tree_model_get_iter (cell_view->priv->model, &iter, path);
818 gtk_tree_path_free (path);
820 gtk_cell_area_apply_attributes (cell_view->priv->area,
821 cell_view->priv->model,
822 &iter, FALSE, FALSE);
824 if (cell_view->priv->draw_sensitive)
827 gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (cell_view->priv->area));
829 for (l = cells; l; l = l->next)
831 GObject *renderer = l->data;
833 g_object_set (renderer, "sensitive", TRUE, NULL);
839 /* GtkCellLayout implementation */
841 gtk_cell_view_cell_layout_get_area (GtkCellLayout *layout)
843 GtkCellView *cellview = GTK_CELL_VIEW (layout);
844 GtkCellViewPrivate *priv = cellview->priv;
846 if (G_UNLIKELY (!priv->area))
848 priv->area = gtk_cell_area_box_new ();
849 g_object_ref_sink (priv->area);
855 /* GtkBuildable implementation */
857 gtk_cell_view_buildable_custom_tag_start (GtkBuildable *buildable,
860 const gchar *tagname,
861 GMarkupParser *parser,
864 if (parent_buildable_iface->custom_tag_start &&
865 parent_buildable_iface->custom_tag_start (buildable, builder, child,
866 tagname, parser, data))
869 return _gtk_cell_layout_buildable_custom_tag_start (buildable, builder, child,
870 tagname, parser, data);
874 gtk_cell_view_buildable_custom_tag_end (GtkBuildable *buildable,
877 const gchar *tagname,
880 if (_gtk_cell_layout_buildable_custom_tag_end (buildable, builder, child, tagname,
883 else if (parent_buildable_iface->custom_tag_end)
884 parent_buildable_iface->custom_tag_end (buildable, builder, child, tagname,
889 context_size_changed_cb (GtkCellAreaContext *context,
893 if (!strcmp (pspec->name, "minimum-width") ||
894 !strcmp (pspec->name, "natural-width") ||
895 !strcmp (pspec->name, "minimum-height") ||
896 !strcmp (pspec->name, "natural-height"))
897 gtk_widget_queue_resize (view);
901 row_changed_cb (GtkTreeModel *model,
906 GtkTreePath *row_path;
908 if (view->priv->displayed_row)
911 gtk_tree_row_reference_get_path (view->priv->displayed_row);
915 /* Resize everything in our context if our row changed */
916 if (gtk_tree_path_compare (row_path, path) == 0)
917 gtk_cell_area_context_reset (view->priv->context);
919 gtk_tree_path_free (row_path);
927 * Creates a new #GtkCellView widget.
929 * Return value: A newly created #GtkCellView widget.
934 gtk_cell_view_new (void)
936 GtkCellView *cellview;
938 cellview = g_object_new (gtk_cell_view_get_type (), NULL);
940 return GTK_WIDGET (cellview);
945 * gtk_cell_view_new_with_context:
946 * @area: the #GtkCellArea to layout cells
947 * @context: the #GtkCellAreaContext in which to calculate cell geometry
949 * Creates a new #GtkCellView widget with a specific #GtkCellArea
950 * to layout cells and a specific #GtkCellAreaContext.
952 * Specifying the same context for a handfull of cells lets
953 * the underlying area synchronize the geometry for those cells,
954 * in this way alignments with cellviews for other rows are
957 * Return value: A newly created #GtkCellView widget.
962 gtk_cell_view_new_with_context (GtkCellArea *area,
963 GtkCellAreaContext *context)
965 g_return_val_if_fail (GTK_IS_CELL_AREA (area), NULL);
966 g_return_val_if_fail (context == NULL || GTK_IS_CELL_AREA_CONTEXT (context), NULL);
968 return (GtkWidget *)g_object_new (GTK_TYPE_CELL_VIEW,
970 "cell-area-context", context,
975 * gtk_cell_view_new_with_text:
976 * @text: the text to display in the cell view
978 * Creates a new #GtkCellView widget, adds a #GtkCellRendererText
979 * to it, and makes its show @text.
981 * Return value: A newly created #GtkCellView widget.
986 gtk_cell_view_new_with_text (const gchar *text)
988 GtkCellView *cellview;
989 GtkCellRenderer *renderer;
990 GValue value = {0, };
992 cellview = GTK_CELL_VIEW (gtk_cell_view_new ());
994 renderer = gtk_cell_renderer_text_new ();
995 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (cellview),
998 g_value_init (&value, G_TYPE_STRING);
999 g_value_set_string (&value, text);
1000 gtk_cell_view_set_value (cellview, renderer, "text", &value);
1001 g_value_unset (&value);
1003 return GTK_WIDGET (cellview);
1007 * gtk_cell_view_new_with_markup:
1008 * @markup: the text to display in the cell view
1010 * Creates a new #GtkCellView widget, adds a #GtkCellRendererText
1011 * to it, and makes it show @markup. The text can be
1012 * marked up with the <link linkend="PangoMarkupFormat">Pango text
1013 * markup language</link>.
1015 * Return value: A newly created #GtkCellView widget.
1020 gtk_cell_view_new_with_markup (const gchar *markup)
1022 GtkCellView *cellview;
1023 GtkCellRenderer *renderer;
1024 GValue value = {0, };
1026 cellview = GTK_CELL_VIEW (gtk_cell_view_new ());
1028 renderer = gtk_cell_renderer_text_new ();
1029 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (cellview),
1032 g_value_init (&value, G_TYPE_STRING);
1033 g_value_set_string (&value, markup);
1034 gtk_cell_view_set_value (cellview, renderer, "markup", &value);
1035 g_value_unset (&value);
1037 return GTK_WIDGET (cellview);
1041 * gtk_cell_view_new_with_pixbuf:
1042 * @pixbuf: the image to display in the cell view
1044 * Creates a new #GtkCellView widget, adds a #GtkCellRendererPixbuf
1045 * to it, and makes its show @pixbuf.
1047 * Return value: A newly created #GtkCellView widget.
1052 gtk_cell_view_new_with_pixbuf (GdkPixbuf *pixbuf)
1054 GtkCellView *cellview;
1055 GtkCellRenderer *renderer;
1056 GValue value = {0, };
1058 cellview = GTK_CELL_VIEW (gtk_cell_view_new ());
1060 renderer = gtk_cell_renderer_pixbuf_new ();
1061 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (cellview),
1064 g_value_init (&value, GDK_TYPE_PIXBUF);
1065 g_value_set_object (&value, pixbuf);
1066 gtk_cell_view_set_value (cellview, renderer, "pixbuf", &value);
1067 g_value_unset (&value);
1069 return GTK_WIDGET (cellview);
1073 * gtk_cell_view_set_value:
1074 * @cell_view: a #GtkCellView widget
1075 * @renderer: one of the renderers of @cell_view
1076 * @property: the name of the property of @renderer to set
1077 * @value: the new value to set the property to
1079 * Sets a property of a cell renderer of @cell_view, and
1080 * makes sure the display of @cell_view is updated.
1085 gtk_cell_view_set_value (GtkCellView *cell_view,
1086 GtkCellRenderer *renderer,
1090 g_object_set_property (G_OBJECT (renderer), property, value);
1092 /* force resize and redraw */
1093 gtk_widget_queue_resize (GTK_WIDGET (cell_view));
1094 gtk_widget_queue_draw (GTK_WIDGET (cell_view));
1098 * gtk_cell_view_set_model:
1099 * @cell_view: a #GtkCellView
1100 * @model: (allow-none): a #GtkTreeModel
1102 * Sets the model for @cell_view. If @cell_view already has a model
1103 * set, it will remove it before setting the new model. If @model is
1104 * %NULL, then it will unset the old model.
1109 gtk_cell_view_set_model (GtkCellView *cell_view,
1110 GtkTreeModel *model)
1112 g_return_if_fail (GTK_IS_CELL_VIEW (cell_view));
1113 g_return_if_fail (model == NULL || GTK_IS_TREE_MODEL (model));
1115 if (cell_view->priv->model)
1117 g_signal_handler_disconnect (cell_view->priv->model,
1118 cell_view->priv->row_changed_id);
1119 cell_view->priv->row_changed_id = 0;
1121 if (cell_view->priv->displayed_row)
1122 gtk_tree_row_reference_free (cell_view->priv->displayed_row);
1123 cell_view->priv->displayed_row = NULL;
1125 g_object_unref (cell_view->priv->model);
1128 cell_view->priv->model = model;
1130 if (cell_view->priv->model)
1132 g_object_ref (cell_view->priv->model);
1134 cell_view->priv->row_changed_id =
1135 g_signal_connect (cell_view->priv->model, "row-changed",
1136 G_CALLBACK (row_changed_cb), cell_view);
1141 * gtk_cell_view_get_model:
1142 * @cell_view: a #GtkCellView
1144 * Returns the model for @cell_view. If no model is used %NULL is
1147 * Returns: (transfer none): a #GtkTreeModel used or %NULL
1152 gtk_cell_view_get_model (GtkCellView *cell_view)
1154 g_return_val_if_fail (GTK_IS_CELL_VIEW (cell_view), NULL);
1156 return cell_view->priv->model;
1160 * gtk_cell_view_set_displayed_row:
1161 * @cell_view: a #GtkCellView
1162 * @path: (allow-none): a #GtkTreePath or %NULL to unset.
1164 * Sets the row of the model that is currently displayed
1165 * by the #GtkCellView. If the path is unset, then the
1166 * contents of the cellview "stick" at their last value;
1167 * this is not normally a desired result, but may be
1168 * a needed intermediate state if say, the model for
1169 * the #GtkCellView becomes temporarily empty.
1174 gtk_cell_view_set_displayed_row (GtkCellView *cell_view,
1177 g_return_if_fail (GTK_IS_CELL_VIEW (cell_view));
1178 g_return_if_fail (GTK_IS_TREE_MODEL (cell_view->priv->model));
1180 if (cell_view->priv->displayed_row)
1181 gtk_tree_row_reference_free (cell_view->priv->displayed_row);
1185 cell_view->priv->displayed_row =
1186 gtk_tree_row_reference_new (cell_view->priv->model, path);
1189 cell_view->priv->displayed_row = NULL;
1191 /* force resize and redraw */
1192 gtk_widget_queue_resize (GTK_WIDGET (cell_view));
1193 gtk_widget_queue_draw (GTK_WIDGET (cell_view));
1197 * gtk_cell_view_get_displayed_row:
1198 * @cell_view: a #GtkCellView
1200 * Returns a #GtkTreePath referring to the currently
1201 * displayed row. If no row is currently displayed,
1202 * %NULL is returned.
1204 * Returns: the currently displayed row or %NULL
1209 gtk_cell_view_get_displayed_row (GtkCellView *cell_view)
1211 g_return_val_if_fail (GTK_IS_CELL_VIEW (cell_view), NULL);
1213 if (!cell_view->priv->displayed_row)
1216 return gtk_tree_row_reference_get_path (cell_view->priv->displayed_row);
1220 * gtk_cell_view_get_size_of_row:
1221 * @cell_view: a #GtkCellView
1222 * @path: a #GtkTreePath
1223 * @requisition: (out): return location for the size
1225 * Sets @requisition to the size needed by @cell_view to display
1226 * the model row pointed to by @path.
1228 * Return value: %TRUE
1232 * Deprecated: 3.0: Combo box formerly used this to calculate the
1233 * sizes for cellviews, now you can achieve this by either using
1234 * the #GtkCellView:fit-model property or by setting the currently
1235 * displayed row of the #GtkCellView and using gtk_widget_get_preferred_size().
1238 gtk_cell_view_get_size_of_row (GtkCellView *cell_view,
1240 GtkRequisition *requisition)
1242 GtkTreeRowReference *tmp;
1245 g_return_val_if_fail (GTK_IS_CELL_VIEW (cell_view), FALSE);
1246 g_return_val_if_fail (path != NULL, FALSE);
1248 tmp = cell_view->priv->displayed_row;
1249 cell_view->priv->displayed_row =
1250 gtk_tree_row_reference_new (cell_view->priv->model, path);
1252 gtk_widget_get_preferred_width (GTK_WIDGET (cell_view), &req.width, NULL);
1253 gtk_widget_get_preferred_height_for_width (GTK_WIDGET (cell_view), req.width, &req.height, NULL);
1255 gtk_tree_row_reference_free (cell_view->priv->displayed_row);
1256 cell_view->priv->displayed_row = tmp;
1265 * gtk_cell_view_set_background_color:
1266 * @cell_view: a #GtkCellView
1267 * @color: the new background color
1269 * Sets the background color of @view.
1274 gtk_cell_view_set_background_color (GtkCellView *cell_view,
1275 const GdkColor *color)
1277 g_return_if_fail (GTK_IS_CELL_VIEW (cell_view));
1281 if (!cell_view->priv->background_set)
1283 cell_view->priv->background_set = TRUE;
1284 g_object_notify (G_OBJECT (cell_view), "background-set");
1287 cell_view->priv->background.red = color->red / 65535.;
1288 cell_view->priv->background.green = color->green / 65535.;
1289 cell_view->priv->background.blue = color->blue / 65535.;
1290 cell_view->priv->background.alpha = 1;
1294 if (cell_view->priv->background_set)
1296 cell_view->priv->background_set = FALSE;
1297 g_object_notify (G_OBJECT (cell_view), "background-set");
1301 gtk_widget_queue_draw (GTK_WIDGET (cell_view));
1305 * gtk_cell_view_set_background_rgba:
1306 * @cell_view: a #GtkCellView
1307 * @rgba: the new background color
1309 * Sets the background color of @cell_view.
1314 gtk_cell_view_set_background_rgba (GtkCellView *cell_view,
1315 const GdkRGBA *rgba)
1317 g_return_if_fail (GTK_IS_CELL_VIEW (cell_view));
1321 if (!cell_view->priv->background_set)
1323 cell_view->priv->background_set = TRUE;
1324 g_object_notify (G_OBJECT (cell_view), "background-set");
1327 cell_view->priv->background = *rgba;
1331 if (cell_view->priv->background_set)
1333 cell_view->priv->background_set = FALSE;
1334 g_object_notify (G_OBJECT (cell_view), "background-set");
1338 gtk_widget_queue_draw (GTK_WIDGET (cell_view));
1342 * gtk_cell_view_get_draw_sensitive:
1343 * @cell_view: a #GtkCellView
1345 * Gets whether @cell_view is configured to draw all of its
1346 * cells in a sensitive state.
1348 * Return value: whether @cell_view draws all of its
1349 * cells in a sensitive state
1354 gtk_cell_view_get_draw_sensitive (GtkCellView *cell_view)
1356 GtkCellViewPrivate *priv;
1358 g_return_val_if_fail (GTK_IS_CELL_VIEW (cell_view), FALSE);
1360 priv = cell_view->priv;
1362 return priv->draw_sensitive;
1366 * gtk_cell_view_set_draw_sensitive:
1367 * @cell_view: a #GtkCellView
1368 * @draw_sensitive: whether to draw all cells in a sensitive state.
1370 * Sets whether @cell_view should draw all of its
1371 * cells in a sensitive state, this is used by #GtkComboBox menus
1372 * to ensure that rows with insensitive cells that contain
1373 * children appear sensitive in the parent menu item.
1378 gtk_cell_view_set_draw_sensitive (GtkCellView *cell_view,
1379 gboolean draw_sensitive)
1381 GtkCellViewPrivate *priv;
1383 g_return_if_fail (GTK_IS_CELL_VIEW (cell_view));
1385 priv = cell_view->priv;
1387 if (priv->draw_sensitive != draw_sensitive)
1389 priv->draw_sensitive = draw_sensitive;
1391 g_object_notify (G_OBJECT (cell_view), "draw-sensitive");
1396 * gtk_cell_view_get_fit_model:
1397 * @cell_view: a #GtkCellView
1399 * Gets whether @cell_view is configured to request space
1400 * to fit the entire #GtkTreeModel.
1402 * Return value: whether @cell_view requests space to fit
1403 * the entire #GtkTreeModel.
1408 gtk_cell_view_get_fit_model (GtkCellView *cell_view)
1410 GtkCellViewPrivate *priv;
1412 g_return_val_if_fail (GTK_IS_CELL_VIEW (cell_view), FALSE);
1414 priv = cell_view->priv;
1416 return priv->fit_model;
1420 * gtk_cell_view_set_fit_model:
1421 * @cell_view: a #GtkCellView
1422 * @fit_model: whether @cell_view should request space for the whole model.
1424 * Sets whether @cell_view should request space to fit the entire #GtkTreeModel.
1426 * This is used by #GtkComboBox to ensure that the cell view displayed on
1427 * the combo box's button always gets enough space and does not resize
1428 * when selection changes.
1433 gtk_cell_view_set_fit_model (GtkCellView *cell_view,
1436 GtkCellViewPrivate *priv;
1438 g_return_if_fail (GTK_IS_CELL_VIEW (cell_view));
1440 priv = cell_view->priv;
1442 if (priv->fit_model != fit_model)
1444 priv->fit_model = fit_model;
1446 gtk_cell_area_context_reset (cell_view->priv->context);
1448 g_object_notify (G_OBJECT (cell_view), "fit-model");