1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
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.
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.
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.
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/.
33 #include <gobject/gvaluecollector.h>
34 #include <gobject/gobjectnotifyqueue.c>
35 #include <cairo-gobject.h>
37 #include "gtkcontainer.h"
38 #include "gtkaccelmapprivate.h"
39 #include "gtkclipboard.h"
40 #include "gtkiconfactory.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"
66 #include "gtktypebuiltins.h"
67 #include "a11y/gtkwidgetaccessible.h"
71 * @Short_description: Base class for all widgets
74 * GtkWidget is the base class all widgets in GTK+ derive from. It manages the
75 * widget lifecycle, states and style.
77 * <refsect2 id="geometry-management">
78 * <title>Height-for-width Geometry Management</title>
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.
87 * Height-for-width geometry management is implemented in GTK+ by way
88 * of five virtual methods:
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>
97 * There are some important things to keep in mind when implementing
98 * height-for-width and when using it in container implementations.
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.
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).
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.
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.
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.
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.
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()
154 * <programlisting><![CDATA[
156 * foo_widget_get_preferred_height (GtkWidget *widget, gint *min_height, gint *nat_height)
158 * if (i_am_in_height_for_width_mode)
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);
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.
172 * ]]></programlisting>
174 * And in #GtkWidgetClass.get_preferred_width_for_height() it will simply return
175 * the minimum and natural width:
177 * <programlisting><![CDATA[
179 * foo_widget_get_preferred_width_for_height (GtkWidget *widget, gint for_height,
180 * gint *min_width, gint *nat_width)
182 * if (i_am_in_height_for_width_mode)
184 * GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, min_width, nat_width);
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.
193 * ]]></programlisting>
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:
201 * <title>Widget calling its own size request method.</title>
203 * GTK_WIDGET_GET_CLASS(widget)->get_preferred_width (widget),
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
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.
224 * <refsect2 id="style-properties">
225 * <title>Style Properties</title>
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.
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.
243 * <refsect2 id="GtkWidget-BUILDER-UI">
244 * <title>GtkWidget as GtkBuildable</title>
246 * The GtkWidget implementation of the GtkBuildable interface supports a
247 * custom <accelerator> element, which has attributes named key,
248 * modifiers and signal and allows to specify accelerators.
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"/>
256 * ]]></programlisting>
259 * In addition to accelerators, <structname>GtkWidget</structname> also support a
260 * custom <accessible> 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>.
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>
270 * <object class="GtkButton" id="button1">
272 * <action action_name="click" translatable="yes">Click the button.</action>
273 * <relation target="label1" type="labelled-by"/>
275 * <child internal-child="accessible">
276 * <object class="AtkObject" id="a11y-button1">
277 * <property name="AtkObject::name">Clickable Button</property>
281 * ]]></programlisting>
284 * Finally, GtkWidget allows style information such as style classes to
285 * be associated with widgets, using the custom <style> element:
287 * <title>A UI definition fragment specifying an style class</title>
288 * <programlisting><![CDATA[
289 * <object class="GtkButton" id="button1">
291 * <class name="my-special-button-class"/>
292 * <class name="dark-button"/>
295 * ]]></programlisting>
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.
305 #define GTK_STATE_FLAGS_DONT_PROPAGATE (GTK_STATE_FLAG_FOCUSED)
306 #define GTK_STATE_FLAGS_DO_PROPAGATE (~GTK_STATE_FLAGS_DONT_PROPAGATE)
308 #define WIDGET_CLASS(w) GTK_WIDGET_GET_CLASS (w)
310 #define GTK_STATE_FLAGS_BITS 7
312 struct _GtkWidgetPrivate
314 /* The state of the widget. Needs to be able to hold all GtkStateFlags bits
315 * (defined in "gtkenums.h").
317 guint state_flags : GTK_STATE_FLAGS_BITS;
321 guint in_destruction : 1;
324 guint composite_child : 1;
332 guint can_default : 1;
333 guint has_default : 1;
334 guint receives_default : 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;
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;
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 */
359 guint hexpand_set : 1; /* whether to use application-forced */
360 guint vexpand_set : 1; /* instead of computing from children */
362 /* SizeGroup related flags */
363 guint sizegroup_visited : 1;
364 guint sizegroup_bumping : 1;
365 guint have_size_groups : 1;
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.
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.
381 GtkStyleContext *context;
383 /* Widget's path for styling */
386 /* The widget's allocated size */
387 GtkAllocation allocation;
389 /* The widget's requested sizes */
390 SizeRequestCache requests;
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).
398 /* The widget's parent */
401 #ifdef G_ENABLE_DEBUG
402 /* Number of gtk_widget_push_verify_invariants () */
403 guint verifying_invariants_count;
404 #endif /* G_ENABLE_DEBUG */
407 struct _GtkWidgetClassPrivate
409 GType accessible_type;
410 AtkRole accessible_role;
439 BUTTON_RELEASE_EVENT,
453 PROPERTY_NOTIFY_EVENT,
454 SELECTION_CLEAR_EVENT,
455 SELECTION_REQUEST_EVENT,
456 SELECTION_NOTIFY_EVENT,
461 VISIBILITY_NOTIFY_EVENT,
475 ACCEL_CLOSURES_CHANGED,
499 PROP_RECEIVES_DEFAULT,
500 PROP_COMPOSITE_CHILD,
508 PROP_DOUBLE_BUFFERED,
523 typedef struct _GtkStateData GtkStateData;
526 STATE_CHANGE_REPLACE,
533 guint flags : GTK_STATE_FLAGS_BITS;
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,
546 static void gtk_widget_get_property (GObject *object,
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);
566 static void gtk_widget_real_grab_focus (GtkWidget *focus_widget);
567 static gboolean gtk_widget_real_query_tooltip (GtkWidget *widget,
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);
576 static void gtk_widget_dispatch_child_properties_changed (GtkWidget *object,
578 GParamSpec **pspecs);
579 static gboolean gtk_widget_real_key_press_event (GtkWidget *widget,
581 static gboolean gtk_widget_real_key_release_event (GtkWidget *widget,
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);
598 #define gtk_widget_verify_invariants(widget)
599 #define gtk_widget_push_verify_invariants(widget)
600 #define gtk_widget_pop_verify_invariants(widget)
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,
607 static gint gtk_widget_event_internal (GtkWidget *widget,
609 static gboolean gtk_widget_real_mnemonic_activate (GtkWidget *widget,
610 gboolean group_cycling);
611 static void gtk_widget_real_get_width (GtkWidget *widget,
614 static void gtk_widget_real_get_height (GtkWidget *widget,
617 static void gtk_widget_real_get_height_for_width (GtkWidget *widget,
619 gint *minimum_height,
620 gint *natural_height);
621 static void gtk_widget_real_get_width_for_height (GtkWidget *widget,
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,
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,
641 static void gtk_widget_real_set_has_tooltip (GtkWidget *widget,
642 gboolean has_tooltip,
644 static void gtk_widget_buildable_interface_init (GtkBuildableIface *iface);
645 static void gtk_widget_buildable_set_name (GtkBuildable *buildable,
647 static const gchar * gtk_widget_buildable_get_name (GtkBuildable *buildable);
648 static GObject * gtk_widget_buildable_get_internal_child (GtkBuildable *buildable,
650 const gchar *childname);
651 static void gtk_widget_buildable_set_buildable_property (GtkBuildable *buildable,
654 const GValue *value);
655 static gboolean gtk_widget_buildable_custom_tag_start (GtkBuildable *buildable,
658 const gchar *tagname,
659 GMarkupParser *parser,
661 static void gtk_widget_buildable_custom_finished (GtkBuildable *buildable,
664 const gchar *tagname,
666 static void gtk_widget_buildable_parser_finished (GtkBuildable *buildable,
667 GtkBuilder *builder);
669 static GtkSizeRequestMode gtk_widget_real_get_request_mode (GtkWidget *widget);
670 static void gtk_widget_real_get_width (GtkWidget *widget,
673 static void gtk_widget_real_get_height (GtkWidget *widget,
677 static void gtk_widget_queue_tooltip_query (GtkWidget *widget);
680 static void gtk_widget_real_adjust_size_request (GtkWidget *widget,
681 GtkOrientation orientation,
684 static void gtk_widget_real_adjust_size_allocation (GtkWidget *widget,
685 GtkOrientation orientation,
689 gint *allocated_size);
691 static void gtk_widget_set_usize_internal (GtkWidget *widget,
694 GtkQueueResizeFlags flags);
696 static void gtk_widget_add_events_internal (GtkWidget *widget,
699 static void gtk_widget_set_device_enabled_internal (GtkWidget *widget,
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;
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;
734 /* --- functions --- */
736 gtk_widget_get_type (void)
738 static GType widget_type = 0;
740 if (G_UNLIKELY (widget_type == 0))
742 const GTypeInfo widget_info =
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 */
752 (GInstanceInitFunc) gtk_widget_init,
753 NULL, /* value_table */
756 const GInterfaceInfo accessibility_info =
758 (GInterfaceInitFunc) gtk_widget_accessible_interface_init,
759 (GInterfaceFinalizeFunc) NULL,
760 NULL /* interface data */
763 const GInterfaceInfo buildable_info =
765 (GInterfaceInitFunc) gtk_widget_buildable_interface_init,
766 (GInterfaceFinalizeFunc) NULL,
767 NULL /* interface data */
770 widget_type = g_type_register_static (G_TYPE_INITIALLY_UNOWNED, "GtkWidget",
771 &widget_info, G_TYPE_FLAG_ABSTRACT);
773 g_type_add_class_private (widget_type, sizeof (GtkWidgetClassPrivate));
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,
785 gtk_widget_base_class_init (gpointer g_class)
787 GtkWidgetClass *klass = g_class;
789 klass->priv = G_TYPE_CLASS_GET_PRIVATE (g_class, GTK_TYPE_WIDGET, GtkWidgetClassPrivate);
793 child_property_notify_dispatcher (GObject *object,
797 GTK_WIDGET_GET_CLASS (object)->dispatch_child_properties_changed (GTK_WIDGET (object), n_pspecs, pspecs);
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?
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)
812 cairo_t *cr = g_value_get_boxed (¶m_values[1]);
816 _gtk_marshal_BOOLEAN__BOXED (closure,
827 gtk_widget_class_init (GtkWidgetClass *klass)
829 static GObjectNotifyContext cpn_context = { 0, NULL, NULL };
830 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
831 GtkBindingSet *binding_set;
833 gtk_widget_parent_class = g_type_class_peek_parent (klass);
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");
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;
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;
867 klass->destroy = gtk_widget_real_destroy;
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;
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;
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;
934 klass->show_help = gtk_widget_real_show_help;
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;
941 klass->adjust_size_request = gtk_widget_real_adjust_size_request;
942 klass->adjust_size_allocation = gtk_widget_real_adjust_size_allocation;
944 g_object_class_install_property (gobject_class,
946 g_param_spec_string ("name",
948 P_("The name of the widget"),
950 GTK_PARAM_READWRITE));
951 g_object_class_install_property (gobject_class,
953 g_param_spec_object ("parent",
955 P_("The parent widget of this widget. Must be a Container widget"),
957 GTK_PARAM_READWRITE));
959 g_object_class_install_property (gobject_class,
961 g_param_spec_int ("width-request",
963 P_("Override for width request of the widget, or -1 if natural request should be used"),
967 GTK_PARAM_READWRITE));
968 g_object_class_install_property (gobject_class,
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"),
976 GTK_PARAM_READWRITE));
977 g_object_class_install_property (gobject_class,
979 g_param_spec_boolean ("visible",
981 P_("Whether the widget is visible"),
983 GTK_PARAM_READWRITE));
984 g_object_class_install_property (gobject_class,
986 g_param_spec_boolean ("sensitive",
988 P_("Whether the widget responds to input"),
990 GTK_PARAM_READWRITE));
991 g_object_class_install_property (gobject_class,
993 g_param_spec_boolean ("app-paintable",
994 P_("Application paintable"),
995 P_("Whether the application will paint directly on the widget"),
997 GTK_PARAM_READWRITE));
998 g_object_class_install_property (gobject_class,
1000 g_param_spec_boolean ("can-focus",
1002 P_("Whether the widget can accept the input focus"),
1004 GTK_PARAM_READWRITE));
1005 g_object_class_install_property (gobject_class,
1007 g_param_spec_boolean ("has-focus",
1009 P_("Whether the widget has the input focus"),
1011 GTK_PARAM_READWRITE));
1012 g_object_class_install_property (gobject_class,
1014 g_param_spec_boolean ("is-focus",
1016 P_("Whether the widget is the focus widget within the toplevel"),
1018 GTK_PARAM_READWRITE));
1019 g_object_class_install_property (gobject_class,
1021 g_param_spec_boolean ("can-default",
1023 P_("Whether the widget can be the default widget"),
1025 GTK_PARAM_READWRITE));
1026 g_object_class_install_property (gobject_class,
1028 g_param_spec_boolean ("has-default",
1030 P_("Whether the widget is the default widget"),
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"),
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"),
1046 GTK_PARAM_READABLE));
1047 g_object_class_install_property (gobject_class,
1049 g_param_spec_object ("style",
1051 P_("The style of the widget, which contains information about how it will look (colors etc)"),
1053 GTK_PARAM_READWRITE));
1054 g_object_class_install_property (gobject_class,
1056 g_param_spec_flags ("events",
1058 P_("The event mask that decides what kind of GdkEvents this widget gets"),
1059 GDK_TYPE_EVENT_MASK,
1061 GTK_PARAM_READWRITE));
1062 g_object_class_install_property (gobject_class,
1064 g_param_spec_boolean ("no-show-all",
1066 P_("Whether gtk_widget_show_all() should not affect this widget"),
1068 GTK_PARAM_READWRITE));
1071 * GtkWidget:has-tooltip:
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.
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.
1085 g_object_class_install_property (gobject_class,
1087 g_param_spec_boolean ("has-tooltip",
1089 P_("Whether this widget has a tooltip"),
1091 GTK_PARAM_READWRITE));
1093 * GtkWidget:tooltip-text:
1095 * Sets the text of tooltip to be the given string.
1097 * Also see gtk_tooltip_set_text().
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.
1106 g_object_class_install_property (gobject_class,
1108 g_param_spec_string ("tooltip-text",
1110 P_("The contents of the tooltip for this widget"),
1112 GTK_PARAM_READWRITE));
1114 * GtkWidget:tooltip-markup:
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().
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.
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"),
1133 GTK_PARAM_READWRITE));
1138 * The widget's window if it is realized, %NULL otherwise.
1142 g_object_class_install_property (gobject_class,
1144 g_param_spec_object ("window",
1146 P_("The widget's window if it is realized"),
1148 GTK_PARAM_READABLE));
1151 * GtkWidget:double-buffered
1153 * Whether the widget is double buffered.
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"),
1163 GTK_PARAM_READWRITE));
1168 * How to distribute horizontal space if widget gets extra space, see #GtkAlign
1172 g_object_class_install_property (gobject_class,
1174 g_param_spec_enum ("halign",
1175 P_("Horizontal Alignment"),
1176 P_("How to position in extra horizontal space"),
1179 GTK_PARAM_READWRITE));
1184 * How to distribute vertical space if widget gets extra space, see #GtkAlign
1188 g_object_class_install_property (gobject_class,
1190 g_param_spec_enum ("valign",
1191 P_("Vertical Alignment"),
1192 P_("How to position in extra vertical space"),
1195 GTK_PARAM_READWRITE));
1198 * GtkWidget:margin-left
1200 * Margin on left side of widget.
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.
1208 g_object_class_install_property (gobject_class,
1210 g_param_spec_int ("margin-left",
1211 P_("Margin on Left"),
1212 P_("Pixels of extra space on the left side"),
1216 GTK_PARAM_READWRITE));
1219 * GtkWidget:margin-right
1221 * Margin on right side of widget.
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.
1229 g_object_class_install_property (gobject_class,
1231 g_param_spec_int ("margin-right",
1232 P_("Margin on Right"),
1233 P_("Pixels of extra space on the right side"),
1237 GTK_PARAM_READWRITE));
1240 * GtkWidget:margin-top
1242 * Margin on top side of widget.
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.
1250 g_object_class_install_property (gobject_class,
1252 g_param_spec_int ("margin-top",
1253 P_("Margin on Top"),
1254 P_("Pixels of extra space on the top side"),
1258 GTK_PARAM_READWRITE));
1261 * GtkWidget:margin-bottom
1263 * Margin on bottom side of widget.
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.
1271 g_object_class_install_property (gobject_class,
1273 g_param_spec_int ("margin-bottom",
1274 P_("Margin on Bottom"),
1275 P_("Pixels of extra space on the bottom side"),
1279 GTK_PARAM_READWRITE));
1284 * Sets all four sides' margin at once. If read, returns max
1285 * margin on any side.
1289 g_object_class_install_property (gobject_class,
1291 g_param_spec_int ("margin",
1293 P_("Pixels of extra space on all four sides"),
1297 GTK_PARAM_READWRITE));
1300 * GtkWidget::destroy:
1301 * @object: the object which received the signal
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.
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),
1313 _gtk_marshal_VOID__VOID,
1319 * Whether to expand horizontally. See gtk_widget_set_hexpand().
1323 g_object_class_install_property (gobject_class,
1325 g_param_spec_boolean ("hexpand",
1326 P_("Horizontal Expand"),
1327 P_("Whether widget wants more horizontal space"),
1329 GTK_PARAM_READWRITE));
1332 * GtkWidget:hexpand-set
1334 * Whether to use the #GtkWidget:hexpand property. See gtk_widget_get_hexpand_set().
1338 g_object_class_install_property (gobject_class,
1340 g_param_spec_boolean ("hexpand-set",
1341 P_("Horizontal Expand Set"),
1342 P_("Whether to use the hexpand property"),
1344 GTK_PARAM_READWRITE));
1349 * Whether to expand vertically. See gtk_widget_set_vexpand().
1353 g_object_class_install_property (gobject_class,
1355 g_param_spec_boolean ("vexpand",
1356 P_("Vertical Expand"),
1357 P_("Whether widget wants more vertical space"),
1359 GTK_PARAM_READWRITE));
1362 * GtkWidget:vexpand-set
1364 * Whether to use the #GtkWidget:vexpand property. See gtk_widget_get_vexpand_set().
1368 g_object_class_install_property (gobject_class,
1370 g_param_spec_boolean ("vexpand-set",
1371 P_("Vertical Expand Set"),
1372 P_("Whether to use the vexpand property"),
1374 GTK_PARAM_READWRITE));
1379 * Whether to expand in both directions. Setting this sets both #GtkWidget:hexpand and #GtkWidget:vexpand
1383 g_object_class_install_property (gobject_class,
1385 g_param_spec_boolean ("expand",
1387 P_("Whether widget wants to expand in both directions"),
1389 GTK_PARAM_READWRITE));
1393 * @widget: the object which received the signal.
1395 widget_signals[SHOW] =
1396 g_signal_new (I_("show"),
1397 G_TYPE_FROM_CLASS (gobject_class),
1399 G_STRUCT_OFFSET (GtkWidgetClass, show),
1401 _gtk_marshal_VOID__VOID,
1406 * @widget: the object which received the signal.
1408 widget_signals[HIDE] =
1409 g_signal_new (I_("hide"),
1410 G_TYPE_FROM_CLASS (gobject_class),
1412 G_STRUCT_OFFSET (GtkWidgetClass, hide),
1414 _gtk_marshal_VOID__VOID,
1419 * @widget: the object which received the signal.
1421 widget_signals[MAP] =
1422 g_signal_new (I_("map"),
1423 G_TYPE_FROM_CLASS (gobject_class),
1425 G_STRUCT_OFFSET (GtkWidgetClass, map),
1427 _gtk_marshal_VOID__VOID,
1432 * @widget: the object which received the signal.
1434 widget_signals[UNMAP] =
1435 g_signal_new (I_("unmap"),
1436 G_TYPE_FROM_CLASS (gobject_class),
1438 G_STRUCT_OFFSET (GtkWidgetClass, unmap),
1440 _gtk_marshal_VOID__VOID,
1444 * GtkWidget::realize:
1445 * @widget: the object which received the signal.
1447 widget_signals[REALIZE] =
1448 g_signal_new (I_("realize"),
1449 G_TYPE_FROM_CLASS (gobject_class),
1451 G_STRUCT_OFFSET (GtkWidgetClass, realize),
1453 _gtk_marshal_VOID__VOID,
1457 * GtkWidget::unrealize:
1458 * @widget: the object which received the signal.
1460 widget_signals[UNREALIZE] =
1461 g_signal_new (I_("unrealize"),
1462 G_TYPE_FROM_CLASS (gobject_class),
1464 G_STRUCT_OFFSET (GtkWidgetClass, unrealize),
1466 _gtk_marshal_VOID__VOID,
1470 * GtkWidget::size-allocate:
1471 * @widget: the object which received the signal.
1474 widget_signals[SIZE_ALLOCATE] =
1475 g_signal_new (I_("size-allocate"),
1476 G_TYPE_FROM_CLASS (gobject_class),
1478 G_STRUCT_OFFSET (GtkWidgetClass, size_allocate),
1480 _gtk_marshal_VOID__BOXED,
1482 GDK_TYPE_RECTANGLE | G_SIGNAL_TYPE_STATIC_SCOPE);
1485 * GtkWidget::state-changed:
1486 * @widget: the object which received the signal.
1487 * @state: the previous state
1489 * The ::state-changed signal is emitted when the widget state changes.
1490 * See gtk_widget_get_state().
1492 * Deprecated: 3.0. Use #GtkWidget::state-flags-changed instead.
1494 widget_signals[STATE_CHANGED] =
1495 g_signal_new (I_("state-changed"),
1496 G_TYPE_FROM_CLASS (gobject_class),
1498 G_STRUCT_OFFSET (GtkWidgetClass, state_changed),
1500 _gtk_marshal_VOID__ENUM,
1502 GTK_TYPE_STATE_TYPE);
1505 * GtkWidget::state-flags-changed:
1506 * @widget: the object which received the signal.
1507 * @flags: The previous state flags.
1509 * The ::state-flags-changed signal is emitted when the widget state
1510 * changes, see gtk_widget_get_state_flags().
1514 widget_signals[STATE_FLAGS_CHANGED] =
1515 g_signal_new (I_("state-flags-changed"),
1516 G_TYPE_FROM_CLASS (gobject_class),
1518 G_STRUCT_OFFSET (GtkWidgetClass, state_flags_changed),
1520 _gtk_marshal_VOID__FLAGS,
1522 GTK_TYPE_STATE_FLAGS);
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.
1530 * The ::parent-set signal is emitted when a new parent
1531 * has been set on a widget.
1533 widget_signals[PARENT_SET] =
1534 g_signal_new (I_("parent-set"),
1535 G_TYPE_FROM_CLASS (gobject_class),
1537 G_STRUCT_OFFSET (GtkWidgetClass, parent_set),
1539 _gtk_marshal_VOID__OBJECT,
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
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.
1555 widget_signals[HIERARCHY_CHANGED] =
1556 g_signal_new (I_("hierarchy-changed"),
1557 G_TYPE_FROM_CLASS (gobject_class),
1559 G_STRUCT_OFFSET (GtkWidgetClass, hierarchy_changed),
1561 _gtk_marshal_VOID__OBJECT,
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
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.
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.
1579 * Deprecated:3.0: Use the #GtkWidget::style-updated signal
1581 widget_signals[STYLE_SET] =
1582 g_signal_new (I_("style-set"),
1583 G_TYPE_FROM_CLASS (gobject_class),
1585 G_STRUCT_OFFSET (GtkWidgetClass, style_set),
1587 _gtk_marshal_VOID__OBJECT,
1592 * GtkWidget::style-updated:
1593 * @widget: the object on which the signal is emitted
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.
1601 widget_signals[STYLE_UPDATED] =
1602 g_signal_new (I_("style-updated"),
1603 G_TYPE_FROM_CLASS (gobject_class),
1605 G_STRUCT_OFFSET (GtkWidgetClass, style_updated),
1607 g_cclosure_marshal_VOID__VOID,
1611 * GtkWidget::direction-changed:
1612 * @widget: the object on which the signal is emitted
1613 * @previous_direction: the previous text direction of @widget
1615 * The ::direction-changed signal is emitted when the text direction
1616 * of a widget changes.
1618 widget_signals[DIRECTION_CHANGED] =
1619 g_signal_new (I_("direction-changed"),
1620 G_TYPE_FROM_CLASS (gobject_class),
1622 G_STRUCT_OFFSET (GtkWidgetClass, direction_changed),
1624 _gtk_marshal_VOID__ENUM,
1626 GTK_TYPE_TEXT_DIRECTION);
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
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
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
1643 widget_signals[GRAB_NOTIFY] =
1644 g_signal_new (I_("grab-notify"),
1645 G_TYPE_FROM_CLASS (gobject_class),
1647 G_STRUCT_OFFSET (GtkWidgetClass, grab_notify),
1649 _gtk_marshal_VOID__BOOLEAN,
1654 * GtkWidget::child-notify:
1655 * @widget: the object which received the signal
1656 * @pspec: the #GParamSpec of the changed child property
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.
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),
1668 g_cclosure_marshal_VOID__PARAM,
1674 * @widget: the object which received the signal
1675 * @cr: the cairo context to draw to
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().
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.
1690 widget_signals[DRAW] =
1691 g_signal_new (I_("draw"),
1692 G_TYPE_FROM_CLASS (gobject_class),
1694 G_STRUCT_OFFSET (GtkWidgetClass, draw),
1695 _gtk_boolean_handled_accumulator, NULL,
1696 gtk_widget_draw_marshaller,
1698 CAIRO_GOBJECT_TYPE_CONTEXT);
1701 * GtkWidget::mnemonic-activate:
1702 * @widget: the object which received the signal.
1705 widget_signals[MNEMONIC_ACTIVATE] =
1706 g_signal_new (I_("mnemonic-activate"),
1707 G_TYPE_FROM_CLASS (gobject_class),
1709 G_STRUCT_OFFSET (GtkWidgetClass, mnemonic_activate),
1710 _gtk_boolean_handled_accumulator, NULL,
1711 _gtk_marshal_BOOLEAN__BOOLEAN,
1716 * GtkWidget::grab-focus:
1717 * @widget: the object which received the signal.
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),
1725 _gtk_marshal_VOID__VOID,
1730 * @widget: the object which received the signal.
1733 * Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
1735 widget_signals[FOCUS] =
1736 g_signal_new (I_("focus"),
1737 G_TYPE_FROM_CLASS (klass),
1739 G_STRUCT_OFFSET (GtkWidgetClass, focus),
1740 _gtk_boolean_handled_accumulator, NULL,
1741 _gtk_marshal_BOOLEAN__ENUM,
1743 GTK_TYPE_DIRECTION_TYPE);
1746 * GtkWidget::move-focus:
1747 * @widget: the object which received the signal.
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),
1756 _gtk_marshal_VOID__ENUM,
1759 GTK_TYPE_DIRECTION_TYPE);
1762 * GtkWidget::keynav-failed:
1763 * @widget: the object which received the signal
1764 * @direction: the direction of movement
1766 * Gets emitted if keyboard navigation fails.
1767 * See gtk_widget_keynav_failed() for details.
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).
1775 widget_signals[KEYNAV_FAILED] =
1776 g_signal_new (I_("keynav-failed"),
1777 G_TYPE_FROM_CLASS (klass),
1779 G_STRUCT_OFFSET (GtkWidgetClass, keynav_failed),
1780 _gtk_boolean_handled_accumulator, NULL,
1781 _gtk_marshal_BOOLEAN__ENUM,
1783 GTK_TYPE_DIRECTION_TYPE);
1787 * @widget: the object which received the signal.
1788 * @event: the #GdkEvent which triggered this signal
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.
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
1802 widget_signals[EVENT] =
1803 g_signal_new (I_("event"),
1804 G_TYPE_FROM_CLASS (klass),
1806 G_STRUCT_OFFSET (GtkWidgetClass, event),
1807 _gtk_boolean_handled_accumulator, NULL,
1808 _gtk_marshal_BOOLEAN__BOXED,
1810 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1813 * GtkWidget::event-after:
1814 * @widget: the object which received the signal.
1815 * @event: the #GdkEvent which triggered this signal
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.
1822 widget_signals[EVENT_AFTER] =
1823 g_signal_new (I_("event-after"),
1824 G_TYPE_FROM_CLASS (klass),
1828 _gtk_marshal_VOID__BOXED,
1830 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1833 * GtkWidget::button-press-event:
1834 * @widget: the object which received the signal.
1835 * @event: (type Gdk.EventButton): the #GdkEventButton which triggered
1838 * The ::button-press-event signal will be emitted when a button
1839 * (typically from a mouse) is pressed.
1841 * To receive this signal, the #GdkWindow associated to the
1842 * widget needs to enable the #GDK_BUTTON_PRESS_MASK mask.
1844 * This signal will be sent to the grab widget if there is one.
1846 * Returns: %TRUE to stop other handlers from being invoked for the event.
1847 * %FALSE to propagate the event further.
1849 widget_signals[BUTTON_PRESS_EVENT] =
1850 g_signal_new (I_("button-press-event"),
1851 G_TYPE_FROM_CLASS (klass),
1853 G_STRUCT_OFFSET (GtkWidgetClass, button_press_event),
1854 _gtk_boolean_handled_accumulator, NULL,
1855 _gtk_marshal_BOOLEAN__BOXED,
1857 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1860 * GtkWidget::button-release-event:
1861 * @widget: the object which received the signal.
1862 * @event: (type Gdk.EventButton): the #GdkEventButton which triggered
1865 * The ::button-release-event signal will be emitted when a button
1866 * (typically from a mouse) is released.
1868 * To receive this signal, the #GdkWindow associated to the
1869 * widget needs to enable the #GDK_BUTTON_RELEASE_MASK mask.
1871 * This signal will be sent to the grab widget if there is one.
1873 * Returns: %TRUE to stop other handlers from being invoked for the event.
1874 * %FALSE to propagate the event further.
1876 widget_signals[BUTTON_RELEASE_EVENT] =
1877 g_signal_new (I_("button-release-event"),
1878 G_TYPE_FROM_CLASS (klass),
1880 G_STRUCT_OFFSET (GtkWidgetClass, button_release_event),
1881 _gtk_boolean_handled_accumulator, NULL,
1882 _gtk_marshal_BOOLEAN__BOXED,
1884 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1887 * GtkWidget::scroll-event:
1888 * @widget: the object which received the signal.
1889 * @event: (type Gdk.EventScroll): the #GdkEventScroll which triggered
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.
1896 * To receive this signal, the #GdkWindow associated to the widget needs
1897 * to enable the #GDK_BUTTON_PRESS_MASK mask.
1899 * This signal will be sent to the grab widget if there is one.
1901 * Returns: %TRUE to stop other handlers from being invoked for the event.
1902 * %FALSE to propagate the event further.
1904 widget_signals[SCROLL_EVENT] =
1905 g_signal_new (I_("scroll-event"),
1906 G_TYPE_FROM_CLASS (klass),
1908 G_STRUCT_OFFSET (GtkWidgetClass, scroll_event),
1909 _gtk_boolean_handled_accumulator, NULL,
1910 _gtk_marshal_BOOLEAN__BOXED,
1912 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1915 * GtkWidget::motion-notify-event:
1916 * @widget: the object which received the signal.
1917 * @event: (type Gdk.EventMotion): the #GdkEventMotion which triggered
1920 * The ::motion-notify-event signal is emitted when the pointer moves
1921 * over the widget's #GdkWindow.
1923 * To receive this signal, the #GdkWindow associated to the widget
1924 * needs to enable the #GDK_POINTER_MOTION_MASK mask.
1926 * This signal will be sent to the grab widget if there is one.
1928 * Returns: %TRUE to stop other handlers from being invoked for the event.
1929 * %FALSE to propagate the event further.
1931 widget_signals[MOTION_NOTIFY_EVENT] =
1932 g_signal_new (I_("motion-notify-event"),
1933 G_TYPE_FROM_CLASS (klass),
1935 G_STRUCT_OFFSET (GtkWidgetClass, motion_notify_event),
1936 _gtk_boolean_handled_accumulator, NULL,
1937 _gtk_marshal_BOOLEAN__BOXED,
1939 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1942 * GtkWidget::composited-changed:
1943 * @widget: the object on which the signal is emitted
1945 * The ::composited-changed signal is emitted when the composited
1946 * status of @widget<!-- -->s screen changes.
1947 * See gdk_screen_is_composited().
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),
1955 _gtk_marshal_VOID__VOID,
1959 * GtkWidget::delete-event:
1960 * @widget: the object which received the signal
1961 * @event: the event which triggered this signal
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.
1969 * Returns: %TRUE to stop other handlers from being invoked for the event.
1970 * %FALSE to propagate the event further.
1972 widget_signals[DELETE_EVENT] =
1973 g_signal_new (I_("delete-event"),
1974 G_TYPE_FROM_CLASS (klass),
1976 G_STRUCT_OFFSET (GtkWidgetClass, delete_event),
1977 _gtk_boolean_handled_accumulator, NULL,
1978 _gtk_marshal_BOOLEAN__BOXED,
1980 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1983 * GtkWidget::destroy-event:
1984 * @widget: the object which received the signal.
1985 * @event: the event which triggered this signal
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.
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.
1996 * Returns: %TRUE to stop other handlers from being invoked for the event.
1997 * %FALSE to propagate the event further.
1999 widget_signals[DESTROY_EVENT] =
2000 g_signal_new (I_("destroy-event"),
2001 G_TYPE_FROM_CLASS (klass),
2003 G_STRUCT_OFFSET (GtkWidgetClass, destroy_event),
2004 _gtk_boolean_handled_accumulator, NULL,
2005 _gtk_marshal_BOOLEAN__BOXED,
2007 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2010 * GtkWidget::key-press-event:
2011 * @widget: the object which received the signal
2012 * @event: (type Gdk.EventKey): the #GdkEventKey which triggered this signal.
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.
2017 * To receive this signal, the #GdkWindow associated to the widget needs
2018 * to enable the #GDK_KEY_PRESS_MASK mask.
2020 * This signal will be sent to the grab widget if there is one.
2022 * Returns: %TRUE to stop other handlers from being invoked for the event.
2023 * %FALSE to propagate the event further.
2025 widget_signals[KEY_PRESS_EVENT] =
2026 g_signal_new (I_("key-press-event"),
2027 G_TYPE_FROM_CLASS (klass),
2029 G_STRUCT_OFFSET (GtkWidgetClass, key_press_event),
2030 _gtk_boolean_handled_accumulator, NULL,
2031 _gtk_marshal_BOOLEAN__BOXED,
2033 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2036 * GtkWidget::key-release-event:
2037 * @widget: the object which received the signal
2038 * @event: (type Gdk.EventKey): the #GdkEventKey which triggered this signal.
2040 * The ::key-release-event signal is emitted when a key is released.
2042 * To receive this signal, the #GdkWindow associated to the widget needs
2043 * to enable the #GDK_KEY_RELEASE_MASK mask.
2045 * This signal will be sent to the grab widget if there is one.
2047 * Returns: %TRUE to stop other handlers from being invoked for the event.
2048 * %FALSE to propagate the event further.
2050 widget_signals[KEY_RELEASE_EVENT] =
2051 g_signal_new (I_("key-release-event"),
2052 G_TYPE_FROM_CLASS (klass),
2054 G_STRUCT_OFFSET (GtkWidgetClass, key_release_event),
2055 _gtk_boolean_handled_accumulator, NULL,
2056 _gtk_marshal_BOOLEAN__BOXED,
2058 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2061 * GtkWidget::enter-notify-event:
2062 * @widget: the object which received the signal
2063 * @event: (type Gdk.EventCrossing): the #GdkEventCrossing which triggered
2066 * The ::enter-notify-event will be emitted when the pointer enters
2067 * the @widget's window.
2069 * To receive this signal, the #GdkWindow associated to the widget needs
2070 * to enable the #GDK_ENTER_NOTIFY_MASK mask.
2072 * This signal will be sent to the grab widget if there is one.
2074 * Returns: %TRUE to stop other handlers from being invoked for the event.
2075 * %FALSE to propagate the event further.
2077 widget_signals[ENTER_NOTIFY_EVENT] =
2078 g_signal_new (I_("enter-notify-event"),
2079 G_TYPE_FROM_CLASS (klass),
2081 G_STRUCT_OFFSET (GtkWidgetClass, enter_notify_event),
2082 _gtk_boolean_handled_accumulator, NULL,
2083 _gtk_marshal_BOOLEAN__BOXED,
2085 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2088 * GtkWidget::leave-notify-event:
2089 * @widget: the object which received the signal
2090 * @event: (type Gdk.EventCrossing): the #GdkEventCrossing which triggered
2093 * The ::leave-notify-event will be emitted when the pointer leaves
2094 * the @widget's window.
2096 * To receive this signal, the #GdkWindow associated to the widget needs
2097 * to enable the #GDK_LEAVE_NOTIFY_MASK mask.
2099 * This signal will be sent to the grab widget if there is one.
2101 * Returns: %TRUE to stop other handlers from being invoked for the event.
2102 * %FALSE to propagate the event further.
2104 widget_signals[LEAVE_NOTIFY_EVENT] =
2105 g_signal_new (I_("leave-notify-event"),
2106 G_TYPE_FROM_CLASS (klass),
2108 G_STRUCT_OFFSET (GtkWidgetClass, leave_notify_event),
2109 _gtk_boolean_handled_accumulator, NULL,
2110 _gtk_marshal_BOOLEAN__BOXED,
2112 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2115 * GtkWidget::configure-event:
2116 * @widget: the object which received the signal
2117 * @event: (type Gdk.EventConfigure): the #GdkEventConfigure which triggered
2120 * The ::configure-event signal will be emitted when the size, position or
2121 * stacking of the @widget's window has changed.
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.
2127 * Returns: %TRUE to stop other handlers from being invoked for the event.
2128 * %FALSE to propagate the event further.
2130 widget_signals[CONFIGURE_EVENT] =
2131 g_signal_new (I_("configure-event"),
2132 G_TYPE_FROM_CLASS (klass),
2134 G_STRUCT_OFFSET (GtkWidgetClass, configure_event),
2135 _gtk_boolean_handled_accumulator, NULL,
2136 _gtk_marshal_BOOLEAN__BOXED,
2138 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2141 * GtkWidget::focus-in-event:
2142 * @widget: the object which received the signal
2143 * @event: (type Gdk.EventFocus): the #GdkEventFocus which triggered
2146 * The ::focus-in-event signal will be emitted when the keyboard focus
2147 * enters the @widget's window.
2149 * To receive this signal, the #GdkWindow associated to the widget needs
2150 * to enable the #GDK_FOCUS_CHANGE_MASK mask.
2152 * Returns: %TRUE to stop other handlers from being invoked for the event.
2153 * %FALSE to propagate the event further.
2155 widget_signals[FOCUS_IN_EVENT] =
2156 g_signal_new (I_("focus-in-event"),
2157 G_TYPE_FROM_CLASS (klass),
2159 G_STRUCT_OFFSET (GtkWidgetClass, focus_in_event),
2160 _gtk_boolean_handled_accumulator, NULL,
2161 _gtk_marshal_BOOLEAN__BOXED,
2163 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2166 * GtkWidget::focus-out-event:
2167 * @widget: the object which received the signal
2168 * @event: (type Gdk.EventFocus): the #GdkEventFocus which triggered this
2171 * The ::focus-out-event signal will be emitted when the keyboard focus
2172 * leaves the @widget's window.
2174 * To receive this signal, the #GdkWindow associated to the widget needs
2175 * to enable the #GDK_FOCUS_CHANGE_MASK mask.
2177 * Returns: %TRUE to stop other handlers from being invoked for the event.
2178 * %FALSE to propagate the event further.
2180 widget_signals[FOCUS_OUT_EVENT] =
2181 g_signal_new (I_("focus-out-event"),
2182 G_TYPE_FROM_CLASS (klass),
2184 G_STRUCT_OFFSET (GtkWidgetClass, focus_out_event),
2185 _gtk_boolean_handled_accumulator, NULL,
2186 _gtk_marshal_BOOLEAN__BOXED,
2188 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2191 * GtkWidget::map-event:
2192 * @widget: the object which received the signal
2193 * @event: (type Gdk.EventAny): the #GdkEventAny which triggered this signal.
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.
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.
2202 * Returns: %TRUE to stop other handlers from being invoked for the event.
2203 * %FALSE to propagate the event further.
2205 widget_signals[MAP_EVENT] =
2206 g_signal_new (I_("map-event"),
2207 G_TYPE_FROM_CLASS (klass),
2209 G_STRUCT_OFFSET (GtkWidgetClass, map_event),
2210 _gtk_boolean_handled_accumulator, NULL,
2211 _gtk_marshal_BOOLEAN__BOXED,
2213 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2216 * GtkWidget::unmap-event:
2217 * @widget: the object which received the signal
2218 * @event: (type Gdk.EventAny): the #GdkEventAny which triggered this signal
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.
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.
2227 * Returns: %TRUE to stop other handlers from being invoked for the event.
2228 * %FALSE to propagate the event further.
2230 widget_signals[UNMAP_EVENT] =
2231 g_signal_new (I_("unmap-event"),
2232 G_TYPE_FROM_CLASS (klass),
2234 G_STRUCT_OFFSET (GtkWidgetClass, unmap_event),
2235 _gtk_boolean_handled_accumulator, NULL,
2236 _gtk_marshal_BOOLEAN__BOXED,
2238 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2241 * GtkWidget::property-notify-event:
2242 * @widget: the object which received the signal
2243 * @event: (type Gdk.EventProperty): the #GdkEventProperty which triggered
2246 * The ::property-notify-event signal will be emitted when a property on
2247 * the @widget's window has been changed or deleted.
2249 * To receive this signal, the #GdkWindow associated to the widget needs
2250 * to enable the #GDK_PROPERTY_CHANGE_MASK mask.
2252 * Returns: %TRUE to stop other handlers from being invoked for the event.
2253 * %FALSE to propagate the event further.
2255 widget_signals[PROPERTY_NOTIFY_EVENT] =
2256 g_signal_new (I_("property-notify-event"),
2257 G_TYPE_FROM_CLASS (klass),
2259 G_STRUCT_OFFSET (GtkWidgetClass, property_notify_event),
2260 _gtk_boolean_handled_accumulator, NULL,
2261 _gtk_marshal_BOOLEAN__BOXED,
2263 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2266 * GtkWidget::selection-clear-event:
2267 * @widget: the object which received the signal
2268 * @event: (type Gdk.EventSelection): the #GdkEventSelection which triggered
2271 * The ::selection-clear-event signal will be emitted when the
2272 * the @widget's window has lost ownership of a selection.
2274 * Returns: %TRUE to stop other handlers from being invoked for the event.
2275 * %FALSE to propagate the event further.
2277 widget_signals[SELECTION_CLEAR_EVENT] =
2278 g_signal_new (I_("selection-clear-event"),
2279 G_TYPE_FROM_CLASS (klass),
2281 G_STRUCT_OFFSET (GtkWidgetClass, selection_clear_event),
2282 _gtk_boolean_handled_accumulator, NULL,
2283 _gtk_marshal_BOOLEAN__BOXED,
2285 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2288 * GtkWidget::selection-request-event:
2289 * @widget: the object which received the signal
2290 * @event: (type Gdk.EventSelection): the #GdkEventSelection which triggered
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.
2297 * Returns: %TRUE to stop other handlers from being invoked for the event.
2298 * %FALSE to propagate the event further.
2300 widget_signals[SELECTION_REQUEST_EVENT] =
2301 g_signal_new (I_("selection-request-event"),
2302 G_TYPE_FROM_CLASS (klass),
2304 G_STRUCT_OFFSET (GtkWidgetClass, selection_request_event),
2305 _gtk_boolean_handled_accumulator, NULL,
2306 _gtk_marshal_BOOLEAN__BOXED,
2308 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2311 * GtkWidget::selection-notify-event:
2312 * @widget: the object which received the signal.
2313 * @event: (type Gdk.EventSelection):
2315 * Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
2317 widget_signals[SELECTION_NOTIFY_EVENT] =
2318 g_signal_new (I_("selection-notify-event"),
2319 G_TYPE_FROM_CLASS (klass),
2321 G_STRUCT_OFFSET (GtkWidgetClass, selection_notify_event),
2322 _gtk_boolean_handled_accumulator, NULL,
2323 _gtk_marshal_BOOLEAN__BOXED,
2325 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2328 * GtkWidget::selection-received:
2329 * @widget: the object which received the signal.
2333 widget_signals[SELECTION_RECEIVED] =
2334 g_signal_new (I_("selection-received"),
2335 G_TYPE_FROM_CLASS (klass),
2337 G_STRUCT_OFFSET (GtkWidgetClass, selection_received),
2339 _gtk_marshal_VOID__BOXED_UINT,
2341 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
2345 * GtkWidget::selection-get:
2346 * @widget: the object which received the signal.
2351 widget_signals[SELECTION_GET] =
2352 g_signal_new (I_("selection-get"),
2353 G_TYPE_FROM_CLASS (klass),
2355 G_STRUCT_OFFSET (GtkWidgetClass, selection_get),
2357 _gtk_marshal_VOID__BOXED_UINT_UINT,
2359 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
2364 * GtkWidget::proximity-in-event:
2365 * @widget: the object which received the signal
2366 * @event: (type Gdk.EventProximity): the #GdkEventProximity which triggered
2369 * To receive this signal the #GdkWindow associated to the widget needs
2370 * to enable the #GDK_PROXIMITY_IN_MASK mask.
2372 * This signal will be sent to the grab widget if there is one.
2374 * Returns: %TRUE to stop other handlers from being invoked for the event.
2375 * %FALSE to propagate the event further.
2377 widget_signals[PROXIMITY_IN_EVENT] =
2378 g_signal_new (I_("proximity-in-event"),
2379 G_TYPE_FROM_CLASS (klass),
2381 G_STRUCT_OFFSET (GtkWidgetClass, proximity_in_event),
2382 _gtk_boolean_handled_accumulator, NULL,
2383 _gtk_marshal_BOOLEAN__BOXED,
2385 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2388 * GtkWidget::proximity-out-event:
2389 * @widget: the object which received the signal
2390 * @event: (type Gdk.EventProximity): the #GdkEventProximity which triggered
2393 * To receive this signal the #GdkWindow associated to the widget needs
2394 * to enable the #GDK_PROXIMITY_OUT_MASK mask.
2396 * This signal will be sent to the grab widget if there is one.
2398 * Returns: %TRUE to stop other handlers from being invoked for the event.
2399 * %FALSE to propagate the event further.
2401 widget_signals[PROXIMITY_OUT_EVENT] =
2402 g_signal_new (I_("proximity-out-event"),
2403 G_TYPE_FROM_CLASS (klass),
2405 G_STRUCT_OFFSET (GtkWidgetClass, proximity_out_event),
2406 _gtk_boolean_handled_accumulator, NULL,
2407 _gtk_marshal_BOOLEAN__BOXED,
2409 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
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
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()
2422 widget_signals[DRAG_LEAVE] =
2423 g_signal_new (I_("drag-leave"),
2424 G_TYPE_FROM_CLASS (klass),
2426 G_STRUCT_OFFSET (GtkWidgetClass, drag_leave),
2428 _gtk_marshal_VOID__OBJECT_UINT,
2430 GDK_TYPE_DRAG_CONTEXT,
2434 * GtkWidget::drag-begin:
2435 * @widget: the object which received the signal
2436 * @drag_context: the drag context
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().
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.
2446 widget_signals[DRAG_BEGIN] =
2447 g_signal_new (I_("drag-begin"),
2448 G_TYPE_FROM_CLASS (klass),
2450 G_STRUCT_OFFSET (GtkWidgetClass, drag_begin),
2452 _gtk_marshal_VOID__OBJECT,
2454 GDK_TYPE_DRAG_CONTEXT);
2457 * GtkWidget::drag-end:
2458 * @widget: the object which received the signal
2459 * @drag_context: the drag context
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.
2465 widget_signals[DRAG_END] =
2466 g_signal_new (I_("drag-end"),
2467 G_TYPE_FROM_CLASS (klass),
2469 G_STRUCT_OFFSET (GtkWidgetClass, drag_end),
2471 _gtk_marshal_VOID__OBJECT,
2473 GDK_TYPE_DRAG_CONTEXT);
2476 * GtkWidget::drag-data-delete:
2477 * @widget: the object which received the signal
2478 * @drag_context: the drag context
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.
2485 widget_signals[DRAG_DATA_DELETE] =
2486 g_signal_new (I_("drag-data-delete"),
2487 G_TYPE_FROM_CLASS (klass),
2489 G_STRUCT_OFFSET (GtkWidgetClass, drag_data_delete),
2491 _gtk_marshal_VOID__OBJECT,
2493 GDK_TYPE_DRAG_CONTEXT);
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
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.
2507 * Return value: %TRUE if the failed drag operation has been already handled.
2511 widget_signals[DRAG_FAILED] =
2512 g_signal_new (I_("drag-failed"),
2513 G_TYPE_FROM_CLASS (klass),
2515 G_STRUCT_OFFSET (GtkWidgetClass, drag_failed),
2516 _gtk_boolean_handled_accumulator, NULL,
2517 _gtk_marshal_BOOLEAN__OBJECT_ENUM,
2519 GDK_TYPE_DRAG_CONTEXT,
2520 GTK_TYPE_DRAG_RESULT);
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
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().
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.
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().
2553 * drag_motion (GtkWidget *widget,
2554 * GdkDragContext *context,
2561 * PrivateData *private_data = GET_PRIVATE_DATA (widget);
2563 * if (!private_data->drag_highlight)
2565 * private_data->drag_highlight = 1;
2566 * gtk_drag_highlight (widget);
2569 * target = gtk_drag_dest_find_target (widget, context, NULL);
2570 * if (target == GDK_NONE)
2571 * gdk_drag_status (context, 0, time);
2574 * private_data->pending_status = context->suggested_action;
2575 * gtk_drag_get_data (widget, context, target, time);
2582 * drag_data_received (GtkWidget *widget,
2583 * GdkDragContext *context,
2586 * GtkSelectionData *selection_data,
2590 * PrivateData *private_data = GET_PRIVATE_DATA (widget);
2592 * if (private_data->suggested_action)
2594 * private_data->suggested_action = 0;
2596 * /* 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
2601 * str = gtk_selection_data_get_text (selection_data);
2602 * if (!data_is_acceptable (str))
2603 * gdk_drag_status (context, 0, time);
2605 * gdk_drag_status (context, private_data->suggested_action, time);
2609 * /* accept the drop */
2614 * Returns: whether the cursor position is in a drop zone
2616 widget_signals[DRAG_MOTION] =
2617 g_signal_new (I_("drag-motion"),
2618 G_TYPE_FROM_CLASS (klass),
2620 G_STRUCT_OFFSET (GtkWidgetClass, drag_motion),
2621 _gtk_boolean_handled_accumulator, NULL,
2622 _gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
2624 GDK_TYPE_DRAG_CONTEXT,
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
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.
2648 * Returns: whether the cursor position is in a drop zone
2650 widget_signals[DRAG_DROP] =
2651 g_signal_new (I_("drag-drop"),
2652 G_TYPE_FROM_CLASS (klass),
2654 G_STRUCT_OFFSET (GtkWidgetClass, drag_drop),
2655 _gtk_boolean_handled_accumulator, NULL,
2656 _gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
2658 GDK_TYPE_DRAG_CONTEXT,
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
2670 * @time: the timestamp at which the data was requested
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().
2678 widget_signals[DRAG_DATA_GET] =
2679 g_signal_new (I_("drag-data-get"),
2680 G_TYPE_FROM_CLASS (klass),
2682 G_STRUCT_OFFSET (GtkWidgetClass, drag_data_get),
2684 _gtk_marshal_VOID__OBJECT_BOXED_UINT_UINT,
2686 GDK_TYPE_DRAG_CONTEXT,
2687 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
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
2700 * @time: the timestamp at which the data was received
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.
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:
2717 * drag_data_received (GtkWidget *widget,
2718 * GdkDragContext *drag_context,
2721 * GtkSelectionData *data,
2725 * if ((data->length >= 0) && (data->format == 8))
2727 * if (drag_context->action == GDK_ACTION_ASK)
2729 * GtkWidget *dialog;
2732 * dialog = gtk_message_dialog_new (NULL,
2733 * GTK_DIALOG_MODAL |
2734 * GTK_DIALOG_DESTROY_WITH_PARENT,
2736 * GTK_BUTTONS_YES_NO,
2737 * "Move the data ?\n");
2738 * response = gtk_dialog_run (GTK_DIALOG (dialog));
2739 * gtk_widget_destroy (dialog);
2741 * if (response == GTK_RESPONSE_YES)
2742 * drag_context->action = GDK_ACTION_MOVE;
2744 * drag_context->action = GDK_ACTION_COPY;
2747 * gtk_drag_finish (drag_context, TRUE, FALSE, time);
2751 * gtk_drag_finish (drag_context, FALSE, FALSE, time);
2755 widget_signals[DRAG_DATA_RECEIVED] =
2756 g_signal_new (I_("drag-data-received"),
2757 G_TYPE_FROM_CLASS (klass),
2759 G_STRUCT_OFFSET (GtkWidgetClass, drag_data_received),
2761 _gtk_marshal_VOID__OBJECT_INT_INT_BOXED_UINT_UINT,
2763 GDK_TYPE_DRAG_CONTEXT,
2766 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
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.
2776 * The ::visibility-notify-event will be emitted when the @widget's window
2777 * is obscured or unobscured.
2779 * To receive this signal the #GdkWindow associated to the widget needs
2780 * to enable the #GDK_VISIBILITY_NOTIFY_MASK mask.
2782 * Returns: %TRUE to stop other handlers from being invoked for the event.
2783 * %FALSE to propagate the event further.
2785 widget_signals[VISIBILITY_NOTIFY_EVENT] =
2786 g_signal_new (I_("visibility-notify-event"),
2787 G_TYPE_FROM_CLASS (klass),
2789 G_STRUCT_OFFSET (GtkWidgetClass, visibility_notify_event),
2790 _gtk_boolean_handled_accumulator, NULL,
2791 _gtk_marshal_BOOLEAN__BOXED,
2793 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
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.
2801 * The ::window-state-event will be emitted when the state of the
2802 * toplevel window associated to the @widget changes.
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.
2808 * Returns: %TRUE to stop other handlers from being invoked for the
2809 * event. %FALSE to propagate the event further.
2811 widget_signals[WINDOW_STATE_EVENT] =
2812 g_signal_new (I_("window-state-event"),
2813 G_TYPE_FROM_CLASS (klass),
2815 G_STRUCT_OFFSET (GtkWidgetClass, window_state_event),
2816 _gtk_boolean_handled_accumulator, NULL,
2817 _gtk_marshal_BOOLEAN__BOXED,
2819 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2822 * GtkWidget::damage-event:
2823 * @widget: the object which received the signal
2824 * @event: (type Gdk.EventExpose): the #GdkEventExpose event
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.
2830 * Returns: %TRUE to stop other handlers from being invoked for the event.
2831 * %FALSE to propagate the event further.
2835 widget_signals[DAMAGE_EVENT] =
2836 g_signal_new (I_("damage-event"),
2837 G_TYPE_FROM_CLASS (klass),
2839 G_STRUCT_OFFSET (GtkWidgetClass, damage_event),
2840 _gtk_boolean_handled_accumulator, NULL,
2841 _gtk_marshal_BOOLEAN__BOXED,
2843 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2846 * GtkWidget::grab-broken-event:
2847 * @widget: the object which received the signal
2848 * @event: (type Gdk.EventGrabBroken): the #GdkEventGrabBroken event
2850 * Emitted when a pointer or keyboard grab on a window belonging
2851 * to @widget gets broken.
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.
2857 * Returns: %TRUE to stop other handlers from being invoked for
2858 * the event. %FALSE to propagate the event further.
2862 widget_signals[GRAB_BROKEN_EVENT] =
2863 g_signal_new (I_("grab-broken-event"),
2864 G_TYPE_FROM_CLASS (klass),
2866 G_STRUCT_OFFSET (GtkWidgetClass, grab_broken_event),
2867 _gtk_boolean_handled_accumulator, NULL,
2868 _gtk_marshal_BOOLEAN__BOXED,
2870 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
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
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.
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.
2892 * The signal handler is free to manipulate @tooltip with the therefore
2893 * destined function calls.
2895 * Returns: %TRUE if @tooltip should be shown right now, %FALSE otherwise.
2899 widget_signals[QUERY_TOOLTIP] =
2900 g_signal_new (I_("query-tooltip"),
2901 G_TYPE_FROM_CLASS (klass),
2903 G_STRUCT_OFFSET (GtkWidgetClass, query_tooltip),
2904 _gtk_boolean_handled_accumulator, NULL,
2905 _gtk_marshal_BOOLEAN__INT_INT_BOOLEAN_OBJECT,
2913 * GtkWidget::popup-menu
2914 * @widget: the object which received the signal
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.
2923 * Returns: %TRUE if a menu was activated
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,
2935 * GtkWidget::show-help:
2936 * @widget: the object which received the signal.
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,
2947 GTK_TYPE_WIDGET_HELP_TYPE);
2950 * GtkWidget::accel-closures-changed:
2951 * @widget: the object which received the signal.
2953 widget_signals[ACCEL_CLOSURES_CHANGED] =
2954 g_signal_new (I_("accel-closures-changed"),
2955 G_TYPE_FROM_CLASS (klass),
2959 _gtk_marshal_VOID__VOID,
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
2968 * The ::screen-changed signal gets emitted when the
2969 * screen of a widget has changed.
2971 widget_signals[SCREEN_CHANGED] =
2972 g_signal_new (I_("screen-changed"),
2973 G_TYPE_FROM_CLASS (klass),
2975 G_STRUCT_OFFSET (GtkWidgetClass, screen_changed),
2977 _gtk_marshal_VOID__OBJECT,
2982 * GtkWidget::can-activate-accel:
2983 * @widget: the object which received the signal
2984 * @signal_id: the ID of a signal installed on @widget
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.
2992 * Returns: %TRUE if the signal can be activated.
2994 widget_signals[CAN_ACTIVATE_ACCEL] =
2995 g_signal_new (I_("can-activate-accel"),
2996 G_TYPE_FROM_CLASS (klass),
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);
3003 binding_set = gtk_binding_set_by_class (klass);
3004 gtk_binding_entry_add_signal (binding_set, GDK_KEY_F10, GDK_SHIFT_MASK,
3006 gtk_binding_entry_add_signal (binding_set, GDK_KEY_Menu, 0,
3009 gtk_binding_entry_add_signal (binding_set, GDK_KEY_F1, GDK_CONTROL_MASK,
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,
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,
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,
3023 GTK_TYPE_WIDGET_HELP_TYPE,
3024 GTK_WIDGET_HELP_WHATS_THIS);
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"),
3031 GTK_PARAM_READABLE));
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"),
3038 GTK_PARAM_READABLE));
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"),
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'"),
3051 GTK_PARAM_READABLE));
3052 gtk_widget_class_install_style_property (klass,
3053 g_param_spec_boxed ("cursor-color",
3055 P_("Color with which to draw insertion cursor"),
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"),
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"),
3069 GTK_PARAM_READABLE));
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"),
3076 GTK_PARAM_READABLE));
3079 * GtkWidget:link-color:
3081 * The "link-color" style property defines the color of unvisited links.
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"),
3090 GTK_PARAM_READABLE));
3093 * GtkWidget:visited-link-color:
3095 * The "visited-link-color" style property defines the color of visited links.
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"),
3104 GTK_PARAM_READABLE));
3107 * GtkWidget:wide-separators:
3109 * The "wide-separators" style property defines whether separators have
3110 * configurable width and should be drawn using a box instead of a line.
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"),
3119 GTK_PARAM_READABLE));
3122 * GtkWidget:separator-width:
3124 * The "separator-width" style property defines the width of separators.
3125 * This property only takes effect if #GtkWidget:wide-separators is %TRUE.
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"),
3134 GTK_PARAM_READABLE));
3137 * GtkWidget:separator-height:
3139 * The "separator-height" style property defines the height of separators.
3140 * This property only takes effect if #GtkWidget:wide-separators is %TRUE.
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"),
3149 GTK_PARAM_READABLE));
3152 * GtkWidget:scroll-arrow-hlength:
3154 * The "scroll-arrow-hlength" style property defines the length of
3155 * horizontal scroll arrows.
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"),
3164 GTK_PARAM_READABLE));
3167 * GtkWidget:scroll-arrow-vlength:
3169 * The "scroll-arrow-vlength" style property defines the length of
3170 * vertical scroll arrows.
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"),
3179 GTK_PARAM_READABLE));
3181 g_type_class_add_private (klass, sizeof (GtkWidgetPrivate));
3183 gtk_widget_class_set_accessible_type (klass, GTK_TYPE_WIDGET_ACCESSIBLE);
3187 gtk_widget_base_class_finalize (GtkWidgetClass *klass)
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)
3194 GParamSpec *pspec = node->data;
3196 g_param_spec_pool_remove (style_property_spec_pool, pspec);
3197 g_param_spec_unref (pspec);
3203 gtk_widget_set_property (GObject *object,
3205 const GValue *value,
3208 GtkWidget *widget = GTK_WIDGET (object);
3213 gchar *tooltip_markup;
3214 const gchar *tooltip_text;
3215 GtkWindow *tooltip_window;
3218 gtk_widget_set_name (widget, g_value_get_string (value));
3221 gtk_container_add (GTK_CONTAINER (g_value_get_object (value)), widget);
3223 case PROP_WIDTH_REQUEST:
3224 gtk_widget_set_usize_internal (widget, g_value_get_int (value), -2, 0);
3226 case PROP_HEIGHT_REQUEST:
3227 gtk_widget_set_usize_internal (widget, -2, g_value_get_int (value), 0);
3230 gtk_widget_set_visible (widget, g_value_get_boolean (value));
3232 case PROP_SENSITIVE:
3233 gtk_widget_set_sensitive (widget, g_value_get_boolean (value));
3235 case PROP_APP_PAINTABLE:
3236 gtk_widget_set_app_paintable (widget, g_value_get_boolean (value));
3238 case PROP_CAN_FOCUS:
3239 gtk_widget_set_can_focus (widget, g_value_get_boolean (value));
3241 case PROP_HAS_FOCUS:
3242 if (g_value_get_boolean (value))
3243 gtk_widget_grab_focus (widget);
3246 if (g_value_get_boolean (value))
3247 gtk_widget_grab_focus (widget);
3249 case PROP_CAN_DEFAULT:
3250 gtk_widget_set_can_default (widget, g_value_get_boolean (value));
3252 case PROP_HAS_DEFAULT:
3253 if (g_value_get_boolean (value))
3254 gtk_widget_grab_default (widget);
3256 case PROP_RECEIVES_DEFAULT:
3257 gtk_widget_set_receives_default (widget, g_value_get_boolean (value));
3260 gtk_widget_set_style (widget, g_value_get_object (value));
3263 if (!gtk_widget_get_realized (widget) && gtk_widget_get_has_window (widget))
3264 gtk_widget_set_events (widget, g_value_get_flags (value));
3266 case PROP_NO_SHOW_ALL:
3267 gtk_widget_set_no_show_all (widget, g_value_get_boolean (value));
3269 case PROP_HAS_TOOLTIP:
3270 gtk_widget_real_set_has_tooltip (widget,
3271 g_value_get_boolean (value), FALSE);
3273 case PROP_TOOLTIP_MARKUP:
3274 tooltip_window = g_object_get_qdata (object, quark_tooltip_window);
3275 tooltip_markup = g_value_dup_string (value);
3277 /* Treat an empty string as a NULL string,
3278 * because an empty string would be useless for a tooltip:
3280 if (tooltip_markup && (strlen (tooltip_markup) == 0))
3282 g_free (tooltip_markup);
3283 tooltip_markup = NULL;
3286 g_object_set_qdata_full (object, quark_tooltip_markup,
3287 tooltip_markup, g_free);
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);
3294 case PROP_TOOLTIP_TEXT:
3295 tooltip_window = g_object_get_qdata (object, quark_tooltip_window);
3297 tooltip_text = g_value_get_string (value);
3299 /* Treat an empty string as a NULL string,
3300 * because an empty string would be useless for a tooltip:
3302 if (tooltip_text && (strlen (tooltip_text) == 0))
3303 tooltip_text = NULL;
3305 tooltip_markup = tooltip_text ? g_markup_escape_text (tooltip_text, -1) : NULL;
3307 g_object_set_qdata_full (object, quark_tooltip_markup,
3308 tooltip_markup, g_free);
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);
3315 case PROP_DOUBLE_BUFFERED:
3316 gtk_widget_set_double_buffered (widget, g_value_get_boolean (value));
3319 gtk_widget_set_halign (widget, g_value_get_enum (value));
3322 gtk_widget_set_valign (widget, g_value_get_enum (value));
3324 case PROP_MARGIN_LEFT:
3325 gtk_widget_set_margin_left (widget, g_value_get_int (value));
3327 case PROP_MARGIN_RIGHT:
3328 gtk_widget_set_margin_right (widget, g_value_get_int (value));
3330 case PROP_MARGIN_TOP:
3331 gtk_widget_set_margin_top (widget, g_value_get_int (value));
3333 case PROP_MARGIN_BOTTOM:
3334 gtk_widget_set_margin_bottom (widget, g_value_get_int (value));
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));
3345 gtk_widget_set_hexpand (widget, g_value_get_boolean (value));
3347 case PROP_HEXPAND_SET:
3348 gtk_widget_set_hexpand_set (widget, g_value_get_boolean (value));
3351 gtk_widget_set_vexpand (widget, g_value_get_boolean (value));
3353 case PROP_VEXPAND_SET:
3354 gtk_widget_set_vexpand_set (widget, g_value_get_boolean (value));
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));
3363 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
3369 gtk_widget_get_property (GObject *object,
3374 GtkWidget *widget = GTK_WIDGET (object);
3375 GtkWidgetPrivate *priv = widget->priv;
3383 g_value_set_string (value, priv->name);
3385 g_value_set_static_string (value, "");
3388 g_value_set_object (value, priv->parent);
3390 case PROP_WIDTH_REQUEST:
3393 gtk_widget_get_size_request (widget, &w, NULL);
3394 g_value_set_int (value, w);
3397 case PROP_HEIGHT_REQUEST:
3400 gtk_widget_get_size_request (widget, NULL, &h);
3401 g_value_set_int (value, h);
3405 g_value_set_boolean (value, (gtk_widget_get_visible (widget) != FALSE));
3407 case PROP_SENSITIVE:
3408 g_value_set_boolean (value, (gtk_widget_get_sensitive (widget) != FALSE));
3410 case PROP_APP_PAINTABLE:
3411 g_value_set_boolean (value, (gtk_widget_get_app_paintable (widget) != FALSE));
3413 case PROP_CAN_FOCUS:
3414 g_value_set_boolean (value, (gtk_widget_get_can_focus (widget) != FALSE));
3416 case PROP_HAS_FOCUS:
3417 g_value_set_boolean (value, (gtk_widget_has_focus (widget) != FALSE));
3420 g_value_set_boolean (value, (gtk_widget_is_focus (widget)));
3422 case PROP_CAN_DEFAULT:
3423 g_value_set_boolean (value, (gtk_widget_get_can_default (widget) != FALSE));
3425 case PROP_HAS_DEFAULT:
3426 g_value_set_boolean (value, (gtk_widget_has_default (widget) != FALSE));
3428 case PROP_RECEIVES_DEFAULT:
3429 g_value_set_boolean (value, (gtk_widget_get_receives_default (widget) != FALSE));
3431 case PROP_COMPOSITE_CHILD:
3432 g_value_set_boolean (value, widget->priv->composite_child);
3435 g_value_set_object (value, gtk_widget_get_style (widget));
3438 eventp = g_object_get_qdata (G_OBJECT (widget), quark_event_mask);
3439 g_value_set_flags (value, GPOINTER_TO_INT (eventp));
3441 case PROP_NO_SHOW_ALL:
3442 g_value_set_boolean (value, gtk_widget_get_no_show_all (widget));
3444 case PROP_HAS_TOOLTIP:
3445 g_value_set_boolean (value, GPOINTER_TO_UINT (g_object_get_qdata (object, quark_has_tooltip)));
3447 case PROP_TOOLTIP_TEXT:
3449 gchar *escaped = g_object_get_qdata (object, quark_tooltip_markup);
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 */
3455 g_value_take_string (value, text);
3458 case PROP_TOOLTIP_MARKUP:
3459 g_value_set_string (value, g_object_get_qdata (object, quark_tooltip_markup));
3462 g_value_set_object (value, gtk_widget_get_window (widget));
3464 case PROP_DOUBLE_BUFFERED:
3465 g_value_set_boolean (value, gtk_widget_get_double_buffered (widget));
3468 g_value_set_enum (value, gtk_widget_get_halign (widget));
3471 g_value_set_enum (value, gtk_widget_get_valign (widget));
3473 case PROP_MARGIN_LEFT:
3474 g_value_set_int (value, gtk_widget_get_margin_left (widget));
3476 case PROP_MARGIN_RIGHT:
3477 g_value_set_int (value, gtk_widget_get_margin_right (widget));
3479 case PROP_MARGIN_TOP:
3480 g_value_set_int (value, gtk_widget_get_margin_top (widget));
3482 case PROP_MARGIN_BOTTOM:
3483 g_value_set_int (value, gtk_widget_get_margin_bottom (widget));
3487 GtkWidgetAuxInfo *aux_info = gtk_widget_get_aux_info (widget, FALSE);
3488 if (aux_info == NULL)
3490 g_value_set_int (value, 0);
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)));
3502 g_value_set_boolean (value, gtk_widget_get_hexpand (widget));
3504 case PROP_HEXPAND_SET:
3505 g_value_set_boolean (value, gtk_widget_get_hexpand_set (widget));
3508 g_value_set_boolean (value, gtk_widget_get_vexpand (widget));
3510 case PROP_VEXPAND_SET:
3511 g_value_set_boolean (value, gtk_widget_get_vexpand_set (widget));
3514 g_value_set_boolean (value,
3515 gtk_widget_get_hexpand (widget) &&
3516 gtk_widget_get_vexpand (widget));
3519 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
3525 gtk_widget_init (GtkWidget *widget)
3527 GtkWidgetPrivate *priv;
3529 widget->priv = G_TYPE_INSTANCE_GET_PRIVATE (widget,
3532 priv = widget->priv;
3534 priv->child_visible = TRUE;
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;
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;
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.
3555 * We really want to default FALSE here to avoid computing expand
3556 * all over the place while initially building a widget tree.
3558 priv->need_compute_expand = FALSE;
3560 priv->style = gtk_widget_get_default_style ();
3561 g_object_ref (priv->style);
3566 gtk_widget_dispatch_child_properties_changed (GtkWidget *widget,
3568 GParamSpec **pspecs)
3570 GtkWidgetPrivate *priv = widget->priv;
3571 GtkWidget *container = priv->parent;
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]);
3579 * gtk_widget_freeze_child_notify:
3580 * @widget: a #GtkWidget
3582 * Stops emission of #GtkWidget::child-notify signals on @widget. The
3583 * signals are queued until gtk_widget_thaw_child_notify() is called
3586 * This is the analogue of g_object_freeze_notify() for child properties.
3589 gtk_widget_freeze_child_notify (GtkWidget *widget)
3591 g_return_if_fail (GTK_IS_WIDGET (widget));
3593 if (!G_OBJECT (widget)->ref_count)
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);
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
3607 * Emits a #GtkWidget::child-notify signal for the
3608 * <link linkend="child-properties">child property</link> @child_property
3611 * This is the analogue of g_object_notify() for child properties.
3613 * Also see gtk_container_child_notify().
3616 gtk_widget_child_notify (GtkWidget *widget,
3617 const gchar *child_property)
3619 if (widget->priv->parent == NULL)
3622 gtk_container_child_notify (GTK_CONTAINER (widget->priv->parent), widget, child_property);
3626 * gtk_widget_thaw_child_notify:
3627 * @widget: a #GtkWidget
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
3634 gtk_widget_thaw_child_notify (GtkWidget *widget)
3636 GObjectNotifyQueue *nqueue;
3638 g_return_if_fail (GTK_IS_WIDGET (widget));
3640 if (!G_OBJECT (widget)->ref_count)
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);
3649 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
3650 g_object_unref (widget);
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,
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.
3668 * Return value: a new #GtkWidget of type @widget_type
3671 gtk_widget_new (GType type,
3672 const gchar *first_property_name,
3678 g_return_val_if_fail (g_type_is_a (type, GTK_TYPE_WIDGET), NULL);
3680 va_start (var_args, first_property_name);
3681 widget = (GtkWidget *)g_object_new_valist (type, first_property_name, var_args);
3688 gtk_widget_queue_draw_child (GtkWidget *widget)
3690 GtkWidgetPrivate *priv = widget->priv;
3693 parent = priv->parent;
3694 if (parent && gtk_widget_is_drawable (parent))
3695 gtk_widget_queue_draw_area (parent,
3698 priv->allocation.width,
3699 priv->allocation.height);
3703 * gtk_widget_unparent:
3704 * @widget: a #GtkWidget
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.
3711 gtk_widget_unparent (GtkWidget *widget)
3713 GtkWidgetPrivate *priv;
3714 GObjectNotifyQueue *nqueue;
3715 GtkWidget *toplevel;
3716 GtkWidget *old_parent;
3718 g_return_if_fail (GTK_IS_WIDGET (widget));
3720 priv = widget->priv;
3722 if (priv->parent == NULL)
3725 /* keep this function in sync with gtk_menu_detach() */
3727 gtk_widget_push_verify_invariants (widget);
3729 g_object_freeze_notify (G_OBJECT (widget));
3730 nqueue = g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
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);
3736 if (gtk_container_get_focus_child (GTK_CONTAINER (priv->parent)) == widget)
3737 gtk_container_set_focus_child (GTK_CONTAINER (priv->parent), NULL);
3739 gtk_widget_queue_draw_child (widget);
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?)
3746 priv->allocation.width = 1;
3747 priv->allocation.height = 1;
3749 if (gtk_widget_get_realized (widget))
3751 if (priv->in_reparent)
3752 gtk_widget_unmap (widget);
3754 gtk_widget_unrealize (widget);
3757 /* If we are unanchoring the child, we save around the toplevel
3758 * to emit hierarchy changed
3760 if (priv->parent->priv->anchored)
3761 g_object_ref (toplevel);
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.
3769 priv->child_visible = TRUE;
3771 old_parent = priv->parent;
3772 priv->parent = NULL;
3774 /* parent may no longer expand if the removed
3775 * child was expand=TRUE and could therefore
3778 if (gtk_widget_get_visible (widget) &&
3779 (priv->need_compute_expand ||
3780 priv->computed_hexpand ||
3781 priv->computed_vexpand))
3783 gtk_widget_queue_compute_expand (old_parent);
3786 /* Unset BACKDROP since we are no longer inside a toplevel window */
3787 gtk_widget_unset_state_flags (widget, GTK_STATE_FLAG_BACKDROP);
3789 gtk_style_context_set_parent (priv->context, NULL);
3791 g_signal_emit (widget, widget_signals[PARENT_SET], 0, old_parent);
3794 _gtk_widget_propagate_hierarchy_changed (widget, toplevel);
3795 g_object_unref (toplevel);
3798 /* Now that the parent pointer is nullified and the hierarchy-changed
3799 * already passed, go ahead and unset the parent window, if we are unparenting
3800 * an embeded GtkWindow the window will become toplevel again and hierarchy-changed
3801 * will fire again for the new subhierarchy.
3803 gtk_widget_set_parent_window (widget, NULL);
3805 g_object_notify (G_OBJECT (widget), "parent");
3806 g_object_thaw_notify (G_OBJECT (widget));
3808 g_object_notify_queue_clear (G_OBJECT (widget), nqueue);
3809 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
3811 gtk_widget_pop_verify_invariants (widget);
3812 g_object_unref (widget);
3816 * gtk_widget_destroy:
3817 * @widget: a #GtkWidget
3819 * Destroys a widget.
3822 * destroyed, it will break any references it holds to other objects.
3823 * If the widget is inside a container, the widget will be removed
3824 * from the container. If the widget is a toplevel (derived from
3825 * #GtkWindow), it will be removed from the list of toplevels, and the
3826 * reference GTK+ holds to it will be removed. Removing a
3827 * widget from its container or the list of toplevels results in the
3828 * widget being finalized, unless you've added additional references
3829 * to the widget with g_object_ref().
3831 * In most cases, only toplevel widgets (windows) require explicit
3832 * destruction, because when you destroy a toplevel its children will
3833 * be destroyed as well.
3836 gtk_widget_destroy (GtkWidget *widget)
3838 g_return_if_fail (GTK_IS_WIDGET (widget));
3840 if (!widget->priv->in_destruction)
3841 g_object_run_dispose (G_OBJECT (widget));
3845 * gtk_widget_destroyed:
3846 * @widget: a #GtkWidget
3847 * @widget_pointer: (inout) (transfer none): address of a variable that contains @widget
3849 * This function sets *@widget_pointer to %NULL if @widget_pointer !=
3850 * %NULL. It's intended to be used as a callback connected to the
3851 * "destroy" signal of a widget. You connect gtk_widget_destroyed()
3852 * as a signal handler, and pass the address of your widget variable
3853 * as user data. Then when the widget is destroyed, the variable will
3854 * be set to %NULL. Useful for example to avoid multiple copies
3855 * of the same dialog.
3858 gtk_widget_destroyed (GtkWidget *widget,
3859 GtkWidget **widget_pointer)
3861 /* Don't make any assumptions about the
3863 * Even check widget_pointer.
3866 *widget_pointer = NULL;
3871 * @widget: a #GtkWidget
3873 * Flags a widget to be displayed. Any widget that isn't shown will
3874 * not appear on the screen. If you want to show all the widgets in a
3875 * container, it's easier to call gtk_widget_show_all() on the
3876 * container, instead of individually showing the widgets.
3878 * Remember that you have to show the containers containing a widget,
3879 * in addition to the widget itself, before it will appear onscreen.
3881 * When a toplevel container is shown, it is immediately realized and
3882 * mapped; other shown widgets are realized and mapped when their
3883 * toplevel container is realized and mapped.
3886 gtk_widget_show (GtkWidget *widget)
3888 g_return_if_fail (GTK_IS_WIDGET (widget));
3890 if (!gtk_widget_get_visible (widget))
3892 g_object_ref (widget);
3893 gtk_widget_push_verify_invariants (widget);
3895 if (!gtk_widget_is_toplevel (widget))
3896 gtk_widget_queue_resize (widget);
3898 /* see comment in set_parent() for why this should and can be
3901 if (widget->priv->need_compute_expand ||
3902 widget->priv->computed_hexpand ||
3903 widget->priv->computed_vexpand)
3905 if (widget->priv->parent != NULL)
3906 gtk_widget_queue_compute_expand (widget->priv->parent);
3909 g_signal_emit (widget, widget_signals[SHOW], 0);
3910 g_object_notify (G_OBJECT (widget), "visible");
3912 gtk_widget_pop_verify_invariants (widget);
3913 g_object_unref (widget);
3918 gtk_widget_real_show (GtkWidget *widget)
3920 GtkWidgetPrivate *priv = widget->priv;
3922 if (!gtk_widget_get_visible (widget))
3924 priv->visible = TRUE;
3927 gtk_widget_get_mapped (priv->parent) &&
3928 gtk_widget_get_child_visible (widget) &&
3929 !gtk_widget_get_mapped (widget))
3930 gtk_widget_map (widget);
3935 gtk_widget_show_map_callback (GtkWidget *widget, GdkEvent *event, gint *flag)
3938 g_signal_handlers_disconnect_by_func (widget,
3939 gtk_widget_show_map_callback,
3944 * gtk_widget_show_now:
3945 * @widget: a #GtkWidget
3947 * Shows a widget. If the widget is an unmapped toplevel widget
3948 * (i.e. a #GtkWindow that has not yet been shown), enter the main
3949 * loop and wait for the window to actually be mapped. Be careful;
3950 * because the main loop is running, anything can happen during
3954 gtk_widget_show_now (GtkWidget *widget)
3958 g_return_if_fail (GTK_IS_WIDGET (widget));
3960 /* make sure we will get event */
3961 if (!gtk_widget_get_mapped (widget) &&
3962 gtk_widget_is_toplevel (widget))
3964 gtk_widget_show (widget);
3966 g_signal_connect (widget, "map-event",
3967 G_CALLBACK (gtk_widget_show_map_callback),
3971 gtk_main_iteration ();
3974 gtk_widget_show (widget);
3979 * @widget: a #GtkWidget
3981 * Reverses the effects of gtk_widget_show(), causing the widget to be
3982 * hidden (invisible to the user).
3985 gtk_widget_hide (GtkWidget *widget)
3987 g_return_if_fail (GTK_IS_WIDGET (widget));
3989 if (gtk_widget_get_visible (widget))
3991 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
3993 g_object_ref (widget);
3994 gtk_widget_push_verify_invariants (widget);
3996 if (toplevel != widget && gtk_widget_is_toplevel (toplevel))
3997 _gtk_window_unset_focus_and_default (GTK_WINDOW (toplevel), widget);
3999 /* a parent may now be expand=FALSE since we're hidden. */
4000 if (widget->priv->need_compute_expand ||
4001 widget->priv->computed_hexpand ||
4002 widget->priv->computed_vexpand)
4004 gtk_widget_queue_compute_expand (widget);
4007 g_signal_emit (widget, widget_signals[HIDE], 0);
4008 if (!gtk_widget_is_toplevel (widget))
4009 gtk_widget_queue_resize (widget);
4010 g_object_notify (G_OBJECT (widget), "visible");
4012 gtk_widget_pop_verify_invariants (widget);
4013 g_object_unref (widget);
4018 gtk_widget_real_hide (GtkWidget *widget)
4020 if (gtk_widget_get_visible (widget))
4022 widget->priv->visible = FALSE;
4024 if (gtk_widget_get_mapped (widget))
4025 gtk_widget_unmap (widget);
4030 * gtk_widget_hide_on_delete:
4031 * @widget: a #GtkWidget
4033 * Utility function; intended to be connected to the #GtkWidget::delete-event
4034 * signal on a #GtkWindow. The function calls gtk_widget_hide() on its
4035 * argument, then returns %TRUE. If connected to ::delete-event, the
4036 * result is that clicking the close button for a window (on the
4037 * window frame, top right corner usually) will hide but not destroy
4038 * the window. By default, GTK+ destroys windows when ::delete-event
4041 * Return value: %TRUE
4044 gtk_widget_hide_on_delete (GtkWidget *widget)
4046 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4048 gtk_widget_hide (widget);
4054 * gtk_widget_show_all:
4055 * @widget: a #GtkWidget
4057 * Recursively shows a widget, and any child widgets (if the widget is
4061 gtk_widget_show_all (GtkWidget *widget)
4063 GtkWidgetClass *class;
4065 g_return_if_fail (GTK_IS_WIDGET (widget));
4067 if (gtk_widget_get_no_show_all (widget))
4070 class = GTK_WIDGET_GET_CLASS (widget);
4072 if (class->show_all)
4073 class->show_all (widget);
4077 _gtk_widget_notify_state_change (GtkWidget *widget,
4085 case GTK_STATE_FLAG_ACTIVE:
4086 state = GTK_STATE_ACTIVE;
4088 case GTK_STATE_FLAG_PRELIGHT:
4089 state = GTK_STATE_PRELIGHT;
4091 case GTK_STATE_FLAG_SELECTED:
4092 state = GTK_STATE_SELECTED;
4094 case GTK_STATE_FLAG_INSENSITIVE:
4095 state = GTK_STATE_INSENSITIVE;
4097 case GTK_STATE_FLAG_INCONSISTENT:
4098 state = GTK_STATE_INCONSISTENT;
4100 case GTK_STATE_FLAG_FOCUSED:
4101 state = GTK_STATE_FOCUSED;
4107 gtk_style_context_notify_state_change (widget->priv->context,
4108 gtk_widget_get_window (widget),
4109 NULL, state, target);
4112 /* Initializes state transitions for those states that
4113 * were enabled before mapping and have a looping animation.
4116 _gtk_widget_start_state_transitions (GtkWidget *widget)
4118 GtkStateFlags state, flag;
4120 if (!widget->priv->context)
4123 state = gtk_widget_get_state_flags (widget);
4124 flag = GTK_STATE_FLAG_FOCUSED;
4128 GtkAnimationDescription *animation_desc;
4130 if ((state & flag) == 0)
4136 gtk_style_context_get (widget->priv->context, state,
4137 "transition", &animation_desc,
4142 if (_gtk_animation_description_get_loop (animation_desc))
4143 _gtk_widget_notify_state_change (widget, flag, TRUE);
4145 _gtk_animation_description_unref (animation_desc);
4154 * @widget: a #GtkWidget
4156 * This function is only for use in widget implementations. Causes
4157 * a widget to be mapped if it isn't already.
4160 gtk_widget_map (GtkWidget *widget)
4162 GtkWidgetPrivate *priv;
4164 g_return_if_fail (GTK_IS_WIDGET (widget));
4165 g_return_if_fail (gtk_widget_get_visible (widget));
4166 g_return_if_fail (gtk_widget_get_child_visible (widget));
4168 priv = widget->priv;
4170 if (!gtk_widget_get_mapped (widget))
4172 gtk_widget_push_verify_invariants (widget);
4174 if (!gtk_widget_get_realized (widget))
4175 gtk_widget_realize (widget);
4177 g_signal_emit (widget, widget_signals[MAP], 0);
4179 if (!gtk_widget_get_has_window (widget))
4180 gdk_window_invalidate_rect (priv->window, &priv->allocation, FALSE);
4182 gtk_widget_pop_verify_invariants (widget);
4184 _gtk_widget_start_state_transitions (widget);
4190 * @widget: a #GtkWidget
4192 * This function is only for use in widget implementations. Causes
4193 * a widget to be unmapped if it's currently mapped.
4196 gtk_widget_unmap (GtkWidget *widget)
4198 GtkWidgetPrivate *priv;
4200 g_return_if_fail (GTK_IS_WIDGET (widget));
4202 priv = widget->priv;
4204 if (gtk_widget_get_mapped (widget))
4206 gtk_widget_push_verify_invariants (widget);
4208 if (!gtk_widget_get_has_window (widget))
4209 gdk_window_invalidate_rect (priv->window, &priv->allocation, FALSE);
4210 _gtk_tooltip_hide (widget);
4211 g_signal_emit (widget, widget_signals[UNMAP], 0);
4213 gtk_widget_pop_verify_invariants (widget);
4216 gtk_style_context_cancel_animations (priv->context, NULL);
4218 /* Unset pointer/window info */
4219 g_object_set_qdata (G_OBJECT (widget), quark_pointer_window, NULL);
4224 _gtk_widget_enable_device_events (GtkWidget *widget)
4226 GHashTable *device_events;
4227 GHashTableIter iter;
4228 gpointer key, value;
4230 device_events = g_object_get_qdata (G_OBJECT (widget), quark_device_event_mask);
4235 g_hash_table_iter_init (&iter, device_events);
4237 while (g_hash_table_iter_next (&iter, &key, &value))
4240 GdkEventMask event_mask;
4243 event_mask = GPOINTER_TO_UINT (value);
4244 gtk_widget_add_events_internal (widget, device, event_mask);
4249 get_widget_windows (GtkWidget *widget)
4251 GList *window_list, *last, *l, *children, *ret;
4253 if (gtk_widget_get_has_window (widget))
4254 window_list = g_list_prepend (NULL, gtk_widget_get_window (widget));
4256 window_list = gdk_window_peek_children (gtk_widget_get_window (widget));
4258 last = g_list_last (window_list);
4261 for (l = window_list; l; l = l->next)
4263 GtkWidget *window_widget = NULL;
4265 gdk_window_get_user_data (l->data, (gpointer *) &window_widget);
4267 if (widget != window_widget)
4270 ret = g_list_prepend (ret, l->data);
4271 children = gdk_window_peek_children (GDK_WINDOW (l->data));
4275 last = g_list_concat (last, children);
4276 last = g_list_last (last);
4280 g_list_free (window_list);
4286 device_enable_foreach (GtkWidget *widget,
4289 GdkDevice *device = user_data;
4290 gtk_widget_set_device_enabled_internal (widget, device, TRUE, TRUE);
4294 device_disable_foreach (GtkWidget *widget,
4297 GdkDevice *device = user_data;
4298 gtk_widget_set_device_enabled_internal (widget, device, TRUE, FALSE);
4302 gtk_widget_set_device_enabled_internal (GtkWidget *widget,
4307 GList *window_list, *l;
4309 window_list = get_widget_windows (widget);
4311 for (l = window_list; l; l = l->next)
4313 GdkEventMask events = 0;
4319 events = gdk_window_get_events (window);
4321 gdk_window_set_device_events (window, device, events);
4324 if (recurse && GTK_IS_CONTAINER (widget))
4327 gtk_container_forall (GTK_CONTAINER (widget), device_enable_foreach, device);
4329 gtk_container_forall (GTK_CONTAINER (widget), device_disable_foreach, device);
4332 g_list_free (window_list);
4336 gtk_widget_update_devices_mask (GtkWidget *widget,
4339 GList *enabled_devices, *l;
4341 enabled_devices = g_object_get_qdata (G_OBJECT (widget), quark_enabled_devices);
4343 for (l = enabled_devices; l; l = l->next)
4344 gtk_widget_set_device_enabled_internal (widget, GDK_DEVICE (l->data), recurse, TRUE);
4348 * gtk_widget_realize:
4349 * @widget: a #GtkWidget
4351 * Creates the GDK (windowing system) resources associated with a
4352 * widget. For example, @widget->window will be created when a widget
4353 * is realized. Normally realization happens implicitly; if you show
4354 * a widget and all its parent containers, then the widget will be
4355 * realized and mapped automatically.
4357 * Realizing a widget requires all
4358 * the widget's parent widgets to be realized; calling
4359 * gtk_widget_realize() realizes the widget's parents in addition to
4360 * @widget itself. If a widget is not yet inside a toplevel window
4361 * when you realize it, bad things will happen.
4363 * This function is primarily used in widget implementations, and
4364 * isn't very useful otherwise. Many times when you think you might
4365 * need it, a better approach is to connect to a signal that will be
4366 * called after the widget is realized automatically, such as
4367 * #GtkWidget::draw. Or simply g_signal_connect () to the
4368 * #GtkWidget::realize signal.
4371 gtk_widget_realize (GtkWidget *widget)
4373 GtkWidgetPrivate *priv;
4374 cairo_region_t *region;
4376 g_return_if_fail (GTK_IS_WIDGET (widget));
4377 g_return_if_fail (widget->priv->anchored ||
4378 GTK_IS_INVISIBLE (widget));
4380 priv = widget->priv;
4382 if (!gtk_widget_get_realized (widget))
4384 gtk_widget_push_verify_invariants (widget);
4387 if (GTK_IS_CONTAINER (widget) && gtk_widget_get_has_window (widget))
4388 g_message ("gtk_widget_realize(%s)", G_OBJECT_TYPE_NAME (widget));
4391 if (priv->parent == NULL &&
4392 !gtk_widget_is_toplevel (widget))
4393 g_warning ("Calling gtk_widget_realize() on a widget that isn't "
4394 "inside a toplevel window is not going to work very well. "
4395 "Widgets must be inside a toplevel container before realizing them.");
4397 if (priv->parent && !gtk_widget_get_realized (priv->parent))
4398 gtk_widget_realize (priv->parent);
4400 gtk_widget_ensure_style (widget);
4402 if (priv->style_update_pending)
4403 g_signal_emit (widget, widget_signals[STYLE_UPDATED], 0);
4405 g_signal_emit (widget, widget_signals[REALIZE], 0);
4407 gtk_widget_real_set_has_tooltip (widget,
4408 GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (widget), quark_has_tooltip)),
4411 if (priv->has_shape_mask)
4413 region = g_object_get_qdata (G_OBJECT (widget), quark_shape_info);
4414 gdk_window_shape_combine_region (priv->window, region, 0, 0);
4417 region = g_object_get_qdata (G_OBJECT (widget), quark_input_shape_info);
4419 gdk_window_input_shape_combine_region (priv->window, region, 0, 0);
4421 if (priv->multidevice)
4422 gdk_window_set_support_multidevice (priv->window, TRUE);
4424 _gtk_widget_enable_device_events (widget);
4425 gtk_widget_update_devices_mask (widget, TRUE);
4427 gtk_widget_pop_verify_invariants (widget);
4432 * gtk_widget_unrealize:
4433 * @widget: a #GtkWidget
4435 * This function is only useful in widget implementations.
4436 * Causes a widget to be unrealized (frees all GDK resources
4437 * associated with the widget, such as @widget->window).
4440 gtk_widget_unrealize (GtkWidget *widget)
4442 g_return_if_fail (GTK_IS_WIDGET (widget));
4444 gtk_widget_push_verify_invariants (widget);
4446 if (widget->priv->has_shape_mask)
4447 gtk_widget_shape_combine_region (widget, NULL);
4449 if (g_object_get_qdata (G_OBJECT (widget), quark_input_shape_info))
4450 gtk_widget_input_shape_combine_region (widget, NULL);
4452 if (gtk_widget_get_realized (widget))
4454 g_object_ref (widget);
4456 if (widget->priv->mapped)
4457 gtk_widget_unmap (widget);
4459 g_signal_emit (widget, widget_signals[UNREALIZE], 0);
4460 g_assert (!widget->priv->mapped);
4461 gtk_widget_set_realized (widget, FALSE);
4463 g_object_unref (widget);
4466 gtk_widget_pop_verify_invariants (widget);
4469 /*****************************************
4471 *****************************************/
4474 * gtk_widget_queue_draw_region:
4475 * @widget: a #GtkWidget
4476 * @region: region to draw
4478 * Invalidates the rectangular area of @widget defined by @region by
4479 * calling gdk_window_invalidate_region() on the widget's window and
4480 * all its child windows. Once the main loop becomes idle (after the
4481 * current batch of events has been processed, roughly), the window
4482 * will receive expose events for the union of all regions that have
4485 * Normally you would only use this function in widget
4486 * implementations. You might also use it to schedule a redraw of a
4487 * #GtkDrawingArea or some portion thereof.
4492 gtk_widget_queue_draw_region (GtkWidget *widget,
4493 const cairo_region_t *region)
4495 GtkWidgetPrivate *priv;
4498 g_return_if_fail (GTK_IS_WIDGET (widget));
4500 priv = widget->priv;
4502 if (!gtk_widget_get_realized (widget))
4505 /* Just return if the widget or one of its ancestors isn't mapped */
4506 for (w = widget; w != NULL; w = w->priv->parent)
4507 if (!gtk_widget_get_mapped (w))
4510 gdk_window_invalidate_region (priv->window, region, TRUE);
4514 * gtk_widget_queue_draw_area:
4515 * @widget: a #GtkWidget
4516 * @x: x coordinate of upper-left corner of rectangle to redraw
4517 * @y: y coordinate of upper-left corner of rectangle to redraw
4518 * @width: width of region to draw
4519 * @height: height of region to draw
4521 * Convenience function that calls gtk_widget_queue_draw_region() on
4522 * the region created from the given coordinates.
4524 * The region here is specified in widget coordinates.
4525 * Widget coordinates are a bit odd; for historical reasons, they are
4526 * defined as @widget->window coordinates for widgets that are not
4527 * #GTK_NO_WINDOW widgets, and are relative to @widget->allocation.x,
4528 * @widget->allocation.y for widgets that are #GTK_NO_WINDOW widgets.
4531 gtk_widget_queue_draw_area (GtkWidget *widget,
4538 cairo_region_t *region;
4540 g_return_if_fail (GTK_IS_WIDGET (widget));
4545 rect.height = height;
4547 region = cairo_region_create_rectangle (&rect);
4548 gtk_widget_queue_draw_region (widget, region);
4549 cairo_region_destroy (region);
4553 * gtk_widget_queue_draw:
4554 * @widget: a #GtkWidget
4556 * Equivalent to calling gtk_widget_queue_draw_area() for the
4557 * entire area of a widget.
4560 gtk_widget_queue_draw (GtkWidget *widget)
4564 g_return_if_fail (GTK_IS_WIDGET (widget));
4566 gtk_widget_get_allocation (widget, &rect);
4568 if (!gtk_widget_get_has_window (widget))
4569 gtk_widget_queue_draw_area (widget,
4570 rect.x, rect.y, rect.width, rect.height);
4572 gtk_widget_queue_draw_area (widget,
4573 0, 0, rect.width, rect.height);
4577 * gtk_widget_queue_resize:
4578 * @widget: a #GtkWidget
4580 * This function is only for use in widget implementations.
4581 * Flags a widget to have its size renegotiated; should
4582 * be called when a widget for some reason has a new size request.
4583 * For example, when you change the text in a #GtkLabel, #GtkLabel
4584 * queues a resize to ensure there's enough space for the new text.
4586 * <note><para>You cannot call gtk_widget_queue_resize() on a widget
4587 * from inside its implementation of the GtkWidgetClass::size_allocate
4588 * virtual method. Calls to gtk_widget_queue_resize() from inside
4589 * GtkWidgetClass::size_allocate will be silently ignored.</para></note>
4592 gtk_widget_queue_resize (GtkWidget *widget)
4594 g_return_if_fail (GTK_IS_WIDGET (widget));
4596 if (gtk_widget_get_realized (widget))
4597 gtk_widget_queue_shallow_draw (widget);
4599 _gtk_size_group_queue_resize (widget, 0);
4603 * gtk_widget_queue_resize_no_redraw:
4604 * @widget: a #GtkWidget
4606 * This function works like gtk_widget_queue_resize(),
4607 * except that the widget is not invalidated.
4612 gtk_widget_queue_resize_no_redraw (GtkWidget *widget)
4614 g_return_if_fail (GTK_IS_WIDGET (widget));
4616 _gtk_size_group_queue_resize (widget, 0);
4620 * gtk_widget_size_request:
4621 * @widget: a #GtkWidget
4622 * @requisition: (out): a #GtkRequisition to be filled in
4624 * This function is typically used when implementing a #GtkContainer
4625 * subclass. Obtains the preferred size of a widget. The container
4626 * uses this information to arrange its child widgets and decide what
4627 * size allocations to give them with gtk_widget_size_allocate().
4629 * You can also call this function from an application, with some
4630 * caveats. Most notably, getting a size request requires the widget
4631 * to be associated with a screen, because font information may be
4632 * needed. Multihead-aware applications should keep this in mind.
4634 * Also remember that the size request is not necessarily the size
4635 * a widget will actually be allocated.
4637 * Deprecated: 3.0: Use gtk_widget_get_preferred_size() instead.
4640 gtk_widget_size_request (GtkWidget *widget,
4641 GtkRequisition *requisition)
4643 g_return_if_fail (GTK_IS_WIDGET (widget));
4645 gtk_widget_get_preferred_size (widget, requisition, NULL);
4649 * gtk_widget_get_child_requisition:
4650 * @widget: a #GtkWidget
4651 * @requisition: (out): a #GtkRequisition to be filled in
4653 * This function is only for use in widget implementations. Obtains
4654 * @widget->requisition, unless someone has forced a particular
4655 * geometry on the widget (e.g. with gtk_widget_set_size_request()),
4656 * in which case it returns that geometry instead of the widget's
4659 * This function differs from gtk_widget_size_request() in that
4660 * it retrieves the last size request value from @widget->requisition,
4661 * while gtk_widget_size_request() actually calls the "size_request" method
4662 * on @widget to compute the size request and fill in @widget->requisition,
4663 * and only then returns @widget->requisition.
4665 * Because this function does not call the "size_request" method, it
4666 * can only be used when you know that @widget->requisition is
4667 * up-to-date, that is, gtk_widget_size_request() has been called
4668 * since the last time a resize was queued. In general, only container
4669 * implementations have this information; applications should use
4670 * gtk_widget_size_request().
4673 * Deprecated: 3.0: Use gtk_widget_get_preferred_size() instead.
4676 gtk_widget_get_child_requisition (GtkWidget *widget,
4677 GtkRequisition *requisition)
4679 gtk_widget_get_preferred_size (widget, requisition, NULL);
4683 invalidate_predicate (GdkWindow *window,
4688 gdk_window_get_user_data (window, &user_data);
4690 return (user_data == data);
4693 /* Invalidate @region in widget->window and all children
4694 * of widget->window owned by widget. @region is in the
4695 * same coordinates as widget->allocation and will be
4696 * modified by this call.
4699 gtk_widget_invalidate_widget_windows (GtkWidget *widget,
4700 cairo_region_t *region)
4702 GtkWidgetPrivate *priv = widget->priv;
4704 if (!gtk_widget_get_realized (widget))
4707 if (gtk_widget_get_has_window (widget) && priv->parent)
4711 gdk_window_get_position (priv->window, &x, &y);
4712 cairo_region_translate (region, -x, -y);
4715 gdk_window_invalidate_maybe_recurse (priv->window, region,
4716 invalidate_predicate, widget);
4720 * gtk_widget_queue_shallow_draw:
4721 * @widget: a #GtkWidget
4723 * Like gtk_widget_queue_draw(), but only windows owned
4724 * by @widget are invalidated.
4727 gtk_widget_queue_shallow_draw (GtkWidget *widget)
4730 cairo_region_t *region;
4732 if (!gtk_widget_get_realized (widget))
4735 gtk_widget_get_allocation (widget, &rect);
4737 region = cairo_region_create_rectangle (&rect);
4738 gtk_widget_invalidate_widget_windows (widget, region);
4739 cairo_region_destroy (region);
4743 * gtk_widget_size_allocate:
4744 * @widget: a #GtkWidget
4745 * @allocation: position and size to be allocated to @widget
4747 * This function is only used by #GtkContainer subclasses, to assign a size
4748 * and position to their child widgets.
4750 * In this function, the allocation may be adjusted. It will be forced
4751 * to a 1x1 minimum size, and the adjust_size_allocation virtual
4752 * method on the child will be used to adjust the allocation. Standard
4753 * adjustments include removing the widget's margins, and applying the
4754 * widget's #GtkWidget:halign and #GtkWidget:valign properties.
4757 gtk_widget_size_allocate (GtkWidget *widget,
4758 GtkAllocation *allocation)
4760 GtkWidgetPrivate *priv;
4761 GdkRectangle real_allocation;
4762 GdkRectangle old_allocation;
4763 GdkRectangle adjusted_allocation;
4764 gboolean alloc_needed;
4765 gboolean size_changed;
4766 gboolean position_changed;
4767 gint natural_width, natural_height, dummy;
4768 gint min_width, min_height;
4770 priv = widget->priv;
4772 g_return_if_fail (GTK_IS_WIDGET (widget));
4774 gtk_widget_push_verify_invariants (widget);
4776 #ifdef G_ENABLE_DEBUG
4777 if (gtk_get_debug_flags () & GTK_DEBUG_GEOMETRY)
4788 parent = gtk_widget_get_parent (parent);
4791 name = g_type_name (G_OBJECT_TYPE (G_OBJECT (widget)));
4792 g_print ("gtk_widget_size_allocate: %*s%s %d %d\n",
4793 2 * depth, " ", name,
4794 allocation->width, allocation->height);
4796 #endif /* G_ENABLE_DEBUG */
4798 alloc_needed = priv->alloc_needed;
4799 if (!priv->width_request_needed && !priv->height_request_needed)
4800 /* Preserve request/allocate ordering */
4801 priv->alloc_needed = FALSE;
4803 old_allocation = priv->allocation;
4804 real_allocation = *allocation;
4806 adjusted_allocation = real_allocation;
4807 if (gtk_widget_get_request_mode (widget) == GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH)
4809 /* Go ahead and request the height for allocated width, note that the internals
4810 * of get_height_for_width will internally limit the for_size to natural size
4811 * when aligning implicitly.
4813 gtk_widget_get_preferred_width (widget, &min_width, &natural_width);
4814 gtk_widget_get_preferred_height_for_width (widget, real_allocation.width, &min_height, &natural_height);
4818 /* Go ahead and request the width for allocated height, note that the internals
4819 * of get_width_for_height will internally limit the for_size to natural size
4820 * when aligning implicitly.
4822 gtk_widget_get_preferred_height (widget, &min_height, &natural_height);
4823 gtk_widget_get_preferred_width_for_height (widget, real_allocation.height, &min_width, &natural_width);
4826 #ifdef G_ENABLE_DEBUG
4827 if (gtk_get_debug_flags () & GTK_DEBUG_GEOMETRY)
4829 if ((min_width > real_allocation.width || min_height > real_allocation.height) &&
4830 !GTK_IS_SCROLLABLE (widget))
4831 g_warning ("gtk_widget_size_allocate(): attempt to underallocate %s%s %s %p. "
4832 "Allocation is %dx%d, but minimum required size is %dx%d.",
4833 priv->parent ? G_OBJECT_TYPE_NAME (priv->parent) : "", priv->parent ? "'s child" : "toplevel",
4834 G_OBJECT_TYPE_NAME (widget), widget,
4835 real_allocation.width, real_allocation.height,
4836 min_width, min_height);
4839 /* Now that we have the right natural height and width, go ahead and remove any margins from the
4840 * allocated sizes and possibly limit them to the natural sizes */
4841 GTK_WIDGET_GET_CLASS (widget)->adjust_size_allocation (widget,
4842 GTK_ORIENTATION_HORIZONTAL,
4845 &adjusted_allocation.x,
4846 &adjusted_allocation.width);
4847 GTK_WIDGET_GET_CLASS (widget)->adjust_size_allocation (widget,
4848 GTK_ORIENTATION_VERTICAL,
4851 &adjusted_allocation.y,
4852 &adjusted_allocation.height);
4854 if (adjusted_allocation.x < real_allocation.x ||
4855 adjusted_allocation.y < real_allocation.y ||
4856 (adjusted_allocation.x + adjusted_allocation.width) >
4857 (real_allocation.x + real_allocation.width) ||
4858 (adjusted_allocation.y + adjusted_allocation.height >
4859 real_allocation.y + real_allocation.height))
4861 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",
4862 G_OBJECT_TYPE_NAME (widget), widget,
4863 real_allocation.x, real_allocation.y, real_allocation.width, real_allocation.height,
4864 adjusted_allocation.x, adjusted_allocation.y, adjusted_allocation.width, adjusted_allocation.height);
4865 adjusted_allocation = real_allocation; /* veto it */
4869 real_allocation = adjusted_allocation;
4872 if (real_allocation.width < 0 || real_allocation.height < 0)
4874 g_warning ("gtk_widget_size_allocate(): attempt to allocate widget with width %d and height %d",
4875 real_allocation.width,
4876 real_allocation.height);
4879 real_allocation.width = MAX (real_allocation.width, 1);
4880 real_allocation.height = MAX (real_allocation.height, 1);
4882 size_changed = (old_allocation.width != real_allocation.width ||
4883 old_allocation.height != real_allocation.height);
4884 position_changed = (old_allocation.x != real_allocation.x ||
4885 old_allocation.y != real_allocation.y);
4887 if (!alloc_needed && !size_changed && !position_changed)
4890 g_signal_emit (widget, widget_signals[SIZE_ALLOCATE], 0, &real_allocation);
4892 /* Size allocation is god... after consulting god, no further requests or allocations are needed */
4893 priv->width_request_needed = FALSE;
4894 priv->height_request_needed = FALSE;
4895 priv->alloc_needed = FALSE;
4897 if (gtk_widget_get_mapped (widget))
4899 if (!gtk_widget_get_has_window (widget) && priv->redraw_on_alloc && position_changed)
4901 /* Invalidate union(old_allaction,priv->allocation) in priv->window
4903 cairo_region_t *invalidate = cairo_region_create_rectangle (&priv->allocation);
4904 cairo_region_union_rectangle (invalidate, &old_allocation);
4906 gdk_window_invalidate_region (priv->window, invalidate, FALSE);
4907 cairo_region_destroy (invalidate);
4912 if (priv->redraw_on_alloc)
4914 /* Invalidate union(old_allaction,priv->allocation) in priv->window and descendents owned by widget
4916 cairo_region_t *invalidate = cairo_region_create_rectangle (&priv->allocation);
4917 cairo_region_union_rectangle (invalidate, &old_allocation);
4919 gtk_widget_invalidate_widget_windows (widget, invalidate);
4920 cairo_region_destroy (invalidate);
4924 if (size_changed || position_changed)
4926 GtkStyleContext *context;
4928 context = gtk_widget_get_style_context (widget);
4929 _gtk_style_context_invalidate_animation_areas (context);
4933 if ((size_changed || position_changed) && priv->parent &&
4934 gtk_widget_get_realized (priv->parent) && _gtk_container_get_reallocate_redraws (GTK_CONTAINER (priv->parent)))
4936 cairo_region_t *invalidate = cairo_region_create_rectangle (&priv->parent->priv->allocation);
4937 gtk_widget_invalidate_widget_windows (priv->parent, invalidate);
4938 cairo_region_destroy (invalidate);
4942 gtk_widget_pop_verify_invariants (widget);
4946 * gtk_widget_common_ancestor:
4947 * @widget_a: a #GtkWidget
4948 * @widget_b: a #GtkWidget
4950 * Find the common ancestor of @widget_a and @widget_b that
4951 * is closest to the two widgets.
4953 * Return value: the closest common ancestor of @widget_a and
4954 * @widget_b or %NULL if @widget_a and @widget_b do not
4955 * share a common ancestor.
4958 gtk_widget_common_ancestor (GtkWidget *widget_a,
4959 GtkWidget *widget_b)
4961 GtkWidget *parent_a;
4962 GtkWidget *parent_b;
4966 parent_a = widget_a;
4967 while (parent_a->priv->parent)
4969 parent_a = parent_a->priv->parent;
4973 parent_b = widget_b;
4974 while (parent_b->priv->parent)
4976 parent_b = parent_b->priv->parent;
4980 if (parent_a != parent_b)
4983 while (depth_a > depth_b)
4985 widget_a = widget_a->priv->parent;
4989 while (depth_b > depth_a)
4991 widget_b = widget_b->priv->parent;
4995 while (widget_a != widget_b)
4997 widget_a = widget_a->priv->parent;
4998 widget_b = widget_b->priv->parent;
5005 * gtk_widget_translate_coordinates:
5006 * @src_widget: a #GtkWidget
5007 * @dest_widget: a #GtkWidget
5008 * @src_x: X position relative to @src_widget
5009 * @src_y: Y position relative to @src_widget
5010 * @dest_x: (out): location to store X position relative to @dest_widget
5011 * @dest_y: (out): location to store Y position relative to @dest_widget
5013 * Translate coordinates relative to @src_widget's allocation to coordinates
5014 * relative to @dest_widget's allocations. In order to perform this
5015 * operation, both widgets must be realized, and must share a common
5018 * Return value: %FALSE if either widget was not realized, or there
5019 * was no common ancestor. In this case, nothing is stored in
5020 * *@dest_x and *@dest_y. Otherwise %TRUE.
5023 gtk_widget_translate_coordinates (GtkWidget *src_widget,
5024 GtkWidget *dest_widget,
5030 GtkWidgetPrivate *src_priv = src_widget->priv;
5031 GtkWidgetPrivate *dest_priv = dest_widget->priv;
5032 GtkWidget *ancestor;
5034 GList *dest_list = NULL;
5036 g_return_val_if_fail (GTK_IS_WIDGET (src_widget), FALSE);
5037 g_return_val_if_fail (GTK_IS_WIDGET (dest_widget), FALSE);
5039 ancestor = gtk_widget_common_ancestor (src_widget, dest_widget);
5040 if (!ancestor || !gtk_widget_get_realized (src_widget) || !gtk_widget_get_realized (dest_widget))
5043 /* Translate from allocation relative to window relative */
5044 if (gtk_widget_get_has_window (src_widget) && src_priv->parent)
5047 gdk_window_get_position (src_priv->window, &wx, &wy);
5049 src_x -= wx - src_priv->allocation.x;
5050 src_y -= wy - src_priv->allocation.y;
5054 src_x += src_priv->allocation.x;
5055 src_y += src_priv->allocation.y;
5058 /* Translate to the common ancestor */
5059 window = src_priv->window;
5060 while (window != ancestor->priv->window)
5064 gdk_window_coords_to_parent (window, src_x, src_y, &dx, &dy);
5069 window = gdk_window_get_effective_parent (window);
5071 if (!window) /* Handle GtkHandleBox */
5076 window = dest_priv->window;
5077 while (window != ancestor->priv->window)
5079 dest_list = g_list_prepend (dest_list, window);
5081 window = gdk_window_get_effective_parent (window);
5083 if (!window) /* Handle GtkHandleBox */
5085 g_list_free (dest_list);
5094 gdk_window_coords_from_parent (dest_list->data, src_x, src_y, &dx, &dy);
5099 dest_list = g_list_remove (dest_list, dest_list->data);
5102 /* Translate from window relative to allocation relative */
5103 if (gtk_widget_get_has_window (dest_widget) && dest_priv->parent)
5106 gdk_window_get_position (dest_priv->window, &wx, &wy);
5108 src_x += wx - dest_priv->allocation.x;
5109 src_y += wy - dest_priv->allocation.y;
5113 src_x -= dest_priv->allocation.x;
5114 src_y -= dest_priv->allocation.y;
5126 gtk_widget_real_size_allocate (GtkWidget *widget,
5127 GtkAllocation *allocation)
5129 GtkWidgetPrivate *priv = widget->priv;
5131 priv->allocation = *allocation;
5133 if (gtk_widget_get_realized (widget) &&
5134 gtk_widget_get_has_window (widget))
5136 gdk_window_move_resize (priv->window,
5137 allocation->x, allocation->y,
5138 allocation->width, allocation->height);
5142 /* translate initial/final into start/end */
5144 effective_align (GtkAlign align,
5145 GtkTextDirection direction)
5149 case GTK_ALIGN_START:
5150 return direction == GTK_TEXT_DIR_RTL ? GTK_ALIGN_END : GTK_ALIGN_START;
5152 return direction == GTK_TEXT_DIR_RTL ? GTK_ALIGN_START : GTK_ALIGN_END;
5159 adjust_for_align (GtkAlign align,
5161 gint *allocated_pos,
5162 gint *allocated_size)
5166 case GTK_ALIGN_FILL:
5167 /* change nothing */
5169 case GTK_ALIGN_START:
5170 /* keep *allocated_pos where it is */
5171 *allocated_size = MIN (*allocated_size, *natural_size);
5174 if (*allocated_size > *natural_size)
5176 *allocated_pos += (*allocated_size - *natural_size);
5177 *allocated_size = *natural_size;
5180 case GTK_ALIGN_CENTER:
5181 if (*allocated_size > *natural_size)
5183 *allocated_pos += (*allocated_size - *natural_size) / 2;
5184 *allocated_size = MIN (*allocated_size, *natural_size);
5191 adjust_for_margin(gint start_margin,
5195 gint *allocated_pos,
5196 gint *allocated_size)
5198 *minimum_size -= (start_margin + end_margin);
5199 *natural_size -= (start_margin + end_margin);
5200 *allocated_pos += start_margin;
5201 *allocated_size -= (start_margin + end_margin);
5205 gtk_widget_real_adjust_size_allocation (GtkWidget *widget,
5206 GtkOrientation orientation,
5209 gint *allocated_pos,
5210 gint *allocated_size)
5212 const GtkWidgetAuxInfo *aux_info;
5214 aux_info = _gtk_widget_get_aux_info_or_defaults (widget);
5216 if (orientation == GTK_ORIENTATION_HORIZONTAL)
5218 adjust_for_margin (aux_info->margin.left,
5219 aux_info->margin.right,
5220 minimum_size, natural_size,
5221 allocated_pos, allocated_size);
5222 adjust_for_align (effective_align (aux_info->halign, gtk_widget_get_direction (widget)),
5223 natural_size, allocated_pos, allocated_size);
5227 adjust_for_margin (aux_info->margin.top,
5228 aux_info->margin.bottom,
5229 minimum_size, natural_size,
5230 allocated_pos, allocated_size);
5231 adjust_for_align (effective_align (aux_info->valign, GTK_TEXT_DIR_NONE),
5232 natural_size, allocated_pos, allocated_size);
5237 gtk_widget_real_can_activate_accel (GtkWidget *widget,
5240 GtkWidgetPrivate *priv = widget->priv;
5242 /* widgets must be onscreen for accels to take effect */
5243 return gtk_widget_is_sensitive (widget) &&
5244 gtk_widget_is_drawable (widget) &&
5245 gdk_window_is_viewable (priv->window);
5249 * gtk_widget_can_activate_accel:
5250 * @widget: a #GtkWidget
5251 * @signal_id: the ID of a signal installed on @widget
5253 * Determines whether an accelerator that activates the signal
5254 * identified by @signal_id can currently be activated.
5255 * This is done by emitting the #GtkWidget::can-activate-accel
5256 * signal on @widget; if the signal isn't overridden by a
5257 * handler or in a derived widget, then the default check is
5258 * that the widget must be sensitive, and the widget and all
5259 * its ancestors mapped.
5261 * Return value: %TRUE if the accelerator can be activated.
5266 gtk_widget_can_activate_accel (GtkWidget *widget,
5269 gboolean can_activate = FALSE;
5270 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5271 g_signal_emit (widget, widget_signals[CAN_ACTIVATE_ACCEL], 0, signal_id, &can_activate);
5272 return can_activate;
5281 closure_accel_activate (GClosure *closure,
5282 GValue *return_value,
5283 guint n_param_values,
5284 const GValue *param_values,
5285 gpointer invocation_hint,
5286 gpointer marshal_data)
5288 AccelClosure *aclosure = (AccelClosure*) closure;
5289 gboolean can_activate = gtk_widget_can_activate_accel (closure->data, aclosure->signal_id);
5292 g_signal_emit (closure->data, aclosure->signal_id, 0);
5294 /* whether accelerator was handled */
5295 g_value_set_boolean (return_value, can_activate);
5299 closures_destroy (gpointer data)
5301 GSList *slist, *closures = data;
5303 for (slist = closures; slist; slist = slist->next)
5305 g_closure_invalidate (slist->data);
5306 g_closure_unref (slist->data);
5308 g_slist_free (closures);
5312 widget_new_accel_closure (GtkWidget *widget,
5315 AccelClosure *aclosure;
5316 GClosure *closure = NULL;
5317 GSList *slist, *closures;
5319 closures = g_object_steal_qdata (G_OBJECT (widget), quark_accel_closures);
5320 for (slist = closures; slist; slist = slist->next)
5321 if (!gtk_accel_group_from_accel_closure (slist->data))
5323 /* reuse this closure */
5324 closure = slist->data;
5329 closure = g_closure_new_object (sizeof (AccelClosure), G_OBJECT (widget));
5330 closures = g_slist_prepend (closures, g_closure_ref (closure));
5331 g_closure_sink (closure);
5332 g_closure_set_marshal (closure, closure_accel_activate);
5334 g_object_set_qdata_full (G_OBJECT (widget), quark_accel_closures, closures, closures_destroy);
5336 aclosure = (AccelClosure*) closure;
5337 g_assert (closure->data == widget);
5338 g_assert (closure->marshal == closure_accel_activate);
5339 aclosure->signal_id = signal_id;
5345 * gtk_widget_add_accelerator
5346 * @widget: widget to install an accelerator on
5347 * @accel_signal: widget signal to emit on accelerator activation
5348 * @accel_group: accel group for this widget, added to its toplevel
5349 * @accel_key: GDK keyval of the accelerator
5350 * @accel_mods: modifier key combination of the accelerator
5351 * @accel_flags: flag accelerators, e.g. %GTK_ACCEL_VISIBLE
5353 * Installs an accelerator for this @widget in @accel_group that causes
5354 * @accel_signal to be emitted if the accelerator is activated.
5355 * The @accel_group needs to be added to the widget's toplevel via
5356 * gtk_window_add_accel_group(), and the signal must be of type %G_RUN_ACTION.
5357 * Accelerators added through this function are not user changeable during
5358 * runtime. If you want to support accelerators that can be changed by the
5359 * user, use gtk_accel_map_add_entry() and gtk_widget_set_accel_path() or
5360 * gtk_menu_item_set_accel_path() instead.
5363 gtk_widget_add_accelerator (GtkWidget *widget,
5364 const gchar *accel_signal,
5365 GtkAccelGroup *accel_group,
5367 GdkModifierType accel_mods,
5368 GtkAccelFlags accel_flags)
5373 g_return_if_fail (GTK_IS_WIDGET (widget));
5374 g_return_if_fail (accel_signal != NULL);
5375 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
5377 g_signal_query (g_signal_lookup (accel_signal, G_OBJECT_TYPE (widget)), &query);
5378 if (!query.signal_id ||
5379 !(query.signal_flags & G_SIGNAL_ACTION) ||
5380 query.return_type != G_TYPE_NONE ||
5383 /* hmm, should be elaborate enough */
5384 g_warning (G_STRLOC ": widget `%s' has no activatable signal \"%s\" without arguments",
5385 G_OBJECT_TYPE_NAME (widget), accel_signal);
5389 closure = widget_new_accel_closure (widget, query.signal_id);
5391 g_object_ref (widget);
5393 /* install the accelerator. since we don't map this onto an accel_path,
5394 * the accelerator will automatically be locked.
5396 gtk_accel_group_connect (accel_group,
5399 accel_flags | GTK_ACCEL_LOCKED,
5402 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
5404 g_object_unref (widget);
5408 * gtk_widget_remove_accelerator:
5409 * @widget: widget to install an accelerator on
5410 * @accel_group: accel group for this widget
5411 * @accel_key: GDK keyval of the accelerator
5412 * @accel_mods: modifier key combination of the accelerator
5414 * Removes an accelerator from @widget, previously installed with
5415 * gtk_widget_add_accelerator().
5417 * Returns: whether an accelerator was installed and could be removed
5420 gtk_widget_remove_accelerator (GtkWidget *widget,
5421 GtkAccelGroup *accel_group,
5423 GdkModifierType accel_mods)
5425 GtkAccelGroupEntry *ag_entry;
5426 GList *slist, *clist;
5429 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5430 g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE);
5432 ag_entry = gtk_accel_group_query (accel_group, accel_key, accel_mods, &n);
5433 clist = gtk_widget_list_accel_closures (widget);
5434 for (slist = clist; slist; slist = slist->next)
5438 for (i = 0; i < n; i++)
5439 if (slist->data == (gpointer) ag_entry[i].closure)
5441 gboolean is_removed = gtk_accel_group_disconnect (accel_group, slist->data);
5443 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
5445 g_list_free (clist);
5450 g_list_free (clist);
5452 g_warning (G_STRLOC ": no accelerator (%u,%u) installed in accel group (%p) for %s (%p)",
5453 accel_key, accel_mods, accel_group,
5454 G_OBJECT_TYPE_NAME (widget), widget);
5460 * gtk_widget_list_accel_closures:
5461 * @widget: widget to list accelerator closures for
5463 * Lists the closures used by @widget for accelerator group connections
5464 * with gtk_accel_group_connect_by_path() or gtk_accel_group_connect().
5465 * The closures can be used to monitor accelerator changes on @widget,
5466 * by connecting to the @GtkAccelGroup::accel-changed signal of the
5467 * #GtkAccelGroup of a closure which can be found out with
5468 * gtk_accel_group_from_accel_closure().
5470 * Return value: (transfer container) (element-type GClosure):
5471 * a newly allocated #GList of closures
5474 gtk_widget_list_accel_closures (GtkWidget *widget)
5477 GList *clist = NULL;
5479 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5481 for (slist = g_object_get_qdata (G_OBJECT (widget), quark_accel_closures); slist; slist = slist->next)
5482 if (gtk_accel_group_from_accel_closure (slist->data))
5483 clist = g_list_prepend (clist, slist->data);
5489 GtkAccelGroup *accel_group;
5494 destroy_accel_path (gpointer data)
5496 AccelPath *apath = data;
5498 gtk_accel_group_disconnect (apath->accel_group, apath->closure);
5500 /* closures_destroy takes care of unrefing the closure */
5501 g_object_unref (apath->accel_group);
5503 g_slice_free (AccelPath, apath);
5508 * gtk_widget_set_accel_path:
5509 * @widget: a #GtkWidget
5510 * @accel_path: (allow-none): path used to look up the accelerator
5511 * @accel_group: (allow-none): a #GtkAccelGroup.
5513 * Given an accelerator group, @accel_group, and an accelerator path,
5514 * @accel_path, sets up an accelerator in @accel_group so whenever the
5515 * key binding that is defined for @accel_path is pressed, @widget
5516 * will be activated. This removes any accelerators (for any
5517 * accelerator group) installed by previous calls to
5518 * gtk_widget_set_accel_path(). Associating accelerators with
5519 * paths allows them to be modified by the user and the modifications
5520 * to be saved for future use. (See gtk_accel_map_save().)
5522 * This function is a low level function that would most likely
5523 * be used by a menu creation system like #GtkUIManager. If you
5524 * use #GtkUIManager, setting up accelerator paths will be done
5527 * Even when you you aren't using #GtkUIManager, if you only want to
5528 * set up accelerators on menu items gtk_menu_item_set_accel_path()
5529 * provides a somewhat more convenient interface.
5531 * Note that @accel_path string will be stored in a #GQuark. Therefore, if you
5532 * pass a static string, you can save some memory by interning it first with
5533 * g_intern_static_string().
5536 gtk_widget_set_accel_path (GtkWidget *widget,
5537 const gchar *accel_path,
5538 GtkAccelGroup *accel_group)
5542 g_return_if_fail (GTK_IS_WIDGET (widget));
5543 g_return_if_fail (GTK_WIDGET_GET_CLASS (widget)->activate_signal != 0);
5547 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
5548 g_return_if_fail (_gtk_accel_path_is_valid (accel_path));
5550 gtk_accel_map_add_entry (accel_path, 0, 0);
5551 apath = g_slice_new (AccelPath);
5552 apath->accel_group = g_object_ref (accel_group);
5553 apath->path_quark = g_quark_from_string (accel_path);
5554 apath->closure = widget_new_accel_closure (widget, GTK_WIDGET_GET_CLASS (widget)->activate_signal);
5559 /* also removes possible old settings */
5560 g_object_set_qdata_full (G_OBJECT (widget), quark_accel_path, apath, destroy_accel_path);
5563 gtk_accel_group_connect_by_path (apath->accel_group, g_quark_to_string (apath->path_quark), apath->closure);
5565 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
5569 _gtk_widget_get_accel_path (GtkWidget *widget,
5574 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5576 apath = g_object_get_qdata (G_OBJECT (widget), quark_accel_path);
5578 *locked = apath ? gtk_accel_group_get_is_locked (apath->accel_group) : TRUE;
5579 return apath ? g_quark_to_string (apath->path_quark) : NULL;
5583 * gtk_widget_mnemonic_activate:
5584 * @widget: a #GtkWidget
5585 * @group_cycling: %TRUE if there are other widgets with the same mnemonic
5587 * Emits the #GtkWidget::mnemonic-activate signal.
5589 * The default handler for this signal activates the @widget if
5590 * @group_cycling is %FALSE, and just grabs the focus if @group_cycling
5593 * Returns: %TRUE if the signal has been handled
5596 gtk_widget_mnemonic_activate (GtkWidget *widget,
5597 gboolean group_cycling)
5601 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5603 group_cycling = group_cycling != FALSE;
5604 if (!gtk_widget_is_sensitive (widget))
5607 g_signal_emit (widget,
5608 widget_signals[MNEMONIC_ACTIVATE],
5616 gtk_widget_real_mnemonic_activate (GtkWidget *widget,
5617 gboolean group_cycling)
5619 if (!group_cycling && GTK_WIDGET_GET_CLASS (widget)->activate_signal)
5620 gtk_widget_activate (widget);
5621 else if (gtk_widget_get_can_focus (widget))
5622 gtk_widget_grab_focus (widget);
5625 g_warning ("widget `%s' isn't suitable for mnemonic activation",
5626 G_OBJECT_TYPE_NAME (widget));
5627 gtk_widget_error_bell (widget);
5632 static const cairo_user_data_key_t event_key;
5635 _gtk_cairo_get_event (cairo_t *cr)
5637 g_return_val_if_fail (cr != NULL, NULL);
5639 return cairo_get_user_data (cr, &event_key);
5643 gtk_cairo_set_event (cairo_t *cr,
5644 GdkEventExpose *event)
5646 cairo_set_user_data (cr, &event_key, event, NULL);
5650 * gtk_cairo_should_draw_window:
5651 * @cr: a cairo context
5652 * @window: the window to check. @window may not be an input-only
5655 * This function is supposed to be called in #GtkWidget::draw
5656 * implementations for widgets that support multiple windows.
5657 * @cr must be untransformed from invoking of the draw function.
5658 * This function will return %TRUE if the contents of the given
5659 * @window are supposed to be drawn and %FALSE otherwise. Note
5660 * that when the drawing was not initiated by the windowing
5661 * system this function will return %TRUE for all windows, so
5662 * you need to draw the bottommost window first. Also, do not
5663 * use "else if" statements to check which window should be drawn.
5665 * Returns: %TRUE if @window should be drawn
5670 gtk_cairo_should_draw_window (cairo_t *cr,
5673 GdkEventExpose *event;
5675 g_return_val_if_fail (cr != NULL, FALSE);
5676 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
5678 event = _gtk_cairo_get_event (cr);
5680 return event == NULL ||
5681 event->window == window;
5685 gtk_widget_get_clip_draw (GtkWidget *widget)
5687 /* labels are not clipped, because clipping them would cause
5688 * mnemonics to not appear on characters that go beyond the
5690 * https://bugzilla.gnome.org/show_bug.cgi?id=648570
5692 if (GTK_IS_LABEL (widget))
5698 /* code shared by gtk_container_propagate_draw() and
5702 _gtk_widget_draw_internal (GtkWidget *widget,
5704 gboolean clip_to_size)
5706 GtkStyleContext *context;
5708 if (!gtk_widget_is_drawable (widget))
5711 clip_to_size &= gtk_widget_get_clip_draw (widget);
5715 cairo_rectangle (cr,
5717 widget->priv->allocation.width,
5718 widget->priv->allocation.height);
5722 if (gdk_cairo_get_clip_rectangle (cr, NULL))
5726 g_signal_emit (widget, widget_signals[DRAW],
5730 if (cairo_status (cr) &&
5731 _gtk_cairo_get_event (cr))
5733 /* We check the event so we only warn about internal GTK calls.
5734 * Errors might come from PDF streams having write failures and
5735 * we don't want to spam stderr in that case.
5736 * We do want to catch errors from
5738 g_warning ("drawing failure for widget `%s': %s",
5739 G_OBJECT_TYPE_NAME (widget),
5740 cairo_status_to_string (cairo_status (cr)));
5744 context = gtk_widget_get_style_context (widget);
5745 _gtk_style_context_coalesce_animation_areas (context, widget);
5750 * @widget: the widget to draw. It must be drawable (see
5751 * gtk_widget_is_drawable()) and a size must have been allocated.
5752 * @cr: a cairo context to draw to
5754 * Draws @widget to @cr. The top left corner of the widget will be
5755 * drawn to the currently set origin point of @cr.
5757 * You should pass a cairo context as @cr argument that is in an
5758 * original state. Otherwise the resulting drawing is undefined. For
5759 * example changing the operator using cairo_set_operator() or the
5760 * line width using cairo_set_line_width() might have unwanted side
5762 * You may however change the context's transform matrix - like with
5763 * cairo_scale(), cairo_translate() or cairo_set_matrix() and clip
5764 * region with cairo_clip() prior to calling this function. Also, it
5765 * is fine to modify the context with cairo_save() and
5766 * cairo_push_group() prior to calling this function.
5768 * <note><para>Special purpose widgets may contain special code for
5769 * rendering to the screen and might appear differently on screen
5770 * and when rendered using gtk_widget_draw().</para></note>
5775 gtk_widget_draw (GtkWidget *widget,
5778 GdkEventExpose *tmp_event;
5780 g_return_if_fail (GTK_IS_WIDGET (widget));
5781 g_return_if_fail (!widget->priv->alloc_needed);
5782 g_return_if_fail (cr != NULL);
5785 /* We have to reset the event here so that draw functions can call
5786 * gtk_widget_draw() on random other widgets and get the desired
5787 * effect: Drawing all contents, not just the current window.
5789 tmp_event = _gtk_cairo_get_event (cr);
5790 gtk_cairo_set_event (cr, NULL);
5792 _gtk_widget_draw_internal (widget, cr, TRUE);
5794 gtk_cairo_set_event (cr, tmp_event);
5799 gtk_widget_real_key_press_event (GtkWidget *widget,
5802 return gtk_bindings_activate_event (G_OBJECT (widget), event);
5806 gtk_widget_real_key_release_event (GtkWidget *widget,
5809 return gtk_bindings_activate_event (G_OBJECT (widget), event);
5813 gtk_widget_real_focus_in_event (GtkWidget *widget,
5814 GdkEventFocus *event)
5816 gtk_widget_queue_shallow_draw (widget);
5822 gtk_widget_real_focus_out_event (GtkWidget *widget,
5823 GdkEventFocus *event)
5825 gtk_widget_queue_shallow_draw (widget);
5830 #define WIDGET_REALIZED_FOR_EVENT(widget, event) \
5831 (event->type == GDK_FOCUS_CHANGE || gtk_widget_get_realized(widget))
5835 * @widget: a #GtkWidget
5836 * @event: a #GdkEvent
5838 * Rarely-used function. This function is used to emit
5839 * the event signals on a widget (those signals should never
5840 * be emitted without using this function to do so).
5841 * If you want to synthesize an event though, don't use this function;
5842 * instead, use gtk_main_do_event() so the event will behave as if
5843 * it were in the event queue. Don't synthesize expose events; instead,
5844 * use gdk_window_invalidate_rect() to invalidate a region of the
5847 * Return value: return from the event signal emission (%TRUE if
5848 * the event was handled)
5851 gtk_widget_event (GtkWidget *widget,
5854 g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
5855 g_return_val_if_fail (WIDGET_REALIZED_FOR_EVENT (widget, event), TRUE);
5857 if (event->type == GDK_EXPOSE)
5859 g_warning ("Events of type GDK_EXPOSE cannot be synthesized. To get "
5860 "the same effect, call gdk_window_invalidate_rect/region(), "
5861 "followed by gdk_window_process_updates().");
5865 return gtk_widget_event_internal (widget, event);
5868 /* Returns TRUE if a translation should be done */
5870 _gtk_widget_get_translation_to_window (GtkWidget *widget,
5875 GdkWindow *w, *widget_window;
5877 if (!gtk_widget_get_has_window (widget))
5879 *x = -widget->priv->allocation.x;
5880 *y = -widget->priv->allocation.y;
5888 widget_window = gtk_widget_get_window (widget);
5890 for (w = window; w && w != widget_window; w = gdk_window_get_parent (w))
5893 gdk_window_get_position (w, &wx, &wy);
5910 * gtk_cairo_transform_to_window:
5911 * @cr: the cairo context to transform
5912 * @widget: the widget the context is currently centered for
5913 * @window: the window to transform the context to
5915 * Transforms the given cairo context @cr that from @widget-relative
5916 * coordinates to @window-relative coordinates.
5917 * If the @widget's window is not an ancestor of @window, no
5918 * modification will be applied.
5920 * This is the inverse to the transformation GTK applies when
5921 * preparing an expose event to be emitted with the #GtkWidget::draw
5922 * signal. It is intended to help porting multiwindow widgets from
5923 * GTK+ 2 to the rendering architecture of GTK+ 3.
5928 gtk_cairo_transform_to_window (cairo_t *cr,
5934 g_return_if_fail (cr != NULL);
5935 g_return_if_fail (GTK_IS_WIDGET (widget));
5936 g_return_if_fail (GDK_IS_WINDOW (window));
5938 if (_gtk_widget_get_translation_to_window (widget, window, &x, &y))
5939 cairo_translate (cr, x, y);
5943 * gtk_widget_send_expose:
5944 * @widget: a #GtkWidget
5945 * @event: a expose #GdkEvent
5947 * Very rarely-used function. This function is used to emit
5948 * an expose event on a widget. This function is not normally used
5949 * directly. The only time it is used is when propagating an expose
5950 * event to a child %NO_WINDOW widget, and that is normally done
5951 * using gtk_container_propagate_draw().
5953 * If you want to force an area of a window to be redrawn,
5954 * use gdk_window_invalidate_rect() or gdk_window_invalidate_region().
5955 * To cause the redraw to be done immediately, follow that call
5956 * with a call to gdk_window_process_updates().
5958 * Return value: return from the event signal emission (%TRUE if
5959 * the event was handled)
5962 gtk_widget_send_expose (GtkWidget *widget,
5965 gboolean result = FALSE;
5970 g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
5971 g_return_val_if_fail (gtk_widget_get_realized (widget), TRUE);
5972 g_return_val_if_fail (event != NULL, TRUE);
5973 g_return_val_if_fail (event->type == GDK_EXPOSE, TRUE);
5975 cr = gdk_cairo_create (event->expose.window);
5976 gtk_cairo_set_event (cr, &event->expose);
5978 gdk_cairo_region (cr, event->expose.region);
5981 do_clip = _gtk_widget_get_translation_to_window (widget,
5982 event->expose.window,
5984 cairo_translate (cr, -x, -y);
5986 _gtk_widget_draw_internal (widget, cr, do_clip);
5988 /* unset here, so if someone keeps a reference to cr we
5989 * don't leak the window. */
5990 gtk_cairo_set_event (cr, NULL);
5997 event_window_is_still_viewable (GdkEvent *event)
5999 /* Check that we think the event's window is viewable before
6000 * delivering the event, to prevent suprises. We do this here
6001 * at the last moment, since the event may have been queued
6002 * up behind other events, held over a recursive main loop, etc.
6004 switch (event->type)
6007 case GDK_MOTION_NOTIFY:
6008 case GDK_BUTTON_PRESS:
6009 case GDK_2BUTTON_PRESS:
6010 case GDK_3BUTTON_PRESS:
6012 case GDK_ENTER_NOTIFY:
6013 case GDK_PROXIMITY_IN:
6015 return event->any.window && gdk_window_is_viewable (event->any.window);
6018 /* The following events are the second half of paired events;
6019 * we always deliver them to deal with widgets that clean up
6020 * on the second half.
6022 case GDK_BUTTON_RELEASE:
6023 case GDK_KEY_RELEASE:
6024 case GDK_LEAVE_NOTIFY:
6025 case GDK_PROXIMITY_OUT:
6029 /* Remaining events would make sense on an not-viewable window,
6030 * or don't have an associated window.
6037 gtk_widget_event_internal (GtkWidget *widget,
6040 gboolean return_val = FALSE;
6042 /* We check only once for is-still-visible; if someone
6043 * hides the window in on of the signals on the widget,
6044 * they are responsible for returning TRUE to terminate
6047 if (!event_window_is_still_viewable (event))
6050 g_object_ref (widget);
6052 g_signal_emit (widget, widget_signals[EVENT], 0, event, &return_val);
6053 return_val |= !WIDGET_REALIZED_FOR_EVENT (widget, event);
6058 switch (event->type)
6064 case GDK_BUTTON_PRESS:
6065 case GDK_2BUTTON_PRESS:
6066 case GDK_3BUTTON_PRESS:
6067 signal_num = BUTTON_PRESS_EVENT;
6070 signal_num = SCROLL_EVENT;
6072 case GDK_BUTTON_RELEASE:
6073 signal_num = BUTTON_RELEASE_EVENT;
6075 case GDK_MOTION_NOTIFY:
6076 signal_num = MOTION_NOTIFY_EVENT;
6079 signal_num = DELETE_EVENT;
6082 signal_num = DESTROY_EVENT;
6083 _gtk_tooltip_hide (widget);
6086 signal_num = KEY_PRESS_EVENT;
6088 case GDK_KEY_RELEASE:
6089 signal_num = KEY_RELEASE_EVENT;
6091 case GDK_ENTER_NOTIFY:
6092 signal_num = ENTER_NOTIFY_EVENT;
6094 case GDK_LEAVE_NOTIFY:
6095 signal_num = LEAVE_NOTIFY_EVENT;
6097 case GDK_FOCUS_CHANGE:
6098 signal_num = event->focus_change.in ? FOCUS_IN_EVENT : FOCUS_OUT_EVENT;
6099 if (event->focus_change.in)
6100 _gtk_tooltip_focus_in (widget);
6102 _gtk_tooltip_focus_out (widget);
6105 signal_num = CONFIGURE_EVENT;
6108 signal_num = MAP_EVENT;
6111 signal_num = UNMAP_EVENT;
6113 case GDK_WINDOW_STATE:
6114 signal_num = WINDOW_STATE_EVENT;
6116 case GDK_PROPERTY_NOTIFY:
6117 signal_num = PROPERTY_NOTIFY_EVENT;
6119 case GDK_SELECTION_CLEAR:
6120 signal_num = SELECTION_CLEAR_EVENT;
6122 case GDK_SELECTION_REQUEST:
6123 signal_num = SELECTION_REQUEST_EVENT;
6125 case GDK_SELECTION_NOTIFY:
6126 signal_num = SELECTION_NOTIFY_EVENT;
6128 case GDK_PROXIMITY_IN:
6129 signal_num = PROXIMITY_IN_EVENT;
6131 case GDK_PROXIMITY_OUT:
6132 signal_num = PROXIMITY_OUT_EVENT;
6134 case GDK_VISIBILITY_NOTIFY:
6135 signal_num = VISIBILITY_NOTIFY_EVENT;
6137 case GDK_GRAB_BROKEN:
6138 signal_num = GRAB_BROKEN_EVENT;
6141 signal_num = DAMAGE_EVENT;
6144 g_warning ("gtk_widget_event(): unhandled event type: %d", event->type);
6148 if (signal_num != -1)
6149 g_signal_emit (widget, widget_signals[signal_num], 0, event, &return_val);
6151 if (WIDGET_REALIZED_FOR_EVENT (widget, event))
6152 g_signal_emit (widget, widget_signals[EVENT_AFTER], 0, event);
6156 g_object_unref (widget);
6162 * gtk_widget_activate:
6163 * @widget: a #GtkWidget that's activatable
6165 * For widgets that can be "activated" (buttons, menu items, etc.)
6166 * this function activates them. Activation is what happens when you
6167 * press Enter on a widget during key navigation. If @widget isn't
6168 * activatable, the function returns %FALSE.
6170 * Return value: %TRUE if the widget was activatable
6173 gtk_widget_activate (GtkWidget *widget)
6175 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6177 if (WIDGET_CLASS (widget)->activate_signal)
6179 /* FIXME: we should eventually check the signals signature here */
6180 g_signal_emit (widget, WIDGET_CLASS (widget)->activate_signal, 0);
6189 gtk_widget_reparent_subwindows (GtkWidget *widget,
6190 GdkWindow *new_window)
6192 GtkWidgetPrivate *priv = widget->priv;
6194 if (!gtk_widget_get_has_window (widget))
6196 GList *children = gdk_window_get_children (priv->window);
6199 for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
6201 GdkWindow *window = tmp_list->data;
6204 gdk_window_get_user_data (window, &child);
6205 while (child && child != widget)
6206 child = ((GtkWidget*) child)->priv->parent;
6209 gdk_window_reparent (window, new_window, 0, 0);
6212 g_list_free (children);
6217 GList *tmp_list, *children;
6219 parent = gdk_window_get_parent (priv->window);
6222 gdk_window_reparent (priv->window, new_window, 0, 0);
6225 children = gdk_window_get_children (parent);
6227 for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
6229 GdkWindow *window = tmp_list->data;
6232 gdk_window_get_user_data (window, &child);
6234 if (child == widget)
6235 gdk_window_reparent (window, new_window, 0, 0);
6238 g_list_free (children);
6244 gtk_widget_reparent_fixup_child (GtkWidget *widget,
6245 gpointer client_data)
6247 GtkWidgetPrivate *priv = widget->priv;
6249 g_assert (client_data != NULL);
6251 if (!gtk_widget_get_has_window (widget))
6254 g_object_unref (priv->window);
6255 priv->window = (GdkWindow*) client_data;
6257 g_object_ref (priv->window);
6259 if (GTK_IS_CONTAINER (widget))
6260 gtk_container_forall (GTK_CONTAINER (widget),
6261 gtk_widget_reparent_fixup_child,
6267 * gtk_widget_reparent:
6268 * @widget: a #GtkWidget
6269 * @new_parent: a #GtkContainer to move the widget into
6271 * Moves a widget from one #GtkContainer to another, handling reference
6272 * count issues to avoid destroying the widget.
6275 gtk_widget_reparent (GtkWidget *widget,
6276 GtkWidget *new_parent)
6278 GtkWidgetPrivate *priv;
6280 g_return_if_fail (GTK_IS_WIDGET (widget));
6281 g_return_if_fail (GTK_IS_CONTAINER (new_parent));
6282 priv = widget->priv;
6283 g_return_if_fail (priv->parent != NULL);
6285 if (priv->parent != new_parent)
6287 /* First try to see if we can get away without unrealizing
6288 * the widget as we reparent it. if so we set a flag so
6289 * that gtk_widget_unparent doesn't unrealize widget
6291 if (gtk_widget_get_realized (widget) && gtk_widget_get_realized (new_parent))
6292 priv->in_reparent = TRUE;
6294 g_object_ref (widget);
6295 gtk_container_remove (GTK_CONTAINER (priv->parent), widget);
6296 gtk_container_add (GTK_CONTAINER (new_parent), widget);
6297 g_object_unref (widget);
6299 if (priv->in_reparent)
6301 priv->in_reparent = FALSE;
6303 gtk_widget_reparent_subwindows (widget, gtk_widget_get_parent_window (widget));
6304 gtk_widget_reparent_fixup_child (widget,
6305 gtk_widget_get_parent_window (widget));
6308 g_object_notify (G_OBJECT (widget), "parent");
6313 * gtk_widget_intersect:
6314 * @widget: a #GtkWidget
6315 * @area: a rectangle
6316 * @intersection: rectangle to store intersection of @widget and @area
6318 * Computes the intersection of a @widget's area and @area, storing
6319 * the intersection in @intersection, and returns %TRUE if there was
6320 * an intersection. @intersection may be %NULL if you're only
6321 * interested in whether there was an intersection.
6323 * Return value: %TRUE if there was an intersection
6326 gtk_widget_intersect (GtkWidget *widget,
6327 const GdkRectangle *area,
6328 GdkRectangle *intersection)
6330 GtkWidgetPrivate *priv;
6335 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6336 g_return_val_if_fail (area != NULL, FALSE);
6338 priv = widget->priv;
6341 dest = intersection;
6345 return_val = gdk_rectangle_intersect (&priv->allocation, area, dest);
6347 if (return_val && intersection && gtk_widget_get_has_window (widget))
6349 intersection->x -= priv->allocation.x;
6350 intersection->y -= priv->allocation.y;
6357 * gtk_widget_region_intersect:
6358 * @widget: a #GtkWidget
6359 * @region: a #cairo_region_t, in the same coordinate system as
6360 * @widget->allocation. That is, relative to @widget->window
6361 * for %NO_WINDOW widgets; relative to the parent window
6362 * of @widget->window for widgets with their own window.
6364 * Computes the intersection of a @widget's area and @region, returning
6365 * the intersection. The result may be empty, use cairo_region_is_empty() to
6368 * Returns: A newly allocated region holding the intersection of @widget
6369 * and @region. The coordinates of the return value are relative to
6370 * @widget->window for %NO_WINDOW widgets, and relative to the parent
6371 * window of @widget->window for widgets with their own window.
6374 gtk_widget_region_intersect (GtkWidget *widget,
6375 const cairo_region_t *region)
6378 cairo_region_t *dest;
6380 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6381 g_return_val_if_fail (region != NULL, NULL);
6383 gtk_widget_get_allocation (widget, &rect);
6385 dest = cairo_region_create_rectangle (&rect);
6387 cairo_region_intersect (dest, region);
6393 * _gtk_widget_grab_notify:
6394 * @widget: a #GtkWidget
6395 * @was_grabbed: whether a grab is now in effect
6397 * Emits the #GtkWidget::grab-notify signal on @widget.
6402 _gtk_widget_grab_notify (GtkWidget *widget,
6403 gboolean was_grabbed)
6405 g_signal_emit (widget, widget_signals[GRAB_NOTIFY], 0, was_grabbed);
6409 * gtk_widget_grab_focus:
6410 * @widget: a #GtkWidget
6412 * Causes @widget to have the keyboard focus for the #GtkWindow it's
6413 * inside. @widget must be a focusable widget, such as a #GtkEntry;
6414 * something like #GtkFrame won't work.
6416 * More precisely, it must have the %GTK_CAN_FOCUS flag set. Use
6417 * gtk_widget_set_can_focus() to modify that flag.
6419 * The widget also needs to be realized and mapped. This is indicated by the
6420 * related signals. Grabbing the focus immediately after creating the widget
6421 * will likely fail and cause critical warnings.
6424 gtk_widget_grab_focus (GtkWidget *widget)
6426 g_return_if_fail (GTK_IS_WIDGET (widget));
6428 if (!gtk_widget_is_sensitive (widget))
6431 g_object_ref (widget);
6432 g_signal_emit (widget, widget_signals[GRAB_FOCUS], 0);
6433 g_object_notify (G_OBJECT (widget), "has-focus");
6434 g_object_unref (widget);
6438 reset_focus_recurse (GtkWidget *widget,
6441 if (GTK_IS_CONTAINER (widget))
6443 GtkContainer *container;
6445 container = GTK_CONTAINER (widget);
6446 gtk_container_set_focus_child (container, NULL);
6448 gtk_container_foreach (container,
6449 reset_focus_recurse,
6455 gtk_widget_real_grab_focus (GtkWidget *focus_widget)
6457 if (gtk_widget_get_can_focus (focus_widget))
6459 GtkWidget *toplevel;
6462 /* clear the current focus setting, break if the current widget
6463 * is the focus widget's parent, since containers above that will
6464 * be set by the next loop.
6466 toplevel = gtk_widget_get_toplevel (focus_widget);
6467 if (gtk_widget_is_toplevel (toplevel) && GTK_IS_WINDOW (toplevel))
6469 widget = gtk_window_get_focus (GTK_WINDOW (toplevel));
6471 if (widget == focus_widget)
6473 /* We call _gtk_window_internal_set_focus() here so that the
6474 * toplevel window can request the focus if necessary.
6475 * This is needed when the toplevel is a GtkPlug
6477 if (!gtk_widget_has_focus (widget))
6478 _gtk_window_internal_set_focus (GTK_WINDOW (toplevel), focus_widget);
6485 GtkWidget *common_ancestor = gtk_widget_common_ancestor (widget, focus_widget);
6487 if (widget != common_ancestor)
6489 while (widget->priv->parent && widget->priv->parent != common_ancestor)
6491 widget = widget->priv->parent;
6492 gtk_container_set_focus_child (GTK_CONTAINER (widget), NULL);
6497 else if (toplevel != focus_widget)
6499 /* gtk_widget_grab_focus() operates on a tree without window...
6500 * actually, this is very questionable behaviour.
6503 gtk_container_foreach (GTK_CONTAINER (toplevel),
6504 reset_focus_recurse,
6508 /* now propagate the new focus up the widget tree and finally
6509 * set it on the window
6511 widget = focus_widget;
6512 while (widget->priv->parent)
6514 gtk_container_set_focus_child (GTK_CONTAINER (widget->priv->parent), widget);
6515 widget = widget->priv->parent;
6517 if (GTK_IS_WINDOW (widget))
6518 _gtk_window_internal_set_focus (GTK_WINDOW (widget), focus_widget);
6523 gtk_widget_real_query_tooltip (GtkWidget *widget,
6526 gboolean keyboard_tip,
6527 GtkTooltip *tooltip)
6529 gchar *tooltip_markup;
6530 gboolean has_tooltip;
6532 tooltip_markup = g_object_get_qdata (G_OBJECT (widget), quark_tooltip_markup);
6533 has_tooltip = GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (widget), quark_has_tooltip));
6535 if (has_tooltip && tooltip_markup)
6537 gtk_tooltip_set_markup (tooltip, tooltip_markup);
6545 gtk_widget_real_state_flags_changed (GtkWidget *widget,
6546 GtkStateFlags old_state)
6548 gtk_widget_update_pango_context (widget);
6552 gtk_widget_real_style_updated (GtkWidget *widget)
6554 GtkWidgetPrivate *priv = widget->priv;
6556 gtk_widget_update_pango_context (widget);
6558 if (priv->style != NULL &&
6559 priv->style != gtk_widget_get_default_style ())
6561 /* Trigger ::style-set for old
6562 * widgets not listening to this
6564 g_signal_emit (widget,
6565 widget_signals[STYLE_SET],
6567 widget->priv->style);
6570 if (widget->priv->context)
6572 if (gtk_widget_get_realized (widget) &&
6573 gtk_widget_get_has_window (widget))
6574 gtk_style_context_set_background (widget->priv->context,
6575 widget->priv->window);
6578 if (widget->priv->anchored)
6579 gtk_widget_queue_resize (widget);
6583 gtk_widget_real_show_help (GtkWidget *widget,
6584 GtkWidgetHelpType help_type)
6586 if (help_type == GTK_WIDGET_HELP_TOOLTIP)
6588 _gtk_tooltip_toggle_keyboard_mode (widget);
6597 gtk_widget_real_focus (GtkWidget *widget,
6598 GtkDirectionType direction)
6600 if (!gtk_widget_get_can_focus (widget))
6603 if (!gtk_widget_is_focus (widget))
6605 gtk_widget_grab_focus (widget);
6613 gtk_widget_real_move_focus (GtkWidget *widget,
6614 GtkDirectionType direction)
6616 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
6618 if (widget != toplevel && GTK_IS_WINDOW (toplevel))
6620 g_signal_emit (toplevel, widget_signals[MOVE_FOCUS], 0,
6626 gtk_widget_real_keynav_failed (GtkWidget *widget,
6627 GtkDirectionType direction)
6629 gboolean cursor_only;
6633 case GTK_DIR_TAB_FORWARD:
6634 case GTK_DIR_TAB_BACKWARD:
6641 g_object_get (gtk_widget_get_settings (widget),
6642 "gtk-keynav-cursor-only", &cursor_only,
6649 gtk_widget_error_bell (widget);
6655 * gtk_widget_set_can_focus:
6656 * @widget: a #GtkWidget
6657 * @can_focus: whether or not @widget can own the input focus.
6659 * Specifies whether @widget can own the input focus. See
6660 * gtk_widget_grab_focus() for actually setting the input focus on a
6666 gtk_widget_set_can_focus (GtkWidget *widget,
6669 g_return_if_fail (GTK_IS_WIDGET (widget));
6671 if (widget->priv->can_focus != can_focus)
6673 widget->priv->can_focus = can_focus;
6675 gtk_widget_queue_resize (widget);
6676 g_object_notify (G_OBJECT (widget), "can-focus");
6681 * gtk_widget_get_can_focus:
6682 * @widget: a #GtkWidget
6684 * Determines whether @widget can own the input focus. See
6685 * gtk_widget_set_can_focus().
6687 * Return value: %TRUE if @widget can own the input focus, %FALSE otherwise
6692 gtk_widget_get_can_focus (GtkWidget *widget)
6694 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6696 return widget->priv->can_focus;
6700 * gtk_widget_has_focus:
6701 * @widget: a #GtkWidget
6703 * Determines if the widget has the global input focus. See
6704 * gtk_widget_is_focus() for the difference between having the global
6705 * input focus, and only having the focus within a toplevel.
6707 * Return value: %TRUE if the widget has the global input focus.
6712 gtk_widget_has_focus (GtkWidget *widget)
6714 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6716 return widget->priv->has_focus;
6720 * gtk_widget_has_visible_focus:
6721 * @widget: a #GtkWidget
6723 * Determines if the widget should show a visible indication that
6724 * it has the global input focus. This is a convenience function for
6725 * use in ::draw handlers that takes into account whether focus
6726 * indication should currently be shown in the toplevel window of
6727 * @widget. See gtk_window_get_focus_visible() for more information
6728 * about focus indication.
6730 * To find out if the widget has the global input focus, use
6731 * gtk_widget_has_focus().
6733 * Return value: %TRUE if the widget should display a 'focus rectangle'
6738 gtk_widget_has_visible_focus (GtkWidget *widget)
6740 gboolean draw_focus;
6742 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6744 if (widget->priv->has_focus)
6746 GtkWidget *toplevel;
6748 toplevel = gtk_widget_get_toplevel (widget);
6750 if (GTK_IS_WINDOW (toplevel))
6751 draw_focus = gtk_window_get_focus_visible (GTK_WINDOW (toplevel));
6762 * gtk_widget_is_focus:
6763 * @widget: a #GtkWidget
6765 * Determines if the widget is the focus widget within its
6766 * toplevel. (This does not mean that the %HAS_FOCUS flag is
6767 * necessarily set; %HAS_FOCUS will only be set if the
6768 * toplevel widget additionally has the global input focus.)
6770 * Return value: %TRUE if the widget is the focus widget.
6773 gtk_widget_is_focus (GtkWidget *widget)
6775 GtkWidget *toplevel;
6777 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6779 toplevel = gtk_widget_get_toplevel (widget);
6781 if (GTK_IS_WINDOW (toplevel))
6782 return widget == gtk_window_get_focus (GTK_WINDOW (toplevel));
6788 * gtk_widget_set_can_default:
6789 * @widget: a #GtkWidget
6790 * @can_default: whether or not @widget can be a default widget.
6792 * Specifies whether @widget can be a default widget. See
6793 * gtk_widget_grab_default() for details about the meaning of
6799 gtk_widget_set_can_default (GtkWidget *widget,
6800 gboolean can_default)
6802 g_return_if_fail (GTK_IS_WIDGET (widget));
6804 if (widget->priv->can_default != can_default)
6806 widget->priv->can_default = can_default;
6808 gtk_widget_queue_resize (widget);
6809 g_object_notify (G_OBJECT (widget), "can-default");
6814 * gtk_widget_get_can_default:
6815 * @widget: a #GtkWidget
6817 * Determines whether @widget can be a default widget. See
6818 * gtk_widget_set_can_default().
6820 * Return value: %TRUE if @widget can be a default widget, %FALSE otherwise
6825 gtk_widget_get_can_default (GtkWidget *widget)
6827 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6829 return widget->priv->can_default;
6833 * gtk_widget_has_default:
6834 * @widget: a #GtkWidget
6836 * Determines whether @widget is the current default widget within its
6837 * toplevel. See gtk_widget_set_can_default().
6839 * Return value: %TRUE if @widget is the current default widget within
6840 * its toplevel, %FALSE otherwise
6845 gtk_widget_has_default (GtkWidget *widget)
6847 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6849 return widget->priv->has_default;
6853 _gtk_widget_set_has_default (GtkWidget *widget,
6854 gboolean has_default)
6856 widget->priv->has_default = has_default;
6860 * gtk_widget_grab_default:
6861 * @widget: a #GtkWidget
6863 * Causes @widget to become the default widget. @widget must have the
6864 * %GTK_CAN_DEFAULT flag set; typically you have to set this flag
6865 * yourself by calling <literal>gtk_widget_set_can_default (@widget,
6866 * %TRUE)</literal>. The default widget is activated when
6867 * the user presses Enter in a window. Default widgets must be
6868 * activatable, that is, gtk_widget_activate() should affect them. Note
6869 * that #GtkEntry widgets require the "activates-default" property
6870 * set to %TRUE before they activate the default widget when Enter
6871 * is pressed and the #GtkEntry is focused.
6874 gtk_widget_grab_default (GtkWidget *widget)
6878 g_return_if_fail (GTK_IS_WIDGET (widget));
6879 g_return_if_fail (gtk_widget_get_can_default (widget));
6881 window = gtk_widget_get_toplevel (widget);
6883 if (window && gtk_widget_is_toplevel (window))
6884 gtk_window_set_default (GTK_WINDOW (window), widget);
6886 g_warning (G_STRLOC ": widget not within a GtkWindow");
6890 * gtk_widget_set_receives_default:
6891 * @widget: a #GtkWidget
6892 * @receives_default: whether or not @widget can be a default widget.
6894 * Specifies whether @widget will be treated as the default widget
6895 * within its toplevel when it has the focus, even if another widget
6898 * See gtk_widget_grab_default() for details about the meaning of
6904 gtk_widget_set_receives_default (GtkWidget *widget,
6905 gboolean receives_default)
6907 g_return_if_fail (GTK_IS_WIDGET (widget));
6909 if (widget->priv->receives_default != receives_default)
6911 widget->priv->receives_default = receives_default;
6913 g_object_notify (G_OBJECT (widget), "receives-default");
6918 * gtk_widget_get_receives_default:
6919 * @widget: a #GtkWidget
6921 * Determines whether @widget is alyways treated as default widget
6922 * withing its toplevel when it has the focus, even if another widget
6925 * See gtk_widget_set_receives_default().
6927 * Return value: %TRUE if @widget acts as default widget when focussed,
6933 gtk_widget_get_receives_default (GtkWidget *widget)
6935 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6937 return widget->priv->receives_default;
6941 * gtk_widget_has_grab:
6942 * @widget: a #GtkWidget
6944 * Determines whether the widget is currently grabbing events, so it
6945 * is the only widget receiving input events (keyboard and mouse).
6947 * See also gtk_grab_add().
6949 * Return value: %TRUE if the widget is in the grab_widgets stack
6954 gtk_widget_has_grab (GtkWidget *widget)
6956 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6958 return widget->priv->has_grab;
6962 _gtk_widget_set_has_grab (GtkWidget *widget,
6965 widget->priv->has_grab = has_grab;
6969 * gtk_widget_device_is_shadowed:
6970 * @widget: a #GtkWidget
6971 * @device: a #GdkDevice
6973 * Returns %TRUE if @device has been shadowed by a GTK+
6974 * device grab on another widget, so it would stop sending
6975 * events to @widget. This may be used in the
6976 * #GtkWidget::grab-notify signal to check for specific
6977 * devices. See gtk_device_grab_add().
6979 * Returns: %TRUE if there is an ongoing grab on @device
6980 * by another #GtkWidget than @widget.
6985 gtk_widget_device_is_shadowed (GtkWidget *widget,
6988 GtkWindowGroup *group;
6989 GtkWidget *grab_widget, *toplevel;
6991 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6992 g_return_val_if_fail (GDK_IS_DEVICE (device), FALSE);
6994 if (!gtk_widget_get_realized (widget))
6997 toplevel = gtk_widget_get_toplevel (widget);
6999 if (GTK_IS_WINDOW (toplevel))
7000 group = gtk_window_get_group (GTK_WINDOW (toplevel));
7002 group = gtk_window_get_group (NULL);
7004 grab_widget = gtk_window_group_get_current_device_grab (group, device);
7006 /* Widget not inside the hierarchy of grab_widget */
7008 widget != grab_widget &&
7009 !gtk_widget_is_ancestor (widget, grab_widget))
7012 grab_widget = gtk_window_group_get_current_grab (group);
7013 if (grab_widget && widget != grab_widget &&
7014 !gtk_widget_is_ancestor (widget, grab_widget))
7021 * gtk_widget_set_name:
7022 * @widget: a #GtkWidget
7023 * @name: name for the widget
7025 * Widgets can be named, which allows you to refer to them from a
7026 * CSS file. You can apply a style to widgets with a particular name
7027 * in the CSS file. See the documentation for the CSS syntax (on the
7028 * same page as the docs for #GtkStyleContext).
7030 * Note that the CSS syntax has certain special characters to delimit
7031 * and represent elements in a selector (period, #, >, *...),
7032 * so using these will make your widget impossible to match by name.
7033 * Any combination of alphanumeric symbols, dashes and underscores will
7037 gtk_widget_set_name (GtkWidget *widget,
7040 GtkWidgetPrivate *priv;
7043 g_return_if_fail (GTK_IS_WIDGET (widget));
7045 priv = widget->priv;
7047 new_name = g_strdup (name);
7048 g_free (priv->name);
7049 priv->name = new_name;
7051 gtk_widget_reset_style (widget);
7053 g_object_notify (G_OBJECT (widget), "name");
7057 * gtk_widget_get_name:
7058 * @widget: a #GtkWidget
7060 * Retrieves the name of a widget. See gtk_widget_set_name() for the
7061 * significance of widget names.
7063 * Return value: name of the widget. This string is owned by GTK+ and
7064 * should not be modified or freed
7067 gtk_widget_get_name (GtkWidget *widget)
7069 GtkWidgetPrivate *priv;
7071 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7073 priv = widget->priv;
7077 return G_OBJECT_TYPE_NAME (widget);
7081 _gtk_widget_update_state_flags (GtkWidget *widget,
7082 GtkStateFlags flags,
7085 GtkWidgetPrivate *priv;
7087 priv = widget->priv;
7089 /* Handle insensitive first, since it is propagated
7090 * differently throughout the widget hierarchy.
7092 if ((priv->state_flags & GTK_STATE_FLAG_INSENSITIVE) && (flags & GTK_STATE_FLAG_INSENSITIVE) && (operation == STATE_CHANGE_UNSET))
7093 gtk_widget_set_sensitive (widget, TRUE);
7094 else if (!(priv->state_flags & GTK_STATE_FLAG_INSENSITIVE) && (flags & GTK_STATE_FLAG_INSENSITIVE) && (operation != STATE_CHANGE_UNSET))
7095 gtk_widget_set_sensitive (widget, FALSE);
7096 else if ((priv->state_flags & GTK_STATE_FLAG_INSENSITIVE) && !(flags & GTK_STATE_FLAG_INSENSITIVE) && (operation == STATE_CHANGE_REPLACE))
7097 gtk_widget_set_sensitive (widget, TRUE);
7099 if (operation != STATE_CHANGE_REPLACE)
7100 flags &= ~(GTK_STATE_FLAG_INSENSITIVE);
7103 operation == STATE_CHANGE_REPLACE)
7108 data.operation = operation;
7110 gtk_widget_propagate_state (widget, &data);
7112 gtk_widget_queue_resize (widget);
7117 * gtk_widget_set_state_flags:
7118 * @widget: a #GtkWidget
7119 * @flags: State flags to turn on
7120 * @clear: Whether to clear state before turning on @flags
7122 * This function is for use in widget implementations. Turns on flag
7123 * values in the current widget state (insensitive, prelighted, etc.).
7125 * It is worth mentioning that any other state than %GTK_STATE_FLAG_INSENSITIVE,
7126 * will be propagated down to all non-internal children if @widget is a
7127 * #GtkContainer, while %GTK_STATE_FLAG_INSENSITIVE itself will be propagated
7128 * down to all #GtkContainer children by different means than turning on the
7129 * state flag down the hierarchy, both gtk_widget_get_state_flags() and
7130 * gtk_widget_is_sensitive() will make use of these.
7135 gtk_widget_set_state_flags (GtkWidget *widget,
7136 GtkStateFlags flags,
7139 g_return_if_fail (GTK_IS_WIDGET (widget));
7141 if ((!clear && (widget->priv->state_flags & flags) == flags) ||
7142 (clear && widget->priv->state_flags == flags))
7146 _gtk_widget_update_state_flags (widget, flags, STATE_CHANGE_REPLACE);
7148 _gtk_widget_update_state_flags (widget, flags, STATE_CHANGE_SET);
7152 * gtk_widget_unset_state_flags:
7153 * @widget: a #GtkWidget
7154 * @flags: State flags to turn off
7156 * This function is for use in widget implementations. Turns off flag
7157 * values for the current widget state (insensitive, prelighted, etc.).
7158 * See gtk_widget_set_state_flags().
7163 gtk_widget_unset_state_flags (GtkWidget *widget,
7164 GtkStateFlags flags)
7166 g_return_if_fail (GTK_IS_WIDGET (widget));
7168 if ((widget->priv->state_flags & flags) == 0)
7171 _gtk_widget_update_state_flags (widget, flags, STATE_CHANGE_UNSET);
7175 * gtk_widget_get_state_flags:
7176 * @widget: a #GtkWidget
7178 * Returns the widget state as a flag set. It is worth mentioning
7179 * that the effective %GTK_STATE_FLAG_INSENSITIVE state will be
7180 * returned, that is, also based on parent insensitivity, even if
7181 * @widget itself is sensitive.
7183 * Returns: The state flags for widget
7188 gtk_widget_get_state_flags (GtkWidget *widget)
7190 GtkStateFlags flags;
7192 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
7194 flags = widget->priv->state_flags;
7196 if (gtk_widget_has_focus (widget))
7197 flags |= GTK_STATE_FLAG_FOCUSED;
7203 * gtk_widget_set_state:
7204 * @widget: a #GtkWidget
7205 * @state: new state for @widget
7207 * This function is for use in widget implementations. Sets the state
7208 * of a widget (insensitive, prelighted, etc.) Usually you should set
7209 * the state using wrapper functions such as gtk_widget_set_sensitive().
7211 * Deprecated: 3.0. Use gtk_widget_set_state_flags() instead.
7214 gtk_widget_set_state (GtkWidget *widget,
7217 GtkStateFlags flags;
7219 if (state == gtk_widget_get_state (widget))
7224 case GTK_STATE_ACTIVE:
7225 flags = GTK_STATE_FLAG_ACTIVE;
7227 case GTK_STATE_PRELIGHT:
7228 flags = GTK_STATE_FLAG_PRELIGHT;
7230 case GTK_STATE_SELECTED:
7231 flags = GTK_STATE_FLAG_SELECTED;
7233 case GTK_STATE_INSENSITIVE:
7234 flags = GTK_STATE_FLAG_INSENSITIVE;
7236 case GTK_STATE_INCONSISTENT:
7237 flags = GTK_STATE_FLAG_INCONSISTENT;
7239 case GTK_STATE_FOCUSED:
7240 flags = GTK_STATE_FLAG_FOCUSED;
7242 case GTK_STATE_NORMAL:
7248 _gtk_widget_update_state_flags (widget, flags, STATE_CHANGE_REPLACE);
7252 * gtk_widget_get_state:
7253 * @widget: a #GtkWidget
7255 * Returns the widget's state. See gtk_widget_set_state().
7257 * Returns: the state of @widget.
7261 * Deprecated: 3.0. Use gtk_widget_get_state_flags() instead.
7264 gtk_widget_get_state (GtkWidget *widget)
7266 GtkStateFlags flags;
7268 g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_STATE_NORMAL);
7270 flags = gtk_widget_get_state_flags (widget);
7272 if (flags & GTK_STATE_FLAG_INSENSITIVE)
7273 return GTK_STATE_INSENSITIVE;
7274 else if (flags & GTK_STATE_FLAG_ACTIVE)
7275 return GTK_STATE_ACTIVE;
7276 else if (flags & GTK_STATE_FLAG_SELECTED)
7277 return GTK_STATE_SELECTED;
7278 else if (flags & GTK_STATE_FLAG_PRELIGHT)
7279 return GTK_STATE_PRELIGHT;
7281 return GTK_STATE_NORMAL;
7285 * gtk_widget_set_visible:
7286 * @widget: a #GtkWidget
7287 * @visible: whether the widget should be shown or not
7289 * Sets the visibility state of @widget. Note that setting this to
7290 * %TRUE doesn't mean the widget is actually viewable, see
7291 * gtk_widget_get_visible().
7293 * This function simply calls gtk_widget_show() or gtk_widget_hide()
7294 * but is nicer to use when the visibility of the widget depends on
7300 gtk_widget_set_visible (GtkWidget *widget,
7303 g_return_if_fail (GTK_IS_WIDGET (widget));
7305 if (visible != gtk_widget_get_visible (widget))
7308 gtk_widget_show (widget);
7310 gtk_widget_hide (widget);
7315 _gtk_widget_set_visible_flag (GtkWidget *widget,
7318 widget->priv->visible = visible;
7322 * gtk_widget_get_visible:
7323 * @widget: a #GtkWidget
7325 * Determines whether the widget is visible. Note that this doesn't
7326 * take into account whether the widget's parent is also visible
7327 * or the widget is obscured in any way.
7329 * See gtk_widget_set_visible().
7331 * Return value: %TRUE if the widget is visible
7336 gtk_widget_get_visible (GtkWidget *widget)
7338 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7340 return widget->priv->visible;
7344 * gtk_widget_set_has_window:
7345 * @widget: a #GtkWidget
7346 * @has_window: whether or not @widget has a window.
7348 * Specifies whether @widget has a #GdkWindow of its own. Note that
7349 * all realized widgets have a non-%NULL "window" pointer
7350 * (gtk_widget_get_window() never returns a %NULL window when a widget
7351 * is realized), but for many of them it's actually the #GdkWindow of
7352 * one of its parent widgets. Widgets that do not create a %window for
7353 * themselves in #GtkWidget::realize must announce this by
7354 * calling this function with @has_window = %FALSE.
7356 * This function should only be called by widget implementations,
7357 * and they should call it in their init() function.
7362 gtk_widget_set_has_window (GtkWidget *widget,
7363 gboolean has_window)
7365 g_return_if_fail (GTK_IS_WIDGET (widget));
7367 widget->priv->no_window = !has_window;
7371 * gtk_widget_get_has_window:
7372 * @widget: a #GtkWidget
7374 * Determines whether @widget has a #GdkWindow of its own. See
7375 * gtk_widget_set_has_window().
7377 * Return value: %TRUE if @widget has a window, %FALSE otherwise
7382 gtk_widget_get_has_window (GtkWidget *widget)
7384 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7386 return ! widget->priv->no_window;
7390 * gtk_widget_is_toplevel:
7391 * @widget: a #GtkWidget
7393 * Determines whether @widget is a toplevel widget.
7395 * Currently only #GtkWindow and #GtkInvisible (and out-of-process
7396 * #GtkPlugs) are toplevel widgets. Toplevel widgets have no parent
7399 * Return value: %TRUE if @widget is a toplevel, %FALSE otherwise
7404 gtk_widget_is_toplevel (GtkWidget *widget)
7406 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7408 return widget->priv->toplevel;
7412 _gtk_widget_set_is_toplevel (GtkWidget *widget,
7413 gboolean is_toplevel)
7415 widget->priv->toplevel = is_toplevel;
7419 * gtk_widget_is_drawable:
7420 * @widget: a #GtkWidget
7422 * Determines whether @widget can be drawn to. A widget can be drawn
7423 * to if it is mapped and visible.
7425 * Return value: %TRUE if @widget is drawable, %FALSE otherwise
7430 gtk_widget_is_drawable (GtkWidget *widget)
7432 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7434 return (gtk_widget_get_visible (widget) &&
7435 gtk_widget_get_mapped (widget));
7439 * gtk_widget_get_realized:
7440 * @widget: a #GtkWidget
7442 * Determines whether @widget is realized.
7444 * Return value: %TRUE if @widget is realized, %FALSE otherwise
7449 gtk_widget_get_realized (GtkWidget *widget)
7451 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7453 return widget->priv->realized;
7457 * gtk_widget_set_realized:
7458 * @widget: a #GtkWidget
7459 * @realized: %TRUE to mark the widget as realized
7461 * Marks the widget as being realized.
7463 * This function should only ever be called in a derived widget's
7464 * "realize" or "unrealize" implementation.
7469 gtk_widget_set_realized (GtkWidget *widget,
7472 g_return_if_fail (GTK_IS_WIDGET (widget));
7474 widget->priv->realized = realized;
7478 * gtk_widget_get_mapped:
7479 * @widget: a #GtkWidget
7481 * Whether the widget is mapped.
7483 * Return value: %TRUE if the widget is mapped, %FALSE otherwise.
7488 gtk_widget_get_mapped (GtkWidget *widget)
7490 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7492 return widget->priv->mapped;
7496 * gtk_widget_set_mapped:
7497 * @widget: a #GtkWidget
7498 * @mapped: %TRUE to mark the widget as mapped
7500 * Marks the widget as being realized.
7502 * This function should only ever be called in a derived widget's
7503 * "map" or "unmap" implementation.
7508 gtk_widget_set_mapped (GtkWidget *widget,
7511 g_return_if_fail (GTK_IS_WIDGET (widget));
7513 widget->priv->mapped = mapped;
7517 * gtk_widget_set_app_paintable:
7518 * @widget: a #GtkWidget
7519 * @app_paintable: %TRUE if the application will paint on the widget
7521 * Sets whether the application intends to draw on the widget in
7522 * an #GtkWidget::draw handler.
7524 * This is a hint to the widget and does not affect the behavior of
7525 * the GTK+ core; many widgets ignore this flag entirely. For widgets
7526 * that do pay attention to the flag, such as #GtkEventBox and #GtkWindow,
7527 * the effect is to suppress default themed drawing of the widget's
7528 * background. (Children of the widget will still be drawn.) The application
7529 * is then entirely responsible for drawing the widget background.
7531 * Note that the background is still drawn when the widget is mapped.
7534 gtk_widget_set_app_paintable (GtkWidget *widget,
7535 gboolean app_paintable)
7537 g_return_if_fail (GTK_IS_WIDGET (widget));
7539 app_paintable = (app_paintable != FALSE);
7541 if (widget->priv->app_paintable != app_paintable)
7543 widget->priv->app_paintable = app_paintable;
7545 if (gtk_widget_is_drawable (widget))
7546 gtk_widget_queue_draw (widget);
7548 g_object_notify (G_OBJECT (widget), "app-paintable");
7553 * gtk_widget_get_app_paintable:
7554 * @widget: a #GtkWidget
7556 * Determines whether the application intends to draw on the widget in
7557 * an #GtkWidget::draw handler.
7559 * See gtk_widget_set_app_paintable()
7561 * Return value: %TRUE if the widget is app paintable
7566 gtk_widget_get_app_paintable (GtkWidget *widget)
7568 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7570 return widget->priv->app_paintable;
7574 * gtk_widget_set_double_buffered:
7575 * @widget: a #GtkWidget
7576 * @double_buffered: %TRUE to double-buffer a widget
7578 * Widgets are double buffered by default; you can use this function
7579 * to turn off the buffering. "Double buffered" simply means that
7580 * gdk_window_begin_paint_region() and gdk_window_end_paint() are called
7581 * automatically around expose events sent to the
7582 * widget. gdk_window_begin_paint() diverts all drawing to a widget's
7583 * window to an offscreen buffer, and gdk_window_end_paint() draws the
7584 * buffer to the screen. The result is that users see the window
7585 * update in one smooth step, and don't see individual graphics
7586 * primitives being rendered.
7588 * In very simple terms, double buffered widgets don't flicker,
7589 * so you would only use this function to turn off double buffering
7590 * if you had special needs and really knew what you were doing.
7592 * Note: if you turn off double-buffering, you have to handle
7593 * expose events, since even the clearing to the background color or
7594 * pixmap will not happen automatically (as it is done in
7595 * gdk_window_begin_paint()).
7598 gtk_widget_set_double_buffered (GtkWidget *widget,
7599 gboolean double_buffered)
7601 g_return_if_fail (GTK_IS_WIDGET (widget));
7603 double_buffered = (double_buffered != FALSE);
7605 if (widget->priv->double_buffered != double_buffered)
7607 widget->priv->double_buffered = double_buffered;
7609 g_object_notify (G_OBJECT (widget), "double-buffered");
7614 * gtk_widget_get_double_buffered:
7615 * @widget: a #GtkWidget
7617 * Determines whether the widget is double buffered.
7619 * See gtk_widget_set_double_buffered()
7621 * Return value: %TRUE if the widget is double buffered
7626 gtk_widget_get_double_buffered (GtkWidget *widget)
7628 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7630 return widget->priv->double_buffered;
7634 * gtk_widget_set_redraw_on_allocate:
7635 * @widget: a #GtkWidget
7636 * @redraw_on_allocate: if %TRUE, the entire widget will be redrawn
7637 * when it is allocated to a new size. Otherwise, only the
7638 * new portion of the widget will be redrawn.
7640 * Sets whether the entire widget is queued for drawing when its size
7641 * allocation changes. By default, this setting is %TRUE and
7642 * the entire widget is redrawn on every size change. If your widget
7643 * leaves the upper left unchanged when made bigger, turning this
7644 * setting off will improve performance.
7646 * Note that for %NO_WINDOW widgets setting this flag to %FALSE turns
7647 * off all allocation on resizing: the widget will not even redraw if
7648 * its position changes; this is to allow containers that don't draw
7649 * anything to avoid excess invalidations. If you set this flag on a
7650 * %NO_WINDOW widget that <emphasis>does</emphasis> draw on @widget->window,
7651 * you are responsible for invalidating both the old and new allocation
7652 * of the widget when the widget is moved and responsible for invalidating
7653 * regions newly when the widget increases size.
7656 gtk_widget_set_redraw_on_allocate (GtkWidget *widget,
7657 gboolean redraw_on_allocate)
7659 g_return_if_fail (GTK_IS_WIDGET (widget));
7661 widget->priv->redraw_on_alloc = redraw_on_allocate;
7665 * gtk_widget_set_sensitive:
7666 * @widget: a #GtkWidget
7667 * @sensitive: %TRUE to make the widget sensitive
7669 * Sets the sensitivity of a widget. A widget is sensitive if the user
7670 * can interact with it. Insensitive widgets are "grayed out" and the
7671 * user can't interact with them. Insensitive widgets are known as
7672 * "inactive", "disabled", or "ghosted" in some other toolkits.
7675 gtk_widget_set_sensitive (GtkWidget *widget,
7678 GtkWidgetPrivate *priv;
7680 g_return_if_fail (GTK_IS_WIDGET (widget));
7682 priv = widget->priv;
7684 sensitive = (sensitive != FALSE);
7686 if (priv->sensitive == sensitive)
7689 priv->sensitive = sensitive;
7691 if (priv->parent == NULL
7692 || gtk_widget_is_sensitive (priv->parent))
7696 data.flags = GTK_STATE_FLAG_INSENSITIVE;
7699 data.operation = STATE_CHANGE_UNSET;
7701 data.operation = STATE_CHANGE_SET;
7703 gtk_widget_propagate_state (widget, &data);
7705 gtk_widget_queue_resize (widget);
7708 g_object_notify (G_OBJECT (widget), "sensitive");
7712 * gtk_widget_get_sensitive:
7713 * @widget: a #GtkWidget
7715 * Returns the widget's sensitivity (in the sense of returning
7716 * the value that has been set using gtk_widget_set_sensitive()).
7718 * The effective sensitivity of a widget is however determined by both its
7719 * own and its parent widget's sensitivity. See gtk_widget_is_sensitive().
7721 * Returns: %TRUE if the widget is sensitive
7726 gtk_widget_get_sensitive (GtkWidget *widget)
7728 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7730 return widget->priv->sensitive;
7734 * gtk_widget_is_sensitive:
7735 * @widget: a #GtkWidget
7737 * Returns the widget's effective sensitivity, which means
7738 * it is sensitive itself and also its parent widget is sensitive
7740 * Returns: %TRUE if the widget is effectively sensitive
7745 gtk_widget_is_sensitive (GtkWidget *widget)
7747 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7749 return !(widget->priv->state_flags & GTK_STATE_FLAG_INSENSITIVE);
7753 _gtk_widget_update_path (GtkWidget *widget)
7755 if (widget->priv->path)
7757 gtk_widget_path_free (widget->priv->path);
7758 widget->priv->path = NULL;
7761 gtk_widget_get_path (widget);
7765 * gtk_widget_set_parent:
7766 * @widget: a #GtkWidget
7767 * @parent: parent container
7769 * This function is useful only when implementing subclasses of
7771 * Sets the container as the parent of @widget, and takes care of
7772 * some details such as updating the state and style of the child
7773 * to reflect its new location. The opposite function is
7774 * gtk_widget_unparent().
7777 gtk_widget_set_parent (GtkWidget *widget,
7780 GtkStateFlags parent_flags;
7781 GtkWidgetPrivate *priv;
7784 g_return_if_fail (GTK_IS_WIDGET (widget));
7785 g_return_if_fail (GTK_IS_WIDGET (parent));
7786 g_return_if_fail (widget != parent);
7788 priv = widget->priv;
7790 if (priv->parent != NULL)
7792 g_warning ("Can't set a parent on widget which has a parent\n");
7795 if (gtk_widget_is_toplevel (widget))
7797 g_warning ("Can't set a parent on a toplevel widget\n");
7801 /* keep this function in sync with gtk_menu_attach_to_widget()
7804 g_object_ref_sink (widget);
7806 gtk_widget_push_verify_invariants (widget);
7808 priv->parent = parent;
7810 parent_flags = gtk_widget_get_state_flags (parent);
7812 /* Merge both old state and current parent state,
7813 * making sure to only propagate the right states */
7814 data.flags = parent_flags & GTK_STATE_FLAGS_DO_PROPAGATE;
7815 data.flags |= priv->state_flags;
7817 data.operation = STATE_CHANGE_REPLACE;
7818 gtk_widget_propagate_state (widget, &data);
7821 gtk_style_context_set_parent (priv->context,
7822 gtk_widget_get_style_context (parent));
7823 gtk_widget_reset_style (widget);
7825 g_signal_emit (widget, widget_signals[PARENT_SET], 0, NULL);
7826 if (priv->parent->priv->anchored)
7827 _gtk_widget_propagate_hierarchy_changed (widget, NULL);
7828 g_object_notify (G_OBJECT (widget), "parent");
7830 /* Enforce realized/mapped invariants
7832 if (gtk_widget_get_realized (priv->parent))
7833 gtk_widget_realize (widget);
7835 if (gtk_widget_get_visible (priv->parent) &&
7836 gtk_widget_get_visible (widget))
7838 if (gtk_widget_get_child_visible (widget) &&
7839 gtk_widget_get_mapped (priv->parent))
7840 gtk_widget_map (widget);
7842 gtk_widget_queue_resize (widget);
7845 /* child may cause parent's expand to change, if the child is
7846 * expanded. If child is not expanded, then it can't modify the
7847 * parent's expand. If the child becomes expanded later then it will
7848 * queue compute_expand then. This optimization plus defaulting
7849 * newly-constructed widgets to need_compute_expand=FALSE should
7850 * mean that initially building a widget tree doesn't have to keep
7851 * walking up setting need_compute_expand on parents over and over.
7853 * We can't change a parent to need to expand unless we're visible.
7855 if (gtk_widget_get_visible (widget) &&
7856 (priv->need_compute_expand ||
7857 priv->computed_hexpand ||
7858 priv->computed_vexpand))
7860 gtk_widget_queue_compute_expand (parent);
7863 gtk_widget_pop_verify_invariants (widget);
7867 * gtk_widget_get_parent:
7868 * @widget: a #GtkWidget
7870 * Returns the parent container of @widget.
7872 * Return value: (transfer none): the parent container of @widget, or %NULL
7875 gtk_widget_get_parent (GtkWidget *widget)
7877 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7879 return widget->priv->parent;
7883 modifier_style_changed (GtkModifierStyle *style,
7886 GtkStyleContext *context;
7888 context = gtk_widget_get_style_context (widget);
7889 gtk_style_context_invalidate (context);
7892 static GtkModifierStyle *
7893 _gtk_widget_get_modifier_properties (GtkWidget *widget)
7895 GtkModifierStyle *style;
7897 style = g_object_get_qdata (G_OBJECT (widget), quark_modifier_style);
7899 if (G_UNLIKELY (!style))
7901 GtkStyleContext *context;
7903 style = _gtk_modifier_style_new ();
7904 g_object_set_qdata_full (G_OBJECT (widget),
7905 quark_modifier_style,
7907 (GDestroyNotify) g_object_unref);
7909 g_signal_connect (style, "changed",
7910 G_CALLBACK (modifier_style_changed), widget);
7912 context = gtk_widget_get_style_context (widget);
7914 gtk_style_context_add_provider (context,
7915 GTK_STYLE_PROVIDER (style),
7916 GTK_STYLE_PROVIDER_PRIORITY_APPLICATION);
7923 * gtk_widget_override_color:
7924 * @widget: a #GtkWidget
7925 * @state: the state for which to set the color
7926 * @color: (allow-none): the color to assign, or %NULL to undo the effect
7927 * of previous calls to gtk_widget_override_color()
7929 * Sets the color to use for a widget.
7931 * All other style values are left untouched.
7934 * This API is mostly meant as a quick way for applications to
7935 * change a widget appearance. If you are developing a widgets
7936 * library and intend this change to be themeable, it is better
7937 * done by setting meaningful CSS classes and regions in your
7938 * widget/container implementation through gtk_style_context_add_class()
7939 * and gtk_style_context_add_region().
7941 * This way, your widget library can install a #GtkCssProvider
7942 * with the %GTK_STYLE_PROVIDER_PRIORITY_FALLBACK priority in order
7943 * to provide a default styling for those widgets that need so, and
7944 * this theming may fully overridden by the user's theme.
7947 * Note that for complex widgets this may bring in undesired
7948 * results (such as uniform background color everywhere), in
7949 * these cases it is better to fully style such widgets through a
7950 * #GtkCssProvider with the %GTK_STYLE_PROVIDER_PRIORITY_APPLICATION
7957 gtk_widget_override_color (GtkWidget *widget,
7958 GtkStateFlags state,
7959 const GdkRGBA *color)
7961 GtkModifierStyle *style;
7963 g_return_if_fail (GTK_IS_WIDGET (widget));
7965 style = _gtk_widget_get_modifier_properties (widget);
7966 _gtk_modifier_style_set_color (style, state, color);
7970 * gtk_widget_override_background_color:
7971 * @widget: a #GtkWidget
7972 * @state: the state for which to set the background color
7973 * @color: (allow-none): the color to assign, or %NULL to undo the effect
7974 * of previous calls to gtk_widget_override_background_color()
7976 * Sets the background color to use for a widget.
7978 * All other style values are left untouched.
7979 * See gtk_widget_override_color().
7984 gtk_widget_override_background_color (GtkWidget *widget,
7985 GtkStateFlags state,
7986 const GdkRGBA *color)
7988 GtkModifierStyle *style;
7990 g_return_if_fail (GTK_IS_WIDGET (widget));
7992 style = _gtk_widget_get_modifier_properties (widget);
7993 _gtk_modifier_style_set_background_color (style, state, color);
7997 * gtk_widget_override_font:
7998 * @widget: a #GtkWidget
7999 * @font_desc: (allow-none): the font descriptiong to use, or %NULL to undo
8000 * the effect of previous calls to gtk_widget_override_font()
8002 * Sets the font to use for a widget. All other style values are
8003 * left untouched. See gtk_widget_override_color().
8008 gtk_widget_override_font (GtkWidget *widget,
8009 const PangoFontDescription *font_desc)
8011 GtkModifierStyle *style;
8013 g_return_if_fail (GTK_IS_WIDGET (widget));
8015 style = _gtk_widget_get_modifier_properties (widget);
8016 _gtk_modifier_style_set_font (style, font_desc);
8020 * gtk_widget_override_symbolic_color:
8021 * @widget: a #GtkWidget
8022 * @name: the name of the symbolic color to modify
8023 * @color: (allow-none): the color to assign (does not need
8024 * to be allocated), or %NULL to undo the effect of previous
8025 * calls to gtk_widget_override_symbolic_color()
8027 * Sets a symbolic color for a widget.
8029 * All other style values are left untouched.
8030 * See gtk_widget_override_color() for overriding the foreground
8031 * or background color.
8036 gtk_widget_override_symbolic_color (GtkWidget *widget,
8038 const GdkRGBA *color)
8040 GtkModifierStyle *style;
8042 g_return_if_fail (GTK_IS_WIDGET (widget));
8044 style = _gtk_widget_get_modifier_properties (widget);
8045 _gtk_modifier_style_map_color (style, name, color);
8049 * gtk_widget_override_cursor:
8050 * @widget: a #GtkWidget
8051 * @cursor: (allow-none): the color to use for primary cursor (does not need to be
8052 * allocated), or %NULL to undo the effect of previous calls to
8053 * of gtk_widget_override_cursor().
8054 * @secondary_cursor: (allow-none): the color to use for secondary cursor (does not
8055 * need to be allocated), or %NULL to undo the effect of previous
8056 * calls to of gtk_widget_override_cursor().
8058 * Sets the cursor color to use in a widget, overriding the
8059 * #GtkWidget:cursor-color and #GtkWidget:secondary-cursor-color
8060 * style properties. All other style values are left untouched.
8061 * See also gtk_widget_modify_style().
8063 * Note that the underlying properties have the #GdkColor type,
8064 * so the alpha value in @primary and @secondary will be ignored.
8069 gtk_widget_override_cursor (GtkWidget *widget,
8070 const GdkRGBA *cursor,
8071 const GdkRGBA *secondary_cursor)
8073 GtkModifierStyle *style;
8075 g_return_if_fail (GTK_IS_WIDGET (widget));
8077 style = _gtk_widget_get_modifier_properties (widget);
8078 _gtk_modifier_style_set_color_property (style,
8080 "cursor-color", cursor);
8081 _gtk_modifier_style_set_color_property (style,
8083 "secondary-cursor-color",
8088 gtk_widget_real_direction_changed (GtkWidget *widget,
8089 GtkTextDirection previous_direction)
8091 gtk_widget_queue_resize (widget);
8095 gtk_widget_real_style_set (GtkWidget *widget,
8096 GtkStyle *previous_style)
8101 GtkWidget *previous_toplevel;
8102 GdkScreen *previous_screen;
8103 GdkScreen *new_screen;
8104 } HierarchyChangedInfo;
8107 do_screen_change (GtkWidget *widget,
8108 GdkScreen *old_screen,
8109 GdkScreen *new_screen)
8111 if (old_screen != new_screen)
8113 GtkWidgetPrivate *priv = widget->priv;
8117 PangoContext *context = g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
8119 g_object_set_qdata (G_OBJECT (widget), quark_pango_context, NULL);
8122 _gtk_tooltip_hide (widget);
8124 if (new_screen && priv->context)
8125 gtk_style_context_set_screen (priv->context, new_screen);
8127 g_signal_emit (widget, widget_signals[SCREEN_CHANGED], 0, old_screen);
8132 gtk_widget_propagate_hierarchy_changed_recurse (GtkWidget *widget,
8133 gpointer client_data)
8135 GtkWidgetPrivate *priv = widget->priv;
8136 HierarchyChangedInfo *info = client_data;
8137 gboolean new_anchored = gtk_widget_is_toplevel (widget) ||
8138 (priv->parent && priv->parent->priv->anchored);
8140 if (priv->anchored != new_anchored)
8142 g_object_ref (widget);
8144 priv->anchored = new_anchored;
8146 g_signal_emit (widget, widget_signals[HIERARCHY_CHANGED], 0, info->previous_toplevel);
8147 do_screen_change (widget, info->previous_screen, info->new_screen);
8149 if (GTK_IS_CONTAINER (widget))
8150 gtk_container_forall (GTK_CONTAINER (widget),
8151 gtk_widget_propagate_hierarchy_changed_recurse,
8154 g_object_unref (widget);
8159 * _gtk_widget_propagate_hierarchy_changed:
8160 * @widget: a #GtkWidget
8161 * @previous_toplevel: Previous toplevel
8163 * Propagates changes in the anchored state to a widget and all
8164 * children, unsetting or setting the %ANCHORED flag, and
8165 * emitting #GtkWidget::hierarchy-changed.
8168 _gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
8169 GtkWidget *previous_toplevel)
8171 GtkWidgetPrivate *priv = widget->priv;
8172 HierarchyChangedInfo info;
8174 info.previous_toplevel = previous_toplevel;
8175 info.previous_screen = previous_toplevel ? gtk_widget_get_screen (previous_toplevel) : NULL;
8177 if (gtk_widget_is_toplevel (widget) ||
8178 (priv->parent && priv->parent->priv->anchored))
8179 info.new_screen = gtk_widget_get_screen (widget);
8181 info.new_screen = NULL;
8183 if (info.previous_screen)
8184 g_object_ref (info.previous_screen);
8185 if (previous_toplevel)
8186 g_object_ref (previous_toplevel);
8188 gtk_widget_propagate_hierarchy_changed_recurse (widget, &info);
8190 if (previous_toplevel)
8191 g_object_unref (previous_toplevel);
8192 if (info.previous_screen)
8193 g_object_unref (info.previous_screen);
8197 gtk_widget_propagate_screen_changed_recurse (GtkWidget *widget,
8198 gpointer client_data)
8200 HierarchyChangedInfo *info = client_data;
8202 g_object_ref (widget);
8204 do_screen_change (widget, info->previous_screen, info->new_screen);
8206 if (GTK_IS_CONTAINER (widget))
8207 gtk_container_forall (GTK_CONTAINER (widget),
8208 gtk_widget_propagate_screen_changed_recurse,
8211 g_object_unref (widget);
8215 * gtk_widget_is_composited:
8216 * @widget: a #GtkWidget
8218 * Whether @widget can rely on having its alpha channel
8219 * drawn correctly. On X11 this function returns whether a
8220 * compositing manager is running for @widget's screen.
8222 * Please note that the semantics of this call will change
8223 * in the future if used on a widget that has a composited
8224 * window in its hierarchy (as set by gdk_window_set_composited()).
8226 * Return value: %TRUE if the widget can rely on its alpha
8227 * channel being drawn correctly.
8232 gtk_widget_is_composited (GtkWidget *widget)
8236 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
8238 screen = gtk_widget_get_screen (widget);
8240 return gdk_screen_is_composited (screen);
8244 propagate_composited_changed (GtkWidget *widget,
8247 if (GTK_IS_CONTAINER (widget))
8249 gtk_container_forall (GTK_CONTAINER (widget),
8250 propagate_composited_changed,
8254 g_signal_emit (widget, widget_signals[COMPOSITED_CHANGED], 0);
8258 _gtk_widget_propagate_composited_changed (GtkWidget *widget)
8260 propagate_composited_changed (widget, NULL);
8264 * _gtk_widget_propagate_screen_changed:
8265 * @widget: a #GtkWidget
8266 * @previous_screen: Previous screen
8268 * Propagates changes in the screen for a widget to all
8269 * children, emitting #GtkWidget::screen-changed.
8272 _gtk_widget_propagate_screen_changed (GtkWidget *widget,
8273 GdkScreen *previous_screen)
8275 HierarchyChangedInfo info;
8277 info.previous_screen = previous_screen;
8278 info.new_screen = gtk_widget_get_screen (widget);
8280 if (previous_screen)
8281 g_object_ref (previous_screen);
8283 gtk_widget_propagate_screen_changed_recurse (widget, &info);
8285 if (previous_screen)
8286 g_object_unref (previous_screen);
8290 reset_style_recurse (GtkWidget *widget, gpointer data)
8292 _gtk_widget_update_path (widget);
8294 if (GTK_IS_CONTAINER (widget))
8295 gtk_container_forall (GTK_CONTAINER (widget),
8296 reset_style_recurse,
8301 * gtk_widget_reset_style:
8302 * @widget: a #GtkWidget
8304 * Updates the style context of @widget and all descendents
8305 * by updating its widget path. #GtkContainer<!-- -->s may want
8306 * to use this on a child when reordering it in a way that a different
8307 * style might apply to it. See also gtk_container_get_path_for_child().
8312 gtk_widget_reset_style (GtkWidget *widget)
8314 g_return_if_fail (GTK_IS_WIDGET (widget));
8316 reset_style_recurse (widget, NULL);
8319 #ifdef G_ENABLE_DEBUG
8321 /* Verify invariants, see docs/widget_system.txt for notes on much of
8322 * this. Invariants may be temporarily broken while we're in the
8323 * process of updating state, of course, so you can only
8324 * verify_invariants() after a given operation is complete.
8325 * Use push/pop_verify_invariants to help with that.
8328 gtk_widget_verify_invariants (GtkWidget *widget)
8332 if (widget->priv->verifying_invariants_count > 0)
8335 parent = widget->priv->parent;
8337 if (widget->priv->mapped)
8339 /* Mapped implies ... */
8341 if (!widget->priv->realized)
8342 g_warning ("%s %p is mapped but not realized",
8343 G_OBJECT_TYPE_NAME (widget), widget);
8345 if (!widget->priv->visible)
8346 g_warning ("%s %p is mapped but not visible",
8347 G_OBJECT_TYPE_NAME (widget), widget);
8349 if (!widget->priv->toplevel)
8351 if (!widget->priv->child_visible)
8352 g_warning ("%s %p is mapped but not child_visible",
8353 G_OBJECT_TYPE_NAME (widget), widget);
8358 /* Not mapped implies... */
8361 /* This check makes sense for normal toplevels, but for
8362 * something like a toplevel that is embedded within a clutter
8363 * state, mapping may depend on external factors.
8365 if (widget->priv->toplevel)
8367 if (widget->priv->visible)
8368 g_warning ("%s %p toplevel is visible but not mapped",
8369 G_OBJECT_TYPE_NAME (widget), widget);
8374 /* Parent related checks aren't possible if parent has
8375 * verifying_invariants_count > 0 because parent needs to recurse
8376 * children first before the invariants will hold.
8378 if (parent == NULL || parent->priv->verifying_invariants_count == 0)
8381 parent->priv->realized)
8383 /* Parent realized implies... */
8386 /* This is in widget_system.txt but appears to fail
8387 * because there's no gtk_container_realize() that
8388 * realizes all children... instead we just lazily
8389 * wait for map to fix things up.
8391 if (!widget->priv->realized)
8392 g_warning ("%s %p is realized but child %s %p is not realized",
8393 G_OBJECT_TYPE_NAME (parent), parent,
8394 G_OBJECT_TYPE_NAME (widget), widget);
8397 else if (!widget->priv->toplevel)
8399 /* No parent or parent not realized on non-toplevel implies... */
8401 if (widget->priv->realized && !widget->priv->in_reparent)
8402 g_warning ("%s %p is not realized but child %s %p is realized",
8403 parent ? G_OBJECT_TYPE_NAME (parent) : "no parent", parent,
8404 G_OBJECT_TYPE_NAME (widget), widget);
8408 parent->priv->mapped &&
8409 widget->priv->visible &&
8410 widget->priv->child_visible)
8412 /* Parent mapped and we are visible implies... */
8414 if (!widget->priv->mapped)
8415 g_warning ("%s %p is mapped but visible child %s %p is not mapped",
8416 G_OBJECT_TYPE_NAME (parent), parent,
8417 G_OBJECT_TYPE_NAME (widget), widget);
8419 else if (!widget->priv->toplevel)
8421 /* No parent or parent not mapped on non-toplevel implies... */
8423 if (widget->priv->mapped && !widget->priv->in_reparent)
8424 g_warning ("%s %p is mapped but visible=%d child_visible=%d parent %s %p mapped=%d",
8425 G_OBJECT_TYPE_NAME (widget), widget,
8426 widget->priv->visible,
8427 widget->priv->child_visible,
8428 parent ? G_OBJECT_TYPE_NAME (parent) : "no parent", parent,
8429 parent ? parent->priv->mapped : FALSE);
8433 if (!widget->priv->realized)
8435 /* Not realized implies... */
8438 /* widget_system.txt says these hold, but they don't. */
8439 if (widget->priv->resize_pending)
8440 g_warning ("%s %p resize pending but not realized",
8441 G_OBJECT_TYPE_NAME (widget), widget);
8443 if (widget->priv->alloc_needed)
8444 g_warning ("%s %p alloc needed but not realized",
8445 G_OBJECT_TYPE_NAME (widget), widget);
8447 if (widget->priv->width_request_needed)
8448 g_warning ("%s %p width request needed but not realized",
8449 G_OBJECT_TYPE_NAME (widget), widget);
8451 if (widget->priv->height_request_needed)
8452 g_warning ("%s %p height request needed but not realized",
8453 G_OBJECT_TYPE_NAME (widget), widget);
8458 /* The point of this push/pop is that invariants may not hold while
8459 * we're busy making changes. So we only check at the outermost call
8460 * on the call stack, after we finish updating everything.
8463 gtk_widget_push_verify_invariants (GtkWidget *widget)
8465 widget->priv->verifying_invariants_count += 1;
8469 gtk_widget_verify_child_invariants (GtkWidget *widget,
8470 gpointer client_data)
8472 /* We don't recurse further; this is a one-level check. */
8473 gtk_widget_verify_invariants (widget);
8477 gtk_widget_pop_verify_invariants (GtkWidget *widget)
8479 g_assert (widget->priv->verifying_invariants_count > 0);
8481 widget->priv->verifying_invariants_count -= 1;
8483 if (widget->priv->verifying_invariants_count == 0)
8485 gtk_widget_verify_invariants (widget);
8487 if (GTK_IS_CONTAINER (widget))
8489 /* Check one level of children, because our
8490 * push_verify_invariants() will have prevented some of the
8491 * checks. This does not recurse because if recursion is
8492 * needed, it will happen naturally as each child has a
8493 * push/pop on that child. For example if we're recursively
8494 * mapping children, we'll push/pop on each child as we map
8497 gtk_container_forall (GTK_CONTAINER (widget),
8498 gtk_widget_verify_child_invariants,
8503 #endif /* G_ENABLE_DEBUG */
8505 static PangoContext *
8506 gtk_widget_peek_pango_context (GtkWidget *widget)
8508 return g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
8512 * gtk_widget_get_pango_context:
8513 * @widget: a #GtkWidget
8515 * Gets a #PangoContext with the appropriate font map, font description,
8516 * and base direction for this widget. Unlike the context returned
8517 * by gtk_widget_create_pango_context(), this context is owned by
8518 * the widget (it can be used until the screen for the widget changes
8519 * or the widget is removed from its toplevel), and will be updated to
8520 * match any changes to the widget's attributes.
8522 * If you create and keep a #PangoLayout using this context, you must
8523 * deal with changes to the context by calling pango_layout_context_changed()
8524 * on the layout in response to the #GtkWidget::style-updated and
8525 * #GtkWidget::direction-changed signals for the widget.
8527 * Return value: (transfer none): the #PangoContext for the widget.
8530 gtk_widget_get_pango_context (GtkWidget *widget)
8532 PangoContext *context;
8534 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8536 context = g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
8539 context = gtk_widget_create_pango_context (GTK_WIDGET (widget));
8540 g_object_set_qdata_full (G_OBJECT (widget),
8541 quark_pango_context,
8550 update_pango_context (GtkWidget *widget,
8551 PangoContext *context)
8553 const PangoFontDescription *font_desc;
8554 GtkStyleContext *style_context;
8556 style_context = gtk_widget_get_style_context (widget);
8558 font_desc = gtk_style_context_get_font (style_context,
8559 gtk_widget_get_state_flags (widget));
8561 pango_context_set_font_description (context, font_desc);
8562 pango_context_set_base_dir (context,
8563 gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR ?
8564 PANGO_DIRECTION_LTR : PANGO_DIRECTION_RTL);
8568 gtk_widget_update_pango_context (GtkWidget *widget)
8570 PangoContext *context = gtk_widget_peek_pango_context (widget);
8576 update_pango_context (widget, context);
8578 screen = gtk_widget_get_screen_unchecked (widget);
8581 pango_cairo_context_set_resolution (context,
8582 gdk_screen_get_resolution (screen));
8583 pango_cairo_context_set_font_options (context,
8584 gdk_screen_get_font_options (screen));
8590 * gtk_widget_create_pango_context:
8591 * @widget: a #GtkWidget
8593 * Creates a new #PangoContext with the appropriate font map,
8594 * font description, and base direction for drawing text for
8595 * this widget. See also gtk_widget_get_pango_context().
8597 * Return value: (transfer full): the new #PangoContext
8600 gtk_widget_create_pango_context (GtkWidget *widget)
8603 PangoContext *context;
8605 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8607 screen = gtk_widget_get_screen_unchecked (widget);
8610 GTK_NOTE (MULTIHEAD,
8611 g_warning ("gtk_widget_create_pango_context ()) called without screen"));
8613 screen = gdk_screen_get_default ();
8616 context = gdk_pango_context_get_for_screen (screen);
8618 update_pango_context (widget, context);
8619 pango_context_set_language (context, gtk_get_default_language ());
8625 * gtk_widget_create_pango_layout:
8626 * @widget: a #GtkWidget
8627 * @text: text to set on the layout (can be %NULL)
8629 * Creates a new #PangoLayout with the appropriate font map,
8630 * font description, and base direction for drawing text for
8633 * If you keep a #PangoLayout created in this way around, in order to
8634 * notify the layout of changes to the base direction or font of this
8635 * widget, you must call pango_layout_context_changed() in response to
8636 * the #GtkWidget::style-updated and #GtkWidget::direction-changed signals
8639 * Return value: (transfer full): the new #PangoLayout
8642 gtk_widget_create_pango_layout (GtkWidget *widget,
8645 PangoLayout *layout;
8646 PangoContext *context;
8648 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8650 context = gtk_widget_get_pango_context (widget);
8651 layout = pango_layout_new (context);
8654 pango_layout_set_text (layout, text, -1);
8660 * gtk_widget_render_icon_pixbuf:
8661 * @widget: a #GtkWidget
8662 * @stock_id: a stock ID
8663 * @size: (type int): a stock size. A size of (GtkIconSize)-1 means
8664 * render at the size of the source and don't scale (if there are
8665 * multiple source sizes, GTK+ picks one of the available sizes).
8667 * A convenience function that uses the theme engine and style
8668 * settings for @widget to look up @stock_id and render it to
8669 * a pixbuf. @stock_id should be a stock icon ID such as
8670 * #GTK_STOCK_OPEN or #GTK_STOCK_OK. @size should be a size
8671 * such as #GTK_ICON_SIZE_MENU.
8673 * The pixels in the returned #GdkPixbuf are shared with the rest of
8674 * the application and should not be modified. The pixbuf should be freed
8675 * after use with g_object_unref().
8677 * Return value: (transfer full): a new pixbuf, or %NULL if the
8678 * stock ID wasn't known
8683 gtk_widget_render_icon_pixbuf (GtkWidget *widget,
8684 const gchar *stock_id,
8687 GtkStyleContext *context;
8688 GtkIconSet *icon_set;
8690 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8691 g_return_val_if_fail (stock_id != NULL, NULL);
8692 g_return_val_if_fail (size > GTK_ICON_SIZE_INVALID || size == -1, NULL);
8694 context = gtk_widget_get_style_context (widget);
8695 icon_set = gtk_style_context_lookup_icon_set (context, stock_id);
8697 if (icon_set == NULL)
8700 return gtk_icon_set_render_icon_pixbuf (icon_set, context, size);
8704 * gtk_widget_set_parent_window:
8705 * @widget: a #GtkWidget.
8706 * @parent_window: the new parent window.
8708 * Sets a non default parent window for @widget.
8710 * For GtkWindow classes, setting a @parent_window effects whether
8711 * the window is a toplevel window or can be embedded into other
8715 * For GtkWindow classes, this needs to be called before the
8716 * window is realized.
8721 gtk_widget_set_parent_window (GtkWidget *widget,
8722 GdkWindow *parent_window)
8724 GdkWindow *old_parent_window;
8726 g_return_if_fail (GTK_IS_WIDGET (widget));
8728 old_parent_window = g_object_get_qdata (G_OBJECT (widget),
8729 quark_parent_window);
8731 if (parent_window != old_parent_window)
8735 g_object_set_qdata (G_OBJECT (widget), quark_parent_window,
8737 if (old_parent_window)
8738 g_object_unref (old_parent_window);
8740 g_object_ref (parent_window);
8742 /* Unset toplevel flag when adding a parent window to a widget,
8743 * this is the primary entry point to allow toplevels to be
8746 #ifdef GDK_WINDOWING_X11
8747 is_plug = GTK_IS_PLUG (widget);
8751 if (GTK_IS_WINDOW (widget) && !is_plug)
8752 _gtk_window_set_is_toplevel (GTK_WINDOW (widget), parent_window == NULL);
8757 * gtk_widget_get_parent_window:
8758 * @widget: a #GtkWidget.
8760 * Gets @widget's parent window.
8762 * Returns: (transfer none): the parent window of @widget.
8765 gtk_widget_get_parent_window (GtkWidget *widget)
8767 GtkWidgetPrivate *priv;
8768 GdkWindow *parent_window;
8770 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8772 priv = widget->priv;
8774 parent_window = g_object_get_qdata (G_OBJECT (widget), quark_parent_window);
8776 return (parent_window != NULL) ? parent_window :
8777 (priv->parent != NULL) ? priv->parent->priv->window : NULL;
8782 * gtk_widget_set_child_visible:
8783 * @widget: a #GtkWidget
8784 * @is_visible: if %TRUE, @widget should be mapped along with its parent.
8786 * Sets whether @widget should be mapped along with its when its parent
8787 * is mapped and @widget has been shown with gtk_widget_show().
8789 * The child visibility can be set for widget before it is added to
8790 * a container with gtk_widget_set_parent(), to avoid mapping
8791 * children unnecessary before immediately unmapping them. However
8792 * it will be reset to its default state of %TRUE when the widget
8793 * is removed from a container.
8795 * Note that changing the child visibility of a widget does not
8796 * queue a resize on the widget. Most of the time, the size of
8797 * a widget is computed from all visible children, whether or
8798 * not they are mapped. If this is not the case, the container
8799 * can queue a resize itself.
8801 * This function is only useful for container implementations and
8802 * never should be called by an application.
8805 gtk_widget_set_child_visible (GtkWidget *widget,
8806 gboolean is_visible)
8808 GtkWidgetPrivate *priv;
8810 g_return_if_fail (GTK_IS_WIDGET (widget));
8811 g_return_if_fail (!gtk_widget_is_toplevel (widget));
8813 priv = widget->priv;
8815 g_object_ref (widget);
8816 gtk_widget_verify_invariants (widget);
8819 priv->child_visible = TRUE;
8822 GtkWidget *toplevel;
8824 priv->child_visible = FALSE;
8826 toplevel = gtk_widget_get_toplevel (widget);
8827 if (toplevel != widget && gtk_widget_is_toplevel (toplevel))
8828 _gtk_window_unset_focus_and_default (GTK_WINDOW (toplevel), widget);
8831 if (priv->parent && gtk_widget_get_realized (priv->parent))
8833 if (gtk_widget_get_mapped (priv->parent) &&
8834 priv->child_visible &&
8835 gtk_widget_get_visible (widget))
8836 gtk_widget_map (widget);
8838 gtk_widget_unmap (widget);
8841 gtk_widget_verify_invariants (widget);
8842 g_object_unref (widget);
8846 * gtk_widget_get_child_visible:
8847 * @widget: a #GtkWidget
8849 * Gets the value set with gtk_widget_set_child_visible().
8850 * If you feel a need to use this function, your code probably
8851 * needs reorganization.
8853 * This function is only useful for container implementations and
8854 * never should be called by an application.
8856 * Return value: %TRUE if the widget is mapped with the parent.
8859 gtk_widget_get_child_visible (GtkWidget *widget)
8861 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
8863 return widget->priv->child_visible;
8867 gtk_widget_get_screen_unchecked (GtkWidget *widget)
8869 GtkWidget *toplevel;
8871 toplevel = gtk_widget_get_toplevel (widget);
8873 if (gtk_widget_is_toplevel (toplevel))
8875 if (GTK_IS_WINDOW (toplevel))
8876 return gtk_window_get_screen (GTK_WINDOW (toplevel));
8877 else if (GTK_IS_INVISIBLE (toplevel))
8878 return gtk_invisible_get_screen (GTK_INVISIBLE (widget));
8885 * gtk_widget_get_screen:
8886 * @widget: a #GtkWidget
8888 * Get the #GdkScreen from the toplevel window associated with
8889 * this widget. This function can only be called after the widget
8890 * has been added to a widget hierarchy with a #GtkWindow
8893 * In general, you should only create screen specific
8894 * resources when a widget has been realized, and you should
8895 * free those resources when the widget is unrealized.
8897 * Return value: (transfer none): the #GdkScreen for the toplevel for this widget.
8902 gtk_widget_get_screen (GtkWidget *widget)
8906 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8908 screen = gtk_widget_get_screen_unchecked (widget);
8915 g_warning (G_STRLOC ": Can't get associated screen"
8916 " for a widget unless it is inside a toplevel GtkWindow\n"
8917 " widget type is %s associated top level type is %s",
8918 g_type_name (G_OBJECT_TYPE(G_OBJECT (widget))),
8919 g_type_name (G_OBJECT_TYPE(G_OBJECT (toplevel))));
8921 return gdk_screen_get_default ();
8926 * gtk_widget_has_screen:
8927 * @widget: a #GtkWidget
8929 * Checks whether there is a #GdkScreen is associated with
8930 * this widget. All toplevel widgets have an associated
8931 * screen, and all widgets added into a hierarchy with a toplevel
8932 * window at the top.
8934 * Return value: %TRUE if there is a #GdkScreen associcated
8940 gtk_widget_has_screen (GtkWidget *widget)
8942 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
8944 return (gtk_widget_get_screen_unchecked (widget) != NULL);
8948 * gtk_widget_get_display:
8949 * @widget: a #GtkWidget
8951 * Get the #GdkDisplay for the toplevel window associated with
8952 * this widget. This function can only be called after the widget
8953 * has been added to a widget hierarchy with a #GtkWindow at the top.
8955 * In general, you should only create display specific
8956 * resources when a widget has been realized, and you should
8957 * free those resources when the widget is unrealized.
8959 * Return value: (transfer none): the #GdkDisplay for the toplevel for this widget.
8964 gtk_widget_get_display (GtkWidget *widget)
8966 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8968 return gdk_screen_get_display (gtk_widget_get_screen (widget));
8972 * gtk_widget_get_root_window:
8973 * @widget: a #GtkWidget
8975 * Get the root window where this widget is located. This function can
8976 * only be called after the widget has been added to a widget
8977 * hierarchy with #GtkWindow at the top.
8979 * The root window is useful for such purposes as creating a popup
8980 * #GdkWindow associated with the window. In general, you should only
8981 * create display specific resources when a widget has been realized,
8982 * and you should free those resources when the widget is unrealized.
8984 * Return value: (transfer none): the #GdkWindow root window for the toplevel for this widget.
8989 gtk_widget_get_root_window (GtkWidget *widget)
8991 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8993 return gdk_screen_get_root_window (gtk_widget_get_screen (widget));
8997 * gtk_widget_child_focus:
8998 * @widget: a #GtkWidget
8999 * @direction: direction of focus movement
9001 * This function is used by custom widget implementations; if you're
9002 * writing an app, you'd use gtk_widget_grab_focus() to move the focus
9003 * to a particular widget, and gtk_container_set_focus_chain() to
9004 * change the focus tab order. So you may want to investigate those
9005 * functions instead.
9007 * gtk_widget_child_focus() is called by containers as the user moves
9008 * around the window using keyboard shortcuts. @direction indicates
9009 * what kind of motion is taking place (up, down, left, right, tab
9010 * forward, tab backward). gtk_widget_child_focus() emits the
9011 * #GtkWidget::focus signal; widgets override the default handler
9012 * for this signal in order to implement appropriate focus behavior.
9014 * The default ::focus handler for a widget should return %TRUE if
9015 * moving in @direction left the focus on a focusable location inside
9016 * that widget, and %FALSE if moving in @direction moved the focus
9017 * outside the widget. If returning %TRUE, widgets normally
9018 * call gtk_widget_grab_focus() to place the focus accordingly;
9019 * if returning %FALSE, they don't modify the current focus location.
9021 * Return value: %TRUE if focus ended up inside @widget
9024 gtk_widget_child_focus (GtkWidget *widget,
9025 GtkDirectionType direction)
9027 gboolean return_val;
9029 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
9031 if (!gtk_widget_get_visible (widget) ||
9032 !gtk_widget_is_sensitive (widget))
9035 /* child widgets must set CAN_FOCUS, containers
9036 * don't have to though.
9038 if (!GTK_IS_CONTAINER (widget) &&
9039 !gtk_widget_get_can_focus (widget))
9042 g_signal_emit (widget,
9043 widget_signals[FOCUS],
9045 direction, &return_val);
9051 * gtk_widget_keynav_failed:
9052 * @widget: a #GtkWidget
9053 * @direction: direction of focus movement
9055 * This function should be called whenever keyboard navigation within
9056 * a single widget hits a boundary. The function emits the
9057 * #GtkWidget::keynav-failed signal on the widget and its return
9058 * value should be interpreted in a way similar to the return value of
9059 * gtk_widget_child_focus():
9061 * When %TRUE is returned, stay in the widget, the failed keyboard
9062 * navigation is Ok and/or there is nowhere we can/should move the
9065 * When %FALSE is returned, the caller should continue with keyboard
9066 * navigation outside the widget, e.g. by calling
9067 * gtk_widget_child_focus() on the widget's toplevel.
9069 * The default ::keynav-failed handler returns %TRUE for
9070 * %GTK_DIR_TAB_FORWARD and %GTK_DIR_TAB_BACKWARD. For the other
9071 * values of #GtkDirectionType, it looks at the
9072 * #GtkSettings:gtk-keynav-cursor-only setting and returns %FALSE
9073 * if the setting is %TRUE. This way the entire user interface
9074 * becomes cursor-navigatable on input devices such as mobile phones
9075 * which only have cursor keys but no tab key.
9077 * Whenever the default handler returns %TRUE, it also calls
9078 * gtk_widget_error_bell() to notify the user of the failed keyboard
9081 * A use case for providing an own implementation of ::keynav-failed
9082 * (either by connecting to it or by overriding it) would be a row of
9083 * #GtkEntry widgets where the user should be able to navigate the
9084 * entire row with the cursor keys, as e.g. known from user interfaces
9085 * that require entering license keys.
9087 * Return value: %TRUE if stopping keyboard navigation is fine, %FALSE
9088 * if the emitting widget should try to handle the keyboard
9089 * navigation attempt in its parent container(s).
9094 gtk_widget_keynav_failed (GtkWidget *widget,
9095 GtkDirectionType direction)
9097 gboolean return_val;
9099 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
9101 g_signal_emit (widget, widget_signals[KEYNAV_FAILED], 0,
9102 direction, &return_val);
9108 * gtk_widget_error_bell:
9109 * @widget: a #GtkWidget
9111 * Notifies the user about an input-related error on this widget.
9112 * If the #GtkSettings:gtk-error-bell setting is %TRUE, it calls
9113 * gdk_window_beep(), otherwise it does nothing.
9115 * Note that the effect of gdk_window_beep() can be configured in many
9116 * ways, depending on the windowing backend and the desktop environment
9117 * or window manager that is used.
9122 gtk_widget_error_bell (GtkWidget *widget)
9124 GtkWidgetPrivate *priv;
9125 GtkSettings* settings;
9128 g_return_if_fail (GTK_IS_WIDGET (widget));
9130 priv = widget->priv;
9132 settings = gtk_widget_get_settings (widget);
9136 g_object_get (settings,
9137 "gtk-error-bell", &beep,
9140 if (beep && priv->window)
9141 gdk_window_beep (priv->window);
9145 gtk_widget_set_usize_internal (GtkWidget *widget,
9148 GtkQueueResizeFlags flags)
9150 GtkWidgetAuxInfo *aux_info;
9151 gboolean changed = FALSE;
9153 g_object_freeze_notify (G_OBJECT (widget));
9155 aux_info = gtk_widget_get_aux_info (widget, TRUE);
9157 if (width > -2 && aux_info->width != width)
9159 if ((flags & GTK_QUEUE_RESIZE_INVALIDATE_ONLY) == 0)
9160 g_object_notify (G_OBJECT (widget), "width-request");
9161 aux_info->width = width;
9164 if (height > -2 && aux_info->height != height)
9166 if ((flags & GTK_QUEUE_RESIZE_INVALIDATE_ONLY) == 0)
9167 g_object_notify (G_OBJECT (widget), "height-request");
9168 aux_info->height = height;
9172 if (gtk_widget_get_visible (widget) && changed)
9174 if ((flags & GTK_QUEUE_RESIZE_INVALIDATE_ONLY) == 0)
9175 gtk_widget_queue_resize (widget);
9177 _gtk_size_group_queue_resize (widget, GTK_QUEUE_RESIZE_INVALIDATE_ONLY);
9180 g_object_thaw_notify (G_OBJECT (widget));
9184 * gtk_widget_set_size_request:
9185 * @widget: a #GtkWidget
9186 * @width: width @widget should request, or -1 to unset
9187 * @height: height @widget should request, or -1 to unset
9189 * Sets the minimum size of a widget; that is, the widget's size
9190 * request will be @width by @height. You can use this function to
9191 * force a widget to be either larger or smaller than it normally
9194 * In most cases, gtk_window_set_default_size() is a better choice for
9195 * toplevel windows than this function; setting the default size will
9196 * still allow users to shrink the window. Setting the size request
9197 * will force them to leave the window at least as large as the size
9198 * request. When dealing with window sizes,
9199 * gtk_window_set_geometry_hints() can be a useful function as well.
9201 * Note the inherent danger of setting any fixed size - themes,
9202 * translations into other languages, different fonts, and user action
9203 * can all change the appropriate size for a given widget. So, it's
9204 * basically impossible to hardcode a size that will always be
9207 * The size request of a widget is the smallest size a widget can
9208 * accept while still functioning well and drawing itself correctly.
9209 * However in some strange cases a widget may be allocated less than
9210 * its requested size, and in many cases a widget may be allocated more
9211 * space than it requested.
9213 * If the size request in a given direction is -1 (unset), then
9214 * the "natural" size request of the widget will be used instead.
9216 * Widgets can't actually be allocated a size less than 1 by 1, but
9217 * you can pass 0,0 to this function to mean "as small as possible."
9219 * The size request set here does not include any margin from the
9220 * #GtkWidget properties margin-left, margin-right, margin-top, and
9221 * margin-bottom, but it does include pretty much all other padding
9222 * or border properties set by any subclass of #GtkWidget.
9225 gtk_widget_set_size_request (GtkWidget *widget,
9229 g_return_if_fail (GTK_IS_WIDGET (widget));
9230 g_return_if_fail (width >= -1);
9231 g_return_if_fail (height >= -1);
9238 gtk_widget_set_usize_internal (widget, width, height, 0);
9243 * gtk_widget_get_size_request:
9244 * @widget: a #GtkWidget
9245 * @width: (out) (allow-none): return location for width, or %NULL
9246 * @height: (out) (allow-none): return location for height, or %NULL
9248 * Gets the size request that was explicitly set for the widget using
9249 * gtk_widget_set_size_request(). A value of -1 stored in @width or
9250 * @height indicates that that dimension has not been set explicitly
9251 * and the natural requisition of the widget will be used intead. See
9252 * gtk_widget_set_size_request(). To get the size a widget will
9253 * actually request, call gtk_widget_get_preferred_size() instead of
9257 gtk_widget_get_size_request (GtkWidget *widget,
9261 const GtkWidgetAuxInfo *aux_info;
9263 g_return_if_fail (GTK_IS_WIDGET (widget));
9265 aux_info = _gtk_widget_get_aux_info_or_defaults (widget);
9268 *width = aux_info->width;
9271 *height = aux_info->height;
9275 * _gtk_widget_override_size_request:
9276 * @widget: a #GtkWidget
9277 * @width: new forced minimum width
9278 * @height: new forced minimum height
9279 * @old_width: location to store previous forced minimum width
9280 * @old_width: location to store previous forced minumum height
9282 * Temporarily establishes a forced minimum size for a widget; this
9283 * is used by GtkWindow when calculating the size to add to the
9284 * window's geometry widget. Cached sizes for the widget and its
9285 * parents are invalidated, so that subsequent calls to the size
9286 * negotiation machinery produce the overriden result, but the
9287 * widget is not queued for relayout or redraw. The old size must
9288 * be restored with _gtk_widget_restore_size_request() or things
9292 _gtk_widget_override_size_request (GtkWidget *widget,
9298 gtk_widget_get_size_request (widget, old_width, old_height);
9299 gtk_widget_set_usize_internal (widget, width, height,
9300 GTK_QUEUE_RESIZE_INVALIDATE_ONLY);
9304 * _gtk_widget_restore_size_request:
9305 * @widget: a #GtkWidget
9306 * @old_width: saved forced minimum size
9307 * @old_height: saved forced minimum size
9309 * Undoes the operation of_gtk_widget_override_size_request().
9312 _gtk_widget_restore_size_request (GtkWidget *widget,
9316 gtk_widget_set_usize_internal (widget, old_width, old_height,
9317 GTK_QUEUE_RESIZE_INVALIDATE_ONLY);
9321 * gtk_widget_set_events:
9322 * @widget: a #GtkWidget
9323 * @events: event mask
9325 * Sets the event mask (see #GdkEventMask) for a widget. The event
9326 * mask determines which events a widget will receive. Keep in mind
9327 * that different widgets have different default event masks, and by
9328 * changing the event mask you may disrupt a widget's functionality,
9329 * so be careful. This function must be called while a widget is
9330 * unrealized. Consider gtk_widget_add_events() for widgets that are
9331 * already realized, or if you want to preserve the existing event
9332 * mask. This function can't be used with #GTK_NO_WINDOW widgets;
9333 * to get events on those widgets, place them inside a #GtkEventBox
9334 * and receive events on the event box.
9337 gtk_widget_set_events (GtkWidget *widget,
9340 g_return_if_fail (GTK_IS_WIDGET (widget));
9341 g_return_if_fail (!gtk_widget_get_realized (widget));
9343 g_object_set_qdata (G_OBJECT (widget), quark_event_mask,
9344 GINT_TO_POINTER (events));
9345 g_object_notify (G_OBJECT (widget), "events");
9349 * gtk_widget_set_device_events:
9350 * @widget: a #GtkWidget
9351 * @device: a #GdkDevice
9352 * @events: event mask
9354 * Sets the device event mask (see #GdkEventMask) for a widget. The event
9355 * mask determines which events a widget will receive from @device. Keep
9356 * in mind that different widgets have different default event masks, and by
9357 * changing the event mask you may disrupt a widget's functionality,
9358 * so be careful. This function must be called while a widget is
9359 * unrealized. Consider gtk_widget_add_device_events() for widgets that are
9360 * already realized, or if you want to preserve the existing event
9361 * mask. This function can't be used with #GTK_NO_WINDOW widgets;
9362 * to get events on those widgets, place them inside a #GtkEventBox
9363 * and receive events on the event box.
9368 gtk_widget_set_device_events (GtkWidget *widget,
9370 GdkEventMask events)
9372 GHashTable *device_events;
9374 g_return_if_fail (GTK_IS_WIDGET (widget));
9375 g_return_if_fail (GDK_IS_DEVICE (device));
9376 g_return_if_fail (!gtk_widget_get_realized (widget));
9378 device_events = g_object_get_qdata (G_OBJECT (widget), quark_device_event_mask);
9380 if (G_UNLIKELY (!device_events))
9382 device_events = g_hash_table_new (NULL, NULL);
9383 g_object_set_qdata_full (G_OBJECT (widget), quark_device_event_mask, device_events,
9384 (GDestroyNotify) g_hash_table_unref);
9387 g_hash_table_insert (device_events, device, GUINT_TO_POINTER (events));
9391 * gtk_widget_set_device_enabled:
9392 * @widget: a #GtkWidget
9393 * @device: a #GdkDevice
9394 * @enabled: whether to enable the device
9396 * Enables or disables a #GdkDevice to interact with @widget
9397 * and all its children.
9399 * It does so by descending through the #GdkWindow hierarchy
9400 * and enabling the same mask that is has for core events
9401 * (i.e. the one that gdk_window_get_events() returns).
9406 gtk_widget_set_device_enabled (GtkWidget *widget,
9410 GList *enabled_devices;
9412 g_return_if_fail (GTK_IS_WIDGET (widget));
9413 g_return_if_fail (GDK_IS_DEVICE (device));
9415 enabled_devices = g_object_get_qdata (G_OBJECT (widget), quark_enabled_devices);
9416 enabled_devices = g_list_append (enabled_devices, device);
9418 g_object_set_qdata_full (G_OBJECT (widget), quark_enabled_devices,
9419 enabled_devices, (GDestroyNotify) g_list_free);;
9421 if (gtk_widget_get_realized (widget))
9422 gtk_widget_set_device_enabled_internal (widget, device, TRUE, enabled);
9426 * gtk_widget_get_device_enabled:
9427 * @widget: a #GtkWidget
9428 * @device: a #GdkDevice
9430 * Returns whether @device can interact with @widget and its
9431 * children. See gtk_widget_set_device_enabled().
9433 * Return value: %TRUE is @device is enabled for @widget
9438 gtk_widget_get_device_enabled (GtkWidget *widget,
9441 GList *enabled_devices;
9443 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
9444 g_return_val_if_fail (GDK_IS_DEVICE (device), FALSE);
9446 enabled_devices = g_object_get_qdata (G_OBJECT (widget), quark_enabled_devices);
9448 return g_list_find (enabled_devices, device) != NULL;
9452 gtk_widget_add_events_internal_list (GtkWidget *widget,
9459 for (l = window_list; l != NULL; l = l->next)
9461 GdkWindow *window = l->data;
9464 gdk_window_get_user_data (window, &user_data);
9465 if (user_data == widget)
9470 gdk_window_set_device_events (window, device, gdk_window_get_events (window) | events);
9472 gdk_window_set_events (window, gdk_window_get_events (window) | events);
9474 children = gdk_window_get_children (window);
9475 gtk_widget_add_events_internal_list (widget, device, events, children);
9476 g_list_free (children);
9482 gtk_widget_add_events_internal (GtkWidget *widget,
9486 GtkWidgetPrivate *priv = widget->priv;
9489 if (!gtk_widget_get_has_window (widget))
9490 window_list = gdk_window_get_children (priv->window);
9492 window_list = g_list_prepend (NULL, priv->window);
9494 gtk_widget_add_events_internal_list (widget, device, events, window_list);
9496 g_list_free (window_list);
9500 * gtk_widget_add_events:
9501 * @widget: a #GtkWidget
9502 * @events: an event mask, see #GdkEventMask
9504 * Adds the events in the bitfield @events to the event mask for
9505 * @widget. See gtk_widget_set_events() for details.
9508 gtk_widget_add_events (GtkWidget *widget,
9513 g_return_if_fail (GTK_IS_WIDGET (widget));
9515 old_events = GPOINTER_TO_INT (g_object_get_qdata (G_OBJECT (widget), quark_event_mask));
9516 g_object_set_qdata (G_OBJECT (widget), quark_event_mask,
9517 GINT_TO_POINTER (old_events | events));
9519 if (gtk_widget_get_realized (widget))
9521 gtk_widget_add_events_internal (widget, NULL, events);
9522 gtk_widget_update_devices_mask (widget, FALSE);
9525 g_object_notify (G_OBJECT (widget), "events");
9529 * gtk_widget_add_device_events:
9530 * @widget: a #GtkWidget
9531 * @device: a #GdkDevice
9532 * @events: an event mask, see #GdkEventMask
9534 * Adds the device events in the bitfield @events to the event mask for
9535 * @widget. See gtk_widget_set_device_events() for details.
9540 gtk_widget_add_device_events (GtkWidget *widget,
9542 GdkEventMask events)
9544 GdkEventMask old_events;
9545 GHashTable *device_events;
9547 g_return_if_fail (GTK_IS_WIDGET (widget));
9548 g_return_if_fail (GDK_IS_DEVICE (device));
9550 old_events = gtk_widget_get_device_events (widget, device);
9552 device_events = g_object_get_qdata (G_OBJECT (widget), quark_device_event_mask);
9554 if (G_UNLIKELY (!device_events))
9556 device_events = g_hash_table_new (NULL, NULL);
9557 g_object_set_qdata_full (G_OBJECT (widget), quark_device_event_mask, device_events,
9558 (GDestroyNotify) g_hash_table_unref);
9561 g_hash_table_insert (device_events, device,
9562 GUINT_TO_POINTER (old_events | events));
9564 if (gtk_widget_get_realized (widget))
9565 gtk_widget_add_events_internal (widget, device, events);
9567 g_object_notify (G_OBJECT (widget), "events");
9571 * gtk_widget_get_toplevel:
9572 * @widget: a #GtkWidget
9574 * This function returns the topmost widget in the container hierarchy
9575 * @widget is a part of. If @widget has no parent widgets, it will be
9576 * returned as the topmost widget. No reference will be added to the
9577 * returned widget; it should not be unreferenced.
9579 * Note the difference in behavior vs. gtk_widget_get_ancestor();
9580 * <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW)</literal>
9582 * %NULL if @widget wasn't inside a toplevel window, and if the
9583 * window was inside a #GtkWindow-derived widget which was in turn
9584 * inside the toplevel #GtkWindow. While the second case may
9585 * seem unlikely, it actually happens when a #GtkPlug is embedded
9586 * inside a #GtkSocket within the same application.
9588 * To reliably find the toplevel #GtkWindow, use
9589 * gtk_widget_get_toplevel() and check if the %TOPLEVEL flags
9590 * is set on the result.
9592 * GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
9593 * if (gtk_widget_is_toplevel (toplevel))
9595 * /* Perform action on toplevel. */
9599 * Return value: (transfer none): the topmost ancestor of @widget, or @widget itself
9600 * if there's no ancestor.
9603 gtk_widget_get_toplevel (GtkWidget *widget)
9605 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9607 while (widget->priv->parent)
9608 widget = widget->priv->parent;
9614 * gtk_widget_get_ancestor:
9615 * @widget: a #GtkWidget
9616 * @widget_type: ancestor type
9618 * Gets the first ancestor of @widget with type @widget_type. For example,
9619 * <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)</literal> gets
9620 * the first #GtkBox that's an ancestor of @widget. No reference will be
9621 * added to the returned widget; it should not be unreferenced. See note
9622 * about checking for a toplevel #GtkWindow in the docs for
9623 * gtk_widget_get_toplevel().
9625 * Note that unlike gtk_widget_is_ancestor(), gtk_widget_get_ancestor()
9626 * considers @widget to be an ancestor of itself.
9628 * Return value: (transfer none): the ancestor widget, or %NULL if not found
9631 gtk_widget_get_ancestor (GtkWidget *widget,
9634 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9636 while (widget && !g_type_is_a (G_OBJECT_TYPE (widget), widget_type))
9637 widget = widget->priv->parent;
9639 if (!(widget && g_type_is_a (G_OBJECT_TYPE (widget), widget_type)))
9646 * gtk_widget_set_visual:
9647 * @widget: a #GtkWidget
9648 * @visual: visual to be used or %NULL to unset a previous one
9650 * Sets the visual that should be used for by widget and its children for
9651 * creating #GdkWindows. The visual must be on the same #GdkScreen as
9652 * returned by gdk_widget_get_screen(), so handling the
9653 * #GtkWidget::screen-changed signal is necessary.
9655 * Setting a new @visual will not cause @widget to recreate its windows,
9656 * so you should call this function before @widget is realized.
9659 gtk_widget_set_visual (GtkWidget *widget,
9662 g_return_if_fail (GTK_IS_WIDGET (widget));
9663 g_return_if_fail (visual == NULL || GDK_IS_VISUAL (visual));
9666 g_return_if_fail (gtk_widget_get_screen (widget) == gdk_visual_get_screen (visual));
9669 g_object_set_qdata_full (G_OBJECT (widget),
9671 g_object_ref (visual),
9676 * gtk_widget_get_visual:
9677 * @widget: a #GtkWidget
9679 * Gets the visual that will be used to render @widget.
9681 * Return value: (transfer none): the visual for @widget
9684 gtk_widget_get_visual (GtkWidget *widget)
9690 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9692 if (gtk_widget_get_has_window (widget) &&
9693 widget->priv->window)
9694 return gdk_window_get_visual (widget->priv->window);
9696 screen = gtk_widget_get_screen (widget);
9698 for (w = widget; w != NULL; w = w->priv->parent)
9700 visual = g_object_get_qdata (G_OBJECT (w), quark_visual);
9703 if (gdk_visual_get_screen (visual) == screen)
9706 g_warning ("Ignoring visual set on widget `%s' that is not on the correct screen.",
9707 gtk_widget_get_name (widget));
9711 return gdk_screen_get_system_visual (screen);
9715 * gtk_widget_get_settings:
9716 * @widget: a #GtkWidget
9718 * Gets the settings object holding the settings used for this widget.
9720 * Note that this function can only be called when the #GtkWidget
9721 * is attached to a toplevel, since the settings object is specific
9722 * to a particular #GdkScreen.
9724 * Return value: (transfer none): the relevant #GtkSettings object
9727 gtk_widget_get_settings (GtkWidget *widget)
9729 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9731 return gtk_settings_get_for_screen (gtk_widget_get_screen (widget));
9735 * gtk_widget_get_events:
9736 * @widget: a #GtkWidget
9738 * Returns the event mask for the widget (a bitfield containing flags
9739 * from the #GdkEventMask enumeration). These are the events that the widget
9742 * Return value: event mask for @widget
9745 gtk_widget_get_events (GtkWidget *widget)
9747 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
9749 return GPOINTER_TO_INT (g_object_get_qdata (G_OBJECT (widget), quark_event_mask));
9753 * gtk_widget_get_device_events:
9754 * @widget: a #GtkWidget
9755 * @device: a #GdkDevice
9757 * Returns the events mask for the widget corresponding to an specific device. These
9758 * are the events that the widget will receive when @device operates on it.
9760 * Returns: device event mask for @widget
9765 gtk_widget_get_device_events (GtkWidget *widget,
9768 GHashTable *device_events;
9770 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
9771 g_return_val_if_fail (GDK_IS_DEVICE (device), 0);
9773 device_events = g_object_get_qdata (G_OBJECT (widget), quark_device_event_mask);
9778 return GPOINTER_TO_UINT (g_hash_table_lookup (device_events, device));
9782 * gtk_widget_get_pointer:
9783 * @widget: a #GtkWidget
9784 * @x: (out) (allow-none): return location for the X coordinate, or %NULL
9785 * @y: (out) (allow-none): return location for the Y coordinate, or %NULL
9787 * Obtains the location of the mouse pointer in widget coordinates.
9788 * Widget coordinates are a bit odd; for historical reasons, they are
9789 * defined as @widget->window coordinates for widgets that are not
9790 * #GTK_NO_WINDOW widgets, and are relative to @widget->allocation.x,
9791 * @widget->allocation.y for widgets that are #GTK_NO_WINDOW widgets.
9793 * Deprecated: 3.4: Use gdk_window_get_device_position() instead.
9796 gtk_widget_get_pointer (GtkWidget *widget,
9800 GtkWidgetPrivate *priv;
9802 g_return_if_fail (GTK_IS_WIDGET (widget));
9804 priv = widget->priv;
9811 if (gtk_widget_get_realized (widget))
9813 gdk_window_get_device_position (priv->window,
9814 gdk_device_manager_get_client_pointer (
9815 gdk_display_get_device_manager (
9816 gtk_widget_get_display (widget))),
9819 if (!gtk_widget_get_has_window (widget))
9822 *x -= priv->allocation.x;
9824 *y -= priv->allocation.y;
9830 * gtk_widget_is_ancestor:
9831 * @widget: a #GtkWidget
9832 * @ancestor: another #GtkWidget
9834 * Determines whether @widget is somewhere inside @ancestor, possibly with
9835 * intermediate containers.
9837 * Return value: %TRUE if @ancestor contains @widget as a child,
9838 * grandchild, great grandchild, etc.
9841 gtk_widget_is_ancestor (GtkWidget *widget,
9842 GtkWidget *ancestor)
9844 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
9845 g_return_val_if_fail (ancestor != NULL, FALSE);
9849 if (widget->priv->parent == ancestor)
9851 widget = widget->priv->parent;
9857 static GQuark quark_composite_name = 0;
9860 * gtk_widget_set_composite_name:
9861 * @widget: a #GtkWidget.
9862 * @name: the name to set
9864 * Sets a widgets composite name. The widget must be
9865 * a composite child of its parent; see gtk_widget_push_composite_child().
9868 gtk_widget_set_composite_name (GtkWidget *widget,
9871 g_return_if_fail (GTK_IS_WIDGET (widget));
9872 g_return_if_fail (widget->priv->composite_child);
9873 g_return_if_fail (name != NULL);
9875 if (!quark_composite_name)
9876 quark_composite_name = g_quark_from_static_string ("gtk-composite-name");
9878 g_object_set_qdata_full (G_OBJECT (widget),
9879 quark_composite_name,
9885 * gtk_widget_get_composite_name:
9886 * @widget: a #GtkWidget
9888 * Obtains the composite name of a widget.
9890 * Returns: the composite name of @widget, or %NULL if @widget is not
9891 * a composite child. The string should be freed when it is no
9895 gtk_widget_get_composite_name (GtkWidget *widget)
9897 GtkWidgetPrivate *priv;
9899 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9901 priv = widget->priv;
9903 if (widget->priv->composite_child && priv->parent)
9904 return _gtk_container_child_composite_name (GTK_CONTAINER (priv->parent),
9911 * gtk_widget_push_composite_child:
9913 * Makes all newly-created widgets as composite children until
9914 * the corresponding gtk_widget_pop_composite_child() call.
9916 * A composite child is a child that's an implementation detail of the
9917 * container it's inside and should not be visible to people using the
9918 * container. Composite children aren't treated differently by GTK (but
9919 * see gtk_container_foreach() vs. gtk_container_forall()), but e.g. GUI
9920 * builders might want to treat them in a different way.
9922 * Here is a simple example:
9924 * gtk_widget_push_composite_child ();
9925 * scrolled_window->hscrollbar = gtk_scrollbar_new (GTK_ORIENTATION_HORIZONTAL, hadjustment);
9926 * gtk_widget_set_composite_name (scrolled_window->hscrollbar, "hscrollbar");
9927 * gtk_widget_pop_composite_child ();
9928 * gtk_widget_set_parent (scrolled_window->hscrollbar,
9929 * GTK_WIDGET (scrolled_window));
9930 * g_object_ref (scrolled_window->hscrollbar);
9934 gtk_widget_push_composite_child (void)
9936 composite_child_stack++;
9940 * gtk_widget_pop_composite_child:
9942 * Cancels the effect of a previous call to gtk_widget_push_composite_child().
9945 gtk_widget_pop_composite_child (void)
9947 if (composite_child_stack)
9948 composite_child_stack--;
9952 gtk_widget_emit_direction_changed (GtkWidget *widget,
9953 GtkTextDirection old_dir)
9955 gtk_widget_update_pango_context (widget);
9957 if (widget->priv->context)
9958 gtk_style_context_set_direction (widget->priv->context,
9959 gtk_widget_get_direction (widget));
9961 g_signal_emit (widget, widget_signals[DIRECTION_CHANGED], 0, old_dir);
9965 * gtk_widget_set_direction:
9966 * @widget: a #GtkWidget
9967 * @dir: the new direction
9969 * Sets the reading direction on a particular widget. This direction
9970 * controls the primary direction for widgets containing text,
9971 * and also the direction in which the children of a container are
9972 * packed. The ability to set the direction is present in order
9973 * so that correct localization into languages with right-to-left
9974 * reading directions can be done. Generally, applications will
9975 * let the default reading direction present, except for containers
9976 * where the containers are arranged in an order that is explicitely
9977 * visual rather than logical (such as buttons for text justification).
9979 * If the direction is set to %GTK_TEXT_DIR_NONE, then the value
9980 * set by gtk_widget_set_default_direction() will be used.
9983 gtk_widget_set_direction (GtkWidget *widget,
9984 GtkTextDirection dir)
9986 GtkTextDirection old_dir;
9988 g_return_if_fail (GTK_IS_WIDGET (widget));
9989 g_return_if_fail (dir >= GTK_TEXT_DIR_NONE && dir <= GTK_TEXT_DIR_RTL);
9991 old_dir = gtk_widget_get_direction (widget);
9993 widget->priv->direction = dir;
9995 if (old_dir != gtk_widget_get_direction (widget))
9996 gtk_widget_emit_direction_changed (widget, old_dir);
10000 * gtk_widget_get_direction:
10001 * @widget: a #GtkWidget
10003 * Gets the reading direction for a particular widget. See
10004 * gtk_widget_set_direction().
10006 * Return value: the reading direction for the widget.
10009 gtk_widget_get_direction (GtkWidget *widget)
10011 g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_TEXT_DIR_LTR);
10013 if (widget->priv->direction == GTK_TEXT_DIR_NONE)
10014 return gtk_default_direction;
10016 return widget->priv->direction;
10020 gtk_widget_set_default_direction_recurse (GtkWidget *widget, gpointer data)
10022 GtkTextDirection old_dir = GPOINTER_TO_UINT (data);
10024 g_object_ref (widget);
10026 if (widget->priv->direction == GTK_TEXT_DIR_NONE)
10027 gtk_widget_emit_direction_changed (widget, old_dir);
10029 if (GTK_IS_CONTAINER (widget))
10030 gtk_container_forall (GTK_CONTAINER (widget),
10031 gtk_widget_set_default_direction_recurse,
10034 g_object_unref (widget);
10038 * gtk_widget_set_default_direction:
10039 * @dir: the new default direction. This cannot be
10040 * %GTK_TEXT_DIR_NONE.
10042 * Sets the default reading direction for widgets where the
10043 * direction has not been explicitly set by gtk_widget_set_direction().
10046 gtk_widget_set_default_direction (GtkTextDirection dir)
10048 g_return_if_fail (dir == GTK_TEXT_DIR_RTL || dir == GTK_TEXT_DIR_LTR);
10050 if (dir != gtk_default_direction)
10052 GList *toplevels, *tmp_list;
10053 GtkTextDirection old_dir = gtk_default_direction;
10055 gtk_default_direction = dir;
10057 tmp_list = toplevels = gtk_window_list_toplevels ();
10058 g_list_foreach (toplevels, (GFunc)g_object_ref, NULL);
10062 gtk_widget_set_default_direction_recurse (tmp_list->data,
10063 GUINT_TO_POINTER (old_dir));
10064 g_object_unref (tmp_list->data);
10065 tmp_list = tmp_list->next;
10068 g_list_free (toplevels);
10073 * gtk_widget_get_default_direction:
10075 * Obtains the current default reading direction. See
10076 * gtk_widget_set_default_direction().
10078 * Return value: the current default direction.
10081 gtk_widget_get_default_direction (void)
10083 return gtk_default_direction;
10087 gtk_widget_dispose (GObject *object)
10089 GtkWidget *widget = GTK_WIDGET (object);
10090 GtkWidgetPrivate *priv = widget->priv;
10093 gtk_container_remove (GTK_CONTAINER (priv->parent), widget);
10094 else if (gtk_widget_get_visible (widget))
10095 gtk_widget_hide (widget);
10097 priv->visible = FALSE;
10098 if (gtk_widget_get_realized (widget))
10099 gtk_widget_unrealize (widget);
10101 if (!priv->in_destruction)
10103 priv->in_destruction = TRUE;
10104 g_signal_emit (object, widget_signals[DESTROY], 0);
10105 priv->in_destruction = FALSE;
10108 G_OBJECT_CLASS (gtk_widget_parent_class)->dispose (object);
10112 gtk_widget_real_destroy (GtkWidget *object)
10114 /* gtk_object_destroy() will already hold a refcount on object */
10115 GtkWidget *widget = GTK_WIDGET (object);
10116 GtkWidgetPrivate *priv = widget->priv;
10118 if (GTK_WIDGET_GET_CLASS (widget)->priv->accessible_type != GTK_TYPE_ACCESSIBLE)
10120 GtkAccessible *accessible = g_object_steal_qdata (G_OBJECT (widget), quark_accessible_object);
10124 gtk_accessible_set_widget (accessible, NULL);
10125 g_object_unref (accessible);
10129 /* wipe accelerator closures (keep order) */
10130 g_object_set_qdata (G_OBJECT (widget), quark_accel_path, NULL);
10131 g_object_set_qdata (G_OBJECT (widget), quark_accel_closures, NULL);
10133 /* Callers of add_mnemonic_label() should disconnect on ::destroy */
10134 g_object_set_qdata (G_OBJECT (widget), quark_mnemonic_labels, NULL);
10136 gtk_grab_remove (widget);
10139 g_object_unref (priv->style);
10140 priv->style = gtk_widget_get_default_style ();
10141 g_object_ref (priv->style);
10145 gtk_widget_finalize (GObject *object)
10147 GtkWidget *widget = GTK_WIDGET (object);
10148 GtkWidgetPrivate *priv = widget->priv;
10149 GtkWidgetAuxInfo *aux_info;
10150 GtkAccessible *accessible;
10152 gtk_grab_remove (widget);
10154 g_object_unref (priv->style);
10155 priv->style = NULL;
10157 g_free (priv->name);
10159 aux_info = gtk_widget_get_aux_info (widget, FALSE);
10161 gtk_widget_aux_info_destroy (aux_info);
10163 accessible = g_object_get_qdata (G_OBJECT (widget), quark_accessible_object);
10165 g_object_unref (accessible);
10168 gtk_widget_path_free (priv->path);
10171 g_object_unref (priv->context);
10173 _gtk_widget_free_cached_sizes (widget);
10175 if (g_object_is_floating (object))
10176 g_warning ("A floating object was finalized. This means that someone\n"
10177 "called g_object_unref() on an object that had only a floating\n"
10178 "reference; the initial floating reference is not owned by anyone\n"
10179 "and must be removed with g_object_ref_sink().");
10181 G_OBJECT_CLASS (gtk_widget_parent_class)->finalize (object);
10184 /*****************************************
10185 * gtk_widget_real_map:
10190 *****************************************/
10193 gtk_widget_real_map (GtkWidget *widget)
10195 GtkWidgetPrivate *priv = widget->priv;
10197 g_assert (gtk_widget_get_realized (widget));
10199 if (!gtk_widget_get_mapped (widget))
10201 gtk_widget_set_mapped (widget, TRUE);
10203 if (gtk_widget_get_has_window (widget))
10204 gdk_window_show (priv->window);
10208 /*****************************************
10209 * gtk_widget_real_unmap:
10214 *****************************************/
10217 gtk_widget_real_unmap (GtkWidget *widget)
10219 GtkWidgetPrivate *priv = widget->priv;
10221 if (gtk_widget_get_mapped (widget))
10223 gtk_widget_set_mapped (widget, FALSE);
10225 if (gtk_widget_get_has_window (widget))
10226 gdk_window_hide (priv->window);
10230 /*****************************************
10231 * gtk_widget_real_realize:
10236 *****************************************/
10239 gtk_widget_real_realize (GtkWidget *widget)
10241 GtkWidgetPrivate *priv = widget->priv;
10243 g_assert (!gtk_widget_get_has_window (widget));
10245 gtk_widget_set_realized (widget, TRUE);
10248 priv->window = gtk_widget_get_parent_window (widget);
10249 g_object_ref (priv->window);
10253 /*****************************************
10254 * gtk_widget_real_unrealize:
10259 *****************************************/
10262 gtk_widget_real_unrealize (GtkWidget *widget)
10264 GtkWidgetPrivate *priv = widget->priv;
10266 g_assert (!widget->priv->mapped);
10268 /* printf ("unrealizing %s\n", g_type_name (G_TYPE_FROM_INSTANCE (widget)));
10271 /* We must do unrealize child widget BEFORE container widget.
10272 * gdk_window_destroy() destroys specified xwindow and its sub-xwindows.
10273 * So, unrealizing container widget bofore its children causes the problem
10274 * (for example, gdk_ic_destroy () with destroyed window causes crash. )
10277 if (GTK_IS_CONTAINER (widget))
10278 gtk_container_forall (GTK_CONTAINER (widget),
10279 (GtkCallback) gtk_widget_unrealize,
10282 if (gtk_widget_get_has_window (widget))
10284 gdk_window_set_user_data (priv->window, NULL);
10285 gdk_window_destroy (priv->window);
10286 priv->window = NULL;
10290 g_object_unref (priv->window);
10291 priv->window = NULL;
10294 gtk_selection_remove_all (widget);
10296 gtk_widget_set_realized (widget, FALSE);
10300 gtk_widget_real_adjust_size_request (GtkWidget *widget,
10301 GtkOrientation orientation,
10302 gint *minimum_size,
10303 gint *natural_size)
10305 const GtkWidgetAuxInfo *aux_info;
10307 aux_info =_gtk_widget_get_aux_info_or_defaults (widget);
10309 if (orientation == GTK_ORIENTATION_HORIZONTAL &&
10310 aux_info->width > 0)
10312 *minimum_size = MAX (*minimum_size, aux_info->width);
10314 else if (orientation == GTK_ORIENTATION_VERTICAL &&
10315 aux_info->height > 0)
10317 *minimum_size = MAX (*minimum_size, aux_info->height);
10320 /* Fix it if set_size_request made natural size smaller than min size.
10321 * This would also silently fix broken widgets, but we warn about them
10322 * in gtksizerequest.c when calling their size request vfuncs.
10324 *natural_size = MAX (*natural_size, *minimum_size);
10326 if (orientation == GTK_ORIENTATION_HORIZONTAL)
10328 *minimum_size += (aux_info->margin.left + aux_info->margin.right);
10329 *natural_size += (aux_info->margin.left + aux_info->margin.right);
10333 *minimum_size += (aux_info->margin.top + aux_info->margin.bottom);
10334 *natural_size += (aux_info->margin.top + aux_info->margin.bottom);
10339 * _gtk_widget_peek_request_cache:
10341 * Returns the address of the widget's request cache (strictly for
10342 * internal use in gtksizerequest.c)
10344 * Return value: the address of @widget's size request cache.
10347 _gtk_widget_peek_request_cache (GtkWidget *widget)
10349 /* Don't bother slowing things down with the return_if_fail guards here */
10350 return &widget->priv->requests;
10354 * _gtk_widget_set_device_window:
10355 * @widget: a #GtkWidget
10356 * @device: a #GdkDevice
10357 * @window: the new device window
10359 * Sets pointer window for @widget and @device.
10360 * Does not ref @window.
10363 _gtk_widget_set_device_window (GtkWidget *widget,
10367 GHashTable *device_window;
10369 g_return_if_fail (GTK_IS_WIDGET (widget));
10370 g_return_if_fail (GDK_IS_DEVICE (device));
10371 g_return_if_fail (window == NULL || GDK_IS_WINDOW (window));
10373 if (!gtk_widget_get_mapped (widget))
10376 device_window = g_object_get_qdata (G_OBJECT (widget), quark_pointer_window);
10378 if (!device_window && window)
10380 device_window = g_hash_table_new (NULL, NULL);
10381 g_object_set_qdata_full (G_OBJECT (widget),
10382 quark_pointer_window,
10384 (GDestroyNotify) g_hash_table_destroy);
10388 g_hash_table_insert (device_window, device, window);
10389 else if (device_window)
10391 g_hash_table_remove (device_window, device);
10393 if (g_hash_table_size (device_window) == 0)
10394 g_object_set_qdata (G_OBJECT (widget), quark_pointer_window, NULL);
10399 * _gtk_widget_get_device_window:
10400 * @widget: a #GtkWidget
10401 * @device: a #GdkDevice
10403 * Return value: the device window set on @widget, or %NULL
10406 _gtk_widget_get_device_window (GtkWidget *widget,
10409 GHashTable *device_window;
10411 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10412 g_return_val_if_fail (GDK_IS_DEVICE (device), NULL);
10414 if (!gtk_widget_get_mapped (widget))
10417 device_window = g_object_get_qdata (G_OBJECT (widget), quark_pointer_window);
10419 if (!device_window)
10422 return g_hash_table_lookup (device_window, device);
10426 * _gtk_widget_list_devices:
10427 * @widget: a #GtkWidget
10429 * Returns the list of #GdkDevices that is currently on top
10430 * of any window belonging to @widget.
10431 * Free the list with g_list_free(), the elements are owned
10432 * by GTK+ and must not be freed.
10435 _gtk_widget_list_devices (GtkWidget *widget)
10437 GHashTableIter iter;
10438 GHashTable *device_window;
10439 GList *devices = NULL;
10440 gpointer key, value;
10442 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10444 if (!gtk_widget_get_mapped (widget))
10447 device_window = g_object_get_qdata (G_OBJECT (widget), quark_pointer_window);
10449 if (G_UNLIKELY (!device_window))
10452 g_hash_table_iter_init (&iter, device_window);
10454 while (g_hash_table_iter_next (&iter, &key, &value))
10455 devices = g_list_prepend (devices, key);
10461 synth_crossing (GtkWidget *widget,
10465 GdkCrossingMode mode,
10466 GdkNotifyType detail)
10470 event = gdk_event_new (type);
10472 event->crossing.window = g_object_ref (window);
10473 event->crossing.send_event = TRUE;
10474 event->crossing.subwindow = g_object_ref (window);
10475 event->crossing.time = GDK_CURRENT_TIME;
10476 event->crossing.x = event->crossing.y = 0;
10477 event->crossing.x_root = event->crossing.y_root = 0;
10478 event->crossing.mode = mode;
10479 event->crossing.detail = detail;
10480 event->crossing.focus = FALSE;
10481 event->crossing.state = 0;
10482 gdk_event_set_device (event, device);
10485 widget = gtk_get_event_widget (event);
10488 gtk_widget_event_internal (widget, event);
10490 gdk_event_free (event);
10494 * _gtk_widget_synthesize_crossing:
10495 * @from: the #GtkWidget the virtual pointer is leaving.
10496 * @to: the #GtkWidget the virtual pointer is moving to.
10497 * @mode: the #GdkCrossingMode to place on the synthesized events.
10499 * Generate crossing event(s) on widget state (sensitivity) or GTK+ grab change.
10501 * The real pointer window is the window that most recently received an enter notify
10502 * event. Windows that don't select for crossing events can't become the real
10503 * poiner window. The real pointer widget that owns the real pointer window. The
10504 * effective pointer window is the same as the real pointer window unless the real
10505 * pointer widget is either insensitive or there is a grab on a widget that is not
10506 * an ancestor of the real pointer widget (in which case the effective pointer
10507 * window should be the root window).
10509 * When the effective pointer window is the same as the real poiner window, we
10510 * receive crossing events from the windowing system. When the effective pointer
10511 * window changes to become different from the real pointer window we synthesize
10512 * crossing events, attempting to follow X protocol rules:
10514 * When the root window becomes the effective pointer window:
10515 * - leave notify on real pointer window, detail Ancestor
10516 * - leave notify on all of its ancestors, detail Virtual
10517 * - enter notify on root window, detail Inferior
10519 * When the root window ceases to be the effective pointer window:
10520 * - leave notify on root window, detail Inferior
10521 * - enter notify on all ancestors of real pointer window, detail Virtual
10522 * - enter notify on real pointer window, detail Ancestor
10525 _gtk_widget_synthesize_crossing (GtkWidget *from,
10528 GdkCrossingMode mode)
10530 GdkWindow *from_window = NULL, *to_window = NULL;
10532 g_return_if_fail (from != NULL || to != NULL);
10536 from_window = _gtk_widget_get_device_window (from, device);
10539 from_window = from->priv->window;
10544 to_window = _gtk_widget_get_device_window (to, device);
10547 to_window = to->priv->window;
10550 if (from_window == NULL && to_window == NULL)
10552 else if (from_window != NULL && to_window == NULL)
10554 GList *from_ancestors = NULL, *list;
10555 GdkWindow *from_ancestor = from_window;
10557 while (from_ancestor != NULL)
10559 from_ancestor = gdk_window_get_effective_parent (from_ancestor);
10560 if (from_ancestor == NULL)
10562 from_ancestors = g_list_prepend (from_ancestors, from_ancestor);
10565 synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
10566 device, mode, GDK_NOTIFY_ANCESTOR);
10567 for (list = g_list_last (from_ancestors); list; list = list->prev)
10569 synth_crossing (NULL, GDK_LEAVE_NOTIFY, (GdkWindow *) list->data,
10570 device, mode, GDK_NOTIFY_VIRTUAL);
10573 /* XXX: enter/inferior on root window? */
10575 g_list_free (from_ancestors);
10577 else if (from_window == NULL && to_window != NULL)
10579 GList *to_ancestors = NULL, *list;
10580 GdkWindow *to_ancestor = to_window;
10582 while (to_ancestor != NULL)
10584 to_ancestor = gdk_window_get_effective_parent (to_ancestor);
10585 if (to_ancestor == NULL)
10587 to_ancestors = g_list_prepend (to_ancestors, to_ancestor);
10590 /* XXX: leave/inferior on root window? */
10592 for (list = to_ancestors; list; list = list->next)
10594 synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
10595 device, mode, GDK_NOTIFY_VIRTUAL);
10597 synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
10598 device, mode, GDK_NOTIFY_ANCESTOR);
10600 g_list_free (to_ancestors);
10602 else if (from_window == to_window)
10606 GList *from_ancestors = NULL, *to_ancestors = NULL, *list;
10607 GdkWindow *from_ancestor = from_window, *to_ancestor = to_window;
10609 while (from_ancestor != NULL || to_ancestor != NULL)
10611 if (from_ancestor != NULL)
10613 from_ancestor = gdk_window_get_effective_parent (from_ancestor);
10614 if (from_ancestor == to_window)
10617 from_ancestors = g_list_prepend (from_ancestors, from_ancestor);
10619 if (to_ancestor != NULL)
10621 to_ancestor = gdk_window_get_effective_parent (to_ancestor);
10622 if (to_ancestor == from_window)
10625 to_ancestors = g_list_prepend (to_ancestors, to_ancestor);
10628 if (to_ancestor == from_window)
10630 if (mode != GDK_CROSSING_GTK_UNGRAB)
10631 synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
10632 device, mode, GDK_NOTIFY_INFERIOR);
10633 for (list = to_ancestors; list; list = list->next)
10634 synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
10635 device, mode, GDK_NOTIFY_VIRTUAL);
10636 synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
10637 device, mode, GDK_NOTIFY_ANCESTOR);
10639 else if (from_ancestor == to_window)
10641 synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
10642 device, mode, GDK_NOTIFY_ANCESTOR);
10643 for (list = g_list_last (from_ancestors); list; list = list->prev)
10645 synth_crossing (NULL, GDK_LEAVE_NOTIFY, (GdkWindow *) list->data,
10646 device, mode, GDK_NOTIFY_VIRTUAL);
10648 if (mode != GDK_CROSSING_GTK_GRAB)
10649 synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
10650 device, mode, GDK_NOTIFY_INFERIOR);
10654 while (from_ancestors != NULL && to_ancestors != NULL
10655 && from_ancestors->data == to_ancestors->data)
10657 from_ancestors = g_list_delete_link (from_ancestors,
10659 to_ancestors = g_list_delete_link (to_ancestors, to_ancestors);
10662 synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
10663 device, mode, GDK_NOTIFY_NONLINEAR);
10665 for (list = g_list_last (from_ancestors); list; list = list->prev)
10667 synth_crossing (NULL, GDK_LEAVE_NOTIFY, (GdkWindow *) list->data,
10668 device, mode, GDK_NOTIFY_NONLINEAR_VIRTUAL);
10670 for (list = to_ancestors; list; list = list->next)
10672 synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
10673 device, mode, GDK_NOTIFY_NONLINEAR_VIRTUAL);
10675 synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
10676 device, mode, GDK_NOTIFY_NONLINEAR);
10678 g_list_free (from_ancestors);
10679 g_list_free (to_ancestors);
10684 gtk_widget_propagate_state (GtkWidget *widget,
10685 GtkStateData *data)
10687 GtkWidgetPrivate *priv = widget->priv;
10688 GtkStateFlags new_flags, old_flags = priv->state_flags;
10689 GtkStateType old_state;
10691 old_state = gtk_widget_get_state (widget);
10693 switch (data->operation)
10695 case STATE_CHANGE_REPLACE:
10696 priv->state_flags = data->flags;
10698 case STATE_CHANGE_SET:
10699 priv->state_flags |= data->flags;
10701 case STATE_CHANGE_UNSET:
10702 priv->state_flags &= ~(data->flags);
10706 /* make insensitivity unoverridable */
10707 if (!priv->sensitive)
10708 priv->state_flags |= GTK_STATE_FLAG_INSENSITIVE;
10710 if (gtk_widget_is_focus (widget) && !gtk_widget_is_sensitive (widget))
10714 window = gtk_widget_get_toplevel (widget);
10716 if (window && gtk_widget_is_toplevel (window))
10717 gtk_window_set_focus (GTK_WINDOW (window), NULL);
10720 new_flags = priv->state_flags;
10722 if (old_flags != new_flags)
10724 g_object_ref (widget);
10726 if (!gtk_widget_is_sensitive (widget) && gtk_widget_has_grab (widget))
10727 gtk_grab_remove (widget);
10729 gtk_style_context_set_state (gtk_widget_get_style_context (widget), new_flags);
10731 g_signal_emit (widget, widget_signals[STATE_CHANGED], 0, old_state);
10732 g_signal_emit (widget, widget_signals[STATE_FLAGS_CHANGED], 0, old_flags);
10734 if (!priv->shadowed &&
10735 (new_flags & GTK_STATE_FLAG_INSENSITIVE) != (old_flags & GTK_STATE_FLAG_INSENSITIVE))
10737 GList *event_windows = NULL;
10738 GList *devices, *d;
10740 devices = _gtk_widget_list_devices (widget);
10742 for (d = devices; d; d = d->next)
10748 window = _gtk_widget_get_device_window (widget, device);
10750 /* Do not propagate more than once to the
10751 * same window if non-multidevice aware.
10753 if (!gdk_window_get_support_multidevice (window) &&
10754 g_list_find (event_windows, window))
10757 if (!gtk_widget_is_sensitive (widget))
10758 _gtk_widget_synthesize_crossing (widget, NULL, d->data,
10759 GDK_CROSSING_STATE_CHANGED);
10761 _gtk_widget_synthesize_crossing (NULL, widget, d->data,
10762 GDK_CROSSING_STATE_CHANGED);
10764 event_windows = g_list_prepend (event_windows, window);
10767 g_list_free (event_windows);
10768 g_list_free (devices);
10771 if (GTK_IS_CONTAINER (widget))
10773 GtkStateData child_data = *data;
10775 /* Make sure to only propate the right states further */
10776 child_data.flags &= GTK_STATE_FLAGS_DO_PROPAGATE;
10778 gtk_container_forall (GTK_CONTAINER (widget),
10779 (GtkCallback) gtk_widget_propagate_state,
10783 /* Trigger state change transitions for the widget */
10784 if (priv->context &&
10785 gtk_widget_get_mapped (widget))
10787 gint diff, flag = 1;
10789 diff = old_flags ^ new_flags;
10793 if ((diff & flag) != 0)
10797 target = ((new_flags & flag) != 0);
10798 _gtk_widget_notify_state_change (widget, flag, target);
10807 g_object_unref (widget);
10811 static const GtkWidgetAuxInfo default_aux_info = {
10819 * gtk_widget_get_aux_info:
10820 * @widget: a #GtkWidget
10821 * @create: if %TRUE, create the structure if it doesn't exist
10823 * Get the #GtkWidgetAuxInfo structure for the widget.
10825 * Return value: the #GtkAuxInfo structure for the widget, or
10826 * %NULL if @create is %FALSE and one doesn't already exist.
10828 static GtkWidgetAuxInfo *
10829 gtk_widget_get_aux_info (GtkWidget *widget,
10832 GtkWidgetAuxInfo *aux_info;
10834 aux_info = g_object_get_qdata (G_OBJECT (widget), quark_aux_info);
10835 if (!aux_info && create)
10837 aux_info = g_slice_new0 (GtkWidgetAuxInfo);
10839 *aux_info = default_aux_info;
10841 g_object_set_qdata (G_OBJECT (widget), quark_aux_info, aux_info);
10847 static const GtkWidgetAuxInfo*
10848 _gtk_widget_get_aux_info_or_defaults (GtkWidget *widget)
10850 GtkWidgetAuxInfo *aux_info;
10852 aux_info = gtk_widget_get_aux_info (widget, FALSE);
10853 if (aux_info == NULL)
10855 return &default_aux_info;
10863 /*****************************************
10864 * gtk_widget_aux_info_destroy:
10869 *****************************************/
10872 gtk_widget_aux_info_destroy (GtkWidgetAuxInfo *aux_info)
10874 g_slice_free (GtkWidgetAuxInfo, aux_info);
10878 * gtk_widget_shape_combine_region:
10879 * @widget: a #GtkWidget
10880 * @region: (allow-none): shape to be added, or %NULL to remove an existing shape
10882 * Sets a shape for this widget's GDK window. This allows for
10883 * transparent windows etc., see gdk_window_shape_combine_region()
10884 * for more information.
10889 gtk_widget_shape_combine_region (GtkWidget *widget,
10890 cairo_region_t *region)
10892 GtkWidgetPrivate *priv;
10894 g_return_if_fail (GTK_IS_WIDGET (widget));
10895 /* set_shape doesn't work on widgets without gdk window */
10896 g_return_if_fail (gtk_widget_get_has_window (widget));
10898 priv = widget->priv;
10900 if (region == NULL)
10902 priv->has_shape_mask = FALSE;
10905 gdk_window_shape_combine_region (priv->window, NULL, 0, 0);
10907 g_object_set_qdata (G_OBJECT (widget), quark_shape_info, NULL);
10911 priv->has_shape_mask = TRUE;
10913 g_object_set_qdata_full (G_OBJECT (widget), quark_shape_info,
10914 cairo_region_copy (region),
10915 (GDestroyNotify) cairo_region_destroy);
10917 /* set shape if widget has a gdk window already.
10918 * otherwise the shape is scheduled to be set by gtk_widget_realize().
10921 gdk_window_shape_combine_region (priv->window, region, 0, 0);
10926 * gtk_widget_input_shape_combine_region:
10927 * @widget: a #GtkWidget
10928 * @region: (allow-none): shape to be added, or %NULL to remove an existing shape
10930 * Sets an input shape for this widget's GDK window. This allows for
10931 * windows which react to mouse click in a nonrectangular region, see
10932 * gdk_window_input_shape_combine_region() for more information.
10937 gtk_widget_input_shape_combine_region (GtkWidget *widget,
10938 cairo_region_t *region)
10940 GtkWidgetPrivate *priv;
10942 g_return_if_fail (GTK_IS_WIDGET (widget));
10943 /* set_shape doesn't work on widgets without gdk window */
10944 g_return_if_fail (gtk_widget_get_has_window (widget));
10946 priv = widget->priv;
10948 if (region == NULL)
10951 gdk_window_input_shape_combine_region (priv->window, NULL, 0, 0);
10953 g_object_set_qdata (G_OBJECT (widget), quark_input_shape_info, NULL);
10957 g_object_set_qdata_full (G_OBJECT (widget), quark_input_shape_info,
10958 cairo_region_copy (region),
10959 (GDestroyNotify) cairo_region_destroy);
10961 /* set shape if widget has a gdk window already.
10962 * otherwise the shape is scheduled to be set by gtk_widget_realize().
10965 gdk_window_input_shape_combine_region (priv->window, region, 0, 0);
10970 /* style properties
10974 * gtk_widget_class_install_style_property_parser: (skip)
10975 * @klass: a #GtkWidgetClass
10976 * @pspec: the #GParamSpec for the style property
10977 * @parser: the parser for the style property
10979 * Installs a style property on a widget class.
10982 gtk_widget_class_install_style_property_parser (GtkWidgetClass *klass,
10984 GtkRcPropertyParser parser)
10986 g_return_if_fail (GTK_IS_WIDGET_CLASS (klass));
10987 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
10988 g_return_if_fail (pspec->flags & G_PARAM_READABLE);
10989 g_return_if_fail (!(pspec->flags & (G_PARAM_CONSTRUCT_ONLY | G_PARAM_CONSTRUCT)));
10991 if (g_param_spec_pool_lookup (style_property_spec_pool, pspec->name, G_OBJECT_CLASS_TYPE (klass), FALSE))
10993 g_warning (G_STRLOC ": class `%s' already contains a style property named `%s'",
10994 G_OBJECT_CLASS_NAME (klass),
10999 g_param_spec_ref_sink (pspec);
11000 g_param_spec_set_qdata (pspec, quark_property_parser, (gpointer) parser);
11001 g_param_spec_pool_insert (style_property_spec_pool, pspec, G_OBJECT_CLASS_TYPE (klass));
11005 * gtk_widget_class_install_style_property:
11006 * @klass: a #GtkWidgetClass
11007 * @pspec: the #GParamSpec for the property
11009 * Installs a style property on a widget class. The parser for the
11010 * style property is determined by the value type of @pspec.
11013 gtk_widget_class_install_style_property (GtkWidgetClass *klass,
11016 GtkRcPropertyParser parser;
11018 g_return_if_fail (GTK_IS_WIDGET_CLASS (klass));
11019 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
11021 parser = _gtk_rc_property_parser_from_type (G_PARAM_SPEC_VALUE_TYPE (pspec));
11023 gtk_widget_class_install_style_property_parser (klass, pspec, parser);
11027 * gtk_widget_class_find_style_property:
11028 * @klass: a #GtkWidgetClass
11029 * @property_name: the name of the style property to find
11031 * Finds a style property of a widget class by name.
11033 * Returns: (transfer none): the #GParamSpec of the style property or
11034 * %NULL if @class has no style property with that name.
11039 gtk_widget_class_find_style_property (GtkWidgetClass *klass,
11040 const gchar *property_name)
11042 g_return_val_if_fail (property_name != NULL, NULL);
11044 return g_param_spec_pool_lookup (style_property_spec_pool,
11046 G_OBJECT_CLASS_TYPE (klass),
11051 * gtk_widget_class_list_style_properties:
11052 * @klass: a #GtkWidgetClass
11053 * @n_properties: location to return the number of style properties found
11055 * Returns all style properties of a widget class.
11057 * Returns: (array length=n_properties) (transfer container): a
11058 * newly allocated array of #GParamSpec*. The array must be
11059 * freed with g_free().
11064 gtk_widget_class_list_style_properties (GtkWidgetClass *klass,
11065 guint *n_properties)
11067 GParamSpec **pspecs;
11070 pspecs = g_param_spec_pool_list (style_property_spec_pool,
11071 G_OBJECT_CLASS_TYPE (klass),
11080 * gtk_widget_style_get_property:
11081 * @widget: a #GtkWidget
11082 * @property_name: the name of a style property
11083 * @value: location to return the property value
11085 * Gets the value of a style property of @widget.
11088 gtk_widget_style_get_property (GtkWidget *widget,
11089 const gchar *property_name,
11094 g_return_if_fail (GTK_IS_WIDGET (widget));
11095 g_return_if_fail (property_name != NULL);
11096 g_return_if_fail (G_IS_VALUE (value));
11098 g_object_ref (widget);
11099 pspec = g_param_spec_pool_lookup (style_property_spec_pool,
11101 G_OBJECT_TYPE (widget),
11104 g_warning ("%s: widget class `%s' has no property named `%s'",
11106 G_OBJECT_TYPE_NAME (widget),
11110 GtkStyleContext *context;
11111 const GValue *peek_value;
11112 GtkStateFlags state;
11114 context = gtk_widget_get_style_context (widget);
11115 state = gtk_widget_get_state_flags (widget);
11117 peek_value = _gtk_style_context_peek_style_property (context,
11118 G_OBJECT_TYPE (widget),
11121 /* auto-conversion of the caller's value type
11123 if (G_VALUE_TYPE (value) == G_PARAM_SPEC_VALUE_TYPE (pspec))
11124 g_value_copy (peek_value, value);
11125 else if (g_value_type_transformable (G_PARAM_SPEC_VALUE_TYPE (pspec), G_VALUE_TYPE (value)))
11126 g_value_transform (peek_value, value);
11128 g_warning ("can't retrieve style property `%s' of type `%s' as value of type `%s'",
11130 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
11131 G_VALUE_TYPE_NAME (value));
11133 g_object_unref (widget);
11137 * gtk_widget_style_get_valist:
11138 * @widget: a #GtkWidget
11139 * @first_property_name: the name of the first property to get
11140 * @var_args: a <type>va_list</type> of pairs of property names and
11141 * locations to return the property values, starting with the location
11142 * for @first_property_name.
11144 * Non-vararg variant of gtk_widget_style_get(). Used primarily by language
11148 gtk_widget_style_get_valist (GtkWidget *widget,
11149 const gchar *first_property_name,
11152 GtkStyleContext *context;
11153 GtkStateFlags state;
11156 g_return_if_fail (GTK_IS_WIDGET (widget));
11158 g_object_ref (widget);
11159 context = gtk_widget_get_style_context (widget);
11160 state = gtk_widget_get_state_flags (widget);
11162 name = first_property_name;
11165 const GValue *peek_value;
11169 pspec = g_param_spec_pool_lookup (style_property_spec_pool,
11171 G_OBJECT_TYPE (widget),
11175 g_warning ("%s: widget class `%s' has no property named `%s'",
11177 G_OBJECT_TYPE_NAME (widget),
11181 /* style pspecs are always readable so we can spare that check here */
11183 peek_value = _gtk_style_context_peek_style_property (context,
11184 G_OBJECT_TYPE (widget),
11187 G_VALUE_LCOPY (peek_value, var_args, 0, &error);
11190 g_warning ("%s: %s", G_STRLOC, error);
11195 name = va_arg (var_args, gchar*);
11198 g_object_unref (widget);
11202 * gtk_widget_style_get:
11203 * @widget: a #GtkWidget
11204 * @first_property_name: the name of the first property to get
11205 * @...: pairs of property names and locations to return the
11206 * property values, starting with the location for
11207 * @first_property_name, terminated by %NULL.
11209 * Gets the values of a multiple style properties of @widget.
11212 gtk_widget_style_get (GtkWidget *widget,
11213 const gchar *first_property_name,
11218 g_return_if_fail (GTK_IS_WIDGET (widget));
11220 va_start (var_args, first_property_name);
11221 gtk_widget_style_get_valist (widget, first_property_name, var_args);
11226 * gtk_requisition_new:
11228 * Allocates a new #GtkRequisition structure and initializes its elements to zero.
11230 * Returns: a new empty #GtkRequisition. The newly allocated #GtkRequisition should
11231 * be freed with gtk_requisition_free().
11236 gtk_requisition_new (void)
11238 return g_slice_new0 (GtkRequisition);
11242 * gtk_requisition_copy:
11243 * @requisition: a #GtkRequisition
11245 * Copies a #GtkRequisition.
11247 * Returns: a copy of @requisition
11250 gtk_requisition_copy (const GtkRequisition *requisition)
11252 return g_slice_dup (GtkRequisition, requisition);
11256 * gtk_requisition_free:
11257 * @requisition: a #GtkRequisition
11259 * Frees a #GtkRequisition.
11262 gtk_requisition_free (GtkRequisition *requisition)
11264 g_slice_free (GtkRequisition, requisition);
11267 G_DEFINE_BOXED_TYPE (GtkRequisition, gtk_requisition,
11268 gtk_requisition_copy,
11269 gtk_requisition_free)
11272 * gtk_widget_class_set_accessible_type:
11273 * @widget_class: class to set the accessible type for
11274 * @type: The object type that implements the accessible for @widget_class
11276 * Sets the type to be used for creating accessibles for widgets of
11277 * @widget_class. The given @type must be a subtype of the type used for
11278 * accessibles of the parent class.
11280 * This function should only be called from class init functions of widgets.
11285 gtk_widget_class_set_accessible_type (GtkWidgetClass *widget_class,
11288 GtkWidgetClassPrivate *priv;
11290 g_return_if_fail (GTK_IS_WIDGET_CLASS (widget_class));
11291 g_return_if_fail (g_type_is_a (type, widget_class->priv->accessible_type));
11293 priv = widget_class->priv;
11295 priv->accessible_type = type;
11296 /* reset this - honoring the type's role is better. */
11297 priv->accessible_role = ATK_ROLE_INVALID;
11301 * gtk_widget_class_set_accessible_role:
11302 * @widget_class: class to set the accessible role for
11303 * @role: The role to use for accessibles created for @widget_class
11305 * Sets the default #AtkRole to be set on accessibles created for
11306 * widgets of @widget_class. Accessibles may decide to not honor this
11307 * setting if their role reporting is more refined. Calls to
11308 * gtk_widget_class_set_accessible_type() will reset this value.
11310 * In cases where you want more fine-grained control over the role of
11311 * accessibles created for @widget_class, you should provide your own
11312 * accessible type and use gtk_widget_class_set_accessible_type()
11315 * If @role is #ATK_ROLE_INVALID, the default role will not be changed
11316 * and the accessible's default role will be used instead.
11318 * This function should only be called from class init functions of widgets.
11323 gtk_widget_class_set_accessible_role (GtkWidgetClass *widget_class,
11326 GtkWidgetClassPrivate *priv;
11328 g_return_if_fail (GTK_IS_WIDGET_CLASS (widget_class));
11330 priv = widget_class->priv;
11332 priv->accessible_role = role;
11336 * _gtk_widget_peek_accessible:
11337 * @widget: a #GtkWidget
11339 * Gets the accessible for @widget, if it has been created yet.
11340 * Otherwise, this function returns %NULL. If the @widget's implementation
11341 * does not use the default way to create accessibles, %NULL will always be
11344 * Returns: the accessible for @widget or %NULL if none has been
11348 _gtk_widget_peek_accessible (GtkWidget *widget)
11350 return g_object_get_qdata (G_OBJECT (widget),
11351 quark_accessible_object);
11355 * gtk_widget_get_accessible:
11356 * @widget: a #GtkWidget
11358 * Returns the accessible object that describes the widget to an
11359 * assistive technology.
11361 * If accessibility support is not available, this #AtkObject
11362 * instance may be a no-op. Likewise, if no class-specific #AtkObject
11363 * implementation is available for the widget instance in question,
11364 * it will inherit an #AtkObject implementation from the first ancestor
11365 * class for which such an implementation is defined.
11367 * The documentation of the
11368 * <ulink url="http://library.gnome.org/devel/atk/stable/">ATK</ulink>
11369 * library contains more information about accessible objects and their uses.
11371 * Returns: (transfer none): the #AtkObject associated with @widget
11374 gtk_widget_get_accessible (GtkWidget *widget)
11376 GtkWidgetClass *klass;
11378 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
11380 klass = GTK_WIDGET_GET_CLASS (widget);
11382 g_return_val_if_fail (klass->get_accessible != NULL, NULL);
11384 return klass->get_accessible (widget);
11388 gtk_widget_real_get_accessible (GtkWidget *widget)
11390 AtkObject* accessible;
11392 accessible = g_object_get_qdata (G_OBJECT (widget),
11393 quark_accessible_object);
11396 GtkWidgetClass *widget_class;
11397 GtkWidgetClassPrivate *priv;
11398 AtkObjectFactory *factory;
11399 AtkRegistry *default_registry;
11401 widget_class = GTK_WIDGET_GET_CLASS (widget);
11402 priv = widget_class->priv;
11404 if (priv->accessible_type == GTK_TYPE_ACCESSIBLE)
11406 default_registry = atk_get_default_registry ();
11407 factory = atk_registry_get_factory (default_registry,
11408 G_TYPE_FROM_INSTANCE (widget));
11410 atk_object_factory_create_accessible (factory,
11411 G_OBJECT (widget));
11413 if (priv->accessible_role != ATK_ROLE_INVALID)
11414 atk_object_set_role (accessible, priv->accessible_role);
11416 g_object_set_qdata (G_OBJECT (widget),
11417 quark_accessible_object,
11422 accessible = g_object_new (priv->accessible_type,
11425 if (priv->accessible_role != ATK_ROLE_INVALID)
11426 atk_object_set_role (accessible, priv->accessible_role);
11428 g_object_set_qdata (G_OBJECT (widget),
11429 quark_accessible_object,
11432 atk_object_initialize (accessible, widget);
11434 /* Set the role again, since we don't want a role set
11435 * in some parent initialize() function to override
11438 if (priv->accessible_role != ATK_ROLE_INVALID)
11439 atk_object_set_role (accessible, priv->accessible_role);
11446 * Initialize a AtkImplementorIface instance's virtual pointers as
11447 * appropriate to this implementor's class (GtkWidget).
11450 gtk_widget_accessible_interface_init (AtkImplementorIface *iface)
11452 iface->ref_accessible = gtk_widget_ref_accessible;
11456 gtk_widget_ref_accessible (AtkImplementor *implementor)
11458 AtkObject *accessible;
11460 accessible = gtk_widget_get_accessible (GTK_WIDGET (implementor));
11462 g_object_ref (accessible);
11467 * Expand flag management
11471 gtk_widget_update_computed_expand (GtkWidget *widget)
11473 GtkWidgetPrivate *priv;
11475 priv = widget->priv;
11477 if (priv->need_compute_expand)
11481 if (priv->hexpand_set)
11486 if (priv->vexpand_set)
11491 /* we don't need to use compute_expand if both expands are
11492 * forced by the app
11494 if (!(priv->hexpand_set && priv->vexpand_set))
11496 if (GTK_WIDGET_GET_CLASS (widget)->compute_expand != NULL)
11500 GTK_WIDGET_GET_CLASS (widget)->compute_expand (widget,
11501 priv->hexpand_set ? &ignored : &h,
11502 priv->vexpand_set ? &ignored : &v);
11506 priv->need_compute_expand = FALSE;
11507 priv->computed_hexpand = h != FALSE;
11508 priv->computed_vexpand = v != FALSE;
11513 * gtk_widget_queue_compute_expand:
11514 * @widget: a #GtkWidget
11516 * Mark @widget as needing to recompute its expand flags. Call
11517 * this function when setting legacy expand child properties
11518 * on the child of a container.
11520 * See gtk_widget_compute_expand().
11523 gtk_widget_queue_compute_expand (GtkWidget *widget)
11526 gboolean changed_anything;
11528 if (widget->priv->need_compute_expand)
11531 changed_anything = FALSE;
11533 while (parent != NULL)
11535 if (!parent->priv->need_compute_expand)
11537 parent->priv->need_compute_expand = TRUE;
11538 changed_anything = TRUE;
11541 /* Note: if we had an invariant that "if a child needs to
11542 * compute expand, its parents also do" then we could stop going
11543 * up when we got to a parent that already needed to
11544 * compute. However, in general we compute expand lazily (as
11545 * soon as we see something in a subtree that is expand, we know
11546 * we're expanding) and so this invariant does not hold and we
11547 * have to always walk all the way up in case some ancestor
11548 * is not currently need_compute_expand.
11551 parent = parent->priv->parent;
11554 /* recomputing expand always requires
11555 * a relayout as well
11557 if (changed_anything)
11558 gtk_widget_queue_resize (widget);
11562 * gtk_widget_compute_expand:
11563 * @widget: the widget
11564 * @orientation: expand direction
11566 * Computes whether a container should give this widget extra space
11567 * when possible. Containers should check this, rather than
11568 * looking at gtk_widget_get_hexpand() or gtk_widget_get_vexpand().
11570 * This function already checks whether the widget is visible, so
11571 * visibility does not need to be checked separately. Non-visible
11572 * widgets are not expanded.
11574 * The computed expand value uses either the expand setting explicitly
11575 * set on the widget itself, or, if none has been explicitly set,
11576 * the widget may expand if some of its children do.
11578 * Return value: whether widget tree rooted here should be expanded
11581 gtk_widget_compute_expand (GtkWidget *widget,
11582 GtkOrientation orientation)
11584 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
11586 /* We never make a widget expand if not even showing. */
11587 if (!gtk_widget_get_visible (widget))
11590 gtk_widget_update_computed_expand (widget);
11592 if (orientation == GTK_ORIENTATION_HORIZONTAL)
11594 return widget->priv->computed_hexpand;
11598 return widget->priv->computed_vexpand;
11603 gtk_widget_set_expand (GtkWidget *widget,
11604 GtkOrientation orientation,
11607 const char *expand_prop;
11608 const char *expand_set_prop;
11610 GtkWidgetPrivate *priv;
11612 g_return_if_fail (GTK_IS_WIDGET (widget));
11614 priv = widget->priv;
11616 expand = expand != FALSE;
11618 was_both = priv->hexpand && priv->vexpand;
11620 if (orientation == GTK_ORIENTATION_HORIZONTAL)
11622 if (priv->hexpand_set &&
11623 priv->hexpand == expand)
11626 priv->hexpand_set = TRUE;
11627 priv->hexpand = expand;
11629 expand_prop = "hexpand";
11630 expand_set_prop = "hexpand-set";
11634 if (priv->vexpand_set &&
11635 priv->vexpand == expand)
11638 priv->vexpand_set = TRUE;
11639 priv->vexpand = expand;
11641 expand_prop = "vexpand";
11642 expand_set_prop = "vexpand-set";
11645 gtk_widget_queue_compute_expand (widget);
11647 g_object_freeze_notify (G_OBJECT (widget));
11648 g_object_notify (G_OBJECT (widget), expand_prop);
11649 g_object_notify (G_OBJECT (widget), expand_set_prop);
11650 if (was_both != (priv->hexpand && priv->vexpand))
11651 g_object_notify (G_OBJECT (widget), "expand");
11652 g_object_thaw_notify (G_OBJECT (widget));
11656 gtk_widget_set_expand_set (GtkWidget *widget,
11657 GtkOrientation orientation,
11660 GtkWidgetPrivate *priv;
11663 priv = widget->priv;
11665 set = set != FALSE;
11667 if (orientation == GTK_ORIENTATION_HORIZONTAL)
11669 if (set == priv->hexpand_set)
11672 priv->hexpand_set = set;
11673 prop = "hexpand-set";
11677 if (set == priv->vexpand_set)
11680 priv->vexpand_set = set;
11681 prop = "vexpand-set";
11684 gtk_widget_queue_compute_expand (widget);
11686 g_object_notify (G_OBJECT (widget), prop);
11690 * gtk_widget_get_hexpand:
11691 * @widget: the widget
11693 * Gets whether the widget would like any available extra horizontal
11694 * space. When a user resizes a #GtkWindow, widgets with expand=TRUE
11695 * generally receive the extra space. For example, a list or
11696 * scrollable area or document in your window would often be set to
11699 * Containers should use gtk_widget_compute_expand() rather than
11700 * this function, to see whether a widget, or any of its children,
11701 * has the expand flag set. If any child of a widget wants to
11702 * expand, the parent may ask to expand also.
11704 * This function only looks at the widget's own hexpand flag, rather
11705 * than computing whether the entire widget tree rooted at this widget
11708 * Return value: whether hexpand flag is set
11711 gtk_widget_get_hexpand (GtkWidget *widget)
11713 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
11715 return widget->priv->hexpand;
11719 * gtk_widget_set_hexpand:
11720 * @widget: the widget
11721 * @expand: whether to expand
11723 * Sets whether the widget would like any available extra horizontal
11724 * space. When a user resizes a #GtkWindow, widgets with expand=TRUE
11725 * generally receive the extra space. For example, a list or
11726 * scrollable area or document in your window would often be set to
11729 * Call this function to set the expand flag if you would like your
11730 * widget to become larger horizontally when the window has extra
11733 * By default, widgets automatically expand if any of their children
11734 * want to expand. (To see if a widget will automatically expand given
11735 * its current children and state, call gtk_widget_compute_expand(). A
11736 * container can decide how the expandability of children affects the
11737 * expansion of the container by overriding the compute_expand virtual
11738 * method on #GtkWidget.).
11740 * Setting hexpand explicitly with this function will override the
11741 * automatic expand behavior.
11743 * This function forces the widget to expand or not to expand,
11744 * regardless of children. The override occurs because
11745 * gtk_widget_set_hexpand() sets the hexpand-set property (see
11746 * gtk_widget_set_hexpand_set()) which causes the widget's hexpand
11747 * value to be used, rather than looking at children and widget state.
11750 gtk_widget_set_hexpand (GtkWidget *widget,
11753 g_return_if_fail (GTK_IS_WIDGET (widget));
11755 gtk_widget_set_expand (widget, GTK_ORIENTATION_HORIZONTAL, expand);
11759 * gtk_widget_get_hexpand_set:
11760 * @widget: the widget
11762 * Gets whether gtk_widget_set_hexpand() has been used to
11763 * explicitly set the expand flag on this widget.
11765 * If hexpand is set, then it overrides any computed
11766 * expand value based on child widgets. If hexpand is not
11767 * set, then the expand value depends on whether any
11768 * children of the widget would like to expand.
11770 * There are few reasons to use this function, but it's here
11771 * for completeness and consistency.
11773 * Return value: whether hexpand has been explicitly set
11776 gtk_widget_get_hexpand_set (GtkWidget *widget)
11778 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
11780 return widget->priv->hexpand_set;
11784 * gtk_widget_set_hexpand_set:
11785 * @widget: the widget
11786 * @set: value for hexpand-set property
11788 * Sets whether the hexpand flag (see gtk_widget_get_hexpand()) will
11791 * The hexpand-set property will be set automatically when you call
11792 * gtk_widget_set_hexpand() to set hexpand, so the most likely
11793 * reason to use this function would be to unset an explicit expand
11796 * If hexpand is set, then it overrides any computed
11797 * expand value based on child widgets. If hexpand is not
11798 * set, then the expand value depends on whether any
11799 * children of the widget would like to expand.
11801 * There are few reasons to use this function, but it's here
11802 * for completeness and consistency.
11805 gtk_widget_set_hexpand_set (GtkWidget *widget,
11808 g_return_if_fail (GTK_IS_WIDGET (widget));
11810 gtk_widget_set_expand_set (widget, GTK_ORIENTATION_HORIZONTAL, set);
11815 * gtk_widget_get_vexpand:
11816 * @widget: the widget
11818 * Gets whether the widget would like any available extra vertical
11821 * See gtk_widget_get_hexpand() for more detail.
11823 * Return value: whether vexpand flag is set
11826 gtk_widget_get_vexpand (GtkWidget *widget)
11828 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
11830 return widget->priv->vexpand;
11834 * gtk_widget_set_vexpand:
11835 * @widget: the widget
11836 * @expand: whether to expand
11838 * Sets whether the widget would like any available extra vertical
11841 * See gtk_widget_set_hexpand() for more detail.
11844 gtk_widget_set_vexpand (GtkWidget *widget,
11847 g_return_if_fail (GTK_IS_WIDGET (widget));
11849 gtk_widget_set_expand (widget, GTK_ORIENTATION_VERTICAL, expand);
11853 * gtk_widget_get_vexpand_set:
11854 * @widget: the widget
11856 * Gets whether gtk_widget_set_vexpand() has been used to
11857 * explicitly set the expand flag on this widget.
11859 * See gtk_widget_get_hexpand_set() for more detail.
11861 * Return value: whether vexpand has been explicitly set
11864 gtk_widget_get_vexpand_set (GtkWidget *widget)
11866 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
11868 return widget->priv->vexpand_set;
11872 * gtk_widget_set_vexpand_set:
11873 * @widget: the widget
11874 * @set: value for vexpand-set property
11876 * Sets whether the vexpand flag (see gtk_widget_get_vexpand()) will
11879 * See gtk_widget_set_hexpand_set() for more detail.
11882 gtk_widget_set_vexpand_set (GtkWidget *widget,
11885 g_return_if_fail (GTK_IS_WIDGET (widget));
11887 gtk_widget_set_expand_set (widget, GTK_ORIENTATION_VERTICAL, set);
11891 * GtkBuildable implementation
11893 static GQuark quark_builder_has_default = 0;
11894 static GQuark quark_builder_has_focus = 0;
11895 static GQuark quark_builder_atk_relations = 0;
11896 static GQuark quark_builder_set_name = 0;
11899 gtk_widget_buildable_interface_init (GtkBuildableIface *iface)
11901 quark_builder_has_default = g_quark_from_static_string ("gtk-builder-has-default");
11902 quark_builder_has_focus = g_quark_from_static_string ("gtk-builder-has-focus");
11903 quark_builder_atk_relations = g_quark_from_static_string ("gtk-builder-atk-relations");
11904 quark_builder_set_name = g_quark_from_static_string ("gtk-builder-set-name");
11906 iface->set_name = gtk_widget_buildable_set_name;
11907 iface->get_name = gtk_widget_buildable_get_name;
11908 iface->get_internal_child = gtk_widget_buildable_get_internal_child;
11909 iface->set_buildable_property = gtk_widget_buildable_set_buildable_property;
11910 iface->parser_finished = gtk_widget_buildable_parser_finished;
11911 iface->custom_tag_start = gtk_widget_buildable_custom_tag_start;
11912 iface->custom_finished = gtk_widget_buildable_custom_finished;
11916 gtk_widget_buildable_set_name (GtkBuildable *buildable,
11919 g_object_set_qdata_full (G_OBJECT (buildable), quark_builder_set_name,
11920 g_strdup (name), g_free);
11923 static const gchar *
11924 gtk_widget_buildable_get_name (GtkBuildable *buildable)
11926 return g_object_get_qdata (G_OBJECT (buildable), quark_builder_set_name);
11930 gtk_widget_buildable_get_internal_child (GtkBuildable *buildable,
11931 GtkBuilder *builder,
11932 const gchar *childname)
11934 if (strcmp (childname, "accessible") == 0)
11935 return G_OBJECT (gtk_widget_get_accessible (GTK_WIDGET (buildable)));
11941 gtk_widget_buildable_set_buildable_property (GtkBuildable *buildable,
11942 GtkBuilder *builder,
11944 const GValue *value)
11946 if (strcmp (name, "has-default") == 0 && g_value_get_boolean (value))
11947 g_object_set_qdata (G_OBJECT (buildable), quark_builder_has_default,
11948 GINT_TO_POINTER (TRUE));
11949 else if (strcmp (name, "has-focus") == 0 && g_value_get_boolean (value))
11950 g_object_set_qdata (G_OBJECT (buildable), quark_builder_has_focus,
11951 GINT_TO_POINTER (TRUE));
11953 g_object_set_property (G_OBJECT (buildable), name, value);
11958 gchar *action_name;
11959 GString *description;
11961 gboolean translatable;
11971 free_action (AtkActionData *data, gpointer user_data)
11973 g_free (data->action_name);
11974 g_string_free (data->description, TRUE);
11975 g_free (data->context);
11976 g_slice_free (AtkActionData, data);
11980 free_relation (AtkRelationData *data, gpointer user_data)
11982 g_free (data->target);
11983 g_free (data->type);
11984 g_slice_free (AtkRelationData, data);
11988 gtk_widget_buildable_parser_finished (GtkBuildable *buildable,
11989 GtkBuilder *builder)
11991 GSList *atk_relations;
11993 if (g_object_get_qdata (G_OBJECT (buildable), quark_builder_has_default))
11994 gtk_widget_grab_default (GTK_WIDGET (buildable));
11995 if (g_object_get_qdata (G_OBJECT (buildable), quark_builder_has_focus))
11996 gtk_widget_grab_focus (GTK_WIDGET (buildable));
11998 atk_relations = g_object_get_qdata (G_OBJECT (buildable),
11999 quark_builder_atk_relations);
12002 AtkObject *accessible;
12003 AtkRelationSet *relation_set;
12006 AtkRelationType relation_type;
12007 AtkObject *target_accessible;
12009 accessible = gtk_widget_get_accessible (GTK_WIDGET (buildable));
12010 relation_set = atk_object_ref_relation_set (accessible);
12012 for (l = atk_relations; l; l = l->next)
12014 AtkRelationData *relation = (AtkRelationData*)l->data;
12016 target = gtk_builder_get_object (builder, relation->target);
12019 g_warning ("Target object %s in <relation> does not exist",
12023 target_accessible = gtk_widget_get_accessible (GTK_WIDGET (target));
12024 g_assert (target_accessible != NULL);
12026 relation_type = atk_relation_type_for_name (relation->type);
12027 if (relation_type == ATK_RELATION_NULL)
12029 g_warning ("<relation> type %s not found",
12033 atk_relation_set_add_relation_by_type (relation_set, relation_type,
12034 target_accessible);
12036 g_object_unref (relation_set);
12038 g_slist_free_full (atk_relations, (GDestroyNotify) free_relation);
12039 g_object_set_qdata (G_OBJECT (buildable), quark_builder_atk_relations,
12048 } AccessibilitySubParserData;
12051 accessibility_start_element (GMarkupParseContext *context,
12052 const gchar *element_name,
12053 const gchar **names,
12054 const gchar **values,
12055 gpointer user_data,
12058 AccessibilitySubParserData *data = (AccessibilitySubParserData*)user_data;
12060 gint line_number, char_number;
12062 if (strcmp (element_name, "relation") == 0)
12064 gchar *target = NULL;
12065 gchar *type = NULL;
12066 AtkRelationData *relation;
12068 for (i = 0; names[i]; i++)
12070 if (strcmp (names[i], "target") == 0)
12071 target = g_strdup (values[i]);
12072 else if (strcmp (names[i], "type") == 0)
12073 type = g_strdup (values[i]);
12076 g_markup_parse_context_get_position (context,
12079 g_set_error (error,
12081 GTK_BUILDER_ERROR_INVALID_ATTRIBUTE,
12082 "%s:%d:%d '%s' is not a valid attribute of <%s>",
12084 line_number, char_number, names[i], "relation");
12091 if (!target || !type)
12093 g_markup_parse_context_get_position (context,
12096 g_set_error (error,
12098 GTK_BUILDER_ERROR_MISSING_ATTRIBUTE,
12099 "%s:%d:%d <%s> requires attribute \"%s\"",
12101 line_number, char_number, "relation",
12102 type ? "target" : "type");
12108 relation = g_slice_new (AtkRelationData);
12109 relation->target = target;
12110 relation->type = type;
12112 data->relations = g_slist_prepend (data->relations, relation);
12114 else if (strcmp (element_name, "action") == 0)
12116 const gchar *action_name = NULL;
12117 const gchar *description = NULL;
12118 const gchar *msg_context = NULL;
12119 gboolean translatable = FALSE;
12120 AtkActionData *action;
12122 for (i = 0; names[i]; i++)
12124 if (strcmp (names[i], "action_name") == 0)
12125 action_name = values[i];
12126 else if (strcmp (names[i], "description") == 0)
12127 description = values[i];
12128 else if (strcmp (names[i], "translatable") == 0)
12130 if (!_gtk_builder_boolean_from_string (values[i], &translatable, error))
12133 else if (strcmp (names[i], "comments") == 0)
12135 /* do nothing, comments are for translators */
12137 else if (strcmp (names[i], "context") == 0)
12138 msg_context = values[i];
12141 g_markup_parse_context_get_position (context,
12144 g_set_error (error,
12146 GTK_BUILDER_ERROR_INVALID_ATTRIBUTE,
12147 "%s:%d:%d '%s' is not a valid attribute of <%s>",
12149 line_number, char_number, names[i], "action");
12156 g_markup_parse_context_get_position (context,
12159 g_set_error (error,
12161 GTK_BUILDER_ERROR_MISSING_ATTRIBUTE,
12162 "%s:%d:%d <%s> requires attribute \"%s\"",
12164 line_number, char_number, "action",
12169 action = g_slice_new (AtkActionData);
12170 action->action_name = g_strdup (action_name);
12171 action->description = g_string_new (description);
12172 action->context = g_strdup (msg_context);
12173 action->translatable = translatable;
12175 data->actions = g_slist_prepend (data->actions, action);
12177 else if (strcmp (element_name, "accessibility") == 0)
12180 g_warning ("Unsupported tag for GtkWidget: %s\n", element_name);
12184 accessibility_text (GMarkupParseContext *context,
12187 gpointer user_data,
12190 AccessibilitySubParserData *data = (AccessibilitySubParserData*)user_data;
12192 if (strcmp (g_markup_parse_context_get_element (context), "action") == 0)
12194 AtkActionData *action = data->actions->data;
12196 g_string_append_len (action->description, text, text_len);
12200 static const GMarkupParser accessibility_parser =
12202 accessibility_start_element,
12204 accessibility_text,
12213 } AccelGroupParserData;
12216 accel_group_start_element (GMarkupParseContext *context,
12217 const gchar *element_name,
12218 const gchar **names,
12219 const gchar **values,
12220 gpointer user_data,
12225 guint modifiers = 0;
12226 gchar *signal = NULL;
12227 AccelGroupParserData *parser_data = (AccelGroupParserData*)user_data;
12229 for (i = 0; names[i]; i++)
12231 if (strcmp (names[i], "key") == 0)
12232 key = gdk_keyval_from_name (values[i]);
12233 else if (strcmp (names[i], "modifiers") == 0)
12235 if (!_gtk_builder_flags_from_string (GDK_TYPE_MODIFIER_TYPE,
12241 else if (strcmp (names[i], "signal") == 0)
12242 signal = g_strdup (values[i]);
12245 if (key == 0 || signal == NULL)
12247 g_warning ("<accelerator> requires key and signal attributes");
12250 parser_data->key = key;
12251 parser_data->modifiers = modifiers;
12252 parser_data->signal = signal;
12255 static const GMarkupParser accel_group_parser =
12257 accel_group_start_element,
12266 style_start_element (GMarkupParseContext *context,
12267 const gchar *element_name,
12268 const gchar **names,
12269 const gchar **values,
12270 gpointer user_data,
12273 StyleParserData *style_data = (StyleParserData *)user_data;
12276 if (strcmp (element_name, "class") == 0)
12278 if (g_markup_collect_attributes (element_name,
12282 G_MARKUP_COLLECT_STRDUP, "name", &class_name,
12283 G_MARKUP_COLLECT_INVALID))
12285 style_data->classes = g_slist_append (style_data->classes, class_name);
12288 else if (strcmp (element_name, "style") == 0)
12291 g_warning ("Unsupported tag for GtkWidget: %s\n", element_name);
12294 static const GMarkupParser style_parser =
12296 style_start_element,
12300 gtk_widget_buildable_custom_tag_start (GtkBuildable *buildable,
12301 GtkBuilder *builder,
12303 const gchar *tagname,
12304 GMarkupParser *parser,
12307 g_assert (buildable);
12309 if (strcmp (tagname, "accelerator") == 0)
12311 AccelGroupParserData *parser_data;
12313 parser_data = g_slice_new0 (AccelGroupParserData);
12314 parser_data->object = g_object_ref (buildable);
12315 *parser = accel_group_parser;
12316 *data = parser_data;
12319 if (strcmp (tagname, "accessibility") == 0)
12321 AccessibilitySubParserData *parser_data;
12323 parser_data = g_slice_new0 (AccessibilitySubParserData);
12324 *parser = accessibility_parser;
12325 *data = parser_data;
12328 if (strcmp (tagname, "style") == 0)
12330 StyleParserData *parser_data;
12332 parser_data = g_slice_new0 (StyleParserData);
12333 *parser = style_parser;
12334 *data = parser_data;
12342 _gtk_widget_buildable_finish_accelerator (GtkWidget *widget,
12343 GtkWidget *toplevel,
12344 gpointer user_data)
12346 AccelGroupParserData *accel_data;
12347 GSList *accel_groups;
12348 GtkAccelGroup *accel_group;
12350 g_return_if_fail (GTK_IS_WIDGET (widget));
12351 g_return_if_fail (GTK_IS_WIDGET (toplevel));
12352 g_return_if_fail (user_data != NULL);
12354 accel_data = (AccelGroupParserData*)user_data;
12355 accel_groups = gtk_accel_groups_from_object (G_OBJECT (toplevel));
12356 if (g_slist_length (accel_groups) == 0)
12358 accel_group = gtk_accel_group_new ();
12359 gtk_window_add_accel_group (GTK_WINDOW (toplevel), accel_group);
12363 g_assert (g_slist_length (accel_groups) == 1);
12364 accel_group = g_slist_nth_data (accel_groups, 0);
12367 gtk_widget_add_accelerator (GTK_WIDGET (accel_data->object),
12368 accel_data->signal,
12371 accel_data->modifiers,
12372 GTK_ACCEL_VISIBLE);
12374 g_object_unref (accel_data->object);
12375 g_free (accel_data->signal);
12376 g_slice_free (AccelGroupParserData, accel_data);
12380 gtk_widget_buildable_custom_finished (GtkBuildable *buildable,
12381 GtkBuilder *builder,
12383 const gchar *tagname,
12384 gpointer user_data)
12386 if (strcmp (tagname, "accelerator") == 0)
12388 AccelGroupParserData *accel_data;
12389 GtkWidget *toplevel;
12391 accel_data = (AccelGroupParserData*)user_data;
12392 g_assert (accel_data->object);
12394 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (accel_data->object));
12396 _gtk_widget_buildable_finish_accelerator (GTK_WIDGET (buildable), toplevel, user_data);
12398 else if (strcmp (tagname, "accessibility") == 0)
12400 AccessibilitySubParserData *a11y_data;
12402 a11y_data = (AccessibilitySubParserData*)user_data;
12404 if (a11y_data->actions)
12406 AtkObject *accessible;
12411 accessible = gtk_widget_get_accessible (GTK_WIDGET (buildable));
12413 if (ATK_IS_ACTION (accessible))
12415 action = ATK_ACTION (accessible);
12416 n_actions = atk_action_get_n_actions (action);
12418 for (l = a11y_data->actions; l; l = l->next)
12420 AtkActionData *action_data = (AtkActionData*)l->data;
12422 for (i = 0; i < n_actions; i++)
12423 if (strcmp (atk_action_get_name (action, i),
12424 action_data->action_name) == 0)
12429 gchar *description;
12431 if (action_data->translatable && action_data->description->len)
12432 description = _gtk_builder_parser_translate (gtk_builder_get_translation_domain (builder),
12433 action_data->context,
12434 action_data->description->str);
12436 description = action_data->description->str;
12438 atk_action_set_description (action, i, description);
12443 g_warning ("accessibility action on a widget that does not implement AtkAction");
12445 g_slist_free_full (a11y_data->actions, (GDestroyNotify) free_action);
12448 if (a11y_data->relations)
12449 g_object_set_qdata (G_OBJECT (buildable), quark_builder_atk_relations,
12450 a11y_data->relations);
12452 g_slice_free (AccessibilitySubParserData, a11y_data);
12454 else if (strcmp (tagname, "style") == 0)
12456 StyleParserData *style_data = (StyleParserData *)user_data;
12457 GtkStyleContext *context;
12460 context = gtk_widget_get_style_context (GTK_WIDGET (buildable));
12462 for (l = style_data->classes; l; l = l->next)
12463 gtk_style_context_add_class (context, (const gchar *)l->data);
12465 gtk_widget_reset_style (GTK_WIDGET (buildable));
12467 g_slist_free_full (style_data->classes, g_free);
12468 g_slice_free (StyleParserData, style_data);
12472 static GtkSizeRequestMode
12473 gtk_widget_real_get_request_mode (GtkWidget *widget)
12475 /* By default widgets dont trade size at all. */
12476 return GTK_SIZE_REQUEST_CONSTANT_SIZE;
12480 gtk_widget_real_get_width (GtkWidget *widget,
12481 gint *minimum_size,
12482 gint *natural_size)
12492 gtk_widget_real_get_height (GtkWidget *widget,
12493 gint *minimum_size,
12494 gint *natural_size)
12504 gtk_widget_real_get_height_for_width (GtkWidget *widget,
12506 gint *minimum_height,
12507 gint *natural_height)
12509 GTK_WIDGET_GET_CLASS (widget)->get_preferred_height (widget, minimum_height, natural_height);
12513 gtk_widget_real_get_width_for_height (GtkWidget *widget,
12515 gint *minimum_width,
12516 gint *natural_width)
12518 GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, minimum_width, natural_width);
12522 * gtk_widget_get_halign:
12523 * @widget: a #GtkWidget
12525 * Gets the value of the #GtkWidget:halign property.
12527 * Returns: the horizontal alignment of @widget
12530 gtk_widget_get_halign (GtkWidget *widget)
12532 g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_ALIGN_FILL);
12533 return _gtk_widget_get_aux_info_or_defaults (widget)->halign;
12537 * gtk_widget_set_halign:
12538 * @widget: a #GtkWidget
12539 * @align: the horizontal alignment
12541 * Sets the horizontal alignment of @widget.
12542 * See the #GtkWidget:halign property.
12545 gtk_widget_set_halign (GtkWidget *widget,
12548 GtkWidgetAuxInfo *aux_info;
12550 g_return_if_fail (GTK_IS_WIDGET (widget));
12552 aux_info = gtk_widget_get_aux_info (widget, TRUE);
12554 if (aux_info->halign == align)
12557 aux_info->halign = align;
12558 gtk_widget_queue_resize (widget);
12559 g_object_notify (G_OBJECT (widget), "halign");
12563 * gtk_widget_get_valign:
12564 * @widget: a #GtkWidget
12566 * Gets the value of the #GtkWidget:valign property.
12568 * Returns: the vertical alignment of @widget
12571 gtk_widget_get_valign (GtkWidget *widget)
12573 g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_ALIGN_FILL);
12574 return _gtk_widget_get_aux_info_or_defaults (widget)->valign;
12578 * gtk_widget_set_valign:
12579 * @widget: a #GtkWidget
12580 * @align: the vertical alignment
12582 * Sets the vertical alignment of @widget.
12583 * See the #GtkWidget:valign property.
12586 gtk_widget_set_valign (GtkWidget *widget,
12589 GtkWidgetAuxInfo *aux_info;
12591 g_return_if_fail (GTK_IS_WIDGET (widget));
12593 aux_info = gtk_widget_get_aux_info (widget, TRUE);
12595 if (aux_info->valign == align)
12598 aux_info->valign = align;
12599 gtk_widget_queue_resize (widget);
12600 g_object_notify (G_OBJECT (widget), "valign");
12604 * gtk_widget_get_margin_left:
12605 * @widget: a #GtkWidget
12607 * Gets the value of the #GtkWidget:margin-left property.
12609 * Returns: The left margin of @widget
12614 gtk_widget_get_margin_left (GtkWidget *widget)
12616 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
12618 return _gtk_widget_get_aux_info_or_defaults (widget)->margin.left;
12622 * gtk_widget_set_margin_left:
12623 * @widget: a #GtkWidget
12624 * @margin: the left margin
12626 * Sets the left margin of @widget.
12627 * See the #GtkWidget:margin-left property.
12632 gtk_widget_set_margin_left (GtkWidget *widget,
12635 GtkWidgetAuxInfo *aux_info;
12637 g_return_if_fail (GTK_IS_WIDGET (widget));
12638 g_return_if_fail (margin <= G_MAXINT16);
12640 aux_info = gtk_widget_get_aux_info (widget, TRUE);
12642 if (aux_info->margin.left == margin)
12645 aux_info->margin.left = margin;
12646 gtk_widget_queue_resize (widget);
12647 g_object_notify (G_OBJECT (widget), "margin-left");
12651 * gtk_widget_get_margin_right:
12652 * @widget: a #GtkWidget
12654 * Gets the value of the #GtkWidget:margin-right property.
12656 * Returns: The right margin of @widget
12661 gtk_widget_get_margin_right (GtkWidget *widget)
12663 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
12665 return _gtk_widget_get_aux_info_or_defaults (widget)->margin.right;
12669 * gtk_widget_set_margin_right:
12670 * @widget: a #GtkWidget
12671 * @margin: the right margin
12673 * Sets the right margin of @widget.
12674 * See the #GtkWidget:margin-right property.
12679 gtk_widget_set_margin_right (GtkWidget *widget,
12682 GtkWidgetAuxInfo *aux_info;
12684 g_return_if_fail (GTK_IS_WIDGET (widget));
12685 g_return_if_fail (margin <= G_MAXINT16);
12687 aux_info = gtk_widget_get_aux_info (widget, TRUE);
12689 if (aux_info->margin.right == margin)
12692 aux_info->margin.right = margin;
12693 gtk_widget_queue_resize (widget);
12694 g_object_notify (G_OBJECT (widget), "margin-right");
12698 * gtk_widget_get_margin_top:
12699 * @widget: a #GtkWidget
12701 * Gets the value of the #GtkWidget:margin-top property.
12703 * Returns: The top margin of @widget
12708 gtk_widget_get_margin_top (GtkWidget *widget)
12710 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
12712 return _gtk_widget_get_aux_info_or_defaults (widget)->margin.top;
12716 * gtk_widget_set_margin_top:
12717 * @widget: a #GtkWidget
12718 * @margin: the top margin
12720 * Sets the top margin of @widget.
12721 * See the #GtkWidget:margin-top property.
12726 gtk_widget_set_margin_top (GtkWidget *widget,
12729 GtkWidgetAuxInfo *aux_info;
12731 g_return_if_fail (GTK_IS_WIDGET (widget));
12732 g_return_if_fail (margin <= G_MAXINT16);
12734 aux_info = gtk_widget_get_aux_info (widget, TRUE);
12736 if (aux_info->margin.top == margin)
12739 aux_info->margin.top = margin;
12740 gtk_widget_queue_resize (widget);
12741 g_object_notify (G_OBJECT (widget), "margin-top");
12745 * gtk_widget_get_margin_bottom:
12746 * @widget: a #GtkWidget
12748 * Gets the value of the #GtkWidget:margin-bottom property.
12750 * Returns: The bottom margin of @widget
12755 gtk_widget_get_margin_bottom (GtkWidget *widget)
12757 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
12759 return _gtk_widget_get_aux_info_or_defaults (widget)->margin.bottom;
12763 * gtk_widget_set_margin_bottom:
12764 * @widget: a #GtkWidget
12765 * @margin: the bottom margin
12767 * Sets the bottom margin of @widget.
12768 * See the #GtkWidget:margin-bottom property.
12773 gtk_widget_set_margin_bottom (GtkWidget *widget,
12776 GtkWidgetAuxInfo *aux_info;
12778 g_return_if_fail (GTK_IS_WIDGET (widget));
12779 g_return_if_fail (margin <= G_MAXINT16);
12781 aux_info = gtk_widget_get_aux_info (widget, TRUE);
12783 if (aux_info->margin.bottom == margin)
12786 aux_info->margin.bottom = margin;
12787 gtk_widget_queue_resize (widget);
12788 g_object_notify (G_OBJECT (widget), "margin-bottom");
12792 * gtk_widget_get_clipboard:
12793 * @widget: a #GtkWidget
12794 * @selection: a #GdkAtom which identifies the clipboard
12795 * to use. %GDK_SELECTION_CLIPBOARD gives the
12796 * default clipboard. Another common value
12797 * is %GDK_SELECTION_PRIMARY, which gives
12798 * the primary X selection.
12800 * Returns the clipboard object for the given selection to
12801 * be used with @widget. @widget must have a #GdkDisplay
12802 * associated with it, so must be attached to a toplevel
12805 * Return value: (transfer none): the appropriate clipboard object. If no
12806 * clipboard already exists, a new one will
12807 * be created. Once a clipboard object has
12808 * been created, it is persistent for all time.
12813 gtk_widget_get_clipboard (GtkWidget *widget, GdkAtom selection)
12815 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
12816 g_return_val_if_fail (gtk_widget_has_screen (widget), NULL);
12818 return gtk_clipboard_get_for_display (gtk_widget_get_display (widget),
12823 * gtk_widget_list_mnemonic_labels:
12824 * @widget: a #GtkWidget
12826 * Returns a newly allocated list of the widgets, normally labels, for
12827 * which this widget is the target of a mnemonic (see for example,
12828 * gtk_label_set_mnemonic_widget()).
12830 * The widgets in the list are not individually referenced. If you
12831 * want to iterate through the list and perform actions involving
12832 * callbacks that might destroy the widgets, you
12833 * <emphasis>must</emphasis> call <literal>g_list_foreach (result,
12834 * (GFunc)g_object_ref, NULL)</literal> first, and then unref all the
12835 * widgets afterwards.
12837 * Return value: (element-type GtkWidget) (transfer container): the list of
12838 * mnemonic labels; free this list
12839 * with g_list_free() when you are done with it.
12844 gtk_widget_list_mnemonic_labels (GtkWidget *widget)
12846 GList *list = NULL;
12849 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
12851 for (l = g_object_get_qdata (G_OBJECT (widget), quark_mnemonic_labels); l; l = l->next)
12852 list = g_list_prepend (list, l->data);
12858 * gtk_widget_add_mnemonic_label:
12859 * @widget: a #GtkWidget
12860 * @label: a #GtkWidget that acts as a mnemonic label for @widget
12862 * Adds a widget to the list of mnemonic labels for
12863 * this widget. (See gtk_widget_list_mnemonic_labels()). Note the
12864 * list of mnemonic labels for the widget is cleared when the
12865 * widget is destroyed, so the caller must make sure to update
12866 * its internal state at this point as well, by using a connection
12867 * to the #GtkWidget::destroy signal or a weak notifier.
12872 gtk_widget_add_mnemonic_label (GtkWidget *widget,
12875 GSList *old_list, *new_list;
12877 g_return_if_fail (GTK_IS_WIDGET (widget));
12878 g_return_if_fail (GTK_IS_WIDGET (label));
12880 old_list = g_object_steal_qdata (G_OBJECT (widget), quark_mnemonic_labels);
12881 new_list = g_slist_prepend (old_list, label);
12883 g_object_set_qdata_full (G_OBJECT (widget), quark_mnemonic_labels,
12884 new_list, (GDestroyNotify) g_slist_free);
12888 * gtk_widget_remove_mnemonic_label:
12889 * @widget: a #GtkWidget
12890 * @label: a #GtkWidget that was previously set as a mnemnic label for
12891 * @widget with gtk_widget_add_mnemonic_label().
12893 * Removes a widget from the list of mnemonic labels for
12894 * this widget. (See gtk_widget_list_mnemonic_labels()). The widget
12895 * must have previously been added to the list with
12896 * gtk_widget_add_mnemonic_label().
12901 gtk_widget_remove_mnemonic_label (GtkWidget *widget,
12904 GSList *old_list, *new_list;
12906 g_return_if_fail (GTK_IS_WIDGET (widget));
12907 g_return_if_fail (GTK_IS_WIDGET (label));
12909 old_list = g_object_steal_qdata (G_OBJECT (widget), quark_mnemonic_labels);
12910 new_list = g_slist_remove (old_list, label);
12913 g_object_set_qdata_full (G_OBJECT (widget), quark_mnemonic_labels,
12914 new_list, (GDestroyNotify) g_slist_free);
12918 * gtk_widget_get_no_show_all:
12919 * @widget: a #GtkWidget
12921 * Returns the current value of the #GtkWidget:no-show-all property,
12922 * which determines whether calls to gtk_widget_show_all()
12923 * will affect this widget.
12925 * Return value: the current value of the "no-show-all" property.
12930 gtk_widget_get_no_show_all (GtkWidget *widget)
12932 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
12934 return widget->priv->no_show_all;
12938 * gtk_widget_set_no_show_all:
12939 * @widget: a #GtkWidget
12940 * @no_show_all: the new value for the "no-show-all" property
12942 * Sets the #GtkWidget:no-show-all property, which determines whether
12943 * calls to gtk_widget_show_all() will affect this widget.
12945 * This is mostly for use in constructing widget hierarchies with externally
12946 * controlled visibility, see #GtkUIManager.
12951 gtk_widget_set_no_show_all (GtkWidget *widget,
12952 gboolean no_show_all)
12954 g_return_if_fail (GTK_IS_WIDGET (widget));
12956 no_show_all = (no_show_all != FALSE);
12958 if (widget->priv->no_show_all != no_show_all)
12960 widget->priv->no_show_all = no_show_all;
12962 g_object_notify (G_OBJECT (widget), "no-show-all");
12968 gtk_widget_real_set_has_tooltip (GtkWidget *widget,
12969 gboolean has_tooltip,
12972 GtkWidgetPrivate *priv = widget->priv;
12973 gboolean priv_has_tooltip;
12975 priv_has_tooltip = GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (widget),
12976 quark_has_tooltip));
12978 if (priv_has_tooltip != has_tooltip || force)
12980 priv_has_tooltip = has_tooltip;
12982 if (priv_has_tooltip)
12984 if (gtk_widget_get_realized (widget) && !gtk_widget_get_has_window (widget))
12985 gdk_window_set_events (priv->window,
12986 gdk_window_get_events (priv->window) |
12987 GDK_LEAVE_NOTIFY_MASK |
12988 GDK_POINTER_MOTION_MASK |
12989 GDK_POINTER_MOTION_HINT_MASK);
12991 if (gtk_widget_get_has_window (widget))
12992 gtk_widget_add_events (widget,
12993 GDK_LEAVE_NOTIFY_MASK |
12994 GDK_POINTER_MOTION_MASK |
12995 GDK_POINTER_MOTION_HINT_MASK);
12998 g_object_set_qdata (G_OBJECT (widget), quark_has_tooltip,
12999 GUINT_TO_POINTER (priv_has_tooltip));
13004 * gtk_widget_set_tooltip_window:
13005 * @widget: a #GtkWidget
13006 * @custom_window: (allow-none): a #GtkWindow, or %NULL
13008 * Replaces the default, usually yellow, window used for displaying
13009 * tooltips with @custom_window. GTK+ will take care of showing and
13010 * hiding @custom_window at the right moment, to behave likewise as
13011 * the default tooltip window. If @custom_window is %NULL, the default
13012 * tooltip window will be used.
13014 * If the custom window should have the default theming it needs to
13015 * have the name "gtk-tooltip", see gtk_widget_set_name().
13020 gtk_widget_set_tooltip_window (GtkWidget *widget,
13021 GtkWindow *custom_window)
13023 gboolean has_tooltip;
13024 gchar *tooltip_markup;
13026 g_return_if_fail (GTK_IS_WIDGET (widget));
13027 g_return_if_fail (custom_window == NULL || GTK_IS_WINDOW (custom_window));
13029 tooltip_markup = g_object_get_qdata (G_OBJECT (widget), quark_tooltip_markup);
13032 g_object_ref (custom_window);
13034 g_object_set_qdata_full (G_OBJECT (widget), quark_tooltip_window,
13035 custom_window, g_object_unref);
13037 has_tooltip = (custom_window != NULL || tooltip_markup != NULL);
13038 gtk_widget_real_set_has_tooltip (widget, has_tooltip, FALSE);
13040 if (has_tooltip && gtk_widget_get_visible (widget))
13041 gtk_widget_queue_tooltip_query (widget);
13045 * gtk_widget_get_tooltip_window:
13046 * @widget: a #GtkWidget
13048 * Returns the #GtkWindow of the current tooltip. This can be the
13049 * GtkWindow created by default, or the custom tooltip window set
13050 * using gtk_widget_set_tooltip_window().
13052 * Return value: (transfer none): The #GtkWindow of the current tooltip.
13057 gtk_widget_get_tooltip_window (GtkWidget *widget)
13059 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
13061 return g_object_get_qdata (G_OBJECT (widget), quark_tooltip_window);
13065 * gtk_widget_trigger_tooltip_query:
13066 * @widget: a #GtkWidget
13068 * Triggers a tooltip query on the display where the toplevel of @widget
13069 * is located. See gtk_tooltip_trigger_tooltip_query() for more
13075 gtk_widget_trigger_tooltip_query (GtkWidget *widget)
13077 gtk_tooltip_trigger_tooltip_query (gtk_widget_get_display (widget));
13080 static guint tooltip_query_id;
13081 static GSList *tooltip_query_displays;
13084 tooltip_query_idle (gpointer data)
13086 g_slist_foreach (tooltip_query_displays, (GFunc)gtk_tooltip_trigger_tooltip_query, NULL);
13087 g_slist_foreach (tooltip_query_displays, (GFunc)g_object_unref, NULL);
13088 g_slist_free (tooltip_query_displays);
13090 tooltip_query_displays = NULL;
13091 tooltip_query_id = 0;
13097 gtk_widget_queue_tooltip_query (GtkWidget *widget)
13099 GdkDisplay *display;
13101 display = gtk_widget_get_display (widget);
13103 if (!g_slist_find (tooltip_query_displays, display))
13104 tooltip_query_displays = g_slist_prepend (tooltip_query_displays, g_object_ref (display));
13106 if (tooltip_query_id == 0)
13107 tooltip_query_id = gdk_threads_add_idle (tooltip_query_idle, NULL);
13111 * gtk_widget_set_tooltip_text:
13112 * @widget: a #GtkWidget
13113 * @text: the contents of the tooltip for @widget
13115 * Sets @text as the contents of the tooltip. This function will take
13116 * care of setting #GtkWidget:has-tooltip to %TRUE and of the default
13117 * handler for the #GtkWidget::query-tooltip signal.
13119 * See also the #GtkWidget:tooltip-text property and gtk_tooltip_set_text().
13124 gtk_widget_set_tooltip_text (GtkWidget *widget,
13127 g_return_if_fail (GTK_IS_WIDGET (widget));
13129 g_object_set (G_OBJECT (widget), "tooltip-text", text, NULL);
13133 * gtk_widget_get_tooltip_text:
13134 * @widget: a #GtkWidget
13136 * Gets the contents of the tooltip for @widget.
13138 * Return value: the tooltip text, or %NULL. You should free the
13139 * returned string with g_free() when done.
13144 gtk_widget_get_tooltip_text (GtkWidget *widget)
13146 gchar *text = NULL;
13148 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
13150 g_object_get (G_OBJECT (widget), "tooltip-text", &text, NULL);
13156 * gtk_widget_set_tooltip_markup:
13157 * @widget: a #GtkWidget
13158 * @markup: (allow-none): the contents of the tooltip for @widget, or %NULL
13160 * Sets @markup as the contents of the tooltip, which is marked up with
13161 * the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
13163 * This function will take care of setting #GtkWidget:has-tooltip to %TRUE
13164 * and of the default handler for the #GtkWidget::query-tooltip signal.
13166 * See also the #GtkWidget:tooltip-markup property and
13167 * gtk_tooltip_set_markup().
13172 gtk_widget_set_tooltip_markup (GtkWidget *widget,
13173 const gchar *markup)
13175 g_return_if_fail (GTK_IS_WIDGET (widget));
13177 g_object_set (G_OBJECT (widget), "tooltip-markup", markup, NULL);
13181 * gtk_widget_get_tooltip_markup:
13182 * @widget: a #GtkWidget
13184 * Gets the contents of the tooltip for @widget.
13186 * Return value: the tooltip text, or %NULL. You should free the
13187 * returned string with g_free() when done.
13192 gtk_widget_get_tooltip_markup (GtkWidget *widget)
13194 gchar *text = NULL;
13196 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
13198 g_object_get (G_OBJECT (widget), "tooltip-markup", &text, NULL);
13204 * gtk_widget_set_has_tooltip:
13205 * @widget: a #GtkWidget
13206 * @has_tooltip: whether or not @widget has a tooltip.
13208 * Sets the has-tooltip property on @widget to @has_tooltip. See
13209 * #GtkWidget:has-tooltip for more information.
13214 gtk_widget_set_has_tooltip (GtkWidget *widget,
13215 gboolean has_tooltip)
13217 g_return_if_fail (GTK_IS_WIDGET (widget));
13219 g_object_set (G_OBJECT (widget), "has-tooltip", has_tooltip, NULL);
13223 * gtk_widget_get_has_tooltip:
13224 * @widget: a #GtkWidget
13226 * Returns the current value of the has-tooltip property. See
13227 * #GtkWidget:has-tooltip for more information.
13229 * Return value: current value of has-tooltip on @widget.
13234 gtk_widget_get_has_tooltip (GtkWidget *widget)
13236 gboolean has_tooltip = FALSE;
13238 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
13240 g_object_get (G_OBJECT (widget), "has-tooltip", &has_tooltip, NULL);
13242 return has_tooltip;
13246 * gtk_widget_get_allocation:
13247 * @widget: a #GtkWidget
13248 * @allocation: (out): a pointer to a #GtkAllocation to copy to
13250 * Retrieves the widget's allocation.
13252 * Note, when implementing a #GtkContainer: a widget's allocation will
13253 * be its "adjusted" allocation, that is, the widget's parent
13254 * container typically calls gtk_widget_size_allocate() with an
13255 * allocation, and that allocation is then adjusted (to handle margin
13256 * and alignment for example) before assignment to the widget.
13257 * gtk_widget_get_allocation() returns the adjusted allocation that
13258 * was actually assigned to the widget. The adjusted allocation is
13259 * guaranteed to be completely contained within the
13260 * gtk_widget_size_allocate() allocation, however. So a #GtkContainer
13261 * is guaranteed that its children stay inside the assigned bounds,
13262 * but not that they have exactly the bounds the container assigned.
13263 * There is no way to get the original allocation assigned by
13264 * gtk_widget_size_allocate(), since it isn't stored; if a container
13265 * implementation needs that information it will have to track it itself.
13270 gtk_widget_get_allocation (GtkWidget *widget,
13271 GtkAllocation *allocation)
13273 GtkWidgetPrivate *priv;
13275 g_return_if_fail (GTK_IS_WIDGET (widget));
13276 g_return_if_fail (allocation != NULL);
13278 priv = widget->priv;
13280 *allocation = priv->allocation;
13284 * gtk_widget_set_allocation:
13285 * @widget: a #GtkWidget
13286 * @allocation: a pointer to a #GtkAllocation to copy from
13288 * Sets the widget's allocation. This should not be used
13289 * directly, but from within a widget's size_allocate method.
13291 * The allocation set should be the "adjusted" or actual
13292 * allocation. If you're implementing a #GtkContainer, you want to use
13293 * gtk_widget_size_allocate() instead of gtk_widget_set_allocation().
13294 * The GtkWidgetClass::adjust_size_allocation virtual method adjusts the
13295 * allocation inside gtk_widget_size_allocate() to create an adjusted
13301 gtk_widget_set_allocation (GtkWidget *widget,
13302 const GtkAllocation *allocation)
13304 GtkWidgetPrivate *priv;
13306 g_return_if_fail (GTK_IS_WIDGET (widget));
13307 g_return_if_fail (allocation != NULL);
13309 priv = widget->priv;
13311 priv->allocation = *allocation;
13315 * gtk_widget_get_allocated_width:
13316 * @widget: the widget to query
13318 * Returns the width that has currently been allocated to @widget.
13319 * This function is intended to be used when implementing handlers
13320 * for the #GtkWidget::draw function.
13322 * Returns: the width of the @widget
13325 gtk_widget_get_allocated_width (GtkWidget *widget)
13327 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
13329 return widget->priv->allocation.width;
13333 * gtk_widget_get_allocated_height:
13334 * @widget: the widget to query
13336 * Returns the height that has currently been allocated to @widget.
13337 * This function is intended to be used when implementing handlers
13338 * for the #GtkWidget::draw function.
13340 * Returns: the height of the @widget
13343 gtk_widget_get_allocated_height (GtkWidget *widget)
13345 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
13347 return widget->priv->allocation.height;
13351 * gtk_widget_get_requisition:
13352 * @widget: a #GtkWidget
13353 * @requisition: (out): a pointer to a #GtkRequisition to copy to
13355 * Retrieves the widget's requisition.
13357 * This function should only be used by widget implementations in
13358 * order to figure whether the widget's requisition has actually
13359 * changed after some internal state change (so that they can call
13360 * gtk_widget_queue_resize() instead of gtk_widget_queue_draw()).
13362 * Normally, gtk_widget_size_request() should be used.
13366 * Deprecated: 3.0: The #GtkRequisition cache on the widget was
13367 * removed, If you need to cache sizes across requests and allocations,
13368 * add an explicit cache to the widget in question instead.
13371 gtk_widget_get_requisition (GtkWidget *widget,
13372 GtkRequisition *requisition)
13374 g_return_if_fail (GTK_IS_WIDGET (widget));
13375 g_return_if_fail (requisition != NULL);
13377 gtk_widget_get_preferred_size (widget, requisition, NULL);
13381 * gtk_widget_set_window:
13382 * @widget: a #GtkWidget
13383 * @window: (transfer full): a #GdkWindow
13385 * Sets a widget's window. This function should only be used in a
13386 * widget's #GtkWidget::realize implementation. The %window passed is
13387 * usually either new window created with gdk_window_new(), or the
13388 * window of its parent widget as returned by
13389 * gtk_widget_get_parent_window().
13391 * Widgets must indicate whether they will create their own #GdkWindow
13392 * by calling gtk_widget_set_has_window(). This is usually done in the
13393 * widget's init() function.
13395 * <note><para>This function does not add any reference to @window.</para></note>
13400 gtk_widget_set_window (GtkWidget *widget,
13403 GtkWidgetPrivate *priv;
13405 g_return_if_fail (GTK_IS_WIDGET (widget));
13406 g_return_if_fail (window == NULL || GDK_IS_WINDOW (window));
13408 priv = widget->priv;
13410 if (priv->window != window)
13412 priv->window = window;
13413 g_object_notify (G_OBJECT (widget), "window");
13418 * gtk_widget_get_window:
13419 * @widget: a #GtkWidget
13421 * Returns the widget's window if it is realized, %NULL otherwise
13423 * Return value: (transfer none): @widget's window.
13428 gtk_widget_get_window (GtkWidget *widget)
13430 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
13432 return widget->priv->window;
13436 * gtk_widget_get_support_multidevice:
13437 * @widget: a #GtkWidget
13439 * Returns %TRUE if @widget is multiple pointer aware. See
13440 * gtk_widget_set_support_multidevice() for more information.
13442 * Returns: %TRUE if @widget is multidevice aware.
13445 gtk_widget_get_support_multidevice (GtkWidget *widget)
13447 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
13449 return widget->priv->multidevice;
13453 * gtk_widget_set_support_multidevice:
13454 * @widget: a #GtkWidget
13455 * @support_multidevice: %TRUE to support input from multiple devices.
13457 * Enables or disables multiple pointer awareness. If this setting is %TRUE,
13458 * @widget will start receiving multiple, per device enter/leave events. Note
13459 * that if custom #GdkWindow<!-- -->s are created in #GtkWidget::realize,
13460 * gdk_window_set_support_multidevice() will have to be called manually on them.
13465 gtk_widget_set_support_multidevice (GtkWidget *widget,
13466 gboolean support_multidevice)
13468 GtkWidgetPrivate *priv;
13470 g_return_if_fail (GTK_IS_WIDGET (widget));
13472 priv = widget->priv;
13473 priv->multidevice = (support_multidevice == TRUE);
13475 if (gtk_widget_get_realized (widget))
13476 gdk_window_set_support_multidevice (priv->window, support_multidevice);
13480 _gtk_widget_set_has_focus (GtkWidget *widget,
13481 gboolean has_focus)
13483 widget->priv->has_focus = has_focus;
13486 gtk_widget_set_state_flags (widget, GTK_STATE_FLAG_FOCUSED, FALSE);
13488 gtk_widget_unset_state_flags (widget, GTK_STATE_FLAG_FOCUSED);
13492 * gtk_widget_send_focus_change:
13493 * @widget: a #GtkWidget
13494 * @event: a #GdkEvent of type GDK_FOCUS_CHANGE
13496 * Sends the focus change @event to @widget
13498 * This function is not meant to be used by applications. The only time it
13499 * should be used is when it is necessary for a #GtkWidget to assign focus
13500 * to a widget that is semantically owned by the first widget even though
13501 * it's not a direct child - for instance, a search entry in a floating
13502 * window similar to the quick search in #GtkTreeView.
13504 * An example of its usage is:
13507 * GdkEvent *fevent = gdk_event_new (GDK_FOCUS_CHANGE);
13509 * fevent->focus_change.type = GDK_FOCUS_CHANGE;
13510 * fevent->focus_change.in = TRUE;
13511 * fevent->focus_change.window = gtk_widget_get_window (widget);
13512 * if (fevent->focus_change.window != NULL)
13513 * g_object_ref (fevent->focus_change.window);
13515 * gtk_widget_send_focus_change (widget, fevent);
13517 * gdk_event_free (event);
13520 * Return value: the return value from the event signal emission: %TRUE
13521 * if the event was handled, and %FALSE otherwise
13526 gtk_widget_send_focus_change (GtkWidget *widget,
13531 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
13532 g_return_val_if_fail (event != NULL && event->type == GDK_FOCUS_CHANGE, FALSE);
13534 g_object_ref (widget);
13536 _gtk_widget_set_has_focus (widget, event->focus_change.in);
13538 res = gtk_widget_event (widget, event);
13540 g_object_notify (G_OBJECT (widget), "has-focus");
13542 g_object_unref (widget);
13548 * gtk_widget_in_destruction:
13549 * @widget: a #GtkWidget
13551 * Returns whether the widget is currently being destroyed.
13552 * This information can sometimes be used to avoid doing
13553 * unnecessary work.
13555 * Returns: %TRUE if @widget is being destroyed
13558 gtk_widget_in_destruction (GtkWidget *widget)
13560 return widget->priv->in_destruction;
13564 _gtk_widget_get_resize_pending (GtkWidget *widget)
13566 return widget->priv->resize_pending;
13570 _gtk_widget_set_resize_pending (GtkWidget *widget,
13571 gboolean resize_pending)
13573 widget->priv->resize_pending = resize_pending;
13577 _gtk_widget_get_in_reparent (GtkWidget *widget)
13579 return widget->priv->in_reparent;
13583 _gtk_widget_set_in_reparent (GtkWidget *widget,
13584 gboolean in_reparent)
13586 widget->priv->in_reparent = in_reparent;
13590 _gtk_widget_get_anchored (GtkWidget *widget)
13592 return widget->priv->anchored;
13596 _gtk_widget_set_anchored (GtkWidget *widget,
13599 widget->priv->anchored = anchored;
13603 _gtk_widget_get_shadowed (GtkWidget *widget)
13605 return widget->priv->shadowed;
13609 _gtk_widget_set_shadowed (GtkWidget *widget,
13612 widget->priv->shadowed = shadowed;
13616 _gtk_widget_get_alloc_needed (GtkWidget *widget)
13618 return widget->priv->alloc_needed;
13622 _gtk_widget_set_alloc_needed (GtkWidget *widget,
13623 gboolean alloc_needed)
13625 widget->priv->alloc_needed = alloc_needed;
13629 _gtk_widget_get_width_request_needed (GtkWidget *widget)
13631 return widget->priv->width_request_needed;
13635 _gtk_widget_set_width_request_needed (GtkWidget *widget,
13636 gboolean width_request_needed)
13638 widget->priv->width_request_needed = width_request_needed;
13642 _gtk_widget_get_height_request_needed (GtkWidget *widget)
13644 return widget->priv->height_request_needed;
13648 _gtk_widget_set_height_request_needed (GtkWidget *widget,
13649 gboolean height_request_needed)
13651 widget->priv->height_request_needed = height_request_needed;
13655 _gtk_widget_get_sizegroup_visited (GtkWidget *widget)
13657 return widget->priv->sizegroup_visited;
13661 _gtk_widget_set_sizegroup_visited (GtkWidget *widget,
13664 widget->priv->sizegroup_visited = visited;
13668 _gtk_widget_get_sizegroup_bumping (GtkWidget *widget)
13670 return widget->priv->sizegroup_bumping;
13674 _gtk_widget_set_sizegroup_bumping (GtkWidget *widget,
13677 widget->priv->sizegroup_bumping = bumping;
13681 _gtk_widget_add_sizegroup (GtkWidget *widget,
13686 groups = g_object_get_qdata (G_OBJECT (widget), quark_size_groups);
13687 groups = g_slist_prepend (groups, group);
13688 g_object_set_qdata (G_OBJECT (widget), quark_size_groups, groups);
13690 widget->priv->have_size_groups = TRUE;
13694 _gtk_widget_remove_sizegroup (GtkWidget *widget,
13699 groups = g_object_get_qdata (G_OBJECT (widget), quark_size_groups);
13700 groups = g_slist_remove (groups, group);
13701 g_object_set_qdata (G_OBJECT (widget), quark_size_groups, groups);
13703 widget->priv->have_size_groups = groups != NULL;
13707 _gtk_widget_get_sizegroups (GtkWidget *widget)
13709 if (widget->priv->have_size_groups)
13710 return g_object_get_qdata (G_OBJECT (widget), quark_size_groups);
13716 * gtk_widget_path_append_for_widget:
13717 * @path: a widget path
13718 * @widget: the widget to append to the widget path
13720 * Appends the data from @widget to the widget hierarchy represented
13721 * by @path. This function is a shortcut for adding information from
13722 * @widget to the given @path. This includes setting the name or
13723 * adding the style classes from @widget.
13725 * Returns: the position where the data was inserted
13730 gtk_widget_path_append_for_widget (GtkWidgetPath *path,
13735 g_return_val_if_fail (path != NULL, 0);
13736 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
13738 pos = gtk_widget_path_append_type (path, G_OBJECT_TYPE (widget));
13740 if (widget->priv->name)
13741 gtk_widget_path_iter_set_name (path, pos, widget->priv->name);
13743 if (widget->priv->context)
13745 GList *classes, *l;
13747 /* Also add any persistent classes in
13748 * the style context the widget path
13750 classes = gtk_style_context_list_classes (widget->priv->context);
13752 for (l = classes; l; l = l->next)
13753 gtk_widget_path_iter_add_class (path, pos, l->data);
13755 g_list_free (classes);
13762 * gtk_widget_get_path:
13763 * @widget: a #GtkWidget
13765 * Returns the #GtkWidgetPath representing @widget, if the widget
13766 * is not connected to a toplevel widget, a partial path will be
13769 * Returns: (transfer none): The #GtkWidgetPath representing @widget
13772 gtk_widget_get_path (GtkWidget *widget)
13774 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
13776 /* As strange as it may seem, this may happen on object construction.
13777 * init() implementations of parent types may eventually call this function,
13778 * each with its corresponding GType, which could leave a child
13779 * implementation with a wrong widget type in the widget path
13781 if (widget->priv->path &&
13782 G_OBJECT_TYPE (widget) != gtk_widget_path_get_object_type (widget->priv->path))
13784 gtk_widget_path_free (widget->priv->path);
13785 widget->priv->path = NULL;
13788 if (!widget->priv->path)
13792 parent = widget->priv->parent;
13795 widget->priv->path = gtk_container_get_path_for_child (GTK_CONTAINER (parent), widget);
13798 /* Widget is either toplevel or unparented, treat both
13799 * as toplevels style wise, since there are situations
13800 * where style properties might be retrieved on that
13803 widget->priv->path = gtk_widget_path_new ();
13805 gtk_widget_path_append_for_widget (widget->priv->path, widget);
13808 if (widget->priv->context)
13809 gtk_style_context_set_path (widget->priv->context,
13810 widget->priv->path);
13813 return widget->priv->path;
13817 style_context_changed (GtkStyleContext *context,
13818 gpointer user_data)
13820 GtkWidget *widget = user_data;
13822 if (gtk_widget_get_realized (widget))
13823 g_signal_emit (widget, widget_signals[STYLE_UPDATED], 0);
13826 /* Compress all style updates so it
13827 * is only emitted once pre-realize.
13829 widget->priv->style_update_pending = TRUE;
13832 if (widget->priv->anchored)
13833 gtk_widget_queue_resize (widget);
13837 * gtk_widget_get_style_context:
13838 * @widget: a #GtkWidget
13840 * Returns the style context associated to @widget.
13842 * Returns: (transfer none): a #GtkStyleContext. This memory is owned by @widget and
13843 * must not be freed.
13846 gtk_widget_get_style_context (GtkWidget *widget)
13848 GtkWidgetPrivate *priv;
13849 GtkWidgetPath *path;
13851 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
13853 priv = widget->priv;
13855 /* updates style context if it exists already */
13856 path = gtk_widget_get_path (widget);
13858 if (G_UNLIKELY (priv->context == NULL))
13862 priv->context = g_object_new (GTK_TYPE_STYLE_CONTEXT,
13863 "direction", gtk_widget_get_direction (widget),
13866 g_signal_connect (widget->priv->context, "changed",
13867 G_CALLBACK (style_context_changed), widget);
13869 screen = gtk_widget_get_screen (widget);
13872 gtk_style_context_set_screen (priv->context, screen);
13874 gtk_style_context_set_path (priv->context, path);
13876 gtk_style_context_set_parent (priv->context,
13877 gtk_widget_get_style_context (priv->parent));
13880 return widget->priv->context;
13884 * gtk_widget_get_modifier_mask:
13885 * @widget: a #GtkWidget
13886 * @intent: the use case for the modifier mask
13888 * Returns the modifier mask the @widget's windowing system backend
13889 * uses for a particular purpose.
13891 * See gdk_keymap_get_modifier_mask().
13893 * Returns: the modifier mask used for @intent.
13898 gtk_widget_get_modifier_mask (GtkWidget *widget,
13899 GdkModifierIntent intent)
13901 GdkDisplay *display;
13903 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
13905 display = gtk_widget_get_display (widget);
13907 return gdk_keymap_get_modifier_mask (gdk_keymap_get_for_display (display),
13912 _gtk_widget_get_style (GtkWidget *widget)
13914 return widget->priv->style;
13918 _gtk_widget_set_style (GtkWidget *widget,
13921 widget->priv->style = style;