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