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

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