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