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