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