3 * Copyright (C) 2010 Openismus GmbH
6 * Tristan Van Berkom <tristanvb@openismus.com>
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
26 #include "gtkorientable.h"
27 #include "gtkcelllayout.h"
28 #include "gtkcellareabox.h"
29 #include "gtkcellareaboxiter.h"
30 #include "gtkprivate.h"
34 static void gtk_cell_area_box_finalize (GObject *object);
35 static void gtk_cell_area_box_dispose (GObject *object);
36 static void gtk_cell_area_box_set_property (GObject *object,
40 static void gtk_cell_area_box_get_property (GObject *object,
45 /* GtkCellAreaClass */
46 static void gtk_cell_area_box_add (GtkCellArea *area,
47 GtkCellRenderer *renderer);
48 static void gtk_cell_area_box_remove (GtkCellArea *area,
49 GtkCellRenderer *renderer);
50 static void gtk_cell_area_box_forall (GtkCellArea *area,
51 GtkCellCallback callback,
52 gpointer callback_data);
53 static void gtk_cell_area_box_get_cell_allocation (GtkCellArea *area,
54 GtkCellAreaIter *iter,
56 GtkCellRenderer *renderer,
57 const GdkRectangle *cell_area,
58 GdkRectangle *allocation);
59 static gint gtk_cell_area_box_event (GtkCellArea *area,
60 GtkCellAreaIter *iter,
63 const GdkRectangle *cell_area,
64 GtkCellRendererState flags);
65 static void gtk_cell_area_box_render (GtkCellArea *area,
66 GtkCellAreaIter *iter,
69 const GdkRectangle *background_area,
70 const GdkRectangle *cell_area,
71 GtkCellRendererState flags,
72 gboolean paint_focus);
73 static void gtk_cell_area_box_set_cell_property (GtkCellArea *area,
74 GtkCellRenderer *renderer,
78 static void gtk_cell_area_box_get_cell_property (GtkCellArea *area,
79 GtkCellRenderer *renderer,
83 static GtkCellAreaIter *gtk_cell_area_box_create_iter (GtkCellArea *area);
84 static GtkSizeRequestMode gtk_cell_area_box_get_request_mode (GtkCellArea *area);
85 static void gtk_cell_area_box_get_preferred_width (GtkCellArea *area,
86 GtkCellAreaIter *iter,
90 static void gtk_cell_area_box_get_preferred_height (GtkCellArea *area,
91 GtkCellAreaIter *iter,
94 gint *natural_height);
95 static void gtk_cell_area_box_get_preferred_height_for_width (GtkCellArea *area,
96 GtkCellAreaIter *iter,
100 gint *natural_height);
101 static void gtk_cell_area_box_get_preferred_width_for_height (GtkCellArea *area,
102 GtkCellAreaIter *iter,
106 gint *natural_width);
107 static gboolean gtk_cell_area_box_focus (GtkCellArea *area,
108 GtkDirectionType direction);
110 /* GtkCellLayoutIface */
111 static void gtk_cell_area_box_cell_layout_init (GtkCellLayoutIface *iface);
112 static void gtk_cell_area_box_layout_pack_start (GtkCellLayout *cell_layout,
113 GtkCellRenderer *renderer,
115 static void gtk_cell_area_box_layout_pack_end (GtkCellLayout *cell_layout,
116 GtkCellRenderer *renderer,
118 static void gtk_cell_area_box_layout_reorder (GtkCellLayout *cell_layout,
119 GtkCellRenderer *renderer,
123 /* CellInfo/CellGroup metadata handling and convenience functions */
125 GtkCellRenderer *renderer;
127 guint expand : 1; /* Whether the cell expands */
128 guint pack : 1; /* Whether the cell is packed from the start or end */
129 guint align : 1; /* Whether to align this cell's position with adjacent rows */
137 guint expand_cells : 8;
141 GtkCellRenderer *renderer;
147 static CellInfo *cell_info_new (GtkCellRenderer *renderer,
151 static void cell_info_free (CellInfo *info);
152 static gint cell_info_find (CellInfo *info,
153 GtkCellRenderer *renderer);
155 static AllocatedCell *allocated_cell_new (GtkCellRenderer *renderer,
158 static void allocated_cell_free (AllocatedCell *cell);
159 static GList *list_consecutive_cells (GtkCellAreaBox *box);
160 static gint count_expand_groups (GtkCellAreaBox *box);
161 static void iter_weak_notify (GtkCellAreaBox *box,
162 GtkCellAreaBoxIter *dead_iter);
163 static void flush_iters (GtkCellAreaBox *box);
164 static void init_iter_groups (GtkCellAreaBox *box);
165 static void init_iter_group (GtkCellAreaBox *box,
166 GtkCellAreaBoxIter *iter);
167 static GSList *get_allocated_cells (GtkCellAreaBox *box,
168 GtkCellAreaBoxIter *iter,
172 struct _GtkCellAreaBoxPrivate
174 GtkOrientation orientation;
197 G_DEFINE_TYPE_WITH_CODE (GtkCellAreaBox, gtk_cell_area_box, GTK_TYPE_CELL_AREA,
198 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_LAYOUT,
199 gtk_cell_area_box_cell_layout_init)
200 G_IMPLEMENT_INTERFACE (GTK_TYPE_ORIENTABLE, NULL));
202 #define OPPOSITE_ORIENTATION(orientation) \
203 ((orientation) == GTK_ORIENTATION_HORIZONTAL ? \
204 GTK_ORIENTATION_VERTICAL : GTK_ORIENTATION_HORIZONTAL)
207 gtk_cell_area_box_init (GtkCellAreaBox *box)
209 GtkCellAreaBoxPrivate *priv;
211 box->priv = G_TYPE_INSTANCE_GET_PRIVATE (box,
212 GTK_TYPE_CELL_AREA_BOX,
213 GtkCellAreaBoxPrivate);
216 priv->orientation = GTK_ORIENTATION_HORIZONTAL;
217 priv->groups = g_array_new (FALSE, TRUE, sizeof (CellGroup));
224 gtk_cell_area_box_class_init (GtkCellAreaBoxClass *class)
226 GObjectClass *object_class = G_OBJECT_CLASS (class);
227 GtkCellAreaClass *area_class = GTK_CELL_AREA_CLASS (class);
230 object_class->finalize = gtk_cell_area_box_finalize;
231 object_class->dispose = gtk_cell_area_box_dispose;
232 object_class->set_property = gtk_cell_area_box_set_property;
233 object_class->get_property = gtk_cell_area_box_get_property;
235 /* GtkCellAreaClass */
236 area_class->add = gtk_cell_area_box_add;
237 area_class->remove = gtk_cell_area_box_remove;
238 area_class->forall = gtk_cell_area_box_forall;
239 area_class->get_cell_allocation = gtk_cell_area_box_get_cell_allocation;
240 area_class->event = gtk_cell_area_box_event;
241 area_class->render = gtk_cell_area_box_render;
242 area_class->set_cell_property = gtk_cell_area_box_set_cell_property;
243 area_class->get_cell_property = gtk_cell_area_box_get_cell_property;
245 area_class->create_iter = gtk_cell_area_box_create_iter;
246 area_class->get_request_mode = gtk_cell_area_box_get_request_mode;
247 area_class->get_preferred_width = gtk_cell_area_box_get_preferred_width;
248 area_class->get_preferred_height = gtk_cell_area_box_get_preferred_height;
249 area_class->get_preferred_height_for_width = gtk_cell_area_box_get_preferred_height_for_width;
250 area_class->get_preferred_width_for_height = gtk_cell_area_box_get_preferred_width_for_height;
252 area_class->focus = gtk_cell_area_box_focus;
255 g_object_class_override_property (object_class, PROP_ORIENTATION, "orientation");
257 g_object_class_install_property (object_class,
259 g_param_spec_int ("spacing",
261 P_("Space which is inserted between cells"),
265 GTK_PARAM_READWRITE));
267 /* Cell Properties */
268 gtk_cell_area_class_install_cell_property (area_class,
273 P_("Whether the cell expands"),
275 GTK_PARAM_READWRITE));
277 gtk_cell_area_class_install_cell_property (area_class,
282 P_("Whether cell should align with adjacent rows"),
284 GTK_PARAM_READWRITE));
286 gtk_cell_area_class_install_cell_property (area_class,
291 P_("A GtkPackType indicating whether the cell is packed with "
292 "reference to the start or end of the cell area"),
293 GTK_TYPE_PACK_TYPE, GTK_PACK_START,
294 GTK_PARAM_READWRITE));
296 g_type_class_add_private (object_class, sizeof (GtkCellAreaBoxPrivate));
300 /*************************************************************
301 * CellInfo/CellGroup basics and convenience functions *
302 *************************************************************/
304 cell_info_new (GtkCellRenderer *renderer,
309 CellInfo *info = g_slice_new (CellInfo);
311 info->renderer = g_object_ref_sink (renderer);
313 info->expand = expand;
320 cell_info_free (CellInfo *info)
322 g_object_unref (info->renderer);
324 g_slice_free (CellInfo, info);
328 cell_info_find (CellInfo *info,
329 GtkCellRenderer *renderer)
331 return (info->renderer == renderer) ? 0 : -1;
334 static AllocatedCell *
335 allocated_cell_new (GtkCellRenderer *renderer,
339 AllocatedCell *cell = g_slice_new (AllocatedCell);
341 cell->renderer = renderer;
342 cell->position = position;
349 allocated_cell_free (AllocatedCell *cell)
351 g_slice_free (AllocatedCell, cell);
355 list_consecutive_cells (GtkCellAreaBox *box)
357 GtkCellAreaBoxPrivate *priv = box->priv;
358 GList *l, *consecutive_cells = NULL, *pack_end_cells = NULL;
361 /* List cells in consecutive order taking their
362 * PACK_START/PACK_END options into account
364 for (l = priv->cells; l; l = l->next)
368 if (info->pack == GTK_PACK_START)
369 consecutive_cells = g_list_prepend (consecutive_cells, info);
372 for (l = priv->cells; l; l = l->next)
376 if (info->pack == GTK_PACK_END)
377 pack_end_cells = g_list_prepend (pack_end_cells, info);
380 consecutive_cells = g_list_reverse (consecutive_cells);
381 consecutive_cells = g_list_concat (consecutive_cells, pack_end_cells);
383 return consecutive_cells;
387 cell_groups_clear (GtkCellAreaBox *box)
389 GtkCellAreaBoxPrivate *priv = box->priv;
392 for (i = 0; i < priv->groups->len; i++)
394 CellGroup *group = &g_array_index (priv->groups, CellGroup, i);
396 g_list_free (group->cells);
399 g_array_set_size (priv->groups, 0);
403 cell_groups_rebuild (GtkCellAreaBox *box)
405 GtkCellAreaBoxPrivate *priv = box->priv;
406 CellGroup group = { 0, };
407 CellGroup *group_ptr;
411 cell_groups_clear (box);
416 cells = list_consecutive_cells (box);
418 /* First group is implied */
419 g_array_append_val (priv->groups, group);
420 group_ptr = &g_array_index (priv->groups, CellGroup, id);
422 for (l = cells; l; l = l->next)
424 CellInfo *info = l->data;
426 /* A new group starts with any aligned cell, the first group is implied */
427 if (info->align && l != cells)
429 memset (&group, 0x0, sizeof (CellGroup));
432 g_array_append_val (priv->groups, group);
433 group_ptr = &g_array_index (priv->groups, CellGroup, id);
436 group_ptr->cells = g_list_prepend (group_ptr->cells, info);
437 group_ptr->n_cells++;
439 /* A group expands if it contains any expand cells */
441 group_ptr->expand_cells++;
446 for (id = 0; id < priv->groups->len; id++)
448 group_ptr = &g_array_index (priv->groups, CellGroup, id);
450 group_ptr->cells = g_list_reverse (group_ptr->cells);
453 /* Iters need to be updated with the new grouping information */
454 init_iter_groups (box);
458 count_visible_cells (CellGroup *group,
462 gint visible_cells = 0;
463 gint n_expand_cells = 0;
465 for (l = group->cells; l; l = l->next)
467 CellInfo *info = l->data;
469 if (gtk_cell_renderer_get_visible (info->renderer))
479 *expand_cells = n_expand_cells;
481 return visible_cells;
485 count_expand_groups (GtkCellAreaBox *box)
487 GtkCellAreaBoxPrivate *priv = box->priv;
489 gint expand_groups = 0;
491 for (i = 0; i < priv->groups->len; i++)
493 CellGroup *group = &g_array_index (priv->groups, CellGroup, i);
495 if (group->expand_cells > 0)
499 return expand_groups;
503 iter_weak_notify (GtkCellAreaBox *box,
504 GtkCellAreaBoxIter *dead_iter)
506 GtkCellAreaBoxPrivate *priv = box->priv;
508 priv->iters = g_slist_remove (priv->iters, dead_iter);
512 init_iter_group (GtkCellAreaBox *box,
513 GtkCellAreaBoxIter *iter)
515 GtkCellAreaBoxPrivate *priv = box->priv;
516 gint *expand_groups, i;
518 expand_groups = g_new (gboolean, priv->groups->len);
520 for (i = 0; i < priv->groups->len; i++)
522 CellGroup *group = &g_array_index (priv->groups, CellGroup, i);
524 expand_groups[i] = (group->expand_cells > 0);
527 /* This call implies flushing the request info */
528 gtk_cell_area_box_init_groups (iter, priv->groups->len, expand_groups);
529 g_free (expand_groups);
533 init_iter_groups (GtkCellAreaBox *box)
535 GtkCellAreaBoxPrivate *priv = box->priv;
538 /* When the box's groups are reconstructed, iters need to
541 for (l = priv->iters; l; l = l->next)
543 GtkCellAreaBoxIter *iter = l->data;
545 init_iter_group (box, iter);
550 flush_iters (GtkCellAreaBox *box)
552 GtkCellAreaBoxPrivate *priv = box->priv;
555 /* When the box layout changes, iters need to
556 * be flushed and sizes for the box get requested again
558 for (l = priv->iters; l; l = l->next)
560 GtkCellAreaIter *iter = l->data;
562 gtk_cell_area_iter_flush (iter);
566 /* Returns an allocation for each cell in the orientation of the box,
567 * used in ->render()/->event() implementations to get a straight-forward
568 * list of allocated cells to operate on.
571 get_allocated_cells (GtkCellAreaBox *box,
572 GtkCellAreaBoxIter *iter,
575 const GtkCellAreaBoxAllocation *group_allocs;
576 GtkCellArea *area = GTK_CELL_AREA (box);
577 GtkCellAreaBoxPrivate *priv = box->priv;
579 GSList *allocated_cells = NULL;
582 group_allocs = gtk_cell_area_box_iter_get_orientation_allocs (iter, &n_allocs);
585 g_warning ("Trying to operate on an unallocated GtkCellAreaIter, "
586 "GtkCellAreaBox requires that the iter be allocated at least "
587 "in the orientation of the box");
591 for (i = 0; i < n_allocs; i++)
593 /* We dont always allocate all groups, sometimes the requested group has only invisible
594 * cells for every row, hence the usage of group_allocs[i].group_idx here
596 CellGroup *group = &g_array_index (priv->groups, CellGroup, group_allocs[i].group_idx);
598 /* Exception for single cell groups */
599 if (group->n_cells == 1)
601 CellInfo *info = group->cells->data;
602 AllocatedCell *cell =
603 allocated_cell_new (info->renderer, group_allocs[i].position, group_allocs[i].size);
605 allocated_cells = g_slist_prepend (allocated_cells, cell);
609 GtkRequestedSize *sizes;
610 gint avail_size, position;
611 gint visible_cells, expand_cells;
612 gint extra_size, extra_extra;
614 visible_cells = count_visible_cells (group, &expand_cells);
616 /* If this row has no visible cells in this group, just
617 * skip the allocation */
618 if (visible_cells == 0)
621 /* Offset the allocation to the group position and allocate into
622 * the group's available size */
623 position = group_allocs[i].position;
624 avail_size = group_allocs[i].size;
626 sizes = g_new (GtkRequestedSize, visible_cells);
628 for (j = 0, cell_list = group->cells; cell_list; cell_list = cell_list->next)
630 CellInfo *info = cell_list->data;
632 if (!gtk_cell_renderer_get_visible (info->renderer))
635 gtk_cell_area_request_renderer (area, info->renderer,
638 &sizes[j].minimum_size,
639 &sizes[j].natural_size);
641 sizes[j].data = info;
642 avail_size -= sizes[j].minimum_size;
647 /* Distribute cells naturally within the group */
648 avail_size -= (visible_cells - 1) * priv->spacing;
649 avail_size = gtk_distribute_natural_allocation (avail_size, visible_cells, sizes);
651 /* Calculate/distribute expand for cells */
652 if (expand_cells > 0)
654 extra_size = avail_size / expand_cells;
655 extra_extra = avail_size % expand_cells;
658 extra_size = extra_extra = 0;
660 /* Create the allocated cells (loop only over visible cells here) */
661 for (j = 0; j < visible_cells; j++)
663 CellInfo *info = sizes[j].data;
668 sizes[j].minimum_size += extra_size;
671 sizes[j].minimum_size++;
676 cell = allocated_cell_new (info->renderer, position, sizes[j].minimum_size);
678 allocated_cells = g_slist_prepend (allocated_cells, cell);
680 position += sizes[j].minimum_size;
681 position += priv->spacing;
688 /* Note it might not be important to reverse the list here at all,
689 * we have the correct positions, no need to allocate from left to right */
690 return g_slist_reverse (allocated_cells);
693 /*************************************************************
695 *************************************************************/
697 gtk_cell_area_box_finalize (GObject *object)
699 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (object);
700 GtkCellAreaBoxPrivate *priv = box->priv;
703 /* Unref/free the iter list */
704 for (l = priv->iters; l; l = l->next)
705 g_object_weak_unref (G_OBJECT (l->data), (GWeakNotify)iter_weak_notify, box);
707 g_slist_free (priv->iters);
710 /* Free the cell grouping info */
711 cell_groups_clear (box);
712 g_array_free (priv->groups, TRUE);
714 G_OBJECT_CLASS (gtk_cell_area_box_parent_class)->finalize (object);
718 gtk_cell_area_box_dispose (GObject *object)
720 G_OBJECT_CLASS (gtk_cell_area_box_parent_class)->dispose (object);
724 gtk_cell_area_box_set_property (GObject *object,
729 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (object);
733 case PROP_ORIENTATION:
734 box->priv->orientation = g_value_get_enum (value);
736 /* Notify that size needs to be requested again */
740 gtk_cell_area_box_set_spacing (box, g_value_get_int (value));
743 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
749 gtk_cell_area_box_get_property (GObject *object,
754 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (object);
758 case PROP_ORIENTATION:
759 g_value_set_enum (value, box->priv->orientation);
762 g_value_set_int (value, gtk_cell_area_box_get_spacing (box));
765 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
770 /*************************************************************
772 *************************************************************/
774 gtk_cell_area_box_add (GtkCellArea *area,
775 GtkCellRenderer *renderer)
777 gtk_cell_area_box_pack_start (GTK_CELL_AREA_BOX (area),
778 renderer, FALSE, TRUE);
782 gtk_cell_area_box_remove (GtkCellArea *area,
783 GtkCellRenderer *renderer)
785 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
786 GtkCellAreaBoxPrivate *priv = box->priv;
789 node = g_list_find_custom (priv->cells, renderer,
790 (GCompareFunc)cell_info_find);
794 CellInfo *info = node->data;
796 cell_info_free (info);
798 priv->cells = g_list_delete_link (priv->cells, node);
800 /* Reconstruct cell groups */
801 cell_groups_rebuild (box);
804 g_warning ("Trying to remove a cell renderer that is not present GtkCellAreaBox");
808 gtk_cell_area_box_forall (GtkCellArea *area,
809 GtkCellCallback callback,
810 gpointer callback_data)
812 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
813 GtkCellAreaBoxPrivate *priv = box->priv;
816 for (list = priv->cells; list; list = list->next)
818 CellInfo *info = list->data;
820 callback (info->renderer, callback_data);
825 gtk_cell_area_box_get_cell_allocation (GtkCellArea *area,
826 GtkCellAreaIter *iter,
828 GtkCellRenderer *renderer,
829 const GdkRectangle *cell_area,
830 GdkRectangle *allocation)
832 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
833 GtkCellAreaBoxPrivate *priv = box->priv;
834 GtkCellAreaBoxIter *box_iter = GTK_CELL_AREA_BOX_ITER (iter);
835 GSList *allocated_cells, *l;
837 *allocation = *cell_area;
839 /* Get a list of cells with allocation sizes decided regardless
840 * of alignments and pack order etc. */
841 allocated_cells = get_allocated_cells (box, box_iter, widget);
843 for (l = allocated_cells; l; l = l->next)
845 AllocatedCell *cell = l->data;
847 if (cell->renderer == renderer)
849 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
851 allocation->x = cell_area->x + cell->position;
852 allocation->width = cell->size;
856 allocation->y = cell_area->y + cell->position;
857 allocation->height = cell->size;
864 g_slist_foreach (allocated_cells, (GFunc)allocated_cell_free, NULL);
865 g_slist_free (allocated_cells);
875 gtk_cell_area_box_event (GtkCellArea *area,
876 GtkCellAreaIter *iter,
879 const GdkRectangle *cell_area,
880 GtkCellRendererState flags)
884 /* First let the parent class handle activation of cells via keystrokes */
886 GTK_CELL_AREA_CLASS (gtk_cell_area_box_parent_class)->event (area, iter, widget,
887 event, cell_area, flags);
892 /* Also detect mouse events, for mouse events we need to allocate the renderers
893 * and find which renderer needs to be activated.
901 gtk_cell_area_box_render (GtkCellArea *area,
902 GtkCellAreaIter *iter,
905 const GdkRectangle *background_area,
906 const GdkRectangle *cell_area,
907 GtkCellRendererState flags,
908 gboolean paint_focus)
910 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
911 GtkCellAreaBoxPrivate *priv = box->priv;
912 GtkCellAreaBoxIter *box_iter = GTK_CELL_AREA_BOX_ITER (iter);
913 GSList *allocated_cells, *l;
914 GdkRectangle cell_background, inner_area;
915 GtkCellRenderer *focus_cell = NULL;
916 GdkRectangle focus_rect = { 0, };
917 gboolean first_focus_cell = TRUE;
919 if (flags & GTK_CELL_RENDERER_FOCUSED)
921 focus_cell = gtk_cell_area_get_focus_cell (area);
922 flags &= ~GTK_CELL_RENDERER_FOCUSED;
925 cell_background = *cell_area;
927 /* Get a list of cells with allocation sizes decided regardless
928 * of alignments and pack order etc. */
929 allocated_cells = get_allocated_cells (box, box_iter, widget);
931 for (l = allocated_cells; l; l = l->next)
933 AllocatedCell *cell = l->data;
934 GtkCellRendererState cell_fields = 0;
936 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
938 cell_background.x = cell_area->x + cell->position;
939 cell_background.width = cell->size;
943 cell_background.y = cell_area->y + cell->position;
944 cell_background.height = cell->size;
947 /* Remove margins from the background area to produce the cell area
949 gtk_cell_area_inner_cell_area (area, &cell_background, &inner_area);
952 (cell->renderer == focus_cell ||
953 gtk_cell_area_is_focus_sibling (area, focus_cell, cell->renderer)))
955 cell_fields |= GTK_CELL_RENDERER_FOCUSED;
959 GdkRectangle cell_focus;
960 gint opposite_size, x_offset, y_offset;
962 cell_focus = inner_area;
964 /* Trim up the focus size */
965 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
967 gtk_cell_renderer_get_preferred_height_for_width (cell->renderer, widget,
969 NULL, &opposite_size);
971 cell_focus.height = MIN (opposite_size, cell_focus.height);
975 gtk_cell_renderer_get_preferred_width_for_height (cell->renderer, widget,
977 NULL, &opposite_size);
979 cell_focus.width = MIN (opposite_size, cell_focus.width);
982 /* offset the cell position */
983 _gtk_cell_renderer_calc_offset (cell->renderer, &inner_area, GTK_TEXT_DIR_LTR,
984 cell_focus.width, cell_focus.height,
985 &x_offset, &y_offset);
987 cell_focus.x += x_offset;
988 cell_focus.y += y_offset;
990 /* Accumulate the focus rectangle for all focus siblings */
991 if (first_focus_cell)
993 focus_rect = cell_focus;
994 first_focus_cell = FALSE;
997 gdk_rectangle_union (&focus_rect, &cell_focus, &focus_rect);
1001 /* We have to do some per-cell considerations for the 'flags'
1002 * for focus handling */
1003 gtk_cell_renderer_render (cell->renderer, cr, widget,
1004 &cell_background, &inner_area,
1005 flags | cell_fields);
1008 if (paint_focus && focus_rect.width != 0 && focus_rect.height != 0)
1010 GtkStateType renderer_state =
1011 flags & GTK_CELL_RENDERER_SELECTED ? GTK_STATE_SELECTED :
1012 (flags & GTK_CELL_RENDERER_PRELIT ? GTK_STATE_PRELIGHT :
1013 (flags & GTK_CELL_RENDERER_INSENSITIVE ? GTK_STATE_INSENSITIVE : GTK_STATE_NORMAL));
1015 gtk_paint_focus (gtk_widget_get_style (widget),
1018 /* XXX This hint should be a property on GtkCellArea I suppose */
1027 g_slist_foreach (allocated_cells, (GFunc)allocated_cell_free, NULL);
1028 g_slist_free (allocated_cells);
1032 gtk_cell_area_box_set_cell_property (GtkCellArea *area,
1033 GtkCellRenderer *renderer,
1035 const GValue *value,
1038 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
1039 GtkCellAreaBoxPrivate *priv = box->priv;
1042 gboolean rebuild = FALSE;
1044 GtkPackType pack_type;
1046 node = g_list_find_custom (priv->cells, renderer,
1047 (GCompareFunc)cell_info_find);
1055 case CELL_PROP_EXPAND:
1056 val = g_value_get_boolean (value);
1058 if (info->expand != val)
1065 case CELL_PROP_ALIGN:
1066 val = g_value_get_boolean (value);
1068 if (info->align != val)
1075 case CELL_PROP_PACK_TYPE:
1076 pack_type = g_value_get_enum (value);
1078 if (info->pack != pack_type)
1080 info->pack = pack_type;
1085 GTK_CELL_AREA_WARN_INVALID_CHILD_PROPERTY_ID (area, prop_id, pspec);
1089 /* Groups need to be rebuilt */
1091 cell_groups_rebuild (box);
1095 gtk_cell_area_box_get_cell_property (GtkCellArea *area,
1096 GtkCellRenderer *renderer,
1101 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
1102 GtkCellAreaBoxPrivate *priv = box->priv;
1106 node = g_list_find_custom (priv->cells, renderer,
1107 (GCompareFunc)cell_info_find);
1115 case CELL_PROP_EXPAND:
1116 g_value_set_boolean (value, info->expand);
1119 case CELL_PROP_ALIGN:
1120 g_value_set_boolean (value, info->align);
1123 case CELL_PROP_PACK_TYPE:
1124 g_value_set_enum (value, info->pack);
1127 GTK_CELL_AREA_WARN_INVALID_CHILD_PROPERTY_ID (area, prop_id, pspec);
1133 static GtkCellAreaIter *
1134 gtk_cell_area_box_create_iter (GtkCellArea *area)
1136 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
1137 GtkCellAreaBoxPrivate *priv = box->priv;
1138 GtkCellAreaIter *iter =
1139 (GtkCellAreaIter *)g_object_new (GTK_TYPE_CELL_AREA_BOX_ITER,
1140 "area", area, NULL);
1142 priv->iters = g_slist_prepend (priv->iters, iter);
1144 g_object_weak_ref (G_OBJECT (iter), (GWeakNotify)iter_weak_notify, box);
1146 /* Tell the new group about our cell layout */
1147 init_iter_group (box, GTK_CELL_AREA_BOX_ITER (iter));
1152 static GtkSizeRequestMode
1153 gtk_cell_area_box_get_request_mode (GtkCellArea *area)
1155 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
1156 GtkCellAreaBoxPrivate *priv = box->priv;
1158 return (priv->orientation) == GTK_ORIENTATION_HORIZONTAL ?
1159 GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH :
1160 GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT;
1164 compute_size (GtkCellAreaBox *box,
1165 GtkOrientation orientation,
1166 GtkCellAreaBoxIter *iter,
1172 GtkCellAreaBoxPrivate *priv = box->priv;
1173 GtkCellArea *area = GTK_CELL_AREA (box);
1179 for (i = 0; i < priv->groups->len; i++)
1181 CellGroup *group = &g_array_index (priv->groups, CellGroup, i);
1182 gint group_min_size = 0;
1183 gint group_nat_size = 0;
1185 for (list = group->cells; list; list = list->next)
1187 CellInfo *info = list->data;
1188 gint renderer_min_size, renderer_nat_size;
1190 if (!gtk_cell_renderer_get_visible (info->renderer))
1193 gtk_cell_area_request_renderer (area, info->renderer, orientation, widget, for_size,
1194 &renderer_min_size, &renderer_nat_size);
1196 if (orientation == priv->orientation)
1200 min_size += priv->spacing;
1201 nat_size += priv->spacing;
1204 if (group_min_size > 0)
1206 group_min_size += priv->spacing;
1207 group_nat_size += priv->spacing;
1210 min_size += renderer_min_size;
1211 nat_size += renderer_nat_size;
1212 group_min_size += renderer_min_size;
1213 group_nat_size += renderer_nat_size;
1217 min_size = MAX (min_size, renderer_min_size);
1218 nat_size = MAX (nat_size, renderer_nat_size);
1219 group_min_size = MAX (group_min_size, renderer_min_size);
1220 group_nat_size = MAX (group_nat_size, renderer_nat_size);
1224 if (orientation == GTK_ORIENTATION_HORIZONTAL)
1227 gtk_cell_area_box_iter_push_group_width (iter, group->id, group_min_size, group_nat_size);
1229 gtk_cell_area_box_iter_push_group_width_for_height (iter, group->id, for_size,
1230 group_min_size, group_nat_size);
1235 gtk_cell_area_box_iter_push_group_height (iter, group->id, group_min_size, group_nat_size);
1237 gtk_cell_area_box_iter_push_group_height_for_width (iter, group->id, for_size,
1238 group_min_size, group_nat_size);
1242 *minimum_size = min_size;
1243 *natural_size = nat_size;
1247 get_group_sizes (GtkCellArea *area,
1249 GtkOrientation orientation,
1253 GtkRequestedSize *sizes;
1257 *n_sizes = count_visible_cells (group, NULL);
1258 sizes = g_new (GtkRequestedSize, *n_sizes);
1260 for (l = group->cells, i = 0; l; l = l->next)
1262 CellInfo *info = l->data;
1264 if (!gtk_cell_renderer_get_visible (info->renderer))
1267 sizes[i].data = info;
1269 gtk_cell_area_request_renderer (area, info->renderer,
1270 orientation, widget, -1,
1271 &sizes[i].minimum_size,
1272 &sizes[i].natural_size);
1281 compute_group_size_for_opposing_orientation (GtkCellAreaBox *box,
1288 GtkCellAreaBoxPrivate *priv = box->priv;
1289 GtkCellArea *area = GTK_CELL_AREA (box);
1291 /* Exception for single cell groups */
1292 if (group->n_cells == 1)
1294 CellInfo *info = group->cells->data;
1296 gtk_cell_area_request_renderer (area, info->renderer,
1297 OPPOSITE_ORIENTATION (priv->orientation),
1298 widget, for_size, minimum_size, natural_size);
1302 GtkRequestedSize *orientation_sizes;
1305 gint avail_size = for_size;
1306 gint extra_size, extra_extra;
1307 gint min_size = 0, nat_size = 0;
1309 orientation_sizes = get_group_sizes (area, group, priv->orientation, widget, &n_sizes);
1311 /* First naturally allocate the cells in the group into the for_size */
1312 avail_size -= (n_sizes - 1) * priv->spacing;
1313 for (i = 0; i < n_sizes; i++)
1314 avail_size -= orientation_sizes[i].minimum_size;
1316 avail_size = gtk_distribute_natural_allocation (avail_size, n_sizes, orientation_sizes);
1318 /* Calculate/distribute expand for cells */
1319 if (group->expand_cells > 0)
1321 extra_size = avail_size / group->expand_cells;
1322 extra_extra = avail_size % group->expand_cells;
1325 extra_size = extra_extra = 0;
1327 for (i = 0; i < n_sizes; i++)
1329 gint cell_min, cell_nat;
1331 info = orientation_sizes[i].data;
1335 orientation_sizes[i].minimum_size += extra_size;
1338 orientation_sizes[i].minimum_size++;
1343 gtk_cell_area_request_renderer (area, info->renderer,
1344 OPPOSITE_ORIENTATION (priv->orientation),
1346 orientation_sizes[i].minimum_size,
1347 &cell_min, &cell_nat);
1349 min_size = MAX (min_size, cell_min);
1350 nat_size = MAX (nat_size, cell_nat);
1353 *minimum_size = min_size;
1354 *natural_size = nat_size;
1356 g_free (orientation_sizes);
1361 compute_size_for_opposing_orientation (GtkCellAreaBox *box,
1362 GtkCellAreaBoxIter *iter,
1368 GtkCellAreaBoxPrivate *priv = box->priv;
1370 GtkRequestedSize *orientation_sizes;
1371 gint n_groups, n_expand_groups, i;
1372 gint avail_size = for_size;
1373 gint extra_size, extra_extra;
1374 gint min_size = 0, nat_size = 0;
1376 n_expand_groups = count_expand_groups (box);
1378 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
1379 orientation_sizes = gtk_cell_area_box_iter_get_widths (iter, &n_groups);
1381 orientation_sizes = gtk_cell_area_box_iter_get_heights (iter, &n_groups);
1383 /* First start by naturally allocating space among groups of cells */
1384 avail_size -= (n_groups - 1) * priv->spacing;
1385 for (i = 0; i < n_groups; i++)
1386 avail_size -= orientation_sizes[i].minimum_size;
1388 avail_size = gtk_distribute_natural_allocation (avail_size, n_groups, orientation_sizes);
1390 /* Calculate/distribute expand for groups */
1391 if (n_expand_groups > 0)
1393 extra_size = avail_size / n_expand_groups;
1394 extra_extra = avail_size % n_expand_groups;
1397 extra_size = extra_extra = 0;
1399 /* Now we need to naturally allocate sizes for cells in each group
1400 * and push the height-for-width for each group accordingly while accumulating
1401 * the overall height-for-width for this row.
1403 for (i = 0; i < n_groups; i++)
1405 gint group_min, group_nat;
1406 gint group_idx = GPOINTER_TO_INT (orientation_sizes[i].data);
1408 group = &g_array_index (priv->groups, CellGroup, group_idx);
1410 if (group->expand_cells > 0)
1412 orientation_sizes[i].minimum_size += extra_size;
1415 orientation_sizes[i].minimum_size++;
1420 /* Now we have the allocation for the group, request it's height-for-width */
1421 compute_group_size_for_opposing_orientation (box, group, widget,
1422 orientation_sizes[i].minimum_size,
1423 &group_min, &group_nat);
1425 min_size = MAX (min_size, group_min);
1426 nat_size = MAX (nat_size, group_nat);
1428 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
1430 gtk_cell_area_box_iter_push_group_height_for_width (iter, group_idx, for_size,
1431 group_min, group_nat);
1435 gtk_cell_area_box_iter_push_group_width_for_height (iter, group_idx, for_size,
1436 group_min, group_nat);
1440 *minimum_size = min_size;
1441 *natural_size = nat_size;
1443 g_free (orientation_sizes);
1449 gtk_cell_area_box_get_preferred_width (GtkCellArea *area,
1450 GtkCellAreaIter *iter,
1452 gint *minimum_width,
1453 gint *natural_width)
1455 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
1456 GtkCellAreaBoxIter *box_iter;
1457 gint min_width, nat_width;
1459 g_return_if_fail (GTK_IS_CELL_AREA_BOX_ITER (iter));
1461 box_iter = GTK_CELL_AREA_BOX_ITER (iter);
1463 /* Compute the size of all renderers for current row data,
1464 * bumping cell alignments in the iter along the way */
1465 compute_size (box, GTK_ORIENTATION_HORIZONTAL,
1466 box_iter, widget, -1, &min_width, &nat_width);
1469 *minimum_width = min_width;
1472 *natural_width = nat_width;
1476 gtk_cell_area_box_get_preferred_height (GtkCellArea *area,
1477 GtkCellAreaIter *iter,
1479 gint *minimum_height,
1480 gint *natural_height)
1482 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
1483 GtkCellAreaBoxIter *box_iter;
1484 gint min_height, nat_height;
1486 g_return_if_fail (GTK_IS_CELL_AREA_BOX_ITER (iter));
1488 box_iter = GTK_CELL_AREA_BOX_ITER (iter);
1490 /* Compute the size of all renderers for current row data,
1491 * bumping cell alignments in the iter along the way */
1492 compute_size (box, GTK_ORIENTATION_VERTICAL,
1493 box_iter, widget, -1, &min_height, &nat_height);
1496 *minimum_height = min_height;
1499 *natural_height = nat_height;
1503 gtk_cell_area_box_get_preferred_height_for_width (GtkCellArea *area,
1504 GtkCellAreaIter *iter,
1507 gint *minimum_height,
1508 gint *natural_height)
1510 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
1511 GtkCellAreaBoxIter *box_iter;
1512 GtkCellAreaBoxPrivate *priv;
1513 gint min_height, nat_height;
1515 g_return_if_fail (GTK_IS_CELL_AREA_BOX_ITER (iter));
1517 box_iter = GTK_CELL_AREA_BOX_ITER (iter);
1520 if (priv->orientation == GTK_ORIENTATION_VERTICAL)
1522 /* Add up vertical requests of height for width and push the overall
1523 * cached sizes for alignments */
1524 compute_size (box, priv->orientation, box_iter, widget, width, &min_height, &nat_height);
1528 /* Juice: virtually allocate cells into the for_width using the
1529 * alignments and then return the overall height for that width, and cache it */
1530 compute_size_for_opposing_orientation (box, box_iter, widget, width, &min_height, &nat_height);
1534 *minimum_height = min_height;
1537 *natural_height = nat_height;
1541 gtk_cell_area_box_get_preferred_width_for_height (GtkCellArea *area,
1542 GtkCellAreaIter *iter,
1545 gint *minimum_width,
1546 gint *natural_width)
1548 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
1549 GtkCellAreaBoxIter *box_iter;
1550 GtkCellAreaBoxPrivate *priv;
1551 gint min_width, nat_width;
1553 g_return_if_fail (GTK_IS_CELL_AREA_BOX_ITER (iter));
1555 box_iter = GTK_CELL_AREA_BOX_ITER (iter);
1558 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
1560 /* Add up horizontal requests of width for height and push the overall
1561 * cached sizes for alignments */
1562 compute_size (box, priv->orientation, box_iter, widget, height, &min_width, &nat_width);
1566 /* Juice: horizontally allocate cells into the for_height using the
1567 * alignments and then return the overall width for that height, and cache it */
1568 compute_size_for_opposing_orientation (box, box_iter, widget, height, &min_width, &nat_width);
1572 *minimum_width = min_width;
1575 *natural_width = nat_width;
1579 gtk_cell_area_box_focus (GtkCellArea *area,
1580 GtkDirectionType direction)
1582 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
1583 GtkCellAreaBoxPrivate *priv = box->priv;
1584 gint cycle = FOCUS_NONE;
1585 gboolean cycled_focus = FALSE;
1586 GtkCellRenderer *focus_cell;
1588 focus_cell = gtk_cell_area_get_focus_cell (area);
1592 case GTK_DIR_TAB_FORWARD:
1595 case GTK_DIR_TAB_BACKWARD:
1599 if (priv->orientation == GTK_ORIENTATION_VERTICAL || !focus_cell)
1603 if (priv->orientation == GTK_ORIENTATION_VERTICAL || !focus_cell)
1607 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL || !focus_cell)
1611 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL || !focus_cell)
1618 if (cycle != FOCUS_NONE)
1620 gboolean found_cell = FALSE;
1624 /* If there is no focused cell, focus on the first (or last) one in the list */
1628 for (i = (cycle == FOCUS_NEXT) ? 0 : priv->groups->len -1;
1629 cycled_focus == FALSE && i >= 0 && i < priv->groups->len;
1630 i = (cycle == FOCUS_NEXT) ? i + 1 : i - 1)
1632 CellGroup *group = &g_array_index (priv->groups, CellGroup, i);
1634 for (list = (cycle == FOCUS_NEXT) ? g_list_first (group->cells) : g_list_last (group->cells);
1635 list; list = (cycle == FOCUS_NEXT) ? list->next : list->prev)
1637 CellInfo *info = list->data;
1639 if (info->renderer == focus_cell)
1641 else if (found_cell)
1643 if (gtk_cell_renderer_can_focus (info->renderer))
1645 gtk_cell_area_set_focus_cell (area, info->renderer);
1647 cycled_focus = TRUE;
1656 gtk_cell_area_set_focus_cell (area, NULL);
1658 return cycled_focus;
1662 /*************************************************************
1663 * GtkCellLayoutIface *
1664 *************************************************************/
1666 gtk_cell_area_box_cell_layout_init (GtkCellLayoutIface *iface)
1668 iface->pack_start = gtk_cell_area_box_layout_pack_start;
1669 iface->pack_end = gtk_cell_area_box_layout_pack_end;
1670 iface->reorder = gtk_cell_area_box_layout_reorder;
1674 gtk_cell_area_box_layout_pack_start (GtkCellLayout *cell_layout,
1675 GtkCellRenderer *renderer,
1678 gtk_cell_area_box_pack_start (GTK_CELL_AREA_BOX (cell_layout), renderer, expand, TRUE);
1682 gtk_cell_area_box_layout_pack_end (GtkCellLayout *cell_layout,
1683 GtkCellRenderer *renderer,
1686 gtk_cell_area_box_pack_end (GTK_CELL_AREA_BOX (cell_layout), renderer, expand, TRUE);
1690 gtk_cell_area_box_layout_reorder (GtkCellLayout *cell_layout,
1691 GtkCellRenderer *renderer,
1694 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (cell_layout);
1695 GtkCellAreaBoxPrivate *priv = box->priv;
1699 node = g_list_find_custom (priv->cells, renderer,
1700 (GCompareFunc)cell_info_find);
1706 priv->cells = g_list_delete_link (priv->cells, node);
1707 priv->cells = g_list_insert (priv->cells, info, position);
1709 cell_groups_rebuild (box);
1713 /*************************************************************
1715 *************************************************************/
1717 gtk_cell_area_box_new (void)
1719 return (GtkCellArea *)g_object_new (GTK_TYPE_CELL_AREA_BOX, NULL);
1723 gtk_cell_area_box_pack_start (GtkCellAreaBox *box,
1724 GtkCellRenderer *renderer,
1728 GtkCellAreaBoxPrivate *priv;
1731 g_return_if_fail (GTK_IS_CELL_AREA_BOX (box));
1732 g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
1736 if (g_list_find_custom (priv->cells, renderer,
1737 (GCompareFunc)cell_info_find))
1739 g_warning ("Refusing to add the same cell renderer to a GtkCellAreaBox twice");
1743 info = cell_info_new (renderer, GTK_PACK_START, expand, align);
1745 priv->cells = g_list_append (priv->cells, info);
1747 cell_groups_rebuild (box);
1751 gtk_cell_area_box_pack_end (GtkCellAreaBox *box,
1752 GtkCellRenderer *renderer,
1756 GtkCellAreaBoxPrivate *priv;
1759 g_return_if_fail (GTK_IS_CELL_AREA_BOX (box));
1760 g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
1764 if (g_list_find_custom (priv->cells, renderer,
1765 (GCompareFunc)cell_info_find))
1767 g_warning ("Refusing to add the same cell renderer to a GtkCellArea twice");
1771 info = cell_info_new (renderer, GTK_PACK_END, expand, align);
1773 priv->cells = g_list_append (priv->cells, info);
1775 cell_groups_rebuild (box);
1779 gtk_cell_area_box_get_spacing (GtkCellAreaBox *box)
1781 g_return_val_if_fail (GTK_IS_CELL_AREA_BOX (box), 0);
1783 return box->priv->spacing;
1787 gtk_cell_area_box_set_spacing (GtkCellAreaBox *box,
1790 GtkCellAreaBoxPrivate *priv;
1792 g_return_if_fail (GTK_IS_CELL_AREA_BOX (box));
1796 if (priv->spacing != spacing)
1798 priv->spacing = spacing;
1800 g_object_notify (G_OBJECT (box), "spacing");
1802 /* Notify that size needs to be requested again */