1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
29 #include "gtkprivate.h"
48 static void gtk_box_set_property (GObject *object,
52 static void gtk_box_get_property (GObject *object,
56 static void gtk_box_add (GtkContainer *container,
58 static void gtk_box_remove (GtkContainer *container,
60 static void gtk_box_forall (GtkContainer *container,
61 gboolean include_internals,
63 gpointer callback_data);
64 static void gtk_box_set_child_property (GtkContainer *container,
69 static void gtk_box_get_child_property (GtkContainer *container,
74 static GType gtk_box_child_type (GtkContainer *container);
77 G_DEFINE_ABSTRACT_TYPE (GtkBox, gtk_box, GTK_TYPE_CONTAINER)
80 gtk_box_class_init (GtkBoxClass *class)
82 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
83 GtkContainerClass *container_class = GTK_CONTAINER_CLASS (class);
85 gobject_class->set_property = gtk_box_set_property;
86 gobject_class->get_property = gtk_box_get_property;
88 container_class->add = gtk_box_add;
89 container_class->remove = gtk_box_remove;
90 container_class->forall = gtk_box_forall;
91 container_class->child_type = gtk_box_child_type;
92 container_class->set_child_property = gtk_box_set_child_property;
93 container_class->get_child_property = gtk_box_get_child_property;
95 g_object_class_install_property (gobject_class,
97 g_param_spec_int ("spacing",
99 P_("The amount of space between children"),
103 GTK_PARAM_READWRITE));
105 g_object_class_install_property (gobject_class,
107 g_param_spec_boolean ("homogeneous",
109 P_("Whether the children should all be the same size"),
111 GTK_PARAM_READWRITE));
113 gtk_container_class_install_child_property (container_class,
115 g_param_spec_boolean ("expand",
117 P_("Whether the child should receive extra space when the parent grows"),
119 GTK_PARAM_READWRITE));
120 gtk_container_class_install_child_property (container_class,
122 g_param_spec_boolean ("fill",
124 P_("Whether extra space given to the child should be allocated to the child or used as padding"),
126 GTK_PARAM_READWRITE));
127 gtk_container_class_install_child_property (container_class,
129 g_param_spec_uint ("padding",
131 P_("Extra space to put between the child and its neighbors, in pixels"),
133 GTK_PARAM_READWRITE));
134 gtk_container_class_install_child_property (container_class,
135 CHILD_PROP_PACK_TYPE,
136 g_param_spec_enum ("pack-type",
138 P_("A GtkPackType indicating whether the child is packed with reference to the start or end of the parent"),
139 GTK_TYPE_PACK_TYPE, GTK_PACK_START,
140 GTK_PARAM_READWRITE));
141 gtk_container_class_install_child_property (container_class,
143 g_param_spec_int ("position",
145 P_("The index of the child in the parent"),
147 GTK_PARAM_READWRITE));
151 gtk_box_init (GtkBox *box)
153 GTK_WIDGET_SET_FLAGS (box, GTK_NO_WINDOW);
154 gtk_widget_set_redraw_on_allocate (GTK_WIDGET (box), FALSE);
156 box->children = NULL;
158 box->homogeneous = FALSE;
162 gtk_box_set_property (GObject *object,
169 box = GTK_BOX (object);
174 gtk_box_set_spacing (box, g_value_get_int (value));
176 case PROP_HOMOGENEOUS:
177 gtk_box_set_homogeneous (box, g_value_get_boolean (value));
180 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
185 static void gtk_box_get_property (GObject *object,
192 box = GTK_BOX (object);
197 g_value_set_int (value, box->spacing);
199 case PROP_HOMOGENEOUS:
200 g_value_set_boolean (value, box->homogeneous);
203 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
209 gtk_box_child_type (GtkContainer *container)
211 return GTK_TYPE_WIDGET;
215 gtk_box_set_child_property (GtkContainer *container,
224 GtkPackType pack_type = 0;
226 if (property_id != CHILD_PROP_POSITION)
227 gtk_box_query_child_packing (GTK_BOX (container),
235 case CHILD_PROP_EXPAND:
236 gtk_box_set_child_packing (GTK_BOX (container),
238 g_value_get_boolean (value),
243 case CHILD_PROP_FILL:
244 gtk_box_set_child_packing (GTK_BOX (container),
247 g_value_get_boolean (value),
251 case CHILD_PROP_PADDING:
252 gtk_box_set_child_packing (GTK_BOX (container),
256 g_value_get_uint (value),
259 case CHILD_PROP_PACK_TYPE:
260 gtk_box_set_child_packing (GTK_BOX (container),
265 g_value_get_enum (value));
267 case CHILD_PROP_POSITION:
268 gtk_box_reorder_child (GTK_BOX (container),
270 g_value_get_int (value));
273 GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
279 gtk_box_get_child_property (GtkContainer *container,
288 GtkPackType pack_type = 0;
291 if (property_id != CHILD_PROP_POSITION)
292 gtk_box_query_child_packing (GTK_BOX (container),
301 case CHILD_PROP_EXPAND:
302 g_value_set_boolean (value, expand);
304 case CHILD_PROP_FILL:
305 g_value_set_boolean (value, fill);
307 case CHILD_PROP_PADDING:
308 g_value_set_uint (value, padding);
310 case CHILD_PROP_PACK_TYPE:
311 g_value_set_enum (value, pack_type);
313 case CHILD_PROP_POSITION:
315 for (list = GTK_BOX (container)->children; list; list = list->next)
317 GtkBoxChild *child_entry;
319 child_entry = list->data;
320 if (child_entry->widget == child)
324 g_value_set_int (value, list ? i : -1);
327 GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
333 gtk_box_pack (GtkBox *box,
338 GtkPackType pack_type)
340 GtkBoxChild *child_info;
342 g_return_if_fail (GTK_IS_BOX (box));
343 g_return_if_fail (GTK_IS_WIDGET (child));
344 g_return_if_fail (child->parent == NULL);
346 child_info = g_new (GtkBoxChild, 1);
347 child_info->widget = child;
348 child_info->padding = padding;
349 child_info->expand = expand ? TRUE : FALSE;
350 child_info->fill = fill ? TRUE : FALSE;
351 child_info->pack = pack_type;
352 child_info->is_secondary = FALSE;
354 box->children = g_list_append (box->children, child_info);
356 gtk_widget_freeze_child_notify (child);
358 gtk_widget_set_parent (child, GTK_WIDGET (box));
360 gtk_widget_child_notify (child, "expand");
361 gtk_widget_child_notify (child, "fill");
362 gtk_widget_child_notify (child, "padding");
363 gtk_widget_child_notify (child, "pack-type");
364 gtk_widget_child_notify (child, "position");
365 gtk_widget_thaw_child_notify (child);
369 * gtk_box_pack_start:
371 * @child: the #GtkWidget to be added to @box
372 * @expand: %TRUE if the new child is to be given extra space allocated to
373 * @box. The extra space will be divided evenly between all children of
374 * @box that use this option
375 * @fill: %TRUE if space given to @child by the @expand option is
376 * actually allocated to @child, rather than just padding it. This
377 * parameter has no effect if @expand is set to %FALSE. A child is
378 * always allocated the full height of a #GtkHBox and the full width
379 * of a #GtkVBox. This option affects the other dimension
380 * @padding: extra space in pixels to put between this child and its
381 * neighbors, over and above the global amount specified by
382 * #GtkBox:spacing property. If @child is a widget at one of the
383 * reference ends of @box, then @padding pixels are also put between
384 * @child and the reference edge of @box
386 * Adds @child to @box, packed with reference to the start of @box.
387 * The @child is packed after any other child packed with reference
388 * to the start of @box.
391 gtk_box_pack_start (GtkBox *box,
397 gtk_box_pack (box, child, expand, fill, padding, GTK_PACK_START);
403 * @child: the #GtkWidget to be added to @box
404 * @expand: %TRUE if the new child is to be given extra space allocated
405 * to @box. The extra space will be divided evenly between all children
406 * of @box that use this option
407 * @fill: %TRUE if space given to @child by the @expand option is
408 * actually allocated to @child, rather than just padding it. This
409 * parameter has no effect if @expand is set to %FALSE. A child is
410 * always allocated the full height of a #GtkHBox and the full width
411 * of a #GtkVBox. This option affects the other dimension
412 * @padding: extra space in pixels to put between this child and its
413 * neighbors, over and above the global amount specified by
414 * #GtkBox:spacing property. If @child is a widget at one of the
415 * reference ends of @box, then @padding pixels are also put between
416 * @child and the reference edge of @box
418 * Adds @child to @box, packed with reference to the end of @box.
419 * The @child is packed after (away from end of) any other child
420 * packed with reference to the end of @box.
423 gtk_box_pack_end (GtkBox *box,
429 gtk_box_pack (box, child, expand, fill, padding, GTK_PACK_END);
433 * gtk_box_pack_start_defaults:
435 * @widget: the #GtkWidget to be added to @box
437 * Adds @widget to @box, packed with reference to the start of @box.
438 * The child is packed after any other child packed with reference
439 * to the start of @box.
441 * Parameters for how to pack the child @widget, #GtkBox:expand,
442 * #GtkBox:fill and #GtkBox:padding, are given their default
443 * values, %TRUE, %TRUE, and 0, respectively.
445 * Deprecated: 2.14: Use gtk_box_pack_start()
448 gtk_box_pack_start_defaults (GtkBox *box,
451 gtk_box_pack_start (box, child, TRUE, TRUE, 0);
455 * gtk_box_pack_end_defaults:
457 * @widget: the #GtkWidget to be added to @box
459 * Adds @widget to @box, packed with reference to the end of @box.
460 * The child is packed after any other child packed with reference
461 * to the start of @box.
463 * Parameters for how to pack the child @widget, #GtkBox:expand,
464 * #GtkBox:fill and #GtkBox:padding, are given their default
465 * values, %TRUE, %TRUE, and 0, respectively.
467 * Deprecated: 2.14: Use gtk_box_pack_end()
470 gtk_box_pack_end_defaults (GtkBox *box,
473 gtk_box_pack_end (box, child, TRUE, TRUE, 0);
477 * gtk_box_set_homogeneous:
479 * @homogeneous: a boolean value, %TRUE to create equal allotments,
480 * %FALSE for variable allotments
482 * Sets the #GtkBox:homogeneous property of @box, controlling
483 * whether or not all children of @box are given equal space
487 gtk_box_set_homogeneous (GtkBox *box,
488 gboolean homogeneous)
490 g_return_if_fail (GTK_IS_BOX (box));
492 if ((homogeneous ? TRUE : FALSE) != box->homogeneous)
494 box->homogeneous = homogeneous ? TRUE : FALSE;
495 g_object_notify (G_OBJECT (box), "homogeneous");
496 gtk_widget_queue_resize (GTK_WIDGET (box));
501 * gtk_box_get_homogeneous:
504 * Returns whether the box is homogeneous (all children are the
505 * same size). See gtk_box_set_homogeneous().
507 * Return value: %TRUE if the box is homogeneous.
510 gtk_box_get_homogeneous (GtkBox *box)
512 g_return_val_if_fail (GTK_IS_BOX (box), FALSE);
514 return box->homogeneous;
518 * gtk_box_set_spacing:
520 * @spacing: the number of pixels to put between children
522 * Sets the #GtkBox:spacing property of @box, which is the
523 * number of pixels to place between children of @box.
526 gtk_box_set_spacing (GtkBox *box,
529 g_return_if_fail (GTK_IS_BOX (box));
531 if (spacing != box->spacing)
533 box->spacing = spacing;
534 g_object_notify (G_OBJECT (box), "spacing");
535 gtk_widget_queue_resize (GTK_WIDGET (box));
540 * gtk_box_get_spacing:
543 * Gets the value set by gtk_box_set_spacing().
545 * Return value: spacing between children
548 gtk_box_get_spacing (GtkBox *box)
550 g_return_val_if_fail (GTK_IS_BOX (box), 0);
556 * gtk_box_reorder_child:
558 * @child: the #GtkWidget to move
559 * @position: the new position for @child in the list of children
560 * of @box, starting from 0. If negative, indicates the end of
563 * Moves @child to a new @position in the list of @box children.
564 * The list is the <structfield>children</structfield> field of
565 * #GtkBox-struct, and contains both widgets packed #GTK_PACK_START
566 * as well as widgets packed #GTK_PACK_END, in the order that these
567 * widgets were added to @box.
569 * A widget's position in the @box children list determines where
570 * the widget is packed into @box. A child widget at some position
571 * in the list will be packed just after all other widgets of the
572 * same packing type that appear earlier in the list.
575 gtk_box_reorder_child (GtkBox *box,
581 GtkBoxChild *child_info = NULL;
584 g_return_if_fail (GTK_IS_BOX (box));
585 g_return_if_fail (GTK_IS_WIDGET (child));
587 old_link = box->children;
591 child_info = old_link->data;
592 if (child_info->widget == child)
595 old_link = old_link->next;
599 g_return_if_fail (old_link != NULL);
601 if (position == old_position)
604 box->children = g_list_delete_link (box->children, old_link);
609 new_link = g_list_nth (box->children, position);
611 box->children = g_list_insert_before (box->children, new_link, child_info);
613 gtk_widget_child_notify (child, "position");
614 if (GTK_WIDGET_VISIBLE (child) && GTK_WIDGET_VISIBLE (box))
615 gtk_widget_queue_resize (child);
619 * gtk_box_query_child_packing:
621 * @child: the #GtkWidget of the child to query
622 * @expand: pointer to return location for #GtkBox:expand child property
623 * @fill: pointer to return location for #GtkBox:fill child property
624 * @padding: pointer to return location for #GtkBox:padding child property
625 * @pack_type: pointer to return location for #GtkBox:pack-type child property
627 * Obtains information about how @child is packed into @box.
630 gtk_box_query_child_packing (GtkBox *box,
635 GtkPackType *pack_type)
638 GtkBoxChild *child_info = NULL;
640 g_return_if_fail (GTK_IS_BOX (box));
641 g_return_if_fail (GTK_IS_WIDGET (child));
643 list = box->children;
646 child_info = list->data;
647 if (child_info->widget == child)
656 *expand = child_info->expand;
658 *fill = child_info->fill;
660 *padding = child_info->padding;
662 *pack_type = child_info->pack;
667 * gtk_box_set_child_packing:
669 * @child: the #GtkWidget of the child to set
670 * @expand: the new value of the #GtkBox:expand child property
671 * @fill: the new value of the #GtkBox:fill child property
672 * @padding: the new value of the #GtkBox:padding child property
673 * @pack_type: the new value of the #GtkBox:pack-type child property
675 * Sets the way @child is packed into @box.
678 gtk_box_set_child_packing (GtkBox *box,
683 GtkPackType pack_type)
686 GtkBoxChild *child_info = NULL;
688 g_return_if_fail (GTK_IS_BOX (box));
689 g_return_if_fail (GTK_IS_WIDGET (child));
691 list = box->children;
694 child_info = list->data;
695 if (child_info->widget == child)
701 gtk_widget_freeze_child_notify (child);
704 child_info->expand = expand != FALSE;
705 gtk_widget_child_notify (child, "expand");
706 child_info->fill = fill != FALSE;
707 gtk_widget_child_notify (child, "fill");
708 child_info->padding = padding;
709 gtk_widget_child_notify (child, "padding");
710 if (pack_type == GTK_PACK_END)
711 child_info->pack = GTK_PACK_END;
713 child_info->pack = GTK_PACK_START;
714 gtk_widget_child_notify (child, "pack-type");
716 if (GTK_WIDGET_VISIBLE (child) && GTK_WIDGET_VISIBLE (box))
717 gtk_widget_queue_resize (child);
719 gtk_widget_thaw_child_notify (child);
723 gtk_box_add (GtkContainer *container,
726 gtk_box_pack_start (GTK_BOX (container), widget, TRUE, TRUE, 0);
730 gtk_box_remove (GtkContainer *container,
733 GtkBox *box = GTK_BOX (container);
737 children = box->children;
740 child = children->data;
742 if (child->widget == widget)
744 gboolean was_visible;
746 was_visible = GTK_WIDGET_VISIBLE (widget);
747 gtk_widget_unparent (widget);
749 box->children = g_list_remove_link (box->children, children);
750 g_list_free (children);
753 /* queue resize regardless of GTK_WIDGET_VISIBLE (container),
754 * since that's what is needed by toplevels.
757 gtk_widget_queue_resize (GTK_WIDGET (container));
762 children = children->next;
767 gtk_box_forall (GtkContainer *container,
768 gboolean include_internals,
769 GtkCallback callback,
770 gpointer callback_data)
772 GtkBox *box = GTK_BOX (container);
776 children = box->children;
779 child = children->data;
780 children = children->next;
782 if (child->pack == GTK_PACK_START)
783 (* callback) (child->widget, callback_data);
786 children = g_list_last (box->children);
789 child = children->data;
790 children = children->prev;
792 if (child->pack == GTK_PACK_END)
793 (* callback) (child->widget, callback_data);
797 #define __GTK_BOX_C__
798 #include "gtkaliasdef.c"