1 /* GTK - The GIMP Toolkit
3 * Copyright (C) 2001 Red Hat Software
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
22 #include "gtkcontainer.h"
24 #include "gtkprivate.h"
25 #include "gtksizegroup.h"
34 static void gtk_size_group_set_property (GObject *object,
38 static void gtk_size_group_get_property (GObject *object,
43 static void add_group_to_closure (GtkSizeGroup *group,
44 GtkSizeGroupMode mode,
47 static void add_widget_to_closure (GtkWidget *widget,
48 GtkSizeGroupMode mode,
52 static GQuark size_groups_quark;
53 static const gchar size_groups_tag[] = "gtk-size-groups";
55 static GQuark visited_quark;
56 static const gchar visited_tag[] = "gtk-size-group-visited";
59 get_size_groups (GtkWidget *widget)
61 return g_object_get_qdata (G_OBJECT (widget), size_groups_quark);
65 set_size_groups (GtkWidget *widget,
68 g_object_set_qdata (G_OBJECT (widget), size_groups_quark, groups);
72 mark_visited (gpointer object)
74 g_object_set_qdata (object, visited_quark, "visited");
78 mark_unvisited (gpointer object)
80 g_object_set_qdata (object, visited_quark, NULL);
84 is_visited (gpointer object)
86 return g_object_get_qdata (object, visited_quark) != NULL;
90 add_group_to_closure (GtkSizeGroup *group,
91 GtkSizeGroupMode mode,
97 *groups = g_slist_prepend (*groups, group);
100 tmp_widgets = group->widgets;
103 GtkWidget *tmp_widget = tmp_widgets->data;
105 if (!is_visited (tmp_widget))
106 add_widget_to_closure (tmp_widget, mode, groups, widgets);
108 tmp_widgets = tmp_widgets->next;
113 add_widget_to_closure (GtkWidget *widget,
114 GtkSizeGroupMode mode,
120 *widgets = g_slist_prepend (*widgets, widget);
121 mark_visited (widget);
123 tmp_groups = get_size_groups (widget);
126 GtkSizeGroup *tmp_group = tmp_groups->data;
128 if ((tmp_group->mode == GTK_SIZE_GROUP_BOTH || tmp_group->mode == mode) &&
129 !is_visited (tmp_group))
130 add_group_to_closure (tmp_group, mode, groups, widgets);
132 tmp_groups = tmp_groups->next;
137 real_queue_resize (GtkWidget *widget)
139 GTK_PRIVATE_SET_FLAG (widget, GTK_ALLOC_NEEDED);
140 GTK_PRIVATE_SET_FLAG (widget, GTK_REQUEST_NEEDED);
143 _gtk_container_queue_resize (GTK_CONTAINER (widget->parent));
144 else if (GTK_WIDGET_TOPLEVEL (widget) && GTK_IS_CONTAINER (widget))
145 _gtk_container_queue_resize (GTK_CONTAINER (widget));
149 reset_group_sizes (GSList *groups)
151 GSList *tmp_list = groups;
154 GtkSizeGroup *tmp_group = tmp_list->data;
156 tmp_group->have_width = FALSE;
157 tmp_group->have_height = FALSE;
159 tmp_list = tmp_list->next;
164 queue_resize_on_widget (GtkWidget *widget,
165 gboolean check_siblings)
167 GtkWidget *parent = widget;
172 GSList *widget_groups;
176 if (widget == parent && !check_siblings)
178 real_queue_resize (widget);
179 parent = parent->parent;
183 widget_groups = get_size_groups (parent);
186 if (widget == parent)
187 real_queue_resize (widget);
189 parent = parent->parent;
196 add_widget_to_closure (parent, GTK_SIZE_GROUP_HORIZONTAL, &groups, &widgets);
197 g_slist_foreach (widgets, (GFunc)mark_unvisited, NULL);
198 g_slist_foreach (groups, (GFunc)mark_unvisited, NULL);
200 reset_group_sizes (groups);
205 if (tmp_list->data == parent)
207 if (widget == parent)
208 real_queue_resize (parent);
211 queue_resize_on_widget (tmp_list->data, FALSE);
213 tmp_list = tmp_list->next;
216 g_slist_free (widgets);
217 g_slist_free (groups);
222 add_widget_to_closure (parent, GTK_SIZE_GROUP_VERTICAL, &groups, &widgets);
223 g_slist_foreach (widgets, (GFunc)mark_unvisited, NULL);
224 g_slist_foreach (groups, (GFunc)mark_unvisited, NULL);
226 reset_group_sizes (groups);
231 if (tmp_list->data == parent)
233 if (widget == parent)
234 real_queue_resize (parent);
237 queue_resize_on_widget (tmp_list->data, FALSE);
239 tmp_list = tmp_list->next;
242 g_slist_free (widgets);
243 g_slist_free (groups);
245 parent = parent->parent;
250 queue_resize_on_group (GtkSizeGroup *size_group)
252 if (size_group->widgets)
253 queue_resize_on_widget (size_group->widgets->data, TRUE);
257 gtk_size_group_class_init (GtkSizeGroupClass *klass)
259 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
261 gobject_class->set_property = gtk_size_group_set_property;
262 gobject_class->get_property = gtk_size_group_get_property;
264 g_object_class_install_property (gobject_class,
266 g_param_spec_enum ("mode",
268 P_("The directions in which the size group affects the requested sizes"
269 " of its component widgets"),
270 GTK_TYPE_SIZE_GROUP_MODE,
271 GTK_SIZE_GROUP_HORIZONTAL, GTK_PARAM_READWRITE));
274 * GtkSizeGroup:ignore-hidden:
276 * If %TRUE, unmapped widgets are ignored when determining
277 * the size of the group.
281 g_object_class_install_property (gobject_class,
283 g_param_spec_boolean ("ignore-hidden",
285 P_("If TRUE, unmapped widgets are ignored "
286 "when determining the size of the group"),
288 GTK_PARAM_READWRITE));
290 size_groups_quark = g_quark_from_static_string (size_groups_tag);
291 visited_quark = g_quark_from_string (visited_tag);
295 gtk_size_group_init (GtkSizeGroup *size_group)
297 size_group->widgets = NULL;
298 size_group->mode = GTK_SIZE_GROUP_HORIZONTAL;
299 size_group->have_width = 0;
300 size_group->have_height = 0;
301 size_group->ignore_hidden = 0;
304 G_DEFINE_TYPE (GtkSizeGroup, gtk_size_group, G_TYPE_OBJECT)
307 gtk_size_group_set_property (GObject *object,
312 GtkSizeGroup *size_group = GTK_SIZE_GROUP (object);
317 gtk_size_group_set_mode (size_group, g_value_get_enum (value));
319 case PROP_IGNORE_HIDDEN:
320 gtk_size_group_set_ignore_hidden (size_group, g_value_get_boolean (value));
323 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
329 gtk_size_group_get_property (GObject *object,
334 GtkSizeGroup *size_group = GTK_SIZE_GROUP (object);
339 g_value_set_enum (value, size_group->mode);
341 case PROP_IGNORE_HIDDEN:
342 g_value_set_boolean (value, size_group->ignore_hidden);
345 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
351 * gtk_size_group_new:
352 * @mode: the mode for the new size group.
354 * Create a new #GtkSizeGroup.
356 * Return value: a newly created #GtkSizeGroup
359 gtk_size_group_new (GtkSizeGroupMode mode)
361 GtkSizeGroup *size_group = g_object_new (GTK_TYPE_SIZE_GROUP, NULL);
363 size_group->mode = mode;
369 * gtk_size_group_set_mode:
370 * @size_group: a #GtkSizeGroup
371 * @mode: the mode to set for the size group.
373 * Sets the #GtkSizeGroupMode of the size group. The mode of the size
374 * group determines whether the widgets in the size group should
375 * all have the same horizontal requisition (%GTK_SIZE_GROUP_MODE_HORIZONTAL)
376 * all have the same vertical requisition (%GTK_SIZE_GROUP_MODE_VERTICAL),
377 * or should all have the same requisition in both directions
378 * (%GTK_SIZE_GROUP_MODE_BOTH).
381 gtk_size_group_set_mode (GtkSizeGroup *size_group,
382 GtkSizeGroupMode mode)
384 g_return_if_fail (GTK_IS_SIZE_GROUP (size_group));
386 if (size_group->mode != mode)
388 if (size_group->mode != GTK_SIZE_GROUP_NONE)
389 queue_resize_on_group (size_group);
390 size_group->mode = mode;
391 if (size_group->mode != GTK_SIZE_GROUP_NONE)
392 queue_resize_on_group (size_group);
394 g_object_notify (G_OBJECT (size_group), "mode");
399 * gtk_size_group_get_mode:
400 * @size_group: a #GtkSizeGroup
402 * Gets the current mode of the size group. See gtk_size_group_set_mode().
404 * Return value: the current mode of the size group.
407 gtk_size_group_get_mode (GtkSizeGroup *size_group)
409 g_return_val_if_fail (GTK_IS_SIZE_GROUP (size_group), GTK_SIZE_GROUP_BOTH);
411 return size_group->mode;
415 * gtk_size_group_set_ignore_hidden:
416 * @size_group: a #GtkSizeGroup
417 * @ignore_hidden: whether unmapped widgets should be ignored
418 * when calculating the size
420 * Sets whether unmapped widgets should be ignored when
421 * calculating the size.
426 gtk_size_group_set_ignore_hidden (GtkSizeGroup *size_group,
427 gboolean ignore_hidden)
429 g_return_if_fail (GTK_IS_SIZE_GROUP (size_group));
431 ignore_hidden = ignore_hidden != FALSE;
433 if (size_group->ignore_hidden != ignore_hidden)
435 size_group->ignore_hidden = ignore_hidden;
437 g_object_notify (G_OBJECT (size_group), "ignore-hidden");
442 * gtk_size_group_get_ignore_hidden:
443 * @size_group: a #GtkSizeGroup
445 * Returns if invisible widgets are ignored when calculating the size.
447 * Returns: %TRUE if invisible widgets are ignored.
452 gtk_size_group_get_ignore_hidden (GtkSizeGroup *size_group)
454 g_return_val_if_fail (GTK_IS_SIZE_GROUP (size_group), FALSE);
456 return size_group->ignore_hidden;
460 gtk_size_group_widget_destroyed (GtkWidget *widget,
461 GtkSizeGroup *size_group)
463 gtk_size_group_remove_widget (size_group, widget);
467 * gtk_size_group_add_widget:
468 * @size_group: a #GtkSizeGroup
469 * @widget: the #GtkWidget to add
471 * Adds a widget to a #GtkSizeGroup. In the future, the requisition
472 * of the widget will be determined as the maximum of its requisition
473 * and the requisition of the other widgets in the size group.
474 * Whether this applies horizontally, vertically, or in both directions
475 * depends on the mode of the size group. See gtk_size_group_set_mode().
478 gtk_size_group_add_widget (GtkSizeGroup *size_group,
483 g_return_if_fail (GTK_IS_SIZE_GROUP (size_group));
484 g_return_if_fail (GTK_IS_WIDGET (widget));
486 groups = get_size_groups (widget);
488 if (!g_slist_find (groups, size_group))
490 groups = g_slist_prepend (groups, size_group);
491 set_size_groups (widget, groups);
493 size_group->widgets = g_slist_prepend (size_group->widgets, widget);
495 g_signal_connect (widget, "destroy",
496 G_CALLBACK (gtk_size_group_widget_destroyed),
499 g_object_ref (size_group);
502 queue_resize_on_group (size_group);
506 * gtk_size_group_remove_widget:
507 * @size_group: a #GtkSizeGrup
508 * @widget: the #GtkWidget to remove
510 * Removes a widget from a #GtkSizeGroup.
513 gtk_size_group_remove_widget (GtkSizeGroup *size_group,
518 g_return_if_fail (GTK_IS_SIZE_GROUP (size_group));
519 g_return_if_fail (GTK_IS_WIDGET (widget));
520 g_return_if_fail (g_slist_find (size_group->widgets, widget));
522 g_signal_handlers_disconnect_by_func (widget,
523 gtk_size_group_widget_destroyed,
526 groups = get_size_groups (widget);
527 groups = g_slist_remove (groups, size_group);
528 set_size_groups (widget, groups);
530 size_group->widgets = g_slist_remove (size_group->widgets, widget);
531 queue_resize_on_group (size_group);
532 gtk_widget_queue_resize (widget);
534 g_object_unref (size_group);
538 * gtk_size_group_get_widgets:
539 * @size_group: a #GtkSizeGrup
541 * Returns the list of widgets associated with @size_group.
543 * Return value: a #GSList of widgets. The list is owned by GTK+
544 * and should not be modified.
549 gtk_size_group_get_widgets (GtkSizeGroup *size_group)
551 return size_group->widgets;
555 get_base_dimension (GtkWidget *widget,
556 GtkSizeGroupMode mode)
558 GtkWidgetAuxInfo *aux_info = _gtk_widget_get_aux_info (widget, FALSE);
560 if (mode == GTK_SIZE_GROUP_HORIZONTAL)
562 if (aux_info && aux_info->width > 0)
563 return aux_info->width;
565 return widget->requisition.width;
569 if (aux_info && aux_info->height > 0)
570 return aux_info->height;
572 return widget->requisition.height;
577 do_size_request (GtkWidget *widget)
579 if (GTK_WIDGET_REQUEST_NEEDED (widget))
581 gtk_widget_ensure_style (widget);
582 GTK_PRIVATE_UNSET_FLAG (widget, GTK_REQUEST_NEEDED);
583 g_signal_emit_by_name (widget,
585 &widget->requisition);
590 compute_base_dimension (GtkWidget *widget,
591 GtkSizeGroupMode mode)
593 do_size_request (widget);
595 return get_base_dimension (widget, mode);
599 compute_dimension (GtkWidget *widget,
600 GtkSizeGroupMode mode)
602 GSList *widgets = NULL;
603 GSList *groups = NULL;
607 add_widget_to_closure (widget, mode, &groups, &widgets);
609 g_slist_foreach (widgets, (GFunc)mark_unvisited, NULL);
610 g_slist_foreach (groups, (GFunc)mark_unvisited, NULL);
612 g_slist_foreach (widgets, (GFunc)g_object_ref, NULL);
616 result = compute_base_dimension (widget, mode);
620 GtkSizeGroup *group = groups->data;
622 if (mode == GTK_SIZE_GROUP_HORIZONTAL && group->have_width)
623 result = group->requisition.width;
624 else if (mode == GTK_SIZE_GROUP_VERTICAL && group->have_height)
625 result = group->requisition.height;
631 GtkWidget *tmp_widget = tmp_list->data;
633 gint dimension = compute_base_dimension (tmp_widget, mode);
635 if (GTK_WIDGET_MAPPED (tmp_widget) || !group->ignore_hidden)
637 if (dimension > result)
641 tmp_list = tmp_list->next;
647 GtkSizeGroup *tmp_group = tmp_list->data;
649 if (mode == GTK_SIZE_GROUP_HORIZONTAL)
651 tmp_group->have_width = TRUE;
652 tmp_group->requisition.width = result;
656 tmp_group->have_height = TRUE;
657 tmp_group->requisition.height = result;
660 tmp_list = tmp_list->next;
665 g_slist_foreach (widgets, (GFunc)g_object_unref, NULL);
667 g_slist_free (widgets);
668 g_slist_free (groups);
674 get_dimension (GtkWidget *widget,
675 GtkSizeGroupMode mode)
677 GSList *widgets = NULL;
678 GSList *groups = NULL;
681 add_widget_to_closure (widget, mode, &groups, &widgets);
683 g_slist_foreach (widgets, (GFunc)mark_unvisited, NULL);
684 g_slist_foreach (groups, (GFunc)mark_unvisited, NULL);
688 result = get_base_dimension (widget, mode);
692 GtkSizeGroup *group = groups->data;
694 if (mode == GTK_SIZE_GROUP_HORIZONTAL && group->have_width)
695 result = group->requisition.width;
696 else if (mode == GTK_SIZE_GROUP_VERTICAL && group->have_height)
697 result = group->requisition.height;
700 g_slist_free (widgets);
701 g_slist_free (groups);
707 get_fast_child_requisition (GtkWidget *widget,
708 GtkRequisition *requisition)
710 GtkWidgetAuxInfo *aux_info = _gtk_widget_get_aux_info (widget, FALSE);
712 *requisition = widget->requisition;
716 if (aux_info->width > 0)
717 requisition->width = aux_info->width;
718 if (aux_info && aux_info->height > 0)
719 requisition->height = aux_info->height;
724 * _gtk_size_group_get_child_requisition:
725 * @widget: a #GtkWidget
726 * @requisition: location to store computed requisition.
728 * Retrieve the "child requisition" of the widget, taking account grouping
729 * of the widget's requisition with other widgets.
732 _gtk_size_group_get_child_requisition (GtkWidget *widget,
733 GtkRequisition *requisition)
737 if (get_size_groups (widget))
739 requisition->width = get_dimension (widget, GTK_SIZE_GROUP_HORIZONTAL);
740 requisition->height = get_dimension (widget, GTK_SIZE_GROUP_VERTICAL);
742 /* Only do the full computation if we actually have size groups */
745 get_fast_child_requisition (widget, requisition);
750 * _gtk_size_group_compute_requisition:
751 * @widget: a #GtkWidget
752 * @requisition: location to store computed requisition.
754 * Compute the requisition of a widget taking into account grouping of
755 * the widget's requisition with other widgets.
758 _gtk_size_group_compute_requisition (GtkWidget *widget,
759 GtkRequisition *requisition)
764 if (get_size_groups (widget))
766 /* Only do the full computation if we actually have size groups */
768 width = compute_dimension (widget, GTK_SIZE_GROUP_HORIZONTAL);
769 height = compute_dimension (widget, GTK_SIZE_GROUP_VERTICAL);
773 requisition->width = width;
774 requisition->height = height;
779 do_size_request (widget);
782 get_fast_child_requisition (widget, requisition);
787 * _gtk_size_group_queue_resize:
788 * @widget: a #GtkWidget
790 * Queue a resize on a widget, and on all other widgets grouped with this widget.
793 _gtk_size_group_queue_resize (GtkWidget *widget)
795 queue_resize_on_widget (widget, TRUE);
798 #define __GTK_SIZE_GROUP_C__
799 #include "gtkaliasdef.c"