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, see <http://www.gnu.org/licenses/>.
19 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
20 * file for a list of people on the GTK+ Team. See the ChangeLog
21 * files for a list of changes. These files are distributed with
22 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
27 #include "gtkcontainer.h"
28 #include "gtkcontainerprivate.h"
34 #include <gobject/gobjectnotifyqueue.c>
35 #include <gobject/gvaluecollector.h>
37 #include "gtkadjustment.h"
38 #include "gtkbuildable.h"
39 #include "gtkbuilderprivate.h"
40 #include "gtktypebuiltins.h"
41 #include "gtkprivate.h"
43 #include "gtkmarshalers.h"
44 #include "gtksizerequest.h"
45 #include "gtkwidgetprivate.h"
46 #include "gtkwindow.h"
47 #include "gtkassistant.h"
49 #include "gtkstylecontextprivate.h"
50 #include "gtkwidgetpath.h"
51 #include "a11y/gtkcontaineraccessible.h"
54 * SECTION:gtkcontainer
55 * @Short_description: Base class for widgets which contain other widgets
56 * @Title: GtkContainer
58 * A GTK+ user interface is constructed by nesting widgets inside widgets.
59 * Container widgets are the inner nodes in the resulting tree of widgets:
60 * they contain other widgets. So, for example, you might have a #GtkWindow
61 * containing a #GtkFrame containing a #GtkLabel. If you wanted an image instead
62 * of a textual label inside the frame, you might replace the #GtkLabel widget
63 * with a #GtkImage widget.
65 * There are two major kinds of container widgets in GTK+. Both are subclasses
66 * of the abstract GtkContainer base class.
68 * The first type of container widget has a single child widget and derives
69 * from #GtkBin. These containers are <emphasis>decorators</emphasis>, which
70 * add some kind of functionality to the child. For example, a #GtkButton makes
71 * its child into a clickable button; a #GtkFrame draws a frame around its child
72 * and a #GtkWindow places its child widget inside a top-level window.
74 * The second type of container can have more than one child; its purpose is to
75 * manage <emphasis>layout</emphasis>. This means that these containers assign
76 * sizes and positions to their children. For example, a #GtkHBox arranges its
77 * children in a horizontal row, and a #GtkGrid arranges the widgets it contains
78 * in a two-dimensional grid.
80 * <refsect2 id="container-geometry-management">
81 * <title>Height for width geometry management</title>
83 * GTK+ uses a height-for-width (and width-for-height) geometry management system.
84 * Height-for-width means that a widget can change how much vertical space it needs,
85 * depending on the amount of horizontal space that it is given (and similar for
88 * There are some things to keep in mind when implementing container widgets
89 * that make use of GTK+'s height for width geometry management system. First,
90 * it's important to note that a container must prioritize one of its
91 * dimensions, that is to say that a widget or container can only have a
92 * #GtkSizeRequestMode that is %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH or
93 * %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT. However, every widget and container
94 * must be able to respond to the APIs for both dimensions, i.e. even if a
95 * widget has a request mode that is height-for-width, it is possible that
96 * its parent will request its sizes using the width-for-height APIs.
98 * To ensure that everything works properly, here are some guidelines to follow
99 * when implementing height-for-width (or width-for-height) containers.
101 * Each request mode involves 2 virtual methods. Height-for-width apis run
102 * through gtk_widget_get_preferred_width() and then through gtk_widget_get_preferred_height_for_width().
103 * When handling requests in the opposite #GtkSizeRequestMode it is important that
104 * every widget request at least enough space to display all of its content at all times.
106 * When gtk_widget_get_preferred_height() is called on a container that is height-for-width,
107 * the container must return the height for its minimum width. This is easily achieved by
108 * simply calling the reverse apis implemented for itself as follows:
110 * <programlisting><![CDATA[
112 * foo_container_get_preferred_height (GtkWidget *widget, gint *min_height, gint *nat_height)
114 * if (i_am_in_height_for_width_mode)
118 * GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, &min_width, NULL);
119 * GTK_WIDGET_GET_CLASS (widget)->get_preferred_height_for_width (widget, min_width,
120 * min_height, nat_height);
124 * ... many containers support both request modes, execute the real width-for-height
125 * request here by returning the collective heights of all widgets that are
126 * stacked vertically (or whatever is appropriate for this container) ...
129 * ]]></programlisting>
131 * Similarly, when gtk_widget_get_preferred_width_for_height() is called for a container or widget
132 * that is height-for-width, it then only needs to return the base minimum width like so:
134 * <programlisting><![CDATA[
136 * foo_container_get_preferred_width_for_height (GtkWidget *widget, gint for_height,
137 * gint *min_width, gint *nat_width)
139 * if (i_am_in_height_for_width_mode)
141 * GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, min_width, nat_width);
145 * ... execute the real width-for-height request here based on the required width
146 * of the children collectively if the container were to be allocated the said height ...
149 * ]]></programlisting>
151 * Height for width requests are generally implemented in terms of a virtual allocation
152 * of widgets in the input orientation. Assuming an height-for-width request mode, a container
153 * would implement the <function>get_preferred_height_for_width()</function> virtual function by first calling
154 * gtk_widget_get_preferred_width() for each of its children.
156 * For each potential group of children that are lined up horizontally, the values returned by
157 * gtk_widget_get_preferred_width() should be collected in an array of #GtkRequestedSize structures.
158 * Any child spacing should be removed from the input @for_width and then the collective size should be
159 * allocated using the gtk_distribute_natural_allocation() convenience function.
161 * The container will then move on to request the preferred height for each child by using
162 * gtk_widget_get_preferred_height_for_width() and using the sizes stored in the #GtkRequestedSize array.
164 * To allocate a height-for-width container, it's again important
165 * to consider that a container must prioritize one dimension over the other. So if
166 * a container is a height-for-width container it must first allocate all widgets horizontally
167 * using a #GtkRequestedSize array and gtk_distribute_natural_allocation() and then add any
168 * extra space (if and where appropriate) for the widget to expand.
170 * After adding all the expand space, the container assumes it was allocated sufficient
171 * height to fit all of its content. At this time, the container must use the total horizontal sizes
172 * of each widget to request the height-for-width of each of its children and store the requests in a
173 * #GtkRequestedSize array for any widgets that stack vertically (for tabular containers this can
174 * be generalized into the heights and widths of rows and columns).
175 * The vertical space must then again be distributed using gtk_distribute_natural_allocation()
176 * while this time considering the allocated height of the widget minus any vertical spacing
177 * that the container adds. Then vertical expand space should be added where appropriate and available
178 * and the container should go on to actually allocating the child widgets.
180 * See <link linkend="geometry-management">GtkWidget's geometry management section</link>
181 * to learn more about implementing height-for-width geometry management for widgets.
184 * <refsect2 id="child-properties">
185 * <title>Child properties</title>
187 * GtkContainer introduces <emphasis>child properties</emphasis>.
188 * These are object properties that are not specific
189 * to either the container or the contained widget, but rather to their relation.
190 * Typical examples of child properties are the position or pack-type of a widget
191 * which is contained in a #GtkBox.
193 * Use gtk_container_class_install_child_property() to install child properties
194 * for a container class and gtk_container_class_find_child_property() or
195 * gtk_container_class_list_child_properties() to get information about existing
198 * To set the value of a child property, use gtk_container_child_set_property(),
199 * gtk_container_child_set() or gtk_container_child_set_valist().
200 * To obtain the value of a child property, use
201 * gtk_container_child_get_property(), gtk_container_child_get() or
202 * gtk_container_child_get_valist(). To emit notification about child property
203 * changes, use gtk_widget_child_notify().
206 * <refsect2 id="GtkContainer-BUILDER-UI">
207 * <title>GtkContainer as GtkBuildable</title>
209 * The GtkContainer implementation of the GtkBuildable interface
210 * supports a <packing> element for children, which can
211 * contain multiple <property> elements that specify
212 * child properties for the child.
214 * <title>Child properties in UI definitions</title>
215 * <programlisting><![CDATA[
216 * <object class="GtkVBox">
218 * <object class="GtkLabel"/>
220 * <property name="pack-type">start</property>
224 * ]]></programlisting>
226 * Since 2.16, child properties can also be marked as translatable using
227 * the same "translatable", "comments" and "context" attributes that are used
228 * for regular properties.
234 struct _GtkContainerPrivate
236 GtkWidget *focus_child;
238 guint border_width : 16;
240 guint has_focus_chain : 1;
241 guint reallocate_redraws : 1;
242 guint resize_pending : 1;
243 guint restyle_pending : 1;
244 guint resize_mode : 2;
245 guint request_mode : 2;
263 #define PARAM_SPEC_PARAM_ID(pspec) ((pspec)->param_id)
264 #define PARAM_SPEC_SET_PARAM_ID(pspec, id) ((pspec)->param_id = (id))
267 /* --- prototypes --- */
268 static void gtk_container_base_class_init (GtkContainerClass *klass);
269 static void gtk_container_base_class_finalize (GtkContainerClass *klass);
270 static void gtk_container_class_init (GtkContainerClass *klass);
271 static void gtk_container_init (GtkContainer *container);
272 static void gtk_container_destroy (GtkWidget *widget);
273 static void gtk_container_set_property (GObject *object,
277 static void gtk_container_get_property (GObject *object,
281 static void gtk_container_add_unimplemented (GtkContainer *container,
283 static void gtk_container_remove_unimplemented (GtkContainer *container,
285 static void gtk_container_real_check_resize (GtkContainer *container);
286 static void gtk_container_compute_expand (GtkWidget *widget,
288 gboolean *vexpand_p);
289 static gboolean gtk_container_focus (GtkWidget *widget,
290 GtkDirectionType direction);
291 static void gtk_container_real_set_focus_child (GtkContainer *container,
294 static gboolean gtk_container_focus_move (GtkContainer *container,
296 GtkDirectionType direction);
297 static void gtk_container_children_callback (GtkWidget *widget,
298 gpointer client_data);
299 static void gtk_container_show_all (GtkWidget *widget);
300 static gint gtk_container_draw (GtkWidget *widget,
302 static void gtk_container_map (GtkWidget *widget);
303 static void gtk_container_unmap (GtkWidget *widget);
304 static void gtk_container_adjust_size_request (GtkWidget *widget,
305 GtkOrientation orientation,
308 static void gtk_container_adjust_size_allocation (GtkWidget *widget,
309 GtkOrientation orientation,
313 gint *allocated_size);
314 static GtkSizeRequestMode gtk_container_get_request_mode (GtkWidget *widget);
316 static gchar* gtk_container_child_default_composite_name (GtkContainer *container,
319 static GtkWidgetPath * gtk_container_real_get_path_for_child (GtkContainer *container,
323 static void gtk_container_buildable_init (GtkBuildableIface *iface);
324 static void gtk_container_buildable_add_child (GtkBuildable *buildable,
328 static gboolean gtk_container_buildable_custom_tag_start (GtkBuildable *buildable,
331 const gchar *tagname,
332 GMarkupParser *parser,
334 static void gtk_container_buildable_custom_tag_end (GtkBuildable *buildable,
337 const gchar *tagname,
341 /* --- variables --- */
342 static const gchar vadjustment_key[] = "gtk-vadjustment";
343 static guint vadjustment_key_id = 0;
344 static const gchar hadjustment_key[] = "gtk-hadjustment";
345 static guint hadjustment_key_id = 0;
346 static GSList *container_resize_queue = NULL;
347 static GSList *container_restyle_queue = NULL;
348 static guint container_signals[LAST_SIGNAL] = { 0 };
349 static GtkWidgetClass *parent_class = NULL;
350 extern GParamSpecPool *_gtk_widget_child_property_pool;
351 extern GObjectNotifyContext *_gtk_widget_child_property_notify_context;
352 static GtkBuildableIface *parent_buildable_iface;
355 /* --- functions --- */
357 gtk_container_get_type (void)
359 static GType container_type = 0;
363 const GTypeInfo container_info =
365 sizeof (GtkContainerClass),
366 (GBaseInitFunc) gtk_container_base_class_init,
367 (GBaseFinalizeFunc) gtk_container_base_class_finalize,
368 (GClassInitFunc) gtk_container_class_init,
369 NULL /* class_finalize */,
370 NULL /* class_data */,
371 sizeof (GtkContainer),
373 (GInstanceInitFunc) gtk_container_init,
374 NULL, /* value_table */
377 const GInterfaceInfo buildable_info =
379 (GInterfaceInitFunc) gtk_container_buildable_init,
385 g_type_register_static (GTK_TYPE_WIDGET, I_("GtkContainer"),
386 &container_info, G_TYPE_FLAG_ABSTRACT);
388 g_type_add_interface_static (container_type,
394 return container_type;
398 gtk_container_base_class_init (GtkContainerClass *class)
400 /* reset instance specifc class fields that don't get inherited */
401 class->set_child_property = NULL;
402 class->get_child_property = NULL;
406 gtk_container_base_class_finalize (GtkContainerClass *class)
410 list = g_param_spec_pool_list_owned (_gtk_widget_child_property_pool, G_OBJECT_CLASS_TYPE (class));
411 for (node = list; node; node = node->next)
413 GParamSpec *pspec = node->data;
415 g_param_spec_pool_remove (_gtk_widget_child_property_pool, pspec);
416 PARAM_SPEC_SET_PARAM_ID (pspec, 0);
417 g_param_spec_unref (pspec);
423 gtk_container_class_init (GtkContainerClass *class)
425 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
426 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
428 parent_class = g_type_class_peek_parent (class);
430 vadjustment_key_id = g_quark_from_static_string (vadjustment_key);
431 hadjustment_key_id = g_quark_from_static_string (hadjustment_key);
433 gobject_class->set_property = gtk_container_set_property;
434 gobject_class->get_property = gtk_container_get_property;
436 widget_class->destroy = gtk_container_destroy;
437 widget_class->compute_expand = gtk_container_compute_expand;
438 widget_class->show_all = gtk_container_show_all;
439 widget_class->draw = gtk_container_draw;
440 widget_class->map = gtk_container_map;
441 widget_class->unmap = gtk_container_unmap;
442 widget_class->focus = gtk_container_focus;
444 widget_class->adjust_size_request = gtk_container_adjust_size_request;
445 widget_class->adjust_size_allocation = gtk_container_adjust_size_allocation;
446 widget_class->get_request_mode = gtk_container_get_request_mode;
448 class->add = gtk_container_add_unimplemented;
449 class->remove = gtk_container_remove_unimplemented;
450 class->check_resize = gtk_container_real_check_resize;
451 class->forall = NULL;
452 class->set_focus_child = gtk_container_real_set_focus_child;
453 class->child_type = NULL;
454 class->composite_name = gtk_container_child_default_composite_name;
455 class->get_path_for_child = gtk_container_real_get_path_for_child;
457 g_object_class_install_property (gobject_class,
459 g_param_spec_enum ("resize-mode",
461 P_("Specify how resize events are handled"),
462 GTK_TYPE_RESIZE_MODE,
464 GTK_PARAM_READWRITE));
465 g_object_class_install_property (gobject_class,
467 g_param_spec_uint ("border-width",
469 P_("The width of the empty border outside the containers children"),
473 GTK_PARAM_READWRITE));
474 g_object_class_install_property (gobject_class,
476 g_param_spec_object ("child",
478 P_("Can be used to add a new child to the container"),
480 GTK_PARAM_WRITABLE));
481 container_signals[ADD] =
482 g_signal_new (I_("add"),
483 G_OBJECT_CLASS_TYPE (gobject_class),
485 G_STRUCT_OFFSET (GtkContainerClass, add),
487 _gtk_marshal_VOID__OBJECT,
490 container_signals[REMOVE] =
491 g_signal_new (I_("remove"),
492 G_OBJECT_CLASS_TYPE (gobject_class),
494 G_STRUCT_OFFSET (GtkContainerClass, remove),
496 _gtk_marshal_VOID__OBJECT,
499 container_signals[CHECK_RESIZE] =
500 g_signal_new (I_("check-resize"),
501 G_OBJECT_CLASS_TYPE (gobject_class),
503 G_STRUCT_OFFSET (GtkContainerClass, check_resize),
505 _gtk_marshal_VOID__VOID,
507 container_signals[SET_FOCUS_CHILD] =
508 g_signal_new (I_("set-focus-child"),
509 G_OBJECT_CLASS_TYPE (gobject_class),
511 G_STRUCT_OFFSET (GtkContainerClass, set_focus_child),
513 _gtk_marshal_VOID__OBJECT,
517 g_type_class_add_private (class, sizeof (GtkContainerPrivate));
519 gtk_widget_class_set_accessible_type (widget_class, GTK_TYPE_CONTAINER_ACCESSIBLE);
523 gtk_container_buildable_init (GtkBuildableIface *iface)
525 parent_buildable_iface = g_type_interface_peek_parent (iface);
526 iface->add_child = gtk_container_buildable_add_child;
527 iface->custom_tag_start = gtk_container_buildable_custom_tag_start;
528 iface->custom_tag_end = gtk_container_buildable_custom_tag_end;
532 gtk_container_buildable_add_child (GtkBuildable *buildable,
539 GTK_BUILDER_WARN_INVALID_CHILD_TYPE (buildable, type);
541 else if (GTK_IS_WIDGET (child) &&
542 gtk_widget_get_parent (GTK_WIDGET (child)) == NULL)
544 gtk_container_add (GTK_CONTAINER (buildable), GTK_WIDGET (child));
547 g_warning ("Cannot add an object of type %s to a container of type %s",
548 g_type_name (G_OBJECT_TYPE (child)), g_type_name (G_OBJECT_TYPE (buildable)));
552 gtk_container_buildable_set_child_property (GtkContainer *container,
559 GValue gvalue = G_VALUE_INIT;
560 GError *error = NULL;
562 pspec = gtk_container_class_find_child_property
563 (G_OBJECT_GET_CLASS (container), name);
566 g_warning ("%s does not have a property called %s",
567 g_type_name (G_OBJECT_TYPE (container)), name);
571 if (!gtk_builder_value_from_string (builder, pspec, value, &gvalue, &error))
573 g_warning ("Could not read property %s:%s with value %s of type %s: %s",
574 g_type_name (G_OBJECT_TYPE (container)),
577 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
579 g_error_free (error);
583 gtk_container_child_set_property (container, child, name, &gvalue);
584 g_value_unset (&gvalue);
589 GtkContainer *container;
592 gchar *child_prop_name;
594 gboolean translatable;
595 } PackingPropertiesData;
598 attributes_start_element (GMarkupParseContext *context,
599 const gchar *element_name,
601 const gchar **values,
605 PackingPropertiesData *parser_data = (PackingPropertiesData*)user_data;
608 if (strcmp (element_name, "property") == 0)
610 for (i = 0; names[i]; i++)
611 if (strcmp (names[i], "name") == 0)
612 parser_data->child_prop_name = g_strdup (values[i]);
613 else if (strcmp (names[i], "translatable") == 0)
615 if (!_gtk_builder_boolean_from_string (values[1],
616 &parser_data->translatable,
620 else if (strcmp (names[i], "comments") == 0)
621 ; /* for translators */
622 else if (strcmp (names[i], "context") == 0)
623 parser_data->context = g_strdup (values[1]);
625 g_warning ("Unsupported attribute for GtkContainer Child "
626 "property: %s\n", names[i]);
628 else if (strcmp (element_name, "packing") == 0)
631 g_warning ("Unsupported tag for GtkContainer: %s\n", element_name);
635 attributes_text_element (GMarkupParseContext *context,
641 PackingPropertiesData *parser_data = (PackingPropertiesData*)user_data;
643 if (parser_data->child_prop_name)
644 g_string_append_len (parser_data->string, text, text_len);
648 attributes_end_element (GMarkupParseContext *context,
649 const gchar *element_name,
653 PackingPropertiesData *parser_data = (PackingPropertiesData*)user_data;
655 /* translate the string */
656 if (parser_data->string->len && parser_data->translatable)
661 domain = gtk_builder_get_translation_domain (parser_data->builder);
663 translated = _gtk_builder_parser_translate (domain,
664 parser_data->context,
665 parser_data->string->str);
666 g_string_set_size (parser_data->string, 0);
667 g_string_append (parser_data->string, translated);
670 if (parser_data->child_prop_name)
671 gtk_container_buildable_set_child_property (parser_data->container,
672 parser_data->builder,
674 parser_data->child_prop_name,
675 parser_data->string->str);
677 g_string_set_size (parser_data->string, 0);
678 g_free (parser_data->child_prop_name);
679 g_free (parser_data->context);
680 parser_data->child_prop_name = NULL;
681 parser_data->context = NULL;
682 parser_data->translatable = FALSE;
685 static const GMarkupParser attributes_parser =
687 attributes_start_element,
688 attributes_end_element,
689 attributes_text_element,
693 gtk_container_buildable_custom_tag_start (GtkBuildable *buildable,
696 const gchar *tagname,
697 GMarkupParser *parser,
700 PackingPropertiesData *parser_data;
702 if (parent_buildable_iface->custom_tag_start (buildable, builder, child,
703 tagname, parser, data))
706 if (child && strcmp (tagname, "packing") == 0)
708 parser_data = g_slice_new0 (PackingPropertiesData);
709 parser_data->string = g_string_new ("");
710 parser_data->builder = builder;
711 parser_data->container = GTK_CONTAINER (buildable);
712 parser_data->child = GTK_WIDGET (child);
713 parser_data->child_prop_name = NULL;
715 *parser = attributes_parser;
724 gtk_container_buildable_custom_tag_end (GtkBuildable *buildable,
727 const gchar *tagname,
730 if (strcmp (tagname, "packing") == 0)
732 PackingPropertiesData *parser_data = (PackingPropertiesData*)data;
733 g_string_free (parser_data->string, TRUE);
734 g_slice_free (PackingPropertiesData, parser_data);
738 if (parent_buildable_iface->custom_tag_end)
739 parent_buildable_iface->custom_tag_end (buildable, builder,
740 child, tagname, data);
744 * gtk_container_child_type:
745 * @container: a #GtkContainer
747 * Returns the type of the children supported by the container.
749 * Note that this may return %G_TYPE_NONE to indicate that no more
750 * children can be added, e.g. for a #GtkPaned which already has two
753 * Return value: a #GType.
756 gtk_container_child_type (GtkContainer *container)
759 GtkContainerClass *class;
761 g_return_val_if_fail (GTK_IS_CONTAINER (container), 0);
763 class = GTK_CONTAINER_GET_CLASS (container);
764 if (class->child_type)
765 slot = class->child_type (container);
772 /* --- GtkContainer child property mechanism --- */
775 * gtk_container_child_notify:
776 * @container: the #GtkContainer
777 * @child: the child widget
778 * @child_property: the name of a child property installed on
779 * the class of @container
781 * Emits a #GtkWidget::child-notify signal for the
782 * <link linkend="child-properties">child property</link>
783 * @child_property on widget.
785 * This is an analogue of g_object_notify() for child properties.
787 * Also see gtk_widget_child_notify().
792 gtk_container_child_notify (GtkContainer *container,
794 const gchar *child_property)
799 g_return_if_fail (GTK_IS_CONTAINER (container));
800 g_return_if_fail (GTK_IS_WIDGET (child));
801 g_return_if_fail (child_property != NULL);
803 obj = G_OBJECT (child);
805 if (obj->ref_count == 0)
810 pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
812 G_OBJECT_TYPE (container),
817 g_warning ("%s: container class `%s' has no child property named `%s'",
819 G_OBJECT_TYPE_NAME (container),
824 GObjectNotifyQueue *nqueue;
826 nqueue = g_object_notify_queue_freeze (obj, _gtk_widget_child_property_notify_context);
828 g_object_notify_queue_add (obj, nqueue, pspec);
829 g_object_notify_queue_thaw (obj, nqueue);
832 g_object_unref (obj);
836 container_get_child_property (GtkContainer *container,
841 GtkContainerClass *class = g_type_class_peek (pspec->owner_type);
843 class->get_child_property (container, child, PARAM_SPEC_PARAM_ID (pspec), value, pspec);
847 container_set_child_property (GtkContainer *container,
851 GObjectNotifyQueue *nqueue)
853 GValue tmp_value = G_VALUE_INIT;
854 GtkContainerClass *class = g_type_class_peek (pspec->owner_type);
856 /* provide a copy to work from, convert (if necessary) and validate */
857 g_value_init (&tmp_value, G_PARAM_SPEC_VALUE_TYPE (pspec));
858 if (!g_value_transform (value, &tmp_value))
859 g_warning ("unable to set child property `%s' of type `%s' from value of type `%s'",
861 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
862 G_VALUE_TYPE_NAME (value));
863 else if (g_param_value_validate (pspec, &tmp_value) && !(pspec->flags & G_PARAM_LAX_VALIDATION))
865 gchar *contents = g_strdup_value_contents (value);
867 g_warning ("value \"%s\" of type `%s' is invalid for property `%s' of type `%s'",
869 G_VALUE_TYPE_NAME (value),
871 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)));
876 class->set_child_property (container, child, PARAM_SPEC_PARAM_ID (pspec), &tmp_value, pspec);
877 g_object_notify_queue_add (G_OBJECT (child), nqueue, pspec);
879 g_value_unset (&tmp_value);
883 * gtk_container_child_get_valist:
884 * @container: a #GtkContainer
885 * @child: a widget which is a child of @container
886 * @first_property_name: the name of the first property to get
887 * @var_args: return location for the first property, followed
888 * optionally by more name/return location pairs, followed by %NULL
890 * Gets the values of one or more child properties for @child and @container.
893 gtk_container_child_get_valist (GtkContainer *container,
895 const gchar *first_property_name,
900 g_return_if_fail (GTK_IS_CONTAINER (container));
901 g_return_if_fail (GTK_IS_WIDGET (child));
903 g_object_ref (container);
904 g_object_ref (child);
906 name = first_property_name;
909 GValue value = G_VALUE_INIT;
913 pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
915 G_OBJECT_TYPE (container),
919 g_warning ("%s: container class `%s' has no child property named `%s'",
921 G_OBJECT_TYPE_NAME (container),
925 if (!(pspec->flags & G_PARAM_READABLE))
927 g_warning ("%s: child property `%s' of container class `%s' is not readable",
930 G_OBJECT_TYPE_NAME (container));
933 g_value_init (&value, G_PARAM_SPEC_VALUE_TYPE (pspec));
934 container_get_child_property (container, child, pspec, &value);
935 G_VALUE_LCOPY (&value, var_args, 0, &error);
938 g_warning ("%s: %s", G_STRLOC, error);
940 g_value_unset (&value);
943 g_value_unset (&value);
944 name = va_arg (var_args, gchar*);
947 g_object_unref (child);
948 g_object_unref (container);
952 * gtk_container_child_get_property:
953 * @container: a #GtkContainer
954 * @child: a widget which is a child of @container
955 * @property_name: the name of the property to get
956 * @value: a location to return the value
958 * Gets the value of a child property for @child and @container.
961 gtk_container_child_get_property (GtkContainer *container,
963 const gchar *property_name,
968 g_return_if_fail (GTK_IS_CONTAINER (container));
969 g_return_if_fail (GTK_IS_WIDGET (child));
970 g_return_if_fail (property_name != NULL);
971 g_return_if_fail (G_IS_VALUE (value));
973 g_object_ref (container);
974 g_object_ref (child);
975 pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool, property_name,
976 G_OBJECT_TYPE (container), TRUE);
978 g_warning ("%s: container class `%s' has no child property named `%s'",
980 G_OBJECT_TYPE_NAME (container),
982 else if (!(pspec->flags & G_PARAM_READABLE))
983 g_warning ("%s: child property `%s' of container class `%s' is not readable",
986 G_OBJECT_TYPE_NAME (container));
989 GValue *prop_value, tmp_value = G_VALUE_INIT;
991 /* auto-conversion of the callers value type
993 if (G_VALUE_TYPE (value) == G_PARAM_SPEC_VALUE_TYPE (pspec))
995 g_value_reset (value);
998 else if (!g_value_type_transformable (G_PARAM_SPEC_VALUE_TYPE (pspec), G_VALUE_TYPE (value)))
1000 g_warning ("can't retrieve child property `%s' of type `%s' as value of type `%s'",
1002 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
1003 G_VALUE_TYPE_NAME (value));
1004 g_object_unref (child);
1005 g_object_unref (container);
1010 g_value_init (&tmp_value, G_PARAM_SPEC_VALUE_TYPE (pspec));
1011 prop_value = &tmp_value;
1013 container_get_child_property (container, child, pspec, prop_value);
1014 if (prop_value != value)
1016 g_value_transform (prop_value, value);
1017 g_value_unset (&tmp_value);
1020 g_object_unref (child);
1021 g_object_unref (container);
1025 * gtk_container_child_set_valist:
1026 * @container: a #GtkContainer
1027 * @child: a widget which is a child of @container
1028 * @first_property_name: the name of the first property to set
1029 * @var_args: a %NULL-terminated list of property names and values, starting
1030 * with @first_prop_name
1032 * Sets one or more child properties for @child and @container.
1035 gtk_container_child_set_valist (GtkContainer *container,
1037 const gchar *first_property_name,
1040 GObjectNotifyQueue *nqueue;
1043 g_return_if_fail (GTK_IS_CONTAINER (container));
1044 g_return_if_fail (GTK_IS_WIDGET (child));
1046 g_object_ref (container);
1047 g_object_ref (child);
1049 nqueue = g_object_notify_queue_freeze (G_OBJECT (child), _gtk_widget_child_property_notify_context);
1050 name = first_property_name;
1053 GValue value = G_VALUE_INIT;
1054 gchar *error = NULL;
1055 GParamSpec *pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
1057 G_OBJECT_TYPE (container),
1061 g_warning ("%s: container class `%s' has no child property named `%s'",
1063 G_OBJECT_TYPE_NAME (container),
1067 if (!(pspec->flags & G_PARAM_WRITABLE))
1069 g_warning ("%s: child property `%s' of container class `%s' is not writable",
1072 G_OBJECT_TYPE_NAME (container));
1076 G_VALUE_COLLECT_INIT (&value, G_PARAM_SPEC_VALUE_TYPE (pspec),
1077 var_args, 0, &error);
1080 g_warning ("%s: %s", G_STRLOC, error);
1083 /* we purposely leak the value here, it might not be
1084 * in a sane state if an error condition occoured
1088 container_set_child_property (container, child, pspec, &value, nqueue);
1089 g_value_unset (&value);
1090 name = va_arg (var_args, gchar*);
1092 g_object_notify_queue_thaw (G_OBJECT (child), nqueue);
1094 g_object_unref (container);
1095 g_object_unref (child);
1099 * gtk_container_child_set_property:
1100 * @container: a #GtkContainer
1101 * @child: a widget which is a child of @container
1102 * @property_name: the name of the property to set
1103 * @value: the value to set the property to
1105 * Sets a child property for @child and @container.
1108 gtk_container_child_set_property (GtkContainer *container,
1110 const gchar *property_name,
1111 const GValue *value)
1113 GObjectNotifyQueue *nqueue;
1116 g_return_if_fail (GTK_IS_CONTAINER (container));
1117 g_return_if_fail (GTK_IS_WIDGET (child));
1118 g_return_if_fail (property_name != NULL);
1119 g_return_if_fail (G_IS_VALUE (value));
1121 g_object_ref (container);
1122 g_object_ref (child);
1124 nqueue = g_object_notify_queue_freeze (G_OBJECT (child), _gtk_widget_child_property_notify_context);
1125 pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool, property_name,
1126 G_OBJECT_TYPE (container), TRUE);
1128 g_warning ("%s: container class `%s' has no child property named `%s'",
1130 G_OBJECT_TYPE_NAME (container),
1132 else if (!(pspec->flags & G_PARAM_WRITABLE))
1133 g_warning ("%s: child property `%s' of container class `%s' is not writable",
1136 G_OBJECT_TYPE_NAME (container));
1139 container_set_child_property (container, child, pspec, value, nqueue);
1141 g_object_notify_queue_thaw (G_OBJECT (child), nqueue);
1142 g_object_unref (container);
1143 g_object_unref (child);
1147 * gtk_container_add_with_properties:
1148 * @container: a #GtkContainer
1149 * @widget: a widget to be placed inside @container
1150 * @first_prop_name: the name of the first child property to set
1151 * @...: a %NULL-terminated list of property names and values, starting
1152 * with @first_prop_name
1154 * Adds @widget to @container, setting child properties at the same time.
1155 * See gtk_container_add() and gtk_container_child_set() for more details.
1158 gtk_container_add_with_properties (GtkContainer *container,
1160 const gchar *first_prop_name,
1163 g_return_if_fail (GTK_IS_CONTAINER (container));
1164 g_return_if_fail (GTK_IS_WIDGET (widget));
1165 g_return_if_fail (gtk_widget_get_parent (widget) == NULL);
1167 g_object_ref (container);
1168 g_object_ref (widget);
1169 gtk_widget_freeze_child_notify (widget);
1171 g_signal_emit (container, container_signals[ADD], 0, widget);
1172 if (gtk_widget_get_parent (widget))
1176 va_start (var_args, first_prop_name);
1177 gtk_container_child_set_valist (container, widget, first_prop_name, var_args);
1181 gtk_widget_thaw_child_notify (widget);
1182 g_object_unref (widget);
1183 g_object_unref (container);
1187 * gtk_container_child_set:
1188 * @container: a #GtkContainer
1189 * @child: a widget which is a child of @container
1190 * @first_prop_name: the name of the first property to set
1191 * @...: a %NULL-terminated list of property names and values, starting
1192 * with @first_prop_name
1194 * Sets one or more child properties for @child and @container.
1197 gtk_container_child_set (GtkContainer *container,
1199 const gchar *first_prop_name,
1204 va_start (var_args, first_prop_name);
1205 gtk_container_child_set_valist (container, child, first_prop_name, var_args);
1210 * gtk_container_child_get:
1211 * @container: a #GtkContainer
1212 * @child: a widget which is a child of @container
1213 * @first_prop_name: the name of the first property to get
1214 * @...: return location for the first property, followed
1215 * optionally by more name/return location pairs, followed by %NULL
1217 * Gets the values of one or more child properties for @child and @container.
1220 gtk_container_child_get (GtkContainer *container,
1222 const gchar *first_prop_name,
1227 va_start (var_args, first_prop_name);
1228 gtk_container_child_get_valist (container, child, first_prop_name, var_args);
1233 * gtk_container_class_install_child_property:
1234 * @cclass: a #GtkContainerClass
1235 * @property_id: the id for the property
1236 * @pspec: the #GParamSpec for the property
1238 * Installs a child property on a container class.
1241 gtk_container_class_install_child_property (GtkContainerClass *cclass,
1245 g_return_if_fail (GTK_IS_CONTAINER_CLASS (cclass));
1246 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
1247 if (pspec->flags & G_PARAM_WRITABLE)
1248 g_return_if_fail (cclass->set_child_property != NULL);
1249 if (pspec->flags & G_PARAM_READABLE)
1250 g_return_if_fail (cclass->get_child_property != NULL);
1251 g_return_if_fail (property_id > 0);
1252 g_return_if_fail (PARAM_SPEC_PARAM_ID (pspec) == 0); /* paranoid */
1253 if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
1254 g_return_if_fail ((pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY)) == 0);
1256 if (g_param_spec_pool_lookup (_gtk_widget_child_property_pool, pspec->name, G_OBJECT_CLASS_TYPE (cclass), FALSE))
1258 g_warning (G_STRLOC ": class `%s' already contains a child property named `%s'",
1259 G_OBJECT_CLASS_NAME (cclass),
1263 g_param_spec_ref (pspec);
1264 g_param_spec_sink (pspec);
1265 PARAM_SPEC_SET_PARAM_ID (pspec, property_id);
1266 g_param_spec_pool_insert (_gtk_widget_child_property_pool, pspec, G_OBJECT_CLASS_TYPE (cclass));
1270 * gtk_container_class_find_child_property:
1271 * @cclass: (type GtkContainerClass): a #GtkContainerClass
1272 * @property_name: the name of the child property to find
1274 * Finds a child property of a container class by name.
1276 * Returns: (transfer none): the #GParamSpec of the child property
1277 * or %NULL if @class has no child property with that name.
1280 gtk_container_class_find_child_property (GObjectClass *cclass,
1281 const gchar *property_name)
1283 g_return_val_if_fail (GTK_IS_CONTAINER_CLASS (cclass), NULL);
1284 g_return_val_if_fail (property_name != NULL, NULL);
1286 return g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
1288 G_OBJECT_CLASS_TYPE (cclass),
1293 * gtk_container_class_list_child_properties:
1294 * @cclass: (type GtkContainerClass): a #GtkContainerClass
1295 * @n_properties: location to return the number of child properties found
1297 * Returns all child properties of a container class.
1299 * Returns: (array length=n_properties) (transfer container):
1300 * a newly allocated %NULL-terminated array of #GParamSpec*.
1301 * The array must be freed with g_free().
1304 gtk_container_class_list_child_properties (GObjectClass *cclass,
1305 guint *n_properties)
1307 GParamSpec **pspecs;
1310 g_return_val_if_fail (GTK_IS_CONTAINER_CLASS (cclass), NULL);
1312 pspecs = g_param_spec_pool_list (_gtk_widget_child_property_pool,
1313 G_OBJECT_CLASS_TYPE (cclass),
1322 gtk_container_add_unimplemented (GtkContainer *container,
1325 g_warning ("GtkContainerClass::add not implemented for `%s'", g_type_name (G_TYPE_FROM_INSTANCE (container)));
1329 gtk_container_remove_unimplemented (GtkContainer *container,
1332 g_warning ("GtkContainerClass::remove not implemented for `%s'", g_type_name (G_TYPE_FROM_INSTANCE (container)));
1336 gtk_container_init (GtkContainer *container)
1338 GtkContainerPrivate *priv;
1340 container->priv = G_TYPE_INSTANCE_GET_PRIVATE (container,
1342 GtkContainerPrivate);
1343 priv = container->priv;
1345 priv->focus_child = NULL;
1346 priv->border_width = 0;
1347 priv->resize_mode = GTK_RESIZE_PARENT;
1348 priv->reallocate_redraws = FALSE;
1352 gtk_container_destroy (GtkWidget *widget)
1354 GtkContainer *container = GTK_CONTAINER (widget);
1355 GtkContainerPrivate *priv = container->priv;
1357 if (priv->resize_pending)
1358 _gtk_container_dequeue_resize_handler (container);
1359 if (priv->restyle_pending)
1361 container_restyle_queue = g_slist_remove (container_restyle_queue, container);
1362 priv->restyle_pending = FALSE;
1365 if (priv->focus_child)
1367 g_object_unref (priv->focus_child);
1368 priv->focus_child = NULL;
1371 /* do this before walking child widgets, to avoid
1372 * removing children from focus chain one by one.
1374 if (priv->has_focus_chain)
1375 gtk_container_unset_focus_chain (container);
1377 gtk_container_foreach (container, (GtkCallback) gtk_widget_destroy, NULL);
1379 GTK_WIDGET_CLASS (parent_class)->destroy (widget);
1383 gtk_container_set_property (GObject *object,
1385 const GValue *value,
1388 GtkContainer *container = GTK_CONTAINER (object);
1392 case PROP_BORDER_WIDTH:
1393 gtk_container_set_border_width (container, g_value_get_uint (value));
1395 case PROP_RESIZE_MODE:
1396 gtk_container_set_resize_mode (container, g_value_get_enum (value));
1399 gtk_container_add (container, GTK_WIDGET (g_value_get_object (value)));
1402 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1408 gtk_container_get_property (GObject *object,
1413 GtkContainer *container = GTK_CONTAINER (object);
1414 GtkContainerPrivate *priv = container->priv;
1418 case PROP_BORDER_WIDTH:
1419 g_value_set_uint (value, priv->border_width);
1421 case PROP_RESIZE_MODE:
1422 g_value_set_enum (value, priv->resize_mode);
1425 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1431 * gtk_container_set_border_width:
1432 * @container: a #GtkContainer
1433 * @border_width: amount of blank space to leave <emphasis>outside</emphasis>
1434 * the container. Valid values are in the range 0-65535 pixels.
1436 * Sets the border width of the container.
1438 * The border width of a container is the amount of space to leave
1439 * around the outside of the container. The only exception to this is
1440 * #GtkWindow; because toplevel windows can't leave space outside,
1441 * they leave the space inside. The border is added on all sides of
1442 * the container. To add space to only one side, one approach is to
1443 * create a #GtkAlignment widget, call gtk_widget_set_size_request()
1444 * to give it a size, and place it on the side of the container as
1448 gtk_container_set_border_width (GtkContainer *container,
1451 GtkContainerPrivate *priv;
1453 g_return_if_fail (GTK_IS_CONTAINER (container));
1455 priv = container->priv;
1457 if (priv->border_width != border_width)
1459 priv->border_width = border_width;
1460 g_object_notify (G_OBJECT (container), "border-width");
1462 if (gtk_widget_get_realized (GTK_WIDGET (container)))
1463 gtk_widget_queue_resize (GTK_WIDGET (container));
1468 * gtk_container_get_border_width:
1469 * @container: a #GtkContainer
1471 * Retrieves the border width of the container. See
1472 * gtk_container_set_border_width().
1474 * Return value: the current border width
1477 gtk_container_get_border_width (GtkContainer *container)
1479 g_return_val_if_fail (GTK_IS_CONTAINER (container), 0);
1481 return container->priv->border_width;
1485 * gtk_container_add:
1486 * @container: a #GtkContainer
1487 * @widget: a widget to be placed inside @container
1489 * Adds @widget to @container. Typically used for simple containers
1490 * such as #GtkWindow, #GtkFrame, or #GtkButton; for more complicated
1491 * layout containers such as #GtkBox or #GtkGrid, this function will
1492 * pick default packing parameters that may not be correct. So
1493 * consider functions such as gtk_box_pack_start() and
1494 * gtk_grid_attach() as an alternative to gtk_container_add() in
1495 * those cases. A widget may be added to only one container at a time;
1496 * you can't place the same widget inside two different containers.
1499 gtk_container_add (GtkContainer *container,
1504 g_return_if_fail (GTK_IS_CONTAINER (container));
1505 g_return_if_fail (GTK_IS_WIDGET (widget));
1507 parent = gtk_widget_get_parent (widget);
1511 g_warning ("Attempting to add a widget with type %s to a container of "
1512 "type %s, but the widget is already inside a container of type %s, "
1513 "please use gtk_widget_reparent()" ,
1514 g_type_name (G_OBJECT_TYPE (widget)),
1515 g_type_name (G_OBJECT_TYPE (container)),
1516 g_type_name (G_OBJECT_TYPE (parent)));
1520 g_signal_emit (container, container_signals[ADD], 0, widget);
1524 * gtk_container_remove:
1525 * @container: a #GtkContainer
1526 * @widget: a current child of @container
1528 * Removes @widget from @container. @widget must be inside @container.
1529 * Note that @container will own a reference to @widget, and that this
1530 * may be the last reference held; so removing a widget from its
1531 * container can destroy that widget. If you want to use @widget
1532 * again, you need to add a reference to it while it's not inside
1533 * a container, using g_object_ref(). If you don't want to use @widget
1534 * again it's usually more efficient to simply destroy it directly
1535 * using gtk_widget_destroy() since this will remove it from the
1536 * container and help break any circular reference count cycles.
1539 gtk_container_remove (GtkContainer *container,
1542 g_return_if_fail (GTK_IS_CONTAINER (container));
1543 g_return_if_fail (GTK_IS_WIDGET (widget));
1544 g_return_if_fail (gtk_widget_get_parent (widget) == GTK_WIDGET (container) || GTK_IS_ASSISTANT (container));
1546 g_signal_emit (container, container_signals[REMOVE], 0, widget);
1550 _gtk_container_dequeue_resize_handler (GtkContainer *container)
1552 g_return_if_fail (GTK_IS_CONTAINER (container));
1553 g_return_if_fail (container->priv->resize_pending);
1555 container_resize_queue = g_slist_remove (container_resize_queue, container);
1556 container->priv->resize_pending = FALSE;
1560 * gtk_container_set_resize_mode:
1561 * @container: a #GtkContainer
1562 * @resize_mode: the new resize mode
1564 * Sets the resize mode for the container.
1566 * The resize mode of a container determines whether a resize request
1567 * will be passed to the container's parent, queued for later execution
1568 * or executed immediately.
1571 gtk_container_set_resize_mode (GtkContainer *container,
1572 GtkResizeMode resize_mode)
1574 GtkContainerPrivate *priv;
1576 g_return_if_fail (GTK_IS_CONTAINER (container));
1577 g_return_if_fail (resize_mode <= GTK_RESIZE_IMMEDIATE);
1579 priv = container->priv;
1581 if (gtk_widget_is_toplevel (GTK_WIDGET (container)) &&
1582 resize_mode == GTK_RESIZE_PARENT)
1584 resize_mode = GTK_RESIZE_QUEUE;
1587 if (priv->resize_mode != resize_mode)
1589 priv->resize_mode = resize_mode;
1591 gtk_widget_queue_resize (GTK_WIDGET (container));
1592 g_object_notify (G_OBJECT (container), "resize-mode");
1597 * gtk_container_get_resize_mode:
1598 * @container: a #GtkContainer
1600 * Returns the resize mode for the container. See
1601 * gtk_container_set_resize_mode ().
1603 * Return value: the current resize mode
1606 gtk_container_get_resize_mode (GtkContainer *container)
1608 g_return_val_if_fail (GTK_IS_CONTAINER (container), GTK_RESIZE_PARENT);
1610 return container->priv->resize_mode;
1614 * gtk_container_set_reallocate_redraws:
1615 * @container: a #GtkContainer
1616 * @needs_redraws: the new value for the container's @reallocate_redraws flag
1618 * Sets the @reallocate_redraws flag of the container to the given value.
1620 * Containers requesting reallocation redraws get automatically
1621 * redrawn if any of their children changed allocation.
1624 gtk_container_set_reallocate_redraws (GtkContainer *container,
1625 gboolean needs_redraws)
1627 g_return_if_fail (GTK_IS_CONTAINER (container));
1629 container->priv->reallocate_redraws = needs_redraws ? TRUE : FALSE;
1633 gtk_container_idle_sizer (gpointer data)
1636 gint64 current_time;
1638 /* We validate the style contexts in a single loop before even trying
1639 * to handle resizes instead of doing validations inline.
1640 * This is mostly necessary for compatibility reasons with old code,
1641 * because both style_updated and size_allocate functions often change
1642 * styles and so could cause infinite loops in this function.
1644 * It's important to note that even an invalid style context returns
1645 * sane values. So the result of an invalid style context will never be
1646 * a program crash, but only a wrong layout or rendering.
1648 current_time = g_get_monotonic_time ();
1649 slist = container_restyle_queue;
1650 container_restyle_queue = NULL;
1653 GSList *next = slist->next;
1654 GtkContainer *container = slist->data;
1657 empty = _gtk_bitmask_new ();
1659 container->priv->restyle_pending = FALSE;
1660 _gtk_style_context_validate (gtk_widget_get_style_context (GTK_WIDGET (container)),
1665 g_slist_free_1 (slist);
1667 _gtk_bitmask_free (empty);
1670 /* we may be invoked with a container_resize_queue of NULL, because
1671 * queue_resize could have been adding an extra idle function while
1672 * the queue still got processed. we better just ignore such case
1673 * than trying to explicitely work around them with some extra flags,
1674 * since it doesn't cause any actual harm.
1676 while (container_resize_queue)
1678 GtkContainer *container;
1680 slist = container_resize_queue;
1681 container_resize_queue = slist->next;
1682 container = slist->data;
1683 g_slist_free_1 (slist);
1685 container->priv->resize_pending = FALSE;
1686 gtk_container_check_resize (container);
1689 gdk_window_process_all_updates ();
1691 return container_resize_queue != NULL || container_restyle_queue != NULL;
1695 gtk_container_start_idle_sizer (GtkContainer *container)
1697 /* already started */
1698 if (container_resize_queue != NULL ||
1699 container_restyle_queue != NULL)
1702 gdk_threads_add_idle_full (GTK_PRIORITY_RESIZE,
1703 gtk_container_idle_sizer,
1708 gtk_container_queue_resize_handler (GtkContainer *container)
1712 g_return_if_fail (GTK_IS_RESIZE_CONTAINER (container));
1714 widget = GTK_WIDGET (container);
1716 if (gtk_widget_get_visible (widget) &&
1717 (gtk_widget_is_toplevel (widget) ||
1718 gtk_widget_get_realized (widget)))
1720 switch (container->priv->resize_mode)
1722 case GTK_RESIZE_QUEUE:
1723 if (!container->priv->resize_pending)
1725 container->priv->resize_pending = TRUE;
1726 gtk_container_start_idle_sizer (container);
1727 container_resize_queue = g_slist_prepend (container_resize_queue, container);
1731 case GTK_RESIZE_IMMEDIATE:
1732 gtk_container_check_resize (container);
1735 case GTK_RESIZE_PARENT:
1737 g_assert_not_reached ();
1744 _gtk_container_queue_resize_internal (GtkContainer *container,
1745 gboolean invalidate_only)
1749 g_return_if_fail (GTK_IS_CONTAINER (container));
1751 widget = GTK_WIDGET (container);
1755 _gtk_widget_set_alloc_needed (widget, TRUE);
1756 _gtk_widget_set_width_request_needed (widget, TRUE);
1757 _gtk_widget_set_height_request_needed (widget, TRUE);
1759 if (GTK_IS_RESIZE_CONTAINER (widget))
1762 widget = gtk_widget_get_parent (widget);
1766 if (widget && !invalidate_only)
1767 gtk_container_queue_resize_handler (GTK_CONTAINER (widget));
1771 _gtk_container_queue_restyle (GtkContainer *container)
1773 GtkContainerPrivate *priv;
1775 g_return_if_fail (GTK_CONTAINER (container));
1777 priv = container->priv;
1779 if (priv->restyle_pending)
1782 gtk_container_start_idle_sizer (container);
1784 container_restyle_queue = g_slist_prepend (container_restyle_queue, container);
1785 priv->restyle_pending = TRUE;
1789 * _gtk_container_queue_resize:
1790 * @container: a #GtkContainer
1792 * Determines the "resize container" in the hierarchy above this container
1793 * (typically the toplevel, but other containers can be set as resize
1794 * containers with gtk_container_set_resize_mode()), marks the container
1795 * and all parents up to and including the resize container as needing
1796 * to have sizes recompted, and if necessary adds the resize container
1797 * to the queue of containers that will be resized out at idle.
1800 _gtk_container_queue_resize (GtkContainer *container)
1802 _gtk_container_queue_resize_internal (container, FALSE);
1806 * _gtk_container_resize_invalidate:
1807 * @container: a #GtkContainer
1809 * Invalidates cached sizes like _gtk_container_queue_resize() but doesn't
1810 * actually queue the resize container for resize.
1813 _gtk_container_resize_invalidate (GtkContainer *container)
1815 _gtk_container_queue_resize_internal (container, TRUE);
1819 gtk_container_check_resize (GtkContainer *container)
1821 g_return_if_fail (GTK_IS_CONTAINER (container));
1823 g_signal_emit (container, container_signals[CHECK_RESIZE], 0);
1827 gtk_container_real_check_resize (GtkContainer *container)
1829 GtkWidget *widget = GTK_WIDGET (container);
1830 GtkAllocation allocation;
1831 GtkRequisition requisition;
1833 gtk_widget_get_preferred_size (widget,
1834 &requisition, NULL);
1835 gtk_widget_get_allocation (widget, &allocation);
1837 if (requisition.width > allocation.width ||
1838 requisition.height > allocation.height)
1840 if (GTK_IS_RESIZE_CONTAINER (container))
1842 gtk_widget_size_allocate (widget, &allocation);
1843 gtk_widget_set_allocation (widget, &allocation);
1846 gtk_widget_queue_resize (widget);
1850 gtk_container_resize_children (container);
1854 /* The container hasn't changed size but one of its children
1855 * queued a resize request. Which means that the allocation
1856 * is not sufficient for the requisition of some child.
1857 * We've already performed a size request at this point,
1858 * so we simply need to reallocate and let the allocation
1859 * trickle down via GTK_WIDGET_ALLOC_NEEDED flags.
1862 gtk_container_resize_children (GtkContainer *container)
1864 GtkAllocation allocation;
1867 /* resizing invariants:
1868 * toplevels have *always* resize_mode != GTK_RESIZE_PARENT set.
1869 * containers that have an idle sizer pending must be flagged with
1872 g_return_if_fail (GTK_IS_CONTAINER (container));
1874 widget = GTK_WIDGET (container);
1875 gtk_widget_get_allocation (widget, &allocation);
1877 gtk_widget_size_allocate (widget, &allocation);
1878 gtk_widget_set_allocation (widget, &allocation);
1882 gtk_container_adjust_size_request (GtkWidget *widget,
1883 GtkOrientation orientation,
1887 GtkContainer *container;
1889 container = GTK_CONTAINER (widget);
1891 if (GTK_CONTAINER_GET_CLASS (widget)->_handle_border_width)
1895 border_width = container->priv->border_width;
1897 *minimum_size += border_width * 2;
1898 *natural_size += border_width * 2;
1901 /* chain up last so gtk_widget_set_size_request() values
1902 * will have a chance to overwrite our border width.
1904 parent_class->adjust_size_request (widget, orientation,
1905 minimum_size, natural_size);
1909 gtk_container_adjust_size_allocation (GtkWidget *widget,
1910 GtkOrientation orientation,
1913 gint *allocated_pos,
1914 gint *allocated_size)
1916 GtkContainer *container;
1919 container = GTK_CONTAINER (widget);
1921 if (GTK_CONTAINER_GET_CLASS (widget)->_handle_border_width)
1923 border_width = container->priv->border_width;
1925 *allocated_size -= border_width * 2;
1926 *allocated_pos += border_width;
1927 *minimum_size -= border_width * 2;
1928 *natural_size -= border_width * 2;
1931 /* Chain up to GtkWidgetClass *after* removing our border width from
1932 * the proposed allocation size. This is because it's possible that the
1933 * widget was allocated more space than it needs in a said orientation,
1934 * if GtkWidgetClass does any alignments and thus limits the size to the
1935 * natural size... then we need that to be done *after* removing any margins
1936 * and padding values.
1938 parent_class->adjust_size_allocation (widget, orientation,
1939 minimum_size, natural_size, allocated_pos,
1949 count_request_modes (GtkWidget *widget,
1950 RequestModeCount *count)
1952 GtkSizeRequestMode mode = gtk_widget_get_request_mode (widget);
1956 case GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH:
1959 case GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT:
1962 case GTK_SIZE_REQUEST_CONSTANT_SIZE:
1968 static GtkSizeRequestMode
1969 gtk_container_get_request_mode (GtkWidget *widget)
1971 GtkContainer *container = GTK_CONTAINER (widget);
1972 GtkContainerPrivate *priv = container->priv;
1974 /* Recalculate the request mode of the children by majority
1975 * vote whenever the internal content changes */
1976 if (_gtk_widget_get_width_request_needed (widget) ||
1977 _gtk_widget_get_height_request_needed (widget))
1979 RequestModeCount count = { 0, 0 };
1981 gtk_container_forall (container, (GtkCallback)count_request_modes, &count);
1983 if (!count.hfw && !count.wfh)
1984 priv->request_mode = GTK_SIZE_REQUEST_CONSTANT_SIZE;
1986 priv->request_mode = count.wfh > count.hfw ?
1987 GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT :
1988 GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH;
1991 return priv->request_mode;
1995 * gtk_container_class_handle_border_width:
1996 * @klass: the class struct of a #GtkContainer subclass
1998 * Modifies a subclass of #GtkContainerClass to automatically add and
1999 * remove the border-width setting on GtkContainer. This allows the
2000 * subclass to ignore the border width in its size request and
2001 * allocate methods. The intent is for a subclass to invoke this
2002 * in its class_init function.
2004 * gtk_container_class_handle_border_width() is necessary because it
2005 * would break API too badly to make this behavior the default. So
2006 * subclasses must "opt in" to the parent class handling border_width
2010 gtk_container_class_handle_border_width (GtkContainerClass *klass)
2012 g_return_if_fail (GTK_IS_CONTAINER_CLASS (klass));
2014 klass->_handle_border_width = TRUE;
2018 * gtk_container_forall:
2019 * @container: a #GtkContainer
2020 * @callback: (scope call) (closure callback_data): a callback
2021 * @callback_data: callback user data
2023 * Invokes @callback on each child of @container, including children
2024 * that are considered "internal" (implementation details of the
2025 * container). "Internal" children generally weren't added by the user
2026 * of the container, but were added by the container implementation
2027 * itself. Most applications should use gtk_container_foreach(),
2028 * rather than gtk_container_forall().
2033 gtk_container_forall (GtkContainer *container,
2034 GtkCallback callback,
2035 gpointer callback_data)
2037 GtkContainerClass *class;
2039 g_return_if_fail (GTK_IS_CONTAINER (container));
2040 g_return_if_fail (callback != NULL);
2042 class = GTK_CONTAINER_GET_CLASS (container);
2045 class->forall (container, TRUE, callback, callback_data);
2049 * gtk_container_foreach:
2050 * @container: a #GtkContainer
2051 * @callback: (scope call): a callback
2052 * @callback_data: callback user data
2054 * Invokes @callback on each non-internal child of @container. See
2055 * gtk_container_forall() for details on what constitutes an
2056 * "internal" child. Most applications should use
2057 * gtk_container_foreach(), rather than gtk_container_forall().
2060 gtk_container_foreach (GtkContainer *container,
2061 GtkCallback callback,
2062 gpointer callback_data)
2064 GtkContainerClass *class;
2066 g_return_if_fail (GTK_IS_CONTAINER (container));
2067 g_return_if_fail (callback != NULL);
2069 class = GTK_CONTAINER_GET_CLASS (container);
2072 class->forall (container, FALSE, callback, callback_data);
2076 * gtk_container_set_focus_child:
2077 * @container: a #GtkContainer
2078 * @child: (allow-none): a #GtkWidget, or %NULL
2080 * Sets, or unsets if @child is %NULL, the focused child of @container.
2082 * This function emits the GtkContainer::set_focus_child signal of
2083 * @container. Implementations of #GtkContainer can override the
2084 * default behaviour by overriding the class closure of this signal.
2086 * This is function is mostly meant to be used by widgets. Applications can use
2087 * gtk_widget_grab_focus() to manualy set the focus to a specific widget.
2090 gtk_container_set_focus_child (GtkContainer *container,
2093 g_return_if_fail (GTK_IS_CONTAINER (container));
2095 g_return_if_fail (GTK_IS_WIDGET (child));
2097 g_signal_emit (container, container_signals[SET_FOCUS_CHILD], 0, child);
2101 * gtk_container_get_focus_child:
2102 * @container: a #GtkContainer
2104 * Returns the current focus child widget inside @container. This is not the
2105 * currently focused widget. That can be obtained by calling
2106 * gtk_window_get_focus().
2108 * Returns: (transfer none): The child widget which will receive the
2109 * focus inside @container when the @conatiner is focussed,
2110 * or %NULL if none is set.
2115 gtk_container_get_focus_child (GtkContainer *container)
2117 g_return_val_if_fail (GTK_IS_CONTAINER (container), NULL);
2119 return container->priv->focus_child;
2123 * gtk_container_get_children:
2124 * @container: a #GtkContainer
2126 * Returns the container's non-internal children. See
2127 * gtk_container_forall() for details on what constitutes an "internal" child.
2129 * Return value: (element-type GtkWidget) (transfer container): a newly-allocated list of the container's non-internal children.
2132 gtk_container_get_children (GtkContainer *container)
2134 GList *children = NULL;
2136 gtk_container_foreach (container,
2137 gtk_container_children_callback,
2140 return g_list_reverse (children);
2144 gtk_container_child_position_callback (GtkWidget *widget,
2145 gpointer client_data)
2151 } *data = client_data;
2154 if (data->child == widget)
2155 data->index = data->i;
2159 gtk_container_child_default_composite_name (GtkContainer *container,
2169 /* fallback implementation */
2173 gtk_container_forall (container,
2174 gtk_container_child_position_callback,
2177 name = g_strdup_printf ("%s-%u",
2178 g_type_name (G_TYPE_FROM_INSTANCE (child)),
2185 _gtk_container_child_composite_name (GtkContainer *container,
2188 gboolean composite_child;
2190 g_return_val_if_fail (GTK_IS_CONTAINER (container), NULL);
2191 g_return_val_if_fail (GTK_IS_WIDGET (child), NULL);
2192 g_return_val_if_fail (gtk_widget_get_parent (child) == GTK_WIDGET (container), NULL);
2194 g_object_get (child, "composite-child", &composite_child, NULL);
2195 if (composite_child)
2197 static GQuark quark_composite_name = 0;
2200 if (!quark_composite_name)
2201 quark_composite_name = g_quark_from_static_string ("gtk-composite-name");
2203 name = g_object_get_qdata (G_OBJECT (child), quark_composite_name);
2206 GtkContainerClass *class;
2208 class = GTK_CONTAINER_GET_CLASS (container);
2209 if (class->composite_name)
2210 name = class->composite_name (container, child);
2213 name = g_strdup (name);
2224 } ComputeExpandData;
2227 gtk_container_compute_expand_callback (GtkWidget *widget,
2228 gpointer client_data)
2230 ComputeExpandData *data = client_data;
2232 /* note that we don't get_expand on the child if we already know we
2233 * have to expand, so we only recurse into children until we find
2234 * one that expands and then we basically don't do any more
2235 * work. This means that we can leave some children in a
2236 * need_compute_expand state, which is fine, as long as GtkWidget
2237 * doesn't rely on an invariant that "if a child has
2238 * need_compute_expand, its parents also do"
2240 * gtk_widget_compute_expand() always returns FALSE if the
2241 * child is !visible so that's taken care of.
2243 data->hexpand = data->hexpand ||
2244 gtk_widget_compute_expand (widget, GTK_ORIENTATION_HORIZONTAL);
2246 data->vexpand = data->vexpand ||
2247 gtk_widget_compute_expand (widget, GTK_ORIENTATION_VERTICAL);
2251 gtk_container_compute_expand (GtkWidget *widget,
2252 gboolean *hexpand_p,
2253 gboolean *vexpand_p)
2255 ComputeExpandData data;
2257 data.hexpand = FALSE;
2258 data.vexpand = FALSE;
2260 gtk_container_forall (GTK_CONTAINER (widget),
2261 gtk_container_compute_expand_callback,
2264 *hexpand_p = data.hexpand;
2265 *vexpand_p = data.vexpand;
2269 gtk_container_real_set_focus_child (GtkContainer *container,
2272 GtkContainerPrivate *priv;
2274 g_return_if_fail (GTK_IS_CONTAINER (container));
2275 g_return_if_fail (child == NULL || GTK_IS_WIDGET (child));
2277 priv = container->priv;
2279 if (child != priv->focus_child)
2281 if (priv->focus_child)
2282 g_object_unref (priv->focus_child);
2283 priv->focus_child = child;
2284 if (priv->focus_child)
2285 g_object_ref (priv->focus_child);
2289 /* check for h/v adjustments
2291 if (priv->focus_child)
2293 GtkAdjustment *hadj;
2294 GtkAdjustment *vadj;
2295 GtkAllocation allocation;
2296 GtkWidget *focus_child;
2299 hadj = g_object_get_qdata (G_OBJECT (container), hadjustment_key_id);
2300 vadj = g_object_get_qdata (G_OBJECT (container), vadjustment_key_id);
2304 focus_child = priv->focus_child;
2305 while (GTK_IS_CONTAINER (focus_child) && gtk_container_get_focus_child (GTK_CONTAINER (focus_child)))
2307 focus_child = gtk_container_get_focus_child (GTK_CONTAINER (focus_child));
2310 gtk_widget_translate_coordinates (focus_child, priv->focus_child,
2313 gtk_widget_get_allocation (priv->focus_child, &allocation);
2317 gtk_widget_get_allocation (focus_child, &allocation);
2320 gtk_adjustment_clamp_page (vadj, y, y + allocation.height);
2323 gtk_adjustment_clamp_page (hadj, x, x + allocation.width);
2329 get_focus_chain (GtkContainer *container)
2331 return g_object_get_data (G_OBJECT (container), "gtk-container-focus-chain");
2334 /* same as gtk_container_get_children, except it includes internals
2337 _gtk_container_get_all_children (GtkContainer *container)
2339 GList *children = NULL;
2341 gtk_container_forall (container,
2342 gtk_container_children_callback,
2348 static GtkWidgetPath *
2349 gtk_container_real_get_path_for_child (GtkContainer *container,
2352 GtkStyleContext *context;
2353 GtkWidgetPath *path;
2356 context = gtk_widget_get_style_context (GTK_WIDGET (container));
2357 path = _gtk_widget_create_path (GTK_WIDGET (container));
2359 /* Copy any permanent classes to the path */
2360 classes = gtk_style_context_list_classes (context);
2367 classes = classes->next;
2369 gtk_widget_path_iter_add_class (path, -1, cur->data);
2370 g_list_free_1 (cur);
2373 gtk_widget_path_append_for_widget (path, child);
2379 gtk_container_focus (GtkWidget *widget,
2380 GtkDirectionType direction)
2383 GList *sorted_children;
2385 GtkContainer *container;
2386 GtkContainerPrivate *priv;
2388 g_return_val_if_fail (GTK_IS_CONTAINER (widget), FALSE);
2390 container = GTK_CONTAINER (widget);
2391 priv = container->priv;
2395 if (gtk_widget_get_can_focus (widget))
2397 if (!gtk_widget_has_focus (widget))
2399 gtk_widget_grab_focus (widget);
2405 /* Get a list of the containers children, allowing focus
2406 * chain to override.
2408 if (priv->has_focus_chain)
2409 children = g_list_copy (get_focus_chain (container));
2411 children = _gtk_container_get_all_children (container);
2413 if (priv->has_focus_chain &&
2414 (direction == GTK_DIR_TAB_FORWARD ||
2415 direction == GTK_DIR_TAB_BACKWARD))
2417 sorted_children = g_list_copy (children);
2419 if (direction == GTK_DIR_TAB_BACKWARD)
2420 sorted_children = g_list_reverse (sorted_children);
2423 sorted_children = _gtk_container_focus_sort (container, children, direction, NULL);
2425 return_val = gtk_container_focus_move (container, sorted_children, direction);
2427 g_list_free (sorted_children);
2428 g_list_free (children);
2435 tab_compare (gconstpointer a,
2439 GtkAllocation child1_allocation, child2_allocation;
2440 const GtkWidget *child1 = a;
2441 const GtkWidget *child2 = b;
2442 GtkTextDirection text_direction = GPOINTER_TO_INT (data);
2445 gtk_widget_get_allocation ((GtkWidget *) child1, &child1_allocation);
2446 gtk_widget_get_allocation ((GtkWidget *) child2, &child2_allocation);
2448 y1 = child1_allocation.y + child1_allocation.height / 2;
2449 y2 = child2_allocation.y + child2_allocation.height / 2;
2453 gint x1 = child1_allocation.x + child1_allocation.width / 2;
2454 gint x2 = child2_allocation.x + child2_allocation.width / 2;
2456 if (text_direction == GTK_TEXT_DIR_RTL)
2457 return (x1 < x2) ? 1 : ((x1 == x2) ? 0 : -1);
2459 return (x1 < x2) ? -1 : ((x1 == x2) ? 0 : 1);
2462 return (y1 < y2) ? -1 : 1;
2466 gtk_container_focus_sort_tab (GtkContainer *container,
2468 GtkDirectionType direction,
2469 GtkWidget *old_focus)
2471 GtkTextDirection text_direction = gtk_widget_get_direction (GTK_WIDGET (container));
2472 children = g_list_sort_with_data (children, tab_compare, GINT_TO_POINTER (text_direction));
2474 /* if we are going backwards then reverse the order
2477 if (direction == GTK_DIR_TAB_BACKWARD)
2478 children = g_list_reverse (children);
2483 /* Get coordinates of @widget's allocation with respect to
2484 * allocation of @container.
2487 get_allocation_coords (GtkContainer *container,
2489 GdkRectangle *allocation)
2491 gtk_widget_get_allocation (widget, allocation);
2493 return gtk_widget_translate_coordinates (widget, GTK_WIDGET (container),
2494 0, 0, &allocation->x, &allocation->y);
2497 /* Look for a child in @children that is intermediate between
2498 * the focus widget and container. This widget, if it exists,
2499 * acts as the starting widget for focus navigation.
2502 find_old_focus (GtkContainer *container,
2505 GList *tmp_list = children;
2508 GtkWidget *child = tmp_list->data;
2509 GtkWidget *widget = child;
2511 while (widget && widget != (GtkWidget *)container)
2515 parent = gtk_widget_get_parent (widget);
2517 if (parent && (gtk_container_get_focus_child (GTK_CONTAINER (parent)) != widget))
2526 tmp_list = tmp_list->next;
2533 old_focus_coords (GtkContainer *container,
2534 GdkRectangle *old_focus_rect)
2536 GtkWidget *widget = GTK_WIDGET (container);
2537 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
2538 GtkWidget *old_focus;
2540 if (GTK_IS_WINDOW (toplevel))
2542 old_focus = gtk_window_get_focus (GTK_WINDOW (toplevel));
2544 return get_allocation_coords (container, old_focus, old_focus_rect);
2550 typedef struct _CompareInfo CompareInfo;
2554 GtkContainer *container;
2561 up_down_compare (gconstpointer a,
2565 GdkRectangle allocation1;
2566 GdkRectangle allocation2;
2567 CompareInfo *compare = data;
2570 get_allocation_coords (compare->container, (GtkWidget *)a, &allocation1);
2571 get_allocation_coords (compare->container, (GtkWidget *)b, &allocation2);
2573 y1 = allocation1.y + allocation1.height / 2;
2574 y2 = allocation2.y + allocation2.height / 2;
2578 gint x1 = abs (allocation1.x + allocation1.width / 2 - compare->x);
2579 gint x2 = abs (allocation2.x + allocation2.width / 2 - compare->x);
2581 if (compare->reverse)
2582 return (x1 < x2) ? 1 : ((x1 == x2) ? 0 : -1);
2584 return (x1 < x2) ? -1 : ((x1 == x2) ? 0 : 1);
2587 return (y1 < y2) ? -1 : 1;
2591 gtk_container_focus_sort_up_down (GtkContainer *container,
2593 GtkDirectionType direction,
2594 GtkWidget *old_focus)
2596 CompareInfo compare;
2598 GdkRectangle old_allocation;
2600 compare.container = container;
2601 compare.reverse = (direction == GTK_DIR_UP);
2604 old_focus = find_old_focus (container, children);
2606 if (old_focus && get_allocation_coords (container, old_focus, &old_allocation))
2612 /* Delete widgets from list that don't match minimum criteria */
2614 compare_x1 = old_allocation.x;
2615 compare_x2 = old_allocation.x + old_allocation.width;
2617 if (direction == GTK_DIR_UP)
2618 compare_y = old_allocation.y;
2620 compare_y = old_allocation.y + old_allocation.height;
2622 tmp_list = children;
2625 GtkWidget *child = tmp_list->data;
2626 GList *next = tmp_list->next;
2627 gint child_x1, child_x2;
2628 GdkRectangle child_allocation;
2630 if (child != old_focus)
2632 if (get_allocation_coords (container, child, &child_allocation))
2634 child_x1 = child_allocation.x;
2635 child_x2 = child_allocation.x + child_allocation.width;
2637 if ((child_x2 <= compare_x1 || child_x1 >= compare_x2) /* No horizontal overlap */ ||
2638 (direction == GTK_DIR_DOWN && child_allocation.y + child_allocation.height < compare_y) || /* Not below */
2639 (direction == GTK_DIR_UP && child_allocation.y > compare_y)) /* Not above */
2641 children = g_list_delete_link (children, tmp_list);
2645 children = g_list_delete_link (children, tmp_list);
2651 compare.x = (compare_x1 + compare_x2) / 2;
2652 compare.y = old_allocation.y + old_allocation.height / 2;
2656 /* No old focus widget, need to figure out starting x,y some other way
2658 GtkAllocation allocation;
2659 GtkWidget *widget = GTK_WIDGET (container);
2660 GdkRectangle old_focus_rect;
2662 gtk_widget_get_allocation (widget, &allocation);
2664 if (old_focus_coords (container, &old_focus_rect))
2666 compare.x = old_focus_rect.x + old_focus_rect.width / 2;
2670 if (!gtk_widget_get_has_window (widget))
2671 compare.x = allocation.x + allocation.width / 2;
2673 compare.x = allocation.width / 2;
2676 if (!gtk_widget_get_has_window (widget))
2677 compare.y = (direction == GTK_DIR_DOWN) ? allocation.y : allocation.y + allocation.height;
2679 compare.y = (direction == GTK_DIR_DOWN) ? 0 : + allocation.height;
2682 children = g_list_sort_with_data (children, up_down_compare, &compare);
2684 if (compare.reverse)
2685 children = g_list_reverse (children);
2691 left_right_compare (gconstpointer a,
2695 GdkRectangle allocation1;
2696 GdkRectangle allocation2;
2697 CompareInfo *compare = data;
2700 get_allocation_coords (compare->container, (GtkWidget *)a, &allocation1);
2701 get_allocation_coords (compare->container, (GtkWidget *)b, &allocation2);
2703 x1 = allocation1.x + allocation1.width / 2;
2704 x2 = allocation2.x + allocation2.width / 2;
2708 gint y1 = abs (allocation1.y + allocation1.height / 2 - compare->y);
2709 gint y2 = abs (allocation2.y + allocation2.height / 2 - compare->y);
2711 if (compare->reverse)
2712 return (y1 < y2) ? 1 : ((y1 == y2) ? 0 : -1);
2714 return (y1 < y2) ? -1 : ((y1 == y2) ? 0 : 1);
2717 return (x1 < x2) ? -1 : 1;
2721 gtk_container_focus_sort_left_right (GtkContainer *container,
2723 GtkDirectionType direction,
2724 GtkWidget *old_focus)
2726 CompareInfo compare;
2728 GdkRectangle old_allocation;
2730 compare.container = container;
2731 compare.reverse = (direction == GTK_DIR_LEFT);
2734 old_focus = find_old_focus (container, children);
2736 if (old_focus && get_allocation_coords (container, old_focus, &old_allocation))
2742 /* Delete widgets from list that don't match minimum criteria */
2744 compare_y1 = old_allocation.y;
2745 compare_y2 = old_allocation.y + old_allocation.height;
2747 if (direction == GTK_DIR_LEFT)
2748 compare_x = old_allocation.x;
2750 compare_x = old_allocation.x + old_allocation.width;
2752 tmp_list = children;
2755 GtkWidget *child = tmp_list->data;
2756 GList *next = tmp_list->next;
2757 gint child_y1, child_y2;
2758 GdkRectangle child_allocation;
2760 if (child != old_focus)
2762 if (get_allocation_coords (container, child, &child_allocation))
2764 child_y1 = child_allocation.y;
2765 child_y2 = child_allocation.y + child_allocation.height;
2767 if ((child_y2 <= compare_y1 || child_y1 >= compare_y2) /* No vertical overlap */ ||
2768 (direction == GTK_DIR_RIGHT && child_allocation.x + child_allocation.width < compare_x) || /* Not to left */
2769 (direction == GTK_DIR_LEFT && child_allocation.x > compare_x)) /* Not to right */
2771 children = g_list_delete_link (children, tmp_list);
2775 children = g_list_delete_link (children, tmp_list);
2781 compare.y = (compare_y1 + compare_y2) / 2;
2782 compare.x = old_allocation.x + old_allocation.width / 2;
2786 /* No old focus widget, need to figure out starting x,y some other way
2788 GtkAllocation allocation;
2789 GtkWidget *widget = GTK_WIDGET (container);
2790 GdkRectangle old_focus_rect;
2792 gtk_widget_get_allocation (widget, &allocation);
2794 if (old_focus_coords (container, &old_focus_rect))
2796 compare.y = old_focus_rect.y + old_focus_rect.height / 2;
2800 if (!gtk_widget_get_has_window (widget))
2801 compare.y = allocation.y + allocation.height / 2;
2803 compare.y = allocation.height / 2;
2806 if (!gtk_widget_get_has_window (widget))
2807 compare.x = (direction == GTK_DIR_RIGHT) ? allocation.x : allocation.x + allocation.width;
2809 compare.x = (direction == GTK_DIR_RIGHT) ? 0 : allocation.width;
2812 children = g_list_sort_with_data (children, left_right_compare, &compare);
2814 if (compare.reverse)
2815 children = g_list_reverse (children);
2821 * gtk_container_focus_sort:
2822 * @container: a #GtkContainer
2823 * @children: a list of descendents of @container (they don't
2824 * have to be direct children)
2825 * @direction: focus direction
2826 * @old_focus: (allow-none): widget to use for the starting position, or %NULL
2827 * to determine this automatically.
2828 * (Note, this argument isn't used for GTK_DIR_TAB_*,
2829 * which is the only @direction we use currently,
2830 * so perhaps this argument should be removed)
2832 * Sorts @children in the correct order for focusing with
2833 * direction type @direction.
2835 * Return value: a copy of @children, sorted in correct focusing order,
2836 * with children that aren't suitable for focusing in this direction
2840 _gtk_container_focus_sort (GtkContainer *container,
2842 GtkDirectionType direction,
2843 GtkWidget *old_focus)
2845 GList *visible_children = NULL;
2849 if (gtk_widget_get_realized (children->data))
2850 visible_children = g_list_prepend (visible_children, children->data);
2851 children = children->next;
2856 case GTK_DIR_TAB_FORWARD:
2857 case GTK_DIR_TAB_BACKWARD:
2858 return gtk_container_focus_sort_tab (container, visible_children, direction, old_focus);
2861 return gtk_container_focus_sort_up_down (container, visible_children, direction, old_focus);
2864 return gtk_container_focus_sort_left_right (container, visible_children, direction, old_focus);
2867 g_assert_not_reached ();
2873 gtk_container_focus_move (GtkContainer *container,
2875 GtkDirectionType direction)
2877 GtkContainerPrivate *priv = container->priv;
2878 GtkWidget *focus_child;
2881 focus_child = priv->focus_child;
2885 child = children->data;
2886 children = children->next;
2893 if (focus_child == child)
2897 if (gtk_widget_child_focus (child, direction))
2901 else if (gtk_widget_is_drawable (child) &&
2902 gtk_widget_is_ancestor (child, GTK_WIDGET (container)))
2904 if (gtk_widget_child_focus (child, direction))
2914 gtk_container_children_callback (GtkWidget *widget,
2915 gpointer client_data)
2919 children = (GList**) client_data;
2920 *children = g_list_prepend (*children, widget);
2924 chain_widget_destroyed (GtkWidget *widget,
2927 GtkContainer *container;
2930 container = GTK_CONTAINER (user_data);
2932 chain = g_object_get_data (G_OBJECT (container),
2933 "gtk-container-focus-chain");
2935 chain = g_list_remove (chain, widget);
2937 g_signal_handlers_disconnect_by_func (widget,
2938 chain_widget_destroyed,
2941 g_object_set_data (G_OBJECT (container),
2942 I_("gtk-container-focus-chain"),
2947 * gtk_container_set_focus_chain:
2948 * @container: a #GtkContainer
2949 * @focusable_widgets: (transfer none) (element-type GtkWidget):
2950 * the new focus chain
2952 * Sets a focus chain, overriding the one computed automatically by GTK+.
2954 * In principle each widget in the chain should be a descendant of the
2955 * container, but this is not enforced by this method, since it's allowed
2956 * to set the focus chain before you pack the widgets, or have a widget
2957 * in the chain that isn't always packed. The necessary checks are done
2958 * when the focus chain is actually traversed.
2961 gtk_container_set_focus_chain (GtkContainer *container,
2962 GList *focusable_widgets)
2966 GtkContainerPrivate *priv;
2968 g_return_if_fail (GTK_IS_CONTAINER (container));
2970 priv = container->priv;
2972 if (priv->has_focus_chain)
2973 gtk_container_unset_focus_chain (container);
2975 priv->has_focus_chain = TRUE;
2978 tmp_list = focusable_widgets;
2979 while (tmp_list != NULL)
2981 g_return_if_fail (GTK_IS_WIDGET (tmp_list->data));
2983 /* In principle each widget in the chain should be a descendant
2984 * of the container, but we don't want to check that here. It's
2985 * expensive and also it's allowed to set the focus chain before
2986 * you pack the widgets, or have a widget in the chain that isn't
2987 * always packed. So we check for ancestor during actual traversal.
2990 chain = g_list_prepend (chain, tmp_list->data);
2992 g_signal_connect (tmp_list->data,
2994 G_CALLBACK (chain_widget_destroyed),
2997 tmp_list = g_list_next (tmp_list);
3000 chain = g_list_reverse (chain);
3002 g_object_set_data (G_OBJECT (container),
3003 I_("gtk-container-focus-chain"),
3008 * gtk_container_get_focus_chain:
3009 * @container: a #GtkContainer
3010 * @focusable_widgets: (element-type GtkWidget) (out) (transfer container): location
3011 * to store the focus chain of the
3012 * container, or %NULL. You should free this list
3013 * using g_list_free() when you are done with it, however
3014 * no additional reference count is added to the
3015 * individual widgets in the focus chain.
3017 * Retrieves the focus chain of the container, if one has been
3018 * set explicitly. If no focus chain has been explicitly
3019 * set, GTK+ computes the focus chain based on the positions
3020 * of the children. In that case, GTK+ stores %NULL in
3021 * @focusable_widgets and returns %FALSE.
3023 * Return value: %TRUE if the focus chain of the container
3024 * has been set explicitly.
3027 gtk_container_get_focus_chain (GtkContainer *container,
3028 GList **focus_chain)
3030 GtkContainerPrivate *priv;
3032 g_return_val_if_fail (GTK_IS_CONTAINER (container), FALSE);
3034 priv = container->priv;
3038 if (priv->has_focus_chain)
3039 *focus_chain = g_list_copy (get_focus_chain (container));
3041 *focus_chain = NULL;
3044 return priv->has_focus_chain;
3048 * gtk_container_unset_focus_chain:
3049 * @container: a #GtkContainer
3051 * Removes a focus chain explicitly set with gtk_container_set_focus_chain().
3054 gtk_container_unset_focus_chain (GtkContainer *container)
3056 GtkContainerPrivate *priv;
3058 g_return_if_fail (GTK_IS_CONTAINER (container));
3060 priv = container->priv;
3062 if (priv->has_focus_chain)
3067 chain = get_focus_chain (container);
3069 priv->has_focus_chain = FALSE;
3071 g_object_set_data (G_OBJECT (container),
3072 I_("gtk-container-focus-chain"),
3076 while (tmp_list != NULL)
3078 g_signal_handlers_disconnect_by_func (tmp_list->data,
3079 chain_widget_destroyed,
3082 tmp_list = g_list_next (tmp_list);
3085 g_list_free (chain);
3090 * gtk_container_set_focus_vadjustment:
3091 * @container: a #GtkContainer
3092 * @adjustment: an adjustment which should be adjusted when the focus
3093 * is moved among the descendents of @container
3095 * Hooks up an adjustment to focus handling in a container, so when a
3096 * child of the container is focused, the adjustment is scrolled to
3097 * show that widget. This function sets the vertical alignment. See
3098 * gtk_scrolled_window_get_vadjustment() for a typical way of obtaining
3099 * the adjustment and gtk_container_set_focus_hadjustment() for setting
3100 * the horizontal adjustment.
3102 * The adjustments have to be in pixel units and in the same coordinate
3103 * system as the allocation for immediate children of the container.
3106 gtk_container_set_focus_vadjustment (GtkContainer *container,
3107 GtkAdjustment *adjustment)
3109 g_return_if_fail (GTK_IS_CONTAINER (container));
3111 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
3114 g_object_ref (adjustment);
3116 g_object_set_qdata_full (G_OBJECT (container),
3123 * gtk_container_get_focus_vadjustment:
3124 * @container: a #GtkContainer
3126 * Retrieves the vertical focus adjustment for the container. See
3127 * gtk_container_set_focus_vadjustment().
3129 * Return value: (transfer none): the vertical focus adjustment, or %NULL if
3130 * none has been set.
3133 gtk_container_get_focus_vadjustment (GtkContainer *container)
3135 GtkAdjustment *vadjustment;
3137 g_return_val_if_fail (GTK_IS_CONTAINER (container), NULL);
3139 vadjustment = g_object_get_qdata (G_OBJECT (container), vadjustment_key_id);
3145 * gtk_container_set_focus_hadjustment:
3146 * @container: a #GtkContainer
3147 * @adjustment: an adjustment which should be adjusted when the focus is
3148 * moved among the descendents of @container
3150 * Hooks up an adjustment to focus handling in a container, so when a child
3151 * of the container is focused, the adjustment is scrolled to show that
3152 * widget. This function sets the horizontal alignment.
3153 * See gtk_scrolled_window_get_hadjustment() for a typical way of obtaining
3154 * the adjustment and gtk_container_set_focus_vadjustment() for setting
3155 * the vertical adjustment.
3157 * The adjustments have to be in pixel units and in the same coordinate
3158 * system as the allocation for immediate children of the container.
3161 gtk_container_set_focus_hadjustment (GtkContainer *container,
3162 GtkAdjustment *adjustment)
3164 g_return_if_fail (GTK_IS_CONTAINER (container));
3166 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
3169 g_object_ref (adjustment);
3171 g_object_set_qdata_full (G_OBJECT (container),
3178 * gtk_container_get_focus_hadjustment:
3179 * @container: a #GtkContainer
3181 * Retrieves the horizontal focus adjustment for the container. See
3182 * gtk_container_set_focus_hadjustment ().
3184 * Return value: (transfer none): the horizontal focus adjustment, or %NULL if
3185 * none has been set.
3188 gtk_container_get_focus_hadjustment (GtkContainer *container)
3190 GtkAdjustment *hadjustment;
3192 g_return_val_if_fail (GTK_IS_CONTAINER (container), NULL);
3194 hadjustment = g_object_get_qdata (G_OBJECT (container), hadjustment_key_id);
3201 gtk_container_show_all (GtkWidget *widget)
3203 g_return_if_fail (GTK_IS_CONTAINER (widget));
3205 gtk_container_foreach (GTK_CONTAINER (widget),
3206 (GtkCallback) gtk_widget_show_all,
3208 gtk_widget_show (widget);
3212 gtk_container_draw_child (GtkWidget *child,
3213 gpointer client_data)
3216 GtkWidget *container;
3218 } *data = client_data;
3220 gtk_container_propagate_draw (GTK_CONTAINER (data->container),
3226 gtk_container_draw (GtkWidget *widget,
3230 GtkWidget *container;
3234 data.container = widget;
3237 gtk_container_forall (GTK_CONTAINER (widget),
3238 gtk_container_draw_child,
3245 gtk_container_map_child (GtkWidget *child,
3246 gpointer client_data)
3248 if (gtk_widget_get_visible (child) &&
3249 gtk_widget_get_child_visible (child) &&
3250 !gtk_widget_get_mapped (child))
3251 gtk_widget_map (child);
3255 gtk_container_map (GtkWidget *widget)
3257 gtk_widget_set_mapped (widget, TRUE);
3259 gtk_container_forall (GTK_CONTAINER (widget),
3260 gtk_container_map_child,
3263 if (gtk_widget_get_has_window (widget))
3264 gdk_window_show (gtk_widget_get_window (widget));
3268 gtk_container_unmap (GtkWidget *widget)
3270 gtk_widget_set_mapped (widget, FALSE);
3272 /* hide our window first so user doesn't see all the child windows
3273 * vanishing one by one. (only matters these days if one of the
3274 * children has an actual native window instead of client-side
3275 * window, e.g. a GtkSocket would)
3277 if (gtk_widget_get_has_window (widget))
3278 gdk_window_hide (gtk_widget_get_window (widget));
3280 gtk_container_forall (GTK_CONTAINER (widget),
3281 (GtkCallback)gtk_widget_unmap,
3286 * gtk_container_propagate_draw:
3287 * @container: a #GtkContainer
3288 * @child: a child of @container
3289 * @cr: Cairo context as passed to the container. If you want to use @cr
3290 * in container's draw function, consider using cairo_save() and
3291 * cairo_restore() before calling this function.
3293 * When a container receives a call to the draw function, it must send
3294 * synthetic #GtkWidget::draw calls to all children that don't have their
3295 * own #GdkWindows. This function provides a convenient way of doing this.
3296 * A container, when it receives a call to its #GtkWidget::draw function,
3297 * calls gtk_container_propagate_draw() once for each child, passing in
3298 * the @cr the container received.
3300 * gtk_container_propagate_draw() takes care of translating the origin of @cr,
3301 * and deciding whether the draw needs to be sent to the child. It is a
3302 * convenient and optimized way of getting the same effect as calling
3303 * gtk_widget_draw() on the child directly.
3305 * In most cases, a container can simply either inherit the
3306 * #GtkWidget::draw implementation from #GtkContainer, or do some drawing
3307 * and then chain to the ::draw implementation from #GtkContainer.
3310 gtk_container_propagate_draw (GtkContainer *container,
3314 GdkEventExpose *event;
3315 GtkAllocation allocation;
3316 GdkWindow *window, *w;
3319 g_return_if_fail (GTK_IS_CONTAINER (container));
3320 g_return_if_fail (GTK_IS_WIDGET (child));
3321 g_return_if_fail (cr != NULL);
3323 g_assert (gtk_widget_get_parent (child) == GTK_WIDGET (container));
3325 event = _gtk_cairo_get_event (cr);
3328 if (gtk_widget_get_has_window (child) ||
3329 gtk_widget_get_window (child) != event->window)
3335 /* translate coordinates. Ugly business, that. */
3336 if (!gtk_widget_get_has_window (GTK_WIDGET (container)))
3338 gtk_widget_get_allocation (GTK_WIDGET (container), &allocation);
3348 window = gtk_widget_get_window (GTK_WIDGET (container));
3350 for (w = gtk_widget_get_window (child); w && w != window; w = gdk_window_get_parent (w))
3353 gdk_window_get_position (w, &wx, &wy);
3364 if (!gtk_widget_get_has_window (child))
3366 gtk_widget_get_allocation (child, &allocation);
3371 cairo_translate (cr, x, y);
3373 _gtk_widget_draw_internal (child, cr, TRUE);
3379 _gtk_container_get_reallocate_redraws (GtkContainer *container)
3381 return container->priv->reallocate_redraws;
3385 * gtk_container_get_path_for_child:
3386 * @container: a #GtkContainer
3387 * @child: a child of @container
3389 * Returns a newly created widget path representing all the widget hierarchy
3390 * from the toplevel down to and including @child.
3392 * Returns: A newly created #GtkWidgetPath
3395 gtk_container_get_path_for_child (GtkContainer *container,
3398 GtkWidgetPath *path;
3400 g_return_val_if_fail (GTK_IS_CONTAINER (container), NULL);
3401 g_return_val_if_fail (GTK_IS_WIDGET (child), NULL);
3402 g_return_val_if_fail (container == (GtkContainer *) gtk_widget_get_parent (child), NULL);
3404 path = GTK_CONTAINER_GET_CLASS (container)->get_path_for_child (container, child);
3405 if (gtk_widget_path_get_object_type (path) != G_OBJECT_TYPE (child))
3407 g_critical ("%s %p returned a widget path for type %s, but child is %s",
3408 G_OBJECT_TYPE_NAME (container),
3410 g_type_name (gtk_widget_path_get_object_type (path)),
3411 G_OBJECT_TYPE_NAME (child));