* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include "config.h"
#include <string.h>
+
+#include "gtkbuildable.h"
#include "gtkcontainer.h"
#include "gtkintl.h"
+#include "gtktypebuiltins.h"
#include "gtkprivate.h"
-#include "gtksizegroup.h"
-#include "gtkbuildable.h"
-#include "gtksizerequest.h"
+#include "gtksizegroup-private.h"
+#include "gtkwidgetprivate.h"
+#include "gtkcontainerprivate.h"
+/**
+ * SECTION:gtksizegroup
+ * @Short_description: Grouping widgets so they request the same size
+ * @Title: GtkSizeGroup
+ *
+ * #GtkSizeGroup provides a mechanism for grouping a number of widgets
+ * together so they all request the same amount of space. This is
+ * typically useful when you want a column of widgets to have the same
+ * size, but you can't use a #GtkGrid widget.
+ *
+ * In detail, the size requested for each widget in a #GtkSizeGroup is
+ * the maximum of the sizes that would have been requested for each
+ * widget in the size group if they were not in the size group. The mode
+ * of the size group (see gtk_size_group_set_mode()) determines whether
+ * this applies to the horizontal size, the vertical size, or both sizes.
+ *
+ * Note that size groups only affect the amount of space requested, not
+ * the size that the widgets finally receive. If you want the widgets in
+ * a #GtkSizeGroup to actually be the same size, you need to pack them in
+ * such a way that they get the size they request and not more. For
+ * example, if you are packing your widgets into a table, you would not
+ * include the %GTK_FILL flag.
+ *
+ * #GtkSizeGroup objects are referenced by each widget in the size group,
+ * so once you have added all widgets to a #GtkSizeGroup, you can drop
+ * the initial reference to the size group with g_object_unref(). If the
+ * widgets in the size group are subsequently destroyed, then they will
+ * be removed from the size group and drop their references on the size
+ * group; when all widgets have been removed, the size group will be
+ * freed.
+ *
+ * Widgets can be part of multiple size groups; GTK+ will compute the
+ * horizontal size of a widget from the horizontal requisition of all
+ * widgets that can be reached from the widget by a chain of size groups
+ * of type %GTK_SIZE_GROUP_HORIZONTAL or %GTK_SIZE_GROUP_BOTH, and the
+ * vertical size from the vertical requisition of all widgets that can be
+ * reached from the widget by a chain of size groups of type
+ * %GTK_SIZE_GROUP_VERTICAL or %GTK_SIZE_GROUP_BOTH.
+ *
+ * Note that only non-contextual sizes of every widget are ever consulted
+ * by size groups (since size groups have no knowledge of what size a widget
+ * will be allocated in one dimension, it cannot derive how much height
+ * a widget will receive for a given width). When grouping widgets that
+ * trade height for width in mode %GTK_SIZE_GROUP_VERTICAL or %GTK_SIZE_GROUP_BOTH:
+ * the height for the minimum width will be the requested height for all
+ * widgets in the group. The same is of course true when horizontally grouping
+ * width for height widgets.
+ *
+ * Widgets that trade height-for-width should set a reasonably large minimum width
+ * by way of #GtkLabel:width-chars for instance. Widgets with static sizes as well
+ * as widgets that grow (such as ellipsizing text) need no such considerations.
+ *
+ * <refsect2 id="GtkSizeGroup-BUILDER-UI">
+ * <title>GtkSizeGroup as GtkBuildable</title>
+ * <para>
+ * Size groups can be specified in a UI definition by placing an
+ * <object> element with <literal>class="GtkSizeGroup"</literal>
+ * somewhere in the UI definition. The widgets that belong to the
+ * size group are specified by a <widgets> element that may
+ * contain multiple <widget> elements, one for each member
+ * of the size group. The name attribute gives the id of the widget.
+ *
+ * <example>
+ * <title>A UI definition fragment with GtkSizeGroup</title>
+ * <programlisting><![CDATA[
+ * <object class="GtkSizeGroup">
+ * <property name="mode">GTK_SIZE_GROUP_HORIZONTAL</property>
+ * <widgets>
+ * <widget name="radio1"/>
+ * <widget name="radio2"/>
+ * </widgets>
+ * </object>
+ * ]]></programlisting>
+ * </example>
+ * </para>
+ * </refsect2>
+ */
+
struct _GtkSizeGroupPrivate
{
- GtkRequisition requisition;
+ GtkRequisition minimum_req;
+ GtkRequisition natural_req;
GSList *widgets;
guint have_width : 1;
guint have_height : 1;
guint ignore_hidden : 1;
+ guint visited : 1;
};
enum {
const gchar *tagname,
gpointer user_data);
-static GQuark size_groups_quark;
-static const gchar size_groups_tag[] = "gtk-size-groups";
-
-static GQuark visited_quark;
-static const gchar visited_tag[] = "gtk-size-group-visited";
-
-static GQuark bumping_quark;
-static const gchar bumping_tag[] = "gtk-size-group-bumping";
-
-static GSList *
-get_size_groups (GtkWidget *widget)
-{
- return g_object_get_qdata (G_OBJECT (widget), size_groups_quark);
-}
-
-static void
-set_size_groups (GtkWidget *widget,
- GSList *groups)
-{
- g_object_set_qdata (G_OBJECT (widget), size_groups_quark, groups);
-}
-
static void
-mark_visited (gpointer object)
+mark_group_unvisited (GtkSizeGroup *group)
{
- g_object_set_qdata (object, visited_quark, "visited");
+ group->priv->visited = FALSE;
}
static void
-mark_unvisited (gpointer object)
+mark_widget_unvisited (GtkWidget *widget)
{
- g_object_set_qdata (object, visited_quark, NULL);
-}
-
-static gboolean
-is_visited (gpointer object)
-{
- return g_object_get_qdata (object, visited_quark) != NULL;
-}
-
-static void
-mark_bumping (gpointer object, gboolean bumping)
-{
- g_object_set_qdata (object, bumping_quark, bumping ? "bumping" : NULL);
-}
-
-static gboolean
-is_bumping (gpointer object)
-{
- return g_object_get_qdata (object, bumping_quark) != NULL;
+ _gtk_widget_set_sizegroup_visited (widget, FALSE);
}
static void
GSList *tmp_widgets;
*groups = g_slist_prepend (*groups, group);
- mark_visited (group);
+ priv->visited = TRUE;
tmp_widgets = priv->widgets;
while (tmp_widgets)
{
GtkWidget *tmp_widget = tmp_widgets->data;
- if (!is_visited (tmp_widget))
+ if (!_gtk_widget_get_sizegroup_visited (tmp_widget))
add_widget_to_closure (tmp_widget, mode, groups, widgets);
tmp_widgets = tmp_widgets->next;
GSList *tmp_groups;
*widgets = g_slist_prepend (*widgets, widget);
- mark_visited (widget);
+ _gtk_widget_set_sizegroup_visited (widget, TRUE);
- tmp_groups = get_size_groups (widget);
+ tmp_groups = _gtk_widget_get_sizegroups (widget);
while (tmp_groups)
{
- GtkSizeGroup *tmp_group = tmp_groups->data;
- GtkSizeGroupPrivate *tmp_priv = tmp_group->priv;
+ GtkSizeGroup *tmp_group = tmp_groups->data;
+ GtkSizeGroupPrivate *tmp_priv = tmp_group->priv;
if ((tmp_priv->mode == GTK_SIZE_GROUP_BOTH || tmp_priv->mode == mode) &&
- !is_visited (tmp_group))
+ !tmp_group->priv->visited)
add_group_to_closure (tmp_group, mode, groups, widgets);
tmp_groups = tmp_groups->next;
}
static void
-real_queue_resize (GtkWidget *widget)
+real_queue_resize (GtkWidget *widget,
+ GtkQueueResizeFlags flags)
{
- GtkWidget *parent;
+ GtkWidget *container;
+
+ _gtk_widget_set_alloc_needed (widget, TRUE);
+ _gtk_widget_set_width_request_needed (widget, TRUE);
+ _gtk_widget_set_height_request_needed (widget, TRUE);
- GTK_PRIVATE_SET_FLAG (widget, GTK_ALLOC_NEEDED);
- GTK_PRIVATE_SET_FLAG (widget, GTK_WIDTH_REQUEST_NEEDED);
- GTK_PRIVATE_SET_FLAG (widget, GTK_HEIGHT_REQUEST_NEEDED);
+ container = gtk_widget_get_parent (widget);
+ if (!container &&
+ gtk_widget_is_toplevel (widget) && GTK_IS_CONTAINER (widget))
+ container = widget;
- parent = gtk_widget_get_parent (widget);
- if (parent)
- _gtk_container_queue_resize (GTK_CONTAINER (parent));
- else if (gtk_widget_is_toplevel (widget) && GTK_IS_CONTAINER (widget))
- _gtk_container_queue_resize (GTK_CONTAINER (widget));
+ if (container)
+ {
+ if (flags & GTK_QUEUE_RESIZE_INVALIDATE_ONLY)
+ _gtk_container_resize_invalidate (GTK_CONTAINER (container));
+ else
+ _gtk_container_queue_resize (GTK_CONTAINER (container));
+ }
}
static void
}
static void
-queue_resize_on_widget (GtkWidget *widget,
- gboolean check_siblings)
+queue_resize_on_widget (GtkWidget *widget,
+ gboolean check_siblings,
+ GtkQueueResizeFlags flags)
{
GtkWidget *parent = widget;
GSList *tmp_list;
if (widget == parent && !check_siblings)
{
- real_queue_resize (widget);
+ real_queue_resize (widget, flags);
parent = gtk_widget_get_parent (parent);
continue;
}
- widget_groups = get_size_groups (parent);
+ widget_groups = _gtk_widget_get_sizegroups (parent);
if (!widget_groups)
{
if (widget == parent)
- real_queue_resize (widget);
+ real_queue_resize (widget, flags);
parent = gtk_widget_get_parent (parent);
continue;
widgets = NULL;
add_widget_to_closure (parent, GTK_SIZE_GROUP_HORIZONTAL, &groups, &widgets);
- g_slist_foreach (widgets, (GFunc)mark_unvisited, NULL);
- g_slist_foreach (groups, (GFunc)mark_unvisited, NULL);
+ g_slist_foreach (widgets, (GFunc)mark_widget_unvisited, NULL);
+ g_slist_foreach (groups, (GFunc)mark_group_unvisited, NULL);
reset_group_sizes (groups);
if (tmp_list->data == parent)
{
if (widget == parent)
- real_queue_resize (parent);
+ real_queue_resize (parent, flags);
}
else if (tmp_list->data == widget)
{
g_warning ("A container and its child are part of this SizeGroup");
}
else
- queue_resize_on_widget (tmp_list->data, FALSE);
+ queue_resize_on_widget (tmp_list->data, FALSE, flags);
tmp_list = tmp_list->next;
}
widgets = NULL;
add_widget_to_closure (parent, GTK_SIZE_GROUP_VERTICAL, &groups, &widgets);
- g_slist_foreach (widgets, (GFunc)mark_unvisited, NULL);
- g_slist_foreach (groups, (GFunc)mark_unvisited, NULL);
+ g_slist_foreach (widgets, (GFunc)mark_widget_unvisited, NULL);
+ g_slist_foreach (groups, (GFunc)mark_group_unvisited, NULL);
reset_group_sizes (groups);
if (tmp_list->data == parent)
{
if (widget == parent)
- real_queue_resize (parent);
+ real_queue_resize (parent, flags);
}
else if (tmp_list->data == widget)
{
g_warning ("A container and its child are part of this SizeGroup");
}
else
- queue_resize_on_widget (tmp_list->data, FALSE);
+ queue_resize_on_widget (tmp_list->data, FALSE, flags);
tmp_list = tmp_list->next;
}
}
static void
-queue_resize_on_group (GtkSizeGroup *size_group)
+queue_resize_on_group (GtkSizeGroup *size_group)
{
GtkSizeGroupPrivate *priv = size_group->priv;
if (priv->widgets)
- queue_resize_on_widget (priv->widgets->data, TRUE);
-}
-
-static void
-initialize_size_group_quarks (void)
-{
- if (!size_groups_quark)
- {
- size_groups_quark = g_quark_from_static_string (size_groups_tag);
- visited_quark = g_quark_from_static_string (visited_tag);
- bumping_quark = g_quark_from_static_string (bumping_tag);
- }
+ queue_resize_on_widget (priv->widgets->data, TRUE, 0);
}
static void
GTK_PARAM_READWRITE));
g_type_class_add_private (klass, sizeof (GtkSizeGroupPrivate));
-
- initialize_size_group_quarks ();
}
static void
priv->have_width = 0;
priv->have_height = 0;
priv->ignore_hidden = 0;
+ priv->visited = FALSE;
}
static void
*
* Sets the #GtkSizeGroupMode of the size group. The mode of the size
* group determines whether the widgets in the size group should
- * all have the same horizontal requisition (%GTK_SIZE_GROUP_MODE_HORIZONTAL)
- * all have the same vertical requisition (%GTK_SIZE_GROUP_MODE_VERTICAL),
+ * all have the same horizontal requisition (%GTK_SIZE_GROUP_HORIZONTAL)
+ * all have the same vertical requisition (%GTK_SIZE_GROUP_VERTICAL),
* or should all have the same requisition in both directions
- * (%GTK_SIZE_GROUP_MODE_BOTH).
+ * (%GTK_SIZE_GROUP_BOTH).
**/
void
gtk_size_group_set_mode (GtkSizeGroup *size_group,
priv = size_group->priv;
- groups = get_size_groups (widget);
+ groups = _gtk_widget_get_sizegroups (widget);
if (!g_slist_find (groups, size_group))
{
- groups = g_slist_prepend (groups, size_group);
- set_size_groups (widget, groups);
+ _gtk_widget_add_sizegroup (widget, size_group);
priv->widgets = g_slist_prepend (priv->widgets, widget);
GtkWidget *widget)
{
GtkSizeGroupPrivate *priv;
- GSList *groups;
g_return_if_fail (GTK_IS_SIZE_GROUP (size_group));
g_return_if_fail (GTK_IS_WIDGET (widget));
gtk_size_group_widget_destroyed,
size_group);
- groups = get_size_groups (widget);
- groups = g_slist_remove (groups, size_group);
- set_size_groups (widget, groups);
+ _gtk_widget_remove_sizegroup (widget, size_group);
priv->widgets = g_slist_remove (priv->widgets, widget);
queue_resize_on_group (size_group);
return size_group->priv->widgets;
}
-static gint
-get_base_dimension (GtkWidget *widget,
- GtkSizeGroupMode mode)
-{
- if (mode == GTK_SIZE_GROUP_HORIZONTAL)
- {
- /* XXX Possibly we should be using natural values and not minimums here. */
- gint width;
-
- gtk_size_request_get_width (GTK_SIZE_REQUEST (widget), &width, NULL);
-
- return width;
- }
- else
- {
- /* XXX Possibly we should be using natural values and not minimums here. */
- gint height;
-
- gtk_size_request_get_height (GTK_SIZE_REQUEST (widget), &height, NULL);
-
- return height;
- }
-}
-
-static gint
+static void
compute_dimension (GtkWidget *widget,
GtkSizeGroupMode mode,
- gint widget_requisition)
+ gint *minimum, /* in-out */
+ gint *natural) /* in-out */
{
GSList *widgets = NULL;
GSList *groups = NULL;
GSList *tmp_list;
- gint result = 0;
+ gint min_result = 0, nat_result = 0;
add_widget_to_closure (widget, mode, &groups, &widgets);
+ g_slist_foreach (widgets, (GFunc)mark_widget_unvisited, NULL);
+ g_slist_foreach (groups, (GFunc)mark_group_unvisited, NULL);
- g_slist_foreach (widgets, (GFunc)mark_unvisited, NULL);
- g_slist_foreach (groups, (GFunc)mark_unvisited, NULL);
-
g_slist_foreach (widgets, (GFunc)g_object_ref, NULL);
if (!groups)
{
- result = widget_requisition;
+ min_result = *minimum;
+ nat_result = *natural;
}
else
{
GtkSizeGroupPrivate *priv = group->priv;
if (mode == GTK_SIZE_GROUP_HORIZONTAL && priv->have_width)
- result = priv->requisition.width;
+ {
+ min_result = priv->minimum_req.width;
+ nat_result = priv->natural_req.width;
+ }
else if (mode == GTK_SIZE_GROUP_VERTICAL && priv->have_height)
- result = priv->requisition.height;
+ {
+ min_result = priv->minimum_req.height;
+ nat_result = priv->natural_req.height;
+ }
else
{
tmp_list = widgets;
while (tmp_list)
{
GtkWidget *tmp_widget = tmp_list->data;
- gint dimension;
+ gint min_dimension, nat_dimension;
if (tmp_widget == widget)
- dimension = widget_requisition;
+ {
+ min_dimension = *minimum;
+ nat_dimension = *natural;
+ }
else
- dimension = get_base_dimension (tmp_widget, mode);
+ {
+ if (mode == GTK_SIZE_GROUP_HORIZONTAL)
+ gtk_widget_get_preferred_width (tmp_widget, &min_dimension, &nat_dimension);
+ else
+ gtk_widget_get_preferred_height (tmp_widget, &min_dimension, &nat_dimension);
+ }
if (gtk_widget_get_mapped (tmp_widget) || !priv->ignore_hidden)
{
- if (dimension > result)
- result = dimension;
+ min_result = MAX (min_result, min_dimension);
+ nat_result = MAX (nat_result, nat_dimension);
}
tmp_list = tmp_list->next;
if (mode == GTK_SIZE_GROUP_HORIZONTAL)
{
tmp_priv->have_width = TRUE;
- tmp_priv->requisition.width = result;
+ tmp_priv->minimum_req.width = min_result;
+ tmp_priv->natural_req.width = nat_result;
}
else
{
tmp_priv->have_height = TRUE;
- tmp_priv->requisition.height = result;
+ tmp_priv->minimum_req.height = min_result;
+ tmp_priv->natural_req.height = nat_result;
}
tmp_list = tmp_list->next;
g_slist_free (widgets);
g_slist_free (groups);
- return result;
+ *minimum = min_result;
+ *natural = nat_result;
}
/**
* @widget: a #GtkWidget
* @mode: either %GTK_SIZE_GROUP_HORIZONTAL or %GTK_SIZE_GROUP_VERTICAL, depending
* on the dimension in which to bump the size.
+ * @minimum: a pointer to the widget's minimum size
+ * @natural: a pointer to the widget's natural size
*
* Refreshes the sizegroup while returning the groups requested
* value in the dimension @mode.
*
- * This function is used to update sizegroup minimum size information
- * in multiple passes from the new #GtkSizeRequest manager.
+ * This function is used both to update sizegroup minimum and natural size
+ * information and widget minimum and natural sizes in multiple passes from
+ * the size request apis.
*/
-gint
+void
_gtk_size_group_bump_requisition (GtkWidget *widget,
GtkSizeGroupMode mode,
- gint widget_requisition)
+ gint *minimum,
+ gint *natural)
{
- gint result = widget_requisition;
-
- if (!is_bumping (widget))
+ if (!_gtk_widget_get_sizegroup_bumping (widget))
{
/* Avoid recursion here */
- mark_bumping (widget, TRUE);
+ _gtk_widget_set_sizegroup_bumping (widget, TRUE);
- if (get_size_groups (widget))
- {
- result = compute_dimension (widget, mode, widget_requisition);
- }
+ if (_gtk_widget_get_sizegroups (widget))
+ compute_dimension (widget, mode, minimum, natural);
- mark_bumping (widget, FALSE);
+ _gtk_widget_set_sizegroup_bumping (widget, FALSE);
}
- return result;
}
* Queue a resize on a widget, and on all other widgets grouped with this widget.
**/
void
-_gtk_size_group_queue_resize (GtkWidget *widget)
+_gtk_size_group_queue_resize (GtkWidget *widget,
+ GtkQueueResizeFlags flags)
{
- initialize_size_group_quarks ();
-
- queue_resize_on_widget (widget, TRUE);
+ queue_resize_on_widget (widget, TRUE, flags);
}
typedef struct {
projects / ~andy / gtk / blobdiff