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"
60 * @Short_description: Base class for all widgets
63 * GtkWidget is the base class all widgets in GTK+ derive from. It manages the
64 * widget lifecycle, states and style.
65 * <refsect2 id="style-properties">
67 * <structname>GtkWidget</structname> introduces <firstterm>style
68 * properties</firstterm> - these are basically object properties that are stored
69 * not on the object, but in the style object associated to the widget. Style
70 * properties are set in <link linkend="gtk-Resource-Files">resource files</link>.
71 * This mechanism is used for configuring such things as the location of the
72 * scrollbar arrows through the theme, giving theme authors more control over the
73 * look of applications without the need to write a theme engine in C.
76 * Use gtk_widget_class_install_style_property() to install style properties for
77 * a widget class, gtk_widget_class_find_style_property() or
78 * gtk_widget_class_list_style_properties() to get information about existing
79 * style properties and gtk_widget_style_get_property(), gtk_widget_style_get() or
80 * gtk_widget_style_get_valist() to obtain the value of a style property.
83 * <refsect2 id="GtkWidget-BUILDER-UI">
84 * <title>GtkWidget as GtkBuildable</title>
86 * The GtkWidget implementation of the GtkBuildable interface supports a
87 * custom <accelerator> element, which has attributes named key,
88 * modifiers and signal and allows to specify accelerators.
91 * <title>A UI definition fragment specifying an accelerator</title>
92 * <programlisting><![CDATA[
93 * <object class="GtkButton">
94 * <accelerator key="q" modifiers="GDK_CONTROL_MASK" signal="clicked"/>
96 * ]]></programlisting>
99 * In addition to accelerators, <structname>GtkWidget</structname> also support a
100 * custom <accessible> element, which supports actions and relations.
101 * Properties on the accessible implementation of an object can be set by accessing the
102 * internal child "accessible" of a <structname>GtkWidget</structname>.
105 * <title>A UI definition fragment specifying an accessible</title>
106 * <programlisting><![CDATA[
107 * <object class="GtkButton" id="label1"/>
108 * <property name="label">I am a Label for a Button</property>
110 * <object class="GtkButton" id="button1">
112 * <action action_name="click" translatable="yes">Click the button.</action>
113 * <relation target="label1" type="labelled-by"/>
115 * <child internal-child="accessible">
116 * <object class="AtkObject" id="a11y-button1">
117 * <property name="AtkObject::name">Clickable Button</property>
121 * ]]></programlisting>
126 #define WIDGET_CLASS(w) GTK_WIDGET_GET_CLASS (w)
127 #define INIT_PATH_SIZE (512)
153 BUTTON_RELEASE_EVENT,
168 PROPERTY_NOTIFY_EVENT,
169 SELECTION_CLEAR_EVENT,
170 SELECTION_REQUEST_EVENT,
171 SELECTION_NOTIFY_EVENT,
186 VISIBILITY_NOTIFY_EVENT,
190 ACCEL_CLOSURES_CHANGED,
216 PROP_RECEIVES_DEFAULT,
217 PROP_COMPOSITE_CHILD,
220 PROP_EXTENSION_EVENTS,
229 typedef struct _GtkStateData GtkStateData;
234 guint state_restoration : 1;
235 guint parent_sensitive : 1;
236 guint use_forall : 1;
239 /* --- prototypes --- */
240 static void gtk_widget_class_init (GtkWidgetClass *klass);
241 static void gtk_widget_base_class_finalize (GtkWidgetClass *klass);
242 static void gtk_widget_init (GtkWidget *widget);
243 static void gtk_widget_set_property (GObject *object,
247 static void gtk_widget_get_property (GObject *object,
251 static void gtk_widget_dispose (GObject *object);
252 static void gtk_widget_real_destroy (GtkObject *object);
253 static void gtk_widget_finalize (GObject *object);
254 static void gtk_widget_real_show (GtkWidget *widget);
255 static void gtk_widget_real_hide (GtkWidget *widget);
256 static void gtk_widget_real_map (GtkWidget *widget);
257 static void gtk_widget_real_unmap (GtkWidget *widget);
258 static void gtk_widget_real_realize (GtkWidget *widget);
259 static void gtk_widget_real_unrealize (GtkWidget *widget);
260 static void gtk_widget_real_size_request (GtkWidget *widget,
261 GtkRequisition *requisition);
262 static void gtk_widget_real_size_allocate (GtkWidget *widget,
263 GtkAllocation *allocation);
264 static void gtk_widget_real_style_set (GtkWidget *widget,
265 GtkStyle *previous_style);
266 static void gtk_widget_real_direction_changed(GtkWidget *widget,
267 GtkTextDirection previous_direction);
269 static void gtk_widget_real_grab_focus (GtkWidget *focus_widget);
270 static gboolean gtk_widget_real_query_tooltip (GtkWidget *widget,
273 gboolean keyboard_tip,
274 GtkTooltip *tooltip);
275 static gboolean gtk_widget_real_show_help (GtkWidget *widget,
276 GtkWidgetHelpType help_type);
278 static void gtk_widget_dispatch_child_properties_changed (GtkWidget *object,
280 GParamSpec **pspecs);
281 static gboolean gtk_widget_real_key_press_event (GtkWidget *widget,
283 static gboolean gtk_widget_real_key_release_event (GtkWidget *widget,
285 static gboolean gtk_widget_real_focus_in_event (GtkWidget *widget,
286 GdkEventFocus *event);
287 static gboolean gtk_widget_real_focus_out_event (GtkWidget *widget,
288 GdkEventFocus *event);
289 static gboolean gtk_widget_real_focus (GtkWidget *widget,
290 GtkDirectionType direction);
291 static void gtk_widget_real_move_focus (GtkWidget *widget,
292 GtkDirectionType direction);
293 static gboolean gtk_widget_real_keynav_failed (GtkWidget *widget,
294 GtkDirectionType direction);
295 static PangoContext* gtk_widget_peek_pango_context (GtkWidget *widget);
296 static void gtk_widget_update_pango_context (GtkWidget *widget);
297 static void gtk_widget_propagate_state (GtkWidget *widget,
299 static void gtk_widget_reset_rc_style (GtkWidget *widget);
300 static void gtk_widget_set_style_internal (GtkWidget *widget,
302 gboolean initial_emission);
303 static gint gtk_widget_event_internal (GtkWidget *widget,
305 static gboolean gtk_widget_real_mnemonic_activate (GtkWidget *widget,
306 gboolean group_cycling);
307 static void gtk_widget_aux_info_destroy (GtkWidgetAuxInfo *aux_info);
308 static AtkObject* gtk_widget_real_get_accessible (GtkWidget *widget);
309 static void gtk_widget_accessible_interface_init (AtkImplementorIface *iface);
310 static AtkObject* gtk_widget_ref_accessible (AtkImplementor *implementor);
311 static void gtk_widget_invalidate_widget_windows (GtkWidget *widget,
313 static GdkScreen * gtk_widget_get_screen_unchecked (GtkWidget *widget);
314 static void gtk_widget_queue_shallow_draw (GtkWidget *widget);
315 static gboolean gtk_widget_real_can_activate_accel (GtkWidget *widget,
318 static void gtk_widget_real_set_has_tooltip (GtkWidget *widget,
319 gboolean has_tooltip,
321 static void gtk_widget_buildable_interface_init (GtkBuildableIface *iface);
322 static void gtk_widget_buildable_set_name (GtkBuildable *buildable,
324 static const gchar * gtk_widget_buildable_get_name (GtkBuildable *buildable);
325 static GObject * gtk_widget_buildable_get_internal_child (GtkBuildable *buildable,
327 const gchar *childname);
328 static void gtk_widget_buildable_set_buildable_property (GtkBuildable *buildable,
331 const GValue *value);
332 static gboolean gtk_widget_buildable_custom_tag_start (GtkBuildable *buildable,
335 const gchar *tagname,
336 GMarkupParser *parser,
338 static void gtk_widget_buildable_custom_finished (GtkBuildable *buildable,
341 const gchar *tagname,
343 static void gtk_widget_buildable_parser_finished (GtkBuildable *buildable,
344 GtkBuilder *builder);
346 static void gtk_widget_queue_tooltip_query (GtkWidget *widget);
348 static void gtk_widget_set_usize_internal (GtkWidget *widget,
351 static void gtk_widget_get_draw_rectangle (GtkWidget *widget,
355 /* --- variables --- */
356 static gpointer gtk_widget_parent_class = NULL;
357 static guint widget_signals[LAST_SIGNAL] = { 0 };
358 static GtkStyle *gtk_default_style = NULL;
359 static GSList *colormap_stack = NULL;
360 static guint composite_child_stack = 0;
361 static GtkTextDirection gtk_default_direction = GTK_TEXT_DIR_LTR;
362 static GParamSpecPool *style_property_spec_pool = NULL;
364 static GQuark quark_property_parser = 0;
365 static GQuark quark_aux_info = 0;
366 static GQuark quark_accel_path = 0;
367 static GQuark quark_accel_closures = 0;
368 static GQuark quark_event_mask = 0;
369 static GQuark quark_extension_event_mode = 0;
370 static GQuark quark_parent_window = 0;
371 static GQuark quark_pointer_window = 0;
372 static GQuark quark_shape_info = 0;
373 static GQuark quark_input_shape_info = 0;
374 static GQuark quark_colormap = 0;
375 static GQuark quark_pango_context = 0;
376 static GQuark quark_rc_style = 0;
377 static GQuark quark_accessible_object = 0;
378 static GQuark quark_mnemonic_labels = 0;
379 static GQuark quark_tooltip_markup = 0;
380 static GQuark quark_has_tooltip = 0;
381 static GQuark quark_tooltip_window = 0;
382 GParamSpecPool *_gtk_widget_child_property_pool = NULL;
383 GObjectNotifyContext *_gtk_widget_child_property_notify_context = NULL;
385 /* --- functions --- */
387 gtk_widget_get_type (void)
389 static GType widget_type = 0;
391 if (G_UNLIKELY (widget_type == 0))
393 const GTypeInfo widget_info =
395 sizeof (GtkWidgetClass),
396 NULL, /* base_init */
397 (GBaseFinalizeFunc) gtk_widget_base_class_finalize,
398 (GClassInitFunc) gtk_widget_class_init,
399 NULL, /* class_finalize */
400 NULL, /* class_init */
403 (GInstanceInitFunc) gtk_widget_init,
404 NULL, /* value_table */
407 const GInterfaceInfo accessibility_info =
409 (GInterfaceInitFunc) gtk_widget_accessible_interface_init,
410 (GInterfaceFinalizeFunc) NULL,
411 NULL /* interface data */
414 const GInterfaceInfo buildable_info =
416 (GInterfaceInitFunc) gtk_widget_buildable_interface_init,
417 (GInterfaceFinalizeFunc) NULL,
418 NULL /* interface data */
421 widget_type = g_type_register_static (GTK_TYPE_OBJECT, "GtkWidget",
422 &widget_info, G_TYPE_FLAG_ABSTRACT);
424 g_type_add_interface_static (widget_type, ATK_TYPE_IMPLEMENTOR,
425 &accessibility_info) ;
426 g_type_add_interface_static (widget_type, GTK_TYPE_BUILDABLE,
435 child_property_notify_dispatcher (GObject *object,
439 GTK_WIDGET_GET_CLASS (object)->dispatch_child_properties_changed (GTK_WIDGET (object), n_pspecs, pspecs);
443 gtk_widget_class_init (GtkWidgetClass *klass)
445 static GObjectNotifyContext cpn_context = { 0, NULL, NULL };
446 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
447 GtkObjectClass *object_class = GTK_OBJECT_CLASS (klass);
448 GtkBindingSet *binding_set;
450 gtk_widget_parent_class = g_type_class_peek_parent (klass);
452 quark_property_parser = g_quark_from_static_string ("gtk-rc-property-parser");
453 quark_aux_info = g_quark_from_static_string ("gtk-aux-info");
454 quark_accel_path = g_quark_from_static_string ("gtk-accel-path");
455 quark_accel_closures = g_quark_from_static_string ("gtk-accel-closures");
456 quark_event_mask = g_quark_from_static_string ("gtk-event-mask");
457 quark_extension_event_mode = g_quark_from_static_string ("gtk-extension-event-mode");
458 quark_parent_window = g_quark_from_static_string ("gtk-parent-window");
459 quark_pointer_window = g_quark_from_static_string ("gtk-pointer-window");
460 quark_shape_info = g_quark_from_static_string ("gtk-shape-info");
461 quark_input_shape_info = g_quark_from_static_string ("gtk-input-shape-info");
462 quark_colormap = g_quark_from_static_string ("gtk-colormap");
463 quark_pango_context = g_quark_from_static_string ("gtk-pango-context");
464 quark_rc_style = g_quark_from_static_string ("gtk-rc-style");
465 quark_accessible_object = g_quark_from_static_string ("gtk-accessible-object");
466 quark_mnemonic_labels = g_quark_from_static_string ("gtk-mnemonic-labels");
467 quark_tooltip_markup = g_quark_from_static_string ("gtk-tooltip-markup");
468 quark_has_tooltip = g_quark_from_static_string ("gtk-has-tooltip");
469 quark_tooltip_window = g_quark_from_static_string ("gtk-tooltip-window");
471 style_property_spec_pool = g_param_spec_pool_new (FALSE);
472 _gtk_widget_child_property_pool = g_param_spec_pool_new (TRUE);
473 cpn_context.quark_notify_queue = g_quark_from_static_string ("GtkWidget-child-property-notify-queue");
474 cpn_context.dispatcher = child_property_notify_dispatcher;
475 _gtk_widget_child_property_notify_context = &cpn_context;
477 gobject_class->dispose = gtk_widget_dispose;
478 gobject_class->finalize = gtk_widget_finalize;
479 gobject_class->set_property = gtk_widget_set_property;
480 gobject_class->get_property = gtk_widget_get_property;
482 object_class->destroy = gtk_widget_real_destroy;
484 klass->activate_signal = 0;
485 klass->set_scroll_adjustments_signal = 0;
486 klass->dispatch_child_properties_changed = gtk_widget_dispatch_child_properties_changed;
487 klass->show = gtk_widget_real_show;
488 klass->show_all = gtk_widget_show;
489 klass->hide = gtk_widget_real_hide;
490 klass->hide_all = gtk_widget_hide;
491 klass->map = gtk_widget_real_map;
492 klass->unmap = gtk_widget_real_unmap;
493 klass->realize = gtk_widget_real_realize;
494 klass->unrealize = gtk_widget_real_unrealize;
495 klass->size_request = gtk_widget_real_size_request;
496 klass->size_allocate = gtk_widget_real_size_allocate;
497 klass->state_changed = NULL;
498 klass->parent_set = NULL;
499 klass->hierarchy_changed = NULL;
500 klass->style_set = gtk_widget_real_style_set;
501 klass->direction_changed = gtk_widget_real_direction_changed;
502 klass->grab_notify = NULL;
503 klass->child_notify = NULL;
504 klass->mnemonic_activate = gtk_widget_real_mnemonic_activate;
505 klass->grab_focus = gtk_widget_real_grab_focus;
506 klass->focus = gtk_widget_real_focus;
508 klass->button_press_event = NULL;
509 klass->button_release_event = NULL;
510 klass->motion_notify_event = NULL;
511 klass->delete_event = NULL;
512 klass->destroy_event = NULL;
513 klass->expose_event = NULL;
514 klass->key_press_event = gtk_widget_real_key_press_event;
515 klass->key_release_event = gtk_widget_real_key_release_event;
516 klass->enter_notify_event = NULL;
517 klass->leave_notify_event = NULL;
518 klass->configure_event = NULL;
519 klass->focus_in_event = gtk_widget_real_focus_in_event;
520 klass->focus_out_event = gtk_widget_real_focus_out_event;
521 klass->map_event = NULL;
522 klass->unmap_event = NULL;
523 klass->window_state_event = NULL;
524 klass->property_notify_event = _gtk_selection_property_notify;
525 klass->selection_clear_event = gtk_selection_clear;
526 klass->selection_request_event = _gtk_selection_request;
527 klass->selection_notify_event = _gtk_selection_notify;
528 klass->selection_received = NULL;
529 klass->proximity_in_event = NULL;
530 klass->proximity_out_event = NULL;
531 klass->drag_begin = NULL;
532 klass->drag_end = NULL;
533 klass->drag_data_delete = NULL;
534 klass->drag_leave = NULL;
535 klass->drag_motion = NULL;
536 klass->drag_drop = NULL;
537 klass->drag_data_received = NULL;
538 klass->screen_changed = NULL;
539 klass->can_activate_accel = gtk_widget_real_can_activate_accel;
540 klass->grab_broken_event = NULL;
541 klass->query_tooltip = gtk_widget_real_query_tooltip;
543 klass->show_help = gtk_widget_real_show_help;
545 /* Accessibility support */
546 klass->get_accessible = gtk_widget_real_get_accessible;
548 klass->no_expose_event = NULL;
550 g_object_class_install_property (gobject_class,
552 g_param_spec_string ("name",
554 P_("The name of the widget"),
556 GTK_PARAM_READWRITE));
557 g_object_class_install_property (gobject_class,
559 g_param_spec_object ("parent",
561 P_("The parent widget of this widget. Must be a Container widget"),
563 GTK_PARAM_READWRITE));
565 g_object_class_install_property (gobject_class,
567 g_param_spec_int ("width-request",
569 P_("Override for width request of the widget, or -1 if natural request should be used"),
573 GTK_PARAM_READWRITE));
574 g_object_class_install_property (gobject_class,
576 g_param_spec_int ("height-request",
577 P_("Height request"),
578 P_("Override for height request of the widget, or -1 if natural request should be used"),
582 GTK_PARAM_READWRITE));
583 g_object_class_install_property (gobject_class,
585 g_param_spec_boolean ("visible",
587 P_("Whether the widget is visible"),
589 GTK_PARAM_READWRITE));
590 g_object_class_install_property (gobject_class,
592 g_param_spec_boolean ("sensitive",
594 P_("Whether the widget responds to input"),
596 GTK_PARAM_READWRITE));
597 g_object_class_install_property (gobject_class,
599 g_param_spec_boolean ("app-paintable",
600 P_("Application paintable"),
601 P_("Whether the application will paint directly on the widget"),
603 GTK_PARAM_READWRITE));
604 g_object_class_install_property (gobject_class,
606 g_param_spec_boolean ("can-focus",
608 P_("Whether the widget can accept the input focus"),
610 GTK_PARAM_READWRITE));
611 g_object_class_install_property (gobject_class,
613 g_param_spec_boolean ("has-focus",
615 P_("Whether the widget has the input focus"),
617 GTK_PARAM_READWRITE));
618 g_object_class_install_property (gobject_class,
620 g_param_spec_boolean ("is-focus",
622 P_("Whether the widget is the focus widget within the toplevel"),
624 GTK_PARAM_READWRITE));
625 g_object_class_install_property (gobject_class,
627 g_param_spec_boolean ("can-default",
629 P_("Whether the widget can be the default widget"),
631 GTK_PARAM_READWRITE));
632 g_object_class_install_property (gobject_class,
634 g_param_spec_boolean ("has-default",
636 P_("Whether the widget is the default widget"),
638 GTK_PARAM_READWRITE));
639 g_object_class_install_property (gobject_class,
640 PROP_RECEIVES_DEFAULT,
641 g_param_spec_boolean ("receives-default",
642 P_("Receives default"),
643 P_("If TRUE, the widget will receive the default action when it is focused"),
645 GTK_PARAM_READWRITE));
646 g_object_class_install_property (gobject_class,
647 PROP_COMPOSITE_CHILD,
648 g_param_spec_boolean ("composite-child",
649 P_("Composite child"),
650 P_("Whether the widget is part of a composite widget"),
652 GTK_PARAM_READABLE));
653 g_object_class_install_property (gobject_class,
655 g_param_spec_object ("style",
657 P_("The style of the widget, which contains information about how it will look (colors etc)"),
659 GTK_PARAM_READWRITE));
660 g_object_class_install_property (gobject_class,
662 g_param_spec_flags ("events",
664 P_("The event mask that decides what kind of GdkEvents this widget gets"),
667 GTK_PARAM_READWRITE));
668 g_object_class_install_property (gobject_class,
669 PROP_EXTENSION_EVENTS,
670 g_param_spec_enum ("extension-events",
671 P_("Extension events"),
672 P_("The mask that decides what kind of extension events this widget gets"),
673 GDK_TYPE_EXTENSION_MODE,
674 GDK_EXTENSION_EVENTS_NONE,
675 GTK_PARAM_READWRITE));
676 g_object_class_install_property (gobject_class,
678 g_param_spec_boolean ("no-show-all",
680 P_("Whether gtk_widget_show_all() should not affect this widget"),
682 GTK_PARAM_READWRITE));
685 * GtkWidget:has-tooltip:
687 * Enables or disables the emission of #GtkWidget::query-tooltip on @widget.
688 * A value of %TRUE indicates that @widget can have a tooltip, in this case
689 * the widget will be queried using #GtkWidget::query-tooltip to determine
690 * whether it will provide a tooltip or not.
692 * Note that setting this property to %TRUE for the first time will change
693 * the event masks of the GdkWindows of this widget to include leave-notify
694 * and motion-notify events. This cannot and will not be undone when the
695 * property is set to %FALSE again.
699 g_object_class_install_property (gobject_class,
701 g_param_spec_boolean ("has-tooltip",
703 P_("Whether this widget has a tooltip"),
705 GTK_PARAM_READWRITE));
707 * GtkWidget:tooltip-text:
709 * Sets the text of tooltip to be the given string.
711 * Also see gtk_tooltip_set_text().
713 * This is a convenience property which will take care of getting the
714 * tooltip shown if the given string is not %NULL: #GtkWidget:has-tooltip
715 * will automatically be set to %TRUE and there will be taken care of
716 * #GtkWidget::query-tooltip in the default signal handler.
720 g_object_class_install_property (gobject_class,
722 g_param_spec_string ("tooltip-text",
724 P_("The contents of the tooltip for this widget"),
726 GTK_PARAM_READWRITE));
728 * GtkWidget:tooltip-markup:
730 * Sets the text of tooltip to be the given string, which is marked up
731 * with the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
732 * Also see gtk_tooltip_set_markup().
734 * This is a convenience property which will take care of getting the
735 * tooltip shown if the given string is not %NULL: #GtkWidget:has-tooltip
736 * will automatically be set to %TRUE and there will be taken care of
737 * #GtkWidget::query-tooltip in the default signal handler.
741 g_object_class_install_property (gobject_class,
743 g_param_spec_string ("tooltip-markup",
744 P_("Tooltip markup"),
745 P_("The contents of the tooltip for this widget"),
747 GTK_PARAM_READWRITE));
752 * The widget's window if it is realized, %NULL otherwise.
756 g_object_class_install_property (gobject_class,
758 g_param_spec_object ("window",
760 P_("The widget's window if it is realized"),
762 GTK_PARAM_READABLE));
765 * GtkWidget:double-buffered
767 * Whether or not the widget is double buffered.
771 g_object_class_install_property (gobject_class,
772 PROP_DOUBLE_BUFFERED,
773 g_param_spec_boolean ("double-buffered",
774 P_("Double Buffered"),
775 P_("Whether or not the widget is double buffered"),
777 GTK_PARAM_READWRITE));
781 * @widget: the object which received the signal.
783 widget_signals[SHOW] =
784 g_signal_new (I_("show"),
785 G_TYPE_FROM_CLASS (gobject_class),
787 G_STRUCT_OFFSET (GtkWidgetClass, show),
789 _gtk_marshal_VOID__VOID,
794 * @widget: the object which received the signal.
796 widget_signals[HIDE] =
797 g_signal_new (I_("hide"),
798 G_TYPE_FROM_CLASS (gobject_class),
800 G_STRUCT_OFFSET (GtkWidgetClass, hide),
802 _gtk_marshal_VOID__VOID,
807 * @widget: the object which received the signal.
809 widget_signals[MAP] =
810 g_signal_new (I_("map"),
811 G_TYPE_FROM_CLASS (gobject_class),
813 G_STRUCT_OFFSET (GtkWidgetClass, map),
815 _gtk_marshal_VOID__VOID,
820 * @widget: the object which received the signal.
822 widget_signals[UNMAP] =
823 g_signal_new (I_("unmap"),
824 G_TYPE_FROM_CLASS (gobject_class),
826 G_STRUCT_OFFSET (GtkWidgetClass, unmap),
828 _gtk_marshal_VOID__VOID,
832 * GtkWidget::realize:
833 * @widget: the object which received the signal.
835 widget_signals[REALIZE] =
836 g_signal_new (I_("realize"),
837 G_TYPE_FROM_CLASS (gobject_class),
839 G_STRUCT_OFFSET (GtkWidgetClass, realize),
841 _gtk_marshal_VOID__VOID,
845 * GtkWidget::unrealize:
846 * @widget: the object which received the signal.
848 widget_signals[UNREALIZE] =
849 g_signal_new (I_("unrealize"),
850 G_TYPE_FROM_CLASS (gobject_class),
852 G_STRUCT_OFFSET (GtkWidgetClass, unrealize),
854 _gtk_marshal_VOID__VOID,
858 * GtkWidget::size-request:
859 * @widget: the object which received the signal.
862 widget_signals[SIZE_REQUEST] =
863 g_signal_new (I_("size-request"),
864 G_TYPE_FROM_CLASS (gobject_class),
866 G_STRUCT_OFFSET (GtkWidgetClass, size_request),
868 _gtk_marshal_VOID__BOXED,
870 GTK_TYPE_REQUISITION | G_SIGNAL_TYPE_STATIC_SCOPE);
873 * GtkWidget::size-allocate:
874 * @widget: the object which received the signal.
877 widget_signals[SIZE_ALLOCATE] =
878 g_signal_new (I_("size-allocate"),
879 G_TYPE_FROM_CLASS (gobject_class),
881 G_STRUCT_OFFSET (GtkWidgetClass, size_allocate),
883 _gtk_marshal_VOID__BOXED,
885 GDK_TYPE_RECTANGLE | G_SIGNAL_TYPE_STATIC_SCOPE);
888 * GtkWidget::state-changed:
889 * @widget: the object which received the signal.
890 * @state: the previous state
892 * The ::state-changed signal is emitted when the widget state changes.
893 * See gtk_widget_get_state().
895 widget_signals[STATE_CHANGED] =
896 g_signal_new (I_("state-changed"),
897 G_TYPE_FROM_CLASS (gobject_class),
899 G_STRUCT_OFFSET (GtkWidgetClass, state_changed),
901 _gtk_marshal_VOID__ENUM,
903 GTK_TYPE_STATE_TYPE);
906 * GtkWidget::parent-set:
907 * @widget: the object on which the signal is emitted
908 * @old_parent: the previous parent, or %NULL if the widget
909 * just got its initial parent.
911 * The ::parent-set signal is emitted when a new parent
912 * has been set on a widget.
914 widget_signals[PARENT_SET] =
915 g_signal_new (I_("parent-set"),
916 G_TYPE_FROM_CLASS (gobject_class),
918 G_STRUCT_OFFSET (GtkWidgetClass, parent_set),
920 _gtk_marshal_VOID__OBJECT,
925 * GtkWidget::hierarchy-changed:
926 * @widget: the object on which the signal is emitted
927 * @previous_toplevel: the previous toplevel ancestor, or %NULL
928 * if the widget was previously unanchored
930 * The ::hierarchy-changed signal is emitted when the
931 * anchored state of a widget changes. A widget is
932 * <firstterm>anchored</firstterm> when its toplevel
933 * ancestor is a #GtkWindow. This signal is emitted when
934 * a widget changes from un-anchored to anchored or vice-versa.
936 widget_signals[HIERARCHY_CHANGED] =
937 g_signal_new (I_("hierarchy-changed"),
938 G_TYPE_FROM_CLASS (gobject_class),
940 G_STRUCT_OFFSET (GtkWidgetClass, hierarchy_changed),
942 _gtk_marshal_VOID__OBJECT,
947 * GtkWidget::style-set:
948 * @widget: the object on which the signal is emitted
949 * @previous_style: the previous style, or %NULL if the widget
950 * just got its initial style
952 * The ::style-set signal is emitted when a new style has been set
953 * on a widget. Note that style-modifying functions like
954 * gtk_widget_modify_base() also cause this signal to be emitted.
956 widget_signals[STYLE_SET] =
957 g_signal_new (I_("style-set"),
958 G_TYPE_FROM_CLASS (gobject_class),
960 G_STRUCT_OFFSET (GtkWidgetClass, style_set),
962 _gtk_marshal_VOID__OBJECT,
966 * GtkWidget::direction-changed:
967 * @widget: the object on which the signal is emitted
968 * @previous_direction: the previous text direction of @widget
970 * The ::direction-changed signal is emitted when the text direction
971 * of a widget changes.
973 widget_signals[DIRECTION_CHANGED] =
974 g_signal_new (I_("direction-changed"),
975 G_TYPE_FROM_CLASS (gobject_class),
977 G_STRUCT_OFFSET (GtkWidgetClass, direction_changed),
979 _gtk_marshal_VOID__ENUM,
981 GTK_TYPE_TEXT_DIRECTION);
984 * GtkWidget::grab-notify:
985 * @widget: the object which received the signal
986 * @was_grabbed: %FALSE if the widget becomes shadowed, %TRUE
987 * if it becomes unshadowed
989 * The ::grab-notify signal is emitted when a widget becomes
990 * shadowed by a GTK+ grab (not a pointer or keyboard grab) on
991 * another widget, or when it becomes unshadowed due to a grab
994 * A widget is shadowed by a gtk_grab_add() when the topmost
995 * grab widget in the grab stack of its window group is not
998 widget_signals[GRAB_NOTIFY] =
999 g_signal_new (I_("grab-notify"),
1000 G_TYPE_FROM_CLASS (gobject_class),
1002 G_STRUCT_OFFSET (GtkWidgetClass, grab_notify),
1004 _gtk_marshal_VOID__BOOLEAN,
1009 * GtkWidget::child-notify:
1010 * @widget: the object which received the signal
1011 * @pspec: the #GParamSpec of the changed child property
1013 * The ::child-notify signal is emitted for each
1014 * <link linkend="child-properties">child property</link> that has
1015 * changed on an object. The signal's detail holds the property name.
1017 widget_signals[CHILD_NOTIFY] =
1018 g_signal_new (I_("child-notify"),
1019 G_TYPE_FROM_CLASS (gobject_class),
1020 G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE | G_SIGNAL_DETAILED | G_SIGNAL_NO_HOOKS,
1021 G_STRUCT_OFFSET (GtkWidgetClass, child_notify),
1023 g_cclosure_marshal_VOID__PARAM,
1028 * GtkWidget::mnemonic-activate:
1029 * @widget: the object which received the signal.
1032 widget_signals[MNEMONIC_ACTIVATE] =
1033 g_signal_new (I_("mnemonic-activate"),
1034 G_TYPE_FROM_CLASS (gobject_class),
1036 G_STRUCT_OFFSET (GtkWidgetClass, mnemonic_activate),
1037 _gtk_boolean_handled_accumulator, NULL,
1038 _gtk_marshal_BOOLEAN__BOOLEAN,
1043 * GtkWidget::grab-focus:
1044 * @widget: the object which received the signal.
1046 widget_signals[GRAB_FOCUS] =
1047 g_signal_new (I_("grab-focus"),
1048 G_TYPE_FROM_CLASS (gobject_class),
1049 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
1050 G_STRUCT_OFFSET (GtkWidgetClass, grab_focus),
1052 _gtk_marshal_VOID__VOID,
1057 * @widget: the object which received the signal.
1060 * Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
1062 widget_signals[FOCUS] =
1063 g_signal_new (I_("focus"),
1064 G_TYPE_FROM_CLASS (object_class),
1066 G_STRUCT_OFFSET (GtkWidgetClass, focus),
1067 _gtk_boolean_handled_accumulator, NULL,
1068 _gtk_marshal_BOOLEAN__ENUM,
1070 GTK_TYPE_DIRECTION_TYPE);
1073 * GtkWidget::move-focus:
1074 * @widget: the object which received the signal.
1077 widget_signals[MOVE_FOCUS] =
1078 g_signal_new_class_handler (I_("move-focus"),
1079 G_TYPE_FROM_CLASS (object_class),
1080 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
1081 G_CALLBACK (gtk_widget_real_move_focus),
1083 _gtk_marshal_VOID__ENUM,
1086 GTK_TYPE_DIRECTION_TYPE);
1089 * @widget: the object which received the signal.
1090 * @event: the #GdkEvent which triggered this signal
1092 * The GTK+ main loop will emit three signals for each GDK event delivered
1093 * to a widget: one generic ::event signal, another, more specific,
1094 * signal that matches the type of event delivered (e.g.
1095 * #GtkWidget::key-press-event) and finally a generic
1096 * #GtkWidget::event-after signal.
1098 * Returns: %TRUE to stop other handlers from being invoked for the event
1099 * and to cancel the emission of the second specific ::event signal.
1100 * %FALSE to propagate the event further and to allow the emission of
1101 * the second signal. The ::event-after signal is emitted regardless of
1104 widget_signals[EVENT] =
1105 g_signal_new (I_("event"),
1106 G_TYPE_FROM_CLASS (gobject_class),
1108 G_STRUCT_OFFSET (GtkWidgetClass, event),
1109 _gtk_boolean_handled_accumulator, NULL,
1110 _gtk_marshal_BOOLEAN__BOXED,
1112 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1115 * GtkWidget::event-after:
1116 * @widget: the object which received the signal.
1117 * @event: the #GdkEvent which triggered this signal
1119 * After the emission of the #GtkWidget::event signal and (optionally)
1120 * the second more specific signal, ::event-after will be emitted
1121 * regardless of the previous two signals handlers return values.
1124 widget_signals[EVENT_AFTER] =
1125 g_signal_new (I_("event-after"),
1126 G_TYPE_FROM_CLASS (gobject_class),
1130 _gtk_marshal_VOID__BOXED,
1132 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1135 * GtkWidget::button-press-event:
1136 * @widget: the object which received the signal.
1137 * @event: the #GdkEventButton which triggered this signal
1139 * The ::button-press-event signal will be emitted when a button
1140 * (typically from a mouse) is pressed.
1142 * To receive this signal, the #GdkWindow associated to the
1143 * widget needs to enable the #GDK_BUTTON_PRESS_MASK mask.
1145 * This signal will be sent to the grab widget if there is one.
1147 * Returns: %TRUE to stop other handlers from being invoked for the event.
1148 * %FALSE to propagate the event further.
1150 widget_signals[BUTTON_PRESS_EVENT] =
1151 g_signal_new (I_("button-press-event"),
1152 G_TYPE_FROM_CLASS (gobject_class),
1154 G_STRUCT_OFFSET (GtkWidgetClass, button_press_event),
1155 _gtk_boolean_handled_accumulator, NULL,
1156 _gtk_marshal_BOOLEAN__BOXED,
1158 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1161 * GtkWidget::button-release-event:
1162 * @widget: the object which received the signal.
1163 * @event: the #GdkEventButton which triggered this signal
1165 * The ::button-release-event signal will be emitted when a button
1166 * (typically from a mouse) is released.
1168 * To receive this signal, the #GdkWindow associated to the
1169 * widget needs to enable the #GDK_BUTTON_RELEASE_MASK mask.
1171 * This signal will be sent to the grab widget if there is one.
1173 * Returns: %TRUE to stop other handlers from being invoked for the event.
1174 * %FALSE to propagate the event further.
1176 widget_signals[BUTTON_RELEASE_EVENT] =
1177 g_signal_new (I_("button-release-event"),
1178 G_TYPE_FROM_CLASS (gobject_class),
1180 G_STRUCT_OFFSET (GtkWidgetClass, button_release_event),
1181 _gtk_boolean_handled_accumulator, NULL,
1182 _gtk_marshal_BOOLEAN__BOXED,
1184 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1187 * GtkWidget::scroll-event:
1188 * @widget: the object which received the signal.
1189 * @event: the #GdkEventScroll which triggered this signal
1191 * The ::scroll-event signal is emitted when a button in the 4 to 7
1192 * range is pressed. Wheel mice are usually configured to generate
1193 * button press events for buttons 4 and 5 when the wheel is turned.
1195 * To receive this signal, the #GdkWindow associated to the widget needs
1196 * to enable the #GDK_BUTTON_PRESS_MASK mask.
1198 * This signal will be sent to the grab widget if there is one.
1200 * Returns: %TRUE to stop other handlers from being invoked for the event.
1201 * %FALSE to propagate the event further.
1203 widget_signals[SCROLL_EVENT] =
1204 g_signal_new (I_("scroll-event"),
1205 G_TYPE_FROM_CLASS (gobject_class),
1207 G_STRUCT_OFFSET (GtkWidgetClass, scroll_event),
1208 _gtk_boolean_handled_accumulator, NULL,
1209 _gtk_marshal_BOOLEAN__BOXED,
1211 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1213 * GtkWidget::motion-notify-event:
1214 * @widget: the object which received the signal.
1215 * @event: the #GdkEventMotion which triggered this signal
1217 * The ::motion-notify-event signal is emitted when the pointer moves
1218 * over the widget's #GdkWindow.
1220 * To receive this signal, the #GdkWindow associated to the widget
1221 * needs to enable the #GDK_POINTER_MOTION_MASK mask.
1223 * This signal will be sent to the grab widget if there is one.
1225 * Returns: %TRUE to stop other handlers from being invoked for the event.
1226 * %FALSE to propagate the event further.
1228 widget_signals[MOTION_NOTIFY_EVENT] =
1229 g_signal_new (I_("motion-notify-event"),
1230 G_TYPE_FROM_CLASS (gobject_class),
1232 G_STRUCT_OFFSET (GtkWidgetClass, motion_notify_event),
1233 _gtk_boolean_handled_accumulator, NULL,
1234 _gtk_marshal_BOOLEAN__BOXED,
1236 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1239 * GtkWidget::composited-changed:
1240 * @widget: the object on which the signal is emitted
1242 * The ::composited-changed signal is emitted when the composited
1243 * status of @widget<!-- -->s screen changes.
1244 * See gdk_screen_is_composited().
1246 widget_signals[COMPOSITED_CHANGED] =
1247 g_signal_new (I_("composited-changed"),
1248 G_TYPE_FROM_CLASS (gobject_class),
1249 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
1250 G_STRUCT_OFFSET (GtkWidgetClass, composited_changed),
1252 _gtk_marshal_VOID__VOID,
1256 * GtkWidget::keynav-failed:
1257 * @widget: the object which received the signal
1258 * @direction: the direction of movement
1260 * Gets emitted if keyboard navigation fails.
1261 * See gtk_widget_keynav_failed() for details.
1263 * Returns: %TRUE if stopping keyboard navigation is fine, %FALSE
1264 * if the emitting widget should try to handle the keyboard
1265 * navigation attempt in its parent container(s).
1269 widget_signals[KEYNAV_FAILED] =
1270 g_signal_new_class_handler (I_("keynav-failed"),
1271 G_TYPE_FROM_CLASS (gobject_class),
1273 G_CALLBACK (gtk_widget_real_keynav_failed),
1274 _gtk_boolean_handled_accumulator, NULL,
1275 _gtk_marshal_BOOLEAN__ENUM,
1277 GTK_TYPE_DIRECTION_TYPE);
1280 * GtkWidget::delete-event:
1281 * @widget: the object which received the signal
1282 * @event: the event which triggered this signal
1284 * The ::delete-event signal is emitted if a user requests that
1285 * a toplevel window is closed. The default handler for this signal
1286 * destroys the window. Connecting gtk_widget_hide_on_delete() to
1287 * this signal will cause the window to be hidden instead, so that
1288 * it can later be shown again without reconstructing it.
1290 * Returns: %TRUE to stop other handlers from being invoked for the event.
1291 * %FALSE to propagate the event further.
1293 widget_signals[DELETE_EVENT] =
1294 g_signal_new (I_("delete-event"),
1295 G_TYPE_FROM_CLASS (gobject_class),
1297 G_STRUCT_OFFSET (GtkWidgetClass, delete_event),
1298 _gtk_boolean_handled_accumulator, NULL,
1299 _gtk_marshal_BOOLEAN__BOXED,
1301 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1304 * GtkWidget::destroy-event:
1305 * @widget: the object which received the signal.
1306 * @event: the event which triggered this signal
1308 * The ::destroy-event signal is emitted when a #GdkWindow is destroyed.
1309 * You rarely get this signal, because most widgets disconnect themselves
1310 * from their window before they destroy it, so no widget owns the
1311 * window at destroy time.
1313 * To receive this signal, the #GdkWindow associated to the widget needs
1314 * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
1315 * automatically for all new windows.
1317 * Returns: %TRUE to stop other handlers from being invoked for the event.
1318 * %FALSE to propagate the event further.
1320 widget_signals[DESTROY_EVENT] =
1321 g_signal_new (I_("destroy-event"),
1322 G_TYPE_FROM_CLASS (gobject_class),
1324 G_STRUCT_OFFSET (GtkWidgetClass, destroy_event),
1325 _gtk_boolean_handled_accumulator, NULL,
1326 _gtk_marshal_BOOLEAN__BOXED,
1328 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1331 * GtkWidget::expose-event:
1332 * @widget: the object which received the signal.
1333 * @event: the #GdkEventExpose which triggered this signal
1335 * The ::expose-event signal is emitted when an area of a previously
1336 * obscured #GdkWindow is made visible and needs to be redrawn.
1337 * #GTK_NO_WINDOW widgets will get a synthesized event from their parent
1340 * To receive this signal, the #GdkWindow associated to the widget needs
1341 * to enable the #GDK_EXPOSURE_MASK mask.
1343 * Returns: %TRUE to stop other handlers from being invoked for the event.
1344 * %FALSE to propagate the event further.
1346 widget_signals[EXPOSE_EVENT] =
1347 g_signal_new (I_("expose-event"),
1348 G_TYPE_FROM_CLASS (gobject_class),
1350 G_STRUCT_OFFSET (GtkWidgetClass, expose_event),
1351 _gtk_boolean_handled_accumulator, NULL,
1352 _gtk_marshal_BOOLEAN__BOXED,
1354 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1357 * GtkWidget::key-press-event:
1358 * @widget: the object which received the signal
1359 * @event: the #GdkEventKey which triggered this signal
1361 * The ::key-press-event signal is emitted when a key is pressed.
1363 * To receive this signal, the #GdkWindow associated to the widget needs
1364 * to enable the #GDK_KEY_PRESS_MASK mask.
1366 * This signal will be sent to the grab widget if there is one.
1368 * Returns: %TRUE to stop other handlers from being invoked for the event.
1369 * %FALSE to propagate the event further.
1371 widget_signals[KEY_PRESS_EVENT] =
1372 g_signal_new (I_("key-press-event"),
1373 G_TYPE_FROM_CLASS (gobject_class),
1375 G_STRUCT_OFFSET (GtkWidgetClass, key_press_event),
1376 _gtk_boolean_handled_accumulator, NULL,
1377 _gtk_marshal_BOOLEAN__BOXED,
1379 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1382 * GtkWidget::key-release-event:
1383 * @widget: the object which received the signal
1384 * @event: the #GdkEventKey which triggered this signal
1386 * The ::key-release-event signal is emitted when a key is pressed.
1388 * To receive this signal, the #GdkWindow associated to the widget needs
1389 * to enable the #GDK_KEY_RELEASE_MASK mask.
1391 * This signal will be sent to the grab widget if there is one.
1393 * Returns: %TRUE to stop other handlers from being invoked for the event.
1394 * %FALSE to propagate the event further.
1396 widget_signals[KEY_RELEASE_EVENT] =
1397 g_signal_new (I_("key-release-event"),
1398 G_TYPE_FROM_CLASS (gobject_class),
1400 G_STRUCT_OFFSET (GtkWidgetClass, key_release_event),
1401 _gtk_boolean_handled_accumulator, NULL,
1402 _gtk_marshal_BOOLEAN__BOXED,
1404 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1407 * GtkWidget::enter-notify-event:
1408 * @widget: the object which received the signal
1409 * @event: the #GdkEventCrossing which triggered this signal
1411 * The ::enter-notify-event will be emitted when the pointer enters
1412 * the @widget's window.
1414 * To receive this signal, the #GdkWindow associated to the widget needs
1415 * to enable the #GDK_ENTER_NOTIFY_MASK mask.
1417 * This signal will be sent to the grab widget if there is one.
1419 * Returns: %TRUE to stop other handlers from being invoked for the event.
1420 * %FALSE to propagate the event further.
1422 widget_signals[ENTER_NOTIFY_EVENT] =
1423 g_signal_new (I_("enter-notify-event"),
1424 G_TYPE_FROM_CLASS (gobject_class),
1426 G_STRUCT_OFFSET (GtkWidgetClass, enter_notify_event),
1427 _gtk_boolean_handled_accumulator, NULL,
1428 _gtk_marshal_BOOLEAN__BOXED,
1430 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1433 * GtkWidget::leave-notify-event:
1434 * @widget: the object which received the signal
1435 * @event: the #GdkEventCrossing which triggered this signal
1437 * The ::leave-notify-event will be emitted when the pointer leaves
1438 * the @widget's window.
1440 * To receive this signal, the #GdkWindow associated to the widget needs
1441 * to enable the #GDK_LEAVE_NOTIFY_MASK mask.
1443 * This signal will be sent to the grab widget if there is one.
1445 * Returns: %TRUE to stop other handlers from being invoked for the event.
1446 * %FALSE to propagate the event further.
1448 widget_signals[LEAVE_NOTIFY_EVENT] =
1449 g_signal_new (I_("leave-notify-event"),
1450 G_TYPE_FROM_CLASS (gobject_class),
1452 G_STRUCT_OFFSET (GtkWidgetClass, leave_notify_event),
1453 _gtk_boolean_handled_accumulator, NULL,
1454 _gtk_marshal_BOOLEAN__BOXED,
1456 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1459 * GtkWidget::configure-event
1460 * @widget: the object which received the signal
1461 * @event: the #GdkEventConfigure which triggered this signal
1463 * The ::configure-event signal will be emitted when the size, position or
1464 * stacking of the @widget's window has changed.
1466 * To receive this signal, the #GdkWindow associated to the widget needs
1467 * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
1468 * automatically for all new windows.
1470 * Returns: %TRUE to stop other handlers from being invoked for the event.
1471 * %FALSE to propagate the event further.
1473 widget_signals[CONFIGURE_EVENT] =
1474 g_signal_new (I_("configure-event"),
1475 G_TYPE_FROM_CLASS (gobject_class),
1477 G_STRUCT_OFFSET (GtkWidgetClass, configure_event),
1478 _gtk_boolean_handled_accumulator, NULL,
1479 _gtk_marshal_BOOLEAN__BOXED,
1481 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1484 * GtkWidget::focus-in-event
1485 * @widget: the object which received the signal
1486 * @event: the #GdkEventFocus which triggered this signal
1488 * The ::focus-in-event signal will be emitted when the keyboard focus
1489 * enters the @widget's window.
1491 * To receive this signal, the #GdkWindow associated to the widget needs
1492 * to enable the #GDK_FOCUS_CHANGE_MASK mask.
1494 * Returns: %TRUE to stop other handlers from being invoked for the event.
1495 * %FALSE to propagate the event further.
1497 widget_signals[FOCUS_IN_EVENT] =
1498 g_signal_new (I_("focus-in-event"),
1499 G_TYPE_FROM_CLASS (gobject_class),
1501 G_STRUCT_OFFSET (GtkWidgetClass, focus_in_event),
1502 _gtk_boolean_handled_accumulator, NULL,
1503 _gtk_marshal_BOOLEAN__BOXED,
1505 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1508 * GtkWidget::focus-out-event
1509 * @widget: the object which received the signal
1510 * @event: the #GdkEventFocus which triggered this signal
1512 * The ::focus-out-event signal will be emitted when the keyboard focus
1513 * leaves the @widget's window.
1515 * To receive this signal, the #GdkWindow associated to the widget needs
1516 * to enable the #GDK_FOCUS_CHANGE_MASK mask.
1518 * Returns: %TRUE to stop other handlers from being invoked for the event.
1519 * %FALSE to propagate the event further.
1521 widget_signals[FOCUS_OUT_EVENT] =
1522 g_signal_new (I_("focus-out-event"),
1523 G_TYPE_FROM_CLASS (gobject_class),
1525 G_STRUCT_OFFSET (GtkWidgetClass, focus_out_event),
1526 _gtk_boolean_handled_accumulator, NULL,
1527 _gtk_marshal_BOOLEAN__BOXED,
1529 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1532 * GtkWidget::map-event
1533 * @widget: the object which received the signal
1534 * @event: the #GdkEventAny which triggered this signal
1536 * The ::map-event signal will be emitted when the @widget's window is
1537 * mapped. A window is mapped when it becomes visible on the screen.
1539 * To receive this signal, the #GdkWindow associated to the widget needs
1540 * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
1541 * automatically for all new windows.
1543 * Returns: %TRUE to stop other handlers from being invoked for the event.
1544 * %FALSE to propagate the event further.
1546 widget_signals[MAP_EVENT] =
1547 g_signal_new (I_("map-event"),
1548 G_TYPE_FROM_CLASS (gobject_class),
1550 G_STRUCT_OFFSET (GtkWidgetClass, map_event),
1551 _gtk_boolean_handled_accumulator, NULL,
1552 _gtk_marshal_BOOLEAN__BOXED,
1554 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1557 * GtkWidget::unmap-event
1558 * @widget: the object which received the signal
1559 * @event: the #GdkEventAny which triggered this signal
1561 * The ::unmap-event signal will be emitted when the @widget's window is
1562 * unmapped. A window is unmapped when it becomes invisible on the screen.
1564 * To receive this signal, the #GdkWindow associated to the widget needs
1565 * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
1566 * automatically for all new windows.
1568 * Returns: %TRUE to stop other handlers from being invoked for the event.
1569 * %FALSE to propagate the event further.
1571 widget_signals[UNMAP_EVENT] =
1572 g_signal_new (I_("unmap-event"),
1573 G_TYPE_FROM_CLASS (gobject_class),
1575 G_STRUCT_OFFSET (GtkWidgetClass, unmap_event),
1576 _gtk_boolean_handled_accumulator, NULL,
1577 _gtk_marshal_BOOLEAN__BOXED,
1579 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1582 * GtkWidget::property-notify-event
1583 * @widget: the object which received the signal
1584 * @event: the #GdkEventProperty which triggered this signal
1586 * The ::property-notify-event signal will be emitted when a property on
1587 * the @widget's window has been changed or deleted.
1589 * To receive this signal, the #GdkWindow associated to the widget needs
1590 * to enable the #GDK_PROPERTY_CHANGE_MASK mask.
1592 * Returns: %TRUE to stop other handlers from being invoked for the event.
1593 * %FALSE to propagate the event further.
1595 widget_signals[PROPERTY_NOTIFY_EVENT] =
1596 g_signal_new (I_("property-notify-event"),
1597 G_TYPE_FROM_CLASS (gobject_class),
1599 G_STRUCT_OFFSET (GtkWidgetClass, property_notify_event),
1600 _gtk_boolean_handled_accumulator, NULL,
1601 _gtk_marshal_BOOLEAN__BOXED,
1603 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1606 * GtkWidget::selection-clear-event
1607 * @widget: the object which received the signal
1608 * @event: the #GdkEventSelection which triggered this signal
1610 * The ::selection-clear-event signal will be emitted when the
1611 * the @widget's window has lost ownership of a selection.
1613 * Returns: %TRUE to stop other handlers from being invoked for the event.
1614 * %FALSE to propagate the event further.
1616 widget_signals[SELECTION_CLEAR_EVENT] =
1617 g_signal_new (I_("selection-clear-event"),
1618 G_TYPE_FROM_CLASS (gobject_class),
1620 G_STRUCT_OFFSET (GtkWidgetClass, selection_clear_event),
1621 _gtk_boolean_handled_accumulator, NULL,
1622 _gtk_marshal_BOOLEAN__BOXED,
1624 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1627 * GtkWidget::selection-request-event
1628 * @widget: the object which received the signal
1629 * @event: the #GdkEventSelection which triggered this signal
1631 * The ::selection-request-event signal will be emitted when
1632 * another client requests ownership of the selection owned by
1633 * the @widget's window.
1635 * Returns: %TRUE to stop other handlers from being invoked for the event.
1636 * %FALSE to propagate the event further.
1638 widget_signals[SELECTION_REQUEST_EVENT] =
1639 g_signal_new (I_("selection-request-event"),
1640 G_TYPE_FROM_CLASS (gobject_class),
1642 G_STRUCT_OFFSET (GtkWidgetClass, selection_request_event),
1643 _gtk_boolean_handled_accumulator, NULL,
1644 _gtk_marshal_BOOLEAN__BOXED,
1646 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1649 * GtkWidget::selection-notify-event:
1650 * @widget: the object which received the signal.
1653 * Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
1655 widget_signals[SELECTION_NOTIFY_EVENT] =
1656 g_signal_new (I_("selection-notify-event"),
1657 G_TYPE_FROM_CLASS (gobject_class),
1659 G_STRUCT_OFFSET (GtkWidgetClass, selection_notify_event),
1660 _gtk_boolean_handled_accumulator, NULL,
1661 _gtk_marshal_BOOLEAN__BOXED,
1663 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1666 * GtkWidget::selection-received:
1667 * @widget: the object which received the signal.
1671 widget_signals[SELECTION_RECEIVED] =
1672 g_signal_new (I_("selection-received"),
1673 G_TYPE_FROM_CLASS (gobject_class),
1675 G_STRUCT_OFFSET (GtkWidgetClass, selection_received),
1677 _gtk_marshal_VOID__BOXED_UINT,
1679 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
1683 * GtkWidget::selection-get:
1684 * @widget: the object which received the signal.
1689 widget_signals[SELECTION_GET] =
1690 g_signal_new (I_("selection-get"),
1691 G_TYPE_FROM_CLASS (gobject_class),
1693 G_STRUCT_OFFSET (GtkWidgetClass, selection_get),
1695 _gtk_marshal_VOID__BOXED_UINT_UINT,
1697 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
1702 * GtkWidget::proximity-in-event
1703 * @widget: the object which received the signal
1704 * @event: the #GdkEventProximity which triggered this signal
1706 * To receive this signal the #GdkWindow associated to the widget needs
1707 * to enable the #GDK_PROXIMITY_IN_MASK mask.
1709 * This signal will be sent to the grab widget if there is one.
1711 * Returns: %TRUE to stop other handlers from being invoked for the event.
1712 * %FALSE to propagate the event further.
1714 widget_signals[PROXIMITY_IN_EVENT] =
1715 g_signal_new (I_("proximity-in-event"),
1716 G_TYPE_FROM_CLASS (gobject_class),
1718 G_STRUCT_OFFSET (GtkWidgetClass, proximity_in_event),
1719 _gtk_boolean_handled_accumulator, NULL,
1720 _gtk_marshal_BOOLEAN__BOXED,
1722 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1725 * GtkWidget::proximity-out-event
1726 * @widget: the object which received the signal
1727 * @event: the #GdkEventProximity which triggered this signal
1729 * To receive this signal the #GdkWindow associated to the widget needs
1730 * to enable the #GDK_PROXIMITY_OUT_MASK mask.
1732 * This signal will be sent to the grab widget if there is one.
1734 * Returns: %TRUE to stop other handlers from being invoked for the event.
1735 * %FALSE to propagate the event further.
1737 widget_signals[PROXIMITY_OUT_EVENT] =
1738 g_signal_new (I_("proximity-out-event"),
1739 G_TYPE_FROM_CLASS (gobject_class),
1741 G_STRUCT_OFFSET (GtkWidgetClass, proximity_out_event),
1742 _gtk_boolean_handled_accumulator, NULL,
1743 _gtk_marshal_BOOLEAN__BOXED,
1745 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1748 * GtkWidget::drag-leave:
1749 * @widget: the object which received the signal.
1750 * @drag_context: the drag context
1751 * @time: the timestamp of the motion event
1753 * The ::drag-leave signal is emitted on the drop site when the cursor
1754 * leaves the widget. A typical reason to connect to this signal is to
1755 * undo things done in #GtkWidget::drag-motion, e.g. undo highlighting
1756 * with gtk_drag_unhighlight()
1758 widget_signals[DRAG_LEAVE] =
1759 g_signal_new (I_("drag-leave"),
1760 G_TYPE_FROM_CLASS (gobject_class),
1762 G_STRUCT_OFFSET (GtkWidgetClass, drag_leave),
1764 _gtk_marshal_VOID__OBJECT_UINT,
1766 GDK_TYPE_DRAG_CONTEXT,
1770 * GtkWidget::drag-begin:
1771 * @widget: the object which received the signal
1772 * @drag_context: the drag context
1774 * The ::drag-begin signal is emitted on the drag source when a drag is
1775 * started. A typical reason to connect to this signal is to set up a
1776 * custom drag icon with gtk_drag_source_set_icon().
1778 * Note that some widgets set up a drag icon in the default handler of
1779 * this signal, so you may have to use g_signal_connect_after() to
1780 * override what the default handler did.
1782 widget_signals[DRAG_BEGIN] =
1783 g_signal_new (I_("drag-begin"),
1784 G_TYPE_FROM_CLASS (gobject_class),
1786 G_STRUCT_OFFSET (GtkWidgetClass, drag_begin),
1788 _gtk_marshal_VOID__OBJECT,
1790 GDK_TYPE_DRAG_CONTEXT);
1793 * GtkWidget::drag-end:
1794 * @widget: the object which received the signal
1795 * @drag_context: the drag context
1797 * The ::drag-end signal is emitted on the drag source when a drag is
1798 * finished. A typical reason to connect to this signal is to undo
1799 * things done in #GtkWidget::drag-begin.
1801 widget_signals[DRAG_END] =
1802 g_signal_new (I_("drag-end"),
1803 G_TYPE_FROM_CLASS (gobject_class),
1805 G_STRUCT_OFFSET (GtkWidgetClass, drag_end),
1807 _gtk_marshal_VOID__OBJECT,
1809 GDK_TYPE_DRAG_CONTEXT);
1812 * GtkWidget::drag-data-delete:
1813 * @widget: the object which received the signal
1814 * @drag_context: the drag context
1816 * The ::drag-data-delete signal is emitted on the drag source when a drag
1817 * with the action %GDK_ACTION_MOVE is successfully completed. The signal
1818 * handler is responsible for deleting the data that has been dropped. What
1819 * "delete" means depends on the context of the drag operation.
1821 widget_signals[DRAG_DATA_DELETE] =
1822 g_signal_new (I_("drag-data-delete"),
1823 G_TYPE_FROM_CLASS (gobject_class),
1825 G_STRUCT_OFFSET (GtkWidgetClass, drag_data_delete),
1827 _gtk_marshal_VOID__OBJECT,
1829 GDK_TYPE_DRAG_CONTEXT);
1832 * GtkWidget::drag-failed:
1833 * @widget: the object which received the signal
1834 * @drag_context: the drag context
1835 * @result: the result of the drag operation
1837 * The ::drag-failed signal is emitted on the drag source when a drag has
1838 * failed. The signal handler may hook custom code to handle a failed DND
1839 * operation based on the type of error, it returns %TRUE is the failure has
1840 * been already handled (not showing the default "drag operation failed"
1841 * animation), otherwise it returns %FALSE.
1843 * Return value: %TRUE if the failed drag operation has been already handled.
1847 widget_signals[DRAG_FAILED] =
1848 g_signal_new (I_("drag-failed"),
1849 G_TYPE_FROM_CLASS (gobject_class),
1851 0, _gtk_boolean_handled_accumulator, NULL,
1852 _gtk_marshal_BOOLEAN__OBJECT_ENUM,
1854 GDK_TYPE_DRAG_CONTEXT,
1855 GTK_TYPE_DRAG_RESULT);
1858 * GtkWidget::drag-motion:
1859 * @widget: the object which received the signal
1860 * @drag_context: the drag context
1861 * @x: the x coordinate of the current cursor position
1862 * @y: the y coordinate of the current cursor position
1863 * @time: the timestamp of the motion event
1864 * @returns: whether the cursor position is in a drop zone
1866 * The drag-motion signal is emitted on the drop site when the user
1867 * moves the cursor over the widget during a drag. The signal handler
1868 * must determine whether the cursor position is in a drop zone or not.
1869 * If it is not in a drop zone, it returns %FALSE and no further processing
1870 * is necessary. Otherwise, the handler returns %TRUE. In this case, the
1871 * handler is responsible for providing the necessary information for
1872 * displaying feedback to the user, by calling gdk_drag_status().
1874 * If the decision whether the drop will be accepted or rejected can't be
1875 * made based solely on the cursor position and the type of the data, the
1876 * handler may inspect the dragged data by calling gtk_drag_get_data() and
1877 * defer the gdk_drag_status() call to the #GtkWidget::drag-data-received
1878 * handler. Note that you cannot not pass #GTK_DEST_DEFAULT_DROP,
1879 * #GTK_DEST_DEFAULT_MOTION or #GTK_DEST_DEFAULT_ALL to gtk_drag_dest_set()
1880 * when using the drag-motion signal that way.
1882 * Also note that there is no drag-enter signal. The drag receiver has to
1883 * keep track of whether he has received any drag-motion signals since the
1884 * last #GtkWidget::drag-leave and if not, treat the drag-motion signal as
1885 * an "enter" signal. Upon an "enter", the handler will typically highlight
1886 * the drop site with gtk_drag_highlight().
1889 * drag_motion (GtkWidget *widget,
1890 * GdkDragContext *context,
1897 * PrivateData *private_data = GET_PRIVATE_DATA (widget);
1899 * if (!private_data->drag_highlight)
1901 * private_data->drag_highlight = 1;
1902 * gtk_drag_highlight (widget);
1905 * target = gtk_drag_dest_find_target (widget, context, NULL);
1906 * if (target == GDK_NONE)
1907 * gdk_drag_status (context, 0, time);
1910 * private_data->pending_status = context->suggested_action;
1911 * gtk_drag_get_data (widget, context, target, time);
1918 * drag_data_received (GtkWidget *widget,
1919 * GdkDragContext *context,
1922 * GtkSelectionData *selection_data,
1926 * PrivateData *private_data = GET_PRIVATE_DATA (widget);
1928 * if (private_data->suggested_action)
1930 * private_data->suggested_action = 0;
1932 * /* We are getting this data due to a request in drag_motion,
1933 * * rather than due to a request in drag_drop, so we are just
1934 * * supposed to call gdk_drag_status (), not actually paste in
1937 * str = gtk_selection_data_get_text (selection_data);
1938 * if (!data_is_acceptable (str))
1939 * gdk_drag_status (context, 0, time);
1941 * gdk_drag_status (context, private_data->suggested_action, time);
1945 * /* accept the drop */
1950 widget_signals[DRAG_MOTION] =
1951 g_signal_new (I_("drag-motion"),
1952 G_TYPE_FROM_CLASS (gobject_class),
1954 G_STRUCT_OFFSET (GtkWidgetClass, drag_motion),
1955 _gtk_boolean_handled_accumulator, NULL,
1956 _gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
1958 GDK_TYPE_DRAG_CONTEXT,
1964 * GtkWidget::drag-drop:
1965 * @widget: the object which received the signal
1966 * @drag_context: the drag context
1967 * @x: the x coordinate of the current cursor position
1968 * @y: the y coordinate of the current cursor position
1969 * @time: the timestamp of the motion event
1970 * @returns: whether the cursor position is in a drop zone
1972 * The ::drag-drop signal is emitted on the drop site when the user drops
1973 * the data onto the widget. The signal handler must determine whether
1974 * the cursor position is in a drop zone or not. If it is not in a drop
1975 * zone, it returns %FALSE and no further processing is necessary.
1976 * Otherwise, the handler returns %TRUE. In this case, the handler must
1977 * ensure that gtk_drag_finish() is called to let the source know that
1978 * the drop is done. The call to gtk_drag_finish() can be done either
1979 * directly or in a #GtkWidget::drag-data-received handler which gets
1980 * triggered by calling gtk_drag_get_data() to receive the data for one
1981 * or more of the supported targets.
1983 widget_signals[DRAG_DROP] =
1984 g_signal_new (I_("drag-drop"),
1985 G_TYPE_FROM_CLASS (gobject_class),
1987 G_STRUCT_OFFSET (GtkWidgetClass, drag_drop),
1988 _gtk_boolean_handled_accumulator, NULL,
1989 _gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
1991 GDK_TYPE_DRAG_CONTEXT,
1997 * GtkWidget::drag-data-get:
1998 * @widget: the object which received the signal
1999 * @drag_context: the drag context
2000 * @data: the #GtkSelectionData to be filled with the dragged data
2001 * @info: the info that has been registered with the target in the
2003 * @time: the timestamp at which the data was requested
2005 * The ::drag-data-get signal is emitted on the drag source when the drop
2006 * site requests the data which is dragged. It is the responsibility of
2007 * the signal handler to fill @data with the data in the format which
2008 * is indicated by @info. See gtk_selection_data_set() and
2009 * gtk_selection_data_set_text().
2011 widget_signals[DRAG_DATA_GET] =
2012 g_signal_new (I_("drag-data-get"),
2013 G_TYPE_FROM_CLASS (gobject_class),
2015 G_STRUCT_OFFSET (GtkWidgetClass, drag_data_get),
2017 _gtk_marshal_VOID__OBJECT_BOXED_UINT_UINT,
2019 GDK_TYPE_DRAG_CONTEXT,
2020 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
2025 * GtkWidget::drag-data-received:
2026 * @widget: the object which received the signal
2027 * @drag_context: the drag context
2028 * @x: where the drop happened
2029 * @y: where the drop happened
2030 * @data: the received data
2031 * @info: the info that has been registered with the target in the
2033 * @time: the timestamp at which the data was received
2035 * The ::drag-data-received signal is emitted on the drop site when the
2036 * dragged data has been received. If the data was received in order to
2037 * determine whether the drop will be accepted, the handler is expected
2038 * to call gdk_drag_status() and <emphasis>not</emphasis> finish the drag.
2039 * If the data was received in response to a #GtkWidget::drag-drop signal
2040 * (and this is the last target to be received), the handler for this
2041 * signal is expected to process the received data and then call
2042 * gtk_drag_finish(), setting the @success parameter depending on whether
2043 * the data was processed successfully.
2045 * The handler may inspect and modify @drag_context->action before calling
2046 * gtk_drag_finish(), e.g. to implement %GDK_ACTION_ASK as shown in the
2047 * following example:
2050 * drag_data_received (GtkWidget *widget,
2051 * GdkDragContext *drag_context,
2054 * GtkSelectionData *data,
2058 * if ((data->length >= 0) && (data->format == 8))
2060 * if (drag_context->action == GDK_ACTION_ASK)
2062 * GtkWidget *dialog;
2065 * dialog = gtk_message_dialog_new (NULL,
2066 * GTK_DIALOG_MODAL |
2067 * GTK_DIALOG_DESTROY_WITH_PARENT,
2069 * GTK_BUTTONS_YES_NO,
2070 * "Move the data ?\n");
2071 * response = gtk_dialog_run (GTK_DIALOG (dialog));
2072 * gtk_widget_destroy (dialog);
2074 * if (response == GTK_RESPONSE_YES)
2075 * drag_context->action = GDK_ACTION_MOVE;
2077 * drag_context->action = GDK_ACTION_COPY;
2080 * gtk_drag_finish (drag_context, TRUE, FALSE, time);
2084 * gtk_drag_finish (drag_context, FALSE, FALSE, time);
2088 widget_signals[DRAG_DATA_RECEIVED] =
2089 g_signal_new (I_("drag-data-received"),
2090 G_TYPE_FROM_CLASS (gobject_class),
2092 G_STRUCT_OFFSET (GtkWidgetClass, drag_data_received),
2094 _gtk_marshal_VOID__OBJECT_INT_INT_BOXED_UINT_UINT,
2096 GDK_TYPE_DRAG_CONTEXT,
2099 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
2104 * GtkWidget::visibility-notify-event:
2105 * @widget: the object which received the signal
2106 * @event: the #GdkEventVisibility which triggered this signal
2108 * The ::visibility-notify-event will be emitted when the @widget's window
2109 * is obscured or unobscured.
2111 * To receive this signal the #GdkWindow associated to the widget needs
2112 * to enable the #GDK_VISIBILITY_NOTIFY_MASK mask.
2114 * Returns: %TRUE to stop other handlers from being invoked for the event.
2115 * %FALSE to propagate the event further.
2117 widget_signals[VISIBILITY_NOTIFY_EVENT] =
2118 g_signal_new (I_("visibility-notify-event"),
2119 G_TYPE_FROM_CLASS (gobject_class),
2121 G_STRUCT_OFFSET (GtkWidgetClass, visibility_notify_event),
2122 _gtk_boolean_handled_accumulator, NULL,
2123 _gtk_marshal_BOOLEAN__BOXED,
2125 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2128 * GtkWidget::client-event:
2129 * @widget: the object which received the signal
2130 * @event: the #GdkEventClient which triggered this signal
2132 * The ::client-event will be emitted when the @widget's window
2133 * receives a message (via a ClientMessage event) from another
2136 * Returns: %TRUE to stop other handlers from being invoked for
2137 * the event. %FALSE to propagate the event further.
2139 widget_signals[CLIENT_EVENT] =
2140 g_signal_new (I_("client-event"),
2141 G_TYPE_FROM_CLASS (gobject_class),
2143 G_STRUCT_OFFSET (GtkWidgetClass, client_event),
2144 _gtk_boolean_handled_accumulator, NULL,
2145 _gtk_marshal_BOOLEAN__BOXED,
2147 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2150 * GtkWidget::no-expose-event:
2151 * @widget: the object which received the signal
2152 * @event: the #GdkEventNoExpose which triggered this signal
2154 * The ::no-expose-event will be emitted when the @widget's window is
2155 * drawn as a copy of another #GdkDrawable (with gdk_draw_drawable() or
2156 * gdk_window_copy_area()) which was completely unobscured. If the source
2157 * window was partially obscured #GdkEventExpose events will be generated
2160 * Returns: %TRUE to stop other handlers from being invoked for the event.
2161 * %FALSE to propagate the event further.
2163 widget_signals[NO_EXPOSE_EVENT] =
2164 g_signal_new (I_("no-expose-event"),
2165 G_TYPE_FROM_CLASS (gobject_class),
2167 G_STRUCT_OFFSET (GtkWidgetClass, no_expose_event),
2168 _gtk_boolean_handled_accumulator, NULL,
2169 _gtk_marshal_BOOLEAN__BOXED,
2171 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2174 * GtkWidget::window-state-event:
2175 * @widget: the object which received the signal
2176 * @event: the #GdkEventWindowState which triggered this signal
2178 * The ::window-state-event will be emitted when the state of the
2179 * toplevel window associated to the @widget changes.
2181 * To receive this signal the #GdkWindow associated to the widget
2182 * needs to enable the #GDK_STRUCTURE_MASK mask. GDK will enable
2183 * this mask automatically for all new windows.
2185 * Returns: %TRUE to stop other handlers from being invoked for the
2186 * event. %FALSE to propagate the event further.
2188 widget_signals[WINDOW_STATE_EVENT] =
2189 g_signal_new (I_("window-state-event"),
2190 G_TYPE_FROM_CLASS (gobject_class),
2192 G_STRUCT_OFFSET (GtkWidgetClass, window_state_event),
2193 _gtk_boolean_handled_accumulator, NULL,
2194 _gtk_marshal_BOOLEAN__BOXED,
2196 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2199 * GtkWidget::damage-event:
2200 * @widget: the object which received the signal
2201 * @event: the #GdkEventExpose event
2203 * Emitted when a redirected window belonging to @widget gets drawn into.
2204 * The region/area members of the event shows what area of the redirected
2205 * drawable was drawn into.
2207 * Returns: %TRUE to stop other handlers from being invoked for the event.
2208 * %FALSE to propagate the event further.
2212 widget_signals[DAMAGE_EVENT] =
2213 g_signal_new (I_("damage-event"),
2214 G_TYPE_FROM_CLASS (gobject_class),
2217 _gtk_boolean_handled_accumulator, NULL,
2218 _gtk_marshal_BOOLEAN__BOXED,
2220 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2222 * GtkWidget::grab-broken-event:
2223 * @widget: the object which received the signal
2224 * @event: the #GdkEventGrabBroken event
2226 * Emitted when a pointer or keyboard grab on a window belonging
2227 * to @widget gets broken.
2229 * On X11, this happens when the grab window becomes unviewable
2230 * (i.e. it or one of its ancestors is unmapped), or if the same
2231 * application grabs the pointer or keyboard again.
2233 * Returns: %TRUE to stop other handlers from being invoked for
2234 * the event. %FALSE to propagate the event further.
2238 widget_signals[GRAB_BROKEN] =
2239 g_signal_new (I_("grab-broken-event"),
2240 G_TYPE_FROM_CLASS (gobject_class),
2242 G_STRUCT_OFFSET (GtkWidgetClass, grab_broken_event),
2243 _gtk_boolean_handled_accumulator, NULL,
2244 _gtk_marshal_BOOLEAN__BOXED,
2246 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2248 * GtkWidget::query-tooltip:
2249 * @widget: the object which received the signal
2250 * @x: the x coordinate of the cursor position where the request has
2251 * been emitted, relative to @widget->window
2252 * @y: the y coordinate of the cursor position where the request has
2253 * been emitted, relative to @widget->window
2254 * @keyboard_mode: %TRUE if the tooltip was trigged using the keyboard
2255 * @tooltip: a #GtkTooltip
2257 * Emitted when #GtkWidget:has-tooltip is %TRUE and the #GtkSettings:gtk-tooltip-timeout
2258 * has expired with the cursor hovering "above" @widget; or emitted when @widget got
2259 * focus in keyboard mode.
2261 * Using the given coordinates, the signal handler should determine
2262 * whether a tooltip should be shown for @widget. If this is the case
2263 * %TRUE should be returned, %FALSE otherwise. Note that if
2264 * @keyboard_mode is %TRUE, the values of @x and @y are undefined and
2265 * should not be used.
2267 * The signal handler is free to manipulate @tooltip with the therefore
2268 * destined function calls.
2270 * Returns: %TRUE if @tooltip should be shown right now, %FALSE otherwise.
2274 widget_signals[QUERY_TOOLTIP] =
2275 g_signal_new (I_("query-tooltip"),
2276 G_TYPE_FROM_CLASS (gobject_class),
2278 G_STRUCT_OFFSET (GtkWidgetClass, query_tooltip),
2279 _gtk_boolean_handled_accumulator, NULL,
2280 _gtk_marshal_BOOLEAN__INT_INT_BOOLEAN_OBJECT,
2288 * GtkWidget::popup-menu
2289 * @widget: the object which received the signal
2291 * This signal gets emitted whenever a widget should pop up a context
2292 * menu. This usually happens through the standard key binding mechanism;
2293 * by pressing a certain key while a widget is focused, the user can cause
2294 * the widget to pop up a menu. For example, the #GtkEntry widget creates
2295 * a menu with clipboard commands. See <xref linkend="checklist-popup-menu"/>
2296 * for an example of how to use this signal.
2298 * Returns: %TRUE if a menu was activated
2300 widget_signals[POPUP_MENU] =
2301 g_signal_new (I_("popup-menu"),
2302 G_TYPE_FROM_CLASS (gobject_class),
2303 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
2304 G_STRUCT_OFFSET (GtkWidgetClass, popup_menu),
2305 _gtk_boolean_handled_accumulator, NULL,
2306 _gtk_marshal_BOOLEAN__VOID,
2310 * GtkWidget::show-help:
2311 * @widget: the object which received the signal.
2314 widget_signals[SHOW_HELP] =
2315 g_signal_new (I_("show-help"),
2316 G_TYPE_FROM_CLASS (gobject_class),
2317 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
2318 G_STRUCT_OFFSET (GtkWidgetClass, show_help),
2319 _gtk_boolean_handled_accumulator, NULL,
2320 _gtk_marshal_BOOLEAN__ENUM,
2322 GTK_TYPE_WIDGET_HELP_TYPE);
2325 * GtkWidget::accel-closures-changed:
2326 * @widget: the object which received the signal.
2328 widget_signals[ACCEL_CLOSURES_CHANGED] =
2329 g_signal_new (I_("accel-closures-changed"),
2330 G_TYPE_FROM_CLASS (gobject_class),
2334 _gtk_marshal_VOID__VOID,
2338 * GtkWidget::screen-changed:
2339 * @widget: the object on which the signal is emitted
2340 * @previous_screen: the previous screen, or %NULL if the
2341 * widget was not associated with a screen before
2343 * The ::screen-changed signal gets emitted when the
2344 * screen of a widget has changed.
2346 widget_signals[SCREEN_CHANGED] =
2347 g_signal_new (I_("screen-changed"),
2348 G_TYPE_FROM_CLASS (gobject_class),
2350 G_STRUCT_OFFSET (GtkWidgetClass, screen_changed),
2352 _gtk_marshal_VOID__OBJECT,
2357 * GtkWidget::can-activate-accel:
2358 * @widget: the object which received the signal
2359 * @signal_id: the ID of a signal installed on @widget
2361 * Determines whether an accelerator that activates the signal
2362 * identified by @signal_id can currently be activated.
2363 * This signal is present to allow applications and derived
2364 * widgets to override the default #GtkWidget handling
2365 * for determining whether an accelerator can be activated.
2367 * Returns: %TRUE if the signal can be activated.
2369 widget_signals[CAN_ACTIVATE_ACCEL] =
2370 g_signal_new (I_("can-activate-accel"),
2371 G_TYPE_FROM_CLASS (gobject_class),
2373 G_STRUCT_OFFSET (GtkWidgetClass, can_activate_accel),
2374 _gtk_boolean_handled_accumulator, NULL,
2375 _gtk_marshal_BOOLEAN__UINT,
2376 G_TYPE_BOOLEAN, 1, G_TYPE_UINT);
2378 binding_set = gtk_binding_set_by_class (klass);
2379 gtk_binding_entry_add_signal (binding_set, GDK_F10, GDK_SHIFT_MASK,
2381 gtk_binding_entry_add_signal (binding_set, GDK_Menu, 0,
2384 gtk_binding_entry_add_signal (binding_set, GDK_F1, GDK_CONTROL_MASK,
2386 GTK_TYPE_WIDGET_HELP_TYPE,
2387 GTK_WIDGET_HELP_TOOLTIP);
2388 gtk_binding_entry_add_signal (binding_set, GDK_KP_F1, GDK_CONTROL_MASK,
2390 GTK_TYPE_WIDGET_HELP_TYPE,
2391 GTK_WIDGET_HELP_TOOLTIP);
2392 gtk_binding_entry_add_signal (binding_set, GDK_F1, GDK_SHIFT_MASK,
2394 GTK_TYPE_WIDGET_HELP_TYPE,
2395 GTK_WIDGET_HELP_WHATS_THIS);
2396 gtk_binding_entry_add_signal (binding_set, GDK_KP_F1, GDK_SHIFT_MASK,
2398 GTK_TYPE_WIDGET_HELP_TYPE,
2399 GTK_WIDGET_HELP_WHATS_THIS);
2401 gtk_widget_class_install_style_property (klass,
2402 g_param_spec_boolean ("interior-focus",
2403 P_("Interior Focus"),
2404 P_("Whether to draw the focus indicator inside widgets"),
2406 GTK_PARAM_READABLE));
2408 gtk_widget_class_install_style_property (klass,
2409 g_param_spec_int ("focus-line-width",
2410 P_("Focus linewidth"),
2411 P_("Width, in pixels, of the focus indicator line"),
2413 GTK_PARAM_READABLE));
2415 gtk_widget_class_install_style_property (klass,
2416 g_param_spec_string ("focus-line-pattern",
2417 P_("Focus line dash pattern"),
2418 P_("Dash pattern used to draw the focus indicator"),
2420 GTK_PARAM_READABLE));
2421 gtk_widget_class_install_style_property (klass,
2422 g_param_spec_int ("focus-padding",
2423 P_("Focus padding"),
2424 P_("Width, in pixels, between focus indicator and the widget 'box'"),
2426 GTK_PARAM_READABLE));
2427 gtk_widget_class_install_style_property (klass,
2428 g_param_spec_boxed ("cursor-color",
2430 P_("Color with which to draw insertion cursor"),
2432 GTK_PARAM_READABLE));
2433 gtk_widget_class_install_style_property (klass,
2434 g_param_spec_boxed ("secondary-cursor-color",
2435 P_("Secondary cursor color"),
2436 P_("Color with which to draw the secondary insertion cursor when editing mixed right-to-left and left-to-right text"),
2438 GTK_PARAM_READABLE));
2439 gtk_widget_class_install_style_property (klass,
2440 g_param_spec_float ("cursor-aspect-ratio",
2441 P_("Cursor line aspect ratio"),
2442 P_("Aspect ratio with which to draw insertion cursor"),
2444 GTK_PARAM_READABLE));
2447 * GtkWidget:draw-border:
2449 * The "draw-border" style property defines the size of areas outside
2450 * the widget's allocation to draw.
2454 gtk_widget_class_install_style_property (klass,
2455 g_param_spec_boxed ("draw-border",
2457 P_("Size of areas outside the widget's allocation to draw"),
2459 GTK_PARAM_READABLE));
2462 * GtkWidget:link-color:
2464 * The "link-color" style property defines the color of unvisited links.
2468 gtk_widget_class_install_style_property (klass,
2469 g_param_spec_boxed ("link-color",
2470 P_("Unvisited Link Color"),
2471 P_("Color of unvisited links"),
2473 GTK_PARAM_READABLE));
2476 * GtkWidget:visited-link-color:
2478 * The "visited-link-color" style property defines the color of visited links.
2482 gtk_widget_class_install_style_property (klass,
2483 g_param_spec_boxed ("visited-link-color",
2484 P_("Visited Link Color"),
2485 P_("Color of visited links"),
2487 GTK_PARAM_READABLE));
2490 * GtkWidget:wide-separators:
2492 * The "wide-separators" style property defines whether separators have
2493 * configurable width and should be drawn using a box instead of a line.
2497 gtk_widget_class_install_style_property (klass,
2498 g_param_spec_boolean ("wide-separators",
2499 P_("Wide Separators"),
2500 P_("Whether separators have configurable width and should be drawn using a box instead of a line"),
2502 GTK_PARAM_READABLE));
2505 * GtkWidget:separator-width:
2507 * The "separator-width" style property defines the width of separators.
2508 * This property only takes effect if #GtkWidget:wide-separators is %TRUE.
2512 gtk_widget_class_install_style_property (klass,
2513 g_param_spec_int ("separator-width",
2514 P_("Separator Width"),
2515 P_("The width of separators if wide-separators is TRUE"),
2517 GTK_PARAM_READABLE));
2520 * GtkWidget:separator-height:
2522 * The "separator-height" style property defines the height of separators.
2523 * This property only takes effect if #GtkWidget:wide-separators is %TRUE.
2527 gtk_widget_class_install_style_property (klass,
2528 g_param_spec_int ("separator-height",
2529 P_("Separator Height"),
2530 P_("The height of separators if \"wide-separators\" is TRUE"),
2532 GTK_PARAM_READABLE));
2535 * GtkWidget:scroll-arrow-hlength:
2537 * The "scroll-arrow-hlength" style property defines the length of
2538 * horizontal scroll arrows.
2542 gtk_widget_class_install_style_property (klass,
2543 g_param_spec_int ("scroll-arrow-hlength",
2544 P_("Horizontal Scroll Arrow Length"),
2545 P_("The length of horizontal scroll arrows"),
2547 GTK_PARAM_READABLE));
2550 * GtkWidget:scroll-arrow-vlength:
2552 * The "scroll-arrow-vlength" style property defines the length of
2553 * vertical scroll arrows.
2557 gtk_widget_class_install_style_property (klass,
2558 g_param_spec_int ("scroll-arrow-vlength",
2559 P_("Vertical Scroll Arrow Length"),
2560 P_("The length of vertical scroll arrows"),
2562 GTK_PARAM_READABLE));
2566 gtk_widget_base_class_finalize (GtkWidgetClass *klass)
2570 list = g_param_spec_pool_list_owned (style_property_spec_pool, G_OBJECT_CLASS_TYPE (klass));
2571 for (node = list; node; node = node->next)
2573 GParamSpec *pspec = node->data;
2575 g_param_spec_pool_remove (style_property_spec_pool, pspec);
2576 g_param_spec_unref (pspec);
2582 gtk_widget_set_property (GObject *object,
2584 const GValue *value,
2587 GtkWidget *widget = GTK_WIDGET (object);
2592 gchar *tooltip_markup;
2593 const gchar *tooltip_text;
2594 GtkWindow *tooltip_window;
2597 gtk_widget_set_name (widget, g_value_get_string (value));
2600 gtk_container_add (GTK_CONTAINER (g_value_get_object (value)), widget);
2602 case PROP_WIDTH_REQUEST:
2603 gtk_widget_set_usize_internal (widget, g_value_get_int (value), -2);
2605 case PROP_HEIGHT_REQUEST:
2606 gtk_widget_set_usize_internal (widget, -2, g_value_get_int (value));
2609 gtk_widget_set_visible (widget, g_value_get_boolean (value));
2611 case PROP_SENSITIVE:
2612 gtk_widget_set_sensitive (widget, g_value_get_boolean (value));
2614 case PROP_APP_PAINTABLE:
2615 gtk_widget_set_app_paintable (widget, g_value_get_boolean (value));
2617 case PROP_CAN_FOCUS:
2618 gtk_widget_set_can_focus (widget, g_value_get_boolean (value));
2620 case PROP_HAS_FOCUS:
2621 if (g_value_get_boolean (value))
2622 gtk_widget_grab_focus (widget);
2625 if (g_value_get_boolean (value))
2626 gtk_widget_grab_focus (widget);
2628 case PROP_CAN_DEFAULT:
2629 gtk_widget_set_can_default (widget, g_value_get_boolean (value));
2631 case PROP_HAS_DEFAULT:
2632 if (g_value_get_boolean (value))
2633 gtk_widget_grab_default (widget);
2635 case PROP_RECEIVES_DEFAULT:
2636 gtk_widget_set_receives_default (widget, g_value_get_boolean (value));
2639 gtk_widget_set_style (widget, g_value_get_object (value));
2642 if (!GTK_WIDGET_REALIZED (widget) && !GTK_WIDGET_NO_WINDOW (widget))
2643 gtk_widget_set_events (widget, g_value_get_flags (value));
2645 case PROP_EXTENSION_EVENTS:
2646 gtk_widget_set_extension_events (widget, g_value_get_enum (value));
2648 case PROP_NO_SHOW_ALL:
2649 gtk_widget_set_no_show_all (widget, g_value_get_boolean (value));
2651 case PROP_HAS_TOOLTIP:
2652 gtk_widget_real_set_has_tooltip (widget,
2653 g_value_get_boolean (value), FALSE);
2655 case PROP_TOOLTIP_MARKUP:
2656 tooltip_window = g_object_get_qdata (object, quark_tooltip_window);
2657 tooltip_markup = g_value_dup_string (value);
2659 /* Treat an empty string as a NULL string,
2660 * because an empty string would be useless for a tooltip:
2662 if (tooltip_markup && (strlen (tooltip_markup) == 0))
2664 g_free (tooltip_markup);
2665 tooltip_markup = NULL;
2668 g_object_set_qdata_full (object, quark_tooltip_markup,
2669 tooltip_markup, g_free);
2671 tmp = (tooltip_window != NULL || tooltip_markup != NULL);
2672 gtk_widget_real_set_has_tooltip (widget, tmp, FALSE);
2673 if (GTK_WIDGET_VISIBLE (widget))
2674 gtk_widget_queue_tooltip_query (widget);
2676 case PROP_TOOLTIP_TEXT:
2677 tooltip_window = g_object_get_qdata (object, quark_tooltip_window);
2679 tooltip_text = g_value_get_string (value);
2681 /* Treat an empty string as a NULL string,
2682 * because an empty string would be useless for a tooltip:
2684 if (tooltip_text && (strlen (tooltip_text) == 0))
2685 tooltip_text = NULL;
2687 tooltip_markup = tooltip_text ? g_markup_escape_text (tooltip_text, -1) : NULL;
2689 g_object_set_qdata_full (object, quark_tooltip_markup,
2690 tooltip_markup, g_free);
2692 tmp = (tooltip_window != NULL || tooltip_markup != NULL);
2693 gtk_widget_real_set_has_tooltip (widget, tmp, FALSE);
2694 if (GTK_WIDGET_VISIBLE (widget))
2695 gtk_widget_queue_tooltip_query (widget);
2697 case PROP_DOUBLE_BUFFERED:
2698 gtk_widget_set_double_buffered (widget, g_value_get_boolean (value));
2701 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2707 gtk_widget_get_property (GObject *object,
2712 GtkWidget *widget = GTK_WIDGET (object);
2721 g_value_set_string (value, widget->name);
2723 g_value_set_static_string (value, "");
2726 g_value_set_object (value, widget->parent);
2728 case PROP_WIDTH_REQUEST:
2731 gtk_widget_get_size_request (widget, &w, NULL);
2732 g_value_set_int (value, w);
2735 case PROP_HEIGHT_REQUEST:
2738 gtk_widget_get_size_request (widget, NULL, &h);
2739 g_value_set_int (value, h);
2743 g_value_set_boolean (value, (GTK_WIDGET_VISIBLE (widget) != FALSE));
2745 case PROP_SENSITIVE:
2746 g_value_set_boolean (value, (GTK_WIDGET_SENSITIVE (widget) != FALSE));
2748 case PROP_APP_PAINTABLE:
2749 g_value_set_boolean (value, (gtk_widget_get_app_paintable (widget) != FALSE));
2751 case PROP_CAN_FOCUS:
2752 g_value_set_boolean (value, (gtk_widget_get_can_focus (widget) != FALSE));
2754 case PROP_HAS_FOCUS:
2755 g_value_set_boolean (value, (GTK_WIDGET_HAS_FOCUS (widget) != FALSE));
2758 g_value_set_boolean (value, (gtk_widget_is_focus (widget)));
2760 case PROP_CAN_DEFAULT:
2761 g_value_set_boolean (value, (gtk_widget_get_can_default (widget) != FALSE));
2763 case PROP_HAS_DEFAULT:
2764 g_value_set_boolean (value, (gtk_widget_has_default (widget) != FALSE));
2766 case PROP_RECEIVES_DEFAULT:
2767 g_value_set_boolean (value, (gtk_widget_get_receives_default (widget) != FALSE));
2769 case PROP_COMPOSITE_CHILD:
2770 g_value_set_boolean (value, (GTK_WIDGET_FLAGS (widget) & GTK_COMPOSITE_CHILD) != 0 );
2773 g_value_set_object (value, gtk_widget_get_style (widget));
2776 eventp = g_object_get_qdata (G_OBJECT (widget), quark_event_mask);
2777 g_value_set_flags (value, GPOINTER_TO_INT (eventp));
2779 case PROP_EXTENSION_EVENTS:
2780 modep = g_object_get_qdata (G_OBJECT (widget), quark_extension_event_mode);
2781 g_value_set_enum (value, GPOINTER_TO_INT (modep));
2783 case PROP_NO_SHOW_ALL:
2784 g_value_set_boolean (value, gtk_widget_get_no_show_all (widget));
2786 case PROP_HAS_TOOLTIP:
2787 g_value_set_boolean (value, GPOINTER_TO_UINT (g_object_get_qdata (object, quark_has_tooltip)));
2789 case PROP_TOOLTIP_TEXT:
2791 gchar *escaped = g_object_get_qdata (object, quark_tooltip_markup);
2794 if (escaped && !pango_parse_markup (escaped, -1, 0, NULL, &text, NULL, NULL))
2795 g_assert (NULL == text); /* text should still be NULL in case of markup errors */
2797 g_value_set_string (value, text);
2801 case PROP_TOOLTIP_MARKUP:
2802 g_value_set_string (value, g_object_get_qdata (object, quark_tooltip_markup));
2805 g_value_set_object (value, gtk_widget_get_window (widget));
2807 case PROP_DOUBLE_BUFFERED:
2808 g_value_set_boolean (value, gtk_widget_get_double_buffered (widget));
2811 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2817 gtk_widget_init (GtkWidget *widget)
2819 GTK_PRIVATE_FLAGS (widget) = PRIVATE_GTK_CHILD_VISIBLE;
2820 widget->state = GTK_STATE_NORMAL;
2821 widget->saved_state = GTK_STATE_NORMAL;
2822 widget->name = NULL;
2823 widget->requisition.width = 0;
2824 widget->requisition.height = 0;
2825 widget->allocation.x = -1;
2826 widget->allocation.y = -1;
2827 widget->allocation.width = 1;
2828 widget->allocation.height = 1;
2829 widget->window = NULL;
2830 widget->parent = NULL;
2832 GTK_WIDGET_SET_FLAGS (widget,
2834 GTK_PARENT_SENSITIVE |
2835 (composite_child_stack ? GTK_COMPOSITE_CHILD : 0) |
2836 GTK_DOUBLE_BUFFERED);
2838 GTK_PRIVATE_SET_FLAG (widget, GTK_REDRAW_ON_ALLOC);
2839 GTK_PRIVATE_SET_FLAG (widget, GTK_REQUEST_NEEDED);
2840 GTK_PRIVATE_SET_FLAG (widget, GTK_ALLOC_NEEDED);
2842 widget->style = gtk_widget_get_default_style ();
2843 g_object_ref (widget->style);
2848 gtk_widget_dispatch_child_properties_changed (GtkWidget *widget,
2850 GParamSpec **pspecs)
2852 GtkWidget *container = widget->parent;
2855 for (i = 0; widget->parent == container && i < n_pspecs; i++)
2856 g_signal_emit (widget, widget_signals[CHILD_NOTIFY], g_quark_from_string (pspecs[i]->name), pspecs[i]);
2860 * gtk_widget_freeze_child_notify:
2861 * @widget: a #GtkWidget
2863 * Stops emission of #GtkWidget::child-notify signals on @widget. The
2864 * signals are queued until gtk_widget_thaw_child_notify() is called
2867 * This is the analogue of g_object_freeze_notify() for child properties.
2870 gtk_widget_freeze_child_notify (GtkWidget *widget)
2872 g_return_if_fail (GTK_IS_WIDGET (widget));
2874 if (!G_OBJECT (widget)->ref_count)
2877 g_object_ref (widget);
2878 g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
2879 g_object_unref (widget);
2883 * gtk_widget_child_notify:
2884 * @widget: a #GtkWidget
2885 * @child_property: the name of a child property installed on the
2886 * class of @widget<!-- -->'s parent
2888 * Emits a #GtkWidget::child-notify signal for the
2889 * <link linkend="child-properties">child property</link> @child_property
2892 * This is the analogue of g_object_notify() for child properties.
2895 gtk_widget_child_notify (GtkWidget *widget,
2896 const gchar *child_property)
2900 g_return_if_fail (GTK_IS_WIDGET (widget));
2901 g_return_if_fail (child_property != NULL);
2902 if (!G_OBJECT (widget)->ref_count || !widget->parent)
2905 g_object_ref (widget);
2906 pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
2908 G_OBJECT_TYPE (widget->parent),
2911 g_warning ("%s: container class `%s' has no child property named `%s'",
2913 G_OBJECT_TYPE_NAME (widget->parent),
2917 GObjectNotifyQueue *nqueue = g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
2919 g_object_notify_queue_add (G_OBJECT (widget), nqueue, pspec);
2920 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
2922 g_object_unref (widget);
2926 * gtk_widget_thaw_child_notify:
2927 * @widget: a #GtkWidget
2929 * Reverts the effect of a previous call to gtk_widget_freeze_child_notify().
2930 * This causes all queued #GtkWidget::child-notify signals on @widget to be
2934 gtk_widget_thaw_child_notify (GtkWidget *widget)
2936 GObjectNotifyQueue *nqueue;
2938 g_return_if_fail (GTK_IS_WIDGET (widget));
2940 if (!G_OBJECT (widget)->ref_count)
2943 g_object_ref (widget);
2944 nqueue = g_object_notify_queue_from_object (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
2945 if (!nqueue || !nqueue->freeze_count)
2946 g_warning (G_STRLOC ": child-property-changed notification for %s(%p) is not frozen",
2947 G_OBJECT_TYPE_NAME (widget), widget);
2949 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
2950 g_object_unref (widget);
2956 * @type: type ID of the widget to create
2957 * @first_property_name: name of first property to set
2958 * @Varargs: value of first property, followed by more properties,
2961 * This is a convenience function for creating a widget and setting
2962 * its properties in one go. For example you might write:
2963 * <literal>gtk_widget_new (GTK_TYPE_LABEL, "label", "Hello World", "xalign",
2964 * 0.0, NULL)</literal> to create a left-aligned label. Equivalent to
2965 * g_object_new(), but returns a widget so you don't have to
2966 * cast the object yourself.
2968 * Return value: a new #GtkWidget of type @widget_type
2971 gtk_widget_new (GType type,
2972 const gchar *first_property_name,
2978 g_return_val_if_fail (g_type_is_a (type, GTK_TYPE_WIDGET), NULL);
2980 va_start (var_args, first_property_name);
2981 widget = (GtkWidget *)g_object_new_valist (type, first_property_name, var_args);
2989 * @widget: a #GtkWidget
2990 * @first_property_name: name of first property to set
2991 * @Varargs: value of first property, followed by more properties,
2994 * Precursor of g_object_set().
2996 * Deprecated: 2.0: Use g_object_set() instead.
2999 gtk_widget_set (GtkWidget *widget,
3000 const gchar *first_property_name,
3005 g_return_if_fail (GTK_IS_WIDGET (widget));
3007 va_start (var_args, first_property_name);
3008 g_object_set_valist (G_OBJECT (widget), first_property_name, var_args);
3013 gtk_widget_queue_draw_child (GtkWidget *widget)
3017 parent = widget->parent;
3018 if (parent && GTK_WIDGET_DRAWABLE (parent))
3019 gtk_widget_queue_draw_area (parent,
3020 widget->allocation.x,
3021 widget->allocation.y,
3022 widget->allocation.width,
3023 widget->allocation.height);
3027 * gtk_widget_unparent:
3028 * @widget: a #GtkWidget
3030 * This function is only for use in widget implementations.
3031 * Should be called by implementations of the remove method
3032 * on #GtkContainer, to dissociate a child from the container.
3035 gtk_widget_unparent (GtkWidget *widget)
3037 GObjectNotifyQueue *nqueue;
3038 GtkWidget *toplevel;
3039 GtkWidget *old_parent;
3041 g_return_if_fail (GTK_IS_WIDGET (widget));
3042 if (widget->parent == NULL)
3045 /* keep this function in sync with gtk_menu_detach()
3048 g_object_freeze_notify (G_OBJECT (widget));
3049 nqueue = g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
3051 toplevel = gtk_widget_get_toplevel (widget);
3052 if (gtk_widget_is_toplevel (toplevel))
3053 _gtk_window_unset_focus_and_default (GTK_WINDOW (toplevel), widget);
3055 if (GTK_CONTAINER (widget->parent)->focus_child == widget)
3056 gtk_container_set_focus_child (GTK_CONTAINER (widget->parent), NULL);
3058 /* If we are unanchoring the child, we save around the toplevel
3059 * to emit hierarchy changed
3061 if (GTK_WIDGET_ANCHORED (widget->parent))
3062 g_object_ref (toplevel);
3066 gtk_widget_queue_draw_child (widget);
3068 /* Reset the width and height here, to force reallocation if we
3069 * get added back to a new parent. This won't work if our new
3070 * allocation is smaller than 1x1 and we actually want a size of 1x1...
3071 * (would 0x0 be OK here?)
3073 widget->allocation.width = 1;
3074 widget->allocation.height = 1;
3076 if (GTK_WIDGET_REALIZED (widget))
3078 if (GTK_WIDGET_IN_REPARENT (widget))
3079 gtk_widget_unmap (widget);
3081 gtk_widget_unrealize (widget);
3084 /* Removing a widget from a container restores the child visible
3085 * flag to the default state, so it doesn't affect the child
3086 * in the next parent.
3088 GTK_PRIVATE_SET_FLAG (widget, GTK_CHILD_VISIBLE);
3090 old_parent = widget->parent;
3091 widget->parent = NULL;
3092 gtk_widget_set_parent_window (widget, NULL);
3093 g_signal_emit (widget, widget_signals[PARENT_SET], 0, old_parent);
3096 _gtk_widget_propagate_hierarchy_changed (widget, toplevel);
3097 g_object_unref (toplevel);
3100 g_object_notify (G_OBJECT (widget), "parent");
3101 g_object_thaw_notify (G_OBJECT (widget));
3102 if (!widget->parent)
3103 g_object_notify_queue_clear (G_OBJECT (widget), nqueue);
3104 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
3105 g_object_unref (widget);
3109 * gtk_widget_destroy:
3110 * @widget: a #GtkWidget
3112 * Destroys a widget. Equivalent to gtk_object_destroy(), except that
3113 * you don't have to cast the widget to #GtkObject. When a widget is
3114 * destroyed, it will break any references it holds to other objects.
3115 * If the widget is inside a container, the widget will be removed
3116 * from the container. If the widget is a toplevel (derived from
3117 * #GtkWindow), it will be removed from the list of toplevels, and the
3118 * reference GTK+ holds to it will be removed. Removing a
3119 * widget from its container or the list of toplevels results in the
3120 * widget being finalized, unless you've added additional references
3121 * to the widget with g_object_ref().
3123 * In most cases, only toplevel widgets (windows) require explicit
3124 * destruction, because when you destroy a toplevel its children will
3125 * be destroyed as well.
3128 gtk_widget_destroy (GtkWidget *widget)
3130 g_return_if_fail (GTK_IS_WIDGET (widget));
3132 gtk_object_destroy ((GtkObject*) widget);
3136 * gtk_widget_destroyed:
3137 * @widget: a #GtkWidget
3138 * @widget_pointer: (inout) (transfer none): address of a variable that contains @widget
3140 * This function sets *@widget_pointer to %NULL if @widget_pointer !=
3141 * %NULL. It's intended to be used as a callback connected to the
3142 * "destroy" signal of a widget. You connect gtk_widget_destroyed()
3143 * as a signal handler, and pass the address of your widget variable
3144 * as user data. Then when the widget is destroyed, the variable will
3145 * be set to %NULL. Useful for example to avoid multiple copies
3146 * of the same dialog.
3149 gtk_widget_destroyed (GtkWidget *widget,
3150 GtkWidget **widget_pointer)
3152 /* Don't make any assumptions about the
3154 * Even check widget_pointer.
3157 *widget_pointer = NULL;
3162 * @widget: a #GtkWidget
3164 * Flags a widget to be displayed. Any widget that isn't shown will
3165 * not appear on the screen. If you want to show all the widgets in a
3166 * container, it's easier to call gtk_widget_show_all() on the
3167 * container, instead of individually showing the widgets.
3169 * Remember that you have to show the containers containing a widget,
3170 * in addition to the widget itself, before it will appear onscreen.
3172 * When a toplevel container is shown, it is immediately realized and
3173 * mapped; other shown widgets are realized and mapped when their
3174 * toplevel container is realized and mapped.
3177 gtk_widget_show (GtkWidget *widget)
3179 g_return_if_fail (GTK_IS_WIDGET (widget));
3181 if (!GTK_WIDGET_VISIBLE (widget))
3183 g_object_ref (widget);
3184 if (!gtk_widget_is_toplevel (widget))
3185 gtk_widget_queue_resize (widget);
3186 g_signal_emit (widget, widget_signals[SHOW], 0);
3187 g_object_notify (G_OBJECT (widget), "visible");
3188 g_object_unref (widget);
3193 gtk_widget_real_show (GtkWidget *widget)
3195 if (!GTK_WIDGET_VISIBLE (widget))
3197 GTK_WIDGET_SET_FLAGS (widget, GTK_VISIBLE);
3199 if (widget->parent &&
3200 GTK_WIDGET_MAPPED (widget->parent) &&
3201 GTK_WIDGET_CHILD_VISIBLE (widget) &&
3202 !GTK_WIDGET_MAPPED (widget))
3203 gtk_widget_map (widget);
3208 gtk_widget_show_map_callback (GtkWidget *widget, GdkEvent *event, gint *flag)
3211 g_signal_handlers_disconnect_by_func (widget,
3212 gtk_widget_show_map_callback,
3217 * gtk_widget_show_now:
3218 * @widget: a #GtkWidget
3220 * Shows a widget. If the widget is an unmapped toplevel widget
3221 * (i.e. a #GtkWindow that has not yet been shown), enter the main
3222 * loop and wait for the window to actually be mapped. Be careful;
3223 * because the main loop is running, anything can happen during
3227 gtk_widget_show_now (GtkWidget *widget)
3231 g_return_if_fail (GTK_IS_WIDGET (widget));
3233 /* make sure we will get event */
3234 if (!GTK_WIDGET_MAPPED (widget) &&
3235 gtk_widget_is_toplevel (widget))
3237 gtk_widget_show (widget);
3239 g_signal_connect (widget, "map-event",
3240 G_CALLBACK (gtk_widget_show_map_callback),
3244 gtk_main_iteration ();
3247 gtk_widget_show (widget);
3252 * @widget: a #GtkWidget
3254 * Reverses the effects of gtk_widget_show(), causing the widget to be
3255 * hidden (invisible to the user).
3258 gtk_widget_hide (GtkWidget *widget)
3260 g_return_if_fail (GTK_IS_WIDGET (widget));
3262 if (GTK_WIDGET_VISIBLE (widget))
3264 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
3266 g_object_ref (widget);
3267 if (toplevel != widget && gtk_widget_is_toplevel (toplevel))
3268 _gtk_window_unset_focus_and_default (GTK_WINDOW (toplevel), widget);
3270 g_signal_emit (widget, widget_signals[HIDE], 0);
3271 if (!gtk_widget_is_toplevel (widget))
3272 gtk_widget_queue_resize (widget);
3273 g_object_notify (G_OBJECT (widget), "visible");
3274 g_object_unref (widget);
3279 gtk_widget_real_hide (GtkWidget *widget)
3281 if (GTK_WIDGET_VISIBLE (widget))
3283 GTK_WIDGET_UNSET_FLAGS (widget, GTK_VISIBLE);
3285 if (GTK_WIDGET_MAPPED (widget))
3286 gtk_widget_unmap (widget);
3291 * gtk_widget_hide_on_delete:
3292 * @widget: a #GtkWidget
3294 * Utility function; intended to be connected to the #GtkWidget::delete-event
3295 * signal on a #GtkWindow. The function calls gtk_widget_hide() on its
3296 * argument, then returns %TRUE. If connected to ::delete-event, the
3297 * result is that clicking the close button for a window (on the
3298 * window frame, top right corner usually) will hide but not destroy
3299 * the window. By default, GTK+ destroys windows when ::delete-event
3302 * Return value: %TRUE
3305 gtk_widget_hide_on_delete (GtkWidget *widget)
3307 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
3309 gtk_widget_hide (widget);
3315 * gtk_widget_show_all:
3316 * @widget: a #GtkWidget
3318 * Recursively shows a widget, and any child widgets (if the widget is
3322 gtk_widget_show_all (GtkWidget *widget)
3324 GtkWidgetClass *class;
3326 g_return_if_fail (GTK_IS_WIDGET (widget));
3328 if ((GTK_WIDGET_FLAGS (widget) & GTK_NO_SHOW_ALL) != 0)
3331 class = GTK_WIDGET_GET_CLASS (widget);
3333 if (class->show_all)
3334 class->show_all (widget);
3338 * gtk_widget_hide_all:
3339 * @widget: a #GtkWidget
3341 * Recursively hides a widget and any child widgets.
3344 gtk_widget_hide_all (GtkWidget *widget)
3346 GtkWidgetClass *class;
3348 g_return_if_fail (GTK_IS_WIDGET (widget));
3350 if ((GTK_WIDGET_FLAGS (widget) & GTK_NO_SHOW_ALL) != 0)
3353 class = GTK_WIDGET_GET_CLASS (widget);
3355 if (class->hide_all)
3356 class->hide_all (widget);
3361 * @widget: a #GtkWidget
3363 * This function is only for use in widget implementations. Causes
3364 * a widget to be mapped if it isn't already.
3367 gtk_widget_map (GtkWidget *widget)
3369 g_return_if_fail (GTK_IS_WIDGET (widget));
3370 g_return_if_fail (GTK_WIDGET_VISIBLE (widget));
3371 g_return_if_fail (GTK_WIDGET_CHILD_VISIBLE (widget));
3373 if (!GTK_WIDGET_MAPPED (widget))
3375 if (!GTK_WIDGET_REALIZED (widget))
3376 gtk_widget_realize (widget);
3378 g_signal_emit (widget, widget_signals[MAP], 0);
3380 if (GTK_WIDGET_NO_WINDOW (widget))
3381 gdk_window_invalidate_rect (widget->window, &widget->allocation, FALSE);
3387 * @widget: a #GtkWidget
3389 * This function is only for use in widget implementations. Causes
3390 * a widget to be unmapped if it's currently mapped.
3393 gtk_widget_unmap (GtkWidget *widget)
3395 g_return_if_fail (GTK_IS_WIDGET (widget));
3397 if (GTK_WIDGET_MAPPED (widget))
3399 if (GTK_WIDGET_NO_WINDOW (widget))
3400 gdk_window_invalidate_rect (widget->window, &widget->allocation, FALSE);
3401 _gtk_tooltip_hide (widget);
3402 g_signal_emit (widget, widget_signals[UNMAP], 0);
3407 gtk_widget_set_extension_events_internal (GtkWidget *widget,
3408 GdkExtensionMode mode,
3411 GList *free_list = NULL;
3414 if (window_list == NULL)
3416 if (!GTK_WIDGET_NO_WINDOW (widget))
3417 window_list = g_list_prepend (NULL, widget->window);
3419 window_list = gdk_window_get_children (widget->window);
3421 free_list = window_list;
3424 for (l = window_list; l != NULL; l = l->next)
3426 GdkWindow *window = l->data;
3429 gdk_window_get_user_data (window, &user_data);
3430 if (user_data == widget)
3434 gdk_input_set_extension_events (window,
3435 gdk_window_get_events (window),
3438 children = gdk_window_get_children (window);
3441 gtk_widget_set_extension_events_internal (widget, mode, children);
3442 g_list_free (children);
3448 g_list_free (free_list);
3452 * gtk_widget_realize:
3453 * @widget: a #GtkWidget
3455 * Creates the GDK (windowing system) resources associated with a
3456 * widget. For example, @widget->window will be created when a widget
3457 * is realized. Normally realization happens implicitly; if you show
3458 * a widget and all its parent containers, then the widget will be
3459 * realized and mapped automatically.
3461 * Realizing a widget requires all
3462 * the widget's parent widgets to be realized; calling
3463 * gtk_widget_realize() realizes the widget's parents in addition to
3464 * @widget itself. If a widget is not yet inside a toplevel window
3465 * when you realize it, bad things will happen.
3467 * This function is primarily used in widget implementations, and
3468 * isn't very useful otherwise. Many times when you think you might
3469 * need it, a better approach is to connect to a signal that will be
3470 * called after the widget is realized automatically, such as
3471 * GtkWidget::expose-event. Or simply g_signal_connect () to the
3472 * GtkWidget::realize signal.
3475 gtk_widget_realize (GtkWidget *widget)
3477 GdkExtensionMode mode;
3478 GtkWidgetShapeInfo *shape_info;
3480 g_return_if_fail (GTK_IS_WIDGET (widget));
3481 g_return_if_fail (GTK_WIDGET_ANCHORED (widget) ||
3482 GTK_IS_INVISIBLE (widget));
3484 if (!GTK_WIDGET_REALIZED (widget))
3487 if (GTK_IS_CONTAINER (widget) && !GTK_WIDGET_NO_WINDOW (widget))
3488 g_message ("gtk_widget_realize(%s)", G_OBJECT_TYPE_NAME (widget));
3491 if (widget->parent == NULL &&
3492 !gtk_widget_is_toplevel (widget))
3493 g_warning ("Calling gtk_widget_realize() on a widget that isn't "
3494 "inside a toplevel window is not going to work very well. "
3495 "Widgets must be inside a toplevel container before realizing them.");
3497 if (widget->parent && !GTK_WIDGET_REALIZED (widget->parent))
3498 gtk_widget_realize (widget->parent);
3500 gtk_widget_ensure_style (widget);
3502 g_signal_emit (widget, widget_signals[REALIZE], 0);
3504 gtk_widget_real_set_has_tooltip (widget,
3505 GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (widget), quark_has_tooltip)),
3508 if (GTK_WIDGET_HAS_SHAPE_MASK (widget))
3510 shape_info = g_object_get_qdata (G_OBJECT (widget), quark_shape_info);
3511 gdk_window_shape_combine_mask (widget->window,
3512 shape_info->shape_mask,
3513 shape_info->offset_x,
3514 shape_info->offset_y);
3517 shape_info = g_object_get_qdata (G_OBJECT (widget), quark_input_shape_info);
3519 gdk_window_input_shape_combine_mask (widget->window,
3520 shape_info->shape_mask,
3521 shape_info->offset_x,
3522 shape_info->offset_y);
3524 mode = gtk_widget_get_extension_events (widget);
3525 if (mode != GDK_EXTENSION_EVENTS_NONE)
3526 gtk_widget_set_extension_events_internal (widget, mode, NULL);
3531 * gtk_widget_unrealize:
3532 * @widget: a #GtkWidget
3534 * This function is only useful in widget implementations.
3535 * Causes a widget to be unrealized (frees all GDK resources
3536 * associated with the widget, such as @widget->window).
3539 gtk_widget_unrealize (GtkWidget *widget)
3541 g_return_if_fail (GTK_IS_WIDGET (widget));
3543 if (GTK_WIDGET_HAS_SHAPE_MASK (widget))
3544 gtk_widget_shape_combine_mask (widget, NULL, 0, 0);
3546 if (g_object_get_qdata (G_OBJECT (widget), quark_input_shape_info))
3547 gtk_widget_input_shape_combine_mask (widget, NULL, 0, 0);
3549 if (GTK_WIDGET_REALIZED (widget))
3551 g_object_ref (widget);
3552 _gtk_tooltip_hide (widget);
3553 g_signal_emit (widget, widget_signals[UNREALIZE], 0);
3554 GTK_WIDGET_UNSET_FLAGS (widget, GTK_REALIZED | GTK_MAPPED);
3555 g_object_unref (widget);
3559 /*****************************************
3561 *****************************************/
3564 * gtk_widget_queue_draw_area:
3565 * @widget: a #GtkWidget
3566 * @x: x coordinate of upper-left corner of rectangle to redraw
3567 * @y: y coordinate of upper-left corner of rectangle to redraw
3568 * @width: width of region to draw
3569 * @height: height of region to draw
3571 * Invalidates the rectangular area of @widget defined by @x, @y,
3572 * @width and @height by calling gdk_window_invalidate_rect() on the
3573 * widget's window and all its child windows. Once the main loop
3574 * becomes idle (after the current batch of events has been processed,
3575 * roughly), the window will receive expose events for the union of
3576 * all regions that have been invalidated.
3578 * Normally you would only use this function in widget
3579 * implementations. You might also use it, or
3580 * gdk_window_invalidate_rect() directly, to schedule a redraw of a
3581 * #GtkDrawingArea or some portion thereof.
3583 * Frequently you can just call gdk_window_invalidate_rect() or
3584 * gdk_window_invalidate_region() instead of this function. Those
3585 * functions will invalidate only a single window, instead of the
3586 * widget and all its children.
3588 * The advantage of adding to the invalidated region compared to
3589 * simply drawing immediately is efficiency; using an invalid region
3590 * ensures that you only have to redraw one time.
3593 gtk_widget_queue_draw_area (GtkWidget *widget,
3599 GdkRectangle invalid_rect;
3602 g_return_if_fail (GTK_IS_WIDGET (widget));
3604 if (!GTK_WIDGET_REALIZED (widget))
3607 /* Just return if the widget or one of its ancestors isn't mapped */
3608 for (w = widget; w != NULL; w = w->parent)
3609 if (!GTK_WIDGET_MAPPED (w))
3612 /* Find the correct widget */
3614 if (!GTK_WIDGET_NO_WINDOW (widget))
3618 /* Translate widget relative to window-relative */
3620 gint wx, wy, wwidth, wheight;
3622 gdk_window_get_position (widget->window, &wx, &wy);
3623 x -= wx - widget->allocation.x;
3624 y -= wy - widget->allocation.y;
3626 gdk_drawable_get_size (widget->window, &wwidth, &wheight);
3628 if (x + width <= 0 || y + height <= 0 ||
3629 x >= wwidth || y >= wheight)
3640 if (x + width > wwidth)
3642 if (y + height > wheight)
3643 height = wheight - y;
3649 invalid_rect.width = width;
3650 invalid_rect.height = height;
3652 gdk_window_invalidate_rect (widget->window, &invalid_rect, TRUE);
3656 widget_add_child_draw_rectangle (GtkWidget *widget,
3659 GdkRectangle child_rect;
3661 if (!GTK_WIDGET_MAPPED (widget) ||
3662 widget->window != widget->parent->window)
3665 gtk_widget_get_draw_rectangle (widget, &child_rect);
3666 gdk_rectangle_union (rect, &child_rect, rect);
3670 gtk_widget_get_draw_rectangle (GtkWidget *widget,
3673 if (GTK_WIDGET_NO_WINDOW (widget))
3675 GtkBorder *draw_border = NULL;
3677 *rect = widget->allocation;
3679 gtk_widget_style_get (widget,
3680 "draw-border", &draw_border,
3684 rect->x -= draw_border->left;
3685 rect->y -= draw_border->top;
3686 rect->width += draw_border->left + draw_border->right;
3687 rect->height += draw_border->top + draw_border->bottom;
3689 gtk_border_free (draw_border);
3692 if (GTK_IS_CONTAINER (widget))
3693 gtk_container_forall (GTK_CONTAINER (widget),
3694 (GtkCallback)widget_add_child_draw_rectangle,
3701 rect->width = widget->allocation.width;
3702 rect->height = widget->allocation.height;
3707 * gtk_widget_queue_draw:
3708 * @widget: a #GtkWidget
3710 * Equivalent to calling gtk_widget_queue_draw_area() for the
3711 * entire area of a widget.
3714 gtk_widget_queue_draw (GtkWidget *widget)
3718 g_return_if_fail (GTK_IS_WIDGET (widget));
3720 gtk_widget_get_draw_rectangle (widget, &rect);
3722 gtk_widget_queue_draw_area (widget,
3724 rect.width, rect.height);
3727 /* Invalidates the given area (allocation-relative-coordinates)
3728 * in all of the widget's windows
3731 * gtk_widget_queue_clear_area:
3732 * @widget: a #GtkWidget
3733 * @x: x coordinate of upper-left corner of rectangle to redraw
3734 * @y: y coordinate of upper-left corner of rectangle to redraw
3735 * @width: width of region to draw
3736 * @height: height of region to draw
3738 * This function is no longer different from
3739 * gtk_widget_queue_draw_area(), though it once was. Now it just calls
3740 * gtk_widget_queue_draw_area(). Originally
3741 * gtk_widget_queue_clear_area() would force a redraw of the
3742 * background for %GTK_NO_WINDOW widgets, and
3743 * gtk_widget_queue_draw_area() would not. Now both functions ensure
3744 * the background will be redrawn.
3746 * Deprecated: 2.2: Use gtk_widget_queue_draw_area() instead.
3749 gtk_widget_queue_clear_area (GtkWidget *widget,
3755 g_return_if_fail (GTK_IS_WIDGET (widget));
3757 gtk_widget_queue_draw_area (widget, x, y, width, height);
3761 * gtk_widget_queue_clear:
3762 * @widget: a #GtkWidget
3764 * This function does the same as gtk_widget_queue_draw().
3766 * Deprecated: 2.2: Use gtk_widget_queue_draw() instead.
3769 gtk_widget_queue_clear (GtkWidget *widget)
3771 g_return_if_fail (GTK_IS_WIDGET (widget));
3773 gtk_widget_queue_draw (widget);
3777 * gtk_widget_queue_resize:
3778 * @widget: a #GtkWidget
3780 * This function is only for use in widget implementations.
3781 * Flags a widget to have its size renegotiated; should
3782 * be called when a widget for some reason has a new size request.
3783 * For example, when you change the text in a #GtkLabel, #GtkLabel
3784 * queues a resize to ensure there's enough space for the new text.
3787 gtk_widget_queue_resize (GtkWidget *widget)
3789 g_return_if_fail (GTK_IS_WIDGET (widget));
3791 if (GTK_WIDGET_REALIZED (widget))
3792 gtk_widget_queue_shallow_draw (widget);
3794 _gtk_size_group_queue_resize (widget);
3798 * gtk_widget_queue_resize_no_redraw:
3799 * @widget: a #GtkWidget
3801 * This function works like gtk_widget_queue_resize(),
3802 * except that the widget is not invalidated.
3807 gtk_widget_queue_resize_no_redraw (GtkWidget *widget)
3809 g_return_if_fail (GTK_IS_WIDGET (widget));
3811 _gtk_size_group_queue_resize (widget);
3816 * @widget: a #GtkWidget
3817 * @area: area to draw
3819 * In GTK+ 1.2, this function would immediately render the
3820 * region @area of a widget, by invoking the virtual draw method of a
3821 * widget. In GTK+ 2.0, the draw method is gone, and instead
3822 * gtk_widget_draw() simply invalidates the specified region of the
3823 * widget, then updates the invalid region of the widget immediately.
3824 * Usually you don't want to update the region immediately for
3825 * performance reasons, so in general gtk_widget_queue_draw_area() is
3826 * a better choice if you want to draw a region of a widget.
3829 gtk_widget_draw (GtkWidget *widget,
3830 const GdkRectangle *area)
3832 g_return_if_fail (GTK_IS_WIDGET (widget));
3834 if (GTK_WIDGET_DRAWABLE (widget))
3837 gtk_widget_queue_draw_area (widget,
3839 area->width, area->height);
3841 gtk_widget_queue_draw (widget);
3843 gdk_window_process_updates (widget->window, TRUE);
3848 * gtk_widget_size_request:
3849 * @widget: a #GtkWidget
3850 * @requisition: a #GtkRequisition to be filled in
3852 * This function is typically used when implementing a #GtkContainer
3853 * subclass. Obtains the preferred size of a widget. The container
3854 * uses this information to arrange its child widgets and decide what
3855 * size allocations to give them with gtk_widget_size_allocate().
3857 * You can also call this function from an application, with some
3858 * caveats. Most notably, getting a size request requires the widget
3859 * to be associated with a screen, because font information may be
3860 * needed. Multihead-aware applications should keep this in mind.
3862 * Also remember that the size request is not necessarily the size
3863 * a widget will actually be allocated.
3865 * See also gtk_widget_get_child_requisition().
3868 gtk_widget_size_request (GtkWidget *widget,
3869 GtkRequisition *requisition)
3871 g_return_if_fail (GTK_IS_WIDGET (widget));
3873 #ifdef G_ENABLE_DEBUG
3874 if (requisition == &widget->requisition)
3875 g_warning ("gtk_widget_size_request() called on child widget with request equal\n to widget->requisition. gtk_widget_set_usize() may not work properly.");
3876 #endif /* G_ENABLE_DEBUG */
3878 _gtk_size_group_compute_requisition (widget, requisition);
3882 * gtk_widget_get_child_requisition:
3883 * @widget: a #GtkWidget
3884 * @requisition: a #GtkRequisition to be filled in
3886 * This function is only for use in widget implementations. Obtains
3887 * @widget->requisition, unless someone has forced a particular
3888 * geometry on the widget (e.g. with gtk_widget_set_size_request()),
3889 * in which case it returns that geometry instead of the widget's
3892 * This function differs from gtk_widget_size_request() in that
3893 * it retrieves the last size request value from @widget->requisition,
3894 * while gtk_widget_size_request() actually calls the "size_request" method
3895 * on @widget to compute the size request and fill in @widget->requisition,
3896 * and only then returns @widget->requisition.
3898 * Because this function does not call the "size_request" method, it
3899 * can only be used when you know that @widget->requisition is
3900 * up-to-date, that is, gtk_widget_size_request() has been called
3901 * since the last time a resize was queued. In general, only container
3902 * implementations have this information; applications should use
3903 * gtk_widget_size_request().
3906 gtk_widget_get_child_requisition (GtkWidget *widget,
3907 GtkRequisition *requisition)
3909 _gtk_size_group_get_child_requisition (widget, requisition);
3913 invalidate_predicate (GdkWindow *window,
3918 gdk_window_get_user_data (window, &user_data);
3920 return (user_data == data);
3923 /* Invalidate @region in widget->window and all children
3924 * of widget->window owned by widget. @region is in the
3925 * same coordinates as widget->allocation and will be
3926 * modified by this call.
3929 gtk_widget_invalidate_widget_windows (GtkWidget *widget,
3932 if (!GTK_WIDGET_REALIZED (widget))
3935 if (!GTK_WIDGET_NO_WINDOW (widget) && widget->parent)
3939 gdk_window_get_position (widget->window, &x, &y);
3940 gdk_region_offset (region, -x, -y);
3943 gdk_window_invalidate_maybe_recurse (widget->window, region,
3944 invalidate_predicate, widget);
3948 * gtk_widget_queue_shallow_draw:
3949 * @widget: a #GtkWidget
3951 * Like gtk_widget_queue_draw(), but only windows owned
3952 * by @widget are invalidated.
3955 gtk_widget_queue_shallow_draw (GtkWidget *widget)
3960 if (!GTK_WIDGET_REALIZED (widget))
3963 gtk_widget_get_draw_rectangle (widget, &rect);
3965 /* get_draw_rectangle() gives us window coordinates, we
3966 * need to convert to the coordinates that widget->allocation
3969 if (!GTK_WIDGET_NO_WINDOW (widget) && widget->parent)
3973 gdk_window_get_position (widget->window, &wx, &wy);
3979 region = gdk_region_rectangle (&rect);
3980 gtk_widget_invalidate_widget_windows (widget, region);
3981 gdk_region_destroy (region);
3985 * gtk_widget_size_allocate:
3986 * @widget: a #GtkWidget
3987 * @allocation: position and size to be allocated to @widget
3989 * This function is only used by #GtkContainer subclasses, to assign a size
3990 * and position to their child widgets.
3993 gtk_widget_size_allocate (GtkWidget *widget,
3994 GtkAllocation *allocation)
3996 GtkWidgetAuxInfo *aux_info;
3997 GdkRectangle real_allocation;
3998 GdkRectangle old_allocation;
3999 gboolean alloc_needed;
4000 gboolean size_changed;
4001 gboolean position_changed;
4003 g_return_if_fail (GTK_IS_WIDGET (widget));
4005 #ifdef G_ENABLE_DEBUG
4006 if (gtk_debug_flags & GTK_DEBUG_GEOMETRY)
4017 parent = gtk_widget_get_parent (parent);
4020 name = g_type_name (G_OBJECT_TYPE (G_OBJECT (widget)));
4021 g_print ("gtk_widget_size_allocate: %*s%s %d %d\n",
4022 2 * depth, " ", name,
4023 allocation->width, allocation->height);
4025 #endif /* G_ENABLE_DEBUG */
4027 alloc_needed = GTK_WIDGET_ALLOC_NEEDED (widget);
4028 if (!GTK_WIDGET_REQUEST_NEEDED (widget)) /* Preserve request/allocate ordering */
4029 GTK_PRIVATE_UNSET_FLAG (widget, GTK_ALLOC_NEEDED);
4031 old_allocation = widget->allocation;
4032 real_allocation = *allocation;
4033 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
4037 if (aux_info->x_set)
4038 real_allocation.x = aux_info->x;
4039 if (aux_info->y_set)
4040 real_allocation.y = aux_info->y;
4043 if (real_allocation.width < 0 || real_allocation.height < 0)
4045 g_warning ("gtk_widget_size_allocate(): attempt to allocate widget with width %d and height %d",
4046 real_allocation.width,
4047 real_allocation.height);
4050 real_allocation.width = MAX (real_allocation.width, 1);
4051 real_allocation.height = MAX (real_allocation.height, 1);
4053 size_changed = (old_allocation.width != real_allocation.width ||
4054 old_allocation.height != real_allocation.height);
4055 position_changed = (old_allocation.x != real_allocation.x ||
4056 old_allocation.y != real_allocation.y);
4058 if (!alloc_needed && !size_changed && !position_changed)
4061 g_signal_emit (widget, widget_signals[SIZE_ALLOCATE], 0, &real_allocation);
4063 if (GTK_WIDGET_MAPPED (widget))
4065 if (GTK_WIDGET_NO_WINDOW (widget) && GTK_WIDGET_REDRAW_ON_ALLOC (widget) && position_changed)
4067 /* Invalidate union(old_allaction,widget->allocation) in widget->window
4069 GdkRegion *invalidate = gdk_region_rectangle (&widget->allocation);
4070 gdk_region_union_with_rect (invalidate, &old_allocation);
4072 gdk_window_invalidate_region (widget->window, invalidate, FALSE);
4073 gdk_region_destroy (invalidate);
4078 if (GTK_WIDGET_REDRAW_ON_ALLOC (widget))
4080 /* Invalidate union(old_allaction,widget->allocation) in widget->window and descendents owned by widget
4082 GdkRegion *invalidate = gdk_region_rectangle (&widget->allocation);
4083 gdk_region_union_with_rect (invalidate, &old_allocation);
4085 gtk_widget_invalidate_widget_windows (widget, invalidate);
4086 gdk_region_destroy (invalidate);
4091 if ((size_changed || position_changed) && widget->parent &&
4092 GTK_WIDGET_REALIZED (widget->parent) && GTK_CONTAINER (widget->parent)->reallocate_redraws)
4094 GdkRegion *invalidate = gdk_region_rectangle (&widget->parent->allocation);
4095 gtk_widget_invalidate_widget_windows (widget->parent, invalidate);
4096 gdk_region_destroy (invalidate);
4101 * gtk_widget_common_ancestor:
4102 * @widget_a: a #GtkWidget
4103 * @widget_b: a #GtkWidget
4105 * Find the common ancestor of @widget_a and @widget_b that
4106 * is closest to the two widgets.
4108 * Return value: the closest common ancestor of @widget_a and
4109 * @widget_b or %NULL if @widget_a and @widget_b do not
4110 * share a common ancestor.
4113 gtk_widget_common_ancestor (GtkWidget *widget_a,
4114 GtkWidget *widget_b)
4116 GtkWidget *parent_a;
4117 GtkWidget *parent_b;
4121 parent_a = widget_a;
4122 while (parent_a->parent)
4124 parent_a = parent_a->parent;
4128 parent_b = widget_b;
4129 while (parent_b->parent)
4131 parent_b = parent_b->parent;
4135 if (parent_a != parent_b)
4138 while (depth_a > depth_b)
4140 widget_a = widget_a->parent;
4144 while (depth_b > depth_a)
4146 widget_b = widget_b->parent;
4150 while (widget_a != widget_b)
4152 widget_a = widget_a->parent;
4153 widget_b = widget_b->parent;
4160 * gtk_widget_translate_coordinates:
4161 * @src_widget: a #GtkWidget
4162 * @dest_widget: a #GtkWidget
4163 * @src_x: X position relative to @src_widget
4164 * @src_y: Y position relative to @src_widget
4165 * @dest_x: (out): location to store X position relative to @dest_widget
4166 * @dest_y: (out): location to store Y position relative to @dest_widget
4168 * Translate coordinates relative to @src_widget's allocation to coordinates
4169 * relative to @dest_widget's allocations. In order to perform this
4170 * operation, both widgets must be realized, and must share a common
4173 * Return value: %FALSE if either widget was not realized, or there
4174 * was no common ancestor. In this case, nothing is stored in
4175 * *@dest_x and *@dest_y. Otherwise %TRUE.
4178 gtk_widget_translate_coordinates (GtkWidget *src_widget,
4179 GtkWidget *dest_widget,
4185 GtkWidget *ancestor;
4188 g_return_val_if_fail (GTK_IS_WIDGET (src_widget), FALSE);
4189 g_return_val_if_fail (GTK_IS_WIDGET (dest_widget), FALSE);
4191 ancestor = gtk_widget_common_ancestor (src_widget, dest_widget);
4192 if (!ancestor || !GTK_WIDGET_REALIZED (src_widget) || !GTK_WIDGET_REALIZED (dest_widget))
4195 /* Translate from allocation relative to window relative */
4196 if (!GTK_WIDGET_NO_WINDOW (src_widget) && src_widget->parent)
4199 gdk_window_get_position (src_widget->window, &wx, &wy);
4201 src_x -= wx - src_widget->allocation.x;
4202 src_y -= wy - src_widget->allocation.y;
4206 src_x += src_widget->allocation.x;
4207 src_y += src_widget->allocation.y;
4210 /* Translate to the common ancestor */
4211 window = src_widget->window;
4212 while (window != ancestor->window)
4216 gdk_window_get_position (window, &dx, &dy);
4221 window = gdk_window_get_parent (window);
4223 if (!window) /* Handle GtkHandleBox */
4228 window = dest_widget->window;
4229 while (window != ancestor->window)
4233 gdk_window_get_position (window, &dx, &dy);
4238 window = gdk_window_get_parent (window);
4240 if (!window) /* Handle GtkHandleBox */
4244 /* Translate from window relative to allocation relative */
4245 if (!GTK_WIDGET_NO_WINDOW (dest_widget) && dest_widget->parent)
4248 gdk_window_get_position (dest_widget->window, &wx, &wy);
4250 src_x += wx - dest_widget->allocation.x;
4251 src_y += wy - dest_widget->allocation.y;
4255 src_x -= dest_widget->allocation.x;
4256 src_y -= dest_widget->allocation.y;
4268 gtk_widget_real_size_allocate (GtkWidget *widget,
4269 GtkAllocation *allocation)
4271 widget->allocation = *allocation;
4273 if (GTK_WIDGET_REALIZED (widget) &&
4274 !GTK_WIDGET_NO_WINDOW (widget))
4276 gdk_window_move_resize (widget->window,
4277 allocation->x, allocation->y,
4278 allocation->width, allocation->height);
4283 gtk_widget_real_can_activate_accel (GtkWidget *widget,
4286 /* widgets must be onscreen for accels to take effect */
4287 return GTK_WIDGET_IS_SENSITIVE (widget) && GTK_WIDGET_DRAWABLE (widget) && gdk_window_is_viewable (widget->window);
4291 * gtk_widget_can_activate_accel:
4292 * @widget: a #GtkWidget
4293 * @signal_id: the ID of a signal installed on @widget
4295 * Determines whether an accelerator that activates the signal
4296 * identified by @signal_id can currently be activated.
4297 * This is done by emitting the #GtkWidget::can-activate-accel
4298 * signal on @widget; if the signal isn't overridden by a
4299 * handler or in a derived widget, then the default check is
4300 * that the widget must be sensitive, and the widget and all
4301 * its ancestors mapped.
4303 * Return value: %TRUE if the accelerator can be activated.
4308 gtk_widget_can_activate_accel (GtkWidget *widget,
4311 gboolean can_activate = FALSE;
4312 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4313 g_signal_emit (widget, widget_signals[CAN_ACTIVATE_ACCEL], 0, signal_id, &can_activate);
4314 return can_activate;
4323 closure_accel_activate (GClosure *closure,
4324 GValue *return_value,
4325 guint n_param_values,
4326 const GValue *param_values,
4327 gpointer invocation_hint,
4328 gpointer marshal_data)
4330 AccelClosure *aclosure = (AccelClosure*) closure;
4331 gboolean can_activate = gtk_widget_can_activate_accel (closure->data, aclosure->signal_id);
4334 g_signal_emit (closure->data, aclosure->signal_id, 0);
4336 /* whether accelerator was handled */
4337 g_value_set_boolean (return_value, can_activate);
4341 closures_destroy (gpointer data)
4343 GSList *slist, *closures = data;
4345 for (slist = closures; slist; slist = slist->next)
4347 g_closure_invalidate (slist->data);
4348 g_closure_unref (slist->data);
4350 g_slist_free (closures);
4354 widget_new_accel_closure (GtkWidget *widget,
4357 AccelClosure *aclosure;
4358 GClosure *closure = NULL;
4359 GSList *slist, *closures;
4361 closures = g_object_steal_qdata (G_OBJECT (widget), quark_accel_closures);
4362 for (slist = closures; slist; slist = slist->next)
4363 if (!gtk_accel_group_from_accel_closure (slist->data))
4365 /* reuse this closure */
4366 closure = slist->data;
4371 closure = g_closure_new_object (sizeof (AccelClosure), G_OBJECT (widget));
4372 closures = g_slist_prepend (closures, g_closure_ref (closure));
4373 g_closure_sink (closure);
4374 g_closure_set_marshal (closure, closure_accel_activate);
4376 g_object_set_qdata_full (G_OBJECT (widget), quark_accel_closures, closures, closures_destroy);
4378 aclosure = (AccelClosure*) closure;
4379 g_assert (closure->data == widget);
4380 g_assert (closure->marshal == closure_accel_activate);
4381 aclosure->signal_id = signal_id;
4387 * gtk_widget_add_accelerator
4388 * @widget: widget to install an accelerator on
4389 * @accel_signal: widget signal to emit on accelerator activation
4390 * @accel_group: accel group for this widget, added to its toplevel
4391 * @accel_key: GDK keyval of the accelerator
4392 * @accel_mods: modifier key combination of the accelerator
4393 * @accel_flags: flag accelerators, e.g. %GTK_ACCEL_VISIBLE
4395 * Installs an accelerator for this @widget in @accel_group that causes
4396 * @accel_signal to be emitted if the accelerator is activated.
4397 * The @accel_group needs to be added to the widget's toplevel via
4398 * gtk_window_add_accel_group(), and the signal must be of type %G_RUN_ACTION.
4399 * Accelerators added through this function are not user changeable during
4400 * runtime. If you want to support accelerators that can be changed by the
4401 * user, use gtk_accel_map_add_entry() and gtk_widget_set_accel_path() or
4402 * gtk_menu_item_set_accel_path() instead.
4405 gtk_widget_add_accelerator (GtkWidget *widget,
4406 const gchar *accel_signal,
4407 GtkAccelGroup *accel_group,
4409 GdkModifierType accel_mods,
4410 GtkAccelFlags accel_flags)
4415 g_return_if_fail (GTK_IS_WIDGET (widget));
4416 g_return_if_fail (accel_signal != NULL);
4417 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
4419 g_signal_query (g_signal_lookup (accel_signal, G_OBJECT_TYPE (widget)), &query);
4420 if (!query.signal_id ||
4421 !(query.signal_flags & G_SIGNAL_ACTION) ||
4422 query.return_type != G_TYPE_NONE ||
4425 /* hmm, should be elaborate enough */
4426 g_warning (G_STRLOC ": widget `%s' has no activatable signal \"%s\" without arguments",
4427 G_OBJECT_TYPE_NAME (widget), accel_signal);
4431 closure = widget_new_accel_closure (widget, query.signal_id);
4433 g_object_ref (widget);
4435 /* install the accelerator. since we don't map this onto an accel_path,
4436 * the accelerator will automatically be locked.
4438 gtk_accel_group_connect (accel_group,
4441 accel_flags | GTK_ACCEL_LOCKED,
4444 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
4446 g_object_unref (widget);
4450 * gtk_widget_remove_accelerator:
4451 * @widget: widget to install an accelerator on
4452 * @accel_group: accel group for this widget
4453 * @accel_key: GDK keyval of the accelerator
4454 * @accel_mods: modifier key combination of the accelerator
4455 * @returns: whether an accelerator was installed and could be removed
4457 * Removes an accelerator from @widget, previously installed with
4458 * gtk_widget_add_accelerator().
4461 gtk_widget_remove_accelerator (GtkWidget *widget,
4462 GtkAccelGroup *accel_group,
4464 GdkModifierType accel_mods)
4466 GtkAccelGroupEntry *ag_entry;
4467 GList *slist, *clist;
4470 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4471 g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE);
4473 ag_entry = gtk_accel_group_query (accel_group, accel_key, accel_mods, &n);
4474 clist = gtk_widget_list_accel_closures (widget);
4475 for (slist = clist; slist; slist = slist->next)
4479 for (i = 0; i < n; i++)
4480 if (slist->data == (gpointer) ag_entry[i].closure)
4482 gboolean is_removed = gtk_accel_group_disconnect (accel_group, slist->data);
4484 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
4486 g_list_free (clist);
4491 g_list_free (clist);
4493 g_warning (G_STRLOC ": no accelerator (%u,%u) installed in accel group (%p) for %s (%p)",
4494 accel_key, accel_mods, accel_group,
4495 G_OBJECT_TYPE_NAME (widget), widget);
4501 * gtk_widget_list_accel_closures
4502 * @widget: widget to list accelerator closures for
4503 * @returns: a newly allocated #GList of closures
4505 * Lists the closures used by @widget for accelerator group connections
4506 * with gtk_accel_group_connect_by_path() or gtk_accel_group_connect().
4507 * The closures can be used to monitor accelerator changes on @widget,
4508 * by connecting to the @GtkAccelGroup::accel-changed signal of the
4509 * #GtkAccelGroup of a closure which can be found out with
4510 * gtk_accel_group_from_accel_closure().
4513 gtk_widget_list_accel_closures (GtkWidget *widget)
4516 GList *clist = NULL;
4518 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4520 for (slist = g_object_get_qdata (G_OBJECT (widget), quark_accel_closures); slist; slist = slist->next)
4521 if (gtk_accel_group_from_accel_closure (slist->data))
4522 clist = g_list_prepend (clist, slist->data);
4528 GtkAccelGroup *accel_group;
4533 destroy_accel_path (gpointer data)
4535 AccelPath *apath = data;
4537 gtk_accel_group_disconnect (apath->accel_group, apath->closure);
4539 /* closures_destroy takes care of unrefing the closure */
4540 g_object_unref (apath->accel_group);
4542 g_slice_free (AccelPath, apath);
4547 * gtk_widget_set_accel_path:
4548 * @widget: a #GtkWidget
4549 * @accel_path: (allow-none): path used to look up the accelerator
4550 * @accel_group: (allow-none): a #GtkAccelGroup.
4552 * Given an accelerator group, @accel_group, and an accelerator path,
4553 * @accel_path, sets up an accelerator in @accel_group so whenever the
4554 * key binding that is defined for @accel_path is pressed, @widget
4555 * will be activated. This removes any accelerators (for any
4556 * accelerator group) installed by previous calls to
4557 * gtk_widget_set_accel_path(). Associating accelerators with
4558 * paths allows them to be modified by the user and the modifications
4559 * to be saved for future use. (See gtk_accel_map_save().)
4561 * This function is a low level function that would most likely
4562 * be used by a menu creation system like #GtkUIManager. If you
4563 * use #GtkUIManager, setting up accelerator paths will be done
4566 * Even when you you aren't using #GtkUIManager, if you only want to
4567 * set up accelerators on menu items gtk_menu_item_set_accel_path()
4568 * provides a somewhat more convenient interface.
4570 * Note that @accel_path string will be stored in a #GQuark. Therefore, if you
4571 * pass a static string, you can save some memory by interning it first with
4572 * g_intern_static_string().
4575 gtk_widget_set_accel_path (GtkWidget *widget,
4576 const gchar *accel_path,
4577 GtkAccelGroup *accel_group)
4581 g_return_if_fail (GTK_IS_WIDGET (widget));
4582 g_return_if_fail (GTK_WIDGET_GET_CLASS (widget)->activate_signal != 0);
4586 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
4587 g_return_if_fail (_gtk_accel_path_is_valid (accel_path));
4589 gtk_accel_map_add_entry (accel_path, 0, 0);
4590 apath = g_slice_new (AccelPath);
4591 apath->accel_group = g_object_ref (accel_group);
4592 apath->path_quark = g_quark_from_string (accel_path);
4593 apath->closure = widget_new_accel_closure (widget, GTK_WIDGET_GET_CLASS (widget)->activate_signal);
4598 /* also removes possible old settings */
4599 g_object_set_qdata_full (G_OBJECT (widget), quark_accel_path, apath, destroy_accel_path);
4602 gtk_accel_group_connect_by_path (apath->accel_group, g_quark_to_string (apath->path_quark), apath->closure);
4604 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
4608 _gtk_widget_get_accel_path (GtkWidget *widget,
4613 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4615 apath = g_object_get_qdata (G_OBJECT (widget), quark_accel_path);
4617 *locked = apath ? apath->accel_group->lock_count > 0 : TRUE;
4618 return apath ? g_quark_to_string (apath->path_quark) : NULL;
4622 * gtk_widget_mnemonic_activate:
4623 * @widget: a #GtkWidget
4624 * @group_cycling: %TRUE if there are other widgets with the same mnemonic
4626 * Emits the #GtkWidget::mnemonic-activate signal.
4628 * The default handler for this signal activates the @widget if
4629 * @group_cycling is %FALSE, and just grabs the focus if @group_cycling
4632 * Returns: %TRUE if the signal has been handled
4635 gtk_widget_mnemonic_activate (GtkWidget *widget,
4636 gboolean group_cycling)
4640 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4642 group_cycling = group_cycling != FALSE;
4643 if (!GTK_WIDGET_IS_SENSITIVE (widget))
4646 g_signal_emit (widget,
4647 widget_signals[MNEMONIC_ACTIVATE],
4655 gtk_widget_real_mnemonic_activate (GtkWidget *widget,
4656 gboolean group_cycling)
4658 if (!group_cycling && GTK_WIDGET_GET_CLASS (widget)->activate_signal)
4659 gtk_widget_activate (widget);
4660 else if (gtk_widget_get_can_focus (widget))
4661 gtk_widget_grab_focus (widget);
4664 g_warning ("widget `%s' isn't suitable for mnemonic activation",
4665 G_OBJECT_TYPE_NAME (widget));
4666 gtk_widget_error_bell (widget);
4672 gtk_widget_real_key_press_event (GtkWidget *widget,
4675 return gtk_bindings_activate_event (GTK_OBJECT (widget), event);
4679 gtk_widget_real_key_release_event (GtkWidget *widget,
4682 return gtk_bindings_activate_event (GTK_OBJECT (widget), event);
4686 gtk_widget_real_focus_in_event (GtkWidget *widget,
4687 GdkEventFocus *event)
4689 gtk_widget_queue_shallow_draw (widget);
4695 gtk_widget_real_focus_out_event (GtkWidget *widget,
4696 GdkEventFocus *event)
4698 gtk_widget_queue_shallow_draw (widget);
4703 #define WIDGET_REALIZED_FOR_EVENT(widget, event) \
4704 (event->type == GDK_FOCUS_CHANGE || GTK_WIDGET_REALIZED(widget))
4708 * @widget: a #GtkWidget
4709 * @event: a #GdkEvent
4711 * Rarely-used function. This function is used to emit
4712 * the event signals on a widget (those signals should never
4713 * be emitted without using this function to do so).
4714 * If you want to synthesize an event though, don't use this function;
4715 * instead, use gtk_main_do_event() so the event will behave as if
4716 * it were in the event queue. Don't synthesize expose events; instead,
4717 * use gdk_window_invalidate_rect() to invalidate a region of the
4720 * Return value: return from the event signal emission (%TRUE if
4721 * the event was handled)
4724 gtk_widget_event (GtkWidget *widget,
4727 g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
4728 g_return_val_if_fail (WIDGET_REALIZED_FOR_EVENT (widget, event), TRUE);
4730 if (event->type == GDK_EXPOSE)
4732 g_warning ("Events of type GDK_EXPOSE cannot be synthesized. To get "
4733 "the same effect, call gdk_window_invalidate_rect/region(), "
4734 "followed by gdk_window_process_updates().");
4738 return gtk_widget_event_internal (widget, event);
4743 * gtk_widget_send_expose:
4744 * @widget: a #GtkWidget
4745 * @event: a expose #GdkEvent
4747 * Very rarely-used function. This function is used to emit
4748 * an expose event signals on a widget. This function is not
4749 * normally used directly. The only time it is used is when
4750 * propagating an expose event to a child %NO_WINDOW widget, and
4751 * that is normally done using gtk_container_propagate_expose().
4753 * If you want to force an area of a window to be redrawn,
4754 * use gdk_window_invalidate_rect() or gdk_window_invalidate_region().
4755 * To cause the redraw to be done immediately, follow that call
4756 * with a call to gdk_window_process_updates().
4758 * Return value: return from the event signal emission (%TRUE if
4759 * the event was handled)
4762 gtk_widget_send_expose (GtkWidget *widget,
4765 g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
4766 g_return_val_if_fail (GTK_WIDGET_REALIZED (widget), TRUE);
4767 g_return_val_if_fail (event != NULL, TRUE);
4768 g_return_val_if_fail (event->type == GDK_EXPOSE, TRUE);
4770 return gtk_widget_event_internal (widget, event);
4774 event_window_is_still_viewable (GdkEvent *event)
4776 /* Some programs, such as gnome-theme-manager, fake widgets
4777 * into exposing onto a pixmap by sending expose events with
4778 * event->window pointing to a pixmap
4780 if (GDK_IS_PIXMAP (event->any.window))
4781 return event->type == GDK_EXPOSE;
4783 /* Check that we think the event's window is viewable before
4784 * delivering the event, to prevent suprises. We do this here
4785 * at the last moment, since the event may have been queued
4786 * up behind other events, held over a recursive main loop, etc.
4788 switch (event->type)
4791 case GDK_MOTION_NOTIFY:
4792 case GDK_BUTTON_PRESS:
4793 case GDK_2BUTTON_PRESS:
4794 case GDK_3BUTTON_PRESS:
4796 case GDK_ENTER_NOTIFY:
4797 case GDK_PROXIMITY_IN:
4799 return event->any.window && gdk_window_is_viewable (event->any.window);
4802 /* The following events are the second half of paired events;
4803 * we always deliver them to deal with widgets that clean up
4804 * on the second half.
4806 case GDK_BUTTON_RELEASE:
4807 case GDK_KEY_RELEASE:
4808 case GDK_LEAVE_NOTIFY:
4809 case GDK_PROXIMITY_OUT:
4813 /* Remaining events would make sense on an not-viewable window,
4814 * or don't have an associated window.
4821 gtk_widget_event_internal (GtkWidget *widget,
4824 gboolean return_val = FALSE;
4826 /* We check only once for is-still-visible; if someone
4827 * hides the window in on of the signals on the widget,
4828 * they are responsible for returning TRUE to terminate
4831 if (!event_window_is_still_viewable (event))
4834 g_object_ref (widget);
4836 g_signal_emit (widget, widget_signals[EVENT], 0, event, &return_val);
4837 return_val |= !WIDGET_REALIZED_FOR_EVENT (widget, event);
4842 switch (event->type)
4847 case GDK_BUTTON_PRESS:
4848 case GDK_2BUTTON_PRESS:
4849 case GDK_3BUTTON_PRESS:
4850 signal_num = BUTTON_PRESS_EVENT;
4853 signal_num = SCROLL_EVENT;
4855 case GDK_BUTTON_RELEASE:
4856 signal_num = BUTTON_RELEASE_EVENT;
4858 case GDK_MOTION_NOTIFY:
4859 signal_num = MOTION_NOTIFY_EVENT;
4862 signal_num = DELETE_EVENT;
4865 signal_num = DESTROY_EVENT;
4866 _gtk_tooltip_hide (widget);
4869 signal_num = KEY_PRESS_EVENT;
4871 case GDK_KEY_RELEASE:
4872 signal_num = KEY_RELEASE_EVENT;
4874 case GDK_ENTER_NOTIFY:
4875 signal_num = ENTER_NOTIFY_EVENT;
4877 case GDK_LEAVE_NOTIFY:
4878 signal_num = LEAVE_NOTIFY_EVENT;
4880 case GDK_FOCUS_CHANGE:
4881 signal_num = event->focus_change.in ? FOCUS_IN_EVENT : FOCUS_OUT_EVENT;
4882 if (event->focus_change.in)
4883 _gtk_tooltip_focus_in (widget);
4885 _gtk_tooltip_focus_out (widget);
4888 signal_num = CONFIGURE_EVENT;
4891 signal_num = MAP_EVENT;
4894 signal_num = UNMAP_EVENT;
4896 case GDK_WINDOW_STATE:
4897 signal_num = WINDOW_STATE_EVENT;
4899 case GDK_PROPERTY_NOTIFY:
4900 signal_num = PROPERTY_NOTIFY_EVENT;
4902 case GDK_SELECTION_CLEAR:
4903 signal_num = SELECTION_CLEAR_EVENT;
4905 case GDK_SELECTION_REQUEST:
4906 signal_num = SELECTION_REQUEST_EVENT;
4908 case GDK_SELECTION_NOTIFY:
4909 signal_num = SELECTION_NOTIFY_EVENT;
4911 case GDK_PROXIMITY_IN:
4912 signal_num = PROXIMITY_IN_EVENT;
4914 case GDK_PROXIMITY_OUT:
4915 signal_num = PROXIMITY_OUT_EVENT;
4918 signal_num = NO_EXPOSE_EVENT;
4920 case GDK_CLIENT_EVENT:
4921 signal_num = CLIENT_EVENT;
4924 signal_num = EXPOSE_EVENT;
4926 case GDK_VISIBILITY_NOTIFY:
4927 signal_num = VISIBILITY_NOTIFY_EVENT;
4929 case GDK_GRAB_BROKEN:
4930 signal_num = GRAB_BROKEN;
4933 signal_num = DAMAGE_EVENT;
4936 g_warning ("gtk_widget_event(): unhandled event type: %d", event->type);
4940 if (signal_num != -1)
4941 g_signal_emit (widget, widget_signals[signal_num], 0, event, &return_val);
4943 if (WIDGET_REALIZED_FOR_EVENT (widget, event))
4944 g_signal_emit (widget, widget_signals[EVENT_AFTER], 0, event);
4948 g_object_unref (widget);
4954 * gtk_widget_activate:
4955 * @widget: a #GtkWidget that's activatable
4957 * For widgets that can be "activated" (buttons, menu items, etc.)
4958 * this function activates them. Activation is what happens when you
4959 * press Enter on a widget during key navigation. If @widget isn't
4960 * activatable, the function returns %FALSE.
4962 * Return value: %TRUE if the widget was activatable
4965 gtk_widget_activate (GtkWidget *widget)
4967 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4969 if (WIDGET_CLASS (widget)->activate_signal)
4971 /* FIXME: we should eventually check the signals signature here */
4972 g_signal_emit (widget, WIDGET_CLASS (widget)->activate_signal, 0);
4981 * gtk_widget_set_scroll_adjustments:
4982 * @widget: a #GtkWidget
4983 * @hadjustment: (allow-none): an adjustment for horizontal scrolling, or %NULL
4984 * @vadjustment: (allow-none): an adjustment for vertical scrolling, or %NULL
4986 * For widgets that support scrolling, sets the scroll adjustments and
4987 * returns %TRUE. For widgets that don't support scrolling, does
4988 * nothing and returns %FALSE. Widgets that don't support scrolling
4989 * can be scrolled by placing them in a #GtkViewport, which does
4990 * support scrolling.
4992 * Return value: %TRUE if the widget supports scrolling
4995 gtk_widget_set_scroll_adjustments (GtkWidget *widget,
4996 GtkAdjustment *hadjustment,
4997 GtkAdjustment *vadjustment)
5002 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5005 g_return_val_if_fail (GTK_IS_ADJUSTMENT (hadjustment), FALSE);
5007 g_return_val_if_fail (GTK_IS_ADJUSTMENT (vadjustment), FALSE);
5009 signal_id = WIDGET_CLASS (widget)->set_scroll_adjustments_signal;
5013 g_signal_query (signal_id, &query);
5014 if (!query.signal_id ||
5015 !g_type_is_a (query.itype, GTK_TYPE_WIDGET) ||
5016 query.return_type != G_TYPE_NONE ||
5017 query.n_params != 2 ||
5018 query.param_types[0] != GTK_TYPE_ADJUSTMENT ||
5019 query.param_types[1] != GTK_TYPE_ADJUSTMENT)
5021 g_warning (G_STRLOC ": signal \"%s::%s\" has wrong signature",
5022 G_OBJECT_TYPE_NAME (widget), query.signal_name);
5026 g_signal_emit (widget, signal_id, 0, hadjustment, vadjustment);
5031 gtk_widget_reparent_subwindows (GtkWidget *widget,
5032 GdkWindow *new_window)
5034 if (GTK_WIDGET_NO_WINDOW (widget))
5036 GList *children = gdk_window_get_children (widget->window);
5039 for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
5041 GdkWindow *window = tmp_list->data;
5044 gdk_window_get_user_data (window, &child);
5045 while (child && child != widget)
5046 child = ((GtkWidget*) child)->parent;
5049 gdk_window_reparent (window, new_window, 0, 0);
5052 g_list_free (children);
5057 GList *tmp_list, *children;
5059 parent = gdk_window_get_parent (widget->window);
5062 gdk_window_reparent (widget->window, new_window, 0, 0);
5065 children = gdk_window_get_children (parent);
5067 for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
5069 GdkWindow *window = tmp_list->data;
5072 gdk_window_get_user_data (window, &child);
5074 if (child == widget)
5075 gdk_window_reparent (window, new_window, 0, 0);
5078 g_list_free (children);
5084 gtk_widget_reparent_fixup_child (GtkWidget *widget,
5085 gpointer client_data)
5087 g_assert (client_data != NULL);
5089 if (GTK_WIDGET_NO_WINDOW (widget))
5092 g_object_unref (widget->window);
5093 widget->window = (GdkWindow*) client_data;
5095 g_object_ref (widget->window);
5097 if (GTK_IS_CONTAINER (widget))
5098 gtk_container_forall (GTK_CONTAINER (widget),
5099 gtk_widget_reparent_fixup_child,
5105 * gtk_widget_reparent:
5106 * @widget: a #GtkWidget
5107 * @new_parent: a #GtkContainer to move the widget into
5109 * Moves a widget from one #GtkContainer to another, handling reference
5110 * count issues to avoid destroying the widget.
5113 gtk_widget_reparent (GtkWidget *widget,
5114 GtkWidget *new_parent)
5116 g_return_if_fail (GTK_IS_WIDGET (widget));
5117 g_return_if_fail (GTK_IS_CONTAINER (new_parent));
5118 g_return_if_fail (widget->parent != NULL);
5120 if (widget->parent != new_parent)
5122 /* First try to see if we can get away without unrealizing
5123 * the widget as we reparent it. if so we set a flag so
5124 * that gtk_widget_unparent doesn't unrealize widget
5126 if (GTK_WIDGET_REALIZED (widget) && GTK_WIDGET_REALIZED (new_parent))
5127 GTK_PRIVATE_SET_FLAG (widget, GTK_IN_REPARENT);
5129 g_object_ref (widget);
5130 gtk_container_remove (GTK_CONTAINER (widget->parent), widget);
5131 gtk_container_add (GTK_CONTAINER (new_parent), widget);
5132 g_object_unref (widget);
5134 if (GTK_WIDGET_IN_REPARENT (widget))
5136 GTK_PRIVATE_UNSET_FLAG (widget, GTK_IN_REPARENT);
5138 gtk_widget_reparent_subwindows (widget, gtk_widget_get_parent_window (widget));
5139 gtk_widget_reparent_fixup_child (widget,
5140 gtk_widget_get_parent_window (widget));
5143 g_object_notify (G_OBJECT (widget), "parent");
5148 * gtk_widget_intersect:
5149 * @widget: a #GtkWidget
5150 * @area: a rectangle
5151 * @intersection: rectangle to store intersection of @widget and @area
5153 * Computes the intersection of a @widget's area and @area, storing
5154 * the intersection in @intersection, and returns %TRUE if there was
5155 * an intersection. @intersection may be %NULL if you're only
5156 * interested in whether there was an intersection.
5158 * Return value: %TRUE if there was an intersection
5161 gtk_widget_intersect (GtkWidget *widget,
5162 const GdkRectangle *area,
5163 GdkRectangle *intersection)
5169 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5170 g_return_val_if_fail (area != NULL, FALSE);
5173 dest = intersection;
5177 return_val = gdk_rectangle_intersect (&widget->allocation, area, dest);
5179 if (return_val && intersection && !GTK_WIDGET_NO_WINDOW (widget))
5181 intersection->x -= widget->allocation.x;
5182 intersection->y -= widget->allocation.y;
5189 * gtk_widget_region_intersect:
5190 * @widget: a #GtkWidget
5191 * @region: a #GdkRegion, in the same coordinate system as
5192 * @widget->allocation. That is, relative to @widget->window
5193 * for %NO_WINDOW widgets; relative to the parent window
5194 * of @widget->window for widgets with their own window.
5195 * @returns: A newly allocated region holding the intersection of @widget
5196 * and @region. The coordinates of the return value are
5197 * relative to @widget->window for %NO_WINDOW widgets, and
5198 * relative to the parent window of @widget->window for
5199 * widgets with their own window.
5201 * Computes the intersection of a @widget's area and @region, returning
5202 * the intersection. The result may be empty, use gdk_region_empty() to
5206 gtk_widget_region_intersect (GtkWidget *widget,
5207 const GdkRegion *region)
5212 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5213 g_return_val_if_fail (region != NULL, NULL);
5215 gtk_widget_get_draw_rectangle (widget, &rect);
5217 dest = gdk_region_rectangle (&rect);
5219 gdk_region_intersect (dest, region);
5225 * _gtk_widget_grab_notify:
5226 * @widget: a #GtkWidget
5227 * @was_grabbed: whether a grab is now in effect
5229 * Emits the #GtkWidget::grab-notify signal on @widget.
5234 _gtk_widget_grab_notify (GtkWidget *widget,
5235 gboolean was_grabbed)
5237 g_signal_emit (widget, widget_signals[GRAB_NOTIFY], 0, was_grabbed);
5241 * gtk_widget_grab_focus:
5242 * @widget: a #GtkWidget
5244 * Causes @widget to have the keyboard focus for the #GtkWindow it's
5245 * inside. @widget must be a focusable widget, such as a #GtkEntry;
5246 * something like #GtkFrame won't work.
5248 * More precisely, it must have the %GTK_CAN_FOCUS flag set. Use
5249 * gtk_widget_set_can_focus() to modify that flag.
5252 gtk_widget_grab_focus (GtkWidget *widget)
5254 g_return_if_fail (GTK_IS_WIDGET (widget));
5256 if (!GTK_WIDGET_IS_SENSITIVE (widget))
5259 g_object_ref (widget);
5260 g_signal_emit (widget, widget_signals[GRAB_FOCUS], 0);
5261 g_object_notify (G_OBJECT (widget), "has-focus");
5262 g_object_unref (widget);
5266 reset_focus_recurse (GtkWidget *widget,
5269 if (GTK_IS_CONTAINER (widget))
5271 GtkContainer *container;
5273 container = GTK_CONTAINER (widget);
5274 gtk_container_set_focus_child (container, NULL);
5276 gtk_container_foreach (container,
5277 reset_focus_recurse,
5283 gtk_widget_real_grab_focus (GtkWidget *focus_widget)
5285 if (gtk_widget_get_can_focus (focus_widget))
5287 GtkWidget *toplevel;
5290 /* clear the current focus setting, break if the current widget
5291 * is the focus widget's parent, since containers above that will
5292 * be set by the next loop.
5294 toplevel = gtk_widget_get_toplevel (focus_widget);
5295 if (gtk_widget_is_toplevel (toplevel) && GTK_IS_WINDOW (toplevel))
5297 widget = GTK_WINDOW (toplevel)->focus_widget;
5299 if (widget == focus_widget)
5301 /* We call _gtk_window_internal_set_focus() here so that the
5302 * toplevel window can request the focus if necessary.
5303 * This is needed when the toplevel is a GtkPlug
5305 if (!GTK_WIDGET_HAS_FOCUS (widget))
5306 _gtk_window_internal_set_focus (GTK_WINDOW (toplevel), focus_widget);
5313 while (widget->parent && widget->parent != focus_widget->parent)
5315 widget = widget->parent;
5316 gtk_container_set_focus_child (GTK_CONTAINER (widget), NULL);
5320 else if (toplevel != focus_widget)
5322 /* gtk_widget_grab_focus() operates on a tree without window...
5323 * actually, this is very questionable behaviour.
5326 gtk_container_foreach (GTK_CONTAINER (toplevel),
5327 reset_focus_recurse,
5331 /* now propagate the new focus up the widget tree and finally
5332 * set it on the window
5334 widget = focus_widget;
5335 while (widget->parent)
5337 gtk_container_set_focus_child (GTK_CONTAINER (widget->parent), widget);
5338 widget = widget->parent;
5340 if (GTK_IS_WINDOW (widget))
5341 _gtk_window_internal_set_focus (GTK_WINDOW (widget), focus_widget);
5346 gtk_widget_real_query_tooltip (GtkWidget *widget,
5349 gboolean keyboard_tip,
5350 GtkTooltip *tooltip)
5352 gchar *tooltip_markup;
5353 gboolean has_tooltip;
5355 tooltip_markup = g_object_get_qdata (G_OBJECT (widget), quark_tooltip_markup);
5356 has_tooltip = GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (widget), quark_has_tooltip));
5358 if (has_tooltip && tooltip_markup)
5360 gtk_tooltip_set_markup (tooltip, tooltip_markup);
5368 gtk_widget_real_show_help (GtkWidget *widget,
5369 GtkWidgetHelpType help_type)
5371 if (help_type == GTK_WIDGET_HELP_TOOLTIP)
5373 _gtk_tooltip_toggle_keyboard_mode (widget);
5382 gtk_widget_real_focus (GtkWidget *widget,
5383 GtkDirectionType direction)
5385 if (!gtk_widget_get_can_focus (widget))
5388 if (!gtk_widget_is_focus (widget))
5390 gtk_widget_grab_focus (widget);
5398 gtk_widget_real_move_focus (GtkWidget *widget,
5399 GtkDirectionType direction)
5401 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
5403 if (GTK_IS_WINDOW (toplevel) &&
5404 GTK_WINDOW_GET_CLASS (toplevel)->move_focus)
5406 GTK_WINDOW_GET_CLASS (toplevel)->move_focus (GTK_WINDOW (toplevel),
5412 gtk_widget_real_keynav_failed (GtkWidget *widget,
5413 GtkDirectionType direction)
5415 gboolean cursor_only;
5419 case GTK_DIR_TAB_FORWARD:
5420 case GTK_DIR_TAB_BACKWARD:
5427 g_object_get (gtk_widget_get_settings (widget),
5428 "gtk-keynav-cursor-only", &cursor_only,
5435 gtk_widget_error_bell (widget);
5441 * gtk_widget_set_can_focus:
5442 * @widget: a #GtkWidget
5443 * @can_focus: whether or not @widget can own the input focus.
5445 * Specifies whether @widget can own the input focus. See
5446 * gtk_widget_grab_focus() for actually setting the input focus on a
5452 gtk_widget_set_can_focus (GtkWidget *widget,
5455 g_return_if_fail (GTK_IS_WIDGET (widget));
5457 if (can_focus != gtk_widget_get_can_focus (widget))
5460 GTK_WIDGET_SET_FLAGS (widget, GTK_CAN_FOCUS);
5462 GTK_WIDGET_UNSET_FLAGS (widget, GTK_CAN_FOCUS);
5464 gtk_widget_queue_resize (widget);
5465 g_object_notify (G_OBJECT (widget), "can-focus");
5470 * gtk_widget_get_can_focus:
5471 * @widget: a #GtkWidget
5473 * Determines whether @widget can own the input focus. See
5474 * gtk_widget_set_can_focus().
5476 * Return value: %TRUE if @widget can own the input focus, %FALSE otherwise
5481 gtk_widget_get_can_focus (GtkWidget *widget)
5483 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5485 return (GTK_WIDGET_FLAGS (widget) & GTK_CAN_FOCUS) != 0;
5489 * gtk_widget_has_focus:
5490 * @widget: a #GtkWidget
5492 * Determines if the widget has the global input focus. See
5493 * gtk_widget_is_focus() for the difference between having the global
5494 * input focus, and only having the focus within a toplevel.
5496 * Return value: %TRUE if the widget has the global input focus.
5501 gtk_widget_has_focus (GtkWidget *widget)
5503 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5505 return GTK_WIDGET_HAS_FOCUS (widget);
5509 * gtk_widget_is_focus:
5510 * @widget: a #GtkWidget
5512 * Determines if the widget is the focus widget within its
5513 * toplevel. (This does not mean that the %HAS_FOCUS flag is
5514 * necessarily set; %HAS_FOCUS will only be set if the
5515 * toplevel widget additionally has the global input focus.)
5517 * Return value: %TRUE if the widget is the focus widget.
5520 gtk_widget_is_focus (GtkWidget *widget)
5522 GtkWidget *toplevel;
5524 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5526 toplevel = gtk_widget_get_toplevel (widget);
5528 if (GTK_IS_WINDOW (toplevel))
5529 return widget == GTK_WINDOW (toplevel)->focus_widget;
5535 * gtk_widget_set_can_default:
5536 * @widget: a #GtkWidget
5537 * @can_default: whether or not @widget can be a default widget.
5539 * Specifies whether @widget can be a default widget. See
5540 * gtk_widget_grab_default() for details about the meaning of
5546 gtk_widget_set_can_default (GtkWidget *widget,
5547 gboolean can_default)
5549 g_return_if_fail (GTK_IS_WIDGET (widget));
5551 if (can_default != gtk_widget_get_can_default (widget))
5554 GTK_WIDGET_SET_FLAGS (widget, GTK_CAN_DEFAULT);
5556 GTK_WIDGET_UNSET_FLAGS (widget, GTK_CAN_DEFAULT);
5558 gtk_widget_queue_resize (widget);
5559 g_object_notify (G_OBJECT (widget), "can-default");
5564 * gtk_widget_get_can_default:
5565 * @widget: a #GtkWidget
5567 * Determines whether @widget can be a default widget. See
5568 * gtk_widget_set_can_default().
5570 * Return value: %TRUE if @widget can be a default widget, %FALSE otherwise
5575 gtk_widget_get_can_default (GtkWidget *widget)
5577 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5579 return (GTK_WIDGET_FLAGS (widget) & GTK_CAN_DEFAULT) != 0;
5583 * gtk_widget_has_default:
5584 * @widget: a #GtkWidget
5586 * Determines whether @widget is the current default widget within its
5587 * toplevel. See gtk_widget_set_can_default().
5589 * Return value: %TRUE if @widget is the current default widget within
5590 * its toplevel, %FALSE otherwise
5595 gtk_widget_has_default (GtkWidget *widget)
5597 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5599 return (GTK_WIDGET_FLAGS (widget) & GTK_HAS_DEFAULT) != 0;
5603 * gtk_widget_grab_default:
5604 * @widget: a #GtkWidget
5606 * Causes @widget to become the default widget. @widget must have the
5607 * %GTK_CAN_DEFAULT flag set; typically you have to set this flag
5608 * yourself by calling <literal>gtk_widget_set_can_default (@widget,
5609 * %TRUE)</literal>. The default widget is activated when
5610 * the user presses Enter in a window. Default widgets must be
5611 * activatable, that is, gtk_widget_activate() should affect them.
5614 gtk_widget_grab_default (GtkWidget *widget)
5618 g_return_if_fail (GTK_IS_WIDGET (widget));
5619 g_return_if_fail (gtk_widget_get_can_default (widget));
5621 window = gtk_widget_get_toplevel (widget);
5623 if (window && gtk_widget_is_toplevel (window))
5624 gtk_window_set_default (GTK_WINDOW (window), widget);
5626 g_warning (G_STRLOC ": widget not within a GtkWindow");
5630 * gtk_widget_set_receives_default:
5631 * @widget: a #GtkWidget
5632 * @receives_default: whether or not @widget can be a default widget.
5634 * Specifies whether @widget will be treated as the default widget
5635 * within its toplevel when it has the focus, even if another widget
5638 * See gtk_widget_grab_default() for details about the meaning of
5644 gtk_widget_set_receives_default (GtkWidget *widget,
5645 gboolean receives_default)
5647 g_return_if_fail (GTK_IS_WIDGET (widget));
5649 if (receives_default != gtk_widget_get_receives_default (widget))
5651 if (receives_default)
5652 GTK_WIDGET_SET_FLAGS (widget, GTK_RECEIVES_DEFAULT);
5654 GTK_WIDGET_UNSET_FLAGS (widget, GTK_RECEIVES_DEFAULT);
5656 g_object_notify (G_OBJECT (widget), "receives-default");
5661 * gtk_widget_get_receives_default:
5662 * @widget: a #GtkWidget
5664 * Determines whether @widget is alyways treated as default widget
5665 * withing its toplevel when it has the focus, even if another widget
5668 * See gtk_widget_set_receives_default().
5670 * Return value: %TRUE if @widget acts as default widget when focussed,
5676 gtk_widget_get_receives_default (GtkWidget *widget)
5678 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5680 return (GTK_WIDGET_FLAGS (widget) & GTK_RECEIVES_DEFAULT) != 0;
5684 * gtk_widget_has_grab:
5685 * @widget: a #GtkWidget
5687 * Determines whether the widget is currently grabbing events, so it
5688 * is the only widget receiving input events (keyboard and mouse).
5690 * See also gtk_grab_add().
5692 * Return value: %TRUE if the widget is in the grab_widgets stack
5697 gtk_widget_has_grab (GtkWidget *widget)
5699 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5701 return (GTK_WIDGET_FLAGS (widget) & GTK_HAS_GRAB) != 0;
5705 * gtk_widget_set_name:
5706 * @widget: a #GtkWidget
5707 * @name: name for the widget
5709 * Widgets can be named, which allows you to refer to them from a
5710 * gtkrc file. You can apply a style to widgets with a particular name
5711 * in the gtkrc file. See the documentation for gtkrc files (on the
5712 * same page as the docs for #GtkRcStyle).
5714 * Note that widget names are separated by periods in paths (see
5715 * gtk_widget_path()), so names with embedded periods may cause confusion.
5718 gtk_widget_set_name (GtkWidget *widget,
5723 g_return_if_fail (GTK_IS_WIDGET (widget));
5725 new_name = g_strdup (name);
5726 g_free (widget->name);
5727 widget->name = new_name;
5729 if (gtk_widget_has_rc_style (widget))
5730 gtk_widget_reset_rc_style (widget);
5732 g_object_notify (G_OBJECT (widget), "name");
5736 * gtk_widget_get_name:
5737 * @widget: a #GtkWidget
5739 * Retrieves the name of a widget. See gtk_widget_set_name() for the
5740 * significance of widget names.
5742 * Return value: name of the widget. This string is owned by GTK+ and
5743 * should not be modified or freed
5745 G_CONST_RETURN gchar*
5746 gtk_widget_get_name (GtkWidget *widget)
5748 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5751 return widget->name;
5752 return G_OBJECT_TYPE_NAME (widget);
5756 * gtk_widget_set_state:
5757 * @widget: a #GtkWidget
5758 * @state: new state for @widget
5760 * This function is for use in widget implementations. Sets the state
5761 * of a widget (insensitive, prelighted, etc.) Usually you should set
5762 * the state using wrapper functions such as gtk_widget_set_sensitive().
5765 gtk_widget_set_state (GtkWidget *widget,
5768 g_return_if_fail (GTK_IS_WIDGET (widget));
5770 if (state == GTK_WIDGET_STATE (widget))
5773 if (state == GTK_STATE_INSENSITIVE)
5774 gtk_widget_set_sensitive (widget, FALSE);
5780 data.state_restoration = FALSE;
5781 data.use_forall = FALSE;
5783 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget->parent) != FALSE);
5785 data.parent_sensitive = TRUE;
5787 gtk_widget_propagate_state (widget, &data);
5789 if (GTK_WIDGET_DRAWABLE (widget))
5790 gtk_widget_queue_draw (widget);
5795 * gtk_widget_get_state:
5796 * @widget: a #GtkWidget
5798 * Returns the widget's state. See gtk_widget_set_state().
5800 * Returns: the state of @widget.
5805 gtk_widget_get_state (GtkWidget *widget)
5807 g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_STATE_NORMAL);
5809 return widget->state;
5813 * gtk_widget_set_visible:
5814 * @widget: a #GtkWidget
5815 * @visible: whether the widget should be shown or not
5817 * Sets the visibility state of @widget. Note that setting this to
5818 * %TRUE doesn't mean the widget is actually viewable, see
5819 * gtk_widget_get_visible().
5821 * This function simply calls gtk_widget_show() or gtk_widget_hide()
5822 * but is nicer to use when the visibility of the widget depends on
5828 gtk_widget_set_visible (GtkWidget *widget,
5831 g_return_if_fail (GTK_IS_WIDGET (widget));
5833 if (visible != GTK_WIDGET_VISIBLE (widget))
5836 gtk_widget_show (widget);
5838 gtk_widget_hide (widget);
5843 * gtk_widget_get_visible:
5844 * @widget: a #GtkWidget
5846 * Determines whether the widget is visible. Note that this doesn't
5847 * take into account whether the widget's parent is also visible
5848 * or the widget is obscured in any way.
5850 * See gtk_widget_set_visible().
5852 * Return value: %TRUE if the widget is visible
5857 gtk_widget_get_visible (GtkWidget *widget)
5859 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5861 return (GTK_WIDGET_FLAGS (widget) & GTK_VISIBLE) != 0;
5865 * gtk_widget_set_has_window:
5866 * @widget: a #GtkWidget
5867 * @has_window: whether or not @widget has a window.
5869 * Specifies whether @widget has a #GdkWindow of its own. Note that
5870 * all realized widgets have a non-%NULL "window" pointer
5871 * (gtk_widget_get_window() never returns a %NULL window when a widget
5872 * is realized), but for many of them it's actually the #GdkWindow of
5873 * one of its parent widgets. Widgets that create a %window for
5874 * themselves in GtkWidget::realize() however must announce this by
5875 * calling this function with @has_window = %TRUE.
5877 * This function should only be called by widget implementations,
5878 * and they should call it in their init() function.
5883 gtk_widget_set_has_window (GtkWidget *widget,
5884 gboolean has_window)
5886 g_return_if_fail (GTK_IS_WIDGET (widget));
5889 GTK_WIDGET_UNSET_FLAGS (widget, GTK_NO_WINDOW);
5891 GTK_WIDGET_SET_FLAGS (widget, GTK_NO_WINDOW);
5895 * gtk_widget_get_has_window:
5896 * @widget: a #GtkWidget
5898 * Determines whether @widget has a #GdkWindow of its own. See
5899 * gtk_widget_set_has_window().
5901 * Return value: %TRUE if @widget has a window, %FALSE otherwise
5906 gtk_widget_get_has_window (GtkWidget *widget)
5908 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5910 return !GTK_WIDGET_NO_WINDOW (widget);
5914 * gtk_widget_is_toplevel:
5915 * @widget: a #GtkWidget
5917 * Determines whether @widget is a toplevel widget. Currently only
5918 * #GtkWindow and #GtkInvisible are toplevel widgets. Toplevel
5919 * widgets have no parent widget.
5921 * Return value: %TRUE if @widget is a toplevel, %FALSE otherwise
5926 gtk_widget_is_toplevel (GtkWidget *widget)
5928 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5930 return (GTK_WIDGET_FLAGS (widget) & GTK_TOPLEVEL) != 0;
5934 * gtk_widget_is_drawable:
5935 * @widget: a #GtkWidget
5937 * Determines whether @widget can be drawn to. A widget can be drawn
5938 * to if it is mapped and visible.
5940 * Return value: %TRUE if @widget is drawable, %FALSE otherwise
5945 gtk_widget_is_drawable (GtkWidget *widget)
5947 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5949 return ((GTK_WIDGET_FLAGS (widget) & GTK_VISIBLE) != 0 &&
5950 (GTK_WIDGET_FLAGS (widget) & GTK_MAPPED) != 0);
5954 * gtk_widget_set_app_paintable:
5955 * @widget: a #GtkWidget
5956 * @app_paintable: %TRUE if the application will paint on the widget
5958 * Sets whether the application intends to draw on the widget in
5959 * an #GtkWidget::expose-event handler.
5961 * This is a hint to the widget and does not affect the behavior of
5962 * the GTK+ core; many widgets ignore this flag entirely. For widgets
5963 * that do pay attention to the flag, such as #GtkEventBox and #GtkWindow,
5964 * the effect is to suppress default themed drawing of the widget's
5965 * background. (Children of the widget will still be drawn.) The application
5966 * is then entirely responsible for drawing the widget background.
5968 * Note that the background is still drawn when the widget is mapped.
5969 * If this is not suitable (e.g. because you want to make a transparent
5970 * window using an RGBA visual), you can work around this by doing:
5972 * gtk_widget_realize (window);
5973 * gdk_window_set_back_pixmap (window->window, NULL, FALSE);
5974 * gtk_widget_show (window);
5978 gtk_widget_set_app_paintable (GtkWidget *widget,
5979 gboolean app_paintable)
5981 g_return_if_fail (GTK_IS_WIDGET (widget));
5983 app_paintable = (app_paintable != FALSE);
5985 if (gtk_widget_get_app_paintable (widget) != app_paintable)
5988 GTK_WIDGET_SET_FLAGS (widget, GTK_APP_PAINTABLE);
5990 GTK_WIDGET_UNSET_FLAGS (widget, GTK_APP_PAINTABLE);
5992 if (GTK_WIDGET_DRAWABLE (widget))
5993 gtk_widget_queue_draw (widget);
5995 g_object_notify (G_OBJECT (widget), "app-paintable");
6000 * gtk_widget_get_app_paintable:
6001 * @widget: a #GtkWidget
6003 * Determines whether the application intends to draw on the widget in
6004 * an #GtkWidget::expose-event handler.
6006 * See gtk_widget_set_app_paintable()
6008 * Return value: %TRUE if the widget is app paintable
6013 gtk_widget_get_app_paintable (GtkWidget *widget)
6015 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6017 return (GTK_WIDGET_FLAGS (widget) & GTK_APP_PAINTABLE) != 0;
6021 * gtk_widget_set_double_buffered:
6022 * @widget: a #GtkWidget
6023 * @double_buffered: %TRUE to double-buffer a widget
6025 * Widgets are double buffered by default; you can use this function
6026 * to turn off the buffering. "Double buffered" simply means that
6027 * gdk_window_begin_paint_region() and gdk_window_end_paint() are called
6028 * automatically around expose events sent to the
6029 * widget. gdk_window_begin_paint() diverts all drawing to a widget's
6030 * window to an offscreen buffer, and gdk_window_end_paint() draws the
6031 * buffer to the screen. The result is that users see the window
6032 * update in one smooth step, and don't see individual graphics
6033 * primitives being rendered.
6035 * In very simple terms, double buffered widgets don't flicker,
6036 * so you would only use this function to turn off double buffering
6037 * if you had special needs and really knew what you were doing.
6039 * Note: if you turn off double-buffering, you have to handle
6040 * expose events, since even the clearing to the background color or
6041 * pixmap will not happen automatically (as it is done in
6042 * gdk_window_begin_paint()).
6045 gtk_widget_set_double_buffered (GtkWidget *widget,
6046 gboolean double_buffered)
6048 g_return_if_fail (GTK_IS_WIDGET (widget));
6050 if (double_buffered != gtk_widget_get_double_buffered (widget))
6052 if (double_buffered)
6053 GTK_WIDGET_SET_FLAGS (widget, GTK_DOUBLE_BUFFERED);
6055 GTK_WIDGET_UNSET_FLAGS (widget, GTK_DOUBLE_BUFFERED);
6057 g_object_notify (G_OBJECT (widget), "double-buffered");
6062 * gtk_widget_get_double_buffered:
6063 * @widget: a #GtkWidget
6065 * Determines whether the widget is double buffered.
6067 * See gtk_widget_set_double_buffered()
6069 * Return value: %TRUE if the widget is double buffered
6074 gtk_widget_get_double_buffered (GtkWidget *widget)
6076 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6078 return (GTK_WIDGET_FLAGS (widget) & GTK_DOUBLE_BUFFERED) != 0;
6082 * gtk_widget_set_redraw_on_allocate:
6083 * @widget: a #GtkWidget
6084 * @redraw_on_allocate: if %TRUE, the entire widget will be redrawn
6085 * when it is allocated to a new size. Otherwise, only the
6086 * new portion of the widget will be redrawn.
6088 * Sets whether the entire widget is queued for drawing when its size
6089 * allocation changes. By default, this setting is %TRUE and
6090 * the entire widget is redrawn on every size change. If your widget
6091 * leaves the upper left unchanged when made bigger, turning this
6092 * setting off will improve performance.
6094 * Note that for %NO_WINDOW widgets setting this flag to %FALSE turns
6095 * off all allocation on resizing: the widget will not even redraw if
6096 * its position changes; this is to allow containers that don't draw
6097 * anything to avoid excess invalidations. If you set this flag on a
6098 * %NO_WINDOW widget that <emphasis>does</emphasis> draw on @widget->window,
6099 * you are responsible for invalidating both the old and new allocation
6100 * of the widget when the widget is moved and responsible for invalidating
6101 * regions newly when the widget increases size.
6104 gtk_widget_set_redraw_on_allocate (GtkWidget *widget,
6105 gboolean redraw_on_allocate)
6107 g_return_if_fail (GTK_IS_WIDGET (widget));
6109 if (redraw_on_allocate)
6110 GTK_PRIVATE_SET_FLAG (widget, GTK_REDRAW_ON_ALLOC);
6112 GTK_PRIVATE_UNSET_FLAG (widget, GTK_REDRAW_ON_ALLOC);
6116 * gtk_widget_set_sensitive:
6117 * @widget: a #GtkWidget
6118 * @sensitive: %TRUE to make the widget sensitive
6120 * Sets the sensitivity of a widget. A widget is sensitive if the user
6121 * can interact with it. Insensitive widgets are "grayed out" and the
6122 * user can't interact with them. Insensitive widgets are known as
6123 * "inactive", "disabled", or "ghosted" in some other toolkits.
6126 gtk_widget_set_sensitive (GtkWidget *widget,
6131 g_return_if_fail (GTK_IS_WIDGET (widget));
6133 sensitive = (sensitive != FALSE);
6135 if (sensitive == (GTK_WIDGET_SENSITIVE (widget) != FALSE))
6140 GTK_WIDGET_SET_FLAGS (widget, GTK_SENSITIVE);
6141 data.state = widget->saved_state;
6145 GTK_WIDGET_UNSET_FLAGS (widget, GTK_SENSITIVE);
6146 data.state = GTK_WIDGET_STATE (widget);
6148 data.state_restoration = TRUE;
6149 data.use_forall = TRUE;
6152 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget->parent) != FALSE);
6154 data.parent_sensitive = TRUE;
6156 gtk_widget_propagate_state (widget, &data);
6157 if (GTK_WIDGET_DRAWABLE (widget))
6158 gtk_widget_queue_draw (widget);
6160 g_object_notify (G_OBJECT (widget), "sensitive");
6164 * gtk_widget_get_sensitive:
6165 * @widget: a #GtkWidget
6167 * Returns the widget's sensitivity (in the sense of returning
6168 * the value that has been set using gtk_widget_set_sensitive()).
6170 * The effective sensitivity of a widget is however determined by both its
6171 * own and its parent widget's sensitivity. See gtk_widget_is_sensitive().
6173 * Returns: %TRUE if the widget is sensitive
6178 gtk_widget_get_sensitive (GtkWidget *widget)
6180 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6182 return GTK_WIDGET_SENSITIVE (widget);
6186 * gtk_widget_is_sensitive:
6187 * @widget: a #GtkWidget
6189 * Returns the widget's effective sensitivity, which means
6190 * it is sensitive itself and also its parent widget is sensntive
6192 * Returns: %TRUE if the widget is effectively sensitive
6197 gtk_widget_is_sensitive (GtkWidget *widget)
6199 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6201 return GTK_WIDGET_IS_SENSITIVE (widget);
6205 * gtk_widget_set_parent:
6206 * @widget: a #GtkWidget
6207 * @parent: parent container
6209 * This function is useful only when implementing subclasses of
6211 * Sets the container as the parent of @widget, and takes care of
6212 * some details such as updating the state and style of the child
6213 * to reflect its new location. The opposite function is
6214 * gtk_widget_unparent().
6217 gtk_widget_set_parent (GtkWidget *widget,
6222 g_return_if_fail (GTK_IS_WIDGET (widget));
6223 g_return_if_fail (GTK_IS_WIDGET (parent));
6224 g_return_if_fail (widget != parent);
6225 if (widget->parent != NULL)
6227 g_warning ("Can't set a parent on widget which has a parent\n");
6230 if (gtk_widget_is_toplevel (widget))
6232 g_warning ("Can't set a parent on a toplevel widget\n");
6236 /* keep this function in sync with gtk_menu_attach_to_widget()
6239 g_object_ref_sink (widget);
6240 widget->parent = parent;
6242 if (GTK_WIDGET_STATE (parent) != GTK_STATE_NORMAL)
6243 data.state = GTK_WIDGET_STATE (parent);
6245 data.state = GTK_WIDGET_STATE (widget);
6246 data.state_restoration = FALSE;
6247 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (parent) != FALSE);
6248 data.use_forall = GTK_WIDGET_IS_SENSITIVE (parent) != GTK_WIDGET_IS_SENSITIVE (widget);
6250 gtk_widget_propagate_state (widget, &data);
6252 gtk_widget_reset_rc_styles (widget);
6254 g_signal_emit (widget, widget_signals[PARENT_SET], 0, NULL);
6255 if (GTK_WIDGET_ANCHORED (widget->parent))
6256 _gtk_widget_propagate_hierarchy_changed (widget, NULL);
6257 g_object_notify (G_OBJECT (widget), "parent");
6259 /* Enforce realized/mapped invariants
6261 if (GTK_WIDGET_REALIZED (widget->parent))
6262 gtk_widget_realize (widget);
6264 if (GTK_WIDGET_VISIBLE (widget->parent) &&
6265 GTK_WIDGET_VISIBLE (widget))
6267 if (GTK_WIDGET_CHILD_VISIBLE (widget) &&
6268 GTK_WIDGET_MAPPED (widget->parent))
6269 gtk_widget_map (widget);
6271 gtk_widget_queue_resize (widget);
6276 * gtk_widget_get_parent:
6277 * @widget: a #GtkWidget
6279 * Returns the parent container of @widget.
6281 * Return value: (transfer none): the parent container of @widget, or %NULL
6284 gtk_widget_get_parent (GtkWidget *widget)
6286 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6288 return widget->parent;
6291 /*****************************************
6293 * see docs/styles.txt
6294 *****************************************/
6297 * gtk_widget_style_attach:
6298 * @widget: a #GtkWidget
6300 * This function attaches the widget's #GtkStyle to the widget's
6301 * #GdkWindow. It is a replacement for
6304 * widget->style = gtk_style_attach (widget->style, widget->window);
6307 * and should only ever be called in a derived widget's "realize"
6308 * implementation which does not chain up to its parent class'
6309 * "realize" implementation, because one of the parent classes
6310 * (finally #GtkWidget) would attach the style itself.
6315 gtk_widget_style_attach (GtkWidget *widget)
6317 g_return_if_fail (GTK_IS_WIDGET (widget));
6319 widget->style = gtk_style_attach (widget->style, widget->window);
6323 * gtk_widget_has_rc_style:
6324 * @widget: a #GtkWidget
6326 * Determines if the widget style has been looked up through the rc mechanism.
6328 * Returns: %TRUE if the widget has been looked up through the rc
6329 * mechanism, %FALSE otherwise.
6334 gtk_widget_has_rc_style (GtkWidget *widget)
6336 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6338 return (GTK_WIDGET_FLAGS (widget) & GTK_RC_STYLE) != 0;
6342 * gtk_widget_set_style:
6343 * @widget: a #GtkWidget
6344 * @style: (allow-none): a #GtkStyle, or %NULL to remove the effect of a previous
6345 * gtk_widget_set_style() and go back to the default style
6347 * Sets the #GtkStyle for a widget (@widget->style). You probably don't
6348 * want to use this function; it interacts badly with themes, because
6349 * themes work by replacing the #GtkStyle. Instead, use
6350 * gtk_widget_modify_style().
6353 gtk_widget_set_style (GtkWidget *widget,
6356 g_return_if_fail (GTK_IS_WIDGET (widget));
6360 gboolean initial_emission;
6362 initial_emission = !gtk_widget_has_rc_style (widget) && !GTK_WIDGET_USER_STYLE (widget);
6364 GTK_WIDGET_UNSET_FLAGS (widget, GTK_RC_STYLE);
6365 GTK_PRIVATE_SET_FLAG (widget, GTK_USER_STYLE);
6367 gtk_widget_set_style_internal (widget, style, initial_emission);
6371 if (GTK_WIDGET_USER_STYLE (widget))
6372 gtk_widget_reset_rc_style (widget);
6377 * gtk_widget_ensure_style:
6378 * @widget: a #GtkWidget
6380 * Ensures that @widget has a style (@widget->style). Not a very useful
6381 * function; most of the time, if you want the style, the widget is
6382 * realized, and realized widgets are guaranteed to have a style
6386 gtk_widget_ensure_style (GtkWidget *widget)
6388 g_return_if_fail (GTK_IS_WIDGET (widget));
6390 if (!GTK_WIDGET_USER_STYLE (widget) &&
6391 !gtk_widget_has_rc_style (widget))
6392 gtk_widget_reset_rc_style (widget);
6395 /* Look up the RC style for this widget, unsetting any user style that
6396 * may be in effect currently
6399 gtk_widget_reset_rc_style (GtkWidget *widget)
6401 GtkStyle *new_style = NULL;
6402 gboolean initial_emission;
6404 initial_emission = !gtk_widget_has_rc_style (widget) && !GTK_WIDGET_USER_STYLE (widget);
6406 GTK_PRIVATE_UNSET_FLAG (widget, GTK_USER_STYLE);
6407 GTK_WIDGET_SET_FLAGS (widget, GTK_RC_STYLE);
6409 if (gtk_widget_has_screen (widget))
6410 new_style = gtk_rc_get_style (widget);
6412 new_style = gtk_widget_get_default_style ();
6414 if (initial_emission || new_style != widget->style)
6415 gtk_widget_set_style_internal (widget, new_style, initial_emission);
6419 * gtk_widget_get_style:
6420 * @widget: a #GtkWidget
6422 * Simply an accessor function that returns @widget->style.
6424 * Return value: (transfer none): the widget's #GtkStyle
6427 gtk_widget_get_style (GtkWidget *widget)
6429 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6431 return widget->style;
6435 * gtk_widget_modify_style:
6436 * @widget: a #GtkWidget
6437 * @style: the #GtkRcStyle holding the style modifications
6439 * Modifies style values on the widget. Modifications made using this
6440 * technique take precedence over style values set via an RC file,
6441 * however, they will be overriden if a style is explicitely set on
6442 * the widget using gtk_widget_set_style(). The #GtkRcStyle structure
6443 * is designed so each field can either be set or unset, so it is
6444 * possible, using this function, to modify some style values and
6445 * leave the others unchanged.
6447 * Note that modifications made with this function are not cumulative
6448 * with previous calls to gtk_widget_modify_style() or with such
6449 * functions as gtk_widget_modify_fg(). If you wish to retain
6450 * previous values, you must first call gtk_widget_get_modifier_style(),
6451 * make your modifications to the returned style, then call
6452 * gtk_widget_modify_style() with that style. On the other hand,
6453 * if you first call gtk_widget_modify_style(), subsequent calls
6454 * to such functions gtk_widget_modify_fg() will have a cumulative
6455 * effect with the initial modifications.
6458 gtk_widget_modify_style (GtkWidget *widget,
6461 g_return_if_fail (GTK_IS_WIDGET (widget));
6462 g_return_if_fail (GTK_IS_RC_STYLE (style));
6464 g_object_set_qdata_full (G_OBJECT (widget),
6466 gtk_rc_style_copy (style),
6467 (GDestroyNotify) g_object_unref);
6469 /* note that "style" may be invalid here if it was the old
6470 * modifier style and the only reference was our own.
6473 if (gtk_widget_has_rc_style (widget))
6474 gtk_widget_reset_rc_style (widget);
6478 * gtk_widget_get_modifier_style:
6479 * @widget: a #GtkWidget
6481 * Returns the current modifier style for the widget. (As set by
6482 * gtk_widget_modify_style().) If no style has previously set, a new
6483 * #GtkRcStyle will be created with all values unset, and set as the
6484 * modifier style for the widget. If you make changes to this rc
6485 * style, you must call gtk_widget_modify_style(), passing in the
6486 * returned rc style, to make sure that your changes take effect.
6488 * Caution: passing the style back to gtk_widget_modify_style() will
6489 * normally end up destroying it, because gtk_widget_modify_style() copies
6490 * the passed-in style and sets the copy as the new modifier style,
6491 * thus dropping any reference to the old modifier style. Add a reference
6492 * to the modifier style if you want to keep it alive.
6494 * Return value: (transfer none): the modifier style for the widget. This rc style is
6495 * owned by the widget. If you want to keep a pointer to value this
6496 * around, you must add a refcount using g_object_ref().
6499 gtk_widget_get_modifier_style (GtkWidget *widget)
6501 GtkRcStyle *rc_style;
6503 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6505 rc_style = g_object_get_qdata (G_OBJECT (widget), quark_rc_style);
6509 rc_style = gtk_rc_style_new ();
6510 g_object_set_qdata_full (G_OBJECT (widget),
6513 (GDestroyNotify) g_object_unref);
6520 gtk_widget_modify_color_component (GtkWidget *widget,
6521 GtkRcFlags component,
6523 const GdkColor *color)
6525 GtkRcStyle *rc_style = gtk_widget_get_modifier_style (widget);
6532 rc_style->fg[state] = *color;
6535 rc_style->bg[state] = *color;
6538 rc_style->text[state] = *color;
6541 rc_style->base[state] = *color;
6544 g_assert_not_reached();
6547 rc_style->color_flags[state] |= component;
6550 rc_style->color_flags[state] &= ~component;
6552 gtk_widget_modify_style (widget, rc_style);
6556 * gtk_widget_modify_fg:
6557 * @widget: a #GtkWidget
6558 * @state: the state for which to set the foreground color
6559 * @color: (allow-none): the color to assign (does not need to be allocated),
6560 * or %NULL to undo the effect of previous calls to
6561 * of gtk_widget_modify_fg().
6563 * Sets the foreground color for a widget in a particular state.
6564 * All other style values are left untouched. See also
6565 * gtk_widget_modify_style().
6568 gtk_widget_modify_fg (GtkWidget *widget,
6570 const GdkColor *color)
6572 g_return_if_fail (GTK_IS_WIDGET (widget));
6573 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
6575 gtk_widget_modify_color_component (widget, GTK_RC_FG, state, color);
6579 * gtk_widget_modify_bg:
6580 * @widget: a #GtkWidget
6581 * @state: the state for which to set the background color
6582 * @color: (allow-none): the color to assign (does not need to be allocated),
6583 * or %NULL to undo the effect of previous calls to
6584 * of gtk_widget_modify_bg().
6586 * Sets the background color for a widget in a particular state.
6587 * All other style values are left untouched. See also
6588 * gtk_widget_modify_style().
6590 * Note that "no window" widgets (which have the %GTK_NO_WINDOW flag set)
6591 * draw on their parent container's window and thus may not draw any
6592 * background themselves. This is the case for e.g. #GtkLabel. To modify
6593 * the background of such widgets, you have to set the background color
6594 * on their parent; if you want to set the background of a rectangular
6595 * area around a label, try placing the label in a #GtkEventBox widget
6596 * and setting the background color on that.
6599 gtk_widget_modify_bg (GtkWidget *widget,
6601 const GdkColor *color)
6603 g_return_if_fail (GTK_IS_WIDGET (widget));
6604 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
6606 gtk_widget_modify_color_component (widget, GTK_RC_BG, state, color);
6610 * gtk_widget_modify_text:
6611 * @widget: a #GtkWidget
6612 * @state: the state for which to set the text color
6613 * @color: (allow-none): the color to assign (does not need to be allocated),
6614 * or %NULL to undo the effect of previous calls to
6615 * of gtk_widget_modify_text().
6617 * Sets the text color for a widget in a particular state. All other
6618 * style values are left untouched. The text color is the foreground
6619 * color used along with the base color (see gtk_widget_modify_base())
6620 * for widgets such as #GtkEntry and #GtkTextView. See also
6621 * gtk_widget_modify_style().
6624 gtk_widget_modify_text (GtkWidget *widget,
6626 const GdkColor *color)
6628 g_return_if_fail (GTK_IS_WIDGET (widget));
6629 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
6631 gtk_widget_modify_color_component (widget, GTK_RC_TEXT, state, color);
6635 * gtk_widget_modify_base:
6636 * @widget: a #GtkWidget
6637 * @state: the state for which to set the base color
6638 * @color: (allow-none): the color to assign (does not need to be allocated),
6639 * or %NULL to undo the effect of previous calls to
6640 * of gtk_widget_modify_base().
6642 * Sets the base color for a widget in a particular state.
6643 * All other style values are left untouched. The base color
6644 * is the background color used along with the text color
6645 * (see gtk_widget_modify_text()) for widgets such as #GtkEntry
6646 * and #GtkTextView. See also gtk_widget_modify_style().
6648 * Note that "no window" widgets (which have the %GTK_NO_WINDOW flag set)
6649 * draw on their parent container's window and thus may not draw any
6650 * background themselves. This is the case for e.g. #GtkLabel. To modify
6651 * the background of such widgets, you have to set the base color on their
6652 * parent; if you want to set the background of a rectangular area around
6653 * a label, try placing the label in a #GtkEventBox widget and setting
6654 * the base color on that.
6657 gtk_widget_modify_base (GtkWidget *widget,
6659 const GdkColor *color)
6661 g_return_if_fail (GTK_IS_WIDGET (widget));
6662 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
6664 gtk_widget_modify_color_component (widget, GTK_RC_BASE, state, color);
6668 modify_color_property (GtkWidget *widget,
6669 GtkRcStyle *rc_style,
6671 const GdkColor *color)
6673 GQuark type_name = g_type_qname (G_OBJECT_TYPE (widget));
6674 GQuark property_name = g_quark_from_string (name);
6678 GtkRcProperty rc_property = {0};
6681 rc_property.type_name = type_name;
6682 rc_property.property_name = property_name;
6683 rc_property.origin = NULL;
6685 color_name = gdk_color_to_string (color);
6686 g_value_init (&rc_property.value, G_TYPE_STRING);
6687 g_value_take_string (&rc_property.value, color_name);
6689 _gtk_rc_style_set_rc_property (rc_style, &rc_property);
6691 g_value_unset (&rc_property.value);
6694 _gtk_rc_style_unset_rc_property (rc_style, type_name, property_name);
6698 * gtk_widget_modify_cursor:
6699 * @widget: a #GtkWidget
6700 * @primary: the color to use for primary cursor (does not need to be
6701 * allocated), or %NULL to undo the effect of previous calls to
6702 * of gtk_widget_modify_cursor().
6703 * @secondary: the color to use for secondary cursor (does not need to be
6704 * allocated), or %NULL to undo the effect of previous calls to
6705 * of gtk_widget_modify_cursor().
6707 * Sets the cursor color to use in a widget, overriding the
6708 * #GtkWidget:cursor-color and #GtkWidget:secondary-cursor-color
6709 * style properties. All other style values are left untouched.
6710 * See also gtk_widget_modify_style().
6715 gtk_widget_modify_cursor (GtkWidget *widget,
6716 const GdkColor *primary,
6717 const GdkColor *secondary)
6719 GtkRcStyle *rc_style;
6721 g_return_if_fail (GTK_IS_WIDGET (widget));
6723 rc_style = gtk_widget_get_modifier_style (widget);
6725 modify_color_property (widget, rc_style, "cursor-color", primary);
6726 modify_color_property (widget, rc_style, "secondary-cursor-color", secondary);
6728 gtk_widget_modify_style (widget, rc_style);
6732 * gtk_widget_modify_font:
6733 * @widget: a #GtkWidget
6734 * @font_desc: (allow-none): the font description to use, or %NULL to undo
6735 * the effect of previous calls to gtk_widget_modify_font().
6737 * Sets the font to use for a widget. All other style values are left
6738 * untouched. See also gtk_widget_modify_style().
6741 gtk_widget_modify_font (GtkWidget *widget,
6742 PangoFontDescription *font_desc)
6744 GtkRcStyle *rc_style;
6746 g_return_if_fail (GTK_IS_WIDGET (widget));
6748 rc_style = gtk_widget_get_modifier_style (widget);
6750 if (rc_style->font_desc)
6751 pango_font_description_free (rc_style->font_desc);
6754 rc_style->font_desc = pango_font_description_copy (font_desc);
6756 rc_style->font_desc = NULL;
6758 gtk_widget_modify_style (widget, rc_style);
6762 gtk_widget_real_direction_changed (GtkWidget *widget,
6763 GtkTextDirection previous_direction)
6765 gtk_widget_queue_resize (widget);
6769 gtk_widget_real_style_set (GtkWidget *widget,
6770 GtkStyle *previous_style)
6772 if (GTK_WIDGET_REALIZED (widget) &&
6773 !GTK_WIDGET_NO_WINDOW (widget))
6774 gtk_style_set_background (widget->style, widget->window, widget->state);
6778 gtk_widget_set_style_internal (GtkWidget *widget,
6780 gboolean initial_emission)
6782 g_object_ref (widget);
6783 g_object_freeze_notify (G_OBJECT (widget));
6785 if (widget->style != style)
6787 GtkStyle *previous_style;
6789 if (GTK_WIDGET_REALIZED (widget))
6791 gtk_widget_reset_shapes (widget);
6792 gtk_style_detach (widget->style);
6795 previous_style = widget->style;
6796 widget->style = style;
6797 g_object_ref (widget->style);
6799 if (GTK_WIDGET_REALIZED (widget))
6800 widget->style = gtk_style_attach (widget->style, widget->window);
6802 gtk_widget_update_pango_context (widget);
6803 g_signal_emit (widget,
6804 widget_signals[STYLE_SET],
6806 initial_emission ? NULL : previous_style);
6807 g_object_unref (previous_style);
6809 if (GTK_WIDGET_ANCHORED (widget) && !initial_emission)
6810 gtk_widget_queue_resize (widget);
6812 else if (initial_emission)
6814 gtk_widget_update_pango_context (widget);
6815 g_signal_emit (widget,
6816 widget_signals[STYLE_SET],
6820 g_object_notify (G_OBJECT (widget), "style");
6821 g_object_thaw_notify (G_OBJECT (widget));
6822 g_object_unref (widget);
6826 GtkWidget *previous_toplevel;
6827 GdkScreen *previous_screen;
6828 GdkScreen *new_screen;
6829 } HierarchyChangedInfo;
6832 do_screen_change (GtkWidget *widget,
6833 GdkScreen *old_screen,
6834 GdkScreen *new_screen)
6836 if (old_screen != new_screen)
6840 PangoContext *context = g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
6842 g_object_set_qdata (G_OBJECT (widget), quark_pango_context, NULL);
6845 _gtk_tooltip_hide (widget);
6846 g_signal_emit (widget, widget_signals[SCREEN_CHANGED], 0, old_screen);
6851 gtk_widget_propagate_hierarchy_changed_recurse (GtkWidget *widget,
6852 gpointer client_data)
6854 HierarchyChangedInfo *info = client_data;
6855 gboolean new_anchored = gtk_widget_is_toplevel (widget) ||
6856 (widget->parent && GTK_WIDGET_ANCHORED (widget->parent));
6858 if (GTK_WIDGET_ANCHORED (widget) != new_anchored)
6860 g_object_ref (widget);
6863 GTK_PRIVATE_SET_FLAG (widget, GTK_ANCHORED);
6865 GTK_PRIVATE_UNSET_FLAG (widget, GTK_ANCHORED);
6867 g_signal_emit (widget, widget_signals[HIERARCHY_CHANGED], 0, info->previous_toplevel);
6868 do_screen_change (widget, info->previous_screen, info->new_screen);
6870 if (GTK_IS_CONTAINER (widget))
6871 gtk_container_forall (GTK_CONTAINER (widget),
6872 gtk_widget_propagate_hierarchy_changed_recurse,
6875 g_object_unref (widget);
6880 * _gtk_widget_propagate_hierarchy_changed:
6881 * @widget: a #GtkWidget
6882 * @previous_toplevel: Previous toplevel
6884 * Propagates changes in the anchored state to a widget and all
6885 * children, unsetting or setting the %ANCHORED flag, and
6886 * emitting #GtkWidget::hierarchy-changed.
6889 _gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
6890 GtkWidget *previous_toplevel)
6892 HierarchyChangedInfo info;
6894 info.previous_toplevel = previous_toplevel;
6895 info.previous_screen = previous_toplevel ? gtk_widget_get_screen (previous_toplevel) : NULL;
6897 if (gtk_widget_is_toplevel (widget) ||
6898 (widget->parent && GTK_WIDGET_ANCHORED (widget->parent)))
6899 info.new_screen = gtk_widget_get_screen (widget);
6901 info.new_screen = NULL;
6903 if (info.previous_screen)
6904 g_object_ref (info.previous_screen);
6905 if (previous_toplevel)
6906 g_object_ref (previous_toplevel);
6908 gtk_widget_propagate_hierarchy_changed_recurse (widget, &info);
6910 if (previous_toplevel)
6911 g_object_unref (previous_toplevel);
6912 if (info.previous_screen)
6913 g_object_unref (info.previous_screen);
6917 gtk_widget_propagate_screen_changed_recurse (GtkWidget *widget,
6918 gpointer client_data)
6920 HierarchyChangedInfo *info = client_data;
6922 g_object_ref (widget);
6924 do_screen_change (widget, info->previous_screen, info->new_screen);
6926 if (GTK_IS_CONTAINER (widget))
6927 gtk_container_forall (GTK_CONTAINER (widget),
6928 gtk_widget_propagate_screen_changed_recurse,
6931 g_object_unref (widget);
6935 * gtk_widget_is_composited:
6936 * @widget: a #GtkWidget
6938 * Whether @widget can rely on having its alpha channel
6939 * drawn correctly. On X11 this function returns whether a
6940 * compositing manager is running for @widget's screen.
6942 * Please note that the semantics of this call will change
6943 * in the future if used on a widget that has a composited
6944 * window in its hierarchy (as set by gdk_window_set_composited()).
6946 * Return value: %TRUE if the widget can rely on its alpha
6947 * channel being drawn correctly.
6952 gtk_widget_is_composited (GtkWidget *widget)
6956 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6958 screen = gtk_widget_get_screen (widget);
6960 return gdk_screen_is_composited (screen);
6964 propagate_composited_changed (GtkWidget *widget,
6967 if (GTK_IS_CONTAINER (widget))
6969 gtk_container_forall (GTK_CONTAINER (widget),
6970 propagate_composited_changed,
6974 g_signal_emit (widget, widget_signals[COMPOSITED_CHANGED], 0);
6978 _gtk_widget_propagate_composited_changed (GtkWidget *widget)
6980 propagate_composited_changed (widget, NULL);
6984 * _gtk_widget_propagate_screen_changed:
6985 * @widget: a #GtkWidget
6986 * @previous_screen: Previous screen
6988 * Propagates changes in the screen for a widget to all
6989 * children, emitting #GtkWidget::screen-changed.
6992 _gtk_widget_propagate_screen_changed (GtkWidget *widget,
6993 GdkScreen *previous_screen)
6995 HierarchyChangedInfo info;
6997 info.previous_screen = previous_screen;
6998 info.new_screen = gtk_widget_get_screen (widget);
7000 if (previous_screen)
7001 g_object_ref (previous_screen);
7003 gtk_widget_propagate_screen_changed_recurse (widget, &info);
7005 if (previous_screen)
7006 g_object_unref (previous_screen);
7010 reset_rc_styles_recurse (GtkWidget *widget, gpointer data)
7012 if (gtk_widget_has_rc_style (widget))
7013 gtk_widget_reset_rc_style (widget);
7015 if (GTK_IS_CONTAINER (widget))
7016 gtk_container_forall (GTK_CONTAINER (widget),
7017 reset_rc_styles_recurse,
7023 * gtk_widget_reset_rc_styles:
7024 * @widget: a #GtkWidget.
7026 * Reset the styles of @widget and all descendents, so when
7027 * they are looked up again, they get the correct values
7028 * for the currently loaded RC file settings.
7030 * This function is not useful for applications.
7033 gtk_widget_reset_rc_styles (GtkWidget *widget)
7035 g_return_if_fail (GTK_IS_WIDGET (widget));
7037 reset_rc_styles_recurse (widget, NULL);
7041 * gtk_widget_get_default_style:
7043 * Returns the default style used by all widgets initially.
7045 * Returns: (transfer none): the default style. This #GtkStyle object is owned
7046 * by GTK+ and should not be modified or freed.
7049 gtk_widget_get_default_style (void)
7051 if (!gtk_default_style)
7053 gtk_default_style = gtk_style_new ();
7054 g_object_ref (gtk_default_style);
7057 return gtk_default_style;
7060 static PangoContext *
7061 gtk_widget_peek_pango_context (GtkWidget *widget)
7063 return g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
7067 * gtk_widget_get_pango_context:
7068 * @widget: a #GtkWidget
7070 * Gets a #PangoContext with the appropriate font map, font description,
7071 * and base direction for this widget. Unlike the context returned
7072 * by gtk_widget_create_pango_context(), this context is owned by
7073 * the widget (it can be used until the screen for the widget changes
7074 * or the widget is removed from its toplevel), and will be updated to
7075 * match any changes to the widget's attributes.
7077 * If you create and keep a #PangoLayout using this context, you must
7078 * deal with changes to the context by calling pango_layout_context_changed()
7079 * on the layout in response to the #GtkWidget::style-set and
7080 * #GtkWidget::direction-changed signals for the widget.
7082 * Return value: (transfer none): the #PangoContext for the widget.
7085 gtk_widget_get_pango_context (GtkWidget *widget)
7087 PangoContext *context;
7089 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7091 context = g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
7094 context = gtk_widget_create_pango_context (GTK_WIDGET (widget));
7095 g_object_set_qdata_full (G_OBJECT (widget),
7096 quark_pango_context,
7105 update_pango_context (GtkWidget *widget,
7106 PangoContext *context)
7108 pango_context_set_font_description (context, widget->style->font_desc);
7109 pango_context_set_base_dir (context,
7110 gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR ?
7111 PANGO_DIRECTION_LTR : PANGO_DIRECTION_RTL);
7115 gtk_widget_update_pango_context (GtkWidget *widget)
7117 PangoContext *context = gtk_widget_peek_pango_context (widget);
7123 update_pango_context (widget, context);
7125 screen = gtk_widget_get_screen_unchecked (widget);
7128 pango_cairo_context_set_resolution (context,
7129 gdk_screen_get_resolution (screen));
7130 pango_cairo_context_set_font_options (context,
7131 gdk_screen_get_font_options (screen));
7137 * gtk_widget_create_pango_context:
7138 * @widget: a #GtkWidget
7140 * Creates a new #PangoContext with the appropriate font map,
7141 * font description, and base direction for drawing text for
7142 * this widget. See also gtk_widget_get_pango_context().
7144 * Return value: the new #PangoContext
7147 gtk_widget_create_pango_context (GtkWidget *widget)
7150 PangoContext *context;
7152 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7154 screen = gtk_widget_get_screen_unchecked (widget);
7157 GTK_NOTE (MULTIHEAD,
7158 g_warning ("gtk_widget_create_pango_context ()) called without screen"));
7160 screen = gdk_screen_get_default ();
7163 context = gdk_pango_context_get_for_screen (screen);
7165 update_pango_context (widget, context);
7166 pango_context_set_language (context, gtk_get_default_language ());
7172 * gtk_widget_create_pango_layout:
7173 * @widget: a #GtkWidget
7174 * @text: text to set on the layout (can be %NULL)
7176 * Creates a new #PangoLayout with the appropriate font map,
7177 * font description, and base direction for drawing text for
7180 * If you keep a #PangoLayout created in this way around, in order to
7181 * notify the layout of changes to the base direction or font of this
7182 * widget, you must call pango_layout_context_changed() in response to
7183 * the #GtkWidget::style-set and #GtkWidget::direction-changed signals
7186 * Return value: the new #PangoLayout
7189 gtk_widget_create_pango_layout (GtkWidget *widget,
7192 PangoLayout *layout;
7193 PangoContext *context;
7195 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7197 context = gtk_widget_get_pango_context (widget);
7198 layout = pango_layout_new (context);
7201 pango_layout_set_text (layout, text, -1);
7207 * gtk_widget_render_icon:
7208 * @widget: a #GtkWidget
7209 * @stock_id: a stock ID
7210 * @size: (type int) a stock size. A size of (GtkIconSize)-1 means
7211 * render at the size of the source and don't scale (if there are
7212 * multiple source sizes, GTK+ picks one of the available sizes).
7213 * @detail: (allow-none): render detail to pass to theme engine
7215 * A convenience function that uses the theme engine and RC file
7216 * settings for @widget to look up @stock_id and render it to
7217 * a pixbuf. @stock_id should be a stock icon ID such as
7218 * #GTK_STOCK_OPEN or #GTK_STOCK_OK. @size should be a size
7219 * such as #GTK_ICON_SIZE_MENU. @detail should be a string that
7220 * identifies the widget or code doing the rendering, so that
7221 * theme engines can special-case rendering for that widget or code.
7223 * The pixels in the returned #GdkPixbuf are shared with the rest of
7224 * the application and should not be modified. The pixbuf should be freed
7225 * after use with g_object_unref().
7227 * Return value: a new pixbuf, or %NULL if the stock ID wasn't known
7230 gtk_widget_render_icon (GtkWidget *widget,
7231 const gchar *stock_id,
7233 const gchar *detail)
7235 GtkIconSet *icon_set;
7238 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7239 g_return_val_if_fail (stock_id != NULL, NULL);
7240 g_return_val_if_fail (size > GTK_ICON_SIZE_INVALID || size == -1, NULL);
7242 gtk_widget_ensure_style (widget);
7244 icon_set = gtk_style_lookup_icon_set (widget->style, stock_id);
7246 if (icon_set == NULL)
7249 retval = gtk_icon_set_render_icon (icon_set,
7251 gtk_widget_get_direction (widget),
7252 GTK_WIDGET_STATE (widget),
7261 * gtk_widget_set_parent_window:
7262 * @widget: a #GtkWidget.
7263 * @parent_window: the new parent window.
7265 * Sets a non default parent window for @widget.
7268 gtk_widget_set_parent_window (GtkWidget *widget,
7269 GdkWindow *parent_window)
7271 GdkWindow *old_parent_window;
7273 g_return_if_fail (GTK_IS_WIDGET (widget));
7275 old_parent_window = g_object_get_qdata (G_OBJECT (widget),
7276 quark_parent_window);
7278 if (parent_window != old_parent_window)
7280 g_object_set_qdata (G_OBJECT (widget), quark_parent_window,
7282 if (old_parent_window)
7283 g_object_unref (old_parent_window);
7285 g_object_ref (parent_window);
7290 * gtk_widget_get_parent_window:
7291 * @widget: a #GtkWidget.
7293 * Gets @widget's parent window.
7295 * Returns: (transfer none): the parent window of @widget.
7298 gtk_widget_get_parent_window (GtkWidget *widget)
7300 GdkWindow *parent_window;
7302 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7304 parent_window = g_object_get_qdata (G_OBJECT (widget), quark_parent_window);
7306 return (parent_window != NULL) ? parent_window :
7307 (widget->parent != NULL) ? widget->parent->window : NULL;
7312 * gtk_widget_set_child_visible:
7313 * @widget: a #GtkWidget
7314 * @is_visible: if %TRUE, @widget should be mapped along with its parent.
7316 * Sets whether @widget should be mapped along with its when its parent
7317 * is mapped and @widget has been shown with gtk_widget_show().
7319 * The child visibility can be set for widget before it is added to
7320 * a container with gtk_widget_set_parent(), to avoid mapping
7321 * children unnecessary before immediately unmapping them. However
7322 * it will be reset to its default state of %TRUE when the widget
7323 * is removed from a container.
7325 * Note that changing the child visibility of a widget does not
7326 * queue a resize on the widget. Most of the time, the size of
7327 * a widget is computed from all visible children, whether or
7328 * not they are mapped. If this is not the case, the container
7329 * can queue a resize itself.
7331 * This function is only useful for container implementations and
7332 * never should be called by an application.
7335 gtk_widget_set_child_visible (GtkWidget *widget,
7336 gboolean is_visible)
7338 g_return_if_fail (GTK_IS_WIDGET (widget));
7339 g_return_if_fail (!gtk_widget_is_toplevel (widget));
7341 g_object_ref (widget);
7344 GTK_PRIVATE_SET_FLAG (widget, GTK_CHILD_VISIBLE);
7347 GtkWidget *toplevel;
7349 GTK_PRIVATE_UNSET_FLAG (widget, GTK_CHILD_VISIBLE);
7351 toplevel = gtk_widget_get_toplevel (widget);
7352 if (toplevel != widget && gtk_widget_is_toplevel (toplevel))
7353 _gtk_window_unset_focus_and_default (GTK_WINDOW (toplevel), widget);
7356 if (widget->parent && GTK_WIDGET_REALIZED (widget->parent))
7358 if (GTK_WIDGET_MAPPED (widget->parent) &&
7359 GTK_WIDGET_CHILD_VISIBLE (widget) &&
7360 GTK_WIDGET_VISIBLE (widget))
7361 gtk_widget_map (widget);
7363 gtk_widget_unmap (widget);
7366 g_object_unref (widget);
7370 * gtk_widget_get_child_visible:
7371 * @widget: a #GtkWidget
7373 * Gets the value set with gtk_widget_set_child_visible().
7374 * If you feel a need to use this function, your code probably
7375 * needs reorganization.
7377 * This function is only useful for container implementations and
7378 * never should be called by an application.
7380 * Return value: %TRUE if the widget is mapped with the parent.
7383 gtk_widget_get_child_visible (GtkWidget *widget)
7385 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7387 return GTK_WIDGET_CHILD_VISIBLE (widget);
7391 gtk_widget_get_screen_unchecked (GtkWidget *widget)
7393 GtkWidget *toplevel;
7395 toplevel = gtk_widget_get_toplevel (widget);
7397 if (gtk_widget_is_toplevel (toplevel))
7399 if (GTK_IS_WINDOW (toplevel))
7400 return GTK_WINDOW (toplevel)->screen;
7401 else if (GTK_IS_INVISIBLE (toplevel))
7402 return GTK_INVISIBLE (widget)->screen;
7409 * gtk_widget_get_screen:
7410 * @widget: a #GtkWidget
7412 * Get the #GdkScreen from the toplevel window associated with
7413 * this widget. This function can only be called after the widget
7414 * has been added to a widget hierarchy with a #GtkWindow
7417 * In general, you should only create screen specific
7418 * resources when a widget has been realized, and you should
7419 * free those resources when the widget is unrealized.
7421 * Return value: (transfer none): the #GdkScreen for the toplevel for this widget.
7426 gtk_widget_get_screen (GtkWidget *widget)
7430 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7432 screen = gtk_widget_get_screen_unchecked (widget);
7439 g_warning (G_STRLOC ": Can't get associated screen"
7440 " for a widget unless it is inside a toplevel GtkWindow\n"
7441 " widget type is %s associated top level type is %s",
7442 g_type_name (G_OBJECT_TYPE(G_OBJECT (widget))),
7443 g_type_name (G_OBJECT_TYPE(G_OBJECT (toplevel))));
7445 return gdk_screen_get_default ();
7450 * gtk_widget_has_screen:
7451 * @widget: a #GtkWidget
7453 * Checks whether there is a #GdkScreen is associated with
7454 * this widget. All toplevel widgets have an associated
7455 * screen, and all widgets added into a hierarchy with a toplevel
7456 * window at the top.
7458 * Return value: %TRUE if there is a #GdkScreen associcated
7464 gtk_widget_has_screen (GtkWidget *widget)
7466 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7468 return (gtk_widget_get_screen_unchecked (widget) != NULL);
7472 * gtk_widget_get_display:
7473 * @widget: a #GtkWidget
7475 * Get the #GdkDisplay for the toplevel window associated with
7476 * this widget. This function can only be called after the widget
7477 * has been added to a widget hierarchy with a #GtkWindow at the top.
7479 * In general, you should only create display specific
7480 * resources when a widget has been realized, and you should
7481 * free those resources when the widget is unrealized.
7483 * Return value: (transfer none): the #GdkDisplay for the toplevel for this widget.
7488 gtk_widget_get_display (GtkWidget *widget)
7490 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7492 return gdk_screen_get_display (gtk_widget_get_screen (widget));
7496 * gtk_widget_get_root_window:
7497 * @widget: a #GtkWidget
7499 * Get the root window where this widget is located. This function can
7500 * only be called after the widget has been added to a widget
7501 * hierarchy with #GtkWindow at the top.
7503 * The root window is useful for such purposes as creating a popup
7504 * #GdkWindow associated with the window. In general, you should only
7505 * create display specific resources when a widget has been realized,
7506 * and you should free those resources when the widget is unrealized.
7508 * Return value: (transfer none): the #GdkWindow root window for the toplevel for this widget.
7513 gtk_widget_get_root_window (GtkWidget *widget)
7515 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7517 return gdk_screen_get_root_window (gtk_widget_get_screen (widget));
7521 * gtk_widget_child_focus:
7522 * @widget: a #GtkWidget
7523 * @direction: direction of focus movement
7525 * This function is used by custom widget implementations; if you're
7526 * writing an app, you'd use gtk_widget_grab_focus() to move the focus
7527 * to a particular widget, and gtk_container_set_focus_chain() to
7528 * change the focus tab order. So you may want to investigate those
7529 * functions instead.
7531 * gtk_widget_child_focus() is called by containers as the user moves
7532 * around the window using keyboard shortcuts. @direction indicates
7533 * what kind of motion is taking place (up, down, left, right, tab
7534 * forward, tab backward). gtk_widget_child_focus() emits the
7535 * #GtkWidget::focus" signal; widgets override the default handler
7536 * for this signal in order to implement appropriate focus behavior.
7538 * The default ::focus handler for a widget should return %TRUE if
7539 * moving in @direction left the focus on a focusable location inside
7540 * that widget, and %FALSE if moving in @direction moved the focus
7541 * outside the widget. If returning %TRUE, widgets normally
7542 * call gtk_widget_grab_focus() to place the focus accordingly;
7543 * if returning %FALSE, they don't modify the current focus location.
7545 * This function replaces gtk_container_focus() from GTK+ 1.2.
7546 * It was necessary to check that the child was visible, sensitive,
7547 * and focusable before calling gtk_container_focus().
7548 * gtk_widget_child_focus() returns %FALSE if the widget is not
7549 * currently in a focusable state, so there's no need for those checks.
7551 * Return value: %TRUE if focus ended up inside @widget
7554 gtk_widget_child_focus (GtkWidget *widget,
7555 GtkDirectionType direction)
7557 gboolean return_val;
7559 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7561 if (!GTK_WIDGET_VISIBLE (widget) ||
7562 !GTK_WIDGET_IS_SENSITIVE (widget))
7565 /* child widgets must set CAN_FOCUS, containers
7566 * don't have to though.
7568 if (!GTK_IS_CONTAINER (widget) &&
7569 !gtk_widget_get_can_focus (widget))
7572 g_signal_emit (widget,
7573 widget_signals[FOCUS],
7575 direction, &return_val);
7581 * gtk_widget_keynav_failed:
7582 * @widget: a #GtkWidget
7583 * @direction: direction of focus movement
7585 * This function should be called whenever keyboard navigation within
7586 * a single widget hits a boundary. The function emits the
7587 * #GtkWidget::keynav-failed signal on the widget and its return
7588 * value should be interpreted in a way similar to the return value of
7589 * gtk_widget_child_focus():
7591 * When %TRUE is returned, stay in the widget, the failed keyboard
7592 * navigation is Ok and/or there is nowhere we can/should move the
7595 * When %FALSE is returned, the caller should continue with keyboard
7596 * navigation outside the widget, e.g. by calling
7597 * gtk_widget_child_focus() on the widget's toplevel.
7599 * The default ::keynav-failed handler returns %TRUE for
7600 * %GTK_DIR_TAB_FORWARD and %GTK_DIR_TAB_BACKWARD. For the other
7601 * values of #GtkDirectionType, it looks at the
7602 * #GtkSettings:gtk-keynav-cursor-only setting and returns %FALSE
7603 * if the setting is %TRUE. This way the entire user interface
7604 * becomes cursor-navigatable on input devices such as mobile phones
7605 * which only have cursor keys but no tab key.
7607 * Whenever the default handler returns %TRUE, it also calls
7608 * gtk_widget_error_bell() to notify the user of the failed keyboard
7611 * A use case for providing an own implementation of ::keynav-failed
7612 * (either by connecting to it or by overriding it) would be a row of
7613 * #GtkEntry widgets where the user should be able to navigate the
7614 * entire row with the cursor keys, as e.g. known from user interfaces
7615 * that require entering license keys.
7617 * Return value: %TRUE if stopping keyboard navigation is fine, %FALSE
7618 * if the emitting widget should try to handle the keyboard
7619 * navigation attempt in its parent container(s).
7624 gtk_widget_keynav_failed (GtkWidget *widget,
7625 GtkDirectionType direction)
7627 gboolean return_val;
7629 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7631 g_signal_emit (widget, widget_signals[KEYNAV_FAILED], 0,
7632 direction, &return_val);
7638 * gtk_widget_error_bell:
7639 * @widget: a #GtkWidget
7641 * Notifies the user about an input-related error on this widget.
7642 * If the #GtkSettings:gtk-error-bell setting is %TRUE, it calls
7643 * gdk_window_beep(), otherwise it does nothing.
7645 * Note that the effect of gdk_window_beep() can be configured in many
7646 * ways, depending on the windowing backend and the desktop environment
7647 * or window manager that is used.
7652 gtk_widget_error_bell (GtkWidget *widget)
7654 GtkSettings* settings;
7657 g_return_if_fail (GTK_IS_WIDGET (widget));
7659 settings = gtk_widget_get_settings (widget);
7663 g_object_get (settings,
7664 "gtk-error-bell", &beep,
7667 if (beep && widget->window)
7668 gdk_window_beep (widget->window);
7672 * gtk_widget_set_uposition:
7673 * @widget: a #GtkWidget
7674 * @x: x position; -1 to unset x; -2 to leave x unchanged
7675 * @y: y position; -1 to unset y; -2 to leave y unchanged
7678 * Sets the position of a widget. The funny "u" in the name comes from
7679 * the "user position" hint specified by the X Window System, and
7680 * exists for legacy reasons. This function doesn't work if a widget
7681 * is inside a container; it's only really useful on #GtkWindow.
7683 * Don't use this function to center dialogs over the main application
7684 * window; most window managers will do the centering on your behalf
7685 * if you call gtk_window_set_transient_for(), and it's really not
7686 * possible to get the centering to work correctly in all cases from
7687 * application code. But if you insist, use gtk_window_set_position()
7688 * to set #GTK_WIN_POS_CENTER_ON_PARENT, don't do the centering
7691 * Note that although @x and @y can be individually unset, the position
7692 * is not honoured unless both @x and @y are set.
7695 gtk_widget_set_uposition (GtkWidget *widget,
7699 /* FIXME this function is the only place that aux_info->x and
7700 * aux_info->y are even used I believe, and this function is
7701 * deprecated. Should be cleaned up.
7703 * (Actually, size_allocate uses them) -Yosh
7706 GtkWidgetAuxInfo *aux_info;
7708 g_return_if_fail (GTK_IS_WIDGET (widget));
7710 aux_info =_gtk_widget_get_aux_info (widget, TRUE);
7715 aux_info->x_set = FALSE;
7718 aux_info->x_set = TRUE;
7726 aux_info->y_set = FALSE;
7729 aux_info->y_set = TRUE;
7734 if (GTK_IS_WINDOW (widget) && aux_info->x_set && aux_info->y_set)
7735 _gtk_window_reposition (GTK_WINDOW (widget), aux_info->x, aux_info->y);
7737 if (GTK_WIDGET_VISIBLE (widget) && widget->parent)
7738 gtk_widget_size_allocate (widget, &widget->allocation);
7742 gtk_widget_set_usize_internal (GtkWidget *widget,
7746 GtkWidgetAuxInfo *aux_info;
7747 gboolean changed = FALSE;
7749 g_object_freeze_notify (G_OBJECT (widget));
7751 aux_info = _gtk_widget_get_aux_info (widget, TRUE);
7753 if (width > -2 && aux_info->width != width)
7755 g_object_notify (G_OBJECT (widget), "width-request");
7756 aux_info->width = width;
7759 if (height > -2 && aux_info->height != height)
7761 g_object_notify (G_OBJECT (widget), "height-request");
7762 aux_info->height = height;
7766 if (GTK_WIDGET_VISIBLE (widget) && changed)
7767 gtk_widget_queue_resize (widget);
7769 g_object_thaw_notify (G_OBJECT (widget));
7773 * gtk_widget_set_usize:
7774 * @widget: a #GtkWidget
7775 * @width: minimum width, or -1 to unset
7776 * @height: minimum height, or -1 to unset
7778 * Sets the minimum size of a widget; that is, the widget's size
7779 * request will be @width by @height. You can use this function to
7780 * force a widget to be either larger or smaller than it is. The
7781 * strange "usize" name dates from the early days of GTK+, and derives
7782 * from X Window System terminology. In many cases,
7783 * gtk_window_set_default_size() is a better choice for toplevel
7784 * windows than this function; setting the default size will still
7785 * allow users to shrink the window. Setting the usize will force them
7786 * to leave the window at least as large as the usize. When dealing
7787 * with window sizes, gtk_window_set_geometry_hints() can be a useful
7790 * Note the inherent danger of setting any fixed size - themes,
7791 * translations into other languages, different fonts, and user action
7792 * can all change the appropriate size for a given widget. So, it's
7793 * basically impossible to hardcode a size that will always be
7796 * Deprecated: 2.2: Use gtk_widget_set_size_request() instead.
7799 gtk_widget_set_usize (GtkWidget *widget,
7803 g_return_if_fail (GTK_IS_WIDGET (widget));
7805 gtk_widget_set_usize_internal (widget, width, height);
7809 * gtk_widget_set_size_request:
7810 * @widget: a #GtkWidget
7811 * @width: width @widget should request, or -1 to unset
7812 * @height: height @widget should request, or -1 to unset
7814 * Sets the minimum size of a widget; that is, the widget's size
7815 * request will be @width by @height. You can use this function to
7816 * force a widget to be either larger or smaller than it normally
7819 * In most cases, gtk_window_set_default_size() is a better choice for
7820 * toplevel windows than this function; setting the default size will
7821 * still allow users to shrink the window. Setting the size request
7822 * will force them to leave the window at least as large as the size
7823 * request. When dealing with window sizes,
7824 * gtk_window_set_geometry_hints() can be a useful function as well.
7826 * Note the inherent danger of setting any fixed size - themes,
7827 * translations into other languages, different fonts, and user action
7828 * can all change the appropriate size for a given widget. So, it's
7829 * basically impossible to hardcode a size that will always be
7832 * The size request of a widget is the smallest size a widget can
7833 * accept while still functioning well and drawing itself correctly.
7834 * However in some strange cases a widget may be allocated less than
7835 * its requested size, and in many cases a widget may be allocated more
7836 * space than it requested.
7838 * If the size request in a given direction is -1 (unset), then
7839 * the "natural" size request of the widget will be used instead.
7841 * Widgets can't actually be allocated a size less than 1 by 1, but
7842 * you can pass 0,0 to this function to mean "as small as possible."
7845 gtk_widget_set_size_request (GtkWidget *widget,
7849 g_return_if_fail (GTK_IS_WIDGET (widget));
7850 g_return_if_fail (width >= -1);
7851 g_return_if_fail (height >= -1);
7858 gtk_widget_set_usize_internal (widget, width, height);
7863 * gtk_widget_get_size_request:
7864 * @widget: a #GtkWidget
7865 * @width: (out): return location for width, or %NULL
7866 * @height: (out): return location for height, or %NULL
7868 * Gets the size request that was explicitly set for the widget using
7869 * gtk_widget_set_size_request(). A value of -1 stored in @width or
7870 * @height indicates that that dimension has not been set explicitly
7871 * and the natural requisition of the widget will be used intead. See
7872 * gtk_widget_set_size_request(). To get the size a widget will
7873 * actually use, call gtk_widget_size_request() instead of
7877 gtk_widget_get_size_request (GtkWidget *widget,
7881 GtkWidgetAuxInfo *aux_info;
7883 g_return_if_fail (GTK_IS_WIDGET (widget));
7885 aux_info = _gtk_widget_get_aux_info (widget, FALSE);
7888 *width = aux_info ? aux_info->width : -1;
7891 *height = aux_info ? aux_info->height : -1;
7895 * gtk_widget_set_events:
7896 * @widget: a #GtkWidget
7897 * @events: event mask
7899 * Sets the event mask (see #GdkEventMask) for a widget. The event
7900 * mask determines which events a widget will receive. Keep in mind
7901 * that different widgets have different default event masks, and by
7902 * changing the event mask you may disrupt a widget's functionality,
7903 * so be careful. This function must be called while a widget is
7904 * unrealized. Consider gtk_widget_add_events() for widgets that are
7905 * already realized, or if you want to preserve the existing event
7906 * mask. This function can't be used with #GTK_NO_WINDOW widgets;
7907 * to get events on those widgets, place them inside a #GtkEventBox
7908 * and receive events on the event box.
7911 gtk_widget_set_events (GtkWidget *widget,
7914 g_return_if_fail (GTK_IS_WIDGET (widget));
7915 g_return_if_fail (!GTK_WIDGET_REALIZED (widget));
7917 g_object_set_qdata (G_OBJECT (widget), quark_event_mask,
7918 GINT_TO_POINTER (events));
7919 g_object_notify (G_OBJECT (widget), "events");
7923 gtk_widget_add_events_internal (GtkWidget *widget,
7929 for (l = window_list; l != NULL; l = l->next)
7931 GdkWindow *window = l->data;
7934 gdk_window_get_user_data (window, &user_data);
7935 if (user_data == widget)
7939 gdk_window_set_events (window, gdk_window_get_events (window) | events);
7941 children = gdk_window_get_children (window);
7942 gtk_widget_add_events_internal (widget, events, children);
7943 g_list_free (children);
7949 * gtk_widget_add_events:
7950 * @widget: a #GtkWidget
7951 * @events: an event mask, see #GdkEventMask
7953 * Adds the events in the bitfield @events to the event mask for
7954 * @widget. See gtk_widget_set_events() for details.
7957 gtk_widget_add_events (GtkWidget *widget,
7962 g_return_if_fail (GTK_IS_WIDGET (widget));
7964 old_events = GPOINTER_TO_INT (g_object_get_qdata (G_OBJECT (widget), quark_event_mask));
7965 g_object_set_qdata (G_OBJECT (widget), quark_event_mask,
7966 GINT_TO_POINTER (old_events | events));
7968 if (GTK_WIDGET_REALIZED (widget))
7972 if (GTK_WIDGET_NO_WINDOW (widget))
7973 window_list = gdk_window_get_children (widget->window);
7975 window_list = g_list_prepend (NULL, widget->window);
7977 gtk_widget_add_events_internal (widget, events, window_list);
7979 g_list_free (window_list);
7982 g_object_notify (G_OBJECT (widget), "events");
7986 * gtk_widget_set_extension_events:
7987 * @widget: a #GtkWidget
7988 * @mode: bitfield of extension events to receive
7990 * Sets the extension events mask to @mode. See #GdkExtensionMode
7991 * and gdk_input_set_extension_events().
7994 gtk_widget_set_extension_events (GtkWidget *widget,
7995 GdkExtensionMode mode)
7997 g_return_if_fail (GTK_IS_WIDGET (widget));
7999 if (GTK_WIDGET_REALIZED (widget))
8000 gtk_widget_set_extension_events_internal (widget, mode, NULL);
8002 g_object_set_qdata (G_OBJECT (widget), quark_extension_event_mode,
8003 GINT_TO_POINTER (mode));
8004 g_object_notify (G_OBJECT (widget), "extension-events");
8008 * gtk_widget_get_toplevel:
8009 * @widget: a #GtkWidget
8011 * This function returns the topmost widget in the container hierarchy
8012 * @widget is a part of. If @widget has no parent widgets, it will be
8013 * returned as the topmost widget. No reference will be added to the
8014 * returned widget; it should not be unreferenced.
8016 * Note the difference in behavior vs. gtk_widget_get_ancestor();
8017 * <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW)</literal>
8019 * %NULL if @widget wasn't inside a toplevel window, and if the
8020 * window was inside a #GtkWindow-derived widget which was in turn
8021 * inside the toplevel #GtkWindow. While the second case may
8022 * seem unlikely, it actually happens when a #GtkPlug is embedded
8023 * inside a #GtkSocket within the same application.
8025 * To reliably find the toplevel #GtkWindow, use
8026 * gtk_widget_get_toplevel() and check if the %TOPLEVEL flags
8027 * is set on the result.
8029 * GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
8030 * if (gtk_widget_is_toplevel (toplevel))
8032 * /* Perform action on toplevel. */
8036 * Return value: (transfer none): the topmost ancestor of @widget, or @widget itself
8037 * if there's no ancestor.
8040 gtk_widget_get_toplevel (GtkWidget *widget)
8042 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8044 while (widget->parent)
8045 widget = widget->parent;
8051 * gtk_widget_get_ancestor:
8052 * @widget: a #GtkWidget
8053 * @widget_type: ancestor type
8055 * Gets the first ancestor of @widget with type @widget_type. For example,
8056 * <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)</literal> gets
8057 * the first #GtkBox that's an ancestor of @widget. No reference will be
8058 * added to the returned widget; it should not be unreferenced. See note
8059 * about checking for a toplevel #GtkWindow in the docs for
8060 * gtk_widget_get_toplevel().
8062 * Note that unlike gtk_widget_is_ancestor(), gtk_widget_get_ancestor()
8063 * considers @widget to be an ancestor of itself.
8065 * Return value: (transfer none): the ancestor widget, or %NULL if not found
8068 gtk_widget_get_ancestor (GtkWidget *widget,
8071 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8073 while (widget && !g_type_is_a (G_OBJECT_TYPE (widget), widget_type))
8074 widget = widget->parent;
8076 if (!(widget && g_type_is_a (G_OBJECT_TYPE (widget), widget_type)))
8083 * gtk_widget_get_colormap:
8084 * @widget: a #GtkWidget
8086 * Gets the colormap that will be used to render @widget. No reference will
8087 * be added to the returned colormap; it should not be unreferenced.
8089 * Return value: (transfer none): the colormap used by @widget
8092 gtk_widget_get_colormap (GtkWidget *widget)
8094 GdkColormap *colormap;
8095 GtkWidget *tmp_widget;
8097 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8101 colormap = gdk_drawable_get_colormap (widget->window);
8102 /* If window was destroyed previously, we'll get NULL here */
8107 tmp_widget = widget;
8110 colormap = g_object_get_qdata (G_OBJECT (tmp_widget), quark_colormap);
8114 tmp_widget= tmp_widget->parent;
8117 return gdk_screen_get_default_colormap (gtk_widget_get_screen (widget));
8121 * gtk_widget_get_visual:
8122 * @widget: a #GtkWidget
8124 * Gets the visual that will be used to render @widget.
8126 * Return value: (transfer none): the visual for @widget
8129 gtk_widget_get_visual (GtkWidget *widget)
8131 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8133 return gdk_colormap_get_visual (gtk_widget_get_colormap (widget));
8137 * gtk_widget_get_settings:
8138 * @widget: a #GtkWidget
8140 * Gets the settings object holding the settings (global property
8141 * settings, RC file information, etc) used for this widget.
8143 * Note that this function can only be called when the #GtkWidget
8144 * is attached to a toplevel, since the settings object is specific
8145 * to a particular #GdkScreen.
8147 * Return value: (transfer none): the relevant #GtkSettings object
8150 gtk_widget_get_settings (GtkWidget *widget)
8152 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8154 return gtk_settings_get_for_screen (gtk_widget_get_screen (widget));
8158 * gtk_widget_set_colormap:
8159 * @widget: a #GtkWidget
8160 * @colormap: a colormap
8162 * Sets the colormap for the widget to the given value. Widget must not
8163 * have been previously realized. This probably should only be used
8164 * from an <function>init()</function> function (i.e. from the constructor
8168 gtk_widget_set_colormap (GtkWidget *widget,
8169 GdkColormap *colormap)
8171 g_return_if_fail (GTK_IS_WIDGET (widget));
8172 g_return_if_fail (!GTK_WIDGET_REALIZED (widget));
8173 g_return_if_fail (GDK_IS_COLORMAP (colormap));
8175 g_object_ref (colormap);
8177 g_object_set_qdata_full (G_OBJECT (widget),
8184 * gtk_widget_get_events:
8185 * @widget: a #GtkWidget
8187 * Returns the event mask for the widget (a bitfield containing flags
8188 * from the #GdkEventMask enumeration). These are the events that the widget
8191 * Return value: event mask for @widget
8194 gtk_widget_get_events (GtkWidget *widget)
8196 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
8198 return GPOINTER_TO_INT (g_object_get_qdata (G_OBJECT (widget), quark_event_mask));
8202 * gtk_widget_get_extension_events:
8203 * @widget: a #GtkWidget
8205 * Retrieves the extension events the widget will receive; see
8206 * gdk_input_set_extension_events().
8208 * Return value: extension events for @widget
8211 gtk_widget_get_extension_events (GtkWidget *widget)
8213 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
8215 return GPOINTER_TO_INT (g_object_get_qdata (G_OBJECT (widget), quark_extension_event_mode));
8219 * gtk_widget_get_pointer:
8220 * @widget: a #GtkWidget
8221 * @x: (out) (allow-none): return location for the X coordinate, or %NULL
8222 * @y: (out) (allow-none): return location for the Y coordinate, or %NULL
8224 * Obtains the location of the mouse pointer in widget coordinates.
8225 * Widget coordinates are a bit odd; for historical reasons, they are
8226 * defined as @widget->window coordinates for widgets that are not
8227 * #GTK_NO_WINDOW widgets, and are relative to @widget->allocation.x,
8228 * @widget->allocation.y for widgets that are #GTK_NO_WINDOW widgets.
8231 gtk_widget_get_pointer (GtkWidget *widget,
8235 g_return_if_fail (GTK_IS_WIDGET (widget));
8242 if (GTK_WIDGET_REALIZED (widget))
8244 gdk_window_get_pointer (widget->window, x, y, NULL);
8246 if (GTK_WIDGET_NO_WINDOW (widget))
8249 *x -= widget->allocation.x;
8251 *y -= widget->allocation.y;
8257 * gtk_widget_is_ancestor:
8258 * @widget: a #GtkWidget
8259 * @ancestor: another #GtkWidget
8261 * Determines whether @widget is somewhere inside @ancestor, possibly with
8262 * intermediate containers.
8264 * Return value: %TRUE if @ancestor contains @widget as a child,
8265 * grandchild, great grandchild, etc.
8268 gtk_widget_is_ancestor (GtkWidget *widget,
8269 GtkWidget *ancestor)
8271 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
8272 g_return_val_if_fail (ancestor != NULL, FALSE);
8276 if (widget->parent == ancestor)
8278 widget = widget->parent;
8284 static GQuark quark_composite_name = 0;
8287 * gtk_widget_set_composite_name:
8288 * @widget: a #GtkWidget.
8289 * @name: the name to set
8291 * Sets a widgets composite name. The widget must be
8292 * a composite child of its parent; see gtk_widget_push_composite_child().
8295 gtk_widget_set_composite_name (GtkWidget *widget,
8298 g_return_if_fail (GTK_IS_WIDGET (widget));
8299 g_return_if_fail ((GTK_WIDGET_FLAGS (widget) & GTK_COMPOSITE_CHILD) != 0);
8300 g_return_if_fail (name != NULL);
8302 if (!quark_composite_name)
8303 quark_composite_name = g_quark_from_static_string ("gtk-composite-name");
8305 g_object_set_qdata_full (G_OBJECT (widget),
8306 quark_composite_name,
8312 * gtk_widget_get_composite_name:
8313 * @widget: a #GtkWidget
8315 * Obtains the composite name of a widget.
8317 * Returns: the composite name of @widget, or %NULL if @widget is not
8318 * a composite child. The string should be freed when it is no
8322 gtk_widget_get_composite_name (GtkWidget *widget)
8324 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8326 if (((GTK_WIDGET_FLAGS (widget) & GTK_COMPOSITE_CHILD) != 0) && widget->parent)
8327 return _gtk_container_child_composite_name (GTK_CONTAINER (widget->parent),
8334 * gtk_widget_push_composite_child:
8336 * Makes all newly-created widgets as composite children until
8337 * the corresponding gtk_widget_pop_composite_child() call.
8339 * A composite child is a child that's an implementation detail of the
8340 * container it's inside and should not be visible to people using the
8341 * container. Composite children aren't treated differently by GTK (but
8342 * see gtk_container_foreach() vs. gtk_container_forall()), but e.g. GUI
8343 * builders might want to treat them in a different way.
8345 * Here is a simple example:
8347 * gtk_widget_push_composite_child ();
8348 * scrolled_window->hscrollbar = gtk_hscrollbar_new (hadjustment);
8349 * gtk_widget_set_composite_name (scrolled_window->hscrollbar, "hscrollbar");
8350 * gtk_widget_pop_composite_child ();
8351 * gtk_widget_set_parent (scrolled_window->hscrollbar,
8352 * GTK_WIDGET (scrolled_window));
8353 * g_object_ref (scrolled_window->hscrollbar);
8357 gtk_widget_push_composite_child (void)
8359 composite_child_stack++;
8363 * gtk_widget_pop_composite_child:
8365 * Cancels the effect of a previous call to gtk_widget_push_composite_child().
8368 gtk_widget_pop_composite_child (void)
8370 if (composite_child_stack)
8371 composite_child_stack--;
8375 * gtk_widget_push_colormap:
8376 * @cmap: a #GdkColormap
8378 * Pushes @cmap onto a global stack of colormaps; the topmost
8379 * colormap on the stack will be used to create all widgets.
8380 * Remove @cmap with gtk_widget_pop_colormap(). There's little
8381 * reason to use this function.
8384 gtk_widget_push_colormap (GdkColormap *cmap)
8386 g_return_if_fail (!cmap || GDK_IS_COLORMAP (cmap));
8388 colormap_stack = g_slist_prepend (colormap_stack, cmap);
8392 * gtk_widget_pop_colormap:
8394 * Removes a colormap pushed with gtk_widget_push_colormap().
8397 gtk_widget_pop_colormap (void)
8400 colormap_stack = g_slist_delete_link (colormap_stack, colormap_stack);
8404 * gtk_widget_set_default_colormap:
8405 * @colormap: a #GdkColormap
8407 * Sets the default colormap to use when creating widgets.
8408 * gtk_widget_push_colormap() is a better function to use if
8409 * you only want to affect a few widgets, rather than all widgets.
8412 gtk_widget_set_default_colormap (GdkColormap *colormap)
8414 g_return_if_fail (GDK_IS_COLORMAP (colormap));
8416 gdk_screen_set_default_colormap (gdk_colormap_get_screen (colormap),
8421 * gtk_widget_get_default_colormap:
8423 * Obtains the default colormap used to create widgets.
8425 * Return value: (transfer none): default widget colormap
8428 gtk_widget_get_default_colormap (void)
8430 return gdk_screen_get_default_colormap (gdk_screen_get_default ());
8434 * gtk_widget_get_default_visual:
8436 * Obtains the visual of the default colormap. Not really useful;
8437 * used to be useful before gdk_colormap_get_visual() existed.
8439 * Return value: (transfer none): visual of the default colormap
8442 gtk_widget_get_default_visual (void)
8444 return gdk_colormap_get_visual (gtk_widget_get_default_colormap ());
8448 gtk_widget_emit_direction_changed (GtkWidget *widget,
8449 GtkTextDirection old_dir)
8451 gtk_widget_update_pango_context (widget);
8453 g_signal_emit (widget, widget_signals[DIRECTION_CHANGED], 0, old_dir);
8457 * gtk_widget_set_direction:
8458 * @widget: a #GtkWidget
8459 * @dir: the new direction
8461 * Sets the reading direction on a particular widget. This direction
8462 * controls the primary direction for widgets containing text,
8463 * and also the direction in which the children of a container are
8464 * packed. The ability to set the direction is present in order
8465 * so that correct localization into languages with right-to-left
8466 * reading directions can be done. Generally, applications will
8467 * let the default reading direction present, except for containers
8468 * where the containers are arranged in an order that is explicitely
8469 * visual rather than logical (such as buttons for text justification).
8471 * If the direction is set to %GTK_TEXT_DIR_NONE, then the value
8472 * set by gtk_widget_set_default_direction() will be used.
8475 gtk_widget_set_direction (GtkWidget *widget,
8476 GtkTextDirection dir)
8478 GtkTextDirection old_dir;
8480 g_return_if_fail (GTK_IS_WIDGET (widget));
8481 g_return_if_fail (dir >= GTK_TEXT_DIR_NONE && dir <= GTK_TEXT_DIR_RTL);
8483 old_dir = gtk_widget_get_direction (widget);
8485 if (dir == GTK_TEXT_DIR_NONE)
8486 GTK_PRIVATE_UNSET_FLAG (widget, GTK_DIRECTION_SET);
8489 GTK_PRIVATE_SET_FLAG (widget, GTK_DIRECTION_SET);
8490 if (dir == GTK_TEXT_DIR_LTR)
8491 GTK_PRIVATE_SET_FLAG (widget, GTK_DIRECTION_LTR);
8493 GTK_PRIVATE_UNSET_FLAG (widget, GTK_DIRECTION_LTR);
8496 if (old_dir != gtk_widget_get_direction (widget))
8497 gtk_widget_emit_direction_changed (widget, old_dir);
8501 * gtk_widget_get_direction:
8502 * @widget: a #GtkWidget
8504 * Gets the reading direction for a particular widget. See
8505 * gtk_widget_set_direction().
8507 * Return value: the reading direction for the widget.
8510 gtk_widget_get_direction (GtkWidget *widget)
8512 g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_TEXT_DIR_LTR);
8514 if (GTK_WIDGET_DIRECTION_SET (widget))
8515 return GTK_WIDGET_DIRECTION_LTR (widget) ? GTK_TEXT_DIR_LTR : GTK_TEXT_DIR_RTL;
8517 return gtk_default_direction;
8521 gtk_widget_set_default_direction_recurse (GtkWidget *widget, gpointer data)
8523 GtkTextDirection old_dir = GPOINTER_TO_UINT (data);
8525 g_object_ref (widget);
8527 if (!GTK_WIDGET_DIRECTION_SET (widget))
8528 gtk_widget_emit_direction_changed (widget, old_dir);
8530 if (GTK_IS_CONTAINER (widget))
8531 gtk_container_forall (GTK_CONTAINER (widget),
8532 gtk_widget_set_default_direction_recurse,
8535 g_object_unref (widget);
8539 * gtk_widget_set_default_direction:
8540 * @dir: the new default direction. This cannot be
8541 * %GTK_TEXT_DIR_NONE.
8543 * Sets the default reading direction for widgets where the
8544 * direction has not been explicitly set by gtk_widget_set_direction().
8547 gtk_widget_set_default_direction (GtkTextDirection dir)
8549 g_return_if_fail (dir == GTK_TEXT_DIR_RTL || dir == GTK_TEXT_DIR_LTR);
8551 if (dir != gtk_default_direction)
8553 GList *toplevels, *tmp_list;
8554 GtkTextDirection old_dir = gtk_default_direction;
8556 gtk_default_direction = dir;
8558 tmp_list = toplevels = gtk_window_list_toplevels ();
8559 g_list_foreach (toplevels, (GFunc)g_object_ref, NULL);
8563 gtk_widget_set_default_direction_recurse (tmp_list->data,
8564 GUINT_TO_POINTER (old_dir));
8565 g_object_unref (tmp_list->data);
8566 tmp_list = tmp_list->next;
8569 g_list_free (toplevels);
8574 * gtk_widget_get_default_direction:
8576 * Obtains the current default reading direction. See
8577 * gtk_widget_set_default_direction().
8579 * Return value: the current default direction.
8582 gtk_widget_get_default_direction (void)
8584 return gtk_default_direction;
8588 gtk_widget_dispose (GObject *object)
8590 GtkWidget *widget = GTK_WIDGET (object);
8593 gtk_container_remove (GTK_CONTAINER (widget->parent), widget);
8594 else if (GTK_WIDGET_VISIBLE (widget))
8595 gtk_widget_hide (widget);
8597 GTK_WIDGET_UNSET_FLAGS (widget, GTK_VISIBLE);
8598 if (GTK_WIDGET_REALIZED (widget))
8599 gtk_widget_unrealize (widget);
8601 G_OBJECT_CLASS (gtk_widget_parent_class)->dispose (object);
8605 gtk_widget_real_destroy (GtkObject *object)
8607 /* gtk_object_destroy() will already hold a refcount on object */
8608 GtkWidget *widget = GTK_WIDGET (object);
8610 /* wipe accelerator closures (keep order) */
8611 g_object_set_qdata (G_OBJECT (widget), quark_accel_path, NULL);
8612 g_object_set_qdata (G_OBJECT (widget), quark_accel_closures, NULL);
8614 /* Callers of add_mnemonic_label() should disconnect on ::destroy */
8615 g_object_set_qdata (G_OBJECT (widget), quark_mnemonic_labels, NULL);
8617 gtk_grab_remove (widget);
8619 g_object_unref (widget->style);
8620 widget->style = gtk_widget_get_default_style ();
8621 g_object_ref (widget->style);
8623 GTK_OBJECT_CLASS (gtk_widget_parent_class)->destroy (object);
8627 gtk_widget_finalize (GObject *object)
8629 GtkWidget *widget = GTK_WIDGET (object);
8630 GtkWidgetAuxInfo *aux_info;
8631 GtkAccessible *accessible;
8633 gtk_grab_remove (widget);
8635 g_object_unref (widget->style);
8636 widget->style = NULL;
8638 g_free (widget->name);
8640 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
8642 gtk_widget_aux_info_destroy (aux_info);
8644 accessible = g_object_get_qdata (G_OBJECT (widget), quark_accessible_object);
8646 g_object_unref (accessible);
8648 G_OBJECT_CLASS (gtk_widget_parent_class)->finalize (object);
8651 /*****************************************
8652 * gtk_widget_real_map:
8657 *****************************************/
8660 gtk_widget_real_map (GtkWidget *widget)
8662 g_assert (GTK_WIDGET_REALIZED (widget));
8664 if (!GTK_WIDGET_MAPPED (widget))
8666 GTK_WIDGET_SET_FLAGS (widget, GTK_MAPPED);
8668 if (!GTK_WIDGET_NO_WINDOW (widget))
8669 gdk_window_show (widget->window);
8673 /*****************************************
8674 * gtk_widget_real_unmap:
8679 *****************************************/
8682 gtk_widget_real_unmap (GtkWidget *widget)
8684 if (GTK_WIDGET_MAPPED (widget))
8686 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
8688 if (!GTK_WIDGET_NO_WINDOW (widget))
8689 gdk_window_hide (widget->window);
8693 /*****************************************
8694 * gtk_widget_real_realize:
8699 *****************************************/
8702 gtk_widget_real_realize (GtkWidget *widget)
8704 g_assert (GTK_WIDGET_NO_WINDOW (widget));
8706 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
8709 widget->window = gtk_widget_get_parent_window (widget);
8710 g_object_ref (widget->window);
8712 widget->style = gtk_style_attach (widget->style, widget->window);
8715 /*****************************************
8716 * gtk_widget_real_unrealize:
8721 *****************************************/
8724 gtk_widget_real_unrealize (GtkWidget *widget)
8726 if (GTK_WIDGET_MAPPED (widget))
8727 gtk_widget_real_unmap (widget);
8729 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
8731 /* printf ("unrealizing %s\n", g_type_name (G_TYPE_FROM_INSTANCE (widget)));
8734 /* We must do unrealize child widget BEFORE container widget.
8735 * gdk_window_destroy() destroys specified xwindow and its sub-xwindows.
8736 * So, unrealizing container widget bofore its children causes the problem
8737 * (for example, gdk_ic_destroy () with destroyed window causes crash. )
8740 if (GTK_IS_CONTAINER (widget))
8741 gtk_container_forall (GTK_CONTAINER (widget),
8742 (GtkCallback) gtk_widget_unrealize,
8745 gtk_style_detach (widget->style);
8746 if (!GTK_WIDGET_NO_WINDOW (widget))
8748 gdk_window_set_user_data (widget->window, NULL);
8749 gdk_window_destroy (widget->window);
8750 widget->window = NULL;
8754 g_object_unref (widget->window);
8755 widget->window = NULL;
8758 gtk_selection_remove_all (widget);
8760 GTK_WIDGET_UNSET_FLAGS (widget, GTK_REALIZED);
8764 gtk_widget_real_size_request (GtkWidget *widget,
8765 GtkRequisition *requisition)
8767 requisition->width = widget->requisition.width;
8768 requisition->height = widget->requisition.height;
8772 * _gtk_widget_peek_colormap:
8774 * Returns colormap currently pushed by gtk_widget_push_colormap, if any.
8776 * Return value: the currently pushed colormap, or %NULL if there is none.
8779 _gtk_widget_peek_colormap (void)
8782 return (GdkColormap*) colormap_stack->data;
8787 * _gtk_widget_set_pointer_window:
8788 * @widget: a #GtkWidget.
8789 * @pointer_window: the new pointer window.
8791 * Sets pointer window for @widget. Does not ref @pointer_window.
8792 * Actually stores it on the #GdkScreen, but you don't need to know that.
8795 _gtk_widget_set_pointer_window (GtkWidget *widget,
8796 GdkWindow *pointer_window)
8798 g_return_if_fail (GTK_IS_WIDGET (widget));
8800 if (GTK_WIDGET_REALIZED (widget))
8802 GdkScreen *screen = gdk_drawable_get_screen (widget->window);
8804 g_object_set_qdata (G_OBJECT (screen), quark_pointer_window,
8810 * _gtk_widget_get_pointer_window:
8811 * @widget: a #GtkWidget.
8813 * Return value: the pointer window set on the #GdkScreen @widget is attached
8817 _gtk_widget_get_pointer_window (GtkWidget *widget)
8819 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8821 if (GTK_WIDGET_REALIZED (widget))
8823 GdkScreen *screen = gdk_drawable_get_screen (widget->window);
8825 return g_object_get_qdata (G_OBJECT (screen), quark_pointer_window);
8832 synth_crossing (GtkWidget *widget,
8835 GdkCrossingMode mode,
8836 GdkNotifyType detail)
8840 event = gdk_event_new (type);
8842 event->crossing.window = g_object_ref (window);
8843 event->crossing.send_event = TRUE;
8844 event->crossing.subwindow = g_object_ref (window);
8845 event->crossing.time = GDK_CURRENT_TIME;
8846 event->crossing.x = event->crossing.y = 0;
8847 event->crossing.x_root = event->crossing.y_root = 0;
8848 event->crossing.mode = mode;
8849 event->crossing.detail = detail;
8850 event->crossing.focus = FALSE;
8851 event->crossing.state = 0;
8854 widget = gtk_get_event_widget (event);
8857 gtk_widget_event_internal (widget, event);
8859 gdk_event_free (event);
8863 * _gtk_widget_is_pointer_widget:
8864 * @widget: a #GtkWidget
8866 * Returns %TRUE if the pointer window belongs to @widget.
8869 _gtk_widget_is_pointer_widget (GtkWidget *widget)
8871 if (GTK_WIDGET_HAS_POINTER (widget))
8876 win = _gtk_widget_get_pointer_window (widget);
8879 gdk_window_get_user_data (win, (gpointer *)&wid);
8889 * _gtk_widget_synthesize_crossing:
8890 * @from: the #GtkWidget the virtual pointer is leaving.
8891 * @to: the #GtkWidget the virtual pointer is moving to.
8892 * @mode: the #GdkCrossingMode to place on the synthesized events.
8894 * Generate crossing event(s) on widget state (sensitivity) or GTK+ grab change.
8896 * The real pointer window is the window that most recently received an enter notify
8897 * event. Windows that don't select for crossing events can't become the real
8898 * poiner window. The real pointer widget that owns the real pointer window. The
8899 * effective pointer window is the same as the real pointer window unless the real
8900 * pointer widget is either insensitive or there is a grab on a widget that is not
8901 * an ancestor of the real pointer widget (in which case the effective pointer
8902 * window should be the root window).
8904 * When the effective pointer window is the same as the real poiner window, we
8905 * receive crossing events from the windowing system. When the effective pointer
8906 * window changes to become different from the real pointer window we synthesize
8907 * crossing events, attempting to follow X protocol rules:
8909 * When the root window becomes the effective pointer window:
8910 * - leave notify on real pointer window, detail Ancestor
8911 * - leave notify on all of its ancestors, detail Virtual
8912 * - enter notify on root window, detail Inferior
8914 * When the root window ceases to be the effective pointer window:
8915 * - leave notify on root window, detail Inferior
8916 * - enter notify on all ancestors of real pointer window, detail Virtual
8917 * - enter notify on real pointer window, detail Ancestor
8920 _gtk_widget_synthesize_crossing (GtkWidget *from,
8922 GdkCrossingMode mode)
8924 GdkWindow *from_window = NULL, *to_window = NULL;
8926 g_return_if_fail (from != NULL || to != NULL);
8929 from_window = GTK_WIDGET_HAS_POINTER (from)
8930 ? _gtk_widget_get_pointer_window (from) : from->window;
8932 to_window = GTK_WIDGET_HAS_POINTER (to)
8933 ? _gtk_widget_get_pointer_window (to) : to->window;
8935 if (from_window == NULL && to_window == NULL)
8937 else if (from_window != NULL && to_window == NULL)
8939 GList *from_ancestors = NULL, *list;
8940 GdkWindow *from_ancestor = from_window;
8942 while (from_ancestor != NULL)
8944 from_ancestor = gdk_window_get_parent (from_ancestor);
8945 if (from_ancestor == NULL)
8947 from_ancestors = g_list_prepend (from_ancestors, from_ancestor);
8950 synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
8951 mode, GDK_NOTIFY_ANCESTOR);
8952 for (list = g_list_last (from_ancestors); list; list = list->prev)
8954 synth_crossing (NULL, GDK_LEAVE_NOTIFY, (GdkWindow *) list->data,
8955 mode, GDK_NOTIFY_VIRTUAL);
8958 /* XXX: enter/inferior on root window? */
8960 g_list_free (from_ancestors);
8962 else if (from_window == NULL && to_window != NULL)
8964 GList *to_ancestors = NULL, *list;
8965 GdkWindow *to_ancestor = to_window;
8967 while (to_ancestor != NULL)
8969 to_ancestor = gdk_window_get_parent (to_ancestor);
8970 if (to_ancestor == NULL)
8972 to_ancestors = g_list_prepend (to_ancestors, to_ancestor);
8975 /* XXX: leave/inferior on root window? */
8977 for (list = to_ancestors; list; list = list->next)
8979 synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
8980 mode, GDK_NOTIFY_VIRTUAL);
8982 synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
8983 mode, GDK_NOTIFY_ANCESTOR);
8985 g_list_free (to_ancestors);
8987 else if (from_window == to_window)
8991 GList *from_ancestors = NULL, *to_ancestors = NULL, *list;
8992 GdkWindow *from_ancestor = from_window, *to_ancestor = to_window;
8994 while (from_ancestor != NULL || to_ancestor != NULL)
8996 if (from_ancestor != NULL)
8998 from_ancestor = gdk_window_get_parent (from_ancestor);
8999 if (from_ancestor == to_window)
9002 from_ancestors = g_list_prepend (from_ancestors, from_ancestor);
9004 if (to_ancestor != NULL)
9006 to_ancestor = gdk_window_get_parent (to_ancestor);
9007 if (to_ancestor == from_window)
9010 to_ancestors = g_list_prepend (to_ancestors, to_ancestor);
9013 if (to_ancestor == from_window)
9015 if (mode != GDK_CROSSING_GTK_UNGRAB)
9016 synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
9017 mode, GDK_NOTIFY_INFERIOR);
9018 for (list = to_ancestors; list; list = list->next)
9019 synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
9020 mode, GDK_NOTIFY_VIRTUAL);
9021 synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
9022 mode, GDK_NOTIFY_ANCESTOR);
9024 else if (from_ancestor == to_window)
9026 synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
9027 mode, GDK_NOTIFY_ANCESTOR);
9028 for (list = g_list_last (from_ancestors); list; list = list->prev)
9030 synth_crossing (NULL, GDK_LEAVE_NOTIFY, (GdkWindow *) list->data,
9031 mode, GDK_NOTIFY_VIRTUAL);
9033 if (mode != GDK_CROSSING_GTK_GRAB)
9034 synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
9035 mode, GDK_NOTIFY_INFERIOR);
9039 while (from_ancestors != NULL && to_ancestors != NULL
9040 && from_ancestors->data == to_ancestors->data)
9042 from_ancestors = g_list_delete_link (from_ancestors,
9044 to_ancestors = g_list_delete_link (to_ancestors, to_ancestors);
9047 synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
9048 mode, GDK_NOTIFY_NONLINEAR);
9050 for (list = g_list_last (from_ancestors); list; list = list->prev)
9052 synth_crossing (NULL, GDK_LEAVE_NOTIFY, (GdkWindow *) list->data,
9053 mode, GDK_NOTIFY_NONLINEAR_VIRTUAL);
9055 for (list = to_ancestors; list; list = list->next)
9057 synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
9058 mode, GDK_NOTIFY_NONLINEAR_VIRTUAL);
9060 synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
9061 mode, GDK_NOTIFY_NONLINEAR);
9063 g_list_free (from_ancestors);
9064 g_list_free (to_ancestors);
9069 gtk_widget_propagate_state (GtkWidget *widget,
9072 guint8 old_state = GTK_WIDGET_STATE (widget);
9073 guint8 old_saved_state = widget->saved_state;
9075 /* don't call this function with state==GTK_STATE_INSENSITIVE,
9076 * parent_sensitive==TRUE on a sensitive widget
9080 if (data->parent_sensitive)
9081 GTK_WIDGET_SET_FLAGS (widget, GTK_PARENT_SENSITIVE);
9083 GTK_WIDGET_UNSET_FLAGS (widget, GTK_PARENT_SENSITIVE);
9085 if (GTK_WIDGET_IS_SENSITIVE (widget))
9087 if (data->state_restoration)
9088 GTK_WIDGET_STATE (widget) = widget->saved_state;
9090 GTK_WIDGET_STATE (widget) = data->state;
9094 if (!data->state_restoration)
9096 if (data->state != GTK_STATE_INSENSITIVE)
9097 widget->saved_state = data->state;
9099 else if (GTK_WIDGET_STATE (widget) != GTK_STATE_INSENSITIVE)
9100 widget->saved_state = GTK_WIDGET_STATE (widget);
9101 GTK_WIDGET_STATE (widget) = GTK_STATE_INSENSITIVE;
9104 if (gtk_widget_is_focus (widget) && !GTK_WIDGET_IS_SENSITIVE (widget))
9108 window = gtk_widget_get_toplevel (widget);
9109 if (window && gtk_widget_is_toplevel (window))
9110 gtk_window_set_focus (GTK_WINDOW (window), NULL);
9113 if (old_state != GTK_WIDGET_STATE (widget) ||
9114 old_saved_state != widget->saved_state)
9116 g_object_ref (widget);
9118 if (!GTK_WIDGET_IS_SENSITIVE (widget) && gtk_widget_has_grab (widget))
9119 gtk_grab_remove (widget);
9121 g_signal_emit (widget, widget_signals[STATE_CHANGED], 0, old_state);
9123 if (GTK_WIDGET_HAS_POINTER (widget) && !GTK_WIDGET_SHADOWED (widget))
9125 if (!GTK_WIDGET_IS_SENSITIVE (widget))
9126 _gtk_widget_synthesize_crossing (widget, NULL,
9127 GDK_CROSSING_STATE_CHANGED);
9128 else if (old_state == GTK_STATE_INSENSITIVE)
9129 _gtk_widget_synthesize_crossing (NULL, widget,
9130 GDK_CROSSING_STATE_CHANGED);
9133 if (GTK_IS_CONTAINER (widget))
9135 data->parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget) != FALSE);
9136 if (data->use_forall)
9137 gtk_container_forall (GTK_CONTAINER (widget),
9138 (GtkCallback) gtk_widget_propagate_state,
9141 gtk_container_foreach (GTK_CONTAINER (widget),
9142 (GtkCallback) gtk_widget_propagate_state,
9145 g_object_unref (widget);
9150 * _gtk_widget_get_aux_info:
9151 * @widget: a #GtkWidget
9152 * @create: if %TRUE, create the structure if it doesn't exist
9154 * Get the #GtkWidgetAuxInfo structure for the widget.
9156 * Return value: the #GtkAuxInfo structure for the widget, or
9157 * %NULL if @create is %FALSE and one doesn't already exist.
9160 _gtk_widget_get_aux_info (GtkWidget *widget,
9163 GtkWidgetAuxInfo *aux_info;
9165 aux_info = g_object_get_qdata (G_OBJECT (widget), quark_aux_info);
9166 if (!aux_info && create)
9168 aux_info = g_slice_new (GtkWidgetAuxInfo);
9170 aux_info->width = -1;
9171 aux_info->height = -1;
9174 aux_info->x_set = FALSE;
9175 aux_info->y_set = FALSE;
9176 g_object_set_qdata (G_OBJECT (widget), quark_aux_info, aux_info);
9182 /*****************************************
9183 * gtk_widget_aux_info_destroy:
9188 *****************************************/
9191 gtk_widget_aux_info_destroy (GtkWidgetAuxInfo *aux_info)
9193 g_slice_free (GtkWidgetAuxInfo, aux_info);
9197 gtk_widget_shape_info_destroy (GtkWidgetShapeInfo *info)
9199 g_object_unref (info->shape_mask);
9200 g_slice_free (GtkWidgetShapeInfo, info);
9204 * gtk_widget_shape_combine_mask:
9205 * @widget: a #GtkWidget
9206 * @shape_mask: shape to be added, or %NULL to remove an existing shape
9207 * @offset_x: X position of shape mask with respect to @window
9208 * @offset_y: Y position of shape mask with respect to @window
9210 * Sets a shape for this widget's GDK window. This allows for
9211 * transparent windows etc., see gdk_window_shape_combine_mask()
9212 * for more information.
9215 gtk_widget_shape_combine_mask (GtkWidget *widget,
9216 GdkBitmap *shape_mask,
9220 GtkWidgetShapeInfo* shape_info;
9222 g_return_if_fail (GTK_IS_WIDGET (widget));
9223 /* set_shape doesn't work on widgets without gdk window */
9224 g_return_if_fail (!GTK_WIDGET_NO_WINDOW (widget));
9228 GTK_PRIVATE_UNSET_FLAG (widget, GTK_HAS_SHAPE_MASK);
9231 gdk_window_shape_combine_mask (widget->window, NULL, 0, 0);
9233 g_object_set_qdata (G_OBJECT (widget), quark_shape_info, NULL);
9237 GTK_PRIVATE_SET_FLAG (widget, GTK_HAS_SHAPE_MASK);
9239 shape_info = g_slice_new (GtkWidgetShapeInfo);
9240 g_object_set_qdata_full (G_OBJECT (widget), quark_shape_info, shape_info,
9241 (GDestroyNotify) gtk_widget_shape_info_destroy);
9243 shape_info->shape_mask = g_object_ref (shape_mask);
9244 shape_info->offset_x = offset_x;
9245 shape_info->offset_y = offset_y;
9247 /* set shape if widget has a gdk window already.
9248 * otherwise the shape is scheduled to be set by gtk_widget_realize().
9251 gdk_window_shape_combine_mask (widget->window, shape_mask,
9252 offset_x, offset_y);
9257 * gtk_widget_input_shape_combine_mask:
9258 * @widget: a #GtkWidget
9259 * @shape_mask: (allow-none): shape to be added, or %NULL to remove an existing shape
9260 * @offset_x: X position of shape mask with respect to @window
9261 * @offset_y: Y position of shape mask with respect to @window
9263 * Sets an input shape for this widget's GDK window. This allows for
9264 * windows which react to mouse click in a nonrectangular region, see
9265 * gdk_window_input_shape_combine_mask() for more information.
9270 gtk_widget_input_shape_combine_mask (GtkWidget *widget,
9271 GdkBitmap *shape_mask,
9275 GtkWidgetShapeInfo* shape_info;
9277 g_return_if_fail (GTK_IS_WIDGET (widget));
9278 /* set_shape doesn't work on widgets without gdk window */
9279 g_return_if_fail (!GTK_WIDGET_NO_WINDOW (widget));
9284 gdk_window_input_shape_combine_mask (widget->window, NULL, 0, 0);
9286 g_object_set_qdata (G_OBJECT (widget), quark_input_shape_info, NULL);
9290 shape_info = g_slice_new (GtkWidgetShapeInfo);
9291 g_object_set_qdata_full (G_OBJECT (widget), quark_input_shape_info,
9293 (GDestroyNotify) gtk_widget_shape_info_destroy);
9295 shape_info->shape_mask = g_object_ref (shape_mask);
9296 shape_info->offset_x = offset_x;
9297 shape_info->offset_y = offset_y;
9299 /* set shape if widget has a gdk window already.
9300 * otherwise the shape is scheduled to be set by gtk_widget_realize().
9303 gdk_window_input_shape_combine_mask (widget->window, shape_mask,
9304 offset_x, offset_y);
9310 gtk_reset_shapes_recurse (GtkWidget *widget,
9316 gdk_window_get_user_data (window, &data);
9320 gdk_window_shape_combine_mask (window, NULL, 0, 0);
9321 for (list = gdk_window_peek_children (window); list; list = list->next)
9322 gtk_reset_shapes_recurse (widget, list->data);
9326 * gtk_widget_reset_shapes:
9327 * @widget: a #GtkWidget
9329 * Recursively resets the shape on this widget and its descendants.
9332 gtk_widget_reset_shapes (GtkWidget *widget)
9334 g_return_if_fail (GTK_IS_WIDGET (widget));
9335 g_return_if_fail (GTK_WIDGET_REALIZED (widget));
9337 if (!GTK_WIDGET_HAS_SHAPE_MASK (widget))
9338 gtk_reset_shapes_recurse (widget, widget->window);
9343 * @widget: a #GtkWidget
9345 * Adds a reference to a widget. This function is exactly the same
9346 * as calling g_object_ref(), and exists mostly for historical
9347 * reasons. It can still be convenient to avoid casting a widget
9348 * to a #GObject, it saves a small amount of typing.
9350 * Return value: the widget that was referenced
9352 * Deprecated: 2.12: Use g_object_ref() instead.
9355 gtk_widget_ref (GtkWidget *widget)
9357 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9359 return (GtkWidget*) g_object_ref ((GObject*) widget);
9364 * @widget: a #GtkWidget
9366 * Inverse of gtk_widget_ref(). Equivalent to g_object_unref().
9368 * Deprecated: 2.12: Use g_object_unref() instead.
9371 gtk_widget_unref (GtkWidget *widget)
9373 g_return_if_fail (GTK_IS_WIDGET (widget));
9375 g_object_unref ((GObject*) widget);
9379 expose_window (GdkWindow *window)
9382 GList *l, *children;
9384 gboolean is_double_buffered;
9386 gdk_window_get_user_data (window, &user_data);
9389 is_double_buffered = gtk_widget_get_double_buffered (GTK_WIDGET (user_data));
9391 is_double_buffered = FALSE;
9393 event.expose.type = GDK_EXPOSE;
9394 event.expose.window = g_object_ref (window);
9395 event.expose.send_event = FALSE;
9396 event.expose.count = 0;
9397 event.expose.area.x = 0;
9398 event.expose.area.y = 0;
9399 gdk_drawable_get_size (GDK_DRAWABLE (window),
9400 &event.expose.area.width,
9401 &event.expose.area.height);
9402 event.expose.region = gdk_region_rectangle (&event.expose.area);
9404 /* If this is not double buffered, force a double buffer so that
9405 redirection works. */
9406 if (!is_double_buffered)
9407 gdk_window_begin_paint_region (window, event.expose.region);
9409 gtk_main_do_event (&event);
9411 if (!is_double_buffered)
9412 gdk_window_end_paint (window);
9414 children = gdk_window_peek_children (window);
9415 for (l = children; l != NULL; l = l->next)
9417 GdkWindow *child = l->data;
9419 /* Don't expose input-only windows */
9420 if (gdk_drawable_get_depth (GDK_DRAWABLE (child)) != 0)
9421 expose_window (l->data);
9424 g_object_unref (window);
9428 * gtk_widget_get_snapshot:
9429 * @widget: a #GtkWidget
9430 * @clip_rect: a #GdkRectangle or %NULL
9432 * Create a #GdkPixmap of the contents of the widget and its children.
9434 * Works even if the widget is obscured. The depth and visual of the
9435 * resulting pixmap is dependent on the widget being snapshot and likely
9436 * differs from those of a target widget displaying the pixmap.
9437 * The function gdk_pixbuf_get_from_drawable() can be used to convert
9438 * the pixmap to a visual independant representation.
9440 * The snapshot area used by this function is the @widget's allocation plus
9441 * any extra space occupied by additional windows belonging to this widget
9442 * (such as the arrows of a spin button).
9443 * Thus, the resulting snapshot pixmap is possibly larger than the allocation.
9445 * If @clip_rect is non-%NULL, the resulting pixmap is shrunken to
9446 * match the specified clip_rect. The (x,y) coordinates of @clip_rect are
9447 * interpreted widget relative. If width or height of @clip_rect are 0 or
9448 * negative, the width or height of the resulting pixmap will be shrunken
9449 * by the respective amount.
9450 * For instance a @clip_rect <literal>{ +5, +5, -10, -10 }</literal> will
9451 * chop off 5 pixels at each side of the snapshot pixmap.
9452 * If non-%NULL, @clip_rect will contain the exact widget-relative snapshot
9453 * coordinates upon return. A @clip_rect of <literal>{ -1, -1, 0, 0 }</literal>
9454 * can be used to preserve the auto-grown snapshot area and use @clip_rect
9455 * as a pure output parameter.
9457 * The returned pixmap can be %NULL, if the resulting @clip_area was empty.
9459 * Return value: #GdkPixmap snapshot of the widget
9464 gtk_widget_get_snapshot (GtkWidget *widget,
9465 GdkRectangle *clip_rect)
9467 int x, y, width, height;
9468 GdkWindow *parent_window = NULL;
9470 GList *windows = NULL, *list;
9472 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9473 if (!GTK_WIDGET_VISIBLE (widget))
9476 /* the widget (and parent_window) must be realized to be drawable */
9477 if (widget->parent && !GTK_WIDGET_REALIZED (widget->parent))
9478 gtk_widget_realize (widget->parent);
9479 if (!GTK_WIDGET_REALIZED (widget))
9480 gtk_widget_realize (widget);
9482 /* determine snapshot rectangle */
9483 x = widget->allocation.x;
9484 y = widget->allocation.y;
9485 width = widget->allocation.width;
9486 height = widget->allocation.height;
9488 if (widget->parent && !GTK_WIDGET_NO_WINDOW (widget))
9490 /* grow snapshot rectangle to cover all widget windows */
9491 parent_window = gtk_widget_get_parent_window (widget);
9492 for (list = gdk_window_peek_children (parent_window); list; list = list->next)
9494 GdkWindow *subwin = list->data;
9497 gdk_window_get_user_data (subwin, &windata);
9498 if (windata != widget)
9500 windows = g_list_prepend (windows, subwin);
9501 gdk_window_get_position (subwin, &wx, &wy);
9502 gdk_drawable_get_size (subwin, &ww, &wh);
9503 /* grow snapshot rectangle by extra widget sub window */
9514 if (x + width < wx + ww)
9515 width += wx + ww - (x + width);
9516 if (y + height < wy + wh)
9517 height += wy + wh - (y + height);
9520 else if (!widget->parent)
9521 x = y = 0; /* toplevel */
9523 /* at this point, (x,y,width,height) is the parent_window relative
9524 * snapshot area covering all of widget's windows.
9527 /* shrink snapshot size by clip_rectangle */
9530 GdkRectangle snap = { x, y, width, height }, clip = *clip_rect;
9531 clip.x = clip.x < 0 ? x : clip.x;
9532 clip.y = clip.y < 0 ? y : clip.y;
9533 clip.width = clip.width <= 0 ? MAX (0, width + clip.width) : clip.width;
9534 clip.height = clip.height <= 0 ? MAX (0, height + clip.height) : clip.height;
9537 /* offset clip_rect, so it's parent_window relative */
9538 if (clip_rect->x >= 0)
9539 clip.x += widget->allocation.x;
9540 if (clip_rect->y >= 0)
9541 clip.y += widget->allocation.y;
9543 if (!gdk_rectangle_intersect (&snap, &clip, &snap))
9545 g_list_free (windows);
9546 clip_rect->width = clip_rect->height = 0;
9547 return NULL; /* empty snapshot area */
9552 height = snap.height;
9555 /* render snapshot */
9556 pixmap = gdk_pixmap_new (widget->window, width, height, gdk_drawable_get_depth (widget->window));
9557 for (list = windows; list; list = list->next) /* !NO_WINDOW widgets */
9559 GdkWindow *subwin = list->data;
9561 if (gdk_drawable_get_depth (GDK_DRAWABLE (subwin)) == 0)
9562 continue; /* Input only window */
9563 gdk_window_get_position (subwin, &wx, &wy);
9564 gdk_window_redirect_to_drawable (subwin, pixmap, MAX (0, x - wx), MAX (0, y - wy),
9565 MAX (0, wx - x), MAX (0, wy - y), width, height);
9567 expose_window (subwin);
9569 if (!windows) /* NO_WINDOW || toplevel => parent_window == NULL || parent_window == widget->window */
9571 gdk_window_redirect_to_drawable (widget->window, pixmap, x, y, 0, 0, width, height);
9572 expose_window (widget->window);
9574 for (list = windows; list; list = list->next)
9575 gdk_window_remove_redirection (list->data);
9576 if (!windows) /* NO_WINDOW || toplevel */
9577 gdk_window_remove_redirection (widget->window);
9578 g_list_free (windows);
9580 /* return pixmap and snapshot rectangle coordinates */
9585 clip_rect->width = width;
9586 clip_rect->height = height;
9589 /* offset clip_rect from parent_window so it's widget relative */
9590 clip_rect->x -= widget->allocation.x;
9591 clip_rect->y -= widget->allocation.y;
9594 g_printerr ("gtk_widget_get_snapshot: %s (%d,%d, %dx%d)\n",
9595 G_OBJECT_TYPE_NAME (widget),
9596 clip_rect->x, clip_rect->y, clip_rect->width, clip_rect->height);
9605 * gtk_widget_class_install_style_property_parser:
9606 * @klass: a #GtkWidgetClass
9607 * @pspec: the #GParamSpec for the style property
9608 * @parser: the parser for the style property
9610 * Installs a style property on a widget class.
9613 gtk_widget_class_install_style_property_parser (GtkWidgetClass *klass,
9615 GtkRcPropertyParser parser)
9617 g_return_if_fail (GTK_IS_WIDGET_CLASS (klass));
9618 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
9619 g_return_if_fail (pspec->flags & G_PARAM_READABLE);
9620 g_return_if_fail (!(pspec->flags & (G_PARAM_CONSTRUCT_ONLY | G_PARAM_CONSTRUCT)));
9622 if (g_param_spec_pool_lookup (style_property_spec_pool, pspec->name, G_OBJECT_CLASS_TYPE (klass), FALSE))
9624 g_warning (G_STRLOC ": class `%s' already contains a style property named `%s'",
9625 G_OBJECT_CLASS_NAME (klass),
9630 g_param_spec_ref_sink (pspec);
9631 g_param_spec_set_qdata (pspec, quark_property_parser, (gpointer) parser);
9632 g_param_spec_pool_insert (style_property_spec_pool, pspec, G_OBJECT_CLASS_TYPE (klass));
9636 * gtk_widget_class_install_style_property:
9637 * @klass: a #GtkWidgetClass
9638 * @pspec: the #GParamSpec for the property
9640 * Installs a style property on a widget class. The parser for the
9641 * style property is determined by the value type of @pspec.
9644 gtk_widget_class_install_style_property (GtkWidgetClass *klass,
9647 GtkRcPropertyParser parser;
9649 g_return_if_fail (GTK_IS_WIDGET_CLASS (klass));
9650 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
9652 parser = _gtk_rc_property_parser_from_type (G_PARAM_SPEC_VALUE_TYPE (pspec));
9654 gtk_widget_class_install_style_property_parser (klass, pspec, parser);
9658 * gtk_widget_class_find_style_property:
9659 * @klass: a #GtkWidgetClass
9660 * @property_name: the name of the style property to find
9661 * @returns: the #GParamSpec of the style property or %NULL if @class has no
9662 * style property with that name.
9664 * Finds a style property of a widget class by name.
9669 gtk_widget_class_find_style_property (GtkWidgetClass *klass,
9670 const gchar *property_name)
9672 g_return_val_if_fail (property_name != NULL, NULL);
9674 return g_param_spec_pool_lookup (style_property_spec_pool,
9676 G_OBJECT_CLASS_TYPE (klass),
9681 * gtk_widget_class_list_style_properties:
9682 * @klass: a #GtkWidgetClass
9683 * @n_properties: location to return the number of style properties found
9684 * @returns: an newly allocated array of #GParamSpec*. The array must
9685 * be freed with g_free().
9687 * Returns all style properties of a widget class.
9692 gtk_widget_class_list_style_properties (GtkWidgetClass *klass,
9693 guint *n_properties)
9695 GParamSpec **pspecs;
9698 pspecs = g_param_spec_pool_list (style_property_spec_pool,
9699 G_OBJECT_CLASS_TYPE (klass),
9708 * gtk_widget_style_get_property:
9709 * @widget: a #GtkWidget
9710 * @property_name: the name of a style property
9711 * @value: location to return the property value
9713 * Gets the value of a style property of @widget.
9716 gtk_widget_style_get_property (GtkWidget *widget,
9717 const gchar *property_name,
9722 g_return_if_fail (GTK_IS_WIDGET (widget));
9723 g_return_if_fail (property_name != NULL);
9724 g_return_if_fail (G_IS_VALUE (value));
9726 g_object_ref (widget);
9727 pspec = g_param_spec_pool_lookup (style_property_spec_pool,
9729 G_OBJECT_TYPE (widget),
9732 g_warning ("%s: widget class `%s' has no property named `%s'",
9734 G_OBJECT_TYPE_NAME (widget),
9738 const GValue *peek_value;
9740 peek_value = _gtk_style_peek_property_value (widget->style,
9741 G_OBJECT_TYPE (widget),
9743 (GtkRcPropertyParser) g_param_spec_get_qdata (pspec, quark_property_parser));
9745 /* auto-conversion of the caller's value type
9747 if (G_VALUE_TYPE (value) == G_PARAM_SPEC_VALUE_TYPE (pspec))
9748 g_value_copy (peek_value, value);
9749 else if (g_value_type_transformable (G_PARAM_SPEC_VALUE_TYPE (pspec), G_VALUE_TYPE (value)))
9750 g_value_transform (peek_value, value);
9752 g_warning ("can't retrieve style property `%s' of type `%s' as value of type `%s'",
9754 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
9755 G_VALUE_TYPE_NAME (value));
9757 g_object_unref (widget);
9761 * gtk_widget_style_get_valist:
9762 * @widget: a #GtkWidget
9763 * @first_property_name: the name of the first property to get
9764 * @var_args: a <type>va_list</type> of pairs of property names and
9765 * locations to return the property values, starting with the location
9766 * for @first_property_name.
9768 * Non-vararg variant of gtk_widget_style_get(). Used primarily by language
9772 gtk_widget_style_get_valist (GtkWidget *widget,
9773 const gchar *first_property_name,
9778 g_return_if_fail (GTK_IS_WIDGET (widget));
9780 g_object_ref (widget);
9782 name = first_property_name;
9785 const GValue *peek_value;
9789 pspec = g_param_spec_pool_lookup (style_property_spec_pool,
9791 G_OBJECT_TYPE (widget),
9795 g_warning ("%s: widget class `%s' has no property named `%s'",
9797 G_OBJECT_TYPE_NAME (widget),
9801 /* style pspecs are always readable so we can spare that check here */
9803 peek_value = _gtk_style_peek_property_value (widget->style,
9804 G_OBJECT_TYPE (widget),
9806 (GtkRcPropertyParser) g_param_spec_get_qdata (pspec, quark_property_parser));
9807 G_VALUE_LCOPY (peek_value, var_args, 0, &error);
9810 g_warning ("%s: %s", G_STRLOC, error);
9815 name = va_arg (var_args, gchar*);
9818 g_object_unref (widget);
9822 * gtk_widget_style_get:
9823 * @widget: a #GtkWidget
9824 * @first_property_name: the name of the first property to get
9825 * @Varargs: pairs of property names and locations to
9826 * return the property values, starting with the location for
9827 * @first_property_name, terminated by %NULL.
9829 * Gets the values of a multiple style properties of @widget.
9832 gtk_widget_style_get (GtkWidget *widget,
9833 const gchar *first_property_name,
9838 g_return_if_fail (GTK_IS_WIDGET (widget));
9840 va_start (var_args, first_property_name);
9841 gtk_widget_style_get_valist (widget, first_property_name, var_args);
9847 * @widget: a #GtkWidget
9848 * @path_length: (out) (allow-none): location to store length of the path, or %NULL
9849 * @path: (out) (allow-none): location to store allocated path string, or %NULL
9850 * @path_reversed: (out) (allow-none): location to store allocated reverse path string, or %NULL
9852 * Obtains the full path to @widget. The path is simply the name of a
9853 * widget and all its parents in the container hierarchy, separated by
9854 * periods. The name of a widget comes from
9855 * gtk_widget_get_name(). Paths are used to apply styles to a widget
9856 * in gtkrc configuration files. Widget names are the type of the
9857 * widget by default (e.g. "GtkButton") or can be set to an
9858 * application-specific value with gtk_widget_set_name(). By setting
9859 * the name of a widget, you allow users or theme authors to apply
9860 * styles to that specific widget in their gtkrc
9861 * file. @path_reversed_p fills in the path in reverse order,
9862 * i.e. starting with @widget's name instead of starting with the name
9863 * of @widget's outermost ancestor.
9866 gtk_widget_path (GtkWidget *widget,
9869 gchar **path_reversed)
9871 static gchar *rev_path = NULL;
9872 static guint tmp_path_len = 0;
9875 g_return_if_fail (GTK_IS_WIDGET (widget));
9880 const gchar *string;
9885 string = gtk_widget_get_name (widget);
9886 l = strlen (string);
9887 while (tmp_path_len <= len + l + 1)
9889 tmp_path_len += INIT_PATH_SIZE;
9890 rev_path = g_realloc (rev_path, tmp_path_len);
9898 widget = widget->parent;
9901 rev_path[len++] = '.';
9903 rev_path[len++] = 0;
9908 *path_length = len - 1;
9910 *path_reversed = g_strdup (rev_path);
9913 *path = g_strdup (rev_path);
9914 g_strreverse (*path);
9919 * gtk_widget_class_path:
9920 * @widget: a #GtkWidget
9921 * @path_length: (out) (allow-none): location to store the length of the class path, or %NULL
9922 * @path: (out) (allow-none) location to store the class path as an allocated string, or %NULL
9923 * @path_reversed: (out) (allow-none) location to store the reverse class path as an allocated
9926 * Same as gtk_widget_path(), but always uses the name of a widget's type,
9927 * never uses a custom name set with gtk_widget_set_name().
9931 gtk_widget_class_path (GtkWidget *widget,
9934 gchar **path_reversed)
9936 static gchar *rev_path = NULL;
9937 static guint tmp_path_len = 0;
9940 g_return_if_fail (GTK_IS_WIDGET (widget));
9945 const gchar *string;
9950 string = g_type_name (G_OBJECT_TYPE (widget));
9951 l = strlen (string);
9952 while (tmp_path_len <= len + l + 1)
9954 tmp_path_len += INIT_PATH_SIZE;
9955 rev_path = g_realloc (rev_path, tmp_path_len);
9963 widget = widget->parent;
9966 rev_path[len++] = '.';
9968 rev_path[len++] = 0;
9973 *path_length = len - 1;
9975 *path_reversed = g_strdup (rev_path);
9978 *path = g_strdup (rev_path);
9979 g_strreverse (*path);
9984 * gtk_requisition_copy:
9985 * @requisition: a #GtkRequisition
9987 * Copies a #GtkRequisition.
9989 * Returns: a copy of @requisition
9992 gtk_requisition_copy (const GtkRequisition *requisition)
9994 return (GtkRequisition *)g_memdup (requisition, sizeof (GtkRequisition));
9998 * gtk_requisition_free:
9999 * @requisition: a #GtkRequisition
10001 * Frees a #GtkRequisition.
10004 gtk_requisition_free (GtkRequisition *requisition)
10006 g_free (requisition);
10010 gtk_requisition_get_type (void)
10012 static GType our_type = 0;
10015 our_type = g_boxed_type_register_static (I_("GtkRequisition"),
10016 (GBoxedCopyFunc) gtk_requisition_copy,
10017 (GBoxedFreeFunc) gtk_requisition_free);
10023 * gtk_widget_get_accessible:
10024 * @widget: a #GtkWidget
10026 * Returns the accessible object that describes the widget to an
10027 * assistive technology.
10029 * If no accessibility library is loaded (i.e. no ATK implementation library is
10030 * loaded via <envar>GTK_MODULES</envar> or via another application library,
10031 * such as libgnome), then this #AtkObject instance may be a no-op. Likewise,
10032 * if no class-specific #AtkObject implementation is available for the widget
10033 * instance in question, it will inherit an #AtkObject implementation from the
10034 * first ancestor class for which such an implementation is defined.
10036 * The documentation of the <ulink url="http://developer.gnome.org/doc/API/2.0/atk/index.html">ATK</ulink>
10037 * library contains more information about accessible objects and their uses.
10039 * Returns: (transfer none): the #AtkObject associated with @widget
10042 gtk_widget_get_accessible (GtkWidget *widget)
10044 GtkWidgetClass *klass;
10046 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10048 klass = GTK_WIDGET_GET_CLASS (widget);
10050 g_return_val_if_fail (klass->get_accessible != NULL, NULL);
10052 return klass->get_accessible (widget);
10056 gtk_widget_real_get_accessible (GtkWidget *widget)
10058 AtkObject* accessible;
10060 accessible = g_object_get_qdata (G_OBJECT (widget),
10061 quark_accessible_object);
10064 AtkObjectFactory *factory;
10065 AtkRegistry *default_registry;
10067 default_registry = atk_get_default_registry ();
10068 factory = atk_registry_get_factory (default_registry,
10069 G_TYPE_FROM_INSTANCE (widget));
10071 atk_object_factory_create_accessible (factory,
10072 G_OBJECT (widget));
10073 g_object_set_qdata (G_OBJECT (widget),
10074 quark_accessible_object,
10081 * Initialize a AtkImplementorIface instance's virtual pointers as
10082 * appropriate to this implementor's class (GtkWidget).
10085 gtk_widget_accessible_interface_init (AtkImplementorIface *iface)
10087 iface->ref_accessible = gtk_widget_ref_accessible;
10091 gtk_widget_ref_accessible (AtkImplementor *implementor)
10093 AtkObject *accessible;
10095 accessible = gtk_widget_get_accessible (GTK_WIDGET (implementor));
10097 g_object_ref (accessible);
10102 * GtkBuildable implementation
10104 static GQuark quark_builder_has_default = 0;
10105 static GQuark quark_builder_has_focus = 0;
10106 static GQuark quark_builder_atk_relations = 0;
10107 static GQuark quark_builder_set_name = 0;
10110 gtk_widget_buildable_interface_init (GtkBuildableIface *iface)
10112 quark_builder_has_default = g_quark_from_static_string ("gtk-builder-has-default");
10113 quark_builder_has_focus = g_quark_from_static_string ("gtk-builder-has-focus");
10114 quark_builder_atk_relations = g_quark_from_static_string ("gtk-builder-atk-relations");
10115 quark_builder_set_name = g_quark_from_static_string ("gtk-builder-set-name");
10117 iface->set_name = gtk_widget_buildable_set_name;
10118 iface->get_name = gtk_widget_buildable_get_name;
10119 iface->get_internal_child = gtk_widget_buildable_get_internal_child;
10120 iface->set_buildable_property = gtk_widget_buildable_set_buildable_property;
10121 iface->parser_finished = gtk_widget_buildable_parser_finished;
10122 iface->custom_tag_start = gtk_widget_buildable_custom_tag_start;
10123 iface->custom_finished = gtk_widget_buildable_custom_finished;
10127 gtk_widget_buildable_set_name (GtkBuildable *buildable,
10130 g_object_set_qdata_full (G_OBJECT (buildable), quark_builder_set_name,
10131 g_strdup (name), g_free);
10134 static const gchar *
10135 gtk_widget_buildable_get_name (GtkBuildable *buildable)
10137 return g_object_get_qdata (G_OBJECT (buildable), quark_builder_set_name);
10141 gtk_widget_buildable_get_internal_child (GtkBuildable *buildable,
10142 GtkBuilder *builder,
10143 const gchar *childname)
10145 if (strcmp (childname, "accessible") == 0)
10146 return G_OBJECT (gtk_widget_get_accessible (GTK_WIDGET (buildable)));
10152 gtk_widget_buildable_set_buildable_property (GtkBuildable *buildable,
10153 GtkBuilder *builder,
10155 const GValue *value)
10157 if (strcmp (name, "has-default") == 0 && g_value_get_boolean (value))
10158 g_object_set_qdata (G_OBJECT (buildable), quark_builder_has_default,
10159 GINT_TO_POINTER (TRUE));
10160 else if (strcmp (name, "has-focus") == 0 && g_value_get_boolean (value))
10161 g_object_set_qdata (G_OBJECT (buildable), quark_builder_has_focus,
10162 GINT_TO_POINTER (TRUE));
10164 g_object_set_property (G_OBJECT (buildable), name, value);
10169 gchar *action_name;
10170 GString *description;
10172 gboolean translatable;
10182 free_action (AtkActionData *data, gpointer user_data)
10184 g_free (data->action_name);
10185 g_string_free (data->description, TRUE);
10186 g_free (data->context);
10187 g_slice_free (AtkActionData, data);
10191 free_relation (AtkRelationData *data, gpointer user_data)
10193 g_free (data->target);
10194 g_free (data->type);
10195 g_slice_free (AtkRelationData, data);
10199 gtk_widget_buildable_parser_finished (GtkBuildable *buildable,
10200 GtkBuilder *builder)
10202 GSList *atk_relations;
10204 if (g_object_get_qdata (G_OBJECT (buildable), quark_builder_has_default))
10205 gtk_widget_grab_default (GTK_WIDGET (buildable));
10206 if (g_object_get_qdata (G_OBJECT (buildable), quark_builder_has_focus))
10207 gtk_widget_grab_focus (GTK_WIDGET (buildable));
10209 atk_relations = g_object_get_qdata (G_OBJECT (buildable),
10210 quark_builder_atk_relations);
10213 AtkObject *accessible;
10214 AtkRelationSet *relation_set;
10217 AtkRelationType relation_type;
10218 AtkObject *target_accessible;
10220 accessible = gtk_widget_get_accessible (GTK_WIDGET (buildable));
10221 relation_set = atk_object_ref_relation_set (accessible);
10223 for (l = atk_relations; l; l = l->next)
10225 AtkRelationData *relation = (AtkRelationData*)l->data;
10227 target = gtk_builder_get_object (builder, relation->target);
10230 g_warning ("Target object %s in <relation> does not exist",
10234 target_accessible = gtk_widget_get_accessible (GTK_WIDGET (target));
10235 g_assert (target_accessible != NULL);
10237 relation_type = atk_relation_type_for_name (relation->type);
10238 if (relation_type == ATK_RELATION_NULL)
10240 g_warning ("<relation> type %s not found",
10244 atk_relation_set_add_relation_by_type (relation_set, relation_type,
10245 target_accessible);
10247 g_object_unref (relation_set);
10249 g_slist_foreach (atk_relations, (GFunc)free_relation, NULL);
10250 g_slist_free (atk_relations);
10251 g_object_set_qdata (G_OBJECT (buildable), quark_builder_atk_relations,
10260 } AccessibilitySubParserData;
10263 accessibility_start_element (GMarkupParseContext *context,
10264 const gchar *element_name,
10265 const gchar **names,
10266 const gchar **values,
10267 gpointer user_data,
10270 AccessibilitySubParserData *data = (AccessibilitySubParserData*)user_data;
10272 gint line_number, char_number;
10274 if (strcmp (element_name, "relation") == 0)
10276 gchar *target = NULL;
10277 gchar *type = NULL;
10278 AtkRelationData *relation;
10280 for (i = 0; names[i]; i++)
10282 if (strcmp (names[i], "target") == 0)
10283 target = g_strdup (values[i]);
10284 else if (strcmp (names[i], "type") == 0)
10285 type = g_strdup (values[i]);
10288 g_markup_parse_context_get_position (context,
10291 g_set_error (error,
10293 GTK_BUILDER_ERROR_INVALID_ATTRIBUTE,
10294 "%s:%d:%d '%s' is not a valid attribute of <%s>",
10296 line_number, char_number, names[i], "relation");
10303 if (!target || !type)
10305 g_markup_parse_context_get_position (context,
10308 g_set_error (error,
10310 GTK_BUILDER_ERROR_MISSING_ATTRIBUTE,
10311 "%s:%d:%d <%s> requires attribute \"%s\"",
10313 line_number, char_number, "relation",
10314 type ? "target" : "type");
10320 relation = g_slice_new (AtkRelationData);
10321 relation->target = target;
10322 relation->type = type;
10324 data->relations = g_slist_prepend (data->relations, relation);
10326 else if (strcmp (element_name, "action") == 0)
10328 const gchar *action_name = NULL;
10329 const gchar *description = NULL;
10330 const gchar *msg_context = NULL;
10331 gboolean translatable = FALSE;
10332 AtkActionData *action;
10334 for (i = 0; names[i]; i++)
10336 if (strcmp (names[i], "action_name") == 0)
10337 action_name = values[i];
10338 else if (strcmp (names[i], "description") == 0)
10339 description = values[i];
10340 else if (strcmp (names[i], "translatable") == 0)
10342 if (!_gtk_builder_boolean_from_string (values[i], &translatable, error))
10345 else if (strcmp (names[i], "comments") == 0)
10347 /* do nothing, comments are for translators */
10349 else if (strcmp (names[i], "context") == 0)
10350 msg_context = values[i];
10353 g_markup_parse_context_get_position (context,
10356 g_set_error (error,
10358 GTK_BUILDER_ERROR_INVALID_ATTRIBUTE,
10359 "%s:%d:%d '%s' is not a valid attribute of <%s>",
10361 line_number, char_number, names[i], "action");
10368 g_markup_parse_context_get_position (context,
10371 g_set_error (error,
10373 GTK_BUILDER_ERROR_MISSING_ATTRIBUTE,
10374 "%s:%d:%d <%s> requires attribute \"%s\"",
10376 line_number, char_number, "action",
10381 action = g_slice_new (AtkActionData);
10382 action->action_name = g_strdup (action_name);
10383 action->description = g_string_new (description);
10384 action->context = g_strdup (msg_context);
10385 action->translatable = translatable;
10387 data->actions = g_slist_prepend (data->actions, action);
10389 else if (strcmp (element_name, "accessibility") == 0)
10392 g_warning ("Unsupported tag for GtkWidget: %s\n", element_name);
10396 accessibility_text (GMarkupParseContext *context,
10399 gpointer user_data,
10402 AccessibilitySubParserData *data = (AccessibilitySubParserData*)user_data;
10404 if (strcmp (g_markup_parse_context_get_element (context), "action") == 0)
10406 AtkActionData *action = data->actions->data;
10408 g_string_append_len (action->description, text, text_len);
10412 static const GMarkupParser accessibility_parser =
10414 accessibility_start_element,
10416 accessibility_text,
10425 } AccelGroupParserData;
10428 accel_group_start_element (GMarkupParseContext *context,
10429 const gchar *element_name,
10430 const gchar **names,
10431 const gchar **values,
10432 gpointer user_data,
10437 guint modifiers = 0;
10438 gchar *signal = NULL;
10439 AccelGroupParserData *parser_data = (AccelGroupParserData*)user_data;
10441 for (i = 0; names[i]; i++)
10443 if (strcmp (names[i], "key") == 0)
10444 key = gdk_keyval_from_name (values[i]);
10445 else if (strcmp (names[i], "modifiers") == 0)
10447 if (!_gtk_builder_flags_from_string (GDK_TYPE_MODIFIER_TYPE,
10453 else if (strcmp (names[i], "signal") == 0)
10454 signal = g_strdup (values[i]);
10457 if (key == 0 || signal == NULL)
10459 g_warning ("<accelerator> requires key and signal attributes");
10462 parser_data->key = key;
10463 parser_data->modifiers = modifiers;
10464 parser_data->signal = signal;
10467 static const GMarkupParser accel_group_parser =
10469 accel_group_start_element,
10473 gtk_widget_buildable_custom_tag_start (GtkBuildable *buildable,
10474 GtkBuilder *builder,
10476 const gchar *tagname,
10477 GMarkupParser *parser,
10480 g_assert (buildable);
10482 if (strcmp (tagname, "accelerator") == 0)
10484 AccelGroupParserData *parser_data;
10486 parser_data = g_slice_new0 (AccelGroupParserData);
10487 parser_data->object = g_object_ref (buildable);
10488 *parser = accel_group_parser;
10489 *data = parser_data;
10492 if (strcmp (tagname, "accessibility") == 0)
10494 AccessibilitySubParserData *parser_data;
10496 parser_data = g_slice_new0 (AccessibilitySubParserData);
10497 *parser = accessibility_parser;
10498 *data = parser_data;
10505 _gtk_widget_buildable_finish_accelerator (GtkWidget *widget,
10506 GtkWidget *toplevel,
10507 gpointer user_data)
10509 AccelGroupParserData *accel_data;
10510 GSList *accel_groups;
10511 GtkAccelGroup *accel_group;
10513 g_return_if_fail (GTK_IS_WIDGET (widget));
10514 g_return_if_fail (GTK_IS_WIDGET (toplevel));
10515 g_return_if_fail (user_data != NULL);
10517 accel_data = (AccelGroupParserData*)user_data;
10518 accel_groups = gtk_accel_groups_from_object (G_OBJECT (toplevel));
10519 if (g_slist_length (accel_groups) == 0)
10521 accel_group = gtk_accel_group_new ();
10522 gtk_window_add_accel_group (GTK_WINDOW (toplevel), accel_group);
10526 g_assert (g_slist_length (accel_groups) == 1);
10527 accel_group = g_slist_nth_data (accel_groups, 0);
10530 gtk_widget_add_accelerator (GTK_WIDGET (accel_data->object),
10531 accel_data->signal,
10534 accel_data->modifiers,
10535 GTK_ACCEL_VISIBLE);
10537 g_object_unref (accel_data->object);
10538 g_free (accel_data->signal);
10539 g_slice_free (AccelGroupParserData, accel_data);
10543 gtk_widget_buildable_custom_finished (GtkBuildable *buildable,
10544 GtkBuilder *builder,
10546 const gchar *tagname,
10547 gpointer user_data)
10549 AccelGroupParserData *accel_data;
10550 AccessibilitySubParserData *a11y_data;
10551 GtkWidget *toplevel;
10553 if (strcmp (tagname, "accelerator") == 0)
10555 accel_data = (AccelGroupParserData*)user_data;
10556 g_assert (accel_data->object);
10558 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (accel_data->object));
10560 _gtk_widget_buildable_finish_accelerator (GTK_WIDGET (buildable), toplevel, user_data);
10562 else if (strcmp (tagname, "accessibility") == 0)
10564 a11y_data = (AccessibilitySubParserData*)user_data;
10566 if (a11y_data->actions)
10568 AtkObject *accessible;
10573 accessible = gtk_widget_get_accessible (GTK_WIDGET (buildable));
10575 action = ATK_ACTION (accessible);
10576 n_actions = atk_action_get_n_actions (action);
10578 for (l = a11y_data->actions; l; l = l->next)
10580 AtkActionData *action_data = (AtkActionData*)l->data;
10582 for (i = 0; i < n_actions; i++)
10583 if (strcmp (atk_action_get_name (action, i),
10584 action_data->action_name) == 0)
10589 gchar *description;
10591 if (action_data->translatable && action_data->description->len)
10592 description = _gtk_builder_parser_translate (gtk_builder_get_translation_domain (builder),
10593 action_data->context,
10594 action_data->description->str);
10596 description = action_data->description->str;
10598 atk_action_set_description (action, i, description);
10602 g_slist_foreach (a11y_data->actions, (GFunc)free_action, NULL);
10603 g_slist_free (a11y_data->actions);
10606 if (a11y_data->relations)
10607 g_object_set_qdata (G_OBJECT (buildable), quark_builder_atk_relations,
10608 a11y_data->relations);
10610 g_slice_free (AccessibilitySubParserData, a11y_data);
10616 * gtk_widget_get_clipboard:
10617 * @widget: a #GtkWidget
10618 * @selection: a #GdkAtom which identifies the clipboard
10619 * to use. %GDK_SELECTION_CLIPBOARD gives the
10620 * default clipboard. Another common value
10621 * is %GDK_SELECTION_PRIMARY, which gives
10622 * the primary X selection.
10624 * Returns the clipboard object for the given selection to
10625 * be used with @widget. @widget must have a #GdkDisplay
10626 * associated with it, so must be attached to a toplevel
10629 * Return value: (transfer none): the appropriate clipboard object. If no
10630 * clipboard already exists, a new one will
10631 * be created. Once a clipboard object has
10632 * been created, it is persistent for all time.
10637 gtk_widget_get_clipboard (GtkWidget *widget, GdkAtom selection)
10639 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10640 g_return_val_if_fail (gtk_widget_has_screen (widget), NULL);
10642 return gtk_clipboard_get_for_display (gtk_widget_get_display (widget),
10647 * gtk_widget_list_mnemonic_labels:
10648 * @widget: a #GtkWidget
10650 * Returns a newly allocated list of the widgets, normally labels, for
10651 * which this widget is a the target of a mnemonic (see for example,
10652 * gtk_label_set_mnemonic_widget()).
10654 * The widgets in the list are not individually referenced. If you
10655 * want to iterate through the list and perform actions involving
10656 * callbacks that might destroy the widgets, you
10657 * <emphasis>must</emphasis> call <literal>g_list_foreach (result,
10658 * (GFunc)g_object_ref, NULL)</literal> first, and then unref all the
10659 * widgets afterwards.
10661 * Return value: (element-type GtkWidget) (transfer container): the list of
10662 * mnemonic labels; free this list
10663 * with g_list_free() when you are done with it.
10668 gtk_widget_list_mnemonic_labels (GtkWidget *widget)
10670 GList *list = NULL;
10673 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10675 for (l = g_object_get_qdata (G_OBJECT (widget), quark_mnemonic_labels); l; l = l->next)
10676 list = g_list_prepend (list, l->data);
10682 * gtk_widget_add_mnemonic_label:
10683 * @widget: a #GtkWidget
10684 * @label: a #GtkWidget that acts as a mnemonic label for @widget
10686 * Adds a widget to the list of mnemonic labels for
10687 * this widget. (See gtk_widget_list_mnemonic_labels()). Note the
10688 * list of mnemonic labels for the widget is cleared when the
10689 * widget is destroyed, so the caller must make sure to update
10690 * its internal state at this point as well, by using a connection
10691 * to the #GtkWidget::destroy signal or a weak notifier.
10696 gtk_widget_add_mnemonic_label (GtkWidget *widget,
10699 GSList *old_list, *new_list;
10701 g_return_if_fail (GTK_IS_WIDGET (widget));
10702 g_return_if_fail (GTK_IS_WIDGET (label));
10704 old_list = g_object_steal_qdata (G_OBJECT (widget), quark_mnemonic_labels);
10705 new_list = g_slist_prepend (old_list, label);
10707 g_object_set_qdata_full (G_OBJECT (widget), quark_mnemonic_labels,
10708 new_list, (GDestroyNotify) g_slist_free);
10712 * gtk_widget_remove_mnemonic_label:
10713 * @widget: a #GtkWidget
10714 * @label: a #GtkWidget that was previously set as a mnemnic label for
10715 * @widget with gtk_widget_add_mnemonic_label().
10717 * Removes a widget from the list of mnemonic labels for
10718 * this widget. (See gtk_widget_list_mnemonic_labels()). The widget
10719 * must have previously been added to the list with
10720 * gtk_widget_add_mnemonic_label().
10725 gtk_widget_remove_mnemonic_label (GtkWidget *widget,
10728 GSList *old_list, *new_list;
10730 g_return_if_fail (GTK_IS_WIDGET (widget));
10731 g_return_if_fail (GTK_IS_WIDGET (label));
10733 old_list = g_object_steal_qdata (G_OBJECT (widget), quark_mnemonic_labels);
10734 new_list = g_slist_remove (old_list, label);
10737 g_object_set_qdata_full (G_OBJECT (widget), quark_mnemonic_labels,
10738 new_list, (GDestroyNotify) g_slist_free);
10742 * gtk_widget_get_no_show_all:
10743 * @widget: a #GtkWidget
10745 * Returns the current value of the GtkWidget:no-show-all property,
10746 * which determines whether calls to gtk_widget_show_all() and
10747 * gtk_widget_hide_all() will affect this widget.
10749 * Return value: the current value of the "no-show-all" property.
10754 gtk_widget_get_no_show_all (GtkWidget *widget)
10756 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
10758 return (GTK_WIDGET_FLAGS (widget) & GTK_NO_SHOW_ALL) != 0;
10762 * gtk_widget_set_no_show_all:
10763 * @widget: a #GtkWidget
10764 * @no_show_all: the new value for the "no-show-all" property
10766 * Sets the #GtkWidget:no-show-all property, which determines whether
10767 * calls to gtk_widget_show_all() and gtk_widget_hide_all() will affect
10770 * This is mostly for use in constructing widget hierarchies with externally
10771 * controlled visibility, see #GtkUIManager.
10776 gtk_widget_set_no_show_all (GtkWidget *widget,
10777 gboolean no_show_all)
10779 g_return_if_fail (GTK_IS_WIDGET (widget));
10781 no_show_all = (no_show_all != FALSE);
10783 if (no_show_all == ((GTK_WIDGET_FLAGS (widget) & GTK_NO_SHOW_ALL) != 0))
10787 GTK_WIDGET_SET_FLAGS (widget, GTK_NO_SHOW_ALL);
10789 GTK_WIDGET_UNSET_FLAGS (widget, GTK_NO_SHOW_ALL);
10791 g_object_notify (G_OBJECT (widget), "no-show-all");
10796 gtk_widget_real_set_has_tooltip (GtkWidget *widget,
10797 gboolean has_tooltip,
10800 gboolean priv_has_tooltip;
10802 priv_has_tooltip = GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (widget),
10803 quark_has_tooltip));
10805 if (priv_has_tooltip != has_tooltip || force)
10807 priv_has_tooltip = has_tooltip;
10809 if (priv_has_tooltip)
10811 if (GTK_WIDGET_REALIZED (widget) && GTK_WIDGET_NO_WINDOW (widget))
10812 gdk_window_set_events (widget->window,
10813 gdk_window_get_events (widget->window) |
10814 GDK_LEAVE_NOTIFY_MASK |
10815 GDK_POINTER_MOTION_MASK |
10816 GDK_POINTER_MOTION_HINT_MASK);
10818 if (!GTK_WIDGET_NO_WINDOW (widget))
10819 gtk_widget_add_events (widget,
10820 GDK_LEAVE_NOTIFY_MASK |
10821 GDK_POINTER_MOTION_MASK |
10822 GDK_POINTER_MOTION_HINT_MASK);
10825 g_object_set_qdata (G_OBJECT (widget), quark_has_tooltip,
10826 GUINT_TO_POINTER (priv_has_tooltip));
10831 * gtk_widget_set_tooltip_window:
10832 * @widget: a #GtkWidget
10833 * @custom_window: a #GtkWindow, or %NULL
10835 * Replaces the default, usually yellow, window used for displaying
10836 * tooltips with @custom_window. GTK+ will take care of showing and
10837 * hiding @custom_window at the right moment, to behave likewise as
10838 * the default tooltip window. If @custom_window is %NULL, the default
10839 * tooltip window will be used.
10841 * If the custom window should have the default theming it needs to
10842 * have the name "gtk-tooltip", see gtk_widget_set_name().
10847 gtk_widget_set_tooltip_window (GtkWidget *widget,
10848 GtkWindow *custom_window)
10850 gboolean has_tooltip;
10851 gchar *tooltip_markup;
10853 g_return_if_fail (GTK_IS_WIDGET (widget));
10854 g_return_if_fail (custom_window == NULL || GTK_IS_WINDOW (custom_window));
10856 tooltip_markup = g_object_get_qdata (G_OBJECT (widget), quark_tooltip_markup);
10859 g_object_ref (custom_window);
10861 g_object_set_qdata_full (G_OBJECT (widget), quark_tooltip_window,
10862 custom_window, g_object_unref);
10864 has_tooltip = (custom_window != NULL || tooltip_markup != NULL);
10865 gtk_widget_real_set_has_tooltip (widget, has_tooltip, FALSE);
10867 if (has_tooltip && GTK_WIDGET_VISIBLE (widget))
10868 gtk_widget_queue_tooltip_query (widget);
10872 * gtk_widget_get_tooltip_window:
10873 * @widget: a #GtkWidget
10875 * Returns the #GtkWindow of the current tooltip. This can be the
10876 * GtkWindow created by default, or the custom tooltip window set
10877 * using gtk_widget_set_tooltip_window().
10879 * Return value: (transfer none): The #GtkWindow of the current tooltip.
10884 gtk_widget_get_tooltip_window (GtkWidget *widget)
10886 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10888 return g_object_get_qdata (G_OBJECT (widget), quark_tooltip_window);
10892 * gtk_widget_trigger_tooltip_query:
10893 * @widget: a #GtkWidget
10895 * Triggers a tooltip query on the display where the toplevel of @widget
10896 * is located. See gtk_tooltip_trigger_tooltip_query() for more
10902 gtk_widget_trigger_tooltip_query (GtkWidget *widget)
10904 gtk_tooltip_trigger_tooltip_query (gtk_widget_get_display (widget));
10907 static guint tooltip_query_id;
10908 static GSList *tooltip_query_displays;
10911 tooltip_query_idle (gpointer data)
10913 g_slist_foreach (tooltip_query_displays, (GFunc)gtk_tooltip_trigger_tooltip_query, NULL);
10914 g_slist_foreach (tooltip_query_displays, (GFunc)g_object_unref, NULL);
10915 g_slist_free (tooltip_query_displays);
10917 tooltip_query_displays = NULL;
10918 tooltip_query_id = 0;
10924 gtk_widget_queue_tooltip_query (GtkWidget *widget)
10926 GdkDisplay *display;
10928 display = gtk_widget_get_display (widget);
10930 if (!g_slist_find (tooltip_query_displays, display))
10931 tooltip_query_displays = g_slist_prepend (tooltip_query_displays, g_object_ref (display));
10933 if (tooltip_query_id == 0)
10934 tooltip_query_id = gdk_threads_add_idle (tooltip_query_idle, NULL);
10938 * gtk_widget_set_tooltip_text:
10939 * @widget: a #GtkWidget
10940 * @text: the contents of the tooltip for @widget
10942 * Sets @text as the contents of the tooltip. This function will take
10943 * care of setting GtkWidget:has-tooltip to %TRUE and of the default
10944 * handler for the GtkWidget::query-tooltip signal.
10946 * See also the GtkWidget:tooltip-text property and gtk_tooltip_set_text().
10951 gtk_widget_set_tooltip_text (GtkWidget *widget,
10954 g_return_if_fail (GTK_IS_WIDGET (widget));
10956 g_object_set (G_OBJECT (widget), "tooltip-text", text, NULL);
10960 * gtk_widget_get_tooltip_text:
10961 * @widget: a #GtkWidget
10963 * Gets the contents of the tooltip for @widget.
10965 * Return value: the tooltip text, or %NULL. You should free the
10966 * returned string with g_free() when done.
10971 gtk_widget_get_tooltip_text (GtkWidget *widget)
10973 gchar *text = NULL;
10975 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10977 g_object_get (G_OBJECT (widget), "tooltip-text", &text, NULL);
10983 * gtk_widget_set_tooltip_markup:
10984 * @widget: a #GtkWidget
10985 * @markup: the contents of the tooltip for @widget, or %NULL
10987 * Sets @markup as the contents of the tooltip, which is marked up with
10988 * the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
10990 * This function will take care of setting GtkWidget:has-tooltip to %TRUE
10991 * and of the default handler for the GtkWidget::query-tooltip signal.
10993 * See also the GtkWidget:tooltip-markup property and
10994 * gtk_tooltip_set_markup().
10999 gtk_widget_set_tooltip_markup (GtkWidget *widget,
11000 const gchar *markup)
11002 g_return_if_fail (GTK_IS_WIDGET (widget));
11004 g_object_set (G_OBJECT (widget), "tooltip-markup", markup, NULL);
11008 * gtk_widget_get_tooltip_markup:
11009 * @widget: a #GtkWidget
11011 * Gets the contents of the tooltip for @widget.
11013 * Return value: the tooltip text, or %NULL. You should free the
11014 * returned string with g_free() when done.
11019 gtk_widget_get_tooltip_markup (GtkWidget *widget)
11021 gchar *text = NULL;
11023 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
11025 g_object_get (G_OBJECT (widget), "tooltip-markup", &text, NULL);
11031 * gtk_widget_set_has_tooltip:
11032 * @widget: a #GtkWidget
11033 * @has_tooltip: whether or not @widget has a tooltip.
11035 * Sets the has-tooltip property on @widget to @has_tooltip. See
11036 * GtkWidget:has-tooltip for more information.
11041 gtk_widget_set_has_tooltip (GtkWidget *widget,
11042 gboolean has_tooltip)
11044 g_return_if_fail (GTK_IS_WIDGET (widget));
11046 g_object_set (G_OBJECT (widget), "has-tooltip", has_tooltip, NULL);
11050 * gtk_widget_get_has_tooltip:
11051 * @widget: a #GtkWidget
11053 * Returns the current value of the has-tooltip property. See
11054 * GtkWidget:has-tooltip for more information.
11056 * Return value: current value of has-tooltip on @widget.
11061 gtk_widget_get_has_tooltip (GtkWidget *widget)
11063 gboolean has_tooltip = FALSE;
11065 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
11067 g_object_get (G_OBJECT (widget), "has-tooltip", &has_tooltip, NULL);
11069 return has_tooltip;
11073 * gtk_widget_get_allocation:
11074 * @widget: a #GtkWidget
11075 * @allocation: (out): a pointer to a #GtkAllocation to copy to
11077 * Retrieves the widget's allocation.
11082 gtk_widget_get_allocation (GtkWidget *widget,
11083 GtkAllocation *allocation)
11085 g_return_if_fail (GTK_IS_WIDGET (widget));
11086 g_return_if_fail (allocation != NULL);
11088 *allocation = widget->allocation;
11092 * gtk_widget_set_allocation:
11093 * @widget: a #GtkWidget
11094 * @allocation: a pointer to a #GtkAllocation to copy from
11096 * Sets the widget's allocation. This should not be used
11097 * directly, but from within a widget's size_allocate method.
11102 gtk_widget_set_allocation (GtkWidget *widget,
11103 const GtkAllocation *allocation)
11105 g_return_if_fail (GTK_IS_WIDGET (widget));
11106 g_return_if_fail (allocation != NULL);
11108 widget->allocation = *allocation;
11112 * gtk_widget_set_window:
11113 * @widget: a #GtkWidget
11114 * @window: a #GdkWindow
11116 * Sets a widget's window. This function should only be used in a
11117 * widget's GtkWidget::realize() implementation. The %window passed is
11118 * usually either new window created with gdk_window_new(), or the
11119 * window of its parent widget as returned by
11120 * gtk_widget_get_parent_window().
11122 * Widgets must indicate whether they will create their own #GdkWindow
11123 * by calling gtk_widget_set_has_window(). This is usually done in the
11124 * widget's init() function.
11129 gtk_widget_set_window (GtkWidget *widget,
11132 g_return_if_fail (GTK_IS_WIDGET (widget));
11133 g_return_if_fail (window == NULL || GDK_IS_WINDOW (window));
11135 if (widget->window != window)
11137 widget->window = window;
11138 g_object_notify (G_OBJECT (widget), "window");
11143 * gtk_widget_get_window:
11144 * @widget: a #GtkWidget
11146 * Returns the widget's window if it is realized, %NULL otherwise
11148 * Return value: @widget's window.
11153 gtk_widget_get_window (GtkWidget *widget)
11155 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
11157 return widget->window;
11160 #define __GTK_WIDGET_C__
11161 #include "gtkaliasdef.c"