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