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 "gtksizerequest.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
40 * cell renderers just like #GtkTreeView. #GtkCellView doesn't support
41 * some of the more complex features of #GtkTreeView, like cell editing
45 static GObject *gtk_cell_view_constructor (GType type,
46 guint n_construct_properties,
47 GObjectConstructParam *construct_properties);
48 static void gtk_cell_view_get_property (GObject *object,
52 static void gtk_cell_view_set_property (GObject *object,
56 static void gtk_cell_view_finalize (GObject *object);
57 static void gtk_cell_view_dispose (GObject *object);
58 static void gtk_cell_view_size_allocate (GtkWidget *widget,
59 GtkAllocation *allocation);
60 static gboolean gtk_cell_view_draw (GtkWidget *widget,
62 static void gtk_cell_view_set_value (GtkCellView *cell_view,
63 GtkCellRenderer *renderer,
66 static void gtk_cell_view_set_cell_data (GtkCellView *cell_view);
69 static void gtk_cell_view_cell_layout_init (GtkCellLayoutIface *iface);
70 static GtkCellArea *gtk_cell_view_cell_layout_get_area (GtkCellLayout *layout);
74 static void gtk_cell_view_buildable_init (GtkBuildableIface *iface);
75 static gboolean gtk_cell_view_buildable_custom_tag_start (GtkBuildable *buildable,
79 GMarkupParser *parser,
81 static void gtk_cell_view_buildable_custom_tag_end (GtkBuildable *buildable,
87 static void gtk_cell_view_get_preferred_width (GtkWidget *widget,
90 static void gtk_cell_view_get_preferred_height (GtkWidget *widget,
93 static void gtk_cell_view_get_preferred_width_for_height (GtkWidget *widget,
97 static void gtk_cell_view_get_preferred_height_for_width (GtkWidget *widget,
102 static void context_size_changed_cb (GtkCellAreaContext *context,
105 static void row_changed_cb (GtkTreeModel *model,
111 struct _GtkCellViewPrivate
114 GtkTreeRowReference *displayed_row;
117 GtkCellAreaContext *context;
120 gboolean background_set;
122 gulong size_changed_id;
123 gulong row_changed_id;
125 guint32 draw_sensitive : 1;
126 guint32 fit_model : 1;
129 static GtkBuildableIface *parent_buildable_iface;
136 PROP_BACKGROUND_RGBA,
140 PROP_CELL_AREA_CONTEXT,
145 G_DEFINE_TYPE_WITH_CODE (GtkCellView, gtk_cell_view, GTK_TYPE_WIDGET,
146 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_LAYOUT,
147 gtk_cell_view_cell_layout_init)
148 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
149 gtk_cell_view_buildable_init))
152 gtk_cell_view_class_init (GtkCellViewClass *klass)
154 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
155 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
157 gobject_class->constructor = gtk_cell_view_constructor;
158 gobject_class->get_property = gtk_cell_view_get_property;
159 gobject_class->set_property = gtk_cell_view_set_property;
160 gobject_class->finalize = gtk_cell_view_finalize;
161 gobject_class->dispose = gtk_cell_view_dispose;
163 widget_class->draw = gtk_cell_view_draw;
164 widget_class->size_allocate = gtk_cell_view_size_allocate;
165 widget_class->get_preferred_width = gtk_cell_view_get_preferred_width;
166 widget_class->get_preferred_height = gtk_cell_view_get_preferred_height;
167 widget_class->get_preferred_width_for_height = gtk_cell_view_get_preferred_width_for_height;
168 widget_class->get_preferred_height_for_width = gtk_cell_view_get_preferred_height_for_width;
171 g_object_class_install_property (gobject_class,
173 g_param_spec_string ("background",
174 P_("Background color name"),
175 P_("Background color as a string"),
177 GTK_PARAM_WRITABLE));
178 g_object_class_install_property (gobject_class,
180 g_param_spec_boxed ("background-gdk",
181 P_("Background color"),
182 P_("Background color as a GdkColor"),
184 GTK_PARAM_READWRITE));
186 * GtkCellView:background-rgba
188 * The background color as a #GdkRGBA
192 g_object_class_install_property (gobject_class,
193 PROP_BACKGROUND_RGBA,
194 g_param_spec_boxed ("background-rgba",
195 P_("Background RGBA color"),
196 P_("Background color as a GdkRGBA"),
198 GTK_PARAM_READWRITE));
203 * The model for cell view
207 g_object_class_install_property (gobject_class,
209 g_param_spec_object ("model",
210 P_("CellView model"),
211 P_("The model for cell view"),
213 GTK_PARAM_READWRITE));
217 * GtkCellView:cell-area
219 * The #GtkCellArea rendering cells
223 g_object_class_install_property (gobject_class,
225 g_param_spec_object ("cell-area",
227 P_("The GtkCellArea used to layout cells"),
229 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
232 * GtkCellView:cell-area-context
234 * The #GtkCellAreaContext used to compute the geometry of the cell view.
238 g_object_class_install_property (gobject_class,
239 PROP_CELL_AREA_CONTEXT,
240 g_param_spec_object ("cell-area-context",
241 P_("Cell Area Context"),
242 P_("The GtkCellAreaContext used to "
243 "compute the geometry of the cell view"),
244 GTK_TYPE_CELL_AREA_CONTEXT,
245 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
248 * GtkCellView:draw-sensitive
250 * Whether all cells should be draw as sensitive for this view regardless
251 * of the actual cell properties (used to make menus with submenus appear
252 * sensitive when the items in submenus might be insensitive).
256 g_object_class_install_property (gobject_class,
258 g_param_spec_boolean ("draw-sensitive",
259 P_("Draw Sensitive"),
260 P_("Whether to force cells to be drawn in a "
263 GTK_PARAM_READWRITE));
266 * GtkCellView:fit-model
268 * Whether the view should request enough space to always fit
269 * the size of every row in the model (used by the combo box to
270 * ensure the combo box size doesnt change when different items
275 g_object_class_install_property (gobject_class,
277 g_param_spec_boolean ("fit-model",
279 P_("Whether to request enough space for "
280 "every row in the model"),
282 GTK_PARAM_READWRITE));
285 #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))
287 ADD_SET_PROP ("background-set", PROP_BACKGROUND_SET,
288 P_("Background set"),
289 P_("Whether this tag affects the background color"));
291 g_type_class_add_private (gobject_class, sizeof (GtkCellViewPrivate));
295 gtk_cell_view_buildable_init (GtkBuildableIface *iface)
297 parent_buildable_iface = g_type_interface_peek_parent (iface);
298 iface->add_child = _gtk_cell_layout_buildable_add_child;
299 iface->custom_tag_start = gtk_cell_view_buildable_custom_tag_start;
300 iface->custom_tag_end = gtk_cell_view_buildable_custom_tag_end;
304 gtk_cell_view_cell_layout_init (GtkCellLayoutIface *iface)
306 iface->get_area = gtk_cell_view_cell_layout_get_area;
310 gtk_cell_view_constructor (GType type,
311 guint n_construct_properties,
312 GObjectConstructParam *construct_properties)
316 GtkCellViewPrivate *priv;
318 object = G_OBJECT_CLASS (gtk_cell_view_parent_class)->constructor
319 (type, n_construct_properties, construct_properties);
321 view = GTK_CELL_VIEW (object);
326 GtkCellArea *area = gtk_cell_area_box_new ();
328 priv->area = g_object_ref_sink (area);
332 priv->context = gtk_cell_area_create_context (priv->area);
334 priv->size_changed_id =
335 g_signal_connect (priv->context, "notify",
336 G_CALLBACK (context_size_changed_cb), view);
342 gtk_cell_view_get_property (GObject *object,
347 GtkCellView *view = GTK_CELL_VIEW (object);
351 case PROP_BACKGROUND_GDK:
355 color.red = (guint) (view->priv->background.red * 65535);
356 color.green = (guint) (view->priv->background.green * 65535);
357 color.blue = (guint) (view->priv->background.blue * 65535);
360 g_value_set_boxed (value, &color);
363 case PROP_BACKGROUND_RGBA:
364 g_value_set_boxed (value, &view->priv->background);
366 case PROP_BACKGROUND_SET:
367 g_value_set_boolean (value, view->priv->background_set);
370 g_value_set_object (value, view->priv->model);
373 g_value_set_object (value, view->priv->area);
375 case PROP_CELL_AREA_CONTEXT:
376 g_value_set_object (value, view->priv->context);
378 case PROP_DRAW_SENSITIVE:
379 g_value_set_boolean (value, view->priv->draw_sensitive);
382 g_value_set_boolean (value, view->priv->fit_model);
385 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
391 gtk_cell_view_set_property (GObject *object,
396 GtkCellView *view = GTK_CELL_VIEW (object);
398 GtkCellAreaContext *context;
402 case PROP_BACKGROUND:
406 if (!g_value_get_string (value))
407 gtk_cell_view_set_background_color (view, NULL);
408 else if (gdk_color_parse (g_value_get_string (value), &color))
409 gtk_cell_view_set_background_color (view, &color);
411 g_warning ("Don't know color `%s'", g_value_get_string (value));
413 g_object_notify (object, "background-gdk");
416 case PROP_BACKGROUND_GDK:
417 gtk_cell_view_set_background_color (view, g_value_get_boxed (value));
419 case PROP_BACKGROUND_RGBA:
420 gtk_cell_view_set_background_rgba (view, g_value_get_boxed (value));
422 case PROP_BACKGROUND_SET:
423 view->priv->background_set = g_value_get_boolean (value);
426 gtk_cell_view_set_model (view, g_value_get_object (value));
429 /* Construct-only, can only be assigned once */
430 area = g_value_get_object (value);
433 view->priv->area = g_object_ref_sink (area);
435 case PROP_CELL_AREA_CONTEXT:
436 /* Construct-only, can only be assigned once */
437 context = g_value_get_object (value);
440 view->priv->context = g_object_ref (context);
443 case PROP_DRAW_SENSITIVE:
444 gtk_cell_view_set_draw_sensitive (view, g_value_get_boolean (value));
448 gtk_cell_view_set_fit_model (view, g_value_get_boolean (value));
452 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
458 gtk_cell_view_init (GtkCellView *cellview)
460 GtkCellViewPrivate *priv;
462 cellview->priv = G_TYPE_INSTANCE_GET_PRIVATE (cellview,
465 priv = cellview->priv;
467 gtk_widget_set_has_window (GTK_WIDGET (cellview), FALSE);
471 gtk_cell_view_finalize (GObject *object)
473 GtkCellView *cellview = GTK_CELL_VIEW (object);
475 if (cellview->priv->displayed_row)
476 gtk_tree_row_reference_free (cellview->priv->displayed_row);
478 G_OBJECT_CLASS (gtk_cell_view_parent_class)->finalize (object);
482 gtk_cell_view_dispose (GObject *object)
484 GtkCellView *cellview = GTK_CELL_VIEW (object);
486 gtk_cell_view_set_model (cellview, NULL);
488 if (cellview->priv->area)
490 g_object_unref (cellview->priv->area);
491 cellview->priv->area = NULL;
494 if (cellview->priv->context)
496 g_signal_handler_disconnect (cellview->priv->context, cellview->priv->size_changed_id);
498 g_object_unref (cellview->priv->context);
499 cellview->priv->context = NULL;
500 cellview->priv->size_changed_id = 0;
503 G_OBJECT_CLASS (gtk_cell_view_parent_class)->dispose (object);
507 gtk_cell_view_size_allocate (GtkWidget *widget,
508 GtkAllocation *allocation)
510 GtkCellView *cellview = GTK_CELL_VIEW (widget);
511 GtkCellViewPrivate *priv = cellview->priv;
512 gint alloc_width, alloc_height;
514 gtk_widget_set_allocation (widget, allocation);
516 gtk_cell_area_context_get_allocation (priv->context, &alloc_width, &alloc_height);
518 /* The first cell view in context is responsible for allocating the context at allocate time
519 * (or the cellview has its own context and is not grouped with any other cell views)
521 * If the cellview is in "fit model" mode, we assume its not in context and needs to
522 * allocate every time.
524 if ((alloc_width <= 0 && alloc_height <= 0) || priv->fit_model)
526 gtk_cell_area_context_allocate_width (priv->context, allocation->width);
527 gtk_cell_area_context_allocate_height (priv->context, allocation->height);
532 gtk_cell_view_request_model (GtkCellView *cellview,
534 GtkOrientation orientation,
539 GtkCellViewPrivate *priv = cellview->priv;
543 valid = gtk_tree_model_iter_children (priv->model, &iter, parent);
548 gtk_cell_area_apply_attributes (priv->area, priv->model, &iter, FALSE, FALSE);
550 if (orientation == GTK_ORIENTATION_HORIZONTAL)
553 gtk_cell_area_get_preferred_width (priv->area, priv->context,
554 GTK_WIDGET (cellview), &min, &nat);
556 gtk_cell_area_get_preferred_width_for_height (priv->area, priv->context,
557 GTK_WIDGET (cellview), for_size, &min, &nat);
562 gtk_cell_area_get_preferred_height (priv->area, priv->context,
563 GTK_WIDGET (cellview), &min, &nat);
565 gtk_cell_area_get_preferred_height_for_width (priv->area, priv->context,
566 GTK_WIDGET (cellview), for_size, &min, &nat);
569 *minimum_size = MAX (min, *minimum_size);
570 *natural_size = MAX (nat, *natural_size);
572 /* Recurse into children when they exist */
573 gtk_cell_view_request_model (cellview, &iter, orientation, for_size, minimum_size, natural_size);
575 valid = gtk_tree_model_iter_next (priv->model, &iter);
580 gtk_cell_view_get_preferred_width (GtkWidget *widget,
584 GtkCellView *cellview = GTK_CELL_VIEW (widget);
585 GtkCellViewPrivate *priv = cellview->priv;
587 g_signal_handler_block (priv->context, priv->size_changed_id);
591 gint min = 0, nat = 0;
592 gtk_cell_view_request_model (cellview, NULL, GTK_ORIENTATION_HORIZONTAL, -1, &min, &nat);
596 if (cellview->priv->displayed_row)
597 gtk_cell_view_set_cell_data (cellview);
599 gtk_cell_area_get_preferred_width (priv->area, priv->context, widget, NULL, NULL);
602 gtk_cell_area_context_sum_preferred_width (priv->context);
603 gtk_cell_area_context_get_preferred_width (priv->context, minimum_size, natural_size);
605 g_signal_handler_unblock (priv->context, priv->size_changed_id);
609 gtk_cell_view_get_preferred_height (GtkWidget *widget,
613 GtkCellView *cellview = GTK_CELL_VIEW (widget);
614 GtkCellViewPrivate *priv = cellview->priv;
616 g_signal_handler_block (priv->context, priv->size_changed_id);
620 gint min = 0, nat = 0;
621 gtk_cell_view_request_model (cellview, NULL, GTK_ORIENTATION_VERTICAL, -1, &min, &nat);
625 if (cellview->priv->displayed_row)
626 gtk_cell_view_set_cell_data (cellview);
628 gtk_cell_area_get_preferred_height (priv->area, priv->context, widget, NULL, NULL);
631 gtk_cell_area_context_sum_preferred_height (priv->context);
632 gtk_cell_area_context_get_preferred_height (priv->context, minimum_size, natural_size);
634 g_signal_handler_unblock (priv->context, priv->size_changed_id);
638 gtk_cell_view_get_preferred_width_for_height (GtkWidget *widget,
643 GtkCellView *cellview = GTK_CELL_VIEW (widget);
644 GtkCellViewPrivate *priv = cellview->priv;
648 gint min = 0, nat = 0;
649 gtk_cell_view_request_model (cellview, NULL, GTK_ORIENTATION_HORIZONTAL, for_size, &min, &nat);
656 if (cellview->priv->displayed_row)
657 gtk_cell_view_set_cell_data (cellview);
659 gtk_cell_area_get_preferred_width_for_height (priv->area, priv->context, widget,
660 for_size, minimum_size, natural_size);
665 gtk_cell_view_get_preferred_height_for_width (GtkWidget *widget,
670 GtkCellView *cellview = GTK_CELL_VIEW (widget);
671 GtkCellViewPrivate *priv = cellview->priv;
675 gint min = 0, nat = 0;
676 gtk_cell_view_request_model (cellview, NULL, GTK_ORIENTATION_VERTICAL, for_size, &min, &nat);
683 if (cellview->priv->displayed_row)
684 gtk_cell_view_set_cell_data (cellview);
686 gtk_cell_area_get_preferred_height_for_width (priv->area, priv->context, widget,
687 for_size, minimum_size, natural_size);
692 gtk_cell_view_draw (GtkWidget *widget,
695 GtkCellView *cellview;
697 GtkCellRendererState state;
699 cellview = GTK_CELL_VIEW (widget);
704 area.width = gtk_widget_get_allocated_width (widget);
705 area.height = gtk_widget_get_allocated_height (widget);
707 /* "blank" background */
708 if (cellview->priv->background_set)
710 gdk_cairo_rectangle (cr, &area);
711 gdk_cairo_set_source_rgba (cr, &cellview->priv->background);
715 /* set cell data (if available) */
716 if (cellview->priv->displayed_row)
717 gtk_cell_view_set_cell_data (cellview);
718 else if (cellview->priv->model)
721 if (gtk_widget_get_state_flags (widget) & GTK_STATE_FLAG_PRELIGHT)
722 state = GTK_CELL_RENDERER_PRELIT;
723 else if (gtk_widget_get_state_flags (widget) & GTK_STATE_FLAG_INSENSITIVE)
724 state = GTK_CELL_RENDERER_INSENSITIVE;
728 /* Render the cells */
729 gtk_cell_area_render (cellview->priv->area, cellview->priv->context,
730 widget, cr, &area, &area, state, FALSE);
736 gtk_cell_view_set_cell_data (GtkCellView *cell_view)
741 g_return_if_fail (cell_view->priv->displayed_row != NULL);
743 path = gtk_tree_row_reference_get_path (cell_view->priv->displayed_row);
747 gtk_tree_model_get_iter (cell_view->priv->model, &iter, path);
748 gtk_tree_path_free (path);
750 gtk_cell_area_apply_attributes (cell_view->priv->area,
751 cell_view->priv->model,
752 &iter, FALSE, FALSE);
754 if (cell_view->priv->draw_sensitive)
757 gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (cell_view->priv->area));
759 for (l = cells; l; l = l->next)
761 GObject *renderer = l->data;
763 g_object_set (renderer, "sensitive", TRUE, NULL);
769 /* GtkCellLayout implementation */
771 gtk_cell_view_cell_layout_get_area (GtkCellLayout *layout)
773 GtkCellView *cellview = GTK_CELL_VIEW (layout);
775 return cellview->priv->area;
778 /* GtkBuildable implementation */
780 gtk_cell_view_buildable_custom_tag_start (GtkBuildable *buildable,
783 const gchar *tagname,
784 GMarkupParser *parser,
787 if (parent_buildable_iface->custom_tag_start &&
788 parent_buildable_iface->custom_tag_start (buildable, builder, child,
789 tagname, parser, data))
792 return _gtk_cell_layout_buildable_custom_tag_start (buildable, builder, child,
793 tagname, parser, data);
797 gtk_cell_view_buildable_custom_tag_end (GtkBuildable *buildable,
800 const gchar *tagname,
803 if (strcmp (tagname, "attributes") == 0 || strcmp (tagname, "cell-packing") == 0)
804 _gtk_cell_layout_buildable_custom_tag_end (buildable, builder, child, tagname,
806 else if (parent_buildable_iface->custom_tag_end)
807 parent_buildable_iface->custom_tag_end (buildable, builder, child, tagname,
812 context_size_changed_cb (GtkCellAreaContext *context,
816 if (!strcmp (pspec->name, "minimum-width") ||
817 !strcmp (pspec->name, "natural-width") ||
818 !strcmp (pspec->name, "minimum-height") ||
819 !strcmp (pspec->name, "natural-height"))
820 gtk_widget_queue_resize (view);
824 row_changed_cb (GtkTreeModel *model,
829 GtkTreePath *row_path;
831 if (view->priv->displayed_row)
834 gtk_tree_row_reference_get_path (view->priv->displayed_row);
838 /* Resize everything in our context if our row changed */
839 if (gtk_tree_path_compare (row_path, path) == 0)
840 gtk_cell_area_context_flush (view->priv->context);
842 gtk_tree_path_free (row_path);
850 * Creates a new #GtkCellView widget.
852 * Return value: A newly created #GtkCellView widget.
857 gtk_cell_view_new (void)
859 GtkCellView *cellview;
861 cellview = g_object_new (gtk_cell_view_get_type (), NULL);
863 return GTK_WIDGET (cellview);
868 * gtk_cell_view_new_with_context:
869 * @area: the #GtkCellArea to layout cells
870 * @context: the #GtkCellAreaContext in which to calculate cell geometry
872 * Creates a new #GtkCellView widget with a specific #GtkCellArea
873 * to layout cells and a specific #GtkCellAreaContext.
875 * Specifying the same context for a handfull of cells lets
876 * the underlying area synchronize the geometry for those cells,
877 * in this way alignments with cellviews for other rows are
880 * Return value: A newly created #GtkCellView widget.
885 gtk_cell_view_new_with_context (GtkCellArea *area,
886 GtkCellAreaContext *context)
888 g_return_val_if_fail (GTK_IS_CELL_AREA (area), NULL);
889 g_return_val_if_fail (context == NULL || GTK_IS_CELL_AREA_CONTEXT (context), NULL);
891 return (GtkWidget *)g_object_new (GTK_TYPE_CELL_VIEW,
893 "cell-area-context", context,
898 * gtk_cell_view_new_with_text:
899 * @text: the text to display in the cell view
901 * Creates a new #GtkCellView widget, adds a #GtkCellRendererText
902 * to it, and makes its show @text.
904 * Return value: A newly created #GtkCellView widget.
909 gtk_cell_view_new_with_text (const gchar *text)
911 GtkCellView *cellview;
912 GtkCellRenderer *renderer;
913 GValue value = {0, };
915 cellview = GTK_CELL_VIEW (gtk_cell_view_new ());
917 renderer = gtk_cell_renderer_text_new ();
918 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (cellview),
921 g_value_init (&value, G_TYPE_STRING);
922 g_value_set_string (&value, text);
923 gtk_cell_view_set_value (cellview, renderer, "text", &value);
924 g_value_unset (&value);
926 return GTK_WIDGET (cellview);
930 * gtk_cell_view_new_with_markup:
931 * @markup: the text to display in the cell view
933 * Creates a new #GtkCellView widget, adds a #GtkCellRendererText
934 * to it, and makes it show @markup. The text can be
935 * marked up with the <link linkend="PangoMarkupFormat">Pango text
936 * markup language</link>.
938 * Return value: A newly created #GtkCellView widget.
943 gtk_cell_view_new_with_markup (const gchar *markup)
945 GtkCellView *cellview;
946 GtkCellRenderer *renderer;
947 GValue value = {0, };
949 cellview = GTK_CELL_VIEW (gtk_cell_view_new ());
951 renderer = gtk_cell_renderer_text_new ();
952 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (cellview),
955 g_value_init (&value, G_TYPE_STRING);
956 g_value_set_string (&value, markup);
957 gtk_cell_view_set_value (cellview, renderer, "markup", &value);
958 g_value_unset (&value);
960 return GTK_WIDGET (cellview);
964 * gtk_cell_view_new_with_pixbuf:
965 * @pixbuf: the image to display in the cell view
967 * Creates a new #GtkCellView widget, adds a #GtkCellRendererPixbuf
968 * to it, and makes its show @pixbuf.
970 * Return value: A newly created #GtkCellView widget.
975 gtk_cell_view_new_with_pixbuf (GdkPixbuf *pixbuf)
977 GtkCellView *cellview;
978 GtkCellRenderer *renderer;
979 GValue value = {0, };
981 cellview = GTK_CELL_VIEW (gtk_cell_view_new ());
983 renderer = gtk_cell_renderer_pixbuf_new ();
984 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (cellview),
987 g_value_init (&value, GDK_TYPE_PIXBUF);
988 g_value_set_object (&value, pixbuf);
989 gtk_cell_view_set_value (cellview, renderer, "pixbuf", &value);
990 g_value_unset (&value);
992 return GTK_WIDGET (cellview);
996 * gtk_cell_view_set_value:
997 * @cell_view: a #GtkCellView widget
998 * @renderer: one of the renderers of @cell_view
999 * @property: the name of the property of @renderer to set
1000 * @value: the new value to set the property to
1002 * Sets a property of a cell renderer of @cell_view, and
1003 * makes sure the display of @cell_view is updated.
1008 gtk_cell_view_set_value (GtkCellView *cell_view,
1009 GtkCellRenderer *renderer,
1013 g_object_set_property (G_OBJECT (renderer), property, value);
1015 /* force resize and redraw */
1016 gtk_widget_queue_resize (GTK_WIDGET (cell_view));
1017 gtk_widget_queue_draw (GTK_WIDGET (cell_view));
1021 * gtk_cell_view_set_model:
1022 * @cell_view: a #GtkCellView
1023 * @model: (allow-none): a #GtkTreeModel
1025 * Sets the model for @cell_view. If @cell_view already has a model
1026 * set, it will remove it before setting the new model. If @model is
1027 * %NULL, then it will unset the old model.
1032 gtk_cell_view_set_model (GtkCellView *cell_view,
1033 GtkTreeModel *model)
1035 g_return_if_fail (GTK_IS_CELL_VIEW (cell_view));
1036 g_return_if_fail (model == NULL || GTK_IS_TREE_MODEL (model));
1038 if (cell_view->priv->model)
1040 g_signal_handler_disconnect (cell_view->priv->model,
1041 cell_view->priv->row_changed_id);
1042 cell_view->priv->row_changed_id = 0;
1044 if (cell_view->priv->displayed_row)
1045 gtk_tree_row_reference_free (cell_view->priv->displayed_row);
1046 cell_view->priv->displayed_row = NULL;
1048 g_object_unref (cell_view->priv->model);
1049 cell_view->priv->model = NULL;
1052 cell_view->priv->model = model;
1054 if (cell_view->priv->model)
1056 g_object_ref (cell_view->priv->model);
1058 cell_view->priv->row_changed_id =
1059 g_signal_connect (cell_view->priv->model, "row-changed",
1060 G_CALLBACK (row_changed_cb), cell_view);
1065 * gtk_cell_view_get_model:
1066 * @cell_view: a #GtkCellView
1068 * Returns the model for @cell_view. If no model is used %NULL is
1071 * Returns: (transfer none): a #GtkTreeModel used or %NULL
1076 gtk_cell_view_get_model (GtkCellView *cell_view)
1078 g_return_val_if_fail (GTK_IS_CELL_VIEW (cell_view), NULL);
1080 return cell_view->priv->model;
1084 * gtk_cell_view_set_displayed_row:
1085 * @cell_view: a #GtkCellView
1086 * @path: (allow-none): a #GtkTreePath or %NULL to unset.
1088 * Sets the row of the model that is currently displayed
1089 * by the #GtkCellView. If the path is unset, then the
1090 * contents of the cellview "stick" at their last value;
1091 * this is not normally a desired result, but may be
1092 * a needed intermediate state if say, the model for
1093 * the #GtkCellView becomes temporarily empty.
1098 gtk_cell_view_set_displayed_row (GtkCellView *cell_view,
1101 g_return_if_fail (GTK_IS_CELL_VIEW (cell_view));
1102 g_return_if_fail (GTK_IS_TREE_MODEL (cell_view->priv->model));
1104 if (cell_view->priv->displayed_row)
1105 gtk_tree_row_reference_free (cell_view->priv->displayed_row);
1109 cell_view->priv->displayed_row =
1110 gtk_tree_row_reference_new (cell_view->priv->model, path);
1113 cell_view->priv->displayed_row = NULL;
1115 /* force resize and redraw */
1116 gtk_widget_queue_resize (GTK_WIDGET (cell_view));
1117 gtk_widget_queue_draw (GTK_WIDGET (cell_view));
1121 * gtk_cell_view_get_displayed_row:
1122 * @cell_view: a #GtkCellView
1124 * Returns a #GtkTreePath referring to the currently
1125 * displayed row. If no row is currently displayed,
1126 * %NULL is returned.
1128 * Returns: the currently displayed row or %NULL
1133 gtk_cell_view_get_displayed_row (GtkCellView *cell_view)
1135 g_return_val_if_fail (GTK_IS_CELL_VIEW (cell_view), NULL);
1137 if (!cell_view->priv->displayed_row)
1140 return gtk_tree_row_reference_get_path (cell_view->priv->displayed_row);
1144 * gtk_cell_view_get_size_of_row:
1145 * @cell_view: a #GtkCellView
1146 * @path: a #GtkTreePath
1147 * @requisition: return location for the size
1149 * Sets @requisition to the size needed by @cell_view to display
1150 * the model row pointed to by @path.
1152 * Return value: %TRUE
1156 * Deprecated: 3.0: Combo box formerly used this to calculate the
1157 * sizes for cellviews, now you can achieve this by either using
1158 * the #GtkCellView:fit-model property or by setting the currently
1159 * displayed row of the #GtkCellView and using gtk_widget_get_preferred_size().
1162 gtk_cell_view_get_size_of_row (GtkCellView *cell_view,
1164 GtkRequisition *requisition)
1166 GtkTreeRowReference *tmp;
1169 g_return_val_if_fail (GTK_IS_CELL_VIEW (cell_view), FALSE);
1170 g_return_val_if_fail (path != NULL, FALSE);
1172 tmp = cell_view->priv->displayed_row;
1173 cell_view->priv->displayed_row =
1174 gtk_tree_row_reference_new (cell_view->priv->model, path);
1176 gtk_widget_get_preferred_width (GTK_WIDGET (cell_view), &req.width, NULL);
1177 gtk_widget_get_preferred_height_for_width (GTK_WIDGET (cell_view), req.width, &req.height, NULL);
1179 gtk_tree_row_reference_free (cell_view->priv->displayed_row);
1180 cell_view->priv->displayed_row = tmp;
1189 * gtk_cell_view_set_background_color:
1190 * @cell_view: a #GtkCellView
1191 * @color: the new background color
1193 * Sets the background color of @view.
1198 gtk_cell_view_set_background_color (GtkCellView *cell_view,
1199 const GdkColor *color)
1201 g_return_if_fail (GTK_IS_CELL_VIEW (cell_view));
1205 if (!cell_view->priv->background_set)
1207 cell_view->priv->background_set = TRUE;
1208 g_object_notify (G_OBJECT (cell_view), "background-set");
1211 cell_view->priv->background.red = color->red / 65535.;
1212 cell_view->priv->background.green = color->green / 65535.;
1213 cell_view->priv->background.blue = color->blue / 65535.;
1214 cell_view->priv->background.alpha = 1;
1218 if (cell_view->priv->background_set)
1220 cell_view->priv->background_set = FALSE;
1221 g_object_notify (G_OBJECT (cell_view), "background-set");
1225 gtk_widget_queue_draw (GTK_WIDGET (cell_view));
1229 * gtk_cell_view_set_background_rgba:
1230 * @cell_view: a #GtkCellView
1231 * @rgba: the new background color
1233 * Sets the background color of @cell_view.
1238 gtk_cell_view_set_background_rgba (GtkCellView *cell_view,
1239 const GdkRGBA *rgba)
1241 g_return_if_fail (GTK_IS_CELL_VIEW (cell_view));
1245 if (!cell_view->priv->background_set)
1247 cell_view->priv->background_set = TRUE;
1248 g_object_notify (G_OBJECT (cell_view), "background-set");
1251 cell_view->priv->background = *rgba;
1255 if (cell_view->priv->background_set)
1257 cell_view->priv->background_set = FALSE;
1258 g_object_notify (G_OBJECT (cell_view), "background-set");
1262 gtk_widget_queue_draw (GTK_WIDGET (cell_view));
1266 gtk_cell_view_get_draw_sensitive (GtkCellView *cell_view)
1268 GtkCellViewPrivate *priv;
1270 g_return_val_if_fail (GTK_IS_CELL_VIEW (cell_view), FALSE);
1272 priv = cell_view->priv;
1274 return priv->draw_sensitive;
1278 gtk_cell_view_set_draw_sensitive (GtkCellView *cell_view,
1279 gboolean draw_sensitive)
1281 GtkCellViewPrivate *priv;
1283 g_return_if_fail (GTK_IS_CELL_VIEW (cell_view));
1285 priv = cell_view->priv;
1287 if (priv->draw_sensitive != draw_sensitive)
1289 priv->draw_sensitive = draw_sensitive;
1291 g_object_notify (G_OBJECT (cell_view), "draw-sensitive");
1296 gtk_cell_view_get_fit_model (GtkCellView *cell_view)
1298 GtkCellViewPrivate *priv;
1300 g_return_val_if_fail (GTK_IS_CELL_VIEW (cell_view), FALSE);
1302 priv = cell_view->priv;
1304 return priv->fit_model;
1308 gtk_cell_view_set_fit_model (GtkCellView *cell_view,
1311 GtkCellViewPrivate *priv;
1313 g_return_if_fail (GTK_IS_CELL_VIEW (cell_view));
1315 priv = cell_view->priv;
1317 if (priv->fit_model != fit_model)
1319 priv->fit_model = fit_model;
1321 gtk_cell_area_context_flush (cell_view->priv->context);
1323 g_object_notify (G_OBJECT (cell_view), "fit-model");