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,
272 GTK_PARAM_READWRITE));
275 * GtkSizeGroup:ignore-hidden:
277 * If %TRUE, hidden widgets are ignored when determining
278 * the size of the group.
282 g_object_class_install_property (gobject_class,
284 g_param_spec_boolean ("ignore-hidden",
286 P_("If TRUE, hidden widgets are ignored "
287 "when determining the size of the group"),
289 GTK_PARAM_READWRITE));
291 size_groups_quark = g_quark_from_static_string (size_groups_tag);
292 visited_quark = g_quark_from_string (visited_tag);
296 gtk_size_group_init (GtkSizeGroup *size_group)
298 size_group->widgets = NULL;
299 size_group->mode = GTK_SIZE_GROUP_HORIZONTAL;
300 size_group->have_width = 0;
301 size_group->have_height = 0;
302 size_group->ignore_hidden = 0;
306 gtk_size_group_get_type (void)
308 static GType size_group_type = 0;
310 if (!size_group_type)
312 static const GTypeInfo size_group_info =
314 sizeof (GtkSizeGroupClass),
315 NULL, /* base_init */
316 NULL, /* base_finalize */
317 (GClassInitFunc) gtk_size_group_class_init,
318 NULL, /* class_finalize */
319 NULL, /* class_data */
320 sizeof (GtkSizeGroup),
321 16, /* n_preallocs */
322 (GInstanceInitFunc) gtk_size_group_init,
325 size_group_type = g_type_register_static (G_TYPE_OBJECT, I_("GtkSizeGroup"),
326 &size_group_info, 0);
329 return size_group_type;
333 gtk_size_group_set_property (GObject *object,
338 GtkSizeGroup *size_group = GTK_SIZE_GROUP (object);
343 gtk_size_group_set_mode (size_group, g_value_get_enum (value));
345 case PROP_IGNORE_HIDDEN:
346 gtk_size_group_set_ignore_hidden (size_group, g_value_get_boolean (value));
349 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
355 gtk_size_group_get_property (GObject *object,
360 GtkSizeGroup *size_group = GTK_SIZE_GROUP (object);
365 g_value_set_enum (value, size_group->mode);
367 case PROP_IGNORE_HIDDEN:
368 g_value_set_boolean (value, size_group->ignore_hidden);
371 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
377 * gtk_size_group_new:
378 * @mode: the mode for the new size group.
380 * Create a new #GtkSizeGroup.
382 * Return value: a newly created #GtkSizeGroup
385 gtk_size_group_new (GtkSizeGroupMode mode)
387 GtkSizeGroup *size_group = g_object_new (GTK_TYPE_SIZE_GROUP, NULL);
389 size_group->mode = mode;
395 * gtk_size_group_set_mode:
396 * @size_group: a #GtkSizeGroup
397 * @mode: the mode to set for the size group.
399 * Sets the #GtkSizeGroupMode of the size group. The mode of the size
400 * group determines whether the widgets in the size group should
401 * all have the same horizontal requisition (%GTK_SIZE_GROUP_MODE_HORIZONTAL)
402 * all have the same vertical requisition (%GTK_SIZE_GROUP_MODE_VERTICAL),
403 * or should all have the same requisition in both directions
404 * (%GTK_SIZE_GROUP_MODE_BOTH).
407 gtk_size_group_set_mode (GtkSizeGroup *size_group,
408 GtkSizeGroupMode mode)
410 g_return_if_fail (GTK_IS_SIZE_GROUP (size_group));
412 if (size_group->mode != mode)
414 if (size_group->mode != GTK_SIZE_GROUP_NONE)
415 queue_resize_on_group (size_group);
416 size_group->mode = mode;
417 if (size_group->mode != GTK_SIZE_GROUP_NONE)
418 queue_resize_on_group (size_group);
420 g_object_notify (G_OBJECT (size_group), "mode");
425 * gtk_size_group_get_mode:
426 * @size_group: a #GtkSizeGroup
428 * Gets the current mode of the size group. See gtk_size_group_set_mode().
430 * Return value: the current mode of the size group.
433 gtk_size_group_get_mode (GtkSizeGroup *size_group)
435 g_return_val_if_fail (GTK_IS_SIZE_GROUP (size_group), GTK_SIZE_GROUP_BOTH);
437 return size_group->mode;
441 * gtk_size_group_set_ignore_hidden:
442 * @size_group: a #GtkSizeGroup
443 * @ignore_hidden: whether hidden widgets should be ignored
444 * when calculating the size
446 * Sets whether invisible widgets should be ignored when
447 * calculating the size.
452 gtk_size_group_set_ignore_hidden (GtkSizeGroup *size_group,
453 gboolean ignore_hidden)
455 g_return_if_fail (GTK_IS_SIZE_GROUP (size_group));
457 ignore_hidden = ignore_hidden != FALSE;
459 if (size_group->ignore_hidden != ignore_hidden)
461 size_group->ignore_hidden = ignore_hidden;
463 g_object_notify (G_OBJECT (size_group), "ignore-hidden");
468 * gtk_size_group_get_ignore_hidden:
469 * @size_group: a #GtkSizeGroup
471 * Returns if invisible widgets are ignored when calculating the size.
473 * Returns: %TRUE if invisible widgets are ignored.
478 gtk_size_group_get_ignore_hidden (GtkSizeGroup *size_group)
480 g_return_val_if_fail (GTK_IS_SIZE_GROUP (size_group), FALSE);
482 return size_group->ignore_hidden;
486 gtk_size_group_widget_destroyed (GtkWidget *widget,
487 GtkSizeGroup *size_group)
489 gtk_size_group_remove_widget (size_group, widget);
493 * gtk_size_group_add_widget:
494 * @size_group: a #GtkSizeGroup
495 * @widget: the #GtkWidget to add
497 * Adds a widget to a #GtkSizeGroup. In the future, the requisition
498 * of the widget will be determined as the maximum of its requisition
499 * and the requisition of the other widgets in the size group.
500 * Whether this applies horizontally, vertically, or in both directions
501 * depends on the mode of the size group. See gtk_size_group_set_mode().
504 gtk_size_group_add_widget (GtkSizeGroup *size_group,
509 g_return_if_fail (GTK_IS_SIZE_GROUP (size_group));
510 g_return_if_fail (GTK_IS_WIDGET (widget));
512 groups = get_size_groups (widget);
514 if (!g_slist_find (groups, size_group))
516 groups = g_slist_prepend (groups, size_group);
517 set_size_groups (widget, groups);
519 size_group->widgets = g_slist_prepend (size_group->widgets, widget);
521 g_signal_connect (widget, "destroy",
522 G_CALLBACK (gtk_size_group_widget_destroyed),
525 g_object_ref (size_group);
528 queue_resize_on_group (size_group);
532 * gtk_size_group_remove_widget:
533 * @size_group: a #GtkSizeGrup
534 * @widget: the #GtkWidget to remove
536 * Removes a widget from a #GtkSizeGroup.
539 gtk_size_group_remove_widget (GtkSizeGroup *size_group,
544 g_return_if_fail (GTK_IS_SIZE_GROUP (size_group));
545 g_return_if_fail (GTK_IS_WIDGET (widget));
546 g_return_if_fail (g_slist_find (size_group->widgets, widget));
548 g_signal_handlers_disconnect_by_func (widget,
549 gtk_size_group_widget_destroyed,
552 groups = get_size_groups (widget);
553 groups = g_slist_remove (groups, size_group);
554 set_size_groups (widget, groups);
556 size_group->widgets = g_slist_remove (size_group->widgets, widget);
557 queue_resize_on_group (size_group);
558 gtk_widget_queue_resize (widget);
560 g_object_unref (size_group);
564 * gtk_size_group_get_widgets:
565 * @size_group: a #GtkSizeGrup
567 * Returns the list of widgets associated with @size_group.
569 * Return value: a #GSList of widgets. The list is owned by GTK+
570 * and should not be modified.
575 gtk_size_group_get_widgets (GtkSizeGroup *size_group)
577 return size_group->widgets;
581 get_base_dimension (GtkWidget *widget,
582 GtkSizeGroupMode mode)
584 GtkWidgetAuxInfo *aux_info = _gtk_widget_get_aux_info (widget, FALSE);
586 if (mode == GTK_SIZE_GROUP_HORIZONTAL)
588 if (aux_info && aux_info->width > 0)
589 return aux_info->width;
591 return widget->requisition.width;
595 if (aux_info && aux_info->height > 0)
596 return aux_info->height;
598 return widget->requisition.height;
603 do_size_request (GtkWidget *widget)
605 if (GTK_WIDGET_REQUEST_NEEDED (widget))
607 gtk_widget_ensure_style (widget);
608 GTK_PRIVATE_UNSET_FLAG (widget, GTK_REQUEST_NEEDED);
609 g_signal_emit_by_name (widget,
611 &widget->requisition);
616 compute_base_dimension (GtkWidget *widget,
617 GtkSizeGroupMode mode)
619 do_size_request (widget);
621 return get_base_dimension (widget, mode);
625 compute_dimension (GtkWidget *widget,
626 GtkSizeGroupMode mode)
628 GSList *widgets = NULL;
629 GSList *groups = NULL;
633 add_widget_to_closure (widget, mode, &groups, &widgets);
635 g_slist_foreach (widgets, (GFunc)mark_unvisited, NULL);
636 g_slist_foreach (groups, (GFunc)mark_unvisited, NULL);
638 g_slist_foreach (widgets, (GFunc)g_object_ref, NULL);
642 result = compute_base_dimension (widget, mode);
646 GtkSizeGroup *group = groups->data;
648 if (mode == GTK_SIZE_GROUP_HORIZONTAL && group->have_width)
649 result = group->requisition.width;
650 else if (mode == GTK_SIZE_GROUP_VERTICAL && group->have_height)
651 result = group->requisition.height;
657 GtkWidget *tmp_widget = tmp_list->data;
659 gint dimension = compute_base_dimension (tmp_widget, mode);
661 if (GTK_WIDGET_VISIBLE (tmp_widget) || !group->ignore_hidden)
663 if (dimension > result)
667 tmp_list = tmp_list->next;
673 GtkSizeGroup *tmp_group = tmp_list->data;
675 if (mode == GTK_SIZE_GROUP_HORIZONTAL)
677 tmp_group->have_width = TRUE;
678 tmp_group->requisition.width = result;
682 tmp_group->have_height = TRUE;
683 tmp_group->requisition.height = result;
686 tmp_list = tmp_list->next;
691 g_slist_foreach (widgets, (GFunc)g_object_unref, NULL);
693 g_slist_free (widgets);
694 g_slist_free (groups);
700 get_dimension (GtkWidget *widget,
701 GtkSizeGroupMode mode)
703 GSList *widgets = NULL;
704 GSList *groups = NULL;
707 add_widget_to_closure (widget, mode, &groups, &widgets);
709 g_slist_foreach (widgets, (GFunc)mark_unvisited, NULL);
710 g_slist_foreach (groups, (GFunc)mark_unvisited, NULL);
714 result = get_base_dimension (widget, mode);
718 GtkSizeGroup *group = groups->data;
720 if (mode == GTK_SIZE_GROUP_HORIZONTAL && group->have_width)
721 result = group->requisition.width;
722 else if (mode == GTK_SIZE_GROUP_VERTICAL && group->have_height)
723 result = group->requisition.height;
726 g_slist_free (widgets);
727 g_slist_free (groups);
733 get_fast_child_requisition (GtkWidget *widget,
734 GtkRequisition *requisition)
736 GtkWidgetAuxInfo *aux_info = _gtk_widget_get_aux_info (widget, FALSE);
738 *requisition = widget->requisition;
742 if (aux_info->width > 0)
743 requisition->width = aux_info->width;
744 if (aux_info && aux_info->height > 0)
745 requisition->height = aux_info->height;
750 * _gtk_size_group_get_child_requisition:
751 * @widget: a #GtkWidget
752 * @requisition: location to store computed requisition.
754 * Retrieve the "child requisition" of the widget, taking account grouping
755 * of the widget's requisition with other widgets.
758 _gtk_size_group_get_child_requisition (GtkWidget *widget,
759 GtkRequisition *requisition)
763 if (get_size_groups (widget))
765 requisition->width = get_dimension (widget, GTK_SIZE_GROUP_HORIZONTAL);
766 requisition->height = get_dimension (widget, GTK_SIZE_GROUP_VERTICAL);
768 /* Only do the full computation if we actually have size groups */
771 get_fast_child_requisition (widget, requisition);
776 * _gtk_size_group_compute_requisition:
777 * @widget: a #GtkWidget
778 * @requisition: location to store computed requisition.
780 * Compute the requisition of a widget taking into account grouping of
781 * the widget's requisition with other widgets.
784 _gtk_size_group_compute_requisition (GtkWidget *widget,
785 GtkRequisition *requisition)
790 if (get_size_groups (widget))
792 /* Only do the full computation if we actually have size groups */
794 width = compute_dimension (widget, GTK_SIZE_GROUP_HORIZONTAL);
795 height = compute_dimension (widget, GTK_SIZE_GROUP_VERTICAL);
799 requisition->width = width;
800 requisition->height = height;
805 do_size_request (widget);
808 get_fast_child_requisition (widget, requisition);
813 * _gtk_size_group_queue_resize:
814 * @widget: a #GtkWidget
816 * Queue a resize on a widget, and on all other widgets grouped with this widget.
819 _gtk_size_group_queue_resize (GtkWidget *widget)
821 queue_resize_on_widget (widget, TRUE);
824 #define __GTK_SIZE_GROUP_C__
825 #include "gtkaliasdef.c"