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