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/.
44 static void gtk_box_class_init (GtkBoxClass *klass);
45 static void gtk_box_init (GtkBox *box);
46 static void gtk_box_get_arg (GtkObject *object,
49 static void gtk_box_set_arg (GtkObject *object,
52 static void gtk_box_map (GtkWidget *widget);
53 static void gtk_box_unmap (GtkWidget *widget);
54 static gint gtk_box_expose (GtkWidget *widget,
55 GdkEventExpose *event);
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_arg (GtkContainer *container,
68 static void gtk_box_get_child_arg (GtkContainer *container,
72 static GtkType gtk_box_child_type (GtkContainer *container);
75 static GtkContainerClass *parent_class = NULL;
79 gtk_box_get_type (void)
81 static GtkType box_type = 0;
85 static const GtkTypeInfo box_info =
90 (GtkClassInitFunc) gtk_box_class_init,
91 (GtkObjectInitFunc) gtk_box_init,
92 /* reserved_1 */ NULL,
93 /* reserved_2 */ NULL,
94 (GtkClassInitFunc) NULL,
97 box_type = gtk_type_unique (GTK_TYPE_CONTAINER, &box_info);
104 gtk_box_class_init (GtkBoxClass *class)
106 GtkObjectClass *object_class;
107 GtkWidgetClass *widget_class;
108 GtkContainerClass *container_class;
110 object_class = (GtkObjectClass*) class;
111 widget_class = (GtkWidgetClass*) class;
112 container_class = (GtkContainerClass*) class;
114 parent_class = gtk_type_class (GTK_TYPE_CONTAINER);
116 gtk_object_add_arg_type ("GtkBox::spacing", GTK_TYPE_INT, GTK_ARG_READWRITE, ARG_SPACING);
117 gtk_object_add_arg_type ("GtkBox::homogeneous", GTK_TYPE_BOOL, GTK_ARG_READWRITE, ARG_HOMOGENEOUS);
118 gtk_container_add_child_arg_type ("GtkBox::expand", GTK_TYPE_BOOL, GTK_ARG_READWRITE, CHILD_ARG_EXPAND);
119 gtk_container_add_child_arg_type ("GtkBox::fill", GTK_TYPE_BOOL, GTK_ARG_READWRITE, CHILD_ARG_FILL);
120 gtk_container_add_child_arg_type ("GtkBox::padding", GTK_TYPE_UINT, GTK_ARG_READWRITE, CHILD_ARG_PADDING);
121 gtk_container_add_child_arg_type ("GtkBox::pack_type", GTK_TYPE_PACK_TYPE, GTK_ARG_READWRITE, CHILD_ARG_PACK_TYPE);
122 gtk_container_add_child_arg_type ("GtkBox::position", GTK_TYPE_INT, GTK_ARG_READWRITE, CHILD_ARG_POSITION);
124 object_class->set_arg = gtk_box_set_arg;
125 object_class->get_arg = gtk_box_get_arg;
127 widget_class->map = gtk_box_map;
128 widget_class->unmap = gtk_box_unmap;
129 widget_class->expose_event = gtk_box_expose;
131 container_class->add = gtk_box_add;
132 container_class->remove = gtk_box_remove;
133 container_class->forall = gtk_box_forall;
134 container_class->child_type = gtk_box_child_type;
135 container_class->set_child_arg = gtk_box_set_child_arg;
136 container_class->get_child_arg = gtk_box_get_child_arg;
140 gtk_box_init (GtkBox *box)
142 GTK_WIDGET_SET_FLAGS (box, GTK_NO_WINDOW);
144 box->children = NULL;
146 box->homogeneous = FALSE;
150 gtk_box_set_arg (GtkObject *object,
156 box = GTK_BOX (object);
161 gtk_box_set_spacing (box, GTK_VALUE_INT (*arg));
163 case ARG_HOMOGENEOUS:
164 gtk_box_set_homogeneous (box, GTK_VALUE_BOOL (*arg));
172 gtk_box_get_arg (GtkObject *object,
178 box = GTK_BOX (object);
183 GTK_VALUE_INT (*arg) = box->spacing;
185 case ARG_HOMOGENEOUS:
186 GTK_VALUE_BOOL (*arg) = box->homogeneous;
189 arg->type = GTK_TYPE_INVALID;
195 gtk_box_child_type (GtkContainer *container)
197 return GTK_TYPE_WIDGET;
201 gtk_box_set_child_arg (GtkContainer *container,
209 GtkPackType pack_type = 0;
211 if (arg_id != CHILD_ARG_POSITION)
212 gtk_box_query_child_packing (GTK_BOX (container),
221 case CHILD_ARG_EXPAND:
222 gtk_box_set_child_packing (GTK_BOX (container),
224 GTK_VALUE_BOOL (*arg),
230 gtk_box_set_child_packing (GTK_BOX (container),
233 GTK_VALUE_BOOL (*arg),
237 case CHILD_ARG_PADDING:
238 gtk_box_set_child_packing (GTK_BOX (container),
242 GTK_VALUE_UINT (*arg),
245 case CHILD_ARG_PACK_TYPE:
246 gtk_box_set_child_packing (GTK_BOX (container),
251 GTK_VALUE_ENUM (*arg));
253 case CHILD_ARG_POSITION:
254 gtk_box_reorder_child (GTK_BOX (container),
256 GTK_VALUE_INT (*arg));
264 gtk_box_get_child_arg (GtkContainer *container,
272 GtkPackType pack_type = 0;
275 if (arg_id != CHILD_ARG_POSITION)
276 gtk_box_query_child_packing (GTK_BOX (container),
285 case CHILD_ARG_EXPAND:
286 GTK_VALUE_BOOL (*arg) = expand;
289 GTK_VALUE_BOOL (*arg) = fill;
291 case CHILD_ARG_PADDING:
292 GTK_VALUE_UINT (*arg) = padding;
294 case CHILD_ARG_PACK_TYPE:
295 GTK_VALUE_ENUM (*arg) = pack_type;
297 case CHILD_ARG_POSITION:
298 GTK_VALUE_INT (*arg) = 0;
299 for (list = GTK_BOX (container)->children; list; list = list->next)
301 GtkBoxChild *child_entry;
303 child_entry = list->data;
304 if (child_entry->widget == child)
306 GTK_VALUE_INT (*arg)++;
309 GTK_VALUE_INT (*arg) = -1;
312 arg->type = GTK_TYPE_INVALID;
318 gtk_box_pack_start (GtkBox *box,
324 GtkBoxChild *child_info;
326 g_return_if_fail (box != NULL);
327 g_return_if_fail (GTK_IS_BOX (box));
328 g_return_if_fail (child != NULL);
329 g_return_if_fail (child->parent == NULL);
331 child_info = g_new (GtkBoxChild, 1);
332 child_info->widget = child;
333 child_info->padding = padding;
334 child_info->expand = expand ? TRUE : FALSE;
335 child_info->fill = fill ? TRUE : FALSE;
336 child_info->pack = GTK_PACK_START;
338 box->children = g_list_append (box->children, child_info);
340 gtk_widget_set_parent (child, GTK_WIDGET (box));
342 if (GTK_WIDGET_REALIZED (box))
343 gtk_widget_realize (child);
345 if (GTK_WIDGET_VISIBLE (box) && GTK_WIDGET_VISIBLE (child))
347 if (GTK_WIDGET_MAPPED (box))
348 gtk_widget_map (child);
350 gtk_widget_queue_resize (child);
355 gtk_box_pack_end (GtkBox *box,
361 GtkBoxChild *child_info;
363 g_return_if_fail (box != NULL);
364 g_return_if_fail (GTK_IS_BOX (box));
365 g_return_if_fail (child != NULL);
366 g_return_if_fail (child->parent == NULL);
368 child_info = g_new (GtkBoxChild, 1);
369 child_info->widget = child;
370 child_info->padding = padding;
371 child_info->expand = expand ? TRUE : FALSE;
372 child_info->fill = fill ? TRUE : FALSE;
373 child_info->pack = GTK_PACK_END;
375 box->children = g_list_append (box->children, child_info);
377 gtk_widget_set_parent (child, GTK_WIDGET (box));
379 if (GTK_WIDGET_REALIZED (box))
380 gtk_widget_realize (child);
382 if (GTK_WIDGET_VISIBLE (box) && GTK_WIDGET_VISIBLE (child))
384 if (GTK_WIDGET_MAPPED (box))
385 gtk_widget_map (child);
387 gtk_widget_queue_resize (child);
392 gtk_box_pack_start_defaults (GtkBox *box,
395 g_return_if_fail (box != NULL);
396 g_return_if_fail (GTK_IS_BOX (box));
397 g_return_if_fail (child != NULL);
399 gtk_box_pack_start (box, child, TRUE, TRUE, 0);
403 gtk_box_pack_end_defaults (GtkBox *box,
406 g_return_if_fail (box != NULL);
407 g_return_if_fail (GTK_IS_BOX (box));
408 g_return_if_fail (child != NULL);
410 gtk_box_pack_end (box, child, TRUE, TRUE, 0);
414 gtk_box_set_homogeneous (GtkBox *box,
415 gboolean homogeneous)
417 g_return_if_fail (box != NULL);
418 g_return_if_fail (GTK_IS_BOX (box));
420 if ((homogeneous ? TRUE : FALSE) != box->homogeneous)
422 box->homogeneous = homogeneous ? TRUE : FALSE;
423 gtk_widget_queue_resize (GTK_WIDGET (box));
428 gtk_box_set_spacing (GtkBox *box,
431 g_return_if_fail (box != NULL);
432 g_return_if_fail (GTK_IS_BOX (box));
434 if (spacing != box->spacing)
436 box->spacing = spacing;
437 gtk_widget_queue_resize (GTK_WIDGET (box));
442 * gtk_box_get_spacing:
445 * Gets the value set by gtk_box_set_spacing().
447 * Return value: spacing between children
450 gtk_box_get_spacing (GtkBox *box)
452 g_return_if_fail (GTK_IS_BOX (box));
458 gtk_box_reorder_child (GtkBox *box,
464 g_return_if_fail (box != NULL);
465 g_return_if_fail (GTK_IS_BOX (box));
466 g_return_if_fail (child != NULL);
468 list = box->children;
471 GtkBoxChild *child_info;
473 child_info = list->data;
474 if (child_info->widget == child)
480 if (list && box->children->next)
485 list->next->prev = list->prev;
487 list->prev->next = list->next;
489 box->children = list->next;
491 tmp_list = box->children;
492 while (position && tmp_list->next)
495 tmp_list = tmp_list->next;
500 tmp_list->next = list;
501 list->prev = tmp_list;
507 tmp_list->prev->next = list;
509 box->children = list;
510 list->prev = tmp_list->prev;
511 tmp_list->prev = list;
512 list->next = tmp_list;
515 if (GTK_WIDGET_VISIBLE (child) && GTK_WIDGET_VISIBLE (box))
516 gtk_widget_queue_resize (child);
521 gtk_box_query_child_packing (GtkBox *box,
526 GtkPackType *pack_type)
529 GtkBoxChild *child_info = NULL;
531 g_return_if_fail (box != NULL);
532 g_return_if_fail (GTK_IS_BOX (box));
533 g_return_if_fail (child != NULL);
535 list = box->children;
538 child_info = list->data;
539 if (child_info->widget == child)
548 *expand = child_info->expand;
550 *fill = child_info->fill;
552 *padding = child_info->padding;
554 *pack_type = child_info->pack;
559 gtk_box_set_child_packing (GtkBox *box,
564 GtkPackType pack_type)
567 GtkBoxChild *child_info = NULL;
569 g_return_if_fail (box != NULL);
570 g_return_if_fail (GTK_IS_BOX (box));
571 g_return_if_fail (child != NULL);
573 list = box->children;
576 child_info = list->data;
577 if (child_info->widget == child)
585 child_info->expand = expand != FALSE;
586 child_info->fill = fill != FALSE;
587 child_info->padding = padding;
588 if (pack_type == GTK_PACK_END)
589 child_info->pack = GTK_PACK_END;
591 child_info->pack = GTK_PACK_START;
593 if (GTK_WIDGET_VISIBLE (child) && GTK_WIDGET_VISIBLE (box))
594 gtk_widget_queue_resize (child);
599 gtk_box_map (GtkWidget *widget)
605 g_return_if_fail (widget != NULL);
606 g_return_if_fail (GTK_IS_BOX (widget));
608 box = GTK_BOX (widget);
609 GTK_WIDGET_SET_FLAGS (box, GTK_MAPPED);
611 children = box->children;
614 child = children->data;
615 children = children->next;
617 if (GTK_WIDGET_VISIBLE (child->widget) &&
618 !GTK_WIDGET_MAPPED (child->widget))
619 gtk_widget_map (child->widget);
624 gtk_box_unmap (GtkWidget *widget)
630 g_return_if_fail (widget != NULL);
631 g_return_if_fail (GTK_IS_BOX (widget));
633 box = GTK_BOX (widget);
634 GTK_WIDGET_UNSET_FLAGS (box, GTK_MAPPED);
636 children = box->children;
639 child = children->data;
640 children = children->next;
642 if (GTK_WIDGET_VISIBLE (child->widget) &&
643 GTK_WIDGET_MAPPED (child->widget))
644 gtk_widget_unmap (child->widget);
649 gtk_box_expose (GtkWidget *widget,
650 GdkEventExpose *event)
654 GdkEventExpose child_event;
657 g_return_val_if_fail (widget != NULL, FALSE);
658 g_return_val_if_fail (GTK_IS_BOX (widget), FALSE);
659 g_return_val_if_fail (event != NULL, FALSE);
661 if (GTK_WIDGET_DRAWABLE (widget))
663 box = GTK_BOX (widget);
665 child_event = *event;
667 children = box->children;
670 child = children->data;
671 children = children->next;
673 if (GTK_WIDGET_DRAWABLE (child->widget) &&
674 GTK_WIDGET_NO_WINDOW (child->widget) &&
675 gtk_widget_intersect (child->widget, &event->area, &child_event.area))
676 gtk_widget_event (child->widget, (GdkEvent*) &child_event);
684 gtk_box_add (GtkContainer *container,
687 g_return_if_fail (container != NULL);
688 g_return_if_fail (GTK_IS_BOX (container));
689 g_return_if_fail (widget != NULL);
691 gtk_box_pack_start_defaults (GTK_BOX (container), widget);
695 gtk_box_remove (GtkContainer *container,
702 g_return_if_fail (container != NULL);
703 g_return_if_fail (GTK_IS_BOX (container));
704 g_return_if_fail (widget != NULL);
706 box = GTK_BOX (container);
708 children = box->children;
711 child = children->data;
713 if (child->widget == widget)
715 gboolean was_visible;
717 was_visible = GTK_WIDGET_VISIBLE (widget);
718 gtk_widget_unparent (widget);
720 box->children = g_list_remove_link (box->children, children);
721 g_list_free (children);
724 /* queue resize regardless of GTK_WIDGET_VISIBLE (container),
725 * since that's what is needed by toplevels.
728 gtk_widget_queue_resize (GTK_WIDGET (container));
733 children = children->next;
738 gtk_box_forall (GtkContainer *container,
739 gboolean include_internals,
740 GtkCallback callback,
741 gpointer callback_data)
747 g_return_if_fail (container != NULL);
748 g_return_if_fail (GTK_IS_BOX (container));
749 g_return_if_fail (callback != NULL);
751 box = GTK_BOX (container);
753 children = box->children;
756 child = children->data;
757 children = children->next;
759 if (child->pack == GTK_PACK_START)
760 (* callback) (child->widget, callback_data);
763 children = g_list_last (box->children);
766 child = children->data;
767 children = children->prev;
769 if (child->pack == GTK_PACK_END)
770 (* callback) (child->widget, callback_data);