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->spacing_set = FALSE;
159 box->homogeneous = FALSE;
163 gtk_box_set_property (GObject *object,
170 box = GTK_BOX (object);
175 gtk_box_set_spacing (box, g_value_get_int (value));
177 case PROP_HOMOGENEOUS:
178 gtk_box_set_homogeneous (box, g_value_get_boolean (value));
181 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
186 static void gtk_box_get_property (GObject *object,
193 box = GTK_BOX (object);
198 g_value_set_int (value, box->spacing);
200 case PROP_HOMOGENEOUS:
201 g_value_set_boolean (value, box->homogeneous);
204 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
210 gtk_box_child_type (GtkContainer *container)
212 return GTK_TYPE_WIDGET;
216 gtk_box_set_child_property (GtkContainer *container,
225 GtkPackType pack_type = 0;
227 if (property_id != CHILD_PROP_POSITION)
228 gtk_box_query_child_packing (GTK_BOX (container),
236 case CHILD_PROP_EXPAND:
237 gtk_box_set_child_packing (GTK_BOX (container),
239 g_value_get_boolean (value),
244 case CHILD_PROP_FILL:
245 gtk_box_set_child_packing (GTK_BOX (container),
248 g_value_get_boolean (value),
252 case CHILD_PROP_PADDING:
253 gtk_box_set_child_packing (GTK_BOX (container),
257 g_value_get_uint (value),
260 case CHILD_PROP_PACK_TYPE:
261 gtk_box_set_child_packing (GTK_BOX (container),
266 g_value_get_enum (value));
268 case CHILD_PROP_POSITION:
269 gtk_box_reorder_child (GTK_BOX (container),
271 g_value_get_int (value));
274 GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
280 gtk_box_get_child_property (GtkContainer *container,
289 GtkPackType pack_type = 0;
292 if (property_id != CHILD_PROP_POSITION)
293 gtk_box_query_child_packing (GTK_BOX (container),
302 case CHILD_PROP_EXPAND:
303 g_value_set_boolean (value, expand);
305 case CHILD_PROP_FILL:
306 g_value_set_boolean (value, fill);
308 case CHILD_PROP_PADDING:
309 g_value_set_uint (value, padding);
311 case CHILD_PROP_PACK_TYPE:
312 g_value_set_enum (value, pack_type);
314 case CHILD_PROP_POSITION:
316 for (list = GTK_BOX (container)->children; list; list = list->next)
318 GtkBoxChild *child_entry;
320 child_entry = list->data;
321 if (child_entry->widget == child)
325 g_value_set_int (value, list ? i : -1);
328 GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
334 gtk_box_pack (GtkBox *box,
339 GtkPackType pack_type)
341 GtkBoxChild *child_info;
343 g_return_if_fail (GTK_IS_BOX (box));
344 g_return_if_fail (GTK_IS_WIDGET (child));
345 g_return_if_fail (child->parent == NULL);
347 child_info = g_new (GtkBoxChild, 1);
348 child_info->widget = child;
349 child_info->padding = padding;
350 child_info->expand = expand ? TRUE : FALSE;
351 child_info->fill = fill ? TRUE : FALSE;
352 child_info->pack = pack_type;
353 child_info->is_secondary = FALSE;
355 box->children = g_list_append (box->children, child_info);
357 gtk_widget_freeze_child_notify (child);
359 gtk_widget_set_parent (child, GTK_WIDGET (box));
361 gtk_widget_child_notify (child, "expand");
362 gtk_widget_child_notify (child, "fill");
363 gtk_widget_child_notify (child, "padding");
364 gtk_widget_child_notify (child, "pack-type");
365 gtk_widget_child_notify (child, "position");
366 gtk_widget_thaw_child_notify (child);
370 * gtk_box_pack_start:
372 * @child: the #GtkWidget to be added to @box
373 * @expand: %TRUE if the new child is to be given extra space allocated to
374 * @box. The extra space will be divided evenly between all children of
375 * @box that use this option
376 * @fill: %TRUE if space given to @child by the @expand option is
377 * actually allocated to @child, rather than just padding it. This
378 * parameter has no effect if @expand is set to %FALSE. A child is
379 * always allocated the full height of a #GtkHBox and the full width
380 * of a #GtkVBox. This option affects the other dimension
381 * @padding: extra space in pixels to put between this child and its
382 * neighbors, over and above the global amount specified by
383 * #GtkBox:spacing property. If @child is a widget at one of the
384 * reference ends of @box, then @padding pixels are also put between
385 * @child and the reference edge of @box
387 * Adds @child to @box, packed with reference to the start of @box.
388 * The @child is packed after any other child packed with reference
389 * to the start of @box.
392 gtk_box_pack_start (GtkBox *box,
398 gtk_box_pack (box, child, expand, fill, padding, GTK_PACK_START);
404 * @child: the #GtkWidget to be added to @box
405 * @expand: %TRUE if the new child is to be given extra space allocated
406 * to @box. The extra space will be divided evenly between all children
407 * of @box that use this option
408 * @fill: %TRUE if space given to @child by the @expand option is
409 * actually allocated to @child, rather than just padding it. This
410 * parameter has no effect if @expand is set to %FALSE. A child is
411 * always allocated the full height of a #GtkHBox and the full width
412 * of a #GtkVBox. This option affects the other dimension
413 * @padding: extra space in pixels to put between this child and its
414 * neighbors, over and above the global amount specified by
415 * #GtkBox:spacing property. If @child is a widget at one of the
416 * reference ends of @box, then @padding pixels are also put between
417 * @child and the reference edge of @box
419 * Adds @child to @box, packed with reference to the end of @box.
420 * The @child is packed after (away from end of) any other child
421 * packed with reference to the end of @box.
424 gtk_box_pack_end (GtkBox *box,
430 gtk_box_pack (box, child, expand, fill, padding, GTK_PACK_END);
434 * gtk_box_pack_start_defaults:
436 * @widget: the #GtkWidget to be added to @box
438 * Adds @widget to @box, packed with reference to the start of @box.
439 * The child is packed after any other child packed with reference
440 * to the start of @box.
442 * Parameters for how to pack the child @widget, #GtkBox:expand,
443 * #GtkBox:fill and #GtkBox:padding, are given their default
444 * values, %TRUE, %TRUE, and 0, respectively.
446 * Deprecated: 2.14: Use gtk_box_pack_start()
449 gtk_box_pack_start_defaults (GtkBox *box,
452 gtk_box_pack_start (box, child, TRUE, TRUE, 0);
456 * gtk_box_pack_end_defaults:
458 * @widget: the #GtkWidget to be added to @box
460 * Adds @widget to @box, packed with reference to the end of @box.
461 * The child is packed after any other child packed with reference
462 * to the start of @box.
464 * Parameters for how to pack the child @widget, #GtkBox:expand,
465 * #GtkBox:fill and #GtkBox:padding, are given their default
466 * values, %TRUE, %TRUE, and 0, respectively.
468 * Deprecated: 2.14: Use gtk_box_pack_end()
471 gtk_box_pack_end_defaults (GtkBox *box,
474 gtk_box_pack_end (box, child, TRUE, TRUE, 0);
478 * gtk_box_set_homogeneous:
480 * @homogeneous: a boolean value, %TRUE to create equal allotments,
481 * %FALSE for variable allotments
483 * Sets the #GtkBox:homogeneous property of @box, controlling
484 * whether or not all children of @box are given equal space
488 gtk_box_set_homogeneous (GtkBox *box,
489 gboolean homogeneous)
491 g_return_if_fail (GTK_IS_BOX (box));
493 if ((homogeneous ? TRUE : FALSE) != box->homogeneous)
495 box->homogeneous = homogeneous ? TRUE : FALSE;
496 g_object_notify (G_OBJECT (box), "homogeneous");
497 gtk_widget_queue_resize (GTK_WIDGET (box));
502 * gtk_box_get_homogeneous:
505 * Returns whether the box is homogeneous (all children are the
506 * same size). See gtk_box_set_homogeneous().
508 * Return value: %TRUE if the box is homogeneous.
511 gtk_box_get_homogeneous (GtkBox *box)
513 g_return_val_if_fail (GTK_IS_BOX (box), FALSE);
515 return box->homogeneous;
519 * gtk_box_set_spacing:
521 * @spacing: the number of pixels to put between children
523 * Sets the #GtkBox:spacing property of @box, which is the
524 * number of pixels to place between children of @box.
527 gtk_box_set_spacing (GtkBox *box,
530 g_return_if_fail (GTK_IS_BOX (box));
532 if (spacing != box->spacing)
534 box->spacing = spacing;
535 box->spacing_set = TRUE;
537 g_object_notify (G_OBJECT (box), "spacing");
539 gtk_widget_queue_resize (GTK_WIDGET (box));
544 * gtk_box_get_spacing:
547 * Gets the value set by gtk_box_set_spacing().
549 * Return value: spacing between children
552 gtk_box_get_spacing (GtkBox *box)
554 g_return_val_if_fail (GTK_IS_BOX (box), 0);
560 _gtk_box_set_spacing_set (GtkBox *box,
561 gboolean spacing_set)
563 g_return_if_fail (GTK_IS_BOX (box));
565 box->spacing_set = spacing_set;
569 _gtk_box_get_spacing_set (GtkBox *box)
571 g_return_val_if_fail (GTK_IS_BOX (box), FALSE);
573 return box->spacing_set;
577 * gtk_box_reorder_child:
579 * @child: the #GtkWidget to move
580 * @position: the new position for @child in the list of children
581 * of @box, starting from 0. If negative, indicates the end of
584 * Moves @child to a new @position in the list of @box children.
585 * The list is the <structfield>children</structfield> field of
586 * #GtkBox-struct, and contains both widgets packed #GTK_PACK_START
587 * as well as widgets packed #GTK_PACK_END, in the order that these
588 * widgets were added to @box.
590 * A widget's position in the @box children list determines where
591 * the widget is packed into @box. A child widget at some position
592 * in the list will be packed just after all other widgets of the
593 * same packing type that appear earlier in the list.
596 gtk_box_reorder_child (GtkBox *box,
602 GtkBoxChild *child_info = NULL;
605 g_return_if_fail (GTK_IS_BOX (box));
606 g_return_if_fail (GTK_IS_WIDGET (child));
608 old_link = box->children;
612 child_info = old_link->data;
613 if (child_info->widget == child)
616 old_link = old_link->next;
620 g_return_if_fail (old_link != NULL);
622 if (position == old_position)
625 box->children = g_list_delete_link (box->children, old_link);
630 new_link = g_list_nth (box->children, position);
632 box->children = g_list_insert_before (box->children, new_link, child_info);
634 gtk_widget_child_notify (child, "position");
635 if (GTK_WIDGET_VISIBLE (child) && GTK_WIDGET_VISIBLE (box))
636 gtk_widget_queue_resize (child);
640 * gtk_box_query_child_packing:
642 * @child: the #GtkWidget of the child to query
643 * @expand: pointer to return location for #GtkBox:expand child property
644 * @fill: pointer to return location for #GtkBox:fill child property
645 * @padding: pointer to return location for #GtkBox:padding child property
646 * @pack_type: pointer to return location for #GtkBox:pack-type child property
648 * Obtains information about how @child is packed into @box.
651 gtk_box_query_child_packing (GtkBox *box,
656 GtkPackType *pack_type)
659 GtkBoxChild *child_info = NULL;
661 g_return_if_fail (GTK_IS_BOX (box));
662 g_return_if_fail (GTK_IS_WIDGET (child));
664 list = box->children;
667 child_info = list->data;
668 if (child_info->widget == child)
677 *expand = child_info->expand;
679 *fill = child_info->fill;
681 *padding = child_info->padding;
683 *pack_type = child_info->pack;
688 * gtk_box_set_child_packing:
690 * @child: the #GtkWidget of the child to set
691 * @expand: the new value of the #GtkBox:expand child property
692 * @fill: the new value of the #GtkBox:fill child property
693 * @padding: the new value of the #GtkBox:padding child property
694 * @pack_type: the new value of the #GtkBox:pack-type child property
696 * Sets the way @child is packed into @box.
699 gtk_box_set_child_packing (GtkBox *box,
704 GtkPackType pack_type)
707 GtkBoxChild *child_info = NULL;
709 g_return_if_fail (GTK_IS_BOX (box));
710 g_return_if_fail (GTK_IS_WIDGET (child));
712 list = box->children;
715 child_info = list->data;
716 if (child_info->widget == child)
722 gtk_widget_freeze_child_notify (child);
725 child_info->expand = expand != FALSE;
726 gtk_widget_child_notify (child, "expand");
727 child_info->fill = fill != FALSE;
728 gtk_widget_child_notify (child, "fill");
729 child_info->padding = padding;
730 gtk_widget_child_notify (child, "padding");
731 if (pack_type == GTK_PACK_END)
732 child_info->pack = GTK_PACK_END;
734 child_info->pack = GTK_PACK_START;
735 gtk_widget_child_notify (child, "pack-type");
737 if (GTK_WIDGET_VISIBLE (child) && GTK_WIDGET_VISIBLE (box))
738 gtk_widget_queue_resize (child);
740 gtk_widget_thaw_child_notify (child);
744 gtk_box_add (GtkContainer *container,
747 gtk_box_pack_start (GTK_BOX (container), widget, TRUE, TRUE, 0);
751 gtk_box_remove (GtkContainer *container,
754 GtkBox *box = GTK_BOX (container);
758 children = box->children;
761 child = children->data;
763 if (child->widget == widget)
765 gboolean was_visible;
767 was_visible = GTK_WIDGET_VISIBLE (widget);
768 gtk_widget_unparent (widget);
770 box->children = g_list_remove_link (box->children, children);
771 g_list_free (children);
774 /* queue resize regardless of GTK_WIDGET_VISIBLE (container),
775 * since that's what is needed by toplevels.
778 gtk_widget_queue_resize (GTK_WIDGET (container));
783 children = children->next;
788 gtk_box_forall (GtkContainer *container,
789 gboolean include_internals,
790 GtkCallback callback,
791 gpointer callback_data)
793 GtkBox *box = GTK_BOX (container);
797 children = box->children;
800 child = children->data;
801 children = children->next;
803 if (child->pack == GTK_PACK_START)
804 (* callback) (child->widget, callback_data);
807 children = g_list_last (box->children);
810 child = children->data;
811 children = children->prev;
813 if (child->pack == GTK_PACK_END)
814 (* callback) (child->widget, callback_data);
818 #define __GTK_BOX_C__
819 #include "gtkaliasdef.c"