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, see <http://www.gnu.org/licenses/>.
19 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
20 * file for a list of people on the GTK+ Team. See the ChangeLog
21 * files for a list of changes. These files are distributed with
22 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
31 #include <gobject/gvaluecollector.h>
32 #include <gobject/gobjectnotifyqueue.c>
33 #include <cairo-gobject.h>
35 #include "gtkcontainer.h"
36 #include "gtkaccelmapprivate.h"
37 #include "gtkclipboard.h"
38 #include "gtkcssstylepropertyprivate.h"
39 #include "gtkiconfactory.h"
41 #include "gtkmarshalers.h"
42 #include "gtkselectionprivate.h"
43 #include "gtksettingsprivate.h"
44 #include "gtksizegroup-private.h"
45 #include "gtksizerequestcacheprivate.h"
46 #include "gtkwidget.h"
47 #include "gtkwidgetprivate.h"
48 #include "gtkwindowprivate.h"
49 #include "gtkcontainerprivate.h"
50 #include "gtkbindings.h"
51 #include "gtkprivate.h"
52 #include "gtkaccessible.h"
53 #include "gtktooltip.h"
54 #include "gtkinvisible.h"
55 #include "gtkbuildable.h"
56 #include "gtkbuilderprivate.h"
57 #include "gtksizerequest.h"
58 #include "gtkstylecontextprivate.h"
59 #include "gtkcssprovider.h"
60 #include "gtkmodifierstyle.h"
61 #include "gtkversion.h"
64 #include "gtktypebuiltins.h"
65 #include "a11y/gtkwidgetaccessible.h"
69 * @Short_description: Base class for all widgets
72 * GtkWidget is the base class all widgets in GTK+ derive from. It manages the
73 * widget lifecycle, states and style.
75 * <refsect2 id="geometry-management">
76 * <title>Height-for-width Geometry Management</title>
78 * GTK+ uses a height-for-width (and width-for-height) geometry management
79 * system. Height-for-width means that a widget can change how much
80 * vertical space it needs, depending on the amount of horizontal space
81 * that it is given (and similar for width-for-height). The most common
82 * example is a label that reflows to fill up the available width, wraps
83 * to fewer lines, and therefore needs less height.
85 * Height-for-width geometry management is implemented in GTK+ by way
86 * of five virtual methods:
88 * <listitem>#GtkWidgetClass.get_request_mode()</listitem>
89 * <listitem>#GtkWidgetClass.get_preferred_width()</listitem>
90 * <listitem>#GtkWidgetClass.get_preferred_height()</listitem>
91 * <listitem>#GtkWidgetClass.get_preferred_height_for_width()</listitem>
92 * <listitem>#GtkWidgetClass.get_preferred_width_for_height()</listitem>
95 * There are some important things to keep in mind when implementing
96 * height-for-width and when using it in container implementations.
98 * The geometry management system will query a widget hierarchy in
99 * only one orientation at a time. When widgets are initially queried
100 * for their minimum sizes it is generally done in two initial passes
101 * in the #GtkSizeRequestMode chosen by the toplevel.
103 * For example, when queried in the normal
104 * %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH mode:
105 * First, the default minimum and natural width for each widget
106 * in the interface will be computed using gtk_widget_get_preferred_width().
107 * Because the preferred widths for each container depend on the preferred
108 * widths of their children, this information propagates up the hierarchy,
109 * and finally a minimum and natural width is determined for the entire
110 * toplevel. Next, the toplevel will use the minimum width to query for the
111 * minimum height contextual to that width using
112 * gtk_widget_get_preferred_height_for_width(), which will also be a highly
113 * recursive operation. The minimum height for the minimum width is normally
114 * used to set the minimum size constraint on the toplevel
115 * (unless gtk_window_set_geometry_hints() is explicitly used instead).
117 * After the toplevel window has initially requested its size in both
118 * dimensions it can go on to allocate itself a reasonable size (or a size
119 * previously specified with gtk_window_set_default_size()). During the
120 * recursive allocation process it's important to note that request cycles
121 * will be recursively executed while container widgets allocate their children.
122 * Each container widget, once allocated a size, will go on to first share the
123 * space in one orientation among its children and then request each child's
124 * height for its target allocated width or its width for allocated height,
125 * depending. In this way a #GtkWidget will typically be requested its size
126 * a number of times before actually being allocated a size. The size a
127 * widget is finally allocated can of course differ from the size it has
128 * requested. For this reason, #GtkWidget caches a small number of results
129 * to avoid re-querying for the same sizes in one allocation cycle.
131 * See <link linkend="container-geometry-management">GtkContainer's
132 * geometry management section</link>
133 * to learn more about how height-for-width allocations are performed
134 * by container widgets.
136 * If a widget does move content around to intelligently use up the
137 * allocated size then it must support the request in both
138 * #GtkSizeRequestModes even if the widget in question only
139 * trades sizes in a single orientation.
141 * For instance, a #GtkLabel that does height-for-width word wrapping
142 * will not expect to have #GtkWidgetClass.get_preferred_height() called
143 * because that call is specific to a width-for-height request. In this
144 * case the label must return the height required for its own minimum
145 * possible width. By following this rule any widget that handles
146 * height-for-width or width-for-height requests will always be allocated
147 * at least enough space to fit its own content.
149 * Here are some examples of how a %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH widget
150 * generally deals with width-for-height requests, for #GtkWidgetClass.get_preferred_height()
152 * <programlisting><![CDATA[
154 * foo_widget_get_preferred_height (GtkWidget *widget, gint *min_height, gint *nat_height)
156 * if (i_am_in_height_for_width_mode)
160 * GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, &min_width, NULL);
161 * GTK_WIDGET_GET_CLASS (widget)->get_preferred_height_for_width (widget, min_width,
162 * min_height, nat_height);
166 * ... some widgets do both. For instance, if a GtkLabel is rotated to 90 degrees
167 * it will return the minimum and natural height for the rotated label here.
170 * ]]></programlisting>
172 * And in #GtkWidgetClass.get_preferred_width_for_height() it will simply return
173 * the minimum and natural width:
175 * <programlisting><![CDATA[
177 * foo_widget_get_preferred_width_for_height (GtkWidget *widget, gint for_height,
178 * gint *min_width, gint *nat_width)
180 * if (i_am_in_height_for_width_mode)
182 * GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, min_width, nat_width);
186 * ... again if a widget is sometimes operating in width-for-height mode
187 * (like a rotated GtkLabel) it can go ahead and do its real width for
188 * height calculation here.
191 * ]]></programlisting>
193 * Often a widget needs to get its own request during size request or
194 * allocation. For example, when computing height it may need to also
195 * compute width. Or when deciding how to use an allocation, the widget
196 * may need to know its natural size. In these cases, the widget should
197 * be careful to call its virtual methods directly, like this:
199 * <title>Widget calling its own size request method.</title>
201 * GTK_WIDGET_GET_CLASS(widget)->get_preferred_width (widget),
206 * It will not work to use the wrapper functions, such as
207 * gtk_widget_get_preferred_width() inside your own size request
208 * implementation. These return a request adjusted by #GtkSizeGroup
209 * and by the #GtkWidgetClass.adjust_size_request() virtual method. If a
210 * widget used the wrappers inside its virtual method implementations,
211 * then the adjustments (such as widget margins) would be applied
212 * twice. GTK+ therefore does not allow this and will warn if you try
215 * Of course if you are getting the size request for
216 * <emphasis>another</emphasis> widget, such as a child of a
217 * container, you <emphasis>must</emphasis> use the wrapper APIs.
218 * Otherwise, you would not properly consider widget margins,
219 * #GtkSizeGroup, and so forth.
222 * <refsect2 id="style-properties">
223 * <title>Style Properties</title>
225 * <structname>GtkWidget</structname> introduces <firstterm>style
226 * properties</firstterm> - these are basically object properties that are stored
227 * not on the object, but in the style object associated to the widget. Style
228 * properties are set in <link linkend="gtk-Resource-Files">resource files</link>.
229 * This mechanism is used for configuring such things as the location of the
230 * scrollbar arrows through the theme, giving theme authors more control over the
231 * look of applications without the need to write a theme engine in C.
234 * Use gtk_widget_class_install_style_property() to install style properties for
235 * a widget class, gtk_widget_class_find_style_property() or
236 * gtk_widget_class_list_style_properties() to get information about existing
237 * style properties and gtk_widget_style_get_property(), gtk_widget_style_get() or
238 * gtk_widget_style_get_valist() to obtain the value of a style property.
241 * <refsect2 id="GtkWidget-BUILDER-UI">
242 * <title>GtkWidget as GtkBuildable</title>
244 * The GtkWidget implementation of the GtkBuildable interface supports a
245 * custom <accelerator> element, which has attributes named key,
246 * modifiers and signal and allows to specify accelerators.
249 * <title>A UI definition fragment specifying an accelerator</title>
250 * <programlisting><![CDATA[
251 * <object class="GtkButton">
252 * <accelerator key="q" modifiers="GDK_CONTROL_MASK" signal="clicked"/>
254 * ]]></programlisting>
257 * In addition to accelerators, <structname>GtkWidget</structname> also support a
258 * custom <accessible> element, which supports actions and relations.
259 * Properties on the accessible implementation of an object can be set by accessing the
260 * internal child "accessible" of a <structname>GtkWidget</structname>.
263 * <title>A UI definition fragment specifying an accessible</title>
264 * <programlisting><![CDATA[
265 * <object class="GtkButton" id="label1"/>
266 * <property name="label">I am a Label for a Button</property>
268 * <object class="GtkButton" id="button1">
270 * <action action_name="click" translatable="yes">Click the button.</action>
271 * <relation target="label1" type="labelled-by"/>
273 * <child internal-child="accessible">
274 * <object class="AtkObject" id="a11y-button1">
275 * <property name="AtkObject::name">Clickable Button</property>
279 * ]]></programlisting>
282 * Finally, GtkWidget allows style information such as style classes to
283 * be associated with widgets, using the custom <style> element:
285 * <title>A UI definition fragment specifying an style class</title>
286 * <programlisting><![CDATA[
287 * <object class="GtkButton" id="button1">
289 * <class name="my-special-button-class"/>
290 * <class name="dark-button"/>
293 * ]]></programlisting>
299 /* Add flags here that should not be propagated to children. By default,
300 * all flags will be set on children (think prelight or active), but we
301 * might want to not do this for some.
303 #define GTK_STATE_FLAGS_DONT_PROPAGATE (GTK_STATE_FLAG_FOCUSED)
304 #define GTK_STATE_FLAGS_DO_PROPAGATE (~GTK_STATE_FLAGS_DONT_PROPAGATE)
306 #define WIDGET_CLASS(w) GTK_WIDGET_GET_CLASS (w)
308 #define GTK_STATE_FLAGS_BITS 7
310 struct _GtkWidgetPrivate
312 /* The state of the widget. Needs to be able to hold all GtkStateFlags bits
313 * (defined in "gtkenums.h").
315 guint state_flags : GTK_STATE_FLAGS_BITS;
319 guint in_destruction : 1;
322 guint composite_child : 1;
330 guint can_default : 1;
331 guint has_default : 1;
332 guint receives_default : 1;
335 guint style_update_pending : 1;
336 guint app_paintable : 1;
337 guint double_buffered : 1;
338 guint redraw_on_alloc : 1;
339 guint no_show_all : 1;
340 guint child_visible : 1;
341 guint multidevice : 1;
342 guint has_shape_mask : 1;
343 guint in_reparent : 1;
345 /* Queue-resize related flags */
346 guint alloc_needed : 1;
348 /* Expand-related flags */
349 guint need_compute_expand : 1; /* Need to recompute computed_[hv]_expand */
350 guint computed_hexpand : 1; /* computed results (composite of child flags) */
351 guint computed_vexpand : 1;
352 guint hexpand : 1; /* application-forced expand */
354 guint hexpand_set : 1; /* whether to use application-forced */
355 guint vexpand_set : 1; /* instead of computing from children */
357 /* SizeGroup related flags */
358 guint have_size_groups : 1;
360 /* The widget's name. If the widget does not have a name
361 * (the name is NULL), then its name (as returned by
362 * "gtk_widget_get_name") is its class's name.
363 * Among other things, the widget name is used to determine
364 * the style to use for a widget.
368 /* The list of attached windows to this widget.
369 * We keep a list in order to call reset_style to all of them,
371 GList *attached_windows;
373 /* The style for the widget. The style contains the
374 * colors the widget should be drawn in for each state
375 * along with graphics contexts used to draw with and
376 * the font to use for text.
379 GtkStyleContext *context;
381 /* Widget's path for styling */
384 /* The widget's allocated size */
385 GtkAllocation allocation;
387 /* The widget's requested sizes */
388 SizeRequestCache requests;
390 /* actions attached to this or any parent widget */
393 /* The widget's window or its parent window if it does
394 * not have a window. (Which will be indicated by the
395 * GTK_NO_WINDOW flag being set).
399 /* The widget's parent */
402 #ifdef G_ENABLE_DEBUG
403 /* Number of gtk_widget_push_verify_invariants () */
404 guint verifying_invariants_count;
405 #endif /* G_ENABLE_DEBUG */
408 struct _GtkWidgetClassPrivate
410 GType accessible_type;
411 AtkRole accessible_role;
440 BUTTON_RELEASE_EVENT,
454 PROPERTY_NOTIFY_EVENT,
455 SELECTION_CLEAR_EVENT,
456 SELECTION_REQUEST_EVENT,
457 SELECTION_NOTIFY_EVENT,
462 VISIBILITY_NOTIFY_EVENT,
476 ACCEL_CLOSURES_CHANGED,
501 PROP_RECEIVES_DEFAULT,
502 PROP_COMPOSITE_CHILD,
510 PROP_DOUBLE_BUFFERED,
525 typedef struct _GtkStateData GtkStateData;
528 STATE_CHANGE_REPLACE,
535 guint flags : GTK_STATE_FLAGS_BITS;
539 /* --- prototypes --- */
540 static void gtk_widget_base_class_init (gpointer g_class);
541 static void gtk_widget_class_init (GtkWidgetClass *klass);
542 static void gtk_widget_base_class_finalize (GtkWidgetClass *klass);
543 static void gtk_widget_init (GtkWidget *widget);
544 static void gtk_widget_set_property (GObject *object,
548 static void gtk_widget_get_property (GObject *object,
552 static void gtk_widget_constructed (GObject *object);
553 static void gtk_widget_dispose (GObject *object);
554 static void gtk_widget_real_destroy (GtkWidget *object);
555 static void gtk_widget_finalize (GObject *object);
556 static void gtk_widget_real_show (GtkWidget *widget);
557 static void gtk_widget_real_hide (GtkWidget *widget);
558 static void gtk_widget_real_map (GtkWidget *widget);
559 static void gtk_widget_real_unmap (GtkWidget *widget);
560 static void gtk_widget_real_realize (GtkWidget *widget);
561 static void gtk_widget_real_unrealize (GtkWidget *widget);
562 static void gtk_widget_real_size_allocate (GtkWidget *widget,
563 GtkAllocation *allocation);
564 static void gtk_widget_real_style_set (GtkWidget *widget,
565 GtkStyle *previous_style);
566 static void gtk_widget_real_direction_changed(GtkWidget *widget,
567 GtkTextDirection previous_direction);
569 static void gtk_widget_real_grab_focus (GtkWidget *focus_widget);
570 static gboolean gtk_widget_real_query_tooltip (GtkWidget *widget,
573 gboolean keyboard_tip,
574 GtkTooltip *tooltip);
575 static void gtk_widget_real_style_updated (GtkWidget *widget);
576 static gboolean gtk_widget_real_show_help (GtkWidget *widget,
577 GtkWidgetHelpType help_type);
579 static void gtk_widget_dispatch_child_properties_changed (GtkWidget *object,
581 GParamSpec **pspecs);
582 static gboolean gtk_widget_real_key_press_event (GtkWidget *widget,
584 static gboolean gtk_widget_real_key_release_event (GtkWidget *widget,
586 static gboolean gtk_widget_real_focus_in_event (GtkWidget *widget,
587 GdkEventFocus *event);
588 static gboolean gtk_widget_real_focus_out_event (GtkWidget *widget,
589 GdkEventFocus *event);
590 static gboolean gtk_widget_real_touch_event (GtkWidget *widget,
591 GdkEventTouch *event);
592 static gboolean gtk_widget_real_focus (GtkWidget *widget,
593 GtkDirectionType direction);
594 static void gtk_widget_real_move_focus (GtkWidget *widget,
595 GtkDirectionType direction);
596 static gboolean gtk_widget_real_keynav_failed (GtkWidget *widget,
597 GtkDirectionType direction);
598 #ifdef G_ENABLE_DEBUG
599 static void gtk_widget_verify_invariants (GtkWidget *widget);
600 static void gtk_widget_push_verify_invariants (GtkWidget *widget);
601 static void gtk_widget_pop_verify_invariants (GtkWidget *widget);
603 #define gtk_widget_verify_invariants(widget)
604 #define gtk_widget_push_verify_invariants(widget)
605 #define gtk_widget_pop_verify_invariants(widget)
607 static PangoContext* gtk_widget_peek_pango_context (GtkWidget *widget);
608 static void gtk_widget_update_pango_context (GtkWidget *widget);
609 static void gtk_widget_propagate_state (GtkWidget *widget,
612 static gint gtk_widget_event_internal (GtkWidget *widget,
614 static gboolean gtk_widget_real_mnemonic_activate (GtkWidget *widget,
615 gboolean group_cycling);
616 static void gtk_widget_real_get_width (GtkWidget *widget,
619 static void gtk_widget_real_get_height (GtkWidget *widget,
622 static void gtk_widget_real_get_height_for_width (GtkWidget *widget,
624 gint *minimum_height,
625 gint *natural_height);
626 static void gtk_widget_real_get_width_for_height (GtkWidget *widget,
629 gint *natural_width);
630 static void gtk_widget_real_state_flags_changed (GtkWidget *widget,
631 GtkStateFlags old_state);
632 static const GtkWidgetAuxInfo* _gtk_widget_get_aux_info_or_defaults (GtkWidget *widget);
633 static GtkWidgetAuxInfo* gtk_widget_get_aux_info (GtkWidget *widget,
635 static void gtk_widget_aux_info_destroy (GtkWidgetAuxInfo *aux_info);
636 static AtkObject* gtk_widget_real_get_accessible (GtkWidget *widget);
637 static void gtk_widget_accessible_interface_init (AtkImplementorIface *iface);
638 static AtkObject* gtk_widget_ref_accessible (AtkImplementor *implementor);
639 static void gtk_widget_invalidate_widget_windows (GtkWidget *widget,
640 cairo_region_t *region);
641 static GdkScreen * gtk_widget_get_screen_unchecked (GtkWidget *widget);
642 static gboolean gtk_widget_real_can_activate_accel (GtkWidget *widget,
645 static void gtk_widget_real_set_has_tooltip (GtkWidget *widget,
646 gboolean has_tooltip,
648 static void gtk_widget_buildable_interface_init (GtkBuildableIface *iface);
649 static void gtk_widget_buildable_set_name (GtkBuildable *buildable,
651 static const gchar * gtk_widget_buildable_get_name (GtkBuildable *buildable);
652 static GObject * gtk_widget_buildable_get_internal_child (GtkBuildable *buildable,
654 const gchar *childname);
655 static void gtk_widget_buildable_set_buildable_property (GtkBuildable *buildable,
658 const GValue *value);
659 static gboolean gtk_widget_buildable_custom_tag_start (GtkBuildable *buildable,
662 const gchar *tagname,
663 GMarkupParser *parser,
665 static void gtk_widget_buildable_custom_finished (GtkBuildable *buildable,
668 const gchar *tagname,
670 static void gtk_widget_buildable_parser_finished (GtkBuildable *buildable,
671 GtkBuilder *builder);
673 static GtkSizeRequestMode gtk_widget_real_get_request_mode (GtkWidget *widget);
674 static void gtk_widget_real_get_width (GtkWidget *widget,
677 static void gtk_widget_real_get_height (GtkWidget *widget,
681 static void gtk_widget_queue_tooltip_query (GtkWidget *widget);
684 static void gtk_widget_real_adjust_size_request (GtkWidget *widget,
685 GtkOrientation orientation,
688 static void gtk_widget_real_adjust_size_allocation (GtkWidget *widget,
689 GtkOrientation orientation,
693 gint *allocated_size);
695 static void gtk_widget_set_usize_internal (GtkWidget *widget,
698 GtkQueueResizeFlags flags);
700 static void gtk_widget_add_events_internal (GtkWidget *widget,
703 static void gtk_widget_set_device_enabled_internal (GtkWidget *widget,
707 static gboolean event_window_is_still_viewable (GdkEvent *event);
709 /* --- variables --- */
710 static gpointer gtk_widget_parent_class = NULL;
711 static guint widget_signals[LAST_SIGNAL] = { 0 };
712 static guint composite_child_stack = 0;
713 static GtkTextDirection gtk_default_direction = GTK_TEXT_DIR_LTR;
714 static GParamSpecPool *style_property_spec_pool = NULL;
716 static GQuark quark_property_parser = 0;
717 static GQuark quark_aux_info = 0;
718 static GQuark quark_accel_path = 0;
719 static GQuark quark_accel_closures = 0;
720 static GQuark quark_event_mask = 0;
721 static GQuark quark_device_event_mask = 0;
722 static GQuark quark_parent_window = 0;
723 static GQuark quark_pointer_window = 0;
724 static GQuark quark_shape_info = 0;
725 static GQuark quark_input_shape_info = 0;
726 static GQuark quark_pango_context = 0;
727 static GQuark quark_accessible_object = 0;
728 static GQuark quark_mnemonic_labels = 0;
729 static GQuark quark_tooltip_markup = 0;
730 static GQuark quark_has_tooltip = 0;
731 static GQuark quark_tooltip_window = 0;
732 static GQuark quark_visual = 0;
733 static GQuark quark_modifier_style = 0;
734 static GQuark quark_enabled_devices = 0;
735 static GQuark quark_size_groups = 0;
736 GParamSpecPool *_gtk_widget_child_property_pool = NULL;
737 GObjectNotifyContext *_gtk_widget_child_property_notify_context = NULL;
739 /* --- functions --- */
741 gtk_widget_get_type (void)
743 static GType widget_type = 0;
745 if (G_UNLIKELY (widget_type == 0))
747 const GTypeInfo widget_info =
749 sizeof (GtkWidgetClass),
750 gtk_widget_base_class_init,
751 (GBaseFinalizeFunc) gtk_widget_base_class_finalize,
752 (GClassInitFunc) gtk_widget_class_init,
753 NULL, /* class_finalize */
754 NULL, /* class_init */
757 (GInstanceInitFunc) gtk_widget_init,
758 NULL, /* value_table */
761 const GInterfaceInfo accessibility_info =
763 (GInterfaceInitFunc) gtk_widget_accessible_interface_init,
764 (GInterfaceFinalizeFunc) NULL,
765 NULL /* interface data */
768 const GInterfaceInfo buildable_info =
770 (GInterfaceInitFunc) gtk_widget_buildable_interface_init,
771 (GInterfaceFinalizeFunc) NULL,
772 NULL /* interface data */
775 widget_type = g_type_register_static (G_TYPE_INITIALLY_UNOWNED, "GtkWidget",
776 &widget_info, G_TYPE_FLAG_ABSTRACT);
778 g_type_add_class_private (widget_type, sizeof (GtkWidgetClassPrivate));
780 g_type_add_interface_static (widget_type, ATK_TYPE_IMPLEMENTOR,
781 &accessibility_info) ;
782 g_type_add_interface_static (widget_type, GTK_TYPE_BUILDABLE,
790 gtk_widget_base_class_init (gpointer g_class)
792 GtkWidgetClass *klass = g_class;
794 klass->priv = G_TYPE_CLASS_GET_PRIVATE (g_class, GTK_TYPE_WIDGET, GtkWidgetClassPrivate);
798 child_property_notify_dispatcher (GObject *object,
802 GTK_WIDGET_GET_CLASS (object)->dispatch_child_properties_changed (GTK_WIDGET (object), n_pspecs, pspecs);
805 /* We guard against the draw signal callbacks modifying the state of the
806 * cairo context by surounding it with save/restore.
807 * Maybe we should also cairo_new_path() just to be sure?
810 gtk_widget_draw_marshaller (GClosure *closure,
811 GValue *return_value,
812 guint n_param_values,
813 const GValue *param_values,
814 gpointer invocation_hint,
815 gpointer marshal_data)
817 cairo_t *cr = g_value_get_boxed (¶m_values[1]);
821 _gtk_marshal_BOOLEAN__BOXED (closure,
832 gtk_widget_draw_marshallerv (GClosure *closure,
833 GValue *return_value,
836 gpointer marshal_data,
843 G_VA_COPY (args_copy, args);
844 cr = va_arg (args_copy, gpointer);
848 _gtk_marshal_BOOLEAN__BOXEDv (closure,
862 gtk_widget_class_init (GtkWidgetClass *klass)
864 static GObjectNotifyContext cpn_context = { 0, NULL, NULL };
865 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
866 GtkBindingSet *binding_set;
868 gtk_widget_parent_class = g_type_class_peek_parent (klass);
870 quark_property_parser = g_quark_from_static_string ("gtk-rc-property-parser");
871 quark_aux_info = g_quark_from_static_string ("gtk-aux-info");
872 quark_accel_path = g_quark_from_static_string ("gtk-accel-path");
873 quark_accel_closures = g_quark_from_static_string ("gtk-accel-closures");
874 quark_event_mask = g_quark_from_static_string ("gtk-event-mask");
875 quark_device_event_mask = g_quark_from_static_string ("gtk-device-event-mask");
876 quark_parent_window = g_quark_from_static_string ("gtk-parent-window");
877 quark_pointer_window = g_quark_from_static_string ("gtk-pointer-window");
878 quark_shape_info = g_quark_from_static_string ("gtk-shape-info");
879 quark_input_shape_info = g_quark_from_static_string ("gtk-input-shape-info");
880 quark_pango_context = g_quark_from_static_string ("gtk-pango-context");
881 quark_accessible_object = g_quark_from_static_string ("gtk-accessible-object");
882 quark_mnemonic_labels = g_quark_from_static_string ("gtk-mnemonic-labels");
883 quark_tooltip_markup = g_quark_from_static_string ("gtk-tooltip-markup");
884 quark_has_tooltip = g_quark_from_static_string ("gtk-has-tooltip");
885 quark_tooltip_window = g_quark_from_static_string ("gtk-tooltip-window");
886 quark_visual = g_quark_from_static_string ("gtk-widget-visual");
887 quark_modifier_style = g_quark_from_static_string ("gtk-widget-modifier-style");
888 quark_enabled_devices = g_quark_from_static_string ("gtk-widget-enabled-devices");
889 quark_size_groups = g_quark_from_static_string ("gtk-widget-size-groups");
891 style_property_spec_pool = g_param_spec_pool_new (FALSE);
892 _gtk_widget_child_property_pool = g_param_spec_pool_new (TRUE);
893 cpn_context.quark_notify_queue = g_quark_from_static_string ("GtkWidget-child-property-notify-queue");
894 cpn_context.dispatcher = child_property_notify_dispatcher;
895 _gtk_widget_child_property_notify_context = &cpn_context;
897 gobject_class->constructed = gtk_widget_constructed;
898 gobject_class->dispose = gtk_widget_dispose;
899 gobject_class->finalize = gtk_widget_finalize;
900 gobject_class->set_property = gtk_widget_set_property;
901 gobject_class->get_property = gtk_widget_get_property;
903 klass->destroy = gtk_widget_real_destroy;
905 klass->activate_signal = 0;
906 klass->dispatch_child_properties_changed = gtk_widget_dispatch_child_properties_changed;
907 klass->show = gtk_widget_real_show;
908 klass->show_all = gtk_widget_show;
909 klass->hide = gtk_widget_real_hide;
910 klass->map = gtk_widget_real_map;
911 klass->unmap = gtk_widget_real_unmap;
912 klass->realize = gtk_widget_real_realize;
913 klass->unrealize = gtk_widget_real_unrealize;
914 klass->size_allocate = gtk_widget_real_size_allocate;
915 klass->get_request_mode = gtk_widget_real_get_request_mode;
916 klass->get_preferred_width = gtk_widget_real_get_width;
917 klass->get_preferred_height = gtk_widget_real_get_height;
918 klass->get_preferred_width_for_height = gtk_widget_real_get_width_for_height;
919 klass->get_preferred_height_for_width = gtk_widget_real_get_height_for_width;
920 klass->state_changed = NULL;
921 klass->state_flags_changed = gtk_widget_real_state_flags_changed;
922 klass->parent_set = NULL;
923 klass->hierarchy_changed = NULL;
924 klass->style_set = gtk_widget_real_style_set;
925 klass->direction_changed = gtk_widget_real_direction_changed;
926 klass->grab_notify = NULL;
927 klass->child_notify = NULL;
929 klass->mnemonic_activate = gtk_widget_real_mnemonic_activate;
930 klass->grab_focus = gtk_widget_real_grab_focus;
931 klass->focus = gtk_widget_real_focus;
932 klass->move_focus = gtk_widget_real_move_focus;
933 klass->keynav_failed = gtk_widget_real_keynav_failed;
935 klass->button_press_event = NULL;
936 klass->button_release_event = NULL;
937 klass->motion_notify_event = NULL;
938 klass->touch_event = gtk_widget_real_touch_event;
939 klass->delete_event = NULL;
940 klass->destroy_event = NULL;
941 klass->key_press_event = gtk_widget_real_key_press_event;
942 klass->key_release_event = gtk_widget_real_key_release_event;
943 klass->enter_notify_event = NULL;
944 klass->leave_notify_event = NULL;
945 klass->configure_event = NULL;
946 klass->focus_in_event = gtk_widget_real_focus_in_event;
947 klass->focus_out_event = gtk_widget_real_focus_out_event;
948 klass->map_event = NULL;
949 klass->unmap_event = NULL;
950 klass->window_state_event = NULL;
951 klass->property_notify_event = _gtk_selection_property_notify;
952 klass->selection_clear_event = _gtk_selection_clear;
953 klass->selection_request_event = _gtk_selection_request;
954 klass->selection_notify_event = _gtk_selection_notify;
955 klass->selection_received = NULL;
956 klass->proximity_in_event = NULL;
957 klass->proximity_out_event = NULL;
958 klass->drag_begin = NULL;
959 klass->drag_end = NULL;
960 klass->drag_data_delete = NULL;
961 klass->drag_leave = NULL;
962 klass->drag_motion = NULL;
963 klass->drag_drop = NULL;
964 klass->drag_data_received = NULL;
965 klass->screen_changed = NULL;
966 klass->can_activate_accel = gtk_widget_real_can_activate_accel;
967 klass->grab_broken_event = NULL;
968 klass->query_tooltip = gtk_widget_real_query_tooltip;
969 klass->style_updated = gtk_widget_real_style_updated;
971 klass->show_help = gtk_widget_real_show_help;
973 /* Accessibility support */
974 klass->priv->accessible_type = GTK_TYPE_ACCESSIBLE;
975 klass->priv->accessible_role = ATK_ROLE_INVALID;
976 klass->get_accessible = gtk_widget_real_get_accessible;
978 klass->adjust_size_request = gtk_widget_real_adjust_size_request;
979 klass->adjust_size_allocation = gtk_widget_real_adjust_size_allocation;
981 g_object_class_install_property (gobject_class,
983 g_param_spec_string ("name",
985 P_("The name of the widget"),
987 GTK_PARAM_READWRITE));
988 g_object_class_install_property (gobject_class,
990 g_param_spec_object ("parent",
992 P_("The parent widget of this widget. Must be a Container widget"),
994 GTK_PARAM_READWRITE));
996 g_object_class_install_property (gobject_class,
998 g_param_spec_int ("width-request",
1000 P_("Override for width request of the widget, or -1 if natural request should be used"),
1004 GTK_PARAM_READWRITE));
1005 g_object_class_install_property (gobject_class,
1006 PROP_HEIGHT_REQUEST,
1007 g_param_spec_int ("height-request",
1008 P_("Height request"),
1009 P_("Override for height request of the widget, or -1 if natural request should be used"),
1013 GTK_PARAM_READWRITE));
1014 g_object_class_install_property (gobject_class,
1016 g_param_spec_boolean ("visible",
1018 P_("Whether the widget is visible"),
1020 GTK_PARAM_READWRITE));
1021 g_object_class_install_property (gobject_class,
1023 g_param_spec_boolean ("sensitive",
1025 P_("Whether the widget responds to input"),
1027 GTK_PARAM_READWRITE));
1028 g_object_class_install_property (gobject_class,
1030 g_param_spec_boolean ("app-paintable",
1031 P_("Application paintable"),
1032 P_("Whether the application will paint directly on the widget"),
1034 GTK_PARAM_READWRITE));
1035 g_object_class_install_property (gobject_class,
1037 g_param_spec_boolean ("can-focus",
1039 P_("Whether the widget can accept the input focus"),
1041 GTK_PARAM_READWRITE));
1042 g_object_class_install_property (gobject_class,
1044 g_param_spec_boolean ("has-focus",
1046 P_("Whether the widget has the input focus"),
1048 GTK_PARAM_READWRITE));
1049 g_object_class_install_property (gobject_class,
1051 g_param_spec_boolean ("is-focus",
1053 P_("Whether the widget is the focus widget within the toplevel"),
1055 GTK_PARAM_READWRITE));
1056 g_object_class_install_property (gobject_class,
1058 g_param_spec_boolean ("can-default",
1060 P_("Whether the widget can be the default widget"),
1062 GTK_PARAM_READWRITE));
1063 g_object_class_install_property (gobject_class,
1065 g_param_spec_boolean ("has-default",
1067 P_("Whether the widget is the default widget"),
1069 GTK_PARAM_READWRITE));
1070 g_object_class_install_property (gobject_class,
1071 PROP_RECEIVES_DEFAULT,
1072 g_param_spec_boolean ("receives-default",
1073 P_("Receives default"),
1074 P_("If TRUE, the widget will receive the default action when it is focused"),
1076 GTK_PARAM_READWRITE));
1077 g_object_class_install_property (gobject_class,
1078 PROP_COMPOSITE_CHILD,
1079 g_param_spec_boolean ("composite-child",
1080 P_("Composite child"),
1081 P_("Whether the widget is part of a composite widget"),
1083 GTK_PARAM_READABLE));
1084 g_object_class_install_property (gobject_class,
1086 g_param_spec_object ("style",
1088 P_("The style of the widget, which contains information about how it will look (colors etc)"),
1090 GTK_PARAM_READWRITE));
1091 g_object_class_install_property (gobject_class,
1093 g_param_spec_flags ("events",
1095 P_("The event mask that decides what kind of GdkEvents this widget gets"),
1096 GDK_TYPE_EVENT_MASK,
1098 GTK_PARAM_READWRITE));
1099 g_object_class_install_property (gobject_class,
1101 g_param_spec_boolean ("no-show-all",
1103 P_("Whether gtk_widget_show_all() should not affect this widget"),
1105 GTK_PARAM_READWRITE));
1108 * GtkWidget:has-tooltip:
1110 * Enables or disables the emission of #GtkWidget::query-tooltip on @widget.
1111 * A value of %TRUE indicates that @widget can have a tooltip, in this case
1112 * the widget will be queried using #GtkWidget::query-tooltip to determine
1113 * whether it will provide a tooltip or not.
1115 * Note that setting this property to %TRUE for the first time will change
1116 * the event masks of the GdkWindows of this widget to include leave-notify
1117 * and motion-notify events. This cannot and will not be undone when the
1118 * property is set to %FALSE again.
1122 g_object_class_install_property (gobject_class,
1124 g_param_spec_boolean ("has-tooltip",
1126 P_("Whether this widget has a tooltip"),
1128 GTK_PARAM_READWRITE));
1130 * GtkWidget:tooltip-text:
1132 * Sets the text of tooltip to be the given string.
1134 * Also see gtk_tooltip_set_text().
1136 * This is a convenience property which will take care of getting the
1137 * tooltip shown if the given string is not %NULL: #GtkWidget:has-tooltip
1138 * will automatically be set to %TRUE and there will be taken care of
1139 * #GtkWidget::query-tooltip in the default signal handler.
1143 g_object_class_install_property (gobject_class,
1145 g_param_spec_string ("tooltip-text",
1147 P_("The contents of the tooltip for this widget"),
1149 GTK_PARAM_READWRITE));
1151 * GtkWidget:tooltip-markup:
1153 * Sets the text of tooltip to be the given string, which is marked up
1154 * with the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
1155 * Also see gtk_tooltip_set_markup().
1157 * This is a convenience property which will take care of getting the
1158 * tooltip shown if the given string is not %NULL: #GtkWidget:has-tooltip
1159 * will automatically be set to %TRUE and there will be taken care of
1160 * #GtkWidget::query-tooltip in the default signal handler.
1164 g_object_class_install_property (gobject_class,
1165 PROP_TOOLTIP_MARKUP,
1166 g_param_spec_string ("tooltip-markup",
1167 P_("Tooltip markup"),
1168 P_("The contents of the tooltip for this widget"),
1170 GTK_PARAM_READWRITE));
1175 * The widget's window if it is realized, %NULL otherwise.
1179 g_object_class_install_property (gobject_class,
1181 g_param_spec_object ("window",
1183 P_("The widget's window if it is realized"),
1185 GTK_PARAM_READABLE));
1188 * GtkWidget:double-buffered:
1190 * Whether the widget is double buffered.
1194 g_object_class_install_property (gobject_class,
1195 PROP_DOUBLE_BUFFERED,
1196 g_param_spec_boolean ("double-buffered",
1197 P_("Double Buffered"),
1198 P_("Whether the widget is double buffered"),
1200 GTK_PARAM_READWRITE));
1205 * How to distribute horizontal space if widget gets extra space, see #GtkAlign
1209 g_object_class_install_property (gobject_class,
1211 g_param_spec_enum ("halign",
1212 P_("Horizontal Alignment"),
1213 P_("How to position in extra horizontal space"),
1216 GTK_PARAM_READWRITE));
1221 * How to distribute vertical space if widget gets extra space, see #GtkAlign
1225 g_object_class_install_property (gobject_class,
1227 g_param_spec_enum ("valign",
1228 P_("Vertical Alignment"),
1229 P_("How to position in extra vertical space"),
1232 GTK_PARAM_READWRITE));
1235 * GtkWidget:margin-left:
1237 * Margin on left side of widget.
1239 * This property adds margin outside of the widget's normal size
1240 * request, the margin will be added in addition to the size from
1241 * gtk_widget_set_size_request() for example.
1245 g_object_class_install_property (gobject_class,
1247 g_param_spec_int ("margin-left",
1248 P_("Margin on Left"),
1249 P_("Pixels of extra space on the left side"),
1253 GTK_PARAM_READWRITE));
1256 * GtkWidget:margin-right:
1258 * Margin on right side of widget.
1260 * This property adds margin outside of the widget's normal size
1261 * request, the margin will be added in addition to the size from
1262 * gtk_widget_set_size_request() for example.
1266 g_object_class_install_property (gobject_class,
1268 g_param_spec_int ("margin-right",
1269 P_("Margin on Right"),
1270 P_("Pixels of extra space on the right side"),
1274 GTK_PARAM_READWRITE));
1277 * GtkWidget:margin-top:
1279 * Margin on top side of widget.
1281 * This property adds margin outside of the widget's normal size
1282 * request, the margin will be added in addition to the size from
1283 * gtk_widget_set_size_request() for example.
1287 g_object_class_install_property (gobject_class,
1289 g_param_spec_int ("margin-top",
1290 P_("Margin on Top"),
1291 P_("Pixels of extra space on the top side"),
1295 GTK_PARAM_READWRITE));
1298 * GtkWidget:margin-bottom:
1300 * Margin on bottom side of widget.
1302 * This property adds margin outside of the widget's normal size
1303 * request, the margin will be added in addition to the size from
1304 * gtk_widget_set_size_request() for example.
1308 g_object_class_install_property (gobject_class,
1310 g_param_spec_int ("margin-bottom",
1311 P_("Margin on Bottom"),
1312 P_("Pixels of extra space on the bottom side"),
1316 GTK_PARAM_READWRITE));
1321 * Sets all four sides' margin at once. If read, returns max
1322 * margin on any side.
1326 g_object_class_install_property (gobject_class,
1328 g_param_spec_int ("margin",
1330 P_("Pixels of extra space on all four sides"),
1334 GTK_PARAM_READWRITE));
1337 * GtkWidget::destroy:
1338 * @object: the object which received the signal
1340 * Signals that all holders of a reference to the widget should release
1341 * the reference that they hold. May result in finalization of the widget
1342 * if all references are released.
1344 widget_signals[DESTROY] =
1345 g_signal_new (I_("destroy"),
1346 G_TYPE_FROM_CLASS (gobject_class),
1347 G_SIGNAL_RUN_CLEANUP | G_SIGNAL_NO_RECURSE | G_SIGNAL_NO_HOOKS,
1348 G_STRUCT_OFFSET (GtkWidgetClass, destroy),
1350 _gtk_marshal_VOID__VOID,
1354 * GtkWidget:hexpand:
1356 * Whether to expand horizontally. See gtk_widget_set_hexpand().
1360 g_object_class_install_property (gobject_class,
1362 g_param_spec_boolean ("hexpand",
1363 P_("Horizontal Expand"),
1364 P_("Whether widget wants more horizontal space"),
1366 GTK_PARAM_READWRITE));
1369 * GtkWidget:hexpand-set:
1371 * Whether to use the #GtkWidget:hexpand property. See gtk_widget_get_hexpand_set().
1375 g_object_class_install_property (gobject_class,
1377 g_param_spec_boolean ("hexpand-set",
1378 P_("Horizontal Expand Set"),
1379 P_("Whether to use the hexpand property"),
1381 GTK_PARAM_READWRITE));
1384 * GtkWidget:vexpand:
1386 * Whether to expand vertically. See gtk_widget_set_vexpand().
1390 g_object_class_install_property (gobject_class,
1392 g_param_spec_boolean ("vexpand",
1393 P_("Vertical Expand"),
1394 P_("Whether widget wants more vertical space"),
1396 GTK_PARAM_READWRITE));
1399 * GtkWidget:vexpand-set:
1401 * Whether to use the #GtkWidget:vexpand property. See gtk_widget_get_vexpand_set().
1405 g_object_class_install_property (gobject_class,
1407 g_param_spec_boolean ("vexpand-set",
1408 P_("Vertical Expand Set"),
1409 P_("Whether to use the vexpand property"),
1411 GTK_PARAM_READWRITE));
1416 * Whether to expand in both directions. Setting this sets both #GtkWidget:hexpand and #GtkWidget:vexpand
1420 g_object_class_install_property (gobject_class,
1422 g_param_spec_boolean ("expand",
1424 P_("Whether widget wants to expand in both directions"),
1426 GTK_PARAM_READWRITE));
1430 * @widget: the object which received the signal.
1432 widget_signals[SHOW] =
1433 g_signal_new (I_("show"),
1434 G_TYPE_FROM_CLASS (gobject_class),
1436 G_STRUCT_OFFSET (GtkWidgetClass, show),
1438 _gtk_marshal_VOID__VOID,
1443 * @widget: the object which received the signal.
1445 widget_signals[HIDE] =
1446 g_signal_new (I_("hide"),
1447 G_TYPE_FROM_CLASS (gobject_class),
1449 G_STRUCT_OFFSET (GtkWidgetClass, hide),
1451 _gtk_marshal_VOID__VOID,
1456 * @widget: the object which received the signal.
1458 widget_signals[MAP] =
1459 g_signal_new (I_("map"),
1460 G_TYPE_FROM_CLASS (gobject_class),
1462 G_STRUCT_OFFSET (GtkWidgetClass, map),
1464 _gtk_marshal_VOID__VOID,
1469 * @widget: the object which received the signal.
1471 widget_signals[UNMAP] =
1472 g_signal_new (I_("unmap"),
1473 G_TYPE_FROM_CLASS (gobject_class),
1475 G_STRUCT_OFFSET (GtkWidgetClass, unmap),
1477 _gtk_marshal_VOID__VOID,
1481 * GtkWidget::realize:
1482 * @widget: the object which received the signal.
1484 widget_signals[REALIZE] =
1485 g_signal_new (I_("realize"),
1486 G_TYPE_FROM_CLASS (gobject_class),
1488 G_STRUCT_OFFSET (GtkWidgetClass, realize),
1490 _gtk_marshal_VOID__VOID,
1494 * GtkWidget::unrealize:
1495 * @widget: the object which received the signal.
1497 widget_signals[UNREALIZE] =
1498 g_signal_new (I_("unrealize"),
1499 G_TYPE_FROM_CLASS (gobject_class),
1501 G_STRUCT_OFFSET (GtkWidgetClass, unrealize),
1503 _gtk_marshal_VOID__VOID,
1507 * GtkWidget::size-allocate:
1508 * @widget: the object which received the signal.
1511 widget_signals[SIZE_ALLOCATE] =
1512 g_signal_new (I_("size-allocate"),
1513 G_TYPE_FROM_CLASS (gobject_class),
1515 G_STRUCT_OFFSET (GtkWidgetClass, size_allocate),
1517 _gtk_marshal_VOID__BOXED,
1519 GDK_TYPE_RECTANGLE | G_SIGNAL_TYPE_STATIC_SCOPE);
1522 * GtkWidget::state-changed:
1523 * @widget: the object which received the signal.
1524 * @state: the previous state
1526 * The ::state-changed signal is emitted when the widget state changes.
1527 * See gtk_widget_get_state().
1529 * Deprecated: 3.0. Use #GtkWidget::state-flags-changed instead.
1531 widget_signals[STATE_CHANGED] =
1532 g_signal_new (I_("state-changed"),
1533 G_TYPE_FROM_CLASS (gobject_class),
1535 G_STRUCT_OFFSET (GtkWidgetClass, state_changed),
1537 _gtk_marshal_VOID__ENUM,
1539 GTK_TYPE_STATE_TYPE);
1542 * GtkWidget::state-flags-changed:
1543 * @widget: the object which received the signal.
1544 * @flags: The previous state flags.
1546 * The ::state-flags-changed signal is emitted when the widget state
1547 * changes, see gtk_widget_get_state_flags().
1551 widget_signals[STATE_FLAGS_CHANGED] =
1552 g_signal_new (I_("state-flags-changed"),
1553 G_TYPE_FROM_CLASS (gobject_class),
1555 G_STRUCT_OFFSET (GtkWidgetClass, state_flags_changed),
1557 _gtk_marshal_VOID__FLAGS,
1559 GTK_TYPE_STATE_FLAGS);
1562 * GtkWidget::parent-set:
1563 * @widget: the object on which the signal is emitted
1564 * @old_parent: (allow-none): the previous parent, or %NULL if the widget
1565 * just got its initial parent.
1567 * The ::parent-set signal is emitted when a new parent
1568 * has been set on a widget.
1570 widget_signals[PARENT_SET] =
1571 g_signal_new (I_("parent-set"),
1572 G_TYPE_FROM_CLASS (gobject_class),
1574 G_STRUCT_OFFSET (GtkWidgetClass, parent_set),
1576 _gtk_marshal_VOID__OBJECT,
1581 * GtkWidget::hierarchy-changed:
1582 * @widget: the object on which the signal is emitted
1583 * @previous_toplevel: (allow-none): the previous toplevel ancestor, or %NULL
1584 * if the widget was previously unanchored
1586 * The ::hierarchy-changed signal is emitted when the
1587 * anchored state of a widget changes. A widget is
1588 * <firstterm>anchored</firstterm> when its toplevel
1589 * ancestor is a #GtkWindow. This signal is emitted when
1590 * a widget changes from un-anchored to anchored or vice-versa.
1592 widget_signals[HIERARCHY_CHANGED] =
1593 g_signal_new (I_("hierarchy-changed"),
1594 G_TYPE_FROM_CLASS (gobject_class),
1596 G_STRUCT_OFFSET (GtkWidgetClass, hierarchy_changed),
1598 _gtk_marshal_VOID__OBJECT,
1603 * GtkWidget::style-set:
1604 * @widget: the object on which the signal is emitted
1605 * @previous_style: (allow-none): the previous style, or %NULL if the widget
1606 * just got its initial style
1608 * The ::style-set signal is emitted when a new style has been set
1609 * on a widget. Note that style-modifying functions like
1610 * gtk_widget_modify_base() also cause this signal to be emitted.
1612 * Note that this signal is emitted for changes to the deprecated
1613 * #GtkStyle. To track changes to the #GtkStyleContext associated
1614 * with a widget, use the #GtkWidget::style-updated signal.
1616 * Deprecated:3.0: Use the #GtkWidget::style-updated signal
1618 widget_signals[STYLE_SET] =
1619 g_signal_new (I_("style-set"),
1620 G_TYPE_FROM_CLASS (gobject_class),
1622 G_STRUCT_OFFSET (GtkWidgetClass, style_set),
1624 _gtk_marshal_VOID__OBJECT,
1629 * GtkWidget::style-updated:
1630 * @widget: the object on which the signal is emitted
1632 * The ::style-updated signal is emitted when the #GtkStyleContext
1633 * of a widget is changed. Note that style-modifying functions like
1634 * gtk_widget_override_color() also cause this signal to be emitted.
1638 widget_signals[STYLE_UPDATED] =
1639 g_signal_new (I_("style-updated"),
1640 G_TYPE_FROM_CLASS (gobject_class),
1642 G_STRUCT_OFFSET (GtkWidgetClass, style_updated),
1644 g_cclosure_marshal_VOID__VOID,
1648 * GtkWidget::direction-changed:
1649 * @widget: the object on which the signal is emitted
1650 * @previous_direction: the previous text direction of @widget
1652 * The ::direction-changed signal is emitted when the text direction
1653 * of a widget changes.
1655 widget_signals[DIRECTION_CHANGED] =
1656 g_signal_new (I_("direction-changed"),
1657 G_TYPE_FROM_CLASS (gobject_class),
1659 G_STRUCT_OFFSET (GtkWidgetClass, direction_changed),
1661 _gtk_marshal_VOID__ENUM,
1663 GTK_TYPE_TEXT_DIRECTION);
1666 * GtkWidget::grab-notify:
1667 * @widget: the object which received the signal
1668 * @was_grabbed: %FALSE if the widget becomes shadowed, %TRUE
1669 * if it becomes unshadowed
1671 * The ::grab-notify signal is emitted when a widget becomes
1672 * shadowed by a GTK+ grab (not a pointer or keyboard grab) on
1673 * another widget, or when it becomes unshadowed due to a grab
1676 * A widget is shadowed by a gtk_grab_add() when the topmost
1677 * grab widget in the grab stack of its window group is not
1680 widget_signals[GRAB_NOTIFY] =
1681 g_signal_new (I_("grab-notify"),
1682 G_TYPE_FROM_CLASS (gobject_class),
1684 G_STRUCT_OFFSET (GtkWidgetClass, grab_notify),
1686 _gtk_marshal_VOID__BOOLEAN,
1691 * GtkWidget::child-notify:
1692 * @widget: the object which received the signal
1693 * @child_property: the #GParamSpec of the changed child property
1695 * The ::child-notify signal is emitted for each
1696 * <link linkend="child-properties">child property</link> that has
1697 * changed on an object. The signal's detail holds the property name.
1699 widget_signals[CHILD_NOTIFY] =
1700 g_signal_new (I_("child-notify"),
1701 G_TYPE_FROM_CLASS (gobject_class),
1702 G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE | G_SIGNAL_DETAILED | G_SIGNAL_NO_HOOKS,
1703 G_STRUCT_OFFSET (GtkWidgetClass, child_notify),
1705 g_cclosure_marshal_VOID__PARAM,
1711 * @widget: the object which received the signal
1712 * @cr: the cairo context to draw to
1714 * This signal is emitted when a widget is supposed to render itself.
1715 * The @widget's top left corner must be painted at the origin of
1716 * the passed in context and be sized to the values returned by
1717 * gtk_widget_get_allocated_width() and
1718 * gtk_widget_get_allocated_height().
1720 * Signal handlers connected to this signal can modify the cairo
1721 * context passed as @cr in any way they like and don't need to
1722 * restore it. The signal emission takes care of calling cairo_save()
1723 * before and cairo_restore() after invoking the handler.
1725 * Returns: %TRUE to stop other handlers from being invoked for the event.
1726 % %FALSE to propagate the event further.
1730 widget_signals[DRAW] =
1731 g_signal_new (I_("draw"),
1732 G_TYPE_FROM_CLASS (gobject_class),
1734 G_STRUCT_OFFSET (GtkWidgetClass, draw),
1735 _gtk_boolean_handled_accumulator, NULL,
1736 gtk_widget_draw_marshaller,
1738 CAIRO_GOBJECT_TYPE_CONTEXT);
1739 g_signal_set_va_marshaller (widget_signals[DRAW], G_TYPE_FROM_CLASS (klass),
1740 gtk_widget_draw_marshallerv);
1743 * GtkWidget::mnemonic-activate:
1744 * @widget: the object which received the signal.
1747 * Returns: %TRUE to stop other handlers from being invoked for the event.
1748 * %FALSE to propagate the event further.
1750 widget_signals[MNEMONIC_ACTIVATE] =
1751 g_signal_new (I_("mnemonic-activate"),
1752 G_TYPE_FROM_CLASS (gobject_class),
1754 G_STRUCT_OFFSET (GtkWidgetClass, mnemonic_activate),
1755 _gtk_boolean_handled_accumulator, NULL,
1756 _gtk_marshal_BOOLEAN__BOOLEAN,
1761 * GtkWidget::grab-focus:
1762 * @widget: the object which received the signal.
1764 widget_signals[GRAB_FOCUS] =
1765 g_signal_new (I_("grab-focus"),
1766 G_TYPE_FROM_CLASS (gobject_class),
1767 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
1768 G_STRUCT_OFFSET (GtkWidgetClass, grab_focus),
1770 _gtk_marshal_VOID__VOID,
1775 * @widget: the object which received the signal.
1778 * Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
1780 widget_signals[FOCUS] =
1781 g_signal_new (I_("focus"),
1782 G_TYPE_FROM_CLASS (klass),
1784 G_STRUCT_OFFSET (GtkWidgetClass, focus),
1785 _gtk_boolean_handled_accumulator, NULL,
1786 _gtk_marshal_BOOLEAN__ENUM,
1788 GTK_TYPE_DIRECTION_TYPE);
1791 * GtkWidget::move-focus:
1792 * @widget: the object which received the signal.
1795 widget_signals[MOVE_FOCUS] =
1796 g_signal_new (I_("move-focus"),
1797 G_TYPE_FROM_CLASS (klass),
1798 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
1799 G_STRUCT_OFFSET (GtkWidgetClass, move_focus),
1801 _gtk_marshal_VOID__ENUM,
1804 GTK_TYPE_DIRECTION_TYPE);
1807 * GtkWidget::keynav-failed:
1808 * @widget: the object which received the signal
1809 * @direction: the direction of movement
1811 * Gets emitted if keyboard navigation fails.
1812 * See gtk_widget_keynav_failed() for details.
1814 * Returns: %TRUE if stopping keyboard navigation is fine, %FALSE
1815 * if the emitting widget should try to handle the keyboard
1816 * navigation attempt in its parent container(s).
1820 widget_signals[KEYNAV_FAILED] =
1821 g_signal_new (I_("keynav-failed"),
1822 G_TYPE_FROM_CLASS (klass),
1824 G_STRUCT_OFFSET (GtkWidgetClass, keynav_failed),
1825 _gtk_boolean_handled_accumulator, NULL,
1826 _gtk_marshal_BOOLEAN__ENUM,
1828 GTK_TYPE_DIRECTION_TYPE);
1832 * @widget: the object which received the signal.
1833 * @event: the #GdkEvent which triggered this signal
1835 * The GTK+ main loop will emit three signals for each GDK event delivered
1836 * to a widget: one generic ::event signal, another, more specific,
1837 * signal that matches the type of event delivered (e.g.
1838 * #GtkWidget::key-press-event) and finally a generic
1839 * #GtkWidget::event-after signal.
1841 * Returns: %TRUE to stop other handlers from being invoked for the event
1842 * and to cancel the emission of the second specific ::event signal.
1843 * %FALSE to propagate the event further and to allow the emission of
1844 * the second signal. The ::event-after signal is emitted regardless of
1847 widget_signals[EVENT] =
1848 g_signal_new (I_("event"),
1849 G_TYPE_FROM_CLASS (klass),
1851 G_STRUCT_OFFSET (GtkWidgetClass, event),
1852 _gtk_boolean_handled_accumulator, NULL,
1853 _gtk_marshal_BOOLEAN__BOXED,
1855 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1856 g_signal_set_va_marshaller (widget_signals[EVENT], G_TYPE_FROM_CLASS (klass),
1857 _gtk_marshal_BOOLEAN__BOXEDv);
1860 * GtkWidget::event-after:
1861 * @widget: the object which received the signal.
1862 * @event: the #GdkEvent which triggered this signal
1864 * After the emission of the #GtkWidget::event signal and (optionally)
1865 * the second more specific signal, ::event-after will be emitted
1866 * regardless of the previous two signals handlers return values.
1869 widget_signals[EVENT_AFTER] =
1870 g_signal_new (I_("event-after"),
1871 G_TYPE_FROM_CLASS (klass),
1875 _gtk_marshal_VOID__BOXED,
1877 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1878 g_signal_set_va_marshaller (widget_signals[EVENT_AFTER], G_TYPE_FROM_CLASS (klass),
1879 _gtk_marshal_BOOLEAN__BOXEDv);
1882 * GtkWidget::button-press-event:
1883 * @widget: the object which received the signal.
1884 * @event: (type Gdk.EventButton): the #GdkEventButton which triggered
1887 * The ::button-press-event signal will be emitted when a button
1888 * (typically from a mouse) is pressed.
1890 * To receive this signal, the #GdkWindow associated to the
1891 * widget needs to enable the #GDK_BUTTON_PRESS_MASK mask.
1893 * This signal will be sent to the grab widget if there is one.
1895 * Returns: %TRUE to stop other handlers from being invoked for the event.
1896 * %FALSE to propagate the event further.
1898 widget_signals[BUTTON_PRESS_EVENT] =
1899 g_signal_new (I_("button-press-event"),
1900 G_TYPE_FROM_CLASS (klass),
1902 G_STRUCT_OFFSET (GtkWidgetClass, button_press_event),
1903 _gtk_boolean_handled_accumulator, NULL,
1904 _gtk_marshal_BOOLEAN__BOXED,
1906 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1907 g_signal_set_va_marshaller (widget_signals[BUTTON_PRESS_EVENT], G_TYPE_FROM_CLASS (klass),
1908 _gtk_marshal_BOOLEAN__BOXEDv);
1911 * GtkWidget::button-release-event:
1912 * @widget: the object which received the signal.
1913 * @event: (type Gdk.EventButton): the #GdkEventButton which triggered
1916 * The ::button-release-event signal will be emitted when a button
1917 * (typically from a mouse) is released.
1919 * To receive this signal, the #GdkWindow associated to the
1920 * widget needs to enable the #GDK_BUTTON_RELEASE_MASK mask.
1922 * This signal will be sent to the grab widget if there is one.
1924 * Returns: %TRUE to stop other handlers from being invoked for the event.
1925 * %FALSE to propagate the event further.
1927 widget_signals[BUTTON_RELEASE_EVENT] =
1928 g_signal_new (I_("button-release-event"),
1929 G_TYPE_FROM_CLASS (klass),
1931 G_STRUCT_OFFSET (GtkWidgetClass, button_release_event),
1932 _gtk_boolean_handled_accumulator, NULL,
1933 _gtk_marshal_BOOLEAN__BOXED,
1935 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1936 g_signal_set_va_marshaller (widget_signals[BUTTON_RELEASE_EVENT], G_TYPE_FROM_CLASS (klass),
1937 _gtk_marshal_BOOLEAN__BOXEDv);
1939 widget_signals[TOUCH_EVENT] =
1940 g_signal_new (I_("touch-event"),
1941 G_TYPE_FROM_CLASS (klass),
1943 G_STRUCT_OFFSET (GtkWidgetClass, touch_event),
1944 _gtk_boolean_handled_accumulator, NULL,
1945 _gtk_marshal_BOOLEAN__BOXED,
1947 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1948 g_signal_set_va_marshaller (widget_signals[TOUCH_EVENT], G_TYPE_FROM_CLASS (klass),
1949 _gtk_marshal_BOOLEAN__BOXEDv);
1952 * GtkWidget::scroll-event:
1953 * @widget: the object which received the signal.
1954 * @event: (type Gdk.EventScroll): the #GdkEventScroll which triggered
1957 * The ::scroll-event signal is emitted when a button in the 4 to 7
1958 * range is pressed. Wheel mice are usually configured to generate
1959 * button press events for buttons 4 and 5 when the wheel is turned.
1961 * To receive this signal, the #GdkWindow associated to the widget needs
1962 * to enable the #GDK_SCROLL_MASK mask.
1964 * This signal will be sent to the grab widget if there is one.
1966 * Returns: %TRUE to stop other handlers from being invoked for the event.
1967 * %FALSE to propagate the event further.
1969 widget_signals[SCROLL_EVENT] =
1970 g_signal_new (I_("scroll-event"),
1971 G_TYPE_FROM_CLASS (klass),
1973 G_STRUCT_OFFSET (GtkWidgetClass, scroll_event),
1974 _gtk_boolean_handled_accumulator, NULL,
1975 _gtk_marshal_BOOLEAN__BOXED,
1977 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1978 g_signal_set_va_marshaller (widget_signals[SCROLL_EVENT], G_TYPE_FROM_CLASS (klass),
1979 _gtk_marshal_BOOLEAN__BOXEDv);
1982 * GtkWidget::motion-notify-event:
1983 * @widget: the object which received the signal.
1984 * @event: (type Gdk.EventMotion): the #GdkEventMotion which triggered
1987 * The ::motion-notify-event signal is emitted when the pointer moves
1988 * over the widget's #GdkWindow.
1990 * To receive this signal, the #GdkWindow associated to the widget
1991 * needs to enable the #GDK_POINTER_MOTION_MASK mask.
1993 * This signal will be sent to the grab widget if there is one.
1995 * Returns: %TRUE to stop other handlers from being invoked for the event.
1996 * %FALSE to propagate the event further.
1998 widget_signals[MOTION_NOTIFY_EVENT] =
1999 g_signal_new (I_("motion-notify-event"),
2000 G_TYPE_FROM_CLASS (klass),
2002 G_STRUCT_OFFSET (GtkWidgetClass, motion_notify_event),
2003 _gtk_boolean_handled_accumulator, NULL,
2004 _gtk_marshal_BOOLEAN__BOXED,
2006 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2007 g_signal_set_va_marshaller (widget_signals[MOTION_NOTIFY_EVENT], G_TYPE_FROM_CLASS (klass),
2008 _gtk_marshal_BOOLEAN__BOXEDv);
2011 * GtkWidget::composited-changed:
2012 * @widget: the object on which the signal is emitted
2014 * The ::composited-changed signal is emitted when the composited
2015 * status of @widget<!-- -->s screen changes.
2016 * See gdk_screen_is_composited().
2018 widget_signals[COMPOSITED_CHANGED] =
2019 g_signal_new (I_("composited-changed"),
2020 G_TYPE_FROM_CLASS (klass),
2021 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
2022 G_STRUCT_OFFSET (GtkWidgetClass, composited_changed),
2024 _gtk_marshal_VOID__VOID,
2028 * GtkWidget::delete-event:
2029 * @widget: the object which received the signal
2030 * @event: the event which triggered this signal
2032 * The ::delete-event signal is emitted if a user requests that
2033 * a toplevel window is closed. The default handler for this signal
2034 * destroys the window. Connecting gtk_widget_hide_on_delete() to
2035 * this signal will cause the window to be hidden instead, so that
2036 * it can later be shown again without reconstructing it.
2038 * Returns: %TRUE to stop other handlers from being invoked for the event.
2039 * %FALSE to propagate the event further.
2041 widget_signals[DELETE_EVENT] =
2042 g_signal_new (I_("delete-event"),
2043 G_TYPE_FROM_CLASS (klass),
2045 G_STRUCT_OFFSET (GtkWidgetClass, delete_event),
2046 _gtk_boolean_handled_accumulator, NULL,
2047 _gtk_marshal_BOOLEAN__BOXED,
2049 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2050 g_signal_set_va_marshaller (widget_signals[DELETE_EVENT], G_TYPE_FROM_CLASS (klass),
2051 _gtk_marshal_BOOLEAN__BOXEDv);
2054 * GtkWidget::destroy-event:
2055 * @widget: the object which received the signal.
2056 * @event: the event which triggered this signal
2058 * The ::destroy-event signal is emitted when a #GdkWindow is destroyed.
2059 * You rarely get this signal, because most widgets disconnect themselves
2060 * from their window before they destroy it, so no widget owns the
2061 * window at destroy time.
2063 * To receive this signal, the #GdkWindow associated to the widget needs
2064 * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
2065 * automatically for all new windows.
2067 * Returns: %TRUE to stop other handlers from being invoked for the event.
2068 * %FALSE to propagate the event further.
2070 widget_signals[DESTROY_EVENT] =
2071 g_signal_new (I_("destroy-event"),
2072 G_TYPE_FROM_CLASS (klass),
2074 G_STRUCT_OFFSET (GtkWidgetClass, destroy_event),
2075 _gtk_boolean_handled_accumulator, NULL,
2076 _gtk_marshal_BOOLEAN__BOXED,
2078 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2079 g_signal_set_va_marshaller (widget_signals[DESTROY_EVENT], G_TYPE_FROM_CLASS (klass),
2080 _gtk_marshal_BOOLEAN__BOXEDv);
2083 * GtkWidget::key-press-event:
2084 * @widget: the object which received the signal
2085 * @event: (type Gdk.EventKey): the #GdkEventKey which triggered this signal.
2087 * The ::key-press-event signal is emitted when a key is pressed. The signal
2088 * emission will reoccur at the key-repeat rate when the key is kept pressed.
2090 * To receive this signal, the #GdkWindow associated to the widget needs
2091 * to enable the #GDK_KEY_PRESS_MASK mask.
2093 * This signal will be sent to the grab widget if there is one.
2095 * Returns: %TRUE to stop other handlers from being invoked for the event.
2096 * %FALSE to propagate the event further.
2098 widget_signals[KEY_PRESS_EVENT] =
2099 g_signal_new (I_("key-press-event"),
2100 G_TYPE_FROM_CLASS (klass),
2102 G_STRUCT_OFFSET (GtkWidgetClass, key_press_event),
2103 _gtk_boolean_handled_accumulator, NULL,
2104 _gtk_marshal_BOOLEAN__BOXED,
2106 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2107 g_signal_set_va_marshaller (widget_signals[KEY_PRESS_EVENT], G_TYPE_FROM_CLASS (klass),
2108 _gtk_marshal_BOOLEAN__BOXEDv);
2111 * GtkWidget::key-release-event:
2112 * @widget: the object which received the signal
2113 * @event: (type Gdk.EventKey): the #GdkEventKey which triggered this signal.
2115 * The ::key-release-event signal is emitted when a key is released.
2117 * To receive this signal, the #GdkWindow associated to the widget needs
2118 * to enable the #GDK_KEY_RELEASE_MASK mask.
2120 * This signal will be sent to the grab widget if there is one.
2122 * Returns: %TRUE to stop other handlers from being invoked for the event.
2123 * %FALSE to propagate the event further.
2125 widget_signals[KEY_RELEASE_EVENT] =
2126 g_signal_new (I_("key-release-event"),
2127 G_TYPE_FROM_CLASS (klass),
2129 G_STRUCT_OFFSET (GtkWidgetClass, key_release_event),
2130 _gtk_boolean_handled_accumulator, NULL,
2131 _gtk_marshal_BOOLEAN__BOXED,
2133 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2134 g_signal_set_va_marshaller (widget_signals[KEY_RELEASE_EVENT], G_TYPE_FROM_CLASS (klass),
2135 _gtk_marshal_BOOLEAN__BOXEDv);
2138 * GtkWidget::enter-notify-event:
2139 * @widget: the object which received the signal
2140 * @event: (type Gdk.EventCrossing): the #GdkEventCrossing which triggered
2143 * The ::enter-notify-event will be emitted when the pointer enters
2144 * the @widget's window.
2146 * To receive this signal, the #GdkWindow associated to the widget needs
2147 * to enable the #GDK_ENTER_NOTIFY_MASK mask.
2149 * This signal will be sent to the grab widget if there is one.
2151 * Returns: %TRUE to stop other handlers from being invoked for the event.
2152 * %FALSE to propagate the event further.
2154 widget_signals[ENTER_NOTIFY_EVENT] =
2155 g_signal_new (I_("enter-notify-event"),
2156 G_TYPE_FROM_CLASS (klass),
2158 G_STRUCT_OFFSET (GtkWidgetClass, enter_notify_event),
2159 _gtk_boolean_handled_accumulator, NULL,
2160 _gtk_marshal_BOOLEAN__BOXED,
2162 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2163 g_signal_set_va_marshaller (widget_signals[ENTER_NOTIFY_EVENT], G_TYPE_FROM_CLASS (klass),
2164 _gtk_marshal_BOOLEAN__BOXEDv);
2167 * GtkWidget::leave-notify-event:
2168 * @widget: the object which received the signal
2169 * @event: (type Gdk.EventCrossing): the #GdkEventCrossing which triggered
2172 * The ::leave-notify-event will be emitted when the pointer leaves
2173 * the @widget's window.
2175 * To receive this signal, the #GdkWindow associated to the widget needs
2176 * to enable the #GDK_LEAVE_NOTIFY_MASK mask.
2178 * This signal will be sent to the grab widget if there is one.
2180 * Returns: %TRUE to stop other handlers from being invoked for the event.
2181 * %FALSE to propagate the event further.
2183 widget_signals[LEAVE_NOTIFY_EVENT] =
2184 g_signal_new (I_("leave-notify-event"),
2185 G_TYPE_FROM_CLASS (klass),
2187 G_STRUCT_OFFSET (GtkWidgetClass, leave_notify_event),
2188 _gtk_boolean_handled_accumulator, NULL,
2189 _gtk_marshal_BOOLEAN__BOXED,
2191 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2192 g_signal_set_va_marshaller (widget_signals[LEAVE_NOTIFY_EVENT], G_TYPE_FROM_CLASS (klass),
2193 _gtk_marshal_BOOLEAN__BOXEDv);
2196 * GtkWidget::configure-event:
2197 * @widget: the object which received the signal
2198 * @event: (type Gdk.EventConfigure): the #GdkEventConfigure which triggered
2201 * The ::configure-event signal will be emitted when the size, position or
2202 * stacking of the @widget's window has changed.
2204 * To receive this signal, the #GdkWindow associated to the widget needs
2205 * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
2206 * automatically for all new windows.
2208 * Returns: %TRUE to stop other handlers from being invoked for the event.
2209 * %FALSE to propagate the event further.
2211 widget_signals[CONFIGURE_EVENT] =
2212 g_signal_new (I_("configure-event"),
2213 G_TYPE_FROM_CLASS (klass),
2215 G_STRUCT_OFFSET (GtkWidgetClass, configure_event),
2216 _gtk_boolean_handled_accumulator, NULL,
2217 _gtk_marshal_BOOLEAN__BOXED,
2219 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2220 g_signal_set_va_marshaller (widget_signals[CONFIGURE_EVENT], G_TYPE_FROM_CLASS (klass),
2221 _gtk_marshal_BOOLEAN__BOXEDv);
2224 * GtkWidget::focus-in-event:
2225 * @widget: the object which received the signal
2226 * @event: (type Gdk.EventFocus): the #GdkEventFocus which triggered
2229 * The ::focus-in-event signal will be emitted when the keyboard focus
2230 * enters the @widget's window.
2232 * To receive this signal, the #GdkWindow associated to the widget needs
2233 * to enable the #GDK_FOCUS_CHANGE_MASK mask.
2235 * Returns: %TRUE to stop other handlers from being invoked for the event.
2236 * %FALSE to propagate the event further.
2238 widget_signals[FOCUS_IN_EVENT] =
2239 g_signal_new (I_("focus-in-event"),
2240 G_TYPE_FROM_CLASS (klass),
2242 G_STRUCT_OFFSET (GtkWidgetClass, focus_in_event),
2243 _gtk_boolean_handled_accumulator, NULL,
2244 _gtk_marshal_BOOLEAN__BOXED,
2246 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2247 g_signal_set_va_marshaller (widget_signals[FOCUS_IN_EVENT], G_TYPE_FROM_CLASS (klass),
2248 _gtk_marshal_BOOLEAN__BOXEDv);
2251 * GtkWidget::focus-out-event:
2252 * @widget: the object which received the signal
2253 * @event: (type Gdk.EventFocus): the #GdkEventFocus which triggered this
2256 * The ::focus-out-event signal will be emitted when the keyboard focus
2257 * leaves the @widget's window.
2259 * To receive this signal, the #GdkWindow associated to the widget needs
2260 * to enable the #GDK_FOCUS_CHANGE_MASK mask.
2262 * Returns: %TRUE to stop other handlers from being invoked for the event.
2263 * %FALSE to propagate the event further.
2265 widget_signals[FOCUS_OUT_EVENT] =
2266 g_signal_new (I_("focus-out-event"),
2267 G_TYPE_FROM_CLASS (klass),
2269 G_STRUCT_OFFSET (GtkWidgetClass, focus_out_event),
2270 _gtk_boolean_handled_accumulator, NULL,
2271 _gtk_marshal_BOOLEAN__BOXED,
2273 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2274 g_signal_set_va_marshaller (widget_signals[FOCUS_OUT_EVENT], G_TYPE_FROM_CLASS (klass),
2275 _gtk_marshal_BOOLEAN__BOXEDv);
2278 * GtkWidget::map-event:
2279 * @widget: the object which received the signal
2280 * @event: (type Gdk.EventAny): the #GdkEventAny which triggered this signal.
2282 * The ::map-event signal will be emitted when the @widget's window is
2283 * mapped. A window is mapped when it becomes visible on the screen.
2285 * To receive this signal, the #GdkWindow associated to the widget needs
2286 * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
2287 * automatically for all new windows.
2289 * Returns: %TRUE to stop other handlers from being invoked for the event.
2290 * %FALSE to propagate the event further.
2292 widget_signals[MAP_EVENT] =
2293 g_signal_new (I_("map-event"),
2294 G_TYPE_FROM_CLASS (klass),
2296 G_STRUCT_OFFSET (GtkWidgetClass, map_event),
2297 _gtk_boolean_handled_accumulator, NULL,
2298 _gtk_marshal_BOOLEAN__BOXED,
2300 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2301 g_signal_set_va_marshaller (widget_signals[MAP_EVENT], G_TYPE_FROM_CLASS (klass),
2302 _gtk_marshal_BOOLEAN__BOXEDv);
2305 * GtkWidget::unmap-event:
2306 * @widget: the object which received the signal
2307 * @event: (type Gdk.EventAny): the #GdkEventAny which triggered this signal
2309 * The ::unmap-event signal will be emitted when the @widget's window is
2310 * unmapped. A window is unmapped when it becomes invisible on the screen.
2312 * To receive this signal, the #GdkWindow associated to the widget needs
2313 * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
2314 * automatically for all new windows.
2316 * Returns: %TRUE to stop other handlers from being invoked for the event.
2317 * %FALSE to propagate the event further.
2319 widget_signals[UNMAP_EVENT] =
2320 g_signal_new (I_("unmap-event"),
2321 G_TYPE_FROM_CLASS (klass),
2323 G_STRUCT_OFFSET (GtkWidgetClass, unmap_event),
2324 _gtk_boolean_handled_accumulator, NULL,
2325 _gtk_marshal_BOOLEAN__BOXED,
2327 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2328 g_signal_set_va_marshaller (widget_signals[UNMAP_EVENT], G_TYPE_FROM_CLASS (klass),
2329 _gtk_marshal_BOOLEAN__BOXEDv);
2332 * GtkWidget::property-notify-event:
2333 * @widget: the object which received the signal
2334 * @event: (type Gdk.EventProperty): the #GdkEventProperty which triggered
2337 * The ::property-notify-event signal will be emitted when a property on
2338 * the @widget's window has been changed or deleted.
2340 * To receive this signal, the #GdkWindow associated to the widget needs
2341 * to enable the #GDK_PROPERTY_CHANGE_MASK mask.
2343 * Returns: %TRUE to stop other handlers from being invoked for the event.
2344 * %FALSE to propagate the event further.
2346 widget_signals[PROPERTY_NOTIFY_EVENT] =
2347 g_signal_new (I_("property-notify-event"),
2348 G_TYPE_FROM_CLASS (klass),
2350 G_STRUCT_OFFSET (GtkWidgetClass, property_notify_event),
2351 _gtk_boolean_handled_accumulator, NULL,
2352 _gtk_marshal_BOOLEAN__BOXED,
2354 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2355 g_signal_set_va_marshaller (widget_signals[PROPERTY_NOTIFY_EVENT], G_TYPE_FROM_CLASS (klass),
2356 _gtk_marshal_BOOLEAN__BOXEDv);
2359 * GtkWidget::selection-clear-event:
2360 * @widget: the object which received the signal
2361 * @event: (type Gdk.EventSelection): the #GdkEventSelection which triggered
2364 * The ::selection-clear-event signal will be emitted when the
2365 * the @widget's window has lost ownership of a selection.
2367 * Returns: %TRUE to stop other handlers from being invoked for the event.
2368 * %FALSE to propagate the event further.
2370 widget_signals[SELECTION_CLEAR_EVENT] =
2371 g_signal_new (I_("selection-clear-event"),
2372 G_TYPE_FROM_CLASS (klass),
2374 G_STRUCT_OFFSET (GtkWidgetClass, selection_clear_event),
2375 _gtk_boolean_handled_accumulator, NULL,
2376 _gtk_marshal_BOOLEAN__BOXED,
2378 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2379 g_signal_set_va_marshaller (widget_signals[SELECTION_CLEAR_EVENT], G_TYPE_FROM_CLASS (klass),
2380 _gtk_marshal_BOOLEAN__BOXEDv);
2383 * GtkWidget::selection-request-event:
2384 * @widget: the object which received the signal
2385 * @event: (type Gdk.EventSelection): the #GdkEventSelection which triggered
2388 * The ::selection-request-event signal will be emitted when
2389 * another client requests ownership of the selection owned by
2390 * the @widget's window.
2392 * Returns: %TRUE to stop other handlers from being invoked for the event.
2393 * %FALSE to propagate the event further.
2395 widget_signals[SELECTION_REQUEST_EVENT] =
2396 g_signal_new (I_("selection-request-event"),
2397 G_TYPE_FROM_CLASS (klass),
2399 G_STRUCT_OFFSET (GtkWidgetClass, selection_request_event),
2400 _gtk_boolean_handled_accumulator, NULL,
2401 _gtk_marshal_BOOLEAN__BOXED,
2403 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2404 g_signal_set_va_marshaller (widget_signals[SELECTION_REQUEST_EVENT], G_TYPE_FROM_CLASS (klass),
2405 _gtk_marshal_BOOLEAN__BOXEDv);
2408 * GtkWidget::selection-notify-event:
2409 * @widget: the object which received the signal.
2410 * @event: (type Gdk.EventSelection):
2412 * Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
2414 widget_signals[SELECTION_NOTIFY_EVENT] =
2415 g_signal_new (I_("selection-notify-event"),
2416 G_TYPE_FROM_CLASS (klass),
2418 G_STRUCT_OFFSET (GtkWidgetClass, selection_notify_event),
2419 _gtk_boolean_handled_accumulator, NULL,
2420 _gtk_marshal_BOOLEAN__BOXED,
2422 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2423 g_signal_set_va_marshaller (widget_signals[SELECTION_NOTIFY_EVENT], G_TYPE_FROM_CLASS (klass),
2424 _gtk_marshal_BOOLEAN__BOXEDv);
2427 * GtkWidget::selection-received:
2428 * @widget: the object which received the signal.
2432 widget_signals[SELECTION_RECEIVED] =
2433 g_signal_new (I_("selection-received"),
2434 G_TYPE_FROM_CLASS (klass),
2436 G_STRUCT_OFFSET (GtkWidgetClass, selection_received),
2438 _gtk_marshal_VOID__BOXED_UINT,
2440 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
2444 * GtkWidget::selection-get:
2445 * @widget: the object which received the signal.
2450 widget_signals[SELECTION_GET] =
2451 g_signal_new (I_("selection-get"),
2452 G_TYPE_FROM_CLASS (klass),
2454 G_STRUCT_OFFSET (GtkWidgetClass, selection_get),
2456 _gtk_marshal_VOID__BOXED_UINT_UINT,
2458 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
2463 * GtkWidget::proximity-in-event:
2464 * @widget: the object which received the signal
2465 * @event: (type Gdk.EventProximity): the #GdkEventProximity which triggered
2468 * To receive this signal the #GdkWindow associated to the widget needs
2469 * to enable the #GDK_PROXIMITY_IN_MASK mask.
2471 * This signal will be sent to the grab widget if there is one.
2473 * Returns: %TRUE to stop other handlers from being invoked for the event.
2474 * %FALSE to propagate the event further.
2476 widget_signals[PROXIMITY_IN_EVENT] =
2477 g_signal_new (I_("proximity-in-event"),
2478 G_TYPE_FROM_CLASS (klass),
2480 G_STRUCT_OFFSET (GtkWidgetClass, proximity_in_event),
2481 _gtk_boolean_handled_accumulator, NULL,
2482 _gtk_marshal_BOOLEAN__BOXED,
2484 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2485 g_signal_set_va_marshaller (widget_signals[PROXIMITY_IN_EVENT], G_TYPE_FROM_CLASS (klass),
2486 _gtk_marshal_BOOLEAN__BOXEDv);
2489 * GtkWidget::proximity-out-event:
2490 * @widget: the object which received the signal
2491 * @event: (type Gdk.EventProximity): the #GdkEventProximity which triggered
2494 * To receive this signal the #GdkWindow associated to the widget needs
2495 * to enable the #GDK_PROXIMITY_OUT_MASK mask.
2497 * This signal will be sent to the grab widget if there is one.
2499 * Returns: %TRUE to stop other handlers from being invoked for the event.
2500 * %FALSE to propagate the event further.
2502 widget_signals[PROXIMITY_OUT_EVENT] =
2503 g_signal_new (I_("proximity-out-event"),
2504 G_TYPE_FROM_CLASS (klass),
2506 G_STRUCT_OFFSET (GtkWidgetClass, proximity_out_event),
2507 _gtk_boolean_handled_accumulator, NULL,
2508 _gtk_marshal_BOOLEAN__BOXED,
2510 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2511 g_signal_set_va_marshaller (widget_signals[PROXIMITY_OUT_EVENT], G_TYPE_FROM_CLASS (klass),
2512 _gtk_marshal_BOOLEAN__BOXEDv);
2515 * GtkWidget::drag-leave:
2516 * @widget: the object which received the signal.
2517 * @context: the drag context
2518 * @time: the timestamp of the motion event
2520 * The ::drag-leave signal is emitted on the drop site when the cursor
2521 * leaves the widget. A typical reason to connect to this signal is to
2522 * undo things done in #GtkWidget::drag-motion, e.g. undo highlighting
2523 * with gtk_drag_unhighlight()
2525 widget_signals[DRAG_LEAVE] =
2526 g_signal_new (I_("drag-leave"),
2527 G_TYPE_FROM_CLASS (klass),
2529 G_STRUCT_OFFSET (GtkWidgetClass, drag_leave),
2531 _gtk_marshal_VOID__OBJECT_UINT,
2533 GDK_TYPE_DRAG_CONTEXT,
2537 * GtkWidget::drag-begin:
2538 * @widget: the object which received the signal
2539 * @context: the drag context
2541 * The ::drag-begin signal is emitted on the drag source when a drag is
2542 * started. A typical reason to connect to this signal is to set up a
2543 * custom drag icon with e.g. gtk_drag_source_set_icon_pixbuf().
2545 * Note that some widgets set up a drag icon in the default handler of
2546 * this signal, so you may have to use g_signal_connect_after() to
2547 * override what the default handler did.
2549 widget_signals[DRAG_BEGIN] =
2550 g_signal_new (I_("drag-begin"),
2551 G_TYPE_FROM_CLASS (klass),
2553 G_STRUCT_OFFSET (GtkWidgetClass, drag_begin),
2555 _gtk_marshal_VOID__OBJECT,
2557 GDK_TYPE_DRAG_CONTEXT);
2560 * GtkWidget::drag-end:
2561 * @widget: the object which received the signal
2562 * @context: the drag context
2564 * The ::drag-end signal is emitted on the drag source when a drag is
2565 * finished. A typical reason to connect to this signal is to undo
2566 * things done in #GtkWidget::drag-begin.
2568 widget_signals[DRAG_END] =
2569 g_signal_new (I_("drag-end"),
2570 G_TYPE_FROM_CLASS (klass),
2572 G_STRUCT_OFFSET (GtkWidgetClass, drag_end),
2574 _gtk_marshal_VOID__OBJECT,
2576 GDK_TYPE_DRAG_CONTEXT);
2579 * GtkWidget::drag-data-delete:
2580 * @widget: the object which received the signal
2581 * @context: the drag context
2583 * The ::drag-data-delete signal is emitted on the drag source when a drag
2584 * with the action %GDK_ACTION_MOVE is successfully completed. The signal
2585 * handler is responsible for deleting the data that has been dropped. What
2586 * "delete" means depends on the context of the drag operation.
2588 widget_signals[DRAG_DATA_DELETE] =
2589 g_signal_new (I_("drag-data-delete"),
2590 G_TYPE_FROM_CLASS (klass),
2592 G_STRUCT_OFFSET (GtkWidgetClass, drag_data_delete),
2594 _gtk_marshal_VOID__OBJECT,
2596 GDK_TYPE_DRAG_CONTEXT);
2599 * GtkWidget::drag-failed:
2600 * @widget: the object which received the signal
2601 * @context: the drag context
2602 * @result: the result of the drag operation
2604 * The ::drag-failed signal is emitted on the drag source when a drag has
2605 * failed. The signal handler may hook custom code to handle a failed DND
2606 * operation based on the type of error, it returns %TRUE is the failure has
2607 * been already handled (not showing the default "drag operation failed"
2608 * animation), otherwise it returns %FALSE.
2610 * Return value: %TRUE if the failed drag operation has been already handled.
2614 widget_signals[DRAG_FAILED] =
2615 g_signal_new (I_("drag-failed"),
2616 G_TYPE_FROM_CLASS (klass),
2618 G_STRUCT_OFFSET (GtkWidgetClass, drag_failed),
2619 _gtk_boolean_handled_accumulator, NULL,
2620 _gtk_marshal_BOOLEAN__OBJECT_ENUM,
2622 GDK_TYPE_DRAG_CONTEXT,
2623 GTK_TYPE_DRAG_RESULT);
2626 * GtkWidget::drag-motion:
2627 * @widget: the object which received the signal
2628 * @context: the drag context
2629 * @x: the x coordinate of the current cursor position
2630 * @y: the y coordinate of the current cursor position
2631 * @time: the timestamp of the motion event
2633 * The ::drag-motion signal is emitted on the drop site when the user
2634 * moves the cursor over the widget during a drag. The signal handler
2635 * must determine whether the cursor position is in a drop zone or not.
2636 * If it is not in a drop zone, it returns %FALSE and no further processing
2637 * is necessary. Otherwise, the handler returns %TRUE. In this case, the
2638 * handler is responsible for providing the necessary information for
2639 * displaying feedback to the user, by calling gdk_drag_status().
2641 * If the decision whether the drop will be accepted or rejected can't be
2642 * made based solely on the cursor position and the type of the data, the
2643 * handler may inspect the dragged data by calling gtk_drag_get_data() and
2644 * defer the gdk_drag_status() call to the #GtkWidget::drag-data-received
2645 * handler. Note that you cannot not pass #GTK_DEST_DEFAULT_DROP,
2646 * #GTK_DEST_DEFAULT_MOTION or #GTK_DEST_DEFAULT_ALL to gtk_drag_dest_set()
2647 * when using the drag-motion signal that way.
2649 * Also note that there is no drag-enter signal. The drag receiver has to
2650 * keep track of whether he has received any drag-motion signals since the
2651 * last #GtkWidget::drag-leave and if not, treat the drag-motion signal as
2652 * an "enter" signal. Upon an "enter", the handler will typically highlight
2653 * the drop site with gtk_drag_highlight().
2656 * drag_motion (GtkWidget *widget,
2657 * GdkDragContext *context,
2664 * PrivateData *private_data = GET_PRIVATE_DATA (widget);
2666 * if (!private_data->drag_highlight)
2668 * private_data->drag_highlight = 1;
2669 * gtk_drag_highlight (widget);
2672 * target = gtk_drag_dest_find_target (widget, context, NULL);
2673 * if (target == GDK_NONE)
2674 * gdk_drag_status (context, 0, time);
2677 * private_data->pending_status = gdk_drag_context_get_suggested_action (context);
2678 * gtk_drag_get_data (widget, context, target, time);
2685 * drag_data_received (GtkWidget *widget,
2686 * GdkDragContext *context,
2689 * GtkSelectionData *selection_data,
2693 * PrivateData *private_data = GET_PRIVATE_DATA (widget);
2695 * if (private_data->suggested_action)
2697 * private_data->suggested_action = 0;
2699 * /* We are getting this data due to a request in drag_motion,
2700 * * rather than due to a request in drag_drop, so we are just
2701 * * supposed to call gdk_drag_status(), not actually paste in
2704 * str = gtk_selection_data_get_text (selection_data);
2705 * if (!data_is_acceptable (str))
2706 * gdk_drag_status (context, 0, time);
2708 * gdk_drag_status (context, private_data->suggested_action, time);
2712 * /* accept the drop */
2717 * Returns: whether the cursor position is in a drop zone
2719 widget_signals[DRAG_MOTION] =
2720 g_signal_new (I_("drag-motion"),
2721 G_TYPE_FROM_CLASS (klass),
2723 G_STRUCT_OFFSET (GtkWidgetClass, drag_motion),
2724 _gtk_boolean_handled_accumulator, NULL,
2725 _gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
2727 GDK_TYPE_DRAG_CONTEXT,
2733 * GtkWidget::drag-drop:
2734 * @widget: the object which received the signal
2735 * @context: the drag context
2736 * @x: the x coordinate of the current cursor position
2737 * @y: the y coordinate of the current cursor position
2738 * @time: the timestamp of the motion event
2740 * The ::drag-drop signal is emitted on the drop site when the user drops
2741 * the data onto the widget. The signal handler must determine whether
2742 * the cursor position is in a drop zone or not. If it is not in a drop
2743 * zone, it returns %FALSE and no further processing is necessary.
2744 * Otherwise, the handler returns %TRUE. In this case, the handler must
2745 * ensure that gtk_drag_finish() is called to let the source know that
2746 * the drop is done. The call to gtk_drag_finish() can be done either
2747 * directly or in a #GtkWidget::drag-data-received handler which gets
2748 * triggered by calling gtk_drag_get_data() to receive the data for one
2749 * or more of the supported targets.
2751 * Returns: whether the cursor position is in a drop zone
2753 widget_signals[DRAG_DROP] =
2754 g_signal_new (I_("drag-drop"),
2755 G_TYPE_FROM_CLASS (klass),
2757 G_STRUCT_OFFSET (GtkWidgetClass, drag_drop),
2758 _gtk_boolean_handled_accumulator, NULL,
2759 _gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
2761 GDK_TYPE_DRAG_CONTEXT,
2767 * GtkWidget::drag-data-get:
2768 * @widget: the object which received the signal
2769 * @context: the drag context
2770 * @data: the #GtkSelectionData to be filled with the dragged data
2771 * @info: the info that has been registered with the target in the
2773 * @time: the timestamp at which the data was requested
2775 * The ::drag-data-get signal is emitted on the drag source when the drop
2776 * site requests the data which is dragged. It is the responsibility of
2777 * the signal handler to fill @data with the data in the format which
2778 * is indicated by @info. See gtk_selection_data_set() and
2779 * gtk_selection_data_set_text().
2781 widget_signals[DRAG_DATA_GET] =
2782 g_signal_new (I_("drag-data-get"),
2783 G_TYPE_FROM_CLASS (klass),
2785 G_STRUCT_OFFSET (GtkWidgetClass, drag_data_get),
2787 _gtk_marshal_VOID__OBJECT_BOXED_UINT_UINT,
2789 GDK_TYPE_DRAG_CONTEXT,
2790 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
2795 * GtkWidget::drag-data-received:
2796 * @widget: the object which received the signal
2797 * @context: the drag context
2798 * @x: where the drop happened
2799 * @y: where the drop happened
2800 * @data: the received data
2801 * @info: the info that has been registered with the target in the
2803 * @time: the timestamp at which the data was received
2805 * The ::drag-data-received signal is emitted on the drop site when the
2806 * dragged data has been received. If the data was received in order to
2807 * determine whether the drop will be accepted, the handler is expected
2808 * to call gdk_drag_status() and <emphasis>not</emphasis> finish the drag.
2809 * If the data was received in response to a #GtkWidget::drag-drop signal
2810 * (and this is the last target to be received), the handler for this
2811 * signal is expected to process the received data and then call
2812 * gtk_drag_finish(), setting the @success parameter depending on
2813 * whether the data was processed successfully.
2815 * The handler may inspect the selected action with
2816 * gdk_drag_context_get_selected_action() before calling
2817 * gtk_drag_finish(), e.g. to implement %GDK_ACTION_ASK as
2818 * shown in the following example:
2821 * drag_data_received (GtkWidget *widget,
2822 * GdkDragContext *context,
2825 * GtkSelectionData *data,
2829 * if ((data->length >= 0) && (data->format == 8))
2831 * GdkDragAction action;
2833 * /* handle data here */
2835 * action = gdk_drag_context_get_selected_action (context);
2836 * if (action == GDK_ACTION_ASK)
2838 * GtkWidget *dialog;
2841 * dialog = gtk_message_dialog_new (NULL,
2842 * GTK_DIALOG_MODAL |
2843 * GTK_DIALOG_DESTROY_WITH_PARENT,
2845 * GTK_BUTTONS_YES_NO,
2846 * "Move the data ?\n");
2847 * response = gtk_dialog_run (GTK_DIALOG (dialog));
2848 * gtk_widget_destroy (dialog);
2850 * if (response == GTK_RESPONSE_YES)
2851 * action = GDK_ACTION_MOVE;
2853 * action = GDK_ACTION_COPY;
2856 * gtk_drag_finish (context, TRUE, action == GDK_ACTION_MOVE, time);
2859 * gtk_drag_finish (context, FALSE, FALSE, time);
2863 widget_signals[DRAG_DATA_RECEIVED] =
2864 g_signal_new (I_("drag-data-received"),
2865 G_TYPE_FROM_CLASS (klass),
2867 G_STRUCT_OFFSET (GtkWidgetClass, drag_data_received),
2869 _gtk_marshal_VOID__OBJECT_INT_INT_BOXED_UINT_UINT,
2871 GDK_TYPE_DRAG_CONTEXT,
2874 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
2879 * GtkWidget::visibility-notify-event:
2880 * @widget: the object which received the signal
2881 * @event: (type Gdk.EventVisibility): the #GdkEventVisibility which
2882 * triggered this signal.
2884 * The ::visibility-notify-event will be emitted when the @widget's window
2885 * is obscured or unobscured.
2887 * To receive this signal the #GdkWindow associated to the widget needs
2888 * to enable the #GDK_VISIBILITY_NOTIFY_MASK mask.
2890 * Returns: %TRUE to stop other handlers from being invoked for the event.
2891 * %FALSE to propagate the event further.
2893 widget_signals[VISIBILITY_NOTIFY_EVENT] =
2894 g_signal_new (I_("visibility-notify-event"),
2895 G_TYPE_FROM_CLASS (klass),
2897 G_STRUCT_OFFSET (GtkWidgetClass, visibility_notify_event),
2898 _gtk_boolean_handled_accumulator, NULL,
2899 _gtk_marshal_BOOLEAN__BOXED,
2901 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2904 * GtkWidget::window-state-event:
2905 * @widget: the object which received the signal
2906 * @event: (type Gdk.EventWindowState): the #GdkEventWindowState which
2907 * triggered this signal.
2909 * The ::window-state-event will be emitted when the state of the
2910 * toplevel window associated to the @widget changes.
2912 * To receive this signal the #GdkWindow associated to the widget
2913 * needs to enable the #GDK_STRUCTURE_MASK mask. GDK will enable
2914 * this mask automatically for all new windows.
2916 * Returns: %TRUE to stop other handlers from being invoked for the
2917 * event. %FALSE to propagate the event further.
2919 widget_signals[WINDOW_STATE_EVENT] =
2920 g_signal_new (I_("window-state-event"),
2921 G_TYPE_FROM_CLASS (klass),
2923 G_STRUCT_OFFSET (GtkWidgetClass, window_state_event),
2924 _gtk_boolean_handled_accumulator, NULL,
2925 _gtk_marshal_BOOLEAN__BOXED,
2927 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2928 g_signal_set_va_marshaller (widget_signals[WINDOW_STATE_EVENT], G_TYPE_FROM_CLASS (klass),
2929 _gtk_marshal_BOOLEAN__BOXEDv);
2932 * GtkWidget::damage-event:
2933 * @widget: the object which received the signal
2934 * @event: (type Gdk.EventExpose): the #GdkEventExpose event
2936 * Emitted when a redirected window belonging to @widget gets drawn into.
2937 * The region/area members of the event shows what area of the redirected
2938 * drawable was drawn into.
2940 * Returns: %TRUE to stop other handlers from being invoked for the event.
2941 * %FALSE to propagate the event further.
2945 widget_signals[DAMAGE_EVENT] =
2946 g_signal_new (I_("damage-event"),
2947 G_TYPE_FROM_CLASS (klass),
2949 G_STRUCT_OFFSET (GtkWidgetClass, damage_event),
2950 _gtk_boolean_handled_accumulator, NULL,
2951 _gtk_marshal_BOOLEAN__BOXED,
2953 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2954 g_signal_set_va_marshaller (widget_signals[DAMAGE_EVENT], G_TYPE_FROM_CLASS (klass),
2955 _gtk_marshal_BOOLEAN__BOXEDv);
2958 * GtkWidget::grab-broken-event:
2959 * @widget: the object which received the signal
2960 * @event: (type Gdk.EventGrabBroken): the #GdkEventGrabBroken event
2962 * Emitted when a pointer or keyboard grab on a window belonging
2963 * to @widget gets broken.
2965 * On X11, this happens when the grab window becomes unviewable
2966 * (i.e. it or one of its ancestors is unmapped), or if the same
2967 * application grabs the pointer or keyboard again.
2969 * Returns: %TRUE to stop other handlers from being invoked for
2970 * the event. %FALSE to propagate the event further.
2974 widget_signals[GRAB_BROKEN_EVENT] =
2975 g_signal_new (I_("grab-broken-event"),
2976 G_TYPE_FROM_CLASS (klass),
2978 G_STRUCT_OFFSET (GtkWidgetClass, grab_broken_event),
2979 _gtk_boolean_handled_accumulator, NULL,
2980 _gtk_marshal_BOOLEAN__BOXED,
2982 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2983 g_signal_set_va_marshaller (widget_signals[GRAB_BROKEN_EVENT], G_TYPE_FROM_CLASS (klass),
2984 _gtk_marshal_BOOLEAN__BOXEDv);
2987 * GtkWidget::query-tooltip:
2988 * @widget: the object which received the signal
2989 * @x: the x coordinate of the cursor position where the request has
2990 * been emitted, relative to @widget's left side
2991 * @y: the y coordinate of the cursor position where the request has
2992 * been emitted, relative to @widget's top
2993 * @keyboard_mode: %TRUE if the tooltip was trigged using the keyboard
2994 * @tooltip: a #GtkTooltip
2996 * Emitted when #GtkWidget:has-tooltip is %TRUE and the #GtkSettings:gtk-tooltip-timeout
2997 * has expired with the cursor hovering "above" @widget; or emitted when @widget got
2998 * focus in keyboard mode.
3000 * Using the given coordinates, the signal handler should determine
3001 * whether a tooltip should be shown for @widget. If this is the case
3002 * %TRUE should be returned, %FALSE otherwise. Note that if
3003 * @keyboard_mode is %TRUE, the values of @x and @y are undefined and
3004 * should not be used.
3006 * The signal handler is free to manipulate @tooltip with the therefore
3007 * destined function calls.
3009 * Returns: %TRUE if @tooltip should be shown right now, %FALSE otherwise.
3013 widget_signals[QUERY_TOOLTIP] =
3014 g_signal_new (I_("query-tooltip"),
3015 G_TYPE_FROM_CLASS (klass),
3017 G_STRUCT_OFFSET (GtkWidgetClass, query_tooltip),
3018 _gtk_boolean_handled_accumulator, NULL,
3019 _gtk_marshal_BOOLEAN__INT_INT_BOOLEAN_OBJECT,
3027 * GtkWidget::popup-menu:
3028 * @widget: the object which received the signal
3030 * This signal gets emitted whenever a widget should pop up a context
3031 * menu. This usually happens through the standard key binding mechanism;
3032 * by pressing a certain key while a widget is focused, the user can cause
3033 * the widget to pop up a menu. For example, the #GtkEntry widget creates
3034 * a menu with clipboard commands. See <xref linkend="checklist-popup-menu"/>
3035 * for an example of how to use this signal.
3037 * Returns: %TRUE if a menu was activated
3039 widget_signals[POPUP_MENU] =
3040 g_signal_new (I_("popup-menu"),
3041 G_TYPE_FROM_CLASS (klass),
3042 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
3043 G_STRUCT_OFFSET (GtkWidgetClass, popup_menu),
3044 _gtk_boolean_handled_accumulator, NULL,
3045 _gtk_marshal_BOOLEAN__VOID,
3049 * GtkWidget::show-help:
3050 * @widget: the object which received the signal.
3053 * Returns: %TRUE to stop other handlers from being invoked for the event.
3054 * %FALSE to propagate the event further.
3056 widget_signals[SHOW_HELP] =
3057 g_signal_new (I_("show-help"),
3058 G_TYPE_FROM_CLASS (klass),
3059 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
3060 G_STRUCT_OFFSET (GtkWidgetClass, show_help),
3061 _gtk_boolean_handled_accumulator, NULL,
3062 _gtk_marshal_BOOLEAN__ENUM,
3064 GTK_TYPE_WIDGET_HELP_TYPE);
3067 * GtkWidget::accel-closures-changed:
3068 * @widget: the object which received the signal.
3070 widget_signals[ACCEL_CLOSURES_CHANGED] =
3071 g_signal_new (I_("accel-closures-changed"),
3072 G_TYPE_FROM_CLASS (klass),
3076 _gtk_marshal_VOID__VOID,
3080 * GtkWidget::screen-changed:
3081 * @widget: the object on which the signal is emitted
3082 * @previous_screen: (allow-none): the previous screen, or %NULL if the
3083 * widget was not associated with a screen before
3085 * The ::screen-changed signal gets emitted when the
3086 * screen of a widget has changed.
3088 widget_signals[SCREEN_CHANGED] =
3089 g_signal_new (I_("screen-changed"),
3090 G_TYPE_FROM_CLASS (klass),
3092 G_STRUCT_OFFSET (GtkWidgetClass, screen_changed),
3094 _gtk_marshal_VOID__OBJECT,
3099 * GtkWidget::can-activate-accel:
3100 * @widget: the object which received the signal
3101 * @signal_id: the ID of a signal installed on @widget
3103 * Determines whether an accelerator that activates the signal
3104 * identified by @signal_id can currently be activated.
3105 * This signal is present to allow applications and derived
3106 * widgets to override the default #GtkWidget handling
3107 * for determining whether an accelerator can be activated.
3109 * Returns: %TRUE if the signal can be activated.
3111 widget_signals[CAN_ACTIVATE_ACCEL] =
3112 g_signal_new (I_("can-activate-accel"),
3113 G_TYPE_FROM_CLASS (klass),
3115 G_STRUCT_OFFSET (GtkWidgetClass, can_activate_accel),
3116 _gtk_boolean_handled_accumulator, NULL,
3117 _gtk_marshal_BOOLEAN__UINT,
3118 G_TYPE_BOOLEAN, 1, G_TYPE_UINT);
3120 binding_set = gtk_binding_set_by_class (klass);
3121 gtk_binding_entry_add_signal (binding_set, GDK_KEY_F10, GDK_SHIFT_MASK,
3123 gtk_binding_entry_add_signal (binding_set, GDK_KEY_Menu, 0,
3126 gtk_binding_entry_add_signal (binding_set, GDK_KEY_F1, GDK_CONTROL_MASK,
3128 GTK_TYPE_WIDGET_HELP_TYPE,
3129 GTK_WIDGET_HELP_TOOLTIP);
3130 gtk_binding_entry_add_signal (binding_set, GDK_KEY_KP_F1, GDK_CONTROL_MASK,
3132 GTK_TYPE_WIDGET_HELP_TYPE,
3133 GTK_WIDGET_HELP_TOOLTIP);
3134 gtk_binding_entry_add_signal (binding_set, GDK_KEY_F1, GDK_SHIFT_MASK,
3136 GTK_TYPE_WIDGET_HELP_TYPE,
3137 GTK_WIDGET_HELP_WHATS_THIS);
3138 gtk_binding_entry_add_signal (binding_set, GDK_KEY_KP_F1, GDK_SHIFT_MASK,
3140 GTK_TYPE_WIDGET_HELP_TYPE,
3141 GTK_WIDGET_HELP_WHATS_THIS);
3143 gtk_widget_class_install_style_property (klass,
3144 g_param_spec_boolean ("interior-focus",
3145 P_("Interior Focus"),
3146 P_("Whether to draw the focus indicator inside widgets"),
3148 GTK_PARAM_READABLE));
3150 gtk_widget_class_install_style_property (klass,
3151 g_param_spec_int ("focus-line-width",
3152 P_("Focus linewidth"),
3153 P_("Width, in pixels, of the focus indicator line"),
3155 GTK_PARAM_READABLE));
3157 gtk_widget_class_install_style_property (klass,
3158 g_param_spec_string ("focus-line-pattern",
3159 P_("Focus line dash pattern"),
3160 P_("Dash pattern used to draw the focus indicator"),
3162 GTK_PARAM_READABLE));
3163 gtk_widget_class_install_style_property (klass,
3164 g_param_spec_int ("focus-padding",
3165 P_("Focus padding"),
3166 P_("Width, in pixels, between focus indicator and the widget 'box'"),
3168 GTK_PARAM_READABLE));
3169 gtk_widget_class_install_style_property (klass,
3170 g_param_spec_boxed ("cursor-color",
3172 P_("Color with which to draw insertion cursor"),
3174 GTK_PARAM_READABLE));
3175 gtk_widget_class_install_style_property (klass,
3176 g_param_spec_boxed ("secondary-cursor-color",
3177 P_("Secondary cursor color"),
3178 P_("Color with which to draw the secondary insertion cursor when editing mixed right-to-left and left-to-right text"),
3180 GTK_PARAM_READABLE));
3181 gtk_widget_class_install_style_property (klass,
3182 g_param_spec_float ("cursor-aspect-ratio",
3183 P_("Cursor line aspect ratio"),
3184 P_("Aspect ratio with which to draw insertion cursor"),
3186 GTK_PARAM_READABLE));
3188 gtk_widget_class_install_style_property (klass,
3189 g_param_spec_boolean ("window-dragging",
3190 P_("Window dragging"),
3191 P_("Whether windows can be dragged by clicking on empty areas"),
3193 GTK_PARAM_READABLE));
3196 * GtkWidget:link-color:
3198 * The "link-color" style property defines the color of unvisited links.
3202 gtk_widget_class_install_style_property (klass,
3203 g_param_spec_boxed ("link-color",
3204 P_("Unvisited Link Color"),
3205 P_("Color of unvisited links"),
3207 GTK_PARAM_READABLE));
3210 * GtkWidget:visited-link-color:
3212 * The "visited-link-color" style property defines the color of visited links.
3216 gtk_widget_class_install_style_property (klass,
3217 g_param_spec_boxed ("visited-link-color",
3218 P_("Visited Link Color"),
3219 P_("Color of visited links"),
3221 GTK_PARAM_READABLE));
3224 * GtkWidget:wide-separators:
3226 * The "wide-separators" style property defines whether separators have
3227 * configurable width and should be drawn using a box instead of a line.
3231 gtk_widget_class_install_style_property (klass,
3232 g_param_spec_boolean ("wide-separators",
3233 P_("Wide Separators"),
3234 P_("Whether separators have configurable width and should be drawn using a box instead of a line"),
3236 GTK_PARAM_READABLE));
3239 * GtkWidget:separator-width:
3241 * The "separator-width" style property defines the width of separators.
3242 * This property only takes effect if #GtkWidget:wide-separators is %TRUE.
3246 gtk_widget_class_install_style_property (klass,
3247 g_param_spec_int ("separator-width",
3248 P_("Separator Width"),
3249 P_("The width of separators if wide-separators is TRUE"),
3251 GTK_PARAM_READABLE));
3254 * GtkWidget:separator-height:
3256 * The "separator-height" style property defines the height of separators.
3257 * This property only takes effect if #GtkWidget:wide-separators is %TRUE.
3261 gtk_widget_class_install_style_property (klass,
3262 g_param_spec_int ("separator-height",
3263 P_("Separator Height"),
3264 P_("The height of separators if \"wide-separators\" is TRUE"),
3266 GTK_PARAM_READABLE));
3269 * GtkWidget:scroll-arrow-hlength:
3271 * The "scroll-arrow-hlength" style property defines the length of
3272 * horizontal scroll arrows.
3276 gtk_widget_class_install_style_property (klass,
3277 g_param_spec_int ("scroll-arrow-hlength",
3278 P_("Horizontal Scroll Arrow Length"),
3279 P_("The length of horizontal scroll arrows"),
3281 GTK_PARAM_READABLE));
3284 * GtkWidget:scroll-arrow-vlength:
3286 * The "scroll-arrow-vlength" style property defines the length of
3287 * vertical scroll arrows.
3291 gtk_widget_class_install_style_property (klass,
3292 g_param_spec_int ("scroll-arrow-vlength",
3293 P_("Vertical Scroll Arrow Length"),
3294 P_("The length of vertical scroll arrows"),
3296 GTK_PARAM_READABLE));
3298 gtk_widget_class_install_style_property (klass,
3299 g_param_spec_int ("text-handle-width",
3300 P_("Width of text selection handles"),
3301 P_("Width of text selection handles"),
3303 GTK_PARAM_READABLE));
3304 gtk_widget_class_install_style_property (klass,
3305 g_param_spec_int ("text-handle-height",
3306 P_("Height of text selection handles"),
3307 P_("Height of text selection handles"),
3309 GTK_PARAM_READABLE));
3311 g_type_class_add_private (klass, sizeof (GtkWidgetPrivate));
3313 gtk_widget_class_set_accessible_type (klass, GTK_TYPE_WIDGET_ACCESSIBLE);
3317 gtk_widget_base_class_finalize (GtkWidgetClass *klass)
3321 list = g_param_spec_pool_list_owned (style_property_spec_pool, G_OBJECT_CLASS_TYPE (klass));
3322 for (node = list; node; node = node->next)
3324 GParamSpec *pspec = node->data;
3326 g_param_spec_pool_remove (style_property_spec_pool, pspec);
3327 g_param_spec_unref (pspec);
3333 gtk_widget_set_property (GObject *object,
3335 const GValue *value,
3338 GtkWidget *widget = GTK_WIDGET (object);
3343 gchar *tooltip_markup;
3344 const gchar *tooltip_text;
3345 GtkWindow *tooltip_window;
3348 gtk_widget_set_name (widget, g_value_get_string (value));
3351 gtk_container_add (GTK_CONTAINER (g_value_get_object (value)), widget);
3353 case PROP_WIDTH_REQUEST:
3354 gtk_widget_set_usize_internal (widget, g_value_get_int (value), -2, 0);
3356 case PROP_HEIGHT_REQUEST:
3357 gtk_widget_set_usize_internal (widget, -2, g_value_get_int (value), 0);
3360 gtk_widget_set_visible (widget, g_value_get_boolean (value));
3362 case PROP_SENSITIVE:
3363 gtk_widget_set_sensitive (widget, g_value_get_boolean (value));
3365 case PROP_APP_PAINTABLE:
3366 gtk_widget_set_app_paintable (widget, g_value_get_boolean (value));
3368 case PROP_CAN_FOCUS:
3369 gtk_widget_set_can_focus (widget, g_value_get_boolean (value));
3371 case PROP_HAS_FOCUS:
3372 if (g_value_get_boolean (value))
3373 gtk_widget_grab_focus (widget);
3376 if (g_value_get_boolean (value))
3377 gtk_widget_grab_focus (widget);
3379 case PROP_CAN_DEFAULT:
3380 gtk_widget_set_can_default (widget, g_value_get_boolean (value));
3382 case PROP_HAS_DEFAULT:
3383 if (g_value_get_boolean (value))
3384 gtk_widget_grab_default (widget);
3386 case PROP_RECEIVES_DEFAULT:
3387 gtk_widget_set_receives_default (widget, g_value_get_boolean (value));
3390 gtk_widget_set_style (widget, g_value_get_object (value));
3393 if (!gtk_widget_get_realized (widget) && gtk_widget_get_has_window (widget))
3394 gtk_widget_set_events (widget, g_value_get_flags (value));
3396 case PROP_NO_SHOW_ALL:
3397 gtk_widget_set_no_show_all (widget, g_value_get_boolean (value));
3399 case PROP_HAS_TOOLTIP:
3400 gtk_widget_real_set_has_tooltip (widget,
3401 g_value_get_boolean (value), FALSE);
3403 case PROP_TOOLTIP_MARKUP:
3404 tooltip_window = g_object_get_qdata (object, quark_tooltip_window);
3405 tooltip_markup = g_value_dup_string (value);
3407 /* Treat an empty string as a NULL string,
3408 * because an empty string would be useless for a tooltip:
3410 if (tooltip_markup && (strlen (tooltip_markup) == 0))
3412 g_free (tooltip_markup);
3413 tooltip_markup = NULL;
3416 g_object_set_qdata_full (object, quark_tooltip_markup,
3417 tooltip_markup, g_free);
3419 tmp = (tooltip_window != NULL || tooltip_markup != NULL);
3420 gtk_widget_real_set_has_tooltip (widget, tmp, FALSE);
3421 if (gtk_widget_get_visible (widget))
3422 gtk_widget_queue_tooltip_query (widget);
3424 case PROP_TOOLTIP_TEXT:
3425 tooltip_window = g_object_get_qdata (object, quark_tooltip_window);
3427 tooltip_text = g_value_get_string (value);
3429 /* Treat an empty string as a NULL string,
3430 * because an empty string would be useless for a tooltip:
3432 if (tooltip_text && (strlen (tooltip_text) == 0))
3433 tooltip_text = NULL;
3435 tooltip_markup = tooltip_text ? g_markup_escape_text (tooltip_text, -1) : NULL;
3437 g_object_set_qdata_full (object, quark_tooltip_markup,
3438 tooltip_markup, g_free);
3440 tmp = (tooltip_window != NULL || tooltip_markup != NULL);
3441 gtk_widget_real_set_has_tooltip (widget, tmp, FALSE);
3442 if (gtk_widget_get_visible (widget))
3443 gtk_widget_queue_tooltip_query (widget);
3445 case PROP_DOUBLE_BUFFERED:
3446 gtk_widget_set_double_buffered (widget, g_value_get_boolean (value));
3449 gtk_widget_set_halign (widget, g_value_get_enum (value));
3452 gtk_widget_set_valign (widget, g_value_get_enum (value));
3454 case PROP_MARGIN_LEFT:
3455 gtk_widget_set_margin_left (widget, g_value_get_int (value));
3457 case PROP_MARGIN_RIGHT:
3458 gtk_widget_set_margin_right (widget, g_value_get_int (value));
3460 case PROP_MARGIN_TOP:
3461 gtk_widget_set_margin_top (widget, g_value_get_int (value));
3463 case PROP_MARGIN_BOTTOM:
3464 gtk_widget_set_margin_bottom (widget, g_value_get_int (value));
3467 g_object_freeze_notify (G_OBJECT (widget));
3468 gtk_widget_set_margin_left (widget, g_value_get_int (value));
3469 gtk_widget_set_margin_right (widget, g_value_get_int (value));
3470 gtk_widget_set_margin_top (widget, g_value_get_int (value));
3471 gtk_widget_set_margin_bottom (widget, g_value_get_int (value));
3472 g_object_thaw_notify (G_OBJECT (widget));
3475 gtk_widget_set_hexpand (widget, g_value_get_boolean (value));
3477 case PROP_HEXPAND_SET:
3478 gtk_widget_set_hexpand_set (widget, g_value_get_boolean (value));
3481 gtk_widget_set_vexpand (widget, g_value_get_boolean (value));
3483 case PROP_VEXPAND_SET:
3484 gtk_widget_set_vexpand_set (widget, g_value_get_boolean (value));
3487 g_object_freeze_notify (G_OBJECT (widget));
3488 gtk_widget_set_hexpand (widget, g_value_get_boolean (value));
3489 gtk_widget_set_vexpand (widget, g_value_get_boolean (value));
3490 g_object_thaw_notify (G_OBJECT (widget));
3493 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
3499 gtk_widget_get_property (GObject *object,
3504 GtkWidget *widget = GTK_WIDGET (object);
3505 GtkWidgetPrivate *priv = widget->priv;
3513 g_value_set_string (value, priv->name);
3515 g_value_set_static_string (value, "");
3518 g_value_set_object (value, priv->parent);
3520 case PROP_WIDTH_REQUEST:
3523 gtk_widget_get_size_request (widget, &w, NULL);
3524 g_value_set_int (value, w);
3527 case PROP_HEIGHT_REQUEST:
3530 gtk_widget_get_size_request (widget, NULL, &h);
3531 g_value_set_int (value, h);
3535 g_value_set_boolean (value, (gtk_widget_get_visible (widget) != FALSE));
3537 case PROP_SENSITIVE:
3538 g_value_set_boolean (value, (gtk_widget_get_sensitive (widget) != FALSE));
3540 case PROP_APP_PAINTABLE:
3541 g_value_set_boolean (value, (gtk_widget_get_app_paintable (widget) != FALSE));
3543 case PROP_CAN_FOCUS:
3544 g_value_set_boolean (value, (gtk_widget_get_can_focus (widget) != FALSE));
3546 case PROP_HAS_FOCUS:
3547 g_value_set_boolean (value, (gtk_widget_has_focus (widget) != FALSE));
3550 g_value_set_boolean (value, (gtk_widget_is_focus (widget)));
3552 case PROP_CAN_DEFAULT:
3553 g_value_set_boolean (value, (gtk_widget_get_can_default (widget) != FALSE));
3555 case PROP_HAS_DEFAULT:
3556 g_value_set_boolean (value, (gtk_widget_has_default (widget) != FALSE));
3558 case PROP_RECEIVES_DEFAULT:
3559 g_value_set_boolean (value, (gtk_widget_get_receives_default (widget) != FALSE));
3561 case PROP_COMPOSITE_CHILD:
3562 g_value_set_boolean (value, widget->priv->composite_child);
3565 g_value_set_object (value, gtk_widget_get_style (widget));
3568 eventp = g_object_get_qdata (G_OBJECT (widget), quark_event_mask);
3569 g_value_set_flags (value, GPOINTER_TO_INT (eventp));
3571 case PROP_NO_SHOW_ALL:
3572 g_value_set_boolean (value, gtk_widget_get_no_show_all (widget));
3574 case PROP_HAS_TOOLTIP:
3575 g_value_set_boolean (value, GPOINTER_TO_UINT (g_object_get_qdata (object, quark_has_tooltip)));
3577 case PROP_TOOLTIP_TEXT:
3579 gchar *escaped = g_object_get_qdata (object, quark_tooltip_markup);
3582 if (escaped && !pango_parse_markup (escaped, -1, 0, NULL, &text, NULL, NULL))
3583 g_assert (NULL == text); /* text should still be NULL in case of markup errors */
3585 g_value_take_string (value, text);
3588 case PROP_TOOLTIP_MARKUP:
3589 g_value_set_string (value, g_object_get_qdata (object, quark_tooltip_markup));
3592 g_value_set_object (value, gtk_widget_get_window (widget));
3594 case PROP_DOUBLE_BUFFERED:
3595 g_value_set_boolean (value, gtk_widget_get_double_buffered (widget));
3598 g_value_set_enum (value, gtk_widget_get_halign (widget));
3601 g_value_set_enum (value, gtk_widget_get_valign (widget));
3603 case PROP_MARGIN_LEFT:
3604 g_value_set_int (value, gtk_widget_get_margin_left (widget));
3606 case PROP_MARGIN_RIGHT:
3607 g_value_set_int (value, gtk_widget_get_margin_right (widget));
3609 case PROP_MARGIN_TOP:
3610 g_value_set_int (value, gtk_widget_get_margin_top (widget));
3612 case PROP_MARGIN_BOTTOM:
3613 g_value_set_int (value, gtk_widget_get_margin_bottom (widget));
3617 GtkWidgetAuxInfo *aux_info = gtk_widget_get_aux_info (widget, FALSE);
3618 if (aux_info == NULL)
3620 g_value_set_int (value, 0);
3624 g_value_set_int (value, MAX (MAX (aux_info->margin.left,
3625 aux_info->margin.right),
3626 MAX (aux_info->margin.top,
3627 aux_info->margin.bottom)));
3632 g_value_set_boolean (value, gtk_widget_get_hexpand (widget));
3634 case PROP_HEXPAND_SET:
3635 g_value_set_boolean (value, gtk_widget_get_hexpand_set (widget));
3638 g_value_set_boolean (value, gtk_widget_get_vexpand (widget));
3640 case PROP_VEXPAND_SET:
3641 g_value_set_boolean (value, gtk_widget_get_vexpand_set (widget));
3644 g_value_set_boolean (value,
3645 gtk_widget_get_hexpand (widget) &&
3646 gtk_widget_get_vexpand (widget));
3649 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
3655 gtk_widget_init (GtkWidget *widget)
3657 GtkWidgetPrivate *priv;
3659 widget->priv = G_TYPE_INSTANCE_GET_PRIVATE (widget,
3662 priv = widget->priv;
3664 priv->child_visible = TRUE;
3666 priv->allocation.x = -1;
3667 priv->allocation.y = -1;
3668 priv->allocation.width = 1;
3669 priv->allocation.height = 1;
3670 priv->window = NULL;
3671 priv->parent = NULL;
3673 priv->sensitive = TRUE;
3674 priv->composite_child = composite_child_stack != 0;
3675 priv->double_buffered = TRUE;
3676 priv->redraw_on_alloc = TRUE;
3677 priv->alloc_needed = TRUE;
3679 /* this will be set to TRUE if the widget gets a child or if the
3680 * expand flag is set on the widget, but until one of those happen
3681 * we know the expand is already properly FALSE.
3683 * We really want to default FALSE here to avoid computing expand
3684 * all over the place while initially building a widget tree.
3686 priv->need_compute_expand = FALSE;
3688 _gtk_size_request_cache_init (&priv->requests);
3690 priv->style = gtk_widget_get_default_style ();
3691 g_object_ref (priv->style);
3696 gtk_widget_dispatch_child_properties_changed (GtkWidget *widget,
3698 GParamSpec **pspecs)
3700 GtkWidgetPrivate *priv = widget->priv;
3701 GtkWidget *container = priv->parent;
3704 for (i = 0; widget->priv->parent == container && i < n_pspecs; i++)
3705 g_signal_emit (widget, widget_signals[CHILD_NOTIFY], g_quark_from_string (pspecs[i]->name), pspecs[i]);
3709 * gtk_widget_freeze_child_notify:
3710 * @widget: a #GtkWidget
3712 * Stops emission of #GtkWidget::child-notify signals on @widget. The
3713 * signals are queued until gtk_widget_thaw_child_notify() is called
3716 * This is the analogue of g_object_freeze_notify() for child properties.
3719 gtk_widget_freeze_child_notify (GtkWidget *widget)
3721 g_return_if_fail (GTK_IS_WIDGET (widget));
3723 if (!G_OBJECT (widget)->ref_count)
3726 g_object_ref (widget);
3727 g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
3728 g_object_unref (widget);
3732 * gtk_widget_child_notify:
3733 * @widget: a #GtkWidget
3734 * @child_property: the name of a child property installed on the
3735 * class of @widget<!-- -->'s parent
3737 * Emits a #GtkWidget::child-notify signal for the
3738 * <link linkend="child-properties">child property</link> @child_property
3741 * This is the analogue of g_object_notify() for child properties.
3743 * Also see gtk_container_child_notify().
3746 gtk_widget_child_notify (GtkWidget *widget,
3747 const gchar *child_property)
3749 if (widget->priv->parent == NULL)
3752 gtk_container_child_notify (GTK_CONTAINER (widget->priv->parent), widget, child_property);
3756 * gtk_widget_thaw_child_notify:
3757 * @widget: a #GtkWidget
3759 * Reverts the effect of a previous call to gtk_widget_freeze_child_notify().
3760 * This causes all queued #GtkWidget::child-notify signals on @widget to be
3764 gtk_widget_thaw_child_notify (GtkWidget *widget)
3766 GObjectNotifyQueue *nqueue;
3768 g_return_if_fail (GTK_IS_WIDGET (widget));
3770 if (!G_OBJECT (widget)->ref_count)
3773 g_object_ref (widget);
3774 nqueue = g_object_notify_queue_from_object (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
3775 if (!nqueue || !nqueue->freeze_count)
3776 g_warning (G_STRLOC ": child-property-changed notification for %s(%p) is not frozen",
3777 G_OBJECT_TYPE_NAME (widget), widget);
3779 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
3780 g_object_unref (widget);
3786 * @type: type ID of the widget to create
3787 * @first_property_name: name of first property to set
3788 * @...: value of first property, followed by more properties,
3791 * This is a convenience function for creating a widget and setting
3792 * its properties in one go. For example you might write:
3793 * <literal>gtk_widget_new (GTK_TYPE_LABEL, "label", "Hello World", "xalign",
3794 * 0.0, NULL)</literal> to create a left-aligned label. Equivalent to
3795 * g_object_new(), but returns a widget so you don't have to
3796 * cast the object yourself.
3798 * Return value: a new #GtkWidget of type @widget_type
3801 gtk_widget_new (GType type,
3802 const gchar *first_property_name,
3808 g_return_val_if_fail (g_type_is_a (type, GTK_TYPE_WIDGET), NULL);
3810 va_start (var_args, first_property_name);
3811 widget = (GtkWidget *)g_object_new_valist (type, first_property_name, var_args);
3818 gtk_widget_queue_draw_child (GtkWidget *widget)
3820 GtkWidgetPrivate *priv = widget->priv;
3823 parent = priv->parent;
3824 if (parent && gtk_widget_is_drawable (parent))
3825 gtk_widget_queue_draw_area (parent,
3828 priv->allocation.width,
3829 priv->allocation.height);
3833 * gtk_widget_unparent:
3834 * @widget: a #GtkWidget
3836 * This function is only for use in widget implementations.
3837 * Should be called by implementations of the remove method
3838 * on #GtkContainer, to dissociate a child from the container.
3841 gtk_widget_unparent (GtkWidget *widget)
3843 GtkWidgetPrivate *priv;
3844 GObjectNotifyQueue *nqueue;
3845 GtkWidget *toplevel;
3846 GtkWidget *old_parent;
3848 g_return_if_fail (GTK_IS_WIDGET (widget));
3850 priv = widget->priv;
3852 if (priv->parent == NULL)
3855 /* keep this function in sync with gtk_menu_detach() */
3857 gtk_widget_push_verify_invariants (widget);
3859 g_object_freeze_notify (G_OBJECT (widget));
3860 nqueue = g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
3862 toplevel = gtk_widget_get_toplevel (widget);
3863 if (gtk_widget_is_toplevel (toplevel))
3864 _gtk_window_unset_focus_and_default (GTK_WINDOW (toplevel), widget);
3866 if (gtk_container_get_focus_child (GTK_CONTAINER (priv->parent)) == widget)
3867 gtk_container_set_focus_child (GTK_CONTAINER (priv->parent), NULL);
3869 gtk_widget_queue_draw_child (widget);
3871 /* Reset the width and height here, to force reallocation if we
3872 * get added back to a new parent. This won't work if our new
3873 * allocation is smaller than 1x1 and we actually want a size of 1x1...
3874 * (would 0x0 be OK here?)
3876 priv->allocation.width = 1;
3877 priv->allocation.height = 1;
3879 if (gtk_widget_get_realized (widget))
3881 if (priv->in_reparent)
3882 gtk_widget_unmap (widget);
3884 gtk_widget_unrealize (widget);
3887 /* If we are unanchoring the child, we save around the toplevel
3888 * to emit hierarchy changed
3890 if (priv->parent->priv->anchored)
3891 g_object_ref (toplevel);
3895 /* Removing a widget from a container restores the child visible
3896 * flag to the default state, so it doesn't affect the child
3897 * in the next parent.
3899 priv->child_visible = TRUE;
3901 old_parent = priv->parent;
3902 priv->parent = NULL;
3904 /* parent may no longer expand if the removed
3905 * child was expand=TRUE and could therefore
3908 if (gtk_widget_get_visible (widget) &&
3909 (priv->need_compute_expand ||
3910 priv->computed_hexpand ||
3911 priv->computed_vexpand))
3913 gtk_widget_queue_compute_expand (old_parent);
3916 /* Unset BACKDROP since we are no longer inside a toplevel window */
3917 gtk_widget_unset_state_flags (widget, GTK_STATE_FLAG_BACKDROP);
3919 gtk_style_context_set_parent (priv->context, NULL);
3921 _gtk_widget_update_parent_muxer (widget);
3923 g_signal_emit (widget, widget_signals[PARENT_SET], 0, old_parent);
3926 _gtk_widget_propagate_hierarchy_changed (widget, toplevel);
3927 g_object_unref (toplevel);
3930 /* Now that the parent pointer is nullified and the hierarchy-changed
3931 * already passed, go ahead and unset the parent window, if we are unparenting
3932 * an embeded GtkWindow the window will become toplevel again and hierarchy-changed
3933 * will fire again for the new subhierarchy.
3935 gtk_widget_set_parent_window (widget, NULL);
3937 g_object_notify (G_OBJECT (widget), "parent");
3938 g_object_thaw_notify (G_OBJECT (widget));
3940 g_object_notify_queue_clear (G_OBJECT (widget), nqueue);
3941 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
3943 gtk_widget_pop_verify_invariants (widget);
3944 g_object_unref (widget);
3948 * gtk_widget_destroy:
3949 * @widget: a #GtkWidget
3951 * Destroys a widget.
3954 * destroyed, it will break any references it holds to other objects.
3955 * If the widget is inside a container, the widget will be removed
3956 * from the container. If the widget is a toplevel (derived from
3957 * #GtkWindow), it will be removed from the list of toplevels, and the
3958 * reference GTK+ holds to it will be removed. Removing a
3959 * widget from its container or the list of toplevels results in the
3960 * widget being finalized, unless you've added additional references
3961 * to the widget with g_object_ref().
3963 * In most cases, only toplevel widgets (windows) require explicit
3964 * destruction, because when you destroy a toplevel its children will
3965 * be destroyed as well.
3968 gtk_widget_destroy (GtkWidget *widget)
3970 g_return_if_fail (GTK_IS_WIDGET (widget));
3972 if (!widget->priv->in_destruction)
3973 g_object_run_dispose (G_OBJECT (widget));
3977 * gtk_widget_destroyed:
3978 * @widget: a #GtkWidget
3979 * @widget_pointer: (inout) (transfer none): address of a variable that contains @widget
3981 * This function sets *@widget_pointer to %NULL if @widget_pointer !=
3982 * %NULL. It's intended to be used as a callback connected to the
3983 * "destroy" signal of a widget. You connect gtk_widget_destroyed()
3984 * as a signal handler, and pass the address of your widget variable
3985 * as user data. Then when the widget is destroyed, the variable will
3986 * be set to %NULL. Useful for example to avoid multiple copies
3987 * of the same dialog.
3990 gtk_widget_destroyed (GtkWidget *widget,
3991 GtkWidget **widget_pointer)
3993 /* Don't make any assumptions about the
3995 * Even check widget_pointer.
3998 *widget_pointer = NULL;
4003 * @widget: a #GtkWidget
4005 * Flags a widget to be displayed. Any widget that isn't shown will
4006 * not appear on the screen. If you want to show all the widgets in a
4007 * container, it's easier to call gtk_widget_show_all() on the
4008 * container, instead of individually showing the widgets.
4010 * Remember that you have to show the containers containing a widget,
4011 * in addition to the widget itself, before it will appear onscreen.
4013 * When a toplevel container is shown, it is immediately realized and
4014 * mapped; other shown widgets are realized and mapped when their
4015 * toplevel container is realized and mapped.
4018 gtk_widget_show (GtkWidget *widget)
4020 g_return_if_fail (GTK_IS_WIDGET (widget));
4022 if (!gtk_widget_get_visible (widget))
4024 g_object_ref (widget);
4025 gtk_widget_push_verify_invariants (widget);
4027 if (!gtk_widget_is_toplevel (widget))
4028 gtk_widget_queue_resize (widget);
4030 /* see comment in set_parent() for why this should and can be
4033 if (widget->priv->need_compute_expand ||
4034 widget->priv->computed_hexpand ||
4035 widget->priv->computed_vexpand)
4037 if (widget->priv->parent != NULL)
4038 gtk_widget_queue_compute_expand (widget->priv->parent);
4041 g_signal_emit (widget, widget_signals[SHOW], 0);
4042 g_object_notify (G_OBJECT (widget), "visible");
4044 gtk_widget_pop_verify_invariants (widget);
4045 g_object_unref (widget);
4050 gtk_widget_real_show (GtkWidget *widget)
4052 GtkWidgetPrivate *priv = widget->priv;
4054 if (!gtk_widget_get_visible (widget))
4056 priv->visible = TRUE;
4059 gtk_widget_get_mapped (priv->parent) &&
4060 gtk_widget_get_child_visible (widget) &&
4061 !gtk_widget_get_mapped (widget))
4062 gtk_widget_map (widget);
4067 gtk_widget_show_map_callback (GtkWidget *widget, GdkEvent *event, gint *flag)
4070 g_signal_handlers_disconnect_by_func (widget,
4071 gtk_widget_show_map_callback,
4076 * gtk_widget_show_now:
4077 * @widget: a #GtkWidget
4079 * Shows a widget. If the widget is an unmapped toplevel widget
4080 * (i.e. a #GtkWindow that has not yet been shown), enter the main
4081 * loop and wait for the window to actually be mapped. Be careful;
4082 * because the main loop is running, anything can happen during
4086 gtk_widget_show_now (GtkWidget *widget)
4090 g_return_if_fail (GTK_IS_WIDGET (widget));
4092 /* make sure we will get event */
4093 if (!gtk_widget_get_mapped (widget) &&
4094 gtk_widget_is_toplevel (widget))
4096 gtk_widget_show (widget);
4098 g_signal_connect (widget, "map-event",
4099 G_CALLBACK (gtk_widget_show_map_callback),
4103 gtk_main_iteration ();
4106 gtk_widget_show (widget);
4111 * @widget: a #GtkWidget
4113 * Reverses the effects of gtk_widget_show(), causing the widget to be
4114 * hidden (invisible to the user).
4117 gtk_widget_hide (GtkWidget *widget)
4119 g_return_if_fail (GTK_IS_WIDGET (widget));
4121 if (gtk_widget_get_visible (widget))
4123 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
4125 g_object_ref (widget);
4126 gtk_widget_push_verify_invariants (widget);
4128 if (toplevel != widget && gtk_widget_is_toplevel (toplevel))
4129 _gtk_window_unset_focus_and_default (GTK_WINDOW (toplevel), widget);
4131 /* a parent may now be expand=FALSE since we're hidden. */
4132 if (widget->priv->need_compute_expand ||
4133 widget->priv->computed_hexpand ||
4134 widget->priv->computed_vexpand)
4136 gtk_widget_queue_compute_expand (widget);
4139 g_signal_emit (widget, widget_signals[HIDE], 0);
4140 if (!gtk_widget_is_toplevel (widget))
4141 gtk_widget_queue_resize (widget);
4142 g_object_notify (G_OBJECT (widget), "visible");
4144 gtk_widget_pop_verify_invariants (widget);
4145 g_object_unref (widget);
4150 gtk_widget_real_hide (GtkWidget *widget)
4152 if (gtk_widget_get_visible (widget))
4154 widget->priv->visible = FALSE;
4156 if (gtk_widget_get_mapped (widget))
4157 gtk_widget_unmap (widget);
4162 * gtk_widget_hide_on_delete:
4163 * @widget: a #GtkWidget
4165 * Utility function; intended to be connected to the #GtkWidget::delete-event
4166 * signal on a #GtkWindow. The function calls gtk_widget_hide() on its
4167 * argument, then returns %TRUE. If connected to ::delete-event, the
4168 * result is that clicking the close button for a window (on the
4169 * window frame, top right corner usually) will hide but not destroy
4170 * the window. By default, GTK+ destroys windows when ::delete-event
4173 * Return value: %TRUE
4176 gtk_widget_hide_on_delete (GtkWidget *widget)
4178 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4180 gtk_widget_hide (widget);
4186 * gtk_widget_show_all:
4187 * @widget: a #GtkWidget
4189 * Recursively shows a widget, and any child widgets (if the widget is
4193 gtk_widget_show_all (GtkWidget *widget)
4195 GtkWidgetClass *class;
4197 g_return_if_fail (GTK_IS_WIDGET (widget));
4199 if (gtk_widget_get_no_show_all (widget))
4202 class = GTK_WIDGET_GET_CLASS (widget);
4204 if (class->show_all)
4205 class->show_all (widget);
4210 * @widget: a #GtkWidget
4212 * This function is only for use in widget implementations. Causes
4213 * a widget to be mapped if it isn't already.
4216 gtk_widget_map (GtkWidget *widget)
4218 GtkWidgetPrivate *priv;
4220 g_return_if_fail (GTK_IS_WIDGET (widget));
4221 g_return_if_fail (gtk_widget_get_visible (widget));
4222 g_return_if_fail (gtk_widget_get_child_visible (widget));
4224 priv = widget->priv;
4226 if (!gtk_widget_get_mapped (widget))
4228 gtk_widget_push_verify_invariants (widget);
4230 if (!gtk_widget_get_realized (widget))
4231 gtk_widget_realize (widget);
4233 g_signal_emit (widget, widget_signals[MAP], 0);
4235 if (!gtk_widget_get_has_window (widget))
4236 gdk_window_invalidate_rect (priv->window, &priv->allocation, FALSE);
4238 if (widget->priv->context)
4239 _gtk_style_context_update_animating (widget->priv->context);
4241 gtk_widget_pop_verify_invariants (widget);
4247 * @widget: a #GtkWidget
4249 * This function is only for use in widget implementations. Causes
4250 * a widget to be unmapped if it's currently mapped.
4253 gtk_widget_unmap (GtkWidget *widget)
4255 GtkWidgetPrivate *priv;
4257 g_return_if_fail (GTK_IS_WIDGET (widget));
4259 priv = widget->priv;
4261 if (gtk_widget_get_mapped (widget))
4263 gtk_widget_push_verify_invariants (widget);
4265 if (!gtk_widget_get_has_window (widget))
4266 gdk_window_invalidate_rect (priv->window, &priv->allocation, FALSE);
4267 _gtk_tooltip_hide (widget);
4269 if (widget->priv->context)
4270 _gtk_style_context_update_animating (widget->priv->context);
4272 g_signal_emit (widget, widget_signals[UNMAP], 0);
4274 gtk_widget_pop_verify_invariants (widget);
4276 /* Unset pointer/window info */
4277 g_object_set_qdata (G_OBJECT (widget), quark_pointer_window, NULL);
4282 _gtk_widget_enable_device_events (GtkWidget *widget)
4284 GHashTable *device_events;
4285 GHashTableIter iter;
4286 gpointer key, value;
4288 device_events = g_object_get_qdata (G_OBJECT (widget), quark_device_event_mask);
4293 g_hash_table_iter_init (&iter, device_events);
4295 while (g_hash_table_iter_next (&iter, &key, &value))
4298 GdkEventMask event_mask;
4301 event_mask = GPOINTER_TO_UINT (value);
4302 gtk_widget_add_events_internal (widget, device, event_mask);
4307 get_widget_windows (GtkWidget *widget)
4309 GList *window_list, *last, *l, *children, *ret;
4311 if (gtk_widget_get_has_window (widget))
4312 window_list = g_list_prepend (NULL, gtk_widget_get_window (widget));
4314 window_list = gdk_window_peek_children (gtk_widget_get_window (widget));
4316 last = g_list_last (window_list);
4319 for (l = window_list; l; l = l->next)
4321 GtkWidget *window_widget = NULL;
4323 gdk_window_get_user_data (l->data, (gpointer *) &window_widget);
4325 if (widget != window_widget)
4328 ret = g_list_prepend (ret, l->data);
4329 children = gdk_window_peek_children (GDK_WINDOW (l->data));
4333 last = g_list_concat (last, children);
4334 last = g_list_last (last);
4338 g_list_free (window_list);
4344 device_enable_foreach (GtkWidget *widget,
4347 GdkDevice *device = user_data;
4348 gtk_widget_set_device_enabled_internal (widget, device, TRUE, TRUE);
4352 device_disable_foreach (GtkWidget *widget,
4355 GdkDevice *device = user_data;
4356 gtk_widget_set_device_enabled_internal (widget, device, TRUE, FALSE);
4360 gtk_widget_set_device_enabled_internal (GtkWidget *widget,
4365 GList *window_list, *l;
4367 window_list = get_widget_windows (widget);
4369 for (l = window_list; l; l = l->next)
4371 GdkEventMask events = 0;
4377 events = gdk_window_get_events (window);
4379 gdk_window_set_device_events (window, device, events);
4382 if (recurse && GTK_IS_CONTAINER (widget))
4385 gtk_container_forall (GTK_CONTAINER (widget), device_enable_foreach, device);
4387 gtk_container_forall (GTK_CONTAINER (widget), device_disable_foreach, device);
4390 g_list_free (window_list);
4394 gtk_widget_update_devices_mask (GtkWidget *widget,
4397 GList *enabled_devices, *l;
4399 enabled_devices = g_object_get_qdata (G_OBJECT (widget), quark_enabled_devices);
4401 for (l = enabled_devices; l; l = l->next)
4402 gtk_widget_set_device_enabled_internal (widget, GDK_DEVICE (l->data), recurse, TRUE);
4406 * gtk_widget_realize:
4407 * @widget: a #GtkWidget
4409 * Creates the GDK (windowing system) resources associated with a
4410 * widget. For example, @widget->window will be created when a widget
4411 * is realized. Normally realization happens implicitly; if you show
4412 * a widget and all its parent containers, then the widget will be
4413 * realized and mapped automatically.
4415 * Realizing a widget requires all
4416 * the widget's parent widgets to be realized; calling
4417 * gtk_widget_realize() realizes the widget's parents in addition to
4418 * @widget itself. If a widget is not yet inside a toplevel window
4419 * when you realize it, bad things will happen.
4421 * This function is primarily used in widget implementations, and
4422 * isn't very useful otherwise. Many times when you think you might
4423 * need it, a better approach is to connect to a signal that will be
4424 * called after the widget is realized automatically, such as
4425 * #GtkWidget::draw. Or simply g_signal_connect () to the
4426 * #GtkWidget::realize signal.
4429 gtk_widget_realize (GtkWidget *widget)
4431 GtkWidgetPrivate *priv;
4432 cairo_region_t *region;
4434 g_return_if_fail (GTK_IS_WIDGET (widget));
4435 g_return_if_fail (widget->priv->anchored ||
4436 GTK_IS_INVISIBLE (widget));
4438 priv = widget->priv;
4440 if (!gtk_widget_get_realized (widget))
4442 gtk_widget_push_verify_invariants (widget);
4445 if (GTK_IS_CONTAINER (widget) && gtk_widget_get_has_window (widget))
4446 g_message ("gtk_widget_realize(%s)", G_OBJECT_TYPE_NAME (widget));
4449 if (priv->parent == NULL &&
4450 !gtk_widget_is_toplevel (widget))
4451 g_warning ("Calling gtk_widget_realize() on a widget that isn't "
4452 "inside a toplevel window is not going to work very well. "
4453 "Widgets must be inside a toplevel container before realizing them.");
4455 if (priv->parent && !gtk_widget_get_realized (priv->parent))
4456 gtk_widget_realize (priv->parent);
4458 gtk_widget_ensure_style (widget);
4460 if (priv->style_update_pending)
4461 g_signal_emit (widget, widget_signals[STYLE_UPDATED], 0);
4463 g_signal_emit (widget, widget_signals[REALIZE], 0);
4465 gtk_widget_real_set_has_tooltip (widget,
4466 GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (widget), quark_has_tooltip)),
4469 if (priv->has_shape_mask)
4471 region = g_object_get_qdata (G_OBJECT (widget), quark_shape_info);
4472 gdk_window_shape_combine_region (priv->window, region, 0, 0);
4475 region = g_object_get_qdata (G_OBJECT (widget), quark_input_shape_info);
4477 gdk_window_input_shape_combine_region (priv->window, region, 0, 0);
4479 if (priv->multidevice)
4480 gdk_window_set_support_multidevice (priv->window, TRUE);
4482 _gtk_widget_enable_device_events (widget);
4483 gtk_widget_update_devices_mask (widget, TRUE);
4485 gtk_widget_pop_verify_invariants (widget);
4490 * gtk_widget_unrealize:
4491 * @widget: a #GtkWidget
4493 * This function is only useful in widget implementations.
4494 * Causes a widget to be unrealized (frees all GDK resources
4495 * associated with the widget, such as @widget->window).
4498 gtk_widget_unrealize (GtkWidget *widget)
4500 g_return_if_fail (GTK_IS_WIDGET (widget));
4502 gtk_widget_push_verify_invariants (widget);
4504 if (widget->priv->has_shape_mask)
4505 gtk_widget_shape_combine_region (widget, NULL);
4507 if (g_object_get_qdata (G_OBJECT (widget), quark_input_shape_info))
4508 gtk_widget_input_shape_combine_region (widget, NULL);
4510 if (gtk_widget_get_realized (widget))
4512 g_object_ref (widget);
4514 if (widget->priv->mapped)
4515 gtk_widget_unmap (widget);
4517 g_signal_emit (widget, widget_signals[UNREALIZE], 0);
4518 g_assert (!widget->priv->mapped);
4519 gtk_widget_set_realized (widget, FALSE);
4521 g_object_unref (widget);
4524 gtk_widget_pop_verify_invariants (widget);
4527 /*****************************************
4529 *****************************************/
4532 * gtk_widget_queue_draw_region:
4533 * @widget: a #GtkWidget
4534 * @region: region to draw
4536 * Invalidates the rectangular area of @widget defined by @region by
4537 * calling gdk_window_invalidate_region() on the widget's window and
4538 * all its child windows. Once the main loop becomes idle (after the
4539 * current batch of events has been processed, roughly), the window
4540 * will receive expose events for the union of all regions that have
4543 * Normally you would only use this function in widget
4544 * implementations. You might also use it to schedule a redraw of a
4545 * #GtkDrawingArea or some portion thereof.
4550 gtk_widget_queue_draw_region (GtkWidget *widget,
4551 const cairo_region_t *region)
4553 GtkWidgetPrivate *priv;
4556 g_return_if_fail (GTK_IS_WIDGET (widget));
4558 priv = widget->priv;
4560 if (!gtk_widget_get_realized (widget))
4563 /* Just return if the widget or one of its ancestors isn't mapped */
4564 for (w = widget; w != NULL; w = w->priv->parent)
4565 if (!gtk_widget_get_mapped (w))
4568 gdk_window_invalidate_region (priv->window, region, TRUE);
4572 * gtk_widget_queue_draw_area:
4573 * @widget: a #GtkWidget
4574 * @x: x coordinate of upper-left corner of rectangle to redraw
4575 * @y: y coordinate of upper-left corner of rectangle to redraw
4576 * @width: width of region to draw
4577 * @height: height of region to draw
4579 * Convenience function that calls gtk_widget_queue_draw_region() on
4580 * the region created from the given coordinates.
4582 * The region here is specified in widget coordinates.
4583 * Widget coordinates are a bit odd; for historical reasons, they are
4584 * defined as @widget->window coordinates for widgets that are not
4585 * #GTK_NO_WINDOW widgets, and are relative to @widget->allocation.x,
4586 * @widget->allocation.y for widgets that are #GTK_NO_WINDOW widgets.
4589 gtk_widget_queue_draw_area (GtkWidget *widget,
4596 cairo_region_t *region;
4598 g_return_if_fail (GTK_IS_WIDGET (widget));
4603 rect.height = height;
4605 region = cairo_region_create_rectangle (&rect);
4606 gtk_widget_queue_draw_region (widget, region);
4607 cairo_region_destroy (region);
4611 * gtk_widget_queue_draw:
4612 * @widget: a #GtkWidget
4614 * Equivalent to calling gtk_widget_queue_draw_area() for the
4615 * entire area of a widget.
4618 gtk_widget_queue_draw (GtkWidget *widget)
4622 g_return_if_fail (GTK_IS_WIDGET (widget));
4624 gtk_widget_get_allocation (widget, &rect);
4626 if (!gtk_widget_get_has_window (widget))
4627 gtk_widget_queue_draw_area (widget,
4628 rect.x, rect.y, rect.width, rect.height);
4630 gtk_widget_queue_draw_area (widget,
4631 0, 0, rect.width, rect.height);
4635 * gtk_widget_queue_resize:
4636 * @widget: a #GtkWidget
4638 * This function is only for use in widget implementations.
4639 * Flags a widget to have its size renegotiated; should
4640 * be called when a widget for some reason has a new size request.
4641 * For example, when you change the text in a #GtkLabel, #GtkLabel
4642 * queues a resize to ensure there's enough space for the new text.
4644 * <note><para>You cannot call gtk_widget_queue_resize() on a widget
4645 * from inside its implementation of the GtkWidgetClass::size_allocate
4646 * virtual method. Calls to gtk_widget_queue_resize() from inside
4647 * GtkWidgetClass::size_allocate will be silently ignored.</para></note>
4650 gtk_widget_queue_resize (GtkWidget *widget)
4652 g_return_if_fail (GTK_IS_WIDGET (widget));
4654 if (gtk_widget_get_realized (widget))
4655 gtk_widget_queue_draw (widget);
4657 if (gtk_widget_get_visible (widget) ||
4658 widget->priv->have_size_groups)
4659 _gtk_size_group_queue_resize (widget, 0);
4663 * gtk_widget_queue_resize_no_redraw:
4664 * @widget: a #GtkWidget
4666 * This function works like gtk_widget_queue_resize(),
4667 * except that the widget is not invalidated.
4672 gtk_widget_queue_resize_no_redraw (GtkWidget *widget)
4674 g_return_if_fail (GTK_IS_WIDGET (widget));
4676 _gtk_size_group_queue_resize (widget, 0);
4680 * gtk_widget_size_request:
4681 * @widget: a #GtkWidget
4682 * @requisition: (out): a #GtkRequisition to be filled in
4684 * This function is typically used when implementing a #GtkContainer
4685 * subclass. Obtains the preferred size of a widget. The container
4686 * uses this information to arrange its child widgets and decide what
4687 * size allocations to give them with gtk_widget_size_allocate().
4689 * You can also call this function from an application, with some
4690 * caveats. Most notably, getting a size request requires the widget
4691 * to be associated with a screen, because font information may be
4692 * needed. Multihead-aware applications should keep this in mind.
4694 * Also remember that the size request is not necessarily the size
4695 * a widget will actually be allocated.
4697 * Deprecated: 3.0: Use gtk_widget_get_preferred_size() instead.
4700 gtk_widget_size_request (GtkWidget *widget,
4701 GtkRequisition *requisition)
4703 g_return_if_fail (GTK_IS_WIDGET (widget));
4705 gtk_widget_get_preferred_size (widget, requisition, NULL);
4709 * gtk_widget_get_child_requisition:
4710 * @widget: a #GtkWidget
4711 * @requisition: (out): a #GtkRequisition to be filled in
4713 * This function is only for use in widget implementations. Obtains
4714 * @widget->requisition, unless someone has forced a particular
4715 * geometry on the widget (e.g. with gtk_widget_set_size_request()),
4716 * in which case it returns that geometry instead of the widget's
4719 * This function differs from gtk_widget_size_request() in that
4720 * it retrieves the last size request value from @widget->requisition,
4721 * while gtk_widget_size_request() actually calls the "size_request" method
4722 * on @widget to compute the size request and fill in @widget->requisition,
4723 * and only then returns @widget->requisition.
4725 * Because this function does not call the "size_request" method, it
4726 * can only be used when you know that @widget->requisition is
4727 * up-to-date, that is, gtk_widget_size_request() has been called
4728 * since the last time a resize was queued. In general, only container
4729 * implementations have this information; applications should use
4730 * gtk_widget_size_request().
4733 * Deprecated: 3.0: Use gtk_widget_get_preferred_size() instead.
4736 gtk_widget_get_child_requisition (GtkWidget *widget,
4737 GtkRequisition *requisition)
4739 gtk_widget_get_preferred_size (widget, requisition, NULL);
4743 invalidate_predicate (GdkWindow *window,
4748 gdk_window_get_user_data (window, &user_data);
4750 return (user_data == data);
4753 /* Invalidate @region in widget->window and all children
4754 * of widget->window owned by widget. @region is in the
4755 * same coordinates as widget->allocation and will be
4756 * modified by this call.
4759 gtk_widget_invalidate_widget_windows (GtkWidget *widget,
4760 cairo_region_t *region)
4762 GtkWidgetPrivate *priv = widget->priv;
4764 if (!gtk_widget_get_realized (widget))
4767 if (gtk_widget_get_has_window (widget) && priv->parent)
4771 gdk_window_get_position (priv->window, &x, &y);
4772 cairo_region_translate (region, -x, -y);
4775 gdk_window_invalidate_maybe_recurse (priv->window, region,
4776 invalidate_predicate, widget);
4780 * gtk_widget_size_allocate:
4781 * @widget: a #GtkWidget
4782 * @allocation: position and size to be allocated to @widget
4784 * This function is only used by #GtkContainer subclasses, to assign a size
4785 * and position to their child widgets.
4787 * In this function, the allocation may be adjusted. It will be forced
4788 * to a 1x1 minimum size, and the adjust_size_allocation virtual
4789 * method on the child will be used to adjust the allocation. Standard
4790 * adjustments include removing the widget's margins, and applying the
4791 * widget's #GtkWidget:halign and #GtkWidget:valign properties.
4794 gtk_widget_size_allocate (GtkWidget *widget,
4795 GtkAllocation *allocation)
4797 GtkWidgetPrivate *priv;
4798 GdkRectangle real_allocation;
4799 GdkRectangle old_allocation;
4800 GdkRectangle adjusted_allocation;
4801 gboolean alloc_needed;
4802 gboolean size_changed;
4803 gboolean position_changed;
4804 gint natural_width, natural_height, dummy;
4805 gint min_width, min_height;
4807 priv = widget->priv;
4809 g_return_if_fail (GTK_IS_WIDGET (widget));
4811 gtk_widget_push_verify_invariants (widget);
4813 #ifdef G_ENABLE_DEBUG
4814 if (gtk_get_debug_flags () & GTK_DEBUG_GEOMETRY)
4825 parent = gtk_widget_get_parent (parent);
4828 name = g_type_name (G_OBJECT_TYPE (G_OBJECT (widget)));
4829 g_print ("gtk_widget_size_allocate: %*s%s %d %d\n",
4830 2 * depth, " ", name,
4831 allocation->width, allocation->height);
4833 #endif /* G_ENABLE_DEBUG */
4835 alloc_needed = priv->alloc_needed;
4836 /* Preserve request/allocate ordering */
4837 priv->alloc_needed = FALSE;
4839 old_allocation = priv->allocation;
4840 real_allocation = *allocation;
4842 adjusted_allocation = real_allocation;
4843 if (gtk_widget_get_request_mode (widget) == GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH)
4845 /* Go ahead and request the height for allocated width, note that the internals
4846 * of get_height_for_width will internally limit the for_size to natural size
4847 * when aligning implicitly.
4849 gtk_widget_get_preferred_width (widget, &min_width, &natural_width);
4850 gtk_widget_get_preferred_height_for_width (widget, real_allocation.width, &min_height, &natural_height);
4854 /* Go ahead and request the width for allocated height, note that the internals
4855 * of get_width_for_height will internally limit the for_size to natural size
4856 * when aligning implicitly.
4858 gtk_widget_get_preferred_height (widget, &min_height, &natural_height);
4859 gtk_widget_get_preferred_width_for_height (widget, real_allocation.height, &min_width, &natural_width);
4862 #ifdef G_ENABLE_DEBUG
4863 if (gtk_get_debug_flags () & GTK_DEBUG_GEOMETRY)
4865 if ((min_width > real_allocation.width || min_height > real_allocation.height) &&
4866 !GTK_IS_SCROLLABLE (widget))
4867 g_warning ("gtk_widget_size_allocate(): attempt to underallocate %s%s %s %p. "
4868 "Allocation is %dx%d, but minimum required size is %dx%d.",
4869 priv->parent ? G_OBJECT_TYPE_NAME (priv->parent) : "", priv->parent ? "'s child" : "toplevel",
4870 G_OBJECT_TYPE_NAME (widget), widget,
4871 real_allocation.width, real_allocation.height,
4872 min_width, min_height);
4875 /* Now that we have the right natural height and width, go ahead and remove any margins from the
4876 * allocated sizes and possibly limit them to the natural sizes */
4877 GTK_WIDGET_GET_CLASS (widget)->adjust_size_allocation (widget,
4878 GTK_ORIENTATION_HORIZONTAL,
4881 &adjusted_allocation.x,
4882 &adjusted_allocation.width);
4883 GTK_WIDGET_GET_CLASS (widget)->adjust_size_allocation (widget,
4884 GTK_ORIENTATION_VERTICAL,
4887 &adjusted_allocation.y,
4888 &adjusted_allocation.height);
4890 if (adjusted_allocation.x < real_allocation.x ||
4891 adjusted_allocation.y < real_allocation.y ||
4892 (adjusted_allocation.x + adjusted_allocation.width) >
4893 (real_allocation.x + real_allocation.width) ||
4894 (adjusted_allocation.y + adjusted_allocation.height >
4895 real_allocation.y + real_allocation.height))
4897 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",
4898 G_OBJECT_TYPE_NAME (widget), widget,
4899 real_allocation.x, real_allocation.y, real_allocation.width, real_allocation.height,
4900 adjusted_allocation.x, adjusted_allocation.y, adjusted_allocation.width, adjusted_allocation.height);
4901 adjusted_allocation = real_allocation; /* veto it */
4905 real_allocation = adjusted_allocation;
4908 if (real_allocation.width < 0 || real_allocation.height < 0)
4910 g_warning ("gtk_widget_size_allocate(): attempt to allocate widget with width %d and height %d",
4911 real_allocation.width,
4912 real_allocation.height);
4915 real_allocation.width = MAX (real_allocation.width, 1);
4916 real_allocation.height = MAX (real_allocation.height, 1);
4918 size_changed = (old_allocation.width != real_allocation.width ||
4919 old_allocation.height != real_allocation.height);
4920 position_changed = (old_allocation.x != real_allocation.x ||
4921 old_allocation.y != real_allocation.y);
4923 if (!alloc_needed && !size_changed && !position_changed)
4926 g_signal_emit (widget, widget_signals[SIZE_ALLOCATE], 0, &real_allocation);
4928 /* Size allocation is god... after consulting god, no further requests or allocations are needed */
4929 priv->alloc_needed = FALSE;
4931 if (gtk_widget_get_mapped (widget))
4933 if (!gtk_widget_get_has_window (widget) && priv->redraw_on_alloc && position_changed)
4935 /* Invalidate union(old_allaction,priv->allocation) in priv->window
4937 cairo_region_t *invalidate = cairo_region_create_rectangle (&priv->allocation);
4938 cairo_region_union_rectangle (invalidate, &old_allocation);
4940 gdk_window_invalidate_region (priv->window, invalidate, FALSE);
4941 cairo_region_destroy (invalidate);
4946 if (priv->redraw_on_alloc)
4948 /* Invalidate union(old_allaction,priv->allocation) in priv->window and descendents owned by widget
4950 cairo_region_t *invalidate = cairo_region_create_rectangle (&priv->allocation);
4951 cairo_region_union_rectangle (invalidate, &old_allocation);
4953 gtk_widget_invalidate_widget_windows (widget, invalidate);
4954 cairo_region_destroy (invalidate);
4959 if ((size_changed || position_changed) && priv->parent &&
4960 gtk_widget_get_realized (priv->parent) && _gtk_container_get_reallocate_redraws (GTK_CONTAINER (priv->parent)))
4962 cairo_region_t *invalidate = cairo_region_create_rectangle (&priv->parent->priv->allocation);
4963 gtk_widget_invalidate_widget_windows (priv->parent, invalidate);
4964 cairo_region_destroy (invalidate);
4968 gtk_widget_pop_verify_invariants (widget);
4972 * gtk_widget_common_ancestor:
4973 * @widget_a: a #GtkWidget
4974 * @widget_b: a #GtkWidget
4976 * Find the common ancestor of @widget_a and @widget_b that
4977 * is closest to the two widgets.
4979 * Return value: the closest common ancestor of @widget_a and
4980 * @widget_b or %NULL if @widget_a and @widget_b do not
4981 * share a common ancestor.
4984 gtk_widget_common_ancestor (GtkWidget *widget_a,
4985 GtkWidget *widget_b)
4987 GtkWidget *parent_a;
4988 GtkWidget *parent_b;
4992 parent_a = widget_a;
4993 while (parent_a->priv->parent)
4995 parent_a = parent_a->priv->parent;
4999 parent_b = widget_b;
5000 while (parent_b->priv->parent)
5002 parent_b = parent_b->priv->parent;
5006 if (parent_a != parent_b)
5009 while (depth_a > depth_b)
5011 widget_a = widget_a->priv->parent;
5015 while (depth_b > depth_a)
5017 widget_b = widget_b->priv->parent;
5021 while (widget_a != widget_b)
5023 widget_a = widget_a->priv->parent;
5024 widget_b = widget_b->priv->parent;
5031 * gtk_widget_translate_coordinates:
5032 * @src_widget: a #GtkWidget
5033 * @dest_widget: a #GtkWidget
5034 * @src_x: X position relative to @src_widget
5035 * @src_y: Y position relative to @src_widget
5036 * @dest_x: (out): location to store X position relative to @dest_widget
5037 * @dest_y: (out): location to store Y position relative to @dest_widget
5039 * Translate coordinates relative to @src_widget's allocation to coordinates
5040 * relative to @dest_widget's allocations. In order to perform this
5041 * operation, both widgets must be realized, and must share a common
5044 * Return value: %FALSE if either widget was not realized, or there
5045 * was no common ancestor. In this case, nothing is stored in
5046 * *@dest_x and *@dest_y. Otherwise %TRUE.
5049 gtk_widget_translate_coordinates (GtkWidget *src_widget,
5050 GtkWidget *dest_widget,
5056 GtkWidgetPrivate *src_priv = src_widget->priv;
5057 GtkWidgetPrivate *dest_priv = dest_widget->priv;
5058 GtkWidget *ancestor;
5060 GList *dest_list = NULL;
5062 g_return_val_if_fail (GTK_IS_WIDGET (src_widget), FALSE);
5063 g_return_val_if_fail (GTK_IS_WIDGET (dest_widget), FALSE);
5065 ancestor = gtk_widget_common_ancestor (src_widget, dest_widget);
5066 if (!ancestor || !gtk_widget_get_realized (src_widget) || !gtk_widget_get_realized (dest_widget))
5069 /* Translate from allocation relative to window relative */
5070 if (gtk_widget_get_has_window (src_widget) && src_priv->parent)
5073 gdk_window_get_position (src_priv->window, &wx, &wy);
5075 src_x -= wx - src_priv->allocation.x;
5076 src_y -= wy - src_priv->allocation.y;
5080 src_x += src_priv->allocation.x;
5081 src_y += src_priv->allocation.y;
5084 /* Translate to the common ancestor */
5085 window = src_priv->window;
5086 while (window != ancestor->priv->window)
5090 gdk_window_coords_to_parent (window, src_x, src_y, &dx, &dy);
5095 window = gdk_window_get_effective_parent (window);
5097 if (!window) /* Handle GtkHandleBox */
5102 window = dest_priv->window;
5103 while (window != ancestor->priv->window)
5105 dest_list = g_list_prepend (dest_list, window);
5107 window = gdk_window_get_effective_parent (window);
5109 if (!window) /* Handle GtkHandleBox */
5111 g_list_free (dest_list);
5120 gdk_window_coords_from_parent (dest_list->data, src_x, src_y, &dx, &dy);
5125 dest_list = g_list_remove (dest_list, dest_list->data);
5128 /* Translate from window relative to allocation relative */
5129 if (gtk_widget_get_has_window (dest_widget) && dest_priv->parent)
5132 gdk_window_get_position (dest_priv->window, &wx, &wy);
5134 src_x += wx - dest_priv->allocation.x;
5135 src_y += wy - dest_priv->allocation.y;
5139 src_x -= dest_priv->allocation.x;
5140 src_y -= dest_priv->allocation.y;
5152 gtk_widget_real_size_allocate (GtkWidget *widget,
5153 GtkAllocation *allocation)
5155 GtkWidgetPrivate *priv = widget->priv;
5157 priv->allocation = *allocation;
5159 if (gtk_widget_get_realized (widget) &&
5160 gtk_widget_get_has_window (widget))
5162 gdk_window_move_resize (priv->window,
5163 allocation->x, allocation->y,
5164 allocation->width, allocation->height);
5168 /* translate initial/final into start/end */
5170 effective_align (GtkAlign align,
5171 GtkTextDirection direction)
5175 case GTK_ALIGN_START:
5176 return direction == GTK_TEXT_DIR_RTL ? GTK_ALIGN_END : GTK_ALIGN_START;
5178 return direction == GTK_TEXT_DIR_RTL ? GTK_ALIGN_START : GTK_ALIGN_END;
5185 adjust_for_align (GtkAlign align,
5187 gint *allocated_pos,
5188 gint *allocated_size)
5192 case GTK_ALIGN_FILL:
5193 /* change nothing */
5195 case GTK_ALIGN_START:
5196 /* keep *allocated_pos where it is */
5197 *allocated_size = MIN (*allocated_size, *natural_size);
5200 if (*allocated_size > *natural_size)
5202 *allocated_pos += (*allocated_size - *natural_size);
5203 *allocated_size = *natural_size;
5206 case GTK_ALIGN_CENTER:
5207 if (*allocated_size > *natural_size)
5209 *allocated_pos += (*allocated_size - *natural_size) / 2;
5210 *allocated_size = MIN (*allocated_size, *natural_size);
5217 adjust_for_margin(gint start_margin,
5221 gint *allocated_pos,
5222 gint *allocated_size)
5224 *minimum_size -= (start_margin + end_margin);
5225 *natural_size -= (start_margin + end_margin);
5226 *allocated_pos += start_margin;
5227 *allocated_size -= (start_margin + end_margin);
5231 gtk_widget_real_adjust_size_allocation (GtkWidget *widget,
5232 GtkOrientation orientation,
5235 gint *allocated_pos,
5236 gint *allocated_size)
5238 const GtkWidgetAuxInfo *aux_info;
5240 aux_info = _gtk_widget_get_aux_info_or_defaults (widget);
5242 if (orientation == GTK_ORIENTATION_HORIZONTAL)
5244 adjust_for_margin (aux_info->margin.left,
5245 aux_info->margin.right,
5246 minimum_size, natural_size,
5247 allocated_pos, allocated_size);
5248 adjust_for_align (effective_align (aux_info->halign, gtk_widget_get_direction (widget)),
5249 natural_size, allocated_pos, allocated_size);
5253 adjust_for_margin (aux_info->margin.top,
5254 aux_info->margin.bottom,
5255 minimum_size, natural_size,
5256 allocated_pos, allocated_size);
5257 adjust_for_align (effective_align (aux_info->valign, GTK_TEXT_DIR_NONE),
5258 natural_size, allocated_pos, allocated_size);
5263 gtk_widget_real_can_activate_accel (GtkWidget *widget,
5266 GtkWidgetPrivate *priv = widget->priv;
5268 /* widgets must be onscreen for accels to take effect */
5269 return gtk_widget_is_sensitive (widget) &&
5270 gtk_widget_is_drawable (widget) &&
5271 gdk_window_is_viewable (priv->window);
5275 * gtk_widget_can_activate_accel:
5276 * @widget: a #GtkWidget
5277 * @signal_id: the ID of a signal installed on @widget
5279 * Determines whether an accelerator that activates the signal
5280 * identified by @signal_id can currently be activated.
5281 * This is done by emitting the #GtkWidget::can-activate-accel
5282 * signal on @widget; if the signal isn't overridden by a
5283 * handler or in a derived widget, then the default check is
5284 * that the widget must be sensitive, and the widget and all
5285 * its ancestors mapped.
5287 * Return value: %TRUE if the accelerator can be activated.
5292 gtk_widget_can_activate_accel (GtkWidget *widget,
5295 gboolean can_activate = FALSE;
5296 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5297 g_signal_emit (widget, widget_signals[CAN_ACTIVATE_ACCEL], 0, signal_id, &can_activate);
5298 return can_activate;
5307 closure_accel_activate (GClosure *closure,
5308 GValue *return_value,
5309 guint n_param_values,
5310 const GValue *param_values,
5311 gpointer invocation_hint,
5312 gpointer marshal_data)
5314 AccelClosure *aclosure = (AccelClosure*) closure;
5315 gboolean can_activate = gtk_widget_can_activate_accel (closure->data, aclosure->signal_id);
5318 g_signal_emit (closure->data, aclosure->signal_id, 0);
5320 /* whether accelerator was handled */
5321 g_value_set_boolean (return_value, can_activate);
5325 closures_destroy (gpointer data)
5327 GSList *slist, *closures = data;
5329 for (slist = closures; slist; slist = slist->next)
5331 g_closure_invalidate (slist->data);
5332 g_closure_unref (slist->data);
5334 g_slist_free (closures);
5338 widget_new_accel_closure (GtkWidget *widget,
5341 AccelClosure *aclosure;
5342 GClosure *closure = NULL;
5343 GSList *slist, *closures;
5345 closures = g_object_steal_qdata (G_OBJECT (widget), quark_accel_closures);
5346 for (slist = closures; slist; slist = slist->next)
5347 if (!gtk_accel_group_from_accel_closure (slist->data))
5349 /* reuse this closure */
5350 closure = slist->data;
5355 closure = g_closure_new_object (sizeof (AccelClosure), G_OBJECT (widget));
5356 closures = g_slist_prepend (closures, g_closure_ref (closure));
5357 g_closure_sink (closure);
5358 g_closure_set_marshal (closure, closure_accel_activate);
5360 g_object_set_qdata_full (G_OBJECT (widget), quark_accel_closures, closures, closures_destroy);
5362 aclosure = (AccelClosure*) closure;
5363 g_assert (closure->data == widget);
5364 g_assert (closure->marshal == closure_accel_activate);
5365 aclosure->signal_id = signal_id;
5371 * gtk_widget_add_accelerator:
5372 * @widget: widget to install an accelerator on
5373 * @accel_signal: widget signal to emit on accelerator activation
5374 * @accel_group: accel group for this widget, added to its toplevel
5375 * @accel_key: GDK keyval of the accelerator
5376 * @accel_mods: modifier key combination of the accelerator
5377 * @accel_flags: flag accelerators, e.g. %GTK_ACCEL_VISIBLE
5379 * Installs an accelerator for this @widget in @accel_group that causes
5380 * @accel_signal to be emitted if the accelerator is activated.
5381 * The @accel_group needs to be added to the widget's toplevel via
5382 * gtk_window_add_accel_group(), and the signal must be of type %G_SIGNAL_ACTION.
5383 * Accelerators added through this function are not user changeable during
5384 * runtime. If you want to support accelerators that can be changed by the
5385 * user, use gtk_accel_map_add_entry() and gtk_widget_set_accel_path() or
5386 * gtk_menu_item_set_accel_path() instead.
5389 gtk_widget_add_accelerator (GtkWidget *widget,
5390 const gchar *accel_signal,
5391 GtkAccelGroup *accel_group,
5393 GdkModifierType accel_mods,
5394 GtkAccelFlags accel_flags)
5399 g_return_if_fail (GTK_IS_WIDGET (widget));
5400 g_return_if_fail (accel_signal != NULL);
5401 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
5403 g_signal_query (g_signal_lookup (accel_signal, G_OBJECT_TYPE (widget)), &query);
5404 if (!query.signal_id ||
5405 !(query.signal_flags & G_SIGNAL_ACTION) ||
5406 query.return_type != G_TYPE_NONE ||
5409 /* hmm, should be elaborate enough */
5410 g_warning (G_STRLOC ": widget `%s' has no activatable signal \"%s\" without arguments",
5411 G_OBJECT_TYPE_NAME (widget), accel_signal);
5415 closure = widget_new_accel_closure (widget, query.signal_id);
5417 g_object_ref (widget);
5419 /* install the accelerator. since we don't map this onto an accel_path,
5420 * the accelerator will automatically be locked.
5422 gtk_accel_group_connect (accel_group,
5425 accel_flags | GTK_ACCEL_LOCKED,
5428 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
5430 g_object_unref (widget);
5434 * gtk_widget_remove_accelerator:
5435 * @widget: widget to install an accelerator on
5436 * @accel_group: accel group for this widget
5437 * @accel_key: GDK keyval of the accelerator
5438 * @accel_mods: modifier key combination of the accelerator
5440 * Removes an accelerator from @widget, previously installed with
5441 * gtk_widget_add_accelerator().
5443 * Returns: whether an accelerator was installed and could be removed
5446 gtk_widget_remove_accelerator (GtkWidget *widget,
5447 GtkAccelGroup *accel_group,
5449 GdkModifierType accel_mods)
5451 GtkAccelGroupEntry *ag_entry;
5452 GList *slist, *clist;
5455 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5456 g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE);
5458 ag_entry = gtk_accel_group_query (accel_group, accel_key, accel_mods, &n);
5459 clist = gtk_widget_list_accel_closures (widget);
5460 for (slist = clist; slist; slist = slist->next)
5464 for (i = 0; i < n; i++)
5465 if (slist->data == (gpointer) ag_entry[i].closure)
5467 gboolean is_removed = gtk_accel_group_disconnect (accel_group, slist->data);
5469 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
5471 g_list_free (clist);
5476 g_list_free (clist);
5478 g_warning (G_STRLOC ": no accelerator (%u,%u) installed in accel group (%p) for %s (%p)",
5479 accel_key, accel_mods, accel_group,
5480 G_OBJECT_TYPE_NAME (widget), widget);
5486 * gtk_widget_list_accel_closures:
5487 * @widget: widget to list accelerator closures for
5489 * Lists the closures used by @widget for accelerator group connections
5490 * with gtk_accel_group_connect_by_path() or gtk_accel_group_connect().
5491 * The closures can be used to monitor accelerator changes on @widget,
5492 * by connecting to the @GtkAccelGroup::accel-changed signal of the
5493 * #GtkAccelGroup of a closure which can be found out with
5494 * gtk_accel_group_from_accel_closure().
5496 * Return value: (transfer container) (element-type GClosure):
5497 * a newly allocated #GList of closures
5500 gtk_widget_list_accel_closures (GtkWidget *widget)
5503 GList *clist = NULL;
5505 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5507 for (slist = g_object_get_qdata (G_OBJECT (widget), quark_accel_closures); slist; slist = slist->next)
5508 if (gtk_accel_group_from_accel_closure (slist->data))
5509 clist = g_list_prepend (clist, slist->data);
5515 GtkAccelGroup *accel_group;
5520 destroy_accel_path (gpointer data)
5522 AccelPath *apath = data;
5524 gtk_accel_group_disconnect (apath->accel_group, apath->closure);
5526 /* closures_destroy takes care of unrefing the closure */
5527 g_object_unref (apath->accel_group);
5529 g_slice_free (AccelPath, apath);
5534 * gtk_widget_set_accel_path:
5535 * @widget: a #GtkWidget
5536 * @accel_path: (allow-none): path used to look up the accelerator
5537 * @accel_group: (allow-none): a #GtkAccelGroup.
5539 * Given an accelerator group, @accel_group, and an accelerator path,
5540 * @accel_path, sets up an accelerator in @accel_group so whenever the
5541 * key binding that is defined for @accel_path is pressed, @widget
5542 * will be activated. This removes any accelerators (for any
5543 * accelerator group) installed by previous calls to
5544 * gtk_widget_set_accel_path(). Associating accelerators with
5545 * paths allows them to be modified by the user and the modifications
5546 * to be saved for future use. (See gtk_accel_map_save().)
5548 * This function is a low level function that would most likely
5549 * be used by a menu creation system like #GtkUIManager. If you
5550 * use #GtkUIManager, setting up accelerator paths will be done
5553 * Even when you you aren't using #GtkUIManager, if you only want to
5554 * set up accelerators on menu items gtk_menu_item_set_accel_path()
5555 * provides a somewhat more convenient interface.
5557 * Note that @accel_path string will be stored in a #GQuark. Therefore, if you
5558 * pass a static string, you can save some memory by interning it first with
5559 * g_intern_static_string().
5562 gtk_widget_set_accel_path (GtkWidget *widget,
5563 const gchar *accel_path,
5564 GtkAccelGroup *accel_group)
5568 g_return_if_fail (GTK_IS_WIDGET (widget));
5569 g_return_if_fail (GTK_WIDGET_GET_CLASS (widget)->activate_signal != 0);
5573 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
5574 g_return_if_fail (_gtk_accel_path_is_valid (accel_path));
5576 gtk_accel_map_add_entry (accel_path, 0, 0);
5577 apath = g_slice_new (AccelPath);
5578 apath->accel_group = g_object_ref (accel_group);
5579 apath->path_quark = g_quark_from_string (accel_path);
5580 apath->closure = widget_new_accel_closure (widget, GTK_WIDGET_GET_CLASS (widget)->activate_signal);
5585 /* also removes possible old settings */
5586 g_object_set_qdata_full (G_OBJECT (widget), quark_accel_path, apath, destroy_accel_path);
5589 gtk_accel_group_connect_by_path (apath->accel_group, g_quark_to_string (apath->path_quark), apath->closure);
5591 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
5595 _gtk_widget_get_accel_path (GtkWidget *widget,
5600 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5602 apath = g_object_get_qdata (G_OBJECT (widget), quark_accel_path);
5604 *locked = apath ? gtk_accel_group_get_is_locked (apath->accel_group) : TRUE;
5605 return apath ? g_quark_to_string (apath->path_quark) : NULL;
5609 * gtk_widget_mnemonic_activate:
5610 * @widget: a #GtkWidget
5611 * @group_cycling: %TRUE if there are other widgets with the same mnemonic
5613 * Emits the #GtkWidget::mnemonic-activate signal.
5615 * The default handler for this signal activates the @widget if
5616 * @group_cycling is %FALSE, and just grabs the focus if @group_cycling
5619 * Returns: %TRUE if the signal has been handled
5622 gtk_widget_mnemonic_activate (GtkWidget *widget,
5623 gboolean group_cycling)
5627 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5629 group_cycling = group_cycling != FALSE;
5630 if (!gtk_widget_is_sensitive (widget))
5633 g_signal_emit (widget,
5634 widget_signals[MNEMONIC_ACTIVATE],
5642 gtk_widget_real_mnemonic_activate (GtkWidget *widget,
5643 gboolean group_cycling)
5645 if (!group_cycling && GTK_WIDGET_GET_CLASS (widget)->activate_signal)
5646 gtk_widget_activate (widget);
5647 else if (gtk_widget_get_can_focus (widget))
5648 gtk_widget_grab_focus (widget);
5651 g_warning ("widget `%s' isn't suitable for mnemonic activation",
5652 G_OBJECT_TYPE_NAME (widget));
5653 gtk_widget_error_bell (widget);
5658 static const cairo_user_data_key_t event_key;
5661 _gtk_cairo_get_event (cairo_t *cr)
5663 g_return_val_if_fail (cr != NULL, NULL);
5665 return cairo_get_user_data (cr, &event_key);
5669 gtk_cairo_set_event (cairo_t *cr,
5670 GdkEventExpose *event)
5672 cairo_set_user_data (cr, &event_key, event, NULL);
5676 * gtk_cairo_should_draw_window:
5677 * @cr: a cairo context
5678 * @window: the window to check. @window may not be an input-only
5681 * This function is supposed to be called in #GtkWidget::draw
5682 * implementations for widgets that support multiple windows.
5683 * @cr must be untransformed from invoking of the draw function.
5684 * This function will return %TRUE if the contents of the given
5685 * @window are supposed to be drawn and %FALSE otherwise. Note
5686 * that when the drawing was not initiated by the windowing
5687 * system this function will return %TRUE for all windows, so
5688 * you need to draw the bottommost window first. Also, do not
5689 * use "else if" statements to check which window should be drawn.
5691 * Returns: %TRUE if @window should be drawn
5696 gtk_cairo_should_draw_window (cairo_t *cr,
5699 GdkEventExpose *event;
5701 g_return_val_if_fail (cr != NULL, FALSE);
5702 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
5704 event = _gtk_cairo_get_event (cr);
5706 return event == NULL ||
5707 event->window == window;
5711 gtk_widget_get_clip_draw (GtkWidget *widget)
5713 /* labels are not clipped, because clipping them would cause
5714 * mnemonics to not appear on characters that go beyond the
5716 * https://bugzilla.gnome.org/show_bug.cgi?id=648570
5718 if (GTK_IS_LABEL (widget))
5724 /* code shared by gtk_container_propagate_draw() and
5728 _gtk_widget_draw_internal (GtkWidget *widget,
5730 gboolean clip_to_size)
5732 if (!gtk_widget_is_drawable (widget))
5735 clip_to_size &= gtk_widget_get_clip_draw (widget);
5739 cairo_rectangle (cr,
5741 widget->priv->allocation.width,
5742 widget->priv->allocation.height);
5746 if (gdk_cairo_get_clip_rectangle (cr, NULL))
5750 g_signal_emit (widget, widget_signals[DRAW],
5754 if (cairo_status (cr) &&
5755 _gtk_cairo_get_event (cr))
5757 /* We check the event so we only warn about internal GTK calls.
5758 * Errors might come from PDF streams having write failures and
5759 * we don't want to spam stderr in that case.
5760 * We do want to catch errors from
5762 g_warning ("drawing failure for widget `%s': %s",
5763 G_OBJECT_TYPE_NAME (widget),
5764 cairo_status_to_string (cairo_status (cr)));
5771 * @widget: the widget to draw. It must be drawable (see
5772 * gtk_widget_is_drawable()) and a size must have been allocated.
5773 * @cr: a cairo context to draw to
5775 * Draws @widget to @cr. The top left corner of the widget will be
5776 * drawn to the currently set origin point of @cr.
5778 * You should pass a cairo context as @cr argument that is in an
5779 * original state. Otherwise the resulting drawing is undefined. For
5780 * example changing the operator using cairo_set_operator() or the
5781 * line width using cairo_set_line_width() might have unwanted side
5783 * You may however change the context's transform matrix - like with
5784 * cairo_scale(), cairo_translate() or cairo_set_matrix() and clip
5785 * region with cairo_clip() prior to calling this function. Also, it
5786 * is fine to modify the context with cairo_save() and
5787 * cairo_push_group() prior to calling this function.
5789 * <note><para>Special purpose widgets may contain special code for
5790 * rendering to the screen and might appear differently on screen
5791 * and when rendered using gtk_widget_draw().</para></note>
5796 gtk_widget_draw (GtkWidget *widget,
5799 GdkEventExpose *tmp_event;
5801 g_return_if_fail (GTK_IS_WIDGET (widget));
5802 g_return_if_fail (!widget->priv->alloc_needed);
5803 g_return_if_fail (cr != NULL);
5806 /* We have to reset the event here so that draw functions can call
5807 * gtk_widget_draw() on random other widgets and get the desired
5808 * effect: Drawing all contents, not just the current window.
5810 tmp_event = _gtk_cairo_get_event (cr);
5811 gtk_cairo_set_event (cr, NULL);
5813 _gtk_widget_draw_internal (widget, cr, TRUE);
5815 gtk_cairo_set_event (cr, tmp_event);
5820 gtk_widget_real_key_press_event (GtkWidget *widget,
5823 return gtk_bindings_activate_event (G_OBJECT (widget), event);
5827 gtk_widget_real_key_release_event (GtkWidget *widget,
5830 return gtk_bindings_activate_event (G_OBJECT (widget), event);
5834 gtk_widget_real_focus_in_event (GtkWidget *widget,
5835 GdkEventFocus *event)
5837 gtk_widget_queue_draw (widget);
5843 gtk_widget_real_focus_out_event (GtkWidget *widget,
5844 GdkEventFocus *event)
5846 gtk_widget_queue_draw (widget);
5852 gtk_widget_real_touch_event (GtkWidget *widget,
5853 GdkEventTouch *event)
5856 gboolean return_val;
5859 if (!event->emulating_pointer)
5862 if (event->type == GDK_TOUCH_BEGIN ||
5863 event->type == GDK_TOUCH_END)
5867 if (event->type == GDK_TOUCH_BEGIN)
5869 type = GDK_BUTTON_PRESS;
5870 signum = BUTTON_PRESS_EVENT;
5874 type = GDK_BUTTON_RELEASE;
5875 signum = BUTTON_RELEASE_EVENT;
5877 bevent = gdk_event_new (type);
5878 bevent->any.window = g_object_ref (event->window);
5879 bevent->any.send_event = FALSE;
5880 bevent->button.time = event->time;
5881 bevent->button.state = event->state;
5882 bevent->button.button = 1;
5883 bevent->button.x_root = event->x_root;
5884 bevent->button.y_root = event->y_root;
5885 bevent->button.x = event->x;
5886 bevent->button.y = event->y;
5887 bevent->button.device = event->device;
5888 bevent->button.axes = g_memdup (event->axes,
5889 sizeof (gdouble) * gdk_device_get_n_axes (event->device));
5890 gdk_event_set_source_device (bevent, gdk_event_get_source_device ((GdkEvent*)event));
5892 else if (event->type == GDK_TOUCH_UPDATE)
5894 signum = MOTION_NOTIFY_EVENT;
5895 bevent = gdk_event_new (GDK_MOTION_NOTIFY);
5896 bevent->any.window = g_object_ref (event->window);
5897 bevent->any.send_event = FALSE;
5898 bevent->motion.time = event->time;
5899 bevent->motion.state = event->state;
5900 bevent->motion.x_root = event->x_root;
5901 bevent->motion.y_root = event->y_root;
5902 bevent->motion.x = event->x;
5903 bevent->motion.y = event->y;
5904 bevent->motion.device = event->device;
5905 bevent->motion.is_hint = FALSE;
5906 bevent->motion.axes = g_memdup (event->axes,
5907 sizeof (gdouble) * gdk_device_get_n_axes (event->device));
5908 gdk_event_set_source_device (bevent, gdk_event_get_source_device ((GdkEvent*)event));
5913 g_signal_emit (widget, widget_signals[signum], 0, bevent, &return_val);
5915 gdk_event_free (bevent);
5921 #define WIDGET_REALIZED_FOR_EVENT(widget, event) \
5922 (event->type == GDK_FOCUS_CHANGE || gtk_widget_get_realized(widget))
5926 * @widget: a #GtkWidget
5927 * @event: a #GdkEvent
5929 * Rarely-used function. This function is used to emit
5930 * the event signals on a widget (those signals should never
5931 * be emitted without using this function to do so).
5932 * If you want to synthesize an event though, don't use this function;
5933 * instead, use gtk_main_do_event() so the event will behave as if
5934 * it were in the event queue. Don't synthesize expose events; instead,
5935 * use gdk_window_invalidate_rect() to invalidate a region of the
5938 * Return value: return from the event signal emission (%TRUE if
5939 * the event was handled)
5942 gtk_widget_event (GtkWidget *widget,
5945 g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
5946 g_return_val_if_fail (WIDGET_REALIZED_FOR_EVENT (widget, event), TRUE);
5948 if (event->type == GDK_EXPOSE)
5950 g_warning ("Events of type GDK_EXPOSE cannot be synthesized. To get "
5951 "the same effect, call gdk_window_invalidate_rect/region(), "
5952 "followed by gdk_window_process_updates().");
5956 return gtk_widget_event_internal (widget, event);
5960 _gtk_widget_set_captured_event_handler (GtkWidget *widget,
5961 GtkCapturedEventHandler callback)
5963 g_object_set_data (G_OBJECT (widget), "captured-event-handler", callback);
5967 _gtk_widget_captured_event (GtkWidget *widget,
5970 gboolean return_val = FALSE;
5971 GtkCapturedEventHandler handler;
5973 g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
5974 g_return_val_if_fail (WIDGET_REALIZED_FOR_EVENT (widget, event), TRUE);
5976 if (event->type == GDK_EXPOSE)
5978 g_warning ("Events of type GDK_EXPOSE cannot be synthesized. To get "
5979 "the same effect, call gdk_window_invalidate_rect/region(), "
5980 "followed by gdk_window_process_updates().");
5984 if (!event_window_is_still_viewable (event))
5987 handler = g_object_get_data (G_OBJECT (widget), "captured-event-handler");
5991 g_object_ref (widget);
5993 return_val = handler (widget, event);
5994 return_val |= !WIDGET_REALIZED_FOR_EVENT (widget, event);
5996 /* The widget that was originally to receive the event
5997 * handles motion hints, but the capturing widget might
5998 * not, so ensure we get further motion events.
6001 event->type == GDK_MOTION_NOTIFY &&
6002 event->motion.is_hint &&
6003 (gdk_window_get_events (event->any.window) &
6004 GDK_POINTER_MOTION_HINT_MASK) != 0)
6005 gdk_event_request_motions (&event->motion);
6007 g_object_unref (widget);
6012 /* Returns TRUE if a translation should be done */
6014 _gtk_widget_get_translation_to_window (GtkWidget *widget,
6019 GdkWindow *w, *widget_window;
6021 if (!gtk_widget_get_has_window (widget))
6023 *x = -widget->priv->allocation.x;
6024 *y = -widget->priv->allocation.y;
6032 widget_window = gtk_widget_get_window (widget);
6034 for (w = window; w && w != widget_window; w = gdk_window_get_parent (w))
6037 gdk_window_get_position (w, &wx, &wy);
6054 * gtk_cairo_transform_to_window:
6055 * @cr: the cairo context to transform
6056 * @widget: the widget the context is currently centered for
6057 * @window: the window to transform the context to
6059 * Transforms the given cairo context @cr that from @widget-relative
6060 * coordinates to @window-relative coordinates.
6061 * If the @widget's window is not an ancestor of @window, no
6062 * modification will be applied.
6064 * This is the inverse to the transformation GTK applies when
6065 * preparing an expose event to be emitted with the #GtkWidget::draw
6066 * signal. It is intended to help porting multiwindow widgets from
6067 * GTK+ 2 to the rendering architecture of GTK+ 3.
6072 gtk_cairo_transform_to_window (cairo_t *cr,
6078 g_return_if_fail (cr != NULL);
6079 g_return_if_fail (GTK_IS_WIDGET (widget));
6080 g_return_if_fail (GDK_IS_WINDOW (window));
6082 if (_gtk_widget_get_translation_to_window (widget, window, &x, &y))
6083 cairo_translate (cr, x, y);
6087 * gtk_widget_send_expose:
6088 * @widget: a #GtkWidget
6089 * @event: a expose #GdkEvent
6091 * Very rarely-used function. This function is used to emit
6092 * an expose event on a widget. This function is not normally used
6093 * directly. The only time it is used is when propagating an expose
6094 * event to a child %NO_WINDOW widget, and that is normally done
6095 * using gtk_container_propagate_draw().
6097 * If you want to force an area of a window to be redrawn,
6098 * use gdk_window_invalidate_rect() or gdk_window_invalidate_region().
6099 * To cause the redraw to be done immediately, follow that call
6100 * with a call to gdk_window_process_updates().
6102 * Return value: return from the event signal emission (%TRUE if
6103 * the event was handled)
6106 gtk_widget_send_expose (GtkWidget *widget,
6109 gboolean result = FALSE;
6114 g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
6115 g_return_val_if_fail (gtk_widget_get_realized (widget), TRUE);
6116 g_return_val_if_fail (event != NULL, TRUE);
6117 g_return_val_if_fail (event->type == GDK_EXPOSE, TRUE);
6119 cr = gdk_cairo_create (event->expose.window);
6120 gtk_cairo_set_event (cr, &event->expose);
6122 gdk_cairo_region (cr, event->expose.region);
6125 do_clip = _gtk_widget_get_translation_to_window (widget,
6126 event->expose.window,
6128 cairo_translate (cr, -x, -y);
6130 _gtk_widget_draw_internal (widget, cr, do_clip);
6132 /* unset here, so if someone keeps a reference to cr we
6133 * don't leak the window. */
6134 gtk_cairo_set_event (cr, NULL);
6141 event_window_is_still_viewable (GdkEvent *event)
6143 /* Check that we think the event's window is viewable before
6144 * delivering the event, to prevent suprises. We do this here
6145 * at the last moment, since the event may have been queued
6146 * up behind other events, held over a recursive main loop, etc.
6148 switch (event->type)
6151 case GDK_MOTION_NOTIFY:
6152 case GDK_BUTTON_PRESS:
6153 case GDK_2BUTTON_PRESS:
6154 case GDK_3BUTTON_PRESS:
6156 case GDK_ENTER_NOTIFY:
6157 case GDK_PROXIMITY_IN:
6159 return event->any.window && gdk_window_is_viewable (event->any.window);
6162 /* The following events are the second half of paired events;
6163 * we always deliver them to deal with widgets that clean up
6164 * on the second half.
6166 case GDK_BUTTON_RELEASE:
6167 case GDK_KEY_RELEASE:
6168 case GDK_LEAVE_NOTIFY:
6169 case GDK_PROXIMITY_OUT:
6173 /* Remaining events would make sense on an not-viewable window,
6174 * or don't have an associated window.
6181 gtk_widget_event_internal (GtkWidget *widget,
6184 gboolean return_val = FALSE;
6186 /* We check only once for is-still-visible; if someone
6187 * hides the window in on of the signals on the widget,
6188 * they are responsible for returning TRUE to terminate
6191 if (!event_window_is_still_viewable (event))
6194 g_object_ref (widget);
6196 g_signal_emit (widget, widget_signals[EVENT], 0, event, &return_val);
6197 return_val |= !WIDGET_REALIZED_FOR_EVENT (widget, event);
6202 switch (event->type)
6208 case GDK_BUTTON_PRESS:
6209 case GDK_2BUTTON_PRESS:
6210 case GDK_3BUTTON_PRESS:
6211 signal_num = BUTTON_PRESS_EVENT;
6213 case GDK_TOUCH_BEGIN:
6214 case GDK_TOUCH_UPDATE:
6216 case GDK_TOUCH_CANCEL:
6217 signal_num = TOUCH_EVENT;
6220 signal_num = SCROLL_EVENT;
6222 case GDK_BUTTON_RELEASE:
6223 signal_num = BUTTON_RELEASE_EVENT;
6225 case GDK_MOTION_NOTIFY:
6226 signal_num = MOTION_NOTIFY_EVENT;
6229 signal_num = DELETE_EVENT;
6232 signal_num = DESTROY_EVENT;
6233 _gtk_tooltip_hide (widget);
6236 signal_num = KEY_PRESS_EVENT;
6238 case GDK_KEY_RELEASE:
6239 signal_num = KEY_RELEASE_EVENT;
6241 case GDK_ENTER_NOTIFY:
6242 signal_num = ENTER_NOTIFY_EVENT;
6244 case GDK_LEAVE_NOTIFY:
6245 signal_num = LEAVE_NOTIFY_EVENT;
6247 case GDK_FOCUS_CHANGE:
6248 signal_num = event->focus_change.in ? FOCUS_IN_EVENT : FOCUS_OUT_EVENT;
6249 if (event->focus_change.in)
6250 _gtk_tooltip_focus_in (widget);
6252 _gtk_tooltip_focus_out (widget);
6255 signal_num = CONFIGURE_EVENT;
6258 signal_num = MAP_EVENT;
6261 signal_num = UNMAP_EVENT;
6263 case GDK_WINDOW_STATE:
6264 signal_num = WINDOW_STATE_EVENT;
6266 case GDK_PROPERTY_NOTIFY:
6267 signal_num = PROPERTY_NOTIFY_EVENT;
6269 case GDK_SELECTION_CLEAR:
6270 signal_num = SELECTION_CLEAR_EVENT;
6272 case GDK_SELECTION_REQUEST:
6273 signal_num = SELECTION_REQUEST_EVENT;
6275 case GDK_SELECTION_NOTIFY:
6276 signal_num = SELECTION_NOTIFY_EVENT;
6278 case GDK_PROXIMITY_IN:
6279 signal_num = PROXIMITY_IN_EVENT;
6281 case GDK_PROXIMITY_OUT:
6282 signal_num = PROXIMITY_OUT_EVENT;
6284 case GDK_VISIBILITY_NOTIFY:
6285 signal_num = VISIBILITY_NOTIFY_EVENT;
6287 case GDK_GRAB_BROKEN:
6288 signal_num = GRAB_BROKEN_EVENT;
6291 signal_num = DAMAGE_EVENT;
6294 g_warning ("gtk_widget_event(): unhandled event type: %d", event->type);
6298 if (signal_num != -1)
6299 g_signal_emit (widget, widget_signals[signal_num], 0, event, &return_val);
6301 if (WIDGET_REALIZED_FOR_EVENT (widget, event))
6302 g_signal_emit (widget, widget_signals[EVENT_AFTER], 0, event);
6306 g_object_unref (widget);
6312 * gtk_widget_activate:
6313 * @widget: a #GtkWidget that's activatable
6315 * For widgets that can be "activated" (buttons, menu items, etc.)
6316 * this function activates them. Activation is what happens when you
6317 * press Enter on a widget during key navigation. If @widget isn't
6318 * activatable, the function returns %FALSE.
6320 * Return value: %TRUE if the widget was activatable
6323 gtk_widget_activate (GtkWidget *widget)
6325 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6327 if (WIDGET_CLASS (widget)->activate_signal)
6329 /* FIXME: we should eventually check the signals signature here */
6330 g_signal_emit (widget, WIDGET_CLASS (widget)->activate_signal, 0);
6339 gtk_widget_reparent_subwindows (GtkWidget *widget,
6340 GdkWindow *new_window)
6342 GtkWidgetPrivate *priv = widget->priv;
6344 if (!gtk_widget_get_has_window (widget))
6346 GList *children = gdk_window_get_children (priv->window);
6349 for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
6351 GdkWindow *window = tmp_list->data;
6354 gdk_window_get_user_data (window, &child);
6355 while (child && child != widget)
6356 child = ((GtkWidget*) child)->priv->parent;
6359 gdk_window_reparent (window, new_window, 0, 0);
6362 g_list_free (children);
6367 GList *tmp_list, *children;
6369 parent = gdk_window_get_parent (priv->window);
6372 gdk_window_reparent (priv->window, new_window, 0, 0);
6375 children = gdk_window_get_children (parent);
6377 for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
6379 GdkWindow *window = tmp_list->data;
6382 gdk_window_get_user_data (window, &child);
6384 if (child == widget)
6385 gdk_window_reparent (window, new_window, 0, 0);
6388 g_list_free (children);
6394 gtk_widget_reparent_fixup_child (GtkWidget *widget,
6395 gpointer client_data)
6397 GtkWidgetPrivate *priv = widget->priv;
6399 g_assert (client_data != NULL);
6401 if (!gtk_widget_get_has_window (widget))
6404 g_object_unref (priv->window);
6405 priv->window = (GdkWindow*) client_data;
6407 g_object_ref (priv->window);
6409 if (GTK_IS_CONTAINER (widget))
6410 gtk_container_forall (GTK_CONTAINER (widget),
6411 gtk_widget_reparent_fixup_child,
6417 * gtk_widget_reparent:
6418 * @widget: a #GtkWidget
6419 * @new_parent: a #GtkContainer to move the widget into
6421 * Moves a widget from one #GtkContainer to another, handling reference
6422 * count issues to avoid destroying the widget.
6425 gtk_widget_reparent (GtkWidget *widget,
6426 GtkWidget *new_parent)
6428 GtkWidgetPrivate *priv;
6430 g_return_if_fail (GTK_IS_WIDGET (widget));
6431 g_return_if_fail (GTK_IS_CONTAINER (new_parent));
6432 priv = widget->priv;
6433 g_return_if_fail (priv->parent != NULL);
6435 if (priv->parent != new_parent)
6437 /* First try to see if we can get away without unrealizing
6438 * the widget as we reparent it. if so we set a flag so
6439 * that gtk_widget_unparent doesn't unrealize widget
6441 if (gtk_widget_get_realized (widget) && gtk_widget_get_realized (new_parent))
6442 priv->in_reparent = TRUE;
6444 g_object_ref (widget);
6445 gtk_container_remove (GTK_CONTAINER (priv->parent), widget);
6446 gtk_container_add (GTK_CONTAINER (new_parent), widget);
6447 g_object_unref (widget);
6449 if (priv->in_reparent)
6451 priv->in_reparent = FALSE;
6453 gtk_widget_reparent_subwindows (widget, gtk_widget_get_parent_window (widget));
6454 gtk_widget_reparent_fixup_child (widget,
6455 gtk_widget_get_parent_window (widget));
6458 g_object_notify (G_OBJECT (widget), "parent");
6463 * gtk_widget_intersect:
6464 * @widget: a #GtkWidget
6465 * @area: a rectangle
6466 * @intersection: rectangle to store intersection of @widget and @area
6468 * Computes the intersection of a @widget's area and @area, storing
6469 * the intersection in @intersection, and returns %TRUE if there was
6470 * an intersection. @intersection may be %NULL if you're only
6471 * interested in whether there was an intersection.
6473 * Return value: %TRUE if there was an intersection
6476 gtk_widget_intersect (GtkWidget *widget,
6477 const GdkRectangle *area,
6478 GdkRectangle *intersection)
6480 GtkWidgetPrivate *priv;
6485 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6486 g_return_val_if_fail (area != NULL, FALSE);
6488 priv = widget->priv;
6491 dest = intersection;
6495 return_val = gdk_rectangle_intersect (&priv->allocation, area, dest);
6497 if (return_val && intersection && gtk_widget_get_has_window (widget))
6499 intersection->x -= priv->allocation.x;
6500 intersection->y -= priv->allocation.y;
6507 * gtk_widget_region_intersect:
6508 * @widget: a #GtkWidget
6509 * @region: a #cairo_region_t, in the same coordinate system as
6510 * @widget->allocation. That is, relative to @widget->window
6511 * for %NO_WINDOW widgets; relative to the parent window
6512 * of @widget->window for widgets with their own window.
6514 * Computes the intersection of a @widget's area and @region, returning
6515 * the intersection. The result may be empty, use cairo_region_is_empty() to
6518 * Returns: A newly allocated region holding the intersection of @widget
6519 * and @region. The coordinates of the return value are relative to
6520 * @widget->window for %NO_WINDOW widgets, and relative to the parent
6521 * window of @widget->window for widgets with their own window.
6524 gtk_widget_region_intersect (GtkWidget *widget,
6525 const cairo_region_t *region)
6528 cairo_region_t *dest;
6530 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6531 g_return_val_if_fail (region != NULL, NULL);
6533 gtk_widget_get_allocation (widget, &rect);
6535 dest = cairo_region_create_rectangle (&rect);
6537 cairo_region_intersect (dest, region);
6543 * _gtk_widget_grab_notify:
6544 * @widget: a #GtkWidget
6545 * @was_grabbed: whether a grab is now in effect
6547 * Emits the #GtkWidget::grab-notify signal on @widget.
6552 _gtk_widget_grab_notify (GtkWidget *widget,
6553 gboolean was_grabbed)
6555 g_signal_emit (widget, widget_signals[GRAB_NOTIFY], 0, was_grabbed);
6559 * gtk_widget_grab_focus:
6560 * @widget: a #GtkWidget
6562 * Causes @widget to have the keyboard focus for the #GtkWindow it's
6563 * inside. @widget must be a focusable widget, such as a #GtkEntry;
6564 * something like #GtkFrame won't work.
6566 * More precisely, it must have the %GTK_CAN_FOCUS flag set. Use
6567 * gtk_widget_set_can_focus() to modify that flag.
6569 * The widget also needs to be realized and mapped. This is indicated by the
6570 * related signals. Grabbing the focus immediately after creating the widget
6571 * will likely fail and cause critical warnings.
6574 gtk_widget_grab_focus (GtkWidget *widget)
6576 g_return_if_fail (GTK_IS_WIDGET (widget));
6578 if (!gtk_widget_is_sensitive (widget))
6581 g_object_ref (widget);
6582 g_signal_emit (widget, widget_signals[GRAB_FOCUS], 0);
6583 g_object_notify (G_OBJECT (widget), "has-focus");
6584 g_object_unref (widget);
6588 reset_focus_recurse (GtkWidget *widget,
6591 if (GTK_IS_CONTAINER (widget))
6593 GtkContainer *container;
6595 container = GTK_CONTAINER (widget);
6596 gtk_container_set_focus_child (container, NULL);
6598 gtk_container_foreach (container,
6599 reset_focus_recurse,
6605 gtk_widget_real_grab_focus (GtkWidget *focus_widget)
6607 if (gtk_widget_get_can_focus (focus_widget))
6609 GtkWidget *toplevel;
6612 /* clear the current focus setting, break if the current widget
6613 * is the focus widget's parent, since containers above that will
6614 * be set by the next loop.
6616 toplevel = gtk_widget_get_toplevel (focus_widget);
6617 if (gtk_widget_is_toplevel (toplevel) && GTK_IS_WINDOW (toplevel))
6619 widget = gtk_window_get_focus (GTK_WINDOW (toplevel));
6621 if (widget == focus_widget)
6623 /* We call _gtk_window_internal_set_focus() here so that the
6624 * toplevel window can request the focus if necessary.
6625 * This is needed when the toplevel is a GtkPlug
6627 if (!gtk_widget_has_focus (widget))
6628 _gtk_window_internal_set_focus (GTK_WINDOW (toplevel), focus_widget);
6635 GtkWidget *common_ancestor = gtk_widget_common_ancestor (widget, focus_widget);
6637 if (widget != common_ancestor)
6639 while (widget->priv->parent && widget->priv->parent != common_ancestor)
6641 widget = widget->priv->parent;
6642 gtk_container_set_focus_child (GTK_CONTAINER (widget), NULL);
6647 else if (toplevel != focus_widget)
6649 /* gtk_widget_grab_focus() operates on a tree without window...
6650 * actually, this is very questionable behaviour.
6653 gtk_container_foreach (GTK_CONTAINER (toplevel),
6654 reset_focus_recurse,
6658 /* now propagate the new focus up the widget tree and finally
6659 * set it on the window
6661 widget = focus_widget;
6662 while (widget->priv->parent)
6664 gtk_container_set_focus_child (GTK_CONTAINER (widget->priv->parent), widget);
6665 widget = widget->priv->parent;
6667 if (GTK_IS_WINDOW (widget))
6668 _gtk_window_internal_set_focus (GTK_WINDOW (widget), focus_widget);
6673 gtk_widget_real_query_tooltip (GtkWidget *widget,
6676 gboolean keyboard_tip,
6677 GtkTooltip *tooltip)
6679 gchar *tooltip_markup;
6680 gboolean has_tooltip;
6682 tooltip_markup = g_object_get_qdata (G_OBJECT (widget), quark_tooltip_markup);
6683 has_tooltip = GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (widget), quark_has_tooltip));
6685 if (has_tooltip && tooltip_markup)
6687 gtk_tooltip_set_markup (tooltip, tooltip_markup);
6695 gtk_widget_real_state_flags_changed (GtkWidget *widget,
6696 GtkStateFlags old_state)
6698 gtk_widget_update_pango_context (widget);
6702 gtk_widget_real_style_updated (GtkWidget *widget)
6704 GtkWidgetPrivate *priv = widget->priv;
6706 gtk_widget_update_pango_context (widget);
6708 if (priv->style != NULL &&
6709 priv->style != gtk_widget_get_default_style ())
6711 /* Trigger ::style-set for old
6712 * widgets not listening to this
6714 g_signal_emit (widget,
6715 widget_signals[STYLE_SET],
6717 widget->priv->style);
6720 if (widget->priv->context)
6722 const GtkBitmask *changes = _gtk_style_context_get_changes (widget->priv->context);
6724 if (gtk_widget_get_realized (widget) &&
6725 gtk_widget_get_has_window (widget) &&
6726 !gtk_widget_get_app_paintable (widget))
6727 gtk_style_context_set_background (widget->priv->context,
6728 widget->priv->window);
6730 if (widget->priv->anchored)
6732 if (changes && _gtk_css_style_property_changes_affect_size (changes))
6733 gtk_widget_queue_resize (widget);
6735 gtk_widget_queue_draw (widget);
6740 if (widget->priv->anchored)
6741 gtk_widget_queue_resize (widget);
6746 gtk_widget_real_show_help (GtkWidget *widget,
6747 GtkWidgetHelpType help_type)
6749 if (help_type == GTK_WIDGET_HELP_TOOLTIP)
6751 _gtk_tooltip_toggle_keyboard_mode (widget);
6760 gtk_widget_real_focus (GtkWidget *widget,
6761 GtkDirectionType direction)
6763 if (!gtk_widget_get_can_focus (widget))
6766 if (!gtk_widget_is_focus (widget))
6768 gtk_widget_grab_focus (widget);
6776 gtk_widget_real_move_focus (GtkWidget *widget,
6777 GtkDirectionType direction)
6779 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
6781 if (widget != toplevel && GTK_IS_WINDOW (toplevel))
6783 g_signal_emit (toplevel, widget_signals[MOVE_FOCUS], 0,
6789 gtk_widget_real_keynav_failed (GtkWidget *widget,
6790 GtkDirectionType direction)
6792 gboolean cursor_only;
6796 case GTK_DIR_TAB_FORWARD:
6797 case GTK_DIR_TAB_BACKWARD:
6804 g_object_get (gtk_widget_get_settings (widget),
6805 "gtk-keynav-cursor-only", &cursor_only,
6812 gtk_widget_error_bell (widget);
6818 * gtk_widget_set_can_focus:
6819 * @widget: a #GtkWidget
6820 * @can_focus: whether or not @widget can own the input focus.
6822 * Specifies whether @widget can own the input focus. See
6823 * gtk_widget_grab_focus() for actually setting the input focus on a
6829 gtk_widget_set_can_focus (GtkWidget *widget,
6832 g_return_if_fail (GTK_IS_WIDGET (widget));
6834 if (widget->priv->can_focus != can_focus)
6836 widget->priv->can_focus = can_focus;
6838 gtk_widget_queue_resize (widget);
6839 g_object_notify (G_OBJECT (widget), "can-focus");
6844 * gtk_widget_get_can_focus:
6845 * @widget: a #GtkWidget
6847 * Determines whether @widget can own the input focus. See
6848 * gtk_widget_set_can_focus().
6850 * Return value: %TRUE if @widget can own the input focus, %FALSE otherwise
6855 gtk_widget_get_can_focus (GtkWidget *widget)
6857 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6859 return widget->priv->can_focus;
6863 * gtk_widget_has_focus:
6864 * @widget: a #GtkWidget
6866 * Determines if the widget has the global input focus. See
6867 * gtk_widget_is_focus() for the difference between having the global
6868 * input focus, and only having the focus within a toplevel.
6870 * Return value: %TRUE if the widget has the global input focus.
6875 gtk_widget_has_focus (GtkWidget *widget)
6877 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6879 return widget->priv->has_focus;
6883 * gtk_widget_has_visible_focus:
6884 * @widget: a #GtkWidget
6886 * Determines if the widget should show a visible indication that
6887 * it has the global input focus. This is a convenience function for
6888 * use in ::draw handlers that takes into account whether focus
6889 * indication should currently be shown in the toplevel window of
6890 * @widget. See gtk_window_get_focus_visible() for more information
6891 * about focus indication.
6893 * To find out if the widget has the global input focus, use
6894 * gtk_widget_has_focus().
6896 * Return value: %TRUE if the widget should display a 'focus rectangle'
6901 gtk_widget_has_visible_focus (GtkWidget *widget)
6903 gboolean draw_focus;
6905 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6907 if (widget->priv->has_focus)
6909 GtkWidget *toplevel;
6911 toplevel = gtk_widget_get_toplevel (widget);
6913 if (GTK_IS_WINDOW (toplevel))
6914 draw_focus = gtk_window_get_focus_visible (GTK_WINDOW (toplevel));
6925 * gtk_widget_is_focus:
6926 * @widget: a #GtkWidget
6928 * Determines if the widget is the focus widget within its
6929 * toplevel. (This does not mean that the %HAS_FOCUS flag is
6930 * necessarily set; %HAS_FOCUS will only be set if the
6931 * toplevel widget additionally has the global input focus.)
6933 * Return value: %TRUE if the widget is the focus widget.
6936 gtk_widget_is_focus (GtkWidget *widget)
6938 GtkWidget *toplevel;
6940 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6942 toplevel = gtk_widget_get_toplevel (widget);
6944 if (GTK_IS_WINDOW (toplevel))
6945 return widget == gtk_window_get_focus (GTK_WINDOW (toplevel));
6951 * gtk_widget_set_can_default:
6952 * @widget: a #GtkWidget
6953 * @can_default: whether or not @widget can be a default widget.
6955 * Specifies whether @widget can be a default widget. See
6956 * gtk_widget_grab_default() for details about the meaning of
6962 gtk_widget_set_can_default (GtkWidget *widget,
6963 gboolean can_default)
6965 g_return_if_fail (GTK_IS_WIDGET (widget));
6967 if (widget->priv->can_default != can_default)
6969 widget->priv->can_default = can_default;
6971 gtk_widget_queue_resize (widget);
6972 g_object_notify (G_OBJECT (widget), "can-default");
6977 * gtk_widget_get_can_default:
6978 * @widget: a #GtkWidget
6980 * Determines whether @widget can be a default widget. See
6981 * gtk_widget_set_can_default().
6983 * Return value: %TRUE if @widget can be a default widget, %FALSE otherwise
6988 gtk_widget_get_can_default (GtkWidget *widget)
6990 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6992 return widget->priv->can_default;
6996 * gtk_widget_has_default:
6997 * @widget: a #GtkWidget
6999 * Determines whether @widget is the current default widget within its
7000 * toplevel. See gtk_widget_set_can_default().
7002 * Return value: %TRUE if @widget is the current default widget within
7003 * its toplevel, %FALSE otherwise
7008 gtk_widget_has_default (GtkWidget *widget)
7010 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7012 return widget->priv->has_default;
7016 _gtk_widget_set_has_default (GtkWidget *widget,
7017 gboolean has_default)
7019 GtkStyleContext *context;
7021 widget->priv->has_default = has_default;
7023 context = gtk_widget_get_style_context (widget);
7026 gtk_style_context_add_class (context, GTK_STYLE_CLASS_DEFAULT);
7028 gtk_style_context_remove_class (context, GTK_STYLE_CLASS_DEFAULT);
7032 * gtk_widget_grab_default:
7033 * @widget: a #GtkWidget
7035 * Causes @widget to become the default widget. @widget must be able to be
7036 * a default widget; typically you would ensure this yourself
7037 * by calling gtk_widget_set_can_default() with a %TRUE value.
7038 * The default widget is activated when
7039 * the user presses Enter in a window. Default widgets must be
7040 * activatable, that is, gtk_widget_activate() should affect them. Note
7041 * that #GtkEntry widgets require the "activates-default" property
7042 * set to %TRUE before they activate the default widget when Enter
7043 * is pressed and the #GtkEntry is focused.
7046 gtk_widget_grab_default (GtkWidget *widget)
7050 g_return_if_fail (GTK_IS_WIDGET (widget));
7051 g_return_if_fail (gtk_widget_get_can_default (widget));
7053 window = gtk_widget_get_toplevel (widget);
7055 if (window && gtk_widget_is_toplevel (window))
7056 gtk_window_set_default (GTK_WINDOW (window), widget);
7058 g_warning (G_STRLOC ": widget not within a GtkWindow");
7062 * gtk_widget_set_receives_default:
7063 * @widget: a #GtkWidget
7064 * @receives_default: whether or not @widget can be a default widget.
7066 * Specifies whether @widget will be treated as the default widget
7067 * within its toplevel when it has the focus, even if another widget
7070 * See gtk_widget_grab_default() for details about the meaning of
7076 gtk_widget_set_receives_default (GtkWidget *widget,
7077 gboolean receives_default)
7079 g_return_if_fail (GTK_IS_WIDGET (widget));
7081 if (widget->priv->receives_default != receives_default)
7083 widget->priv->receives_default = receives_default;
7085 g_object_notify (G_OBJECT (widget), "receives-default");
7090 * gtk_widget_get_receives_default:
7091 * @widget: a #GtkWidget
7093 * Determines whether @widget is alyways treated as default widget
7094 * withing its toplevel when it has the focus, even if another widget
7097 * See gtk_widget_set_receives_default().
7099 * Return value: %TRUE if @widget acts as default widget when focussed,
7105 gtk_widget_get_receives_default (GtkWidget *widget)
7107 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7109 return widget->priv->receives_default;
7113 * gtk_widget_has_grab:
7114 * @widget: a #GtkWidget
7116 * Determines whether the widget is currently grabbing events, so it
7117 * is the only widget receiving input events (keyboard and mouse).
7119 * See also gtk_grab_add().
7121 * Return value: %TRUE if the widget is in the grab_widgets stack
7126 gtk_widget_has_grab (GtkWidget *widget)
7128 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7130 return widget->priv->has_grab;
7134 _gtk_widget_set_has_grab (GtkWidget *widget,
7137 widget->priv->has_grab = has_grab;
7141 * gtk_widget_device_is_shadowed:
7142 * @widget: a #GtkWidget
7143 * @device: a #GdkDevice
7145 * Returns %TRUE if @device has been shadowed by a GTK+
7146 * device grab on another widget, so it would stop sending
7147 * events to @widget. This may be used in the
7148 * #GtkWidget::grab-notify signal to check for specific
7149 * devices. See gtk_device_grab_add().
7151 * Returns: %TRUE if there is an ongoing grab on @device
7152 * by another #GtkWidget than @widget.
7157 gtk_widget_device_is_shadowed (GtkWidget *widget,
7160 GtkWindowGroup *group;
7161 GtkWidget *grab_widget, *toplevel;
7163 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7164 g_return_val_if_fail (GDK_IS_DEVICE (device), FALSE);
7166 if (!gtk_widget_get_realized (widget))
7169 toplevel = gtk_widget_get_toplevel (widget);
7171 if (GTK_IS_WINDOW (toplevel))
7172 group = gtk_window_get_group (GTK_WINDOW (toplevel));
7174 group = gtk_window_get_group (NULL);
7176 grab_widget = gtk_window_group_get_current_device_grab (group, device);
7178 /* Widget not inside the hierarchy of grab_widget */
7180 widget != grab_widget &&
7181 !gtk_widget_is_ancestor (widget, grab_widget))
7184 grab_widget = gtk_window_group_get_current_grab (group);
7185 if (grab_widget && widget != grab_widget &&
7186 !gtk_widget_is_ancestor (widget, grab_widget))
7193 * gtk_widget_set_name:
7194 * @widget: a #GtkWidget
7195 * @name: name for the widget
7197 * Widgets can be named, which allows you to refer to them from a
7198 * CSS file. You can apply a style to widgets with a particular name
7199 * in the CSS file. See the documentation for the CSS syntax (on the
7200 * same page as the docs for #GtkStyleContext).
7202 * Note that the CSS syntax has certain special characters to delimit
7203 * and represent elements in a selector (period, #, >, *...),
7204 * so using these will make your widget impossible to match by name.
7205 * Any combination of alphanumeric symbols, dashes and underscores will
7209 gtk_widget_set_name (GtkWidget *widget,
7212 GtkWidgetPrivate *priv;
7215 g_return_if_fail (GTK_IS_WIDGET (widget));
7217 priv = widget->priv;
7219 new_name = g_strdup (name);
7220 g_free (priv->name);
7221 priv->name = new_name;
7223 _gtk_widget_invalidate_style_context (widget, GTK_CSS_CHANGE_NAME);
7225 g_object_notify (G_OBJECT (widget), "name");
7229 * gtk_widget_get_name:
7230 * @widget: a #GtkWidget
7232 * Retrieves the name of a widget. See gtk_widget_set_name() for the
7233 * significance of widget names.
7235 * Return value: name of the widget. This string is owned by GTK+ and
7236 * should not be modified or freed
7239 gtk_widget_get_name (GtkWidget *widget)
7241 GtkWidgetPrivate *priv;
7243 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7245 priv = widget->priv;
7249 return G_OBJECT_TYPE_NAME (widget);
7253 _gtk_widget_update_state_flags (GtkWidget *widget,
7254 GtkStateFlags flags,
7257 GtkWidgetPrivate *priv;
7259 priv = widget->priv;
7261 /* Handle insensitive first, since it is propagated
7262 * differently throughout the widget hierarchy.
7264 if ((priv->state_flags & GTK_STATE_FLAG_INSENSITIVE) && (flags & GTK_STATE_FLAG_INSENSITIVE) && (operation == STATE_CHANGE_UNSET))
7265 gtk_widget_set_sensitive (widget, TRUE);
7266 else if (!(priv->state_flags & GTK_STATE_FLAG_INSENSITIVE) && (flags & GTK_STATE_FLAG_INSENSITIVE) && (operation != STATE_CHANGE_UNSET))
7267 gtk_widget_set_sensitive (widget, FALSE);
7268 else if ((priv->state_flags & GTK_STATE_FLAG_INSENSITIVE) && !(flags & GTK_STATE_FLAG_INSENSITIVE) && (operation == STATE_CHANGE_REPLACE))
7269 gtk_widget_set_sensitive (widget, TRUE);
7271 if (operation != STATE_CHANGE_REPLACE)
7272 flags &= ~(GTK_STATE_FLAG_INSENSITIVE);
7275 operation == STATE_CHANGE_REPLACE)
7280 data.operation = operation;
7282 gtk_widget_propagate_state (widget, &data);
7287 * gtk_widget_set_state_flags:
7288 * @widget: a #GtkWidget
7289 * @flags: State flags to turn on
7290 * @clear: Whether to clear state before turning on @flags
7292 * This function is for use in widget implementations. Turns on flag
7293 * values in the current widget state (insensitive, prelighted, etc.).
7295 * It is worth mentioning that any other state than %GTK_STATE_FLAG_INSENSITIVE,
7296 * will be propagated down to all non-internal children if @widget is a
7297 * #GtkContainer, while %GTK_STATE_FLAG_INSENSITIVE itself will be propagated
7298 * down to all #GtkContainer children by different means than turning on the
7299 * state flag down the hierarchy, both gtk_widget_get_state_flags() and
7300 * gtk_widget_is_sensitive() will make use of these.
7305 gtk_widget_set_state_flags (GtkWidget *widget,
7306 GtkStateFlags flags,
7309 g_return_if_fail (GTK_IS_WIDGET (widget));
7311 if ((!clear && (widget->priv->state_flags & flags) == flags) ||
7312 (clear && widget->priv->state_flags == flags))
7316 _gtk_widget_update_state_flags (widget, flags, STATE_CHANGE_REPLACE);
7318 _gtk_widget_update_state_flags (widget, flags, STATE_CHANGE_SET);
7322 * gtk_widget_unset_state_flags:
7323 * @widget: a #GtkWidget
7324 * @flags: State flags to turn off
7326 * This function is for use in widget implementations. Turns off flag
7327 * values for the current widget state (insensitive, prelighted, etc.).
7328 * See gtk_widget_set_state_flags().
7333 gtk_widget_unset_state_flags (GtkWidget *widget,
7334 GtkStateFlags flags)
7336 g_return_if_fail (GTK_IS_WIDGET (widget));
7338 if ((widget->priv->state_flags & flags) == 0)
7341 _gtk_widget_update_state_flags (widget, flags, STATE_CHANGE_UNSET);
7345 * gtk_widget_get_state_flags:
7346 * @widget: a #GtkWidget
7348 * Returns the widget state as a flag set. It is worth mentioning
7349 * that the effective %GTK_STATE_FLAG_INSENSITIVE state will be
7350 * returned, that is, also based on parent insensitivity, even if
7351 * @widget itself is sensitive.
7353 * Returns: The state flags for widget
7358 gtk_widget_get_state_flags (GtkWidget *widget)
7360 GtkStateFlags flags;
7362 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
7364 flags = widget->priv->state_flags;
7366 if (gtk_widget_has_focus (widget))
7367 flags |= GTK_STATE_FLAG_FOCUSED;
7373 * gtk_widget_set_state:
7374 * @widget: a #GtkWidget
7375 * @state: new state for @widget
7377 * This function is for use in widget implementations. Sets the state
7378 * of a widget (insensitive, prelighted, etc.) Usually you should set
7379 * the state using wrapper functions such as gtk_widget_set_sensitive().
7381 * Deprecated: 3.0. Use gtk_widget_set_state_flags() instead.
7384 gtk_widget_set_state (GtkWidget *widget,
7387 GtkStateFlags flags;
7389 if (state == gtk_widget_get_state (widget))
7394 case GTK_STATE_ACTIVE:
7395 flags = GTK_STATE_FLAG_ACTIVE;
7397 case GTK_STATE_PRELIGHT:
7398 flags = GTK_STATE_FLAG_PRELIGHT;
7400 case GTK_STATE_SELECTED:
7401 flags = GTK_STATE_FLAG_SELECTED;
7403 case GTK_STATE_INSENSITIVE:
7404 flags = GTK_STATE_FLAG_INSENSITIVE;
7406 case GTK_STATE_INCONSISTENT:
7407 flags = GTK_STATE_FLAG_INCONSISTENT;
7409 case GTK_STATE_FOCUSED:
7410 flags = GTK_STATE_FLAG_FOCUSED;
7412 case GTK_STATE_NORMAL:
7418 _gtk_widget_update_state_flags (widget, flags, STATE_CHANGE_REPLACE);
7422 * gtk_widget_get_state:
7423 * @widget: a #GtkWidget
7425 * Returns the widget's state. See gtk_widget_set_state().
7427 * Returns: the state of @widget.
7431 * Deprecated: 3.0. Use gtk_widget_get_state_flags() instead.
7434 gtk_widget_get_state (GtkWidget *widget)
7436 GtkStateFlags flags;
7438 g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_STATE_NORMAL);
7440 flags = gtk_widget_get_state_flags (widget);
7442 if (flags & GTK_STATE_FLAG_INSENSITIVE)
7443 return GTK_STATE_INSENSITIVE;
7444 else if (flags & GTK_STATE_FLAG_ACTIVE)
7445 return GTK_STATE_ACTIVE;
7446 else if (flags & GTK_STATE_FLAG_SELECTED)
7447 return GTK_STATE_SELECTED;
7448 else if (flags & GTK_STATE_FLAG_PRELIGHT)
7449 return GTK_STATE_PRELIGHT;
7451 return GTK_STATE_NORMAL;
7455 * gtk_widget_set_visible:
7456 * @widget: a #GtkWidget
7457 * @visible: whether the widget should be shown or not
7459 * Sets the visibility state of @widget. Note that setting this to
7460 * %TRUE doesn't mean the widget is actually viewable, see
7461 * gtk_widget_get_visible().
7463 * This function simply calls gtk_widget_show() or gtk_widget_hide()
7464 * but is nicer to use when the visibility of the widget depends on
7470 gtk_widget_set_visible (GtkWidget *widget,
7473 g_return_if_fail (GTK_IS_WIDGET (widget));
7475 if (visible != gtk_widget_get_visible (widget))
7478 gtk_widget_show (widget);
7480 gtk_widget_hide (widget);
7485 _gtk_widget_set_visible_flag (GtkWidget *widget,
7488 widget->priv->visible = visible;
7492 * gtk_widget_get_visible:
7493 * @widget: a #GtkWidget
7495 * Determines whether the widget is visible. If you want to
7496 * take into account whether the widget's parent is also marked as
7497 * visible, use gtk_widget_is_visible() instead.
7499 * This function does not check if the widget is obscured in any way.
7501 * See gtk_widget_set_visible().
7503 * Return value: %TRUE if the widget is visible
7508 gtk_widget_get_visible (GtkWidget *widget)
7510 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7512 return widget->priv->visible;
7516 * gtk_widget_is_visible:
7517 * @widget: a #GtkWidget
7519 * Determines whether the widget and all its parents are marked as
7522 * This function does not check if the widget is obscured in any way.
7524 * See also gtk_widget_get_visible() and gtk_widget_set_visible()
7526 * Return value: %TRUE if the widget and all its parents are visible
7531 gtk_widget_is_visible (GtkWidget *widget)
7533 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7537 GtkWidgetPrivate *priv = widget->priv;
7542 widget = priv->parent;
7549 * gtk_widget_set_has_window:
7550 * @widget: a #GtkWidget
7551 * @has_window: whether or not @widget has a window.
7553 * Specifies whether @widget has a #GdkWindow of its own. Note that
7554 * all realized widgets have a non-%NULL "window" pointer
7555 * (gtk_widget_get_window() never returns a %NULL window when a widget
7556 * is realized), but for many of them it's actually the #GdkWindow of
7557 * one of its parent widgets. Widgets that do not create a %window for
7558 * themselves in #GtkWidget::realize must announce this by
7559 * calling this function with @has_window = %FALSE.
7561 * This function should only be called by widget implementations,
7562 * and they should call it in their init() function.
7567 gtk_widget_set_has_window (GtkWidget *widget,
7568 gboolean has_window)
7570 g_return_if_fail (GTK_IS_WIDGET (widget));
7572 widget->priv->no_window = !has_window;
7576 * gtk_widget_get_has_window:
7577 * @widget: a #GtkWidget
7579 * Determines whether @widget has a #GdkWindow of its own. See
7580 * gtk_widget_set_has_window().
7582 * Return value: %TRUE if @widget has a window, %FALSE otherwise
7587 gtk_widget_get_has_window (GtkWidget *widget)
7589 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7591 return ! widget->priv->no_window;
7595 * gtk_widget_is_toplevel:
7596 * @widget: a #GtkWidget
7598 * Determines whether @widget is a toplevel widget.
7600 * Currently only #GtkWindow and #GtkInvisible (and out-of-process
7601 * #GtkPlugs) are toplevel widgets. Toplevel widgets have no parent
7604 * Return value: %TRUE if @widget is a toplevel, %FALSE otherwise
7609 gtk_widget_is_toplevel (GtkWidget *widget)
7611 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7613 return widget->priv->toplevel;
7617 _gtk_widget_set_is_toplevel (GtkWidget *widget,
7618 gboolean is_toplevel)
7620 widget->priv->toplevel = is_toplevel;
7624 * gtk_widget_is_drawable:
7625 * @widget: a #GtkWidget
7627 * Determines whether @widget can be drawn to. A widget can be drawn
7628 * to if it is mapped and visible.
7630 * Return value: %TRUE if @widget is drawable, %FALSE otherwise
7635 gtk_widget_is_drawable (GtkWidget *widget)
7637 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7639 return (gtk_widget_get_visible (widget) &&
7640 gtk_widget_get_mapped (widget));
7644 * gtk_widget_get_realized:
7645 * @widget: a #GtkWidget
7647 * Determines whether @widget is realized.
7649 * Return value: %TRUE if @widget is realized, %FALSE otherwise
7654 gtk_widget_get_realized (GtkWidget *widget)
7656 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7658 return widget->priv->realized;
7662 * gtk_widget_set_realized:
7663 * @widget: a #GtkWidget
7664 * @realized: %TRUE to mark the widget as realized
7666 * Marks the widget as being realized.
7668 * This function should only ever be called in a derived widget's
7669 * "realize" or "unrealize" implementation.
7674 gtk_widget_set_realized (GtkWidget *widget,
7677 g_return_if_fail (GTK_IS_WIDGET (widget));
7679 widget->priv->realized = realized;
7683 * gtk_widget_get_mapped:
7684 * @widget: a #GtkWidget
7686 * Whether the widget is mapped.
7688 * Return value: %TRUE if the widget is mapped, %FALSE otherwise.
7693 gtk_widget_get_mapped (GtkWidget *widget)
7695 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7697 return widget->priv->mapped;
7701 * gtk_widget_set_mapped:
7702 * @widget: a #GtkWidget
7703 * @mapped: %TRUE to mark the widget as mapped
7705 * Marks the widget as being realized.
7707 * This function should only ever be called in a derived widget's
7708 * "map" or "unmap" implementation.
7713 gtk_widget_set_mapped (GtkWidget *widget,
7716 g_return_if_fail (GTK_IS_WIDGET (widget));
7718 widget->priv->mapped = mapped;
7722 * gtk_widget_set_app_paintable:
7723 * @widget: a #GtkWidget
7724 * @app_paintable: %TRUE if the application will paint on the widget
7726 * Sets whether the application intends to draw on the widget in
7727 * an #GtkWidget::draw handler.
7729 * This is a hint to the widget and does not affect the behavior of
7730 * the GTK+ core; many widgets ignore this flag entirely. For widgets
7731 * that do pay attention to the flag, such as #GtkEventBox and #GtkWindow,
7732 * the effect is to suppress default themed drawing of the widget's
7733 * background. (Children of the widget will still be drawn.) The application
7734 * is then entirely responsible for drawing the widget background.
7736 * Note that the background is still drawn when the widget is mapped.
7739 gtk_widget_set_app_paintable (GtkWidget *widget,
7740 gboolean app_paintable)
7742 g_return_if_fail (GTK_IS_WIDGET (widget));
7744 app_paintable = (app_paintable != FALSE);
7746 if (widget->priv->app_paintable != app_paintable)
7748 widget->priv->app_paintable = app_paintable;
7750 if (gtk_widget_is_drawable (widget))
7751 gtk_widget_queue_draw (widget);
7753 g_object_notify (G_OBJECT (widget), "app-paintable");
7758 * gtk_widget_get_app_paintable:
7759 * @widget: a #GtkWidget
7761 * Determines whether the application intends to draw on the widget in
7762 * an #GtkWidget::draw handler.
7764 * See gtk_widget_set_app_paintable()
7766 * Return value: %TRUE if the widget is app paintable
7771 gtk_widget_get_app_paintable (GtkWidget *widget)
7773 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7775 return widget->priv->app_paintable;
7779 * gtk_widget_set_double_buffered:
7780 * @widget: a #GtkWidget
7781 * @double_buffered: %TRUE to double-buffer a widget
7783 * Widgets are double buffered by default; you can use this function
7784 * to turn off the buffering. "Double buffered" simply means that
7785 * gdk_window_begin_paint_region() and gdk_window_end_paint() are called
7786 * automatically around expose events sent to the
7787 * widget. gdk_window_begin_paint_region() diverts all drawing to a widget's
7788 * window to an offscreen buffer, and gdk_window_end_paint() draws the
7789 * buffer to the screen. The result is that users see the window
7790 * update in one smooth step, and don't see individual graphics
7791 * primitives being rendered.
7793 * In very simple terms, double buffered widgets don't flicker,
7794 * so you would only use this function to turn off double buffering
7795 * if you had special needs and really knew what you were doing.
7797 * Note: if you turn off double-buffering, you have to handle
7798 * expose events, since even the clearing to the background color or
7799 * pixmap will not happen automatically (as it is done in
7800 * gdk_window_begin_paint_region()).
7803 gtk_widget_set_double_buffered (GtkWidget *widget,
7804 gboolean double_buffered)
7806 g_return_if_fail (GTK_IS_WIDGET (widget));
7808 double_buffered = (double_buffered != FALSE);
7810 if (widget->priv->double_buffered != double_buffered)
7812 widget->priv->double_buffered = double_buffered;
7814 g_object_notify (G_OBJECT (widget), "double-buffered");
7819 * gtk_widget_get_double_buffered:
7820 * @widget: a #GtkWidget
7822 * Determines whether the widget is double buffered.
7824 * See gtk_widget_set_double_buffered()
7826 * Return value: %TRUE if the widget is double buffered
7831 gtk_widget_get_double_buffered (GtkWidget *widget)
7833 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7835 return widget->priv->double_buffered;
7839 * gtk_widget_set_redraw_on_allocate:
7840 * @widget: a #GtkWidget
7841 * @redraw_on_allocate: if %TRUE, the entire widget will be redrawn
7842 * when it is allocated to a new size. Otherwise, only the
7843 * new portion of the widget will be redrawn.
7845 * Sets whether the entire widget is queued for drawing when its size
7846 * allocation changes. By default, this setting is %TRUE and
7847 * the entire widget is redrawn on every size change. If your widget
7848 * leaves the upper left unchanged when made bigger, turning this
7849 * setting off will improve performance.
7851 * Note that for %NO_WINDOW widgets setting this flag to %FALSE turns
7852 * off all allocation on resizing: the widget will not even redraw if
7853 * its position changes; this is to allow containers that don't draw
7854 * anything to avoid excess invalidations. If you set this flag on a
7855 * %NO_WINDOW widget that <emphasis>does</emphasis> draw on @widget->window,
7856 * you are responsible for invalidating both the old and new allocation
7857 * of the widget when the widget is moved and responsible for invalidating
7858 * regions newly when the widget increases size.
7861 gtk_widget_set_redraw_on_allocate (GtkWidget *widget,
7862 gboolean redraw_on_allocate)
7864 g_return_if_fail (GTK_IS_WIDGET (widget));
7866 widget->priv->redraw_on_alloc = redraw_on_allocate;
7870 * gtk_widget_set_sensitive:
7871 * @widget: a #GtkWidget
7872 * @sensitive: %TRUE to make the widget sensitive
7874 * Sets the sensitivity of a widget. A widget is sensitive if the user
7875 * can interact with it. Insensitive widgets are "grayed out" and the
7876 * user can't interact with them. Insensitive widgets are known as
7877 * "inactive", "disabled", or "ghosted" in some other toolkits.
7880 gtk_widget_set_sensitive (GtkWidget *widget,
7883 GtkWidgetPrivate *priv;
7885 g_return_if_fail (GTK_IS_WIDGET (widget));
7887 priv = widget->priv;
7889 sensitive = (sensitive != FALSE);
7891 if (priv->sensitive == sensitive)
7894 priv->sensitive = sensitive;
7896 if (priv->parent == NULL
7897 || gtk_widget_is_sensitive (priv->parent))
7901 data.flags = GTK_STATE_FLAG_INSENSITIVE;
7904 data.operation = STATE_CHANGE_UNSET;
7906 data.operation = STATE_CHANGE_SET;
7908 gtk_widget_propagate_state (widget, &data);
7910 gtk_widget_queue_resize (widget);
7913 g_object_notify (G_OBJECT (widget), "sensitive");
7917 * gtk_widget_get_sensitive:
7918 * @widget: a #GtkWidget
7920 * Returns the widget's sensitivity (in the sense of returning
7921 * the value that has been set using gtk_widget_set_sensitive()).
7923 * The effective sensitivity of a widget is however determined by both its
7924 * own and its parent widget's sensitivity. See gtk_widget_is_sensitive().
7926 * Returns: %TRUE if the widget is sensitive
7931 gtk_widget_get_sensitive (GtkWidget *widget)
7933 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7935 return widget->priv->sensitive;
7939 * gtk_widget_is_sensitive:
7940 * @widget: a #GtkWidget
7942 * Returns the widget's effective sensitivity, which means
7943 * it is sensitive itself and also its parent widget is sensitive
7945 * Returns: %TRUE if the widget is effectively sensitive
7950 gtk_widget_is_sensitive (GtkWidget *widget)
7952 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7954 return !(widget->priv->state_flags & GTK_STATE_FLAG_INSENSITIVE);
7958 * gtk_widget_set_parent:
7959 * @widget: a #GtkWidget
7960 * @parent: parent container
7962 * This function is useful only when implementing subclasses of
7964 * Sets the container as the parent of @widget, and takes care of
7965 * some details such as updating the state and style of the child
7966 * to reflect its new location. The opposite function is
7967 * gtk_widget_unparent().
7970 gtk_widget_set_parent (GtkWidget *widget,
7973 GtkStateFlags parent_flags;
7974 GtkWidgetPrivate *priv;
7977 g_return_if_fail (GTK_IS_WIDGET (widget));
7978 g_return_if_fail (GTK_IS_WIDGET (parent));
7979 g_return_if_fail (widget != parent);
7981 priv = widget->priv;
7983 if (priv->parent != NULL)
7985 g_warning ("Can't set a parent on widget which has a parent\n");
7988 if (gtk_widget_is_toplevel (widget))
7990 g_warning ("Can't set a parent on a toplevel widget\n");
7994 /* keep this function in sync with gtk_menu_attach_to_widget()
7997 g_object_ref_sink (widget);
7999 gtk_widget_push_verify_invariants (widget);
8001 priv->parent = parent;
8003 parent_flags = gtk_widget_get_state_flags (parent);
8005 /* Merge both old state and current parent state,
8006 * making sure to only propagate the right states */
8007 data.flags = parent_flags & GTK_STATE_FLAGS_DO_PROPAGATE;
8008 data.flags |= priv->state_flags;
8010 data.operation = STATE_CHANGE_REPLACE;
8011 gtk_widget_propagate_state (widget, &data);
8014 gtk_style_context_set_parent (priv->context,
8015 gtk_widget_get_style_context (parent));
8017 _gtk_widget_update_parent_muxer (widget);
8019 g_signal_emit (widget, widget_signals[PARENT_SET], 0, NULL);
8020 if (priv->parent->priv->anchored)
8021 _gtk_widget_propagate_hierarchy_changed (widget, NULL);
8022 g_object_notify (G_OBJECT (widget), "parent");
8024 /* Enforce realized/mapped invariants
8026 if (gtk_widget_get_realized (priv->parent))
8027 gtk_widget_realize (widget);
8029 if (gtk_widget_get_visible (priv->parent) &&
8030 gtk_widget_get_visible (widget))
8032 if (gtk_widget_get_child_visible (widget) &&
8033 gtk_widget_get_mapped (priv->parent))
8034 gtk_widget_map (widget);
8036 gtk_widget_queue_resize (widget);
8039 /* child may cause parent's expand to change, if the child is
8040 * expanded. If child is not expanded, then it can't modify the
8041 * parent's expand. If the child becomes expanded later then it will
8042 * queue compute_expand then. This optimization plus defaulting
8043 * newly-constructed widgets to need_compute_expand=FALSE should
8044 * mean that initially building a widget tree doesn't have to keep
8045 * walking up setting need_compute_expand on parents over and over.
8047 * We can't change a parent to need to expand unless we're visible.
8049 if (gtk_widget_get_visible (widget) &&
8050 (priv->need_compute_expand ||
8051 priv->computed_hexpand ||
8052 priv->computed_vexpand))
8054 gtk_widget_queue_compute_expand (parent);
8057 gtk_widget_pop_verify_invariants (widget);
8061 * gtk_widget_get_parent:
8062 * @widget: a #GtkWidget
8064 * Returns the parent container of @widget.
8066 * Return value: (transfer none): the parent container of @widget, or %NULL
8069 gtk_widget_get_parent (GtkWidget *widget)
8071 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8073 return widget->priv->parent;
8077 modifier_style_changed (GtkModifierStyle *style,
8080 _gtk_widget_invalidate_style_context (widget, GTK_CSS_CHANGE_ANY);
8083 static GtkModifierStyle *
8084 _gtk_widget_get_modifier_properties (GtkWidget *widget)
8086 GtkModifierStyle *style;
8088 style = g_object_get_qdata (G_OBJECT (widget), quark_modifier_style);
8090 if (G_UNLIKELY (!style))
8092 GtkStyleContext *context;
8094 style = _gtk_modifier_style_new ();
8095 g_object_set_qdata_full (G_OBJECT (widget),
8096 quark_modifier_style,
8098 (GDestroyNotify) g_object_unref);
8100 g_signal_connect (style, "changed",
8101 G_CALLBACK (modifier_style_changed), widget);
8103 context = gtk_widget_get_style_context (widget);
8105 gtk_style_context_add_provider (context,
8106 GTK_STYLE_PROVIDER (style),
8107 GTK_STYLE_PROVIDER_PRIORITY_APPLICATION);
8114 * gtk_widget_override_color:
8115 * @widget: a #GtkWidget
8116 * @state: the state for which to set the color
8117 * @color: (allow-none): the color to assign, or %NULL to undo the effect
8118 * of previous calls to gtk_widget_override_color()
8120 * Sets the color to use for a widget.
8122 * All other style values are left untouched.
8125 * This API is mostly meant as a quick way for applications to
8126 * change a widget appearance. If you are developing a widgets
8127 * library and intend this change to be themeable, it is better
8128 * done by setting meaningful CSS classes and regions in your
8129 * widget/container implementation through gtk_style_context_add_class()
8130 * and gtk_style_context_add_region().
8132 * This way, your widget library can install a #GtkCssProvider
8133 * with the %GTK_STYLE_PROVIDER_PRIORITY_FALLBACK priority in order
8134 * to provide a default styling for those widgets that need so, and
8135 * this theming may fully overridden by the user's theme.
8138 * Note that for complex widgets this may bring in undesired
8139 * results (such as uniform background color everywhere), in
8140 * these cases it is better to fully style such widgets through a
8141 * #GtkCssProvider with the %GTK_STYLE_PROVIDER_PRIORITY_APPLICATION
8148 gtk_widget_override_color (GtkWidget *widget,
8149 GtkStateFlags state,
8150 const GdkRGBA *color)
8152 GtkModifierStyle *style;
8154 g_return_if_fail (GTK_IS_WIDGET (widget));
8156 style = _gtk_widget_get_modifier_properties (widget);
8157 _gtk_modifier_style_set_color (style, state, color);
8161 * gtk_widget_override_background_color:
8162 * @widget: a #GtkWidget
8163 * @state: the state for which to set the background color
8164 * @color: (allow-none): the color to assign, or %NULL to undo the effect
8165 * of previous calls to gtk_widget_override_background_color()
8167 * Sets the background color to use for a widget.
8169 * All other style values are left untouched.
8170 * See gtk_widget_override_color().
8175 gtk_widget_override_background_color (GtkWidget *widget,
8176 GtkStateFlags state,
8177 const GdkRGBA *color)
8179 GtkModifierStyle *style;
8181 g_return_if_fail (GTK_IS_WIDGET (widget));
8183 style = _gtk_widget_get_modifier_properties (widget);
8184 _gtk_modifier_style_set_background_color (style, state, color);
8188 * gtk_widget_override_font:
8189 * @widget: a #GtkWidget
8190 * @font_desc: (allow-none): the font descriptiong to use, or %NULL to undo
8191 * the effect of previous calls to gtk_widget_override_font()
8193 * Sets the font to use for a widget. All other style values are
8194 * left untouched. See gtk_widget_override_color().
8199 gtk_widget_override_font (GtkWidget *widget,
8200 const PangoFontDescription *font_desc)
8202 GtkModifierStyle *style;
8204 g_return_if_fail (GTK_IS_WIDGET (widget));
8206 style = _gtk_widget_get_modifier_properties (widget);
8207 _gtk_modifier_style_set_font (style, font_desc);
8211 * gtk_widget_override_symbolic_color:
8212 * @widget: a #GtkWidget
8213 * @name: the name of the symbolic color to modify
8214 * @color: (allow-none): the color to assign (does not need
8215 * to be allocated), or %NULL to undo the effect of previous
8216 * calls to gtk_widget_override_symbolic_color()
8218 * Sets a symbolic color for a widget.
8220 * All other style values are left untouched.
8221 * See gtk_widget_override_color() for overriding the foreground
8222 * or background color.
8227 gtk_widget_override_symbolic_color (GtkWidget *widget,
8229 const GdkRGBA *color)
8231 GtkModifierStyle *style;
8233 g_return_if_fail (GTK_IS_WIDGET (widget));
8235 style = _gtk_widget_get_modifier_properties (widget);
8236 _gtk_modifier_style_map_color (style, name, color);
8240 * gtk_widget_override_cursor:
8241 * @widget: a #GtkWidget
8242 * @cursor: (allow-none): the color to use for primary cursor (does not need to be
8243 * allocated), or %NULL to undo the effect of previous calls to
8244 * of gtk_widget_override_cursor().
8245 * @secondary_cursor: (allow-none): the color to use for secondary cursor (does not
8246 * need to be allocated), or %NULL to undo the effect of previous
8247 * calls to of gtk_widget_override_cursor().
8249 * Sets the cursor color to use in a widget, overriding the
8250 * #GtkWidget:cursor-color and #GtkWidget:secondary-cursor-color
8251 * style properties. All other style values are left untouched.
8252 * See also gtk_widget_modify_style().
8254 * Note that the underlying properties have the #GdkColor type,
8255 * so the alpha value in @primary and @secondary will be ignored.
8260 gtk_widget_override_cursor (GtkWidget *widget,
8261 const GdkRGBA *cursor,
8262 const GdkRGBA *secondary_cursor)
8264 GtkModifierStyle *style;
8266 g_return_if_fail (GTK_IS_WIDGET (widget));
8268 style = _gtk_widget_get_modifier_properties (widget);
8269 _gtk_modifier_style_set_color_property (style,
8271 "cursor-color", cursor);
8272 _gtk_modifier_style_set_color_property (style,
8274 "secondary-cursor-color",
8279 gtk_widget_real_direction_changed (GtkWidget *widget,
8280 GtkTextDirection previous_direction)
8282 gtk_widget_queue_resize (widget);
8286 gtk_widget_real_style_set (GtkWidget *widget,
8287 GtkStyle *previous_style)
8292 GtkWidget *previous_toplevel;
8293 GdkScreen *previous_screen;
8294 GdkScreen *new_screen;
8295 } HierarchyChangedInfo;
8298 do_screen_change (GtkWidget *widget,
8299 GdkScreen *old_screen,
8300 GdkScreen *new_screen)
8302 if (old_screen != new_screen)
8304 GtkWidgetPrivate *priv = widget->priv;
8308 PangoContext *context = g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
8310 g_object_set_qdata (G_OBJECT (widget), quark_pango_context, NULL);
8313 _gtk_tooltip_hide (widget);
8315 if (new_screen && priv->context)
8316 gtk_style_context_set_screen (priv->context, new_screen);
8318 g_signal_emit (widget, widget_signals[SCREEN_CHANGED], 0, old_screen);
8323 gtk_widget_propagate_hierarchy_changed_recurse (GtkWidget *widget,
8324 gpointer client_data)
8326 GtkWidgetPrivate *priv = widget->priv;
8327 HierarchyChangedInfo *info = client_data;
8328 gboolean new_anchored = gtk_widget_is_toplevel (widget) ||
8329 (priv->parent && priv->parent->priv->anchored);
8331 if (priv->anchored != new_anchored)
8333 g_object_ref (widget);
8335 priv->anchored = new_anchored;
8337 g_signal_emit (widget, widget_signals[HIERARCHY_CHANGED], 0, info->previous_toplevel);
8338 do_screen_change (widget, info->previous_screen, info->new_screen);
8340 if (GTK_IS_CONTAINER (widget))
8341 gtk_container_forall (GTK_CONTAINER (widget),
8342 gtk_widget_propagate_hierarchy_changed_recurse,
8345 g_object_unref (widget);
8350 * _gtk_widget_propagate_hierarchy_changed:
8351 * @widget: a #GtkWidget
8352 * @previous_toplevel: Previous toplevel
8354 * Propagates changes in the anchored state to a widget and all
8355 * children, unsetting or setting the %ANCHORED flag, and
8356 * emitting #GtkWidget::hierarchy-changed.
8359 _gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
8360 GtkWidget *previous_toplevel)
8362 GtkWidgetPrivate *priv = widget->priv;
8363 HierarchyChangedInfo info;
8365 info.previous_toplevel = previous_toplevel;
8366 info.previous_screen = previous_toplevel ? gtk_widget_get_screen (previous_toplevel) : NULL;
8368 if (gtk_widget_is_toplevel (widget) ||
8369 (priv->parent && priv->parent->priv->anchored))
8370 info.new_screen = gtk_widget_get_screen (widget);
8372 info.new_screen = NULL;
8374 if (info.previous_screen)
8375 g_object_ref (info.previous_screen);
8376 if (previous_toplevel)
8377 g_object_ref (previous_toplevel);
8379 gtk_widget_propagate_hierarchy_changed_recurse (widget, &info);
8381 if (previous_toplevel)
8382 g_object_unref (previous_toplevel);
8383 if (info.previous_screen)
8384 g_object_unref (info.previous_screen);
8388 gtk_widget_propagate_screen_changed_recurse (GtkWidget *widget,
8389 gpointer client_data)
8391 HierarchyChangedInfo *info = client_data;
8393 g_object_ref (widget);
8395 do_screen_change (widget, info->previous_screen, info->new_screen);
8397 if (GTK_IS_CONTAINER (widget))
8398 gtk_container_forall (GTK_CONTAINER (widget),
8399 gtk_widget_propagate_screen_changed_recurse,
8402 g_object_unref (widget);
8406 * gtk_widget_is_composited:
8407 * @widget: a #GtkWidget
8409 * Whether @widget can rely on having its alpha channel
8410 * drawn correctly. On X11 this function returns whether a
8411 * compositing manager is running for @widget's screen.
8413 * Please note that the semantics of this call will change
8414 * in the future if used on a widget that has a composited
8415 * window in its hierarchy (as set by gdk_window_set_composited()).
8417 * Return value: %TRUE if the widget can rely on its alpha
8418 * channel being drawn correctly.
8423 gtk_widget_is_composited (GtkWidget *widget)
8427 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
8429 screen = gtk_widget_get_screen (widget);
8431 return gdk_screen_is_composited (screen);
8435 propagate_composited_changed (GtkWidget *widget,
8438 if (GTK_IS_CONTAINER (widget))
8440 gtk_container_forall (GTK_CONTAINER (widget),
8441 propagate_composited_changed,
8445 g_signal_emit (widget, widget_signals[COMPOSITED_CHANGED], 0);
8449 _gtk_widget_propagate_composited_changed (GtkWidget *widget)
8451 propagate_composited_changed (widget, NULL);
8455 * _gtk_widget_propagate_screen_changed:
8456 * @widget: a #GtkWidget
8457 * @previous_screen: Previous screen
8459 * Propagates changes in the screen for a widget to all
8460 * children, emitting #GtkWidget::screen-changed.
8463 _gtk_widget_propagate_screen_changed (GtkWidget *widget,
8464 GdkScreen *previous_screen)
8466 HierarchyChangedInfo info;
8468 info.previous_screen = previous_screen;
8469 info.new_screen = gtk_widget_get_screen (widget);
8471 if (previous_screen)
8472 g_object_ref (previous_screen);
8474 gtk_widget_propagate_screen_changed_recurse (widget, &info);
8476 if (previous_screen)
8477 g_object_unref (previous_screen);
8481 reset_style_recurse (GtkWidget *widget, gpointer data)
8483 _gtk_widget_invalidate_style_context (widget, GTK_CSS_CHANGE_ANY);
8485 if (GTK_IS_CONTAINER (widget))
8486 gtk_container_forall (GTK_CONTAINER (widget),
8487 reset_style_recurse,
8492 * gtk_widget_reset_style:
8493 * @widget: a #GtkWidget
8495 * Updates the style context of @widget and all descendents
8496 * by updating its widget path. #GtkContainer<!-- -->s may want
8497 * to use this on a child when reordering it in a way that a different
8498 * style might apply to it. See also gtk_container_get_path_for_child().
8503 gtk_widget_reset_style (GtkWidget *widget)
8505 g_return_if_fail (GTK_IS_WIDGET (widget));
8507 reset_style_recurse (widget, NULL);
8509 g_list_foreach (widget->priv->attached_windows,
8510 (GFunc) reset_style_recurse, NULL);
8513 #ifdef G_ENABLE_DEBUG
8515 /* Verify invariants, see docs/widget_system.txt for notes on much of
8516 * this. Invariants may be temporarily broken while we're in the
8517 * process of updating state, of course, so you can only
8518 * verify_invariants() after a given operation is complete.
8519 * Use push/pop_verify_invariants to help with that.
8522 gtk_widget_verify_invariants (GtkWidget *widget)
8526 if (widget->priv->verifying_invariants_count > 0)
8529 parent = widget->priv->parent;
8531 if (widget->priv->mapped)
8533 /* Mapped implies ... */
8535 if (!widget->priv->realized)
8536 g_warning ("%s %p is mapped but not realized",
8537 G_OBJECT_TYPE_NAME (widget), widget);
8539 if (!widget->priv->visible)
8540 g_warning ("%s %p is mapped but not visible",
8541 G_OBJECT_TYPE_NAME (widget), widget);
8543 if (!widget->priv->toplevel)
8545 if (!widget->priv->child_visible)
8546 g_warning ("%s %p is mapped but not child_visible",
8547 G_OBJECT_TYPE_NAME (widget), widget);
8552 /* Not mapped implies... */
8555 /* This check makes sense for normal toplevels, but for
8556 * something like a toplevel that is embedded within a clutter
8557 * state, mapping may depend on external factors.
8559 if (widget->priv->toplevel)
8561 if (widget->priv->visible)
8562 g_warning ("%s %p toplevel is visible but not mapped",
8563 G_OBJECT_TYPE_NAME (widget), widget);
8568 /* Parent related checks aren't possible if parent has
8569 * verifying_invariants_count > 0 because parent needs to recurse
8570 * children first before the invariants will hold.
8572 if (parent == NULL || parent->priv->verifying_invariants_count == 0)
8575 parent->priv->realized)
8577 /* Parent realized implies... */
8580 /* This is in widget_system.txt but appears to fail
8581 * because there's no gtk_container_realize() that
8582 * realizes all children... instead we just lazily
8583 * wait for map to fix things up.
8585 if (!widget->priv->realized)
8586 g_warning ("%s %p is realized but child %s %p is not realized",
8587 G_OBJECT_TYPE_NAME (parent), parent,
8588 G_OBJECT_TYPE_NAME (widget), widget);
8591 else if (!widget->priv->toplevel)
8593 /* No parent or parent not realized on non-toplevel implies... */
8595 if (widget->priv->realized && !widget->priv->in_reparent)
8596 g_warning ("%s %p is not realized but child %s %p is realized",
8597 parent ? G_OBJECT_TYPE_NAME (parent) : "no parent", parent,
8598 G_OBJECT_TYPE_NAME (widget), widget);
8602 parent->priv->mapped &&
8603 widget->priv->visible &&
8604 widget->priv->child_visible)
8606 /* Parent mapped and we are visible implies... */
8608 if (!widget->priv->mapped)
8609 g_warning ("%s %p is mapped but visible child %s %p is not mapped",
8610 G_OBJECT_TYPE_NAME (parent), parent,
8611 G_OBJECT_TYPE_NAME (widget), widget);
8613 else if (!widget->priv->toplevel)
8615 /* No parent or parent not mapped on non-toplevel implies... */
8617 if (widget->priv->mapped && !widget->priv->in_reparent)
8618 g_warning ("%s %p is mapped but visible=%d child_visible=%d parent %s %p mapped=%d",
8619 G_OBJECT_TYPE_NAME (widget), widget,
8620 widget->priv->visible,
8621 widget->priv->child_visible,
8622 parent ? G_OBJECT_TYPE_NAME (parent) : "no parent", parent,
8623 parent ? parent->priv->mapped : FALSE);
8627 if (!widget->priv->realized)
8629 /* Not realized implies... */
8632 /* widget_system.txt says these hold, but they don't. */
8633 if (widget->priv->alloc_needed)
8634 g_warning ("%s %p alloc needed but not realized",
8635 G_OBJECT_TYPE_NAME (widget), widget);
8637 if (widget->priv->width_request_needed)
8638 g_warning ("%s %p width request needed but not realized",
8639 G_OBJECT_TYPE_NAME (widget), widget);
8641 if (widget->priv->height_request_needed)
8642 g_warning ("%s %p height request needed but not realized",
8643 G_OBJECT_TYPE_NAME (widget), widget);
8648 /* The point of this push/pop is that invariants may not hold while
8649 * we're busy making changes. So we only check at the outermost call
8650 * on the call stack, after we finish updating everything.
8653 gtk_widget_push_verify_invariants (GtkWidget *widget)
8655 widget->priv->verifying_invariants_count += 1;
8659 gtk_widget_verify_child_invariants (GtkWidget *widget,
8660 gpointer client_data)
8662 /* We don't recurse further; this is a one-level check. */
8663 gtk_widget_verify_invariants (widget);
8667 gtk_widget_pop_verify_invariants (GtkWidget *widget)
8669 g_assert (widget->priv->verifying_invariants_count > 0);
8671 widget->priv->verifying_invariants_count -= 1;
8673 if (widget->priv->verifying_invariants_count == 0)
8675 gtk_widget_verify_invariants (widget);
8677 if (GTK_IS_CONTAINER (widget))
8679 /* Check one level of children, because our
8680 * push_verify_invariants() will have prevented some of the
8681 * checks. This does not recurse because if recursion is
8682 * needed, it will happen naturally as each child has a
8683 * push/pop on that child. For example if we're recursively
8684 * mapping children, we'll push/pop on each child as we map
8687 gtk_container_forall (GTK_CONTAINER (widget),
8688 gtk_widget_verify_child_invariants,
8693 #endif /* G_ENABLE_DEBUG */
8695 static PangoContext *
8696 gtk_widget_peek_pango_context (GtkWidget *widget)
8698 return g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
8702 * gtk_widget_get_pango_context:
8703 * @widget: a #GtkWidget
8705 * Gets a #PangoContext with the appropriate font map, font description,
8706 * and base direction for this widget. Unlike the context returned
8707 * by gtk_widget_create_pango_context(), this context is owned by
8708 * the widget (it can be used until the screen for the widget changes
8709 * or the widget is removed from its toplevel), and will be updated to
8710 * match any changes to the widget's attributes.
8712 * If you create and keep a #PangoLayout using this context, you must
8713 * deal with changes to the context by calling pango_layout_context_changed()
8714 * on the layout in response to the #GtkWidget::style-updated and
8715 * #GtkWidget::direction-changed signals for the widget.
8717 * Return value: (transfer none): the #PangoContext for the widget.
8720 gtk_widget_get_pango_context (GtkWidget *widget)
8722 PangoContext *context;
8724 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8726 context = g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
8729 context = gtk_widget_create_pango_context (GTK_WIDGET (widget));
8730 g_object_set_qdata_full (G_OBJECT (widget),
8731 quark_pango_context,
8740 update_pango_context (GtkWidget *widget,
8741 PangoContext *context)
8743 const PangoFontDescription *font_desc;
8744 GtkStyleContext *style_context;
8746 style_context = gtk_widget_get_style_context (widget);
8748 font_desc = gtk_style_context_get_font (style_context,
8749 gtk_widget_get_state_flags (widget));
8751 pango_context_set_font_description (context, font_desc);
8752 pango_context_set_base_dir (context,
8753 gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR ?
8754 PANGO_DIRECTION_LTR : PANGO_DIRECTION_RTL);
8758 gtk_widget_update_pango_context (GtkWidget *widget)
8760 PangoContext *context = gtk_widget_peek_pango_context (widget);
8766 update_pango_context (widget, context);
8768 screen = gtk_widget_get_screen_unchecked (widget);
8771 pango_cairo_context_set_resolution (context,
8772 gdk_screen_get_resolution (screen));
8773 pango_cairo_context_set_font_options (context,
8774 gdk_screen_get_font_options (screen));
8780 * gtk_widget_create_pango_context:
8781 * @widget: a #GtkWidget
8783 * Creates a new #PangoContext with the appropriate font map,
8784 * font description, and base direction for drawing text for
8785 * this widget. See also gtk_widget_get_pango_context().
8787 * Return value: (transfer full): the new #PangoContext
8790 gtk_widget_create_pango_context (GtkWidget *widget)
8793 PangoContext *context;
8795 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8797 screen = gtk_widget_get_screen_unchecked (widget);
8800 GTK_NOTE (MULTIHEAD,
8801 g_warning ("gtk_widget_create_pango_context ()) called without screen"));
8803 screen = gdk_screen_get_default ();
8806 context = gdk_pango_context_get_for_screen (screen);
8808 update_pango_context (widget, context);
8809 pango_context_set_language (context, gtk_get_default_language ());
8815 * gtk_widget_create_pango_layout:
8816 * @widget: a #GtkWidget
8817 * @text: text to set on the layout (can be %NULL)
8819 * Creates a new #PangoLayout with the appropriate font map,
8820 * font description, and base direction for drawing text for
8823 * If you keep a #PangoLayout created in this way around, in order to
8824 * notify the layout of changes to the base direction or font of this
8825 * widget, you must call pango_layout_context_changed() in response to
8826 * the #GtkWidget::style-updated and #GtkWidget::direction-changed signals
8829 * Return value: (transfer full): the new #PangoLayout
8832 gtk_widget_create_pango_layout (GtkWidget *widget,
8835 PangoLayout *layout;
8836 PangoContext *context;
8838 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8840 context = gtk_widget_get_pango_context (widget);
8841 layout = pango_layout_new (context);
8844 pango_layout_set_text (layout, text, -1);
8850 * gtk_widget_render_icon_pixbuf:
8851 * @widget: a #GtkWidget
8852 * @stock_id: a stock ID
8853 * @size: (type int): a stock size. A size of (GtkIconSize)-1 means
8854 * render at the size of the source and don't scale (if there are
8855 * multiple source sizes, GTK+ picks one of the available sizes).
8857 * A convenience function that uses the theme engine and style
8858 * settings for @widget to look up @stock_id and render it to
8859 * a pixbuf. @stock_id should be a stock icon ID such as
8860 * #GTK_STOCK_OPEN or #GTK_STOCK_OK. @size should be a size
8861 * such as #GTK_ICON_SIZE_MENU.
8863 * The pixels in the returned #GdkPixbuf are shared with the rest of
8864 * the application and should not be modified. The pixbuf should be freed
8865 * after use with g_object_unref().
8867 * Return value: (transfer full): a new pixbuf, or %NULL if the
8868 * stock ID wasn't known
8873 gtk_widget_render_icon_pixbuf (GtkWidget *widget,
8874 const gchar *stock_id,
8877 GtkStyleContext *context;
8878 GtkIconSet *icon_set;
8880 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8881 g_return_val_if_fail (stock_id != NULL, NULL);
8882 g_return_val_if_fail (size > GTK_ICON_SIZE_INVALID || size == -1, NULL);
8884 context = gtk_widget_get_style_context (widget);
8885 icon_set = gtk_style_context_lookup_icon_set (context, stock_id);
8887 if (icon_set == NULL)
8890 return gtk_icon_set_render_icon_pixbuf (icon_set, context, size);
8894 * gtk_widget_set_parent_window:
8895 * @widget: a #GtkWidget.
8896 * @parent_window: the new parent window.
8898 * Sets a non default parent window for @widget.
8900 * For GtkWindow classes, setting a @parent_window effects whether
8901 * the window is a toplevel window or can be embedded into other
8905 * For GtkWindow classes, this needs to be called before the
8906 * window is realized.
8911 gtk_widget_set_parent_window (GtkWidget *widget,
8912 GdkWindow *parent_window)
8914 GdkWindow *old_parent_window;
8916 g_return_if_fail (GTK_IS_WIDGET (widget));
8918 old_parent_window = g_object_get_qdata (G_OBJECT (widget),
8919 quark_parent_window);
8921 if (parent_window != old_parent_window)
8925 g_object_set_qdata (G_OBJECT (widget), quark_parent_window,
8927 if (old_parent_window)
8928 g_object_unref (old_parent_window);
8930 g_object_ref (parent_window);
8932 /* Unset toplevel flag when adding a parent window to a widget,
8933 * this is the primary entry point to allow toplevels to be
8936 #ifdef GDK_WINDOWING_X11
8937 is_plug = GTK_IS_PLUG (widget);
8941 if (GTK_IS_WINDOW (widget) && !is_plug)
8942 _gtk_window_set_is_toplevel (GTK_WINDOW (widget), parent_window == NULL);
8947 * gtk_widget_get_parent_window:
8948 * @widget: a #GtkWidget.
8950 * Gets @widget's parent window.
8952 * Returns: (transfer none): the parent window of @widget.
8955 gtk_widget_get_parent_window (GtkWidget *widget)
8957 GtkWidgetPrivate *priv;
8958 GdkWindow *parent_window;
8960 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8962 priv = widget->priv;
8964 parent_window = g_object_get_qdata (G_OBJECT (widget), quark_parent_window);
8966 return (parent_window != NULL) ? parent_window :
8967 (priv->parent != NULL) ? priv->parent->priv->window : NULL;
8972 * gtk_widget_set_child_visible:
8973 * @widget: a #GtkWidget
8974 * @is_visible: if %TRUE, @widget should be mapped along with its parent.
8976 * Sets whether @widget should be mapped along with its when its parent
8977 * is mapped and @widget has been shown with gtk_widget_show().
8979 * The child visibility can be set for widget before it is added to
8980 * a container with gtk_widget_set_parent(), to avoid mapping
8981 * children unnecessary before immediately unmapping them. However
8982 * it will be reset to its default state of %TRUE when the widget
8983 * is removed from a container.
8985 * Note that changing the child visibility of a widget does not
8986 * queue a resize on the widget. Most of the time, the size of
8987 * a widget is computed from all visible children, whether or
8988 * not they are mapped. If this is not the case, the container
8989 * can queue a resize itself.
8991 * This function is only useful for container implementations and
8992 * never should be called by an application.
8995 gtk_widget_set_child_visible (GtkWidget *widget,
8996 gboolean is_visible)
8998 GtkWidgetPrivate *priv;
9000 g_return_if_fail (GTK_IS_WIDGET (widget));
9001 g_return_if_fail (!gtk_widget_is_toplevel (widget));
9003 priv = widget->priv;
9005 g_object_ref (widget);
9006 gtk_widget_verify_invariants (widget);
9009 priv->child_visible = TRUE;
9012 GtkWidget *toplevel;
9014 priv->child_visible = FALSE;
9016 toplevel = gtk_widget_get_toplevel (widget);
9017 if (toplevel != widget && gtk_widget_is_toplevel (toplevel))
9018 _gtk_window_unset_focus_and_default (GTK_WINDOW (toplevel), widget);
9021 if (priv->parent && gtk_widget_get_realized (priv->parent))
9023 if (gtk_widget_get_mapped (priv->parent) &&
9024 priv->child_visible &&
9025 gtk_widget_get_visible (widget))
9026 gtk_widget_map (widget);
9028 gtk_widget_unmap (widget);
9031 gtk_widget_verify_invariants (widget);
9032 g_object_unref (widget);
9036 * gtk_widget_get_child_visible:
9037 * @widget: a #GtkWidget
9039 * Gets the value set with gtk_widget_set_child_visible().
9040 * If you feel a need to use this function, your code probably
9041 * needs reorganization.
9043 * This function is only useful for container implementations and
9044 * never should be called by an application.
9046 * Return value: %TRUE if the widget is mapped with the parent.
9049 gtk_widget_get_child_visible (GtkWidget *widget)
9051 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
9053 return widget->priv->child_visible;
9057 gtk_widget_get_screen_unchecked (GtkWidget *widget)
9059 GtkWidget *toplevel;
9061 toplevel = gtk_widget_get_toplevel (widget);
9063 if (gtk_widget_is_toplevel (toplevel))
9065 if (GTK_IS_WINDOW (toplevel))
9066 return gtk_window_get_screen (GTK_WINDOW (toplevel));
9067 else if (GTK_IS_INVISIBLE (toplevel))
9068 return gtk_invisible_get_screen (GTK_INVISIBLE (widget));
9075 * gtk_widget_get_screen:
9076 * @widget: a #GtkWidget
9078 * Get the #GdkScreen from the toplevel window associated with
9079 * this widget. This function can only be called after the widget
9080 * has been added to a widget hierarchy with a #GtkWindow
9083 * In general, you should only create screen specific
9084 * resources when a widget has been realized, and you should
9085 * free those resources when the widget is unrealized.
9087 * Return value: (transfer none): the #GdkScreen for the toplevel for this widget.
9092 gtk_widget_get_screen (GtkWidget *widget)
9096 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9098 screen = gtk_widget_get_screen_unchecked (widget);
9105 g_warning (G_STRLOC ": Can't get associated screen"
9106 " for a widget unless it is inside a toplevel GtkWindow\n"
9107 " widget type is %s associated top level type is %s",
9108 g_type_name (G_OBJECT_TYPE(G_OBJECT (widget))),
9109 g_type_name (G_OBJECT_TYPE(G_OBJECT (toplevel))));
9111 return gdk_screen_get_default ();
9116 * gtk_widget_has_screen:
9117 * @widget: a #GtkWidget
9119 * Checks whether there is a #GdkScreen is associated with
9120 * this widget. All toplevel widgets have an associated
9121 * screen, and all widgets added into a hierarchy with a toplevel
9122 * window at the top.
9124 * Return value: %TRUE if there is a #GdkScreen associcated
9130 gtk_widget_has_screen (GtkWidget *widget)
9132 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
9134 return (gtk_widget_get_screen_unchecked (widget) != NULL);
9138 * gtk_widget_get_display:
9139 * @widget: a #GtkWidget
9141 * Get the #GdkDisplay for the toplevel window associated with
9142 * this widget. This function can only be called after the widget
9143 * has been added to a widget hierarchy with a #GtkWindow at the top.
9145 * In general, you should only create display specific
9146 * resources when a widget has been realized, and you should
9147 * free those resources when the widget is unrealized.
9149 * Return value: (transfer none): the #GdkDisplay for the toplevel for this widget.
9154 gtk_widget_get_display (GtkWidget *widget)
9156 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9158 return gdk_screen_get_display (gtk_widget_get_screen (widget));
9162 * gtk_widget_get_root_window:
9163 * @widget: a #GtkWidget
9165 * Get the root window where this widget is located. This function can
9166 * only be called after the widget has been added to a widget
9167 * hierarchy with #GtkWindow at the top.
9169 * The root window is useful for such purposes as creating a popup
9170 * #GdkWindow associated with the window. In general, you should only
9171 * create display specific resources when a widget has been realized,
9172 * and you should free those resources when the widget is unrealized.
9174 * Return value: (transfer none): the #GdkWindow root window for the toplevel for this widget.
9179 gtk_widget_get_root_window (GtkWidget *widget)
9181 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9183 return gdk_screen_get_root_window (gtk_widget_get_screen (widget));
9187 * gtk_widget_child_focus:
9188 * @widget: a #GtkWidget
9189 * @direction: direction of focus movement
9191 * This function is used by custom widget implementations; if you're
9192 * writing an app, you'd use gtk_widget_grab_focus() to move the focus
9193 * to a particular widget, and gtk_container_set_focus_chain() to
9194 * change the focus tab order. So you may want to investigate those
9195 * functions instead.
9197 * gtk_widget_child_focus() is called by containers as the user moves
9198 * around the window using keyboard shortcuts. @direction indicates
9199 * what kind of motion is taking place (up, down, left, right, tab
9200 * forward, tab backward). gtk_widget_child_focus() emits the
9201 * #GtkWidget::focus signal; widgets override the default handler
9202 * for this signal in order to implement appropriate focus behavior.
9204 * The default ::focus handler for a widget should return %TRUE if
9205 * moving in @direction left the focus on a focusable location inside
9206 * that widget, and %FALSE if moving in @direction moved the focus
9207 * outside the widget. If returning %TRUE, widgets normally
9208 * call gtk_widget_grab_focus() to place the focus accordingly;
9209 * if returning %FALSE, they don't modify the current focus location.
9211 * Return value: %TRUE if focus ended up inside @widget
9214 gtk_widget_child_focus (GtkWidget *widget,
9215 GtkDirectionType direction)
9217 gboolean return_val;
9219 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
9221 if (!gtk_widget_get_visible (widget) ||
9222 !gtk_widget_is_sensitive (widget))
9225 /* child widgets must set CAN_FOCUS, containers
9226 * don't have to though.
9228 if (!GTK_IS_CONTAINER (widget) &&
9229 !gtk_widget_get_can_focus (widget))
9232 g_signal_emit (widget,
9233 widget_signals[FOCUS],
9235 direction, &return_val);
9241 * gtk_widget_keynav_failed:
9242 * @widget: a #GtkWidget
9243 * @direction: direction of focus movement
9245 * This function should be called whenever keyboard navigation within
9246 * a single widget hits a boundary. The function emits the
9247 * #GtkWidget::keynav-failed signal on the widget and its return
9248 * value should be interpreted in a way similar to the return value of
9249 * gtk_widget_child_focus():
9251 * When %TRUE is returned, stay in the widget, the failed keyboard
9252 * navigation is Ok and/or there is nowhere we can/should move the
9255 * When %FALSE is returned, the caller should continue with keyboard
9256 * navigation outside the widget, e.g. by calling
9257 * gtk_widget_child_focus() on the widget's toplevel.
9259 * The default ::keynav-failed handler returns %TRUE for
9260 * %GTK_DIR_TAB_FORWARD and %GTK_DIR_TAB_BACKWARD. For the other
9261 * values of #GtkDirectionType, it looks at the
9262 * #GtkSettings:gtk-keynav-cursor-only setting and returns %FALSE
9263 * if the setting is %TRUE. This way the entire user interface
9264 * becomes cursor-navigatable on input devices such as mobile phones
9265 * which only have cursor keys but no tab key.
9267 * Whenever the default handler returns %TRUE, it also calls
9268 * gtk_widget_error_bell() to notify the user of the failed keyboard
9271 * A use case for providing an own implementation of ::keynav-failed
9272 * (either by connecting to it or by overriding it) would be a row of
9273 * #GtkEntry widgets where the user should be able to navigate the
9274 * entire row with the cursor keys, as e.g. known from user interfaces
9275 * that require entering license keys.
9277 * Return value: %TRUE if stopping keyboard navigation is fine, %FALSE
9278 * if the emitting widget should try to handle the keyboard
9279 * navigation attempt in its parent container(s).
9284 gtk_widget_keynav_failed (GtkWidget *widget,
9285 GtkDirectionType direction)
9287 gboolean return_val;
9289 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
9291 g_signal_emit (widget, widget_signals[KEYNAV_FAILED], 0,
9292 direction, &return_val);
9298 * gtk_widget_error_bell:
9299 * @widget: a #GtkWidget
9301 * Notifies the user about an input-related error on this widget.
9302 * If the #GtkSettings:gtk-error-bell setting is %TRUE, it calls
9303 * gdk_window_beep(), otherwise it does nothing.
9305 * Note that the effect of gdk_window_beep() can be configured in many
9306 * ways, depending on the windowing backend and the desktop environment
9307 * or window manager that is used.
9312 gtk_widget_error_bell (GtkWidget *widget)
9314 GtkWidgetPrivate *priv;
9315 GtkSettings* settings;
9318 g_return_if_fail (GTK_IS_WIDGET (widget));
9320 priv = widget->priv;
9322 settings = gtk_widget_get_settings (widget);
9326 g_object_get (settings,
9327 "gtk-error-bell", &beep,
9330 if (beep && priv->window)
9331 gdk_window_beep (priv->window);
9335 gtk_widget_set_usize_internal (GtkWidget *widget,
9338 GtkQueueResizeFlags flags)
9340 GtkWidgetAuxInfo *aux_info;
9341 gboolean changed = FALSE;
9343 g_object_freeze_notify (G_OBJECT (widget));
9345 aux_info = gtk_widget_get_aux_info (widget, TRUE);
9347 if (width > -2 && aux_info->width != width)
9349 if ((flags & GTK_QUEUE_RESIZE_INVALIDATE_ONLY) == 0)
9350 g_object_notify (G_OBJECT (widget), "width-request");
9351 aux_info->width = width;
9354 if (height > -2 && aux_info->height != height)
9356 if ((flags & GTK_QUEUE_RESIZE_INVALIDATE_ONLY) == 0)
9357 g_object_notify (G_OBJECT (widget), "height-request");
9358 aux_info->height = height;
9362 if (gtk_widget_get_visible (widget) && changed)
9364 if ((flags & GTK_QUEUE_RESIZE_INVALIDATE_ONLY) == 0)
9365 gtk_widget_queue_resize (widget);
9367 _gtk_size_group_queue_resize (widget, GTK_QUEUE_RESIZE_INVALIDATE_ONLY);
9370 g_object_thaw_notify (G_OBJECT (widget));
9374 * gtk_widget_set_size_request:
9375 * @widget: a #GtkWidget
9376 * @width: width @widget should request, or -1 to unset
9377 * @height: height @widget should request, or -1 to unset
9379 * Sets the minimum size of a widget; that is, the widget's size
9380 * request will be at least @width by @height. You can use this
9381 * function to force a widget to be larger than it normally would be.
9383 * In most cases, gtk_window_set_default_size() is a better choice for
9384 * toplevel windows than this function; setting the default size will
9385 * still allow users to shrink the window. Setting the size request
9386 * will force them to leave the window at least as large as the size
9387 * request. When dealing with window sizes,
9388 * gtk_window_set_geometry_hints() can be a useful function as well.
9390 * Note the inherent danger of setting any fixed size - themes,
9391 * translations into other languages, different fonts, and user action
9392 * can all change the appropriate size for a given widget. So, it's
9393 * basically impossible to hardcode a size that will always be
9396 * The size request of a widget is the smallest size a widget can
9397 * accept while still functioning well and drawing itself correctly.
9398 * However in some strange cases a widget may be allocated less than
9399 * its requested size, and in many cases a widget may be allocated more
9400 * space than it requested.
9402 * If the size request in a given direction is -1 (unset), then
9403 * the "natural" size request of the widget will be used instead.
9405 * The size request set here does not include any margin from the
9406 * #GtkWidget properties margin-left, margin-right, margin-top, and
9407 * margin-bottom, but it does include pretty much all other padding
9408 * or border properties set by any subclass of #GtkWidget.
9411 gtk_widget_set_size_request (GtkWidget *widget,
9415 g_return_if_fail (GTK_IS_WIDGET (widget));
9416 g_return_if_fail (width >= -1);
9417 g_return_if_fail (height >= -1);
9424 gtk_widget_set_usize_internal (widget, width, height, 0);
9429 * gtk_widget_get_size_request:
9430 * @widget: a #GtkWidget
9431 * @width: (out) (allow-none): return location for width, or %NULL
9432 * @height: (out) (allow-none): return location for height, or %NULL
9434 * Gets the size request that was explicitly set for the widget using
9435 * gtk_widget_set_size_request(). A value of -1 stored in @width or
9436 * @height indicates that that dimension has not been set explicitly
9437 * and the natural requisition of the widget will be used intead. See
9438 * gtk_widget_set_size_request(). To get the size a widget will
9439 * actually request, call gtk_widget_get_preferred_size() instead of
9443 gtk_widget_get_size_request (GtkWidget *widget,
9447 const GtkWidgetAuxInfo *aux_info;
9449 g_return_if_fail (GTK_IS_WIDGET (widget));
9451 aux_info = _gtk_widget_get_aux_info_or_defaults (widget);
9454 *width = aux_info->width;
9457 *height = aux_info->height;
9461 * _gtk_widget_override_size_request:
9462 * @widget: a #GtkWidget
9463 * @width: new forced minimum width
9464 * @height: new forced minimum height
9465 * @old_width: location to store previous forced minimum width
9466 * @old_height: location to store previous forced minumum height
9468 * Temporarily establishes a forced minimum size for a widget; this
9469 * is used by GtkWindow when calculating the size to add to the
9470 * window's geometry widget. Cached sizes for the widget and its
9471 * parents are invalidated, so that subsequent calls to the size
9472 * negotiation machinery produce the overriden result, but the
9473 * widget is not queued for relayout or redraw. The old size must
9474 * be restored with _gtk_widget_restore_size_request() or things
9478 _gtk_widget_override_size_request (GtkWidget *widget,
9484 gtk_widget_get_size_request (widget, old_width, old_height);
9485 gtk_widget_set_usize_internal (widget, width, height,
9486 GTK_QUEUE_RESIZE_INVALIDATE_ONLY);
9490 * _gtk_widget_restore_size_request:
9491 * @widget: a #GtkWidget
9492 * @old_width: saved forced minimum size
9493 * @old_height: saved forced minimum size
9495 * Undoes the operation of_gtk_widget_override_size_request().
9498 _gtk_widget_restore_size_request (GtkWidget *widget,
9502 gtk_widget_set_usize_internal (widget, old_width, old_height,
9503 GTK_QUEUE_RESIZE_INVALIDATE_ONLY);
9507 * gtk_widget_set_events:
9508 * @widget: a #GtkWidget
9509 * @events: event mask
9511 * Sets the event mask (see #GdkEventMask) for a widget. The event
9512 * mask determines which events a widget will receive. Keep in mind
9513 * that different widgets have different default event masks, and by
9514 * changing the event mask you may disrupt a widget's functionality,
9515 * so be careful. This function must be called while a widget is
9516 * unrealized. Consider gtk_widget_add_events() for widgets that are
9517 * already realized, or if you want to preserve the existing event
9518 * mask. This function can't be used with #GTK_NO_WINDOW widgets;
9519 * to get events on those widgets, place them inside a #GtkEventBox
9520 * and receive events on the event box.
9523 gtk_widget_set_events (GtkWidget *widget,
9526 g_return_if_fail (GTK_IS_WIDGET (widget));
9527 g_return_if_fail (!gtk_widget_get_realized (widget));
9529 g_object_set_qdata (G_OBJECT (widget), quark_event_mask,
9530 GINT_TO_POINTER (events));
9531 g_object_notify (G_OBJECT (widget), "events");
9535 * gtk_widget_set_device_events:
9536 * @widget: a #GtkWidget
9537 * @device: a #GdkDevice
9538 * @events: event mask
9540 * Sets the device event mask (see #GdkEventMask) for a widget. The event
9541 * mask determines which events a widget will receive from @device. Keep
9542 * in mind that different widgets have different default event masks, and by
9543 * changing the event mask you may disrupt a widget's functionality,
9544 * so be careful. This function must be called while a widget is
9545 * unrealized. Consider gtk_widget_add_device_events() for widgets that are
9546 * already realized, or if you want to preserve the existing event
9547 * mask. This function can't be used with #GTK_NO_WINDOW widgets;
9548 * to get events on those widgets, place them inside a #GtkEventBox
9549 * and receive events on the event box.
9554 gtk_widget_set_device_events (GtkWidget *widget,
9556 GdkEventMask events)
9558 GHashTable *device_events;
9560 g_return_if_fail (GTK_IS_WIDGET (widget));
9561 g_return_if_fail (GDK_IS_DEVICE (device));
9562 g_return_if_fail (!gtk_widget_get_realized (widget));
9564 device_events = g_object_get_qdata (G_OBJECT (widget), quark_device_event_mask);
9566 if (G_UNLIKELY (!device_events))
9568 device_events = g_hash_table_new (NULL, NULL);
9569 g_object_set_qdata_full (G_OBJECT (widget), quark_device_event_mask, device_events,
9570 (GDestroyNotify) g_hash_table_unref);
9573 g_hash_table_insert (device_events, device, GUINT_TO_POINTER (events));
9577 * gtk_widget_set_device_enabled:
9578 * @widget: a #GtkWidget
9579 * @device: a #GdkDevice
9580 * @enabled: whether to enable the device
9582 * Enables or disables a #GdkDevice to interact with @widget
9583 * and all its children.
9585 * It does so by descending through the #GdkWindow hierarchy
9586 * and enabling the same mask that is has for core events
9587 * (i.e. the one that gdk_window_get_events() returns).
9592 gtk_widget_set_device_enabled (GtkWidget *widget,
9596 GList *enabled_devices;
9598 g_return_if_fail (GTK_IS_WIDGET (widget));
9599 g_return_if_fail (GDK_IS_DEVICE (device));
9601 enabled_devices = g_object_get_qdata (G_OBJECT (widget), quark_enabled_devices);
9602 enabled_devices = g_list_append (enabled_devices, device);
9604 g_object_set_qdata_full (G_OBJECT (widget), quark_enabled_devices,
9605 enabled_devices, (GDestroyNotify) g_list_free);;
9607 if (gtk_widget_get_realized (widget))
9608 gtk_widget_set_device_enabled_internal (widget, device, TRUE, enabled);
9612 * gtk_widget_get_device_enabled:
9613 * @widget: a #GtkWidget
9614 * @device: a #GdkDevice
9616 * Returns whether @device can interact with @widget and its
9617 * children. See gtk_widget_set_device_enabled().
9619 * Return value: %TRUE is @device is enabled for @widget
9624 gtk_widget_get_device_enabled (GtkWidget *widget,
9627 GList *enabled_devices;
9629 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
9630 g_return_val_if_fail (GDK_IS_DEVICE (device), FALSE);
9632 enabled_devices = g_object_get_qdata (G_OBJECT (widget), quark_enabled_devices);
9634 return g_list_find (enabled_devices, device) != NULL;
9638 gtk_widget_add_events_internal_list (GtkWidget *widget,
9645 for (l = window_list; l != NULL; l = l->next)
9647 GdkWindow *window = l->data;
9650 gdk_window_get_user_data (window, &user_data);
9651 if (user_data == widget)
9656 gdk_window_set_device_events (window, device, gdk_window_get_events (window) | events);
9658 gdk_window_set_events (window, gdk_window_get_events (window) | events);
9660 children = gdk_window_get_children (window);
9661 gtk_widget_add_events_internal_list (widget, device, events, children);
9662 g_list_free (children);
9668 gtk_widget_add_events_internal (GtkWidget *widget,
9672 GtkWidgetPrivate *priv = widget->priv;
9675 if (!gtk_widget_get_has_window (widget))
9676 window_list = gdk_window_get_children (priv->window);
9678 window_list = g_list_prepend (NULL, priv->window);
9680 gtk_widget_add_events_internal_list (widget, device, events, window_list);
9682 g_list_free (window_list);
9686 * gtk_widget_add_events:
9687 * @widget: a #GtkWidget
9688 * @events: an event mask, see #GdkEventMask
9690 * Adds the events in the bitfield @events to the event mask for
9691 * @widget. See gtk_widget_set_events() for details.
9694 gtk_widget_add_events (GtkWidget *widget,
9699 g_return_if_fail (GTK_IS_WIDGET (widget));
9701 old_events = GPOINTER_TO_INT (g_object_get_qdata (G_OBJECT (widget), quark_event_mask));
9702 g_object_set_qdata (G_OBJECT (widget), quark_event_mask,
9703 GINT_TO_POINTER (old_events | events));
9705 if (gtk_widget_get_realized (widget))
9707 gtk_widget_add_events_internal (widget, NULL, events);
9708 gtk_widget_update_devices_mask (widget, FALSE);
9711 g_object_notify (G_OBJECT (widget), "events");
9715 * gtk_widget_add_device_events:
9716 * @widget: a #GtkWidget
9717 * @device: a #GdkDevice
9718 * @events: an event mask, see #GdkEventMask
9720 * Adds the device events in the bitfield @events to the event mask for
9721 * @widget. See gtk_widget_set_device_events() for details.
9726 gtk_widget_add_device_events (GtkWidget *widget,
9728 GdkEventMask events)
9730 GdkEventMask old_events;
9731 GHashTable *device_events;
9733 g_return_if_fail (GTK_IS_WIDGET (widget));
9734 g_return_if_fail (GDK_IS_DEVICE (device));
9736 old_events = gtk_widget_get_device_events (widget, device);
9738 device_events = g_object_get_qdata (G_OBJECT (widget), quark_device_event_mask);
9740 if (G_UNLIKELY (!device_events))
9742 device_events = g_hash_table_new (NULL, NULL);
9743 g_object_set_qdata_full (G_OBJECT (widget), quark_device_event_mask, device_events,
9744 (GDestroyNotify) g_hash_table_unref);
9747 g_hash_table_insert (device_events, device,
9748 GUINT_TO_POINTER (old_events | events));
9750 if (gtk_widget_get_realized (widget))
9751 gtk_widget_add_events_internal (widget, device, events);
9753 g_object_notify (G_OBJECT (widget), "events");
9757 * gtk_widget_get_toplevel:
9758 * @widget: a #GtkWidget
9760 * This function returns the topmost widget in the container hierarchy
9761 * @widget is a part of. If @widget has no parent widgets, it will be
9762 * returned as the topmost widget. No reference will be added to the
9763 * returned widget; it should not be unreferenced.
9765 * Note the difference in behavior vs. gtk_widget_get_ancestor();
9766 * <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW)</literal>
9768 * %NULL if @widget wasn't inside a toplevel window, and if the
9769 * window was inside a #GtkWindow<!-- -->-derived widget which was in turn
9770 * inside the toplevel #GtkWindow. While the second case may
9771 * seem unlikely, it actually happens when a #GtkPlug is embedded
9772 * inside a #GtkSocket within the same application.
9774 * To reliably find the toplevel #GtkWindow, use
9775 * gtk_widget_get_toplevel() and check if the %TOPLEVEL flags
9776 * is set on the result.
9778 * GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
9779 * if (gtk_widget_is_toplevel (toplevel))
9781 * /* Perform action on toplevel. */
9785 * Return value: (transfer none): the topmost ancestor of @widget, or @widget itself
9786 * if there's no ancestor.
9789 gtk_widget_get_toplevel (GtkWidget *widget)
9791 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9793 while (widget->priv->parent)
9794 widget = widget->priv->parent;
9800 * gtk_widget_get_ancestor:
9801 * @widget: a #GtkWidget
9802 * @widget_type: ancestor type
9804 * Gets the first ancestor of @widget with type @widget_type. For example,
9805 * <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)</literal> gets
9806 * the first #GtkBox that's an ancestor of @widget. No reference will be
9807 * added to the returned widget; it should not be unreferenced. See note
9808 * about checking for a toplevel #GtkWindow in the docs for
9809 * gtk_widget_get_toplevel().
9811 * Note that unlike gtk_widget_is_ancestor(), gtk_widget_get_ancestor()
9812 * considers @widget to be an ancestor of itself.
9814 * Return value: (transfer none): the ancestor widget, or %NULL if not found
9817 gtk_widget_get_ancestor (GtkWidget *widget,
9820 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9822 while (widget && !g_type_is_a (G_OBJECT_TYPE (widget), widget_type))
9823 widget = widget->priv->parent;
9825 if (!(widget && g_type_is_a (G_OBJECT_TYPE (widget), widget_type)))
9832 * gtk_widget_set_visual:
9833 * @widget: a #GtkWidget
9834 * @visual: visual to be used or %NULL to unset a previous one
9836 * Sets the visual that should be used for by widget and its children for
9837 * creating #GdkWindows. The visual must be on the same #GdkScreen as
9838 * returned by gtk_widget_get_screen(), so handling the
9839 * #GtkWidget::screen-changed signal is necessary.
9841 * Setting a new @visual will not cause @widget to recreate its windows,
9842 * so you should call this function before @widget is realized.
9845 gtk_widget_set_visual (GtkWidget *widget,
9848 g_return_if_fail (GTK_IS_WIDGET (widget));
9849 g_return_if_fail (visual == NULL || GDK_IS_VISUAL (visual));
9852 g_return_if_fail (gtk_widget_get_screen (widget) == gdk_visual_get_screen (visual));
9855 g_object_set_qdata_full (G_OBJECT (widget),
9857 g_object_ref (visual),
9862 * gtk_widget_get_visual:
9863 * @widget: a #GtkWidget
9865 * Gets the visual that will be used to render @widget.
9867 * Return value: (transfer none): the visual for @widget
9870 gtk_widget_get_visual (GtkWidget *widget)
9876 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9878 if (gtk_widget_get_has_window (widget) &&
9879 widget->priv->window)
9880 return gdk_window_get_visual (widget->priv->window);
9882 screen = gtk_widget_get_screen (widget);
9884 for (w = widget; w != NULL; w = w->priv->parent)
9886 visual = g_object_get_qdata (G_OBJECT (w), quark_visual);
9889 if (gdk_visual_get_screen (visual) == screen)
9892 g_warning ("Ignoring visual set on widget `%s' that is not on the correct screen.",
9893 gtk_widget_get_name (widget));
9897 return gdk_screen_get_system_visual (screen);
9901 * gtk_widget_get_settings:
9902 * @widget: a #GtkWidget
9904 * Gets the settings object holding the settings used for this widget.
9906 * Note that this function can only be called when the #GtkWidget
9907 * is attached to a toplevel, since the settings object is specific
9908 * to a particular #GdkScreen.
9910 * Return value: (transfer none): the relevant #GtkSettings object
9913 gtk_widget_get_settings (GtkWidget *widget)
9915 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9917 return gtk_settings_get_for_screen (gtk_widget_get_screen (widget));
9921 * gtk_widget_get_events:
9922 * @widget: a #GtkWidget
9924 * Returns the event mask for the widget (a bitfield containing flags
9925 * from the #GdkEventMask enumeration). These are the events that the widget
9928 * Return value: event mask for @widget
9931 gtk_widget_get_events (GtkWidget *widget)
9933 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
9935 return GPOINTER_TO_INT (g_object_get_qdata (G_OBJECT (widget), quark_event_mask));
9939 * gtk_widget_get_device_events:
9940 * @widget: a #GtkWidget
9941 * @device: a #GdkDevice
9943 * Returns the events mask for the widget corresponding to an specific device. These
9944 * are the events that the widget will receive when @device operates on it.
9946 * Returns: device event mask for @widget
9951 gtk_widget_get_device_events (GtkWidget *widget,
9954 GHashTable *device_events;
9956 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
9957 g_return_val_if_fail (GDK_IS_DEVICE (device), 0);
9959 device_events = g_object_get_qdata (G_OBJECT (widget), quark_device_event_mask);
9964 return GPOINTER_TO_UINT (g_hash_table_lookup (device_events, device));
9968 * gtk_widget_get_pointer:
9969 * @widget: a #GtkWidget
9970 * @x: (out) (allow-none): return location for the X coordinate, or %NULL
9971 * @y: (out) (allow-none): return location for the Y coordinate, or %NULL
9973 * Obtains the location of the mouse pointer in widget coordinates.
9974 * Widget coordinates are a bit odd; for historical reasons, they are
9975 * defined as @widget->window coordinates for widgets that are not
9976 * #GTK_NO_WINDOW widgets, and are relative to @widget->allocation.x,
9977 * @widget->allocation.y for widgets that are #GTK_NO_WINDOW widgets.
9979 * Deprecated: 3.4: Use gdk_window_get_device_position() instead.
9982 gtk_widget_get_pointer (GtkWidget *widget,
9986 GtkWidgetPrivate *priv;
9988 g_return_if_fail (GTK_IS_WIDGET (widget));
9990 priv = widget->priv;
9997 if (gtk_widget_get_realized (widget))
9999 gdk_window_get_device_position (priv->window,
10000 gdk_device_manager_get_client_pointer (
10001 gdk_display_get_device_manager (
10002 gtk_widget_get_display (widget))),
10005 if (!gtk_widget_get_has_window (widget))
10008 *x -= priv->allocation.x;
10010 *y -= priv->allocation.y;
10016 * gtk_widget_is_ancestor:
10017 * @widget: a #GtkWidget
10018 * @ancestor: another #GtkWidget
10020 * Determines whether @widget is somewhere inside @ancestor, possibly with
10021 * intermediate containers.
10023 * Return value: %TRUE if @ancestor contains @widget as a child,
10024 * grandchild, great grandchild, etc.
10027 gtk_widget_is_ancestor (GtkWidget *widget,
10028 GtkWidget *ancestor)
10030 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
10031 g_return_val_if_fail (ancestor != NULL, FALSE);
10035 if (widget->priv->parent == ancestor)
10037 widget = widget->priv->parent;
10043 static GQuark quark_composite_name = 0;
10046 * gtk_widget_set_composite_name:
10047 * @widget: a #GtkWidget.
10048 * @name: the name to set
10050 * Sets a widgets composite name. The widget must be
10051 * a composite child of its parent; see gtk_widget_push_composite_child().
10054 gtk_widget_set_composite_name (GtkWidget *widget,
10057 g_return_if_fail (GTK_IS_WIDGET (widget));
10058 g_return_if_fail (widget->priv->composite_child);
10059 g_return_if_fail (name != NULL);
10061 if (!quark_composite_name)
10062 quark_composite_name = g_quark_from_static_string ("gtk-composite-name");
10064 g_object_set_qdata_full (G_OBJECT (widget),
10065 quark_composite_name,
10071 * gtk_widget_get_composite_name:
10072 * @widget: a #GtkWidget
10074 * Obtains the composite name of a widget.
10076 * Returns: the composite name of @widget, or %NULL if @widget is not
10077 * a composite child. The string should be freed when it is no
10081 gtk_widget_get_composite_name (GtkWidget *widget)
10083 GtkWidgetPrivate *priv;
10085 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10087 priv = widget->priv;
10089 if (widget->priv->composite_child && priv->parent)
10090 return _gtk_container_child_composite_name (GTK_CONTAINER (priv->parent),
10097 * gtk_widget_push_composite_child:
10099 * Makes all newly-created widgets as composite children until
10100 * the corresponding gtk_widget_pop_composite_child() call.
10102 * A composite child is a child that's an implementation detail of the
10103 * container it's inside and should not be visible to people using the
10104 * container. Composite children aren't treated differently by GTK (but
10105 * see gtk_container_foreach() vs. gtk_container_forall()), but e.g. GUI
10106 * builders might want to treat them in a different way.
10108 * Here is a simple example:
10110 * gtk_widget_push_composite_child ();
10111 * scrolled_window->hscrollbar = gtk_scrollbar_new (GTK_ORIENTATION_HORIZONTAL, hadjustment);
10112 * gtk_widget_set_composite_name (scrolled_window->hscrollbar, "hscrollbar");
10113 * gtk_widget_pop_composite_child ();
10114 * gtk_widget_set_parent (scrolled_window->hscrollbar,
10115 * GTK_WIDGET (scrolled_window));
10116 * g_object_ref (scrolled_window->hscrollbar);
10120 gtk_widget_push_composite_child (void)
10122 composite_child_stack++;
10126 * gtk_widget_pop_composite_child:
10128 * Cancels the effect of a previous call to gtk_widget_push_composite_child().
10131 gtk_widget_pop_composite_child (void)
10133 if (composite_child_stack)
10134 composite_child_stack--;
10138 gtk_widget_emit_direction_changed (GtkWidget *widget,
10139 GtkTextDirection old_dir)
10141 gtk_widget_update_pango_context (widget);
10143 if (widget->priv->context)
10144 gtk_style_context_set_direction (widget->priv->context,
10145 gtk_widget_get_direction (widget));
10147 g_signal_emit (widget, widget_signals[DIRECTION_CHANGED], 0, old_dir);
10151 * gtk_widget_set_direction:
10152 * @widget: a #GtkWidget
10153 * @dir: the new direction
10155 * Sets the reading direction on a particular widget. This direction
10156 * controls the primary direction for widgets containing text,
10157 * and also the direction in which the children of a container are
10158 * packed. The ability to set the direction is present in order
10159 * so that correct localization into languages with right-to-left
10160 * reading directions can be done. Generally, applications will
10161 * let the default reading direction present, except for containers
10162 * where the containers are arranged in an order that is explicitely
10163 * visual rather than logical (such as buttons for text justification).
10165 * If the direction is set to %GTK_TEXT_DIR_NONE, then the value
10166 * set by gtk_widget_set_default_direction() will be used.
10169 gtk_widget_set_direction (GtkWidget *widget,
10170 GtkTextDirection dir)
10172 GtkTextDirection old_dir;
10174 g_return_if_fail (GTK_IS_WIDGET (widget));
10175 g_return_if_fail (dir >= GTK_TEXT_DIR_NONE && dir <= GTK_TEXT_DIR_RTL);
10177 old_dir = gtk_widget_get_direction (widget);
10179 widget->priv->direction = dir;
10181 if (old_dir != gtk_widget_get_direction (widget))
10182 gtk_widget_emit_direction_changed (widget, old_dir);
10186 * gtk_widget_get_direction:
10187 * @widget: a #GtkWidget
10189 * Gets the reading direction for a particular widget. See
10190 * gtk_widget_set_direction().
10192 * Return value: the reading direction for the widget.
10195 gtk_widget_get_direction (GtkWidget *widget)
10197 g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_TEXT_DIR_LTR);
10199 if (widget->priv->direction == GTK_TEXT_DIR_NONE)
10200 return gtk_default_direction;
10202 return widget->priv->direction;
10206 gtk_widget_set_default_direction_recurse (GtkWidget *widget, gpointer data)
10208 GtkTextDirection old_dir = GPOINTER_TO_UINT (data);
10210 g_object_ref (widget);
10212 if (widget->priv->direction == GTK_TEXT_DIR_NONE)
10213 gtk_widget_emit_direction_changed (widget, old_dir);
10215 if (GTK_IS_CONTAINER (widget))
10216 gtk_container_forall (GTK_CONTAINER (widget),
10217 gtk_widget_set_default_direction_recurse,
10220 g_object_unref (widget);
10224 * gtk_widget_set_default_direction:
10225 * @dir: the new default direction. This cannot be
10226 * %GTK_TEXT_DIR_NONE.
10228 * Sets the default reading direction for widgets where the
10229 * direction has not been explicitly set by gtk_widget_set_direction().
10232 gtk_widget_set_default_direction (GtkTextDirection dir)
10234 g_return_if_fail (dir == GTK_TEXT_DIR_RTL || dir == GTK_TEXT_DIR_LTR);
10236 if (dir != gtk_default_direction)
10238 GList *toplevels, *tmp_list;
10239 GtkTextDirection old_dir = gtk_default_direction;
10241 gtk_default_direction = dir;
10243 tmp_list = toplevels = gtk_window_list_toplevels ();
10244 g_list_foreach (toplevels, (GFunc)g_object_ref, NULL);
10248 gtk_widget_set_default_direction_recurse (tmp_list->data,
10249 GUINT_TO_POINTER (old_dir));
10250 g_object_unref (tmp_list->data);
10251 tmp_list = tmp_list->next;
10254 g_list_free (toplevels);
10259 * gtk_widget_get_default_direction:
10261 * Obtains the current default reading direction. See
10262 * gtk_widget_set_default_direction().
10264 * Return value: the current default direction.
10267 gtk_widget_get_default_direction (void)
10269 return gtk_default_direction;
10273 gtk_widget_constructed (GObject *object)
10275 GtkWidget *widget = GTK_WIDGET (object);
10276 GtkWidgetPrivate *priv = widget->priv;
10278 /* As strange as it may seem, this may happen on object construction.
10279 * init() implementations of parent types may eventually call this function,
10280 * each with its corresponding GType, which could leave a child
10281 * implementation with a wrong widget type in the widget path
10284 G_OBJECT_TYPE (widget) != gtk_widget_path_get_object_type (priv->path))
10286 gtk_widget_path_free (priv->path);
10290 G_OBJECT_CLASS (gtk_widget_parent_class)->constructed (object);
10294 gtk_widget_dispose (GObject *object)
10296 GtkWidget *widget = GTK_WIDGET (object);
10297 GtkWidgetPrivate *priv = widget->priv;
10300 gtk_container_remove (GTK_CONTAINER (priv->parent), widget);
10301 else if (gtk_widget_get_visible (widget))
10302 gtk_widget_hide (widget);
10304 priv->visible = FALSE;
10305 if (gtk_widget_get_realized (widget))
10306 gtk_widget_unrealize (widget);
10308 if (!priv->in_destruction)
10310 priv->in_destruction = TRUE;
10311 g_signal_emit (object, widget_signals[DESTROY], 0);
10312 priv->in_destruction = FALSE;
10315 g_clear_object (&priv->muxer);
10317 G_OBJECT_CLASS (gtk_widget_parent_class)->dispose (object);
10321 gtk_widget_real_destroy (GtkWidget *object)
10323 /* gtk_object_destroy() will already hold a refcount on object */
10324 GtkWidget *widget = GTK_WIDGET (object);
10325 GtkWidgetPrivate *priv = widget->priv;
10327 if (GTK_WIDGET_GET_CLASS (widget)->priv->accessible_type != GTK_TYPE_ACCESSIBLE)
10329 GtkAccessible *accessible = g_object_steal_qdata (G_OBJECT (widget), quark_accessible_object);
10333 gtk_accessible_set_widget (accessible, NULL);
10334 g_object_unref (accessible);
10338 /* wipe accelerator closures (keep order) */
10339 g_object_set_qdata (G_OBJECT (widget), quark_accel_path, NULL);
10340 g_object_set_qdata (G_OBJECT (widget), quark_accel_closures, NULL);
10342 /* Callers of add_mnemonic_label() should disconnect on ::destroy */
10343 g_object_set_qdata (G_OBJECT (widget), quark_mnemonic_labels, NULL);
10345 gtk_grab_remove (widget);
10348 g_object_unref (priv->style);
10349 priv->style = gtk_widget_get_default_style ();
10350 g_object_ref (priv->style);
10354 gtk_widget_finalize (GObject *object)
10356 GtkWidget *widget = GTK_WIDGET (object);
10357 GtkWidgetPrivate *priv = widget->priv;
10358 GtkWidgetAuxInfo *aux_info;
10359 GtkAccessible *accessible;
10361 gtk_grab_remove (widget);
10363 g_object_unref (priv->style);
10364 priv->style = NULL;
10366 g_free (priv->name);
10368 aux_info = gtk_widget_get_aux_info (widget, FALSE);
10370 gtk_widget_aux_info_destroy (aux_info);
10372 accessible = g_object_get_qdata (G_OBJECT (widget), quark_accessible_object);
10374 g_object_unref (accessible);
10377 gtk_widget_path_free (priv->path);
10381 _gtk_style_context_set_widget (priv->context, NULL);
10382 g_object_unref (priv->context);
10385 _gtk_size_request_cache_free (&priv->requests);
10387 if (g_object_is_floating (object))
10388 g_warning ("A floating object was finalized. This means that someone\n"
10389 "called g_object_unref() on an object that had only a floating\n"
10390 "reference; the initial floating reference is not owned by anyone\n"
10391 "and must be removed with g_object_ref_sink().");
10393 G_OBJECT_CLASS (gtk_widget_parent_class)->finalize (object);
10396 /*****************************************
10397 * gtk_widget_real_map:
10402 *****************************************/
10405 gtk_widget_real_map (GtkWidget *widget)
10407 GtkWidgetPrivate *priv = widget->priv;
10409 g_assert (gtk_widget_get_realized (widget));
10411 if (!gtk_widget_get_mapped (widget))
10413 gtk_widget_set_mapped (widget, TRUE);
10415 if (gtk_widget_get_has_window (widget))
10416 gdk_window_show (priv->window);
10420 /*****************************************
10421 * gtk_widget_real_unmap:
10426 *****************************************/
10429 gtk_widget_real_unmap (GtkWidget *widget)
10431 GtkWidgetPrivate *priv = widget->priv;
10433 if (gtk_widget_get_mapped (widget))
10435 gtk_widget_set_mapped (widget, FALSE);
10437 if (gtk_widget_get_has_window (widget))
10438 gdk_window_hide (priv->window);
10442 /*****************************************
10443 * gtk_widget_real_realize:
10448 *****************************************/
10451 gtk_widget_real_realize (GtkWidget *widget)
10453 GtkWidgetPrivate *priv = widget->priv;
10455 g_assert (!gtk_widget_get_has_window (widget));
10457 gtk_widget_set_realized (widget, TRUE);
10460 priv->window = gtk_widget_get_parent_window (widget);
10461 g_object_ref (priv->window);
10465 /*****************************************
10466 * gtk_widget_real_unrealize:
10471 *****************************************/
10474 gtk_widget_real_unrealize (GtkWidget *widget)
10476 GtkWidgetPrivate *priv = widget->priv;
10478 g_assert (!widget->priv->mapped);
10480 /* printf ("unrealizing %s\n", g_type_name (G_TYPE_FROM_INSTANCE (widget)));
10483 /* We must do unrealize child widget BEFORE container widget.
10484 * gdk_window_destroy() destroys specified xwindow and its sub-xwindows.
10485 * So, unrealizing container widget bofore its children causes the problem
10486 * (for example, gdk_ic_destroy () with destroyed window causes crash. )
10489 if (GTK_IS_CONTAINER (widget))
10490 gtk_container_forall (GTK_CONTAINER (widget),
10491 (GtkCallback) gtk_widget_unrealize,
10494 if (gtk_widget_get_has_window (widget))
10496 gdk_window_set_user_data (priv->window, NULL);
10497 gdk_window_destroy (priv->window);
10498 priv->window = NULL;
10502 g_object_unref (priv->window);
10503 priv->window = NULL;
10506 gtk_selection_remove_all (widget);
10508 gtk_widget_set_realized (widget, FALSE);
10512 gtk_widget_real_adjust_size_request (GtkWidget *widget,
10513 GtkOrientation orientation,
10514 gint *minimum_size,
10515 gint *natural_size)
10517 const GtkWidgetAuxInfo *aux_info;
10519 aux_info =_gtk_widget_get_aux_info_or_defaults (widget);
10521 if (orientation == GTK_ORIENTATION_HORIZONTAL &&
10522 aux_info->width > 0)
10524 *minimum_size = MAX (*minimum_size, aux_info->width);
10526 else if (orientation == GTK_ORIENTATION_VERTICAL &&
10527 aux_info->height > 0)
10529 *minimum_size = MAX (*minimum_size, aux_info->height);
10532 /* Fix it if set_size_request made natural size smaller than min size.
10533 * This would also silently fix broken widgets, but we warn about them
10534 * in gtksizerequest.c when calling their size request vfuncs.
10536 *natural_size = MAX (*natural_size, *minimum_size);
10538 if (orientation == GTK_ORIENTATION_HORIZONTAL)
10540 *minimum_size += (aux_info->margin.left + aux_info->margin.right);
10541 *natural_size += (aux_info->margin.left + aux_info->margin.right);
10545 *minimum_size += (aux_info->margin.top + aux_info->margin.bottom);
10546 *natural_size += (aux_info->margin.top + aux_info->margin.bottom);
10551 * _gtk_widget_peek_request_cache:
10553 * Returns the address of the widget's request cache (strictly for
10554 * internal use in gtksizerequest.c)
10556 * Return value: the address of @widget's size request cache.
10559 _gtk_widget_peek_request_cache (GtkWidget *widget)
10561 /* Don't bother slowing things down with the return_if_fail guards here */
10562 return &widget->priv->requests;
10566 * _gtk_widget_set_device_window:
10567 * @widget: a #GtkWidget
10568 * @device: a #GdkDevice
10569 * @window: the new device window
10571 * Sets pointer window for @widget and @device.
10572 * Does not ref @window.
10575 _gtk_widget_set_device_window (GtkWidget *widget,
10579 GHashTable *device_window;
10581 g_return_if_fail (GTK_IS_WIDGET (widget));
10582 g_return_if_fail (GDK_IS_DEVICE (device));
10583 g_return_if_fail (window == NULL || GDK_IS_WINDOW (window));
10585 if (!gtk_widget_get_mapped (widget))
10588 device_window = g_object_get_qdata (G_OBJECT (widget), quark_pointer_window);
10590 if (!device_window && window)
10592 device_window = g_hash_table_new (NULL, NULL);
10593 g_object_set_qdata_full (G_OBJECT (widget),
10594 quark_pointer_window,
10596 (GDestroyNotify) g_hash_table_destroy);
10600 g_hash_table_insert (device_window, device, window);
10601 else if (device_window)
10603 g_hash_table_remove (device_window, device);
10605 if (g_hash_table_size (device_window) == 0)
10606 g_object_set_qdata (G_OBJECT (widget), quark_pointer_window, NULL);
10611 * _gtk_widget_get_device_window:
10612 * @widget: a #GtkWidget
10613 * @device: a #GdkDevice
10615 * Return value: the device window set on @widget, or %NULL
10618 _gtk_widget_get_device_window (GtkWidget *widget,
10621 GHashTable *device_window;
10623 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10624 g_return_val_if_fail (GDK_IS_DEVICE (device), NULL);
10626 if (!gtk_widget_get_mapped (widget))
10629 device_window = g_object_get_qdata (G_OBJECT (widget), quark_pointer_window);
10631 if (!device_window)
10634 return g_hash_table_lookup (device_window, device);
10638 * _gtk_widget_list_devices:
10639 * @widget: a #GtkWidget
10641 * Returns the list of #GdkDevices that is currently on top
10642 * of any window belonging to @widget.
10643 * Free the list with g_list_free(), the elements are owned
10644 * by GTK+ and must not be freed.
10647 _gtk_widget_list_devices (GtkWidget *widget)
10649 GHashTableIter iter;
10650 GHashTable *device_window;
10651 GList *devices = NULL;
10652 gpointer key, value;
10654 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10656 if (!gtk_widget_get_mapped (widget))
10659 device_window = g_object_get_qdata (G_OBJECT (widget), quark_pointer_window);
10661 if (G_UNLIKELY (!device_window))
10664 g_hash_table_iter_init (&iter, device_window);
10666 while (g_hash_table_iter_next (&iter, &key, &value))
10667 devices = g_list_prepend (devices, key);
10673 synth_crossing (GtkWidget *widget,
10677 GdkCrossingMode mode,
10678 GdkNotifyType detail)
10682 event = gdk_event_new (type);
10684 event->crossing.window = g_object_ref (window);
10685 event->crossing.send_event = TRUE;
10686 event->crossing.subwindow = g_object_ref (window);
10687 event->crossing.time = GDK_CURRENT_TIME;
10688 event->crossing.x = event->crossing.y = 0;
10689 event->crossing.x_root = event->crossing.y_root = 0;
10690 event->crossing.mode = mode;
10691 event->crossing.detail = detail;
10692 event->crossing.focus = FALSE;
10693 event->crossing.state = 0;
10694 gdk_event_set_device (event, device);
10697 widget = gtk_get_event_widget (event);
10700 gtk_widget_event_internal (widget, event);
10702 gdk_event_free (event);
10706 * _gtk_widget_synthesize_crossing:
10707 * @from: the #GtkWidget the virtual pointer is leaving.
10708 * @to: the #GtkWidget the virtual pointer is moving to.
10709 * @mode: the #GdkCrossingMode to place on the synthesized events.
10711 * Generate crossing event(s) on widget state (sensitivity) or GTK+ grab change.
10713 * The real pointer window is the window that most recently received an enter notify
10714 * event. Windows that don't select for crossing events can't become the real
10715 * poiner window. The real pointer widget that owns the real pointer window. The
10716 * effective pointer window is the same as the real pointer window unless the real
10717 * pointer widget is either insensitive or there is a grab on a widget that is not
10718 * an ancestor of the real pointer widget (in which case the effective pointer
10719 * window should be the root window).
10721 * When the effective pointer window is the same as the real poiner window, we
10722 * receive crossing events from the windowing system. When the effective pointer
10723 * window changes to become different from the real pointer window we synthesize
10724 * crossing events, attempting to follow X protocol rules:
10726 * When the root window becomes the effective pointer window:
10727 * - leave notify on real pointer window, detail Ancestor
10728 * - leave notify on all of its ancestors, detail Virtual
10729 * - enter notify on root window, detail Inferior
10731 * When the root window ceases to be the effective pointer window:
10732 * - leave notify on root window, detail Inferior
10733 * - enter notify on all ancestors of real pointer window, detail Virtual
10734 * - enter notify on real pointer window, detail Ancestor
10737 _gtk_widget_synthesize_crossing (GtkWidget *from,
10740 GdkCrossingMode mode)
10742 GdkWindow *from_window = NULL, *to_window = NULL;
10744 g_return_if_fail (from != NULL || to != NULL);
10748 from_window = _gtk_widget_get_device_window (from, device);
10751 from_window = from->priv->window;
10756 to_window = _gtk_widget_get_device_window (to, device);
10759 to_window = to->priv->window;
10762 if (from_window == NULL && to_window == NULL)
10764 else if (from_window != NULL && to_window == NULL)
10766 GList *from_ancestors = NULL, *list;
10767 GdkWindow *from_ancestor = from_window;
10769 while (from_ancestor != NULL)
10771 from_ancestor = gdk_window_get_effective_parent (from_ancestor);
10772 if (from_ancestor == NULL)
10774 from_ancestors = g_list_prepend (from_ancestors, from_ancestor);
10777 synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
10778 device, mode, GDK_NOTIFY_ANCESTOR);
10779 for (list = g_list_last (from_ancestors); list; list = list->prev)
10781 synth_crossing (NULL, GDK_LEAVE_NOTIFY, (GdkWindow *) list->data,
10782 device, mode, GDK_NOTIFY_VIRTUAL);
10785 /* XXX: enter/inferior on root window? */
10787 g_list_free (from_ancestors);
10789 else if (from_window == NULL && to_window != NULL)
10791 GList *to_ancestors = NULL, *list;
10792 GdkWindow *to_ancestor = to_window;
10794 while (to_ancestor != NULL)
10796 to_ancestor = gdk_window_get_effective_parent (to_ancestor);
10797 if (to_ancestor == NULL)
10799 to_ancestors = g_list_prepend (to_ancestors, to_ancestor);
10802 /* XXX: leave/inferior on root window? */
10804 for (list = to_ancestors; list; list = list->next)
10806 synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
10807 device, mode, GDK_NOTIFY_VIRTUAL);
10809 synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
10810 device, mode, GDK_NOTIFY_ANCESTOR);
10812 g_list_free (to_ancestors);
10814 else if (from_window == to_window)
10818 GList *from_ancestors = NULL, *to_ancestors = NULL, *list;
10819 GdkWindow *from_ancestor = from_window, *to_ancestor = to_window;
10821 while (from_ancestor != NULL || to_ancestor != NULL)
10823 if (from_ancestor != NULL)
10825 from_ancestor = gdk_window_get_effective_parent (from_ancestor);
10826 if (from_ancestor == to_window)
10829 from_ancestors = g_list_prepend (from_ancestors, from_ancestor);
10831 if (to_ancestor != NULL)
10833 to_ancestor = gdk_window_get_effective_parent (to_ancestor);
10834 if (to_ancestor == from_window)
10837 to_ancestors = g_list_prepend (to_ancestors, to_ancestor);
10840 if (to_ancestor == from_window)
10842 if (mode != GDK_CROSSING_GTK_UNGRAB)
10843 synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
10844 device, mode, GDK_NOTIFY_INFERIOR);
10845 for (list = to_ancestors; list; list = list->next)
10846 synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
10847 device, mode, GDK_NOTIFY_VIRTUAL);
10848 synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
10849 device, mode, GDK_NOTIFY_ANCESTOR);
10851 else if (from_ancestor == to_window)
10853 synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
10854 device, mode, GDK_NOTIFY_ANCESTOR);
10855 for (list = g_list_last (from_ancestors); list; list = list->prev)
10857 synth_crossing (NULL, GDK_LEAVE_NOTIFY, (GdkWindow *) list->data,
10858 device, mode, GDK_NOTIFY_VIRTUAL);
10860 if (mode != GDK_CROSSING_GTK_GRAB)
10861 synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
10862 device, mode, GDK_NOTIFY_INFERIOR);
10866 while (from_ancestors != NULL && to_ancestors != NULL
10867 && from_ancestors->data == to_ancestors->data)
10869 from_ancestors = g_list_delete_link (from_ancestors,
10871 to_ancestors = g_list_delete_link (to_ancestors, to_ancestors);
10874 synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
10875 device, mode, GDK_NOTIFY_NONLINEAR);
10877 for (list = g_list_last (from_ancestors); list; list = list->prev)
10879 synth_crossing (NULL, GDK_LEAVE_NOTIFY, (GdkWindow *) list->data,
10880 device, mode, GDK_NOTIFY_NONLINEAR_VIRTUAL);
10882 for (list = to_ancestors; list; list = list->next)
10884 synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
10885 device, mode, GDK_NOTIFY_NONLINEAR_VIRTUAL);
10887 synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
10888 device, mode, GDK_NOTIFY_NONLINEAR);
10890 g_list_free (from_ancestors);
10891 g_list_free (to_ancestors);
10896 gtk_widget_propagate_state (GtkWidget *widget,
10897 GtkStateData *data)
10899 GtkWidgetPrivate *priv = widget->priv;
10900 GtkStateFlags new_flags, old_flags = priv->state_flags;
10901 GtkStateType old_state;
10903 old_state = gtk_widget_get_state (widget);
10905 switch (data->operation)
10907 case STATE_CHANGE_REPLACE:
10908 priv->state_flags = data->flags;
10910 case STATE_CHANGE_SET:
10911 priv->state_flags |= data->flags;
10913 case STATE_CHANGE_UNSET:
10914 priv->state_flags &= ~(data->flags);
10918 /* make insensitivity unoverridable */
10919 if (!priv->sensitive)
10920 priv->state_flags |= GTK_STATE_FLAG_INSENSITIVE;
10922 if (gtk_widget_is_focus (widget) && !gtk_widget_is_sensitive (widget))
10926 window = gtk_widget_get_toplevel (widget);
10928 if (window && gtk_widget_is_toplevel (window))
10929 gtk_window_set_focus (GTK_WINDOW (window), NULL);
10932 new_flags = priv->state_flags;
10934 if (old_flags != new_flags)
10936 g_object_ref (widget);
10938 if (!gtk_widget_is_sensitive (widget) && gtk_widget_has_grab (widget))
10939 gtk_grab_remove (widget);
10941 gtk_style_context_set_state (gtk_widget_get_style_context (widget), new_flags);
10943 g_signal_emit (widget, widget_signals[STATE_CHANGED], 0, old_state);
10944 g_signal_emit (widget, widget_signals[STATE_FLAGS_CHANGED], 0, old_flags);
10946 if (!priv->shadowed &&
10947 (new_flags & GTK_STATE_FLAG_INSENSITIVE) != (old_flags & GTK_STATE_FLAG_INSENSITIVE))
10949 GList *event_windows = NULL;
10950 GList *devices, *d;
10952 devices = _gtk_widget_list_devices (widget);
10954 for (d = devices; d; d = d->next)
10960 window = _gtk_widget_get_device_window (widget, device);
10962 /* Do not propagate more than once to the
10963 * same window if non-multidevice aware.
10965 if (!gdk_window_get_support_multidevice (window) &&
10966 g_list_find (event_windows, window))
10969 if (!gtk_widget_is_sensitive (widget))
10970 _gtk_widget_synthesize_crossing (widget, NULL, d->data,
10971 GDK_CROSSING_STATE_CHANGED);
10973 _gtk_widget_synthesize_crossing (NULL, widget, d->data,
10974 GDK_CROSSING_STATE_CHANGED);
10976 event_windows = g_list_prepend (event_windows, window);
10979 g_list_free (event_windows);
10980 g_list_free (devices);
10983 if (GTK_IS_CONTAINER (widget))
10985 GtkStateData child_data = *data;
10987 /* Make sure to only propate the right states further */
10988 child_data.flags &= GTK_STATE_FLAGS_DO_PROPAGATE;
10990 gtk_container_forall (GTK_CONTAINER (widget),
10991 (GtkCallback) gtk_widget_propagate_state,
10995 g_object_unref (widget);
10999 static const GtkWidgetAuxInfo default_aux_info = {
11007 * gtk_widget_get_aux_info:
11008 * @widget: a #GtkWidget
11009 * @create: if %TRUE, create the structure if it doesn't exist
11011 * Get the #GtkWidgetAuxInfo structure for the widget.
11013 * Return value: the #GtkAuxInfo structure for the widget, or
11014 * %NULL if @create is %FALSE and one doesn't already exist.
11016 static GtkWidgetAuxInfo *
11017 gtk_widget_get_aux_info (GtkWidget *widget,
11020 GtkWidgetAuxInfo *aux_info;
11022 aux_info = g_object_get_qdata (G_OBJECT (widget), quark_aux_info);
11023 if (!aux_info && create)
11025 aux_info = g_slice_new0 (GtkWidgetAuxInfo);
11027 *aux_info = default_aux_info;
11029 g_object_set_qdata (G_OBJECT (widget), quark_aux_info, aux_info);
11035 static const GtkWidgetAuxInfo*
11036 _gtk_widget_get_aux_info_or_defaults (GtkWidget *widget)
11038 GtkWidgetAuxInfo *aux_info;
11040 aux_info = gtk_widget_get_aux_info (widget, FALSE);
11041 if (aux_info == NULL)
11043 return &default_aux_info;
11051 /*****************************************
11052 * gtk_widget_aux_info_destroy:
11057 *****************************************/
11060 gtk_widget_aux_info_destroy (GtkWidgetAuxInfo *aux_info)
11062 g_slice_free (GtkWidgetAuxInfo, aux_info);
11066 * gtk_widget_shape_combine_region:
11067 * @widget: a #GtkWidget
11068 * @region: (allow-none): shape to be added, or %NULL to remove an existing shape
11070 * Sets a shape for this widget's GDK window. This allows for
11071 * transparent windows etc., see gdk_window_shape_combine_region()
11072 * for more information.
11077 gtk_widget_shape_combine_region (GtkWidget *widget,
11078 cairo_region_t *region)
11080 GtkWidgetPrivate *priv;
11082 g_return_if_fail (GTK_IS_WIDGET (widget));
11083 /* set_shape doesn't work on widgets without gdk window */
11084 g_return_if_fail (gtk_widget_get_has_window (widget));
11086 priv = widget->priv;
11088 if (region == NULL)
11090 priv->has_shape_mask = FALSE;
11093 gdk_window_shape_combine_region (priv->window, NULL, 0, 0);
11095 g_object_set_qdata (G_OBJECT (widget), quark_shape_info, NULL);
11099 priv->has_shape_mask = TRUE;
11101 g_object_set_qdata_full (G_OBJECT (widget), quark_shape_info,
11102 cairo_region_copy (region),
11103 (GDestroyNotify) cairo_region_destroy);
11105 /* set shape if widget has a gdk window already.
11106 * otherwise the shape is scheduled to be set by gtk_widget_realize().
11109 gdk_window_shape_combine_region (priv->window, region, 0, 0);
11114 * gtk_widget_input_shape_combine_region:
11115 * @widget: a #GtkWidget
11116 * @region: (allow-none): shape to be added, or %NULL to remove an existing shape
11118 * Sets an input shape for this widget's GDK window. This allows for
11119 * windows which react to mouse click in a nonrectangular region, see
11120 * gdk_window_input_shape_combine_region() for more information.
11125 gtk_widget_input_shape_combine_region (GtkWidget *widget,
11126 cairo_region_t *region)
11128 GtkWidgetPrivate *priv;
11130 g_return_if_fail (GTK_IS_WIDGET (widget));
11131 /* set_shape doesn't work on widgets without gdk window */
11132 g_return_if_fail (gtk_widget_get_has_window (widget));
11134 priv = widget->priv;
11136 if (region == NULL)
11139 gdk_window_input_shape_combine_region (priv->window, NULL, 0, 0);
11141 g_object_set_qdata (G_OBJECT (widget), quark_input_shape_info, NULL);
11145 g_object_set_qdata_full (G_OBJECT (widget), quark_input_shape_info,
11146 cairo_region_copy (region),
11147 (GDestroyNotify) cairo_region_destroy);
11149 /* set shape if widget has a gdk window already.
11150 * otherwise the shape is scheduled to be set by gtk_widget_realize().
11153 gdk_window_input_shape_combine_region (priv->window, region, 0, 0);
11158 /* style properties
11162 * gtk_widget_class_install_style_property_parser: (skip)
11163 * @klass: a #GtkWidgetClass
11164 * @pspec: the #GParamSpec for the style property
11165 * @parser: the parser for the style property
11167 * Installs a style property on a widget class.
11170 gtk_widget_class_install_style_property_parser (GtkWidgetClass *klass,
11172 GtkRcPropertyParser parser)
11174 g_return_if_fail (GTK_IS_WIDGET_CLASS (klass));
11175 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
11176 g_return_if_fail (pspec->flags & G_PARAM_READABLE);
11177 g_return_if_fail (!(pspec->flags & (G_PARAM_CONSTRUCT_ONLY | G_PARAM_CONSTRUCT)));
11179 if (g_param_spec_pool_lookup (style_property_spec_pool, pspec->name, G_OBJECT_CLASS_TYPE (klass), FALSE))
11181 g_warning (G_STRLOC ": class `%s' already contains a style property named `%s'",
11182 G_OBJECT_CLASS_NAME (klass),
11187 g_param_spec_ref_sink (pspec);
11188 g_param_spec_set_qdata (pspec, quark_property_parser, (gpointer) parser);
11189 g_param_spec_pool_insert (style_property_spec_pool, pspec, G_OBJECT_CLASS_TYPE (klass));
11193 * gtk_widget_class_install_style_property:
11194 * @klass: a #GtkWidgetClass
11195 * @pspec: the #GParamSpec for the property
11197 * Installs a style property on a widget class. The parser for the
11198 * style property is determined by the value type of @pspec.
11201 gtk_widget_class_install_style_property (GtkWidgetClass *klass,
11204 GtkRcPropertyParser parser;
11206 g_return_if_fail (GTK_IS_WIDGET_CLASS (klass));
11207 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
11209 parser = _gtk_rc_property_parser_from_type (G_PARAM_SPEC_VALUE_TYPE (pspec));
11211 gtk_widget_class_install_style_property_parser (klass, pspec, parser);
11215 * gtk_widget_class_find_style_property:
11216 * @klass: a #GtkWidgetClass
11217 * @property_name: the name of the style property to find
11219 * Finds a style property of a widget class by name.
11221 * Returns: (transfer none): the #GParamSpec of the style property or
11222 * %NULL if @class has no style property with that name.
11227 gtk_widget_class_find_style_property (GtkWidgetClass *klass,
11228 const gchar *property_name)
11230 g_return_val_if_fail (property_name != NULL, NULL);
11232 return g_param_spec_pool_lookup (style_property_spec_pool,
11234 G_OBJECT_CLASS_TYPE (klass),
11239 * gtk_widget_class_list_style_properties:
11240 * @klass: a #GtkWidgetClass
11241 * @n_properties: location to return the number of style properties found
11243 * Returns all style properties of a widget class.
11245 * Returns: (array length=n_properties) (transfer container): a
11246 * newly allocated array of #GParamSpec*. The array must be
11247 * freed with g_free().
11252 gtk_widget_class_list_style_properties (GtkWidgetClass *klass,
11253 guint *n_properties)
11255 GParamSpec **pspecs;
11258 pspecs = g_param_spec_pool_list (style_property_spec_pool,
11259 G_OBJECT_CLASS_TYPE (klass),
11268 * gtk_widget_style_get_property:
11269 * @widget: a #GtkWidget
11270 * @property_name: the name of a style property
11271 * @value: location to return the property value
11273 * Gets the value of a style property of @widget.
11276 gtk_widget_style_get_property (GtkWidget *widget,
11277 const gchar *property_name,
11282 g_return_if_fail (GTK_IS_WIDGET (widget));
11283 g_return_if_fail (property_name != NULL);
11284 g_return_if_fail (G_IS_VALUE (value));
11286 g_object_ref (widget);
11287 pspec = g_param_spec_pool_lookup (style_property_spec_pool,
11289 G_OBJECT_TYPE (widget),
11292 g_warning ("%s: widget class `%s' has no property named `%s'",
11294 G_OBJECT_TYPE_NAME (widget),
11298 GtkStyleContext *context;
11299 const GValue *peek_value;
11300 GtkStateFlags state;
11302 context = gtk_widget_get_style_context (widget);
11303 state = gtk_widget_get_state_flags (widget);
11305 peek_value = _gtk_style_context_peek_style_property (context,
11306 G_OBJECT_TYPE (widget),
11309 /* auto-conversion of the caller's value type
11311 if (G_VALUE_TYPE (value) == G_PARAM_SPEC_VALUE_TYPE (pspec))
11312 g_value_copy (peek_value, value);
11313 else if (g_value_type_transformable (G_PARAM_SPEC_VALUE_TYPE (pspec), G_VALUE_TYPE (value)))
11314 g_value_transform (peek_value, value);
11316 g_warning ("can't retrieve style property `%s' of type `%s' as value of type `%s'",
11318 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
11319 G_VALUE_TYPE_NAME (value));
11321 g_object_unref (widget);
11325 * gtk_widget_style_get_valist:
11326 * @widget: a #GtkWidget
11327 * @first_property_name: the name of the first property to get
11328 * @var_args: a <type>va_list</type> of pairs of property names and
11329 * locations to return the property values, starting with the location
11330 * for @first_property_name.
11332 * Non-vararg variant of gtk_widget_style_get(). Used primarily by language
11336 gtk_widget_style_get_valist (GtkWidget *widget,
11337 const gchar *first_property_name,
11340 GtkStyleContext *context;
11341 GtkStateFlags state;
11344 g_return_if_fail (GTK_IS_WIDGET (widget));
11346 g_object_ref (widget);
11347 context = gtk_widget_get_style_context (widget);
11348 state = gtk_widget_get_state_flags (widget);
11350 name = first_property_name;
11353 const GValue *peek_value;
11357 pspec = g_param_spec_pool_lookup (style_property_spec_pool,
11359 G_OBJECT_TYPE (widget),
11363 g_warning ("%s: widget class `%s' has no property named `%s'",
11365 G_OBJECT_TYPE_NAME (widget),
11369 /* style pspecs are always readable so we can spare that check here */
11371 peek_value = _gtk_style_context_peek_style_property (context,
11372 G_OBJECT_TYPE (widget),
11375 G_VALUE_LCOPY (peek_value, var_args, 0, &error);
11378 g_warning ("%s: %s", G_STRLOC, error);
11383 name = va_arg (var_args, gchar*);
11386 g_object_unref (widget);
11390 * gtk_widget_style_get:
11391 * @widget: a #GtkWidget
11392 * @first_property_name: the name of the first property to get
11393 * @...: pairs of property names and locations to return the
11394 * property values, starting with the location for
11395 * @first_property_name, terminated by %NULL.
11397 * Gets the values of a multiple style properties of @widget.
11400 gtk_widget_style_get (GtkWidget *widget,
11401 const gchar *first_property_name,
11406 g_return_if_fail (GTK_IS_WIDGET (widget));
11408 va_start (var_args, first_property_name);
11409 gtk_widget_style_get_valist (widget, first_property_name, var_args);
11414 * gtk_requisition_new:
11416 * Allocates a new #GtkRequisition structure and initializes its elements to zero.
11418 * Returns: a new empty #GtkRequisition. The newly allocated #GtkRequisition should
11419 * be freed with gtk_requisition_free().
11424 gtk_requisition_new (void)
11426 return g_slice_new0 (GtkRequisition);
11430 * gtk_requisition_copy:
11431 * @requisition: a #GtkRequisition
11433 * Copies a #GtkRequisition.
11435 * Returns: a copy of @requisition
11438 gtk_requisition_copy (const GtkRequisition *requisition)
11440 return g_slice_dup (GtkRequisition, requisition);
11444 * gtk_requisition_free:
11445 * @requisition: a #GtkRequisition
11447 * Frees a #GtkRequisition.
11450 gtk_requisition_free (GtkRequisition *requisition)
11452 g_slice_free (GtkRequisition, requisition);
11455 G_DEFINE_BOXED_TYPE (GtkRequisition, gtk_requisition,
11456 gtk_requisition_copy,
11457 gtk_requisition_free)
11460 * gtk_widget_class_set_accessible_type:
11461 * @widget_class: class to set the accessible type for
11462 * @type: The object type that implements the accessible for @widget_class
11464 * Sets the type to be used for creating accessibles for widgets of
11465 * @widget_class. The given @type must be a subtype of the type used for
11466 * accessibles of the parent class.
11468 * This function should only be called from class init functions of widgets.
11473 gtk_widget_class_set_accessible_type (GtkWidgetClass *widget_class,
11476 GtkWidgetClassPrivate *priv;
11478 g_return_if_fail (GTK_IS_WIDGET_CLASS (widget_class));
11479 g_return_if_fail (g_type_is_a (type, widget_class->priv->accessible_type));
11481 priv = widget_class->priv;
11483 priv->accessible_type = type;
11484 /* reset this - honoring the type's role is better. */
11485 priv->accessible_role = ATK_ROLE_INVALID;
11489 * gtk_widget_class_set_accessible_role:
11490 * @widget_class: class to set the accessible role for
11491 * @role: The role to use for accessibles created for @widget_class
11493 * Sets the default #AtkRole to be set on accessibles created for
11494 * widgets of @widget_class. Accessibles may decide to not honor this
11495 * setting if their role reporting is more refined. Calls to
11496 * gtk_widget_class_set_accessible_type() will reset this value.
11498 * In cases where you want more fine-grained control over the role of
11499 * accessibles created for @widget_class, you should provide your own
11500 * accessible type and use gtk_widget_class_set_accessible_type()
11503 * If @role is #ATK_ROLE_INVALID, the default role will not be changed
11504 * and the accessible's default role will be used instead.
11506 * This function should only be called from class init functions of widgets.
11511 gtk_widget_class_set_accessible_role (GtkWidgetClass *widget_class,
11514 GtkWidgetClassPrivate *priv;
11516 g_return_if_fail (GTK_IS_WIDGET_CLASS (widget_class));
11518 priv = widget_class->priv;
11520 priv->accessible_role = role;
11524 * _gtk_widget_peek_accessible:
11525 * @widget: a #GtkWidget
11527 * Gets the accessible for @widget, if it has been created yet.
11528 * Otherwise, this function returns %NULL. If the @widget's implementation
11529 * does not use the default way to create accessibles, %NULL will always be
11532 * Returns: the accessible for @widget or %NULL if none has been
11536 _gtk_widget_peek_accessible (GtkWidget *widget)
11538 return g_object_get_qdata (G_OBJECT (widget),
11539 quark_accessible_object);
11543 * gtk_widget_get_accessible:
11544 * @widget: a #GtkWidget
11546 * Returns the accessible object that describes the widget to an
11547 * assistive technology.
11549 * If accessibility support is not available, this #AtkObject
11550 * instance may be a no-op. Likewise, if no class-specific #AtkObject
11551 * implementation is available for the widget instance in question,
11552 * it will inherit an #AtkObject implementation from the first ancestor
11553 * class for which such an implementation is defined.
11555 * The documentation of the
11556 * <ulink url="http://developer.gnome.org/atk/stable/">ATK</ulink>
11557 * library contains more information about accessible objects and their uses.
11559 * Returns: (transfer none): the #AtkObject associated with @widget
11562 gtk_widget_get_accessible (GtkWidget *widget)
11564 GtkWidgetClass *klass;
11566 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
11568 klass = GTK_WIDGET_GET_CLASS (widget);
11570 g_return_val_if_fail (klass->get_accessible != NULL, NULL);
11572 return klass->get_accessible (widget);
11576 gtk_widget_real_get_accessible (GtkWidget *widget)
11578 AtkObject* accessible;
11580 accessible = g_object_get_qdata (G_OBJECT (widget),
11581 quark_accessible_object);
11584 GtkWidgetClass *widget_class;
11585 GtkWidgetClassPrivate *priv;
11586 AtkObjectFactory *factory;
11587 AtkRegistry *default_registry;
11589 widget_class = GTK_WIDGET_GET_CLASS (widget);
11590 priv = widget_class->priv;
11592 if (priv->accessible_type == GTK_TYPE_ACCESSIBLE)
11594 default_registry = atk_get_default_registry ();
11595 factory = atk_registry_get_factory (default_registry,
11596 G_TYPE_FROM_INSTANCE (widget));
11598 atk_object_factory_create_accessible (factory,
11599 G_OBJECT (widget));
11601 if (priv->accessible_role != ATK_ROLE_INVALID)
11602 atk_object_set_role (accessible, priv->accessible_role);
11604 g_object_set_qdata (G_OBJECT (widget),
11605 quark_accessible_object,
11610 accessible = g_object_new (priv->accessible_type,
11613 if (priv->accessible_role != ATK_ROLE_INVALID)
11614 atk_object_set_role (accessible, priv->accessible_role);
11616 g_object_set_qdata (G_OBJECT (widget),
11617 quark_accessible_object,
11620 atk_object_initialize (accessible, widget);
11622 /* Set the role again, since we don't want a role set
11623 * in some parent initialize() function to override
11626 if (priv->accessible_role != ATK_ROLE_INVALID)
11627 atk_object_set_role (accessible, priv->accessible_role);
11634 * Initialize a AtkImplementorIface instance's virtual pointers as
11635 * appropriate to this implementor's class (GtkWidget).
11638 gtk_widget_accessible_interface_init (AtkImplementorIface *iface)
11640 iface->ref_accessible = gtk_widget_ref_accessible;
11644 gtk_widget_ref_accessible (AtkImplementor *implementor)
11646 AtkObject *accessible;
11648 accessible = gtk_widget_get_accessible (GTK_WIDGET (implementor));
11650 g_object_ref (accessible);
11655 * Expand flag management
11659 gtk_widget_update_computed_expand (GtkWidget *widget)
11661 GtkWidgetPrivate *priv;
11663 priv = widget->priv;
11665 if (priv->need_compute_expand)
11669 if (priv->hexpand_set)
11674 if (priv->vexpand_set)
11679 /* we don't need to use compute_expand if both expands are
11680 * forced by the app
11682 if (!(priv->hexpand_set && priv->vexpand_set))
11684 if (GTK_WIDGET_GET_CLASS (widget)->compute_expand != NULL)
11688 GTK_WIDGET_GET_CLASS (widget)->compute_expand (widget,
11689 priv->hexpand_set ? &ignored : &h,
11690 priv->vexpand_set ? &ignored : &v);
11694 priv->need_compute_expand = FALSE;
11695 priv->computed_hexpand = h != FALSE;
11696 priv->computed_vexpand = v != FALSE;
11701 * gtk_widget_queue_compute_expand:
11702 * @widget: a #GtkWidget
11704 * Mark @widget as needing to recompute its expand flags. Call
11705 * this function when setting legacy expand child properties
11706 * on the child of a container.
11708 * See gtk_widget_compute_expand().
11711 gtk_widget_queue_compute_expand (GtkWidget *widget)
11714 gboolean changed_anything;
11716 if (widget->priv->need_compute_expand)
11719 changed_anything = FALSE;
11721 while (parent != NULL)
11723 if (!parent->priv->need_compute_expand)
11725 parent->priv->need_compute_expand = TRUE;
11726 changed_anything = TRUE;
11729 /* Note: if we had an invariant that "if a child needs to
11730 * compute expand, its parents also do" then we could stop going
11731 * up when we got to a parent that already needed to
11732 * compute. However, in general we compute expand lazily (as
11733 * soon as we see something in a subtree that is expand, we know
11734 * we're expanding) and so this invariant does not hold and we
11735 * have to always walk all the way up in case some ancestor
11736 * is not currently need_compute_expand.
11739 parent = parent->priv->parent;
11742 /* recomputing expand always requires
11743 * a relayout as well
11745 if (changed_anything)
11746 gtk_widget_queue_resize (widget);
11750 * gtk_widget_compute_expand:
11751 * @widget: the widget
11752 * @orientation: expand direction
11754 * Computes whether a container should give this widget extra space
11755 * when possible. Containers should check this, rather than
11756 * looking at gtk_widget_get_hexpand() or gtk_widget_get_vexpand().
11758 * This function already checks whether the widget is visible, so
11759 * visibility does not need to be checked separately. Non-visible
11760 * widgets are not expanded.
11762 * The computed expand value uses either the expand setting explicitly
11763 * set on the widget itself, or, if none has been explicitly set,
11764 * the widget may expand if some of its children do.
11766 * Return value: whether widget tree rooted here should be expanded
11769 gtk_widget_compute_expand (GtkWidget *widget,
11770 GtkOrientation orientation)
11772 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
11774 /* We never make a widget expand if not even showing. */
11775 if (!gtk_widget_get_visible (widget))
11778 gtk_widget_update_computed_expand (widget);
11780 if (orientation == GTK_ORIENTATION_HORIZONTAL)
11782 return widget->priv->computed_hexpand;
11786 return widget->priv->computed_vexpand;
11791 gtk_widget_set_expand (GtkWidget *widget,
11792 GtkOrientation orientation,
11795 const char *expand_prop;
11796 const char *expand_set_prop;
11798 GtkWidgetPrivate *priv;
11800 g_return_if_fail (GTK_IS_WIDGET (widget));
11802 priv = widget->priv;
11804 expand = expand != FALSE;
11806 was_both = priv->hexpand && priv->vexpand;
11808 if (orientation == GTK_ORIENTATION_HORIZONTAL)
11810 if (priv->hexpand_set &&
11811 priv->hexpand == expand)
11814 priv->hexpand_set = TRUE;
11815 priv->hexpand = expand;
11817 expand_prop = "hexpand";
11818 expand_set_prop = "hexpand-set";
11822 if (priv->vexpand_set &&
11823 priv->vexpand == expand)
11826 priv->vexpand_set = TRUE;
11827 priv->vexpand = expand;
11829 expand_prop = "vexpand";
11830 expand_set_prop = "vexpand-set";
11833 gtk_widget_queue_compute_expand (widget);
11835 g_object_freeze_notify (G_OBJECT (widget));
11836 g_object_notify (G_OBJECT (widget), expand_prop);
11837 g_object_notify (G_OBJECT (widget), expand_set_prop);
11838 if (was_both != (priv->hexpand && priv->vexpand))
11839 g_object_notify (G_OBJECT (widget), "expand");
11840 g_object_thaw_notify (G_OBJECT (widget));
11844 gtk_widget_set_expand_set (GtkWidget *widget,
11845 GtkOrientation orientation,
11848 GtkWidgetPrivate *priv;
11851 priv = widget->priv;
11853 set = set != FALSE;
11855 if (orientation == GTK_ORIENTATION_HORIZONTAL)
11857 if (set == priv->hexpand_set)
11860 priv->hexpand_set = set;
11861 prop = "hexpand-set";
11865 if (set == priv->vexpand_set)
11868 priv->vexpand_set = set;
11869 prop = "vexpand-set";
11872 gtk_widget_queue_compute_expand (widget);
11874 g_object_notify (G_OBJECT (widget), prop);
11878 * gtk_widget_get_hexpand:
11879 * @widget: the widget
11881 * Gets whether the widget would like any available extra horizontal
11882 * space. When a user resizes a #GtkWindow, widgets with expand=TRUE
11883 * generally receive the extra space. For example, a list or
11884 * scrollable area or document in your window would often be set to
11887 * Containers should use gtk_widget_compute_expand() rather than
11888 * this function, to see whether a widget, or any of its children,
11889 * has the expand flag set. If any child of a widget wants to
11890 * expand, the parent may ask to expand also.
11892 * This function only looks at the widget's own hexpand flag, rather
11893 * than computing whether the entire widget tree rooted at this widget
11896 * Return value: whether hexpand flag is set
11899 gtk_widget_get_hexpand (GtkWidget *widget)
11901 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
11903 return widget->priv->hexpand;
11907 * gtk_widget_set_hexpand:
11908 * @widget: the widget
11909 * @expand: whether to expand
11911 * Sets whether the widget would like any available extra horizontal
11912 * space. When a user resizes a #GtkWindow, widgets with expand=TRUE
11913 * generally receive the extra space. For example, a list or
11914 * scrollable area or document in your window would often be set to
11917 * Call this function to set the expand flag if you would like your
11918 * widget to become larger horizontally when the window has extra
11921 * By default, widgets automatically expand if any of their children
11922 * want to expand. (To see if a widget will automatically expand given
11923 * its current children and state, call gtk_widget_compute_expand(). A
11924 * container can decide how the expandability of children affects the
11925 * expansion of the container by overriding the compute_expand virtual
11926 * method on #GtkWidget.).
11928 * Setting hexpand explicitly with this function will override the
11929 * automatic expand behavior.
11931 * This function forces the widget to expand or not to expand,
11932 * regardless of children. The override occurs because
11933 * gtk_widget_set_hexpand() sets the hexpand-set property (see
11934 * gtk_widget_set_hexpand_set()) which causes the widget's hexpand
11935 * value to be used, rather than looking at children and widget state.
11938 gtk_widget_set_hexpand (GtkWidget *widget,
11941 g_return_if_fail (GTK_IS_WIDGET (widget));
11943 gtk_widget_set_expand (widget, GTK_ORIENTATION_HORIZONTAL, expand);
11947 * gtk_widget_get_hexpand_set:
11948 * @widget: the widget
11950 * Gets whether gtk_widget_set_hexpand() has been used to
11951 * explicitly set the expand flag on this widget.
11953 * If hexpand is set, then it overrides any computed
11954 * expand value based on child widgets. If hexpand is not
11955 * set, then the expand value depends on whether any
11956 * children of the widget would like to expand.
11958 * There are few reasons to use this function, but it's here
11959 * for completeness and consistency.
11961 * Return value: whether hexpand has been explicitly set
11964 gtk_widget_get_hexpand_set (GtkWidget *widget)
11966 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
11968 return widget->priv->hexpand_set;
11972 * gtk_widget_set_hexpand_set:
11973 * @widget: the widget
11974 * @set: value for hexpand-set property
11976 * Sets whether the hexpand flag (see gtk_widget_get_hexpand()) will
11979 * The hexpand-set property will be set automatically when you call
11980 * gtk_widget_set_hexpand() to set hexpand, so the most likely
11981 * reason to use this function would be to unset an explicit expand
11984 * If hexpand is set, then it overrides any computed
11985 * expand value based on child widgets. If hexpand is not
11986 * set, then the expand value depends on whether any
11987 * children of the widget would like to expand.
11989 * There are few reasons to use this function, but it's here
11990 * for completeness and consistency.
11993 gtk_widget_set_hexpand_set (GtkWidget *widget,
11996 g_return_if_fail (GTK_IS_WIDGET (widget));
11998 gtk_widget_set_expand_set (widget, GTK_ORIENTATION_HORIZONTAL, set);
12003 * gtk_widget_get_vexpand:
12004 * @widget: the widget
12006 * Gets whether the widget would like any available extra vertical
12009 * See gtk_widget_get_hexpand() for more detail.
12011 * Return value: whether vexpand flag is set
12014 gtk_widget_get_vexpand (GtkWidget *widget)
12016 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
12018 return widget->priv->vexpand;
12022 * gtk_widget_set_vexpand:
12023 * @widget: the widget
12024 * @expand: whether to expand
12026 * Sets whether the widget would like any available extra vertical
12029 * See gtk_widget_set_hexpand() for more detail.
12032 gtk_widget_set_vexpand (GtkWidget *widget,
12035 g_return_if_fail (GTK_IS_WIDGET (widget));
12037 gtk_widget_set_expand (widget, GTK_ORIENTATION_VERTICAL, expand);
12041 * gtk_widget_get_vexpand_set:
12042 * @widget: the widget
12044 * Gets whether gtk_widget_set_vexpand() has been used to
12045 * explicitly set the expand flag on this widget.
12047 * See gtk_widget_get_hexpand_set() for more detail.
12049 * Return value: whether vexpand has been explicitly set
12052 gtk_widget_get_vexpand_set (GtkWidget *widget)
12054 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
12056 return widget->priv->vexpand_set;
12060 * gtk_widget_set_vexpand_set:
12061 * @widget: the widget
12062 * @set: value for vexpand-set property
12064 * Sets whether the vexpand flag (see gtk_widget_get_vexpand()) will
12067 * See gtk_widget_set_hexpand_set() for more detail.
12070 gtk_widget_set_vexpand_set (GtkWidget *widget,
12073 g_return_if_fail (GTK_IS_WIDGET (widget));
12075 gtk_widget_set_expand_set (widget, GTK_ORIENTATION_VERTICAL, set);
12079 * GtkBuildable implementation
12081 static GQuark quark_builder_has_default = 0;
12082 static GQuark quark_builder_has_focus = 0;
12083 static GQuark quark_builder_atk_relations = 0;
12084 static GQuark quark_builder_set_name = 0;
12087 gtk_widget_buildable_interface_init (GtkBuildableIface *iface)
12089 quark_builder_has_default = g_quark_from_static_string ("gtk-builder-has-default");
12090 quark_builder_has_focus = g_quark_from_static_string ("gtk-builder-has-focus");
12091 quark_builder_atk_relations = g_quark_from_static_string ("gtk-builder-atk-relations");
12092 quark_builder_set_name = g_quark_from_static_string ("gtk-builder-set-name");
12094 iface->set_name = gtk_widget_buildable_set_name;
12095 iface->get_name = gtk_widget_buildable_get_name;
12096 iface->get_internal_child = gtk_widget_buildable_get_internal_child;
12097 iface->set_buildable_property = gtk_widget_buildable_set_buildable_property;
12098 iface->parser_finished = gtk_widget_buildable_parser_finished;
12099 iface->custom_tag_start = gtk_widget_buildable_custom_tag_start;
12100 iface->custom_finished = gtk_widget_buildable_custom_finished;
12104 gtk_widget_buildable_set_name (GtkBuildable *buildable,
12107 g_object_set_qdata_full (G_OBJECT (buildable), quark_builder_set_name,
12108 g_strdup (name), g_free);
12111 static const gchar *
12112 gtk_widget_buildable_get_name (GtkBuildable *buildable)
12114 return g_object_get_qdata (G_OBJECT (buildable), quark_builder_set_name);
12118 gtk_widget_buildable_get_internal_child (GtkBuildable *buildable,
12119 GtkBuilder *builder,
12120 const gchar *childname)
12122 if (strcmp (childname, "accessible") == 0)
12123 return G_OBJECT (gtk_widget_get_accessible (GTK_WIDGET (buildable)));
12129 gtk_widget_buildable_set_buildable_property (GtkBuildable *buildable,
12130 GtkBuilder *builder,
12132 const GValue *value)
12134 if (strcmp (name, "has-default") == 0 && g_value_get_boolean (value))
12135 g_object_set_qdata (G_OBJECT (buildable), quark_builder_has_default,
12136 GINT_TO_POINTER (TRUE));
12137 else if (strcmp (name, "has-focus") == 0 && g_value_get_boolean (value))
12138 g_object_set_qdata (G_OBJECT (buildable), quark_builder_has_focus,
12139 GINT_TO_POINTER (TRUE));
12141 g_object_set_property (G_OBJECT (buildable), name, value);
12146 gchar *action_name;
12147 GString *description;
12149 gboolean translatable;
12159 free_action (AtkActionData *data, gpointer user_data)
12161 g_free (data->action_name);
12162 g_string_free (data->description, TRUE);
12163 g_free (data->context);
12164 g_slice_free (AtkActionData, data);
12168 free_relation (AtkRelationData *data, gpointer user_data)
12170 g_free (data->target);
12171 g_free (data->type);
12172 g_slice_free (AtkRelationData, data);
12176 gtk_widget_buildable_parser_finished (GtkBuildable *buildable,
12177 GtkBuilder *builder)
12179 GSList *atk_relations;
12181 if (g_object_get_qdata (G_OBJECT (buildable), quark_builder_has_default))
12182 gtk_widget_grab_default (GTK_WIDGET (buildable));
12183 if (g_object_get_qdata (G_OBJECT (buildable), quark_builder_has_focus))
12184 gtk_widget_grab_focus (GTK_WIDGET (buildable));
12186 atk_relations = g_object_get_qdata (G_OBJECT (buildable),
12187 quark_builder_atk_relations);
12190 AtkObject *accessible;
12191 AtkRelationSet *relation_set;
12194 AtkRelationType relation_type;
12195 AtkObject *target_accessible;
12197 accessible = gtk_widget_get_accessible (GTK_WIDGET (buildable));
12198 relation_set = atk_object_ref_relation_set (accessible);
12200 for (l = atk_relations; l; l = l->next)
12202 AtkRelationData *relation = (AtkRelationData*)l->data;
12204 target = gtk_builder_get_object (builder, relation->target);
12207 g_warning ("Target object %s in <relation> does not exist",
12211 target_accessible = gtk_widget_get_accessible (GTK_WIDGET (target));
12212 g_assert (target_accessible != NULL);
12214 relation_type = atk_relation_type_for_name (relation->type);
12215 if (relation_type == ATK_RELATION_NULL)
12217 g_warning ("<relation> type %s not found",
12221 atk_relation_set_add_relation_by_type (relation_set, relation_type,
12222 target_accessible);
12224 g_object_unref (relation_set);
12226 g_slist_free_full (atk_relations, (GDestroyNotify) free_relation);
12227 g_object_set_qdata (G_OBJECT (buildable), quark_builder_atk_relations,
12236 } AccessibilitySubParserData;
12239 accessibility_start_element (GMarkupParseContext *context,
12240 const gchar *element_name,
12241 const gchar **names,
12242 const gchar **values,
12243 gpointer user_data,
12246 AccessibilitySubParserData *data = (AccessibilitySubParserData*)user_data;
12248 gint line_number, char_number;
12250 if (strcmp (element_name, "relation") == 0)
12252 gchar *target = NULL;
12253 gchar *type = NULL;
12254 AtkRelationData *relation;
12256 for (i = 0; names[i]; i++)
12258 if (strcmp (names[i], "target") == 0)
12259 target = g_strdup (values[i]);
12260 else if (strcmp (names[i], "type") == 0)
12261 type = g_strdup (values[i]);
12264 g_markup_parse_context_get_position (context,
12267 g_set_error (error,
12269 GTK_BUILDER_ERROR_INVALID_ATTRIBUTE,
12270 "%s:%d:%d '%s' is not a valid attribute of <%s>",
12272 line_number, char_number, names[i], "relation");
12279 if (!target || !type)
12281 g_markup_parse_context_get_position (context,
12284 g_set_error (error,
12286 GTK_BUILDER_ERROR_MISSING_ATTRIBUTE,
12287 "%s:%d:%d <%s> requires attribute \"%s\"",
12289 line_number, char_number, "relation",
12290 type ? "target" : "type");
12296 relation = g_slice_new (AtkRelationData);
12297 relation->target = target;
12298 relation->type = type;
12300 data->relations = g_slist_prepend (data->relations, relation);
12302 else if (strcmp (element_name, "action") == 0)
12304 const gchar *action_name = NULL;
12305 const gchar *description = NULL;
12306 const gchar *msg_context = NULL;
12307 gboolean translatable = FALSE;
12308 AtkActionData *action;
12310 for (i = 0; names[i]; i++)
12312 if (strcmp (names[i], "action_name") == 0)
12313 action_name = values[i];
12314 else if (strcmp (names[i], "description") == 0)
12315 description = values[i];
12316 else if (strcmp (names[i], "translatable") == 0)
12318 if (!_gtk_builder_boolean_from_string (values[i], &translatable, error))
12321 else if (strcmp (names[i], "comments") == 0)
12323 /* do nothing, comments are for translators */
12325 else if (strcmp (names[i], "context") == 0)
12326 msg_context = values[i];
12329 g_markup_parse_context_get_position (context,
12332 g_set_error (error,
12334 GTK_BUILDER_ERROR_INVALID_ATTRIBUTE,
12335 "%s:%d:%d '%s' is not a valid attribute of <%s>",
12337 line_number, char_number, names[i], "action");
12344 g_markup_parse_context_get_position (context,
12347 g_set_error (error,
12349 GTK_BUILDER_ERROR_MISSING_ATTRIBUTE,
12350 "%s:%d:%d <%s> requires attribute \"%s\"",
12352 line_number, char_number, "action",
12357 action = g_slice_new (AtkActionData);
12358 action->action_name = g_strdup (action_name);
12359 action->description = g_string_new (description);
12360 action->context = g_strdup (msg_context);
12361 action->translatable = translatable;
12363 data->actions = g_slist_prepend (data->actions, action);
12365 else if (strcmp (element_name, "accessibility") == 0)
12368 g_warning ("Unsupported tag for GtkWidget: %s\n", element_name);
12372 accessibility_text (GMarkupParseContext *context,
12375 gpointer user_data,
12378 AccessibilitySubParserData *data = (AccessibilitySubParserData*)user_data;
12380 if (strcmp (g_markup_parse_context_get_element (context), "action") == 0)
12382 AtkActionData *action = data->actions->data;
12384 g_string_append_len (action->description, text, text_len);
12388 static const GMarkupParser accessibility_parser =
12390 accessibility_start_element,
12392 accessibility_text,
12401 } AccelGroupParserData;
12404 accel_group_start_element (GMarkupParseContext *context,
12405 const gchar *element_name,
12406 const gchar **names,
12407 const gchar **values,
12408 gpointer user_data,
12413 guint modifiers = 0;
12414 gchar *signal = NULL;
12415 AccelGroupParserData *parser_data = (AccelGroupParserData*)user_data;
12417 for (i = 0; names[i]; i++)
12419 if (strcmp (names[i], "key") == 0)
12420 key = gdk_keyval_from_name (values[i]);
12421 else if (strcmp (names[i], "modifiers") == 0)
12423 if (!_gtk_builder_flags_from_string (GDK_TYPE_MODIFIER_TYPE,
12429 else if (strcmp (names[i], "signal") == 0)
12430 signal = g_strdup (values[i]);
12433 if (key == 0 || signal == NULL)
12435 g_warning ("<accelerator> requires key and signal attributes");
12438 parser_data->key = key;
12439 parser_data->modifiers = modifiers;
12440 parser_data->signal = signal;
12443 static const GMarkupParser accel_group_parser =
12445 accel_group_start_element,
12454 style_start_element (GMarkupParseContext *context,
12455 const gchar *element_name,
12456 const gchar **names,
12457 const gchar **values,
12458 gpointer user_data,
12461 StyleParserData *style_data = (StyleParserData *)user_data;
12464 if (strcmp (element_name, "class") == 0)
12466 if (g_markup_collect_attributes (element_name,
12470 G_MARKUP_COLLECT_STRDUP, "name", &class_name,
12471 G_MARKUP_COLLECT_INVALID))
12473 style_data->classes = g_slist_append (style_data->classes, class_name);
12476 else if (strcmp (element_name, "style") == 0)
12479 g_warning ("Unsupported tag for GtkWidget: %s\n", element_name);
12482 static const GMarkupParser style_parser =
12484 style_start_element,
12488 gtk_widget_buildable_custom_tag_start (GtkBuildable *buildable,
12489 GtkBuilder *builder,
12491 const gchar *tagname,
12492 GMarkupParser *parser,
12495 g_assert (buildable);
12497 if (strcmp (tagname, "accelerator") == 0)
12499 AccelGroupParserData *parser_data;
12501 parser_data = g_slice_new0 (AccelGroupParserData);
12502 parser_data->object = g_object_ref (buildable);
12503 *parser = accel_group_parser;
12504 *data = parser_data;
12507 if (strcmp (tagname, "accessibility") == 0)
12509 AccessibilitySubParserData *parser_data;
12511 parser_data = g_slice_new0 (AccessibilitySubParserData);
12512 *parser = accessibility_parser;
12513 *data = parser_data;
12516 if (strcmp (tagname, "style") == 0)
12518 StyleParserData *parser_data;
12520 parser_data = g_slice_new0 (StyleParserData);
12521 *parser = style_parser;
12522 *data = parser_data;
12530 _gtk_widget_buildable_finish_accelerator (GtkWidget *widget,
12531 GtkWidget *toplevel,
12532 gpointer user_data)
12534 AccelGroupParserData *accel_data;
12535 GSList *accel_groups;
12536 GtkAccelGroup *accel_group;
12538 g_return_if_fail (GTK_IS_WIDGET (widget));
12539 g_return_if_fail (GTK_IS_WIDGET (toplevel));
12540 g_return_if_fail (user_data != NULL);
12542 accel_data = (AccelGroupParserData*)user_data;
12543 accel_groups = gtk_accel_groups_from_object (G_OBJECT (toplevel));
12544 if (g_slist_length (accel_groups) == 0)
12546 accel_group = gtk_accel_group_new ();
12547 gtk_window_add_accel_group (GTK_WINDOW (toplevel), accel_group);
12551 g_assert (g_slist_length (accel_groups) == 1);
12552 accel_group = g_slist_nth_data (accel_groups, 0);
12555 gtk_widget_add_accelerator (GTK_WIDGET (accel_data->object),
12556 accel_data->signal,
12559 accel_data->modifiers,
12560 GTK_ACCEL_VISIBLE);
12562 g_object_unref (accel_data->object);
12563 g_free (accel_data->signal);
12564 g_slice_free (AccelGroupParserData, accel_data);
12568 gtk_widget_buildable_custom_finished (GtkBuildable *buildable,
12569 GtkBuilder *builder,
12571 const gchar *tagname,
12572 gpointer user_data)
12574 if (strcmp (tagname, "accelerator") == 0)
12576 AccelGroupParserData *accel_data;
12577 GtkWidget *toplevel;
12579 accel_data = (AccelGroupParserData*)user_data;
12580 g_assert (accel_data->object);
12582 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (accel_data->object));
12584 _gtk_widget_buildable_finish_accelerator (GTK_WIDGET (buildable), toplevel, user_data);
12586 else if (strcmp (tagname, "accessibility") == 0)
12588 AccessibilitySubParserData *a11y_data;
12590 a11y_data = (AccessibilitySubParserData*)user_data;
12592 if (a11y_data->actions)
12594 AtkObject *accessible;
12599 accessible = gtk_widget_get_accessible (GTK_WIDGET (buildable));
12601 if (ATK_IS_ACTION (accessible))
12603 action = ATK_ACTION (accessible);
12604 n_actions = atk_action_get_n_actions (action);
12606 for (l = a11y_data->actions; l; l = l->next)
12608 AtkActionData *action_data = (AtkActionData*)l->data;
12610 for (i = 0; i < n_actions; i++)
12611 if (strcmp (atk_action_get_name (action, i),
12612 action_data->action_name) == 0)
12617 gchar *description;
12619 if (action_data->translatable && action_data->description->len)
12620 description = _gtk_builder_parser_translate (gtk_builder_get_translation_domain (builder),
12621 action_data->context,
12622 action_data->description->str);
12624 description = action_data->description->str;
12626 atk_action_set_description (action, i, description);
12631 g_warning ("accessibility action on a widget that does not implement AtkAction");
12633 g_slist_free_full (a11y_data->actions, (GDestroyNotify) free_action);
12636 if (a11y_data->relations)
12637 g_object_set_qdata (G_OBJECT (buildable), quark_builder_atk_relations,
12638 a11y_data->relations);
12640 g_slice_free (AccessibilitySubParserData, a11y_data);
12642 else if (strcmp (tagname, "style") == 0)
12644 StyleParserData *style_data = (StyleParserData *)user_data;
12645 GtkStyleContext *context;
12648 context = gtk_widget_get_style_context (GTK_WIDGET (buildable));
12650 for (l = style_data->classes; l; l = l->next)
12651 gtk_style_context_add_class (context, (const gchar *)l->data);
12653 gtk_widget_reset_style (GTK_WIDGET (buildable));
12655 g_slist_free_full (style_data->classes, g_free);
12656 g_slice_free (StyleParserData, style_data);
12660 static GtkSizeRequestMode
12661 gtk_widget_real_get_request_mode (GtkWidget *widget)
12663 /* By default widgets dont trade size at all. */
12664 return GTK_SIZE_REQUEST_CONSTANT_SIZE;
12668 gtk_widget_real_get_width (GtkWidget *widget,
12669 gint *minimum_size,
12670 gint *natural_size)
12680 gtk_widget_real_get_height (GtkWidget *widget,
12681 gint *minimum_size,
12682 gint *natural_size)
12692 gtk_widget_real_get_height_for_width (GtkWidget *widget,
12694 gint *minimum_height,
12695 gint *natural_height)
12697 GTK_WIDGET_GET_CLASS (widget)->get_preferred_height (widget, minimum_height, natural_height);
12701 gtk_widget_real_get_width_for_height (GtkWidget *widget,
12703 gint *minimum_width,
12704 gint *natural_width)
12706 GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, minimum_width, natural_width);
12710 * gtk_widget_get_halign:
12711 * @widget: a #GtkWidget
12713 * Gets the value of the #GtkWidget:halign property.
12715 * Returns: the horizontal alignment of @widget
12718 gtk_widget_get_halign (GtkWidget *widget)
12720 g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_ALIGN_FILL);
12721 return _gtk_widget_get_aux_info_or_defaults (widget)->halign;
12725 * gtk_widget_set_halign:
12726 * @widget: a #GtkWidget
12727 * @align: the horizontal alignment
12729 * Sets the horizontal alignment of @widget.
12730 * See the #GtkWidget:halign property.
12733 gtk_widget_set_halign (GtkWidget *widget,
12736 GtkWidgetAuxInfo *aux_info;
12738 g_return_if_fail (GTK_IS_WIDGET (widget));
12740 aux_info = gtk_widget_get_aux_info (widget, TRUE);
12742 if (aux_info->halign == align)
12745 aux_info->halign = align;
12746 gtk_widget_queue_resize (widget);
12747 g_object_notify (G_OBJECT (widget), "halign");
12751 * gtk_widget_get_valign:
12752 * @widget: a #GtkWidget
12754 * Gets the value of the #GtkWidget:valign property.
12756 * Returns: the vertical alignment of @widget
12759 gtk_widget_get_valign (GtkWidget *widget)
12761 g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_ALIGN_FILL);
12762 return _gtk_widget_get_aux_info_or_defaults (widget)->valign;
12766 * gtk_widget_set_valign:
12767 * @widget: a #GtkWidget
12768 * @align: the vertical alignment
12770 * Sets the vertical alignment of @widget.
12771 * See the #GtkWidget:valign property.
12774 gtk_widget_set_valign (GtkWidget *widget,
12777 GtkWidgetAuxInfo *aux_info;
12779 g_return_if_fail (GTK_IS_WIDGET (widget));
12781 aux_info = gtk_widget_get_aux_info (widget, TRUE);
12783 if (aux_info->valign == align)
12786 aux_info->valign = align;
12787 gtk_widget_queue_resize (widget);
12788 g_object_notify (G_OBJECT (widget), "valign");
12792 * gtk_widget_get_margin_left:
12793 * @widget: a #GtkWidget
12795 * Gets the value of the #GtkWidget:margin-left property.
12797 * Returns: The left margin of @widget
12802 gtk_widget_get_margin_left (GtkWidget *widget)
12804 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
12806 return _gtk_widget_get_aux_info_or_defaults (widget)->margin.left;
12810 * gtk_widget_set_margin_left:
12811 * @widget: a #GtkWidget
12812 * @margin: the left margin
12814 * Sets the left margin of @widget.
12815 * See the #GtkWidget:margin-left property.
12820 gtk_widget_set_margin_left (GtkWidget *widget,
12823 GtkWidgetAuxInfo *aux_info;
12825 g_return_if_fail (GTK_IS_WIDGET (widget));
12826 g_return_if_fail (margin <= G_MAXINT16);
12828 aux_info = gtk_widget_get_aux_info (widget, TRUE);
12830 if (aux_info->margin.left == margin)
12833 aux_info->margin.left = margin;
12834 gtk_widget_queue_resize (widget);
12835 g_object_notify (G_OBJECT (widget), "margin-left");
12839 * gtk_widget_get_margin_right:
12840 * @widget: a #GtkWidget
12842 * Gets the value of the #GtkWidget:margin-right property.
12844 * Returns: The right margin of @widget
12849 gtk_widget_get_margin_right (GtkWidget *widget)
12851 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
12853 return _gtk_widget_get_aux_info_or_defaults (widget)->margin.right;
12857 * gtk_widget_set_margin_right:
12858 * @widget: a #GtkWidget
12859 * @margin: the right margin
12861 * Sets the right margin of @widget.
12862 * See the #GtkWidget:margin-right property.
12867 gtk_widget_set_margin_right (GtkWidget *widget,
12870 GtkWidgetAuxInfo *aux_info;
12872 g_return_if_fail (GTK_IS_WIDGET (widget));
12873 g_return_if_fail (margin <= G_MAXINT16);
12875 aux_info = gtk_widget_get_aux_info (widget, TRUE);
12877 if (aux_info->margin.right == margin)
12880 aux_info->margin.right = margin;
12881 gtk_widget_queue_resize (widget);
12882 g_object_notify (G_OBJECT (widget), "margin-right");
12886 * gtk_widget_get_margin_top:
12887 * @widget: a #GtkWidget
12889 * Gets the value of the #GtkWidget:margin-top property.
12891 * Returns: The top margin of @widget
12896 gtk_widget_get_margin_top (GtkWidget *widget)
12898 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
12900 return _gtk_widget_get_aux_info_or_defaults (widget)->margin.top;
12904 * gtk_widget_set_margin_top:
12905 * @widget: a #GtkWidget
12906 * @margin: the top margin
12908 * Sets the top margin of @widget.
12909 * See the #GtkWidget:margin-top property.
12914 gtk_widget_set_margin_top (GtkWidget *widget,
12917 GtkWidgetAuxInfo *aux_info;
12919 g_return_if_fail (GTK_IS_WIDGET (widget));
12920 g_return_if_fail (margin <= G_MAXINT16);
12922 aux_info = gtk_widget_get_aux_info (widget, TRUE);
12924 if (aux_info->margin.top == margin)
12927 aux_info->margin.top = margin;
12928 gtk_widget_queue_resize (widget);
12929 g_object_notify (G_OBJECT (widget), "margin-top");
12933 * gtk_widget_get_margin_bottom:
12934 * @widget: a #GtkWidget
12936 * Gets the value of the #GtkWidget:margin-bottom property.
12938 * Returns: The bottom margin of @widget
12943 gtk_widget_get_margin_bottom (GtkWidget *widget)
12945 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
12947 return _gtk_widget_get_aux_info_or_defaults (widget)->margin.bottom;
12951 * gtk_widget_set_margin_bottom:
12952 * @widget: a #GtkWidget
12953 * @margin: the bottom margin
12955 * Sets the bottom margin of @widget.
12956 * See the #GtkWidget:margin-bottom property.
12961 gtk_widget_set_margin_bottom (GtkWidget *widget,
12964 GtkWidgetAuxInfo *aux_info;
12966 g_return_if_fail (GTK_IS_WIDGET (widget));
12967 g_return_if_fail (margin <= G_MAXINT16);
12969 aux_info = gtk_widget_get_aux_info (widget, TRUE);
12971 if (aux_info->margin.bottom == margin)
12974 aux_info->margin.bottom = margin;
12975 gtk_widget_queue_resize (widget);
12976 g_object_notify (G_OBJECT (widget), "margin-bottom");
12980 * gtk_widget_get_clipboard:
12981 * @widget: a #GtkWidget
12982 * @selection: a #GdkAtom which identifies the clipboard
12983 * to use. %GDK_SELECTION_CLIPBOARD gives the
12984 * default clipboard. Another common value
12985 * is %GDK_SELECTION_PRIMARY, which gives
12986 * the primary X selection.
12988 * Returns the clipboard object for the given selection to
12989 * be used with @widget. @widget must have a #GdkDisplay
12990 * associated with it, so must be attached to a toplevel
12993 * Return value: (transfer none): the appropriate clipboard object. If no
12994 * clipboard already exists, a new one will
12995 * be created. Once a clipboard object has
12996 * been created, it is persistent for all time.
13001 gtk_widget_get_clipboard (GtkWidget *widget, GdkAtom selection)
13003 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
13004 g_return_val_if_fail (gtk_widget_has_screen (widget), NULL);
13006 return gtk_clipboard_get_for_display (gtk_widget_get_display (widget),
13011 * gtk_widget_list_mnemonic_labels:
13012 * @widget: a #GtkWidget
13014 * Returns a newly allocated list of the widgets, normally labels, for
13015 * which this widget is the target of a mnemonic (see for example,
13016 * gtk_label_set_mnemonic_widget()).
13018 * The widgets in the list are not individually referenced. If you
13019 * want to iterate through the list and perform actions involving
13020 * callbacks that might destroy the widgets, you
13021 * <emphasis>must</emphasis> call <literal>g_list_foreach (result,
13022 * (GFunc)g_object_ref, NULL)</literal> first, and then unref all the
13023 * widgets afterwards.
13025 * Return value: (element-type GtkWidget) (transfer container): the list of
13026 * mnemonic labels; free this list
13027 * with g_list_free() when you are done with it.
13032 gtk_widget_list_mnemonic_labels (GtkWidget *widget)
13034 GList *list = NULL;
13037 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
13039 for (l = g_object_get_qdata (G_OBJECT (widget), quark_mnemonic_labels); l; l = l->next)
13040 list = g_list_prepend (list, l->data);
13046 * gtk_widget_add_mnemonic_label:
13047 * @widget: a #GtkWidget
13048 * @label: a #GtkWidget that acts as a mnemonic label for @widget
13050 * Adds a widget to the list of mnemonic labels for
13051 * this widget. (See gtk_widget_list_mnemonic_labels()). Note the
13052 * list of mnemonic labels for the widget is cleared when the
13053 * widget is destroyed, so the caller must make sure to update
13054 * its internal state at this point as well, by using a connection
13055 * to the #GtkWidget::destroy signal or a weak notifier.
13060 gtk_widget_add_mnemonic_label (GtkWidget *widget,
13063 GSList *old_list, *new_list;
13065 g_return_if_fail (GTK_IS_WIDGET (widget));
13066 g_return_if_fail (GTK_IS_WIDGET (label));
13068 old_list = g_object_steal_qdata (G_OBJECT (widget), quark_mnemonic_labels);
13069 new_list = g_slist_prepend (old_list, label);
13071 g_object_set_qdata_full (G_OBJECT (widget), quark_mnemonic_labels,
13072 new_list, (GDestroyNotify) g_slist_free);
13076 * gtk_widget_remove_mnemonic_label:
13077 * @widget: a #GtkWidget
13078 * @label: a #GtkWidget that was previously set as a mnemnic label for
13079 * @widget with gtk_widget_add_mnemonic_label().
13081 * Removes a widget from the list of mnemonic labels for
13082 * this widget. (See gtk_widget_list_mnemonic_labels()). The widget
13083 * must have previously been added to the list with
13084 * gtk_widget_add_mnemonic_label().
13089 gtk_widget_remove_mnemonic_label (GtkWidget *widget,
13092 GSList *old_list, *new_list;
13094 g_return_if_fail (GTK_IS_WIDGET (widget));
13095 g_return_if_fail (GTK_IS_WIDGET (label));
13097 old_list = g_object_steal_qdata (G_OBJECT (widget), quark_mnemonic_labels);
13098 new_list = g_slist_remove (old_list, label);
13101 g_object_set_qdata_full (G_OBJECT (widget), quark_mnemonic_labels,
13102 new_list, (GDestroyNotify) g_slist_free);
13106 * gtk_widget_get_no_show_all:
13107 * @widget: a #GtkWidget
13109 * Returns the current value of the #GtkWidget:no-show-all property,
13110 * which determines whether calls to gtk_widget_show_all()
13111 * will affect this widget.
13113 * Return value: the current value of the "no-show-all" property.
13118 gtk_widget_get_no_show_all (GtkWidget *widget)
13120 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
13122 return widget->priv->no_show_all;
13126 * gtk_widget_set_no_show_all:
13127 * @widget: a #GtkWidget
13128 * @no_show_all: the new value for the "no-show-all" property
13130 * Sets the #GtkWidget:no-show-all property, which determines whether
13131 * calls to gtk_widget_show_all() will affect this widget.
13133 * This is mostly for use in constructing widget hierarchies with externally
13134 * controlled visibility, see #GtkUIManager.
13139 gtk_widget_set_no_show_all (GtkWidget *widget,
13140 gboolean no_show_all)
13142 g_return_if_fail (GTK_IS_WIDGET (widget));
13144 no_show_all = (no_show_all != FALSE);
13146 if (widget->priv->no_show_all != no_show_all)
13148 widget->priv->no_show_all = no_show_all;
13150 g_object_notify (G_OBJECT (widget), "no-show-all");
13156 gtk_widget_real_set_has_tooltip (GtkWidget *widget,
13157 gboolean has_tooltip,
13160 GtkWidgetPrivate *priv = widget->priv;
13161 gboolean priv_has_tooltip;
13163 priv_has_tooltip = GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (widget),
13164 quark_has_tooltip));
13166 if (priv_has_tooltip != has_tooltip || force)
13168 priv_has_tooltip = has_tooltip;
13170 if (priv_has_tooltip)
13172 if (gtk_widget_get_realized (widget) && !gtk_widget_get_has_window (widget))
13173 gdk_window_set_events (priv->window,
13174 gdk_window_get_events (priv->window) |
13175 GDK_LEAVE_NOTIFY_MASK |
13176 GDK_POINTER_MOTION_MASK |
13177 GDK_POINTER_MOTION_HINT_MASK);
13179 if (gtk_widget_get_has_window (widget))
13180 gtk_widget_add_events (widget,
13181 GDK_LEAVE_NOTIFY_MASK |
13182 GDK_POINTER_MOTION_MASK |
13183 GDK_POINTER_MOTION_HINT_MASK);
13186 g_object_set_qdata (G_OBJECT (widget), quark_has_tooltip,
13187 GUINT_TO_POINTER (priv_has_tooltip));
13192 * gtk_widget_set_tooltip_window:
13193 * @widget: a #GtkWidget
13194 * @custom_window: (allow-none): a #GtkWindow, or %NULL
13196 * Replaces the default, usually yellow, window used for displaying
13197 * tooltips with @custom_window. GTK+ will take care of showing and
13198 * hiding @custom_window at the right moment, to behave likewise as
13199 * the default tooltip window. If @custom_window is %NULL, the default
13200 * tooltip window will be used.
13202 * If the custom window should have the default theming it needs to
13203 * have the name "gtk-tooltip", see gtk_widget_set_name().
13208 gtk_widget_set_tooltip_window (GtkWidget *widget,
13209 GtkWindow *custom_window)
13211 gboolean has_tooltip;
13212 gchar *tooltip_markup;
13214 g_return_if_fail (GTK_IS_WIDGET (widget));
13215 g_return_if_fail (custom_window == NULL || GTK_IS_WINDOW (custom_window));
13217 tooltip_markup = g_object_get_qdata (G_OBJECT (widget), quark_tooltip_markup);
13220 g_object_ref (custom_window);
13222 g_object_set_qdata_full (G_OBJECT (widget), quark_tooltip_window,
13223 custom_window, g_object_unref);
13225 has_tooltip = (custom_window != NULL || tooltip_markup != NULL);
13226 gtk_widget_real_set_has_tooltip (widget, has_tooltip, FALSE);
13228 if (has_tooltip && gtk_widget_get_visible (widget))
13229 gtk_widget_queue_tooltip_query (widget);
13233 * gtk_widget_get_tooltip_window:
13234 * @widget: a #GtkWidget
13236 * Returns the #GtkWindow of the current tooltip. This can be the
13237 * GtkWindow created by default, or the custom tooltip window set
13238 * using gtk_widget_set_tooltip_window().
13240 * Return value: (transfer none): The #GtkWindow of the current tooltip.
13245 gtk_widget_get_tooltip_window (GtkWidget *widget)
13247 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
13249 return g_object_get_qdata (G_OBJECT (widget), quark_tooltip_window);
13253 * gtk_widget_trigger_tooltip_query:
13254 * @widget: a #GtkWidget
13256 * Triggers a tooltip query on the display where the toplevel of @widget
13257 * is located. See gtk_tooltip_trigger_tooltip_query() for more
13263 gtk_widget_trigger_tooltip_query (GtkWidget *widget)
13265 gtk_tooltip_trigger_tooltip_query (gtk_widget_get_display (widget));
13268 static guint tooltip_query_id;
13269 static GSList *tooltip_query_displays;
13272 tooltip_query_idle (gpointer data)
13274 g_slist_foreach (tooltip_query_displays, (GFunc)gtk_tooltip_trigger_tooltip_query, NULL);
13275 g_slist_foreach (tooltip_query_displays, (GFunc)g_object_unref, NULL);
13276 g_slist_free (tooltip_query_displays);
13278 tooltip_query_displays = NULL;
13279 tooltip_query_id = 0;
13285 gtk_widget_queue_tooltip_query (GtkWidget *widget)
13287 GdkDisplay *display;
13289 display = gtk_widget_get_display (widget);
13291 if (!g_slist_find (tooltip_query_displays, display))
13292 tooltip_query_displays = g_slist_prepend (tooltip_query_displays, g_object_ref (display));
13294 if (tooltip_query_id == 0)
13295 tooltip_query_id = gdk_threads_add_idle (tooltip_query_idle, NULL);
13299 * gtk_widget_set_tooltip_text:
13300 * @widget: a #GtkWidget
13301 * @text: the contents of the tooltip for @widget
13303 * Sets @text as the contents of the tooltip. This function will take
13304 * care of setting #GtkWidget:has-tooltip to %TRUE and of the default
13305 * handler for the #GtkWidget::query-tooltip signal.
13307 * See also the #GtkWidget:tooltip-text property and gtk_tooltip_set_text().
13312 gtk_widget_set_tooltip_text (GtkWidget *widget,
13315 g_return_if_fail (GTK_IS_WIDGET (widget));
13317 g_object_set (G_OBJECT (widget), "tooltip-text", text, NULL);
13321 * gtk_widget_get_tooltip_text:
13322 * @widget: a #GtkWidget
13324 * Gets the contents of the tooltip for @widget.
13326 * Return value: the tooltip text, or %NULL. You should free the
13327 * returned string with g_free() when done.
13332 gtk_widget_get_tooltip_text (GtkWidget *widget)
13334 gchar *text = NULL;
13336 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
13338 g_object_get (G_OBJECT (widget), "tooltip-text", &text, NULL);
13344 * gtk_widget_set_tooltip_markup:
13345 * @widget: a #GtkWidget
13346 * @markup: (allow-none): the contents of the tooltip for @widget, or %NULL
13348 * Sets @markup as the contents of the tooltip, which is marked up with
13349 * the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
13351 * This function will take care of setting #GtkWidget:has-tooltip to %TRUE
13352 * and of the default handler for the #GtkWidget::query-tooltip signal.
13354 * See also the #GtkWidget:tooltip-markup property and
13355 * gtk_tooltip_set_markup().
13360 gtk_widget_set_tooltip_markup (GtkWidget *widget,
13361 const gchar *markup)
13363 g_return_if_fail (GTK_IS_WIDGET (widget));
13365 g_object_set (G_OBJECT (widget), "tooltip-markup", markup, NULL);
13369 * gtk_widget_get_tooltip_markup:
13370 * @widget: a #GtkWidget
13372 * Gets the contents of the tooltip for @widget.
13374 * Return value: the tooltip text, or %NULL. You should free the
13375 * returned string with g_free() when done.
13380 gtk_widget_get_tooltip_markup (GtkWidget *widget)
13382 gchar *text = NULL;
13384 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
13386 g_object_get (G_OBJECT (widget), "tooltip-markup", &text, NULL);
13392 * gtk_widget_set_has_tooltip:
13393 * @widget: a #GtkWidget
13394 * @has_tooltip: whether or not @widget has a tooltip.
13396 * Sets the has-tooltip property on @widget to @has_tooltip. See
13397 * #GtkWidget:has-tooltip for more information.
13402 gtk_widget_set_has_tooltip (GtkWidget *widget,
13403 gboolean has_tooltip)
13405 g_return_if_fail (GTK_IS_WIDGET (widget));
13407 g_object_set (G_OBJECT (widget), "has-tooltip", has_tooltip, NULL);
13411 * gtk_widget_get_has_tooltip:
13412 * @widget: a #GtkWidget
13414 * Returns the current value of the has-tooltip property. See
13415 * #GtkWidget:has-tooltip for more information.
13417 * Return value: current value of has-tooltip on @widget.
13422 gtk_widget_get_has_tooltip (GtkWidget *widget)
13424 gboolean has_tooltip = FALSE;
13426 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
13428 g_object_get (G_OBJECT (widget), "has-tooltip", &has_tooltip, NULL);
13430 return has_tooltip;
13434 * gtk_widget_get_allocation:
13435 * @widget: a #GtkWidget
13436 * @allocation: (out): a pointer to a #GtkAllocation to copy to
13438 * Retrieves the widget's allocation.
13440 * Note, when implementing a #GtkContainer: a widget's allocation will
13441 * be its "adjusted" allocation, that is, the widget's parent
13442 * container typically calls gtk_widget_size_allocate() with an
13443 * allocation, and that allocation is then adjusted (to handle margin
13444 * and alignment for example) before assignment to the widget.
13445 * gtk_widget_get_allocation() returns the adjusted allocation that
13446 * was actually assigned to the widget. The adjusted allocation is
13447 * guaranteed to be completely contained within the
13448 * gtk_widget_size_allocate() allocation, however. So a #GtkContainer
13449 * is guaranteed that its children stay inside the assigned bounds,
13450 * but not that they have exactly the bounds the container assigned.
13451 * There is no way to get the original allocation assigned by
13452 * gtk_widget_size_allocate(), since it isn't stored; if a container
13453 * implementation needs that information it will have to track it itself.
13458 gtk_widget_get_allocation (GtkWidget *widget,
13459 GtkAllocation *allocation)
13461 GtkWidgetPrivate *priv;
13463 g_return_if_fail (GTK_IS_WIDGET (widget));
13464 g_return_if_fail (allocation != NULL);
13466 priv = widget->priv;
13468 *allocation = priv->allocation;
13472 * gtk_widget_set_allocation:
13473 * @widget: a #GtkWidget
13474 * @allocation: a pointer to a #GtkAllocation to copy from
13476 * Sets the widget's allocation. This should not be used
13477 * directly, but from within a widget's size_allocate method.
13479 * The allocation set should be the "adjusted" or actual
13480 * allocation. If you're implementing a #GtkContainer, you want to use
13481 * gtk_widget_size_allocate() instead of gtk_widget_set_allocation().
13482 * The GtkWidgetClass::adjust_size_allocation virtual method adjusts the
13483 * allocation inside gtk_widget_size_allocate() to create an adjusted
13489 gtk_widget_set_allocation (GtkWidget *widget,
13490 const GtkAllocation *allocation)
13492 GtkWidgetPrivate *priv;
13494 g_return_if_fail (GTK_IS_WIDGET (widget));
13495 g_return_if_fail (allocation != NULL);
13497 priv = widget->priv;
13499 priv->allocation = *allocation;
13503 * gtk_widget_get_allocated_width:
13504 * @widget: the widget to query
13506 * Returns the width that has currently been allocated to @widget.
13507 * This function is intended to be used when implementing handlers
13508 * for the #GtkWidget::draw function.
13510 * Returns: the width of the @widget
13513 gtk_widget_get_allocated_width (GtkWidget *widget)
13515 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
13517 return widget->priv->allocation.width;
13521 * gtk_widget_get_allocated_height:
13522 * @widget: the widget to query
13524 * Returns the height that has currently been allocated to @widget.
13525 * This function is intended to be used when implementing handlers
13526 * for the #GtkWidget::draw function.
13528 * Returns: the height of the @widget
13531 gtk_widget_get_allocated_height (GtkWidget *widget)
13533 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
13535 return widget->priv->allocation.height;
13539 * gtk_widget_get_requisition:
13540 * @widget: a #GtkWidget
13541 * @requisition: (out): a pointer to a #GtkRequisition to copy to
13543 * Retrieves the widget's requisition.
13545 * This function should only be used by widget implementations in
13546 * order to figure whether the widget's requisition has actually
13547 * changed after some internal state change (so that they can call
13548 * gtk_widget_queue_resize() instead of gtk_widget_queue_draw()).
13550 * Normally, gtk_widget_size_request() should be used.
13554 * Deprecated: 3.0: The #GtkRequisition cache on the widget was
13555 * removed, If you need to cache sizes across requests and allocations,
13556 * add an explicit cache to the widget in question instead.
13559 gtk_widget_get_requisition (GtkWidget *widget,
13560 GtkRequisition *requisition)
13562 g_return_if_fail (GTK_IS_WIDGET (widget));
13563 g_return_if_fail (requisition != NULL);
13565 gtk_widget_get_preferred_size (widget, requisition, NULL);
13569 * gtk_widget_set_window:
13570 * @widget: a #GtkWidget
13571 * @window: (transfer full): a #GdkWindow
13573 * Sets a widget's window. This function should only be used in a
13574 * widget's #GtkWidget::realize implementation. The %window passed is
13575 * usually either new window created with gdk_window_new(), or the
13576 * window of its parent widget as returned by
13577 * gtk_widget_get_parent_window().
13579 * Widgets must indicate whether they will create their own #GdkWindow
13580 * by calling gtk_widget_set_has_window(). This is usually done in the
13581 * widget's init() function.
13583 * <note><para>This function does not add any reference to @window.</para></note>
13588 gtk_widget_set_window (GtkWidget *widget,
13591 GtkWidgetPrivate *priv;
13593 g_return_if_fail (GTK_IS_WIDGET (widget));
13594 g_return_if_fail (window == NULL || GDK_IS_WINDOW (window));
13596 priv = widget->priv;
13598 if (priv->window != window)
13600 priv->window = window;
13601 g_object_notify (G_OBJECT (widget), "window");
13606 * gtk_widget_get_window:
13607 * @widget: a #GtkWidget
13609 * Returns the widget's window if it is realized, %NULL otherwise
13611 * Return value: (transfer none): @widget's window.
13616 gtk_widget_get_window (GtkWidget *widget)
13618 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
13620 return widget->priv->window;
13624 * gtk_widget_get_support_multidevice:
13625 * @widget: a #GtkWidget
13627 * Returns %TRUE if @widget is multiple pointer aware. See
13628 * gtk_widget_set_support_multidevice() for more information.
13630 * Returns: %TRUE if @widget is multidevice aware.
13633 gtk_widget_get_support_multidevice (GtkWidget *widget)
13635 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
13637 return widget->priv->multidevice;
13641 * gtk_widget_set_support_multidevice:
13642 * @widget: a #GtkWidget
13643 * @support_multidevice: %TRUE to support input from multiple devices.
13645 * Enables or disables multiple pointer awareness. If this setting is %TRUE,
13646 * @widget will start receiving multiple, per device enter/leave events. Note
13647 * that if custom #GdkWindow<!-- -->s are created in #GtkWidget::realize,
13648 * gdk_window_set_support_multidevice() will have to be called manually on them.
13653 gtk_widget_set_support_multidevice (GtkWidget *widget,
13654 gboolean support_multidevice)
13656 GtkWidgetPrivate *priv;
13658 g_return_if_fail (GTK_IS_WIDGET (widget));
13660 priv = widget->priv;
13661 priv->multidevice = (support_multidevice == TRUE);
13663 if (gtk_widget_get_realized (widget))
13664 gdk_window_set_support_multidevice (priv->window, support_multidevice);
13668 _gtk_widget_set_has_focus (GtkWidget *widget,
13669 gboolean has_focus)
13671 widget->priv->has_focus = has_focus;
13674 gtk_widget_set_state_flags (widget, GTK_STATE_FLAG_FOCUSED, FALSE);
13676 gtk_widget_unset_state_flags (widget, GTK_STATE_FLAG_FOCUSED);
13680 * gtk_widget_send_focus_change:
13681 * @widget: a #GtkWidget
13682 * @event: a #GdkEvent of type GDK_FOCUS_CHANGE
13684 * Sends the focus change @event to @widget
13686 * This function is not meant to be used by applications. The only time it
13687 * should be used is when it is necessary for a #GtkWidget to assign focus
13688 * to a widget that is semantically owned by the first widget even though
13689 * it's not a direct child - for instance, a search entry in a floating
13690 * window similar to the quick search in #GtkTreeView.
13692 * An example of its usage is:
13695 * GdkEvent *fevent = gdk_event_new (GDK_FOCUS_CHANGE);
13697 * fevent->focus_change.type = GDK_FOCUS_CHANGE;
13698 * fevent->focus_change.in = TRUE;
13699 * fevent->focus_change.window = gtk_widget_get_window (widget);
13700 * if (fevent->focus_change.window != NULL)
13701 * g_object_ref (fevent->focus_change.window);
13703 * gtk_widget_send_focus_change (widget, fevent);
13705 * gdk_event_free (event);
13708 * Return value: the return value from the event signal emission: %TRUE
13709 * if the event was handled, and %FALSE otherwise
13714 gtk_widget_send_focus_change (GtkWidget *widget,
13719 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
13720 g_return_val_if_fail (event != NULL && event->type == GDK_FOCUS_CHANGE, FALSE);
13722 g_object_ref (widget);
13724 _gtk_widget_set_has_focus (widget, event->focus_change.in);
13726 res = gtk_widget_event (widget, event);
13728 g_object_notify (G_OBJECT (widget), "has-focus");
13730 g_object_unref (widget);
13736 * gtk_widget_in_destruction:
13737 * @widget: a #GtkWidget
13739 * Returns whether the widget is currently being destroyed.
13740 * This information can sometimes be used to avoid doing
13741 * unnecessary work.
13743 * Returns: %TRUE if @widget is being destroyed
13746 gtk_widget_in_destruction (GtkWidget *widget)
13748 return widget->priv->in_destruction;
13752 _gtk_widget_get_in_reparent (GtkWidget *widget)
13754 return widget->priv->in_reparent;
13758 _gtk_widget_set_in_reparent (GtkWidget *widget,
13759 gboolean in_reparent)
13761 widget->priv->in_reparent = in_reparent;
13765 _gtk_widget_get_anchored (GtkWidget *widget)
13767 return widget->priv->anchored;
13771 _gtk_widget_set_anchored (GtkWidget *widget,
13774 widget->priv->anchored = anchored;
13778 _gtk_widget_get_shadowed (GtkWidget *widget)
13780 return widget->priv->shadowed;
13784 _gtk_widget_set_shadowed (GtkWidget *widget,
13787 widget->priv->shadowed = shadowed;
13791 _gtk_widget_get_alloc_needed (GtkWidget *widget)
13793 return widget->priv->alloc_needed;
13797 _gtk_widget_set_alloc_needed (GtkWidget *widget,
13798 gboolean alloc_needed)
13800 widget->priv->alloc_needed = alloc_needed;
13804 _gtk_widget_add_sizegroup (GtkWidget *widget,
13809 groups = g_object_get_qdata (G_OBJECT (widget), quark_size_groups);
13810 groups = g_slist_prepend (groups, group);
13811 g_object_set_qdata (G_OBJECT (widget), quark_size_groups, groups);
13813 widget->priv->have_size_groups = TRUE;
13817 _gtk_widget_remove_sizegroup (GtkWidget *widget,
13822 groups = g_object_get_qdata (G_OBJECT (widget), quark_size_groups);
13823 groups = g_slist_remove (groups, group);
13824 g_object_set_qdata (G_OBJECT (widget), quark_size_groups, groups);
13826 widget->priv->have_size_groups = groups != NULL;
13830 _gtk_widget_get_sizegroups (GtkWidget *widget)
13832 if (widget->priv->have_size_groups)
13833 return g_object_get_qdata (G_OBJECT (widget), quark_size_groups);
13839 _gtk_widget_add_attached_window (GtkWidget *widget,
13842 widget->priv->attached_windows = g_list_prepend (widget->priv->attached_windows, window);
13846 _gtk_widget_remove_attached_window (GtkWidget *widget,
13849 widget->priv->attached_windows = g_list_remove (widget->priv->attached_windows, window);
13853 * gtk_widget_path_append_for_widget:
13854 * @path: a widget path
13855 * @widget: the widget to append to the widget path
13857 * Appends the data from @widget to the widget hierarchy represented
13858 * by @path. This function is a shortcut for adding information from
13859 * @widget to the given @path. This includes setting the name or
13860 * adding the style classes from @widget.
13862 * Returns: the position where the data was inserted
13867 gtk_widget_path_append_for_widget (GtkWidgetPath *path,
13872 g_return_val_if_fail (path != NULL, 0);
13873 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
13875 pos = gtk_widget_path_append_type (path, G_OBJECT_TYPE (widget));
13877 if (widget->priv->name)
13878 gtk_widget_path_iter_set_name (path, pos, widget->priv->name);
13880 if (widget->priv->context)
13882 GList *classes, *l;
13884 /* Also add any persistent classes in
13885 * the style context the widget path
13887 classes = gtk_style_context_list_classes (widget->priv->context);
13889 for (l = classes; l; l = l->next)
13890 gtk_widget_path_iter_add_class (path, pos, l->data);
13892 g_list_free (classes);
13899 _gtk_widget_create_path (GtkWidget *widget)
13903 parent = widget->priv->parent;
13906 return gtk_container_get_path_for_child (GTK_CONTAINER (parent), widget);
13909 /* Widget is either toplevel or unparented, treat both
13910 * as toplevels style wise, since there are situations
13911 * where style properties might be retrieved on that
13914 GtkWidget *attach_widget = NULL;
13915 GtkWidgetPath *result;
13917 if (GTK_IS_WINDOW (widget))
13918 attach_widget = gtk_window_get_attached_to (GTK_WINDOW (widget));
13920 if (attach_widget != NULL)
13921 result = gtk_widget_path_copy (gtk_widget_get_path (attach_widget));
13923 result = gtk_widget_path_new ();
13925 gtk_widget_path_append_for_widget (result, widget);
13932 * gtk_widget_get_path:
13933 * @widget: a #GtkWidget
13935 * Returns the #GtkWidgetPath representing @widget, if the widget
13936 * is not connected to a toplevel widget, a partial path will be
13939 * Returns: (transfer none): The #GtkWidgetPath representing @widget
13942 gtk_widget_get_path (GtkWidget *widget)
13944 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
13946 if (!widget->priv->path)
13947 widget->priv->path = _gtk_widget_create_path (widget);
13949 return widget->priv->path;
13953 _gtk_widget_style_context_invalidated (GtkWidget *widget)
13955 if (widget->priv->path)
13957 gtk_widget_path_free (widget->priv->path);
13958 widget->priv->path = NULL;
13961 if (gtk_widget_get_realized (widget))
13962 g_signal_emit (widget, widget_signals[STYLE_UPDATED], 0);
13965 /* Compress all style updates so it
13966 * is only emitted once pre-realize.
13968 widget->priv->style_update_pending = TRUE;
13973 * gtk_widget_get_style_context:
13974 * @widget: a #GtkWidget
13976 * Returns the style context associated to @widget.
13978 * Returns: (transfer none): a #GtkStyleContext. This memory is owned by @widget and
13979 * must not be freed.
13982 gtk_widget_get_style_context (GtkWidget *widget)
13984 GtkWidgetPrivate *priv;
13986 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
13988 priv = widget->priv;
13990 if (G_UNLIKELY (priv->context == NULL))
13994 priv->context = gtk_style_context_new ();
13996 gtk_style_context_set_direction (priv->context, gtk_widget_get_direction (widget));
13998 screen = gtk_widget_get_screen (widget);
14000 gtk_style_context_set_screen (priv->context, screen);
14003 gtk_style_context_set_parent (priv->context,
14004 gtk_widget_get_style_context (priv->parent));
14006 _gtk_style_context_set_widget (priv->context, widget);
14009 return widget->priv->context;
14013 _gtk_widget_invalidate_style_context (GtkWidget *widget,
14014 GtkCssChange change)
14016 GtkWidgetPrivate *priv;
14018 priv = widget->priv;
14020 if (priv->context == NULL)
14023 _gtk_style_context_queue_invalidate (priv->context, change);
14027 * gtk_widget_get_modifier_mask:
14028 * @widget: a #GtkWidget
14029 * @intent: the use case for the modifier mask
14031 * Returns the modifier mask the @widget's windowing system backend
14032 * uses for a particular purpose.
14034 * See gdk_keymap_get_modifier_mask().
14036 * Returns: the modifier mask used for @intent.
14041 gtk_widget_get_modifier_mask (GtkWidget *widget,
14042 GdkModifierIntent intent)
14044 GdkDisplay *display;
14046 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
14048 display = gtk_widget_get_display (widget);
14050 return gdk_keymap_get_modifier_mask (gdk_keymap_get_for_display (display),
14055 _gtk_widget_get_style (GtkWidget *widget)
14057 return widget->priv->style;
14061 _gtk_widget_set_style (GtkWidget *widget,
14064 widget->priv->style = style;
14068 _gtk_widget_update_parent_muxer (GtkWidget *widget)
14071 GActionMuxer *parent_muxer;
14073 if (widget->priv->muxer == NULL)
14076 if (GTK_IS_MENU (widget))
14077 parent = gtk_menu_get_attach_widget (GTK_MENU (widget));
14079 parent = gtk_widget_get_parent (widget);
14081 parent_muxer = parent ? _gtk_widget_get_action_muxer (parent) : NULL;
14083 g_action_muxer_set_parent (widget->priv->muxer, parent_muxer);
14087 _gtk_widget_get_action_muxer (GtkWidget *widget)
14089 if (widget->priv->muxer == NULL)
14091 widget->priv->muxer = g_action_muxer_new ();
14092 _gtk_widget_update_parent_muxer (widget);
14095 return widget->priv->muxer;
14099 * gtk_widget_insert_action_group:
14100 * @widget: a #GtkWidget
14101 * @name: the prefix for actions in @group
14102 * @group: a #GActionGroup
14104 * Inserts @group into @widget. Children of @widget that implement
14105 * #GtkActionable can then be associated with actions in @group by
14106 * setting their 'action-name' to
14107 * @prefix.<replaceable>action-name</replaceable>.
14112 gtk_widget_insert_action_group (GtkWidget *widget,
14114 GActionGroup *group)
14116 GActionMuxer *muxer;
14118 g_return_if_fail (GTK_IS_WIDGET (widget));
14119 g_return_if_fail (name != NULL);
14121 muxer = _gtk_widget_get_action_muxer (widget);
14124 g_action_muxer_insert (muxer, name, group);
14126 g_action_muxer_remove (muxer, name);