Pileus Git - ~andy/gtk/blob - gtk/gtkcontainer.c

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   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.
   8  *
   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.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GTK+ Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #include "config.h"
  28
  29 #include "gtkcontainer.h"
  30 #include "gtkcontainerprivate.h"
  31
  32 #include <stdarg.h>
  33 #include <string.h>
  34 #include <stdlib.h>
  35
  36 #include <gobject/gobjectnotifyqueue.c>
  37 #include <gobject/gvaluecollector.h>
  38
  39 #include "gtkbuildable.h"
  40 #include "gtkbuilderprivate.h"
  41 #include "gtktypebuiltins.h"
  42 #include "gtkprivate.h"
  43 #include "gtkmain.h"
  44 #include "gtkmarshalers.h"
  45 #include "gtksizerequest.h"
  46 #include "gtkwidgetprivate.h"
  47 #include "gtkwindow.h"
  48 #include "gtkintl.h"
  49 #include "gtktoolbar.h"
  50 #include "a11y/gtkcontaineraccessible.h"
  51
  52 /**
  53  * SECTION:gtkcontainer
  54  * @Short_description: Base class for widgets which contain other widgets
  55  * @Title: GtkContainer
  56  *
  57  * A GTK+ user interface is constructed by nesting widgets inside widgets.
  58  * Container widgets are the inner nodes in the resulting tree of widgets:
  59  * they contain other widgets. So, for example, you might have a #GtkWindow
  60  * containing a #GtkFrame containing a #GtkLabel. If you wanted an image instead
  61  * of a textual label inside the frame, you might replace the #GtkLabel widget
  62  * with a #GtkImage widget.
  63  *
  64  * There are two major kinds of container widgets in GTK+. Both are subclasses
  65  * of the abstract GtkContainer base class.
  66  *
  67  * The first type of container widget has a single child widget and derives
  68  * from #GtkBin. These containers are <emphasis>decorators</emphasis>, which
  69  * add some kind of functionality to the child. For example, a #GtkButton makes
  70  * its child into a clickable button; a #GtkFrame draws a frame around its child
  71  * and a #GtkWindow places its child widget inside a top-level window.
  72  *
  73  * The second type of container can have more than one child; its purpose is to
  74  * manage <emphasis>layout</emphasis>. This means that these containers assign
  75  * sizes and positions to their children. For example, a #GtkHBox arranges its
  76  * children in a horizontal row, and a #GtkTable arranges the widgets it contains
  77  * in a two-dimensional grid.
  78  *
  79  * <refsect2 id="container-geometry-management">
  80  * <title>Height for width geometry management</title>
  81  * <para>
  82  * GTK+ uses a height-for-width (and width-for-height) geometry management system.
  83  * Height-for-width means that a widget can change how much vertical space it needs,
  84  * depending on the amount of horizontal space that it is given (and similar for
  85  * width-for-height).
  86  *
  87  * There are some things to keep in mind when implementing container widgets
  88  * that make use of GTK+'s height for width geometry management system. First,
  89  * it's important to note that a container must prioritize one of its
  90  * dimensions, that is to say that a widget or container can only have a
  91  * #GtkSizeRequestMode that is %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH or
  92  * %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT. However, every widget and container
  93  * must be able to respond to the APIs for both dimensions, i.e. even if a
  94  * widget has a request mode that is height-for-width, it is possible that
  95  * its parent will request its sizes using the width-for-height APIs.
  96  *
  97  * To ensure that everything works properly, here are some guidelines to follow
  98  * when implementing height-for-width (or width-for-height) containers.
  99  *
 100  * Each request mode involves 2 virtual methods. Height-for-width apis run
 101  * through gtk_widget_get_preferred_width() and then through gtk_widget_get_preferred_height_for_width().
 102  * When handling requests in the opposite #GtkSizeRequestMode it is important that
 103  * every widget request at least enough space to display all of its content at all times.
 104  *
 105  * When gtk_widget_get_preferred_height() is called on a container that is height-for-width,
 106  * the container must return the height for its minimum width. This is easily achieved by
 107  * simply calling the reverse apis implemented for itself as follows:
 108  *
 109  * <programlisting><![CDATA[
 110  * static void
 111  * foo_container_get_preferred_height (GtkWidget *widget, gint *min_height, gint *nat_height)
 112  * {
 113  *    if (i_am_in_height_for_width_mode)
 114  *      {
 115  *        gint min_width;
 116  *
 117  *        GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, &min_width, NULL);
 118  *        GTK_WIDGET_GET_CLASS (widget)->get_preferred_height_for_width (widget, min_width,
 119  *                                                                       min_height, nat_height);
 120  *      }
 121  *    else
 122  *      {
 123  *        ... many containers support both request modes, execute the real width-for-height
 124  *        request here by returning the collective heights of all widgets that are
 125  *        stacked vertically (or whatever is appropriate for this container) ...
 126  *      }
 127  * }
 128  * ]]></programlisting>
 129  *
 130  * Similarly, when gtk_widget_get_preferred_width_for_height() is called for a container or widget
 131  * that is height-for-width, it then only needs to return the base minimum width like so:
 132  *
 133  * <programlisting><![CDATA[
 134  * static void
 135  * foo_container_get_preferred_width_for_height (GtkWidget *widget, gint for_height,
 136  *                                               gint *min_width, gint *nat_width)
 137  * {
 138  *    if (i_am_in_height_for_width_mode)
 139  *      {
 140  *        GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, min_width, nat_width);
 141  *      }
 142  *    else
 143  *      {
 144  *        ... execute the real width-for-height request here based on the required width
 145  *        of the children collectively if the container were to be allocated the said height ...
 146  *      }
 147  * }
 148  * ]]></programlisting>
 149  *
 150  * Height for width requests are generally implemented in terms of a virtual allocation
 151  * of widgets in the input orientation. Assuming an height-for-width request mode, a container
 152  * would implement the <function>get_preferred_height_for_width()</function> virtual function by first calling
 153  * gtk_widget_get_preferred_width() for each of its children.
 154  *
 155  * For each potential group of children that are lined up horizontally, the values returned by
 156  * gtk_widget_get_preferred_width() should be collected in an array of #GtkRequestedSize structures.
 157  * Any child spacing should be removed from the input @for_width and then the collective size should be
 158  * allocated using the gtk_distribute_natural_allocation() convenience function.
 159  *
 160  * The container will then move on to request the preferred height for each child by using
 161  * gtk_widget_get_preferred_height_for_width() and using the sizes stored in the #GtkRequestedSize array.
 162  *
 163  * To allocate a height-for-width container, it's again important
 164  * to consider that a container must prioritize one dimension over the other. So if
 165  * a container is a height-for-width container it must first allocate all widgets horizontally
 166  * using a #GtkRequestedSize array and gtk_distribute_natural_allocation() and then add any
 167  * extra space (if and where appropriate) for the widget to expand.
 168  *
 169  * After adding all the expand space, the container assumes it was allocated sufficient
 170  * height to fit all of its content. At this time, the container must use the total horizontal sizes
 171  * of each widget to request the height-for-width of each of its children and store the requests in a
 172  * #GtkRequestedSize array for any widgets that stack vertically (for tabular containers this can
 173  * be generalized into the heights and widths of rows and columns).
 174  * The vertical space must then again be distributed using gtk_distribute_natural_allocation()
 175  * while this time considering the allocated height of the widget minus any vertical spacing
 176  * that the container adds. Then vertical expand space should be added where appropriate and available
 177  * and the container should go on to actually allocating the child widgets.
 178  *
 179  * See <link linkend="geometry-management">GtkWidget's geometry management section</link>
 180  * to learn more about implementing height-for-width geometry management for widgets.
 181  * </para>
 182  * </refsect2>
 183  * <refsect2 id="child-properties">
 184  * <title>Child properties</title>
 185  * <para>
 186  * GtkContainer introduces <emphasis>child properties</emphasis>.
 187  * These are object properties that are not specific
 188  * to either the container or the contained widget, but rather to their relation.
 189  * Typical examples of child properties are the position or pack-type of a widget
 190  * which is contained in a #GtkBox.
 191  *
 192  * Use gtk_container_class_install_child_property() to install child properties
 193  * for a container class and gtk_container_class_find_child_property() or
 194  * gtk_container_class_list_child_properties() to get information about existing
 195  * child properties.
 196  *
 197  * To set the value of a child property, use gtk_container_child_set_property(),
 198  * gtk_container_child_set() or gtk_container_child_set_valist().
 199  * To obtain the value of a child property, use
 200  * gtk_container_child_get_property(), gtk_container_child_get() or
 201  * gtk_container_child_get_valist(). To emit notification about child property
 202  * changes, use gtk_widget_child_notify().
 203  * </para>
 204  * </refsect2>
 205  * <refsect2 id="GtkContainer-BUILDER-UI">
 206  * <title>GtkContainer as GtkBuildable</title>
 207  * <para>
 208  * The GtkContainer implementation of the GtkBuildable interface
 209  * supports a &lt;packing&gt; element for children, which can
 210  * contain multiple &lt;property&gt; elements that specify
 211  * child properties for the child.
 212  * <example>
 213  * <title>Child properties in UI definitions</title>
 214  * <programlisting><![CDATA[
 215  * <object class="GtkVBox">
 216  *   <child>
 217  *     <object class="GtkLabel"/>
 218  *     <packing>
 219  *       <property name="pack-type">start</property>
 220  *     </packing>
 221  *   </child>
 222  * </object>
 223  * ]]></programlisting>
 224  * </example>
 225  * Since 2.16, child properties can also be marked as translatable using
 226  * the same "translatable", "comments" and "context" attributes that are used
 227  * for regular properties.
 228  * </para>
 229  * </refsect2>
 230  */
 231
 232
 233 struct _GtkContainerPrivate
 234 {
 235   GtkWidget *focus_child;
 236
 237   guint border_width : 16;
 238
 239   guint has_focus_chain    : 1;
 240   guint need_resize        : 1;
 241   guint reallocate_redraws : 1;
 242   guint resize_mode        : 2;
 243   guint request_mode       : 2;
 244 };
 245
 246 enum {
 247   ADD,
 248   REMOVE,
 249   CHECK_RESIZE,
 250   SET_FOCUS_CHILD,
 251   LAST_SIGNAL
 252 };
 253
 254 enum {
 255   PROP_0,
 256   PROP_BORDER_WIDTH,
 257   PROP_RESIZE_MODE,
 258   PROP_CHILD
 259 };
 260
 261 #define PARAM_SPEC_PARAM_ID(pspec)              ((pspec)->param_id)
 262 #define PARAM_SPEC_SET_PARAM_ID(pspec, id)      ((pspec)->param_id = (id))
 263
 264
 265 /* --- prototypes --- */
 266 static void     gtk_container_base_class_init      (GtkContainerClass *klass);
 267 static void     gtk_container_base_class_finalize  (GtkContainerClass *klass);
 268 static void     gtk_container_class_init           (GtkContainerClass *klass);
 269 static void     gtk_container_init                 (GtkContainer      *container);
 270 static void     gtk_container_destroy              (GtkWidget         *widget);
 271 static void     gtk_container_set_property         (GObject         *object,
 272                                                     guint            prop_id,
 273                                                     const GValue    *value,
 274                                                     GParamSpec      *pspec);
 275 static void     gtk_container_get_property         (GObject         *object,
 276                                                     guint            prop_id,
 277                                                     GValue          *value,
 278                                                     GParamSpec      *pspec);
 279 static void     gtk_container_add_unimplemented    (GtkContainer      *container,
 280                                                     GtkWidget         *widget);
 281 static void     gtk_container_remove_unimplemented (GtkContainer      *container,
 282                                                     GtkWidget         *widget);
 283 static void     gtk_container_real_check_resize    (GtkContainer      *container);
 284 static void     gtk_container_compute_expand       (GtkWidget         *widget,
 285                                                     gboolean          *hexpand_p,
 286                                                     gboolean          *vexpand_p);
 287 static gboolean gtk_container_focus                (GtkWidget         *widget,
 288                                                     GtkDirectionType   direction);
 289 static void     gtk_container_real_set_focus_child (GtkContainer      *container,
 290                                                     GtkWidget         *widget);
 291
 292 static gboolean gtk_container_focus_move           (GtkContainer      *container,
 293                                                     GList             *children,
 294                                                     GtkDirectionType   direction);
 295 static void     gtk_container_children_callback    (GtkWidget         *widget,
 296                                                     gpointer           client_data);
 297 static void     gtk_container_show_all             (GtkWidget         *widget);
 298 static gint     gtk_container_draw                 (GtkWidget         *widget,
 299                                                     cairo_t           *cr);
 300 static void     gtk_container_map                  (GtkWidget         *widget);
 301 static void     gtk_container_unmap                (GtkWidget         *widget);
 302 static void     gtk_container_adjust_size_request  (GtkWidget         *widget,
 303                                                     GtkOrientation     orientation,
 304                                                     gint              *minimum_size,
 305                                                     gint              *natural_size);
 306 static void     gtk_container_adjust_size_allocation (GtkWidget       *widget,
 307                                                       GtkOrientation   orientation,
 308                                                       gint            *minimum_size,
 309                                                       gint            *natural_size,
 310                                                       gint            *allocated_pos,
 311                                                       gint            *allocated_size);
 312 static GtkSizeRequestMode gtk_container_get_request_mode (GtkWidget   *widget);
 313
 314 static gchar* gtk_container_child_default_composite_name (GtkContainer *container,
 315                                                           GtkWidget    *child);
 316
 317 static GtkWidgetPath * gtk_container_real_get_path_for_child (GtkContainer *container,
 318                                                               GtkWidget    *child);
 319
 320 /* GtkBuildable */
 321 static void gtk_container_buildable_init           (GtkBuildableIface *iface);
 322 static void gtk_container_buildable_add_child      (GtkBuildable *buildable,
 323                                                     GtkBuilder   *builder,
 324                                                     GObject      *child,
 325                                                     const gchar  *type);
 326 static gboolean gtk_container_buildable_custom_tag_start (GtkBuildable  *buildable,
 327                                                           GtkBuilder    *builder,
 328                                                           GObject       *child,
 329                                                           const gchar   *tagname,
 330                                                           GMarkupParser *parser,
 331                                                           gpointer      *data);
 332 static void    gtk_container_buildable_custom_tag_end (GtkBuildable *buildable,
 333                                                        GtkBuilder   *builder,
 334                                                        GObject      *child,
 335                                                        const gchar  *tagname,
 336                                                        gpointer     *data);
 337
 338
 339 /* --- variables --- */
 340 static const gchar           vadjustment_key[] = "gtk-vadjustment";
 341 static guint                 vadjustment_key_id = 0;
 342 static const gchar           hadjustment_key[] = "gtk-hadjustment";
 343 static guint                 hadjustment_key_id = 0;
 344 static GSList               *container_resize_queue = NULL;
 345 static guint                 container_signals[LAST_SIGNAL] = { 0 };
 346 static GtkWidgetClass       *parent_class = NULL;
 347 extern GParamSpecPool       *_gtk_widget_child_property_pool;
 348 extern GObjectNotifyContext *_gtk_widget_child_property_notify_context;
 349 static GtkBuildableIface    *parent_buildable_iface;
 350
 351
 352 /* --- functions --- */
 353 GType
 354 gtk_container_get_type (void)
 355 {
 356   static GType container_type = 0;
 357
 358   if (!container_type)
 359     {
 360       const GTypeInfo container_info =
 361       {
 362         sizeof (GtkContainerClass),
 363         (GBaseInitFunc) gtk_container_base_class_init,
 364         (GBaseFinalizeFunc) gtk_container_base_class_finalize,
 365         (GClassInitFunc) gtk_container_class_init,
 366         NULL        /* class_finalize */,
 367         NULL        /* class_data */,
 368         sizeof (GtkContainer),
 369         0           /* n_preallocs */,
 370         (GInstanceInitFunc) gtk_container_init,
 371         NULL,       /* value_table */
 372       };
 373
 374       const GInterfaceInfo buildable_info =
 375       {
 376         (GInterfaceInitFunc) gtk_container_buildable_init,
 377         NULL,
 378         NULL
 379       };
 380
 381       container_type =
 382         g_type_register_static (GTK_TYPE_WIDGET, I_("GtkContainer"),
 383                                 &container_info, G_TYPE_FLAG_ABSTRACT);
 384
 385       g_type_add_interface_static (container_type,
 386                                    GTK_TYPE_BUILDABLE,
 387                                    &buildable_info);
 388
 389     }
 390
 391   return container_type;
 392 }
 393
 394 static void
 395 gtk_container_base_class_init (GtkContainerClass *class)
 396 {
 397   /* reset instance specifc class fields that don't get inherited */
 398   class->set_child_property = NULL;
 399   class->get_child_property = NULL;
 400 }
 401
 402 static void
 403 gtk_container_base_class_finalize (GtkContainerClass *class)
 404 {
 405   GList *list, *node;
 406
 407   list = g_param_spec_pool_list_owned (_gtk_widget_child_property_pool, G_OBJECT_CLASS_TYPE (class));
 408   for (node = list; node; node = node->next)
 409     {
 410       GParamSpec *pspec = node->data;
 411
 412       g_param_spec_pool_remove (_gtk_widget_child_property_pool, pspec);
 413       PARAM_SPEC_SET_PARAM_ID (pspec, 0);
 414       g_param_spec_unref (pspec);
 415     }
 416   g_list_free (list);
 417 }
 418
 419 static void
 420 gtk_container_class_init (GtkContainerClass *class)
 421 {
 422   GObjectClass *gobject_class = G_OBJECT_CLASS (class);
 423   GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
 424
 425   parent_class = g_type_class_peek_parent (class);
 426
 427   vadjustment_key_id = g_quark_from_static_string (vadjustment_key);
 428   hadjustment_key_id = g_quark_from_static_string (hadjustment_key);
 429
 430   gobject_class->set_property = gtk_container_set_property;
 431   gobject_class->get_property = gtk_container_get_property;
 432
 433   widget_class->destroy = gtk_container_destroy;
 434   widget_class->compute_expand = gtk_container_compute_expand;
 435   widget_class->show_all = gtk_container_show_all;
 436   widget_class->draw = gtk_container_draw;
 437   widget_class->map = gtk_container_map;
 438   widget_class->unmap = gtk_container_unmap;
 439   widget_class->focus = gtk_container_focus;
 440
 441   widget_class->adjust_size_request = gtk_container_adjust_size_request;
 442   widget_class->adjust_size_allocation = gtk_container_adjust_size_allocation;
 443   widget_class->get_request_mode = gtk_container_get_request_mode;
 444
 445   class->add = gtk_container_add_unimplemented;
 446   class->remove = gtk_container_remove_unimplemented;
 447   class->check_resize = gtk_container_real_check_resize;
 448   class->forall = NULL;
 449   class->set_focus_child = gtk_container_real_set_focus_child;
 450   class->child_type = NULL;
 451   class->composite_name = gtk_container_child_default_composite_name;
 452   class->get_path_for_child = gtk_container_real_get_path_for_child;
 453
 454   g_object_class_install_property (gobject_class,
 455                                    PROP_RESIZE_MODE,
 456                                    g_param_spec_enum ("resize-mode",
 457                                                       P_("Resize mode"),
 458                                                       P_("Specify how resize events are handled"),
 459                                                       GTK_TYPE_RESIZE_MODE,
 460                                                       GTK_RESIZE_PARENT,
 461                                                       GTK_PARAM_READWRITE));
 462   g_object_class_install_property (gobject_class,
 463                                    PROP_BORDER_WIDTH,
 464                                    g_param_spec_uint ("border-width",
 465                                                       P_("Border width"),
 466                                                       P_("The width of the empty border outside the containers children"),
 467                                                       0,
 468                                                       65535,
 469                                                       0,
 470                                                       GTK_PARAM_READWRITE));
 471   g_object_class_install_property (gobject_class,
 472                                    PROP_CHILD,
 473                                    g_param_spec_object ("child",
 474                                                       P_("Child"),
 475                                                       P_("Can be used to add a new child to the container"),
 476                                                       GTK_TYPE_WIDGET,
 477                                                       GTK_PARAM_WRITABLE));
 478   container_signals[ADD] =
 479     g_signal_new (I_("add"),
 480                   G_OBJECT_CLASS_TYPE (gobject_class),
 481                   G_SIGNAL_RUN_FIRST,
 482                   G_STRUCT_OFFSET (GtkContainerClass, add),
 483                   NULL, NULL,
 484                   _gtk_marshal_VOID__OBJECT,
 485                   G_TYPE_NONE, 1,
 486                   GTK_TYPE_WIDGET);
 487   container_signals[REMOVE] =
 488     g_signal_new (I_("remove"),
 489                   G_OBJECT_CLASS_TYPE (gobject_class),
 490                   G_SIGNAL_RUN_FIRST,
 491                   G_STRUCT_OFFSET (GtkContainerClass, remove),
 492                   NULL, NULL,
 493                   _gtk_marshal_VOID__OBJECT,
 494                   G_TYPE_NONE, 1,
 495                   GTK_TYPE_WIDGET);
 496   container_signals[CHECK_RESIZE] =
 497     g_signal_new (I_("check-resize"),
 498                   G_OBJECT_CLASS_TYPE (gobject_class),
 499                   G_SIGNAL_RUN_LAST,
 500                   G_STRUCT_OFFSET (GtkContainerClass, check_resize),
 501                   NULL, NULL,
 502                   _gtk_marshal_VOID__VOID,
 503                   G_TYPE_NONE, 0);
 504   container_signals[SET_FOCUS_CHILD] =
 505     g_signal_new (I_("set-focus-child"),
 506                   G_OBJECT_CLASS_TYPE (gobject_class),
 507                   G_SIGNAL_RUN_FIRST,
 508                   G_STRUCT_OFFSET (GtkContainerClass, set_focus_child),
 509                   NULL, NULL,
 510                   _gtk_marshal_VOID__OBJECT,
 511                   G_TYPE_NONE, 1,
 512                   GTK_TYPE_WIDGET);
 513
 514   g_type_class_add_private (class, sizeof (GtkContainerPrivate));
 515
 516   gtk_widget_class_set_accessible_type (widget_class, GTK_TYPE_CONTAINER_ACCESSIBLE);
 517 }
 518
 519 static void
 520 gtk_container_buildable_init (GtkBuildableIface *iface)
 521 {
 522   parent_buildable_iface = g_type_interface_peek_parent (iface);
 523   iface->add_child = gtk_container_buildable_add_child;
 524   iface->custom_tag_start = gtk_container_buildable_custom_tag_start;
 525   iface->custom_tag_end = gtk_container_buildable_custom_tag_end;
 526 }
 527
 528 static void
 529 gtk_container_buildable_add_child (GtkBuildable  *buildable,
 530                                    GtkBuilder    *builder,
 531                                    GObject       *child,
 532                                    const gchar   *type)
 533 {
 534   if (type)
 535     {
 536       GTK_BUILDER_WARN_INVALID_CHILD_TYPE (buildable, type);
 537     }
 538   else if (GTK_IS_WIDGET (child) &&
 539            gtk_widget_get_parent (GTK_WIDGET (child)) == NULL)
 540     {
 541       gtk_container_add (GTK_CONTAINER (buildable), GTK_WIDGET (child));
 542     }
 543   else
 544     g_warning ("Cannot add an object of type %s to a container of type %s",
 545                g_type_name (G_OBJECT_TYPE (child)), g_type_name (G_OBJECT_TYPE (buildable)));
 546 }
 547
 548 static void
 549 gtk_container_buildable_set_child_property (GtkContainer *container,
 550                                             GtkBuilder   *builder,
 551                                             GtkWidget    *child,
 552                                             gchar        *name,
 553                                             const gchar  *value)
 554 {
 555   GParamSpec *pspec;
 556   GValue gvalue = { 0, };
 557   GError *error = NULL;
 558
 559   pspec = gtk_container_class_find_child_property
 560     (G_OBJECT_GET_CLASS (container), name);
 561   if (!pspec)
 562     {
 563       g_warning ("%s does not have a property called %s",
 564                  g_type_name (G_OBJECT_TYPE (container)), name);
 565       return;
 566     }
 567
 568   if (!gtk_builder_value_from_string (builder, pspec, value, &gvalue, &error))
 569     {
 570       g_warning ("Could not read property %s:%s with value %s of type %s: %s",
 571                  g_type_name (G_OBJECT_TYPE (container)),
 572                  name,
 573                  value,
 574                  g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
 575                  error->message);
 576       g_error_free (error);
 577       return;
 578     }
 579
 580   gtk_container_child_set_property (container, child, name, &gvalue);
 581   g_value_unset (&gvalue);
 582 }
 583
 584 typedef struct {
 585   GtkBuilder   *builder;
 586   GtkContainer *container;
 587   GtkWidget    *child;
 588   GString      *string;
 589   gchar        *child_prop_name;
 590   gchar        *context;
 591   gboolean      translatable;
 592 } PackingPropertiesData;
 593
 594 static void
 595 attributes_start_element (GMarkupParseContext *context,
 596                           const gchar         *element_name,
 597                           const gchar        **names,
 598                           const gchar        **values,
 599                           gpointer             user_data,
 600                           GError             **error)
 601 {
 602   PackingPropertiesData *parser_data = (PackingPropertiesData*)user_data;
 603   guint i;
 604
 605   if (strcmp (element_name, "property") == 0)
 606     {
 607       for (i = 0; names[i]; i++)
 608         if (strcmp (names[i], "name") == 0)
 609           parser_data->child_prop_name = g_strdup (values[i]);
 610         else if (strcmp (names[i], "translatable") == 0)
 611           {
 612             if (!_gtk_builder_boolean_from_string (values[1],
 613                                                    &parser_data->translatable,
 614                                                    error))
 615               return;
 616           }
 617         else if (strcmp (names[i], "comments") == 0)
 618           ; /* for translators */
 619         else if (strcmp (names[i], "context") == 0)
 620           parser_data->context = g_strdup (values[1]);
 621         else
 622           g_warning ("Unsupported attribute for GtkContainer Child "
 623                      "property: %s\n", names[i]);
 624     }
 625   else if (strcmp (element_name, "packing") == 0)
 626     return;
 627   else
 628     g_warning ("Unsupported tag for GtkContainer: %s\n", element_name);
 629 }
 630
 631 static void
 632 attributes_text_element (GMarkupParseContext *context,
 633                          const gchar         *text,
 634                          gsize                text_len,
 635                          gpointer             user_data,
 636                          GError             **error)
 637 {
 638   PackingPropertiesData *parser_data = (PackingPropertiesData*)user_data;
 639
 640   if (parser_data->child_prop_name)
 641     g_string_append_len (parser_data->string, text, text_len);
 642 }
 643
 644 static void
 645 attributes_end_element (GMarkupParseContext *context,
 646                         const gchar         *element_name,
 647                         gpointer             user_data,
 648                         GError             **error)
 649 {
 650   PackingPropertiesData *parser_data = (PackingPropertiesData*)user_data;
 651
 652   /* translate the string */
 653   if (parser_data->string->len && parser_data->translatable)
 654     {
 655       gchar *translated;
 656       const gchar* domain;
 657
 658       domain = gtk_builder_get_translation_domain (parser_data->builder);
 659
 660       translated = _gtk_builder_parser_translate (domain,
 661                                                   parser_data->context,
 662                                                   parser_data->string->str);
 663       g_string_set_size (parser_data->string, 0);
 664       g_string_append (parser_data->string, translated);
 665     }
 666
 667   if (parser_data->child_prop_name)
 668     gtk_container_buildable_set_child_property (parser_data->container,
 669                                                 parser_data->builder,
 670                                                 parser_data->child,
 671                                                 parser_data->child_prop_name,
 672                                                 parser_data->string->str);
 673
 674   g_string_set_size (parser_data->string, 0);
 675   g_free (parser_data->child_prop_name);
 676   g_free (parser_data->context);
 677   parser_data->child_prop_name = NULL;
 678   parser_data->context = NULL;
 679   parser_data->translatable = FALSE;
 680 }
 681
 682 static const GMarkupParser attributes_parser =
 683   {
 684     attributes_start_element,
 685     attributes_end_element,
 686     attributes_text_element,
 687   };
 688
 689 static gboolean
 690 gtk_container_buildable_custom_tag_start (GtkBuildable  *buildable,
 691                                           GtkBuilder    *builder,
 692                                           GObject       *child,
 693                                           const gchar   *tagname,
 694                                           GMarkupParser *parser,
 695                                           gpointer      *data)
 696 {
 697   PackingPropertiesData *parser_data;
 698
 699   if (parent_buildable_iface->custom_tag_start (buildable, builder, child,
 700                                                 tagname, parser, data))
 701     return TRUE;
 702
 703   if (child && strcmp (tagname, "packing") == 0)
 704     {
 705       parser_data = g_slice_new0 (PackingPropertiesData);
 706       parser_data->string = g_string_new ("");
 707       parser_data->builder = builder;
 708       parser_data->container = GTK_CONTAINER (buildable);
 709       parser_data->child = GTK_WIDGET (child);
 710       parser_data->child_prop_name = NULL;
 711
 712       *parser = attributes_parser;
 713       *data = parser_data;
 714       return TRUE;
 715     }
 716
 717   return FALSE;
 718 }
 719
 720 static void
 721 gtk_container_buildable_custom_tag_end (GtkBuildable *buildable,
 722                                         GtkBuilder   *builder,
 723                                         GObject      *child,
 724                                         const gchar  *tagname,
 725                                         gpointer     *data)
 726 {
 727   if (strcmp (tagname, "packing") == 0)
 728     {
 729       PackingPropertiesData *parser_data = (PackingPropertiesData*)data;
 730       g_string_free (parser_data->string, TRUE);
 731       g_slice_free (PackingPropertiesData, parser_data);
 732       return;
 733     }
 734
 735   if (parent_buildable_iface->custom_tag_end)
 736     parent_buildable_iface->custom_tag_end (buildable, builder,
 737                                             child, tagname, data);
 738 }
 739
 740 /**
 741  * gtk_container_child_type:
 742  * @container: a #GtkContainer
 743  *
 744  * Returns the type of the children supported by the container.
 745  *
 746  * Note that this may return %G_TYPE_NONE to indicate that no more
 747  * children can be added, e.g. for a #GtkPaned which already has two
 748  * children.
 749  *
 750  * Return value: a #GType.
 751  **/
 752 GType
 753 gtk_container_child_type (GtkContainer *container)
 754 {
 755   GType slot;
 756   GtkContainerClass *class;
 757
 758   g_return_val_if_fail (GTK_IS_CONTAINER (container), 0);
 759
 760   class = GTK_CONTAINER_GET_CLASS (container);
 761   if (class->child_type)
 762     slot = class->child_type (container);
 763   else
 764     slot = G_TYPE_NONE;
 765
 766   return slot;
 767 }
 768
 769 /* --- GtkContainer child property mechanism --- */
 770
 771 /**
 772  * gtk_container_child_notify:
 773  * @container: the #GtkContainer
 774  * @child: the child widget
 775  * @child_property: the name of a child property installed on
 776  *     the class of @container
 777  *
 778  * Emits a #GtkWidget::child-notify signal for the
 779  * <link linkend="child-properties">child property</link>
 780  * @child_property on widget.
 781  *
 782  * This is an analogue of g_object_notify() for child properties.
 783  *
 784  * Also see gtk_widget_child_notify().
 785  *
 786  * Since: 3.2
 787  */
 788 void
 789 gtk_container_child_notify (GtkContainer *container,
 790                             GtkWidget    *child,
 791                             const gchar  *child_property)
 792 {
 793   GObject *obj;
 794   GParamSpec *pspec;
 795
 796   g_return_if_fail (GTK_IS_CONTAINER (container));
 797   g_return_if_fail (GTK_IS_WIDGET (child));
 798   g_return_if_fail (child_property != NULL);
 799
 800   obj = G_OBJECT (child);
 801
 802   if (obj->ref_count == 0)
 803     return;
 804
 805   g_object_ref (obj);
 806
 807   pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
 808                                     child_property,
 809                                     G_OBJECT_TYPE (container),
 810                                     TRUE);
 811
 812   if (pspec == NULL)
 813     {
 814       g_warning ("%s: container class `%s' has no child property named `%s'",
 815                  G_STRLOC,
 816                  G_OBJECT_TYPE_NAME (container),
 817                  child_property);
 818     }
 819   else
 820     {
 821       GObjectNotifyQueue *nqueue;
 822
 823       nqueue = g_object_notify_queue_freeze (obj, _gtk_widget_child_property_notify_context);
 824
 825       g_object_notify_queue_add (obj, nqueue, pspec);
 826       g_object_notify_queue_thaw (obj, nqueue);
 827     }
 828
 829   g_object_unref (obj);
 830 }
 831
 832 static inline void
 833 container_get_child_property (GtkContainer *container,
 834                               GtkWidget    *child,
 835                               GParamSpec   *pspec,
 836                               GValue       *value)
 837 {
 838   GtkContainerClass *class = g_type_class_peek (pspec->owner_type);
 839
 840   class->get_child_property (container, child, PARAM_SPEC_PARAM_ID (pspec), value, pspec);
 841 }
 842
 843 static inline void
 844 container_set_child_property (GtkContainer       *container,
 845                               GtkWidget          *child,
 846                               GParamSpec         *pspec,
 847                               const GValue       *value,
 848                               GObjectNotifyQueue *nqueue)
 849 {
 850   GValue tmp_value = { 0, };
 851   GtkContainerClass *class = g_type_class_peek (pspec->owner_type);
 852
 853   /* provide a copy to work from, convert (if necessary) and validate */
 854   g_value_init (&tmp_value, G_PARAM_SPEC_VALUE_TYPE (pspec));
 855   if (!g_value_transform (value, &tmp_value))
 856     g_warning ("unable to set child property `%s' of type `%s' from value of type `%s'",
 857                pspec->name,
 858                g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
 859                G_VALUE_TYPE_NAME (value));
 860   else if (g_param_value_validate (pspec, &tmp_value) && !(pspec->flags & G_PARAM_LAX_VALIDATION))
 861     {
 862       gchar *contents = g_strdup_value_contents (value);
 863
 864       g_warning ("value \"%s\" of type `%s' is invalid for property `%s' of type `%s'",
 865                  contents,
 866                  G_VALUE_TYPE_NAME (value),
 867                  pspec->name,
 868                  g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)));
 869       g_free (contents);
 870     }
 871   else
 872     {
 873       class->set_child_property (container, child, PARAM_SPEC_PARAM_ID (pspec), &tmp_value, pspec);
 874       g_object_notify_queue_add (G_OBJECT (child), nqueue, pspec);
 875     }
 876   g_value_unset (&tmp_value);
 877 }
 878
 879 /**
 880  * gtk_container_child_get_valist:
 881  * @container: a #GtkContainer
 882  * @child: a widget which is a child of @container
 883  * @first_property_name: the name of the first property to get
 884  * @var_args: return location for the first property, followed
 885  *     optionally by more name/return location pairs, followed by %NULL
 886  *
 887  * Gets the values of one or more child properties for @child and @container.
 888  **/
 889 void
 890 gtk_container_child_get_valist (GtkContainer *container,
 891                                 GtkWidget    *child,
 892                                 const gchar  *first_property_name,
 893                                 va_list       var_args)
 894 {
 895   const gchar *name;
 896
 897   g_return_if_fail (GTK_IS_CONTAINER (container));
 898   g_return_if_fail (GTK_IS_WIDGET (child));
 899
 900   g_object_ref (container);
 901   g_object_ref (child);
 902
 903   name = first_property_name;
 904   while (name)
 905     {
 906       GValue value = { 0, };
 907       GParamSpec *pspec;
 908       gchar *error;
 909
 910       pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
 911                                         name,
 912                                         G_OBJECT_TYPE (container),
 913                                         TRUE);
 914       if (!pspec)
 915         {
 916           g_warning ("%s: container class `%s' has no child property named `%s'",
 917                      G_STRLOC,
 918                      G_OBJECT_TYPE_NAME (container),
 919                      name);
 920           break;
 921         }
 922       if (!(pspec->flags & G_PARAM_READABLE))
 923         {
 924           g_warning ("%s: child property `%s' of container class `%s' is not readable",
 925                      G_STRLOC,
 926                      pspec->name,
 927                      G_OBJECT_TYPE_NAME (container));
 928           break;
 929         }
 930       g_value_init (&value, G_PARAM_SPEC_VALUE_TYPE (pspec));
 931       container_get_child_property (container, child, pspec, &value);
 932       G_VALUE_LCOPY (&value, var_args, 0, &error);
 933       if (error)
 934         {
 935           g_warning ("%s: %s", G_STRLOC, error);
 936           g_free (error);
 937           g_value_unset (&value);
 938           break;
 939         }
 940       g_value_unset (&value);
 941       name = va_arg (var_args, gchar*);
 942     }
 943
 944   g_object_unref (child);
 945   g_object_unref (container);
 946 }
 947
 948 /**
 949  * gtk_container_child_get_property:
 950  * @container: a #GtkContainer
 951  * @child: a widget which is a child of @container
 952  * @property_name: the name of the property to get
 953  * @value: a location to return the value
 954  *
 955  * Gets the value of a child property for @child and @container.
 956  **/
 957 void
 958 gtk_container_child_get_property (GtkContainer *container,
 959                                   GtkWidget    *child,
 960                                   const gchar  *property_name,
 961                                   GValue       *value)
 962 {
 963   GParamSpec *pspec;
 964
 965   g_return_if_fail (GTK_IS_CONTAINER (container));
 966   g_return_if_fail (GTK_IS_WIDGET (child));
 967   g_return_if_fail (property_name != NULL);
 968   g_return_if_fail (G_IS_VALUE (value));
 969
 970   g_object_ref (container);
 971   g_object_ref (child);
 972   pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool, property_name,
 973                                     G_OBJECT_TYPE (container), TRUE);
 974   if (!pspec)
 975     g_warning ("%s: container class `%s' has no child property named `%s'",
 976                G_STRLOC,
 977                G_OBJECT_TYPE_NAME (container),
 978                property_name);
 979   else if (!(pspec->flags & G_PARAM_READABLE))
 980     g_warning ("%s: child property `%s' of container class `%s' is not readable",
 981                G_STRLOC,
 982                pspec->name,
 983                G_OBJECT_TYPE_NAME (container));
 984   else
 985     {
 986       GValue *prop_value, tmp_value = { 0, };
 987
 988       /* auto-conversion of the callers value type
 989        */
 990       if (G_VALUE_TYPE (value) == G_PARAM_SPEC_VALUE_TYPE (pspec))
 991         {
 992           g_value_reset (value);
 993           prop_value = value;
 994         }
 995       else if (!g_value_type_transformable (G_PARAM_SPEC_VALUE_TYPE (pspec), G_VALUE_TYPE (value)))
 996         {
 997           g_warning ("can't retrieve child property `%s' of type `%s' as value of type `%s'",
 998                      pspec->name,
 999                      g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
1000                      G_VALUE_TYPE_NAME (value));
1001           g_object_unref (child);
1002           g_object_unref (container);
1003           return;
1004         }
1005       else
1006         {
1007           g_value_init (&tmp_value, G_PARAM_SPEC_VALUE_TYPE (pspec));
1008           prop_value = &tmp_value;
1009         }
1010       container_get_child_property (container, child, pspec, prop_value);
1011       if (prop_value != value)
1012         {
1013           g_value_transform (prop_value, value);
1014           g_value_unset (&tmp_value);
1015         }
1016     }
1017   g_object_unref (child);
1018   g_object_unref (container);
1019 }
1020
1021 /**
1022  * gtk_container_child_set_valist:
1023  * @container: a #GtkContainer
1024  * @child: a widget which is a child of @container
1025  * @first_property_name: the name of the first property to set
1026  * @var_args: a %NULL-terminated list of property names and values, starting
1027  *           with @first_prop_name
1028  *
1029  * Sets one or more child properties for @child and @container.
1030  **/
1031 void
1032 gtk_container_child_set_valist (GtkContainer *container,
1033                                 GtkWidget    *child,
1034                                 const gchar  *first_property_name,
1035                                 va_list       var_args)
1036 {
1037   GObjectNotifyQueue *nqueue;
1038   const gchar *name;
1039
1040   g_return_if_fail (GTK_IS_CONTAINER (container));
1041   g_return_if_fail (GTK_IS_WIDGET (child));
1042
1043   g_object_ref (container);
1044   g_object_ref (child);
1045
1046   nqueue = g_object_notify_queue_freeze (G_OBJECT (child), _gtk_widget_child_property_notify_context);
1047   name = first_property_name;
1048   while (name)
1049     {
1050       GValue value = { 0, };
1051       gchar *error = NULL;
1052       GParamSpec *pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
1053                                                     name,
1054                                                     G_OBJECT_TYPE (container),
1055                                                     TRUE);
1056       if (!pspec)
1057         {
1058           g_warning ("%s: container class `%s' has no child property named `%s'",
1059                      G_STRLOC,
1060                      G_OBJECT_TYPE_NAME (container),
1061                      name);
1062           break;
1063         }
1064       if (!(pspec->flags & G_PARAM_WRITABLE))
1065         {
1066           g_warning ("%s: child property `%s' of container class `%s' is not writable",
1067                      G_STRLOC,
1068                      pspec->name,
1069                      G_OBJECT_TYPE_NAME (container));
1070           break;
1071         }
1072
1073       G_VALUE_COLLECT_INIT (&value, G_PARAM_SPEC_VALUE_TYPE (pspec),
1074                             var_args, 0, &error);
1075       if (error)
1076         {
1077           g_warning ("%s: %s", G_STRLOC, error);
1078           g_free (error);
1079
1080           /* we purposely leak the value here, it might not be
1081            * in a sane state if an error condition occoured
1082            */
1083           break;
1084         }
1085       container_set_child_property (container, child, pspec, &value, nqueue);
1086       g_value_unset (&value);
1087       name = va_arg (var_args, gchar*);
1088     }
1089   g_object_notify_queue_thaw (G_OBJECT (child), nqueue);
1090
1091   g_object_unref (container);
1092   g_object_unref (child);
1093 }
1094
1095 /**
1096  * gtk_container_child_set_property:
1097  * @container: a #GtkContainer
1098  * @child: a widget which is a child of @container
1099  * @property_name: the name of the property to set
1100  * @value: the value to set the property to
1101  *
1102  * Sets a child property for @child and @container.
1103  **/
1104 void
1105 gtk_container_child_set_property (GtkContainer *container,
1106                                   GtkWidget    *child,
1107                                   const gchar  *property_name,
1108                                   const GValue *value)
1109 {
1110   GObjectNotifyQueue *nqueue;
1111   GParamSpec *pspec;
1112
1113   g_return_if_fail (GTK_IS_CONTAINER (container));
1114   g_return_if_fail (GTK_IS_WIDGET (child));
1115   g_return_if_fail (property_name != NULL);
1116   g_return_if_fail (G_IS_VALUE (value));
1117
1118   g_object_ref (container);
1119   g_object_ref (child);
1120
1121   nqueue = g_object_notify_queue_freeze (G_OBJECT (child), _gtk_widget_child_property_notify_context);
1122   pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool, property_name,
1123                                     G_OBJECT_TYPE (container), TRUE);
1124   if (!pspec)
1125     g_warning ("%s: container class `%s' has no child property named `%s'",
1126                G_STRLOC,
1127                G_OBJECT_TYPE_NAME (container),
1128                property_name);
1129   else if (!(pspec->flags & G_PARAM_WRITABLE))
1130     g_warning ("%s: child property `%s' of container class `%s' is not writable",
1131                G_STRLOC,
1132                pspec->name,
1133                G_OBJECT_TYPE_NAME (container));
1134   else
1135     {
1136       container_set_child_property (container, child, pspec, value, nqueue);
1137     }
1138   g_object_notify_queue_thaw (G_OBJECT (child), nqueue);
1139   g_object_unref (container);
1140   g_object_unref (child);
1141 }
1142
1143 /**
1144  * gtk_container_add_with_properties:
1145  * @container: a #GtkContainer
1146  * @widget: a widget to be placed inside @container
1147  * @first_prop_name: the name of the first child property to set
1148  * @Varargs: a %NULL-terminated list of property names and values, starting
1149  *           with @first_prop_name
1150  *
1151  * Adds @widget to @container, setting child properties at the same time.
1152  * See gtk_container_add() and gtk_container_child_set() for more details.
1153  */
1154 void
1155 gtk_container_add_with_properties (GtkContainer *container,
1156                                    GtkWidget    *widget,
1157                                    const gchar  *first_prop_name,
1158                                    ...)
1159 {
1160   g_return_if_fail (GTK_IS_CONTAINER (container));
1161   g_return_if_fail (GTK_IS_WIDGET (widget));
1162   g_return_if_fail (gtk_widget_get_parent (widget) == NULL);
1163
1164   g_object_ref (container);
1165   g_object_ref (widget);
1166   gtk_widget_freeze_child_notify (widget);
1167
1168   g_signal_emit (container, container_signals[ADD], 0, widget);
1169   if (gtk_widget_get_parent (widget))
1170     {
1171       va_list var_args;
1172
1173       va_start (var_args, first_prop_name);
1174       gtk_container_child_set_valist (container, widget, first_prop_name, var_args);
1175       va_end (var_args);
1176     }
1177
1178   gtk_widget_thaw_child_notify (widget);
1179   g_object_unref (widget);
1180   g_object_unref (container);
1181 }
1182
1183 /**
1184  * gtk_container_child_set:
1185  * @container: a #GtkContainer
1186  * @child: a widget which is a child of @container
1187  * @first_prop_name: the name of the first property to set
1188  * @Varargs: a %NULL-terminated list of property names and values, starting
1189  *           with @first_prop_name
1190  *
1191  * Sets one or more child properties for @child and @container.
1192  */
1193 void
1194 gtk_container_child_set (GtkContainer      *container,
1195                          GtkWidget         *child,
1196                          const gchar       *first_prop_name,
1197                          ...)
1198 {
1199   va_list var_args;
1200
1201   va_start (var_args, first_prop_name);
1202   gtk_container_child_set_valist (container, child, first_prop_name, var_args);
1203   va_end (var_args);
1204 }
1205
1206 /**
1207  * gtk_container_child_get:
1208  * @container: a #GtkContainer
1209  * @child: a widget which is a child of @container
1210  * @first_prop_name: the name of the first property to get
1211  * @Varargs: return location for the first property, followed
1212  *     optionally by more name/return location pairs, followed by %NULL
1213  *
1214  * Gets the values of one or more child properties for @child and @container.
1215  **/
1216 void
1217 gtk_container_child_get (GtkContainer      *container,
1218                          GtkWidget         *child,
1219                          const gchar       *first_prop_name,
1220                          ...)
1221 {
1222   va_list var_args;
1223
1224   va_start (var_args, first_prop_name);
1225   gtk_container_child_get_valist (container, child, first_prop_name, var_args);
1226   va_end (var_args);
1227 }
1228
1229 /**
1230  * gtk_container_class_install_child_property:
1231  * @cclass: a #GtkContainerClass
1232  * @property_id: the id for the property
1233  * @pspec: the #GParamSpec for the property
1234  *
1235  * Installs a child property on a container class.
1236  **/
1237 void
1238 gtk_container_class_install_child_property (GtkContainerClass *cclass,
1239                                             guint              property_id,
1240                                             GParamSpec        *pspec)
1241 {
1242   g_return_if_fail (GTK_IS_CONTAINER_CLASS (cclass));
1243   g_return_if_fail (G_IS_PARAM_SPEC (pspec));
1244   if (pspec->flags & G_PARAM_WRITABLE)
1245     g_return_if_fail (cclass->set_child_property != NULL);
1246   if (pspec->flags & G_PARAM_READABLE)
1247     g_return_if_fail (cclass->get_child_property != NULL);
1248   g_return_if_fail (property_id > 0);
1249   g_return_if_fail (PARAM_SPEC_PARAM_ID (pspec) == 0);  /* paranoid */
1250   if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
1251     g_return_if_fail ((pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY)) == 0);
1252
1253   if (g_param_spec_pool_lookup (_gtk_widget_child_property_pool, pspec->name, G_OBJECT_CLASS_TYPE (cclass), FALSE))
1254     {
1255       g_warning (G_STRLOC ": class `%s' already contains a child property named `%s'",
1256                  G_OBJECT_CLASS_NAME (cclass),
1257                  pspec->name);
1258       return;
1259     }
1260   g_param_spec_ref (pspec);
1261   g_param_spec_sink (pspec);
1262   PARAM_SPEC_SET_PARAM_ID (pspec, property_id);
1263   g_param_spec_pool_insert (_gtk_widget_child_property_pool, pspec, G_OBJECT_CLASS_TYPE (cclass));
1264 }
1265
1266 /**
1267  * gtk_container_class_find_child_property:
1268  * @cclass: (type GtkContainerClass): a #GtkContainerClass
1269  * @property_name: the name of the child property to find
1270  * @returns: (transfer none): the #GParamSpec of the child property or
1271  *           %NULL if @class has no child property with that name.
1272  *
1273  * Finds a child property of a container class by name.
1274  */
1275 GParamSpec*
1276 gtk_container_class_find_child_property (GObjectClass *cclass,
1277                                          const gchar  *property_name)
1278 {
1279   g_return_val_if_fail (GTK_IS_CONTAINER_CLASS (cclass), NULL);
1280   g_return_val_if_fail (property_name != NULL, NULL);
1281
1282   return g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
1283                                    property_name,
1284                                    G_OBJECT_CLASS_TYPE (cclass),
1285                                    TRUE);
1286 }
1287
1288 /**
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
1292  * @returns: (array length=n_properties) (transfer container): a newly
1293  *           allocated %NULL-terminated array of #GParamSpec*.  The
1294  *           array must be freed with g_free().
1295  *
1296  * Returns all child properties of a container class.
1297  */
1298 GParamSpec**
1299 gtk_container_class_list_child_properties (GObjectClass *cclass,
1300                                            guint        *n_properties)
1301 {
1302   GParamSpec **pspecs;
1303   guint n;
1304
1305   g_return_val_if_fail (GTK_IS_CONTAINER_CLASS (cclass), NULL);
1306
1307   pspecs = g_param_spec_pool_list (_gtk_widget_child_property_pool,
1308                                    G_OBJECT_CLASS_TYPE (cclass),
1309                                    &n);
1310   if (n_properties)
1311     *n_properties = n;
1312
1313   return pspecs;
1314 }
1315
1316 static void
1317 gtk_container_add_unimplemented (GtkContainer     *container,
1318                                  GtkWidget        *widget)
1319 {
1320   g_warning ("GtkContainerClass::add not implemented for `%s'", g_type_name (G_TYPE_FROM_INSTANCE (container)));
1321 }
1322
1323 static void
1324 gtk_container_remove_unimplemented (GtkContainer     *container,
1325                                     GtkWidget        *widget)
1326 {
1327   g_warning ("GtkContainerClass::remove not implemented for `%s'", g_type_name (G_TYPE_FROM_INSTANCE (container)));
1328 }
1329
1330 static void
1331 gtk_container_init (GtkContainer *container)
1332 {
1333   GtkContainerPrivate *priv;
1334
1335   container->priv = G_TYPE_INSTANCE_GET_PRIVATE (container,
1336                                                  GTK_TYPE_CONTAINER,
1337                                                  GtkContainerPrivate);
1338   priv = container->priv;
1339
1340   priv->focus_child = NULL;
1341   priv->border_width = 0;
1342   priv->need_resize = FALSE;
1343   priv->resize_mode = GTK_RESIZE_PARENT;
1344   priv->reallocate_redraws = FALSE;
1345 }
1346
1347 static void
1348 gtk_container_destroy (GtkWidget *widget)
1349 {
1350   GtkContainer *container = GTK_CONTAINER (widget);
1351   GtkContainerPrivate *priv = container->priv;
1352
1353   if (_gtk_widget_get_resize_pending (GTK_WIDGET (container)))
1354     _gtk_container_dequeue_resize_handler (container);
1355
1356   if (priv->focus_child)
1357     {
1358       g_object_unref (priv->focus_child);
1359       priv->focus_child = NULL;
1360     }
1361
1362   /* do this before walking child widgets, to avoid
1363    * removing children from focus chain one by one.
1364    */
1365   if (priv->has_focus_chain)
1366     gtk_container_unset_focus_chain (container);
1367
1368   gtk_container_foreach (container, (GtkCallback) gtk_widget_destroy, NULL);
1369
1370   GTK_WIDGET_CLASS (parent_class)->destroy (widget);
1371 }
1372
1373 static void
1374 gtk_container_set_property (GObject         *object,
1375                             guint            prop_id,
1376                             const GValue    *value,
1377                             GParamSpec      *pspec)
1378 {
1379   GtkContainer *container = GTK_CONTAINER (object);
1380
1381   switch (prop_id)
1382     {
1383     case PROP_BORDER_WIDTH:
1384       gtk_container_set_border_width (container, g_value_get_uint (value));
1385       break;
1386     case PROP_RESIZE_MODE:
1387       gtk_container_set_resize_mode (container, g_value_get_enum (value));
1388       break;
1389     case PROP_CHILD:
1390       gtk_container_add (container, GTK_WIDGET (g_value_get_object (value)));
1391       break;
1392     default:
1393       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1394       break;
1395     }
1396 }
1397
1398 static void
1399 gtk_container_get_property (GObject         *object,
1400                             guint            prop_id,
1401                             GValue          *value,
1402                             GParamSpec      *pspec)
1403 {
1404   GtkContainer *container = GTK_CONTAINER (object);
1405   GtkContainerPrivate *priv = container->priv;
1406
1407   switch (prop_id)
1408     {
1409     case PROP_BORDER_WIDTH:
1410       g_value_set_uint (value, priv->border_width);
1411       break;
1412     case PROP_RESIZE_MODE:
1413       g_value_set_enum (value, priv->resize_mode);
1414       break;
1415     default:
1416       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1417       break;
1418     }
1419 }
1420
1421 /**
1422  * gtk_container_set_border_width:
1423  * @container: a #GtkContainer
1424  * @border_width: amount of blank space to leave <emphasis>outside</emphasis>
1425  *   the container. Valid values are in the range 0-65535 pixels.
1426  *
1427  * Sets the border width of the container.
1428  *
1429  * The border width of a container is the amount of space to leave
1430  * around the outside of the container. The only exception to this is
1431  * #GtkWindow; because toplevel windows can't leave space outside,
1432  * they leave the space inside. The border is added on all sides of
1433  * the container. To add space to only one side, one approach is to
1434  * create a #GtkAlignment widget, call gtk_widget_set_size_request()
1435  * to give it a size, and place it on the side of the container as
1436  * a spacer.
1437  **/
1438 void
1439 gtk_container_set_border_width (GtkContainer *container,
1440                                 guint         border_width)
1441 {
1442   GtkContainerPrivate *priv;
1443
1444   g_return_if_fail (GTK_IS_CONTAINER (container));
1445
1446   priv = container->priv;
1447
1448   if (priv->border_width != border_width)
1449     {
1450       priv->border_width = border_width;
1451       g_object_notify (G_OBJECT (container), "border-width");
1452
1453       if (gtk_widget_get_realized (GTK_WIDGET (container)))
1454         gtk_widget_queue_resize (GTK_WIDGET (container));
1455     }
1456 }
1457
1458 /**
1459  * gtk_container_get_border_width:
1460  * @container: a #GtkContainer
1461  *
1462  * Retrieves the border width of the container. See
1463  * gtk_container_set_border_width().
1464  *
1465  * Return value: the current border width
1466  **/
1467 guint
1468 gtk_container_get_border_width (GtkContainer *container)
1469 {
1470   g_return_val_if_fail (GTK_IS_CONTAINER (container), 0);
1471
1472   return container->priv->border_width;
1473 }
1474
1475 /**
1476  * gtk_container_add:
1477  * @container: a #GtkContainer
1478  * @widget: a widget to be placed inside @container
1479  *
1480  * Adds @widget to @container. Typically used for simple containers
1481  * such as #GtkWindow, #GtkFrame, or #GtkButton; for more complicated
1482  * layout containers such as #GtkBox or #GtkTable, this function will
1483  * pick default packing parameters that may not be correct.  So
1484  * consider functions such as gtk_box_pack_start() and
1485  * gtk_table_attach() as an alternative to gtk_container_add() in
1486  * those cases. A widget may be added to only one container at a time;
1487  * you can't place the same widget inside two different containers.
1488  **/
1489 void
1490 gtk_container_add (GtkContainer *container,
1491                    GtkWidget    *widget)
1492 {
1493   GtkWidget *parent;
1494
1495   g_return_if_fail (GTK_IS_CONTAINER (container));
1496   g_return_if_fail (GTK_IS_WIDGET (widget));
1497
1498   parent = gtk_widget_get_parent (widget);
1499
1500   if (parent != NULL)
1501     {
1502       g_warning ("Attempting to add a widget with type %s to a container of "
1503                  "type %s, but the widget is already inside a container of type %s, "
1504                  "please use gtk_widget_reparent()" ,
1505                  g_type_name (G_OBJECT_TYPE (widget)),
1506                  g_type_name (G_OBJECT_TYPE (container)),
1507                  g_type_name (G_OBJECT_TYPE (parent)));
1508       return;
1509     }
1510
1511   g_signal_emit (container, container_signals[ADD], 0, widget);
1512 }
1513
1514 /**
1515  * gtk_container_remove:
1516  * @container: a #GtkContainer
1517  * @widget: a current child of @container
1518  *
1519  * Removes @widget from @container. @widget must be inside @container.
1520  * Note that @container will own a reference to @widget, and that this
1521  * may be the last reference held; so removing a widget from its
1522  * container can destroy that widget. If you want to use @widget
1523  * again, you need to add a reference to it while it's not inside
1524  * a container, using g_object_ref(). If you don't want to use @widget
1525  * again it's usually more efficient to simply destroy it directly
1526  * using gtk_widget_destroy() since this will remove it from the
1527  * container and help break any circular reference count cycles.
1528  **/
1529 void
1530 gtk_container_remove (GtkContainer *container,
1531                       GtkWidget    *widget)
1532 {
1533   g_return_if_fail (GTK_IS_CONTAINER (container));
1534   g_return_if_fail (GTK_IS_WIDGET (widget));
1535   g_return_if_fail (gtk_widget_get_parent (widget) == GTK_WIDGET (container));
1536
1537   g_signal_emit (container, container_signals[REMOVE], 0, widget);
1538 }
1539
1540 void
1541 _gtk_container_dequeue_resize_handler (GtkContainer *container)
1542 {
1543   g_return_if_fail (GTK_IS_CONTAINER (container));
1544   g_return_if_fail (_gtk_widget_get_resize_pending (GTK_WIDGET (container)));
1545
1546   container_resize_queue = g_slist_remove (container_resize_queue, container);
1547   _gtk_widget_set_resize_pending (GTK_WIDGET (container), FALSE);
1548 }
1549
1550 /**
1551  * gtk_container_set_resize_mode:
1552  * @container: a #GtkContainer
1553  * @resize_mode: the new resize mode
1554  *
1555  * Sets the resize mode for the container.
1556  *
1557  * The resize mode of a container determines whether a resize request
1558  * will be passed to the container's parent, queued for later execution
1559  * or executed immediately.
1560  **/
1561 void
1562 gtk_container_set_resize_mode (GtkContainer  *container,
1563                                GtkResizeMode  resize_mode)
1564 {
1565   GtkContainerPrivate *priv;
1566
1567   g_return_if_fail (GTK_IS_CONTAINER (container));
1568   g_return_if_fail (resize_mode <= GTK_RESIZE_IMMEDIATE);
1569
1570   priv = container->priv;
1571
1572   if (gtk_widget_is_toplevel (GTK_WIDGET (container)) &&
1573       resize_mode == GTK_RESIZE_PARENT)
1574     {
1575       resize_mode = GTK_RESIZE_QUEUE;
1576     }
1577
1578   if (priv->resize_mode != resize_mode)
1579     {
1580       priv->resize_mode = resize_mode;
1581
1582       gtk_widget_queue_resize (GTK_WIDGET (container));
1583       g_object_notify (G_OBJECT (container), "resize-mode");
1584     }
1585 }
1586
1587 /**
1588  * gtk_container_get_resize_mode:
1589  * @container: a #GtkContainer
1590  *
1591  * Returns the resize mode for the container. See
1592  * gtk_container_set_resize_mode ().
1593  *
1594  * Return value: the current resize mode
1595  **/
1596 GtkResizeMode
1597 gtk_container_get_resize_mode (GtkContainer *container)
1598 {
1599   g_return_val_if_fail (GTK_IS_CONTAINER (container), GTK_RESIZE_PARENT);
1600
1601   return container->priv->resize_mode;
1602 }
1603
1604 /**
1605  * gtk_container_set_reallocate_redraws:
1606  * @container: a #GtkContainer
1607  * @needs_redraws: the new value for the container's @reallocate_redraws flag
1608  *
1609  * Sets the @reallocate_redraws flag of the container to the given value.
1610  *
1611  * Containers requesting reallocation redraws get automatically
1612  * redrawn if any of their children changed allocation.
1613  **/
1614 void
1615 gtk_container_set_reallocate_redraws (GtkContainer *container,
1616                                       gboolean      needs_redraws)
1617 {
1618   g_return_if_fail (GTK_IS_CONTAINER (container));
1619
1620   container->priv->reallocate_redraws = needs_redraws ? TRUE : FALSE;
1621 }
1622
1623 static GtkContainer*
1624 gtk_container_get_resize_container (GtkContainer *container)
1625 {
1626   GtkWidget *parent;
1627   GtkWidget *widget = GTK_WIDGET (container);
1628
1629   while ((parent = gtk_widget_get_parent (widget)))
1630     {
1631       widget = parent;
1632       if (GTK_IS_RESIZE_CONTAINER (widget))
1633         break;
1634     }
1635
1636   return GTK_IS_RESIZE_CONTAINER (widget) ? (GtkContainer*) widget : NULL;
1637 }
1638
1639 static gboolean
1640 gtk_container_idle_sizer (gpointer data)
1641 {
1642   /* we may be invoked with a container_resize_queue of NULL, because
1643    * queue_resize could have been adding an extra idle function while
1644    * the queue still got processed. we better just ignore such case
1645    * than trying to explicitely work around them with some extra flags,
1646    * since it doesn't cause any actual harm.
1647    */
1648   while (container_resize_queue)
1649     {
1650       GSList *slist;
1651       GtkWidget *widget;
1652
1653       slist = container_resize_queue;
1654       container_resize_queue = slist->next;
1655       widget = slist->data;
1656       g_slist_free_1 (slist);
1657
1658       _gtk_widget_set_resize_pending (widget, FALSE);
1659       gtk_container_check_resize (GTK_CONTAINER (widget));
1660     }
1661
1662   gdk_window_process_all_updates ();
1663
1664   return FALSE;
1665 }
1666
1667 static void
1668 _gtk_container_queue_resize_internal (GtkContainer *container,
1669                                       gboolean      invalidate_only)
1670 {
1671   GtkContainer *resize_container;
1672   GtkWidget *parent;
1673   GtkWidget *widget;
1674
1675   g_return_if_fail (GTK_IS_CONTAINER (container));
1676
1677   widget = GTK_WIDGET (container);
1678
1679   resize_container = gtk_container_get_resize_container (container);
1680
1681   while (TRUE)
1682     {
1683       _gtk_widget_set_alloc_needed (widget, TRUE);
1684       _gtk_widget_set_width_request_needed (widget, TRUE);
1685       _gtk_widget_set_height_request_needed (widget, TRUE);
1686
1687       if ((resize_container && widget == GTK_WIDGET (resize_container)) ||
1688           !(parent = gtk_widget_get_parent (widget)))
1689         break;
1690
1691       widget = parent;
1692     }
1693
1694   if (resize_container && !invalidate_only)
1695     {
1696       if (gtk_widget_get_visible (GTK_WIDGET (resize_container)) &&
1697           (gtk_widget_is_toplevel (GTK_WIDGET (resize_container)) ||
1698            gtk_widget_get_realized (GTK_WIDGET (resize_container))))
1699         {
1700           switch (resize_container->priv->resize_mode)
1701             {
1702             case GTK_RESIZE_QUEUE:
1703               if (!_gtk_widget_get_resize_pending (GTK_WIDGET (resize_container)))
1704                 {
1705                   _gtk_widget_set_resize_pending (GTK_WIDGET (resize_container), TRUE);
1706                   if (container_resize_queue == NULL)
1707                     gdk_threads_add_idle_full (GTK_PRIORITY_RESIZE,
1708                                      gtk_container_idle_sizer,
1709                                      NULL, NULL);
1710                   container_resize_queue = g_slist_prepend (container_resize_queue, resize_container);
1711                 }
1712               break;
1713
1714             case GTK_RESIZE_IMMEDIATE:
1715               gtk_container_check_resize (resize_container);
1716               break;
1717
1718             case GTK_RESIZE_PARENT:
1719               g_assert_not_reached ();
1720               break;
1721             }
1722         }
1723       else
1724         {
1725           /* we need to let hidden resize containers know that something
1726            * changed while they where hidden (currently only evaluated by
1727            * toplevels).
1728            */
1729           resize_container->priv->need_resize = TRUE;
1730         }
1731     }
1732 }
1733
1734 /**
1735  * _gtk_container_queue_resize:
1736  * @container: a #GtkContainer
1737  *
1738  * Determines the "resize container" in the hierarchy above this container
1739  * (typically the toplevel, but other containers can be set as resize
1740  * containers with gtk_container_set_resize_mode()), marks the container
1741  * and all parents up to and including the resize container as needing
1742  * to have sizes recompted, and if necessary adds the resize container
1743  * to the queue of containers that will be resized out at idle.
1744  */
1745 void
1746 _gtk_container_queue_resize (GtkContainer *container)
1747 {
1748   _gtk_container_queue_resize_internal (container, FALSE);
1749 }
1750
1751 /**
1752  * _gtk_container_resize_invalidate:
1753  * @container: a #GtkContainer
1754  *
1755  * Invalidates cached sizes like _gtk_container_queue_resize() but doesn't
1756  * actually queue the resize container for resize.
1757  */
1758 void
1759 _gtk_container_resize_invalidate (GtkContainer *container)
1760 {
1761   _gtk_container_queue_resize_internal (container, TRUE);
1762 }
1763
1764 void
1765 gtk_container_check_resize (GtkContainer *container)
1766 {
1767   g_return_if_fail (GTK_IS_CONTAINER (container));
1768
1769   g_signal_emit (container, container_signals[CHECK_RESIZE], 0);
1770 }
1771
1772 static void
1773 gtk_container_real_check_resize (GtkContainer *container)
1774 {
1775   GtkWidget *widget = GTK_WIDGET (container);
1776   GtkAllocation allocation;
1777   GtkRequisition requisition;
1778
1779   gtk_widget_get_preferred_size (widget,
1780                                  &requisition, NULL);
1781   gtk_widget_get_allocation (widget, &allocation);
1782
1783   if (requisition.width > allocation.width ||
1784       requisition.height > allocation.height)
1785     {
1786       if (GTK_IS_RESIZE_CONTAINER (container))
1787         {
1788           gtk_widget_size_allocate (widget, &allocation);
1789           gtk_widget_set_allocation (widget, &allocation);
1790         }
1791       else
1792         gtk_widget_queue_resize (widget);
1793     }
1794   else
1795     {
1796       gtk_container_resize_children (container);
1797     }
1798 }
1799
1800 /* The container hasn't changed size but one of its children
1801  *  queued a resize request. Which means that the allocation
1802  *  is not sufficient for the requisition of some child.
1803  *  We've already performed a size request at this point,
1804  *  so we simply need to reallocate and let the allocation
1805  *  trickle down via GTK_WIDGET_ALLOC_NEEDED flags.
1806  */
1807 void
1808 gtk_container_resize_children (GtkContainer *container)
1809 {
1810   GtkAllocation allocation;
1811   GtkWidget *widget;
1812
1813   /* resizing invariants:
1814    * toplevels have *always* resize_mode != GTK_RESIZE_PARENT set.
1815    * containers that have an idle sizer pending must be flagged with
1816    * RESIZE_PENDING.
1817    */
1818   g_return_if_fail (GTK_IS_CONTAINER (container));
1819
1820   widget = GTK_WIDGET (container);
1821   gtk_widget_get_allocation (widget, &allocation);
1822
1823   gtk_widget_size_allocate (widget, &allocation);
1824   gtk_widget_set_allocation (widget, &allocation);
1825 }
1826
1827 static void
1828 gtk_container_adjust_size_request (GtkWidget         *widget,
1829                                    GtkOrientation     orientation,
1830                                    gint              *minimum_size,
1831                                    gint              *natural_size)
1832 {
1833   GtkContainer *container;
1834
1835   container = GTK_CONTAINER (widget);
1836
1837   if (GTK_CONTAINER_GET_CLASS (widget)->_handle_border_width)
1838     {
1839       int border_width;
1840
1841       border_width = container->priv->border_width;
1842
1843       *minimum_size += border_width * 2;
1844       *natural_size += border_width * 2;
1845     }
1846
1847   /* chain up last so gtk_widget_set_size_request() values
1848    * will have a chance to overwrite our border width.
1849    */
1850   parent_class->adjust_size_request (widget, orientation,
1851                                      minimum_size, natural_size);
1852 }
1853
1854 static void
1855 gtk_container_adjust_size_allocation (GtkWidget         *widget,
1856                                       GtkOrientation     orientation,
1857                                       gint              *minimum_size,
1858                                       gint              *natural_size,
1859                                       gint              *allocated_pos,
1860                                       gint              *allocated_size)
1861 {
1862   GtkContainer *container;
1863   int border_width;
1864
1865   container = GTK_CONTAINER (widget);
1866
1867   if (!GTK_CONTAINER_GET_CLASS (widget)->_handle_border_width)
1868     {
1869       parent_class->adjust_size_allocation (widget, orientation,
1870                                             minimum_size, natural_size, allocated_pos,
1871                                             allocated_size);
1872       return;
1873     }
1874
1875   border_width = container->priv->border_width;
1876
1877   *allocated_size -= border_width * 2;
1878
1879   /* If we get a pathological too-small allocation to hold
1880    * even the border width, leave all allocation to the actual
1881    * widget, and leave x,y unchanged. (GtkWidget's min size is
1882    * 1x1 if you're wondering why <1 and not <0)
1883    *
1884    * As long as we have space, set x,y properly.
1885    */
1886
1887   if (*allocated_size < 1)
1888     {
1889       *allocated_size += border_width * 2;
1890     }
1891   else
1892     {
1893       *allocated_pos += border_width;
1894       *minimum_size -= border_width * 2;
1895       *natural_size -= border_width * 2;
1896     }
1897
1898   /* Chain up to GtkWidgetClass *after* removing our border width from
1899    * the proposed allocation size. This is because it's possible that the
1900    * widget was allocated more space than it needs in a said orientation,
1901    * if GtkWidgetClass does any alignments and thus limits the size to the
1902    * natural size... then we need that to be done *after* removing any margins
1903    * and padding values.
1904    */
1905   parent_class->adjust_size_allocation (widget, orientation,
1906                                         minimum_size, natural_size, allocated_pos,
1907                                         allocated_size);
1908 }
1909
1910 typedef struct {
1911   gint hfw;
1912   gint wfh;
1913 } RequestModeCount;
1914
1915 static void
1916 count_request_modes (GtkWidget        *widget,
1917                      RequestModeCount *count)
1918 {
1919   GtkSizeRequestMode mode = gtk_widget_get_request_mode (widget);
1920
1921   switch (mode)
1922     {
1923     case GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH:
1924       count->hfw++;
1925       break;
1926     case GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT:
1927       count->wfh++;
1928       break;
1929     case GTK_SIZE_REQUEST_CONSTANT_SIZE:
1930     default:
1931       break;
1932     }
1933 }
1934
1935 static GtkSizeRequestMode
1936 gtk_container_get_request_mode (GtkWidget *widget)
1937 {
1938   GtkContainer        *container = GTK_CONTAINER (widget);
1939   GtkContainerPrivate *priv      = container->priv;
1940
1941   /* Recalculate the request mode of the children by majority
1942    * vote whenever the internal content changes */
1943   if (_gtk_widget_get_width_request_needed (widget) ||
1944       _gtk_widget_get_height_request_needed (widget))
1945     {
1946       RequestModeCount count = { 0, 0 };
1947
1948       gtk_container_forall (container, (GtkCallback)count_request_modes, &count);
1949
1950       if (!count.hfw && !count.wfh)
1951         priv->request_mode = GTK_SIZE_REQUEST_CONSTANT_SIZE;
1952       else
1953         priv->request_mode = count.wfh > count.hfw ?
1954           GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT :
1955           GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH;
1956     }
1957
1958   return priv->request_mode;
1959 }
1960
1961 /**
1962  * gtk_container_class_handle_border_width:
1963  * @klass: the class struct of a #GtkContainer subclass
1964  *
1965  * Modifies a subclass of #GtkContainerClass to automatically add and
1966  * remove the border-width setting on GtkContainer.  This allows the
1967  * subclass to ignore the border width in its size request and
1968  * allocate methods. The intent is for a subclass to invoke this
1969  * in its class_init function.
1970  *
1971  * gtk_container_class_handle_border_width() is necessary because it
1972  * would break API too badly to make this behavior the default. So
1973  * subclasses must "opt in" to the parent class handling border_width
1974  * for them.
1975  */
1976 void
1977 gtk_container_class_handle_border_width (GtkContainerClass *klass)
1978 {
1979   g_return_if_fail (GTK_IS_CONTAINER_CLASS (klass));
1980
1981   klass->_handle_border_width = TRUE;
1982 }
1983
1984 /**
1985  * gtk_container_forall:
1986  * @container: a #GtkContainer
1987  * @callback: (scope call) (closure callback_data): a callback
1988  * @callback_data: callback user data
1989  *
1990  * Invokes @callback on each child of @container, including children
1991  * that are considered "internal" (implementation details of the
1992  * container). "Internal" children generally weren't added by the user
1993  * of the container, but were added by the container implementation
1994  * itself.  Most applications should use gtk_container_foreach(),
1995  * rather than gtk_container_forall().
1996  *
1997  * Virtual: forall
1998  **/
1999 void
2000 gtk_container_forall (GtkContainer *container,
2001                       GtkCallback   callback,
2002                       gpointer      callback_data)
2003 {
2004   GtkContainerClass *class;
2005
2006   g_return_if_fail (GTK_IS_CONTAINER (container));
2007   g_return_if_fail (callback != NULL);
2008
2009   class = GTK_CONTAINER_GET_CLASS (container);
2010
2011   if (class->forall)
2012     class->forall (container, TRUE, callback, callback_data);
2013 }
2014
2015 /**
2016  * gtk_container_foreach:
2017  * @container: a #GtkContainer
2018  * @callback: (scope call):  a callback
2019  * @callback_data: callback user data
2020  *
2021  * Invokes @callback on each non-internal child of @container. See
2022  * gtk_container_forall() for details on what constitutes an
2023  * "internal" child.  Most applications should use
2024  * gtk_container_foreach(), rather than gtk_container_forall().
2025  **/
2026 void
2027 gtk_container_foreach (GtkContainer *container,
2028                        GtkCallback   callback,
2029                        gpointer      callback_data)
2030 {
2031   GtkContainerClass *class;
2032
2033   g_return_if_fail (GTK_IS_CONTAINER (container));
2034   g_return_if_fail (callback != NULL);
2035
2036   class = GTK_CONTAINER_GET_CLASS (container);
2037
2038   if (class->forall)
2039     class->forall (container, FALSE, callback, callback_data);
2040 }
2041
2042 /**
2043  * gtk_container_set_focus_child:
2044  * @container: a #GtkContainer
2045  * @child: (allow-none): a #GtkWidget, or %NULL
2046  *
2047  * Sets, or unsets if @child is %NULL, the focused child of @container.
2048  *
2049  * This function emits the GtkContainer::set_focus_child signal of
2050  * @container. Implementations of #GtkContainer can override the
2051  * default behaviour by overriding the class closure of this signal.
2052  *
2053  * This is function is mostly meant to be used by widgets. Applications can use
2054  * gtk_widget_grab_focus() to manualy set the focus to a specific widget.
2055  */
2056 void
2057 gtk_container_set_focus_child (GtkContainer *container,
2058                                GtkWidget    *child)
2059 {
2060   g_return_if_fail (GTK_IS_CONTAINER (container));
2061   if (child)
2062     g_return_if_fail (GTK_IS_WIDGET (child));
2063
2064   g_signal_emit (container, container_signals[SET_FOCUS_CHILD], 0, child);
2065 }
2066
2067 /**
2068  * gtk_container_get_focus_child:
2069  * @container: a #GtkContainer
2070  *
2071  * Returns the current focus child widget inside @container. This is not the
2072  * currently focused widget. That can be obtained by calling
2073  * gtk_window_get_focus().
2074  *
2075  * Returns: (transfer none): The child widget which will receive the
2076  *          focus inside @container when the @conatiner is focussed,
2077  *          or %NULL if none is set.
2078  *
2079  * Since: 2.14
2080  **/
2081 GtkWidget *
2082 gtk_container_get_focus_child (GtkContainer *container)
2083 {
2084   g_return_val_if_fail (GTK_IS_CONTAINER (container), NULL);
2085
2086   return container->priv->focus_child;
2087 }
2088
2089 /**
2090  * gtk_container_get_children:
2091  * @container: a #GtkContainer
2092  *
2093  * Returns the container's non-internal children. See
2094  * gtk_container_forall() for details on what constitutes an "internal" child.
2095  *
2096  * Return value: (element-type GtkWidget) (transfer container): a newly-allocated list of the container's non-internal children.
2097  **/
2098 GList*
2099 gtk_container_get_children (GtkContainer *container)
2100 {
2101   GList *children = NULL;
2102
2103   gtk_container_foreach (container,
2104                          gtk_container_children_callback,
2105                          &children);
2106
2107   return g_list_reverse (children);
2108 }
2109
2110 static void
2111 gtk_container_child_position_callback (GtkWidget *widget,
2112                                        gpointer   client_data)
2113 {
2114   struct {
2115     GtkWidget *child;
2116     guint i;
2117     guint index;
2118   } *data = client_data;
2119
2120   data->i++;
2121   if (data->child == widget)
2122     data->index = data->i;
2123 }
2124
2125 static gchar*
2126 gtk_container_child_default_composite_name (GtkContainer *container,
2127                                             GtkWidget    *child)
2128 {
2129   struct {
2130     GtkWidget *child;
2131     guint i;
2132     guint index;
2133   } data;
2134   gchar *name;
2135
2136   /* fallback implementation */
2137   data.child = child;
2138   data.i = 0;
2139   data.index = 0;
2140   gtk_container_forall (container,
2141                         gtk_container_child_position_callback,
2142                         &data);
2143
2144   name = g_strdup_printf ("%s-%u",
2145                           g_type_name (G_TYPE_FROM_INSTANCE (child)),
2146                           data.index);
2147
2148   return name;
2149 }
2150
2151 gchar*
2152 _gtk_container_child_composite_name (GtkContainer *container,
2153                                     GtkWidget    *child)
2154 {
2155   gboolean composite_child;
2156
2157   g_return_val_if_fail (GTK_IS_CONTAINER (container), NULL);
2158   g_return_val_if_fail (GTK_IS_WIDGET (child), NULL);
2159   g_return_val_if_fail (gtk_widget_get_parent (child) == GTK_WIDGET (container), NULL);
2160
2161   g_object_get (child, "composite-child", &composite_child, NULL);
2162   if (composite_child)
2163     {
2164       static GQuark quark_composite_name = 0;
2165       gchar *name;
2166
2167       if (!quark_composite_name)
2168         quark_composite_name = g_quark_from_static_string ("gtk-composite-name");
2169
2170       name = g_object_get_qdata (G_OBJECT (child), quark_composite_name);
2171       if (!name)
2172         {
2173           GtkContainerClass *class;
2174
2175           class = GTK_CONTAINER_GET_CLASS (container);
2176           if (class->composite_name)
2177             name = class->composite_name (container, child);
2178         }
2179       else
2180         name = g_strdup (name);
2181
2182       return name;
2183     }
2184
2185   return NULL;
2186 }
2187
2188 typedef struct {
2189   gboolean hexpand;
2190   gboolean vexpand;
2191 } ComputeExpandData;
2192
2193 static void
2194 gtk_container_compute_expand_callback (GtkWidget *widget,
2195                                        gpointer   client_data)
2196 {
2197   ComputeExpandData *data = client_data;
2198
2199   /* note that we don't get_expand on the child if we already know we
2200    * have to expand, so we only recurse into children until we find
2201    * one that expands and then we basically don't do any more
2202    * work. This means that we can leave some children in a
2203    * need_compute_expand state, which is fine, as long as GtkWidget
2204    * doesn't rely on an invariant that "if a child has
2205    * need_compute_expand, its parents also do"
2206    *
2207    * gtk_widget_compute_expand() always returns FALSE if the
2208    * child is !visible so that's taken care of.
2209    */
2210   data->hexpand = data->hexpand ||
2211     gtk_widget_compute_expand (widget, GTK_ORIENTATION_HORIZONTAL);
2212
2213   data->vexpand = data->vexpand ||
2214     gtk_widget_compute_expand (widget, GTK_ORIENTATION_VERTICAL);
2215 }
2216
2217 static void
2218 gtk_container_compute_expand (GtkWidget         *widget,
2219                               gboolean          *hexpand_p,
2220                               gboolean          *vexpand_p)
2221 {
2222   ComputeExpandData data;
2223
2224   data.hexpand = FALSE;
2225   data.vexpand = FALSE;
2226
2227   gtk_container_forall (GTK_CONTAINER (widget),
2228                         gtk_container_compute_expand_callback,
2229                         &data);
2230
2231   *hexpand_p = data.hexpand;
2232   *vexpand_p = data.vexpand;
2233 }
2234
2235 static void
2236 gtk_container_real_set_focus_child (GtkContainer     *container,
2237                                     GtkWidget        *child)
2238 {
2239   GtkContainerPrivate *priv;
2240
2241   g_return_if_fail (GTK_IS_CONTAINER (container));
2242   g_return_if_fail (child == NULL || GTK_IS_WIDGET (child));
2243
2244   priv = container->priv;
2245
2246   if (child != priv->focus_child)
2247     {
2248       if (priv->focus_child)
2249         g_object_unref (priv->focus_child);
2250       priv->focus_child = child;
2251       if (priv->focus_child)
2252         g_object_ref (priv->focus_child);
2253     }
2254
2255
2256   /* check for h/v adjustments
2257    */
2258   if (priv->focus_child)
2259     {
2260       GtkAdjustment *hadj;
2261       GtkAdjustment *vadj;
2262       GtkAllocation allocation;
2263       GtkWidget *focus_child;
2264       gint x, y;
2265
2266       hadj = g_object_get_qdata (G_OBJECT (container), hadjustment_key_id);
2267       vadj = g_object_get_qdata (G_OBJECT (container), vadjustment_key_id);
2268       if (hadj || vadj)
2269         {
2270
2271           focus_child = priv->focus_child;
2272           while (GTK_IS_CONTAINER (focus_child) && gtk_container_get_focus_child (GTK_CONTAINER (focus_child)))
2273             {
2274               focus_child = gtk_container_get_focus_child (GTK_CONTAINER (focus_child));
2275             }
2276
2277           gtk_widget_translate_coordinates (focus_child, priv->focus_child,
2278                                             0, 0, &x, &y);
2279
2280           gtk_widget_get_allocation (priv->focus_child, &allocation);
2281           x += allocation.x;
2282           y += allocation.y;
2283
2284           gtk_widget_get_allocation (focus_child, &allocation);
2285
2286           if (vadj)
2287             gtk_adjustment_clamp_page (vadj, y, y + allocation.height);
2288
2289           if (hadj)
2290             gtk_adjustment_clamp_page (hadj, x, x + allocation.width);
2291         }
2292     }
2293 }
2294
2295 static GList*
2296 get_focus_chain (GtkContainer *container)
2297 {
2298   return g_object_get_data (G_OBJECT (container), "gtk-container-focus-chain");
2299 }
2300
2301 /* same as gtk_container_get_children, except it includes internals
2302  */
2303 static GList *
2304 gtk_container_get_all_children (GtkContainer *container)
2305 {
2306   GList *children = NULL;
2307
2308   gtk_container_forall (container,
2309                          gtk_container_children_callback,
2310                          &children);
2311
2312   return children;
2313 }
2314
2315 static GtkWidgetPath *
2316 gtk_container_real_get_path_for_child (GtkContainer *container,
2317                                        GtkWidget    *child)
2318 {
2319   GtkStyleContext *context;
2320   GtkWidgetPath *path;
2321   GList *classes;
2322
2323   context = gtk_widget_get_style_context (GTK_WIDGET (container));
2324   path = gtk_widget_path_copy (gtk_widget_get_path (GTK_WIDGET (container)));
2325
2326   /* Copy any permanent classes to the path */
2327   classes = gtk_style_context_list_classes (context);
2328
2329   while (classes)
2330     {
2331       GList *cur;
2332
2333       cur = classes;
2334       classes = classes->next;
2335
2336       gtk_widget_path_iter_add_class (path, -1, cur->data);
2337       g_list_free_1 (cur);
2338     }
2339
2340   gtk_widget_path_append_for_widget (path, child);
2341
2342   return path;
2343 }
2344
2345 static gboolean
2346 gtk_container_focus (GtkWidget        *widget,
2347                      GtkDirectionType  direction)
2348 {
2349   GList *children;
2350   GList *sorted_children;
2351   gint return_val;
2352   GtkContainer *container;
2353   GtkContainerPrivate *priv;
2354
2355   g_return_val_if_fail (GTK_IS_CONTAINER (widget), FALSE);
2356
2357   container = GTK_CONTAINER (widget);
2358   priv = container->priv;
2359
2360   return_val = FALSE;
2361
2362   if (gtk_widget_get_can_focus (widget))
2363     {
2364       if (!gtk_widget_has_focus (widget))
2365         {
2366           gtk_widget_grab_focus (widget);
2367           return_val = TRUE;
2368         }
2369     }
2370   else
2371     {
2372       /* Get a list of the containers children, allowing focus
2373        * chain to override.
2374        */
2375       if (priv->has_focus_chain)
2376         children = g_list_copy (get_focus_chain (container));
2377       else
2378         children = gtk_container_get_all_children (container);
2379
2380       if (priv->has_focus_chain &&
2381           (direction == GTK_DIR_TAB_FORWARD ||
2382            direction == GTK_DIR_TAB_BACKWARD))
2383         {
2384           sorted_children = g_list_copy (children);
2385
2386           if (direction == GTK_DIR_TAB_BACKWARD)
2387             sorted_children = g_list_reverse (sorted_children);
2388         }
2389       else
2390         sorted_children = _gtk_container_focus_sort (container, children, direction, NULL);
2391
2392       return_val = gtk_container_focus_move (container, sorted_children, direction);
2393
2394       g_list_free (sorted_children);
2395       g_list_free (children);
2396     }
2397
2398   return return_val;
2399 }
2400
2401 static gint
2402 tab_compare (gconstpointer a,
2403              gconstpointer b,
2404              gpointer      data)
2405 {
2406   GtkAllocation child1_allocation, child2_allocation;
2407   const GtkWidget *child1 = a;
2408   const GtkWidget *child2 = b;
2409   GtkTextDirection text_direction = GPOINTER_TO_INT (data);
2410   gint y1, y2;
2411
2412   gtk_widget_get_allocation ((GtkWidget *) child1, &child1_allocation);
2413   gtk_widget_get_allocation ((GtkWidget *) child2, &child2_allocation);
2414
2415   y1 = child1_allocation.y + child1_allocation.height / 2;
2416   y2 = child2_allocation.y + child2_allocation.height / 2;
2417
2418   if (y1 == y2)
2419     {
2420       gint x1 = child1_allocation.x + child1_allocation.width / 2;
2421       gint x2 = child2_allocation.x + child2_allocation.width / 2;
2422
2423       if (text_direction == GTK_TEXT_DIR_RTL)
2424         return (x1 < x2) ? 1 : ((x1 == x2) ? 0 : -1);
2425       else
2426         return (x1 < x2) ? -1 : ((x1 == x2) ? 0 : 1);
2427     }
2428   else
2429     return (y1 < y2) ? -1 : 1;
2430 }
2431
2432 static GList *
2433 gtk_container_focus_sort_tab (GtkContainer     *container,
2434                               GList            *children,
2435                               GtkDirectionType  direction,
2436                               GtkWidget        *old_focus)
2437 {
2438   GtkTextDirection text_direction = gtk_widget_get_direction (GTK_WIDGET (container));
2439   children = g_list_sort_with_data (children, tab_compare, GINT_TO_POINTER (text_direction));
2440
2441   /* if we are going backwards then reverse the order
2442    *  of the children.
2443    */
2444   if (direction == GTK_DIR_TAB_BACKWARD)
2445     children = g_list_reverse (children);
2446
2447   return children;
2448 }
2449
2450 /* Get coordinates of @widget's allocation with respect to
2451  * allocation of @container.
2452  */
2453 static gboolean
2454 get_allocation_coords (GtkContainer  *container,
2455                        GtkWidget     *widget,
2456                        GdkRectangle  *allocation)
2457 {
2458   gtk_widget_get_allocation (widget, allocation);
2459
2460   return gtk_widget_translate_coordinates (widget, GTK_WIDGET (container),
2461                                            0, 0, &allocation->x, &allocation->y);
2462 }
2463
2464 /* Look for a child in @children that is intermediate between
2465  * the focus widget and container. This widget, if it exists,
2466  * acts as the starting widget for focus navigation.
2467  */
2468 static GtkWidget *
2469 find_old_focus (GtkContainer *container,
2470                 GList        *children)
2471 {
2472   GList *tmp_list = children;
2473   while (tmp_list)
2474     {
2475       GtkWidget *child = tmp_list->data;
2476       GtkWidget *widget = child;
2477
2478       while (widget && widget != (GtkWidget *)container)
2479         {
2480           GtkWidget *parent;
2481
2482           parent = gtk_widget_get_parent (widget);
2483
2484           if (parent && (gtk_container_get_focus_child (GTK_CONTAINER (parent)) != widget))
2485             goto next;
2486
2487           widget = parent;
2488         }
2489
2490       return child;
2491
2492     next:
2493       tmp_list = tmp_list->next;
2494     }
2495
2496   return NULL;
2497 }
2498
2499 static gboolean
2500 old_focus_coords (GtkContainer *container,
2501                   GdkRectangle *old_focus_rect)
2502 {
2503   GtkWidget *widget = GTK_WIDGET (container);
2504   GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
2505   GtkWidget *old_focus;
2506
2507   if (GTK_IS_WINDOW (toplevel))
2508     {
2509       old_focus = gtk_window_get_focus (GTK_WINDOW (toplevel));
2510       if (old_focus)
2511         return get_allocation_coords (container, old_focus, old_focus_rect);
2512     }
2513
2514   return FALSE;
2515 }
2516
2517 typedef struct _CompareInfo CompareInfo;
2518
2519 struct _CompareInfo
2520 {
2521   GtkContainer *container;
2522   gint x;
2523   gint y;
2524   gboolean reverse;
2525 };
2526
2527 static gint
2528 up_down_compare (gconstpointer a,
2529                  gconstpointer b,
2530                  gpointer      data)
2531 {
2532   GdkRectangle allocation1;
2533   GdkRectangle allocation2;
2534   CompareInfo *compare = data;
2535   gint y1, y2;
2536
2537   get_allocation_coords (compare->container, (GtkWidget *)a, &allocation1);
2538   get_allocation_coords (compare->container, (GtkWidget *)b, &allocation2);
2539
2540   y1 = allocation1.y + allocation1.height / 2;
2541   y2 = allocation2.y + allocation2.height / 2;
2542
2543   if (y1 == y2)
2544     {
2545       gint x1 = abs (allocation1.x + allocation1.width / 2 - compare->x);
2546       gint x2 = abs (allocation2.x + allocation2.width / 2 - compare->x);
2547
2548       if (compare->reverse)
2549         return (x1 < x2) ? 1 : ((x1 == x2) ? 0 : -1);
2550       else
2551         return (x1 < x2) ? -1 : ((x1 == x2) ? 0 : 1);
2552     }
2553   else
2554     return (y1 < y2) ? -1 : 1;
2555 }
2556
2557 static GList *
2558 gtk_container_focus_sort_up_down (GtkContainer     *container,
2559                                   GList            *children,
2560                                   GtkDirectionType  direction,
2561                                   GtkWidget        *old_focus)
2562 {
2563   CompareInfo compare;
2564   GList *tmp_list;
2565   GdkRectangle old_allocation;
2566
2567   compare.container = container;
2568   compare.reverse = (direction == GTK_DIR_UP);
2569
2570   if (!old_focus)
2571       old_focus = find_old_focus (container, children);
2572
2573   if (old_focus && get_allocation_coords (container, old_focus, &old_allocation))
2574     {
2575       gint compare_x1;
2576       gint compare_x2;
2577       gint compare_y;
2578
2579       /* Delete widgets from list that don't match minimum criteria */
2580
2581       compare_x1 = old_allocation.x;
2582       compare_x2 = old_allocation.x + old_allocation.width;
2583
2584       if (direction == GTK_DIR_UP)
2585         compare_y = old_allocation.y;
2586       else
2587         compare_y = old_allocation.y + old_allocation.height;
2588
2589       tmp_list = children;
2590       while (tmp_list)
2591         {
2592           GtkWidget *child = tmp_list->data;
2593           GList *next = tmp_list->next;
2594           gint child_x1, child_x2;
2595           GdkRectangle child_allocation;
2596
2597           if (child != old_focus)
2598             {
2599               if (get_allocation_coords (container, child, &child_allocation))
2600                 {
2601                   child_x1 = child_allocation.x;
2602                   child_x2 = child_allocation.x + child_allocation.width;
2603
2604                   if ((child_x2 <= compare_x1 || child_x1 >= compare_x2) /* No horizontal overlap */ ||
2605                       (direction == GTK_DIR_DOWN && child_allocation.y + child_allocation.height < compare_y) || /* Not below */
2606                       (direction == GTK_DIR_UP && child_allocation.y > compare_y)) /* Not above */
2607                     {
2608                       children = g_list_delete_link (children, tmp_list);
2609                     }
2610                 }
2611               else
2612                 children = g_list_delete_link (children, tmp_list);
2613             }
2614
2615           tmp_list = next;
2616         }
2617
2618       compare.x = (compare_x1 + compare_x2) / 2;
2619       compare.y = old_allocation.y + old_allocation.height / 2;
2620     }
2621   else
2622     {
2623       /* No old focus widget, need to figure out starting x,y some other way
2624        */
2625       GtkAllocation allocation;
2626       GtkWidget *widget = GTK_WIDGET (container);
2627       GdkRectangle old_focus_rect;
2628
2629       gtk_widget_get_allocation (widget, &allocation);
2630
2631       if (old_focus_coords (container, &old_focus_rect))
2632         {
2633           compare.x = old_focus_rect.x + old_focus_rect.width / 2;
2634         }
2635       else
2636         {
2637           if (!gtk_widget_get_has_window (widget))
2638             compare.x = allocation.x + allocation.width / 2;
2639           else
2640             compare.x = allocation.width / 2;
2641         }
2642
2643       if (!gtk_widget_get_has_window (widget))
2644         compare.y = (direction == GTK_DIR_DOWN) ? allocation.y : allocation.y + allocation.height;
2645       else
2646         compare.y = (direction == GTK_DIR_DOWN) ? 0 : + allocation.height;
2647     }
2648
2649   children = g_list_sort_with_data (children, up_down_compare, &compare);
2650
2651   if (compare.reverse)
2652     children = g_list_reverse (children);
2653
2654   return children;
2655 }
2656
2657 static gint
2658 left_right_compare (gconstpointer a,
2659                     gconstpointer b,
2660                     gpointer      data)
2661 {
2662   GdkRectangle allocation1;
2663   GdkRectangle allocation2;
2664   CompareInfo *compare = data;
2665   gint x1, x2;
2666
2667   get_allocation_coords (compare->container, (GtkWidget *)a, &allocation1);
2668   get_allocation_coords (compare->container, (GtkWidget *)b, &allocation2);
2669
2670   x1 = allocation1.x + allocation1.width / 2;
2671   x2 = allocation2.x + allocation2.width / 2;
2672
2673   if (x1 == x2)
2674     {
2675       gint y1 = abs (allocation1.y + allocation1.height / 2 - compare->y);
2676       gint y2 = abs (allocation2.y + allocation2.height / 2 - compare->y);
2677
2678       if (compare->reverse)
2679         return (y1 < y2) ? 1 : ((y1 == y2) ? 0 : -1);
2680       else
2681         return (y1 < y2) ? -1 : ((y1 == y2) ? 0 : 1);
2682     }
2683   else
2684     return (x1 < x2) ? -1 : 1;
2685 }
2686
2687 static GList *
2688 gtk_container_focus_sort_left_right (GtkContainer     *container,
2689                                      GList            *children,
2690                                      GtkDirectionType  direction,
2691                                      GtkWidget        *old_focus)
2692 {
2693   CompareInfo compare;
2694   GList *tmp_list;
2695   GdkRectangle old_allocation;
2696
2697   compare.container = container;
2698   compare.reverse = (direction == GTK_DIR_LEFT);
2699
2700   if (!old_focus)
2701     old_focus = find_old_focus (container, children);
2702
2703   if (old_focus && get_allocation_coords (container, old_focus, &old_allocation))
2704     {
2705       gint compare_y1;
2706       gint compare_y2;
2707       gint compare_x;
2708
2709       /* Delete widgets from list that don't match minimum criteria */
2710
2711       compare_y1 = old_allocation.y;
2712       compare_y2 = old_allocation.y + old_allocation.height;
2713
2714       if (direction == GTK_DIR_LEFT)
2715         compare_x = old_allocation.x;
2716       else
2717         compare_x = old_allocation.x + old_allocation.width;
2718
2719       tmp_list = children;
2720       while (tmp_list)
2721         {
2722           GtkWidget *child = tmp_list->data;
2723           GList *next = tmp_list->next;
2724           gint child_y1, child_y2;
2725           GdkRectangle child_allocation;
2726
2727           if (child != old_focus)
2728             {
2729               if (get_allocation_coords (container, child, &child_allocation))
2730                 {
2731                   child_y1 = child_allocation.y;
2732                   child_y2 = child_allocation.y + child_allocation.height;
2733
2734                   if ((child_y2 <= compare_y1 || child_y1 >= compare_y2) /* No vertical overlap */ ||
2735                       (direction == GTK_DIR_RIGHT && child_allocation.x + child_allocation.width < compare_x) || /* Not to left */
2736                       (direction == GTK_DIR_LEFT && child_allocation.x > compare_x)) /* Not to right */
2737                     {
2738                       children = g_list_delete_link (children, tmp_list);
2739                     }
2740                 }
2741               else
2742                 children = g_list_delete_link (children, tmp_list);
2743             }
2744
2745           tmp_list = next;
2746         }
2747
2748       compare.y = (compare_y1 + compare_y2) / 2;
2749       compare.x = old_allocation.x + old_allocation.width / 2;
2750     }
2751   else
2752     {
2753       /* No old focus widget, need to figure out starting x,y some other way
2754        */
2755       GtkAllocation allocation;
2756       GtkWidget *widget = GTK_WIDGET (container);
2757       GdkRectangle old_focus_rect;
2758
2759       gtk_widget_get_allocation (widget, &allocation);
2760
2761       if (old_focus_coords (container, &old_focus_rect))
2762         {
2763           compare.y = old_focus_rect.y + old_focus_rect.height / 2;
2764         }
2765       else
2766         {
2767           if (!gtk_widget_get_has_window (widget))
2768             compare.y = allocation.y + allocation.height / 2;
2769           else
2770             compare.y = allocation.height / 2;
2771         }
2772
2773       if (!gtk_widget_get_has_window (widget))
2774         compare.x = (direction == GTK_DIR_RIGHT) ? allocation.x : allocation.x + allocation.width;
2775       else
2776         compare.x = (direction == GTK_DIR_RIGHT) ? 0 : allocation.width;
2777     }
2778
2779   children = g_list_sort_with_data (children, left_right_compare, &compare);
2780
2781   if (compare.reverse)
2782     children = g_list_reverse (children);
2783
2784   return children;
2785 }
2786
2787 /**
2788  * gtk_container_focus_sort:
2789  * @container: a #GtkContainer
2790  * @children:  a list of descendents of @container (they don't
2791  *             have to be direct children)
2792  * @direction: focus direction
2793  * @old_focus: (allow-none): widget to use for the starting position, or %NULL
2794  *             to determine this automatically.
2795  *             (Note, this argument isn't used for GTK_DIR_TAB_*,
2796  *              which is the only @direction we use currently,
2797  *              so perhaps this argument should be removed)
2798  *
2799  * Sorts @children in the correct order for focusing with
2800  * direction type @direction.
2801  *
2802  * Return value: a copy of @children, sorted in correct focusing order,
2803  *   with children that aren't suitable for focusing in this direction
2804  *   removed.
2805  **/
2806 GList *
2807 _gtk_container_focus_sort (GtkContainer     *container,
2808                            GList            *children,
2809                            GtkDirectionType  direction,
2810                            GtkWidget        *old_focus)
2811 {
2812   GList *visible_children = NULL;
2813
2814   while (children)
2815     {
2816       if (gtk_widget_get_realized (children->data))
2817         visible_children = g_list_prepend (visible_children, children->data);
2818       children = children->next;
2819     }
2820
2821   switch (direction)
2822     {
2823     case GTK_DIR_TAB_FORWARD:
2824     case GTK_DIR_TAB_BACKWARD:
2825       return gtk_container_focus_sort_tab (container, visible_children, direction, old_focus);
2826     case GTK_DIR_UP:
2827     case GTK_DIR_DOWN:
2828       return gtk_container_focus_sort_up_down (container, visible_children, direction, old_focus);
2829     case GTK_DIR_LEFT:
2830     case GTK_DIR_RIGHT:
2831       return gtk_container_focus_sort_left_right (container, visible_children, direction, old_focus);
2832     }
2833
2834   g_assert_not_reached ();
2835
2836   return NULL;
2837 }
2838
2839 static gboolean
2840 gtk_container_focus_move (GtkContainer     *container,
2841                           GList            *children,
2842                           GtkDirectionType  direction)
2843 {
2844   GtkContainerPrivate *priv = container->priv;
2845   GtkWidget *focus_child;
2846   GtkWidget *child;
2847
2848   focus_child = priv->focus_child;
2849
2850   while (children)
2851     {
2852       child = children->data;
2853       children = children->next;
2854
2855       if (!child)
2856         continue;
2857
2858       if (focus_child)
2859         {
2860           if (focus_child == child)
2861             {
2862               focus_child = NULL;
2863
2864                 if (gtk_widget_child_focus (child, direction))
2865                   return TRUE;
2866             }
2867         }
2868       else if (gtk_widget_is_drawable (child) &&
2869                gtk_widget_is_ancestor (child, GTK_WIDGET (container)))
2870         {
2871           if (gtk_widget_child_focus (child, direction))
2872             return TRUE;
2873         }
2874     }
2875
2876   return FALSE;
2877 }
2878
2879
2880 static void
2881 gtk_container_children_callback (GtkWidget *widget,
2882                                  gpointer   client_data)
2883 {
2884   GList **children;
2885
2886   children = (GList**) client_data;
2887   *children = g_list_prepend (*children, widget);
2888 }
2889
2890 static void
2891 chain_widget_destroyed (GtkWidget *widget,
2892                         gpointer   user_data)
2893 {
2894   GtkContainer *container;
2895   GList *chain;
2896
2897   container = GTK_CONTAINER (user_data);
2898
2899   chain = g_object_get_data (G_OBJECT (container),
2900                              "gtk-container-focus-chain");
2901
2902   chain = g_list_remove (chain, widget);
2903
2904   g_signal_handlers_disconnect_by_func (widget,
2905                                         chain_widget_destroyed,
2906                                         user_data);
2907
2908   g_object_set_data (G_OBJECT (container),
2909                      I_("gtk-container-focus-chain"),
2910                      chain);
2911 }
2912
2913 /**
2914  * gtk_container_set_focus_chain:
2915  * @container: a #GtkContainer
2916  * @focusable_widgets: (transfer none) (element-type GtkWidget):
2917  *     the new focus chain
2918  *
2919  * Sets a focus chain, overriding the one computed automatically by GTK+.
2920  *
2921  * In principle each widget in the chain should be a descendant of the
2922  * container, but this is not enforced by this method, since it's allowed
2923  * to set the focus chain before you pack the widgets, or have a widget
2924  * in the chain that isn't always packed. The necessary checks are done
2925  * when the focus chain is actually traversed.
2926  **/
2927 void
2928 gtk_container_set_focus_chain (GtkContainer *container,
2929                                GList        *focusable_widgets)
2930 {
2931   GList *chain;
2932   GList *tmp_list;
2933   GtkContainerPrivate *priv;
2934
2935   g_return_if_fail (GTK_IS_CONTAINER (container));
2936
2937   priv = container->priv;
2938
2939   if (priv->has_focus_chain)
2940     gtk_container_unset_focus_chain (container);
2941
2942   priv->has_focus_chain = TRUE;
2943
2944   chain = NULL;
2945   tmp_list = focusable_widgets;
2946   while (tmp_list != NULL)
2947     {
2948       g_return_if_fail (GTK_IS_WIDGET (tmp_list->data));
2949
2950       /* In principle each widget in the chain should be a descendant
2951        * of the container, but we don't want to check that here. It's
2952        * expensive and also it's allowed to set the focus chain before
2953        * you pack the widgets, or have a widget in the chain that isn't
2954        * always packed. So we check for ancestor during actual traversal.
2955        */
2956
2957       chain = g_list_prepend (chain, tmp_list->data);
2958
2959       g_signal_connect (tmp_list->data,
2960                         "destroy",
2961                         G_CALLBACK (chain_widget_destroyed),
2962                         container);
2963
2964       tmp_list = g_list_next (tmp_list);
2965     }
2966
2967   chain = g_list_reverse (chain);
2968
2969   g_object_set_data (G_OBJECT (container),
2970                      I_("gtk-container-focus-chain"),
2971                      chain);
2972 }
2973
2974 /**
2975  * gtk_container_get_focus_chain:
2976  * @container:         a #GtkContainer
2977  * @focusable_widgets: (element-type GtkWidget) (out) (transfer container): location
2978  *                     to store the focus chain of the
2979  *                     container, or %NULL. You should free this list
2980  *                     using g_list_free() when you are done with it, however
2981  *                     no additional reference count is added to the
2982  *                     individual widgets in the focus chain.
2983  *
2984  * Retrieves the focus chain of the container, if one has been
2985  * set explicitly. If no focus chain has been explicitly
2986  * set, GTK+ computes the focus chain based on the positions
2987  * of the children. In that case, GTK+ stores %NULL in
2988  * @focusable_widgets and returns %FALSE.
2989  *
2990  * Return value: %TRUE if the focus chain of the container
2991  * has been set explicitly.
2992  **/
2993 gboolean
2994 gtk_container_get_focus_chain (GtkContainer *container,
2995                                GList       **focus_chain)
2996 {
2997   GtkContainerPrivate *priv;
2998
2999   g_return_val_if_fail (GTK_IS_CONTAINER (container), FALSE);
3000
3001   priv = container->priv;
3002
3003   if (focus_chain)
3004     {
3005       if (priv->has_focus_chain)
3006         *focus_chain = g_list_copy (get_focus_chain (container));
3007       else
3008         *focus_chain = NULL;
3009     }
3010
3011   return priv->has_focus_chain;
3012 }
3013
3014 /**
3015  * gtk_container_unset_focus_chain:
3016  * @container: a #GtkContainer
3017  *
3018  * Removes a focus chain explicitly set with gtk_container_set_focus_chain().
3019  **/
3020 void
3021 gtk_container_unset_focus_chain (GtkContainer  *container)
3022 {
3023   GtkContainerPrivate *priv;
3024
3025   g_return_if_fail (GTK_IS_CONTAINER (container));
3026
3027   priv = container->priv;
3028
3029   if (priv->has_focus_chain)
3030     {
3031       GList *chain;
3032       GList *tmp_list;
3033
3034       chain = get_focus_chain (container);
3035
3036       priv->has_focus_chain = FALSE;
3037
3038       g_object_set_data (G_OBJECT (container),
3039                          I_("gtk-container-focus-chain"),
3040                          NULL);
3041
3042       tmp_list = chain;
3043       while (tmp_list != NULL)
3044         {
3045           g_signal_handlers_disconnect_by_func (tmp_list->data,
3046                                                 chain_widget_destroyed,
3047                                                 container);
3048
3049           tmp_list = g_list_next (tmp_list);
3050         }
3051
3052       g_list_free (chain);
3053     }
3054 }
3055
3056 /**
3057  * gtk_container_set_focus_vadjustment:
3058  * @container: a #GtkContainer
3059  * @adjustment: an adjustment which should be adjusted when the focus
3060  *   is moved among the descendents of @container
3061  *
3062  * Hooks up an adjustment to focus handling in a container, so when a
3063  * child of the container is focused, the adjustment is scrolled to
3064  * show that widget. This function sets the vertical alignment. See
3065  * gtk_scrolled_window_get_vadjustment() for a typical way of obtaining
3066  * the adjustment and gtk_container_set_focus_hadjustment() for setting
3067  * the horizontal adjustment.
3068  *
3069  * The adjustments have to be in pixel units and in the same coordinate
3070  * system as the allocation for immediate children of the container.
3071  */
3072 void
3073 gtk_container_set_focus_vadjustment (GtkContainer  *container,
3074                                      GtkAdjustment *adjustment)
3075 {
3076   g_return_if_fail (GTK_IS_CONTAINER (container));
3077   if (adjustment)
3078     g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
3079
3080   if (adjustment)
3081     g_object_ref (adjustment);
3082
3083   g_object_set_qdata_full (G_OBJECT (container),
3084                            vadjustment_key_id,
3085                            adjustment,
3086                            g_object_unref);
3087 }
3088
3089 /**
3090  * gtk_container_get_focus_vadjustment:
3091  * @container: a #GtkContainer
3092  *
3093  * Retrieves the vertical focus adjustment for the container. See
3094  * gtk_container_set_focus_vadjustment().
3095  *
3096  * Return value: (transfer none): the vertical focus adjustment, or %NULL if
3097  *   none has been set.
3098  **/
3099 GtkAdjustment *
3100 gtk_container_get_focus_vadjustment (GtkContainer *container)
3101 {
3102   GtkAdjustment *vadjustment;
3103
3104   g_return_val_if_fail (GTK_IS_CONTAINER (container), NULL);
3105
3106   vadjustment = g_object_get_qdata (G_OBJECT (container), vadjustment_key_id);
3107
3108   return vadjustment;
3109 }
3110
3111 /**
3112  * gtk_container_set_focus_hadjustment:
3113  * @container: a #GtkContainer
3114  * @adjustment: an adjustment which should be adjusted when the focus is
3115  *   moved among the descendents of @container
3116  *
3117  * Hooks up an adjustment to focus handling in a container, so when a child
3118  * of the container is focused, the adjustment is scrolled to show that
3119  * widget. This function sets the horizontal alignment.
3120  * See gtk_scrolled_window_get_hadjustment() for a typical way of obtaining
3121  * the adjustment and gtk_container_set_focus_vadjustment() for setting
3122  * the vertical adjustment.
3123  *
3124  * The adjustments have to be in pixel units and in the same coordinate
3125  * system as the allocation for immediate children of the container.
3126  */
3127 void
3128 gtk_container_set_focus_hadjustment (GtkContainer  *container,
3129                                      GtkAdjustment *adjustment)
3130 {
3131   g_return_if_fail (GTK_IS_CONTAINER (container));
3132   if (adjustment)
3133     g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
3134
3135   if (adjustment)
3136     g_object_ref (adjustment);
3137
3138   g_object_set_qdata_full (G_OBJECT (container),
3139                            hadjustment_key_id,
3140                            adjustment,
3141                            g_object_unref);
3142 }
3143
3144 /**
3145  * gtk_container_get_focus_hadjustment:
3146  * @container: a #GtkContainer
3147  *
3148  * Retrieves the horizontal focus adjustment for the container. See
3149  * gtk_container_set_focus_hadjustment ().
3150  *
3151  * Return value: (transfer none): the horizontal focus adjustment, or %NULL if
3152  *   none has been set.
3153  **/
3154 GtkAdjustment *
3155 gtk_container_get_focus_hadjustment (GtkContainer *container)
3156 {
3157   GtkAdjustment *hadjustment;
3158
3159   g_return_val_if_fail (GTK_IS_CONTAINER (container), NULL);
3160
3161   hadjustment = g_object_get_qdata (G_OBJECT (container), hadjustment_key_id);
3162
3163   return hadjustment;
3164 }
3165
3166
3167 static void
3168 gtk_container_show_all (GtkWidget *widget)
3169 {
3170   g_return_if_fail (GTK_IS_CONTAINER (widget));
3171
3172   gtk_container_foreach (GTK_CONTAINER (widget),
3173                          (GtkCallback) gtk_widget_show_all,
3174                          NULL);
3175   gtk_widget_show (widget);
3176 }
3177
3178 static void
3179 gtk_container_draw_child (GtkWidget *child,
3180                           gpointer   client_data)
3181 {
3182   struct {
3183     GtkWidget *container;
3184     cairo_t *cr;
3185   } *data = client_data;
3186
3187   gtk_container_propagate_draw (GTK_CONTAINER (data->container),
3188                                 child,
3189                                 data->cr);
3190 }
3191
3192 static gint
3193 gtk_container_draw (GtkWidget *widget,
3194                     cairo_t   *cr)
3195 {
3196   struct {
3197     GtkWidget *container;
3198     cairo_t *cr;
3199   } data;
3200
3201   data.container = widget;
3202   data.cr = cr;
3203
3204   gtk_container_forall (GTK_CONTAINER (widget),
3205                         gtk_container_draw_child,
3206                         &data);
3207
3208   return FALSE;
3209 }
3210
3211 static void
3212 gtk_container_map_child (GtkWidget *child,
3213                          gpointer   client_data)
3214 {
3215   if (gtk_widget_get_visible (child) &&
3216       gtk_widget_get_child_visible (child) &&
3217       !gtk_widget_get_mapped (child))
3218     gtk_widget_map (child);
3219 }
3220
3221 static void
3222 gtk_container_map (GtkWidget *widget)
3223 {
3224   gtk_widget_set_mapped (widget, TRUE);
3225
3226   gtk_container_forall (GTK_CONTAINER (widget),
3227                         gtk_container_map_child,
3228                         NULL);
3229
3230   if (gtk_widget_get_has_window (widget))
3231     gdk_window_show (gtk_widget_get_window (widget));
3232 }
3233
3234 static void
3235 gtk_container_unmap (GtkWidget *widget)
3236 {
3237   gtk_widget_set_mapped (widget, FALSE);
3238
3239   /* hide our window first so user doesn't see all the child windows
3240    * vanishing one by one.  (only matters these days if one of the
3241    * children has an actual native window instead of client-side
3242    * window, e.g. a GtkSocket would)
3243    */
3244   if (gtk_widget_get_has_window (widget))
3245     gdk_window_hide (gtk_widget_get_window (widget));
3246
3247   gtk_container_forall (GTK_CONTAINER (widget),
3248                         (GtkCallback)gtk_widget_unmap,
3249                         NULL);
3250 }
3251
3252 /**
3253  * gtk_container_propagate_draw:
3254  * @container: a #GtkContainer
3255  * @child: a child of @container
3256  * @cr: Cairo context as passed to the container. If you want to use @cr
3257  *   in container's draw function, consider using cairo_save() and
3258  *   cairo_restore() before calling this function.
3259  *
3260  * When a container receives a call to the draw function, it must send
3261  * synthetic #GtkWidget::draw calls to all children that don't have their
3262  * own #GdkWindows. This function provides a convenient way of doing this.
3263  * A container, when it receives a call to its #GtkWidget::draw function,
3264  * calls gtk_container_propagate_draw() once for each child, passing in
3265  * the @cr the container received.
3266  *
3267  * gtk_container_propagate_draw() takes care of translating the origin of @cr,
3268  * and deciding whether the draw needs to be sent to the child. It is a
3269  * convenient and optimized way of getting the same effect as calling
3270  * gtk_widget_draw() on the child directly.
3271  *
3272  * In most cases, a container can simply either inherit the
3273  * #GtkWidget::draw implementation from #GtkContainer, or do some drawing
3274  * and then chain to the ::draw implementation from #GtkContainer.
3275  **/
3276 void
3277 gtk_container_propagate_draw (GtkContainer   *container,
3278                               GtkWidget      *child,
3279                               cairo_t        *cr)
3280 {
3281   GdkEventExpose *event;
3282   GtkAllocation allocation;
3283   GdkWindow *window, *w;
3284   int x, y;
3285
3286   g_return_if_fail (GTK_IS_CONTAINER (container));
3287   g_return_if_fail (GTK_IS_WIDGET (child));
3288   g_return_if_fail (cr != NULL);
3289
3290   g_assert (gtk_widget_get_parent (child) == GTK_WIDGET (container));
3291
3292   event = _gtk_cairo_get_event (cr);
3293   if (event)
3294     {
3295       if (gtk_widget_get_has_window (child) ||
3296           gtk_widget_get_window (child) != event->window)
3297         return;
3298     }
3299
3300   cairo_save (cr);
3301
3302   /* translate coordinates. Ugly business, that. */
3303   if (!gtk_widget_get_has_window (GTK_WIDGET (container)))
3304     {
3305       gtk_widget_get_allocation (GTK_WIDGET (container), &allocation);
3306       x = -allocation.x;
3307       y = -allocation.y;
3308     }
3309   else
3310     {
3311       x = 0;
3312       y = 0;
3313     }
3314
3315   window = gtk_widget_get_window (GTK_WIDGET (container));
3316
3317   for (w = gtk_widget_get_window (child); w && w != window; w = gdk_window_get_parent (w))
3318     {
3319       int wx, wy;
3320       gdk_window_get_position (w, &wx, &wy);
3321       x += wx;
3322       y += wy;
3323     }
3324
3325   if (w == NULL)
3326     {
3327       x = 0;
3328       y = 0;
3329     }
3330
3331   if (!gtk_widget_get_has_window (child))
3332     {
3333       gtk_widget_get_allocation (child, &allocation);
3334       x += allocation.x;
3335       y += allocation.y;
3336     }
3337
3338   cairo_translate (cr, x, y);
3339
3340   _gtk_widget_draw_internal (child, cr, TRUE);
3341
3342   cairo_restore (cr);
3343 }
3344
3345 gboolean
3346 _gtk_container_get_need_resize (GtkContainer *container)
3347 {
3348   return container->priv->need_resize;
3349 }
3350
3351 void
3352 _gtk_container_set_need_resize (GtkContainer *container,
3353                                 gboolean      need_resize)
3354 {
3355   container->priv->need_resize = need_resize;
3356 }
3357
3358 gboolean
3359 _gtk_container_get_reallocate_redraws (GtkContainer *container)
3360 {
3361   return container->priv->reallocate_redraws;
3362 }
3363
3364 /**
3365  * gtk_container_get_path_for_child:
3366  * @container: a #GtkContainer
3367  * @child: a child of @container
3368  *
3369  * Returns a newly created widget path representing all the widget hierarchy
3370  * from the toplevel down to and including @child.
3371  *
3372  * Returns: A newly created #GtkWidgetPath
3373  **/
3374 GtkWidgetPath *
3375 gtk_container_get_path_for_child (GtkContainer *container,
3376                                   GtkWidget    *child)
3377 {
3378   g_return_val_if_fail (GTK_IS_CONTAINER (container), NULL);
3379   g_return_val_if_fail (GTK_IS_WIDGET (child), NULL);
3380   g_return_val_if_fail (container == (GtkContainer *) gtk_widget_get_parent (child), NULL);
3381
3382   return GTK_CONTAINER_GET_CLASS (container)->get_path_for_child (container, child);
3383 }