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 *cell_area,
70 GtkCellRendererState flags);
71 static void gtk_cell_area_box_set_cell_property (GtkCellArea *area,
72 GtkCellRenderer *renderer,
76 static void gtk_cell_area_box_get_cell_property (GtkCellArea *area,
77 GtkCellRenderer *renderer,
81 static GtkCellAreaIter *gtk_cell_area_box_create_iter (GtkCellArea *area);
82 static GtkSizeRequestMode gtk_cell_area_box_get_request_mode (GtkCellArea *area);
83 static void gtk_cell_area_box_get_preferred_width (GtkCellArea *area,
84 GtkCellAreaIter *iter,
88 static void gtk_cell_area_box_get_preferred_height (GtkCellArea *area,
89 GtkCellAreaIter *iter,
92 gint *natural_height);
93 static void gtk_cell_area_box_get_preferred_height_for_width (GtkCellArea *area,
94 GtkCellAreaIter *iter,
98 gint *natural_height);
99 static void gtk_cell_area_box_get_preferred_width_for_height (GtkCellArea *area,
100 GtkCellAreaIter *iter,
104 gint *natural_width);
105 static void gtk_cell_area_box_grab_focus (GtkCellArea *area,
106 GtkDirectionType direction);
108 /* GtkCellLayoutIface */
109 static void gtk_cell_area_box_cell_layout_init (GtkCellLayoutIface *iface);
110 static void gtk_cell_area_box_layout_pack_start (GtkCellLayout *cell_layout,
111 GtkCellRenderer *renderer,
113 static void gtk_cell_area_box_layout_pack_end (GtkCellLayout *cell_layout,
114 GtkCellRenderer *renderer,
116 static void gtk_cell_area_box_layout_reorder (GtkCellLayout *cell_layout,
117 GtkCellRenderer *renderer,
121 /* CellInfo/CellGroup metadata handling and convenience functions */
123 GtkCellRenderer *renderer;
125 guint expand : 1; /* Whether the cell expands */
126 guint pack : 1; /* Whether the cell is packed from the start or end */
127 guint align : 1; /* Whether to align this cell's position with adjacent rows */
135 guint expand_cells : 8;
139 GtkCellRenderer *renderer;
145 static CellInfo *cell_info_new (GtkCellRenderer *renderer,
149 static void cell_info_free (CellInfo *info);
150 static gint cell_info_find (CellInfo *info,
151 GtkCellRenderer *renderer);
153 static AllocatedCell *allocated_cell_new (GtkCellRenderer *renderer,
156 static void allocated_cell_free (AllocatedCell *cell);
157 static GList *list_consecutive_cells (GtkCellAreaBox *box);
158 static gint count_expand_groups (GtkCellAreaBox *box);
159 static void iter_weak_notify (GtkCellAreaBox *box,
160 GtkCellAreaBoxIter *dead_iter);
161 static void flush_iters (GtkCellAreaBox *box);
162 static void init_iter_groups (GtkCellAreaBox *box);
163 static void init_iter_group (GtkCellAreaBox *box,
164 GtkCellAreaBoxIter *iter);
165 static GSList *get_allocated_cells (GtkCellAreaBox *box,
166 GtkCellAreaBoxIter *iter,
170 struct _GtkCellAreaBoxPrivate
172 GtkOrientation orientation;
195 G_DEFINE_TYPE_WITH_CODE (GtkCellAreaBox, gtk_cell_area_box, GTK_TYPE_CELL_AREA,
196 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_LAYOUT,
197 gtk_cell_area_box_cell_layout_init)
198 G_IMPLEMENT_INTERFACE (GTK_TYPE_ORIENTABLE, NULL));
200 #define OPPOSITE_ORIENTATION(orientation) \
201 ((orientation) == GTK_ORIENTATION_HORIZONTAL ? \
202 GTK_ORIENTATION_VERTICAL : GTK_ORIENTATION_HORIZONTAL)
205 gtk_cell_area_box_init (GtkCellAreaBox *box)
207 GtkCellAreaBoxPrivate *priv;
209 box->priv = G_TYPE_INSTANCE_GET_PRIVATE (box,
210 GTK_TYPE_CELL_AREA_BOX,
211 GtkCellAreaBoxPrivate);
214 priv->orientation = GTK_ORIENTATION_HORIZONTAL;
215 priv->groups = g_array_new (FALSE, TRUE, sizeof (CellGroup));
222 gtk_cell_area_box_class_init (GtkCellAreaBoxClass *class)
224 GObjectClass *object_class = G_OBJECT_CLASS (class);
225 GtkCellAreaClass *area_class = GTK_CELL_AREA_CLASS (class);
228 object_class->finalize = gtk_cell_area_box_finalize;
229 object_class->dispose = gtk_cell_area_box_dispose;
230 object_class->set_property = gtk_cell_area_box_set_property;
231 object_class->get_property = gtk_cell_area_box_get_property;
233 /* GtkCellAreaClass */
234 area_class->add = gtk_cell_area_box_add;
235 area_class->remove = gtk_cell_area_box_remove;
236 area_class->forall = gtk_cell_area_box_forall;
237 area_class->get_cell_allocation = gtk_cell_area_box_get_cell_allocation;
238 area_class->event = gtk_cell_area_box_event;
239 area_class->render = gtk_cell_area_box_render;
240 area_class->set_cell_property = gtk_cell_area_box_set_cell_property;
241 area_class->get_cell_property = gtk_cell_area_box_get_cell_property;
243 area_class->create_iter = gtk_cell_area_box_create_iter;
244 area_class->get_request_mode = gtk_cell_area_box_get_request_mode;
245 area_class->get_preferred_width = gtk_cell_area_box_get_preferred_width;
246 area_class->get_preferred_height = gtk_cell_area_box_get_preferred_height;
247 area_class->get_preferred_height_for_width = gtk_cell_area_box_get_preferred_height_for_width;
248 area_class->get_preferred_width_for_height = gtk_cell_area_box_get_preferred_width_for_height;
250 area_class->grab_focus = gtk_cell_area_box_grab_focus;
253 g_object_class_override_property (object_class, PROP_ORIENTATION, "orientation");
255 g_object_class_install_property (object_class,
257 g_param_spec_int ("spacing",
259 P_("Space which is inserted between cells"),
263 GTK_PARAM_READWRITE));
265 /* Cell Properties */
266 gtk_cell_area_class_install_cell_property (area_class,
271 P_("Whether the cell expands"),
273 GTK_PARAM_READWRITE));
275 gtk_cell_area_class_install_cell_property (area_class,
280 P_("Whether cell should align with adjacent rows"),
282 GTK_PARAM_READWRITE));
284 gtk_cell_area_class_install_cell_property (area_class,
289 P_("A GtkPackType indicating whether the cell is packed with "
290 "reference to the start or end of the cell area"),
291 GTK_TYPE_PACK_TYPE, GTK_PACK_START,
292 GTK_PARAM_READWRITE));
294 g_type_class_add_private (object_class, sizeof (GtkCellAreaBoxPrivate));
298 /*************************************************************
299 * CellInfo/CellGroup basics and convenience functions *
300 *************************************************************/
302 cell_info_new (GtkCellRenderer *renderer,
307 CellInfo *info = g_slice_new (CellInfo);
309 info->renderer = g_object_ref_sink (renderer);
311 info->expand = expand;
318 cell_info_free (CellInfo *info)
320 g_object_unref (info->renderer);
322 g_slice_free (CellInfo, info);
326 cell_info_find (CellInfo *info,
327 GtkCellRenderer *renderer)
329 return (info->renderer == renderer) ? 0 : -1;
332 static AllocatedCell *
333 allocated_cell_new (GtkCellRenderer *renderer,
337 AllocatedCell *cell = g_slice_new (AllocatedCell);
339 cell->renderer = renderer;
340 cell->position = position;
347 allocated_cell_free (AllocatedCell *cell)
349 g_slice_free (AllocatedCell, cell);
353 list_consecutive_cells (GtkCellAreaBox *box)
355 GtkCellAreaBoxPrivate *priv = box->priv;
356 GList *l, *consecutive_cells = NULL, *pack_end_cells = NULL;
359 /* List cells in consecutive order taking their
360 * PACK_START/PACK_END options into account
362 for (l = priv->cells; l; l = l->next)
366 if (info->pack == GTK_PACK_START)
367 consecutive_cells = g_list_prepend (consecutive_cells, info);
370 for (l = priv->cells; l; l = l->next)
374 if (info->pack == GTK_PACK_END)
375 pack_end_cells = g_list_prepend (pack_end_cells, info);
378 consecutive_cells = g_list_reverse (consecutive_cells);
379 consecutive_cells = g_list_concat (consecutive_cells, pack_end_cells);
381 return consecutive_cells;
385 cell_groups_clear (GtkCellAreaBox *box)
387 GtkCellAreaBoxPrivate *priv = box->priv;
390 for (i = 0; i < priv->groups->len; i++)
392 CellGroup *group = &g_array_index (priv->groups, CellGroup, i);
394 g_list_free (group->cells);
397 g_array_set_size (priv->groups, 0);
401 cell_groups_rebuild (GtkCellAreaBox *box)
403 GtkCellAreaBoxPrivate *priv = box->priv;
404 CellGroup group = { 0, };
408 cell_groups_clear (box);
413 cells = list_consecutive_cells (box);
415 /* First group is implied */
416 g_array_append_val (priv->groups, group);
418 for (l = cells; l; l = l->next)
420 CellInfo *info = l->data;
422 /* A new group starts with any aligned cell, the first group is implied */
423 if (info->align && l != cells)
425 memset (&group, 0x0, sizeof (CellGroup));
428 g_array_append_val (priv->groups, group);
431 group.cells = g_list_prepend (group.cells, info);
434 /* A group expands if it contains any expand cells */
436 group.expand_cells++;
441 for (id = 0; id < priv->groups->len; id++)
443 CellGroup *group_ptr = &g_array_index (priv->groups, CellGroup, id);
445 group_ptr->cells = g_list_reverse (group_ptr->cells);
448 /* Iters need to be updated with the new grouping information */
449 init_iter_groups (box);
453 count_visible_cells (CellGroup *group,
457 gint visible_cells = 0;
458 gint n_expand_cells = 0;
460 for (l = group->cells; l; l = l->next)
462 CellInfo *info = l->data;
464 if (gtk_cell_renderer_get_visible (info->renderer))
474 *expand_cells = n_expand_cells;
476 return visible_cells;
480 count_expand_groups (GtkCellAreaBox *box)
482 GtkCellAreaBoxPrivate *priv = box->priv;
484 gint expand_groups = 0;
486 for (i = 0; i < priv->groups->len; i++)
488 CellGroup *group = &g_array_index (priv->groups, CellGroup, i);
490 if (group->expand_cells > 0)
494 return expand_groups;
498 iter_weak_notify (GtkCellAreaBox *box,
499 GtkCellAreaBoxIter *dead_iter)
501 GtkCellAreaBoxPrivate *priv = box->priv;
503 priv->iters = g_slist_remove (priv->iters, dead_iter);
507 init_iter_group (GtkCellAreaBox *box,
508 GtkCellAreaBoxIter *iter)
510 GtkCellAreaBoxPrivate *priv = box->priv;
511 gint *expand_groups, i;
513 expand_groups = g_new (gboolean, priv->groups->len);
515 for (i = 0; i < priv->groups->len; i++)
517 CellGroup *group = &g_array_index (priv->groups, CellGroup, i);
519 expand_groups[i] = (group->expand_cells > 0);
522 /* This call implies flushing the request info */
523 gtk_cell_area_box_init_groups (iter, priv->groups->len, expand_groups);
524 g_free (expand_groups);
528 init_iter_groups (GtkCellAreaBox *box)
530 GtkCellAreaBoxPrivate *priv = box->priv;
533 /* When the box's groups are reconstructed, iters need to
536 for (l = priv->iters; l; l = l->next)
538 GtkCellAreaBoxIter *iter = l->data;
540 init_iter_group (box, iter);
545 flush_iters (GtkCellAreaBox *box)
547 GtkCellAreaBoxPrivate *priv = box->priv;
550 /* When the box layout changes, iters need to
551 * be flushed and sizes for the box get requested again
553 for (l = priv->iters; l; l = l->next)
555 GtkCellAreaIter *iter = l->data;
557 gtk_cell_area_iter_flush (iter);
561 /* Returns an allocation for each cell in the orientation of the box,
562 * used in ->render()/->event() implementations to get a straight-forward
563 * list of allocated cells to operate on.
566 get_allocated_cells (GtkCellAreaBox *box,
567 GtkCellAreaBoxIter *iter,
570 const GtkCellAreaBoxAllocation *group_allocs;
571 GtkCellArea *area = GTK_CELL_AREA (box);
572 GtkCellAreaBoxPrivate *priv = box->priv;
574 GSList *allocated_cells = NULL;
577 group_allocs = gtk_cell_area_box_iter_get_orientation_allocs (iter, &n_allocs);
580 g_warning ("Trying to operate on an unallocated GtkCellAreaIter, "
581 "GtkCellAreaBox requires that the iter be allocated at least "
582 "in the orientation of the box");
586 for (i = 0; i < n_allocs; i++)
588 /* We dont always allocate all groups, sometimes the requested group has only invisible
589 * cells for every row, hence the usage of group_allocs[i].group_idx here
591 CellGroup *group = &g_array_index (priv->groups, CellGroup, group_allocs[i].group_idx);
593 /* Exception for single cell groups */
594 if (group->n_cells == 1)
596 CellInfo *info = group->cells->data;
597 AllocatedCell *cell =
598 allocated_cell_new (info->renderer, group_allocs[i].position, group_allocs[i].size);
600 allocated_cells = g_slist_prepend (allocated_cells, cell);
604 GtkRequestedSize *sizes;
605 gint avail_size, position;
606 gint visible_cells, expand_cells;
607 gint extra_size, extra_extra;
609 visible_cells = count_visible_cells (group, &expand_cells);
611 /* If this row has no visible cells in this group, just
612 * skip the allocation */
613 if (visible_cells == 0)
616 /* Offset the allocation to the group position and allocate into
617 * the group's available size */
618 position = group_allocs[i].position;
619 avail_size = group_allocs[i].size;
621 sizes = g_new (GtkRequestedSize, visible_cells);
623 for (j = 0, cell_list = group->cells; cell_list; cell_list = cell_list->next)
625 CellInfo *info = cell_list->data;
627 if (!gtk_cell_renderer_get_visible (info->renderer))
630 gtk_cell_area_request_renderer (area, info->renderer,
633 &sizes[j].minimum_size,
634 &sizes[j].natural_size);
636 sizes[j].data = info;
637 avail_size -= sizes[j].minimum_size;
642 /* Distribute cells naturally within the group */
643 avail_size -= (visible_cells - 1) * priv->spacing;
644 avail_size = gtk_distribute_natural_allocation (avail_size, visible_cells, sizes);
646 /* Calculate/distribute expand for cells */
647 if (expand_cells > 0)
649 extra_size = avail_size / expand_cells;
650 extra_extra = avail_size % expand_cells;
653 extra_size = extra_extra = 0;
655 /* Create the allocated cells (loop only over visible cells here) */
656 for (j = 0; j < visible_cells; j++)
658 CellInfo *info = sizes[j].data;
663 sizes[j].minimum_size += extra_size;
666 sizes[j].minimum_size++;
671 cell = allocated_cell_new (info->renderer, position, sizes[j].minimum_size);
673 allocated_cells = g_slist_prepend (allocated_cells, cell);
675 position += sizes[j].minimum_size;
676 position += priv->spacing;
685 /* Note it might not be important to reverse the list here at all,
686 * we have the correct positions, no need to allocate from left to right */
687 return g_slist_reverse (allocated_cells);
690 /*************************************************************
692 *************************************************************/
694 gtk_cell_area_box_finalize (GObject *object)
696 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (object);
697 GtkCellAreaBoxPrivate *priv = box->priv;
700 /* Unref/free the iter list */
701 for (l = priv->iters; l; l = l->next)
702 g_object_weak_unref (G_OBJECT (l->data), (GWeakNotify)iter_weak_notify, box);
704 g_slist_free (priv->iters);
707 /* Free the cell grouping info */
708 cell_groups_clear (box);
709 g_array_free (priv->groups, TRUE);
711 G_OBJECT_CLASS (gtk_cell_area_box_parent_class)->finalize (object);
715 gtk_cell_area_box_dispose (GObject *object)
717 G_OBJECT_CLASS (gtk_cell_area_box_parent_class)->dispose (object);
721 gtk_cell_area_box_set_property (GObject *object,
726 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (object);
730 case PROP_ORIENTATION:
731 box->priv->orientation = g_value_get_enum (value);
733 /* Notify that size needs to be requested again */
737 gtk_cell_area_box_set_spacing (box, g_value_get_int (value));
740 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
746 gtk_cell_area_box_get_property (GObject *object,
751 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (object);
755 case PROP_ORIENTATION:
756 g_value_set_enum (value, box->priv->orientation);
759 g_value_set_int (value, gtk_cell_area_box_get_spacing (box));
762 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
767 /*************************************************************
769 *************************************************************/
771 gtk_cell_area_box_add (GtkCellArea *area,
772 GtkCellRenderer *renderer)
774 gtk_cell_area_box_pack_start (GTK_CELL_AREA_BOX (area),
775 renderer, FALSE, TRUE);
779 gtk_cell_area_box_remove (GtkCellArea *area,
780 GtkCellRenderer *renderer)
782 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
783 GtkCellAreaBoxPrivate *priv = box->priv;
786 node = g_list_find_custom (priv->cells, renderer,
787 (GCompareFunc)cell_info_find);
791 CellInfo *info = node->data;
793 cell_info_free (info);
795 priv->cells = g_list_delete_link (priv->cells, node);
797 /* Reconstruct cell groups */
798 cell_groups_rebuild (box);
801 g_warning ("Trying to remove a cell renderer that is not present GtkCellAreaBox");
805 gtk_cell_area_box_forall (GtkCellArea *area,
806 GtkCellCallback callback,
807 gpointer callback_data)
809 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
810 GtkCellAreaBoxPrivate *priv = box->priv;
813 for (list = priv->cells; list; list = list->next)
815 CellInfo *info = list->data;
817 callback (info->renderer, callback_data);
822 gtk_cell_area_box_get_cell_allocation (GtkCellArea *area,
823 GtkCellAreaIter *iter,
825 GtkCellRenderer *renderer,
826 const GdkRectangle *cell_area,
827 GdkRectangle *allocation)
829 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
830 GtkCellAreaBoxPrivate *priv = box->priv;
831 GtkCellAreaBoxIter *box_iter = GTK_CELL_AREA_BOX_ITER (iter);
832 GSList *allocated_cells, *l;
834 *allocation = *cell_area;
836 /* Get a list of cells with allocation sizes decided regardless
837 * of alignments and pack order etc. */
838 allocated_cells = get_allocated_cells (box, box_iter, widget);
840 for (l = allocated_cells; l; l = l->next)
842 AllocatedCell *cell = l->data;
844 if (cell->renderer == renderer)
846 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
848 allocation->x = cell_area->x + cell->position;
849 allocation->width = cell->size;
853 allocation->y = cell_area->y + cell->position;
854 allocation->height = cell->size;
861 g_slist_foreach (allocated_cells, (GFunc)allocated_cell_free, NULL);
862 g_slist_free (allocated_cells);
872 gtk_cell_area_cycle_focus (GtkCellAreaBox *box,
873 GtkCellRenderer *focus_cell,
874 GtkDirectionType direction)
876 GtkCellAreaBoxPrivate *priv = box->priv;
877 GtkCellArea *area = GTK_CELL_AREA (box);
878 gint cycle = FOCUS_NONE;
882 case GTK_DIR_TAB_FORWARD:
885 case GTK_DIR_TAB_BACKWARD:
889 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
890 gtk_cell_area_focus_leave (area, direction);
895 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
896 gtk_cell_area_focus_leave (area, direction);
901 if (priv->orientation == GTK_ORIENTATION_VERTICAL)
902 gtk_cell_area_focus_leave (area, direction);
907 if (priv->orientation == GTK_ORIENTATION_VERTICAL)
908 gtk_cell_area_focus_leave (area, direction);
916 if (cycle != FOCUS_NONE)
918 gboolean found_cell = FALSE;
919 gboolean cycled_focus = FALSE;
923 for (i = (cycle == FOCUS_NEXT) ? 0 : priv->groups->len -1;
924 i >= 0 && i < priv->groups->len;
925 i = (cycle == FOCUS_NEXT) ? i + 1 : i - 1)
927 CellGroup *group = &g_array_index (priv->groups, CellGroup, i);
929 for (list = (cycle == FOCUS_NEXT) ? g_list_first (group->cells) : g_list_last (group->cells);
930 list; list = (cycle == FOCUS_NEXT) ? list->next : list->prev)
932 CellInfo *info = list->data;
934 if (!found_cell && info->renderer == focus_cell)
938 if (gtk_cell_renderer_can_focus (info->renderer))
940 gtk_cell_area_set_focus_cell (area, info->renderer);
949 /* We cycled right out of the area, signal the parent we
950 * need to focus out of the area */
952 gtk_cell_area_focus_leave (area, direction);
957 gtk_cell_area_box_event (GtkCellArea *area,
958 GtkCellAreaIter *iter,
961 const GdkRectangle *cell_area,
962 GtkCellRendererState flags)
966 /* First let the parent class handle activation of cells via keystrokes */
968 GTK_CELL_AREA_CLASS (gtk_cell_area_box_parent_class)->event (area, iter, widget,
969 event, cell_area, flags);
974 /* Now detect keystrokes that move focus directionally inside the area
975 * or signal that focus should leave the area in a given direction.
977 * To navigate focus we only need to loop through the groups and
978 * observe the orientation and push focus along to the next cell
979 * or signal that focus should leave the area.
981 if (event->type == GDK_KEY_PRESS && (flags & GTK_CELL_RENDERER_FOCUSED) != 0)
983 GdkEventKey *key_event = (GdkEventKey *)event;
984 GtkCellRenderer *focus_cell;
986 focus_cell = gtk_cell_area_get_focus_cell (area);
990 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
991 GtkDirectionType direction = GTK_DIR_TAB_FORWARD;
992 gboolean have_direction = FALSE;
994 /* Check modifiers and TAB keys ! */
995 switch (key_event->keyval)
999 direction = GTK_DIR_UP;
1000 have_direction = TRUE;
1002 case GDK_KEY_KP_Down:
1004 direction = GTK_DIR_DOWN;
1005 have_direction = TRUE;
1007 case GDK_KEY_KP_Left:
1009 direction = GTK_DIR_LEFT;
1010 have_direction = TRUE;
1012 case GDK_KEY_KP_Right:
1014 direction = GTK_DIR_RIGHT;
1015 have_direction = TRUE;
1023 gtk_cell_area_cycle_focus (box, focus_cell, direction);
1029 /* Also detect mouse events, for mouse events we need to allocate the renderers
1030 * and find which renderer needs to be activated.
1038 gtk_cell_area_box_render (GtkCellArea *area,
1039 GtkCellAreaIter *iter,
1042 const GdkRectangle *cell_area,
1043 GtkCellRendererState flags)
1045 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
1046 GtkCellAreaBoxPrivate *priv = box->priv;
1047 GtkCellAreaBoxIter *box_iter = GTK_CELL_AREA_BOX_ITER (iter);
1048 GSList *allocated_cells, *l;
1049 GdkRectangle background_area, inner_area;
1051 background_area = *cell_area;
1053 /* Get a list of cells with allocation sizes decided regardless
1054 * of alignments and pack order etc. */
1055 allocated_cells = get_allocated_cells (box, box_iter, widget);
1057 for (l = allocated_cells; l; l = l->next)
1059 AllocatedCell *cell = l->data;
1061 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
1063 background_area.x = cell_area->x + cell->position;
1064 background_area.width = cell->size;
1068 background_area.y = cell_area->y + cell->position;
1069 background_area.height = cell->size;
1072 /* Remove margins from the background area to produce the cell area
1074 gtk_cell_area_inner_cell_area (area, &background_area, &inner_area);
1076 /* XXX We have to do some per-cell considerations for the 'flags'
1077 * for focus handling */
1078 gtk_cell_renderer_render (cell->renderer, cr, widget,
1079 &background_area, &inner_area,
1084 g_slist_foreach (allocated_cells, (GFunc)allocated_cell_free, NULL);
1085 g_slist_free (allocated_cells);
1089 gtk_cell_area_box_set_cell_property (GtkCellArea *area,
1090 GtkCellRenderer *renderer,
1092 const GValue *value,
1095 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
1096 GtkCellAreaBoxPrivate *priv = box->priv;
1099 gboolean rebuild = FALSE;
1100 gboolean flush = FALSE;
1102 GtkPackType pack_type;
1104 node = g_list_find_custom (priv->cells, renderer,
1105 (GCompareFunc)cell_info_find);
1113 case CELL_PROP_EXPAND:
1114 val = g_value_get_boolean (value);
1116 if (info->expand != val)
1123 case CELL_PROP_ALIGN:
1124 val = g_value_get_boolean (value);
1126 if (info->align != val)
1133 case CELL_PROP_PACK_TYPE:
1134 pack_type = g_value_get_enum (value);
1136 if (info->pack != pack_type)
1138 info->pack = pack_type;
1143 GTK_CELL_AREA_WARN_INVALID_CHILD_PROPERTY_ID (area, prop_id, pspec);
1147 /* Groups need to be rebuilt */
1150 cell_groups_rebuild (box);
1159 gtk_cell_area_box_get_cell_property (GtkCellArea *area,
1160 GtkCellRenderer *renderer,
1165 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
1166 GtkCellAreaBoxPrivate *priv = box->priv;
1170 node = g_list_find_custom (priv->cells, renderer,
1171 (GCompareFunc)cell_info_find);
1179 case CELL_PROP_EXPAND:
1180 g_value_set_boolean (value, info->expand);
1183 case CELL_PROP_ALIGN:
1184 g_value_set_boolean (value, info->align);
1187 case CELL_PROP_PACK_TYPE:
1188 g_value_set_enum (value, info->pack);
1191 GTK_CELL_AREA_WARN_INVALID_CHILD_PROPERTY_ID (area, prop_id, pspec);
1197 static GtkCellAreaIter *
1198 gtk_cell_area_box_create_iter (GtkCellArea *area)
1200 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
1201 GtkCellAreaBoxPrivate *priv = box->priv;
1202 GtkCellAreaIter *iter =
1203 (GtkCellAreaIter *)g_object_new (GTK_TYPE_CELL_AREA_BOX_ITER, NULL);
1205 priv->iters = g_slist_prepend (priv->iters, iter);
1207 g_object_weak_ref (G_OBJECT (iter), (GWeakNotify)iter_weak_notify, box);
1209 /* Tell the new group about our cell layout */
1210 init_iter_group (box, GTK_CELL_AREA_BOX_ITER (iter));
1215 static GtkSizeRequestMode
1216 gtk_cell_area_box_get_request_mode (GtkCellArea *area)
1218 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
1219 GtkCellAreaBoxPrivate *priv = box->priv;
1221 return (priv->orientation) == GTK_ORIENTATION_HORIZONTAL ?
1222 GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH :
1223 GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT;
1227 compute_size (GtkCellAreaBox *box,
1228 GtkOrientation orientation,
1229 GtkCellAreaBoxIter *iter,
1235 GtkCellAreaBoxPrivate *priv = box->priv;
1236 GtkCellArea *area = GTK_CELL_AREA (box);
1242 for (i = 0; i < priv->groups->len; i++)
1244 CellGroup *group = &g_array_index (priv->groups, CellGroup, i);
1245 gint group_min_size = 0;
1246 gint group_nat_size = 0;
1248 for (list = group->cells; list; list = list->next)
1250 CellInfo *info = list->data;
1251 gint renderer_min_size, renderer_nat_size;
1253 if (!gtk_cell_renderer_get_visible (info->renderer))
1256 gtk_cell_area_request_renderer (area, info->renderer, orientation, widget, for_size,
1257 &renderer_min_size, &renderer_nat_size);
1259 if (orientation == priv->orientation)
1263 min_size += priv->spacing;
1264 nat_size += priv->spacing;
1267 if (group_min_size > 0)
1269 group_min_size += priv->spacing;
1270 group_nat_size += priv->spacing;
1273 min_size += renderer_min_size;
1274 nat_size += renderer_nat_size;
1275 group_min_size += renderer_min_size;
1276 group_nat_size += renderer_nat_size;
1280 min_size = MAX (min_size, renderer_min_size);
1281 nat_size = MAX (nat_size, renderer_nat_size);
1282 group_min_size = MAX (group_min_size, renderer_min_size);
1283 group_nat_size = MAX (group_nat_size, renderer_nat_size);
1287 if (orientation == GTK_ORIENTATION_HORIZONTAL)
1290 gtk_cell_area_box_iter_push_group_width (iter, group->id, group_min_size, group_nat_size);
1292 gtk_cell_area_box_iter_push_group_width_for_height (iter, group->id, for_size,
1293 group_min_size, group_nat_size);
1298 gtk_cell_area_box_iter_push_group_height (iter, group->id, group_min_size, group_nat_size);
1300 gtk_cell_area_box_iter_push_group_height_for_width (iter, group->id, for_size,
1301 group_min_size, group_nat_size);
1305 *minimum_size = min_size;
1306 *natural_size = nat_size;
1310 get_group_sizes (GtkCellArea *area,
1312 GtkOrientation orientation,
1316 GtkRequestedSize *sizes;
1320 *n_sizes = count_visible_cells (group, NULL);
1321 sizes = g_new (GtkRequestedSize, *n_sizes);
1323 for (l = group->cells, i = 0; l; l = l->next)
1325 CellInfo *info = l->data;
1327 if (!gtk_cell_renderer_get_visible (info->renderer))
1330 sizes[i].data = info;
1332 gtk_cell_area_request_renderer (area, info->renderer,
1333 orientation, widget, -1,
1334 &sizes[i].minimum_size,
1335 &sizes[i].natural_size);
1344 compute_group_size_for_opposing_orientation (GtkCellAreaBox *box,
1351 GtkCellAreaBoxPrivate *priv = box->priv;
1352 GtkCellArea *area = GTK_CELL_AREA (box);
1354 /* Exception for single cell groups */
1355 if (group->n_cells == 1)
1357 CellInfo *info = group->cells->data;
1359 gtk_cell_area_request_renderer (area, info->renderer,
1360 OPPOSITE_ORIENTATION (priv->orientation),
1361 widget, for_size, minimum_size, natural_size);
1365 GtkRequestedSize *orientation_sizes;
1368 gint avail_size = for_size;
1369 gint extra_size, extra_extra;
1370 gint min_size = 0, nat_size = 0;
1372 orientation_sizes = get_group_sizes (area, group, priv->orientation, widget, &n_sizes);
1374 /* First naturally allocate the cells in the group into the for_size */
1375 avail_size -= (n_sizes - 1) * priv->spacing;
1376 for (i = 0; i < n_sizes; i++)
1377 avail_size -= orientation_sizes[i].minimum_size;
1379 avail_size = gtk_distribute_natural_allocation (avail_size, n_sizes, orientation_sizes);
1381 /* Calculate/distribute expand for cells */
1382 if (group->expand_cells > 0)
1384 extra_size = avail_size / group->expand_cells;
1385 extra_extra = avail_size % group->expand_cells;
1388 extra_size = extra_extra = 0;
1390 for (i = 0; i < n_sizes; i++)
1392 gint cell_min, cell_nat;
1394 info = orientation_sizes[i].data;
1398 orientation_sizes[i].minimum_size += extra_size;
1401 orientation_sizes[i].minimum_size++;
1406 gtk_cell_area_request_renderer (area, info->renderer,
1407 OPPOSITE_ORIENTATION (priv->orientation),
1409 orientation_sizes[i].minimum_size,
1410 &cell_min, &cell_nat);
1412 min_size = MAX (min_size, cell_min);
1413 nat_size = MAX (nat_size, cell_nat);
1416 *minimum_size = min_size;
1417 *natural_size = nat_size;
1419 g_free (orientation_sizes);
1424 compute_size_for_opposing_orientation (GtkCellAreaBox *box,
1425 GtkCellAreaBoxIter *iter,
1431 GtkCellAreaBoxPrivate *priv = box->priv;
1433 GtkRequestedSize *orientation_sizes;
1434 gint n_groups, n_expand_groups, i;
1435 gint avail_size = for_size;
1436 gint extra_size, extra_extra;
1437 gint min_size = 0, nat_size = 0;
1439 n_expand_groups = count_expand_groups (box);
1441 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
1442 orientation_sizes = gtk_cell_area_box_iter_get_widths (iter, &n_groups);
1444 orientation_sizes = gtk_cell_area_box_iter_get_heights (iter, &n_groups);
1446 /* First start by naturally allocating space among groups of cells */
1447 avail_size -= (n_groups - 1) * priv->spacing;
1448 for (i = 0; i < n_groups; i++)
1449 avail_size -= orientation_sizes[i].minimum_size;
1451 avail_size = gtk_distribute_natural_allocation (avail_size, n_groups, orientation_sizes);
1453 /* Calculate/distribute expand for groups */
1454 if (n_expand_groups > 0)
1456 extra_size = avail_size / n_expand_groups;
1457 extra_extra = avail_size % n_expand_groups;
1460 extra_size = extra_extra = 0;
1462 /* Now we need to naturally allocate sizes for cells in each group
1463 * and push the height-for-width for each group accordingly while accumulating
1464 * the overall height-for-width for this row.
1466 for (i = 0; i < n_groups; i++)
1468 gint group_min, group_nat;
1469 gint group_idx = GPOINTER_TO_INT (orientation_sizes[i].data);
1471 group = &g_array_index (priv->groups, CellGroup, group_idx);
1473 if (group->expand_cells > 0)
1475 orientation_sizes[i].minimum_size += extra_size;
1478 orientation_sizes[i].minimum_size++;
1483 /* Now we have the allocation for the group, request it's height-for-width */
1484 compute_group_size_for_opposing_orientation (box, group, widget,
1485 orientation_sizes[i].minimum_size,
1486 &group_min, &group_nat);
1488 min_size = MAX (min_size, group_min);
1489 nat_size = MAX (nat_size, group_nat);
1491 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
1493 gtk_cell_area_box_iter_push_group_height_for_width (iter, group_idx, for_size,
1494 group_min, group_nat);
1498 gtk_cell_area_box_iter_push_group_width_for_height (iter, group_idx, for_size,
1499 group_min, group_nat);
1503 *minimum_size = min_size;
1504 *natural_size = nat_size;
1506 g_free (orientation_sizes);
1512 gtk_cell_area_box_get_preferred_width (GtkCellArea *area,
1513 GtkCellAreaIter *iter,
1515 gint *minimum_width,
1516 gint *natural_width)
1518 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
1519 GtkCellAreaBoxIter *box_iter;
1520 gint min_width, nat_width;
1522 g_return_if_fail (GTK_IS_CELL_AREA_BOX_ITER (iter));
1524 box_iter = GTK_CELL_AREA_BOX_ITER (iter);
1526 /* Compute the size of all renderers for current row data,
1527 * bumping cell alignments in the iter along the way */
1528 compute_size (box, GTK_ORIENTATION_HORIZONTAL,
1529 box_iter, widget, -1, &min_width, &nat_width);
1532 *minimum_width = min_width;
1535 *natural_width = nat_width;
1539 gtk_cell_area_box_get_preferred_height (GtkCellArea *area,
1540 GtkCellAreaIter *iter,
1542 gint *minimum_height,
1543 gint *natural_height)
1545 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
1546 GtkCellAreaBoxIter *box_iter;
1547 gint min_height, nat_height;
1549 g_return_if_fail (GTK_IS_CELL_AREA_BOX_ITER (iter));
1551 box_iter = GTK_CELL_AREA_BOX_ITER (iter);
1553 /* Compute the size of all renderers for current row data,
1554 * bumping cell alignments in the iter along the way */
1555 compute_size (box, GTK_ORIENTATION_VERTICAL,
1556 box_iter, widget, -1, &min_height, &nat_height);
1559 *minimum_height = min_height;
1562 *natural_height = nat_height;
1566 gtk_cell_area_box_get_preferred_height_for_width (GtkCellArea *area,
1567 GtkCellAreaIter *iter,
1570 gint *minimum_height,
1571 gint *natural_height)
1573 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
1574 GtkCellAreaBoxIter *box_iter;
1575 GtkCellAreaBoxPrivate *priv;
1576 gint min_height, nat_height;
1578 g_return_if_fail (GTK_IS_CELL_AREA_BOX_ITER (iter));
1580 box_iter = GTK_CELL_AREA_BOX_ITER (iter);
1583 if (priv->orientation == GTK_ORIENTATION_VERTICAL)
1585 /* Add up vertical requests of height for width and push the overall
1586 * cached sizes for alignments */
1587 compute_size (box, priv->orientation, box_iter, widget, width, &min_height, &nat_height);
1591 /* Juice: virtually allocate cells into the for_width using the
1592 * alignments and then return the overall height for that width, and cache it */
1593 compute_size_for_opposing_orientation (box, box_iter, widget, width, &min_height, &nat_height);
1597 *minimum_height = min_height;
1600 *natural_height = nat_height;
1604 gtk_cell_area_box_get_preferred_width_for_height (GtkCellArea *area,
1605 GtkCellAreaIter *iter,
1608 gint *minimum_width,
1609 gint *natural_width)
1611 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
1612 GtkCellAreaBoxIter *box_iter;
1613 GtkCellAreaBoxPrivate *priv;
1614 gint min_width, nat_width;
1616 g_return_if_fail (GTK_IS_CELL_AREA_BOX_ITER (iter));
1618 box_iter = GTK_CELL_AREA_BOX_ITER (iter);
1621 if (priv->orientation == GTK_ORIENTATION_HORIZONTAL)
1623 /* Add up horizontal requests of width for height and push the overall
1624 * cached sizes for alignments */
1625 compute_size (box, priv->orientation, box_iter, widget, height, &min_width, &nat_width);
1629 /* Juice: horizontally allocate cells into the for_height using the
1630 * alignments and then return the overall width for that height, and cache it */
1631 compute_size_for_opposing_orientation (box, box_iter, widget, height, &min_width, &nat_width);
1635 *minimum_width = min_width;
1638 *natural_width = nat_width;
1642 gtk_cell_area_box_grab_focus (GtkCellArea *area,
1643 GtkDirectionType direction)
1645 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (area);
1646 GtkCellAreaBoxPrivate *priv;
1647 gboolean first_cell = FALSE;
1655 case GTK_DIR_TAB_FORWARD:
1661 case GTK_DIR_TAB_BACKWARD:
1669 for (i = first_cell ? 0 : priv->groups->len -1;
1670 i >= 0 && i < priv->groups->len;
1671 i = first_cell ? i + 1 : i - 1)
1673 CellGroup *group = &g_array_index (priv->groups, CellGroup, i);
1675 for (list = first_cell ? g_list_first (group->cells) : g_list_last (group->cells);
1676 list; list = first_cell ? list->next : list->prev)
1678 CellInfo *info = list->data;
1680 if (gtk_cell_renderer_can_focus (info->renderer))
1682 gtk_cell_area_set_focus_cell (area, info->renderer);
1690 /*************************************************************
1691 * GtkCellLayoutIface *
1692 *************************************************************/
1694 gtk_cell_area_box_cell_layout_init (GtkCellLayoutIface *iface)
1696 iface->pack_start = gtk_cell_area_box_layout_pack_start;
1697 iface->pack_end = gtk_cell_area_box_layout_pack_end;
1698 iface->reorder = gtk_cell_area_box_layout_reorder;
1702 gtk_cell_area_box_layout_pack_start (GtkCellLayout *cell_layout,
1703 GtkCellRenderer *renderer,
1706 gtk_cell_area_box_pack_start (GTK_CELL_AREA_BOX (cell_layout), renderer, expand, TRUE);
1710 gtk_cell_area_box_layout_pack_end (GtkCellLayout *cell_layout,
1711 GtkCellRenderer *renderer,
1714 gtk_cell_area_box_pack_end (GTK_CELL_AREA_BOX (cell_layout), renderer, expand, TRUE);
1718 gtk_cell_area_box_layout_reorder (GtkCellLayout *cell_layout,
1719 GtkCellRenderer *renderer,
1722 GtkCellAreaBox *box = GTK_CELL_AREA_BOX (cell_layout);
1723 GtkCellAreaBoxPrivate *priv = box->priv;
1727 node = g_list_find_custom (priv->cells, renderer,
1728 (GCompareFunc)cell_info_find);
1734 priv->cells = g_list_delete_link (priv->cells, node);
1735 priv->cells = g_list_insert (priv->cells, info, position);
1737 cell_groups_rebuild (box);
1741 /*************************************************************
1743 *************************************************************/
1745 gtk_cell_area_box_new (void)
1747 return (GtkCellArea *)g_object_new (GTK_TYPE_CELL_AREA_BOX, NULL);
1751 gtk_cell_area_box_pack_start (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 GtkCellAreaBox twice");
1771 info = cell_info_new (renderer, GTK_PACK_START, expand, align);
1773 priv->cells = g_list_append (priv->cells, info);
1775 cell_groups_rebuild (box);
1779 gtk_cell_area_box_pack_end (GtkCellAreaBox *box,
1780 GtkCellRenderer *renderer,
1784 GtkCellAreaBoxPrivate *priv;
1787 g_return_if_fail (GTK_IS_CELL_AREA_BOX (box));
1788 g_return_if_fail (GTK_IS_CELL_RENDERER (renderer));
1792 if (g_list_find_custom (priv->cells, renderer,
1793 (GCompareFunc)cell_info_find))
1795 g_warning ("Refusing to add the same cell renderer to a GtkCellArea twice");
1799 info = cell_info_new (renderer, GTK_PACK_END, expand, align);
1801 priv->cells = g_list_append (priv->cells, info);
1803 cell_groups_rebuild (box);
1807 gtk_cell_area_box_get_spacing (GtkCellAreaBox *box)
1809 g_return_val_if_fail (GTK_IS_CELL_AREA_BOX (box), 0);
1811 return box->priv->spacing;
1815 gtk_cell_area_box_set_spacing (GtkCellAreaBox *box,
1818 GtkCellAreaBoxPrivate *priv;
1820 g_return_if_fail (GTK_IS_CELL_AREA_BOX (box));
1824 if (priv->spacing != spacing)
1826 priv->spacing = spacing;
1828 g_object_notify (G_OBJECT (box), "spacing");
1830 /* Notify that size needs to be requested again */