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