1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
31 #include "gtkcontainer.h"
32 #include "gtkaccelmap.h"
33 #include "gtkclipboard.h"
34 #include "gtkiconfactory.h"
37 #include "gtkmarshalers.h"
39 #include "gtkselection.h"
40 #include "gtksettings.h"
41 #include "gtksizegroup.h"
42 #include "gtkwidget.h"
43 #include "gtkwindow.h"
44 #include "gtkbindings.h"
45 #include "gtkprivate.h"
47 #include "gdk/gdkprivate.h" /* Used in gtk_reset_shapes_recurse to avoid copy */
48 #include <gobject/gvaluecollector.h>
49 #include <gobject/gobjectnotifyqueue.c>
50 #include "gdk/gdkkeysyms.h"
51 #include "gtkaccessible.h"
52 #include "gtktooltip.h"
53 #include "gtkinvisible.h"
54 #include "gtkbuildable.h"
55 #include "gtkbuilderprivate.h"
56 #include "gtkextendedlayout.h"
61 * @Short_description: Base class for all widgets
64 * GtkWidget is the base class all widgets in GTK+ derive from. It manages the
65 * widget lifecycle, states and style.
67 * <refsect2 id="style-properties">
69 * <structname>GtkWidget</structname> introduces <firstterm>style
70 * properties</firstterm> - these are basically object properties that are stored
71 * not on the object, but in the style object associated to the widget. Style
72 * properties are set in <link linkend="gtk-Resource-Files">resource files</link>.
73 * This mechanism is used for configuring such things as the location of the
74 * scrollbar arrows through the theme, giving theme authors more control over the
75 * look of applications without the need to write a theme engine in C.
78 * Use gtk_widget_class_install_style_property() to install style properties for
79 * a widget class, gtk_widget_class_find_style_property() or
80 * gtk_widget_class_list_style_properties() to get information about existing
81 * style properties and gtk_widget_style_get_property(), gtk_widget_style_get() or
82 * gtk_widget_style_get_valist() to obtain the value of a style property.
85 * <refsect2 id="GtkWidget-BUILDER-UI">
86 * <title>GtkWidget as GtkBuildable</title>
88 * The GtkWidget implementation of the GtkBuildable interface supports a
89 * custom <accelerator> element, which has attributes named key,
90 * modifiers and signal and allows to specify accelerators.
93 * <title>A UI definition fragment specifying an accelerator</title>
94 * <programlisting><![CDATA[
95 * <object class="GtkButton">
96 * <accelerator key="q" modifiers="GDK_CONTROL_MASK" signal="clicked"/>
98 * ]]></programlisting>
101 * In addition to accelerators, <structname>GtkWidget</structname> also support a
102 * custom <accessible> element, which supports actions and relations.
103 * Properties on the accessible implementation of an object can be set by accessing the
104 * internal child "accessible" of a <structname>GtkWidget</structname>.
107 * <title>A UI definition fragment specifying an accessible</title>
108 * <programlisting><![CDATA[
109 * <object class="GtkButton" id="label1"/>
110 * <property name="label">I am a Label for a Button</property>
112 * <object class="GtkButton" id="button1">
114 * <action action_name="click" translatable="yes">Click the button.</action>
115 * <relation target="label1" type="labelled-by"/>
117 * <child internal-child="accessible">
118 * <object class="AtkObject" id="a11y-button1">
119 * <property name="AtkObject::name">Clickable Button</property>
123 * ]]></programlisting>
128 #define WIDGET_CLASS(w) GTK_WIDGET_GET_CLASS (w)
129 #define INIT_PATH_SIZE (512)
155 BUTTON_RELEASE_EVENT,
170 PROPERTY_NOTIFY_EVENT,
171 SELECTION_CLEAR_EVENT,
172 SELECTION_REQUEST_EVENT,
173 SELECTION_NOTIFY_EVENT,
188 VISIBILITY_NOTIFY_EVENT,
192 ACCEL_CLOSURES_CHANGED,
218 PROP_RECEIVES_DEFAULT,
219 PROP_COMPOSITE_CHILD,
222 PROP_EXTENSION_EVENTS,
231 typedef struct _GtkStateData GtkStateData;
236 guint state_restoration : 1;
237 guint parent_sensitive : 1;
238 guint use_forall : 1;
241 /* --- prototypes --- */
242 static void gtk_widget_class_init (GtkWidgetClass *klass);
243 static void gtk_widget_base_class_finalize (GtkWidgetClass *klass);
244 static void gtk_widget_init (GtkWidget *widget);
245 static void gtk_widget_set_property (GObject *object,
249 static void gtk_widget_get_property (GObject *object,
253 static void gtk_widget_dispose (GObject *object);
254 static void gtk_widget_real_destroy (GtkObject *object);
255 static void gtk_widget_finalize (GObject *object);
256 static void gtk_widget_real_show (GtkWidget *widget);
257 static void gtk_widget_real_hide (GtkWidget *widget);
258 static void gtk_widget_real_map (GtkWidget *widget);
259 static void gtk_widget_real_unmap (GtkWidget *widget);
260 static void gtk_widget_real_realize (GtkWidget *widget);
261 static void gtk_widget_real_unrealize (GtkWidget *widget);
262 static void gtk_widget_real_size_request (GtkWidget *widget,
263 GtkRequisition *requisition);
264 static void gtk_widget_real_size_allocate (GtkWidget *widget,
265 GtkAllocation *allocation);
266 static void gtk_widget_real_style_set (GtkWidget *widget,
267 GtkStyle *previous_style);
268 static void gtk_widget_real_direction_changed(GtkWidget *widget,
269 GtkTextDirection previous_direction);
271 static void gtk_widget_real_grab_focus (GtkWidget *focus_widget);
272 static gboolean gtk_widget_real_query_tooltip (GtkWidget *widget,
275 gboolean keyboard_tip,
276 GtkTooltip *tooltip);
277 static gboolean gtk_widget_real_show_help (GtkWidget *widget,
278 GtkWidgetHelpType help_type);
280 static void gtk_widget_dispatch_child_properties_changed (GtkWidget *object,
282 GParamSpec **pspecs);
283 static gboolean gtk_widget_real_key_press_event (GtkWidget *widget,
285 static gboolean gtk_widget_real_key_release_event (GtkWidget *widget,
287 static gboolean gtk_widget_real_focus_in_event (GtkWidget *widget,
288 GdkEventFocus *event);
289 static gboolean gtk_widget_real_focus_out_event (GtkWidget *widget,
290 GdkEventFocus *event);
291 static gboolean gtk_widget_real_focus (GtkWidget *widget,
292 GtkDirectionType direction);
293 static void gtk_widget_real_move_focus (GtkWidget *widget,
294 GtkDirectionType direction);
295 static gboolean gtk_widget_real_keynav_failed (GtkWidget *widget,
296 GtkDirectionType direction);
297 static PangoContext* gtk_widget_peek_pango_context (GtkWidget *widget);
298 static void gtk_widget_update_pango_context (GtkWidget *widget);
299 static void gtk_widget_propagate_state (GtkWidget *widget,
301 static void gtk_widget_reset_rc_style (GtkWidget *widget);
302 static void gtk_widget_set_style_internal (GtkWidget *widget,
304 gboolean initial_emission);
305 static gint gtk_widget_event_internal (GtkWidget *widget,
307 static gboolean gtk_widget_real_mnemonic_activate (GtkWidget *widget,
308 gboolean group_cycling);
309 static void gtk_widget_aux_info_destroy (GtkWidgetAuxInfo *aux_info);
310 static AtkObject* gtk_widget_real_get_accessible (GtkWidget *widget);
311 static void gtk_widget_accessible_interface_init (AtkImplementorIface *iface);
312 static AtkObject* gtk_widget_ref_accessible (AtkImplementor *implementor);
313 static void gtk_widget_invalidate_widget_windows (GtkWidget *widget,
315 static GdkScreen * gtk_widget_get_screen_unchecked (GtkWidget *widget);
316 static void gtk_widget_queue_shallow_draw (GtkWidget *widget);
317 static gboolean gtk_widget_real_can_activate_accel (GtkWidget *widget,
320 static void gtk_widget_real_set_has_tooltip (GtkWidget *widget,
321 gboolean has_tooltip,
323 static void gtk_widget_buildable_interface_init (GtkBuildableIface *iface);
324 static void gtk_widget_buildable_set_name (GtkBuildable *buildable,
326 static const gchar * gtk_widget_buildable_get_name (GtkBuildable *buildable);
327 static GObject * gtk_widget_buildable_get_internal_child (GtkBuildable *buildable,
329 const gchar *childname);
330 static void gtk_widget_buildable_set_buildable_property (GtkBuildable *buildable,
333 const GValue *value);
334 static gboolean gtk_widget_buildable_custom_tag_start (GtkBuildable *buildable,
337 const gchar *tagname,
338 GMarkupParser *parser,
340 static void gtk_widget_buildable_custom_finished (GtkBuildable *buildable,
343 const gchar *tagname,
345 static void gtk_widget_buildable_parser_finished (GtkBuildable *buildable,
346 GtkBuilder *builder);
348 static void gtk_widget_extended_layout_init (GtkExtendedLayoutIface *iface);
349 static void gtk_widget_real_get_desired_width (GtkExtendedLayout *layout,
352 static void gtk_widget_real_get_desired_height (GtkExtendedLayout *layout,
356 static void gtk_widget_queue_tooltip_query (GtkWidget *widget);
358 static void gtk_widget_set_usize_internal (GtkWidget *widget,
361 static void gtk_widget_get_draw_rectangle (GtkWidget *widget,
365 /* --- variables --- */
366 static gpointer gtk_widget_parent_class = NULL;
367 static guint widget_signals[LAST_SIGNAL] = { 0 };
368 static GtkStyle *gtk_default_style = NULL;
369 static GSList *colormap_stack = NULL;
370 static guint composite_child_stack = 0;
371 static GtkTextDirection gtk_default_direction = GTK_TEXT_DIR_LTR;
372 static GParamSpecPool *style_property_spec_pool = NULL;
374 static GQuark quark_property_parser = 0;
375 static GQuark quark_aux_info = 0;
376 static GQuark quark_accel_path = 0;
377 static GQuark quark_accel_closures = 0;
378 static GQuark quark_event_mask = 0;
379 static GQuark quark_extension_event_mode = 0;
380 static GQuark quark_parent_window = 0;
381 static GQuark quark_pointer_window = 0;
382 static GQuark quark_shape_info = 0;
383 static GQuark quark_input_shape_info = 0;
384 static GQuark quark_colormap = 0;
385 static GQuark quark_pango_context = 0;
386 static GQuark quark_rc_style = 0;
387 static GQuark quark_accessible_object = 0;
388 static GQuark quark_mnemonic_labels = 0;
389 static GQuark quark_tooltip_markup = 0;
390 static GQuark quark_has_tooltip = 0;
391 static GQuark quark_tooltip_window = 0;
392 GParamSpecPool *_gtk_widget_child_property_pool = NULL;
393 GObjectNotifyContext *_gtk_widget_child_property_notify_context = NULL;
395 /* --- functions --- */
397 gtk_widget_get_type (void)
399 static GType widget_type = 0;
401 if (G_UNLIKELY (widget_type == 0))
403 const GTypeInfo widget_info =
405 sizeof (GtkWidgetClass),
406 NULL, /* base_init */
407 (GBaseFinalizeFunc) gtk_widget_base_class_finalize,
408 (GClassInitFunc) gtk_widget_class_init,
409 NULL, /* class_finalize */
410 NULL, /* class_init */
413 (GInstanceInitFunc) gtk_widget_init,
414 NULL, /* value_table */
417 const GInterfaceInfo accessibility_info =
419 (GInterfaceInitFunc) gtk_widget_accessible_interface_init,
420 (GInterfaceFinalizeFunc) NULL,
421 NULL /* interface data */
424 const GInterfaceInfo buildable_info =
426 (GInterfaceInitFunc) gtk_widget_buildable_interface_init,
427 (GInterfaceFinalizeFunc) NULL,
428 NULL /* interface data */
431 const GInterfaceInfo layout_info =
433 (GInterfaceInitFunc) gtk_widget_extended_layout_init,
434 (GInterfaceFinalizeFunc) NULL,
435 NULL /* interface data */
438 widget_type = g_type_register_static (GTK_TYPE_OBJECT, "GtkWidget",
439 &widget_info, G_TYPE_FLAG_ABSTRACT);
441 g_type_add_interface_static (widget_type, ATK_TYPE_IMPLEMENTOR,
442 &accessibility_info) ;
443 g_type_add_interface_static (widget_type, GTK_TYPE_BUILDABLE,
445 g_type_add_interface_static (widget_type, GTK_TYPE_EXTENDED_LAYOUT,
453 child_property_notify_dispatcher (GObject *object,
457 GTK_WIDGET_GET_CLASS (object)->dispatch_child_properties_changed (GTK_WIDGET (object), n_pspecs, pspecs);
461 gtk_widget_class_init (GtkWidgetClass *klass)
463 static GObjectNotifyContext cpn_context = { 0, NULL, NULL };
464 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
465 GtkObjectClass *object_class = GTK_OBJECT_CLASS (klass);
466 GtkBindingSet *binding_set;
468 gtk_widget_parent_class = g_type_class_peek_parent (klass);
470 quark_property_parser = g_quark_from_static_string ("gtk-rc-property-parser");
471 quark_aux_info = g_quark_from_static_string ("gtk-aux-info");
472 quark_accel_path = g_quark_from_static_string ("gtk-accel-path");
473 quark_accel_closures = g_quark_from_static_string ("gtk-accel-closures");
474 quark_event_mask = g_quark_from_static_string ("gtk-event-mask");
475 quark_extension_event_mode = g_quark_from_static_string ("gtk-extension-event-mode");
476 quark_parent_window = g_quark_from_static_string ("gtk-parent-window");
477 quark_pointer_window = g_quark_from_static_string ("gtk-pointer-window");
478 quark_shape_info = g_quark_from_static_string ("gtk-shape-info");
479 quark_input_shape_info = g_quark_from_static_string ("gtk-input-shape-info");
480 quark_colormap = g_quark_from_static_string ("gtk-colormap");
481 quark_pango_context = g_quark_from_static_string ("gtk-pango-context");
482 quark_rc_style = g_quark_from_static_string ("gtk-rc-style");
483 quark_accessible_object = g_quark_from_static_string ("gtk-accessible-object");
484 quark_mnemonic_labels = g_quark_from_static_string ("gtk-mnemonic-labels");
485 quark_tooltip_markup = g_quark_from_static_string ("gtk-tooltip-markup");
486 quark_has_tooltip = g_quark_from_static_string ("gtk-has-tooltip");
487 quark_tooltip_window = g_quark_from_static_string ("gtk-tooltip-window");
489 style_property_spec_pool = g_param_spec_pool_new (FALSE);
490 _gtk_widget_child_property_pool = g_param_spec_pool_new (TRUE);
491 cpn_context.quark_notify_queue = g_quark_from_static_string ("GtkWidget-child-property-notify-queue");
492 cpn_context.dispatcher = child_property_notify_dispatcher;
493 _gtk_widget_child_property_notify_context = &cpn_context;
495 gobject_class->dispose = gtk_widget_dispose;
496 gobject_class->finalize = gtk_widget_finalize;
497 gobject_class->set_property = gtk_widget_set_property;
498 gobject_class->get_property = gtk_widget_get_property;
500 object_class->destroy = gtk_widget_real_destroy;
502 klass->activate_signal = 0;
503 klass->set_scroll_adjustments_signal = 0;
504 klass->dispatch_child_properties_changed = gtk_widget_dispatch_child_properties_changed;
505 klass->show = gtk_widget_real_show;
506 klass->show_all = gtk_widget_show;
507 klass->hide = gtk_widget_real_hide;
508 klass->hide_all = gtk_widget_hide;
509 klass->map = gtk_widget_real_map;
510 klass->unmap = gtk_widget_real_unmap;
511 klass->realize = gtk_widget_real_realize;
512 klass->unrealize = gtk_widget_real_unrealize;
513 klass->size_request = gtk_widget_real_size_request;
514 klass->size_allocate = gtk_widget_real_size_allocate;
515 klass->state_changed = NULL;
516 klass->parent_set = NULL;
517 klass->hierarchy_changed = NULL;
518 klass->style_set = gtk_widget_real_style_set;
519 klass->direction_changed = gtk_widget_real_direction_changed;
520 klass->grab_notify = NULL;
521 klass->child_notify = NULL;
522 klass->mnemonic_activate = gtk_widget_real_mnemonic_activate;
523 klass->grab_focus = gtk_widget_real_grab_focus;
524 klass->focus = gtk_widget_real_focus;
526 klass->button_press_event = NULL;
527 klass->button_release_event = NULL;
528 klass->motion_notify_event = NULL;
529 klass->delete_event = NULL;
530 klass->destroy_event = NULL;
531 klass->expose_event = NULL;
532 klass->key_press_event = gtk_widget_real_key_press_event;
533 klass->key_release_event = gtk_widget_real_key_release_event;
534 klass->enter_notify_event = NULL;
535 klass->leave_notify_event = NULL;
536 klass->configure_event = NULL;
537 klass->focus_in_event = gtk_widget_real_focus_in_event;
538 klass->focus_out_event = gtk_widget_real_focus_out_event;
539 klass->map_event = NULL;
540 klass->unmap_event = NULL;
541 klass->window_state_event = NULL;
542 klass->property_notify_event = _gtk_selection_property_notify;
543 klass->selection_clear_event = _gtk_selection_clear;
544 klass->selection_request_event = _gtk_selection_request;
545 klass->selection_notify_event = _gtk_selection_notify;
546 klass->selection_received = NULL;
547 klass->proximity_in_event = NULL;
548 klass->proximity_out_event = NULL;
549 klass->drag_begin = NULL;
550 klass->drag_end = NULL;
551 klass->drag_data_delete = NULL;
552 klass->drag_leave = NULL;
553 klass->drag_motion = NULL;
554 klass->drag_drop = NULL;
555 klass->drag_data_received = NULL;
556 klass->screen_changed = NULL;
557 klass->can_activate_accel = gtk_widget_real_can_activate_accel;
558 klass->grab_broken_event = NULL;
559 klass->query_tooltip = gtk_widget_real_query_tooltip;
561 klass->show_help = gtk_widget_real_show_help;
563 /* Accessibility support */
564 klass->get_accessible = gtk_widget_real_get_accessible;
566 klass->no_expose_event = NULL;
568 g_object_class_install_property (gobject_class,
570 g_param_spec_string ("name",
572 P_("The name of the widget"),
574 GTK_PARAM_READWRITE));
575 g_object_class_install_property (gobject_class,
577 g_param_spec_object ("parent",
579 P_("The parent widget of this widget. Must be a Container widget"),
581 GTK_PARAM_READWRITE));
583 g_object_class_install_property (gobject_class,
585 g_param_spec_int ("width-request",
587 P_("Override for width request of the widget, or -1 if natural request should be used"),
591 GTK_PARAM_READWRITE));
592 g_object_class_install_property (gobject_class,
594 g_param_spec_int ("height-request",
595 P_("Height request"),
596 P_("Override for height request of the widget, or -1 if natural request should be used"),
600 GTK_PARAM_READWRITE));
601 g_object_class_install_property (gobject_class,
603 g_param_spec_boolean ("visible",
605 P_("Whether the widget is visible"),
607 GTK_PARAM_READWRITE));
608 g_object_class_install_property (gobject_class,
610 g_param_spec_boolean ("sensitive",
612 P_("Whether the widget responds to input"),
614 GTK_PARAM_READWRITE));
615 g_object_class_install_property (gobject_class,
617 g_param_spec_boolean ("app-paintable",
618 P_("Application paintable"),
619 P_("Whether the application will paint directly on the widget"),
621 GTK_PARAM_READWRITE));
622 g_object_class_install_property (gobject_class,
624 g_param_spec_boolean ("can-focus",
626 P_("Whether the widget can accept the input focus"),
628 GTK_PARAM_READWRITE));
629 g_object_class_install_property (gobject_class,
631 g_param_spec_boolean ("has-focus",
633 P_("Whether the widget has the input focus"),
635 GTK_PARAM_READWRITE));
636 g_object_class_install_property (gobject_class,
638 g_param_spec_boolean ("is-focus",
640 P_("Whether the widget is the focus widget within the toplevel"),
642 GTK_PARAM_READWRITE));
643 g_object_class_install_property (gobject_class,
645 g_param_spec_boolean ("can-default",
647 P_("Whether the widget can be the default widget"),
649 GTK_PARAM_READWRITE));
650 g_object_class_install_property (gobject_class,
652 g_param_spec_boolean ("has-default",
654 P_("Whether the widget is the default widget"),
656 GTK_PARAM_READWRITE));
657 g_object_class_install_property (gobject_class,
658 PROP_RECEIVES_DEFAULT,
659 g_param_spec_boolean ("receives-default",
660 P_("Receives default"),
661 P_("If TRUE, the widget will receive the default action when it is focused"),
663 GTK_PARAM_READWRITE));
664 g_object_class_install_property (gobject_class,
665 PROP_COMPOSITE_CHILD,
666 g_param_spec_boolean ("composite-child",
667 P_("Composite child"),
668 P_("Whether the widget is part of a composite widget"),
670 GTK_PARAM_READABLE));
671 g_object_class_install_property (gobject_class,
673 g_param_spec_object ("style",
675 P_("The style of the widget, which contains information about how it will look (colors etc)"),
677 GTK_PARAM_READWRITE));
678 g_object_class_install_property (gobject_class,
680 g_param_spec_flags ("events",
682 P_("The event mask that decides what kind of GdkEvents this widget gets"),
685 GTK_PARAM_READWRITE));
686 g_object_class_install_property (gobject_class,
687 PROP_EXTENSION_EVENTS,
688 g_param_spec_enum ("extension-events",
689 P_("Extension events"),
690 P_("The mask that decides what kind of extension events this widget gets"),
691 GDK_TYPE_EXTENSION_MODE,
692 GDK_EXTENSION_EVENTS_NONE,
693 GTK_PARAM_READWRITE));
694 g_object_class_install_property (gobject_class,
696 g_param_spec_boolean ("no-show-all",
698 P_("Whether gtk_widget_show_all() should not affect this widget"),
700 GTK_PARAM_READWRITE));
703 * GtkWidget:has-tooltip:
705 * Enables or disables the emission of #GtkWidget::query-tooltip on @widget.
706 * A value of %TRUE indicates that @widget can have a tooltip, in this case
707 * the widget will be queried using #GtkWidget::query-tooltip to determine
708 * whether it will provide a tooltip or not.
710 * Note that setting this property to %TRUE for the first time will change
711 * the event masks of the GdkWindows of this widget to include leave-notify
712 * and motion-notify events. This cannot and will not be undone when the
713 * property is set to %FALSE again.
717 g_object_class_install_property (gobject_class,
719 g_param_spec_boolean ("has-tooltip",
721 P_("Whether this widget has a tooltip"),
723 GTK_PARAM_READWRITE));
725 * GtkWidget:tooltip-text:
727 * Sets the text of tooltip to be the given string.
729 * Also see gtk_tooltip_set_text().
731 * This is a convenience property which will take care of getting the
732 * tooltip shown if the given string is not %NULL: #GtkWidget:has-tooltip
733 * will automatically be set to %TRUE and there will be taken care of
734 * #GtkWidget::query-tooltip in the default signal handler.
738 g_object_class_install_property (gobject_class,
740 g_param_spec_string ("tooltip-text",
742 P_("The contents of the tooltip for this widget"),
744 GTK_PARAM_READWRITE));
746 * GtkWidget:tooltip-markup:
748 * Sets the text of tooltip to be the given string, which is marked up
749 * with the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
750 * Also see gtk_tooltip_set_markup().
752 * This is a convenience property which will take care of getting the
753 * tooltip shown if the given string is not %NULL: #GtkWidget:has-tooltip
754 * will automatically be set to %TRUE and there will be taken care of
755 * #GtkWidget::query-tooltip in the default signal handler.
759 g_object_class_install_property (gobject_class,
761 g_param_spec_string ("tooltip-markup",
762 P_("Tooltip markup"),
763 P_("The contents of the tooltip for this widget"),
765 GTK_PARAM_READWRITE));
770 * The widget's window if it is realized, %NULL otherwise.
774 g_object_class_install_property (gobject_class,
776 g_param_spec_object ("window",
778 P_("The widget's window if it is realized"),
780 GTK_PARAM_READABLE));
783 * GtkWidget:double-buffered
785 * Whether or not the widget is double buffered.
789 g_object_class_install_property (gobject_class,
790 PROP_DOUBLE_BUFFERED,
791 g_param_spec_boolean ("double-buffered",
792 P_("Double Buffered"),
793 P_("Whether or not the widget is double buffered"),
795 GTK_PARAM_READWRITE));
799 * @widget: the object which received the signal.
801 widget_signals[SHOW] =
802 g_signal_new (I_("show"),
803 G_TYPE_FROM_CLASS (gobject_class),
805 G_STRUCT_OFFSET (GtkWidgetClass, show),
807 _gtk_marshal_VOID__VOID,
812 * @widget: the object which received the signal.
814 widget_signals[HIDE] =
815 g_signal_new (I_("hide"),
816 G_TYPE_FROM_CLASS (gobject_class),
818 G_STRUCT_OFFSET (GtkWidgetClass, hide),
820 _gtk_marshal_VOID__VOID,
825 * @widget: the object which received the signal.
827 widget_signals[MAP] =
828 g_signal_new (I_("map"),
829 G_TYPE_FROM_CLASS (gobject_class),
831 G_STRUCT_OFFSET (GtkWidgetClass, map),
833 _gtk_marshal_VOID__VOID,
838 * @widget: the object which received the signal.
840 widget_signals[UNMAP] =
841 g_signal_new (I_("unmap"),
842 G_TYPE_FROM_CLASS (gobject_class),
844 G_STRUCT_OFFSET (GtkWidgetClass, unmap),
846 _gtk_marshal_VOID__VOID,
850 * GtkWidget::realize:
851 * @widget: the object which received the signal.
853 widget_signals[REALIZE] =
854 g_signal_new (I_("realize"),
855 G_TYPE_FROM_CLASS (gobject_class),
857 G_STRUCT_OFFSET (GtkWidgetClass, realize),
859 _gtk_marshal_VOID__VOID,
863 * GtkWidget::unrealize:
864 * @widget: the object which received the signal.
866 widget_signals[UNREALIZE] =
867 g_signal_new (I_("unrealize"),
868 G_TYPE_FROM_CLASS (gobject_class),
870 G_STRUCT_OFFSET (GtkWidgetClass, unrealize),
872 _gtk_marshal_VOID__VOID,
876 * GtkWidget::size-request:
877 * @widget: the object which received the signal.
880 widget_signals[SIZE_REQUEST] =
881 g_signal_new (I_("size-request"),
882 G_TYPE_FROM_CLASS (gobject_class),
884 G_STRUCT_OFFSET (GtkWidgetClass, size_request),
886 _gtk_marshal_VOID__BOXED,
888 GTK_TYPE_REQUISITION | G_SIGNAL_TYPE_STATIC_SCOPE);
891 * GtkWidget::size-allocate:
892 * @widget: the object which received the signal.
895 widget_signals[SIZE_ALLOCATE] =
896 g_signal_new (I_("size-allocate"),
897 G_TYPE_FROM_CLASS (gobject_class),
899 G_STRUCT_OFFSET (GtkWidgetClass, size_allocate),
901 _gtk_marshal_VOID__BOXED,
903 GDK_TYPE_RECTANGLE | G_SIGNAL_TYPE_STATIC_SCOPE);
906 * GtkWidget::state-changed:
907 * @widget: the object which received the signal.
908 * @state: the previous state
910 * The ::state-changed signal is emitted when the widget state changes.
911 * See gtk_widget_get_state().
913 widget_signals[STATE_CHANGED] =
914 g_signal_new (I_("state-changed"),
915 G_TYPE_FROM_CLASS (gobject_class),
917 G_STRUCT_OFFSET (GtkWidgetClass, state_changed),
919 _gtk_marshal_VOID__ENUM,
921 GTK_TYPE_STATE_TYPE);
924 * GtkWidget::parent-set:
925 * @widget: the object on which the signal is emitted
926 * @old_parent: (allow-none): the previous parent, or %NULL if the widget
927 * just got its initial parent.
929 * The ::parent-set signal is emitted when a new parent
930 * has been set on a widget.
932 widget_signals[PARENT_SET] =
933 g_signal_new (I_("parent-set"),
934 G_TYPE_FROM_CLASS (gobject_class),
936 G_STRUCT_OFFSET (GtkWidgetClass, parent_set),
938 _gtk_marshal_VOID__OBJECT,
943 * GtkWidget::hierarchy-changed:
944 * @widget: the object on which the signal is emitted
945 * @previous_toplevel: (allow-none): the previous toplevel ancestor, or %NULL
946 * if the widget was previously unanchored
948 * The ::hierarchy-changed signal is emitted when the
949 * anchored state of a widget changes. A widget is
950 * <firstterm>anchored</firstterm> when its toplevel
951 * ancestor is a #GtkWindow. This signal is emitted when
952 * a widget changes from un-anchored to anchored or vice-versa.
954 widget_signals[HIERARCHY_CHANGED] =
955 g_signal_new (I_("hierarchy-changed"),
956 G_TYPE_FROM_CLASS (gobject_class),
958 G_STRUCT_OFFSET (GtkWidgetClass, hierarchy_changed),
960 _gtk_marshal_VOID__OBJECT,
965 * GtkWidget::style-set:
966 * @widget: the object on which the signal is emitted
967 * @previous_style: (allow-none): the previous style, or %NULL if the widget
968 * just got its initial style
970 * The ::style-set signal is emitted when a new style has been set
971 * on a widget. Note that style-modifying functions like
972 * gtk_widget_modify_base() also cause this signal to be emitted.
974 widget_signals[STYLE_SET] =
975 g_signal_new (I_("style-set"),
976 G_TYPE_FROM_CLASS (gobject_class),
978 G_STRUCT_OFFSET (GtkWidgetClass, style_set),
980 _gtk_marshal_VOID__OBJECT,
984 * GtkWidget::direction-changed:
985 * @widget: the object on which the signal is emitted
986 * @previous_direction: the previous text direction of @widget
988 * The ::direction-changed signal is emitted when the text direction
989 * of a widget changes.
991 widget_signals[DIRECTION_CHANGED] =
992 g_signal_new (I_("direction-changed"),
993 G_TYPE_FROM_CLASS (gobject_class),
995 G_STRUCT_OFFSET (GtkWidgetClass, direction_changed),
997 _gtk_marshal_VOID__ENUM,
999 GTK_TYPE_TEXT_DIRECTION);
1002 * GtkWidget::grab-notify:
1003 * @widget: the object which received the signal
1004 * @was_grabbed: %FALSE if the widget becomes shadowed, %TRUE
1005 * if it becomes unshadowed
1007 * The ::grab-notify signal is emitted when a widget becomes
1008 * shadowed by a GTK+ grab (not a pointer or keyboard grab) on
1009 * another widget, or when it becomes unshadowed due to a grab
1012 * A widget is shadowed by a gtk_grab_add() when the topmost
1013 * grab widget in the grab stack of its window group is not
1016 widget_signals[GRAB_NOTIFY] =
1017 g_signal_new (I_("grab-notify"),
1018 G_TYPE_FROM_CLASS (gobject_class),
1020 G_STRUCT_OFFSET (GtkWidgetClass, grab_notify),
1022 _gtk_marshal_VOID__BOOLEAN,
1027 * GtkWidget::child-notify:
1028 * @widget: the object which received the signal
1029 * @pspec: the #GParamSpec of the changed child property
1031 * The ::child-notify signal is emitted for each
1032 * <link linkend="child-properties">child property</link> that has
1033 * changed on an object. The signal's detail holds the property name.
1035 widget_signals[CHILD_NOTIFY] =
1036 g_signal_new (I_("child-notify"),
1037 G_TYPE_FROM_CLASS (gobject_class),
1038 G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE | G_SIGNAL_DETAILED | G_SIGNAL_NO_HOOKS,
1039 G_STRUCT_OFFSET (GtkWidgetClass, child_notify),
1041 g_cclosure_marshal_VOID__PARAM,
1046 * GtkWidget::mnemonic-activate:
1047 * @widget: the object which received the signal.
1050 widget_signals[MNEMONIC_ACTIVATE] =
1051 g_signal_new (I_("mnemonic-activate"),
1052 G_TYPE_FROM_CLASS (gobject_class),
1054 G_STRUCT_OFFSET (GtkWidgetClass, mnemonic_activate),
1055 _gtk_boolean_handled_accumulator, NULL,
1056 _gtk_marshal_BOOLEAN__BOOLEAN,
1061 * GtkWidget::grab-focus:
1062 * @widget: the object which received the signal.
1064 widget_signals[GRAB_FOCUS] =
1065 g_signal_new (I_("grab-focus"),
1066 G_TYPE_FROM_CLASS (gobject_class),
1067 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
1068 G_STRUCT_OFFSET (GtkWidgetClass, grab_focus),
1070 _gtk_marshal_VOID__VOID,
1075 * @widget: the object which received the signal.
1078 * Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
1080 widget_signals[FOCUS] =
1081 g_signal_new (I_("focus"),
1082 G_TYPE_FROM_CLASS (object_class),
1084 G_STRUCT_OFFSET (GtkWidgetClass, focus),
1085 _gtk_boolean_handled_accumulator, NULL,
1086 _gtk_marshal_BOOLEAN__ENUM,
1088 GTK_TYPE_DIRECTION_TYPE);
1091 * GtkWidget::move-focus:
1092 * @widget: the object which received the signal.
1095 widget_signals[MOVE_FOCUS] =
1096 g_signal_new_class_handler (I_("move-focus"),
1097 G_TYPE_FROM_CLASS (object_class),
1098 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
1099 G_CALLBACK (gtk_widget_real_move_focus),
1101 _gtk_marshal_VOID__ENUM,
1104 GTK_TYPE_DIRECTION_TYPE);
1107 * @widget: the object which received the signal.
1108 * @event: the #GdkEvent which triggered this signal
1110 * The GTK+ main loop will emit three signals for each GDK event delivered
1111 * to a widget: one generic ::event signal, another, more specific,
1112 * signal that matches the type of event delivered (e.g.
1113 * #GtkWidget::key-press-event) and finally a generic
1114 * #GtkWidget::event-after signal.
1116 * Returns: %TRUE to stop other handlers from being invoked for the event
1117 * and to cancel the emission of the second specific ::event signal.
1118 * %FALSE to propagate the event further and to allow the emission of
1119 * the second signal. The ::event-after signal is emitted regardless of
1122 widget_signals[EVENT] =
1123 g_signal_new (I_("event"),
1124 G_TYPE_FROM_CLASS (gobject_class),
1126 G_STRUCT_OFFSET (GtkWidgetClass, event),
1127 _gtk_boolean_handled_accumulator, NULL,
1128 _gtk_marshal_BOOLEAN__BOXED,
1130 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1133 * GtkWidget::event-after:
1134 * @widget: the object which received the signal.
1135 * @event: the #GdkEvent which triggered this signal
1137 * After the emission of the #GtkWidget::event signal and (optionally)
1138 * the second more specific signal, ::event-after will be emitted
1139 * regardless of the previous two signals handlers return values.
1142 widget_signals[EVENT_AFTER] =
1143 g_signal_new (I_("event-after"),
1144 G_TYPE_FROM_CLASS (gobject_class),
1148 _gtk_marshal_VOID__BOXED,
1150 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1153 * GtkWidget::button-press-event:
1154 * @widget: the object which received the signal.
1155 * @event: the #GdkEventButton which triggered this signal
1157 * The ::button-press-event signal will be emitted when a button
1158 * (typically from a mouse) is pressed.
1160 * To receive this signal, the #GdkWindow associated to the
1161 * widget needs to enable the #GDK_BUTTON_PRESS_MASK mask.
1163 * This signal will be sent to the grab widget if there is one.
1165 * Returns: %TRUE to stop other handlers from being invoked for the event.
1166 * %FALSE to propagate the event further.
1168 widget_signals[BUTTON_PRESS_EVENT] =
1169 g_signal_new (I_("button-press-event"),
1170 G_TYPE_FROM_CLASS (gobject_class),
1172 G_STRUCT_OFFSET (GtkWidgetClass, button_press_event),
1173 _gtk_boolean_handled_accumulator, NULL,
1174 _gtk_marshal_BOOLEAN__BOXED,
1176 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1179 * GtkWidget::button-release-event:
1180 * @widget: the object which received the signal.
1181 * @event: the #GdkEventButton which triggered this signal
1183 * The ::button-release-event signal will be emitted when a button
1184 * (typically from a mouse) is released.
1186 * To receive this signal, the #GdkWindow associated to the
1187 * widget needs to enable the #GDK_BUTTON_RELEASE_MASK mask.
1189 * This signal will be sent to the grab widget if there is one.
1191 * Returns: %TRUE to stop other handlers from being invoked for the event.
1192 * %FALSE to propagate the event further.
1194 widget_signals[BUTTON_RELEASE_EVENT] =
1195 g_signal_new (I_("button-release-event"),
1196 G_TYPE_FROM_CLASS (gobject_class),
1198 G_STRUCT_OFFSET (GtkWidgetClass, button_release_event),
1199 _gtk_boolean_handled_accumulator, NULL,
1200 _gtk_marshal_BOOLEAN__BOXED,
1202 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1205 * GtkWidget::scroll-event:
1206 * @widget: the object which received the signal.
1207 * @event: the #GdkEventScroll which triggered this signal
1209 * The ::scroll-event signal is emitted when a button in the 4 to 7
1210 * range is pressed. Wheel mice are usually configured to generate
1211 * button press events for buttons 4 and 5 when the wheel is turned.
1213 * To receive this signal, the #GdkWindow associated to the widget needs
1214 * to enable the #GDK_BUTTON_PRESS_MASK mask.
1216 * This signal will be sent to the grab widget if there is one.
1218 * Returns: %TRUE to stop other handlers from being invoked for the event.
1219 * %FALSE to propagate the event further.
1221 widget_signals[SCROLL_EVENT] =
1222 g_signal_new (I_("scroll-event"),
1223 G_TYPE_FROM_CLASS (gobject_class),
1225 G_STRUCT_OFFSET (GtkWidgetClass, scroll_event),
1226 _gtk_boolean_handled_accumulator, NULL,
1227 _gtk_marshal_BOOLEAN__BOXED,
1229 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1231 * GtkWidget::motion-notify-event:
1232 * @widget: the object which received the signal.
1233 * @event: the #GdkEventMotion which triggered this signal
1235 * The ::motion-notify-event signal is emitted when the pointer moves
1236 * over the widget's #GdkWindow.
1238 * To receive this signal, the #GdkWindow associated to the widget
1239 * needs to enable the #GDK_POINTER_MOTION_MASK mask.
1241 * This signal will be sent to the grab widget if there is one.
1243 * Returns: %TRUE to stop other handlers from being invoked for the event.
1244 * %FALSE to propagate the event further.
1246 widget_signals[MOTION_NOTIFY_EVENT] =
1247 g_signal_new (I_("motion-notify-event"),
1248 G_TYPE_FROM_CLASS (gobject_class),
1250 G_STRUCT_OFFSET (GtkWidgetClass, motion_notify_event),
1251 _gtk_boolean_handled_accumulator, NULL,
1252 _gtk_marshal_BOOLEAN__BOXED,
1254 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1257 * GtkWidget::composited-changed:
1258 * @widget: the object on which the signal is emitted
1260 * The ::composited-changed signal is emitted when the composited
1261 * status of @widget<!-- -->s screen changes.
1262 * See gdk_screen_is_composited().
1264 widget_signals[COMPOSITED_CHANGED] =
1265 g_signal_new (I_("composited-changed"),
1266 G_TYPE_FROM_CLASS (gobject_class),
1267 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
1268 G_STRUCT_OFFSET (GtkWidgetClass, composited_changed),
1270 _gtk_marshal_VOID__VOID,
1274 * GtkWidget::keynav-failed:
1275 * @widget: the object which received the signal
1276 * @direction: the direction of movement
1278 * Gets emitted if keyboard navigation fails.
1279 * See gtk_widget_keynav_failed() for details.
1281 * Returns: %TRUE if stopping keyboard navigation is fine, %FALSE
1282 * if the emitting widget should try to handle the keyboard
1283 * navigation attempt in its parent container(s).
1287 widget_signals[KEYNAV_FAILED] =
1288 g_signal_new_class_handler (I_("keynav-failed"),
1289 G_TYPE_FROM_CLASS (gobject_class),
1291 G_CALLBACK (gtk_widget_real_keynav_failed),
1292 _gtk_boolean_handled_accumulator, NULL,
1293 _gtk_marshal_BOOLEAN__ENUM,
1295 GTK_TYPE_DIRECTION_TYPE);
1298 * GtkWidget::delete-event:
1299 * @widget: the object which received the signal
1300 * @event: the event which triggered this signal
1302 * The ::delete-event signal is emitted if a user requests that
1303 * a toplevel window is closed. The default handler for this signal
1304 * destroys the window. Connecting gtk_widget_hide_on_delete() to
1305 * this signal will cause the window to be hidden instead, so that
1306 * it can later be shown again without reconstructing it.
1308 * Returns: %TRUE to stop other handlers from being invoked for the event.
1309 * %FALSE to propagate the event further.
1311 widget_signals[DELETE_EVENT] =
1312 g_signal_new (I_("delete-event"),
1313 G_TYPE_FROM_CLASS (gobject_class),
1315 G_STRUCT_OFFSET (GtkWidgetClass, delete_event),
1316 _gtk_boolean_handled_accumulator, NULL,
1317 _gtk_marshal_BOOLEAN__BOXED,
1319 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1322 * GtkWidget::destroy-event:
1323 * @widget: the object which received the signal.
1324 * @event: the event which triggered this signal
1326 * The ::destroy-event signal is emitted when a #GdkWindow is destroyed.
1327 * You rarely get this signal, because most widgets disconnect themselves
1328 * from their window before they destroy it, so no widget owns the
1329 * window at destroy time.
1331 * To receive this signal, the #GdkWindow associated to the widget needs
1332 * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
1333 * automatically for all new windows.
1335 * Returns: %TRUE to stop other handlers from being invoked for the event.
1336 * %FALSE to propagate the event further.
1338 widget_signals[DESTROY_EVENT] =
1339 g_signal_new (I_("destroy-event"),
1340 G_TYPE_FROM_CLASS (gobject_class),
1342 G_STRUCT_OFFSET (GtkWidgetClass, destroy_event),
1343 _gtk_boolean_handled_accumulator, NULL,
1344 _gtk_marshal_BOOLEAN__BOXED,
1346 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1349 * GtkWidget::expose-event:
1350 * @widget: the object which received the signal.
1351 * @event: the #GdkEventExpose which triggered this signal
1353 * The ::expose-event signal is emitted when an area of a previously
1354 * obscured #GdkWindow is made visible and needs to be redrawn.
1355 * #GTK_NO_WINDOW widgets will get a synthesized event from their parent
1358 * To receive this signal, the #GdkWindow associated to the widget needs
1359 * to enable the #GDK_EXPOSURE_MASK mask.
1361 * Returns: %TRUE to stop other handlers from being invoked for the event.
1362 * %FALSE to propagate the event further.
1364 widget_signals[EXPOSE_EVENT] =
1365 g_signal_new (I_("expose-event"),
1366 G_TYPE_FROM_CLASS (gobject_class),
1368 G_STRUCT_OFFSET (GtkWidgetClass, expose_event),
1369 _gtk_boolean_handled_accumulator, NULL,
1370 _gtk_marshal_BOOLEAN__BOXED,
1372 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1375 * GtkWidget::key-press-event:
1376 * @widget: the object which received the signal
1377 * @event: the #GdkEventKey which triggered this signal
1379 * The ::key-press-event signal is emitted when a key is pressed.
1381 * To receive this signal, the #GdkWindow associated to the widget needs
1382 * to enable the #GDK_KEY_PRESS_MASK mask.
1384 * This signal will be sent to the grab widget if there is one.
1386 * Returns: %TRUE to stop other handlers from being invoked for the event.
1387 * %FALSE to propagate the event further.
1389 widget_signals[KEY_PRESS_EVENT] =
1390 g_signal_new (I_("key-press-event"),
1391 G_TYPE_FROM_CLASS (gobject_class),
1393 G_STRUCT_OFFSET (GtkWidgetClass, key_press_event),
1394 _gtk_boolean_handled_accumulator, NULL,
1395 _gtk_marshal_BOOLEAN__BOXED,
1397 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1400 * GtkWidget::key-release-event:
1401 * @widget: the object which received the signal
1402 * @event: the #GdkEventKey which triggered this signal
1404 * The ::key-release-event signal is emitted when a key is pressed.
1406 * To receive this signal, the #GdkWindow associated to the widget needs
1407 * to enable the #GDK_KEY_RELEASE_MASK mask.
1409 * This signal will be sent to the grab widget if there is one.
1411 * Returns: %TRUE to stop other handlers from being invoked for the event.
1412 * %FALSE to propagate the event further.
1414 widget_signals[KEY_RELEASE_EVENT] =
1415 g_signal_new (I_("key-release-event"),
1416 G_TYPE_FROM_CLASS (gobject_class),
1418 G_STRUCT_OFFSET (GtkWidgetClass, key_release_event),
1419 _gtk_boolean_handled_accumulator, NULL,
1420 _gtk_marshal_BOOLEAN__BOXED,
1422 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1425 * GtkWidget::enter-notify-event:
1426 * @widget: the object which received the signal
1427 * @event: the #GdkEventCrossing which triggered this signal
1429 * The ::enter-notify-event will be emitted when the pointer enters
1430 * the @widget's window.
1432 * To receive this signal, the #GdkWindow associated to the widget needs
1433 * to enable the #GDK_ENTER_NOTIFY_MASK mask.
1435 * This signal will be sent to the grab widget if there is one.
1437 * Returns: %TRUE to stop other handlers from being invoked for the event.
1438 * %FALSE to propagate the event further.
1440 widget_signals[ENTER_NOTIFY_EVENT] =
1441 g_signal_new (I_("enter-notify-event"),
1442 G_TYPE_FROM_CLASS (gobject_class),
1444 G_STRUCT_OFFSET (GtkWidgetClass, enter_notify_event),
1445 _gtk_boolean_handled_accumulator, NULL,
1446 _gtk_marshal_BOOLEAN__BOXED,
1448 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1451 * GtkWidget::leave-notify-event:
1452 * @widget: the object which received the signal
1453 * @event: the #GdkEventCrossing which triggered this signal
1455 * The ::leave-notify-event will be emitted when the pointer leaves
1456 * the @widget's window.
1458 * To receive this signal, the #GdkWindow associated to the widget needs
1459 * to enable the #GDK_LEAVE_NOTIFY_MASK mask.
1461 * This signal will be sent to the grab widget if there is one.
1463 * Returns: %TRUE to stop other handlers from being invoked for the event.
1464 * %FALSE to propagate the event further.
1466 widget_signals[LEAVE_NOTIFY_EVENT] =
1467 g_signal_new (I_("leave-notify-event"),
1468 G_TYPE_FROM_CLASS (gobject_class),
1470 G_STRUCT_OFFSET (GtkWidgetClass, leave_notify_event),
1471 _gtk_boolean_handled_accumulator, NULL,
1472 _gtk_marshal_BOOLEAN__BOXED,
1474 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1477 * GtkWidget::configure-event
1478 * @widget: the object which received the signal
1479 * @event: the #GdkEventConfigure which triggered this signal
1481 * The ::configure-event signal will be emitted when the size, position or
1482 * stacking of the @widget's window has changed.
1484 * To receive this signal, the #GdkWindow associated to the widget needs
1485 * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
1486 * automatically for all new windows.
1488 * Returns: %TRUE to stop other handlers from being invoked for the event.
1489 * %FALSE to propagate the event further.
1491 widget_signals[CONFIGURE_EVENT] =
1492 g_signal_new (I_("configure-event"),
1493 G_TYPE_FROM_CLASS (gobject_class),
1495 G_STRUCT_OFFSET (GtkWidgetClass, configure_event),
1496 _gtk_boolean_handled_accumulator, NULL,
1497 _gtk_marshal_BOOLEAN__BOXED,
1499 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1502 * GtkWidget::focus-in-event
1503 * @widget: the object which received the signal
1504 * @event: the #GdkEventFocus which triggered this signal
1506 * The ::focus-in-event signal will be emitted when the keyboard focus
1507 * enters the @widget's window.
1509 * To receive this signal, the #GdkWindow associated to the widget needs
1510 * to enable the #GDK_FOCUS_CHANGE_MASK mask.
1512 * Returns: %TRUE to stop other handlers from being invoked for the event.
1513 * %FALSE to propagate the event further.
1515 widget_signals[FOCUS_IN_EVENT] =
1516 g_signal_new (I_("focus-in-event"),
1517 G_TYPE_FROM_CLASS (gobject_class),
1519 G_STRUCT_OFFSET (GtkWidgetClass, focus_in_event),
1520 _gtk_boolean_handled_accumulator, NULL,
1521 _gtk_marshal_BOOLEAN__BOXED,
1523 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1526 * GtkWidget::focus-out-event
1527 * @widget: the object which received the signal
1528 * @event: the #GdkEventFocus which triggered this signal
1530 * The ::focus-out-event signal will be emitted when the keyboard focus
1531 * leaves the @widget's window.
1533 * To receive this signal, the #GdkWindow associated to the widget needs
1534 * to enable the #GDK_FOCUS_CHANGE_MASK mask.
1536 * Returns: %TRUE to stop other handlers from being invoked for the event.
1537 * %FALSE to propagate the event further.
1539 widget_signals[FOCUS_OUT_EVENT] =
1540 g_signal_new (I_("focus-out-event"),
1541 G_TYPE_FROM_CLASS (gobject_class),
1543 G_STRUCT_OFFSET (GtkWidgetClass, focus_out_event),
1544 _gtk_boolean_handled_accumulator, NULL,
1545 _gtk_marshal_BOOLEAN__BOXED,
1547 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1550 * GtkWidget::map-event
1551 * @widget: the object which received the signal
1552 * @event: the #GdkEventAny which triggered this signal
1554 * The ::map-event signal will be emitted when the @widget's window is
1555 * mapped. A window is mapped when it becomes visible on the screen.
1557 * To receive this signal, the #GdkWindow associated to the widget needs
1558 * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
1559 * automatically for all new windows.
1561 * Returns: %TRUE to stop other handlers from being invoked for the event.
1562 * %FALSE to propagate the event further.
1564 widget_signals[MAP_EVENT] =
1565 g_signal_new (I_("map-event"),
1566 G_TYPE_FROM_CLASS (gobject_class),
1568 G_STRUCT_OFFSET (GtkWidgetClass, map_event),
1569 _gtk_boolean_handled_accumulator, NULL,
1570 _gtk_marshal_BOOLEAN__BOXED,
1572 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1575 * GtkWidget::unmap-event
1576 * @widget: the object which received the signal
1577 * @event: the #GdkEventAny which triggered this signal
1579 * The ::unmap-event signal will be emitted when the @widget's window is
1580 * unmapped. A window is unmapped when it becomes invisible on the screen.
1582 * To receive this signal, the #GdkWindow associated to the widget needs
1583 * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
1584 * automatically for all new windows.
1586 * Returns: %TRUE to stop other handlers from being invoked for the event.
1587 * %FALSE to propagate the event further.
1589 widget_signals[UNMAP_EVENT] =
1590 g_signal_new (I_("unmap-event"),
1591 G_TYPE_FROM_CLASS (gobject_class),
1593 G_STRUCT_OFFSET (GtkWidgetClass, unmap_event),
1594 _gtk_boolean_handled_accumulator, NULL,
1595 _gtk_marshal_BOOLEAN__BOXED,
1597 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1600 * GtkWidget::property-notify-event
1601 * @widget: the object which received the signal
1602 * @event: the #GdkEventProperty which triggered this signal
1604 * The ::property-notify-event signal will be emitted when a property on
1605 * the @widget's window has been changed or deleted.
1607 * To receive this signal, the #GdkWindow associated to the widget needs
1608 * to enable the #GDK_PROPERTY_CHANGE_MASK mask.
1610 * Returns: %TRUE to stop other handlers from being invoked for the event.
1611 * %FALSE to propagate the event further.
1613 widget_signals[PROPERTY_NOTIFY_EVENT] =
1614 g_signal_new (I_("property-notify-event"),
1615 G_TYPE_FROM_CLASS (gobject_class),
1617 G_STRUCT_OFFSET (GtkWidgetClass, property_notify_event),
1618 _gtk_boolean_handled_accumulator, NULL,
1619 _gtk_marshal_BOOLEAN__BOXED,
1621 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1624 * GtkWidget::selection-clear-event
1625 * @widget: the object which received the signal
1626 * @event: the #GdkEventSelection which triggered this signal
1628 * The ::selection-clear-event signal will be emitted when the
1629 * the @widget's window has lost ownership of a selection.
1631 * Returns: %TRUE to stop other handlers from being invoked for the event.
1632 * %FALSE to propagate the event further.
1634 widget_signals[SELECTION_CLEAR_EVENT] =
1635 g_signal_new (I_("selection-clear-event"),
1636 G_TYPE_FROM_CLASS (gobject_class),
1638 G_STRUCT_OFFSET (GtkWidgetClass, selection_clear_event),
1639 _gtk_boolean_handled_accumulator, NULL,
1640 _gtk_marshal_BOOLEAN__BOXED,
1642 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1645 * GtkWidget::selection-request-event
1646 * @widget: the object which received the signal
1647 * @event: the #GdkEventSelection which triggered this signal
1649 * The ::selection-request-event signal will be emitted when
1650 * another client requests ownership of the selection owned by
1651 * the @widget's window.
1653 * Returns: %TRUE to stop other handlers from being invoked for the event.
1654 * %FALSE to propagate the event further.
1656 widget_signals[SELECTION_REQUEST_EVENT] =
1657 g_signal_new (I_("selection-request-event"),
1658 G_TYPE_FROM_CLASS (gobject_class),
1660 G_STRUCT_OFFSET (GtkWidgetClass, selection_request_event),
1661 _gtk_boolean_handled_accumulator, NULL,
1662 _gtk_marshal_BOOLEAN__BOXED,
1664 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1667 * GtkWidget::selection-notify-event:
1668 * @widget: the object which received the signal.
1671 * Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
1673 widget_signals[SELECTION_NOTIFY_EVENT] =
1674 g_signal_new (I_("selection-notify-event"),
1675 G_TYPE_FROM_CLASS (gobject_class),
1677 G_STRUCT_OFFSET (GtkWidgetClass, selection_notify_event),
1678 _gtk_boolean_handled_accumulator, NULL,
1679 _gtk_marshal_BOOLEAN__BOXED,
1681 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1684 * GtkWidget::selection-received:
1685 * @widget: the object which received the signal.
1689 widget_signals[SELECTION_RECEIVED] =
1690 g_signal_new (I_("selection-received"),
1691 G_TYPE_FROM_CLASS (gobject_class),
1693 G_STRUCT_OFFSET (GtkWidgetClass, selection_received),
1695 _gtk_marshal_VOID__BOXED_UINT,
1697 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
1701 * GtkWidget::selection-get:
1702 * @widget: the object which received the signal.
1707 widget_signals[SELECTION_GET] =
1708 g_signal_new (I_("selection-get"),
1709 G_TYPE_FROM_CLASS (gobject_class),
1711 G_STRUCT_OFFSET (GtkWidgetClass, selection_get),
1713 _gtk_marshal_VOID__BOXED_UINT_UINT,
1715 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
1720 * GtkWidget::proximity-in-event
1721 * @widget: the object which received the signal
1722 * @event: the #GdkEventProximity which triggered this signal
1724 * To receive this signal the #GdkWindow associated to the widget needs
1725 * to enable the #GDK_PROXIMITY_IN_MASK mask.
1727 * This signal will be sent to the grab widget if there is one.
1729 * Returns: %TRUE to stop other handlers from being invoked for the event.
1730 * %FALSE to propagate the event further.
1732 widget_signals[PROXIMITY_IN_EVENT] =
1733 g_signal_new (I_("proximity-in-event"),
1734 G_TYPE_FROM_CLASS (gobject_class),
1736 G_STRUCT_OFFSET (GtkWidgetClass, proximity_in_event),
1737 _gtk_boolean_handled_accumulator, NULL,
1738 _gtk_marshal_BOOLEAN__BOXED,
1740 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1743 * GtkWidget::proximity-out-event
1744 * @widget: the object which received the signal
1745 * @event: the #GdkEventProximity which triggered this signal
1747 * To receive this signal the #GdkWindow associated to the widget needs
1748 * to enable the #GDK_PROXIMITY_OUT_MASK mask.
1750 * This signal will be sent to the grab widget if there is one.
1752 * Returns: %TRUE to stop other handlers from being invoked for the event.
1753 * %FALSE to propagate the event further.
1755 widget_signals[PROXIMITY_OUT_EVENT] =
1756 g_signal_new (I_("proximity-out-event"),
1757 G_TYPE_FROM_CLASS (gobject_class),
1759 G_STRUCT_OFFSET (GtkWidgetClass, proximity_out_event),
1760 _gtk_boolean_handled_accumulator, NULL,
1761 _gtk_marshal_BOOLEAN__BOXED,
1763 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1766 * GtkWidget::drag-leave:
1767 * @widget: the object which received the signal.
1768 * @drag_context: the drag context
1769 * @time: the timestamp of the motion event
1771 * The ::drag-leave signal is emitted on the drop site when the cursor
1772 * leaves the widget. A typical reason to connect to this signal is to
1773 * undo things done in #GtkWidget::drag-motion, e.g. undo highlighting
1774 * with gtk_drag_unhighlight()
1776 widget_signals[DRAG_LEAVE] =
1777 g_signal_new (I_("drag-leave"),
1778 G_TYPE_FROM_CLASS (gobject_class),
1780 G_STRUCT_OFFSET (GtkWidgetClass, drag_leave),
1782 _gtk_marshal_VOID__OBJECT_UINT,
1784 GDK_TYPE_DRAG_CONTEXT,
1788 * GtkWidget::drag-begin:
1789 * @widget: the object which received the signal
1790 * @drag_context: the drag context
1792 * The ::drag-begin signal is emitted on the drag source when a drag is
1793 * started. A typical reason to connect to this signal is to set up a
1794 * custom drag icon with gtk_drag_source_set_icon().
1796 * Note that some widgets set up a drag icon in the default handler of
1797 * this signal, so you may have to use g_signal_connect_after() to
1798 * override what the default handler did.
1800 widget_signals[DRAG_BEGIN] =
1801 g_signal_new (I_("drag-begin"),
1802 G_TYPE_FROM_CLASS (gobject_class),
1804 G_STRUCT_OFFSET (GtkWidgetClass, drag_begin),
1806 _gtk_marshal_VOID__OBJECT,
1808 GDK_TYPE_DRAG_CONTEXT);
1811 * GtkWidget::drag-end:
1812 * @widget: the object which received the signal
1813 * @drag_context: the drag context
1815 * The ::drag-end signal is emitted on the drag source when a drag is
1816 * finished. A typical reason to connect to this signal is to undo
1817 * things done in #GtkWidget::drag-begin.
1819 widget_signals[DRAG_END] =
1820 g_signal_new (I_("drag-end"),
1821 G_TYPE_FROM_CLASS (gobject_class),
1823 G_STRUCT_OFFSET (GtkWidgetClass, drag_end),
1825 _gtk_marshal_VOID__OBJECT,
1827 GDK_TYPE_DRAG_CONTEXT);
1830 * GtkWidget::drag-data-delete:
1831 * @widget: the object which received the signal
1832 * @drag_context: the drag context
1834 * The ::drag-data-delete signal is emitted on the drag source when a drag
1835 * with the action %GDK_ACTION_MOVE is successfully completed. The signal
1836 * handler is responsible for deleting the data that has been dropped. What
1837 * "delete" means depends on the context of the drag operation.
1839 widget_signals[DRAG_DATA_DELETE] =
1840 g_signal_new (I_("drag-data-delete"),
1841 G_TYPE_FROM_CLASS (gobject_class),
1843 G_STRUCT_OFFSET (GtkWidgetClass, drag_data_delete),
1845 _gtk_marshal_VOID__OBJECT,
1847 GDK_TYPE_DRAG_CONTEXT);
1850 * GtkWidget::drag-failed:
1851 * @widget: the object which received the signal
1852 * @drag_context: the drag context
1853 * @result: the result of the drag operation
1855 * The ::drag-failed signal is emitted on the drag source when a drag has
1856 * failed. The signal handler may hook custom code to handle a failed DND
1857 * operation based on the type of error, it returns %TRUE is the failure has
1858 * been already handled (not showing the default "drag operation failed"
1859 * animation), otherwise it returns %FALSE.
1861 * Return value: %TRUE if the failed drag operation has been already handled.
1865 widget_signals[DRAG_FAILED] =
1866 g_signal_new (I_("drag-failed"),
1867 G_TYPE_FROM_CLASS (gobject_class),
1869 0, _gtk_boolean_handled_accumulator, NULL,
1870 _gtk_marshal_BOOLEAN__OBJECT_ENUM,
1872 GDK_TYPE_DRAG_CONTEXT,
1873 GTK_TYPE_DRAG_RESULT);
1876 * GtkWidget::drag-motion:
1877 * @widget: the object which received the signal
1878 * @drag_context: the drag context
1879 * @x: the x coordinate of the current cursor position
1880 * @y: the y coordinate of the current cursor position
1881 * @time: the timestamp of the motion event
1882 * @returns: whether the cursor position is in a drop zone
1884 * The drag-motion signal is emitted on the drop site when the user
1885 * moves the cursor over the widget during a drag. The signal handler
1886 * must determine whether the cursor position is in a drop zone or not.
1887 * If it is not in a drop zone, it returns %FALSE and no further processing
1888 * is necessary. Otherwise, the handler returns %TRUE. In this case, the
1889 * handler is responsible for providing the necessary information for
1890 * displaying feedback to the user, by calling gdk_drag_status().
1892 * If the decision whether the drop will be accepted or rejected can't be
1893 * made based solely on the cursor position and the type of the data, the
1894 * handler may inspect the dragged data by calling gtk_drag_get_data() and
1895 * defer the gdk_drag_status() call to the #GtkWidget::drag-data-received
1896 * handler. Note that you cannot not pass #GTK_DEST_DEFAULT_DROP,
1897 * #GTK_DEST_DEFAULT_MOTION or #GTK_DEST_DEFAULT_ALL to gtk_drag_dest_set()
1898 * when using the drag-motion signal that way.
1900 * Also note that there is no drag-enter signal. The drag receiver has to
1901 * keep track of whether he has received any drag-motion signals since the
1902 * last #GtkWidget::drag-leave and if not, treat the drag-motion signal as
1903 * an "enter" signal. Upon an "enter", the handler will typically highlight
1904 * the drop site with gtk_drag_highlight().
1907 * drag_motion (GtkWidget *widget,
1908 * GdkDragContext *context,
1915 * PrivateData *private_data = GET_PRIVATE_DATA (widget);
1917 * if (!private_data->drag_highlight)
1919 * private_data->drag_highlight = 1;
1920 * gtk_drag_highlight (widget);
1923 * target = gtk_drag_dest_find_target (widget, context, NULL);
1924 * if (target == GDK_NONE)
1925 * gdk_drag_status (context, 0, time);
1928 * private_data->pending_status = context->suggested_action;
1929 * gtk_drag_get_data (widget, context, target, time);
1936 * drag_data_received (GtkWidget *widget,
1937 * GdkDragContext *context,
1940 * GtkSelectionData *selection_data,
1944 * PrivateData *private_data = GET_PRIVATE_DATA (widget);
1946 * if (private_data->suggested_action)
1948 * private_data->suggested_action = 0;
1950 * /* We are getting this data due to a request in drag_motion,
1951 * * rather than due to a request in drag_drop, so we are just
1952 * * supposed to call gdk_drag_status (), not actually paste in
1955 * str = gtk_selection_data_get_text (selection_data);
1956 * if (!data_is_acceptable (str))
1957 * gdk_drag_status (context, 0, time);
1959 * gdk_drag_status (context, private_data->suggested_action, time);
1963 * /* accept the drop */
1968 widget_signals[DRAG_MOTION] =
1969 g_signal_new (I_("drag-motion"),
1970 G_TYPE_FROM_CLASS (gobject_class),
1972 G_STRUCT_OFFSET (GtkWidgetClass, drag_motion),
1973 _gtk_boolean_handled_accumulator, NULL,
1974 _gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
1976 GDK_TYPE_DRAG_CONTEXT,
1982 * GtkWidget::drag-drop:
1983 * @widget: the object which received the signal
1984 * @drag_context: the drag context
1985 * @x: the x coordinate of the current cursor position
1986 * @y: the y coordinate of the current cursor position
1987 * @time: the timestamp of the motion event
1988 * @returns: whether the cursor position is in a drop zone
1990 * The ::drag-drop signal is emitted on the drop site when the user drops
1991 * the data onto the widget. The signal handler must determine whether
1992 * the cursor position is in a drop zone or not. If it is not in a drop
1993 * zone, it returns %FALSE and no further processing is necessary.
1994 * Otherwise, the handler returns %TRUE. In this case, the handler must
1995 * ensure that gtk_drag_finish() is called to let the source know that
1996 * the drop is done. The call to gtk_drag_finish() can be done either
1997 * directly or in a #GtkWidget::drag-data-received handler which gets
1998 * triggered by calling gtk_drag_get_data() to receive the data for one
1999 * or more of the supported targets.
2001 widget_signals[DRAG_DROP] =
2002 g_signal_new (I_("drag-drop"),
2003 G_TYPE_FROM_CLASS (gobject_class),
2005 G_STRUCT_OFFSET (GtkWidgetClass, drag_drop),
2006 _gtk_boolean_handled_accumulator, NULL,
2007 _gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
2009 GDK_TYPE_DRAG_CONTEXT,
2015 * GtkWidget::drag-data-get:
2016 * @widget: the object which received the signal
2017 * @drag_context: the drag context
2018 * @data: the #GtkSelectionData to be filled with the dragged data
2019 * @info: the info that has been registered with the target in the
2021 * @time: the timestamp at which the data was requested
2023 * The ::drag-data-get signal is emitted on the drag source when the drop
2024 * site requests the data which is dragged. It is the responsibility of
2025 * the signal handler to fill @data with the data in the format which
2026 * is indicated by @info. See gtk_selection_data_set() and
2027 * gtk_selection_data_set_text().
2029 widget_signals[DRAG_DATA_GET] =
2030 g_signal_new (I_("drag-data-get"),
2031 G_TYPE_FROM_CLASS (gobject_class),
2033 G_STRUCT_OFFSET (GtkWidgetClass, drag_data_get),
2035 _gtk_marshal_VOID__OBJECT_BOXED_UINT_UINT,
2037 GDK_TYPE_DRAG_CONTEXT,
2038 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
2043 * GtkWidget::drag-data-received:
2044 * @widget: the object which received the signal
2045 * @drag_context: the drag context
2046 * @x: where the drop happened
2047 * @y: where the drop happened
2048 * @data: the received data
2049 * @info: the info that has been registered with the target in the
2051 * @time: the timestamp at which the data was received
2053 * The ::drag-data-received signal is emitted on the drop site when the
2054 * dragged data has been received. If the data was received in order to
2055 * determine whether the drop will be accepted, the handler is expected
2056 * to call gdk_drag_status() and <emphasis>not</emphasis> finish the drag.
2057 * If the data was received in response to a #GtkWidget::drag-drop signal
2058 * (and this is the last target to be received), the handler for this
2059 * signal is expected to process the received data and then call
2060 * gtk_drag_finish(), setting the @success parameter depending on whether
2061 * the data was processed successfully.
2063 * The handler may inspect and modify @drag_context->action before calling
2064 * gtk_drag_finish(), e.g. to implement %GDK_ACTION_ASK as shown in the
2065 * following example:
2068 * drag_data_received (GtkWidget *widget,
2069 * GdkDragContext *drag_context,
2072 * GtkSelectionData *data,
2076 * if ((data->length >= 0) && (data->format == 8))
2078 * if (drag_context->action == GDK_ACTION_ASK)
2080 * GtkWidget *dialog;
2083 * dialog = gtk_message_dialog_new (NULL,
2084 * GTK_DIALOG_MODAL |
2085 * GTK_DIALOG_DESTROY_WITH_PARENT,
2087 * GTK_BUTTONS_YES_NO,
2088 * "Move the data ?\n");
2089 * response = gtk_dialog_run (GTK_DIALOG (dialog));
2090 * gtk_widget_destroy (dialog);
2092 * if (response == GTK_RESPONSE_YES)
2093 * drag_context->action = GDK_ACTION_MOVE;
2095 * drag_context->action = GDK_ACTION_COPY;
2098 * gtk_drag_finish (drag_context, TRUE, FALSE, time);
2102 * gtk_drag_finish (drag_context, FALSE, FALSE, time);
2106 widget_signals[DRAG_DATA_RECEIVED] =
2107 g_signal_new (I_("drag-data-received"),
2108 G_TYPE_FROM_CLASS (gobject_class),
2110 G_STRUCT_OFFSET (GtkWidgetClass, drag_data_received),
2112 _gtk_marshal_VOID__OBJECT_INT_INT_BOXED_UINT_UINT,
2114 GDK_TYPE_DRAG_CONTEXT,
2117 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
2122 * GtkWidget::visibility-notify-event:
2123 * @widget: the object which received the signal
2124 * @event: the #GdkEventVisibility which triggered this signal
2126 * The ::visibility-notify-event will be emitted when the @widget's window
2127 * is obscured or unobscured.
2129 * To receive this signal the #GdkWindow associated to the widget needs
2130 * to enable the #GDK_VISIBILITY_NOTIFY_MASK mask.
2132 * Returns: %TRUE to stop other handlers from being invoked for the event.
2133 * %FALSE to propagate the event further.
2135 widget_signals[VISIBILITY_NOTIFY_EVENT] =
2136 g_signal_new (I_("visibility-notify-event"),
2137 G_TYPE_FROM_CLASS (gobject_class),
2139 G_STRUCT_OFFSET (GtkWidgetClass, visibility_notify_event),
2140 _gtk_boolean_handled_accumulator, NULL,
2141 _gtk_marshal_BOOLEAN__BOXED,
2143 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2146 * GtkWidget::client-event:
2147 * @widget: the object which received the signal
2148 * @event: the #GdkEventClient which triggered this signal
2150 * The ::client-event will be emitted when the @widget's window
2151 * receives a message (via a ClientMessage event) from another
2154 * Returns: %TRUE to stop other handlers from being invoked for
2155 * the event. %FALSE to propagate the event further.
2157 widget_signals[CLIENT_EVENT] =
2158 g_signal_new (I_("client-event"),
2159 G_TYPE_FROM_CLASS (gobject_class),
2161 G_STRUCT_OFFSET (GtkWidgetClass, client_event),
2162 _gtk_boolean_handled_accumulator, NULL,
2163 _gtk_marshal_BOOLEAN__BOXED,
2165 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2168 * GtkWidget::no-expose-event:
2169 * @widget: the object which received the signal
2170 * @event: the #GdkEventNoExpose which triggered this signal
2172 * The ::no-expose-event will be emitted when the @widget's window is
2173 * drawn as a copy of another #GdkDrawable (with gdk_draw_drawable() or
2174 * gdk_window_copy_area()) which was completely unobscured. If the source
2175 * window was partially obscured #GdkEventExpose events will be generated
2178 * Returns: %TRUE to stop other handlers from being invoked for the event.
2179 * %FALSE to propagate the event further.
2181 widget_signals[NO_EXPOSE_EVENT] =
2182 g_signal_new (I_("no-expose-event"),
2183 G_TYPE_FROM_CLASS (gobject_class),
2185 G_STRUCT_OFFSET (GtkWidgetClass, no_expose_event),
2186 _gtk_boolean_handled_accumulator, NULL,
2187 _gtk_marshal_BOOLEAN__BOXED,
2189 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2192 * GtkWidget::window-state-event:
2193 * @widget: the object which received the signal
2194 * @event: the #GdkEventWindowState which triggered this signal
2196 * The ::window-state-event will be emitted when the state of the
2197 * toplevel window associated to the @widget changes.
2199 * To receive this signal the #GdkWindow associated to the widget
2200 * needs to enable the #GDK_STRUCTURE_MASK mask. GDK will enable
2201 * this mask automatically for all new windows.
2203 * Returns: %TRUE to stop other handlers from being invoked for the
2204 * event. %FALSE to propagate the event further.
2206 widget_signals[WINDOW_STATE_EVENT] =
2207 g_signal_new (I_("window-state-event"),
2208 G_TYPE_FROM_CLASS (gobject_class),
2210 G_STRUCT_OFFSET (GtkWidgetClass, window_state_event),
2211 _gtk_boolean_handled_accumulator, NULL,
2212 _gtk_marshal_BOOLEAN__BOXED,
2214 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2217 * GtkWidget::damage-event:
2218 * @widget: the object which received the signal
2219 * @event: the #GdkEventExpose event
2221 * Emitted when a redirected window belonging to @widget gets drawn into.
2222 * The region/area members of the event shows what area of the redirected
2223 * drawable was drawn into.
2225 * Returns: %TRUE to stop other handlers from being invoked for the event.
2226 * %FALSE to propagate the event further.
2230 widget_signals[DAMAGE_EVENT] =
2231 g_signal_new (I_("damage-event"),
2232 G_TYPE_FROM_CLASS (gobject_class),
2235 _gtk_boolean_handled_accumulator, NULL,
2236 _gtk_marshal_BOOLEAN__BOXED,
2238 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2240 * GtkWidget::grab-broken-event:
2241 * @widget: the object which received the signal
2242 * @event: the #GdkEventGrabBroken event
2244 * Emitted when a pointer or keyboard grab on a window belonging
2245 * to @widget gets broken.
2247 * On X11, this happens when the grab window becomes unviewable
2248 * (i.e. it or one of its ancestors is unmapped), or if the same
2249 * application grabs the pointer or keyboard again.
2251 * Returns: %TRUE to stop other handlers from being invoked for
2252 * the event. %FALSE to propagate the event further.
2256 widget_signals[GRAB_BROKEN] =
2257 g_signal_new (I_("grab-broken-event"),
2258 G_TYPE_FROM_CLASS (gobject_class),
2260 G_STRUCT_OFFSET (GtkWidgetClass, grab_broken_event),
2261 _gtk_boolean_handled_accumulator, NULL,
2262 _gtk_marshal_BOOLEAN__BOXED,
2264 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2266 * GtkWidget::query-tooltip:
2267 * @widget: the object which received the signal
2268 * @x: the x coordinate of the cursor position where the request has
2269 * been emitted, relative to @widget->window
2270 * @y: the y coordinate of the cursor position where the request has
2271 * been emitted, relative to @widget->window
2272 * @keyboard_mode: %TRUE if the tooltip was trigged using the keyboard
2273 * @tooltip: a #GtkTooltip
2275 * Emitted when #GtkWidget:has-tooltip is %TRUE and the #GtkSettings:gtk-tooltip-timeout
2276 * has expired with the cursor hovering "above" @widget; or emitted when @widget got
2277 * focus in keyboard mode.
2279 * Using the given coordinates, the signal handler should determine
2280 * whether a tooltip should be shown for @widget. If this is the case
2281 * %TRUE should be returned, %FALSE otherwise. Note that if
2282 * @keyboard_mode is %TRUE, the values of @x and @y are undefined and
2283 * should not be used.
2285 * The signal handler is free to manipulate @tooltip with the therefore
2286 * destined function calls.
2288 * Returns: %TRUE if @tooltip should be shown right now, %FALSE otherwise.
2292 widget_signals[QUERY_TOOLTIP] =
2293 g_signal_new (I_("query-tooltip"),
2294 G_TYPE_FROM_CLASS (gobject_class),
2296 G_STRUCT_OFFSET (GtkWidgetClass, query_tooltip),
2297 _gtk_boolean_handled_accumulator, NULL,
2298 _gtk_marshal_BOOLEAN__INT_INT_BOOLEAN_OBJECT,
2306 * GtkWidget::popup-menu
2307 * @widget: the object which received the signal
2309 * This signal gets emitted whenever a widget should pop up a context
2310 * menu. This usually happens through the standard key binding mechanism;
2311 * by pressing a certain key while a widget is focused, the user can cause
2312 * the widget to pop up a menu. For example, the #GtkEntry widget creates
2313 * a menu with clipboard commands. See <xref linkend="checklist-popup-menu"/>
2314 * for an example of how to use this signal.
2316 * Returns: %TRUE if a menu was activated
2318 widget_signals[POPUP_MENU] =
2319 g_signal_new (I_("popup-menu"),
2320 G_TYPE_FROM_CLASS (gobject_class),
2321 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
2322 G_STRUCT_OFFSET (GtkWidgetClass, popup_menu),
2323 _gtk_boolean_handled_accumulator, NULL,
2324 _gtk_marshal_BOOLEAN__VOID,
2328 * GtkWidget::show-help:
2329 * @widget: the object which received the signal.
2332 widget_signals[SHOW_HELP] =
2333 g_signal_new (I_("show-help"),
2334 G_TYPE_FROM_CLASS (gobject_class),
2335 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
2336 G_STRUCT_OFFSET (GtkWidgetClass, show_help),
2337 _gtk_boolean_handled_accumulator, NULL,
2338 _gtk_marshal_BOOLEAN__ENUM,
2340 GTK_TYPE_WIDGET_HELP_TYPE);
2343 * GtkWidget::accel-closures-changed:
2344 * @widget: the object which received the signal.
2346 widget_signals[ACCEL_CLOSURES_CHANGED] =
2347 g_signal_new (I_("accel-closures-changed"),
2348 G_TYPE_FROM_CLASS (gobject_class),
2352 _gtk_marshal_VOID__VOID,
2356 * GtkWidget::screen-changed:
2357 * @widget: the object on which the signal is emitted
2358 * @previous_screen: (allow-none): the previous screen, or %NULL if the
2359 * widget was not associated with a screen before
2361 * The ::screen-changed signal gets emitted when the
2362 * screen of a widget has changed.
2364 widget_signals[SCREEN_CHANGED] =
2365 g_signal_new (I_("screen-changed"),
2366 G_TYPE_FROM_CLASS (gobject_class),
2368 G_STRUCT_OFFSET (GtkWidgetClass, screen_changed),
2370 _gtk_marshal_VOID__OBJECT,
2375 * GtkWidget::can-activate-accel:
2376 * @widget: the object which received the signal
2377 * @signal_id: the ID of a signal installed on @widget
2379 * Determines whether an accelerator that activates the signal
2380 * identified by @signal_id can currently be activated.
2381 * This signal is present to allow applications and derived
2382 * widgets to override the default #GtkWidget handling
2383 * for determining whether an accelerator can be activated.
2385 * Returns: %TRUE if the signal can be activated.
2387 widget_signals[CAN_ACTIVATE_ACCEL] =
2388 g_signal_new (I_("can-activate-accel"),
2389 G_TYPE_FROM_CLASS (gobject_class),
2391 G_STRUCT_OFFSET (GtkWidgetClass, can_activate_accel),
2392 _gtk_boolean_handled_accumulator, NULL,
2393 _gtk_marshal_BOOLEAN__UINT,
2394 G_TYPE_BOOLEAN, 1, G_TYPE_UINT);
2396 binding_set = gtk_binding_set_by_class (klass);
2397 gtk_binding_entry_add_signal (binding_set, GDK_F10, GDK_SHIFT_MASK,
2399 gtk_binding_entry_add_signal (binding_set, GDK_Menu, 0,
2402 gtk_binding_entry_add_signal (binding_set, GDK_F1, GDK_CONTROL_MASK,
2404 GTK_TYPE_WIDGET_HELP_TYPE,
2405 GTK_WIDGET_HELP_TOOLTIP);
2406 gtk_binding_entry_add_signal (binding_set, GDK_KP_F1, GDK_CONTROL_MASK,
2408 GTK_TYPE_WIDGET_HELP_TYPE,
2409 GTK_WIDGET_HELP_TOOLTIP);
2410 gtk_binding_entry_add_signal (binding_set, GDK_F1, GDK_SHIFT_MASK,
2412 GTK_TYPE_WIDGET_HELP_TYPE,
2413 GTK_WIDGET_HELP_WHATS_THIS);
2414 gtk_binding_entry_add_signal (binding_set, GDK_KP_F1, GDK_SHIFT_MASK,
2416 GTK_TYPE_WIDGET_HELP_TYPE,
2417 GTK_WIDGET_HELP_WHATS_THIS);
2419 gtk_widget_class_install_style_property (klass,
2420 g_param_spec_boolean ("interior-focus",
2421 P_("Interior Focus"),
2422 P_("Whether to draw the focus indicator inside widgets"),
2424 GTK_PARAM_READABLE));
2426 gtk_widget_class_install_style_property (klass,
2427 g_param_spec_int ("focus-line-width",
2428 P_("Focus linewidth"),
2429 P_("Width, in pixels, of the focus indicator line"),
2431 GTK_PARAM_READABLE));
2433 gtk_widget_class_install_style_property (klass,
2434 g_param_spec_string ("focus-line-pattern",
2435 P_("Focus line dash pattern"),
2436 P_("Dash pattern used to draw the focus indicator"),
2438 GTK_PARAM_READABLE));
2439 gtk_widget_class_install_style_property (klass,
2440 g_param_spec_int ("focus-padding",
2441 P_("Focus padding"),
2442 P_("Width, in pixels, between focus indicator and the widget 'box'"),
2444 GTK_PARAM_READABLE));
2445 gtk_widget_class_install_style_property (klass,
2446 g_param_spec_boxed ("cursor-color",
2448 P_("Color with which to draw insertion cursor"),
2450 GTK_PARAM_READABLE));
2451 gtk_widget_class_install_style_property (klass,
2452 g_param_spec_boxed ("secondary-cursor-color",
2453 P_("Secondary cursor color"),
2454 P_("Color with which to draw the secondary insertion cursor when editing mixed right-to-left and left-to-right text"),
2456 GTK_PARAM_READABLE));
2457 gtk_widget_class_install_style_property (klass,
2458 g_param_spec_float ("cursor-aspect-ratio",
2459 P_("Cursor line aspect ratio"),
2460 P_("Aspect ratio with which to draw insertion cursor"),
2462 GTK_PARAM_READABLE));
2465 * GtkWidget:draw-border:
2467 * The "draw-border" style property defines the size of areas outside
2468 * the widget's allocation to draw.
2472 gtk_widget_class_install_style_property (klass,
2473 g_param_spec_boxed ("draw-border",
2475 P_("Size of areas outside the widget's allocation to draw"),
2477 GTK_PARAM_READABLE));
2480 * GtkWidget:link-color:
2482 * The "link-color" style property defines the color of unvisited links.
2486 gtk_widget_class_install_style_property (klass,
2487 g_param_spec_boxed ("link-color",
2488 P_("Unvisited Link Color"),
2489 P_("Color of unvisited links"),
2491 GTK_PARAM_READABLE));
2494 * GtkWidget:visited-link-color:
2496 * The "visited-link-color" style property defines the color of visited links.
2500 gtk_widget_class_install_style_property (klass,
2501 g_param_spec_boxed ("visited-link-color",
2502 P_("Visited Link Color"),
2503 P_("Color of visited links"),
2505 GTK_PARAM_READABLE));
2508 * GtkWidget:wide-separators:
2510 * The "wide-separators" style property defines whether separators have
2511 * configurable width and should be drawn using a box instead of a line.
2515 gtk_widget_class_install_style_property (klass,
2516 g_param_spec_boolean ("wide-separators",
2517 P_("Wide Separators"),
2518 P_("Whether separators have configurable width and should be drawn using a box instead of a line"),
2520 GTK_PARAM_READABLE));
2523 * GtkWidget:separator-width:
2525 * The "separator-width" style property defines the width of separators.
2526 * This property only takes effect if #GtkWidget:wide-separators is %TRUE.
2530 gtk_widget_class_install_style_property (klass,
2531 g_param_spec_int ("separator-width",
2532 P_("Separator Width"),
2533 P_("The width of separators if wide-separators is TRUE"),
2535 GTK_PARAM_READABLE));
2538 * GtkWidget:separator-height:
2540 * The "separator-height" style property defines the height of separators.
2541 * This property only takes effect if #GtkWidget:wide-separators is %TRUE.
2545 gtk_widget_class_install_style_property (klass,
2546 g_param_spec_int ("separator-height",
2547 P_("Separator Height"),
2548 P_("The height of separators if \"wide-separators\" is TRUE"),
2550 GTK_PARAM_READABLE));
2553 * GtkWidget:scroll-arrow-hlength:
2555 * The "scroll-arrow-hlength" style property defines the length of
2556 * horizontal scroll arrows.
2560 gtk_widget_class_install_style_property (klass,
2561 g_param_spec_int ("scroll-arrow-hlength",
2562 P_("Horizontal Scroll Arrow Length"),
2563 P_("The length of horizontal scroll arrows"),
2565 GTK_PARAM_READABLE));
2568 * GtkWidget:scroll-arrow-vlength:
2570 * The "scroll-arrow-vlength" style property defines the length of
2571 * vertical scroll arrows.
2575 gtk_widget_class_install_style_property (klass,
2576 g_param_spec_int ("scroll-arrow-vlength",
2577 P_("Vertical Scroll Arrow Length"),
2578 P_("The length of vertical scroll arrows"),
2580 GTK_PARAM_READABLE));
2584 gtk_widget_base_class_finalize (GtkWidgetClass *klass)
2588 list = g_param_spec_pool_list_owned (style_property_spec_pool, G_OBJECT_CLASS_TYPE (klass));
2589 for (node = list; node; node = node->next)
2591 GParamSpec *pspec = node->data;
2593 g_param_spec_pool_remove (style_property_spec_pool, pspec);
2594 g_param_spec_unref (pspec);
2600 gtk_widget_set_property (GObject *object,
2602 const GValue *value,
2605 GtkWidget *widget = GTK_WIDGET (object);
2610 gchar *tooltip_markup;
2611 const gchar *tooltip_text;
2612 GtkWindow *tooltip_window;
2615 gtk_widget_set_name (widget, g_value_get_string (value));
2618 gtk_container_add (GTK_CONTAINER (g_value_get_object (value)), widget);
2620 case PROP_WIDTH_REQUEST:
2621 gtk_widget_set_usize_internal (widget, g_value_get_int (value), -2);
2623 case PROP_HEIGHT_REQUEST:
2624 gtk_widget_set_usize_internal (widget, -2, g_value_get_int (value));
2627 gtk_widget_set_visible (widget, g_value_get_boolean (value));
2629 case PROP_SENSITIVE:
2630 gtk_widget_set_sensitive (widget, g_value_get_boolean (value));
2632 case PROP_APP_PAINTABLE:
2633 gtk_widget_set_app_paintable (widget, g_value_get_boolean (value));
2635 case PROP_CAN_FOCUS:
2636 gtk_widget_set_can_focus (widget, g_value_get_boolean (value));
2638 case PROP_HAS_FOCUS:
2639 if (g_value_get_boolean (value))
2640 gtk_widget_grab_focus (widget);
2643 if (g_value_get_boolean (value))
2644 gtk_widget_grab_focus (widget);
2646 case PROP_CAN_DEFAULT:
2647 gtk_widget_set_can_default (widget, g_value_get_boolean (value));
2649 case PROP_HAS_DEFAULT:
2650 if (g_value_get_boolean (value))
2651 gtk_widget_grab_default (widget);
2653 case PROP_RECEIVES_DEFAULT:
2654 gtk_widget_set_receives_default (widget, g_value_get_boolean (value));
2657 gtk_widget_set_style (widget, g_value_get_object (value));
2660 if (!gtk_widget_get_realized (widget) && gtk_widget_get_has_window (widget))
2661 gtk_widget_set_events (widget, g_value_get_flags (value));
2663 case PROP_EXTENSION_EVENTS:
2664 gtk_widget_set_extension_events (widget, g_value_get_enum (value));
2666 case PROP_NO_SHOW_ALL:
2667 gtk_widget_set_no_show_all (widget, g_value_get_boolean (value));
2669 case PROP_HAS_TOOLTIP:
2670 gtk_widget_real_set_has_tooltip (widget,
2671 g_value_get_boolean (value), FALSE);
2673 case PROP_TOOLTIP_MARKUP:
2674 tooltip_window = g_object_get_qdata (object, quark_tooltip_window);
2675 tooltip_markup = g_value_dup_string (value);
2677 /* Treat an empty string as a NULL string,
2678 * because an empty string would be useless for a tooltip:
2680 if (tooltip_markup && (strlen (tooltip_markup) == 0))
2682 g_free (tooltip_markup);
2683 tooltip_markup = NULL;
2686 g_object_set_qdata_full (object, quark_tooltip_markup,
2687 tooltip_markup, g_free);
2689 tmp = (tooltip_window != NULL || tooltip_markup != NULL);
2690 gtk_widget_real_set_has_tooltip (widget, tmp, FALSE);
2691 if (gtk_widget_get_visible (widget))
2692 gtk_widget_queue_tooltip_query (widget);
2694 case PROP_TOOLTIP_TEXT:
2695 tooltip_window = g_object_get_qdata (object, quark_tooltip_window);
2697 tooltip_text = g_value_get_string (value);
2699 /* Treat an empty string as a NULL string,
2700 * because an empty string would be useless for a tooltip:
2702 if (tooltip_text && (strlen (tooltip_text) == 0))
2703 tooltip_text = NULL;
2705 tooltip_markup = tooltip_text ? g_markup_escape_text (tooltip_text, -1) : NULL;
2707 g_object_set_qdata_full (object, quark_tooltip_markup,
2708 tooltip_markup, g_free);
2710 tmp = (tooltip_window != NULL || tooltip_markup != NULL);
2711 gtk_widget_real_set_has_tooltip (widget, tmp, FALSE);
2712 if (gtk_widget_get_visible (widget))
2713 gtk_widget_queue_tooltip_query (widget);
2715 case PROP_DOUBLE_BUFFERED:
2716 gtk_widget_set_double_buffered (widget, g_value_get_boolean (value));
2719 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2725 gtk_widget_get_property (GObject *object,
2730 GtkWidget *widget = GTK_WIDGET (object);
2739 g_value_set_string (value, widget->name);
2741 g_value_set_static_string (value, "");
2744 g_value_set_object (value, widget->parent);
2746 case PROP_WIDTH_REQUEST:
2749 gtk_widget_get_size_request (widget, &w, NULL);
2750 g_value_set_int (value, w);
2753 case PROP_HEIGHT_REQUEST:
2756 gtk_widget_get_size_request (widget, NULL, &h);
2757 g_value_set_int (value, h);
2761 g_value_set_boolean (value, (gtk_widget_get_visible (widget) != FALSE));
2763 case PROP_SENSITIVE:
2764 g_value_set_boolean (value, (gtk_widget_get_sensitive (widget) != FALSE));
2766 case PROP_APP_PAINTABLE:
2767 g_value_set_boolean (value, (gtk_widget_get_app_paintable (widget) != FALSE));
2769 case PROP_CAN_FOCUS:
2770 g_value_set_boolean (value, (gtk_widget_get_can_focus (widget) != FALSE));
2772 case PROP_HAS_FOCUS:
2773 g_value_set_boolean (value, (gtk_widget_has_focus (widget) != FALSE));
2776 g_value_set_boolean (value, (gtk_widget_is_focus (widget)));
2778 case PROP_CAN_DEFAULT:
2779 g_value_set_boolean (value, (gtk_widget_get_can_default (widget) != FALSE));
2781 case PROP_HAS_DEFAULT:
2782 g_value_set_boolean (value, (gtk_widget_has_default (widget) != FALSE));
2784 case PROP_RECEIVES_DEFAULT:
2785 g_value_set_boolean (value, (gtk_widget_get_receives_default (widget) != FALSE));
2787 case PROP_COMPOSITE_CHILD:
2788 g_value_set_boolean (value, (GTK_OBJECT_FLAGS (widget) & GTK_COMPOSITE_CHILD) != 0 );
2791 g_value_set_object (value, gtk_widget_get_style (widget));
2794 eventp = g_object_get_qdata (G_OBJECT (widget), quark_event_mask);
2795 g_value_set_flags (value, GPOINTER_TO_INT (eventp));
2797 case PROP_EXTENSION_EVENTS:
2798 modep = g_object_get_qdata (G_OBJECT (widget), quark_extension_event_mode);
2799 g_value_set_enum (value, GPOINTER_TO_INT (modep));
2801 case PROP_NO_SHOW_ALL:
2802 g_value_set_boolean (value, gtk_widget_get_no_show_all (widget));
2804 case PROP_HAS_TOOLTIP:
2805 g_value_set_boolean (value, GPOINTER_TO_UINT (g_object_get_qdata (object, quark_has_tooltip)));
2807 case PROP_TOOLTIP_TEXT:
2809 gchar *escaped = g_object_get_qdata (object, quark_tooltip_markup);
2812 if (escaped && !pango_parse_markup (escaped, -1, 0, NULL, &text, NULL, NULL))
2813 g_assert (NULL == text); /* text should still be NULL in case of markup errors */
2815 g_value_take_string (value, text);
2818 case PROP_TOOLTIP_MARKUP:
2819 g_value_set_string (value, g_object_get_qdata (object, quark_tooltip_markup));
2822 g_value_set_object (value, gtk_widget_get_window (widget));
2824 case PROP_DOUBLE_BUFFERED:
2825 g_value_set_boolean (value, gtk_widget_get_double_buffered (widget));
2828 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2834 gtk_widget_init (GtkWidget *widget)
2836 GTK_PRIVATE_FLAGS (widget) = PRIVATE_GTK_CHILD_VISIBLE;
2837 widget->state = GTK_STATE_NORMAL;
2838 widget->saved_state = GTK_STATE_NORMAL;
2839 widget->name = NULL;
2840 widget->requisition.width = 0;
2841 widget->requisition.height = 0;
2842 widget->allocation.x = -1;
2843 widget->allocation.y = -1;
2844 widget->allocation.width = 1;
2845 widget->allocation.height = 1;
2846 widget->window = NULL;
2847 widget->parent = NULL;
2849 GTK_OBJECT_FLAGS (widget) |= GTK_SENSITIVE;
2850 GTK_OBJECT_FLAGS (widget) |= GTK_PARENT_SENSITIVE;
2851 GTK_OBJECT_FLAGS (widget) |= composite_child_stack ? GTK_COMPOSITE_CHILD : 0;
2852 gtk_widget_set_double_buffered (widget, TRUE);
2854 GTK_PRIVATE_SET_FLAG (widget, GTK_REDRAW_ON_ALLOC);
2855 GTK_PRIVATE_SET_FLAG (widget, GTK_REQUEST_NEEDED);
2856 GTK_PRIVATE_SET_FLAG (widget, GTK_WIDTH_REQUEST_NEEDED);
2857 GTK_PRIVATE_SET_FLAG (widget, GTK_HEIGHT_REQUEST_NEEDED);
2858 GTK_PRIVATE_SET_FLAG (widget, GTK_ALLOC_NEEDED);
2860 widget->style = gtk_widget_get_default_style ();
2861 g_object_ref (widget->style);
2866 gtk_widget_dispatch_child_properties_changed (GtkWidget *widget,
2868 GParamSpec **pspecs)
2870 GtkWidget *container = widget->parent;
2873 for (i = 0; widget->parent == container && i < n_pspecs; i++)
2874 g_signal_emit (widget, widget_signals[CHILD_NOTIFY], g_quark_from_string (pspecs[i]->name), pspecs[i]);
2878 * gtk_widget_freeze_child_notify:
2879 * @widget: a #GtkWidget
2881 * Stops emission of #GtkWidget::child-notify signals on @widget. The
2882 * signals are queued until gtk_widget_thaw_child_notify() is called
2885 * This is the analogue of g_object_freeze_notify() for child properties.
2888 gtk_widget_freeze_child_notify (GtkWidget *widget)
2890 g_return_if_fail (GTK_IS_WIDGET (widget));
2892 if (!G_OBJECT (widget)->ref_count)
2895 g_object_ref (widget);
2896 g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
2897 g_object_unref (widget);
2901 * gtk_widget_child_notify:
2902 * @widget: a #GtkWidget
2903 * @child_property: the name of a child property installed on the
2904 * class of @widget<!-- -->'s parent
2906 * Emits a #GtkWidget::child-notify signal for the
2907 * <link linkend="child-properties">child property</link> @child_property
2910 * This is the analogue of g_object_notify() for child properties.
2913 gtk_widget_child_notify (GtkWidget *widget,
2914 const gchar *child_property)
2918 g_return_if_fail (GTK_IS_WIDGET (widget));
2919 g_return_if_fail (child_property != NULL);
2920 if (!G_OBJECT (widget)->ref_count || !widget->parent)
2923 g_object_ref (widget);
2924 pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
2926 G_OBJECT_TYPE (widget->parent),
2929 g_warning ("%s: container class `%s' has no child property named `%s'",
2931 G_OBJECT_TYPE_NAME (widget->parent),
2935 GObjectNotifyQueue *nqueue = g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
2937 g_object_notify_queue_add (G_OBJECT (widget), nqueue, pspec);
2938 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
2940 g_object_unref (widget);
2944 * gtk_widget_thaw_child_notify:
2945 * @widget: a #GtkWidget
2947 * Reverts the effect of a previous call to gtk_widget_freeze_child_notify().
2948 * This causes all queued #GtkWidget::child-notify signals on @widget to be
2952 gtk_widget_thaw_child_notify (GtkWidget *widget)
2954 GObjectNotifyQueue *nqueue;
2956 g_return_if_fail (GTK_IS_WIDGET (widget));
2958 if (!G_OBJECT (widget)->ref_count)
2961 g_object_ref (widget);
2962 nqueue = g_object_notify_queue_from_object (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
2963 if (!nqueue || !nqueue->freeze_count)
2964 g_warning (G_STRLOC ": child-property-changed notification for %s(%p) is not frozen",
2965 G_OBJECT_TYPE_NAME (widget), widget);
2967 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
2968 g_object_unref (widget);
2974 * @type: type ID of the widget to create
2975 * @first_property_name: name of first property to set
2976 * @Varargs: value of first property, followed by more properties,
2979 * This is a convenience function for creating a widget and setting
2980 * its properties in one go. For example you might write:
2981 * <literal>gtk_widget_new (GTK_TYPE_LABEL, "label", "Hello World", "xalign",
2982 * 0.0, NULL)</literal> to create a left-aligned label. Equivalent to
2983 * g_object_new(), but returns a widget so you don't have to
2984 * cast the object yourself.
2986 * Return value: a new #GtkWidget of type @widget_type
2989 gtk_widget_new (GType type,
2990 const gchar *first_property_name,
2996 g_return_val_if_fail (g_type_is_a (type, GTK_TYPE_WIDGET), NULL);
2998 va_start (var_args, first_property_name);
2999 widget = (GtkWidget *)g_object_new_valist (type, first_property_name, var_args);
3006 gtk_widget_queue_draw_child (GtkWidget *widget)
3010 parent = widget->parent;
3011 if (parent && gtk_widget_is_drawable (parent))
3012 gtk_widget_queue_draw_area (parent,
3013 widget->allocation.x,
3014 widget->allocation.y,
3015 widget->allocation.width,
3016 widget->allocation.height);
3020 * gtk_widget_unparent:
3021 * @widget: a #GtkWidget
3023 * This function is only for use in widget implementations.
3024 * Should be called by implementations of the remove method
3025 * on #GtkContainer, to dissociate a child from the container.
3028 gtk_widget_unparent (GtkWidget *widget)
3030 GObjectNotifyQueue *nqueue;
3031 GtkWidget *toplevel;
3032 GtkWidget *old_parent;
3034 g_return_if_fail (GTK_IS_WIDGET (widget));
3035 if (widget->parent == NULL)
3038 /* keep this function in sync with gtk_menu_detach()
3041 g_object_freeze_notify (G_OBJECT (widget));
3042 nqueue = g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
3044 toplevel = gtk_widget_get_toplevel (widget);
3045 if (gtk_widget_is_toplevel (toplevel))
3046 _gtk_window_unset_focus_and_default (GTK_WINDOW (toplevel), widget);
3048 if (GTK_CONTAINER (widget->parent)->focus_child == widget)
3049 gtk_container_set_focus_child (GTK_CONTAINER (widget->parent), NULL);
3051 /* If we are unanchoring the child, we save around the toplevel
3052 * to emit hierarchy changed
3054 if (GTK_WIDGET_ANCHORED (widget->parent))
3055 g_object_ref (toplevel);
3059 gtk_widget_queue_draw_child (widget);
3061 /* Reset the width and height here, to force reallocation if we
3062 * get added back to a new parent. This won't work if our new
3063 * allocation is smaller than 1x1 and we actually want a size of 1x1...
3064 * (would 0x0 be OK here?)
3066 widget->allocation.width = 1;
3067 widget->allocation.height = 1;
3069 if (gtk_widget_get_realized (widget))
3071 if (GTK_WIDGET_IN_REPARENT (widget))
3072 gtk_widget_unmap (widget);
3074 gtk_widget_unrealize (widget);
3077 /* Removing a widget from a container restores the child visible
3078 * flag to the default state, so it doesn't affect the child
3079 * in the next parent.
3081 GTK_PRIVATE_SET_FLAG (widget, GTK_CHILD_VISIBLE);
3083 old_parent = widget->parent;
3084 widget->parent = NULL;
3085 gtk_widget_set_parent_window (widget, NULL);
3086 g_signal_emit (widget, widget_signals[PARENT_SET], 0, old_parent);
3089 _gtk_widget_propagate_hierarchy_changed (widget, toplevel);
3090 g_object_unref (toplevel);
3093 g_object_notify (G_OBJECT (widget), "parent");
3094 g_object_thaw_notify (G_OBJECT (widget));
3095 if (!widget->parent)
3096 g_object_notify_queue_clear (G_OBJECT (widget), nqueue);
3097 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
3098 g_object_unref (widget);
3102 * gtk_widget_destroy:
3103 * @widget: a #GtkWidget
3105 * Destroys a widget. Equivalent to gtk_object_destroy(), except that
3106 * you don't have to cast the widget to #GtkObject. When a widget is
3107 * destroyed, it will break any references it holds to other objects.
3108 * If the widget is inside a container, the widget will be removed
3109 * from the container. If the widget is a toplevel (derived from
3110 * #GtkWindow), it will be removed from the list of toplevels, and the
3111 * reference GTK+ holds to it will be removed. Removing a
3112 * widget from its container or the list of toplevels results in the
3113 * widget being finalized, unless you've added additional references
3114 * to the widget with g_object_ref().
3116 * In most cases, only toplevel widgets (windows) require explicit
3117 * destruction, because when you destroy a toplevel its children will
3118 * be destroyed as well.
3121 gtk_widget_destroy (GtkWidget *widget)
3123 g_return_if_fail (GTK_IS_WIDGET (widget));
3125 gtk_object_destroy ((GtkObject*) widget);
3129 * gtk_widget_destroyed:
3130 * @widget: a #GtkWidget
3131 * @widget_pointer: (inout) (transfer none): address of a variable that contains @widget
3133 * This function sets *@widget_pointer to %NULL if @widget_pointer !=
3134 * %NULL. It's intended to be used as a callback connected to the
3135 * "destroy" signal of a widget. You connect gtk_widget_destroyed()
3136 * as a signal handler, and pass the address of your widget variable
3137 * as user data. Then when the widget is destroyed, the variable will
3138 * be set to %NULL. Useful for example to avoid multiple copies
3139 * of the same dialog.
3142 gtk_widget_destroyed (GtkWidget *widget,
3143 GtkWidget **widget_pointer)
3145 /* Don't make any assumptions about the
3147 * Even check widget_pointer.
3150 *widget_pointer = NULL;
3155 * @widget: a #GtkWidget
3157 * Flags a widget to be displayed. Any widget that isn't shown will
3158 * not appear on the screen. If you want to show all the widgets in a
3159 * container, it's easier to call gtk_widget_show_all() on the
3160 * container, instead of individually showing the widgets.
3162 * Remember that you have to show the containers containing a widget,
3163 * in addition to the widget itself, before it will appear onscreen.
3165 * When a toplevel container is shown, it is immediately realized and
3166 * mapped; other shown widgets are realized and mapped when their
3167 * toplevel container is realized and mapped.
3170 gtk_widget_show (GtkWidget *widget)
3172 g_return_if_fail (GTK_IS_WIDGET (widget));
3174 if (!gtk_widget_get_visible (widget))
3176 g_object_ref (widget);
3177 if (!gtk_widget_is_toplevel (widget))
3178 gtk_widget_queue_resize (widget);
3179 g_signal_emit (widget, widget_signals[SHOW], 0);
3180 g_object_notify (G_OBJECT (widget), "visible");
3181 g_object_unref (widget);
3186 gtk_widget_real_show (GtkWidget *widget)
3188 if (!gtk_widget_get_visible (widget))
3190 GTK_WIDGET_SET_FLAGS (widget, GTK_VISIBLE);
3192 if (widget->parent &&
3193 gtk_widget_get_mapped (widget->parent) &&
3194 GTK_WIDGET_CHILD_VISIBLE (widget) &&
3195 !gtk_widget_get_mapped (widget))
3196 gtk_widget_map (widget);
3201 gtk_widget_show_map_callback (GtkWidget *widget, GdkEvent *event, gint *flag)
3204 g_signal_handlers_disconnect_by_func (widget,
3205 gtk_widget_show_map_callback,
3210 * gtk_widget_show_now:
3211 * @widget: a #GtkWidget
3213 * Shows a widget. If the widget is an unmapped toplevel widget
3214 * (i.e. a #GtkWindow that has not yet been shown), enter the main
3215 * loop and wait for the window to actually be mapped. Be careful;
3216 * because the main loop is running, anything can happen during
3220 gtk_widget_show_now (GtkWidget *widget)
3224 g_return_if_fail (GTK_IS_WIDGET (widget));
3226 /* make sure we will get event */
3227 if (!gtk_widget_get_mapped (widget) &&
3228 gtk_widget_is_toplevel (widget))
3230 gtk_widget_show (widget);
3232 g_signal_connect (widget, "map-event",
3233 G_CALLBACK (gtk_widget_show_map_callback),
3237 gtk_main_iteration ();
3240 gtk_widget_show (widget);
3245 * @widget: a #GtkWidget
3247 * Reverses the effects of gtk_widget_show(), causing the widget to be
3248 * hidden (invisible to the user).
3251 gtk_widget_hide (GtkWidget *widget)
3253 g_return_if_fail (GTK_IS_WIDGET (widget));
3255 if (gtk_widget_get_visible (widget))
3257 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
3259 g_object_ref (widget);
3260 if (toplevel != widget && gtk_widget_is_toplevel (toplevel))
3261 _gtk_window_unset_focus_and_default (GTK_WINDOW (toplevel), widget);
3263 g_signal_emit (widget, widget_signals[HIDE], 0);
3264 if (!gtk_widget_is_toplevel (widget))
3265 gtk_widget_queue_resize (widget);
3266 g_object_notify (G_OBJECT (widget), "visible");
3267 g_object_unref (widget);
3272 gtk_widget_real_hide (GtkWidget *widget)
3274 if (gtk_widget_get_visible (widget))
3276 GTK_WIDGET_UNSET_FLAGS (widget, GTK_VISIBLE);
3278 if (gtk_widget_get_mapped (widget))
3279 gtk_widget_unmap (widget);
3284 * gtk_widget_hide_on_delete:
3285 * @widget: a #GtkWidget
3287 * Utility function; intended to be connected to the #GtkWidget::delete-event
3288 * signal on a #GtkWindow. The function calls gtk_widget_hide() on its
3289 * argument, then returns %TRUE. If connected to ::delete-event, the
3290 * result is that clicking the close button for a window (on the
3291 * window frame, top right corner usually) will hide but not destroy
3292 * the window. By default, GTK+ destroys windows when ::delete-event
3295 * Return value: %TRUE
3298 gtk_widget_hide_on_delete (GtkWidget *widget)
3300 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
3302 gtk_widget_hide (widget);
3308 * gtk_widget_show_all:
3309 * @widget: a #GtkWidget
3311 * Recursively shows a widget, and any child widgets (if the widget is
3315 gtk_widget_show_all (GtkWidget *widget)
3317 GtkWidgetClass *class;
3319 g_return_if_fail (GTK_IS_WIDGET (widget));
3321 if (gtk_widget_get_no_show_all (widget))
3324 class = GTK_WIDGET_GET_CLASS (widget);
3326 if (class->show_all)
3327 class->show_all (widget);
3331 * gtk_widget_hide_all:
3332 * @widget: a #GtkWidget
3334 * Recursively hides a widget and any child widgets.
3337 gtk_widget_hide_all (GtkWidget *widget)
3339 GtkWidgetClass *class;
3341 g_return_if_fail (GTK_IS_WIDGET (widget));
3343 if (gtk_widget_get_no_show_all (widget))
3346 class = GTK_WIDGET_GET_CLASS (widget);
3348 if (class->hide_all)
3349 class->hide_all (widget);
3354 * @widget: a #GtkWidget
3356 * This function is only for use in widget implementations. Causes
3357 * a widget to be mapped if it isn't already.
3360 gtk_widget_map (GtkWidget *widget)
3362 g_return_if_fail (GTK_IS_WIDGET (widget));
3363 g_return_if_fail (gtk_widget_get_visible (widget));
3364 g_return_if_fail (GTK_WIDGET_CHILD_VISIBLE (widget));
3366 if (!gtk_widget_get_mapped (widget))
3368 if (!gtk_widget_get_realized (widget))
3369 gtk_widget_realize (widget);
3371 g_signal_emit (widget, widget_signals[MAP], 0);
3373 if (!gtk_widget_get_has_window (widget))
3374 gdk_window_invalidate_rect (widget->window, &widget->allocation, FALSE);
3380 * @widget: a #GtkWidget
3382 * This function is only for use in widget implementations. Causes
3383 * a widget to be unmapped if it's currently mapped.
3386 gtk_widget_unmap (GtkWidget *widget)
3388 g_return_if_fail (GTK_IS_WIDGET (widget));
3390 if (gtk_widget_get_mapped (widget))
3392 if (!gtk_widget_get_has_window (widget))
3393 gdk_window_invalidate_rect (widget->window, &widget->allocation, FALSE);
3394 _gtk_tooltip_hide (widget);
3395 g_signal_emit (widget, widget_signals[UNMAP], 0);
3400 gtk_widget_set_extension_events_internal (GtkWidget *widget,
3401 GdkExtensionMode mode,
3404 GList *free_list = NULL;
3407 if (window_list == NULL)
3409 if (gtk_widget_get_has_window (widget))
3410 window_list = g_list_prepend (NULL, widget->window);
3412 window_list = gdk_window_get_children (widget->window);
3414 free_list = window_list;
3417 for (l = window_list; l != NULL; l = l->next)
3419 GdkWindow *window = l->data;
3422 gdk_window_get_user_data (window, &user_data);
3423 if (user_data == widget)
3427 gdk_input_set_extension_events (window,
3428 gdk_window_get_events (window),
3431 children = gdk_window_get_children (window);
3434 gtk_widget_set_extension_events_internal (widget, mode, children);
3435 g_list_free (children);
3441 g_list_free (free_list);
3445 * gtk_widget_realize:
3446 * @widget: a #GtkWidget
3448 * Creates the GDK (windowing system) resources associated with a
3449 * widget. For example, @widget->window will be created when a widget
3450 * is realized. Normally realization happens implicitly; if you show
3451 * a widget and all its parent containers, then the widget will be
3452 * realized and mapped automatically.
3454 * Realizing a widget requires all
3455 * the widget's parent widgets to be realized; calling
3456 * gtk_widget_realize() realizes the widget's parents in addition to
3457 * @widget itself. If a widget is not yet inside a toplevel window
3458 * when you realize it, bad things will happen.
3460 * This function is primarily used in widget implementations, and
3461 * isn't very useful otherwise. Many times when you think you might
3462 * need it, a better approach is to connect to a signal that will be
3463 * called after the widget is realized automatically, such as
3464 * GtkWidget::expose-event. Or simply g_signal_connect () to the
3465 * GtkWidget::realize signal.
3468 gtk_widget_realize (GtkWidget *widget)
3470 GdkExtensionMode mode;
3471 GtkWidgetShapeInfo *shape_info;
3473 g_return_if_fail (GTK_IS_WIDGET (widget));
3474 g_return_if_fail (GTK_WIDGET_ANCHORED (widget) ||
3475 GTK_IS_INVISIBLE (widget));
3477 if (!gtk_widget_get_realized (widget))
3480 if (GTK_IS_CONTAINER (widget) && gtk_widget_get_has_window (widget))
3481 g_message ("gtk_widget_realize(%s)", G_OBJECT_TYPE_NAME (widget));
3484 if (widget->parent == NULL &&
3485 !gtk_widget_is_toplevel (widget))
3486 g_warning ("Calling gtk_widget_realize() on a widget that isn't "
3487 "inside a toplevel window is not going to work very well. "
3488 "Widgets must be inside a toplevel container before realizing them.");
3490 if (widget->parent && !gtk_widget_get_realized (widget->parent))
3491 gtk_widget_realize (widget->parent);
3493 gtk_widget_ensure_style (widget);
3495 g_signal_emit (widget, widget_signals[REALIZE], 0);
3497 gtk_widget_real_set_has_tooltip (widget,
3498 GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (widget), quark_has_tooltip)),
3501 if (GTK_WIDGET_HAS_SHAPE_MASK (widget))
3503 shape_info = g_object_get_qdata (G_OBJECT (widget), quark_shape_info);
3504 gdk_window_shape_combine_mask (widget->window,
3505 shape_info->shape_mask,
3506 shape_info->offset_x,
3507 shape_info->offset_y);
3510 shape_info = g_object_get_qdata (G_OBJECT (widget), quark_input_shape_info);
3512 gdk_window_input_shape_combine_mask (widget->window,
3513 shape_info->shape_mask,
3514 shape_info->offset_x,
3515 shape_info->offset_y);
3517 mode = gtk_widget_get_extension_events (widget);
3518 if (mode != GDK_EXTENSION_EVENTS_NONE)
3519 gtk_widget_set_extension_events_internal (widget, mode, NULL);
3524 * gtk_widget_unrealize:
3525 * @widget: a #GtkWidget
3527 * This function is only useful in widget implementations.
3528 * Causes a widget to be unrealized (frees all GDK resources
3529 * associated with the widget, such as @widget->window).
3532 gtk_widget_unrealize (GtkWidget *widget)
3534 g_return_if_fail (GTK_IS_WIDGET (widget));
3536 if (GTK_WIDGET_HAS_SHAPE_MASK (widget))
3537 gtk_widget_shape_combine_mask (widget, NULL, 0, 0);
3539 if (g_object_get_qdata (G_OBJECT (widget), quark_input_shape_info))
3540 gtk_widget_input_shape_combine_mask (widget, NULL, 0, 0);
3542 if (gtk_widget_get_realized (widget))
3544 g_object_ref (widget);
3545 _gtk_tooltip_hide (widget);
3546 g_signal_emit (widget, widget_signals[UNREALIZE], 0);
3547 gtk_widget_set_realized (widget, FALSE);
3548 gtk_widget_set_mapped (widget, FALSE);
3549 g_object_unref (widget);
3553 /*****************************************
3555 *****************************************/
3558 * gtk_widget_queue_draw_area:
3559 * @widget: a #GtkWidget
3560 * @x: x coordinate of upper-left corner of rectangle to redraw
3561 * @y: y coordinate of upper-left corner of rectangle to redraw
3562 * @width: width of region to draw
3563 * @height: height of region to draw
3565 * Invalidates the rectangular area of @widget defined by @x, @y,
3566 * @width and @height by calling gdk_window_invalidate_rect() on the
3567 * widget's window and all its child windows. Once the main loop
3568 * becomes idle (after the current batch of events has been processed,
3569 * roughly), the window will receive expose events for the union of
3570 * all regions that have been invalidated.
3572 * Normally you would only use this function in widget
3573 * implementations. You might also use it, or
3574 * gdk_window_invalidate_rect() directly, to schedule a redraw of a
3575 * #GtkDrawingArea or some portion thereof.
3577 * Frequently you can just call gdk_window_invalidate_rect() or
3578 * gdk_window_invalidate_region() instead of this function. Those
3579 * functions will invalidate only a single window, instead of the
3580 * widget and all its children.
3582 * The advantage of adding to the invalidated region compared to
3583 * simply drawing immediately is efficiency; using an invalid region
3584 * ensures that you only have to redraw one time.
3587 gtk_widget_queue_draw_area (GtkWidget *widget,
3593 GdkRectangle invalid_rect;
3596 g_return_if_fail (GTK_IS_WIDGET (widget));
3598 if (!gtk_widget_get_realized (widget))
3601 /* Just return if the widget or one of its ancestors isn't mapped */
3602 for (w = widget; w != NULL; w = w->parent)
3603 if (!gtk_widget_get_mapped (w))
3606 /* Find the correct widget */
3608 if (gtk_widget_get_has_window (widget))
3612 /* Translate widget relative to window-relative */
3614 gint wx, wy, wwidth, wheight;
3616 gdk_window_get_position (widget->window, &wx, &wy);
3617 x -= wx - widget->allocation.x;
3618 y -= wy - widget->allocation.y;
3620 gdk_drawable_get_size (widget->window, &wwidth, &wheight);
3622 if (x + width <= 0 || y + height <= 0 ||
3623 x >= wwidth || y >= wheight)
3634 if (x + width > wwidth)
3636 if (y + height > wheight)
3637 height = wheight - y;
3643 invalid_rect.width = width;
3644 invalid_rect.height = height;
3646 gdk_window_invalidate_rect (widget->window, &invalid_rect, TRUE);
3650 widget_add_child_draw_rectangle (GtkWidget *widget,
3653 GdkRectangle child_rect;
3655 if (!gtk_widget_get_mapped (widget) ||
3656 widget->window != widget->parent->window)
3659 gtk_widget_get_draw_rectangle (widget, &child_rect);
3660 gdk_rectangle_union (rect, &child_rect, rect);
3664 gtk_widget_get_draw_rectangle (GtkWidget *widget,
3667 if (!gtk_widget_get_has_window (widget))
3669 GtkBorder *draw_border = NULL;
3671 *rect = widget->allocation;
3673 gtk_widget_style_get (widget,
3674 "draw-border", &draw_border,
3678 rect->x -= draw_border->left;
3679 rect->y -= draw_border->top;
3680 rect->width += draw_border->left + draw_border->right;
3681 rect->height += draw_border->top + draw_border->bottom;
3683 gtk_border_free (draw_border);
3686 if (GTK_IS_CONTAINER (widget))
3687 gtk_container_forall (GTK_CONTAINER (widget),
3688 (GtkCallback)widget_add_child_draw_rectangle,
3695 rect->width = widget->allocation.width;
3696 rect->height = widget->allocation.height;
3701 * gtk_widget_queue_draw:
3702 * @widget: a #GtkWidget
3704 * Equivalent to calling gtk_widget_queue_draw_area() for the
3705 * entire area of a widget.
3708 gtk_widget_queue_draw (GtkWidget *widget)
3712 g_return_if_fail (GTK_IS_WIDGET (widget));
3714 gtk_widget_get_draw_rectangle (widget, &rect);
3716 gtk_widget_queue_draw_area (widget,
3718 rect.width, rect.height);
3722 * gtk_widget_queue_resize:
3723 * @widget: a #GtkWidget
3725 * This function is only for use in widget implementations.
3726 * Flags a widget to have its size renegotiated; should
3727 * be called when a widget for some reason has a new size request.
3728 * For example, when you change the text in a #GtkLabel, #GtkLabel
3729 * queues a resize to ensure there's enough space for the new text.
3732 gtk_widget_queue_resize (GtkWidget *widget)
3734 g_return_if_fail (GTK_IS_WIDGET (widget));
3736 if (gtk_widget_get_realized (widget))
3737 gtk_widget_queue_shallow_draw (widget);
3739 _gtk_size_group_queue_resize (widget);
3743 * gtk_widget_queue_resize_no_redraw:
3744 * @widget: a #GtkWidget
3746 * This function works like gtk_widget_queue_resize(),
3747 * except that the widget is not invalidated.
3752 gtk_widget_queue_resize_no_redraw (GtkWidget *widget)
3754 g_return_if_fail (GTK_IS_WIDGET (widget));
3756 _gtk_size_group_queue_resize (widget);
3760 * gtk_widget_size_request:
3761 * @widget: a #GtkWidget
3762 * @requisition: a #GtkRequisition to be filled in
3764 * This function is typically used when implementing a #GtkContainer
3765 * subclass. Obtains the preferred size of a widget. The container
3766 * uses this information to arrange its child widgets and decide what
3767 * size allocations to give them with gtk_widget_size_allocate().
3769 * You can also call this function from an application, with some
3770 * caveats. Most notably, getting a size request requires the widget
3771 * to be associated with a screen, because font information may be
3772 * needed. Multihead-aware applications should keep this in mind.
3774 * Also remember that the size request is not necessarily the size
3775 * a widget will actually be allocated.
3777 * Deprecated: 3.0: Use gtk_extended_layout_get_desired_size() instead.
3780 gtk_widget_size_request (GtkWidget *widget,
3781 GtkRequisition *requisition)
3783 g_return_if_fail (GTK_IS_WIDGET (widget));
3785 #ifdef G_ENABLE_DEBUG
3786 if (requisition == &widget->requisition)
3787 g_warning ("gtk_widget_size_request() called on child widget with request equal\n"
3788 "to widget->requisition. gtk_widget_set_usize() may not work properly.");
3789 #endif /* G_ENABLE_DEBUG */
3791 gtk_extended_layout_get_desired_size (GTK_EXTENDED_LAYOUT (widget), FALSE, requisition, NULL);
3795 * gtk_widget_get_child_requisition:
3796 * @widget: a #GtkWidget
3797 * @requisition: a #GtkRequisition to be filled in
3799 * This function is only for use in widget implementations. Obtains
3800 * @widget->requisition, unless someone has forced a particular
3801 * geometry on the widget (e.g. with gtk_widget_set_size_request()),
3802 * in which case it returns that geometry instead of the widget's
3805 * This function differs from gtk_widget_size_request() in that
3806 * it retrieves the last size request value from @widget->requisition,
3807 * while gtk_widget_size_request() actually calls the "size_request" method
3808 * on @widget to compute the size request and fill in @widget->requisition,
3809 * and only then returns @widget->requisition.
3811 * Because this function does not call the "size_request" method, it
3812 * can only be used when you know that @widget->requisition is
3813 * up-to-date, that is, gtk_widget_size_request() has been called
3814 * since the last time a resize was queued. In general, only container
3815 * implementations have this information; applications should use
3816 * gtk_widget_size_request().
3819 * Deprecated: 3.0: Use gtk_extended_layout_get_desired_size() instead.
3822 gtk_widget_get_child_requisition (GtkWidget *widget,
3823 GtkRequisition *requisition)
3825 gtk_extended_layout_get_desired_size (GTK_EXTENDED_LAYOUT (widget), FALSE, requisition, NULL);
3829 invalidate_predicate (GdkWindow *window,
3834 gdk_window_get_user_data (window, &user_data);
3836 return (user_data == data);
3839 /* Invalidate @region in widget->window and all children
3840 * of widget->window owned by widget. @region is in the
3841 * same coordinates as widget->allocation and will be
3842 * modified by this call.
3845 gtk_widget_invalidate_widget_windows (GtkWidget *widget,
3848 if (!gtk_widget_get_realized (widget))
3851 if (gtk_widget_get_has_window (widget) && widget->parent)
3855 gdk_window_get_position (widget->window, &x, &y);
3856 gdk_region_offset (region, -x, -y);
3859 gdk_window_invalidate_maybe_recurse (widget->window, region,
3860 invalidate_predicate, widget);
3864 * gtk_widget_queue_shallow_draw:
3865 * @widget: a #GtkWidget
3867 * Like gtk_widget_queue_draw(), but only windows owned
3868 * by @widget are invalidated.
3871 gtk_widget_queue_shallow_draw (GtkWidget *widget)
3876 if (!gtk_widget_get_realized (widget))
3879 gtk_widget_get_draw_rectangle (widget, &rect);
3881 /* get_draw_rectangle() gives us window coordinates, we
3882 * need to convert to the coordinates that widget->allocation
3885 if (gtk_widget_get_has_window (widget) && widget->parent)
3889 gdk_window_get_position (widget->window, &wx, &wy);
3895 region = gdk_region_rectangle (&rect);
3896 gtk_widget_invalidate_widget_windows (widget, region);
3897 gdk_region_destroy (region);
3901 * gtk_widget_size_allocate:
3902 * @widget: a #GtkWidget
3903 * @allocation: position and size to be allocated to @widget
3905 * This function is only used by #GtkContainer subclasses, to assign a size
3906 * and position to their child widgets.
3909 gtk_widget_size_allocate (GtkWidget *widget,
3910 GtkAllocation *allocation)
3912 GtkWidgetAuxInfo *aux_info;
3913 GdkRectangle real_allocation;
3914 GdkRectangle old_allocation;
3915 gboolean alloc_needed;
3916 gboolean size_changed;
3917 gboolean position_changed;
3919 g_return_if_fail (GTK_IS_WIDGET (widget));
3921 #ifdef G_ENABLE_DEBUG
3922 if (gtk_debug_flags & GTK_DEBUG_GEOMETRY)
3933 parent = gtk_widget_get_parent (parent);
3936 name = g_type_name (G_OBJECT_TYPE (G_OBJECT (widget)));
3937 g_print ("gtk_widget_size_allocate: %*s%s %d %d\n",
3938 2 * depth, " ", name,
3939 allocation->width, allocation->height);
3941 #endif /* G_ENABLE_DEBUG */
3943 alloc_needed = GTK_WIDGET_ALLOC_NEEDED (widget);
3944 if (!GTK_WIDGET_REQUEST_NEEDED (widget)) /* Preserve request/allocate ordering */
3945 GTK_PRIVATE_UNSET_FLAG (widget, GTK_ALLOC_NEEDED);
3947 old_allocation = widget->allocation;
3948 real_allocation = *allocation;
3949 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
3953 if (aux_info->x_set)
3954 real_allocation.x = aux_info->x;
3955 if (aux_info->y_set)
3956 real_allocation.y = aux_info->y;
3959 if (real_allocation.width < 0 || real_allocation.height < 0)
3961 g_warning ("gtk_widget_size_allocate(): attempt to allocate widget with width %d and height %d",
3962 real_allocation.width,
3963 real_allocation.height);
3966 real_allocation.width = MAX (real_allocation.width, 1);
3967 real_allocation.height = MAX (real_allocation.height, 1);
3969 size_changed = (old_allocation.width != real_allocation.width ||
3970 old_allocation.height != real_allocation.height);
3971 position_changed = (old_allocation.x != real_allocation.x ||
3972 old_allocation.y != real_allocation.y);
3974 if (!alloc_needed && !size_changed && !position_changed)
3977 g_signal_emit (widget, widget_signals[SIZE_ALLOCATE], 0, &real_allocation);
3979 if (gtk_widget_get_mapped (widget))
3981 if (!gtk_widget_get_has_window (widget) && GTK_WIDGET_REDRAW_ON_ALLOC (widget) && position_changed)
3983 /* Invalidate union(old_allaction,widget->allocation) in widget->window
3985 GdkRegion *invalidate = gdk_region_rectangle (&widget->allocation);
3986 gdk_region_union_with_rect (invalidate, &old_allocation);
3988 gdk_window_invalidate_region (widget->window, invalidate, FALSE);
3989 gdk_region_destroy (invalidate);
3994 if (GTK_WIDGET_REDRAW_ON_ALLOC (widget))
3996 /* Invalidate union(old_allaction,widget->allocation) in widget->window and descendents owned by widget
3998 GdkRegion *invalidate = gdk_region_rectangle (&widget->allocation);
3999 gdk_region_union_with_rect (invalidate, &old_allocation);
4001 gtk_widget_invalidate_widget_windows (widget, invalidate);
4002 gdk_region_destroy (invalidate);
4007 if ((size_changed || position_changed) && widget->parent &&
4008 gtk_widget_get_realized (widget->parent) && GTK_CONTAINER (widget->parent)->reallocate_redraws)
4010 GdkRegion *invalidate = gdk_region_rectangle (&widget->parent->allocation);
4011 gtk_widget_invalidate_widget_windows (widget->parent, invalidate);
4012 gdk_region_destroy (invalidate);
4017 * gtk_widget_common_ancestor:
4018 * @widget_a: a #GtkWidget
4019 * @widget_b: a #GtkWidget
4021 * Find the common ancestor of @widget_a and @widget_b that
4022 * is closest to the two widgets.
4024 * Return value: the closest common ancestor of @widget_a and
4025 * @widget_b or %NULL if @widget_a and @widget_b do not
4026 * share a common ancestor.
4029 gtk_widget_common_ancestor (GtkWidget *widget_a,
4030 GtkWidget *widget_b)
4032 GtkWidget *parent_a;
4033 GtkWidget *parent_b;
4037 parent_a = widget_a;
4038 while (parent_a->parent)
4040 parent_a = parent_a->parent;
4044 parent_b = widget_b;
4045 while (parent_b->parent)
4047 parent_b = parent_b->parent;
4051 if (parent_a != parent_b)
4054 while (depth_a > depth_b)
4056 widget_a = widget_a->parent;
4060 while (depth_b > depth_a)
4062 widget_b = widget_b->parent;
4066 while (widget_a != widget_b)
4068 widget_a = widget_a->parent;
4069 widget_b = widget_b->parent;
4076 * gtk_widget_translate_coordinates:
4077 * @src_widget: a #GtkWidget
4078 * @dest_widget: a #GtkWidget
4079 * @src_x: X position relative to @src_widget
4080 * @src_y: Y position relative to @src_widget
4081 * @dest_x: (out): location to store X position relative to @dest_widget
4082 * @dest_y: (out): location to store Y position relative to @dest_widget
4084 * Translate coordinates relative to @src_widget's allocation to coordinates
4085 * relative to @dest_widget's allocations. In order to perform this
4086 * operation, both widgets must be realized, and must share a common
4089 * Return value: %FALSE if either widget was not realized, or there
4090 * was no common ancestor. In this case, nothing is stored in
4091 * *@dest_x and *@dest_y. Otherwise %TRUE.
4094 gtk_widget_translate_coordinates (GtkWidget *src_widget,
4095 GtkWidget *dest_widget,
4101 GtkWidget *ancestor;
4103 GList *dest_list = NULL;
4105 g_return_val_if_fail (GTK_IS_WIDGET (src_widget), FALSE);
4106 g_return_val_if_fail (GTK_IS_WIDGET (dest_widget), FALSE);
4108 ancestor = gtk_widget_common_ancestor (src_widget, dest_widget);
4109 if (!ancestor || !gtk_widget_get_realized (src_widget) || !gtk_widget_get_realized (dest_widget))
4112 /* Translate from allocation relative to window relative */
4113 if (gtk_widget_get_has_window (src_widget) && src_widget->parent)
4116 gdk_window_get_position (src_widget->window, &wx, &wy);
4118 src_x -= wx - src_widget->allocation.x;
4119 src_y -= wy - src_widget->allocation.y;
4123 src_x += src_widget->allocation.x;
4124 src_y += src_widget->allocation.y;
4127 /* Translate to the common ancestor */
4128 window = src_widget->window;
4129 while (window != ancestor->window)
4133 gdk_window_coords_to_parent (window, src_x, src_y, &dx, &dy);
4138 window = gdk_window_get_effective_parent (window);
4140 if (!window) /* Handle GtkHandleBox */
4145 window = dest_widget->window;
4146 while (window != ancestor->window)
4148 dest_list = g_list_prepend (dest_list, window);
4150 window = gdk_window_get_effective_parent (window);
4152 if (!window) /* Handle GtkHandleBox */
4154 g_list_free (dest_list);
4163 gdk_window_coords_from_parent (dest_list->data, src_x, src_y, &dx, &dy);
4168 dest_list = g_list_remove (dest_list, dest_list->data);
4171 /* Translate from window relative to allocation relative */
4172 if (gtk_widget_get_has_window (dest_widget) && dest_widget->parent)
4175 gdk_window_get_position (dest_widget->window, &wx, &wy);
4177 src_x += wx - dest_widget->allocation.x;
4178 src_y += wy - dest_widget->allocation.y;
4182 src_x -= dest_widget->allocation.x;
4183 src_y -= dest_widget->allocation.y;
4195 gtk_widget_real_size_allocate (GtkWidget *widget,
4196 GtkAllocation *allocation)
4198 widget->allocation = *allocation;
4200 if (gtk_widget_get_realized (widget) &&
4201 gtk_widget_get_has_window (widget))
4203 gdk_window_move_resize (widget->window,
4204 allocation->x, allocation->y,
4205 allocation->width, allocation->height);
4210 gtk_widget_real_can_activate_accel (GtkWidget *widget,
4213 /* widgets must be onscreen for accels to take effect */
4214 return gtk_widget_is_sensitive (widget) &&
4215 gtk_widget_is_drawable (widget) &&
4216 gdk_window_is_viewable (widget->window);
4220 * gtk_widget_can_activate_accel:
4221 * @widget: a #GtkWidget
4222 * @signal_id: the ID of a signal installed on @widget
4224 * Determines whether an accelerator that activates the signal
4225 * identified by @signal_id can currently be activated.
4226 * This is done by emitting the #GtkWidget::can-activate-accel
4227 * signal on @widget; if the signal isn't overridden by a
4228 * handler or in a derived widget, then the default check is
4229 * that the widget must be sensitive, and the widget and all
4230 * its ancestors mapped.
4232 * Return value: %TRUE if the accelerator can be activated.
4237 gtk_widget_can_activate_accel (GtkWidget *widget,
4240 gboolean can_activate = FALSE;
4241 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4242 g_signal_emit (widget, widget_signals[CAN_ACTIVATE_ACCEL], 0, signal_id, &can_activate);
4243 return can_activate;
4252 closure_accel_activate (GClosure *closure,
4253 GValue *return_value,
4254 guint n_param_values,
4255 const GValue *param_values,
4256 gpointer invocation_hint,
4257 gpointer marshal_data)
4259 AccelClosure *aclosure = (AccelClosure*) closure;
4260 gboolean can_activate = gtk_widget_can_activate_accel (closure->data, aclosure->signal_id);
4263 g_signal_emit (closure->data, aclosure->signal_id, 0);
4265 /* whether accelerator was handled */
4266 g_value_set_boolean (return_value, can_activate);
4270 closures_destroy (gpointer data)
4272 GSList *slist, *closures = data;
4274 for (slist = closures; slist; slist = slist->next)
4276 g_closure_invalidate (slist->data);
4277 g_closure_unref (slist->data);
4279 g_slist_free (closures);
4283 widget_new_accel_closure (GtkWidget *widget,
4286 AccelClosure *aclosure;
4287 GClosure *closure = NULL;
4288 GSList *slist, *closures;
4290 closures = g_object_steal_qdata (G_OBJECT (widget), quark_accel_closures);
4291 for (slist = closures; slist; slist = slist->next)
4292 if (!gtk_accel_group_from_accel_closure (slist->data))
4294 /* reuse this closure */
4295 closure = slist->data;
4300 closure = g_closure_new_object (sizeof (AccelClosure), G_OBJECT (widget));
4301 closures = g_slist_prepend (closures, g_closure_ref (closure));
4302 g_closure_sink (closure);
4303 g_closure_set_marshal (closure, closure_accel_activate);
4305 g_object_set_qdata_full (G_OBJECT (widget), quark_accel_closures, closures, closures_destroy);
4307 aclosure = (AccelClosure*) closure;
4308 g_assert (closure->data == widget);
4309 g_assert (closure->marshal == closure_accel_activate);
4310 aclosure->signal_id = signal_id;
4316 * gtk_widget_add_accelerator
4317 * @widget: widget to install an accelerator on
4318 * @accel_signal: widget signal to emit on accelerator activation
4319 * @accel_group: accel group for this widget, added to its toplevel
4320 * @accel_key: GDK keyval of the accelerator
4321 * @accel_mods: modifier key combination of the accelerator
4322 * @accel_flags: flag accelerators, e.g. %GTK_ACCEL_VISIBLE
4324 * Installs an accelerator for this @widget in @accel_group that causes
4325 * @accel_signal to be emitted if the accelerator is activated.
4326 * The @accel_group needs to be added to the widget's toplevel via
4327 * gtk_window_add_accel_group(), and the signal must be of type %G_RUN_ACTION.
4328 * Accelerators added through this function are not user changeable during
4329 * runtime. If you want to support accelerators that can be changed by the
4330 * user, use gtk_accel_map_add_entry() and gtk_widget_set_accel_path() or
4331 * gtk_menu_item_set_accel_path() instead.
4334 gtk_widget_add_accelerator (GtkWidget *widget,
4335 const gchar *accel_signal,
4336 GtkAccelGroup *accel_group,
4338 GdkModifierType accel_mods,
4339 GtkAccelFlags accel_flags)
4344 g_return_if_fail (GTK_IS_WIDGET (widget));
4345 g_return_if_fail (accel_signal != NULL);
4346 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
4348 g_signal_query (g_signal_lookup (accel_signal, G_OBJECT_TYPE (widget)), &query);
4349 if (!query.signal_id ||
4350 !(query.signal_flags & G_SIGNAL_ACTION) ||
4351 query.return_type != G_TYPE_NONE ||
4354 /* hmm, should be elaborate enough */
4355 g_warning (G_STRLOC ": widget `%s' has no activatable signal \"%s\" without arguments",
4356 G_OBJECT_TYPE_NAME (widget), accel_signal);
4360 closure = widget_new_accel_closure (widget, query.signal_id);
4362 g_object_ref (widget);
4364 /* install the accelerator. since we don't map this onto an accel_path,
4365 * the accelerator will automatically be locked.
4367 gtk_accel_group_connect (accel_group,
4370 accel_flags | GTK_ACCEL_LOCKED,
4373 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
4375 g_object_unref (widget);
4379 * gtk_widget_remove_accelerator:
4380 * @widget: widget to install an accelerator on
4381 * @accel_group: accel group for this widget
4382 * @accel_key: GDK keyval of the accelerator
4383 * @accel_mods: modifier key combination of the accelerator
4384 * @returns: whether an accelerator was installed and could be removed
4386 * Removes an accelerator from @widget, previously installed with
4387 * gtk_widget_add_accelerator().
4390 gtk_widget_remove_accelerator (GtkWidget *widget,
4391 GtkAccelGroup *accel_group,
4393 GdkModifierType accel_mods)
4395 GtkAccelGroupEntry *ag_entry;
4396 GList *slist, *clist;
4399 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4400 g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE);
4402 ag_entry = gtk_accel_group_query (accel_group, accel_key, accel_mods, &n);
4403 clist = gtk_widget_list_accel_closures (widget);
4404 for (slist = clist; slist; slist = slist->next)
4408 for (i = 0; i < n; i++)
4409 if (slist->data == (gpointer) ag_entry[i].closure)
4411 gboolean is_removed = gtk_accel_group_disconnect (accel_group, slist->data);
4413 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
4415 g_list_free (clist);
4420 g_list_free (clist);
4422 g_warning (G_STRLOC ": no accelerator (%u,%u) installed in accel group (%p) for %s (%p)",
4423 accel_key, accel_mods, accel_group,
4424 G_OBJECT_TYPE_NAME (widget), widget);
4430 * gtk_widget_list_accel_closures
4431 * @widget: widget to list accelerator closures for
4432 * @returns: a newly allocated #GList of closures
4434 * Lists the closures used by @widget for accelerator group connections
4435 * with gtk_accel_group_connect_by_path() or gtk_accel_group_connect().
4436 * The closures can be used to monitor accelerator changes on @widget,
4437 * by connecting to the @GtkAccelGroup::accel-changed signal of the
4438 * #GtkAccelGroup of a closure which can be found out with
4439 * gtk_accel_group_from_accel_closure().
4442 gtk_widget_list_accel_closures (GtkWidget *widget)
4445 GList *clist = NULL;
4447 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4449 for (slist = g_object_get_qdata (G_OBJECT (widget), quark_accel_closures); slist; slist = slist->next)
4450 if (gtk_accel_group_from_accel_closure (slist->data))
4451 clist = g_list_prepend (clist, slist->data);
4457 GtkAccelGroup *accel_group;
4462 destroy_accel_path (gpointer data)
4464 AccelPath *apath = data;
4466 gtk_accel_group_disconnect (apath->accel_group, apath->closure);
4468 /* closures_destroy takes care of unrefing the closure */
4469 g_object_unref (apath->accel_group);
4471 g_slice_free (AccelPath, apath);
4476 * gtk_widget_set_accel_path:
4477 * @widget: a #GtkWidget
4478 * @accel_path: (allow-none): path used to look up the accelerator
4479 * @accel_group: (allow-none): a #GtkAccelGroup.
4481 * Given an accelerator group, @accel_group, and an accelerator path,
4482 * @accel_path, sets up an accelerator in @accel_group so whenever the
4483 * key binding that is defined for @accel_path is pressed, @widget
4484 * will be activated. This removes any accelerators (for any
4485 * accelerator group) installed by previous calls to
4486 * gtk_widget_set_accel_path(). Associating accelerators with
4487 * paths allows them to be modified by the user and the modifications
4488 * to be saved for future use. (See gtk_accel_map_save().)
4490 * This function is a low level function that would most likely
4491 * be used by a menu creation system like #GtkUIManager. If you
4492 * use #GtkUIManager, setting up accelerator paths will be done
4495 * Even when you you aren't using #GtkUIManager, if you only want to
4496 * set up accelerators on menu items gtk_menu_item_set_accel_path()
4497 * provides a somewhat more convenient interface.
4499 * Note that @accel_path string will be stored in a #GQuark. Therefore, if you
4500 * pass a static string, you can save some memory by interning it first with
4501 * g_intern_static_string().
4504 gtk_widget_set_accel_path (GtkWidget *widget,
4505 const gchar *accel_path,
4506 GtkAccelGroup *accel_group)
4510 g_return_if_fail (GTK_IS_WIDGET (widget));
4511 g_return_if_fail (GTK_WIDGET_GET_CLASS (widget)->activate_signal != 0);
4515 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
4516 g_return_if_fail (_gtk_accel_path_is_valid (accel_path));
4518 gtk_accel_map_add_entry (accel_path, 0, 0);
4519 apath = g_slice_new (AccelPath);
4520 apath->accel_group = g_object_ref (accel_group);
4521 apath->path_quark = g_quark_from_string (accel_path);
4522 apath->closure = widget_new_accel_closure (widget, GTK_WIDGET_GET_CLASS (widget)->activate_signal);
4527 /* also removes possible old settings */
4528 g_object_set_qdata_full (G_OBJECT (widget), quark_accel_path, apath, destroy_accel_path);
4531 gtk_accel_group_connect_by_path (apath->accel_group, g_quark_to_string (apath->path_quark), apath->closure);
4533 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
4537 _gtk_widget_get_accel_path (GtkWidget *widget,
4542 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4544 apath = g_object_get_qdata (G_OBJECT (widget), quark_accel_path);
4546 *locked = apath ? gtk_accel_group_get_is_locked (apath->accel_group) : TRUE;
4547 return apath ? g_quark_to_string (apath->path_quark) : NULL;
4551 * gtk_widget_mnemonic_activate:
4552 * @widget: a #GtkWidget
4553 * @group_cycling: %TRUE if there are other widgets with the same mnemonic
4555 * Emits the #GtkWidget::mnemonic-activate signal.
4557 * The default handler for this signal activates the @widget if
4558 * @group_cycling is %FALSE, and just grabs the focus if @group_cycling
4561 * Returns: %TRUE if the signal has been handled
4564 gtk_widget_mnemonic_activate (GtkWidget *widget,
4565 gboolean group_cycling)
4569 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4571 group_cycling = group_cycling != FALSE;
4572 if (!gtk_widget_is_sensitive (widget))
4575 g_signal_emit (widget,
4576 widget_signals[MNEMONIC_ACTIVATE],
4584 gtk_widget_real_mnemonic_activate (GtkWidget *widget,
4585 gboolean group_cycling)
4587 if (!group_cycling && GTK_WIDGET_GET_CLASS (widget)->activate_signal)
4588 gtk_widget_activate (widget);
4589 else if (gtk_widget_get_can_focus (widget))
4590 gtk_widget_grab_focus (widget);
4593 g_warning ("widget `%s' isn't suitable for mnemonic activation",
4594 G_OBJECT_TYPE_NAME (widget));
4595 gtk_widget_error_bell (widget);
4601 gtk_widget_real_key_press_event (GtkWidget *widget,
4604 return gtk_bindings_activate_event (GTK_OBJECT (widget), event);
4608 gtk_widget_real_key_release_event (GtkWidget *widget,
4611 return gtk_bindings_activate_event (GTK_OBJECT (widget), event);
4615 gtk_widget_real_focus_in_event (GtkWidget *widget,
4616 GdkEventFocus *event)
4618 gtk_widget_queue_shallow_draw (widget);
4624 gtk_widget_real_focus_out_event (GtkWidget *widget,
4625 GdkEventFocus *event)
4627 gtk_widget_queue_shallow_draw (widget);
4632 #define WIDGET_REALIZED_FOR_EVENT(widget, event) \
4633 (event->type == GDK_FOCUS_CHANGE || gtk_widget_get_realized(widget))
4637 * @widget: a #GtkWidget
4638 * @event: a #GdkEvent
4640 * Rarely-used function. This function is used to emit
4641 * the event signals on a widget (those signals should never
4642 * be emitted without using this function to do so).
4643 * If you want to synthesize an event though, don't use this function;
4644 * instead, use gtk_main_do_event() so the event will behave as if
4645 * it were in the event queue. Don't synthesize expose events; instead,
4646 * use gdk_window_invalidate_rect() to invalidate a region of the
4649 * Return value: return from the event signal emission (%TRUE if
4650 * the event was handled)
4653 gtk_widget_event (GtkWidget *widget,
4656 g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
4657 g_return_val_if_fail (WIDGET_REALIZED_FOR_EVENT (widget, event), TRUE);
4659 if (event->type == GDK_EXPOSE)
4661 g_warning ("Events of type GDK_EXPOSE cannot be synthesized. To get "
4662 "the same effect, call gdk_window_invalidate_rect/region(), "
4663 "followed by gdk_window_process_updates().");
4667 return gtk_widget_event_internal (widget, event);
4672 * gtk_widget_send_expose:
4673 * @widget: a #GtkWidget
4674 * @event: a expose #GdkEvent
4676 * Very rarely-used function. This function is used to emit
4677 * an expose event signals on a widget. This function is not
4678 * normally used directly. The only time it is used is when
4679 * propagating an expose event to a child %NO_WINDOW widget, and
4680 * that is normally done using gtk_container_propagate_expose().
4682 * If you want to force an area of a window to be redrawn,
4683 * use gdk_window_invalidate_rect() or gdk_window_invalidate_region().
4684 * To cause the redraw to be done immediately, follow that call
4685 * with a call to gdk_window_process_updates().
4687 * Return value: return from the event signal emission (%TRUE if
4688 * the event was handled)
4691 gtk_widget_send_expose (GtkWidget *widget,
4694 g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
4695 g_return_val_if_fail (gtk_widget_get_realized (widget), TRUE);
4696 g_return_val_if_fail (event != NULL, TRUE);
4697 g_return_val_if_fail (event->type == GDK_EXPOSE, TRUE);
4699 return gtk_widget_event_internal (widget, event);
4703 event_window_is_still_viewable (GdkEvent *event)
4705 /* Some programs, such as gnome-theme-manager, fake widgets
4706 * into exposing onto a pixmap by sending expose events with
4707 * event->window pointing to a pixmap
4709 if (GDK_IS_PIXMAP (event->any.window))
4710 return event->type == GDK_EXPOSE;
4712 /* Check that we think the event's window is viewable before
4713 * delivering the event, to prevent suprises. We do this here
4714 * at the last moment, since the event may have been queued
4715 * up behind other events, held over a recursive main loop, etc.
4717 switch (event->type)
4720 case GDK_MOTION_NOTIFY:
4721 case GDK_BUTTON_PRESS:
4722 case GDK_2BUTTON_PRESS:
4723 case GDK_3BUTTON_PRESS:
4725 case GDK_ENTER_NOTIFY:
4726 case GDK_PROXIMITY_IN:
4728 return event->any.window && gdk_window_is_viewable (event->any.window);
4731 /* The following events are the second half of paired events;
4732 * we always deliver them to deal with widgets that clean up
4733 * on the second half.
4735 case GDK_BUTTON_RELEASE:
4736 case GDK_KEY_RELEASE:
4737 case GDK_LEAVE_NOTIFY:
4738 case GDK_PROXIMITY_OUT:
4742 /* Remaining events would make sense on an not-viewable window,
4743 * or don't have an associated window.
4750 gtk_widget_event_internal (GtkWidget *widget,
4753 gboolean return_val = FALSE;
4755 /* We check only once for is-still-visible; if someone
4756 * hides the window in on of the signals on the widget,
4757 * they are responsible for returning TRUE to terminate
4760 if (!event_window_is_still_viewable (event))
4763 g_object_ref (widget);
4765 g_signal_emit (widget, widget_signals[EVENT], 0, event, &return_val);
4766 return_val |= !WIDGET_REALIZED_FOR_EVENT (widget, event);
4771 switch (event->type)
4776 case GDK_BUTTON_PRESS:
4777 case GDK_2BUTTON_PRESS:
4778 case GDK_3BUTTON_PRESS:
4779 signal_num = BUTTON_PRESS_EVENT;
4782 signal_num = SCROLL_EVENT;
4784 case GDK_BUTTON_RELEASE:
4785 signal_num = BUTTON_RELEASE_EVENT;
4787 case GDK_MOTION_NOTIFY:
4788 signal_num = MOTION_NOTIFY_EVENT;
4791 signal_num = DELETE_EVENT;
4794 signal_num = DESTROY_EVENT;
4795 _gtk_tooltip_hide (widget);
4798 signal_num = KEY_PRESS_EVENT;
4800 case GDK_KEY_RELEASE:
4801 signal_num = KEY_RELEASE_EVENT;
4803 case GDK_ENTER_NOTIFY:
4804 signal_num = ENTER_NOTIFY_EVENT;
4806 case GDK_LEAVE_NOTIFY:
4807 signal_num = LEAVE_NOTIFY_EVENT;
4809 case GDK_FOCUS_CHANGE:
4810 signal_num = event->focus_change.in ? FOCUS_IN_EVENT : FOCUS_OUT_EVENT;
4811 if (event->focus_change.in)
4812 _gtk_tooltip_focus_in (widget);
4814 _gtk_tooltip_focus_out (widget);
4817 signal_num = CONFIGURE_EVENT;
4820 signal_num = MAP_EVENT;
4823 signal_num = UNMAP_EVENT;
4825 case GDK_WINDOW_STATE:
4826 signal_num = WINDOW_STATE_EVENT;
4828 case GDK_PROPERTY_NOTIFY:
4829 signal_num = PROPERTY_NOTIFY_EVENT;
4831 case GDK_SELECTION_CLEAR:
4832 signal_num = SELECTION_CLEAR_EVENT;
4834 case GDK_SELECTION_REQUEST:
4835 signal_num = SELECTION_REQUEST_EVENT;
4837 case GDK_SELECTION_NOTIFY:
4838 signal_num = SELECTION_NOTIFY_EVENT;
4840 case GDK_PROXIMITY_IN:
4841 signal_num = PROXIMITY_IN_EVENT;
4843 case GDK_PROXIMITY_OUT:
4844 signal_num = PROXIMITY_OUT_EVENT;
4847 signal_num = NO_EXPOSE_EVENT;
4849 case GDK_CLIENT_EVENT:
4850 signal_num = CLIENT_EVENT;
4853 signal_num = EXPOSE_EVENT;
4855 case GDK_VISIBILITY_NOTIFY:
4856 signal_num = VISIBILITY_NOTIFY_EVENT;
4858 case GDK_GRAB_BROKEN:
4859 signal_num = GRAB_BROKEN;
4862 signal_num = DAMAGE_EVENT;
4865 g_warning ("gtk_widget_event(): unhandled event type: %d", event->type);
4869 if (signal_num != -1)
4870 g_signal_emit (widget, widget_signals[signal_num], 0, event, &return_val);
4872 if (WIDGET_REALIZED_FOR_EVENT (widget, event))
4873 g_signal_emit (widget, widget_signals[EVENT_AFTER], 0, event);
4877 g_object_unref (widget);
4883 * gtk_widget_activate:
4884 * @widget: a #GtkWidget that's activatable
4886 * For widgets that can be "activated" (buttons, menu items, etc.)
4887 * this function activates them. Activation is what happens when you
4888 * press Enter on a widget during key navigation. If @widget isn't
4889 * activatable, the function returns %FALSE.
4891 * Return value: %TRUE if the widget was activatable
4894 gtk_widget_activate (GtkWidget *widget)
4896 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4898 if (WIDGET_CLASS (widget)->activate_signal)
4900 /* FIXME: we should eventually check the signals signature here */
4901 g_signal_emit (widget, WIDGET_CLASS (widget)->activate_signal, 0);
4910 * gtk_widget_set_scroll_adjustments:
4911 * @widget: a #GtkWidget
4912 * @hadjustment: (allow-none): an adjustment for horizontal scrolling, or %NULL
4913 * @vadjustment: (allow-none): an adjustment for vertical scrolling, or %NULL
4915 * For widgets that support scrolling, sets the scroll adjustments and
4916 * returns %TRUE. For widgets that don't support scrolling, does
4917 * nothing and returns %FALSE. Widgets that don't support scrolling
4918 * can be scrolled by placing them in a #GtkViewport, which does
4919 * support scrolling.
4921 * Return value: %TRUE if the widget supports scrolling
4924 gtk_widget_set_scroll_adjustments (GtkWidget *widget,
4925 GtkAdjustment *hadjustment,
4926 GtkAdjustment *vadjustment)
4931 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4934 g_return_val_if_fail (GTK_IS_ADJUSTMENT (hadjustment), FALSE);
4936 g_return_val_if_fail (GTK_IS_ADJUSTMENT (vadjustment), FALSE);
4938 signal_id = WIDGET_CLASS (widget)->set_scroll_adjustments_signal;
4942 g_signal_query (signal_id, &query);
4943 if (!query.signal_id ||
4944 !g_type_is_a (query.itype, GTK_TYPE_WIDGET) ||
4945 query.return_type != G_TYPE_NONE ||
4946 query.n_params != 2 ||
4947 query.param_types[0] != GTK_TYPE_ADJUSTMENT ||
4948 query.param_types[1] != GTK_TYPE_ADJUSTMENT)
4950 g_warning (G_STRLOC ": signal \"%s::%s\" has wrong signature",
4951 G_OBJECT_TYPE_NAME (widget), query.signal_name);
4955 g_signal_emit (widget, signal_id, 0, hadjustment, vadjustment);
4960 gtk_widget_reparent_subwindows (GtkWidget *widget,
4961 GdkWindow *new_window)
4963 if (!gtk_widget_get_has_window (widget))
4965 GList *children = gdk_window_get_children (widget->window);
4968 for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
4970 GdkWindow *window = tmp_list->data;
4973 gdk_window_get_user_data (window, &child);
4974 while (child && child != widget)
4975 child = ((GtkWidget*) child)->parent;
4978 gdk_window_reparent (window, new_window, 0, 0);
4981 g_list_free (children);
4986 GList *tmp_list, *children;
4988 parent = gdk_window_get_parent (widget->window);
4991 gdk_window_reparent (widget->window, new_window, 0, 0);
4994 children = gdk_window_get_children (parent);
4996 for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
4998 GdkWindow *window = tmp_list->data;
5001 gdk_window_get_user_data (window, &child);
5003 if (child == widget)
5004 gdk_window_reparent (window, new_window, 0, 0);
5007 g_list_free (children);
5013 gtk_widget_reparent_fixup_child (GtkWidget *widget,
5014 gpointer client_data)
5016 g_assert (client_data != NULL);
5018 if (!gtk_widget_get_has_window (widget))
5021 g_object_unref (widget->window);
5022 widget->window = (GdkWindow*) client_data;
5024 g_object_ref (widget->window);
5026 if (GTK_IS_CONTAINER (widget))
5027 gtk_container_forall (GTK_CONTAINER (widget),
5028 gtk_widget_reparent_fixup_child,
5034 * gtk_widget_reparent:
5035 * @widget: a #GtkWidget
5036 * @new_parent: a #GtkContainer to move the widget into
5038 * Moves a widget from one #GtkContainer to another, handling reference
5039 * count issues to avoid destroying the widget.
5042 gtk_widget_reparent (GtkWidget *widget,
5043 GtkWidget *new_parent)
5045 g_return_if_fail (GTK_IS_WIDGET (widget));
5046 g_return_if_fail (GTK_IS_CONTAINER (new_parent));
5047 g_return_if_fail (widget->parent != NULL);
5049 if (widget->parent != new_parent)
5051 /* First try to see if we can get away without unrealizing
5052 * the widget as we reparent it. if so we set a flag so
5053 * that gtk_widget_unparent doesn't unrealize widget
5055 if (gtk_widget_get_realized (widget) && gtk_widget_get_realized (new_parent))
5056 GTK_PRIVATE_SET_FLAG (widget, GTK_IN_REPARENT);
5058 g_object_ref (widget);
5059 gtk_container_remove (GTK_CONTAINER (widget->parent), widget);
5060 gtk_container_add (GTK_CONTAINER (new_parent), widget);
5061 g_object_unref (widget);
5063 if (GTK_WIDGET_IN_REPARENT (widget))
5065 GTK_PRIVATE_UNSET_FLAG (widget, GTK_IN_REPARENT);
5067 gtk_widget_reparent_subwindows (widget, gtk_widget_get_parent_window (widget));
5068 gtk_widget_reparent_fixup_child (widget,
5069 gtk_widget_get_parent_window (widget));
5072 g_object_notify (G_OBJECT (widget), "parent");
5077 * gtk_widget_intersect:
5078 * @widget: a #GtkWidget
5079 * @area: a rectangle
5080 * @intersection: rectangle to store intersection of @widget and @area
5082 * Computes the intersection of a @widget's area and @area, storing
5083 * the intersection in @intersection, and returns %TRUE if there was
5084 * an intersection. @intersection may be %NULL if you're only
5085 * interested in whether there was an intersection.
5087 * Return value: %TRUE if there was an intersection
5090 gtk_widget_intersect (GtkWidget *widget,
5091 const GdkRectangle *area,
5092 GdkRectangle *intersection)
5098 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5099 g_return_val_if_fail (area != NULL, FALSE);
5102 dest = intersection;
5106 return_val = gdk_rectangle_intersect (&widget->allocation, area, dest);
5108 if (return_val && intersection && gtk_widget_get_has_window (widget))
5110 intersection->x -= widget->allocation.x;
5111 intersection->y -= widget->allocation.y;
5118 * gtk_widget_region_intersect:
5119 * @widget: a #GtkWidget
5120 * @region: a #GdkRegion, in the same coordinate system as
5121 * @widget->allocation. That is, relative to @widget->window
5122 * for %NO_WINDOW widgets; relative to the parent window
5123 * of @widget->window for widgets with their own window.
5124 * @returns: A newly allocated region holding the intersection of @widget
5125 * and @region. The coordinates of the return value are
5126 * relative to @widget->window for %NO_WINDOW widgets, and
5127 * relative to the parent window of @widget->window for
5128 * widgets with their own window.
5130 * Computes the intersection of a @widget's area and @region, returning
5131 * the intersection. The result may be empty, use gdk_region_empty() to
5135 gtk_widget_region_intersect (GtkWidget *widget,
5136 const GdkRegion *region)
5141 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5142 g_return_val_if_fail (region != NULL, NULL);
5144 gtk_widget_get_draw_rectangle (widget, &rect);
5146 dest = gdk_region_rectangle (&rect);
5148 gdk_region_intersect (dest, region);
5154 * _gtk_widget_grab_notify:
5155 * @widget: a #GtkWidget
5156 * @was_grabbed: whether a grab is now in effect
5158 * Emits the #GtkWidget::grab-notify signal on @widget.
5163 _gtk_widget_grab_notify (GtkWidget *widget,
5164 gboolean was_grabbed)
5166 g_signal_emit (widget, widget_signals[GRAB_NOTIFY], 0, was_grabbed);
5170 * gtk_widget_grab_focus:
5171 * @widget: a #GtkWidget
5173 * Causes @widget to have the keyboard focus for the #GtkWindow it's
5174 * inside. @widget must be a focusable widget, such as a #GtkEntry;
5175 * something like #GtkFrame won't work.
5177 * More precisely, it must have the %GTK_CAN_FOCUS flag set. Use
5178 * gtk_widget_set_can_focus() to modify that flag.
5181 gtk_widget_grab_focus (GtkWidget *widget)
5183 g_return_if_fail (GTK_IS_WIDGET (widget));
5185 if (!gtk_widget_is_sensitive (widget))
5188 g_object_ref (widget);
5189 g_signal_emit (widget, widget_signals[GRAB_FOCUS], 0);
5190 g_object_notify (G_OBJECT (widget), "has-focus");
5191 g_object_unref (widget);
5195 reset_focus_recurse (GtkWidget *widget,
5198 if (GTK_IS_CONTAINER (widget))
5200 GtkContainer *container;
5202 container = GTK_CONTAINER (widget);
5203 gtk_container_set_focus_child (container, NULL);
5205 gtk_container_foreach (container,
5206 reset_focus_recurse,
5212 gtk_widget_real_grab_focus (GtkWidget *focus_widget)
5214 if (gtk_widget_get_can_focus (focus_widget))
5216 GtkWidget *toplevel;
5219 /* clear the current focus setting, break if the current widget
5220 * is the focus widget's parent, since containers above that will
5221 * be set by the next loop.
5223 toplevel = gtk_widget_get_toplevel (focus_widget);
5224 if (gtk_widget_is_toplevel (toplevel) && GTK_IS_WINDOW (toplevel))
5226 widget = GTK_WINDOW (toplevel)->focus_widget;
5228 if (widget == focus_widget)
5230 /* We call _gtk_window_internal_set_focus() here so that the
5231 * toplevel window can request the focus if necessary.
5232 * This is needed when the toplevel is a GtkPlug
5234 if (!gtk_widget_has_focus (widget))
5235 _gtk_window_internal_set_focus (GTK_WINDOW (toplevel), focus_widget);
5242 while (widget->parent && widget->parent != focus_widget->parent)
5244 widget = widget->parent;
5245 gtk_container_set_focus_child (GTK_CONTAINER (widget), NULL);
5249 else if (toplevel != focus_widget)
5251 /* gtk_widget_grab_focus() operates on a tree without window...
5252 * actually, this is very questionable behaviour.
5255 gtk_container_foreach (GTK_CONTAINER (toplevel),
5256 reset_focus_recurse,
5260 /* now propagate the new focus up the widget tree and finally
5261 * set it on the window
5263 widget = focus_widget;
5264 while (widget->parent)
5266 gtk_container_set_focus_child (GTK_CONTAINER (widget->parent), widget);
5267 widget = widget->parent;
5269 if (GTK_IS_WINDOW (widget))
5270 _gtk_window_internal_set_focus (GTK_WINDOW (widget), focus_widget);
5275 gtk_widget_real_query_tooltip (GtkWidget *widget,
5278 gboolean keyboard_tip,
5279 GtkTooltip *tooltip)
5281 gchar *tooltip_markup;
5282 gboolean has_tooltip;
5284 tooltip_markup = g_object_get_qdata (G_OBJECT (widget), quark_tooltip_markup);
5285 has_tooltip = GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (widget), quark_has_tooltip));
5287 if (has_tooltip && tooltip_markup)
5289 gtk_tooltip_set_markup (tooltip, tooltip_markup);
5297 gtk_widget_real_show_help (GtkWidget *widget,
5298 GtkWidgetHelpType help_type)
5300 if (help_type == GTK_WIDGET_HELP_TOOLTIP)
5302 _gtk_tooltip_toggle_keyboard_mode (widget);
5311 gtk_widget_real_focus (GtkWidget *widget,
5312 GtkDirectionType direction)
5314 if (!gtk_widget_get_can_focus (widget))
5317 if (!gtk_widget_is_focus (widget))
5319 gtk_widget_grab_focus (widget);
5327 gtk_widget_real_move_focus (GtkWidget *widget,
5328 GtkDirectionType direction)
5330 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
5332 if (GTK_IS_WINDOW (toplevel) &&
5333 GTK_WINDOW_GET_CLASS (toplevel)->move_focus)
5335 GTK_WINDOW_GET_CLASS (toplevel)->move_focus (GTK_WINDOW (toplevel),
5341 gtk_widget_real_keynav_failed (GtkWidget *widget,
5342 GtkDirectionType direction)
5344 gboolean cursor_only;
5348 case GTK_DIR_TAB_FORWARD:
5349 case GTK_DIR_TAB_BACKWARD:
5356 g_object_get (gtk_widget_get_settings (widget),
5357 "gtk-keynav-cursor-only", &cursor_only,
5364 gtk_widget_error_bell (widget);
5370 * gtk_widget_set_can_focus:
5371 * @widget: a #GtkWidget
5372 * @can_focus: whether or not @widget can own the input focus.
5374 * Specifies whether @widget can own the input focus. See
5375 * gtk_widget_grab_focus() for actually setting the input focus on a
5381 gtk_widget_set_can_focus (GtkWidget *widget,
5384 g_return_if_fail (GTK_IS_WIDGET (widget));
5386 if (can_focus != gtk_widget_get_can_focus (widget))
5389 GTK_OBJECT_FLAGS (widget) |= GTK_CAN_FOCUS;
5391 GTK_OBJECT_FLAGS (widget) &= ~(GTK_CAN_FOCUS);
5393 gtk_widget_queue_resize (widget);
5394 g_object_notify (G_OBJECT (widget), "can-focus");
5399 * gtk_widget_get_can_focus:
5400 * @widget: a #GtkWidget
5402 * Determines whether @widget can own the input focus. See
5403 * gtk_widget_set_can_focus().
5405 * Return value: %TRUE if @widget can own the input focus, %FALSE otherwise
5410 gtk_widget_get_can_focus (GtkWidget *widget)
5412 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5414 return (GTK_OBJECT_FLAGS (widget) & GTK_CAN_FOCUS) != 0;
5418 * gtk_widget_has_focus:
5419 * @widget: a #GtkWidget
5421 * Determines if the widget has the global input focus. See
5422 * gtk_widget_is_focus() for the difference between having the global
5423 * input focus, and only having the focus within a toplevel.
5425 * Return value: %TRUE if the widget has the global input focus.
5430 gtk_widget_has_focus (GtkWidget *widget)
5432 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5434 return (GTK_OBJECT_FLAGS (widget) & GTK_HAS_FOCUS) != 0;
5438 * gtk_widget_is_focus:
5439 * @widget: a #GtkWidget
5441 * Determines if the widget is the focus widget within its
5442 * toplevel. (This does not mean that the %HAS_FOCUS flag is
5443 * necessarily set; %HAS_FOCUS will only be set if the
5444 * toplevel widget additionally has the global input focus.)
5446 * Return value: %TRUE if the widget is the focus widget.
5449 gtk_widget_is_focus (GtkWidget *widget)
5451 GtkWidget *toplevel;
5453 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5455 toplevel = gtk_widget_get_toplevel (widget);
5457 if (GTK_IS_WINDOW (toplevel))
5458 return widget == GTK_WINDOW (toplevel)->focus_widget;
5464 * gtk_widget_set_can_default:
5465 * @widget: a #GtkWidget
5466 * @can_default: whether or not @widget can be a default widget.
5468 * Specifies whether @widget can be a default widget. See
5469 * gtk_widget_grab_default() for details about the meaning of
5475 gtk_widget_set_can_default (GtkWidget *widget,
5476 gboolean can_default)
5478 g_return_if_fail (GTK_IS_WIDGET (widget));
5480 if (can_default != gtk_widget_get_can_default (widget))
5483 GTK_OBJECT_FLAGS (widget) |= GTK_CAN_DEFAULT;
5485 GTK_OBJECT_FLAGS (widget) &= ~(GTK_CAN_DEFAULT);
5487 gtk_widget_queue_resize (widget);
5488 g_object_notify (G_OBJECT (widget), "can-default");
5493 * gtk_widget_get_can_default:
5494 * @widget: a #GtkWidget
5496 * Determines whether @widget can be a default widget. See
5497 * gtk_widget_set_can_default().
5499 * Return value: %TRUE if @widget can be a default widget, %FALSE otherwise
5504 gtk_widget_get_can_default (GtkWidget *widget)
5506 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5508 return (GTK_OBJECT_FLAGS (widget) & GTK_CAN_DEFAULT) != 0;
5512 * gtk_widget_has_default:
5513 * @widget: a #GtkWidget
5515 * Determines whether @widget is the current default widget within its
5516 * toplevel. See gtk_widget_set_can_default().
5518 * Return value: %TRUE if @widget is the current default widget within
5519 * its toplevel, %FALSE otherwise
5524 gtk_widget_has_default (GtkWidget *widget)
5526 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5528 return (GTK_OBJECT_FLAGS (widget) & GTK_HAS_DEFAULT) != 0;
5532 _gtk_widget_set_has_default (GtkWidget *widget,
5533 gboolean has_default)
5536 GTK_OBJECT_FLAGS (widget) |= GTK_HAS_DEFAULT;
5538 GTK_OBJECT_FLAGS (widget) &= ~(GTK_HAS_DEFAULT);
5542 * gtk_widget_grab_default:
5543 * @widget: a #GtkWidget
5545 * Causes @widget to become the default widget. @widget must have the
5546 * %GTK_CAN_DEFAULT flag set; typically you have to set this flag
5547 * yourself by calling <literal>gtk_widget_set_can_default (@widget,
5548 * %TRUE)</literal>. The default widget is activated when
5549 * the user presses Enter in a window. Default widgets must be
5550 * activatable, that is, gtk_widget_activate() should affect them.
5553 gtk_widget_grab_default (GtkWidget *widget)
5557 g_return_if_fail (GTK_IS_WIDGET (widget));
5558 g_return_if_fail (gtk_widget_get_can_default (widget));
5560 window = gtk_widget_get_toplevel (widget);
5562 if (window && gtk_widget_is_toplevel (window))
5563 gtk_window_set_default (GTK_WINDOW (window), widget);
5565 g_warning (G_STRLOC ": widget not within a GtkWindow");
5569 * gtk_widget_set_receives_default:
5570 * @widget: a #GtkWidget
5571 * @receives_default: whether or not @widget can be a default widget.
5573 * Specifies whether @widget will be treated as the default widget
5574 * within its toplevel when it has the focus, even if another widget
5577 * See gtk_widget_grab_default() for details about the meaning of
5583 gtk_widget_set_receives_default (GtkWidget *widget,
5584 gboolean receives_default)
5586 g_return_if_fail (GTK_IS_WIDGET (widget));
5588 if (receives_default != gtk_widget_get_receives_default (widget))
5590 if (receives_default)
5591 GTK_OBJECT_FLAGS (widget) |= GTK_RECEIVES_DEFAULT;
5593 GTK_OBJECT_FLAGS (widget) &= ~(GTK_RECEIVES_DEFAULT);
5595 g_object_notify (G_OBJECT (widget), "receives-default");
5600 * gtk_widget_get_receives_default:
5601 * @widget: a #GtkWidget
5603 * Determines whether @widget is alyways treated as default widget
5604 * withing its toplevel when it has the focus, even if another widget
5607 * See gtk_widget_set_receives_default().
5609 * Return value: %TRUE if @widget acts as default widget when focussed,
5615 gtk_widget_get_receives_default (GtkWidget *widget)
5617 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5619 return (GTK_OBJECT_FLAGS (widget) & GTK_RECEIVES_DEFAULT) != 0;
5623 * gtk_widget_has_grab:
5624 * @widget: a #GtkWidget
5626 * Determines whether the widget is currently grabbing events, so it
5627 * is the only widget receiving input events (keyboard and mouse).
5629 * See also gtk_grab_add().
5631 * Return value: %TRUE if the widget is in the grab_widgets stack
5636 gtk_widget_has_grab (GtkWidget *widget)
5638 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5640 return (GTK_OBJECT_FLAGS (widget) & GTK_HAS_GRAB) != 0;
5644 _gtk_widget_set_has_grab (GtkWidget *widget,
5648 GTK_OBJECT_FLAGS (widget) |= GTK_HAS_GRAB;
5650 GTK_OBJECT_FLAGS (widget) &= ~(GTK_HAS_GRAB);
5654 * gtk_widget_set_name:
5655 * @widget: a #GtkWidget
5656 * @name: name for the widget
5658 * Widgets can be named, which allows you to refer to them from a
5659 * gtkrc file. You can apply a style to widgets with a particular name
5660 * in the gtkrc file. See the documentation for gtkrc files (on the
5661 * same page as the docs for #GtkRcStyle).
5663 * Note that widget names are separated by periods in paths (see
5664 * gtk_widget_path()), so names with embedded periods may cause confusion.
5667 gtk_widget_set_name (GtkWidget *widget,
5672 g_return_if_fail (GTK_IS_WIDGET (widget));
5674 new_name = g_strdup (name);
5675 g_free (widget->name);
5676 widget->name = new_name;
5678 if (gtk_widget_has_rc_style (widget))
5679 gtk_widget_reset_rc_style (widget);
5681 g_object_notify (G_OBJECT (widget), "name");
5685 * gtk_widget_get_name:
5686 * @widget: a #GtkWidget
5688 * Retrieves the name of a widget. See gtk_widget_set_name() for the
5689 * significance of widget names.
5691 * Return value: name of the widget. This string is owned by GTK+ and
5692 * should not be modified or freed
5694 G_CONST_RETURN gchar*
5695 gtk_widget_get_name (GtkWidget *widget)
5697 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5700 return widget->name;
5701 return G_OBJECT_TYPE_NAME (widget);
5705 * gtk_widget_set_state:
5706 * @widget: a #GtkWidget
5707 * @state: new state for @widget
5709 * This function is for use in widget implementations. Sets the state
5710 * of a widget (insensitive, prelighted, etc.) Usually you should set
5711 * the state using wrapper functions such as gtk_widget_set_sensitive().
5714 gtk_widget_set_state (GtkWidget *widget,
5717 g_return_if_fail (GTK_IS_WIDGET (widget));
5719 if (state == gtk_widget_get_state (widget))
5722 if (state == GTK_STATE_INSENSITIVE)
5723 gtk_widget_set_sensitive (widget, FALSE);
5729 data.state_restoration = FALSE;
5730 data.use_forall = FALSE;
5732 data.parent_sensitive = (gtk_widget_is_sensitive (widget->parent) != FALSE);
5734 data.parent_sensitive = TRUE;
5736 gtk_widget_propagate_state (widget, &data);
5738 if (gtk_widget_is_drawable (widget))
5739 gtk_widget_queue_draw (widget);
5744 * gtk_widget_get_state:
5745 * @widget: a #GtkWidget
5747 * Returns the widget's state. See gtk_widget_set_state().
5749 * Returns: the state of @widget.
5754 gtk_widget_get_state (GtkWidget *widget)
5756 g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_STATE_NORMAL);
5758 return widget->state;
5762 * gtk_widget_set_visible:
5763 * @widget: a #GtkWidget
5764 * @visible: whether the widget should be shown or not
5766 * Sets the visibility state of @widget. Note that setting this to
5767 * %TRUE doesn't mean the widget is actually viewable, see
5768 * gtk_widget_get_visible().
5770 * This function simply calls gtk_widget_show() or gtk_widget_hide()
5771 * but is nicer to use when the visibility of the widget depends on
5777 gtk_widget_set_visible (GtkWidget *widget,
5780 g_return_if_fail (GTK_IS_WIDGET (widget));
5782 if (visible != gtk_widget_get_visible (widget))
5785 gtk_widget_show (widget);
5787 gtk_widget_hide (widget);
5792 * gtk_widget_get_visible:
5793 * @widget: a #GtkWidget
5795 * Determines whether the widget is visible. Note that this doesn't
5796 * take into account whether the widget's parent is also visible
5797 * or the widget is obscured in any way.
5799 * See gtk_widget_set_visible().
5801 * Return value: %TRUE if the widget is visible
5806 gtk_widget_get_visible (GtkWidget *widget)
5808 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5810 return (GTK_OBJECT_FLAGS (widget) & GTK_VISIBLE) != 0;
5814 * gtk_widget_set_has_window:
5815 * @widget: a #GtkWidget
5816 * @has_window: whether or not @widget has a window.
5818 * Specifies whether @widget has a #GdkWindow of its own. Note that
5819 * all realized widgets have a non-%NULL "window" pointer
5820 * (gtk_widget_get_window() never returns a %NULL window when a widget
5821 * is realized), but for many of them it's actually the #GdkWindow of
5822 * one of its parent widgets. Widgets that create a %window for
5823 * themselves in GtkWidget::realize() however must announce this by
5824 * calling this function with @has_window = %TRUE.
5826 * This function should only be called by widget implementations,
5827 * and they should call it in their init() function.
5832 gtk_widget_set_has_window (GtkWidget *widget,
5833 gboolean has_window)
5835 g_return_if_fail (GTK_IS_WIDGET (widget));
5838 GTK_OBJECT_FLAGS (widget) &= ~(GTK_NO_WINDOW);
5840 GTK_OBJECT_FLAGS (widget) |= GTK_NO_WINDOW;
5844 * gtk_widget_get_has_window:
5845 * @widget: a #GtkWidget
5847 * Determines whether @widget has a #GdkWindow of its own. See
5848 * gtk_widget_set_has_window().
5850 * Return value: %TRUE if @widget has a window, %FALSE otherwise
5855 gtk_widget_get_has_window (GtkWidget *widget)
5857 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5859 return !((GTK_OBJECT_FLAGS (widget) & GTK_NO_WINDOW) != 0);
5863 * gtk_widget_is_toplevel:
5864 * @widget: a #GtkWidget
5866 * Determines whether @widget is a toplevel widget. Currently only
5867 * #GtkWindow and #GtkInvisible are toplevel widgets. Toplevel
5868 * widgets have no parent widget.
5870 * Return value: %TRUE if @widget is a toplevel, %FALSE otherwise
5875 gtk_widget_is_toplevel (GtkWidget *widget)
5877 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5879 return (GTK_OBJECT_FLAGS (widget) & GTK_TOPLEVEL) != 0;
5883 _gtk_widget_set_is_toplevel (GtkWidget *widget,
5884 gboolean is_toplevel)
5887 GTK_OBJECT_FLAGS (widget) |= GTK_TOPLEVEL;
5889 GTK_OBJECT_FLAGS (widget) &= ~(GTK_TOPLEVEL);
5893 * gtk_widget_is_drawable:
5894 * @widget: a #GtkWidget
5896 * Determines whether @widget can be drawn to. A widget can be drawn
5897 * to if it is mapped and visible.
5899 * Return value: %TRUE if @widget is drawable, %FALSE otherwise
5904 gtk_widget_is_drawable (GtkWidget *widget)
5906 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5908 return (gtk_widget_get_visible (widget) &&
5909 gtk_widget_get_mapped (widget));
5913 * gtk_widget_get_realized:
5914 * @widget: a #GtkWidget
5916 * Determines whether @widget is realized.
5918 * Return value: %TRUE if @widget is realized, %FALSE otherwise
5923 gtk_widget_get_realized (GtkWidget *widget)
5925 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5927 return (GTK_OBJECT_FLAGS (widget) & GTK_REALIZED) != 0;
5931 * gtk_widget_set_realized:
5932 * @widget: a #GtkWidget
5933 * @realized: %TRUE to mark the widget as realized
5935 * Marks the widget as being realized.
5937 * This function should only ever be called in a derived widget's
5938 * "realize" or "unrealize" implementation.
5943 gtk_widget_set_realized (GtkWidget *widget,
5946 g_return_if_fail (GTK_IS_WIDGET (widget));
5949 GTK_OBJECT_FLAGS (widget) |= GTK_REALIZED;
5951 GTK_OBJECT_FLAGS (widget) &= ~(GTK_REALIZED);
5955 * gtk_widget_get_mapped:
5956 * @widget: a #GtkWidget
5958 * Whether the widget is mapped.
5960 * Return value: %TRUE if the widget is mapped, %FALSE otherwise.
5965 gtk_widget_get_mapped (GtkWidget *widget)
5967 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5969 return (GTK_OBJECT_FLAGS (widget) & GTK_MAPPED) != 0;
5973 * gtk_widget_set_mapped:
5974 * @widget: a #GtkWidget
5975 * @mapped: %TRUE to mark the widget as mapped
5977 * Marks the widget as being realized.
5979 * This function should only ever be called in a derived widget's
5980 * "map" or "unmap" implementation.
5985 gtk_widget_set_mapped (GtkWidget *widget,
5988 g_return_if_fail (GTK_IS_WIDGET (widget));
5991 GTK_OBJECT_FLAGS (widget) |= GTK_MAPPED;
5993 GTK_OBJECT_FLAGS (widget) &= ~(GTK_MAPPED);
5997 * gtk_widget_set_app_paintable:
5998 * @widget: a #GtkWidget
5999 * @app_paintable: %TRUE if the application will paint on the widget
6001 * Sets whether the application intends to draw on the widget in
6002 * an #GtkWidget::expose-event handler.
6004 * This is a hint to the widget and does not affect the behavior of
6005 * the GTK+ core; many widgets ignore this flag entirely. For widgets
6006 * that do pay attention to the flag, such as #GtkEventBox and #GtkWindow,
6007 * the effect is to suppress default themed drawing of the widget's
6008 * background. (Children of the widget will still be drawn.) The application
6009 * is then entirely responsible for drawing the widget background.
6011 * Note that the background is still drawn when the widget is mapped.
6012 * If this is not suitable (e.g. because you want to make a transparent
6013 * window using an RGBA visual), you can work around this by doing:
6015 * gtk_widget_realize (window);
6016 * gdk_window_set_back_pixmap (window->window, NULL, FALSE);
6017 * gtk_widget_show (window);
6021 gtk_widget_set_app_paintable (GtkWidget *widget,
6022 gboolean app_paintable)
6024 g_return_if_fail (GTK_IS_WIDGET (widget));
6026 app_paintable = (app_paintable != FALSE);
6028 if (gtk_widget_get_app_paintable (widget) != app_paintable)
6031 GTK_OBJECT_FLAGS (widget) |= GTK_APP_PAINTABLE;
6033 GTK_OBJECT_FLAGS (widget) &= ~(GTK_APP_PAINTABLE);
6035 if (gtk_widget_is_drawable (widget))
6036 gtk_widget_queue_draw (widget);
6038 g_object_notify (G_OBJECT (widget), "app-paintable");
6043 * gtk_widget_get_app_paintable:
6044 * @widget: a #GtkWidget
6046 * Determines whether the application intends to draw on the widget in
6047 * an #GtkWidget::expose-event handler.
6049 * See gtk_widget_set_app_paintable()
6051 * Return value: %TRUE if the widget is app paintable
6056 gtk_widget_get_app_paintable (GtkWidget *widget)
6058 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6060 return (GTK_OBJECT_FLAGS (widget) & GTK_APP_PAINTABLE) != 0;
6064 * gtk_widget_set_double_buffered:
6065 * @widget: a #GtkWidget
6066 * @double_buffered: %TRUE to double-buffer a widget
6068 * Widgets are double buffered by default; you can use this function
6069 * to turn off the buffering. "Double buffered" simply means that
6070 * gdk_window_begin_paint_region() and gdk_window_end_paint() are called
6071 * automatically around expose events sent to the
6072 * widget. gdk_window_begin_paint() diverts all drawing to a widget's
6073 * window to an offscreen buffer, and gdk_window_end_paint() draws the
6074 * buffer to the screen. The result is that users see the window
6075 * update in one smooth step, and don't see individual graphics
6076 * primitives being rendered.
6078 * In very simple terms, double buffered widgets don't flicker,
6079 * so you would only use this function to turn off double buffering
6080 * if you had special needs and really knew what you were doing.
6082 * Note: if you turn off double-buffering, you have to handle
6083 * expose events, since even the clearing to the background color or
6084 * pixmap will not happen automatically (as it is done in
6085 * gdk_window_begin_paint()).
6088 gtk_widget_set_double_buffered (GtkWidget *widget,
6089 gboolean double_buffered)
6091 g_return_if_fail (GTK_IS_WIDGET (widget));
6093 double_buffered = (double_buffered != FALSE);
6095 if (double_buffered != gtk_widget_get_double_buffered (widget))
6097 if (double_buffered)
6098 GTK_OBJECT_FLAGS (widget) |= GTK_DOUBLE_BUFFERED;
6100 GTK_OBJECT_FLAGS (widget) &= ~(GTK_DOUBLE_BUFFERED);
6102 g_object_notify (G_OBJECT (widget), "double-buffered");
6107 * gtk_widget_get_double_buffered:
6108 * @widget: a #GtkWidget
6110 * Determines whether the widget is double buffered.
6112 * See gtk_widget_set_double_buffered()
6114 * Return value: %TRUE if the widget is double buffered
6119 gtk_widget_get_double_buffered (GtkWidget *widget)
6121 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6123 return (GTK_OBJECT_FLAGS (widget) & GTK_DOUBLE_BUFFERED) != 0;
6127 * gtk_widget_set_redraw_on_allocate:
6128 * @widget: a #GtkWidget
6129 * @redraw_on_allocate: if %TRUE, the entire widget will be redrawn
6130 * when it is allocated to a new size. Otherwise, only the
6131 * new portion of the widget will be redrawn.
6133 * Sets whether the entire widget is queued for drawing when its size
6134 * allocation changes. By default, this setting is %TRUE and
6135 * the entire widget is redrawn on every size change. If your widget
6136 * leaves the upper left unchanged when made bigger, turning this
6137 * setting off will improve performance.
6139 * Note that for %NO_WINDOW widgets setting this flag to %FALSE turns
6140 * off all allocation on resizing: the widget will not even redraw if
6141 * its position changes; this is to allow containers that don't draw
6142 * anything to avoid excess invalidations. If you set this flag on a
6143 * %NO_WINDOW widget that <emphasis>does</emphasis> draw on @widget->window,
6144 * you are responsible for invalidating both the old and new allocation
6145 * of the widget when the widget is moved and responsible for invalidating
6146 * regions newly when the widget increases size.
6149 gtk_widget_set_redraw_on_allocate (GtkWidget *widget,
6150 gboolean redraw_on_allocate)
6152 g_return_if_fail (GTK_IS_WIDGET (widget));
6154 if (redraw_on_allocate)
6155 GTK_PRIVATE_SET_FLAG (widget, GTK_REDRAW_ON_ALLOC);
6157 GTK_PRIVATE_UNSET_FLAG (widget, GTK_REDRAW_ON_ALLOC);
6161 * gtk_widget_set_sensitive:
6162 * @widget: a #GtkWidget
6163 * @sensitive: %TRUE to make the widget sensitive
6165 * Sets the sensitivity of a widget. A widget is sensitive if the user
6166 * can interact with it. Insensitive widgets are "grayed out" and the
6167 * user can't interact with them. Insensitive widgets are known as
6168 * "inactive", "disabled", or "ghosted" in some other toolkits.
6171 gtk_widget_set_sensitive (GtkWidget *widget,
6176 g_return_if_fail (GTK_IS_WIDGET (widget));
6178 sensitive = (sensitive != FALSE);
6180 if (sensitive == (gtk_widget_get_sensitive (widget) != FALSE))
6185 GTK_OBJECT_FLAGS (widget) |= GTK_SENSITIVE;
6186 data.state = widget->saved_state;
6190 GTK_OBJECT_FLAGS (widget) &= ~(GTK_SENSITIVE);
6191 data.state = gtk_widget_get_state (widget);
6193 data.state_restoration = TRUE;
6194 data.use_forall = TRUE;
6197 data.parent_sensitive = (gtk_widget_is_sensitive (widget->parent) != FALSE);
6199 data.parent_sensitive = TRUE;
6201 gtk_widget_propagate_state (widget, &data);
6202 if (gtk_widget_is_drawable (widget))
6203 gtk_widget_queue_draw (widget);
6205 g_object_notify (G_OBJECT (widget), "sensitive");
6209 * gtk_widget_get_sensitive:
6210 * @widget: a #GtkWidget
6212 * Returns the widget's sensitivity (in the sense of returning
6213 * the value that has been set using gtk_widget_set_sensitive()).
6215 * The effective sensitivity of a widget is however determined by both its
6216 * own and its parent widget's sensitivity. See gtk_widget_is_sensitive().
6218 * Returns: %TRUE if the widget is sensitive
6223 gtk_widget_get_sensitive (GtkWidget *widget)
6225 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6227 return (GTK_OBJECT_FLAGS (widget) & GTK_SENSITIVE) != 0;
6231 * gtk_widget_is_sensitive:
6232 * @widget: a #GtkWidget
6234 * Returns the widget's effective sensitivity, which means
6235 * it is sensitive itself and also its parent widget is sensntive
6237 * Returns: %TRUE if the widget is effectively sensitive
6242 gtk_widget_is_sensitive (GtkWidget *widget)
6244 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6246 return (gtk_widget_get_sensitive (widget) &&
6247 (GTK_OBJECT_FLAGS (widget) & GTK_PARENT_SENSITIVE) != 0);
6251 * gtk_widget_set_parent:
6252 * @widget: a #GtkWidget
6253 * @parent: parent container
6255 * This function is useful only when implementing subclasses of
6257 * Sets the container as the parent of @widget, and takes care of
6258 * some details such as updating the state and style of the child
6259 * to reflect its new location. The opposite function is
6260 * gtk_widget_unparent().
6263 gtk_widget_set_parent (GtkWidget *widget,
6268 g_return_if_fail (GTK_IS_WIDGET (widget));
6269 g_return_if_fail (GTK_IS_WIDGET (parent));
6270 g_return_if_fail (widget != parent);
6271 if (widget->parent != NULL)
6273 g_warning ("Can't set a parent on widget which has a parent\n");
6276 if (gtk_widget_is_toplevel (widget))
6278 g_warning ("Can't set a parent on a toplevel widget\n");
6282 /* keep this function in sync with gtk_menu_attach_to_widget()
6285 g_object_ref_sink (widget);
6286 widget->parent = parent;
6288 if (gtk_widget_get_state (parent) != GTK_STATE_NORMAL)
6289 data.state = gtk_widget_get_state (parent);
6291 data.state = gtk_widget_get_state (widget);
6292 data.state_restoration = FALSE;
6293 data.parent_sensitive = (gtk_widget_is_sensitive (parent) != FALSE);
6294 data.use_forall = gtk_widget_is_sensitive (parent) != gtk_widget_is_sensitive (widget);
6296 gtk_widget_propagate_state (widget, &data);
6298 gtk_widget_reset_rc_styles (widget);
6300 g_signal_emit (widget, widget_signals[PARENT_SET], 0, NULL);
6301 if (GTK_WIDGET_ANCHORED (widget->parent))
6302 _gtk_widget_propagate_hierarchy_changed (widget, NULL);
6303 g_object_notify (G_OBJECT (widget), "parent");
6305 /* Enforce realized/mapped invariants
6307 if (gtk_widget_get_realized (widget->parent))
6308 gtk_widget_realize (widget);
6310 if (gtk_widget_get_visible (widget->parent) &&
6311 gtk_widget_get_visible (widget))
6313 if (GTK_WIDGET_CHILD_VISIBLE (widget) &&
6314 gtk_widget_get_mapped (widget->parent))
6315 gtk_widget_map (widget);
6317 gtk_widget_queue_resize (widget);
6322 * gtk_widget_get_parent:
6323 * @widget: a #GtkWidget
6325 * Returns the parent container of @widget.
6327 * Return value: (transfer none): the parent container of @widget, or %NULL
6330 gtk_widget_get_parent (GtkWidget *widget)
6332 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6334 return widget->parent;
6337 /*****************************************
6339 * see docs/styles.txt
6340 *****************************************/
6343 * gtk_widget_style_attach:
6344 * @widget: a #GtkWidget
6346 * This function attaches the widget's #GtkStyle to the widget's
6347 * #GdkWindow. It is a replacement for
6350 * widget->style = gtk_style_attach (widget->style, widget->window);
6353 * and should only ever be called in a derived widget's "realize"
6354 * implementation which does not chain up to its parent class'
6355 * "realize" implementation, because one of the parent classes
6356 * (finally #GtkWidget) would attach the style itself.
6361 gtk_widget_style_attach (GtkWidget *widget)
6363 g_return_if_fail (GTK_IS_WIDGET (widget));
6364 g_return_if_fail (gtk_widget_get_realized (widget));
6366 widget->style = gtk_style_attach (widget->style, widget->window);
6370 * gtk_widget_has_rc_style:
6371 * @widget: a #GtkWidget
6373 * Determines if the widget style has been looked up through the rc mechanism.
6375 * Returns: %TRUE if the widget has been looked up through the rc
6376 * mechanism, %FALSE otherwise.
6381 gtk_widget_has_rc_style (GtkWidget *widget)
6383 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6385 return (GTK_OBJECT_FLAGS (widget) & GTK_RC_STYLE) != 0;
6389 * gtk_widget_set_style:
6390 * @widget: a #GtkWidget
6391 * @style: (allow-none): a #GtkStyle, or %NULL to remove the effect of a previous
6392 * gtk_widget_set_style() and go back to the default style
6394 * Sets the #GtkStyle for a widget (@widget->style). You probably don't
6395 * want to use this function; it interacts badly with themes, because
6396 * themes work by replacing the #GtkStyle. Instead, use
6397 * gtk_widget_modify_style().
6400 gtk_widget_set_style (GtkWidget *widget,
6403 g_return_if_fail (GTK_IS_WIDGET (widget));
6407 gboolean initial_emission;
6409 initial_emission = !gtk_widget_has_rc_style (widget) && !GTK_WIDGET_USER_STYLE (widget);
6411 GTK_OBJECT_FLAGS (widget) &= ~(GTK_RC_STYLE);
6412 GTK_PRIVATE_SET_FLAG (widget, GTK_USER_STYLE);
6414 gtk_widget_set_style_internal (widget, style, initial_emission);
6418 if (GTK_WIDGET_USER_STYLE (widget))
6419 gtk_widget_reset_rc_style (widget);
6424 * gtk_widget_ensure_style:
6425 * @widget: a #GtkWidget
6427 * Ensures that @widget has a style (@widget->style). Not a very useful
6428 * function; most of the time, if you want the style, the widget is
6429 * realized, and realized widgets are guaranteed to have a style
6433 gtk_widget_ensure_style (GtkWidget *widget)
6435 g_return_if_fail (GTK_IS_WIDGET (widget));
6437 if (!GTK_WIDGET_USER_STYLE (widget) &&
6438 !gtk_widget_has_rc_style (widget))
6439 gtk_widget_reset_rc_style (widget);
6442 /* Look up the RC style for this widget, unsetting any user style that
6443 * may be in effect currently
6446 gtk_widget_reset_rc_style (GtkWidget *widget)
6448 GtkStyle *new_style = NULL;
6449 gboolean initial_emission;
6451 initial_emission = !gtk_widget_has_rc_style (widget) && !GTK_WIDGET_USER_STYLE (widget);
6453 GTK_PRIVATE_UNSET_FLAG (widget, GTK_USER_STYLE);
6454 GTK_OBJECT_FLAGS (widget) |= GTK_RC_STYLE;
6456 if (gtk_widget_has_screen (widget))
6457 new_style = gtk_rc_get_style (widget);
6459 new_style = gtk_widget_get_default_style ();
6461 if (initial_emission || new_style != widget->style)
6462 gtk_widget_set_style_internal (widget, new_style, initial_emission);
6466 * gtk_widget_get_style:
6467 * @widget: a #GtkWidget
6469 * Simply an accessor function that returns @widget->style.
6471 * Return value: (transfer none): the widget's #GtkStyle
6474 gtk_widget_get_style (GtkWidget *widget)
6476 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6478 return widget->style;
6482 * gtk_widget_modify_style:
6483 * @widget: a #GtkWidget
6484 * @style: the #GtkRcStyle holding the style modifications
6486 * Modifies style values on the widget. Modifications made using this
6487 * technique take precedence over style values set via an RC file,
6488 * however, they will be overriden if a style is explicitely set on
6489 * the widget using gtk_widget_set_style(). The #GtkRcStyle structure
6490 * is designed so each field can either be set or unset, so it is
6491 * possible, using this function, to modify some style values and
6492 * leave the others unchanged.
6494 * Note that modifications made with this function are not cumulative
6495 * with previous calls to gtk_widget_modify_style() or with such
6496 * functions as gtk_widget_modify_fg(). If you wish to retain
6497 * previous values, you must first call gtk_widget_get_modifier_style(),
6498 * make your modifications to the returned style, then call
6499 * gtk_widget_modify_style() with that style. On the other hand,
6500 * if you first call gtk_widget_modify_style(), subsequent calls
6501 * to such functions gtk_widget_modify_fg() will have a cumulative
6502 * effect with the initial modifications.
6505 gtk_widget_modify_style (GtkWidget *widget,
6508 g_return_if_fail (GTK_IS_WIDGET (widget));
6509 g_return_if_fail (GTK_IS_RC_STYLE (style));
6511 g_object_set_qdata_full (G_OBJECT (widget),
6513 gtk_rc_style_copy (style),
6514 (GDestroyNotify) g_object_unref);
6516 /* note that "style" may be invalid here if it was the old
6517 * modifier style and the only reference was our own.
6520 if (gtk_widget_has_rc_style (widget))
6521 gtk_widget_reset_rc_style (widget);
6525 * gtk_widget_get_modifier_style:
6526 * @widget: a #GtkWidget
6528 * Returns the current modifier style for the widget. (As set by
6529 * gtk_widget_modify_style().) If no style has previously set, a new
6530 * #GtkRcStyle will be created with all values unset, and set as the
6531 * modifier style for the widget. If you make changes to this rc
6532 * style, you must call gtk_widget_modify_style(), passing in the
6533 * returned rc style, to make sure that your changes take effect.
6535 * Caution: passing the style back to gtk_widget_modify_style() will
6536 * normally end up destroying it, because gtk_widget_modify_style() copies
6537 * the passed-in style and sets the copy as the new modifier style,
6538 * thus dropping any reference to the old modifier style. Add a reference
6539 * to the modifier style if you want to keep it alive.
6541 * Return value: (transfer none): the modifier style for the widget. This rc style is
6542 * owned by the widget. If you want to keep a pointer to value this
6543 * around, you must add a refcount using g_object_ref().
6546 gtk_widget_get_modifier_style (GtkWidget *widget)
6548 GtkRcStyle *rc_style;
6550 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6552 rc_style = g_object_get_qdata (G_OBJECT (widget), quark_rc_style);
6556 rc_style = gtk_rc_style_new ();
6557 g_object_set_qdata_full (G_OBJECT (widget),
6560 (GDestroyNotify) g_object_unref);
6567 gtk_widget_modify_color_component (GtkWidget *widget,
6568 GtkRcFlags component,
6570 const GdkColor *color)
6572 GtkRcStyle *rc_style = gtk_widget_get_modifier_style (widget);
6579 rc_style->fg[state] = *color;
6582 rc_style->bg[state] = *color;
6585 rc_style->text[state] = *color;
6588 rc_style->base[state] = *color;
6591 g_assert_not_reached();
6594 rc_style->color_flags[state] |= component;
6597 rc_style->color_flags[state] &= ~component;
6599 gtk_widget_modify_style (widget, rc_style);
6603 * gtk_widget_modify_symbolic_color:
6604 * @widget: a #GtkWidget
6605 * @name: the name of the symbolic color to modify
6606 * @color: (allow-none): the color to assign (does not need to be allocated),
6607 * or %NULL to undo the effect of previous calls to
6608 * of gtk_widget_modify_symbolic_color().
6610 * Sets a symbolic color for a widget.
6611 * All other style values are left untouched. See also
6612 * gtk_widget_modify_style().
6617 gtk_widget_modify_symbolic_color (GtkWidget *widget,
6619 const GdkColor *color)
6621 GtkRcStyle *rc_style = gtk_widget_get_modifier_style (widget);
6623 _gtk_rc_style_set_symbolic_color (rc_style, name, color);
6625 gtk_widget_modify_style (widget, rc_style);
6629 * gtk_widget_modify_fg:
6630 * @widget: a #GtkWidget
6631 * @state: the state for which to set the foreground color
6632 * @color: (allow-none): the color to assign (does not need to be allocated),
6633 * or %NULL to undo the effect of previous calls to
6634 * of gtk_widget_modify_fg().
6636 * Sets the foreground color for a widget in a particular state.
6637 * All other style values are left untouched. See also
6638 * gtk_widget_modify_style().
6641 gtk_widget_modify_fg (GtkWidget *widget,
6643 const GdkColor *color)
6645 g_return_if_fail (GTK_IS_WIDGET (widget));
6646 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
6648 gtk_widget_modify_color_component (widget, GTK_RC_FG, state, color);
6652 * gtk_widget_modify_bg:
6653 * @widget: a #GtkWidget
6654 * @state: the state for which to set the background color
6655 * @color: (allow-none): the color to assign (does not need to be allocated),
6656 * or %NULL to undo the effect of previous calls to
6657 * of gtk_widget_modify_bg().
6659 * Sets the background color for a widget in a particular state.
6660 * All other style values are left untouched. See also
6661 * gtk_widget_modify_style().
6663 * Note that "no window" widgets (which have the %GTK_NO_WINDOW flag set)
6664 * draw on their parent container's window and thus may not draw any
6665 * background themselves. This is the case for e.g. #GtkLabel. To modify
6666 * the background of such widgets, you have to set the background color
6667 * on their parent; if you want to set the background of a rectangular
6668 * area around a label, try placing the label in a #GtkEventBox widget
6669 * and setting the background color on that.
6672 gtk_widget_modify_bg (GtkWidget *widget,
6674 const GdkColor *color)
6676 g_return_if_fail (GTK_IS_WIDGET (widget));
6677 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
6679 gtk_widget_modify_color_component (widget, GTK_RC_BG, state, color);
6683 * gtk_widget_modify_text:
6684 * @widget: a #GtkWidget
6685 * @state: the state for which to set the text color
6686 * @color: (allow-none): the color to assign (does not need to be allocated),
6687 * or %NULL to undo the effect of previous calls to
6688 * of gtk_widget_modify_text().
6690 * Sets the text color for a widget in a particular state. All other
6691 * style values are left untouched. The text color is the foreground
6692 * color used along with the base color (see gtk_widget_modify_base())
6693 * for widgets such as #GtkEntry and #GtkTextView. See also
6694 * gtk_widget_modify_style().
6697 gtk_widget_modify_text (GtkWidget *widget,
6699 const GdkColor *color)
6701 g_return_if_fail (GTK_IS_WIDGET (widget));
6702 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
6704 gtk_widget_modify_color_component (widget, GTK_RC_TEXT, state, color);
6708 * gtk_widget_modify_base:
6709 * @widget: a #GtkWidget
6710 * @state: the state for which to set the base color
6711 * @color: (allow-none): the color to assign (does not need to be allocated),
6712 * or %NULL to undo the effect of previous calls to
6713 * of gtk_widget_modify_base().
6715 * Sets the base color for a widget in a particular state.
6716 * All other style values are left untouched. The base color
6717 * is the background color used along with the text color
6718 * (see gtk_widget_modify_text()) for widgets such as #GtkEntry
6719 * and #GtkTextView. See also gtk_widget_modify_style().
6721 * Note that "no window" widgets (which have the %GTK_NO_WINDOW flag set)
6722 * draw on their parent container's window and thus may not draw any
6723 * background themselves. This is the case for e.g. #GtkLabel. To modify
6724 * the background of such widgets, you have to set the base color on their
6725 * parent; if you want to set the background of a rectangular area around
6726 * a label, try placing the label in a #GtkEventBox widget and setting
6727 * the base color on that.
6730 gtk_widget_modify_base (GtkWidget *widget,
6732 const GdkColor *color)
6734 g_return_if_fail (GTK_IS_WIDGET (widget));
6735 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
6737 gtk_widget_modify_color_component (widget, GTK_RC_BASE, state, color);
6741 modify_color_property (GtkWidget *widget,
6742 GtkRcStyle *rc_style,
6744 const GdkColor *color)
6746 GQuark type_name = g_type_qname (G_OBJECT_TYPE (widget));
6747 GQuark property_name = g_quark_from_string (name);
6751 GtkRcProperty rc_property = {0};
6754 rc_property.type_name = type_name;
6755 rc_property.property_name = property_name;
6756 rc_property.origin = NULL;
6758 color_name = gdk_color_to_string (color);
6759 g_value_init (&rc_property.value, G_TYPE_STRING);
6760 g_value_take_string (&rc_property.value, color_name);
6762 _gtk_rc_style_set_rc_property (rc_style, &rc_property);
6764 g_value_unset (&rc_property.value);
6767 _gtk_rc_style_unset_rc_property (rc_style, type_name, property_name);
6771 * gtk_widget_modify_cursor:
6772 * @widget: a #GtkWidget
6773 * @primary: the color to use for primary cursor (does not need to be
6774 * allocated), or %NULL to undo the effect of previous calls to
6775 * of gtk_widget_modify_cursor().
6776 * @secondary: the color to use for secondary cursor (does not need to be
6777 * allocated), or %NULL to undo the effect of previous calls to
6778 * of gtk_widget_modify_cursor().
6780 * Sets the cursor color to use in a widget, overriding the
6781 * #GtkWidget:cursor-color and #GtkWidget:secondary-cursor-color
6782 * style properties. All other style values are left untouched.
6783 * See also gtk_widget_modify_style().
6788 gtk_widget_modify_cursor (GtkWidget *widget,
6789 const GdkColor *primary,
6790 const GdkColor *secondary)
6792 GtkRcStyle *rc_style;
6794 g_return_if_fail (GTK_IS_WIDGET (widget));
6796 rc_style = gtk_widget_get_modifier_style (widget);
6798 modify_color_property (widget, rc_style, "cursor-color", primary);
6799 modify_color_property (widget, rc_style, "secondary-cursor-color", secondary);
6801 gtk_widget_modify_style (widget, rc_style);
6805 * gtk_widget_modify_font:
6806 * @widget: a #GtkWidget
6807 * @font_desc: (allow-none): the font description to use, or %NULL to undo
6808 * the effect of previous calls to gtk_widget_modify_font().
6810 * Sets the font to use for a widget. All other style values are left
6811 * untouched. See also gtk_widget_modify_style().
6814 gtk_widget_modify_font (GtkWidget *widget,
6815 PangoFontDescription *font_desc)
6817 GtkRcStyle *rc_style;
6819 g_return_if_fail (GTK_IS_WIDGET (widget));
6821 rc_style = gtk_widget_get_modifier_style (widget);
6823 if (rc_style->font_desc)
6824 pango_font_description_free (rc_style->font_desc);
6827 rc_style->font_desc = pango_font_description_copy (font_desc);
6829 rc_style->font_desc = NULL;
6831 gtk_widget_modify_style (widget, rc_style);
6835 gtk_widget_real_direction_changed (GtkWidget *widget,
6836 GtkTextDirection previous_direction)
6838 gtk_widget_queue_resize (widget);
6842 gtk_widget_real_style_set (GtkWidget *widget,
6843 GtkStyle *previous_style)
6845 if (gtk_widget_get_realized (widget) &&
6846 gtk_widget_get_has_window (widget))
6847 gtk_style_set_background (widget->style, widget->window, widget->state);
6851 gtk_widget_set_style_internal (GtkWidget *widget,
6853 gboolean initial_emission)
6855 g_object_ref (widget);
6856 g_object_freeze_notify (G_OBJECT (widget));
6858 if (widget->style != style)
6860 GtkStyle *previous_style;
6862 if (gtk_widget_get_realized (widget))
6864 gtk_widget_reset_shapes (widget);
6865 gtk_style_detach (widget->style);
6868 previous_style = widget->style;
6869 widget->style = style;
6870 g_object_ref (widget->style);
6872 if (gtk_widget_get_realized (widget))
6873 widget->style = gtk_style_attach (widget->style, widget->window);
6875 gtk_widget_update_pango_context (widget);
6876 g_signal_emit (widget,
6877 widget_signals[STYLE_SET],
6879 initial_emission ? NULL : previous_style);
6880 g_object_unref (previous_style);
6882 if (GTK_WIDGET_ANCHORED (widget) && !initial_emission)
6883 gtk_widget_queue_resize (widget);
6885 else if (initial_emission)
6887 gtk_widget_update_pango_context (widget);
6888 g_signal_emit (widget,
6889 widget_signals[STYLE_SET],
6893 g_object_notify (G_OBJECT (widget), "style");
6894 g_object_thaw_notify (G_OBJECT (widget));
6895 g_object_unref (widget);
6899 GtkWidget *previous_toplevel;
6900 GdkScreen *previous_screen;
6901 GdkScreen *new_screen;
6902 } HierarchyChangedInfo;
6905 do_screen_change (GtkWidget *widget,
6906 GdkScreen *old_screen,
6907 GdkScreen *new_screen)
6909 if (old_screen != new_screen)
6913 PangoContext *context = g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
6915 g_object_set_qdata (G_OBJECT (widget), quark_pango_context, NULL);
6918 _gtk_tooltip_hide (widget);
6919 g_signal_emit (widget, widget_signals[SCREEN_CHANGED], 0, old_screen);
6924 gtk_widget_propagate_hierarchy_changed_recurse (GtkWidget *widget,
6925 gpointer client_data)
6927 HierarchyChangedInfo *info = client_data;
6928 gboolean new_anchored = gtk_widget_is_toplevel (widget) ||
6929 (widget->parent && GTK_WIDGET_ANCHORED (widget->parent));
6931 if (GTK_WIDGET_ANCHORED (widget) != new_anchored)
6933 g_object_ref (widget);
6936 GTK_PRIVATE_SET_FLAG (widget, GTK_ANCHORED);
6938 GTK_PRIVATE_UNSET_FLAG (widget, GTK_ANCHORED);
6940 g_signal_emit (widget, widget_signals[HIERARCHY_CHANGED], 0, info->previous_toplevel);
6941 do_screen_change (widget, info->previous_screen, info->new_screen);
6943 if (GTK_IS_CONTAINER (widget))
6944 gtk_container_forall (GTK_CONTAINER (widget),
6945 gtk_widget_propagate_hierarchy_changed_recurse,
6948 g_object_unref (widget);
6953 * _gtk_widget_propagate_hierarchy_changed:
6954 * @widget: a #GtkWidget
6955 * @previous_toplevel: Previous toplevel
6957 * Propagates changes in the anchored state to a widget and all
6958 * children, unsetting or setting the %ANCHORED flag, and
6959 * emitting #GtkWidget::hierarchy-changed.
6962 _gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
6963 GtkWidget *previous_toplevel)
6965 HierarchyChangedInfo info;
6967 info.previous_toplevel = previous_toplevel;
6968 info.previous_screen = previous_toplevel ? gtk_widget_get_screen (previous_toplevel) : NULL;
6970 if (gtk_widget_is_toplevel (widget) ||
6971 (widget->parent && GTK_WIDGET_ANCHORED (widget->parent)))
6972 info.new_screen = gtk_widget_get_screen (widget);
6974 info.new_screen = NULL;
6976 if (info.previous_screen)
6977 g_object_ref (info.previous_screen);
6978 if (previous_toplevel)
6979 g_object_ref (previous_toplevel);
6981 gtk_widget_propagate_hierarchy_changed_recurse (widget, &info);
6983 if (previous_toplevel)
6984 g_object_unref (previous_toplevel);
6985 if (info.previous_screen)
6986 g_object_unref (info.previous_screen);
6990 gtk_widget_propagate_screen_changed_recurse (GtkWidget *widget,
6991 gpointer client_data)
6993 HierarchyChangedInfo *info = client_data;
6995 g_object_ref (widget);
6997 do_screen_change (widget, info->previous_screen, info->new_screen);
6999 if (GTK_IS_CONTAINER (widget))
7000 gtk_container_forall (GTK_CONTAINER (widget),
7001 gtk_widget_propagate_screen_changed_recurse,
7004 g_object_unref (widget);
7008 * gtk_widget_is_composited:
7009 * @widget: a #GtkWidget
7011 * Whether @widget can rely on having its alpha channel
7012 * drawn correctly. On X11 this function returns whether a
7013 * compositing manager is running for @widget's screen.
7015 * Please note that the semantics of this call will change
7016 * in the future if used on a widget that has a composited
7017 * window in its hierarchy (as set by gdk_window_set_composited()).
7019 * Return value: %TRUE if the widget can rely on its alpha
7020 * channel being drawn correctly.
7025 gtk_widget_is_composited (GtkWidget *widget)
7029 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7031 screen = gtk_widget_get_screen (widget);
7033 return gdk_screen_is_composited (screen);
7037 propagate_composited_changed (GtkWidget *widget,
7040 if (GTK_IS_CONTAINER (widget))
7042 gtk_container_forall (GTK_CONTAINER (widget),
7043 propagate_composited_changed,
7047 g_signal_emit (widget, widget_signals[COMPOSITED_CHANGED], 0);
7051 _gtk_widget_propagate_composited_changed (GtkWidget *widget)
7053 propagate_composited_changed (widget, NULL);
7057 * _gtk_widget_propagate_screen_changed:
7058 * @widget: a #GtkWidget
7059 * @previous_screen: Previous screen
7061 * Propagates changes in the screen for a widget to all
7062 * children, emitting #GtkWidget::screen-changed.
7065 _gtk_widget_propagate_screen_changed (GtkWidget *widget,
7066 GdkScreen *previous_screen)
7068 HierarchyChangedInfo info;
7070 info.previous_screen = previous_screen;
7071 info.new_screen = gtk_widget_get_screen (widget);
7073 if (previous_screen)
7074 g_object_ref (previous_screen);
7076 gtk_widget_propagate_screen_changed_recurse (widget, &info);
7078 if (previous_screen)
7079 g_object_unref (previous_screen);
7083 reset_rc_styles_recurse (GtkWidget *widget, gpointer data)
7085 if (gtk_widget_has_rc_style (widget))
7086 gtk_widget_reset_rc_style (widget);
7088 if (GTK_IS_CONTAINER (widget))
7089 gtk_container_forall (GTK_CONTAINER (widget),
7090 reset_rc_styles_recurse,
7096 * gtk_widget_reset_rc_styles:
7097 * @widget: a #GtkWidget.
7099 * Reset the styles of @widget and all descendents, so when
7100 * they are looked up again, they get the correct values
7101 * for the currently loaded RC file settings.
7103 * This function is not useful for applications.
7106 gtk_widget_reset_rc_styles (GtkWidget *widget)
7108 g_return_if_fail (GTK_IS_WIDGET (widget));
7110 reset_rc_styles_recurse (widget, NULL);
7114 * gtk_widget_get_default_style:
7116 * Returns the default style used by all widgets initially.
7118 * Returns: (transfer none): the default style. This #GtkStyle object is owned
7119 * by GTK+ and should not be modified or freed.
7122 gtk_widget_get_default_style (void)
7124 if (!gtk_default_style)
7126 gtk_default_style = gtk_style_new ();
7127 g_object_ref (gtk_default_style);
7130 return gtk_default_style;
7133 static PangoContext *
7134 gtk_widget_peek_pango_context (GtkWidget *widget)
7136 return g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
7140 * gtk_widget_get_pango_context:
7141 * @widget: a #GtkWidget
7143 * Gets a #PangoContext with the appropriate font map, font description,
7144 * and base direction for this widget. Unlike the context returned
7145 * by gtk_widget_create_pango_context(), this context is owned by
7146 * the widget (it can be used until the screen for the widget changes
7147 * or the widget is removed from its toplevel), and will be updated to
7148 * match any changes to the widget's attributes.
7150 * If you create and keep a #PangoLayout using this context, you must
7151 * deal with changes to the context by calling pango_layout_context_changed()
7152 * on the layout in response to the #GtkWidget::style-set and
7153 * #GtkWidget::direction-changed signals for the widget.
7155 * Return value: (transfer none): the #PangoContext for the widget.
7158 gtk_widget_get_pango_context (GtkWidget *widget)
7160 PangoContext *context;
7162 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7164 context = g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
7167 context = gtk_widget_create_pango_context (GTK_WIDGET (widget));
7168 g_object_set_qdata_full (G_OBJECT (widget),
7169 quark_pango_context,
7178 update_pango_context (GtkWidget *widget,
7179 PangoContext *context)
7181 pango_context_set_font_description (context, widget->style->font_desc);
7182 pango_context_set_base_dir (context,
7183 gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR ?
7184 PANGO_DIRECTION_LTR : PANGO_DIRECTION_RTL);
7188 gtk_widget_update_pango_context (GtkWidget *widget)
7190 PangoContext *context = gtk_widget_peek_pango_context (widget);
7196 update_pango_context (widget, context);
7198 screen = gtk_widget_get_screen_unchecked (widget);
7201 pango_cairo_context_set_resolution (context,
7202 gdk_screen_get_resolution (screen));
7203 pango_cairo_context_set_font_options (context,
7204 gdk_screen_get_font_options (screen));
7210 * gtk_widget_create_pango_context:
7211 * @widget: a #GtkWidget
7213 * Creates a new #PangoContext with the appropriate font map,
7214 * font description, and base direction for drawing text for
7215 * this widget. See also gtk_widget_get_pango_context().
7217 * Return value: the new #PangoContext
7220 gtk_widget_create_pango_context (GtkWidget *widget)
7223 PangoContext *context;
7225 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7227 screen = gtk_widget_get_screen_unchecked (widget);
7230 GTK_NOTE (MULTIHEAD,
7231 g_warning ("gtk_widget_create_pango_context ()) called without screen"));
7233 screen = gdk_screen_get_default ();
7236 context = gdk_pango_context_get_for_screen (screen);
7238 update_pango_context (widget, context);
7239 pango_context_set_language (context, gtk_get_default_language ());
7245 * gtk_widget_create_pango_layout:
7246 * @widget: a #GtkWidget
7247 * @text: text to set on the layout (can be %NULL)
7249 * Creates a new #PangoLayout with the appropriate font map,
7250 * font description, and base direction for drawing text for
7253 * If you keep a #PangoLayout created in this way around, in order to
7254 * notify the layout of changes to the base direction or font of this
7255 * widget, you must call pango_layout_context_changed() in response to
7256 * the #GtkWidget::style-set and #GtkWidget::direction-changed signals
7259 * Return value: the new #PangoLayout
7262 gtk_widget_create_pango_layout (GtkWidget *widget,
7265 PangoLayout *layout;
7266 PangoContext *context;
7268 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7270 context = gtk_widget_get_pango_context (widget);
7271 layout = pango_layout_new (context);
7274 pango_layout_set_text (layout, text, -1);
7280 * gtk_widget_render_icon:
7281 * @widget: a #GtkWidget
7282 * @stock_id: a stock ID
7283 * @size: (type int) a stock size. A size of (GtkIconSize)-1 means
7284 * render at the size of the source and don't scale (if there are
7285 * multiple source sizes, GTK+ picks one of the available sizes).
7286 * @detail: (allow-none): render detail to pass to theme engine
7288 * A convenience function that uses the theme engine and RC file
7289 * settings for @widget to look up @stock_id and render it to
7290 * a pixbuf. @stock_id should be a stock icon ID such as
7291 * #GTK_STOCK_OPEN or #GTK_STOCK_OK. @size should be a size
7292 * such as #GTK_ICON_SIZE_MENU. @detail should be a string that
7293 * identifies the widget or code doing the rendering, so that
7294 * theme engines can special-case rendering for that widget or code.
7296 * The pixels in the returned #GdkPixbuf are shared with the rest of
7297 * the application and should not be modified. The pixbuf should be freed
7298 * after use with g_object_unref().
7300 * Return value: a new pixbuf, or %NULL if the stock ID wasn't known
7303 gtk_widget_render_icon (GtkWidget *widget,
7304 const gchar *stock_id,
7306 const gchar *detail)
7308 GtkIconSet *icon_set;
7311 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7312 g_return_val_if_fail (stock_id != NULL, NULL);
7313 g_return_val_if_fail (size > GTK_ICON_SIZE_INVALID || size == -1, NULL);
7315 gtk_widget_ensure_style (widget);
7317 icon_set = gtk_style_lookup_icon_set (widget->style, stock_id);
7319 if (icon_set == NULL)
7322 retval = gtk_icon_set_render_icon (icon_set,
7324 gtk_widget_get_direction (widget),
7325 gtk_widget_get_state (widget),
7334 * gtk_widget_set_parent_window:
7335 * @widget: a #GtkWidget.
7336 * @parent_window: the new parent window.
7338 * Sets a non default parent window for @widget.
7341 gtk_widget_set_parent_window (GtkWidget *widget,
7342 GdkWindow *parent_window)
7344 GdkWindow *old_parent_window;
7346 g_return_if_fail (GTK_IS_WIDGET (widget));
7348 old_parent_window = g_object_get_qdata (G_OBJECT (widget),
7349 quark_parent_window);
7351 if (parent_window != old_parent_window)
7353 g_object_set_qdata (G_OBJECT (widget), quark_parent_window,
7355 if (old_parent_window)
7356 g_object_unref (old_parent_window);
7358 g_object_ref (parent_window);
7363 * gtk_widget_get_parent_window:
7364 * @widget: a #GtkWidget.
7366 * Gets @widget's parent window.
7368 * Returns: (transfer none): the parent window of @widget.
7371 gtk_widget_get_parent_window (GtkWidget *widget)
7373 GdkWindow *parent_window;
7375 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7377 parent_window = g_object_get_qdata (G_OBJECT (widget), quark_parent_window);
7379 return (parent_window != NULL) ? parent_window :
7380 (widget->parent != NULL) ? widget->parent->window : NULL;
7385 * gtk_widget_set_child_visible:
7386 * @widget: a #GtkWidget
7387 * @is_visible: if %TRUE, @widget should be mapped along with its parent.
7389 * Sets whether @widget should be mapped along with its when its parent
7390 * is mapped and @widget has been shown with gtk_widget_show().
7392 * The child visibility can be set for widget before it is added to
7393 * a container with gtk_widget_set_parent(), to avoid mapping
7394 * children unnecessary before immediately unmapping them. However
7395 * it will be reset to its default state of %TRUE when the widget
7396 * is removed from a container.
7398 * Note that changing the child visibility of a widget does not
7399 * queue a resize on the widget. Most of the time, the size of
7400 * a widget is computed from all visible children, whether or
7401 * not they are mapped. If this is not the case, the container
7402 * can queue a resize itself.
7404 * This function is only useful for container implementations and
7405 * never should be called by an application.
7408 gtk_widget_set_child_visible (GtkWidget *widget,
7409 gboolean is_visible)
7411 g_return_if_fail (GTK_IS_WIDGET (widget));
7412 g_return_if_fail (!gtk_widget_is_toplevel (widget));
7414 g_object_ref (widget);
7417 GTK_PRIVATE_SET_FLAG (widget, GTK_CHILD_VISIBLE);
7420 GtkWidget *toplevel;
7422 GTK_PRIVATE_UNSET_FLAG (widget, GTK_CHILD_VISIBLE);
7424 toplevel = gtk_widget_get_toplevel (widget);
7425 if (toplevel != widget && gtk_widget_is_toplevel (toplevel))
7426 _gtk_window_unset_focus_and_default (GTK_WINDOW (toplevel), widget);
7429 if (widget->parent && gtk_widget_get_realized (widget->parent))
7431 if (gtk_widget_get_mapped (widget->parent) &&
7432 GTK_WIDGET_CHILD_VISIBLE (widget) &&
7433 gtk_widget_get_visible (widget))
7434 gtk_widget_map (widget);
7436 gtk_widget_unmap (widget);
7439 g_object_unref (widget);
7443 * gtk_widget_get_child_visible:
7444 * @widget: a #GtkWidget
7446 * Gets the value set with gtk_widget_set_child_visible().
7447 * If you feel a need to use this function, your code probably
7448 * needs reorganization.
7450 * This function is only useful for container implementations and
7451 * never should be called by an application.
7453 * Return value: %TRUE if the widget is mapped with the parent.
7456 gtk_widget_get_child_visible (GtkWidget *widget)
7458 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7460 return GTK_WIDGET_CHILD_VISIBLE (widget);
7464 gtk_widget_get_screen_unchecked (GtkWidget *widget)
7466 GtkWidget *toplevel;
7468 toplevel = gtk_widget_get_toplevel (widget);
7470 if (gtk_widget_is_toplevel (toplevel))
7472 if (GTK_IS_WINDOW (toplevel))
7473 return GTK_WINDOW (toplevel)->screen;
7474 else if (GTK_IS_INVISIBLE (toplevel))
7475 return GTK_INVISIBLE (widget)->screen;
7482 * gtk_widget_get_screen:
7483 * @widget: a #GtkWidget
7485 * Get the #GdkScreen from the toplevel window associated with
7486 * this widget. This function can only be called after the widget
7487 * has been added to a widget hierarchy with a #GtkWindow
7490 * In general, you should only create screen specific
7491 * resources when a widget has been realized, and you should
7492 * free those resources when the widget is unrealized.
7494 * Return value: (transfer none): the #GdkScreen for the toplevel for this widget.
7499 gtk_widget_get_screen (GtkWidget *widget)
7503 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7505 screen = gtk_widget_get_screen_unchecked (widget);
7512 g_warning (G_STRLOC ": Can't get associated screen"
7513 " for a widget unless it is inside a toplevel GtkWindow\n"
7514 " widget type is %s associated top level type is %s",
7515 g_type_name (G_OBJECT_TYPE(G_OBJECT (widget))),
7516 g_type_name (G_OBJECT_TYPE(G_OBJECT (toplevel))));
7518 return gdk_screen_get_default ();
7523 * gtk_widget_has_screen:
7524 * @widget: a #GtkWidget
7526 * Checks whether there is a #GdkScreen is associated with
7527 * this widget. All toplevel widgets have an associated
7528 * screen, and all widgets added into a hierarchy with a toplevel
7529 * window at the top.
7531 * Return value: %TRUE if there is a #GdkScreen associcated
7537 gtk_widget_has_screen (GtkWidget *widget)
7539 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7541 return (gtk_widget_get_screen_unchecked (widget) != NULL);
7545 * gtk_widget_get_display:
7546 * @widget: a #GtkWidget
7548 * Get the #GdkDisplay for the toplevel window associated with
7549 * this widget. This function can only be called after the widget
7550 * has been added to a widget hierarchy with a #GtkWindow at the top.
7552 * In general, you should only create display specific
7553 * resources when a widget has been realized, and you should
7554 * free those resources when the widget is unrealized.
7556 * Return value: (transfer none): the #GdkDisplay for the toplevel for this widget.
7561 gtk_widget_get_display (GtkWidget *widget)
7563 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7565 return gdk_screen_get_display (gtk_widget_get_screen (widget));
7569 * gtk_widget_get_root_window:
7570 * @widget: a #GtkWidget
7572 * Get the root window where this widget is located. This function can
7573 * only be called after the widget has been added to a widget
7574 * hierarchy with #GtkWindow at the top.
7576 * The root window is useful for such purposes as creating a popup
7577 * #GdkWindow associated with the window. In general, you should only
7578 * create display specific resources when a widget has been realized,
7579 * and you should free those resources when the widget is unrealized.
7581 * Return value: (transfer none): the #GdkWindow root window for the toplevel for this widget.
7586 gtk_widget_get_root_window (GtkWidget *widget)
7588 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7590 return gdk_screen_get_root_window (gtk_widget_get_screen (widget));
7594 * gtk_widget_child_focus:
7595 * @widget: a #GtkWidget
7596 * @direction: direction of focus movement
7598 * This function is used by custom widget implementations; if you're
7599 * writing an app, you'd use gtk_widget_grab_focus() to move the focus
7600 * to a particular widget, and gtk_container_set_focus_chain() to
7601 * change the focus tab order. So you may want to investigate those
7602 * functions instead.
7604 * gtk_widget_child_focus() is called by containers as the user moves
7605 * around the window using keyboard shortcuts. @direction indicates
7606 * what kind of motion is taking place (up, down, left, right, tab
7607 * forward, tab backward). gtk_widget_child_focus() emits the
7608 * #GtkWidget::focus signal; widgets override the default handler
7609 * for this signal in order to implement appropriate focus behavior.
7611 * The default ::focus handler for a widget should return %TRUE if
7612 * moving in @direction left the focus on a focusable location inside
7613 * that widget, and %FALSE if moving in @direction moved the focus
7614 * outside the widget. If returning %TRUE, widgets normally
7615 * call gtk_widget_grab_focus() to place the focus accordingly;
7616 * if returning %FALSE, they don't modify the current focus location.
7618 * This function replaces gtk_container_focus() from GTK+ 1.2.
7619 * It was necessary to check that the child was visible, sensitive,
7620 * and focusable before calling gtk_container_focus().
7621 * gtk_widget_child_focus() returns %FALSE if the widget is not
7622 * currently in a focusable state, so there's no need for those checks.
7624 * Return value: %TRUE if focus ended up inside @widget
7627 gtk_widget_child_focus (GtkWidget *widget,
7628 GtkDirectionType direction)
7630 gboolean return_val;
7632 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7634 if (!gtk_widget_get_visible (widget) ||
7635 !gtk_widget_is_sensitive (widget))
7638 /* child widgets must set CAN_FOCUS, containers
7639 * don't have to though.
7641 if (!GTK_IS_CONTAINER (widget) &&
7642 !gtk_widget_get_can_focus (widget))
7645 g_signal_emit (widget,
7646 widget_signals[FOCUS],
7648 direction, &return_val);
7654 * gtk_widget_keynav_failed:
7655 * @widget: a #GtkWidget
7656 * @direction: direction of focus movement
7658 * This function should be called whenever keyboard navigation within
7659 * a single widget hits a boundary. The function emits the
7660 * #GtkWidget::keynav-failed signal on the widget and its return
7661 * value should be interpreted in a way similar to the return value of
7662 * gtk_widget_child_focus():
7664 * When %TRUE is returned, stay in the widget, the failed keyboard
7665 * navigation is Ok and/or there is nowhere we can/should move the
7668 * When %FALSE is returned, the caller should continue with keyboard
7669 * navigation outside the widget, e.g. by calling
7670 * gtk_widget_child_focus() on the widget's toplevel.
7672 * The default ::keynav-failed handler returns %TRUE for
7673 * %GTK_DIR_TAB_FORWARD and %GTK_DIR_TAB_BACKWARD. For the other
7674 * values of #GtkDirectionType, it looks at the
7675 * #GtkSettings:gtk-keynav-cursor-only setting and returns %FALSE
7676 * if the setting is %TRUE. This way the entire user interface
7677 * becomes cursor-navigatable on input devices such as mobile phones
7678 * which only have cursor keys but no tab key.
7680 * Whenever the default handler returns %TRUE, it also calls
7681 * gtk_widget_error_bell() to notify the user of the failed keyboard
7684 * A use case for providing an own implementation of ::keynav-failed
7685 * (either by connecting to it or by overriding it) would be a row of
7686 * #GtkEntry widgets where the user should be able to navigate the
7687 * entire row with the cursor keys, as e.g. known from user interfaces
7688 * that require entering license keys.
7690 * Return value: %TRUE if stopping keyboard navigation is fine, %FALSE
7691 * if the emitting widget should try to handle the keyboard
7692 * navigation attempt in its parent container(s).
7697 gtk_widget_keynav_failed (GtkWidget *widget,
7698 GtkDirectionType direction)
7700 gboolean return_val;
7702 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7704 g_signal_emit (widget, widget_signals[KEYNAV_FAILED], 0,
7705 direction, &return_val);
7711 * gtk_widget_error_bell:
7712 * @widget: a #GtkWidget
7714 * Notifies the user about an input-related error on this widget.
7715 * If the #GtkSettings:gtk-error-bell setting is %TRUE, it calls
7716 * gdk_window_beep(), otherwise it does nothing.
7718 * Note that the effect of gdk_window_beep() can be configured in many
7719 * ways, depending on the windowing backend and the desktop environment
7720 * or window manager that is used.
7725 gtk_widget_error_bell (GtkWidget *widget)
7727 GtkSettings* settings;
7730 g_return_if_fail (GTK_IS_WIDGET (widget));
7732 settings = gtk_widget_get_settings (widget);
7736 g_object_get (settings,
7737 "gtk-error-bell", &beep,
7740 if (beep && widget->window)
7741 gdk_window_beep (widget->window);
7745 gtk_widget_set_usize_internal (GtkWidget *widget,
7749 GtkWidgetAuxInfo *aux_info;
7750 gboolean changed = FALSE;
7752 g_object_freeze_notify (G_OBJECT (widget));
7754 aux_info = _gtk_widget_get_aux_info (widget, TRUE);
7756 if (width > -2 && aux_info->width != width)
7758 g_object_notify (G_OBJECT (widget), "width-request");
7759 aux_info->width = width;
7762 if (height > -2 && aux_info->height != height)
7764 g_object_notify (G_OBJECT (widget), "height-request");
7765 aux_info->height = height;
7769 if (gtk_widget_get_visible (widget) && changed)
7770 gtk_widget_queue_resize (widget);
7772 g_object_thaw_notify (G_OBJECT (widget));
7776 * gtk_widget_set_size_request:
7777 * @widget: a #GtkWidget
7778 * @width: width @widget should request, or -1 to unset
7779 * @height: height @widget should request, or -1 to unset
7781 * Sets the minimum size of a widget; that is, the widget's size
7782 * request will be @width by @height. You can use this function to
7783 * force a widget to be either larger or smaller than it normally
7786 * In most cases, gtk_window_set_default_size() is a better choice for
7787 * toplevel windows than this function; setting the default size will
7788 * still allow users to shrink the window. Setting the size request
7789 * will force them to leave the window at least as large as the size
7790 * request. When dealing with window sizes,
7791 * gtk_window_set_geometry_hints() can be a useful function as well.
7793 * Note the inherent danger of setting any fixed size - themes,
7794 * translations into other languages, different fonts, and user action
7795 * can all change the appropriate size for a given widget. So, it's
7796 * basically impossible to hardcode a size that will always be
7799 * The size request of a widget is the smallest size a widget can
7800 * accept while still functioning well and drawing itself correctly.
7801 * However in some strange cases a widget may be allocated less than
7802 * its requested size, and in many cases a widget may be allocated more
7803 * space than it requested.
7805 * If the size request in a given direction is -1 (unset), then
7806 * the "natural" size request of the widget will be used instead.
7808 * Widgets can't actually be allocated a size less than 1 by 1, but
7809 * you can pass 0,0 to this function to mean "as small as possible."
7812 gtk_widget_set_size_request (GtkWidget *widget,
7816 g_return_if_fail (GTK_IS_WIDGET (widget));
7817 g_return_if_fail (width >= -1);
7818 g_return_if_fail (height >= -1);
7825 gtk_widget_set_usize_internal (widget, width, height);
7830 * gtk_widget_get_size_request:
7831 * @widget: a #GtkWidget
7832 * @width: (allow-none): (out): return location for width, or %NULL
7833 * @height: (allow-none): (out): return location for height, or %NULL
7835 * Gets the size request that was explicitly set for the widget using
7836 * gtk_widget_set_size_request(). A value of -1 stored in @width or
7837 * @height indicates that that dimension has not been set explicitly
7838 * and the natural requisition of the widget will be used intead. See
7839 * gtk_widget_set_size_request(). To get the size a widget will
7840 * actually use, call gtk_widget_size_request() instead of
7844 gtk_widget_get_size_request (GtkWidget *widget,
7848 GtkWidgetAuxInfo *aux_info;
7850 g_return_if_fail (GTK_IS_WIDGET (widget));
7852 aux_info = _gtk_widget_get_aux_info (widget, FALSE);
7855 *width = aux_info ? aux_info->width : -1;
7858 *height = aux_info ? aux_info->height : -1;
7862 * gtk_widget_set_events:
7863 * @widget: a #GtkWidget
7864 * @events: event mask
7866 * Sets the event mask (see #GdkEventMask) for a widget. The event
7867 * mask determines which events a widget will receive. Keep in mind
7868 * that different widgets have different default event masks, and by
7869 * changing the event mask you may disrupt a widget's functionality,
7870 * so be careful. This function must be called while a widget is
7871 * unrealized. Consider gtk_widget_add_events() for widgets that are
7872 * already realized, or if you want to preserve the existing event
7873 * mask. This function can't be used with #GTK_NO_WINDOW widgets;
7874 * to get events on those widgets, place them inside a #GtkEventBox
7875 * and receive events on the event box.
7878 gtk_widget_set_events (GtkWidget *widget,
7881 g_return_if_fail (GTK_IS_WIDGET (widget));
7882 g_return_if_fail (!gtk_widget_get_realized (widget));
7884 g_object_set_qdata (G_OBJECT (widget), quark_event_mask,
7885 GINT_TO_POINTER (events));
7886 g_object_notify (G_OBJECT (widget), "events");
7890 gtk_widget_add_events_internal (GtkWidget *widget,
7896 for (l = window_list; l != NULL; l = l->next)
7898 GdkWindow *window = l->data;
7901 gdk_window_get_user_data (window, &user_data);
7902 if (user_data == widget)
7906 gdk_window_set_events (window, gdk_window_get_events (window) | events);
7908 children = gdk_window_get_children (window);
7909 gtk_widget_add_events_internal (widget, events, children);
7910 g_list_free (children);
7916 * gtk_widget_add_events:
7917 * @widget: a #GtkWidget
7918 * @events: an event mask, see #GdkEventMask
7920 * Adds the events in the bitfield @events to the event mask for
7921 * @widget. See gtk_widget_set_events() for details.
7924 gtk_widget_add_events (GtkWidget *widget,
7929 g_return_if_fail (GTK_IS_WIDGET (widget));
7931 old_events = GPOINTER_TO_INT (g_object_get_qdata (G_OBJECT (widget), quark_event_mask));
7932 g_object_set_qdata (G_OBJECT (widget), quark_event_mask,
7933 GINT_TO_POINTER (old_events | events));
7935 if (gtk_widget_get_realized (widget))
7939 if (!gtk_widget_get_has_window (widget))
7940 window_list = gdk_window_get_children (widget->window);
7942 window_list = g_list_prepend (NULL, widget->window);
7944 gtk_widget_add_events_internal (widget, events, window_list);
7946 g_list_free (window_list);
7949 g_object_notify (G_OBJECT (widget), "events");
7953 * gtk_widget_set_extension_events:
7954 * @widget: a #GtkWidget
7955 * @mode: bitfield of extension events to receive
7957 * Sets the extension events mask to @mode. See #GdkExtensionMode
7958 * and gdk_input_set_extension_events().
7961 gtk_widget_set_extension_events (GtkWidget *widget,
7962 GdkExtensionMode mode)
7964 g_return_if_fail (GTK_IS_WIDGET (widget));
7966 if (gtk_widget_get_realized (widget))
7967 gtk_widget_set_extension_events_internal (widget, mode, NULL);
7969 g_object_set_qdata (G_OBJECT (widget), quark_extension_event_mode,
7970 GINT_TO_POINTER (mode));
7971 g_object_notify (G_OBJECT (widget), "extension-events");
7975 * gtk_widget_get_toplevel:
7976 * @widget: a #GtkWidget
7978 * This function returns the topmost widget in the container hierarchy
7979 * @widget is a part of. If @widget has no parent widgets, it will be
7980 * returned as the topmost widget. No reference will be added to the
7981 * returned widget; it should not be unreferenced.
7983 * Note the difference in behavior vs. gtk_widget_get_ancestor();
7984 * <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW)</literal>
7986 * %NULL if @widget wasn't inside a toplevel window, and if the
7987 * window was inside a #GtkWindow-derived widget which was in turn
7988 * inside the toplevel #GtkWindow. While the second case may
7989 * seem unlikely, it actually happens when a #GtkPlug is embedded
7990 * inside a #GtkSocket within the same application.
7992 * To reliably find the toplevel #GtkWindow, use
7993 * gtk_widget_get_toplevel() and check if the %TOPLEVEL flags
7994 * is set on the result.
7996 * GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
7997 * if (gtk_widget_is_toplevel (toplevel))
7999 * /* Perform action on toplevel. */
8003 * Return value: (transfer none): the topmost ancestor of @widget, or @widget itself
8004 * if there's no ancestor.
8007 gtk_widget_get_toplevel (GtkWidget *widget)
8009 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8011 while (widget->parent)
8012 widget = widget->parent;
8018 * gtk_widget_get_ancestor:
8019 * @widget: a #GtkWidget
8020 * @widget_type: ancestor type
8022 * Gets the first ancestor of @widget with type @widget_type. For example,
8023 * <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)</literal> gets
8024 * the first #GtkBox that's an ancestor of @widget. No reference will be
8025 * added to the returned widget; it should not be unreferenced. See note
8026 * about checking for a toplevel #GtkWindow in the docs for
8027 * gtk_widget_get_toplevel().
8029 * Note that unlike gtk_widget_is_ancestor(), gtk_widget_get_ancestor()
8030 * considers @widget to be an ancestor of itself.
8032 * Return value: (transfer none): the ancestor widget, or %NULL if not found
8035 gtk_widget_get_ancestor (GtkWidget *widget,
8038 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8040 while (widget && !g_type_is_a (G_OBJECT_TYPE (widget), widget_type))
8041 widget = widget->parent;
8043 if (!(widget && g_type_is_a (G_OBJECT_TYPE (widget), widget_type)))
8050 * gtk_widget_get_colormap:
8051 * @widget: a #GtkWidget
8053 * Gets the colormap that will be used to render @widget. No reference will
8054 * be added to the returned colormap; it should not be unreferenced.
8056 * Return value: (transfer none): the colormap used by @widget
8059 gtk_widget_get_colormap (GtkWidget *widget)
8061 GdkColormap *colormap;
8062 GtkWidget *tmp_widget;
8064 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8068 colormap = gdk_drawable_get_colormap (widget->window);
8069 /* If window was destroyed previously, we'll get NULL here */
8074 tmp_widget = widget;
8077 colormap = g_object_get_qdata (G_OBJECT (tmp_widget), quark_colormap);
8081 tmp_widget= tmp_widget->parent;
8084 return gdk_screen_get_default_colormap (gtk_widget_get_screen (widget));
8088 * gtk_widget_get_visual:
8089 * @widget: a #GtkWidget
8091 * Gets the visual that will be used to render @widget.
8093 * Return value: (transfer none): the visual for @widget
8096 gtk_widget_get_visual (GtkWidget *widget)
8098 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8100 return gdk_colormap_get_visual (gtk_widget_get_colormap (widget));
8104 * gtk_widget_get_settings:
8105 * @widget: a #GtkWidget
8107 * Gets the settings object holding the settings (global property
8108 * settings, RC file information, etc) used for this widget.
8110 * Note that this function can only be called when the #GtkWidget
8111 * is attached to a toplevel, since the settings object is specific
8112 * to a particular #GdkScreen.
8114 * Return value: (transfer none): the relevant #GtkSettings object
8117 gtk_widget_get_settings (GtkWidget *widget)
8119 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8121 return gtk_settings_get_for_screen (gtk_widget_get_screen (widget));
8125 * gtk_widget_set_colormap:
8126 * @widget: a #GtkWidget
8127 * @colormap: a colormap
8129 * Sets the colormap for the widget to the given value. Widget must not
8130 * have been previously realized. This probably should only be used
8131 * from an <function>init()</function> function (i.e. from the constructor
8135 gtk_widget_set_colormap (GtkWidget *widget,
8136 GdkColormap *colormap)
8138 g_return_if_fail (GTK_IS_WIDGET (widget));
8139 g_return_if_fail (!gtk_widget_get_realized (widget));
8140 g_return_if_fail (GDK_IS_COLORMAP (colormap));
8142 g_object_ref (colormap);
8144 g_object_set_qdata_full (G_OBJECT (widget),
8151 * gtk_widget_get_events:
8152 * @widget: a #GtkWidget
8154 * Returns the event mask for the widget (a bitfield containing flags
8155 * from the #GdkEventMask enumeration). These are the events that the widget
8158 * Return value: event mask for @widget
8161 gtk_widget_get_events (GtkWidget *widget)
8163 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
8165 return GPOINTER_TO_INT (g_object_get_qdata (G_OBJECT (widget), quark_event_mask));
8169 * gtk_widget_get_extension_events:
8170 * @widget: a #GtkWidget
8172 * Retrieves the extension events the widget will receive; see
8173 * gdk_input_set_extension_events().
8175 * Return value: extension events for @widget
8178 gtk_widget_get_extension_events (GtkWidget *widget)
8180 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
8182 return GPOINTER_TO_INT (g_object_get_qdata (G_OBJECT (widget), quark_extension_event_mode));
8186 * gtk_widget_get_pointer:
8187 * @widget: a #GtkWidget
8188 * @x: (out) (allow-none): return location for the X coordinate, or %NULL
8189 * @y: (out) (allow-none): return location for the Y coordinate, or %NULL
8191 * Obtains the location of the mouse pointer in widget coordinates.
8192 * Widget coordinates are a bit odd; for historical reasons, they are
8193 * defined as @widget->window coordinates for widgets that are not
8194 * #GTK_NO_WINDOW widgets, and are relative to @widget->allocation.x,
8195 * @widget->allocation.y for widgets that are #GTK_NO_WINDOW widgets.
8198 gtk_widget_get_pointer (GtkWidget *widget,
8202 g_return_if_fail (GTK_IS_WIDGET (widget));
8209 if (gtk_widget_get_realized (widget))
8211 gdk_window_get_pointer (widget->window, x, y, NULL);
8213 if (!gtk_widget_get_has_window (widget))
8216 *x -= widget->allocation.x;
8218 *y -= widget->allocation.y;
8224 * gtk_widget_is_ancestor:
8225 * @widget: a #GtkWidget
8226 * @ancestor: another #GtkWidget
8228 * Determines whether @widget is somewhere inside @ancestor, possibly with
8229 * intermediate containers.
8231 * Return value: %TRUE if @ancestor contains @widget as a child,
8232 * grandchild, great grandchild, etc.
8235 gtk_widget_is_ancestor (GtkWidget *widget,
8236 GtkWidget *ancestor)
8238 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
8239 g_return_val_if_fail (ancestor != NULL, FALSE);
8243 if (widget->parent == ancestor)
8245 widget = widget->parent;
8251 static GQuark quark_composite_name = 0;
8254 * gtk_widget_set_composite_name:
8255 * @widget: a #GtkWidget.
8256 * @name: the name to set
8258 * Sets a widgets composite name. The widget must be
8259 * a composite child of its parent; see gtk_widget_push_composite_child().
8262 gtk_widget_set_composite_name (GtkWidget *widget,
8265 g_return_if_fail (GTK_IS_WIDGET (widget));
8266 g_return_if_fail ((GTK_OBJECT_FLAGS (widget) & GTK_COMPOSITE_CHILD) != 0);
8267 g_return_if_fail (name != NULL);
8269 if (!quark_composite_name)
8270 quark_composite_name = g_quark_from_static_string ("gtk-composite-name");
8272 g_object_set_qdata_full (G_OBJECT (widget),
8273 quark_composite_name,
8279 * gtk_widget_get_composite_name:
8280 * @widget: a #GtkWidget
8282 * Obtains the composite name of a widget.
8284 * Returns: the composite name of @widget, or %NULL if @widget is not
8285 * a composite child. The string should be freed when it is no
8289 gtk_widget_get_composite_name (GtkWidget *widget)
8291 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8293 if (((GTK_OBJECT_FLAGS (widget) & GTK_COMPOSITE_CHILD) != 0) && widget->parent)
8294 return _gtk_container_child_composite_name (GTK_CONTAINER (widget->parent),
8301 * gtk_widget_push_composite_child:
8303 * Makes all newly-created widgets as composite children until
8304 * the corresponding gtk_widget_pop_composite_child() call.
8306 * A composite child is a child that's an implementation detail of the
8307 * container it's inside and should not be visible to people using the
8308 * container. Composite children aren't treated differently by GTK (but
8309 * see gtk_container_foreach() vs. gtk_container_forall()), but e.g. GUI
8310 * builders might want to treat them in a different way.
8312 * Here is a simple example:
8314 * gtk_widget_push_composite_child ();
8315 * scrolled_window->hscrollbar = gtk_hscrollbar_new (hadjustment);
8316 * gtk_widget_set_composite_name (scrolled_window->hscrollbar, "hscrollbar");
8317 * gtk_widget_pop_composite_child ();
8318 * gtk_widget_set_parent (scrolled_window->hscrollbar,
8319 * GTK_WIDGET (scrolled_window));
8320 * g_object_ref (scrolled_window->hscrollbar);
8324 gtk_widget_push_composite_child (void)
8326 composite_child_stack++;
8330 * gtk_widget_pop_composite_child:
8332 * Cancels the effect of a previous call to gtk_widget_push_composite_child().
8335 gtk_widget_pop_composite_child (void)
8337 if (composite_child_stack)
8338 composite_child_stack--;
8342 * gtk_widget_push_colormap:
8343 * @cmap: a #GdkColormap
8345 * Pushes @cmap onto a global stack of colormaps; the topmost
8346 * colormap on the stack will be used to create all widgets.
8347 * Remove @cmap with gtk_widget_pop_colormap(). There's little
8348 * reason to use this function.
8351 gtk_widget_push_colormap (GdkColormap *cmap)
8353 g_return_if_fail (!cmap || GDK_IS_COLORMAP (cmap));
8355 colormap_stack = g_slist_prepend (colormap_stack, cmap);
8359 * gtk_widget_pop_colormap:
8361 * Removes a colormap pushed with gtk_widget_push_colormap().
8364 gtk_widget_pop_colormap (void)
8367 colormap_stack = g_slist_delete_link (colormap_stack, colormap_stack);
8371 * gtk_widget_set_default_colormap:
8372 * @colormap: a #GdkColormap
8374 * Sets the default colormap to use when creating widgets.
8375 * gtk_widget_push_colormap() is a better function to use if
8376 * you only want to affect a few widgets, rather than all widgets.
8379 gtk_widget_set_default_colormap (GdkColormap *colormap)
8381 g_return_if_fail (GDK_IS_COLORMAP (colormap));
8383 gdk_screen_set_default_colormap (gdk_colormap_get_screen (colormap),
8388 * gtk_widget_get_default_colormap:
8390 * Obtains the default colormap used to create widgets.
8392 * Return value: (transfer none): default widget colormap
8395 gtk_widget_get_default_colormap (void)
8397 return gdk_screen_get_default_colormap (gdk_screen_get_default ());
8401 * gtk_widget_get_default_visual:
8403 * Obtains the visual of the default colormap. Not really useful;
8404 * used to be useful before gdk_colormap_get_visual() existed.
8406 * Return value: (transfer none): visual of the default colormap
8409 gtk_widget_get_default_visual (void)
8411 return gdk_colormap_get_visual (gtk_widget_get_default_colormap ());
8415 gtk_widget_emit_direction_changed (GtkWidget *widget,
8416 GtkTextDirection old_dir)
8418 gtk_widget_update_pango_context (widget);
8420 g_signal_emit (widget, widget_signals[DIRECTION_CHANGED], 0, old_dir);
8424 * gtk_widget_set_direction:
8425 * @widget: a #GtkWidget
8426 * @dir: the new direction
8428 * Sets the reading direction on a particular widget. This direction
8429 * controls the primary direction for widgets containing text,
8430 * and also the direction in which the children of a container are
8431 * packed. The ability to set the direction is present in order
8432 * so that correct localization into languages with right-to-left
8433 * reading directions can be done. Generally, applications will
8434 * let the default reading direction present, except for containers
8435 * where the containers are arranged in an order that is explicitely
8436 * visual rather than logical (such as buttons for text justification).
8438 * If the direction is set to %GTK_TEXT_DIR_NONE, then the value
8439 * set by gtk_widget_set_default_direction() will be used.
8442 gtk_widget_set_direction (GtkWidget *widget,
8443 GtkTextDirection dir)
8445 GtkTextDirection old_dir;
8447 g_return_if_fail (GTK_IS_WIDGET (widget));
8448 g_return_if_fail (dir >= GTK_TEXT_DIR_NONE && dir <= GTK_TEXT_DIR_RTL);
8450 old_dir = gtk_widget_get_direction (widget);
8452 if (dir == GTK_TEXT_DIR_NONE)
8453 GTK_PRIVATE_UNSET_FLAG (widget, GTK_DIRECTION_SET);
8456 GTK_PRIVATE_SET_FLAG (widget, GTK_DIRECTION_SET);
8457 if (dir == GTK_TEXT_DIR_LTR)
8458 GTK_PRIVATE_SET_FLAG (widget, GTK_DIRECTION_LTR);
8460 GTK_PRIVATE_UNSET_FLAG (widget, GTK_DIRECTION_LTR);
8463 if (old_dir != gtk_widget_get_direction (widget))
8464 gtk_widget_emit_direction_changed (widget, old_dir);
8468 * gtk_widget_get_direction:
8469 * @widget: a #GtkWidget
8471 * Gets the reading direction for a particular widget. See
8472 * gtk_widget_set_direction().
8474 * Return value: the reading direction for the widget.
8477 gtk_widget_get_direction (GtkWidget *widget)
8479 g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_TEXT_DIR_LTR);
8481 if (GTK_WIDGET_DIRECTION_SET (widget))
8482 return GTK_WIDGET_DIRECTION_LTR (widget) ? GTK_TEXT_DIR_LTR : GTK_TEXT_DIR_RTL;
8484 return gtk_default_direction;
8488 gtk_widget_set_default_direction_recurse (GtkWidget *widget, gpointer data)
8490 GtkTextDirection old_dir = GPOINTER_TO_UINT (data);
8492 g_object_ref (widget);
8494 if (!GTK_WIDGET_DIRECTION_SET (widget))
8495 gtk_widget_emit_direction_changed (widget, old_dir);
8497 if (GTK_IS_CONTAINER (widget))
8498 gtk_container_forall (GTK_CONTAINER (widget),
8499 gtk_widget_set_default_direction_recurse,
8502 g_object_unref (widget);
8506 * gtk_widget_set_default_direction:
8507 * @dir: the new default direction. This cannot be
8508 * %GTK_TEXT_DIR_NONE.
8510 * Sets the default reading direction for widgets where the
8511 * direction has not been explicitly set by gtk_widget_set_direction().
8514 gtk_widget_set_default_direction (GtkTextDirection dir)
8516 g_return_if_fail (dir == GTK_TEXT_DIR_RTL || dir == GTK_TEXT_DIR_LTR);
8518 if (dir != gtk_default_direction)
8520 GList *toplevels, *tmp_list;
8521 GtkTextDirection old_dir = gtk_default_direction;
8523 gtk_default_direction = dir;
8525 tmp_list = toplevels = gtk_window_list_toplevels ();
8526 g_list_foreach (toplevels, (GFunc)g_object_ref, NULL);
8530 gtk_widget_set_default_direction_recurse (tmp_list->data,
8531 GUINT_TO_POINTER (old_dir));
8532 g_object_unref (tmp_list->data);
8533 tmp_list = tmp_list->next;
8536 g_list_free (toplevels);
8541 * gtk_widget_get_default_direction:
8543 * Obtains the current default reading direction. See
8544 * gtk_widget_set_default_direction().
8546 * Return value: the current default direction.
8549 gtk_widget_get_default_direction (void)
8551 return gtk_default_direction;
8555 gtk_widget_dispose (GObject *object)
8557 GtkWidget *widget = GTK_WIDGET (object);
8560 gtk_container_remove (GTK_CONTAINER (widget->parent), widget);
8561 else if (gtk_widget_get_visible (widget))
8562 gtk_widget_hide (widget);
8564 GTK_WIDGET_UNSET_FLAGS (widget, GTK_VISIBLE);
8565 if (gtk_widget_get_realized (widget))
8566 gtk_widget_unrealize (widget);
8568 G_OBJECT_CLASS (gtk_widget_parent_class)->dispose (object);
8572 gtk_widget_real_destroy (GtkObject *object)
8574 /* gtk_object_destroy() will already hold a refcount on object */
8575 GtkWidget *widget = GTK_WIDGET (object);
8577 /* wipe accelerator closures (keep order) */
8578 g_object_set_qdata (G_OBJECT (widget), quark_accel_path, NULL);
8579 g_object_set_qdata (G_OBJECT (widget), quark_accel_closures, NULL);
8581 /* Callers of add_mnemonic_label() should disconnect on ::destroy */
8582 g_object_set_qdata (G_OBJECT (widget), quark_mnemonic_labels, NULL);
8584 gtk_grab_remove (widget);
8586 g_object_unref (widget->style);
8587 widget->style = gtk_widget_get_default_style ();
8588 g_object_ref (widget->style);
8590 GTK_OBJECT_CLASS (gtk_widget_parent_class)->destroy (object);
8594 gtk_widget_finalize (GObject *object)
8596 GtkWidget *widget = GTK_WIDGET (object);
8597 GtkWidgetAuxInfo *aux_info;
8598 GtkAccessible *accessible;
8600 gtk_grab_remove (widget);
8602 g_object_unref (widget->style);
8603 widget->style = NULL;
8605 g_free (widget->name);
8607 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
8609 gtk_widget_aux_info_destroy (aux_info);
8611 accessible = g_object_get_qdata (G_OBJECT (widget), quark_accessible_object);
8613 g_object_unref (accessible);
8615 G_OBJECT_CLASS (gtk_widget_parent_class)->finalize (object);
8618 /*****************************************
8619 * gtk_widget_real_map:
8624 *****************************************/
8627 gtk_widget_real_map (GtkWidget *widget)
8629 g_assert (gtk_widget_get_realized (widget));
8631 if (!gtk_widget_get_mapped (widget))
8633 gtk_widget_set_mapped (widget, TRUE);
8635 if (gtk_widget_get_has_window (widget))
8636 gdk_window_show (widget->window);
8640 /*****************************************
8641 * gtk_widget_real_unmap:
8646 *****************************************/
8649 gtk_widget_real_unmap (GtkWidget *widget)
8651 if (gtk_widget_get_mapped (widget))
8653 gtk_widget_set_mapped (widget, FALSE);
8655 if (gtk_widget_get_has_window (widget))
8656 gdk_window_hide (widget->window);
8660 /*****************************************
8661 * gtk_widget_real_realize:
8666 *****************************************/
8669 gtk_widget_real_realize (GtkWidget *widget)
8671 g_assert (!gtk_widget_get_has_window (widget));
8673 gtk_widget_set_realized (widget, TRUE);
8676 widget->window = gtk_widget_get_parent_window (widget);
8677 g_object_ref (widget->window);
8679 widget->style = gtk_style_attach (widget->style, widget->window);
8682 /*****************************************
8683 * gtk_widget_real_unrealize:
8688 *****************************************/
8691 gtk_widget_real_unrealize (GtkWidget *widget)
8693 if (gtk_widget_get_mapped (widget))
8694 gtk_widget_real_unmap (widget);
8696 gtk_widget_set_mapped (widget, FALSE);
8698 /* printf ("unrealizing %s\n", g_type_name (G_TYPE_FROM_INSTANCE (widget)));
8701 /* We must do unrealize child widget BEFORE container widget.
8702 * gdk_window_destroy() destroys specified xwindow and its sub-xwindows.
8703 * So, unrealizing container widget bofore its children causes the problem
8704 * (for example, gdk_ic_destroy () with destroyed window causes crash. )
8707 if (GTK_IS_CONTAINER (widget))
8708 gtk_container_forall (GTK_CONTAINER (widget),
8709 (GtkCallback) gtk_widget_unrealize,
8712 gtk_style_detach (widget->style);
8713 if (gtk_widget_get_has_window (widget))
8715 gdk_window_set_user_data (widget->window, NULL);
8716 gdk_window_destroy (widget->window);
8717 widget->window = NULL;
8721 g_object_unref (widget->window);
8722 widget->window = NULL;
8725 gtk_selection_remove_all (widget);
8727 gtk_widget_set_realized (widget, FALSE);
8731 gtk_widget_real_size_request (GtkWidget *widget,
8732 GtkRequisition *requisition)
8734 requisition->width = widget->requisition.width;
8735 requisition->height = widget->requisition.height;
8739 * _gtk_widget_peek_colormap:
8741 * Returns colormap currently pushed by gtk_widget_push_colormap, if any.
8743 * Return value: the currently pushed colormap, or %NULL if there is none.
8746 _gtk_widget_peek_colormap (void)
8749 return (GdkColormap*) colormap_stack->data;
8754 * _gtk_widget_set_pointer_window:
8755 * @widget: a #GtkWidget.
8756 * @pointer_window: the new pointer window.
8758 * Sets pointer window for @widget. Does not ref @pointer_window.
8759 * Actually stores it on the #GdkScreen, but you don't need to know that.
8762 _gtk_widget_set_pointer_window (GtkWidget *widget,
8763 GdkWindow *pointer_window)
8765 g_return_if_fail (GTK_IS_WIDGET (widget));
8767 if (gtk_widget_get_realized (widget))
8769 GdkScreen *screen = gdk_drawable_get_screen (widget->window);
8771 g_object_set_qdata (G_OBJECT (screen), quark_pointer_window,
8777 * _gtk_widget_get_pointer_window:
8778 * @widget: a #GtkWidget.
8780 * Return value: the pointer window set on the #GdkScreen @widget is attached
8784 _gtk_widget_get_pointer_window (GtkWidget *widget)
8786 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8788 if (gtk_widget_get_realized (widget))
8790 GdkScreen *screen = gdk_drawable_get_screen (widget->window);
8792 return g_object_get_qdata (G_OBJECT (screen), quark_pointer_window);
8799 synth_crossing (GtkWidget *widget,
8802 GdkCrossingMode mode,
8803 GdkNotifyType detail)
8807 event = gdk_event_new (type);
8809 event->crossing.window = g_object_ref (window);
8810 event->crossing.send_event = TRUE;
8811 event->crossing.subwindow = g_object_ref (window);
8812 event->crossing.time = GDK_CURRENT_TIME;
8813 event->crossing.x = event->crossing.y = 0;
8814 event->crossing.x_root = event->crossing.y_root = 0;
8815 event->crossing.mode = mode;
8816 event->crossing.detail = detail;
8817 event->crossing.focus = FALSE;
8818 event->crossing.state = 0;
8821 widget = gtk_get_event_widget (event);
8824 gtk_widget_event_internal (widget, event);
8826 gdk_event_free (event);
8830 * _gtk_widget_is_pointer_widget:
8831 * @widget: a #GtkWidget
8833 * Returns %TRUE if the pointer window belongs to @widget.
8836 _gtk_widget_is_pointer_widget (GtkWidget *widget)
8838 if (GTK_WIDGET_HAS_POINTER (widget))
8843 win = _gtk_widget_get_pointer_window (widget);
8846 gdk_window_get_user_data (win, (gpointer *)&wid);
8856 * _gtk_widget_synthesize_crossing:
8857 * @from: the #GtkWidget the virtual pointer is leaving.
8858 * @to: the #GtkWidget the virtual pointer is moving to.
8859 * @mode: the #GdkCrossingMode to place on the synthesized events.
8861 * Generate crossing event(s) on widget state (sensitivity) or GTK+ grab change.
8863 * The real pointer window is the window that most recently received an enter notify
8864 * event. Windows that don't select for crossing events can't become the real
8865 * poiner window. The real pointer widget that owns the real pointer window. The
8866 * effective pointer window is the same as the real pointer window unless the real
8867 * pointer widget is either insensitive or there is a grab on a widget that is not
8868 * an ancestor of the real pointer widget (in which case the effective pointer
8869 * window should be the root window).
8871 * When the effective pointer window is the same as the real poiner window, we
8872 * receive crossing events from the windowing system. When the effective pointer
8873 * window changes to become different from the real pointer window we synthesize
8874 * crossing events, attempting to follow X protocol rules:
8876 * When the root window becomes the effective pointer window:
8877 * - leave notify on real pointer window, detail Ancestor
8878 * - leave notify on all of its ancestors, detail Virtual
8879 * - enter notify on root window, detail Inferior
8881 * When the root window ceases to be the effective pointer window:
8882 * - leave notify on root window, detail Inferior
8883 * - enter notify on all ancestors of real pointer window, detail Virtual
8884 * - enter notify on real pointer window, detail Ancestor
8887 _gtk_widget_synthesize_crossing (GtkWidget *from,
8889 GdkCrossingMode mode)
8891 GdkWindow *from_window = NULL, *to_window = NULL;
8893 g_return_if_fail (from != NULL || to != NULL);
8896 from_window = GTK_WIDGET_HAS_POINTER (from)
8897 ? _gtk_widget_get_pointer_window (from) : from->window;
8899 to_window = GTK_WIDGET_HAS_POINTER (to)
8900 ? _gtk_widget_get_pointer_window (to) : to->window;
8902 if (from_window == NULL && to_window == NULL)
8904 else if (from_window != NULL && to_window == NULL)
8906 GList *from_ancestors = NULL, *list;
8907 GdkWindow *from_ancestor = from_window;
8909 while (from_ancestor != NULL)
8911 from_ancestor = gdk_window_get_effective_parent (from_ancestor);
8912 if (from_ancestor == NULL)
8914 from_ancestors = g_list_prepend (from_ancestors, from_ancestor);
8917 synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
8918 mode, GDK_NOTIFY_ANCESTOR);
8919 for (list = g_list_last (from_ancestors); list; list = list->prev)
8921 synth_crossing (NULL, GDK_LEAVE_NOTIFY, (GdkWindow *) list->data,
8922 mode, GDK_NOTIFY_VIRTUAL);
8925 /* XXX: enter/inferior on root window? */
8927 g_list_free (from_ancestors);
8929 else if (from_window == NULL && to_window != NULL)
8931 GList *to_ancestors = NULL, *list;
8932 GdkWindow *to_ancestor = to_window;
8934 while (to_ancestor != NULL)
8936 to_ancestor = gdk_window_get_effective_parent (to_ancestor);
8937 if (to_ancestor == NULL)
8939 to_ancestors = g_list_prepend (to_ancestors, to_ancestor);
8942 /* XXX: leave/inferior on root window? */
8944 for (list = to_ancestors; list; list = list->next)
8946 synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
8947 mode, GDK_NOTIFY_VIRTUAL);
8949 synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
8950 mode, GDK_NOTIFY_ANCESTOR);
8952 g_list_free (to_ancestors);
8954 else if (from_window == to_window)
8958 GList *from_ancestors = NULL, *to_ancestors = NULL, *list;
8959 GdkWindow *from_ancestor = from_window, *to_ancestor = to_window;
8961 while (from_ancestor != NULL || to_ancestor != NULL)
8963 if (from_ancestor != NULL)
8965 from_ancestor = gdk_window_get_effective_parent (from_ancestor);
8966 if (from_ancestor == to_window)
8969 from_ancestors = g_list_prepend (from_ancestors, from_ancestor);
8971 if (to_ancestor != NULL)
8973 to_ancestor = gdk_window_get_effective_parent (to_ancestor);
8974 if (to_ancestor == from_window)
8977 to_ancestors = g_list_prepend (to_ancestors, to_ancestor);
8980 if (to_ancestor == from_window)
8982 if (mode != GDK_CROSSING_GTK_UNGRAB)
8983 synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
8984 mode, GDK_NOTIFY_INFERIOR);
8985 for (list = to_ancestors; list; list = list->next)
8986 synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
8987 mode, GDK_NOTIFY_VIRTUAL);
8988 synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
8989 mode, GDK_NOTIFY_ANCESTOR);
8991 else if (from_ancestor == to_window)
8993 synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
8994 mode, GDK_NOTIFY_ANCESTOR);
8995 for (list = g_list_last (from_ancestors); list; list = list->prev)
8997 synth_crossing (NULL, GDK_LEAVE_NOTIFY, (GdkWindow *) list->data,
8998 mode, GDK_NOTIFY_VIRTUAL);
9000 if (mode != GDK_CROSSING_GTK_GRAB)
9001 synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
9002 mode, GDK_NOTIFY_INFERIOR);
9006 while (from_ancestors != NULL && to_ancestors != NULL
9007 && from_ancestors->data == to_ancestors->data)
9009 from_ancestors = g_list_delete_link (from_ancestors,
9011 to_ancestors = g_list_delete_link (to_ancestors, to_ancestors);
9014 synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
9015 mode, GDK_NOTIFY_NONLINEAR);
9017 for (list = g_list_last (from_ancestors); list; list = list->prev)
9019 synth_crossing (NULL, GDK_LEAVE_NOTIFY, (GdkWindow *) list->data,
9020 mode, GDK_NOTIFY_NONLINEAR_VIRTUAL);
9022 for (list = to_ancestors; list; list = list->next)
9024 synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
9025 mode, GDK_NOTIFY_NONLINEAR_VIRTUAL);
9027 synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
9028 mode, GDK_NOTIFY_NONLINEAR);
9030 g_list_free (from_ancestors);
9031 g_list_free (to_ancestors);
9036 gtk_widget_propagate_state (GtkWidget *widget,
9039 guint8 old_state = gtk_widget_get_state (widget);
9040 guint8 old_saved_state = widget->saved_state;
9042 /* don't call this function with state==GTK_STATE_INSENSITIVE,
9043 * parent_sensitive==TRUE on a sensitive widget
9047 if (data->parent_sensitive)
9048 GTK_OBJECT_FLAGS (widget) |= GTK_PARENT_SENSITIVE;
9050 GTK_OBJECT_FLAGS (widget) &= ~(GTK_PARENT_SENSITIVE);
9052 if (gtk_widget_is_sensitive (widget))
9054 if (data->state_restoration)
9055 widget->state = widget->saved_state;
9057 widget->state = data->state;
9061 if (!data->state_restoration)
9063 if (data->state != GTK_STATE_INSENSITIVE)
9064 widget->saved_state = data->state;
9066 else if (gtk_widget_get_state (widget) != GTK_STATE_INSENSITIVE)
9067 widget->saved_state = gtk_widget_get_state (widget);
9068 widget->state = GTK_STATE_INSENSITIVE;
9071 if (gtk_widget_is_focus (widget) && !gtk_widget_is_sensitive (widget))
9075 window = gtk_widget_get_toplevel (widget);
9076 if (window && gtk_widget_is_toplevel (window))
9077 gtk_window_set_focus (GTK_WINDOW (window), NULL);
9080 if (old_state != gtk_widget_get_state (widget) ||
9081 old_saved_state != widget->saved_state)
9083 g_object_ref (widget);
9085 if (!gtk_widget_is_sensitive (widget) && gtk_widget_has_grab (widget))
9086 gtk_grab_remove (widget);
9088 g_signal_emit (widget, widget_signals[STATE_CHANGED], 0, old_state);
9090 if (GTK_WIDGET_HAS_POINTER (widget) && !GTK_WIDGET_SHADOWED (widget))
9092 if (!gtk_widget_is_sensitive (widget))
9093 _gtk_widget_synthesize_crossing (widget, NULL,
9094 GDK_CROSSING_STATE_CHANGED);
9095 else if (old_state == GTK_STATE_INSENSITIVE)
9096 _gtk_widget_synthesize_crossing (NULL, widget,
9097 GDK_CROSSING_STATE_CHANGED);
9100 if (GTK_IS_CONTAINER (widget))
9102 data->parent_sensitive = (gtk_widget_is_sensitive (widget) != FALSE);
9103 if (data->use_forall)
9104 gtk_container_forall (GTK_CONTAINER (widget),
9105 (GtkCallback) gtk_widget_propagate_state,
9108 gtk_container_foreach (GTK_CONTAINER (widget),
9109 (GtkCallback) gtk_widget_propagate_state,
9112 g_object_unref (widget);
9117 * _gtk_widget_get_aux_info:
9118 * @widget: a #GtkWidget
9119 * @create: if %TRUE, create the structure if it doesn't exist
9121 * Get the #GtkWidgetAuxInfo structure for the widget.
9123 * Return value: the #GtkAuxInfo structure for the widget, or
9124 * %NULL if @create is %FALSE and one doesn't already exist.
9127 _gtk_widget_get_aux_info (GtkWidget *widget,
9130 GtkWidgetAuxInfo *aux_info;
9132 aux_info = g_object_get_qdata (G_OBJECT (widget), quark_aux_info);
9133 if (!aux_info && create)
9135 aux_info = g_slice_new0 (GtkWidgetAuxInfo);
9137 aux_info->width = -1;
9138 aux_info->height = -1;
9140 g_object_set_qdata (G_OBJECT (widget), quark_aux_info, aux_info);
9147 /*****************************************
9148 * gtk_widget_aux_info_destroy:
9153 *****************************************/
9156 gtk_widget_aux_info_destroy (GtkWidgetAuxInfo *aux_info)
9158 g_slice_free (GtkWidgetAuxInfo, aux_info);
9162 gtk_widget_shape_info_destroy (GtkWidgetShapeInfo *info)
9164 g_object_unref (info->shape_mask);
9165 g_slice_free (GtkWidgetShapeInfo, info);
9169 * gtk_widget_shape_combine_mask:
9170 * @widget: a #GtkWidget
9171 * @shape_mask: (allow-none): shape to be added, or %NULL to remove an existing shape
9172 * @offset_x: X position of shape mask with respect to @window
9173 * @offset_y: Y position of shape mask with respect to @window
9175 * Sets a shape for this widget's GDK window. This allows for
9176 * transparent windows etc., see gdk_window_shape_combine_mask()
9177 * for more information.
9180 gtk_widget_shape_combine_mask (GtkWidget *widget,
9181 GdkBitmap *shape_mask,
9185 GtkWidgetShapeInfo* shape_info;
9187 g_return_if_fail (GTK_IS_WIDGET (widget));
9188 /* set_shape doesn't work on widgets without gdk window */
9189 g_return_if_fail (gtk_widget_get_has_window (widget));
9193 GTK_PRIVATE_UNSET_FLAG (widget, GTK_HAS_SHAPE_MASK);
9196 gdk_window_shape_combine_mask (widget->window, NULL, 0, 0);
9198 g_object_set_qdata (G_OBJECT (widget), quark_shape_info, NULL);
9202 GTK_PRIVATE_SET_FLAG (widget, GTK_HAS_SHAPE_MASK);
9204 shape_info = g_slice_new (GtkWidgetShapeInfo);
9205 g_object_set_qdata_full (G_OBJECT (widget), quark_shape_info, shape_info,
9206 (GDestroyNotify) gtk_widget_shape_info_destroy);
9208 shape_info->shape_mask = g_object_ref (shape_mask);
9209 shape_info->offset_x = offset_x;
9210 shape_info->offset_y = offset_y;
9212 /* set shape if widget has a gdk window already.
9213 * otherwise the shape is scheduled to be set by gtk_widget_realize().
9216 gdk_window_shape_combine_mask (widget->window, shape_mask,
9217 offset_x, offset_y);
9222 * gtk_widget_input_shape_combine_mask:
9223 * @widget: a #GtkWidget
9224 * @shape_mask: (allow-none): shape to be added, or %NULL to remove an existing shape
9225 * @offset_x: X position of shape mask with respect to @window
9226 * @offset_y: Y position of shape mask with respect to @window
9228 * Sets an input shape for this widget's GDK window. This allows for
9229 * windows which react to mouse click in a nonrectangular region, see
9230 * gdk_window_input_shape_combine_mask() for more information.
9235 gtk_widget_input_shape_combine_mask (GtkWidget *widget,
9236 GdkBitmap *shape_mask,
9240 GtkWidgetShapeInfo* shape_info;
9242 g_return_if_fail (GTK_IS_WIDGET (widget));
9243 /* set_shape doesn't work on widgets without gdk window */
9244 g_return_if_fail (gtk_widget_get_has_window (widget));
9249 gdk_window_input_shape_combine_mask (widget->window, NULL, 0, 0);
9251 g_object_set_qdata (G_OBJECT (widget), quark_input_shape_info, NULL);
9255 shape_info = g_slice_new (GtkWidgetShapeInfo);
9256 g_object_set_qdata_full (G_OBJECT (widget), quark_input_shape_info,
9258 (GDestroyNotify) gtk_widget_shape_info_destroy);
9260 shape_info->shape_mask = g_object_ref (shape_mask);
9261 shape_info->offset_x = offset_x;
9262 shape_info->offset_y = offset_y;
9264 /* set shape if widget has a gdk window already.
9265 * otherwise the shape is scheduled to be set by gtk_widget_realize().
9268 gdk_window_input_shape_combine_mask (widget->window, shape_mask,
9269 offset_x, offset_y);
9275 gtk_reset_shapes_recurse (GtkWidget *widget,
9281 gdk_window_get_user_data (window, &data);
9285 gdk_window_shape_combine_mask (window, NULL, 0, 0);
9286 for (list = gdk_window_peek_children (window); list; list = list->next)
9287 gtk_reset_shapes_recurse (widget, list->data);
9291 * gtk_widget_reset_shapes:
9292 * @widget: a #GtkWidget
9294 * Recursively resets the shape on this widget and its descendants.
9297 gtk_widget_reset_shapes (GtkWidget *widget)
9299 g_return_if_fail (GTK_IS_WIDGET (widget));
9300 g_return_if_fail (gtk_widget_get_realized (widget));
9302 if (!GTK_WIDGET_HAS_SHAPE_MASK (widget))
9303 gtk_reset_shapes_recurse (widget, widget->window);
9307 expose_window (GdkWindow *window)
9310 GList *l, *children;
9312 gboolean is_double_buffered;
9314 gdk_window_get_user_data (window, &user_data);
9317 is_double_buffered = gtk_widget_get_double_buffered (GTK_WIDGET (user_data));
9319 is_double_buffered = FALSE;
9321 event.expose.type = GDK_EXPOSE;
9322 event.expose.window = g_object_ref (window);
9323 event.expose.send_event = FALSE;
9324 event.expose.count = 0;
9325 event.expose.area.x = 0;
9326 event.expose.area.y = 0;
9327 gdk_drawable_get_size (GDK_DRAWABLE (window),
9328 &event.expose.area.width,
9329 &event.expose.area.height);
9330 event.expose.region = gdk_region_rectangle (&event.expose.area);
9332 /* If this is not double buffered, force a double buffer so that
9333 redirection works. */
9334 if (!is_double_buffered)
9335 gdk_window_begin_paint_region (window, event.expose.region);
9337 gtk_main_do_event (&event);
9339 if (!is_double_buffered)
9340 gdk_window_end_paint (window);
9342 children = gdk_window_peek_children (window);
9343 for (l = children; l != NULL; l = l->next)
9345 GdkWindow *child = l->data;
9347 /* Don't expose input-only windows */
9348 if (gdk_drawable_get_depth (GDK_DRAWABLE (child)) != 0)
9349 expose_window (l->data);
9352 g_object_unref (window);
9356 * gtk_widget_get_snapshot:
9357 * @widget: a #GtkWidget
9358 * @clip_rect: (allow-none): a #GdkRectangle or %NULL
9360 * Create a #GdkPixmap of the contents of the widget and its children.
9362 * Works even if the widget is obscured. The depth and visual of the
9363 * resulting pixmap is dependent on the widget being snapshot and likely
9364 * differs from those of a target widget displaying the pixmap.
9365 * The function gdk_pixbuf_get_from_drawable() can be used to convert
9366 * the pixmap to a visual independant representation.
9368 * The snapshot area used by this function is the @widget's allocation plus
9369 * any extra space occupied by additional windows belonging to this widget
9370 * (such as the arrows of a spin button).
9371 * Thus, the resulting snapshot pixmap is possibly larger than the allocation.
9373 * If @clip_rect is non-%NULL, the resulting pixmap is shrunken to
9374 * match the specified clip_rect. The (x,y) coordinates of @clip_rect are
9375 * interpreted widget relative. If width or height of @clip_rect are 0 or
9376 * negative, the width or height of the resulting pixmap will be shrunken
9377 * by the respective amount.
9378 * For instance a @clip_rect <literal>{ +5, +5, -10, -10 }</literal> will
9379 * chop off 5 pixels at each side of the snapshot pixmap.
9380 * If non-%NULL, @clip_rect will contain the exact widget-relative snapshot
9381 * coordinates upon return. A @clip_rect of <literal>{ -1, -1, 0, 0 }</literal>
9382 * can be used to preserve the auto-grown snapshot area and use @clip_rect
9383 * as a pure output parameter.
9385 * The returned pixmap can be %NULL, if the resulting @clip_area was empty.
9387 * Return value: #GdkPixmap snapshot of the widget
9392 gtk_widget_get_snapshot (GtkWidget *widget,
9393 GdkRectangle *clip_rect)
9395 int x, y, width, height;
9396 GdkWindow *parent_window = NULL;
9398 GList *windows = NULL, *list;
9400 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9401 if (!gtk_widget_get_visible (widget))
9404 /* the widget (and parent_window) must be realized to be drawable */
9405 if (widget->parent && !gtk_widget_get_realized (widget->parent))
9406 gtk_widget_realize (widget->parent);
9407 if (!gtk_widget_get_realized (widget))
9408 gtk_widget_realize (widget);
9410 /* determine snapshot rectangle */
9411 x = widget->allocation.x;
9412 y = widget->allocation.y;
9413 width = widget->allocation.width;
9414 height = widget->allocation.height;
9416 if (widget->parent && gtk_widget_get_has_window (widget))
9418 /* grow snapshot rectangle to cover all widget windows */
9419 parent_window = gtk_widget_get_parent_window (widget);
9420 for (list = gdk_window_peek_children (parent_window); list; list = list->next)
9422 GdkWindow *subwin = list->data;
9425 gdk_window_get_user_data (subwin, &windata);
9426 if (windata != widget)
9428 windows = g_list_prepend (windows, subwin);
9429 gdk_window_get_position (subwin, &wx, &wy);
9430 gdk_drawable_get_size (subwin, &ww, &wh);
9431 /* grow snapshot rectangle by extra widget sub window */
9442 if (x + width < wx + ww)
9443 width += wx + ww - (x + width);
9444 if (y + height < wy + wh)
9445 height += wy + wh - (y + height);
9448 else if (!widget->parent)
9449 x = y = 0; /* toplevel */
9451 /* at this point, (x,y,width,height) is the parent_window relative
9452 * snapshot area covering all of widget's windows.
9455 /* shrink snapshot size by clip_rectangle */
9458 GdkRectangle snap = { x, y, width, height }, clip = *clip_rect;
9459 clip.x = clip.x < 0 ? x : clip.x;
9460 clip.y = clip.y < 0 ? y : clip.y;
9461 clip.width = clip.width <= 0 ? MAX (0, width + clip.width) : clip.width;
9462 clip.height = clip.height <= 0 ? MAX (0, height + clip.height) : clip.height;
9465 /* offset clip_rect, so it's parent_window relative */
9466 if (clip_rect->x >= 0)
9467 clip.x += widget->allocation.x;
9468 if (clip_rect->y >= 0)
9469 clip.y += widget->allocation.y;
9471 if (!gdk_rectangle_intersect (&snap, &clip, &snap))
9473 g_list_free (windows);
9474 clip_rect->width = clip_rect->height = 0;
9475 return NULL; /* empty snapshot area */
9480 height = snap.height;
9483 /* render snapshot */
9484 pixmap = gdk_pixmap_new (widget->window, width, height, gdk_drawable_get_depth (widget->window));
9485 for (list = windows; list; list = list->next) /* !NO_WINDOW widgets */
9487 GdkWindow *subwin = list->data;
9489 if (gdk_drawable_get_depth (GDK_DRAWABLE (subwin)) == 0)
9490 continue; /* Input only window */
9491 gdk_window_get_position (subwin, &wx, &wy);
9492 gdk_window_redirect_to_drawable (subwin, pixmap, MAX (0, x - wx), MAX (0, y - wy),
9493 MAX (0, wx - x), MAX (0, wy - y), width, height);
9495 expose_window (subwin);
9497 if (!windows) /* NO_WINDOW || toplevel => parent_window == NULL || parent_window == widget->window */
9499 gdk_window_redirect_to_drawable (widget->window, pixmap, x, y, 0, 0, width, height);
9500 expose_window (widget->window);
9502 for (list = windows; list; list = list->next)
9503 gdk_window_remove_redirection (list->data);
9504 if (!windows) /* NO_WINDOW || toplevel */
9505 gdk_window_remove_redirection (widget->window);
9506 g_list_free (windows);
9508 /* return pixmap and snapshot rectangle coordinates */
9513 clip_rect->width = width;
9514 clip_rect->height = height;
9517 /* offset clip_rect from parent_window so it's widget relative */
9518 clip_rect->x -= widget->allocation.x;
9519 clip_rect->y -= widget->allocation.y;
9522 g_printerr ("gtk_widget_get_snapshot: %s (%d,%d, %dx%d)\n",
9523 G_OBJECT_TYPE_NAME (widget),
9524 clip_rect->x, clip_rect->y, clip_rect->width, clip_rect->height);
9533 * gtk_widget_class_install_style_property_parser:
9534 * @klass: a #GtkWidgetClass
9535 * @pspec: the #GParamSpec for the style property
9536 * @parser: the parser for the style property
9538 * Installs a style property on a widget class.
9541 gtk_widget_class_install_style_property_parser (GtkWidgetClass *klass,
9543 GtkRcPropertyParser parser)
9545 g_return_if_fail (GTK_IS_WIDGET_CLASS (klass));
9546 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
9547 g_return_if_fail (pspec->flags & G_PARAM_READABLE);
9548 g_return_if_fail (!(pspec->flags & (G_PARAM_CONSTRUCT_ONLY | G_PARAM_CONSTRUCT)));
9550 if (g_param_spec_pool_lookup (style_property_spec_pool, pspec->name, G_OBJECT_CLASS_TYPE (klass), FALSE))
9552 g_warning (G_STRLOC ": class `%s' already contains a style property named `%s'",
9553 G_OBJECT_CLASS_NAME (klass),
9558 g_param_spec_ref_sink (pspec);
9559 g_param_spec_set_qdata (pspec, quark_property_parser, (gpointer) parser);
9560 g_param_spec_pool_insert (style_property_spec_pool, pspec, G_OBJECT_CLASS_TYPE (klass));
9564 * gtk_widget_class_install_style_property:
9565 * @klass: a #GtkWidgetClass
9566 * @pspec: the #GParamSpec for the property
9568 * Installs a style property on a widget class. The parser for the
9569 * style property is determined by the value type of @pspec.
9572 gtk_widget_class_install_style_property (GtkWidgetClass *klass,
9575 GtkRcPropertyParser parser;
9577 g_return_if_fail (GTK_IS_WIDGET_CLASS (klass));
9578 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
9580 parser = _gtk_rc_property_parser_from_type (G_PARAM_SPEC_VALUE_TYPE (pspec));
9582 gtk_widget_class_install_style_property_parser (klass, pspec, parser);
9586 * gtk_widget_class_find_style_property:
9587 * @klass: a #GtkWidgetClass
9588 * @property_name: the name of the style property to find
9589 * @returns: (allow-none): the #GParamSpec of the style property or %NULL if @class has no
9590 * style property with that name.
9592 * Finds a style property of a widget class by name.
9597 gtk_widget_class_find_style_property (GtkWidgetClass *klass,
9598 const gchar *property_name)
9600 g_return_val_if_fail (property_name != NULL, NULL);
9602 return g_param_spec_pool_lookup (style_property_spec_pool,
9604 G_OBJECT_CLASS_TYPE (klass),
9609 * gtk_widget_class_list_style_properties:
9610 * @klass: a #GtkWidgetClass
9611 * @n_properties: location to return the number of style properties found
9612 * @returns: an newly allocated array of #GParamSpec*. The array must
9613 * be freed with g_free().
9615 * Returns all style properties of a widget class.
9620 gtk_widget_class_list_style_properties (GtkWidgetClass *klass,
9621 guint *n_properties)
9623 GParamSpec **pspecs;
9626 pspecs = g_param_spec_pool_list (style_property_spec_pool,
9627 G_OBJECT_CLASS_TYPE (klass),
9636 * gtk_widget_style_get_property:
9637 * @widget: a #GtkWidget
9638 * @property_name: the name of a style property
9639 * @value: location to return the property value
9641 * Gets the value of a style property of @widget.
9644 gtk_widget_style_get_property (GtkWidget *widget,
9645 const gchar *property_name,
9650 g_return_if_fail (GTK_IS_WIDGET (widget));
9651 g_return_if_fail (property_name != NULL);
9652 g_return_if_fail (G_IS_VALUE (value));
9654 g_object_ref (widget);
9655 pspec = g_param_spec_pool_lookup (style_property_spec_pool,
9657 G_OBJECT_TYPE (widget),
9660 g_warning ("%s: widget class `%s' has no property named `%s'",
9662 G_OBJECT_TYPE_NAME (widget),
9666 const GValue *peek_value;
9668 peek_value = _gtk_style_peek_property_value (widget->style,
9669 G_OBJECT_TYPE (widget),
9671 (GtkRcPropertyParser) g_param_spec_get_qdata (pspec, quark_property_parser));
9673 /* auto-conversion of the caller's value type
9675 if (G_VALUE_TYPE (value) == G_PARAM_SPEC_VALUE_TYPE (pspec))
9676 g_value_copy (peek_value, value);
9677 else if (g_value_type_transformable (G_PARAM_SPEC_VALUE_TYPE (pspec), G_VALUE_TYPE (value)))
9678 g_value_transform (peek_value, value);
9680 g_warning ("can't retrieve style property `%s' of type `%s' as value of type `%s'",
9682 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
9683 G_VALUE_TYPE_NAME (value));
9685 g_object_unref (widget);
9689 * gtk_widget_style_get_valist:
9690 * @widget: a #GtkWidget
9691 * @first_property_name: the name of the first property to get
9692 * @var_args: a <type>va_list</type> of pairs of property names and
9693 * locations to return the property values, starting with the location
9694 * for @first_property_name.
9696 * Non-vararg variant of gtk_widget_style_get(). Used primarily by language
9700 gtk_widget_style_get_valist (GtkWidget *widget,
9701 const gchar *first_property_name,
9706 g_return_if_fail (GTK_IS_WIDGET (widget));
9708 g_object_ref (widget);
9710 name = first_property_name;
9713 const GValue *peek_value;
9717 pspec = g_param_spec_pool_lookup (style_property_spec_pool,
9719 G_OBJECT_TYPE (widget),
9723 g_warning ("%s: widget class `%s' has no property named `%s'",
9725 G_OBJECT_TYPE_NAME (widget),
9729 /* style pspecs are always readable so we can spare that check here */
9731 peek_value = _gtk_style_peek_property_value (widget->style,
9732 G_OBJECT_TYPE (widget),
9734 (GtkRcPropertyParser) g_param_spec_get_qdata (pspec, quark_property_parser));
9735 G_VALUE_LCOPY (peek_value, var_args, 0, &error);
9738 g_warning ("%s: %s", G_STRLOC, error);
9743 name = va_arg (var_args, gchar*);
9746 g_object_unref (widget);
9750 * gtk_widget_style_get:
9751 * @widget: a #GtkWidget
9752 * @first_property_name: the name of the first property to get
9753 * @Varargs: pairs of property names and locations to
9754 * return the property values, starting with the location for
9755 * @first_property_name, terminated by %NULL.
9757 * Gets the values of a multiple style properties of @widget.
9760 gtk_widget_style_get (GtkWidget *widget,
9761 const gchar *first_property_name,
9766 g_return_if_fail (GTK_IS_WIDGET (widget));
9768 va_start (var_args, first_property_name);
9769 gtk_widget_style_get_valist (widget, first_property_name, var_args);
9775 * @widget: a #GtkWidget
9776 * @path_length: (out) (allow-none): location to store length of the path, or %NULL
9777 * @path: (out) (allow-none): location to store allocated path string, or %NULL
9778 * @path_reversed: (out) (allow-none): location to store allocated reverse path string, or %NULL
9780 * Obtains the full path to @widget. The path is simply the name of a
9781 * widget and all its parents in the container hierarchy, separated by
9782 * periods. The name of a widget comes from
9783 * gtk_widget_get_name(). Paths are used to apply styles to a widget
9784 * in gtkrc configuration files. Widget names are the type of the
9785 * widget by default (e.g. "GtkButton") or can be set to an
9786 * application-specific value with gtk_widget_set_name(). By setting
9787 * the name of a widget, you allow users or theme authors to apply
9788 * styles to that specific widget in their gtkrc
9789 * file. @path_reversed_p fills in the path in reverse order,
9790 * i.e. starting with @widget's name instead of starting with the name
9791 * of @widget's outermost ancestor.
9794 gtk_widget_path (GtkWidget *widget,
9797 gchar **path_reversed)
9799 static gchar *rev_path = NULL;
9800 static guint tmp_path_len = 0;
9803 g_return_if_fail (GTK_IS_WIDGET (widget));
9808 const gchar *string;
9813 string = gtk_widget_get_name (widget);
9814 l = strlen (string);
9815 while (tmp_path_len <= len + l + 1)
9817 tmp_path_len += INIT_PATH_SIZE;
9818 rev_path = g_realloc (rev_path, tmp_path_len);
9826 widget = widget->parent;
9829 rev_path[len++] = '.';
9831 rev_path[len++] = 0;
9836 *path_length = len - 1;
9838 *path_reversed = g_strdup (rev_path);
9841 *path = g_strdup (rev_path);
9842 g_strreverse (*path);
9847 * gtk_widget_class_path:
9848 * @widget: a #GtkWidget
9849 * @path_length: (out) (allow-none): location to store the length of the class path, or %NULL
9850 * @path: (out) (allow-none) location to store the class path as an allocated string, or %NULL
9851 * @path_reversed: (out) (allow-none) location to store the reverse class path as an allocated
9854 * Same as gtk_widget_path(), but always uses the name of a widget's type,
9855 * never uses a custom name set with gtk_widget_set_name().
9859 gtk_widget_class_path (GtkWidget *widget,
9862 gchar **path_reversed)
9864 static gchar *rev_path = NULL;
9865 static guint tmp_path_len = 0;
9868 g_return_if_fail (GTK_IS_WIDGET (widget));
9873 const gchar *string;
9878 string = g_type_name (G_OBJECT_TYPE (widget));
9879 l = strlen (string);
9880 while (tmp_path_len <= len + l + 1)
9882 tmp_path_len += INIT_PATH_SIZE;
9883 rev_path = g_realloc (rev_path, tmp_path_len);
9891 widget = widget->parent;
9894 rev_path[len++] = '.';
9896 rev_path[len++] = 0;
9901 *path_length = len - 1;
9903 *path_reversed = g_strdup (rev_path);
9906 *path = g_strdup (rev_path);
9907 g_strreverse (*path);
9912 * gtk_requisition_copy:
9913 * @requisition: a #GtkRequisition
9915 * Copies a #GtkRequisition.
9917 * Returns: a copy of @requisition
9920 gtk_requisition_copy (const GtkRequisition *requisition)
9922 return (GtkRequisition *)g_memdup (requisition, sizeof (GtkRequisition));
9926 * gtk_requisition_free:
9927 * @requisition: a #GtkRequisition
9929 * Frees a #GtkRequisition.
9932 gtk_requisition_free (GtkRequisition *requisition)
9934 g_free (requisition);
9938 gtk_requisition_get_type (void)
9940 static GType our_type = 0;
9943 our_type = g_boxed_type_register_static (I_("GtkRequisition"),
9944 (GBoxedCopyFunc) gtk_requisition_copy,
9945 (GBoxedFreeFunc) gtk_requisition_free);
9951 * gtk_widget_get_accessible:
9952 * @widget: a #GtkWidget
9954 * Returns the accessible object that describes the widget to an
9955 * assistive technology.
9957 * If no accessibility library is loaded (i.e. no ATK implementation library is
9958 * loaded via <envar>GTK_MODULES</envar> or via another application library,
9959 * such as libgnome), then this #AtkObject instance may be a no-op. Likewise,
9960 * if no class-specific #AtkObject implementation is available for the widget
9961 * instance in question, it will inherit an #AtkObject implementation from the
9962 * first ancestor class for which such an implementation is defined.
9964 * The documentation of the <ulink url="http://developer.gnome.org/doc/API/2.0/atk/index.html">ATK</ulink>
9965 * library contains more information about accessible objects and their uses.
9967 * Returns: (transfer none): the #AtkObject associated with @widget
9970 gtk_widget_get_accessible (GtkWidget *widget)
9972 GtkWidgetClass *klass;
9974 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9976 klass = GTK_WIDGET_GET_CLASS (widget);
9978 g_return_val_if_fail (klass->get_accessible != NULL, NULL);
9980 return klass->get_accessible (widget);
9984 gtk_widget_real_get_accessible (GtkWidget *widget)
9986 AtkObject* accessible;
9988 accessible = g_object_get_qdata (G_OBJECT (widget),
9989 quark_accessible_object);
9992 AtkObjectFactory *factory;
9993 AtkRegistry *default_registry;
9995 default_registry = atk_get_default_registry ();
9996 factory = atk_registry_get_factory (default_registry,
9997 G_TYPE_FROM_INSTANCE (widget));
9999 atk_object_factory_create_accessible (factory,
10000 G_OBJECT (widget));
10001 g_object_set_qdata (G_OBJECT (widget),
10002 quark_accessible_object,
10009 * Initialize a AtkImplementorIface instance's virtual pointers as
10010 * appropriate to this implementor's class (GtkWidget).
10013 gtk_widget_accessible_interface_init (AtkImplementorIface *iface)
10015 iface->ref_accessible = gtk_widget_ref_accessible;
10019 gtk_widget_ref_accessible (AtkImplementor *implementor)
10021 AtkObject *accessible;
10023 accessible = gtk_widget_get_accessible (GTK_WIDGET (implementor));
10025 g_object_ref (accessible);
10030 * GtkBuildable implementation
10032 static GQuark quark_builder_has_default = 0;
10033 static GQuark quark_builder_has_focus = 0;
10034 static GQuark quark_builder_atk_relations = 0;
10035 static GQuark quark_builder_set_name = 0;
10038 gtk_widget_buildable_interface_init (GtkBuildableIface *iface)
10040 quark_builder_has_default = g_quark_from_static_string ("gtk-builder-has-default");
10041 quark_builder_has_focus = g_quark_from_static_string ("gtk-builder-has-focus");
10042 quark_builder_atk_relations = g_quark_from_static_string ("gtk-builder-atk-relations");
10043 quark_builder_set_name = g_quark_from_static_string ("gtk-builder-set-name");
10045 iface->set_name = gtk_widget_buildable_set_name;
10046 iface->get_name = gtk_widget_buildable_get_name;
10047 iface->get_internal_child = gtk_widget_buildable_get_internal_child;
10048 iface->set_buildable_property = gtk_widget_buildable_set_buildable_property;
10049 iface->parser_finished = gtk_widget_buildable_parser_finished;
10050 iface->custom_tag_start = gtk_widget_buildable_custom_tag_start;
10051 iface->custom_finished = gtk_widget_buildable_custom_finished;
10055 gtk_widget_buildable_set_name (GtkBuildable *buildable,
10058 g_object_set_qdata_full (G_OBJECT (buildable), quark_builder_set_name,
10059 g_strdup (name), g_free);
10062 static const gchar *
10063 gtk_widget_buildable_get_name (GtkBuildable *buildable)
10065 return g_object_get_qdata (G_OBJECT (buildable), quark_builder_set_name);
10069 gtk_widget_buildable_get_internal_child (GtkBuildable *buildable,
10070 GtkBuilder *builder,
10071 const gchar *childname)
10073 if (strcmp (childname, "accessible") == 0)
10074 return G_OBJECT (gtk_widget_get_accessible (GTK_WIDGET (buildable)));
10080 gtk_widget_buildable_set_buildable_property (GtkBuildable *buildable,
10081 GtkBuilder *builder,
10083 const GValue *value)
10085 if (strcmp (name, "has-default") == 0 && g_value_get_boolean (value))
10086 g_object_set_qdata (G_OBJECT (buildable), quark_builder_has_default,
10087 GINT_TO_POINTER (TRUE));
10088 else if (strcmp (name, "has-focus") == 0 && g_value_get_boolean (value))
10089 g_object_set_qdata (G_OBJECT (buildable), quark_builder_has_focus,
10090 GINT_TO_POINTER (TRUE));
10092 g_object_set_property (G_OBJECT (buildable), name, value);
10097 gchar *action_name;
10098 GString *description;
10100 gboolean translatable;
10110 free_action (AtkActionData *data, gpointer user_data)
10112 g_free (data->action_name);
10113 g_string_free (data->description, TRUE);
10114 g_free (data->context);
10115 g_slice_free (AtkActionData, data);
10119 free_relation (AtkRelationData *data, gpointer user_data)
10121 g_free (data->target);
10122 g_free (data->type);
10123 g_slice_free (AtkRelationData, data);
10127 gtk_widget_buildable_parser_finished (GtkBuildable *buildable,
10128 GtkBuilder *builder)
10130 GSList *atk_relations;
10132 if (g_object_get_qdata (G_OBJECT (buildable), quark_builder_has_default))
10133 gtk_widget_grab_default (GTK_WIDGET (buildable));
10134 if (g_object_get_qdata (G_OBJECT (buildable), quark_builder_has_focus))
10135 gtk_widget_grab_focus (GTK_WIDGET (buildable));
10137 atk_relations = g_object_get_qdata (G_OBJECT (buildable),
10138 quark_builder_atk_relations);
10141 AtkObject *accessible;
10142 AtkRelationSet *relation_set;
10145 AtkRelationType relation_type;
10146 AtkObject *target_accessible;
10148 accessible = gtk_widget_get_accessible (GTK_WIDGET (buildable));
10149 relation_set = atk_object_ref_relation_set (accessible);
10151 for (l = atk_relations; l; l = l->next)
10153 AtkRelationData *relation = (AtkRelationData*)l->data;
10155 target = gtk_builder_get_object (builder, relation->target);
10158 g_warning ("Target object %s in <relation> does not exist",
10162 target_accessible = gtk_widget_get_accessible (GTK_WIDGET (target));
10163 g_assert (target_accessible != NULL);
10165 relation_type = atk_relation_type_for_name (relation->type);
10166 if (relation_type == ATK_RELATION_NULL)
10168 g_warning ("<relation> type %s not found",
10172 atk_relation_set_add_relation_by_type (relation_set, relation_type,
10173 target_accessible);
10175 g_object_unref (relation_set);
10177 g_slist_foreach (atk_relations, (GFunc)free_relation, NULL);
10178 g_slist_free (atk_relations);
10179 g_object_set_qdata (G_OBJECT (buildable), quark_builder_atk_relations,
10188 } AccessibilitySubParserData;
10191 accessibility_start_element (GMarkupParseContext *context,
10192 const gchar *element_name,
10193 const gchar **names,
10194 const gchar **values,
10195 gpointer user_data,
10198 AccessibilitySubParserData *data = (AccessibilitySubParserData*)user_data;
10200 gint line_number, char_number;
10202 if (strcmp (element_name, "relation") == 0)
10204 gchar *target = NULL;
10205 gchar *type = NULL;
10206 AtkRelationData *relation;
10208 for (i = 0; names[i]; i++)
10210 if (strcmp (names[i], "target") == 0)
10211 target = g_strdup (values[i]);
10212 else if (strcmp (names[i], "type") == 0)
10213 type = g_strdup (values[i]);
10216 g_markup_parse_context_get_position (context,
10219 g_set_error (error,
10221 GTK_BUILDER_ERROR_INVALID_ATTRIBUTE,
10222 "%s:%d:%d '%s' is not a valid attribute of <%s>",
10224 line_number, char_number, names[i], "relation");
10231 if (!target || !type)
10233 g_markup_parse_context_get_position (context,
10236 g_set_error (error,
10238 GTK_BUILDER_ERROR_MISSING_ATTRIBUTE,
10239 "%s:%d:%d <%s> requires attribute \"%s\"",
10241 line_number, char_number, "relation",
10242 type ? "target" : "type");
10248 relation = g_slice_new (AtkRelationData);
10249 relation->target = target;
10250 relation->type = type;
10252 data->relations = g_slist_prepend (data->relations, relation);
10254 else if (strcmp (element_name, "action") == 0)
10256 const gchar *action_name = NULL;
10257 const gchar *description = NULL;
10258 const gchar *msg_context = NULL;
10259 gboolean translatable = FALSE;
10260 AtkActionData *action;
10262 for (i = 0; names[i]; i++)
10264 if (strcmp (names[i], "action_name") == 0)
10265 action_name = values[i];
10266 else if (strcmp (names[i], "description") == 0)
10267 description = values[i];
10268 else if (strcmp (names[i], "translatable") == 0)
10270 if (!_gtk_builder_boolean_from_string (values[i], &translatable, error))
10273 else if (strcmp (names[i], "comments") == 0)
10275 /* do nothing, comments are for translators */
10277 else if (strcmp (names[i], "context") == 0)
10278 msg_context = values[i];
10281 g_markup_parse_context_get_position (context,
10284 g_set_error (error,
10286 GTK_BUILDER_ERROR_INVALID_ATTRIBUTE,
10287 "%s:%d:%d '%s' is not a valid attribute of <%s>",
10289 line_number, char_number, names[i], "action");
10296 g_markup_parse_context_get_position (context,
10299 g_set_error (error,
10301 GTK_BUILDER_ERROR_MISSING_ATTRIBUTE,
10302 "%s:%d:%d <%s> requires attribute \"%s\"",
10304 line_number, char_number, "action",
10309 action = g_slice_new (AtkActionData);
10310 action->action_name = g_strdup (action_name);
10311 action->description = g_string_new (description);
10312 action->context = g_strdup (msg_context);
10313 action->translatable = translatable;
10315 data->actions = g_slist_prepend (data->actions, action);
10317 else if (strcmp (element_name, "accessibility") == 0)
10320 g_warning ("Unsupported tag for GtkWidget: %s\n", element_name);
10324 accessibility_text (GMarkupParseContext *context,
10327 gpointer user_data,
10330 AccessibilitySubParserData *data = (AccessibilitySubParserData*)user_data;
10332 if (strcmp (g_markup_parse_context_get_element (context), "action") == 0)
10334 AtkActionData *action = data->actions->data;
10336 g_string_append_len (action->description, text, text_len);
10340 static const GMarkupParser accessibility_parser =
10342 accessibility_start_element,
10344 accessibility_text,
10353 } AccelGroupParserData;
10356 accel_group_start_element (GMarkupParseContext *context,
10357 const gchar *element_name,
10358 const gchar **names,
10359 const gchar **values,
10360 gpointer user_data,
10365 guint modifiers = 0;
10366 gchar *signal = NULL;
10367 AccelGroupParserData *parser_data = (AccelGroupParserData*)user_data;
10369 for (i = 0; names[i]; i++)
10371 if (strcmp (names[i], "key") == 0)
10372 key = gdk_keyval_from_name (values[i]);
10373 else if (strcmp (names[i], "modifiers") == 0)
10375 if (!_gtk_builder_flags_from_string (GDK_TYPE_MODIFIER_TYPE,
10381 else if (strcmp (names[i], "signal") == 0)
10382 signal = g_strdup (values[i]);
10385 if (key == 0 || signal == NULL)
10387 g_warning ("<accelerator> requires key and signal attributes");
10390 parser_data->key = key;
10391 parser_data->modifiers = modifiers;
10392 parser_data->signal = signal;
10395 static const GMarkupParser accel_group_parser =
10397 accel_group_start_element,
10401 gtk_widget_buildable_custom_tag_start (GtkBuildable *buildable,
10402 GtkBuilder *builder,
10404 const gchar *tagname,
10405 GMarkupParser *parser,
10408 g_assert (buildable);
10410 if (strcmp (tagname, "accelerator") == 0)
10412 AccelGroupParserData *parser_data;
10414 parser_data = g_slice_new0 (AccelGroupParserData);
10415 parser_data->object = g_object_ref (buildable);
10416 *parser = accel_group_parser;
10417 *data = parser_data;
10420 if (strcmp (tagname, "accessibility") == 0)
10422 AccessibilitySubParserData *parser_data;
10424 parser_data = g_slice_new0 (AccessibilitySubParserData);
10425 *parser = accessibility_parser;
10426 *data = parser_data;
10433 _gtk_widget_buildable_finish_accelerator (GtkWidget *widget,
10434 GtkWidget *toplevel,
10435 gpointer user_data)
10437 AccelGroupParserData *accel_data;
10438 GSList *accel_groups;
10439 GtkAccelGroup *accel_group;
10441 g_return_if_fail (GTK_IS_WIDGET (widget));
10442 g_return_if_fail (GTK_IS_WIDGET (toplevel));
10443 g_return_if_fail (user_data != NULL);
10445 accel_data = (AccelGroupParserData*)user_data;
10446 accel_groups = gtk_accel_groups_from_object (G_OBJECT (toplevel));
10447 if (g_slist_length (accel_groups) == 0)
10449 accel_group = gtk_accel_group_new ();
10450 gtk_window_add_accel_group (GTK_WINDOW (toplevel), accel_group);
10454 g_assert (g_slist_length (accel_groups) == 1);
10455 accel_group = g_slist_nth_data (accel_groups, 0);
10458 gtk_widget_add_accelerator (GTK_WIDGET (accel_data->object),
10459 accel_data->signal,
10462 accel_data->modifiers,
10463 GTK_ACCEL_VISIBLE);
10465 g_object_unref (accel_data->object);
10466 g_free (accel_data->signal);
10467 g_slice_free (AccelGroupParserData, accel_data);
10471 gtk_widget_buildable_custom_finished (GtkBuildable *buildable,
10472 GtkBuilder *builder,
10474 const gchar *tagname,
10475 gpointer user_data)
10477 AccelGroupParserData *accel_data;
10478 AccessibilitySubParserData *a11y_data;
10479 GtkWidget *toplevel;
10481 if (strcmp (tagname, "accelerator") == 0)
10483 accel_data = (AccelGroupParserData*)user_data;
10484 g_assert (accel_data->object);
10486 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (accel_data->object));
10488 _gtk_widget_buildable_finish_accelerator (GTK_WIDGET (buildable), toplevel, user_data);
10490 else if (strcmp (tagname, "accessibility") == 0)
10492 a11y_data = (AccessibilitySubParserData*)user_data;
10494 if (a11y_data->actions)
10496 AtkObject *accessible;
10501 accessible = gtk_widget_get_accessible (GTK_WIDGET (buildable));
10503 action = ATK_ACTION (accessible);
10504 n_actions = atk_action_get_n_actions (action);
10506 for (l = a11y_data->actions; l; l = l->next)
10508 AtkActionData *action_data = (AtkActionData*)l->data;
10510 for (i = 0; i < n_actions; i++)
10511 if (strcmp (atk_action_get_name (action, i),
10512 action_data->action_name) == 0)
10517 gchar *description;
10519 if (action_data->translatable && action_data->description->len)
10520 description = _gtk_builder_parser_translate (gtk_builder_get_translation_domain (builder),
10521 action_data->context,
10522 action_data->description->str);
10524 description = action_data->description->str;
10526 atk_action_set_description (action, i, description);
10530 g_slist_foreach (a11y_data->actions, (GFunc)free_action, NULL);
10531 g_slist_free (a11y_data->actions);
10534 if (a11y_data->relations)
10535 g_object_set_qdata (G_OBJECT (buildable), quark_builder_atk_relations,
10536 a11y_data->relations);
10538 g_slice_free (AccessibilitySubParserData, a11y_data);
10543 * GtkExtendedLayout implementation
10546 gtk_widget_real_get_desired_width (GtkExtendedLayout *layout,
10547 gint *minimum_size,
10548 gint *natural_size)
10550 /* Set the initial values so that unimplemented classes will fall back
10551 * on the "size-request" collected values (see gtksizegroup.c:do_size_request()).
10554 *minimum_size = GTK_WIDGET (layout)->requisition.width;
10557 *natural_size = GTK_WIDGET (layout)->requisition.width;
10561 gtk_widget_real_get_desired_height (GtkExtendedLayout *layout,
10562 gint *minimum_size,
10563 gint *natural_size)
10565 /* Set the initial values so that unimplemented classes will fall back
10566 * on the "size-request" collected values (see gtksizegroup.c:do_size_request()).
10569 *minimum_size = GTK_WIDGET (layout)->requisition.height;
10572 *natural_size = GTK_WIDGET (layout)->requisition.height;
10576 gtk_widget_real_get_height_for_width (GtkExtendedLayout *layout,
10578 gint *minimum_height,
10579 gint *natural_height)
10581 gtk_extended_layout_get_desired_height (layout, minimum_height, natural_height);
10585 gtk_widget_real_get_width_for_height (GtkExtendedLayout *layout,
10587 gint *minimum_width,
10588 gint *natural_width)
10590 gtk_extended_layout_get_desired_width (layout, minimum_width, natural_width);
10594 gtk_widget_extended_layout_init (GtkExtendedLayoutIface *iface)
10596 iface->get_desired_width = gtk_widget_real_get_desired_width;
10597 iface->get_desired_height = gtk_widget_real_get_desired_height;
10598 iface->get_width_for_height = gtk_widget_real_get_width_for_height;
10599 iface->get_height_for_width = gtk_widget_real_get_height_for_width;
10604 * gtk_widget_get_clipboard:
10605 * @widget: a #GtkWidget
10606 * @selection: a #GdkAtom which identifies the clipboard
10607 * to use. %GDK_SELECTION_CLIPBOARD gives the
10608 * default clipboard. Another common value
10609 * is %GDK_SELECTION_PRIMARY, which gives
10610 * the primary X selection.
10612 * Returns the clipboard object for the given selection to
10613 * be used with @widget. @widget must have a #GdkDisplay
10614 * associated with it, so must be attached to a toplevel
10617 * Return value: (transfer none): the appropriate clipboard object. If no
10618 * clipboard already exists, a new one will
10619 * be created. Once a clipboard object has
10620 * been created, it is persistent for all time.
10625 gtk_widget_get_clipboard (GtkWidget *widget, GdkAtom selection)
10627 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10628 g_return_val_if_fail (gtk_widget_has_screen (widget), NULL);
10630 return gtk_clipboard_get_for_display (gtk_widget_get_display (widget),
10635 * gtk_widget_list_mnemonic_labels:
10636 * @widget: a #GtkWidget
10638 * Returns a newly allocated list of the widgets, normally labels, for
10639 * which this widget is a the target of a mnemonic (see for example,
10640 * gtk_label_set_mnemonic_widget()).
10642 * The widgets in the list are not individually referenced. If you
10643 * want to iterate through the list and perform actions involving
10644 * callbacks that might destroy the widgets, you
10645 * <emphasis>must</emphasis> call <literal>g_list_foreach (result,
10646 * (GFunc)g_object_ref, NULL)</literal> first, and then unref all the
10647 * widgets afterwards.
10649 * Return value: (element-type GtkWidget) (transfer container): the list of
10650 * mnemonic labels; free this list
10651 * with g_list_free() when you are done with it.
10656 gtk_widget_list_mnemonic_labels (GtkWidget *widget)
10658 GList *list = NULL;
10661 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10663 for (l = g_object_get_qdata (G_OBJECT (widget), quark_mnemonic_labels); l; l = l->next)
10664 list = g_list_prepend (list, l->data);
10670 * gtk_widget_add_mnemonic_label:
10671 * @widget: a #GtkWidget
10672 * @label: a #GtkWidget that acts as a mnemonic label for @widget
10674 * Adds a widget to the list of mnemonic labels for
10675 * this widget. (See gtk_widget_list_mnemonic_labels()). Note the
10676 * list of mnemonic labels for the widget is cleared when the
10677 * widget is destroyed, so the caller must make sure to update
10678 * its internal state at this point as well, by using a connection
10679 * to the #GtkWidget::destroy signal or a weak notifier.
10684 gtk_widget_add_mnemonic_label (GtkWidget *widget,
10687 GSList *old_list, *new_list;
10689 g_return_if_fail (GTK_IS_WIDGET (widget));
10690 g_return_if_fail (GTK_IS_WIDGET (label));
10692 old_list = g_object_steal_qdata (G_OBJECT (widget), quark_mnemonic_labels);
10693 new_list = g_slist_prepend (old_list, label);
10695 g_object_set_qdata_full (G_OBJECT (widget), quark_mnemonic_labels,
10696 new_list, (GDestroyNotify) g_slist_free);
10700 * gtk_widget_remove_mnemonic_label:
10701 * @widget: a #GtkWidget
10702 * @label: a #GtkWidget that was previously set as a mnemnic label for
10703 * @widget with gtk_widget_add_mnemonic_label().
10705 * Removes a widget from the list of mnemonic labels for
10706 * this widget. (See gtk_widget_list_mnemonic_labels()). The widget
10707 * must have previously been added to the list with
10708 * gtk_widget_add_mnemonic_label().
10713 gtk_widget_remove_mnemonic_label (GtkWidget *widget,
10716 GSList *old_list, *new_list;
10718 g_return_if_fail (GTK_IS_WIDGET (widget));
10719 g_return_if_fail (GTK_IS_WIDGET (label));
10721 old_list = g_object_steal_qdata (G_OBJECT (widget), quark_mnemonic_labels);
10722 new_list = g_slist_remove (old_list, label);
10725 g_object_set_qdata_full (G_OBJECT (widget), quark_mnemonic_labels,
10726 new_list, (GDestroyNotify) g_slist_free);
10730 * gtk_widget_get_no_show_all:
10731 * @widget: a #GtkWidget
10733 * Returns the current value of the GtkWidget:no-show-all property,
10734 * which determines whether calls to gtk_widget_show_all() and
10735 * gtk_widget_hide_all() will affect this widget.
10737 * Return value: the current value of the "no-show-all" property.
10742 gtk_widget_get_no_show_all (GtkWidget *widget)
10744 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
10746 return (GTK_OBJECT_FLAGS (widget) & GTK_NO_SHOW_ALL) != 0;
10750 * gtk_widget_set_no_show_all:
10751 * @widget: a #GtkWidget
10752 * @no_show_all: the new value for the "no-show-all" property
10754 * Sets the #GtkWidget:no-show-all property, which determines whether
10755 * calls to gtk_widget_show_all() and gtk_widget_hide_all() will affect
10758 * This is mostly for use in constructing widget hierarchies with externally
10759 * controlled visibility, see #GtkUIManager.
10764 gtk_widget_set_no_show_all (GtkWidget *widget,
10765 gboolean no_show_all)
10767 g_return_if_fail (GTK_IS_WIDGET (widget));
10769 no_show_all = (no_show_all != FALSE);
10771 if (no_show_all == gtk_widget_get_no_show_all (widget))
10775 GTK_OBJECT_FLAGS (widget) |= GTK_NO_SHOW_ALL;
10777 GTK_OBJECT_FLAGS (widget) &= ~(GTK_NO_SHOW_ALL);
10779 g_object_notify (G_OBJECT (widget), "no-show-all");
10784 gtk_widget_real_set_has_tooltip (GtkWidget *widget,
10785 gboolean has_tooltip,
10788 gboolean priv_has_tooltip;
10790 priv_has_tooltip = GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (widget),
10791 quark_has_tooltip));
10793 if (priv_has_tooltip != has_tooltip || force)
10795 priv_has_tooltip = has_tooltip;
10797 if (priv_has_tooltip)
10799 if (gtk_widget_get_realized (widget) && !gtk_widget_get_has_window (widget))
10800 gdk_window_set_events (widget->window,
10801 gdk_window_get_events (widget->window) |
10802 GDK_LEAVE_NOTIFY_MASK |
10803 GDK_POINTER_MOTION_MASK |
10804 GDK_POINTER_MOTION_HINT_MASK);
10806 if (gtk_widget_get_has_window (widget))
10807 gtk_widget_add_events (widget,
10808 GDK_LEAVE_NOTIFY_MASK |
10809 GDK_POINTER_MOTION_MASK |
10810 GDK_POINTER_MOTION_HINT_MASK);
10813 g_object_set_qdata (G_OBJECT (widget), quark_has_tooltip,
10814 GUINT_TO_POINTER (priv_has_tooltip));
10819 * gtk_widget_set_tooltip_window:
10820 * @widget: a #GtkWidget
10821 * @custom_window: (allow-none): a #GtkWindow, or %NULL
10823 * Replaces the default, usually yellow, window used for displaying
10824 * tooltips with @custom_window. GTK+ will take care of showing and
10825 * hiding @custom_window at the right moment, to behave likewise as
10826 * the default tooltip window. If @custom_window is %NULL, the default
10827 * tooltip window will be used.
10829 * If the custom window should have the default theming it needs to
10830 * have the name "gtk-tooltip", see gtk_widget_set_name().
10835 gtk_widget_set_tooltip_window (GtkWidget *widget,
10836 GtkWindow *custom_window)
10838 gboolean has_tooltip;
10839 gchar *tooltip_markup;
10841 g_return_if_fail (GTK_IS_WIDGET (widget));
10842 g_return_if_fail (custom_window == NULL || GTK_IS_WINDOW (custom_window));
10844 tooltip_markup = g_object_get_qdata (G_OBJECT (widget), quark_tooltip_markup);
10847 g_object_ref (custom_window);
10849 g_object_set_qdata_full (G_OBJECT (widget), quark_tooltip_window,
10850 custom_window, g_object_unref);
10852 has_tooltip = (custom_window != NULL || tooltip_markup != NULL);
10853 gtk_widget_real_set_has_tooltip (widget, has_tooltip, FALSE);
10855 if (has_tooltip && gtk_widget_get_visible (widget))
10856 gtk_widget_queue_tooltip_query (widget);
10860 * gtk_widget_get_tooltip_window:
10861 * @widget: a #GtkWidget
10863 * Returns the #GtkWindow of the current tooltip. This can be the
10864 * GtkWindow created by default, or the custom tooltip window set
10865 * using gtk_widget_set_tooltip_window().
10867 * Return value: (transfer none): The #GtkWindow of the current tooltip.
10872 gtk_widget_get_tooltip_window (GtkWidget *widget)
10874 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10876 return g_object_get_qdata (G_OBJECT (widget), quark_tooltip_window);
10880 * gtk_widget_trigger_tooltip_query:
10881 * @widget: a #GtkWidget
10883 * Triggers a tooltip query on the display where the toplevel of @widget
10884 * is located. See gtk_tooltip_trigger_tooltip_query() for more
10890 gtk_widget_trigger_tooltip_query (GtkWidget *widget)
10892 gtk_tooltip_trigger_tooltip_query (gtk_widget_get_display (widget));
10895 static guint tooltip_query_id;
10896 static GSList *tooltip_query_displays;
10899 tooltip_query_idle (gpointer data)
10901 g_slist_foreach (tooltip_query_displays, (GFunc)gtk_tooltip_trigger_tooltip_query, NULL);
10902 g_slist_foreach (tooltip_query_displays, (GFunc)g_object_unref, NULL);
10903 g_slist_free (tooltip_query_displays);
10905 tooltip_query_displays = NULL;
10906 tooltip_query_id = 0;
10912 gtk_widget_queue_tooltip_query (GtkWidget *widget)
10914 GdkDisplay *display;
10916 display = gtk_widget_get_display (widget);
10918 if (!g_slist_find (tooltip_query_displays, display))
10919 tooltip_query_displays = g_slist_prepend (tooltip_query_displays, g_object_ref (display));
10921 if (tooltip_query_id == 0)
10922 tooltip_query_id = gdk_threads_add_idle (tooltip_query_idle, NULL);
10926 * gtk_widget_set_tooltip_text:
10927 * @widget: a #GtkWidget
10928 * @text: the contents of the tooltip for @widget
10930 * Sets @text as the contents of the tooltip. This function will take
10931 * care of setting GtkWidget:has-tooltip to %TRUE and of the default
10932 * handler for the GtkWidget::query-tooltip signal.
10934 * See also the GtkWidget:tooltip-text property and gtk_tooltip_set_text().
10939 gtk_widget_set_tooltip_text (GtkWidget *widget,
10942 g_return_if_fail (GTK_IS_WIDGET (widget));
10944 g_object_set (G_OBJECT (widget), "tooltip-text", text, NULL);
10948 * gtk_widget_get_tooltip_text:
10949 * @widget: a #GtkWidget
10951 * Gets the contents of the tooltip for @widget.
10953 * Return value: the tooltip text, or %NULL. You should free the
10954 * returned string with g_free() when done.
10959 gtk_widget_get_tooltip_text (GtkWidget *widget)
10961 gchar *text = NULL;
10963 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10965 g_object_get (G_OBJECT (widget), "tooltip-text", &text, NULL);
10971 * gtk_widget_set_tooltip_markup:
10972 * @widget: a #GtkWidget
10973 * @markup: (allow-none): the contents of the tooltip for @widget, or %NULL
10975 * Sets @markup as the contents of the tooltip, which is marked up with
10976 * the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
10978 * This function will take care of setting GtkWidget:has-tooltip to %TRUE
10979 * and of the default handler for the GtkWidget::query-tooltip signal.
10981 * See also the GtkWidget:tooltip-markup property and
10982 * gtk_tooltip_set_markup().
10987 gtk_widget_set_tooltip_markup (GtkWidget *widget,
10988 const gchar *markup)
10990 g_return_if_fail (GTK_IS_WIDGET (widget));
10992 g_object_set (G_OBJECT (widget), "tooltip-markup", markup, NULL);
10996 * gtk_widget_get_tooltip_markup:
10997 * @widget: a #GtkWidget
10999 * Gets the contents of the tooltip for @widget.
11001 * Return value: the tooltip text, or %NULL. You should free the
11002 * returned string with g_free() when done.
11007 gtk_widget_get_tooltip_markup (GtkWidget *widget)
11009 gchar *text = NULL;
11011 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
11013 g_object_get (G_OBJECT (widget), "tooltip-markup", &text, NULL);
11019 * gtk_widget_set_has_tooltip:
11020 * @widget: a #GtkWidget
11021 * @has_tooltip: whether or not @widget has a tooltip.
11023 * Sets the has-tooltip property on @widget to @has_tooltip. See
11024 * GtkWidget:has-tooltip for more information.
11029 gtk_widget_set_has_tooltip (GtkWidget *widget,
11030 gboolean has_tooltip)
11032 g_return_if_fail (GTK_IS_WIDGET (widget));
11034 g_object_set (G_OBJECT (widget), "has-tooltip", has_tooltip, NULL);
11038 * gtk_widget_get_has_tooltip:
11039 * @widget: a #GtkWidget
11041 * Returns the current value of the has-tooltip property. See
11042 * GtkWidget:has-tooltip for more information.
11044 * Return value: current value of has-tooltip on @widget.
11049 gtk_widget_get_has_tooltip (GtkWidget *widget)
11051 gboolean has_tooltip = FALSE;
11053 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
11055 g_object_get (G_OBJECT (widget), "has-tooltip", &has_tooltip, NULL);
11057 return has_tooltip;
11061 * gtk_widget_get_allocation:
11062 * @widget: a #GtkWidget
11063 * @allocation: (out): a pointer to a #GtkAllocation to copy to
11065 * Retrieves the widget's allocation.
11070 gtk_widget_get_allocation (GtkWidget *widget,
11071 GtkAllocation *allocation)
11073 g_return_if_fail (GTK_IS_WIDGET (widget));
11074 g_return_if_fail (allocation != NULL);
11076 *allocation = widget->allocation;
11080 * gtk_widget_set_allocation:
11081 * @widget: a #GtkWidget
11082 * @allocation: a pointer to a #GtkAllocation to copy from
11084 * Sets the widget's allocation. This should not be used
11085 * directly, but from within a widget's size_allocate method.
11090 gtk_widget_set_allocation (GtkWidget *widget,
11091 const GtkAllocation *allocation)
11093 g_return_if_fail (GTK_IS_WIDGET (widget));
11094 g_return_if_fail (allocation != NULL);
11096 widget->allocation = *allocation;
11100 * gtk_widget_get_requisition:
11101 * @widget: a #GtkWidget
11102 * @requisition: (out): a pointer to a #GtkRequisition to copy to
11104 * Retrieves the widget's requisition.
11106 * This function should only be used by widget implementations in
11107 * order to figure whether the widget's requisition has actually
11108 * changed after some internal state change (so that they can call
11109 * gtk_widget_queue_resize() instead of gtk_widget_queue_draw()).
11111 * Normally, gtk_widget_size_request() should be used.
11116 gtk_widget_get_requisition (GtkWidget *widget,
11117 GtkRequisition *requisition)
11119 g_return_if_fail (GTK_IS_WIDGET (widget));
11120 g_return_if_fail (requisition != NULL);
11122 *requisition = widget->requisition;
11126 * gtk_widget_set_window:
11127 * @widget: a #GtkWidget
11128 * @window: a #GdkWindow
11130 * Sets a widget's window. This function should only be used in a
11131 * widget's GtkWidget::realize() implementation. The %window passed is
11132 * usually either new window created with gdk_window_new(), or the
11133 * window of its parent widget as returned by
11134 * gtk_widget_get_parent_window().
11136 * Widgets must indicate whether they will create their own #GdkWindow
11137 * by calling gtk_widget_set_has_window(). This is usually done in the
11138 * widget's init() function.
11143 gtk_widget_set_window (GtkWidget *widget,
11146 g_return_if_fail (GTK_IS_WIDGET (widget));
11147 g_return_if_fail (window == NULL || GDK_IS_WINDOW (window));
11149 if (widget->window != window)
11151 widget->window = window;
11152 g_object_notify (G_OBJECT (widget), "window");
11157 * gtk_widget_get_window:
11158 * @widget: a #GtkWidget
11160 * Returns the widget's window if it is realized, %NULL otherwise
11162 * Return value: @widget's window.
11167 gtk_widget_get_window (GtkWidget *widget)
11169 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
11171 return widget->window;
11175 _gtk_widget_set_has_focus (GtkWidget *widget,
11176 gboolean has_focus)
11179 GTK_OBJECT_FLAGS (widget) |= GTK_HAS_FOCUS;
11181 GTK_OBJECT_FLAGS (widget) &= ~(GTK_HAS_FOCUS);
11185 * gtk_widget_send_focus_change:
11186 * @widget: a #GtkWidget
11187 * @event: a #GdkEvent of type GDK_FOCUS_CHANGE
11189 * Sends the focus change @event to @widget
11191 * This function is not meant to be used by applications. The only time it
11192 * should be used is when it is necessary for a #GtkWidget to assign focus
11193 * to a widget that is semantically owned by the first widget even though
11194 * it's not a direct child - for instance, a search entry in a floating
11195 * window similar to the quick search in #GtkTreeView.
11197 * An example of its usage is:
11200 * GdkEvent *fevent = gdk_event_new (GDK_FOCUS_CHANGE);
11202 * fevent->focus_change.type = GDK_FOCUS_CHANGE;
11203 * fevent->focus_change.in = TRUE;
11204 * fevent->focus_change.window = gtk_widget_get_window (widget);
11205 * if (fevent->focus_change.window != NULL)
11206 * g_object_ref (fevent->focus_change.window);
11208 * gtk_widget_send_focus_change (widget, fevent);
11210 * gdk_event_free (event);
11213 * Return value: the return value from the event signal emission: %TRUE
11214 * if the event was handled, and %FALSE otherwise
11219 gtk_widget_send_focus_change (GtkWidget *widget,
11224 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
11225 g_return_val_if_fail (event != NULL && event->type == GDK_FOCUS_CHANGE, FALSE);
11227 g_object_ref (widget);
11229 _gtk_widget_set_has_focus (widget, event->focus_change.in);
11231 res = gtk_widget_event (widget, event);
11233 g_object_notify (G_OBJECT (widget), "has-focus");
11235 g_object_unref (widget);
11240 #define __GTK_WIDGET_C__
11241 #include "gtkaliasdef.c"