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