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, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 /*
  19  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  20  * file for a list of people on the GTK+ Team.  See the ChangeLog
  21  * files for a list of changes.  These files are distributed with
  22  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  23  */
  24
  25 #include "config.h"
  26
  27 #include <stdarg.h>
  28 #include <string.h>
  29 #include <locale.h>
  30
  31 #include <gobject/gvaluecollector.h>
  32 #include <gobject/gobjectnotifyqueue.c>
  33 #include <cairo-gobject.h>
  34
  35 #include "gtkcontainer.h"
  36 #include "gtkaccelmapprivate.h"
  37 #include "gtkclipboard.h"
  38 #include "gtkcssstylepropertyprivate.h"
  39 #include "gtkiconfactory.h"
  40 #include "gtkintl.h"
  41 #include "gtkmarshalers.h"
  42 #include "gtkselectionprivate.h"
  43 #include "gtksettingsprivate.h"
  44 #include "gtksizegroup-private.h"
  45 #include "gtksizerequestcacheprivate.h"
  46 #include "gtkwidget.h"
  47 #include "gtkwidgetprivate.h"
  48 #include "gtkwindowprivate.h"
  49 #include "gtkcontainerprivate.h"
  50 #include "gtkbindings.h"
  51 #include "gtkprivate.h"
  52 #include "gtkaccessible.h"
  53 #include "gtktooltip.h"
  54 #include "gtkinvisible.h"
  55 #include "gtkbuildable.h"
  56 #include "gtkbuilderprivate.h"
  57 #include "gtksizerequest.h"
  58 #include "gtkstylecontextprivate.h"
  59 #include "gtkcssprovider.h"
  60 #include "gtkmodifierstyle.h"
  61 #include "gtkversion.h"
  62 #include "gtkdebug.h"
  63 #include "gtkplug.h"
  64 #include "gtktypebuiltins.h"
  65 #include "a11y/gtkwidgetaccessible.h"
  66
  67 /**
  68  * SECTION:gtkwidget
  69  * @Short_description: Base class for all widgets
  70  * @Title: GtkWidget
  71  *
  72  * GtkWidget is the base class all widgets in GTK+ derive from. It manages the
  73  * widget lifecycle, states and style.
  74  *
  75  * <refsect2 id="geometry-management">
  76  * <title>Height-for-width Geometry Management</title>
  77  * <para>
  78  * GTK+ uses a height-for-width (and width-for-height) geometry management
  79  * system. Height-for-width means that a widget can change how much
  80  * vertical space it needs, depending on the amount of horizontal space
  81  * that it is given (and similar for width-for-height). The most common
  82  * example is a label that reflows to fill up the available width, wraps
  83  * to fewer lines, and therefore needs less height.
  84  *
  85  * Height-for-width geometry management is implemented in GTK+ by way
  86  * of five virtual methods:
  87  * <itemizedlist>
  88  *   <listitem>#GtkWidgetClass.get_request_mode()</listitem>
  89  *   <listitem>#GtkWidgetClass.get_preferred_width()</listitem>
  90  *   <listitem>#GtkWidgetClass.get_preferred_height()</listitem>
  91  *   <listitem>#GtkWidgetClass.get_preferred_height_for_width()</listitem>
  92  *   <listitem>#GtkWidgetClass.get_preferred_width_for_height()</listitem>
  93  * </itemizedlist>
  94  *
  95  * There are some important things to keep in mind when implementing
  96  * height-for-width and when using it in container implementations.
  97  *
  98  * The geometry management system will query a widget hierarchy in
  99  * only one orientation at a time. When widgets are initially queried
 100  * for their minimum sizes it is generally done in two initial passes
 101  * in the #GtkSizeRequestMode chosen by the toplevel.
 102  *
 103  * For example, when queried in the normal
 104  * %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH mode:
 105  * First, the default minimum and natural width for each widget
 106  * in the interface will be computed using gtk_widget_get_preferred_width().
 107  * Because the preferred widths for each container depend on the preferred
 108  * widths of their children, this information propagates up the hierarchy,
 109  * and finally a minimum and natural width is determined for the entire
 110  * toplevel. Next, the toplevel will use the minimum width to query for the
 111  * minimum height contextual to that width using
 112  * gtk_widget_get_preferred_height_for_width(), which will also be a highly
 113  * recursive operation. The minimum height for the minimum width is normally
 114  * used to set the minimum size constraint on the toplevel
 115  * (unless gtk_window_set_geometry_hints() is explicitly used instead).
 116  *
 117  * After the toplevel window has initially requested its size in both
 118  * dimensions it can go on to allocate itself a reasonable size (or a size
 119  * previously specified with gtk_window_set_default_size()). During the
 120  * recursive allocation process it's important to note that request cycles
 121  * will be recursively executed while container widgets allocate their children.
 122  * Each container widget, once allocated a size, will go on to first share the
 123  * space in one orientation among its children and then request each child's
 124  * height for its target allocated width or its width for allocated height,
 125  * depending. In this way a #GtkWidget will typically be requested its size
 126  * a number of times before actually being allocated a size. The size a
 127  * widget is finally allocated can of course differ from the size it has
 128  * requested. For this reason, #GtkWidget caches a  small number of results
 129  * to avoid re-querying for the same sizes in one allocation cycle.
 130  *
 131  * See <link linkend="container-geometry-management">GtkContainer's
 132  * geometry management section</link>
 133  * to learn more about how height-for-width allocations are performed
 134  * by container widgets.
 135  *
 136  * If a widget does move content around to intelligently use up the
 137  * allocated size then it must support the request in both
 138  * #GtkSizeRequestModes even if the widget in question only
 139  * trades sizes in a single orientation.
 140  *
 141  * For instance, a #GtkLabel that does height-for-width word wrapping
 142  * will not expect to have #GtkWidgetClass.get_preferred_height() called
 143  * because that call is specific to a width-for-height request. In this
 144  * case the label must return the height required for its own minimum
 145  * possible width. By following this rule any widget that handles
 146  * height-for-width or width-for-height requests will always be allocated
 147  * at least enough space to fit its own content.
 148  *
 149  * Here are some examples of how a %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH widget
 150  * generally deals with width-for-height requests, for #GtkWidgetClass.get_preferred_height()
 151  * it will do:
 152  * <programlisting><![CDATA[
 153  * static void
 154  * foo_widget_get_preferred_height (GtkWidget *widget, gint *min_height, gint *nat_height)
 155  * {
 156  *    if (i_am_in_height_for_width_mode)
 157  *      {
 158  *        gint min_width;
 159  *
 160  *        GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, &min_width, NULL);
 161  *        GTK_WIDGET_GET_CLASS (widget)->get_preferred_height_for_width (widget, min_width,
 162  *                                                                      min_height, nat_height);
 163  *      }
 164  *    else
 165  *      {
 166  *         ... some widgets do both. For instance, if a GtkLabel is rotated to 90 degrees
 167  *         it will return the minimum and natural height for the rotated label here.
 168  *      }
 169  * }
 170  * ]]></programlisting>
 171  *
 172  * And in #GtkWidgetClass.get_preferred_width_for_height() it will simply return
 173  * the minimum and natural width:
 174  *
 175  * <programlisting><![CDATA[
 176  * static void
 177  * foo_widget_get_preferred_width_for_height (GtkWidget *widget, gint for_height,
 178  *                                            gint *min_width, gint *nat_width)
 179  * {
 180  *    if (i_am_in_height_for_width_mode)
 181  *      {
 182  *        GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, min_width, nat_width);
 183  *      }
 184  *    else
 185  *      {
 186  *         ... again if a widget is sometimes operating in width-for-height mode
 187  *         (like a rotated GtkLabel) it can go ahead and do its real width for
 188  *         height calculation here.
 189  *      }
 190  * }
 191  * ]]></programlisting>
 192  *
 193  * Often a widget needs to get its own request during size request or
 194  * allocation. For example, when computing height it may need to also
 195  * compute width. Or when deciding how to use an allocation, the widget
 196  * may need to know its natural size. In these cases, the widget should
 197  * be careful to call its virtual methods directly, like this:
 198  * <example>
 199  *   <title>Widget calling its own size request method.</title>
 200  *   <programlisting>
 201  * GTK_WIDGET_GET_CLASS(widget)-&gt;get_preferred_width (widget),
 202  *                                  &min, &natural);
 203  *   </programlisting>
 204  * </example>
 205  *
 206  * It will not work to use the wrapper functions, such as
 207  * gtk_widget_get_preferred_width() inside your own size request
 208  * implementation. These return a request adjusted by #GtkSizeGroup
 209  * and by the #GtkWidgetClass.adjust_size_request() virtual method. If a
 210  * widget used the wrappers inside its virtual method implementations,
 211  * then the adjustments (such as widget margins) would be applied
 212  * twice. GTK+ therefore does not allow this and will warn if you try
 213  * to do it.
 214  *
 215  * Of course if you are getting the size request for
 216  * <emphasis>another</emphasis> widget, such as a child of a
 217  * container, you <emphasis>must</emphasis> use the wrapper APIs.
 218  * Otherwise, you would not properly consider widget margins,
 219  * #GtkSizeGroup, and so forth.
 220  * </para>
 221  * </refsect2>
 222  * <refsect2 id="style-properties">
 223  * <title>Style Properties</title>
 224  * <para>
 225  * <structname>GtkWidget</structname> introduces <firstterm>style
 226  * properties</firstterm> - these are basically object properties that are stored
 227  * not on the object, but in the style object associated to the widget. Style
 228  * properties are set in <link linkend="gtk-Resource-Files">resource files</link>.
 229  * This mechanism is used for configuring such things as the location of the
 230  * scrollbar arrows through the theme, giving theme authors more control over the
 231  * look of applications without the need to write a theme engine in C.
 232  * </para>
 233  * <para>
 234  * Use gtk_widget_class_install_style_property() to install style properties for
 235  * a widget class, gtk_widget_class_find_style_property() or
 236  * gtk_widget_class_list_style_properties() to get information about existing
 237  * style properties and gtk_widget_style_get_property(), gtk_widget_style_get() or
 238  * gtk_widget_style_get_valist() to obtain the value of a style property.
 239  * </para>
 240  * </refsect2>
 241  * <refsect2 id="GtkWidget-BUILDER-UI">
 242  * <title>GtkWidget as GtkBuildable</title>
 243  * <para>
 244  * The GtkWidget implementation of the GtkBuildable interface supports a
 245  * custom &lt;accelerator&gt; element, which has attributes named key,
 246  * modifiers and signal and allows to specify accelerators.
 247  * </para>
 248  * <example>
 249  * <title>A UI definition fragment specifying an accelerator</title>
 250  * <programlisting><![CDATA[
 251  * <object class="GtkButton">
 252  *   <accelerator key="q" modifiers="GDK_CONTROL_MASK" signal="clicked"/>
 253  * </object>
 254  * ]]></programlisting>
 255  * </example>
 256  * <para>
 257  * In addition to accelerators, <structname>GtkWidget</structname> also support a
 258  * custom &lt;accessible&gt; element, which supports actions and relations.
 259  * Properties on the accessible implementation of an object can be set by accessing the
 260  * internal child "accessible" of a <structname>GtkWidget</structname>.
 261  * </para>
 262  * <example>
 263  * <title>A UI definition fragment specifying an accessible</title>
 264  * <programlisting><![CDATA[
 265  * <object class="GtkButton" id="label1"/>
 266  *   <property name="label">I am a Label for a Button</property>
 267  * </object>
 268  * <object class="GtkButton" id="button1">
 269  *   <accessibility>
 270  *     <action action_name="click" translatable="yes">Click the button.</action>
 271  *     <relation target="label1" type="labelled-by"/>
 272  *   </accessibility>
 273  *   <child internal-child="accessible">
 274  *     <object class="AtkObject" id="a11y-button1">
 275  *       <property name="AtkObject::name">Clickable Button</property>
 276  *     </object>
 277  *   </child>
 278  * </object>
 279  * ]]></programlisting>
 280  * </example>
 281  * <para>
 282  * Finally, GtkWidget allows style information such as style classes to
 283  * be associated with widgets, using the custom &lt;style&gt; element:
 284  * <example>
 285  * <title>A UI definition fragment specifying an style class</title>
 286  * <programlisting><![CDATA[
 287  * <object class="GtkButton" id="button1">
 288  *   <style>
 289  *     <class name="my-special-button-class"/>
 290  *     <class name="dark-button"/>
 291  *   </style>
 292  * </object>
 293  * ]]></programlisting>
 294  * </example>
 295  * </para>
 296  * </refsect2>
 297  */
 298
 299 /* Add flags here that should not be propagated to children. By default,
 300  * all flags will be set on children (think prelight or active), but we
 301  * might want to not do this for some.
 302  */
 303 #define GTK_STATE_FLAGS_DONT_PROPAGATE (GTK_STATE_FLAG_FOCUSED | GTK_STATE_FLAG_DIR_LTR | GTK_STATE_FLAG_DIR_RTL)
 304 #define GTK_STATE_FLAGS_DO_PROPAGATE (~GTK_STATE_FLAGS_DONT_PROPAGATE)
 305
 306 #define WIDGET_CLASS(w)  GTK_WIDGET_GET_CLASS (w)
 307
 308 #define GTK_STATE_FLAGS_BITS 9
 309
 310 struct _GtkWidgetPrivate
 311 {
 312   /* The state of the widget. Needs to be able to hold all GtkStateFlags bits
 313    * (defined in "gtkenums.h").
 314    */
 315   guint state_flags : GTK_STATE_FLAGS_BITS;
 316
 317   guint direction             : 2;
 318
 319   guint in_destruction        : 1;
 320   guint toplevel              : 1;
 321   guint anchored              : 1;
 322   guint composite_child       : 1;
 323   guint no_window             : 1;
 324   guint realized              : 1;
 325   guint mapped                : 1;
 326   guint visible               : 1;
 327   guint sensitive             : 1;
 328   guint can_focus             : 1;
 329   guint has_focus             : 1;
 330   guint can_default           : 1;
 331   guint has_default           : 1;
 332   guint receives_default      : 1;
 333   guint has_grab              : 1;
 334   guint shadowed              : 1;
 335   guint style_update_pending  : 1;
 336   guint app_paintable         : 1;
 337   guint double_buffered       : 1;
 338   guint redraw_on_alloc       : 1;
 339   guint no_show_all           : 1;
 340   guint child_visible         : 1;
 341   guint multidevice           : 1;
 342   guint has_shape_mask        : 1;
 343   guint in_reparent           : 1;
 344
 345   /* Queue-resize related flags */
 346   guint alloc_needed          : 1;
 347
 348   /* Expand-related flags */
 349   guint need_compute_expand   : 1; /* Need to recompute computed_[hv]_expand */
 350   guint computed_hexpand      : 1; /* computed results (composite of child flags) */
 351   guint computed_vexpand      : 1;
 352   guint hexpand               : 1; /* application-forced expand */
 353   guint vexpand               : 1;
 354   guint hexpand_set           : 1; /* whether to use application-forced  */
 355   guint vexpand_set           : 1; /* instead of computing from children */
 356
 357   /* SizeGroup related flags */
 358   guint have_size_groups      : 1;
 359
 360   /* The widget's name. If the widget does not have a name
 361    * (the name is NULL), then its name (as returned by
 362    * "gtk_widget_get_name") is its class's name.
 363    * Among other things, the widget name is used to determine
 364    * the style to use for a widget.
 365    */
 366   gchar *name;
 367
 368   /* The list of attached windows to this widget.
 369    * We keep a list in order to call reset_style to all of them,
 370    * recursively. */
 371   GList *attached_windows;
 372
 373   /* The style for the widget. The style contains the
 374    * colors the widget should be drawn in for each state
 375    * along with graphics contexts used to draw with and
 376    * the font to use for text.
 377    */
 378   GtkStyle *style;
 379   GtkStyleContext *context;
 380
 381   /* Widget's path for styling */
 382   GtkWidgetPath *path;
 383
 384   /* The widget's allocated size */
 385   GtkAllocation allocation;
 386
 387   /* The widget's requested sizes */
 388   SizeRequestCache requests;
 389
 390   /* actions attached to this or any parent widget */
 391   GActionMuxer *muxer;
 392
 393   /* The widget's window or its parent window if it does
 394    * not have a window. (Which will be indicated by the
 395    * GTK_NO_WINDOW flag being set).
 396    */
 397   GdkWindow *window;
 398
 399   /* The widget's parent */
 400   GtkWidget *parent;
 401
 402 #ifdef G_ENABLE_DEBUG
 403   /* Number of gtk_widget_push_verify_invariants () */
 404   guint verifying_invariants_count;
 405 #endif /* G_ENABLE_DEBUG */
 406 };
 407
 408 struct _GtkWidgetClassPrivate
 409 {
 410   GType accessible_type;
 411   AtkRole accessible_role;
 412 };
 413
 414 enum {
 415   DESTROY,
 416   SHOW,
 417   HIDE,
 418   MAP,
 419   UNMAP,
 420   REALIZE,
 421   UNREALIZE,
 422   SIZE_ALLOCATE,
 423   STATE_FLAGS_CHANGED,
 424   STATE_CHANGED,
 425   PARENT_SET,
 426   HIERARCHY_CHANGED,
 427   STYLE_SET,
 428   DIRECTION_CHANGED,
 429   GRAB_NOTIFY,
 430   CHILD_NOTIFY,
 431   DRAW,
 432   MNEMONIC_ACTIVATE,
 433   GRAB_FOCUS,
 434   FOCUS,
 435   MOVE_FOCUS,
 436   KEYNAV_FAILED,
 437   EVENT,
 438   EVENT_AFTER,
 439   BUTTON_PRESS_EVENT,
 440   BUTTON_RELEASE_EVENT,
 441   SCROLL_EVENT,
 442   MOTION_NOTIFY_EVENT,
 443   DELETE_EVENT,
 444   DESTROY_EVENT,
 445   KEY_PRESS_EVENT,
 446   KEY_RELEASE_EVENT,
 447   ENTER_NOTIFY_EVENT,
 448   LEAVE_NOTIFY_EVENT,
 449   CONFIGURE_EVENT,
 450   FOCUS_IN_EVENT,
 451   FOCUS_OUT_EVENT,
 452   MAP_EVENT,
 453   UNMAP_EVENT,
 454   PROPERTY_NOTIFY_EVENT,
 455   SELECTION_CLEAR_EVENT,
 456   SELECTION_REQUEST_EVENT,
 457   SELECTION_NOTIFY_EVENT,
 458   SELECTION_GET,
 459   SELECTION_RECEIVED,
 460   PROXIMITY_IN_EVENT,
 461   PROXIMITY_OUT_EVENT,
 462   VISIBILITY_NOTIFY_EVENT,
 463   WINDOW_STATE_EVENT,
 464   DAMAGE_EVENT,
 465   GRAB_BROKEN_EVENT,
 466   DRAG_BEGIN,
 467   DRAG_END,
 468   DRAG_DATA_DELETE,
 469   DRAG_LEAVE,
 470   DRAG_MOTION,
 471   DRAG_DROP,
 472   DRAG_DATA_GET,
 473   DRAG_DATA_RECEIVED,
 474   POPUP_MENU,
 475   SHOW_HELP,
 476   ACCEL_CLOSURES_CHANGED,
 477   SCREEN_CHANGED,
 478   CAN_ACTIVATE_ACCEL,
 479   COMPOSITED_CHANGED,
 480   QUERY_TOOLTIP,
 481   DRAG_FAILED,
 482   STYLE_UPDATED,
 483   TOUCH_EVENT,
 484   LAST_SIGNAL
 485 };
 486
 487 enum {
 488   PROP_0,
 489   PROP_NAME,
 490   PROP_PARENT,
 491   PROP_WIDTH_REQUEST,
 492   PROP_HEIGHT_REQUEST,
 493   PROP_VISIBLE,
 494   PROP_SENSITIVE,
 495   PROP_APP_PAINTABLE,
 496   PROP_CAN_FOCUS,
 497   PROP_HAS_FOCUS,
 498   PROP_IS_FOCUS,
 499   PROP_CAN_DEFAULT,
 500   PROP_HAS_DEFAULT,
 501   PROP_RECEIVES_DEFAULT,
 502   PROP_COMPOSITE_CHILD,
 503   PROP_STYLE,
 504   PROP_EVENTS,
 505   PROP_NO_SHOW_ALL,
 506   PROP_HAS_TOOLTIP,
 507   PROP_TOOLTIP_MARKUP,
 508   PROP_TOOLTIP_TEXT,
 509   PROP_WINDOW,
 510   PROP_DOUBLE_BUFFERED,
 511   PROP_HALIGN,
 512   PROP_VALIGN,
 513   PROP_MARGIN_LEFT,
 514   PROP_MARGIN_RIGHT,
 515   PROP_MARGIN_TOP,
 516   PROP_MARGIN_BOTTOM,
 517   PROP_MARGIN,
 518   PROP_HEXPAND,
 519   PROP_VEXPAND,
 520   PROP_HEXPAND_SET,
 521   PROP_VEXPAND_SET,
 522   PROP_EXPAND
 523 };
 524
 525 typedef struct  _GtkStateData    GtkStateData;
 526
 527 struct _GtkStateData
 528 {
 529   guint         flags_to_set;
 530   guint         flags_to_unset;
 531 };
 532
 533 /* --- prototypes --- */
 534 static void     gtk_widget_base_class_init      (gpointer            g_class);
 535 static void     gtk_widget_class_init           (GtkWidgetClass     *klass);
 536 static void     gtk_widget_base_class_finalize  (GtkWidgetClass     *klass);
 537 static void     gtk_widget_init                 (GtkWidget          *widget);
 538 static void     gtk_widget_set_property          (GObject           *object,
 539                                                   guint              prop_id,
 540                                                   const GValue      *value,
 541                                                   GParamSpec        *pspec);
 542 static void     gtk_widget_get_property          (GObject           *object,
 543                                                   guint              prop_id,
 544                                                   GValue            *value,
 545                                                   GParamSpec        *pspec);
 546 static void     gtk_widget_constructed           (GObject           *object);
 547 static void     gtk_widget_dispose               (GObject           *object);
 548 static void     gtk_widget_real_destroy          (GtkWidget         *object);
 549 static void     gtk_widget_finalize              (GObject           *object);
 550 static void     gtk_widget_real_show             (GtkWidget         *widget);
 551 static void     gtk_widget_real_hide             (GtkWidget         *widget);
 552 static void     gtk_widget_real_map              (GtkWidget         *widget);
 553 static void     gtk_widget_real_unmap            (GtkWidget         *widget);
 554 static void     gtk_widget_real_realize          (GtkWidget         *widget);
 555 static void     gtk_widget_real_unrealize        (GtkWidget         *widget);
 556 static void     gtk_widget_real_size_allocate    (GtkWidget         *widget,
 557                                                   GtkAllocation     *allocation);
 558 static void     gtk_widget_real_style_set        (GtkWidget         *widget,
 559                                                   GtkStyle          *previous_style);
 560 static void     gtk_widget_real_direction_changed(GtkWidget         *widget,
 561                                                   GtkTextDirection   previous_direction);
 562
 563 static void     gtk_widget_real_grab_focus       (GtkWidget         *focus_widget);
 564 static gboolean gtk_widget_real_query_tooltip    (GtkWidget         *widget,
 565                                                   gint               x,
 566                                                   gint               y,
 567                                                   gboolean           keyboard_tip,
 568                                                   GtkTooltip        *tooltip);
 569 static void     gtk_widget_real_style_updated    (GtkWidget         *widget);
 570 static gboolean gtk_widget_real_show_help        (GtkWidget         *widget,
 571                                                   GtkWidgetHelpType  help_type);
 572
 573 static void     gtk_widget_dispatch_child_properties_changed    (GtkWidget        *object,
 574                                                                  guint             n_pspecs,
 575                                                                  GParamSpec      **pspecs);
 576 static gboolean         gtk_widget_real_key_press_event         (GtkWidget        *widget,
 577                                                                  GdkEventKey      *event);
 578 static gboolean         gtk_widget_real_key_release_event       (GtkWidget        *widget,
 579                                                                  GdkEventKey      *event);
 580 static gboolean         gtk_widget_real_focus_in_event           (GtkWidget       *widget,
 581                                                                   GdkEventFocus   *event);
 582 static gboolean         gtk_widget_real_focus_out_event         (GtkWidget        *widget,
 583                                                                  GdkEventFocus    *event);
 584 static gboolean         gtk_widget_real_touch_event             (GtkWidget        *widget,
 585                                                                  GdkEventTouch    *event);
 586 static gboolean         gtk_widget_real_focus                   (GtkWidget        *widget,
 587                                                                  GtkDirectionType  direction);
 588 static void             gtk_widget_real_move_focus              (GtkWidget        *widget,
 589                                                                  GtkDirectionType  direction);
 590 static gboolean         gtk_widget_real_keynav_failed           (GtkWidget        *widget,
 591                                                                  GtkDirectionType  direction);
 592 #ifdef G_ENABLE_DEBUG
 593 static void             gtk_widget_verify_invariants            (GtkWidget        *widget);
 594 static void             gtk_widget_push_verify_invariants       (GtkWidget        *widget);
 595 static void             gtk_widget_pop_verify_invariants        (GtkWidget        *widget);
 596 #else
 597 #define                 gtk_widget_verify_invariants(widget)
 598 #define                 gtk_widget_push_verify_invariants(widget)
 599 #define                 gtk_widget_pop_verify_invariants(widget)
 600 #endif
 601 static PangoContext*    gtk_widget_peek_pango_context           (GtkWidget        *widget);
 602 static void             gtk_widget_update_pango_context         (GtkWidget        *widget);
 603 static void             gtk_widget_propagate_state              (GtkWidget        *widget,
 604                                                                  GtkStateData     *data);
 605 ;
 606 static gint             gtk_widget_event_internal               (GtkWidget        *widget,
 607                                                                  GdkEvent         *event);
 608 static gboolean         gtk_widget_real_mnemonic_activate       (GtkWidget        *widget,
 609                                                                  gboolean          group_cycling);
 610 static void             gtk_widget_real_get_width               (GtkWidget        *widget,
 611                                                                  gint             *minimum_size,
 612                                                                  gint             *natural_size);
 613 static void             gtk_widget_real_get_height              (GtkWidget        *widget,
 614                                                                  gint             *minimum_size,
 615                                                                  gint             *natural_size);
 616 static void             gtk_widget_real_get_height_for_width    (GtkWidget        *widget,
 617                                                                  gint              width,
 618                                                                  gint             *minimum_height,
 619                                                                  gint             *natural_height);
 620 static void             gtk_widget_real_get_width_for_height    (GtkWidget        *widget,
 621                                                                  gint              height,
 622                                                                  gint             *minimum_width,
 623                                                                  gint             *natural_width);
 624 static void             gtk_widget_real_state_flags_changed     (GtkWidget        *widget,
 625                                                                  GtkStateFlags     old_state);
 626 static const GtkWidgetAuxInfo* _gtk_widget_get_aux_info_or_defaults (GtkWidget *widget);
 627 static GtkWidgetAuxInfo* gtk_widget_get_aux_info                (GtkWidget        *widget,
 628                                                                  gboolean          create);
 629 static void             gtk_widget_aux_info_destroy             (GtkWidgetAuxInfo *aux_info);
 630 static AtkObject*       gtk_widget_real_get_accessible          (GtkWidget        *widget);
 631 static void             gtk_widget_accessible_interface_init    (AtkImplementorIface *iface);
 632 static AtkObject*       gtk_widget_ref_accessible               (AtkImplementor *implementor);
 633 static void             gtk_widget_invalidate_widget_windows    (GtkWidget        *widget,
 634                                                                  cairo_region_t        *region);
 635 static GdkScreen *      gtk_widget_get_screen_unchecked         (GtkWidget        *widget);
 636 static gboolean         gtk_widget_real_can_activate_accel      (GtkWidget *widget,
 637                                                                  guint      signal_id);
 638
 639 static void             gtk_widget_real_set_has_tooltip         (GtkWidget *widget,
 640                                                                  gboolean   has_tooltip,
 641                                                                  gboolean   force);
 642 static void             gtk_widget_buildable_interface_init     (GtkBuildableIface *iface);
 643 static void             gtk_widget_buildable_set_name           (GtkBuildable     *buildable,
 644                                                                  const gchar      *name);
 645 static const gchar *    gtk_widget_buildable_get_name           (GtkBuildable     *buildable);
 646 static GObject *        gtk_widget_buildable_get_internal_child (GtkBuildable *buildable,
 647                                                                  GtkBuilder   *builder,
 648                                                                  const gchar  *childname);
 649 static void             gtk_widget_buildable_set_buildable_property (GtkBuildable     *buildable,
 650                                                                      GtkBuilder       *builder,
 651                                                                      const gchar      *name,
 652                                                                      const GValue     *value);
 653 static gboolean         gtk_widget_buildable_custom_tag_start   (GtkBuildable     *buildable,
 654                                                                  GtkBuilder       *builder,
 655                                                                  GObject          *child,
 656                                                                  const gchar      *tagname,
 657                                                                  GMarkupParser    *parser,
 658                                                                  gpointer         *data);
 659 static void             gtk_widget_buildable_custom_finished    (GtkBuildable     *buildable,
 660                                                                  GtkBuilder       *builder,
 661                                                                  GObject          *child,
 662                                                                  const gchar      *tagname,
 663                                                                  gpointer          data);
 664 static void             gtk_widget_buildable_parser_finished    (GtkBuildable     *buildable,
 665                                                                  GtkBuilder       *builder);
 666
 667 static GtkSizeRequestMode gtk_widget_real_get_request_mode      (GtkWidget         *widget);
 668 static void             gtk_widget_real_get_width               (GtkWidget         *widget,
 669                                                                  gint              *minimum_size,
 670                                                                  gint              *natural_size);
 671 static void             gtk_widget_real_get_height              (GtkWidget         *widget,
 672                                                                  gint              *minimum_size,
 673                                                                  gint              *natural_size);
 674
 675 static void             gtk_widget_queue_tooltip_query          (GtkWidget *widget);
 676
 677
 678 static void             gtk_widget_real_adjust_size_request     (GtkWidget         *widget,
 679                                                                  GtkOrientation     orientation,
 680                                                                  gint              *minimum_size,
 681                                                                  gint              *natural_size);
 682 static void             gtk_widget_real_adjust_size_allocation  (GtkWidget         *widget,
 683                                                                  GtkOrientation     orientation,
 684                                                                  gint              *minimum_size,
 685                                                                  gint              *natural_size,
 686                                                                  gint              *allocated_pos,
 687                                                                  gint              *allocated_size);
 688
 689 static void gtk_widget_set_usize_internal (GtkWidget          *widget,
 690                                            gint                width,
 691                                            gint                height,
 692                                            GtkQueueResizeFlags flags);
 693
 694 static void gtk_widget_add_events_internal (GtkWidget *widget,
 695                                             GdkDevice *device,
 696                                             gint       events);
 697 static void gtk_widget_set_device_enabled_internal (GtkWidget *widget,
 698                                                     GdkDevice *device,
 699                                                     gboolean   recurse,
 700                                                     gboolean   enabled);
 701 static gboolean event_window_is_still_viewable (GdkEvent *event);
 702
 703 /* --- variables --- */
 704 static gpointer         gtk_widget_parent_class = NULL;
 705 static guint            widget_signals[LAST_SIGNAL] = { 0 };
 706 static guint            composite_child_stack = 0;
 707 static GtkTextDirection gtk_default_direction = GTK_TEXT_DIR_LTR;
 708 static GParamSpecPool  *style_property_spec_pool = NULL;
 709
 710 static GQuark           quark_property_parser = 0;
 711 static GQuark           quark_aux_info = 0;
 712 static GQuark           quark_accel_path = 0;
 713 static GQuark           quark_accel_closures = 0;
 714 static GQuark           quark_event_mask = 0;
 715 static GQuark           quark_device_event_mask = 0;
 716 static GQuark           quark_parent_window = 0;
 717 static GQuark           quark_pointer_window = 0;
 718 static GQuark           quark_shape_info = 0;
 719 static GQuark           quark_input_shape_info = 0;
 720 static GQuark           quark_pango_context = 0;
 721 static GQuark           quark_accessible_object = 0;
 722 static GQuark           quark_mnemonic_labels = 0;
 723 static GQuark           quark_tooltip_markup = 0;
 724 static GQuark           quark_has_tooltip = 0;
 725 static GQuark           quark_tooltip_window = 0;
 726 static GQuark           quark_visual = 0;
 727 static GQuark           quark_modifier_style = 0;
 728 static GQuark           quark_enabled_devices = 0;
 729 static GQuark           quark_size_groups = 0;
 730 GParamSpecPool         *_gtk_widget_child_property_pool = NULL;
 731 GObjectNotifyContext   *_gtk_widget_child_property_notify_context = NULL;
 732
 733 /* --- functions --- */
 734 GType
 735 gtk_widget_get_type (void)
 736 {
 737   static GType widget_type = 0;
 738
 739   if (G_UNLIKELY (widget_type == 0))
 740     {
 741       const GTypeInfo widget_info =
 742       {
 743         sizeof (GtkWidgetClass),
 744         gtk_widget_base_class_init,
 745         (GBaseFinalizeFunc) gtk_widget_base_class_finalize,
 746         (GClassInitFunc) gtk_widget_class_init,
 747         NULL,           /* class_finalize */
 748         NULL,           /* class_init */
 749         sizeof (GtkWidget),
 750         0,              /* n_preallocs */
 751         (GInstanceInitFunc) gtk_widget_init,
 752         NULL,           /* value_table */
 753       };
 754
 755       const GInterfaceInfo accessibility_info =
 756       {
 757         (GInterfaceInitFunc) gtk_widget_accessible_interface_init,
 758         (GInterfaceFinalizeFunc) NULL,
 759         NULL /* interface data */
 760       };
 761
 762       const GInterfaceInfo buildable_info =
 763       {
 764         (GInterfaceInitFunc) gtk_widget_buildable_interface_init,
 765         (GInterfaceFinalizeFunc) NULL,
 766         NULL /* interface data */
 767       };
 768
 769       widget_type = g_type_register_static (G_TYPE_INITIALLY_UNOWNED, "GtkWidget",
 770                                             &widget_info, G_TYPE_FLAG_ABSTRACT);
 771
 772       g_type_add_class_private (widget_type, sizeof (GtkWidgetClassPrivate));
 773
 774       g_type_add_interface_static (widget_type, ATK_TYPE_IMPLEMENTOR,
 775                                    &accessibility_info) ;
 776       g_type_add_interface_static (widget_type, GTK_TYPE_BUILDABLE,
 777                                    &buildable_info) ;
 778     }
 779
 780   return widget_type;
 781 }
 782
 783 static void
 784 gtk_widget_base_class_init (gpointer g_class)
 785 {
 786   GtkWidgetClass *klass = g_class;
 787
 788   klass->priv = G_TYPE_CLASS_GET_PRIVATE (g_class, GTK_TYPE_WIDGET, GtkWidgetClassPrivate);
 789 }
 790
 791 static void
 792 child_property_notify_dispatcher (GObject     *object,
 793                                   guint        n_pspecs,
 794                                   GParamSpec **pspecs)
 795 {
 796   GTK_WIDGET_GET_CLASS (object)->dispatch_child_properties_changed (GTK_WIDGET (object), n_pspecs, pspecs);
 797 }
 798
 799 /* We guard against the draw signal callbacks modifying the state of the
 800  * cairo context by surounding it with save/restore.
 801  * Maybe we should also cairo_new_path() just to be sure?
 802  */
 803 static void
 804 gtk_widget_draw_marshaller (GClosure     *closure,
 805                             GValue       *return_value,
 806                             guint         n_param_values,
 807                             const GValue *param_values,
 808                             gpointer      invocation_hint,
 809                             gpointer      marshal_data)
 810 {
 811   cairo_t *cr = g_value_get_boxed (&param_values[1]);
 812
 813   cairo_save (cr);
 814
 815   _gtk_marshal_BOOLEAN__BOXED (closure,
 816                                return_value,
 817                                n_param_values,
 818                                param_values,
 819                                invocation_hint,
 820                                marshal_data);
 821
 822   cairo_restore (cr);
 823 }
 824
 825 static void
 826 gtk_widget_draw_marshallerv (GClosure     *closure,
 827                              GValue       *return_value,
 828                              gpointer      instance,
 829                              va_list       args,
 830                              gpointer      marshal_data,
 831                              int           n_params,
 832                              GType        *param_types)
 833 {
 834   cairo_t *cr;
 835   va_list args_copy;
 836
 837   G_VA_COPY (args_copy, args);
 838   cr = va_arg (args_copy, gpointer);
 839
 840   cairo_save (cr);
 841
 842   _gtk_marshal_BOOLEAN__BOXEDv (closure,
 843                                 return_value,
 844                                 instance,
 845                                 args,
 846                                 marshal_data,
 847                                 n_params,
 848                                 param_types);
 849
 850   cairo_restore (cr);
 851
 852   va_end (args_copy);
 853 }
 854
 855 static void
 856 gtk_widget_class_init (GtkWidgetClass *klass)
 857 {
 858   static GObjectNotifyContext cpn_context = { 0, NULL, NULL };
 859   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 860   GtkBindingSet *binding_set;
 861
 862   gtk_widget_parent_class = g_type_class_peek_parent (klass);
 863
 864   quark_property_parser = g_quark_from_static_string ("gtk-rc-property-parser");
 865   quark_aux_info = g_quark_from_static_string ("gtk-aux-info");
 866   quark_accel_path = g_quark_from_static_string ("gtk-accel-path");
 867   quark_accel_closures = g_quark_from_static_string ("gtk-accel-closures");
 868   quark_event_mask = g_quark_from_static_string ("gtk-event-mask");
 869   quark_device_event_mask = g_quark_from_static_string ("gtk-device-event-mask");
 870   quark_parent_window = g_quark_from_static_string ("gtk-parent-window");
 871   quark_pointer_window = g_quark_from_static_string ("gtk-pointer-window");
 872   quark_shape_info = g_quark_from_static_string ("gtk-shape-info");
 873   quark_input_shape_info = g_quark_from_static_string ("gtk-input-shape-info");
 874   quark_pango_context = g_quark_from_static_string ("gtk-pango-context");
 875   quark_accessible_object = g_quark_from_static_string ("gtk-accessible-object");
 876   quark_mnemonic_labels = g_quark_from_static_string ("gtk-mnemonic-labels");
 877   quark_tooltip_markup = g_quark_from_static_string ("gtk-tooltip-markup");
 878   quark_has_tooltip = g_quark_from_static_string ("gtk-has-tooltip");
 879   quark_tooltip_window = g_quark_from_static_string ("gtk-tooltip-window");
 880   quark_visual = g_quark_from_static_string ("gtk-widget-visual");
 881   quark_modifier_style = g_quark_from_static_string ("gtk-widget-modifier-style");
 882   quark_enabled_devices = g_quark_from_static_string ("gtk-widget-enabled-devices");
 883   quark_size_groups = g_quark_from_static_string ("gtk-widget-size-groups");
 884
 885   style_property_spec_pool = g_param_spec_pool_new (FALSE);
 886   _gtk_widget_child_property_pool = g_param_spec_pool_new (TRUE);
 887   cpn_context.quark_notify_queue = g_quark_from_static_string ("GtkWidget-child-property-notify-queue");
 888   cpn_context.dispatcher = child_property_notify_dispatcher;
 889   _gtk_widget_child_property_notify_context = &cpn_context;
 890
 891   gobject_class->constructed = gtk_widget_constructed;
 892   gobject_class->dispose = gtk_widget_dispose;
 893   gobject_class->finalize = gtk_widget_finalize;
 894   gobject_class->set_property = gtk_widget_set_property;
 895   gobject_class->get_property = gtk_widget_get_property;
 896
 897   klass->destroy = gtk_widget_real_destroy;
 898
 899   klass->activate_signal = 0;
 900   klass->dispatch_child_properties_changed = gtk_widget_dispatch_child_properties_changed;
 901   klass->show = gtk_widget_real_show;
 902   klass->show_all = gtk_widget_show;
 903   klass->hide = gtk_widget_real_hide;
 904   klass->map = gtk_widget_real_map;
 905   klass->unmap = gtk_widget_real_unmap;
 906   klass->realize = gtk_widget_real_realize;
 907   klass->unrealize = gtk_widget_real_unrealize;
 908   klass->size_allocate = gtk_widget_real_size_allocate;
 909   klass->get_request_mode = gtk_widget_real_get_request_mode;
 910   klass->get_preferred_width = gtk_widget_real_get_width;
 911   klass->get_preferred_height = gtk_widget_real_get_height;
 912   klass->get_preferred_width_for_height = gtk_widget_real_get_width_for_height;
 913   klass->get_preferred_height_for_width = gtk_widget_real_get_height_for_width;
 914   klass->state_changed = NULL;
 915   klass->state_flags_changed = gtk_widget_real_state_flags_changed;
 916   klass->parent_set = NULL;
 917   klass->hierarchy_changed = NULL;
 918   klass->style_set = gtk_widget_real_style_set;
 919   klass->direction_changed = gtk_widget_real_direction_changed;
 920   klass->grab_notify = NULL;
 921   klass->child_notify = NULL;
 922   klass->draw = NULL;
 923   klass->mnemonic_activate = gtk_widget_real_mnemonic_activate;
 924   klass->grab_focus = gtk_widget_real_grab_focus;
 925   klass->focus = gtk_widget_real_focus;
 926   klass->move_focus = gtk_widget_real_move_focus;
 927   klass->keynav_failed = gtk_widget_real_keynav_failed;
 928   klass->event = NULL;
 929   klass->button_press_event = NULL;
 930   klass->button_release_event = NULL;
 931   klass->motion_notify_event = NULL;
 932   klass->touch_event = gtk_widget_real_touch_event;
 933   klass->delete_event = NULL;
 934   klass->destroy_event = NULL;
 935   klass->key_press_event = gtk_widget_real_key_press_event;
 936   klass->key_release_event = gtk_widget_real_key_release_event;
 937   klass->enter_notify_event = NULL;
 938   klass->leave_notify_event = NULL;
 939   klass->configure_event = NULL;
 940   klass->focus_in_event = gtk_widget_real_focus_in_event;
 941   klass->focus_out_event = gtk_widget_real_focus_out_event;
 942   klass->map_event = NULL;
 943   klass->unmap_event = NULL;
 944   klass->window_state_event = NULL;
 945   klass->property_notify_event = _gtk_selection_property_notify;
 946   klass->selection_clear_event = _gtk_selection_clear;
 947   klass->selection_request_event = _gtk_selection_request;
 948   klass->selection_notify_event = _gtk_selection_notify;
 949   klass->selection_received = NULL;
 950   klass->proximity_in_event = NULL;
 951   klass->proximity_out_event = NULL;
 952   klass->drag_begin = NULL;
 953   klass->drag_end = NULL;
 954   klass->drag_data_delete = NULL;
 955   klass->drag_leave = NULL;
 956   klass->drag_motion = NULL;
 957   klass->drag_drop = NULL;
 958   klass->drag_data_received = NULL;
 959   klass->screen_changed = NULL;
 960   klass->can_activate_accel = gtk_widget_real_can_activate_accel;
 961   klass->grab_broken_event = NULL;
 962   klass->query_tooltip = gtk_widget_real_query_tooltip;
 963   klass->style_updated = gtk_widget_real_style_updated;
 964
 965   klass->show_help = gtk_widget_real_show_help;
 966
 967   /* Accessibility support */
 968   klass->priv->accessible_type = GTK_TYPE_ACCESSIBLE;
 969   klass->priv->accessible_role = ATK_ROLE_INVALID;
 970   klass->get_accessible = gtk_widget_real_get_accessible;
 971
 972   klass->adjust_size_request = gtk_widget_real_adjust_size_request;
 973   klass->adjust_size_allocation = gtk_widget_real_adjust_size_allocation;
 974
 975   g_object_class_install_property (gobject_class,
 976                                    PROP_NAME,
 977                                    g_param_spec_string ("name",
 978                                                         P_("Widget name"),
 979                                                         P_("The name of the widget"),
 980                                                         NULL,
 981                                                         GTK_PARAM_READWRITE));
 982   g_object_class_install_property (gobject_class,
 983                                    PROP_PARENT,
 984                                    g_param_spec_object ("parent",
 985                                                         P_("Parent widget"),
 986                                                         P_("The parent widget of this widget. Must be a Container widget"),
 987                                                         GTK_TYPE_CONTAINER,
 988                                                         GTK_PARAM_READWRITE));
 989
 990   g_object_class_install_property (gobject_class,
 991                                    PROP_WIDTH_REQUEST,
 992                                    g_param_spec_int ("width-request",
 993                                                      P_("Width request"),
 994                                                      P_("Override for width request of the widget, or -1 if natural request should be used"),
 995                                                      -1,
 996                                                      G_MAXINT,
 997                                                      -1,
 998                                                      GTK_PARAM_READWRITE));
 999   g_object_class_install_property (gobject_class,
1000                                    PROP_HEIGHT_REQUEST,
1001                                    g_param_spec_int ("height-request",
1002                                                      P_("Height request"),
1003                                                      P_("Override for height request of the widget, or -1 if natural request should be used"),
1004                                                      -1,
1005                                                      G_MAXINT,
1006                                                      -1,
1007                                                      GTK_PARAM_READWRITE));
1008   g_object_class_install_property (gobject_class,
1009                                    PROP_VISIBLE,
1010                                    g_param_spec_boolean ("visible",
1011                                                          P_("Visible"),
1012                                                          P_("Whether the widget is visible"),
1013                                                          FALSE,
1014                                                          GTK_PARAM_READWRITE));
1015   g_object_class_install_property (gobject_class,
1016                                    PROP_SENSITIVE,
1017                                    g_param_spec_boolean ("sensitive",
1018                                                          P_("Sensitive"),
1019                                                          P_("Whether the widget responds to input"),
1020                                                          TRUE,
1021                                                          GTK_PARAM_READWRITE));
1022   g_object_class_install_property (gobject_class,
1023                                    PROP_APP_PAINTABLE,
1024                                    g_param_spec_boolean ("app-paintable",
1025                                                          P_("Application paintable"),
1026                                                          P_("Whether the application will paint directly on the widget"),
1027                                                          FALSE,
1028                                                          GTK_PARAM_READWRITE));
1029   g_object_class_install_property (gobject_class,
1030                                    PROP_CAN_FOCUS,
1031                                    g_param_spec_boolean ("can-focus",
1032                                                          P_("Can focus"),
1033                                                          P_("Whether the widget can accept the input focus"),
1034                                                          FALSE,
1035                                                          GTK_PARAM_READWRITE));
1036   g_object_class_install_property (gobject_class,
1037                                    PROP_HAS_FOCUS,
1038                                    g_param_spec_boolean ("has-focus",
1039                                                          P_("Has focus"),
1040                                                          P_("Whether the widget has the input focus"),
1041                                                          FALSE,
1042                                                          GTK_PARAM_READWRITE));
1043   g_object_class_install_property (gobject_class,
1044                                    PROP_IS_FOCUS,
1045                                    g_param_spec_boolean ("is-focus",
1046                                                          P_("Is focus"),
1047                                                          P_("Whether the widget is the focus widget within the toplevel"),
1048                                                          FALSE,
1049                                                          GTK_PARAM_READWRITE));
1050   g_object_class_install_property (gobject_class,
1051                                    PROP_CAN_DEFAULT,
1052                                    g_param_spec_boolean ("can-default",
1053                                                          P_("Can default"),
1054                                                          P_("Whether the widget can be the default widget"),
1055                                                          FALSE,
1056                                                          GTK_PARAM_READWRITE));
1057   g_object_class_install_property (gobject_class,
1058                                    PROP_HAS_DEFAULT,
1059                                    g_param_spec_boolean ("has-default",
1060                                                          P_("Has default"),
1061                                                          P_("Whether the widget is the default widget"),
1062                                                          FALSE,
1063                                                          GTK_PARAM_READWRITE));
1064   g_object_class_install_property (gobject_class,
1065                                    PROP_RECEIVES_DEFAULT,
1066                                    g_param_spec_boolean ("receives-default",
1067                                                          P_("Receives default"),
1068                                                          P_("If TRUE, the widget will receive the default action when it is focused"),
1069                                                          FALSE,
1070                                                          GTK_PARAM_READWRITE));
1071   g_object_class_install_property (gobject_class,
1072                                    PROP_COMPOSITE_CHILD,
1073                                    g_param_spec_boolean ("composite-child",
1074                                                          P_("Composite child"),
1075                                                          P_("Whether the widget is part of a composite widget"),
1076                                                          FALSE,
1077                                                          GTK_PARAM_READABLE));
1078   g_object_class_install_property (gobject_class,
1079                                    PROP_STYLE,
1080                                    g_param_spec_object ("style",
1081                                                         P_("Style"),
1082                                                         P_("The style of the widget, which contains information about how it will look (colors etc)"),
1083                                                         GTK_TYPE_STYLE,
1084                                                         GTK_PARAM_READWRITE));
1085   g_object_class_install_property (gobject_class,
1086                                    PROP_EVENTS,
1087                                    g_param_spec_flags ("events",
1088                                                        P_("Events"),
1089                                                        P_("The event mask that decides what kind of GdkEvents this widget gets"),
1090                                                        GDK_TYPE_EVENT_MASK,
1091                                                        GDK_STRUCTURE_MASK,
1092                                                        GTK_PARAM_READWRITE));
1093   g_object_class_install_property (gobject_class,
1094                                    PROP_NO_SHOW_ALL,
1095                                    g_param_spec_boolean ("no-show-all",
1096                                                          P_("No show all"),
1097                                                          P_("Whether gtk_widget_show_all() should not affect this widget"),
1098                                                          FALSE,
1099                                                          GTK_PARAM_READWRITE));
1100
1101 /**
1102  * GtkWidget:has-tooltip:
1103  *
1104  * Enables or disables the emission of #GtkWidget::query-tooltip on @widget.
1105  * A value of %TRUE indicates that @widget can have a tooltip, in this case
1106  * the widget will be queried using #GtkWidget::query-tooltip to determine
1107  * whether it will provide a tooltip or not.
1108  *
1109  * Note that setting this property to %TRUE for the first time will change
1110  * the event masks of the GdkWindows of this widget to include leave-notify
1111  * and motion-notify events.  This cannot and will not be undone when the
1112  * property is set to %FALSE again.
1113  *
1114  * Since: 2.12
1115  */
1116   g_object_class_install_property (gobject_class,
1117                                    PROP_HAS_TOOLTIP,
1118                                    g_param_spec_boolean ("has-tooltip",
1119                                                          P_("Has tooltip"),
1120                                                          P_("Whether this widget has a tooltip"),
1121                                                          FALSE,
1122                                                          GTK_PARAM_READWRITE));
1123   /**
1124    * GtkWidget:tooltip-text:
1125    *
1126    * Sets the text of tooltip to be the given string.
1127    *
1128    * Also see gtk_tooltip_set_text().
1129    *
1130    * This is a convenience property which will take care of getting the
1131    * tooltip shown if the given string is not %NULL: #GtkWidget:has-tooltip
1132    * will automatically be set to %TRUE and there will be taken care of
1133    * #GtkWidget::query-tooltip in the default signal handler.
1134    *
1135    * Since: 2.12
1136    */
1137   g_object_class_install_property (gobject_class,
1138                                    PROP_TOOLTIP_TEXT,
1139                                    g_param_spec_string ("tooltip-text",
1140                                                         P_("Tooltip Text"),
1141                                                         P_("The contents of the tooltip for this widget"),
1142                                                         NULL,
1143                                                         GTK_PARAM_READWRITE));
1144   /**
1145    * GtkWidget:tooltip-markup:
1146    *
1147    * Sets the text of tooltip to be the given string, which is marked up
1148    * with the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
1149    * Also see gtk_tooltip_set_markup().
1150    *
1151    * This is a convenience property which will take care of getting the
1152    * tooltip shown if the given string is not %NULL: #GtkWidget:has-tooltip
1153    * will automatically be set to %TRUE and there will be taken care of
1154    * #GtkWidget::query-tooltip in the default signal handler.
1155    *
1156    * Since: 2.12
1157    */
1158   g_object_class_install_property (gobject_class,
1159                                    PROP_TOOLTIP_MARKUP,
1160                                    g_param_spec_string ("tooltip-markup",
1161                                                         P_("Tooltip markup"),
1162                                                         P_("The contents of the tooltip for this widget"),
1163                                                         NULL,
1164                                                         GTK_PARAM_READWRITE));
1165
1166   /**
1167    * GtkWidget:window:
1168    *
1169    * The widget's window if it is realized, %NULL otherwise.
1170    *
1171    * Since: 2.14
1172    */
1173   g_object_class_install_property (gobject_class,
1174                                    PROP_WINDOW,
1175                                    g_param_spec_object ("window",
1176                                                         P_("Window"),
1177                                                         P_("The widget's window if it is realized"),
1178                                                         GDK_TYPE_WINDOW,
1179                                                         GTK_PARAM_READABLE));
1180
1181   /**
1182    * GtkWidget:double-buffered:
1183    *
1184    * Whether the widget is double buffered.
1185    *
1186    * Since: 2.18
1187    */
1188   g_object_class_install_property (gobject_class,
1189                                    PROP_DOUBLE_BUFFERED,
1190                                    g_param_spec_boolean ("double-buffered",
1191                                                          P_("Double Buffered"),
1192                                                          P_("Whether the widget is double buffered"),
1193                                                          TRUE,
1194                                                          GTK_PARAM_READWRITE));
1195
1196   /**
1197    * GtkWidget:halign:
1198    *
1199    * How to distribute horizontal space if widget gets extra space, see #GtkAlign
1200    *
1201    * Since: 3.0
1202    */
1203   g_object_class_install_property (gobject_class,
1204                                    PROP_HALIGN,
1205                                    g_param_spec_enum ("halign",
1206                                                       P_("Horizontal Alignment"),
1207                                                       P_("How to position in extra horizontal space"),
1208                                                       GTK_TYPE_ALIGN,
1209                                                       GTK_ALIGN_FILL,
1210                                                       GTK_PARAM_READWRITE));
1211
1212   /**
1213    * GtkWidget:valign:
1214    *
1215    * How to distribute vertical space if widget gets extra space, see #GtkAlign
1216    *
1217    * Since: 3.0
1218    */
1219   g_object_class_install_property (gobject_class,
1220                                    PROP_VALIGN,
1221                                    g_param_spec_enum ("valign",
1222                                                       P_("Vertical Alignment"),
1223                                                       P_("How to position in extra vertical space"),
1224                                                       GTK_TYPE_ALIGN,
1225                                                       GTK_ALIGN_FILL,
1226                                                       GTK_PARAM_READWRITE));
1227
1228   /**
1229    * GtkWidget:margin-left:
1230    *
1231    * Margin on left side of widget.
1232    *
1233    * This property adds margin outside of the widget's normal size
1234    * request, the margin will be added in addition to the size from
1235    * gtk_widget_set_size_request() for example.
1236    *
1237    * Since: 3.0
1238    */
1239   g_object_class_install_property (gobject_class,
1240                                    PROP_MARGIN_LEFT,
1241                                    g_param_spec_int ("margin-left",
1242                                                      P_("Margin on Left"),
1243                                                      P_("Pixels of extra space on the left side"),
1244                                                      0,
1245                                                      G_MAXINT16,
1246                                                      0,
1247                                                      GTK_PARAM_READWRITE));
1248
1249   /**
1250    * GtkWidget:margin-right:
1251    *
1252    * Margin on right side of widget.
1253    *
1254    * This property adds margin outside of the widget's normal size
1255    * request, the margin will be added in addition to the size from
1256    * gtk_widget_set_size_request() for example.
1257    *
1258    * Since: 3.0
1259    */
1260   g_object_class_install_property (gobject_class,
1261                                    PROP_MARGIN_RIGHT,
1262                                    g_param_spec_int ("margin-right",
1263                                                      P_("Margin on Right"),
1264                                                      P_("Pixels of extra space on the right side"),
1265                                                      0,
1266                                                      G_MAXINT16,
1267                                                      0,
1268                                                      GTK_PARAM_READWRITE));
1269
1270   /**
1271    * GtkWidget:margin-top:
1272    *
1273    * Margin on top side of widget.
1274    *
1275    * This property adds margin outside of the widget's normal size
1276    * request, the margin will be added in addition to the size from
1277    * gtk_widget_set_size_request() for example.
1278    *
1279    * Since: 3.0
1280    */
1281   g_object_class_install_property (gobject_class,
1282                                    PROP_MARGIN_TOP,
1283                                    g_param_spec_int ("margin-top",
1284                                                      P_("Margin on Top"),
1285                                                      P_("Pixels of extra space on the top side"),
1286                                                      0,
1287                                                      G_MAXINT16,
1288                                                      0,
1289                                                      GTK_PARAM_READWRITE));
1290
1291   /**
1292    * GtkWidget:margin-bottom:
1293    *
1294    * Margin on bottom side of widget.
1295    *
1296    * This property adds margin outside of the widget's normal size
1297    * request, the margin will be added in addition to the size from
1298    * gtk_widget_set_size_request() for example.
1299    *
1300    * Since: 3.0
1301    */
1302   g_object_class_install_property (gobject_class,
1303                                    PROP_MARGIN_BOTTOM,
1304                                    g_param_spec_int ("margin-bottom",
1305                                                      P_("Margin on Bottom"),
1306                                                      P_("Pixels of extra space on the bottom side"),
1307                                                      0,
1308                                                      G_MAXINT16,
1309                                                      0,
1310                                                      GTK_PARAM_READWRITE));
1311
1312   /**
1313    * GtkWidget:margin:
1314    *
1315    * Sets all four sides' margin at once. If read, returns max
1316    * margin on any side.
1317    *
1318    * Since: 3.0
1319    */
1320   g_object_class_install_property (gobject_class,
1321                                    PROP_MARGIN,
1322                                    g_param_spec_int ("margin",
1323                                                      P_("All Margins"),
1324                                                      P_("Pixels of extra space on all four sides"),
1325                                                      0,
1326                                                      G_MAXINT16,
1327                                                      0,
1328                                                      GTK_PARAM_READWRITE));
1329
1330   /**
1331    * GtkWidget::destroy:
1332    * @object: the object which received the signal
1333    *
1334    * Signals that all holders of a reference to the widget should release
1335    * the reference that they hold. May result in finalization of the widget
1336    * if all references are released.
1337    */
1338   widget_signals[DESTROY] =
1339     g_signal_new (I_("destroy"),
1340                   G_TYPE_FROM_CLASS (gobject_class),
1341                   G_SIGNAL_RUN_CLEANUP | G_SIGNAL_NO_RECURSE | G_SIGNAL_NO_HOOKS,
1342                   G_STRUCT_OFFSET (GtkWidgetClass, destroy),
1343                   NULL, NULL,
1344                   _gtk_marshal_VOID__VOID,
1345                   G_TYPE_NONE, 0);
1346
1347   /**
1348    * GtkWidget:hexpand:
1349    *
1350    * Whether to expand horizontally. See gtk_widget_set_hexpand().
1351    *
1352    * Since: 3.0
1353    */
1354   g_object_class_install_property (gobject_class,
1355                                    PROP_HEXPAND,
1356                                    g_param_spec_boolean ("hexpand",
1357                                                          P_("Horizontal Expand"),
1358                                                          P_("Whether widget wants more horizontal space"),
1359                                                          FALSE,
1360                                                          GTK_PARAM_READWRITE));
1361
1362   /**
1363    * GtkWidget:hexpand-set:
1364    *
1365    * Whether to use the #GtkWidget:hexpand property. See gtk_widget_get_hexpand_set().
1366    *
1367    * Since: 3.0
1368    */
1369   g_object_class_install_property (gobject_class,
1370                                    PROP_HEXPAND_SET,
1371                                    g_param_spec_boolean ("hexpand-set",
1372                                                          P_("Horizontal Expand Set"),
1373                                                          P_("Whether to use the hexpand property"),
1374                                                          FALSE,
1375                                                          GTK_PARAM_READWRITE));
1376
1377   /**
1378    * GtkWidget:vexpand:
1379    *
1380    * Whether to expand vertically. See gtk_widget_set_vexpand().
1381    *
1382    * Since: 3.0
1383    */
1384   g_object_class_install_property (gobject_class,
1385                                    PROP_VEXPAND,
1386                                    g_param_spec_boolean ("vexpand",
1387                                                          P_("Vertical Expand"),
1388                                                          P_("Whether widget wants more vertical space"),
1389                                                          FALSE,
1390                                                          GTK_PARAM_READWRITE));
1391
1392   /**
1393    * GtkWidget:vexpand-set:
1394    *
1395    * Whether to use the #GtkWidget:vexpand property. See gtk_widget_get_vexpand_set().
1396    *
1397    * Since: 3.0
1398    */
1399   g_object_class_install_property (gobject_class,
1400                                    PROP_VEXPAND_SET,
1401                                    g_param_spec_boolean ("vexpand-set",
1402                                                          P_("Vertical Expand Set"),
1403                                                          P_("Whether to use the vexpand property"),
1404                                                          FALSE,
1405                                                          GTK_PARAM_READWRITE));
1406
1407   /**
1408    * GtkWidget:expand:
1409    *
1410    * Whether to expand in both directions. Setting this sets both #GtkWidget:hexpand and #GtkWidget:vexpand
1411    *
1412    * Since: 3.0
1413    */
1414   g_object_class_install_property (gobject_class,
1415                                    PROP_EXPAND,
1416                                    g_param_spec_boolean ("expand",
1417                                                          P_("Expand Both"),
1418                                                          P_("Whether widget wants to expand in both directions"),
1419                                                          FALSE,
1420                                                          GTK_PARAM_READWRITE));
1421
1422   /**
1423    * GtkWidget::show:
1424    * @widget: the object which received the signal.
1425    */
1426   widget_signals[SHOW] =
1427     g_signal_new (I_("show"),
1428                   G_TYPE_FROM_CLASS (gobject_class),
1429                   G_SIGNAL_RUN_FIRST,
1430                   G_STRUCT_OFFSET (GtkWidgetClass, show),
1431                   NULL, NULL,
1432                   _gtk_marshal_VOID__VOID,
1433                   G_TYPE_NONE, 0);
1434
1435   /**
1436    * GtkWidget::hide:
1437    * @widget: the object which received the signal.
1438    */
1439   widget_signals[HIDE] =
1440     g_signal_new (I_("hide"),
1441                   G_TYPE_FROM_CLASS (gobject_class),
1442                   G_SIGNAL_RUN_FIRST,
1443                   G_STRUCT_OFFSET (GtkWidgetClass, hide),
1444                   NULL, NULL,
1445                   _gtk_marshal_VOID__VOID,
1446                   G_TYPE_NONE, 0);
1447
1448   /**
1449    * GtkWidget::map:
1450    * @widget: the object which received the signal.
1451    */
1452   widget_signals[MAP] =
1453     g_signal_new (I_("map"),
1454                   G_TYPE_FROM_CLASS (gobject_class),
1455                   G_SIGNAL_RUN_FIRST,
1456                   G_STRUCT_OFFSET (GtkWidgetClass, map),
1457                   NULL, NULL,
1458                   _gtk_marshal_VOID__VOID,
1459                   G_TYPE_NONE, 0);
1460
1461   /**
1462    * GtkWidget::unmap:
1463    * @widget: the object which received the signal.
1464    */
1465   widget_signals[UNMAP] =
1466     g_signal_new (I_("unmap"),
1467                   G_TYPE_FROM_CLASS (gobject_class),
1468                   G_SIGNAL_RUN_FIRST,
1469                   G_STRUCT_OFFSET (GtkWidgetClass, unmap),
1470                   NULL, NULL,
1471                   _gtk_marshal_VOID__VOID,
1472                   G_TYPE_NONE, 0);
1473
1474   /**
1475    * GtkWidget::realize:
1476    * @widget: the object which received the signal.
1477    */
1478   widget_signals[REALIZE] =
1479     g_signal_new (I_("realize"),
1480                   G_TYPE_FROM_CLASS (gobject_class),
1481                   G_SIGNAL_RUN_FIRST,
1482                   G_STRUCT_OFFSET (GtkWidgetClass, realize),
1483                   NULL, NULL,
1484                   _gtk_marshal_VOID__VOID,
1485                   G_TYPE_NONE, 0);
1486
1487   /**
1488    * GtkWidget::unrealize:
1489    * @widget: the object which received the signal.
1490    */
1491   widget_signals[UNREALIZE] =
1492     g_signal_new (I_("unrealize"),
1493                   G_TYPE_FROM_CLASS (gobject_class),
1494                   G_SIGNAL_RUN_LAST,
1495                   G_STRUCT_OFFSET (GtkWidgetClass, unrealize),
1496                   NULL, NULL,
1497                   _gtk_marshal_VOID__VOID,
1498                   G_TYPE_NONE, 0);
1499
1500   /**
1501    * GtkWidget::size-allocate:
1502    * @widget: the object which received the signal.
1503    * @allocation:
1504    */
1505   widget_signals[SIZE_ALLOCATE] =
1506     g_signal_new (I_("size-allocate"),
1507                   G_TYPE_FROM_CLASS (gobject_class),
1508                   G_SIGNAL_RUN_FIRST,
1509                   G_STRUCT_OFFSET (GtkWidgetClass, size_allocate),
1510                   NULL, NULL,
1511                   _gtk_marshal_VOID__BOXED,
1512                   G_TYPE_NONE, 1,
1513                   GDK_TYPE_RECTANGLE | G_SIGNAL_TYPE_STATIC_SCOPE);
1514
1515   /**
1516    * GtkWidget::state-changed:
1517    * @widget: the object which received the signal.
1518    * @state: the previous state
1519    *
1520    * The ::state-changed signal is emitted when the widget state changes.
1521    * See gtk_widget_get_state().
1522    *
1523    * Deprecated: 3.0. Use #GtkWidget::state-flags-changed instead.
1524    */
1525   widget_signals[STATE_CHANGED] =
1526     g_signal_new (I_("state-changed"),
1527                   G_TYPE_FROM_CLASS (gobject_class),
1528                   G_SIGNAL_RUN_FIRST,
1529                   G_STRUCT_OFFSET (GtkWidgetClass, state_changed),
1530                   NULL, NULL,
1531                   _gtk_marshal_VOID__ENUM,
1532                   G_TYPE_NONE, 1,
1533                   GTK_TYPE_STATE_TYPE);
1534
1535   /**
1536    * GtkWidget::state-flags-changed:
1537    * @widget: the object which received the signal.
1538    * @flags: The previous state flags.
1539    *
1540    * The ::state-flags-changed signal is emitted when the widget state
1541    * changes, see gtk_widget_get_state_flags().
1542    *
1543    * Since: 3.0
1544    */
1545   widget_signals[STATE_FLAGS_CHANGED] =
1546     g_signal_new (I_("state-flags-changed"),
1547                   G_TYPE_FROM_CLASS (gobject_class),
1548                   G_SIGNAL_RUN_FIRST,
1549                   G_STRUCT_OFFSET (GtkWidgetClass, state_flags_changed),
1550                   NULL, NULL,
1551                   _gtk_marshal_VOID__FLAGS,
1552                   G_TYPE_NONE, 1,
1553                   GTK_TYPE_STATE_FLAGS);
1554
1555   /**
1556    * GtkWidget::parent-set:
1557    * @widget: the object on which the signal is emitted
1558    * @old_parent: (allow-none): the previous parent, or %NULL if the widget
1559    *   just got its initial parent.
1560    *
1561    * The ::parent-set signal is emitted when a new parent
1562    * has been set on a widget.
1563    */
1564   widget_signals[PARENT_SET] =
1565     g_signal_new (I_("parent-set"),
1566                   G_TYPE_FROM_CLASS (gobject_class),
1567                   G_SIGNAL_RUN_FIRST,
1568                   G_STRUCT_OFFSET (GtkWidgetClass, parent_set),
1569                   NULL, NULL,
1570                   _gtk_marshal_VOID__OBJECT,
1571                   G_TYPE_NONE, 1,
1572                   GTK_TYPE_WIDGET);
1573
1574   /**
1575    * GtkWidget::hierarchy-changed:
1576    * @widget: the object on which the signal is emitted
1577    * @previous_toplevel: (allow-none): the previous toplevel ancestor, or %NULL
1578    *   if the widget was previously unanchored
1579    *
1580    * The ::hierarchy-changed signal is emitted when the
1581    * anchored state of a widget changes. A widget is
1582    * <firstterm>anchored</firstterm> when its toplevel
1583    * ancestor is a #GtkWindow. This signal is emitted when
1584    * a widget changes from un-anchored to anchored or vice-versa.
1585    */
1586   widget_signals[HIERARCHY_CHANGED] =
1587     g_signal_new (I_("hierarchy-changed"),
1588                   G_TYPE_FROM_CLASS (gobject_class),
1589                   G_SIGNAL_RUN_LAST,
1590                   G_STRUCT_OFFSET (GtkWidgetClass, hierarchy_changed),
1591                   NULL, NULL,
1592                   _gtk_marshal_VOID__OBJECT,
1593                   G_TYPE_NONE, 1,
1594                   GTK_TYPE_WIDGET);
1595
1596   /**
1597    * GtkWidget::style-set:
1598    * @widget: the object on which the signal is emitted
1599    * @previous_style: (allow-none): the previous style, or %NULL if the widget
1600    *   just got its initial style
1601    *
1602    * The ::style-set signal is emitted when a new style has been set
1603    * on a widget. Note that style-modifying functions like
1604    * gtk_widget_modify_base() also cause this signal to be emitted.
1605    *
1606    * Note that this signal is emitted for changes to the deprecated
1607    * #GtkStyle. To track changes to the #GtkStyleContext associated
1608    * with a widget, use the #GtkWidget::style-updated signal.
1609    *
1610    * Deprecated:3.0: Use the #GtkWidget::style-updated signal
1611    */
1612   widget_signals[STYLE_SET] =
1613     g_signal_new (I_("style-set"),
1614                   G_TYPE_FROM_CLASS (gobject_class),
1615                   G_SIGNAL_RUN_FIRST,
1616                   G_STRUCT_OFFSET (GtkWidgetClass, style_set),
1617                   NULL, NULL,
1618                   _gtk_marshal_VOID__OBJECT,
1619                   G_TYPE_NONE, 1,
1620                   GTK_TYPE_STYLE);
1621
1622   /**
1623    * GtkWidget::style-updated:
1624    * @widget: the object on which the signal is emitted
1625    *
1626    * The ::style-updated signal is emitted when the #GtkStyleContext
1627    * of a widget is changed. Note that style-modifying functions like
1628    * gtk_widget_override_color() also cause this signal to be emitted.
1629    *
1630    * Since: 3.0
1631    */
1632   widget_signals[STYLE_UPDATED] =
1633     g_signal_new (I_("style-updated"),
1634                   G_TYPE_FROM_CLASS (gobject_class),
1635                   G_SIGNAL_RUN_FIRST,
1636                   G_STRUCT_OFFSET (GtkWidgetClass, style_updated),
1637                   NULL, NULL,
1638                   g_cclosure_marshal_VOID__VOID,
1639                   G_TYPE_NONE, 0);
1640
1641   /**
1642    * GtkWidget::direction-changed:
1643    * @widget: the object on which the signal is emitted
1644    * @previous_direction: the previous text direction of @widget
1645    *
1646    * The ::direction-changed signal is emitted when the text direction
1647    * of a widget changes.
1648    */
1649   widget_signals[DIRECTION_CHANGED] =
1650     g_signal_new (I_("direction-changed"),
1651                   G_TYPE_FROM_CLASS (gobject_class),
1652                   G_SIGNAL_RUN_FIRST,
1653                   G_STRUCT_OFFSET (GtkWidgetClass, direction_changed),
1654                   NULL, NULL,
1655                   _gtk_marshal_VOID__ENUM,
1656                   G_TYPE_NONE, 1,
1657                   GTK_TYPE_TEXT_DIRECTION);
1658
1659   /**
1660    * GtkWidget::grab-notify:
1661    * @widget: the object which received the signal
1662    * @was_grabbed: %FALSE if the widget becomes shadowed, %TRUE
1663    *               if it becomes unshadowed
1664    *
1665    * The ::grab-notify signal is emitted when a widget becomes
1666    * shadowed by a GTK+ grab (not a pointer or keyboard grab) on
1667    * another widget, or when it becomes unshadowed due to a grab
1668    * being removed.
1669    *
1670    * A widget is shadowed by a gtk_grab_add() when the topmost
1671    * grab widget in the grab stack of its window group is not
1672    * its ancestor.
1673    */
1674   widget_signals[GRAB_NOTIFY] =
1675     g_signal_new (I_("grab-notify"),
1676                   G_TYPE_FROM_CLASS (gobject_class),
1677                   G_SIGNAL_RUN_FIRST,
1678                   G_STRUCT_OFFSET (GtkWidgetClass, grab_notify),
1679                   NULL, NULL,
1680                   _gtk_marshal_VOID__BOOLEAN,
1681                   G_TYPE_NONE, 1,
1682                   G_TYPE_BOOLEAN);
1683
1684   /**
1685    * GtkWidget::child-notify:
1686    * @widget: the object which received the signal
1687    * @child_property: the #GParamSpec of the changed child property
1688    *
1689    * The ::child-notify signal is emitted for each
1690    * <link linkend="child-properties">child property</link>  that has
1691    * changed on an object. The signal's detail holds the property name.
1692    */
1693   widget_signals[CHILD_NOTIFY] =
1694     g_signal_new (I_("child-notify"),
1695                    G_TYPE_FROM_CLASS (gobject_class),
1696                    G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE | G_SIGNAL_DETAILED | G_SIGNAL_NO_HOOKS,
1697                    G_STRUCT_OFFSET (GtkWidgetClass, child_notify),
1698                    NULL, NULL,
1699                    g_cclosure_marshal_VOID__PARAM,
1700                    G_TYPE_NONE, 1,
1701                    G_TYPE_PARAM);
1702
1703   /**
1704    * GtkWidget::draw:
1705    * @widget: the object which received the signal
1706    * @cr: the cairo context to draw to
1707    *
1708    * This signal is emitted when a widget is supposed to render itself.
1709    * The @widget's top left corner must be painted at the origin of
1710    * the passed in context and be sized to the values returned by
1711    * gtk_widget_get_allocated_width() and
1712    * gtk_widget_get_allocated_height().
1713    *
1714    * Signal handlers connected to this signal can modify the cairo
1715    * context passed as @cr in any way they like and don't need to
1716    * restore it. The signal emission takes care of calling cairo_save()
1717    * before and cairo_restore() after invoking the handler.
1718    *
1719    * Returns: %TRUE to stop other handlers from being invoked for the event.
1720    % %FALSE to propagate the event further.
1721    *
1722    * Since: 3.0
1723    */
1724   widget_signals[DRAW] =
1725     g_signal_new (I_("draw"),
1726                    G_TYPE_FROM_CLASS (gobject_class),
1727                    G_SIGNAL_RUN_LAST,
1728                    G_STRUCT_OFFSET (GtkWidgetClass, draw),
1729                    _gtk_boolean_handled_accumulator, NULL,
1730                    gtk_widget_draw_marshaller,
1731                    G_TYPE_BOOLEAN, 1,
1732                    CAIRO_GOBJECT_TYPE_CONTEXT);
1733   g_signal_set_va_marshaller (widget_signals[DRAW], G_TYPE_FROM_CLASS (klass),
1734                               gtk_widget_draw_marshallerv);
1735
1736   /**
1737    * GtkWidget::mnemonic-activate:
1738    * @widget: the object which received the signal.
1739    * @arg1:
1740    *
1741    * Returns: %TRUE to stop other handlers from being invoked for the event.
1742    * %FALSE to propagate the event further.
1743    */
1744   widget_signals[MNEMONIC_ACTIVATE] =
1745     g_signal_new (I_("mnemonic-activate"),
1746                   G_TYPE_FROM_CLASS (gobject_class),
1747                   G_SIGNAL_RUN_LAST,
1748                   G_STRUCT_OFFSET (GtkWidgetClass, mnemonic_activate),
1749                   _gtk_boolean_handled_accumulator, NULL,
1750                   _gtk_marshal_BOOLEAN__BOOLEAN,
1751                   G_TYPE_BOOLEAN, 1,
1752                   G_TYPE_BOOLEAN);
1753
1754   /**
1755    * GtkWidget::grab-focus:
1756    * @widget: the object which received the signal.
1757    */
1758   widget_signals[GRAB_FOCUS] =
1759     g_signal_new (I_("grab-focus"),
1760                   G_TYPE_FROM_CLASS (gobject_class),
1761                   G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
1762                   G_STRUCT_OFFSET (GtkWidgetClass, grab_focus),
1763                   NULL, NULL,
1764                   _gtk_marshal_VOID__VOID,
1765                   G_TYPE_NONE, 0);
1766
1767   /**
1768    * GtkWidget::focus:
1769    * @widget: the object which received the signal.
1770    * @direction:
1771    *
1772    * Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
1773    */
1774   widget_signals[FOCUS] =
1775     g_signal_new (I_("focus"),
1776                   G_TYPE_FROM_CLASS (klass),
1777                   G_SIGNAL_RUN_LAST,
1778                   G_STRUCT_OFFSET (GtkWidgetClass, focus),
1779                   _gtk_boolean_handled_accumulator, NULL,
1780                   _gtk_marshal_BOOLEAN__ENUM,
1781                   G_TYPE_BOOLEAN, 1,
1782                   GTK_TYPE_DIRECTION_TYPE);
1783
1784   /**
1785    * GtkWidget::move-focus:
1786    * @widget: the object which received the signal.
1787    * @direction:
1788    */
1789   widget_signals[MOVE_FOCUS] =
1790     g_signal_new (I_("move-focus"),
1791                   G_TYPE_FROM_CLASS (klass),
1792                   G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
1793                   G_STRUCT_OFFSET (GtkWidgetClass, move_focus),
1794                   NULL, NULL,
1795                   _gtk_marshal_VOID__ENUM,
1796                   G_TYPE_NONE,
1797                   1,
1798                   GTK_TYPE_DIRECTION_TYPE);
1799
1800   /**
1801    * GtkWidget::keynav-failed:
1802    * @widget: the object which received the signal
1803    * @direction: the direction of movement
1804    *
1805    * Gets emitted if keyboard navigation fails.
1806    * See gtk_widget_keynav_failed() for details.
1807    *
1808    * Returns: %TRUE if stopping keyboard navigation is fine, %FALSE
1809    *          if the emitting widget should try to handle the keyboard
1810    *          navigation attempt in its parent container(s).
1811    *
1812    * Since: 2.12
1813    **/
1814   widget_signals[KEYNAV_FAILED] =
1815     g_signal_new (I_("keynav-failed"),
1816                   G_TYPE_FROM_CLASS (klass),
1817                   G_SIGNAL_RUN_LAST,
1818                   G_STRUCT_OFFSET (GtkWidgetClass, keynav_failed),
1819                   _gtk_boolean_handled_accumulator, NULL,
1820                   _gtk_marshal_BOOLEAN__ENUM,
1821                   G_TYPE_BOOLEAN, 1,
1822                   GTK_TYPE_DIRECTION_TYPE);
1823
1824   /**
1825    * GtkWidget::event:
1826    * @widget: the object which received the signal.
1827    * @event: the #GdkEvent which triggered this signal
1828    *
1829    * The GTK+ main loop will emit three signals for each GDK event delivered
1830    * to a widget: one generic ::event signal, another, more specific,
1831    * signal that matches the type of event delivered (e.g.
1832    * #GtkWidget::key-press-event) and finally a generic
1833    * #GtkWidget::event-after signal.
1834    *
1835    * Returns: %TRUE to stop other handlers from being invoked for the event
1836    * and to cancel the emission of the second specific ::event signal.
1837    *   %FALSE to propagate the event further and to allow the emission of
1838    *   the second signal. The ::event-after signal is emitted regardless of
1839    *   the return value.
1840    */
1841   widget_signals[EVENT] =
1842     g_signal_new (I_("event"),
1843                   G_TYPE_FROM_CLASS (klass),
1844                   G_SIGNAL_RUN_LAST,
1845                   G_STRUCT_OFFSET (GtkWidgetClass, event),
1846                   _gtk_boolean_handled_accumulator, NULL,
1847                   _gtk_marshal_BOOLEAN__BOXED,
1848                   G_TYPE_BOOLEAN, 1,
1849                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1850   g_signal_set_va_marshaller (widget_signals[EVENT], G_TYPE_FROM_CLASS (klass),
1851                               _gtk_marshal_BOOLEAN__BOXEDv);
1852
1853   /**
1854    * GtkWidget::event-after:
1855    * @widget: the object which received the signal.
1856    * @event: the #GdkEvent which triggered this signal
1857    *
1858    * After the emission of the #GtkWidget::event signal and (optionally)
1859    * the second more specific signal, ::event-after will be emitted
1860    * regardless of the previous two signals handlers return values.
1861    *
1862    */
1863   widget_signals[EVENT_AFTER] =
1864     g_signal_new (I_("event-after"),
1865                   G_TYPE_FROM_CLASS (klass),
1866                   0,
1867                   0,
1868                   NULL, NULL,
1869                   _gtk_marshal_VOID__BOXED,
1870                   G_TYPE_NONE, 1,
1871                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1872   g_signal_set_va_marshaller (widget_signals[EVENT_AFTER], G_TYPE_FROM_CLASS (klass),
1873                               _gtk_marshal_BOOLEAN__BOXEDv);
1874
1875   /**
1876    * GtkWidget::button-press-event:
1877    * @widget: the object which received the signal.
1878    * @event: (type Gdk.EventButton): the #GdkEventButton which triggered
1879    *   this signal.
1880    *
1881    * The ::button-press-event signal will be emitted when a button
1882    * (typically from a mouse) is pressed.
1883    *
1884    * To receive this signal, the #GdkWindow associated to the
1885    * widget needs to enable the #GDK_BUTTON_PRESS_MASK mask.
1886    *
1887    * This signal will be sent to the grab widget if there is one.
1888    *
1889    * Returns: %TRUE to stop other handlers from being invoked for the event.
1890    *   %FALSE to propagate the event further.
1891    */
1892   widget_signals[BUTTON_PRESS_EVENT] =
1893     g_signal_new (I_("button-press-event"),
1894                   G_TYPE_FROM_CLASS (klass),
1895                   G_SIGNAL_RUN_LAST,
1896                   G_STRUCT_OFFSET (GtkWidgetClass, button_press_event),
1897                   _gtk_boolean_handled_accumulator, NULL,
1898                   _gtk_marshal_BOOLEAN__BOXED,
1899                   G_TYPE_BOOLEAN, 1,
1900                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1901   g_signal_set_va_marshaller (widget_signals[BUTTON_PRESS_EVENT], G_TYPE_FROM_CLASS (klass),
1902                               _gtk_marshal_BOOLEAN__BOXEDv);
1903
1904   /**
1905    * GtkWidget::button-release-event:
1906    * @widget: the object which received the signal.
1907    * @event: (type Gdk.EventButton): the #GdkEventButton which triggered
1908    *   this signal.
1909    *
1910    * The ::button-release-event signal will be emitted when a button
1911    * (typically from a mouse) is released.
1912    *
1913    * To receive this signal, the #GdkWindow associated to the
1914    * widget needs to enable the #GDK_BUTTON_RELEASE_MASK mask.
1915    *
1916    * This signal will be sent to the grab widget if there is one.
1917    *
1918    * Returns: %TRUE to stop other handlers from being invoked for the event.
1919    *   %FALSE to propagate the event further.
1920    */
1921   widget_signals[BUTTON_RELEASE_EVENT] =
1922     g_signal_new (I_("button-release-event"),
1923                   G_TYPE_FROM_CLASS (klass),
1924                   G_SIGNAL_RUN_LAST,
1925                   G_STRUCT_OFFSET (GtkWidgetClass, button_release_event),
1926                   _gtk_boolean_handled_accumulator, NULL,
1927                   _gtk_marshal_BOOLEAN__BOXED,
1928                   G_TYPE_BOOLEAN, 1,
1929                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1930   g_signal_set_va_marshaller (widget_signals[BUTTON_RELEASE_EVENT], G_TYPE_FROM_CLASS (klass),
1931                               _gtk_marshal_BOOLEAN__BOXEDv);
1932
1933   widget_signals[TOUCH_EVENT] =
1934     g_signal_new (I_("touch-event"),
1935                   G_TYPE_FROM_CLASS (klass),
1936                   G_SIGNAL_RUN_LAST,
1937                   G_STRUCT_OFFSET (GtkWidgetClass, touch_event),
1938                   _gtk_boolean_handled_accumulator, NULL,
1939                   _gtk_marshal_BOOLEAN__BOXED,
1940                   G_TYPE_BOOLEAN, 1,
1941                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1942   g_signal_set_va_marshaller (widget_signals[TOUCH_EVENT], G_TYPE_FROM_CLASS (klass),
1943                               _gtk_marshal_BOOLEAN__BOXEDv);
1944
1945   /**
1946    * GtkWidget::scroll-event:
1947    * @widget: the object which received the signal.
1948    * @event: (type Gdk.EventScroll): the #GdkEventScroll which triggered
1949    *   this signal.
1950    *
1951    * The ::scroll-event signal is emitted when a button in the 4 to 7
1952    * range is pressed. Wheel mice are usually configured to generate
1953    * button press events for buttons 4 and 5 when the wheel is turned.
1954    *
1955    * To receive this signal, the #GdkWindow associated to the widget needs
1956    * to enable the #GDK_SCROLL_MASK mask.
1957    *
1958    * This signal will be sent to the grab widget if there is one.
1959    *
1960    * Returns: %TRUE to stop other handlers from being invoked for the event.
1961    *   %FALSE to propagate the event further.
1962    */
1963   widget_signals[SCROLL_EVENT] =
1964     g_signal_new (I_("scroll-event"),
1965                   G_TYPE_FROM_CLASS (klass),
1966                   G_SIGNAL_RUN_LAST,
1967                   G_STRUCT_OFFSET (GtkWidgetClass, scroll_event),
1968                   _gtk_boolean_handled_accumulator, NULL,
1969                   _gtk_marshal_BOOLEAN__BOXED,
1970                   G_TYPE_BOOLEAN, 1,
1971                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1972   g_signal_set_va_marshaller (widget_signals[SCROLL_EVENT], G_TYPE_FROM_CLASS (klass),
1973                               _gtk_marshal_BOOLEAN__BOXEDv);
1974
1975   /**
1976    * GtkWidget::motion-notify-event:
1977    * @widget: the object which received the signal.
1978    * @event: (type Gdk.EventMotion): the #GdkEventMotion which triggered
1979    *   this signal.
1980    *
1981    * The ::motion-notify-event signal is emitted when the pointer moves
1982    * over the widget's #GdkWindow.
1983    *
1984    * To receive this signal, the #GdkWindow associated to the widget
1985    * needs to enable the #GDK_POINTER_MOTION_MASK mask.
1986    *
1987    * This signal will be sent to the grab widget if there is one.
1988    *
1989    * Returns: %TRUE to stop other handlers from being invoked for the event.
1990    *   %FALSE to propagate the event further.
1991    */
1992   widget_signals[MOTION_NOTIFY_EVENT] =
1993     g_signal_new (I_("motion-notify-event"),
1994                   G_TYPE_FROM_CLASS (klass),
1995                   G_SIGNAL_RUN_LAST,
1996                   G_STRUCT_OFFSET (GtkWidgetClass, motion_notify_event),
1997                   _gtk_boolean_handled_accumulator, NULL,
1998                   _gtk_marshal_BOOLEAN__BOXED,
1999                   G_TYPE_BOOLEAN, 1,
2000                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2001   g_signal_set_va_marshaller (widget_signals[MOTION_NOTIFY_EVENT], G_TYPE_FROM_CLASS (klass),
2002                               _gtk_marshal_BOOLEAN__BOXEDv);
2003
2004   /**
2005    * GtkWidget::composited-changed:
2006    * @widget: the object on which the signal is emitted
2007    *
2008    * The ::composited-changed signal is emitted when the composited
2009    * status of @widget<!-- -->s screen changes.
2010    * See gdk_screen_is_composited().
2011    */
2012   widget_signals[COMPOSITED_CHANGED] =
2013     g_signal_new (I_("composited-changed"),
2014                   G_TYPE_FROM_CLASS (klass),
2015                   G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
2016                   G_STRUCT_OFFSET (GtkWidgetClass, composited_changed),
2017                   NULL, NULL,
2018                   _gtk_marshal_VOID__VOID,
2019                   G_TYPE_NONE, 0);
2020
2021   /**
2022    * GtkWidget::delete-event:
2023    * @widget: the object which received the signal
2024    * @event: the event which triggered this signal
2025    *
2026    * The ::delete-event signal is emitted if a user requests that
2027    * a toplevel window is closed. The default handler for this signal
2028    * destroys the window. Connecting gtk_widget_hide_on_delete() to
2029    * this signal will cause the window to be hidden instead, so that
2030    * it can later be shown again without reconstructing it.
2031    *
2032    * Returns: %TRUE to stop other handlers from being invoked for the event.
2033    *   %FALSE to propagate the event further.
2034    */
2035   widget_signals[DELETE_EVENT] =
2036     g_signal_new (I_("delete-event"),
2037                   G_TYPE_FROM_CLASS (klass),
2038                   G_SIGNAL_RUN_LAST,
2039                   G_STRUCT_OFFSET (GtkWidgetClass, delete_event),
2040                   _gtk_boolean_handled_accumulator, NULL,
2041                   _gtk_marshal_BOOLEAN__BOXED,
2042                   G_TYPE_BOOLEAN, 1,
2043                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2044   g_signal_set_va_marshaller (widget_signals[DELETE_EVENT], G_TYPE_FROM_CLASS (klass),
2045                               _gtk_marshal_BOOLEAN__BOXEDv);
2046
2047   /**
2048    * GtkWidget::destroy-event:
2049    * @widget: the object which received the signal.
2050    * @event: the event which triggered this signal
2051    *
2052    * The ::destroy-event signal is emitted when a #GdkWindow is destroyed.
2053    * You rarely get this signal, because most widgets disconnect themselves
2054    * from their window before they destroy it, so no widget owns the
2055    * window at destroy time.
2056    *
2057    * To receive this signal, the #GdkWindow associated to the widget needs
2058    * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
2059    * automatically for all new windows.
2060    *
2061    * Returns: %TRUE to stop other handlers from being invoked for the event.
2062    *   %FALSE to propagate the event further.
2063    */
2064   widget_signals[DESTROY_EVENT] =
2065     g_signal_new (I_("destroy-event"),
2066                   G_TYPE_FROM_CLASS (klass),
2067                   G_SIGNAL_RUN_LAST,
2068                   G_STRUCT_OFFSET (GtkWidgetClass, destroy_event),
2069                   _gtk_boolean_handled_accumulator, NULL,
2070                   _gtk_marshal_BOOLEAN__BOXED,
2071                   G_TYPE_BOOLEAN, 1,
2072                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2073   g_signal_set_va_marshaller (widget_signals[DESTROY_EVENT], G_TYPE_FROM_CLASS (klass),
2074                               _gtk_marshal_BOOLEAN__BOXEDv);
2075
2076   /**
2077    * GtkWidget::key-press-event:
2078    * @widget: the object which received the signal
2079    * @event: (type Gdk.EventKey): the #GdkEventKey which triggered this signal.
2080    *
2081    * The ::key-press-event signal is emitted when a key is pressed. The signal
2082    * emission will reoccur at the key-repeat rate when the key is kept pressed.
2083    *
2084    * To receive this signal, the #GdkWindow associated to the widget needs
2085    * to enable the #GDK_KEY_PRESS_MASK mask.
2086    *
2087    * This signal will be sent to the grab widget if there is one.
2088    *
2089    * Returns: %TRUE to stop other handlers from being invoked for the event.
2090    *   %FALSE to propagate the event further.
2091    */
2092   widget_signals[KEY_PRESS_EVENT] =
2093     g_signal_new (I_("key-press-event"),
2094                   G_TYPE_FROM_CLASS (klass),
2095                   G_SIGNAL_RUN_LAST,
2096                   G_STRUCT_OFFSET (GtkWidgetClass, key_press_event),
2097                   _gtk_boolean_handled_accumulator, NULL,
2098                   _gtk_marshal_BOOLEAN__BOXED,
2099                   G_TYPE_BOOLEAN, 1,
2100                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2101   g_signal_set_va_marshaller (widget_signals[KEY_PRESS_EVENT], G_TYPE_FROM_CLASS (klass),
2102                               _gtk_marshal_BOOLEAN__BOXEDv);
2103
2104   /**
2105    * GtkWidget::key-release-event:
2106    * @widget: the object which received the signal
2107    * @event: (type Gdk.EventKey): the #GdkEventKey which triggered this signal.
2108    *
2109    * The ::key-release-event signal is emitted when a key is released.
2110    *
2111    * To receive this signal, the #GdkWindow associated to the widget needs
2112    * to enable the #GDK_KEY_RELEASE_MASK mask.
2113    *
2114    * This signal will be sent to the grab widget if there is one.
2115    *
2116    * Returns: %TRUE to stop other handlers from being invoked for the event.
2117    *   %FALSE to propagate the event further.
2118    */
2119   widget_signals[KEY_RELEASE_EVENT] =
2120     g_signal_new (I_("key-release-event"),
2121                   G_TYPE_FROM_CLASS (klass),
2122                   G_SIGNAL_RUN_LAST,
2123                   G_STRUCT_OFFSET (GtkWidgetClass, key_release_event),
2124                   _gtk_boolean_handled_accumulator, NULL,
2125                   _gtk_marshal_BOOLEAN__BOXED,
2126                   G_TYPE_BOOLEAN, 1,
2127                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2128   g_signal_set_va_marshaller (widget_signals[KEY_RELEASE_EVENT], G_TYPE_FROM_CLASS (klass),
2129                               _gtk_marshal_BOOLEAN__BOXEDv);
2130
2131   /**
2132    * GtkWidget::enter-notify-event:
2133    * @widget: the object which received the signal
2134    * @event: (type Gdk.EventCrossing): the #GdkEventCrossing which triggered
2135    *   this signal.
2136    *
2137    * The ::enter-notify-event will be emitted when the pointer enters
2138    * the @widget's window.
2139    *
2140    * To receive this signal, the #GdkWindow associated to the widget needs
2141    * to enable the #GDK_ENTER_NOTIFY_MASK mask.
2142    *
2143    * This signal will be sent to the grab widget if there is one.
2144    *
2145    * Returns: %TRUE to stop other handlers from being invoked for the event.
2146    *   %FALSE to propagate the event further.
2147    */
2148   widget_signals[ENTER_NOTIFY_EVENT] =
2149     g_signal_new (I_("enter-notify-event"),
2150                   G_TYPE_FROM_CLASS (klass),
2151                   G_SIGNAL_RUN_LAST,
2152                   G_STRUCT_OFFSET (GtkWidgetClass, enter_notify_event),
2153                   _gtk_boolean_handled_accumulator, NULL,
2154                   _gtk_marshal_BOOLEAN__BOXED,
2155                   G_TYPE_BOOLEAN, 1,
2156                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2157   g_signal_set_va_marshaller (widget_signals[ENTER_NOTIFY_EVENT], G_TYPE_FROM_CLASS (klass),
2158                               _gtk_marshal_BOOLEAN__BOXEDv);
2159
2160   /**
2161    * GtkWidget::leave-notify-event:
2162    * @widget: the object which received the signal
2163    * @event: (type Gdk.EventCrossing): the #GdkEventCrossing which triggered
2164    *   this signal.
2165    *
2166    * The ::leave-notify-event will be emitted when the pointer leaves
2167    * the @widget's window.
2168    *
2169    * To receive this signal, the #GdkWindow associated to the widget needs
2170    * to enable the #GDK_LEAVE_NOTIFY_MASK mask.
2171    *
2172    * This signal will be sent to the grab widget if there is one.
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[LEAVE_NOTIFY_EVENT] =
2178     g_signal_new (I_("leave-notify-event"),
2179                   G_TYPE_FROM_CLASS (klass),
2180                   G_SIGNAL_RUN_LAST,
2181                   G_STRUCT_OFFSET (GtkWidgetClass, leave_notify_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   g_signal_set_va_marshaller (widget_signals[LEAVE_NOTIFY_EVENT], G_TYPE_FROM_CLASS (klass),
2187                               _gtk_marshal_BOOLEAN__BOXEDv);
2188
2189   /**
2190    * GtkWidget::configure-event:
2191    * @widget: the object which received the signal
2192    * @event: (type Gdk.EventConfigure): the #GdkEventConfigure which triggered
2193    *   this signal.
2194    *
2195    * The ::configure-event signal will be emitted when the size, position or
2196    * stacking of the @widget's window has changed.
2197    *
2198    * To receive this signal, the #GdkWindow associated to the widget needs
2199    * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
2200    * automatically for all new windows.
2201    *
2202    * Returns: %TRUE to stop other handlers from being invoked for the event.
2203    *   %FALSE to propagate the event further.
2204    */
2205   widget_signals[CONFIGURE_EVENT] =
2206     g_signal_new (I_("configure-event"),
2207                   G_TYPE_FROM_CLASS (klass),
2208                   G_SIGNAL_RUN_LAST,
2209                   G_STRUCT_OFFSET (GtkWidgetClass, configure_event),
2210                   _gtk_boolean_handled_accumulator, NULL,
2211                   _gtk_marshal_BOOLEAN__BOXED,
2212                   G_TYPE_BOOLEAN, 1,
2213                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2214   g_signal_set_va_marshaller (widget_signals[CONFIGURE_EVENT], G_TYPE_FROM_CLASS (klass),
2215                               _gtk_marshal_BOOLEAN__BOXEDv);
2216
2217   /**
2218    * GtkWidget::focus-in-event:
2219    * @widget: the object which received the signal
2220    * @event: (type Gdk.EventFocus): the #GdkEventFocus which triggered
2221    *   this signal.
2222    *
2223    * The ::focus-in-event signal will be emitted when the keyboard focus
2224    * enters the @widget's window.
2225    *
2226    * To receive this signal, the #GdkWindow associated to the widget needs
2227    * to enable the #GDK_FOCUS_CHANGE_MASK mask.
2228    *
2229    * Returns: %TRUE to stop other handlers from being invoked for the event.
2230    *   %FALSE to propagate the event further.
2231    */
2232   widget_signals[FOCUS_IN_EVENT] =
2233     g_signal_new (I_("focus-in-event"),
2234                   G_TYPE_FROM_CLASS (klass),
2235                   G_SIGNAL_RUN_LAST,
2236                   G_STRUCT_OFFSET (GtkWidgetClass, focus_in_event),
2237                   _gtk_boolean_handled_accumulator, NULL,
2238                   _gtk_marshal_BOOLEAN__BOXED,
2239                   G_TYPE_BOOLEAN, 1,
2240                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2241   g_signal_set_va_marshaller (widget_signals[FOCUS_IN_EVENT], G_TYPE_FROM_CLASS (klass),
2242                               _gtk_marshal_BOOLEAN__BOXEDv);
2243
2244   /**
2245    * GtkWidget::focus-out-event:
2246    * @widget: the object which received the signal
2247    * @event: (type Gdk.EventFocus): the #GdkEventFocus which triggered this
2248    *   signal.
2249    *
2250    * The ::focus-out-event signal will be emitted when the keyboard focus
2251    * leaves the @widget's window.
2252    *
2253    * To receive this signal, the #GdkWindow associated to the widget needs
2254    * to enable the #GDK_FOCUS_CHANGE_MASK mask.
2255    *
2256    * Returns: %TRUE to stop other handlers from being invoked for the event.
2257    *   %FALSE to propagate the event further.
2258    */
2259   widget_signals[FOCUS_OUT_EVENT] =
2260     g_signal_new (I_("focus-out-event"),
2261                   G_TYPE_FROM_CLASS (klass),
2262                   G_SIGNAL_RUN_LAST,
2263                   G_STRUCT_OFFSET (GtkWidgetClass, focus_out_event),
2264                   _gtk_boolean_handled_accumulator, NULL,
2265                   _gtk_marshal_BOOLEAN__BOXED,
2266                   G_TYPE_BOOLEAN, 1,
2267                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2268   g_signal_set_va_marshaller (widget_signals[FOCUS_OUT_EVENT], G_TYPE_FROM_CLASS (klass),
2269                               _gtk_marshal_BOOLEAN__BOXEDv);
2270
2271   /**
2272    * GtkWidget::map-event:
2273    * @widget: the object which received the signal
2274    * @event: (type Gdk.EventAny): the #GdkEventAny which triggered this signal.
2275    *
2276    * The ::map-event signal will be emitted when the @widget's window is
2277    * mapped. A window is mapped when it becomes visible on the screen.
2278    *
2279    * To receive this signal, the #GdkWindow associated to the widget needs
2280    * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
2281    * automatically for all new windows.
2282    *
2283    * Returns: %TRUE to stop other handlers from being invoked for the event.
2284    *   %FALSE to propagate the event further.
2285    */
2286   widget_signals[MAP_EVENT] =
2287     g_signal_new (I_("map-event"),
2288                   G_TYPE_FROM_CLASS (klass),
2289                   G_SIGNAL_RUN_LAST,
2290                   G_STRUCT_OFFSET (GtkWidgetClass, map_event),
2291                   _gtk_boolean_handled_accumulator, NULL,
2292                   _gtk_marshal_BOOLEAN__BOXED,
2293                   G_TYPE_BOOLEAN, 1,
2294                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2295   g_signal_set_va_marshaller (widget_signals[MAP_EVENT], G_TYPE_FROM_CLASS (klass),
2296                               _gtk_marshal_BOOLEAN__BOXEDv);
2297
2298   /**
2299    * GtkWidget::unmap-event:
2300    * @widget: the object which received the signal
2301    * @event: (type Gdk.EventAny): the #GdkEventAny which triggered this signal
2302    *
2303    * The ::unmap-event signal will be emitted when the @widget's window is
2304    * unmapped. A window is unmapped when it becomes invisible on the screen.
2305    *
2306    * To receive this signal, the #GdkWindow associated to the widget needs
2307    * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
2308    * automatically for all new windows.
2309    *
2310    * Returns: %TRUE to stop other handlers from being invoked for the event.
2311    *   %FALSE to propagate the event further.
2312    */
2313   widget_signals[UNMAP_EVENT] =
2314     g_signal_new (I_("unmap-event"),
2315                   G_TYPE_FROM_CLASS (klass),
2316                   G_SIGNAL_RUN_LAST,
2317                   G_STRUCT_OFFSET (GtkWidgetClass, unmap_event),
2318                   _gtk_boolean_handled_accumulator, NULL,
2319                   _gtk_marshal_BOOLEAN__BOXED,
2320                   G_TYPE_BOOLEAN, 1,
2321                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2322   g_signal_set_va_marshaller (widget_signals[UNMAP_EVENT], G_TYPE_FROM_CLASS (klass),
2323                               _gtk_marshal_BOOLEAN__BOXEDv);
2324
2325   /**
2326    * GtkWidget::property-notify-event:
2327    * @widget: the object which received the signal
2328    * @event: (type Gdk.EventProperty): the #GdkEventProperty which triggered
2329    *   this signal.
2330    *
2331    * The ::property-notify-event signal will be emitted when a property on
2332    * the @widget's window has been changed or deleted.
2333    *
2334    * To receive this signal, the #GdkWindow associated to the widget needs
2335    * to enable the #GDK_PROPERTY_CHANGE_MASK mask.
2336    *
2337    * Returns: %TRUE to stop other handlers from being invoked for the event.
2338    *   %FALSE to propagate the event further.
2339    */
2340   widget_signals[PROPERTY_NOTIFY_EVENT] =
2341     g_signal_new (I_("property-notify-event"),
2342                   G_TYPE_FROM_CLASS (klass),
2343                   G_SIGNAL_RUN_LAST,
2344                   G_STRUCT_OFFSET (GtkWidgetClass, property_notify_event),
2345                   _gtk_boolean_handled_accumulator, NULL,
2346                   _gtk_marshal_BOOLEAN__BOXED,
2347                   G_TYPE_BOOLEAN, 1,
2348                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2349   g_signal_set_va_marshaller (widget_signals[PROPERTY_NOTIFY_EVENT], G_TYPE_FROM_CLASS (klass),
2350                               _gtk_marshal_BOOLEAN__BOXEDv);
2351
2352   /**
2353    * GtkWidget::selection-clear-event:
2354    * @widget: the object which received the signal
2355    * @event: (type Gdk.EventSelection): the #GdkEventSelection which triggered
2356    *   this signal.
2357    *
2358    * The ::selection-clear-event signal will be emitted when the
2359    * the @widget's window has lost ownership of a selection.
2360    *
2361    * Returns: %TRUE to stop other handlers from being invoked for the event.
2362    *   %FALSE to propagate the event further.
2363    */
2364   widget_signals[SELECTION_CLEAR_EVENT] =
2365     g_signal_new (I_("selection-clear-event"),
2366                   G_TYPE_FROM_CLASS (klass),
2367                   G_SIGNAL_RUN_LAST,
2368                   G_STRUCT_OFFSET (GtkWidgetClass, selection_clear_event),
2369                   _gtk_boolean_handled_accumulator, NULL,
2370                   _gtk_marshal_BOOLEAN__BOXED,
2371                   G_TYPE_BOOLEAN, 1,
2372                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2373   g_signal_set_va_marshaller (widget_signals[SELECTION_CLEAR_EVENT], G_TYPE_FROM_CLASS (klass),
2374                               _gtk_marshal_BOOLEAN__BOXEDv);
2375
2376   /**
2377    * GtkWidget::selection-request-event:
2378    * @widget: the object which received the signal
2379    * @event: (type Gdk.EventSelection): the #GdkEventSelection which triggered
2380    *   this signal.
2381    *
2382    * The ::selection-request-event signal will be emitted when
2383    * another client requests ownership of the selection owned by
2384    * the @widget's window.
2385    *
2386    * Returns: %TRUE to stop other handlers from being invoked for the event.
2387    *   %FALSE to propagate the event further.
2388    */
2389   widget_signals[SELECTION_REQUEST_EVENT] =
2390     g_signal_new (I_("selection-request-event"),
2391                   G_TYPE_FROM_CLASS (klass),
2392                   G_SIGNAL_RUN_LAST,
2393                   G_STRUCT_OFFSET (GtkWidgetClass, selection_request_event),
2394                   _gtk_boolean_handled_accumulator, NULL,
2395                   _gtk_marshal_BOOLEAN__BOXED,
2396                   G_TYPE_BOOLEAN, 1,
2397                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2398   g_signal_set_va_marshaller (widget_signals[SELECTION_REQUEST_EVENT], G_TYPE_FROM_CLASS (klass),
2399                               _gtk_marshal_BOOLEAN__BOXEDv);
2400
2401   /**
2402    * GtkWidget::selection-notify-event:
2403    * @widget: the object which received the signal.
2404    * @event: (type Gdk.EventSelection):
2405    *
2406    * Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
2407    */
2408   widget_signals[SELECTION_NOTIFY_EVENT] =
2409     g_signal_new (I_("selection-notify-event"),
2410                   G_TYPE_FROM_CLASS (klass),
2411                   G_SIGNAL_RUN_LAST,
2412                   G_STRUCT_OFFSET (GtkWidgetClass, selection_notify_event),
2413                   _gtk_boolean_handled_accumulator, NULL,
2414                   _gtk_marshal_BOOLEAN__BOXED,
2415                   G_TYPE_BOOLEAN, 1,
2416                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2417   g_signal_set_va_marshaller (widget_signals[SELECTION_NOTIFY_EVENT], G_TYPE_FROM_CLASS (klass),
2418                               _gtk_marshal_BOOLEAN__BOXEDv);
2419
2420   /**
2421    * GtkWidget::selection-received:
2422    * @widget: the object which received the signal.
2423    * @data:
2424    * @time:
2425    */
2426   widget_signals[SELECTION_RECEIVED] =
2427     g_signal_new (I_("selection-received"),
2428                   G_TYPE_FROM_CLASS (klass),
2429                   G_SIGNAL_RUN_LAST,
2430                   G_STRUCT_OFFSET (GtkWidgetClass, selection_received),
2431                   NULL, NULL,
2432                   _gtk_marshal_VOID__BOXED_UINT,
2433                   G_TYPE_NONE, 2,
2434                   GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
2435                   G_TYPE_UINT);
2436
2437   /**
2438    * GtkWidget::selection-get:
2439    * @widget: the object which received the signal.
2440    * @data:
2441    * @info:
2442    * @time:
2443    */
2444   widget_signals[SELECTION_GET] =
2445     g_signal_new (I_("selection-get"),
2446                   G_TYPE_FROM_CLASS (klass),
2447                   G_SIGNAL_RUN_LAST,
2448                   G_STRUCT_OFFSET (GtkWidgetClass, selection_get),
2449                   NULL, NULL,
2450                   _gtk_marshal_VOID__BOXED_UINT_UINT,
2451                   G_TYPE_NONE, 3,
2452                   GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
2453                   G_TYPE_UINT,
2454                   G_TYPE_UINT);
2455
2456   /**
2457    * GtkWidget::proximity-in-event:
2458    * @widget: the object which received the signal
2459    * @event: (type Gdk.EventProximity): the #GdkEventProximity which triggered
2460    *   this signal.
2461    *
2462    * To receive this signal the #GdkWindow associated to the widget needs
2463    * to enable the #GDK_PROXIMITY_IN_MASK mask.
2464    *
2465    * This signal will be sent to the grab widget if there is one.
2466    *
2467    * Returns: %TRUE to stop other handlers from being invoked for the event.
2468    *   %FALSE to propagate the event further.
2469    */
2470   widget_signals[PROXIMITY_IN_EVENT] =
2471     g_signal_new (I_("proximity-in-event"),
2472                   G_TYPE_FROM_CLASS (klass),
2473                   G_SIGNAL_RUN_LAST,
2474                   G_STRUCT_OFFSET (GtkWidgetClass, proximity_in_event),
2475                   _gtk_boolean_handled_accumulator, NULL,
2476                   _gtk_marshal_BOOLEAN__BOXED,
2477                   G_TYPE_BOOLEAN, 1,
2478                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2479   g_signal_set_va_marshaller (widget_signals[PROXIMITY_IN_EVENT], G_TYPE_FROM_CLASS (klass),
2480                               _gtk_marshal_BOOLEAN__BOXEDv);
2481
2482   /**
2483    * GtkWidget::proximity-out-event:
2484    * @widget: the object which received the signal
2485    * @event: (type Gdk.EventProximity): the #GdkEventProximity which triggered
2486    *   this signal.
2487    *
2488    * To receive this signal the #GdkWindow associated to the widget needs
2489    * to enable the #GDK_PROXIMITY_OUT_MASK mask.
2490    *
2491    * This signal will be sent to the grab widget if there is one.
2492    *
2493    * Returns: %TRUE to stop other handlers from being invoked for the event.
2494    *   %FALSE to propagate the event further.
2495    */
2496   widget_signals[PROXIMITY_OUT_EVENT] =
2497     g_signal_new (I_("proximity-out-event"),
2498                   G_TYPE_FROM_CLASS (klass),
2499                   G_SIGNAL_RUN_LAST,
2500                   G_STRUCT_OFFSET (GtkWidgetClass, proximity_out_event),
2501                   _gtk_boolean_handled_accumulator, NULL,
2502                   _gtk_marshal_BOOLEAN__BOXED,
2503                   G_TYPE_BOOLEAN, 1,
2504                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2505   g_signal_set_va_marshaller (widget_signals[PROXIMITY_OUT_EVENT], G_TYPE_FROM_CLASS (klass),
2506                               _gtk_marshal_BOOLEAN__BOXEDv);
2507
2508   /**
2509    * GtkWidget::drag-leave:
2510    * @widget: the object which received the signal.
2511    * @context: the drag context
2512    * @time: the timestamp of the motion event
2513    *
2514    * The ::drag-leave signal is emitted on the drop site when the cursor
2515    * leaves the widget. A typical reason to connect to this signal is to
2516    * undo things done in #GtkWidget::drag-motion, e.g. undo highlighting
2517    * with gtk_drag_unhighlight()
2518    */
2519   widget_signals[DRAG_LEAVE] =
2520     g_signal_new (I_("drag-leave"),
2521                   G_TYPE_FROM_CLASS (klass),
2522                   G_SIGNAL_RUN_LAST,
2523                   G_STRUCT_OFFSET (GtkWidgetClass, drag_leave),
2524                   NULL, NULL,
2525                   _gtk_marshal_VOID__OBJECT_UINT,
2526                   G_TYPE_NONE, 2,
2527                   GDK_TYPE_DRAG_CONTEXT,
2528                   G_TYPE_UINT);
2529
2530   /**
2531    * GtkWidget::drag-begin:
2532    * @widget: the object which received the signal
2533    * @context: the drag context
2534    *
2535    * The ::drag-begin signal is emitted on the drag source when a drag is
2536    * started. A typical reason to connect to this signal is to set up a
2537    * custom drag icon with e.g. gtk_drag_source_set_icon_pixbuf().
2538    *
2539    * Note that some widgets set up a drag icon in the default handler of
2540    * this signal, so you may have to use g_signal_connect_after() to
2541    * override what the default handler did.
2542    */
2543   widget_signals[DRAG_BEGIN] =
2544     g_signal_new (I_("drag-begin"),
2545                   G_TYPE_FROM_CLASS (klass),
2546                   G_SIGNAL_RUN_LAST,
2547                   G_STRUCT_OFFSET (GtkWidgetClass, drag_begin),
2548                   NULL, NULL,
2549                   _gtk_marshal_VOID__OBJECT,
2550                   G_TYPE_NONE, 1,
2551                   GDK_TYPE_DRAG_CONTEXT);
2552
2553   /**
2554    * GtkWidget::drag-end:
2555    * @widget: the object which received the signal
2556    * @context: the drag context
2557    *
2558    * The ::drag-end signal is emitted on the drag source when a drag is
2559    * finished.  A typical reason to connect to this signal is to undo
2560    * things done in #GtkWidget::drag-begin.
2561    */
2562   widget_signals[DRAG_END] =
2563     g_signal_new (I_("drag-end"),
2564                   G_TYPE_FROM_CLASS (klass),
2565                   G_SIGNAL_RUN_LAST,
2566                   G_STRUCT_OFFSET (GtkWidgetClass, drag_end),
2567                   NULL, NULL,
2568                   _gtk_marshal_VOID__OBJECT,
2569                   G_TYPE_NONE, 1,
2570                   GDK_TYPE_DRAG_CONTEXT);
2571
2572   /**
2573    * GtkWidget::drag-data-delete:
2574    * @widget: the object which received the signal
2575    * @context: the drag context
2576    *
2577    * The ::drag-data-delete signal is emitted on the drag source when a drag
2578    * with the action %GDK_ACTION_MOVE is successfully completed. The signal
2579    * handler is responsible for deleting the data that has been dropped. What
2580    * "delete" means depends on the context of the drag operation.
2581    */
2582   widget_signals[DRAG_DATA_DELETE] =
2583     g_signal_new (I_("drag-data-delete"),
2584                   G_TYPE_FROM_CLASS (klass),
2585                   G_SIGNAL_RUN_LAST,
2586                   G_STRUCT_OFFSET (GtkWidgetClass, drag_data_delete),
2587                   NULL, NULL,
2588                   _gtk_marshal_VOID__OBJECT,
2589                   G_TYPE_NONE, 1,
2590                   GDK_TYPE_DRAG_CONTEXT);
2591
2592   /**
2593    * GtkWidget::drag-failed:
2594    * @widget: the object which received the signal
2595    * @context: the drag context
2596    * @result: the result of the drag operation
2597    *
2598    * The ::drag-failed signal is emitted on the drag source when a drag has
2599    * failed. The signal handler may hook custom code to handle a failed DND
2600    * operation based on the type of error, it returns %TRUE is the failure has
2601    * been already handled (not showing the default "drag operation failed"
2602    * animation), otherwise it returns %FALSE.
2603    *
2604    * Return value: %TRUE if the failed drag operation has been already handled.
2605    *
2606    * Since: 2.12
2607    */
2608   widget_signals[DRAG_FAILED] =
2609     g_signal_new (I_("drag-failed"),
2610                   G_TYPE_FROM_CLASS (klass),
2611                   G_SIGNAL_RUN_LAST,
2612                   G_STRUCT_OFFSET (GtkWidgetClass, drag_failed),
2613                   _gtk_boolean_handled_accumulator, NULL,
2614                   _gtk_marshal_BOOLEAN__OBJECT_ENUM,
2615                   G_TYPE_BOOLEAN, 2,
2616                   GDK_TYPE_DRAG_CONTEXT,
2617                   GTK_TYPE_DRAG_RESULT);
2618
2619   /**
2620    * GtkWidget::drag-motion:
2621    * @widget: the object which received the signal
2622    * @context: the drag context
2623    * @x: the x coordinate of the current cursor position
2624    * @y: the y coordinate of the current cursor position
2625    * @time: the timestamp of the motion event
2626    *
2627    * The ::drag-motion signal is emitted on the drop site when the user
2628    * moves the cursor over the widget during a drag. The signal handler
2629    * must determine whether the cursor position is in a drop zone or not.
2630    * If it is not in a drop zone, it returns %FALSE and no further processing
2631    * is necessary. Otherwise, the handler returns %TRUE. In this case, the
2632    * handler is responsible for providing the necessary information for
2633    * displaying feedback to the user, by calling gdk_drag_status().
2634    *
2635    * If the decision whether the drop will be accepted or rejected can't be
2636    * made based solely on the cursor position and the type of the data, the
2637    * handler may inspect the dragged data by calling gtk_drag_get_data() and
2638    * defer the gdk_drag_status() call to the #GtkWidget::drag-data-received
2639    * handler. Note that you cannot not pass #GTK_DEST_DEFAULT_DROP,
2640    * #GTK_DEST_DEFAULT_MOTION or #GTK_DEST_DEFAULT_ALL to gtk_drag_dest_set()
2641    * when using the drag-motion signal that way.
2642    *
2643    * Also note that there is no drag-enter signal. The drag receiver has to
2644    * keep track of whether he has received any drag-motion signals since the
2645    * last #GtkWidget::drag-leave and if not, treat the drag-motion signal as
2646    * an "enter" signal. Upon an "enter", the handler will typically highlight
2647    * the drop site with gtk_drag_highlight().
2648    * |[
2649    * static void
2650    * drag_motion (GtkWidget      *widget,
2651    *              GdkDragContext *context,
2652    *              gint            x,
2653    *              gint            y,
2654    *              guint           time)
2655    * {
2656    *   GdkAtom target;
2657    *
2658    *   PrivateData *private_data = GET_PRIVATE_DATA (widget);
2659    *
2660    *   if (!private_data->drag_highlight)
2661    *    {
2662    *      private_data->drag_highlight = 1;
2663    *      gtk_drag_highlight (widget);
2664    *    }
2665    *
2666    *   target = gtk_drag_dest_find_target (widget, context, NULL);
2667    *   if (target == GDK_NONE)
2668    *     gdk_drag_status (context, 0, time);
2669    *   else
2670    *    {
2671    *      private_data->pending_status = gdk_drag_context_get_suggested_action (context);
2672    *      gtk_drag_get_data (widget, context, target, time);
2673    *    }
2674    *
2675    *   return TRUE;
2676    * }
2677    *
2678    * static void
2679    * drag_data_received (GtkWidget        *widget,
2680    *                     GdkDragContext   *context,
2681    *                     gint              x,
2682    *                     gint              y,
2683    *                     GtkSelectionData *selection_data,
2684    *                     guint             info,
2685    *                     guint             time)
2686    * {
2687    *   PrivateData *private_data = GET_PRIVATE_DATA (widget);
2688    *
2689    *   if (private_data->suggested_action)
2690    *    {
2691    *      private_data->suggested_action = 0;
2692    *
2693    *      /&ast; We are getting this data due to a request in drag_motion,
2694    *       * rather than due to a request in drag_drop, so we are just
2695    *       * supposed to call gdk_drag_status(), not actually paste in
2696    *       * the data.
2697    *       &ast;/
2698    *      str = gtk_selection_data_get_text (selection_data);
2699    *      if (!data_is_acceptable (str))
2700    *        gdk_drag_status (context, 0, time);
2701    *      else
2702    *        gdk_drag_status (context, private_data->suggested_action, time);
2703    *    }
2704    *   else
2705    *    {
2706    *      /&ast; accept the drop &ast;/
2707    *    }
2708    * }
2709    * ]|
2710    *
2711    * Returns: whether the cursor position is in a drop zone
2712    */
2713   widget_signals[DRAG_MOTION] =
2714     g_signal_new (I_("drag-motion"),
2715                   G_TYPE_FROM_CLASS (klass),
2716                   G_SIGNAL_RUN_LAST,
2717                   G_STRUCT_OFFSET (GtkWidgetClass, drag_motion),
2718                   _gtk_boolean_handled_accumulator, NULL,
2719                   _gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
2720                   G_TYPE_BOOLEAN, 4,
2721                   GDK_TYPE_DRAG_CONTEXT,
2722                   G_TYPE_INT,
2723                   G_TYPE_INT,
2724                   G_TYPE_UINT);
2725
2726   /**
2727    * GtkWidget::drag-drop:
2728    * @widget: the object which received the signal
2729    * @context: the drag context
2730    * @x: the x coordinate of the current cursor position
2731    * @y: the y coordinate of the current cursor position
2732    * @time: the timestamp of the motion event
2733    *
2734    * The ::drag-drop signal is emitted on the drop site when the user drops
2735    * the data onto the widget. The signal handler must determine whether
2736    * the cursor position is in a drop zone or not. If it is not in a drop
2737    * zone, it returns %FALSE and no further processing is necessary.
2738    * Otherwise, the handler returns %TRUE. In this case, the handler must
2739    * ensure that gtk_drag_finish() is called to let the source know that
2740    * the drop is done. The call to gtk_drag_finish() can be done either
2741    * directly or in a #GtkWidget::drag-data-received handler which gets
2742    * triggered by calling gtk_drag_get_data() to receive the data for one
2743    * or more of the supported targets.
2744    *
2745    * Returns: whether the cursor position is in a drop zone
2746    */
2747   widget_signals[DRAG_DROP] =
2748     g_signal_new (I_("drag-drop"),
2749                   G_TYPE_FROM_CLASS (klass),
2750                   G_SIGNAL_RUN_LAST,
2751                   G_STRUCT_OFFSET (GtkWidgetClass, drag_drop),
2752                   _gtk_boolean_handled_accumulator, NULL,
2753                   _gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
2754                   G_TYPE_BOOLEAN, 4,
2755                   GDK_TYPE_DRAG_CONTEXT,
2756                   G_TYPE_INT,
2757                   G_TYPE_INT,
2758                   G_TYPE_UINT);
2759
2760   /**
2761    * GtkWidget::drag-data-get:
2762    * @widget: the object which received the signal
2763    * @context: the drag context
2764    * @data: the #GtkSelectionData to be filled with the dragged data
2765    * @info: the info that has been registered with the target in the
2766    *        #GtkTargetList
2767    * @time: the timestamp at which the data was requested
2768    *
2769    * The ::drag-data-get signal is emitted on the drag source when the drop
2770    * site requests the data which is dragged. It is the responsibility of
2771    * the signal handler to fill @data with the data in the format which
2772    * is indicated by @info. See gtk_selection_data_set() and
2773    * gtk_selection_data_set_text().
2774    */
2775   widget_signals[DRAG_DATA_GET] =
2776     g_signal_new (I_("drag-data-get"),
2777                   G_TYPE_FROM_CLASS (klass),
2778                   G_SIGNAL_RUN_LAST,
2779                   G_STRUCT_OFFSET (GtkWidgetClass, drag_data_get),
2780                   NULL, NULL,
2781                   _gtk_marshal_VOID__OBJECT_BOXED_UINT_UINT,
2782                   G_TYPE_NONE, 4,
2783                   GDK_TYPE_DRAG_CONTEXT,
2784                   GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
2785                   G_TYPE_UINT,
2786                   G_TYPE_UINT);
2787
2788   /**
2789    * GtkWidget::drag-data-received:
2790    * @widget: the object which received the signal
2791    * @context: the drag context
2792    * @x: where the drop happened
2793    * @y: where the drop happened
2794    * @data: the received data
2795    * @info: the info that has been registered with the target in the
2796    *        #GtkTargetList
2797    * @time: the timestamp at which the data was received
2798    *
2799    * The ::drag-data-received signal is emitted on the drop site when the
2800    * dragged data has been received. If the data was received in order to
2801    * determine whether the drop will be accepted, the handler is expected
2802    * to call gdk_drag_status() and <emphasis>not</emphasis> finish the drag.
2803    * If the data was received in response to a #GtkWidget::drag-drop signal
2804    * (and this is the last target to be received), the handler for this
2805    * signal is expected to process the received data and then call
2806    * gtk_drag_finish(), setting the @success parameter depending on
2807    * whether the data was processed successfully.
2808    *
2809    * The handler may inspect the selected action with
2810    * gdk_drag_context_get_selected_action() before calling
2811    * gtk_drag_finish(), e.g. to implement %GDK_ACTION_ASK as
2812    * shown in the following example:
2813    * |[
2814    * void
2815    * drag_data_received (GtkWidget          *widget,
2816    *                     GdkDragContext     *context,
2817    *                     gint                x,
2818    *                     gint                y,
2819    *                     GtkSelectionData   *data,
2820    *                     guint               info,
2821    *                     guint               time)
2822    * {
2823    *   if ((data->length >= 0) && (data->format == 8))
2824    *     {
2825    *       GdkDragAction action;
2826    *
2827    *       /&ast; handle data here &ast;/
2828    *
2829    *       action = gdk_drag_context_get_selected_action (context);
2830    *       if (action == GDK_ACTION_ASK)
2831    *         {
2832    *           GtkWidget *dialog;
2833    *           gint response;
2834    *
2835    *           dialog = gtk_message_dialog_new (NULL,
2836    *                                            GTK_DIALOG_MODAL |
2837    *                                            GTK_DIALOG_DESTROY_WITH_PARENT,
2838    *                                            GTK_MESSAGE_INFO,
2839    *                                            GTK_BUTTONS_YES_NO,
2840    *                                            "Move the data ?\n");
2841    *           response = gtk_dialog_run (GTK_DIALOG (dialog));
2842    *           gtk_widget_destroy (dialog);
2843    *
2844    *           if (response == GTK_RESPONSE_YES)
2845    *             action = GDK_ACTION_MOVE;
2846    *           else
2847    *             action = GDK_ACTION_COPY;
2848    *          }
2849    *
2850    *       gtk_drag_finish (context, TRUE, action == GDK_ACTION_MOVE, time);
2851    *     }
2852    *   else
2853    *     gtk_drag_finish (context, FALSE, FALSE, time);
2854    *  }
2855    * ]|
2856    */
2857   widget_signals[DRAG_DATA_RECEIVED] =
2858     g_signal_new (I_("drag-data-received"),
2859                   G_TYPE_FROM_CLASS (klass),
2860                   G_SIGNAL_RUN_LAST,
2861                   G_STRUCT_OFFSET (GtkWidgetClass, drag_data_received),
2862                   NULL, NULL,
2863                   _gtk_marshal_VOID__OBJECT_INT_INT_BOXED_UINT_UINT,
2864                   G_TYPE_NONE, 6,
2865                   GDK_TYPE_DRAG_CONTEXT,
2866                   G_TYPE_INT,
2867                   G_TYPE_INT,
2868                   GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
2869                   G_TYPE_UINT,
2870                   G_TYPE_UINT);
2871
2872   /**
2873    * GtkWidget::visibility-notify-event:
2874    * @widget: the object which received the signal
2875    * @event: (type Gdk.EventVisibility): the #GdkEventVisibility which
2876    *   triggered this signal.
2877    *
2878    * The ::visibility-notify-event will be emitted when the @widget's window
2879    * is obscured or unobscured.
2880    *
2881    * To receive this signal the #GdkWindow associated to the widget needs
2882    * to enable the #GDK_VISIBILITY_NOTIFY_MASK mask.
2883    *
2884    * Returns: %TRUE to stop other handlers from being invoked for the event.
2885    *   %FALSE to propagate the event further.
2886    */
2887   widget_signals[VISIBILITY_NOTIFY_EVENT] =
2888     g_signal_new (I_("visibility-notify-event"),
2889                   G_TYPE_FROM_CLASS (klass),
2890                   G_SIGNAL_RUN_LAST,
2891                   G_STRUCT_OFFSET (GtkWidgetClass, visibility_notify_event),
2892                   _gtk_boolean_handled_accumulator, NULL,
2893                   _gtk_marshal_BOOLEAN__BOXED,
2894                   G_TYPE_BOOLEAN, 1,
2895                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2896
2897   /**
2898    * GtkWidget::window-state-event:
2899    * @widget: the object which received the signal
2900    * @event: (type Gdk.EventWindowState): the #GdkEventWindowState which
2901    *   triggered this signal.
2902    *
2903    * The ::window-state-event will be emitted when the state of the
2904    * toplevel window associated to the @widget changes.
2905    *
2906    * To receive this signal the #GdkWindow associated to the widget
2907    * needs to enable the #GDK_STRUCTURE_MASK mask. GDK will enable
2908    * this mask automatically for all new windows.
2909    *
2910    * Returns: %TRUE to stop other handlers from being invoked for the
2911    *   event. %FALSE to propagate the event further.
2912    */
2913   widget_signals[WINDOW_STATE_EVENT] =
2914     g_signal_new (I_("window-state-event"),
2915                   G_TYPE_FROM_CLASS (klass),
2916                   G_SIGNAL_RUN_LAST,
2917                   G_STRUCT_OFFSET (GtkWidgetClass, window_state_event),
2918                   _gtk_boolean_handled_accumulator, NULL,
2919                   _gtk_marshal_BOOLEAN__BOXED,
2920                   G_TYPE_BOOLEAN, 1,
2921                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2922   g_signal_set_va_marshaller (widget_signals[WINDOW_STATE_EVENT], G_TYPE_FROM_CLASS (klass),
2923                               _gtk_marshal_BOOLEAN__BOXEDv);
2924
2925   /**
2926    * GtkWidget::damage-event:
2927    * @widget: the object which received the signal
2928    * @event: (type Gdk.EventExpose): the #GdkEventExpose event
2929    *
2930    * Emitted when a redirected window belonging to @widget gets drawn into.
2931    * The region/area members of the event shows what area of the redirected
2932    * drawable was drawn into.
2933    *
2934    * Returns: %TRUE to stop other handlers from being invoked for the event.
2935    *   %FALSE to propagate the event further.
2936    *
2937    * Since: 2.14
2938    */
2939   widget_signals[DAMAGE_EVENT] =
2940     g_signal_new (I_("damage-event"),
2941                   G_TYPE_FROM_CLASS (klass),
2942                   G_SIGNAL_RUN_LAST,
2943                   G_STRUCT_OFFSET (GtkWidgetClass, damage_event),
2944                   _gtk_boolean_handled_accumulator, NULL,
2945                   _gtk_marshal_BOOLEAN__BOXED,
2946                   G_TYPE_BOOLEAN, 1,
2947                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2948   g_signal_set_va_marshaller (widget_signals[DAMAGE_EVENT], G_TYPE_FROM_CLASS (klass),
2949                               _gtk_marshal_BOOLEAN__BOXEDv);
2950
2951 /**
2952    * GtkWidget::grab-broken-event:
2953    * @widget: the object which received the signal
2954    * @event: (type Gdk.EventGrabBroken): the #GdkEventGrabBroken event
2955    *
2956    * Emitted when a pointer or keyboard grab on a window belonging
2957    * to @widget gets broken.
2958    *
2959    * On X11, this happens when the grab window becomes unviewable
2960    * (i.e. it or one of its ancestors is unmapped), or if the same
2961    * application grabs the pointer or keyboard again.
2962    *
2963    * Returns: %TRUE to stop other handlers from being invoked for
2964    *   the event. %FALSE to propagate the event further.
2965    *
2966    * Since: 2.8
2967    */
2968   widget_signals[GRAB_BROKEN_EVENT] =
2969     g_signal_new (I_("grab-broken-event"),
2970                   G_TYPE_FROM_CLASS (klass),
2971                   G_SIGNAL_RUN_LAST,
2972                   G_STRUCT_OFFSET (GtkWidgetClass, grab_broken_event),
2973                   _gtk_boolean_handled_accumulator, NULL,
2974                   _gtk_marshal_BOOLEAN__BOXED,
2975                   G_TYPE_BOOLEAN, 1,
2976                   GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2977   g_signal_set_va_marshaller (widget_signals[GRAB_BROKEN_EVENT], G_TYPE_FROM_CLASS (klass),
2978                               _gtk_marshal_BOOLEAN__BOXEDv);
2979
2980   /**
2981    * GtkWidget::query-tooltip:
2982    * @widget: the object which received the signal
2983    * @x: the x coordinate of the cursor position where the request has
2984    *     been emitted, relative to @widget's left side
2985    * @y: the y coordinate of the cursor position where the request has
2986    *     been emitted, relative to @widget's top
2987    * @keyboard_mode: %TRUE if the tooltip was trigged using the keyboard
2988    * @tooltip: a #GtkTooltip
2989    *
2990    * Emitted when #GtkWidget:has-tooltip is %TRUE and the #GtkSettings:gtk-tooltip-timeout
2991    * has expired with the cursor hovering "above" @widget; or emitted when @widget got
2992    * focus in keyboard mode.
2993    *
2994    * Using the given coordinates, the signal handler should determine
2995    * whether a tooltip should be shown for @widget. If this is the case
2996    * %TRUE should be returned, %FALSE otherwise.  Note that if
2997    * @keyboard_mode is %TRUE, the values of @x and @y are undefined and
2998    * should not be used.
2999    *
3000    * The signal handler is free to manipulate @tooltip with the therefore
3001    * destined function calls.
3002    *
3003    * Returns: %TRUE if @tooltip should be shown right now, %FALSE otherwise.
3004    *
3005    * Since: 2.12
3006    */
3007   widget_signals[QUERY_TOOLTIP] =
3008     g_signal_new (I_("query-tooltip"),
3009                   G_TYPE_FROM_CLASS (klass),
3010                   G_SIGNAL_RUN_LAST,
3011                   G_STRUCT_OFFSET (GtkWidgetClass, query_tooltip),
3012                   _gtk_boolean_handled_accumulator, NULL,
3013                   _gtk_marshal_BOOLEAN__INT_INT_BOOLEAN_OBJECT,
3014                   G_TYPE_BOOLEAN, 4,
3015                   G_TYPE_INT,
3016                   G_TYPE_INT,
3017                   G_TYPE_BOOLEAN,
3018                   GTK_TYPE_TOOLTIP);
3019
3020   /**
3021    * GtkWidget::popup-menu:
3022    * @widget: the object which received the signal
3023    *
3024    * This signal gets emitted whenever a widget should pop up a context
3025    * menu. This usually happens through the standard key binding mechanism;
3026    * by pressing a certain key while a widget is focused, the user can cause
3027    * the widget to pop up a menu.  For example, the #GtkEntry widget creates
3028    * a menu with clipboard commands. See <xref linkend="checklist-popup-menu"/>
3029    * for an example of how to use this signal.
3030    *
3031    * Returns: %TRUE if a menu was activated
3032    */
3033   widget_signals[POPUP_MENU] =
3034     g_signal_new (I_("popup-menu"),
3035                   G_TYPE_FROM_CLASS (klass),
3036                   G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
3037                   G_STRUCT_OFFSET (GtkWidgetClass, popup_menu),
3038                   _gtk_boolean_handled_accumulator, NULL,
3039                   _gtk_marshal_BOOLEAN__VOID,
3040                   G_TYPE_BOOLEAN, 0);
3041
3042   /**
3043    * GtkWidget::show-help:
3044    * @widget: the object which received the signal.
3045    * @help_type:
3046    *
3047    * Returns: %TRUE to stop other handlers from being invoked for the event.
3048    * %FALSE to propagate the event further.
3049    */
3050   widget_signals[SHOW_HELP] =
3051     g_signal_new (I_("show-help"),
3052                   G_TYPE_FROM_CLASS (klass),
3053                   G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
3054                   G_STRUCT_OFFSET (GtkWidgetClass, show_help),
3055                   _gtk_boolean_handled_accumulator, NULL,
3056                   _gtk_marshal_BOOLEAN__ENUM,
3057                   G_TYPE_BOOLEAN, 1,
3058                   GTK_TYPE_WIDGET_HELP_TYPE);
3059
3060   /**
3061    * GtkWidget::accel-closures-changed:
3062    * @widget: the object which received the signal.
3063    */
3064   widget_signals[ACCEL_CLOSURES_CHANGED] =
3065     g_signal_new (I_("accel-closures-changed"),
3066                   G_TYPE_FROM_CLASS (klass),
3067                   0,
3068                   0,
3069                   NULL, NULL,
3070                   _gtk_marshal_VOID__VOID,
3071                   G_TYPE_NONE, 0);
3072
3073   /**
3074    * GtkWidget::screen-changed:
3075    * @widget: the object on which the signal is emitted
3076    * @previous_screen: (allow-none): the previous screen, or %NULL if the
3077    *   widget was not associated with a screen before
3078    *
3079    * The ::screen-changed signal gets emitted when the
3080    * screen of a widget has changed.
3081    */
3082   widget_signals[SCREEN_CHANGED] =
3083     g_signal_new (I_("screen-changed"),
3084                   G_TYPE_FROM_CLASS (klass),
3085                   G_SIGNAL_RUN_LAST,
3086                   G_STRUCT_OFFSET (GtkWidgetClass, screen_changed),
3087                   NULL, NULL,
3088                   _gtk_marshal_VOID__OBJECT,
3089                   G_TYPE_NONE, 1,
3090                   GDK_TYPE_SCREEN);
3091
3092   /**
3093    * GtkWidget::can-activate-accel:
3094    * @widget: the object which received the signal
3095    * @signal_id: the ID of a signal installed on @widget
3096    *
3097    * Determines whether an accelerator that activates the signal
3098    * identified by @signal_id can currently be activated.
3099    * This signal is present to allow applications and derived
3100    * widgets to override the default #GtkWidget handling
3101    * for determining whether an accelerator can be activated.
3102    *
3103    * Returns: %TRUE if the signal can be activated.
3104    */
3105   widget_signals[CAN_ACTIVATE_ACCEL] =
3106      g_signal_new (I_("can-activate-accel"),
3107                   G_TYPE_FROM_CLASS (klass),
3108                   G_SIGNAL_RUN_LAST,
3109                   G_STRUCT_OFFSET (GtkWidgetClass, can_activate_accel),
3110                   _gtk_boolean_handled_accumulator, NULL,
3111                   _gtk_marshal_BOOLEAN__UINT,
3112                   G_TYPE_BOOLEAN, 1, G_TYPE_UINT);
3113
3114   binding_set = gtk_binding_set_by_class (klass);
3115   gtk_binding_entry_add_signal (binding_set, GDK_KEY_F10, GDK_SHIFT_MASK,
3116                                 "popup-menu", 0);
3117   gtk_binding_entry_add_signal (binding_set, GDK_KEY_Menu, 0,
3118                                 "popup-menu", 0);
3119
3120   gtk_binding_entry_add_signal (binding_set, GDK_KEY_F1, GDK_CONTROL_MASK,
3121                                 "show-help", 1,
3122                                 GTK_TYPE_WIDGET_HELP_TYPE,
3123                                 GTK_WIDGET_HELP_TOOLTIP);
3124   gtk_binding_entry_add_signal (binding_set, GDK_KEY_KP_F1, GDK_CONTROL_MASK,
3125                                 "show-help", 1,
3126                                 GTK_TYPE_WIDGET_HELP_TYPE,
3127                                 GTK_WIDGET_HELP_TOOLTIP);
3128   gtk_binding_entry_add_signal (binding_set, GDK_KEY_F1, GDK_SHIFT_MASK,
3129                                 "show-help", 1,
3130                                 GTK_TYPE_WIDGET_HELP_TYPE,
3131                                 GTK_WIDGET_HELP_WHATS_THIS);
3132   gtk_binding_entry_add_signal (binding_set, GDK_KEY_KP_F1, GDK_SHIFT_MASK,
3133                                 "show-help", 1,
3134                                 GTK_TYPE_WIDGET_HELP_TYPE,
3135                                 GTK_WIDGET_HELP_WHATS_THIS);
3136
3137   gtk_widget_class_install_style_property (klass,
3138                                            g_param_spec_boolean ("interior-focus",
3139                                                                  P_("Interior Focus"),
3140                                                                  P_("Whether to draw the focus indicator inside widgets"),
3141                                                                  TRUE,
3142                                                                  GTK_PARAM_READABLE));
3143
3144   gtk_widget_class_install_style_property (klass,
3145                                            g_param_spec_int ("focus-line-width",
3146                                                              P_("Focus linewidth"),
3147                                                              P_("Width, in pixels, of the focus indicator line"),
3148                                                              0, G_MAXINT, 1,
3149                                                              GTK_PARAM_READABLE));
3150
3151   gtk_widget_class_install_style_property (klass,
3152                                            g_param_spec_string ("focus-line-pattern",
3153                                                                 P_("Focus line dash pattern"),
3154                                                                 P_("Dash pattern used to draw the focus indicator"),
3155                                                                 "\1\1",
3156                                                                 GTK_PARAM_READABLE));
3157   gtk_widget_class_install_style_property (klass,
3158                                            g_param_spec_int ("focus-padding",
3159                                                              P_("Focus padding"),
3160                                                              P_("Width, in pixels, between focus indicator and the widget 'box'"),
3161                                                              0, G_MAXINT, 1,
3162                                                              GTK_PARAM_READABLE));
3163   gtk_widget_class_install_style_property (klass,
3164                                            g_param_spec_boxed ("cursor-color",
3165                                                                P_("Cursor color"),
3166                                                                P_("Color with which to draw insertion cursor"),
3167                                                                GDK_TYPE_COLOR,
3168                                                                GTK_PARAM_READABLE));
3169   gtk_widget_class_install_style_property (klass,
3170                                            g_param_spec_boxed ("secondary-cursor-color",
3171                                                                P_("Secondary cursor color"),
3172                                                                P_("Color with which to draw the secondary insertion cursor when editing mixed right-to-left and left-to-right text"),
3173                                                                GDK_TYPE_COLOR,
3174                                                                GTK_PARAM_READABLE));
3175   gtk_widget_class_install_style_property (klass,
3176                                            g_param_spec_float ("cursor-aspect-ratio",
3177                                                                P_("Cursor line aspect ratio"),
3178                                                                P_("Aspect ratio with which to draw insertion cursor"),
3179                                                                0.0, 1.0, 0.04,
3180                                                                GTK_PARAM_READABLE));
3181
3182   gtk_widget_class_install_style_property (klass,
3183                                            g_param_spec_boolean ("window-dragging",
3184                                                                  P_("Window dragging"),
3185                                                                  P_("Whether windows can be dragged by clicking on empty areas"),
3186                                                                  FALSE,
3187                                                                  GTK_PARAM_READABLE));
3188
3189   /**
3190    * GtkWidget:link-color:
3191    *
3192    * The "link-color" style property defines the color of unvisited links.
3193    *
3194    * Since: 2.10
3195    */
3196   gtk_widget_class_install_style_property (klass,
3197                                            g_param_spec_boxed ("link-color",
3198                                                                P_("Unvisited Link Color"),
3199                                                                P_("Color of unvisited links"),
3200                                                                GDK_TYPE_COLOR,
3201                                                                GTK_PARAM_READABLE));
3202
3203   /**
3204    * GtkWidget:visited-link-color:
3205    *
3206    * The "visited-link-color" style property defines the color of visited links.
3207    *
3208    * Since: 2.10
3209    */
3210   gtk_widget_class_install_style_property (klass,
3211                                            g_param_spec_boxed ("visited-link-color",
3212                                                                P_("Visited Link Color"),
3213                                                                P_("Color of visited links"),
3214                                                                GDK_TYPE_COLOR,
3215                                                                GTK_PARAM_READABLE));
3216
3217   /**
3218    * GtkWidget:wide-separators:
3219    *
3220    * The "wide-separators" style property defines whether separators have
3221    * configurable width and should be drawn using a box instead of a line.
3222    *
3223    * Since: 2.10
3224    */
3225   gtk_widget_class_install_style_property (klass,
3226                                            g_param_spec_boolean ("wide-separators",
3227                                                                  P_("Wide Separators"),
3228                                                                  P_("Whether separators have configurable width and should be drawn using a box instead of a line"),
3229                                                                  FALSE,
3230                                                                  GTK_PARAM_READABLE));
3231
3232   /**
3233    * GtkWidget:separator-width:
3234    *
3235    * The "separator-width" style property defines the width of separators.
3236    * This property only takes effect if #GtkWidget:wide-separators is %TRUE.
3237    *
3238    * Since: 2.10
3239    */
3240   gtk_widget_class_install_style_property (klass,
3241                                            g_param_spec_int ("separator-width",
3242                                                              P_("Separator Width"),
3243                                                              P_("The width of separators if wide-separators is TRUE"),
3244                                                              0, G_MAXINT, 0,
3245                                                              GTK_PARAM_READABLE));
3246
3247   /**
3248    * GtkWidget:separator-height:
3249    *
3250    * The "separator-height" style property defines the height of separators.
3251    * This property only takes effect if #GtkWidget:wide-separators is %TRUE.
3252    *
3253    * Since: 2.10
3254    */
3255   gtk_widget_class_install_style_property (klass,
3256                                            g_param_spec_int ("separator-height",
3257                                                              P_("Separator Height"),
3258                                                              P_("The height of separators if \"wide-separators\" is TRUE"),
3259                                                              0, G_MAXINT, 0,
3260                                                              GTK_PARAM_READABLE));
3261
3262   /**
3263    * GtkWidget:scroll-arrow-hlength:
3264    *
3265    * The "scroll-arrow-hlength" style property defines the length of
3266    * horizontal scroll arrows.
3267    *
3268    * Since: 2.10
3269    */
3270   gtk_widget_class_install_style_property (klass,
3271                                            g_param_spec_int ("scroll-arrow-hlength",
3272                                                              P_("Horizontal Scroll Arrow Length"),
3273                                                              P_("The length of horizontal scroll arrows"),
3274                                                              1, G_MAXINT, 16,
3275                                                              GTK_PARAM_READABLE));
3276
3277   /**
3278    * GtkWidget:scroll-arrow-vlength:
3279    *
3280    * The "scroll-arrow-vlength" style property defines the length of
3281    * vertical scroll arrows.
3282    *
3283    * Since: 2.10
3284    */
3285   gtk_widget_class_install_style_property (klass,
3286                                            g_param_spec_int ("scroll-arrow-vlength",
3287                                                              P_("Vertical Scroll Arrow Length"),
3288                                                              P_("The length of vertical scroll arrows"),
3289                                                              1, G_MAXINT, 16,
3290                                                              GTK_PARAM_READABLE));
3291
3292   gtk_widget_class_install_style_property (klass,
3293                                            g_param_spec_int ("text-handle-width",
3294                                                              P_("Width of text selection handles"),
3295                                                              P_("Width of text selection handles"),
3296                                                              1, G_MAXINT, 16,
3297                                                              GTK_PARAM_READABLE));
3298   gtk_widget_class_install_style_property (klass,
3299                                            g_param_spec_int ("text-handle-height",
3300                                                              P_("Height of text selection handles"),
3301                                                              P_("Height of text selection handles"),
3302                                                              1, G_MAXINT, 20,
3303                                                              GTK_PARAM_READABLE));
3304
3305   g_type_class_add_private (klass, sizeof (GtkWidgetPrivate));
3306
3307   gtk_widget_class_set_accessible_type (klass, GTK_TYPE_WIDGET_ACCESSIBLE);
3308 }
3309
3310 static void
3311 gtk_widget_base_class_finalize (GtkWidgetClass *klass)
3312 {
3313   GList *list, *node;
3314
3315   list = g_param_spec_pool_list_owned (style_property_spec_pool, G_OBJECT_CLASS_TYPE (klass));
3316   for (node = list; node; node = node->next)
3317     {
3318       GParamSpec *pspec = node->data;
3319
3320       g_param_spec_pool_remove (style_property_spec_pool, pspec);
3321       g_param_spec_unref (pspec);
3322     }
3323   g_list_free (list);
3324 }
3325
3326 static void
3327 gtk_widget_set_property (GObject         *object,
3328                          guint            prop_id,
3329                          const GValue    *value,
3330                          GParamSpec      *pspec)
3331 {
3332   GtkWidget *widget = GTK_WIDGET (object);
3333
3334   switch (prop_id)
3335     {
3336       gboolean tmp;
3337       gchar *tooltip_markup;
3338       const gchar *tooltip_text;
3339       GtkWindow *tooltip_window;
3340
3341     case PROP_NAME:
3342       gtk_widget_set_name (widget, g_value_get_string (value));
3343       break;
3344     case PROP_PARENT:
3345       gtk_container_add (GTK_CONTAINER (g_value_get_object (value)), widget);
3346       break;
3347     case PROP_WIDTH_REQUEST:
3348       gtk_widget_set_usize_internal (widget, g_value_get_int (value), -2, 0);
3349       break;
3350     case PROP_HEIGHT_REQUEST:
3351       gtk_widget_set_usize_internal (widget, -2, g_value_get_int (value), 0);
3352       break;
3353     case PROP_VISIBLE:
3354       gtk_widget_set_visible (widget, g_value_get_boolean (value));
3355       break;
3356     case PROP_SENSITIVE:
3357       gtk_widget_set_sensitive (widget, g_value_get_boolean (value));
3358       break;
3359     case PROP_APP_PAINTABLE:
3360       gtk_widget_set_app_paintable (widget, g_value_get_boolean (value));
3361       break;
3362     case PROP_CAN_FOCUS:
3363       gtk_widget_set_can_focus (widget, g_value_get_boolean (value));
3364       break;
3365     case PROP_HAS_FOCUS:
3366       if (g_value_get_boolean (value))
3367         gtk_widget_grab_focus (widget);
3368       break;
3369     case PROP_IS_FOCUS:
3370       if (g_value_get_boolean (value))
3371         gtk_widget_grab_focus (widget);
3372       break;
3373     case PROP_CAN_DEFAULT:
3374       gtk_widget_set_can_default (widget, g_value_get_boolean (value));
3375       break;
3376     case PROP_HAS_DEFAULT:
3377       if (g_value_get_boolean (value))
3378         gtk_widget_grab_default (widget);
3379       break;
3380     case PROP_RECEIVES_DEFAULT:
3381       gtk_widget_set_receives_default (widget, g_value_get_boolean (value));
3382       break;
3383     case PROP_STYLE:
3384       gtk_widget_set_style (widget, g_value_get_object (value));
3385       break;
3386     case PROP_EVENTS:
3387       if (!gtk_widget_get_realized (widget) && gtk_widget_get_has_window (widget))
3388         gtk_widget_set_events (widget, g_value_get_flags (value));
3389       break;
3390     case PROP_NO_SHOW_ALL:
3391       gtk_widget_set_no_show_all (widget, g_value_get_boolean (value));
3392       break;
3393     case PROP_HAS_TOOLTIP:
3394       gtk_widget_real_set_has_tooltip (widget,
3395                                        g_value_get_boolean (value), FALSE);
3396       break;
3397     case PROP_TOOLTIP_MARKUP:
3398       tooltip_window = g_object_get_qdata (object, quark_tooltip_window);
3399       tooltip_markup = g_value_dup_string (value);
3400
3401       /* Treat an empty string as a NULL string,
3402        * because an empty string would be useless for a tooltip:
3403        */
3404       if (tooltip_markup && (strlen (tooltip_markup) == 0))
3405         {
3406           g_free (tooltip_markup);
3407           tooltip_markup = NULL;
3408         }
3409
3410       g_object_set_qdata_full (object, quark_tooltip_markup,
3411                                tooltip_markup, g_free);
3412
3413       tmp = (tooltip_window != NULL || tooltip_markup != NULL);
3414       gtk_widget_real_set_has_tooltip (widget, tmp, FALSE);
3415       if (gtk_widget_get_visible (widget))
3416         gtk_widget_queue_tooltip_query (widget);
3417       break;
3418     case PROP_TOOLTIP_TEXT:
3419       tooltip_window = g_object_get_qdata (object, quark_tooltip_window);
3420
3421       tooltip_text = g_value_get_string (value);
3422
3423       /* Treat an empty string as a NULL string,
3424        * because an empty string would be useless for a tooltip:
3425        */
3426       if (tooltip_text && (strlen (tooltip_text) == 0))
3427         tooltip_text = NULL;
3428
3429       tooltip_markup = tooltip_text ? g_markup_escape_text (tooltip_text, -1) : NULL;
3430
3431       g_object_set_qdata_full (object, quark_tooltip_markup,
3432                                tooltip_markup, g_free);
3433
3434       tmp = (tooltip_window != NULL || tooltip_markup != NULL);
3435       gtk_widget_real_set_has_tooltip (widget, tmp, FALSE);
3436       if (gtk_widget_get_visible (widget))
3437         gtk_widget_queue_tooltip_query (widget);
3438       break;
3439     case PROP_DOUBLE_BUFFERED:
3440       gtk_widget_set_double_buffered (widget, g_value_get_boolean (value));
3441       break;
3442     case PROP_HALIGN:
3443       gtk_widget_set_halign (widget, g_value_get_enum (value));
3444       break;
3445     case PROP_VALIGN:
3446       gtk_widget_set_valign (widget, g_value_get_enum (value));
3447       break;
3448     case PROP_MARGIN_LEFT:
3449       gtk_widget_set_margin_left (widget, g_value_get_int (value));
3450       break;
3451     case PROP_MARGIN_RIGHT:
3452       gtk_widget_set_margin_right (widget, g_value_get_int (value));
3453       break;
3454     case PROP_MARGIN_TOP:
3455       gtk_widget_set_margin_top (widget, g_value_get_int (value));
3456       break;
3457     case PROP_MARGIN_BOTTOM:
3458       gtk_widget_set_margin_bottom (widget, g_value_get_int (value));
3459       break;
3460     case PROP_MARGIN:
3461       g_object_freeze_notify (G_OBJECT (widget));
3462       gtk_widget_set_margin_left (widget, g_value_get_int (value));
3463       gtk_widget_set_margin_right (widget, g_value_get_int (value));
3464       gtk_widget_set_margin_top (widget, g_value_get_int (value));
3465       gtk_widget_set_margin_bottom (widget, g_value_get_int (value));
3466       g_object_thaw_notify (G_OBJECT (widget));
3467       break;
3468     case PROP_HEXPAND:
3469       gtk_widget_set_hexpand (widget, g_value_get_boolean (value));
3470       break;
3471     case PROP_HEXPAND_SET:
3472       gtk_widget_set_hexpand_set (widget, g_value_get_boolean (value));
3473       break;
3474     case PROP_VEXPAND:
3475       gtk_widget_set_vexpand (widget, g_value_get_boolean (value));
3476       break;
3477     case PROP_VEXPAND_SET:
3478       gtk_widget_set_vexpand_set (widget, g_value_get_boolean (value));
3479       break;
3480     case PROP_EXPAND:
3481       g_object_freeze_notify (G_OBJECT (widget));
3482       gtk_widget_set_hexpand (widget, g_value_get_boolean (value));
3483       gtk_widget_set_vexpand (widget, g_value_get_boolean (value));
3484       g_object_thaw_notify (G_OBJECT (widget));
3485       break;
3486     default:
3487       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
3488       break;
3489     }
3490 }
3491
3492 static void
3493 gtk_widget_get_property (GObject         *object,
3494                          guint            prop_id,
3495                          GValue          *value,
3496                          GParamSpec      *pspec)
3497 {
3498   GtkWidget *widget = GTK_WIDGET (object);
3499   GtkWidgetPrivate *priv = widget->priv;
3500
3501   switch (prop_id)
3502     {
3503       gpointer *eventp;
3504
3505     case PROP_NAME:
3506       if (priv->name)
3507         g_value_set_string (value, priv->name);
3508       else
3509         g_value_set_static_string (value, "");
3510       break;
3511     case PROP_PARENT:
3512       g_value_set_object (value, priv->parent);
3513       break;
3514     case PROP_WIDTH_REQUEST:
3515       {
3516         int w;
3517         gtk_widget_get_size_request (widget, &w, NULL);
3518         g_value_set_int (value, w);
3519       }
3520       break;
3521     case PROP_HEIGHT_REQUEST:
3522       {
3523         int h;
3524         gtk_widget_get_size_request (widget, NULL, &h);
3525         g_value_set_int (value, h);
3526       }
3527       break;
3528     case PROP_VISIBLE:
3529       g_value_set_boolean (value, (gtk_widget_get_visible (widget) != FALSE));
3530       break;
3531     case PROP_SENSITIVE:
3532       g_value_set_boolean (value, (gtk_widget_get_sensitive (widget) != FALSE));
3533       break;
3534     case PROP_APP_PAINTABLE:
3535       g_value_set_boolean (value, (gtk_widget_get_app_paintable (widget) != FALSE));
3536       break;
3537     case PROP_CAN_FOCUS:
3538       g_value_set_boolean (value, (gtk_widget_get_can_focus (widget) != FALSE));
3539       break;
3540     case PROP_HAS_FOCUS:
3541       g_value_set_boolean (value, (gtk_widget_has_focus (widget) != FALSE));
3542       break;
3543     case PROP_IS_FOCUS:
3544       g_value_set_boolean (value, (gtk_widget_is_focus (widget)));
3545       break;
3546     case PROP_CAN_DEFAULT:
3547       g_value_set_boolean (value, (gtk_widget_get_can_default (widget) != FALSE));
3548       break;
3549     case PROP_HAS_DEFAULT:
3550       g_value_set_boolean (value, (gtk_widget_has_default (widget) != FALSE));
3551       break;
3552     case PROP_RECEIVES_DEFAULT:
3553       g_value_set_boolean (value, (gtk_widget_get_receives_default (widget) != FALSE));
3554       break;
3555     case PROP_COMPOSITE_CHILD:
3556       g_value_set_boolean (value, widget->priv->composite_child);
3557       break;
3558     case PROP_STYLE:
3559       g_value_set_object (value, gtk_widget_get_style (widget));
3560       break;
3561     case PROP_EVENTS:
3562       eventp = g_object_get_qdata (G_OBJECT (widget), quark_event_mask);
3563       g_value_set_flags (value, GPOINTER_TO_INT (eventp));
3564       break;
3565     case PROP_NO_SHOW_ALL:
3566       g_value_set_boolean (value, gtk_widget_get_no_show_all (widget));
3567       break;
3568     case PROP_HAS_TOOLTIP:
3569       g_value_set_boolean (value, GPOINTER_TO_UINT (g_object_get_qdata (object, quark_has_tooltip)));
3570       break;
3571     case PROP_TOOLTIP_TEXT:
3572       {
3573         gchar *escaped = g_object_get_qdata (object, quark_tooltip_markup);
3574         gchar *text = NULL;
3575
3576         if (escaped && !pango_parse_markup (escaped, -1, 0, NULL, &text, NULL, NULL))
3577           g_assert (NULL == text); /* text should still be NULL in case of markup errors */
3578
3579         g_value_take_string (value, text);
3580       }
3581       break;
3582     case PROP_TOOLTIP_MARKUP:
3583       g_value_set_string (value, g_object_get_qdata (object, quark_tooltip_markup));
3584       break;
3585     case PROP_WINDOW:
3586       g_value_set_object (value, gtk_widget_get_window (widget));
3587       break;
3588     case PROP_DOUBLE_BUFFERED:
3589       g_value_set_boolean (value, gtk_widget_get_double_buffered (widget));
3590       break;
3591     case PROP_HALIGN:
3592       g_value_set_enum (value, gtk_widget_get_halign (widget));
3593       break;
3594     case PROP_VALIGN:
3595       g_value_set_enum (value, gtk_widget_get_valign (widget));
3596       break;
3597     case PROP_MARGIN_LEFT:
3598       g_value_set_int (value, gtk_widget_get_margin_left (widget));
3599       break;
3600     case PROP_MARGIN_RIGHT:
3601       g_value_set_int (value, gtk_widget_get_margin_right (widget));
3602       break;
3603     case PROP_MARGIN_TOP:
3604       g_value_set_int (value, gtk_widget_get_margin_top (widget));
3605       break;
3606     case PROP_MARGIN_BOTTOM:
3607       g_value_set_int (value, gtk_widget_get_margin_bottom (widget));
3608       break;
3609     case PROP_MARGIN:
3610       {
3611         GtkWidgetAuxInfo *aux_info = gtk_widget_get_aux_info (widget, FALSE);
3612         if (aux_info == NULL)
3613           {
3614             g_value_set_int (value, 0);
3615           }
3616         else
3617           {
3618             g_value_set_int (value, MAX (MAX (aux_info->margin.left,
3619                                               aux_info->margin.right),
3620                                          MAX (aux_info->margin.top,
3621                                               aux_info->margin.bottom)));
3622           }
3623       }
3624       break;
3625     case PROP_HEXPAND:
3626       g_value_set_boolean (value, gtk_widget_get_hexpand (widget));
3627       break;
3628     case PROP_HEXPAND_SET:
3629       g_value_set_boolean (value, gtk_widget_get_hexpand_set (widget));
3630       break;
3631     case PROP_VEXPAND:
3632       g_value_set_boolean (value, gtk_widget_get_vexpand (widget));
3633       break;
3634     case PROP_VEXPAND_SET:
3635       g_value_set_boolean (value, gtk_widget_get_vexpand_set (widget));
3636       break;
3637     case PROP_EXPAND:
3638       g_value_set_boolean (value,
3639                            gtk_widget_get_hexpand (widget) &&
3640                            gtk_widget_get_vexpand (widget));
3641       break;
3642     default:
3643       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
3644       break;
3645     }
3646 }
3647
3648 static void
3649 gtk_widget_init (GtkWidget *widget)
3650 {
3651   GtkWidgetPrivate *priv;
3652
3653   widget->priv = G_TYPE_INSTANCE_GET_PRIVATE (widget,
3654                                               GTK_TYPE_WIDGET,
3655                                               GtkWidgetPrivate);
3656   priv = widget->priv;
3657
3658   priv->child_visible = TRUE;
3659   priv->name = NULL;
3660   priv->allocation.x = -1;
3661   priv->allocation.y = -1;
3662   priv->allocation.width = 1;
3663   priv->allocation.height = 1;
3664   priv->window = NULL;
3665   priv->parent = NULL;
3666
3667   priv->sensitive = TRUE;
3668   priv->composite_child = composite_child_stack != 0;
3669   priv->double_buffered = TRUE;
3670   priv->redraw_on_alloc = TRUE;
3671   priv->alloc_needed = TRUE;
3672
3673   switch (gtk_widget_get_direction (widget))
3674     {
3675     case GTK_TEXT_DIR_LTR:
3676       priv->state_flags = GTK_STATE_FLAG_DIR_LTR;
3677       break;
3678
3679     case GTK_TEXT_DIR_RTL:
3680       priv->state_flags = GTK_STATE_FLAG_DIR_RTL;
3681       break;
3682
3683     case GTK_TEXT_DIR_NONE:
3684     default:
3685       g_assert_not_reached ();
3686       break;
3687     }
3688
3689
3690   /* this will be set to TRUE if the widget gets a child or if the
3691    * expand flag is set on the widget, but until one of those happen
3692    * we know the expand is already properly FALSE.
3693    *
3694    * We really want to default FALSE here to avoid computing expand
3695    * all over the place while initially building a widget tree.
3696    */
3697   priv->need_compute_expand = FALSE;
3698
3699   _gtk_size_request_cache_init (&priv->requests);
3700
3701   priv->style = gtk_widget_get_default_style ();
3702   g_object_ref (priv->style);
3703 }
3704
3705
3706 static void
3707 gtk_widget_dispatch_child_properties_changed (GtkWidget   *widget,
3708                                               guint        n_pspecs,
3709                                               GParamSpec **pspecs)
3710 {
3711   GtkWidgetPrivate *priv = widget->priv;
3712   GtkWidget *container = priv->parent;
3713   guint i;
3714
3715   for (i = 0; widget->priv->parent == container && i < n_pspecs; i++)
3716     g_signal_emit (widget, widget_signals[CHILD_NOTIFY], g_quark_from_string (pspecs[i]->name), pspecs[i]);
3717 }
3718
3719 /**
3720  * gtk_widget_freeze_child_notify:
3721  * @widget: a #GtkWidget
3722  *
3723  * Stops emission of #GtkWidget::child-notify signals on @widget. The
3724  * signals are queued until gtk_widget_thaw_child_notify() is called
3725  * on @widget.
3726  *
3727  * This is the analogue of g_object_freeze_notify() for child properties.
3728  **/
3729 void
3730 gtk_widget_freeze_child_notify (GtkWidget *widget)
3731 {
3732   g_return_if_fail (GTK_IS_WIDGET (widget));
3733
3734   if (!G_OBJECT (widget)->ref_count)
3735     return;
3736
3737   g_object_ref (widget);
3738   g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
3739   g_object_unref (widget);
3740 }
3741
3742 /**
3743  * gtk_widget_child_notify:
3744  * @widget: a #GtkWidget
3745  * @child_property: the name of a child property installed on the
3746  *                  class of @widget<!-- -->'s parent
3747  *
3748  * Emits a #GtkWidget::child-notify signal for the
3749  * <link linkend="child-properties">child property</link> @child_property
3750  * on @widget.
3751  *
3752  * This is the analogue of g_object_notify() for child properties.
3753  *
3754  * Also see gtk_container_child_notify().
3755  */
3756 void
3757 gtk_widget_child_notify (GtkWidget    *widget,
3758                          const gchar  *child_property)
3759 {
3760   if (widget->priv->parent == NULL)
3761     return;
3762
3763   gtk_container_child_notify (GTK_CONTAINER (widget->priv->parent), widget, child_property);
3764 }
3765
3766 /**
3767  * gtk_widget_thaw_child_notify:
3768  * @widget: a #GtkWidget
3769  *
3770  * Reverts the effect of a previous call to gtk_widget_freeze_child_notify().
3771  * This causes all queued #GtkWidget::child-notify signals on @widget to be
3772  * emitted.
3773  */
3774 void
3775 gtk_widget_thaw_child_notify (GtkWidget *widget)
3776 {
3777   GObjectNotifyQueue *nqueue;
3778
3779   g_return_if_fail (GTK_IS_WIDGET (widget));
3780
3781   if (!G_OBJECT (widget)->ref_count)
3782     return;
3783
3784   g_object_ref (widget);
3785   nqueue = g_object_notify_queue_from_object (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
3786   if (!nqueue || !nqueue->freeze_count)
3787     g_warning (G_STRLOC ": child-property-changed notification for %s(%p) is not frozen",
3788                G_OBJECT_TYPE_NAME (widget), widget);
3789   else
3790     g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
3791   g_object_unref (widget);
3792 }
3793
3794
3795 /**
3796  * gtk_widget_new:
3797  * @type: type ID of the widget to create
3798  * @first_property_name: name of first property to set
3799  * @...: value of first property, followed by more properties,
3800  *     %NULL-terminated
3801  *
3802  * This is a convenience function for creating a widget and setting
3803  * its properties in one go. For example you might write:
3804  * <literal>gtk_widget_new (GTK_TYPE_LABEL, "label", "Hello World", "xalign",
3805  * 0.0, NULL)</literal> to create a left-aligned label. Equivalent to
3806  * g_object_new(), but returns a widget so you don't have to
3807  * cast the object yourself.
3808  *
3809  * Return value: a new #GtkWidget of type @widget_type
3810  **/
3811 GtkWidget*
3812 gtk_widget_new (GType        type,
3813                 const gchar *first_property_name,
3814                 ...)
3815 {
3816   GtkWidget *widget;
3817   va_list var_args;
3818
3819   g_return_val_if_fail (g_type_is_a (type, GTK_TYPE_WIDGET), NULL);
3820
3821   va_start (var_args, first_property_name);
3822   widget = (GtkWidget *)g_object_new_valist (type, first_property_name, var_args);
3823   va_end (var_args);
3824
3825   return widget;
3826 }
3827
3828 static inline void
3829 gtk_widget_queue_draw_child (GtkWidget *widget)
3830 {
3831   GtkWidgetPrivate *priv = widget->priv;
3832   GtkWidget *parent;
3833
3834   parent = priv->parent;
3835   if (parent && gtk_widget_is_drawable (parent))
3836     gtk_widget_queue_draw_area (parent,
3837                                 priv->allocation.x,
3838                                 priv->allocation.y,
3839                                 priv->allocation.width,
3840                                 priv->allocation.height);
3841 }
3842
3843 /**
3844  * gtk_widget_unparent:
3845  * @widget: a #GtkWidget
3846  *
3847  * This function is only for use in widget implementations.
3848  * Should be called by implementations of the remove method
3849  * on #GtkContainer, to dissociate a child from the container.
3850  **/
3851 void
3852 gtk_widget_unparent (GtkWidget *widget)
3853 {
3854   GtkWidgetPrivate *priv;
3855   GObjectNotifyQueue *nqueue;
3856   GtkWidget *toplevel;
3857   GtkWidget *old_parent;
3858
3859   g_return_if_fail (GTK_IS_WIDGET (widget));
3860
3861   priv = widget->priv;
3862
3863   if (priv->parent == NULL)
3864     return;
3865
3866   /* keep this function in sync with gtk_menu_detach() */
3867
3868   gtk_widget_push_verify_invariants (widget);
3869
3870   g_object_freeze_notify (G_OBJECT (widget));
3871   nqueue = g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
3872
3873   toplevel = gtk_widget_get_toplevel (widget);
3874   if (gtk_widget_is_toplevel (toplevel))
3875     _gtk_window_unset_focus_and_default (GTK_WINDOW (toplevel), widget);
3876
3877   if (gtk_container_get_focus_child (GTK_CONTAINER (priv->parent)) == widget)
3878     gtk_container_set_focus_child (GTK_CONTAINER (priv->parent), NULL);
3879
3880   gtk_widget_queue_draw_child (widget);
3881
3882   /* Reset the width and height here, to force reallocation if we
3883    * get added back to a new parent. This won't work if our new
3884    * allocation is smaller than 1x1 and we actually want a size of 1x1...
3885    * (would 0x0 be OK here?)
3886    */
3887   priv->allocation.width = 1;
3888   priv->allocation.height = 1;
3889
3890   if (gtk_widget_get_realized (widget))
3891     {
3892       if (priv->in_reparent)
3893         gtk_widget_unmap (widget);
3894       else
3895         gtk_widget_unrealize (widget);
3896     }
3897
3898   /* If we are unanchoring the child, we save around the toplevel
3899    * to emit hierarchy changed
3900    */
3901   if (priv->parent->priv->anchored)
3902     g_object_ref (toplevel);
3903   else
3904     toplevel = NULL;
3905
3906   /* Removing a widget from a container restores the child visible
3907    * flag to the default state, so it doesn't affect the child
3908    * in the next parent.
3909    */
3910   priv->child_visible = TRUE;
3911
3912   old_parent = priv->parent;
3913   priv->parent = NULL;
3914
3915   /* parent may no longer expand if the removed
3916    * child was expand=TRUE and could therefore
3917    * be forcing it to.
3918    */
3919   if (gtk_widget_get_visible (widget) &&
3920       (priv->need_compute_expand ||
3921        priv->computed_hexpand ||
3922        priv->computed_vexpand))
3923     {
3924       gtk_widget_queue_compute_expand (old_parent);
3925     }
3926
3927   /* Unset BACKDROP since we are no longer inside a toplevel window */
3928   gtk_widget_unset_state_flags (widget, GTK_STATE_FLAG_BACKDROP);
3929   if (priv->context)
3930     gtk_style_context_set_parent (priv->context, NULL);
3931
3932   _gtk_widget_update_parent_muxer (widget);
3933
3934   g_signal_emit (widget, widget_signals[PARENT_SET], 0, old_parent);
3935   if (toplevel)
3936     {
3937       _gtk_widget_propagate_hierarchy_changed (widget, toplevel);
3938       g_object_unref (toplevel);
3939     }
3940
3941   /* Now that the parent pointer is nullified and the hierarchy-changed
3942    * already passed, go ahead and unset the parent window, if we are unparenting
3943    * an embeded GtkWindow the window will become toplevel again and hierarchy-changed
3944    * will fire again for the new subhierarchy.
3945    */
3946   gtk_widget_set_parent_window (widget, NULL);
3947
3948   g_object_notify (G_OBJECT (widget), "parent");
3949   g_object_thaw_notify (G_OBJECT (widget));
3950   if (!priv->parent)
3951     g_object_notify_queue_clear (G_OBJECT (widget), nqueue);
3952   g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
3953
3954   gtk_widget_pop_verify_invariants (widget);
3955   g_object_unref (widget);
3956 }
3957
3958 /**
3959  * gtk_widget_destroy:
3960  * @widget: a #GtkWidget
3961  *
3962  * Destroys a widget.
3963  *
3964  * When a widget is
3965  * destroyed, it will break any references it holds to other objects.
3966  * If the widget is inside a container, the widget will be removed
3967  * from the container. If the widget is a toplevel (derived from
3968  * #GtkWindow), it will be removed from the list of toplevels, and the
3969  * reference GTK+ holds to it will be removed. Removing a
3970  * widget from its container or the list of toplevels results in the
3971  * widget being finalized, unless you've added additional references
3972  * to the widget with g_object_ref().
3973  *
3974  * In most cases, only toplevel widgets (windows) require explicit
3975  * destruction, because when you destroy a toplevel its children will
3976  * be destroyed as well.
3977  **/
3978 void
3979 gtk_widget_destroy (GtkWidget *widget)
3980 {
3981   g_return_if_fail (GTK_IS_WIDGET (widget));
3982
3983   if (!widget->priv->in_destruction)
3984     g_object_run_dispose (G_OBJECT (widget));
3985 }
3986
3987 /**
3988  * gtk_widget_destroyed:
3989  * @widget: a #GtkWidget
3990  * @widget_pointer: (inout) (transfer none): address of a variable that contains @widget
3991  *
3992  * This function sets *@widget_pointer to %NULL if @widget_pointer !=
3993  * %NULL.  It's intended to be used as a callback connected to the
3994  * "destroy" signal of a widget. You connect gtk_widget_destroyed()
3995  * as a signal handler, and pass the address of your widget variable
3996  * as user data. Then when the widget is destroyed, the variable will
3997  * be set to %NULL. Useful for example to avoid multiple copies
3998  * of the same dialog.
3999  **/
4000 void
4001 gtk_widget_destroyed (GtkWidget      *widget,
4002                       GtkWidget      **widget_pointer)
4003 {
4004   /* Don't make any assumptions about the
4005    *  value of widget!
4006    *  Even check widget_pointer.
4007    */
4008   if (widget_pointer)
4009     *widget_pointer = NULL;
4010 }
4011
4012 /**
4013  * gtk_widget_show:
4014  * @widget: a #GtkWidget
4015  *
4016  * Flags a widget to be displayed. Any widget that isn't shown will
4017  * not appear on the screen. If you want to show all the widgets in a
4018  * container, it's easier to call gtk_widget_show_all() on the
4019  * container, instead of individually showing the widgets.
4020  *
4021  * Remember that you have to show the containers containing a widget,
4022  * in addition to the widget itself, before it will appear onscreen.
4023  *
4024  * When a toplevel container is shown, it is immediately realized and
4025  * mapped; other shown widgets are realized and mapped when their
4026  * toplevel container is realized and mapped.
4027  **/
4028 void
4029 gtk_widget_show (GtkWidget *widget)
4030 {
4031   g_return_if_fail (GTK_IS_WIDGET (widget));
4032
4033   if (!gtk_widget_get_visible (widget))
4034     {
4035       g_object_ref (widget);
4036       gtk_widget_push_verify_invariants (widget);
4037
4038       if (!gtk_widget_is_toplevel (widget))
4039         gtk_widget_queue_resize (widget);
4040
4041       /* see comment in set_parent() for why this should and can be
4042        * conditional
4043        */
4044       if (widget->priv->need_compute_expand ||
4045           widget->priv->computed_hexpand ||
4046           widget->priv->computed_vexpand)
4047         {
4048           if (widget->priv->parent != NULL)
4049             gtk_widget_queue_compute_expand (widget->priv->parent);
4050         }
4051
4052       g_signal_emit (widget, widget_signals[SHOW], 0);
4053       g_object_notify (G_OBJECT (widget), "visible");
4054
4055       gtk_widget_pop_verify_invariants (widget);
4056       g_object_unref (widget);
4057     }
4058 }
4059
4060 static void
4061 gtk_widget_real_show (GtkWidget *widget)
4062 {
4063   GtkWidgetPrivate *priv = widget->priv;
4064
4065   if (!gtk_widget_get_visible (widget))
4066     {
4067       priv->visible = TRUE;
4068
4069       if (priv->parent &&
4070           gtk_widget_get_mapped (priv->parent) &&
4071           gtk_widget_get_child_visible (widget) &&
4072           !gtk_widget_get_mapped (widget))
4073         gtk_widget_map (widget);
4074     }
4075 }
4076
4077 static void
4078 gtk_widget_show_map_callback (GtkWidget *widget, GdkEvent *event, gint *flag)
4079 {
4080   *flag = TRUE;
4081   g_signal_handlers_disconnect_by_func (widget,
4082                                         gtk_widget_show_map_callback,
4083                                         flag);
4084 }
4085
4086 /**
4087  * gtk_widget_show_now:
4088  * @widget: a #GtkWidget
4089  *
4090  * Shows a widget. If the widget is an unmapped toplevel widget
4091  * (i.e. a #GtkWindow that has not yet been shown), enter the main
4092  * loop and wait for the window to actually be mapped. Be careful;
4093  * because the main loop is running, anything can happen during
4094  * this function.
4095  **/
4096 void
4097 gtk_widget_show_now (GtkWidget *widget)
4098 {
4099   gint flag = FALSE;
4100
4101   g_return_if_fail (GTK_IS_WIDGET (widget));
4102
4103   /* make sure we will get event */
4104   if (!gtk_widget_get_mapped (widget) &&
4105       gtk_widget_is_toplevel (widget))
4106     {
4107       gtk_widget_show (widget);
4108
4109       g_signal_connect (widget, "map-event",
4110                         G_CALLBACK (gtk_widget_show_map_callback),
4111                         &flag);
4112
4113       while (!flag)
4114         gtk_main_iteration ();
4115     }
4116   else
4117     gtk_widget_show (widget);
4118 }
4119
4120 /**
4121  * gtk_widget_hide:
4122  * @widget: a #GtkWidget
4123  *
4124  * Reverses the effects of gtk_widget_show(), causing the widget to be
4125  * hidden (invisible to the user).
4126  **/
4127 void
4128 gtk_widget_hide (GtkWidget *widget)
4129 {
4130   g_return_if_fail (GTK_IS_WIDGET (widget));
4131
4132   if (gtk_widget_get_visible (widget))
4133     {
4134       GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
4135
4136       g_object_ref (widget);
4137       gtk_widget_push_verify_invariants (widget);
4138
4139       if (toplevel != widget && gtk_widget_is_toplevel (toplevel))
4140         _gtk_window_unset_focus_and_default (GTK_WINDOW (toplevel), widget);
4141
4142       /* a parent may now be expand=FALSE since we're hidden. */
4143       if (widget->priv->need_compute_expand ||
4144           widget->priv->computed_hexpand ||
4145           widget->priv->computed_vexpand)
4146         {
4147           gtk_widget_queue_compute_expand (widget);
4148         }
4149
4150       g_signal_emit (widget, widget_signals[HIDE], 0);
4151       if (!gtk_widget_is_toplevel (widget))
4152         gtk_widget_queue_resize (widget);
4153       g_object_notify (G_OBJECT (widget), "visible");
4154
4155       gtk_widget_pop_verify_invariants (widget);
4156       g_object_unref (widget);
4157     }
4158 }
4159
4160 static void
4161 gtk_widget_real_hide (GtkWidget *widget)
4162 {
4163   if (gtk_widget_get_visible (widget))
4164     {
4165       widget->priv->visible = FALSE;
4166
4167       if (gtk_widget_get_mapped (widget))
4168         gtk_widget_unmap (widget);
4169     }
4170 }
4171
4172 /**
4173  * gtk_widget_hide_on_delete:
4174  * @widget: a #GtkWidget
4175  *
4176  * Utility function; intended to be connected to the #GtkWidget::delete-event
4177  * signal on a #GtkWindow. The function calls gtk_widget_hide() on its
4178  * argument, then returns %TRUE. If connected to ::delete-event, the
4179  * result is that clicking the close button for a window (on the
4180  * window frame, top right corner usually) will hide but not destroy
4181  * the window. By default, GTK+ destroys windows when ::delete-event
4182  * is received.
4183  *
4184  * Return value: %TRUE
4185  **/
4186 gboolean
4187 gtk_widget_hide_on_delete (GtkWidget *widget)
4188 {
4189   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4190
4191   gtk_widget_hide (widget);
4192
4193   return TRUE;
4194 }
4195
4196 /**
4197  * gtk_widget_show_all:
4198  * @widget: a #GtkWidget
4199  *
4200  * Recursively shows a widget, and any child widgets (if the widget is
4201  * a container).
4202  **/
4203 void
4204 gtk_widget_show_all (GtkWidget *widget)
4205 {
4206   GtkWidgetClass *class;
4207
4208   g_return_if_fail (GTK_IS_WIDGET (widget));
4209
4210   if (gtk_widget_get_no_show_all (widget))
4211     return;
4212
4213   class = GTK_WIDGET_GET_CLASS (widget);
4214
4215   if (class->show_all)
4216     class->show_all (widget);
4217 }
4218
4219 /**
4220  * gtk_widget_map:
4221  * @widget: a #GtkWidget
4222  *
4223  * This function is only for use in widget implementations. Causes
4224  * a widget to be mapped if it isn't already.
4225  **/
4226 void
4227 gtk_widget_map (GtkWidget *widget)
4228 {
4229   GtkWidgetPrivate *priv;
4230
4231   g_return_if_fail (GTK_IS_WIDGET (widget));
4232   g_return_if_fail (gtk_widget_get_visible (widget));
4233   g_return_if_fail (gtk_widget_get_child_visible (widget));
4234
4235   priv = widget->priv;
4236
4237   if (!gtk_widget_get_mapped (widget))
4238     {
4239       gtk_widget_push_verify_invariants (widget);
4240
4241       if (!gtk_widget_get_realized (widget))
4242         gtk_widget_realize (widget);
4243
4244       g_signal_emit (widget, widget_signals[MAP], 0);
4245
4246       if (!gtk_widget_get_has_window (widget))
4247         gdk_window_invalidate_rect (priv->window, &priv->allocation, FALSE);
4248
4249       if (widget->priv->context)
4250         _gtk_style_context_update_animating (widget->priv->context);
4251
4252       gtk_widget_pop_verify_invariants (widget);
4253     }
4254 }
4255
4256 /**
4257  * gtk_widget_unmap:
4258  * @widget: a #GtkWidget
4259  *
4260  * This function is only for use in widget implementations. Causes
4261  * a widget to be unmapped if it's currently mapped.
4262  **/
4263 void
4264 gtk_widget_unmap (GtkWidget *widget)
4265 {
4266   GtkWidgetPrivate *priv;
4267
4268   g_return_if_fail (GTK_IS_WIDGET (widget));
4269
4270   priv = widget->priv;
4271
4272   if (gtk_widget_get_mapped (widget))
4273     {
4274       gtk_widget_push_verify_invariants (widget);
4275
4276       if (!gtk_widget_get_has_window (widget))
4277         gdk_window_invalidate_rect (priv->window, &priv->allocation, FALSE);
4278       _gtk_tooltip_hide (widget);
4279
4280       if (widget->priv->context)
4281         _gtk_style_context_update_animating (widget->priv->context);
4282
4283       g_signal_emit (widget, widget_signals[UNMAP], 0);
4284
4285       gtk_widget_pop_verify_invariants (widget);
4286
4287       /* Unset pointer/window info */
4288       g_object_set_qdata (G_OBJECT (widget), quark_pointer_window, NULL);
4289     }
4290 }
4291
4292 static void
4293 _gtk_widget_enable_device_events (GtkWidget *widget)
4294 {
4295   GHashTable *device_events;
4296   GHashTableIter iter;
4297   gpointer key, value;
4298
4299   device_events = g_object_get_qdata (G_OBJECT (widget), quark_device_event_mask);
4300
4301   if (!device_events)
4302     return;
4303
4304   g_hash_table_iter_init (&iter, device_events);
4305
4306   while (g_hash_table_iter_next (&iter, &key, &value))
4307     {
4308       GdkDevice *device;
4309       GdkEventMask event_mask;
4310
4311       device = key;
4312       event_mask = GPOINTER_TO_UINT (value);
4313       gtk_widget_add_events_internal (widget, device, event_mask);
4314     }
4315 }
4316
4317 static GList *
4318 get_widget_windows (GtkWidget *widget)
4319 {
4320   GList *window_list, *last, *l, *children, *ret;
4321
4322   if (gtk_widget_get_has_window (widget))
4323     window_list = g_list_prepend (NULL, gtk_widget_get_window (widget));
4324   else
4325     window_list = gdk_window_peek_children (gtk_widget_get_window (widget));
4326
4327   last = g_list_last (window_list);
4328   ret = NULL;
4329
4330   for (l = window_list; l; l = l->next)
4331     {
4332       GtkWidget *window_widget = NULL;
4333
4334       gdk_window_get_user_data (l->data, (gpointer *) &window_widget);
4335
4336       if (widget != window_widget)
4337         continue;
4338
4339       ret = g_list_prepend (ret, l->data);
4340       children = gdk_window_peek_children (GDK_WINDOW (l->data));
4341
4342       if (children)
4343         {
4344           last = g_list_concat (last, children);
4345           last = g_list_last (last);
4346         }
4347     }
4348
4349   g_list_free (window_list);
4350
4351   return ret;
4352 }
4353
4354 static void
4355 device_enable_foreach (GtkWidget *widget,
4356                        gpointer   user_data)
4357 {
4358   GdkDevice *device = user_data;
4359   gtk_widget_set_device_enabled_internal (widget, device, TRUE, TRUE);
4360 }
4361
4362 static void
4363 device_disable_foreach (GtkWidget *widget,
4364                         gpointer   user_data)
4365 {
4366   GdkDevice *device = user_data;
4367   gtk_widget_set_device_enabled_internal (widget, device, TRUE, FALSE);
4368 }
4369
4370 static void
4371 gtk_widget_set_device_enabled_internal (GtkWidget *widget,
4372                                         GdkDevice *device,
4373                                         gboolean   recurse,
4374                                         gboolean   enabled)
4375 {
4376   GList *window_list, *l;
4377
4378   window_list = get_widget_windows (widget);
4379
4380   for (l = window_list; l; l = l->next)
4381     {
4382       GdkEventMask events = 0;
4383       GdkWindow *window;
4384
4385       window = l->data;
4386
4387       if (enabled)
4388         events = gdk_window_get_events (window);
4389
4390       gdk_window_set_device_events (window, device, events);
4391     }
4392
4393   if (recurse && GTK_IS_CONTAINER (widget))
4394     {
4395       if (enabled)
4396         gtk_container_forall (GTK_CONTAINER (widget), device_enable_foreach, device);
4397       else
4398         gtk_container_forall (GTK_CONTAINER (widget), device_disable_foreach, device);
4399     }
4400
4401   g_list_free (window_list);
4402 }
4403
4404 static void
4405 gtk_widget_update_devices_mask (GtkWidget *widget,
4406                                 gboolean   recurse)
4407 {
4408   GList *enabled_devices, *l;
4409
4410   enabled_devices = g_object_get_qdata (G_OBJECT (widget), quark_enabled_devices);
4411
4412   for (l = enabled_devices; l; l = l->next)
4413     gtk_widget_set_device_enabled_internal (widget, GDK_DEVICE (l->data), recurse, TRUE);
4414 }
4415
4416 /**
4417  * gtk_widget_realize:
4418  * @widget: a #GtkWidget
4419  *
4420  * Creates the GDK (windowing system) resources associated with a
4421  * widget.  For example, @widget->window will be created when a widget
4422  * is realized.  Normally realization happens implicitly; if you show
4423  * a widget and all its parent containers, then the widget will be
4424  * realized and mapped automatically.
4425  *
4426  * Realizing a widget requires all
4427  * the widget's parent widgets to be realized; calling
4428  * gtk_widget_realize() realizes the widget's parents in addition to
4429  * @widget itself. If a widget is not yet inside a toplevel window
4430  * when you realize it, bad things will happen.
4431  *
4432  * This function is primarily used in widget implementations, and
4433  * isn't very useful otherwise. Many times when you think you might
4434  * need it, a better approach is to connect to a signal that will be
4435  * called after the widget is realized automatically, such as
4436  * #GtkWidget::draw. Or simply g_signal_connect () to the
4437  * #GtkWidget::realize signal.
4438  **/
4439 void
4440 gtk_widget_realize (GtkWidget *widget)
4441 {
4442   GtkWidgetPrivate *priv;
4443   cairo_region_t *region;
4444
4445   g_return_if_fail (GTK_IS_WIDGET (widget));
4446   g_return_if_fail (widget->priv->anchored ||
4447                     GTK_IS_INVISIBLE (widget));
4448
4449   priv = widget->priv;
4450
4451   if (!gtk_widget_get_realized (widget))
4452     {
4453       gtk_widget_push_verify_invariants (widget);
4454
4455       /*
4456         if (GTK_IS_CONTAINER (widget) && gtk_widget_get_has_window (widget))
4457           g_message ("gtk_widget_realize(%s)", G_OBJECT_TYPE_NAME (widget));
4458       */
4459
4460       if (priv->parent == NULL &&
4461           !gtk_widget_is_toplevel (widget))
4462         g_warning ("Calling gtk_widget_realize() on a widget that isn't "
4463                    "inside a toplevel window is not going to work very well. "
4464                    "Widgets must be inside a toplevel container before realizing them.");
4465
4466       if (priv->parent && !gtk_widget_get_realized (priv->parent))
4467         gtk_widget_realize (priv->parent);
4468
4469       gtk_widget_ensure_style (widget);
4470
4471       if (priv->style_update_pending)
4472         g_signal_emit (widget, widget_signals[STYLE_UPDATED], 0);
4473
4474       g_signal_emit (widget, widget_signals[REALIZE], 0);
4475
4476       gtk_widget_real_set_has_tooltip (widget,
4477                                        GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (widget), quark_has_tooltip)),
4478                                        TRUE);
4479
4480       if (priv->has_shape_mask)
4481         {
4482           region = g_object_get_qdata (G_OBJECT (widget), quark_shape_info);
4483           gdk_window_shape_combine_region (priv->window, region, 0, 0);
4484         }
4485
4486       region = g_object_get_qdata (G_OBJECT (widget), quark_input_shape_info);
4487       if (region)
4488         gdk_window_input_shape_combine_region (priv->window, region, 0, 0);
4489
4490       if (priv->multidevice)
4491         gdk_window_set_support_multidevice (priv->window, TRUE);
4492
4493       _gtk_widget_enable_device_events (widget);
4494       gtk_widget_update_devices_mask (widget, TRUE);
4495
4496       gtk_widget_pop_verify_invariants (widget);
4497     }
4498 }
4499
4500 /**
4501  * gtk_widget_unrealize:
4502  * @widget: a #GtkWidget
4503  *
4504  * This function is only useful in widget implementations.
4505  * Causes a widget to be unrealized (frees all GDK resources
4506  * associated with the widget, such as @widget->window).
4507  **/
4508 void
4509 gtk_widget_unrealize (GtkWidget *widget)
4510 {
4511   g_return_if_fail (GTK_IS_WIDGET (widget));
4512
4513   gtk_widget_push_verify_invariants (widget);
4514
4515   if (widget->priv->has_shape_mask)
4516     gtk_widget_shape_combine_region (widget, NULL);
4517
4518   if (g_object_get_qdata (G_OBJECT (widget), quark_input_shape_info))
4519     gtk_widget_input_shape_combine_region (widget, NULL);
4520
4521   if (gtk_widget_get_realized (widget))
4522     {
4523       g_object_ref (widget);
4524
4525       if (widget->priv->mapped)
4526         gtk_widget_unmap (widget);
4527
4528       g_signal_emit (widget, widget_signals[UNREALIZE], 0);
4529       g_assert (!widget->priv->mapped);
4530       gtk_widget_set_realized (widget, FALSE);
4531
4532       g_object_unref (widget);
4533     }
4534
4535   gtk_widget_pop_verify_invariants (widget);
4536 }
4537
4538 /*****************************************
4539  * Draw queueing.
4540  *****************************************/
4541
4542 /**
4543  * gtk_widget_queue_draw_region:
4544  * @widget: a #GtkWidget
4545  * @region: region to draw
4546  *
4547  * Invalidates the rectangular area of @widget defined by @region by
4548  * calling gdk_window_invalidate_region() on the widget's window and
4549  * all its child windows. Once the main loop becomes idle (after the
4550  * current batch of events has been processed, roughly), the window
4551  * will receive expose events for the union of all regions that have
4552  * been invalidated.
4553  *
4554  * Normally you would only use this function in widget
4555  * implementations. You might also use it to schedule a redraw of a
4556  * #GtkDrawingArea or some portion thereof.
4557  *
4558  * Since: 3.0
4559  **/
4560 void
4561 gtk_widget_queue_draw_region (GtkWidget            *widget,
4562                               const cairo_region_t *region)
4563 {
4564   GtkWidgetPrivate *priv;
4565   GtkWidget *w;
4566
4567   g_return_if_fail (GTK_IS_WIDGET (widget));
4568
4569   priv = widget->priv;
4570
4571   if (!gtk_widget_get_realized (widget))
4572     return;
4573
4574   /* Just return if the widget or one of its ancestors isn't mapped */
4575   for (w = widget; w != NULL; w = w->priv->parent)
4576     if (!gtk_widget_get_mapped (w))
4577       return;
4578
4579   gdk_window_invalidate_region (priv->window, region, TRUE);
4580 }
4581
4582 /**
4583  * gtk_widget_queue_draw_area:
4584  * @widget: a #GtkWidget
4585  * @x: x coordinate of upper-left corner of rectangle to redraw
4586  * @y: y coordinate of upper-left corner of rectangle to redraw
4587  * @width: width of region to draw
4588  * @height: height of region to draw
4589  *
4590  * Convenience function that calls gtk_widget_queue_draw_region() on
4591  * the region created from the given coordinates.
4592  *
4593  * The region here is specified in widget coordinates.
4594  * Widget coordinates are a bit odd; for historical reasons, they are
4595  * defined as @widget->window coordinates for widgets that are not
4596  * #GTK_NO_WINDOW widgets, and are relative to @widget->allocation.x,
4597  * @widget->allocation.y for widgets that are #GTK_NO_WINDOW widgets.
4598  */
4599 void
4600 gtk_widget_queue_draw_area (GtkWidget *widget,
4601                             gint       x,
4602                             gint       y,
4603                             gint       width,
4604                             gint       height)
4605 {
4606   GdkRectangle rect;
4607   cairo_region_t *region;
4608
4609   g_return_if_fail (GTK_IS_WIDGET (widget));
4610
4611   rect.x = x;
4612   rect.y = y;
4613   rect.width = width;
4614   rect.height = height;
4615
4616   region = cairo_region_create_rectangle (&rect);
4617   gtk_widget_queue_draw_region (widget, region);
4618   cairo_region_destroy (region);
4619 }
4620
4621 /**
4622  * gtk_widget_queue_draw:
4623  * @widget: a #GtkWidget
4624  *
4625  * Equivalent to calling gtk_widget_queue_draw_area() for the
4626  * entire area of a widget.
4627  **/
4628 void
4629 gtk_widget_queue_draw (GtkWidget *widget)
4630 {
4631   GdkRectangle rect;
4632
4633   g_return_if_fail (GTK_IS_WIDGET (widget));
4634
4635   gtk_widget_get_allocation (widget, &rect);
4636
4637   if (!gtk_widget_get_has_window (widget))
4638     gtk_widget_queue_draw_area (widget,
4639                                 rect.x, rect.y, rect.width, rect.height);
4640   else
4641     gtk_widget_queue_draw_area (widget,
4642                                 0, 0, rect.width, rect.height);
4643 }
4644
4645 /**
4646  * gtk_widget_queue_resize:
4647  * @widget: a #GtkWidget
4648  *
4649  * This function is only for use in widget implementations.
4650  * Flags a widget to have its size renegotiated; should
4651  * be called when a widget for some reason has a new size request.
4652  * For example, when you change the text in a #GtkLabel, #GtkLabel
4653  * queues a resize to ensure there's enough space for the new text.
4654  *
4655  * <note><para>You cannot call gtk_widget_queue_resize() on a widget
4656  * from inside its implementation of the GtkWidgetClass::size_allocate
4657  * virtual method. Calls to gtk_widget_queue_resize() from inside
4658  * GtkWidgetClass::size_allocate will be silently ignored.</para></note>
4659  **/
4660 void
4661 gtk_widget_queue_resize (GtkWidget *widget)
4662 {
4663   g_return_if_fail (GTK_IS_WIDGET (widget));
4664
4665   if (gtk_widget_get_realized (widget))
4666     gtk_widget_queue_draw (widget);
4667
4668   _gtk_size_group_queue_resize (widget, 0);
4669 }
4670
4671 /**
4672  * gtk_widget_queue_resize_no_redraw:
4673  * @widget: a #GtkWidget
4674  *
4675  * This function works like gtk_widget_queue_resize(),
4676  * except that the widget is not invalidated.
4677  *
4678  * Since: 2.4
4679  **/
4680 void
4681 gtk_widget_queue_resize_no_redraw (GtkWidget *widget)
4682 {
4683   g_return_if_fail (GTK_IS_WIDGET (widget));
4684
4685   _gtk_size_group_queue_resize (widget, 0);
4686 }
4687
4688 /**
4689  * gtk_widget_size_request:
4690  * @widget: a #GtkWidget
4691  * @requisition: (out): a #GtkRequisition to be filled in
4692  *
4693  * This function is typically used when implementing a #GtkContainer
4694  * subclass.  Obtains the preferred size of a widget. The container
4695  * uses this information to arrange its child widgets and decide what
4696  * size allocations to give them with gtk_widget_size_allocate().
4697  *
4698  * You can also call this function from an application, with some
4699  * caveats. Most notably, getting a size request requires the widget
4700  * to be associated with a screen, because font information may be
4701  * needed. Multihead-aware applications should keep this in mind.
4702  *
4703  * Also remember that the size request is not necessarily the size
4704  * a widget will actually be allocated.
4705  *
4706  * Deprecated: 3.0: Use gtk_widget_get_preferred_size() instead.
4707  **/
4708 void
4709 gtk_widget_size_request (GtkWidget      *widget,
4710                          GtkRequisition *requisition)
4711 {
4712   g_return_if_fail (GTK_IS_WIDGET (widget));
4713
4714   gtk_widget_get_preferred_size (widget, requisition, NULL);
4715 }
4716
4717 /**
4718  * gtk_widget_get_child_requisition:
4719  * @widget: a #GtkWidget
4720  * @requisition: (out): a #GtkRequisition to be filled in
4721  *
4722  * This function is only for use in widget implementations. Obtains
4723  * @widget->requisition, unless someone has forced a particular
4724  * geometry on the widget (e.g. with gtk_widget_set_size_request()),
4725  * in which case it returns that geometry instead of the widget's
4726  * requisition.
4727  *
4728  * This function differs from gtk_widget_size_request() in that
4729  * it retrieves the last size request value from @widget->requisition,
4730  * while gtk_widget_size_request() actually calls the "size_request" method
4731  * on @widget to compute the size request and fill in @widget->requisition,
4732  * and only then returns @widget->requisition.
4733  *
4734  * Because this function does not call the "size_request" method, it
4735  * can only be used when you know that @widget->requisition is
4736  * up-to-date, that is, gtk_widget_size_request() has been called
4737  * since the last time a resize was queued. In general, only container
4738  * implementations have this information; applications should use
4739  * gtk_widget_size_request().
4740  *
4741  *
4742  * Deprecated: 3.0: Use gtk_widget_get_preferred_size() instead.
4743  **/
4744 void
4745 gtk_widget_get_child_requisition (GtkWidget      *widget,
4746                                   GtkRequisition *requisition)
4747 {
4748   gtk_widget_get_preferred_size (widget, requisition, NULL);
4749 }
4750
4751 static gboolean
4752 invalidate_predicate (GdkWindow *window,
4753                       gpointer   data)
4754 {
4755   gpointer user_data;
4756
4757   gdk_window_get_user_data (window, &user_data);
4758
4759   return (user_data == data);
4760 }
4761
4762 /* Invalidate @region in widget->window and all children
4763  * of widget->window owned by widget. @region is in the
4764  * same coordinates as widget->allocation and will be
4765  * modified by this call.
4766  */
4767 static void
4768 gtk_widget_invalidate_widget_windows (GtkWidget *widget,
4769                                       cairo_region_t *region)
4770 {
4771   GtkWidgetPrivate *priv = widget->priv;
4772
4773   if (!gtk_widget_get_realized (widget))
4774     return;
4775
4776   if (gtk_widget_get_has_window (widget) && priv->parent)
4777     {
4778       int x, y;
4779
4780       gdk_window_get_position (priv->window, &x, &y);
4781       cairo_region_translate (region, -x, -y);
4782     }
4783
4784   gdk_window_invalidate_maybe_recurse (priv->window, region,
4785                                        invalidate_predicate, widget);
4786 }
4787
4788 /**
4789  * gtk_widget_size_allocate:
4790  * @widget: a #GtkWidget
4791  * @allocation: position and size to be allocated to @widget
4792  *
4793  * This function is only used by #GtkContainer subclasses, to assign a size
4794  * and position to their child widgets.
4795  *
4796  * In this function, the allocation may be adjusted. It will be forced
4797  * to a 1x1 minimum size, and the adjust_size_allocation virtual
4798  * method on the child will be used to adjust the allocation. Standard
4799  * adjustments include removing the widget's margins, and applying the
4800  * widget's #GtkWidget:halign and #GtkWidget:valign properties.
4801  **/
4802 void
4803 gtk_widget_size_allocate (GtkWidget     *widget,
4804                           GtkAllocation *allocation)
4805 {
4806   GtkWidgetPrivate *priv;
4807   GdkRectangle real_allocation;
4808   GdkRectangle old_allocation;
4809   GdkRectangle adjusted_allocation;
4810   gboolean alloc_needed;
4811   gboolean size_changed;
4812   gboolean position_changed;
4813   gint natural_width, natural_height, dummy;
4814   gint min_width, min_height;
4815
4816   priv = widget->priv;
4817
4818   g_return_if_fail (GTK_IS_WIDGET (widget));
4819
4820   gtk_widget_push_verify_invariants (widget);
4821
4822 #ifdef G_ENABLE_DEBUG
4823   if (gtk_get_debug_flags () & GTK_DEBUG_GEOMETRY)
4824     {
4825       gint depth;
4826       GtkWidget *parent;
4827       const gchar *name;
4828
4829       depth = 0;
4830       parent = widget;
4831       while (parent)
4832         {
4833           depth++;
4834           parent = gtk_widget_get_parent (parent);
4835         }
4836
4837       name = g_type_name (G_OBJECT_TYPE (G_OBJECT (widget)));
4838       g_print ("gtk_widget_size_allocate: %*s%s %d %d\n",
4839                2 * depth, " ", name,
4840                allocation->width, allocation->height);
4841     }
4842 #endif /* G_ENABLE_DEBUG */
4843
4844   alloc_needed = priv->alloc_needed;
4845   /* Preserve request/allocate ordering */
4846   priv->alloc_needed = FALSE;
4847
4848   old_allocation = priv->allocation;
4849   real_allocation = *allocation;
4850
4851   adjusted_allocation = real_allocation;
4852   if (gtk_widget_get_request_mode (widget) == GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH)
4853     {
4854       /* Go ahead and request the height for allocated width, note that the internals
4855        * of get_height_for_width will internally limit the for_size to natural size
4856        * when aligning implicitly.
4857        */
4858       gtk_widget_get_preferred_width (widget, &min_width, &natural_width);
4859       gtk_widget_get_preferred_height_for_width (widget, real_allocation.width, &min_height, &natural_height);
4860     }
4861   else
4862     {
4863       /* Go ahead and request the width for allocated height, note that the internals
4864        * of get_width_for_height will internally limit the for_size to natural size
4865        * when aligning implicitly.
4866        */
4867       gtk_widget_get_preferred_height (widget, &min_height, &natural_height);
4868       gtk_widget_get_preferred_width_for_height (widget, real_allocation.height, &min_width, &natural_width);
4869     }
4870
4871 #ifdef G_ENABLE_DEBUG
4872   if (gtk_get_debug_flags () & GTK_DEBUG_GEOMETRY)
4873     {
4874       if ((min_width > real_allocation.width || min_height > real_allocation.height) &&
4875           !GTK_IS_SCROLLABLE (widget))
4876         g_warning ("gtk_widget_size_allocate(): attempt to underallocate %s%s %s %p. "
4877                    "Allocation is %dx%d, but minimum required size is %dx%d.",
4878                    priv->parent ? G_OBJECT_TYPE_NAME (priv->parent) : "", priv->parent ? "'s child" : "toplevel",
4879                    G_OBJECT_TYPE_NAME (widget), widget,
4880                    real_allocation.width, real_allocation.height,
4881                    min_width, min_height);
4882     }
4883 #endif
4884   /* Now that we have the right natural height and width, go ahead and remove any margins from the
4885    * allocated sizes and possibly limit them to the natural sizes */
4886   GTK_WIDGET_GET_CLASS (widget)->adjust_size_allocation (widget,
4887                                                          GTK_ORIENTATION_HORIZONTAL,
4888                                                          &dummy,
4889                                                          &natural_width,
4890                                                          &adjusted_allocation.x,
4891                                                          &adjusted_allocation.width);
4892   GTK_WIDGET_GET_CLASS (widget)->adjust_size_allocation (widget,
4893                                                          GTK_ORIENTATION_VERTICAL,
4894                                                          &dummy,
4895                                                          &natural_height,
4896                                                          &adjusted_allocation.y,
4897                                                          &adjusted_allocation.height);
4898
4899   if (adjusted_allocation.x < real_allocation.x ||
4900       adjusted_allocation.y < real_allocation.y ||
4901       (adjusted_allocation.x + adjusted_allocation.width) >
4902       (real_allocation.x + real_allocation.width) ||
4903       (adjusted_allocation.y + adjusted_allocation.height >
4904        real_allocation.y + real_allocation.height))
4905     {
4906       g_warning ("%s %p attempted to adjust its size allocation from %d,%d %dx%d to %d,%d %dx%d. adjust_size_allocation must keep allocation inside original bounds",
4907                  G_OBJECT_TYPE_NAME (widget), widget,
4908                  real_allocation.x, real_allocation.y, real_allocation.width, real_allocation.height,
4909                  adjusted_allocation.x, adjusted_allocation.y, adjusted_allocation.width, adjusted_allocation.height);
4910       adjusted_allocation = real_allocation; /* veto it */
4911     }
4912   else
4913     {
4914       real_allocation = adjusted_allocation;
4915     }
4916
4917   if (real_allocation.width < 0 || real_allocation.height < 0)
4918     {
4919       g_warning ("gtk_widget_size_allocate(): attempt to allocate widget with width %d and height %d",
4920                  real_allocation.width,
4921                  real_allocation.height);
4922     }
4923
4924   real_allocation.width = MAX (real_allocation.width, 1);
4925   real_allocation.height = MAX (real_allocation.height, 1);
4926
4927   size_changed = (old_allocation.width != real_allocation.width ||
4928                   old_allocation.height != real_allocation.height);
4929   position_changed = (old_allocation.x != real_allocation.x ||
4930                       old_allocation.y != real_allocation.y);
4931
4932   if (!alloc_needed && !size_changed && !position_changed)
4933     goto out;
4934
4935   g_signal_emit (widget, widget_signals[SIZE_ALLOCATE], 0, &real_allocation);
4936
4937   /* Size allocation is god... after consulting god, no further requests or allocations are needed */
4938   priv->alloc_needed = FALSE;
4939
4940   if (gtk_widget_get_mapped (widget))
4941     {
4942       if (!gtk_widget_get_has_window (widget) && priv->redraw_on_alloc && position_changed)
4943         {
4944           /* Invalidate union(old_allaction,priv->allocation) in priv->window
4945            */
4946           cairo_region_t *invalidate = cairo_region_create_rectangle (&priv->allocation);
4947           cairo_region_union_rectangle (invalidate, &old_allocation);
4948
4949           gdk_window_invalidate_region (priv->window, invalidate, FALSE);
4950           cairo_region_destroy (invalidate);
4951         }
4952
4953       if (size_changed)
4954         {
4955           if (priv->redraw_on_alloc)
4956             {
4957               /* Invalidate union(old_allaction,priv->allocation) in priv->window and descendents owned by widget
4958                */
4959               cairo_region_t *invalidate = cairo_region_create_rectangle (&priv->allocation);
4960               cairo_region_union_rectangle (invalidate, &old_allocation);
4961
4962               gtk_widget_invalidate_widget_windows (widget, invalidate);
4963               cairo_region_destroy (invalidate);
4964             }
4965         }
4966     }
4967
4968   if ((size_changed || position_changed) && priv->parent &&
4969       gtk_widget_get_realized (priv->parent) && _gtk_container_get_reallocate_redraws (GTK_CONTAINER (priv->parent)))
4970     {
4971       cairo_region_t *invalidate = cairo_region_create_rectangle (&priv->parent->priv->allocation);
4972       gtk_widget_invalidate_widget_windows (priv->parent, invalidate);
4973       cairo_region_destroy (invalidate);
4974     }
4975
4976 out:
4977   gtk_widget_pop_verify_invariants (widget);
4978 }
4979
4980 /**
4981  * gtk_widget_common_ancestor:
4982  * @widget_a: a #GtkWidget
4983  * @widget_b: a #GtkWidget
4984  *
4985  * Find the common ancestor of @widget_a and @widget_b that
4986  * is closest to the two widgets.
4987  *
4988  * Return value: the closest common ancestor of @widget_a and
4989  *   @widget_b or %NULL if @widget_a and @widget_b do not
4990  *   share a common ancestor.
4991  **/
4992 static GtkWidget *
4993 gtk_widget_common_ancestor (GtkWidget *widget_a,
4994                             GtkWidget *widget_b)
4995 {
4996   GtkWidget *parent_a;
4997   GtkWidget *parent_b;
4998   gint depth_a = 0;
4999   gint depth_b = 0;
5000
5001   parent_a = widget_a;
5002   while (parent_a->priv->parent)
5003     {
5004       parent_a = parent_a->priv->parent;
5005       depth_a++;
5006     }
5007
5008   parent_b = widget_b;
5009   while (parent_b->priv->parent)
5010     {
5011       parent_b = parent_b->priv->parent;
5012       depth_b++;
5013     }
5014
5015   if (parent_a != parent_b)
5016     return NULL;
5017
5018   while (depth_a > depth_b)
5019     {
5020       widget_a = widget_a->priv->parent;
5021       depth_a--;
5022     }
5023
5024   while (depth_b > depth_a)
5025     {
5026       widget_b = widget_b->priv->parent;
5027       depth_b--;
5028     }
5029
5030   while (widget_a != widget_b)
5031     {
5032       widget_a = widget_a->priv->parent;
5033       widget_b = widget_b->priv->parent;
5034     }
5035
5036   return widget_a;
5037 }
5038
5039 /**
5040  * gtk_widget_translate_coordinates:
5041  * @src_widget:  a #GtkWidget
5042  * @dest_widget: a #GtkWidget
5043  * @src_x: X position relative to @src_widget
5044  * @src_y: Y position relative to @src_widget
5045  * @dest_x: (out): location to store X position relative to @dest_widget
5046  * @dest_y: (out): location to store Y position relative to @dest_widget
5047  *
5048  * Translate coordinates relative to @src_widget's allocation to coordinates
5049  * relative to @dest_widget's allocations. In order to perform this
5050  * operation, both widgets must be realized, and must share a common
5051  * toplevel.
5052  *
5053  * Return value: %FALSE if either widget was not realized, or there
5054  *   was no common ancestor. In this case, nothing is stored in
5055  *   *@dest_x and *@dest_y. Otherwise %TRUE.
5056  **/
5057 gboolean
5058 gtk_widget_translate_coordinates (GtkWidget  *src_widget,
5059                                   GtkWidget  *dest_widget,
5060                                   gint        src_x,
5061                                   gint        src_y,
5062                                   gint       *dest_x,
5063                                   gint       *dest_y)
5064 {
5065   GtkWidgetPrivate *src_priv = src_widget->priv;
5066   GtkWidgetPrivate *dest_priv = dest_widget->priv;
5067   GtkWidget *ancestor;
5068   GdkWindow *window;
5069   GList *dest_list = NULL;
5070
5071   g_return_val_if_fail (GTK_IS_WIDGET (src_widget), FALSE);
5072   g_return_val_if_fail (GTK_IS_WIDGET (dest_widget), FALSE);
5073
5074   ancestor = gtk_widget_common_ancestor (src_widget, dest_widget);
5075   if (!ancestor || !gtk_widget_get_realized (src_widget) || !gtk_widget_get_realized (dest_widget))
5076     return FALSE;
5077
5078   /* Translate from allocation relative to window relative */
5079   if (gtk_widget_get_has_window (src_widget) && src_priv->parent)
5080     {
5081       gint wx, wy;
5082       gdk_window_get_position (src_priv->window, &wx, &wy);
5083
5084       src_x -= wx - src_priv->allocation.x;
5085       src_y -= wy - src_priv->allocation.y;
5086     }
5087   else
5088     {
5089       src_x += src_priv->allocation.x;
5090       src_y += src_priv->allocation.y;
5091     }
5092
5093   /* Translate to the common ancestor */
5094   window = src_priv->window;
5095   while (window != ancestor->priv->window)
5096     {
5097       gdouble dx, dy;
5098
5099       gdk_window_coords_to_parent (window, src_x, src_y, &dx, &dy);
5100
5101       src_x = dx;
5102       src_y = dy;
5103
5104       window = gdk_window_get_effective_parent (window);
5105
5106       if (!window)              /* Handle GtkHandleBox */
5107         return FALSE;
5108     }
5109
5110   /* And back */
5111   window = dest_priv->window;
5112   while (window != ancestor->priv->window)
5113     {
5114       dest_list = g_list_prepend (dest_list, window);
5115
5116       window = gdk_window_get_effective_parent (window);
5117
5118       if (!window)              /* Handle GtkHandleBox */
5119         {
5120           g_list_free (dest_list);
5121           return FALSE;
5122         }
5123     }
5124
5125   while (dest_list)
5126     {
5127       gdouble dx, dy;
5128
5129       gdk_window_coords_from_parent (dest_list->data, src_x, src_y, &dx, &dy);
5130
5131       src_x = dx;
5132       src_y = dy;
5133
5134       dest_list = g_list_remove (dest_list, dest_list->data);
5135     }
5136
5137   /* Translate from window relative to allocation relative */
5138   if (gtk_widget_get_has_window (dest_widget) && dest_priv->parent)
5139     {
5140       gint wx, wy;
5141       gdk_window_get_position (dest_priv->window, &wx, &wy);
5142
5143       src_x += wx - dest_priv->allocation.x;
5144       src_y += wy - dest_priv->allocation.y;
5145     }
5146   else
5147     {
5148       src_x -= dest_priv->allocation.x;
5149       src_y -= dest_priv->allocation.y;
5150     }
5151
5152   if (dest_x)
5153     *dest_x = src_x;
5154   if (dest_y)
5155     *dest_y = src_y;
5156
5157   return TRUE;
5158 }
5159
5160 static void
5161 gtk_widget_real_size_allocate (GtkWidget     *widget,
5162                                GtkAllocation *allocation)
5163 {
5164   GtkWidgetPrivate *priv = widget->priv;
5165
5166   priv->allocation = *allocation;
5167
5168   if (gtk_widget_get_realized (widget) &&
5169       gtk_widget_get_has_window (widget))
5170      {
5171         gdk_window_move_resize (priv->window,
5172                                 allocation->x, allocation->y,
5173                                 allocation->width, allocation->height);
5174      }
5175 }
5176
5177 /* translate initial/final into start/end */
5178 static GtkAlign
5179 effective_align (GtkAlign         align,
5180                  GtkTextDirection direction)
5181 {
5182   switch (align)
5183     {
5184     case GTK_ALIGN_START:
5185       return direction == GTK_TEXT_DIR_RTL ? GTK_ALIGN_END : GTK_ALIGN_START;
5186     case GTK_ALIGN_END:
5187       return direction == GTK_TEXT_DIR_RTL ? GTK_ALIGN_START : GTK_ALIGN_END;
5188     default:
5189       return align;
5190     }
5191 }
5192
5193 static void
5194 adjust_for_align (GtkAlign  align,
5195                   gint     *natural_size,
5196                   gint     *allocated_pos,
5197                   gint     *allocated_size)
5198 {
5199   switch (align)
5200     {
5201     case GTK_ALIGN_FILL:
5202       /* change nothing */
5203       break;
5204     case GTK_ALIGN_START:
5205       /* keep *allocated_pos where it is */
5206       *allocated_size = MIN (*allocated_size, *natural_size);
5207       break;
5208     case GTK_ALIGN_END:
5209       if (*allocated_size > *natural_size)
5210         {
5211           *allocated_pos += (*allocated_size - *natural_size);
5212           *allocated_size = *natural_size;
5213         }
5214       break;
5215     case GTK_ALIGN_CENTER:
5216       if (*allocated_size > *natural_size)
5217         {
5218           *allocated_pos += (*allocated_size - *natural_size) / 2;
5219           *allocated_size = MIN (*allocated_size, *natural_size);
5220         }
5221       break;
5222     }
5223 }
5224
5225 static void
5226 adjust_for_margin(gint               start_margin,
5227                   gint               end_margin,
5228                   gint              *minimum_size,
5229                   gint              *natural_size,
5230                   gint              *allocated_pos,
5231                   gint              *allocated_size)
5232 {
5233   *minimum_size -= (start_margin + end_margin);
5234   *natural_size -= (start_margin + end_margin);
5235   *allocated_pos += start_margin;
5236   *allocated_size -= (start_margin + end_margin);
5237 }
5238
5239 static void
5240 gtk_widget_real_adjust_size_allocation (GtkWidget         *widget,
5241                                         GtkOrientation     orientation,
5242                                         gint              *minimum_size,
5243                                         gint              *natural_size,
5244                                         gint              *allocated_pos,
5245                                         gint              *allocated_size)
5246 {
5247   const GtkWidgetAuxInfo *aux_info;
5248
5249   aux_info = _gtk_widget_get_aux_info_or_defaults (widget);
5250
5251   if (orientation == GTK_ORIENTATION_HORIZONTAL)
5252     {
5253       adjust_for_margin (aux_info->margin.left,
5254                          aux_info->margin.right,
5255                          minimum_size, natural_size,
5256                          allocated_pos, allocated_size);
5257       adjust_for_align (effective_align (aux_info->halign, gtk_widget_get_direction (widget)),
5258                         natural_size, allocated_pos, allocated_size);
5259     }
5260   else
5261     {
5262       adjust_for_margin (aux_info->margin.top,
5263                          aux_info->margin.bottom,
5264                          minimum_size, natural_size,
5265                          allocated_pos, allocated_size);
5266       adjust_for_align (effective_align (aux_info->valign, GTK_TEXT_DIR_NONE),
5267                         natural_size, allocated_pos, allocated_size);
5268     }
5269 }
5270
5271 static gboolean
5272 gtk_widget_real_can_activate_accel (GtkWidget *widget,
5273                                     guint      signal_id)
5274 {
5275   GtkWidgetPrivate *priv = widget->priv;
5276
5277   /* widgets must be onscreen for accels to take effect */
5278   return gtk_widget_is_sensitive (widget) &&
5279          gtk_widget_is_drawable (widget) &&
5280          gdk_window_is_viewable (priv->window);
5281 }
5282
5283 /**
5284  * gtk_widget_can_activate_accel:
5285  * @widget: a #GtkWidget
5286  * @signal_id: the ID of a signal installed on @widget
5287  *
5288  * Determines whether an accelerator that activates the signal
5289  * identified by @signal_id can currently be activated.
5290  * This is done by emitting the #GtkWidget::can-activate-accel
5291  * signal on @widget; if the signal isn't overridden by a
5292  * handler or in a derived widget, then the default check is
5293  * that the widget must be sensitive, and the widget and all
5294  * its ancestors mapped.
5295  *
5296  * Return value: %TRUE if the accelerator can be activated.
5297  *
5298  * Since: 2.4
5299  **/
5300 gboolean
5301 gtk_widget_can_activate_accel (GtkWidget *widget,
5302                                guint      signal_id)
5303 {
5304   gboolean can_activate = FALSE;
5305   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5306   g_signal_emit (widget, widget_signals[CAN_ACTIVATE_ACCEL], 0, signal_id, &can_activate);
5307   return can_activate;
5308 }
5309
5310 typedef struct {
5311   GClosure   closure;
5312   guint      signal_id;
5313 } AccelClosure;
5314
5315 static void
5316 closure_accel_activate (GClosure     *closure,
5317                         GValue       *return_value,
5318                         guint         n_param_values,
5319                         const GValue *param_values,
5320                         gpointer      invocation_hint,
5321                         gpointer      marshal_data)
5322 {
5323   AccelClosure *aclosure = (AccelClosure*) closure;
5324   gboolean can_activate = gtk_widget_can_activate_accel (closure->data, aclosure->signal_id);
5325
5326   if (can_activate)
5327     g_signal_emit (closure->data, aclosure->signal_id, 0);
5328
5329   /* whether accelerator was handled */
5330   g_value_set_boolean (return_value, can_activate);
5331 }
5332
5333 static void
5334 closures_destroy (gpointer data)
5335 {
5336   GSList *slist, *closures = data;
5337
5338   for (slist = closures; slist; slist = slist->next)
5339     {
5340       g_closure_invalidate (slist->data);
5341       g_closure_unref (slist->data);
5342     }
5343   g_slist_free (closures);
5344 }
5345
5346 static GClosure*
5347 widget_new_accel_closure (GtkWidget *widget,
5348                           guint      signal_id)
5349 {
5350   AccelClosure *aclosure;
5351   GClosure *closure = NULL;
5352   GSList *slist, *closures;
5353
5354   closures = g_object_steal_qdata (G_OBJECT (widget), quark_accel_closures);
5355   for (slist = closures; slist; slist = slist->next)
5356     if (!gtk_accel_group_from_accel_closure (slist->data))
5357       {
5358         /* reuse this closure */
5359         closure = slist->data;
5360         break;
5361       }
5362   if (!closure)
5363     {
5364       closure = g_closure_new_object (sizeof (AccelClosure), G_OBJECT (widget));
5365       closures = g_slist_prepend (closures, g_closure_ref (closure));
5366       g_closure_sink (closure);
5367       g_closure_set_marshal (closure, closure_accel_activate);
5368     }
5369   g_object_set_qdata_full (G_OBJECT (widget), quark_accel_closures, closures, closures_destroy);
5370
5371   aclosure = (AccelClosure*) closure;
5372   g_assert (closure->data == widget);
5373   g_assert (closure->marshal == closure_accel_activate);
5374   aclosure->signal_id = signal_id;
5375
5376   return closure;
5377 }
5378
5379 /**
5380  * gtk_widget_add_accelerator:
5381  * @widget:       widget to install an accelerator on
5382  * @accel_signal: widget signal to emit on accelerator activation
5383  * @accel_group:  accel group for this widget, added to its toplevel
5384  * @accel_key:    GDK keyval of the accelerator
5385  * @accel_mods:   modifier key combination of the accelerator
5386  * @accel_flags:  flag accelerators, e.g. %GTK_ACCEL_VISIBLE
5387  *
5388  * Installs an accelerator for this @widget in @accel_group that causes
5389  * @accel_signal to be emitted if the accelerator is activated.
5390  * The @accel_group needs to be added to the widget's toplevel via
5391  * gtk_window_add_accel_group(), and the signal must be of type %G_SIGNAL_ACTION.
5392  * Accelerators added through this function are not user changeable during
5393  * runtime. If you want to support accelerators that can be changed by the
5394  * user, use gtk_accel_map_add_entry() and gtk_widget_set_accel_path() or
5395  * gtk_menu_item_set_accel_path() instead.
5396  */
5397 void
5398 gtk_widget_add_accelerator (GtkWidget      *widget,
5399                             const gchar    *accel_signal,
5400                             GtkAccelGroup  *accel_group,
5401                             guint           accel_key,
5402                             GdkModifierType accel_mods,
5403                             GtkAccelFlags   accel_flags)
5404 {
5405   GClosure *closure;
5406   GSignalQuery query;
5407
5408   g_return_if_fail (GTK_IS_WIDGET (widget));
5409   g_return_if_fail (accel_signal != NULL);
5410   g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
5411
5412   g_signal_query (g_signal_lookup (accel_signal, G_OBJECT_TYPE (widget)), &query);
5413   if (!query.signal_id ||
5414       !(query.signal_flags & G_SIGNAL_ACTION) ||
5415       query.return_type != G_TYPE_NONE ||
5416       query.n_params)
5417     {
5418       /* hmm, should be elaborate enough */
5419       g_warning (G_STRLOC ": widget `%s' has no activatable signal \"%s\" without arguments",
5420                  G_OBJECT_TYPE_NAME (widget), accel_signal);
5421       return;
5422     }
5423
5424   closure = widget_new_accel_closure (widget, query.signal_id);
5425
5426   g_object_ref (widget);
5427
5428   /* install the accelerator. since we don't map this onto an accel_path,
5429    * the accelerator will automatically be locked.
5430    */
5431   gtk_accel_group_connect (accel_group,
5432                            accel_key,
5433                            accel_mods,
5434                            accel_flags | GTK_ACCEL_LOCKED,
5435                            closure);
5436
5437   g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
5438
5439   g_object_unref (widget);
5440 }
5441
5442 /**
5443  * gtk_widget_remove_accelerator:
5444  * @widget:       widget to install an accelerator on
5445  * @accel_group:  accel group for this widget
5446  * @accel_key:    GDK keyval of the accelerator
5447  * @accel_mods:   modifier key combination of the accelerator
5448  *
5449  * Removes an accelerator from @widget, previously installed with
5450  * gtk_widget_add_accelerator().
5451  *
5452  * Returns: whether an accelerator was installed and could be removed
5453  */
5454 gboolean
5455 gtk_widget_remove_accelerator (GtkWidget      *widget,
5456                                GtkAccelGroup  *accel_group,
5457                                guint           accel_key,
5458                                GdkModifierType accel_mods)
5459 {
5460   GtkAccelGroupEntry *ag_entry;
5461   GList *slist, *clist;
5462   guint n;
5463
5464   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5465   g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE);
5466
5467   ag_entry = gtk_accel_group_query (accel_group, accel_key, accel_mods, &n);
5468   clist = gtk_widget_list_accel_closures (widget);
5469   for (slist = clist; slist; slist = slist->next)
5470     {
5471       guint i;
5472
5473       for (i = 0; i < n; i++)
5474         if (slist->data == (gpointer) ag_entry[i].closure)
5475           {
5476             gboolean is_removed = gtk_accel_group_disconnect (accel_group, slist->data);
5477
5478             g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
5479
5480             g_list_free (clist);
5481
5482             return is_removed;
5483           }
5484     }
5485   g_list_free (clist);
5486
5487   g_warning (G_STRLOC ": no accelerator (%u,%u) installed in accel group (%p) for %s (%p)",
5488              accel_key, accel_mods, accel_group,
5489              G_OBJECT_TYPE_NAME (widget), widget);
5490
5491   return FALSE;
5492 }
5493
5494 /**
5495  * gtk_widget_list_accel_closures:
5496  * @widget:  widget to list accelerator closures for
5497  *
5498  * Lists the closures used by @widget for accelerator group connections
5499  * with gtk_accel_group_connect_by_path() or gtk_accel_group_connect().
5500  * The closures can be used to monitor accelerator changes on @widget,
5501  * by connecting to the @GtkAccelGroup::accel-changed signal of the
5502  * #GtkAccelGroup of a closure which can be found out with
5503  * gtk_accel_group_from_accel_closure().
5504  *
5505  * Return value: (transfer container) (element-type GClosure):
5506  *     a newly allocated #GList of closures
5507  */
5508 GList*
5509 gtk_widget_list_accel_closures (GtkWidget *widget)
5510 {
5511   GSList *slist;
5512   GList *clist = NULL;
5513
5514   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5515
5516   for (slist = g_object_get_qdata (G_OBJECT (widget), quark_accel_closures); slist; slist = slist->next)
5517     if (gtk_accel_group_from_accel_closure (slist->data))
5518       clist = g_list_prepend (clist, slist->data);
5519   return clist;
5520 }
5521
5522 typedef struct {
5523   GQuark         path_quark;
5524   GtkAccelGroup *accel_group;
5525   GClosure      *closure;
5526 } AccelPath;
5527
5528 static void
5529 destroy_accel_path (gpointer data)
5530 {
5531   AccelPath *apath = data;
5532
5533   gtk_accel_group_disconnect (apath->accel_group, apath->closure);
5534
5535   /* closures_destroy takes care of unrefing the closure */
5536   g_object_unref (apath->accel_group);
5537
5538   g_slice_free (AccelPath, apath);
5539 }
5540
5541
5542 /**
5543  * gtk_widget_set_accel_path:
5544  * @widget: a #GtkWidget
5545  * @accel_path: (allow-none): path used to look up the accelerator
5546  * @accel_group: (allow-none): a #GtkAccelGroup.
5547  *
5548  * Given an accelerator group, @accel_group, and an accelerator path,
5549  * @accel_path, sets up an accelerator in @accel_group so whenever the
5550  * key binding that is defined for @accel_path is pressed, @widget
5551  * will be activated.  This removes any accelerators (for any
5552  * accelerator group) installed by previous calls to
5553  * gtk_widget_set_accel_path(). Associating accelerators with
5554  * paths allows them to be modified by the user and the modifications
5555  * to be saved for future use. (See gtk_accel_map_save().)
5556  *
5557  * This function is a low level function that would most likely
5558  * be used by a menu creation system like #GtkUIManager. If you
5559  * use #GtkUIManager, setting up accelerator paths will be done
5560  * automatically.
5561  *
5562  * Even when you you aren't using #GtkUIManager, if you only want to
5563  * set up accelerators on menu items gtk_menu_item_set_accel_path()
5564  * provides a somewhat more convenient interface.
5565  *
5566  * Note that @accel_path string will be stored in a #GQuark. Therefore, if you
5567  * pass a static string, you can save some memory by interning it first with
5568  * g_intern_static_string().
5569  **/
5570 void
5571 gtk_widget_set_accel_path (GtkWidget     *widget,
5572                            const gchar   *accel_path,
5573                            GtkAccelGroup *accel_group)
5574 {
5575   AccelPath *apath;
5576
5577   g_return_if_fail (GTK_IS_WIDGET (widget));
5578   g_return_if_fail (GTK_WIDGET_GET_CLASS (widget)->activate_signal != 0);
5579
5580   if (accel_path)
5581     {
5582       g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
5583       g_return_if_fail (_gtk_accel_path_is_valid (accel_path));
5584
5585       gtk_accel_map_add_entry (accel_path, 0, 0);
5586       apath = g_slice_new (AccelPath);
5587       apath->accel_group = g_object_ref (accel_group);
5588       apath->path_quark = g_quark_from_string (accel_path);
5589       apath->closure = widget_new_accel_closure (widget, GTK_WIDGET_GET_CLASS (widget)->activate_signal);
5590     }
5591   else
5592     apath = NULL;
5593
5594   /* also removes possible old settings */
5595   g_object_set_qdata_full (G_OBJECT (widget), quark_accel_path, apath, destroy_accel_path);
5596
5597   if (apath)
5598     gtk_accel_group_connect_by_path (apath->accel_group, g_quark_to_string (apath->path_quark), apath->closure);
5599
5600   g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
5601 }
5602
5603 const gchar*
5604 _gtk_widget_get_accel_path (GtkWidget *widget,
5605                             gboolean  *locked)
5606 {
5607   AccelPath *apath;
5608
5609   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5610
5611   apath = g_object_get_qdata (G_OBJECT (widget), quark_accel_path);
5612   if (locked)
5613     *locked = apath ? gtk_accel_group_get_is_locked (apath->accel_group) : TRUE;
5614   return apath ? g_quark_to_string (apath->path_quark) : NULL;
5615 }
5616
5617 /**
5618  * gtk_widget_mnemonic_activate:
5619  * @widget: a #GtkWidget
5620  * @group_cycling:  %TRUE if there are other widgets with the same mnemonic
5621  *
5622  * Emits the #GtkWidget::mnemonic-activate signal.
5623  *
5624  * The default handler for this signal activates the @widget if
5625  * @group_cycling is %FALSE, and just grabs the focus if @group_cycling
5626  * is %TRUE.
5627  *
5628  * Returns: %TRUE if the signal has been handled
5629  */
5630 gboolean
5631 gtk_widget_mnemonic_activate (GtkWidget *widget,
5632                               gboolean   group_cycling)
5633 {
5634   gboolean handled;
5635
5636   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5637
5638   group_cycling = group_cycling != FALSE;
5639   if (!gtk_widget_is_sensitive (widget))
5640     handled = TRUE;
5641   else
5642     g_signal_emit (widget,
5643                    widget_signals[MNEMONIC_ACTIVATE],
5644                    0,
5645                    group_cycling,
5646                    &handled);
5647   return handled;
5648 }
5649
5650 static gboolean
5651 gtk_widget_real_mnemonic_activate (GtkWidget *widget,
5652                                    gboolean   group_cycling)
5653 {
5654   if (!group_cycling && GTK_WIDGET_GET_CLASS (widget)->activate_signal)
5655     gtk_widget_activate (widget);
5656   else if (gtk_widget_get_can_focus (widget))
5657     gtk_widget_grab_focus (widget);
5658   else
5659     {
5660       g_warning ("widget `%s' isn't suitable for mnemonic activation",
5661                  G_OBJECT_TYPE_NAME (widget));
5662       gtk_widget_error_bell (widget);
5663     }
5664   return TRUE;
5665 }
5666
5667 static const cairo_user_data_key_t event_key;
5668
5669 GdkEventExpose *
5670 _gtk_cairo_get_event (cairo_t *cr)
5671 {
5672   g_return_val_if_fail (cr != NULL, NULL);
5673
5674   return cairo_get_user_data (cr, &event_key);
5675 }
5676
5677 static void
5678 gtk_cairo_set_event (cairo_t        *cr,
5679                      GdkEventExpose *event)
5680 {
5681   cairo_set_user_data (cr, &event_key, event, NULL);
5682 }
5683
5684 /**
5685  * gtk_cairo_should_draw_window:
5686  * @cr: a cairo context
5687  * @window: the window to check. @window may not be an input-only
5688  *          window.
5689  *
5690  * This function is supposed to be called in #GtkWidget::draw
5691  * implementations for widgets that support multiple windows.
5692  * @cr must be untransformed from invoking of the draw function.
5693  * This function will return %TRUE if the contents of the given
5694  * @window are supposed to be drawn and %FALSE otherwise. Note
5695  * that when the drawing was not initiated by the windowing
5696  * system this function will return %TRUE for all windows, so
5697  * you need to draw the bottommost window first. Also, do not
5698  * use "else if" statements to check which window should be drawn.
5699  *
5700  * Returns: %TRUE if @window should be drawn
5701  *
5702  * Since: 3.0
5703  **/
5704 gboolean
5705 gtk_cairo_should_draw_window (cairo_t *cr,
5706                               GdkWindow *window)
5707 {
5708   GdkEventExpose *event;
5709
5710   g_return_val_if_fail (cr != NULL, FALSE);
5711   g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
5712
5713   event = _gtk_cairo_get_event (cr);
5714
5715   return event == NULL ||
5716          event->window == window;
5717 }
5718
5719 static gboolean
5720 gtk_widget_get_clip_draw (GtkWidget *widget)
5721 {
5722   /* labels are not clipped, because clipping them would cause
5723    * mnemonics to not appear on characters that go beyond the
5724    * baseline.
5725    * https://bugzilla.gnome.org/show_bug.cgi?id=648570
5726    */
5727   if (GTK_IS_LABEL (widget))
5728     return FALSE;
5729
5730   return TRUE;
5731 }
5732
5733 /* code shared by gtk_container_propagate_draw() and
5734  * gtk_widget_draw()
5735  */
5736 void
5737 _gtk_widget_draw_internal (GtkWidget *widget,
5738                            cairo_t   *cr,
5739                            gboolean   clip_to_size)
5740 {
5741   if (!gtk_widget_is_drawable (widget))
5742     return;
5743
5744   clip_to_size &= gtk_widget_get_clip_draw (widget);
5745
5746   if (clip_to_size)
5747     {
5748       cairo_rectangle (cr,
5749                        0, 0,
5750                        widget->priv->allocation.width,
5751                        widget->priv->allocation.height);
5752       cairo_clip (cr);
5753     }
5754
5755   if (gdk_cairo_get_clip_rectangle (cr, NULL))
5756     {
5757       gboolean result;
5758
5759       g_signal_emit (widget, widget_signals[DRAW],
5760                      0, cr,
5761                      &result);
5762
5763       if (cairo_status (cr) &&
5764           _gtk_cairo_get_event (cr))
5765         {
5766           /* We check the event so we only warn about internal GTK calls.
5767            * Errors might come from PDF streams having write failures and
5768            * we don't want to spam stderr in that case.
5769            * We do want to catch errors from
5770            */
5771           g_warning ("drawing failure for widget `%s': %s",
5772                      G_OBJECT_TYPE_NAME (widget),
5773                      cairo_status_to_string (cairo_status (cr)));
5774         }
5775     }
5776 }
5777
5778 /**
5779  * gtk_widget_draw:
5780  * @widget: the widget to draw. It must be drawable (see
5781  *   gtk_widget_is_drawable()) and a size must have been allocated.
5782  * @cr: a cairo context to draw to
5783  *
5784  * Draws @widget to @cr. The top left corner of the widget will be
5785  * drawn to the currently set origin point of @cr.
5786  *
5787  * You should pass a cairo context as @cr argument that is in an
5788  * original state. Otherwise the resulting drawing is undefined. For
5789  * example changing the operator using cairo_set_operator() or the
5790  * line width using cairo_set_line_width() might have unwanted side
5791  * effects.
5792  * You may however change the context's transform matrix - like with
5793  * cairo_scale(), cairo_translate() or cairo_set_matrix() and clip
5794  * region with cairo_clip() prior to calling this function. Also, it
5795  * is fine to modify the context with cairo_save() and
5796  * cairo_push_group() prior to calling this function.
5797  *
5798  * <note><para>Special purpose widgets may contain special code for
5799  * rendering to the screen and might appear differently on screen
5800  * and when rendered using gtk_widget_draw().</para></note>
5801  *
5802  * Since: 3.0
5803  **/
5804 void
5805 gtk_widget_draw (GtkWidget *widget,
5806                  cairo_t   *cr)
5807 {
5808   GdkEventExpose *tmp_event;
5809
5810   g_return_if_fail (GTK_IS_WIDGET (widget));
5811   g_return_if_fail (!widget->priv->alloc_needed);
5812   g_return_if_fail (cr != NULL);
5813
5814   cairo_save (cr);
5815   /* We have to reset the event here so that draw functions can call
5816    * gtk_widget_draw() on random other widgets and get the desired
5817    * effect: Drawing all contents, not just the current window.
5818    */
5819   tmp_event = _gtk_cairo_get_event (cr);
5820   gtk_cairo_set_event (cr, NULL);
5821
5822   _gtk_widget_draw_internal (widget, cr, TRUE);
5823
5824   gtk_cairo_set_event (cr, tmp_event);
5825   cairo_restore (cr);
5826 }
5827
5828 static gboolean
5829 gtk_widget_real_key_press_event (GtkWidget         *widget,
5830                                  GdkEventKey       *event)
5831 {
5832   return gtk_bindings_activate_event (G_OBJECT (widget), event);
5833 }
5834
5835 static gboolean
5836 gtk_widget_real_key_release_event (GtkWidget         *widget,
5837                                    GdkEventKey       *event)
5838 {
5839   return gtk_bindings_activate_event (G_OBJECT (widget), event);
5840 }
5841
5842 static gboolean
5843 gtk_widget_real_focus_in_event (GtkWidget     *widget,
5844                                 GdkEventFocus *event)
5845 {
5846   gtk_widget_queue_draw (widget);
5847
5848   return FALSE;
5849 }
5850
5851 static gboolean
5852 gtk_widget_real_focus_out_event (GtkWidget     *widget,
5853                                  GdkEventFocus *event)
5854 {
5855   gtk_widget_queue_draw (widget);
5856
5857   return FALSE;
5858 }
5859
5860 static gboolean
5861 gtk_widget_real_touch_event (GtkWidget     *widget,
5862                              GdkEventTouch *event)
5863 {
5864   GdkEvent *bevent;
5865   gboolean return_val;
5866   gint signum;
5867
5868   if (!event->emulating_pointer)
5869     return FALSE;
5870
5871   if (event->type == GDK_TOUCH_BEGIN ||
5872       event->type == GDK_TOUCH_END)
5873     {
5874       GdkEventType type;
5875
5876       if (event->type == GDK_TOUCH_BEGIN)
5877         {
5878           type = GDK_BUTTON_PRESS;
5879           signum = BUTTON_PRESS_EVENT;
5880         }
5881       else
5882         {
5883           type = GDK_BUTTON_RELEASE;
5884           signum = BUTTON_RELEASE_EVENT;
5885         }
5886       bevent = gdk_event_new (type);
5887       bevent->any.window = g_object_ref (event->window);
5888       bevent->any.send_event = FALSE;
5889       bevent->button.time = event->time;
5890       bevent->button.state = event->state;
5891       bevent->button.button = 1;
5892       bevent->button.x_root = event->x_root;
5893       bevent->button.y_root = event->y_root;
5894       bevent->button.x = event->x;
5895       bevent->button.y = event->y;
5896       bevent->button.device = event->device;
5897       bevent->button.axes = g_memdup (event->axes,
5898                                       sizeof (gdouble) * gdk_device_get_n_axes (event->device));
5899       gdk_event_set_source_device (bevent, gdk_event_get_source_device ((GdkEvent*)event));
5900     }
5901   else if (event->type == GDK_TOUCH_UPDATE)
5902     {
5903       signum = MOTION_NOTIFY_EVENT;
5904       bevent = gdk_event_new (GDK_MOTION_NOTIFY);
5905       bevent->any.window = g_object_ref (event->window);
5906       bevent->any.send_event = FALSE;
5907       bevent->motion.time = event->time;
5908       bevent->motion.state = event->state;
5909       bevent->motion.x_root = event->x_root;
5910       bevent->motion.y_root = event->y_root;
5911       bevent->motion.x = event->x;
5912       bevent->motion.y = event->y;
5913       bevent->motion.device = event->device;
5914       bevent->motion.is_hint = FALSE;
5915       bevent->motion.axes = g_memdup (event->axes,
5916                                       sizeof (gdouble) * gdk_device_get_n_axes (event->device));
5917       gdk_event_set_source_device (bevent, gdk_event_get_source_device ((GdkEvent*)event));
5918     }
5919   else
5920     return FALSE;
5921
5922   g_signal_emit (widget, widget_signals[signum], 0, bevent, &return_val);
5923
5924   gdk_event_free (bevent);
5925
5926   return return_val;
5927 }
5928
5929
5930 #define WIDGET_REALIZED_FOR_EVENT(widget, event) \
5931      (event->type == GDK_FOCUS_CHANGE || gtk_widget_get_realized(widget))
5932
5933 /**
5934  * gtk_widget_event:
5935  * @widget: a #GtkWidget
5936  * @event: a #GdkEvent
5937  *
5938  * Rarely-used function. This function is used to emit
5939  * the event signals on a widget (those signals should never
5940  * be emitted without using this function to do so).
5941  * If you want to synthesize an event though, don't use this function;
5942  * instead, use gtk_main_do_event() so the event will behave as if
5943  * it were in the event queue. Don't synthesize expose events; instead,
5944  * use gdk_window_invalidate_rect() to invalidate a region of the
5945  * window.
5946  *
5947  * Return value: return from the event signal emission (%TRUE if
5948  *               the event was handled)
5949  **/
5950 gboolean
5951 gtk_widget_event (GtkWidget *widget,
5952                   GdkEvent  *event)
5953 {
5954   g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
5955   g_return_val_if_fail (WIDGET_REALIZED_FOR_EVENT (widget, event), TRUE);
5956
5957   if (event->type == GDK_EXPOSE)
5958     {
5959       g_warning ("Events of type GDK_EXPOSE cannot be synthesized. To get "
5960                  "the same effect, call gdk_window_invalidate_rect/region(), "
5961                  "followed by gdk_window_process_updates().");
5962       return TRUE;
5963     }
5964
5965   return gtk_widget_event_internal (widget, event);
5966 }
5967
5968 void
5969 _gtk_widget_set_captured_event_handler (GtkWidget               *widget,
5970                                         GtkCapturedEventHandler  callback)
5971 {
5972   g_object_set_data (G_OBJECT (widget), "captured-event-handler", callback);
5973 }
5974
5975 gboolean
5976 _gtk_widget_captured_event (GtkWidget *widget,
5977                             GdkEvent  *event)
5978 {
5979   gboolean return_val = FALSE;
5980   GtkCapturedEventHandler handler;
5981
5982   g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
5983   g_return_val_if_fail (WIDGET_REALIZED_FOR_EVENT (widget, event), TRUE);
5984
5985   if (event->type == GDK_EXPOSE)
5986     {
5987       g_warning ("Events of type GDK_EXPOSE cannot be synthesized. To get "
5988                  "the same effect, call gdk_window_invalidate_rect/region(), "
5989                  "followed by gdk_window_process_updates().");
5990       return TRUE;
5991     }
5992
5993   if (!event_window_is_still_viewable (event))
5994     return TRUE;
5995
5996   handler = g_object_get_data (G_OBJECT (widget), "captured-event-handler");
5997   if (!handler)
5998     return FALSE;
5999
6000   g_object_ref (widget);
6001
6002   return_val = handler (widget, event);
6003   return_val |= !WIDGET_REALIZED_FOR_EVENT (widget, event);
6004
6005   /* The widget that was originally to receive the event
6006    * handles motion hints, but the capturing widget might
6007    * not, so ensure we get further motion events.
6008    */
6009   if (return_val &&
6010       event->type == GDK_MOTION_NOTIFY &&
6011       event->motion.is_hint &&
6012       (gdk_window_get_events (event->any.window) &
6013        GDK_POINTER_MOTION_HINT_MASK) != 0)
6014     gdk_event_request_motions (&event->motion);
6015
6016   g_object_unref (widget);
6017
6018   return return_val;
6019 }
6020
6021 /* Returns TRUE if a translation should be done */
6022 gboolean
6023 _gtk_widget_get_translation_to_window (GtkWidget      *widget,
6024                                        GdkWindow      *window,
6025                                        int            *x,
6026                                        int            *y)
6027 {
6028   GdkWindow *w, *widget_window;
6029
6030   if (!gtk_widget_get_has_window (widget))
6031     {
6032       *x = -widget->priv->allocation.x;
6033       *y = -widget->priv->allocation.y;
6034     }
6035   else
6036     {
6037       *x = 0;
6038       *y = 0;
6039     }
6040
6041   widget_window = gtk_widget_get_window (widget);
6042
6043   for (w = window; w && w != widget_window; w = gdk_window_get_parent (w))
6044     {
6045       int wx, wy;
6046       gdk_window_get_position (w, &wx, &wy);
6047       *x += wx;
6048       *y += wy;
6049     }
6050
6051   if (w == NULL)
6052     {
6053       *x = 0;
6054       *y = 0;
6055       return FALSE;
6056     }
6057
6058   return TRUE;
6059 }
6060
6061
6062 /**
6063  * gtk_cairo_transform_to_window:
6064  * @cr: the cairo context to transform
6065  * @widget: the widget the context is currently centered for
6066  * @window: the window to transform the context to
6067  *
6068  * Transforms the given cairo context @cr that from @widget-relative
6069  * coordinates to @window-relative coordinates.
6070  * If the @widget's window is not an ancestor of @window, no
6071  * modification will be applied.
6072  *
6073  * This is the inverse to the transformation GTK applies when
6074  * preparing an expose event to be emitted with the #GtkWidget::draw
6075  * signal. It is intended to help porting multiwindow widgets from
6076  * GTK+ 2 to the rendering architecture of GTK+ 3.
6077  *
6078  * Since: 3.0
6079  **/
6080 void
6081 gtk_cairo_transform_to_window (cairo_t   *cr,
6082                                GtkWidget *widget,
6083                                GdkWindow *window)
6084 {
6085   int x, y;
6086
6087   g_return_if_fail (cr != NULL);
6088   g_return_if_fail (GTK_IS_WIDGET (widget));
6089   g_return_if_fail (GDK_IS_WINDOW (window));
6090
6091   if (_gtk_widget_get_translation_to_window (widget, window, &x, &y))
6092     cairo_translate (cr, x, y);
6093 }
6094
6095 /**
6096  * gtk_widget_send_expose:
6097  * @widget: a #GtkWidget
6098  * @event: a expose #GdkEvent
6099  *
6100  * Very rarely-used function. This function is used to emit
6101  * an expose event on a widget. This function is not normally used
6102  * directly. The only time it is used is when propagating an expose
6103  * event to a child %NO_WINDOW widget, and that is normally done
6104  * using gtk_container_propagate_draw().
6105  *
6106  * If you want to force an area of a window to be redrawn,
6107  * use gdk_window_invalidate_rect() or gdk_window_invalidate_region().
6108  * To cause the redraw to be done immediately, follow that call
6109  * with a call to gdk_window_process_updates().
6110  *
6111  * Return value: return from the event signal emission (%TRUE if
6112  *               the event was handled)
6113  **/
6114 gint
6115 gtk_widget_send_expose (GtkWidget *widget,
6116                         GdkEvent  *event)
6117 {
6118   gboolean result = FALSE;
6119   cairo_t *cr;
6120   int x, y;
6121   gboolean do_clip;
6122
6123   g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
6124   g_return_val_if_fail (gtk_widget_get_realized (widget), TRUE);
6125   g_return_val_if_fail (event != NULL, TRUE);
6126   g_return_val_if_fail (event->type == GDK_EXPOSE, TRUE);
6127
6128   cr = gdk_cairo_create (event->expose.window);
6129   gtk_cairo_set_event (cr, &event->expose);
6130
6131   gdk_cairo_region (cr, event->expose.region);
6132   cairo_clip (cr);
6133
6134   do_clip = _gtk_widget_get_translation_to_window (widget,
6135                                                    event->expose.window,
6136                                                    &x, &y);
6137   cairo_translate (cr, -x, -y);
6138
6139   _gtk_widget_draw_internal (widget, cr, do_clip);
6140
6141   /* unset here, so if someone keeps a reference to cr we
6142    * don't leak the window. */
6143   gtk_cairo_set_event (cr, NULL);
6144   cairo_destroy (cr);
6145
6146   return result;
6147 }
6148
6149 static gboolean
6150 event_window_is_still_viewable (GdkEvent *event)
6151 {
6152   /* Check that we think the event's window is viewable before
6153    * delivering the event, to prevent suprises. We do this here
6154    * at the last moment, since the event may have been queued
6155    * up behind other events, held over a recursive main loop, etc.
6156    */
6157   switch (event->type)
6158     {
6159     case GDK_EXPOSE:
6160     case GDK_MOTION_NOTIFY:
6161     case GDK_BUTTON_PRESS:
6162     case GDK_2BUTTON_PRESS:
6163     case GDK_3BUTTON_PRESS:
6164     case GDK_KEY_PRESS:
6165     case GDK_ENTER_NOTIFY:
6166     case GDK_PROXIMITY_IN:
6167     case GDK_SCROLL:
6168       return event->any.window && gdk_window_is_viewable (event->any.window);
6169
6170 #if 0
6171     /* The following events are the second half of paired events;
6172      * we always deliver them to deal with widgets that clean up
6173      * on the second half.
6174      */
6175     case GDK_BUTTON_RELEASE:
6176     case GDK_KEY_RELEASE:
6177     case GDK_LEAVE_NOTIFY:
6178     case GDK_PROXIMITY_OUT:
6179 #endif
6180
6181     default:
6182       /* Remaining events would make sense on an not-viewable window,
6183        * or don't have an associated window.
6184        */
6185       return TRUE;
6186     }
6187 }
6188
6189 static gint
6190 gtk_widget_event_internal (GtkWidget *widget,
6191                            GdkEvent  *event)
6192 {
6193   gboolean return_val = FALSE;
6194
6195   /* We check only once for is-still-visible; if someone
6196    * hides the window in on of the signals on the widget,
6197    * they are responsible for returning TRUE to terminate
6198    * handling.
6199    */
6200   if (!event_window_is_still_viewable (event))
6201     return TRUE;
6202
6203   g_object_ref (widget);
6204
6205   g_signal_emit (widget, widget_signals[EVENT], 0, event, &return_val);
6206   return_val |= !WIDGET_REALIZED_FOR_EVENT (widget, event);
6207   if (!return_val)
6208     {
6209       gint signal_num;
6210
6211       switch (event->type)
6212         {
6213         case GDK_EXPOSE:
6214         case GDK_NOTHING:
6215           signal_num = -1;
6216           break;
6217         case GDK_BUTTON_PRESS:
6218         case GDK_2BUTTON_PRESS:
6219         case GDK_3BUTTON_PRESS:
6220           signal_num = BUTTON_PRESS_EVENT;
6221           break;
6222         case GDK_TOUCH_BEGIN:
6223         case GDK_TOUCH_UPDATE:
6224         case GDK_TOUCH_END:
6225         case GDK_TOUCH_CANCEL:
6226           signal_num = TOUCH_EVENT;
6227           break;
6228         case GDK_SCROLL:
6229           signal_num = SCROLL_EVENT;
6230           break;
6231         case GDK_BUTTON_RELEASE:
6232           signal_num = BUTTON_RELEASE_EVENT;
6233           break;
6234         case GDK_MOTION_NOTIFY:
6235           signal_num = MOTION_NOTIFY_EVENT;
6236           break;
6237         case GDK_DELETE:
6238           signal_num = DELETE_EVENT;
6239           break;
6240         case GDK_DESTROY:
6241           signal_num = DESTROY_EVENT;
6242           _gtk_tooltip_hide (widget);
6243           break;
6244         case GDK_KEY_PRESS:
6245           signal_num = KEY_PRESS_EVENT;
6246           break;
6247         case GDK_KEY_RELEASE:
6248           signal_num = KEY_RELEASE_EVENT;
6249           break;
6250         case GDK_ENTER_NOTIFY:
6251           signal_num = ENTER_NOTIFY_EVENT;
6252           break;
6253         case GDK_LEAVE_NOTIFY:
6254           signal_num = LEAVE_NOTIFY_EVENT;
6255           break;
6256         case GDK_FOCUS_CHANGE:
6257           signal_num = event->focus_change.in ? FOCUS_IN_EVENT : FOCUS_OUT_EVENT;
6258           if (event->focus_change.in)
6259             _gtk_tooltip_focus_in (widget);
6260           else
6261             _gtk_tooltip_focus_out (widget);
6262           break;
6263         case GDK_CONFIGURE:
6264           signal_num = CONFIGURE_EVENT;
6265           break;
6266         case GDK_MAP:
6267           signal_num = MAP_EVENT;
6268           break;
6269         case GDK_UNMAP:
6270           signal_num = UNMAP_EVENT;
6271           break;
6272         case GDK_WINDOW_STATE:
6273           signal_num = WINDOW_STATE_EVENT;
6274           break;
6275         case GDK_PROPERTY_NOTIFY:
6276           signal_num = PROPERTY_NOTIFY_EVENT;
6277           break;
6278         case GDK_SELECTION_CLEAR:
6279           signal_num = SELECTION_CLEAR_EVENT;
6280           break;
6281         case GDK_SELECTION_REQUEST:
6282           signal_num = SELECTION_REQUEST_EVENT;
6283           break;
6284         case GDK_SELECTION_NOTIFY:
6285           signal_num = SELECTION_NOTIFY_EVENT;
6286           break;
6287         case GDK_PROXIMITY_IN:
6288           signal_num = PROXIMITY_IN_EVENT;
6289           break;
6290         case GDK_PROXIMITY_OUT:
6291           signal_num = PROXIMITY_OUT_EVENT;
6292           break;
6293         case GDK_VISIBILITY_NOTIFY:
6294           signal_num = VISIBILITY_NOTIFY_EVENT;
6295           break;
6296         case GDK_GRAB_BROKEN:
6297           signal_num = GRAB_BROKEN_EVENT;
6298           break;
6299         case GDK_DAMAGE:
6300           signal_num = DAMAGE_EVENT;
6301           break;
6302         default:
6303           g_warning ("gtk_widget_event(): unhandled event type: %d", event->type);
6304           signal_num = -1;
6305           break;
6306         }
6307       if (signal_num != -1)
6308         g_signal_emit (widget, widget_signals[signal_num], 0, event, &return_val);
6309     }
6310   if (WIDGET_REALIZED_FOR_EVENT (widget, event))
6311     g_signal_emit (widget, widget_signals[EVENT_AFTER], 0, event);
6312   else
6313     return_val = TRUE;
6314
6315   g_object_unref (widget);
6316
6317   return return_val;
6318 }
6319
6320 /**
6321  * gtk_widget_activate:
6322  * @widget: a #GtkWidget that's activatable
6323  *
6324  * For widgets that can be "activated" (buttons, menu items, etc.)
6325  * this function activates them. Activation is what happens when you
6326  * press Enter on a widget during key navigation. If @widget isn't
6327  * activatable, the function returns %FALSE.
6328  *
6329  * Return value: %TRUE if the widget was activatable
6330  **/
6331 gboolean
6332 gtk_widget_activate (GtkWidget *widget)
6333 {
6334   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6335
6336   if (WIDGET_CLASS (widget)->activate_signal)
6337     {
6338       /* FIXME: we should eventually check the signals signature here */
6339       g_signal_emit (widget, WIDGET_CLASS (widget)->activate_signal, 0);
6340
6341       return TRUE;
6342     }
6343   else
6344     return FALSE;
6345 }
6346
6347 static void
6348 gtk_widget_reparent_subwindows (GtkWidget *widget,
6349                                 GdkWindow *new_window)
6350 {
6351   GtkWidgetPrivate *priv = widget->priv;
6352
6353   if (!gtk_widget_get_has_window (widget))
6354     {
6355       GList *children = gdk_window_get_children (priv->window);
6356       GList *tmp_list;
6357
6358       for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
6359         {
6360           GdkWindow *window = tmp_list->data;
6361           gpointer child;
6362
6363           gdk_window_get_user_data (window, &child);
6364           while (child && child != widget)
6365             child = ((GtkWidget*) child)->priv->parent;
6366
6367           if (child)
6368             gdk_window_reparent (window, new_window, 0, 0);
6369         }
6370
6371       g_list_free (children);
6372     }
6373   else
6374    {
6375      GdkWindow *parent;
6376      GList *tmp_list, *children;
6377
6378      parent = gdk_window_get_parent (priv->window);
6379
6380      if (parent == NULL)
6381        gdk_window_reparent (priv->window, new_window, 0, 0);
6382      else
6383        {
6384          children = gdk_window_get_children (parent);
6385
6386          for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
6387            {
6388              GdkWindow *window = tmp_list->data;
6389              gpointer child;
6390
6391              gdk_window_get_user_data (window, &child);
6392
6393              if (child == widget)
6394                gdk_window_reparent (window, new_window, 0, 0);
6395            }
6396
6397          g_list_free (children);
6398        }
6399    }
6400 }
6401
6402 static void
6403 gtk_widget_reparent_fixup_child (GtkWidget *widget,
6404                                  gpointer   client_data)
6405 {
6406   GtkWidgetPrivate *priv = widget->priv;
6407
6408   g_assert (client_data != NULL);
6409
6410   if (!gtk_widget_get_has_window (widget))
6411     {
6412       if (priv->window)
6413         g_object_unref (priv->window);
6414       priv->window = (GdkWindow*) client_data;
6415       if (priv->window)
6416         g_object_ref (priv->window);
6417
6418       if (GTK_IS_CONTAINER (widget))
6419         gtk_container_forall (GTK_CONTAINER (widget),
6420                               gtk_widget_reparent_fixup_child,
6421                               client_data);
6422     }
6423 }
6424
6425 /**
6426  * gtk_widget_reparent:
6427  * @widget: a #GtkWidget
6428  * @new_parent: a #GtkContainer to move the widget into
6429  *
6430  * Moves a widget from one #GtkContainer to another, handling reference
6431  * count issues to avoid destroying the widget.
6432  **/
6433 void
6434 gtk_widget_reparent (GtkWidget *widget,
6435                      GtkWidget *new_parent)
6436 {
6437   GtkWidgetPrivate *priv;
6438
6439   g_return_if_fail (GTK_IS_WIDGET (widget));
6440   g_return_if_fail (GTK_IS_CONTAINER (new_parent));
6441   priv = widget->priv;
6442   g_return_if_fail (priv->parent != NULL);
6443
6444   if (priv->parent != new_parent)
6445     {
6446       /* First try to see if we can get away without unrealizing
6447        * the widget as we reparent it. if so we set a flag so
6448        * that gtk_widget_unparent doesn't unrealize widget
6449        */
6450       if (gtk_widget_get_realized (widget) && gtk_widget_get_realized (new_parent))
6451         priv->in_reparent = TRUE;
6452
6453       g_object_ref (widget);
6454       gtk_container_remove (GTK_CONTAINER (priv->parent), widget);
6455       gtk_container_add (GTK_CONTAINER (new_parent), widget);
6456       g_object_unref (widget);
6457
6458       if (priv->in_reparent)
6459         {
6460           priv->in_reparent = FALSE;
6461
6462           gtk_widget_reparent_subwindows (widget, gtk_widget_get_parent_window (widget));
6463           gtk_widget_reparent_fixup_child (widget,
6464                                            gtk_widget_get_parent_window (widget));
6465         }
6466
6467       g_object_notify (G_OBJECT (widget), "parent");
6468     }
6469 }
6470
6471 /**
6472  * gtk_widget_intersect:
6473  * @widget: a #GtkWidget
6474  * @area: a rectangle
6475  * @intersection: rectangle to store intersection of @widget and @area
6476  *
6477  * Computes the intersection of a @widget's area and @area, storing
6478  * the intersection in @intersection, and returns %TRUE if there was
6479  * an intersection.  @intersection may be %NULL if you're only
6480  * interested in whether there was an intersection.
6481  *
6482  * Return value: %TRUE if there was an intersection
6483  **/
6484 gboolean
6485 gtk_widget_intersect (GtkWidget          *widget,
6486                       const GdkRectangle *area,
6487                       GdkRectangle       *intersection)
6488 {
6489   GtkWidgetPrivate *priv;
6490   GdkRectangle *dest;
6491   GdkRectangle tmp;
6492   gint return_val;
6493
6494   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6495   g_return_val_if_fail (area != NULL, FALSE);
6496
6497   priv = widget->priv;
6498
6499   if (intersection)
6500     dest = intersection;
6501   else
6502     dest = &tmp;
6503
6504   return_val = gdk_rectangle_intersect (&priv->allocation, area, dest);
6505
6506   if (return_val && intersection && gtk_widget_get_has_window (widget))
6507     {
6508       intersection->x -= priv->allocation.x;
6509       intersection->y -= priv->allocation.y;
6510     }
6511
6512   return return_val;
6513 }
6514
6515 /**
6516  * gtk_widget_region_intersect:
6517  * @widget: a #GtkWidget
6518  * @region: a #cairo_region_t, in the same coordinate system as
6519  *          @widget->allocation. That is, relative to @widget->window
6520  *          for %NO_WINDOW widgets; relative to the parent window
6521  *          of @widget->window for widgets with their own window.
6522  *
6523  * Computes the intersection of a @widget's area and @region, returning
6524  * the intersection. The result may be empty, use cairo_region_is_empty() to
6525  * check.
6526  *
6527  * Returns: A newly allocated region holding the intersection of @widget
6528  *     and @region. The coordinates of the return value are relative to
6529  *     @widget->window for %NO_WINDOW widgets, and relative to the parent
6530  *     window of @widget->window for widgets with their own window.
6531  */
6532 cairo_region_t *
6533 gtk_widget_region_intersect (GtkWidget       *widget,
6534                              const cairo_region_t *region)
6535 {
6536   GdkRectangle rect;
6537   cairo_region_t *dest;
6538
6539   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6540   g_return_val_if_fail (region != NULL, NULL);
6541
6542   gtk_widget_get_allocation (widget, &rect);
6543
6544   dest = cairo_region_create_rectangle (&rect);
6545
6546   cairo_region_intersect (dest, region);
6547
6548   return dest;
6549 }
6550
6551 /**
6552  * _gtk_widget_grab_notify:
6553  * @widget: a #GtkWidget
6554  * @was_grabbed: whether a grab is now in effect
6555  *
6556  * Emits the #GtkWidget::grab-notify signal on @widget.
6557  *
6558  * Since: 2.6
6559  **/
6560 void
6561 _gtk_widget_grab_notify (GtkWidget *widget,
6562                          gboolean   was_grabbed)
6563 {
6564   g_signal_emit (widget, widget_signals[GRAB_NOTIFY], 0, was_grabbed);
6565 }
6566
6567 /**
6568  * gtk_widget_grab_focus:
6569  * @widget: a #GtkWidget
6570  *
6571  * Causes @widget to have the keyboard focus for the #GtkWindow it's
6572  * inside. @widget must be a focusable widget, such as a #GtkEntry;
6573  * something like #GtkFrame won't work.
6574  *
6575  * More precisely, it must have the %GTK_CAN_FOCUS flag set. Use
6576  * gtk_widget_set_can_focus() to modify that flag.
6577  *
6578  * The widget also needs to be realized and mapped. This is indicated by the
6579  * related signals. Grabbing the focus immediately after creating the widget
6580  * will likely fail and cause critical warnings.
6581  **/
6582 void
6583 gtk_widget_grab_focus (GtkWidget *widget)
6584 {
6585   g_return_if_fail (GTK_IS_WIDGET (widget));
6586
6587   if (!gtk_widget_is_sensitive (widget))
6588     return;
6589
6590   g_object_ref (widget);
6591   g_signal_emit (widget, widget_signals[GRAB_FOCUS], 0);
6592   g_object_notify (G_OBJECT (widget), "has-focus");
6593   g_object_unref (widget);
6594 }
6595
6596 static void
6597 reset_focus_recurse (GtkWidget *widget,
6598                      gpointer   data)
6599 {
6600   if (GTK_IS_CONTAINER (widget))
6601     {
6602       GtkContainer *container;
6603
6604       container = GTK_CONTAINER (widget);
6605       gtk_container_set_focus_child (container, NULL);
6606
6607       gtk_container_foreach (container,
6608                              reset_focus_recurse,
6609                              NULL);
6610     }
6611 }
6612
6613 static void
6614 gtk_widget_real_grab_focus (GtkWidget *focus_widget)
6615 {
6616   if (gtk_widget_get_can_focus (focus_widget))
6617     {
6618       GtkWidget *toplevel;
6619       GtkWidget *widget;
6620
6621       /* clear the current focus setting, break if the current widget
6622        * is the focus widget's parent, since containers above that will
6623        * be set by the next loop.
6624        */
6625       toplevel = gtk_widget_get_toplevel (focus_widget);
6626       if (gtk_widget_is_toplevel (toplevel) && GTK_IS_WINDOW (toplevel))
6627         {
6628           widget = gtk_window_get_focus (GTK_WINDOW (toplevel));
6629
6630           if (widget == focus_widget)
6631             {
6632               /* We call _gtk_window_internal_set_focus() here so that the
6633                * toplevel window can request the focus if necessary.
6634                * This is needed when the toplevel is a GtkPlug
6635                */
6636               if (!gtk_widget_has_focus (widget))
6637                 _gtk_window_internal_set_focus (GTK_WINDOW (toplevel), focus_widget);
6638
6639               return;
6640             }
6641
6642           if (widget)
6643             {
6644               GtkWidget *common_ancestor = gtk_widget_common_ancestor (widget, focus_widget);
6645
6646               if (widget != common_ancestor)
6647                 {
6648                   while (widget->priv->parent && widget->priv->parent != common_ancestor)
6649                     {
6650                       widget = widget->priv->parent;
6651                       gtk_container_set_focus_child (GTK_CONTAINER (widget), NULL);
6652                     }
6653                 }
6654             }
6655         }
6656       else if (toplevel != focus_widget)
6657         {
6658           /* gtk_widget_grab_focus() operates on a tree without window...
6659            * actually, this is very questionable behaviour.
6660            */
6661
6662           gtk_container_foreach (GTK_CONTAINER (toplevel),
6663                                  reset_focus_recurse,
6664                                  NULL);
6665         }
6666
6667       /* now propagate the new focus up the widget tree and finally
6668        * set it on the window
6669        */
6670       widget = focus_widget;
6671       while (widget->priv->parent)
6672         {
6673           gtk_container_set_focus_child (GTK_CONTAINER (widget->priv->parent), widget);
6674           widget = widget->priv->parent;
6675         }
6676       if (GTK_IS_WINDOW (widget))
6677         _gtk_window_internal_set_focus (GTK_WINDOW (widget), focus_widget);
6678     }
6679 }
6680
6681 static gboolean
6682 gtk_widget_real_query_tooltip (GtkWidget  *widget,
6683                                gint        x,
6684                                gint        y,
6685                                gboolean    keyboard_tip,
6686                                GtkTooltip *tooltip)
6687 {
6688   gchar *tooltip_markup;
6689   gboolean has_tooltip;
6690
6691   tooltip_markup = g_object_get_qdata (G_OBJECT (widget), quark_tooltip_markup);
6692   has_tooltip = GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (widget), quark_has_tooltip));
6693
6694   if (has_tooltip && tooltip_markup)
6695     {
6696       gtk_tooltip_set_markup (tooltip, tooltip_markup);
6697       return TRUE;
6698     }
6699
6700   return FALSE;
6701 }
6702
6703 static void
6704 gtk_widget_real_state_flags_changed (GtkWidget     *widget,
6705                                      GtkStateFlags  old_state)
6706 {
6707   gtk_widget_update_pango_context (widget);
6708 }
6709
6710 static void
6711 gtk_widget_real_style_updated (GtkWidget *widget)
6712 {
6713   GtkWidgetPrivate *priv = widget->priv;
6714
6715   gtk_widget_update_pango_context (widget);
6716
6717   if (priv->style != NULL &&
6718       priv->style != gtk_widget_get_default_style ())
6719     {
6720       /* Trigger ::style-set for old
6721        * widgets not listening to this
6722        */
6723       g_signal_emit (widget,
6724                      widget_signals[STYLE_SET],
6725                      0,
6726                      widget->priv->style);
6727     }
6728
6729   if (widget->priv->context)
6730     {
6731       const GtkBitmask *changes = _gtk_style_context_get_changes (widget->priv->context);
6732
6733       if (gtk_widget_get_realized (widget) &&
6734           gtk_widget_get_has_window (widget) &&
6735           !gtk_widget_get_app_paintable (widget))
6736         gtk_style_context_set_background (widget->priv->context,
6737                                           widget->priv->window);
6738
6739       if (widget->priv->anchored)
6740         {
6741           if (changes && _gtk_css_style_property_changes_affect_size (changes))
6742             gtk_widget_queue_resize (widget);
6743           else
6744             gtk_widget_queue_draw (widget);
6745         }
6746     }
6747   else
6748     {
6749       if (widget->priv->anchored)
6750         gtk_widget_queue_resize (widget);
6751     }
6752 }
6753
6754 static gboolean
6755 gtk_widget_real_show_help (GtkWidget        *widget,
6756                            GtkWidgetHelpType help_type)
6757 {
6758   if (help_type == GTK_WIDGET_HELP_TOOLTIP)
6759     {
6760       _gtk_tooltip_toggle_keyboard_mode (widget);
6761
6762       return TRUE;
6763     }
6764   else
6765     return FALSE;
6766 }
6767
6768 static gboolean
6769 gtk_widget_real_focus (GtkWidget         *widget,
6770                        GtkDirectionType   direction)
6771 {
6772   if (!gtk_widget_get_can_focus (widget))
6773     return FALSE;
6774
6775   if (!gtk_widget_is_focus (widget))
6776     {
6777       gtk_widget_grab_focus (widget);
6778       return TRUE;
6779     }
6780   else
6781     return FALSE;
6782 }
6783
6784 static void
6785 gtk_widget_real_move_focus (GtkWidget         *widget,
6786                             GtkDirectionType   direction)
6787 {
6788   GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
6789
6790   if (widget != toplevel && GTK_IS_WINDOW (toplevel))
6791     {
6792       g_signal_emit (toplevel, widget_signals[MOVE_FOCUS], 0,
6793                      direction);
6794     }
6795 }
6796
6797 static gboolean
6798 gtk_widget_real_keynav_failed (GtkWidget        *widget,
6799                                GtkDirectionType  direction)
6800 {
6801   gboolean cursor_only;
6802
6803   switch (direction)
6804     {
6805     case GTK_DIR_TAB_FORWARD:
6806     case GTK_DIR_TAB_BACKWARD:
6807       return FALSE;
6808
6809     case GTK_DIR_UP:
6810     case GTK_DIR_DOWN:
6811     case GTK_DIR_LEFT:
6812     case GTK_DIR_RIGHT:
6813       g_object_get (gtk_widget_get_settings (widget),
6814                     "gtk-keynav-cursor-only", &cursor_only,
6815                     NULL);
6816       if (cursor_only)
6817         return FALSE;
6818       break;
6819     }
6820
6821   gtk_widget_error_bell (widget);
6822
6823   return TRUE;
6824 }
6825
6826 /**
6827  * gtk_widget_set_can_focus:
6828  * @widget: a #GtkWidget
6829  * @can_focus: whether or not @widget can own the input focus.
6830  *
6831  * Specifies whether @widget can own the input focus. See
6832  * gtk_widget_grab_focus() for actually setting the input focus on a
6833  * widget.
6834  *
6835  * Since: 2.18
6836  **/
6837 void
6838 gtk_widget_set_can_focus (GtkWidget *widget,
6839                           gboolean   can_focus)
6840 {
6841   g_return_if_fail (GTK_IS_WIDGET (widget));
6842
6843   if (widget->priv->can_focus != can_focus)
6844     {
6845       widget->priv->can_focus = can_focus;
6846
6847       gtk_widget_queue_resize (widget);
6848       g_object_notify (G_OBJECT (widget), "can-focus");
6849     }
6850 }
6851
6852 /**
6853  * gtk_widget_get_can_focus:
6854  * @widget: a #GtkWidget
6855  *
6856  * Determines whether @widget can own the input focus. See
6857  * gtk_widget_set_can_focus().
6858  *
6859  * Return value: %TRUE if @widget can own the input focus, %FALSE otherwise
6860  *
6861  * Since: 2.18
6862  **/
6863 gboolean
6864 gtk_widget_get_can_focus (GtkWidget *widget)
6865 {
6866   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6867
6868   return widget->priv->can_focus;
6869 }
6870
6871 /**
6872  * gtk_widget_has_focus:
6873  * @widget: a #GtkWidget
6874  *
6875  * Determines if the widget has the global input focus. See
6876  * gtk_widget_is_focus() for the difference between having the global
6877  * input focus, and only having the focus within a toplevel.
6878  *
6879  * Return value: %TRUE if the widget has the global input focus.
6880  *
6881  * Since: 2.18
6882  **/
6883 gboolean
6884 gtk_widget_has_focus (GtkWidget *widget)
6885 {
6886   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6887
6888   return widget->priv->has_focus;
6889 }
6890
6891 /**
6892  * gtk_widget_has_visible_focus:
6893  * @widget: a #GtkWidget
6894  *
6895  * Determines if the widget should show a visible indication that
6896  * it has the global input focus. This is a convenience function for
6897  * use in ::draw handlers that takes into account whether focus
6898  * indication should currently be shown in the toplevel window of
6899  * @widget. See gtk_window_get_focus_visible() for more information
6900  * about focus indication.
6901  *
6902  * To find out if the widget has the global input focus, use
6903  * gtk_widget_has_focus().
6904  *
6905  * Return value: %TRUE if the widget should display a 'focus rectangle'
6906  *
6907  * Since: 3.2
6908  */
6909 gboolean
6910 gtk_widget_has_visible_focus (GtkWidget *widget)
6911 {
6912   gboolean draw_focus;
6913
6914   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6915
6916   if (widget->priv->has_focus)
6917     {
6918       GtkWidget *toplevel;
6919
6920       toplevel = gtk_widget_get_toplevel (widget);
6921
6922       if (GTK_IS_WINDOW (toplevel))
6923         draw_focus = gtk_window_get_focus_visible (GTK_WINDOW (toplevel));
6924       else
6925         draw_focus = TRUE;
6926     }
6927   else
6928     draw_focus = FALSE;
6929
6930   return draw_focus;
6931 }
6932
6933 /**
6934  * gtk_widget_is_focus:
6935  * @widget: a #GtkWidget
6936  *
6937  * Determines if the widget is the focus widget within its
6938  * toplevel. (This does not mean that the %HAS_FOCUS flag is
6939  * necessarily set; %HAS_FOCUS will only be set if the
6940  * toplevel widget additionally has the global input focus.)
6941  *
6942  * Return value: %TRUE if the widget is the focus widget.
6943  **/
6944 gboolean
6945 gtk_widget_is_focus (GtkWidget *widget)
6946 {
6947   GtkWidget *toplevel;
6948
6949   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6950
6951   toplevel = gtk_widget_get_toplevel (widget);
6952
6953   if (GTK_IS_WINDOW (toplevel))
6954     return widget == gtk_window_get_focus (GTK_WINDOW (toplevel));
6955   else
6956     return FALSE;
6957 }
6958
6959 /**
6960  * gtk_widget_set_can_default:
6961  * @widget: a #GtkWidget
6962  * @can_default: whether or not @widget can be a default widget.
6963  *
6964  * Specifies whether @widget can be a default widget. See
6965  * gtk_widget_grab_default() for details about the meaning of
6966  * "default".
6967  *
6968  * Since: 2.18
6969  **/
6970 void
6971 gtk_widget_set_can_default (GtkWidget *widget,
6972                             gboolean   can_default)
6973 {
6974   g_return_if_fail (GTK_IS_WIDGET (widget));
6975
6976   if (widget->priv->can_default != can_default)
6977     {
6978       widget->priv->can_default = can_default;
6979
6980       gtk_widget_queue_resize (widget);
6981       g_object_notify (G_OBJECT (widget), "can-default");
6982     }
6983 }
6984
6985 /**
6986  * gtk_widget_get_can_default:
6987  * @widget: a #GtkWidget
6988  *
6989  * Determines whether @widget can be a default widget. See
6990  * gtk_widget_set_can_default().
6991  *
6992  * Return value: %TRUE if @widget can be a default widget, %FALSE otherwise
6993  *
6994  * Since: 2.18
6995  **/
6996 gboolean
6997 gtk_widget_get_can_default (GtkWidget *widget)
6998 {
6999   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7000
7001   return widget->priv->can_default;
7002 }
7003
7004 /**
7005  * gtk_widget_has_default:
7006  * @widget: a #GtkWidget
7007  *
7008  * Determines whether @widget is the current default widget within its
7009  * toplevel. See gtk_widget_set_can_default().
7010  *
7011  * Return value: %TRUE if @widget is the current default widget within
7012  *     its toplevel, %FALSE otherwise
7013  *
7014  * Since: 2.18
7015  */
7016 gboolean
7017 gtk_widget_has_default (GtkWidget *widget)
7018 {
7019   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7020
7021   return widget->priv->has_default;
7022 }
7023
7024 void
7025 _gtk_widget_set_has_default (GtkWidget *widget,
7026                              gboolean   has_default)
7027 {
7028   GtkStyleContext *context;
7029
7030   widget->priv->has_default = has_default;
7031
7032   context = gtk_widget_get_style_context (widget);
7033
7034   if (has_default)
7035     gtk_style_context_add_class (context, GTK_STYLE_CLASS_DEFAULT);
7036   else
7037     gtk_style_context_remove_class (context, GTK_STYLE_CLASS_DEFAULT);
7038 }
7039
7040 /**
7041  * gtk_widget_grab_default:
7042  * @widget: a #GtkWidget
7043  *
7044  * Causes @widget to become the default widget. @widget must be able to be
7045  * a default widget; typically you would ensure this yourself
7046  * by calling gtk_widget_set_can_default() with a %TRUE value.
7047  * The default widget is activated when
7048  * the user presses Enter in a window. Default widgets must be
7049  * activatable, that is, gtk_widget_activate() should affect them. Note
7050  * that #GtkEntry widgets require the "activates-default" property
7051  * set to %TRUE before they activate the default widget when Enter
7052  * is pressed and the #GtkEntry is focused.
7053  **/
7054 void
7055 gtk_widget_grab_default (GtkWidget *widget)
7056 {
7057   GtkWidget *window;
7058
7059   g_return_if_fail (GTK_IS_WIDGET (widget));
7060   g_return_if_fail (gtk_widget_get_can_default (widget));
7061
7062   window = gtk_widget_get_toplevel (widget);
7063
7064   if (window && gtk_widget_is_toplevel (window))
7065     gtk_window_set_default (GTK_WINDOW (window), widget);
7066   else
7067     g_warning (G_STRLOC ": widget not within a GtkWindow");
7068 }
7069
7070 /**
7071  * gtk_widget_set_receives_default:
7072  * @widget: a #GtkWidget
7073  * @receives_default: whether or not @widget can be a default widget.
7074  *
7075  * Specifies whether @widget will be treated as the default widget
7076  * within its toplevel when it has the focus, even if another widget
7077  * is the default.
7078  *
7079  * See gtk_widget_grab_default() for details about the meaning of
7080  * "default".
7081  *
7082  * Since: 2.18
7083  **/
7084 void
7085 gtk_widget_set_receives_default (GtkWidget *widget,
7086                                  gboolean   receives_default)
7087 {
7088   g_return_if_fail (GTK_IS_WIDGET (widget));
7089
7090   if (widget->priv->receives_default != receives_default)
7091     {
7092       widget->priv->receives_default = receives_default;
7093
7094       g_object_notify (G_OBJECT (widget), "receives-default");
7095     }
7096 }
7097
7098 /**
7099  * gtk_widget_get_receives_default:
7100  * @widget: a #GtkWidget
7101  *
7102  * Determines whether @widget is alyways treated as default widget
7103  * withing its toplevel when it has the focus, even if another widget
7104  * is the default.
7105  *
7106  * See gtk_widget_set_receives_default().
7107  *
7108  * Return value: %TRUE if @widget acts as default widget when focussed,
7109  *               %FALSE otherwise
7110  *
7111  * Since: 2.18
7112  **/
7113 gboolean
7114 gtk_widget_get_receives_default (GtkWidget *widget)
7115 {
7116   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7117
7118   return widget->priv->receives_default;
7119 }
7120
7121 /**
7122  * gtk_widget_has_grab:
7123  * @widget: a #GtkWidget
7124  *
7125  * Determines whether the widget is currently grabbing events, so it
7126  * is the only widget receiving input events (keyboard and mouse).
7127  *
7128  * See also gtk_grab_add().
7129  *
7130  * Return value: %TRUE if the widget is in the grab_widgets stack
7131  *
7132  * Since: 2.18
7133  **/
7134 gboolean
7135 gtk_widget_has_grab (GtkWidget *widget)
7136 {
7137   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7138
7139   return widget->priv->has_grab;
7140 }
7141
7142 void
7143 _gtk_widget_set_has_grab (GtkWidget *widget,
7144                           gboolean   has_grab)
7145 {
7146   widget->priv->has_grab = has_grab;
7147 }
7148
7149 /**
7150  * gtk_widget_device_is_shadowed:
7151  * @widget: a #GtkWidget
7152  * @device: a #GdkDevice
7153  *
7154  * Returns %TRUE if @device has been shadowed by a GTK+
7155  * device grab on another widget, so it would stop sending
7156  * events to @widget. This may be used in the
7157  * #GtkWidget::grab-notify signal to check for specific
7158  * devices. See gtk_device_grab_add().
7159  *
7160  * Returns: %TRUE if there is an ongoing grab on @device
7161  *          by another #GtkWidget than @widget.
7162  *
7163  * Since: 3.0
7164  **/
7165 gboolean
7166 gtk_widget_device_is_shadowed (GtkWidget *widget,
7167                                GdkDevice *device)
7168 {
7169   GtkWindowGroup *group;
7170   GtkWidget *grab_widget, *toplevel;
7171
7172   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7173   g_return_val_if_fail (GDK_IS_DEVICE (device), FALSE);
7174
7175   if (!gtk_widget_get_realized (widget))
7176     return TRUE;
7177
7178   toplevel = gtk_widget_get_toplevel (widget);
7179
7180   if (GTK_IS_WINDOW (toplevel))
7181     group = gtk_window_get_group (GTK_WINDOW (toplevel));
7182   else
7183     group = gtk_window_get_group (NULL);
7184
7185   grab_widget = gtk_window_group_get_current_device_grab (group, device);
7186
7187   /* Widget not inside the hierarchy of grab_widget */
7188   if (grab_widget &&
7189       widget != grab_widget &&
7190       !gtk_widget_is_ancestor (widget, grab_widget))
7191     return TRUE;
7192
7193   grab_widget = gtk_window_group_get_current_grab (group);
7194   if (grab_widget && widget != grab_widget &&
7195       !gtk_widget_is_ancestor (widget, grab_widget))
7196     return TRUE;
7197
7198   return FALSE;
7199 }
7200
7201 /**
7202  * gtk_widget_set_name:
7203  * @widget: a #GtkWidget
7204  * @name: name for the widget
7205  *
7206  * Widgets can be named, which allows you to refer to them from a
7207  * CSS file. You can apply a style to widgets with a particular name
7208  * in the CSS file. See the documentation for the CSS syntax (on the
7209  * same page as the docs for #GtkStyleContext).
7210  *
7211  * Note that the CSS syntax has certain special characters to delimit
7212  * and represent elements in a selector (period, &num;, &gt;, &ast;...),
7213  * so using these will make your widget impossible to match by name.
7214  * Any combination of alphanumeric symbols, dashes and underscores will
7215  * suffice.
7216  **/
7217 void
7218 gtk_widget_set_name (GtkWidget   *widget,
7219                      const gchar *name)
7220 {
7221   GtkWidgetPrivate *priv;
7222   gchar *new_name;
7223
7224   g_return_if_fail (GTK_IS_WIDGET (widget));
7225
7226   priv = widget->priv;
7227
7228   new_name = g_strdup (name);
7229   g_free (priv->name);
7230   priv->name = new_name;
7231
7232   _gtk_widget_invalidate_style_context (widget, GTK_CSS_CHANGE_NAME);
7233
7234   g_object_notify (G_OBJECT (widget), "name");
7235 }
7236
7237 /**
7238  * gtk_widget_get_name:
7239  * @widget: a #GtkWidget
7240  *
7241  * Retrieves the name of a widget. See gtk_widget_set_name() for the
7242  * significance of widget names.
7243  *
7244  * Return value: name of the widget. This string is owned by GTK+ and
7245  * should not be modified or freed
7246  **/
7247 const gchar*
7248 gtk_widget_get_name (GtkWidget *widget)
7249 {
7250   GtkWidgetPrivate *priv;
7251
7252   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7253
7254   priv = widget->priv;
7255
7256   if (priv->name)
7257     return priv->name;
7258   return G_OBJECT_TYPE_NAME (widget);
7259 }
7260
7261 static void
7262 gtk_widget_update_state_flags (GtkWidget     *widget,
7263                                GtkStateFlags  flags_to_set,
7264                                GtkStateFlags  flags_to_unset)
7265 {
7266   GtkWidgetPrivate *priv;
7267
7268   priv = widget->priv;
7269
7270   /* Handle insensitive first, since it is propagated
7271    * differently throughout the widget hierarchy.
7272    */
7273   if ((priv->state_flags & GTK_STATE_FLAG_INSENSITIVE) && (flags_to_unset & GTK_STATE_FLAG_INSENSITIVE))
7274     gtk_widget_set_sensitive (widget, TRUE);
7275   else if (!(priv->state_flags & GTK_STATE_FLAG_INSENSITIVE) && (flags_to_set & GTK_STATE_FLAG_INSENSITIVE))
7276     gtk_widget_set_sensitive (widget, FALSE);
7277
7278   flags_to_set &= ~(GTK_STATE_FLAG_INSENSITIVE);
7279   flags_to_unset &= ~(GTK_STATE_FLAG_INSENSITIVE);
7280
7281   if (flags_to_set != 0 || flags_to_unset != 0)
7282     {
7283       GtkStateData data;
7284
7285       data.flags_to_set = flags_to_set;
7286       data.flags_to_unset = flags_to_unset;
7287
7288       gtk_widget_propagate_state (widget, &data);
7289     }
7290 }
7291
7292 /**
7293  * gtk_widget_set_state_flags:
7294  * @widget: a #GtkWidget
7295  * @flags: State flags to turn on
7296  * @clear: Whether to clear state before turning on @flags
7297  *
7298  * This function is for use in widget implementations. Turns on flag
7299  * values in the current widget state (insensitive, prelighted, etc.).
7300  *
7301  * It is worth mentioning that any other state than %GTK_STATE_FLAG_INSENSITIVE,
7302  * will be propagated down to all non-internal children if @widget is a
7303  * #GtkContainer, while %GTK_STATE_FLAG_INSENSITIVE itself will be propagated
7304  * down to all #GtkContainer children by different means than turning on the
7305  * state flag down the hierarchy, both gtk_widget_get_state_flags() and
7306  * gtk_widget_is_sensitive() will make use of these.
7307  *
7308  * Since: 3.0
7309  **/
7310 void
7311 gtk_widget_set_state_flags (GtkWidget     *widget,
7312                             GtkStateFlags  flags,
7313                             gboolean       clear)
7314 {
7315   g_return_if_fail (GTK_IS_WIDGET (widget));
7316
7317   if ((!clear && (widget->priv->state_flags & flags) == flags) ||
7318       (clear && widget->priv->state_flags == flags))
7319     return;
7320
7321   if (clear)
7322     gtk_widget_update_state_flags (widget, flags, ~(flags ^ (GTK_STATE_FLAG_DIR_LTR | GTK_STATE_FLAG_DIR_RTL)));
7323   else
7324     gtk_widget_update_state_flags (widget, flags, 0);
7325 }
7326
7327 /**
7328  * gtk_widget_unset_state_flags:
7329  * @widget: a #GtkWidget
7330  * @flags: State flags to turn off
7331  *
7332  * This function is for use in widget implementations. Turns off flag
7333  * values for the current widget state (insensitive, prelighted, etc.).
7334  * See gtk_widget_set_state_flags().
7335  *
7336  * Since: 3.0
7337  **/
7338 void
7339 gtk_widget_unset_state_flags (GtkWidget     *widget,
7340                               GtkStateFlags  flags)
7341 {
7342   g_return_if_fail (GTK_IS_WIDGET (widget));
7343
7344   if ((widget->priv->state_flags & flags) == 0)
7345     return;
7346
7347   gtk_widget_update_state_flags (widget, 0, flags);
7348 }
7349
7350 /**
7351  * gtk_widget_get_state_flags:
7352  * @widget: a #GtkWidget
7353  *
7354  * Returns the widget state as a flag set. It is worth mentioning
7355  * that the effective %GTK_STATE_FLAG_INSENSITIVE state will be
7356  * returned, that is, also based on parent insensitivity, even if
7357  * @widget itself is sensitive.
7358  *
7359  * Returns: The state flags for widget
7360  *
7361  * Since: 3.0
7362  **/
7363 GtkStateFlags
7364 gtk_widget_get_state_flags (GtkWidget *widget)
7365 {
7366   GtkStateFlags flags;
7367
7368   g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
7369
7370   flags = widget->priv->state_flags;
7371
7372   if (gtk_widget_has_focus (widget))
7373     flags |= GTK_STATE_FLAG_FOCUSED;
7374
7375   return flags;
7376 }
7377
7378 /**
7379  * gtk_widget_set_state:
7380  * @widget: a #GtkWidget
7381  * @state: new state for @widget
7382  *
7383  * This function is for use in widget implementations. Sets the state
7384  * of a widget (insensitive, prelighted, etc.) Usually you should set
7385  * the state using wrapper functions such as gtk_widget_set_sensitive().
7386  *
7387  * Deprecated: 3.0. Use gtk_widget_set_state_flags() instead.
7388  **/
7389 void
7390 gtk_widget_set_state (GtkWidget           *widget,
7391                       GtkStateType         state)
7392 {
7393   GtkStateFlags flags;
7394
7395   if (state == gtk_widget_get_state (widget))
7396     return;
7397
7398   switch (state)
7399     {
7400     case GTK_STATE_ACTIVE:
7401       flags = GTK_STATE_FLAG_ACTIVE;
7402       break;
7403     case GTK_STATE_PRELIGHT:
7404       flags = GTK_STATE_FLAG_PRELIGHT;
7405       break;
7406     case GTK_STATE_SELECTED:
7407       flags = GTK_STATE_FLAG_SELECTED;
7408       break;
7409     case GTK_STATE_INSENSITIVE:
7410       flags = GTK_STATE_FLAG_INSENSITIVE;
7411       break;
7412     case GTK_STATE_INCONSISTENT:
7413       flags = GTK_STATE_FLAG_INCONSISTENT;
7414       break;
7415     case GTK_STATE_FOCUSED:
7416       flags = GTK_STATE_FLAG_FOCUSED;
7417       break;
7418     case GTK_STATE_NORMAL:
7419     default:
7420       flags = 0;
7421       break;
7422     }
7423
7424   gtk_widget_update_state_flags (widget,
7425                                  flags,
7426                                  (GTK_STATE_FLAG_ACTIVE | GTK_STATE_FLAG_PRELIGHT | GTK_STATE_FLAG_SELECTED
7427                                  | GTK_STATE_FLAG_INSENSITIVE | GTK_STATE_FLAG_INCONSISTENT | GTK_STATE_FLAG_FOCUSED) ^ flags);
7428 }
7429
7430 /**
7431  * gtk_widget_get_state:
7432  * @widget: a #GtkWidget
7433  *
7434  * Returns the widget's state. See gtk_widget_set_state().
7435  *
7436  * Returns: the state of @widget.
7437  *
7438  * Since: 2.18
7439  *
7440  * Deprecated: 3.0. Use gtk_widget_get_state_flags() instead.
7441  */
7442 GtkStateType
7443 gtk_widget_get_state (GtkWidget *widget)
7444 {
7445   GtkStateFlags flags;
7446
7447   g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_STATE_NORMAL);
7448
7449   flags = gtk_widget_get_state_flags (widget);
7450
7451   if (flags & GTK_STATE_FLAG_INSENSITIVE)
7452     return GTK_STATE_INSENSITIVE;
7453   else if (flags & GTK_STATE_FLAG_ACTIVE)
7454     return GTK_STATE_ACTIVE;
7455   else if (flags & GTK_STATE_FLAG_SELECTED)
7456     return GTK_STATE_SELECTED;
7457   else if (flags & GTK_STATE_FLAG_PRELIGHT)
7458     return GTK_STATE_PRELIGHT;
7459   else
7460     return GTK_STATE_NORMAL;
7461 }
7462
7463 /**
7464  * gtk_widget_set_visible:
7465  * @widget: a #GtkWidget
7466  * @visible: whether the widget should be shown or not
7467  *
7468  * Sets the visibility state of @widget. Note that setting this to
7469  * %TRUE doesn't mean the widget is actually viewable, see
7470  * gtk_widget_get_visible().
7471  *
7472  * This function simply calls gtk_widget_show() or gtk_widget_hide()
7473  * but is nicer to use when the visibility of the widget depends on
7474  * some condition.
7475  *
7476  * Since: 2.18
7477  **/
7478 void
7479 gtk_widget_set_visible (GtkWidget *widget,
7480                         gboolean   visible)
7481 {
7482   g_return_if_fail (GTK_IS_WIDGET (widget));
7483
7484   if (visible != gtk_widget_get_visible (widget))
7485     {
7486       if (visible)
7487         gtk_widget_show (widget);
7488       else
7489         gtk_widget_hide (widget);
7490     }
7491 }
7492
7493 void
7494 _gtk_widget_set_visible_flag (GtkWidget *widget,
7495                               gboolean   visible)
7496 {
7497   widget->priv->visible = visible;
7498 }
7499
7500 /**
7501  * gtk_widget_get_visible:
7502  * @widget: a #GtkWidget
7503  *
7504  * Determines whether the widget is visible. If you want to
7505  * take into account whether the widget's parent is also marked as
7506  * visible, use gtk_widget_is_visible() instead.
7507  *
7508  * This function does not check if the widget is obscured in any way.
7509  *
7510  * See gtk_widget_set_visible().
7511  *
7512  * Return value: %TRUE if the widget is visible
7513  *
7514  * Since: 2.18
7515  **/
7516 gboolean
7517 gtk_widget_get_visible (GtkWidget *widget)
7518 {
7519   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7520
7521   return widget->priv->visible;
7522 }
7523
7524 /**
7525  * gtk_widget_is_visible:
7526  * @widget: a #GtkWidget
7527  *
7528  * Determines whether the widget and all its parents are marked as
7529  * visible.
7530  *
7531  * This function does not check if the widget is obscured in any way.
7532  *
7533  * See also gtk_widget_get_visible() and gtk_widget_set_visible()
7534  *
7535  * Return value: %TRUE if the widget and all its parents are visible
7536  *
7537  * Since: 3.8
7538  **/
7539 gboolean
7540 gtk_widget_is_visible (GtkWidget *widget)
7541 {
7542   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7543
7544   while (widget)
7545     {
7546       GtkWidgetPrivate *priv = widget->priv;
7547
7548       if (!priv->visible)
7549         return FALSE;
7550
7551       widget = priv->parent;
7552     }
7553
7554   return TRUE;
7555 }
7556
7557 /**
7558  * gtk_widget_set_has_window:
7559  * @widget: a #GtkWidget
7560  * @has_window: whether or not @widget has a window.
7561  *
7562  * Specifies whether @widget has a #GdkWindow of its own. Note that
7563  * all realized widgets have a non-%NULL "window" pointer
7564  * (gtk_widget_get_window() never returns a %NULL window when a widget
7565  * is realized), but for many of them it's actually the #GdkWindow of
7566  * one of its parent widgets. Widgets that do not create a %window for
7567  * themselves in #GtkWidget::realize must announce this by
7568  * calling this function with @has_window = %FALSE.
7569  *
7570  * This function should only be called by widget implementations,
7571  * and they should call it in their init() function.
7572  *
7573  * Since: 2.18
7574  **/
7575 void
7576 gtk_widget_set_has_window (GtkWidget *widget,
7577                            gboolean   has_window)
7578 {
7579   g_return_if_fail (GTK_IS_WIDGET (widget));
7580
7581   widget->priv->no_window = !has_window;
7582 }
7583
7584 /**
7585  * gtk_widget_get_has_window:
7586  * @widget: a #GtkWidget
7587  *
7588  * Determines whether @widget has a #GdkWindow of its own. See
7589  * gtk_widget_set_has_window().
7590  *
7591  * Return value: %TRUE if @widget has a window, %FALSE otherwise
7592  *
7593  * Since: 2.18
7594  **/
7595 gboolean
7596 gtk_widget_get_has_window (GtkWidget *widget)
7597 {
7598   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7599
7600   return ! widget->priv->no_window;
7601 }
7602
7603 /**
7604  * gtk_widget_is_toplevel:
7605  * @widget: a #GtkWidget
7606  *
7607  * Determines whether @widget is a toplevel widget.
7608  *
7609  * Currently only #GtkWindow and #GtkInvisible (and out-of-process
7610  * #GtkPlugs) are toplevel widgets. Toplevel widgets have no parent
7611  * widget.
7612  *
7613  * Return value: %TRUE if @widget is a toplevel, %FALSE otherwise
7614  *
7615  * Since: 2.18
7616  **/
7617 gboolean
7618 gtk_widget_is_toplevel (GtkWidget *widget)
7619 {
7620   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7621
7622   return widget->priv->toplevel;
7623 }
7624
7625 void
7626 _gtk_widget_set_is_toplevel (GtkWidget *widget,
7627                              gboolean   is_toplevel)
7628 {
7629   widget->priv->toplevel = is_toplevel;
7630 }
7631
7632 /**
7633  * gtk_widget_is_drawable:
7634  * @widget: a #GtkWidget
7635  *
7636  * Determines whether @widget can be drawn to. A widget can be drawn
7637  * to if it is mapped and visible.
7638  *
7639  * Return value: %TRUE if @widget is drawable, %FALSE otherwise
7640  *
7641  * Since: 2.18
7642  **/
7643 gboolean
7644 gtk_widget_is_drawable (GtkWidget *widget)
7645 {
7646   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7647
7648   return (gtk_widget_get_visible (widget) &&
7649           gtk_widget_get_mapped (widget));
7650 }
7651
7652 /**
7653  * gtk_widget_get_realized:
7654  * @widget: a #GtkWidget
7655  *
7656  * Determines whether @widget is realized.
7657  *
7658  * Return value: %TRUE if @widget is realized, %FALSE otherwise
7659  *
7660  * Since: 2.20
7661  **/
7662 gboolean
7663 gtk_widget_get_realized (GtkWidget *widget)
7664 {
7665   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7666
7667   return widget->priv->realized;
7668 }
7669
7670 /**
7671  * gtk_widget_set_realized:
7672  * @widget: a #GtkWidget
7673  * @realized: %TRUE to mark the widget as realized
7674  *
7675  * Marks the widget as being realized.
7676  *
7677  * This function should only ever be called in a derived widget's
7678  * "realize" or "unrealize" implementation.
7679  *
7680  * Since: 2.20
7681  */
7682 void
7683 gtk_widget_set_realized (GtkWidget *widget,
7684                          gboolean   realized)
7685 {
7686   g_return_if_fail (GTK_IS_WIDGET (widget));
7687
7688   widget->priv->realized = realized;
7689 }
7690
7691 /**
7692  * gtk_widget_get_mapped:
7693  * @widget: a #GtkWidget
7694  *
7695  * Whether the widget is mapped.
7696  *
7697  * Return value: %TRUE if the widget is mapped, %FALSE otherwise.
7698  *
7699  * Since: 2.20
7700  */
7701 gboolean
7702 gtk_widget_get_mapped (GtkWidget *widget)
7703 {
7704   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7705
7706   return widget->priv->mapped;
7707 }
7708
7709 /**
7710  * gtk_widget_set_mapped:
7711  * @widget: a #GtkWidget
7712  * @mapped: %TRUE to mark the widget as mapped
7713  *
7714  * Marks the widget as being realized.
7715  *
7716  * This function should only ever be called in a derived widget's
7717  * "map" or "unmap" implementation.
7718  *
7719  * Since: 2.20
7720  */
7721 void
7722 gtk_widget_set_mapped (GtkWidget *widget,
7723                        gboolean   mapped)
7724 {
7725   g_return_if_fail (GTK_IS_WIDGET (widget));
7726
7727   widget->priv->mapped = mapped;
7728 }
7729
7730 /**
7731  * gtk_widget_set_app_paintable:
7732  * @widget: a #GtkWidget
7733  * @app_paintable: %TRUE if the application will paint on the widget
7734  *
7735  * Sets whether the application intends to draw on the widget in
7736  * an #GtkWidget::draw handler.
7737  *
7738  * This is a hint to the widget and does not affect the behavior of
7739  * the GTK+ core; many widgets ignore this flag entirely. For widgets
7740  * that do pay attention to the flag, such as #GtkEventBox and #GtkWindow,
7741  * the effect is to suppress default themed drawing of the widget's
7742  * background. (Children of the widget will still be drawn.) The application
7743  * is then entirely responsible for drawing the widget background.
7744  *
7745  * Note that the background is still drawn when the widget is mapped.
7746  **/
7747 void
7748 gtk_widget_set_app_paintable (GtkWidget *widget,
7749                               gboolean   app_paintable)
7750 {
7751   g_return_if_fail (GTK_IS_WIDGET (widget));
7752
7753   app_paintable = (app_paintable != FALSE);
7754
7755   if (widget->priv->app_paintable != app_paintable)
7756     {
7757       widget->priv->app_paintable = app_paintable;
7758
7759       if (gtk_widget_is_drawable (widget))
7760         gtk_widget_queue_draw (widget);
7761
7762       g_object_notify (G_OBJECT (widget), "app-paintable");
7763     }
7764 }
7765
7766 /**
7767  * gtk_widget_get_app_paintable:
7768  * @widget: a #GtkWidget
7769  *
7770  * Determines whether the application intends to draw on the widget in
7771  * an #GtkWidget::draw handler.
7772  *
7773  * See gtk_widget_set_app_paintable()
7774  *
7775  * Return value: %TRUE if the widget is app paintable
7776  *
7777  * Since: 2.18
7778  **/
7779 gboolean
7780 gtk_widget_get_app_paintable (GtkWidget *widget)
7781 {
7782   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7783
7784   return widget->priv->app_paintable;
7785 }
7786
7787 /**
7788  * gtk_widget_set_double_buffered:
7789  * @widget: a #GtkWidget
7790  * @double_buffered: %TRUE to double-buffer a widget
7791  *
7792  * Widgets are double buffered by default; you can use this function
7793  * to turn off the buffering. "Double buffered" simply means that
7794  * gdk_window_begin_paint_region() and gdk_window_end_paint() are called
7795  * automatically around expose events sent to the
7796  * widget. gdk_window_begin_paint_region() diverts all drawing to a widget's
7797  * window to an offscreen buffer, and gdk_window_end_paint() draws the
7798  * buffer to the screen. The result is that users see the window
7799  * update in one smooth step, and don't see individual graphics
7800  * primitives being rendered.
7801  *
7802  * In very simple terms, double buffered widgets don't flicker,
7803  * so you would only use this function to turn off double buffering
7804  * if you had special needs and really knew what you were doing.
7805  *
7806  * Note: if you turn off double-buffering, you have to handle
7807  * expose events, since even the clearing to the background color or
7808  * pixmap will not happen automatically (as it is done in
7809  * gdk_window_begin_paint_region()).
7810  **/
7811 void
7812 gtk_widget_set_double_buffered (GtkWidget *widget,
7813                                 gboolean   double_buffered)
7814 {
7815   g_return_if_fail (GTK_IS_WIDGET (widget));
7816
7817   double_buffered = (double_buffered != FALSE);
7818
7819   if (widget->priv->double_buffered != double_buffered)
7820     {
7821       widget->priv->double_buffered = double_buffered;
7822
7823       g_object_notify (G_OBJECT (widget), "double-buffered");
7824     }
7825 }
7826
7827 /**
7828  * gtk_widget_get_double_buffered:
7829  * @widget: a #GtkWidget
7830  *
7831  * Determines whether the widget is double buffered.
7832  *
7833  * See gtk_widget_set_double_buffered()
7834  *
7835  * Return value: %TRUE if the widget is double buffered
7836  *
7837  * Since: 2.18
7838  **/
7839 gboolean
7840 gtk_widget_get_double_buffered (GtkWidget *widget)
7841 {
7842   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7843
7844   return widget->priv->double_buffered;
7845 }
7846
7847 /**
7848  * gtk_widget_set_redraw_on_allocate:
7849  * @widget: a #GtkWidget
7850  * @redraw_on_allocate: if %TRUE, the entire widget will be redrawn
7851  *   when it is allocated to a new size. Otherwise, only the
7852  *   new portion of the widget will be redrawn.
7853  *
7854  * Sets whether the entire widget is queued for drawing when its size
7855  * allocation changes. By default, this setting is %TRUE and
7856  * the entire widget is redrawn on every size change. If your widget
7857  * leaves the upper left unchanged when made bigger, turning this
7858  * setting off will improve performance.
7859
7860  * Note that for %NO_WINDOW widgets setting this flag to %FALSE turns
7861  * off all allocation on resizing: the widget will not even redraw if
7862  * its position changes; this is to allow containers that don't draw
7863  * anything to avoid excess invalidations. If you set this flag on a
7864  * %NO_WINDOW widget that <emphasis>does</emphasis> draw on @widget->window,
7865  * you are responsible for invalidating both the old and new allocation
7866  * of the widget when the widget is moved and responsible for invalidating
7867  * regions newly when the widget increases size.
7868  **/
7869 void
7870 gtk_widget_set_redraw_on_allocate (GtkWidget *widget,
7871                                    gboolean   redraw_on_allocate)
7872 {
7873   g_return_if_fail (GTK_IS_WIDGET (widget));
7874
7875   widget->priv->redraw_on_alloc = redraw_on_allocate;
7876 }
7877
7878 /**
7879  * gtk_widget_set_sensitive:
7880  * @widget: a #GtkWidget
7881  * @sensitive: %TRUE to make the widget sensitive
7882  *
7883  * Sets the sensitivity of a widget. A widget is sensitive if the user
7884  * can interact with it. Insensitive widgets are "grayed out" and the
7885  * user can't interact with them. Insensitive widgets are known as
7886  * "inactive", "disabled", or "ghosted" in some other toolkits.
7887  **/
7888 void
7889 gtk_widget_set_sensitive (GtkWidget *widget,
7890                           gboolean   sensitive)
7891 {
7892   GtkWidgetPrivate *priv;
7893
7894   g_return_if_fail (GTK_IS_WIDGET (widget));
7895
7896   priv = widget->priv;
7897
7898   sensitive = (sensitive != FALSE);
7899
7900   if (priv->sensitive == sensitive)
7901     return;
7902
7903   priv->sensitive = sensitive;
7904
7905   if (priv->parent == NULL
7906       || gtk_widget_is_sensitive (priv->parent))
7907     {
7908       GtkStateData data;
7909
7910       if (sensitive)
7911         {
7912           data.flags_to_set = 0;
7913           data.flags_to_unset = GTK_STATE_FLAG_INSENSITIVE;
7914         }
7915       else
7916         {
7917           data.flags_to_set = GTK_STATE_FLAG_INSENSITIVE;
7918           data.flags_to_unset = 0;
7919         }
7920
7921       gtk_widget_propagate_state (widget, &data);
7922
7923       gtk_widget_queue_resize (widget);
7924     }
7925
7926   g_object_notify (G_OBJECT (widget), "sensitive");
7927 }
7928
7929 /**
7930  * gtk_widget_get_sensitive:
7931  * @widget: a #GtkWidget
7932  *
7933  * Returns the widget's sensitivity (in the sense of returning
7934  * the value that has been set using gtk_widget_set_sensitive()).
7935  *
7936  * The effective sensitivity of a widget is however determined by both its
7937  * own and its parent widget's sensitivity. See gtk_widget_is_sensitive().
7938  *
7939  * Returns: %TRUE if the widget is sensitive
7940  *
7941  * Since: 2.18
7942  */
7943 gboolean
7944 gtk_widget_get_sensitive (GtkWidget *widget)
7945 {
7946   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7947
7948   return widget->priv->sensitive;
7949 }
7950
7951 /**
7952  * gtk_widget_is_sensitive:
7953  * @widget: a #GtkWidget
7954  *
7955  * Returns the widget's effective sensitivity, which means
7956  * it is sensitive itself and also its parent widget is sensitive
7957  *
7958  * Returns: %TRUE if the widget is effectively sensitive
7959  *
7960  * Since: 2.18
7961  */
7962 gboolean
7963 gtk_widget_is_sensitive (GtkWidget *widget)
7964 {
7965   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7966
7967   return !(widget->priv->state_flags & GTK_STATE_FLAG_INSENSITIVE);
7968 }
7969
7970 /**
7971  * gtk_widget_set_parent:
7972  * @widget: a #GtkWidget
7973  * @parent: parent container
7974  *
7975  * This function is useful only when implementing subclasses of
7976  * #GtkContainer.
7977  * Sets the container as the parent of @widget, and takes care of
7978  * some details such as updating the state and style of the child
7979  * to reflect its new location. The opposite function is
7980  * gtk_widget_unparent().
7981  **/
7982 void
7983 gtk_widget_set_parent (GtkWidget *widget,
7984                        GtkWidget *parent)
7985 {
7986   GtkStateFlags parent_flags;
7987   GtkWidgetPrivate *priv;
7988   GtkStateData data;
7989
7990   g_return_if_fail (GTK_IS_WIDGET (widget));
7991   g_return_if_fail (GTK_IS_WIDGET (parent));
7992   g_return_if_fail (widget != parent);
7993
7994   priv = widget->priv;
7995
7996   if (priv->parent != NULL)
7997     {
7998       g_warning ("Can't set a parent on widget which has a parent\n");
7999       return;
8000     }
8001   if (gtk_widget_is_toplevel (widget))
8002     {
8003       g_warning ("Can't set a parent on a toplevel widget\n");
8004       return;
8005     }
8006
8007   /* keep this function in sync with gtk_menu_attach_to_widget()
8008    */
8009
8010   g_object_ref_sink (widget);
8011
8012   gtk_widget_push_verify_invariants (widget);
8013
8014   priv->parent = parent;
8015
8016   parent_flags = gtk_widget_get_state_flags (parent);
8017
8018   /* Merge both old state and current parent state,
8019    * making sure to only propagate the right states */
8020   data.flags_to_set = parent_flags & GTK_STATE_FLAGS_DO_PROPAGATE;
8021   data.flags_to_unset = 0;
8022   gtk_widget_propagate_state (widget, &data);
8023
8024   if (priv->context)
8025     gtk_style_context_set_parent (priv->context,
8026                                   gtk_widget_get_style_context (parent));
8027
8028   _gtk_widget_update_parent_muxer (widget);
8029
8030   g_signal_emit (widget, widget_signals[PARENT_SET], 0, NULL);
8031   if (priv->parent->priv->anchored)
8032     _gtk_widget_propagate_hierarchy_changed (widget, NULL);
8033   g_object_notify (G_OBJECT (widget), "parent");
8034
8035   /* Enforce realized/mapped invariants
8036    */
8037   if (gtk_widget_get_realized (priv->parent))
8038     gtk_widget_realize (widget);
8039
8040   if (gtk_widget_get_visible (priv->parent) &&
8041       gtk_widget_get_visible (widget))
8042     {
8043       if (gtk_widget_get_child_visible (widget) &&
8044           gtk_widget_get_mapped (priv->parent))
8045         gtk_widget_map (widget);
8046
8047       gtk_widget_queue_resize (widget);
8048     }
8049
8050   /* child may cause parent's expand to change, if the child is
8051    * expanded. If child is not expanded, then it can't modify the
8052    * parent's expand. If the child becomes expanded later then it will
8053    * queue compute_expand then. This optimization plus defaulting
8054    * newly-constructed widgets to need_compute_expand=FALSE should
8055    * mean that initially building a widget tree doesn't have to keep
8056    * walking up setting need_compute_expand on parents over and over.
8057    *
8058    * We can't change a parent to need to expand unless we're visible.
8059    */
8060   if (gtk_widget_get_visible (widget) &&
8061       (priv->need_compute_expand ||
8062        priv->computed_hexpand ||
8063        priv->computed_vexpand))
8064     {
8065       gtk_widget_queue_compute_expand (parent);
8066     }
8067
8068   gtk_widget_pop_verify_invariants (widget);
8069 }
8070
8071 /**
8072  * gtk_widget_get_parent:
8073  * @widget: a #GtkWidget
8074  *
8075  * Returns the parent container of @widget.
8076  *
8077  * Return value: (transfer none): the parent container of @widget, or %NULL
8078  **/
8079 GtkWidget *
8080 gtk_widget_get_parent (GtkWidget *widget)
8081 {
8082   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8083
8084   return widget->priv->parent;
8085 }
8086
8087 static void
8088 modifier_style_changed (GtkModifierStyle *style,
8089                         GtkWidget        *widget)
8090 {
8091   _gtk_widget_invalidate_style_context (widget, GTK_CSS_CHANGE_ANY);
8092 }
8093
8094 static GtkModifierStyle *
8095 _gtk_widget_get_modifier_properties (GtkWidget *widget)
8096 {
8097   GtkModifierStyle *style;
8098
8099   style = g_object_get_qdata (G_OBJECT (widget), quark_modifier_style);
8100
8101   if (G_UNLIKELY (!style))
8102     {
8103       GtkStyleContext *context;
8104
8105       style = _gtk_modifier_style_new ();
8106       g_object_set_qdata_full (G_OBJECT (widget),
8107                                quark_modifier_style,
8108                                style,
8109                                (GDestroyNotify) g_object_unref);
8110
8111       g_signal_connect (style, "changed",
8112                         G_CALLBACK (modifier_style_changed), widget);
8113
8114       context = gtk_widget_get_style_context (widget);
8115
8116       gtk_style_context_add_provider (context,
8117                                       GTK_STYLE_PROVIDER (style),
8118                                       GTK_STYLE_PROVIDER_PRIORITY_APPLICATION);
8119     }
8120
8121   return style;
8122 }
8123
8124 /**
8125  * gtk_widget_override_color:
8126  * @widget: a #GtkWidget
8127  * @state: the state for which to set the color
8128  * @color: (allow-none): the color to assign, or %NULL to undo the effect
8129  *     of previous calls to gtk_widget_override_color()
8130  *
8131  * Sets the color to use for a widget.
8132  *
8133  * All other style values are left untouched.
8134  *
8135  * <note><para>
8136  * This API is mostly meant as a quick way for applications to
8137  * change a widget appearance. If you are developing a widgets
8138  * library and intend this change to be themeable, it is better
8139  * done by setting meaningful CSS classes and regions in your
8140  * widget/container implementation through gtk_style_context_add_class()
8141  * and gtk_style_context_add_region().
8142  * </para><para>
8143  * This way, your widget library can install a #GtkCssProvider
8144  * with the %GTK_STYLE_PROVIDER_PRIORITY_FALLBACK priority in order
8145  * to provide a default styling for those widgets that need so, and
8146  * this theming may fully overridden by the user's theme.
8147  * </para></note>
8148  * <note><para>
8149  * Note that for complex widgets this may bring in undesired
8150  * results (such as uniform background color everywhere), in
8151  * these cases it is better to fully style such widgets through a
8152  * #GtkCssProvider with the %GTK_STYLE_PROVIDER_PRIORITY_APPLICATION
8153  * priority.
8154  * </para></note>
8155  *
8156  * Since: 3.0
8157  */
8158 void
8159 gtk_widget_override_color (GtkWidget     *widget,
8160                            GtkStateFlags  state,
8161                            const GdkRGBA *color)
8162 {
8163   GtkModifierStyle *style;
8164
8165   g_return_if_fail (GTK_IS_WIDGET (widget));
8166
8167   style = _gtk_widget_get_modifier_properties (widget);
8168   _gtk_modifier_style_set_color (style, state, color);
8169 }
8170
8171 /**
8172  * gtk_widget_override_background_color:
8173  * @widget: a #GtkWidget
8174  * @state: the state for which to set the background color
8175  * @color: (allow-none): the color to assign, or %NULL to undo the effect
8176  *     of previous calls to gtk_widget_override_background_color()
8177  *
8178  * Sets the background color to use for a widget.
8179  *
8180  * All other style values are left untouched.
8181  * See gtk_widget_override_color().
8182  *
8183  * Since: 3.0
8184  */
8185 void
8186 gtk_widget_override_background_color (GtkWidget     *widget,
8187                                       GtkStateFlags  state,
8188                                       const GdkRGBA *color)
8189 {
8190   GtkModifierStyle *style;
8191
8192   g_return_if_fail (GTK_IS_WIDGET (widget));
8193
8194   style = _gtk_widget_get_modifier_properties (widget);
8195   _gtk_modifier_style_set_background_color (style, state, color);
8196 }
8197
8198 /**
8199  * gtk_widget_override_font:
8200  * @widget: a #GtkWidget
8201  * @font_desc: (allow-none): the font descriptiong to use, or %NULL to undo
8202  *     the effect of previous calls to gtk_widget_override_font()
8203  *
8204  * Sets the font to use for a widget. All other style values are
8205  * left untouched. See gtk_widget_override_color().
8206  *
8207  * Since: 3.0
8208  */
8209 void
8210 gtk_widget_override_font (GtkWidget                  *widget,
8211                           const PangoFontDescription *font_desc)
8212 {
8213   GtkModifierStyle *style;
8214
8215   g_return_if_fail (GTK_IS_WIDGET (widget));
8216
8217   style = _gtk_widget_get_modifier_properties (widget);
8218   _gtk_modifier_style_set_font (style, font_desc);
8219 }
8220
8221 /**
8222  * gtk_widget_override_symbolic_color:
8223  * @widget: a #GtkWidget
8224  * @name: the name of the symbolic color to modify
8225  * @color: (allow-none): the color to assign (does not need
8226  *     to be allocated), or %NULL to undo the effect of previous
8227  *     calls to gtk_widget_override_symbolic_color()
8228  *
8229  * Sets a symbolic color for a widget.
8230  *
8231  * All other style values are left untouched.
8232  * See gtk_widget_override_color() for overriding the foreground
8233  * or background color.
8234  *
8235  * Since: 3.0
8236  */
8237 void
8238 gtk_widget_override_symbolic_color (GtkWidget     *widget,
8239                                     const gchar   *name,
8240                                     const GdkRGBA *color)
8241 {
8242   GtkModifierStyle *style;
8243
8244   g_return_if_fail (GTK_IS_WIDGET (widget));
8245
8246   style = _gtk_widget_get_modifier_properties (widget);
8247   _gtk_modifier_style_map_color (style, name, color);
8248 }
8249
8250 /**
8251  * gtk_widget_override_cursor:
8252  * @widget: a #GtkWidget
8253  * @cursor: (allow-none): the color to use for primary cursor (does not need to be
8254  *     allocated), or %NULL to undo the effect of previous calls to
8255  *     of gtk_widget_override_cursor().
8256  * @secondary_cursor: (allow-none): the color to use for secondary cursor (does not
8257  *     need to be allocated), or %NULL to undo the effect of previous
8258  *     calls to of gtk_widget_override_cursor().
8259  *
8260  * Sets the cursor color to use in a widget, overriding the
8261  * #GtkWidget:cursor-color and #GtkWidget:secondary-cursor-color
8262  * style properties. All other style values are left untouched.
8263  * See also gtk_widget_modify_style().
8264  *
8265  * Note that the underlying properties have the #GdkColor type,
8266  * so the alpha value in @primary and @secondary will be ignored.
8267  *
8268  * Since: 3.0
8269  */
8270 void
8271 gtk_widget_override_cursor (GtkWidget     *widget,
8272                             const GdkRGBA *cursor,
8273                             const GdkRGBA *secondary_cursor)
8274 {
8275   GtkModifierStyle *style;
8276
8277   g_return_if_fail (GTK_IS_WIDGET (widget));
8278
8279   style = _gtk_widget_get_modifier_properties (widget);
8280   _gtk_modifier_style_set_color_property (style,
8281                                           GTK_TYPE_WIDGET,
8282                                           "cursor-color", cursor);
8283   _gtk_modifier_style_set_color_property (style,
8284                                           GTK_TYPE_WIDGET,
8285                                           "secondary-cursor-color",
8286                                           secondary_cursor);
8287 }
8288
8289 static void
8290 gtk_widget_real_direction_changed (GtkWidget        *widget,
8291                                    GtkTextDirection  previous_direction)
8292 {
8293   gtk_widget_queue_resize (widget);
8294 }
8295
8296 static void
8297 gtk_widget_real_style_set (GtkWidget *widget,
8298                            GtkStyle  *previous_style)
8299 {
8300 }
8301
8302 typedef struct {
8303   GtkWidget *previous_toplevel;
8304   GdkScreen *previous_screen;
8305   GdkScreen *new_screen;
8306 } HierarchyChangedInfo;
8307
8308 static void
8309 do_screen_change (GtkWidget *widget,
8310                   GdkScreen *old_screen,
8311                   GdkScreen *new_screen)
8312 {
8313   if (old_screen != new_screen)
8314     {
8315       GtkWidgetPrivate *priv = widget->priv;
8316
8317       if (old_screen)
8318         {
8319           PangoContext *context = g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
8320           if (context)
8321             g_object_set_qdata (G_OBJECT (widget), quark_pango_context, NULL);
8322         }
8323
8324       _gtk_tooltip_hide (widget);
8325
8326       if (new_screen && priv->context)
8327         gtk_style_context_set_screen (priv->context, new_screen);
8328
8329       g_signal_emit (widget, widget_signals[SCREEN_CHANGED], 0, old_screen);
8330     }
8331 }
8332
8333 static void
8334 gtk_widget_propagate_hierarchy_changed_recurse (GtkWidget *widget,
8335                                                 gpointer   client_data)
8336 {
8337   GtkWidgetPrivate *priv = widget->priv;
8338   HierarchyChangedInfo *info = client_data;
8339   gboolean new_anchored = gtk_widget_is_toplevel (widget) ||
8340                  (priv->parent && priv->parent->priv->anchored);
8341
8342   if (priv->anchored != new_anchored)
8343     {
8344       g_object_ref (widget);
8345
8346       priv->anchored = new_anchored;
8347
8348       g_signal_emit (widget, widget_signals[HIERARCHY_CHANGED], 0, info->previous_toplevel);
8349       do_screen_change (widget, info->previous_screen, info->new_screen);
8350
8351       if (GTK_IS_CONTAINER (widget))
8352         gtk_container_forall (GTK_CONTAINER (widget),
8353                               gtk_widget_propagate_hierarchy_changed_recurse,
8354                               client_data);
8355
8356       g_object_unref (widget);
8357     }
8358 }
8359
8360 /**
8361  * _gtk_widget_propagate_hierarchy_changed:
8362  * @widget: a #GtkWidget
8363  * @previous_toplevel: Previous toplevel
8364  *
8365  * Propagates changes in the anchored state to a widget and all
8366  * children, unsetting or setting the %ANCHORED flag, and
8367  * emitting #GtkWidget::hierarchy-changed.
8368  **/
8369 void
8370 _gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
8371                                          GtkWidget *previous_toplevel)
8372 {
8373   GtkWidgetPrivate *priv = widget->priv;
8374   HierarchyChangedInfo info;
8375
8376   info.previous_toplevel = previous_toplevel;
8377   info.previous_screen = previous_toplevel ? gtk_widget_get_screen (previous_toplevel) : NULL;
8378
8379   if (gtk_widget_is_toplevel (widget) ||
8380       (priv->parent && priv->parent->priv->anchored))
8381     info.new_screen = gtk_widget_get_screen (widget);
8382   else
8383     info.new_screen = NULL;
8384
8385   if (info.previous_screen)
8386     g_object_ref (info.previous_screen);
8387   if (previous_toplevel)
8388     g_object_ref (previous_toplevel);
8389
8390   gtk_widget_propagate_hierarchy_changed_recurse (widget, &info);
8391
8392   if (previous_toplevel)
8393     g_object_unref (previous_toplevel);
8394   if (info.previous_screen)
8395     g_object_unref (info.previous_screen);
8396 }
8397
8398 static void
8399 gtk_widget_propagate_screen_changed_recurse (GtkWidget *widget,
8400                                              gpointer   client_data)
8401 {
8402   HierarchyChangedInfo *info = client_data;
8403
8404   g_object_ref (widget);
8405
8406   do_screen_change (widget, info->previous_screen, info->new_screen);
8407
8408   if (GTK_IS_CONTAINER (widget))
8409     gtk_container_forall (GTK_CONTAINER (widget),
8410                           gtk_widget_propagate_screen_changed_recurse,
8411                           client_data);
8412
8413   g_object_unref (widget);
8414 }
8415
8416 /**
8417  * gtk_widget_is_composited:
8418  * @widget: a #GtkWidget
8419  *
8420  * Whether @widget can rely on having its alpha channel
8421  * drawn correctly. On X11 this function returns whether a
8422  * compositing manager is running for @widget's screen.
8423  *
8424  * Please note that the semantics of this call will change
8425  * in the future if used on a widget that has a composited
8426  * window in its hierarchy (as set by gdk_window_set_composited()).
8427  *
8428  * Return value: %TRUE if the widget can rely on its alpha
8429  * channel being drawn correctly.
8430  *
8431  * Since: 2.10
8432  */
8433 gboolean
8434 gtk_widget_is_composited (GtkWidget *widget)
8435 {
8436   GdkScreen *screen;
8437
8438   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
8439
8440   screen = gtk_widget_get_screen (widget);
8441
8442   return gdk_screen_is_composited (screen);
8443 }
8444
8445 static void
8446 propagate_composited_changed (GtkWidget *widget,
8447                               gpointer dummy)
8448 {
8449   if (GTK_IS_CONTAINER (widget))
8450     {
8451       gtk_container_forall (GTK_CONTAINER (widget),
8452                             propagate_composited_changed,
8453                             NULL);
8454     }
8455
8456   g_signal_emit (widget, widget_signals[COMPOSITED_CHANGED], 0);
8457 }
8458
8459 void
8460 _gtk_widget_propagate_composited_changed (GtkWidget *widget)
8461 {
8462   propagate_composited_changed (widget, NULL);
8463 }
8464
8465 /**
8466  * _gtk_widget_propagate_screen_changed:
8467  * @widget: a #GtkWidget
8468  * @previous_screen: Previous screen
8469  *
8470  * Propagates changes in the screen for a widget to all
8471  * children, emitting #GtkWidget::screen-changed.
8472  **/
8473 void
8474 _gtk_widget_propagate_screen_changed (GtkWidget    *widget,
8475                                       GdkScreen    *previous_screen)
8476 {
8477   HierarchyChangedInfo info;
8478
8479   info.previous_screen = previous_screen;
8480   info.new_screen = gtk_widget_get_screen (widget);
8481
8482   if (previous_screen)
8483     g_object_ref (previous_screen);
8484
8485   gtk_widget_propagate_screen_changed_recurse (widget, &info);
8486
8487   if (previous_screen)
8488     g_object_unref (previous_screen);
8489 }
8490
8491 static void
8492 reset_style_recurse (GtkWidget *widget, gpointer data)
8493 {
8494   _gtk_widget_invalidate_style_context (widget, GTK_CSS_CHANGE_ANY);
8495
8496   if (GTK_IS_CONTAINER (widget))
8497     gtk_container_forall (GTK_CONTAINER (widget),
8498                           reset_style_recurse,
8499                           NULL);
8500 }
8501
8502 /**
8503  * gtk_widget_reset_style:
8504  * @widget: a #GtkWidget
8505  *
8506  * Updates the style context of @widget and all descendents
8507  * by updating its widget path. #GtkContainer<!-- -->s may want
8508  * to use this on a child when reordering it in a way that a different
8509  * style might apply to it. See also gtk_container_get_path_for_child().
8510  *
8511  * Since: 3.0
8512  */
8513 void
8514 gtk_widget_reset_style (GtkWidget *widget)
8515 {
8516   g_return_if_fail (GTK_IS_WIDGET (widget));
8517
8518   reset_style_recurse (widget, NULL);
8519
8520   g_list_foreach (widget->priv->attached_windows,
8521                   (GFunc) reset_style_recurse, NULL);
8522 }
8523
8524 #ifdef G_ENABLE_DEBUG
8525
8526 /* Verify invariants, see docs/widget_system.txt for notes on much of
8527  * this.  Invariants may be temporarily broken while we're in the
8528  * process of updating state, of course, so you can only
8529  * verify_invariants() after a given operation is complete.
8530  * Use push/pop_verify_invariants to help with that.
8531  */
8532 static void
8533 gtk_widget_verify_invariants (GtkWidget *widget)
8534 {
8535   GtkWidget *parent;
8536
8537   if (widget->priv->verifying_invariants_count > 0)
8538     return;
8539
8540   parent = widget->priv->parent;
8541
8542   if (widget->priv->mapped)
8543     {
8544       /* Mapped implies ... */
8545
8546       if (!widget->priv->realized)
8547         g_warning ("%s %p is mapped but not realized",
8548                    G_OBJECT_TYPE_NAME (widget), widget);
8549
8550       if (!widget->priv->visible)
8551         g_warning ("%s %p is mapped but not visible",
8552                    G_OBJECT_TYPE_NAME (widget), widget);
8553
8554       if (!widget->priv->toplevel)
8555         {
8556           if (!widget->priv->child_visible)
8557             g_warning ("%s %p is mapped but not child_visible",
8558                        G_OBJECT_TYPE_NAME (widget), widget);
8559         }
8560     }
8561   else
8562     {
8563       /* Not mapped implies... */
8564
8565 #if 0
8566   /* This check makes sense for normal toplevels, but for
8567    * something like a toplevel that is embedded within a clutter
8568    * state, mapping may depend on external factors.
8569    */
8570       if (widget->priv->toplevel)
8571         {
8572           if (widget->priv->visible)
8573             g_warning ("%s %p toplevel is visible but not mapped",
8574                        G_OBJECT_TYPE_NAME (widget), widget);
8575         }
8576 #endif
8577     }
8578
8579   /* Parent related checks aren't possible if parent has
8580    * verifying_invariants_count > 0 because parent needs to recurse
8581    * children first before the invariants will hold.
8582    */
8583   if (parent == NULL || parent->priv->verifying_invariants_count == 0)
8584     {
8585       if (parent &&
8586           parent->priv->realized)
8587         {
8588           /* Parent realized implies... */
8589
8590 #if 0
8591           /* This is in widget_system.txt but appears to fail
8592            * because there's no gtk_container_realize() that
8593            * realizes all children... instead we just lazily
8594            * wait for map to fix things up.
8595            */
8596           if (!widget->priv->realized)
8597             g_warning ("%s %p is realized but child %s %p is not realized",
8598                        G_OBJECT_TYPE_NAME (parent), parent,
8599                        G_OBJECT_TYPE_NAME (widget), widget);
8600 #endif
8601         }
8602       else if (!widget->priv->toplevel)
8603         {
8604           /* No parent or parent not realized on non-toplevel implies... */
8605
8606           if (widget->priv->realized && !widget->priv->in_reparent)
8607             g_warning ("%s %p is not realized but child %s %p is realized",
8608                        parent ? G_OBJECT_TYPE_NAME (parent) : "no parent", parent,
8609                        G_OBJECT_TYPE_NAME (widget), widget);
8610         }
8611
8612       if (parent &&
8613           parent->priv->mapped &&
8614           widget->priv->visible &&
8615           widget->priv->child_visible)
8616         {
8617           /* Parent mapped and we are visible implies... */
8618
8619           if (!widget->priv->mapped)
8620             g_warning ("%s %p is mapped but visible child %s %p is not mapped",
8621                        G_OBJECT_TYPE_NAME (parent), parent,
8622                        G_OBJECT_TYPE_NAME (widget), widget);
8623         }
8624       else if (!widget->priv->toplevel)
8625         {
8626           /* No parent or parent not mapped on non-toplevel implies... */
8627
8628           if (widget->priv->mapped && !widget->priv->in_reparent)
8629             g_warning ("%s %p is mapped but visible=%d child_visible=%d parent %s %p mapped=%d",
8630                        G_OBJECT_TYPE_NAME (widget), widget,
8631                        widget->priv->visible,
8632                        widget->priv->child_visible,
8633                        parent ? G_OBJECT_TYPE_NAME (parent) : "no parent", parent,
8634                        parent ? parent->priv->mapped : FALSE);
8635         }
8636     }
8637
8638   if (!widget->priv->realized)
8639     {
8640       /* Not realized implies... */
8641
8642 #if 0
8643       /* widget_system.txt says these hold, but they don't. */
8644       if (widget->priv->alloc_needed)
8645         g_warning ("%s %p alloc needed but not realized",
8646                    G_OBJECT_TYPE_NAME (widget), widget);
8647
8648       if (widget->priv->width_request_needed)
8649         g_warning ("%s %p width request needed but not realized",
8650                    G_OBJECT_TYPE_NAME (widget), widget);
8651
8652       if (widget->priv->height_request_needed)
8653         g_warning ("%s %p height request needed but not realized",
8654                    G_OBJECT_TYPE_NAME (widget), widget);
8655 #endif
8656     }
8657 }
8658
8659 /* The point of this push/pop is that invariants may not hold while
8660  * we're busy making changes. So we only check at the outermost call
8661  * on the call stack, after we finish updating everything.
8662  */
8663 static void
8664 gtk_widget_push_verify_invariants (GtkWidget *widget)
8665 {
8666   widget->priv->verifying_invariants_count += 1;
8667 }
8668
8669 static void
8670 gtk_widget_verify_child_invariants (GtkWidget *widget,
8671                                     gpointer   client_data)
8672 {
8673   /* We don't recurse further; this is a one-level check. */
8674   gtk_widget_verify_invariants (widget);
8675 }
8676
8677 static void
8678 gtk_widget_pop_verify_invariants (GtkWidget *widget)
8679 {
8680   g_assert (widget->priv->verifying_invariants_count > 0);
8681
8682   widget->priv->verifying_invariants_count -= 1;
8683
8684   if (widget->priv->verifying_invariants_count == 0)
8685     {
8686       gtk_widget_verify_invariants (widget);
8687
8688       if (GTK_IS_CONTAINER (widget))
8689         {
8690           /* Check one level of children, because our
8691            * push_verify_invariants() will have prevented some of the
8692            * checks. This does not recurse because if recursion is
8693            * needed, it will happen naturally as each child has a
8694            * push/pop on that child. For example if we're recursively
8695            * mapping children, we'll push/pop on each child as we map
8696            * it.
8697            */
8698           gtk_container_forall (GTK_CONTAINER (widget),
8699                                 gtk_widget_verify_child_invariants,
8700                                 NULL);
8701         }
8702     }
8703 }
8704 #endif /* G_ENABLE_DEBUG */
8705
8706 static PangoContext *
8707 gtk_widget_peek_pango_context (GtkWidget *widget)
8708 {
8709   return g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
8710 }
8711
8712 /**
8713  * gtk_widget_get_pango_context:
8714  * @widget: a #GtkWidget
8715  *
8716  * Gets a #PangoContext with the appropriate font map, font description,
8717  * and base direction for this widget. Unlike the context returned
8718  * by gtk_widget_create_pango_context(), this context is owned by
8719  * the widget (it can be used until the screen for the widget changes
8720  * or the widget is removed from its toplevel), and will be updated to
8721  * match any changes to the widget's attributes. This can be tracked
8722  * by using the #GtkWidget::screen-changed signal on the widget.
8723  *
8724  * Return value: (transfer none): the #PangoContext for the widget.
8725  **/
8726 PangoContext *
8727 gtk_widget_get_pango_context (GtkWidget *widget)
8728 {
8729   PangoContext *context;
8730
8731   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8732
8733   context = g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
8734   if (!context)
8735     {
8736       context = gtk_widget_create_pango_context (GTK_WIDGET (widget));
8737       g_object_set_qdata_full (G_OBJECT (widget),
8738                                quark_pango_context,
8739                                context,
8740                                g_object_unref);
8741     }
8742
8743   return context;
8744 }
8745
8746 static void
8747 update_pango_context (GtkWidget    *widget,
8748                       PangoContext *context)
8749 {
8750   PangoFontDescription *font_desc;
8751   GtkStyleContext *style_context;
8752
8753   style_context = gtk_widget_get_style_context (widget);
8754   gtk_style_context_get (style_context,
8755                          gtk_widget_get_state_flags (widget),
8756                          "font", &font_desc,
8757                          NULL);
8758
8759   pango_context_set_font_description (context, font_desc);
8760   pango_context_set_base_dir (context,
8761                               gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR ?
8762                               PANGO_DIRECTION_LTR : PANGO_DIRECTION_RTL);
8763
8764   pango_font_description_free (font_desc);
8765 }
8766
8767 static void
8768 gtk_widget_update_pango_context (GtkWidget *widget)
8769 {
8770   PangoContext *context = gtk_widget_peek_pango_context (widget);
8771
8772   if (context)
8773     {
8774       GdkScreen *screen;
8775
8776       update_pango_context (widget, context);
8777
8778       screen = gtk_widget_get_screen_unchecked (widget);
8779       if (screen)
8780         {
8781           pango_cairo_context_set_resolution (context,
8782                                               gdk_screen_get_resolution (screen));
8783           pango_cairo_context_set_font_options (context,
8784                                                 gdk_screen_get_font_options (screen));
8785         }
8786     }
8787 }
8788
8789 /**
8790  * gtk_widget_create_pango_context:
8791  * @widget: a #GtkWidget
8792  *
8793  * Creates a new #PangoContext with the appropriate font map,
8794  * font description, and base direction for drawing text for
8795  * this widget. See also gtk_widget_get_pango_context().
8796  *
8797  * Return value: (transfer full): the new #PangoContext
8798  **/
8799 PangoContext *
8800 gtk_widget_create_pango_context (GtkWidget *widget)
8801 {
8802   GdkScreen *screen;
8803   PangoContext *context;
8804
8805   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8806
8807   screen = gtk_widget_get_screen_unchecked (widget);
8808   if (!screen)
8809     {
8810       GTK_NOTE (MULTIHEAD,
8811                 g_warning ("gtk_widget_create_pango_context ()) called without screen"));
8812
8813       screen = gdk_screen_get_default ();
8814     }
8815
8816   context = gdk_pango_context_get_for_screen (screen);
8817
8818   update_pango_context (widget, context);
8819   pango_context_set_language (context, gtk_get_default_language ());
8820
8821   return context;
8822 }
8823
8824 /**
8825  * gtk_widget_create_pango_layout:
8826  * @widget: a #GtkWidget
8827  * @text: text to set on the layout (can be %NULL)
8828  *
8829  * Creates a new #PangoLayout with the appropriate font map,
8830  * font description, and base direction for drawing text for
8831  * this widget.
8832  *
8833  * If you keep a #PangoLayout created in this way around, you need
8834  * to re-create it when the widget #PangoContext is replaced.
8835  * This can be tracked by using the #GtkWidget::screen-changed signal
8836  * on the widget.
8837  *
8838  * Return value: (transfer full): the new #PangoLayout
8839  **/
8840 PangoLayout *
8841 gtk_widget_create_pango_layout (GtkWidget   *widget,
8842                                 const gchar *text)
8843 {
8844   PangoLayout *layout;
8845   PangoContext *context;
8846
8847   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8848
8849   context = gtk_widget_get_pango_context (widget);
8850   layout = pango_layout_new (context);
8851
8852   if (text)
8853     pango_layout_set_text (layout, text, -1);
8854
8855   return layout;
8856 }
8857
8858 /**
8859  * gtk_widget_render_icon_pixbuf:
8860  * @widget: a #GtkWidget
8861  * @stock_id: a stock ID
8862  * @size: (type int): a stock size. A size of (GtkIconSize)-1 means
8863  *     render at the size of the source and don't scale (if there are
8864  *     multiple source sizes, GTK+ picks one of the available sizes).
8865  *
8866  * A convenience function that uses the theme engine and style
8867  * settings for @widget to look up @stock_id and render it to
8868  * a pixbuf. @stock_id should be a stock icon ID such as
8869  * #GTK_STOCK_OPEN or #GTK_STOCK_OK. @size should be a size
8870  * such as #GTK_ICON_SIZE_MENU.
8871  *
8872  * The pixels in the returned #GdkPixbuf are shared with the rest of
8873  * the application and should not be modified. The pixbuf should be freed
8874  * after use with g_object_unref().
8875  *
8876  * Return value: (transfer full): a new pixbuf, or %NULL if the
8877  *     stock ID wasn't known
8878  *
8879  * Since: 3.0
8880  **/
8881 GdkPixbuf*
8882 gtk_widget_render_icon_pixbuf (GtkWidget   *widget,
8883                                const gchar *stock_id,
8884                                GtkIconSize  size)
8885 {
8886   GtkStyleContext *context;
8887   GtkIconSet *icon_set;
8888
8889   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8890   g_return_val_if_fail (stock_id != NULL, NULL);
8891   g_return_val_if_fail (size > GTK_ICON_SIZE_INVALID || size == -1, NULL);
8892
8893   context = gtk_widget_get_style_context (widget);
8894   icon_set = gtk_style_context_lookup_icon_set (context, stock_id);
8895
8896   if (icon_set == NULL)
8897     return NULL;
8898
8899   return gtk_icon_set_render_icon_pixbuf (icon_set, context, size);
8900 }
8901
8902 /**
8903  * gtk_widget_set_parent_window:
8904  * @widget: a #GtkWidget.
8905  * @parent_window: the new parent window.
8906  *
8907  * Sets a non default parent window for @widget.
8908  *
8909  * For GtkWindow classes, setting a @parent_window effects whether
8910  * the window is a toplevel window or can be embedded into other
8911  * widgets.
8912  *
8913  * <note><para>
8914  * For GtkWindow classes, this needs to be called before the
8915  * window is realized.
8916  * </para></note>
8917  *
8918  **/
8919 void
8920 gtk_widget_set_parent_window   (GtkWidget           *widget,
8921                                 GdkWindow           *parent_window)
8922 {
8923   GdkWindow *old_parent_window;
8924
8925   g_return_if_fail (GTK_IS_WIDGET (widget));
8926
8927   old_parent_window = g_object_get_qdata (G_OBJECT (widget),
8928                                           quark_parent_window);
8929
8930   if (parent_window != old_parent_window)
8931     {
8932       gboolean is_plug;
8933
8934       g_object_set_qdata (G_OBJECT (widget), quark_parent_window,
8935                           parent_window);
8936       if (old_parent_window)
8937         g_object_unref (old_parent_window);
8938       if (parent_window)
8939         g_object_ref (parent_window);
8940
8941       /* Unset toplevel flag when adding a parent window to a widget,
8942        * this is the primary entry point to allow toplevels to be
8943        * embeddable.
8944        */
8945 #ifdef GDK_WINDOWING_X11
8946       is_plug = GTK_IS_PLUG (widget);
8947 #else
8948       is_plug = FALSE;
8949 #endif
8950       if (GTK_IS_WINDOW (widget) && !is_plug)
8951         _gtk_window_set_is_toplevel (GTK_WINDOW (widget), parent_window == NULL);
8952     }
8953 }
8954
8955 /**
8956  * gtk_widget_get_parent_window:
8957  * @widget: a #GtkWidget.
8958  *
8959  * Gets @widget's parent window.
8960  *
8961  * Returns: (transfer none): the parent window of @widget.
8962  **/
8963 GdkWindow *
8964 gtk_widget_get_parent_window (GtkWidget *widget)
8965 {
8966   GtkWidgetPrivate *priv;
8967   GdkWindow *parent_window;
8968
8969   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8970
8971   priv = widget->priv;
8972
8973   parent_window = g_object_get_qdata (G_OBJECT (widget), quark_parent_window);
8974
8975   return (parent_window != NULL) ? parent_window :
8976          (priv->parent != NULL) ? priv->parent->priv->window : NULL;
8977 }
8978
8979
8980 /**
8981  * gtk_widget_set_child_visible:
8982  * @widget: a #GtkWidget
8983  * @is_visible: if %TRUE, @widget should be mapped along with its parent.
8984  *
8985  * Sets whether @widget should be mapped along with its when its parent
8986  * is mapped and @widget has been shown with gtk_widget_show().
8987  *
8988  * The child visibility can be set for widget before it is added to
8989  * a container with gtk_widget_set_parent(), to avoid mapping
8990  * children unnecessary before immediately unmapping them. However
8991  * it will be reset to its default state of %TRUE when the widget
8992  * is removed from a container.
8993  *
8994  * Note that changing the child visibility of a widget does not
8995  * queue a resize on the widget. Most of the time, the size of
8996  * a widget is computed from all visible children, whether or
8997  * not they are mapped. If this is not the case, the container
8998  * can queue a resize itself.
8999  *
9000  * This function is only useful for container implementations and
9001  * never should be called by an application.
9002  **/
9003 void
9004 gtk_widget_set_child_visible (GtkWidget *widget,
9005                               gboolean   is_visible)
9006 {
9007   GtkWidgetPrivate *priv;
9008
9009   g_return_if_fail (GTK_IS_WIDGET (widget));
9010   g_return_if_fail (!gtk_widget_is_toplevel (widget));
9011
9012   priv = widget->priv;
9013
9014   g_object_ref (widget);
9015   gtk_widget_verify_invariants (widget);
9016
9017   if (is_visible)
9018     priv->child_visible = TRUE;
9019   else
9020     {
9021       GtkWidget *toplevel;
9022
9023       priv->child_visible = FALSE;
9024
9025       toplevel = gtk_widget_get_toplevel (widget);
9026       if (toplevel != widget && gtk_widget_is_toplevel (toplevel))
9027         _gtk_window_unset_focus_and_default (GTK_WINDOW (toplevel), widget);
9028     }
9029
9030   if (priv->parent && gtk_widget_get_realized (priv->parent))
9031     {
9032       if (gtk_widget_get_mapped (priv->parent) &&
9033           priv->child_visible &&
9034           gtk_widget_get_visible (widget))
9035         gtk_widget_map (widget);
9036       else
9037         gtk_widget_unmap (widget);
9038     }
9039
9040   gtk_widget_verify_invariants (widget);
9041   g_object_unref (widget);
9042 }
9043
9044 /**
9045  * gtk_widget_get_child_visible:
9046  * @widget: a #GtkWidget
9047  *
9048  * Gets the value set with gtk_widget_set_child_visible().
9049  * If you feel a need to use this function, your code probably
9050  * needs reorganization.
9051  *
9052  * This function is only useful for container implementations and
9053  * never should be called by an application.
9054  *
9055  * Return value: %TRUE if the widget is mapped with the parent.
9056  **/
9057 gboolean
9058 gtk_widget_get_child_visible (GtkWidget *widget)
9059 {
9060   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
9061
9062   return widget->priv->child_visible;
9063 }
9064
9065 static GdkScreen *
9066 gtk_widget_get_screen_unchecked (GtkWidget *widget)
9067 {
9068   GtkWidget *toplevel;
9069
9070   toplevel = gtk_widget_get_toplevel (widget);
9071
9072   if (gtk_widget_is_toplevel (toplevel))
9073     {
9074       if (GTK_IS_WINDOW (toplevel))
9075         return gtk_window_get_screen (GTK_WINDOW (toplevel));
9076       else if (GTK_IS_INVISIBLE (toplevel))
9077         return gtk_invisible_get_screen (GTK_INVISIBLE (widget));
9078     }
9079
9080   return NULL;
9081 }
9082
9083 /**
9084  * gtk_widget_get_screen:
9085  * @widget: a #GtkWidget
9086  *
9087  * Get the #GdkScreen from the toplevel window associated with
9088  * this widget. This function can only be called after the widget
9089  * has been added to a widget hierarchy with a #GtkWindow
9090  * at the top.
9091  *
9092  * In general, you should only create screen specific
9093  * resources when a widget has been realized, and you should
9094  * free those resources when the widget is unrealized.
9095  *
9096  * Return value: (transfer none): the #GdkScreen for the toplevel for this widget.
9097  *
9098  * Since: 2.2
9099  **/
9100 GdkScreen*
9101 gtk_widget_get_screen (GtkWidget *widget)
9102 {
9103   GdkScreen *screen;
9104
9105   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9106
9107   screen = gtk_widget_get_screen_unchecked (widget);
9108
9109   if (screen)
9110     return screen;
9111   else
9112     {
9113 #if 0
9114       g_warning (G_STRLOC ": Can't get associated screen"
9115                  " for a widget unless it is inside a toplevel GtkWindow\n"
9116                  " widget type is %s associated top level type is %s",
9117                  g_type_name (G_OBJECT_TYPE(G_OBJECT (widget))),
9118                  g_type_name (G_OBJECT_TYPE(G_OBJECT (toplevel))));
9119 #endif
9120       return gdk_screen_get_default ();
9121     }
9122 }
9123
9124 /**
9125  * gtk_widget_has_screen:
9126  * @widget: a #GtkWidget
9127  *
9128  * Checks whether there is a #GdkScreen is associated with
9129  * this widget. All toplevel widgets have an associated
9130  * screen, and all widgets added into a hierarchy with a toplevel
9131  * window at the top.
9132  *
9133  * Return value: %TRUE if there is a #GdkScreen associcated
9134  *   with the widget.
9135  *
9136  * Since: 2.2
9137  **/
9138 gboolean
9139 gtk_widget_has_screen (GtkWidget *widget)
9140 {
9141   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
9142
9143   return (gtk_widget_get_screen_unchecked (widget) != NULL);
9144 }
9145
9146 /**
9147  * gtk_widget_get_display:
9148  * @widget: a #GtkWidget
9149  *
9150  * Get the #GdkDisplay for the toplevel window associated with
9151  * this widget. This function can only be called after the widget
9152  * has been added to a widget hierarchy with a #GtkWindow at the top.
9153  *
9154  * In general, you should only create display specific
9155  * resources when a widget has been realized, and you should
9156  * free those resources when the widget is unrealized.
9157  *
9158  * Return value: (transfer none): the #GdkDisplay for the toplevel for this widget.
9159  *
9160  * Since: 2.2
9161  **/
9162 GdkDisplay*
9163 gtk_widget_get_display (GtkWidget *widget)
9164 {
9165   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9166
9167   return gdk_screen_get_display (gtk_widget_get_screen (widget));
9168 }
9169
9170 /**
9171  * gtk_widget_get_root_window:
9172  * @widget: a #GtkWidget
9173  *
9174  * Get the root window where this widget is located. This function can
9175  * only be called after the widget has been added to a widget
9176  * hierarchy with #GtkWindow at the top.
9177  *
9178  * The root window is useful for such purposes as creating a popup
9179  * #GdkWindow associated with the window. In general, you should only
9180  * create display specific resources when a widget has been realized,
9181  * and you should free those resources when the widget is unrealized.
9182  *
9183  * Return value: (transfer none): the #GdkWindow root window for the toplevel for this widget.
9184  *
9185  * Since: 2.2
9186  **/
9187 GdkWindow*
9188 gtk_widget_get_root_window (GtkWidget *widget)
9189 {
9190   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9191
9192   return gdk_screen_get_root_window (gtk_widget_get_screen (widget));
9193 }
9194
9195 /**
9196  * gtk_widget_child_focus:
9197  * @widget: a #GtkWidget
9198  * @direction: direction of focus movement
9199  *
9200  * This function is used by custom widget implementations; if you're
9201  * writing an app, you'd use gtk_widget_grab_focus() to move the focus
9202  * to a particular widget, and gtk_container_set_focus_chain() to
9203  * change the focus tab order. So you may want to investigate those
9204  * functions instead.
9205  *
9206  * gtk_widget_child_focus() is called by containers as the user moves
9207  * around the window using keyboard shortcuts. @direction indicates
9208  * what kind of motion is taking place (up, down, left, right, tab
9209  * forward, tab backward). gtk_widget_child_focus() emits the
9210  * #GtkWidget::focus signal; widgets override the default handler
9211  * for this signal in order to implement appropriate focus behavior.
9212  *
9213  * The default ::focus handler for a widget should return %TRUE if
9214  * moving in @direction left the focus on a focusable location inside
9215  * that widget, and %FALSE if moving in @direction moved the focus
9216  * outside the widget. If returning %TRUE, widgets normally
9217  * call gtk_widget_grab_focus() to place the focus accordingly;
9218  * if returning %FALSE, they don't modify the current focus location.
9219  *
9220  * Return value: %TRUE if focus ended up inside @widget
9221  **/
9222 gboolean
9223 gtk_widget_child_focus (GtkWidget       *widget,
9224                         GtkDirectionType direction)
9225 {
9226   gboolean return_val;
9227
9228   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
9229
9230   if (!gtk_widget_get_visible (widget) ||
9231       !gtk_widget_is_sensitive (widget))
9232     return FALSE;
9233
9234   /* child widgets must set CAN_FOCUS, containers
9235    * don't have to though.
9236    */
9237   if (!GTK_IS_CONTAINER (widget) &&
9238       !gtk_widget_get_can_focus (widget))
9239     return FALSE;
9240
9241   g_signal_emit (widget,
9242                  widget_signals[FOCUS],
9243                  0,
9244                  direction, &return_val);
9245
9246   return return_val;
9247 }
9248
9249 /**
9250  * gtk_widget_keynav_failed:
9251  * @widget: a #GtkWidget
9252  * @direction: direction of focus movement
9253  *
9254  * This function should be called whenever keyboard navigation within
9255  * a single widget hits a boundary. The function emits the
9256  * #GtkWidget::keynav-failed signal on the widget and its return
9257  * value should be interpreted in a way similar to the return value of
9258  * gtk_widget_child_focus():
9259  *
9260  * When %TRUE is returned, stay in the widget, the failed keyboard
9261  * navigation is Ok and/or there is nowhere we can/should move the
9262  * focus to.
9263  *
9264  * When %FALSE is returned, the caller should continue with keyboard
9265  * navigation outside the widget, e.g. by calling
9266  * gtk_widget_child_focus() on the widget's toplevel.
9267  *
9268  * The default ::keynav-failed handler returns %TRUE for
9269  * %GTK_DIR_TAB_FORWARD and %GTK_DIR_TAB_BACKWARD. For the other
9270  * values of #GtkDirectionType, it looks at the
9271  * #GtkSettings:gtk-keynav-cursor-only setting and returns %FALSE
9272  * if the setting is %TRUE. This way the entire user interface
9273  * becomes cursor-navigatable on input devices such as mobile phones
9274  * which only have cursor keys but no tab key.
9275  *
9276  * Whenever the default handler returns %TRUE, it also calls
9277  * gtk_widget_error_bell() to notify the user of the failed keyboard
9278  * navigation.
9279  *
9280  * A use case for providing an own implementation of ::keynav-failed
9281  * (either by connecting to it or by overriding it) would be a row of
9282  * #GtkEntry widgets where the user should be able to navigate the
9283  * entire row with the cursor keys, as e.g. known from user interfaces
9284  * that require entering license keys.
9285  *
9286  * Return value: %TRUE if stopping keyboard navigation is fine, %FALSE
9287  *               if the emitting widget should try to handle the keyboard
9288  *               navigation attempt in its parent container(s).
9289  *
9290  * Since: 2.12
9291  **/
9292 gboolean
9293 gtk_widget_keynav_failed (GtkWidget        *widget,
9294                           GtkDirectionType  direction)
9295 {
9296   gboolean return_val;
9297
9298   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
9299
9300   g_signal_emit (widget, widget_signals[KEYNAV_FAILED], 0,
9301                  direction, &return_val);
9302
9303   return return_val;
9304 }
9305
9306 /**
9307  * gtk_widget_error_bell:
9308  * @widget: a #GtkWidget
9309  *
9310  * Notifies the user about an input-related error on this widget.
9311  * If the #GtkSettings:gtk-error-bell setting is %TRUE, it calls
9312  * gdk_window_beep(), otherwise it does nothing.
9313  *
9314  * Note that the effect of gdk_window_beep() can be configured in many
9315  * ways, depending on the windowing backend and the desktop environment
9316  * or window manager that is used.
9317  *
9318  * Since: 2.12
9319  **/
9320 void
9321 gtk_widget_error_bell (GtkWidget *widget)
9322 {
9323   GtkWidgetPrivate *priv;
9324   GtkSettings* settings;
9325   gboolean beep;
9326
9327   g_return_if_fail (GTK_IS_WIDGET (widget));
9328
9329   priv = widget->priv;
9330
9331   settings = gtk_widget_get_settings (widget);
9332   if (!settings)
9333     return;
9334
9335   g_object_get (settings,
9336                 "gtk-error-bell", &beep,
9337                 NULL);
9338
9339   if (beep && priv->window)
9340     gdk_window_beep (priv->window);
9341 }
9342
9343 static void
9344 gtk_widget_set_usize_internal (GtkWidget          *widget,
9345                                gint                width,
9346                                gint                height,
9347                                GtkQueueResizeFlags flags)
9348 {
9349   GtkWidgetAuxInfo *aux_info;
9350   gboolean changed = FALSE;
9351
9352   g_object_freeze_notify (G_OBJECT (widget));
9353
9354   aux_info = gtk_widget_get_aux_info (widget, TRUE);
9355
9356   if (width > -2 && aux_info->width != width)
9357     {
9358       if ((flags & GTK_QUEUE_RESIZE_INVALIDATE_ONLY) == 0)
9359         g_object_notify (G_OBJECT (widget), "width-request");
9360       aux_info->width = width;
9361       changed = TRUE;
9362     }
9363   if (height > -2 && aux_info->height != height)
9364     {
9365       if ((flags & GTK_QUEUE_RESIZE_INVALIDATE_ONLY) == 0)
9366         g_object_notify (G_OBJECT (widget), "height-request");
9367       aux_info->height = height;
9368       changed = TRUE;
9369     }
9370
9371   if (gtk_widget_get_visible (widget) && changed)
9372     {
9373       if ((flags & GTK_QUEUE_RESIZE_INVALIDATE_ONLY) == 0)
9374         gtk_widget_queue_resize (widget);
9375       else
9376         _gtk_size_group_queue_resize (widget, GTK_QUEUE_RESIZE_INVALIDATE_ONLY);
9377     }
9378
9379   g_object_thaw_notify (G_OBJECT (widget));
9380 }
9381
9382 /**
9383  * gtk_widget_set_size_request:
9384  * @widget: a #GtkWidget
9385  * @width: width @widget should request, or -1 to unset
9386  * @height: height @widget should request, or -1 to unset
9387  *
9388  * Sets the minimum size of a widget; that is, the widget's size
9389  * request will be at least @width by @height. You can use this
9390  * function to force a widget to be larger than it normally would be.
9391  *
9392  * In most cases, gtk_window_set_default_size() is a better choice for
9393  * toplevel windows than this function; setting the default size will
9394  * still allow users to shrink the window. Setting the size request
9395  * will force them to leave the window at least as large as the size
9396  * request. When dealing with window sizes,
9397  * gtk_window_set_geometry_hints() can be a useful function as well.
9398  *
9399  * Note the inherent danger of setting any fixed size - themes,
9400  * translations into other languages, different fonts, and user action
9401  * can all change the appropriate size for a given widget. So, it's
9402  * basically impossible to hardcode a size that will always be
9403  * correct.
9404  *
9405  * The size request of a widget is the smallest size a widget can
9406  * accept while still functioning well and drawing itself correctly.
9407  * However in some strange cases a widget may be allocated less than
9408  * its requested size, and in many cases a widget may be allocated more
9409  * space than it requested.
9410  *
9411  * If the size request in a given direction is -1 (unset), then
9412  * the "natural" size request of the widget will be used instead.
9413  *
9414  * The size request set here does not include any margin from the
9415  * #GtkWidget properties margin-left, margin-right, margin-top, and
9416  * margin-bottom, but it does include pretty much all other padding
9417  * or border properties set by any subclass of #GtkWidget.
9418  **/
9419 void
9420 gtk_widget_set_size_request (GtkWidget *widget,
9421                              gint       width,
9422                              gint       height)
9423 {
9424   g_return_if_fail (GTK_IS_WIDGET (widget));
9425   g_return_if_fail (width >= -1);
9426   g_return_if_fail (height >= -1);
9427
9428   if (width == 0)
9429     width = 1;
9430   if (height == 0)
9431     height = 1;
9432
9433   gtk_widget_set_usize_internal (widget, width, height, 0);
9434 }
9435
9436
9437 /**
9438  * gtk_widget_get_size_request:
9439  * @widget: a #GtkWidget
9440  * @width: (out) (allow-none): return location for width, or %NULL
9441  * @height: (out) (allow-none): return location for height, or %NULL
9442  *
9443  * Gets the size request that was explicitly set for the widget using
9444  * gtk_widget_set_size_request(). A value of -1 stored in @width or
9445  * @height indicates that that dimension has not been set explicitly
9446  * and the natural requisition of the widget will be used intead. See
9447  * gtk_widget_set_size_request(). To get the size a widget will
9448  * actually request, call gtk_widget_get_preferred_size() instead of
9449  * this function.
9450  **/
9451 void
9452 gtk_widget_get_size_request (GtkWidget *widget,
9453                              gint      *width,
9454                              gint      *height)
9455 {
9456   const GtkWidgetAuxInfo *aux_info;
9457
9458   g_return_if_fail (GTK_IS_WIDGET (widget));
9459
9460   aux_info = _gtk_widget_get_aux_info_or_defaults (widget);
9461
9462   if (width)
9463     *width = aux_info->width;
9464
9465   if (height)
9466     *height = aux_info->height;
9467 }
9468
9469 /**
9470  * _gtk_widget_override_size_request:
9471  * @widget: a #GtkWidget
9472  * @width: new forced minimum width
9473  * @height: new forced minimum height
9474  * @old_width: location to store previous forced minimum width
9475  * @old_height: location to store previous forced minumum height
9476  *
9477  * Temporarily establishes a forced minimum size for a widget; this
9478  * is used by GtkWindow when calculating the size to add to the
9479  * window's geometry widget. Cached sizes for the widget and its
9480  * parents are invalidated, so that subsequent calls to the size
9481  * negotiation machinery produce the overriden result, but the
9482  * widget is not queued for relayout or redraw. The old size must
9483  * be restored with _gtk_widget_restore_size_request() or things
9484  * will go screwy.
9485  */
9486 void
9487 _gtk_widget_override_size_request (GtkWidget *widget,
9488                                    int        width,
9489                                    int        height,
9490                                    int       *old_width,
9491                                    int       *old_height)
9492 {
9493   gtk_widget_get_size_request (widget, old_width, old_height);
9494   gtk_widget_set_usize_internal (widget, width, height,
9495                                  GTK_QUEUE_RESIZE_INVALIDATE_ONLY);
9496 }
9497
9498 /**
9499  * _gtk_widget_restore_size_request:
9500  * @widget: a #GtkWidget
9501  * @old_width: saved forced minimum size
9502  * @old_height: saved forced minimum size
9503  *
9504  * Undoes the operation of_gtk_widget_override_size_request().
9505  */
9506 void
9507 _gtk_widget_restore_size_request (GtkWidget *widget,
9508                                   int        old_width,
9509                                   int        old_height)
9510 {
9511   gtk_widget_set_usize_internal (widget, old_width, old_height,
9512                                  GTK_QUEUE_RESIZE_INVALIDATE_ONLY);
9513 }
9514
9515 /**
9516  * gtk_widget_set_events:
9517  * @widget: a #GtkWidget
9518  * @events: event mask
9519  *
9520  * Sets the event mask (see #GdkEventMask) for a widget. The event
9521  * mask determines which events a widget will receive. Keep in mind
9522  * that different widgets have different default event masks, and by
9523  * changing the event mask you may disrupt a widget's functionality,
9524  * so be careful. This function must be called while a widget is
9525  * unrealized. Consider gtk_widget_add_events() for widgets that are
9526  * already realized, or if you want to preserve the existing event
9527  * mask. This function can't be used with #GTK_NO_WINDOW widgets;
9528  * to get events on those widgets, place them inside a #GtkEventBox
9529  * and receive events on the event box.
9530  **/
9531 void
9532 gtk_widget_set_events (GtkWidget *widget,
9533                        gint       events)
9534 {
9535   g_return_if_fail (GTK_IS_WIDGET (widget));
9536   g_return_if_fail (!gtk_widget_get_realized (widget));
9537
9538   g_object_set_qdata (G_OBJECT (widget), quark_event_mask,
9539                       GINT_TO_POINTER (events));
9540   g_object_notify (G_OBJECT (widget), "events");
9541 }
9542
9543 /**
9544  * gtk_widget_set_device_events:
9545  * @widget: a #GtkWidget
9546  * @device: a #GdkDevice
9547  * @events: event mask
9548  *
9549  * Sets the device event mask (see #GdkEventMask) for a widget. The event
9550  * mask determines which events a widget will receive from @device. Keep
9551  * in mind that different widgets have different default event masks, and by
9552  * changing the event mask you may disrupt a widget's functionality,
9553  * so be careful. This function must be called while a widget is
9554  * unrealized. Consider gtk_widget_add_device_events() for widgets that are
9555  * already realized, or if you want to preserve the existing event
9556  * mask. This function can't be used with #GTK_NO_WINDOW widgets;
9557  * to get events on those widgets, place them inside a #GtkEventBox
9558  * and receive events on the event box.
9559  *
9560  * Since: 3.0
9561  **/
9562 void
9563 gtk_widget_set_device_events (GtkWidget    *widget,
9564                               GdkDevice    *device,
9565                               GdkEventMask  events)
9566 {
9567   GHashTable *device_events;
9568
9569   g_return_if_fail (GTK_IS_WIDGET (widget));
9570   g_return_if_fail (GDK_IS_DEVICE (device));
9571   g_return_if_fail (!gtk_widget_get_realized (widget));
9572
9573   device_events = g_object_get_qdata (G_OBJECT (widget), quark_device_event_mask);
9574
9575   if (G_UNLIKELY (!device_events))
9576     {
9577       device_events = g_hash_table_new (NULL, NULL);
9578       g_object_set_qdata_full (G_OBJECT (widget), quark_device_event_mask, device_events,
9579                                (GDestroyNotify) g_hash_table_unref);
9580     }
9581
9582   g_hash_table_insert (device_events, device, GUINT_TO_POINTER (events));
9583 }
9584
9585 /**
9586  * gtk_widget_set_device_enabled:
9587  * @widget: a #GtkWidget
9588  * @device: a #GdkDevice
9589  * @enabled: whether to enable the device
9590  *
9591  * Enables or disables a #GdkDevice to interact with @widget
9592  * and all its children.
9593  *
9594  * It does so by descending through the #GdkWindow hierarchy
9595  * and enabling the same mask that is has for core events
9596  * (i.e. the one that gdk_window_get_events() returns).
9597  *
9598  * Since: 3.0
9599  */
9600 void
9601 gtk_widget_set_device_enabled (GtkWidget *widget,
9602                                GdkDevice *device,
9603                                gboolean   enabled)
9604 {
9605   GList *enabled_devices;
9606
9607   g_return_if_fail (GTK_IS_WIDGET (widget));
9608   g_return_if_fail (GDK_IS_DEVICE (device));
9609
9610   enabled_devices = g_object_get_qdata (G_OBJECT (widget), quark_enabled_devices);
9611   enabled_devices = g_list_append (enabled_devices, device);
9612
9613   g_object_set_qdata_full (G_OBJECT (widget), quark_enabled_devices,
9614                            enabled_devices, (GDestroyNotify) g_list_free);;
9615
9616   if (gtk_widget_get_realized (widget))
9617     gtk_widget_set_device_enabled_internal (widget, device, TRUE, enabled);
9618 }
9619
9620 /**
9621  * gtk_widget_get_device_enabled:
9622  * @widget: a #GtkWidget
9623  * @device: a #GdkDevice
9624  *
9625  * Returns whether @device can interact with @widget and its
9626  * children. See gtk_widget_set_device_enabled().
9627  *
9628  * Return value: %TRUE is @device is enabled for @widget
9629  *
9630  * Since: 3.0
9631  */
9632 gboolean
9633 gtk_widget_get_device_enabled (GtkWidget *widget,
9634                                GdkDevice *device)
9635 {
9636   GList *enabled_devices;
9637
9638   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
9639   g_return_val_if_fail (GDK_IS_DEVICE (device), FALSE);
9640
9641   enabled_devices = g_object_get_qdata (G_OBJECT (widget), quark_enabled_devices);
9642
9643   return g_list_find (enabled_devices, device) != NULL;
9644 }
9645
9646 static void
9647 gtk_widget_add_events_internal_list (GtkWidget *widget,
9648                                      GdkDevice *device,
9649                                      gint       events,
9650                                      GList     *window_list)
9651 {
9652   GList *l;
9653
9654   for (l = window_list; l != NULL; l = l->next)
9655     {
9656       GdkWindow *window = l->data;
9657       gpointer user_data;
9658
9659       gdk_window_get_user_data (window, &user_data);
9660       if (user_data == widget)
9661         {
9662           GList *children;
9663
9664           if (device)
9665             gdk_window_set_device_events (window, device, gdk_window_get_events (window) | events);
9666           else
9667             gdk_window_set_events (window, gdk_window_get_events (window) | events);
9668
9669           children = gdk_window_get_children (window);
9670           gtk_widget_add_events_internal_list (widget, device, events, children);
9671           g_list_free (children);
9672         }
9673     }
9674 }
9675
9676 static void
9677 gtk_widget_add_events_internal (GtkWidget *widget,
9678                                 GdkDevice *device,
9679                                 gint       events)
9680 {
9681   GtkWidgetPrivate *priv = widget->priv;
9682   GList *window_list;
9683
9684   if (!gtk_widget_get_has_window (widget))
9685     window_list = gdk_window_get_children (priv->window);
9686   else
9687     window_list = g_list_prepend (NULL, priv->window);
9688
9689   gtk_widget_add_events_internal_list (widget, device, events, window_list);
9690
9691   g_list_free (window_list);
9692 }
9693
9694 /**
9695  * gtk_widget_add_events:
9696  * @widget: a #GtkWidget
9697  * @events: an event mask, see #GdkEventMask
9698  *
9699  * Adds the events in the bitfield @events to the event mask for
9700  * @widget. See gtk_widget_set_events() for details.
9701  **/
9702 void
9703 gtk_widget_add_events (GtkWidget *widget,
9704                        gint       events)
9705 {
9706   gint old_events;
9707
9708   g_return_if_fail (GTK_IS_WIDGET (widget));
9709
9710   old_events = GPOINTER_TO_INT (g_object_get_qdata (G_OBJECT (widget), quark_event_mask));
9711   g_object_set_qdata (G_OBJECT (widget), quark_event_mask,
9712                       GINT_TO_POINTER (old_events | events));
9713
9714   if (gtk_widget_get_realized (widget))
9715     {
9716       gtk_widget_add_events_internal (widget, NULL, events);
9717       gtk_widget_update_devices_mask (widget, FALSE);
9718     }
9719
9720   g_object_notify (G_OBJECT (widget), "events");
9721 }
9722
9723 /**
9724  * gtk_widget_add_device_events:
9725  * @widget: a #GtkWidget
9726  * @device: a #GdkDevice
9727  * @events: an event mask, see #GdkEventMask
9728  *
9729  * Adds the device events in the bitfield @events to the event mask for
9730  * @widget. See gtk_widget_set_device_events() for details.
9731  *
9732  * Since: 3.0
9733  **/
9734 void
9735 gtk_widget_add_device_events (GtkWidget    *widget,
9736                               GdkDevice    *device,
9737                               GdkEventMask  events)
9738 {
9739   GdkEventMask old_events;
9740   GHashTable *device_events;
9741
9742   g_return_if_fail (GTK_IS_WIDGET (widget));
9743   g_return_if_fail (GDK_IS_DEVICE (device));
9744
9745   old_events = gtk_widget_get_device_events (widget, device);
9746
9747   device_events = g_object_get_qdata (G_OBJECT (widget), quark_device_event_mask);
9748
9749   if (G_UNLIKELY (!device_events))
9750     {
9751       device_events = g_hash_table_new (NULL, NULL);
9752       g_object_set_qdata_full (G_OBJECT (widget), quark_device_event_mask, device_events,
9753                                (GDestroyNotify) g_hash_table_unref);
9754     }
9755
9756   g_hash_table_insert (device_events, device,
9757                        GUINT_TO_POINTER (old_events | events));
9758
9759   if (gtk_widget_get_realized (widget))
9760     gtk_widget_add_events_internal (widget, device, events);
9761
9762   g_object_notify (G_OBJECT (widget), "events");
9763 }
9764
9765 /**
9766  * gtk_widget_get_toplevel:
9767  * @widget: a #GtkWidget
9768  *
9769  * This function returns the topmost widget in the container hierarchy
9770  * @widget is a part of. If @widget has no parent widgets, it will be
9771  * returned as the topmost widget. No reference will be added to the
9772  * returned widget; it should not be unreferenced.
9773  *
9774  * Note the difference in behavior vs. gtk_widget_get_ancestor();
9775  * <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW)</literal>
9776  * would return
9777  * %NULL if @widget wasn't inside a toplevel window, and if the
9778  * window was inside a #GtkWindow<!-- -->-derived widget which was in turn
9779  * inside the toplevel #GtkWindow. While the second case may
9780  * seem unlikely, it actually happens when a #GtkPlug is embedded
9781  * inside a #GtkSocket within the same application.
9782  *
9783  * To reliably find the toplevel #GtkWindow, use
9784  * gtk_widget_get_toplevel() and check if the %TOPLEVEL flags
9785  * is set on the result.
9786  * |[
9787  *  GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
9788  *  if (gtk_widget_is_toplevel (toplevel))
9789  *    {
9790  *      /&ast; Perform action on toplevel. &ast;/
9791  *    }
9792  * ]|
9793  *
9794  * Return value: (transfer none): the topmost ancestor of @widget, or @widget itself
9795  *    if there's no ancestor.
9796  **/
9797 GtkWidget*
9798 gtk_widget_get_toplevel (GtkWidget *widget)
9799 {
9800   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9801
9802   while (widget->priv->parent)
9803     widget = widget->priv->parent;
9804
9805   return widget;
9806 }
9807
9808 /**
9809  * gtk_widget_get_ancestor:
9810  * @widget: a #GtkWidget
9811  * @widget_type: ancestor type
9812  *
9813  * Gets the first ancestor of @widget with type @widget_type. For example,
9814  * <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)</literal> gets
9815  * the first #GtkBox that's an ancestor of @widget. No reference will be
9816  * added to the returned widget; it should not be unreferenced. See note
9817  * about checking for a toplevel #GtkWindow in the docs for
9818  * gtk_widget_get_toplevel().
9819  *
9820  * Note that unlike gtk_widget_is_ancestor(), gtk_widget_get_ancestor()
9821  * considers @widget to be an ancestor of itself.
9822  *
9823  * Return value: (transfer none): the ancestor widget, or %NULL if not found
9824  **/
9825 GtkWidget*
9826 gtk_widget_get_ancestor (GtkWidget *widget,
9827                          GType      widget_type)
9828 {
9829   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9830
9831   while (widget && !g_type_is_a (G_OBJECT_TYPE (widget), widget_type))
9832     widget = widget->priv->parent;
9833
9834   if (!(widget && g_type_is_a (G_OBJECT_TYPE (widget), widget_type)))
9835     return NULL;
9836
9837   return widget;
9838 }
9839
9840 /**
9841  * gtk_widget_set_visual:
9842  * @widget: a #GtkWidget
9843  * @visual: visual to be used or %NULL to unset a previous one
9844  *
9845  * Sets the visual that should be used for by widget and its children for
9846  * creating #GdkWindows. The visual must be on the same #GdkScreen as
9847  * returned by gtk_widget_get_screen(), so handling the
9848  * #GtkWidget::screen-changed signal is necessary.
9849  *
9850  * Setting a new @visual will not cause @widget to recreate its windows,
9851  * so you should call this function before @widget is realized.
9852  **/
9853 void
9854 gtk_widget_set_visual (GtkWidget *widget,
9855                        GdkVisual *visual)
9856 {
9857   g_return_if_fail (GTK_IS_WIDGET (widget));
9858   g_return_if_fail (visual == NULL || GDK_IS_VISUAL (visual));
9859   if (visual)
9860     {
9861       g_return_if_fail (gtk_widget_get_screen (widget) == gdk_visual_get_screen (visual));
9862     }
9863
9864   g_object_set_qdata_full (G_OBJECT (widget),
9865                            quark_visual,
9866                            g_object_ref (visual),
9867                            g_object_unref);
9868 }
9869
9870 /**
9871  * gtk_widget_get_visual:
9872  * @widget: a #GtkWidget
9873  *
9874  * Gets the visual that will be used to render @widget.
9875  *
9876  * Return value: (transfer none): the visual for @widget
9877  **/
9878 GdkVisual*
9879 gtk_widget_get_visual (GtkWidget *widget)
9880 {
9881   GtkWidget *w;
9882   GdkVisual *visual;
9883   GdkScreen *screen;
9884
9885   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9886
9887   if (gtk_widget_get_has_window (widget) &&
9888       widget->priv->window)
9889     return gdk_window_get_visual (widget->priv->window);
9890
9891   screen = gtk_widget_get_screen (widget);
9892
9893   for (w = widget; w != NULL; w = w->priv->parent)
9894     {
9895       visual = g_object_get_qdata (G_OBJECT (w), quark_visual);
9896       if (visual)
9897         {
9898           if (gdk_visual_get_screen (visual) == screen)
9899             return visual;
9900
9901           g_warning ("Ignoring visual set on widget `%s' that is not on the correct screen.",
9902                      gtk_widget_get_name (widget));
9903         }
9904     }
9905
9906   return gdk_screen_get_system_visual (screen);
9907 }
9908
9909 /**
9910  * gtk_widget_get_settings:
9911  * @widget: a #GtkWidget
9912  *
9913  * Gets the settings object holding the settings used for this widget.
9914  *
9915  * Note that this function can only be called when the #GtkWidget
9916  * is attached to a toplevel, since the settings object is specific
9917  * to a particular #GdkScreen.
9918  *
9919  * Return value: (transfer none): the relevant #GtkSettings object
9920  */
9921 GtkSettings*
9922 gtk_widget_get_settings (GtkWidget *widget)
9923 {
9924   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9925
9926   return gtk_settings_get_for_screen (gtk_widget_get_screen (widget));
9927 }
9928
9929 /**
9930  * gtk_widget_get_events:
9931  * @widget: a #GtkWidget
9932  *
9933  * Returns the event mask for the widget (a bitfield containing flags
9934  * from the #GdkEventMask enumeration). These are the events that the widget
9935  * will receive.
9936  *
9937  * Return value: event mask for @widget
9938  **/
9939 gint
9940 gtk_widget_get_events (GtkWidget *widget)
9941 {
9942   g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
9943
9944   return GPOINTER_TO_INT (g_object_get_qdata (G_OBJECT (widget), quark_event_mask));
9945 }
9946
9947 /**
9948  * gtk_widget_get_device_events:
9949  * @widget: a #GtkWidget
9950  * @device: a #GdkDevice
9951  *
9952  * Returns the events mask for the widget corresponding to an specific device. These
9953  * are the events that the widget will receive when @device operates on it.
9954  *
9955  * Returns: device event mask for @widget
9956  *
9957  * Since: 3.0
9958  **/
9959 GdkEventMask
9960 gtk_widget_get_device_events (GtkWidget *widget,
9961                               GdkDevice *device)
9962 {
9963   GHashTable *device_events;
9964
9965   g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
9966   g_return_val_if_fail (GDK_IS_DEVICE (device), 0);
9967
9968   device_events = g_object_get_qdata (G_OBJECT (widget), quark_device_event_mask);
9969
9970   if (!device_events)
9971     return 0;
9972
9973   return GPOINTER_TO_UINT (g_hash_table_lookup (device_events, device));
9974 }
9975
9976 /**
9977  * gtk_widget_get_pointer:
9978  * @widget: a #GtkWidget
9979  * @x: (out) (allow-none): return location for the X coordinate, or %NULL
9980  * @y: (out) (allow-none): return location for the Y coordinate, or %NULL
9981  *
9982  * Obtains the location of the mouse pointer in widget coordinates.
9983  * Widget coordinates are a bit odd; for historical reasons, they are
9984  * defined as @widget->window coordinates for widgets that are not
9985  * #GTK_NO_WINDOW widgets, and are relative to @widget->allocation.x,
9986  * @widget->allocation.y for widgets that are #GTK_NO_WINDOW widgets.
9987  *
9988  * Deprecated: 3.4: Use gdk_window_get_device_position() instead.
9989  **/
9990 void
9991 gtk_widget_get_pointer (GtkWidget *widget,
9992                         gint      *x,
9993                         gint      *y)
9994 {
9995   GtkWidgetPrivate *priv;
9996
9997   g_return_if_fail (GTK_IS_WIDGET (widget));
9998
9999   priv = widget->priv;
10000
10001   if (x)
10002     *x = -1;
10003   if (y)
10004     *y = -1;
10005
10006   if (gtk_widget_get_realized (widget))
10007     {
10008       gdk_window_get_device_position (priv->window,
10009                                       gdk_device_manager_get_client_pointer (
10010                                         gdk_display_get_device_manager (
10011                                           gtk_widget_get_display (widget))),
10012                                       x, y, NULL);
10013
10014       if (!gtk_widget_get_has_window (widget))
10015         {
10016           if (x)
10017             *x -= priv->allocation.x;
10018           if (y)
10019             *y -= priv->allocation.y;
10020         }
10021     }
10022 }
10023
10024 /**
10025  * gtk_widget_is_ancestor:
10026  * @widget: a #GtkWidget
10027  * @ancestor: another #GtkWidget
10028  *
10029  * Determines whether @widget is somewhere inside @ancestor, possibly with
10030  * intermediate containers.
10031  *
10032  * Return value: %TRUE if @ancestor contains @widget as a child,
10033  *    grandchild, great grandchild, etc.
10034  **/
10035 gboolean
10036 gtk_widget_is_ancestor (GtkWidget *widget,
10037                         GtkWidget *ancestor)
10038 {
10039   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
10040   g_return_val_if_fail (ancestor != NULL, FALSE);
10041
10042   while (widget)
10043     {
10044       if (widget->priv->parent == ancestor)
10045         return TRUE;
10046       widget = widget->priv->parent;
10047     }
10048
10049   return FALSE;
10050 }
10051
10052 static GQuark quark_composite_name = 0;
10053
10054 /**
10055  * gtk_widget_set_composite_name:
10056  * @widget: a #GtkWidget.
10057  * @name: the name to set
10058  *
10059  * Sets a widgets composite name. The widget must be
10060  * a composite child of its parent; see gtk_widget_push_composite_child().
10061  **/
10062 void
10063 gtk_widget_set_composite_name (GtkWidget   *widget,
10064                                const gchar *name)
10065 {
10066   g_return_if_fail (GTK_IS_WIDGET (widget));
10067   g_return_if_fail (widget->priv->composite_child);
10068   g_return_if_fail (name != NULL);
10069
10070   if (!quark_composite_name)
10071     quark_composite_name = g_quark_from_static_string ("gtk-composite-name");
10072
10073   g_object_set_qdata_full (G_OBJECT (widget),
10074                            quark_composite_name,
10075                            g_strdup (name),
10076                            g_free);
10077 }
10078
10079 /**
10080  * gtk_widget_get_composite_name:
10081  * @widget: a #GtkWidget
10082  *
10083  * Obtains the composite name of a widget.
10084  *
10085  * Returns: the composite name of @widget, or %NULL if @widget is not
10086  *   a composite child. The string should be freed when it is no
10087  *   longer needed.
10088  **/
10089 gchar*
10090 gtk_widget_get_composite_name (GtkWidget *widget)
10091 {
10092   GtkWidgetPrivate *priv;
10093
10094   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10095
10096   priv = widget->priv;
10097
10098   if (widget->priv->composite_child && priv->parent)
10099     return _gtk_container_child_composite_name (GTK_CONTAINER (priv->parent),
10100                                                widget);
10101   else
10102     return NULL;
10103 }
10104
10105 /**
10106  * gtk_widget_push_composite_child:
10107  *
10108  * Makes all newly-created widgets as composite children until
10109  * the corresponding gtk_widget_pop_composite_child() call.
10110  *
10111  * A composite child is a child that's an implementation detail of the
10112  * container it's inside and should not be visible to people using the
10113  * container. Composite children aren't treated differently by GTK (but
10114  * see gtk_container_foreach() vs. gtk_container_forall()), but e.g. GUI
10115  * builders might want to treat them in a different way.
10116  *
10117  * Here is a simple example:
10118  * |[
10119  *   gtk_widget_push_composite_child ();
10120  *   scrolled_window->hscrollbar = gtk_scrollbar_new (GTK_ORIENTATION_HORIZONTAL, hadjustment);
10121  *   gtk_widget_set_composite_name (scrolled_window->hscrollbar, "hscrollbar");
10122  *   gtk_widget_pop_composite_child ();
10123  *   gtk_widget_set_parent (scrolled_window->hscrollbar,
10124  *                          GTK_WIDGET (scrolled_window));
10125  *   g_object_ref (scrolled_window->hscrollbar);
10126  * ]|
10127  **/
10128 void
10129 gtk_widget_push_composite_child (void)
10130 {
10131   composite_child_stack++;
10132 }
10133
10134 /**
10135  * gtk_widget_pop_composite_child:
10136  *
10137  * Cancels the effect of a previous call to gtk_widget_push_composite_child().
10138  **/
10139 void
10140 gtk_widget_pop_composite_child (void)
10141 {
10142   if (composite_child_stack)
10143     composite_child_stack--;
10144 }
10145
10146 static void
10147 gtk_widget_emit_direction_changed (GtkWidget        *widget,
10148                                    GtkTextDirection  old_dir)
10149 {
10150   GtkTextDirection direction;
10151   GtkStateFlags state;
10152
10153   gtk_widget_update_pango_context (widget);
10154
10155   direction = gtk_widget_get_direction (widget);
10156   state = widget->priv->state_flags;
10157   state &= GTK_STATE_FLAG_DIR_LTR | GTK_STATE_FLAG_DIR_RTL;
10158
10159   switch (direction)
10160     {
10161     case GTK_TEXT_DIR_LTR:
10162       state |= GTK_STATE_FLAG_DIR_LTR;
10163       break;
10164
10165     case GTK_TEXT_DIR_RTL:
10166       state |= GTK_STATE_FLAG_DIR_RTL;
10167       break;
10168
10169     case GTK_TEXT_DIR_NONE:
10170     default:
10171       g_assert_not_reached ();
10172       break;
10173     }
10174
10175   gtk_widget_set_state_flags (widget, state, TRUE);
10176
10177   g_signal_emit (widget, widget_signals[DIRECTION_CHANGED], 0, old_dir);
10178 }
10179
10180 /**
10181  * gtk_widget_set_direction:
10182  * @widget: a #GtkWidget
10183  * @dir:    the new direction
10184  *
10185  * Sets the reading direction on a particular widget. This direction
10186  * controls the primary direction for widgets containing text,
10187  * and also the direction in which the children of a container are
10188  * packed. The ability to set the direction is present in order
10189  * so that correct localization into languages with right-to-left
10190  * reading directions can be done. Generally, applications will
10191  * let the default reading direction present, except for containers
10192  * where the containers are arranged in an order that is explicitely
10193  * visual rather than logical (such as buttons for text justification).
10194  *
10195  * If the direction is set to %GTK_TEXT_DIR_NONE, then the value
10196  * set by gtk_widget_set_default_direction() will be used.
10197  **/
10198 void
10199 gtk_widget_set_direction (GtkWidget        *widget,
10200                           GtkTextDirection  dir)
10201 {
10202   GtkTextDirection old_dir;
10203
10204   g_return_if_fail (GTK_IS_WIDGET (widget));
10205   g_return_if_fail (dir >= GTK_TEXT_DIR_NONE && dir <= GTK_TEXT_DIR_RTL);
10206
10207   old_dir = gtk_widget_get_direction (widget);
10208
10209   widget->priv->direction = dir;
10210
10211   if (old_dir != gtk_widget_get_direction (widget))
10212     gtk_widget_emit_direction_changed (widget, old_dir);
10213 }
10214
10215 /**
10216  * gtk_widget_get_direction:
10217  * @widget: a #GtkWidget
10218  *
10219  * Gets the reading direction for a particular widget. See
10220  * gtk_widget_set_direction().
10221  *
10222  * Return value: the reading direction for the widget.
10223  **/
10224 GtkTextDirection
10225 gtk_widget_get_direction (GtkWidget *widget)
10226 {
10227   g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_TEXT_DIR_LTR);
10228
10229   if (widget->priv->direction == GTK_TEXT_DIR_NONE)
10230     return gtk_default_direction;
10231   else
10232     return widget->priv->direction;
10233 }
10234
10235 static void
10236 gtk_widget_set_default_direction_recurse (GtkWidget *widget, gpointer data)
10237 {
10238   GtkTextDirection old_dir = GPOINTER_TO_UINT (data);
10239
10240   g_object_ref (widget);
10241
10242   if (widget->priv->direction == GTK_TEXT_DIR_NONE)
10243     gtk_widget_emit_direction_changed (widget, old_dir);
10244
10245   if (GTK_IS_CONTAINER (widget))
10246     gtk_container_forall (GTK_CONTAINER (widget),
10247                           gtk_widget_set_default_direction_recurse,
10248                           data);
10249
10250   g_object_unref (widget);
10251 }
10252
10253 /**
10254  * gtk_widget_set_default_direction:
10255  * @dir: the new default direction. This cannot be
10256  *        %GTK_TEXT_DIR_NONE.
10257  *
10258  * Sets the default reading direction for widgets where the
10259  * direction has not been explicitly set by gtk_widget_set_direction().
10260  **/
10261 void
10262 gtk_widget_set_default_direction (GtkTextDirection dir)
10263 {
10264   g_return_if_fail (dir == GTK_TEXT_DIR_RTL || dir == GTK_TEXT_DIR_LTR);
10265
10266   if (dir != gtk_default_direction)
10267     {
10268       GList *toplevels, *tmp_list;
10269       GtkTextDirection old_dir = gtk_default_direction;
10270
10271       gtk_default_direction = dir;
10272
10273       tmp_list = toplevels = gtk_window_list_toplevels ();
10274       g_list_foreach (toplevels, (GFunc)g_object_ref, NULL);
10275
10276       while (tmp_list)
10277         {
10278           gtk_widget_set_default_direction_recurse (tmp_list->data,
10279                                                     GUINT_TO_POINTER (old_dir));
10280           g_object_unref (tmp_list->data);
10281           tmp_list = tmp_list->next;
10282         }
10283
10284       g_list_free (toplevels);
10285     }
10286 }
10287
10288 /**
10289  * gtk_widget_get_default_direction:
10290  *
10291  * Obtains the current default reading direction. See
10292  * gtk_widget_set_default_direction().
10293  *
10294  * Return value: the current default direction.
10295  **/
10296 GtkTextDirection
10297 gtk_widget_get_default_direction (void)
10298 {
10299   return gtk_default_direction;
10300 }
10301
10302 static void
10303 gtk_widget_constructed (GObject *object)
10304 {
10305   GtkWidget *widget = GTK_WIDGET (object);
10306   GtkWidgetPrivate *priv = widget->priv;
10307
10308   /* As strange as it may seem, this may happen on object construction.
10309    * init() implementations of parent types may eventually call this function,
10310    * each with its corresponding GType, which could leave a child
10311    * implementation with a wrong widget type in the widget path
10312    */
10313   if (priv->path &&
10314       G_OBJECT_TYPE (widget) != gtk_widget_path_get_object_type (priv->path))
10315     {
10316       gtk_widget_path_free (priv->path);
10317       priv->path = NULL;
10318     }
10319
10320   G_OBJECT_CLASS (gtk_widget_parent_class)->constructed (object);
10321 }
10322
10323 static void
10324 gtk_widget_dispose (GObject *object)
10325 {
10326   GtkWidget *widget = GTK_WIDGET (object);
10327   GtkWidgetPrivate *priv = widget->priv;
10328
10329   if (priv->parent)
10330     gtk_container_remove (GTK_CONTAINER (priv->parent), widget);
10331   else if (gtk_widget_get_visible (widget))
10332     gtk_widget_hide (widget);
10333
10334   priv->visible = FALSE;
10335   if (gtk_widget_get_realized (widget))
10336     gtk_widget_unrealize (widget);
10337
10338   if (!priv->in_destruction)
10339     {
10340       priv->in_destruction = TRUE;
10341       g_signal_emit (object, widget_signals[DESTROY], 0);
10342       priv->in_destruction = FALSE;
10343     }
10344
10345   g_clear_object (&priv->muxer);
10346
10347   G_OBJECT_CLASS (gtk_widget_parent_class)->dispose (object);
10348 }
10349
10350 static void
10351 gtk_widget_real_destroy (GtkWidget *object)
10352 {
10353   /* gtk_object_destroy() will already hold a refcount on object */
10354   GtkWidget *widget = GTK_WIDGET (object);
10355   GtkWidgetPrivate *priv = widget->priv;
10356
10357   if (GTK_WIDGET_GET_CLASS (widget)->priv->accessible_type != GTK_TYPE_ACCESSIBLE)
10358     {
10359       GtkAccessible *accessible = g_object_steal_qdata (G_OBJECT (widget), quark_accessible_object);
10360
10361       if (accessible)
10362         {
10363           gtk_accessible_set_widget (accessible, NULL);
10364           g_object_unref (accessible);
10365         }
10366     }
10367
10368   /* wipe accelerator closures (keep order) */
10369   g_object_set_qdata (G_OBJECT (widget), quark_accel_path, NULL);
10370   g_object_set_qdata (G_OBJECT (widget), quark_accel_closures, NULL);
10371
10372   /* Callers of add_mnemonic_label() should disconnect on ::destroy */
10373   g_object_set_qdata (G_OBJECT (widget), quark_mnemonic_labels, NULL);
10374
10375   gtk_grab_remove (widget);
10376
10377   if (priv->style)
10378     g_object_unref (priv->style);
10379   priv->style = gtk_widget_get_default_style ();
10380   g_object_ref (priv->style);
10381 }
10382
10383 static void
10384 gtk_widget_finalize (GObject *object)
10385 {
10386   GtkWidget *widget = GTK_WIDGET (object);
10387   GtkWidgetPrivate *priv = widget->priv;
10388   GtkWidgetAuxInfo *aux_info;
10389   GtkAccessible *accessible;
10390
10391   gtk_grab_remove (widget);
10392
10393   g_object_unref (priv->style);
10394   priv->style = NULL;
10395
10396   g_free (priv->name);
10397
10398   aux_info = gtk_widget_get_aux_info (widget, FALSE);
10399   if (aux_info)
10400     gtk_widget_aux_info_destroy (aux_info);
10401
10402   accessible = g_object_get_qdata (G_OBJECT (widget), quark_accessible_object);
10403   if (accessible)
10404     g_object_unref (accessible);
10405
10406   if (priv->path)
10407     gtk_widget_path_free (priv->path);
10408
10409   if (priv->context)
10410     {
10411       _gtk_style_context_set_widget (priv->context, NULL);
10412       g_object_unref (priv->context);
10413     }
10414
10415   _gtk_size_request_cache_free (&priv->requests);
10416
10417   if (g_object_is_floating (object))
10418     g_warning ("A floating object was finalized. This means that someone\n"
10419                "called g_object_unref() on an object that had only a floating\n"
10420                "reference; the initial floating reference is not owned by anyone\n"
10421                "and must be removed with g_object_ref_sink().");
10422
10423   G_OBJECT_CLASS (gtk_widget_parent_class)->finalize (object);
10424 }
10425
10426 /*****************************************
10427  * gtk_widget_real_map:
10428  *
10429  *   arguments:
10430  *
10431  *   results:
10432  *****************************************/
10433
10434 static void
10435 gtk_widget_real_map (GtkWidget *widget)
10436 {
10437   GtkWidgetPrivate *priv = widget->priv;
10438
10439   g_assert (gtk_widget_get_realized (widget));
10440
10441   if (!gtk_widget_get_mapped (widget))
10442     {
10443       gtk_widget_set_mapped (widget, TRUE);
10444
10445       if (gtk_widget_get_has_window (widget))
10446         gdk_window_show (priv->window);
10447     }
10448 }
10449
10450 /*****************************************
10451  * gtk_widget_real_unmap:
10452  *
10453  *   arguments:
10454  *
10455  *   results:
10456  *****************************************/
10457
10458 static void
10459 gtk_widget_real_unmap (GtkWidget *widget)
10460 {
10461   GtkWidgetPrivate *priv = widget->priv;
10462
10463   if (gtk_widget_get_mapped (widget))
10464     {
10465       gtk_widget_set_mapped (widget, FALSE);
10466
10467       if (gtk_widget_get_has_window (widget))
10468         gdk_window_hide (priv->window);
10469     }
10470 }
10471
10472 /*****************************************
10473  * gtk_widget_real_realize:
10474  *
10475  *   arguments:
10476  *
10477  *   results:
10478  *****************************************/
10479
10480 static void
10481 gtk_widget_real_realize (GtkWidget *widget)
10482 {
10483   GtkWidgetPrivate *priv = widget->priv;
10484
10485   g_assert (!gtk_widget_get_has_window (widget));
10486
10487   gtk_widget_set_realized (widget, TRUE);
10488   if (priv->parent)
10489     {
10490       priv->window = gtk_widget_get_parent_window (widget);
10491       g_object_ref (priv->window);
10492     }
10493 }
10494
10495 /*****************************************
10496  * gtk_widget_real_unrealize:
10497  *
10498  *   arguments:
10499  *
10500  *   results:
10501  *****************************************/
10502
10503 static void
10504 gtk_widget_real_unrealize (GtkWidget *widget)
10505 {
10506   GtkWidgetPrivate *priv = widget->priv;
10507
10508   g_assert (!widget->priv->mapped);
10509
10510   /* printf ("unrealizing %s\n", g_type_name (G_TYPE_FROM_INSTANCE (widget)));
10511    */
10512
10513    /* We must do unrealize child widget BEFORE container widget.
10514     * gdk_window_destroy() destroys specified xwindow and its sub-xwindows.
10515     * So, unrealizing container widget bofore its children causes the problem
10516     * (for example, gdk_ic_destroy () with destroyed window causes crash. )
10517     */
10518
10519   if (GTK_IS_CONTAINER (widget))
10520     gtk_container_forall (GTK_CONTAINER (widget),
10521                           (GtkCallback) gtk_widget_unrealize,
10522                           NULL);
10523
10524   if (gtk_widget_get_has_window (widget))
10525     {
10526       gdk_window_set_user_data (priv->window, NULL);
10527       gdk_window_destroy (priv->window);
10528       priv->window = NULL;
10529     }
10530   else
10531     {
10532       g_object_unref (priv->window);
10533       priv->window = NULL;
10534     }
10535
10536   gtk_selection_remove_all (widget);
10537
10538   gtk_widget_set_realized (widget, FALSE);
10539 }
10540
10541 static void
10542 gtk_widget_real_adjust_size_request (GtkWidget         *widget,
10543                                      GtkOrientation     orientation,
10544                                      gint              *minimum_size,
10545                                      gint              *natural_size)
10546 {
10547   const GtkWidgetAuxInfo *aux_info;
10548
10549   aux_info =_gtk_widget_get_aux_info_or_defaults (widget);
10550
10551   if (orientation == GTK_ORIENTATION_HORIZONTAL &&
10552       aux_info->width > 0)
10553     {
10554       *minimum_size = MAX (*minimum_size, aux_info->width);
10555     }
10556   else if (orientation == GTK_ORIENTATION_VERTICAL &&
10557            aux_info->height > 0)
10558     {
10559       *minimum_size = MAX (*minimum_size, aux_info->height);
10560     }
10561
10562   /* Fix it if set_size_request made natural size smaller than min size.
10563    * This would also silently fix broken widgets, but we warn about them
10564    * in gtksizerequest.c when calling their size request vfuncs.
10565    */
10566   *natural_size = MAX (*natural_size, *minimum_size);
10567
10568   if (orientation == GTK_ORIENTATION_HORIZONTAL)
10569     {
10570       *minimum_size += (aux_info->margin.left + aux_info->margin.right);
10571       *natural_size += (aux_info->margin.left + aux_info->margin.right);
10572     }
10573   else
10574     {
10575       *minimum_size += (aux_info->margin.top + aux_info->margin.bottom);
10576       *natural_size += (aux_info->margin.top + aux_info->margin.bottom);
10577     }
10578 }
10579
10580 /**
10581  * _gtk_widget_peek_request_cache:
10582  *
10583  * Returns the address of the widget's request cache (strictly for
10584  * internal use in gtksizerequest.c)
10585  *
10586  * Return value: the address of @widget's size request cache.
10587  **/
10588 gpointer
10589 _gtk_widget_peek_request_cache (GtkWidget *widget)
10590 {
10591   /* Don't bother slowing things down with the return_if_fail guards here */
10592   return &widget->priv->requests;
10593 }
10594
10595 /*
10596  * _gtk_widget_set_device_window:
10597  * @widget: a #GtkWidget
10598  * @device: a #GdkDevice
10599  * @window: the new device window
10600  *
10601  * Sets pointer window for @widget and @device.
10602  * Does not ref @window.
10603  */
10604 void
10605 _gtk_widget_set_device_window (GtkWidget *widget,
10606                                GdkDevice *device,
10607                                GdkWindow *window)
10608 {
10609   GHashTable *device_window;
10610
10611   g_return_if_fail (GTK_IS_WIDGET (widget));
10612   g_return_if_fail (GDK_IS_DEVICE (device));
10613   g_return_if_fail (window == NULL || GDK_IS_WINDOW (window));
10614
10615   if (!gtk_widget_get_mapped (widget))
10616     return;
10617
10618   device_window = g_object_get_qdata (G_OBJECT (widget), quark_pointer_window);
10619
10620   if (!device_window && window)
10621     {
10622       device_window = g_hash_table_new (NULL, NULL);
10623       g_object_set_qdata_full (G_OBJECT (widget),
10624                                quark_pointer_window,
10625                                device_window,
10626                                (GDestroyNotify) g_hash_table_destroy);
10627     }
10628
10629   if (window)
10630     g_hash_table_insert (device_window, device, window);
10631   else if (device_window)
10632     {
10633       g_hash_table_remove (device_window, device);
10634
10635       if (g_hash_table_size (device_window) == 0)
10636         g_object_set_qdata (G_OBJECT (widget), quark_pointer_window, NULL);
10637     }
10638 }
10639
10640 /*
10641  * _gtk_widget_get_device_window:
10642  * @widget: a #GtkWidget
10643  * @device: a #GdkDevice
10644  *
10645  * Return value: the device window set on @widget, or %NULL
10646  */
10647 GdkWindow *
10648 _gtk_widget_get_device_window (GtkWidget *widget,
10649                                GdkDevice *device)
10650 {
10651   GHashTable *device_window;
10652
10653   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10654   g_return_val_if_fail (GDK_IS_DEVICE (device), NULL);
10655
10656   if (!gtk_widget_get_mapped (widget))
10657     return NULL;
10658
10659   device_window = g_object_get_qdata (G_OBJECT (widget), quark_pointer_window);
10660
10661   if (!device_window)
10662     return NULL;
10663
10664   return g_hash_table_lookup (device_window, device);
10665 }
10666
10667 /*
10668  * _gtk_widget_list_devices:
10669  * @widget: a #GtkWidget
10670  *
10671  * Returns the list of #GdkDevices that is currently on top
10672  * of any window belonging to @widget.
10673  * Free the list with g_list_free(), the elements are owned
10674  * by GTK+ and must not be freed.
10675  */
10676 GList *
10677 _gtk_widget_list_devices (GtkWidget *widget)
10678 {
10679   GHashTableIter iter;
10680   GHashTable *device_window;
10681   GList *devices = NULL;
10682   gpointer key, value;
10683
10684   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10685
10686   if (!gtk_widget_get_mapped (widget))
10687     return NULL;
10688
10689   device_window = g_object_get_qdata (G_OBJECT (widget), quark_pointer_window);
10690
10691   if (G_UNLIKELY (!device_window))
10692     return NULL;
10693
10694   g_hash_table_iter_init (&iter, device_window);
10695
10696   while (g_hash_table_iter_next (&iter, &key, &value))
10697     devices = g_list_prepend (devices, key);
10698
10699   return devices;
10700 }
10701
10702 static void
10703 synth_crossing (GtkWidget       *widget,
10704                 GdkEventType     type,
10705                 GdkWindow       *window,
10706                 GdkDevice       *device,
10707                 GdkCrossingMode  mode,
10708                 GdkNotifyType    detail)
10709 {
10710   GdkEvent *event;
10711
10712   event = gdk_event_new (type);
10713
10714   event->crossing.window = g_object_ref (window);
10715   event->crossing.send_event = TRUE;
10716   event->crossing.subwindow = g_object_ref (window);
10717   event->crossing.time = GDK_CURRENT_TIME;
10718   event->crossing.x = event->crossing.y = 0;
10719   event->crossing.x_root = event->crossing.y_root = 0;
10720   event->crossing.mode = mode;
10721   event->crossing.detail = detail;
10722   event->crossing.focus = FALSE;
10723   event->crossing.state = 0;
10724   gdk_event_set_device (event, device);
10725
10726   if (!widget)
10727     widget = gtk_get_event_widget (event);
10728
10729   if (widget)
10730     gtk_widget_event_internal (widget, event);
10731
10732   gdk_event_free (event);
10733 }
10734
10735 /*
10736  * _gtk_widget_synthesize_crossing:
10737  * @from: the #GtkWidget the virtual pointer is leaving.
10738  * @to: the #GtkWidget the virtual pointer is moving to.
10739  * @mode: the #GdkCrossingMode to place on the synthesized events.
10740  *
10741  * Generate crossing event(s) on widget state (sensitivity) or GTK+ grab change.
10742  *
10743  * The real pointer window is the window that most recently received an enter notify
10744  * event.  Windows that don't select for crossing events can't become the real
10745  * poiner window.  The real pointer widget that owns the real pointer window.  The
10746  * effective pointer window is the same as the real pointer window unless the real
10747  * pointer widget is either insensitive or there is a grab on a widget that is not
10748  * an ancestor of the real pointer widget (in which case the effective pointer
10749  * window should be the root window).
10750  *
10751  * When the effective pointer window is the same as the real poiner window, we
10752  * receive crossing events from the windowing system.  When the effective pointer
10753  * window changes to become different from the real pointer window we synthesize
10754  * crossing events, attempting to follow X protocol rules:
10755  *
10756  * When the root window becomes the effective pointer window:
10757  *   - leave notify on real pointer window, detail Ancestor
10758  *   - leave notify on all of its ancestors, detail Virtual
10759  *   - enter notify on root window, detail Inferior
10760  *
10761  * When the root window ceases to be the effective pointer window:
10762  *   - leave notify on root window, detail Inferior
10763  *   - enter notify on all ancestors of real pointer window, detail Virtual
10764  *   - enter notify on real pointer window, detail Ancestor
10765  */
10766 void
10767 _gtk_widget_synthesize_crossing (GtkWidget       *from,
10768                                  GtkWidget       *to,
10769                                  GdkDevice       *device,
10770                                  GdkCrossingMode  mode)
10771 {
10772   GdkWindow *from_window = NULL, *to_window = NULL;
10773
10774   g_return_if_fail (from != NULL || to != NULL);
10775
10776   if (from != NULL)
10777     {
10778       from_window = _gtk_widget_get_device_window (from, device);
10779
10780       if (!from_window)
10781         from_window = from->priv->window;
10782     }
10783
10784   if (to != NULL)
10785     {
10786       to_window = _gtk_widget_get_device_window (to, device);
10787
10788       if (!to_window)
10789         to_window = to->priv->window;
10790     }
10791
10792   if (from_window == NULL && to_window == NULL)
10793     ;
10794   else if (from_window != NULL && to_window == NULL)
10795     {
10796       GList *from_ancestors = NULL, *list;
10797       GdkWindow *from_ancestor = from_window;
10798
10799       while (from_ancestor != NULL)
10800         {
10801           from_ancestor = gdk_window_get_effective_parent (from_ancestor);
10802           if (from_ancestor == NULL)
10803             break;
10804           from_ancestors = g_list_prepend (from_ancestors, from_ancestor);
10805         }
10806
10807       synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
10808                       device, mode, GDK_NOTIFY_ANCESTOR);
10809       for (list = g_list_last (from_ancestors); list; list = list->prev)
10810         {
10811           synth_crossing (NULL, GDK_LEAVE_NOTIFY, (GdkWindow *) list->data,
10812                           device, mode, GDK_NOTIFY_VIRTUAL);
10813         }
10814
10815       /* XXX: enter/inferior on root window? */
10816
10817       g_list_free (from_ancestors);
10818     }
10819   else if (from_window == NULL && to_window != NULL)
10820     {
10821       GList *to_ancestors = NULL, *list;
10822       GdkWindow *to_ancestor = to_window;
10823
10824       while (to_ancestor != NULL)
10825         {
10826           to_ancestor = gdk_window_get_effective_parent (to_ancestor);
10827           if (to_ancestor == NULL)
10828             break;
10829           to_ancestors = g_list_prepend (to_ancestors, to_ancestor);
10830         }
10831
10832       /* XXX: leave/inferior on root window? */
10833
10834       for (list = to_ancestors; list; list = list->next)
10835         {
10836           synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
10837                           device, mode, GDK_NOTIFY_VIRTUAL);
10838         }
10839       synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
10840                       device, mode, GDK_NOTIFY_ANCESTOR);
10841
10842       g_list_free (to_ancestors);
10843     }
10844   else if (from_window == to_window)
10845     ;
10846   else
10847     {
10848       GList *from_ancestors = NULL, *to_ancestors = NULL, *list;
10849       GdkWindow *from_ancestor = from_window, *to_ancestor = to_window;
10850
10851       while (from_ancestor != NULL || to_ancestor != NULL)
10852         {
10853           if (from_ancestor != NULL)
10854             {
10855               from_ancestor = gdk_window_get_effective_parent (from_ancestor);
10856               if (from_ancestor == to_window)
10857                 break;
10858               if (from_ancestor)
10859                 from_ancestors = g_list_prepend (from_ancestors, from_ancestor);
10860             }
10861           if (to_ancestor != NULL)
10862             {
10863               to_ancestor = gdk_window_get_effective_parent (to_ancestor);
10864               if (to_ancestor == from_window)
10865                 break;
10866               if (to_ancestor)
10867                 to_ancestors = g_list_prepend (to_ancestors, to_ancestor);
10868             }
10869         }
10870       if (to_ancestor == from_window)
10871         {
10872           if (mode != GDK_CROSSING_GTK_UNGRAB)
10873             synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
10874                             device, mode, GDK_NOTIFY_INFERIOR);
10875           for (list = to_ancestors; list; list = list->next)
10876             synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
10877                             device, mode, GDK_NOTIFY_VIRTUAL);
10878           synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
10879                           device, mode, GDK_NOTIFY_ANCESTOR);
10880         }
10881       else if (from_ancestor == to_window)
10882         {
10883           synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
10884                           device, mode, GDK_NOTIFY_ANCESTOR);
10885           for (list = g_list_last (from_ancestors); list; list = list->prev)
10886             {
10887               synth_crossing (NULL, GDK_LEAVE_NOTIFY, (GdkWindow *) list->data,
10888                               device, mode, GDK_NOTIFY_VIRTUAL);
10889             }
10890           if (mode != GDK_CROSSING_GTK_GRAB)
10891             synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
10892                             device, mode, GDK_NOTIFY_INFERIOR);
10893         }
10894       else
10895         {
10896           while (from_ancestors != NULL && to_ancestors != NULL
10897                  && from_ancestors->data == to_ancestors->data)
10898             {
10899               from_ancestors = g_list_delete_link (from_ancestors,
10900                                                    from_ancestors);
10901               to_ancestors = g_list_delete_link (to_ancestors, to_ancestors);
10902             }
10903
10904           synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
10905                           device, mode, GDK_NOTIFY_NONLINEAR);
10906
10907           for (list = g_list_last (from_ancestors); list; list = list->prev)
10908             {
10909               synth_crossing (NULL, GDK_LEAVE_NOTIFY, (GdkWindow *) list->data,
10910                               device, mode, GDK_NOTIFY_NONLINEAR_VIRTUAL);
10911             }
10912           for (list = to_ancestors; list; list = list->next)
10913             {
10914               synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
10915                               device, mode, GDK_NOTIFY_NONLINEAR_VIRTUAL);
10916             }
10917           synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
10918                           device, mode, GDK_NOTIFY_NONLINEAR);
10919         }
10920       g_list_free (from_ancestors);
10921       g_list_free (to_ancestors);
10922     }
10923 }
10924
10925 static void
10926 gtk_widget_propagate_state (GtkWidget    *widget,
10927                             GtkStateData *data)
10928 {
10929   GtkWidgetPrivate *priv = widget->priv;
10930   GtkStateFlags new_flags, old_flags = priv->state_flags;
10931   GtkStateType old_state;
10932
10933   old_state = gtk_widget_get_state (widget);
10934
10935   priv->state_flags |= data->flags_to_set;
10936   priv->state_flags &= ~(data->flags_to_unset);
10937
10938   /* make insensitivity unoverridable */
10939   if (!priv->sensitive)
10940     priv->state_flags |= GTK_STATE_FLAG_INSENSITIVE;
10941
10942   if (gtk_widget_is_focus (widget) && !gtk_widget_is_sensitive (widget))
10943     {
10944       GtkWidget *window;
10945
10946       window = gtk_widget_get_toplevel (widget);
10947
10948       if (window && gtk_widget_is_toplevel (window))
10949         gtk_window_set_focus (GTK_WINDOW (window), NULL);
10950     }
10951
10952   new_flags = priv->state_flags;
10953
10954   if (old_flags != new_flags)
10955     {
10956       g_object_ref (widget);
10957
10958       if (!gtk_widget_is_sensitive (widget) && gtk_widget_has_grab (widget))
10959         gtk_grab_remove (widget);
10960
10961       gtk_style_context_set_state (gtk_widget_get_style_context (widget), new_flags);
10962
10963       g_signal_emit (widget, widget_signals[STATE_CHANGED], 0, old_state);
10964       g_signal_emit (widget, widget_signals[STATE_FLAGS_CHANGED], 0, old_flags);
10965
10966       if (!priv->shadowed &&
10967           (new_flags & GTK_STATE_FLAG_INSENSITIVE) != (old_flags & GTK_STATE_FLAG_INSENSITIVE))
10968         {
10969           GList *event_windows = NULL;
10970           GList *devices, *d;
10971
10972           devices = _gtk_widget_list_devices (widget);
10973
10974           for (d = devices; d; d = d->next)
10975             {
10976               GdkWindow *window;
10977               GdkDevice *device;
10978
10979               device = d->data;
10980               window = _gtk_widget_get_device_window (widget, device);
10981
10982               /* Do not propagate more than once to the
10983                * same window if non-multidevice aware.
10984                */
10985               if (!gdk_window_get_support_multidevice (window) &&
10986                   g_list_find (event_windows, window))
10987                 continue;
10988
10989               if (!gtk_widget_is_sensitive (widget))
10990                 _gtk_widget_synthesize_crossing (widget, NULL, d->data,
10991                                                  GDK_CROSSING_STATE_CHANGED);
10992               else
10993                 _gtk_widget_synthesize_crossing (NULL, widget, d->data,
10994                                                  GDK_CROSSING_STATE_CHANGED);
10995
10996               event_windows = g_list_prepend (event_windows, window);
10997             }
10998
10999           g_list_free (event_windows);
11000           g_list_free (devices);
11001         }
11002
11003       if (GTK_IS_CONTAINER (widget))
11004         {
11005           GtkStateData child_data;
11006
11007           /* Make sure to only propate the right states further */
11008           child_data.flags_to_set = data->flags_to_set & GTK_STATE_FLAGS_DO_PROPAGATE;
11009           child_data.flags_to_unset = data->flags_to_unset & GTK_STATE_FLAGS_DO_PROPAGATE;
11010
11011           gtk_container_forall (GTK_CONTAINER (widget),
11012                                 (GtkCallback) gtk_widget_propagate_state,
11013                                 &child_data);
11014         }
11015
11016       g_object_unref (widget);
11017     }
11018 }
11019
11020 static const GtkWidgetAuxInfo default_aux_info = {
11021   -1, -1,
11022   GTK_ALIGN_FILL,
11023   GTK_ALIGN_FILL,
11024   { 0, 0, 0, 0 }
11025 };
11026
11027 /*
11028  * gtk_widget_get_aux_info:
11029  * @widget: a #GtkWidget
11030  * @create: if %TRUE, create the structure if it doesn't exist
11031  *
11032  * Get the #GtkWidgetAuxInfo structure for the widget.
11033  *
11034  * Return value: the #GtkAuxInfo structure for the widget, or
11035  *    %NULL if @create is %FALSE and one doesn't already exist.
11036  */
11037 static GtkWidgetAuxInfo *
11038 gtk_widget_get_aux_info (GtkWidget *widget,
11039                          gboolean   create)
11040 {
11041   GtkWidgetAuxInfo *aux_info;
11042
11043   aux_info = g_object_get_qdata (G_OBJECT (widget), quark_aux_info);
11044   if (!aux_info && create)
11045     {
11046       aux_info = g_slice_new0 (GtkWidgetAuxInfo);
11047
11048       *aux_info = default_aux_info;
11049
11050       g_object_set_qdata (G_OBJECT (widget), quark_aux_info, aux_info);
11051     }
11052
11053   return aux_info;
11054 }
11055
11056 static const GtkWidgetAuxInfo*
11057 _gtk_widget_get_aux_info_or_defaults (GtkWidget *widget)
11058 {
11059   GtkWidgetAuxInfo *aux_info;
11060
11061   aux_info = gtk_widget_get_aux_info (widget, FALSE);
11062   if (aux_info == NULL)
11063     {
11064       return &default_aux_info;
11065     }
11066   else
11067     {
11068       return aux_info;
11069     }
11070 }
11071
11072 /*****************************************
11073  * gtk_widget_aux_info_destroy:
11074  *
11075  *   arguments:
11076  *
11077  *   results:
11078  *****************************************/
11079
11080 static void
11081 gtk_widget_aux_info_destroy (GtkWidgetAuxInfo *aux_info)
11082 {
11083   g_slice_free (GtkWidgetAuxInfo, aux_info);
11084 }
11085
11086 /**
11087  * gtk_widget_shape_combine_region:
11088  * @widget: a #GtkWidget
11089  * @region: (allow-none): shape to be added, or %NULL to remove an existing shape
11090  *
11091  * Sets a shape for this widget's GDK window. This allows for
11092  * transparent windows etc., see gdk_window_shape_combine_region()
11093  * for more information.
11094  *
11095  * Since: 3.0
11096  **/
11097 void
11098 gtk_widget_shape_combine_region (GtkWidget *widget,
11099                                  cairo_region_t *region)
11100 {
11101   GtkWidgetPrivate *priv;
11102
11103   g_return_if_fail (GTK_IS_WIDGET (widget));
11104   /*  set_shape doesn't work on widgets without gdk window */
11105   g_return_if_fail (gtk_widget_get_has_window (widget));
11106
11107   priv = widget->priv;
11108
11109   if (region == NULL)
11110     {
11111       priv->has_shape_mask = FALSE;
11112
11113       if (priv->window)
11114         gdk_window_shape_combine_region (priv->window, NULL, 0, 0);
11115
11116       g_object_set_qdata (G_OBJECT (widget), quark_shape_info, NULL);
11117     }
11118   else
11119     {
11120       priv->has_shape_mask = TRUE;
11121
11122       g_object_set_qdata_full (G_OBJECT (widget), quark_shape_info,
11123                                cairo_region_copy (region),
11124                                (GDestroyNotify) cairo_region_destroy);
11125
11126       /* set shape if widget has a gdk window already.
11127        * otherwise the shape is scheduled to be set by gtk_widget_realize().
11128        */
11129       if (priv->window)
11130         gdk_window_shape_combine_region (priv->window, region, 0, 0);
11131     }
11132 }
11133
11134 /**
11135  * gtk_widget_input_shape_combine_region:
11136  * @widget: a #GtkWidget
11137  * @region: (allow-none): shape to be added, or %NULL to remove an existing shape
11138  *
11139  * Sets an input shape for this widget's GDK window. This allows for
11140  * windows which react to mouse click in a nonrectangular region, see
11141  * gdk_window_input_shape_combine_region() for more information.
11142  *
11143  * Since: 3.0
11144  **/
11145 void
11146 gtk_widget_input_shape_combine_region (GtkWidget *widget,
11147                                        cairo_region_t *region)
11148 {
11149   GtkWidgetPrivate *priv;
11150
11151   g_return_if_fail (GTK_IS_WIDGET (widget));
11152   /*  set_shape doesn't work on widgets without gdk window */
11153   g_return_if_fail (gtk_widget_get_has_window (widget));
11154
11155   priv = widget->priv;
11156
11157   if (region == NULL)
11158     {
11159       if (priv->window)
11160         gdk_window_input_shape_combine_region (priv->window, NULL, 0, 0);
11161
11162       g_object_set_qdata (G_OBJECT (widget), quark_input_shape_info, NULL);
11163     }
11164   else
11165     {
11166       g_object_set_qdata_full (G_OBJECT (widget), quark_input_shape_info,
11167                                cairo_region_copy (region),
11168                                (GDestroyNotify) cairo_region_destroy);
11169
11170       /* set shape if widget has a gdk window already.
11171        * otherwise the shape is scheduled to be set by gtk_widget_realize().
11172        */
11173       if (priv->window)
11174         gdk_window_input_shape_combine_region (priv->window, region, 0, 0);
11175     }
11176 }
11177
11178
11179 /* style properties
11180  */
11181
11182 /**
11183  * gtk_widget_class_install_style_property_parser: (skip)
11184  * @klass: a #GtkWidgetClass
11185  * @pspec: the #GParamSpec for the style property
11186  * @parser: the parser for the style property
11187  *
11188  * Installs a style property on a widget class.
11189  **/
11190 void
11191 gtk_widget_class_install_style_property_parser (GtkWidgetClass     *klass,
11192                                                 GParamSpec         *pspec,
11193                                                 GtkRcPropertyParser parser)
11194 {
11195   g_return_if_fail (GTK_IS_WIDGET_CLASS (klass));
11196   g_return_if_fail (G_IS_PARAM_SPEC (pspec));
11197   g_return_if_fail (pspec->flags & G_PARAM_READABLE);
11198   g_return_if_fail (!(pspec->flags & (G_PARAM_CONSTRUCT_ONLY | G_PARAM_CONSTRUCT)));
11199
11200   if (g_param_spec_pool_lookup (style_property_spec_pool, pspec->name, G_OBJECT_CLASS_TYPE (klass), FALSE))
11201     {
11202       g_warning (G_STRLOC ": class `%s' already contains a style property named `%s'",
11203                  G_OBJECT_CLASS_NAME (klass),
11204                  pspec->name);
11205       return;
11206     }
11207
11208   g_param_spec_ref_sink (pspec);
11209   g_param_spec_set_qdata (pspec, quark_property_parser, (gpointer) parser);
11210   g_param_spec_pool_insert (style_property_spec_pool, pspec, G_OBJECT_CLASS_TYPE (klass));
11211 }
11212
11213 /**
11214  * gtk_widget_class_install_style_property:
11215  * @klass: a #GtkWidgetClass
11216  * @pspec: the #GParamSpec for the property
11217  *
11218  * Installs a style property on a widget class. The parser for the
11219  * style property is determined by the value type of @pspec.
11220  **/
11221 void
11222 gtk_widget_class_install_style_property (GtkWidgetClass *klass,
11223                                          GParamSpec     *pspec)
11224 {
11225   GtkRcPropertyParser parser;
11226
11227   g_return_if_fail (GTK_IS_WIDGET_CLASS (klass));
11228   g_return_if_fail (G_IS_PARAM_SPEC (pspec));
11229
11230   parser = _gtk_rc_property_parser_from_type (G_PARAM_SPEC_VALUE_TYPE (pspec));
11231
11232   gtk_widget_class_install_style_property_parser (klass, pspec, parser);
11233 }
11234
11235 /**
11236  * gtk_widget_class_find_style_property:
11237  * @klass: a #GtkWidgetClass
11238  * @property_name: the name of the style property to find
11239  *
11240  * Finds a style property of a widget class by name.
11241  *
11242  * Returns: (transfer none): the #GParamSpec of the style property or
11243  *   %NULL if @class has no style property with that name.
11244  *
11245  * Since: 2.2
11246  */
11247 GParamSpec*
11248 gtk_widget_class_find_style_property (GtkWidgetClass *klass,
11249                                       const gchar    *property_name)
11250 {
11251   g_return_val_if_fail (property_name != NULL, NULL);
11252
11253   return g_param_spec_pool_lookup (style_property_spec_pool,
11254                                    property_name,
11255                                    G_OBJECT_CLASS_TYPE (klass),
11256                                    TRUE);
11257 }
11258
11259 /**
11260  * gtk_widget_class_list_style_properties:
11261  * @klass: a #GtkWidgetClass
11262  * @n_properties: location to return the number of style properties found
11263  *
11264  * Returns all style properties of a widget class.
11265  *
11266  * Returns: (array length=n_properties) (transfer container): a
11267  *     newly allocated array of #GParamSpec*. The array must be
11268  *     freed with g_free().
11269  *
11270  * Since: 2.2
11271  */
11272 GParamSpec**
11273 gtk_widget_class_list_style_properties (GtkWidgetClass *klass,
11274                                         guint          *n_properties)
11275 {
11276   GParamSpec **pspecs;
11277   guint n;
11278
11279   pspecs = g_param_spec_pool_list (style_property_spec_pool,
11280                                    G_OBJECT_CLASS_TYPE (klass),
11281                                    &n);
11282   if (n_properties)
11283     *n_properties = n;
11284
11285   return pspecs;
11286 }
11287
11288 /**
11289  * gtk_widget_style_get_property:
11290  * @widget: a #GtkWidget
11291  * @property_name: the name of a style property
11292  * @value: location to return the property value
11293  *
11294  * Gets the value of a style property of @widget.
11295  */
11296 void
11297 gtk_widget_style_get_property (GtkWidget   *widget,
11298                                const gchar *property_name,
11299                                GValue      *value)
11300 {
11301   GParamSpec *pspec;
11302
11303   g_return_if_fail (GTK_IS_WIDGET (widget));
11304   g_return_if_fail (property_name != NULL);
11305   g_return_if_fail (G_IS_VALUE (value));
11306
11307   g_object_ref (widget);
11308   pspec = g_param_spec_pool_lookup (style_property_spec_pool,
11309                                     property_name,
11310                                     G_OBJECT_TYPE (widget),
11311                                     TRUE);
11312   if (!pspec)
11313     g_warning ("%s: widget class `%s' has no property named `%s'",
11314                G_STRLOC,
11315                G_OBJECT_TYPE_NAME (widget),
11316                property_name);
11317   else
11318     {
11319       GtkStyleContext *context;
11320       const GValue *peek_value;
11321       GtkStateFlags state;
11322
11323       context = gtk_widget_get_style_context (widget);
11324       state = gtk_widget_get_state_flags (widget);
11325
11326       peek_value = _gtk_style_context_peek_style_property (context,
11327                                                            G_OBJECT_TYPE (widget),
11328                                                            state, pspec);
11329
11330       /* auto-conversion of the caller's value type
11331        */
11332       if (G_VALUE_TYPE (value) == G_PARAM_SPEC_VALUE_TYPE (pspec))
11333         g_value_copy (peek_value, value);
11334       else if (g_value_type_transformable (G_PARAM_SPEC_VALUE_TYPE (pspec), G_VALUE_TYPE (value)))
11335         g_value_transform (peek_value, value);
11336       else
11337         g_warning ("can't retrieve style property `%s' of type `%s' as value of type `%s'",
11338                    pspec->name,
11339                    g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
11340                    G_VALUE_TYPE_NAME (value));
11341     }
11342   g_object_unref (widget);
11343 }
11344
11345 /**
11346  * gtk_widget_style_get_valist:
11347  * @widget: a #GtkWidget
11348  * @first_property_name: the name of the first property to get
11349  * @var_args: a <type>va_list</type> of pairs of property names and
11350  *     locations to return the property values, starting with the location
11351  *     for @first_property_name.
11352  *
11353  * Non-vararg variant of gtk_widget_style_get(). Used primarily by language
11354  * bindings.
11355  */
11356 void
11357 gtk_widget_style_get_valist (GtkWidget   *widget,
11358                              const gchar *first_property_name,
11359                              va_list      var_args)
11360 {
11361   GtkStyleContext *context;
11362   GtkStateFlags state;
11363   const gchar *name;
11364
11365   g_return_if_fail (GTK_IS_WIDGET (widget));
11366
11367   g_object_ref (widget);
11368   context = gtk_widget_get_style_context (widget);
11369   state = gtk_widget_get_state_flags (widget);
11370
11371   name = first_property_name;
11372   while (name)
11373     {
11374       const GValue *peek_value;
11375       GParamSpec *pspec;
11376       gchar *error;
11377
11378       pspec = g_param_spec_pool_lookup (style_property_spec_pool,
11379                                         name,
11380                                         G_OBJECT_TYPE (widget),
11381                                         TRUE);
11382       if (!pspec)
11383         {
11384           g_warning ("%s: widget class `%s' has no property named `%s'",
11385                      G_STRLOC,
11386                      G_OBJECT_TYPE_NAME (widget),
11387                      name);
11388           break;
11389         }
11390       /* style pspecs are always readable so we can spare that check here */
11391
11392       peek_value = _gtk_style_context_peek_style_property (context,
11393                                                            G_OBJECT_TYPE (widget),
11394                                                            state, pspec);
11395
11396       G_VALUE_LCOPY (peek_value, var_args, 0, &error);
11397       if (error)
11398         {
11399           g_warning ("%s: %s", G_STRLOC, error);
11400           g_free (error);
11401           break;
11402         }
11403
11404       name = va_arg (var_args, gchar*);
11405     }
11406
11407   g_object_unref (widget);
11408 }
11409
11410 /**
11411  * gtk_widget_style_get:
11412  * @widget: a #GtkWidget
11413  * @first_property_name: the name of the first property to get
11414  * @...: pairs of property names and locations to return the
11415  *     property values, starting with the location for
11416  *     @first_property_name, terminated by %NULL.
11417  *
11418  * Gets the values of a multiple style properties of @widget.
11419  */
11420 void
11421 gtk_widget_style_get (GtkWidget   *widget,
11422                       const gchar *first_property_name,
11423                       ...)
11424 {
11425   va_list var_args;
11426
11427   g_return_if_fail (GTK_IS_WIDGET (widget));
11428
11429   va_start (var_args, first_property_name);
11430   gtk_widget_style_get_valist (widget, first_property_name, var_args);
11431   va_end (var_args);
11432 }
11433
11434 /**
11435  * gtk_requisition_new:
11436  *
11437  * Allocates a new #GtkRequisition structure and initializes its elements to zero.
11438  *
11439  * Returns: a new empty #GtkRequisition. The newly allocated #GtkRequisition should
11440  *   be freed with gtk_requisition_free().
11441  *
11442  * Since: 3.0
11443  */
11444 GtkRequisition *
11445 gtk_requisition_new (void)
11446 {
11447   return g_slice_new0 (GtkRequisition);
11448 }
11449
11450 /**
11451  * gtk_requisition_copy:
11452  * @requisition: a #GtkRequisition
11453  *
11454  * Copies a #GtkRequisition.
11455  *
11456  * Returns: a copy of @requisition
11457  **/
11458 GtkRequisition *
11459 gtk_requisition_copy (const GtkRequisition *requisition)
11460 {
11461   return g_slice_dup (GtkRequisition, requisition);
11462 }
11463
11464 /**
11465  * gtk_requisition_free:
11466  * @requisition: a #GtkRequisition
11467  *
11468  * Frees a #GtkRequisition.
11469  **/
11470 void
11471 gtk_requisition_free (GtkRequisition *requisition)
11472 {
11473   g_slice_free (GtkRequisition, requisition);
11474 }
11475
11476 G_DEFINE_BOXED_TYPE (GtkRequisition, gtk_requisition,
11477                      gtk_requisition_copy,
11478                      gtk_requisition_free)
11479
11480 /**
11481  * gtk_widget_class_set_accessible_type:
11482  * @widget_class: class to set the accessible type for
11483  * @type: The object type that implements the accessible for @widget_class
11484  *
11485  * Sets the type to be used for creating accessibles for widgets of
11486  * @widget_class. The given @type must be a subtype of the type used for
11487  * accessibles of the parent class.
11488  *
11489  * This function should only be called from class init functions of widgets.
11490  *
11491  * Since: 3.2
11492  **/
11493 void
11494 gtk_widget_class_set_accessible_type (GtkWidgetClass *widget_class,
11495                                       GType           type)
11496 {
11497   GtkWidgetClassPrivate *priv;
11498
11499   g_return_if_fail (GTK_IS_WIDGET_CLASS (widget_class));
11500   g_return_if_fail (g_type_is_a (type, widget_class->priv->accessible_type));
11501
11502   priv = widget_class->priv;
11503
11504   priv->accessible_type = type;
11505   /* reset this - honoring the type's role is better. */
11506   priv->accessible_role = ATK_ROLE_INVALID;
11507 }
11508
11509 /**
11510  * gtk_widget_class_set_accessible_role:
11511  * @widget_class: class to set the accessible role for
11512  * @role: The role to use for accessibles created for @widget_class
11513  *
11514  * Sets the default #AtkRole to be set on accessibles created for
11515  * widgets of @widget_class. Accessibles may decide to not honor this
11516  * setting if their role reporting is more refined. Calls to
11517  * gtk_widget_class_set_accessible_type() will reset this value.
11518  *
11519  * In cases where you want more fine-grained control over the role of
11520  * accessibles created for @widget_class, you should provide your own
11521  * accessible type and use gtk_widget_class_set_accessible_type()
11522  * instead.
11523  *
11524  * If @role is #ATK_ROLE_INVALID, the default role will not be changed
11525  * and the accessible's default role will be used instead.
11526  *
11527  * This function should only be called from class init functions of widgets.
11528  *
11529  * Since: 3.2
11530  **/
11531 void
11532 gtk_widget_class_set_accessible_role (GtkWidgetClass *widget_class,
11533                                       AtkRole         role)
11534 {
11535   GtkWidgetClassPrivate *priv;
11536
11537   g_return_if_fail (GTK_IS_WIDGET_CLASS (widget_class));
11538
11539   priv = widget_class->priv;
11540
11541   priv->accessible_role = role;
11542 }
11543
11544 /**
11545  * _gtk_widget_peek_accessible:
11546  * @widget: a #GtkWidget
11547  *
11548  * Gets the accessible for @widget, if it has been created yet.
11549  * Otherwise, this function returns %NULL. If the @widget's implementation
11550  * does not use the default way to create accessibles, %NULL will always be
11551  * returned.
11552  *
11553  * Returns: the accessible for @widget or %NULL if none has been
11554  *     created yet.
11555  **/
11556 AtkObject *
11557 _gtk_widget_peek_accessible (GtkWidget *widget)
11558 {
11559   return g_object_get_qdata (G_OBJECT (widget),
11560                              quark_accessible_object);
11561 }
11562
11563 /**
11564  * gtk_widget_get_accessible:
11565  * @widget: a #GtkWidget
11566  *
11567  * Returns the accessible object that describes the widget to an
11568  * assistive technology.
11569  *
11570  * If accessibility support is not available, this #AtkObject
11571  * instance may be a no-op. Likewise, if no class-specific #AtkObject
11572  * implementation is available for the widget instance in question,
11573  * it will inherit an #AtkObject implementation from the first ancestor
11574  * class for which such an implementation is defined.
11575  *
11576  * The documentation of the
11577  * <ulink url="http://developer.gnome.org/atk/stable/">ATK</ulink>
11578  * library contains more information about accessible objects and their uses.
11579  *
11580  * Returns: (transfer none): the #AtkObject associated with @widget
11581  */
11582 AtkObject*
11583 gtk_widget_get_accessible (GtkWidget *widget)
11584 {
11585   GtkWidgetClass *klass;
11586
11587   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
11588
11589   klass = GTK_WIDGET_GET_CLASS (widget);
11590
11591   g_return_val_if_fail (klass->get_accessible != NULL, NULL);
11592
11593   return klass->get_accessible (widget);
11594 }
11595
11596 static AtkObject*
11597 gtk_widget_real_get_accessible (GtkWidget *widget)
11598 {
11599   AtkObject* accessible;
11600
11601   accessible = g_object_get_qdata (G_OBJECT (widget),
11602                                    quark_accessible_object);
11603   if (!accessible)
11604   {
11605     GtkWidgetClass *widget_class;
11606     GtkWidgetClassPrivate *priv;
11607     AtkObjectFactory *factory;
11608     AtkRegistry *default_registry;
11609
11610     widget_class = GTK_WIDGET_GET_CLASS (widget);
11611     priv = widget_class->priv;
11612
11613     if (priv->accessible_type == GTK_TYPE_ACCESSIBLE)
11614       {
11615         default_registry = atk_get_default_registry ();
11616         factory = atk_registry_get_factory (default_registry,
11617                                             G_TYPE_FROM_INSTANCE (widget));
11618         accessible =
11619           atk_object_factory_create_accessible (factory,
11620                                                 G_OBJECT (widget));
11621
11622         if (priv->accessible_role != ATK_ROLE_INVALID)
11623           atk_object_set_role (accessible, priv->accessible_role);
11624
11625         g_object_set_qdata (G_OBJECT (widget),
11626                             quark_accessible_object,
11627                             accessible);
11628       }
11629     else
11630       {
11631         accessible = g_object_new (priv->accessible_type,
11632                                    "widget", widget,
11633                                    NULL);
11634         if (priv->accessible_role != ATK_ROLE_INVALID)
11635           atk_object_set_role (accessible, priv->accessible_role);
11636
11637         g_object_set_qdata (G_OBJECT (widget),
11638                             quark_accessible_object,
11639                             accessible);
11640
11641         atk_object_initialize (accessible, widget);
11642
11643         /* Set the role again, since we don't want a role set
11644          * in some parent initialize() function to override
11645          * our own.
11646          */
11647         if (priv->accessible_role != ATK_ROLE_INVALID)
11648           atk_object_set_role (accessible, priv->accessible_role);
11649       }
11650   }
11651   return accessible;
11652 }
11653
11654 /*
11655  * Initialize a AtkImplementorIface instance's virtual pointers as
11656  * appropriate to this implementor's class (GtkWidget).
11657  */
11658 static void
11659 gtk_widget_accessible_interface_init (AtkImplementorIface *iface)
11660 {
11661   iface->ref_accessible = gtk_widget_ref_accessible;
11662 }
11663
11664 static AtkObject*
11665 gtk_widget_ref_accessible (AtkImplementor *implementor)
11666 {
11667   AtkObject *accessible;
11668
11669   accessible = gtk_widget_get_accessible (GTK_WIDGET (implementor));
11670   if (accessible)
11671     g_object_ref (accessible);
11672   return accessible;
11673 }
11674
11675 /*
11676  * Expand flag management
11677  */
11678
11679 static void
11680 gtk_widget_update_computed_expand (GtkWidget *widget)
11681 {
11682   GtkWidgetPrivate *priv;
11683
11684   priv = widget->priv;
11685
11686   if (priv->need_compute_expand)
11687     {
11688       gboolean h, v;
11689
11690       if (priv->hexpand_set)
11691         h = priv->hexpand;
11692       else
11693         h = FALSE;
11694
11695       if (priv->vexpand_set)
11696         v = priv->vexpand;
11697       else
11698         v = FALSE;
11699
11700       /* we don't need to use compute_expand if both expands are
11701        * forced by the app
11702        */
11703       if (!(priv->hexpand_set && priv->vexpand_set))
11704         {
11705           if (GTK_WIDGET_GET_CLASS (widget)->compute_expand != NULL)
11706             {
11707               gboolean ignored;
11708
11709               GTK_WIDGET_GET_CLASS (widget)->compute_expand (widget,
11710                                                              priv->hexpand_set ? &ignored : &h,
11711                                                              priv->vexpand_set ? &ignored : &v);
11712             }
11713         }
11714
11715       priv->need_compute_expand = FALSE;
11716       priv->computed_hexpand = h != FALSE;
11717       priv->computed_vexpand = v != FALSE;
11718     }
11719 }
11720
11721 /**
11722  * gtk_widget_queue_compute_expand:
11723  * @widget: a #GtkWidget
11724  *
11725  * Mark @widget as needing to recompute its expand flags. Call
11726  * this function when setting legacy expand child properties
11727  * on the child of a container.
11728  *
11729  * See gtk_widget_compute_expand().
11730  */
11731 void
11732 gtk_widget_queue_compute_expand (GtkWidget *widget)
11733 {
11734   GtkWidget *parent;
11735   gboolean changed_anything;
11736
11737   if (widget->priv->need_compute_expand)
11738     return;
11739
11740   changed_anything = FALSE;
11741   parent = widget;
11742   while (parent != NULL)
11743     {
11744       if (!parent->priv->need_compute_expand)
11745         {
11746           parent->priv->need_compute_expand = TRUE;
11747           changed_anything = TRUE;
11748         }
11749
11750       /* Note: if we had an invariant that "if a child needs to
11751        * compute expand, its parents also do" then we could stop going
11752        * up when we got to a parent that already needed to
11753        * compute. However, in general we compute expand lazily (as
11754        * soon as we see something in a subtree that is expand, we know
11755        * we're expanding) and so this invariant does not hold and we
11756        * have to always walk all the way up in case some ancestor
11757        * is not currently need_compute_expand.
11758        */
11759
11760       parent = parent->priv->parent;
11761     }
11762
11763   /* recomputing expand always requires
11764    * a relayout as well
11765    */
11766   if (changed_anything)
11767     gtk_widget_queue_resize (widget);
11768 }
11769
11770 /**
11771  * gtk_widget_compute_expand:
11772  * @widget: the widget
11773  * @orientation: expand direction
11774  *
11775  * Computes whether a container should give this widget extra space
11776  * when possible. Containers should check this, rather than
11777  * looking at gtk_widget_get_hexpand() or gtk_widget_get_vexpand().
11778  *
11779  * This function already checks whether the widget is visible, so
11780  * visibility does not need to be checked separately. Non-visible
11781  * widgets are not expanded.
11782  *
11783  * The computed expand value uses either the expand setting explicitly
11784  * set on the widget itself, or, if none has been explicitly set,
11785  * the widget may expand if some of its children do.
11786  *
11787  * Return value: whether widget tree rooted here should be expanded
11788  */
11789 gboolean
11790 gtk_widget_compute_expand (GtkWidget     *widget,
11791                            GtkOrientation orientation)
11792 {
11793   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
11794
11795   /* We never make a widget expand if not even showing. */
11796   if (!gtk_widget_get_visible (widget))
11797     return FALSE;
11798
11799   gtk_widget_update_computed_expand (widget);
11800
11801   if (orientation == GTK_ORIENTATION_HORIZONTAL)
11802     {
11803       return widget->priv->computed_hexpand;
11804     }
11805   else
11806     {
11807       return widget->priv->computed_vexpand;
11808     }
11809 }
11810
11811 static void
11812 gtk_widget_set_expand (GtkWidget     *widget,
11813                        GtkOrientation orientation,
11814                        gboolean       expand)
11815 {
11816   const char *expand_prop;
11817   const char *expand_set_prop;
11818   gboolean was_both;
11819   GtkWidgetPrivate *priv;
11820
11821   g_return_if_fail (GTK_IS_WIDGET (widget));
11822
11823   priv = widget->priv;
11824
11825   expand = expand != FALSE;
11826
11827   was_both = priv->hexpand && priv->vexpand;
11828
11829   if (orientation == GTK_ORIENTATION_HORIZONTAL)
11830     {
11831       if (priv->hexpand_set &&
11832           priv->hexpand == expand)
11833         return;
11834
11835       priv->hexpand_set = TRUE;
11836       priv->hexpand = expand;
11837
11838       expand_prop = "hexpand";
11839       expand_set_prop = "hexpand-set";
11840     }
11841   else
11842     {
11843       if (priv->vexpand_set &&
11844           priv->vexpand == expand)
11845         return;
11846
11847       priv->vexpand_set = TRUE;
11848       priv->vexpand = expand;
11849
11850       expand_prop = "vexpand";
11851       expand_set_prop = "vexpand-set";
11852     }
11853
11854   gtk_widget_queue_compute_expand (widget);
11855
11856   g_object_freeze_notify (G_OBJECT (widget));
11857   g_object_notify (G_OBJECT (widget), expand_prop);
11858   g_object_notify (G_OBJECT (widget), expand_set_prop);
11859   if (was_both != (priv->hexpand && priv->vexpand))
11860     g_object_notify (G_OBJECT (widget), "expand");
11861   g_object_thaw_notify (G_OBJECT (widget));
11862 }
11863
11864 static void
11865 gtk_widget_set_expand_set (GtkWidget      *widget,
11866                            GtkOrientation  orientation,
11867                            gboolean        set)
11868 {
11869   GtkWidgetPrivate *priv;
11870   const char *prop;
11871
11872   priv = widget->priv;
11873
11874   set = set != FALSE;
11875
11876   if (orientation == GTK_ORIENTATION_HORIZONTAL)
11877     {
11878       if (set == priv->hexpand_set)
11879         return;
11880
11881       priv->hexpand_set = set;
11882       prop = "hexpand-set";
11883     }
11884   else
11885     {
11886       if (set == priv->vexpand_set)
11887         return;
11888
11889       priv->vexpand_set = set;
11890       prop = "vexpand-set";
11891     }
11892
11893   gtk_widget_queue_compute_expand (widget);
11894
11895   g_object_notify (G_OBJECT (widget), prop);
11896 }
11897
11898 /**
11899  * gtk_widget_get_hexpand:
11900  * @widget: the widget
11901  *
11902  * Gets whether the widget would like any available extra horizontal
11903  * space. When a user resizes a #GtkWindow, widgets with expand=TRUE
11904  * generally receive the extra space. For example, a list or
11905  * scrollable area or document in your window would often be set to
11906  * expand.
11907  *
11908  * Containers should use gtk_widget_compute_expand() rather than
11909  * this function, to see whether a widget, or any of its children,
11910  * has the expand flag set. If any child of a widget wants to
11911  * expand, the parent may ask to expand also.
11912  *
11913  * This function only looks at the widget's own hexpand flag, rather
11914  * than computing whether the entire widget tree rooted at this widget
11915  * wants to expand.
11916  *
11917  * Return value: whether hexpand flag is set
11918  */
11919 gboolean
11920 gtk_widget_get_hexpand (GtkWidget *widget)
11921 {
11922   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
11923
11924   return widget->priv->hexpand;
11925 }
11926
11927 /**
11928  * gtk_widget_set_hexpand:
11929  * @widget: the widget
11930  * @expand: whether to expand
11931  *
11932  * Sets whether the widget would like any available extra horizontal
11933  * space. When a user resizes a #GtkWindow, widgets with expand=TRUE
11934  * generally receive the extra space. For example, a list or
11935  * scrollable area or document in your window would often be set to
11936  * expand.
11937  *
11938  * Call this function to set the expand flag if you would like your
11939  * widget to become larger horizontally when the window has extra
11940  * room.
11941  *
11942  * By default, widgets automatically expand if any of their children
11943  * want to expand. (To see if a widget will automatically expand given
11944  * its current children and state, call gtk_widget_compute_expand(). A
11945  * container can decide how the expandability of children affects the
11946  * expansion of the container by overriding the compute_expand virtual
11947  * method on #GtkWidget.).
11948  *
11949  * Setting hexpand explicitly with this function will override the
11950  * automatic expand behavior.
11951  *
11952  * This function forces the widget to expand or not to expand,
11953  * regardless of children.  The override occurs because
11954  * gtk_widget_set_hexpand() sets the hexpand-set property (see
11955  * gtk_widget_set_hexpand_set()) which causes the widget's hexpand
11956  * value to be used, rather than looking at children and widget state.
11957  */
11958 void
11959 gtk_widget_set_hexpand (GtkWidget      *widget,
11960                         gboolean        expand)
11961 {
11962   g_return_if_fail (GTK_IS_WIDGET (widget));
11963
11964   gtk_widget_set_expand (widget, GTK_ORIENTATION_HORIZONTAL, expand);
11965 }
11966
11967 /**
11968  * gtk_widget_get_hexpand_set:
11969  * @widget: the widget
11970  *
11971  * Gets whether gtk_widget_set_hexpand() has been used to
11972  * explicitly set the expand flag on this widget.
11973  *
11974  * If hexpand is set, then it overrides any computed
11975  * expand value based on child widgets. If hexpand is not
11976  * set, then the expand value depends on whether any
11977  * children of the widget would like to expand.
11978  *
11979  * There are few reasons to use this function, but it's here
11980  * for completeness and consistency.
11981  *
11982  * Return value: whether hexpand has been explicitly set
11983  */
11984 gboolean
11985 gtk_widget_get_hexpand_set (GtkWidget      *widget)
11986 {
11987   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
11988
11989   return widget->priv->hexpand_set;
11990 }
11991
11992 /**
11993  * gtk_widget_set_hexpand_set:
11994  * @widget: the widget
11995  * @set: value for hexpand-set property
11996  *
11997  * Sets whether the hexpand flag (see gtk_widget_get_hexpand()) will
11998  * be used.
11999  *
12000  * The hexpand-set property will be set automatically when you call
12001  * gtk_widget_set_hexpand() to set hexpand, so the most likely
12002  * reason to use this function would be to unset an explicit expand
12003  * flag.
12004  *
12005  * If hexpand is set, then it overrides any computed
12006  * expand value based on child widgets. If hexpand is not
12007  * set, then the expand value depends on whether any
12008  * children of the widget would like to expand.
12009  *
12010  * There are few reasons to use this function, but it's here
12011  * for completeness and consistency.
12012  */
12013 void
12014 gtk_widget_set_hexpand_set (GtkWidget      *widget,
12015                             gboolean        set)
12016 {
12017   g_return_if_fail (GTK_IS_WIDGET (widget));
12018
12019   gtk_widget_set_expand_set (widget, GTK_ORIENTATION_HORIZONTAL, set);
12020 }
12021
12022
12023 /**
12024  * gtk_widget_get_vexpand:
12025  * @widget: the widget
12026  *
12027  * Gets whether the widget would like any available extra vertical
12028  * space.
12029  *
12030  * See gtk_widget_get_hexpand() for more detail.
12031  *
12032  * Return value: whether vexpand flag is set
12033  */
12034 gboolean
12035 gtk_widget_get_vexpand (GtkWidget *widget)
12036 {
12037   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
12038
12039   return widget->priv->vexpand;
12040 }
12041
12042 /**
12043  * gtk_widget_set_vexpand:
12044  * @widget: the widget
12045  * @expand: whether to expand
12046  *
12047  * Sets whether the widget would like any available extra vertical
12048  * space.
12049  *
12050  * See gtk_widget_set_hexpand() for more detail.
12051  */
12052 void
12053 gtk_widget_set_vexpand (GtkWidget      *widget,
12054                         gboolean        expand)
12055 {
12056   g_return_if_fail (GTK_IS_WIDGET (widget));
12057
12058   gtk_widget_set_expand (widget, GTK_ORIENTATION_VERTICAL, expand);
12059 }
12060
12061 /**
12062  * gtk_widget_get_vexpand_set:
12063  * @widget: the widget
12064  *
12065  * Gets whether gtk_widget_set_vexpand() has been used to
12066  * explicitly set the expand flag on this widget.
12067  *
12068  * See gtk_widget_get_hexpand_set() for more detail.
12069  *
12070  * Return value: whether vexpand has been explicitly set
12071  */
12072 gboolean
12073 gtk_widget_get_vexpand_set (GtkWidget      *widget)
12074 {
12075   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
12076
12077   return widget->priv->vexpand_set;
12078 }
12079
12080 /**
12081  * gtk_widget_set_vexpand_set:
12082  * @widget: the widget
12083  * @set: value for vexpand-set property
12084  *
12085  * Sets whether the vexpand flag (see gtk_widget_get_vexpand()) will
12086  * be used.
12087  *
12088  * See gtk_widget_set_hexpand_set() for more detail.
12089  */
12090 void
12091 gtk_widget_set_vexpand_set (GtkWidget      *widget,
12092                             gboolean        set)
12093 {
12094   g_return_if_fail (GTK_IS_WIDGET (widget));
12095
12096   gtk_widget_set_expand_set (widget, GTK_ORIENTATION_VERTICAL, set);
12097 }
12098
12099 /*
12100  * GtkBuildable implementation
12101  */
12102 static GQuark            quark_builder_has_default = 0;
12103 static GQuark            quark_builder_has_focus = 0;
12104 static GQuark            quark_builder_atk_relations = 0;
12105 static GQuark            quark_builder_set_name = 0;
12106
12107 static void
12108 gtk_widget_buildable_interface_init (GtkBuildableIface *iface)
12109 {
12110   quark_builder_has_default = g_quark_from_static_string ("gtk-builder-has-default");
12111   quark_builder_has_focus = g_quark_from_static_string ("gtk-builder-has-focus");
12112   quark_builder_atk_relations = g_quark_from_static_string ("gtk-builder-atk-relations");
12113   quark_builder_set_name = g_quark_from_static_string ("gtk-builder-set-name");
12114
12115   iface->set_name = gtk_widget_buildable_set_name;
12116   iface->get_name = gtk_widget_buildable_get_name;
12117   iface->get_internal_child = gtk_widget_buildable_get_internal_child;
12118   iface->set_buildable_property = gtk_widget_buildable_set_buildable_property;
12119   iface->parser_finished = gtk_widget_buildable_parser_finished;
12120   iface->custom_tag_start = gtk_widget_buildable_custom_tag_start;
12121   iface->custom_finished = gtk_widget_buildable_custom_finished;
12122 }
12123
12124 static void
12125 gtk_widget_buildable_set_name (GtkBuildable *buildable,
12126                                const gchar  *name)
12127 {
12128   g_object_set_qdata_full (G_OBJECT (buildable), quark_builder_set_name,
12129                            g_strdup (name), g_free);
12130 }
12131
12132 static const gchar *
12133 gtk_widget_buildable_get_name (GtkBuildable *buildable)
12134 {
12135   return g_object_get_qdata (G_OBJECT (buildable), quark_builder_set_name);
12136 }
12137
12138 static GObject *
12139 gtk_widget_buildable_get_internal_child (GtkBuildable *buildable,
12140                                          GtkBuilder   *builder,
12141                                          const gchar  *childname)
12142 {
12143   if (strcmp (childname, "accessible") == 0)
12144     return G_OBJECT (gtk_widget_get_accessible (GTK_WIDGET (buildable)));
12145
12146   return NULL;
12147 }
12148
12149 static void
12150 gtk_widget_buildable_set_buildable_property (GtkBuildable *buildable,
12151                                              GtkBuilder   *builder,
12152                                              const gchar  *name,
12153                                              const GValue *value)
12154 {
12155   if (strcmp (name, "has-default") == 0 && g_value_get_boolean (value))
12156       g_object_set_qdata (G_OBJECT (buildable), quark_builder_has_default,
12157                           GINT_TO_POINTER (TRUE));
12158   else if (strcmp (name, "has-focus") == 0 && g_value_get_boolean (value))
12159       g_object_set_qdata (G_OBJECT (buildable), quark_builder_has_focus,
12160                           GINT_TO_POINTER (TRUE));
12161   else
12162     g_object_set_property (G_OBJECT (buildable), name, value);
12163 }
12164
12165 typedef struct
12166 {
12167   gchar *action_name;
12168   GString *description;
12169   gchar *context;
12170   gboolean translatable;
12171 } AtkActionData;
12172
12173 typedef struct
12174 {
12175   gchar *target;
12176   gchar *type;
12177 } AtkRelationData;
12178
12179 static void
12180 free_action (AtkActionData *data, gpointer user_data)
12181 {
12182   g_free (data->action_name);
12183   g_string_free (data->description, TRUE);
12184   g_free (data->context);
12185   g_slice_free (AtkActionData, data);
12186 }
12187
12188 static void
12189 free_relation (AtkRelationData *data, gpointer user_data)
12190 {
12191   g_free (data->target);
12192   g_free (data->type);
12193   g_slice_free (AtkRelationData, data);
12194 }
12195
12196 static void
12197 gtk_widget_buildable_parser_finished (GtkBuildable *buildable,
12198                                       GtkBuilder   *builder)
12199 {
12200   GSList *atk_relations;
12201
12202   if (g_object_get_qdata (G_OBJECT (buildable), quark_builder_has_default))
12203     gtk_widget_grab_default (GTK_WIDGET (buildable));
12204   if (g_object_get_qdata (G_OBJECT (buildable), quark_builder_has_focus))
12205     gtk_widget_grab_focus (GTK_WIDGET (buildable));
12206
12207   atk_relations = g_object_get_qdata (G_OBJECT (buildable),
12208                                       quark_builder_atk_relations);
12209   if (atk_relations)
12210     {
12211       AtkObject *accessible;
12212       AtkRelationSet *relation_set;
12213       GSList *l;
12214       GObject *target;
12215       AtkRelationType relation_type;
12216       AtkObject *target_accessible;
12217
12218       accessible = gtk_widget_get_accessible (GTK_WIDGET (buildable));
12219       relation_set = atk_object_ref_relation_set (accessible);
12220
12221       for (l = atk_relations; l; l = l->next)
12222         {
12223           AtkRelationData *relation = (AtkRelationData*)l->data;
12224
12225           target = gtk_builder_get_object (builder, relation->target);
12226           if (!target)
12227             {
12228               g_warning ("Target object %s in <relation> does not exist",
12229                          relation->target);
12230               continue;
12231             }
12232           target_accessible = gtk_widget_get_accessible (GTK_WIDGET (target));
12233           g_assert (target_accessible != NULL);
12234
12235           relation_type = atk_relation_type_for_name (relation->type);
12236           if (relation_type == ATK_RELATION_NULL)
12237             {
12238               g_warning ("<relation> type %s not found",
12239                          relation->type);
12240               continue;
12241             }
12242           atk_relation_set_add_relation_by_type (relation_set, relation_type,
12243                                                  target_accessible);
12244         }
12245       g_object_unref (relation_set);
12246
12247       g_slist_free_full (atk_relations, (GDestroyNotify) free_relation);
12248       g_object_set_qdata (G_OBJECT (buildable), quark_builder_atk_relations,
12249                           NULL);
12250     }
12251 }
12252
12253 typedef struct
12254 {
12255   GSList *actions;
12256   GSList *relations;
12257 } AccessibilitySubParserData;
12258
12259 static void
12260 accessibility_start_element (GMarkupParseContext  *context,
12261                              const gchar          *element_name,
12262                              const gchar         **names,
12263                              const gchar         **values,
12264                              gpointer              user_data,
12265                              GError              **error)
12266 {
12267   AccessibilitySubParserData *data = (AccessibilitySubParserData*)user_data;
12268   guint i;
12269   gint line_number, char_number;
12270
12271   if (strcmp (element_name, "relation") == 0)
12272     {
12273       gchar *target = NULL;
12274       gchar *type = NULL;
12275       AtkRelationData *relation;
12276
12277       for (i = 0; names[i]; i++)
12278         {
12279           if (strcmp (names[i], "target") == 0)
12280             target = g_strdup (values[i]);
12281           else if (strcmp (names[i], "type") == 0)
12282             type = g_strdup (values[i]);
12283           else
12284             {
12285               g_markup_parse_context_get_position (context,
12286                                                    &line_number,
12287                                                    &char_number);
12288               g_set_error (error,
12289                            GTK_BUILDER_ERROR,
12290                            GTK_BUILDER_ERROR_INVALID_ATTRIBUTE,
12291                            "%s:%d:%d '%s' is not a valid attribute of <%s>",
12292                            "<input>",
12293                            line_number, char_number, names[i], "relation");
12294               g_free (target);
12295               g_free (type);
12296               return;
12297             }
12298         }
12299
12300       if (!target || !type)
12301         {
12302           g_markup_parse_context_get_position (context,
12303                                                &line_number,
12304                                                &char_number);
12305           g_set_error (error,
12306                        GTK_BUILDER_ERROR,
12307                        GTK_BUILDER_ERROR_MISSING_ATTRIBUTE,
12308                        "%s:%d:%d <%s> requires attribute \"%s\"",
12309                        "<input>",
12310                        line_number, char_number, "relation",
12311                        type ? "target" : "type");
12312           g_free (target);
12313           g_free (type);
12314           return;
12315         }
12316
12317       relation = g_slice_new (AtkRelationData);
12318       relation->target = target;
12319       relation->type = type;
12320
12321       data->relations = g_slist_prepend (data->relations, relation);
12322     }
12323   else if (strcmp (element_name, "action") == 0)
12324     {
12325       const gchar *action_name = NULL;
12326       const gchar *description = NULL;
12327       const gchar *msg_context = NULL;
12328       gboolean translatable = FALSE;
12329       AtkActionData *action;
12330
12331       for (i = 0; names[i]; i++)
12332         {
12333           if (strcmp (names[i], "action_name") == 0)
12334             action_name = values[i];
12335           else if (strcmp (names[i], "description") == 0)
12336             description = values[i];
12337           else if (strcmp (names[i], "translatable") == 0)
12338             {
12339               if (!_gtk_builder_boolean_from_string (values[i], &translatable, error))
12340                 return;
12341             }
12342           else if (strcmp (names[i], "comments") == 0)
12343             {
12344               /* do nothing, comments are for translators */
12345             }
12346           else if (strcmp (names[i], "context") == 0)
12347             msg_context = values[i];
12348           else
12349             {
12350               g_markup_parse_context_get_position (context,
12351                                                    &line_number,
12352                                                    &char_number);
12353               g_set_error (error,
12354                            GTK_BUILDER_ERROR,
12355                            GTK_BUILDER_ERROR_INVALID_ATTRIBUTE,
12356                            "%s:%d:%d '%s' is not a valid attribute of <%s>",
12357                            "<input>",
12358                            line_number, char_number, names[i], "action");
12359               return;
12360             }
12361         }
12362
12363       if (!action_name)
12364         {
12365           g_markup_parse_context_get_position (context,
12366                                                &line_number,
12367                                                &char_number);
12368           g_set_error (error,
12369                        GTK_BUILDER_ERROR,
12370                        GTK_BUILDER_ERROR_MISSING_ATTRIBUTE,
12371                        "%s:%d:%d <%s> requires attribute \"%s\"",
12372                        "<input>",
12373                        line_number, char_number, "action",
12374                        "action_name");
12375           return;
12376         }
12377
12378       action = g_slice_new (AtkActionData);
12379       action->action_name = g_strdup (action_name);
12380       action->description = g_string_new (description);
12381       action->context = g_strdup (msg_context);
12382       action->translatable = translatable;
12383
12384       data->actions = g_slist_prepend (data->actions, action);
12385     }
12386   else if (strcmp (element_name, "accessibility") == 0)
12387     ;
12388   else
12389     g_warning ("Unsupported tag for GtkWidget: %s\n", element_name);
12390 }
12391
12392 static void
12393 accessibility_text (GMarkupParseContext  *context,
12394                     const gchar          *text,
12395                     gsize                 text_len,
12396                     gpointer              user_data,
12397                     GError              **error)
12398 {
12399   AccessibilitySubParserData *data = (AccessibilitySubParserData*)user_data;
12400
12401   if (strcmp (g_markup_parse_context_get_element (context), "action") == 0)
12402     {
12403       AtkActionData *action = data->actions->data;
12404
12405       g_string_append_len (action->description, text, text_len);
12406     }
12407 }
12408
12409 static const GMarkupParser accessibility_parser =
12410   {
12411     accessibility_start_element,
12412     NULL,
12413     accessibility_text,
12414   };
12415
12416 typedef struct
12417 {
12418   GObject *object;
12419   guint    key;
12420   guint    modifiers;
12421   gchar   *signal;
12422 } AccelGroupParserData;
12423
12424 static void
12425 accel_group_start_element (GMarkupParseContext  *context,
12426                            const gchar          *element_name,
12427                            const gchar         **names,
12428                            const gchar         **values,
12429                            gpointer              user_data,
12430                            GError              **error)
12431 {
12432   gint i;
12433   guint key = 0;
12434   guint modifiers = 0;
12435   gchar *signal = NULL;
12436   AccelGroupParserData *parser_data = (AccelGroupParserData*)user_data;
12437
12438   for (i = 0; names[i]; i++)
12439     {
12440       if (strcmp (names[i], "key") == 0)
12441         key = gdk_keyval_from_name (values[i]);
12442       else if (strcmp (names[i], "modifiers") == 0)
12443         {
12444           if (!_gtk_builder_flags_from_string (GDK_TYPE_MODIFIER_TYPE,
12445                                                values[i],
12446                                                &modifiers,
12447                                                error))
12448               return;
12449         }
12450       else if (strcmp (names[i], "signal") == 0)
12451         signal = g_strdup (values[i]);
12452     }
12453
12454   if (key == 0 || signal == NULL)
12455     {
12456       g_warning ("<accelerator> requires key and signal attributes");
12457       return;
12458     }
12459   parser_data->key = key;
12460   parser_data->modifiers = modifiers;
12461   parser_data->signal = signal;
12462 }
12463
12464 static const GMarkupParser accel_group_parser =
12465   {
12466     accel_group_start_element,
12467   };
12468
12469 typedef struct
12470 {
12471   GSList *classes;
12472 } StyleParserData;
12473
12474 static void
12475 style_start_element (GMarkupParseContext  *context,
12476                      const gchar          *element_name,
12477                      const gchar         **names,
12478                      const gchar         **values,
12479                      gpointer              user_data,
12480                      GError              **error)
12481 {
12482   StyleParserData *style_data = (StyleParserData *)user_data;
12483   gchar *class_name;
12484
12485   if (strcmp (element_name, "class") == 0)
12486     {
12487       if (g_markup_collect_attributes (element_name,
12488                                        names,
12489                                        values,
12490                                        error,
12491                                        G_MARKUP_COLLECT_STRDUP, "name", &class_name,
12492                                        G_MARKUP_COLLECT_INVALID))
12493         {
12494           style_data->classes = g_slist_append (style_data->classes, class_name);
12495         }
12496     }
12497   else if (strcmp (element_name, "style") == 0)
12498     ;
12499   else
12500     g_warning ("Unsupported tag for GtkWidget: %s\n", element_name);
12501 }
12502
12503 static const GMarkupParser style_parser =
12504   {
12505     style_start_element,
12506   };
12507
12508 static gboolean
12509 gtk_widget_buildable_custom_tag_start (GtkBuildable     *buildable,
12510                                        GtkBuilder       *builder,
12511                                        GObject          *child,
12512                                        const gchar      *tagname,
12513                                        GMarkupParser    *parser,
12514                                        gpointer         *data)
12515 {
12516   g_assert (buildable);
12517
12518   if (strcmp (tagname, "accelerator") == 0)
12519     {
12520       AccelGroupParserData *parser_data;
12521
12522       parser_data = g_slice_new0 (AccelGroupParserData);
12523       parser_data->object = g_object_ref (buildable);
12524       *parser = accel_group_parser;
12525       *data = parser_data;
12526       return TRUE;
12527     }
12528   if (strcmp (tagname, "accessibility") == 0)
12529     {
12530       AccessibilitySubParserData *parser_data;
12531
12532       parser_data = g_slice_new0 (AccessibilitySubParserData);
12533       *parser = accessibility_parser;
12534       *data = parser_data;
12535       return TRUE;
12536     }
12537   if (strcmp (tagname, "style") == 0)
12538     {
12539       StyleParserData *parser_data;
12540
12541       parser_data = g_slice_new0 (StyleParserData);
12542       *parser = style_parser;
12543       *data = parser_data;
12544       return TRUE;
12545     }
12546
12547   return FALSE;
12548 }
12549
12550 void
12551 _gtk_widget_buildable_finish_accelerator (GtkWidget *widget,
12552                                           GtkWidget *toplevel,
12553                                           gpointer   user_data)
12554 {
12555   AccelGroupParserData *accel_data;
12556   GSList *accel_groups;
12557   GtkAccelGroup *accel_group;
12558
12559   g_return_if_fail (GTK_IS_WIDGET (widget));
12560   g_return_if_fail (GTK_IS_WIDGET (toplevel));
12561   g_return_if_fail (user_data != NULL);
12562
12563   accel_data = (AccelGroupParserData*)user_data;
12564   accel_groups = gtk_accel_groups_from_object (G_OBJECT (toplevel));
12565   if (g_slist_length (accel_groups) == 0)
12566     {
12567       accel_group = gtk_accel_group_new ();
12568       gtk_window_add_accel_group (GTK_WINDOW (toplevel), accel_group);
12569     }
12570   else
12571     {
12572       g_assert (g_slist_length (accel_groups) == 1);
12573       accel_group = g_slist_nth_data (accel_groups, 0);
12574     }
12575
12576   gtk_widget_add_accelerator (GTK_WIDGET (accel_data->object),
12577                               accel_data->signal,
12578                               accel_group,
12579                               accel_data->key,
12580                               accel_data->modifiers,
12581                               GTK_ACCEL_VISIBLE);
12582
12583   g_object_unref (accel_data->object);
12584   g_free (accel_data->signal);
12585   g_slice_free (AccelGroupParserData, accel_data);
12586 }
12587
12588 static void
12589 gtk_widget_buildable_custom_finished (GtkBuildable *buildable,
12590                                       GtkBuilder   *builder,
12591                                       GObject      *child,
12592                                       const gchar  *tagname,
12593                                       gpointer      user_data)
12594 {
12595   if (strcmp (tagname, "accelerator") == 0)
12596     {
12597       AccelGroupParserData *accel_data;
12598       GtkWidget *toplevel;
12599
12600       accel_data = (AccelGroupParserData*)user_data;
12601       g_assert (accel_data->object);
12602
12603       toplevel = gtk_widget_get_toplevel (GTK_WIDGET (accel_data->object));
12604
12605       _gtk_widget_buildable_finish_accelerator (GTK_WIDGET (buildable), toplevel, user_data);
12606     }
12607   else if (strcmp (tagname, "accessibility") == 0)
12608     {
12609       AccessibilitySubParserData *a11y_data;
12610
12611       a11y_data = (AccessibilitySubParserData*)user_data;
12612
12613       if (a11y_data->actions)
12614         {
12615           AtkObject *accessible;
12616           AtkAction *action;
12617           gint i, n_actions;
12618           GSList *l;
12619
12620           accessible = gtk_widget_get_accessible (GTK_WIDGET (buildable));
12621
12622           if (ATK_IS_ACTION (accessible))
12623             {
12624               action = ATK_ACTION (accessible);
12625               n_actions = atk_action_get_n_actions (action);
12626
12627               for (l = a11y_data->actions; l; l = l->next)
12628                 {
12629                   AtkActionData *action_data = (AtkActionData*)l->data;
12630
12631                   for (i = 0; i < n_actions; i++)
12632                     if (strcmp (atk_action_get_name (action, i),
12633                                 action_data->action_name) == 0)
12634                       break;
12635
12636                   if (i < n_actions)
12637                     {
12638                       gchar *description;
12639
12640                       if (action_data->translatable && action_data->description->len)
12641                         description = _gtk_builder_parser_translate (gtk_builder_get_translation_domain (builder),
12642                                                                      action_data->context,
12643                                                                      action_data->description->str);
12644                       else
12645                         description = action_data->description->str;
12646
12647                       atk_action_set_description (action, i, description);
12648                     }
12649                 }
12650             }
12651           else
12652             g_warning ("accessibility action on a widget that does not implement AtkAction");
12653
12654           g_slist_free_full (a11y_data->actions, (GDestroyNotify) free_action);
12655         }
12656
12657       if (a11y_data->relations)
12658         g_object_set_qdata (G_OBJECT (buildable), quark_builder_atk_relations,
12659                             a11y_data->relations);
12660
12661       g_slice_free (AccessibilitySubParserData, a11y_data);
12662     }
12663   else if (strcmp (tagname, "style") == 0)
12664     {
12665       StyleParserData *style_data = (StyleParserData *)user_data;
12666       GtkStyleContext *context;
12667       GSList *l;
12668
12669       context = gtk_widget_get_style_context (GTK_WIDGET (buildable));
12670
12671       for (l = style_data->classes; l; l = l->next)
12672         gtk_style_context_add_class (context, (const gchar *)l->data);
12673
12674       gtk_widget_reset_style (GTK_WIDGET (buildable));
12675
12676       g_slist_free_full (style_data->classes, g_free);
12677       g_slice_free (StyleParserData, style_data);
12678     }
12679 }
12680
12681 static GtkSizeRequestMode
12682 gtk_widget_real_get_request_mode (GtkWidget *widget)
12683 {
12684   /* By default widgets dont trade size at all. */
12685   return GTK_SIZE_REQUEST_CONSTANT_SIZE;
12686 }
12687
12688 static void
12689 gtk_widget_real_get_width (GtkWidget *widget,
12690                            gint      *minimum_size,
12691                            gint      *natural_size)
12692 {
12693   if (minimum_size)
12694     *minimum_size = 0;
12695
12696   if (natural_size)
12697     *natural_size = 0;
12698 }
12699
12700 static void
12701 gtk_widget_real_get_height (GtkWidget *widget,
12702                             gint      *minimum_size,
12703                             gint      *natural_size)
12704 {
12705   if (minimum_size)
12706     *minimum_size = 0;
12707
12708   if (natural_size)
12709     *natural_size = 0;
12710 }
12711
12712 static void
12713 gtk_widget_real_get_height_for_width (GtkWidget *widget,
12714                                       gint       width,
12715                                       gint      *minimum_height,
12716                                       gint      *natural_height)
12717 {
12718   GTK_WIDGET_GET_CLASS (widget)->get_preferred_height (widget, minimum_height, natural_height);
12719 }
12720
12721 static void
12722 gtk_widget_real_get_width_for_height (GtkWidget *widget,
12723                                       gint       height,
12724                                       gint      *minimum_width,
12725                                       gint      *natural_width)
12726 {
12727   GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, minimum_width, natural_width);
12728 }
12729
12730 /**
12731  * gtk_widget_get_halign:
12732  * @widget: a #GtkWidget
12733  *
12734  * Gets the value of the #GtkWidget:halign property.
12735  *
12736  * Returns: the horizontal alignment of @widget
12737  */
12738 GtkAlign
12739 gtk_widget_get_halign (GtkWidget *widget)
12740 {
12741   g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_ALIGN_FILL);
12742   return _gtk_widget_get_aux_info_or_defaults (widget)->halign;
12743 }
12744
12745 /**
12746  * gtk_widget_set_halign:
12747  * @widget: a #GtkWidget
12748  * @align: the horizontal alignment
12749  *
12750  * Sets the horizontal alignment of @widget.
12751  * See the #GtkWidget:halign property.
12752  */
12753 void
12754 gtk_widget_set_halign (GtkWidget *widget,
12755                        GtkAlign   align)
12756 {
12757   GtkWidgetAuxInfo *aux_info;
12758
12759   g_return_if_fail (GTK_IS_WIDGET (widget));
12760
12761   aux_info = gtk_widget_get_aux_info (widget, TRUE);
12762
12763   if (aux_info->halign == align)
12764     return;
12765
12766   aux_info->halign = align;
12767   gtk_widget_queue_resize (widget);
12768   g_object_notify (G_OBJECT (widget), "halign");
12769 }
12770
12771 /**
12772  * gtk_widget_get_valign:
12773  * @widget: a #GtkWidget
12774  *
12775  * Gets the value of the #GtkWidget:valign property.
12776  *
12777  * Returns: the vertical alignment of @widget
12778  */
12779 GtkAlign
12780 gtk_widget_get_valign (GtkWidget *widget)
12781 {
12782   g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_ALIGN_FILL);
12783   return _gtk_widget_get_aux_info_or_defaults (widget)->valign;
12784 }
12785
12786 /**
12787  * gtk_widget_set_valign:
12788  * @widget: a #GtkWidget
12789  * @align: the vertical alignment
12790  *
12791  * Sets the vertical alignment of @widget.
12792  * See the #GtkWidget:valign property.
12793  */
12794 void
12795 gtk_widget_set_valign (GtkWidget *widget,
12796                        GtkAlign   align)
12797 {
12798   GtkWidgetAuxInfo *aux_info;
12799
12800   g_return_if_fail (GTK_IS_WIDGET (widget));
12801
12802   aux_info = gtk_widget_get_aux_info (widget, TRUE);
12803
12804   if (aux_info->valign == align)
12805     return;
12806
12807   aux_info->valign = align;
12808   gtk_widget_queue_resize (widget);
12809   g_object_notify (G_OBJECT (widget), "valign");
12810 }
12811
12812 /**
12813  * gtk_widget_get_margin_left:
12814  * @widget: a #GtkWidget
12815  *
12816  * Gets the value of the #GtkWidget:margin-left property.
12817  *
12818  * Returns: The left margin of @widget
12819  *
12820  * Since: 3.0
12821  */
12822 gint
12823 gtk_widget_get_margin_left (GtkWidget *widget)
12824 {
12825   g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
12826
12827   return _gtk_widget_get_aux_info_or_defaults (widget)->margin.left;
12828 }
12829
12830 /**
12831  * gtk_widget_set_margin_left:
12832  * @widget: a #GtkWidget
12833  * @margin: the left margin
12834  *
12835  * Sets the left margin of @widget.
12836  * See the #GtkWidget:margin-left property.
12837  *
12838  * Since: 3.0
12839  */
12840 void
12841 gtk_widget_set_margin_left (GtkWidget *widget,
12842                             gint       margin)
12843 {
12844   GtkWidgetAuxInfo *aux_info;
12845
12846   g_return_if_fail (GTK_IS_WIDGET (widget));
12847   g_return_if_fail (margin <= G_MAXINT16);
12848
12849   aux_info = gtk_widget_get_aux_info (widget, TRUE);
12850
12851   if (aux_info->margin.left == margin)
12852     return;
12853
12854   aux_info->margin.left = margin;
12855   gtk_widget_queue_resize (widget);
12856   g_object_notify (G_OBJECT (widget), "margin-left");
12857 }
12858
12859 /**
12860  * gtk_widget_get_margin_right:
12861  * @widget: a #GtkWidget
12862  *
12863  * Gets the value of the #GtkWidget:margin-right property.
12864  *
12865  * Returns: The right margin of @widget
12866  *
12867  * Since: 3.0
12868  */
12869 gint
12870 gtk_widget_get_margin_right (GtkWidget *widget)
12871 {
12872   g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
12873
12874   return _gtk_widget_get_aux_info_or_defaults (widget)->margin.right;
12875 }
12876
12877 /**
12878  * gtk_widget_set_margin_right:
12879  * @widget: a #GtkWidget
12880  * @margin: the right margin
12881  *
12882  * Sets the right margin of @widget.
12883  * See the #GtkWidget:margin-right property.
12884  *
12885  * Since: 3.0
12886  */
12887 void
12888 gtk_widget_set_margin_right (GtkWidget *widget,
12889                              gint       margin)
12890 {
12891   GtkWidgetAuxInfo *aux_info;
12892
12893   g_return_if_fail (GTK_IS_WIDGET (widget));
12894   g_return_if_fail (margin <= G_MAXINT16);
12895
12896   aux_info = gtk_widget_get_aux_info (widget, TRUE);
12897
12898   if (aux_info->margin.right == margin)
12899     return;
12900
12901   aux_info->margin.right = margin;
12902   gtk_widget_queue_resize (widget);
12903   g_object_notify (G_OBJECT (widget), "margin-right");
12904 }
12905
12906 /**
12907  * gtk_widget_get_margin_top:
12908  * @widget: a #GtkWidget
12909  *
12910  * Gets the value of the #GtkWidget:margin-top property.
12911  *
12912  * Returns: The top margin of @widget
12913  *
12914  * Since: 3.0
12915  */
12916 gint
12917 gtk_widget_get_margin_top (GtkWidget *widget)
12918 {
12919   g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
12920
12921   return _gtk_widget_get_aux_info_or_defaults (widget)->margin.top;
12922 }
12923
12924 /**
12925  * gtk_widget_set_margin_top:
12926  * @widget: a #GtkWidget
12927  * @margin: the top margin
12928  *
12929  * Sets the top margin of @widget.
12930  * See the #GtkWidget:margin-top property.
12931  *
12932  * Since: 3.0
12933  */
12934 void
12935 gtk_widget_set_margin_top (GtkWidget *widget,
12936                            gint       margin)
12937 {
12938   GtkWidgetAuxInfo *aux_info;
12939
12940   g_return_if_fail (GTK_IS_WIDGET (widget));
12941   g_return_if_fail (margin <= G_MAXINT16);
12942
12943   aux_info = gtk_widget_get_aux_info (widget, TRUE);
12944
12945   if (aux_info->margin.top == margin)
12946     return;
12947
12948   aux_info->margin.top = margin;
12949   gtk_widget_queue_resize (widget);
12950   g_object_notify (G_OBJECT (widget), "margin-top");
12951 }
12952
12953 /**
12954  * gtk_widget_get_margin_bottom:
12955  * @widget: a #GtkWidget
12956  *
12957  * Gets the value of the #GtkWidget:margin-bottom property.
12958  *
12959  * Returns: The bottom margin of @widget
12960  *
12961  * Since: 3.0
12962  */
12963 gint
12964 gtk_widget_get_margin_bottom (GtkWidget *widget)
12965 {
12966   g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
12967
12968   return _gtk_widget_get_aux_info_or_defaults (widget)->margin.bottom;
12969 }
12970
12971 /**
12972  * gtk_widget_set_margin_bottom:
12973  * @widget: a #GtkWidget
12974  * @margin: the bottom margin
12975  *
12976  * Sets the bottom margin of @widget.
12977  * See the #GtkWidget:margin-bottom property.
12978  *
12979  * Since: 3.0
12980  */
12981 void
12982 gtk_widget_set_margin_bottom (GtkWidget *widget,
12983                               gint       margin)
12984 {
12985   GtkWidgetAuxInfo *aux_info;
12986
12987   g_return_if_fail (GTK_IS_WIDGET (widget));
12988   g_return_if_fail (margin <= G_MAXINT16);
12989
12990   aux_info = gtk_widget_get_aux_info (widget, TRUE);
12991
12992   if (aux_info->margin.bottom == margin)
12993     return;
12994
12995   aux_info->margin.bottom = margin;
12996   gtk_widget_queue_resize (widget);
12997   g_object_notify (G_OBJECT (widget), "margin-bottom");
12998 }
12999
13000 /**
13001  * gtk_widget_get_clipboard:
13002  * @widget: a #GtkWidget
13003  * @selection: a #GdkAtom which identifies the clipboard
13004  *             to use. %GDK_SELECTION_CLIPBOARD gives the
13005  *             default clipboard. Another common value
13006  *             is %GDK_SELECTION_PRIMARY, which gives
13007  *             the primary X selection.
13008  *
13009  * Returns the clipboard object for the given selection to
13010  * be used with @widget. @widget must have a #GdkDisplay
13011  * associated with it, so must be attached to a toplevel
13012  * window.
13013  *
13014  * Return value: (transfer none): the appropriate clipboard object. If no
13015  *             clipboard already exists, a new one will
13016  *             be created. Once a clipboard object has
13017  *             been created, it is persistent for all time.
13018  *
13019  * Since: 2.2
13020  **/
13021 GtkClipboard *
13022 gtk_widget_get_clipboard (GtkWidget *widget, GdkAtom selection)
13023 {
13024   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
13025   g_return_val_if_fail (gtk_widget_has_screen (widget), NULL);
13026
13027   return gtk_clipboard_get_for_display (gtk_widget_get_display (widget),
13028                                         selection);
13029 }
13030
13031 /**
13032  * gtk_widget_list_mnemonic_labels:
13033  * @widget: a #GtkWidget
13034  *
13035  * Returns a newly allocated list of the widgets, normally labels, for
13036  * which this widget is the target of a mnemonic (see for example,
13037  * gtk_label_set_mnemonic_widget()).
13038
13039  * The widgets in the list are not individually referenced. If you
13040  * want to iterate through the list and perform actions involving
13041  * callbacks that might destroy the widgets, you
13042  * <emphasis>must</emphasis> call <literal>g_list_foreach (result,
13043  * (GFunc)g_object_ref, NULL)</literal> first, and then unref all the
13044  * widgets afterwards.
13045
13046  * Return value: (element-type GtkWidget) (transfer container): the list of
13047  *  mnemonic labels; free this list
13048  *  with g_list_free() when you are done with it.
13049  *
13050  * Since: 2.4
13051  **/
13052 GList *
13053 gtk_widget_list_mnemonic_labels (GtkWidget *widget)
13054 {
13055   GList *list = NULL;
13056   GSList *l;
13057
13058   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
13059
13060   for (l = g_object_get_qdata (G_OBJECT (widget), quark_mnemonic_labels); l; l = l->next)
13061     list = g_list_prepend (list, l->data);
13062
13063   return list;
13064 }
13065
13066 /**
13067  * gtk_widget_add_mnemonic_label:
13068  * @widget: a #GtkWidget
13069  * @label: a #GtkWidget that acts as a mnemonic label for @widget
13070  *
13071  * Adds a widget to the list of mnemonic labels for
13072  * this widget. (See gtk_widget_list_mnemonic_labels()). Note the
13073  * list of mnemonic labels for the widget is cleared when the
13074  * widget is destroyed, so the caller must make sure to update
13075  * its internal state at this point as well, by using a connection
13076  * to the #GtkWidget::destroy signal or a weak notifier.
13077  *
13078  * Since: 2.4
13079  **/
13080 void
13081 gtk_widget_add_mnemonic_label (GtkWidget *widget,
13082                                GtkWidget *label)
13083 {
13084   GSList *old_list, *new_list;
13085
13086   g_return_if_fail (GTK_IS_WIDGET (widget));
13087   g_return_if_fail (GTK_IS_WIDGET (label));
13088
13089   old_list = g_object_steal_qdata (G_OBJECT (widget), quark_mnemonic_labels);
13090   new_list = g_slist_prepend (old_list, label);
13091
13092   g_object_set_qdata_full (G_OBJECT (widget), quark_mnemonic_labels,
13093                            new_list, (GDestroyNotify) g_slist_free);
13094 }
13095
13096 /**
13097  * gtk_widget_remove_mnemonic_label:
13098  * @widget: a #GtkWidget
13099  * @label: a #GtkWidget that was previously set as a mnemnic label for
13100  *         @widget with gtk_widget_add_mnemonic_label().
13101  *
13102  * Removes a widget from the list of mnemonic labels for
13103  * this widget. (See gtk_widget_list_mnemonic_labels()). The widget
13104  * must have previously been added to the list with
13105  * gtk_widget_add_mnemonic_label().
13106  *
13107  * Since: 2.4
13108  **/
13109 void
13110 gtk_widget_remove_mnemonic_label (GtkWidget *widget,
13111                                   GtkWidget *label)
13112 {
13113   GSList *old_list, *new_list;
13114
13115   g_return_if_fail (GTK_IS_WIDGET (widget));
13116   g_return_if_fail (GTK_IS_WIDGET (label));
13117
13118   old_list = g_object_steal_qdata (G_OBJECT (widget), quark_mnemonic_labels);
13119   new_list = g_slist_remove (old_list, label);
13120
13121   if (new_list)
13122     g_object_set_qdata_full (G_OBJECT (widget), quark_mnemonic_labels,
13123                              new_list, (GDestroyNotify) g_slist_free);
13124 }
13125
13126 /**
13127  * gtk_widget_get_no_show_all:
13128  * @widget: a #GtkWidget
13129  *
13130  * Returns the current value of the #GtkWidget:no-show-all property,
13131  * which determines whether calls to gtk_widget_show_all()
13132  * will affect this widget.
13133  *
13134  * Return value: the current value of the "no-show-all" property.
13135  *
13136  * Since: 2.4
13137  **/
13138 gboolean
13139 gtk_widget_get_no_show_all (GtkWidget *widget)
13140 {
13141   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
13142
13143   return widget->priv->no_show_all;
13144 }
13145
13146 /**
13147  * gtk_widget_set_no_show_all:
13148  * @widget: a #GtkWidget
13149  * @no_show_all: the new value for the "no-show-all" property
13150  *
13151  * Sets the #GtkWidget:no-show-all property, which determines whether
13152  * calls to gtk_widget_show_all() will affect this widget.
13153  *
13154  * This is mostly for use in constructing widget hierarchies with externally
13155  * controlled visibility, see #GtkUIManager.
13156  *
13157  * Since: 2.4
13158  **/
13159 void
13160 gtk_widget_set_no_show_all (GtkWidget *widget,
13161                             gboolean   no_show_all)
13162 {
13163   g_return_if_fail (GTK_IS_WIDGET (widget));
13164
13165   no_show_all = (no_show_all != FALSE);
13166
13167   if (widget->priv->no_show_all != no_show_all)
13168     {
13169       widget->priv->no_show_all = no_show_all;
13170
13171       g_object_notify (G_OBJECT (widget), "no-show-all");
13172     }
13173 }
13174
13175
13176 static void
13177 gtk_widget_real_set_has_tooltip (GtkWidget *widget,
13178                                  gboolean   has_tooltip,
13179                                  gboolean   force)
13180 {
13181   GtkWidgetPrivate *priv = widget->priv;
13182   gboolean priv_has_tooltip;
13183
13184   priv_has_tooltip = GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (widget),
13185                                        quark_has_tooltip));
13186
13187   if (priv_has_tooltip != has_tooltip || force)
13188     {
13189       priv_has_tooltip = has_tooltip;
13190
13191       if (priv_has_tooltip)
13192         {
13193           if (gtk_widget_get_realized (widget) && !gtk_widget_get_has_window (widget))
13194             gdk_window_set_events (priv->window,
13195                                    gdk_window_get_events (priv->window) |
13196                                    GDK_LEAVE_NOTIFY_MASK |
13197                                    GDK_POINTER_MOTION_MASK |
13198                                    GDK_POINTER_MOTION_HINT_MASK);
13199
13200           if (gtk_widget_get_has_window (widget))
13201               gtk_widget_add_events (widget,
13202                                      GDK_LEAVE_NOTIFY_MASK |
13203                                      GDK_POINTER_MOTION_MASK |
13204                                      GDK_POINTER_MOTION_HINT_MASK);
13205         }
13206
13207       g_object_set_qdata (G_OBJECT (widget), quark_has_tooltip,
13208                           GUINT_TO_POINTER (priv_has_tooltip));
13209     }
13210 }
13211
13212 /**
13213  * gtk_widget_set_tooltip_window:
13214  * @widget: a #GtkWidget
13215  * @custom_window: (allow-none): a #GtkWindow, or %NULL
13216  *
13217  * Replaces the default, usually yellow, window used for displaying
13218  * tooltips with @custom_window. GTK+ will take care of showing and
13219  * hiding @custom_window at the right moment, to behave likewise as
13220  * the default tooltip window. If @custom_window is %NULL, the default
13221  * tooltip window will be used.
13222  *
13223  * If the custom window should have the default theming it needs to
13224  * have the name "gtk-tooltip", see gtk_widget_set_name().
13225  *
13226  * Since: 2.12
13227  */
13228 void
13229 gtk_widget_set_tooltip_window (GtkWidget *widget,
13230                                GtkWindow *custom_window)
13231 {
13232   gboolean has_tooltip;
13233   gchar *tooltip_markup;
13234
13235   g_return_if_fail (GTK_IS_WIDGET (widget));
13236   g_return_if_fail (custom_window == NULL || GTK_IS_WINDOW (custom_window));
13237
13238   tooltip_markup = g_object_get_qdata (G_OBJECT (widget), quark_tooltip_markup);
13239
13240   if (custom_window)
13241     g_object_ref (custom_window);
13242
13243   g_object_set_qdata_full (G_OBJECT (widget), quark_tooltip_window,
13244                            custom_window, g_object_unref);
13245
13246   has_tooltip = (custom_window != NULL || tooltip_markup != NULL);
13247   gtk_widget_real_set_has_tooltip (widget, has_tooltip, FALSE);
13248
13249   if (has_tooltip && gtk_widget_get_visible (widget))
13250     gtk_widget_queue_tooltip_query (widget);
13251 }
13252
13253 /**
13254  * gtk_widget_get_tooltip_window:
13255  * @widget: a #GtkWidget
13256  *
13257  * Returns the #GtkWindow of the current tooltip. This can be the
13258  * GtkWindow created by default, or the custom tooltip window set
13259  * using gtk_widget_set_tooltip_window().
13260  *
13261  * Return value: (transfer none): The #GtkWindow of the current tooltip.
13262  *
13263  * Since: 2.12
13264  */
13265 GtkWindow *
13266 gtk_widget_get_tooltip_window (GtkWidget *widget)
13267 {
13268   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
13269
13270   return g_object_get_qdata (G_OBJECT (widget), quark_tooltip_window);
13271 }
13272
13273 /**
13274  * gtk_widget_trigger_tooltip_query:
13275  * @widget: a #GtkWidget
13276  *
13277  * Triggers a tooltip query on the display where the toplevel of @widget
13278  * is located. See gtk_tooltip_trigger_tooltip_query() for more
13279  * information.
13280  *
13281  * Since: 2.12
13282  */
13283 void
13284 gtk_widget_trigger_tooltip_query (GtkWidget *widget)
13285 {
13286   gtk_tooltip_trigger_tooltip_query (gtk_widget_get_display (widget));
13287 }
13288
13289 static guint tooltip_query_id;
13290 static GSList *tooltip_query_displays;
13291
13292 static gboolean
13293 tooltip_query_idle (gpointer data)
13294 {
13295   g_slist_foreach (tooltip_query_displays, (GFunc)gtk_tooltip_trigger_tooltip_query, NULL);
13296   g_slist_foreach (tooltip_query_displays, (GFunc)g_object_unref, NULL);
13297   g_slist_free (tooltip_query_displays);
13298
13299   tooltip_query_displays = NULL;
13300   tooltip_query_id = 0;
13301
13302   return FALSE;
13303 }
13304
13305 static void
13306 gtk_widget_queue_tooltip_query (GtkWidget *widget)
13307 {
13308   GdkDisplay *display;
13309
13310   display = gtk_widget_get_display (widget);
13311
13312   if (!g_slist_find (tooltip_query_displays, display))
13313     tooltip_query_displays = g_slist_prepend (tooltip_query_displays, g_object_ref (display));
13314
13315   if (tooltip_query_id == 0)
13316     tooltip_query_id = gdk_threads_add_idle (tooltip_query_idle, NULL);
13317 }
13318
13319 /**
13320  * gtk_widget_set_tooltip_text:
13321  * @widget: a #GtkWidget
13322  * @text: the contents of the tooltip for @widget
13323  *
13324  * Sets @text as the contents of the tooltip. This function will take
13325  * care of setting #GtkWidget:has-tooltip to %TRUE and of the default
13326  * handler for the #GtkWidget::query-tooltip signal.
13327  *
13328  * See also the #GtkWidget:tooltip-text property and gtk_tooltip_set_text().
13329  *
13330  * Since: 2.12
13331  */
13332 void
13333 gtk_widget_set_tooltip_text (GtkWidget   *widget,
13334                              const gchar *text)
13335 {
13336   g_return_if_fail (GTK_IS_WIDGET (widget));
13337
13338   g_object_set (G_OBJECT (widget), "tooltip-text", text, NULL);
13339 }
13340
13341 /**
13342  * gtk_widget_get_tooltip_text:
13343  * @widget: a #GtkWidget
13344  *
13345  * Gets the contents of the tooltip for @widget.
13346  *
13347  * Return value: the tooltip text, or %NULL. You should free the
13348  *   returned string with g_free() when done.
13349  *
13350  * Since: 2.12
13351  */
13352 gchar *
13353 gtk_widget_get_tooltip_text (GtkWidget *widget)
13354 {
13355   gchar *text = NULL;
13356
13357   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
13358
13359   g_object_get (G_OBJECT (widget), "tooltip-text", &text, NULL);
13360
13361   return text;
13362 }
13363
13364 /**
13365  * gtk_widget_set_tooltip_markup:
13366  * @widget: a #GtkWidget
13367  * @markup: (allow-none): the contents of the tooltip for @widget, or %NULL
13368  *
13369  * Sets @markup as the contents of the tooltip, which is marked up with
13370  *  the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
13371  *
13372  * This function will take care of setting #GtkWidget:has-tooltip to %TRUE
13373  * and of the default handler for the #GtkWidget::query-tooltip signal.
13374  *
13375  * See also the #GtkWidget:tooltip-markup property and
13376  * gtk_tooltip_set_markup().
13377  *
13378  * Since: 2.12
13379  */
13380 void
13381 gtk_widget_set_tooltip_markup (GtkWidget   *widget,
13382                                const gchar *markup)
13383 {
13384   g_return_if_fail (GTK_IS_WIDGET (widget));
13385
13386   g_object_set (G_OBJECT (widget), "tooltip-markup", markup, NULL);
13387 }
13388
13389 /**
13390  * gtk_widget_get_tooltip_markup:
13391  * @widget: a #GtkWidget
13392  *
13393  * Gets the contents of the tooltip for @widget.
13394  *
13395  * Return value: the tooltip text, or %NULL. You should free the
13396  *   returned string with g_free() when done.
13397  *
13398  * Since: 2.12
13399  */
13400 gchar *
13401 gtk_widget_get_tooltip_markup (GtkWidget *widget)
13402 {
13403   gchar *text = NULL;
13404
13405   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
13406
13407   g_object_get (G_OBJECT (widget), "tooltip-markup", &text, NULL);
13408
13409   return text;
13410 }
13411
13412 /**
13413  * gtk_widget_set_has_tooltip:
13414  * @widget: a #GtkWidget
13415  * @has_tooltip: whether or not @widget has a tooltip.
13416  *
13417  * Sets the has-tooltip property on @widget to @has_tooltip.  See
13418  * #GtkWidget:has-tooltip for more information.
13419  *
13420  * Since: 2.12
13421  */
13422 void
13423 gtk_widget_set_has_tooltip (GtkWidget *widget,
13424                             gboolean   has_tooltip)
13425 {
13426   g_return_if_fail (GTK_IS_WIDGET (widget));
13427
13428   g_object_set (G_OBJECT (widget), "has-tooltip", has_tooltip, NULL);
13429 }
13430
13431 /**
13432  * gtk_widget_get_has_tooltip:
13433  * @widget: a #GtkWidget
13434  *
13435  * Returns the current value of the has-tooltip property.  See
13436  * #GtkWidget:has-tooltip for more information.
13437  *
13438  * Return value: current value of has-tooltip on @widget.
13439  *
13440  * Since: 2.12
13441  */
13442 gboolean
13443 gtk_widget_get_has_tooltip (GtkWidget *widget)
13444 {
13445   gboolean has_tooltip = FALSE;
13446
13447   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
13448
13449   g_object_get (G_OBJECT (widget), "has-tooltip", &has_tooltip, NULL);
13450
13451   return has_tooltip;
13452 }
13453
13454 /**
13455  * gtk_widget_get_allocation:
13456  * @widget: a #GtkWidget
13457  * @allocation: (out): a pointer to a #GtkAllocation to copy to
13458  *
13459  * Retrieves the widget's allocation.
13460  *
13461  * Note, when implementing a #GtkContainer: a widget's allocation will
13462  * be its "adjusted" allocation, that is, the widget's parent
13463  * container typically calls gtk_widget_size_allocate() with an
13464  * allocation, and that allocation is then adjusted (to handle margin
13465  * and alignment for example) before assignment to the widget.
13466  * gtk_widget_get_allocation() returns the adjusted allocation that
13467  * was actually assigned to the widget. The adjusted allocation is
13468  * guaranteed to be completely contained within the
13469  * gtk_widget_size_allocate() allocation, however. So a #GtkContainer
13470  * is guaranteed that its children stay inside the assigned bounds,
13471  * but not that they have exactly the bounds the container assigned.
13472  * There is no way to get the original allocation assigned by
13473  * gtk_widget_size_allocate(), since it isn't stored; if a container
13474  * implementation needs that information it will have to track it itself.
13475  *
13476  * Since: 2.18
13477  */
13478 void
13479 gtk_widget_get_allocation (GtkWidget     *widget,
13480                            GtkAllocation *allocation)
13481 {
13482   GtkWidgetPrivate *priv;
13483
13484   g_return_if_fail (GTK_IS_WIDGET (widget));
13485   g_return_if_fail (allocation != NULL);
13486
13487   priv = widget->priv;
13488
13489   *allocation = priv->allocation;
13490 }
13491
13492 /**
13493  * gtk_widget_set_allocation:
13494  * @widget: a #GtkWidget
13495  * @allocation: a pointer to a #GtkAllocation to copy from
13496  *
13497  * Sets the widget's allocation.  This should not be used
13498  * directly, but from within a widget's size_allocate method.
13499  *
13500  * The allocation set should be the "adjusted" or actual
13501  * allocation. If you're implementing a #GtkContainer, you want to use
13502  * gtk_widget_size_allocate() instead of gtk_widget_set_allocation().
13503  * The GtkWidgetClass::adjust_size_allocation virtual method adjusts the
13504  * allocation inside gtk_widget_size_allocate() to create an adjusted
13505  * allocation.
13506  *
13507  * Since: 2.18
13508  */
13509 void
13510 gtk_widget_set_allocation (GtkWidget           *widget,
13511                            const GtkAllocation *allocation)
13512 {
13513   GtkWidgetPrivate *priv;
13514
13515   g_return_if_fail (GTK_IS_WIDGET (widget));
13516   g_return_if_fail (allocation != NULL);
13517
13518   priv = widget->priv;
13519
13520   priv->allocation = *allocation;
13521 }
13522
13523 /**
13524  * gtk_widget_get_allocated_width:
13525  * @widget: the widget to query
13526  *
13527  * Returns the width that has currently been allocated to @widget.
13528  * This function is intended to be used when implementing handlers
13529  * for the #GtkWidget::draw function.
13530  *
13531  * Returns: the width of the @widget
13532  **/
13533 int
13534 gtk_widget_get_allocated_width (GtkWidget *widget)
13535 {
13536   g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
13537
13538   return widget->priv->allocation.width;
13539 }
13540
13541 /**
13542  * gtk_widget_get_allocated_height:
13543  * @widget: the widget to query
13544  *
13545  * Returns the height that has currently been allocated to @widget.
13546  * This function is intended to be used when implementing handlers
13547  * for the #GtkWidget::draw function.
13548  *
13549  * Returns: the height of the @widget
13550  **/
13551 int
13552 gtk_widget_get_allocated_height (GtkWidget *widget)
13553 {
13554   g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
13555
13556   return widget->priv->allocation.height;
13557 }
13558
13559 /**
13560  * gtk_widget_get_requisition:
13561  * @widget: a #GtkWidget
13562  * @requisition: (out): a pointer to a #GtkRequisition to copy to
13563  *
13564  * Retrieves the widget's requisition.
13565  *
13566  * This function should only be used by widget implementations in
13567  * order to figure whether the widget's requisition has actually
13568  * changed after some internal state change (so that they can call
13569  * gtk_widget_queue_resize() instead of gtk_widget_queue_draw()).
13570  *
13571  * Normally, gtk_widget_size_request() should be used.
13572  *
13573  * Since: 2.20
13574  *
13575  * Deprecated: 3.0: The #GtkRequisition cache on the widget was
13576  * removed, If you need to cache sizes across requests and allocations,
13577  * add an explicit cache to the widget in question instead.
13578  */
13579 void
13580 gtk_widget_get_requisition (GtkWidget      *widget,
13581                             GtkRequisition *requisition)
13582 {
13583   g_return_if_fail (GTK_IS_WIDGET (widget));
13584   g_return_if_fail (requisition != NULL);
13585
13586   gtk_widget_get_preferred_size (widget, requisition, NULL);
13587 }
13588
13589 /**
13590  * gtk_widget_set_window:
13591  * @widget: a #GtkWidget
13592  * @window: (transfer full): a #GdkWindow
13593  *
13594  * Sets a widget's window. This function should only be used in a
13595  * widget's #GtkWidget::realize implementation. The %window passed is
13596  * usually either new window created with gdk_window_new(), or the
13597  * window of its parent widget as returned by
13598  * gtk_widget_get_parent_window().
13599  *
13600  * Widgets must indicate whether they will create their own #GdkWindow
13601  * by calling gtk_widget_set_has_window(). This is usually done in the
13602  * widget's init() function.
13603  *
13604  * <note><para>This function does not add any reference to @window.</para></note>
13605  *
13606  * Since: 2.18
13607  */
13608 void
13609 gtk_widget_set_window (GtkWidget *widget,
13610                        GdkWindow *window)
13611 {
13612   GtkWidgetPrivate *priv;
13613
13614   g_return_if_fail (GTK_IS_WIDGET (widget));
13615   g_return_if_fail (window == NULL || GDK_IS_WINDOW (window));
13616
13617   priv = widget->priv;
13618
13619   if (priv->window != window)
13620     {
13621       priv->window = window;
13622       g_object_notify (G_OBJECT (widget), "window");
13623     }
13624 }
13625
13626 /**
13627  * gtk_widget_get_window:
13628  * @widget: a #GtkWidget
13629  *
13630  * Returns the widget's window if it is realized, %NULL otherwise
13631  *
13632  * Return value: (transfer none): @widget's window.
13633  *
13634  * Since: 2.14
13635  */
13636 GdkWindow*
13637 gtk_widget_get_window (GtkWidget *widget)
13638 {
13639   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
13640
13641   return widget->priv->window;
13642 }
13643
13644 /**
13645  * gtk_widget_get_support_multidevice:
13646  * @widget: a #GtkWidget
13647  *
13648  * Returns %TRUE if @widget is multiple pointer aware. See
13649  * gtk_widget_set_support_multidevice() for more information.
13650  *
13651  * Returns: %TRUE if @widget is multidevice aware.
13652  **/
13653 gboolean
13654 gtk_widget_get_support_multidevice (GtkWidget *widget)
13655 {
13656   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
13657
13658   return widget->priv->multidevice;
13659 }
13660
13661 /**
13662  * gtk_widget_set_support_multidevice:
13663  * @widget: a #GtkWidget
13664  * @support_multidevice: %TRUE to support input from multiple devices.
13665  *
13666  * Enables or disables multiple pointer awareness. If this setting is %TRUE,
13667  * @widget will start receiving multiple, per device enter/leave events. Note
13668  * that if custom #GdkWindow<!-- -->s are created in #GtkWidget::realize,
13669  * gdk_window_set_support_multidevice() will have to be called manually on them.
13670  *
13671  * Since: 3.0
13672  **/
13673 void
13674 gtk_widget_set_support_multidevice (GtkWidget *widget,
13675                                     gboolean   support_multidevice)
13676 {
13677   GtkWidgetPrivate *priv;
13678
13679   g_return_if_fail (GTK_IS_WIDGET (widget));
13680
13681   priv = widget->priv;
13682   priv->multidevice = (support_multidevice == TRUE);
13683
13684   if (gtk_widget_get_realized (widget))
13685     gdk_window_set_support_multidevice (priv->window, support_multidevice);
13686 }
13687
13688 static void
13689 _gtk_widget_set_has_focus (GtkWidget *widget,
13690                            gboolean   has_focus)
13691 {
13692   widget->priv->has_focus = has_focus;
13693
13694   if (has_focus)
13695     gtk_widget_set_state_flags (widget, GTK_STATE_FLAG_FOCUSED, FALSE);
13696   else
13697     gtk_widget_unset_state_flags (widget, GTK_STATE_FLAG_FOCUSED);
13698 }
13699
13700 /**
13701  * gtk_widget_send_focus_change:
13702  * @widget: a #GtkWidget
13703  * @event: a #GdkEvent of type GDK_FOCUS_CHANGE
13704  *
13705  * Sends the focus change @event to @widget
13706  *
13707  * This function is not meant to be used by applications. The only time it
13708  * should be used is when it is necessary for a #GtkWidget to assign focus
13709  * to a widget that is semantically owned by the first widget even though
13710  * it's not a direct child - for instance, a search entry in a floating
13711  * window similar to the quick search in #GtkTreeView.
13712  *
13713  * An example of its usage is:
13714  *
13715  * |[
13716  *   GdkEvent *fevent = gdk_event_new (GDK_FOCUS_CHANGE);
13717  *
13718  *   fevent->focus_change.type = GDK_FOCUS_CHANGE;
13719  *   fevent->focus_change.in = TRUE;
13720  *   fevent->focus_change.window = gtk_widget_get_window (widget);
13721  *   if (fevent->focus_change.window != NULL)
13722  *     g_object_ref (fevent->focus_change.window);
13723  *
13724  *   gtk_widget_send_focus_change (widget, fevent);
13725  *
13726  *   gdk_event_free (event);
13727  * ]|
13728  *
13729  * Return value: the return value from the event signal emission: %TRUE
13730  *   if the event was handled, and %FALSE otherwise
13731  *
13732  * Since: 2.20
13733  */
13734 gboolean
13735 gtk_widget_send_focus_change (GtkWidget *widget,
13736                               GdkEvent  *event)
13737 {
13738   gboolean res;
13739
13740   g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
13741   g_return_val_if_fail (event != NULL && event->type == GDK_FOCUS_CHANGE, FALSE);
13742
13743   g_object_ref (widget);
13744
13745   _gtk_widget_set_has_focus (widget, event->focus_change.in);
13746
13747   res = gtk_widget_event (widget, event);
13748
13749   g_object_notify (G_OBJECT (widget), "has-focus");
13750
13751   g_object_unref (widget);
13752
13753   return res;
13754 }
13755
13756 /**
13757  * gtk_widget_in_destruction:
13758  * @widget: a #GtkWidget
13759  *
13760  * Returns whether the widget is currently being destroyed.
13761  * This information can sometimes be used to avoid doing
13762  * unnecessary work.
13763  *
13764  * Returns: %TRUE if @widget is being destroyed
13765  */
13766 gboolean
13767 gtk_widget_in_destruction (GtkWidget *widget)
13768 {
13769   return widget->priv->in_destruction;
13770 }
13771
13772 gboolean
13773 _gtk_widget_get_in_reparent (GtkWidget *widget)
13774 {
13775   return widget->priv->in_reparent;
13776 }
13777
13778 void
13779 _gtk_widget_set_in_reparent (GtkWidget *widget,
13780                              gboolean   in_reparent)
13781 {
13782   widget->priv->in_reparent = in_reparent;
13783 }
13784
13785 gboolean
13786 _gtk_widget_get_anchored (GtkWidget *widget)
13787 {
13788   return widget->priv->anchored;
13789 }
13790
13791 void
13792 _gtk_widget_set_anchored (GtkWidget *widget,
13793                           gboolean   anchored)
13794 {
13795   widget->priv->anchored = anchored;
13796 }
13797
13798 gboolean
13799 _gtk_widget_get_shadowed (GtkWidget *widget)
13800 {
13801   return widget->priv->shadowed;
13802 }
13803
13804 void
13805 _gtk_widget_set_shadowed (GtkWidget *widget,
13806                           gboolean   shadowed)
13807 {
13808   widget->priv->shadowed = shadowed;
13809 }
13810
13811 gboolean
13812 _gtk_widget_get_alloc_needed (GtkWidget *widget)
13813 {
13814   return widget->priv->alloc_needed;
13815 }
13816
13817 void
13818 _gtk_widget_set_alloc_needed (GtkWidget *widget,
13819                               gboolean   alloc_needed)
13820 {
13821   widget->priv->alloc_needed = alloc_needed;
13822 }
13823
13824 void
13825 _gtk_widget_add_sizegroup (GtkWidget    *widget,
13826                            gpointer      group)
13827 {
13828   GSList *groups;
13829
13830   groups = g_object_get_qdata (G_OBJECT (widget), quark_size_groups);
13831   groups = g_slist_prepend (groups, group);
13832   g_object_set_qdata (G_OBJECT (widget), quark_size_groups, groups);
13833
13834   widget->priv->have_size_groups = TRUE;
13835 }
13836
13837 void
13838 _gtk_widget_remove_sizegroup (GtkWidget    *widget,
13839                               gpointer      group)
13840 {
13841   GSList *groups;
13842
13843   groups = g_object_get_qdata (G_OBJECT (widget), quark_size_groups);
13844   groups = g_slist_remove (groups, group);
13845   g_object_set_qdata (G_OBJECT (widget), quark_size_groups, groups);
13846
13847   widget->priv->have_size_groups = groups != NULL;
13848 }
13849
13850 GSList *
13851 _gtk_widget_get_sizegroups (GtkWidget    *widget)
13852 {
13853   if (widget->priv->have_size_groups)
13854     return g_object_get_qdata (G_OBJECT (widget), quark_size_groups);
13855
13856   return NULL;
13857 }
13858
13859 void
13860 _gtk_widget_add_attached_window (GtkWidget    *widget,
13861                                  GtkWindow    *window)
13862 {
13863   widget->priv->attached_windows = g_list_prepend (widget->priv->attached_windows, window);
13864 }
13865
13866 void
13867 _gtk_widget_remove_attached_window (GtkWidget    *widget,
13868                                     GtkWindow    *window)
13869 {
13870   widget->priv->attached_windows = g_list_remove (widget->priv->attached_windows, window);
13871 }
13872
13873 /**
13874  * gtk_widget_path_append_for_widget:
13875  * @path: a widget path
13876  * @widget: the widget to append to the widget path
13877  *
13878  * Appends the data from @widget to the widget hierarchy represented
13879  * by @path. This function is a shortcut for adding information from
13880  * @widget to the given @path. This includes setting the name or
13881  * adding the style classes from @widget.
13882  *
13883  * Returns: the position where the data was inserted
13884  *
13885  * Since: 3.2
13886  */
13887 gint
13888 gtk_widget_path_append_for_widget (GtkWidgetPath *path,
13889                                    GtkWidget     *widget)
13890 {
13891   gint pos;
13892
13893   g_return_val_if_fail (path != NULL, 0);
13894   g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
13895
13896   pos = gtk_widget_path_append_type (path, G_OBJECT_TYPE (widget));
13897
13898   if (widget->priv->name)
13899     gtk_widget_path_iter_set_name (path, pos, widget->priv->name);
13900
13901   if (widget->priv->context)
13902     {
13903       GList *classes, *l;
13904
13905       /* Also add any persistent classes in
13906        * the style context the widget path
13907        */
13908       classes = gtk_style_context_list_classes (widget->priv->context);
13909
13910       for (l = classes; l; l = l->next)
13911         gtk_widget_path_iter_add_class (path, pos, l->data);
13912
13913       g_list_free (classes);
13914     }
13915
13916   return pos;
13917 }
13918
13919 GtkWidgetPath *
13920 _gtk_widget_create_path (GtkWidget *widget)
13921 {
13922   GtkWidget *parent;
13923
13924   parent = widget->priv->parent;
13925
13926   if (parent)
13927     return gtk_container_get_path_for_child (GTK_CONTAINER (parent), widget);
13928   else
13929     {
13930       /* Widget is either toplevel or unparented, treat both
13931        * as toplevels style wise, since there are situations
13932        * where style properties might be retrieved on that
13933        * situation.
13934        */
13935       GtkWidget *attach_widget = NULL;
13936       GtkWidgetPath *result;
13937
13938       if (GTK_IS_WINDOW (widget))
13939         attach_widget = gtk_window_get_attached_to (GTK_WINDOW (widget));
13940
13941       if (attach_widget != NULL)
13942         result = gtk_widget_path_copy (gtk_widget_get_path (attach_widget));
13943       else
13944         result = gtk_widget_path_new ();
13945
13946       gtk_widget_path_append_for_widget (result, widget);
13947
13948       return result;
13949     }
13950 }
13951
13952 /**
13953  * gtk_widget_get_path:
13954  * @widget: a #GtkWidget
13955  *
13956  * Returns the #GtkWidgetPath representing @widget, if the widget
13957  * is not connected to a toplevel widget, a partial path will be
13958  * created.
13959  *
13960  * Returns: (transfer none): The #GtkWidgetPath representing @widget
13961  **/
13962 GtkWidgetPath *
13963 gtk_widget_get_path (GtkWidget *widget)
13964 {
13965   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
13966
13967   if (!widget->priv->path)
13968     widget->priv->path = _gtk_widget_create_path (widget);
13969
13970   return widget->priv->path;
13971 }
13972
13973 void
13974 _gtk_widget_style_context_invalidated (GtkWidget *widget)
13975 {
13976   if (widget->priv->path)
13977     {
13978       gtk_widget_path_free (widget->priv->path);
13979       widget->priv->path = NULL;
13980     }
13981
13982   if (gtk_widget_get_realized (widget))
13983     g_signal_emit (widget, widget_signals[STYLE_UPDATED], 0);
13984   else
13985     {
13986       /* Compress all style updates so it
13987        * is only emitted once pre-realize.
13988        */
13989       widget->priv->style_update_pending = TRUE;
13990     }
13991 }
13992
13993 /**
13994  * gtk_widget_get_style_context:
13995  * @widget: a #GtkWidget
13996  *
13997  * Returns the style context associated to @widget.
13998  *
13999  * Returns: (transfer none): a #GtkStyleContext. This memory is owned by @widget and
14000  *          must not be freed.
14001  **/
14002 GtkStyleContext *
14003 gtk_widget_get_style_context (GtkWidget *widget)
14004 {
14005   GtkWidgetPrivate *priv;
14006
14007   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
14008
14009   priv = widget->priv;
14010
14011   if (G_UNLIKELY (priv->context == NULL))
14012     {
14013       GdkScreen *screen;
14014
14015       priv->context = gtk_style_context_new ();
14016
14017       gtk_style_context_set_state (priv->context, priv->state_flags);
14018
14019       screen = gtk_widget_get_screen (widget);
14020       if (screen)
14021         gtk_style_context_set_screen (priv->context, screen);
14022
14023       if (priv->parent)
14024         gtk_style_context_set_parent (priv->context,
14025                                       gtk_widget_get_style_context (priv->parent));
14026
14027       _gtk_style_context_set_widget (priv->context, widget);
14028     }
14029
14030   return widget->priv->context;
14031 }
14032
14033 void
14034 _gtk_widget_invalidate_style_context (GtkWidget    *widget,
14035                                       GtkCssChange  change)
14036 {
14037   GtkWidgetPrivate *priv;
14038
14039   priv = widget->priv;
14040
14041   if (priv->context == NULL)
14042     return;
14043
14044   _gtk_style_context_queue_invalidate (priv->context, change);
14045 }
14046
14047 /**
14048  * gtk_widget_get_modifier_mask:
14049  * @widget: a #GtkWidget
14050  * @intent: the use case for the modifier mask
14051  *
14052  * Returns the modifier mask the @widget's windowing system backend
14053  * uses for a particular purpose.
14054  *
14055  * See gdk_keymap_get_modifier_mask().
14056  *
14057  * Returns: the modifier mask used for @intent.
14058  *
14059  * Since: 3.4
14060  **/
14061 GdkModifierType
14062 gtk_widget_get_modifier_mask (GtkWidget         *widget,
14063                               GdkModifierIntent  intent)
14064 {
14065   GdkDisplay *display;
14066
14067   g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
14068
14069   display = gtk_widget_get_display (widget);
14070
14071   return gdk_keymap_get_modifier_mask (gdk_keymap_get_for_display (display),
14072                                        intent);
14073 }
14074
14075 GtkStyle *
14076 _gtk_widget_get_style (GtkWidget *widget)
14077 {
14078   return widget->priv->style;
14079 }
14080
14081 void
14082 _gtk_widget_set_style (GtkWidget *widget,
14083                        GtkStyle  *style)
14084 {
14085   widget->priv->style = style;
14086 }
14087
14088 void
14089 _gtk_widget_update_parent_muxer (GtkWidget *widget)
14090 {
14091   GtkWidget *parent;
14092   GActionMuxer *parent_muxer;
14093
14094   if (widget->priv->muxer == NULL)
14095     return;
14096
14097   if (GTK_IS_MENU (widget))
14098     parent = gtk_menu_get_attach_widget (GTK_MENU (widget));
14099   else
14100     parent = gtk_widget_get_parent (widget);
14101
14102   parent_muxer = parent ? _gtk_widget_get_action_muxer (parent) : NULL;
14103
14104   g_action_muxer_set_parent (widget->priv->muxer, parent_muxer);
14105 }
14106
14107 GActionMuxer *
14108 _gtk_widget_get_action_muxer (GtkWidget *widget)
14109 {
14110   if (widget->priv->muxer == NULL)
14111     {
14112       widget->priv->muxer = g_action_muxer_new ();
14113       _gtk_widget_update_parent_muxer (widget);
14114     }
14115
14116   return widget->priv->muxer;
14117 }
14118
14119 /**
14120  * gtk_widget_insert_action_group:
14121  * @widget: a #GtkWidget
14122  * @name: the prefix for actions in @group
14123  * @group: a #GActionGroup
14124  *
14125  * Inserts @group into @widget. Children of @widget that implement
14126  * #GtkActionable can then be associated with actions in @group by
14127  * setting their 'action-name' to
14128  * @prefix.<replaceable>action-name</replaceable>.
14129  *
14130  * Since: 3.6
14131  */
14132 void
14133 gtk_widget_insert_action_group (GtkWidget    *widget,
14134                                 const gchar  *name,
14135                                 GActionGroup *group)
14136 {
14137   GActionMuxer *muxer;
14138
14139   g_return_if_fail (GTK_IS_WIDGET (widget));
14140   g_return_if_fail (name != NULL);
14141
14142   muxer = _gtk_widget_get_action_muxer (widget);
14143
14144   if (group)
14145     g_action_muxer_insert (muxer, name, group);
14146   else
14147     g_action_muxer_remove (muxer, name);
14148 }