* Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
*
* This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Library General Public
+ * modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Library General Public License for more details.
+ * Lesser General Public License for more details.
*
- * You should have received a copy of the GNU Library General Public
- * License along with this library; if not, write to the Free
- * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
+
+/*
+ * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
+ * file for a list of people on the GTK+ Team. See the ChangeLog
+ * files for a list of changes. These files are distributed with
+ * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
+ */
+
+/**
+ * SECTION:gtkbox
+ * @Short_description: A container box
+ * @Title: GtkBox
+ * @See_also: #GtkFrame, #GtkGrid, #GtkLayout
+ *
+ * The GtkBox widget organizes child widgets into a rectangular area.
+ *
+ * The rectangular area of a GtkBox is organized into either a single row
+ * or a single column of child widgets depending upon the orientation.
+ * Thus, all children of a GtkBox are allocated one dimension in common,
+ * which is the height of a row, or the width of a column.
+ *
+ * GtkBox uses a notion of <emphasis>packing</emphasis>. Packing refers
+ * to adding widgets with reference to a particular position in a
+ * #GtkContainer. For a GtkBox, there are two reference positions: the
+ * <emphasis>start</emphasis> and the <emphasis>end</emphasis> of the box.
+ * For a vertical #GtkBox, the start is defined as the top of the box and
+ * the end is defined as the bottom. For a horizontal #GtkBox the start
+ * is defined as the left side and the end is defined as the right side.
+ *
+ * Use repeated calls to gtk_box_pack_start() to pack widgets into a
+ * GtkBox from start to end. Use gtk_box_pack_end() to add widgets from
+ * end to start. You may intersperse these calls and add widgets from
+ * both ends of the same GtkBox.
+ *
+ * Because GtkBox is a #GtkContainer, you may also use gtk_container_add()
+ * to insert widgets into the box, and they will be packed with the default
+ * values for #GtkBox:expand and #GtkBox:fill. Use gtk_container_remove()
+ * to remove widgets from the GtkBox.
+ *
+ * Use gtk_box_set_homogeneous() to specify whether or not all children
+ * of the GtkBox are forced to get the same amount of space.
+ *
+ * Use gtk_box_set_spacing() to determine how much space will be
+ * minimally placed between all children in the GtkBox. Note that
+ * spacing is added <emphasis>between</emphasis> the children, while
+ * padding added by gtk_box_pack_start() or gtk_box_pack_end() is added
+ * <emphasis>on either side</emphasis> of the widget it belongs to.
+ *
+ * Use gtk_box_reorder_child() to move a GtkBox child to a different
+ * place in the box.
+ *
+ * Use gtk_box_set_child_packing() to reset the #GtkBox:expand,
+ * #GtkBox:fill and #GtkBox:padding child properties.
+ * Use gtk_box_query_child_packing() to query these fields.
+ *
+ * <note><para>
+ * Note that a single-row or single-column #GtkGrid provides exactly
+ * the same functionality as #GtkBox.
+ * </para></note>
+ */
+
+#include "config.h"
+
#include "gtkbox.h"
+#include "gtkboxprivate.h"
+#include "gtkintl.h"
+#include "gtkorientable.h"
+#include "gtkorientableprivate.h"
+#include "gtkprivate.h"
+#include "gtktypebuiltins.h"
+#include "gtksizerequest.h"
+#include "gtkwidgetpath.h"
+#include "gtkwidgetprivate.h"
+#include "a11y/gtkcontaineraccessible.h"
+
enum {
- ARG_0,
- ARG_SPACING,
- ARG_HOMOGENEOUS
+ PROP_0,
+ PROP_ORIENTATION,
+ PROP_SPACING,
+ PROP_HOMOGENEOUS
};
-static void gtk_box_class_init (GtkBoxClass *klass);
-static void gtk_box_init (GtkBox *box);
-static void gtk_box_get_arg (GtkBox *box,
- GtkArg *arg,
- guint arg_id);
-static void gtk_box_set_arg (GtkBox *box,
- GtkArg *arg,
- guint arg_id);
-static void gtk_box_destroy (GtkObject *object);
-static void gtk_box_map (GtkWidget *widget);
-static void gtk_box_unmap (GtkWidget *widget);
-static void gtk_box_draw (GtkWidget *widget,
- GdkRectangle *area);
-static gint gtk_box_expose (GtkWidget *widget,
- GdkEventExpose *event);
-static void gtk_box_add (GtkContainer *container,
- GtkWidget *widget);
-static void gtk_box_remove (GtkContainer *container,
- GtkWidget *widget);
-static void gtk_box_foreach (GtkContainer *container,
- GtkCallback callback,
- gpointer callback_data);
+enum {
+ CHILD_PROP_0,
+ CHILD_PROP_EXPAND,
+ CHILD_PROP_FILL,
+ CHILD_PROP_PADDING,
+ CHILD_PROP_PACK_TYPE,
+ CHILD_PROP_POSITION
+};
+struct _GtkBoxPrivate
+{
+ GList *children;
-static GtkContainerClass *parent_class = NULL;
+ GtkOrientation orientation;
+ gint16 spacing;
+ guint default_expand : 1;
+ guint homogeneous : 1;
+ guint spacing_set : 1;
+};
-guint
-gtk_box_get_type ()
+typedef struct _GtkBoxChild GtkBoxChild;
+
+/*
+ * GtkBoxChild:
+ * @widget: the child widget, packed into the GtkBox.
+ * @padding: the number of extra pixels to put between this child and its
+ * neighbors, set when packed, zero by default.
+ * @expand: flag indicates whether extra space should be given to this child.
+ * Any extra space given to the parent GtkBox is divided up among all children
+ * with this attribute set to %TRUE; set when packed, %TRUE by default.
+ * @fill: flag indicates whether any extra space given to this child due to its
+ * @expand attribute being set is actually allocated to the child, rather than
+ * being used as padding around the widget; set when packed, %TRUE by default.
+ * @pack: one of #GtkPackType indicating whether the child is packed with
+ * reference to the start (top/left) or end (bottom/right) of the GtkBox.
+ */
+struct _GtkBoxChild
{
- static guint box_type = 0;
+ GtkWidget *widget;
+
+ guint16 padding;
+
+ guint expand : 1;
+ guint fill : 1;
+ guint pack : 1;
+};
+
+static void gtk_box_size_allocate (GtkWidget *widget,
+ GtkAllocation *allocation);
+
+static void gtk_box_compute_expand (GtkWidget *widget,
+ gboolean *hexpand,
+ gboolean *vexpand);
+static void gtk_box_direction_changed (GtkWidget *widget,
+ GtkTextDirection previous_direction);
+
+static void gtk_box_set_property (GObject *object,
+ guint prop_id,
+ const GValue *value,
+ GParamSpec *pspec);
+static void gtk_box_get_property (GObject *object,
+ guint prop_id,
+ GValue *value,
+ GParamSpec *pspec);
+static void gtk_box_add (GtkContainer *container,
+ GtkWidget *widget);
+static void gtk_box_remove (GtkContainer *container,
+ GtkWidget *widget);
+static void gtk_box_forall (GtkContainer *container,
+ gboolean include_internals,
+ GtkCallback callback,
+ gpointer callback_data);
+static void gtk_box_set_child_property (GtkContainer *container,
+ GtkWidget *child,
+ guint property_id,
+ const GValue *value,
+ GParamSpec *pspec);
+static void gtk_box_get_child_property (GtkContainer *container,
+ GtkWidget *child,
+ guint property_id,
+ GValue *value,
+ GParamSpec *pspec);
+static GType gtk_box_child_type (GtkContainer *container);
+static GtkWidgetPath * gtk_box_get_path_for_child
+ (GtkContainer *container,
+ GtkWidget *child);
+
+
+static void gtk_box_get_preferred_width (GtkWidget *widget,
+ gint *minimum_size,
+ gint *natural_size);
+static void gtk_box_get_preferred_height (GtkWidget *widget,
+ gint *minimum_size,
+ gint *natural_size);
+static void gtk_box_get_preferred_width_for_height (GtkWidget *widget,
+ gint height,
+ gint *minimum_width,
+ gint *natural_width);
+static void gtk_box_get_preferred_height_for_width (GtkWidget *widget,
+ gint width,
+ gint *minimum_height,
+ gint *natural_height);
+
+
+G_DEFINE_TYPE_WITH_CODE (GtkBox, gtk_box, GTK_TYPE_CONTAINER,
+ G_IMPLEMENT_INTERFACE (GTK_TYPE_ORIENTABLE,
+ NULL))
- if (!box_type)
+static void
+gtk_box_class_init (GtkBoxClass *class)
+{
+ GObjectClass *object_class = G_OBJECT_CLASS (class);
+ GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
+ GtkContainerClass *container_class = GTK_CONTAINER_CLASS (class);
+
+ object_class->set_property = gtk_box_set_property;
+ object_class->get_property = gtk_box_get_property;
+
+ widget_class->size_allocate = gtk_box_size_allocate;
+ widget_class->get_preferred_width = gtk_box_get_preferred_width;
+ widget_class->get_preferred_height = gtk_box_get_preferred_height;
+ widget_class->get_preferred_height_for_width = gtk_box_get_preferred_height_for_width;
+ widget_class->get_preferred_width_for_height = gtk_box_get_preferred_width_for_height;
+ widget_class->compute_expand = gtk_box_compute_expand;
+ widget_class->direction_changed = gtk_box_direction_changed;
+
+ container_class->add = gtk_box_add;
+ container_class->remove = gtk_box_remove;
+ container_class->forall = gtk_box_forall;
+ container_class->child_type = gtk_box_child_type;
+ container_class->set_child_property = gtk_box_set_child_property;
+ container_class->get_child_property = gtk_box_get_child_property;
+ container_class->get_path_for_child = gtk_box_get_path_for_child;
+ gtk_container_class_handle_border_width (container_class);
+
+ g_object_class_override_property (object_class,
+ PROP_ORIENTATION,
+ "orientation");
+
+ g_object_class_install_property (object_class,
+ PROP_SPACING,
+ g_param_spec_int ("spacing",
+ P_("Spacing"),
+ P_("The amount of space between children"),
+ 0,
+ G_MAXINT,
+ 0,
+ GTK_PARAM_READWRITE));
+
+ g_object_class_install_property (object_class,
+ PROP_HOMOGENEOUS,
+ g_param_spec_boolean ("homogeneous",
+ P_("Homogeneous"),
+ P_("Whether the children should all be the same size"),
+ FALSE,
+ GTK_PARAM_READWRITE));
+
+ /**
+ * GtkBox:expand:
+ *
+ * Whether the child should receive extra space when the parent grows.
+ *
+ * Note that the default value for this property is %FALSE for GtkBox,
+ * but #GtkHBox, #GtkVBox and other subclasses use the old default
+ * of %TRUE.
+ *
+ * Note that the #GtkWidget:halign, #GtkWidget:valign, #GtkWidget:hexpand
+ * and #GtkWidget:vexpand properties are the preferred way to influence
+ * child size allocation in containers.
+ */
+ gtk_container_class_install_child_property (container_class,
+ CHILD_PROP_EXPAND,
+ g_param_spec_boolean ("expand",
+ P_("Expand"),
+ P_("Whether the child should receive extra space when the parent grows"),
+ FALSE,
+ GTK_PARAM_READWRITE));
+
+ /**
+ * GtkBox:fill:
+ *
+ * Whether the child should receive extra space when the parent grows.
+ *
+ * Note that the #GtkWidget:halign, #GtkWidget:valign, #GtkWidget:hexpand
+ * and #GtkWidget:vexpand properties are the preferred way to influence
+ * child size allocation in containers.
+ */
+ gtk_container_class_install_child_property (container_class,
+ CHILD_PROP_FILL,
+ g_param_spec_boolean ("fill",
+ P_("Fill"),
+ P_("Whether extra space given to the child should be allocated to the child or used as padding"),
+ TRUE,
+ GTK_PARAM_READWRITE));
+
+ gtk_container_class_install_child_property (container_class,
+ CHILD_PROP_PADDING,
+ g_param_spec_uint ("padding",
+ P_("Padding"),
+ P_("Extra space to put between the child and its neighbors, in pixels"),
+ 0, G_MAXINT, 0,
+ GTK_PARAM_READWRITE));
+ gtk_container_class_install_child_property (container_class,
+ CHILD_PROP_PACK_TYPE,
+ g_param_spec_enum ("pack-type",
+ P_("Pack type"),
+ P_("A GtkPackType indicating whether the child is packed with reference to the start or end of the parent"),
+ GTK_TYPE_PACK_TYPE, GTK_PACK_START,
+ GTK_PARAM_READWRITE));
+ gtk_container_class_install_child_property (container_class,
+ CHILD_PROP_POSITION,
+ g_param_spec_int ("position",
+ P_("Position"),
+ P_("The index of the child in the parent"),
+ -1, G_MAXINT, 0,
+ GTK_PARAM_READWRITE));
+
+ g_type_class_add_private (object_class, sizeof (GtkBoxPrivate));
+
+ gtk_widget_class_set_accessible_role (widget_class, ATK_ROLE_FILLER);
+}
+
+static void
+gtk_box_init (GtkBox *box)
+{
+ GtkBoxPrivate *private;
+
+ box->priv = G_TYPE_INSTANCE_GET_PRIVATE (box,
+ GTK_TYPE_BOX,
+ GtkBoxPrivate);
+ private = box->priv;
+
+ gtk_widget_set_has_window (GTK_WIDGET (box), FALSE);
+ gtk_widget_set_redraw_on_allocate (GTK_WIDGET (box), FALSE);
+
+ private->orientation = GTK_ORIENTATION_HORIZONTAL;
+ private->children = NULL;
+
+ private->default_expand = FALSE;
+ private->homogeneous = FALSE;
+ private->spacing = 0;
+ private->spacing_set = FALSE;
+}
+
+static void
+gtk_box_set_property (GObject *object,
+ guint prop_id,
+ const GValue *value,
+ GParamSpec *pspec)
+{
+ GtkBox *box = GTK_BOX (object);
+ GtkBoxPrivate *private = box->priv;
+
+ switch (prop_id)
{
- GtkTypeInfo box_info =
- {
- "GtkBox",
- sizeof (GtkBox),
- sizeof (GtkBoxClass),
- (GtkClassInitFunc) gtk_box_class_init,
- (GtkObjectInitFunc) gtk_box_init,
- (GtkArgSetFunc) gtk_box_set_arg,
- (GtkArgGetFunc) gtk_box_get_arg,
- };
+ case PROP_ORIENTATION:
+ private->orientation = g_value_get_enum (value);
+ _gtk_orientable_set_style_classes (GTK_ORIENTABLE (box));
+ gtk_widget_queue_resize (GTK_WIDGET (box));
+ break;
+ case PROP_SPACING:
+ gtk_box_set_spacing (box, g_value_get_int (value));
+ break;
+ case PROP_HOMOGENEOUS:
+ gtk_box_set_homogeneous (box, g_value_get_boolean (value));
+ break;
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ break;
+ }
+}
- box_type = gtk_type_unique (gtk_container_get_type (), &box_info);
+static void
+gtk_box_get_property (GObject *object,
+ guint prop_id,
+ GValue *value,
+ GParamSpec *pspec)
+{
+ GtkBox *box = GTK_BOX (object);
+ GtkBoxPrivate *private = box->priv;
+
+ switch (prop_id)
+ {
+ case PROP_ORIENTATION:
+ g_value_set_enum (value, private->orientation);
+ break;
+ case PROP_SPACING:
+ g_value_set_int (value, private->spacing);
+ break;
+ case PROP_HOMOGENEOUS:
+ g_value_set_boolean (value, private->homogeneous);
+ break;
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ break;
}
+}
- return box_type;
+
+static void
+count_expand_children (GtkBox *box,
+ gint *visible_children,
+ gint *expand_children)
+{
+ GtkBoxPrivate *private = box->priv;
+ GList *children;
+ GtkBoxChild *child;
+
+ *visible_children = *expand_children = 0;
+
+ for (children = private->children; children; children = children->next)
+ {
+ child = children->data;
+
+ if (gtk_widget_get_visible (child->widget))
+ {
+ *visible_children += 1;
+ if (child->expand || gtk_widget_compute_expand (child->widget, private->orientation))
+ *expand_children += 1;
+ }
+ }
}
static void
-gtk_box_class_init (GtkBoxClass *class)
+gtk_box_size_allocate (GtkWidget *widget,
+ GtkAllocation *allocation)
{
- GtkObjectClass *object_class;
- GtkWidgetClass *widget_class;
- GtkContainerClass *container_class;
+ GtkBox *box = GTK_BOX (widget);
+ GtkBoxPrivate *private = box->priv;
+ GtkBoxChild *child;
+ GList *children;
+ gint nvis_children;
+ gint nexpand_children;
- object_class = (GtkObjectClass*) class;
- widget_class = (GtkWidgetClass*) class;
- container_class = (GtkContainerClass*) class;
+ GtkTextDirection direction;
+ GtkAllocation child_allocation;
+ GtkRequestedSize *sizes;
- parent_class = gtk_type_class (gtk_container_get_type ());
+ GtkPackType packing;
- gtk_object_add_arg_type ("GtkBox::spacing", GTK_TYPE_INT, ARG_SPACING);
- gtk_object_add_arg_type ("GtkBox::homogeneous", GTK_TYPE_BOOL, ARG_HOMOGENEOUS);
+ gint size;
+ gint extra;
+ gint n_extra_widgets = 0; /* Number of widgets that receive 1 extra px */
+ gint x = 0, y = 0, i;
+ gint child_size;
- object_class->destroy = gtk_box_destroy;
- widget_class->map = gtk_box_map;
- widget_class->unmap = gtk_box_unmap;
- widget_class->draw = gtk_box_draw;
- widget_class->expose_event = gtk_box_expose;
+ gtk_widget_set_allocation (widget, allocation);
- container_class->add = gtk_box_add;
- container_class->remove = gtk_box_remove;
- container_class->foreach = gtk_box_foreach;
+ count_expand_children (box, &nvis_children, &nexpand_children);
+
+ /* If there is no visible child, simply return. */
+ if (nvis_children <= 0)
+ return;
+
+ direction = gtk_widget_get_direction (widget);
+ sizes = g_newa (GtkRequestedSize, nvis_children);
+
+ if (private->orientation == GTK_ORIENTATION_HORIZONTAL)
+ size = allocation->width - (nvis_children - 1) * private->spacing;
+ else
+ size = allocation->height - (nvis_children - 1) * private->spacing;
+
+ /* Retrieve desired size for visible children. */
+ for (i = 0, children = private->children; children; children = children->next)
+ {
+ child = children->data;
+
+ if (!gtk_widget_get_visible (child->widget))
+ continue;
+
+ if (private->orientation == GTK_ORIENTATION_HORIZONTAL)
+ gtk_widget_get_preferred_width_for_height (child->widget,
+ allocation->height,
+ &sizes[i].minimum_size,
+ &sizes[i].natural_size);
+ else
+ gtk_widget_get_preferred_height_for_width (child->widget,
+ allocation->width,
+ &sizes[i].minimum_size,
+ &sizes[i].natural_size);
+
+
+ /* Assert the api is working properly */
+ if (sizes[i].minimum_size < 0)
+ g_error ("GtkBox child %s minimum %s: %d < 0 for %s %d",
+ gtk_widget_get_name (GTK_WIDGET (child->widget)),
+ (private->orientation == GTK_ORIENTATION_HORIZONTAL) ? "width" : "height",
+ sizes[i].minimum_size,
+ (private->orientation == GTK_ORIENTATION_HORIZONTAL) ? "height" : "width",
+ (private->orientation == GTK_ORIENTATION_HORIZONTAL) ? allocation->height : allocation->width);
+
+ if (sizes[i].natural_size < sizes[i].minimum_size)
+ g_error ("GtkBox child %s natural %s: %d < minimum %d for %s %d",
+ gtk_widget_get_name (GTK_WIDGET (child->widget)),
+ (private->orientation == GTK_ORIENTATION_HORIZONTAL) ? "width" : "height",
+ sizes[i].natural_size,
+ sizes[i].minimum_size,
+ (private->orientation == GTK_ORIENTATION_HORIZONTAL) ? "height" : "width",
+ (private->orientation == GTK_ORIENTATION_HORIZONTAL) ? allocation->height : allocation->width);
+
+ size -= sizes[i].minimum_size;
+ size -= child->padding * 2;
+
+ sizes[i].data = child;
+
+ i++;
+ }
+
+ if (private->homogeneous)
+ {
+ /* If were homogenous we still need to run the above loop to get the
+ * minimum sizes for children that are not going to fill
+ */
+ if (private->orientation == GTK_ORIENTATION_HORIZONTAL)
+ size = allocation->width - (nvis_children - 1) * private->spacing;
+ else
+ size = allocation->height - (nvis_children - 1) * private->spacing;
+
+ extra = size / nvis_children;
+ n_extra_widgets = size % nvis_children;
+ }
+ else
+ {
+ /* Bring children up to size first */
+ size = gtk_distribute_natural_allocation (MAX (0, size), nvis_children, sizes);
+
+ /* Calculate space which hasn't distributed yet,
+ * and is available for expanding children.
+ */
+ if (nexpand_children > 0)
+ {
+ extra = size / nexpand_children;
+ n_extra_widgets = size % nexpand_children;
+ }
+ else
+ extra = 0;
+ }
+
+ /* Allocate child positions. */
+ for (packing = GTK_PACK_START; packing <= GTK_PACK_END; ++packing)
+ {
+ if (private->orientation == GTK_ORIENTATION_HORIZONTAL)
+ {
+ child_allocation.y = allocation->y;
+ child_allocation.height = MAX (1, allocation->height);
+ if (packing == GTK_PACK_START)
+ x = allocation->x;
+ else
+ x = allocation->x + allocation->width;
+ }
+ else
+ {
+ child_allocation.x = allocation->x;
+ child_allocation.width = MAX (1, allocation->width);
+ if (packing == GTK_PACK_START)
+ y = allocation->y;
+ else
+ y = allocation->y + allocation->height;
+ }
+
+ for (i = 0, children = private->children;
+ children;
+ children = children->next)
+ {
+ child = children->data;
+
+ /* If widget is not visible, skip it. */
+ if (!gtk_widget_get_visible (child->widget))
+ continue;
+
+ /* If widget is packed differently skip it, but still increment i,
+ * since widget is visible and will be handled in next loop iteration.
+ */
+ if (child->pack != packing)
+ {
+ i++;
+ continue;
+ }
+
+ /* Assign the child's size. */
+ if (private->homogeneous)
+ {
+ child_size = extra;
+
+ if (n_extra_widgets > 0)
+ {
+ child_size++;
+ n_extra_widgets--;
+ }
+ }
+ else
+ {
+ child_size = sizes[i].minimum_size + child->padding * 2;
+
+ if (child->expand || gtk_widget_compute_expand (child->widget, private->orientation))
+ {
+ child_size += extra;
+
+ if (n_extra_widgets > 0)
+ {
+ child_size++;
+ n_extra_widgets--;
+ }
+ }
+ }
+
+ /* Assign the child's position. */
+ if (private->orientation == GTK_ORIENTATION_HORIZONTAL)
+ {
+ if (child->fill)
+ {
+ child_allocation.width = MAX (1, child_size - child->padding * 2);
+ child_allocation.x = x + child->padding;
+ }
+ else
+ {
+ child_allocation.width = sizes[i].minimum_size;
+ child_allocation.x = x + (child_size - child_allocation.width) / 2;
+ }
+
+ if (packing == GTK_PACK_START)
+ {
+ x += child_size + private->spacing;
+ }
+ else
+ {
+ x -= child_size + private->spacing;
+
+ child_allocation.x -= child_size;
+ }
+
+ if (direction == GTK_TEXT_DIR_RTL)
+ child_allocation.x = allocation->x + allocation->width - (child_allocation.x - allocation->x) - child_allocation.width;
+
+ }
+ else /* (private->orientation == GTK_ORIENTATION_VERTICAL) */
+ {
+ if (child->fill)
+ {
+ child_allocation.height = MAX (1, child_size - child->padding * 2);
+ child_allocation.y = y + child->padding;
+ }
+ else
+ {
+ child_allocation.height = sizes[i].minimum_size;
+ child_allocation.y = y + (child_size - child_allocation.height) / 2;
+ }
+
+ if (packing == GTK_PACK_START)
+ {
+ y += child_size + private->spacing;
+ }
+ else
+ {
+ y -= child_size + private->spacing;
+
+ child_allocation.y -= child_size;
+ }
+ }
+ gtk_widget_size_allocate (child->widget, &child_allocation);
+
+ i++;
+ }
+ }
}
static void
-gtk_box_init (GtkBox *box)
+gtk_box_compute_expand (GtkWidget *widget,
+ gboolean *hexpand_p,
+ gboolean *vexpand_p)
{
- GTK_WIDGET_SET_FLAGS (box, GTK_NO_WINDOW | GTK_BASIC);
+ GtkBoxPrivate *private = GTK_BOX (widget)->priv;
+ GList *children;
+ GtkBoxChild *child;
+ gboolean our_expand;
+ gboolean opposite_expand;
+ GtkOrientation opposite_orientation;
+
+ if (private->orientation == GTK_ORIENTATION_HORIZONTAL)
+ opposite_orientation = GTK_ORIENTATION_VERTICAL;
+ else
+ opposite_orientation = GTK_ORIENTATION_HORIZONTAL;
+
+ our_expand = FALSE;
+ opposite_expand = FALSE;
+
+ for (children = private->children; children; children = children->next)
+ {
+ child = children->data;
- box->children = NULL;
- box->spacing = 0;
- box->homogeneous = FALSE;
+ /* we don't recurse into children anymore as soon as we know
+ * expand=TRUE in an orientation
+ */
+
+ if (child->expand || (!our_expand && gtk_widget_compute_expand (child->widget, private->orientation)))
+ our_expand = TRUE;
+
+ if (!opposite_expand && gtk_widget_compute_expand (child->widget, opposite_orientation))
+ opposite_expand = TRUE;
+
+ if (our_expand && opposite_expand)
+ break;
+ }
+
+ if (private->orientation == GTK_ORIENTATION_HORIZONTAL)
+ {
+ *hexpand_p = our_expand;
+ *vexpand_p = opposite_expand;
+ }
+ else
+ {
+ *hexpand_p = opposite_expand;
+ *vexpand_p = our_expand;
+ }
+}
+
+static GType
+gtk_box_child_type (GtkContainer *container)
+{
+ return GTK_TYPE_WIDGET;
}
static void
-gtk_box_set_arg (GtkBox *box,
- GtkArg *arg,
- guint arg_id)
+gtk_box_set_child_property (GtkContainer *container,
+ GtkWidget *child,
+ guint property_id,
+ const GValue *value,
+ GParamSpec *pspec)
{
- switch (arg_id)
+ gboolean expand = 0;
+ gboolean fill = 0;
+ guint padding = 0;
+ GtkPackType pack_type = 0;
+
+ if (property_id != CHILD_PROP_POSITION)
+ gtk_box_query_child_packing (GTK_BOX (container),
+ child,
+ &expand,
+ &fill,
+ &padding,
+ &pack_type);
+ switch (property_id)
{
- case ARG_SPACING:
- gtk_box_set_spacing (box, GTK_VALUE_INT (*arg));
+ case CHILD_PROP_EXPAND:
+ gtk_box_set_child_packing (GTK_BOX (container),
+ child,
+ g_value_get_boolean (value),
+ fill,
+ padding,
+ pack_type);
+ break;
+ case CHILD_PROP_FILL:
+ gtk_box_set_child_packing (GTK_BOX (container),
+ child,
+ expand,
+ g_value_get_boolean (value),
+ padding,
+ pack_type);
break;
- case ARG_HOMOGENEOUS:
- gtk_box_set_homogeneous (box, GTK_VALUE_BOOL (*arg));
+ case CHILD_PROP_PADDING:
+ gtk_box_set_child_packing (GTK_BOX (container),
+ child,
+ expand,
+ fill,
+ g_value_get_uint (value),
+ pack_type);
+ break;
+ case CHILD_PROP_PACK_TYPE:
+ gtk_box_set_child_packing (GTK_BOX (container),
+ child,
+ expand,
+ fill,
+ padding,
+ g_value_get_enum (value));
+ break;
+ case CHILD_PROP_POSITION:
+ gtk_box_reorder_child (GTK_BOX (container),
+ child,
+ g_value_get_int (value));
+ break;
+ default:
+ GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
break;
}
}
static void
-gtk_box_get_arg (GtkBox *box,
- GtkArg *arg,
- guint arg_id)
+gtk_box_get_child_property (GtkContainer *container,
+ GtkWidget *child,
+ guint property_id,
+ GValue *value,
+ GParamSpec *pspec)
{
- switch (arg_id)
+ gboolean expand = FALSE;
+ gboolean fill = FALSE;
+ guint padding = 0;
+ GtkPackType pack_type = 0;
+ GList *list;
+
+ if (property_id != CHILD_PROP_POSITION)
+ gtk_box_query_child_packing (GTK_BOX (container),
+ child,
+ &expand,
+ &fill,
+ &padding,
+ &pack_type);
+ switch (property_id)
{
- case ARG_SPACING:
- GTK_VALUE_INT (*arg) = box->spacing;
+ guint i;
+ case CHILD_PROP_EXPAND:
+ g_value_set_boolean (value, expand);
break;
- case ARG_HOMOGENEOUS:
- GTK_VALUE_BOOL (*arg) = box->homogeneous;
+ case CHILD_PROP_FILL:
+ g_value_set_boolean (value, fill);
+ break;
+ case CHILD_PROP_PADDING:
+ g_value_set_uint (value, padding);
+ break;
+ case CHILD_PROP_PACK_TYPE:
+ g_value_set_enum (value, pack_type);
+ break;
+ case CHILD_PROP_POSITION:
+ i = 0;
+ for (list = GTK_BOX (container)->priv->children; list; list = list->next)
+ {
+ GtkBoxChild *child_entry;
+
+ child_entry = list->data;
+ if (child_entry->widget == child)
+ break;
+ i++;
+ }
+ g_value_set_int (value, list ? i : -1);
break;
default:
- arg->type = GTK_TYPE_INVALID;
+ GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
break;
}
}
-void
-gtk_box_pack_start (GtkBox *box,
- GtkWidget *child,
- gint expand,
- gint fill,
- gint padding)
+typedef struct _CountingData CountingData;
+struct _CountingData {
+ GtkWidget *widget;
+ gboolean found;
+ guint before;
+ guint after;
+};
+
+static void
+count_widget_position (GtkWidget *widget,
+ gpointer data)
{
- GtkBoxChild *child_info;
+ CountingData *count = data;
- g_return_if_fail (box != NULL);
- g_return_if_fail (GTK_IS_BOX (box));
- g_return_if_fail (child != NULL);
+ if (!gtk_widget_get_visible (widget))
+ return;
- child_info = g_new (GtkBoxChild, 1);
- child_info->widget = child;
- child_info->padding = padding;
- child_info->expand = expand ? TRUE : FALSE;
- child_info->fill = fill ? TRUE : FALSE;
- child_info->pack = GTK_PACK_START;
+ if (count->widget == widget)
+ count->found = TRUE;
+ else if (count->found)
+ count->after++;
+ else
+ count->before++;
+}
+
+static gint
+gtk_box_get_visible_position (GtkBox *box,
+ GtkWidget *child)
+{
+ CountingData count = { child, FALSE, 0, 0 };
+
+ /* foreach iterates in visible order */
+ gtk_container_foreach (GTK_CONTAINER (box),
+ count_widget_position,
+ &count);
+
+ /* the child wasn't found, it's likely an internal child of some
+ * subclass, return -1 to indicate that there is no sibling relation
+ * to the regular box children
+ */
+ if (!count.found)
+ return -1;
+
+ if (box->priv->orientation == GTK_ORIENTATION_HORIZONTAL &&
+ gtk_widget_get_direction (GTK_WIDGET (box)) == GTK_TEXT_DIR_RTL)
+ return count.after;
+ else
+ return count.before;
+}
- box->children = g_list_append (box->children, child_info);
+static GtkWidgetPath *
+gtk_box_get_path_for_child (GtkContainer *container,
+ GtkWidget *child)
+{
+ GtkWidgetPath *path, *sibling_path;
+ GtkBox *box;
+ GtkBoxPrivate *private;
+ GList *list, *children;
- gtk_widget_set_parent (child, GTK_WIDGET (box));
+ box = GTK_BOX (container);
+ private = box->priv;
+
+ path = _gtk_widget_create_path (GTK_WIDGET (container));
- if (GTK_WIDGET_VISIBLE (GTK_WIDGET (box)))
+ if (gtk_widget_get_visible (child))
{
- if (GTK_WIDGET_REALIZED (GTK_WIDGET (box)) &&
- !GTK_WIDGET_REALIZED (child))
- gtk_widget_realize (child);
-
- if (GTK_WIDGET_MAPPED (GTK_WIDGET (box)) &&
- !GTK_WIDGET_MAPPED (child))
- gtk_widget_map (child);
+ gint position;
+
+ sibling_path = gtk_widget_path_new ();
+
+ /* get_children works in visible order */
+ children = gtk_container_get_children (container);
+ if (private->orientation == GTK_ORIENTATION_HORIZONTAL &&
+ gtk_widget_get_direction (GTK_WIDGET (box)) == GTK_TEXT_DIR_RTL)
+ children = g_list_reverse (children);
+
+ for (list = children; list; list = list->next)
+ {
+ if (!gtk_widget_get_visible (list->data))
+ continue;
+
+ gtk_widget_path_append_for_widget (sibling_path, list->data);
+ }
+
+ g_list_free (children);
+
+ position = gtk_box_get_visible_position (box, child);
+
+ if (position >= 0)
+ gtk_widget_path_append_with_siblings (path, sibling_path, position);
+ else
+ gtk_widget_path_append_for_widget (path, child);
+
+ gtk_widget_path_unref (sibling_path);
}
+ else
+ gtk_widget_path_append_for_widget (path, child);
- if (GTK_WIDGET_VISIBLE (child) && GTK_WIDGET_VISIBLE (box))
- gtk_widget_queue_resize (child);
+ return path;
}
-void
-gtk_box_pack_end (GtkBox *box,
- GtkWidget *child,
- gint expand,
- gint fill,
- gint padding)
+static void
+gtk_box_invalidate_order_foreach (GtkWidget *widget)
+{
+ _gtk_widget_invalidate_style_context (widget, GTK_CSS_CHANGE_POSITION | GTK_CSS_CHANGE_SIBLING_POSITION);
+}
+
+static void
+gtk_box_invalidate_order (GtkBox *box)
+{
+ gtk_container_foreach (GTK_CONTAINER (box),
+ (GtkCallback) gtk_box_invalidate_order_foreach,
+ NULL);
+}
+
+static void
+gtk_box_direction_changed (GtkWidget *widget,
+ GtkTextDirection previous_direction)
{
+ gtk_box_invalidate_order (GTK_BOX (widget));
+}
+
+static void
+box_child_visibility_notify_cb (GObject *obj,
+ GParamSpec *pspec,
+ gpointer user_data)
+{
+ GtkBox *box = user_data;
+
+ gtk_box_invalidate_order (box);
+}
+
+static void
+gtk_box_pack (GtkBox *box,
+ GtkWidget *child,
+ gboolean expand,
+ gboolean fill,
+ guint padding,
+ GtkPackType pack_type)
+{
+ GtkBoxPrivate *private = box->priv;
GtkBoxChild *child_info;
- g_return_if_fail (box != NULL);
g_return_if_fail (GTK_IS_BOX (box));
- g_return_if_fail (child != NULL);
+ g_return_if_fail (GTK_IS_WIDGET (child));
+ g_return_if_fail (gtk_widget_get_parent (child) == NULL);
child_info = g_new (GtkBoxChild, 1);
child_info->widget = child;
child_info->padding = padding;
child_info->expand = expand ? TRUE : FALSE;
child_info->fill = fill ? TRUE : FALSE;
- child_info->pack = GTK_PACK_END;
+ child_info->pack = pack_type;
- box->children = g_list_append (box->children, child_info);
+ private->children = g_list_append (private->children, child_info);
+ gtk_widget_freeze_child_notify (child);
+
+ gtk_box_invalidate_order (box);
gtk_widget_set_parent (child, GTK_WIDGET (box));
- if (GTK_WIDGET_VISIBLE (GTK_WIDGET (box)))
+ g_signal_connect (child, "notify::visible",
+ G_CALLBACK (box_child_visibility_notify_cb), box);
+
+ gtk_widget_child_notify (child, "expand");
+ gtk_widget_child_notify (child, "fill");
+ gtk_widget_child_notify (child, "padding");
+ gtk_widget_child_notify (child, "pack-type");
+ gtk_widget_child_notify (child, "position");
+ gtk_widget_thaw_child_notify (child);
+}
+
+static void
+gtk_box_get_size (GtkWidget *widget,
+ GtkOrientation orientation,
+ gint *minimum_size,
+ gint *natural_size)
+{
+ GtkBox *box;
+ GtkBoxPrivate *private;
+ GList *children;
+ gint nvis_children;
+ gint minimum, natural;
+
+ box = GTK_BOX (widget);
+ private = box->priv;
+
+ minimum = natural = 0;
+
+ nvis_children = 0;
+
+ for (children = private->children; children; children = children->next)
{
- if (GTK_WIDGET_REALIZED (GTK_WIDGET (box)) &&
- !GTK_WIDGET_REALIZED (child))
- gtk_widget_realize (child);
-
- if (GTK_WIDGET_MAPPED (GTK_WIDGET (box)) &&
- !GTK_WIDGET_MAPPED (child))
- gtk_widget_map (child);
+ GtkBoxChild *child = children->data;
+
+ if (gtk_widget_get_visible (child->widget))
+ {
+ gint child_minimum, child_natural;
+
+ if (orientation == GTK_ORIENTATION_HORIZONTAL)
+ gtk_widget_get_preferred_width (child->widget,
+ &child_minimum, &child_natural);
+ else
+ gtk_widget_get_preferred_height (child->widget,
+ &child_minimum, &child_natural);
+
+ if (private->orientation == orientation)
+ {
+ if (private->homogeneous)
+ {
+ gint largest;
+
+ largest = child_minimum + child->padding * 2;
+ minimum = MAX (minimum, largest);
+
+ largest = child_natural + child->padding * 2;
+ natural = MAX (natural, largest);
+ }
+ else
+ {
+ minimum += child_minimum + child->padding * 2;
+ natural += child_natural + child->padding * 2;
+ }
+ }
+ else
+ {
+ /* The biggest mins and naturals in the opposing orientation */
+ minimum = MAX (minimum, child_minimum);
+ natural = MAX (natural, child_natural);
+ }
+
+ nvis_children += 1;
+ }
}
-
- if (GTK_WIDGET_VISIBLE (child) && GTK_WIDGET_VISIBLE (box))
- gtk_widget_queue_resize (child);
+
+ if (nvis_children > 0 && private->orientation == orientation)
+ {
+ if (private->homogeneous)
+ {
+ minimum *= nvis_children;
+ natural *= nvis_children;
+ }
+ minimum += (nvis_children - 1) * private->spacing;
+ natural += (nvis_children - 1) * private->spacing;
+ }
+
+ if (minimum_size)
+ *minimum_size = minimum;
+
+ if (natural_size)
+ *natural_size = natural;
}
-void
-gtk_box_pack_start_defaults (GtkBox *box,
- GtkWidget *child)
+static void
+gtk_box_get_preferred_width (GtkWidget *widget,
+ gint *minimum_size,
+ gint *natural_size)
{
- g_return_if_fail (box != NULL);
- g_return_if_fail (GTK_IS_BOX (box));
- g_return_if_fail (child != NULL);
+ gtk_box_get_size (widget, GTK_ORIENTATION_HORIZONTAL, minimum_size, natural_size);
+}
+
+static void
+gtk_box_get_preferred_height (GtkWidget *widget,
+ gint *minimum_size,
+ gint *natural_size)
+{
+ gtk_box_get_size (widget, GTK_ORIENTATION_VERTICAL, minimum_size, natural_size);
+}
+
+static void
+gtk_box_compute_size_for_opposing_orientation (GtkBox *box,
+ gint avail_size,
+ gint *minimum_size,
+ gint *natural_size)
+{
+ GtkBoxPrivate *private = box->priv;
+ GtkBoxChild *child;
+ GList *children;
+ gint nvis_children;
+ gint nexpand_children;
+ gint computed_minimum = 0, computed_natural = 0;
+ GtkRequestedSize *sizes;
+ GtkPackType packing;
+ gint size, extra, i;
+ gint child_size, child_minimum, child_natural;
+ gint n_extra_widgets = 0;
+
+ count_expand_children (box, &nvis_children, &nexpand_children);
+
+ if (nvis_children <= 0)
+ return;
+
+ sizes = g_newa (GtkRequestedSize, nvis_children);
+ size = avail_size - (nvis_children - 1) * private->spacing;
+
+ /* Retrieve desired size for visible children */
+ for (i = 0, children = private->children; children; children = children->next)
+ {
+ child = children->data;
+
+ if (gtk_widget_get_visible (child->widget))
+ {
+ if (private->orientation == GTK_ORIENTATION_HORIZONTAL)
+ gtk_widget_get_preferred_width (child->widget,
+ &sizes[i].minimum_size,
+ &sizes[i].natural_size);
+ else
+ gtk_widget_get_preferred_height (child->widget,
+ &sizes[i].minimum_size,
+ &sizes[i].natural_size);
+
+ /* Assert the api is working properly */
+ if (sizes[i].minimum_size < 0)
+ g_error ("GtkBox child %s minimum %s: %d < 0",
+ gtk_widget_get_name (GTK_WIDGET (child->widget)),
+ (private->orientation == GTK_ORIENTATION_HORIZONTAL) ? "width" : "height",
+ sizes[i].minimum_size);
+
+ if (sizes[i].natural_size < sizes[i].minimum_size)
+ g_error ("GtkBox child %s natural %s: %d < minimum %d",
+ gtk_widget_get_name (GTK_WIDGET (child->widget)),
+ (private->orientation == GTK_ORIENTATION_HORIZONTAL) ? "width" : "height",
+ sizes[i].natural_size,
+ sizes[i].minimum_size);
+
+ size -= sizes[i].minimum_size;
+ size -= child->padding * 2;
+
+ sizes[i].data = child;
+
+ i += 1;
+ }
+ }
+
+ if (private->homogeneous)
+ {
+ /* If were homogenous we still need to run the above loop to get the
+ * minimum sizes for children that are not going to fill
+ */
+ size = avail_size - (nvis_children - 1) * private->spacing;
+ extra = size / nvis_children;
+ n_extra_widgets = size % nvis_children;
+ }
+ else
+ {
+ /* Bring children up to size first */
+ size = gtk_distribute_natural_allocation (MAX (0, size), nvis_children, sizes);
+
+ /* Calculate space which hasn't distributed yet,
+ * and is available for expanding children.
+ */
+ if (nexpand_children > 0)
+ {
+ extra = size / nexpand_children;
+ n_extra_widgets = size % nexpand_children;
+ }
+ else
+ extra = 0;
+ }
+
+ /* Allocate child positions. */
+ for (packing = GTK_PACK_START; packing <= GTK_PACK_END; ++packing)
+ {
+ for (i = 0, children = private->children;
+ children;
+ children = children->next)
+ {
+ child = children->data;
+
+ /* If widget is not visible, skip it. */
+ if (!gtk_widget_get_visible (child->widget))
+ continue;
+
+ /* If widget is packed differently skip it, but still increment i,
+ * since widget is visible and will be handled in next loop iteration.
+ */
+ if (child->pack != packing)
+ {
+ i++;
+ continue;
+ }
+
+ if (child->pack == packing)
+ {
+ /* Assign the child's size. */
+ if (private->homogeneous)
+ {
+ child_size = extra;
+
+ if (n_extra_widgets > 0)
+ {
+ child_size++;
+ n_extra_widgets--;
+ }
+ }
+ else
+ {
+ child_size = sizes[i].minimum_size + child->padding * 2;
+
+ if (child->expand || gtk_widget_compute_expand (child->widget, private->orientation))
+ {
+ child_size += extra;
+
+ if (n_extra_widgets > 0)
+ {
+ child_size++;
+ n_extra_widgets--;
+ }
+ }
+ }
+
+ if (child->fill)
+ {
+ child_size = MAX (1, child_size - child->padding * 2);
+ }
+ else
+ {
+ child_size = sizes[i].minimum_size;
+ }
+
+
+ /* Assign the child's position. */
+ if (private->orientation == GTK_ORIENTATION_HORIZONTAL)
+ gtk_widget_get_preferred_height_for_width (child->widget,
+ child_size, &child_minimum, &child_natural);
+ else /* (private->orientation == GTK_ORIENTATION_VERTICAL) */
+ gtk_widget_get_preferred_width_for_height (child->widget,
+ child_size, &child_minimum, &child_natural);
+
+
+ computed_minimum = MAX (computed_minimum, child_minimum);
+ computed_natural = MAX (computed_natural, child_natural);
+ }
+ i += 1;
+ }
+ }
+
+ if (minimum_size)
+ *minimum_size = computed_minimum;
+ if (natural_size)
+ *natural_size = computed_natural;
+}
+
+static void
+gtk_box_compute_size_for_orientation (GtkBox *box,
+ gint avail_size,
+ gint *minimum_size,
+ gint *natural_size)
+{
+ GtkBoxPrivate *private = box->priv;
+ GList *children;
+ gint nvis_children = 0;
+ gint required_size = 0, required_natural = 0, child_size, child_natural;
+ gint largest_child = 0, largest_natural = 0;
+
+ for (children = private->children; children != NULL;
+ children = children->next)
+ {
+ GtkBoxChild *child = children->data;
+
+ if (gtk_widget_get_visible (child->widget))
+ {
+
+ if (private->orientation == GTK_ORIENTATION_HORIZONTAL)
+ gtk_widget_get_preferred_width_for_height (child->widget,
+ avail_size, &child_size, &child_natural);
+ else
+ gtk_widget_get_preferred_height_for_width (child->widget,
+ avail_size, &child_size, &child_natural);
+
+
+ child_size += child->padding * 2;
+ child_natural += child->padding * 2;
+
+ if (child_size > largest_child)
+ largest_child = child_size;
+
+ if (child_natural > largest_natural)
+ largest_natural = child_natural;
+
+ required_size += child_size;
+ required_natural += child_natural;
+
+ nvis_children += 1;
+ }
+ }
+
+ if (nvis_children > 0)
+ {
+ if (private->homogeneous)
+ {
+ required_size = largest_child * nvis_children;
+ required_natural = largest_natural * nvis_children;
+ }
+
+ required_size += (nvis_children - 1) * private->spacing;
+ required_natural += (nvis_children - 1) * private->spacing;
+ }
+
+ if (minimum_size)
+ *minimum_size = required_size;
+
+ if (natural_size)
+ *natural_size = required_natural;
+}
+
+static void
+gtk_box_get_preferred_width_for_height (GtkWidget *widget,
+ gint height,
+ gint *minimum_width,
+ gint *natural_width)
+{
+ GtkBox *box = GTK_BOX (widget);
+ GtkBoxPrivate *private = box->priv;
+
+ if (private->orientation == GTK_ORIENTATION_VERTICAL)
+ gtk_box_compute_size_for_opposing_orientation (box, height, minimum_width, natural_width);
+ else
+ gtk_box_compute_size_for_orientation (box, height, minimum_width, natural_width);
+}
- gtk_box_pack_start (box, child, TRUE, TRUE, 0);
+static void
+gtk_box_get_preferred_height_for_width (GtkWidget *widget,
+ gint width,
+ gint *minimum_height,
+ gint *natural_height)
+{
+ GtkBox *box = GTK_BOX (widget);
+ GtkBoxPrivate *private = box->priv;
+
+ if (private->orientation == GTK_ORIENTATION_HORIZONTAL)
+ gtk_box_compute_size_for_opposing_orientation (box, width, minimum_height, natural_height);
+ else
+ gtk_box_compute_size_for_orientation (box, width, minimum_height, natural_height);
}
+/**
+ * gtk_box_new:
+ * @orientation: the box's orientation.
+ * @spacing: the number of pixels to place by default between children.
+ *
+ * Creates a new #GtkBox.
+ *
+ * Return value: a new #GtkBox.
+ *
+ * Since: 3.0
+ **/
+GtkWidget*
+gtk_box_new (GtkOrientation orientation,
+ gint spacing)
+{
+ return g_object_new (GTK_TYPE_BOX,
+ "orientation", orientation,
+ "spacing", spacing,
+ NULL);
+}
+
+/**
+ * gtk_box_pack_start:
+ * @box: a #GtkBox
+ * @child: the #GtkWidget to be added to @box
+ * @expand: %TRUE if the new child is to be given extra space allocated
+ * to @box. The extra space will be divided evenly between all children
+ * that use this option
+ * @fill: %TRUE if space given to @child by the @expand option is
+ * actually allocated to @child, rather than just padding it. This
+ * parameter has no effect if @expand is set to %FALSE. A child is
+ * always allocated the full height of a horizontal #GtkBox and the full width
+ * of a vertical #GtkBox. This option affects the other dimension
+ * @padding: extra space in pixels to put between this child and its
+ * neighbors, over and above the global amount specified by
+ * #GtkBox:spacing property. If @child is a widget at one of the
+ * reference ends of @box, then @padding pixels are also put between
+ * @child and the reference edge of @box
+ *
+ * Adds @child to @box, packed with reference to the start of @box.
+ * The @child is packed after any other child packed with reference
+ * to the start of @box.
+ */
void
-gtk_box_pack_end_defaults (GtkBox *box,
- GtkWidget *child)
+gtk_box_pack_start (GtkBox *box,
+ GtkWidget *child,
+ gboolean expand,
+ gboolean fill,
+ guint padding)
{
- g_return_if_fail (box != NULL);
- g_return_if_fail (GTK_IS_BOX (box));
- g_return_if_fail (child != NULL);
+ gtk_box_pack (box, child, expand, fill, padding, GTK_PACK_START);
+}
- gtk_box_pack_end (box, child, TRUE, TRUE, 0);
+/**
+ * gtk_box_pack_end:
+ * @box: a #GtkBox
+ * @child: the #GtkWidget to be added to @box
+ * @expand: %TRUE if the new child is to be given extra space allocated
+ * to @box. The extra space will be divided evenly between all children
+ * of @box that use this option
+ * @fill: %TRUE if space given to @child by the @expand option is
+ * actually allocated to @child, rather than just padding it. This
+ * parameter has no effect if @expand is set to %FALSE. A child is
+ * always allocated the full height of a horizontal #GtkBox and the full width
+ * of a vertical #GtkBox. This option affects the other dimension
+ * @padding: extra space in pixels to put between this child and its
+ * neighbors, over and above the global amount specified by
+ * #GtkBox:spacing property. If @child is a widget at one of the
+ * reference ends of @box, then @padding pixels are also put between
+ * @child and the reference edge of @box
+ *
+ * Adds @child to @box, packed with reference to the end of @box.
+ * The @child is packed after (away from end of) any other child
+ * packed with reference to the end of @box.
+ */
+void
+gtk_box_pack_end (GtkBox *box,
+ GtkWidget *child,
+ gboolean expand,
+ gboolean fill,
+ guint padding)
+{
+ gtk_box_pack (box, child, expand, fill, padding, GTK_PACK_END);
}
+/**
+ * gtk_box_set_homogeneous:
+ * @box: a #GtkBox
+ * @homogeneous: a boolean value, %TRUE to create equal allotments,
+ * %FALSE for variable allotments
+ *
+ * Sets the #GtkBox:homogeneous property of @box, controlling
+ * whether or not all children of @box are given equal space
+ * in the box.
+ */
void
-gtk_box_set_homogeneous (GtkBox *box,
- gint homogeneous)
+gtk_box_set_homogeneous (GtkBox *box,
+ gboolean homogeneous)
{
- g_return_if_fail (box != NULL);
+ GtkBoxPrivate *private;
+
g_return_if_fail (GTK_IS_BOX (box));
- if ((homogeneous ? TRUE : FALSE) != box->homogeneous)
+ private = box->priv;
+
+ if ((homogeneous ? TRUE : FALSE) != private->homogeneous)
{
- box->homogeneous = homogeneous ? TRUE : FALSE;
+ private->homogeneous = homogeneous ? TRUE : FALSE;
+ g_object_notify (G_OBJECT (box), "homogeneous");
gtk_widget_queue_resize (GTK_WIDGET (box));
}
}
+/**
+ * gtk_box_get_homogeneous:
+ * @box: a #GtkBox
+ *
+ * Returns whether the box is homogeneous (all children are the
+ * same size). See gtk_box_set_homogeneous().
+ *
+ * Return value: %TRUE if the box is homogeneous.
+ **/
+gboolean
+gtk_box_get_homogeneous (GtkBox *box)
+{
+ g_return_val_if_fail (GTK_IS_BOX (box), FALSE);
+
+ return box->priv->homogeneous;
+}
+
+/**
+ * gtk_box_set_spacing:
+ * @box: a #GtkBox
+ * @spacing: the number of pixels to put between children
+ *
+ * Sets the #GtkBox:spacing property of @box, which is the
+ * number of pixels to place between children of @box.
+ */
void
gtk_box_set_spacing (GtkBox *box,
gint spacing)
{
- g_return_if_fail (box != NULL);
+ GtkBoxPrivate *private;
+
g_return_if_fail (GTK_IS_BOX (box));
- if (spacing != box->spacing)
+ private = box->priv;
+
+ if (spacing != private->spacing)
{
- box->spacing = spacing;
+ private->spacing = spacing;
+ _gtk_box_set_spacing_set (box, TRUE);
+
+ g_object_notify (G_OBJECT (box), "spacing");
+
gtk_widget_queue_resize (GTK_WIDGET (box));
}
}
+/**
+ * gtk_box_get_spacing:
+ * @box: a #GtkBox
+ *
+ * Gets the value set by gtk_box_set_spacing().
+ *
+ * Return value: spacing between children
+ **/
+gint
+gtk_box_get_spacing (GtkBox *box)
+{
+ g_return_val_if_fail (GTK_IS_BOX (box), 0);
+
+ return box->priv->spacing;
+}
-static void
-gtk_box_destroy (GtkObject *object)
+void
+_gtk_box_set_spacing_set (GtkBox *box,
+ gboolean spacing_set)
{
- GtkBox *box;
- GtkBoxChild *child;
- GList *children;
+ GtkBoxPrivate *private;
- g_return_if_fail (object != NULL);
- g_return_if_fail (GTK_IS_BOX (object));
+ g_return_if_fail (GTK_IS_BOX (box));
- box = GTK_BOX (object);
+ private = box->priv;
- children = box->children;
- while (children)
- {
- child = children->data;
- children = children->next;
+ private->spacing_set = spacing_set ? TRUE : FALSE;
+}
- child->widget->parent = NULL;
- gtk_object_unref (GTK_OBJECT (child->widget));
- gtk_widget_destroy (child->widget);
- g_free (child);
- }
+gboolean
+_gtk_box_get_spacing_set (GtkBox *box)
+{
+ GtkBoxPrivate *private;
+
+ g_return_val_if_fail (GTK_IS_BOX (box), FALSE);
- g_list_free (box->children);
+ private = box->priv;
- if (GTK_OBJECT_CLASS (parent_class)->destroy)
- (* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
+ return private->spacing_set;
}
-static void
-gtk_box_map (GtkWidget *widget)
+/**
+ * gtk_box_reorder_child:
+ * @box: a #GtkBox
+ * @child: the #GtkWidget to move
+ * @position: the new position for @child in the list of children
+ * of @box, starting from 0. If negative, indicates the end of
+ * the list
+ *
+ * Moves @child to a new @position in the list of @box children.
+ * The list is the <structfield>children</structfield> field of
+ * #GtkBox-struct, and contains both widgets packed #GTK_PACK_START
+ * as well as widgets packed #GTK_PACK_END, in the order that these
+ * widgets were added to @box.
+ *
+ * A widget's position in the @box children list determines where
+ * the widget is packed into @box. A child widget at some position
+ * in the list will be packed just after all other widgets of the
+ * same packing type that appear earlier in the list.
+ */
+void
+gtk_box_reorder_child (GtkBox *box,
+ GtkWidget *child,
+ gint position)
{
- GtkBox *box;
- GtkBoxChild *child;
- GList *children;
+ GtkBoxPrivate *priv;
+ GList *old_link;
+ GList *new_link;
+ GtkBoxChild *child_info = NULL;
+ gint old_position;
- g_return_if_fail (widget != NULL);
- g_return_if_fail (GTK_IS_BOX (widget));
+ g_return_if_fail (GTK_IS_BOX (box));
+ g_return_if_fail (GTK_IS_WIDGET (child));
- box = GTK_BOX (widget);
- GTK_WIDGET_SET_FLAGS (box, GTK_MAPPED);
+ priv = box->priv;
- children = box->children;
- while (children)
+ old_link = priv->children;
+ old_position = 0;
+ while (old_link)
{
- child = children->data;
- children = children->next;
+ child_info = old_link->data;
+ if (child_info->widget == child)
+ break;
- if (GTK_WIDGET_VISIBLE (child->widget) &&
- !GTK_WIDGET_MAPPED (child->widget))
- gtk_widget_map (child->widget);
+ old_link = old_link->next;
+ old_position++;
}
-}
-static void
-gtk_box_unmap (GtkWidget *widget)
-{
- GtkBox *box;
- GtkBoxChild *child;
- GList *children;
+ g_return_if_fail (old_link != NULL);
- g_return_if_fail (widget != NULL);
- g_return_if_fail (GTK_IS_BOX (widget));
+ if (position == old_position)
+ return;
- box = GTK_BOX (widget);
- GTK_WIDGET_UNSET_FLAGS (box, GTK_MAPPED);
+ priv->children = g_list_delete_link (priv->children, old_link);
- children = box->children;
- while (children)
- {
- child = children->data;
- children = children->next;
+ if (position < 0)
+ new_link = NULL;
+ else
+ new_link = g_list_nth (priv->children, position);
- if (GTK_WIDGET_VISIBLE (child->widget) &&
- GTK_WIDGET_MAPPED (child->widget))
- gtk_widget_unmap (child->widget);
+ priv->children = g_list_insert_before (priv->children, new_link, child_info);
+
+ gtk_widget_child_notify (child, "position");
+ if (gtk_widget_get_visible (child)
+ && gtk_widget_get_visible (GTK_WIDGET (box)))
+ {
+ gtk_box_invalidate_order (box);
+ gtk_widget_queue_resize (child);
}
}
-static void
-gtk_box_draw (GtkWidget *widget,
- GdkRectangle *area)
+/**
+ * gtk_box_query_child_packing:
+ * @box: a #GtkBox
+ * @child: the #GtkWidget of the child to query
+ * @expand: (out): pointer to return location for #GtkBox:expand child
+ * property
+ * @fill: (out): pointer to return location for #GtkBox:fill child
+ * property
+ * @padding: (out): pointer to return location for #GtkBox:padding
+ * child property
+ * @pack_type: (out): pointer to return location for #GtkBox:pack-type
+ * child property
+ *
+ * Obtains information about how @child is packed into @box.
+ */
+void
+gtk_box_query_child_packing (GtkBox *box,
+ GtkWidget *child,
+ gboolean *expand,
+ gboolean *fill,
+ guint *padding,
+ GtkPackType *pack_type)
{
- GtkBox *box;
- GtkBoxChild *child;
- GdkRectangle child_area;
- GList *children;
+ GtkBoxPrivate *private;
+ GList *list;
+ GtkBoxChild *child_info = NULL;
+
+ g_return_if_fail (GTK_IS_BOX (box));
+ g_return_if_fail (GTK_IS_WIDGET (child));
- g_return_if_fail (widget != NULL);
- g_return_if_fail (GTK_IS_BOX (widget));
+ private = box->priv;
- if (GTK_WIDGET_DRAWABLE (widget))
+ list = private->children;
+ while (list)
{
- box = GTK_BOX (widget);
+ child_info = list->data;
+ if (child_info->widget == child)
+ break;
- children = box->children;
- while (children)
- {
- child = children->data;
- children = children->next;
+ list = list->next;
+ }
- if (gtk_widget_intersect (child->widget, area, &child_area))
- gtk_widget_draw (child->widget, &child_area);
- }
+ if (list)
+ {
+ if (expand)
+ *expand = child_info->expand;
+ if (fill)
+ *fill = child_info->fill;
+ if (padding)
+ *padding = child_info->padding;
+ if (pack_type)
+ *pack_type = child_info->pack;
}
}
-static gint
-gtk_box_expose (GtkWidget *widget,
- GdkEventExpose *event)
+/**
+ * gtk_box_set_child_packing:
+ * @box: a #GtkBox
+ * @child: the #GtkWidget of the child to set
+ * @expand: the new value of the #GtkBox:expand child property
+ * @fill: the new value of the #GtkBox:fill child property
+ * @padding: the new value of the #GtkBox:padding child property
+ * @pack_type: the new value of the #GtkBox:pack-type child property
+ *
+ * Sets the way @child is packed into @box.
+ */
+void
+gtk_box_set_child_packing (GtkBox *box,
+ GtkWidget *child,
+ gboolean expand,
+ gboolean fill,
+ guint padding,
+ GtkPackType pack_type)
{
- GtkBox *box;
- GtkBoxChild *child;
- GdkEventExpose child_event;
- GList *children;
+ GtkBoxPrivate *private;
+ GList *list;
+ GtkBoxChild *child_info = NULL;
+
+ g_return_if_fail (GTK_IS_BOX (box));
+ g_return_if_fail (GTK_IS_WIDGET (child));
- g_return_val_if_fail (widget != NULL, FALSE);
- g_return_val_if_fail (GTK_IS_BOX (widget), FALSE);
- g_return_val_if_fail (event != NULL, FALSE);
+ private = box->priv;
- if (GTK_WIDGET_DRAWABLE (widget))
+ list = private->children;
+ while (list)
{
- box = GTK_BOX (widget);
-
- child_event = *event;
+ child_info = list->data;
+ if (child_info->widget == child)
+ break;
- children = box->children;
- while (children)
- {
- child = children->data;
- children = children->next;
+ list = list->next;
+ }
- if (GTK_WIDGET_NO_WINDOW (child->widget) &&
- gtk_widget_intersect (child->widget, &event->area, &child_event.area))
- gtk_widget_event (child->widget, (GdkEvent*) &child_event);
- }
+ gtk_widget_freeze_child_notify (child);
+ if (list)
+ {
+ gboolean expanded;
+
+ expanded = expand != FALSE;
+
+ /* avoid setting expand if unchanged, since queue_compute_expand
+ * can be expensive-ish
+ */
+ if (child_info->expand != expanded)
+ {
+ child_info->expand = expand != FALSE;
+ gtk_widget_queue_compute_expand (GTK_WIDGET (box));
+ gtk_widget_child_notify (child, "expand");
+ }
+
+ child_info->fill = fill != FALSE;
+ gtk_widget_child_notify (child, "fill");
+ child_info->padding = padding;
+ gtk_widget_child_notify (child, "padding");
+ if (pack_type != GTK_PACK_END)
+ pack_type = GTK_PACK_START;
+ if (child_info->pack != pack_type)
+ {
+ child_info->pack = pack_type;
+ gtk_widget_child_notify (child, "pack-type");
+ gtk_box_invalidate_order (box);
+ }
+
+ if (gtk_widget_get_visible (child)
+ && gtk_widget_get_visible (GTK_WIDGET (box)))
+ gtk_widget_queue_resize (child);
}
+ gtk_widget_thaw_child_notify (child);
+}
+
+void
+_gtk_box_set_old_defaults (GtkBox *box)
+{
+ GtkBoxPrivate *private;
+
+ g_return_if_fail (GTK_IS_BOX (box));
- return FALSE;
+ private = box->priv;
+
+ private->default_expand = TRUE;
}
static void
gtk_box_add (GtkContainer *container,
GtkWidget *widget)
{
- g_return_if_fail (container != NULL);
- g_return_if_fail (GTK_IS_BOX (container));
- g_return_if_fail (widget != NULL);
+ GtkBoxPrivate *priv = GTK_BOX (container)->priv;
- gtk_box_pack_start_defaults (GTK_BOX (container), widget);
+ gtk_box_pack_start (GTK_BOX (container), widget,
+ priv->default_expand,
+ TRUE,
+ 0);
}
static void
gtk_box_remove (GtkContainer *container,
GtkWidget *widget)
{
- GtkBox *box;
+ GtkBox *box = GTK_BOX (container);
+ GtkBoxPrivate *priv = box->priv;
GtkBoxChild *child;
GList *children;
- g_return_if_fail (container != NULL);
- g_return_if_fail (GTK_IS_BOX (container));
- g_return_if_fail (widget != NULL);
-
- box = GTK_BOX (container);
-
- children = box->children;
+ children = priv->children;
while (children)
{
child = children->data;
if (child->widget == widget)
{
+ gboolean was_visible;
+
+ g_signal_handlers_disconnect_by_func (widget,
+ box_child_visibility_notify_cb,
+ box);
+
+ was_visible = gtk_widget_get_visible (widget);
gtk_widget_unparent (widget);
- box->children = g_list_remove_link (box->children, children);
+ priv->children = g_list_remove_link (priv->children, children);
g_list_free (children);
g_free (child);
- if (GTK_WIDGET_VISIBLE (widget) && GTK_WIDGET_VISIBLE (container))
- gtk_widget_queue_resize (GTK_WIDGET (container));
+ /* queue resize regardless of gtk_widget_get_visible (container),
+ * since that's what is needed by toplevels.
+ */
+ if (was_visible)
+ {
+ gtk_box_invalidate_order (box);
+ gtk_widget_queue_resize (GTK_WIDGET (container));
+ }
break;
}
}
static void
-gtk_box_foreach (GtkContainer *container,
- GtkCallback callback,
- gpointer callback_data)
+gtk_box_forall (GtkContainer *container,
+ gboolean include_internals,
+ GtkCallback callback,
+ gpointer callback_data)
{
- GtkBox *box;
+ GtkBox *box = GTK_BOX (container);
+ GtkBoxPrivate *priv = box->priv;
GtkBoxChild *child;
GList *children;
- g_return_if_fail (container != NULL);
- g_return_if_fail (GTK_IS_BOX (container));
- g_return_if_fail (callback != NULL);
-
- box = GTK_BOX (container);
-
- children = box->children;
+ children = priv->children;
while (children)
{
child = children->data;
(* callback) (child->widget, callback_data);
}
- children = g_list_last (box->children);
+ children = g_list_last (priv->children);
while (children)
{
child = children->data;
(* callback) (child->widget, callback_data);
}
}
+
+GList *
+_gtk_box_get_children (GtkBox *box)
+{
+ GtkBoxPrivate *priv;
+ GtkBoxChild *child;
+ GList *children;
+ GList *retval = NULL;
+
+ g_return_val_if_fail (GTK_IS_BOX (box), NULL);
+
+ priv = box->priv;
+
+ children = priv->children;
+ while (children)
+ {
+ child = children->data;
+ children = children->next;
+
+ retval = g_list_prepend (retval, child->widget);
+ }
+
+ return g_list_reverse (retval);
+}
projects / ~andy / gtk / blobdiff