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