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

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