Pileus Git - ~andy/gtk/blob - gtk/gtkwidget.c

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GTK+ Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #include "config.h"
  28 #include <stdarg.h>
  29 #include <string.h>
  30 #include <locale.h>
  31 #include "gtkcontainer.h"
  32 #include "gtkaccelmap.h"
  33 #include "gtkclipboard.h"
  34 #include "gtkiconfactory.h"
  35 #include "gtkintl.h"
  36 #include "gtkmain.h"
  37 #include "gtkmarshalers.h"
  38 #include "gtkrc.h"
  39 #include "gtkselection.h"
  40 #include "gtksettings.h"
  41 #include "gtksizegroup.h"
  42 #include "gtkwidget.h"
  43 #include "gtkwindow.h"
  44 #include "gtkbindings.h"
  45 #include "gtkprivate.h"
  46 #include "gdk/gdk.h"
  47 #include "gdk/gdkprivate.h" /* Used in gtk_reset_shapes_recurse to avoid copy */
  48 #include <gobject/gvaluecollector.h>
  49 #include <gobject/gobjectnotifyqueue.c>
  50 #include "gdk/gdkkeysyms.h"
  51 #include "gtkaccessible.h"
  52 #include "gtktooltip.h"
  53 #include "gtkinvisible.h"
  54 #include "gtkbuildable.h"
  55 #include "gtkbuilderprivate.h"
  56 #include "gtkalias.h"
  57
  58 /**
  59  * SECTION:gtkwidget
  60  * @Short_description: Base class for all widgets
  61  * @Title: GtkWidget
  62  *
  63  * GtkWidget is the base class all widgets in GTK+ derive from. It manages the
  64  * widget lifecycle, states and style.
  65  * <refsect2 id="style-properties">
  66  * <para>
  67  * <structname>GtkWidget</structname> introduces <firstterm>style
  68  * properties</firstterm> - these are basically object properties that are stored
  69  * not on the object, but in the style object associated to the widget. Style
  70  * properties are set in <link linkend="gtk-Resource-Files">resource files</link>.
  71  * This mechanism is used for configuring such things as the location of the
  72  * scrollbar arrows through the theme, giving theme authors more control over the
  73  * look of applications without the need to write a theme engine in C.
  74  * </para>
  75  * <para>
  76  * Use gtk_widget_class_install_style_property() to install style properties for
  77  * a widget class, gtk_widget_class_find_style_property() or
  78  * gtk_widget_class_list_style_properties() to get information about existing
  79  * style properties and gtk_widget_style_get_property(), gtk_widget_style_get() or
  80  * gtk_widget_style_get_valist() to obtain the value of a style property.
  81  * </para>
  82  * </refsect2>
  83  * <refsect2 id="GtkWidget-BUILDER-UI">
  84  * <title>GtkWidget as GtkBuildable</title>
  85  * <para>
  86  * The GtkWidget implementation of the GtkBuildable interface supports a
  87  * custom &lt;accelerator&gt; element, which has attributes named key,
  88  * modifiers and signal and allows to specify accelerators.
  89  * </para>
  90  * <example>
  91  * <title>A UI definition fragment specifying an accelerator</title>
  92  * <programlisting><![CDATA[
  93  * <object class="GtkButton">
  94  *   <accelerator key="q" modifiers="GDK_CONTROL_MASK" signal="clicked"/>
  95  * </object>
  96  * ]]></programlisting>
  97  * </example>
  98  * <para>
  99  * In addition to accelerators, <structname>GtkWidget</structname> also support a
 100  * custom &lt;accessible&gt; element, which supports actions and relations.
 101  * Properties on the accessible implementation of an object can be set by accessing the
 102  * internal child "accessible" of a <structname>GtkWidget</structname>.
 103  * </para>
 104  * <example>
 105  * <title>A UI definition fragment specifying an accessible</title>
 106  * <programlisting><![CDATA[
 107  * <object class="GtkButton" id="label1"/>
 108  *   <property name="label">I am a Label for a Button</property>
 109  * </object>
 110  * <object class="GtkButton" id="button1">
 111  *   <accessibility>
 112  *     <action action_name="click" translatable="yes">Click the button.</action>
 113  *     <relation target="label1" type="labelled-by"/>
 114  *   </accessibility>
 115  *   <child internal-child="accessible">
 116  *     <object class="AtkObject" id="a11y-button1">
 117  *       <property name="AtkObject::name">Clickable Button</property>
 118  *     </object>
 119  *   </child>
 120  * </object>
 121  * ]]></programlisting>
 122  * </example>
 123  * </refsect2>
 124  */
 125
 126 #define WIDGET_CLASS(w)  GTK_WIDGET_GET_CLASS (w)
 127 #define INIT_PATH_SIZE  (512)
 128
 129
 130 enum {
 131   SHOW,
 132   HIDE,
 133   MAP,
 134   UNMAP,
 135   REALIZE,
 136   UNREALIZE,
 137   SIZE_REQUEST,
 138   SIZE_ALLOCATE,
 139   STATE_CHANGED,
 140   PARENT_SET,
 141   HIERARCHY_CHANGED,
 142   STYLE_SET,
 143   DIRECTION_CHANGED,
 144   GRAB_NOTIFY,
 145   CHILD_NOTIFY,
 146   MNEMONIC_ACTIVATE,
 147   GRAB_FOCUS,
 148   FOCUS,
 149   MOVE_FOCUS,
 150   EVENT,
 151   EVENT_AFTER,
 152   BUTTON_PRESS_EVENT,
 153   BUTTON_RELEASE_EVENT,
 154   SCROLL_EVENT,
 155   MOTION_NOTIFY_EVENT,
 156   DELETE_EVENT,
 157   DESTROY_EVENT,
 158   EXPOSE_EVENT,
 159   KEY_PRESS_EVENT,
 160   KEY_RELEASE_EVENT,
 161   ENTER_NOTIFY_EVENT,
 162   LEAVE_NOTIFY_EVENT,
 163   CONFIGURE_EVENT,
 164   FOCUS_IN_EVENT,
 165   FOCUS_OUT_EVENT,
 166   MAP_EVENT,
 167   UNMAP_EVENT,
 168   PROPERTY_NOTIFY_EVENT,
 169   SELECTION_CLEAR_EVENT,
 170   SELECTION_REQUEST_EVENT,
 171   SELECTION_NOTIFY_EVENT,
 172   SELECTION_GET,
 173   SELECTION_RECEIVED,
 174   PROXIMITY_IN_EVENT,
 175   PROXIMITY_OUT_EVENT,
 176   DRAG_BEGIN,
 177   DRAG_END,
 178   DRAG_DATA_DELETE,
 179   DRAG_LEAVE,
 180   DRAG_MOTION,
 181   DRAG_DROP,
 182   DRAG_DATA_GET,
 183   DRAG_DATA_RECEIVED,
 184   CLIENT_EVENT,
 185   NO_EXPOSE_EVENT,
 186   VISIBILITY_NOTIFY_EVENT,
 187   WINDOW_STATE_EVENT,
 188   POPUP_MENU,
 189   SHOW_HELP,
 190   ACCEL_CLOSURES_CHANGED,
 191   SCREEN_CHANGED,
 192   CAN_ACTIVATE_ACCEL,
 193   GRAB_BROKEN,
 194   COMPOSITED_CHANGED,
 195   QUERY_TOOLTIP,
 196   KEYNAV_FAILED,
 197   DRAG_FAILED,
 198   DAMAGE_EVENT,
 199   LAST_SIGNAL
 200 };
 201
 202 enum {
 203   PROP_0,
 204   PROP_NAME,
 205   PROP_PARENT,
 206   PROP_WIDTH_REQUEST,
 207   PROP_HEIGHT_REQUEST,
 208   PROP_VISIBLE,
 209   PROP_SENSITIVE,
 210   PROP_APP_PAINTABLE,
 211   PROP_CAN_FOCUS,
 212   PROP_HAS_FOCUS,
 213   PROP_IS_FOCUS,
 214   PROP_CAN_DEFAULT,
 215   PROP_HAS_DEFAULT,
 216   PROP_RECEIVES_DEFAULT,
 217   PROP_COMPOSITE_CHILD,
 218   PROP_STYLE,
 219   PROP_EVENTS,
 220   PROP_EXTENSION_EVENTS,
 221   PROP_NO_SHOW_ALL,
 222   PROP_HAS_TOOLTIP,
 223   PROP_TOOLTIP_MARKUP,
 224   PROP_TOOLTIP_TEXT,
 225   PROP_WINDOW,
 226   PROP_DOUBLE_BUFFERED
 227 };
 228
 229 typedef struct  _GtkStateData    GtkStateData;
 230
 231 struct _GtkStateData
 232 {
 233   GtkStateType  state;
 234   guint         state_restoration : 1;
 235   guint         parent_sensitive : 1;
 236   guint         use_forall : 1;
 237 };
 238
 239 /* --- prototypes --- */
 240 static void     gtk_widget_class_init           (GtkWidgetClass     *klass);
 241 static void     gtk_widget_base_class_finalize  (GtkWidgetClass     *klass);
 242 static void     gtk_widget_init                 (GtkWidget          *widget);
 243 static void     gtk_widget_set_property          (GObject           *object,
 244                                                   guint              prop_id,
 245                                                   const GValue      *value,
 246                                                   GParamSpec        *pspec);
 247 static void     gtk_widget_get_property          (GObject           *object,
 248                                                   guint              prop_id,
 249                                                   GValue            *value,
 250                                                   GParamSpec        *pspec);
 251 static void     gtk_widget_dispose               (GObject           *object);
 252 static void     gtk_widget_real_destroy          (GtkObject         *object);
 253 static void     gtk_widget_finalize              (GObject           *object);
 254 static void     gtk_widget_real_show             (GtkWidget         *widget);
 255 static void     gtk_widget_real_hide             (GtkWidget         *widget);
 256 static void     gtk_widget_real_map              (GtkWidget         *widget);
 257 static void     gtk_widget_real_unmap            (GtkWidget         *widget);
 258 static void     gtk_widget_real_realize          (GtkWidget         *widget);
 259 static void     gtk_widget_real_unrealize        (GtkWidget         *widget);
 260 static void     gtk_widget_real_size_request     (GtkWidget         *widget,
 261                                                   GtkRequisition    *requisition);
 262 static void     gtk_widget_real_size_allocate    (GtkWidget         *widget,
 263                                                   GtkAllocation     *allocation);
 264 static void     gtk_widget_real_style_set        (GtkWidget         *widget,
 265                                                   GtkStyle          *previous_style);
 266 static void     gtk_widget_real_direction_changed(GtkWidget         *widget,
 267                                                   GtkTextDirection   previous_direction);
 268
 269 static void     gtk_widget_real_grab_focus       (GtkWidget         *focus_widget);
 270 static gboolean gtk_widget_real_query_tooltip    (GtkWidget         *widget,
 271                                                   gint               x,
 272                                                   gint               y,
 273                                                   gboolean           keyboard_tip,
 274                                                   GtkTooltip        *tooltip);
 275 static gboolean gtk_widget_real_show_help        (GtkWidget         *widget,
 276                                                   GtkWidgetHelpType  help_type);
 277
 278 static void     gtk_widget_dispatch_child_properties_changed    (GtkWidget        *object,
 279                                                                  guint             n_pspecs,
 280                                                                  GParamSpec      **pspecs);
 281 static gboolean         gtk_widget_real_key_press_event         (GtkWidget        *widget,
 282                                                                  GdkEventKey      *event);
 283 static gboolean         gtk_widget_real_key_release_event       (GtkWidget        *widget,
 284                                                                  GdkEventKey      *event);
 285 static gboolean         gtk_widget_real_focus_in_event           (GtkWidget       *widget,
 286                                                                   GdkEventFocus   *event);
 287 static gboolean         gtk_widget_real_focus_out_event         (GtkWidget        *widget,
 288                                                                  GdkEventFocus    *event);
 289 static gboolean         gtk_widget_real_focus                   (GtkWidget        *widget,
 290                                                                  GtkDirectionType  direction);
 291 static void             gtk_widget_real_move_focus              (GtkWidget        *widget,
 292                                                                  GtkDirectionType  direction);
 293 static gboolean         gtk_widget_real_keynav_failed           (GtkWidget        *widget,
 294                                                                  GtkDirectionType  direction);
 295 static PangoContext*    gtk_widget_peek_pango_context           (GtkWidget        *widget);
 296 static void             gtk_widget_update_pango_context         (GtkWidget        *widget);
 297 static void             gtk_widget_propagate_state              (GtkWidget        *widget,
 298                                                                  GtkStateData     *data);
 299 static void             gtk_widget_reset_rc_style               (GtkWidget        *widget);
 300 static void             gtk_widget_set_style_internal           (GtkWidget        *widget,
 301                                                                  GtkStyle         *style,
 302                                                                  gboolean          initial_emission);
 303 static gint             gtk_widget_event_internal               (GtkWidget        *widget,
 304                                                                  GdkEvent         *event);
 305 static gboolean         gtk_widget_real_mnemonic_activate       (GtkWidget        *widget,
 306                                                                  gboolean          group_cycling);
 307 static void             gtk_widget_aux_info_destroy             (GtkWidgetAuxInfo *aux_info);
 308 static AtkObject*       gtk_widget_real_get_accessible          (GtkWidget        *widget);
 309 static void             gtk_widget_accessible_interface_init    (AtkImplementorIface *iface);
 310 static AtkObject*       gtk_widget_ref_accessible               (AtkImplementor *implementor);
 311 static void             gtk_widget_invalidate_widget_windows    (GtkWidget        *widget,
 312                                                                  GdkRegion        *region);
 313 static GdkScreen *      gtk_widget_get_screen_unchecked         (GtkWidget        *widget);
 314 static void             gtk_widget_queue_shallow_draw           (GtkWidget        *widget);
 315 static gboolean         gtk_widget_real_can_activate_accel      (GtkWidget *widget,
 316                                                                  guint      signal_id);
 317
 318 static void             gtk_widget_real_set_has_tooltip         (GtkWidget *widget,
 319                                                                  gboolean   has_tooltip,
 320                                                                  gboolean   force);
 321 static void             gtk_widget_buildable_interface_init     (GtkBuildableIface *iface);
 322 static void             gtk_widget_buildable_set_name           (GtkBuildable     *buildable,
 323                                                                  const gchar      *name);
 324 static const gchar *    gtk_widget_buildable_get_name           (GtkBuildable     *buildable);
 325 static GObject *        gtk_widget_buildable_get_internal_child (GtkBuildable *buildable,
 326                                                                  GtkBuilder   *builder,
 327                                                                  const gchar  *childname);
 328 static void             gtk_widget_buildable_set_buildable_property (GtkBuildable     *buildable,
 329                                                                      GtkBuilder       *builder,
 330                                                                      const gchar      *name,
 331                                                                      const GValue     *value);
 332 static gboolean         gtk_widget_buildable_custom_tag_start   (GtkBuildable     *buildable,
 333                                                                  GtkBuilder       *builder,
 334                                                                  GObject          *child,
 335                                                                  const gchar      *tagname,
 336                                                                  GMarkupParser    *parser,
 337                                                                  gpointer         *data);
 338 static void             gtk_widget_buildable_custom_finished    (GtkBuildable     *buildable,
 339                                                                  GtkBuilder       *builder,
 340                                                                  GObject          *child,
 341                                                                  const gchar      *tagname,
 342                                                                  gpointer          data);
 343 static void             gtk_widget_buildable_parser_finished    (GtkBuildable     *buildable,
 344                                                                  GtkBuilder       *builder);
 345
 346 static void             gtk_widget_queue_tooltip_query          (GtkWidget *widget);
 347
 348 static void gtk_widget_set_usize_internal (GtkWidget *widget,
 349                                            gint       width,
 350                                            gint       height);
 351 static void gtk_widget_get_draw_rectangle (GtkWidget    *widget,
 352                                            GdkRectangle *rect);
 353
 354
 355 /* --- variables --- */
 356 static gpointer         gtk_widget_parent_class = NULL;
 357 static guint            widget_signals[LAST_SIGNAL] = { 0 };
 358 static GtkStyle        *gtk_default_style = NULL;
 359 static GSList          *colormap_stack = NULL;
 360 static guint            composite_child_stack = 0;
 361 static GtkTextDirection gtk_default_direction = GTK_TEXT_DIR_LTR;
 362 static GParamSpecPool  *style_property_spec_pool = NULL;
 363
 364 static GQuark           quark_property_parser = 0;
 365 static GQuark           quark_aux_info = 0;
 366 static GQuark           quark_accel_path = 0;
 367 static GQuark           quark_accel_closures = 0;
 368 static GQuark           quark_event_mask = 0;
 369 static GQuark           quark_extension_event_mode = 0;
 370 static GQuark           quark_parent_window = 0;
 371 static GQuark           quark_pointer_window = 0;
 372 static GQuark           quark_shape_info = 0;
 373 static GQuark           quark_input_shape_info = 0;
 374 static GQuark           quark_colormap = 0;
 375 static GQuark           quark_pango_context = 0;
 376 static GQuark           quark_rc_style = 0;
 377 static GQuark           quark_accessible_object = 0;
 378 static GQuark           quark_mnemonic_labels = 0;
 379 static GQuark           quark_tooltip_markup = 0;
 380 static GQuark           quark_has_tooltip = 0;
 381 static GQuark           quark_tooltip_window = 0;
 382 GParamSpecPool         *_gtk_widget_child_property_pool = NULL;
 383 GObjectNotifyContext   *_gtk_widget_child_property_notify_context = NULL;
 384
 385 /* --- functions --- */
 386 GType
 387 gtk_widget_get_type (void)
 388 {
 389   static GType widget_type = 0;
 390
 391   if (G_UNLIKELY (widget_type == 0))
 392     {
 393       const GTypeInfo widget_info =
 394       {
 395         sizeof (GtkWidgetClass),
 396         NULL,           /* base_init */
 397         (GBaseFinalizeFunc) gtk_widget_base_class_finalize,
 398         (GClassInitFunc) gtk_widget_class_init,
 399         NULL,           /* class_finalize */
 400         NULL,           /* class_init */
 401         sizeof (GtkWidget),
 402         0,              /* n_preallocs */
 403         (GInstanceInitFunc) gtk_widget_init,
 404         NULL,           /* value_table */
 405       };
 406
 407       const GInterfaceInfo accessibility_info =
 408       {
 409         (GInterfaceInitFunc) gtk_widget_accessible_interface_init,
 410         (GInterfaceFinalizeFunc) NULL,
 411         NULL /* interface data */
 412       };
 413
 414       const GInterfaceInfo buildable_info =
 415       {
 416         (GInterfaceInitFunc) gtk_widget_buildable_interface_init,
 417         (GInterfaceFinalizeFunc) NULL,
 418         NULL /* interface data */
 419       };
 420
 421       widget_type = g_type_register_static (GTK_TYPE_OBJECT, "GtkWidget",
 422                                            &widget_info, G_TYPE_FLAG_ABSTRACT);
 423
 424       g_type_add_interface_static (widget_type, ATK_TYPE_IMPLEMENTOR,
 425                                    &accessibility_info) ;
 426       g_type_add_interface_static (widget_type, GTK_TYPE_BUILDABLE,
 427                                    &buildable_info) ;
 428
 429     }
 430
 431   return widget_type;
 432 }
 433
 434 static void
 435 child_property_notify_dispatcher (GObject     *object,
 436                                   guint        n_pspecs,
 437                                   GParamSpec **pspecs)
 438 {
 439   GTK_WIDGET_GET_CLASS (object)->dispatch_child_properties_changed (GTK_WIDGET (object), n_pspecs, pspecs);
 440 }
 441
 442 static void
 443 gtk_widget_class_init (GtkWidgetClass *klass)
 444 {
 445   static GObjectNotifyContext cpn_context = { 0, NULL, NULL };
 446   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 447   GtkObjectClass *object_class = GTK_OBJECT_CLASS (klass);
 448   GtkBindingSet *binding_set;
 449
 450   gtk_widget_parent_class = g_type_class_peek_parent (klass);
 451
 452   quark_property_parser = g_quark_from_static_string ("gtk-rc-property-parser");
 453   quark_aux_info = g_quark_from_static_string ("gtk-aux-info");
 454   quark_accel_path = g_quark_from_static_string ("gtk-accel-path");
 455   quark_accel_closures = g_quark_from_static_string ("gtk-accel-closures");
 456   quark_event_mask = g_quark_from_static_string ("gtk-event-mask");
 457   quark_extension_event_mode = g_quark_from_static_string ("gtk-extension-event-mode");
 458   quark_parent_window = g_quark_from_static_string ("gtk-parent-window");
 459   quark_pointer_window = g_quark_from_static_string ("gtk-pointer-window");
 460   quark_shape_info = g_quark_from_static_string ("gtk-shape-info");
 461   quark_input_shape_info = g_quark_from_static_string ("gtk-input-shape-info");
 462   quark_colormap = g_quark_from_static_string ("gtk-colormap");
 463   quark_pango_context = g_quark_from_static_string ("gtk-pango-context");
 464   quark_rc_style = g_quark_from_static_string ("gtk-rc-style");
 465   quark_accessible_object = g_quark_from_static_string ("gtk-accessible-object");
 466   quark_mnemonic_labels = g_quark_from_static_string ("gtk-mnemonic-labels");
 467   quark_tooltip_markup = g_quark_from_static_string ("gtk-tooltip-markup");
 468   quark_has_tooltip = g_quark_from_static_string ("gtk-has-tooltip");
 469   quark_tooltip_window = g_quark_from_static_string ("gtk-tooltip-window");
 470
 471   style_property_spec_pool = g_param_spec_pool_new (FALSE);
 472   _gtk_widget_child_property_pool = g_param_spec_pool_new (TRUE);
 473   cpn_context.quark_notify_queue = g_quark_from_static_string ("GtkWidget-child-property-notify-queue");
 474   cpn_context.dispatcher = child_property_notify_dispatcher;
 475   _gtk_widget_child_property_notify_context = &cpn_context;
 476
 477   gobject_class->dispose = gtk_widget_dispose;
 478   gobject_class->finalize = gtk_widget_finalize;
 479   gobject_class->set_property = gtk_widget_set_property;
 480   gobject_class->get_property = gtk_widget_get_property;
 481
 482   object_class->destroy = gtk_widget_real_destroy;
 483
 484   klass->activate_signal = 0;
 485   klass->set_scroll_adjustments_signal = 0;
 486   klass->dispatch_child_properties_changed = gtk_widget_dispatch_child_properties_changed;
 487   klass->show = gtk_widget_real_show;
 488   klass->show_all = gtk_widget_show;
 489   klass->hide = gtk_widget_real_hide;
 490   klass->hide_all = gtk_widget_hide;
 491   klass->map = gtk_widget_real_map;
 492   klass->unmap = gtk_widget_real_unmap;
 493   klass->realize = gtk_widget_real_realize;
 494   klass->unrealize = gtk_widget_real_unrealize;
 495   klass->size_request = gtk_widget_real_size_request;
 496   klass->size_allocate = gtk_widget_real_size_allocate;
 497   klass->state_changed = NULL;
 498   klass->parent_set = NULL;
 499   klass->hierarchy_changed = NULL;
 500   klass->style_set = gtk_widget_real_style_set;
 501   klass->direction_changed = gtk_widget_real_direction_changed;
 502   klass->grab_notify = NULL;
 503   klass->child_notify = NULL;
 504   klass->mnemonic_activate = gtk_widget_real_mnemonic_activate;
 505   klass->grab_focus = gtk_widget_real_grab_focus;
 506   klass->focus = gtk_widget_real_focus;
 507   klass->event = NULL;
 508   klass->button_press_event = NULL;
 509   klass->button_release_event = NULL;
 510   klass->motion_notify_event = NULL;
 511   klass->delete_event = NULL;
 512   klass->destroy_event = NULL;
 513   klass->expose_event = NULL;
 514   klass->key_press_event = gtk_widget_real_key_press_event;
 515   klass->key_release_event = gtk_widget_real_key_release_event;
 516   klass->enter_notify_event = NULL;
 517   klass->leave_notify_event = NULL;
 518   klass->configure_event = NULL;
 519   klass->focus_in_event = gtk_widget_real_focus_in_event;
 520   klass->focus_out_event = gtk_widget_real_focus_out_event;
 521   klass->map_event = NULL;
 522   klass->unmap_event = NULL;
 523   klass->window_state_event = NULL;
 524   klass->property_notify_event = _gtk_selection_property_notify;
 525   klass->selection_clear_event = gtk_selection_clear;
 526   klass->selection_request_event = _gtk_selection_request;
 527   klass->selection_notify_event = _gtk_selection_notify;
 528   klass->selection_received = NULL;
 529   klass->proximity_in_event = NULL;
 530   klass->proximity_out_event = NULL;
 531   klass->drag_begin = NULL;
 532   klass->drag_end = NULL;
 533   klass->drag_data_delete = NULL;
 534   klass->drag_leave = NULL;
 535   klass->drag_motion = NULL;
 536   klass->drag_drop = NULL;
 537   klass->drag_data_received = NULL;
 538   klass->screen_changed = NULL;
 539   klass->can_activate_accel = gtk_widget_real_can_activate_accel;
 540   klass->grab_broken_event = NULL;
 541   klass->query_tooltip = gtk_widget_real_query_tooltip;
 542
 543   klass->show_help = gtk_widget_real_show_help;
 544
 545   /* Accessibility support */
 546   klass->get_accessible = gtk_widget_real_get_accessible;
 547
 548   klass->no_expose_event = NULL;
 549
 550   g_object_class_install_property (gobject_class,
 551                                    PROP_NAME,
 552                                    g_param_spec_string ("name",
 553                                                         P_("Widget name"),
 554                                                         P_("The name of the widget"),
 555                                                         NULL,
 556                                                         GTK_PARAM_READWRITE));
 557   g_object_class_install_property (gobject_class,
 558                                    PROP_PARENT,
 559                                    g_param_spec_object ("parent",
 560                                                         P_("Parent widget"),
 561                                                         P_("The parent widget of this widget. Must be a Container widget"),
 562                                                         GTK_TYPE_CONTAINER,
 563                                                         GTK_PARAM_READWRITE));
 564
 565   g_object_class_install_property (gobject_class,
 566                                    PROP_WIDTH_REQUEST,
 567                                    g_param_spec_int ("width-request",
 568                                                      P_("Width request"),
 569                                                      P_("Override for width request of the widget, or -1 if natural request should be used"),
 570                                                      -1,
 571                                                      G_MAXINT,
 572                                                      -1,
 573                                                      GTK_PARAM_READWRITE));
 574   g_object_class_install_property (gobject_class,
 575                                    PROP_HEIGHT_REQUEST,
 576                                    g_param_spec_int ("height-request",
 577                                                      P_("Height request"),
 578                                                      P_("Override for height request of the widget, or -1 if natural request should be used"),
 579                                                      -1,
 580                                                      G_MAXINT,
 581                                                      -1,
 582                                                      GTK_PARAM_READWRITE));
 583   g_object_class_install_property (gobject_class,
 584                                    PROP_VISIBLE,
 585                                    g_param_spec_boolean ("visible",
 586                                                          P_("Visible"),
 587                                                          P_("Whether the widget is visible"),
 588                                                          FALSE,
 589                                                          GTK_PARAM_READWRITE));
 590   g_object_class_install_property (gobject_class,
 591                                    PROP_SENSITIVE,
 592                                    g_param_spec_boolean ("sensitive",
 593                                                          P_("Sensitive"),
 594                                                          P_("Whether the widget responds to input"),
 595                                                          TRUE,
 596                                                          GTK_PARAM_READWRITE));
 597   g_object_class_install_property (gobject_class,
 598                                    PROP_APP_PAINTABLE,
 599                                    g_param_spec_boolean ("app-paintable",
 600                                                          P_("Application paintable"),
 601                                                          P_("Whether the application will paint directly on the widget"),
 602                                                          FALSE,
 603                                                          GTK_PARAM_READWRITE));
 604   g_object_class_install_property (gobject_class,
 605                                    PROP_CAN_FOCUS,
 606                                    g_param_spec_boolean ("can-focus",
 607                                                          P_("Can focus"),
 608                                                          P_("Whether the widget can accept the input focus"),
 609                                                          FALSE,
 610                                                          GTK_PARAM_READWRITE));
 611   g_object_class_install_property (gobject_class,
 612                                    PROP_HAS_FOCUS,
 613                                    g_param_spec_boolean ("has-focus",
 614                                                          P_("Has focus"),
 615                                                          P_("Whether the widget has the input focus"),
 616                                                          FALSE,
 617                                                          GTK_PARAM_READWRITE));
 618   g_object_class_install_property (gobject_class,
 619                                    PROP_IS_FOCUS,
 620                                    g_param_spec_boolean ("is-focus",
 621                                                          P_("Is focus"),
 622                                                          P_("Whether the widget is the focus widget within the toplevel"),
 623                                                          FALSE,
 624                                                          GTK_PARAM_READWRITE));
 625   g_object_class_install_property (gobject_class,
 626                                    PROP_CAN_DEFAULT,
 627                                    g_param_spec_boolean ("can-default",
 628                                                          P_("Can default"),
 629                                                          P_("Whether the widget can be the default widget"),
 630                                                          FALSE,
 631                                                          GTK_PARAM_READWRITE));
 632   g_object_class_install_property (gobject_class,
 633                                    PROP_HAS_DEFAULT,
 634                                    g_param_spec_boolean ("has-default",
 635                                                          P_("Has default"),
 636                                                          P_("Whether the widget is the default widget"),
 637                                                          FALSE,
 638                                                          GTK_PARAM_READWRITE));
 639   g_object_class_install_property (gobject_class,
 640                                    PROP_RECEIVES_DEFAULT,
 641                                    g_param_spec_boolean ("receives-default",
 642                                                          P_("Receives default"),
 643                                                          P_("If TRUE, the widget will receive the default action when it is focused"),
 644                                                          FALSE,
 645                                                          GTK_PARAM_READWRITE));
 646   g_object_class_install_property (gobject_class,
 647                                    PROP_COMPOSITE_CHILD,
 648                                    g_param_spec_boolean ("composite-child",
 649                                                          P_("Composite child"),
 650                                                          P_("Whether the widget is part of a composite widget"),
 651                                                          FALSE,
 652                                                          GTK_PARAM_READABLE));
 653   g_object_class_install_property (gobject_class,
 654                                    PROP_STYLE,
 655                                    g_param_spec_object ("style",
 656                                                         P_("Style"),
 657                                                         P_("The style of the widget, which contains information about how it will look (colors etc)"),
 658                                                         GTK_TYPE_STYLE,
 659                                                         GTK_PARAM_READWRITE));
 660   g_object_class_install_property (gobject_class,
 661                                    PROP_EVENTS,
 662                                    g_param_spec_flags ("events",
 663                                                        P_("Events"),
 664                                                        P_("The event mask that decides what kind of GdkEvents this widget gets"),
 665                                                        GDK_TYPE_EVENT_MASK,
 666                                                        GDK_STRUCTURE_MASK,
 667                                                        GTK_PARAM_READWRITE));
 668   g_object_class_install_property (gobject_class,
 669                                    PROP_EXTENSION_EVENTS,
 670                                    g_param_spec_enum ("extension-events",
 671                                                       P_("Extension events"),
 672                                                       P_("The mask that decides what kind of extension events this widget gets"),
 673                                                       GDK_TYPE_EXTENSION_MODE,
 674                                                       GDK_EXTENSION_EVENTS_NONE,
 675                                                       GTK_PARAM_READWRITE));
 676   g_object_class_install_property (gobject_class,
 677                                    PROP_NO_SHOW_ALL,
 678                                    g_param_spec_boolean ("no-show-all",
 679                                                          P_("No show all"),
 680                                                          P_("Whether gtk_widget_show_all() should not affect this widget"),
 681                                                          FALSE,
 682                                                          GTK_PARAM_READWRITE));
 683
 684 /**
 685  * GtkWidget:has-tooltip:
 686  *
 687  * Enables or disables the emission of #GtkWidget::query-tooltip on @widget.
 688  * A value of %TRUE indicates that @widget can have a tooltip, in this case
 689  * the widget will be queried using #GtkWidget::query-tooltip to determine
 690  * whether it will provide a tooltip or not.
 691  *
 692  * Note that setting this property to %TRUE for the first time will change
 693  * the event masks of the GdkWindows of this widget to include leave-notify
 694  * and motion-notify events.  This cannot and will not be undone when the
 695  * property is set to %FALSE again.
 696  *
 697  * Since: 2.12
 698  */
 699   g_object_class_install_property (gobject_class,
 700                                    PROP_HAS_TOOLTIP,
 701                                    g_param_spec_boolean ("has-tooltip",
 702                                                          P_("Has tooltip"),
 703                                                          P_("Whether this widget has a tooltip"),
 704                                                          FALSE,
 705                                                          GTK_PARAM_READWRITE));
 706   /**
 707    * GtkWidget:tooltip-text:
 708    *
 709    * Sets the text of tooltip to be the given string.
 710    *
 711    * Also see gtk_tooltip_set_text().
 712    *
 713    * This is a convenience property which will take care of getting the
 714    * tooltip shown if the given string is not %NULL: #GtkWidget:has-tooltip
 715    * will automatically be set to %TRUE and there will be taken care of
 716    * #GtkWidget::query-tooltip in the default signal handler.
 717    *
 718    * Since: 2.12
 719    */
 720   g_object_class_install_property (gobject_class,
 721                                    PROP_TOOLTIP_TEXT,
 722                                    g_param_spec_string ("tooltip-text",
 723                                                         P_("Tooltip Text"),
 724                                                         P_("The contents of the tooltip for this widget"),
 725                                                         NULL,
 726                                                         GTK_PARAM_READWRITE));
 727   /**
 728    * GtkWidget:tooltip-markup:
 729    *
 730    * Sets the text of tooltip to be the given string, which is marked up
 731    * with the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
 732    * Also see gtk_tooltip_set_markup().
 733    *
 734    * This is a convenience property which will take care of getting the
 735    * tooltip shown if the given string is not %NULL: #GtkWidget:has-tooltip
 736    * will automatically be set to %TRUE and there will be taken care of
 737    * #GtkWidget::query-tooltip in the default signal handler.
 738    *
 739    * Since: 2.12
 740    */
 741   g_object_class_install_property (gobject_class,
 742                                    PROP_TOOLTIP_MARKUP,
 743                                    g_param_spec_string ("tooltip-markup",
 744                                                         P_("Tooltip markup"),
 745                                                         P_("The contents of the tooltip for this widget"),
 746                                                         NULL,
 747                                                         GTK_PARAM_READWRITE));
 748
 749   /**
 750    * GtkWidget:window:
 751    *
 752    * The widget's window if it is realized, %NULL otherwise.
 753    *
 754    * Since: 2.14
 755    */
 756   g_object_class_install_property (gobject_class,
 757                                    PROP_WINDOW,
 758                                    g_param_spec_object ("window",
 759                                                         P_("Window"),
 760                                                         P_("The widget's window if it is realized"),
 761                                                         GDK_TYPE_WINDOW,
 762                                                         GTK_PARAM_READABLE));
 763
 764   /**
 765    * GtkWidget:double-buffered
 766    *
 767    * Whether or not the widget is double buffered.
 768    *
 769    * Since: 2.18
 770    */
 771   g_object_class_install_property (gobject_class,
 772                                    PROP_DOUBLE_BUFFERED,
 773                                    g_param_spec_boolean ("double-buffered",
 774                                                          P_("Double Buffered"),
 775                                                          P_("Whether or not the widget is double buffered"),
 776                                                          TRUE,
 777                                                          GTK_PARAM_READWRITE));
 778
 779   /**
 780    * GtkWidget::show:
 781    * @widget: the object which received the signal.
 782    */
 783   widget_signals[SHOW] =
 784     g_signal_new (I_("show"),
 785                   G_TYPE_FROM_CLASS (gobject_class),
 786                   G_SIGNAL_RUN_FIRST,
 787                   G_STRUCT_OFFSET (GtkWidgetClass, show),
 788                   NULL, NULL,
 789                   _gtk_marshal_VOID__VOID,
 790                   G_TYPE_NONE, 0);
 791
 792   /**
 793    * GtkWidget::hide:
 794    * @widget: the object which received the signal.
 795    */
 796   widget_signals[HIDE] =
 797     g_signal_new (I_("hide"),
 798                   G_TYPE_FROM_CLASS (gobject_class),
 799                   G_SIGNAL_RUN_FIRST,
 800                   G_STRUCT_OFFSET (GtkWidgetClass, hide),
 801                   NULL, NULL,
 802                   _gtk_marshal_VOID__VOID,
 803                   G_TYPE_NONE, 0);
 804
 805   /**
 806    * GtkWidget::map:
 807    * @widget: the object which received the signal.
 808    */
 809   widget_signals[MAP] =
 810     g_signal_new (I_("map"),
 811                   G_TYPE_FROM_CLASS (gobject_class),
 812                   G_SIGNAL_RUN_FIRST,
 813                   G_STRUCT_OFFSET (GtkWidgetClass, map),
 814                   NULL, NULL,
 815                   _gtk_marshal_VOID__VOID,
 816                   G_TYPE_NONE, 0);
 817
 818   /**
 819    * GtkWidget::unmap:
 820    * @widget: the object which received the signal.
 821    */
 822   widget_signals[UNMAP] =
 823     g_signal_new (I_("unmap"),
 824                   G_TYPE_FROM_CLASS (gobject_class),
 825                   G_SIGNAL_RUN_FIRST,
 826                   G_STRUCT_OFFSET (GtkWidgetClass, unmap),
 827                   NULL, NULL,
 828                   _gtk_marshal_VOID__VOID,
 829                   G_TYPE_NONE, 0);
 830
 831   /**
 832    * GtkWidget::realize:
 833    * @widget: the object which received the signal.
 834    */
 835   widget_signals[REALIZE] =
 836     g_signal_new (I_("realize"),
 837                   G_TYPE_FROM_CLASS (gobject_class),
 838                   G_SIGNAL_RUN_FIRST,
 839                   G_STRUCT_OFFSET (GtkWidgetClass, realize),
 840                   NULL, NULL,
 841                   _gtk_marshal_VOID__VOID,
 842                   G_TYPE_NONE, 0);
 843
 844   /**
 845    * GtkWidget::unrealize:
 846    * @widget: the object which received the signal.
 847    */
 848   widget_signals[UNREALIZE] =
 849     g_signal_new (I_("unrealize"),
 850                   G_TYPE_FROM_CLASS (gobject_class),
 851                   G_SIGNAL_RUN_LAST,
 852                   G_STRUCT_OFFSET (GtkWidgetClass, unrealize),
 853                   NULL, NULL,
 854                   _gtk_marshal_VOID__VOID,
 855                   G_TYPE_NONE, 0);
 856
 857   /**
 858    * GtkWidget::size-request:
 859    * @widget: the object which received the signal.
 860    * @requisition:
 861    */
 862   widget_signals[SIZE_REQUEST] =
 863     g_signal_new (I_("size-request"),
 864                   G_TYPE_FROM_CLASS (gobject_class),
 865                   G_SIGNAL_RUN_FIRST,
 866                   G_STRUCT_OFFSET (GtkWidgetClass, size_request),
 867                   NULL, NULL,
 868                   _gtk_marshal_VOID__BOXED,
 869                   G_TYPE_NONE, 1,
 870                   GTK_TYPE_REQUISITION | G_SIGNAL_TYPE_STATIC_SCOPE);
 871
 872   /**
 873    * GtkWidget::size-allocate:
 874    * @widget: the object which received the signal.
 875    * @allocation:
 876    */
 877   widget_signals[SIZE_ALLOCATE] =
 878     g_signal_new (I_("size-allocate"),
 879                   G_TYPE_FROM_CLASS (gobject_class),
 880                   G_SIGNAL_RUN_FIRST,
 881                   G_STRUCT_OFFSET (GtkWidgetClass, size_allocate),
 882                   NULL, NULL,
 883                   _gtk_marshal_VOID__BOXED,
 884                   G_TYPE_NONE, 1,
 885                   GDK_TYPE_RECTANGLE | G_SIGNAL_TYPE_STATIC_SCOPE);
 886
 887   /**
 888    * GtkWidget::state-changed:
 889    * @widget: the object which received the signal.
 890    * @state: the previous state
 891    *
 892    * The ::state-changed signal is emitted when the widget state changes.
 893    * See gtk_widget_get_state().
 894    */
 895   widget_signals[STATE_CHANGED] =
 896     g_signal_new (I_("state-changed"),
 897                   G_TYPE_FROM_CLASS (gobject_class),
 898                   G_SIGNAL_RUN_FIRST,
 899                   G_STRUCT_OFFSET (GtkWidgetClass, state_changed),
 900                   NULL, NULL,
 901                   _gtk_marshal_VOID__ENUM,
 902                   G_TYPE_NONE, 1,
 903                   GTK_TYPE_STATE_TYPE);
 904
 905   /**
 906    * GtkWidget::parent-set:
 907    * @widget: the object on which the signal is emitted
 908    * @old_parent: (allow-none): the previous parent, or %NULL if the widget
 909    *   just got its initial parent.
 910    *
 911    * The ::parent-set signal is emitted when a new parent
 912    * has been set on a widget.
 913    */
 914   widget_signals[PARENT_SET] =
 915     g_signal_new (I_("parent-set"),
 916                   G_TYPE_FROM_CLASS (gobject_class),
 917                   G_SIGNAL_RUN_FIRST,
 918                   G_STRUCT_OFFSET (GtkWidgetClass, parent_set),
 919                   NULL, NULL,
 920                   _gtk_marshal_VOID__OBJECT,
 921                   G_TYPE_NONE, 1,
 922                   GTK_TYPE_WIDGET);
 923
 924   /**
 925    * GtkWidget::hierarchy-changed:
 926    * @widget: the object on which the signal is emitted
 927    * @previous_toplevel: (allow-none): the previous toplevel ancestor, or %NULL
 928    *   if the widget was previously unanchored
 929    *
 930    * The ::hierarchy-changed signal is emitted when the
 931    * anchored state of a widget changes. A widget is
 932    * <firstterm>anchored</firstterm> when its toplevel
 933    * ancestor is a #GtkWindow. This signal is emitted when
 934    * a widget changes from un-anchored to anchored or vice-versa.
 935    */
 936   widget_signals[HIERARCHY_CHANGED] =
 937     g_signal_new (I_("hierarchy-changed"),
 938                   G_TYPE_FROM_CLASS (gobject_class),
 939                   G_SIGNAL_RUN_LAST,
 940                   G_STRUCT_OFFSET (GtkWidgetClass, hierarchy_changed),
 941                   NULL, NULL,
 942                   _gtk_marshal_VOID__OBJECT,
 943                   G_TYPE_NONE, 1,
 944                   GTK_TYPE_WIDGET);
 945
 946   /**
 947    * GtkWidget::style-set:
 948    * @widget: the object on which the signal is emitted
 949    * @previous_style: (allow-none): the previous style, or %NULL if the widget
 950    *   just got its initial style
 951    *
 952    * The ::style-set signal is emitted when a new style has been set
 953    * on a widget. Note that style-modifying functions like
 954    * gtk_widget_modify_base() also cause this signal to be emitted.
 955    */
 956   widget_signals[STYLE_SET] =
 957     g_signal_new (I_("style-set"),
 958                   G_TYPE_FROM_CLASS (gobject_class),
 959                   G_SIGNAL_RUN_FIRST,
 960                   G_STRUCT_OFFSET (GtkWidgetClass, style_set),
 961                   NULL, NULL,
 962                   _gtk_marshal_VOID__OBJECT,
 963                   G_TYPE_NONE, 1,
 964                   GTK_TYPE_STYLE);
 965 /**
 966  * GtkWidget::direction-changed:
 967  * @widget: the object on which the signal is emitted
 968  * @previous_direction: the previous text direction of @widget
 969  *
 970  * The ::direction-changed signal is emitted when the text direction
 971  * of a widget changes.
 972  */
 973   widget_signals[DIRECTION_CHANGED] =
 974     g_signal_new (I_("direction-changed"),
 975                   G_TYPE_FROM_CLASS (gobject_class),
 976                   G_SIGNAL_RUN_FIRST,
 977                   G_STRUCT_OFFSET (GtkWidgetClass, direction_changed),
 978                   NULL, NULL,
 979                   _gtk_marshal_VOID__ENUM,
 980                   G_TYPE_NONE, 1,
 981                   GTK_TYPE_TEXT_DIRECTION);
 982
 983   /**
 984    * GtkWidget::grab-notify:
 985    * @widget: the object which received the signal
 986    * @was_grabbed: %FALSE if the widget becomes shadowed, %TRUE
 987    *               if it becomes unshadowed
 988    *
 989    * The ::grab-notify signal is emitted when a widget becomes
 990    * shadowed by a GTK+ grab (not a pointer or keyboard grab) on
 991    * another widget, or when it becomes unshadowed due to a grab
 992    * being removed.
 993    *
 994    * A widget is shadowed by a gtk_grab_add() when the topmost
 995    * grab widget in the grab stack of its window group is not
 996    * its ancestor.
 997    */
 998   widget_signals[GRAB_NOTIFY] =
 999     g_signal_new (I_("grab-notify"),
1000                   G_TYPE_FROM_CLASS (gobject_class),
1001                   G_SIGNAL_RUN_FIRST,
1002                   G_STRUCT_OFFSET (GtkWidgetClass, grab_notify),
1003                   NULL, NULL,
1004                   _gtk_marshal_VOID__BOOLEAN,
1005                   G_TYPE_NONE, 1,
1006                   G_TYPE_BOOLEAN);
1007
1008 /**
1009  * GtkWidget::child-notify:
1010  * @widget: the object which received the signal
1011  * @pspec: the #GParamSpec of the changed child property
1012  *
1013  * The ::child-notify signal is emitted for each
1014  * <link linkend="child-properties">child property</link>  that has
1015  * changed on an object. The signal's detail holds the property name.
1016  */
1017   widget_signals[CHILD_NOTIFY] =
1018     g_signal_new (I_("child-notify"),
1019                    G_TYPE_FROM_CLASS (gobject_class),
1020                    G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE | G_SIGNAL_DETAILED | G_SIGNAL_NO_HOOKS,
1021                    G_STRUCT_OFFSET (GtkWidgetClass, child_notify),
1022                    NULL, NULL,
1023                    g_cclosure_marshal_VOID__PARAM,
1024                    G_TYPE_NONE, 1,
1025                    G_TYPE_PARAM);
1026
1027   /**
1028    * GtkWidget::mnemonic-activate:
1029    * @widget: the object which received the signal.
1030    * @arg1:
1031    */
1032   widget_signals[MNEMONIC_ACTIVATE] =
1033     g_signal_new (I_("mnemonic-activate"),
1034                   G_TYPE_FROM_CLASS (gobject_class),
1035                   G_SIGNAL_RUN_LAST,
1036                   G_STRUCT_OFFSET (GtkWidgetClass, mnemonic_activate),
1037                   _gtk_boolean_handled_accumulator, NULL,
1038                   _gtk_marshal_BOOLEAN__BOOLEAN,
1039                   G_TYPE_BOOLEAN, 1,
1040                   G_TYPE_BOOLEAN);
1041
1042   /**
1043    * GtkWidget::grab-focus:
1044    * @widget: the object which received the signal.
1045    */
1046   widget_signals[GRAB_FOCUS] =
1047     g_signal_new (I_("grab-focus"),
1048                   G_TYPE_FROM_CLASS (gobject_class),
1049                   G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
1050                   G_STRUCT_OFFSET (GtkWidgetClass, grab_focus),
1051                   NULL, NULL,
1052                   _gtk_marshal_VOID__VOID,
1053                   G_TYPE_NONE, 0);
1054
1055   /**
1056    * GtkWidget::focus:
1057    * @widget: the object which received the signal.
1058    * @direction:
1059    *
1060    * Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
1061    */
1062   widget_signals[FOCUS] =
1063     g_signal_new (I_("focus"),
1064                   G_TYPE_FROM_CLASS (object_class),
1065                   G_SIGNAL_RUN_LAST,
1066                   G_STRUCT_OFFSET (GtkWidgetClass, focus),
1067                   _gtk_boolean_handled_accumulator, NULL,
1068                   _gtk_marshal_BOOLEAN__ENUM,
1069                   G_TYPE_BOOLEAN, 1,
1070                   GTK_TYPE_DIRECTION_TYPE);
1071
1072   /**
1073    * GtkWidget::move-focus:
1074    * @widget: the object which received the signal.
1075    * @direction:
1076    */
1077   widget_signals[MOVE_FOCUS] =
1078     g_signal_new_class_handler (I_("move-focus"),
1079                                 G_TYPE_FROM_CLASS (object_class),
1080                                 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
1081                                 G_CALLBACK (gtk_widget_real_move_focus),
1082                                 NULL, NULL,
1083                                 _gtk_marshal_VOID__ENUM,
1084                                 G_TYPE_NONE,
1085                                 1,
1086                                 GTK_TYPE_DIRECTION_TYPE);
1087   /**
1088    * GtkWidget::event:
1089    * @widget: the object which received the signal.
1090    * @event: the #GdkEvent which triggered this signal
1091    *
1092    * The GTK+ main loop will emit three signals for each GDK event delivered
1093    * to a widget: one generic ::event signal, another, more specific,
1094    * signal that matches the type of event delivered (e.g.
1095    * #GtkWidget::key-press-event) and finally a generic
1096    * #GtkWidget::event-after signal.
1097    *
1098    * Returns: %TRUE to stop other handlers from being invoked for the event
1099    * and to cancel the emission of the second specific ::event signal.
1100    *   %FALSE to propagate the event further and to allow the emission of
1101    *   the second signal. The ::event-after signal is emitted regardless of
1102    *   the return value.
1103    */
1104   widget_signals[EVENT] =
1105     g_signal_new (I_("event"),
1106                   G_TYPE_FROM_CLASS (gobject_class),
1107                   G_SIGNAL_RUN_LAST,
1108                   G_STRUCT_OFFSET (GtkWidgetClass, event),
1109                   _gtk_boolean_handled_accumulator, NULL,
1110                   _gtk_marshal_BOOLEAN__BOXED,
1111                   G_TYPE_BOOLEAN, 1,
1112                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1113
1114   /**
1115    * GtkWidget::event-after:
1116    * @widget: the object which received the signal.
1117    * @event: the #GdkEvent which triggered this signal
1118    *
1119    * After the emission of the #GtkWidget::event signal and (optionally)
1120    * the second more specific signal, ::event-after will be emitted
1121    * regardless of the previous two signals handlers return values.
1122    *
1123    */
1124   widget_signals[EVENT_AFTER] =
1125     g_signal_new (I_("event-after"),
1126                   G_TYPE_FROM_CLASS (gobject_class),
1127                   0,
1128                   0,
1129                   NULL, NULL,
1130                   _gtk_marshal_VOID__BOXED,
1131                   G_TYPE_NONE, 1,
1132                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1133
1134   /**
1135    * GtkWidget::button-press-event:
1136    * @widget: the object which received the signal.
1137    * @event: the #GdkEventButton which triggered this signal
1138    *
1139    * The ::button-press-event signal will be emitted when a button
1140    * (typically from a mouse) is pressed.
1141    *
1142    * To receive this signal, the #GdkWindow associated to the
1143    * widget needs to enable the #GDK_BUTTON_PRESS_MASK mask.
1144    *
1145    * This signal will be sent to the grab widget if there is one.
1146    *
1147    * Returns: %TRUE to stop other handlers from being invoked for the event.
1148    *   %FALSE to propagate the event further.
1149    */
1150   widget_signals[BUTTON_PRESS_EVENT] =
1151     g_signal_new (I_("button-press-event"),
1152                   G_TYPE_FROM_CLASS (gobject_class),
1153                   G_SIGNAL_RUN_LAST,
1154                   G_STRUCT_OFFSET (GtkWidgetClass, button_press_event),
1155                   _gtk_boolean_handled_accumulator, NULL,
1156                   _gtk_marshal_BOOLEAN__BOXED,
1157                   G_TYPE_BOOLEAN, 1,
1158                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1159
1160   /**
1161    * GtkWidget::button-release-event:
1162    * @widget: the object which received the signal.
1163    * @event: the #GdkEventButton which triggered this signal
1164    *
1165    * The ::button-release-event signal will be emitted when a button
1166    * (typically from a mouse) is released.
1167    *
1168    * To receive this signal, the #GdkWindow associated to the
1169    * widget needs to enable the #GDK_BUTTON_RELEASE_MASK mask.
1170    *
1171    * This signal will be sent to the grab widget if there is one.
1172    *
1173    * Returns: %TRUE to stop other handlers from being invoked for the event.
1174    *   %FALSE to propagate the event further.
1175    */
1176   widget_signals[BUTTON_RELEASE_EVENT] =
1177     g_signal_new (I_("button-release-event"),
1178                   G_TYPE_FROM_CLASS (gobject_class),
1179                   G_SIGNAL_RUN_LAST,
1180                   G_STRUCT_OFFSET (GtkWidgetClass, button_release_event),
1181                   _gtk_boolean_handled_accumulator, NULL,
1182                   _gtk_marshal_BOOLEAN__BOXED,
1183                   G_TYPE_BOOLEAN, 1,
1184                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1185
1186   /**
1187    * GtkWidget::scroll-event:
1188    * @widget: the object which received the signal.
1189    * @event: the #GdkEventScroll which triggered this signal
1190    *
1191    * The ::scroll-event signal is emitted when a button in the 4 to 7
1192    * range is pressed. Wheel mice are usually configured to generate
1193    * button press events for buttons 4 and 5 when the wheel is turned.
1194    *
1195    * To receive this signal, the #GdkWindow associated to the widget needs
1196    * to enable the #GDK_BUTTON_PRESS_MASK mask.
1197    *
1198    * This signal will be sent to the grab widget if there is one.
1199    *
1200    * Returns: %TRUE to stop other handlers from being invoked for the event.
1201    *   %FALSE to propagate the event further.
1202    */
1203   widget_signals[SCROLL_EVENT] =
1204     g_signal_new (I_("scroll-event"),
1205                   G_TYPE_FROM_CLASS (gobject_class),
1206                   G_SIGNAL_RUN_LAST,
1207                   G_STRUCT_OFFSET (GtkWidgetClass, scroll_event),
1208                   _gtk_boolean_handled_accumulator, NULL,
1209                   _gtk_marshal_BOOLEAN__BOXED,
1210                   G_TYPE_BOOLEAN, 1,
1211                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1212   /**
1213    * GtkWidget::motion-notify-event:
1214    * @widget: the object which received the signal.
1215    * @event: the #GdkEventMotion which triggered this signal
1216    *
1217    * The ::motion-notify-event signal is emitted when the pointer moves
1218    * over the widget's #GdkWindow.
1219    *
1220    * To receive this signal, the #GdkWindow associated to the widget
1221    * needs to enable the #GDK_POINTER_MOTION_MASK mask.
1222    *
1223    * This signal will be sent to the grab widget if there is one.
1224    *
1225    * Returns: %TRUE to stop other handlers from being invoked for the event.
1226    *   %FALSE to propagate the event further.
1227    */
1228   widget_signals[MOTION_NOTIFY_EVENT] =
1229     g_signal_new (I_("motion-notify-event"),
1230                   G_TYPE_FROM_CLASS (gobject_class),
1231                   G_SIGNAL_RUN_LAST,
1232                   G_STRUCT_OFFSET (GtkWidgetClass, motion_notify_event),
1233                   _gtk_boolean_handled_accumulator, NULL,
1234                   _gtk_marshal_BOOLEAN__BOXED,
1235                   G_TYPE_BOOLEAN, 1,
1236                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1237
1238   /**
1239    * GtkWidget::composited-changed:
1240    * @widget: the object on which the signal is emitted
1241    *
1242    * The ::composited-changed signal is emitted when the composited
1243    * status of @widget<!-- -->s screen changes.
1244    * See gdk_screen_is_composited().
1245    */
1246   widget_signals[COMPOSITED_CHANGED] =
1247     g_signal_new (I_("composited-changed"),
1248                   G_TYPE_FROM_CLASS (gobject_class),
1249                   G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
1250                   G_STRUCT_OFFSET (GtkWidgetClass, composited_changed),
1251                   NULL, NULL,
1252                   _gtk_marshal_VOID__VOID,
1253                   G_TYPE_NONE, 0);
1254
1255   /**
1256    * GtkWidget::keynav-failed:
1257    * @widget: the object which received the signal
1258    * @direction: the direction of movement
1259    *
1260    * Gets emitted if keyboard navigation fails.
1261    * See gtk_widget_keynav_failed() for details.
1262    *
1263    * Returns: %TRUE if stopping keyboard navigation is fine, %FALSE
1264    *          if the emitting widget should try to handle the keyboard
1265    *          navigation attempt in its parent container(s).
1266    *
1267    * Since: 2.12
1268    **/
1269   widget_signals[KEYNAV_FAILED] =
1270     g_signal_new_class_handler (I_("keynav-failed"),
1271                                 G_TYPE_FROM_CLASS (gobject_class),
1272                                 G_SIGNAL_RUN_LAST,
1273                                 G_CALLBACK (gtk_widget_real_keynav_failed),
1274                                 _gtk_boolean_handled_accumulator, NULL,
1275                                 _gtk_marshal_BOOLEAN__ENUM,
1276                                 G_TYPE_BOOLEAN, 1,
1277                                 GTK_TYPE_DIRECTION_TYPE);
1278
1279   /**
1280    * GtkWidget::delete-event:
1281    * @widget: the object which received the signal
1282    * @event: the event which triggered this signal
1283    *
1284    * The ::delete-event signal is emitted if a user requests that
1285    * a toplevel window is closed. The default handler for this signal
1286    * destroys the window. Connecting gtk_widget_hide_on_delete() to
1287    * this signal will cause the window to be hidden instead, so that
1288    * it can later be shown again without reconstructing it.
1289    *
1290    * Returns: %TRUE to stop other handlers from being invoked for the event.
1291    *   %FALSE to propagate the event further.
1292    */
1293   widget_signals[DELETE_EVENT] =
1294     g_signal_new (I_("delete-event"),
1295                   G_TYPE_FROM_CLASS (gobject_class),
1296                   G_SIGNAL_RUN_LAST,
1297                   G_STRUCT_OFFSET (GtkWidgetClass, delete_event),
1298                   _gtk_boolean_handled_accumulator, NULL,
1299                   _gtk_marshal_BOOLEAN__BOXED,
1300                   G_TYPE_BOOLEAN, 1,
1301                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1302
1303   /**
1304    * GtkWidget::destroy-event:
1305    * @widget: the object which received the signal.
1306    * @event: the event which triggered this signal
1307    *
1308    * The ::destroy-event signal is emitted when a #GdkWindow is destroyed.
1309    * You rarely get this signal, because most widgets disconnect themselves
1310    * from their window before they destroy it, so no widget owns the
1311    * window at destroy time.
1312    *
1313    * To receive this signal, the #GdkWindow associated to the widget needs
1314    * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
1315    * automatically for all new windows.
1316    *
1317    * Returns: %TRUE to stop other handlers from being invoked for the event.
1318    *   %FALSE to propagate the event further.
1319    */
1320   widget_signals[DESTROY_EVENT] =
1321     g_signal_new (I_("destroy-event"),
1322                   G_TYPE_FROM_CLASS (gobject_class),
1323                   G_SIGNAL_RUN_LAST,
1324                   G_STRUCT_OFFSET (GtkWidgetClass, destroy_event),
1325                   _gtk_boolean_handled_accumulator, NULL,
1326                   _gtk_marshal_BOOLEAN__BOXED,
1327                   G_TYPE_BOOLEAN, 1,
1328                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1329
1330   /**
1331    * GtkWidget::expose-event:
1332    * @widget: the object which received the signal.
1333    * @event: the #GdkEventExpose which triggered this signal
1334    *
1335    * The ::expose-event signal is emitted when an area of a previously
1336    * obscured #GdkWindow is made visible and needs to be redrawn.
1337    * #GTK_NO_WINDOW widgets will get a synthesized event from their parent
1338    * widget.
1339    *
1340    * To receive this signal, the #GdkWindow associated to the widget needs
1341    * to enable the #GDK_EXPOSURE_MASK mask.
1342    *
1343    * Returns: %TRUE to stop other handlers from being invoked for the event.
1344    *   %FALSE to propagate the event further.
1345    */
1346   widget_signals[EXPOSE_EVENT] =
1347     g_signal_new (I_("expose-event"),
1348                   G_TYPE_FROM_CLASS (gobject_class),
1349                   G_SIGNAL_RUN_LAST,
1350                   G_STRUCT_OFFSET (GtkWidgetClass, expose_event),
1351                   _gtk_boolean_handled_accumulator, NULL,
1352                   _gtk_marshal_BOOLEAN__BOXED,
1353                   G_TYPE_BOOLEAN, 1,
1354                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1355
1356   /**
1357    * GtkWidget::key-press-event:
1358    * @widget: the object which received the signal
1359    * @event: the #GdkEventKey which triggered this signal
1360    *
1361    * The ::key-press-event signal is emitted when a key is pressed.
1362    *
1363    * To receive this signal, the #GdkWindow associated to the widget needs
1364    * to enable the #GDK_KEY_PRESS_MASK mask.
1365    *
1366    * This signal will be sent to the grab widget if there is one.
1367    *
1368    * Returns: %TRUE to stop other handlers from being invoked for the event.
1369    *   %FALSE to propagate the event further.
1370    */
1371   widget_signals[KEY_PRESS_EVENT] =
1372     g_signal_new (I_("key-press-event"),
1373                   G_TYPE_FROM_CLASS (gobject_class),
1374                   G_SIGNAL_RUN_LAST,
1375                   G_STRUCT_OFFSET (GtkWidgetClass, key_press_event),
1376                   _gtk_boolean_handled_accumulator, NULL,
1377                   _gtk_marshal_BOOLEAN__BOXED,
1378                   G_TYPE_BOOLEAN, 1,
1379                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1380
1381   /**
1382    * GtkWidget::key-release-event:
1383    * @widget: the object which received the signal
1384    * @event: the #GdkEventKey which triggered this signal
1385    *
1386    * The ::key-release-event signal is emitted when a key is pressed.
1387    *
1388    * To receive this signal, the #GdkWindow associated to the widget needs
1389    * to enable the #GDK_KEY_RELEASE_MASK mask.
1390    *
1391    * This signal will be sent to the grab widget if there is one.
1392    *
1393    * Returns: %TRUE to stop other handlers from being invoked for the event.
1394    *   %FALSE to propagate the event further.
1395    */
1396   widget_signals[KEY_RELEASE_EVENT] =
1397     g_signal_new (I_("key-release-event"),
1398                   G_TYPE_FROM_CLASS (gobject_class),
1399                   G_SIGNAL_RUN_LAST,
1400                   G_STRUCT_OFFSET (GtkWidgetClass, key_release_event),
1401                   _gtk_boolean_handled_accumulator, NULL,
1402                   _gtk_marshal_BOOLEAN__BOXED,
1403                   G_TYPE_BOOLEAN, 1,
1404                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1405
1406   /**
1407    * GtkWidget::enter-notify-event:
1408    * @widget: the object which received the signal
1409    * @event: the #GdkEventCrossing which triggered this signal
1410    *
1411    * The ::enter-notify-event will be emitted when the pointer enters
1412    * the @widget's window.
1413    *
1414    * To receive this signal, the #GdkWindow associated to the widget needs
1415    * to enable the #GDK_ENTER_NOTIFY_MASK mask.
1416    *
1417    * This signal will be sent to the grab widget if there is one.
1418    *
1419    * Returns: %TRUE to stop other handlers from being invoked for the event.
1420    *   %FALSE to propagate the event further.
1421    */
1422   widget_signals[ENTER_NOTIFY_EVENT] =
1423     g_signal_new (I_("enter-notify-event"),
1424                   G_TYPE_FROM_CLASS (gobject_class),
1425                   G_SIGNAL_RUN_LAST,
1426                   G_STRUCT_OFFSET (GtkWidgetClass, enter_notify_event),
1427                   _gtk_boolean_handled_accumulator, NULL,
1428                   _gtk_marshal_BOOLEAN__BOXED,
1429                   G_TYPE_BOOLEAN, 1,
1430                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1431
1432   /**
1433    * GtkWidget::leave-notify-event:
1434    * @widget: the object which received the signal
1435    * @event: the #GdkEventCrossing which triggered this signal
1436    *
1437    * The ::leave-notify-event will be emitted when the pointer leaves
1438    * the @widget's window.
1439    *
1440    * To receive this signal, the #GdkWindow associated to the widget needs
1441    * to enable the #GDK_LEAVE_NOTIFY_MASK mask.
1442    *
1443    * This signal will be sent to the grab widget if there is one.
1444    *
1445    * Returns: %TRUE to stop other handlers from being invoked for the event.
1446    *   %FALSE to propagate the event further.
1447    */
1448   widget_signals[LEAVE_NOTIFY_EVENT] =
1449     g_signal_new (I_("leave-notify-event"),
1450                   G_TYPE_FROM_CLASS (gobject_class),
1451                   G_SIGNAL_RUN_LAST,
1452                   G_STRUCT_OFFSET (GtkWidgetClass, leave_notify_event),
1453                   _gtk_boolean_handled_accumulator, NULL,
1454                   _gtk_marshal_BOOLEAN__BOXED,
1455                   G_TYPE_BOOLEAN, 1,
1456                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1457
1458   /**
1459    * GtkWidget::configure-event
1460    * @widget: the object which received the signal
1461    * @event: the #GdkEventConfigure which triggered this signal
1462    *
1463    * The ::configure-event signal will be emitted when the size, position or
1464    * stacking of the @widget's window has changed.
1465    *
1466    * To receive this signal, the #GdkWindow associated to the widget needs
1467    * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
1468    * automatically for all new windows.
1469    *
1470    * Returns: %TRUE to stop other handlers from being invoked for the event.
1471    *   %FALSE to propagate the event further.
1472    */
1473   widget_signals[CONFIGURE_EVENT] =
1474     g_signal_new (I_("configure-event"),
1475                   G_TYPE_FROM_CLASS (gobject_class),
1476                   G_SIGNAL_RUN_LAST,
1477                   G_STRUCT_OFFSET (GtkWidgetClass, configure_event),
1478                   _gtk_boolean_handled_accumulator, NULL,
1479                   _gtk_marshal_BOOLEAN__BOXED,
1480                   G_TYPE_BOOLEAN, 1,
1481                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1482
1483   /**
1484    * GtkWidget::focus-in-event
1485    * @widget: the object which received the signal
1486    * @event: the #GdkEventFocus which triggered this signal
1487    *
1488    * The ::focus-in-event signal will be emitted when the keyboard focus
1489    * enters the @widget's window.
1490    *
1491    * To receive this signal, the #GdkWindow associated to the widget needs
1492    * to enable the #GDK_FOCUS_CHANGE_MASK mask.
1493    *
1494    * Returns: %TRUE to stop other handlers from being invoked for the event.
1495    *   %FALSE to propagate the event further.
1496    */
1497   widget_signals[FOCUS_IN_EVENT] =
1498     g_signal_new (I_("focus-in-event"),
1499                   G_TYPE_FROM_CLASS (gobject_class),
1500                   G_SIGNAL_RUN_LAST,
1501                   G_STRUCT_OFFSET (GtkWidgetClass, focus_in_event),
1502                   _gtk_boolean_handled_accumulator, NULL,
1503                   _gtk_marshal_BOOLEAN__BOXED,
1504                   G_TYPE_BOOLEAN, 1,
1505                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1506
1507   /**
1508    * GtkWidget::focus-out-event
1509    * @widget: the object which received the signal
1510    * @event: the #GdkEventFocus which triggered this signal
1511    *
1512    * The ::focus-out-event signal will be emitted when the keyboard focus
1513    * leaves the @widget's window.
1514    *
1515    * To receive this signal, the #GdkWindow associated to the widget needs
1516    * to enable the #GDK_FOCUS_CHANGE_MASK mask.
1517    *
1518    * Returns: %TRUE to stop other handlers from being invoked for the event.
1519    *   %FALSE to propagate the event further.
1520    */
1521   widget_signals[FOCUS_OUT_EVENT] =
1522     g_signal_new (I_("focus-out-event"),
1523                   G_TYPE_FROM_CLASS (gobject_class),
1524                   G_SIGNAL_RUN_LAST,
1525                   G_STRUCT_OFFSET (GtkWidgetClass, focus_out_event),
1526                   _gtk_boolean_handled_accumulator, NULL,
1527                   _gtk_marshal_BOOLEAN__BOXED,
1528                   G_TYPE_BOOLEAN, 1,
1529                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1530
1531   /**
1532    * GtkWidget::map-event
1533    * @widget: the object which received the signal
1534    * @event: the #GdkEventAny which triggered this signal
1535    *
1536    * The ::map-event signal will be emitted when the @widget's window is
1537    * mapped. A window is mapped when it becomes visible on the screen.
1538    *
1539    * To receive this signal, the #GdkWindow associated to the widget needs
1540    * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
1541    * automatically for all new windows.
1542    *
1543    * Returns: %TRUE to stop other handlers from being invoked for the event.
1544    *   %FALSE to propagate the event further.
1545    */
1546   widget_signals[MAP_EVENT] =
1547     g_signal_new (I_("map-event"),
1548                   G_TYPE_FROM_CLASS (gobject_class),
1549                   G_SIGNAL_RUN_LAST,
1550                   G_STRUCT_OFFSET (GtkWidgetClass, map_event),
1551                   _gtk_boolean_handled_accumulator, NULL,
1552                   _gtk_marshal_BOOLEAN__BOXED,
1553                   G_TYPE_BOOLEAN, 1,
1554                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1555
1556   /**
1557    * GtkWidget::unmap-event
1558    * @widget: the object which received the signal
1559    * @event: the #GdkEventAny which triggered this signal
1560    *
1561    * The ::unmap-event signal will be emitted when the @widget's window is
1562    * unmapped. A window is unmapped when it becomes invisible on the screen.
1563    *
1564    * To receive this signal, the #GdkWindow associated to the widget needs
1565    * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
1566    * automatically for all new windows.
1567    *
1568    * Returns: %TRUE to stop other handlers from being invoked for the event.
1569    *   %FALSE to propagate the event further.
1570    */
1571   widget_signals[UNMAP_EVENT] =
1572     g_signal_new (I_("unmap-event"),
1573                   G_TYPE_FROM_CLASS (gobject_class),
1574                   G_SIGNAL_RUN_LAST,
1575                   G_STRUCT_OFFSET (GtkWidgetClass, unmap_event),
1576                   _gtk_boolean_handled_accumulator, NULL,
1577                   _gtk_marshal_BOOLEAN__BOXED,
1578                   G_TYPE_BOOLEAN, 1,
1579                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1580
1581   /**
1582    * GtkWidget::property-notify-event
1583    * @widget: the object which received the signal
1584    * @event: the #GdkEventProperty which triggered this signal
1585    *
1586    * The ::property-notify-event signal will be emitted when a property on
1587    * the @widget's window has been changed or deleted.
1588    *
1589    * To receive this signal, the #GdkWindow associated to the widget needs
1590    * to enable the #GDK_PROPERTY_CHANGE_MASK mask.
1591    *
1592    * Returns: %TRUE to stop other handlers from being invoked for the event.
1593    *   %FALSE to propagate the event further.
1594    */
1595   widget_signals[PROPERTY_NOTIFY_EVENT] =
1596     g_signal_new (I_("property-notify-event"),
1597                   G_TYPE_FROM_CLASS (gobject_class),
1598                   G_SIGNAL_RUN_LAST,
1599                   G_STRUCT_OFFSET (GtkWidgetClass, property_notify_event),
1600                   _gtk_boolean_handled_accumulator, NULL,
1601                   _gtk_marshal_BOOLEAN__BOXED,
1602                   G_TYPE_BOOLEAN, 1,
1603                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1604
1605   /**
1606    * GtkWidget::selection-clear-event
1607    * @widget: the object which received the signal
1608    * @event: the #GdkEventSelection which triggered this signal
1609    *
1610    * The ::selection-clear-event signal will be emitted when the
1611    * the @widget's window has lost ownership of a selection.
1612    *
1613    * Returns: %TRUE to stop other handlers from being invoked for the event.
1614    *   %FALSE to propagate the event further.
1615    */
1616   widget_signals[SELECTION_CLEAR_EVENT] =
1617     g_signal_new (I_("selection-clear-event"),
1618                   G_TYPE_FROM_CLASS (gobject_class),
1619                   G_SIGNAL_RUN_LAST,
1620                   G_STRUCT_OFFSET (GtkWidgetClass, selection_clear_event),
1621                   _gtk_boolean_handled_accumulator, NULL,
1622                   _gtk_marshal_BOOLEAN__BOXED,
1623                   G_TYPE_BOOLEAN, 1,
1624                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1625
1626   /**
1627    * GtkWidget::selection-request-event
1628    * @widget: the object which received the signal
1629    * @event: the #GdkEventSelection which triggered this signal
1630    *
1631    * The ::selection-request-event signal will be emitted when
1632    * another client requests ownership of the selection owned by
1633    * the @widget's window.
1634    *
1635    * Returns: %TRUE to stop other handlers from being invoked for the event.
1636    *   %FALSE to propagate the event further.
1637    */
1638   widget_signals[SELECTION_REQUEST_EVENT] =
1639     g_signal_new (I_("selection-request-event"),
1640                   G_TYPE_FROM_CLASS (gobject_class),
1641                   G_SIGNAL_RUN_LAST,
1642                   G_STRUCT_OFFSET (GtkWidgetClass, selection_request_event),
1643                   _gtk_boolean_handled_accumulator, NULL,
1644                   _gtk_marshal_BOOLEAN__BOXED,
1645                   G_TYPE_BOOLEAN, 1,
1646                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1647
1648   /**
1649    * GtkWidget::selection-notify-event:
1650    * @widget: the object which received the signal.
1651    * @event:
1652    *
1653    * Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
1654    */
1655   widget_signals[SELECTION_NOTIFY_EVENT] =
1656     g_signal_new (I_("selection-notify-event"),
1657                   G_TYPE_FROM_CLASS (gobject_class),
1658                   G_SIGNAL_RUN_LAST,
1659                   G_STRUCT_OFFSET (GtkWidgetClass, selection_notify_event),
1660                   _gtk_boolean_handled_accumulator, NULL,
1661                   _gtk_marshal_BOOLEAN__BOXED,
1662                   G_TYPE_BOOLEAN, 1,
1663                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1664
1665   /**
1666    * GtkWidget::selection-received:
1667    * @widget: the object which received the signal.
1668    * @data:
1669    * @time:
1670    */
1671   widget_signals[SELECTION_RECEIVED] =
1672     g_signal_new (I_("selection-received"),
1673                   G_TYPE_FROM_CLASS (gobject_class),
1674                   G_SIGNAL_RUN_LAST,
1675                   G_STRUCT_OFFSET (GtkWidgetClass, selection_received),
1676                   NULL, NULL,
1677                   _gtk_marshal_VOID__BOXED_UINT,
1678                   G_TYPE_NONE, 2,
1679                   GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
1680                   G_TYPE_UINT);
1681
1682   /**
1683    * GtkWidget::selection-get:
1684    * @widget: the object which received the signal.
1685    * @data:
1686    * @info:
1687    * @time:
1688    */
1689   widget_signals[SELECTION_GET] =
1690     g_signal_new (I_("selection-get"),
1691                   G_TYPE_FROM_CLASS (gobject_class),
1692                   G_SIGNAL_RUN_LAST,
1693                   G_STRUCT_OFFSET (GtkWidgetClass, selection_get),
1694                   NULL, NULL,
1695                   _gtk_marshal_VOID__BOXED_UINT_UINT,
1696                   G_TYPE_NONE, 3,
1697                   GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
1698                   G_TYPE_UINT,
1699                   G_TYPE_UINT);
1700
1701   /**
1702    * GtkWidget::proximity-in-event
1703    * @widget: the object which received the signal
1704    * @event: the #GdkEventProximity which triggered this signal
1705    *
1706    * To receive this signal the #GdkWindow associated to the widget needs
1707    * to enable the #GDK_PROXIMITY_IN_MASK mask.
1708    *
1709    * This signal will be sent to the grab widget if there is one.
1710    *
1711    * Returns: %TRUE to stop other handlers from being invoked for the event.
1712    *   %FALSE to propagate the event further.
1713    */
1714   widget_signals[PROXIMITY_IN_EVENT] =
1715     g_signal_new (I_("proximity-in-event"),
1716                   G_TYPE_FROM_CLASS (gobject_class),
1717                   G_SIGNAL_RUN_LAST,
1718                   G_STRUCT_OFFSET (GtkWidgetClass, proximity_in_event),
1719                   _gtk_boolean_handled_accumulator, NULL,
1720                   _gtk_marshal_BOOLEAN__BOXED,
1721                   G_TYPE_BOOLEAN, 1,
1722                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1723
1724   /**
1725    * GtkWidget::proximity-out-event
1726    * @widget: the object which received the signal
1727    * @event: the #GdkEventProximity which triggered this signal
1728    *
1729    * To receive this signal the #GdkWindow associated to the widget needs
1730    * to enable the #GDK_PROXIMITY_OUT_MASK mask.
1731    *
1732    * This signal will be sent to the grab widget if there is one.
1733    *
1734    * Returns: %TRUE to stop other handlers from being invoked for the event.
1735    *   %FALSE to propagate the event further.
1736    */
1737   widget_signals[PROXIMITY_OUT_EVENT] =
1738     g_signal_new (I_("proximity-out-event"),
1739                   G_TYPE_FROM_CLASS (gobject_class),
1740                   G_SIGNAL_RUN_LAST,
1741                   G_STRUCT_OFFSET (GtkWidgetClass, proximity_out_event),
1742                   _gtk_boolean_handled_accumulator, NULL,
1743                   _gtk_marshal_BOOLEAN__BOXED,
1744                   G_TYPE_BOOLEAN, 1,
1745                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1746
1747   /**
1748    * GtkWidget::drag-leave:
1749    * @widget: the object which received the signal.
1750    * @drag_context: the drag context
1751    * @time: the timestamp of the motion event
1752    *
1753    * The ::drag-leave signal is emitted on the drop site when the cursor
1754    * leaves the widget. A typical reason to connect to this signal is to
1755    * undo things done in #GtkWidget::drag-motion, e.g. undo highlighting
1756    * with gtk_drag_unhighlight()
1757    */
1758   widget_signals[DRAG_LEAVE] =
1759     g_signal_new (I_("drag-leave"),
1760                   G_TYPE_FROM_CLASS (gobject_class),
1761                   G_SIGNAL_RUN_LAST,
1762                   G_STRUCT_OFFSET (GtkWidgetClass, drag_leave),
1763                   NULL, NULL,
1764                   _gtk_marshal_VOID__OBJECT_UINT,
1765                   G_TYPE_NONE, 2,
1766                   GDK_TYPE_DRAG_CONTEXT,
1767                   G_TYPE_UINT);
1768
1769   /**
1770    * GtkWidget::drag-begin:
1771    * @widget: the object which received the signal
1772    * @drag_context: the drag context
1773    *
1774    * The ::drag-begin signal is emitted on the drag source when a drag is
1775    * started. A typical reason to connect to this signal is to set up a
1776    * custom drag icon with gtk_drag_source_set_icon().
1777    *
1778    * Note that some widgets set up a drag icon in the default handler of
1779    * this signal, so you may have to use g_signal_connect_after() to
1780    * override what the default handler did.
1781    */
1782   widget_signals[DRAG_BEGIN] =
1783     g_signal_new (I_("drag-begin"),
1784                   G_TYPE_FROM_CLASS (gobject_class),
1785                   G_SIGNAL_RUN_LAST,
1786                   G_STRUCT_OFFSET (GtkWidgetClass, drag_begin),
1787                   NULL, NULL,
1788                   _gtk_marshal_VOID__OBJECT,
1789                   G_TYPE_NONE, 1,
1790                   GDK_TYPE_DRAG_CONTEXT);
1791
1792   /**
1793    * GtkWidget::drag-end:
1794    * @widget: the object which received the signal
1795    * @drag_context: the drag context
1796    *
1797    * The ::drag-end signal is emitted on the drag source when a drag is
1798    * finished.  A typical reason to connect to this signal is to undo
1799    * things done in #GtkWidget::drag-begin.
1800    */
1801   widget_signals[DRAG_END] =
1802     g_signal_new (I_("drag-end"),
1803                   G_TYPE_FROM_CLASS (gobject_class),
1804                   G_SIGNAL_RUN_LAST,
1805                   G_STRUCT_OFFSET (GtkWidgetClass, drag_end),
1806                   NULL, NULL,
1807                   _gtk_marshal_VOID__OBJECT,
1808                   G_TYPE_NONE, 1,
1809                   GDK_TYPE_DRAG_CONTEXT);
1810
1811   /**
1812    * GtkWidget::drag-data-delete:
1813    * @widget: the object which received the signal
1814    * @drag_context: the drag context
1815    *
1816    * The ::drag-data-delete signal is emitted on the drag source when a drag
1817    * with the action %GDK_ACTION_MOVE is successfully completed. The signal
1818    * handler is responsible for deleting the data that has been dropped. What
1819    * "delete" means depends on the context of the drag operation.
1820    */
1821   widget_signals[DRAG_DATA_DELETE] =
1822     g_signal_new (I_("drag-data-delete"),
1823                   G_TYPE_FROM_CLASS (gobject_class),
1824                   G_SIGNAL_RUN_LAST,
1825                   G_STRUCT_OFFSET (GtkWidgetClass, drag_data_delete),
1826                   NULL, NULL,
1827                   _gtk_marshal_VOID__OBJECT,
1828                   G_TYPE_NONE, 1,
1829                   GDK_TYPE_DRAG_CONTEXT);
1830
1831   /**
1832    * GtkWidget::drag-failed:
1833    * @widget: the object which received the signal
1834    * @drag_context: the drag context
1835    * @result: the result of the drag operation
1836    *
1837    * The ::drag-failed signal is emitted on the drag source when a drag has
1838    * failed. The signal handler may hook custom code to handle a failed DND
1839    * operation based on the type of error, it returns %TRUE is the failure has
1840    * been already handled (not showing the default "drag operation failed"
1841    * animation), otherwise it returns %FALSE.
1842    *
1843    * Return value: %TRUE if the failed drag operation has been already handled.
1844    *
1845    * Since: 2.12
1846    */
1847   widget_signals[DRAG_FAILED] =
1848     g_signal_new (I_("drag-failed"),
1849                   G_TYPE_FROM_CLASS (gobject_class),
1850                   G_SIGNAL_RUN_LAST,
1851                   0, _gtk_boolean_handled_accumulator, NULL,
1852                   _gtk_marshal_BOOLEAN__OBJECT_ENUM,
1853                   G_TYPE_BOOLEAN, 2,
1854                   GDK_TYPE_DRAG_CONTEXT,
1855                   GTK_TYPE_DRAG_RESULT);
1856
1857   /**
1858    * GtkWidget::drag-motion:
1859    * @widget: the object which received the signal
1860    * @drag_context: the drag context
1861    * @x: the x coordinate of the current cursor position
1862    * @y: the y coordinate of the current cursor position
1863    * @time: the timestamp of the motion event
1864    * @returns: whether the cursor position is in a drop zone
1865    *
1866    * The drag-motion signal is emitted on the drop site when the user
1867    * moves the cursor over the widget during a drag. The signal handler
1868    * must determine whether the cursor position is in a drop zone or not.
1869    * If it is not in a drop zone, it returns %FALSE and no further processing
1870    * is necessary. Otherwise, the handler returns %TRUE. In this case, the
1871    * handler is responsible for providing the necessary information for
1872    * displaying feedback to the user, by calling gdk_drag_status().
1873    *
1874    * If the decision whether the drop will be accepted or rejected can't be
1875    * made based solely on the cursor position and the type of the data, the
1876    * handler may inspect the dragged data by calling gtk_drag_get_data() and
1877    * defer the gdk_drag_status() call to the #GtkWidget::drag-data-received
1878    * handler. Note that you cannot not pass #GTK_DEST_DEFAULT_DROP,
1879    * #GTK_DEST_DEFAULT_MOTION or #GTK_DEST_DEFAULT_ALL to gtk_drag_dest_set()
1880    * when using the drag-motion signal that way.
1881    *
1882    * Also note that there is no drag-enter signal. The drag receiver has to
1883    * keep track of whether he has received any drag-motion signals since the
1884    * last #GtkWidget::drag-leave and if not, treat the drag-motion signal as
1885    * an "enter" signal. Upon an "enter", the handler will typically highlight
1886    * the drop site with gtk_drag_highlight().
1887    * |[
1888    * static void
1889    * drag_motion (GtkWidget *widget,
1890    *              GdkDragContext *context,
1891    *              gint x,
1892    *              gint y,
1893    *              guint time)
1894    * {
1895    *   GdkAtom target;
1896    *
1897    *   PrivateData *private_data = GET_PRIVATE_DATA (widget);
1898    *
1899    *   if (!private_data->drag_highlight)
1900    *    {
1901    *      private_data->drag_highlight = 1;
1902    *      gtk_drag_highlight (widget);
1903    *    }
1904    *
1905    *   target = gtk_drag_dest_find_target (widget, context, NULL);
1906    *   if (target == GDK_NONE)
1907    *     gdk_drag_status (context, 0, time);
1908    *   else
1909    *    {
1910    *      private_data->pending_status = context->suggested_action;
1911    *      gtk_drag_get_data (widget, context, target, time);
1912    *    }
1913    *
1914    *   return TRUE;
1915    * }
1916    *
1917    * static void
1918    * drag_data_received (GtkWidget        *widget,
1919    *                     GdkDragContext   *context,
1920    *                     gint              x,
1921    *                     gint              y,
1922    *                     GtkSelectionData *selection_data,
1923    *                     guint             info,
1924    *                     guint             time)
1925    * {
1926    *   PrivateData *private_data = GET_PRIVATE_DATA (widget);
1927    *
1928    *   if (private_data->suggested_action)
1929    *    {
1930    *      private_data->suggested_action = 0;
1931    *
1932    *     /&ast; We are getting this data due to a request in drag_motion,
1933    *      * rather than due to a request in drag_drop, so we are just
1934    *      * supposed to call gdk_drag_status (), not actually paste in
1935    *      * the data.
1936    *      &ast;/
1937    *      str = gtk_selection_data_get_text (selection_data);
1938    *      if (!data_is_acceptable (str))
1939    *        gdk_drag_status (context, 0, time);
1940    *      else
1941    *        gdk_drag_status (context, private_data->suggested_action, time);
1942    *    }
1943    *   else
1944    *    {
1945    *      /&ast; accept the drop &ast;/
1946    *    }
1947    * }
1948    * ]|
1949    */
1950   widget_signals[DRAG_MOTION] =
1951     g_signal_new (I_("drag-motion"),
1952                   G_TYPE_FROM_CLASS (gobject_class),
1953                   G_SIGNAL_RUN_LAST,
1954                   G_STRUCT_OFFSET (GtkWidgetClass, drag_motion),
1955                   _gtk_boolean_handled_accumulator, NULL,
1956                   _gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
1957                   G_TYPE_BOOLEAN, 4,
1958                   GDK_TYPE_DRAG_CONTEXT,
1959                   G_TYPE_INT,
1960                   G_TYPE_INT,
1961                   G_TYPE_UINT);
1962
1963   /**
1964    * GtkWidget::drag-drop:
1965    * @widget: the object which received the signal
1966    * @drag_context: the drag context
1967    * @x: the x coordinate of the current cursor position
1968    * @y: the y coordinate of the current cursor position
1969    * @time: the timestamp of the motion event
1970    * @returns: whether the cursor position is in a drop zone
1971    *
1972    * The ::drag-drop signal is emitted on the drop site when the user drops
1973    * the data onto the widget. The signal handler must determine whether
1974    * the cursor position is in a drop zone or not. If it is not in a drop
1975    * zone, it returns %FALSE and no further processing is necessary.
1976    * Otherwise, the handler returns %TRUE. In this case, the handler must
1977    * ensure that gtk_drag_finish() is called to let the source know that
1978    * the drop is done. The call to gtk_drag_finish() can be done either
1979    * directly or in a #GtkWidget::drag-data-received handler which gets
1980    * triggered by calling gtk_drag_get_data() to receive the data for one
1981    * or more of the supported targets.
1982    */
1983   widget_signals[DRAG_DROP] =
1984     g_signal_new (I_("drag-drop"),
1985                   G_TYPE_FROM_CLASS (gobject_class),
1986                   G_SIGNAL_RUN_LAST,
1987                   G_STRUCT_OFFSET (GtkWidgetClass, drag_drop),
1988                   _gtk_boolean_handled_accumulator, NULL,
1989                   _gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
1990                   G_TYPE_BOOLEAN, 4,
1991                   GDK_TYPE_DRAG_CONTEXT,
1992                   G_TYPE_INT,
1993                   G_TYPE_INT,
1994                   G_TYPE_UINT);
1995
1996   /**
1997    * GtkWidget::drag-data-get:
1998    * @widget: the object which received the signal
1999    * @drag_context: the drag context
2000    * @data: the #GtkSelectionData to be filled with the dragged data
2001    * @info: the info that has been registered with the target in the
2002    *        #GtkTargetList
2003    * @time: the timestamp at which the data was requested
2004    *
2005    * The ::drag-data-get signal is emitted on the drag source when the drop
2006    * site requests the data which is dragged. It is the responsibility of
2007    * the signal handler to fill @data with the data in the format which
2008    * is indicated by @info. See gtk_selection_data_set() and
2009    * gtk_selection_data_set_text().
2010    */
2011   widget_signals[DRAG_DATA_GET] =
2012     g_signal_new (I_("drag-data-get"),
2013                   G_TYPE_FROM_CLASS (gobject_class),
2014                   G_SIGNAL_RUN_LAST,
2015                   G_STRUCT_OFFSET (GtkWidgetClass, drag_data_get),
2016                   NULL, NULL,
2017                   _gtk_marshal_VOID__OBJECT_BOXED_UINT_UINT,
2018                   G_TYPE_NONE, 4,
2019                   GDK_TYPE_DRAG_CONTEXT,
2020                   GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
2021                   G_TYPE_UINT,
2022                   G_TYPE_UINT);
2023
2024   /**
2025    * GtkWidget::drag-data-received:
2026    * @widget: the object which received the signal
2027    * @drag_context: the drag context
2028    * @x: where the drop happened
2029    * @y: where the drop happened
2030    * @data: the received data
2031    * @info: the info that has been registered with the target in the
2032    *        #GtkTargetList
2033    * @time: the timestamp at which the data was received
2034    *
2035    * The ::drag-data-received signal is emitted on the drop site when the
2036    * dragged data has been received. If the data was received in order to
2037    * determine whether the drop will be accepted, the handler is expected
2038    * to call gdk_drag_status() and <emphasis>not</emphasis> finish the drag.
2039    * If the data was received in response to a #GtkWidget::drag-drop signal
2040    * (and this is the last target to be received), the handler for this
2041    * signal is expected to process the received data and then call
2042    * gtk_drag_finish(), setting the @success parameter depending on whether
2043    * the data was processed successfully.
2044    *
2045    * The handler may inspect and modify @drag_context->action before calling
2046    * gtk_drag_finish(), e.g. to implement %GDK_ACTION_ASK as shown in the
2047    * following example:
2048    * |[
2049    * void
2050    * drag_data_received (GtkWidget          *widget,
2051    *                     GdkDragContext     *drag_context,
2052    *                     gint                x,
2053    *                     gint                y,
2054    *                     GtkSelectionData   *data,
2055    *                     guint               info,
2056    *                     guint               time)
2057    * {
2058    *   if ((data->length >= 0) && (data->format == 8))
2059    *     {
2060    *       if (drag_context->action == GDK_ACTION_ASK)
2061    *         {
2062    *           GtkWidget *dialog;
2063    *           gint response;
2064    *
2065    *           dialog = gtk_message_dialog_new (NULL,
2066    *                                            GTK_DIALOG_MODAL |
2067    *                                            GTK_DIALOG_DESTROY_WITH_PARENT,
2068    *                                            GTK_MESSAGE_INFO,
2069    *                                            GTK_BUTTONS_YES_NO,
2070    *                                            "Move the data ?\n");
2071    *           response = gtk_dialog_run (GTK_DIALOG (dialog));
2072    *           gtk_widget_destroy (dialog);
2073    *
2074    *           if (response == GTK_RESPONSE_YES)
2075    *             drag_context->action = GDK_ACTION_MOVE;
2076    *           else
2077    *             drag_context->action = GDK_ACTION_COPY;
2078    *          }
2079    *
2080    *       gtk_drag_finish (drag_context, TRUE, FALSE, time);
2081    *       return;
2082    *     }
2083    *
2084    *    gtk_drag_finish (drag_context, FALSE, FALSE, time);
2085    *  }
2086    * ]|
2087    */
2088   widget_signals[DRAG_DATA_RECEIVED] =
2089     g_signal_new (I_("drag-data-received"),
2090                   G_TYPE_FROM_CLASS (gobject_class),
2091                   G_SIGNAL_RUN_LAST,
2092                   G_STRUCT_OFFSET (GtkWidgetClass, drag_data_received),
2093                   NULL, NULL,
2094                   _gtk_marshal_VOID__OBJECT_INT_INT_BOXED_UINT_UINT,
2095                   G_TYPE_NONE, 6,
2096                   GDK_TYPE_DRAG_CONTEXT,
2097                   G_TYPE_INT,
2098                   G_TYPE_INT,
2099                   GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
2100                   G_TYPE_UINT,
2101                   G_TYPE_UINT);
2102
2103   /**
2104    * GtkWidget::visibility-notify-event:
2105    * @widget: the object which received the signal
2106    * @event: the #GdkEventVisibility which triggered this signal
2107    *
2108    * The ::visibility-notify-event will be emitted when the @widget's window
2109    * is obscured or unobscured.
2110    *
2111    * To receive this signal the #GdkWindow associated to the widget needs
2112    * to enable the #GDK_VISIBILITY_NOTIFY_MASK mask.
2113    *
2114    * Returns: %TRUE to stop other handlers from being invoked for the event.
2115    *   %FALSE to propagate the event further.
2116    */
2117   widget_signals[VISIBILITY_NOTIFY_EVENT] =
2118     g_signal_new (I_("visibility-notify-event"),
2119                   G_TYPE_FROM_CLASS (gobject_class),
2120                   G_SIGNAL_RUN_LAST,
2121                   G_STRUCT_OFFSET (GtkWidgetClass, visibility_notify_event),
2122                   _gtk_boolean_handled_accumulator, NULL,
2123                   _gtk_marshal_BOOLEAN__BOXED,
2124                   G_TYPE_BOOLEAN, 1,
2125                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2126
2127   /**
2128    * GtkWidget::client-event:
2129    * @widget: the object which received the signal
2130    * @event: the #GdkEventClient which triggered this signal
2131    *
2132    * The ::client-event will be emitted when the @widget's window
2133    * receives a message (via a ClientMessage event) from another
2134    * application.
2135    *
2136    * Returns: %TRUE to stop other handlers from being invoked for
2137    *   the event. %FALSE to propagate the event further.
2138    */
2139   widget_signals[CLIENT_EVENT] =
2140     g_signal_new (I_("client-event"),
2141                   G_TYPE_FROM_CLASS (gobject_class),
2142                   G_SIGNAL_RUN_LAST,
2143                   G_STRUCT_OFFSET (GtkWidgetClass, client_event),
2144                   _gtk_boolean_handled_accumulator, NULL,
2145                   _gtk_marshal_BOOLEAN__BOXED,
2146                   G_TYPE_BOOLEAN, 1,
2147                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2148
2149   /**
2150    * GtkWidget::no-expose-event:
2151    * @widget: the object which received the signal
2152    * @event: the #GdkEventNoExpose which triggered this signal
2153    *
2154    * The ::no-expose-event will be emitted when the @widget's window is
2155    * drawn as a copy of another #GdkDrawable (with gdk_draw_drawable() or
2156    * gdk_window_copy_area()) which was completely unobscured. If the source
2157    * window was partially obscured #GdkEventExpose events will be generated
2158    * for those areas.
2159    *
2160    * Returns: %TRUE to stop other handlers from being invoked for the event.
2161    *   %FALSE to propagate the event further.
2162    */
2163   widget_signals[NO_EXPOSE_EVENT] =
2164     g_signal_new (I_("no-expose-event"),
2165                   G_TYPE_FROM_CLASS (gobject_class),
2166                   G_SIGNAL_RUN_LAST,
2167                   G_STRUCT_OFFSET (GtkWidgetClass, no_expose_event),
2168                   _gtk_boolean_handled_accumulator, NULL,
2169                   _gtk_marshal_BOOLEAN__BOXED,
2170                   G_TYPE_BOOLEAN, 1,
2171                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2172
2173   /**
2174    * GtkWidget::window-state-event:
2175    * @widget: the object which received the signal
2176    * @event: the #GdkEventWindowState which triggered this signal
2177    *
2178    * The ::window-state-event will be emitted when the state of the
2179    * toplevel window associated to the @widget changes.
2180    *
2181    * To receive this signal the #GdkWindow associated to the widget
2182    * needs to enable the #GDK_STRUCTURE_MASK mask. GDK will enable
2183    * this mask automatically for all new windows.
2184    *
2185    * Returns: %TRUE to stop other handlers from being invoked for the
2186    *   event. %FALSE to propagate the event further.
2187    */
2188   widget_signals[WINDOW_STATE_EVENT] =
2189     g_signal_new (I_("window-state-event"),
2190                   G_TYPE_FROM_CLASS (gobject_class),
2191                   G_SIGNAL_RUN_LAST,
2192                   G_STRUCT_OFFSET (GtkWidgetClass, window_state_event),
2193                   _gtk_boolean_handled_accumulator, NULL,
2194                   _gtk_marshal_BOOLEAN__BOXED,
2195                   G_TYPE_BOOLEAN, 1,
2196                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2197
2198   /**
2199    * GtkWidget::damage-event:
2200    * @widget: the object which received the signal
2201    * @event: the #GdkEventExpose event
2202    *
2203    * Emitted when a redirected window belonging to @widget gets drawn into.
2204    * The region/area members of the event shows what area of the redirected
2205    * drawable was drawn into.
2206    *
2207    * Returns: %TRUE to stop other handlers from being invoked for the event.
2208    *   %FALSE to propagate the event further.
2209    *
2210    * Since: 2.14
2211    */
2212   widget_signals[DAMAGE_EVENT] =
2213     g_signal_new (I_("damage-event"),
2214                   G_TYPE_FROM_CLASS (gobject_class),
2215                   G_SIGNAL_RUN_LAST,
2216                   0,
2217                   _gtk_boolean_handled_accumulator, NULL,
2218                   _gtk_marshal_BOOLEAN__BOXED,
2219                   G_TYPE_BOOLEAN, 1,
2220                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2221 /**
2222    * GtkWidget::grab-broken-event:
2223    * @widget: the object which received the signal
2224    * @event: the #GdkEventGrabBroken event
2225    *
2226    * Emitted when a pointer or keyboard grab on a window belonging
2227    * to @widget gets broken.
2228    *
2229    * On X11, this happens when the grab window becomes unviewable
2230    * (i.e. it or one of its ancestors is unmapped), or if the same
2231    * application grabs the pointer or keyboard again.
2232    *
2233    * Returns: %TRUE to stop other handlers from being invoked for
2234    *   the event. %FALSE to propagate the event further.
2235    *
2236    * Since: 2.8
2237    */
2238   widget_signals[GRAB_BROKEN] =
2239     g_signal_new (I_("grab-broken-event"),
2240                   G_TYPE_FROM_CLASS (gobject_class),
2241                   G_SIGNAL_RUN_LAST,
2242                   G_STRUCT_OFFSET (GtkWidgetClass, grab_broken_event),
2243                   _gtk_boolean_handled_accumulator, NULL,
2244                   _gtk_marshal_BOOLEAN__BOXED,
2245                   G_TYPE_BOOLEAN, 1,
2246                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2247   /**
2248    * GtkWidget::query-tooltip:
2249    * @widget: the object which received the signal
2250    * @x: the x coordinate of the cursor position where the request has
2251    *     been emitted, relative to @widget->window
2252    * @y: the y coordinate of the cursor position where the request has
2253    *     been emitted, relative to @widget->window
2254    * @keyboard_mode: %TRUE if the tooltip was trigged using the keyboard
2255    * @tooltip: a #GtkTooltip
2256    *
2257    * Emitted when #GtkWidget:has-tooltip is %TRUE and the #GtkSettings:gtk-tooltip-timeout
2258    * has expired with the cursor hovering "above" @widget; or emitted when @widget got
2259    * focus in keyboard mode.
2260    *
2261    * Using the given coordinates, the signal handler should determine
2262    * whether a tooltip should be shown for @widget. If this is the case
2263    * %TRUE should be returned, %FALSE otherwise.  Note that if
2264    * @keyboard_mode is %TRUE, the values of @x and @y are undefined and
2265    * should not be used.
2266    *
2267    * The signal handler is free to manipulate @tooltip with the therefore
2268    * destined function calls.
2269    *
2270    * Returns: %TRUE if @tooltip should be shown right now, %FALSE otherwise.
2271    *
2272    * Since: 2.12
2273    */
2274   widget_signals[QUERY_TOOLTIP] =
2275     g_signal_new (I_("query-tooltip"),
2276                   G_TYPE_FROM_CLASS (gobject_class),
2277                   G_SIGNAL_RUN_LAST,
2278                   G_STRUCT_OFFSET (GtkWidgetClass, query_tooltip),
2279                   _gtk_boolean_handled_accumulator, NULL,
2280                   _gtk_marshal_BOOLEAN__INT_INT_BOOLEAN_OBJECT,
2281                   G_TYPE_BOOLEAN, 4,
2282                   G_TYPE_INT,
2283                   G_TYPE_INT,
2284                   G_TYPE_BOOLEAN,
2285                   GTK_TYPE_TOOLTIP);
2286
2287   /**
2288    * GtkWidget::popup-menu
2289    * @widget: the object which received the signal
2290    *
2291    * This signal gets emitted whenever a widget should pop up a context
2292    * menu. This usually happens through the standard key binding mechanism;
2293    * by pressing a certain key while a widget is focused, the user can cause
2294    * the widget to pop up a menu.  For example, the #GtkEntry widget creates
2295    * a menu with clipboard commands. See <xref linkend="checklist-popup-menu"/>
2296    * for an example of how to use this signal.
2297    *
2298    * Returns: %TRUE if a menu was activated
2299    */
2300   widget_signals[POPUP_MENU] =
2301     g_signal_new (I_("popup-menu"),
2302                   G_TYPE_FROM_CLASS (gobject_class),
2303                   G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
2304                   G_STRUCT_OFFSET (GtkWidgetClass, popup_menu),
2305                   _gtk_boolean_handled_accumulator, NULL,
2306                   _gtk_marshal_BOOLEAN__VOID,
2307                   G_TYPE_BOOLEAN, 0);
2308
2309   /**
2310    * GtkWidget::show-help:
2311    * @widget: the object which received the signal.
2312    * @help_type:
2313    */
2314   widget_signals[SHOW_HELP] =
2315     g_signal_new (I_("show-help"),
2316                   G_TYPE_FROM_CLASS (gobject_class),
2317                   G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
2318                   G_STRUCT_OFFSET (GtkWidgetClass, show_help),
2319                   _gtk_boolean_handled_accumulator, NULL,
2320                   _gtk_marshal_BOOLEAN__ENUM,
2321                   G_TYPE_BOOLEAN, 1,
2322                   GTK_TYPE_WIDGET_HELP_TYPE);
2323
2324   /**
2325    * GtkWidget::accel-closures-changed:
2326    * @widget: the object which received the signal.
2327    */
2328   widget_signals[ACCEL_CLOSURES_CHANGED] =
2329     g_signal_new (I_("accel-closures-changed"),
2330                   G_TYPE_FROM_CLASS (gobject_class),
2331                   0,
2332                   0,
2333                   NULL, NULL,
2334                   _gtk_marshal_VOID__VOID,
2335                   G_TYPE_NONE, 0);
2336
2337   /**
2338    * GtkWidget::screen-changed:
2339    * @widget: the object on which the signal is emitted
2340    * @previous_screen: (allow-none): the previous screen, or %NULL if the
2341    *   widget was not associated with a screen before
2342    *
2343    * The ::screen-changed signal gets emitted when the
2344    * screen of a widget has changed.
2345    */
2346   widget_signals[SCREEN_CHANGED] =
2347     g_signal_new (I_("screen-changed"),
2348                   G_TYPE_FROM_CLASS (gobject_class),
2349                   G_SIGNAL_RUN_LAST,
2350                   G_STRUCT_OFFSET (GtkWidgetClass, screen_changed),
2351                   NULL, NULL,
2352                   _gtk_marshal_VOID__OBJECT,
2353                   G_TYPE_NONE, 1,
2354                   GDK_TYPE_SCREEN);
2355
2356   /**
2357    * GtkWidget::can-activate-accel:
2358    * @widget: the object which received the signal
2359    * @signal_id: the ID of a signal installed on @widget
2360    *
2361    * Determines whether an accelerator that activates the signal
2362    * identified by @signal_id can currently be activated.
2363    * This signal is present to allow applications and derived
2364    * widgets to override the default #GtkWidget handling
2365    * for determining whether an accelerator can be activated.
2366    *
2367    * Returns: %TRUE if the signal can be activated.
2368    */
2369   widget_signals[CAN_ACTIVATE_ACCEL] =
2370      g_signal_new (I_("can-activate-accel"),
2371                   G_TYPE_FROM_CLASS (gobject_class),
2372                   G_SIGNAL_RUN_LAST,
2373                   G_STRUCT_OFFSET (GtkWidgetClass, can_activate_accel),
2374                   _gtk_boolean_handled_accumulator, NULL,
2375                   _gtk_marshal_BOOLEAN__UINT,
2376                   G_TYPE_BOOLEAN, 1, G_TYPE_UINT);
2377
2378   binding_set = gtk_binding_set_by_class (klass);
2379   gtk_binding_entry_add_signal (binding_set, GDK_F10, GDK_SHIFT_MASK,
2380                                 "popup-menu", 0);
2381   gtk_binding_entry_add_signal (binding_set, GDK_Menu, 0,
2382                                 "popup-menu", 0);
2383
2384   gtk_binding_entry_add_signal (binding_set, GDK_F1, GDK_CONTROL_MASK,
2385                                 "show-help", 1,
2386                                 GTK_TYPE_WIDGET_HELP_TYPE,
2387                                 GTK_WIDGET_HELP_TOOLTIP);
2388   gtk_binding_entry_add_signal (binding_set, GDK_KP_F1, GDK_CONTROL_MASK,
2389                                 "show-help", 1,
2390                                 GTK_TYPE_WIDGET_HELP_TYPE,
2391                                 GTK_WIDGET_HELP_TOOLTIP);
2392   gtk_binding_entry_add_signal (binding_set, GDK_F1, GDK_SHIFT_MASK,
2393                                 "show-help", 1,
2394                                 GTK_TYPE_WIDGET_HELP_TYPE,
2395                                 GTK_WIDGET_HELP_WHATS_THIS);
2396   gtk_binding_entry_add_signal (binding_set, GDK_KP_F1, GDK_SHIFT_MASK,
2397                                 "show-help", 1,
2398                                 GTK_TYPE_WIDGET_HELP_TYPE,
2399                                 GTK_WIDGET_HELP_WHATS_THIS);
2400
2401   gtk_widget_class_install_style_property (klass,
2402                                            g_param_spec_boolean ("interior-focus",
2403                                                                  P_("Interior Focus"),
2404                                                                  P_("Whether to draw the focus indicator inside widgets"),
2405                                                                  TRUE,
2406                                                                  GTK_PARAM_READABLE));
2407
2408   gtk_widget_class_install_style_property (klass,
2409                                            g_param_spec_int ("focus-line-width",
2410                                                              P_("Focus linewidth"),
2411                                                              P_("Width, in pixels, of the focus indicator line"),
2412                                                              0, G_MAXINT, 1,
2413                                                              GTK_PARAM_READABLE));
2414
2415   gtk_widget_class_install_style_property (klass,
2416                                            g_param_spec_string ("focus-line-pattern",
2417                                                                 P_("Focus line dash pattern"),
2418                                                                 P_("Dash pattern used to draw the focus indicator"),
2419                                                                 "\1\1",
2420                                                                 GTK_PARAM_READABLE));
2421   gtk_widget_class_install_style_property (klass,
2422                                            g_param_spec_int ("focus-padding",
2423                                                              P_("Focus padding"),
2424                                                              P_("Width, in pixels, between focus indicator and the widget 'box'"),
2425                                                              0, G_MAXINT, 1,
2426                                                              GTK_PARAM_READABLE));
2427   gtk_widget_class_install_style_property (klass,
2428                                            g_param_spec_boxed ("cursor-color",
2429                                                                P_("Cursor color"),
2430                                                                P_("Color with which to draw insertion cursor"),
2431                                                                GDK_TYPE_COLOR,
2432                                                                GTK_PARAM_READABLE));
2433   gtk_widget_class_install_style_property (klass,
2434                                            g_param_spec_boxed ("secondary-cursor-color",
2435                                                                P_("Secondary cursor color"),
2436                                                                P_("Color with which to draw the secondary insertion cursor when editing mixed right-to-left and left-to-right text"),
2437                                                                GDK_TYPE_COLOR,
2438                                                                GTK_PARAM_READABLE));
2439   gtk_widget_class_install_style_property (klass,
2440                                            g_param_spec_float ("cursor-aspect-ratio",
2441                                                                P_("Cursor line aspect ratio"),
2442                                                                P_("Aspect ratio with which to draw insertion cursor"),
2443                                                                0.0, 1.0, 0.04,
2444                                                                GTK_PARAM_READABLE));
2445
2446   /**
2447    * GtkWidget:draw-border:
2448    *
2449    * The "draw-border" style property defines the size of areas outside
2450    * the widget's allocation to draw.
2451    *
2452    * Since: 2.8
2453    */
2454   gtk_widget_class_install_style_property (klass,
2455                                            g_param_spec_boxed ("draw-border",
2456                                                                P_("Draw Border"),
2457                                                                P_("Size of areas outside the widget's allocation to draw"),
2458                                                                GTK_TYPE_BORDER,
2459                                                                GTK_PARAM_READABLE));
2460
2461   /**
2462    * GtkWidget:link-color:
2463    *
2464    * The "link-color" style property defines the color of unvisited links.
2465    *
2466    * Since: 2.10
2467    */
2468   gtk_widget_class_install_style_property (klass,
2469                                            g_param_spec_boxed ("link-color",
2470                                                                P_("Unvisited Link Color"),
2471                                                                P_("Color of unvisited links"),
2472                                                                GDK_TYPE_COLOR,
2473                                                                GTK_PARAM_READABLE));
2474
2475   /**
2476    * GtkWidget:visited-link-color:
2477    *
2478    * The "visited-link-color" style property defines the color of visited links.
2479    *
2480    * Since: 2.10
2481    */
2482   gtk_widget_class_install_style_property (klass,
2483                                            g_param_spec_boxed ("visited-link-color",
2484                                                                P_("Visited Link Color"),
2485                                                                P_("Color of visited links"),
2486                                                                GDK_TYPE_COLOR,
2487                                                                GTK_PARAM_READABLE));
2488
2489   /**
2490    * GtkWidget:wide-separators:
2491    *
2492    * The "wide-separators" style property defines whether separators have
2493    * configurable width and should be drawn using a box instead of a line.
2494    *
2495    * Since: 2.10
2496    */
2497   gtk_widget_class_install_style_property (klass,
2498                                            g_param_spec_boolean ("wide-separators",
2499                                                                  P_("Wide Separators"),
2500                                                                  P_("Whether separators have configurable width and should be drawn using a box instead of a line"),
2501                                                                  FALSE,
2502                                                                  GTK_PARAM_READABLE));
2503
2504   /**
2505    * GtkWidget:separator-width:
2506    *
2507    * The "separator-width" style property defines the width of separators.
2508    * This property only takes effect if #GtkWidget:wide-separators is %TRUE.
2509    *
2510    * Since: 2.10
2511    */
2512   gtk_widget_class_install_style_property (klass,
2513                                            g_param_spec_int ("separator-width",
2514                                                              P_("Separator Width"),
2515                                                              P_("The width of separators if wide-separators is TRUE"),
2516                                                              0, G_MAXINT, 0,
2517                                                              GTK_PARAM_READABLE));
2518
2519   /**
2520    * GtkWidget:separator-height:
2521    *
2522    * The "separator-height" style property defines the height of separators.
2523    * This property only takes effect if #GtkWidget:wide-separators is %TRUE.
2524    *
2525    * Since: 2.10
2526    */
2527   gtk_widget_class_install_style_property (klass,
2528                                            g_param_spec_int ("separator-height",
2529                                                              P_("Separator Height"),
2530                                                              P_("The height of separators if \"wide-separators\" is TRUE"),
2531                                                              0, G_MAXINT, 0,
2532                                                              GTK_PARAM_READABLE));
2533
2534   /**
2535    * GtkWidget:scroll-arrow-hlength:
2536    *
2537    * The "scroll-arrow-hlength" style property defines the length of
2538    * horizontal scroll arrows.
2539    *
2540    * Since: 2.10
2541    */
2542   gtk_widget_class_install_style_property (klass,
2543                                            g_param_spec_int ("scroll-arrow-hlength",
2544                                                              P_("Horizontal Scroll Arrow Length"),
2545                                                              P_("The length of horizontal scroll arrows"),
2546                                                              1, G_MAXINT, 16,
2547                                                              GTK_PARAM_READABLE));
2548
2549   /**
2550    * GtkWidget:scroll-arrow-vlength:
2551    *
2552    * The "scroll-arrow-vlength" style property defines the length of
2553    * vertical scroll arrows.
2554    *
2555    * Since: 2.10
2556    */
2557   gtk_widget_class_install_style_property (klass,
2558                                            g_param_spec_int ("scroll-arrow-vlength",
2559                                                              P_("Vertical Scroll Arrow Length"),
2560                                                              P_("The length of vertical scroll arrows"),
2561                                                              1, G_MAXINT, 16,
2562                                                              GTK_PARAM_READABLE));
2563 }
2564
2565 static void
2566 gtk_widget_base_class_finalize (GtkWidgetClass *klass)
2567 {
2568   GList *list, *node;
2569
2570   list = g_param_spec_pool_list_owned (style_property_spec_pool, G_OBJECT_CLASS_TYPE (klass));
2571   for (node = list; node; node = node->next)
2572     {
2573       GParamSpec *pspec = node->data;
2574
2575       g_param_spec_pool_remove (style_property_spec_pool, pspec);
2576       g_param_spec_unref (pspec);
2577     }
2578   g_list_free (list);
2579 }
2580
2581 static void
2582 gtk_widget_set_property (GObject         *object,
2583                          guint            prop_id,
2584                          const GValue    *value,
2585                          GParamSpec      *pspec)
2586 {
2587   GtkWidget *widget = GTK_WIDGET (object);
2588
2589   switch (prop_id)
2590     {
2591       gboolean tmp;
2592       gchar *tooltip_markup;
2593       const gchar *tooltip_text;
2594       GtkWindow *tooltip_window;
2595
2596     case PROP_NAME:
2597       gtk_widget_set_name (widget, g_value_get_string (value));
2598       break;
2599     case PROP_PARENT:
2600       gtk_container_add (GTK_CONTAINER (g_value_get_object (value)), widget);
2601       break;
2602     case PROP_WIDTH_REQUEST:
2603       gtk_widget_set_usize_internal (widget, g_value_get_int (value), -2);
2604       break;
2605     case PROP_HEIGHT_REQUEST:
2606       gtk_widget_set_usize_internal (widget, -2, g_value_get_int (value));
2607       break;
2608     case PROP_VISIBLE:
2609       gtk_widget_set_visible (widget, g_value_get_boolean (value));
2610       break;
2611     case PROP_SENSITIVE:
2612       gtk_widget_set_sensitive (widget, g_value_get_boolean (value));
2613       break;
2614     case PROP_APP_PAINTABLE:
2615       gtk_widget_set_app_paintable (widget, g_value_get_boolean (value));
2616       break;
2617     case PROP_CAN_FOCUS:
2618       gtk_widget_set_can_focus (widget, g_value_get_boolean (value));
2619       break;
2620     case PROP_HAS_FOCUS:
2621       if (g_value_get_boolean (value))
2622         gtk_widget_grab_focus (widget);
2623       break;
2624     case PROP_IS_FOCUS:
2625       if (g_value_get_boolean (value))
2626         gtk_widget_grab_focus (widget);
2627       break;
2628     case PROP_CAN_DEFAULT:
2629       gtk_widget_set_can_default (widget, g_value_get_boolean (value));
2630       break;
2631     case PROP_HAS_DEFAULT:
2632       if (g_value_get_boolean (value))
2633         gtk_widget_grab_default (widget);
2634       break;
2635     case PROP_RECEIVES_DEFAULT:
2636       gtk_widget_set_receives_default (widget, g_value_get_boolean (value));
2637       break;
2638     case PROP_STYLE:
2639       gtk_widget_set_style (widget, g_value_get_object (value));
2640       break;
2641     case PROP_EVENTS:
2642       if (!gtk_widget_get_realized (widget) && gtk_widget_get_has_window (widget))
2643         gtk_widget_set_events (widget, g_value_get_flags (value));
2644       break;
2645     case PROP_EXTENSION_EVENTS:
2646       gtk_widget_set_extension_events (widget, g_value_get_enum (value));
2647       break;
2648     case PROP_NO_SHOW_ALL:
2649       gtk_widget_set_no_show_all (widget, g_value_get_boolean (value));
2650       break;
2651     case PROP_HAS_TOOLTIP:
2652       gtk_widget_real_set_has_tooltip (widget,
2653                                        g_value_get_boolean (value), FALSE);
2654       break;
2655     case PROP_TOOLTIP_MARKUP:
2656       tooltip_window = g_object_get_qdata (object, quark_tooltip_window);
2657       tooltip_markup = g_value_dup_string (value);
2658
2659       /* Treat an empty string as a NULL string,
2660        * because an empty string would be useless for a tooltip:
2661        */
2662       if (tooltip_markup && (strlen (tooltip_markup) == 0))
2663         {
2664           g_free (tooltip_markup);
2665           tooltip_markup = NULL;
2666         }
2667
2668       g_object_set_qdata_full (object, quark_tooltip_markup,
2669                                tooltip_markup, g_free);
2670
2671       tmp = (tooltip_window != NULL || tooltip_markup != NULL);
2672       gtk_widget_real_set_has_tooltip (widget, tmp, FALSE);
2673       if (gtk_widget_get_visible (widget))
2674         gtk_widget_queue_tooltip_query (widget);
2675       break;
2676     case PROP_TOOLTIP_TEXT:
2677       tooltip_window = g_object_get_qdata (object, quark_tooltip_window);
2678
2679       tooltip_text = g_value_get_string (value);
2680
2681       /* Treat an empty string as a NULL string,
2682        * because an empty string would be useless for a tooltip:
2683        */
2684       if (tooltip_text && (strlen (tooltip_text) == 0))
2685         tooltip_text = NULL;
2686
2687       tooltip_markup = tooltip_text ? g_markup_escape_text (tooltip_text, -1) : NULL;
2688
2689       g_object_set_qdata_full (object, quark_tooltip_markup,
2690                                tooltip_markup, g_free);
2691
2692       tmp = (tooltip_window != NULL || tooltip_markup != NULL);
2693       gtk_widget_real_set_has_tooltip (widget, tmp, FALSE);
2694       if (gtk_widget_get_visible (widget))
2695         gtk_widget_queue_tooltip_query (widget);
2696       break;
2697     case PROP_DOUBLE_BUFFERED:
2698       gtk_widget_set_double_buffered (widget, g_value_get_boolean (value));
2699       break;
2700     default:
2701       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2702       break;
2703     }
2704 }
2705
2706 static void
2707 gtk_widget_get_property (GObject         *object,
2708                          guint            prop_id,
2709                          GValue          *value,
2710                          GParamSpec      *pspec)
2711 {
2712   GtkWidget *widget = GTK_WIDGET (object);
2713
2714   switch (prop_id)
2715     {
2716       gpointer *eventp;
2717       gpointer *modep;
2718
2719     case PROP_NAME:
2720       if (widget->name)
2721         g_value_set_string (value, widget->name);
2722       else
2723         g_value_set_static_string (value, "");
2724       break;
2725     case PROP_PARENT:
2726       g_value_set_object (value, widget->parent);
2727       break;
2728     case PROP_WIDTH_REQUEST:
2729       {
2730         int w;
2731         gtk_widget_get_size_request (widget, &w, NULL);
2732         g_value_set_int (value, w);
2733       }
2734       break;
2735     case PROP_HEIGHT_REQUEST:
2736       {
2737         int h;
2738         gtk_widget_get_size_request (widget, NULL, &h);
2739         g_value_set_int (value, h);
2740       }
2741       break;
2742     case PROP_VISIBLE:
2743       g_value_set_boolean (value, (gtk_widget_get_visible (widget) != FALSE));
2744       break;
2745     case PROP_SENSITIVE:
2746       g_value_set_boolean (value, (gtk_widget_get_sensitive (widget) != FALSE));
2747       break;
2748     case PROP_APP_PAINTABLE:
2749       g_value_set_boolean (value, (gtk_widget_get_app_paintable (widget) != FALSE));
2750       break;
2751     case PROP_CAN_FOCUS:
2752       g_value_set_boolean (value, (gtk_widget_get_can_focus (widget) != FALSE));
2753       break;
2754     case PROP_HAS_FOCUS:
2755       g_value_set_boolean (value, (gtk_widget_has_focus (widget) != FALSE));
2756       break;
2757     case PROP_IS_FOCUS:
2758       g_value_set_boolean (value, (gtk_widget_is_focus (widget)));
2759       break;
2760     case PROP_CAN_DEFAULT:
2761       g_value_set_boolean (value, (gtk_widget_get_can_default (widget) != FALSE));
2762       break;
2763     case PROP_HAS_DEFAULT:
2764       g_value_set_boolean (value, (gtk_widget_has_default (widget) != FALSE));
2765       break;
2766     case PROP_RECEIVES_DEFAULT:
2767       g_value_set_boolean (value, (gtk_widget_get_receives_default (widget) != FALSE));
2768       break;
2769     case PROP_COMPOSITE_CHILD:
2770       g_value_set_boolean (value, (GTK_OBJECT_FLAGS (widget) & GTK_COMPOSITE_CHILD) != 0 );
2771       break;
2772     case PROP_STYLE:
2773       g_value_set_object (value, gtk_widget_get_style (widget));
2774       break;
2775     case PROP_EVENTS:
2776       eventp = g_object_get_qdata (G_OBJECT (widget), quark_event_mask);
2777       g_value_set_flags (value, GPOINTER_TO_INT (eventp));
2778       break;
2779     case PROP_EXTENSION_EVENTS:
2780       modep = g_object_get_qdata (G_OBJECT (widget), quark_extension_event_mode);
2781       g_value_set_enum (value, GPOINTER_TO_INT (modep));
2782       break;
2783     case PROP_NO_SHOW_ALL:
2784       g_value_set_boolean (value, gtk_widget_get_no_show_all (widget));
2785       break;
2786     case PROP_HAS_TOOLTIP:
2787       g_value_set_boolean (value, GPOINTER_TO_UINT (g_object_get_qdata (object, quark_has_tooltip)));
2788       break;
2789     case PROP_TOOLTIP_TEXT:
2790       {
2791         gchar *escaped = g_object_get_qdata (object, quark_tooltip_markup);
2792         gchar *text = NULL;
2793
2794         if (escaped && !pango_parse_markup (escaped, -1, 0, NULL, &text, NULL, NULL))
2795           g_assert (NULL == text); /* text should still be NULL in case of markup errors */
2796
2797         g_value_take_string (value, text);
2798       }
2799       break;
2800     case PROP_TOOLTIP_MARKUP:
2801       g_value_set_string (value, g_object_get_qdata (object, quark_tooltip_markup));
2802       break;
2803     case PROP_WINDOW:
2804       g_value_set_object (value, gtk_widget_get_window (widget));
2805       break;
2806     case PROP_DOUBLE_BUFFERED:
2807       g_value_set_boolean (value, gtk_widget_get_double_buffered (widget));
2808       break;
2809     default:
2810       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2811       break;
2812     }
2813 }
2814
2815 static void
2816 gtk_widget_init (GtkWidget *widget)
2817 {
2818   GTK_PRIVATE_FLAGS (widget) = PRIVATE_GTK_CHILD_VISIBLE;
2819   widget->state = GTK_STATE_NORMAL;
2820   widget->saved_state = GTK_STATE_NORMAL;
2821   widget->name = NULL;
2822   widget->requisition.width = 0;
2823   widget->requisition.height = 0;
2824   widget->allocation.x = -1;
2825   widget->allocation.y = -1;
2826   widget->allocation.width = 1;
2827   widget->allocation.height = 1;
2828   widget->window = NULL;
2829   widget->parent = NULL;
2830
2831   GTK_OBJECT_FLAGS (widget) |= GTK_SENSITIVE;
2832   GTK_OBJECT_FLAGS (widget) |= GTK_PARENT_SENSITIVE;
2833   GTK_OBJECT_FLAGS (widget) |= composite_child_stack ? GTK_COMPOSITE_CHILD : 0;
2834   gtk_widget_set_double_buffered (widget, TRUE);
2835
2836   GTK_PRIVATE_SET_FLAG (widget, GTK_REDRAW_ON_ALLOC);
2837   GTK_PRIVATE_SET_FLAG (widget, GTK_REQUEST_NEEDED);
2838   GTK_PRIVATE_SET_FLAG (widget, GTK_ALLOC_NEEDED);
2839
2840   widget->style = gtk_widget_get_default_style ();
2841   g_object_ref (widget->style);
2842 }
2843
2844
2845 static void
2846 gtk_widget_dispatch_child_properties_changed (GtkWidget   *widget,
2847                                               guint        n_pspecs,
2848                                               GParamSpec **pspecs)
2849 {
2850   GtkWidget *container = widget->parent;
2851   guint i;
2852
2853   for (i = 0; widget->parent == container && i < n_pspecs; i++)
2854     g_signal_emit (widget, widget_signals[CHILD_NOTIFY], g_quark_from_string (pspecs[i]->name), pspecs[i]);
2855 }
2856
2857 /**
2858  * gtk_widget_freeze_child_notify:
2859  * @widget: a #GtkWidget
2860  *
2861  * Stops emission of #GtkWidget::child-notify signals on @widget. The
2862  * signals are queued until gtk_widget_thaw_child_notify() is called
2863  * on @widget.
2864  *
2865  * This is the analogue of g_object_freeze_notify() for child properties.
2866  **/
2867 void
2868 gtk_widget_freeze_child_notify (GtkWidget *widget)
2869 {
2870   g_return_if_fail (GTK_IS_WIDGET (widget));
2871
2872   if (!G_OBJECT (widget)->ref_count)
2873     return;
2874
2875   g_object_ref (widget);
2876   g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
2877   g_object_unref (widget);
2878 }
2879
2880 /**
2881  * gtk_widget_child_notify:
2882  * @widget: a #GtkWidget
2883  * @child_property: the name of a child property installed on the
2884  *                  class of @widget<!-- -->'s parent
2885  *
2886  * Emits a #GtkWidget::child-notify signal for the
2887  * <link linkend="child-properties">child property</link> @child_property
2888  * on @widget.
2889  *
2890  * This is the analogue of g_object_notify() for child properties.
2891  **/
2892 void
2893 gtk_widget_child_notify (GtkWidget    *widget,
2894                          const gchar  *child_property)
2895 {
2896   GParamSpec *pspec;
2897
2898   g_return_if_fail (GTK_IS_WIDGET (widget));
2899   g_return_if_fail (child_property != NULL);
2900   if (!G_OBJECT (widget)->ref_count || !widget->parent)
2901     return;
2902
2903   g_object_ref (widget);
2904   pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
2905                                     child_property,
2906                                     G_OBJECT_TYPE (widget->parent),
2907                                     TRUE);
2908   if (!pspec)
2909     g_warning ("%s: container class `%s' has no child property named `%s'",
2910                G_STRLOC,
2911                G_OBJECT_TYPE_NAME (widget->parent),
2912                child_property);
2913   else
2914     {
2915       GObjectNotifyQueue *nqueue = g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
2916
2917       g_object_notify_queue_add (G_OBJECT (widget), nqueue, pspec);
2918       g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
2919     }
2920   g_object_unref (widget);
2921 }
2922
2923 /**
2924  * gtk_widget_thaw_child_notify:
2925  * @widget: a #GtkWidget
2926  *
2927  * Reverts the effect of a previous call to gtk_widget_freeze_child_notify().
2928  * This causes all queued #GtkWidget::child-notify signals on @widget to be
2929  * emitted.
2930  */
2931 void
2932 gtk_widget_thaw_child_notify (GtkWidget *widget)
2933 {
2934   GObjectNotifyQueue *nqueue;
2935
2936   g_return_if_fail (GTK_IS_WIDGET (widget));
2937
2938   if (!G_OBJECT (widget)->ref_count)
2939     return;
2940
2941   g_object_ref (widget);
2942   nqueue = g_object_notify_queue_from_object (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
2943   if (!nqueue || !nqueue->freeze_count)
2944     g_warning (G_STRLOC ": child-property-changed notification for %s(%p) is not frozen",
2945                G_OBJECT_TYPE_NAME (widget), widget);
2946   else
2947     g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
2948   g_object_unref (widget);
2949 }
2950
2951
2952 /**
2953  * gtk_widget_new:
2954  * @type: type ID of the widget to create
2955  * @first_property_name: name of first property to set
2956  * @Varargs: value of first property, followed by more properties,
2957  *           %NULL-terminated
2958  *
2959  * This is a convenience function for creating a widget and setting
2960  * its properties in one go. For example you might write:
2961  * <literal>gtk_widget_new (GTK_TYPE_LABEL, "label", "Hello World", "xalign",
2962  * 0.0, NULL)</literal> to create a left-aligned label. Equivalent to
2963  * g_object_new(), but returns a widget so you don't have to
2964  * cast the object yourself.
2965  *
2966  * Return value: a new #GtkWidget of type @widget_type
2967  **/
2968 GtkWidget*
2969 gtk_widget_new (GType        type,
2970                 const gchar *first_property_name,
2971                 ...)
2972 {
2973   GtkWidget *widget;
2974   va_list var_args;
2975
2976   g_return_val_if_fail (g_type_is_a (type, GTK_TYPE_WIDGET), NULL);
2977
2978   va_start (var_args, first_property_name);
2979   widget = (GtkWidget *)g_object_new_valist (type, first_property_name, var_args);
2980   va_end (var_args);
2981
2982   return widget;
2983 }
2984
2985 /**
2986  * gtk_widget_set:
2987  * @widget: a #GtkWidget
2988  * @first_property_name: name of first property to set
2989  * @Varargs: value of first property, followed by more properties,
2990  *           %NULL-terminated
2991  *
2992  * Precursor of g_object_set().
2993  *
2994  * Deprecated: 2.0: Use g_object_set() instead.
2995  **/
2996 void
2997 gtk_widget_set (GtkWidget   *widget,
2998                 const gchar *first_property_name,
2999                 ...)
3000 {
3001   va_list var_args;
3002
3003   g_return_if_fail (GTK_IS_WIDGET (widget));
3004
3005   va_start (var_args, first_property_name);
3006   g_object_set_valist (G_OBJECT (widget), first_property_name, var_args);
3007   va_end (var_args);
3008 }
3009
3010 static inline void
3011 gtk_widget_queue_draw_child (GtkWidget *widget)
3012 {
3013   GtkWidget *parent;
3014
3015   parent = widget->parent;
3016   if (parent && gtk_widget_is_drawable (parent))
3017     gtk_widget_queue_draw_area (parent,
3018                                 widget->allocation.x,
3019                                 widget->allocation.y,
3020                                 widget->allocation.width,
3021                                 widget->allocation.height);
3022 }
3023
3024 /**
3025  * gtk_widget_unparent:
3026  * @widget: a #GtkWidget
3027  *
3028  * This function is only for use in widget implementations.
3029  * Should be called by implementations of the remove method
3030  * on #GtkContainer, to dissociate a child from the container.
3031  **/
3032 void
3033 gtk_widget_unparent (GtkWidget *widget)
3034 {
3035   GObjectNotifyQueue *nqueue;
3036   GtkWidget *toplevel;
3037   GtkWidget *old_parent;
3038
3039   g_return_if_fail (GTK_IS_WIDGET (widget));
3040   if (widget->parent == NULL)
3041     return;
3042
3043   /* keep this function in sync with gtk_menu_detach()
3044    */
3045
3046   g_object_freeze_notify (G_OBJECT (widget));
3047   nqueue = g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
3048
3049   toplevel = gtk_widget_get_toplevel (widget);
3050   if (gtk_widget_is_toplevel (toplevel))
3051     _gtk_window_unset_focus_and_default (GTK_WINDOW (toplevel), widget);
3052
3053   if (GTK_CONTAINER (widget->parent)->focus_child == widget)
3054     gtk_container_set_focus_child (GTK_CONTAINER (widget->parent), NULL);
3055
3056   /* If we are unanchoring the child, we save around the toplevel
3057    * to emit hierarchy changed
3058    */
3059   if (GTK_WIDGET_ANCHORED (widget->parent))
3060     g_object_ref (toplevel);
3061   else
3062     toplevel = NULL;
3063
3064   gtk_widget_queue_draw_child (widget);
3065
3066   /* Reset the width and height here, to force reallocation if we
3067    * get added back to a new parent. This won't work if our new
3068    * allocation is smaller than 1x1 and we actually want a size of 1x1...
3069    * (would 0x0 be OK here?)
3070    */
3071   widget->allocation.width = 1;
3072   widget->allocation.height = 1;
3073
3074   if (gtk_widget_get_realized (widget))
3075     {
3076       if (GTK_WIDGET_IN_REPARENT (widget))
3077         gtk_widget_unmap (widget);
3078       else
3079         gtk_widget_unrealize (widget);
3080     }
3081
3082   /* Removing a widget from a container restores the child visible
3083    * flag to the default state, so it doesn't affect the child
3084    * in the next parent.
3085    */
3086   GTK_PRIVATE_SET_FLAG (widget, GTK_CHILD_VISIBLE);
3087
3088   old_parent = widget->parent;
3089   widget->parent = NULL;
3090   gtk_widget_set_parent_window (widget, NULL);
3091   g_signal_emit (widget, widget_signals[PARENT_SET], 0, old_parent);
3092   if (toplevel)
3093     {
3094       _gtk_widget_propagate_hierarchy_changed (widget, toplevel);
3095       g_object_unref (toplevel);
3096     }
3097
3098   g_object_notify (G_OBJECT (widget), "parent");
3099   g_object_thaw_notify (G_OBJECT (widget));
3100   if (!widget->parent)
3101     g_object_notify_queue_clear (G_OBJECT (widget), nqueue);
3102   g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
3103   g_object_unref (widget);
3104 }
3105
3106 /**
3107  * gtk_widget_destroy:
3108  * @widget: a #GtkWidget
3109  *
3110  * Destroys a widget. Equivalent to gtk_object_destroy(), except that
3111  * you don't have to cast the widget to #GtkObject. When a widget is
3112  * destroyed, it will break any references it holds to other objects.
3113  * If the widget is inside a container, the widget will be removed
3114  * from the container. If the widget is a toplevel (derived from
3115  * #GtkWindow), it will be removed from the list of toplevels, and the
3116  * reference GTK+ holds to it will be removed. Removing a
3117  * widget from its container or the list of toplevels results in the
3118  * widget being finalized, unless you've added additional references
3119  * to the widget with g_object_ref().
3120  *
3121  * In most cases, only toplevel widgets (windows) require explicit
3122  * destruction, because when you destroy a toplevel its children will
3123  * be destroyed as well.
3124  **/
3125 void
3126 gtk_widget_destroy (GtkWidget *widget)
3127 {
3128   g_return_if_fail (GTK_IS_WIDGET (widget));
3129
3130   gtk_object_destroy ((GtkObject*) widget);
3131 }
3132
3133 /**
3134  * gtk_widget_destroyed:
3135  * @widget: a #GtkWidget
3136  * @widget_pointer: (inout) (transfer none): address of a variable that contains @widget
3137  *
3138  * This function sets *@widget_pointer to %NULL if @widget_pointer !=
3139  * %NULL.  It's intended to be used as a callback connected to the
3140  * "destroy" signal of a widget. You connect gtk_widget_destroyed()
3141  * as a signal handler, and pass the address of your widget variable
3142  * as user data. Then when the widget is destroyed, the variable will
3143  * be set to %NULL. Useful for example to avoid multiple copies
3144  * of the same dialog.
3145  **/
3146 void
3147 gtk_widget_destroyed (GtkWidget      *widget,
3148                       GtkWidget      **widget_pointer)
3149 {
3150   /* Don't make any assumptions about the
3151    *  value of widget!
3152    *  Even check widget_pointer.
3153    */
3154   if (widget_pointer)
3155     *widget_pointer = NULL;
3156 }
3157
3158 /**
3159  * gtk_widget_show:
3160  * @widget: a #GtkWidget
3161  *
3162  * Flags a widget to be displayed. Any widget that isn't shown will
3163  * not appear on the screen. If you want to show all the widgets in a
3164  * container, it's easier to call gtk_widget_show_all() on the
3165  * container, instead of individually showing the widgets.
3166  *
3167  * Remember that you have to show the containers containing a widget,
3168  * in addition to the widget itself, before it will appear onscreen.
3169  *
3170  * When a toplevel container is shown, it is immediately realized and
3171  * mapped; other shown widgets are realized and mapped when their
3172  * toplevel container is realized and mapped.
3173  **/
3174 void
3175 gtk_widget_show (GtkWidget *widget)
3176 {
3177   g_return_if_fail (GTK_IS_WIDGET (widget));
3178
3179   if (!gtk_widget_get_visible (widget))
3180     {
3181       g_object_ref (widget);
3182       if (!gtk_widget_is_toplevel (widget))
3183         gtk_widget_queue_resize (widget);
3184       g_signal_emit (widget, widget_signals[SHOW], 0);
3185       g_object_notify (G_OBJECT (widget), "visible");
3186       g_object_unref (widget);
3187     }
3188 }
3189
3190 static void
3191 gtk_widget_real_show (GtkWidget *widget)
3192 {
3193   if (!gtk_widget_get_visible (widget))
3194     {
3195       GTK_WIDGET_SET_FLAGS (widget, GTK_VISIBLE);
3196
3197       if (widget->parent &&
3198           gtk_widget_get_mapped (widget->parent) &&
3199           GTK_WIDGET_CHILD_VISIBLE (widget) &&
3200           !gtk_widget_get_mapped (widget))
3201         gtk_widget_map (widget);
3202     }
3203 }
3204
3205 static void
3206 gtk_widget_show_map_callback (GtkWidget *widget, GdkEvent *event, gint *flag)
3207 {
3208   *flag = TRUE;
3209   g_signal_handlers_disconnect_by_func (widget,
3210                                         gtk_widget_show_map_callback,
3211                                         flag);
3212 }
3213
3214 /**
3215  * gtk_widget_show_now:
3216  * @widget: a #GtkWidget
3217  *
3218  * Shows a widget. If the widget is an unmapped toplevel widget
3219  * (i.e. a #GtkWindow that has not yet been shown), enter the main
3220  * loop and wait for the window to actually be mapped. Be careful;
3221  * because the main loop is running, anything can happen during
3222  * this function.
3223  **/
3224 void
3225 gtk_widget_show_now (GtkWidget *widget)
3226 {
3227   gint flag = FALSE;
3228
3229   g_return_if_fail (GTK_IS_WIDGET (widget));
3230
3231   /* make sure we will get event */
3232   if (!gtk_widget_get_mapped (widget) &&
3233       gtk_widget_is_toplevel (widget))
3234     {
3235       gtk_widget_show (widget);
3236
3237       g_signal_connect (widget, "map-event",
3238                         G_CALLBACK (gtk_widget_show_map_callback),
3239                         &flag);
3240
3241       while (!flag)
3242         gtk_main_iteration ();
3243     }
3244   else
3245     gtk_widget_show (widget);
3246 }
3247
3248 /**
3249  * gtk_widget_hide:
3250  * @widget: a #GtkWidget
3251  *
3252  * Reverses the effects of gtk_widget_show(), causing the widget to be
3253  * hidden (invisible to the user).
3254  **/
3255 void
3256 gtk_widget_hide (GtkWidget *widget)
3257 {
3258   g_return_if_fail (GTK_IS_WIDGET (widget));
3259
3260   if (gtk_widget_get_visible (widget))
3261     {
3262       GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
3263
3264       g_object_ref (widget);
3265       if (toplevel != widget && gtk_widget_is_toplevel (toplevel))
3266         _gtk_window_unset_focus_and_default (GTK_WINDOW (toplevel), widget);
3267
3268       g_signal_emit (widget, widget_signals[HIDE], 0);
3269       if (!gtk_widget_is_toplevel (widget))
3270         gtk_widget_queue_resize (widget);
3271       g_object_notify (G_OBJECT (widget), "visible");
3272       g_object_unref (widget);
3273     }
3274 }
3275
3276 static void
3277 gtk_widget_real_hide (GtkWidget *widget)
3278 {
3279   if (gtk_widget_get_visible (widget))
3280     {
3281       GTK_WIDGET_UNSET_FLAGS (widget, GTK_VISIBLE);
3282
3283       if (gtk_widget_get_mapped (widget))
3284         gtk_widget_unmap (widget);
3285     }
3286 }
3287
3288 /**
3289  * gtk_widget_hide_on_delete:
3290  * @widget: a #GtkWidget
3291  *
3292  * Utility function; intended to be connected to the #GtkWidget::delete-event
3293  * signal on a #GtkWindow. The function calls gtk_widget_hide() on its
3294  * argument, then returns %TRUE. If connected to ::delete-event, the
3295  * result is that clicking the close button for a window (on the
3296  * window frame, top right corner usually) will hide but not destroy
3297  * the window. By default, GTK+ destroys windows when ::delete-event
3298  * is received.
3299  *
3300  * Return value: %TRUE
3301  **/
3302 gboolean
3303 gtk_widget_hide_on_delete (GtkWidget *widget)
3304 {
3305   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
3306
3307   gtk_widget_hide (widget);
3308
3309   return TRUE;
3310 }
3311
3312 /**
3313  * gtk_widget_show_all:
3314  * @widget: a #GtkWidget
3315  *
3316  * Recursively shows a widget, and any child widgets (if the widget is
3317  * a container).
3318  **/
3319 void
3320 gtk_widget_show_all (GtkWidget *widget)
3321 {
3322   GtkWidgetClass *class;
3323
3324   g_return_if_fail (GTK_IS_WIDGET (widget));
3325
3326   if (gtk_widget_get_no_show_all (widget))
3327     return;
3328
3329   class = GTK_WIDGET_GET_CLASS (widget);
3330
3331   if (class->show_all)
3332     class->show_all (widget);
3333 }
3334
3335 /**
3336  * gtk_widget_hide_all:
3337  * @widget: a #GtkWidget
3338  *
3339  * Recursively hides a widget and any child widgets.
3340  **/
3341 void
3342 gtk_widget_hide_all (GtkWidget *widget)
3343 {
3344   GtkWidgetClass *class;
3345
3346   g_return_if_fail (GTK_IS_WIDGET (widget));
3347
3348   if (gtk_widget_get_no_show_all (widget))
3349     return;
3350
3351   class = GTK_WIDGET_GET_CLASS (widget);
3352
3353   if (class->hide_all)
3354     class->hide_all (widget);
3355 }
3356
3357 /**
3358  * gtk_widget_map:
3359  * @widget: a #GtkWidget
3360  *
3361  * This function is only for use in widget implementations. Causes
3362  * a widget to be mapped if it isn't already.
3363  **/
3364 void
3365 gtk_widget_map (GtkWidget *widget)
3366 {
3367   g_return_if_fail (GTK_IS_WIDGET (widget));
3368   g_return_if_fail (gtk_widget_get_visible (widget));
3369   g_return_if_fail (GTK_WIDGET_CHILD_VISIBLE (widget));
3370
3371   if (!gtk_widget_get_mapped (widget))
3372     {
3373       if (!gtk_widget_get_realized (widget))
3374         gtk_widget_realize (widget);
3375
3376       g_signal_emit (widget, widget_signals[MAP], 0);
3377
3378       if (!gtk_widget_get_has_window (widget))
3379         gdk_window_invalidate_rect (widget->window, &widget->allocation, FALSE);
3380     }
3381 }
3382
3383 /**
3384  * gtk_widget_unmap:
3385  * @widget: a #GtkWidget
3386  *
3387  * This function is only for use in widget implementations. Causes
3388  * a widget to be unmapped if it's currently mapped.
3389  **/
3390 void
3391 gtk_widget_unmap (GtkWidget *widget)
3392 {
3393   g_return_if_fail (GTK_IS_WIDGET (widget));
3394
3395   if (gtk_widget_get_mapped (widget))
3396     {
3397       if (!gtk_widget_get_has_window (widget))
3398         gdk_window_invalidate_rect (widget->window, &widget->allocation, FALSE);
3399       _gtk_tooltip_hide (widget);
3400       g_signal_emit (widget, widget_signals[UNMAP], 0);
3401     }
3402 }
3403
3404 static void
3405 gtk_widget_set_extension_events_internal (GtkWidget        *widget,
3406                                           GdkExtensionMode  mode,
3407                                           GList            *window_list)
3408 {
3409   GList *free_list = NULL;
3410   GList *l;
3411
3412   if (window_list == NULL)
3413     {
3414       if (gtk_widget_get_has_window (widget))
3415         window_list = g_list_prepend (NULL, widget->window);
3416       else
3417         window_list = gdk_window_get_children (widget->window);
3418
3419       free_list = window_list;
3420     }
3421
3422   for (l = window_list; l != NULL; l = l->next)
3423     {
3424       GdkWindow *window = l->data;
3425       gpointer user_data;
3426
3427       gdk_window_get_user_data (window, &user_data);
3428       if (user_data == widget)
3429         {
3430           GList *children;
3431
3432           gdk_input_set_extension_events (window,
3433                                           gdk_window_get_events (window),
3434                                           mode);
3435
3436           children = gdk_window_get_children (window);
3437           if (children)
3438             {
3439               gtk_widget_set_extension_events_internal (widget, mode, children);
3440               g_list_free (children);
3441             }
3442         }
3443     }
3444
3445   if (free_list)
3446     g_list_free (free_list);
3447 }
3448
3449 /**
3450  * gtk_widget_realize:
3451  * @widget: a #GtkWidget
3452  *
3453  * Creates the GDK (windowing system) resources associated with a
3454  * widget.  For example, @widget->window will be created when a widget
3455  * is realized.  Normally realization happens implicitly; if you show
3456  * a widget and all its parent containers, then the widget will be
3457  * realized and mapped automatically.
3458  *
3459  * Realizing a widget requires all
3460  * the widget's parent widgets to be realized; calling
3461  * gtk_widget_realize() realizes the widget's parents in addition to
3462  * @widget itself. If a widget is not yet inside a toplevel window
3463  * when you realize it, bad things will happen.
3464  *
3465  * This function is primarily used in widget implementations, and
3466  * isn't very useful otherwise. Many times when you think you might
3467  * need it, a better approach is to connect to a signal that will be
3468  * called after the widget is realized automatically, such as
3469  * GtkWidget::expose-event. Or simply g_signal_connect () to the
3470  * GtkWidget::realize signal.
3471  **/
3472 void
3473 gtk_widget_realize (GtkWidget *widget)
3474 {
3475   GdkExtensionMode mode;
3476   GtkWidgetShapeInfo *shape_info;
3477
3478   g_return_if_fail (GTK_IS_WIDGET (widget));
3479   g_return_if_fail (GTK_WIDGET_ANCHORED (widget) ||
3480                     GTK_IS_INVISIBLE (widget));
3481
3482   if (!gtk_widget_get_realized (widget))
3483     {
3484       /*
3485         if (GTK_IS_CONTAINER (widget) && gtk_widget_get_has_window (widget))
3486           g_message ("gtk_widget_realize(%s)", G_OBJECT_TYPE_NAME (widget));
3487       */
3488
3489       if (widget->parent == NULL &&
3490           !gtk_widget_is_toplevel (widget))
3491         g_warning ("Calling gtk_widget_realize() on a widget that isn't "
3492                    "inside a toplevel window is not going to work very well. "
3493                    "Widgets must be inside a toplevel container before realizing them.");
3494
3495       if (widget->parent && !gtk_widget_get_realized (widget->parent))
3496         gtk_widget_realize (widget->parent);
3497
3498       gtk_widget_ensure_style (widget);
3499
3500       g_signal_emit (widget, widget_signals[REALIZE], 0);
3501
3502       gtk_widget_real_set_has_tooltip (widget,
3503                                        GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (widget), quark_has_tooltip)),
3504                                        TRUE);
3505
3506       if (GTK_WIDGET_HAS_SHAPE_MASK (widget))
3507         {
3508           shape_info = g_object_get_qdata (G_OBJECT (widget), quark_shape_info);
3509           gdk_window_shape_combine_mask (widget->window,
3510                                          shape_info->shape_mask,
3511                                          shape_info->offset_x,
3512                                          shape_info->offset_y);
3513         }
3514
3515       shape_info = g_object_get_qdata (G_OBJECT (widget), quark_input_shape_info);
3516       if (shape_info)
3517         gdk_window_input_shape_combine_mask (widget->window,
3518                                              shape_info->shape_mask,
3519                                              shape_info->offset_x,
3520                                              shape_info->offset_y);
3521
3522       mode = gtk_widget_get_extension_events (widget);
3523       if (mode != GDK_EXTENSION_EVENTS_NONE)
3524         gtk_widget_set_extension_events_internal (widget, mode, NULL);
3525     }
3526 }
3527
3528 /**
3529  * gtk_widget_unrealize:
3530  * @widget: a #GtkWidget
3531  *
3532  * This function is only useful in widget implementations.
3533  * Causes a widget to be unrealized (frees all GDK resources
3534  * associated with the widget, such as @widget->window).
3535  **/
3536 void
3537 gtk_widget_unrealize (GtkWidget *widget)
3538 {
3539   g_return_if_fail (GTK_IS_WIDGET (widget));
3540
3541   if (GTK_WIDGET_HAS_SHAPE_MASK (widget))
3542     gtk_widget_shape_combine_mask (widget, NULL, 0, 0);
3543
3544   if (g_object_get_qdata (G_OBJECT (widget), quark_input_shape_info))
3545     gtk_widget_input_shape_combine_mask (widget, NULL, 0, 0);
3546
3547   if (gtk_widget_get_realized (widget))
3548     {
3549       g_object_ref (widget);
3550       _gtk_tooltip_hide (widget);
3551       g_signal_emit (widget, widget_signals[UNREALIZE], 0);
3552       gtk_widget_set_realized (widget, FALSE);
3553       gtk_widget_set_mapped (widget, FALSE);
3554       g_object_unref (widget);
3555     }
3556 }
3557
3558 /*****************************************
3559  * Draw queueing.
3560  *****************************************/
3561
3562 /**
3563  * gtk_widget_queue_draw_area:
3564  * @widget: a #GtkWidget
3565  * @x: x coordinate of upper-left corner of rectangle to redraw
3566  * @y: y coordinate of upper-left corner of rectangle to redraw
3567  * @width: width of region to draw
3568  * @height: height of region to draw
3569  *
3570  * Invalidates the rectangular area of @widget defined by @x, @y,
3571  * @width and @height by calling gdk_window_invalidate_rect() on the
3572  * widget's window and all its child windows. Once the main loop
3573  * becomes idle (after the current batch of events has been processed,
3574  * roughly), the window will receive expose events for the union of
3575  * all regions that have been invalidated.
3576  *
3577  * Normally you would only use this function in widget
3578  * implementations. You might also use it, or
3579  * gdk_window_invalidate_rect() directly, to schedule a redraw of a
3580  * #GtkDrawingArea or some portion thereof.
3581  *
3582  * Frequently you can just call gdk_window_invalidate_rect() or
3583  * gdk_window_invalidate_region() instead of this function. Those
3584  * functions will invalidate only a single window, instead of the
3585  * widget and all its children.
3586  *
3587  * The advantage of adding to the invalidated region compared to
3588  * simply drawing immediately is efficiency; using an invalid region
3589  * ensures that you only have to redraw one time.
3590  **/
3591 void
3592 gtk_widget_queue_draw_area (GtkWidget *widget,
3593                             gint       x,
3594                             gint       y,
3595                             gint       width,
3596                             gint       height)
3597 {
3598   GdkRectangle invalid_rect;
3599   GtkWidget *w;
3600
3601   g_return_if_fail (GTK_IS_WIDGET (widget));
3602
3603   if (!gtk_widget_get_realized (widget))
3604     return;
3605
3606   /* Just return if the widget or one of its ancestors isn't mapped */
3607   for (w = widget; w != NULL; w = w->parent)
3608     if (!gtk_widget_get_mapped (w))
3609       return;
3610
3611   /* Find the correct widget */
3612
3613   if (gtk_widget_get_has_window (widget))
3614     {
3615       if (widget->parent)
3616         {
3617           /* Translate widget relative to window-relative */
3618
3619           gint wx, wy, wwidth, wheight;
3620
3621           gdk_window_get_position (widget->window, &wx, &wy);
3622           x -= wx - widget->allocation.x;
3623           y -= wy - widget->allocation.y;
3624
3625           gdk_drawable_get_size (widget->window, &wwidth, &wheight);
3626
3627           if (x + width <= 0 || y + height <= 0 ||
3628               x >= wwidth || y >= wheight)
3629             return;
3630
3631           if (x < 0)
3632             {
3633               width += x;  x = 0;
3634             }
3635           if (y < 0)
3636             {
3637               height += y; y = 0;
3638             }
3639           if (x + width > wwidth)
3640             width = wwidth - x;
3641           if (y + height > wheight)
3642             height = wheight - y;
3643         }
3644     }
3645
3646   invalid_rect.x = x;
3647   invalid_rect.y = y;
3648   invalid_rect.width = width;
3649   invalid_rect.height = height;
3650
3651   gdk_window_invalidate_rect (widget->window, &invalid_rect, TRUE);
3652 }
3653
3654 static void
3655 widget_add_child_draw_rectangle (GtkWidget    *widget,
3656                                  GdkRectangle *rect)
3657 {
3658   GdkRectangle child_rect;
3659
3660   if (!gtk_widget_get_mapped (widget) ||
3661       widget->window != widget->parent->window)
3662     return;
3663
3664   gtk_widget_get_draw_rectangle (widget, &child_rect);
3665   gdk_rectangle_union (rect, &child_rect, rect);
3666 }
3667
3668 static void
3669 gtk_widget_get_draw_rectangle (GtkWidget    *widget,
3670                                GdkRectangle *rect)
3671 {
3672   if (!gtk_widget_get_has_window (widget))
3673     {
3674       GtkBorder *draw_border = NULL;
3675
3676       *rect = widget->allocation;
3677
3678       gtk_widget_style_get (widget,
3679                             "draw-border", &draw_border,
3680                             NULL);
3681       if (draw_border)
3682         {
3683           rect->x -= draw_border->left;
3684           rect->y -= draw_border->top;
3685           rect->width += draw_border->left + draw_border->right;
3686           rect->height += draw_border->top + draw_border->bottom;
3687
3688           gtk_border_free (draw_border);
3689         }
3690
3691       if (GTK_IS_CONTAINER (widget))
3692         gtk_container_forall (GTK_CONTAINER (widget),
3693                               (GtkCallback)widget_add_child_draw_rectangle,
3694                               rect);
3695     }
3696   else
3697     {
3698       rect->x = 0;
3699       rect->y = 0;
3700       rect->width = widget->allocation.width;
3701       rect->height = widget->allocation.height;
3702     }
3703 }
3704
3705 /**
3706  * gtk_widget_queue_draw:
3707  * @widget: a #GtkWidget
3708  *
3709  * Equivalent to calling gtk_widget_queue_draw_area() for the
3710  * entire area of a widget.
3711  **/
3712 void
3713 gtk_widget_queue_draw (GtkWidget *widget)
3714 {
3715   GdkRectangle rect;
3716
3717   g_return_if_fail (GTK_IS_WIDGET (widget));
3718
3719   gtk_widget_get_draw_rectangle (widget, &rect);
3720
3721   gtk_widget_queue_draw_area (widget,
3722                               rect.x, rect.y,
3723                               rect.width, rect.height);
3724 }
3725
3726 /* Invalidates the given area (allocation-relative-coordinates)
3727  * in all of the widget's windows
3728  */
3729 /**
3730  * gtk_widget_queue_clear_area:
3731  * @widget: a #GtkWidget
3732  * @x: x coordinate of upper-left corner of rectangle to redraw
3733  * @y: y coordinate of upper-left corner of rectangle to redraw
3734  * @width: width of region to draw
3735  * @height: height of region to draw
3736  *
3737  * This function is no longer different from
3738  * gtk_widget_queue_draw_area(), though it once was. Now it just calls
3739  * gtk_widget_queue_draw_area(). Originally
3740  * gtk_widget_queue_clear_area() would force a redraw of the
3741  * background for %GTK_NO_WINDOW widgets, and
3742  * gtk_widget_queue_draw_area() would not. Now both functions ensure
3743  * the background will be redrawn.
3744  *
3745  * Deprecated: 2.2: Use gtk_widget_queue_draw_area() instead.
3746  **/
3747 void
3748 gtk_widget_queue_clear_area (GtkWidget *widget,
3749                              gint       x,
3750                              gint       y,
3751                              gint       width,
3752                              gint       height)
3753 {
3754   g_return_if_fail (GTK_IS_WIDGET (widget));
3755
3756   gtk_widget_queue_draw_area (widget, x, y, width, height);
3757 }
3758
3759 /**
3760  * gtk_widget_queue_clear:
3761  * @widget: a #GtkWidget
3762  *
3763  * This function does the same as gtk_widget_queue_draw().
3764  *
3765  * Deprecated: 2.2: Use gtk_widget_queue_draw() instead.
3766  **/
3767 void
3768 gtk_widget_queue_clear (GtkWidget *widget)
3769 {
3770   g_return_if_fail (GTK_IS_WIDGET (widget));
3771
3772   gtk_widget_queue_draw (widget);
3773 }
3774
3775 /**
3776  * gtk_widget_queue_resize:
3777  * @widget: a #GtkWidget
3778  *
3779  * This function is only for use in widget implementations.
3780  * Flags a widget to have its size renegotiated; should
3781  * be called when a widget for some reason has a new size request.
3782  * For example, when you change the text in a #GtkLabel, #GtkLabel
3783  * queues a resize to ensure there's enough space for the new text.
3784  **/
3785 void
3786 gtk_widget_queue_resize (GtkWidget *widget)
3787 {
3788   g_return_if_fail (GTK_IS_WIDGET (widget));
3789
3790   if (gtk_widget_get_realized (widget))
3791     gtk_widget_queue_shallow_draw (widget);
3792
3793   _gtk_size_group_queue_resize (widget);
3794 }
3795
3796 /**
3797  * gtk_widget_queue_resize_no_redraw:
3798  * @widget: a #GtkWidget
3799  *
3800  * This function works like gtk_widget_queue_resize(),
3801  * except that the widget is not invalidated.
3802  *
3803  * Since: 2.4
3804  **/
3805 void
3806 gtk_widget_queue_resize_no_redraw (GtkWidget *widget)
3807 {
3808   g_return_if_fail (GTK_IS_WIDGET (widget));
3809
3810   _gtk_size_group_queue_resize (widget);
3811 }
3812
3813 /**
3814  * gtk_widget_draw:
3815  * @widget: a #GtkWidget
3816  * @area: area to draw
3817  *
3818  * In GTK+ 1.2, this function would immediately render the
3819  * region @area of a widget, by invoking the virtual draw method of a
3820  * widget. In GTK+ 2.0, the draw method is gone, and instead
3821  * gtk_widget_draw() simply invalidates the specified region of the
3822  * widget, then updates the invalid region of the widget immediately.
3823  * Usually you don't want to update the region immediately for
3824  * performance reasons, so in general gtk_widget_queue_draw_area() is
3825  * a better choice if you want to draw a region of a widget.
3826  **/
3827 void
3828 gtk_widget_draw (GtkWidget          *widget,
3829                  const GdkRectangle *area)
3830 {
3831   g_return_if_fail (GTK_IS_WIDGET (widget));
3832
3833   if (gtk_widget_is_drawable (widget))
3834     {
3835       if (area)
3836         gtk_widget_queue_draw_area (widget,
3837                                     area->x, area->y,
3838                                     area->width, area->height);
3839       else
3840         gtk_widget_queue_draw (widget);
3841
3842       gdk_window_process_updates (widget->window, TRUE);
3843     }
3844 }
3845
3846 /**
3847  * gtk_widget_size_request:
3848  * @widget: a #GtkWidget
3849  * @requisition: a #GtkRequisition to be filled in
3850  *
3851  * This function is typically used when implementing a #GtkContainer
3852  * subclass.  Obtains the preferred size of a widget. The container
3853  * uses this information to arrange its child widgets and decide what
3854  * size allocations to give them with gtk_widget_size_allocate().
3855  *
3856  * You can also call this function from an application, with some
3857  * caveats. Most notably, getting a size request requires the widget
3858  * to be associated with a screen, because font information may be
3859  * needed. Multihead-aware applications should keep this in mind.
3860  *
3861  * Also remember that the size request is not necessarily the size
3862  * a widget will actually be allocated.
3863  *
3864  * See also gtk_widget_get_child_requisition().
3865  **/
3866 void
3867 gtk_widget_size_request (GtkWidget      *widget,
3868                          GtkRequisition *requisition)
3869 {
3870   g_return_if_fail (GTK_IS_WIDGET (widget));
3871
3872 #ifdef G_ENABLE_DEBUG
3873   if (requisition == &widget->requisition)
3874     g_warning ("gtk_widget_size_request() called on child widget with request equal\n to widget->requisition. gtk_widget_set_usize() may not work properly.");
3875 #endif /* G_ENABLE_DEBUG */
3876
3877   _gtk_size_group_compute_requisition (widget, requisition);
3878 }
3879
3880 /**
3881  * gtk_widget_get_child_requisition:
3882  * @widget: a #GtkWidget
3883  * @requisition: a #GtkRequisition to be filled in
3884  *
3885  * This function is only for use in widget implementations. Obtains
3886  * @widget->requisition, unless someone has forced a particular
3887  * geometry on the widget (e.g. with gtk_widget_set_size_request()),
3888  * in which case it returns that geometry instead of the widget's
3889  * requisition.
3890  *
3891  * This function differs from gtk_widget_size_request() in that
3892  * it retrieves the last size request value from @widget->requisition,
3893  * while gtk_widget_size_request() actually calls the "size_request" method
3894  * on @widget to compute the size request and fill in @widget->requisition,
3895  * and only then returns @widget->requisition.
3896  *
3897  * Because this function does not call the "size_request" method, it
3898  * can only be used when you know that @widget->requisition is
3899  * up-to-date, that is, gtk_widget_size_request() has been called
3900  * since the last time a resize was queued. In general, only container
3901  * implementations have this information; applications should use
3902  * gtk_widget_size_request().
3903  **/
3904 void
3905 gtk_widget_get_child_requisition (GtkWidget      *widget,
3906                                   GtkRequisition *requisition)
3907 {
3908   _gtk_size_group_get_child_requisition (widget, requisition);
3909 }
3910
3911 static gboolean
3912 invalidate_predicate (GdkWindow *window,
3913                       gpointer   data)
3914 {
3915   gpointer user_data;
3916
3917   gdk_window_get_user_data (window, &user_data);
3918
3919   return (user_data == data);
3920 }
3921
3922 /* Invalidate @region in widget->window and all children
3923  * of widget->window owned by widget. @region is in the
3924  * same coordinates as widget->allocation and will be
3925  * modified by this call.
3926  */
3927 static void
3928 gtk_widget_invalidate_widget_windows (GtkWidget *widget,
3929                                       GdkRegion *region)
3930 {
3931   if (!gtk_widget_get_realized (widget))
3932     return;
3933
3934   if (gtk_widget_get_has_window (widget) && widget->parent)
3935     {
3936       int x, y;
3937
3938       gdk_window_get_position (widget->window, &x, &y);
3939       gdk_region_offset (region, -x, -y);
3940     }
3941
3942   gdk_window_invalidate_maybe_recurse (widget->window, region,
3943                                        invalidate_predicate, widget);
3944 }
3945
3946 /**
3947  * gtk_widget_queue_shallow_draw:
3948  * @widget: a #GtkWidget
3949  *
3950  * Like gtk_widget_queue_draw(), but only windows owned
3951  * by @widget are invalidated.
3952  **/
3953 static void
3954 gtk_widget_queue_shallow_draw (GtkWidget *widget)
3955 {
3956   GdkRectangle rect;
3957   GdkRegion *region;
3958
3959   if (!gtk_widget_get_realized (widget))
3960     return;
3961
3962   gtk_widget_get_draw_rectangle (widget, &rect);
3963
3964   /* get_draw_rectangle() gives us window coordinates, we
3965    * need to convert to the coordinates that widget->allocation
3966    * is in.
3967    */
3968   if (gtk_widget_get_has_window (widget) && widget->parent)
3969     {
3970       int wx, wy;
3971
3972       gdk_window_get_position (widget->window, &wx, &wy);
3973
3974       rect.x += wx;
3975       rect.y += wy;
3976     }
3977
3978   region = gdk_region_rectangle (&rect);
3979   gtk_widget_invalidate_widget_windows (widget, region);
3980   gdk_region_destroy (region);
3981 }
3982
3983 /**
3984  * gtk_widget_size_allocate:
3985  * @widget: a #GtkWidget
3986  * @allocation: position and size to be allocated to @widget
3987  *
3988  * This function is only used by #GtkContainer subclasses, to assign a size
3989  * and position to their child widgets.
3990  **/
3991 void
3992 gtk_widget_size_allocate (GtkWidget     *widget,
3993                           GtkAllocation *allocation)
3994 {
3995   GtkWidgetAuxInfo *aux_info;
3996   GdkRectangle real_allocation;
3997   GdkRectangle old_allocation;
3998   gboolean alloc_needed;
3999   gboolean size_changed;
4000   gboolean position_changed;
4001
4002   g_return_if_fail (GTK_IS_WIDGET (widget));
4003
4004 #ifdef G_ENABLE_DEBUG
4005   if (gtk_debug_flags & GTK_DEBUG_GEOMETRY)
4006     {
4007       gint depth;
4008       GtkWidget *parent;
4009       const gchar *name;
4010
4011       depth = 0;
4012       parent = widget;
4013       while (parent)
4014         {
4015           depth++;
4016           parent = gtk_widget_get_parent (parent);
4017         }
4018
4019       name = g_type_name (G_OBJECT_TYPE (G_OBJECT (widget)));
4020       g_print ("gtk_widget_size_allocate: %*s%s %d %d\n",
4021                2 * depth, " ", name,
4022                allocation->width, allocation->height);
4023     }
4024 #endif /* G_ENABLE_DEBUG */
4025
4026   alloc_needed = GTK_WIDGET_ALLOC_NEEDED (widget);
4027   if (!GTK_WIDGET_REQUEST_NEEDED (widget))      /* Preserve request/allocate ordering */
4028     GTK_PRIVATE_UNSET_FLAG (widget, GTK_ALLOC_NEEDED);
4029
4030   old_allocation = widget->allocation;
4031   real_allocation = *allocation;
4032   aux_info =_gtk_widget_get_aux_info (widget, FALSE);
4033
4034   if (aux_info)
4035     {
4036       if (aux_info->x_set)
4037         real_allocation.x = aux_info->x;
4038       if (aux_info->y_set)
4039         real_allocation.y = aux_info->y;
4040     }
4041
4042   if (real_allocation.width < 0 || real_allocation.height < 0)
4043     {
4044       g_warning ("gtk_widget_size_allocate(): attempt to allocate widget with width %d and height %d",
4045                  real_allocation.width,
4046                  real_allocation.height);
4047     }
4048
4049   real_allocation.width = MAX (real_allocation.width, 1);
4050   real_allocation.height = MAX (real_allocation.height, 1);
4051
4052   size_changed = (old_allocation.width != real_allocation.width ||
4053                   old_allocation.height != real_allocation.height);
4054   position_changed = (old_allocation.x != real_allocation.x ||
4055                       old_allocation.y != real_allocation.y);
4056
4057   if (!alloc_needed && !size_changed && !position_changed)
4058     return;
4059
4060   g_signal_emit (widget, widget_signals[SIZE_ALLOCATE], 0, &real_allocation);
4061
4062   if (gtk_widget_get_mapped (widget))
4063     {
4064       if (!gtk_widget_get_has_window (widget) && GTK_WIDGET_REDRAW_ON_ALLOC (widget) && position_changed)
4065         {
4066           /* Invalidate union(old_allaction,widget->allocation) in widget->window
4067            */
4068           GdkRegion *invalidate = gdk_region_rectangle (&widget->allocation);
4069           gdk_region_union_with_rect (invalidate, &old_allocation);
4070
4071           gdk_window_invalidate_region (widget->window, invalidate, FALSE);
4072           gdk_region_destroy (invalidate);
4073         }
4074
4075       if (size_changed)
4076         {
4077           if (GTK_WIDGET_REDRAW_ON_ALLOC (widget))
4078             {
4079               /* Invalidate union(old_allaction,widget->allocation) in widget->window and descendents owned by widget
4080                */
4081               GdkRegion *invalidate = gdk_region_rectangle (&widget->allocation);
4082               gdk_region_union_with_rect (invalidate, &old_allocation);
4083
4084               gtk_widget_invalidate_widget_windows (widget, invalidate);
4085               gdk_region_destroy (invalidate);
4086             }
4087         }
4088     }
4089
4090   if ((size_changed || position_changed) && widget->parent &&
4091       gtk_widget_get_realized (widget->parent) && GTK_CONTAINER (widget->parent)->reallocate_redraws)
4092     {
4093       GdkRegion *invalidate = gdk_region_rectangle (&widget->parent->allocation);
4094       gtk_widget_invalidate_widget_windows (widget->parent, invalidate);
4095       gdk_region_destroy (invalidate);
4096     }
4097 }
4098
4099 /**
4100  * gtk_widget_common_ancestor:
4101  * @widget_a: a #GtkWidget
4102  * @widget_b: a #GtkWidget
4103  *
4104  * Find the common ancestor of @widget_a and @widget_b that
4105  * is closest to the two widgets.
4106  *
4107  * Return value: the closest common ancestor of @widget_a and
4108  *   @widget_b or %NULL if @widget_a and @widget_b do not
4109  *   share a common ancestor.
4110  **/
4111 static GtkWidget *
4112 gtk_widget_common_ancestor (GtkWidget *widget_a,
4113                             GtkWidget *widget_b)
4114 {
4115   GtkWidget *parent_a;
4116   GtkWidget *parent_b;
4117   gint depth_a = 0;
4118   gint depth_b = 0;
4119
4120   parent_a = widget_a;
4121   while (parent_a->parent)
4122     {
4123       parent_a = parent_a->parent;
4124       depth_a++;
4125     }
4126
4127   parent_b = widget_b;
4128   while (parent_b->parent)
4129     {
4130       parent_b = parent_b->parent;
4131       depth_b++;
4132     }
4133
4134   if (parent_a != parent_b)
4135     return NULL;
4136
4137   while (depth_a > depth_b)
4138     {
4139       widget_a = widget_a->parent;
4140       depth_a--;
4141     }
4142
4143   while (depth_b > depth_a)
4144     {
4145       widget_b = widget_b->parent;
4146       depth_b--;
4147     }
4148
4149   while (widget_a != widget_b)
4150     {
4151       widget_a = widget_a->parent;
4152       widget_b = widget_b->parent;
4153     }
4154
4155   return widget_a;
4156 }
4157
4158 /**
4159  * gtk_widget_translate_coordinates:
4160  * @src_widget:  a #GtkWidget
4161  * @dest_widget: a #GtkWidget
4162  * @src_x: X position relative to @src_widget
4163  * @src_y: Y position relative to @src_widget
4164  * @dest_x: (out): location to store X position relative to @dest_widget
4165  * @dest_y: (out): location to store Y position relative to @dest_widget
4166  *
4167  * Translate coordinates relative to @src_widget's allocation to coordinates
4168  * relative to @dest_widget's allocations. In order to perform this
4169  * operation, both widgets must be realized, and must share a common
4170  * toplevel.
4171  *
4172  * Return value: %FALSE if either widget was not realized, or there
4173  *   was no common ancestor. In this case, nothing is stored in
4174  *   *@dest_x and *@dest_y. Otherwise %TRUE.
4175  **/
4176 gboolean
4177 gtk_widget_translate_coordinates (GtkWidget  *src_widget,
4178                                   GtkWidget  *dest_widget,
4179                                   gint        src_x,
4180                                   gint        src_y,
4181                                   gint       *dest_x,
4182                                   gint       *dest_y)
4183 {
4184   GtkWidget *ancestor;
4185   GdkWindow *window;
4186   GList *dest_list = NULL;
4187
4188   g_return_val_if_fail (GTK_IS_WIDGET (src_widget), FALSE);
4189   g_return_val_if_fail (GTK_IS_WIDGET (dest_widget), FALSE);
4190
4191   ancestor = gtk_widget_common_ancestor (src_widget, dest_widget);
4192   if (!ancestor || !gtk_widget_get_realized (src_widget) || !gtk_widget_get_realized (dest_widget))
4193     return FALSE;
4194
4195   /* Translate from allocation relative to window relative */
4196   if (gtk_widget_get_has_window (src_widget) && src_widget->parent)
4197     {
4198       gint wx, wy;
4199       gdk_window_get_position (src_widget->window, &wx, &wy);
4200
4201       src_x -= wx - src_widget->allocation.x;
4202       src_y -= wy - src_widget->allocation.y;
4203     }
4204   else
4205     {
4206       src_x += src_widget->allocation.x;
4207       src_y += src_widget->allocation.y;
4208     }
4209
4210   /* Translate to the common ancestor */
4211   window = src_widget->window;
4212   while (window != ancestor->window)
4213     {
4214       gdouble dx, dy;
4215
4216       gdk_window_coords_to_parent (window, src_x, src_y, &dx, &dy);
4217
4218       src_x = dx;
4219       src_y = dy;
4220
4221       window = gdk_window_get_effective_parent (window);
4222
4223       if (!window)              /* Handle GtkHandleBox */
4224         return FALSE;
4225     }
4226
4227   /* And back */
4228   window = dest_widget->window;
4229   while (window != ancestor->window)
4230     {
4231       dest_list = g_list_prepend (dest_list, window);
4232
4233       window = gdk_window_get_effective_parent (window);
4234
4235       if (!window)              /* Handle GtkHandleBox */
4236         {
4237           g_list_free (dest_list);
4238           return FALSE;
4239         }
4240     }
4241
4242   while (dest_list)
4243     {
4244       gdouble dx, dy;
4245
4246       gdk_window_coords_from_parent (dest_list->data, src_x, src_y, &dx, &dy);
4247
4248       src_x = dx;
4249       src_y = dy;
4250
4251       dest_list = g_list_remove (dest_list, dest_list->data);
4252     }
4253
4254   /* Translate from window relative to allocation relative */
4255   if (gtk_widget_get_has_window (dest_widget) && dest_widget->parent)
4256     {
4257       gint wx, wy;
4258       gdk_window_get_position (dest_widget->window, &wx, &wy);
4259
4260       src_x += wx - dest_widget->allocation.x;
4261       src_y += wy - dest_widget->allocation.y;
4262     }
4263   else
4264     {
4265       src_x -= dest_widget->allocation.x;
4266       src_y -= dest_widget->allocation.y;
4267     }
4268
4269   if (dest_x)
4270     *dest_x = src_x;
4271   if (dest_y)
4272     *dest_y = src_y;
4273
4274   return TRUE;
4275 }
4276
4277 static void
4278 gtk_widget_real_size_allocate (GtkWidget     *widget,
4279                                GtkAllocation *allocation)
4280 {
4281   widget->allocation = *allocation;
4282
4283   if (gtk_widget_get_realized (widget) &&
4284       gtk_widget_get_has_window (widget))
4285      {
4286         gdk_window_move_resize (widget->window,
4287                                 allocation->x, allocation->y,
4288                                 allocation->width, allocation->height);
4289      }
4290 }
4291
4292 static gboolean
4293 gtk_widget_real_can_activate_accel (GtkWidget *widget,
4294                                     guint      signal_id)
4295 {
4296   /* widgets must be onscreen for accels to take effect */
4297   return gtk_widget_is_sensitive (widget) &&
4298          gtk_widget_is_drawable (widget) &&
4299          gdk_window_is_viewable (widget->window);
4300 }
4301
4302 /**
4303  * gtk_widget_can_activate_accel:
4304  * @widget: a #GtkWidget
4305  * @signal_id: the ID of a signal installed on @widget
4306  *
4307  * Determines whether an accelerator that activates the signal
4308  * identified by @signal_id can currently be activated.
4309  * This is done by emitting the #GtkWidget::can-activate-accel
4310  * signal on @widget; if the signal isn't overridden by a
4311  * handler or in a derived widget, then the default check is
4312  * that the widget must be sensitive, and the widget and all
4313  * its ancestors mapped.
4314  *
4315  * Return value: %TRUE if the accelerator can be activated.
4316  *
4317  * Since: 2.4
4318  **/
4319 gboolean
4320 gtk_widget_can_activate_accel (GtkWidget *widget,
4321                                guint      signal_id)
4322 {
4323   gboolean can_activate = FALSE;
4324   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4325   g_signal_emit (widget, widget_signals[CAN_ACTIVATE_ACCEL], 0, signal_id, &can_activate);
4326   return can_activate;
4327 }
4328
4329 typedef struct {
4330   GClosure   closure;
4331   guint      signal_id;
4332 } AccelClosure;
4333
4334 static void
4335 closure_accel_activate (GClosure     *closure,
4336                         GValue       *return_value,
4337                         guint         n_param_values,
4338                         const GValue *param_values,
4339                         gpointer      invocation_hint,
4340                         gpointer      marshal_data)
4341 {
4342   AccelClosure *aclosure = (AccelClosure*) closure;
4343   gboolean can_activate = gtk_widget_can_activate_accel (closure->data, aclosure->signal_id);
4344
4345   if (can_activate)
4346     g_signal_emit (closure->data, aclosure->signal_id, 0);
4347
4348   /* whether accelerator was handled */
4349   g_value_set_boolean (return_value, can_activate);
4350 }
4351
4352 static void
4353 closures_destroy (gpointer data)
4354 {
4355   GSList *slist, *closures = data;
4356
4357   for (slist = closures; slist; slist = slist->next)
4358     {
4359       g_closure_invalidate (slist->data);
4360       g_closure_unref (slist->data);
4361     }
4362   g_slist_free (closures);
4363 }
4364
4365 static GClosure*
4366 widget_new_accel_closure (GtkWidget *widget,
4367                           guint      signal_id)
4368 {
4369   AccelClosure *aclosure;
4370   GClosure *closure = NULL;
4371   GSList *slist, *closures;
4372
4373   closures = g_object_steal_qdata (G_OBJECT (widget), quark_accel_closures);
4374   for (slist = closures; slist; slist = slist->next)
4375     if (!gtk_accel_group_from_accel_closure (slist->data))
4376       {
4377         /* reuse this closure */
4378         closure = slist->data;
4379         break;
4380       }
4381   if (!closure)
4382     {
4383       closure = g_closure_new_object (sizeof (AccelClosure), G_OBJECT (widget));
4384       closures = g_slist_prepend (closures, g_closure_ref (closure));
4385       g_closure_sink (closure);
4386       g_closure_set_marshal (closure, closure_accel_activate);
4387     }
4388   g_object_set_qdata_full (G_OBJECT (widget), quark_accel_closures, closures, closures_destroy);
4389
4390   aclosure = (AccelClosure*) closure;
4391   g_assert (closure->data == widget);
4392   g_assert (closure->marshal == closure_accel_activate);
4393   aclosure->signal_id = signal_id;
4394
4395   return closure;
4396 }
4397
4398 /**
4399  * gtk_widget_add_accelerator
4400  * @widget:       widget to install an accelerator on
4401  * @accel_signal: widget signal to emit on accelerator activation
4402  * @accel_group:  accel group for this widget, added to its toplevel
4403  * @accel_key:    GDK keyval of the accelerator
4404  * @accel_mods:   modifier key combination of the accelerator
4405  * @accel_flags:  flag accelerators, e.g. %GTK_ACCEL_VISIBLE
4406  *
4407  * Installs an accelerator for this @widget in @accel_group that causes
4408  * @accel_signal to be emitted if the accelerator is activated.
4409  * The @accel_group needs to be added to the widget's toplevel via
4410  * gtk_window_add_accel_group(), and the signal must be of type %G_RUN_ACTION.
4411  * Accelerators added through this function are not user changeable during
4412  * runtime. If you want to support accelerators that can be changed by the
4413  * user, use gtk_accel_map_add_entry() and gtk_widget_set_accel_path() or
4414  * gtk_menu_item_set_accel_path() instead.
4415  */
4416 void
4417 gtk_widget_add_accelerator (GtkWidget      *widget,
4418                             const gchar    *accel_signal,
4419                             GtkAccelGroup  *accel_group,
4420                             guint           accel_key,
4421                             GdkModifierType accel_mods,
4422                             GtkAccelFlags   accel_flags)
4423 {
4424   GClosure *closure;
4425   GSignalQuery query;
4426
4427   g_return_if_fail (GTK_IS_WIDGET (widget));
4428   g_return_if_fail (accel_signal != NULL);
4429   g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
4430
4431   g_signal_query (g_signal_lookup (accel_signal, G_OBJECT_TYPE (widget)), &query);
4432   if (!query.signal_id ||
4433       !(query.signal_flags & G_SIGNAL_ACTION) ||
4434       query.return_type != G_TYPE_NONE ||
4435       query.n_params)
4436     {
4437       /* hmm, should be elaborate enough */
4438       g_warning (G_STRLOC ": widget `%s' has no activatable signal \"%s\" without arguments",
4439                  G_OBJECT_TYPE_NAME (widget), accel_signal);
4440       return;
4441     }
4442
4443   closure = widget_new_accel_closure (widget, query.signal_id);
4444
4445   g_object_ref (widget);
4446
4447   /* install the accelerator. since we don't map this onto an accel_path,
4448    * the accelerator will automatically be locked.
4449    */
4450   gtk_accel_group_connect (accel_group,
4451                            accel_key,
4452                            accel_mods,
4453                            accel_flags | GTK_ACCEL_LOCKED,
4454                            closure);
4455
4456   g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
4457
4458   g_object_unref (widget);
4459 }
4460
4461 /**
4462  * gtk_widget_remove_accelerator:
4463  * @widget:       widget to install an accelerator on
4464  * @accel_group:  accel group for this widget
4465  * @accel_key:    GDK keyval of the accelerator
4466  * @accel_mods:   modifier key combination of the accelerator
4467  * @returns:      whether an accelerator was installed and could be removed
4468  *
4469  * Removes an accelerator from @widget, previously installed with
4470  * gtk_widget_add_accelerator().
4471  */
4472 gboolean
4473 gtk_widget_remove_accelerator (GtkWidget      *widget,
4474                                GtkAccelGroup  *accel_group,
4475                                guint           accel_key,
4476                                GdkModifierType accel_mods)
4477 {
4478   GtkAccelGroupEntry *ag_entry;
4479   GList *slist, *clist;
4480   guint n;
4481
4482   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4483   g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE);
4484
4485   ag_entry = gtk_accel_group_query (accel_group, accel_key, accel_mods, &n);
4486   clist = gtk_widget_list_accel_closures (widget);
4487   for (slist = clist; slist; slist = slist->next)
4488     {
4489       guint i;
4490
4491       for (i = 0; i < n; i++)
4492         if (slist->data == (gpointer) ag_entry[i].closure)
4493           {
4494             gboolean is_removed = gtk_accel_group_disconnect (accel_group, slist->data);
4495
4496             g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
4497
4498             g_list_free (clist);
4499
4500             return is_removed;
4501           }
4502     }
4503   g_list_free (clist);
4504
4505   g_warning (G_STRLOC ": no accelerator (%u,%u) installed in accel group (%p) for %s (%p)",
4506              accel_key, accel_mods, accel_group,
4507              G_OBJECT_TYPE_NAME (widget), widget);
4508
4509   return FALSE;
4510 }
4511
4512 /**
4513  * gtk_widget_list_accel_closures
4514  * @widget:  widget to list accelerator closures for
4515  * @returns: a newly allocated #GList of closures
4516  *
4517  * Lists the closures used by @widget for accelerator group connections
4518  * with gtk_accel_group_connect_by_path() or gtk_accel_group_connect().
4519  * The closures can be used to monitor accelerator changes on @widget,
4520  * by connecting to the @GtkAccelGroup::accel-changed signal of the
4521  * #GtkAccelGroup of a closure which can be found out with
4522  * gtk_accel_group_from_accel_closure().
4523  */
4524 GList*
4525 gtk_widget_list_accel_closures (GtkWidget *widget)
4526 {
4527   GSList *slist;
4528   GList *clist = NULL;
4529
4530   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4531
4532   for (slist = g_object_get_qdata (G_OBJECT (widget), quark_accel_closures); slist; slist = slist->next)
4533     if (gtk_accel_group_from_accel_closure (slist->data))
4534       clist = g_list_prepend (clist, slist->data);
4535   return clist;
4536 }
4537
4538 typedef struct {
4539   GQuark         path_quark;
4540   GtkAccelGroup *accel_group;
4541   GClosure      *closure;
4542 } AccelPath;
4543
4544 static void
4545 destroy_accel_path (gpointer data)
4546 {
4547   AccelPath *apath = data;
4548
4549   gtk_accel_group_disconnect (apath->accel_group, apath->closure);
4550
4551   /* closures_destroy takes care of unrefing the closure */
4552   g_object_unref (apath->accel_group);
4553
4554   g_slice_free (AccelPath, apath);
4555 }
4556
4557
4558 /**
4559  * gtk_widget_set_accel_path:
4560  * @widget: a #GtkWidget
4561  * @accel_path: (allow-none): path used to look up the accelerator
4562  * @accel_group: (allow-none): a #GtkAccelGroup.
4563  *
4564  * Given an accelerator group, @accel_group, and an accelerator path,
4565  * @accel_path, sets up an accelerator in @accel_group so whenever the
4566  * key binding that is defined for @accel_path is pressed, @widget
4567  * will be activated.  This removes any accelerators (for any
4568  * accelerator group) installed by previous calls to
4569  * gtk_widget_set_accel_path(). Associating accelerators with
4570  * paths allows them to be modified by the user and the modifications
4571  * to be saved for future use. (See gtk_accel_map_save().)
4572  *
4573  * This function is a low level function that would most likely
4574  * be used by a menu creation system like #GtkUIManager. If you
4575  * use #GtkUIManager, setting up accelerator paths will be done
4576  * automatically.
4577  *
4578  * Even when you you aren't using #GtkUIManager, if you only want to
4579  * set up accelerators on menu items gtk_menu_item_set_accel_path()
4580  * provides a somewhat more convenient interface.
4581  *
4582  * Note that @accel_path string will be stored in a #GQuark. Therefore, if you
4583  * pass a static string, you can save some memory by interning it first with
4584  * g_intern_static_string().
4585  **/
4586 void
4587 gtk_widget_set_accel_path (GtkWidget     *widget,
4588                            const gchar   *accel_path,
4589                            GtkAccelGroup *accel_group)
4590 {
4591   AccelPath *apath;
4592
4593   g_return_if_fail (GTK_IS_WIDGET (widget));
4594   g_return_if_fail (GTK_WIDGET_GET_CLASS (widget)->activate_signal != 0);
4595
4596   if (accel_path)
4597     {
4598       g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
4599       g_return_if_fail (_gtk_accel_path_is_valid (accel_path));
4600
4601       gtk_accel_map_add_entry (accel_path, 0, 0);
4602       apath = g_slice_new (AccelPath);
4603       apath->accel_group = g_object_ref (accel_group);
4604       apath->path_quark = g_quark_from_string (accel_path);
4605       apath->closure = widget_new_accel_closure (widget, GTK_WIDGET_GET_CLASS (widget)->activate_signal);
4606     }
4607   else
4608     apath = NULL;
4609
4610   /* also removes possible old settings */
4611   g_object_set_qdata_full (G_OBJECT (widget), quark_accel_path, apath, destroy_accel_path);
4612
4613   if (apath)
4614     gtk_accel_group_connect_by_path (apath->accel_group, g_quark_to_string (apath->path_quark), apath->closure);
4615
4616   g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
4617 }
4618
4619 const gchar*
4620 _gtk_widget_get_accel_path (GtkWidget *widget,
4621                             gboolean  *locked)
4622 {
4623   AccelPath *apath;
4624
4625   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4626
4627   apath = g_object_get_qdata (G_OBJECT (widget), quark_accel_path);
4628   if (locked)
4629     *locked = apath ? apath->accel_group->lock_count > 0 : TRUE;
4630   return apath ? g_quark_to_string (apath->path_quark) : NULL;
4631 }
4632
4633 /**
4634  * gtk_widget_mnemonic_activate:
4635  * @widget: a #GtkWidget
4636  * @group_cycling:  %TRUE if there are other widgets with the same mnemonic
4637  *
4638  * Emits the #GtkWidget::mnemonic-activate signal.
4639  *
4640  * The default handler for this signal activates the @widget if
4641  * @group_cycling is %FALSE, and just grabs the focus if @group_cycling
4642  * is %TRUE.
4643  *
4644  * Returns: %TRUE if the signal has been handled
4645  */
4646 gboolean
4647 gtk_widget_mnemonic_activate (GtkWidget *widget,
4648                               gboolean   group_cycling)
4649 {
4650   gboolean handled;
4651
4652   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4653
4654   group_cycling = group_cycling != FALSE;
4655   if (!gtk_widget_is_sensitive (widget))
4656     handled = TRUE;
4657   else
4658     g_signal_emit (widget,
4659                    widget_signals[MNEMONIC_ACTIVATE],
4660                    0,
4661                    group_cycling,
4662                    &handled);
4663   return handled;
4664 }
4665
4666 static gboolean
4667 gtk_widget_real_mnemonic_activate (GtkWidget *widget,
4668                                    gboolean   group_cycling)
4669 {
4670   if (!group_cycling && GTK_WIDGET_GET_CLASS (widget)->activate_signal)
4671     gtk_widget_activate (widget);
4672   else if (gtk_widget_get_can_focus (widget))
4673     gtk_widget_grab_focus (widget);
4674   else
4675     {
4676       g_warning ("widget `%s' isn't suitable for mnemonic activation",
4677                  G_OBJECT_TYPE_NAME (widget));
4678       gtk_widget_error_bell (widget);
4679     }
4680   return TRUE;
4681 }
4682
4683 static gboolean
4684 gtk_widget_real_key_press_event (GtkWidget         *widget,
4685                                  GdkEventKey       *event)
4686 {
4687   return gtk_bindings_activate_event (GTK_OBJECT (widget), event);
4688 }
4689
4690 static gboolean
4691 gtk_widget_real_key_release_event (GtkWidget         *widget,
4692                                    GdkEventKey       *event)
4693 {
4694   return gtk_bindings_activate_event (GTK_OBJECT (widget), event);
4695 }
4696
4697 static gboolean
4698 gtk_widget_real_focus_in_event (GtkWidget     *widget,
4699                                 GdkEventFocus *event)
4700 {
4701   gtk_widget_queue_shallow_draw (widget);
4702
4703   return FALSE;
4704 }
4705
4706 static gboolean
4707 gtk_widget_real_focus_out_event (GtkWidget     *widget,
4708                                  GdkEventFocus *event)
4709 {
4710   gtk_widget_queue_shallow_draw (widget);
4711
4712   return FALSE;
4713 }
4714
4715 #define WIDGET_REALIZED_FOR_EVENT(widget, event) \
4716      (event->type == GDK_FOCUS_CHANGE || gtk_widget_get_realized(widget))
4717
4718 /**
4719  * gtk_widget_event:
4720  * @widget: a #GtkWidget
4721  * @event: a #GdkEvent
4722  *
4723  * Rarely-used function. This function is used to emit
4724  * the event signals on a widget (those signals should never
4725  * be emitted without using this function to do so).
4726  * If you want to synthesize an event though, don't use this function;
4727  * instead, use gtk_main_do_event() so the event will behave as if
4728  * it were in the event queue. Don't synthesize expose events; instead,
4729  * use gdk_window_invalidate_rect() to invalidate a region of the
4730  * window.
4731  *
4732  * Return value: return from the event signal emission (%TRUE if
4733  *               the event was handled)
4734  **/
4735 gboolean
4736 gtk_widget_event (GtkWidget *widget,
4737                   GdkEvent  *event)
4738 {
4739   g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
4740   g_return_val_if_fail (WIDGET_REALIZED_FOR_EVENT (widget, event), TRUE);
4741
4742   if (event->type == GDK_EXPOSE)
4743     {
4744       g_warning ("Events of type GDK_EXPOSE cannot be synthesized. To get "
4745                  "the same effect, call gdk_window_invalidate_rect/region(), "
4746                  "followed by gdk_window_process_updates().");
4747       return TRUE;
4748     }
4749
4750   return gtk_widget_event_internal (widget, event);
4751 }
4752
4753
4754 /**
4755  * gtk_widget_send_expose:
4756  * @widget: a #GtkWidget
4757  * @event: a expose #GdkEvent
4758  *
4759  * Very rarely-used function. This function is used to emit
4760  * an expose event signals on a widget. This function is not
4761  * normally used directly. The only time it is used is when
4762  * propagating an expose event to a child %NO_WINDOW widget, and
4763  * that is normally done using gtk_container_propagate_expose().
4764  *
4765  * If you want to force an area of a window to be redrawn,
4766  * use gdk_window_invalidate_rect() or gdk_window_invalidate_region().
4767  * To cause the redraw to be done immediately, follow that call
4768  * with a call to gdk_window_process_updates().
4769  *
4770  * Return value: return from the event signal emission (%TRUE if
4771  *               the event was handled)
4772  **/
4773 gint
4774 gtk_widget_send_expose (GtkWidget *widget,
4775                         GdkEvent  *event)
4776 {
4777   g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
4778   g_return_val_if_fail (gtk_widget_get_realized (widget), TRUE);
4779   g_return_val_if_fail (event != NULL, TRUE);
4780   g_return_val_if_fail (event->type == GDK_EXPOSE, TRUE);
4781
4782   return gtk_widget_event_internal (widget, event);
4783 }
4784
4785 static gboolean
4786 event_window_is_still_viewable (GdkEvent *event)
4787 {
4788   /* Some programs, such as gnome-theme-manager, fake widgets
4789    * into exposing onto a pixmap by sending expose events with
4790    * event->window pointing to a pixmap
4791    */
4792   if (GDK_IS_PIXMAP (event->any.window))
4793     return event->type == GDK_EXPOSE;
4794
4795   /* Check that we think the event's window is viewable before
4796    * delivering the event, to prevent suprises. We do this here
4797    * at the last moment, since the event may have been queued
4798    * up behind other events, held over a recursive main loop, etc.
4799    */
4800   switch (event->type)
4801     {
4802     case GDK_EXPOSE:
4803     case GDK_MOTION_NOTIFY:
4804     case GDK_BUTTON_PRESS:
4805     case GDK_2BUTTON_PRESS:
4806     case GDK_3BUTTON_PRESS:
4807     case GDK_KEY_PRESS:
4808     case GDK_ENTER_NOTIFY:
4809     case GDK_PROXIMITY_IN:
4810     case GDK_SCROLL:
4811       return event->any.window && gdk_window_is_viewable (event->any.window);
4812
4813 #if 0
4814     /* The following events are the second half of paired events;
4815      * we always deliver them to deal with widgets that clean up
4816      * on the second half.
4817      */
4818     case GDK_BUTTON_RELEASE:
4819     case GDK_KEY_RELEASE:
4820     case GDK_LEAVE_NOTIFY:
4821     case GDK_PROXIMITY_OUT:
4822 #endif
4823
4824     default:
4825       /* Remaining events would make sense on an not-viewable window,
4826        * or don't have an associated window.
4827        */
4828       return TRUE;
4829     }
4830 }
4831
4832 static gint
4833 gtk_widget_event_internal (GtkWidget *widget,
4834                            GdkEvent  *event)
4835 {
4836   gboolean return_val = FALSE;
4837
4838   /* We check only once for is-still-visible; if someone
4839    * hides the window in on of the signals on the widget,
4840    * they are responsible for returning TRUE to terminate
4841    * handling.
4842    */
4843   if (!event_window_is_still_viewable (event))
4844     return TRUE;
4845
4846   g_object_ref (widget);
4847
4848   g_signal_emit (widget, widget_signals[EVENT], 0, event, &return_val);
4849   return_val |= !WIDGET_REALIZED_FOR_EVENT (widget, event);
4850   if (!return_val)
4851     {
4852       gint signal_num;
4853
4854       switch (event->type)
4855         {
4856         case GDK_NOTHING:
4857           signal_num = -1;
4858           break;
4859         case GDK_BUTTON_PRESS:
4860         case GDK_2BUTTON_PRESS:
4861         case GDK_3BUTTON_PRESS:
4862           signal_num = BUTTON_PRESS_EVENT;
4863           break;
4864         case GDK_SCROLL:
4865           signal_num = SCROLL_EVENT;
4866           break;
4867         case GDK_BUTTON_RELEASE:
4868           signal_num = BUTTON_RELEASE_EVENT;
4869           break;
4870         case GDK_MOTION_NOTIFY:
4871           signal_num = MOTION_NOTIFY_EVENT;
4872           break;
4873         case GDK_DELETE:
4874           signal_num = DELETE_EVENT;
4875           break;
4876         case GDK_DESTROY:
4877           signal_num = DESTROY_EVENT;
4878           _gtk_tooltip_hide (widget);
4879           break;
4880         case GDK_KEY_PRESS:
4881           signal_num = KEY_PRESS_EVENT;
4882           break;
4883         case GDK_KEY_RELEASE:
4884           signal_num = KEY_RELEASE_EVENT;
4885           break;
4886         case GDK_ENTER_NOTIFY:
4887           signal_num = ENTER_NOTIFY_EVENT;
4888           break;
4889         case GDK_LEAVE_NOTIFY:
4890           signal_num = LEAVE_NOTIFY_EVENT;
4891           break;
4892         case GDK_FOCUS_CHANGE:
4893           signal_num = event->focus_change.in ? FOCUS_IN_EVENT : FOCUS_OUT_EVENT;
4894           if (event->focus_change.in)
4895             _gtk_tooltip_focus_in (widget);
4896           else
4897             _gtk_tooltip_focus_out (widget);
4898           break;
4899         case GDK_CONFIGURE:
4900           signal_num = CONFIGURE_EVENT;
4901           break;
4902         case GDK_MAP:
4903           signal_num = MAP_EVENT;
4904           break;
4905         case GDK_UNMAP:
4906           signal_num = UNMAP_EVENT;
4907           break;
4908         case GDK_WINDOW_STATE:
4909           signal_num = WINDOW_STATE_EVENT;
4910           break;
4911         case GDK_PROPERTY_NOTIFY:
4912           signal_num = PROPERTY_NOTIFY_EVENT;
4913           break;
4914         case GDK_SELECTION_CLEAR:
4915           signal_num = SELECTION_CLEAR_EVENT;
4916           break;
4917         case GDK_SELECTION_REQUEST:
4918           signal_num = SELECTION_REQUEST_EVENT;
4919           break;
4920         case GDK_SELECTION_NOTIFY:
4921           signal_num = SELECTION_NOTIFY_EVENT;
4922           break;
4923         case GDK_PROXIMITY_IN:
4924           signal_num = PROXIMITY_IN_EVENT;
4925           break;
4926         case GDK_PROXIMITY_OUT:
4927           signal_num = PROXIMITY_OUT_EVENT;
4928           break;
4929         case GDK_NO_EXPOSE:
4930           signal_num = NO_EXPOSE_EVENT;
4931           break;
4932         case GDK_CLIENT_EVENT:
4933           signal_num = CLIENT_EVENT;
4934           break;
4935         case GDK_EXPOSE:
4936           signal_num = EXPOSE_EVENT;
4937           break;
4938         case GDK_VISIBILITY_NOTIFY:
4939           signal_num = VISIBILITY_NOTIFY_EVENT;
4940           break;
4941         case GDK_GRAB_BROKEN:
4942           signal_num = GRAB_BROKEN;
4943           break;
4944         case GDK_DAMAGE:
4945           signal_num = DAMAGE_EVENT;
4946           break;
4947         default:
4948           g_warning ("gtk_widget_event(): unhandled event type: %d", event->type);
4949           signal_num = -1;
4950           break;
4951         }
4952       if (signal_num != -1)
4953         g_signal_emit (widget, widget_signals[signal_num], 0, event, &return_val);
4954     }
4955   if (WIDGET_REALIZED_FOR_EVENT (widget, event))
4956     g_signal_emit (widget, widget_signals[EVENT_AFTER], 0, event);
4957   else
4958     return_val = TRUE;
4959
4960   g_object_unref (widget);
4961
4962   return return_val;
4963 }
4964
4965 /**
4966  * gtk_widget_activate:
4967  * @widget: a #GtkWidget that's activatable
4968  *
4969  * For widgets that can be "activated" (buttons, menu items, etc.)
4970  * this function activates them. Activation is what happens when you
4971  * press Enter on a widget during key navigation. If @widget isn't
4972  * activatable, the function returns %FALSE.
4973  *
4974  * Return value: %TRUE if the widget was activatable
4975  **/
4976 gboolean
4977 gtk_widget_activate (GtkWidget *widget)
4978 {
4979   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4980
4981   if (WIDGET_CLASS (widget)->activate_signal)
4982     {
4983       /* FIXME: we should eventually check the signals signature here */
4984       g_signal_emit (widget, WIDGET_CLASS (widget)->activate_signal, 0);
4985
4986       return TRUE;
4987     }
4988   else
4989     return FALSE;
4990 }
4991
4992 /**
4993  * gtk_widget_set_scroll_adjustments:
4994  * @widget: a #GtkWidget
4995  * @hadjustment: (allow-none): an adjustment for horizontal scrolling, or %NULL
4996  * @vadjustment: (allow-none): an adjustment for vertical scrolling, or %NULL
4997  *
4998  * For widgets that support scrolling, sets the scroll adjustments and
4999  * returns %TRUE.  For widgets that don't support scrolling, does
5000  * nothing and returns %FALSE. Widgets that don't support scrolling
5001  * can be scrolled by placing them in a #GtkViewport, which does
5002  * support scrolling.
5003  *
5004  * Return value: %TRUE if the widget supports scrolling
5005  **/
5006 gboolean
5007 gtk_widget_set_scroll_adjustments (GtkWidget     *widget,
5008                                    GtkAdjustment *hadjustment,
5009                                    GtkAdjustment *vadjustment)
5010 {
5011   guint signal_id;
5012   GSignalQuery query;
5013
5014   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5015
5016   if (hadjustment)
5017     g_return_val_if_fail (GTK_IS_ADJUSTMENT (hadjustment), FALSE);
5018   if (vadjustment)
5019     g_return_val_if_fail (GTK_IS_ADJUSTMENT (vadjustment), FALSE);
5020
5021   signal_id = WIDGET_CLASS (widget)->set_scroll_adjustments_signal;
5022   if (!signal_id)
5023     return FALSE;
5024
5025   g_signal_query (signal_id, &query);
5026   if (!query.signal_id ||
5027       !g_type_is_a (query.itype, GTK_TYPE_WIDGET) ||
5028       query.return_type != G_TYPE_NONE ||
5029       query.n_params != 2 ||
5030       query.param_types[0] != GTK_TYPE_ADJUSTMENT ||
5031       query.param_types[1] != GTK_TYPE_ADJUSTMENT)
5032     {
5033       g_warning (G_STRLOC ": signal \"%s::%s\" has wrong signature",
5034                  G_OBJECT_TYPE_NAME (widget), query.signal_name);
5035       return FALSE;
5036     }
5037
5038   g_signal_emit (widget, signal_id, 0, hadjustment, vadjustment);
5039   return TRUE;
5040 }
5041
5042 static void
5043 gtk_widget_reparent_subwindows (GtkWidget *widget,
5044                                 GdkWindow *new_window)
5045 {
5046   if (!gtk_widget_get_has_window (widget))
5047     {
5048       GList *children = gdk_window_get_children (widget->window);
5049       GList *tmp_list;
5050
5051       for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
5052         {
5053           GdkWindow *window = tmp_list->data;
5054           gpointer child;
5055
5056           gdk_window_get_user_data (window, &child);
5057           while (child && child != widget)
5058             child = ((GtkWidget*) child)->parent;
5059
5060           if (child)
5061             gdk_window_reparent (window, new_window, 0, 0);
5062         }
5063
5064       g_list_free (children);
5065     }
5066   else
5067    {
5068      GdkWindow *parent;
5069      GList *tmp_list, *children;
5070
5071      parent = gdk_window_get_parent (widget->window);
5072
5073      if (parent == NULL)
5074        gdk_window_reparent (widget->window, new_window, 0, 0);
5075      else
5076        {
5077          children = gdk_window_get_children (parent);
5078
5079          for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
5080            {
5081              GdkWindow *window = tmp_list->data;
5082              gpointer child;
5083
5084              gdk_window_get_user_data (window, &child);
5085
5086              if (child == widget)
5087                gdk_window_reparent (window, new_window, 0, 0);
5088            }
5089
5090          g_list_free (children);
5091        }
5092    }
5093 }
5094
5095 static void
5096 gtk_widget_reparent_fixup_child (GtkWidget *widget,
5097                                  gpointer   client_data)
5098 {
5099   g_assert (client_data != NULL);
5100
5101   if (!gtk_widget_get_has_window (widget))
5102     {
5103       if (widget->window)
5104         g_object_unref (widget->window);
5105       widget->window = (GdkWindow*) client_data;
5106       if (widget->window)
5107         g_object_ref (widget->window);
5108
5109       if (GTK_IS_CONTAINER (widget))
5110         gtk_container_forall (GTK_CONTAINER (widget),
5111                               gtk_widget_reparent_fixup_child,
5112                               client_data);
5113     }
5114 }
5115
5116 /**
5117  * gtk_widget_reparent:
5118  * @widget: a #GtkWidget
5119  * @new_parent: a #GtkContainer to move the widget into
5120  *
5121  * Moves a widget from one #GtkContainer to another, handling reference
5122  * count issues to avoid destroying the widget.
5123  **/
5124 void
5125 gtk_widget_reparent (GtkWidget *widget,
5126                      GtkWidget *new_parent)
5127 {
5128   g_return_if_fail (GTK_IS_WIDGET (widget));
5129   g_return_if_fail (GTK_IS_CONTAINER (new_parent));
5130   g_return_if_fail (widget->parent != NULL);
5131
5132   if (widget->parent != new_parent)
5133     {
5134       /* First try to see if we can get away without unrealizing
5135        * the widget as we reparent it. if so we set a flag so
5136        * that gtk_widget_unparent doesn't unrealize widget
5137        */
5138       if (gtk_widget_get_realized (widget) && gtk_widget_get_realized (new_parent))
5139         GTK_PRIVATE_SET_FLAG (widget, GTK_IN_REPARENT);
5140
5141       g_object_ref (widget);
5142       gtk_container_remove (GTK_CONTAINER (widget->parent), widget);
5143       gtk_container_add (GTK_CONTAINER (new_parent), widget);
5144       g_object_unref (widget);
5145
5146       if (GTK_WIDGET_IN_REPARENT (widget))
5147         {
5148           GTK_PRIVATE_UNSET_FLAG (widget, GTK_IN_REPARENT);
5149
5150           gtk_widget_reparent_subwindows (widget, gtk_widget_get_parent_window (widget));
5151           gtk_widget_reparent_fixup_child (widget,
5152                                            gtk_widget_get_parent_window (widget));
5153         }
5154
5155       g_object_notify (G_OBJECT (widget), "parent");
5156     }
5157 }
5158
5159 /**
5160  * gtk_widget_intersect:
5161  * @widget: a #GtkWidget
5162  * @area: a rectangle
5163  * @intersection: rectangle to store intersection of @widget and @area
5164  *
5165  * Computes the intersection of a @widget's area and @area, storing
5166  * the intersection in @intersection, and returns %TRUE if there was
5167  * an intersection.  @intersection may be %NULL if you're only
5168  * interested in whether there was an intersection.
5169  *
5170  * Return value: %TRUE if there was an intersection
5171  **/
5172 gboolean
5173 gtk_widget_intersect (GtkWidget          *widget,
5174                       const GdkRectangle *area,
5175                       GdkRectangle       *intersection)
5176 {
5177   GdkRectangle *dest;
5178   GdkRectangle tmp;
5179   gint return_val;
5180
5181   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5182   g_return_val_if_fail (area != NULL, FALSE);
5183
5184   if (intersection)
5185     dest = intersection;
5186   else
5187     dest = &tmp;
5188
5189   return_val = gdk_rectangle_intersect (&widget->allocation, area, dest);
5190
5191   if (return_val && intersection && gtk_widget_get_has_window (widget))
5192     {
5193       intersection->x -= widget->allocation.x;
5194       intersection->y -= widget->allocation.y;
5195     }
5196
5197   return return_val;
5198 }
5199
5200 /**
5201  * gtk_widget_region_intersect:
5202  * @widget: a #GtkWidget
5203  * @region: a #GdkRegion, in the same coordinate system as
5204  *          @widget->allocation. That is, relative to @widget->window
5205  *          for %NO_WINDOW widgets; relative to the parent window
5206  *          of @widget->window for widgets with their own window.
5207  * @returns: A newly allocated region holding the intersection of @widget
5208  *           and @region. The coordinates of the return value are
5209  *           relative to @widget->window for %NO_WINDOW widgets, and
5210  *           relative to the parent window of @widget->window for
5211  *           widgets with their own window.
5212  *
5213  * Computes the intersection of a @widget's area and @region, returning
5214  * the intersection. The result may be empty, use gdk_region_empty() to
5215  * check.
5216  **/
5217 GdkRegion *
5218 gtk_widget_region_intersect (GtkWidget       *widget,
5219                              const GdkRegion *region)
5220 {
5221   GdkRectangle rect;
5222   GdkRegion *dest;
5223
5224   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5225   g_return_val_if_fail (region != NULL, NULL);
5226
5227   gtk_widget_get_draw_rectangle (widget, &rect);
5228
5229   dest = gdk_region_rectangle (&rect);
5230
5231   gdk_region_intersect (dest, region);
5232
5233   return dest;
5234 }
5235
5236 /**
5237  * _gtk_widget_grab_notify:
5238  * @widget: a #GtkWidget
5239  * @was_grabbed: whether a grab is now in effect
5240  *
5241  * Emits the #GtkWidget::grab-notify signal on @widget.
5242  *
5243  * Since: 2.6
5244  **/
5245 void
5246 _gtk_widget_grab_notify (GtkWidget *widget,
5247                          gboolean   was_grabbed)
5248 {
5249   g_signal_emit (widget, widget_signals[GRAB_NOTIFY], 0, was_grabbed);
5250 }
5251
5252 /**
5253  * gtk_widget_grab_focus:
5254  * @widget: a #GtkWidget
5255  *
5256  * Causes @widget to have the keyboard focus for the #GtkWindow it's
5257  * inside. @widget must be a focusable widget, such as a #GtkEntry;
5258  * something like #GtkFrame won't work.
5259  *
5260  * More precisely, it must have the %GTK_CAN_FOCUS flag set. Use
5261  * gtk_widget_set_can_focus() to modify that flag.
5262  **/
5263 void
5264 gtk_widget_grab_focus (GtkWidget *widget)
5265 {
5266   g_return_if_fail (GTK_IS_WIDGET (widget));
5267
5268   if (!gtk_widget_is_sensitive (widget))
5269     return;
5270
5271   g_object_ref (widget);
5272   g_signal_emit (widget, widget_signals[GRAB_FOCUS], 0);
5273   g_object_notify (G_OBJECT (widget), "has-focus");
5274   g_object_unref (widget);
5275 }
5276
5277 static void
5278 reset_focus_recurse (GtkWidget *widget,
5279                      gpointer   data)
5280 {
5281   if (GTK_IS_CONTAINER (widget))
5282     {
5283       GtkContainer *container;
5284
5285       container = GTK_CONTAINER (widget);
5286       gtk_container_set_focus_child (container, NULL);
5287
5288       gtk_container_foreach (container,
5289                              reset_focus_recurse,
5290                              NULL);
5291     }
5292 }
5293
5294 static void
5295 gtk_widget_real_grab_focus (GtkWidget *focus_widget)
5296 {
5297   if (gtk_widget_get_can_focus (focus_widget))
5298     {
5299       GtkWidget *toplevel;
5300       GtkWidget *widget;
5301
5302       /* clear the current focus setting, break if the current widget
5303        * is the focus widget's parent, since containers above that will
5304        * be set by the next loop.
5305        */
5306       toplevel = gtk_widget_get_toplevel (focus_widget);
5307       if (gtk_widget_is_toplevel (toplevel) && GTK_IS_WINDOW (toplevel))
5308         {
5309           widget = GTK_WINDOW (toplevel)->focus_widget;
5310
5311           if (widget == focus_widget)
5312             {
5313               /* We call _gtk_window_internal_set_focus() here so that the
5314                * toplevel window can request the focus if necessary.
5315                * This is needed when the toplevel is a GtkPlug
5316                */
5317               if (!gtk_widget_has_focus (widget))
5318                 _gtk_window_internal_set_focus (GTK_WINDOW (toplevel), focus_widget);
5319
5320               return;
5321             }
5322
5323           if (widget)
5324             {
5325               while (widget->parent && widget->parent != focus_widget->parent)
5326                 {
5327                   widget = widget->parent;
5328                   gtk_container_set_focus_child (GTK_CONTAINER (widget), NULL);
5329                 }
5330             }
5331         }
5332       else if (toplevel != focus_widget)
5333         {
5334           /* gtk_widget_grab_focus() operates on a tree without window...
5335            * actually, this is very questionable behaviour.
5336            */
5337
5338           gtk_container_foreach (GTK_CONTAINER (toplevel),
5339                                  reset_focus_recurse,
5340                                  NULL);
5341         }
5342
5343       /* now propagate the new focus up the widget tree and finally
5344        * set it on the window
5345        */
5346       widget = focus_widget;
5347       while (widget->parent)
5348         {
5349           gtk_container_set_focus_child (GTK_CONTAINER (widget->parent), widget);
5350           widget = widget->parent;
5351         }
5352       if (GTK_IS_WINDOW (widget))
5353         _gtk_window_internal_set_focus (GTK_WINDOW (widget), focus_widget);
5354     }
5355 }
5356
5357 static gboolean
5358 gtk_widget_real_query_tooltip (GtkWidget  *widget,
5359                                gint        x,
5360                                gint        y,
5361                                gboolean    keyboard_tip,
5362                                GtkTooltip *tooltip)
5363 {
5364   gchar *tooltip_markup;
5365   gboolean has_tooltip;
5366
5367   tooltip_markup = g_object_get_qdata (G_OBJECT (widget), quark_tooltip_markup);
5368   has_tooltip = GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (widget), quark_has_tooltip));
5369
5370   if (has_tooltip && tooltip_markup)
5371     {
5372       gtk_tooltip_set_markup (tooltip, tooltip_markup);
5373       return TRUE;
5374     }
5375
5376   return FALSE;
5377 }
5378
5379 static gboolean
5380 gtk_widget_real_show_help (GtkWidget        *widget,
5381                            GtkWidgetHelpType help_type)
5382 {
5383   if (help_type == GTK_WIDGET_HELP_TOOLTIP)
5384     {
5385       _gtk_tooltip_toggle_keyboard_mode (widget);
5386
5387       return TRUE;
5388     }
5389   else
5390     return FALSE;
5391 }
5392
5393 static gboolean
5394 gtk_widget_real_focus (GtkWidget         *widget,
5395                        GtkDirectionType   direction)
5396 {
5397   if (!gtk_widget_get_can_focus (widget))
5398     return FALSE;
5399
5400   if (!gtk_widget_is_focus (widget))
5401     {
5402       gtk_widget_grab_focus (widget);
5403       return TRUE;
5404     }
5405   else
5406     return FALSE;
5407 }
5408
5409 static void
5410 gtk_widget_real_move_focus (GtkWidget         *widget,
5411                             GtkDirectionType   direction)
5412 {
5413   GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
5414
5415   if (GTK_IS_WINDOW (toplevel) &&
5416       GTK_WINDOW_GET_CLASS (toplevel)->move_focus)
5417     {
5418       GTK_WINDOW_GET_CLASS (toplevel)->move_focus (GTK_WINDOW (toplevel),
5419                                                    direction);
5420     }
5421 }
5422
5423 static gboolean
5424 gtk_widget_real_keynav_failed (GtkWidget        *widget,
5425                                GtkDirectionType  direction)
5426 {
5427   gboolean cursor_only;
5428
5429   switch (direction)
5430     {
5431     case GTK_DIR_TAB_FORWARD:
5432     case GTK_DIR_TAB_BACKWARD:
5433       return FALSE;
5434
5435     case GTK_DIR_UP:
5436     case GTK_DIR_DOWN:
5437     case GTK_DIR_LEFT:
5438     case GTK_DIR_RIGHT:
5439       g_object_get (gtk_widget_get_settings (widget),
5440                     "gtk-keynav-cursor-only", &cursor_only,
5441                     NULL);
5442       if (cursor_only)
5443         return FALSE;
5444       break;
5445     }
5446
5447   gtk_widget_error_bell (widget);
5448
5449   return TRUE;
5450 }
5451
5452 /**
5453  * gtk_widget_set_can_focus:
5454  * @widget: a #GtkWidget
5455  * @can_focus: whether or not @widget can own the input focus.
5456  *
5457  * Specifies whether @widget can own the input focus. See
5458  * gtk_widget_grab_focus() for actually setting the input focus on a
5459  * widget.
5460  *
5461  * Since: 2.18
5462  **/
5463 void
5464 gtk_widget_set_can_focus (GtkWidget *widget,
5465                           gboolean   can_focus)
5466 {
5467   g_return_if_fail (GTK_IS_WIDGET (widget));
5468
5469   if (can_focus != gtk_widget_get_can_focus (widget))
5470     {
5471       if (can_focus)
5472         GTK_OBJECT_FLAGS (widget) |= GTK_CAN_FOCUS;
5473       else
5474         GTK_OBJECT_FLAGS (widget) &= ~(GTK_CAN_FOCUS);
5475
5476       gtk_widget_queue_resize (widget);
5477       g_object_notify (G_OBJECT (widget), "can-focus");
5478     }
5479 }
5480
5481 /**
5482  * gtk_widget_get_can_focus:
5483  * @widget: a #GtkWidget
5484  *
5485  * Determines whether @widget can own the input focus. See
5486  * gtk_widget_set_can_focus().
5487  *
5488  * Return value: %TRUE if @widget can own the input focus, %FALSE otherwise
5489  *
5490  * Since: 2.18
5491  **/
5492 gboolean
5493 gtk_widget_get_can_focus (GtkWidget *widget)
5494 {
5495   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5496
5497   return (GTK_OBJECT_FLAGS (widget) & GTK_CAN_FOCUS) != 0;
5498 }
5499
5500 /**
5501  * gtk_widget_has_focus:
5502  * @widget: a #GtkWidget
5503  *
5504  * Determines if the widget has the global input focus. See
5505  * gtk_widget_is_focus() for the difference between having the global
5506  * input focus, and only having the focus within a toplevel.
5507  *
5508  * Return value: %TRUE if the widget has the global input focus.
5509  *
5510  * Since: 2.18
5511  **/
5512 gboolean
5513 gtk_widget_has_focus (GtkWidget *widget)
5514 {
5515   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5516
5517   return (GTK_OBJECT_FLAGS (widget) & GTK_HAS_FOCUS) != 0;
5518 }
5519
5520 /**
5521  * gtk_widget_is_focus:
5522  * @widget: a #GtkWidget
5523  *
5524  * Determines if the widget is the focus widget within its
5525  * toplevel. (This does not mean that the %HAS_FOCUS flag is
5526  * necessarily set; %HAS_FOCUS will only be set if the
5527  * toplevel widget additionally has the global input focus.)
5528  *
5529  * Return value: %TRUE if the widget is the focus widget.
5530  **/
5531 gboolean
5532 gtk_widget_is_focus (GtkWidget *widget)
5533 {
5534   GtkWidget *toplevel;
5535
5536   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5537
5538   toplevel = gtk_widget_get_toplevel (widget);
5539
5540   if (GTK_IS_WINDOW (toplevel))
5541     return widget == GTK_WINDOW (toplevel)->focus_widget;
5542   else
5543     return FALSE;
5544 }
5545
5546 /**
5547  * gtk_widget_set_can_default:
5548  * @widget: a #GtkWidget
5549  * @can_default: whether or not @widget can be a default widget.
5550  *
5551  * Specifies whether @widget can be a default widget. See
5552  * gtk_widget_grab_default() for details about the meaning of
5553  * "default".
5554  *
5555  * Since: 2.18
5556  **/
5557 void
5558 gtk_widget_set_can_default (GtkWidget *widget,
5559                             gboolean   can_default)
5560 {
5561   g_return_if_fail (GTK_IS_WIDGET (widget));
5562
5563   if (can_default != gtk_widget_get_can_default (widget))
5564     {
5565       if (can_default)
5566         GTK_OBJECT_FLAGS (widget) |= GTK_CAN_DEFAULT;
5567       else
5568         GTK_OBJECT_FLAGS (widget) &= ~(GTK_CAN_DEFAULT);
5569
5570       gtk_widget_queue_resize (widget);
5571       g_object_notify (G_OBJECT (widget), "can-default");
5572     }
5573 }
5574
5575 /**
5576  * gtk_widget_get_can_default:
5577  * @widget: a #GtkWidget
5578  *
5579  * Determines whether @widget can be a default widget. See
5580  * gtk_widget_set_can_default().
5581  *
5582  * Return value: %TRUE if @widget can be a default widget, %FALSE otherwise
5583  *
5584  * Since: 2.18
5585  **/
5586 gboolean
5587 gtk_widget_get_can_default (GtkWidget *widget)
5588 {
5589   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5590
5591   return (GTK_OBJECT_FLAGS (widget) & GTK_CAN_DEFAULT) != 0;
5592 }
5593
5594 /**
5595  * gtk_widget_has_default:
5596  * @widget: a #GtkWidget
5597  *
5598  * Determines whether @widget is the current default widget within its
5599  * toplevel. See gtk_widget_set_can_default().
5600  *
5601  * Return value: %TRUE if @widget is the current default widget within
5602  *     its toplevel, %FALSE otherwise
5603  *
5604  * Since: 2.18
5605  */
5606 gboolean
5607 gtk_widget_has_default (GtkWidget *widget)
5608 {
5609   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5610
5611   return (GTK_OBJECT_FLAGS (widget) & GTK_HAS_DEFAULT) != 0;
5612 }
5613
5614 /**
5615  * gtk_widget_grab_default:
5616  * @widget: a #GtkWidget
5617  *
5618  * Causes @widget to become the default widget. @widget must have the
5619  * %GTK_CAN_DEFAULT flag set; typically you have to set this flag
5620  * yourself by calling <literal>gtk_widget_set_can_default (@widget,
5621  * %TRUE)</literal>. The default widget is activated when
5622  * the user presses Enter in a window. Default widgets must be
5623  * activatable, that is, gtk_widget_activate() should affect them.
5624  **/
5625 void
5626 gtk_widget_grab_default (GtkWidget *widget)
5627 {
5628   GtkWidget *window;
5629
5630   g_return_if_fail (GTK_IS_WIDGET (widget));
5631   g_return_if_fail (gtk_widget_get_can_default (widget));
5632
5633   window = gtk_widget_get_toplevel (widget);
5634
5635   if (window && gtk_widget_is_toplevel (window))
5636     gtk_window_set_default (GTK_WINDOW (window), widget);
5637   else
5638     g_warning (G_STRLOC ": widget not within a GtkWindow");
5639 }
5640
5641 /**
5642  * gtk_widget_set_receives_default:
5643  * @widget: a #GtkWidget
5644  * @receives_default: whether or not @widget can be a default widget.
5645  *
5646  * Specifies whether @widget will be treated as the default widget
5647  * within its toplevel when it has the focus, even if another widget
5648  * is the default.
5649  *
5650  * See gtk_widget_grab_default() for details about the meaning of
5651  * "default".
5652  *
5653  * Since: 2.18
5654  **/
5655 void
5656 gtk_widget_set_receives_default (GtkWidget *widget,
5657                                  gboolean   receives_default)
5658 {
5659   g_return_if_fail (GTK_IS_WIDGET (widget));
5660
5661   if (receives_default != gtk_widget_get_receives_default (widget))
5662     {
5663       if (receives_default)
5664         GTK_OBJECT_FLAGS (widget) |= GTK_RECEIVES_DEFAULT;
5665       else
5666         GTK_OBJECT_FLAGS (widget) &= ~(GTK_RECEIVES_DEFAULT);
5667
5668       g_object_notify (G_OBJECT (widget), "receives-default");
5669     }
5670 }
5671
5672 /**
5673  * gtk_widget_get_receives_default:
5674  * @widget: a #GtkWidget
5675  *
5676  * Determines whether @widget is alyways treated as default widget
5677  * withing its toplevel when it has the focus, even if another widget
5678  * is the default.
5679  *
5680  * See gtk_widget_set_receives_default().
5681  *
5682  * Return value: %TRUE if @widget acts as default widget when focussed,
5683  *               %FALSE otherwise
5684  *
5685  * Since: 2.18
5686  **/
5687 gboolean
5688 gtk_widget_get_receives_default (GtkWidget *widget)
5689 {
5690   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5691
5692   return (GTK_OBJECT_FLAGS (widget) & GTK_RECEIVES_DEFAULT) != 0;
5693 }
5694
5695 /**
5696  * gtk_widget_has_grab:
5697  * @widget: a #GtkWidget
5698  *
5699  * Determines whether the widget is currently grabbing events, so it
5700  * is the only widget receiving input events (keyboard and mouse).
5701  *
5702  * See also gtk_grab_add().
5703  *
5704  * Return value: %TRUE if the widget is in the grab_widgets stack
5705  *
5706  * Since: 2.18
5707  **/
5708 gboolean
5709 gtk_widget_has_grab (GtkWidget *widget)
5710 {
5711   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5712
5713   return (GTK_OBJECT_FLAGS (widget) & GTK_HAS_GRAB) != 0;
5714 }
5715
5716 /**
5717  * gtk_widget_set_name:
5718  * @widget: a #GtkWidget
5719  * @name: name for the widget
5720  *
5721  * Widgets can be named, which allows you to refer to them from a
5722  * gtkrc file. You can apply a style to widgets with a particular name
5723  * in the gtkrc file. See the documentation for gtkrc files (on the
5724  * same page as the docs for #GtkRcStyle).
5725  *
5726  * Note that widget names are separated by periods in paths (see
5727  * gtk_widget_path()), so names with embedded periods may cause confusion.
5728  **/
5729 void
5730 gtk_widget_set_name (GtkWidget   *widget,
5731                      const gchar *name)
5732 {
5733   gchar *new_name;
5734
5735   g_return_if_fail (GTK_IS_WIDGET (widget));
5736
5737   new_name = g_strdup (name);
5738   g_free (widget->name);
5739   widget->name = new_name;
5740
5741   if (gtk_widget_has_rc_style (widget))
5742     gtk_widget_reset_rc_style (widget);
5743
5744   g_object_notify (G_OBJECT (widget), "name");
5745 }
5746
5747 /**
5748  * gtk_widget_get_name:
5749  * @widget: a #GtkWidget
5750  *
5751  * Retrieves the name of a widget. See gtk_widget_set_name() for the
5752  * significance of widget names.
5753  *
5754  * Return value: name of the widget. This string is owned by GTK+ and
5755  * should not be modified or freed
5756  **/
5757 G_CONST_RETURN gchar*
5758 gtk_widget_get_name (GtkWidget *widget)
5759 {
5760   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5761
5762   if (widget->name)
5763     return widget->name;
5764   return G_OBJECT_TYPE_NAME (widget);
5765 }
5766
5767 /**
5768  * gtk_widget_set_state:
5769  * @widget: a #GtkWidget
5770  * @state: new state for @widget
5771  *
5772  * This function is for use in widget implementations. Sets the state
5773  * of a widget (insensitive, prelighted, etc.) Usually you should set
5774  * the state using wrapper functions such as gtk_widget_set_sensitive().
5775  **/
5776 void
5777 gtk_widget_set_state (GtkWidget           *widget,
5778                       GtkStateType         state)
5779 {
5780   g_return_if_fail (GTK_IS_WIDGET (widget));
5781
5782   if (state == gtk_widget_get_state (widget))
5783     return;
5784
5785   if (state == GTK_STATE_INSENSITIVE)
5786     gtk_widget_set_sensitive (widget, FALSE);
5787   else
5788     {
5789       GtkStateData data;
5790
5791       data.state = state;
5792       data.state_restoration = FALSE;
5793       data.use_forall = FALSE;
5794       if (widget->parent)
5795         data.parent_sensitive = (gtk_widget_is_sensitive (widget->parent) != FALSE);
5796       else
5797         data.parent_sensitive = TRUE;
5798
5799       gtk_widget_propagate_state (widget, &data);
5800
5801       if (gtk_widget_is_drawable (widget))
5802         gtk_widget_queue_draw (widget);
5803     }
5804 }
5805
5806 /**
5807  * gtk_widget_get_state:
5808  * @widget: a #GtkWidget
5809  *
5810  * Returns the widget's state. See gtk_widget_set_state().
5811  *
5812  * Returns: the state of @widget.
5813  *
5814  * Since: 2.18
5815  */
5816 GtkStateType
5817 gtk_widget_get_state (GtkWidget *widget)
5818 {
5819   g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_STATE_NORMAL);
5820
5821   return widget->state;
5822 }
5823
5824 /**
5825  * gtk_widget_set_visible:
5826  * @widget: a #GtkWidget
5827  * @visible: whether the widget should be shown or not
5828  *
5829  * Sets the visibility state of @widget. Note that setting this to
5830  * %TRUE doesn't mean the widget is actually viewable, see
5831  * gtk_widget_get_visible().
5832  *
5833  * This function simply calls gtk_widget_show() or gtk_widget_hide()
5834  * but is nicer to use when the visibility of the widget depends on
5835  * some condition.
5836  *
5837  * Since: 2.18
5838  **/
5839 void
5840 gtk_widget_set_visible (GtkWidget *widget,
5841                         gboolean   visible)
5842 {
5843   g_return_if_fail (GTK_IS_WIDGET (widget));
5844
5845   if (visible != gtk_widget_get_visible (widget))
5846     {
5847       if (visible)
5848         gtk_widget_show (widget);
5849       else
5850         gtk_widget_hide (widget);
5851     }
5852 }
5853
5854 /**
5855  * gtk_widget_get_visible:
5856  * @widget: a #GtkWidget
5857  *
5858  * Determines whether the widget is visible. Note that this doesn't
5859  * take into account whether the widget's parent is also visible
5860  * or the widget is obscured in any way.
5861  *
5862  * See gtk_widget_set_visible().
5863  *
5864  * Return value: %TRUE if the widget is visible
5865  *
5866  * Since: 2.18
5867  **/
5868 gboolean
5869 gtk_widget_get_visible (GtkWidget *widget)
5870 {
5871   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5872
5873   return (GTK_OBJECT_FLAGS (widget) & GTK_VISIBLE) != 0;
5874 }
5875
5876 /**
5877  * gtk_widget_set_has_window:
5878  * @widget: a #GtkWidget
5879  * @has_window: whether or not @widget has a window.
5880  *
5881  * Specifies whether @widget has a #GdkWindow of its own. Note that
5882  * all realized widgets have a non-%NULL "window" pointer
5883  * (gtk_widget_get_window() never returns a %NULL window when a widget
5884  * is realized), but for many of them it's actually the #GdkWindow of
5885  * one of its parent widgets. Widgets that create a %window for
5886  * themselves in GtkWidget::realize() however must announce this by
5887  * calling this function with @has_window = %TRUE.
5888  *
5889  * This function should only be called by widget implementations,
5890  * and they should call it in their init() function.
5891  *
5892  * Since: 2.18
5893  **/
5894 void
5895 gtk_widget_set_has_window (GtkWidget *widget,
5896                            gboolean   has_window)
5897 {
5898   g_return_if_fail (GTK_IS_WIDGET (widget));
5899
5900   if (has_window)
5901     GTK_OBJECT_FLAGS (widget) &= ~(GTK_NO_WINDOW);
5902   else
5903     GTK_OBJECT_FLAGS (widget) |= GTK_NO_WINDOW;
5904 }
5905
5906 /**
5907  * gtk_widget_get_has_window:
5908  * @widget: a #GtkWidget
5909  *
5910  * Determines whether @widget has a #GdkWindow of its own. See
5911  * gtk_widget_set_has_window().
5912  *
5913  * Return value: %TRUE if @widget has a window, %FALSE otherwise
5914  *
5915  * Since: 2.18
5916  **/
5917 gboolean
5918 gtk_widget_get_has_window (GtkWidget *widget)
5919 {
5920   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5921
5922   return !((GTK_OBJECT_FLAGS (widget) & GTK_NO_WINDOW) != 0);
5923 }
5924
5925 /**
5926  * gtk_widget_is_toplevel:
5927  * @widget: a #GtkWidget
5928  *
5929  * Determines whether @widget is a toplevel widget. Currently only
5930  * #GtkWindow and #GtkInvisible are toplevel widgets. Toplevel
5931  * widgets have no parent widget.
5932  *
5933  * Return value: %TRUE if @widget is a toplevel, %FALSE otherwise
5934  *
5935  * Since: 2.18
5936  **/
5937 gboolean
5938 gtk_widget_is_toplevel (GtkWidget *widget)
5939 {
5940   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5941
5942   return (GTK_OBJECT_FLAGS (widget) & GTK_TOPLEVEL) != 0;
5943 }
5944
5945 /**
5946  * gtk_widget_is_drawable:
5947  * @widget: a #GtkWidget
5948  *
5949  * Determines whether @widget can be drawn to. A widget can be drawn
5950  * to if it is mapped and visible.
5951  *
5952  * Return value: %TRUE if @widget is drawable, %FALSE otherwise
5953  *
5954  * Since: 2.18
5955  **/
5956 gboolean
5957 gtk_widget_is_drawable (GtkWidget *widget)
5958 {
5959   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5960
5961   return (gtk_widget_get_visible (widget) &&
5962           gtk_widget_get_mapped (widget));
5963 }
5964
5965 /**
5966  * gtk_widget_get_realized:
5967  * @widget: a #GtkWidget
5968  *
5969  * Determines whether @widget is realized.
5970  *
5971  * Return value: %TRUE if @widget is realized, %FALSE otherwise
5972  *
5973  * Since: 2.20
5974  **/
5975 gboolean
5976 gtk_widget_get_realized (GtkWidget *widget)
5977 {
5978   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5979
5980   return (GTK_OBJECT_FLAGS (widget) & GTK_REALIZED) != 0;
5981 }
5982
5983 /**
5984  * gtk_widget_set_realized:
5985  * @widget: a #GtkWidget
5986  * @realized: %TRUE to mark the widget as realized
5987  *
5988  * Marks the widget as being realized.
5989  *
5990  * This function should only ever be called in a derived widget's
5991  * "realize" or "unrealize" implementation.
5992  *
5993  * Since: 2.20
5994  */
5995 void
5996 gtk_widget_set_realized (GtkWidget *widget,
5997                          gboolean   realized)
5998 {
5999   g_return_if_fail (GTK_IS_WIDGET (widget));
6000
6001   if (realized)
6002     GTK_OBJECT_FLAGS (widget) |= GTK_REALIZED;
6003   else
6004     GTK_OBJECT_FLAGS (widget) &= ~(GTK_REALIZED);
6005 }
6006
6007 /**
6008  * gtk_widget_get_mapped:
6009  * @widget: a #GtkWidget
6010  *
6011  * Whether the widget is mapped.
6012  *
6013  * Return value: %TRUE if the widget is mapped, %FALSE otherwise.
6014  *
6015  * Since: 2.20
6016  */
6017 gboolean
6018 gtk_widget_get_mapped (GtkWidget *widget)
6019 {
6020   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6021
6022   return (GTK_OBJECT_FLAGS (widget) & GTK_MAPPED) != 0;
6023 }
6024
6025 /**
6026  * gtk_widget_set_mapped:
6027  * @widget: a #GtkWidget
6028  * @mapped: %TRUE to mark the widget as mapped
6029  *
6030  * Marks the widget as being realized.
6031  *
6032  * This function should only ever be called in a derived widget's
6033  * "map" or "unmap" implementation.
6034  *
6035  * Since: 2.20
6036  */
6037 void
6038 gtk_widget_set_mapped (GtkWidget *widget,
6039                        gboolean   mapped)
6040 {
6041   g_return_if_fail (GTK_IS_WIDGET (widget));
6042
6043   if (mapped)
6044     GTK_OBJECT_FLAGS (widget) |= GTK_MAPPED;
6045   else
6046     GTK_OBJECT_FLAGS (widget) &= ~(GTK_MAPPED);
6047 }
6048
6049 /**
6050  * gtk_widget_set_app_paintable:
6051  * @widget: a #GtkWidget
6052  * @app_paintable: %TRUE if the application will paint on the widget
6053  *
6054  * Sets whether the application intends to draw on the widget in
6055  * an #GtkWidget::expose-event handler.
6056  *
6057  * This is a hint to the widget and does not affect the behavior of
6058  * the GTK+ core; many widgets ignore this flag entirely. For widgets
6059  * that do pay attention to the flag, such as #GtkEventBox and #GtkWindow,
6060  * the effect is to suppress default themed drawing of the widget's
6061  * background. (Children of the widget will still be drawn.) The application
6062  * is then entirely responsible for drawing the widget background.
6063  *
6064  * Note that the background is still drawn when the widget is mapped.
6065  * If this is not suitable (e.g. because you want to make a transparent
6066  * window using an RGBA visual), you can work around this by doing:
6067  * |[
6068  *  gtk_widget_realize (window);
6069  *  gdk_window_set_back_pixmap (window->window, NULL, FALSE);
6070  *  gtk_widget_show (window);
6071  * ]|
6072  **/
6073 void
6074 gtk_widget_set_app_paintable (GtkWidget *widget,
6075                               gboolean   app_paintable)
6076 {
6077   g_return_if_fail (GTK_IS_WIDGET (widget));
6078
6079   app_paintable = (app_paintable != FALSE);
6080
6081   if (gtk_widget_get_app_paintable (widget) != app_paintable)
6082     {
6083       if (app_paintable)
6084         GTK_OBJECT_FLAGS (widget) |= GTK_APP_PAINTABLE;
6085       else
6086         GTK_OBJECT_FLAGS (widget) &= ~(GTK_APP_PAINTABLE);
6087
6088       if (gtk_widget_is_drawable (widget))
6089         gtk_widget_queue_draw (widget);
6090
6091       g_object_notify (G_OBJECT (widget), "app-paintable");
6092     }
6093 }
6094
6095 /**
6096  * gtk_widget_get_app_paintable:
6097  * @widget: a #GtkWidget
6098  *
6099  * Determines whether the application intends to draw on the widget in
6100  * an #GtkWidget::expose-event handler.
6101  *
6102  * See gtk_widget_set_app_paintable()
6103  *
6104  * Return value: %TRUE if the widget is app paintable
6105  *
6106  * Since: 2.18
6107  **/
6108 gboolean
6109 gtk_widget_get_app_paintable (GtkWidget *widget)
6110 {
6111   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6112
6113   return (GTK_OBJECT_FLAGS (widget) & GTK_APP_PAINTABLE) != 0;
6114 }
6115
6116 /**
6117  * gtk_widget_set_double_buffered:
6118  * @widget: a #GtkWidget
6119  * @double_buffered: %TRUE to double-buffer a widget
6120  *
6121  * Widgets are double buffered by default; you can use this function
6122  * to turn off the buffering. "Double buffered" simply means that
6123  * gdk_window_begin_paint_region() and gdk_window_end_paint() are called
6124  * automatically around expose events sent to the
6125  * widget. gdk_window_begin_paint() diverts all drawing to a widget's
6126  * window to an offscreen buffer, and gdk_window_end_paint() draws the
6127  * buffer to the screen. The result is that users see the window
6128  * update in one smooth step, and don't see individual graphics
6129  * primitives being rendered.
6130  *
6131  * In very simple terms, double buffered widgets don't flicker,
6132  * so you would only use this function to turn off double buffering
6133  * if you had special needs and really knew what you were doing.
6134  *
6135  * Note: if you turn off double-buffering, you have to handle
6136  * expose events, since even the clearing to the background color or
6137  * pixmap will not happen automatically (as it is done in
6138  * gdk_window_begin_paint()).
6139  **/
6140 void
6141 gtk_widget_set_double_buffered (GtkWidget *widget,
6142                                 gboolean   double_buffered)
6143 {
6144   g_return_if_fail (GTK_IS_WIDGET (widget));
6145
6146   double_buffered = (double_buffered != FALSE);
6147
6148   if (double_buffered != gtk_widget_get_double_buffered (widget))
6149     {
6150       if (double_buffered)
6151         GTK_OBJECT_FLAGS (widget) |= GTK_DOUBLE_BUFFERED;
6152       else
6153         GTK_OBJECT_FLAGS (widget) &= ~(GTK_DOUBLE_BUFFERED);
6154
6155       g_object_notify (G_OBJECT (widget), "double-buffered");
6156     }
6157 }
6158
6159 /**
6160  * gtk_widget_get_double_buffered:
6161  * @widget: a #GtkWidget
6162  *
6163  * Determines whether the widget is double buffered.
6164  *
6165  * See gtk_widget_set_double_buffered()
6166  *
6167  * Return value: %TRUE if the widget is double buffered
6168  *
6169  * Since: 2.18
6170  **/
6171 gboolean
6172 gtk_widget_get_double_buffered (GtkWidget *widget)
6173 {
6174   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6175
6176   return (GTK_OBJECT_FLAGS (widget) & GTK_DOUBLE_BUFFERED) != 0;
6177 }
6178
6179 /**
6180  * gtk_widget_set_redraw_on_allocate:
6181  * @widget: a #GtkWidget
6182  * @redraw_on_allocate: if %TRUE, the entire widget will be redrawn
6183  *   when it is allocated to a new size. Otherwise, only the
6184  *   new portion of the widget will be redrawn.
6185  *
6186  * Sets whether the entire widget is queued for drawing when its size
6187  * allocation changes. By default, this setting is %TRUE and
6188  * the entire widget is redrawn on every size change. If your widget
6189  * leaves the upper left unchanged when made bigger, turning this
6190  * setting off will improve performance.
6191
6192  * Note that for %NO_WINDOW widgets setting this flag to %FALSE turns
6193  * off all allocation on resizing: the widget will not even redraw if
6194  * its position changes; this is to allow containers that don't draw
6195  * anything to avoid excess invalidations. If you set this flag on a
6196  * %NO_WINDOW widget that <emphasis>does</emphasis> draw on @widget->window,
6197  * you are responsible for invalidating both the old and new allocation
6198  * of the widget when the widget is moved and responsible for invalidating
6199  * regions newly when the widget increases size.
6200  **/
6201 void
6202 gtk_widget_set_redraw_on_allocate (GtkWidget *widget,
6203                                    gboolean   redraw_on_allocate)
6204 {
6205   g_return_if_fail (GTK_IS_WIDGET (widget));
6206
6207   if (redraw_on_allocate)
6208     GTK_PRIVATE_SET_FLAG (widget, GTK_REDRAW_ON_ALLOC);
6209   else
6210     GTK_PRIVATE_UNSET_FLAG (widget, GTK_REDRAW_ON_ALLOC);
6211 }
6212
6213 /**
6214  * gtk_widget_set_sensitive:
6215  * @widget: a #GtkWidget
6216  * @sensitive: %TRUE to make the widget sensitive
6217  *
6218  * Sets the sensitivity of a widget. A widget is sensitive if the user
6219  * can interact with it. Insensitive widgets are "grayed out" and the
6220  * user can't interact with them. Insensitive widgets are known as
6221  * "inactive", "disabled", or "ghosted" in some other toolkits.
6222  **/
6223 void
6224 gtk_widget_set_sensitive (GtkWidget *widget,
6225                           gboolean   sensitive)
6226 {
6227   GtkStateData data;
6228
6229   g_return_if_fail (GTK_IS_WIDGET (widget));
6230
6231   sensitive = (sensitive != FALSE);
6232
6233   if (sensitive == (gtk_widget_get_sensitive (widget) != FALSE))
6234     return;
6235
6236   if (sensitive)
6237     {
6238       GTK_OBJECT_FLAGS (widget) |= GTK_SENSITIVE;
6239       data.state = widget->saved_state;
6240     }
6241   else
6242     {
6243       GTK_OBJECT_FLAGS (widget) &= ~(GTK_SENSITIVE);
6244       data.state = gtk_widget_get_state (widget);
6245     }
6246   data.state_restoration = TRUE;
6247   data.use_forall = TRUE;
6248
6249   if (widget->parent)
6250     data.parent_sensitive = (gtk_widget_is_sensitive (widget->parent) != FALSE);
6251   else
6252     data.parent_sensitive = TRUE;
6253
6254   gtk_widget_propagate_state (widget, &data);
6255   if (gtk_widget_is_drawable (widget))
6256     gtk_widget_queue_draw (widget);
6257
6258   g_object_notify (G_OBJECT (widget), "sensitive");
6259 }
6260
6261 /**
6262  * gtk_widget_get_sensitive:
6263  * @widget: a #GtkWidget
6264  *
6265  * Returns the widget's sensitivity (in the sense of returning
6266  * the value that has been set using gtk_widget_set_sensitive()).
6267  *
6268  * The effective sensitivity of a widget is however determined by both its
6269  * own and its parent widget's sensitivity. See gtk_widget_is_sensitive().
6270  *
6271  * Returns: %TRUE if the widget is sensitive
6272  *
6273  * Since: 2.18
6274  */
6275 gboolean
6276 gtk_widget_get_sensitive (GtkWidget *widget)
6277 {
6278   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6279
6280   return (GTK_OBJECT_FLAGS (widget) & GTK_SENSITIVE) != 0;
6281 }
6282
6283 /**
6284  * gtk_widget_is_sensitive:
6285  * @widget: a #GtkWidget
6286  *
6287  * Returns the widget's effective sensitivity, which means
6288  * it is sensitive itself and also its parent widget is sensntive
6289  *
6290  * Returns: %TRUE if the widget is effectively sensitive
6291  *
6292  * Since: 2.18
6293  */
6294 gboolean
6295 gtk_widget_is_sensitive (GtkWidget *widget)
6296 {
6297   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6298
6299   return (gtk_widget_get_sensitive (widget) &&
6300           (GTK_OBJECT_FLAGS (widget) & GTK_PARENT_SENSITIVE) != 0);
6301 }
6302
6303 /**
6304  * gtk_widget_set_parent:
6305  * @widget: a #GtkWidget
6306  * @parent: parent container
6307  *
6308  * This function is useful only when implementing subclasses of
6309  * #GtkContainer.
6310  * Sets the container as the parent of @widget, and takes care of
6311  * some details such as updating the state and style of the child
6312  * to reflect its new location. The opposite function is
6313  * gtk_widget_unparent().
6314  **/
6315 void
6316 gtk_widget_set_parent (GtkWidget *widget,
6317                        GtkWidget *parent)
6318 {
6319   GtkStateData data;
6320
6321   g_return_if_fail (GTK_IS_WIDGET (widget));
6322   g_return_if_fail (GTK_IS_WIDGET (parent));
6323   g_return_if_fail (widget != parent);
6324   if (widget->parent != NULL)
6325     {
6326       g_warning ("Can't set a parent on widget which has a parent\n");
6327       return;
6328     }
6329   if (gtk_widget_is_toplevel (widget))
6330     {
6331       g_warning ("Can't set a parent on a toplevel widget\n");
6332       return;
6333     }
6334
6335   /* keep this function in sync with gtk_menu_attach_to_widget()
6336    */
6337
6338   g_object_ref_sink (widget);
6339   widget->parent = parent;
6340
6341   if (gtk_widget_get_state (parent) != GTK_STATE_NORMAL)
6342     data.state = gtk_widget_get_state (parent);
6343   else
6344     data.state = gtk_widget_get_state (widget);
6345   data.state_restoration = FALSE;
6346   data.parent_sensitive = (gtk_widget_is_sensitive (parent) != FALSE);
6347   data.use_forall = gtk_widget_is_sensitive (parent) != gtk_widget_is_sensitive (widget);
6348
6349   gtk_widget_propagate_state (widget, &data);
6350
6351   gtk_widget_reset_rc_styles (widget);
6352
6353   g_signal_emit (widget, widget_signals[PARENT_SET], 0, NULL);
6354   if (GTK_WIDGET_ANCHORED (widget->parent))
6355     _gtk_widget_propagate_hierarchy_changed (widget, NULL);
6356   g_object_notify (G_OBJECT (widget), "parent");
6357
6358   /* Enforce realized/mapped invariants
6359    */
6360   if (gtk_widget_get_realized (widget->parent))
6361     gtk_widget_realize (widget);
6362
6363   if (gtk_widget_get_visible (widget->parent) &&
6364       gtk_widget_get_visible (widget))
6365     {
6366       if (GTK_WIDGET_CHILD_VISIBLE (widget) &&
6367           gtk_widget_get_mapped (widget->parent))
6368         gtk_widget_map (widget);
6369
6370       gtk_widget_queue_resize (widget);
6371     }
6372 }
6373
6374 /**
6375  * gtk_widget_get_parent:
6376  * @widget: a #GtkWidget
6377  *
6378  * Returns the parent container of @widget.
6379  *
6380  * Return value: (transfer none): the parent container of @widget, or %NULL
6381  **/
6382 GtkWidget *
6383 gtk_widget_get_parent (GtkWidget *widget)
6384 {
6385   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6386
6387   return widget->parent;
6388 }
6389
6390 /*****************************************
6391  * Widget styles
6392  * see docs/styles.txt
6393  *****************************************/
6394
6395 /**
6396  * gtk_widget_style_attach:
6397  * @widget: a #GtkWidget
6398  *
6399  * This function attaches the widget's #GtkStyle to the widget's
6400  * #GdkWindow. It is a replacement for
6401  *
6402  * <programlisting>
6403  * widget->style = gtk_style_attach (widget->style, widget->window);
6404  * </programlisting>
6405  *
6406  * and should only ever be called in a derived widget's "realize"
6407  * implementation which does not chain up to its parent class'
6408  * "realize" implementation, because one of the parent classes
6409  * (finally #GtkWidget) would attach the style itself.
6410  *
6411  * Since: 2.20
6412  **/
6413 void
6414 gtk_widget_style_attach (GtkWidget *widget)
6415 {
6416   g_return_if_fail (GTK_IS_WIDGET (widget));
6417   g_return_if_fail (gtk_widget_get_realized (widget));
6418
6419   widget->style = gtk_style_attach (widget->style, widget->window);
6420 }
6421
6422 /**
6423  * gtk_widget_has_rc_style:
6424  * @widget: a #GtkWidget
6425  *
6426  * Determines if the widget style has been looked up through the rc mechanism.
6427  *
6428  * Returns: %TRUE if the widget has been looked up through the rc
6429  *   mechanism, %FALSE otherwise.
6430  *
6431  * Since: 2.20
6432  **/
6433 gboolean
6434 gtk_widget_has_rc_style (GtkWidget *widget)
6435 {
6436   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6437
6438   return (GTK_OBJECT_FLAGS (widget) & GTK_RC_STYLE) != 0;
6439 }
6440
6441 /**
6442  * gtk_widget_set_style:
6443  * @widget: a #GtkWidget
6444  * @style: (allow-none): a #GtkStyle, or %NULL to remove the effect of a previous
6445  *         gtk_widget_set_style() and go back to the default style
6446  *
6447  * Sets the #GtkStyle for a widget (@widget->style). You probably don't
6448  * want to use this function; it interacts badly with themes, because
6449  * themes work by replacing the #GtkStyle. Instead, use
6450  * gtk_widget_modify_style().
6451  **/
6452 void
6453 gtk_widget_set_style (GtkWidget *widget,
6454                       GtkStyle  *style)
6455 {
6456   g_return_if_fail (GTK_IS_WIDGET (widget));
6457
6458   if (style)
6459     {
6460       gboolean initial_emission;
6461
6462       initial_emission = !gtk_widget_has_rc_style (widget) && !GTK_WIDGET_USER_STYLE (widget);
6463
6464       GTK_OBJECT_FLAGS (widget) &= ~(GTK_RC_STYLE);
6465       GTK_PRIVATE_SET_FLAG (widget, GTK_USER_STYLE);
6466
6467       gtk_widget_set_style_internal (widget, style, initial_emission);
6468     }
6469   else
6470     {
6471       if (GTK_WIDGET_USER_STYLE (widget))
6472         gtk_widget_reset_rc_style (widget);
6473     }
6474 }
6475
6476 /**
6477  * gtk_widget_ensure_style:
6478  * @widget: a #GtkWidget
6479  *
6480  * Ensures that @widget has a style (@widget->style). Not a very useful
6481  * function; most of the time, if you want the style, the widget is
6482  * realized, and realized widgets are guaranteed to have a style
6483  * already.
6484  **/
6485 void
6486 gtk_widget_ensure_style (GtkWidget *widget)
6487 {
6488   g_return_if_fail (GTK_IS_WIDGET (widget));
6489
6490   if (!GTK_WIDGET_USER_STYLE (widget) &&
6491       !gtk_widget_has_rc_style (widget))
6492     gtk_widget_reset_rc_style (widget);
6493 }
6494
6495 /* Look up the RC style for this widget, unsetting any user style that
6496  * may be in effect currently
6497  **/
6498 static void
6499 gtk_widget_reset_rc_style (GtkWidget *widget)
6500 {
6501   GtkStyle *new_style = NULL;
6502   gboolean initial_emission;
6503
6504   initial_emission = !gtk_widget_has_rc_style (widget) && !GTK_WIDGET_USER_STYLE (widget);
6505
6506   GTK_PRIVATE_UNSET_FLAG (widget, GTK_USER_STYLE);
6507   GTK_OBJECT_FLAGS (widget) |= GTK_RC_STYLE;
6508
6509   if (gtk_widget_has_screen (widget))
6510     new_style = gtk_rc_get_style (widget);
6511   if (!new_style)
6512     new_style = gtk_widget_get_default_style ();
6513
6514   if (initial_emission || new_style != widget->style)
6515     gtk_widget_set_style_internal (widget, new_style, initial_emission);
6516 }
6517
6518 /**
6519  * gtk_widget_get_style:
6520  * @widget: a #GtkWidget
6521  *
6522  * Simply an accessor function that returns @widget->style.
6523  *
6524  * Return value: (transfer none): the widget's #GtkStyle
6525  **/
6526 GtkStyle*
6527 gtk_widget_get_style (GtkWidget *widget)
6528 {
6529   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6530
6531   return widget->style;
6532 }
6533
6534 /**
6535  * gtk_widget_modify_style:
6536  * @widget: a #GtkWidget
6537  * @style: the #GtkRcStyle holding the style modifications
6538  *
6539  * Modifies style values on the widget. Modifications made using this
6540  * technique take precedence over style values set via an RC file,
6541  * however, they will be overriden if a style is explicitely set on
6542  * the widget using gtk_widget_set_style(). The #GtkRcStyle structure
6543  * is designed so each field can either be set or unset, so it is
6544  * possible, using this function, to modify some style values and
6545  * leave the others unchanged.
6546  *
6547  * Note that modifications made with this function are not cumulative
6548  * with previous calls to gtk_widget_modify_style() or with such
6549  * functions as gtk_widget_modify_fg(). If you wish to retain
6550  * previous values, you must first call gtk_widget_get_modifier_style(),
6551  * make your modifications to the returned style, then call
6552  * gtk_widget_modify_style() with that style. On the other hand,
6553  * if you first call gtk_widget_modify_style(), subsequent calls
6554  * to such functions gtk_widget_modify_fg() will have a cumulative
6555  * effect with the initial modifications.
6556  **/
6557 void
6558 gtk_widget_modify_style (GtkWidget      *widget,
6559                          GtkRcStyle     *style)
6560 {
6561   g_return_if_fail (GTK_IS_WIDGET (widget));
6562   g_return_if_fail (GTK_IS_RC_STYLE (style));
6563
6564   g_object_set_qdata_full (G_OBJECT (widget),
6565                            quark_rc_style,
6566                            gtk_rc_style_copy (style),
6567                            (GDestroyNotify) g_object_unref);
6568
6569   /* note that "style" may be invalid here if it was the old
6570    * modifier style and the only reference was our own.
6571    */
6572
6573   if (gtk_widget_has_rc_style (widget))
6574     gtk_widget_reset_rc_style (widget);
6575 }
6576
6577 /**
6578  * gtk_widget_get_modifier_style:
6579  * @widget: a #GtkWidget
6580  *
6581  * Returns the current modifier style for the widget. (As set by
6582  * gtk_widget_modify_style().) If no style has previously set, a new
6583  * #GtkRcStyle will be created with all values unset, and set as the
6584  * modifier style for the widget. If you make changes to this rc
6585  * style, you must call gtk_widget_modify_style(), passing in the
6586  * returned rc style, to make sure that your changes take effect.
6587  *
6588  * Caution: passing the style back to gtk_widget_modify_style() will
6589  * normally end up destroying it, because gtk_widget_modify_style() copies
6590  * the passed-in style and sets the copy as the new modifier style,
6591  * thus dropping any reference to the old modifier style. Add a reference
6592  * to the modifier style if you want to keep it alive.
6593  *
6594  * Return value: (transfer none): the modifier style for the widget. This rc style is
6595  *   owned by the widget. If you want to keep a pointer to value this
6596  *   around, you must add a refcount using g_object_ref().
6597  **/
6598 GtkRcStyle *
6599 gtk_widget_get_modifier_style (GtkWidget      *widget)
6600 {
6601   GtkRcStyle *rc_style;
6602
6603   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6604
6605   rc_style = g_object_get_qdata (G_OBJECT (widget), quark_rc_style);
6606
6607   if (!rc_style)
6608     {
6609       rc_style = gtk_rc_style_new ();
6610       g_object_set_qdata_full (G_OBJECT (widget),
6611                                quark_rc_style,
6612                                rc_style,
6613                                (GDestroyNotify) g_object_unref);
6614     }
6615
6616   return rc_style;
6617 }
6618
6619 static void
6620 gtk_widget_modify_color_component (GtkWidget      *widget,
6621                                    GtkRcFlags      component,
6622                                    GtkStateType    state,
6623                                    const GdkColor *color)
6624 {
6625   GtkRcStyle *rc_style = gtk_widget_get_modifier_style (widget);
6626
6627   if (color)
6628     {
6629       switch (component)
6630         {
6631         case GTK_RC_FG:
6632           rc_style->fg[state] = *color;
6633           break;
6634         case GTK_RC_BG:
6635           rc_style->bg[state] = *color;
6636           break;
6637         case GTK_RC_TEXT:
6638           rc_style->text[state] = *color;
6639           break;
6640         case GTK_RC_BASE:
6641           rc_style->base[state] = *color;
6642           break;
6643         default:
6644           g_assert_not_reached();
6645         }
6646
6647       rc_style->color_flags[state] |= component;
6648     }
6649   else
6650     rc_style->color_flags[state] &= ~component;
6651
6652   gtk_widget_modify_style (widget, rc_style);
6653 }
6654
6655 /**
6656  * gtk_widget_modify_fg:
6657  * @widget: a #GtkWidget
6658  * @state: the state for which to set the foreground color
6659  * @color: (allow-none): the color to assign (does not need to be allocated),
6660  *         or %NULL to undo the effect of previous calls to
6661  *         of gtk_widget_modify_fg().
6662  *
6663  * Sets the foreground color for a widget in a particular state.
6664  * All other style values are left untouched. See also
6665  * gtk_widget_modify_style().
6666  **/
6667 void
6668 gtk_widget_modify_fg (GtkWidget      *widget,
6669                       GtkStateType    state,
6670                       const GdkColor *color)
6671 {
6672   g_return_if_fail (GTK_IS_WIDGET (widget));
6673   g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
6674
6675   gtk_widget_modify_color_component (widget, GTK_RC_FG, state, color);
6676 }
6677
6678 /**
6679  * gtk_widget_modify_bg:
6680  * @widget: a #GtkWidget
6681  * @state: the state for which to set the background color
6682  * @color: (allow-none): the color to assign (does not need to be allocated),
6683  *         or %NULL to undo the effect of previous calls to
6684  *         of gtk_widget_modify_bg().
6685  *
6686  * Sets the background color for a widget in a particular state.
6687  * All other style values are left untouched. See also
6688  * gtk_widget_modify_style().
6689  *
6690  * Note that "no window" widgets (which have the %GTK_NO_WINDOW flag set)
6691  * draw on their parent container's window and thus may not draw any
6692  * background themselves. This is the case for e.g. #GtkLabel. To modify
6693  * the background of such widgets, you have to set the background color
6694  * on their parent; if you want to set the background of a rectangular
6695  * area around a label, try placing the label in a #GtkEventBox widget
6696  * and setting the background color on that.
6697  **/
6698 void
6699 gtk_widget_modify_bg (GtkWidget      *widget,
6700                       GtkStateType    state,
6701                       const GdkColor *color)
6702 {
6703   g_return_if_fail (GTK_IS_WIDGET (widget));
6704   g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
6705
6706   gtk_widget_modify_color_component (widget, GTK_RC_BG, state, color);
6707 }
6708
6709 /**
6710  * gtk_widget_modify_text:
6711  * @widget: a #GtkWidget
6712  * @state: the state for which to set the text color
6713  * @color: (allow-none): the color to assign (does not need to be allocated),
6714  *         or %NULL to undo the effect of previous calls to
6715  *         of gtk_widget_modify_text().
6716  *
6717  * Sets the text color for a widget in a particular state.  All other
6718  * style values are left untouched. The text color is the foreground
6719  * color used along with the base color (see gtk_widget_modify_base())
6720  * for widgets such as #GtkEntry and #GtkTextView. See also
6721  * gtk_widget_modify_style().
6722  **/
6723 void
6724 gtk_widget_modify_text (GtkWidget      *widget,
6725                         GtkStateType    state,
6726                         const GdkColor *color)
6727 {
6728   g_return_if_fail (GTK_IS_WIDGET (widget));
6729   g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
6730
6731   gtk_widget_modify_color_component (widget, GTK_RC_TEXT, state, color);
6732 }
6733
6734 /**
6735  * gtk_widget_modify_base:
6736  * @widget: a #GtkWidget
6737  * @state: the state for which to set the base color
6738  * @color: (allow-none): the color to assign (does not need to be allocated),
6739  *         or %NULL to undo the effect of previous calls to
6740  *         of gtk_widget_modify_base().
6741  *
6742  * Sets the base color for a widget in a particular state.
6743  * All other style values are left untouched. The base color
6744  * is the background color used along with the text color
6745  * (see gtk_widget_modify_text()) for widgets such as #GtkEntry
6746  * and #GtkTextView. See also gtk_widget_modify_style().
6747  *
6748  * Note that "no window" widgets (which have the %GTK_NO_WINDOW flag set)
6749  * draw on their parent container's window and thus may not draw any
6750  * background themselves. This is the case for e.g. #GtkLabel. To modify
6751  * the background of such widgets, you have to set the base color on their
6752  * parent; if you want to set the background of a rectangular area around
6753  * a label, try placing the label in a #GtkEventBox widget and setting
6754  * the base color on that.
6755  **/
6756 void
6757 gtk_widget_modify_base (GtkWidget      *widget,
6758                         GtkStateType    state,
6759                         const GdkColor *color)
6760 {
6761   g_return_if_fail (GTK_IS_WIDGET (widget));
6762   g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
6763
6764   gtk_widget_modify_color_component (widget, GTK_RC_BASE, state, color);
6765 }
6766
6767 static void
6768 modify_color_property (GtkWidget      *widget,
6769                        GtkRcStyle     *rc_style,
6770                        const char     *name,
6771                        const GdkColor *color)
6772 {
6773   GQuark type_name = g_type_qname (G_OBJECT_TYPE (widget));
6774   GQuark property_name = g_quark_from_string (name);
6775
6776   if (color)
6777     {
6778       GtkRcProperty rc_property = {0};
6779       char *color_name;
6780
6781       rc_property.type_name = type_name;
6782       rc_property.property_name = property_name;
6783       rc_property.origin = NULL;
6784
6785       color_name = gdk_color_to_string (color);
6786       g_value_init (&rc_property.value, G_TYPE_STRING);
6787       g_value_take_string (&rc_property.value, color_name);
6788
6789       _gtk_rc_style_set_rc_property (rc_style, &rc_property);
6790
6791       g_value_unset (&rc_property.value);
6792     }
6793   else
6794     _gtk_rc_style_unset_rc_property (rc_style, type_name, property_name);
6795 }
6796
6797 /**
6798  * gtk_widget_modify_cursor:
6799  * @widget: a #GtkWidget
6800  * @primary: the color to use for primary cursor (does not need to be
6801  *           allocated), or %NULL to undo the effect of previous calls to
6802  *           of gtk_widget_modify_cursor().
6803  * @secondary: the color to use for secondary cursor (does not need to be
6804  *             allocated), or %NULL to undo the effect of previous calls to
6805  *             of gtk_widget_modify_cursor().
6806  *
6807  * Sets the cursor color to use in a widget, overriding the
6808  * #GtkWidget:cursor-color and #GtkWidget:secondary-cursor-color
6809  * style properties. All other style values are left untouched.
6810  * See also gtk_widget_modify_style().
6811  *
6812  * Since: 2.12
6813  **/
6814 void
6815 gtk_widget_modify_cursor (GtkWidget      *widget,
6816                           const GdkColor *primary,
6817                           const GdkColor *secondary)
6818 {
6819   GtkRcStyle *rc_style;
6820
6821   g_return_if_fail (GTK_IS_WIDGET (widget));
6822
6823   rc_style = gtk_widget_get_modifier_style (widget);
6824
6825   modify_color_property (widget, rc_style, "cursor-color", primary);
6826   modify_color_property (widget, rc_style, "secondary-cursor-color", secondary);
6827
6828   gtk_widget_modify_style (widget, rc_style);
6829 }
6830
6831 /**
6832  * gtk_widget_modify_font:
6833  * @widget: a #GtkWidget
6834  * @font_desc: (allow-none): the font description to use, or %NULL to undo
6835  *   the effect of previous calls to gtk_widget_modify_font().
6836  *
6837  * Sets the font to use for a widget.  All other style values are left
6838  * untouched. See also gtk_widget_modify_style().
6839  **/
6840 void
6841 gtk_widget_modify_font (GtkWidget            *widget,
6842                         PangoFontDescription *font_desc)
6843 {
6844   GtkRcStyle *rc_style;
6845
6846   g_return_if_fail (GTK_IS_WIDGET (widget));
6847
6848   rc_style = gtk_widget_get_modifier_style (widget);
6849
6850   if (rc_style->font_desc)
6851     pango_font_description_free (rc_style->font_desc);
6852
6853   if (font_desc)
6854     rc_style->font_desc = pango_font_description_copy (font_desc);
6855   else
6856     rc_style->font_desc = NULL;
6857
6858   gtk_widget_modify_style (widget, rc_style);
6859 }
6860
6861 static void
6862 gtk_widget_real_direction_changed (GtkWidget        *widget,
6863                                    GtkTextDirection  previous_direction)
6864 {
6865   gtk_widget_queue_resize (widget);
6866 }
6867
6868 static void
6869 gtk_widget_real_style_set (GtkWidget *widget,
6870                            GtkStyle  *previous_style)
6871 {
6872   if (gtk_widget_get_realized (widget) &&
6873       gtk_widget_get_has_window (widget))
6874     gtk_style_set_background (widget->style, widget->window, widget->state);
6875 }
6876
6877 static void
6878 gtk_widget_set_style_internal (GtkWidget *widget,
6879                                GtkStyle  *style,
6880                                gboolean   initial_emission)
6881 {
6882   g_object_ref (widget);
6883   g_object_freeze_notify (G_OBJECT (widget));
6884
6885   if (widget->style != style)
6886     {
6887       GtkStyle *previous_style;
6888
6889       if (gtk_widget_get_realized (widget))
6890         {
6891           gtk_widget_reset_shapes (widget);
6892           gtk_style_detach (widget->style);
6893         }
6894
6895       previous_style = widget->style;
6896       widget->style = style;
6897       g_object_ref (widget->style);
6898
6899       if (gtk_widget_get_realized (widget))
6900         widget->style = gtk_style_attach (widget->style, widget->window);
6901
6902       gtk_widget_update_pango_context (widget);
6903       g_signal_emit (widget,
6904                      widget_signals[STYLE_SET],
6905                      0,
6906                      initial_emission ? NULL : previous_style);
6907       g_object_unref (previous_style);
6908
6909       if (GTK_WIDGET_ANCHORED (widget) && !initial_emission)
6910         gtk_widget_queue_resize (widget);
6911     }
6912   else if (initial_emission)
6913     {
6914       gtk_widget_update_pango_context (widget);
6915       g_signal_emit (widget,
6916                      widget_signals[STYLE_SET],
6917                      0,
6918                      NULL);
6919     }
6920   g_object_notify (G_OBJECT (widget), "style");
6921   g_object_thaw_notify (G_OBJECT (widget));
6922   g_object_unref (widget);
6923 }
6924
6925 typedef struct {
6926   GtkWidget *previous_toplevel;
6927   GdkScreen *previous_screen;
6928   GdkScreen *new_screen;
6929 } HierarchyChangedInfo;
6930
6931 static void
6932 do_screen_change (GtkWidget *widget,
6933                   GdkScreen *old_screen,
6934                   GdkScreen *new_screen)
6935 {
6936   if (old_screen != new_screen)
6937     {
6938       if (old_screen)
6939         {
6940           PangoContext *context = g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
6941           if (context)
6942             g_object_set_qdata (G_OBJECT (widget), quark_pango_context, NULL);
6943         }
6944
6945       _gtk_tooltip_hide (widget);
6946       g_signal_emit (widget, widget_signals[SCREEN_CHANGED], 0, old_screen);
6947     }
6948 }
6949
6950 static void
6951 gtk_widget_propagate_hierarchy_changed_recurse (GtkWidget *widget,
6952                                                 gpointer   client_data)
6953 {
6954   HierarchyChangedInfo *info = client_data;
6955   gboolean new_anchored = gtk_widget_is_toplevel (widget) ||
6956                  (widget->parent && GTK_WIDGET_ANCHORED (widget->parent));
6957
6958   if (GTK_WIDGET_ANCHORED (widget) != new_anchored)
6959     {
6960       g_object_ref (widget);
6961
6962       if (new_anchored)
6963         GTK_PRIVATE_SET_FLAG (widget, GTK_ANCHORED);
6964       else
6965         GTK_PRIVATE_UNSET_FLAG (widget, GTK_ANCHORED);
6966
6967       g_signal_emit (widget, widget_signals[HIERARCHY_CHANGED], 0, info->previous_toplevel);
6968       do_screen_change (widget, info->previous_screen, info->new_screen);
6969
6970       if (GTK_IS_CONTAINER (widget))
6971         gtk_container_forall (GTK_CONTAINER (widget),
6972                               gtk_widget_propagate_hierarchy_changed_recurse,
6973                               client_data);
6974
6975       g_object_unref (widget);
6976     }
6977 }
6978
6979 /**
6980  * _gtk_widget_propagate_hierarchy_changed:
6981  * @widget: a #GtkWidget
6982  * @previous_toplevel: Previous toplevel
6983  *
6984  * Propagates changes in the anchored state to a widget and all
6985  * children, unsetting or setting the %ANCHORED flag, and
6986  * emitting #GtkWidget::hierarchy-changed.
6987  **/
6988 void
6989 _gtk_widget_propagate_hierarchy_changed (GtkWidget    *widget,
6990                                          GtkWidget    *previous_toplevel)
6991 {
6992   HierarchyChangedInfo info;
6993
6994   info.previous_toplevel = previous_toplevel;
6995   info.previous_screen = previous_toplevel ? gtk_widget_get_screen (previous_toplevel) : NULL;
6996
6997   if (gtk_widget_is_toplevel (widget) ||
6998       (widget->parent && GTK_WIDGET_ANCHORED (widget->parent)))
6999     info.new_screen = gtk_widget_get_screen (widget);
7000   else
7001     info.new_screen = NULL;
7002
7003   if (info.previous_screen)
7004     g_object_ref (info.previous_screen);
7005   if (previous_toplevel)
7006     g_object_ref (previous_toplevel);
7007
7008   gtk_widget_propagate_hierarchy_changed_recurse (widget, &info);
7009
7010   if (previous_toplevel)
7011     g_object_unref (previous_toplevel);
7012   if (info.previous_screen)
7013     g_object_unref (info.previous_screen);
7014 }
7015
7016 static void
7017 gtk_widget_propagate_screen_changed_recurse (GtkWidget *widget,
7018                                              gpointer   client_data)
7019 {
7020   HierarchyChangedInfo *info = client_data;
7021
7022   g_object_ref (widget);
7023
7024   do_screen_change (widget, info->previous_screen, info->new_screen);
7025
7026   if (GTK_IS_CONTAINER (widget))
7027     gtk_container_forall (GTK_CONTAINER (widget),
7028                           gtk_widget_propagate_screen_changed_recurse,
7029                           client_data);
7030
7031   g_object_unref (widget);
7032 }
7033
7034 /**
7035  * gtk_widget_is_composited:
7036  * @widget: a #GtkWidget
7037  *
7038  * Whether @widget can rely on having its alpha channel
7039  * drawn correctly. On X11 this function returns whether a
7040  * compositing manager is running for @widget's screen.
7041  *
7042  * Please note that the semantics of this call will change
7043  * in the future if used on a widget that has a composited
7044  * window in its hierarchy (as set by gdk_window_set_composited()).
7045  *
7046  * Return value: %TRUE if the widget can rely on its alpha
7047  * channel being drawn correctly.
7048  *
7049  * Since: 2.10
7050  */
7051 gboolean
7052 gtk_widget_is_composited (GtkWidget *widget)
7053 {
7054   GdkScreen *screen;
7055
7056   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7057
7058   screen = gtk_widget_get_screen (widget);
7059
7060   return gdk_screen_is_composited (screen);
7061 }
7062
7063 static void
7064 propagate_composited_changed (GtkWidget *widget,
7065                               gpointer dummy)
7066 {
7067   if (GTK_IS_CONTAINER (widget))
7068     {
7069       gtk_container_forall (GTK_CONTAINER (widget),
7070                             propagate_composited_changed,
7071                             NULL);
7072     }
7073
7074   g_signal_emit (widget, widget_signals[COMPOSITED_CHANGED], 0);
7075 }
7076
7077 void
7078 _gtk_widget_propagate_composited_changed (GtkWidget *widget)
7079 {
7080   propagate_composited_changed (widget, NULL);
7081 }
7082
7083 /**
7084  * _gtk_widget_propagate_screen_changed:
7085  * @widget: a #GtkWidget
7086  * @previous_screen: Previous screen
7087  *
7088  * Propagates changes in the screen for a widget to all
7089  * children, emitting #GtkWidget::screen-changed.
7090  **/
7091 void
7092 _gtk_widget_propagate_screen_changed (GtkWidget    *widget,
7093                                       GdkScreen    *previous_screen)
7094 {
7095   HierarchyChangedInfo info;
7096
7097   info.previous_screen = previous_screen;
7098   info.new_screen = gtk_widget_get_screen (widget);
7099
7100   if (previous_screen)
7101     g_object_ref (previous_screen);
7102
7103   gtk_widget_propagate_screen_changed_recurse (widget, &info);
7104
7105   if (previous_screen)
7106     g_object_unref (previous_screen);
7107 }
7108
7109 static void
7110 reset_rc_styles_recurse (GtkWidget *widget, gpointer data)
7111 {
7112   if (gtk_widget_has_rc_style (widget))
7113     gtk_widget_reset_rc_style (widget);
7114
7115   if (GTK_IS_CONTAINER (widget))
7116     gtk_container_forall (GTK_CONTAINER (widget),
7117                           reset_rc_styles_recurse,
7118                           NULL);
7119 }
7120
7121
7122 /**
7123  * gtk_widget_reset_rc_styles:
7124  * @widget: a #GtkWidget.
7125  *
7126  * Reset the styles of @widget and all descendents, so when
7127  * they are looked up again, they get the correct values
7128  * for the currently loaded RC file settings.
7129  *
7130  * This function is not useful for applications.
7131  */
7132 void
7133 gtk_widget_reset_rc_styles (GtkWidget *widget)
7134 {
7135   g_return_if_fail (GTK_IS_WIDGET (widget));
7136
7137   reset_rc_styles_recurse (widget, NULL);
7138 }
7139
7140 /**
7141  * gtk_widget_get_default_style:
7142  *
7143  * Returns the default style used by all widgets initially.
7144  *
7145  * Returns: (transfer none): the default style. This #GtkStyle object is owned
7146  *          by GTK+ and should not be modified or freed.
7147  */
7148 GtkStyle*
7149 gtk_widget_get_default_style (void)
7150 {
7151   if (!gtk_default_style)
7152     {
7153       gtk_default_style = gtk_style_new ();
7154       g_object_ref (gtk_default_style);
7155     }
7156
7157   return gtk_default_style;
7158 }
7159
7160 static PangoContext *
7161 gtk_widget_peek_pango_context (GtkWidget *widget)
7162 {
7163   return g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
7164 }
7165
7166 /**
7167  * gtk_widget_get_pango_context:
7168  * @widget: a #GtkWidget
7169  *
7170  * Gets a #PangoContext with the appropriate font map, font description,
7171  * and base direction for this widget. Unlike the context returned
7172  * by gtk_widget_create_pango_context(), this context is owned by
7173  * the widget (it can be used until the screen for the widget changes
7174  * or the widget is removed from its toplevel), and will be updated to
7175  * match any changes to the widget's attributes.
7176  *
7177  * If you create and keep a #PangoLayout using this context, you must
7178  * deal with changes to the context by calling pango_layout_context_changed()
7179  * on the layout in response to the #GtkWidget::style-set and
7180  * #GtkWidget::direction-changed signals for the widget.
7181  *
7182  * Return value: (transfer none): the #PangoContext for the widget.
7183  **/
7184 PangoContext *
7185 gtk_widget_get_pango_context (GtkWidget *widget)
7186 {
7187   PangoContext *context;
7188
7189   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7190
7191   context = g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
7192   if (!context)
7193     {
7194       context = gtk_widget_create_pango_context (GTK_WIDGET (widget));
7195       g_object_set_qdata_full (G_OBJECT (widget),
7196                                quark_pango_context,
7197                                context,
7198                                g_object_unref);
7199     }
7200
7201   return context;
7202 }
7203
7204 static void
7205 update_pango_context (GtkWidget    *widget,
7206                       PangoContext *context)
7207 {
7208   pango_context_set_font_description (context, widget->style->font_desc);
7209   pango_context_set_base_dir (context,
7210                               gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR ?
7211                               PANGO_DIRECTION_LTR : PANGO_DIRECTION_RTL);
7212 }
7213
7214 static void
7215 gtk_widget_update_pango_context (GtkWidget *widget)
7216 {
7217   PangoContext *context = gtk_widget_peek_pango_context (widget);
7218
7219   if (context)
7220     {
7221       GdkScreen *screen;
7222
7223       update_pango_context (widget, context);
7224
7225       screen = gtk_widget_get_screen_unchecked (widget);
7226       if (screen)
7227         {
7228           pango_cairo_context_set_resolution (context,
7229                                               gdk_screen_get_resolution (screen));
7230           pango_cairo_context_set_font_options (context,
7231                                                 gdk_screen_get_font_options (screen));
7232         }
7233     }
7234 }
7235
7236 /**
7237  * gtk_widget_create_pango_context:
7238  * @widget: a #GtkWidget
7239  *
7240  * Creates a new #PangoContext with the appropriate font map,
7241  * font description, and base direction for drawing text for
7242  * this widget. See also gtk_widget_get_pango_context().
7243  *
7244  * Return value: the new #PangoContext
7245  **/
7246 PangoContext *
7247 gtk_widget_create_pango_context (GtkWidget *widget)
7248 {
7249   GdkScreen *screen;
7250   PangoContext *context;
7251
7252   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7253
7254   screen = gtk_widget_get_screen_unchecked (widget);
7255   if (!screen)
7256     {
7257       GTK_NOTE (MULTIHEAD,
7258                 g_warning ("gtk_widget_create_pango_context ()) called without screen"));
7259
7260       screen = gdk_screen_get_default ();
7261     }
7262
7263   context = gdk_pango_context_get_for_screen (screen);
7264
7265   update_pango_context (widget, context);
7266   pango_context_set_language (context, gtk_get_default_language ());
7267
7268   return context;
7269 }
7270
7271 /**
7272  * gtk_widget_create_pango_layout:
7273  * @widget: a #GtkWidget
7274  * @text: text to set on the layout (can be %NULL)
7275  *
7276  * Creates a new #PangoLayout with the appropriate font map,
7277  * font description, and base direction for drawing text for
7278  * this widget.
7279  *
7280  * If you keep a #PangoLayout created in this way around, in order to
7281  * notify the layout of changes to the base direction or font of this
7282  * widget, you must call pango_layout_context_changed() in response to
7283  * the #GtkWidget::style-set and #GtkWidget::direction-changed signals
7284  * for the widget.
7285  *
7286  * Return value: the new #PangoLayout
7287  **/
7288 PangoLayout *
7289 gtk_widget_create_pango_layout (GtkWidget   *widget,
7290                                 const gchar *text)
7291 {
7292   PangoLayout *layout;
7293   PangoContext *context;
7294
7295   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7296
7297   context = gtk_widget_get_pango_context (widget);
7298   layout = pango_layout_new (context);
7299
7300   if (text)
7301     pango_layout_set_text (layout, text, -1);
7302
7303   return layout;
7304 }
7305
7306 /**
7307  * gtk_widget_render_icon:
7308  * @widget: a #GtkWidget
7309  * @stock_id: a stock ID
7310  * @size: (type int) a stock size. A size of (GtkIconSize)-1 means
7311  *     render at the size of the source and don't scale (if there are
7312  *     multiple source sizes, GTK+ picks one of the available sizes).
7313  * @detail: (allow-none): render detail to pass to theme engine
7314  *
7315  * A convenience function that uses the theme engine and RC file
7316  * settings for @widget to look up @stock_id and render it to
7317  * a pixbuf. @stock_id should be a stock icon ID such as
7318  * #GTK_STOCK_OPEN or #GTK_STOCK_OK. @size should be a size
7319  * such as #GTK_ICON_SIZE_MENU. @detail should be a string that
7320  * identifies the widget or code doing the rendering, so that
7321  * theme engines can special-case rendering for that widget or code.
7322  *
7323  * The pixels in the returned #GdkPixbuf are shared with the rest of
7324  * the application and should not be modified. The pixbuf should be freed
7325  * after use with g_object_unref().
7326  *
7327  * Return value: a new pixbuf, or %NULL if the stock ID wasn't known
7328  **/
7329 GdkPixbuf*
7330 gtk_widget_render_icon (GtkWidget      *widget,
7331                         const gchar    *stock_id,
7332                         GtkIconSize     size,
7333                         const gchar    *detail)
7334 {
7335   GtkIconSet *icon_set;
7336   GdkPixbuf *retval;
7337
7338   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7339   g_return_val_if_fail (stock_id != NULL, NULL);
7340   g_return_val_if_fail (size > GTK_ICON_SIZE_INVALID || size == -1, NULL);
7341
7342   gtk_widget_ensure_style (widget);
7343
7344   icon_set = gtk_style_lookup_icon_set (widget->style, stock_id);
7345
7346   if (icon_set == NULL)
7347     return NULL;
7348
7349   retval = gtk_icon_set_render_icon (icon_set,
7350                                      widget->style,
7351                                      gtk_widget_get_direction (widget),
7352                                      gtk_widget_get_state (widget),
7353                                      size,
7354                                      widget,
7355                                      detail);
7356
7357   return retval;
7358 }
7359
7360 /**
7361  * gtk_widget_set_parent_window:
7362  * @widget: a #GtkWidget.
7363  * @parent_window: the new parent window.
7364  *
7365  * Sets a non default parent window for @widget.
7366  **/
7367 void
7368 gtk_widget_set_parent_window   (GtkWidget           *widget,
7369                                 GdkWindow           *parent_window)
7370 {
7371   GdkWindow *old_parent_window;
7372
7373   g_return_if_fail (GTK_IS_WIDGET (widget));
7374
7375   old_parent_window = g_object_get_qdata (G_OBJECT (widget),
7376                                           quark_parent_window);
7377
7378   if (parent_window != old_parent_window)
7379     {
7380       g_object_set_qdata (G_OBJECT (widget), quark_parent_window,
7381                           parent_window);
7382       if (old_parent_window)
7383         g_object_unref (old_parent_window);
7384       if (parent_window)
7385         g_object_ref (parent_window);
7386     }
7387 }
7388
7389 /**
7390  * gtk_widget_get_parent_window:
7391  * @widget: a #GtkWidget.
7392  *
7393  * Gets @widget's parent window.
7394  *
7395  * Returns: (transfer none): the parent window of @widget.
7396  **/
7397 GdkWindow *
7398 gtk_widget_get_parent_window (GtkWidget *widget)
7399 {
7400   GdkWindow *parent_window;
7401
7402   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7403
7404   parent_window = g_object_get_qdata (G_OBJECT (widget), quark_parent_window);
7405
7406   return (parent_window != NULL) ? parent_window :
7407          (widget->parent != NULL) ? widget->parent->window : NULL;
7408 }
7409
7410
7411 /**
7412  * gtk_widget_set_child_visible:
7413  * @widget: a #GtkWidget
7414  * @is_visible: if %TRUE, @widget should be mapped along with its parent.
7415  *
7416  * Sets whether @widget should be mapped along with its when its parent
7417  * is mapped and @widget has been shown with gtk_widget_show().
7418  *
7419  * The child visibility can be set for widget before it is added to
7420  * a container with gtk_widget_set_parent(), to avoid mapping
7421  * children unnecessary before immediately unmapping them. However
7422  * it will be reset to its default state of %TRUE when the widget
7423  * is removed from a container.
7424  *
7425  * Note that changing the child visibility of a widget does not
7426  * queue a resize on the widget. Most of the time, the size of
7427  * a widget is computed from all visible children, whether or
7428  * not they are mapped. If this is not the case, the container
7429  * can queue a resize itself.
7430  *
7431  * This function is only useful for container implementations and
7432  * never should be called by an application.
7433  **/
7434 void
7435 gtk_widget_set_child_visible (GtkWidget *widget,
7436                               gboolean   is_visible)
7437 {
7438   g_return_if_fail (GTK_IS_WIDGET (widget));
7439   g_return_if_fail (!gtk_widget_is_toplevel (widget));
7440
7441   g_object_ref (widget);
7442
7443   if (is_visible)
7444     GTK_PRIVATE_SET_FLAG (widget, GTK_CHILD_VISIBLE);
7445   else
7446     {
7447       GtkWidget *toplevel;
7448
7449       GTK_PRIVATE_UNSET_FLAG (widget, GTK_CHILD_VISIBLE);
7450
7451       toplevel = gtk_widget_get_toplevel (widget);
7452       if (toplevel != widget && gtk_widget_is_toplevel (toplevel))
7453         _gtk_window_unset_focus_and_default (GTK_WINDOW (toplevel), widget);
7454     }
7455
7456   if (widget->parent && gtk_widget_get_realized (widget->parent))
7457     {
7458       if (gtk_widget_get_mapped (widget->parent) &&
7459           GTK_WIDGET_CHILD_VISIBLE (widget) &&
7460           gtk_widget_get_visible (widget))
7461         gtk_widget_map (widget);
7462       else
7463         gtk_widget_unmap (widget);
7464     }
7465
7466   g_object_unref (widget);
7467 }
7468
7469 /**
7470  * gtk_widget_get_child_visible:
7471  * @widget: a #GtkWidget
7472  *
7473  * Gets the value set with gtk_widget_set_child_visible().
7474  * If you feel a need to use this function, your code probably
7475  * needs reorganization.
7476  *
7477  * This function is only useful for container implementations and
7478  * never should be called by an application.
7479  *
7480  * Return value: %TRUE if the widget is mapped with the parent.
7481  **/
7482 gboolean
7483 gtk_widget_get_child_visible (GtkWidget *widget)
7484 {
7485   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7486
7487   return GTK_WIDGET_CHILD_VISIBLE (widget);
7488 }
7489
7490 static GdkScreen *
7491 gtk_widget_get_screen_unchecked (GtkWidget *widget)
7492 {
7493   GtkWidget *toplevel;
7494
7495   toplevel = gtk_widget_get_toplevel (widget);
7496
7497   if (gtk_widget_is_toplevel (toplevel))
7498     {
7499       if (GTK_IS_WINDOW (toplevel))
7500         return GTK_WINDOW (toplevel)->screen;
7501       else if (GTK_IS_INVISIBLE (toplevel))
7502         return GTK_INVISIBLE (widget)->screen;
7503     }
7504
7505   return NULL;
7506 }
7507
7508 /**
7509  * gtk_widget_get_screen:
7510  * @widget: a #GtkWidget
7511  *
7512  * Get the #GdkScreen from the toplevel window associated with
7513  * this widget. This function can only be called after the widget
7514  * has been added to a widget hierarchy with a #GtkWindow
7515  * at the top.
7516  *
7517  * In general, you should only create screen specific
7518  * resources when a widget has been realized, and you should
7519  * free those resources when the widget is unrealized.
7520  *
7521  * Return value: (transfer none): the #GdkScreen for the toplevel for this widget.
7522  *
7523  * Since: 2.2
7524  **/
7525 GdkScreen*
7526 gtk_widget_get_screen (GtkWidget *widget)
7527 {
7528   GdkScreen *screen;
7529
7530   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7531
7532   screen = gtk_widget_get_screen_unchecked (widget);
7533
7534   if (screen)
7535     return screen;
7536   else
7537     {
7538 #if 0
7539       g_warning (G_STRLOC ": Can't get associated screen"
7540                  " for a widget unless it is inside a toplevel GtkWindow\n"
7541                  " widget type is %s associated top level type is %s",
7542                  g_type_name (G_OBJECT_TYPE(G_OBJECT (widget))),
7543                  g_type_name (G_OBJECT_TYPE(G_OBJECT (toplevel))));
7544 #endif
7545       return gdk_screen_get_default ();
7546     }
7547 }
7548
7549 /**
7550  * gtk_widget_has_screen:
7551  * @widget: a #GtkWidget
7552  *
7553  * Checks whether there is a #GdkScreen is associated with
7554  * this widget. All toplevel widgets have an associated
7555  * screen, and all widgets added into a hierarchy with a toplevel
7556  * window at the top.
7557  *
7558  * Return value: %TRUE if there is a #GdkScreen associcated
7559  *   with the widget.
7560  *
7561  * Since: 2.2
7562  **/
7563 gboolean
7564 gtk_widget_has_screen (GtkWidget *widget)
7565 {
7566   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7567
7568   return (gtk_widget_get_screen_unchecked (widget) != NULL);
7569 }
7570
7571 /**
7572  * gtk_widget_get_display:
7573  * @widget: a #GtkWidget
7574  *
7575  * Get the #GdkDisplay for the toplevel window associated with
7576  * this widget. This function can only be called after the widget
7577  * has been added to a widget hierarchy with a #GtkWindow at the top.
7578  *
7579  * In general, you should only create display specific
7580  * resources when a widget has been realized, and you should
7581  * free those resources when the widget is unrealized.
7582  *
7583  * Return value: (transfer none): the #GdkDisplay for the toplevel for this widget.
7584  *
7585  * Since: 2.2
7586  **/
7587 GdkDisplay*
7588 gtk_widget_get_display (GtkWidget *widget)
7589 {
7590   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7591
7592   return gdk_screen_get_display (gtk_widget_get_screen (widget));
7593 }
7594
7595 /**
7596  * gtk_widget_get_root_window:
7597  * @widget: a #GtkWidget
7598  *
7599  * Get the root window where this widget is located. This function can
7600  * only be called after the widget has been added to a widget
7601  * hierarchy with #GtkWindow at the top.
7602  *
7603  * The root window is useful for such purposes as creating a popup
7604  * #GdkWindow associated with the window. In general, you should only
7605  * create display specific resources when a widget has been realized,
7606  * and you should free those resources when the widget is unrealized.
7607  *
7608  * Return value: (transfer none): the #GdkWindow root window for the toplevel for this widget.
7609  *
7610  * Since: 2.2
7611  **/
7612 GdkWindow*
7613 gtk_widget_get_root_window (GtkWidget *widget)
7614 {
7615   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7616
7617   return gdk_screen_get_root_window (gtk_widget_get_screen (widget));
7618 }
7619
7620 /**
7621  * gtk_widget_child_focus:
7622  * @widget: a #GtkWidget
7623  * @direction: direction of focus movement
7624  *
7625  * This function is used by custom widget implementations; if you're
7626  * writing an app, you'd use gtk_widget_grab_focus() to move the focus
7627  * to a particular widget, and gtk_container_set_focus_chain() to
7628  * change the focus tab order. So you may want to investigate those
7629  * functions instead.
7630  *
7631  * gtk_widget_child_focus() is called by containers as the user moves
7632  * around the window using keyboard shortcuts. @direction indicates
7633  * what kind of motion is taking place (up, down, left, right, tab
7634  * forward, tab backward). gtk_widget_child_focus() emits the
7635  * #GtkWidget::focus signal; widgets override the default handler
7636  * for this signal in order to implement appropriate focus behavior.
7637  *
7638  * The default ::focus handler for a widget should return %TRUE if
7639  * moving in @direction left the focus on a focusable location inside
7640  * that widget, and %FALSE if moving in @direction moved the focus
7641  * outside the widget. If returning %TRUE, widgets normally
7642  * call gtk_widget_grab_focus() to place the focus accordingly;
7643  * if returning %FALSE, they don't modify the current focus location.
7644  *
7645  * This function replaces gtk_container_focus() from GTK+ 1.2.
7646  * It was necessary to check that the child was visible, sensitive,
7647  * and focusable before calling gtk_container_focus().
7648  * gtk_widget_child_focus() returns %FALSE if the widget is not
7649  * currently in a focusable state, so there's no need for those checks.
7650  *
7651  * Return value: %TRUE if focus ended up inside @widget
7652  **/
7653 gboolean
7654 gtk_widget_child_focus (GtkWidget       *widget,
7655                         GtkDirectionType direction)
7656 {
7657   gboolean return_val;
7658
7659   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7660
7661   if (!gtk_widget_get_visible (widget) ||
7662       !gtk_widget_is_sensitive (widget))
7663     return FALSE;
7664
7665   /* child widgets must set CAN_FOCUS, containers
7666    * don't have to though.
7667    */
7668   if (!GTK_IS_CONTAINER (widget) &&
7669       !gtk_widget_get_can_focus (widget))
7670     return FALSE;
7671
7672   g_signal_emit (widget,
7673                  widget_signals[FOCUS],
7674                  0,
7675                  direction, &return_val);
7676
7677   return return_val;
7678 }
7679
7680 /**
7681  * gtk_widget_keynav_failed:
7682  * @widget: a #GtkWidget
7683  * @direction: direction of focus movement
7684  *
7685  * This function should be called whenever keyboard navigation within
7686  * a single widget hits a boundary. The function emits the
7687  * #GtkWidget::keynav-failed signal on the widget and its return
7688  * value should be interpreted in a way similar to the return value of
7689  * gtk_widget_child_focus():
7690  *
7691  * When %TRUE is returned, stay in the widget, the failed keyboard
7692  * navigation is Ok and/or there is nowhere we can/should move the
7693  * focus to.
7694  *
7695  * When %FALSE is returned, the caller should continue with keyboard
7696  * navigation outside the widget, e.g. by calling
7697  * gtk_widget_child_focus() on the widget's toplevel.
7698  *
7699  * The default ::keynav-failed handler returns %TRUE for
7700  * %GTK_DIR_TAB_FORWARD and %GTK_DIR_TAB_BACKWARD. For the other
7701  * values of #GtkDirectionType, it looks at the
7702  * #GtkSettings:gtk-keynav-cursor-only setting and returns %FALSE
7703  * if the setting is %TRUE. This way the entire user interface
7704  * becomes cursor-navigatable on input devices such as mobile phones
7705  * which only have cursor keys but no tab key.
7706  *
7707  * Whenever the default handler returns %TRUE, it also calls
7708  * gtk_widget_error_bell() to notify the user of the failed keyboard
7709  * navigation.
7710  *
7711  * A use case for providing an own implementation of ::keynav-failed
7712  * (either by connecting to it or by overriding it) would be a row of
7713  * #GtkEntry widgets where the user should be able to navigate the
7714  * entire row with the cursor keys, as e.g. known from user interfaces
7715  * that require entering license keys.
7716  *
7717  * Return value: %TRUE if stopping keyboard navigation is fine, %FALSE
7718  *               if the emitting widget should try to handle the keyboard
7719  *               navigation attempt in its parent container(s).
7720  *
7721  * Since: 2.12
7722  **/
7723 gboolean
7724 gtk_widget_keynav_failed (GtkWidget        *widget,
7725                           GtkDirectionType  direction)
7726 {
7727   gboolean return_val;
7728
7729   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7730
7731   g_signal_emit (widget, widget_signals[KEYNAV_FAILED], 0,
7732                  direction, &return_val);
7733
7734   return return_val;
7735 }
7736
7737 /**
7738  * gtk_widget_error_bell:
7739  * @widget: a #GtkWidget
7740  *
7741  * Notifies the user about an input-related error on this widget.
7742  * If the #GtkSettings:gtk-error-bell setting is %TRUE, it calls
7743  * gdk_window_beep(), otherwise it does nothing.
7744  *
7745  * Note that the effect of gdk_window_beep() can be configured in many
7746  * ways, depending on the windowing backend and the desktop environment
7747  * or window manager that is used.
7748  *
7749  * Since: 2.12
7750  **/
7751 void
7752 gtk_widget_error_bell (GtkWidget *widget)
7753 {
7754   GtkSettings* settings;
7755   gboolean beep;
7756
7757   g_return_if_fail (GTK_IS_WIDGET (widget));
7758
7759   settings = gtk_widget_get_settings (widget);
7760   if (!settings)
7761     return;
7762
7763   g_object_get (settings,
7764                 "gtk-error-bell", &beep,
7765                 NULL);
7766
7767   if (beep && widget->window)
7768     gdk_window_beep (widget->window);
7769 }
7770
7771 /**
7772  * gtk_widget_set_uposition:
7773  * @widget: a #GtkWidget
7774  * @x: x position; -1 to unset x; -2 to leave x unchanged
7775  * @y: y position; -1 to unset y; -2 to leave y unchanged
7776  *
7777  *
7778  * Sets the position of a widget. The funny "u" in the name comes from
7779  * the "user position" hint specified by the X Window System, and
7780  * exists for legacy reasons. This function doesn't work if a widget
7781  * is inside a container; it's only really useful on #GtkWindow.
7782  *
7783  * Don't use this function to center dialogs over the main application
7784  * window; most window managers will do the centering on your behalf
7785  * if you call gtk_window_set_transient_for(), and it's really not
7786  * possible to get the centering to work correctly in all cases from
7787  * application code. But if you insist, use gtk_window_set_position()
7788  * to set #GTK_WIN_POS_CENTER_ON_PARENT, don't do the centering
7789  * manually.
7790  *
7791  * Note that although @x and @y can be individually unset, the position
7792  * is not honoured unless both @x and @y are set.
7793  **/
7794 void
7795 gtk_widget_set_uposition (GtkWidget *widget,
7796                           gint       x,
7797                           gint       y)
7798 {
7799   /* FIXME this function is the only place that aux_info->x and
7800    * aux_info->y are even used I believe, and this function is
7801    * deprecated. Should be cleaned up.
7802    *
7803    * (Actually, size_allocate uses them) -Yosh
7804    */
7805
7806   GtkWidgetAuxInfo *aux_info;
7807
7808   g_return_if_fail (GTK_IS_WIDGET (widget));
7809
7810   aux_info =_gtk_widget_get_aux_info (widget, TRUE);
7811
7812   if (x > -2)
7813     {
7814       if (x == -1)
7815         aux_info->x_set = FALSE;
7816       else
7817         {
7818           aux_info->x_set = TRUE;
7819           aux_info->x = x;
7820         }
7821     }
7822
7823   if (y > -2)
7824     {
7825       if (y == -1)
7826         aux_info->y_set = FALSE;
7827       else
7828         {
7829           aux_info->y_set = TRUE;
7830           aux_info->y = y;
7831         }
7832     }
7833
7834   if (GTK_IS_WINDOW (widget) && aux_info->x_set && aux_info->y_set)
7835     _gtk_window_reposition (GTK_WINDOW (widget), aux_info->x, aux_info->y);
7836
7837   if (gtk_widget_get_visible (widget) && widget->parent)
7838     gtk_widget_size_allocate (widget, &widget->allocation);
7839 }
7840
7841 static void
7842 gtk_widget_set_usize_internal (GtkWidget *widget,
7843                                gint       width,
7844                                gint       height)
7845 {
7846   GtkWidgetAuxInfo *aux_info;
7847   gboolean changed = FALSE;
7848
7849   g_object_freeze_notify (G_OBJECT (widget));
7850
7851   aux_info = _gtk_widget_get_aux_info (widget, TRUE);
7852
7853   if (width > -2 && aux_info->width != width)
7854     {
7855       g_object_notify (G_OBJECT (widget), "width-request");
7856       aux_info->width = width;
7857       changed = TRUE;
7858     }
7859   if (height > -2 && aux_info->height != height)
7860     {
7861       g_object_notify (G_OBJECT (widget), "height-request");
7862       aux_info->height = height;
7863       changed = TRUE;
7864     }
7865
7866   if (gtk_widget_get_visible (widget) && changed)
7867     gtk_widget_queue_resize (widget);
7868
7869   g_object_thaw_notify (G_OBJECT (widget));
7870 }
7871
7872 /**
7873  * gtk_widget_set_usize:
7874  * @widget: a #GtkWidget
7875  * @width: minimum width, or -1 to unset
7876  * @height: minimum height, or -1 to unset
7877  *
7878  * Sets the minimum size of a widget; that is, the widget's size
7879  * request will be @width by @height. You can use this function to
7880  * force a widget to be either larger or smaller than it is. The
7881  * strange "usize" name dates from the early days of GTK+, and derives
7882  * from X Window System terminology. In many cases,
7883  * gtk_window_set_default_size() is a better choice for toplevel
7884  * windows than this function; setting the default size will still
7885  * allow users to shrink the window. Setting the usize will force them
7886  * to leave the window at least as large as the usize. When dealing
7887  * with window sizes, gtk_window_set_geometry_hints() can be a useful
7888  * function as well.
7889  *
7890  * Note the inherent danger of setting any fixed size - themes,
7891  * translations into other languages, different fonts, and user action
7892  * can all change the appropriate size for a given widget. So, it's
7893  * basically impossible to hardcode a size that will always be
7894  * correct.
7895  *
7896  * Deprecated: 2.2: Use gtk_widget_set_size_request() instead.
7897  **/
7898 void
7899 gtk_widget_set_usize (GtkWidget *widget,
7900                       gint       width,
7901                       gint       height)
7902 {
7903   g_return_if_fail (GTK_IS_WIDGET (widget));
7904
7905   gtk_widget_set_usize_internal (widget, width, height);
7906 }
7907
7908 /**
7909  * gtk_widget_set_size_request:
7910  * @widget: a #GtkWidget
7911  * @width: width @widget should request, or -1 to unset
7912  * @height: height @widget should request, or -1 to unset
7913  *
7914  * Sets the minimum size of a widget; that is, the widget's size
7915  * request will be @width by @height. You can use this function to
7916  * force a widget to be either larger or smaller than it normally
7917  * would be.
7918  *
7919  * In most cases, gtk_window_set_default_size() is a better choice for
7920  * toplevel windows than this function; setting the default size will
7921  * still allow users to shrink the window. Setting the size request
7922  * will force them to leave the window at least as large as the size
7923  * request. When dealing with window sizes,
7924  * gtk_window_set_geometry_hints() can be a useful function as well.
7925  *
7926  * Note the inherent danger of setting any fixed size - themes,
7927  * translations into other languages, different fonts, and user action
7928  * can all change the appropriate size for a given widget. So, it's
7929  * basically impossible to hardcode a size that will always be
7930  * correct.
7931  *
7932  * The size request of a widget is the smallest size a widget can
7933  * accept while still functioning well and drawing itself correctly.
7934  * However in some strange cases a widget may be allocated less than
7935  * its requested size, and in many cases a widget may be allocated more
7936  * space than it requested.
7937  *
7938  * If the size request in a given direction is -1 (unset), then
7939  * the "natural" size request of the widget will be used instead.
7940  *
7941  * Widgets can't actually be allocated a size less than 1 by 1, but
7942  * you can pass 0,0 to this function to mean "as small as possible."
7943  **/
7944 void
7945 gtk_widget_set_size_request (GtkWidget *widget,
7946                              gint       width,
7947                              gint       height)
7948 {
7949   g_return_if_fail (GTK_IS_WIDGET (widget));
7950   g_return_if_fail (width >= -1);
7951   g_return_if_fail (height >= -1);
7952
7953   if (width == 0)
7954     width = 1;
7955   if (height == 0)
7956     height = 1;
7957
7958   gtk_widget_set_usize_internal (widget, width, height);
7959 }
7960
7961
7962 /**
7963  * gtk_widget_get_size_request:
7964  * @widget: a #GtkWidget
7965  * @width: (allow-none): (out): return location for width, or %NULL
7966  * @height: (allow-none): (out): return location for height, or %NULL
7967  *
7968  * Gets the size request that was explicitly set for the widget using
7969  * gtk_widget_set_size_request(). A value of -1 stored in @width or
7970  * @height indicates that that dimension has not been set explicitly
7971  * and the natural requisition of the widget will be used intead. See
7972  * gtk_widget_set_size_request(). To get the size a widget will
7973  * actually use, call gtk_widget_size_request() instead of
7974  * this function.
7975  **/
7976 void
7977 gtk_widget_get_size_request (GtkWidget *widget,
7978                              gint      *width,
7979                              gint      *height)
7980 {
7981   GtkWidgetAuxInfo *aux_info;
7982
7983   g_return_if_fail (GTK_IS_WIDGET (widget));
7984
7985   aux_info = _gtk_widget_get_aux_info (widget, FALSE);
7986
7987   if (width)
7988     *width = aux_info ? aux_info->width : -1;
7989
7990   if (height)
7991     *height = aux_info ? aux_info->height : -1;
7992 }
7993
7994 /**
7995  * gtk_widget_set_events:
7996  * @widget: a #GtkWidget
7997  * @events: event mask
7998  *
7999  * Sets the event mask (see #GdkEventMask) for a widget. The event
8000  * mask determines which events a widget will receive. Keep in mind
8001  * that different widgets have different default event masks, and by
8002  * changing the event mask you may disrupt a widget's functionality,
8003  * so be careful. This function must be called while a widget is
8004  * unrealized. Consider gtk_widget_add_events() for widgets that are
8005  * already realized, or if you want to preserve the existing event
8006  * mask. This function can't be used with #GTK_NO_WINDOW widgets;
8007  * to get events on those widgets, place them inside a #GtkEventBox
8008  * and receive events on the event box.
8009  **/
8010 void
8011 gtk_widget_set_events (GtkWidget *widget,
8012                        gint       events)
8013 {
8014   g_return_if_fail (GTK_IS_WIDGET (widget));
8015   g_return_if_fail (!gtk_widget_get_realized (widget));
8016
8017   g_object_set_qdata (G_OBJECT (widget), quark_event_mask,
8018                       GINT_TO_POINTER (events));
8019   g_object_notify (G_OBJECT (widget), "events");
8020 }
8021
8022 static void
8023 gtk_widget_add_events_internal (GtkWidget *widget,
8024                                 gint       events,
8025                                 GList     *window_list)
8026 {
8027   GList *l;
8028
8029   for (l = window_list; l != NULL; l = l->next)
8030     {
8031       GdkWindow *window = l->data;
8032       gpointer user_data;
8033
8034       gdk_window_get_user_data (window, &user_data);
8035       if (user_data == widget)
8036         {
8037           GList *children;
8038
8039           gdk_window_set_events (window, gdk_window_get_events (window) | events);
8040
8041           children = gdk_window_get_children (window);
8042           gtk_widget_add_events_internal (widget, events, children);
8043           g_list_free (children);
8044         }
8045     }
8046 }
8047
8048 /**
8049  * gtk_widget_add_events:
8050  * @widget: a #GtkWidget
8051  * @events: an event mask, see #GdkEventMask
8052  *
8053  * Adds the events in the bitfield @events to the event mask for
8054  * @widget. See gtk_widget_set_events() for details.
8055  **/
8056 void
8057 gtk_widget_add_events (GtkWidget *widget,
8058                        gint       events)
8059 {
8060   gint old_events;
8061
8062   g_return_if_fail (GTK_IS_WIDGET (widget));
8063
8064   old_events = GPOINTER_TO_INT (g_object_get_qdata (G_OBJECT (widget), quark_event_mask));
8065   g_object_set_qdata (G_OBJECT (widget), quark_event_mask,
8066                       GINT_TO_POINTER (old_events | events));
8067
8068   if (gtk_widget_get_realized (widget))
8069     {
8070       GList *window_list;
8071
8072       if (!gtk_widget_get_has_window (widget))
8073         window_list = gdk_window_get_children (widget->window);
8074       else
8075         window_list = g_list_prepend (NULL, widget->window);
8076
8077       gtk_widget_add_events_internal (widget, events, window_list);
8078
8079       g_list_free (window_list);
8080     }
8081
8082   g_object_notify (G_OBJECT (widget), "events");
8083 }
8084
8085 /**
8086  * gtk_widget_set_extension_events:
8087  * @widget: a #GtkWidget
8088  * @mode: bitfield of extension events to receive
8089  *
8090  * Sets the extension events mask to @mode. See #GdkExtensionMode
8091  * and gdk_input_set_extension_events().
8092  **/
8093 void
8094 gtk_widget_set_extension_events (GtkWidget *widget,
8095                                  GdkExtensionMode mode)
8096 {
8097   g_return_if_fail (GTK_IS_WIDGET (widget));
8098
8099   if (gtk_widget_get_realized (widget))
8100     gtk_widget_set_extension_events_internal (widget, mode, NULL);
8101
8102   g_object_set_qdata (G_OBJECT (widget), quark_extension_event_mode,
8103                       GINT_TO_POINTER (mode));
8104   g_object_notify (G_OBJECT (widget), "extension-events");
8105 }
8106
8107 /**
8108  * gtk_widget_get_toplevel:
8109  * @widget: a #GtkWidget
8110  *
8111  * This function returns the topmost widget in the container hierarchy
8112  * @widget is a part of. If @widget has no parent widgets, it will be
8113  * returned as the topmost widget. No reference will be added to the
8114  * returned widget; it should not be unreferenced.
8115  *
8116  * Note the difference in behavior vs. gtk_widget_get_ancestor();
8117  * <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW)</literal>
8118  * would return
8119  * %NULL if @widget wasn't inside a toplevel window, and if the
8120  * window was inside a #GtkWindow-derived widget which was in turn
8121  * inside the toplevel #GtkWindow. While the second case may
8122  * seem unlikely, it actually happens when a #GtkPlug is embedded
8123  * inside a #GtkSocket within the same application.
8124  *
8125  * To reliably find the toplevel #GtkWindow, use
8126  * gtk_widget_get_toplevel() and check if the %TOPLEVEL flags
8127  * is set on the result.
8128  * |[
8129  *  GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
8130  *  if (gtk_widget_is_toplevel (toplevel))
8131  *    {
8132  *      /&ast; Perform action on toplevel. &ast;/
8133  *    }
8134  * ]|
8135  *
8136  * Return value: (transfer none): the topmost ancestor of @widget, or @widget itself
8137  *    if there's no ancestor.
8138  **/
8139 GtkWidget*
8140 gtk_widget_get_toplevel (GtkWidget *widget)
8141 {
8142   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8143
8144   while (widget->parent)
8145     widget = widget->parent;
8146
8147   return widget;
8148 }
8149
8150 /**
8151  * gtk_widget_get_ancestor:
8152  * @widget: a #GtkWidget
8153  * @widget_type: ancestor type
8154  *
8155  * Gets the first ancestor of @widget with type @widget_type. For example,
8156  * <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)</literal> gets
8157  * the first #GtkBox that's an ancestor of @widget. No reference will be
8158  * added to the returned widget; it should not be unreferenced. See note
8159  * about checking for a toplevel #GtkWindow in the docs for
8160  * gtk_widget_get_toplevel().
8161  *
8162  * Note that unlike gtk_widget_is_ancestor(), gtk_widget_get_ancestor()
8163  * considers @widget to be an ancestor of itself.
8164  *
8165  * Return value: (transfer none): the ancestor widget, or %NULL if not found
8166  **/
8167 GtkWidget*
8168 gtk_widget_get_ancestor (GtkWidget *widget,
8169                          GType      widget_type)
8170 {
8171   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8172
8173   while (widget && !g_type_is_a (G_OBJECT_TYPE (widget), widget_type))
8174     widget = widget->parent;
8175
8176   if (!(widget && g_type_is_a (G_OBJECT_TYPE (widget), widget_type)))
8177     return NULL;
8178
8179   return widget;
8180 }
8181
8182 /**
8183  * gtk_widget_get_colormap:
8184  * @widget: a #GtkWidget
8185  *
8186  * Gets the colormap that will be used to render @widget. No reference will
8187  * be added to the returned colormap; it should not be unreferenced.
8188  *
8189  * Return value: (transfer none): the colormap used by @widget
8190  **/
8191 GdkColormap*
8192 gtk_widget_get_colormap (GtkWidget *widget)
8193 {
8194   GdkColormap *colormap;
8195   GtkWidget *tmp_widget;
8196
8197   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8198
8199   if (widget->window)
8200     {
8201       colormap = gdk_drawable_get_colormap (widget->window);
8202       /* If window was destroyed previously, we'll get NULL here */
8203       if (colormap)
8204         return colormap;
8205     }
8206
8207   tmp_widget = widget;
8208   while (tmp_widget)
8209     {
8210       colormap = g_object_get_qdata (G_OBJECT (tmp_widget), quark_colormap);
8211       if (colormap)
8212         return colormap;
8213
8214       tmp_widget= tmp_widget->parent;
8215     }
8216
8217   return gdk_screen_get_default_colormap (gtk_widget_get_screen (widget));
8218 }
8219
8220 /**
8221  * gtk_widget_get_visual:
8222  * @widget: a #GtkWidget
8223  *
8224  * Gets the visual that will be used to render @widget.
8225  *
8226  * Return value: (transfer none): the visual for @widget
8227  **/
8228 GdkVisual*
8229 gtk_widget_get_visual (GtkWidget *widget)
8230 {
8231   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8232
8233   return gdk_colormap_get_visual (gtk_widget_get_colormap (widget));
8234 }
8235
8236 /**
8237  * gtk_widget_get_settings:
8238  * @widget: a #GtkWidget
8239  *
8240  * Gets the settings object holding the settings (global property
8241  * settings, RC file information, etc) used for this widget.
8242  *
8243  * Note that this function can only be called when the #GtkWidget
8244  * is attached to a toplevel, since the settings object is specific
8245  * to a particular #GdkScreen.
8246  *
8247  * Return value: (transfer none): the relevant #GtkSettings object
8248  **/
8249 GtkSettings*
8250 gtk_widget_get_settings (GtkWidget *widget)
8251 {
8252   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8253
8254   return gtk_settings_get_for_screen (gtk_widget_get_screen (widget));
8255 }
8256
8257 /**
8258  * gtk_widget_set_colormap:
8259  * @widget: a #GtkWidget
8260  * @colormap: a colormap
8261  *
8262  * Sets the colormap for the widget to the given value. Widget must not
8263  * have been previously realized. This probably should only be used
8264  * from an <function>init()</function> function (i.e. from the constructor
8265  * for the widget).
8266  **/
8267 void
8268 gtk_widget_set_colormap (GtkWidget   *widget,
8269                          GdkColormap *colormap)
8270 {
8271   g_return_if_fail (GTK_IS_WIDGET (widget));
8272   g_return_if_fail (!gtk_widget_get_realized (widget));
8273   g_return_if_fail (GDK_IS_COLORMAP (colormap));
8274
8275   g_object_ref (colormap);
8276
8277   g_object_set_qdata_full (G_OBJECT (widget),
8278                            quark_colormap,
8279                            colormap,
8280                            g_object_unref);
8281 }
8282
8283 /**
8284  * gtk_widget_get_events:
8285  * @widget: a #GtkWidget
8286  *
8287  * Returns the event mask for the widget (a bitfield containing flags
8288  * from the #GdkEventMask enumeration). These are the events that the widget
8289  * will receive.
8290  *
8291  * Return value: event mask for @widget
8292  **/
8293 gint
8294 gtk_widget_get_events (GtkWidget *widget)
8295 {
8296   g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
8297
8298   return GPOINTER_TO_INT (g_object_get_qdata (G_OBJECT (widget), quark_event_mask));
8299 }
8300
8301 /**
8302  * gtk_widget_get_extension_events:
8303  * @widget: a #GtkWidget
8304  *
8305  * Retrieves the extension events the widget will receive; see
8306  * gdk_input_set_extension_events().
8307  *
8308  * Return value: extension events for @widget
8309  **/
8310 GdkExtensionMode
8311 gtk_widget_get_extension_events (GtkWidget *widget)
8312 {
8313   g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
8314
8315   return GPOINTER_TO_INT (g_object_get_qdata (G_OBJECT (widget), quark_extension_event_mode));
8316 }
8317
8318 /**
8319  * gtk_widget_get_pointer:
8320  * @widget: a #GtkWidget
8321  * @x: (out) (allow-none): return location for the X coordinate, or %NULL
8322  * @y: (out) (allow-none): return location for the Y coordinate, or %NULL
8323  *
8324  * Obtains the location of the mouse pointer in widget coordinates.
8325  * Widget coordinates are a bit odd; for historical reasons, they are
8326  * defined as @widget->window coordinates for widgets that are not
8327  * #GTK_NO_WINDOW widgets, and are relative to @widget->allocation.x,
8328  * @widget->allocation.y for widgets that are #GTK_NO_WINDOW widgets.
8329  **/
8330 void
8331 gtk_widget_get_pointer (GtkWidget *widget,
8332                         gint      *x,
8333                         gint      *y)
8334 {
8335   g_return_if_fail (GTK_IS_WIDGET (widget));
8336
8337   if (x)
8338     *x = -1;
8339   if (y)
8340     *y = -1;
8341
8342   if (gtk_widget_get_realized (widget))
8343     {
8344       gdk_window_get_pointer (widget->window, x, y, NULL);
8345
8346       if (!gtk_widget_get_has_window (widget))
8347         {
8348           if (x)
8349             *x -= widget->allocation.x;
8350           if (y)
8351             *y -= widget->allocation.y;
8352         }
8353     }
8354 }
8355
8356 /**
8357  * gtk_widget_is_ancestor:
8358  * @widget: a #GtkWidget
8359  * @ancestor: another #GtkWidget
8360  *
8361  * Determines whether @widget is somewhere inside @ancestor, possibly with
8362  * intermediate containers.
8363  *
8364  * Return value: %TRUE if @ancestor contains @widget as a child,
8365  *    grandchild, great grandchild, etc.
8366  **/
8367 gboolean
8368 gtk_widget_is_ancestor (GtkWidget *widget,
8369                         GtkWidget *ancestor)
8370 {
8371   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
8372   g_return_val_if_fail (ancestor != NULL, FALSE);
8373
8374   while (widget)
8375     {
8376       if (widget->parent == ancestor)
8377         return TRUE;
8378       widget = widget->parent;
8379     }
8380
8381   return FALSE;
8382 }
8383
8384 static GQuark quark_composite_name = 0;
8385
8386 /**
8387  * gtk_widget_set_composite_name:
8388  * @widget: a #GtkWidget.
8389  * @name: the name to set
8390  *
8391  * Sets a widgets composite name. The widget must be
8392  * a composite child of its parent; see gtk_widget_push_composite_child().
8393  **/
8394 void
8395 gtk_widget_set_composite_name (GtkWidget   *widget,
8396                                const gchar *name)
8397 {
8398   g_return_if_fail (GTK_IS_WIDGET (widget));
8399   g_return_if_fail ((GTK_OBJECT_FLAGS (widget) & GTK_COMPOSITE_CHILD) != 0);
8400   g_return_if_fail (name != NULL);
8401
8402   if (!quark_composite_name)
8403     quark_composite_name = g_quark_from_static_string ("gtk-composite-name");
8404
8405   g_object_set_qdata_full (G_OBJECT (widget),
8406                            quark_composite_name,
8407                            g_strdup (name),
8408                            g_free);
8409 }
8410
8411 /**
8412  * gtk_widget_get_composite_name:
8413  * @widget: a #GtkWidget
8414  *
8415  * Obtains the composite name of a widget.
8416  *
8417  * Returns: the composite name of @widget, or %NULL if @widget is not
8418  *   a composite child. The string should be freed when it is no
8419  *   longer needed.
8420  **/
8421 gchar*
8422 gtk_widget_get_composite_name (GtkWidget *widget)
8423 {
8424   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8425
8426   if (((GTK_OBJECT_FLAGS (widget) & GTK_COMPOSITE_CHILD) != 0) && widget->parent)
8427     return _gtk_container_child_composite_name (GTK_CONTAINER (widget->parent),
8428                                                widget);
8429   else
8430     return NULL;
8431 }
8432
8433 /**
8434  * gtk_widget_push_composite_child:
8435  *
8436  * Makes all newly-created widgets as composite children until
8437  * the corresponding gtk_widget_pop_composite_child() call.
8438  *
8439  * A composite child is a child that's an implementation detail of the
8440  * container it's inside and should not be visible to people using the
8441  * container. Composite children aren't treated differently by GTK (but
8442  * see gtk_container_foreach() vs. gtk_container_forall()), but e.g. GUI
8443  * builders might want to treat them in a different way.
8444  *
8445  * Here is a simple example:
8446  * |[
8447  *   gtk_widget_push_composite_child ();
8448  *   scrolled_window->hscrollbar = gtk_hscrollbar_new (hadjustment);
8449  *   gtk_widget_set_composite_name (scrolled_window->hscrollbar, "hscrollbar");
8450  *   gtk_widget_pop_composite_child ();
8451  *   gtk_widget_set_parent (scrolled_window->hscrollbar,
8452  *                          GTK_WIDGET (scrolled_window));
8453  *   g_object_ref (scrolled_window->hscrollbar);
8454  * ]|
8455  **/
8456 void
8457 gtk_widget_push_composite_child (void)
8458 {
8459   composite_child_stack++;
8460 }
8461
8462 /**
8463  * gtk_widget_pop_composite_child:
8464  *
8465  * Cancels the effect of a previous call to gtk_widget_push_composite_child().
8466  **/
8467 void
8468 gtk_widget_pop_composite_child (void)
8469 {
8470   if (composite_child_stack)
8471     composite_child_stack--;
8472 }
8473
8474 /**
8475  * gtk_widget_push_colormap:
8476  * @cmap: a #GdkColormap
8477  *
8478  * Pushes @cmap onto a global stack of colormaps; the topmost
8479  * colormap on the stack will be used to create all widgets.
8480  * Remove @cmap with gtk_widget_pop_colormap(). There's little
8481  * reason to use this function.
8482  **/
8483 void
8484 gtk_widget_push_colormap (GdkColormap *cmap)
8485 {
8486   g_return_if_fail (!cmap || GDK_IS_COLORMAP (cmap));
8487
8488   colormap_stack = g_slist_prepend (colormap_stack, cmap);
8489 }
8490
8491 /**
8492  * gtk_widget_pop_colormap:
8493  *
8494  * Removes a colormap pushed with gtk_widget_push_colormap().
8495  **/
8496 void
8497 gtk_widget_pop_colormap (void)
8498 {
8499   if (colormap_stack)
8500     colormap_stack = g_slist_delete_link (colormap_stack, colormap_stack);
8501 }
8502
8503 /**
8504  * gtk_widget_set_default_colormap:
8505  * @colormap: a #GdkColormap
8506  *
8507  * Sets the default colormap to use when creating widgets.
8508  * gtk_widget_push_colormap() is a better function to use if
8509  * you only want to affect a few widgets, rather than all widgets.
8510  **/
8511 void
8512 gtk_widget_set_default_colormap (GdkColormap *colormap)
8513 {
8514   g_return_if_fail (GDK_IS_COLORMAP (colormap));
8515
8516   gdk_screen_set_default_colormap (gdk_colormap_get_screen (colormap),
8517                                    colormap);
8518 }
8519
8520 /**
8521  * gtk_widget_get_default_colormap:
8522  *
8523  * Obtains the default colormap used to create widgets.
8524  *
8525  * Return value: (transfer none): default widget colormap
8526  **/
8527 GdkColormap*
8528 gtk_widget_get_default_colormap (void)
8529 {
8530   return gdk_screen_get_default_colormap (gdk_screen_get_default ());
8531 }
8532
8533 /**
8534  * gtk_widget_get_default_visual:
8535  *
8536  * Obtains the visual of the default colormap. Not really useful;
8537  * used to be useful before gdk_colormap_get_visual() existed.
8538  *
8539  * Return value: (transfer none): visual of the default colormap
8540  **/
8541 GdkVisual*
8542 gtk_widget_get_default_visual (void)
8543 {
8544   return gdk_colormap_get_visual (gtk_widget_get_default_colormap ());
8545 }
8546
8547 static void
8548 gtk_widget_emit_direction_changed (GtkWidget        *widget,
8549                                    GtkTextDirection  old_dir)
8550 {
8551   gtk_widget_update_pango_context (widget);
8552
8553   g_signal_emit (widget, widget_signals[DIRECTION_CHANGED], 0, old_dir);
8554 }
8555
8556 /**
8557  * gtk_widget_set_direction:
8558  * @widget: a #GtkWidget
8559  * @dir:    the new direction
8560  *
8561  * Sets the reading direction on a particular widget. This direction
8562  * controls the primary direction for widgets containing text,
8563  * and also the direction in which the children of a container are
8564  * packed. The ability to set the direction is present in order
8565  * so that correct localization into languages with right-to-left
8566  * reading directions can be done. Generally, applications will
8567  * let the default reading direction present, except for containers
8568  * where the containers are arranged in an order that is explicitely
8569  * visual rather than logical (such as buttons for text justification).
8570  *
8571  * If the direction is set to %GTK_TEXT_DIR_NONE, then the value
8572  * set by gtk_widget_set_default_direction() will be used.
8573  **/
8574 void
8575 gtk_widget_set_direction (GtkWidget        *widget,
8576                           GtkTextDirection  dir)
8577 {
8578   GtkTextDirection old_dir;
8579
8580   g_return_if_fail (GTK_IS_WIDGET (widget));
8581   g_return_if_fail (dir >= GTK_TEXT_DIR_NONE && dir <= GTK_TEXT_DIR_RTL);
8582
8583   old_dir = gtk_widget_get_direction (widget);
8584
8585   if (dir == GTK_TEXT_DIR_NONE)
8586     GTK_PRIVATE_UNSET_FLAG (widget, GTK_DIRECTION_SET);
8587   else
8588     {
8589       GTK_PRIVATE_SET_FLAG (widget, GTK_DIRECTION_SET);
8590       if (dir == GTK_TEXT_DIR_LTR)
8591         GTK_PRIVATE_SET_FLAG (widget, GTK_DIRECTION_LTR);
8592       else
8593         GTK_PRIVATE_UNSET_FLAG (widget, GTK_DIRECTION_LTR);
8594     }
8595
8596   if (old_dir != gtk_widget_get_direction (widget))
8597     gtk_widget_emit_direction_changed (widget, old_dir);
8598 }
8599
8600 /**
8601  * gtk_widget_get_direction:
8602  * @widget: a #GtkWidget
8603  *
8604  * Gets the reading direction for a particular widget. See
8605  * gtk_widget_set_direction().
8606  *
8607  * Return value: the reading direction for the widget.
8608  **/
8609 GtkTextDirection
8610 gtk_widget_get_direction (GtkWidget *widget)
8611 {
8612   g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_TEXT_DIR_LTR);
8613
8614   if (GTK_WIDGET_DIRECTION_SET (widget))
8615     return GTK_WIDGET_DIRECTION_LTR (widget) ? GTK_TEXT_DIR_LTR : GTK_TEXT_DIR_RTL;
8616   else
8617     return gtk_default_direction;
8618 }
8619
8620 static void
8621 gtk_widget_set_default_direction_recurse (GtkWidget *widget, gpointer data)
8622 {
8623   GtkTextDirection old_dir = GPOINTER_TO_UINT (data);
8624
8625   g_object_ref (widget);
8626
8627   if (!GTK_WIDGET_DIRECTION_SET (widget))
8628     gtk_widget_emit_direction_changed (widget, old_dir);
8629
8630   if (GTK_IS_CONTAINER (widget))
8631     gtk_container_forall (GTK_CONTAINER (widget),
8632                           gtk_widget_set_default_direction_recurse,
8633                           data);
8634
8635   g_object_unref (widget);
8636 }
8637
8638 /**
8639  * gtk_widget_set_default_direction:
8640  * @dir: the new default direction. This cannot be
8641  *        %GTK_TEXT_DIR_NONE.
8642  *
8643  * Sets the default reading direction for widgets where the
8644  * direction has not been explicitly set by gtk_widget_set_direction().
8645  **/
8646 void
8647 gtk_widget_set_default_direction (GtkTextDirection dir)
8648 {
8649   g_return_if_fail (dir == GTK_TEXT_DIR_RTL || dir == GTK_TEXT_DIR_LTR);
8650
8651   if (dir != gtk_default_direction)
8652     {
8653       GList *toplevels, *tmp_list;
8654       GtkTextDirection old_dir = gtk_default_direction;
8655
8656       gtk_default_direction = dir;
8657
8658       tmp_list = toplevels = gtk_window_list_toplevels ();
8659       g_list_foreach (toplevels, (GFunc)g_object_ref, NULL);
8660
8661       while (tmp_list)
8662         {
8663           gtk_widget_set_default_direction_recurse (tmp_list->data,
8664                                                     GUINT_TO_POINTER (old_dir));
8665           g_object_unref (tmp_list->data);
8666           tmp_list = tmp_list->next;
8667         }
8668
8669       g_list_free (toplevels);
8670     }
8671 }
8672
8673 /**
8674  * gtk_widget_get_default_direction:
8675  *
8676  * Obtains the current default reading direction. See
8677  * gtk_widget_set_default_direction().
8678  *
8679  * Return value: the current default direction.
8680  **/
8681 GtkTextDirection
8682 gtk_widget_get_default_direction (void)
8683 {
8684   return gtk_default_direction;
8685 }
8686
8687 static void
8688 gtk_widget_dispose (GObject *object)
8689 {
8690   GtkWidget *widget = GTK_WIDGET (object);
8691
8692   if (widget->parent)
8693     gtk_container_remove (GTK_CONTAINER (widget->parent), widget);
8694   else if (gtk_widget_get_visible (widget))
8695     gtk_widget_hide (widget);
8696
8697   GTK_WIDGET_UNSET_FLAGS (widget, GTK_VISIBLE);
8698   if (gtk_widget_get_realized (widget))
8699     gtk_widget_unrealize (widget);
8700
8701   G_OBJECT_CLASS (gtk_widget_parent_class)->dispose (object);
8702 }
8703
8704 static void
8705 gtk_widget_real_destroy (GtkObject *object)
8706 {
8707   /* gtk_object_destroy() will already hold a refcount on object */
8708   GtkWidget *widget = GTK_WIDGET (object);
8709
8710   /* wipe accelerator closures (keep order) */
8711   g_object_set_qdata (G_OBJECT (widget), quark_accel_path, NULL);
8712   g_object_set_qdata (G_OBJECT (widget), quark_accel_closures, NULL);
8713
8714   /* Callers of add_mnemonic_label() should disconnect on ::destroy */
8715   g_object_set_qdata (G_OBJECT (widget), quark_mnemonic_labels, NULL);
8716
8717   gtk_grab_remove (widget);
8718
8719   g_object_unref (widget->style);
8720   widget->style = gtk_widget_get_default_style ();
8721   g_object_ref (widget->style);
8722
8723   GTK_OBJECT_CLASS (gtk_widget_parent_class)->destroy (object);
8724 }
8725
8726 static void
8727 gtk_widget_finalize (GObject *object)
8728 {
8729   GtkWidget *widget = GTK_WIDGET (object);
8730   GtkWidgetAuxInfo *aux_info;
8731   GtkAccessible *accessible;
8732
8733   gtk_grab_remove (widget);
8734
8735   g_object_unref (widget->style);
8736   widget->style = NULL;
8737
8738   g_free (widget->name);
8739
8740   aux_info =_gtk_widget_get_aux_info (widget, FALSE);
8741   if (aux_info)
8742     gtk_widget_aux_info_destroy (aux_info);
8743
8744   accessible = g_object_get_qdata (G_OBJECT (widget), quark_accessible_object);
8745   if (accessible)
8746     g_object_unref (accessible);
8747
8748   G_OBJECT_CLASS (gtk_widget_parent_class)->finalize (object);
8749 }
8750
8751 /*****************************************
8752  * gtk_widget_real_map:
8753  *
8754  *   arguments:
8755  *
8756  *   results:
8757  *****************************************/
8758
8759 static void
8760 gtk_widget_real_map (GtkWidget *widget)
8761 {
8762   g_assert (gtk_widget_get_realized (widget));
8763
8764   if (!gtk_widget_get_mapped (widget))
8765     {
8766       gtk_widget_set_mapped (widget, TRUE);
8767
8768       if (gtk_widget_get_has_window (widget))
8769         gdk_window_show (widget->window);
8770     }
8771 }
8772
8773 /*****************************************
8774  * gtk_widget_real_unmap:
8775  *
8776  *   arguments:
8777  *
8778  *   results:
8779  *****************************************/
8780
8781 static void
8782 gtk_widget_real_unmap (GtkWidget *widget)
8783 {
8784   if (gtk_widget_get_mapped (widget))
8785     {
8786       gtk_widget_set_mapped (widget, FALSE);
8787
8788       if (gtk_widget_get_has_window (widget))
8789         gdk_window_hide (widget->window);
8790     }
8791 }
8792
8793 /*****************************************
8794  * gtk_widget_real_realize:
8795  *
8796  *   arguments:
8797  *
8798  *   results:
8799  *****************************************/
8800
8801 static void
8802 gtk_widget_real_realize (GtkWidget *widget)
8803 {
8804   g_assert (!gtk_widget_get_has_window (widget));
8805
8806   gtk_widget_set_realized (widget, TRUE);
8807   if (widget->parent)
8808     {
8809       widget->window = gtk_widget_get_parent_window (widget);
8810       g_object_ref (widget->window);
8811     }
8812   widget->style = gtk_style_attach (widget->style, widget->window);
8813 }
8814
8815 /*****************************************
8816  * gtk_widget_real_unrealize:
8817  *
8818  *   arguments:
8819  *
8820  *   results:
8821  *****************************************/
8822
8823 static void
8824 gtk_widget_real_unrealize (GtkWidget *widget)
8825 {
8826   if (gtk_widget_get_mapped (widget))
8827     gtk_widget_real_unmap (widget);
8828
8829   gtk_widget_set_mapped (widget, FALSE);
8830
8831   /* printf ("unrealizing %s\n", g_type_name (G_TYPE_FROM_INSTANCE (widget)));
8832    */
8833
8834    /* We must do unrealize child widget BEFORE container widget.
8835     * gdk_window_destroy() destroys specified xwindow and its sub-xwindows.
8836     * So, unrealizing container widget bofore its children causes the problem
8837     * (for example, gdk_ic_destroy () with destroyed window causes crash. )
8838     */
8839
8840   if (GTK_IS_CONTAINER (widget))
8841     gtk_container_forall (GTK_CONTAINER (widget),
8842                           (GtkCallback) gtk_widget_unrealize,
8843                           NULL);
8844
8845   gtk_style_detach (widget->style);
8846   if (gtk_widget_get_has_window (widget))
8847     {
8848       gdk_window_set_user_data (widget->window, NULL);
8849       gdk_window_destroy (widget->window);
8850       widget->window = NULL;
8851     }
8852   else
8853     {
8854       g_object_unref (widget->window);
8855       widget->window = NULL;
8856     }
8857
8858   gtk_selection_remove_all (widget);
8859
8860   gtk_widget_set_realized (widget, FALSE);
8861 }
8862
8863 static void
8864 gtk_widget_real_size_request (GtkWidget         *widget,
8865                               GtkRequisition    *requisition)
8866 {
8867   requisition->width = widget->requisition.width;
8868   requisition->height = widget->requisition.height;
8869 }
8870
8871 /**
8872  * _gtk_widget_peek_colormap:
8873  *
8874  * Returns colormap currently pushed by gtk_widget_push_colormap, if any.
8875  *
8876  * Return value: the currently pushed colormap, or %NULL if there is none.
8877  **/
8878 GdkColormap*
8879 _gtk_widget_peek_colormap (void)
8880 {
8881   if (colormap_stack)
8882     return (GdkColormap*) colormap_stack->data;
8883   return NULL;
8884 }
8885
8886 /*
8887  * _gtk_widget_set_pointer_window:
8888  * @widget: a #GtkWidget.
8889  * @pointer_window: the new pointer window.
8890  *
8891  * Sets pointer window for @widget.  Does not ref @pointer_window.
8892  * Actually stores it on the #GdkScreen, but you don't need to know that.
8893  */
8894 void
8895 _gtk_widget_set_pointer_window (GtkWidget *widget,
8896                                 GdkWindow *pointer_window)
8897 {
8898   g_return_if_fail (GTK_IS_WIDGET (widget));
8899
8900   if (gtk_widget_get_realized (widget))
8901     {
8902       GdkScreen *screen = gdk_drawable_get_screen (widget->window);
8903
8904       g_object_set_qdata (G_OBJECT (screen), quark_pointer_window,
8905                           pointer_window);
8906     }
8907 }
8908
8909 /*
8910  * _gtk_widget_get_pointer_window:
8911  * @widget: a #GtkWidget.
8912  *
8913  * Return value: the pointer window set on the #GdkScreen @widget is attached
8914  * to, or %NULL.
8915  */
8916 GdkWindow *
8917 _gtk_widget_get_pointer_window (GtkWidget *widget)
8918 {
8919   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8920
8921   if (gtk_widget_get_realized (widget))
8922     {
8923       GdkScreen *screen = gdk_drawable_get_screen (widget->window);
8924
8925       return g_object_get_qdata (G_OBJECT (screen), quark_pointer_window);
8926     }
8927
8928   return NULL;
8929 }
8930
8931 static void
8932 synth_crossing (GtkWidget      *widget,
8933                 GdkEventType    type,
8934                 GdkWindow      *window,
8935                 GdkCrossingMode mode,
8936                 GdkNotifyType   detail)
8937 {
8938   GdkEvent *event;
8939
8940   event = gdk_event_new (type);
8941
8942   event->crossing.window = g_object_ref (window);
8943   event->crossing.send_event = TRUE;
8944   event->crossing.subwindow = g_object_ref (window);
8945   event->crossing.time = GDK_CURRENT_TIME;
8946   event->crossing.x = event->crossing.y = 0;
8947   event->crossing.x_root = event->crossing.y_root = 0;
8948   event->crossing.mode = mode;
8949   event->crossing.detail = detail;
8950   event->crossing.focus = FALSE;
8951   event->crossing.state = 0;
8952
8953   if (!widget)
8954     widget = gtk_get_event_widget (event);
8955
8956   if (widget)
8957     gtk_widget_event_internal (widget, event);
8958
8959   gdk_event_free (event);
8960 }
8961
8962 /*
8963  * _gtk_widget_is_pointer_widget:
8964  * @widget: a #GtkWidget
8965  *
8966  * Returns %TRUE if the pointer window belongs to @widget.
8967  */
8968 gboolean
8969 _gtk_widget_is_pointer_widget (GtkWidget *widget)
8970 {
8971   if (GTK_WIDGET_HAS_POINTER (widget))
8972     {
8973       GdkWindow *win;
8974       GtkWidget *wid;
8975
8976       win = _gtk_widget_get_pointer_window (widget);
8977       if (win)
8978         {
8979           gdk_window_get_user_data (win, (gpointer *)&wid);
8980           if (wid == widget)
8981             return TRUE;
8982         }
8983     }
8984
8985   return FALSE;
8986 }
8987
8988 /*
8989  * _gtk_widget_synthesize_crossing:
8990  * @from: the #GtkWidget the virtual pointer is leaving.
8991  * @to: the #GtkWidget the virtual pointer is moving to.
8992  * @mode: the #GdkCrossingMode to place on the synthesized events.
8993  *
8994  * Generate crossing event(s) on widget state (sensitivity) or GTK+ grab change.
8995  *
8996  * The real pointer window is the window that most recently received an enter notify
8997  * event.  Windows that don't select for crossing events can't become the real
8998  * poiner window.  The real pointer widget that owns the real pointer window.  The
8999  * effective pointer window is the same as the real pointer window unless the real
9000  * pointer widget is either insensitive or there is a grab on a widget that is not
9001  * an ancestor of the real pointer widget (in which case the effective pointer
9002  * window should be the root window).
9003  *
9004  * When the effective pointer window is the same as the real poiner window, we
9005  * receive crossing events from the windowing system.  When the effective pointer
9006  * window changes to become different from the real pointer window we synthesize
9007  * crossing events, attempting to follow X protocol rules:
9008  *
9009  * When the root window becomes the effective pointer window:
9010  *   - leave notify on real pointer window, detail Ancestor
9011  *   - leave notify on all of its ancestors, detail Virtual
9012  *   - enter notify on root window, detail Inferior
9013  *
9014  * When the root window ceases to be the effective pointer window:
9015  *   - leave notify on root window, detail Inferior
9016  *   - enter notify on all ancestors of real pointer window, detail Virtual
9017  *   - enter notify on real pointer window, detail Ancestor
9018  */
9019 void
9020 _gtk_widget_synthesize_crossing (GtkWidget      *from,
9021                                  GtkWidget      *to,
9022                                  GdkCrossingMode mode)
9023 {
9024   GdkWindow *from_window = NULL, *to_window = NULL;
9025
9026   g_return_if_fail (from != NULL || to != NULL);
9027
9028   if (from != NULL)
9029     from_window = GTK_WIDGET_HAS_POINTER (from)
9030       ? _gtk_widget_get_pointer_window (from) : from->window;
9031   if (to != NULL)
9032     to_window = GTK_WIDGET_HAS_POINTER (to)
9033       ? _gtk_widget_get_pointer_window (to) : to->window;
9034
9035   if (from_window == NULL && to_window == NULL)
9036     ;
9037   else if (from_window != NULL && to_window == NULL)
9038     {
9039       GList *from_ancestors = NULL, *list;
9040       GdkWindow *from_ancestor = from_window;
9041
9042       while (from_ancestor != NULL)
9043         {
9044           from_ancestor = gdk_window_get_effective_parent (from_ancestor);
9045           if (from_ancestor == NULL)
9046             break;
9047           from_ancestors = g_list_prepend (from_ancestors, from_ancestor);
9048         }
9049
9050       synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
9051                       mode, GDK_NOTIFY_ANCESTOR);
9052       for (list = g_list_last (from_ancestors); list; list = list->prev)
9053         {
9054           synth_crossing (NULL, GDK_LEAVE_NOTIFY, (GdkWindow *) list->data,
9055                           mode, GDK_NOTIFY_VIRTUAL);
9056         }
9057
9058       /* XXX: enter/inferior on root window? */
9059
9060       g_list_free (from_ancestors);
9061     }
9062   else if (from_window == NULL && to_window != NULL)
9063     {
9064       GList *to_ancestors = NULL, *list;
9065       GdkWindow *to_ancestor = to_window;
9066
9067       while (to_ancestor != NULL)
9068         {
9069           to_ancestor = gdk_window_get_effective_parent (to_ancestor);
9070           if (to_ancestor == NULL)
9071             break;
9072           to_ancestors = g_list_prepend (to_ancestors, to_ancestor);
9073         }
9074
9075       /* XXX: leave/inferior on root window? */
9076
9077       for (list = to_ancestors; list; list = list->next)
9078         {
9079           synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
9080                           mode, GDK_NOTIFY_VIRTUAL);
9081         }
9082       synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
9083                       mode, GDK_NOTIFY_ANCESTOR);
9084
9085       g_list_free (to_ancestors);
9086     }
9087   else if (from_window == to_window)
9088     ;
9089   else
9090     {
9091       GList *from_ancestors = NULL, *to_ancestors = NULL, *list;
9092       GdkWindow *from_ancestor = from_window, *to_ancestor = to_window;
9093
9094       while (from_ancestor != NULL || to_ancestor != NULL)
9095         {
9096           if (from_ancestor != NULL)
9097             {
9098               from_ancestor = gdk_window_get_effective_parent (from_ancestor);
9099               if (from_ancestor == to_window)
9100                 break;
9101               if (from_ancestor)
9102                 from_ancestors = g_list_prepend (from_ancestors, from_ancestor);
9103             }
9104           if (to_ancestor != NULL)
9105             {
9106               to_ancestor = gdk_window_get_effective_parent (to_ancestor);
9107               if (to_ancestor == from_window)
9108                 break;
9109               if (to_ancestor)
9110                 to_ancestors = g_list_prepend (to_ancestors, to_ancestor);
9111             }
9112         }
9113       if (to_ancestor == from_window)
9114         {
9115           if (mode != GDK_CROSSING_GTK_UNGRAB)
9116             synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
9117                             mode, GDK_NOTIFY_INFERIOR);
9118           for (list = to_ancestors; list; list = list->next)
9119             synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
9120                             mode, GDK_NOTIFY_VIRTUAL);
9121           synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
9122                           mode, GDK_NOTIFY_ANCESTOR);
9123         }
9124       else if (from_ancestor == to_window)
9125         {
9126           synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
9127                           mode, GDK_NOTIFY_ANCESTOR);
9128           for (list = g_list_last (from_ancestors); list; list = list->prev)
9129             {
9130               synth_crossing (NULL, GDK_LEAVE_NOTIFY, (GdkWindow *) list->data,
9131                               mode, GDK_NOTIFY_VIRTUAL);
9132             }
9133           if (mode != GDK_CROSSING_GTK_GRAB)
9134             synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
9135                             mode, GDK_NOTIFY_INFERIOR);
9136         }
9137       else
9138         {
9139           while (from_ancestors != NULL && to_ancestors != NULL
9140                  && from_ancestors->data == to_ancestors->data)
9141             {
9142               from_ancestors = g_list_delete_link (from_ancestors,
9143                                                    from_ancestors);
9144               to_ancestors = g_list_delete_link (to_ancestors, to_ancestors);
9145             }
9146
9147           synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
9148                           mode, GDK_NOTIFY_NONLINEAR);
9149
9150           for (list = g_list_last (from_ancestors); list; list = list->prev)
9151             {
9152               synth_crossing (NULL, GDK_LEAVE_NOTIFY, (GdkWindow *) list->data,
9153                               mode, GDK_NOTIFY_NONLINEAR_VIRTUAL);
9154             }
9155           for (list = to_ancestors; list; list = list->next)
9156             {
9157               synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
9158                               mode, GDK_NOTIFY_NONLINEAR_VIRTUAL);
9159             }
9160           synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
9161                           mode, GDK_NOTIFY_NONLINEAR);
9162         }
9163       g_list_free (from_ancestors);
9164       g_list_free (to_ancestors);
9165     }
9166 }
9167
9168 static void
9169 gtk_widget_propagate_state (GtkWidget           *widget,
9170                             GtkStateData        *data)
9171 {
9172   guint8 old_state = gtk_widget_get_state (widget);
9173   guint8 old_saved_state = widget->saved_state;
9174
9175   /* don't call this function with state==GTK_STATE_INSENSITIVE,
9176    * parent_sensitive==TRUE on a sensitive widget
9177    */
9178
9179
9180   if (data->parent_sensitive)
9181     GTK_OBJECT_FLAGS (widget) |= GTK_PARENT_SENSITIVE;
9182   else
9183     GTK_OBJECT_FLAGS (widget) &= ~(GTK_PARENT_SENSITIVE);
9184
9185   if (gtk_widget_is_sensitive (widget))
9186     {
9187       if (data->state_restoration)
9188         widget->state = widget->saved_state;
9189       else
9190         widget->state = data->state;
9191     }
9192   else
9193     {
9194       if (!data->state_restoration)
9195         {
9196           if (data->state != GTK_STATE_INSENSITIVE)
9197             widget->saved_state = data->state;
9198         }
9199       else if (gtk_widget_get_state (widget) != GTK_STATE_INSENSITIVE)
9200         widget->saved_state = gtk_widget_get_state (widget);
9201       widget->state = GTK_STATE_INSENSITIVE;
9202     }
9203
9204   if (gtk_widget_is_focus (widget) && !gtk_widget_is_sensitive (widget))
9205     {
9206       GtkWidget *window;
9207
9208       window = gtk_widget_get_toplevel (widget);
9209       if (window && gtk_widget_is_toplevel (window))
9210         gtk_window_set_focus (GTK_WINDOW (window), NULL);
9211     }
9212
9213   if (old_state != gtk_widget_get_state (widget) ||
9214       old_saved_state != widget->saved_state)
9215     {
9216       g_object_ref (widget);
9217
9218       if (!gtk_widget_is_sensitive (widget) && gtk_widget_has_grab (widget))
9219         gtk_grab_remove (widget);
9220
9221       g_signal_emit (widget, widget_signals[STATE_CHANGED], 0, old_state);
9222
9223       if (GTK_WIDGET_HAS_POINTER (widget) && !GTK_WIDGET_SHADOWED (widget))
9224         {
9225           if (!gtk_widget_is_sensitive (widget))
9226             _gtk_widget_synthesize_crossing (widget, NULL,
9227                                              GDK_CROSSING_STATE_CHANGED);
9228           else if (old_state == GTK_STATE_INSENSITIVE)
9229             _gtk_widget_synthesize_crossing (NULL, widget,
9230                                              GDK_CROSSING_STATE_CHANGED);
9231         }
9232
9233       if (GTK_IS_CONTAINER (widget))
9234         {
9235           data->parent_sensitive = (gtk_widget_is_sensitive (widget) != FALSE);
9236           if (data->use_forall)
9237             gtk_container_forall (GTK_CONTAINER (widget),
9238                                   (GtkCallback) gtk_widget_propagate_state,
9239                                   data);
9240           else
9241             gtk_container_foreach (GTK_CONTAINER (widget),
9242                                    (GtkCallback) gtk_widget_propagate_state,
9243                                    data);
9244         }
9245       g_object_unref (widget);
9246     }
9247 }
9248
9249 /*
9250  * _gtk_widget_get_aux_info:
9251  * @widget: a #GtkWidget
9252  * @create: if %TRUE, create the structure if it doesn't exist
9253  *
9254  * Get the #GtkWidgetAuxInfo structure for the widget.
9255  *
9256  * Return value: the #GtkAuxInfo structure for the widget, or
9257  *    %NULL if @create is %FALSE and one doesn't already exist.
9258  */
9259 GtkWidgetAuxInfo*
9260 _gtk_widget_get_aux_info (GtkWidget *widget,
9261                           gboolean   create)
9262 {
9263   GtkWidgetAuxInfo *aux_info;
9264
9265   aux_info = g_object_get_qdata (G_OBJECT (widget), quark_aux_info);
9266   if (!aux_info && create)
9267     {
9268       aux_info = g_slice_new (GtkWidgetAuxInfo);
9269
9270       aux_info->width = -1;
9271       aux_info->height = -1;
9272       aux_info->x = 0;
9273       aux_info->y = 0;
9274       aux_info->x_set = FALSE;
9275       aux_info->y_set = FALSE;
9276       g_object_set_qdata (G_OBJECT (widget), quark_aux_info, aux_info);
9277     }
9278
9279   return aux_info;
9280 }
9281
9282 /*****************************************
9283  * gtk_widget_aux_info_destroy:
9284  *
9285  *   arguments:
9286  *
9287  *   results:
9288  *****************************************/
9289
9290 static void
9291 gtk_widget_aux_info_destroy (GtkWidgetAuxInfo *aux_info)
9292 {
9293   g_slice_free (GtkWidgetAuxInfo, aux_info);
9294 }
9295
9296 static void
9297 gtk_widget_shape_info_destroy (GtkWidgetShapeInfo *info)
9298 {
9299   g_object_unref (info->shape_mask);
9300   g_slice_free (GtkWidgetShapeInfo, info);
9301 }
9302
9303 /**
9304  * gtk_widget_shape_combine_mask:
9305  * @widget: a #GtkWidget
9306  * @shape_mask: (allow-none): shape to be added, or %NULL to remove an existing shape
9307  * @offset_x: X position of shape mask with respect to @window
9308  * @offset_y: Y position of shape mask with respect to @window
9309  *
9310  * Sets a shape for this widget's GDK window. This allows for
9311  * transparent windows etc., see gdk_window_shape_combine_mask()
9312  * for more information.
9313  **/
9314 void
9315 gtk_widget_shape_combine_mask (GtkWidget *widget,
9316                                GdkBitmap *shape_mask,
9317                                gint       offset_x,
9318                                gint       offset_y)
9319 {
9320   GtkWidgetShapeInfo* shape_info;
9321
9322   g_return_if_fail (GTK_IS_WIDGET (widget));
9323   /*  set_shape doesn't work on widgets without gdk window */
9324   g_return_if_fail (gtk_widget_get_has_window (widget));
9325
9326   if (!shape_mask)
9327     {
9328       GTK_PRIVATE_UNSET_FLAG (widget, GTK_HAS_SHAPE_MASK);
9329
9330       if (widget->window)
9331         gdk_window_shape_combine_mask (widget->window, NULL, 0, 0);
9332
9333       g_object_set_qdata (G_OBJECT (widget), quark_shape_info, NULL);
9334     }
9335   else
9336     {
9337       GTK_PRIVATE_SET_FLAG (widget, GTK_HAS_SHAPE_MASK);
9338
9339       shape_info = g_slice_new (GtkWidgetShapeInfo);
9340       g_object_set_qdata_full (G_OBJECT (widget), quark_shape_info, shape_info,
9341                                (GDestroyNotify) gtk_widget_shape_info_destroy);
9342
9343       shape_info->shape_mask = g_object_ref (shape_mask);
9344       shape_info->offset_x = offset_x;
9345       shape_info->offset_y = offset_y;
9346
9347       /* set shape if widget has a gdk window already.
9348        * otherwise the shape is scheduled to be set by gtk_widget_realize().
9349        */
9350       if (widget->window)
9351         gdk_window_shape_combine_mask (widget->window, shape_mask,
9352                                        offset_x, offset_y);
9353     }
9354 }
9355
9356 /**
9357  * gtk_widget_input_shape_combine_mask:
9358  * @widget: a #GtkWidget
9359  * @shape_mask: (allow-none): shape to be added, or %NULL to remove an existing shape
9360  * @offset_x: X position of shape mask with respect to @window
9361  * @offset_y: Y position of shape mask with respect to @window
9362  *
9363  * Sets an input shape for this widget's GDK window. This allows for
9364  * windows which react to mouse click in a nonrectangular region, see
9365  * gdk_window_input_shape_combine_mask() for more information.
9366  *
9367  * Since: 2.10
9368  **/
9369 void
9370 gtk_widget_input_shape_combine_mask (GtkWidget *widget,
9371                                      GdkBitmap *shape_mask,
9372                                      gint       offset_x,
9373                                      gint       offset_y)
9374 {
9375   GtkWidgetShapeInfo* shape_info;
9376
9377   g_return_if_fail (GTK_IS_WIDGET (widget));
9378   /*  set_shape doesn't work on widgets without gdk window */
9379   g_return_if_fail (gtk_widget_get_has_window (widget));
9380
9381   if (!shape_mask)
9382     {
9383       if (widget->window)
9384         gdk_window_input_shape_combine_mask (widget->window, NULL, 0, 0);
9385
9386       g_object_set_qdata (G_OBJECT (widget), quark_input_shape_info, NULL);
9387     }
9388   else
9389     {
9390       shape_info = g_slice_new (GtkWidgetShapeInfo);
9391       g_object_set_qdata_full (G_OBJECT (widget), quark_input_shape_info,
9392                                shape_info,
9393                                (GDestroyNotify) gtk_widget_shape_info_destroy);
9394
9395       shape_info->shape_mask = g_object_ref (shape_mask);
9396       shape_info->offset_x = offset_x;
9397       shape_info->offset_y = offset_y;
9398
9399       /* set shape if widget has a gdk window already.
9400        * otherwise the shape is scheduled to be set by gtk_widget_realize().
9401        */
9402       if (widget->window)
9403         gdk_window_input_shape_combine_mask (widget->window, shape_mask,
9404                                              offset_x, offset_y);
9405     }
9406 }
9407
9408
9409 static void
9410 gtk_reset_shapes_recurse (GtkWidget *widget,
9411                           GdkWindow *window)
9412 {
9413   gpointer data;
9414   GList *list;
9415
9416   gdk_window_get_user_data (window, &data);
9417   if (data != widget)
9418     return;
9419
9420   gdk_window_shape_combine_mask (window, NULL, 0, 0);
9421   for (list = gdk_window_peek_children (window); list; list = list->next)
9422     gtk_reset_shapes_recurse (widget, list->data);
9423 }
9424
9425 /**
9426  * gtk_widget_reset_shapes:
9427  * @widget: a #GtkWidget
9428  *
9429  * Recursively resets the shape on this widget and its descendants.
9430  **/
9431 void
9432 gtk_widget_reset_shapes (GtkWidget *widget)
9433 {
9434   g_return_if_fail (GTK_IS_WIDGET (widget));
9435   g_return_if_fail (gtk_widget_get_realized (widget));
9436
9437   if (!GTK_WIDGET_HAS_SHAPE_MASK (widget))
9438     gtk_reset_shapes_recurse (widget, widget->window);
9439 }
9440
9441 /**
9442  * gtk_widget_ref:
9443  * @widget: a #GtkWidget
9444  *
9445  * Adds a reference to a widget. This function is exactly the same
9446  * as calling g_object_ref(), and exists mostly for historical
9447  * reasons. It can still be convenient to avoid casting a widget
9448  * to a #GObject, it saves a small amount of typing.
9449  *
9450  * Return value: the widget that was referenced
9451  *
9452  * Deprecated: 2.12: Use g_object_ref() instead.
9453  **/
9454 GtkWidget*
9455 gtk_widget_ref (GtkWidget *widget)
9456 {
9457   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9458
9459   return (GtkWidget*) g_object_ref ((GObject*) widget);
9460 }
9461
9462 /**
9463  * gtk_widget_unref:
9464  * @widget: a #GtkWidget
9465  *
9466  * Inverse of gtk_widget_ref(). Equivalent to g_object_unref().
9467  *
9468  * Deprecated: 2.12: Use g_object_unref() instead.
9469  **/
9470 void
9471 gtk_widget_unref (GtkWidget *widget)
9472 {
9473   g_return_if_fail (GTK_IS_WIDGET (widget));
9474
9475   g_object_unref ((GObject*) widget);
9476 }
9477
9478 static void
9479 expose_window (GdkWindow *window)
9480 {
9481   GdkEvent event;
9482   GList *l, *children;
9483   gpointer user_data;
9484   gboolean is_double_buffered;
9485
9486   gdk_window_get_user_data (window, &user_data);
9487
9488   if (user_data)
9489     is_double_buffered = gtk_widget_get_double_buffered (GTK_WIDGET (user_data));
9490   else
9491     is_double_buffered = FALSE;
9492
9493   event.expose.type = GDK_EXPOSE;
9494   event.expose.window = g_object_ref (window);
9495   event.expose.send_event = FALSE;
9496   event.expose.count = 0;
9497   event.expose.area.x = 0;
9498   event.expose.area.y = 0;
9499   gdk_drawable_get_size (GDK_DRAWABLE (window),
9500                          &event.expose.area.width,
9501                          &event.expose.area.height);
9502   event.expose.region = gdk_region_rectangle (&event.expose.area);
9503
9504   /* If this is not double buffered, force a double buffer so that
9505      redirection works. */
9506   if (!is_double_buffered)
9507     gdk_window_begin_paint_region (window, event.expose.region);
9508
9509   gtk_main_do_event (&event);
9510
9511   if (!is_double_buffered)
9512     gdk_window_end_paint (window);
9513
9514   children = gdk_window_peek_children (window);
9515   for (l = children; l != NULL; l = l->next)
9516     {
9517       GdkWindow *child = l->data;
9518
9519       /* Don't expose input-only windows */
9520       if (gdk_drawable_get_depth (GDK_DRAWABLE (child)) != 0)
9521         expose_window (l->data);
9522     }
9523
9524   g_object_unref (window);
9525 }
9526
9527 /**
9528  * gtk_widget_get_snapshot:
9529  * @widget:    a #GtkWidget
9530  * @clip_rect: (allow-none): a #GdkRectangle or %NULL
9531  *
9532  * Create a #GdkPixmap of the contents of the widget and its children.
9533  *
9534  * Works even if the widget is obscured. The depth and visual of the
9535  * resulting pixmap is dependent on the widget being snapshot and likely
9536  * differs from those of a target widget displaying the pixmap.
9537  * The function gdk_pixbuf_get_from_drawable() can be used to convert
9538  * the pixmap to a visual independant representation.
9539  *
9540  * The snapshot area used by this function is the @widget's allocation plus
9541  * any extra space occupied by additional windows belonging to this widget
9542  * (such as the arrows of a spin button).
9543  * Thus, the resulting snapshot pixmap is possibly larger than the allocation.
9544  *
9545  * If @clip_rect is non-%NULL, the resulting pixmap is shrunken to
9546  * match the specified clip_rect. The (x,y) coordinates of @clip_rect are
9547  * interpreted widget relative. If width or height of @clip_rect are 0 or
9548  * negative, the width or height of the resulting pixmap will be shrunken
9549  * by the respective amount.
9550  * For instance a @clip_rect <literal>{ +5, +5, -10, -10 }</literal> will
9551  * chop off 5 pixels at each side of the snapshot pixmap.
9552  * If non-%NULL, @clip_rect will contain the exact widget-relative snapshot
9553  * coordinates upon return. A @clip_rect of <literal>{ -1, -1, 0, 0 }</literal>
9554  * can be used to preserve the auto-grown snapshot area and use @clip_rect
9555  * as a pure output parameter.
9556  *
9557  * The returned pixmap can be %NULL, if the resulting @clip_area was empty.
9558  *
9559  * Return value: #GdkPixmap snapshot of the widget
9560  *
9561  * Since: 2.14
9562  **/
9563 GdkPixmap*
9564 gtk_widget_get_snapshot (GtkWidget    *widget,
9565                          GdkRectangle *clip_rect)
9566 {
9567   int x, y, width, height;
9568   GdkWindow *parent_window = NULL;
9569   GdkPixmap *pixmap;
9570   GList *windows = NULL, *list;
9571
9572   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9573   if (!gtk_widget_get_visible (widget))
9574     return NULL;
9575
9576   /* the widget (and parent_window) must be realized to be drawable */
9577   if (widget->parent && !gtk_widget_get_realized (widget->parent))
9578     gtk_widget_realize (widget->parent);
9579   if (!gtk_widget_get_realized (widget))
9580     gtk_widget_realize (widget);
9581
9582   /* determine snapshot rectangle */
9583   x = widget->allocation.x;
9584   y = widget->allocation.y;
9585   width = widget->allocation.width;
9586   height = widget->allocation.height;
9587
9588   if (widget->parent && gtk_widget_get_has_window (widget))
9589     {
9590       /* grow snapshot rectangle to cover all widget windows */
9591       parent_window = gtk_widget_get_parent_window (widget);
9592       for (list = gdk_window_peek_children (parent_window); list; list = list->next)
9593         {
9594           GdkWindow *subwin = list->data;
9595           gpointer windata;
9596           int wx, wy, ww, wh;
9597           gdk_window_get_user_data (subwin, &windata);
9598           if (windata != widget)
9599             continue;
9600           windows = g_list_prepend (windows, subwin);
9601           gdk_window_get_position (subwin, &wx, &wy);
9602           gdk_drawable_get_size (subwin, &ww, &wh);
9603           /* grow snapshot rectangle by extra widget sub window */
9604           if (wx < x)
9605             {
9606               width += x - wx;
9607               x = wx;
9608             }
9609           if (wy < y)
9610             {
9611               height += y - wy;
9612               y = wy;
9613             }
9614           if (x + width < wx + ww)
9615             width += wx + ww - (x + width);
9616           if (y + height < wy + wh)
9617             height += wy + wh - (y + height);
9618         }
9619     }
9620   else if (!widget->parent)
9621     x = y = 0; /* toplevel */
9622
9623   /* at this point, (x,y,width,height) is the parent_window relative
9624    * snapshot area covering all of widget's windows.
9625    */
9626
9627   /* shrink snapshot size by clip_rectangle */
9628   if (clip_rect)
9629     {
9630       GdkRectangle snap = { x, y, width, height }, clip = *clip_rect;
9631       clip.x = clip.x < 0 ? x : clip.x;
9632       clip.y = clip.y < 0 ? y : clip.y;
9633       clip.width = clip.width <= 0 ? MAX (0, width + clip.width) : clip.width;
9634       clip.height = clip.height <= 0 ? MAX (0, height + clip.height) : clip.height;
9635       if (widget->parent)
9636         {
9637           /* offset clip_rect, so it's parent_window relative */
9638           if (clip_rect->x >= 0)
9639             clip.x += widget->allocation.x;
9640           if (clip_rect->y >= 0)
9641             clip.y += widget->allocation.y;
9642         }
9643       if (!gdk_rectangle_intersect (&snap, &clip, &snap))
9644         {
9645           g_list_free (windows);
9646           clip_rect->width = clip_rect->height = 0;
9647           return NULL; /* empty snapshot area */
9648         }
9649       x = snap.x;
9650       y = snap.y;
9651       width = snap.width;
9652       height = snap.height;
9653     }
9654
9655   /* render snapshot */
9656   pixmap = gdk_pixmap_new (widget->window, width, height, gdk_drawable_get_depth (widget->window));
9657   for (list = windows; list; list = list->next) /* !NO_WINDOW widgets */
9658     {
9659       GdkWindow *subwin = list->data;
9660       int wx, wy;
9661       if (gdk_drawable_get_depth (GDK_DRAWABLE (subwin)) == 0)
9662         continue; /* Input only window */
9663       gdk_window_get_position (subwin, &wx, &wy);
9664       gdk_window_redirect_to_drawable (subwin, pixmap, MAX (0, x - wx), MAX (0, y - wy),
9665                                        MAX (0, wx - x), MAX (0, wy - y), width, height);
9666
9667       expose_window (subwin);
9668     }
9669   if (!windows) /* NO_WINDOW || toplevel => parent_window == NULL || parent_window == widget->window */
9670     {
9671       gdk_window_redirect_to_drawable (widget->window, pixmap, x, y, 0, 0, width, height);
9672       expose_window (widget->window);
9673     }
9674   for (list = windows; list; list = list->next)
9675     gdk_window_remove_redirection (list->data);
9676   if (!windows) /* NO_WINDOW || toplevel */
9677     gdk_window_remove_redirection (widget->window);
9678   g_list_free (windows);
9679
9680   /* return pixmap and snapshot rectangle coordinates */
9681   if (clip_rect)
9682     {
9683       clip_rect->x = x;
9684       clip_rect->y = y;
9685       clip_rect->width = width;
9686       clip_rect->height = height;
9687       if (widget->parent)
9688         {
9689           /* offset clip_rect from parent_window so it's widget relative */
9690           clip_rect->x -= widget->allocation.x;
9691           clip_rect->y -= widget->allocation.y;
9692         }
9693       if (0)
9694         g_printerr ("gtk_widget_get_snapshot: %s (%d,%d, %dx%d)\n",
9695                     G_OBJECT_TYPE_NAME (widget),
9696                     clip_rect->x, clip_rect->y, clip_rect->width, clip_rect->height);
9697     }
9698   return pixmap;
9699 }
9700
9701 /* style properties
9702  */
9703
9704 /**
9705  * gtk_widget_class_install_style_property_parser:
9706  * @klass: a #GtkWidgetClass
9707  * @pspec: the #GParamSpec for the style property
9708  * @parser: the parser for the style property
9709  *
9710  * Installs a style property on a widget class.
9711  **/
9712 void
9713 gtk_widget_class_install_style_property_parser (GtkWidgetClass     *klass,
9714                                                 GParamSpec         *pspec,
9715                                                 GtkRcPropertyParser parser)
9716 {
9717   g_return_if_fail (GTK_IS_WIDGET_CLASS (klass));
9718   g_return_if_fail (G_IS_PARAM_SPEC (pspec));
9719   g_return_if_fail (pspec->flags & G_PARAM_READABLE);
9720   g_return_if_fail (!(pspec->flags & (G_PARAM_CONSTRUCT_ONLY | G_PARAM_CONSTRUCT)));
9721
9722   if (g_param_spec_pool_lookup (style_property_spec_pool, pspec->name, G_OBJECT_CLASS_TYPE (klass), FALSE))
9723     {
9724       g_warning (G_STRLOC ": class `%s' already contains a style property named `%s'",
9725                  G_OBJECT_CLASS_NAME (klass),
9726                  pspec->name);
9727       return;
9728     }
9729
9730   g_param_spec_ref_sink (pspec);
9731   g_param_spec_set_qdata (pspec, quark_property_parser, (gpointer) parser);
9732   g_param_spec_pool_insert (style_property_spec_pool, pspec, G_OBJECT_CLASS_TYPE (klass));
9733 }
9734
9735 /**
9736  * gtk_widget_class_install_style_property:
9737  * @klass: a #GtkWidgetClass
9738  * @pspec: the #GParamSpec for the property
9739  *
9740  * Installs a style property on a widget class. The parser for the
9741  * style property is determined by the value type of @pspec.
9742  **/
9743 void
9744 gtk_widget_class_install_style_property (GtkWidgetClass *klass,
9745                                          GParamSpec     *pspec)
9746 {
9747   GtkRcPropertyParser parser;
9748
9749   g_return_if_fail (GTK_IS_WIDGET_CLASS (klass));
9750   g_return_if_fail (G_IS_PARAM_SPEC (pspec));
9751
9752   parser = _gtk_rc_property_parser_from_type (G_PARAM_SPEC_VALUE_TYPE (pspec));
9753
9754   gtk_widget_class_install_style_property_parser (klass, pspec, parser);
9755 }
9756
9757 /**
9758  * gtk_widget_class_find_style_property:
9759  * @klass: a #GtkWidgetClass
9760  * @property_name: the name of the style property to find
9761  * @returns: (allow-none): the #GParamSpec of the style property or %NULL if @class has no
9762  *   style property with that name.
9763  *
9764  * Finds a style property of a widget class by name.
9765  *
9766  * Since: 2.2
9767  */
9768 GParamSpec*
9769 gtk_widget_class_find_style_property (GtkWidgetClass *klass,
9770                                       const gchar    *property_name)
9771 {
9772   g_return_val_if_fail (property_name != NULL, NULL);
9773
9774   return g_param_spec_pool_lookup (style_property_spec_pool,
9775                                    property_name,
9776                                    G_OBJECT_CLASS_TYPE (klass),
9777                                    TRUE);
9778 }
9779
9780 /**
9781  * gtk_widget_class_list_style_properties:
9782  * @klass: a #GtkWidgetClass
9783  * @n_properties: location to return the number of style properties found
9784  * @returns: an newly allocated array of #GParamSpec*. The array must
9785  *       be freed with g_free().
9786  *
9787  * Returns all style properties of a widget class.
9788  *
9789  * Since: 2.2
9790  */
9791 GParamSpec**
9792 gtk_widget_class_list_style_properties (GtkWidgetClass *klass,
9793                                         guint          *n_properties)
9794 {
9795   GParamSpec **pspecs;
9796   guint n;
9797
9798   pspecs = g_param_spec_pool_list (style_property_spec_pool,
9799                                    G_OBJECT_CLASS_TYPE (klass),
9800                                    &n);
9801   if (n_properties)
9802     *n_properties = n;
9803
9804   return pspecs;
9805 }
9806
9807 /**
9808  * gtk_widget_style_get_property:
9809  * @widget: a #GtkWidget
9810  * @property_name: the name of a style property
9811  * @value: location to return the property value
9812  *
9813  * Gets the value of a style property of @widget.
9814  */
9815 void
9816 gtk_widget_style_get_property (GtkWidget   *widget,
9817                                const gchar *property_name,
9818                                GValue      *value)
9819 {
9820   GParamSpec *pspec;
9821
9822   g_return_if_fail (GTK_IS_WIDGET (widget));
9823   g_return_if_fail (property_name != NULL);
9824   g_return_if_fail (G_IS_VALUE (value));
9825
9826   g_object_ref (widget);
9827   pspec = g_param_spec_pool_lookup (style_property_spec_pool,
9828                                     property_name,
9829                                     G_OBJECT_TYPE (widget),
9830                                     TRUE);
9831   if (!pspec)
9832     g_warning ("%s: widget class `%s' has no property named `%s'",
9833                G_STRLOC,
9834                G_OBJECT_TYPE_NAME (widget),
9835                property_name);
9836   else
9837     {
9838       const GValue *peek_value;
9839
9840       peek_value = _gtk_style_peek_property_value (widget->style,
9841                                                    G_OBJECT_TYPE (widget),
9842                                                    pspec,
9843                                                    (GtkRcPropertyParser) g_param_spec_get_qdata (pspec, quark_property_parser));
9844
9845       /* auto-conversion of the caller's value type
9846        */
9847       if (G_VALUE_TYPE (value) == G_PARAM_SPEC_VALUE_TYPE (pspec))
9848         g_value_copy (peek_value, value);
9849       else if (g_value_type_transformable (G_PARAM_SPEC_VALUE_TYPE (pspec), G_VALUE_TYPE (value)))
9850         g_value_transform (peek_value, value);
9851       else
9852         g_warning ("can't retrieve style property `%s' of type `%s' as value of type `%s'",
9853                    pspec->name,
9854                    g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
9855                    G_VALUE_TYPE_NAME (value));
9856     }
9857   g_object_unref (widget);
9858 }
9859
9860 /**
9861  * gtk_widget_style_get_valist:
9862  * @widget: a #GtkWidget
9863  * @first_property_name: the name of the first property to get
9864  * @var_args: a <type>va_list</type> of pairs of property names and
9865  *     locations to return the property values, starting with the location
9866  *     for @first_property_name.
9867  *
9868  * Non-vararg variant of gtk_widget_style_get(). Used primarily by language
9869  * bindings.
9870  */
9871 void
9872 gtk_widget_style_get_valist (GtkWidget   *widget,
9873                              const gchar *first_property_name,
9874                              va_list      var_args)
9875 {
9876   const gchar *name;
9877
9878   g_return_if_fail (GTK_IS_WIDGET (widget));
9879
9880   g_object_ref (widget);
9881
9882   name = first_property_name;
9883   while (name)
9884     {
9885       const GValue *peek_value;
9886       GParamSpec *pspec;
9887       gchar *error;
9888
9889       pspec = g_param_spec_pool_lookup (style_property_spec_pool,
9890                                         name,
9891                                         G_OBJECT_TYPE (widget),
9892                                         TRUE);
9893       if (!pspec)
9894         {
9895           g_warning ("%s: widget class `%s' has no property named `%s'",
9896                      G_STRLOC,
9897                      G_OBJECT_TYPE_NAME (widget),
9898                      name);
9899           break;
9900         }
9901       /* style pspecs are always readable so we can spare that check here */
9902
9903       peek_value = _gtk_style_peek_property_value (widget->style,
9904                                                    G_OBJECT_TYPE (widget),
9905                                                    pspec,
9906                                                    (GtkRcPropertyParser) g_param_spec_get_qdata (pspec, quark_property_parser));
9907       G_VALUE_LCOPY (peek_value, var_args, 0, &error);
9908       if (error)
9909         {
9910           g_warning ("%s: %s", G_STRLOC, error);
9911           g_free (error);
9912           break;
9913         }
9914
9915       name = va_arg (var_args, gchar*);
9916     }
9917
9918   g_object_unref (widget);
9919 }
9920
9921 /**
9922  * gtk_widget_style_get:
9923  * @widget: a #GtkWidget
9924  * @first_property_name: the name of the first property to get
9925  * @Varargs: pairs of property names and locations to
9926  *   return the property values, starting with the location for
9927  *   @first_property_name, terminated by %NULL.
9928  *
9929  * Gets the values of a multiple style properties of @widget.
9930  */
9931 void
9932 gtk_widget_style_get (GtkWidget   *widget,
9933                       const gchar *first_property_name,
9934                       ...)
9935 {
9936   va_list var_args;
9937
9938   g_return_if_fail (GTK_IS_WIDGET (widget));
9939
9940   va_start (var_args, first_property_name);
9941   gtk_widget_style_get_valist (widget, first_property_name, var_args);
9942   va_end (var_args);
9943 }
9944
9945 /**
9946  * gtk_widget_path:
9947  * @widget: a #GtkWidget
9948  * @path_length: (out) (allow-none): location to store length of the path, or %NULL
9949  * @path: (out) (allow-none):  location to store allocated path string, or %NULL
9950  * @path_reversed: (out) (allow-none):  location to store allocated reverse path string, or %NULL
9951  *
9952  * Obtains the full path to @widget. The path is simply the name of a
9953  * widget and all its parents in the container hierarchy, separated by
9954  * periods. The name of a widget comes from
9955  * gtk_widget_get_name(). Paths are used to apply styles to a widget
9956  * in gtkrc configuration files. Widget names are the type of the
9957  * widget by default (e.g. "GtkButton") or can be set to an
9958  * application-specific value with gtk_widget_set_name(). By setting
9959  * the name of a widget, you allow users or theme authors to apply
9960  * styles to that specific widget in their gtkrc
9961  * file. @path_reversed_p fills in the path in reverse order,
9962  * i.e. starting with @widget's name instead of starting with the name
9963  * of @widget's outermost ancestor.
9964  **/
9965 void
9966 gtk_widget_path (GtkWidget *widget,
9967                  guint     *path_length,
9968                  gchar    **path,
9969                  gchar    **path_reversed)
9970 {
9971   static gchar *rev_path = NULL;
9972   static guint tmp_path_len = 0;
9973   guint len;
9974
9975   g_return_if_fail (GTK_IS_WIDGET (widget));
9976
9977   len = 0;
9978   do
9979     {
9980       const gchar *string;
9981       const gchar *s;
9982       gchar *d;
9983       guint l;
9984
9985       string = gtk_widget_get_name (widget);
9986       l = strlen (string);
9987       while (tmp_path_len <= len + l + 1)
9988         {
9989           tmp_path_len += INIT_PATH_SIZE;
9990           rev_path = g_realloc (rev_path, tmp_path_len);
9991         }
9992       s = string + l - 1;
9993       d = rev_path + len;
9994       while (s >= string)
9995         *(d++) = *(s--);
9996       len += l;
9997
9998       widget = widget->parent;
9999
10000       if (widget)
10001         rev_path[len++] = '.';
10002       else
10003         rev_path[len++] = 0;
10004     }
10005   while (widget);
10006
10007   if (path_length)
10008     *path_length = len - 1;
10009   if (path_reversed)
10010     *path_reversed = g_strdup (rev_path);
10011   if (path)
10012     {
10013       *path = g_strdup (rev_path);
10014       g_strreverse (*path);
10015     }
10016 }
10017
10018 /**
10019  * gtk_widget_class_path:
10020  * @widget: a #GtkWidget
10021  * @path_length: (out) (allow-none): location to store the length of the class path, or %NULL
10022  * @path: (out) (allow-none) location to store the class path as an allocated string, or %NULL
10023  * @path_reversed: (out) (allow-none) location to store the reverse class path as an allocated
10024  *    string, or %NULL
10025  *
10026  * Same as gtk_widget_path(), but always uses the name of a widget's type,
10027  * never uses a custom name set with gtk_widget_set_name().
10028  *
10029  **/
10030 void
10031 gtk_widget_class_path (GtkWidget *widget,
10032                        guint     *path_length,
10033                        gchar    **path,
10034                        gchar    **path_reversed)
10035 {
10036   static gchar *rev_path = NULL;
10037   static guint tmp_path_len = 0;
10038   guint len;
10039
10040   g_return_if_fail (GTK_IS_WIDGET (widget));
10041
10042   len = 0;
10043   do
10044     {
10045       const gchar *string;
10046       const gchar *s;
10047       gchar *d;
10048       guint l;
10049
10050       string = g_type_name (G_OBJECT_TYPE (widget));
10051       l = strlen (string);
10052       while (tmp_path_len <= len + l + 1)
10053         {
10054           tmp_path_len += INIT_PATH_SIZE;
10055           rev_path = g_realloc (rev_path, tmp_path_len);
10056         }
10057       s = string + l - 1;
10058       d = rev_path + len;
10059       while (s >= string)
10060         *(d++) = *(s--);
10061       len += l;
10062
10063       widget = widget->parent;
10064
10065       if (widget)
10066         rev_path[len++] = '.';
10067       else
10068         rev_path[len++] = 0;
10069     }
10070   while (widget);
10071
10072   if (path_length)
10073     *path_length = len - 1;
10074   if (path_reversed)
10075     *path_reversed = g_strdup (rev_path);
10076   if (path)
10077     {
10078       *path = g_strdup (rev_path);
10079       g_strreverse (*path);
10080     }
10081 }
10082
10083 /**
10084  * gtk_requisition_copy:
10085  * @requisition: a #GtkRequisition
10086  *
10087  * Copies a #GtkRequisition.
10088  *
10089  * Returns: a copy of @requisition
10090  **/
10091 GtkRequisition *
10092 gtk_requisition_copy (const GtkRequisition *requisition)
10093 {
10094   return (GtkRequisition *)g_memdup (requisition, sizeof (GtkRequisition));
10095 }
10096
10097 /**
10098  * gtk_requisition_free:
10099  * @requisition: a #GtkRequisition
10100  *
10101  * Frees a #GtkRequisition.
10102  **/
10103 void
10104 gtk_requisition_free (GtkRequisition *requisition)
10105 {
10106   g_free (requisition);
10107 }
10108
10109 GType
10110 gtk_requisition_get_type (void)
10111 {
10112   static GType our_type = 0;
10113
10114   if (our_type == 0)
10115     our_type = g_boxed_type_register_static (I_("GtkRequisition"),
10116                                              (GBoxedCopyFunc) gtk_requisition_copy,
10117                                              (GBoxedFreeFunc) gtk_requisition_free);
10118
10119   return our_type;
10120 }
10121
10122 /**
10123  * gtk_widget_get_accessible:
10124  * @widget: a #GtkWidget
10125  *
10126  * Returns the accessible object that describes the widget to an
10127  * assistive technology.
10128  *
10129  * If no accessibility library is loaded (i.e. no ATK implementation library is
10130  * loaded via <envar>GTK_MODULES</envar> or via another application library,
10131  * such as libgnome), then this #AtkObject instance may be a no-op. Likewise,
10132  * if no class-specific #AtkObject implementation is available for the widget
10133  * instance in question, it will inherit an #AtkObject implementation from the
10134  * first ancestor class for which such an implementation is defined.
10135  *
10136  * The documentation of the <ulink url="http://developer.gnome.org/doc/API/2.0/atk/index.html">ATK</ulink>
10137  * library contains more information about accessible objects and their uses.
10138  *
10139  * Returns: (transfer none): the #AtkObject associated with @widget
10140  */
10141 AtkObject*
10142 gtk_widget_get_accessible (GtkWidget *widget)
10143 {
10144   GtkWidgetClass *klass;
10145
10146   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10147
10148   klass = GTK_WIDGET_GET_CLASS (widget);
10149
10150   g_return_val_if_fail (klass->get_accessible != NULL, NULL);
10151
10152   return klass->get_accessible (widget);
10153 }
10154
10155 static AtkObject*
10156 gtk_widget_real_get_accessible (GtkWidget *widget)
10157 {
10158   AtkObject* accessible;
10159
10160   accessible = g_object_get_qdata (G_OBJECT (widget),
10161                                    quark_accessible_object);
10162   if (!accessible)
10163   {
10164     AtkObjectFactory *factory;
10165     AtkRegistry *default_registry;
10166
10167     default_registry = atk_get_default_registry ();
10168     factory = atk_registry_get_factory (default_registry,
10169                                         G_TYPE_FROM_INSTANCE (widget));
10170     accessible =
10171       atk_object_factory_create_accessible (factory,
10172                                             G_OBJECT (widget));
10173     g_object_set_qdata (G_OBJECT (widget),
10174                         quark_accessible_object,
10175                         accessible);
10176   }
10177   return accessible;
10178 }
10179
10180 /*
10181  * Initialize a AtkImplementorIface instance's virtual pointers as
10182  * appropriate to this implementor's class (GtkWidget).
10183  */
10184 static void
10185 gtk_widget_accessible_interface_init (AtkImplementorIface *iface)
10186 {
10187   iface->ref_accessible = gtk_widget_ref_accessible;
10188 }
10189
10190 static AtkObject*
10191 gtk_widget_ref_accessible (AtkImplementor *implementor)
10192 {
10193   AtkObject *accessible;
10194
10195   accessible = gtk_widget_get_accessible (GTK_WIDGET (implementor));
10196   if (accessible)
10197     g_object_ref (accessible);
10198   return accessible;
10199 }
10200
10201 /*
10202  * GtkBuildable implementation
10203  */
10204 static GQuark            quark_builder_has_default = 0;
10205 static GQuark            quark_builder_has_focus = 0;
10206 static GQuark            quark_builder_atk_relations = 0;
10207 static GQuark            quark_builder_set_name = 0;
10208
10209 static void
10210 gtk_widget_buildable_interface_init (GtkBuildableIface *iface)
10211 {
10212   quark_builder_has_default = g_quark_from_static_string ("gtk-builder-has-default");
10213   quark_builder_has_focus = g_quark_from_static_string ("gtk-builder-has-focus");
10214   quark_builder_atk_relations = g_quark_from_static_string ("gtk-builder-atk-relations");
10215   quark_builder_set_name = g_quark_from_static_string ("gtk-builder-set-name");
10216
10217   iface->set_name = gtk_widget_buildable_set_name;
10218   iface->get_name = gtk_widget_buildable_get_name;
10219   iface->get_internal_child = gtk_widget_buildable_get_internal_child;
10220   iface->set_buildable_property = gtk_widget_buildable_set_buildable_property;
10221   iface->parser_finished = gtk_widget_buildable_parser_finished;
10222   iface->custom_tag_start = gtk_widget_buildable_custom_tag_start;
10223   iface->custom_finished = gtk_widget_buildable_custom_finished;
10224 }
10225
10226 static void
10227 gtk_widget_buildable_set_name (GtkBuildable *buildable,
10228                                const gchar  *name)
10229 {
10230   g_object_set_qdata_full (G_OBJECT (buildable), quark_builder_set_name,
10231                            g_strdup (name), g_free);
10232 }
10233
10234 static const gchar *
10235 gtk_widget_buildable_get_name (GtkBuildable *buildable)
10236 {
10237   return g_object_get_qdata (G_OBJECT (buildable), quark_builder_set_name);
10238 }
10239
10240 static GObject *
10241 gtk_widget_buildable_get_internal_child (GtkBuildable *buildable,
10242                                          GtkBuilder   *builder,
10243                                          const gchar  *childname)
10244 {
10245   if (strcmp (childname, "accessible") == 0)
10246     return G_OBJECT (gtk_widget_get_accessible (GTK_WIDGET (buildable)));
10247
10248   return NULL;
10249 }
10250
10251 static void
10252 gtk_widget_buildable_set_buildable_property (GtkBuildable *buildable,
10253                                              GtkBuilder   *builder,
10254                                              const gchar  *name,
10255                                              const GValue *value)
10256 {
10257   if (strcmp (name, "has-default") == 0 && g_value_get_boolean (value))
10258       g_object_set_qdata (G_OBJECT (buildable), quark_builder_has_default,
10259                           GINT_TO_POINTER (TRUE));
10260   else if (strcmp (name, "has-focus") == 0 && g_value_get_boolean (value))
10261       g_object_set_qdata (G_OBJECT (buildable), quark_builder_has_focus,
10262                           GINT_TO_POINTER (TRUE));
10263   else
10264     g_object_set_property (G_OBJECT (buildable), name, value);
10265 }
10266
10267 typedef struct
10268 {
10269   gchar *action_name;
10270   GString *description;
10271   gchar *context;
10272   gboolean translatable;
10273 } AtkActionData;
10274
10275 typedef struct
10276 {
10277   gchar *target;
10278   gchar *type;
10279 } AtkRelationData;
10280
10281 static void
10282 free_action (AtkActionData *data, gpointer user_data)
10283 {
10284   g_free (data->action_name);
10285   g_string_free (data->description, TRUE);
10286   g_free (data->context);
10287   g_slice_free (AtkActionData, data);
10288 }
10289
10290 static void
10291 free_relation (AtkRelationData *data, gpointer user_data)
10292 {
10293   g_free (data->target);
10294   g_free (data->type);
10295   g_slice_free (AtkRelationData, data);
10296 }
10297
10298 static void
10299 gtk_widget_buildable_parser_finished (GtkBuildable *buildable,
10300                                       GtkBuilder   *builder)
10301 {
10302   GSList *atk_relations;
10303
10304   if (g_object_get_qdata (G_OBJECT (buildable), quark_builder_has_default))
10305     gtk_widget_grab_default (GTK_WIDGET (buildable));
10306   if (g_object_get_qdata (G_OBJECT (buildable), quark_builder_has_focus))
10307     gtk_widget_grab_focus (GTK_WIDGET (buildable));
10308
10309   atk_relations = g_object_get_qdata (G_OBJECT (buildable),
10310                                       quark_builder_atk_relations);
10311   if (atk_relations)
10312     {
10313       AtkObject *accessible;
10314       AtkRelationSet *relation_set;
10315       GSList *l;
10316       GObject *target;
10317       AtkRelationType relation_type;
10318       AtkObject *target_accessible;
10319
10320       accessible = gtk_widget_get_accessible (GTK_WIDGET (buildable));
10321       relation_set = atk_object_ref_relation_set (accessible);
10322
10323       for (l = atk_relations; l; l = l->next)
10324         {
10325           AtkRelationData *relation = (AtkRelationData*)l->data;
10326
10327           target = gtk_builder_get_object (builder, relation->target);
10328           if (!target)
10329             {
10330               g_warning ("Target object %s in <relation> does not exist",
10331                          relation->target);
10332               continue;
10333             }
10334           target_accessible = gtk_widget_get_accessible (GTK_WIDGET (target));
10335           g_assert (target_accessible != NULL);
10336
10337           relation_type = atk_relation_type_for_name (relation->type);
10338           if (relation_type == ATK_RELATION_NULL)
10339             {
10340               g_warning ("<relation> type %s not found",
10341                          relation->type);
10342               continue;
10343             }
10344           atk_relation_set_add_relation_by_type (relation_set, relation_type,
10345                                                  target_accessible);
10346         }
10347       g_object_unref (relation_set);
10348
10349       g_slist_foreach (atk_relations, (GFunc)free_relation, NULL);
10350       g_slist_free (atk_relations);
10351       g_object_set_qdata (G_OBJECT (buildable), quark_builder_atk_relations,
10352                           NULL);
10353     }
10354 }
10355
10356 typedef struct
10357 {
10358   GSList *actions;
10359   GSList *relations;
10360 } AccessibilitySubParserData;
10361
10362 static void
10363 accessibility_start_element (GMarkupParseContext  *context,
10364                              const gchar          *element_name,
10365                              const gchar         **names,
10366                              const gchar         **values,
10367                              gpointer              user_data,
10368                              GError              **error)
10369 {
10370   AccessibilitySubParserData *data = (AccessibilitySubParserData*)user_data;
10371   guint i;
10372   gint line_number, char_number;
10373
10374   if (strcmp (element_name, "relation") == 0)
10375     {
10376       gchar *target = NULL;
10377       gchar *type = NULL;
10378       AtkRelationData *relation;
10379
10380       for (i = 0; names[i]; i++)
10381         {
10382           if (strcmp (names[i], "target") == 0)
10383             target = g_strdup (values[i]);
10384           else if (strcmp (names[i], "type") == 0)
10385             type = g_strdup (values[i]);
10386           else
10387             {
10388               g_markup_parse_context_get_position (context,
10389                                                    &line_number,
10390                                                    &char_number);
10391               g_set_error (error,
10392                            GTK_BUILDER_ERROR,
10393                            GTK_BUILDER_ERROR_INVALID_ATTRIBUTE,
10394                            "%s:%d:%d '%s' is not a valid attribute of <%s>",
10395                            "<input>",
10396                            line_number, char_number, names[i], "relation");
10397               g_free (target);
10398               g_free (type);
10399               return;
10400             }
10401         }
10402
10403       if (!target || !type)
10404         {
10405           g_markup_parse_context_get_position (context,
10406                                                &line_number,
10407                                                &char_number);
10408           g_set_error (error,
10409                        GTK_BUILDER_ERROR,
10410                        GTK_BUILDER_ERROR_MISSING_ATTRIBUTE,
10411                        "%s:%d:%d <%s> requires attribute \"%s\"",
10412                        "<input>",
10413                        line_number, char_number, "relation",
10414                        type ? "target" : "type");
10415           g_free (target);
10416           g_free (type);
10417           return;
10418         }
10419
10420       relation = g_slice_new (AtkRelationData);
10421       relation->target = target;
10422       relation->type = type;
10423
10424       data->relations = g_slist_prepend (data->relations, relation);
10425     }
10426   else if (strcmp (element_name, "action") == 0)
10427     {
10428       const gchar *action_name = NULL;
10429       const gchar *description = NULL;
10430       const gchar *msg_context = NULL;
10431       gboolean translatable = FALSE;
10432       AtkActionData *action;
10433
10434       for (i = 0; names[i]; i++)
10435         {
10436           if (strcmp (names[i], "action_name") == 0)
10437             action_name = values[i];
10438           else if (strcmp (names[i], "description") == 0)
10439             description = values[i];
10440           else if (strcmp (names[i], "translatable") == 0)
10441             {
10442               if (!_gtk_builder_boolean_from_string (values[i], &translatable, error))
10443                 return;
10444             }
10445           else if (strcmp (names[i], "comments") == 0)
10446             {
10447               /* do nothing, comments are for translators */
10448             }
10449           else if (strcmp (names[i], "context") == 0)
10450             msg_context = values[i];
10451           else
10452             {
10453               g_markup_parse_context_get_position (context,
10454                                                    &line_number,
10455                                                    &char_number);
10456               g_set_error (error,
10457                            GTK_BUILDER_ERROR,
10458                            GTK_BUILDER_ERROR_INVALID_ATTRIBUTE,
10459                            "%s:%d:%d '%s' is not a valid attribute of <%s>",
10460                            "<input>",
10461                            line_number, char_number, names[i], "action");
10462               return;
10463             }
10464         }
10465
10466       if (!action_name)
10467         {
10468           g_markup_parse_context_get_position (context,
10469                                                &line_number,
10470                                                &char_number);
10471           g_set_error (error,
10472                        GTK_BUILDER_ERROR,
10473                        GTK_BUILDER_ERROR_MISSING_ATTRIBUTE,
10474                        "%s:%d:%d <%s> requires attribute \"%s\"",
10475                        "<input>",
10476                        line_number, char_number, "action",
10477                        "action_name");
10478           return;
10479         }
10480
10481       action = g_slice_new (AtkActionData);
10482       action->action_name = g_strdup (action_name);
10483       action->description = g_string_new (description);
10484       action->context = g_strdup (msg_context);
10485       action->translatable = translatable;
10486
10487       data->actions = g_slist_prepend (data->actions, action);
10488     }
10489   else if (strcmp (element_name, "accessibility") == 0)
10490     ;
10491   else
10492     g_warning ("Unsupported tag for GtkWidget: %s\n", element_name);
10493 }
10494
10495 static void
10496 accessibility_text (GMarkupParseContext  *context,
10497                     const gchar          *text,
10498                     gsize                 text_len,
10499                     gpointer              user_data,
10500                     GError              **error)
10501 {
10502   AccessibilitySubParserData *data = (AccessibilitySubParserData*)user_data;
10503
10504   if (strcmp (g_markup_parse_context_get_element (context), "action") == 0)
10505     {
10506       AtkActionData *action = data->actions->data;
10507
10508       g_string_append_len (action->description, text, text_len);
10509     }
10510 }
10511
10512 static const GMarkupParser accessibility_parser =
10513   {
10514     accessibility_start_element,
10515     NULL,
10516     accessibility_text,
10517   };
10518
10519 typedef struct
10520 {
10521   GObject *object;
10522   guint    key;
10523   guint    modifiers;
10524   gchar   *signal;
10525 } AccelGroupParserData;
10526
10527 static void
10528 accel_group_start_element (GMarkupParseContext  *context,
10529                            const gchar          *element_name,
10530                            const gchar         **names,
10531                            const gchar         **values,
10532                            gpointer              user_data,
10533                            GError              **error)
10534 {
10535   gint i;
10536   guint key = 0;
10537   guint modifiers = 0;
10538   gchar *signal = NULL;
10539   AccelGroupParserData *parser_data = (AccelGroupParserData*)user_data;
10540
10541   for (i = 0; names[i]; i++)
10542     {
10543       if (strcmp (names[i], "key") == 0)
10544         key = gdk_keyval_from_name (values[i]);
10545       else if (strcmp (names[i], "modifiers") == 0)
10546         {
10547           if (!_gtk_builder_flags_from_string (GDK_TYPE_MODIFIER_TYPE,
10548                                                values[i],
10549                                                &modifiers,
10550                                                error))
10551               return;
10552         }
10553       else if (strcmp (names[i], "signal") == 0)
10554         signal = g_strdup (values[i]);
10555     }
10556
10557   if (key == 0 || signal == NULL)
10558     {
10559       g_warning ("<accelerator> requires key and signal attributes");
10560       return;
10561     }
10562   parser_data->key = key;
10563   parser_data->modifiers = modifiers;
10564   parser_data->signal = signal;
10565 }
10566
10567 static const GMarkupParser accel_group_parser =
10568   {
10569     accel_group_start_element,
10570   };
10571
10572 static gboolean
10573 gtk_widget_buildable_custom_tag_start (GtkBuildable     *buildable,
10574                                        GtkBuilder       *builder,
10575                                        GObject          *child,
10576                                        const gchar      *tagname,
10577                                        GMarkupParser    *parser,
10578                                        gpointer         *data)
10579 {
10580   g_assert (buildable);
10581
10582   if (strcmp (tagname, "accelerator") == 0)
10583     {
10584       AccelGroupParserData *parser_data;
10585
10586       parser_data = g_slice_new0 (AccelGroupParserData);
10587       parser_data->object = g_object_ref (buildable);
10588       *parser = accel_group_parser;
10589       *data = parser_data;
10590       return TRUE;
10591     }
10592   if (strcmp (tagname, "accessibility") == 0)
10593     {
10594       AccessibilitySubParserData *parser_data;
10595
10596       parser_data = g_slice_new0 (AccessibilitySubParserData);
10597       *parser = accessibility_parser;
10598       *data = parser_data;
10599       return TRUE;
10600     }
10601   return FALSE;
10602 }
10603
10604 void
10605 _gtk_widget_buildable_finish_accelerator (GtkWidget *widget,
10606                                           GtkWidget *toplevel,
10607                                           gpointer   user_data)
10608 {
10609   AccelGroupParserData *accel_data;
10610   GSList *accel_groups;
10611   GtkAccelGroup *accel_group;
10612
10613   g_return_if_fail (GTK_IS_WIDGET (widget));
10614   g_return_if_fail (GTK_IS_WIDGET (toplevel));
10615   g_return_if_fail (user_data != NULL);
10616
10617   accel_data = (AccelGroupParserData*)user_data;
10618   accel_groups = gtk_accel_groups_from_object (G_OBJECT (toplevel));
10619   if (g_slist_length (accel_groups) == 0)
10620     {
10621       accel_group = gtk_accel_group_new ();
10622       gtk_window_add_accel_group (GTK_WINDOW (toplevel), accel_group);
10623     }
10624   else
10625     {
10626       g_assert (g_slist_length (accel_groups) == 1);
10627       accel_group = g_slist_nth_data (accel_groups, 0);
10628     }
10629
10630   gtk_widget_add_accelerator (GTK_WIDGET (accel_data->object),
10631                               accel_data->signal,
10632                               accel_group,
10633                               accel_data->key,
10634                               accel_data->modifiers,
10635                               GTK_ACCEL_VISIBLE);
10636
10637   g_object_unref (accel_data->object);
10638   g_free (accel_data->signal);
10639   g_slice_free (AccelGroupParserData, accel_data);
10640 }
10641
10642 static void
10643 gtk_widget_buildable_custom_finished (GtkBuildable *buildable,
10644                                       GtkBuilder   *builder,
10645                                       GObject      *child,
10646                                       const gchar  *tagname,
10647                                       gpointer      user_data)
10648 {
10649   AccelGroupParserData *accel_data;
10650   AccessibilitySubParserData *a11y_data;
10651   GtkWidget *toplevel;
10652
10653   if (strcmp (tagname, "accelerator") == 0)
10654     {
10655       accel_data = (AccelGroupParserData*)user_data;
10656       g_assert (accel_data->object);
10657
10658       toplevel = gtk_widget_get_toplevel (GTK_WIDGET (accel_data->object));
10659
10660       _gtk_widget_buildable_finish_accelerator (GTK_WIDGET (buildable), toplevel, user_data);
10661     }
10662   else if (strcmp (tagname, "accessibility") == 0)
10663     {
10664       a11y_data = (AccessibilitySubParserData*)user_data;
10665
10666       if (a11y_data->actions)
10667         {
10668           AtkObject *accessible;
10669           AtkAction *action;
10670           gint i, n_actions;
10671           GSList *l;
10672
10673           accessible = gtk_widget_get_accessible (GTK_WIDGET (buildable));
10674
10675           action = ATK_ACTION (accessible);
10676           n_actions = atk_action_get_n_actions (action);
10677
10678           for (l = a11y_data->actions; l; l = l->next)
10679             {
10680               AtkActionData *action_data = (AtkActionData*)l->data;
10681
10682               for (i = 0; i < n_actions; i++)
10683                 if (strcmp (atk_action_get_name (action, i),
10684                             action_data->action_name) == 0)
10685                   break;
10686
10687               if (i < n_actions)
10688                 {
10689                   gchar *description;
10690
10691                   if (action_data->translatable && action_data->description->len)
10692                     description = _gtk_builder_parser_translate (gtk_builder_get_translation_domain (builder),
10693                                                                  action_data->context,
10694                                                                  action_data->description->str);
10695                   else
10696                     description = action_data->description->str;
10697
10698                   atk_action_set_description (action, i, description);
10699                 }
10700             }
10701
10702           g_slist_foreach (a11y_data->actions, (GFunc)free_action, NULL);
10703           g_slist_free (a11y_data->actions);
10704         }
10705
10706       if (a11y_data->relations)
10707         g_object_set_qdata (G_OBJECT (buildable), quark_builder_atk_relations,
10708                             a11y_data->relations);
10709
10710       g_slice_free (AccessibilitySubParserData, a11y_data);
10711     }
10712 }
10713
10714
10715 /**
10716  * gtk_widget_get_clipboard:
10717  * @widget: a #GtkWidget
10718  * @selection: a #GdkAtom which identifies the clipboard
10719  *             to use. %GDK_SELECTION_CLIPBOARD gives the
10720  *             default clipboard. Another common value
10721  *             is %GDK_SELECTION_PRIMARY, which gives
10722  *             the primary X selection.
10723  *
10724  * Returns the clipboard object for the given selection to
10725  * be used with @widget. @widget must have a #GdkDisplay
10726  * associated with it, so must be attached to a toplevel
10727  * window.
10728  *
10729  * Return value: (transfer none): the appropriate clipboard object. If no
10730  *             clipboard already exists, a new one will
10731  *             be created. Once a clipboard object has
10732  *             been created, it is persistent for all time.
10733  *
10734  * Since: 2.2
10735  **/
10736 GtkClipboard *
10737 gtk_widget_get_clipboard (GtkWidget *widget, GdkAtom selection)
10738 {
10739   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10740   g_return_val_if_fail (gtk_widget_has_screen (widget), NULL);
10741
10742   return gtk_clipboard_get_for_display (gtk_widget_get_display (widget),
10743                                         selection);
10744 }
10745
10746 /**
10747  * gtk_widget_list_mnemonic_labels:
10748  * @widget: a #GtkWidget
10749  *
10750  * Returns a newly allocated list of the widgets, normally labels, for
10751  * which this widget is a the target of a mnemonic (see for example,
10752  * gtk_label_set_mnemonic_widget()).
10753
10754  * The widgets in the list are not individually referenced. If you
10755  * want to iterate through the list and perform actions involving
10756  * callbacks that might destroy the widgets, you
10757  * <emphasis>must</emphasis> call <literal>g_list_foreach (result,
10758  * (GFunc)g_object_ref, NULL)</literal> first, and then unref all the
10759  * widgets afterwards.
10760
10761  * Return value: (element-type GtkWidget) (transfer container): the list of
10762  *  mnemonic labels; free this list
10763  *  with g_list_free() when you are done with it.
10764  *
10765  * Since: 2.4
10766  **/
10767 GList *
10768 gtk_widget_list_mnemonic_labels (GtkWidget *widget)
10769 {
10770   GList *list = NULL;
10771   GSList *l;
10772
10773   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10774
10775   for (l = g_object_get_qdata (G_OBJECT (widget), quark_mnemonic_labels); l; l = l->next)
10776     list = g_list_prepend (list, l->data);
10777
10778   return list;
10779 }
10780
10781 /**
10782  * gtk_widget_add_mnemonic_label:
10783  * @widget: a #GtkWidget
10784  * @label: a #GtkWidget that acts as a mnemonic label for @widget
10785  *
10786  * Adds a widget to the list of mnemonic labels for
10787  * this widget. (See gtk_widget_list_mnemonic_labels()). Note the
10788  * list of mnemonic labels for the widget is cleared when the
10789  * widget is destroyed, so the caller must make sure to update
10790  * its internal state at this point as well, by using a connection
10791  * to the #GtkWidget::destroy signal or a weak notifier.
10792  *
10793  * Since: 2.4
10794  **/
10795 void
10796 gtk_widget_add_mnemonic_label (GtkWidget *widget,
10797                                GtkWidget *label)
10798 {
10799   GSList *old_list, *new_list;
10800
10801   g_return_if_fail (GTK_IS_WIDGET (widget));
10802   g_return_if_fail (GTK_IS_WIDGET (label));
10803
10804   old_list = g_object_steal_qdata (G_OBJECT (widget), quark_mnemonic_labels);
10805   new_list = g_slist_prepend (old_list, label);
10806
10807   g_object_set_qdata_full (G_OBJECT (widget), quark_mnemonic_labels,
10808                            new_list, (GDestroyNotify) g_slist_free);
10809 }
10810
10811 /**
10812  * gtk_widget_remove_mnemonic_label:
10813  * @widget: a #GtkWidget
10814  * @label: a #GtkWidget that was previously set as a mnemnic label for
10815  *         @widget with gtk_widget_add_mnemonic_label().
10816  *
10817  * Removes a widget from the list of mnemonic labels for
10818  * this widget. (See gtk_widget_list_mnemonic_labels()). The widget
10819  * must have previously been added to the list with
10820  * gtk_widget_add_mnemonic_label().
10821  *
10822  * Since: 2.4
10823  **/
10824 void
10825 gtk_widget_remove_mnemonic_label (GtkWidget *widget,
10826                                   GtkWidget *label)
10827 {
10828   GSList *old_list, *new_list;
10829
10830   g_return_if_fail (GTK_IS_WIDGET (widget));
10831   g_return_if_fail (GTK_IS_WIDGET (label));
10832
10833   old_list = g_object_steal_qdata (G_OBJECT (widget), quark_mnemonic_labels);
10834   new_list = g_slist_remove (old_list, label);
10835
10836   if (new_list)
10837     g_object_set_qdata_full (G_OBJECT (widget), quark_mnemonic_labels,
10838                              new_list, (GDestroyNotify) g_slist_free);
10839 }
10840
10841 /**
10842  * gtk_widget_get_no_show_all:
10843  * @widget: a #GtkWidget
10844  *
10845  * Returns the current value of the GtkWidget:no-show-all property,
10846  * which determines whether calls to gtk_widget_show_all() and
10847  * gtk_widget_hide_all() will affect this widget.
10848  *
10849  * Return value: the current value of the "no-show-all" property.
10850  *
10851  * Since: 2.4
10852  **/
10853 gboolean
10854 gtk_widget_get_no_show_all (GtkWidget *widget)
10855 {
10856   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
10857
10858   return (GTK_OBJECT_FLAGS (widget) & GTK_NO_SHOW_ALL) != 0;
10859 }
10860
10861 /**
10862  * gtk_widget_set_no_show_all:
10863  * @widget: a #GtkWidget
10864  * @no_show_all: the new value for the "no-show-all" property
10865  *
10866  * Sets the #GtkWidget:no-show-all property, which determines whether
10867  * calls to gtk_widget_show_all() and gtk_widget_hide_all() will affect
10868  * this widget.
10869  *
10870  * This is mostly for use in constructing widget hierarchies with externally
10871  * controlled visibility, see #GtkUIManager.
10872  *
10873  * Since: 2.4
10874  **/
10875 void
10876 gtk_widget_set_no_show_all (GtkWidget *widget,
10877                             gboolean   no_show_all)
10878 {
10879   g_return_if_fail (GTK_IS_WIDGET (widget));
10880
10881   no_show_all = (no_show_all != FALSE);
10882
10883   if (no_show_all == gtk_widget_get_no_show_all (widget))
10884     return;
10885
10886   if (no_show_all)
10887     GTK_OBJECT_FLAGS (widget) |= GTK_NO_SHOW_ALL;
10888   else
10889     GTK_OBJECT_FLAGS (widget) &= ~(GTK_NO_SHOW_ALL);
10890
10891   g_object_notify (G_OBJECT (widget), "no-show-all");
10892 }
10893
10894
10895 static void
10896 gtk_widget_real_set_has_tooltip (GtkWidget *widget,
10897                                  gboolean   has_tooltip,
10898                                  gboolean   force)
10899 {
10900   gboolean priv_has_tooltip;
10901
10902   priv_has_tooltip = GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (widget),
10903                                        quark_has_tooltip));
10904
10905   if (priv_has_tooltip != has_tooltip || force)
10906     {
10907       priv_has_tooltip = has_tooltip;
10908
10909       if (priv_has_tooltip)
10910         {
10911           if (gtk_widget_get_realized (widget) && !gtk_widget_get_has_window (widget))
10912             gdk_window_set_events (widget->window,
10913                                    gdk_window_get_events (widget->window) |
10914                                    GDK_LEAVE_NOTIFY_MASK |
10915                                    GDK_POINTER_MOTION_MASK |
10916                                    GDK_POINTER_MOTION_HINT_MASK);
10917
10918           if (gtk_widget_get_has_window (widget))
10919               gtk_widget_add_events (widget,
10920                                      GDK_LEAVE_NOTIFY_MASK |
10921                                      GDK_POINTER_MOTION_MASK |
10922                                      GDK_POINTER_MOTION_HINT_MASK);
10923         }
10924
10925       g_object_set_qdata (G_OBJECT (widget), quark_has_tooltip,
10926                           GUINT_TO_POINTER (priv_has_tooltip));
10927     }
10928 }
10929
10930 /**
10931  * gtk_widget_set_tooltip_window:
10932  * @widget: a #GtkWidget
10933  * @custom_window: (allow-none): a #GtkWindow, or %NULL
10934  *
10935  * Replaces the default, usually yellow, window used for displaying
10936  * tooltips with @custom_window. GTK+ will take care of showing and
10937  * hiding @custom_window at the right moment, to behave likewise as
10938  * the default tooltip window. If @custom_window is %NULL, the default
10939  * tooltip window will be used.
10940  *
10941  * If the custom window should have the default theming it needs to
10942  * have the name "gtk-tooltip", see gtk_widget_set_name().
10943  *
10944  * Since: 2.12
10945  */
10946 void
10947 gtk_widget_set_tooltip_window (GtkWidget *widget,
10948                                GtkWindow *custom_window)
10949 {
10950   gboolean has_tooltip;
10951   gchar *tooltip_markup;
10952
10953   g_return_if_fail (GTK_IS_WIDGET (widget));
10954   g_return_if_fail (custom_window == NULL || GTK_IS_WINDOW (custom_window));
10955
10956   tooltip_markup = g_object_get_qdata (G_OBJECT (widget), quark_tooltip_markup);
10957
10958   if (custom_window)
10959     g_object_ref (custom_window);
10960
10961   g_object_set_qdata_full (G_OBJECT (widget), quark_tooltip_window,
10962                            custom_window, g_object_unref);
10963
10964   has_tooltip = (custom_window != NULL || tooltip_markup != NULL);
10965   gtk_widget_real_set_has_tooltip (widget, has_tooltip, FALSE);
10966
10967   if (has_tooltip && gtk_widget_get_visible (widget))
10968     gtk_widget_queue_tooltip_query (widget);
10969 }
10970
10971 /**
10972  * gtk_widget_get_tooltip_window:
10973  * @widget: a #GtkWidget
10974  *
10975  * Returns the #GtkWindow of the current tooltip. This can be the
10976  * GtkWindow created by default, or the custom tooltip window set
10977  * using gtk_widget_set_tooltip_window().
10978  *
10979  * Return value: (transfer none): The #GtkWindow of the current tooltip.
10980  *
10981  * Since: 2.12
10982  */
10983 GtkWindow *
10984 gtk_widget_get_tooltip_window (GtkWidget *widget)
10985 {
10986   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10987
10988   return g_object_get_qdata (G_OBJECT (widget), quark_tooltip_window);
10989 }
10990
10991 /**
10992  * gtk_widget_trigger_tooltip_query:
10993  * @widget: a #GtkWidget
10994  *
10995  * Triggers a tooltip query on the display where the toplevel of @widget
10996  * is located. See gtk_tooltip_trigger_tooltip_query() for more
10997  * information.
10998  *
10999  * Since: 2.12
11000  */
11001 void
11002 gtk_widget_trigger_tooltip_query (GtkWidget *widget)
11003 {
11004   gtk_tooltip_trigger_tooltip_query (gtk_widget_get_display (widget));
11005 }
11006
11007 static guint tooltip_query_id;
11008 static GSList *tooltip_query_displays;
11009
11010 static gboolean
11011 tooltip_query_idle (gpointer data)
11012 {
11013   g_slist_foreach (tooltip_query_displays, (GFunc)gtk_tooltip_trigger_tooltip_query, NULL);
11014   g_slist_foreach (tooltip_query_displays, (GFunc)g_object_unref, NULL);
11015   g_slist_free (tooltip_query_displays);
11016
11017   tooltip_query_displays = NULL;
11018   tooltip_query_id = 0;
11019
11020   return FALSE;
11021 }
11022
11023 static void
11024 gtk_widget_queue_tooltip_query (GtkWidget *widget)
11025 {
11026   GdkDisplay *display;
11027
11028   display = gtk_widget_get_display (widget);
11029
11030   if (!g_slist_find (tooltip_query_displays, display))
11031     tooltip_query_displays = g_slist_prepend (tooltip_query_displays, g_object_ref (display));
11032
11033   if (tooltip_query_id == 0)
11034     tooltip_query_id = gdk_threads_add_idle (tooltip_query_idle, NULL);
11035 }
11036
11037 /**
11038  * gtk_widget_set_tooltip_text:
11039  * @widget: a #GtkWidget
11040  * @text: the contents of the tooltip for @widget
11041  *
11042  * Sets @text as the contents of the tooltip. This function will take
11043  * care of setting GtkWidget:has-tooltip to %TRUE and of the default
11044  * handler for the GtkWidget::query-tooltip signal.
11045  *
11046  * See also the GtkWidget:tooltip-text property and gtk_tooltip_set_text().
11047  *
11048  * Since: 2.12
11049  */
11050 void
11051 gtk_widget_set_tooltip_text (GtkWidget   *widget,
11052                              const gchar *text)
11053 {
11054   g_return_if_fail (GTK_IS_WIDGET (widget));
11055
11056   g_object_set (G_OBJECT (widget), "tooltip-text", text, NULL);
11057 }
11058
11059 /**
11060  * gtk_widget_get_tooltip_text:
11061  * @widget: a #GtkWidget
11062  *
11063  * Gets the contents of the tooltip for @widget.
11064  *
11065  * Return value: the tooltip text, or %NULL. You should free the
11066  *   returned string with g_free() when done.
11067  *
11068  * Since: 2.12
11069  */
11070 gchar *
11071 gtk_widget_get_tooltip_text (GtkWidget *widget)
11072 {
11073   gchar *text = NULL;
11074
11075   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
11076
11077   g_object_get (G_OBJECT (widget), "tooltip-text", &text, NULL);
11078
11079   return text;
11080 }
11081
11082 /**
11083  * gtk_widget_set_tooltip_markup:
11084  * @widget: a #GtkWidget
11085  * @markup: (allow-none): the contents of the tooltip for @widget, or %NULL
11086  *
11087  * Sets @markup as the contents of the tooltip, which is marked up with
11088  *  the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
11089  *
11090  * This function will take care of setting GtkWidget:has-tooltip to %TRUE
11091  * and of the default handler for the GtkWidget::query-tooltip signal.
11092  *
11093  * See also the GtkWidget:tooltip-markup property and
11094  * gtk_tooltip_set_markup().
11095  *
11096  * Since: 2.12
11097  */
11098 void
11099 gtk_widget_set_tooltip_markup (GtkWidget   *widget,
11100                                const gchar *markup)
11101 {
11102   g_return_if_fail (GTK_IS_WIDGET (widget));
11103
11104   g_object_set (G_OBJECT (widget), "tooltip-markup", markup, NULL);
11105 }
11106
11107 /**
11108  * gtk_widget_get_tooltip_markup:
11109  * @widget: a #GtkWidget
11110  *
11111  * Gets the contents of the tooltip for @widget.
11112  *
11113  * Return value: the tooltip text, or %NULL. You should free the
11114  *   returned string with g_free() when done.
11115  *
11116  * Since: 2.12
11117  */
11118 gchar *
11119 gtk_widget_get_tooltip_markup (GtkWidget *widget)
11120 {
11121   gchar *text = NULL;
11122
11123   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
11124
11125   g_object_get (G_OBJECT (widget), "tooltip-markup", &text, NULL);
11126
11127   return text;
11128 }
11129
11130 /**
11131  * gtk_widget_set_has_tooltip:
11132  * @widget: a #GtkWidget
11133  * @has_tooltip: whether or not @widget has a tooltip.
11134  *
11135  * Sets the has-tooltip property on @widget to @has_tooltip.  See
11136  * GtkWidget:has-tooltip for more information.
11137  *
11138  * Since: 2.12
11139  */
11140 void
11141 gtk_widget_set_has_tooltip (GtkWidget *widget,
11142                             gboolean   has_tooltip)
11143 {
11144   g_return_if_fail (GTK_IS_WIDGET (widget));
11145
11146   g_object_set (G_OBJECT (widget), "has-tooltip", has_tooltip, NULL);
11147 }
11148
11149 /**
11150  * gtk_widget_get_has_tooltip:
11151  * @widget: a #GtkWidget
11152  *
11153  * Returns the current value of the has-tooltip property.  See
11154  * GtkWidget:has-tooltip for more information.
11155  *
11156  * Return value: current value of has-tooltip on @widget.
11157  *
11158  * Since: 2.12
11159  */
11160 gboolean
11161 gtk_widget_get_has_tooltip (GtkWidget *widget)
11162 {
11163   gboolean has_tooltip = FALSE;
11164
11165   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
11166
11167   g_object_get (G_OBJECT (widget), "has-tooltip", &has_tooltip, NULL);
11168
11169   return has_tooltip;
11170 }
11171
11172 /**
11173  * gtk_widget_get_allocation:
11174  * @widget: a #GtkWidget
11175  * @allocation: (out): a pointer to a #GtkAllocation to copy to
11176  *
11177  * Retrieves the widget's allocation.
11178  *
11179  * Since: 2.18
11180  */
11181 void
11182 gtk_widget_get_allocation (GtkWidget     *widget,
11183                            GtkAllocation *allocation)
11184 {
11185   g_return_if_fail (GTK_IS_WIDGET (widget));
11186   g_return_if_fail (allocation != NULL);
11187
11188   *allocation = widget->allocation;
11189 }
11190
11191 /**
11192  * gtk_widget_set_allocation:
11193  * @widget: a #GtkWidget
11194  * @allocation: a pointer to a #GtkAllocation to copy from
11195  *
11196  * Sets the widget's allocation.  This should not be used
11197  * directly, but from within a widget's size_allocate method.
11198  *
11199  * Since: 2.18
11200  */
11201 void
11202 gtk_widget_set_allocation (GtkWidget           *widget,
11203                            const GtkAllocation *allocation)
11204 {
11205   g_return_if_fail (GTK_IS_WIDGET (widget));
11206   g_return_if_fail (allocation != NULL);
11207
11208   widget->allocation = *allocation;
11209 }
11210
11211 /**
11212  * gtk_widget_get_requisition:
11213  * @widget: a #GtkWidget
11214  * @requisition: (out): a pointer to a #GtkRequisition to copy to
11215  *
11216  * Retrieves the widget's requisition.
11217  *
11218  * This function should only be used by widget implementations in
11219  * order to figure whether the widget's requisition has actually
11220  * changed after some internal state change (so that they can call
11221  * gtk_widget_queue_resize() instead of gtk_widget_queue_draw()).
11222  *
11223  * Normally, gtk_widget_size_request() should be used.
11224  *
11225  * Since: 2.20
11226  */
11227 void
11228 gtk_widget_get_requisition (GtkWidget      *widget,
11229                             GtkRequisition *requisition)
11230 {
11231   g_return_if_fail (GTK_IS_WIDGET (widget));
11232   g_return_if_fail (requisition != NULL);
11233
11234   *requisition = widget->requisition;
11235 }
11236
11237 /**
11238  * gtk_widget_set_window:
11239  * @widget: a #GtkWidget
11240  * @window: a #GdkWindow
11241  *
11242  * Sets a widget's window. This function should only be used in a
11243  * widget's GtkWidget::realize() implementation. The %window passed is
11244  * usually either new window created with gdk_window_new(), or the
11245  * window of its parent widget as returned by
11246  * gtk_widget_get_parent_window().
11247  *
11248  * Widgets must indicate whether they will create their own #GdkWindow
11249  * by calling gtk_widget_set_has_window(). This is usually done in the
11250  * widget's init() function.
11251  *
11252  * Since: 2.18
11253  */
11254 void
11255 gtk_widget_set_window (GtkWidget *widget,
11256                        GdkWindow *window)
11257 {
11258   g_return_if_fail (GTK_IS_WIDGET (widget));
11259   g_return_if_fail (window == NULL || GDK_IS_WINDOW (window));
11260
11261   if (widget->window != window)
11262     {
11263       widget->window = window;
11264       g_object_notify (G_OBJECT (widget), "window");
11265     }
11266 }
11267
11268 /**
11269  * gtk_widget_get_window:
11270  * @widget: a #GtkWidget
11271  *
11272  * Returns the widget's window if it is realized, %NULL otherwise
11273  *
11274  * Return value: @widget's window.
11275  *
11276  * Since: 2.14
11277  */
11278 GdkWindow*
11279 gtk_widget_get_window (GtkWidget *widget)
11280 {
11281   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
11282
11283   return widget->window;
11284 }
11285
11286 #define __GTK_WIDGET_C__
11287 #include "gtkaliasdef.c"