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.
23 #include "gtkcontainer.h"
25 #include "gtkprivate.h"
26 #include "gtksizegroup.h"
27 #include "gtkbuildable.h"
28 #include "gtksizerequest.h"
32 struct _GtkSizeGroupPrivate
34 GtkRequisition requisition;
41 guint have_height : 1;
42 guint ignore_hidden : 1;
51 static void gtk_size_group_set_property (GObject *object,
55 static void gtk_size_group_get_property (GObject *object,
60 static void add_group_to_closure (GtkSizeGroup *group,
61 GtkSizeGroupMode mode,
64 static void add_widget_to_closure (GtkWidget *widget,
65 GtkSizeGroupMode mode,
70 static void gtk_size_group_buildable_init (GtkBuildableIface *iface);
71 static gboolean gtk_size_group_buildable_custom_tag_start (GtkBuildable *buildable,
75 GMarkupParser *parser,
77 static void gtk_size_group_buildable_custom_finished (GtkBuildable *buildable,
83 static GQuark size_groups_quark;
84 static const gchar size_groups_tag[] = "gtk-size-groups";
86 static GQuark visited_quark;
87 static const gchar visited_tag[] = "gtk-size-group-visited";
89 static GQuark bumping_quark;
90 static const gchar bumping_tag[] = "gtk-size-group-bumping";
93 get_size_groups (GtkWidget *widget)
95 return g_object_get_qdata (G_OBJECT (widget), size_groups_quark);
99 set_size_groups (GtkWidget *widget,
102 g_object_set_qdata (G_OBJECT (widget), size_groups_quark, groups);
106 mark_visited (gpointer object)
108 g_object_set_qdata (object, visited_quark, "visited");
112 mark_unvisited (gpointer object)
114 g_object_set_qdata (object, visited_quark, NULL);
118 is_visited (gpointer object)
120 return g_object_get_qdata (object, visited_quark) != NULL;
124 mark_bumping (gpointer object, gboolean bumping)
126 g_object_set_qdata (object, bumping_quark, bumping ? "bumping" : NULL);
130 is_bumping (gpointer object)
132 return g_object_get_qdata (object, bumping_quark) != NULL;
136 add_group_to_closure (GtkSizeGroup *group,
137 GtkSizeGroupMode mode,
141 GtkSizeGroupPrivate *priv = group->priv;
144 *groups = g_slist_prepend (*groups, group);
145 mark_visited (group);
147 tmp_widgets = priv->widgets;
150 GtkWidget *tmp_widget = tmp_widgets->data;
152 if (!is_visited (tmp_widget))
153 add_widget_to_closure (tmp_widget, mode, groups, widgets);
155 tmp_widgets = tmp_widgets->next;
160 add_widget_to_closure (GtkWidget *widget,
161 GtkSizeGroupMode mode,
167 *widgets = g_slist_prepend (*widgets, widget);
168 mark_visited (widget);
170 tmp_groups = get_size_groups (widget);
173 GtkSizeGroup *tmp_group = tmp_groups->data;
174 GtkSizeGroupPrivate *tmp_priv = tmp_group->priv;
176 if ((tmp_priv->mode == GTK_SIZE_GROUP_BOTH || tmp_priv->mode == mode) &&
177 !is_visited (tmp_group))
178 add_group_to_closure (tmp_group, mode, groups, widgets);
180 tmp_groups = tmp_groups->next;
185 real_queue_resize (GtkWidget *widget)
189 GTK_PRIVATE_SET_FLAG (widget, GTK_ALLOC_NEEDED);
190 GTK_PRIVATE_SET_FLAG (widget, GTK_WIDTH_REQUEST_NEEDED);
191 GTK_PRIVATE_SET_FLAG (widget, GTK_HEIGHT_REQUEST_NEEDED);
193 parent = gtk_widget_get_parent (widget);
195 _gtk_container_queue_resize (GTK_CONTAINER (parent));
196 else if (gtk_widget_is_toplevel (widget) && GTK_IS_CONTAINER (widget))
197 _gtk_container_queue_resize (GTK_CONTAINER (widget));
201 reset_group_sizes (GSList *groups)
203 GSList *tmp_list = groups;
206 GtkSizeGroup *tmp_group = tmp_list->data;
207 GtkSizeGroupPrivate *tmp_priv = tmp_group->priv;
209 tmp_priv->have_width = FALSE;
210 tmp_priv->have_height = FALSE;
212 tmp_list = tmp_list->next;
217 queue_resize_on_widget (GtkWidget *widget,
218 gboolean check_siblings)
220 GtkWidget *parent = widget;
225 GSList *widget_groups;
229 if (widget == parent && !check_siblings)
231 real_queue_resize (widget);
232 parent = gtk_widget_get_parent (parent);
236 widget_groups = get_size_groups (parent);
239 if (widget == parent)
240 real_queue_resize (widget);
242 parent = gtk_widget_get_parent (parent);
249 add_widget_to_closure (parent, GTK_SIZE_GROUP_HORIZONTAL, &groups, &widgets);
250 g_slist_foreach (widgets, (GFunc)mark_unvisited, NULL);
251 g_slist_foreach (groups, (GFunc)mark_unvisited, NULL);
253 reset_group_sizes (groups);
258 if (tmp_list->data == parent)
260 if (widget == parent)
261 real_queue_resize (parent);
263 else if (tmp_list->data == widget)
265 g_warning ("A container and its child are part of this SizeGroup");
268 queue_resize_on_widget (tmp_list->data, FALSE);
270 tmp_list = tmp_list->next;
273 g_slist_free (widgets);
274 g_slist_free (groups);
279 add_widget_to_closure (parent, GTK_SIZE_GROUP_VERTICAL, &groups, &widgets);
280 g_slist_foreach (widgets, (GFunc)mark_unvisited, NULL);
281 g_slist_foreach (groups, (GFunc)mark_unvisited, NULL);
283 reset_group_sizes (groups);
288 if (tmp_list->data == parent)
290 if (widget == parent)
291 real_queue_resize (parent);
293 else if (tmp_list->data == widget)
295 g_warning ("A container and its child are part of this SizeGroup");
298 queue_resize_on_widget (tmp_list->data, FALSE);
300 tmp_list = tmp_list->next;
303 g_slist_free (widgets);
304 g_slist_free (groups);
306 parent = gtk_widget_get_parent (parent);
311 queue_resize_on_group (GtkSizeGroup *size_group)
313 GtkSizeGroupPrivate *priv = size_group->priv;
316 queue_resize_on_widget (priv->widgets->data, TRUE);
320 initialize_size_group_quarks (void)
322 if (!size_groups_quark)
324 size_groups_quark = g_quark_from_static_string (size_groups_tag);
325 visited_quark = g_quark_from_static_string (visited_tag);
326 bumping_quark = g_quark_from_static_string (bumping_tag);
331 gtk_size_group_class_init (GtkSizeGroupClass *klass)
333 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
335 gobject_class->set_property = gtk_size_group_set_property;
336 gobject_class->get_property = gtk_size_group_get_property;
338 g_object_class_install_property (gobject_class,
340 g_param_spec_enum ("mode",
342 P_("The directions in which the size group affects the requested sizes"
343 " of its component widgets"),
344 GTK_TYPE_SIZE_GROUP_MODE,
345 GTK_SIZE_GROUP_HORIZONTAL, GTK_PARAM_READWRITE));
348 * GtkSizeGroup:ignore-hidden:
350 * If %TRUE, unmapped widgets are ignored when determining
351 * the size of the group.
355 g_object_class_install_property (gobject_class,
357 g_param_spec_boolean ("ignore-hidden",
359 P_("If TRUE, unmapped widgets are ignored "
360 "when determining the size of the group"),
362 GTK_PARAM_READWRITE));
364 g_type_class_add_private (klass, sizeof (GtkSizeGroupPrivate));
366 initialize_size_group_quarks ();
370 gtk_size_group_init (GtkSizeGroup *size_group)
372 GtkSizeGroupPrivate *priv;
374 size_group->priv = G_TYPE_INSTANCE_GET_PRIVATE (size_group,
376 GtkSizeGroupPrivate);
377 priv = size_group->priv;
379 priv->widgets = NULL;
380 priv->mode = GTK_SIZE_GROUP_HORIZONTAL;
381 priv->have_width = 0;
382 priv->have_height = 0;
383 priv->ignore_hidden = 0;
387 gtk_size_group_buildable_init (GtkBuildableIface *iface)
389 iface->custom_tag_start = gtk_size_group_buildable_custom_tag_start;
390 iface->custom_finished = gtk_size_group_buildable_custom_finished;
393 G_DEFINE_TYPE_WITH_CODE (GtkSizeGroup, gtk_size_group, G_TYPE_OBJECT,
394 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
395 gtk_size_group_buildable_init))
398 gtk_size_group_set_property (GObject *object,
403 GtkSizeGroup *size_group = GTK_SIZE_GROUP (object);
408 gtk_size_group_set_mode (size_group, g_value_get_enum (value));
410 case PROP_IGNORE_HIDDEN:
411 gtk_size_group_set_ignore_hidden (size_group, g_value_get_boolean (value));
414 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
420 gtk_size_group_get_property (GObject *object,
425 GtkSizeGroup *size_group = GTK_SIZE_GROUP (object);
426 GtkSizeGroupPrivate *priv = size_group->priv;
431 g_value_set_enum (value, priv->mode);
433 case PROP_IGNORE_HIDDEN:
434 g_value_set_boolean (value, priv->ignore_hidden);
437 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
443 * gtk_size_group_new:
444 * @mode: the mode for the new size group.
446 * Create a new #GtkSizeGroup.
448 * Return value: a newly created #GtkSizeGroup
451 gtk_size_group_new (GtkSizeGroupMode mode)
453 GtkSizeGroup *size_group = g_object_new (GTK_TYPE_SIZE_GROUP, NULL);
454 GtkSizeGroupPrivate *priv = size_group->priv;
462 * gtk_size_group_set_mode:
463 * @size_group: a #GtkSizeGroup
464 * @mode: the mode to set for the size group.
466 * Sets the #GtkSizeGroupMode of the size group. The mode of the size
467 * group determines whether the widgets in the size group should
468 * all have the same horizontal requisition (%GTK_SIZE_GROUP_MODE_HORIZONTAL)
469 * all have the same vertical requisition (%GTK_SIZE_GROUP_MODE_VERTICAL),
470 * or should all have the same requisition in both directions
471 * (%GTK_SIZE_GROUP_MODE_BOTH).
474 gtk_size_group_set_mode (GtkSizeGroup *size_group,
475 GtkSizeGroupMode mode)
477 GtkSizeGroupPrivate *priv;
479 g_return_if_fail (GTK_IS_SIZE_GROUP (size_group));
481 priv = size_group->priv;
483 if (priv->mode != mode)
485 if (priv->mode != GTK_SIZE_GROUP_NONE)
486 queue_resize_on_group (size_group);
488 if (priv->mode != GTK_SIZE_GROUP_NONE)
489 queue_resize_on_group (size_group);
491 g_object_notify (G_OBJECT (size_group), "mode");
496 * gtk_size_group_get_mode:
497 * @size_group: a #GtkSizeGroup
499 * Gets the current mode of the size group. See gtk_size_group_set_mode().
501 * Return value: the current mode of the size group.
504 gtk_size_group_get_mode (GtkSizeGroup *size_group)
506 g_return_val_if_fail (GTK_IS_SIZE_GROUP (size_group), GTK_SIZE_GROUP_BOTH);
508 return size_group->priv->mode;
512 * gtk_size_group_set_ignore_hidden:
513 * @size_group: a #GtkSizeGroup
514 * @ignore_hidden: whether unmapped widgets should be ignored
515 * when calculating the size
517 * Sets whether unmapped widgets should be ignored when
518 * calculating the size.
523 gtk_size_group_set_ignore_hidden (GtkSizeGroup *size_group,
524 gboolean ignore_hidden)
526 GtkSizeGroupPrivate *priv;
528 g_return_if_fail (GTK_IS_SIZE_GROUP (size_group));
530 priv = size_group->priv;
532 ignore_hidden = ignore_hidden != FALSE;
534 if (priv->ignore_hidden != ignore_hidden)
536 priv->ignore_hidden = ignore_hidden;
538 g_object_notify (G_OBJECT (size_group), "ignore-hidden");
543 * gtk_size_group_get_ignore_hidden:
544 * @size_group: a #GtkSizeGroup
546 * Returns if invisible widgets are ignored when calculating the size.
548 * Returns: %TRUE if invisible widgets are ignored.
553 gtk_size_group_get_ignore_hidden (GtkSizeGroup *size_group)
555 g_return_val_if_fail (GTK_IS_SIZE_GROUP (size_group), FALSE);
557 return size_group->priv->ignore_hidden;
561 gtk_size_group_widget_destroyed (GtkWidget *widget,
562 GtkSizeGroup *size_group)
564 gtk_size_group_remove_widget (size_group, widget);
568 * gtk_size_group_add_widget:
569 * @size_group: a #GtkSizeGroup
570 * @widget: the #GtkWidget to add
572 * Adds a widget to a #GtkSizeGroup. In the future, the requisition
573 * of the widget will be determined as the maximum of its requisition
574 * and the requisition of the other widgets in the size group.
575 * Whether this applies horizontally, vertically, or in both directions
576 * depends on the mode of the size group. See gtk_size_group_set_mode().
578 * When the widget is destroyed or no longer referenced elsewhere, it will
579 * be removed from the size group.
582 gtk_size_group_add_widget (GtkSizeGroup *size_group,
585 GtkSizeGroupPrivate *priv;
588 g_return_if_fail (GTK_IS_SIZE_GROUP (size_group));
589 g_return_if_fail (GTK_IS_WIDGET (widget));
591 priv = size_group->priv;
593 groups = get_size_groups (widget);
595 if (!g_slist_find (groups, size_group))
597 groups = g_slist_prepend (groups, size_group);
598 set_size_groups (widget, groups);
600 priv->widgets = g_slist_prepend (priv->widgets, widget);
602 g_signal_connect (widget, "destroy",
603 G_CALLBACK (gtk_size_group_widget_destroyed),
606 g_object_ref (size_group);
609 queue_resize_on_group (size_group);
613 * gtk_size_group_remove_widget:
614 * @size_group: a #GtkSizeGroup
615 * @widget: the #GtkWidget to remove
617 * Removes a widget from a #GtkSizeGroup.
620 gtk_size_group_remove_widget (GtkSizeGroup *size_group,
623 GtkSizeGroupPrivate *priv;
626 g_return_if_fail (GTK_IS_SIZE_GROUP (size_group));
627 g_return_if_fail (GTK_IS_WIDGET (widget));
629 priv = size_group->priv;
631 g_return_if_fail (g_slist_find (priv->widgets, widget));
633 g_signal_handlers_disconnect_by_func (widget,
634 gtk_size_group_widget_destroyed,
637 groups = get_size_groups (widget);
638 groups = g_slist_remove (groups, size_group);
639 set_size_groups (widget, groups);
641 priv->widgets = g_slist_remove (priv->widgets, widget);
642 queue_resize_on_group (size_group);
643 gtk_widget_queue_resize (widget);
645 g_object_unref (size_group);
649 * gtk_size_group_get_widgets:
650 * @size_group: a #GtkSizeGroup
652 * Returns the list of widgets associated with @size_group.
654 * Return value: (element-type GtkWidget) (transfer none): a #GSList of
655 * widgets. The list is owned by GTK+ and should not be modified.
660 gtk_size_group_get_widgets (GtkSizeGroup *size_group)
662 return size_group->priv->widgets;
666 get_base_dimension (GtkWidget *widget,
667 GtkSizeGroupMode mode)
669 if (mode == GTK_SIZE_GROUP_HORIZONTAL)
671 /* XXX Possibly we should be using natural values and not minimums here. */
674 gtk_size_request_get_width (GTK_SIZE_REQUEST (widget), &width, NULL);
680 /* XXX Possibly we should be using natural values and not minimums here. */
683 gtk_size_request_get_height (GTK_SIZE_REQUEST (widget), &height, NULL);
690 compute_dimension (GtkWidget *widget,
691 GtkSizeGroupMode mode,
692 gint widget_requisition)
694 GSList *widgets = NULL;
695 GSList *groups = NULL;
699 add_widget_to_closure (widget, mode, &groups, &widgets);
701 g_slist_foreach (widgets, (GFunc)mark_unvisited, NULL);
702 g_slist_foreach (groups, (GFunc)mark_unvisited, NULL);
704 g_slist_foreach (widgets, (GFunc)g_object_ref, NULL);
708 result = widget_requisition;
712 GtkSizeGroup *group = groups->data;
713 GtkSizeGroupPrivate *priv = group->priv;
715 if (mode == GTK_SIZE_GROUP_HORIZONTAL && priv->have_width)
716 result = priv->requisition.width;
717 else if (mode == GTK_SIZE_GROUP_VERTICAL && priv->have_height)
718 result = priv->requisition.height;
724 GtkWidget *tmp_widget = tmp_list->data;
727 if (tmp_widget == widget)
728 dimension = widget_requisition;
730 dimension = get_base_dimension (tmp_widget, mode);
732 if (gtk_widget_get_mapped (tmp_widget) || !priv->ignore_hidden)
734 if (dimension > result)
738 tmp_list = tmp_list->next;
744 GtkSizeGroup *tmp_group = tmp_list->data;
745 GtkSizeGroupPrivate *tmp_priv = tmp_group->priv;
747 if (mode == GTK_SIZE_GROUP_HORIZONTAL)
749 tmp_priv->have_width = TRUE;
750 tmp_priv->requisition.width = result;
754 tmp_priv->have_height = TRUE;
755 tmp_priv->requisition.height = result;
758 tmp_list = tmp_list->next;
763 g_slist_foreach (widgets, (GFunc)g_object_unref, NULL);
765 g_slist_free (widgets);
766 g_slist_free (groups);
772 * _gtk_size_group_bump_requisition:
773 * @widget: a #GtkWidget
774 * @mode: either %GTK_SIZE_GROUP_HORIZONTAL or %GTK_SIZE_GROUP_VERTICAL, depending
775 * on the dimension in which to bump the size.
777 * Refreshes the sizegroup while returning the groups requested
778 * value in the dimension @mode.
780 * This function is used to update sizegroup minimum size information
781 * in multiple passes from the new #GtkSizeRequest manager.
784 _gtk_size_group_bump_requisition (GtkWidget *widget,
785 GtkSizeGroupMode mode,
786 gint widget_requisition)
788 gint result = widget_requisition;
790 if (!is_bumping (widget))
792 /* Avoid recursion here */
793 mark_bumping (widget, TRUE);
795 if (get_size_groups (widget))
797 result = compute_dimension (widget, mode, widget_requisition);
800 mark_bumping (widget, FALSE);
808 * _gtk_size_group_queue_resize:
809 * @widget: a #GtkWidget
811 * Queue a resize on a widget, and on all other widgets grouped with this widget.
814 _gtk_size_group_queue_resize (GtkWidget *widget)
816 initialize_size_group_quarks ();
818 queue_resize_on_widget (widget, TRUE);
824 } GSListSubParserData;
827 size_group_start_element (GMarkupParseContext *context,
828 const gchar *element_name,
830 const gchar **values,
835 GSListSubParserData *data = (GSListSubParserData*)user_data;
837 if (strcmp (element_name, "widget") == 0)
838 for (i = 0; names[i]; i++)
839 if (strcmp (names[i], "name") == 0)
840 data->items = g_slist_prepend (data->items, g_strdup (values[i]));
841 else if (strcmp (element_name, "widgets") == 0)
844 g_warning ("Unsupported type tag for GtkSizeGroup: %s\n",
849 static const GMarkupParser size_group_parser =
851 size_group_start_element
855 gtk_size_group_buildable_custom_tag_start (GtkBuildable *buildable,
858 const gchar *tagname,
859 GMarkupParser *parser,
862 GSListSubParserData *parser_data;
867 if (strcmp (tagname, "widgets") == 0)
869 parser_data = g_slice_new0 (GSListSubParserData);
870 parser_data->items = NULL;
871 parser_data->object = G_OBJECT (buildable);
873 *parser = size_group_parser;
882 gtk_size_group_buildable_custom_finished (GtkBuildable *buildable,
885 const gchar *tagname,
889 GSListSubParserData *data;
892 if (strcmp (tagname, "widgets"))
895 data = (GSListSubParserData*)user_data;
896 data->items = g_slist_reverse (data->items);
898 for (l = data->items; l; l = l->next)
900 object = gtk_builder_get_object (builder, l->data);
903 g_warning ("Unknown object %s specified in sizegroup %s",
904 (const gchar*)l->data,
905 gtk_buildable_get_name (GTK_BUILDABLE (data->object)));
908 gtk_size_group_add_widget (GTK_SIZE_GROUP (data->object),
909 GTK_WIDGET (object));
912 g_slist_free (data->items);
913 g_slice_free (GSListSubParserData, data);