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.
21 #include "gtkcontainer.h"
23 #include "gtkprivate.h"
24 #include "gtksignal.h"
25 #include "gtksizegroup.h"
32 static void gtk_size_group_set_property (GObject *object,
36 static void gtk_size_group_get_property (GObject *object,
41 static void add_group_to_closure (GtkSizeGroup *group,
42 GtkSizeGroupMode mode,
45 static void add_widget_to_closure (GtkWidget *widget,
46 GtkSizeGroupMode mode,
50 static GQuark size_groups_quark;
51 static const gchar *size_groups_tag = "gtk-size-groups";
54 get_size_groups (GtkWidget *widget)
56 if (!size_groups_quark)
57 size_groups_quark = g_quark_from_string (size_groups_tag);
59 return g_object_get_qdata (G_OBJECT (widget), size_groups_quark);
63 set_size_groups (GtkWidget *widget,
66 if (!size_groups_quark)
67 size_groups_quark = g_quark_from_string (size_groups_tag);
69 g_object_set_qdata (G_OBJECT (widget), size_groups_quark, groups);
73 add_group_to_closure (GtkSizeGroup *group,
74 GtkSizeGroupMode mode,
80 *groups = g_slist_prepend (*groups, group);
82 tmp_widgets = group->widgets;
85 GtkWidget *tmp_widget = tmp_widgets->data;
87 if (!g_slist_find (*widgets, tmp_widget))
88 add_widget_to_closure (tmp_widget, mode, groups, widgets);
90 tmp_widgets = tmp_widgets->next;
95 add_widget_to_closure (GtkWidget *widget,
96 GtkSizeGroupMode mode,
102 *widgets = g_slist_prepend (*widgets, widget);
104 tmp_groups = get_size_groups (widget);
107 GtkSizeGroup *tmp_group = tmp_groups->data;
109 if ((tmp_group->mode == GTK_SIZE_GROUP_BOTH || tmp_group->mode == mode) &&
110 !g_slist_find (*groups, tmp_group))
111 add_group_to_closure (tmp_group, mode, groups, widgets);
113 tmp_groups = tmp_groups->next;
118 real_queue_resize (GtkWidget *widget)
120 GTK_PRIVATE_SET_FLAG (widget, GTK_ALLOC_NEEDED);
121 GTK_PRIVATE_SET_FLAG (widget, GTK_REQUEST_NEEDED);
124 _gtk_container_queue_resize (GTK_CONTAINER (widget->parent));
125 else if (GTK_WIDGET_TOPLEVEL (widget) && GTK_IS_CONTAINER (widget))
126 _gtk_container_queue_resize (GTK_CONTAINER (widget));
130 reset_group_sizes (GSList *groups)
132 GSList *tmp_list = groups;
135 GtkSizeGroup *tmp_group = tmp_list->data;
137 tmp_group->have_width = FALSE;
138 tmp_group->have_height = FALSE;
140 tmp_list = tmp_list->next;
145 queue_resize_on_widget (GtkWidget *widget,
146 gboolean check_siblings)
148 GtkWidget *parent = widget;
153 GSList *widget_groups;
157 if (widget == parent && !check_siblings)
159 real_queue_resize (widget);
160 parent = parent->parent;
164 widget_groups = get_size_groups (parent);
167 if (widget == parent)
168 real_queue_resize (widget);
170 parent = parent->parent;
177 add_widget_to_closure (parent, GTK_SIZE_GROUP_HORIZONTAL, &groups, &widgets);
178 reset_group_sizes (groups);
183 if (tmp_list->data == parent)
185 if (widget == parent)
186 real_queue_resize (parent);
189 queue_resize_on_widget (tmp_list->data, FALSE);
191 tmp_list = tmp_list->next;
194 g_slist_free (widgets);
195 g_slist_free (groups);
200 add_widget_to_closure (parent, GTK_SIZE_GROUP_VERTICAL, &groups, &widgets);
201 reset_group_sizes (groups);
206 if (tmp_list->data == parent)
208 if (widget == parent)
209 real_queue_resize (parent);
212 queue_resize_on_widget (tmp_list->data, FALSE);
214 tmp_list = tmp_list->next;
217 g_slist_free (widgets);
218 g_slist_free (groups);
220 parent = parent->parent;
225 queue_resize_on_group (GtkSizeGroup *size_group)
227 if (size_group->widgets)
228 queue_resize_on_widget (size_group->widgets->data, TRUE);
232 gtk_size_group_class_init (GtkSizeGroupClass *klass)
234 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
236 gobject_class->set_property = gtk_size_group_set_property;
237 gobject_class->get_property = gtk_size_group_get_property;
239 g_object_class_install_property (gobject_class,
241 g_param_spec_enum ("mode",
243 _("The directions in which the size group effects the requested sizes"
244 " of its component widgets."),
245 GTK_TYPE_SIZE_GROUP_MODE,
246 GTK_SIZE_GROUP_HORIZONTAL,
251 gtk_size_group_init (GtkSizeGroup *size_group)
253 size_group->widgets = NULL;
254 size_group->mode = GTK_SIZE_GROUP_HORIZONTAL;
255 size_group->have_width = 0;
256 size_group->have_height = 0;
260 gtk_size_group_get_type (void)
262 static GtkType size_group_type = 0;
264 if (!size_group_type)
266 static const GTypeInfo size_group_info =
268 sizeof (GtkSizeGroupClass),
269 NULL, /* base_init */
270 NULL, /* base_finalize */
271 (GClassInitFunc) gtk_size_group_class_init,
272 NULL, /* class_finalize */
273 NULL, /* class_data */
274 sizeof (GtkSizeGroup),
275 16, /* n_preallocs */
276 (GInstanceInitFunc) gtk_size_group_init,
279 size_group_type = g_type_register_static (G_TYPE_OBJECT, "GtkSizeGroup", &size_group_info, 0);
282 return size_group_type;
286 gtk_size_group_set_property (GObject *object,
291 GtkSizeGroup *size_group = GTK_SIZE_GROUP (object);
296 gtk_size_group_set_mode (size_group, g_value_get_enum (value));
299 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
305 gtk_size_group_get_property (GObject *object,
310 GtkSizeGroup *size_group = GTK_SIZE_GROUP (object);
315 g_value_set_enum (value, size_group->mode);
318 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
324 * gtk_size_group_new:
325 * @mode: the mode for the new size group.
327 * Create a new #GtkSizeGroup.
329 * Return value: a newly created #GtkSizeGroup
332 gtk_size_group_new (GtkSizeGroupMode mode)
334 GtkSizeGroup *size_group = g_object_new (GTK_TYPE_SIZE_GROUP, NULL);
336 size_group->mode = mode;
342 * gtk_size_group_set_mode:
343 * @size_group: a #GtkSizeGroup
344 * @mode: the mode to set for the size group.
346 * Sets the #GtkSizeGroupMode of the size group. The mode of the size
347 * group determines whether the widgets in the size group should
348 * all have the same horizontal requisition (%GTK_SIZE_GROUP_MODE_HORIZONTAL)
349 * all have the same vertical requisition (%GTK_SIZE_GROUP_MODE_VERTICAL),
350 * or should all have the same requisition in both directions
351 * (%GTK_SIZE_GROUP_MODE_BOTH).
354 gtk_size_group_set_mode (GtkSizeGroup *size_group,
355 GtkSizeGroupMode mode)
357 g_return_if_fail (GTK_IS_SIZE_GROUP (size_group));
359 if (size_group->mode != mode)
361 if (size_group->mode != GTK_SIZE_GROUP_NONE)
362 queue_resize_on_group (size_group);
363 size_group->mode = mode;
364 if (size_group->mode != GTK_SIZE_GROUP_NONE)
365 queue_resize_on_group (size_group);
367 g_object_notify (G_OBJECT (size_group), "mode");
372 * gtk_size_group_get_mode:
373 * @size_group: a #GtkSizeGroup
375 * Gets the current mode of the size group. See gtk_size_group_set_mode().
377 * Return value: the current mode of the size group.
380 gtk_size_group_get_mode (GtkSizeGroup *size_group)
382 g_return_val_if_fail (GTK_IS_SIZE_GROUP (size_group), GTK_SIZE_GROUP_BOTH);
384 return size_group->mode;
388 gtk_size_group_widget_destroyed (GtkWidget *widget,
389 GtkSizeGroup *size_group)
391 gtk_size_group_remove_widget (size_group, widget);
395 * gtk_size_group_add_widget:
396 * @size_group: a #GtkSizeGroup
397 * @widget: the #GtkWidget to add
399 * Adds a widget to a #GtkSizeGroup. In the future, the requisition
400 * of the widget will be determined as the maximum of its requisition
401 * and the requisition of the other widgets in the size group.
402 * Whether this applies horizontally, vertically, or in both directions
403 * depends on the mode of the size group. See gtk_size_group_set_mode().
406 gtk_size_group_add_widget (GtkSizeGroup *size_group,
411 g_return_if_fail (GTK_IS_SIZE_GROUP (size_group));
412 g_return_if_fail (GTK_IS_WIDGET (widget));
414 groups = get_size_groups (widget);
416 if (!g_slist_find (groups, widget))
418 groups = g_slist_prepend (groups, size_group);
419 set_size_groups (widget, groups);
421 size_group->widgets = g_slist_prepend (size_group->widgets, widget);
423 gtk_signal_connect (GTK_OBJECT (widget), "destroy",
424 GTK_SIGNAL_FUNC (gtk_size_group_widget_destroyed), size_group);
426 g_object_ref (G_OBJECT (size_group));
429 queue_resize_on_group (size_group);
433 * gtk_size_group_remove_widget:
434 * @size_group: a #GtkSizeGrup
435 * @widget: the #GtkWidget to remove
437 * Removes a widget from a #GtkSizeGroup.
440 gtk_size_group_remove_widget (GtkSizeGroup *size_group,
445 g_return_if_fail (GTK_IS_SIZE_GROUP (size_group));
446 g_return_if_fail (GTK_IS_WIDGET (widget));
447 g_return_if_fail (g_slist_find (size_group->widgets, widget));
449 gtk_signal_disconnect_by_func (GTK_OBJECT (widget),
450 GTK_SIGNAL_FUNC (gtk_size_group_widget_destroyed), size_group);
452 groups = get_size_groups (widget);
453 groups = g_slist_remove (groups, size_group);
454 set_size_groups (widget, groups);
456 size_group->widgets = g_slist_remove (size_group->widgets, widget);
457 queue_resize_on_group (size_group);
458 gtk_widget_queue_resize (widget);
460 g_object_unref (G_OBJECT (size_group));
464 get_base_dimension (GtkWidget *widget,
465 GtkSizeGroupMode mode)
467 GtkWidgetAuxInfo *aux_info = _gtk_widget_get_aux_info (widget, FALSE);
469 if (mode == GTK_SIZE_GROUP_HORIZONTAL)
471 if (aux_info && aux_info->width > 0)
472 return aux_info->width;
474 return widget->requisition.width;
478 if (aux_info && aux_info->height > 0)
479 return aux_info->height;
481 return widget->requisition.height;
486 do_size_request (GtkWidget *widget)
488 if (GTK_WIDGET_REQUEST_NEEDED (widget))
490 gtk_widget_ensure_style (widget);
491 gtk_signal_emit_by_name (GTK_OBJECT (widget), "size_request", &widget->requisition);
493 GTK_PRIVATE_UNSET_FLAG (widget, GTK_REQUEST_NEEDED);
498 compute_base_dimension (GtkWidget *widget,
499 GtkSizeGroupMode mode)
501 do_size_request (widget);
503 return get_base_dimension (widget, mode);
507 compute_dimension (GtkWidget *widget,
508 GtkSizeGroupMode mode)
510 GSList *widgets = NULL;
511 GSList *groups = NULL;
515 add_widget_to_closure (widget, mode, &groups, &widgets);
517 g_slist_foreach (widgets, (GFunc)g_object_ref, NULL);
521 result = compute_base_dimension (widget, mode);
525 GtkSizeGroup *group = groups->data;
527 if (mode == GTK_SIZE_GROUP_HORIZONTAL && group->have_width)
528 result = group->requisition.width;
529 else if (mode == GTK_SIZE_GROUP_VERTICAL && group->have_height)
530 result = group->requisition.height;
536 GtkWidget *tmp_widget = tmp_list->data;
538 gint dimension = compute_base_dimension (tmp_widget, mode);
540 if (dimension > result)
543 tmp_list = tmp_list->next;
549 GtkSizeGroup *tmp_group = tmp_list->data;
551 if (mode == GTK_SIZE_GROUP_HORIZONTAL)
553 tmp_group->have_width = TRUE;
554 tmp_group->requisition.width = result;
558 tmp_group->have_height = TRUE;
559 tmp_group->requisition.height = result;
562 tmp_list = tmp_list->next;
567 g_slist_foreach (widgets, (GFunc)g_object_unref, NULL);
569 g_slist_free (widgets);
570 g_slist_free (groups);
576 get_dimension (GtkWidget *widget,
577 GtkSizeGroupMode mode)
579 GSList *widgets = NULL;
580 GSList *groups = NULL;
583 add_widget_to_closure (widget, mode, &groups, &widgets);
587 result = get_base_dimension (widget, mode);
591 GtkSizeGroup *group = groups->data;
593 if (mode == GTK_SIZE_GROUP_HORIZONTAL && group->have_width)
594 result = group->requisition.width;
595 else if (mode == GTK_SIZE_GROUP_VERTICAL && group->have_height)
596 result = group->requisition.height;
599 g_slist_free (widgets);
600 g_slist_free (groups);
606 get_fast_child_requisition (GtkWidget *widget,
607 GtkRequisition *requisition)
609 GtkWidgetAuxInfo *aux_info = _gtk_widget_get_aux_info (widget, FALSE);
611 *requisition = widget->requisition;
615 if (aux_info->width > 0)
616 requisition->width = aux_info->width;
617 if (aux_info && aux_info->height > 0)
618 requisition->height = aux_info->height;
623 * _gtk_size_group_get_child_requisition:
624 * @widget: a #GtkWidget
625 * @requisition: location to store computed requisition.
627 * Retrieve the "child requisition" of the widget, taking account grouping
628 * of the widget's requisition with other widgets.
631 _gtk_size_group_get_child_requisition (GtkWidget *widget,
632 GtkRequisition *requisition)
636 if (get_size_groups (widget))
638 requisition->width = get_dimension (widget, GTK_SIZE_GROUP_HORIZONTAL);
639 requisition->height = get_dimension (widget, GTK_SIZE_GROUP_VERTICAL);
641 /* Only do the full computation if we actually have size groups */
644 get_fast_child_requisition (widget, requisition);
649 * _gtk_size_group_compute_requisition:
650 * @widget: a #GtkWidget
651 * @requisition: location to store computed requisition.
653 * Compute the requisition of a widget taking into account grouping of
654 * the widget's requisition with other widgets.
657 _gtk_size_group_compute_requisition (GtkWidget *widget,
658 GtkRequisition *requisition)
663 if (get_size_groups (widget))
665 /* Only do the full computation if we actually have size groups */
667 width = compute_dimension (widget, GTK_SIZE_GROUP_HORIZONTAL);
668 height = compute_dimension (widget, GTK_SIZE_GROUP_VERTICAL);
672 requisition->width = width;
673 requisition->height = height;
678 do_size_request (widget);
681 get_fast_child_requisition (widget, requisition);
686 * _gtk_size_group_queue_resize:
687 * @widget: a #GtkWidget
689 * Queue a resize on a widget, and on all other widgets grouped with this widget.
692 _gtk_size_group_queue_resize (GtkWidget *widget)
694 queue_resize_on_widget (widget, TRUE);