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 "gtkorientable.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 void gtk_cell_view_get_preferred_width (GtkWidget *widget,
99 static void gtk_cell_view_get_preferred_height (GtkWidget *widget,
102 static void gtk_cell_view_get_preferred_width_for_height (GtkWidget *widget,
106 static void gtk_cell_view_get_preferred_height_for_width (GtkWidget *widget,
111 static void context_size_changed_cb (GtkCellAreaContext *context,
114 static void row_changed_cb (GtkTreeModel *model,
120 struct _GtkCellViewPrivate
123 GtkTreeRowReference *displayed_row;
126 GtkCellAreaContext *context;
128 GtkOrientation orientation;
131 gboolean background_set;
133 gulong size_changed_id;
134 gulong row_changed_id;
136 guint32 draw_sensitive : 1;
137 guint32 fit_model : 1;
140 static GtkBuildableIface *parent_buildable_iface;
148 PROP_BACKGROUND_RGBA,
152 PROP_CELL_AREA_CONTEXT,
157 G_DEFINE_TYPE_WITH_CODE (GtkCellView, gtk_cell_view, GTK_TYPE_WIDGET,
158 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_LAYOUT,
159 gtk_cell_view_cell_layout_init)
160 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
161 gtk_cell_view_buildable_init)
162 G_IMPLEMENT_INTERFACE (GTK_TYPE_ORIENTABLE, NULL));
165 gtk_cell_view_class_init (GtkCellViewClass *klass)
167 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
168 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
170 gobject_class->constructor = gtk_cell_view_constructor;
171 gobject_class->get_property = gtk_cell_view_get_property;
172 gobject_class->set_property = gtk_cell_view_set_property;
173 gobject_class->finalize = gtk_cell_view_finalize;
174 gobject_class->dispose = gtk_cell_view_dispose;
176 widget_class->draw = gtk_cell_view_draw;
177 widget_class->size_allocate = gtk_cell_view_size_allocate;
178 widget_class->get_preferred_width = gtk_cell_view_get_preferred_width;
179 widget_class->get_preferred_height = gtk_cell_view_get_preferred_height;
180 widget_class->get_preferred_width_for_height = gtk_cell_view_get_preferred_width_for_height;
181 widget_class->get_preferred_height_for_width = gtk_cell_view_get_preferred_height_for_width;
184 g_object_class_override_property (gobject_class, PROP_ORIENTATION, "orientation");
186 g_object_class_install_property (gobject_class,
188 g_param_spec_string ("background",
189 P_("Background color name"),
190 P_("Background color as a string"),
192 GTK_PARAM_WRITABLE));
193 g_object_class_install_property (gobject_class,
195 g_param_spec_boxed ("background-gdk",
196 P_("Background color"),
197 P_("Background color as a GdkColor"),
199 GTK_PARAM_READWRITE));
201 * GtkCellView:background-rgba
203 * The background color as a #GdkRGBA
207 g_object_class_install_property (gobject_class,
208 PROP_BACKGROUND_RGBA,
209 g_param_spec_boxed ("background-rgba",
210 P_("Background RGBA color"),
211 P_("Background color as a GdkRGBA"),
213 GTK_PARAM_READWRITE));
218 * The model for cell view
222 g_object_class_install_property (gobject_class,
224 g_param_spec_object ("model",
225 P_("CellView model"),
226 P_("The model for cell view"),
228 GTK_PARAM_READWRITE));
232 * GtkCellView:cell-area
234 * The #GtkCellArea rendering cells
238 g_object_class_install_property (gobject_class,
240 g_param_spec_object ("cell-area",
242 P_("The GtkCellArea used to layout cells"),
244 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
247 * GtkCellView:cell-area-context
249 * The #GtkCellAreaContext used to compute the geometry of the cell view.
251 * A group of cell views can be assigned the same context in order to
252 * ensure the sizes and cell alignments match across all the views with
255 * #GtkComboBox menus uses this to assign the same context to all cell views
256 * in the menu items for a single menu (each submenu creates it's own
257 * context since the size of each submenu does not depend on parent
262 g_object_class_install_property (gobject_class,
263 PROP_CELL_AREA_CONTEXT,
264 g_param_spec_object ("cell-area-context",
265 P_("Cell Area Context"),
266 P_("The GtkCellAreaContext used to "
267 "compute the geometry of the cell view"),
268 GTK_TYPE_CELL_AREA_CONTEXT,
269 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
272 * GtkCellView:draw-sensitive
274 * Whether all cells should be draw as sensitive for this view regardless
275 * of the actual cell properties (used to make menus with submenus appear
276 * sensitive when the items in submenus might be insensitive).
280 g_object_class_install_property (gobject_class,
282 g_param_spec_boolean ("draw-sensitive",
283 P_("Draw Sensitive"),
284 P_("Whether to force cells to be drawn in a "
287 GTK_PARAM_READWRITE));
290 * GtkCellView:fit-model
292 * Whether the view should request enough space to always fit
293 * the size of every row in the model (used by the combo box to
294 * ensure the combo box size doesnt change when different items
299 g_object_class_install_property (gobject_class,
301 g_param_spec_boolean ("fit-model",
303 P_("Whether to request enough space for "
304 "every row in the model"),
306 GTK_PARAM_READWRITE));
309 #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))
311 ADD_SET_PROP ("background-set", PROP_BACKGROUND_SET,
312 P_("Background set"),
313 P_("Whether this tag affects the background color"));
315 g_type_class_add_private (gobject_class, sizeof (GtkCellViewPrivate));
319 gtk_cell_view_buildable_init (GtkBuildableIface *iface)
321 parent_buildable_iface = g_type_interface_peek_parent (iface);
322 iface->add_child = _gtk_cell_layout_buildable_add_child;
323 iface->custom_tag_start = gtk_cell_view_buildable_custom_tag_start;
324 iface->custom_tag_end = gtk_cell_view_buildable_custom_tag_end;
328 gtk_cell_view_cell_layout_init (GtkCellLayoutIface *iface)
330 iface->get_area = gtk_cell_view_cell_layout_get_area;
334 gtk_cell_view_constructor (GType type,
335 guint n_construct_properties,
336 GObjectConstructParam *construct_properties)
340 GtkCellViewPrivate *priv;
342 object = G_OBJECT_CLASS (gtk_cell_view_parent_class)->constructor
343 (type, n_construct_properties, construct_properties);
345 view = GTK_CELL_VIEW (object);
350 GtkCellArea *area = gtk_cell_area_box_new ();
352 priv->area = g_object_ref_sink (area);
356 priv->context = gtk_cell_area_create_context (priv->area);
358 priv->size_changed_id =
359 g_signal_connect (priv->context, "notify",
360 G_CALLBACK (context_size_changed_cb), view);
366 gtk_cell_view_get_property (GObject *object,
371 GtkCellView *view = GTK_CELL_VIEW (object);
375 case PROP_ORIENTATION:
376 g_value_set_enum (value, view->priv->orientation);
378 case PROP_BACKGROUND_GDK:
382 color.red = (guint) (view->priv->background.red * 65535);
383 color.green = (guint) (view->priv->background.green * 65535);
384 color.blue = (guint) (view->priv->background.blue * 65535);
387 g_value_set_boxed (value, &color);
390 case PROP_BACKGROUND_RGBA:
391 g_value_set_boxed (value, &view->priv->background);
393 case PROP_BACKGROUND_SET:
394 g_value_set_boolean (value, view->priv->background_set);
397 g_value_set_object (value, view->priv->model);
400 g_value_set_object (value, view->priv->area);
402 case PROP_CELL_AREA_CONTEXT:
403 g_value_set_object (value, view->priv->context);
405 case PROP_DRAW_SENSITIVE:
406 g_value_set_boolean (value, view->priv->draw_sensitive);
409 g_value_set_boolean (value, view->priv->fit_model);
412 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
418 reset_orientation_style (GtkCellView *view)
420 GtkStyleContext *context;
422 context = gtk_widget_get_style_context (GTK_WIDGET (view));
424 if (view->priv->orientation == GTK_ORIENTATION_VERTICAL)
426 gtk_style_context_add_class (context, GTK_STYLE_CLASS_VERTICAL);
427 gtk_style_context_remove_class (context, GTK_STYLE_CLASS_HORIZONTAL);
431 gtk_style_context_add_class (context, GTK_STYLE_CLASS_HORIZONTAL);
432 gtk_style_context_remove_class (context, GTK_STYLE_CLASS_VERTICAL);
437 gtk_cell_view_set_property (GObject *object,
442 GtkCellView *view = GTK_CELL_VIEW (object);
444 GtkCellAreaContext *context;
448 case PROP_ORIENTATION:
449 view->priv->orientation = g_value_get_enum (value);
450 if (view->priv->context)
451 gtk_cell_area_context_reset (view->priv->context);
453 reset_orientation_style (view);
455 case PROP_BACKGROUND:
459 if (!g_value_get_string (value))
460 gtk_cell_view_set_background_color (view, NULL);
461 else if (gdk_color_parse (g_value_get_string (value), &color))
462 gtk_cell_view_set_background_color (view, &color);
464 g_warning ("Don't know color `%s'", g_value_get_string (value));
466 g_object_notify (object, "background-gdk");
469 case PROP_BACKGROUND_GDK:
470 gtk_cell_view_set_background_color (view, g_value_get_boxed (value));
472 case PROP_BACKGROUND_RGBA:
473 gtk_cell_view_set_background_rgba (view, g_value_get_boxed (value));
475 case PROP_BACKGROUND_SET:
476 view->priv->background_set = g_value_get_boolean (value);
479 gtk_cell_view_set_model (view, g_value_get_object (value));
482 /* Construct-only, can only be assigned once */
483 area = g_value_get_object (value);
486 view->priv->area = g_object_ref_sink (area);
488 case PROP_CELL_AREA_CONTEXT:
489 /* Construct-only, can only be assigned once */
490 context = g_value_get_object (value);
493 view->priv->context = g_object_ref (context);
496 case PROP_DRAW_SENSITIVE:
497 gtk_cell_view_set_draw_sensitive (view, g_value_get_boolean (value));
501 gtk_cell_view_set_fit_model (view, g_value_get_boolean (value));
505 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
511 gtk_cell_view_init (GtkCellView *cellview)
513 GtkCellViewPrivate *priv;
515 cellview->priv = G_TYPE_INSTANCE_GET_PRIVATE (cellview,
518 priv = cellview->priv;
520 gtk_widget_set_has_window (GTK_WIDGET (cellview), FALSE);
522 priv->orientation = GTK_ORIENTATION_HORIZONTAL;
526 gtk_cell_view_finalize (GObject *object)
528 GtkCellView *cellview = GTK_CELL_VIEW (object);
530 if (cellview->priv->displayed_row)
531 gtk_tree_row_reference_free (cellview->priv->displayed_row);
533 G_OBJECT_CLASS (gtk_cell_view_parent_class)->finalize (object);
537 gtk_cell_view_dispose (GObject *object)
539 GtkCellView *cellview = GTK_CELL_VIEW (object);
541 gtk_cell_view_set_model (cellview, NULL);
543 if (cellview->priv->area)
545 g_object_unref (cellview->priv->area);
546 cellview->priv->area = NULL;
549 if (cellview->priv->context)
551 g_signal_handler_disconnect (cellview->priv->context, cellview->priv->size_changed_id);
553 g_object_unref (cellview->priv->context);
554 cellview->priv->context = NULL;
555 cellview->priv->size_changed_id = 0;
558 G_OBJECT_CLASS (gtk_cell_view_parent_class)->dispose (object);
562 gtk_cell_view_size_allocate (GtkWidget *widget,
563 GtkAllocation *allocation)
565 GtkCellView *cellview = GTK_CELL_VIEW (widget);
566 GtkCellViewPrivate *priv = cellview->priv;
567 gint alloc_width, alloc_height;
569 gtk_widget_set_allocation (widget, allocation);
571 gtk_cell_area_context_get_allocation (priv->context, &alloc_width, &alloc_height);
573 /* The first cell view in context is responsible for allocating the context at allocate time
574 * (or the cellview has its own context and is not grouped with any other cell views)
576 * If the cellview is in "fit model" mode, we assume its not in context and needs to
577 * allocate every time.
580 gtk_cell_area_context_allocate (priv->context, allocation->width, allocation->height);
581 else if (alloc_width != allocation->width && priv->orientation == GTK_ORIENTATION_HORIZONTAL)
582 gtk_cell_area_context_allocate (priv->context, allocation->width, -1);
583 else if (alloc_height != allocation->height && priv->orientation == GTK_ORIENTATION_VERTICAL)
584 gtk_cell_area_context_allocate (priv->context, -1, allocation->height);
588 gtk_cell_view_request_model (GtkCellView *cellview,
590 GtkOrientation orientation,
595 GtkCellViewPrivate *priv = cellview->priv;
599 valid = gtk_tree_model_iter_children (priv->model, &iter, parent);
604 gtk_cell_area_apply_attributes (priv->area, priv->model, &iter, FALSE, FALSE);
606 if (orientation == GTK_ORIENTATION_HORIZONTAL)
609 gtk_cell_area_get_preferred_width (priv->area, priv->context,
610 GTK_WIDGET (cellview), &min, &nat);
612 gtk_cell_area_get_preferred_width_for_height (priv->area, priv->context,
613 GTK_WIDGET (cellview), for_size, &min, &nat);
618 gtk_cell_area_get_preferred_height (priv->area, priv->context,
619 GTK_WIDGET (cellview), &min, &nat);
621 gtk_cell_area_get_preferred_height_for_width (priv->area, priv->context,
622 GTK_WIDGET (cellview), for_size, &min, &nat);
625 *minimum_size = MAX (min, *minimum_size);
626 *natural_size = MAX (nat, *natural_size);
628 /* Recurse into children when they exist */
629 gtk_cell_view_request_model (cellview, &iter, orientation, for_size, minimum_size, natural_size);
631 valid = gtk_tree_model_iter_next (priv->model, &iter);
636 gtk_cell_view_get_preferred_width (GtkWidget *widget,
640 GtkCellView *cellview = GTK_CELL_VIEW (widget);
641 GtkCellViewPrivate *priv = cellview->priv;
643 g_signal_handler_block (priv->context, priv->size_changed_id);
647 gint min = 0, nat = 0;
648 gtk_cell_view_request_model (cellview, NULL, GTK_ORIENTATION_HORIZONTAL, -1, &min, &nat);
652 if (cellview->priv->displayed_row)
653 gtk_cell_view_set_cell_data (cellview);
655 gtk_cell_area_get_preferred_width (priv->area, priv->context, widget, NULL, NULL);
658 gtk_cell_area_context_get_preferred_width (priv->context, minimum_size, natural_size);
660 g_signal_handler_unblock (priv->context, priv->size_changed_id);
664 gtk_cell_view_get_preferred_height (GtkWidget *widget,
668 GtkCellView *cellview = GTK_CELL_VIEW (widget);
669 GtkCellViewPrivate *priv = cellview->priv;
671 g_signal_handler_block (priv->context, priv->size_changed_id);
675 gint min = 0, nat = 0;
676 gtk_cell_view_request_model (cellview, NULL, GTK_ORIENTATION_VERTICAL, -1, &min, &nat);
680 if (cellview->priv->displayed_row)
681 gtk_cell_view_set_cell_data (cellview);
683 gtk_cell_area_get_preferred_height (priv->area, priv->context, widget, NULL, NULL);
686 gtk_cell_area_context_get_preferred_height (priv->context, minimum_size, natural_size);
688 g_signal_handler_unblock (priv->context, priv->size_changed_id);
692 gtk_cell_view_get_preferred_width_for_height (GtkWidget *widget,
697 GtkCellView *cellview = GTK_CELL_VIEW (widget);
698 GtkCellViewPrivate *priv = cellview->priv;
702 gint min = 0, nat = 0;
703 gtk_cell_view_request_model (cellview, NULL, GTK_ORIENTATION_HORIZONTAL, for_size, &min, &nat);
710 if (cellview->priv->displayed_row)
711 gtk_cell_view_set_cell_data (cellview);
713 gtk_cell_area_get_preferred_width_for_height (priv->area, priv->context, widget,
714 for_size, minimum_size, natural_size);
719 gtk_cell_view_get_preferred_height_for_width (GtkWidget *widget,
724 GtkCellView *cellview = GTK_CELL_VIEW (widget);
725 GtkCellViewPrivate *priv = cellview->priv;
729 gint min = 0, nat = 0;
730 gtk_cell_view_request_model (cellview, NULL, GTK_ORIENTATION_VERTICAL, for_size, &min, &nat);
737 if (cellview->priv->displayed_row)
738 gtk_cell_view_set_cell_data (cellview);
740 gtk_cell_area_get_preferred_height_for_width (priv->area, priv->context, widget,
741 for_size, minimum_size, natural_size);
746 gtk_cell_view_draw (GtkWidget *widget,
749 GtkCellView *cellview;
751 GtkCellRendererState state;
753 cellview = GTK_CELL_VIEW (widget);
758 area.width = gtk_widget_get_allocated_width (widget);
759 area.height = gtk_widget_get_allocated_height (widget);
761 /* "blank" background */
762 if (cellview->priv->background_set)
764 gdk_cairo_rectangle (cr, &area);
765 gdk_cairo_set_source_rgba (cr, &cellview->priv->background);
769 /* set cell data (if available) */
770 if (cellview->priv->displayed_row)
771 gtk_cell_view_set_cell_data (cellview);
772 else if (cellview->priv->model)
775 if (gtk_widget_get_state_flags (widget) & GTK_STATE_FLAG_PRELIGHT)
776 state = GTK_CELL_RENDERER_PRELIT;
777 else if (gtk_widget_get_state_flags (widget) & GTK_STATE_FLAG_INSENSITIVE)
778 state = GTK_CELL_RENDERER_INSENSITIVE;
782 /* Render the cells */
783 gtk_cell_area_render (cellview->priv->area, cellview->priv->context,
784 widget, cr, &area, &area, state, FALSE);
790 gtk_cell_view_set_cell_data (GtkCellView *cell_view)
795 g_return_if_fail (cell_view->priv->displayed_row != NULL);
797 path = gtk_tree_row_reference_get_path (cell_view->priv->displayed_row);
801 gtk_tree_model_get_iter (cell_view->priv->model, &iter, path);
802 gtk_tree_path_free (path);
804 gtk_cell_area_apply_attributes (cell_view->priv->area,
805 cell_view->priv->model,
806 &iter, FALSE, FALSE);
808 if (cell_view->priv->draw_sensitive)
811 gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (cell_view->priv->area));
813 for (l = cells; l; l = l->next)
815 GObject *renderer = l->data;
817 g_object_set (renderer, "sensitive", TRUE, NULL);
823 /* GtkCellLayout implementation */
825 gtk_cell_view_cell_layout_get_area (GtkCellLayout *layout)
827 GtkCellView *cellview = GTK_CELL_VIEW (layout);
829 return cellview->priv->area;
832 /* GtkBuildable implementation */
834 gtk_cell_view_buildable_custom_tag_start (GtkBuildable *buildable,
837 const gchar *tagname,
838 GMarkupParser *parser,
841 if (parent_buildable_iface->custom_tag_start &&
842 parent_buildable_iface->custom_tag_start (buildable, builder, child,
843 tagname, parser, data))
846 return _gtk_cell_layout_buildable_custom_tag_start (buildable, builder, child,
847 tagname, parser, data);
851 gtk_cell_view_buildable_custom_tag_end (GtkBuildable *buildable,
854 const gchar *tagname,
857 if (_gtk_cell_layout_buildable_custom_tag_end (buildable, builder, child, tagname,
860 else if (parent_buildable_iface->custom_tag_end)
861 parent_buildable_iface->custom_tag_end (buildable, builder, child, tagname,
866 context_size_changed_cb (GtkCellAreaContext *context,
870 if (!strcmp (pspec->name, "minimum-width") ||
871 !strcmp (pspec->name, "natural-width") ||
872 !strcmp (pspec->name, "minimum-height") ||
873 !strcmp (pspec->name, "natural-height"))
874 gtk_widget_queue_resize (view);
878 row_changed_cb (GtkTreeModel *model,
883 GtkTreePath *row_path;
885 if (view->priv->displayed_row)
888 gtk_tree_row_reference_get_path (view->priv->displayed_row);
892 /* Resize everything in our context if our row changed */
893 if (gtk_tree_path_compare (row_path, path) == 0)
894 gtk_cell_area_context_reset (view->priv->context);
896 gtk_tree_path_free (row_path);
904 * Creates a new #GtkCellView widget.
906 * Return value: A newly created #GtkCellView widget.
911 gtk_cell_view_new (void)
913 GtkCellView *cellview;
915 cellview = g_object_new (gtk_cell_view_get_type (), NULL);
917 return GTK_WIDGET (cellview);
922 * gtk_cell_view_new_with_context:
923 * @area: the #GtkCellArea to layout cells
924 * @context: the #GtkCellAreaContext in which to calculate cell geometry
926 * Creates a new #GtkCellView widget with a specific #GtkCellArea
927 * to layout cells and a specific #GtkCellAreaContext.
929 * Specifying the same context for a handfull of cells lets
930 * the underlying area synchronize the geometry for those cells,
931 * in this way alignments with cellviews for other rows are
934 * Return value: A newly created #GtkCellView widget.
939 gtk_cell_view_new_with_context (GtkCellArea *area,
940 GtkCellAreaContext *context)
942 g_return_val_if_fail (GTK_IS_CELL_AREA (area), NULL);
943 g_return_val_if_fail (context == NULL || GTK_IS_CELL_AREA_CONTEXT (context), NULL);
945 return (GtkWidget *)g_object_new (GTK_TYPE_CELL_VIEW,
947 "cell-area-context", context,
952 * gtk_cell_view_new_with_text:
953 * @text: the text to display in the cell view
955 * Creates a new #GtkCellView widget, adds a #GtkCellRendererText
956 * to it, and makes its show @text.
958 * Return value: A newly created #GtkCellView widget.
963 gtk_cell_view_new_with_text (const gchar *text)
965 GtkCellView *cellview;
966 GtkCellRenderer *renderer;
967 GValue value = {0, };
969 cellview = GTK_CELL_VIEW (gtk_cell_view_new ());
971 renderer = gtk_cell_renderer_text_new ();
972 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (cellview),
975 g_value_init (&value, G_TYPE_STRING);
976 g_value_set_string (&value, text);
977 gtk_cell_view_set_value (cellview, renderer, "text", &value);
978 g_value_unset (&value);
980 return GTK_WIDGET (cellview);
984 * gtk_cell_view_new_with_markup:
985 * @markup: the text to display in the cell view
987 * Creates a new #GtkCellView widget, adds a #GtkCellRendererText
988 * to it, and makes it show @markup. The text can be
989 * marked up with the <link linkend="PangoMarkupFormat">Pango text
990 * markup language</link>.
992 * Return value: A newly created #GtkCellView widget.
997 gtk_cell_view_new_with_markup (const gchar *markup)
999 GtkCellView *cellview;
1000 GtkCellRenderer *renderer;
1001 GValue value = {0, };
1003 cellview = GTK_CELL_VIEW (gtk_cell_view_new ());
1005 renderer = gtk_cell_renderer_text_new ();
1006 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (cellview),
1009 g_value_init (&value, G_TYPE_STRING);
1010 g_value_set_string (&value, markup);
1011 gtk_cell_view_set_value (cellview, renderer, "markup", &value);
1012 g_value_unset (&value);
1014 return GTK_WIDGET (cellview);
1018 * gtk_cell_view_new_with_pixbuf:
1019 * @pixbuf: the image to display in the cell view
1021 * Creates a new #GtkCellView widget, adds a #GtkCellRendererPixbuf
1022 * to it, and makes its show @pixbuf.
1024 * Return value: A newly created #GtkCellView widget.
1029 gtk_cell_view_new_with_pixbuf (GdkPixbuf *pixbuf)
1031 GtkCellView *cellview;
1032 GtkCellRenderer *renderer;
1033 GValue value = {0, };
1035 cellview = GTK_CELL_VIEW (gtk_cell_view_new ());
1037 renderer = gtk_cell_renderer_pixbuf_new ();
1038 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (cellview),
1041 g_value_init (&value, GDK_TYPE_PIXBUF);
1042 g_value_set_object (&value, pixbuf);
1043 gtk_cell_view_set_value (cellview, renderer, "pixbuf", &value);
1044 g_value_unset (&value);
1046 return GTK_WIDGET (cellview);
1050 * gtk_cell_view_set_value:
1051 * @cell_view: a #GtkCellView widget
1052 * @renderer: one of the renderers of @cell_view
1053 * @property: the name of the property of @renderer to set
1054 * @value: the new value to set the property to
1056 * Sets a property of a cell renderer of @cell_view, and
1057 * makes sure the display of @cell_view is updated.
1062 gtk_cell_view_set_value (GtkCellView *cell_view,
1063 GtkCellRenderer *renderer,
1067 g_object_set_property (G_OBJECT (renderer), property, value);
1069 /* force resize and redraw */
1070 gtk_widget_queue_resize (GTK_WIDGET (cell_view));
1071 gtk_widget_queue_draw (GTK_WIDGET (cell_view));
1075 * gtk_cell_view_set_model:
1076 * @cell_view: a #GtkCellView
1077 * @model: (allow-none): a #GtkTreeModel
1079 * Sets the model for @cell_view. If @cell_view already has a model
1080 * set, it will remove it before setting the new model. If @model is
1081 * %NULL, then it will unset the old model.
1086 gtk_cell_view_set_model (GtkCellView *cell_view,
1087 GtkTreeModel *model)
1089 g_return_if_fail (GTK_IS_CELL_VIEW (cell_view));
1090 g_return_if_fail (model == NULL || GTK_IS_TREE_MODEL (model));
1092 if (cell_view->priv->model)
1094 g_signal_handler_disconnect (cell_view->priv->model,
1095 cell_view->priv->row_changed_id);
1096 cell_view->priv->row_changed_id = 0;
1098 if (cell_view->priv->displayed_row)
1099 gtk_tree_row_reference_free (cell_view->priv->displayed_row);
1100 cell_view->priv->displayed_row = NULL;
1102 g_object_unref (cell_view->priv->model);
1103 cell_view->priv->model = NULL;
1106 cell_view->priv->model = model;
1108 if (cell_view->priv->model)
1110 g_object_ref (cell_view->priv->model);
1112 cell_view->priv->row_changed_id =
1113 g_signal_connect (cell_view->priv->model, "row-changed",
1114 G_CALLBACK (row_changed_cb), cell_view);
1119 * gtk_cell_view_get_model:
1120 * @cell_view: a #GtkCellView
1122 * Returns the model for @cell_view. If no model is used %NULL is
1125 * Returns: (transfer none): a #GtkTreeModel used or %NULL
1130 gtk_cell_view_get_model (GtkCellView *cell_view)
1132 g_return_val_if_fail (GTK_IS_CELL_VIEW (cell_view), NULL);
1134 return cell_view->priv->model;
1138 * gtk_cell_view_set_displayed_row:
1139 * @cell_view: a #GtkCellView
1140 * @path: (allow-none): a #GtkTreePath or %NULL to unset.
1142 * Sets the row of the model that is currently displayed
1143 * by the #GtkCellView. If the path is unset, then the
1144 * contents of the cellview "stick" at their last value;
1145 * this is not normally a desired result, but may be
1146 * a needed intermediate state if say, the model for
1147 * the #GtkCellView becomes temporarily empty.
1152 gtk_cell_view_set_displayed_row (GtkCellView *cell_view,
1155 g_return_if_fail (GTK_IS_CELL_VIEW (cell_view));
1156 g_return_if_fail (GTK_IS_TREE_MODEL (cell_view->priv->model));
1158 if (cell_view->priv->displayed_row)
1159 gtk_tree_row_reference_free (cell_view->priv->displayed_row);
1163 cell_view->priv->displayed_row =
1164 gtk_tree_row_reference_new (cell_view->priv->model, path);
1167 cell_view->priv->displayed_row = NULL;
1169 /* force resize and redraw */
1170 gtk_widget_queue_resize (GTK_WIDGET (cell_view));
1171 gtk_widget_queue_draw (GTK_WIDGET (cell_view));
1175 * gtk_cell_view_get_displayed_row:
1176 * @cell_view: a #GtkCellView
1178 * Returns a #GtkTreePath referring to the currently
1179 * displayed row. If no row is currently displayed,
1180 * %NULL is returned.
1182 * Returns: the currently displayed row or %NULL
1187 gtk_cell_view_get_displayed_row (GtkCellView *cell_view)
1189 g_return_val_if_fail (GTK_IS_CELL_VIEW (cell_view), NULL);
1191 if (!cell_view->priv->displayed_row)
1194 return gtk_tree_row_reference_get_path (cell_view->priv->displayed_row);
1198 * gtk_cell_view_get_size_of_row:
1199 * @cell_view: a #GtkCellView
1200 * @path: a #GtkTreePath
1201 * @requisition: return location for the size
1203 * Sets @requisition to the size needed by @cell_view to display
1204 * the model row pointed to by @path.
1206 * Return value: %TRUE
1210 * Deprecated: 3.0: Combo box formerly used this to calculate the
1211 * sizes for cellviews, now you can achieve this by either using
1212 * the #GtkCellView:fit-model property or by setting the currently
1213 * displayed row of the #GtkCellView and using gtk_widget_get_preferred_size().
1216 gtk_cell_view_get_size_of_row (GtkCellView *cell_view,
1218 GtkRequisition *requisition)
1220 GtkTreeRowReference *tmp;
1223 g_return_val_if_fail (GTK_IS_CELL_VIEW (cell_view), FALSE);
1224 g_return_val_if_fail (path != NULL, FALSE);
1226 tmp = cell_view->priv->displayed_row;
1227 cell_view->priv->displayed_row =
1228 gtk_tree_row_reference_new (cell_view->priv->model, path);
1230 gtk_widget_get_preferred_width (GTK_WIDGET (cell_view), &req.width, NULL);
1231 gtk_widget_get_preferred_height_for_width (GTK_WIDGET (cell_view), req.width, &req.height, NULL);
1233 gtk_tree_row_reference_free (cell_view->priv->displayed_row);
1234 cell_view->priv->displayed_row = tmp;
1243 * gtk_cell_view_set_background_color:
1244 * @cell_view: a #GtkCellView
1245 * @color: the new background color
1247 * Sets the background color of @view.
1252 gtk_cell_view_set_background_color (GtkCellView *cell_view,
1253 const GdkColor *color)
1255 g_return_if_fail (GTK_IS_CELL_VIEW (cell_view));
1259 if (!cell_view->priv->background_set)
1261 cell_view->priv->background_set = TRUE;
1262 g_object_notify (G_OBJECT (cell_view), "background-set");
1265 cell_view->priv->background.red = color->red / 65535.;
1266 cell_view->priv->background.green = color->green / 65535.;
1267 cell_view->priv->background.blue = color->blue / 65535.;
1268 cell_view->priv->background.alpha = 1;
1272 if (cell_view->priv->background_set)
1274 cell_view->priv->background_set = FALSE;
1275 g_object_notify (G_OBJECT (cell_view), "background-set");
1279 gtk_widget_queue_draw (GTK_WIDGET (cell_view));
1283 * gtk_cell_view_set_background_rgba:
1284 * @cell_view: a #GtkCellView
1285 * @rgba: the new background color
1287 * Sets the background color of @cell_view.
1292 gtk_cell_view_set_background_rgba (GtkCellView *cell_view,
1293 const GdkRGBA *rgba)
1295 g_return_if_fail (GTK_IS_CELL_VIEW (cell_view));
1299 if (!cell_view->priv->background_set)
1301 cell_view->priv->background_set = TRUE;
1302 g_object_notify (G_OBJECT (cell_view), "background-set");
1305 cell_view->priv->background = *rgba;
1309 if (cell_view->priv->background_set)
1311 cell_view->priv->background_set = FALSE;
1312 g_object_notify (G_OBJECT (cell_view), "background-set");
1316 gtk_widget_queue_draw (GTK_WIDGET (cell_view));
1320 * gtk_cell_view_get_draw_sensitive:
1321 * @cell_view: a #GtkCellView
1323 * Gets whether @cell_view is configured to draw all of it's
1324 * cells in a sensitive state.
1326 * Return value: whether @cell_view draws all of it's
1327 * cells in a sensitive state
1332 gtk_cell_view_get_draw_sensitive (GtkCellView *cell_view)
1334 GtkCellViewPrivate *priv;
1336 g_return_val_if_fail (GTK_IS_CELL_VIEW (cell_view), FALSE);
1338 priv = cell_view->priv;
1340 return priv->draw_sensitive;
1344 * gtk_cell_view_set_draw_sensitive:
1345 * @cell_view: a #GtkCellView
1346 * @draw_sensitive: whether to draw all cells in a sensitive state.
1348 * Sets whether @cell_view should draw all of it's
1349 * cells in a sensitive state, this is used by #GtkComboBox menus
1350 * to ensure that rows with insensitive cells that contain
1351 * children appear sensitive in the parent menu item.
1356 gtk_cell_view_set_draw_sensitive (GtkCellView *cell_view,
1357 gboolean draw_sensitive)
1359 GtkCellViewPrivate *priv;
1361 g_return_if_fail (GTK_IS_CELL_VIEW (cell_view));
1363 priv = cell_view->priv;
1365 if (priv->draw_sensitive != draw_sensitive)
1367 priv->draw_sensitive = draw_sensitive;
1369 g_object_notify (G_OBJECT (cell_view), "draw-sensitive");
1374 * gtk_cell_view_get_fit_model:
1375 * @cell_view: a #GtkCellView
1377 * Gets whether @cell_view is configured to request space
1378 * to fit the entire #GtkTreeModel.
1380 * Return value: whether @cell_view requests space to fit
1381 * the entire #GtkTreeModel.
1386 gtk_cell_view_get_fit_model (GtkCellView *cell_view)
1388 GtkCellViewPrivate *priv;
1390 g_return_val_if_fail (GTK_IS_CELL_VIEW (cell_view), FALSE);
1392 priv = cell_view->priv;
1394 return priv->fit_model;
1398 * gtk_cell_view_set_fit_model:
1399 * @cell_view: a #GtkCellView
1400 * @fit_model: whether @cell_view should request space for the whole model.
1402 * Sets whether @cell_view should request space to fit the entire #GtkTreeModel.
1404 * This is used by #GtkComboBox to ensure that the cell view displayed on
1405 * the combo box's button always gets enough space and does not resize
1406 * when selection changes.
1411 gtk_cell_view_set_fit_model (GtkCellView *cell_view,
1414 GtkCellViewPrivate *priv;
1416 g_return_if_fail (GTK_IS_CELL_VIEW (cell_view));
1418 priv = cell_view->priv;
1420 if (priv->fit_model != fit_model)
1422 priv->fit_model = fit_model;
1424 gtk_cell_area_context_reset (cell_view->priv->context);
1426 g_object_notify (G_OBJECT (cell_view), "fit-model");