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 "gtkcontainer.h"
35 #include "gtkbuildable.h"
36 #include "gtkbuilderprivate.h"
37 #include "gtkprivate.h"
39 #include "gtkmarshalers.h"
40 #include "gtksizerequest.h"
41 #include "gtkwidgetprivate.h"
42 #include "gtkwindow.h"
44 #include "gtktoolbar.h"
45 #include <gobject/gobjectnotifyqueue.c>
46 #include <gobject/gvaluecollector.h>
50 * SECTION:gtkcontainer
51 * @Short_description: Base class for widgets which contain other widgets
52 * @Title: GtkContainer
54 * A GTK+ user interface is constructed by nesting widgets inside widgets.
55 * Container widgets are the inner nodes in the resulting tree of widgets:
56 * they contain other widgets. So, for example, you might have a #GtkWindow
57 * containing a #GtkFrame containing a #GtkLabel. If you wanted an image instead
58 * of a textual label inside the frame, you might replace the #GtkLabel widget
59 * with a #GtkImage widget.
61 * There are two major kinds of container widgets in GTK+. Both are subclasses
62 * of the abstract GtkContainer base class.
64 * The first type of container widget has a single child widget and derives
65 * from #GtkBin. These containers are <emphasis>decorators</emphasis>, which
66 * add some kind of functionality to the child. For example, a #GtkButton makes
67 * its child into a clickable button; a #GtkFrame draws a frame around its child
68 * and a #GtkWindow places its child widget inside a top-level window.
70 * The second type of container can have more than one child; its purpose is to
71 * manage <emphasis>layout</emphasis>. This means that these containers assign
72 * sizes and positions to their children. For example, a #GtkHBox arranges its
73 * children in a horizontal row, and a #GtkTable arranges the widgets it contains
74 * in a two-dimensional grid.
76 * <refsect2 id="container-geometry-management">
77 * <title>Height for width geometry management</title>
79 * GTK+ uses a height-for-width (and width-for-height) geometry management system.
80 * Height-for-width means that a widget can change how much vertical space it needs,
81 * depending on the amount of horizontal space that it is given (and similar for
84 * There are some things to keep in mind when implementing container widgets
85 * that make use of GTK+'s height for width geometry management system. First,
86 * it's important to note that a container must prioritize one of its
87 * dimensions, that is to say that a widget or container can only have a
88 * #GtkSizeRequestMode that is %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH or
89 * %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT. However, every widget and container
90 * must be able to respond to the APIs for both dimensions, i.e. even if a
91 * widget has a request mode that is height-for-width, it is possible that
92 * its parent will request its sizes using the width-for-height APIs.
94 * To ensure that everything works properly, here are some guidelines to follow
95 * when implementing height-for-width (or width-for-height) containers.
97 * Each request mode involves 2 virtual methods. Height-for-width apis run
98 * through gtk_widget_get_preferred_width() and then through gtk_widget_get_preferred_height_for_width().
99 * When handling requests in the opposite #GtkSizeRequestMode it is important that
100 * every widget request at least enough space to display all of its content at all times.
102 * When gtk_widget_get_preferred_height() is called on a container that is height-for-width,
103 * the container must return the height for its minimum width. This is easily achieved by
104 * simply calling the reverse apis implemented for itself as follows:
106 * <programlisting><![CDATA[
108 * foo_container_get_preferred_height (GtkWidget *widget, gint *min_height, gint *nat_height)
110 * if (i_am_in_height_for_width_mode)
114 * GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, &min_width, NULL);
115 * GTK_WIDGET_GET_CLASS (widget)->get_preferred_height_for_width (widget, min_width,
116 * min_height, nat_height);
120 * ... many containers support both request modes, execute the real width-for-height
121 * request here by returning the collective heights of all widgets that are
122 * stacked vertically (or whatever is appropriate for this container) ...
125 * ]]></programlisting>
127 * Similarly, when gtk_widget_get_preferred_width_for_height() is called for a container or widget
128 * that is height-for-width, it then only needs to return the base minimum width like so:
130 * <programlisting><![CDATA[
132 * foo_container_get_preferred_width_for_height (GtkWidget *widget, gint for_height,
133 * gint *min_width, gint *nat_width)
135 * if (i_am_in_height_for_width_mode)
137 * GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, min_width, nat_width);
141 * ... execute the real width-for-height request here based on the required width
142 * of the children collectively if the container were to be allocated the said height ...
145 * ]]></programlisting>
147 * Furthermore, in order to ensure correct height-for-width requests it is important
148 * to check the input width against the real required minimum width. This can
149 * easily be achieved as follows:
151 * <programlisting><![CDATA[
153 * foo_container_get_preferred_height_for_width (GtkWidget *widget, gint for_width,
154 * gint *min_height, gint *nat_height)
156 * if (i_am_in_height_for_width_mode)
160 * GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, &min_width, NULL);
162 * for_width = MAX (min_width, for_width);
164 * execute_real_height_for_width_request_code (widget, for_width, min_height, nat_height);
168 * ... fall back on virtual results as mentioned in the previous example ...
171 * ]]></programlisting>
173 * Height for width requests are generally implemented in terms of a virtual allocation
174 * of widgets in the input orientation. Assuming an height-for-width request mode, a container
175 * would implement the <function>get_preferred_height_for_width()</function> virtual function by first calling
176 * gtk_widget_get_preferred_width() for each of its children.
178 * For each potential group of children that are lined up horizontally, the values returned by
179 * gtk_widget_get_preferred_width() should be collected in an array of #GtkRequestedSize structures.
180 * Any child spacing should be removed from the input @for_width and then the collective size should be
181 * allocated using the gtk_distribute_natural_allocation() convenience function.
183 * The container will then move on to request the preferred height for each child by using
184 * gtk_widget_get_preferred_height_for_width() and using the sizes stored in the #GtkRequestedSize array.
186 * To allocate a height-for-width container, it's again important
187 * to consider that a container must prioritize one dimension over the other. So if
188 * a container is a height-for-width container it must first allocate all widgets horizontally
189 * using a #GtkRequestedSize array and gtk_distribute_natural_allocation() and then add any
190 * extra space (if and where appropriate) for the widget to expand.
192 * After adding all the expand space, the container assumes it was allocated sufficient
193 * height to fit all of its content. At this time, the container must use the total horizontal sizes
194 * of each widget to request the height-for-width of each of its children and store the requests in a
195 * #GtkRequestedSize array for any widgets that stack vertically (for tabular containers this can
196 * be generalized into the heights and widths of rows and columns).
197 * The vertical space must then again be distributed using gtk_distribute_natural_allocation()
198 * while this time considering the allocated height of the widget minus any vertical spacing
199 * that the container adds. Then vertical expand space should be added where appropriate and available
200 * and the container should go on to actually allocating the child widgets.
202 * See <link linkend="geometry-management">GtkWidget's geometry management section</link>
203 * to learn more about implementing height-for-width geometry management for widgets.
206 * <refsect2 id="child-properties">
207 * <title>Child properties</title>
209 * GtkContainer introduces <emphasis>child properties</emphasis>.
210 * These are object properties that are not specific
211 * to either the container or the contained widget, but rather to their relation.
212 * Typical examples of child properties are the position or pack-type of a widget
213 * which is contained in a #GtkBox.
215 * Use gtk_container_class_install_child_property() to install child properties
216 * for a container class and gtk_container_class_find_child_property() or
217 * gtk_container_class_list_child_properties() to get information about existing
220 * To set the value of a child property, use gtk_container_child_set_property(),
221 * gtk_container_child_set() or gtk_container_child_set_valist().
222 * To obtain the value of a child property, use
223 * gtk_container_child_get_property(), gtk_container_child_get() or
224 * gtk_container_child_get_valist(). To emit notification about child property
225 * changes, use gtk_widget_child_notify().
228 * <refsect2 id="GtkContainer-BUILDER-UI">
229 * <title>GtkContainer as GtkBuildable</title>
231 * The GtkContainer implementation of the GtkBuildable interface
232 * supports a <packing> element for children, which can
233 * contain multiple <property> elements that specify
234 * child properties for the child.
236 * <title>Child properties in UI definitions</title>
237 * <programlisting><![CDATA[
238 * <object class="GtkVBox">
240 * <object class="GtkLabel"/>
242 * <property name="pack-type">start</property>
246 * ]]></programlisting>
248 * Since 2.16, child properties can also be marked as translatable using
249 * the same "translatable", "comments" and "context" attributes that are used
250 * for regular properties.
256 struct _GtkContainerPrivate
258 GtkWidget *focus_child;
260 guint border_width : 16;
262 guint has_focus_chain : 1;
263 guint need_resize : 1;
264 guint reallocate_redraws : 1;
265 guint resize_mode : 2;
283 #define PARAM_SPEC_PARAM_ID(pspec) ((pspec)->param_id)
284 #define PARAM_SPEC_SET_PARAM_ID(pspec, id) ((pspec)->param_id = (id))
287 /* --- prototypes --- */
288 static void gtk_container_base_class_init (GtkContainerClass *klass);
289 static void gtk_container_base_class_finalize (GtkContainerClass *klass);
290 static void gtk_container_class_init (GtkContainerClass *klass);
291 static void gtk_container_init (GtkContainer *container);
292 static void gtk_container_destroy (GtkWidget *widget);
293 static void gtk_container_set_property (GObject *object,
297 static void gtk_container_get_property (GObject *object,
301 static void gtk_container_add_unimplemented (GtkContainer *container,
303 static void gtk_container_remove_unimplemented (GtkContainer *container,
305 static void gtk_container_real_check_resize (GtkContainer *container);
306 static void gtk_container_compute_expand (GtkWidget *widget,
308 gboolean *vexpand_p);
309 static gboolean gtk_container_focus (GtkWidget *widget,
310 GtkDirectionType direction);
311 static void gtk_container_real_set_focus_child (GtkContainer *container,
314 static gboolean gtk_container_focus_move (GtkContainer *container,
316 GtkDirectionType direction);
317 static void gtk_container_children_callback (GtkWidget *widget,
318 gpointer client_data);
319 static void gtk_container_show_all (GtkWidget *widget);
320 static gint gtk_container_draw (GtkWidget *widget,
322 static void gtk_container_map (GtkWidget *widget);
323 static void gtk_container_unmap (GtkWidget *widget);
324 static void gtk_container_adjust_size_request (GtkWidget *widget,
325 GtkOrientation orientation,
328 static void gtk_container_adjust_size_allocation (GtkWidget *widget,
329 GtkOrientation orientation,
332 gint *allocated_size);
334 static gchar* gtk_container_child_default_composite_name (GtkContainer *container,
337 static GtkWidgetPath * gtk_container_real_get_path_for_child (GtkContainer *container,
341 static void gtk_container_buildable_init (GtkBuildableIface *iface);
342 static void gtk_container_buildable_add_child (GtkBuildable *buildable,
346 static gboolean gtk_container_buildable_custom_tag_start (GtkBuildable *buildable,
349 const gchar *tagname,
350 GMarkupParser *parser,
352 static void gtk_container_buildable_custom_tag_end (GtkBuildable *buildable,
355 const gchar *tagname,
359 /* --- variables --- */
360 static const gchar vadjustment_key[] = "gtk-vadjustment";
361 static guint vadjustment_key_id = 0;
362 static const gchar hadjustment_key[] = "gtk-hadjustment";
363 static guint hadjustment_key_id = 0;
364 static GSList *container_resize_queue = NULL;
365 static guint container_signals[LAST_SIGNAL] = { 0 };
366 static GtkWidgetClass *parent_class = NULL;
367 extern GParamSpecPool *_gtk_widget_child_property_pool;
368 extern GObjectNotifyContext *_gtk_widget_child_property_notify_context;
369 static GtkBuildableIface *parent_buildable_iface;
372 /* --- functions --- */
374 gtk_container_get_type (void)
376 static GType container_type = 0;
380 const GTypeInfo container_info =
382 sizeof (GtkContainerClass),
383 (GBaseInitFunc) gtk_container_base_class_init,
384 (GBaseFinalizeFunc) gtk_container_base_class_finalize,
385 (GClassInitFunc) gtk_container_class_init,
386 NULL /* class_finalize */,
387 NULL /* class_data */,
388 sizeof (GtkContainer),
390 (GInstanceInitFunc) gtk_container_init,
391 NULL, /* value_table */
394 const GInterfaceInfo buildable_info =
396 (GInterfaceInitFunc) gtk_container_buildable_init,
402 g_type_register_static (GTK_TYPE_WIDGET, I_("GtkContainer"),
403 &container_info, G_TYPE_FLAG_ABSTRACT);
405 g_type_add_interface_static (container_type,
411 return container_type;
415 gtk_container_base_class_init (GtkContainerClass *class)
417 /* reset instance specifc class fields that don't get inherited */
418 class->set_child_property = NULL;
419 class->get_child_property = NULL;
423 gtk_container_base_class_finalize (GtkContainerClass *class)
427 list = g_param_spec_pool_list_owned (_gtk_widget_child_property_pool, G_OBJECT_CLASS_TYPE (class));
428 for (node = list; node; node = node->next)
430 GParamSpec *pspec = node->data;
432 g_param_spec_pool_remove (_gtk_widget_child_property_pool, pspec);
433 PARAM_SPEC_SET_PARAM_ID (pspec, 0);
434 g_param_spec_unref (pspec);
440 gtk_container_class_init (GtkContainerClass *class)
442 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
443 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
445 parent_class = g_type_class_peek_parent (class);
447 vadjustment_key_id = g_quark_from_static_string (vadjustment_key);
448 hadjustment_key_id = g_quark_from_static_string (hadjustment_key);
450 gobject_class->set_property = gtk_container_set_property;
451 gobject_class->get_property = gtk_container_get_property;
453 widget_class->destroy = gtk_container_destroy;
454 widget_class->compute_expand = gtk_container_compute_expand;
455 widget_class->show_all = gtk_container_show_all;
456 widget_class->draw = gtk_container_draw;
457 widget_class->map = gtk_container_map;
458 widget_class->unmap = gtk_container_unmap;
459 widget_class->focus = gtk_container_focus;
461 widget_class->adjust_size_request = gtk_container_adjust_size_request;
462 widget_class->adjust_size_allocation = gtk_container_adjust_size_allocation;
464 class->add = gtk_container_add_unimplemented;
465 class->remove = gtk_container_remove_unimplemented;
466 class->check_resize = gtk_container_real_check_resize;
467 class->forall = NULL;
468 class->set_focus_child = gtk_container_real_set_focus_child;
469 class->child_type = NULL;
470 class->composite_name = gtk_container_child_default_composite_name;
471 class->get_path_for_child = gtk_container_real_get_path_for_child;
473 g_object_class_install_property (gobject_class,
475 g_param_spec_enum ("resize-mode",
477 P_("Specify how resize events are handled"),
478 GTK_TYPE_RESIZE_MODE,
480 GTK_PARAM_READWRITE));
481 g_object_class_install_property (gobject_class,
483 g_param_spec_uint ("border-width",
485 P_("The width of the empty border outside the containers children"),
489 GTK_PARAM_READWRITE));
490 g_object_class_install_property (gobject_class,
492 g_param_spec_object ("child",
494 P_("Can be used to add a new child to the container"),
496 GTK_PARAM_WRITABLE));
497 container_signals[ADD] =
498 g_signal_new (I_("add"),
499 G_OBJECT_CLASS_TYPE (gobject_class),
501 G_STRUCT_OFFSET (GtkContainerClass, add),
503 _gtk_marshal_VOID__OBJECT,
506 container_signals[REMOVE] =
507 g_signal_new (I_("remove"),
508 G_OBJECT_CLASS_TYPE (gobject_class),
510 G_STRUCT_OFFSET (GtkContainerClass, remove),
512 _gtk_marshal_VOID__OBJECT,
515 container_signals[CHECK_RESIZE] =
516 g_signal_new (I_("check-resize"),
517 G_OBJECT_CLASS_TYPE (gobject_class),
519 G_STRUCT_OFFSET (GtkContainerClass, check_resize),
521 _gtk_marshal_VOID__VOID,
523 container_signals[SET_FOCUS_CHILD] =
524 g_signal_new (I_("set-focus-child"),
525 G_OBJECT_CLASS_TYPE (gobject_class),
527 G_STRUCT_OFFSET (GtkContainerClass, set_focus_child),
529 _gtk_marshal_VOID__OBJECT,
533 g_type_class_add_private (class, sizeof (GtkContainerPrivate));
537 gtk_container_buildable_init (GtkBuildableIface *iface)
539 parent_buildable_iface = g_type_interface_peek_parent (iface);
540 iface->add_child = gtk_container_buildable_add_child;
541 iface->custom_tag_start = gtk_container_buildable_custom_tag_start;
542 iface->custom_tag_end = gtk_container_buildable_custom_tag_end;
546 gtk_container_buildable_add_child (GtkBuildable *buildable,
553 GTK_BUILDER_WARN_INVALID_CHILD_TYPE (buildable, type);
555 else if (GTK_IS_WIDGET (child) &&
556 gtk_widget_get_parent (GTK_WIDGET (child)) == NULL)
558 gtk_container_add (GTK_CONTAINER (buildable), GTK_WIDGET (child));
561 g_warning ("Cannot add an object of type %s to a container of type %s",
562 g_type_name (G_OBJECT_TYPE (child)), g_type_name (G_OBJECT_TYPE (buildable)));
566 gtk_container_buildable_set_child_property (GtkContainer *container,
573 GValue gvalue = { 0, };
574 GError *error = NULL;
576 pspec = gtk_container_class_find_child_property
577 (G_OBJECT_GET_CLASS (container), name);
580 g_warning ("%s does not have a property called %s",
581 g_type_name (G_OBJECT_TYPE (container)), name);
585 if (!gtk_builder_value_from_string (builder, pspec, value, &gvalue, &error))
587 g_warning ("Could not read property %s:%s with value %s of type %s: %s",
588 g_type_name (G_OBJECT_TYPE (container)),
591 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
593 g_error_free (error);
597 gtk_container_child_set_property (container, child, name, &gvalue);
598 g_value_unset (&gvalue);
603 GtkContainer *container;
605 gchar *child_prop_name;
607 gboolean translatable;
608 } PackingPropertiesData;
611 attributes_start_element (GMarkupParseContext *context,
612 const gchar *element_name,
614 const gchar **values,
618 PackingPropertiesData *parser_data = (PackingPropertiesData*)user_data;
621 if (strcmp (element_name, "property") == 0)
623 for (i = 0; names[i]; i++)
624 if (strcmp (names[i], "name") == 0)
625 parser_data->child_prop_name = g_strdup (values[i]);
626 else if (strcmp (names[i], "translatable") == 0)
628 if (!_gtk_builder_boolean_from_string (values[1],
629 &parser_data->translatable,
633 else if (strcmp (names[i], "comments") == 0)
634 ; /* for translators */
635 else if (strcmp (names[i], "context") == 0)
636 parser_data->context = g_strdup (values[1]);
638 g_warning ("Unsupported attribute for GtkContainer Child "
639 "property: %s\n", names[i]);
641 else if (strcmp (element_name, "packing") == 0)
644 g_warning ("Unsupported tag for GtkContainer: %s\n", element_name);
648 attributes_text_element (GMarkupParseContext *context,
654 PackingPropertiesData *parser_data = (PackingPropertiesData*)user_data;
657 if (!parser_data->child_prop_name)
660 if (parser_data->translatable && text_len)
663 domain = gtk_builder_get_translation_domain (parser_data->builder);
665 value = _gtk_builder_parser_translate (domain,
666 parser_data->context,
671 value = g_strdup (text);
674 gtk_container_buildable_set_child_property (parser_data->container,
675 parser_data->builder,
677 parser_data->child_prop_name,
680 g_free (parser_data->child_prop_name);
681 g_free (parser_data->context);
683 parser_data->child_prop_name = NULL;
684 parser_data->context = NULL;
685 parser_data->translatable = FALSE;
688 static const GMarkupParser attributes_parser =
690 attributes_start_element,
692 attributes_text_element,
696 gtk_container_buildable_custom_tag_start (GtkBuildable *buildable,
699 const gchar *tagname,
700 GMarkupParser *parser,
703 PackingPropertiesData *parser_data;
705 if (parent_buildable_iface->custom_tag_start (buildable, builder, child,
706 tagname, parser, data))
709 if (child && strcmp (tagname, "packing") == 0)
711 parser_data = g_slice_new0 (PackingPropertiesData);
712 parser_data->builder = builder;
713 parser_data->container = GTK_CONTAINER (buildable);
714 parser_data->child = GTK_WIDGET (child);
715 parser_data->child_prop_name = NULL;
717 *parser = attributes_parser;
726 gtk_container_buildable_custom_tag_end (GtkBuildable *buildable,
729 const gchar *tagname,
732 if (strcmp (tagname, "packing") == 0)
734 g_slice_free (PackingPropertiesData, (gpointer)data);
739 if (parent_buildable_iface->custom_tag_end)
740 parent_buildable_iface->custom_tag_end (buildable, builder,
741 child, tagname, data);
746 * gtk_container_child_type:
747 * @container: a #GtkContainer
749 * Returns the type of the children supported by the container.
751 * Note that this may return %G_TYPE_NONE to indicate that no more
752 * children can be added, e.g. for a #GtkPaned which already has two
755 * Return value: a #GType.
758 gtk_container_child_type (GtkContainer *container)
761 GtkContainerClass *class;
763 g_return_val_if_fail (GTK_IS_CONTAINER (container), 0);
765 class = GTK_CONTAINER_GET_CLASS (container);
766 if (class->child_type)
767 slot = class->child_type (container);
774 /* --- GtkContainer child property mechanism --- */
776 container_get_child_property (GtkContainer *container,
781 GtkContainerClass *class = g_type_class_peek (pspec->owner_type);
783 class->get_child_property (container, child, PARAM_SPEC_PARAM_ID (pspec), value, pspec);
787 container_set_child_property (GtkContainer *container,
791 GObjectNotifyQueue *nqueue)
793 GValue tmp_value = { 0, };
794 GtkContainerClass *class = g_type_class_peek (pspec->owner_type);
796 /* provide a copy to work from, convert (if necessary) and validate */
797 g_value_init (&tmp_value, G_PARAM_SPEC_VALUE_TYPE (pspec));
798 if (!g_value_transform (value, &tmp_value))
799 g_warning ("unable to set child property `%s' of type `%s' from value of type `%s'",
801 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
802 G_VALUE_TYPE_NAME (value));
803 else if (g_param_value_validate (pspec, &tmp_value) && !(pspec->flags & G_PARAM_LAX_VALIDATION))
805 gchar *contents = g_strdup_value_contents (value);
807 g_warning ("value \"%s\" of type `%s' is invalid for property `%s' of type `%s'",
809 G_VALUE_TYPE_NAME (value),
811 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)));
816 class->set_child_property (container, child, PARAM_SPEC_PARAM_ID (pspec), &tmp_value, pspec);
817 g_object_notify_queue_add (G_OBJECT (child), nqueue, pspec);
819 g_value_unset (&tmp_value);
823 * gtk_container_child_get_valist:
824 * @container: a #GtkContainer
825 * @child: a widget which is a child of @container
826 * @first_property_name: the name of the first property to get
827 * @var_args: return location for the first property, followed
828 * optionally by more name/return location pairs, followed by %NULL
830 * Gets the values of one or more child properties for @child and @container.
833 gtk_container_child_get_valist (GtkContainer *container,
835 const gchar *first_property_name,
840 g_return_if_fail (GTK_IS_CONTAINER (container));
841 g_return_if_fail (GTK_IS_WIDGET (child));
842 g_return_if_fail (gtk_widget_get_parent (child) == GTK_WIDGET (container));
844 g_object_ref (container);
845 g_object_ref (child);
847 name = first_property_name;
850 GValue value = { 0, };
854 pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
856 G_OBJECT_TYPE (container),
860 g_warning ("%s: container class `%s' has no child property named `%s'",
862 G_OBJECT_TYPE_NAME (container),
866 if (!(pspec->flags & G_PARAM_READABLE))
868 g_warning ("%s: child property `%s' of container class `%s' is not readable",
871 G_OBJECT_TYPE_NAME (container));
874 g_value_init (&value, G_PARAM_SPEC_VALUE_TYPE (pspec));
875 container_get_child_property (container, child, pspec, &value);
876 G_VALUE_LCOPY (&value, var_args, 0, &error);
879 g_warning ("%s: %s", G_STRLOC, error);
881 g_value_unset (&value);
884 g_value_unset (&value);
885 name = va_arg (var_args, gchar*);
888 g_object_unref (child);
889 g_object_unref (container);
893 * gtk_container_child_get_property:
894 * @container: a #GtkContainer
895 * @child: a widget which is a child of @container
896 * @property_name: the name of the property to get
897 * @value: a location to return the value
899 * Gets the value of a child property for @child and @container.
902 gtk_container_child_get_property (GtkContainer *container,
904 const gchar *property_name,
909 g_return_if_fail (GTK_IS_CONTAINER (container));
910 g_return_if_fail (GTK_IS_WIDGET (child));
911 g_return_if_fail (gtk_widget_get_parent (child) == GTK_WIDGET (container));
912 g_return_if_fail (property_name != NULL);
913 g_return_if_fail (G_IS_VALUE (value));
915 g_object_ref (container);
916 g_object_ref (child);
917 pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool, property_name,
918 G_OBJECT_TYPE (container), TRUE);
920 g_warning ("%s: container class `%s' has no child property named `%s'",
922 G_OBJECT_TYPE_NAME (container),
924 else if (!(pspec->flags & G_PARAM_READABLE))
925 g_warning ("%s: child property `%s' of container class `%s' is not readable",
928 G_OBJECT_TYPE_NAME (container));
931 GValue *prop_value, tmp_value = { 0, };
933 /* auto-conversion of the callers value type
935 if (G_VALUE_TYPE (value) == G_PARAM_SPEC_VALUE_TYPE (pspec))
937 g_value_reset (value);
940 else if (!g_value_type_transformable (G_PARAM_SPEC_VALUE_TYPE (pspec), G_VALUE_TYPE (value)))
942 g_warning ("can't retrieve child property `%s' of type `%s' as value of type `%s'",
944 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
945 G_VALUE_TYPE_NAME (value));
946 g_object_unref (child);
947 g_object_unref (container);
952 g_value_init (&tmp_value, G_PARAM_SPEC_VALUE_TYPE (pspec));
953 prop_value = &tmp_value;
955 container_get_child_property (container, child, pspec, prop_value);
956 if (prop_value != value)
958 g_value_transform (prop_value, value);
959 g_value_unset (&tmp_value);
962 g_object_unref (child);
963 g_object_unref (container);
967 * gtk_container_child_set_valist:
968 * @container: a #GtkContainer
969 * @child: a widget which is a child of @container
970 * @first_property_name: the name of the first property to set
971 * @var_args: a %NULL-terminated list of property names and values, starting
972 * with @first_prop_name
974 * Sets one or more child properties for @child and @container.
977 gtk_container_child_set_valist (GtkContainer *container,
979 const gchar *first_property_name,
982 GObjectNotifyQueue *nqueue;
985 g_return_if_fail (GTK_IS_CONTAINER (container));
986 g_return_if_fail (GTK_IS_WIDGET (child));
987 g_return_if_fail (gtk_widget_get_parent (child) == GTK_WIDGET (container));
989 g_object_ref (container);
990 g_object_ref (child);
992 nqueue = g_object_notify_queue_freeze (G_OBJECT (child), _gtk_widget_child_property_notify_context);
993 name = first_property_name;
996 GValue value = { 0, };
998 GParamSpec *pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
1000 G_OBJECT_TYPE (container),
1004 g_warning ("%s: container class `%s' has no child property named `%s'",
1006 G_OBJECT_TYPE_NAME (container),
1010 if (!(pspec->flags & G_PARAM_WRITABLE))
1012 g_warning ("%s: child property `%s' of container class `%s' is not writable",
1015 G_OBJECT_TYPE_NAME (container));
1018 g_value_init (&value, G_PARAM_SPEC_VALUE_TYPE (pspec));
1019 G_VALUE_COLLECT (&value, var_args, 0, &error);
1022 g_warning ("%s: %s", G_STRLOC, error);
1025 /* we purposely leak the value here, it might not be
1026 * in a sane state if an error condition occoured
1030 container_set_child_property (container, child, pspec, &value, nqueue);
1031 g_value_unset (&value);
1032 name = va_arg (var_args, gchar*);
1034 g_object_notify_queue_thaw (G_OBJECT (child), nqueue);
1036 g_object_unref (container);
1037 g_object_unref (child);
1041 * gtk_container_child_set_property:
1042 * @container: a #GtkContainer
1043 * @child: a widget which is a child of @container
1044 * @property_name: the name of the property to set
1045 * @value: the value to set the property to
1047 * Sets a child property for @child and @container.
1050 gtk_container_child_set_property (GtkContainer *container,
1052 const gchar *property_name,
1053 const GValue *value)
1055 GObjectNotifyQueue *nqueue;
1058 g_return_if_fail (GTK_IS_CONTAINER (container));
1059 g_return_if_fail (GTK_IS_WIDGET (child));
1060 g_return_if_fail (gtk_widget_get_parent (child) == GTK_WIDGET (container));
1061 g_return_if_fail (property_name != NULL);
1062 g_return_if_fail (G_IS_VALUE (value));
1064 g_object_ref (container);
1065 g_object_ref (child);
1067 nqueue = g_object_notify_queue_freeze (G_OBJECT (child), _gtk_widget_child_property_notify_context);
1068 pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool, property_name,
1069 G_OBJECT_TYPE (container), TRUE);
1071 g_warning ("%s: container class `%s' has no child property named `%s'",
1073 G_OBJECT_TYPE_NAME (container),
1075 else if (!(pspec->flags & G_PARAM_WRITABLE))
1076 g_warning ("%s: child property `%s' of container class `%s' is not writable",
1079 G_OBJECT_TYPE_NAME (container));
1082 container_set_child_property (container, child, pspec, value, nqueue);
1084 g_object_notify_queue_thaw (G_OBJECT (child), nqueue);
1085 g_object_unref (container);
1086 g_object_unref (child);
1090 * gtk_container_add_with_properties:
1091 * @container: a #GtkContainer
1092 * @widget: a widget to be placed inside @container
1093 * @first_prop_name: the name of the first child property to set
1094 * @Varargs: a %NULL-terminated list of property names and values, starting
1095 * with @first_prop_name
1097 * Adds @widget to @container, setting child properties at the same time.
1098 * See gtk_container_add() and gtk_container_child_set() for more details.
1101 gtk_container_add_with_properties (GtkContainer *container,
1103 const gchar *first_prop_name,
1106 g_return_if_fail (GTK_IS_CONTAINER (container));
1107 g_return_if_fail (GTK_IS_WIDGET (widget));
1108 g_return_if_fail (gtk_widget_get_parent (widget) == NULL);
1110 g_object_ref (container);
1111 g_object_ref (widget);
1112 gtk_widget_freeze_child_notify (widget);
1114 g_signal_emit (container, container_signals[ADD], 0, widget);
1115 if (gtk_widget_get_parent (widget))
1119 va_start (var_args, first_prop_name);
1120 gtk_container_child_set_valist (container, widget, first_prop_name, var_args);
1124 gtk_widget_thaw_child_notify (widget);
1125 g_object_unref (widget);
1126 g_object_unref (container);
1130 * gtk_container_child_set:
1131 * @container: a #GtkContainer
1132 * @child: a widget which is a child of @container
1133 * @first_prop_name: the name of the first property to set
1134 * @Varargs: a %NULL-terminated list of property names and values, starting
1135 * with @first_prop_name
1137 * Sets one or more child properties for @child and @container.
1140 gtk_container_child_set (GtkContainer *container,
1142 const gchar *first_prop_name,
1147 g_return_if_fail (GTK_IS_CONTAINER (container));
1148 g_return_if_fail (GTK_IS_WIDGET (child));
1149 g_return_if_fail (gtk_widget_get_parent (child) == GTK_WIDGET (container));
1151 va_start (var_args, first_prop_name);
1152 gtk_container_child_set_valist (container, child, first_prop_name, var_args);
1157 * gtk_container_child_get:
1158 * @container: a #GtkContainer
1159 * @child: a widget which is a child of @container
1160 * @first_prop_name: the name of the first property to get
1161 * @Varargs: return location for the first property, followed
1162 * optionally by more name/return location pairs, followed by %NULL
1164 * Gets the values of one or more child properties for @child and @container.
1167 gtk_container_child_get (GtkContainer *container,
1169 const gchar *first_prop_name,
1174 g_return_if_fail (GTK_IS_CONTAINER (container));
1175 g_return_if_fail (GTK_IS_WIDGET (child));
1176 g_return_if_fail (gtk_widget_get_parent (child) == GTK_WIDGET (container));
1178 va_start (var_args, first_prop_name);
1179 gtk_container_child_get_valist (container, child, first_prop_name, var_args);
1184 * gtk_container_class_install_child_property:
1185 * @cclass: a #GtkContainerClass
1186 * @property_id: the id for the property
1187 * @pspec: the #GParamSpec for the property
1189 * Installs a child property on a container class.
1192 gtk_container_class_install_child_property (GtkContainerClass *cclass,
1196 g_return_if_fail (GTK_IS_CONTAINER_CLASS (cclass));
1197 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
1198 if (pspec->flags & G_PARAM_WRITABLE)
1199 g_return_if_fail (cclass->set_child_property != NULL);
1200 if (pspec->flags & G_PARAM_READABLE)
1201 g_return_if_fail (cclass->get_child_property != NULL);
1202 g_return_if_fail (property_id > 0);
1203 g_return_if_fail (PARAM_SPEC_PARAM_ID (pspec) == 0); /* paranoid */
1204 if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
1205 g_return_if_fail ((pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY)) == 0);
1207 if (g_param_spec_pool_lookup (_gtk_widget_child_property_pool, pspec->name, G_OBJECT_CLASS_TYPE (cclass), FALSE))
1209 g_warning (G_STRLOC ": class `%s' already contains a child property named `%s'",
1210 G_OBJECT_CLASS_NAME (cclass),
1214 g_param_spec_ref (pspec);
1215 g_param_spec_sink (pspec);
1216 PARAM_SPEC_SET_PARAM_ID (pspec, property_id);
1217 g_param_spec_pool_insert (_gtk_widget_child_property_pool, pspec, G_OBJECT_CLASS_TYPE (cclass));
1221 * gtk_container_class_find_child_property:
1222 * @cclass: a #GtkContainerClass
1223 * @property_name: the name of the child property to find
1224 * @returns: (allow-none): the #GParamSpec of the child property or %NULL if @class has no
1225 * child property with that name.
1227 * Finds a child property of a container class by name.
1230 gtk_container_class_find_child_property (GObjectClass *cclass,
1231 const gchar *property_name)
1233 g_return_val_if_fail (GTK_IS_CONTAINER_CLASS (cclass), NULL);
1234 g_return_val_if_fail (property_name != NULL, NULL);
1236 return g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
1238 G_OBJECT_CLASS_TYPE (cclass),
1243 * gtk_container_class_list_child_properties:
1244 * @cclass: a #GtkContainerClass
1245 * @n_properties: location to return the number of child properties found
1246 * @returns: a newly allocated %NULL-terminated array of #GParamSpec*.
1247 * The array must be freed with g_free().
1249 * Returns all child properties of a container class.
1252 gtk_container_class_list_child_properties (GObjectClass *cclass,
1253 guint *n_properties)
1255 GParamSpec **pspecs;
1258 g_return_val_if_fail (GTK_IS_CONTAINER_CLASS (cclass), NULL);
1260 pspecs = g_param_spec_pool_list (_gtk_widget_child_property_pool,
1261 G_OBJECT_CLASS_TYPE (cclass),
1270 gtk_container_add_unimplemented (GtkContainer *container,
1273 g_warning ("GtkContainerClass::add not implemented for `%s'", g_type_name (G_TYPE_FROM_INSTANCE (container)));
1277 gtk_container_remove_unimplemented (GtkContainer *container,
1280 g_warning ("GtkContainerClass::remove not implemented for `%s'", g_type_name (G_TYPE_FROM_INSTANCE (container)));
1284 gtk_container_init (GtkContainer *container)
1286 GtkContainerPrivate *priv;
1288 container->priv = G_TYPE_INSTANCE_GET_PRIVATE (container,
1290 GtkContainerPrivate);
1291 priv = container->priv;
1293 priv->focus_child = NULL;
1294 priv->border_width = 0;
1295 priv->need_resize = FALSE;
1296 priv->resize_mode = GTK_RESIZE_PARENT;
1297 priv->reallocate_redraws = FALSE;
1301 gtk_container_destroy (GtkWidget *widget)
1303 GtkContainer *container = GTK_CONTAINER (widget);
1304 GtkContainerPrivate *priv = container->priv;
1306 if (_gtk_widget_get_resize_pending (GTK_WIDGET (container)))
1307 _gtk_container_dequeue_resize_handler (container);
1309 if (priv->focus_child)
1311 g_object_unref (priv->focus_child);
1312 priv->focus_child = NULL;
1315 /* do this before walking child widgets, to avoid
1316 * removing children from focus chain one by one.
1318 if (priv->has_focus_chain)
1319 gtk_container_unset_focus_chain (container);
1321 gtk_container_foreach (container, (GtkCallback) gtk_widget_destroy, NULL);
1323 GTK_WIDGET_CLASS (parent_class)->destroy (widget);
1327 gtk_container_set_property (GObject *object,
1329 const GValue *value,
1332 GtkContainer *container = GTK_CONTAINER (object);
1336 case PROP_BORDER_WIDTH:
1337 gtk_container_set_border_width (container, g_value_get_uint (value));
1339 case PROP_RESIZE_MODE:
1340 gtk_container_set_resize_mode (container, g_value_get_enum (value));
1343 gtk_container_add (container, GTK_WIDGET (g_value_get_object (value)));
1346 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1352 gtk_container_get_property (GObject *object,
1357 GtkContainer *container = GTK_CONTAINER (object);
1358 GtkContainerPrivate *priv = container->priv;
1362 case PROP_BORDER_WIDTH:
1363 g_value_set_uint (value, priv->border_width);
1365 case PROP_RESIZE_MODE:
1366 g_value_set_enum (value, priv->resize_mode);
1369 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1375 * gtk_container_set_border_width:
1376 * @container: a #GtkContainer
1377 * @border_width: amount of blank space to leave <emphasis>outside</emphasis>
1378 * the container. Valid values are in the range 0-65535 pixels.
1380 * Sets the border width of the container.
1382 * The border width of a container is the amount of space to leave
1383 * around the outside of the container. The only exception to this is
1384 * #GtkWindow; because toplevel windows can't leave space outside,
1385 * they leave the space inside. The border is added on all sides of
1386 * the container. To add space to only one side, one approach is to
1387 * create a #GtkAlignment widget, call gtk_widget_set_size_request()
1388 * to give it a size, and place it on the side of the container as
1392 gtk_container_set_border_width (GtkContainer *container,
1395 GtkContainerPrivate *priv;
1397 g_return_if_fail (GTK_IS_CONTAINER (container));
1399 priv = container->priv;
1401 if (priv->border_width != border_width)
1403 priv->border_width = border_width;
1404 g_object_notify (G_OBJECT (container), "border-width");
1406 if (gtk_widget_get_realized (GTK_WIDGET (container)))
1407 gtk_widget_queue_resize (GTK_WIDGET (container));
1412 * gtk_container_get_border_width:
1413 * @container: a #GtkContainer
1415 * Retrieves the border width of the container. See
1416 * gtk_container_set_border_width().
1418 * Return value: the current border width
1421 gtk_container_get_border_width (GtkContainer *container)
1423 g_return_val_if_fail (GTK_IS_CONTAINER (container), 0);
1425 return container->priv->border_width;
1429 * gtk_container_add:
1430 * @container: a #GtkContainer
1431 * @widget: a widget to be placed inside @container
1433 * Adds @widget to @container. Typically used for simple containers
1434 * such as #GtkWindow, #GtkFrame, or #GtkButton; for more complicated
1435 * layout containers such as #GtkBox or #GtkTable, this function will
1436 * pick default packing parameters that may not be correct. So
1437 * consider functions such as gtk_box_pack_start() and
1438 * gtk_table_attach() as an alternative to gtk_container_add() in
1439 * those cases. A widget may be added to only one container at a time;
1440 * you can't place the same widget inside two different containers.
1443 gtk_container_add (GtkContainer *container,
1448 g_return_if_fail (GTK_IS_CONTAINER (container));
1449 g_return_if_fail (GTK_IS_WIDGET (widget));
1451 parent = gtk_widget_get_parent (widget);
1455 g_warning ("Attempting to add a widget with type %s to a container of "
1456 "type %s, but the widget is already inside a container of type %s, "
1457 "please use gtk_widget_reparent()" ,
1458 g_type_name (G_OBJECT_TYPE (widget)),
1459 g_type_name (G_OBJECT_TYPE (container)),
1460 g_type_name (G_OBJECT_TYPE (parent)));
1464 g_signal_emit (container, container_signals[ADD], 0, widget);
1468 * gtk_container_remove:
1469 * @container: a #GtkContainer
1470 * @widget: a current child of @container
1472 * Removes @widget from @container. @widget must be inside @container.
1473 * Note that @container will own a reference to @widget, and that this
1474 * may be the last reference held; so removing a widget from its
1475 * container can destroy that widget. If you want to use @widget
1476 * again, you need to add a reference to it while it's not inside
1477 * a container, using g_object_ref(). If you don't want to use @widget
1478 * again it's usually more efficient to simply destroy it directly
1479 * using gtk_widget_destroy() since this will remove it from the
1480 * container and help break any circular reference count cycles.
1483 gtk_container_remove (GtkContainer *container,
1486 g_return_if_fail (GTK_IS_CONTAINER (container));
1487 g_return_if_fail (GTK_IS_WIDGET (widget));
1488 g_return_if_fail (gtk_widget_get_parent (widget) == GTK_WIDGET (container));
1490 g_signal_emit (container, container_signals[REMOVE], 0, widget);
1494 _gtk_container_dequeue_resize_handler (GtkContainer *container)
1496 g_return_if_fail (GTK_IS_CONTAINER (container));
1497 g_return_if_fail (_gtk_widget_get_resize_pending (GTK_WIDGET (container)));
1499 container_resize_queue = g_slist_remove (container_resize_queue, container);
1500 _gtk_widget_set_resize_pending (GTK_WIDGET (container), FALSE);
1504 * gtk_container_set_resize_mode:
1505 * @container: a #GtkContainer
1506 * @resize_mode: the new resize mode
1508 * Sets the resize mode for the container.
1510 * The resize mode of a container determines whether a resize request
1511 * will be passed to the container's parent, queued for later execution
1512 * or executed immediately.
1515 gtk_container_set_resize_mode (GtkContainer *container,
1516 GtkResizeMode resize_mode)
1518 GtkContainerPrivate *priv;
1520 g_return_if_fail (GTK_IS_CONTAINER (container));
1521 g_return_if_fail (resize_mode <= GTK_RESIZE_IMMEDIATE);
1523 priv = container->priv;
1525 if (gtk_widget_is_toplevel (GTK_WIDGET (container)) &&
1526 resize_mode == GTK_RESIZE_PARENT)
1528 resize_mode = GTK_RESIZE_QUEUE;
1531 if (priv->resize_mode != resize_mode)
1533 priv->resize_mode = resize_mode;
1535 gtk_widget_queue_resize (GTK_WIDGET (container));
1536 g_object_notify (G_OBJECT (container), "resize-mode");
1541 * gtk_container_get_resize_mode:
1542 * @container: a #GtkContainer
1544 * Returns the resize mode for the container. See
1545 * gtk_container_set_resize_mode ().
1547 * Return value: the current resize mode
1550 gtk_container_get_resize_mode (GtkContainer *container)
1552 g_return_val_if_fail (GTK_IS_CONTAINER (container), GTK_RESIZE_PARENT);
1554 return container->priv->resize_mode;
1558 * gtk_container_set_reallocate_redraws:
1559 * @container: a #GtkContainer
1560 * @needs_redraws: the new value for the container's @reallocate_redraws flag
1562 * Sets the @reallocate_redraws flag of the container to the given value.
1564 * Containers requesting reallocation redraws get automatically
1565 * redrawn if any of their children changed allocation.
1568 gtk_container_set_reallocate_redraws (GtkContainer *container,
1569 gboolean needs_redraws)
1571 g_return_if_fail (GTK_IS_CONTAINER (container));
1573 container->priv->reallocate_redraws = needs_redraws ? TRUE : FALSE;
1576 static GtkContainer*
1577 gtk_container_get_resize_container (GtkContainer *container)
1580 GtkWidget *widget = GTK_WIDGET (container);
1582 while ((parent = gtk_widget_get_parent (widget)))
1585 if (GTK_IS_RESIZE_CONTAINER (widget))
1589 return GTK_IS_RESIZE_CONTAINER (widget) ? (GtkContainer*) widget : NULL;
1593 gtk_container_idle_sizer (gpointer data)
1595 /* we may be invoked with a container_resize_queue of NULL, because
1596 * queue_resize could have been adding an extra idle function while
1597 * the queue still got processed. we better just ignore such case
1598 * than trying to explicitely work around them with some extra flags,
1599 * since it doesn't cause any actual harm.
1601 while (container_resize_queue)
1606 slist = container_resize_queue;
1607 container_resize_queue = slist->next;
1608 widget = slist->data;
1609 g_slist_free_1 (slist);
1611 _gtk_widget_set_resize_pending (widget, FALSE);
1612 gtk_container_check_resize (GTK_CONTAINER (widget));
1615 gdk_window_process_all_updates ();
1621 _gtk_container_queue_resize_internal (GtkContainer *container,
1622 gboolean invalidate_only)
1624 GtkContainerPrivate *priv;
1625 GtkContainer *resize_container;
1629 g_return_if_fail (GTK_IS_CONTAINER (container));
1631 priv = container->priv;
1632 widget = GTK_WIDGET (container);
1634 resize_container = gtk_container_get_resize_container (container);
1638 _gtk_widget_set_alloc_needed (widget, TRUE);
1639 _gtk_widget_set_width_request_needed (widget, TRUE);
1640 _gtk_widget_set_height_request_needed (widget, TRUE);
1642 if ((resize_container && widget == GTK_WIDGET (resize_container)) ||
1643 !(parent = gtk_widget_get_parent (widget)))
1649 if (resize_container && !invalidate_only)
1651 if (gtk_widget_get_visible (GTK_WIDGET (resize_container)) &&
1652 (gtk_widget_is_toplevel (GTK_WIDGET (resize_container)) ||
1653 gtk_widget_get_realized (GTK_WIDGET (resize_container))))
1655 switch (resize_container->priv->resize_mode)
1657 case GTK_RESIZE_QUEUE:
1658 if (!_gtk_widget_get_resize_pending (GTK_WIDGET (resize_container)))
1660 _gtk_widget_set_resize_pending (GTK_WIDGET (resize_container), TRUE);
1661 if (container_resize_queue == NULL)
1662 gdk_threads_add_idle_full (GTK_PRIORITY_RESIZE,
1663 gtk_container_idle_sizer,
1665 container_resize_queue = g_slist_prepend (container_resize_queue, resize_container);
1669 case GTK_RESIZE_IMMEDIATE:
1670 gtk_container_check_resize (resize_container);
1673 case GTK_RESIZE_PARENT:
1674 g_assert_not_reached ();
1680 /* we need to let hidden resize containers know that something
1681 * changed while they where hidden (currently only evaluated by
1684 resize_container->priv->need_resize = TRUE;
1690 * _gtk_container_queue_resize:
1691 * @container: a #GtkContainer
1693 * Determines the "resize container" in the hierarchy above this container
1694 * (typically the toplevel, but other containers can be set as resize
1695 * containers with gtk_container_set_resize_mode()), marks the container
1696 * and all parents up to and including the resize container as needing
1697 * to have sizes recompted, and if necessary adds the resize container
1698 * to the queue of containers that will be resized out at idle.
1701 _gtk_container_queue_resize (GtkContainer *container)
1703 _gtk_container_queue_resize_internal (container, FALSE);
1707 * _gtk_container_resize_invalidate:
1708 * @container: a #GtkContainer
1710 * Invalidates cached sizes like _gtk_container_queue_resize() but doesn't
1711 * actually queue the resize container for resize.
1714 _gtk_container_resize_invalidate (GtkContainer *container)
1716 _gtk_container_queue_resize_internal (container, TRUE);
1720 gtk_container_check_resize (GtkContainer *container)
1722 g_return_if_fail (GTK_IS_CONTAINER (container));
1724 g_signal_emit (container, container_signals[CHECK_RESIZE], 0);
1728 gtk_container_real_check_resize (GtkContainer *container)
1730 GtkWidget *widget = GTK_WIDGET (container);
1731 GtkAllocation allocation;
1732 GtkRequisition requisition;
1734 gtk_widget_get_preferred_size (widget,
1735 &requisition, NULL);
1736 gtk_widget_get_allocation (widget, &allocation);
1738 if (requisition.width > allocation.width ||
1739 requisition.height > allocation.height)
1741 if (GTK_IS_RESIZE_CONTAINER (container))
1743 gtk_widget_size_allocate (widget, &allocation);
1744 gtk_widget_set_allocation (widget, &allocation);
1747 gtk_widget_queue_resize (widget);
1751 gtk_container_resize_children (container);
1755 /* The container hasn't changed size but one of its children
1756 * queued a resize request. Which means that the allocation
1757 * is not sufficient for the requisition of some child.
1758 * We've already performed a size request at this point,
1759 * so we simply need to reallocate and let the allocation
1760 * trickle down via GTK_WIDGET_ALLOC_NEEDED flags.
1763 gtk_container_resize_children (GtkContainer *container)
1765 GtkAllocation allocation;
1768 /* resizing invariants:
1769 * toplevels have *always* resize_mode != GTK_RESIZE_PARENT set.
1770 * containers that have an idle sizer pending must be flagged with
1773 g_return_if_fail (GTK_IS_CONTAINER (container));
1775 widget = GTK_WIDGET (container);
1776 gtk_widget_get_allocation (widget, &allocation);
1778 gtk_widget_size_allocate (widget, &allocation);
1779 gtk_widget_set_allocation (widget, &allocation);
1783 gtk_container_adjust_size_request (GtkWidget *widget,
1784 GtkOrientation orientation,
1788 GtkContainer *container;
1790 container = GTK_CONTAINER (widget);
1792 if (GTK_CONTAINER_GET_CLASS (widget)->handle_border_width)
1796 border_width = container->priv->border_width;
1798 *minimum_size += border_width * 2;
1799 *natural_size += border_width * 2;
1802 /* chain up last so gtk_widget_set_size_request() values
1803 * will have a chance to overwrite our border width.
1805 parent_class->adjust_size_request (widget, orientation,
1806 minimum_size, natural_size);
1810 gtk_container_adjust_size_allocation (GtkWidget *widget,
1811 GtkOrientation orientation,
1813 gint *allocated_pos,
1814 gint *allocated_size)
1816 GtkContainer *container;
1819 container = GTK_CONTAINER (widget);
1821 if (!GTK_CONTAINER_GET_CLASS (widget)->handle_border_width)
1823 parent_class->adjust_size_allocation (widget, orientation,
1824 natural_size, allocated_pos,
1829 border_width = container->priv->border_width;
1831 *allocated_size -= border_width * 2;
1833 /* If we get a pathological too-small allocation to hold
1834 * even the border width, leave all allocation to the actual
1835 * widget, and leave x,y unchanged. (GtkWidget's min size is
1836 * 1x1 if you're wondering why <1 and not <0)
1838 * As long as we have space, set x,y properly.
1841 if (*allocated_size < 1)
1843 *allocated_size += border_width * 2;
1847 *allocated_pos += border_width;
1848 *natural_size -= border_width * 2;
1851 /* Chain up to GtkWidgetClass *after* removing our border width from
1852 * the proposed allocation size. This is because it's possible that the
1853 * widget was allocated more space than it needs in a said orientation,
1854 * if GtkWidgetClass does any alignments and thus limits the size to the
1855 * natural size... then we need that to be done *after* removing any margins
1856 * and padding values.
1858 parent_class->adjust_size_allocation (widget, orientation,
1859 natural_size, allocated_pos,
1864 * gtk_container_class_handle_border_width:
1865 * @klass: the class struct of a #GtkContainer subclass
1867 * Modifies a subclass of #GtkContainerClass to automatically add and
1868 * remove the border-width setting on GtkContainer. This allows the
1869 * subclass to ignore the border width in its size request and
1870 * allocate methods. The intent is for a subclass to invoke this
1871 * in its class_init function.
1873 * gtk_container_class_handle_border_width() is necessary because it
1874 * would break API too badly to make this behavior the default. So
1875 * subclasses must "opt in" to the parent class handling border_width
1879 gtk_container_class_handle_border_width (GtkContainerClass *klass)
1881 g_return_if_fail (GTK_IS_CONTAINER_CLASS (klass));
1883 klass->handle_border_width = TRUE;
1887 * gtk_container_forall:
1888 * @container: a #GtkContainer
1889 * @callback: a callback
1890 * @callback_data: callback user data
1892 * Invokes @callback on each child of @container, including children
1893 * that are considered "internal" (implementation details of the
1894 * container). "Internal" children generally weren't added by the user
1895 * of the container, but were added by the container implementation
1896 * itself. Most applications should use gtk_container_foreach(),
1897 * rather than gtk_container_forall().
1900 gtk_container_forall (GtkContainer *container,
1901 GtkCallback callback,
1902 gpointer callback_data)
1904 GtkContainerClass *class;
1906 g_return_if_fail (GTK_IS_CONTAINER (container));
1907 g_return_if_fail (callback != NULL);
1909 class = GTK_CONTAINER_GET_CLASS (container);
1912 class->forall (container, TRUE, callback, callback_data);
1916 * gtk_container_foreach:
1917 * @container: a #GtkContainer
1918 * @callback: (scope call): a callback
1919 * @callback_data: callback user data
1921 * Invokes @callback on each non-internal child of @container. See
1922 * gtk_container_forall() for details on what constitutes an
1923 * "internal" child. Most applications should use
1924 * gtk_container_foreach(), rather than gtk_container_forall().
1927 gtk_container_foreach (GtkContainer *container,
1928 GtkCallback callback,
1929 gpointer callback_data)
1931 GtkContainerClass *class;
1933 g_return_if_fail (GTK_IS_CONTAINER (container));
1934 g_return_if_fail (callback != NULL);
1936 class = GTK_CONTAINER_GET_CLASS (container);
1939 class->forall (container, FALSE, callback, callback_data);
1943 * gtk_container_set_focus_child:
1944 * @container: a #GtkContainer
1945 * @child: (allow-none): a #GtkWidget, or %NULL
1947 * Sets, or unsets if @child is %NULL, the focused child of @container.
1949 * This function emits the GtkContainer::set_focus_child signal of
1950 * @container. Implementations of #GtkContainer can override the
1951 * default behaviour by overriding the class closure of this signal.
1953 * This is function is mostly meant to be used by widgets. Applications can use
1954 * gtk_widget_grab_focus() to manualy set the focus to a specific widget.
1957 gtk_container_set_focus_child (GtkContainer *container,
1960 g_return_if_fail (GTK_IS_CONTAINER (container));
1962 g_return_if_fail (GTK_IS_WIDGET (child));
1964 g_signal_emit (container, container_signals[SET_FOCUS_CHILD], 0, child);
1968 * gtk_container_get_focus_child:
1969 * @container: a #GtkContainer
1971 * Returns the current focus child widget inside @container. This is not the
1972 * currently focused widget. That can be obtained by calling
1973 * gtk_window_get_focus().
1975 * Returns: The child widget which will recieve the focus inside @container when
1976 * the @conatiner is focussed, or %NULL if none is set.
1981 gtk_container_get_focus_child (GtkContainer *container)
1983 g_return_val_if_fail (GTK_IS_CONTAINER (container), NULL);
1985 return container->priv->focus_child;
1989 * gtk_container_get_children:
1990 * @container: a #GtkContainer
1992 * Returns the container's non-internal children. See
1993 * gtk_container_forall() for details on what constitutes an "internal" child.
1995 * Return value: (element-type GtkWidget) (transfer container): a newly-allocated list of the container's non-internal children.
1998 gtk_container_get_children (GtkContainer *container)
2000 GList *children = NULL;
2002 gtk_container_foreach (container,
2003 gtk_container_children_callback,
2006 return g_list_reverse (children);
2010 gtk_container_child_position_callback (GtkWidget *widget,
2011 gpointer client_data)
2017 } *data = client_data;
2020 if (data->child == widget)
2021 data->index = data->i;
2025 gtk_container_child_default_composite_name (GtkContainer *container,
2035 /* fallback implementation */
2039 gtk_container_forall (container,
2040 gtk_container_child_position_callback,
2043 name = g_strdup_printf ("%s-%u",
2044 g_type_name (G_TYPE_FROM_INSTANCE (child)),
2051 _gtk_container_child_composite_name (GtkContainer *container,
2054 gboolean composite_child;
2056 g_return_val_if_fail (GTK_IS_CONTAINER (container), NULL);
2057 g_return_val_if_fail (GTK_IS_WIDGET (child), NULL);
2058 g_return_val_if_fail (gtk_widget_get_parent (child) == GTK_WIDGET (container), NULL);
2060 g_object_get (child, "composite-child", &composite_child, NULL);
2061 if (composite_child)
2063 static GQuark quark_composite_name = 0;
2066 if (!quark_composite_name)
2067 quark_composite_name = g_quark_from_static_string ("gtk-composite-name");
2069 name = g_object_get_qdata (G_OBJECT (child), quark_composite_name);
2072 GtkContainerClass *class;
2074 class = GTK_CONTAINER_GET_CLASS (container);
2075 if (class->composite_name)
2076 name = class->composite_name (container, child);
2079 name = g_strdup (name);
2090 } ComputeExpandData;
2093 gtk_container_compute_expand_callback (GtkWidget *widget,
2094 gpointer client_data)
2096 ComputeExpandData *data = client_data;
2098 /* note that we don't get_expand on the child if we already know we
2099 * have to expand, so we only recurse into children until we find
2100 * one that expands and then we basically don't do any more
2101 * work. This means that we can leave some children in a
2102 * need_compute_expand state, which is fine, as long as GtkWidget
2103 * doesn't rely on an invariant that "if a child has
2104 * need_compute_expand, its parents also do"
2106 * gtk_widget_compute_expand() always returns FALSE if the
2107 * child is !visible so that's taken care of.
2109 data->hexpand = data->hexpand ||
2110 gtk_widget_compute_expand (widget, GTK_ORIENTATION_HORIZONTAL);
2112 data->vexpand = data->vexpand ||
2113 gtk_widget_compute_expand (widget, GTK_ORIENTATION_VERTICAL);
2117 gtk_container_compute_expand (GtkWidget *widget,
2118 gboolean *hexpand_p,
2119 gboolean *vexpand_p)
2121 ComputeExpandData data;
2123 data.hexpand = FALSE;
2124 data.vexpand = FALSE;
2126 gtk_container_forall (GTK_CONTAINER (widget),
2127 gtk_container_compute_expand_callback,
2130 *hexpand_p = data.hexpand;
2131 *vexpand_p = data.vexpand;
2135 gtk_container_real_set_focus_child (GtkContainer *container,
2138 GtkContainerPrivate *priv;
2140 g_return_if_fail (GTK_IS_CONTAINER (container));
2141 g_return_if_fail (child == NULL || GTK_IS_WIDGET (child));
2143 priv = container->priv;
2145 if (child != priv->focus_child)
2147 if (priv->focus_child)
2148 g_object_unref (priv->focus_child);
2149 priv->focus_child = child;
2150 if (priv->focus_child)
2151 g_object_ref (priv->focus_child);
2155 /* check for h/v adjustments
2157 if (priv->focus_child)
2159 GtkAdjustment *hadj;
2160 GtkAdjustment *vadj;
2161 GtkAllocation allocation;
2162 GtkWidget *focus_child;
2165 hadj = g_object_get_qdata (G_OBJECT (container), hadjustment_key_id);
2166 vadj = g_object_get_qdata (G_OBJECT (container), vadjustment_key_id);
2170 focus_child = priv->focus_child;
2171 while (GTK_IS_CONTAINER (focus_child) && gtk_container_get_focus_child (GTK_CONTAINER (focus_child)))
2173 focus_child = gtk_container_get_focus_child (GTK_CONTAINER (focus_child));
2176 gtk_widget_translate_coordinates (focus_child, priv->focus_child,
2179 gtk_widget_get_allocation (priv->focus_child, &allocation);
2183 gtk_widget_get_allocation (focus_child, &allocation);
2186 gtk_adjustment_clamp_page (vadj, y, y + allocation.height);
2189 gtk_adjustment_clamp_page (hadj, x, x + allocation.width);
2195 get_focus_chain (GtkContainer *container)
2197 return g_object_get_data (G_OBJECT (container), "gtk-container-focus-chain");
2200 /* same as gtk_container_get_children, except it includes internals
2203 gtk_container_get_all_children (GtkContainer *container)
2205 GList *children = NULL;
2207 gtk_container_forall (container,
2208 gtk_container_children_callback,
2214 static GtkWidgetPath *
2215 gtk_container_real_get_path_for_child (GtkContainer *container,
2218 return gtk_widget_path_copy (gtk_widget_get_path (GTK_WIDGET (container)));
2222 gtk_container_focus (GtkWidget *widget,
2223 GtkDirectionType direction)
2226 GList *sorted_children;
2228 GtkContainer *container;
2229 GtkContainerPrivate *priv;
2231 g_return_val_if_fail (GTK_IS_CONTAINER (widget), FALSE);
2233 container = GTK_CONTAINER (widget);
2234 priv = container->priv;
2238 if (gtk_widget_get_can_focus (widget))
2240 if (!gtk_widget_has_focus (widget))
2242 gtk_widget_grab_focus (widget);
2248 /* Get a list of the containers children, allowing focus
2249 * chain to override.
2251 if (priv->has_focus_chain)
2252 children = g_list_copy (get_focus_chain (container));
2254 children = gtk_container_get_all_children (container);
2256 if (priv->has_focus_chain &&
2257 (direction == GTK_DIR_TAB_FORWARD ||
2258 direction == GTK_DIR_TAB_BACKWARD))
2260 sorted_children = g_list_copy (children);
2262 if (direction == GTK_DIR_TAB_BACKWARD)
2263 sorted_children = g_list_reverse (sorted_children);
2266 sorted_children = _gtk_container_focus_sort (container, children, direction, NULL);
2268 return_val = gtk_container_focus_move (container, sorted_children, direction);
2270 g_list_free (sorted_children);
2271 g_list_free (children);
2278 tab_compare (gconstpointer a,
2282 GtkAllocation child1_allocation, child2_allocation;
2283 const GtkWidget *child1 = a;
2284 const GtkWidget *child2 = b;
2285 GtkTextDirection text_direction = GPOINTER_TO_INT (data);
2288 gtk_widget_get_allocation ((GtkWidget *) child1, &child1_allocation);
2289 gtk_widget_get_allocation ((GtkWidget *) child2, &child2_allocation);
2291 y1 = child1_allocation.y + child1_allocation.height / 2;
2292 y2 = child2_allocation.y + child2_allocation.height / 2;
2296 gint x1 = child1_allocation.x + child1_allocation.width / 2;
2297 gint x2 = child2_allocation.x + child2_allocation.width / 2;
2299 if (text_direction == GTK_TEXT_DIR_RTL)
2300 return (x1 < x2) ? 1 : ((x1 == x2) ? 0 : -1);
2302 return (x1 < x2) ? -1 : ((x1 == x2) ? 0 : 1);
2305 return (y1 < y2) ? -1 : 1;
2309 gtk_container_focus_sort_tab (GtkContainer *container,
2311 GtkDirectionType direction,
2312 GtkWidget *old_focus)
2314 GtkTextDirection text_direction = gtk_widget_get_direction (GTK_WIDGET (container));
2315 children = g_list_sort_with_data (children, tab_compare, GINT_TO_POINTER (text_direction));
2317 /* if we are going backwards then reverse the order
2320 if (direction == GTK_DIR_TAB_BACKWARD)
2321 children = g_list_reverse (children);
2326 /* Get coordinates of @widget's allocation with respect to
2327 * allocation of @container.
2330 get_allocation_coords (GtkContainer *container,
2332 GdkRectangle *allocation)
2334 gtk_widget_get_allocation (widget, allocation);
2336 return gtk_widget_translate_coordinates (widget, GTK_WIDGET (container),
2337 0, 0, &allocation->x, &allocation->y);
2340 /* Look for a child in @children that is intermediate between
2341 * the focus widget and container. This widget, if it exists,
2342 * acts as the starting widget for focus navigation.
2345 find_old_focus (GtkContainer *container,
2348 GList *tmp_list = children;
2351 GtkWidget *child = tmp_list->data;
2352 GtkWidget *widget = child;
2354 while (widget && widget != (GtkWidget *)container)
2358 parent = gtk_widget_get_parent (widget);
2360 if (parent && (gtk_container_get_focus_child (GTK_CONTAINER (parent)) != widget))
2369 tmp_list = tmp_list->next;
2376 old_focus_coords (GtkContainer *container,
2377 GdkRectangle *old_focus_rect)
2379 GtkWidget *widget = GTK_WIDGET (container);
2380 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
2381 GtkWidget *old_focus;
2383 if (GTK_IS_WINDOW (toplevel))
2385 old_focus = gtk_window_get_focus (GTK_WINDOW (toplevel));
2387 return get_allocation_coords (container, old_focus, old_focus_rect);
2393 typedef struct _CompareInfo CompareInfo;
2397 GtkContainer *container;
2404 up_down_compare (gconstpointer a,
2408 GdkRectangle allocation1;
2409 GdkRectangle allocation2;
2410 CompareInfo *compare = data;
2413 get_allocation_coords (compare->container, (GtkWidget *)a, &allocation1);
2414 get_allocation_coords (compare->container, (GtkWidget *)b, &allocation2);
2416 y1 = allocation1.y + allocation1.height / 2;
2417 y2 = allocation2.y + allocation2.height / 2;
2421 gint x1 = abs (allocation1.x + allocation1.width / 2 - compare->x);
2422 gint x2 = abs (allocation2.x + allocation2.width / 2 - compare->x);
2424 if (compare->reverse)
2425 return (x1 < x2) ? 1 : ((x1 == x2) ? 0 : -1);
2427 return (x1 < x2) ? -1 : ((x1 == x2) ? 0 : 1);
2430 return (y1 < y2) ? -1 : 1;
2434 gtk_container_focus_sort_up_down (GtkContainer *container,
2436 GtkDirectionType direction,
2437 GtkWidget *old_focus)
2439 CompareInfo compare;
2441 GdkRectangle old_allocation;
2443 compare.container = container;
2444 compare.reverse = (direction == GTK_DIR_UP);
2447 old_focus = find_old_focus (container, children);
2449 if (old_focus && get_allocation_coords (container, old_focus, &old_allocation))
2455 /* Delete widgets from list that don't match minimum criteria */
2457 compare_x1 = old_allocation.x;
2458 compare_x2 = old_allocation.x + old_allocation.width;
2460 if (direction == GTK_DIR_UP)
2461 compare_y = old_allocation.y;
2463 compare_y = old_allocation.y + old_allocation.height;
2465 tmp_list = children;
2468 GtkWidget *child = tmp_list->data;
2469 GList *next = tmp_list->next;
2470 gint child_x1, child_x2;
2471 GdkRectangle child_allocation;
2473 if (child != old_focus)
2475 if (get_allocation_coords (container, child, &child_allocation))
2477 child_x1 = child_allocation.x;
2478 child_x2 = child_allocation.x + child_allocation.width;
2480 if ((child_x2 <= compare_x1 || child_x1 >= compare_x2) /* No horizontal overlap */ ||
2481 (direction == GTK_DIR_DOWN && child_allocation.y + child_allocation.height < compare_y) || /* Not below */
2482 (direction == GTK_DIR_UP && child_allocation.y > compare_y)) /* Not above */
2484 children = g_list_delete_link (children, tmp_list);
2488 children = g_list_delete_link (children, tmp_list);
2494 compare.x = (compare_x1 + compare_x2) / 2;
2495 compare.y = old_allocation.y + old_allocation.height / 2;
2499 /* No old focus widget, need to figure out starting x,y some other way
2501 GtkAllocation allocation;
2502 GtkWidget *widget = GTK_WIDGET (container);
2503 GdkRectangle old_focus_rect;
2505 gtk_widget_get_allocation (widget, &allocation);
2507 if (old_focus_coords (container, &old_focus_rect))
2509 compare.x = old_focus_rect.x + old_focus_rect.width / 2;
2513 if (!gtk_widget_get_has_window (widget))
2514 compare.x = allocation.x + allocation.width / 2;
2516 compare.x = allocation.width / 2;
2519 if (!gtk_widget_get_has_window (widget))
2520 compare.y = (direction == GTK_DIR_DOWN) ? allocation.y : allocation.y + allocation.height;
2522 compare.y = (direction == GTK_DIR_DOWN) ? 0 : + allocation.height;
2525 children = g_list_sort_with_data (children, up_down_compare, &compare);
2527 if (compare.reverse)
2528 children = g_list_reverse (children);
2534 left_right_compare (gconstpointer a,
2538 GdkRectangle allocation1;
2539 GdkRectangle allocation2;
2540 CompareInfo *compare = data;
2543 get_allocation_coords (compare->container, (GtkWidget *)a, &allocation1);
2544 get_allocation_coords (compare->container, (GtkWidget *)b, &allocation2);
2546 x1 = allocation1.x + allocation1.width / 2;
2547 x2 = allocation2.x + allocation2.width / 2;
2551 gint y1 = abs (allocation1.y + allocation1.height / 2 - compare->y);
2552 gint y2 = abs (allocation2.y + allocation2.height / 2 - compare->y);
2554 if (compare->reverse)
2555 return (y1 < y2) ? 1 : ((y1 == y2) ? 0 : -1);
2557 return (y1 < y2) ? -1 : ((y1 == y2) ? 0 : 1);
2560 return (x1 < x2) ? -1 : 1;
2564 gtk_container_focus_sort_left_right (GtkContainer *container,
2566 GtkDirectionType direction,
2567 GtkWidget *old_focus)
2569 CompareInfo compare;
2571 GdkRectangle old_allocation;
2573 compare.container = container;
2574 compare.reverse = (direction == GTK_DIR_LEFT);
2577 old_focus = find_old_focus (container, children);
2579 if (old_focus && get_allocation_coords (container, old_focus, &old_allocation))
2585 /* Delete widgets from list that don't match minimum criteria */
2587 compare_y1 = old_allocation.y;
2588 compare_y2 = old_allocation.y + old_allocation.height;
2590 if (direction == GTK_DIR_LEFT)
2591 compare_x = old_allocation.x;
2593 compare_x = old_allocation.x + old_allocation.width;
2595 tmp_list = children;
2598 GtkWidget *child = tmp_list->data;
2599 GList *next = tmp_list->next;
2600 gint child_y1, child_y2;
2601 GdkRectangle child_allocation;
2603 if (child != old_focus)
2605 if (get_allocation_coords (container, child, &child_allocation))
2607 child_y1 = child_allocation.y;
2608 child_y2 = child_allocation.y + child_allocation.height;
2610 if ((child_y2 <= compare_y1 || child_y1 >= compare_y2) /* No vertical overlap */ ||
2611 (direction == GTK_DIR_RIGHT && child_allocation.x + child_allocation.width < compare_x) || /* Not to left */
2612 (direction == GTK_DIR_LEFT && child_allocation.x > compare_x)) /* Not to right */
2614 children = g_list_delete_link (children, tmp_list);
2618 children = g_list_delete_link (children, tmp_list);
2624 compare.y = (compare_y1 + compare_y2) / 2;
2625 compare.x = old_allocation.x + old_allocation.width / 2;
2629 /* No old focus widget, need to figure out starting x,y some other way
2631 GtkAllocation allocation;
2632 GtkWidget *widget = GTK_WIDGET (container);
2633 GdkRectangle old_focus_rect;
2635 gtk_widget_get_allocation (widget, &allocation);
2637 if (old_focus_coords (container, &old_focus_rect))
2639 compare.y = old_focus_rect.y + old_focus_rect.height / 2;
2643 if (!gtk_widget_get_has_window (widget))
2644 compare.y = allocation.y + allocation.height / 2;
2646 compare.y = allocation.height / 2;
2649 if (!gtk_widget_get_has_window (widget))
2650 compare.x = (direction == GTK_DIR_RIGHT) ? allocation.x : allocation.x + allocation.width;
2652 compare.x = (direction == GTK_DIR_RIGHT) ? 0 : allocation.width;
2655 children = g_list_sort_with_data (children, left_right_compare, &compare);
2657 if (compare.reverse)
2658 children = g_list_reverse (children);
2664 * gtk_container_focus_sort:
2665 * @container: a #GtkContainer
2666 * @children: a list of descendents of @container (they don't
2667 * have to be direct children)
2668 * @direction: focus direction
2669 * @old_focus: (allow-none): widget to use for the starting position, or %NULL
2670 * to determine this automatically.
2671 * (Note, this argument isn't used for GTK_DIR_TAB_*,
2672 * which is the only @direction we use currently,
2673 * so perhaps this argument should be removed)
2675 * Sorts @children in the correct order for focusing with
2676 * direction type @direction.
2678 * Return value: a copy of @children, sorted in correct focusing order,
2679 * with children that aren't suitable for focusing in this direction
2683 _gtk_container_focus_sort (GtkContainer *container,
2685 GtkDirectionType direction,
2686 GtkWidget *old_focus)
2688 GList *visible_children = NULL;
2692 if (gtk_widget_get_realized (children->data))
2693 visible_children = g_list_prepend (visible_children, children->data);
2694 children = children->next;
2699 case GTK_DIR_TAB_FORWARD:
2700 case GTK_DIR_TAB_BACKWARD:
2701 return gtk_container_focus_sort_tab (container, visible_children, direction, old_focus);
2704 return gtk_container_focus_sort_up_down (container, visible_children, direction, old_focus);
2707 return gtk_container_focus_sort_left_right (container, visible_children, direction, old_focus);
2710 g_assert_not_reached ();
2716 gtk_container_focus_move (GtkContainer *container,
2718 GtkDirectionType direction)
2720 GtkContainerPrivate *priv = container->priv;
2721 GtkWidget *focus_child;
2724 focus_child = priv->focus_child;
2728 child = children->data;
2729 children = children->next;
2736 if (focus_child == child)
2740 if (gtk_widget_child_focus (child, direction))
2744 else if (gtk_widget_is_drawable (child) &&
2745 gtk_widget_is_ancestor (child, GTK_WIDGET (container)))
2747 if (gtk_widget_child_focus (child, direction))
2757 gtk_container_children_callback (GtkWidget *widget,
2758 gpointer client_data)
2762 children = (GList**) client_data;
2763 *children = g_list_prepend (*children, widget);
2767 chain_widget_destroyed (GtkWidget *widget,
2770 GtkContainer *container;
2773 container = GTK_CONTAINER (user_data);
2775 chain = g_object_get_data (G_OBJECT (container),
2776 "gtk-container-focus-chain");
2778 chain = g_list_remove (chain, widget);
2780 g_signal_handlers_disconnect_by_func (widget,
2781 chain_widget_destroyed,
2784 g_object_set_data (G_OBJECT (container),
2785 I_("gtk-container-focus-chain"),
2790 * gtk_container_set_focus_chain:
2791 * @container: a #GtkContainer
2792 * @focusable_widgets: (transfer none) (element-type GtkWidget):
2793 * the new focus chain
2795 * Sets a focus chain, overriding the one computed automatically by GTK+.
2797 * In principle each widget in the chain should be a descendant of the
2798 * container, but this is not enforced by this method, since it's allowed
2799 * to set the focus chain before you pack the widgets, or have a widget
2800 * in the chain that isn't always packed. The necessary checks are done
2801 * when the focus chain is actually traversed.
2804 gtk_container_set_focus_chain (GtkContainer *container,
2805 GList *focusable_widgets)
2809 GtkContainerPrivate *priv;
2811 g_return_if_fail (GTK_IS_CONTAINER (container));
2813 priv = container->priv;
2815 if (priv->has_focus_chain)
2816 gtk_container_unset_focus_chain (container);
2818 priv->has_focus_chain = TRUE;
2821 tmp_list = focusable_widgets;
2822 while (tmp_list != NULL)
2824 g_return_if_fail (GTK_IS_WIDGET (tmp_list->data));
2826 /* In principle each widget in the chain should be a descendant
2827 * of the container, but we don't want to check that here, it's
2828 * expensive and also it's allowed to set the focus chain before
2829 * you pack the widgets, or have a widget in the chain that isn't
2830 * always packed. So we check for ancestor during actual traversal.
2833 chain = g_list_prepend (chain, tmp_list->data);
2835 g_signal_connect (tmp_list->data,
2837 G_CALLBACK (chain_widget_destroyed),
2840 tmp_list = g_list_next (tmp_list);
2843 chain = g_list_reverse (chain);
2845 g_object_set_data (G_OBJECT (container),
2846 I_("gtk-container-focus-chain"),
2851 * gtk_container_get_focus_chain:
2852 * @container: a #GtkContainer
2853 * @focusable_widgets: (element-type GtkWidget) (out) (transfer container): location
2854 * to store the focus chain of the
2855 * container, or %NULL. You should free this list
2856 * using g_list_free() when you are done with it, however
2857 * no additional reference count is added to the
2858 * individual widgets in the focus chain.
2860 * Retrieves the focus chain of the container, if one has been
2861 * set explicitly. If no focus chain has been explicitly
2862 * set, GTK+ computes the focus chain based on the positions
2863 * of the children. In that case, GTK+ stores %NULL in
2864 * @focusable_widgets and returns %FALSE.
2866 * Return value: %TRUE if the focus chain of the container
2867 * has been set explicitly.
2870 gtk_container_get_focus_chain (GtkContainer *container,
2871 GList **focus_chain)
2873 GtkContainerPrivate *priv;
2875 g_return_val_if_fail (GTK_IS_CONTAINER (container), FALSE);
2877 priv = container->priv;
2881 if (priv->has_focus_chain)
2882 *focus_chain = g_list_copy (get_focus_chain (container));
2884 *focus_chain = NULL;
2887 return priv->has_focus_chain;
2891 * gtk_container_unset_focus_chain:
2892 * @container: a #GtkContainer
2894 * Removes a focus chain explicitly set with gtk_container_set_focus_chain().
2897 gtk_container_unset_focus_chain (GtkContainer *container)
2899 GtkContainerPrivate *priv;
2901 g_return_if_fail (GTK_IS_CONTAINER (container));
2903 priv = container->priv;
2905 if (priv->has_focus_chain)
2910 chain = get_focus_chain (container);
2912 priv->has_focus_chain = FALSE;
2914 g_object_set_data (G_OBJECT (container),
2915 I_("gtk-container-focus-chain"),
2919 while (tmp_list != NULL)
2921 g_signal_handlers_disconnect_by_func (tmp_list->data,
2922 chain_widget_destroyed,
2925 tmp_list = g_list_next (tmp_list);
2928 g_list_free (chain);
2933 * gtk_container_set_focus_vadjustment:
2934 * @container: a #GtkContainer
2935 * @adjustment: an adjustment which should be adjusted when the focus
2936 * is moved among the descendents of @container
2938 * Hooks up an adjustment to focus handling in a container, so when a
2939 * child of the container is focused, the adjustment is scrolled to
2940 * show that widget. This function sets the vertical alignment. See
2941 * gtk_scrolled_window_get_vadjustment() for a typical way of obtaining
2942 * the adjustment and gtk_container_set_focus_hadjustment() for setting
2943 * the horizontal adjustment.
2945 * The adjustments have to be in pixel units and in the same coordinate
2946 * system as the allocation for immediate children of the container.
2949 gtk_container_set_focus_vadjustment (GtkContainer *container,
2950 GtkAdjustment *adjustment)
2952 g_return_if_fail (GTK_IS_CONTAINER (container));
2954 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
2957 g_object_ref (adjustment);
2959 g_object_set_qdata_full (G_OBJECT (container),
2966 * gtk_container_get_focus_vadjustment:
2967 * @container: a #GtkContainer
2969 * Retrieves the vertical focus adjustment for the container. See
2970 * gtk_container_set_focus_vadjustment().
2972 * Return value: (transfer none): the vertical focus adjustment, or %NULL if
2973 * none has been set.
2976 gtk_container_get_focus_vadjustment (GtkContainer *container)
2978 GtkAdjustment *vadjustment;
2980 g_return_val_if_fail (GTK_IS_CONTAINER (container), NULL);
2982 vadjustment = g_object_get_qdata (G_OBJECT (container), vadjustment_key_id);
2988 * gtk_container_set_focus_hadjustment:
2989 * @container: a #GtkContainer
2990 * @adjustment: an adjustment which should be adjusted when the focus is
2991 * moved among the descendents of @container
2993 * Hooks up an adjustment to focus handling in a container, so when a child
2994 * of the container is focused, the adjustment is scrolled to show that
2995 * widget. This function sets the horizontal alignment.
2996 * See gtk_scrolled_window_get_hadjustment() for a typical way of obtaining
2997 * the adjustment and gtk_container_set_focus_vadjustment() for setting
2998 * the vertical adjustment.
3000 * The adjustments have to be in pixel units and in the same coordinate
3001 * system as the allocation for immediate children of the container.
3004 gtk_container_set_focus_hadjustment (GtkContainer *container,
3005 GtkAdjustment *adjustment)
3007 g_return_if_fail (GTK_IS_CONTAINER (container));
3009 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
3012 g_object_ref (adjustment);
3014 g_object_set_qdata_full (G_OBJECT (container),
3021 * gtk_container_get_focus_hadjustment:
3022 * @container: a #GtkContainer
3024 * Retrieves the horizontal focus adjustment for the container. See
3025 * gtk_container_set_focus_hadjustment ().
3027 * Return value: (transfer none): the horizontal focus adjustment, or %NULL if
3028 * none has been set.
3031 gtk_container_get_focus_hadjustment (GtkContainer *container)
3033 GtkAdjustment *hadjustment;
3035 g_return_val_if_fail (GTK_IS_CONTAINER (container), NULL);
3037 hadjustment = g_object_get_qdata (G_OBJECT (container), hadjustment_key_id);
3044 gtk_container_show_all (GtkWidget *widget)
3046 g_return_if_fail (GTK_IS_CONTAINER (widget));
3048 gtk_container_foreach (GTK_CONTAINER (widget),
3049 (GtkCallback) gtk_widget_show_all,
3051 gtk_widget_show (widget);
3055 gtk_container_draw_child (GtkWidget *child,
3056 gpointer client_data)
3059 GtkWidget *container;
3061 } *data = client_data;
3063 gtk_container_propagate_draw (GTK_CONTAINER (data->container),
3069 gtk_container_draw (GtkWidget *widget,
3073 GtkWidget *container;
3077 data.container = widget;
3080 gtk_container_forall (GTK_CONTAINER (widget),
3081 gtk_container_draw_child,
3088 gtk_container_map_child (GtkWidget *child,
3089 gpointer client_data)
3091 if (gtk_widget_get_visible (child) &&
3092 gtk_widget_get_child_visible (child) &&
3093 !gtk_widget_get_mapped (child))
3094 gtk_widget_map (child);
3098 gtk_container_map (GtkWidget *widget)
3100 gtk_widget_set_mapped (widget, TRUE);
3102 gtk_container_forall (GTK_CONTAINER (widget),
3103 gtk_container_map_child,
3106 if (gtk_widget_get_has_window (widget))
3107 gdk_window_show (gtk_widget_get_window (widget));
3111 gtk_container_unmap (GtkWidget *widget)
3113 gtk_widget_set_mapped (widget, FALSE);
3115 if (gtk_widget_get_has_window (widget))
3116 gdk_window_hide (gtk_widget_get_window (widget));
3118 gtk_container_forall (GTK_CONTAINER (widget),
3119 (GtkCallback)gtk_widget_unmap,
3124 * gtk_container_propagate_draw:
3125 * @container: a #GtkContainer
3126 * @child: a child of @container
3127 * @cr: Cairo context as passed to the container. If you want to use @cr
3128 * in container's draw function, consider using cairo_save() and
3129 * cairo_restore() before calling this function.
3131 * When a container receives a call to the draw function, it must send
3132 * synthetic #GtkWidget::draw calls to all children that don't have their
3133 * own #GdkWindows. This function provides a convenient way of doing this.
3134 * A container, when it receives a call to its #GtkWidget::draw function,
3135 * calls gtk_container_propagate_draw() once for each child, passing in
3136 * the @cr the container received.
3138 * gtk_container_propagate_draw() takes care of translating the origin of @cr,
3139 * and deciding whether the draw needs to be sent to the child. It is a
3140 * convenient and optimized way of getting the same effect as calling
3141 * gtk_widget_draw() on the child directly.
3143 * In most cases, a container can simply either inherit the
3144 * #GtkWidget::draw implementation from #GtkContainer, or do some drawing
3145 * and then chain to the ::draw implementation from #GtkContainer.
3148 gtk_container_propagate_draw (GtkContainer *container,
3152 GdkEventExpose *event;
3153 GtkAllocation allocation;
3154 GdkWindow *window, *w;
3157 g_return_if_fail (GTK_IS_CONTAINER (container));
3158 g_return_if_fail (GTK_IS_WIDGET (child));
3159 g_return_if_fail (cr != NULL);
3161 g_assert (gtk_widget_get_parent (child) == GTK_WIDGET (container));
3163 event = _gtk_cairo_get_event (cr);
3166 if (gtk_widget_get_has_window (child) ||
3167 gtk_widget_get_window (child) != event->window)
3173 /* translate coordinates. Ugly business, that. */
3174 if (!gtk_widget_get_has_window (GTK_WIDGET (container)))
3176 gtk_widget_get_allocation (GTK_WIDGET (container), &allocation);
3186 window = gtk_widget_get_window (GTK_WIDGET (container));
3188 for (w = gtk_widget_get_window (child); w && w != window; w = gdk_window_get_parent (w))
3191 gdk_window_get_position (w, &wx, &wy);
3202 if (!gtk_widget_get_has_window (child))
3204 gtk_widget_get_allocation (child, &allocation);
3209 cairo_translate (cr, x, y);
3211 _gtk_widget_draw_internal (child, cr, TRUE);
3217 _gtk_container_get_need_resize (GtkContainer *container)
3219 return container->priv->need_resize;
3223 _gtk_container_set_need_resize (GtkContainer *container,
3224 gboolean need_resize)
3226 container->priv->need_resize = need_resize;
3230 _gtk_container_get_reallocate_redraws (GtkContainer *container)
3232 return container->priv->reallocate_redraws;
3236 * gtk_container_get_path_for_child:
3237 * @container: a #GtkContainer
3238 * @child: a child of @container
3240 * Returns a newly created widget path representing all the widget hierarchy
3241 * from the toplevel down to @child (this one not being included).
3243 * Returns: A newly created #GtkWidgetPath
3246 gtk_container_get_path_for_child (GtkContainer *container,
3249 g_return_val_if_fail (GTK_IS_CONTAINER (container), NULL);
3250 g_return_val_if_fail (GTK_IS_WIDGET (child), NULL);
3251 g_return_val_if_fail (container == (GtkContainer *) gtk_widget_get_parent (child), NULL);
3253 return GTK_CONTAINER_GET_CLASS (container)->get_path_for_child (container, child);