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 "a11y/gtkcontaineraccessible.h"
52 * SECTION:gtkcontainer
53 * @Short_description: Base class for widgets which contain other widgets
54 * @Title: GtkContainer
56 * A GTK+ user interface is constructed by nesting widgets inside widgets.
57 * Container widgets are the inner nodes in the resulting tree of widgets:
58 * they contain other widgets. So, for example, you might have a #GtkWindow
59 * containing a #GtkFrame containing a #GtkLabel. If you wanted an image instead
60 * of a textual label inside the frame, you might replace the #GtkLabel widget
61 * with a #GtkImage widget.
63 * There are two major kinds of container widgets in GTK+. Both are subclasses
64 * of the abstract GtkContainer base class.
66 * The first type of container widget has a single child widget and derives
67 * from #GtkBin. These containers are <emphasis>decorators</emphasis>, which
68 * add some kind of functionality to the child. For example, a #GtkButton makes
69 * its child into a clickable button; a #GtkFrame draws a frame around its child
70 * and a #GtkWindow places its child widget inside a top-level window.
72 * The second type of container can have more than one child; its purpose is to
73 * manage <emphasis>layout</emphasis>. This means that these containers assign
74 * sizes and positions to their children. For example, a #GtkHBox arranges its
75 * children in a horizontal row, and a #GtkGrid arranges the widgets it contains
76 * in a two-dimensional grid.
78 * <refsect2 id="container-geometry-management">
79 * <title>Height for width geometry management</title>
81 * GTK+ uses a height-for-width (and width-for-height) geometry management system.
82 * Height-for-width means that a widget can change how much vertical space it needs,
83 * depending on the amount of horizontal space that it is given (and similar for
86 * There are some things to keep in mind when implementing container widgets
87 * that make use of GTK+'s height for width geometry management system. First,
88 * it's important to note that a container must prioritize one of its
89 * dimensions, that is to say that a widget or container can only have a
90 * #GtkSizeRequestMode that is %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH or
91 * %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT. However, every widget and container
92 * must be able to respond to the APIs for both dimensions, i.e. even if a
93 * widget has a request mode that is height-for-width, it is possible that
94 * its parent will request its sizes using the width-for-height APIs.
96 * To ensure that everything works properly, here are some guidelines to follow
97 * when implementing height-for-width (or width-for-height) containers.
99 * Each request mode involves 2 virtual methods. Height-for-width apis run
100 * through gtk_widget_get_preferred_width() and then through gtk_widget_get_preferred_height_for_width().
101 * When handling requests in the opposite #GtkSizeRequestMode it is important that
102 * every widget request at least enough space to display all of its content at all times.
104 * When gtk_widget_get_preferred_height() is called on a container that is height-for-width,
105 * the container must return the height for its minimum width. This is easily achieved by
106 * simply calling the reverse apis implemented for itself as follows:
108 * <programlisting><![CDATA[
110 * foo_container_get_preferred_height (GtkWidget *widget, gint *min_height, gint *nat_height)
112 * if (i_am_in_height_for_width_mode)
116 * GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, &min_width, NULL);
117 * GTK_WIDGET_GET_CLASS (widget)->get_preferred_height_for_width (widget, min_width,
118 * min_height, nat_height);
122 * ... many containers support both request modes, execute the real width-for-height
123 * request here by returning the collective heights of all widgets that are
124 * stacked vertically (or whatever is appropriate for this container) ...
127 * ]]></programlisting>
129 * Similarly, when gtk_widget_get_preferred_width_for_height() is called for a container or widget
130 * that is height-for-width, it then only needs to return the base minimum width like so:
132 * <programlisting><![CDATA[
134 * foo_container_get_preferred_width_for_height (GtkWidget *widget, gint for_height,
135 * gint *min_width, gint *nat_width)
137 * if (i_am_in_height_for_width_mode)
139 * GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, min_width, nat_width);
143 * ... execute the real width-for-height request here based on the required width
144 * of the children collectively if the container were to be allocated the said height ...
147 * ]]></programlisting>
149 * Height for width requests are generally implemented in terms of a virtual allocation
150 * of widgets in the input orientation. Assuming an height-for-width request mode, a container
151 * would implement the <function>get_preferred_height_for_width()</function> virtual function by first calling
152 * gtk_widget_get_preferred_width() for each of its children.
154 * For each potential group of children that are lined up horizontally, the values returned by
155 * gtk_widget_get_preferred_width() should be collected in an array of #GtkRequestedSize structures.
156 * Any child spacing should be removed from the input @for_width and then the collective size should be
157 * allocated using the gtk_distribute_natural_allocation() convenience function.
159 * The container will then move on to request the preferred height for each child by using
160 * gtk_widget_get_preferred_height_for_width() and using the sizes stored in the #GtkRequestedSize array.
162 * To allocate a height-for-width container, it's again important
163 * to consider that a container must prioritize one dimension over the other. So if
164 * a container is a height-for-width container it must first allocate all widgets horizontally
165 * using a #GtkRequestedSize array and gtk_distribute_natural_allocation() and then add any
166 * extra space (if and where appropriate) for the widget to expand.
168 * After adding all the expand space, the container assumes it was allocated sufficient
169 * height to fit all of its content. At this time, the container must use the total horizontal sizes
170 * of each widget to request the height-for-width of each of its children and store the requests in a
171 * #GtkRequestedSize array for any widgets that stack vertically (for tabular containers this can
172 * be generalized into the heights and widths of rows and columns).
173 * The vertical space must then again be distributed using gtk_distribute_natural_allocation()
174 * while this time considering the allocated height of the widget minus any vertical spacing
175 * that the container adds. Then vertical expand space should be added where appropriate and available
176 * and the container should go on to actually allocating the child widgets.
178 * See <link linkend="geometry-management">GtkWidget's geometry management section</link>
179 * to learn more about implementing height-for-width geometry management for widgets.
182 * <refsect2 id="child-properties">
183 * <title>Child properties</title>
185 * GtkContainer introduces <emphasis>child properties</emphasis>.
186 * These are object properties that are not specific
187 * to either the container or the contained widget, but rather to their relation.
188 * Typical examples of child properties are the position or pack-type of a widget
189 * which is contained in a #GtkBox.
191 * Use gtk_container_class_install_child_property() to install child properties
192 * for a container class and gtk_container_class_find_child_property() or
193 * gtk_container_class_list_child_properties() to get information about existing
196 * To set the value of a child property, use gtk_container_child_set_property(),
197 * gtk_container_child_set() or gtk_container_child_set_valist().
198 * To obtain the value of a child property, use
199 * gtk_container_child_get_property(), gtk_container_child_get() or
200 * gtk_container_child_get_valist(). To emit notification about child property
201 * changes, use gtk_widget_child_notify().
204 * <refsect2 id="GtkContainer-BUILDER-UI">
205 * <title>GtkContainer as GtkBuildable</title>
207 * The GtkContainer implementation of the GtkBuildable interface
208 * supports a <packing> element for children, which can
209 * contain multiple <property> elements that specify
210 * child properties for the child.
212 * <title>Child properties in UI definitions</title>
213 * <programlisting><![CDATA[
214 * <object class="GtkVBox">
216 * <object class="GtkLabel"/>
218 * <property name="pack-type">start</property>
222 * ]]></programlisting>
224 * Since 2.16, child properties can also be marked as translatable using
225 * the same "translatable", "comments" and "context" attributes that are used
226 * for regular properties.
232 struct _GtkContainerPrivate
234 GtkWidget *focus_child;
236 guint border_width : 16;
238 guint has_focus_chain : 1;
239 guint need_resize : 1;
240 guint reallocate_redraws : 1;
241 guint resize_mode : 2;
242 guint request_mode : 2;
260 #define PARAM_SPEC_PARAM_ID(pspec) ((pspec)->param_id)
261 #define PARAM_SPEC_SET_PARAM_ID(pspec, id) ((pspec)->param_id = (id))
264 /* --- prototypes --- */
265 static void gtk_container_base_class_init (GtkContainerClass *klass);
266 static void gtk_container_base_class_finalize (GtkContainerClass *klass);
267 static void gtk_container_class_init (GtkContainerClass *klass);
268 static void gtk_container_init (GtkContainer *container);
269 static void gtk_container_destroy (GtkWidget *widget);
270 static void gtk_container_set_property (GObject *object,
274 static void gtk_container_get_property (GObject *object,
278 static void gtk_container_add_unimplemented (GtkContainer *container,
280 static void gtk_container_remove_unimplemented (GtkContainer *container,
282 static void gtk_container_real_check_resize (GtkContainer *container);
283 static void gtk_container_compute_expand (GtkWidget *widget,
285 gboolean *vexpand_p);
286 static gboolean gtk_container_focus (GtkWidget *widget,
287 GtkDirectionType direction);
288 static void gtk_container_real_set_focus_child (GtkContainer *container,
291 static gboolean gtk_container_focus_move (GtkContainer *container,
293 GtkDirectionType direction);
294 static void gtk_container_children_callback (GtkWidget *widget,
295 gpointer client_data);
296 static void gtk_container_show_all (GtkWidget *widget);
297 static gint gtk_container_draw (GtkWidget *widget,
299 static void gtk_container_map (GtkWidget *widget);
300 static void gtk_container_unmap (GtkWidget *widget);
301 static void gtk_container_adjust_size_request (GtkWidget *widget,
302 GtkOrientation orientation,
305 static void gtk_container_adjust_size_allocation (GtkWidget *widget,
306 GtkOrientation orientation,
310 gint *allocated_size);
311 static GtkSizeRequestMode gtk_container_get_request_mode (GtkWidget *widget);
313 static gchar* gtk_container_child_default_composite_name (GtkContainer *container,
316 static GtkWidgetPath * gtk_container_real_get_path_for_child (GtkContainer *container,
320 static void gtk_container_buildable_init (GtkBuildableIface *iface);
321 static void gtk_container_buildable_add_child (GtkBuildable *buildable,
325 static gboolean gtk_container_buildable_custom_tag_start (GtkBuildable *buildable,
328 const gchar *tagname,
329 GMarkupParser *parser,
331 static void gtk_container_buildable_custom_tag_end (GtkBuildable *buildable,
334 const gchar *tagname,
338 /* --- variables --- */
339 static const gchar vadjustment_key[] = "gtk-vadjustment";
340 static guint vadjustment_key_id = 0;
341 static const gchar hadjustment_key[] = "gtk-hadjustment";
342 static guint hadjustment_key_id = 0;
343 static GSList *container_resize_queue = NULL;
344 static guint container_signals[LAST_SIGNAL] = { 0 };
345 static GtkWidgetClass *parent_class = NULL;
346 extern GParamSpecPool *_gtk_widget_child_property_pool;
347 extern GObjectNotifyContext *_gtk_widget_child_property_notify_context;
348 static GtkBuildableIface *parent_buildable_iface;
351 /* --- functions --- */
353 gtk_container_get_type (void)
355 static GType container_type = 0;
359 const GTypeInfo container_info =
361 sizeof (GtkContainerClass),
362 (GBaseInitFunc) gtk_container_base_class_init,
363 (GBaseFinalizeFunc) gtk_container_base_class_finalize,
364 (GClassInitFunc) gtk_container_class_init,
365 NULL /* class_finalize */,
366 NULL /* class_data */,
367 sizeof (GtkContainer),
369 (GInstanceInitFunc) gtk_container_init,
370 NULL, /* value_table */
373 const GInterfaceInfo buildable_info =
375 (GInterfaceInitFunc) gtk_container_buildable_init,
381 g_type_register_static (GTK_TYPE_WIDGET, I_("GtkContainer"),
382 &container_info, G_TYPE_FLAG_ABSTRACT);
384 g_type_add_interface_static (container_type,
390 return container_type;
394 gtk_container_base_class_init (GtkContainerClass *class)
396 /* reset instance specifc class fields that don't get inherited */
397 class->set_child_property = NULL;
398 class->get_child_property = NULL;
402 gtk_container_base_class_finalize (GtkContainerClass *class)
406 list = g_param_spec_pool_list_owned (_gtk_widget_child_property_pool, G_OBJECT_CLASS_TYPE (class));
407 for (node = list; node; node = node->next)
409 GParamSpec *pspec = node->data;
411 g_param_spec_pool_remove (_gtk_widget_child_property_pool, pspec);
412 PARAM_SPEC_SET_PARAM_ID (pspec, 0);
413 g_param_spec_unref (pspec);
419 gtk_container_class_init (GtkContainerClass *class)
421 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
422 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
424 parent_class = g_type_class_peek_parent (class);
426 vadjustment_key_id = g_quark_from_static_string (vadjustment_key);
427 hadjustment_key_id = g_quark_from_static_string (hadjustment_key);
429 gobject_class->set_property = gtk_container_set_property;
430 gobject_class->get_property = gtk_container_get_property;
432 widget_class->destroy = gtk_container_destroy;
433 widget_class->compute_expand = gtk_container_compute_expand;
434 widget_class->show_all = gtk_container_show_all;
435 widget_class->draw = gtk_container_draw;
436 widget_class->map = gtk_container_map;
437 widget_class->unmap = gtk_container_unmap;
438 widget_class->focus = gtk_container_focus;
440 widget_class->adjust_size_request = gtk_container_adjust_size_request;
441 widget_class->adjust_size_allocation = gtk_container_adjust_size_allocation;
442 widget_class->get_request_mode = gtk_container_get_request_mode;
444 class->add = gtk_container_add_unimplemented;
445 class->remove = gtk_container_remove_unimplemented;
446 class->check_resize = gtk_container_real_check_resize;
447 class->forall = NULL;
448 class->set_focus_child = gtk_container_real_set_focus_child;
449 class->child_type = NULL;
450 class->composite_name = gtk_container_child_default_composite_name;
451 class->get_path_for_child = gtk_container_real_get_path_for_child;
453 g_object_class_install_property (gobject_class,
455 g_param_spec_enum ("resize-mode",
457 P_("Specify how resize events are handled"),
458 GTK_TYPE_RESIZE_MODE,
460 GTK_PARAM_READWRITE));
461 g_object_class_install_property (gobject_class,
463 g_param_spec_uint ("border-width",
465 P_("The width of the empty border outside the containers children"),
469 GTK_PARAM_READWRITE));
470 g_object_class_install_property (gobject_class,
472 g_param_spec_object ("child",
474 P_("Can be used to add a new child to the container"),
476 GTK_PARAM_WRITABLE));
477 container_signals[ADD] =
478 g_signal_new (I_("add"),
479 G_OBJECT_CLASS_TYPE (gobject_class),
481 G_STRUCT_OFFSET (GtkContainerClass, add),
483 _gtk_marshal_VOID__OBJECT,
486 container_signals[REMOVE] =
487 g_signal_new (I_("remove"),
488 G_OBJECT_CLASS_TYPE (gobject_class),
490 G_STRUCT_OFFSET (GtkContainerClass, remove),
492 _gtk_marshal_VOID__OBJECT,
495 container_signals[CHECK_RESIZE] =
496 g_signal_new (I_("check-resize"),
497 G_OBJECT_CLASS_TYPE (gobject_class),
499 G_STRUCT_OFFSET (GtkContainerClass, check_resize),
501 _gtk_marshal_VOID__VOID,
503 container_signals[SET_FOCUS_CHILD] =
504 g_signal_new (I_("set-focus-child"),
505 G_OBJECT_CLASS_TYPE (gobject_class),
507 G_STRUCT_OFFSET (GtkContainerClass, set_focus_child),
509 _gtk_marshal_VOID__OBJECT,
513 g_type_class_add_private (class, sizeof (GtkContainerPrivate));
515 gtk_widget_class_set_accessible_type (widget_class, GTK_TYPE_CONTAINER_ACCESSIBLE);
519 gtk_container_buildable_init (GtkBuildableIface *iface)
521 parent_buildable_iface = g_type_interface_peek_parent (iface);
522 iface->add_child = gtk_container_buildable_add_child;
523 iface->custom_tag_start = gtk_container_buildable_custom_tag_start;
524 iface->custom_tag_end = gtk_container_buildable_custom_tag_end;
528 gtk_container_buildable_add_child (GtkBuildable *buildable,
535 GTK_BUILDER_WARN_INVALID_CHILD_TYPE (buildable, type);
537 else if (GTK_IS_WIDGET (child) &&
538 gtk_widget_get_parent (GTK_WIDGET (child)) == NULL)
540 gtk_container_add (GTK_CONTAINER (buildable), GTK_WIDGET (child));
543 g_warning ("Cannot add an object of type %s to a container of type %s",
544 g_type_name (G_OBJECT_TYPE (child)), g_type_name (G_OBJECT_TYPE (buildable)));
548 gtk_container_buildable_set_child_property (GtkContainer *container,
555 GValue gvalue = G_VALUE_INIT;
556 GError *error = NULL;
558 pspec = gtk_container_class_find_child_property
559 (G_OBJECT_GET_CLASS (container), name);
562 g_warning ("%s does not have a property called %s",
563 g_type_name (G_OBJECT_TYPE (container)), name);
567 if (!gtk_builder_value_from_string (builder, pspec, value, &gvalue, &error))
569 g_warning ("Could not read property %s:%s with value %s of type %s: %s",
570 g_type_name (G_OBJECT_TYPE (container)),
573 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
575 g_error_free (error);
579 gtk_container_child_set_property (container, child, name, &gvalue);
580 g_value_unset (&gvalue);
585 GtkContainer *container;
588 gchar *child_prop_name;
590 gboolean translatable;
591 } PackingPropertiesData;
594 attributes_start_element (GMarkupParseContext *context,
595 const gchar *element_name,
597 const gchar **values,
601 PackingPropertiesData *parser_data = (PackingPropertiesData*)user_data;
604 if (strcmp (element_name, "property") == 0)
606 for (i = 0; names[i]; i++)
607 if (strcmp (names[i], "name") == 0)
608 parser_data->child_prop_name = g_strdup (values[i]);
609 else if (strcmp (names[i], "translatable") == 0)
611 if (!_gtk_builder_boolean_from_string (values[1],
612 &parser_data->translatable,
616 else if (strcmp (names[i], "comments") == 0)
617 ; /* for translators */
618 else if (strcmp (names[i], "context") == 0)
619 parser_data->context = g_strdup (values[1]);
621 g_warning ("Unsupported attribute for GtkContainer Child "
622 "property: %s\n", names[i]);
624 else if (strcmp (element_name, "packing") == 0)
627 g_warning ("Unsupported tag for GtkContainer: %s\n", element_name);
631 attributes_text_element (GMarkupParseContext *context,
637 PackingPropertiesData *parser_data = (PackingPropertiesData*)user_data;
639 if (parser_data->child_prop_name)
640 g_string_append_len (parser_data->string, text, text_len);
644 attributes_end_element (GMarkupParseContext *context,
645 const gchar *element_name,
649 PackingPropertiesData *parser_data = (PackingPropertiesData*)user_data;
651 /* translate the string */
652 if (parser_data->string->len && parser_data->translatable)
657 domain = gtk_builder_get_translation_domain (parser_data->builder);
659 translated = _gtk_builder_parser_translate (domain,
660 parser_data->context,
661 parser_data->string->str);
662 g_string_set_size (parser_data->string, 0);
663 g_string_append (parser_data->string, translated);
666 if (parser_data->child_prop_name)
667 gtk_container_buildable_set_child_property (parser_data->container,
668 parser_data->builder,
670 parser_data->child_prop_name,
671 parser_data->string->str);
673 g_string_set_size (parser_data->string, 0);
674 g_free (parser_data->child_prop_name);
675 g_free (parser_data->context);
676 parser_data->child_prop_name = NULL;
677 parser_data->context = NULL;
678 parser_data->translatable = FALSE;
681 static const GMarkupParser attributes_parser =
683 attributes_start_element,
684 attributes_end_element,
685 attributes_text_element,
689 gtk_container_buildable_custom_tag_start (GtkBuildable *buildable,
692 const gchar *tagname,
693 GMarkupParser *parser,
696 PackingPropertiesData *parser_data;
698 if (parent_buildable_iface->custom_tag_start (buildable, builder, child,
699 tagname, parser, data))
702 if (child && strcmp (tagname, "packing") == 0)
704 parser_data = g_slice_new0 (PackingPropertiesData);
705 parser_data->string = g_string_new ("");
706 parser_data->builder = builder;
707 parser_data->container = GTK_CONTAINER (buildable);
708 parser_data->child = GTK_WIDGET (child);
709 parser_data->child_prop_name = NULL;
711 *parser = attributes_parser;
720 gtk_container_buildable_custom_tag_end (GtkBuildable *buildable,
723 const gchar *tagname,
726 if (strcmp (tagname, "packing") == 0)
728 PackingPropertiesData *parser_data = (PackingPropertiesData*)data;
729 g_string_free (parser_data->string, TRUE);
730 g_slice_free (PackingPropertiesData, parser_data);
734 if (parent_buildable_iface->custom_tag_end)
735 parent_buildable_iface->custom_tag_end (buildable, builder,
736 child, tagname, data);
740 * gtk_container_child_type:
741 * @container: a #GtkContainer
743 * Returns the type of the children supported by the container.
745 * Note that this may return %G_TYPE_NONE to indicate that no more
746 * children can be added, e.g. for a #GtkPaned which already has two
749 * Return value: a #GType.
752 gtk_container_child_type (GtkContainer *container)
755 GtkContainerClass *class;
757 g_return_val_if_fail (GTK_IS_CONTAINER (container), 0);
759 class = GTK_CONTAINER_GET_CLASS (container);
760 if (class->child_type)
761 slot = class->child_type (container);
768 /* --- GtkContainer child property mechanism --- */
771 * gtk_container_child_notify:
772 * @container: the #GtkContainer
773 * @child: the child widget
774 * @child_property: the name of a child property installed on
775 * the class of @container
777 * Emits a #GtkWidget::child-notify signal for the
778 * <link linkend="child-properties">child property</link>
779 * @child_property on widget.
781 * This is an analogue of g_object_notify() for child properties.
783 * Also see gtk_widget_child_notify().
788 gtk_container_child_notify (GtkContainer *container,
790 const gchar *child_property)
795 g_return_if_fail (GTK_IS_CONTAINER (container));
796 g_return_if_fail (GTK_IS_WIDGET (child));
797 g_return_if_fail (child_property != NULL);
799 obj = G_OBJECT (child);
801 if (obj->ref_count == 0)
806 pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
808 G_OBJECT_TYPE (container),
813 g_warning ("%s: container class `%s' has no child property named `%s'",
815 G_OBJECT_TYPE_NAME (container),
820 GObjectNotifyQueue *nqueue;
822 nqueue = g_object_notify_queue_freeze (obj, _gtk_widget_child_property_notify_context);
824 g_object_notify_queue_add (obj, nqueue, pspec);
825 g_object_notify_queue_thaw (obj, nqueue);
828 g_object_unref (obj);
832 container_get_child_property (GtkContainer *container,
837 GtkContainerClass *class = g_type_class_peek (pspec->owner_type);
839 class->get_child_property (container, child, PARAM_SPEC_PARAM_ID (pspec), value, pspec);
843 container_set_child_property (GtkContainer *container,
847 GObjectNotifyQueue *nqueue)
849 GValue tmp_value = G_VALUE_INIT;
850 GtkContainerClass *class = g_type_class_peek (pspec->owner_type);
852 /* provide a copy to work from, convert (if necessary) and validate */
853 g_value_init (&tmp_value, G_PARAM_SPEC_VALUE_TYPE (pspec));
854 if (!g_value_transform (value, &tmp_value))
855 g_warning ("unable to set child property `%s' of type `%s' from value of type `%s'",
857 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
858 G_VALUE_TYPE_NAME (value));
859 else if (g_param_value_validate (pspec, &tmp_value) && !(pspec->flags & G_PARAM_LAX_VALIDATION))
861 gchar *contents = g_strdup_value_contents (value);
863 g_warning ("value \"%s\" of type `%s' is invalid for property `%s' of type `%s'",
865 G_VALUE_TYPE_NAME (value),
867 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)));
872 class->set_child_property (container, child, PARAM_SPEC_PARAM_ID (pspec), &tmp_value, pspec);
873 g_object_notify_queue_add (G_OBJECT (child), nqueue, pspec);
875 g_value_unset (&tmp_value);
879 * gtk_container_child_get_valist:
880 * @container: a #GtkContainer
881 * @child: a widget which is a child of @container
882 * @first_property_name: the name of the first property to get
883 * @var_args: return location for the first property, followed
884 * optionally by more name/return location pairs, followed by %NULL
886 * Gets the values of one or more child properties for @child and @container.
889 gtk_container_child_get_valist (GtkContainer *container,
891 const gchar *first_property_name,
896 g_return_if_fail (GTK_IS_CONTAINER (container));
897 g_return_if_fail (GTK_IS_WIDGET (child));
899 g_object_ref (container);
900 g_object_ref (child);
902 name = first_property_name;
905 GValue value = G_VALUE_INIT;
909 pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
911 G_OBJECT_TYPE (container),
915 g_warning ("%s: container class `%s' has no child property named `%s'",
917 G_OBJECT_TYPE_NAME (container),
921 if (!(pspec->flags & G_PARAM_READABLE))
923 g_warning ("%s: child property `%s' of container class `%s' is not readable",
926 G_OBJECT_TYPE_NAME (container));
929 g_value_init (&value, G_PARAM_SPEC_VALUE_TYPE (pspec));
930 container_get_child_property (container, child, pspec, &value);
931 G_VALUE_LCOPY (&value, var_args, 0, &error);
934 g_warning ("%s: %s", G_STRLOC, error);
936 g_value_unset (&value);
939 g_value_unset (&value);
940 name = va_arg (var_args, gchar*);
943 g_object_unref (child);
944 g_object_unref (container);
948 * gtk_container_child_get_property:
949 * @container: a #GtkContainer
950 * @child: a widget which is a child of @container
951 * @property_name: the name of the property to get
952 * @value: a location to return the value
954 * Gets the value of a child property for @child and @container.
957 gtk_container_child_get_property (GtkContainer *container,
959 const gchar *property_name,
964 g_return_if_fail (GTK_IS_CONTAINER (container));
965 g_return_if_fail (GTK_IS_WIDGET (child));
966 g_return_if_fail (property_name != NULL);
967 g_return_if_fail (G_IS_VALUE (value));
969 g_object_ref (container);
970 g_object_ref (child);
971 pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool, property_name,
972 G_OBJECT_TYPE (container), TRUE);
974 g_warning ("%s: container class `%s' has no child property named `%s'",
976 G_OBJECT_TYPE_NAME (container),
978 else if (!(pspec->flags & G_PARAM_READABLE))
979 g_warning ("%s: child property `%s' of container class `%s' is not readable",
982 G_OBJECT_TYPE_NAME (container));
985 GValue *prop_value, tmp_value = G_VALUE_INIT;
987 /* auto-conversion of the callers value type
989 if (G_VALUE_TYPE (value) == G_PARAM_SPEC_VALUE_TYPE (pspec))
991 g_value_reset (value);
994 else if (!g_value_type_transformable (G_PARAM_SPEC_VALUE_TYPE (pspec), G_VALUE_TYPE (value)))
996 g_warning ("can't retrieve child property `%s' of type `%s' as value of type `%s'",
998 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
999 G_VALUE_TYPE_NAME (value));
1000 g_object_unref (child);
1001 g_object_unref (container);
1006 g_value_init (&tmp_value, G_PARAM_SPEC_VALUE_TYPE (pspec));
1007 prop_value = &tmp_value;
1009 container_get_child_property (container, child, pspec, prop_value);
1010 if (prop_value != value)
1012 g_value_transform (prop_value, value);
1013 g_value_unset (&tmp_value);
1016 g_object_unref (child);
1017 g_object_unref (container);
1021 * gtk_container_child_set_valist:
1022 * @container: a #GtkContainer
1023 * @child: a widget which is a child of @container
1024 * @first_property_name: the name of the first property to set
1025 * @var_args: a %NULL-terminated list of property names and values, starting
1026 * with @first_prop_name
1028 * Sets one or more child properties for @child and @container.
1031 gtk_container_child_set_valist (GtkContainer *container,
1033 const gchar *first_property_name,
1036 GObjectNotifyQueue *nqueue;
1039 g_return_if_fail (GTK_IS_CONTAINER (container));
1040 g_return_if_fail (GTK_IS_WIDGET (child));
1042 g_object_ref (container);
1043 g_object_ref (child);
1045 nqueue = g_object_notify_queue_freeze (G_OBJECT (child), _gtk_widget_child_property_notify_context);
1046 name = first_property_name;
1049 GValue value = G_VALUE_INIT;
1050 gchar *error = NULL;
1051 GParamSpec *pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
1053 G_OBJECT_TYPE (container),
1057 g_warning ("%s: container class `%s' has no child property named `%s'",
1059 G_OBJECT_TYPE_NAME (container),
1063 if (!(pspec->flags & G_PARAM_WRITABLE))
1065 g_warning ("%s: child property `%s' of container class `%s' is not writable",
1068 G_OBJECT_TYPE_NAME (container));
1072 G_VALUE_COLLECT_INIT (&value, G_PARAM_SPEC_VALUE_TYPE (pspec),
1073 var_args, 0, &error);
1076 g_warning ("%s: %s", G_STRLOC, error);
1079 /* we purposely leak the value here, it might not be
1080 * in a sane state if an error condition occoured
1084 container_set_child_property (container, child, pspec, &value, nqueue);
1085 g_value_unset (&value);
1086 name = va_arg (var_args, gchar*);
1088 g_object_notify_queue_thaw (G_OBJECT (child), nqueue);
1090 g_object_unref (container);
1091 g_object_unref (child);
1095 * gtk_container_child_set_property:
1096 * @container: a #GtkContainer
1097 * @child: a widget which is a child of @container
1098 * @property_name: the name of the property to set
1099 * @value: the value to set the property to
1101 * Sets a child property for @child and @container.
1104 gtk_container_child_set_property (GtkContainer *container,
1106 const gchar *property_name,
1107 const GValue *value)
1109 GObjectNotifyQueue *nqueue;
1112 g_return_if_fail (GTK_IS_CONTAINER (container));
1113 g_return_if_fail (GTK_IS_WIDGET (child));
1114 g_return_if_fail (property_name != NULL);
1115 g_return_if_fail (G_IS_VALUE (value));
1117 g_object_ref (container);
1118 g_object_ref (child);
1120 nqueue = g_object_notify_queue_freeze (G_OBJECT (child), _gtk_widget_child_property_notify_context);
1121 pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool, property_name,
1122 G_OBJECT_TYPE (container), TRUE);
1124 g_warning ("%s: container class `%s' has no child property named `%s'",
1126 G_OBJECT_TYPE_NAME (container),
1128 else if (!(pspec->flags & G_PARAM_WRITABLE))
1129 g_warning ("%s: child property `%s' of container class `%s' is not writable",
1132 G_OBJECT_TYPE_NAME (container));
1135 container_set_child_property (container, child, pspec, value, nqueue);
1137 g_object_notify_queue_thaw (G_OBJECT (child), nqueue);
1138 g_object_unref (container);
1139 g_object_unref (child);
1143 * gtk_container_add_with_properties:
1144 * @container: a #GtkContainer
1145 * @widget: a widget to be placed inside @container
1146 * @first_prop_name: the name of the first child property to set
1147 * @...: a %NULL-terminated list of property names and values, starting
1148 * with @first_prop_name
1150 * Adds @widget to @container, setting child properties at the same time.
1151 * See gtk_container_add() and gtk_container_child_set() for more details.
1154 gtk_container_add_with_properties (GtkContainer *container,
1156 const gchar *first_prop_name,
1159 g_return_if_fail (GTK_IS_CONTAINER (container));
1160 g_return_if_fail (GTK_IS_WIDGET (widget));
1161 g_return_if_fail (gtk_widget_get_parent (widget) == NULL);
1163 g_object_ref (container);
1164 g_object_ref (widget);
1165 gtk_widget_freeze_child_notify (widget);
1167 g_signal_emit (container, container_signals[ADD], 0, widget);
1168 if (gtk_widget_get_parent (widget))
1172 va_start (var_args, first_prop_name);
1173 gtk_container_child_set_valist (container, widget, first_prop_name, var_args);
1177 gtk_widget_thaw_child_notify (widget);
1178 g_object_unref (widget);
1179 g_object_unref (container);
1183 * gtk_container_child_set:
1184 * @container: a #GtkContainer
1185 * @child: a widget which is a child of @container
1186 * @first_prop_name: the name of the first property to set
1187 * @...: a %NULL-terminated list of property names and values, starting
1188 * with @first_prop_name
1190 * Sets one or more child properties for @child and @container.
1193 gtk_container_child_set (GtkContainer *container,
1195 const gchar *first_prop_name,
1200 va_start (var_args, first_prop_name);
1201 gtk_container_child_set_valist (container, child, first_prop_name, var_args);
1206 * gtk_container_child_get:
1207 * @container: a #GtkContainer
1208 * @child: a widget which is a child of @container
1209 * @first_prop_name: the name of the first property to get
1210 * @...: return location for the first property, followed
1211 * optionally by more name/return location pairs, followed by %NULL
1213 * Gets the values of one or more child properties for @child and @container.
1216 gtk_container_child_get (GtkContainer *container,
1218 const gchar *first_prop_name,
1223 va_start (var_args, first_prop_name);
1224 gtk_container_child_get_valist (container, child, first_prop_name, var_args);
1229 * gtk_container_class_install_child_property:
1230 * @cclass: a #GtkContainerClass
1231 * @property_id: the id for the property
1232 * @pspec: the #GParamSpec for the property
1234 * Installs a child property on a container class.
1237 gtk_container_class_install_child_property (GtkContainerClass *cclass,
1241 g_return_if_fail (GTK_IS_CONTAINER_CLASS (cclass));
1242 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
1243 if (pspec->flags & G_PARAM_WRITABLE)
1244 g_return_if_fail (cclass->set_child_property != NULL);
1245 if (pspec->flags & G_PARAM_READABLE)
1246 g_return_if_fail (cclass->get_child_property != NULL);
1247 g_return_if_fail (property_id > 0);
1248 g_return_if_fail (PARAM_SPEC_PARAM_ID (pspec) == 0); /* paranoid */
1249 if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
1250 g_return_if_fail ((pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY)) == 0);
1252 if (g_param_spec_pool_lookup (_gtk_widget_child_property_pool, pspec->name, G_OBJECT_CLASS_TYPE (cclass), FALSE))
1254 g_warning (G_STRLOC ": class `%s' already contains a child property named `%s'",
1255 G_OBJECT_CLASS_NAME (cclass),
1259 g_param_spec_ref (pspec);
1260 g_param_spec_sink (pspec);
1261 PARAM_SPEC_SET_PARAM_ID (pspec, property_id);
1262 g_param_spec_pool_insert (_gtk_widget_child_property_pool, pspec, G_OBJECT_CLASS_TYPE (cclass));
1266 * gtk_container_class_find_child_property:
1267 * @cclass: (type GtkContainerClass): a #GtkContainerClass
1268 * @property_name: the name of the child property to find
1270 * Finds a child property of a container class by name.
1272 * Returns: (transfer none): the #GParamSpec of the child property
1273 * or %NULL if @class has no child property with that name.
1276 gtk_container_class_find_child_property (GObjectClass *cclass,
1277 const gchar *property_name)
1279 g_return_val_if_fail (GTK_IS_CONTAINER_CLASS (cclass), NULL);
1280 g_return_val_if_fail (property_name != NULL, NULL);
1282 return g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
1284 G_OBJECT_CLASS_TYPE (cclass),
1289 * gtk_container_class_list_child_properties:
1290 * @cclass: (type GtkContainerClass): a #GtkContainerClass
1291 * @n_properties: location to return the number of child properties found
1293 * Returns all child properties of a container class.
1295 * Returns: (array length=n_properties) (transfer container):
1296 * a newly allocated %NULL-terminated array of #GParamSpec*.
1297 * The array must be freed with g_free().
1300 gtk_container_class_list_child_properties (GObjectClass *cclass,
1301 guint *n_properties)
1303 GParamSpec **pspecs;
1306 g_return_val_if_fail (GTK_IS_CONTAINER_CLASS (cclass), NULL);
1308 pspecs = g_param_spec_pool_list (_gtk_widget_child_property_pool,
1309 G_OBJECT_CLASS_TYPE (cclass),
1318 gtk_container_add_unimplemented (GtkContainer *container,
1321 g_warning ("GtkContainerClass::add not implemented for `%s'", g_type_name (G_TYPE_FROM_INSTANCE (container)));
1325 gtk_container_remove_unimplemented (GtkContainer *container,
1328 g_warning ("GtkContainerClass::remove not implemented for `%s'", g_type_name (G_TYPE_FROM_INSTANCE (container)));
1332 gtk_container_init (GtkContainer *container)
1334 GtkContainerPrivate *priv;
1336 container->priv = G_TYPE_INSTANCE_GET_PRIVATE (container,
1338 GtkContainerPrivate);
1339 priv = container->priv;
1341 priv->focus_child = NULL;
1342 priv->border_width = 0;
1343 priv->need_resize = FALSE;
1344 priv->resize_mode = GTK_RESIZE_PARENT;
1345 priv->reallocate_redraws = FALSE;
1349 gtk_container_destroy (GtkWidget *widget)
1351 GtkContainer *container = GTK_CONTAINER (widget);
1352 GtkContainerPrivate *priv = container->priv;
1354 if (_gtk_widget_get_resize_pending (GTK_WIDGET (container)))
1355 _gtk_container_dequeue_resize_handler (container);
1357 if (priv->focus_child)
1359 g_object_unref (priv->focus_child);
1360 priv->focus_child = NULL;
1363 /* do this before walking child widgets, to avoid
1364 * removing children from focus chain one by one.
1366 if (priv->has_focus_chain)
1367 gtk_container_unset_focus_chain (container);
1369 gtk_container_foreach (container, (GtkCallback) gtk_widget_destroy, NULL);
1371 GTK_WIDGET_CLASS (parent_class)->destroy (widget);
1375 gtk_container_set_property (GObject *object,
1377 const GValue *value,
1380 GtkContainer *container = GTK_CONTAINER (object);
1384 case PROP_BORDER_WIDTH:
1385 gtk_container_set_border_width (container, g_value_get_uint (value));
1387 case PROP_RESIZE_MODE:
1388 gtk_container_set_resize_mode (container, g_value_get_enum (value));
1391 gtk_container_add (container, GTK_WIDGET (g_value_get_object (value)));
1394 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1400 gtk_container_get_property (GObject *object,
1405 GtkContainer *container = GTK_CONTAINER (object);
1406 GtkContainerPrivate *priv = container->priv;
1410 case PROP_BORDER_WIDTH:
1411 g_value_set_uint (value, priv->border_width);
1413 case PROP_RESIZE_MODE:
1414 g_value_set_enum (value, priv->resize_mode);
1417 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1423 * gtk_container_set_border_width:
1424 * @container: a #GtkContainer
1425 * @border_width: amount of blank space to leave <emphasis>outside</emphasis>
1426 * the container. Valid values are in the range 0-65535 pixels.
1428 * Sets the border width of the container.
1430 * The border width of a container is the amount of space to leave
1431 * around the outside of the container. The only exception to this is
1432 * #GtkWindow; because toplevel windows can't leave space outside,
1433 * they leave the space inside. The border is added on all sides of
1434 * the container. To add space to only one side, one approach is to
1435 * create a #GtkAlignment widget, call gtk_widget_set_size_request()
1436 * to give it a size, and place it on the side of the container as
1440 gtk_container_set_border_width (GtkContainer *container,
1443 GtkContainerPrivate *priv;
1445 g_return_if_fail (GTK_IS_CONTAINER (container));
1447 priv = container->priv;
1449 if (priv->border_width != border_width)
1451 priv->border_width = border_width;
1452 g_object_notify (G_OBJECT (container), "border-width");
1454 if (gtk_widget_get_realized (GTK_WIDGET (container)))
1455 gtk_widget_queue_resize (GTK_WIDGET (container));
1460 * gtk_container_get_border_width:
1461 * @container: a #GtkContainer
1463 * Retrieves the border width of the container. See
1464 * gtk_container_set_border_width().
1466 * Return value: the current border width
1469 gtk_container_get_border_width (GtkContainer *container)
1471 g_return_val_if_fail (GTK_IS_CONTAINER (container), 0);
1473 return container->priv->border_width;
1477 * gtk_container_add:
1478 * @container: a #GtkContainer
1479 * @widget: a widget to be placed inside @container
1481 * Adds @widget to @container. Typically used for simple containers
1482 * such as #GtkWindow, #GtkFrame, or #GtkButton; for more complicated
1483 * layout containers such as #GtkBox or #GtkGrid, this function will
1484 * pick default packing parameters that may not be correct. So
1485 * consider functions such as gtk_box_pack_start() and
1486 * gtk_grid_attach() as an alternative to gtk_container_add() in
1487 * those cases. A widget may be added to only one container at a time;
1488 * you can't place the same widget inside two different containers.
1491 gtk_container_add (GtkContainer *container,
1496 g_return_if_fail (GTK_IS_CONTAINER (container));
1497 g_return_if_fail (GTK_IS_WIDGET (widget));
1499 parent = gtk_widget_get_parent (widget);
1503 g_warning ("Attempting to add a widget with type %s to a container of "
1504 "type %s, but the widget is already inside a container of type %s, "
1505 "please use gtk_widget_reparent()" ,
1506 g_type_name (G_OBJECT_TYPE (widget)),
1507 g_type_name (G_OBJECT_TYPE (container)),
1508 g_type_name (G_OBJECT_TYPE (parent)));
1512 g_signal_emit (container, container_signals[ADD], 0, widget);
1516 * gtk_container_remove:
1517 * @container: a #GtkContainer
1518 * @widget: a current child of @container
1520 * Removes @widget from @container. @widget must be inside @container.
1521 * Note that @container will own a reference to @widget, and that this
1522 * may be the last reference held; so removing a widget from its
1523 * container can destroy that widget. If you want to use @widget
1524 * again, you need to add a reference to it while it's not inside
1525 * a container, using g_object_ref(). If you don't want to use @widget
1526 * again it's usually more efficient to simply destroy it directly
1527 * using gtk_widget_destroy() since this will remove it from the
1528 * container and help break any circular reference count cycles.
1531 gtk_container_remove (GtkContainer *container,
1534 g_return_if_fail (GTK_IS_CONTAINER (container));
1535 g_return_if_fail (GTK_IS_WIDGET (widget));
1536 g_return_if_fail (gtk_widget_get_parent (widget) == GTK_WIDGET (container) || GTK_IS_ASSISTANT (container));
1538 g_signal_emit (container, container_signals[REMOVE], 0, widget);
1542 _gtk_container_dequeue_resize_handler (GtkContainer *container)
1544 g_return_if_fail (GTK_IS_CONTAINER (container));
1545 g_return_if_fail (_gtk_widget_get_resize_pending (GTK_WIDGET (container)));
1547 container_resize_queue = g_slist_remove (container_resize_queue, container);
1548 _gtk_widget_set_resize_pending (GTK_WIDGET (container), FALSE);
1552 * gtk_container_set_resize_mode:
1553 * @container: a #GtkContainer
1554 * @resize_mode: the new resize mode
1556 * Sets the resize mode for the container.
1558 * The resize mode of a container determines whether a resize request
1559 * will be passed to the container's parent, queued for later execution
1560 * or executed immediately.
1563 gtk_container_set_resize_mode (GtkContainer *container,
1564 GtkResizeMode resize_mode)
1566 GtkContainerPrivate *priv;
1568 g_return_if_fail (GTK_IS_CONTAINER (container));
1569 g_return_if_fail (resize_mode <= GTK_RESIZE_IMMEDIATE);
1571 priv = container->priv;
1573 if (gtk_widget_is_toplevel (GTK_WIDGET (container)) &&
1574 resize_mode == GTK_RESIZE_PARENT)
1576 resize_mode = GTK_RESIZE_QUEUE;
1579 if (priv->resize_mode != resize_mode)
1581 priv->resize_mode = resize_mode;
1583 gtk_widget_queue_resize (GTK_WIDGET (container));
1584 g_object_notify (G_OBJECT (container), "resize-mode");
1589 * gtk_container_get_resize_mode:
1590 * @container: a #GtkContainer
1592 * Returns the resize mode for the container. See
1593 * gtk_container_set_resize_mode ().
1595 * Return value: the current resize mode
1598 gtk_container_get_resize_mode (GtkContainer *container)
1600 g_return_val_if_fail (GTK_IS_CONTAINER (container), GTK_RESIZE_PARENT);
1602 return container->priv->resize_mode;
1606 * gtk_container_set_reallocate_redraws:
1607 * @container: a #GtkContainer
1608 * @needs_redraws: the new value for the container's @reallocate_redraws flag
1610 * Sets the @reallocate_redraws flag of the container to the given value.
1612 * Containers requesting reallocation redraws get automatically
1613 * redrawn if any of their children changed allocation.
1616 gtk_container_set_reallocate_redraws (GtkContainer *container,
1617 gboolean needs_redraws)
1619 g_return_if_fail (GTK_IS_CONTAINER (container));
1621 container->priv->reallocate_redraws = needs_redraws ? TRUE : FALSE;
1624 static GtkContainer*
1625 gtk_container_get_resize_container (GtkContainer *container)
1628 GtkWidget *widget = GTK_WIDGET (container);
1630 while ((parent = gtk_widget_get_parent (widget)))
1633 if (GTK_IS_RESIZE_CONTAINER (widget))
1637 return GTK_IS_RESIZE_CONTAINER (widget) ? (GtkContainer*) widget : NULL;
1641 gtk_container_idle_sizer (gpointer data)
1643 /* we may be invoked with a container_resize_queue of NULL, because
1644 * queue_resize could have been adding an extra idle function while
1645 * the queue still got processed. we better just ignore such case
1646 * than trying to explicitely work around them with some extra flags,
1647 * since it doesn't cause any actual harm.
1649 while (container_resize_queue)
1654 slist = container_resize_queue;
1655 container_resize_queue = slist->next;
1656 widget = slist->data;
1657 g_slist_free_1 (slist);
1659 _gtk_widget_set_resize_pending (widget, FALSE);
1660 gtk_container_check_resize (GTK_CONTAINER (widget));
1663 gdk_window_process_all_updates ();
1669 _gtk_container_queue_resize_internal (GtkContainer *container,
1670 gboolean invalidate_only)
1672 GtkContainer *resize_container;
1676 g_return_if_fail (GTK_IS_CONTAINER (container));
1678 widget = GTK_WIDGET (container);
1680 resize_container = gtk_container_get_resize_container (container);
1684 _gtk_widget_set_alloc_needed (widget, TRUE);
1685 _gtk_widget_set_width_request_needed (widget, TRUE);
1686 _gtk_widget_set_height_request_needed (widget, TRUE);
1688 if ((resize_container && widget == GTK_WIDGET (resize_container)) ||
1689 !(parent = gtk_widget_get_parent (widget)))
1695 if (resize_container && !invalidate_only)
1697 if (gtk_widget_get_visible (GTK_WIDGET (resize_container)) &&
1698 (gtk_widget_is_toplevel (GTK_WIDGET (resize_container)) ||
1699 gtk_widget_get_realized (GTK_WIDGET (resize_container))))
1701 switch (resize_container->priv->resize_mode)
1703 case GTK_RESIZE_QUEUE:
1704 if (!_gtk_widget_get_resize_pending (GTK_WIDGET (resize_container)))
1706 _gtk_widget_set_resize_pending (GTK_WIDGET (resize_container), TRUE);
1707 if (container_resize_queue == NULL)
1708 gdk_threads_add_idle_full (GTK_PRIORITY_RESIZE,
1709 gtk_container_idle_sizer,
1711 container_resize_queue = g_slist_prepend (container_resize_queue, resize_container);
1715 case GTK_RESIZE_IMMEDIATE:
1716 gtk_container_check_resize (resize_container);
1719 case GTK_RESIZE_PARENT:
1720 g_assert_not_reached ();
1726 /* we need to let hidden resize containers know that something
1727 * changed while they where hidden (currently only evaluated by
1730 resize_container->priv->need_resize = TRUE;
1736 * _gtk_container_queue_resize:
1737 * @container: a #GtkContainer
1739 * Determines the "resize container" in the hierarchy above this container
1740 * (typically the toplevel, but other containers can be set as resize
1741 * containers with gtk_container_set_resize_mode()), marks the container
1742 * and all parents up to and including the resize container as needing
1743 * to have sizes recompted, and if necessary adds the resize container
1744 * to the queue of containers that will be resized out at idle.
1747 _gtk_container_queue_resize (GtkContainer *container)
1749 _gtk_container_queue_resize_internal (container, FALSE);
1753 * _gtk_container_resize_invalidate:
1754 * @container: a #GtkContainer
1756 * Invalidates cached sizes like _gtk_container_queue_resize() but doesn't
1757 * actually queue the resize container for resize.
1760 _gtk_container_resize_invalidate (GtkContainer *container)
1762 _gtk_container_queue_resize_internal (container, TRUE);
1766 gtk_container_check_resize (GtkContainer *container)
1768 g_return_if_fail (GTK_IS_CONTAINER (container));
1770 g_signal_emit (container, container_signals[CHECK_RESIZE], 0);
1774 gtk_container_real_check_resize (GtkContainer *container)
1776 GtkWidget *widget = GTK_WIDGET (container);
1777 GtkAllocation allocation;
1778 GtkRequisition requisition;
1780 gtk_widget_get_preferred_size (widget,
1781 &requisition, NULL);
1782 gtk_widget_get_allocation (widget, &allocation);
1784 if (requisition.width > allocation.width ||
1785 requisition.height > allocation.height)
1787 if (GTK_IS_RESIZE_CONTAINER (container))
1789 gtk_widget_size_allocate (widget, &allocation);
1790 gtk_widget_set_allocation (widget, &allocation);
1793 gtk_widget_queue_resize (widget);
1797 gtk_container_resize_children (container);
1801 /* The container hasn't changed size but one of its children
1802 * queued a resize request. Which means that the allocation
1803 * is not sufficient for the requisition of some child.
1804 * We've already performed a size request at this point,
1805 * so we simply need to reallocate and let the allocation
1806 * trickle down via GTK_WIDGET_ALLOC_NEEDED flags.
1809 gtk_container_resize_children (GtkContainer *container)
1811 GtkAllocation allocation;
1814 /* resizing invariants:
1815 * toplevels have *always* resize_mode != GTK_RESIZE_PARENT set.
1816 * containers that have an idle sizer pending must be flagged with
1819 g_return_if_fail (GTK_IS_CONTAINER (container));
1821 widget = GTK_WIDGET (container);
1822 gtk_widget_get_allocation (widget, &allocation);
1824 gtk_widget_size_allocate (widget, &allocation);
1825 gtk_widget_set_allocation (widget, &allocation);
1829 gtk_container_adjust_size_request (GtkWidget *widget,
1830 GtkOrientation orientation,
1834 GtkContainer *container;
1836 container = GTK_CONTAINER (widget);
1838 if (GTK_CONTAINER_GET_CLASS (widget)->_handle_border_width)
1842 border_width = container->priv->border_width;
1844 *minimum_size += border_width * 2;
1845 *natural_size += border_width * 2;
1848 /* chain up last so gtk_widget_set_size_request() values
1849 * will have a chance to overwrite our border width.
1851 parent_class->adjust_size_request (widget, orientation,
1852 minimum_size, natural_size);
1856 gtk_container_adjust_size_allocation (GtkWidget *widget,
1857 GtkOrientation orientation,
1860 gint *allocated_pos,
1861 gint *allocated_size)
1863 GtkContainer *container;
1866 container = GTK_CONTAINER (widget);
1868 if (!GTK_CONTAINER_GET_CLASS (widget)->_handle_border_width)
1870 parent_class->adjust_size_allocation (widget, orientation,
1871 minimum_size, natural_size, allocated_pos,
1876 border_width = container->priv->border_width;
1878 *allocated_size -= border_width * 2;
1880 /* If we get a pathological too-small allocation to hold
1881 * even the border width, leave all allocation to the actual
1882 * widget, and leave x,y unchanged. (GtkWidget's min size is
1883 * 1x1 if you're wondering why <1 and not <0)
1885 * As long as we have space, set x,y properly.
1888 if (*allocated_size < 1)
1890 *allocated_size += border_width * 2;
1894 *allocated_pos += border_width;
1895 *minimum_size -= border_width * 2;
1896 *natural_size -= border_width * 2;
1899 /* Chain up to GtkWidgetClass *after* removing our border width from
1900 * the proposed allocation size. This is because it's possible that the
1901 * widget was allocated more space than it needs in a said orientation,
1902 * if GtkWidgetClass does any alignments and thus limits the size to the
1903 * natural size... then we need that to be done *after* removing any margins
1904 * and padding values.
1906 parent_class->adjust_size_allocation (widget, orientation,
1907 minimum_size, natural_size, allocated_pos,
1917 count_request_modes (GtkWidget *widget,
1918 RequestModeCount *count)
1920 GtkSizeRequestMode mode = gtk_widget_get_request_mode (widget);
1924 case GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH:
1927 case GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT:
1930 case GTK_SIZE_REQUEST_CONSTANT_SIZE:
1936 static GtkSizeRequestMode
1937 gtk_container_get_request_mode (GtkWidget *widget)
1939 GtkContainer *container = GTK_CONTAINER (widget);
1940 GtkContainerPrivate *priv = container->priv;
1942 /* Recalculate the request mode of the children by majority
1943 * vote whenever the internal content changes */
1944 if (_gtk_widget_get_width_request_needed (widget) ||
1945 _gtk_widget_get_height_request_needed (widget))
1947 RequestModeCount count = { 0, 0 };
1949 gtk_container_forall (container, (GtkCallback)count_request_modes, &count);
1951 if (!count.hfw && !count.wfh)
1952 priv->request_mode = GTK_SIZE_REQUEST_CONSTANT_SIZE;
1954 priv->request_mode = count.wfh > count.hfw ?
1955 GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT :
1956 GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH;
1959 return priv->request_mode;
1963 * gtk_container_class_handle_border_width:
1964 * @klass: the class struct of a #GtkContainer subclass
1966 * Modifies a subclass of #GtkContainerClass to automatically add and
1967 * remove the border-width setting on GtkContainer. This allows the
1968 * subclass to ignore the border width in its size request and
1969 * allocate methods. The intent is for a subclass to invoke this
1970 * in its class_init function.
1972 * gtk_container_class_handle_border_width() is necessary because it
1973 * would break API too badly to make this behavior the default. So
1974 * subclasses must "opt in" to the parent class handling border_width
1978 gtk_container_class_handle_border_width (GtkContainerClass *klass)
1980 g_return_if_fail (GTK_IS_CONTAINER_CLASS (klass));
1982 klass->_handle_border_width = TRUE;
1986 * gtk_container_forall:
1987 * @container: a #GtkContainer
1988 * @callback: (scope call) (closure callback_data): a callback
1989 * @callback_data: callback user data
1991 * Invokes @callback on each child of @container, including children
1992 * that are considered "internal" (implementation details of the
1993 * container). "Internal" children generally weren't added by the user
1994 * of the container, but were added by the container implementation
1995 * itself. Most applications should use gtk_container_foreach(),
1996 * rather than gtk_container_forall().
2001 gtk_container_forall (GtkContainer *container,
2002 GtkCallback callback,
2003 gpointer callback_data)
2005 GtkContainerClass *class;
2007 g_return_if_fail (GTK_IS_CONTAINER (container));
2008 g_return_if_fail (callback != NULL);
2010 class = GTK_CONTAINER_GET_CLASS (container);
2013 class->forall (container, TRUE, callback, callback_data);
2017 * gtk_container_foreach:
2018 * @container: a #GtkContainer
2019 * @callback: (scope call): a callback
2020 * @callback_data: callback user data
2022 * Invokes @callback on each non-internal child of @container. See
2023 * gtk_container_forall() for details on what constitutes an
2024 * "internal" child. Most applications should use
2025 * gtk_container_foreach(), rather than gtk_container_forall().
2028 gtk_container_foreach (GtkContainer *container,
2029 GtkCallback callback,
2030 gpointer callback_data)
2032 GtkContainerClass *class;
2034 g_return_if_fail (GTK_IS_CONTAINER (container));
2035 g_return_if_fail (callback != NULL);
2037 class = GTK_CONTAINER_GET_CLASS (container);
2040 class->forall (container, FALSE, callback, callback_data);
2044 * gtk_container_set_focus_child:
2045 * @container: a #GtkContainer
2046 * @child: (allow-none): a #GtkWidget, or %NULL
2048 * Sets, or unsets if @child is %NULL, the focused child of @container.
2050 * This function emits the GtkContainer::set_focus_child signal of
2051 * @container. Implementations of #GtkContainer can override the
2052 * default behaviour by overriding the class closure of this signal.
2054 * This is function is mostly meant to be used by widgets. Applications can use
2055 * gtk_widget_grab_focus() to manualy set the focus to a specific widget.
2058 gtk_container_set_focus_child (GtkContainer *container,
2061 g_return_if_fail (GTK_IS_CONTAINER (container));
2063 g_return_if_fail (GTK_IS_WIDGET (child));
2065 g_signal_emit (container, container_signals[SET_FOCUS_CHILD], 0, child);
2069 * gtk_container_get_focus_child:
2070 * @container: a #GtkContainer
2072 * Returns the current focus child widget inside @container. This is not the
2073 * currently focused widget. That can be obtained by calling
2074 * gtk_window_get_focus().
2076 * Returns: (transfer none): The child widget which will receive the
2077 * focus inside @container when the @conatiner is focussed,
2078 * or %NULL if none is set.
2083 gtk_container_get_focus_child (GtkContainer *container)
2085 g_return_val_if_fail (GTK_IS_CONTAINER (container), NULL);
2087 return container->priv->focus_child;
2091 * gtk_container_get_children:
2092 * @container: a #GtkContainer
2094 * Returns the container's non-internal children. See
2095 * gtk_container_forall() for details on what constitutes an "internal" child.
2097 * Return value: (element-type GtkWidget) (transfer container): a newly-allocated list of the container's non-internal children.
2100 gtk_container_get_children (GtkContainer *container)
2102 GList *children = NULL;
2104 gtk_container_foreach (container,
2105 gtk_container_children_callback,
2108 return g_list_reverse (children);
2112 gtk_container_child_position_callback (GtkWidget *widget,
2113 gpointer client_data)
2119 } *data = client_data;
2122 if (data->child == widget)
2123 data->index = data->i;
2127 gtk_container_child_default_composite_name (GtkContainer *container,
2137 /* fallback implementation */
2141 gtk_container_forall (container,
2142 gtk_container_child_position_callback,
2145 name = g_strdup_printf ("%s-%u",
2146 g_type_name (G_TYPE_FROM_INSTANCE (child)),
2153 _gtk_container_child_composite_name (GtkContainer *container,
2156 gboolean composite_child;
2158 g_return_val_if_fail (GTK_IS_CONTAINER (container), NULL);
2159 g_return_val_if_fail (GTK_IS_WIDGET (child), NULL);
2160 g_return_val_if_fail (gtk_widget_get_parent (child) == GTK_WIDGET (container), NULL);
2162 g_object_get (child, "composite-child", &composite_child, NULL);
2163 if (composite_child)
2165 static GQuark quark_composite_name = 0;
2168 if (!quark_composite_name)
2169 quark_composite_name = g_quark_from_static_string ("gtk-composite-name");
2171 name = g_object_get_qdata (G_OBJECT (child), quark_composite_name);
2174 GtkContainerClass *class;
2176 class = GTK_CONTAINER_GET_CLASS (container);
2177 if (class->composite_name)
2178 name = class->composite_name (container, child);
2181 name = g_strdup (name);
2192 } ComputeExpandData;
2195 gtk_container_compute_expand_callback (GtkWidget *widget,
2196 gpointer client_data)
2198 ComputeExpandData *data = client_data;
2200 /* note that we don't get_expand on the child if we already know we
2201 * have to expand, so we only recurse into children until we find
2202 * one that expands and then we basically don't do any more
2203 * work. This means that we can leave some children in a
2204 * need_compute_expand state, which is fine, as long as GtkWidget
2205 * doesn't rely on an invariant that "if a child has
2206 * need_compute_expand, its parents also do"
2208 * gtk_widget_compute_expand() always returns FALSE if the
2209 * child is !visible so that's taken care of.
2211 data->hexpand = data->hexpand ||
2212 gtk_widget_compute_expand (widget, GTK_ORIENTATION_HORIZONTAL);
2214 data->vexpand = data->vexpand ||
2215 gtk_widget_compute_expand (widget, GTK_ORIENTATION_VERTICAL);
2219 gtk_container_compute_expand (GtkWidget *widget,
2220 gboolean *hexpand_p,
2221 gboolean *vexpand_p)
2223 ComputeExpandData data;
2225 data.hexpand = FALSE;
2226 data.vexpand = FALSE;
2228 gtk_container_forall (GTK_CONTAINER (widget),
2229 gtk_container_compute_expand_callback,
2232 *hexpand_p = data.hexpand;
2233 *vexpand_p = data.vexpand;
2237 gtk_container_real_set_focus_child (GtkContainer *container,
2240 GtkContainerPrivate *priv;
2242 g_return_if_fail (GTK_IS_CONTAINER (container));
2243 g_return_if_fail (child == NULL || GTK_IS_WIDGET (child));
2245 priv = container->priv;
2247 if (child != priv->focus_child)
2249 if (priv->focus_child)
2250 g_object_unref (priv->focus_child);
2251 priv->focus_child = child;
2252 if (priv->focus_child)
2253 g_object_ref (priv->focus_child);
2257 /* check for h/v adjustments
2259 if (priv->focus_child)
2261 GtkAdjustment *hadj;
2262 GtkAdjustment *vadj;
2263 GtkAllocation allocation;
2264 GtkWidget *focus_child;
2267 hadj = g_object_get_qdata (G_OBJECT (container), hadjustment_key_id);
2268 vadj = g_object_get_qdata (G_OBJECT (container), vadjustment_key_id);
2272 focus_child = priv->focus_child;
2273 while (GTK_IS_CONTAINER (focus_child) && gtk_container_get_focus_child (GTK_CONTAINER (focus_child)))
2275 focus_child = gtk_container_get_focus_child (GTK_CONTAINER (focus_child));
2278 gtk_widget_translate_coordinates (focus_child, priv->focus_child,
2281 gtk_widget_get_allocation (priv->focus_child, &allocation);
2285 gtk_widget_get_allocation (focus_child, &allocation);
2288 gtk_adjustment_clamp_page (vadj, y, y + allocation.height);
2291 gtk_adjustment_clamp_page (hadj, x, x + allocation.width);
2297 get_focus_chain (GtkContainer *container)
2299 return g_object_get_data (G_OBJECT (container), "gtk-container-focus-chain");
2302 /* same as gtk_container_get_children, except it includes internals
2305 _gtk_container_get_all_children (GtkContainer *container)
2307 GList *children = NULL;
2309 gtk_container_forall (container,
2310 gtk_container_children_callback,
2316 static GtkWidgetPath *
2317 gtk_container_real_get_path_for_child (GtkContainer *container,
2320 GtkStyleContext *context;
2321 GtkWidgetPath *path;
2324 context = gtk_widget_get_style_context (GTK_WIDGET (container));
2325 path = gtk_widget_path_copy (gtk_widget_get_path (GTK_WIDGET (container)));
2327 /* Copy any permanent classes to the path */
2328 classes = gtk_style_context_list_classes (context);
2335 classes = classes->next;
2337 gtk_widget_path_iter_add_class (path, -1, cur->data);
2338 g_list_free_1 (cur);
2341 gtk_widget_path_append_for_widget (path, child);
2347 gtk_container_focus (GtkWidget *widget,
2348 GtkDirectionType direction)
2351 GList *sorted_children;
2353 GtkContainer *container;
2354 GtkContainerPrivate *priv;
2356 g_return_val_if_fail (GTK_IS_CONTAINER (widget), FALSE);
2358 container = GTK_CONTAINER (widget);
2359 priv = container->priv;
2363 if (gtk_widget_get_can_focus (widget))
2365 if (!gtk_widget_has_focus (widget))
2367 gtk_widget_grab_focus (widget);
2373 /* Get a list of the containers children, allowing focus
2374 * chain to override.
2376 if (priv->has_focus_chain)
2377 children = g_list_copy (get_focus_chain (container));
2379 children = _gtk_container_get_all_children (container);
2381 if (priv->has_focus_chain &&
2382 (direction == GTK_DIR_TAB_FORWARD ||
2383 direction == GTK_DIR_TAB_BACKWARD))
2385 sorted_children = g_list_copy (children);
2387 if (direction == GTK_DIR_TAB_BACKWARD)
2388 sorted_children = g_list_reverse (sorted_children);
2391 sorted_children = _gtk_container_focus_sort (container, children, direction, NULL);
2393 return_val = gtk_container_focus_move (container, sorted_children, direction);
2395 g_list_free (sorted_children);
2396 g_list_free (children);
2403 tab_compare (gconstpointer a,
2407 GtkAllocation child1_allocation, child2_allocation;
2408 const GtkWidget *child1 = a;
2409 const GtkWidget *child2 = b;
2410 GtkTextDirection text_direction = GPOINTER_TO_INT (data);
2413 gtk_widget_get_allocation ((GtkWidget *) child1, &child1_allocation);
2414 gtk_widget_get_allocation ((GtkWidget *) child2, &child2_allocation);
2416 y1 = child1_allocation.y + child1_allocation.height / 2;
2417 y2 = child2_allocation.y + child2_allocation.height / 2;
2421 gint x1 = child1_allocation.x + child1_allocation.width / 2;
2422 gint x2 = child2_allocation.x + child2_allocation.width / 2;
2424 if (text_direction == GTK_TEXT_DIR_RTL)
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_tab (GtkContainer *container,
2436 GtkDirectionType direction,
2437 GtkWidget *old_focus)
2439 GtkTextDirection text_direction = gtk_widget_get_direction (GTK_WIDGET (container));
2440 children = g_list_sort_with_data (children, tab_compare, GINT_TO_POINTER (text_direction));
2442 /* if we are going backwards then reverse the order
2445 if (direction == GTK_DIR_TAB_BACKWARD)
2446 children = g_list_reverse (children);
2451 /* Get coordinates of @widget's allocation with respect to
2452 * allocation of @container.
2455 get_allocation_coords (GtkContainer *container,
2457 GdkRectangle *allocation)
2459 gtk_widget_get_allocation (widget, allocation);
2461 return gtk_widget_translate_coordinates (widget, GTK_WIDGET (container),
2462 0, 0, &allocation->x, &allocation->y);
2465 /* Look for a child in @children that is intermediate between
2466 * the focus widget and container. This widget, if it exists,
2467 * acts as the starting widget for focus navigation.
2470 find_old_focus (GtkContainer *container,
2473 GList *tmp_list = children;
2476 GtkWidget *child = tmp_list->data;
2477 GtkWidget *widget = child;
2479 while (widget && widget != (GtkWidget *)container)
2483 parent = gtk_widget_get_parent (widget);
2485 if (parent && (gtk_container_get_focus_child (GTK_CONTAINER (parent)) != widget))
2494 tmp_list = tmp_list->next;
2501 old_focus_coords (GtkContainer *container,
2502 GdkRectangle *old_focus_rect)
2504 GtkWidget *widget = GTK_WIDGET (container);
2505 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
2506 GtkWidget *old_focus;
2508 if (GTK_IS_WINDOW (toplevel))
2510 old_focus = gtk_window_get_focus (GTK_WINDOW (toplevel));
2512 return get_allocation_coords (container, old_focus, old_focus_rect);
2518 typedef struct _CompareInfo CompareInfo;
2522 GtkContainer *container;
2529 up_down_compare (gconstpointer a,
2533 GdkRectangle allocation1;
2534 GdkRectangle allocation2;
2535 CompareInfo *compare = data;
2538 get_allocation_coords (compare->container, (GtkWidget *)a, &allocation1);
2539 get_allocation_coords (compare->container, (GtkWidget *)b, &allocation2);
2541 y1 = allocation1.y + allocation1.height / 2;
2542 y2 = allocation2.y + allocation2.height / 2;
2546 gint x1 = abs (allocation1.x + allocation1.width / 2 - compare->x);
2547 gint x2 = abs (allocation2.x + allocation2.width / 2 - compare->x);
2549 if (compare->reverse)
2550 return (x1 < x2) ? 1 : ((x1 == x2) ? 0 : -1);
2552 return (x1 < x2) ? -1 : ((x1 == x2) ? 0 : 1);
2555 return (y1 < y2) ? -1 : 1;
2559 gtk_container_focus_sort_up_down (GtkContainer *container,
2561 GtkDirectionType direction,
2562 GtkWidget *old_focus)
2564 CompareInfo compare;
2566 GdkRectangle old_allocation;
2568 compare.container = container;
2569 compare.reverse = (direction == GTK_DIR_UP);
2572 old_focus = find_old_focus (container, children);
2574 if (old_focus && get_allocation_coords (container, old_focus, &old_allocation))
2580 /* Delete widgets from list that don't match minimum criteria */
2582 compare_x1 = old_allocation.x;
2583 compare_x2 = old_allocation.x + old_allocation.width;
2585 if (direction == GTK_DIR_UP)
2586 compare_y = old_allocation.y;
2588 compare_y = old_allocation.y + old_allocation.height;
2590 tmp_list = children;
2593 GtkWidget *child = tmp_list->data;
2594 GList *next = tmp_list->next;
2595 gint child_x1, child_x2;
2596 GdkRectangle child_allocation;
2598 if (child != old_focus)
2600 if (get_allocation_coords (container, child, &child_allocation))
2602 child_x1 = child_allocation.x;
2603 child_x2 = child_allocation.x + child_allocation.width;
2605 if ((child_x2 <= compare_x1 || child_x1 >= compare_x2) /* No horizontal overlap */ ||
2606 (direction == GTK_DIR_DOWN && child_allocation.y + child_allocation.height < compare_y) || /* Not below */
2607 (direction == GTK_DIR_UP && child_allocation.y > compare_y)) /* Not above */
2609 children = g_list_delete_link (children, tmp_list);
2613 children = g_list_delete_link (children, tmp_list);
2619 compare.x = (compare_x1 + compare_x2) / 2;
2620 compare.y = old_allocation.y + old_allocation.height / 2;
2624 /* No old focus widget, need to figure out starting x,y some other way
2626 GtkAllocation allocation;
2627 GtkWidget *widget = GTK_WIDGET (container);
2628 GdkRectangle old_focus_rect;
2630 gtk_widget_get_allocation (widget, &allocation);
2632 if (old_focus_coords (container, &old_focus_rect))
2634 compare.x = old_focus_rect.x + old_focus_rect.width / 2;
2638 if (!gtk_widget_get_has_window (widget))
2639 compare.x = allocation.x + allocation.width / 2;
2641 compare.x = allocation.width / 2;
2644 if (!gtk_widget_get_has_window (widget))
2645 compare.y = (direction == GTK_DIR_DOWN) ? allocation.y : allocation.y + allocation.height;
2647 compare.y = (direction == GTK_DIR_DOWN) ? 0 : + allocation.height;
2650 children = g_list_sort_with_data (children, up_down_compare, &compare);
2652 if (compare.reverse)
2653 children = g_list_reverse (children);
2659 left_right_compare (gconstpointer a,
2663 GdkRectangle allocation1;
2664 GdkRectangle allocation2;
2665 CompareInfo *compare = data;
2668 get_allocation_coords (compare->container, (GtkWidget *)a, &allocation1);
2669 get_allocation_coords (compare->container, (GtkWidget *)b, &allocation2);
2671 x1 = allocation1.x + allocation1.width / 2;
2672 x2 = allocation2.x + allocation2.width / 2;
2676 gint y1 = abs (allocation1.y + allocation1.height / 2 - compare->y);
2677 gint y2 = abs (allocation2.y + allocation2.height / 2 - compare->y);
2679 if (compare->reverse)
2680 return (y1 < y2) ? 1 : ((y1 == y2) ? 0 : -1);
2682 return (y1 < y2) ? -1 : ((y1 == y2) ? 0 : 1);
2685 return (x1 < x2) ? -1 : 1;
2689 gtk_container_focus_sort_left_right (GtkContainer *container,
2691 GtkDirectionType direction,
2692 GtkWidget *old_focus)
2694 CompareInfo compare;
2696 GdkRectangle old_allocation;
2698 compare.container = container;
2699 compare.reverse = (direction == GTK_DIR_LEFT);
2702 old_focus = find_old_focus (container, children);
2704 if (old_focus && get_allocation_coords (container, old_focus, &old_allocation))
2710 /* Delete widgets from list that don't match minimum criteria */
2712 compare_y1 = old_allocation.y;
2713 compare_y2 = old_allocation.y + old_allocation.height;
2715 if (direction == GTK_DIR_LEFT)
2716 compare_x = old_allocation.x;
2718 compare_x = old_allocation.x + old_allocation.width;
2720 tmp_list = children;
2723 GtkWidget *child = tmp_list->data;
2724 GList *next = tmp_list->next;
2725 gint child_y1, child_y2;
2726 GdkRectangle child_allocation;
2728 if (child != old_focus)
2730 if (get_allocation_coords (container, child, &child_allocation))
2732 child_y1 = child_allocation.y;
2733 child_y2 = child_allocation.y + child_allocation.height;
2735 if ((child_y2 <= compare_y1 || child_y1 >= compare_y2) /* No vertical overlap */ ||
2736 (direction == GTK_DIR_RIGHT && child_allocation.x + child_allocation.width < compare_x) || /* Not to left */
2737 (direction == GTK_DIR_LEFT && child_allocation.x > compare_x)) /* Not to right */
2739 children = g_list_delete_link (children, tmp_list);
2743 children = g_list_delete_link (children, tmp_list);
2749 compare.y = (compare_y1 + compare_y2) / 2;
2750 compare.x = old_allocation.x + old_allocation.width / 2;
2754 /* No old focus widget, need to figure out starting x,y some other way
2756 GtkAllocation allocation;
2757 GtkWidget *widget = GTK_WIDGET (container);
2758 GdkRectangle old_focus_rect;
2760 gtk_widget_get_allocation (widget, &allocation);
2762 if (old_focus_coords (container, &old_focus_rect))
2764 compare.y = old_focus_rect.y + old_focus_rect.height / 2;
2768 if (!gtk_widget_get_has_window (widget))
2769 compare.y = allocation.y + allocation.height / 2;
2771 compare.y = allocation.height / 2;
2774 if (!gtk_widget_get_has_window (widget))
2775 compare.x = (direction == GTK_DIR_RIGHT) ? allocation.x : allocation.x + allocation.width;
2777 compare.x = (direction == GTK_DIR_RIGHT) ? 0 : allocation.width;
2780 children = g_list_sort_with_data (children, left_right_compare, &compare);
2782 if (compare.reverse)
2783 children = g_list_reverse (children);
2789 * gtk_container_focus_sort:
2790 * @container: a #GtkContainer
2791 * @children: a list of descendents of @container (they don't
2792 * have to be direct children)
2793 * @direction: focus direction
2794 * @old_focus: (allow-none): widget to use for the starting position, or %NULL
2795 * to determine this automatically.
2796 * (Note, this argument isn't used for GTK_DIR_TAB_*,
2797 * which is the only @direction we use currently,
2798 * so perhaps this argument should be removed)
2800 * Sorts @children in the correct order for focusing with
2801 * direction type @direction.
2803 * Return value: a copy of @children, sorted in correct focusing order,
2804 * with children that aren't suitable for focusing in this direction
2808 _gtk_container_focus_sort (GtkContainer *container,
2810 GtkDirectionType direction,
2811 GtkWidget *old_focus)
2813 GList *visible_children = NULL;
2817 if (gtk_widget_get_realized (children->data))
2818 visible_children = g_list_prepend (visible_children, children->data);
2819 children = children->next;
2824 case GTK_DIR_TAB_FORWARD:
2825 case GTK_DIR_TAB_BACKWARD:
2826 return gtk_container_focus_sort_tab (container, visible_children, direction, old_focus);
2829 return gtk_container_focus_sort_up_down (container, visible_children, direction, old_focus);
2832 return gtk_container_focus_sort_left_right (container, visible_children, direction, old_focus);
2835 g_assert_not_reached ();
2841 gtk_container_focus_move (GtkContainer *container,
2843 GtkDirectionType direction)
2845 GtkContainerPrivate *priv = container->priv;
2846 GtkWidget *focus_child;
2849 focus_child = priv->focus_child;
2853 child = children->data;
2854 children = children->next;
2861 if (focus_child == child)
2865 if (gtk_widget_child_focus (child, direction))
2869 else if (gtk_widget_is_drawable (child) &&
2870 gtk_widget_is_ancestor (child, GTK_WIDGET (container)))
2872 if (gtk_widget_child_focus (child, direction))
2882 gtk_container_children_callback (GtkWidget *widget,
2883 gpointer client_data)
2887 children = (GList**) client_data;
2888 *children = g_list_prepend (*children, widget);
2892 chain_widget_destroyed (GtkWidget *widget,
2895 GtkContainer *container;
2898 container = GTK_CONTAINER (user_data);
2900 chain = g_object_get_data (G_OBJECT (container),
2901 "gtk-container-focus-chain");
2903 chain = g_list_remove (chain, widget);
2905 g_signal_handlers_disconnect_by_func (widget,
2906 chain_widget_destroyed,
2909 g_object_set_data (G_OBJECT (container),
2910 I_("gtk-container-focus-chain"),
2915 * gtk_container_set_focus_chain:
2916 * @container: a #GtkContainer
2917 * @focusable_widgets: (transfer none) (element-type GtkWidget):
2918 * the new focus chain
2920 * Sets a focus chain, overriding the one computed automatically by GTK+.
2922 * In principle each widget in the chain should be a descendant of the
2923 * container, but this is not enforced by this method, since it's allowed
2924 * to set the focus chain before you pack the widgets, or have a widget
2925 * in the chain that isn't always packed. The necessary checks are done
2926 * when the focus chain is actually traversed.
2929 gtk_container_set_focus_chain (GtkContainer *container,
2930 GList *focusable_widgets)
2934 GtkContainerPrivate *priv;
2936 g_return_if_fail (GTK_IS_CONTAINER (container));
2938 priv = container->priv;
2940 if (priv->has_focus_chain)
2941 gtk_container_unset_focus_chain (container);
2943 priv->has_focus_chain = TRUE;
2946 tmp_list = focusable_widgets;
2947 while (tmp_list != NULL)
2949 g_return_if_fail (GTK_IS_WIDGET (tmp_list->data));
2951 /* In principle each widget in the chain should be a descendant
2952 * of the container, but we don't want to check that here. It's
2953 * expensive and also it's allowed to set the focus chain before
2954 * you pack the widgets, or have a widget in the chain that isn't
2955 * always packed. So we check for ancestor during actual traversal.
2958 chain = g_list_prepend (chain, tmp_list->data);
2960 g_signal_connect (tmp_list->data,
2962 G_CALLBACK (chain_widget_destroyed),
2965 tmp_list = g_list_next (tmp_list);
2968 chain = g_list_reverse (chain);
2970 g_object_set_data (G_OBJECT (container),
2971 I_("gtk-container-focus-chain"),
2976 * gtk_container_get_focus_chain:
2977 * @container: a #GtkContainer
2978 * @focusable_widgets: (element-type GtkWidget) (out) (transfer container): location
2979 * to store the focus chain of the
2980 * container, or %NULL. You should free this list
2981 * using g_list_free() when you are done with it, however
2982 * no additional reference count is added to the
2983 * individual widgets in the focus chain.
2985 * Retrieves the focus chain of the container, if one has been
2986 * set explicitly. If no focus chain has been explicitly
2987 * set, GTK+ computes the focus chain based on the positions
2988 * of the children. In that case, GTK+ stores %NULL in
2989 * @focusable_widgets and returns %FALSE.
2991 * Return value: %TRUE if the focus chain of the container
2992 * has been set explicitly.
2995 gtk_container_get_focus_chain (GtkContainer *container,
2996 GList **focus_chain)
2998 GtkContainerPrivate *priv;
3000 g_return_val_if_fail (GTK_IS_CONTAINER (container), FALSE);
3002 priv = container->priv;
3006 if (priv->has_focus_chain)
3007 *focus_chain = g_list_copy (get_focus_chain (container));
3009 *focus_chain = NULL;
3012 return priv->has_focus_chain;
3016 * gtk_container_unset_focus_chain:
3017 * @container: a #GtkContainer
3019 * Removes a focus chain explicitly set with gtk_container_set_focus_chain().
3022 gtk_container_unset_focus_chain (GtkContainer *container)
3024 GtkContainerPrivate *priv;
3026 g_return_if_fail (GTK_IS_CONTAINER (container));
3028 priv = container->priv;
3030 if (priv->has_focus_chain)
3035 chain = get_focus_chain (container);
3037 priv->has_focus_chain = FALSE;
3039 g_object_set_data (G_OBJECT (container),
3040 I_("gtk-container-focus-chain"),
3044 while (tmp_list != NULL)
3046 g_signal_handlers_disconnect_by_func (tmp_list->data,
3047 chain_widget_destroyed,
3050 tmp_list = g_list_next (tmp_list);
3053 g_list_free (chain);
3058 * gtk_container_set_focus_vadjustment:
3059 * @container: a #GtkContainer
3060 * @adjustment: an adjustment which should be adjusted when the focus
3061 * is moved among the descendents of @container
3063 * Hooks up an adjustment to focus handling in a container, so when a
3064 * child of the container is focused, the adjustment is scrolled to
3065 * show that widget. This function sets the vertical alignment. See
3066 * gtk_scrolled_window_get_vadjustment() for a typical way of obtaining
3067 * the adjustment and gtk_container_set_focus_hadjustment() for setting
3068 * the horizontal adjustment.
3070 * The adjustments have to be in pixel units and in the same coordinate
3071 * system as the allocation for immediate children of the container.
3074 gtk_container_set_focus_vadjustment (GtkContainer *container,
3075 GtkAdjustment *adjustment)
3077 g_return_if_fail (GTK_IS_CONTAINER (container));
3079 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
3082 g_object_ref (adjustment);
3084 g_object_set_qdata_full (G_OBJECT (container),
3091 * gtk_container_get_focus_vadjustment:
3092 * @container: a #GtkContainer
3094 * Retrieves the vertical focus adjustment for the container. See
3095 * gtk_container_set_focus_vadjustment().
3097 * Return value: (transfer none): the vertical focus adjustment, or %NULL if
3098 * none has been set.
3101 gtk_container_get_focus_vadjustment (GtkContainer *container)
3103 GtkAdjustment *vadjustment;
3105 g_return_val_if_fail (GTK_IS_CONTAINER (container), NULL);
3107 vadjustment = g_object_get_qdata (G_OBJECT (container), vadjustment_key_id);
3113 * gtk_container_set_focus_hadjustment:
3114 * @container: a #GtkContainer
3115 * @adjustment: an adjustment which should be adjusted when the focus is
3116 * moved among the descendents of @container
3118 * Hooks up an adjustment to focus handling in a container, so when a child
3119 * of the container is focused, the adjustment is scrolled to show that
3120 * widget. This function sets the horizontal alignment.
3121 * See gtk_scrolled_window_get_hadjustment() for a typical way of obtaining
3122 * the adjustment and gtk_container_set_focus_vadjustment() for setting
3123 * the vertical adjustment.
3125 * The adjustments have to be in pixel units and in the same coordinate
3126 * system as the allocation for immediate children of the container.
3129 gtk_container_set_focus_hadjustment (GtkContainer *container,
3130 GtkAdjustment *adjustment)
3132 g_return_if_fail (GTK_IS_CONTAINER (container));
3134 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
3137 g_object_ref (adjustment);
3139 g_object_set_qdata_full (G_OBJECT (container),
3146 * gtk_container_get_focus_hadjustment:
3147 * @container: a #GtkContainer
3149 * Retrieves the horizontal focus adjustment for the container. See
3150 * gtk_container_set_focus_hadjustment ().
3152 * Return value: (transfer none): the horizontal focus adjustment, or %NULL if
3153 * none has been set.
3156 gtk_container_get_focus_hadjustment (GtkContainer *container)
3158 GtkAdjustment *hadjustment;
3160 g_return_val_if_fail (GTK_IS_CONTAINER (container), NULL);
3162 hadjustment = g_object_get_qdata (G_OBJECT (container), hadjustment_key_id);
3169 gtk_container_show_all (GtkWidget *widget)
3171 g_return_if_fail (GTK_IS_CONTAINER (widget));
3173 gtk_container_foreach (GTK_CONTAINER (widget),
3174 (GtkCallback) gtk_widget_show_all,
3176 gtk_widget_show (widget);
3180 gtk_container_draw_child (GtkWidget *child,
3181 gpointer client_data)
3184 GtkWidget *container;
3186 } *data = client_data;
3188 gtk_container_propagate_draw (GTK_CONTAINER (data->container),
3194 gtk_container_draw (GtkWidget *widget,
3198 GtkWidget *container;
3202 data.container = widget;
3205 gtk_container_forall (GTK_CONTAINER (widget),
3206 gtk_container_draw_child,
3213 gtk_container_map_child (GtkWidget *child,
3214 gpointer client_data)
3216 if (gtk_widget_get_visible (child) &&
3217 gtk_widget_get_child_visible (child) &&
3218 !gtk_widget_get_mapped (child))
3219 gtk_widget_map (child);
3223 gtk_container_map (GtkWidget *widget)
3225 gtk_widget_set_mapped (widget, TRUE);
3227 gtk_container_forall (GTK_CONTAINER (widget),
3228 gtk_container_map_child,
3231 if (gtk_widget_get_has_window (widget))
3232 gdk_window_show (gtk_widget_get_window (widget));
3236 gtk_container_unmap (GtkWidget *widget)
3238 gtk_widget_set_mapped (widget, FALSE);
3240 /* hide our window first so user doesn't see all the child windows
3241 * vanishing one by one. (only matters these days if one of the
3242 * children has an actual native window instead of client-side
3243 * window, e.g. a GtkSocket would)
3245 if (gtk_widget_get_has_window (widget))
3246 gdk_window_hide (gtk_widget_get_window (widget));
3248 gtk_container_forall (GTK_CONTAINER (widget),
3249 (GtkCallback)gtk_widget_unmap,
3254 * gtk_container_propagate_draw:
3255 * @container: a #GtkContainer
3256 * @child: a child of @container
3257 * @cr: Cairo context as passed to the container. If you want to use @cr
3258 * in container's draw function, consider using cairo_save() and
3259 * cairo_restore() before calling this function.
3261 * When a container receives a call to the draw function, it must send
3262 * synthetic #GtkWidget::draw calls to all children that don't have their
3263 * own #GdkWindows. This function provides a convenient way of doing this.
3264 * A container, when it receives a call to its #GtkWidget::draw function,
3265 * calls gtk_container_propagate_draw() once for each child, passing in
3266 * the @cr the container received.
3268 * gtk_container_propagate_draw() takes care of translating the origin of @cr,
3269 * and deciding whether the draw needs to be sent to the child. It is a
3270 * convenient and optimized way of getting the same effect as calling
3271 * gtk_widget_draw() on the child directly.
3273 * In most cases, a container can simply either inherit the
3274 * #GtkWidget::draw implementation from #GtkContainer, or do some drawing
3275 * and then chain to the ::draw implementation from #GtkContainer.
3278 gtk_container_propagate_draw (GtkContainer *container,
3282 GdkEventExpose *event;
3283 GtkAllocation allocation;
3284 GdkWindow *window, *w;
3287 g_return_if_fail (GTK_IS_CONTAINER (container));
3288 g_return_if_fail (GTK_IS_WIDGET (child));
3289 g_return_if_fail (cr != NULL);
3291 g_assert (gtk_widget_get_parent (child) == GTK_WIDGET (container));
3293 event = _gtk_cairo_get_event (cr);
3296 if (gtk_widget_get_has_window (child) ||
3297 gtk_widget_get_window (child) != event->window)
3303 /* translate coordinates. Ugly business, that. */
3304 if (!gtk_widget_get_has_window (GTK_WIDGET (container)))
3306 gtk_widget_get_allocation (GTK_WIDGET (container), &allocation);
3316 window = gtk_widget_get_window (GTK_WIDGET (container));
3318 for (w = gtk_widget_get_window (child); w && w != window; w = gdk_window_get_parent (w))
3321 gdk_window_get_position (w, &wx, &wy);
3332 if (!gtk_widget_get_has_window (child))
3334 gtk_widget_get_allocation (child, &allocation);
3339 cairo_translate (cr, x, y);
3341 _gtk_widget_draw_internal (child, cr, TRUE);
3347 _gtk_container_get_need_resize (GtkContainer *container)
3349 return container->priv->need_resize;
3353 _gtk_container_set_need_resize (GtkContainer *container,
3354 gboolean need_resize)
3356 container->priv->need_resize = need_resize;
3360 _gtk_container_get_reallocate_redraws (GtkContainer *container)
3362 return container->priv->reallocate_redraws;
3366 * gtk_container_get_path_for_child:
3367 * @container: a #GtkContainer
3368 * @child: a child of @container
3370 * Returns a newly created widget path representing all the widget hierarchy
3371 * from the toplevel down to and including @child.
3373 * Returns: A newly created #GtkWidgetPath
3376 gtk_container_get_path_for_child (GtkContainer *container,
3379 GtkWidgetPath *path;
3381 g_return_val_if_fail (GTK_IS_CONTAINER (container), NULL);
3382 g_return_val_if_fail (GTK_IS_WIDGET (child), NULL);
3383 g_return_val_if_fail (container == (GtkContainer *) gtk_widget_get_parent (child), NULL);
3385 path = GTK_CONTAINER_GET_CLASS (container)->get_path_for_child (container, child);
3386 if (gtk_widget_path_get_object_type (path) != G_OBJECT_TYPE (child))
3388 g_critical ("%s %p returned a widget path for type %s, but child is %s",
3389 G_OBJECT_TYPE_NAME (container),
3391 g_type_name (gtk_widget_path_get_object_type (path)),
3392 G_OBJECT_TYPE_NAME (child));