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"
25 #include "gtkcellrenderertext.h"
26 #include "gtkcellrendererpixbuf.h"
27 #include "gtkprivate.h"
28 #include "gtksizerequest.h"
29 #include <gobject/gmarshal.h>
30 #include "gtkbuildable.h"
35 * @Short_description: A widget displaying a single row of a GtkTreeModel
38 * A #GtkCellView displays a single row of a #GtkTreeModel, using
39 * cell renderers just like #GtkTreeView. #GtkCellView doesn't support
40 * some of the more complex features of #GtkTreeView, like cell editing
46 typedef struct _GtkCellViewCellInfo GtkCellViewCellInfo;
47 struct _GtkCellViewCellInfo
49 GtkCellRenderer *cell;
59 GtkCellLayoutDataFunc func;
61 GDestroyNotify destroy;
64 struct _GtkCellViewPrivate
67 GtkTreeRowReference *displayed_row;
72 gboolean background_set;
76 static void gtk_cell_view_cell_layout_init (GtkCellLayoutIface *iface);
77 static void gtk_cell_view_get_property (GObject *object,
81 static void gtk_cell_view_set_property (GObject *object,
85 static void gtk_cell_view_finalize (GObject *object);
86 static void gtk_cell_view_size_allocate (GtkWidget *widget,
87 GtkAllocation *allocation);
88 static gboolean gtk_cell_view_draw (GtkWidget *widget,
90 static void gtk_cell_view_set_value (GtkCellView *cell_view,
91 GtkCellRenderer *renderer,
94 static GtkCellViewCellInfo *gtk_cell_view_get_cell_info (GtkCellView *cellview,
95 GtkCellRenderer *renderer);
96 static void gtk_cell_view_set_cell_data (GtkCellView *cell_view);
99 static void gtk_cell_view_cell_layout_pack_start (GtkCellLayout *layout,
100 GtkCellRenderer *renderer,
102 static void gtk_cell_view_cell_layout_pack_end (GtkCellLayout *layout,
103 GtkCellRenderer *renderer,
105 static void gtk_cell_view_cell_layout_add_attribute (GtkCellLayout *layout,
106 GtkCellRenderer *renderer,
107 const gchar *attribute,
109 static void gtk_cell_view_cell_layout_clear (GtkCellLayout *layout);
110 static void gtk_cell_view_cell_layout_clear_attributes (GtkCellLayout *layout,
111 GtkCellRenderer *renderer);
112 static void gtk_cell_view_cell_layout_set_cell_data_func (GtkCellLayout *layout,
113 GtkCellRenderer *cell,
114 GtkCellLayoutDataFunc func,
116 GDestroyNotify destroy);
117 static void gtk_cell_view_cell_layout_reorder (GtkCellLayout *layout,
118 GtkCellRenderer *cell,
120 static GList * gtk_cell_view_cell_layout_get_cells (GtkCellLayout *layout);
123 static void gtk_cell_view_buildable_init (GtkBuildableIface *iface);
124 static gboolean gtk_cell_view_buildable_custom_tag_start (GtkBuildable *buildable,
127 const gchar *tagname,
128 GMarkupParser *parser,
130 static void gtk_cell_view_buildable_custom_tag_end (GtkBuildable *buildable,
133 const gchar *tagname,
136 static void gtk_cell_view_get_preferred_width (GtkWidget *widget,
139 static void gtk_cell_view_get_preferred_height (GtkWidget *widget,
142 static void gtk_cell_view_get_preferred_width_for_height (GtkWidget *widget,
146 static void gtk_cell_view_get_preferred_height_for_width (GtkWidget *widget,
151 static GtkBuildableIface *parent_buildable_iface;
159 PROP_BACKGROUND_RGBA,
164 G_DEFINE_TYPE_WITH_CODE (GtkCellView, gtk_cell_view, GTK_TYPE_WIDGET,
165 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_LAYOUT,
166 gtk_cell_view_cell_layout_init)
167 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
168 gtk_cell_view_buildable_init))
172 gtk_cell_view_class_init (GtkCellViewClass *klass)
174 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
175 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
177 gobject_class->get_property = gtk_cell_view_get_property;
178 gobject_class->set_property = gtk_cell_view_set_property;
179 gobject_class->finalize = gtk_cell_view_finalize;
181 widget_class->draw = gtk_cell_view_draw;
182 widget_class->size_allocate = gtk_cell_view_size_allocate;
183 widget_class->get_preferred_width = gtk_cell_view_get_preferred_width;
184 widget_class->get_preferred_height = gtk_cell_view_get_preferred_height;
185 widget_class->get_preferred_width_for_height = gtk_cell_view_get_preferred_width_for_height;
186 widget_class->get_preferred_height_for_width = gtk_cell_view_get_preferred_height_for_width;
189 g_object_class_install_property (gobject_class,
191 g_param_spec_string ("background",
192 P_("Background color name"),
193 P_("Background color as a string"),
195 GTK_PARAM_WRITABLE));
196 g_object_class_install_property (gobject_class,
198 g_param_spec_boxed ("background-gdk",
199 P_("Background color"),
200 P_("Background color as a GdkColor"),
202 GTK_PARAM_READWRITE));
204 * GtkCellView:background-rgba
206 * The background color as a #GdkRGBA
210 g_object_class_install_property (gobject_class,
211 PROP_BACKGROUND_RGBA,
212 g_param_spec_boxed ("background-rgba",
213 P_("Background RGBA color"),
214 P_("Background color as a GdkRGBA"),
216 GTK_PARAM_READWRITE));
221 * The model for cell view
225 g_object_class_install_property (gobject_class,
227 g_param_spec_object ("model",
228 P_("CellView model"),
229 P_("The model for cell view"),
231 GTK_PARAM_READWRITE));
233 #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))
235 ADD_SET_PROP ("background-set", PROP_BACKGROUND_SET,
236 P_("Background set"),
237 P_("Whether this tag affects the background color"));
239 g_type_class_add_private (gobject_class, sizeof (GtkCellViewPrivate));
243 gtk_cell_view_buildable_init (GtkBuildableIface *iface)
245 parent_buildable_iface = g_type_interface_peek_parent (iface);
246 iface->add_child = _gtk_cell_layout_buildable_add_child;
247 iface->custom_tag_start = gtk_cell_view_buildable_custom_tag_start;
248 iface->custom_tag_end = gtk_cell_view_buildable_custom_tag_end;
252 gtk_cell_view_cell_layout_init (GtkCellLayoutIface *iface)
254 iface->pack_start = gtk_cell_view_cell_layout_pack_start;
255 iface->pack_end = gtk_cell_view_cell_layout_pack_end;
256 iface->clear = gtk_cell_view_cell_layout_clear;
257 iface->add_attribute = gtk_cell_view_cell_layout_add_attribute;
258 iface->set_cell_data_func = gtk_cell_view_cell_layout_set_cell_data_func;
259 iface->clear_attributes = gtk_cell_view_cell_layout_clear_attributes;
260 iface->reorder = gtk_cell_view_cell_layout_reorder;
261 iface->get_cells = gtk_cell_view_cell_layout_get_cells;
265 gtk_cell_view_get_property (GObject *object,
270 GtkCellView *view = GTK_CELL_VIEW (object);
274 case PROP_BACKGROUND_GDK:
278 color.red = (guint) (view->priv->background.red * 65535);
279 color.green = (guint) (view->priv->background.green * 65535);
280 color.blue = (guint) (view->priv->background.blue * 65535);
283 g_value_set_boxed (value, &color);
286 case PROP_BACKGROUND_RGBA:
287 g_value_set_boxed (value, &view->priv->background);
289 case PROP_BACKGROUND_SET:
290 g_value_set_boolean (value, view->priv->background_set);
293 g_value_set_object (value, view->priv->model);
296 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
302 gtk_cell_view_set_property (GObject *object,
307 GtkCellView *view = GTK_CELL_VIEW (object);
311 case PROP_BACKGROUND:
315 if (!g_value_get_string (value))
316 gtk_cell_view_set_background_color (view, NULL);
317 else if (gdk_color_parse (g_value_get_string (value), &color))
318 gtk_cell_view_set_background_color (view, &color);
320 g_warning ("Don't know color `%s'", g_value_get_string (value));
322 g_object_notify (object, "background-gdk");
325 case PROP_BACKGROUND_GDK:
326 gtk_cell_view_set_background_color (view, g_value_get_boxed (value));
328 case PROP_BACKGROUND_RGBA:
329 gtk_cell_view_set_background_rgba (view, g_value_get_boxed (value));
331 case PROP_BACKGROUND_SET:
332 view->priv->background_set = g_value_get_boolean (value);
335 gtk_cell_view_set_model (view, g_value_get_object (value));
338 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
344 gtk_cell_view_init (GtkCellView *cellview)
346 GtkCellViewPrivate *priv;
348 cellview->priv = G_TYPE_INSTANCE_GET_PRIVATE (cellview,
351 priv = cellview->priv;
353 gtk_widget_set_has_window (GTK_WIDGET (cellview), FALSE);
357 gtk_cell_view_finalize (GObject *object)
359 GtkCellView *cellview = GTK_CELL_VIEW (object);
361 gtk_cell_view_cell_layout_clear (GTK_CELL_LAYOUT (cellview));
363 if (cellview->priv->model)
364 g_object_unref (cellview->priv->model);
366 if (cellview->priv->displayed_row)
367 gtk_tree_row_reference_free (cellview->priv->displayed_row);
369 G_OBJECT_CLASS (gtk_cell_view_parent_class)->finalize (object);
373 gtk_cell_view_size_allocate (GtkWidget *widget,
374 GtkAllocation *allocation)
376 GtkCellView *cellview;
377 GtkRequestedSize *sizes;
379 gint n_visible_cells, n_expand_cells;
380 gint avail_width = 0;
381 gint extra_per_cell, extra_extra, i;
382 gboolean first_cell = TRUE;
384 gtk_widget_set_allocation (widget, allocation);
386 cellview = GTK_CELL_VIEW (widget);
388 avail_width = allocation->width;
390 /* Count visible/expand children */
391 for (n_visible_cells = 0, n_expand_cells = 0, list = cellview->priv->cell_list;
392 list; list = list->next)
394 GtkCellViewCellInfo *info = (GtkCellViewCellInfo *)list->data;
402 sizes = g_new0 (GtkRequestedSize, n_visible_cells);
404 /* checking how much extra space we have */
405 for (i = 0, list = cellview->priv->cell_list; list; list = list->next)
407 GtkCellViewCellInfo *info = (GtkCellViewCellInfo *)list->data;
409 if (!gtk_cell_renderer_get_visible (info->cell))
412 sizes[i].data = info;
413 sizes[i].minimum_size = info->requested_width;
414 sizes[i].natural_size = info->natural_width;
417 avail_width -= cellview->priv->spacing;
419 avail_width -= sizes[i].minimum_size;
426 avail_width = gtk_distribute_natural_allocation (MAX (0, avail_width), n_visible_cells, sizes);
428 /* Deal with any expand space... */
429 if (n_expand_cells > 0)
431 extra_per_cell = avail_width / n_expand_cells;
432 extra_extra = avail_width % n_expand_cells;
435 /* Everything just left-aligned if no cells expand */
436 extra_per_cell = extra_extra = 0;
438 for (i = 0, list = cellview->priv->cell_list; list; list = list->next)
440 GtkCellViewCellInfo *info = (GtkCellViewCellInfo *)list->data;
442 if (!gtk_cell_renderer_get_visible (info->cell))
445 info->real_width = sizes[i].minimum_size;
449 info->real_width += extra_per_cell;
458 /* increment index into sizes for visible children */
466 gtk_cell_view_draw (GtkWidget *widget,
470 GtkCellView *cellview;
472 GtkCellRendererState state;
473 gboolean rtl = (gtk_widget_get_direction(widget) == GTK_TEXT_DIR_RTL);
477 cellview = GTK_CELL_VIEW (widget);
482 area.width = width = gtk_widget_get_allocated_width (widget);
483 area.height = gtk_widget_get_allocated_height (widget);
485 /* "blank" background */
486 if (cellview->priv->background_set)
488 gdk_cairo_rectangle (cr, &area);
489 gdk_cairo_set_source_rgba (cr, &cellview->priv->background);
493 /* set cell data (if available) */
494 if (cellview->priv->displayed_row)
495 gtk_cell_view_set_cell_data (cellview);
496 else if (cellview->priv->model)
499 if (gtk_widget_get_state_flags (widget) & GTK_STATE_FLAG_PRELIGHT)
500 state = GTK_CELL_RENDERER_PRELIT;
501 else if (gtk_widget_get_state_flags (widget) & GTK_STATE_FLAG_INSENSITIVE)
502 state = GTK_CELL_RENDERER_INSENSITIVE;
506 for (packing = GTK_PACK_START; packing <= GTK_PACK_END; ++packing)
508 if (packing == GTK_PACK_START)
509 area.x = rtl ? width : 0;
511 area.x = rtl ? 0 : width;
513 for (list = cellview->priv->cell_list; list; list = list->next)
515 GtkCellViewCellInfo *info = (GtkCellViewCellInfo *)list->data;
517 if (info->pack != packing)
520 if (!gtk_cell_renderer_get_visible (info->cell))
523 area.width = info->real_width;
525 if ((packing == GTK_PACK_START && rtl) ||
526 (packing == GTK_PACK_END && !rtl))
527 area.x -= area.width;
529 gtk_cell_renderer_render (info->cell,
533 &area, &area, state);
535 if ((packing == GTK_PACK_START && !rtl) ||
536 (packing == GTK_PACK_END && rtl))
538 area.x += area.width;
539 area.x += cellview->priv->spacing;
542 area.x -= cellview->priv->spacing;
549 static GtkCellViewCellInfo *
550 gtk_cell_view_get_cell_info (GtkCellView *cellview,
551 GtkCellRenderer *renderer)
555 for (i = cellview->priv->cell_list; i; i = i->next)
557 GtkCellViewCellInfo *info = (GtkCellViewCellInfo *)i->data;
559 if (info->cell == renderer)
567 gtk_cell_view_set_cell_data (GtkCellView *cell_view)
573 g_return_if_fail (cell_view->priv->displayed_row != NULL);
575 path = gtk_tree_row_reference_get_path (cell_view->priv->displayed_row);
579 gtk_tree_model_get_iter (cell_view->priv->model, &iter, path);
580 gtk_tree_path_free (path);
582 for (i = cell_view->priv->cell_list; i; i = i->next)
585 GtkCellViewCellInfo *info = i->data;
587 g_object_freeze_notify (G_OBJECT (info->cell));
589 for (j = info->attributes; j && j->next; j = j->next->next)
591 gchar *property = j->data;
592 gint column = GPOINTER_TO_INT (j->next->data);
593 GValue value = {0, };
595 gtk_tree_model_get_value (cell_view->priv->model, &iter,
597 g_object_set_property (G_OBJECT (info->cell),
599 g_value_unset (&value);
603 (* info->func) (GTK_CELL_LAYOUT (cell_view),
605 cell_view->priv->model,
609 g_object_thaw_notify (G_OBJECT (info->cell));
613 /* GtkCellLayout implementation */
615 gtk_cell_view_cell_layout_pack_start (GtkCellLayout *layout,
616 GtkCellRenderer *renderer,
619 GtkCellViewCellInfo *info;
620 GtkCellView *cellview = GTK_CELL_VIEW (layout);
622 g_return_if_fail (!gtk_cell_view_get_cell_info (cellview, renderer));
624 g_object_ref_sink (renderer);
626 info = g_slice_new0 (GtkCellViewCellInfo);
627 info->cell = renderer;
628 info->expand = expand ? TRUE : FALSE;
629 info->pack = GTK_PACK_START;
631 cellview->priv->cell_list = g_list_append (cellview->priv->cell_list, info);
633 gtk_widget_queue_resize (GTK_WIDGET (cellview));
637 gtk_cell_view_cell_layout_pack_end (GtkCellLayout *layout,
638 GtkCellRenderer *renderer,
641 GtkCellViewCellInfo *info;
642 GtkCellView *cellview = GTK_CELL_VIEW (layout);
644 g_return_if_fail (!gtk_cell_view_get_cell_info (cellview, renderer));
646 g_object_ref_sink (renderer);
648 info = g_slice_new0 (GtkCellViewCellInfo);
649 info->cell = renderer;
650 info->expand = expand ? TRUE : FALSE;
651 info->pack = GTK_PACK_END;
653 cellview->priv->cell_list = g_list_append (cellview->priv->cell_list, info);
655 gtk_widget_queue_resize (GTK_WIDGET (cellview));
659 gtk_cell_view_cell_layout_add_attribute (GtkCellLayout *layout,
660 GtkCellRenderer *renderer,
661 const gchar *attribute,
664 GtkCellViewCellInfo *info;
665 GtkCellView *cellview = GTK_CELL_VIEW (layout);
667 info = gtk_cell_view_get_cell_info (cellview, renderer);
668 g_return_if_fail (info != NULL);
670 info->attributes = g_slist_prepend (info->attributes,
671 GINT_TO_POINTER (column));
672 info->attributes = g_slist_prepend (info->attributes,
673 g_strdup (attribute));
677 gtk_cell_view_cell_layout_clear (GtkCellLayout *layout)
679 GtkCellView *cellview = GTK_CELL_VIEW (layout);
681 while (cellview->priv->cell_list)
683 GtkCellViewCellInfo *info = (GtkCellViewCellInfo *)cellview->priv->cell_list->data;
685 gtk_cell_view_cell_layout_clear_attributes (layout, info->cell);
686 g_object_unref (info->cell);
687 g_slice_free (GtkCellViewCellInfo, info);
688 cellview->priv->cell_list = g_list_delete_link (cellview->priv->cell_list,
689 cellview->priv->cell_list);
694 gtk_cell_view_cell_layout_set_cell_data_func (GtkCellLayout *layout,
695 GtkCellRenderer *cell,
696 GtkCellLayoutDataFunc func,
698 GDestroyNotify destroy)
700 GtkCellView *cellview = GTK_CELL_VIEW (layout);
701 GtkCellViewCellInfo *info;
703 info = gtk_cell_view_get_cell_info (cellview, cell);
704 g_return_if_fail (info != NULL);
708 GDestroyNotify d = info->destroy;
710 info->destroy = NULL;
715 info->func_data = func_data;
716 info->destroy = destroy;
720 gtk_cell_view_cell_layout_clear_attributes (GtkCellLayout *layout,
721 GtkCellRenderer *renderer)
723 GtkCellView *cellview = GTK_CELL_VIEW (layout);
724 GtkCellViewCellInfo *info;
727 info = gtk_cell_view_get_cell_info (cellview, renderer);
730 list = info->attributes;
731 while (list && list->next)
734 list = list->next->next;
737 g_slist_free (info->attributes);
738 info->attributes = NULL;
743 gtk_cell_view_cell_layout_reorder (GtkCellLayout *layout,
744 GtkCellRenderer *cell,
747 GtkCellView *cellview = GTK_CELL_VIEW (layout);
748 GtkCellViewCellInfo *info;
751 info = gtk_cell_view_get_cell_info (cellview, cell);
753 g_return_if_fail (info != NULL);
754 g_return_if_fail (position >= 0);
756 link = g_list_find (cellview->priv->cell_list, info);
758 g_return_if_fail (link != NULL);
760 cellview->priv->cell_list = g_list_delete_link (cellview->priv->cell_list,
762 cellview->priv->cell_list = g_list_insert (cellview->priv->cell_list,
765 gtk_widget_queue_draw (GTK_WIDGET (cellview));
771 * Creates a new #GtkCellView widget.
773 * Return value: A newly created #GtkCellView widget.
778 gtk_cell_view_new (void)
780 GtkCellView *cellview;
782 cellview = g_object_new (gtk_cell_view_get_type (), NULL);
784 return GTK_WIDGET (cellview);
788 * gtk_cell_view_new_with_text:
789 * @text: the text to display in the cell view
791 * Creates a new #GtkCellView widget, adds a #GtkCellRendererText
792 * to it, and makes its show @text.
794 * Return value: A newly created #GtkCellView widget.
799 gtk_cell_view_new_with_text (const gchar *text)
801 GtkCellView *cellview;
802 GtkCellRenderer *renderer;
803 GValue value = {0, };
805 cellview = GTK_CELL_VIEW (gtk_cell_view_new ());
807 renderer = gtk_cell_renderer_text_new ();
808 gtk_cell_view_cell_layout_pack_start (GTK_CELL_LAYOUT (cellview),
811 g_value_init (&value, G_TYPE_STRING);
812 g_value_set_string (&value, text);
813 gtk_cell_view_set_value (cellview, renderer, "text", &value);
814 g_value_unset (&value);
816 return GTK_WIDGET (cellview);
820 * gtk_cell_view_new_with_markup:
821 * @markup: the text to display in the cell view
823 * Creates a new #GtkCellView widget, adds a #GtkCellRendererText
824 * to it, and makes it show @markup. The text can be
825 * marked up with the <link linkend="PangoMarkupFormat">Pango text
826 * markup language</link>.
828 * Return value: A newly created #GtkCellView widget.
833 gtk_cell_view_new_with_markup (const gchar *markup)
835 GtkCellView *cellview;
836 GtkCellRenderer *renderer;
837 GValue value = {0, };
839 cellview = GTK_CELL_VIEW (gtk_cell_view_new ());
841 renderer = gtk_cell_renderer_text_new ();
842 gtk_cell_view_cell_layout_pack_start (GTK_CELL_LAYOUT (cellview),
845 g_value_init (&value, G_TYPE_STRING);
846 g_value_set_string (&value, markup);
847 gtk_cell_view_set_value (cellview, renderer, "markup", &value);
848 g_value_unset (&value);
850 return GTK_WIDGET (cellview);
854 * gtk_cell_view_new_with_pixbuf:
855 * @pixbuf: the image to display in the cell view
857 * Creates a new #GtkCellView widget, adds a #GtkCellRendererPixbuf
858 * to it, and makes its show @pixbuf.
860 * Return value: A newly created #GtkCellView widget.
865 gtk_cell_view_new_with_pixbuf (GdkPixbuf *pixbuf)
867 GtkCellView *cellview;
868 GtkCellRenderer *renderer;
869 GValue value = {0, };
871 cellview = GTK_CELL_VIEW (gtk_cell_view_new ());
873 renderer = gtk_cell_renderer_pixbuf_new ();
874 gtk_cell_view_cell_layout_pack_start (GTK_CELL_LAYOUT (cellview),
877 g_value_init (&value, GDK_TYPE_PIXBUF);
878 g_value_set_object (&value, pixbuf);
879 gtk_cell_view_set_value (cellview, renderer, "pixbuf", &value);
880 g_value_unset (&value);
882 return GTK_WIDGET (cellview);
886 * gtk_cell_view_set_value:
887 * @cell_view: a #GtkCellView widget
888 * @renderer: one of the renderers of @cell_view
889 * @property: the name of the property of @renderer to set
890 * @value: the new value to set the property to
892 * Sets a property of a cell renderer of @cell_view, and
893 * makes sure the display of @cell_view is updated.
898 gtk_cell_view_set_value (GtkCellView *cell_view,
899 GtkCellRenderer *renderer,
903 g_object_set_property (G_OBJECT (renderer), property, value);
905 /* force resize and redraw */
906 gtk_widget_queue_resize (GTK_WIDGET (cell_view));
907 gtk_widget_queue_draw (GTK_WIDGET (cell_view));
911 * gtk_cell_view_set_model:
912 * @cell_view: a #GtkCellView
913 * @model: (allow-none): a #GtkTreeModel
915 * Sets the model for @cell_view. If @cell_view already has a model
916 * set, it will remove it before setting the new model. If @model is
917 * %NULL, then it will unset the old model.
922 gtk_cell_view_set_model (GtkCellView *cell_view,
925 g_return_if_fail (GTK_IS_CELL_VIEW (cell_view));
926 g_return_if_fail (model == NULL || GTK_IS_TREE_MODEL (model));
928 if (cell_view->priv->model)
930 if (cell_view->priv->displayed_row)
931 gtk_tree_row_reference_free (cell_view->priv->displayed_row);
932 cell_view->priv->displayed_row = NULL;
934 g_object_unref (cell_view->priv->model);
935 cell_view->priv->model = NULL;
938 cell_view->priv->model = model;
940 if (cell_view->priv->model)
941 g_object_ref (cell_view->priv->model);
945 * gtk_cell_view_get_model:
946 * @cell_view: a #GtkCellView
948 * Returns the model for @cell_view. If no model is used %NULL is
951 * Returns: (transfer none): a #GtkTreeModel used or %NULL
956 gtk_cell_view_get_model (GtkCellView *cell_view)
958 g_return_val_if_fail (GTK_IS_CELL_VIEW (cell_view), NULL);
960 return cell_view->priv->model;
964 * gtk_cell_view_set_displayed_row:
965 * @cell_view: a #GtkCellView
966 * @path: (allow-none): a #GtkTreePath or %NULL to unset.
968 * Sets the row of the model that is currently displayed
969 * by the #GtkCellView. If the path is unset, then the
970 * contents of the cellview "stick" at their last value;
971 * this is not normally a desired result, but may be
972 * a needed intermediate state if say, the model for
973 * the #GtkCellView becomes temporarily empty.
978 gtk_cell_view_set_displayed_row (GtkCellView *cell_view,
981 g_return_if_fail (GTK_IS_CELL_VIEW (cell_view));
982 g_return_if_fail (GTK_IS_TREE_MODEL (cell_view->priv->model));
984 if (cell_view->priv->displayed_row)
985 gtk_tree_row_reference_free (cell_view->priv->displayed_row);
989 cell_view->priv->displayed_row =
990 gtk_tree_row_reference_new (cell_view->priv->model, path);
993 cell_view->priv->displayed_row = NULL;
995 /* force resize and redraw */
996 gtk_widget_queue_resize (GTK_WIDGET (cell_view));
997 gtk_widget_queue_draw (GTK_WIDGET (cell_view));
1001 * gtk_cell_view_get_displayed_row:
1002 * @cell_view: a #GtkCellView
1004 * Returns a #GtkTreePath referring to the currently
1005 * displayed row. If no row is currently displayed,
1006 * %NULL is returned.
1008 * Returns: the currently displayed row or %NULL
1013 gtk_cell_view_get_displayed_row (GtkCellView *cell_view)
1015 g_return_val_if_fail (GTK_IS_CELL_VIEW (cell_view), NULL);
1017 if (!cell_view->priv->displayed_row)
1020 return gtk_tree_row_reference_get_path (cell_view->priv->displayed_row);
1024 * gtk_cell_view_get_size_of_row:
1025 * @cell_view: a #GtkCellView
1026 * @path: a #GtkTreePath
1027 * @requisition: return location for the size
1029 * Sets @requisition to the size needed by @cell_view to display
1030 * the model row pointed to by @path.
1032 * Return value: %TRUE
1036 * Deprecated: 3.0: Use gtk_cell_view_get_desired_width_of_row() and
1037 * gtk_cell_view_get_desired_height_for_width_of_row() instead.
1040 gtk_cell_view_get_size_of_row (GtkCellView *cell_view,
1042 GtkRequisition *requisition)
1046 g_return_val_if_fail (GTK_IS_CELL_VIEW (cell_view), FALSE);
1047 g_return_val_if_fail (path != NULL, FALSE);
1049 /* Return the minimum height for the minimum width */
1050 gtk_cell_view_get_desired_width_of_row (cell_view, path, &req.width, NULL);
1051 gtk_cell_view_get_desired_height_for_width_of_row (cell_view, path, req.width, &req.height, NULL);
1061 * gtk_cell_view_get_desired_width_of_row:
1062 * @cell_view: a #GtkCellView
1063 * @path: a #GtkTreePath
1064 * @minimum_size: location to store the minimum size
1065 * @natural_size: location to store the natural size
1067 * Sets @minimum_size and @natural_size to the width desired by @cell_view
1068 * to display the model row pointed to by @path.
1073 gtk_cell_view_get_desired_width_of_row (GtkCellView *cell_view,
1078 GtkTreeRowReference *tmp;
1080 g_return_if_fail (GTK_IS_CELL_VIEW (cell_view));
1081 g_return_if_fail (path != NULL);
1082 g_return_if_fail (minimum_size != NULL || natural_size != NULL);
1084 tmp = cell_view->priv->displayed_row;
1085 cell_view->priv->displayed_row =
1086 gtk_tree_row_reference_new (cell_view->priv->model, path);
1088 gtk_cell_view_get_preferred_width (GTK_WIDGET (cell_view), minimum_size, natural_size);
1090 gtk_tree_row_reference_free (cell_view->priv->displayed_row);
1091 cell_view->priv->displayed_row = tmp;
1093 /* Restore active size (this will restore the cellrenderer info->width/requested_width's) */
1094 gtk_cell_view_get_preferred_width (GTK_WIDGET (cell_view), NULL, NULL);
1099 * gtk_cell_view_get_desired_height_for_width_of_row:
1100 * @cell_view: a #GtkCellView
1101 * @path: a #GtkTreePath
1102 * @avail_size: available width
1103 * @minimum_size: location to store the minimum height
1104 * @natural_size: location to store the natural height
1106 * Sets @minimum_size and @natural_size to the height desired by @cell_view
1107 * if it were allocated a width of @avail_size to display the model row
1108 * pointed to by @path.
1113 gtk_cell_view_get_desired_height_for_width_of_row (GtkCellView *cell_view,
1119 GtkTreeRowReference *tmp;
1121 g_return_if_fail (GTK_IS_CELL_VIEW (cell_view));
1122 g_return_if_fail (path != NULL);
1123 g_return_if_fail (minimum_size != NULL || natural_size != NULL);
1125 tmp = cell_view->priv->displayed_row;
1126 cell_view->priv->displayed_row =
1127 gtk_tree_row_reference_new (cell_view->priv->model, path);
1129 /* Then get the collective height_for_width based on the cached values */
1130 gtk_cell_view_get_preferred_height_for_width (GTK_WIDGET (cell_view), avail_size, minimum_size, natural_size);
1132 gtk_tree_row_reference_free (cell_view->priv->displayed_row);
1133 cell_view->priv->displayed_row = tmp;
1135 /* Restore active size (this will restore the cellrenderer info->width/requested_width's) */
1136 gtk_cell_view_get_preferred_width (GTK_WIDGET (cell_view), NULL, NULL);
1140 * gtk_cell_view_set_background_color:
1141 * @cell_view: a #GtkCellView
1142 * @color: the new background color
1144 * Sets the background color of @view.
1149 gtk_cell_view_set_background_color (GtkCellView *cell_view,
1150 const GdkColor *color)
1152 g_return_if_fail (GTK_IS_CELL_VIEW (cell_view));
1156 if (!cell_view->priv->background_set)
1158 cell_view->priv->background_set = TRUE;
1159 g_object_notify (G_OBJECT (cell_view), "background-set");
1162 cell_view->priv->background.red = color->red / 65535.;
1163 cell_view->priv->background.green = color->green / 65535.;
1164 cell_view->priv->background.blue = color->blue / 65535.;
1165 cell_view->priv->background.alpha = 1;
1169 if (cell_view->priv->background_set)
1171 cell_view->priv->background_set = FALSE;
1172 g_object_notify (G_OBJECT (cell_view), "background-set");
1176 gtk_widget_queue_draw (GTK_WIDGET (cell_view));
1180 * gtk_cell_view_set_background_rgba:
1181 * @cell_view: a #GtkCellView
1182 * @rgba: the new background color
1184 * Sets the background color of @cell_view.
1189 gtk_cell_view_set_background_rgba (GtkCellView *cell_view,
1190 const GdkRGBA *rgba)
1192 g_return_if_fail (GTK_IS_CELL_VIEW (cell_view));
1196 if (!cell_view->priv->background_set)
1198 cell_view->priv->background_set = TRUE;
1199 g_object_notify (G_OBJECT (cell_view), "background-set");
1202 cell_view->priv->background = *rgba;
1206 if (cell_view->priv->background_set)
1208 cell_view->priv->background_set = FALSE;
1209 g_object_notify (G_OBJECT (cell_view), "background-set");
1213 gtk_widget_queue_draw (GTK_WIDGET (cell_view));
1217 gtk_cell_view_cell_layout_get_cells (GtkCellLayout *layout)
1219 GtkCellView *cell_view = GTK_CELL_VIEW (layout);
1220 GList *retval = NULL, *list;
1222 g_return_val_if_fail (cell_view != NULL, NULL);
1224 gtk_cell_view_set_cell_data (cell_view);
1226 for (list = cell_view->priv->cell_list; list; list = list->next)
1228 GtkCellViewCellInfo *info = (GtkCellViewCellInfo *)list->data;
1230 retval = g_list_prepend (retval, info->cell);
1233 return g_list_reverse (retval);
1237 gtk_cell_view_buildable_custom_tag_start (GtkBuildable *buildable,
1238 GtkBuilder *builder,
1240 const gchar *tagname,
1241 GMarkupParser *parser,
1244 if (parent_buildable_iface->custom_tag_start &&
1245 parent_buildable_iface->custom_tag_start (buildable, builder, child,
1246 tagname, parser, data))
1249 return _gtk_cell_layout_buildable_custom_tag_start (buildable, builder, child,
1250 tagname, parser, data);
1254 gtk_cell_view_buildable_custom_tag_end (GtkBuildable *buildable,
1255 GtkBuilder *builder,
1257 const gchar *tagname,
1260 if (strcmp (tagname, "attributes") == 0)
1261 _gtk_cell_layout_buildable_custom_tag_end (buildable, builder, child, tagname,
1263 else if (parent_buildable_iface->custom_tag_end)
1264 parent_buildable_iface->custom_tag_end (buildable, builder, child, tagname,
1269 gtk_cell_view_get_preferred_width (GtkWidget *widget,
1274 gint cell_min, cell_nat;
1275 gboolean first_cell = TRUE;
1276 GtkCellView *cellview = GTK_CELL_VIEW (widget);
1277 gint minimum, natural;
1279 minimum = natural = 0;
1281 if (cellview->priv->displayed_row)
1282 gtk_cell_view_set_cell_data (cellview);
1284 for (list = cellview->priv->cell_list; list; list = list->next)
1286 GtkCellViewCellInfo *info = (GtkCellViewCellInfo *)list->data;
1288 if (gtk_cell_renderer_get_visible (info->cell))
1293 minimum += cellview->priv->spacing;
1294 natural += cellview->priv->spacing;
1297 gtk_cell_renderer_get_preferred_width (info->cell,
1298 GTK_WIDGET (cellview), &cell_min, &cell_nat);
1300 info->requested_width = cell_min;
1301 info->natural_width = cell_nat;
1303 minimum += info->requested_width;
1304 natural += info->natural_width;
1311 *minimum_size = minimum;
1314 *natural_size = natural;
1318 gtk_cell_view_get_preferred_height (GtkWidget *widget,
1324 /* CellViews only need to respond to height-for-width mode (cellview is pretty much
1325 * an implementation detail of GtkComboBox) */
1326 gtk_cell_view_get_preferred_width (widget, &minimum_width, NULL);
1327 gtk_cell_view_get_preferred_height_for_width (widget, minimum_width, minimum_size, natural_size);
1331 gtk_cell_view_get_preferred_width_for_height (GtkWidget *widget,
1336 /* CellViews only need to respond to height-for-width mode (cellview is pretty much
1337 * an implementation detail of GtkComboBox) */
1338 gtk_cell_view_get_preferred_width (widget, minimum_size, natural_size);
1342 gtk_cell_view_get_preferred_height_for_width (GtkWidget *widget,
1347 GtkCellView *cellview = GTK_CELL_VIEW (widget);
1349 GtkRequestedSize *sizes;
1351 gint minimum, natural, avail_size;
1352 gboolean first_cell = TRUE;
1353 gint n_expand_cells = 0;
1354 gint extra_per_cell, extra_extra, i;
1356 minimum = natural = 0;
1357 avail_size = for_size;
1359 array = g_array_new (0, TRUE, sizeof (GtkRequestedSize));
1361 if (cellview->priv->displayed_row)
1362 gtk_cell_view_set_cell_data (cellview);
1364 /* First allocate the right width to all cells */
1365 for (list = cellview->priv->cell_list; list; list = list->next)
1367 GtkCellViewCellInfo *info = (GtkCellViewCellInfo *)list->data;
1369 if (gtk_cell_renderer_get_visible (info->cell))
1371 GtkRequestedSize requested;
1373 gtk_cell_renderer_get_preferred_width (GTK_CELL_RENDERER (info->cell),
1374 GTK_WIDGET (cellview),
1375 &requested.minimum_size,
1376 &requested.natural_size);
1378 requested.data = info;
1379 g_array_append_val (array, requested);
1381 avail_size -= requested.minimum_size;
1384 avail_size -= cellview->priv->spacing;
1393 sizes = (GtkRequestedSize *)array->data;
1394 avail_size = gtk_distribute_natural_allocation (MAX (0, avail_size), array->len, sizes);
1396 /* Deal with any expand space... */
1397 if (n_expand_cells > 0)
1399 extra_per_cell = avail_size / n_expand_cells;
1400 extra_extra = avail_size % n_expand_cells;
1403 /* Everything just left-aligned if no cells expand */
1404 extra_per_cell = extra_extra = 0;
1406 /* Now get the height for the real width of each cell */
1407 for (i = 0, list = cellview->priv->cell_list; list; list = list->next)
1409 GtkCellViewCellInfo *info = (GtkCellViewCellInfo *)list->data;
1410 gint cell_minimum, cell_natural;
1412 if (gtk_cell_renderer_get_visible (info->cell))
1414 gint cell_width = sizes[i].minimum_size;
1416 g_assert (sizes[i].data == info);
1420 cell_width += extra_per_cell;
1428 /* Get the height for the real width of this cell */
1429 gtk_cell_renderer_get_preferred_height_for_width (GTK_CELL_RENDERER (info->cell),
1430 GTK_WIDGET (widget),
1431 cell_width, &cell_minimum, &cell_natural);
1433 minimum = MAX (minimum, cell_minimum);
1434 natural = MAX (natural, cell_natural);
1436 /* increment sizes[] index for visible cells */
1441 g_array_free (array, TRUE);
1444 *minimum_size = minimum;
1446 *natural_size = natural;