* Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
*
* This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Library General Public
+ * modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Library General Public License for more details.
+ * Lesser General Public License for more details.
*
- * You should have received a copy of the GNU Library General Public
+ * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
+
+/*
+ * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
+ * file for a list of people on the GTK+ Team. See the ChangeLog
+ * files for a list of changes. These files are distributed with
+ * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
+ */
+
+#include <config.h>
+#include <stdarg.h>
#include <string.h>
+#include <stdlib.h>
+
#include "gtkcontainer.h"
#include "gtkprivate.h"
-#include "gtksignal.h"
#include "gtkmain.h"
-#include <stdarg.h>
+#include "gtkmarshalers.h"
+#include "gtkwindow.h"
+#include "gtkintl.h"
+#include "gtktoolbar.h"
+#include <gobject/gobjectnotifyqueue.c>
+#include <gobject/gvaluecollector.h>
+#include "gtkalias.h"
enum {
ADD,
REMOVE,
CHECK_RESIZE,
- FOCUS,
SET_FOCUS_CHILD,
LAST_SIGNAL
};
-enum {
- ARG_0,
- ARG_BORDER_WIDTH,
- ARG_RESIZE_MODE,
- ARG_CHILD
-};
-typedef struct _GtkChildArgInfo GtkChildArgInfo;
-struct _GtkChildArgInfo
-{
- gchar *name;
- GtkType type;
- GtkType class_type;
- guint arg_flags;
- guint arg_id;
- guint seq_id;
+enum {
+ PROP_0,
+ PROP_BORDER_WIDTH,
+ PROP_RESIZE_MODE,
+ PROP_CHILD
};
-/* The global list of toplevel windows */
-static GList *toplevel_list = NULL;
-
-static void gtk_container_base_class_init (GtkContainerClass *klass);
-static void gtk_container_class_init (GtkContainerClass *klass);
-static void gtk_container_init (GtkContainer *container);
-static void gtk_container_destroy (GtkObject *object);
-static void gtk_container_get_arg (GtkObject *object,
- GtkArg *arg,
- guint arg_id);
-static void gtk_container_set_arg (GtkObject *object,
- GtkArg *arg,
- guint arg_id);
-static void gtk_container_add_unimplemented (GtkContainer *container,
- GtkWidget *widget);
-static void gtk_container_remove_unimplemented (GtkContainer *container,
- GtkWidget *widget);
-static void gtk_container_real_check_resize (GtkContainer *container);
-static gint gtk_container_real_focus (GtkContainer *container,
- GtkDirectionType direction);
-static void gtk_container_real_set_focus_child (GtkContainer *container,
- GtkWidget *widget);
-static gint gtk_container_focus_tab (GtkContainer *container,
- GList *children,
- GtkDirectionType direction);
-static gint gtk_container_focus_up_down (GtkContainer *container,
- GList *children,
- GtkDirectionType direction);
-static gint gtk_container_focus_left_right (GtkContainer *container,
- GList *children,
- GtkDirectionType direction);
-static gint gtk_container_focus_move (GtkContainer *container,
- GList *children,
- GtkDirectionType direction);
-static void gtk_container_children_callback (GtkWidget *widget,
- gpointer client_data);
-static void gtk_container_show_all (GtkWidget *widget);
-static void gtk_container_hide_all (GtkWidget *widget);
+#define PARAM_SPEC_PARAM_ID(pspec) ((pspec)->param_id)
+#define PARAM_SPEC_SET_PARAM_ID(pspec, id) ((pspec)->param_id = (id))
+
+
+/* --- prototypes --- */
+static void gtk_container_base_class_init (GtkContainerClass *klass);
+static void gtk_container_base_class_finalize (GtkContainerClass *klass);
+static void gtk_container_class_init (GtkContainerClass *klass);
+static void gtk_container_init (GtkContainer *container);
+static void gtk_container_destroy (GtkObject *object);
+static void gtk_container_set_property (GObject *object,
+ guint prop_id,
+ const GValue *value,
+ GParamSpec *pspec);
+static void gtk_container_get_property (GObject *object,
+ guint prop_id,
+ GValue *value,
+ GParamSpec *pspec);
+static void gtk_container_add_unimplemented (GtkContainer *container,
+ GtkWidget *widget);
+static void gtk_container_remove_unimplemented (GtkContainer *container,
+ GtkWidget *widget);
+static void gtk_container_real_check_resize (GtkContainer *container);
+static gboolean gtk_container_focus (GtkWidget *widget,
+ GtkDirectionType direction);
+static void gtk_container_real_set_focus_child (GtkContainer *container,
+ GtkWidget *widget);
+
+static gboolean gtk_container_focus_move (GtkContainer *container,
+ GList *children,
+ GtkDirectionType direction);
+static void gtk_container_children_callback (GtkWidget *widget,
+ gpointer client_data);
+static void gtk_container_show_all (GtkWidget *widget);
+static void gtk_container_hide_all (GtkWidget *widget);
+static gint gtk_container_expose (GtkWidget *widget,
+ GdkEventExpose *event);
+static void gtk_container_map (GtkWidget *widget);
+static void gtk_container_unmap (GtkWidget *widget);
static gchar* gtk_container_child_default_composite_name (GtkContainer *container,
GtkWidget *child);
+/* --- variables --- */
+static const gchar vadjustment_key[] = "gtk-vadjustment";
+static guint vadjustment_key_id = 0;
+static const gchar hadjustment_key[] = "gtk-hadjustment";
+static guint hadjustment_key_id = 0;
+static GSList *container_resize_queue = NULL;
+static guint container_signals[LAST_SIGNAL] = { 0 };
+static GtkWidgetClass *parent_class = NULL;
+extern GParamSpecPool *_gtk_widget_child_property_pool;
+extern GObjectNotifyContext *_gtk_widget_child_property_notify_context;
-static guint container_signals[LAST_SIGNAL] = { 0 };
-static GHashTable *container_child_arg_info_ht = NULL;
-
-static GtkWidgetClass *parent_class = NULL;
-static const gchar *vadjustment_key = "gtk-vadjustment";
-static guint vadjustment_key_id = 0;
-static const gchar *hadjustment_key = "gtk-hadjustment";
-static guint hadjustment_key_id = 0;
-static GSList *container_resize_queue = NULL;
-
-GtkType
+/* --- functions --- */
+GType
gtk_container_get_type (void)
{
- static GtkType container_type = 0;
+ static GType container_type = 0;
if (!container_type)
{
- static const GtkTypeInfo container_info =
+ const GTypeInfo container_info =
{
- "GtkContainer",
- sizeof (GtkContainer),
sizeof (GtkContainerClass),
- (GtkClassInitFunc) gtk_container_class_init,
- (GtkObjectInitFunc) gtk_container_init,
- /* reserved_1 */ NULL,
- /* reserved_2 */ NULL,
- (GtkClassInitFunc) gtk_container_base_class_init,
+ (GBaseInitFunc) gtk_container_base_class_init,
+ (GBaseFinalizeFunc) gtk_container_base_class_finalize,
+ (GClassInitFunc) gtk_container_class_init,
+ NULL /* class_finalize */,
+ NULL /* class_data */,
+ sizeof (GtkContainer),
+ 0 /* n_preallocs */,
+ (GInstanceInitFunc) gtk_container_init,
+ NULL, /* value_table */
};
- container_type = gtk_type_unique (gtk_widget_get_type (), &container_info);
+ container_type =
+ g_type_register_static (GTK_TYPE_WIDGET, I_("GtkContainer"),
+ &container_info, G_TYPE_FLAG_ABSTRACT);
}
return container_type;
gtk_container_base_class_init (GtkContainerClass *class)
{
/* reset instance specifc class fields that don't get inherited */
- class->n_child_args = 0;
- class->set_child_arg = NULL;
- class->get_child_arg = NULL;
+ class->set_child_property = NULL;
+ class->get_child_property = NULL;
}
static void
-gtk_container_class_init (GtkContainerClass *class)
+gtk_container_base_class_finalize (GtkContainerClass *class)
{
- GtkObjectClass *object_class;
- GtkWidgetClass *widget_class;
+ GList *list, *node;
- object_class = (GtkObjectClass*) class;
- widget_class = (GtkWidgetClass*) class;
+ list = g_param_spec_pool_list_owned (_gtk_widget_child_property_pool, G_OBJECT_CLASS_TYPE (class));
+ for (node = list; node; node = node->next)
+ {
+ GParamSpec *pspec = node->data;
+
+ g_param_spec_pool_remove (_gtk_widget_child_property_pool, pspec);
+ PARAM_SPEC_SET_PARAM_ID (pspec, 0);
+ g_param_spec_unref (pspec);
+ }
+ g_list_free (list);
+}
- parent_class = gtk_type_class (gtk_widget_get_type ());
+static void
+gtk_container_class_init (GtkContainerClass *class)
+{
+ GObjectClass *gobject_class = G_OBJECT_CLASS (class);
+ GtkObjectClass *object_class = GTK_OBJECT_CLASS (class);
+ GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
- container_child_arg_info_ht = g_hash_table_new (gtk_arg_info_hash,
- gtk_arg_info_equal);
+ parent_class = g_type_class_peek_parent (class);
vadjustment_key_id = g_quark_from_static_string (vadjustment_key);
hadjustment_key_id = g_quark_from_static_string (hadjustment_key);
- gtk_object_add_arg_type ("GtkContainer::border_width", GTK_TYPE_ULONG, GTK_ARG_READWRITE, ARG_BORDER_WIDTH);
- gtk_object_add_arg_type ("GtkContainer::resize_mode", GTK_TYPE_RESIZE_MODE, GTK_ARG_READWRITE, ARG_RESIZE_MODE);
- gtk_object_add_arg_type ("GtkContainer::child", GTK_TYPE_WIDGET, GTK_ARG_WRITABLE, ARG_CHILD);
+ gobject_class->set_property = gtk_container_set_property;
+ gobject_class->get_property = gtk_container_get_property;
- container_signals[ADD] =
- gtk_signal_new ("add",
- GTK_RUN_FIRST,
- object_class->type,
- GTK_SIGNAL_OFFSET (GtkContainerClass, add),
- gtk_marshal_NONE__POINTER,
- GTK_TYPE_NONE, 1,
- GTK_TYPE_WIDGET);
- container_signals[REMOVE] =
- gtk_signal_new ("remove",
- GTK_RUN_FIRST,
- object_class->type,
- GTK_SIGNAL_OFFSET (GtkContainerClass, remove),
- gtk_marshal_NONE__POINTER,
- GTK_TYPE_NONE, 1,
- GTK_TYPE_WIDGET);
- container_signals[CHECK_RESIZE] =
- gtk_signal_new ("check_resize",
- GTK_RUN_LAST,
- object_class->type,
- GTK_SIGNAL_OFFSET (GtkContainerClass, check_resize),
- gtk_marshal_NONE__NONE,
- GTK_TYPE_NONE, 0);
- container_signals[FOCUS] =
- gtk_signal_new ("focus",
- GTK_RUN_LAST,
- object_class->type,
- GTK_SIGNAL_OFFSET (GtkContainerClass, focus),
- gtk_marshal_ENUM__ENUM,
- GTK_TYPE_DIRECTION_TYPE, 1,
- GTK_TYPE_DIRECTION_TYPE);
- container_signals[SET_FOCUS_CHILD] =
- gtk_signal_new ("set-focus-child",
- GTK_RUN_FIRST,
- object_class->type,
- GTK_SIGNAL_OFFSET (GtkContainerClass, set_focus_child),
- gtk_marshal_NONE__POINTER,
- GTK_TYPE_NONE, 1,
- GTK_TYPE_WIDGET);
- gtk_object_class_add_signals (object_class, container_signals, LAST_SIGNAL);
-
- object_class->get_arg = gtk_container_get_arg;
- object_class->set_arg = gtk_container_set_arg;
object_class->destroy = gtk_container_destroy;
widget_class->show_all = gtk_container_show_all;
widget_class->hide_all = gtk_container_hide_all;
+ widget_class->expose_event = gtk_container_expose;
+ widget_class->map = gtk_container_map;
+ widget_class->unmap = gtk_container_unmap;
+ widget_class->focus = gtk_container_focus;
class->add = gtk_container_add_unimplemented;
class->remove = gtk_container_remove_unimplemented;
class->check_resize = gtk_container_real_check_resize;
class->forall = NULL;
- class->focus = gtk_container_real_focus;
class->set_focus_child = gtk_container_real_set_focus_child;
class->child_type = NULL;
class->composite_name = gtk_container_child_default_composite_name;
+
+ g_object_class_install_property (gobject_class,
+ PROP_RESIZE_MODE,
+ g_param_spec_enum ("resize-mode",
+ P_("Resize mode"),
+ P_("Specify how resize events are handled"),
+ GTK_TYPE_RESIZE_MODE,
+ GTK_RESIZE_PARENT,
+ GTK_PARAM_READWRITE));
+ g_object_class_install_property (gobject_class,
+ PROP_BORDER_WIDTH,
+ g_param_spec_uint ("border-width",
+ P_("Border width"),
+ P_("The width of the empty border outside the containers children"),
+ 0,
+ G_MAXINT,
+ 0,
+ GTK_PARAM_READWRITE));
+ g_object_class_install_property (gobject_class,
+ PROP_CHILD,
+ g_param_spec_object ("child",
+ P_("Child"),
+ P_("Can be used to add a new child to the container"),
+ GTK_TYPE_WIDGET,
+ GTK_PARAM_WRITABLE));
+ container_signals[ADD] =
+ g_signal_new (I_("add"),
+ G_OBJECT_CLASS_TYPE (object_class),
+ G_SIGNAL_RUN_FIRST,
+ G_STRUCT_OFFSET (GtkContainerClass, add),
+ NULL, NULL,
+ _gtk_marshal_VOID__OBJECT,
+ G_TYPE_NONE, 1,
+ GTK_TYPE_WIDGET);
+ container_signals[REMOVE] =
+ g_signal_new (I_("remove"),
+ G_OBJECT_CLASS_TYPE (object_class),
+ G_SIGNAL_RUN_FIRST,
+ G_STRUCT_OFFSET (GtkContainerClass, remove),
+ NULL, NULL,
+ _gtk_marshal_VOID__OBJECT,
+ G_TYPE_NONE, 1,
+ GTK_TYPE_WIDGET);
+ container_signals[CHECK_RESIZE] =
+ g_signal_new (I_("check_resize"),
+ G_OBJECT_CLASS_TYPE (object_class),
+ G_SIGNAL_RUN_LAST,
+ G_STRUCT_OFFSET (GtkContainerClass, check_resize),
+ NULL, NULL,
+ _gtk_marshal_VOID__VOID,
+ G_TYPE_NONE, 0);
+ container_signals[SET_FOCUS_CHILD] =
+ g_signal_new (I_("set-focus-child"),
+ G_OBJECT_CLASS_TYPE (object_class),
+ G_SIGNAL_RUN_FIRST,
+ G_STRUCT_OFFSET (GtkContainerClass, set_focus_child),
+ NULL, NULL,
+ _gtk_marshal_VOID__OBJECT,
+ G_TYPE_NONE, 1,
+ GTK_TYPE_WIDGET);
}
-GtkType
-gtk_container_child_type (GtkContainer *container)
+/**
+ * gtk_container_child_type:
+ * @container: a #GtkContainer.
+ *
+ * Returns the type of the children supported by the container.
+ *
+ * Note that this may return %G_TYPE_NONE to indicate that no more
+ * children can be added, e.g. for a #GtkPaned which already has two
+ * children.
+ *
+ * Return value: a #GType.
+ **/
+GType
+gtk_container_child_type (GtkContainer *container)
{
- GtkType slot;
+ GType slot;
GtkContainerClass *class;
- g_return_val_if_fail (container != NULL, 0);
g_return_val_if_fail (GTK_IS_CONTAINER (container), 0);
- class = GTK_CONTAINER_CLASS (GTK_OBJECT (container)->klass);
+ class = GTK_CONTAINER_GET_CLASS (container);
if (class->child_type)
slot = class->child_type (container);
else
- slot = GTK_TYPE_NONE;
+ slot = G_TYPE_NONE;
return slot;
}
-/****************************************************
- * GtkContainer child argument mechanism
- *
- ****************************************************/
+/* --- GtkContainer child property mechanism --- */
+static inline void
+container_get_child_property (GtkContainer *container,
+ GtkWidget *child,
+ GParamSpec *pspec,
+ GValue *value)
+{
+ GtkContainerClass *class = g_type_class_peek (pspec->owner_type);
+
+ class->get_child_property (container, child, PARAM_SPEC_PARAM_ID (pspec), value, pspec);
+}
+
+static inline void
+container_set_child_property (GtkContainer *container,
+ GtkWidget *child,
+ GParamSpec *pspec,
+ const GValue *value,
+ GObjectNotifyQueue *nqueue)
+{
+ GValue tmp_value = { 0, };
+ GtkContainerClass *class = g_type_class_peek (pspec->owner_type);
+
+ /* provide a copy to work from, convert (if necessary) and validate */
+ g_value_init (&tmp_value, G_PARAM_SPEC_VALUE_TYPE (pspec));
+ if (!g_value_transform (value, &tmp_value))
+ g_warning ("unable to set child property `%s' of type `%s' from value of type `%s'",
+ pspec->name,
+ g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
+ G_VALUE_TYPE_NAME (value));
+ else if (g_param_value_validate (pspec, &tmp_value) && !(pspec->flags & G_PARAM_LAX_VALIDATION))
+ {
+ gchar *contents = g_strdup_value_contents (value);
+
+ g_warning ("value \"%s\" of type `%s' is invalid for property `%s' of type `%s'",
+ contents,
+ G_VALUE_TYPE_NAME (value),
+ pspec->name,
+ g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)));
+ g_free (contents);
+ }
+ else
+ {
+ class->set_child_property (container, child, PARAM_SPEC_PARAM_ID (pspec), &tmp_value, pspec);
+ g_object_notify_queue_add (G_OBJECT (child), nqueue, pspec);
+ }
+ g_value_unset (&tmp_value);
+}
+/**
+ * gtk_container_child_get_valist:
+ * @container: a #GtkContainer
+ * @child: a widget which is a child of @container
+ * @first_property_name: the name of the first property to get
+ * @var_args: a %NULL-terminated list of property names and #GValue*,
+ * starting with @first_prop_name.
+ *
+ * Gets the values of one or more child properties for @child and @container.
+ **/
void
-gtk_container_add_with_args (GtkContainer *container,
- GtkWidget *widget,
- const gchar *first_arg_name,
- ...)
+gtk_container_child_get_valist (GtkContainer *container,
+ GtkWidget *child,
+ const gchar *first_property_name,
+ va_list var_args)
{
- g_return_if_fail (container != NULL);
+ const gchar *name;
+
g_return_if_fail (GTK_IS_CONTAINER (container));
- g_return_if_fail (widget != NULL);
- g_return_if_fail (GTK_IS_WIDGET (widget));
- g_return_if_fail (widget->parent == NULL);
+ g_return_if_fail (GTK_IS_WIDGET (child));
+ g_return_if_fail (child->parent == GTK_WIDGET (container));
- gtk_widget_ref (GTK_WIDGET (container));
- gtk_widget_ref (widget);
+ g_object_ref (container);
+ g_object_ref (child);
- gtk_signal_emit (GTK_OBJECT (container), container_signals[ADD], widget);
-
- if (widget->parent)
+ name = first_property_name;
+ while (name)
{
- va_list var_args;
- GSList *arg_list = NULL;
- GSList *info_list = NULL;
+ GValue value = { 0, };
+ GParamSpec *pspec;
gchar *error;
-
- va_start (var_args, first_arg_name);
- error = gtk_container_child_args_collect (GTK_OBJECT_TYPE (container),
- &arg_list,
- &info_list,
- first_arg_name,
- var_args);
- va_end (var_args);
+ pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
+ name,
+ G_OBJECT_TYPE (container),
+ TRUE);
+ if (!pspec)
+ {
+ g_warning ("%s: container class `%s' has no child property named `%s'",
+ G_STRLOC,
+ G_OBJECT_TYPE_NAME (container),
+ name);
+ break;
+ }
+ if (!(pspec->flags & G_PARAM_READABLE))
+ {
+ g_warning ("%s: child property `%s' of container class `%s' is not readable",
+ G_STRLOC,
+ pspec->name,
+ G_OBJECT_TYPE_NAME (container));
+ break;
+ }
+ g_value_init (&value, G_PARAM_SPEC_VALUE_TYPE (pspec));
+ container_get_child_property (container, child, pspec, &value);
+ G_VALUE_LCOPY (&value, var_args, 0, &error);
if (error)
{
- g_warning ("gtk_container_add_with_args(): %s", error);
+ g_warning ("%s: %s", G_STRLOC, error);
g_free (error);
+ g_value_unset (&value);
+ break;
+ }
+ g_value_unset (&value);
+ name = va_arg (var_args, gchar*);
+ }
+
+ g_object_unref (child);
+ g_object_unref (container);
+}
+
+/**
+ * gtk_container_child_get_property:
+ * @container: a #GtkContainer
+ * @child: a widget which is a child of @container
+ * @property_name: the name of the property to get
+ * @value: a location to return the value
+ *
+ * Gets the value of a child property for @child and @container.
+ **/
+void
+gtk_container_child_get_property (GtkContainer *container,
+ GtkWidget *child,
+ const gchar *property_name,
+ GValue *value)
+{
+ GParamSpec *pspec;
+
+ g_return_if_fail (GTK_IS_CONTAINER (container));
+ g_return_if_fail (GTK_IS_WIDGET (child));
+ g_return_if_fail (child->parent == GTK_WIDGET (container));
+ g_return_if_fail (property_name != NULL);
+ g_return_if_fail (G_IS_VALUE (value));
+
+ g_object_ref (container);
+ g_object_ref (child);
+ pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool, property_name,
+ G_OBJECT_TYPE (container), TRUE);
+ if (!pspec)
+ g_warning ("%s: container class `%s' has no child property named `%s'",
+ G_STRLOC,
+ G_OBJECT_TYPE_NAME (container),
+ property_name);
+ else if (!(pspec->flags & G_PARAM_READABLE))
+ g_warning ("%s: child property `%s' of container class `%s' is not readable",
+ G_STRLOC,
+ pspec->name,
+ G_OBJECT_TYPE_NAME (container));
+ else
+ {
+ GValue *prop_value, tmp_value = { 0, };
+
+ /* auto-conversion of the callers value type
+ */
+ if (G_VALUE_TYPE (value) == G_PARAM_SPEC_VALUE_TYPE (pspec))
+ {
+ g_value_reset (value);
+ prop_value = value;
+ }
+ else if (!g_value_type_transformable (G_PARAM_SPEC_VALUE_TYPE (pspec), G_VALUE_TYPE (value)))
+ {
+ g_warning ("can't retrieve child property `%s' of type `%s' as value of type `%s'",
+ pspec->name,
+ g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
+ G_VALUE_TYPE_NAME (value));
+ g_object_unref (child);
+ g_object_unref (container);
+ return;
}
else
{
- GSList *slist_arg;
- GSList *slist_info;
-
- slist_arg = arg_list;
- slist_info = info_list;
- while (slist_arg)
- {
- gtk_container_arg_set (container, widget, slist_arg->data, slist_info->data);
- slist_arg = slist_arg->next;
- slist_info = slist_info->next;
- }
- gtk_args_collect_cleanup (arg_list, info_list);
+ g_value_init (&tmp_value, G_PARAM_SPEC_VALUE_TYPE (pspec));
+ prop_value = &tmp_value;
+ }
+ container_get_child_property (container, child, pspec, prop_value);
+ if (prop_value != value)
+ {
+ g_value_transform (prop_value, value);
+ g_value_unset (&tmp_value);
}
}
-
- gtk_widget_unref (widget);
- gtk_widget_unref (GTK_WIDGET (container));
+ g_object_unref (child);
+ g_object_unref (container);
}
+/**
+ * gtk_container_child_set_valist:
+ * @container: a #GtkContainer
+ * @child: a widget which is a child of @container
+ * @first_property_name: the name of the first property to set
+ * @var_args: a %NULL-terminated list of property names and values, starting
+ * with @first_prop_name.
+ *
+ * Sets one or more child properties for @child and @container.
+ **/
void
-gtk_container_addv (GtkContainer *container,
- GtkWidget *widget,
- guint n_args,
- GtkArg *args)
+gtk_container_child_set_valist (GtkContainer *container,
+ GtkWidget *child,
+ const gchar *first_property_name,
+ va_list var_args)
{
- g_return_if_fail (container != NULL);
+ GObjectNotifyQueue *nqueue;
+ const gchar *name;
+
g_return_if_fail (GTK_IS_CONTAINER (container));
- g_return_if_fail (widget != NULL);
- g_return_if_fail (GTK_IS_WIDGET (widget));
- g_return_if_fail (widget->parent == NULL);
+ g_return_if_fail (GTK_IS_WIDGET (child));
+ g_return_if_fail (child->parent == GTK_WIDGET (container));
- gtk_widget_ref (GTK_WIDGET (container));
- gtk_widget_ref (widget);
+ g_object_ref (container);
+ g_object_ref (child);
- gtk_signal_emit (GTK_OBJECT (container), container_signals[ADD], widget);
-
- if (widget->parent)
+ nqueue = g_object_notify_queue_freeze (G_OBJECT (child), _gtk_widget_child_property_notify_context);
+ name = first_property_name;
+ while (name)
{
- GtkArg *max_args;
+ GValue value = { 0, };
+ gchar *error = NULL;
+ GParamSpec *pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
+ name,
+ G_OBJECT_TYPE (container),
+ TRUE);
+ if (!pspec)
+ {
+ g_warning ("%s: container class `%s' has no child property named `%s'",
+ G_STRLOC,
+ G_OBJECT_TYPE_NAME (container),
+ name);
+ break;
+ }
+ if (!(pspec->flags & G_PARAM_WRITABLE))
+ {
+ g_warning ("%s: child property `%s' of container class `%s' is not writable",
+ G_STRLOC,
+ pspec->name,
+ G_OBJECT_TYPE_NAME (container));
+ break;
+ }
+ g_value_init (&value, G_PARAM_SPEC_VALUE_TYPE (pspec));
+ G_VALUE_COLLECT (&value, var_args, 0, &error);
+ if (error)
+ {
+ g_warning ("%s: %s", G_STRLOC, error);
+ g_free (error);
- for (max_args = args + n_args; args < max_args; args++)
- gtk_container_arg_set (container, widget, args, NULL);
+ /* we purposely leak the value here, it might not be
+ * in a sane state if an error condition occoured
+ */
+ break;
+ }
+ container_set_child_property (container, child, pspec, &value, nqueue);
+ g_value_unset (&value);
+ name = va_arg (var_args, gchar*);
}
+ g_object_notify_queue_thaw (G_OBJECT (child), nqueue);
- gtk_widget_unref (widget);
- gtk_widget_unref (GTK_WIDGET (container));
+ g_object_unref (container);
+ g_object_unref (child);
}
+/**
+ * gtk_container_child_set_property:
+ * @container: a #GtkContainer
+ * @child: a widget which is a child of @container
+ * @property_name: the name of the property to set
+ * @value: the value to set the property to
+ *
+ * Sets a child property for @child and @container.
+ **/
void
-gtk_container_child_setv (GtkContainer *container,
- GtkWidget *child,
- guint n_args,
- GtkArg *args)
+gtk_container_child_set_property (GtkContainer *container,
+ GtkWidget *child,
+ const gchar *property_name,
+ const GValue *value)
{
- GtkArg *max_args;
+ GObjectNotifyQueue *nqueue;
+ GParamSpec *pspec;
- g_return_if_fail (container != NULL);
g_return_if_fail (GTK_IS_CONTAINER (container));
- g_return_if_fail (child != NULL);
g_return_if_fail (GTK_IS_WIDGET (child));
- g_return_if_fail (child->parent != NULL);
- if (n_args)
- g_return_if_fail (args != NULL);
-
- for (max_args = args + n_args; args < max_args; args++)
- gtk_container_arg_set (container, child, args, NULL);
+ g_return_if_fail (child->parent == GTK_WIDGET (container));
+ g_return_if_fail (property_name != NULL);
+ g_return_if_fail (G_IS_VALUE (value));
+
+ g_object_ref (container);
+ g_object_ref (child);
+
+ nqueue = g_object_notify_queue_freeze (G_OBJECT (child), _gtk_widget_child_property_notify_context);
+ pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool, property_name,
+ G_OBJECT_TYPE (container), TRUE);
+ if (!pspec)
+ g_warning ("%s: container class `%s' has no child property named `%s'",
+ G_STRLOC,
+ G_OBJECT_TYPE_NAME (container),
+ property_name);
+ else if (!(pspec->flags & G_PARAM_WRITABLE))
+ g_warning ("%s: child property `%s' of container class `%s' is not writable",
+ G_STRLOC,
+ pspec->name,
+ G_OBJECT_TYPE_NAME (container));
+ else
+ {
+ container_set_child_property (container, child, pspec, value, nqueue);
+ }
+ g_object_notify_queue_thaw (G_OBJECT (child), nqueue);
+ g_object_unref (container);
+ g_object_unref (child);
}
+/**
+ * gtk_container_add_with_properties:
+ * @container: a #GtkContainer
+ * @widget: a widget to be placed inside @container
+ * @first_prop_name: the name of the first child property to set
+ * @Varargs: a %NULL-terminated list of property names and values, starting
+ * with @first_prop_name.
+ *
+ * Adds @widget to @container, setting child properties at the same time.
+ * See gtk_container_add() and gtk_container_child_set() for more details.
+ **/
void
-gtk_container_child_getv (GtkContainer *container,
- GtkWidget *child,
- guint n_args,
- GtkArg *args)
+gtk_container_add_with_properties (GtkContainer *container,
+ GtkWidget *widget,
+ const gchar *first_prop_name,
+ ...)
{
- GtkArg *max_args;
-
- g_return_if_fail (container != NULL);
g_return_if_fail (GTK_IS_CONTAINER (container));
- g_return_if_fail (child != NULL);
- g_return_if_fail (GTK_IS_WIDGET (child));
- g_return_if_fail (child->parent != NULL);
- if (n_args)
- g_return_if_fail (args != NULL);
+ g_return_if_fail (GTK_IS_WIDGET (widget));
+ g_return_if_fail (widget->parent == NULL);
+
+ g_object_ref (container);
+ g_object_ref (widget);
+ gtk_widget_freeze_child_notify (widget);
+
+ g_signal_emit (container, container_signals[ADD], 0, widget);
+ if (widget->parent)
+ {
+ va_list var_args;
+
+ va_start (var_args, first_prop_name);
+ gtk_container_child_set_valist (container, widget, first_prop_name, var_args);
+ va_end (var_args);
+ }
- for (max_args = args + n_args; args < max_args; args++)
- gtk_container_arg_get (container, child, args, NULL);
+ gtk_widget_thaw_child_notify (widget);
+ g_object_unref (widget);
+ g_object_unref (container);
}
+/**
+ * gtk_container_child_set:
+ * @container: a #GtkContainer
+ * @child: a widget which is a child of @container
+ * @first_prop_name: the name of the first property to set
+ * @Varargs: a %NULL-terminated list of property names and values, starting
+ * with @first_prop_name.
+ *
+ * Sets one or more child properties for @child and @container.
+ **/
void
gtk_container_child_set (GtkContainer *container,
GtkWidget *child,
- const gchar *first_arg_name,
+ const gchar *first_prop_name,
...)
{
va_list var_args;
- GSList *arg_list = NULL;
- GSList *info_list = NULL;
- gchar *error;
- g_return_if_fail (container != NULL);
g_return_if_fail (GTK_IS_CONTAINER (container));
- g_return_if_fail (child != NULL);
g_return_if_fail (GTK_IS_WIDGET (child));
- g_return_if_fail (child->parent != NULL);
-
- va_start (var_args, first_arg_name);
- error = gtk_container_child_args_collect (GTK_OBJECT_TYPE (container),
- &arg_list,
- &info_list,
- first_arg_name,
- var_args);
- va_end (var_args);
-
- if (error)
- {
- g_warning ("gtk_container_child_set(): %s", error);
- g_free (error);
- }
- else
- {
- GSList *slist_arg;
- GSList *slist_info;
+ g_return_if_fail (child->parent == GTK_WIDGET (container));
- slist_arg = arg_list;
- slist_info = info_list;
- while (slist_arg)
- {
- gtk_container_arg_set (container, child, slist_arg->data, slist_info->data);
- slist_arg = slist_arg->next;
- slist_info = slist_info->next;
- }
- gtk_args_collect_cleanup (arg_list, info_list);
- }
+ va_start (var_args, first_prop_name);
+ gtk_container_child_set_valist (container, child, first_prop_name, var_args);
+ va_end (var_args);
}
+/**
+ * gtk_container_child_get:
+ * @container: a #GtkContainer
+ * @child: a widget which is a child of @container
+ * @first_prop_name: the name of the first property to get
+ * @Varargs: a %NULL-terminated list of property names and #GValue*,
+ * starting with @first_prop_name.
+ *
+ * Gets the values of one or more child properties for @child and @container.
+ **/
void
-gtk_container_arg_set (GtkContainer *container,
- GtkWidget *child,
- GtkArg *arg,
- GtkArgInfo *info)
+gtk_container_child_get (GtkContainer *container,
+ GtkWidget *child,
+ const gchar *first_prop_name,
+ ...)
{
- GtkContainerClass *class;
+ va_list var_args;
- g_return_if_fail (container != NULL);
g_return_if_fail (GTK_IS_CONTAINER (container));
- g_return_if_fail (child != NULL);
g_return_if_fail (GTK_IS_WIDGET (child));
- g_return_if_fail (arg != NULL);
-
- if (!info)
- {
- gchar *error;
-
- error = gtk_arg_get_info (GTK_OBJECT_TYPE (container),
- container_child_arg_info_ht,
- arg->name,
- &info);
- if (error)
- {
- g_warning ("gtk_container_arg_set(): %s", error);
- g_free (error);
- return;
- }
- }
- g_return_if_fail (info->arg_flags & GTK_ARG_CHILD_ARG);
-
- if (! (info->arg_flags & GTK_ARG_WRITABLE))
- {
- g_warning ("gtk_container_arg_set(): argument \"%s\" is not writable",
- info->full_name);
- return;
- }
- if (info->type != arg->type)
- {
- g_warning ("gtk_container_arg_set(): argument \"%s\" has invalid type `%s'",
- info->full_name,
- gtk_type_name (arg->type));
- return;
- }
-
- class = gtk_type_class (info->class_type);
- g_assert (class->set_child_arg != NULL);
- class->set_child_arg (container, child, arg, info->arg_id);
+ g_return_if_fail (child->parent == GTK_WIDGET (container));
+
+ va_start (var_args, first_prop_name);
+ gtk_container_child_get_valist (container, child, first_prop_name, var_args);
+ va_end (var_args);
}
+/**
+ * gtk_container_class_install_child_property:
+ * @cclass: a #GtkContainerClass
+ * @property_id: the id for the property
+ * @pspec: the #GParamSpec for the property
+ *
+ * Installs a child property on a container class.
+ **/
void
-gtk_container_arg_get (GtkContainer *container,
- GtkWidget *child,
- GtkArg *arg,
- GtkArgInfo *info)
+gtk_container_class_install_child_property (GtkContainerClass *cclass,
+ guint property_id,
+ GParamSpec *pspec)
{
- GtkContainerClass *class;
-
- g_return_if_fail (container != NULL);
- g_return_if_fail (GTK_IS_CONTAINER (container));
- g_return_if_fail (child != NULL);
- g_return_if_fail (GTK_IS_WIDGET (child));
- g_return_if_fail (arg != NULL);
-
- if (!info)
- {
- gchar *error;
-
- error = gtk_arg_get_info (GTK_OBJECT_TYPE (container),
- container_child_arg_info_ht,
- arg->name,
- &info);
- if (error)
- {
- g_warning ("gtk_container_arg_get(): %s", error);
- g_free (error);
- arg->type = GTK_TYPE_INVALID;
- return;
- }
- }
- g_return_if_fail (info->arg_flags & GTK_ARG_CHILD_ARG);
-
- if (! (info->arg_flags & GTK_ARG_READABLE))
+ g_return_if_fail (GTK_IS_CONTAINER_CLASS (cclass));
+ g_return_if_fail (G_IS_PARAM_SPEC (pspec));
+ if (pspec->flags & G_PARAM_WRITABLE)
+ g_return_if_fail (cclass->set_child_property != NULL);
+ if (pspec->flags & G_PARAM_READABLE)
+ g_return_if_fail (cclass->get_child_property != NULL);
+ g_return_if_fail (property_id > 0);
+ g_return_if_fail (PARAM_SPEC_PARAM_ID (pspec) == 0); /* paranoid */
+ if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
+ g_return_if_fail ((pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY)) == 0);
+
+ if (g_param_spec_pool_lookup (_gtk_widget_child_property_pool, pspec->name, G_OBJECT_CLASS_TYPE (cclass), FALSE))
{
- g_warning ("gtk_container_arg_get(): argument \"%s\" is not readable",
- info->full_name);
- arg->type = GTK_TYPE_INVALID;
+ g_warning (G_STRLOC ": class `%s' already contains a child property named `%s'",
+ G_OBJECT_CLASS_NAME (cclass),
+ pspec->name);
return;
}
-
- class = gtk_type_class (info->class_type);
- g_assert (class->get_child_arg != NULL);
- arg->type = info->type;
- class->get_child_arg (container, child, arg, info->arg_id);
+ g_param_spec_ref (pspec);
+ g_param_spec_sink (pspec);
+ PARAM_SPEC_SET_PARAM_ID (pspec, property_id);
+ g_param_spec_pool_insert (_gtk_widget_child_property_pool, pspec, G_OBJECT_CLASS_TYPE (cclass));
}
-void
-gtk_container_add_child_arg_type (const gchar *arg_name,
- GtkType arg_type,
- guint arg_flags,
- guint arg_id)
+/**
+ * gtk_container_class_find_child_property:
+ * @cclass: a #GtkContainerClass
+ * @property_name: the name of the child property to find
+ * @returns: the #GParamSpec of the child property or %NULL if @class has no
+ * child property with that name.
+ *
+ * Finds a child property of a container class by name.
+ */
+GParamSpec*
+gtk_container_class_find_child_property (GObjectClass *cclass,
+ const gchar *property_name)
{
- g_return_if_fail (arg_name != NULL);
- g_return_if_fail (arg_type > GTK_TYPE_NONE);
- g_return_if_fail (arg_id > 0);
- g_return_if_fail ((arg_flags & GTK_ARG_READWRITE) == GTK_ARG_READWRITE);
- /* g_return_if_fail ((arg_flags & GTK_ARG_CHILD_ARG) != 0); */
+ g_return_val_if_fail (GTK_IS_CONTAINER_CLASS (cclass), NULL);
+ g_return_val_if_fail (property_name != NULL, NULL);
- arg_flags |= GTK_ARG_CHILD_ARG;
- arg_flags &= GTK_ARG_MASK;
-
- gtk_arg_type_new_static (GTK_TYPE_CONTAINER,
- arg_name,
- GTK_STRUCT_OFFSET (GtkContainerClass, n_child_args),
- container_child_arg_info_ht,
- arg_type,
- arg_flags,
- arg_id);
+ return g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
+ property_name,
+ G_OBJECT_CLASS_TYPE (cclass),
+ TRUE);
}
-gchar*
-gtk_container_child_args_collect (GtkType object_type,
- GSList **arg_list_p,
- GSList **info_list_p,
- const gchar *first_arg_name,
- va_list var_args)
+/**
+ * gtk_container_class_list_child_properties:
+ * @cclass: a #GtkContainerClass
+ * @n_properties: location to return the number of child properties found
+ * @returns: a newly allocated array of #GParamSpec*. The array must be
+ * freed with g_free().
+ *
+ * Returns all child properties of a container class.
+ */
+GParamSpec**
+gtk_container_class_list_child_properties (GObjectClass *cclass,
+ guint *n_properties)
{
- return gtk_args_collect (object_type,
- container_child_arg_info_ht,
- arg_list_p,
- info_list_p,
- first_arg_name,
- var_args);
-}
+ GParamSpec **pspecs;
+ guint n;
-gchar*
-gtk_container_child_arg_get_info (GtkType object_type,
- const gchar *arg_name,
- GtkArgInfo **info_p)
-{
- return gtk_arg_get_info (object_type,
- container_child_arg_info_ht,
- arg_name,
- info_p);
-}
+ g_return_val_if_fail (GTK_IS_CONTAINER_CLASS (cclass), NULL);
-GtkArg*
-gtk_container_query_child_args (GtkType class_type,
- guint32 **arg_flags,
- guint *n_args)
-{
- g_return_val_if_fail (n_args != NULL, NULL);
- *n_args = 0;
- g_return_val_if_fail (gtk_type_is_a (class_type, GTK_TYPE_CONTAINER), NULL);
+ pspecs = g_param_spec_pool_list (_gtk_widget_child_property_pool,
+ G_OBJECT_CLASS_TYPE (cclass),
+ &n);
+ if (n_properties)
+ *n_properties = n;
- return gtk_args_query (class_type, container_child_arg_info_ht, arg_flags, n_args);
+ return pspecs;
}
-
static void
gtk_container_add_unimplemented (GtkContainer *container,
GtkWidget *widget)
{
- g_warning ("GtkContainerClass::add not implemented for `%s'", gtk_type_name (GTK_OBJECT_TYPE (container)));
+ g_warning ("GtkContainerClass::add not implemented for `%s'", g_type_name (G_TYPE_FROM_INSTANCE (container)));
}
static void
gtk_container_remove_unimplemented (GtkContainer *container,
GtkWidget *widget)
{
- g_warning ("GtkContainerClass::remove not implemented for `%s'", gtk_type_name (GTK_OBJECT_TYPE (container)));
+ g_warning ("GtkContainerClass::remove not implemented for `%s'", g_type_name (G_TYPE_FROM_INSTANCE (container)));
}
static void
container->border_width = 0;
container->need_resize = FALSE;
container->resize_mode = GTK_RESIZE_PARENT;
- container->resize_widgets = NULL;
+ container->reallocate_redraws = FALSE;
}
static void
gtk_container_destroy (GtkObject *object)
{
- GtkContainer *container;
-
- g_return_if_fail (object != NULL);
- g_return_if_fail (GTK_IS_CONTAINER (object));
-
- container = GTK_CONTAINER (object);
+ GtkContainer *container = GTK_CONTAINER (object);
if (GTK_CONTAINER_RESIZE_PENDING (container))
- {
- container_resize_queue = g_slist_remove (container_resize_queue, container);
- GTK_PRIVATE_UNSET_FLAG (container, GTK_RESIZE_PENDING);
- }
- gtk_container_clear_resize_widgets (container);
+ _gtk_container_dequeue_resize_handler (container);
+
+ /* do this before walking child widgets, to avoid
+ * removing children from focus chain one by one.
+ */
+ if (container->has_focus_chain)
+ gtk_container_unset_focus_chain (container);
gtk_container_foreach (container, (GtkCallback) gtk_widget_destroy, NULL);
}
static void
-gtk_container_set_arg (GtkObject *object,
- GtkArg *arg,
- guint arg_id)
+gtk_container_set_property (GObject *object,
+ guint prop_id,
+ const GValue *value,
+ GParamSpec *pspec)
{
- GtkContainer *container;
+ GtkContainer *container = GTK_CONTAINER (object);
- container = GTK_CONTAINER (object);
-
- switch (arg_id)
+ switch (prop_id)
{
- case ARG_BORDER_WIDTH:
- gtk_container_set_border_width (container, GTK_VALUE_ULONG (*arg));
+ case PROP_BORDER_WIDTH:
+ gtk_container_set_border_width (container, g_value_get_uint (value));
break;
- case ARG_RESIZE_MODE:
- gtk_container_set_resize_mode (container, GTK_VALUE_ENUM (*arg));
+ case PROP_RESIZE_MODE:
+ gtk_container_set_resize_mode (container, g_value_get_enum (value));
break;
- case ARG_CHILD:
- gtk_container_add (container, GTK_WIDGET (GTK_VALUE_OBJECT (*arg)));
+ case PROP_CHILD:
+ gtk_container_add (container, GTK_WIDGET (g_value_get_object (value)));
break;
default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
-gtk_container_get_arg (GtkObject *object,
- GtkArg *arg,
- guint arg_id)
+gtk_container_get_property (GObject *object,
+ guint prop_id,
+ GValue *value,
+ GParamSpec *pspec)
{
- GtkContainer *container;
-
- container = GTK_CONTAINER (object);
+ GtkContainer *container = GTK_CONTAINER (object);
- switch (arg_id)
+ switch (prop_id)
{
- case ARG_BORDER_WIDTH:
- GTK_VALUE_ULONG (*arg) = container->border_width;
+ case PROP_BORDER_WIDTH:
+ g_value_set_uint (value, container->border_width);
break;
- case ARG_RESIZE_MODE:
- GTK_VALUE_ENUM (*arg) = container->resize_mode;
+ case PROP_RESIZE_MODE:
+ g_value_set_enum (value, container->resize_mode);
break;
default:
- arg->type = GTK_TYPE_INVALID;
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
+/**
+ * gtk_container_set_border_width:
+ * @container: a #GtkContainer
+ * @border_width: amount of blank space to leave <emphasis>outside</emphasis> the container.
+ * Valid values are in the range 0-65535 pixels.
+ *
+ * Sets the border width of the container.
+ *
+ * The border width of a container is the amount of space to leave
+ * around the outside of the container. The only exception to this is
+ * #GtkWindow; because toplevel windows can't leave space outside,
+ * they leave the space inside. The border is added on all sides of
+ * the container. To add space to only one side, one approach is to
+ * create a #GtkAlignment widget, call gtk_widget_set_usize() to give
+ * it a size, and place it on the side of the container as a spacer.
+ **/
void
gtk_container_set_border_width (GtkContainer *container,
guint border_width)
{
- g_return_if_fail (container != NULL);
g_return_if_fail (GTK_IS_CONTAINER (container));
if (container->border_width != border_width)
{
container->border_width = border_width;
-
+ g_object_notify (G_OBJECT (container), "border-width");
+
if (GTK_WIDGET_REALIZED (container))
gtk_widget_queue_resize (GTK_WIDGET (container));
}
}
+/**
+ * gtk_container_get_border_width:
+ * @container: a #GtkContainer
+ *
+ * Retrieves the border width of the container. See
+ * gtk_container_set_border_width().
+ *
+ * Return value: the current border width
+ **/
+guint
+gtk_container_get_border_width (GtkContainer *container)
+{
+ g_return_val_if_fail (GTK_IS_CONTAINER (container), 0);
+
+ return container->border_width;
+}
+
+/**
+ * gtk_container_add:
+ * @container: a #GtkContainer
+ * @widget: a widget to be placed inside @container
+ *
+ * Adds @widget to @container. Typically used for simple containers
+ * such as #GtkWindow, #GtkFrame, or #GtkButton; for more complicated
+ * layout containers such as #GtkBox or #GtkTable, this function will
+ * pick default packing parameters that may not be correct. So
+ * consider functions such as gtk_box_pack_start() and
+ * gtk_table_attach() as an alternative to gtk_container_add() in
+ * those cases. A widget may be added to only one container at a time;
+ * you can't place the same widget inside two different containers.
+ **/
void
gtk_container_add (GtkContainer *container,
GtkWidget *widget)
{
- g_return_if_fail (container != NULL);
g_return_if_fail (GTK_IS_CONTAINER (container));
- g_return_if_fail (widget != NULL);
g_return_if_fail (GTK_IS_WIDGET (widget));
- g_return_if_fail (widget->parent == NULL);
- gtk_signal_emit (GTK_OBJECT (container), container_signals[ADD], widget);
+ if (widget->parent != NULL)
+ {
+ g_warning ("Attempting to add a widget with type %s to a container of "
+ "type %s, but the widget is already inside a container of type %s, "
+ "the GTK+ FAQ at http://www.gtk.org/faq/ explains how to reparent a widget.",
+ g_type_name (G_OBJECT_TYPE (widget)),
+ g_type_name (G_OBJECT_TYPE (container)),
+ g_type_name (G_OBJECT_TYPE (widget->parent)));
+ return;
+ }
+
+ g_signal_emit (container, container_signals[ADD], 0, widget);
}
+/**
+ * gtk_container_remove:
+ * @container: a #GtkContainer
+ * @widget: a current child of @container
+ *
+ * Removes @widget from @container. @widget must be inside @container.
+ * Note that @container will own a reference to @widget, and that this
+ * may be the last reference held; so removing a widget from its
+ * container can destroy that widget. If you want to use @widget
+ * again, you need to add a reference to it while it's not inside
+ * a container, using g_object_ref(). If you don't want to use @widget
+ * again it's usually more efficient to simply destroy it directly
+ * using gtk_widget_destroy() since this will remove it from the
+ * container and help break any circular reference count cycles.
+ **/
void
gtk_container_remove (GtkContainer *container,
GtkWidget *widget)
{
- g_return_if_fail (container != NULL);
g_return_if_fail (GTK_IS_CONTAINER (container));
- g_return_if_fail (widget != NULL);
g_return_if_fail (GTK_IS_WIDGET (widget));
- g_return_if_fail (widget->parent == GTK_WIDGET (container));
+
+ /* When using the deprecated API of the toolbar, it is possible
+ * to legitimately call this function with a widget that is not
+ * a direct child of the container.
+ */
+ g_return_if_fail (GTK_IS_TOOLBAR (container) ||
+ widget->parent == GTK_WIDGET (container));
- gtk_signal_emit (GTK_OBJECT (container), container_signals[REMOVE], widget);
+ g_signal_emit (container, container_signals[REMOVE], 0, widget);
}
void
-gtk_container_clear_resize_widgets (GtkContainer *container)
+_gtk_container_dequeue_resize_handler (GtkContainer *container)
{
- GSList *node;
-
- g_return_if_fail (container != NULL);
g_return_if_fail (GTK_IS_CONTAINER (container));
+ g_return_if_fail (GTK_CONTAINER_RESIZE_PENDING (container));
- node = container->resize_widgets;
-
- if (node)
- gtk_signal_disconnect_by_func (GTK_OBJECT (container),
- GTK_SIGNAL_FUNC (gtk_container_clear_resize_widgets),
- NULL);
-
- while (node)
- {
- GtkWidget *widget = node->data;
-
- GTK_PRIVATE_UNSET_FLAG (widget, GTK_RESIZE_NEEDED);
- node = node->next;
- }
-
- g_slist_free (container->resize_widgets);
- container->resize_widgets = NULL;
+ container_resize_queue = g_slist_remove (container_resize_queue, container);
+ GTK_PRIVATE_UNSET_FLAG (container, GTK_RESIZE_PENDING);
}
+/**
+ * gtk_container_set_resize_mode:
+ * @container: a #GtkContainer.
+ * @resize_mode: the new resize mode.
+ *
+ * Sets the resize mode for the container.
+ *
+ * The resize mode of a container determines whether a resize request
+ * will be passed to the container's parent, queued for later execution
+ * or executed immediately.
+ **/
void
gtk_container_set_resize_mode (GtkContainer *container,
GtkResizeMode resize_mode)
{
- g_return_if_fail (container != NULL);
g_return_if_fail (GTK_IS_CONTAINER (container));
g_return_if_fail (resize_mode <= GTK_RESIZE_IMMEDIATE);
if (GTK_WIDGET_TOPLEVEL (container) &&
resize_mode == GTK_RESIZE_PARENT)
- resize_mode = GTK_RESIZE_QUEUE;
+ {
+ resize_mode = GTK_RESIZE_QUEUE;
+ }
if (container->resize_mode != resize_mode)
{
container->resize_mode = resize_mode;
- if (resize_mode == GTK_RESIZE_IMMEDIATE)
- gtk_container_check_resize (container);
- else
- {
- gtk_container_clear_resize_widgets (container);
- gtk_widget_queue_resize (GTK_WIDGET (container));
- }
+ gtk_widget_queue_resize (GTK_WIDGET (container));
+ g_object_notify (G_OBJECT (container), "resize-mode");
}
}
+/**
+ * gtk_container_get_resize_mode:
+ * @container: a #GtkContainer
+ *
+ * Returns the resize mode for the container. See
+ * gtk_container_set_resize_mode ().
+ *
+ * Return value: the current resize mode
+ **/
+GtkResizeMode
+gtk_container_get_resize_mode (GtkContainer *container)
+{
+ g_return_val_if_fail (GTK_IS_CONTAINER (container), GTK_RESIZE_PARENT);
+
+ return container->resize_mode;
+}
+
+/**
+ * gtk_container_set_reallocate_redraws:
+ * @container: a #GtkContainer.
+ * @needs_redraws: the new value for the container's @reallocate_redraws flag.
+ *
+ * Sets the @reallocate_redraws flag of the container to the given value.
+ *
+ * Containers requesting reallocation redraws get automatically
+ * redrawn if any of their children changed allocation.
+ **/
+void
+gtk_container_set_reallocate_redraws (GtkContainer *container,
+ gboolean needs_redraws)
+{
+ g_return_if_fail (GTK_IS_CONTAINER (container));
+
+ container->reallocate_redraws = needs_redraws ? TRUE : FALSE;
+}
+
static GtkContainer*
gtk_container_get_resize_container (GtkContainer *container)
{
- GtkWidget *widget;
-
- widget = GTK_WIDGET (container);
+ GtkWidget *widget = GTK_WIDGET (container);
while (widget->parent)
{
widget = widget->parent;
- if (GTK_IS_RESIZE_CONTAINER (widget) && !GTK_WIDGET_RESIZE_NEEDED (widget))
+ if (GTK_IS_RESIZE_CONTAINER (widget))
break;
}
static gboolean
gtk_container_idle_sizer (gpointer data)
{
- GDK_THREADS_ENTER ();
-
/* we may be invoked with a container_resize_queue of NULL, because
* queue_resize could have been adding an extra idle function while
* the queue still got processed. we better just ignore such case
gtk_container_check_resize (GTK_CONTAINER (widget));
}
- GDK_THREADS_LEAVE ();
-
+ gdk_window_process_all_updates ();
+
return FALSE;
}
void
-gtk_container_queue_resize (GtkContainer *container)
+_gtk_container_queue_resize (GtkContainer *container)
{
GtkContainer *resize_container;
+ GtkWidget *widget;
- g_return_if_fail (container != NULL);
g_return_if_fail (GTK_IS_CONTAINER (container));
- if (GTK_OBJECT_DESTROYED (container) ||
- GTK_WIDGET_RESIZE_NEEDED (container))
- return;
-
- if (GTK_IS_RESIZE_CONTAINER (container))
- gtk_container_clear_resize_widgets (container);
-
+ widget = GTK_WIDGET (container);
resize_container = gtk_container_get_resize_container (container);
-
+
+ while (TRUE)
+ {
+ GTK_PRIVATE_SET_FLAG (widget, GTK_ALLOC_NEEDED);
+ GTK_PRIVATE_SET_FLAG (widget, GTK_REQUEST_NEEDED);
+ if ((resize_container && widget == GTK_WIDGET (resize_container)) ||
+ !widget->parent)
+ break;
+
+ widget = widget->parent;
+ }
+
if (resize_container)
{
- if (GTK_WIDGET_VISIBLE (resize_container))
+ if (GTK_WIDGET_VISIBLE (resize_container) &&
+ (GTK_WIDGET_TOPLEVEL (resize_container) || GTK_WIDGET_REALIZED (resize_container)))
{
switch (resize_container->resize_mode)
{
{
GTK_PRIVATE_SET_FLAG (resize_container, GTK_RESIZE_PENDING);
if (container_resize_queue == NULL)
- gtk_idle_add_priority (GTK_PRIORITY_RESIZE,
- gtk_container_idle_sizer,
- NULL);
+ gdk_threads_add_idle_full (GTK_PRIORITY_RESIZE,
+ gtk_container_idle_sizer,
+ NULL, NULL);
container_resize_queue = g_slist_prepend (container_resize_queue, resize_container);
}
-
- GTK_PRIVATE_SET_FLAG (container, GTK_RESIZE_NEEDED);
- if (!resize_container->resize_widgets)
- gtk_signal_connect (GTK_OBJECT (resize_container),
- "size_allocate",
- GTK_SIGNAL_FUNC (gtk_container_clear_resize_widgets),
- NULL);
- resize_container->resize_widgets =
- g_slist_prepend (resize_container->resize_widgets, container);
break;
case GTK_RESIZE_IMMEDIATE:
- GTK_PRIVATE_SET_FLAG (container, GTK_RESIZE_NEEDED);
- if (!resize_container->resize_widgets)
- gtk_signal_connect (GTK_OBJECT (resize_container),
- "size_allocate",
- GTK_SIGNAL_FUNC (gtk_container_clear_resize_widgets),
- NULL);
- resize_container->resize_widgets =
- g_slist_prepend (resize_container->resize_widgets, container);
gtk_container_check_resize (resize_container);
break;
case GTK_RESIZE_PARENT:
- /* Ignore */
+ g_assert_not_reached ();
break;
}
}
else
{
- /* We need to let hidden toplevels know that something
- * changed while they where hidden. For other resize containers,
- * they will get resized when they are shown.
+ /* we need to let hidden resize containers know that something
+ * changed while they where hidden (currently only evaluated by
+ * toplevels).
*/
- if (GTK_WIDGET_TOPLEVEL (resize_container))
- gtk_container_check_resize (resize_container);
+ resize_container->need_resize = TRUE;
}
}
}
void
gtk_container_check_resize (GtkContainer *container)
{
- g_return_if_fail (container != NULL);
g_return_if_fail (GTK_IS_CONTAINER (container));
-
- gtk_signal_emit (GTK_OBJECT (container), container_signals[CHECK_RESIZE]);
+
+ g_signal_emit (container, container_signals[CHECK_RESIZE], 0);
}
static void
gtk_container_real_check_resize (GtkContainer *container)
{
- GtkWidget *widget;
+ GtkWidget *widget = GTK_WIDGET (container);
GtkRequisition requisition;
- g_return_if_fail (container != NULL);
- g_return_if_fail (GTK_IS_CONTAINER (container));
-
- widget = GTK_WIDGET (container);
-
- gtk_widget_size_request (widget, &requisition);
+ gtk_widget_size_request (widget, &requisition);
if (requisition.width > widget->allocation.width ||
requisition.height > widget->allocation.height)
* queued a resize request. Which means that the allocation
* is not sufficient for the requisition of some child.
* We've already performed a size request at this point,
- * so we simply need to run through the list of resize
- * widgets and reallocate their sizes appropriately. We
- * make the optimization of not performing reallocation
- * for a widget who also has a parent in the resize widgets
- * list. GTK_RESIZE_NEEDED is used for flagging those
- * parents inside this function.
+ * so we simply need to reallocate and let the allocation
+ * trickle down via GTK_WIDGET_ALLOC_NEEDED flags.
*/
void
gtk_container_resize_children (GtkContainer *container)
{
GtkWidget *widget;
- GtkWidget *resize_container;
- GSList *resize_widgets;
- GSList *resize_containers;
- GSList *node;
/* resizing invariants:
* toplevels have *always* resize_mode != GTK_RESIZE_PARENT set.
- * containers with resize_mode==GTK_RESIZE_PARENT have to have resize_widgets
- * set to NULL.
- * containers that are flagged RESIZE_NEEDED must have resize_widgets set to
- * NULL, or are toplevels (thus have ->parent set to NULL).
- * widgets that are in some container->resize_widgets list must be flagged with
- * RESIZE_NEEDED.
- * widgets that have RESIZE_NEEDED set must be referenced in some
- * GTK_IS_RESIZE_CONTAINER (container)->resize_widgets list.
* containers that have an idle sizer pending must be flagged with
* RESIZE_PENDING.
*/
-
- g_return_if_fail (container != NULL);
g_return_if_fail (GTK_IS_CONTAINER (container));
- /* we first check out if we actually need to perform a resize,
- * which is not the case if we got another container queued for
- * a resize in our anchestry. also we can skip the whole
- * resize_widgets checks if we are a toplevel and NEED_RESIZE.
- * this code implies that our allocation is sufficient for our
- * requisition, since otherwise we would NEED_RESIZE.
- */
- resize_container = GTK_WIDGET (container);
- while (resize_container)
- {
- if (GTK_WIDGET_RESIZE_NEEDED (resize_container))
- break;
- resize_container = resize_container->parent;
- }
- if (resize_container)
- {
- /* queue_resize and size_allocate both clear our
- * resize_widgets list.
- */
- if (resize_container->parent)
- gtk_container_queue_resize (container);
- else
- gtk_widget_size_allocate (GTK_WIDGET (container),
- >K_WIDGET (container)->allocation);
- return;
- }
-
- resize_container = GTK_WIDGET (container);
-
- /* we now walk the anchestry for all resize widgets as long
- * as they are our children and as long as their allocation
- * is insufficient, since we don't need to reallocate below that.
- */
- resize_widgets = container->resize_widgets;
- if (resize_widgets)
- gtk_signal_disconnect_by_func (GTK_OBJECT (container),
- GTK_SIGNAL_FUNC (gtk_container_clear_resize_widgets),
- NULL);
- container->resize_widgets = NULL;
- for (node = resize_widgets; node; node = node->next)
- {
- widget = node->data;
-
- GTK_PRIVATE_UNSET_FLAG (widget, GTK_RESIZE_NEEDED);
-
- while (widget->parent != resize_container &&
- ((widget->allocation.width < widget->requisition.width) ||
- (widget->allocation.height < widget->requisition.height)))
- widget = widget->parent;
-
- GTK_PRIVATE_SET_FLAG (widget, GTK_RESIZE_NEEDED);
- node->data = widget;
- }
-
- /* for the newly setup resize_widgets list, we now walk each widget's
- * anchestry to sort those widgets out that have RESIZE_NEEDED parents.
- * we can safely stop the walk if we are the parent, since we checked
- * our own anchestry already.
- */
- resize_containers = NULL;
- for (node = resize_widgets; node; node = node->next)
- {
- GtkWidget *parent;
-
- widget = node->data;
-
- if (!GTK_WIDGET_RESIZE_NEEDED (widget))
- continue;
-
- parent = widget->parent;
-
- while (parent != resize_container)
- {
- if (GTK_WIDGET_RESIZE_NEEDED (parent))
- {
- GTK_PRIVATE_UNSET_FLAG (widget, GTK_RESIZE_NEEDED);
- widget = parent;
- }
- parent = parent->parent;
- }
-
- if (!g_slist_find (resize_containers, widget))
- {
- resize_containers = g_slist_prepend (resize_containers, widget);
- gtk_widget_ref (widget);
- }
- }
- g_slist_free (resize_widgets);
-
- for (node = resize_containers; node; node = node->next)
- {
- widget = node->data;
-
- GTK_PRIVATE_UNSET_FLAG (widget, GTK_RESIZE_NEEDED);
-
- gtk_widget_size_allocate (widget, &widget->allocation);
-
- gtk_widget_unref (widget);
- }
- g_slist_free (resize_containers);
+ widget = GTK_WIDGET (container);
+ gtk_widget_size_allocate (widget, &widget->allocation);
}
+/**
+ * gtk_container_forall:
+ * @container: a #GtkContainer
+ * @callback: a callback
+ * @callback_data: callback user data
+ *
+ * Invokes @callback on each child of @container, including children
+ * that are considered "internal" (implementation details of the
+ * container). "Internal" children generally weren't added by the user
+ * of the container, but were added by the container implementation
+ * itself. Most applications should use gtk_container_foreach(),
+ * rather than gtk_container_forall().
+ **/
void
gtk_container_forall (GtkContainer *container,
GtkCallback callback,
{
GtkContainerClass *class;
- g_return_if_fail (container != NULL);
g_return_if_fail (GTK_IS_CONTAINER (container));
g_return_if_fail (callback != NULL);
- class = GTK_CONTAINER_CLASS (GTK_OBJECT (container)->klass);
+ class = GTK_CONTAINER_GET_CLASS (container);
if (class->forall)
class->forall (container, TRUE, callback, callback_data);
}
+/**
+ * gtk_container_foreach:
+ * @container: a #GtkContainer
+ * @callback: a callback
+ * @callback_data: callback user data
+ *
+ * Invokes @callback on each non-internal child of @container. See
+ * gtk_container_forall() for details on what constitutes an
+ * "internal" child. Most applications should use
+ * gtk_container_foreach(), rather than gtk_container_forall().
+ **/
void
gtk_container_foreach (GtkContainer *container,
GtkCallback callback,
{
GtkContainerClass *class;
- g_return_if_fail (container != NULL);
g_return_if_fail (GTK_IS_CONTAINER (container));
g_return_if_fail (callback != NULL);
- class = GTK_CONTAINER_CLASS (GTK_OBJECT (container)->klass);
+ class = GTK_CONTAINER_GET_CLASS (container);
if (class->forall)
class->forall (container, FALSE, callback, callback_data);
/* first argument */
args[0].name = NULL;
- args[0].type = GTK_OBJECT(child)->klass->type;
- GTK_VALUE_OBJECT(args[0]) = GTK_OBJECT (child);
+ args[0].type = G_TYPE_FROM_INSTANCE (child);
+ GTK_VALUE_OBJECT (args[0]) = GTK_OBJECT (child);
/* location for return value */
args[1].name = NULL;
- args[1].type = GTK_TYPE_NONE;
+ args[1].type = G_TYPE_NONE;
fdata->callback (fdata->container, fdata->callback_data, 1, args);
}
gpointer callback_data,
GtkDestroyNotify notify)
{
- g_return_if_fail (container != NULL);
g_return_if_fail (GTK_IS_CONTAINER (container));
if (marshal)
notify (callback_data);
}
-gint
-gtk_container_focus (GtkContainer *container,
- GtkDirectionType direction)
-{
- gint return_val;
-
- g_return_val_if_fail (container != NULL, FALSE);
- g_return_val_if_fail (GTK_IS_CONTAINER (container), FALSE);
-
- gtk_signal_emit (GTK_OBJECT (container),
- container_signals[FOCUS],
- direction, &return_val);
-
- return return_val;
-}
-
void
gtk_container_set_focus_child (GtkContainer *container,
GtkWidget *widget)
{
- g_return_if_fail (container != NULL);
g_return_if_fail (GTK_IS_CONTAINER (container));
if (widget)
g_return_if_fail (GTK_IS_WIDGET (widget));
- gtk_signal_emit (GTK_OBJECT (container), container_signals[SET_FOCUS_CHILD], widget);
+ g_signal_emit (container, container_signals[SET_FOCUS_CHILD], 0, widget);
}
+/**
+ * gtk_container_get_children:
+ * @container: a #GtkContainer.
+ *
+ * Returns the container's non-internal children. See
+ * gtk_container_forall() for details on what constitutes an "internal" child.
+ *
+ * Return value: a newly-allocated list of the container's non-internal children.
+ **/
GList*
-gtk_container_children (GtkContainer *container)
+gtk_container_get_children (GtkContainer *container)
{
- GList *children;
-
- children = NULL;
+ GList *children = NULL;
gtk_container_foreach (container,
gtk_container_children_callback,
return g_list_reverse (children);
}
-void
-gtk_container_register_toplevel (GtkContainer *container)
-{
- g_return_if_fail (container != NULL);
-
- toplevel_list = g_list_prepend (toplevel_list, container);
-
- gtk_widget_ref (GTK_WIDGET (container));
- gtk_object_sink (GTK_OBJECT (container));
-}
-
-void
-gtk_container_unregister_toplevel (GtkContainer *container)
-{
- GList *node;
-
- g_return_if_fail (container != NULL);
-
- node = g_list_find (toplevel_list, container);
- g_return_if_fail (node != NULL);
-
- toplevel_list = g_list_remove_link (toplevel_list, node);
- g_list_free_1 (node);
-
- gtk_widget_unref (GTK_WIDGET (container));
-}
-
-GList*
-gtk_container_get_toplevels (void)
-{
- /* XXX: fixme we should ref all these widgets and duplicate
- * the list.
- */
- return toplevel_list;
-}
-
static void
gtk_container_child_position_callback (GtkWidget *widget,
gpointer client_data)
&data);
name = g_strdup_printf ("%s-%u",
- gtk_type_name (GTK_OBJECT_TYPE (child)),
+ g_type_name (G_TYPE_FROM_INSTANCE (child)),
data.index);
return name;
}
gchar*
-gtk_container_child_composite_name (GtkContainer *container,
+_gtk_container_child_composite_name (GtkContainer *container,
GtkWidget *child)
{
- g_return_val_if_fail (container != NULL, NULL);
g_return_val_if_fail (GTK_IS_CONTAINER (container), NULL);
- g_return_val_if_fail (child != NULL, NULL);
g_return_val_if_fail (GTK_IS_WIDGET (child), NULL);
g_return_val_if_fail (child->parent == GTK_WIDGET (container), NULL);
if (!quark_composite_name)
quark_composite_name = g_quark_from_static_string ("gtk-composite-name");
- name = gtk_object_get_data_by_id (GTK_OBJECT (child), quark_composite_name);
+ name = g_object_get_qdata (G_OBJECT (child), quark_composite_name);
if (!name)
{
GtkContainerClass *class;
- class = GTK_CONTAINER_CLASS (GTK_OBJECT (container)->klass);
+ class = GTK_CONTAINER_GET_CLASS (container);
if (class->composite_name)
name = class->composite_name (container, child);
}
return NULL;
}
-void
+static void
gtk_container_real_set_focus_child (GtkContainer *container,
GtkWidget *child)
{
- g_return_if_fail (container != NULL);
g_return_if_fail (GTK_IS_CONTAINER (container));
- if (child)
- g_return_if_fail (GTK_IS_WIDGET (child));
+ g_return_if_fail (child == NULL || GTK_IS_WIDGET (child));
if (child != container->focus_child)
{
if (container->focus_child)
- gtk_widget_unref (container->focus_child);
+ g_object_unref (container->focus_child);
container->focus_child = child;
if (container->focus_child)
- gtk_widget_ref (container->focus_child);
+ g_object_ref (container->focus_child);
}
*/
if (container->focus_child)
{
- GtkAdjustment *adjustment;
-
- adjustment = gtk_object_get_data_by_id (GTK_OBJECT (container), vadjustment_key_id);
- if (adjustment)
- gtk_adjustment_clamp_page (adjustment,
- container->focus_child->allocation.y,
- (container->focus_child->allocation.y +
- container->focus_child->allocation.height));
-
- adjustment = gtk_object_get_data_by_id (GTK_OBJECT (container), hadjustment_key_id);
- if (adjustment)
- gtk_adjustment_clamp_page (adjustment,
- container->focus_child->allocation.x,
- (container->focus_child->allocation.x +
- container->focus_child->allocation.width));
+ GtkAdjustment *hadj;
+ GtkAdjustment *vadj;
+ GtkWidget *focus_child;
+ gint x, y;
+
+ hadj = g_object_get_qdata (G_OBJECT (container), hadjustment_key_id);
+ vadj = g_object_get_qdata (G_OBJECT (container), vadjustment_key_id);
+ if (hadj || vadj)
+ {
+
+ focus_child = container->focus_child;
+ while (GTK_IS_CONTAINER (focus_child) &&
+ GTK_CONTAINER (focus_child)->focus_child)
+ {
+ focus_child = GTK_CONTAINER (focus_child)->focus_child;
+ }
+
+ gtk_widget_translate_coordinates (focus_child, container->focus_child,
+ 0, 0, &x, &y);
+
+ x += container->focus_child->allocation.x;
+ y += container->focus_child->allocation.y;
+
+ if (vadj)
+ gtk_adjustment_clamp_page (vadj, y, y + focus_child->allocation.height);
+
+ if (hadj)
+ gtk_adjustment_clamp_page (hadj, x, x + focus_child->allocation.width);
+ }
}
}
-static gint
-gtk_container_real_focus (GtkContainer *container,
- GtkDirectionType direction)
+static GList*
+get_focus_chain (GtkContainer *container)
+{
+ return g_object_get_data (G_OBJECT (container), "gtk-container-focus-chain");
+}
+
+/* same as gtk_container_get_children, except it includes internals
+ */
+static GList *
+gtk_container_get_all_children (GtkContainer *container)
+{
+ GList *children = NULL;
+
+ gtk_container_forall (container,
+ gtk_container_children_callback,
+ &children);
+
+ return children;
+}
+
+static gboolean
+gtk_container_focus (GtkWidget *widget,
+ GtkDirectionType direction)
{
GList *children;
- GList *tmp_list;
- GList *tmp_list2;
+ GList *sorted_children;
gint return_val;
+ GtkContainer *container;
- g_return_val_if_fail (container != NULL, FALSE);
- g_return_val_if_fail (GTK_IS_CONTAINER (container), FALSE);
+ g_return_val_if_fail (GTK_IS_CONTAINER (widget), FALSE);
- /* Fail if the container is inappropriate for focus movement
- */
- if (!GTK_WIDGET_DRAWABLE (container) ||
- !GTK_WIDGET_IS_SENSITIVE (container))
- return FALSE;
+ container = GTK_CONTAINER (widget);
return_val = FALSE;
if (GTK_WIDGET_CAN_FOCUS (container))
{
- gtk_widget_grab_focus (GTK_WIDGET (container));
- return_val = TRUE;
+ if (!GTK_WIDGET_HAS_FOCUS (container))
+ {
+ gtk_widget_grab_focus (GTK_WIDGET (container));
+ return_val = TRUE;
+ }
}
else
{
- /* Get a list of the containers children
+ /* Get a list of the containers children, allowing focus
+ * chain to override.
*/
- children = NULL;
- gtk_container_forall (container,
- gtk_container_children_callback,
- &children);
- children = g_list_reverse (children);
- /* children = gtk_container_children (container); */
-
- if (children)
- {
- /* Remove any children which are inappropriate for focus movement
- */
- tmp_list = children;
- while (tmp_list)
- {
- if (GTK_WIDGET_IS_SENSITIVE (tmp_list->data) &&
- GTK_WIDGET_DRAWABLE (tmp_list->data) &&
- (GTK_IS_CONTAINER (tmp_list->data) || GTK_WIDGET_CAN_FOCUS (tmp_list->data)))
- tmp_list = tmp_list->next;
- else
- {
- tmp_list2 = tmp_list;
- tmp_list = tmp_list->next;
-
- children = g_list_remove_link (children, tmp_list2);
- g_list_free_1 (tmp_list2);
- }
- }
-
- switch (direction)
- {
- case GTK_DIR_TAB_FORWARD:
- case GTK_DIR_TAB_BACKWARD:
- return_val = gtk_container_focus_tab (container, children, direction);
- break;
- case GTK_DIR_UP:
- case GTK_DIR_DOWN:
- return_val = gtk_container_focus_up_down (container, children, direction);
- break;
- case GTK_DIR_LEFT:
- case GTK_DIR_RIGHT:
- return_val = gtk_container_focus_left_right (container, children, direction);
- break;
- }
+ if (container->has_focus_chain)
+ children = g_list_copy (get_focus_chain (container));
+ else
+ children = gtk_container_get_all_children (container);
- g_list_free (children);
+ if (container->has_focus_chain &&
+ (direction == GTK_DIR_TAB_FORWARD ||
+ direction == GTK_DIR_TAB_BACKWARD))
+ {
+ sorted_children = g_list_copy (children);
+
+ if (direction == GTK_DIR_TAB_BACKWARD)
+ sorted_children = g_list_reverse (sorted_children);
}
+ else
+ sorted_children = _gtk_container_focus_sort (container, children, direction, NULL);
+
+ return_val = gtk_container_focus_move (container, sorted_children, direction);
+
+ g_list_free (sorted_children);
+ g_list_free (children);
}
return return_val;
}
static gint
-gtk_container_focus_tab (GtkContainer *container,
- GList *children,
- GtkDirectionType direction)
+tab_compare (gconstpointer a,
+ gconstpointer b,
+ gpointer data)
{
- GtkWidget *child;
- GtkWidget *child2;
- GList *tmp_list;
- guint length;
- guint i, j;
+ const GtkWidget *child1 = a;
+ const GtkWidget *child2 = b;
+ GtkTextDirection text_direction = GPOINTER_TO_INT (data);
- length = g_list_length (children);
+ gint y1 = child1->allocation.y + child1->allocation.height / 2;
+ gint y2 = child2->allocation.y + child2->allocation.height / 2;
- /* sort the children in the y direction */
- for (i = 1; i < length; i++)
+ if (y1 == y2)
{
- j = i;
- tmp_list = g_list_nth (children, j);
- child = tmp_list->data;
-
- while (j > 0)
- {
- child2 = tmp_list->prev->data;
- if (child->allocation.y < child2->allocation.y)
- {
- tmp_list->data = tmp_list->prev->data;
- tmp_list = tmp_list->prev;
- j--;
- }
- else
- break;
- }
-
- tmp_list->data = child;
+ gint x1 = child1->allocation.x + child1->allocation.width / 2;
+ gint x2 = child2->allocation.x + child2->allocation.width / 2;
+
+ if (text_direction == GTK_TEXT_DIR_RTL)
+ return (x1 < x2) ? 1 : ((x1 == x2) ? 0 : -1);
+ else
+ return (x1 < x2) ? -1 : ((x1 == x2) ? 0 : 1);
}
+ else
+ return (y1 < y2) ? -1 : 1;
+}
- /* sort the children in the x direction while
- * maintaining the y direction sort.
- */
- for (i = 1; i < length; i++)
- {
- j = i;
- tmp_list = g_list_nth (children, j);
- child = tmp_list->data;
-
- while (j > 0)
- {
- child2 = tmp_list->prev->data;
- if ((child->allocation.x < child2->allocation.x) &&
- (child->allocation.y == child2->allocation.y))
- {
- tmp_list->data = tmp_list->prev->data;
- tmp_list = tmp_list->prev;
- j--;
- }
- else
- break;
- }
-
- tmp_list->data = child;
- }
+static GList *
+gtk_container_focus_sort_tab (GtkContainer *container,
+ GList *children,
+ GtkDirectionType direction,
+ GtkWidget *old_focus)
+{
+ GtkTextDirection text_direction = gtk_widget_get_direction (GTK_WIDGET (container));
+ children = g_list_sort_with_data (children, tab_compare, GINT_TO_POINTER (text_direction));
/* if we are going backwards then reverse the order
* of the children.
if (direction == GTK_DIR_TAB_BACKWARD)
children = g_list_reverse (children);
- return gtk_container_focus_move (container, children, direction);
+ return children;
}
-static gint
-gtk_container_focus_up_down (GtkContainer *container,
- GList *children,
- GtkDirectionType direction)
+/* Get coordinates of @widget's allocation with respect to
+ * allocation of @container.
+ */
+static gboolean
+get_allocation_coords (GtkContainer *container,
+ GtkWidget *widget,
+ GdkRectangle *allocation)
{
- GtkWidget *child;
- GtkWidget *child2;
- GList *tmp_list;
- gint dist1, dist2;
- gint focus_x;
- gint focus_width;
- guint length;
- guint i, j;
+ *allocation = widget->allocation;
- /* return failure if there isn't a focus child */
- if (container->focus_child)
+ return gtk_widget_translate_coordinates (widget, GTK_WIDGET (container),
+ 0, 0, &allocation->x, &allocation->y);
+}
+
+/* Look for a child in @children that is intermediate between
+ * the focus widget and container. This widget, if it exists,
+ * acts as the starting widget for focus navigation.
+ */
+static GtkWidget *
+find_old_focus (GtkContainer *container,
+ GList *children)
+{
+ GList *tmp_list = children;
+ while (tmp_list)
+ {
+ GtkWidget *child = tmp_list->data;
+ GtkWidget *widget = child;
+
+ while (widget && widget != (GtkWidget *)container)
+ {
+ GtkWidget *parent = widget->parent;
+ if (parent && ((GtkContainer *)parent)->focus_child != widget)
+ goto next;
+
+ widget = parent;
+ }
+
+ return child;
+
+ next:
+ tmp_list = tmp_list->next;
+ }
+
+ return NULL;
+}
+
+static gboolean
+old_focus_coords (GtkContainer *container,
+ GdkRectangle *old_focus_rect)
+{
+ GtkWidget *widget = GTK_WIDGET (container);
+ GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
+
+ if (toplevel && GTK_IS_WINDOW (toplevel) && GTK_WINDOW (toplevel)->focus_widget)
{
- focus_width = container->focus_child->allocation.width / 2;
- focus_x = container->focus_child->allocation.x + focus_width;
+ GtkWidget *old_focus = GTK_WINDOW (toplevel)->focus_widget;
+
+ return get_allocation_coords (container, old_focus, old_focus_rect);
}
else
+ return FALSE;
+}
+
+typedef struct _CompareInfo CompareInfo;
+
+struct _CompareInfo
+{
+ GtkContainer *container;
+ gint x;
+ gint y;
+ gboolean reverse;
+};
+
+static gint
+up_down_compare (gconstpointer a,
+ gconstpointer b,
+ gpointer data)
+{
+ GdkRectangle allocation1;
+ GdkRectangle allocation2;
+ CompareInfo *compare = data;
+ gint y1, y2;
+
+ get_allocation_coords (compare->container, (GtkWidget *)a, &allocation1);
+ get_allocation_coords (compare->container, (GtkWidget *)b, &allocation2);
+
+ y1 = allocation1.y + allocation1.height / 2;
+ y2 = allocation2.y + allocation2.height / 2;
+
+ if (y1 == y2)
{
- focus_width = GTK_WIDGET (container)->allocation.width;
- if (GTK_WIDGET_NO_WINDOW (container))
- focus_x = GTK_WIDGET (container)->allocation.x;
+ gint x1 = abs (allocation1.x + allocation1.width / 2 - compare->x);
+ gint x2 = abs (allocation2.x + allocation2.width / 2 - compare->x);
+
+ if (compare->reverse)
+ return (x1 < x2) ? 1 : ((x1 == x2) ? 0 : -1);
else
- focus_x = 0;
+ return (x1 < x2) ? -1 : ((x1 == x2) ? 0 : 1);
}
+ else
+ return (y1 < y2) ? -1 : 1;
+}
+
+static GList *
+gtk_container_focus_sort_up_down (GtkContainer *container,
+ GList *children,
+ GtkDirectionType direction,
+ GtkWidget *old_focus)
+{
+ CompareInfo compare;
+ GList *tmp_list;
+ GdkRectangle old_allocation;
- length = g_list_length (children);
+ compare.container = container;
+ compare.reverse = (direction == GTK_DIR_UP);
- /* sort the children in the y direction */
- for (i = 1; i < length; i++)
+ if (!old_focus)
+ old_focus = find_old_focus (container, children);
+
+ if (old_focus && get_allocation_coords (container, old_focus, &old_allocation))
{
- j = i;
- tmp_list = g_list_nth (children, j);
- child = tmp_list->data;
+ gint compare_x1;
+ gint compare_x2;
+ gint compare_y;
+
+ /* Delete widgets from list that don't match minimum criteria */
- while (j > 0)
+ compare_x1 = old_allocation.x;
+ compare_x2 = old_allocation.x + old_allocation.width;
+
+ if (direction == GTK_DIR_UP)
+ compare_y = old_allocation.y;
+ else
+ compare_y = old_allocation.y + old_allocation.height;
+
+ tmp_list = children;
+ while (tmp_list)
{
- child2 = tmp_list->prev->data;
- if (child->allocation.y < child2->allocation.y)
+ GtkWidget *child = tmp_list->data;
+ GList *next = tmp_list->next;
+ gint child_x1, child_x2;
+ GdkRectangle child_allocation;
+
+ if (child != old_focus)
{
- tmp_list->data = tmp_list->prev->data;
- tmp_list = tmp_list->prev;
- j--;
+ if (get_allocation_coords (container, child, &child_allocation))
+ {
+ child_x1 = child_allocation.x;
+ child_x2 = child_allocation.x + child_allocation.width;
+
+ if ((child_x2 <= compare_x1 || child_x1 >= compare_x2) /* No horizontal overlap */ ||
+ (direction == GTK_DIR_DOWN && child_allocation.y + child_allocation.height < compare_y) || /* Not below */
+ (direction == GTK_DIR_UP && child_allocation.y > compare_y)) /* Not above */
+ {
+ children = g_list_delete_link (children, tmp_list);
+ }
+ }
+ else
+ children = g_list_delete_link (children, tmp_list);
}
- else
- break;
+
+ tmp_list = next;
}
- tmp_list->data = child;
+ compare.x = (compare_x1 + compare_x2) / 2;
+ compare.y = old_allocation.y + old_allocation.height / 2;
}
-
- /* sort the children in distance in the x direction
- * in distance from the current focus child while maintaining the
- * sort in the y direction
- */
- for (i = 1; i < length; i++)
+ else
{
- j = i;
- tmp_list = g_list_nth (children, j);
- child = tmp_list->data;
- dist1 = (child->allocation.x + child->allocation.width / 2) - focus_x;
+ /* No old focus widget, need to figure out starting x,y some other way
+ */
+ GtkWidget *widget = GTK_WIDGET (container);
+ GdkRectangle old_focus_rect;
- while (j > 0)
+ if (old_focus_coords (container, &old_focus_rect))
{
- child2 = tmp_list->prev->data;
- dist2 = (child2->allocation.x + child2->allocation.width / 2) - focus_x;
-
- if ((dist1 < dist2) &&
- (child->allocation.y >= child2->allocation.y))
- {
- tmp_list->data = tmp_list->prev->data;
- tmp_list = tmp_list->prev;
- j--;
- }
+ compare.x = old_focus_rect.x + old_focus_rect.width / 2;
+ }
+ else
+ {
+ if (GTK_WIDGET_NO_WINDOW (widget))
+ compare.x = widget->allocation.x + widget->allocation.width / 2;
else
- break;
+ compare.x = widget->allocation.width / 2;
}
-
- tmp_list->data = child;
+
+ if (GTK_WIDGET_NO_WINDOW (widget))
+ compare.y = (direction == GTK_DIR_DOWN) ? widget->allocation.y : widget->allocation.y + widget->allocation.height;
+ else
+ compare.y = (direction == GTK_DIR_DOWN) ? 0 : + widget->allocation.height;
}
- /* go and invalidate any widget which is too
- * far from the focus widget.
- */
- if (!container->focus_child &&
- (direction == GTK_DIR_UP))
- focus_x += focus_width;
+ children = g_list_sort_with_data (children, up_down_compare, &compare);
- tmp_list = children;
- while (tmp_list)
- {
- child = tmp_list->data;
-
- dist1 = (child->allocation.x + child->allocation.width / 2) - focus_x;
- if (((direction == GTK_DIR_DOWN) && (dist1 < 0)) ||
- ((direction == GTK_DIR_UP) && (dist1 > 0)))
- tmp_list->data = NULL;
-
- tmp_list = tmp_list->next;
- }
-
- if (direction == GTK_DIR_UP)
+ if (compare.reverse)
children = g_list_reverse (children);
- return gtk_container_focus_move (container, children, direction);
+ return children;
}
static gint
-gtk_container_focus_left_right (GtkContainer *container,
- GList *children,
- GtkDirectionType direction)
+left_right_compare (gconstpointer a,
+ gconstpointer b,
+ gpointer data)
{
- GtkWidget *child;
- GtkWidget *child2;
- GList *tmp_list;
- gint dist1, dist2;
- gint focus_y;
- gint focus_height;
- guint length;
- guint i, j;
+ GdkRectangle allocation1;
+ GdkRectangle allocation2;
+ CompareInfo *compare = data;
+ gint x1, x2;
- /* return failure if there isn't a focus child */
- if (container->focus_child)
- {
- focus_height = container->focus_child->allocation.height / 2;
- focus_y = container->focus_child->allocation.y + focus_height;
- }
- else
+ get_allocation_coords (compare->container, (GtkWidget *)a, &allocation1);
+ get_allocation_coords (compare->container, (GtkWidget *)b, &allocation2);
+
+ x1 = allocation1.x + allocation1.width / 2;
+ x2 = allocation2.x + allocation2.width / 2;
+
+ if (x1 == x2)
{
- focus_height = GTK_WIDGET (container)->allocation.height;
- if (GTK_WIDGET_NO_WINDOW (container))
- focus_y = GTK_WIDGET (container)->allocation.y;
+ gint y1 = abs (allocation1.y + allocation1.height / 2 - compare->y);
+ gint y2 = abs (allocation2.y + allocation2.height / 2 - compare->y);
+
+ if (compare->reverse)
+ return (y1 < y2) ? 1 : ((y1 == y2) ? 0 : -1);
else
- focus_y = 0;
+ return (y1 < y2) ? -1 : ((y1 == y2) ? 0 : 1);
}
+ else
+ return (x1 < x2) ? -1 : 1;
+}
+
+static GList *
+gtk_container_focus_sort_left_right (GtkContainer *container,
+ GList *children,
+ GtkDirectionType direction,
+ GtkWidget *old_focus)
+{
+ CompareInfo compare;
+ GList *tmp_list;
+ GdkRectangle old_allocation;
- length = g_list_length (children);
+ compare.container = container;
+ compare.reverse = (direction == GTK_DIR_LEFT);
- /* sort the children in the x direction */
- for (i = 1; i < length; i++)
+ if (!old_focus)
+ old_focus = find_old_focus (container, children);
+
+ if (old_focus && get_allocation_coords (container, old_focus, &old_allocation))
{
- j = i;
- tmp_list = g_list_nth (children, j);
- child = tmp_list->data;
+ gint compare_y1;
+ gint compare_y2;
+ gint compare_x;
+
+ /* Delete widgets from list that don't match minimum criteria */
+
+ compare_y1 = old_allocation.y;
+ compare_y2 = old_allocation.y + old_allocation.height;
- while (j > 0)
+ if (direction == GTK_DIR_LEFT)
+ compare_x = old_allocation.x;
+ else
+ compare_x = old_allocation.x + old_allocation.width;
+
+ tmp_list = children;
+ while (tmp_list)
{
- child2 = tmp_list->prev->data;
- if (child->allocation.x < child2->allocation.x)
+ GtkWidget *child = tmp_list->data;
+ GList *next = tmp_list->next;
+ gint child_y1, child_y2;
+ GdkRectangle child_allocation;
+
+ if (child != old_focus)
{
- tmp_list->data = tmp_list->prev->data;
- tmp_list = tmp_list->prev;
- j--;
+ if (get_allocation_coords (container, child, &child_allocation))
+ {
+ child_y1 = child_allocation.y;
+ child_y2 = child_allocation.y + child_allocation.height;
+
+ if ((child_y2 <= compare_y1 || child_y1 >= compare_y2) /* No vertical overlap */ ||
+ (direction == GTK_DIR_RIGHT && child_allocation.x + child_allocation.width < compare_x) || /* Not to left */
+ (direction == GTK_DIR_LEFT && child_allocation.x > compare_x)) /* Not to right */
+ {
+ children = g_list_delete_link (children, tmp_list);
+ }
+ }
+ else
+ children = g_list_delete_link (children, tmp_list);
}
- else
- break;
+
+ tmp_list = next;
}
- tmp_list->data = child;
+ compare.y = (compare_y1 + compare_y2) / 2;
+ compare.x = old_allocation.x + old_allocation.width / 2;
}
-
- /* sort the children in distance in the y direction
- * in distance from the current focus child while maintaining the
- * sort in the x direction
- */
- for (i = 1; i < length; i++)
+ else
{
- j = i;
- tmp_list = g_list_nth (children, j);
- child = tmp_list->data;
- dist1 = (child->allocation.y + child->allocation.height / 2) - focus_y;
+ /* No old focus widget, need to figure out starting x,y some other way
+ */
+ GtkWidget *widget = GTK_WIDGET (container);
+ GdkRectangle old_focus_rect;
- while (j > 0)
+ if (old_focus_coords (container, &old_focus_rect))
{
- child2 = tmp_list->prev->data;
- dist2 = (child2->allocation.y + child2->allocation.height / 2) - focus_y;
-
- if ((dist1 < dist2) &&
- (child->allocation.x >= child2->allocation.x))
- {
- tmp_list->data = tmp_list->prev->data;
- tmp_list = tmp_list->prev;
- j--;
- }
+ compare.y = old_focus_rect.y + old_focus_rect.height / 2;
+ }
+ else
+ {
+ if (GTK_WIDGET_NO_WINDOW (widget))
+ compare.y = widget->allocation.y + widget->allocation.height / 2;
else
- break;
+ compare.y = widget->allocation.height / 2;
}
-
- tmp_list->data = child;
+
+ if (GTK_WIDGET_NO_WINDOW (widget))
+ compare.x = (direction == GTK_DIR_RIGHT) ? widget->allocation.x : widget->allocation.x + widget->allocation.width;
+ else
+ compare.x = (direction == GTK_DIR_RIGHT) ? 0 : widget->allocation.width;
}
- /* go and invalidate any widget which is too
- * far from the focus widget.
- */
- if (!container->focus_child &&
- (direction == GTK_DIR_LEFT))
- focus_y += focus_height;
+ children = g_list_sort_with_data (children, left_right_compare, &compare);
- tmp_list = children;
- while (tmp_list)
- {
- child = tmp_list->data;
+ if (compare.reverse)
+ children = g_list_reverse (children);
- dist1 = (child->allocation.y + child->allocation.height / 2) - focus_y;
- if (((direction == GTK_DIR_RIGHT) && (dist1 < 0)) ||
- ((direction == GTK_DIR_LEFT) && (dist1 > 0)))
- tmp_list->data = NULL;
+ return children;
+}
- tmp_list = tmp_list->next;
+/**
+ * gtk_container_focus_sort:
+ * @container: a #GtkContainer
+ * @children: a list of descendents of @container (they don't
+ * have to be direct children.
+ * @direction: focus direction
+ * @old_focus: widget to use for the starting position, or %NULL
+ * to determine this automatically.
+ * [ Note, this argument isn't used for GTK_DIR_TAB_*,
+ * which is the only @direction we use currently,
+ * so perhaps this argument should be removed ]
+ *
+ * Sorts @children in the correct order for focusing with
+ * direction type @direction.
+ *
+ * Return value: a copy of @children, sorted in correct focusing order,
+ * with children that aren't suitable for focusing in this direction
+ * removed.
+ **/
+GList *
+_gtk_container_focus_sort (GtkContainer *container,
+ GList *children,
+ GtkDirectionType direction,
+ GtkWidget *old_focus)
+{
+ GList *visible_children = NULL;
+
+ while (children)
+ {
+ if (GTK_WIDGET_REALIZED (children->data))
+ visible_children = g_list_prepend (visible_children, children->data);
+ children = children->next;
+ }
+
+ switch (direction)
+ {
+ case GTK_DIR_TAB_FORWARD:
+ case GTK_DIR_TAB_BACKWARD:
+ return gtk_container_focus_sort_tab (container, visible_children, direction, old_focus);
+ case GTK_DIR_UP:
+ case GTK_DIR_DOWN:
+ return gtk_container_focus_sort_up_down (container, visible_children, direction, old_focus);
+ case GTK_DIR_LEFT:
+ case GTK_DIR_RIGHT:
+ return gtk_container_focus_sort_left_right (container, visible_children, direction, old_focus);
}
- if (direction == GTK_DIR_LEFT)
- children = g_list_reverse (children);
+ g_assert_not_reached ();
- return gtk_container_focus_move (container, children, direction);
+ return NULL;
}
-static gint
+static gboolean
gtk_container_focus_move (GtkContainer *container,
GList *children,
GtkDirectionType direction)
GtkWidget *child;
focus_child = container->focus_child;
- gtk_container_set_focus_child (container, NULL);
while (children)
{
if (!child)
continue;
-
+
if (focus_child)
{
if (focus_child == child)
{
focus_child = NULL;
- if (GTK_WIDGET_DRAWABLE (child) &&
- GTK_IS_CONTAINER (child) &&
- !GTK_WIDGET_HAS_FOCUS (child))
- if (gtk_container_focus (GTK_CONTAINER (child), direction))
+ if (gtk_widget_child_focus (child, direction))
return TRUE;
}
}
- else if (GTK_WIDGET_DRAWABLE (child))
+ else if (GTK_WIDGET_DRAWABLE (child) &&
+ gtk_widget_is_ancestor (child, GTK_WIDGET (container)))
{
- if (GTK_IS_CONTAINER (child))
- {
- if (gtk_container_focus (GTK_CONTAINER (child), direction))
- return TRUE;
- }
- else if (GTK_WIDGET_CAN_FOCUS (child))
- {
- gtk_widget_grab_focus (child);
- return TRUE;
- }
+ if (gtk_widget_child_focus (child, direction))
+ return TRUE;
}
}
*children = g_list_prepend (*children, widget);
}
+static void
+chain_widget_destroyed (GtkWidget *widget,
+ gpointer user_data)
+{
+ GtkContainer *container;
+ GList *chain;
+
+ container = GTK_CONTAINER (user_data);
+
+ chain = g_object_get_data (G_OBJECT (container),
+ "gtk-container-focus-chain");
+
+ chain = g_list_remove (chain, widget);
+
+ g_signal_handlers_disconnect_by_func (widget,
+ chain_widget_destroyed,
+ user_data);
+
+ g_object_set_data (G_OBJECT (container),
+ I_("gtk-container-focus-chain"),
+ chain);
+}
+
+/**
+ * gtk_container_set_focus_chain:
+ * @container: a #GtkContainer.
+ * @focusable_widgets: the new focus chain.
+ *
+ * Sets a focus chain, overriding the one computed automatically by GTK+.
+ *
+ * In principle each widget in the chain should be a descendant of the
+ * container, but this is not enforced by this method, since it's allowed
+ * to set the focus chain before you pack the widgets, or have a widget
+ * in the chain that isn't always packed. The necessary checks are done
+ * when the focus chain is actually traversed.
+ **/
+void
+gtk_container_set_focus_chain (GtkContainer *container,
+ GList *focusable_widgets)
+{
+ GList *chain;
+ GList *tmp_list;
+
+ g_return_if_fail (GTK_IS_CONTAINER (container));
+
+ if (container->has_focus_chain)
+ gtk_container_unset_focus_chain (container);
+
+ container->has_focus_chain = TRUE;
+
+ chain = NULL;
+ tmp_list = focusable_widgets;
+ while (tmp_list != NULL)
+ {
+ g_return_if_fail (GTK_IS_WIDGET (tmp_list->data));
+
+ /* In principle each widget in the chain should be a descendant
+ * of the container, but we don't want to check that here, it's
+ * expensive and also it's allowed to set the focus chain before
+ * you pack the widgets, or have a widget in the chain that isn't
+ * always packed. So we check for ancestor during actual traversal.
+ */
+
+ chain = g_list_prepend (chain, tmp_list->data);
+
+ g_signal_connect (tmp_list->data,
+ "destroy",
+ G_CALLBACK (chain_widget_destroyed),
+ container);
+
+ tmp_list = g_list_next (tmp_list);
+ }
+
+ chain = g_list_reverse (chain);
+
+ g_object_set_data (G_OBJECT (container),
+ I_("gtk-container-focus-chain"),
+ chain);
+}
+
+/**
+ * gtk_container_get_focus_chain:
+ * @container: a #GtkContainer
+ * @focusable_widgets: location to store the focus chain of the
+ * container, or %NULL. You should free this list
+ * using g_list_free() when you are done with it, however
+ * no additional reference count is added to the
+ * individual widgets in the focus chain.
+ *
+ * Retrieves the focus chain of the container, if one has been
+ * set explicitly. If no focus chain has been explicitly
+ * set, GTK+ computes the focus chain based on the positions
+ * of the children. In that case, GTK+ stores %NULL in
+ * @focusable_widgets and returns %FALSE.
+ *
+ * Return value: %TRUE if the focus chain of the container
+ * has been set explicitly.
+ **/
+gboolean
+gtk_container_get_focus_chain (GtkContainer *container,
+ GList **focus_chain)
+{
+ g_return_val_if_fail (GTK_IS_CONTAINER (container), FALSE);
+
+ if (focus_chain)
+ {
+ if (container->has_focus_chain)
+ *focus_chain = g_list_copy (get_focus_chain (container));
+ else
+ *focus_chain = NULL;
+ }
+
+ return container->has_focus_chain;
+}
+
+/**
+ * gtk_container_unset_focus_chain:
+ * @container: a #GtkContainer.
+ *
+ * Removes a focus chain explicitly set with gtk_container_set_focus_chain().
+ **/
+void
+gtk_container_unset_focus_chain (GtkContainer *container)
+{
+ g_return_if_fail (GTK_IS_CONTAINER (container));
+
+ if (container->has_focus_chain)
+ {
+ GList *chain;
+ GList *tmp_list;
+
+ chain = get_focus_chain (container);
+
+ container->has_focus_chain = FALSE;
+
+ g_object_set_data (G_OBJECT (container),
+ I_("gtk-container-focus-chain"),
+ NULL);
+
+ tmp_list = chain;
+ while (tmp_list != NULL)
+ {
+ g_signal_handlers_disconnect_by_func (tmp_list->data,
+ chain_widget_destroyed,
+ container);
+
+ tmp_list = g_list_next (tmp_list);
+ }
+
+ g_list_free (chain);
+ }
+}
+
+/**
+ * gtk_container_set_focus_vadjustment:
+ * @container: a #GtkContainer
+ * @adjustment: an adjustment which should be adjusted when the focus is moved among the
+ * descendents of @container
+ *
+ * Hooks up an adjustment to focus handling in a container, so when a child of the
+ * container is focused, the adjustment is scrolled to show that widget. This function
+ * sets the vertical alignment. See gtk_scrolled_window_get_vadjustment() for a typical
+ * way of obtaining the adjustment and gtk_container_set_focus_hadjustment() for setting
+ * the horizontal adjustment.
+ *
+ * The adjustments have to be in pixel units and in the same coordinate system as the
+ * allocation for immediate children of the container.
+ */
void
gtk_container_set_focus_vadjustment (GtkContainer *container,
GtkAdjustment *adjustment)
{
- g_return_if_fail (container != NULL);
g_return_if_fail (GTK_IS_CONTAINER (container));
if (adjustment)
g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
if (adjustment)
- gtk_object_ref (GTK_OBJECT(adjustment));
+ g_object_ref (adjustment);
+
+ g_object_set_qdata_full (G_OBJECT (container),
+ vadjustment_key_id,
+ adjustment,
+ g_object_unref);
+}
+
+/**
+ * gtk_container_get_focus_vadjustment:
+ * @container: a #GtkContainer
+ *
+ * Retrieves the vertical focus adjustment for the container. See
+ * gtk_container_set_focus_vadjustment ().
+ *
+ * Return value: the vertical focus adjustment, or %NULL if
+ * none has been set.
+ **/
+GtkAdjustment *
+gtk_container_get_focus_vadjustment (GtkContainer *container)
+{
+ GtkAdjustment *vadjustment;
+
+ g_return_val_if_fail (GTK_IS_CONTAINER (container), NULL);
- gtk_object_set_data_by_id_full (GTK_OBJECT (container),
- vadjustment_key_id,
- adjustment,
- (GtkDestroyNotify) gtk_object_unref);
+ vadjustment = g_object_get_qdata (G_OBJECT (container), vadjustment_key_id);
+
+ return vadjustment;
}
+/**
+ * gtk_container_set_focus_hadjustment:
+ * @container: a #GtkContainer
+ * @adjustment: an adjustment which should be adjusted when the focus is moved among the
+ * descendents of @container
+ *
+ * Hooks up an adjustment to focus handling in a container, so when a child of the
+ * container is focused, the adjustment is scrolled to show that widget. This function
+ * sets the horizontal alignment. See gtk_scrolled_window_get_hadjustment() for a typical
+ * way of obtaining the adjustment and gtk_container_set_focus_vadjustment() for setting
+ * the vertical adjustment.
+ *
+ * The adjustments have to be in pixel units and in the same coordinate system as the
+ * allocation for immediate children of the container.
+ */
void
gtk_container_set_focus_hadjustment (GtkContainer *container,
GtkAdjustment *adjustment)
{
- g_return_if_fail (container != NULL);
g_return_if_fail (GTK_IS_CONTAINER (container));
if (adjustment)
g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
if (adjustment)
- gtk_object_ref (GTK_OBJECT (adjustment));
+ g_object_ref (adjustment);
- gtk_object_set_data_by_id_full (GTK_OBJECT (container),
- hadjustment_key_id,
- adjustment,
- (GtkDestroyNotify) gtk_object_unref);
+ g_object_set_qdata_full (G_OBJECT (container),
+ hadjustment_key_id,
+ adjustment,
+ g_object_unref);
+}
+
+/**
+ * gtk_container_get_focus_hadjustment:
+ * @container: a #GtkContainer
+ *
+ * Retrieves the horizontal focus adjustment for the container. See
+ * gtk_container_set_focus_hadjustment ().
+ *
+ * Return value: the horizontal focus adjustment, or %NULL if
+ * none has been set.
+ **/
+GtkAdjustment *
+gtk_container_get_focus_hadjustment (GtkContainer *container)
+{
+ GtkAdjustment *hadjustment;
+
+ g_return_val_if_fail (GTK_IS_CONTAINER (container), NULL);
+
+ hadjustment = g_object_get_qdata (G_OBJECT (container), hadjustment_key_id);
+
+ return hadjustment;
}
static void
gtk_container_show_all (GtkWidget *widget)
{
- g_return_if_fail (widget != NULL);
g_return_if_fail (GTK_IS_CONTAINER (widget));
gtk_container_foreach (GTK_CONTAINER (widget),
static void
gtk_container_hide_all (GtkWidget *widget)
{
- g_return_if_fail (widget != NULL);
g_return_if_fail (GTK_IS_CONTAINER (widget));
gtk_widget_hide (widget);
(GtkCallback) gtk_widget_hide_all,
NULL);
}
+
+
+static void
+gtk_container_expose_child (GtkWidget *child,
+ gpointer client_data)
+{
+ struct {
+ GtkWidget *container;
+ GdkEventExpose *event;
+ } *data = client_data;
+
+ gtk_container_propagate_expose (GTK_CONTAINER (data->container),
+ child,
+ data->event);
+}
+
+static gint
+gtk_container_expose (GtkWidget *widget,
+ GdkEventExpose *event)
+{
+ struct {
+ GtkWidget *container;
+ GdkEventExpose *event;
+ } data;
+
+ g_return_val_if_fail (GTK_IS_CONTAINER (widget), FALSE);
+ g_return_val_if_fail (event != NULL, FALSE);
+
+
+ if (GTK_WIDGET_DRAWABLE (widget))
+ {
+ data.container = widget;
+ data.event = event;
+
+ gtk_container_forall (GTK_CONTAINER (widget),
+ gtk_container_expose_child,
+ &data);
+ }
+
+ return FALSE;
+}
+
+static void
+gtk_container_map_child (GtkWidget *child,
+ gpointer client_data)
+{
+ if (GTK_WIDGET_VISIBLE (child) &&
+ GTK_WIDGET_CHILD_VISIBLE (child) &&
+ !GTK_WIDGET_MAPPED (child))
+ gtk_widget_map (child);
+}
+
+static void
+gtk_container_map (GtkWidget *widget)
+{
+ GTK_WIDGET_SET_FLAGS (widget, GTK_MAPPED);
+
+ gtk_container_forall (GTK_CONTAINER (widget),
+ gtk_container_map_child,
+ NULL);
+
+ if (!GTK_WIDGET_NO_WINDOW (widget))
+ gdk_window_show (widget->window);
+}
+
+static void
+gtk_container_unmap (GtkWidget *widget)
+{
+ GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
+
+ if (!GTK_WIDGET_NO_WINDOW (widget))
+ gdk_window_hide (widget->window);
+ else
+ gtk_container_forall (GTK_CONTAINER (widget),
+ (GtkCallback)gtk_widget_unmap,
+ NULL);
+}
+
+/**
+ * gtk_container_propagate_expose:
+ * @container: a #GtkContainer
+ * @child: a child of @container
+ * @event: a expose event sent to container
+ *
+ * When a container receives an expose event, it must send synthetic
+ * expose events to all children that don't have their own #GdkWindows.
+ * This function provides a convenient way of doing this. A container,
+ * when it receives an expose event, calls gtk_container_propagate_expose()
+ * once for each child, passing in the event the container received.
+ *
+ * gtk_container_propagate_expose() takes care of deciding whether
+ * an expose event needs to be sent to the child, intersecting
+ * the event's area with the child area, and sending the event.
+ *
+ * In most cases, a container can simply either simply inherit the
+ * ::expose implementation from #GtkContainer, or, do some drawing
+ * and then chain to the ::expose implementation from #GtkContainer.
+ **/
+void
+gtk_container_propagate_expose (GtkContainer *container,
+ GtkWidget *child,
+ GdkEventExpose *event)
+{
+ GdkEvent *child_event;
+
+ g_return_if_fail (GTK_IS_CONTAINER (container));
+ g_return_if_fail (GTK_IS_WIDGET (child));
+ g_return_if_fail (event != NULL);
+
+ g_assert (child->parent == GTK_WIDGET (container));
+
+ if (GTK_WIDGET_DRAWABLE (child) &&
+ GTK_WIDGET_NO_WINDOW (child) &&
+ (child->window == event->window))
+ {
+ child_event = gdk_event_new (GDK_EXPOSE);
+ child_event->expose = *event;
+ g_object_ref (child_event->expose.window);
+
+ child_event->expose.region = gtk_widget_region_intersect (child, event->region);
+ if (!gdk_region_empty (child_event->expose.region))
+ {
+ gdk_region_get_clipbox (child_event->expose.region, &child_event->expose.area);
+ gtk_widget_send_expose (child, child_event);
+ }
+ gdk_event_free (child_event);
+ }
+}
+
+#define __GTK_CONTAINER_C__
+#include "gtkaliasdef.c"
projects / ~andy / gtk / blobdiff