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"
58 #define WIDGET_CLASS(w) GTK_WIDGET_GET_CLASS (w)
59 #define INIT_PATH_SIZE (512)
100 PROPERTY_NOTIFY_EVENT,
101 SELECTION_CLEAR_EVENT,
102 SELECTION_REQUEST_EVENT,
103 SELECTION_NOTIFY_EVENT,
118 VISIBILITY_NOTIFY_EVENT,
122 ACCEL_CLOSURES_CHANGED,
148 PROP_RECEIVES_DEFAULT,
149 PROP_COMPOSITE_CHILD,
152 PROP_EXTENSION_EVENTS,
161 typedef struct _GtkStateData GtkStateData;
166 guint state_restoration : 1;
167 guint parent_sensitive : 1;
168 guint use_forall : 1;
171 /* --- prototypes --- */
172 static void gtk_widget_class_init (GtkWidgetClass *klass);
173 static void gtk_widget_base_class_finalize (GtkWidgetClass *klass);
174 static void gtk_widget_init (GtkWidget *widget);
175 static void gtk_widget_set_property (GObject *object,
179 static void gtk_widget_get_property (GObject *object,
183 static void gtk_widget_dispose (GObject *object);
184 static void gtk_widget_real_destroy (GtkObject *object);
185 static void gtk_widget_finalize (GObject *object);
186 static void gtk_widget_real_show (GtkWidget *widget);
187 static void gtk_widget_real_hide (GtkWidget *widget);
188 static void gtk_widget_real_map (GtkWidget *widget);
189 static void gtk_widget_real_unmap (GtkWidget *widget);
190 static void gtk_widget_real_realize (GtkWidget *widget);
191 static void gtk_widget_real_unrealize (GtkWidget *widget);
192 static void gtk_widget_real_size_request (GtkWidget *widget,
193 GtkRequisition *requisition);
194 static void gtk_widget_real_size_allocate (GtkWidget *widget,
195 GtkAllocation *allocation);
196 static void gtk_widget_real_style_set (GtkWidget *widget,
197 GtkStyle *previous_style);
198 static void gtk_widget_real_direction_changed(GtkWidget *widget,
199 GtkTextDirection previous_direction);
201 static void gtk_widget_real_grab_focus (GtkWidget *focus_widget);
202 static gboolean gtk_widget_real_query_tooltip (GtkWidget *widget,
205 gboolean keyboard_tip,
206 GtkTooltip *tooltip);
207 static gboolean gtk_widget_real_show_help (GtkWidget *widget,
208 GtkWidgetHelpType help_type);
210 static void gtk_widget_dispatch_child_properties_changed (GtkWidget *object,
212 GParamSpec **pspecs);
213 static gboolean gtk_widget_real_key_press_event (GtkWidget *widget,
215 static gboolean gtk_widget_real_key_release_event (GtkWidget *widget,
217 static gboolean gtk_widget_real_focus_in_event (GtkWidget *widget,
218 GdkEventFocus *event);
219 static gboolean gtk_widget_real_focus_out_event (GtkWidget *widget,
220 GdkEventFocus *event);
221 static gboolean gtk_widget_real_focus (GtkWidget *widget,
222 GtkDirectionType direction);
223 static void gtk_widget_real_move_focus (GtkWidget *widget,
224 GtkDirectionType direction);
225 static gboolean gtk_widget_real_keynav_failed (GtkWidget *widget,
226 GtkDirectionType direction);
227 static PangoContext* gtk_widget_peek_pango_context (GtkWidget *widget);
228 static void gtk_widget_update_pango_context (GtkWidget *widget);
229 static void gtk_widget_propagate_state (GtkWidget *widget,
231 static void gtk_widget_reset_rc_style (GtkWidget *widget);
232 static void gtk_widget_set_style_internal (GtkWidget *widget,
234 gboolean initial_emission);
235 static gint gtk_widget_event_internal (GtkWidget *widget,
237 static gboolean gtk_widget_real_mnemonic_activate (GtkWidget *widget,
238 gboolean group_cycling);
239 static void gtk_widget_aux_info_destroy (GtkWidgetAuxInfo *aux_info);
240 static AtkObject* gtk_widget_real_get_accessible (GtkWidget *widget);
241 static void gtk_widget_accessible_interface_init (AtkImplementorIface *iface);
242 static AtkObject* gtk_widget_ref_accessible (AtkImplementor *implementor);
243 static void gtk_widget_invalidate_widget_windows (GtkWidget *widget,
245 static GdkScreen * gtk_widget_get_screen_unchecked (GtkWidget *widget);
246 static void gtk_widget_queue_shallow_draw (GtkWidget *widget);
247 static gboolean gtk_widget_real_can_activate_accel (GtkWidget *widget,
250 static void gtk_widget_real_set_has_tooltip (GtkWidget *widget,
251 gboolean has_tooltip,
253 static void gtk_widget_buildable_interface_init (GtkBuildableIface *iface);
254 static void gtk_widget_buildable_set_name (GtkBuildable *buildable,
256 static const gchar * gtk_widget_buildable_get_name (GtkBuildable *buildable);
257 static GObject * gtk_widget_buildable_get_internal_child (GtkBuildable *buildable,
259 const gchar *childname);
260 static void gtk_widget_buildable_set_buildable_property (GtkBuildable *buildable,
263 const GValue *value);
264 static gboolean gtk_widget_buildable_custom_tag_start (GtkBuildable *buildable,
267 const gchar *tagname,
268 GMarkupParser *parser,
270 static void gtk_widget_buildable_custom_finished (GtkBuildable *buildable,
273 const gchar *tagname,
275 static void gtk_widget_buildable_parser_finished (GtkBuildable *buildable,
276 GtkBuilder *builder);
278 static void gtk_widget_queue_tooltip_query (GtkWidget *widget);
280 static void gtk_widget_set_usize_internal (GtkWidget *widget,
283 static void gtk_widget_get_draw_rectangle (GtkWidget *widget,
287 /* --- variables --- */
288 static gpointer gtk_widget_parent_class = NULL;
289 static guint widget_signals[LAST_SIGNAL] = { 0 };
290 static GtkStyle *gtk_default_style = NULL;
291 static GSList *colormap_stack = NULL;
292 static guint composite_child_stack = 0;
293 static GtkTextDirection gtk_default_direction = GTK_TEXT_DIR_LTR;
294 static GParamSpecPool *style_property_spec_pool = NULL;
296 static GQuark quark_property_parser = 0;
297 static GQuark quark_aux_info = 0;
298 static GQuark quark_accel_path = 0;
299 static GQuark quark_accel_closures = 0;
300 static GQuark quark_event_mask = 0;
301 static GQuark quark_extension_event_mode = 0;
302 static GQuark quark_parent_window = 0;
303 static GQuark quark_pointer_window = 0;
304 static GQuark quark_shape_info = 0;
305 static GQuark quark_input_shape_info = 0;
306 static GQuark quark_colormap = 0;
307 static GQuark quark_pango_context = 0;
308 static GQuark quark_rc_style = 0;
309 static GQuark quark_accessible_object = 0;
310 static GQuark quark_mnemonic_labels = 0;
311 static GQuark quark_tooltip_markup = 0;
312 static GQuark quark_has_tooltip = 0;
313 static GQuark quark_tooltip_window = 0;
314 GParamSpecPool *_gtk_widget_child_property_pool = NULL;
315 GObjectNotifyContext *_gtk_widget_child_property_notify_context = NULL;
317 /* --- functions --- */
319 gtk_widget_get_type (void)
321 static GType widget_type = 0;
323 if (G_UNLIKELY (widget_type == 0))
325 const GTypeInfo widget_info =
327 sizeof (GtkWidgetClass),
328 NULL, /* base_init */
329 (GBaseFinalizeFunc) gtk_widget_base_class_finalize,
330 (GClassInitFunc) gtk_widget_class_init,
331 NULL, /* class_finalize */
332 NULL, /* class_init */
335 (GInstanceInitFunc) gtk_widget_init,
336 NULL, /* value_table */
339 const GInterfaceInfo accessibility_info =
341 (GInterfaceInitFunc) gtk_widget_accessible_interface_init,
342 (GInterfaceFinalizeFunc) NULL,
343 NULL /* interface data */
346 const GInterfaceInfo buildable_info =
348 (GInterfaceInitFunc) gtk_widget_buildable_interface_init,
349 (GInterfaceFinalizeFunc) NULL,
350 NULL /* interface data */
353 widget_type = g_type_register_static (GTK_TYPE_OBJECT, "GtkWidget",
354 &widget_info, G_TYPE_FLAG_ABSTRACT);
356 g_type_add_interface_static (widget_type, ATK_TYPE_IMPLEMENTOR,
357 &accessibility_info) ;
358 g_type_add_interface_static (widget_type, GTK_TYPE_BUILDABLE,
367 child_property_notify_dispatcher (GObject *object,
371 GTK_WIDGET_GET_CLASS (object)->dispatch_child_properties_changed (GTK_WIDGET (object), n_pspecs, pspecs);
375 gtk_widget_class_init (GtkWidgetClass *klass)
377 static GObjectNotifyContext cpn_context = { 0, NULL, NULL };
378 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
379 GtkObjectClass *object_class = GTK_OBJECT_CLASS (klass);
380 GtkBindingSet *binding_set;
382 gtk_widget_parent_class = g_type_class_peek_parent (klass);
384 quark_property_parser = g_quark_from_static_string ("gtk-rc-property-parser");
385 quark_aux_info = g_quark_from_static_string ("gtk-aux-info");
386 quark_accel_path = g_quark_from_static_string ("gtk-accel-path");
387 quark_accel_closures = g_quark_from_static_string ("gtk-accel-closures");
388 quark_event_mask = g_quark_from_static_string ("gtk-event-mask");
389 quark_extension_event_mode = g_quark_from_static_string ("gtk-extension-event-mode");
390 quark_parent_window = g_quark_from_static_string ("gtk-parent-window");
391 quark_pointer_window = g_quark_from_static_string ("gtk-pointer-window");
392 quark_shape_info = g_quark_from_static_string ("gtk-shape-info");
393 quark_input_shape_info = g_quark_from_static_string ("gtk-input-shape-info");
394 quark_colormap = g_quark_from_static_string ("gtk-colormap");
395 quark_pango_context = g_quark_from_static_string ("gtk-pango-context");
396 quark_rc_style = g_quark_from_static_string ("gtk-rc-style");
397 quark_accessible_object = g_quark_from_static_string ("gtk-accessible-object");
398 quark_mnemonic_labels = g_quark_from_static_string ("gtk-mnemonic-labels");
399 quark_tooltip_markup = g_quark_from_static_string ("gtk-tooltip-markup");
400 quark_has_tooltip = g_quark_from_static_string ("gtk-has-tooltip");
401 quark_tooltip_window = g_quark_from_static_string ("gtk-tooltip-window");
403 style_property_spec_pool = g_param_spec_pool_new (FALSE);
404 _gtk_widget_child_property_pool = g_param_spec_pool_new (TRUE);
405 cpn_context.quark_notify_queue = g_quark_from_static_string ("GtkWidget-child-property-notify-queue");
406 cpn_context.dispatcher = child_property_notify_dispatcher;
407 _gtk_widget_child_property_notify_context = &cpn_context;
409 gobject_class->dispose = gtk_widget_dispose;
410 gobject_class->finalize = gtk_widget_finalize;
411 gobject_class->set_property = gtk_widget_set_property;
412 gobject_class->get_property = gtk_widget_get_property;
414 object_class->destroy = gtk_widget_real_destroy;
416 klass->activate_signal = 0;
417 klass->set_scroll_adjustments_signal = 0;
418 klass->dispatch_child_properties_changed = gtk_widget_dispatch_child_properties_changed;
419 klass->show = gtk_widget_real_show;
420 klass->show_all = gtk_widget_show;
421 klass->hide = gtk_widget_real_hide;
422 klass->hide_all = gtk_widget_hide;
423 klass->map = gtk_widget_real_map;
424 klass->unmap = gtk_widget_real_unmap;
425 klass->realize = gtk_widget_real_realize;
426 klass->unrealize = gtk_widget_real_unrealize;
427 klass->size_request = gtk_widget_real_size_request;
428 klass->size_allocate = gtk_widget_real_size_allocate;
429 klass->state_changed = NULL;
430 klass->parent_set = NULL;
431 klass->hierarchy_changed = NULL;
432 klass->style_set = gtk_widget_real_style_set;
433 klass->direction_changed = gtk_widget_real_direction_changed;
434 klass->grab_notify = NULL;
435 klass->child_notify = NULL;
436 klass->mnemonic_activate = gtk_widget_real_mnemonic_activate;
437 klass->grab_focus = gtk_widget_real_grab_focus;
438 klass->focus = gtk_widget_real_focus;
440 klass->button_press_event = NULL;
441 klass->button_release_event = NULL;
442 klass->motion_notify_event = NULL;
443 klass->delete_event = NULL;
444 klass->destroy_event = NULL;
445 klass->expose_event = NULL;
446 klass->key_press_event = gtk_widget_real_key_press_event;
447 klass->key_release_event = gtk_widget_real_key_release_event;
448 klass->enter_notify_event = NULL;
449 klass->leave_notify_event = NULL;
450 klass->configure_event = NULL;
451 klass->focus_in_event = gtk_widget_real_focus_in_event;
452 klass->focus_out_event = gtk_widget_real_focus_out_event;
453 klass->map_event = NULL;
454 klass->unmap_event = NULL;
455 klass->window_state_event = NULL;
456 klass->property_notify_event = _gtk_selection_property_notify;
457 klass->selection_clear_event = gtk_selection_clear;
458 klass->selection_request_event = _gtk_selection_request;
459 klass->selection_notify_event = _gtk_selection_notify;
460 klass->selection_received = NULL;
461 klass->proximity_in_event = NULL;
462 klass->proximity_out_event = NULL;
463 klass->drag_begin = NULL;
464 klass->drag_end = NULL;
465 klass->drag_data_delete = NULL;
466 klass->drag_leave = NULL;
467 klass->drag_motion = NULL;
468 klass->drag_drop = NULL;
469 klass->drag_data_received = NULL;
470 klass->screen_changed = NULL;
471 klass->can_activate_accel = gtk_widget_real_can_activate_accel;
472 klass->grab_broken_event = NULL;
473 klass->query_tooltip = gtk_widget_real_query_tooltip;
475 klass->show_help = gtk_widget_real_show_help;
477 /* Accessibility support */
478 klass->get_accessible = gtk_widget_real_get_accessible;
480 klass->no_expose_event = NULL;
482 g_object_class_install_property (gobject_class,
484 g_param_spec_string ("name",
486 P_("The name of the widget"),
488 GTK_PARAM_READWRITE));
489 g_object_class_install_property (gobject_class,
491 g_param_spec_object ("parent",
493 P_("The parent widget of this widget. Must be a Container widget"),
495 GTK_PARAM_READWRITE));
497 g_object_class_install_property (gobject_class,
499 g_param_spec_int ("width-request",
501 P_("Override for width request of the widget, or -1 if natural request should be used"),
505 GTK_PARAM_READWRITE));
506 g_object_class_install_property (gobject_class,
508 g_param_spec_int ("height-request",
509 P_("Height request"),
510 P_("Override for height request of the widget, or -1 if natural request should be used"),
514 GTK_PARAM_READWRITE));
515 g_object_class_install_property (gobject_class,
517 g_param_spec_boolean ("visible",
519 P_("Whether the widget is visible"),
521 GTK_PARAM_READWRITE));
522 g_object_class_install_property (gobject_class,
524 g_param_spec_boolean ("sensitive",
526 P_("Whether the widget responds to input"),
528 GTK_PARAM_READWRITE));
529 g_object_class_install_property (gobject_class,
531 g_param_spec_boolean ("app-paintable",
532 P_("Application paintable"),
533 P_("Whether the application will paint directly on the widget"),
535 GTK_PARAM_READWRITE));
536 g_object_class_install_property (gobject_class,
538 g_param_spec_boolean ("can-focus",
540 P_("Whether the widget can accept the input focus"),
542 GTK_PARAM_READWRITE));
543 g_object_class_install_property (gobject_class,
545 g_param_spec_boolean ("has-focus",
547 P_("Whether the widget has the input focus"),
549 GTK_PARAM_READWRITE));
550 g_object_class_install_property (gobject_class,
552 g_param_spec_boolean ("is-focus",
554 P_("Whether the widget is the focus widget within the toplevel"),
556 GTK_PARAM_READWRITE));
557 g_object_class_install_property (gobject_class,
559 g_param_spec_boolean ("can-default",
561 P_("Whether the widget can be the default widget"),
563 GTK_PARAM_READWRITE));
564 g_object_class_install_property (gobject_class,
566 g_param_spec_boolean ("has-default",
568 P_("Whether the widget is the default widget"),
570 GTK_PARAM_READWRITE));
571 g_object_class_install_property (gobject_class,
572 PROP_RECEIVES_DEFAULT,
573 g_param_spec_boolean ("receives-default",
574 P_("Receives default"),
575 P_("If TRUE, the widget will receive the default action when it is focused"),
577 GTK_PARAM_READWRITE));
578 g_object_class_install_property (gobject_class,
579 PROP_COMPOSITE_CHILD,
580 g_param_spec_boolean ("composite-child",
581 P_("Composite child"),
582 P_("Whether the widget is part of a composite widget"),
584 GTK_PARAM_READABLE));
585 g_object_class_install_property (gobject_class,
587 g_param_spec_object ("style",
589 P_("The style of the widget, which contains information about how it will look (colors etc)"),
591 GTK_PARAM_READWRITE));
592 g_object_class_install_property (gobject_class,
594 g_param_spec_flags ("events",
596 P_("The event mask that decides what kind of GdkEvents this widget gets"),
599 GTK_PARAM_READWRITE));
600 g_object_class_install_property (gobject_class,
601 PROP_EXTENSION_EVENTS,
602 g_param_spec_enum ("extension-events",
603 P_("Extension events"),
604 P_("The mask that decides what kind of extension events this widget gets"),
605 GDK_TYPE_EXTENSION_MODE,
606 GDK_EXTENSION_EVENTS_NONE,
607 GTK_PARAM_READWRITE));
608 g_object_class_install_property (gobject_class,
610 g_param_spec_boolean ("no-show-all",
612 P_("Whether gtk_widget_show_all() should not affect this widget"),
614 GTK_PARAM_READWRITE));
617 * GtkWidget:has-tooltip:
619 * Enables or disables the emission of #GtkWidget::query-tooltip on @widget.
620 * A value of %TRUE indicates that @widget can have a tooltip, in this case
621 * the widget will be queried using #GtkWidget::query-tooltip to determine
622 * whether it will provide a tooltip or not.
624 * Note that setting this property to %TRUE for the first time will change
625 * the event masks of the GdkWindows of this widget to include leave-notify
626 * and motion-notify events. This cannot and will not be undone when the
627 * property is set to %FALSE again.
631 g_object_class_install_property (gobject_class,
633 g_param_spec_boolean ("has-tooltip",
635 P_("Whether this widget has a tooltip"),
637 GTK_PARAM_READWRITE));
639 * GtkWidget:tooltip-text:
641 * Sets the text of tooltip to be the given string.
643 * Also see gtk_tooltip_set_text().
645 * This is a convenience property which will take care of getting the
646 * tooltip shown if the given string is not %NULL: #GtkWidget:has-tooltip
647 * will automatically be set to %TRUE and there will be taken care of
648 * #GtkWidget::query-tooltip in the default signal handler.
652 g_object_class_install_property (gobject_class,
654 g_param_spec_string ("tooltip-text",
656 P_("The contents of the tooltip for this widget"),
658 GTK_PARAM_READWRITE));
660 * GtkWidget:tooltip-markup:
662 * Sets the text of tooltip to be the given string, which is marked up
663 * with the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
664 * Also see gtk_tooltip_set_markup().
666 * This is a convenience property which will take care of getting the
667 * tooltip shown if the given string is not %NULL: #GtkWidget:has-tooltip
668 * will automatically be set to %TRUE and there will be taken care of
669 * #GtkWidget::query-tooltip in the default signal handler.
673 g_object_class_install_property (gobject_class,
675 g_param_spec_string ("tooltip-markup",
676 P_("Tooltip markup"),
677 P_("The contents of the tooltip for this widget"),
679 GTK_PARAM_READWRITE));
684 * The widget's window if it is realized, %NULL otherwise.
688 g_object_class_install_property (gobject_class,
690 g_param_spec_object ("window",
692 P_("The widget's window if it is realized"),
694 GTK_PARAM_READABLE));
697 * GtkWidget:double-buffered
699 * Whether or not the widget is double buffered.
703 g_object_class_install_property (gobject_class,
704 PROP_DOUBLE_BUFFERED,
705 g_param_spec_boolean ("double-buffered",
706 P_("Double Buffered"),
707 P_("Whether or not the widget is double buffered"),
709 GTK_PARAM_READWRITE));
711 widget_signals[SHOW] =
712 g_signal_new (I_("show"),
713 G_TYPE_FROM_CLASS (gobject_class),
715 G_STRUCT_OFFSET (GtkWidgetClass, show),
717 _gtk_marshal_VOID__VOID,
719 widget_signals[HIDE] =
720 g_signal_new (I_("hide"),
721 G_TYPE_FROM_CLASS (gobject_class),
723 G_STRUCT_OFFSET (GtkWidgetClass, hide),
725 _gtk_marshal_VOID__VOID,
727 widget_signals[MAP] =
728 g_signal_new (I_("map"),
729 G_TYPE_FROM_CLASS (gobject_class),
731 G_STRUCT_OFFSET (GtkWidgetClass, map),
733 _gtk_marshal_VOID__VOID,
735 widget_signals[UNMAP] =
736 g_signal_new (I_("unmap"),
737 G_TYPE_FROM_CLASS (gobject_class),
739 G_STRUCT_OFFSET (GtkWidgetClass, unmap),
741 _gtk_marshal_VOID__VOID,
743 widget_signals[REALIZE] =
744 g_signal_new (I_("realize"),
745 G_TYPE_FROM_CLASS (gobject_class),
747 G_STRUCT_OFFSET (GtkWidgetClass, realize),
749 _gtk_marshal_VOID__VOID,
751 widget_signals[UNREALIZE] =
752 g_signal_new (I_("unrealize"),
753 G_TYPE_FROM_CLASS (gobject_class),
755 G_STRUCT_OFFSET (GtkWidgetClass, unrealize),
757 _gtk_marshal_VOID__VOID,
759 widget_signals[SIZE_REQUEST] =
760 g_signal_new (I_("size-request"),
761 G_TYPE_FROM_CLASS (gobject_class),
763 G_STRUCT_OFFSET (GtkWidgetClass, size_request),
765 _gtk_marshal_VOID__BOXED,
767 GTK_TYPE_REQUISITION | G_SIGNAL_TYPE_STATIC_SCOPE);
768 widget_signals[SIZE_ALLOCATE] =
769 g_signal_new (I_("size-allocate"),
770 G_TYPE_FROM_CLASS (gobject_class),
772 G_STRUCT_OFFSET (GtkWidgetClass, size_allocate),
774 _gtk_marshal_VOID__BOXED,
776 GDK_TYPE_RECTANGLE | G_SIGNAL_TYPE_STATIC_SCOPE);
778 widget_signals[STATE_CHANGED] =
779 g_signal_new (I_("state-changed"),
780 G_TYPE_FROM_CLASS (gobject_class),
782 G_STRUCT_OFFSET (GtkWidgetClass, state_changed),
784 _gtk_marshal_VOID__ENUM,
786 GTK_TYPE_STATE_TYPE);
789 * GtkWidget::parent-set:
790 * @widget: the object on which the signal is emitted
791 * @old_parent: the previous parent, or %NULL if the widget
792 * just got its initial parent.
794 * The ::parent-set signal is emitted when a new parent
795 * has been set on a widget.
797 widget_signals[PARENT_SET] =
798 g_signal_new (I_("parent-set"),
799 G_TYPE_FROM_CLASS (gobject_class),
801 G_STRUCT_OFFSET (GtkWidgetClass, parent_set),
803 _gtk_marshal_VOID__OBJECT,
808 * GtkWidget::hierarchy-changed:
809 * @widget: the object on which the signal is emitted
810 * @previous_toplevel: the previous toplevel ancestor, or %NULL
811 * if the widget was previously unanchored
813 * The ::hierarchy-changed signal is emitted when the
814 * anchored state of a widget changes. A widget is
815 * <firstterm>anchored</firstterm> when its toplevel
816 * ancestor is a #GtkWindow. This signal is emitted when
817 * a widget changes from un-anchored to anchored or vice-versa.
819 widget_signals[HIERARCHY_CHANGED] =
820 g_signal_new (I_("hierarchy-changed"),
821 G_TYPE_FROM_CLASS (gobject_class),
823 G_STRUCT_OFFSET (GtkWidgetClass, hierarchy_changed),
825 _gtk_marshal_VOID__OBJECT,
830 * GtkWidget::style-set:
831 * @widget: the object on which the signal is emitted
832 * @previous_style: the previous style, or %NULL if the widget
833 * just got its initial style
835 * The ::style-set signal is emitted when a new style has been set
836 * on a widget. Note that style-modifying functions like
837 * gtk_widget_modify_base() also cause this signal to be emitted.
839 widget_signals[STYLE_SET] =
840 g_signal_new (I_("style-set"),
841 G_TYPE_FROM_CLASS (gobject_class),
843 G_STRUCT_OFFSET (GtkWidgetClass, style_set),
845 _gtk_marshal_VOID__OBJECT,
849 * GtkWidget::direction-changed:
850 * @widget: the object on which the signal is emitted
851 * @previous_direction: the previous text direction of @widget
853 * The ::direction-changed signal is emitted when the text direction
854 * of a widget changes.
856 widget_signals[DIRECTION_CHANGED] =
857 g_signal_new (I_("direction-changed"),
858 G_TYPE_FROM_CLASS (gobject_class),
860 G_STRUCT_OFFSET (GtkWidgetClass, direction_changed),
862 _gtk_marshal_VOID__ENUM,
864 GTK_TYPE_TEXT_DIRECTION);
867 * GtkWidget::grab-notify:
868 * @widget: the object which received the signal
869 * @was_grabbed: %FALSE if the widget becomes shadowed, %TRUE
870 * if it becomes unshadowed
872 * The ::grab-notify signal is emitted when a widget becomes
873 * shadowed by a GTK+ grab (not a pointer or keyboard grab) on
874 * another widget, or when it becomes unshadowed due to a grab
877 * A widget is shadowed by a gtk_grab_add() when the topmost
878 * grab widget in the grab stack of its window group is not
881 widget_signals[GRAB_NOTIFY] =
882 g_signal_new (I_("grab-notify"),
883 G_TYPE_FROM_CLASS (gobject_class),
885 G_STRUCT_OFFSET (GtkWidgetClass, grab_notify),
887 _gtk_marshal_VOID__BOOLEAN,
892 * GtkWidget::child-notify:
893 * @widget: the object which received the signal
894 * @pspec: the #GParamSpec of the changed child property
896 * The ::child-notify signal is emitted for each
897 * <link linkend="child-properties">child property</link> that has
898 * changed on an object. The signal's detail holds the property name.
900 widget_signals[CHILD_NOTIFY] =
901 g_signal_new (I_("child-notify"),
902 G_TYPE_FROM_CLASS (gobject_class),
903 G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE | G_SIGNAL_DETAILED | G_SIGNAL_NO_HOOKS,
904 G_STRUCT_OFFSET (GtkWidgetClass, child_notify),
906 g_cclosure_marshal_VOID__PARAM,
909 widget_signals[MNEMONIC_ACTIVATE] =
910 g_signal_new (I_("mnemonic-activate"),
911 G_TYPE_FROM_CLASS (gobject_class),
913 G_STRUCT_OFFSET (GtkWidgetClass, mnemonic_activate),
914 _gtk_boolean_handled_accumulator, NULL,
915 _gtk_marshal_BOOLEAN__BOOLEAN,
918 widget_signals[GRAB_FOCUS] =
919 g_signal_new (I_("grab-focus"),
920 G_TYPE_FROM_CLASS (gobject_class),
921 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
922 G_STRUCT_OFFSET (GtkWidgetClass, grab_focus),
924 _gtk_marshal_VOID__VOID,
926 widget_signals[FOCUS] =
927 g_signal_new (I_("focus"),
928 G_TYPE_FROM_CLASS (object_class),
930 G_STRUCT_OFFSET (GtkWidgetClass, focus),
931 _gtk_boolean_handled_accumulator, NULL,
932 _gtk_marshal_BOOLEAN__ENUM,
934 GTK_TYPE_DIRECTION_TYPE);
935 widget_signals[MOVE_FOCUS] =
936 g_signal_new_class_handler (I_("move-focus"),
937 G_TYPE_FROM_CLASS (object_class),
938 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
939 G_CALLBACK (gtk_widget_real_move_focus),
941 _gtk_marshal_VOID__ENUM,
944 GTK_TYPE_DIRECTION_TYPE);
947 * @widget: the object which received the signal.
948 * @event: the #GdkEvent which triggered this signal
950 * The GTK+ main loop will emit three signals for each GDK event delivered
951 * to a widget: one generic ::event signal, another, more specific,
952 * signal that matches the type of event delivered (e.g.
953 * #GtkWidget::key-press-event) and finally a generic
954 * #GtkWidget::event-after signal.
956 * Returns: %TRUE to stop other handlers from being invoked for the event
957 * and to cancel the emission of the second specific ::event signal.
958 * %FALSE to propagate the event further and to allow the emission of
959 * the second signal. The ::event-after signal is emitted regardless of
962 widget_signals[EVENT] =
963 g_signal_new (I_("event"),
964 G_TYPE_FROM_CLASS (gobject_class),
966 G_STRUCT_OFFSET (GtkWidgetClass, event),
967 _gtk_boolean_handled_accumulator, NULL,
968 _gtk_marshal_BOOLEAN__BOXED,
970 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
973 * GtkWidget::event-after:
974 * @widget: the object which received the signal.
975 * @event: the #GdkEvent which triggered this signal
977 * After the emission of the #GtkWidget::event signal and (optionally)
978 * the second more specific signal, ::event-after will be emitted
979 * regardless of the previous two signals handlers return values.
982 widget_signals[EVENT_AFTER] =
983 g_signal_new (I_("event-after"),
984 G_TYPE_FROM_CLASS (gobject_class),
988 _gtk_marshal_VOID__BOXED,
990 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
993 * GtkWidget::button-press-event:
994 * @widget: the object which received the signal.
995 * @event: the #GdkEventButton which triggered this signal
997 * The ::button-press-event signal will be emitted when a button
998 * (typically from a mouse) is pressed.
1000 * To receive this signal, the #GdkWindow associated to the
1001 * widget needs to enable the #GDK_BUTTON_PRESS_MASK mask.
1003 * This signal will be sent to the grab widget if there is one.
1005 * Returns: %TRUE to stop other handlers from being invoked for the event.
1006 * %FALSE to propagate the event further.
1008 widget_signals[BUTTON_PRESS_EVENT] =
1009 g_signal_new (I_("button-press-event"),
1010 G_TYPE_FROM_CLASS (gobject_class),
1012 G_STRUCT_OFFSET (GtkWidgetClass, button_press_event),
1013 _gtk_boolean_handled_accumulator, NULL,
1014 _gtk_marshal_BOOLEAN__BOXED,
1016 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1019 * GtkWidget::button-release-event:
1020 * @widget: the object which received the signal.
1021 * @event: the #GdkEventButton which triggered this signal
1023 * The ::button-release-event signal will be emitted when a button
1024 * (typically from a mouse) is released.
1026 * To receive this signal, the #GdkWindow associated to the
1027 * widget needs to enable the #GDK_BUTTON_RELEASE_MASK mask.
1029 * This signal will be sent to the grab widget if there is one.
1031 * Returns: %TRUE to stop other handlers from being invoked for the event.
1032 * %FALSE to propagate the event further.
1034 widget_signals[BUTTON_RELEASE_EVENT] =
1035 g_signal_new (I_("button-release-event"),
1036 G_TYPE_FROM_CLASS (gobject_class),
1038 G_STRUCT_OFFSET (GtkWidgetClass, button_release_event),
1039 _gtk_boolean_handled_accumulator, NULL,
1040 _gtk_marshal_BOOLEAN__BOXED,
1042 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1045 * GtkWidget::scroll-event:
1046 * @widget: the object which received the signal.
1047 * @event: the #GdkEventScroll which triggered this signal
1049 * The ::scroll-event signal is emitted when a button in the 4 to 7
1050 * range is pressed. Wheel mice are usually configured to generate
1051 * button press events for buttons 4 and 5 when the wheel is turned.
1053 * To receive this signal, the #GdkWindow associated to the widget needs
1054 * to enable the #GDK_BUTTON_PRESS_MASK mask.
1056 * This signal will be sent to the grab widget if there is one.
1058 * Returns: %TRUE to stop other handlers from being invoked for the event.
1059 * %FALSE to propagate the event further.
1061 widget_signals[SCROLL_EVENT] =
1062 g_signal_new (I_("scroll-event"),
1063 G_TYPE_FROM_CLASS (gobject_class),
1065 G_STRUCT_OFFSET (GtkWidgetClass, scroll_event),
1066 _gtk_boolean_handled_accumulator, NULL,
1067 _gtk_marshal_BOOLEAN__BOXED,
1069 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1071 * GtkWidget::motion-notify-event:
1072 * @widget: the object which received the signal.
1073 * @event: the #GdkEventMotion which triggered this signal
1075 * The ::motion-notify-event signal is emitted when the pointer moves
1076 * over the widget's #GdkWindow.
1078 * To receive this signal, the #GdkWindow associated to the widget
1079 * needs to enable the #GDK_POINTER_MOTION_MASK mask.
1081 * This signal will be sent to the grab widget if there is one.
1083 * Returns: %TRUE to stop other handlers from being invoked for the event.
1084 * %FALSE to propagate the event further.
1086 widget_signals[MOTION_NOTIFY_EVENT] =
1087 g_signal_new (I_("motion-notify-event"),
1088 G_TYPE_FROM_CLASS (gobject_class),
1090 G_STRUCT_OFFSET (GtkWidgetClass, motion_notify_event),
1091 _gtk_boolean_handled_accumulator, NULL,
1092 _gtk_marshal_BOOLEAN__BOXED,
1094 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1097 * GtkWidget::composited-changed:
1098 * @widget: the object on which the signal is emitted
1100 * The ::composited-changed signal is emitted when the composited
1101 * status of @widget<!-- -->s screen changes.
1102 * See gdk_screen_is_composited().
1104 widget_signals[COMPOSITED_CHANGED] =
1105 g_signal_new (I_("composited-changed"),
1106 G_TYPE_FROM_CLASS (gobject_class),
1107 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
1108 G_STRUCT_OFFSET (GtkWidgetClass, composited_changed),
1110 _gtk_marshal_VOID__VOID,
1114 * GtkWidget::keynav-failed:
1115 * @widget: the object which received the signal
1116 * @direction: the direction of movement
1118 * Gets emitted if keyboard navigation fails.
1119 * See gtk_widget_keynav_failed() for details.
1121 * Returns: %TRUE if stopping keyboard navigation is fine, %FALSE
1122 * if the emitting widget should try to handle the keyboard
1123 * navigation attempt in its parent container(s).
1127 widget_signals[KEYNAV_FAILED] =
1128 g_signal_new_class_handler (I_("keynav-failed"),
1129 G_TYPE_FROM_CLASS (gobject_class),
1131 G_CALLBACK (gtk_widget_real_keynav_failed),
1132 _gtk_boolean_handled_accumulator, NULL,
1133 _gtk_marshal_BOOLEAN__ENUM,
1135 GTK_TYPE_DIRECTION_TYPE);
1138 * GtkWidget::delete-event:
1139 * @widget: the object which received the signal
1140 * @event: the event which triggered this signal
1142 * The ::delete-event signal is emitted if a user requests that
1143 * a toplevel window is closed. The default handler for this signal
1144 * destroys the window. Connecting gtk_widget_hide_on_delete() to
1145 * this signal will cause the window to be hidden instead, so that
1146 * it can later be shown again without reconstructing it.
1148 * Returns: %TRUE to stop other handlers from being invoked for the event.
1149 * %FALSE to propagate the event further.
1151 widget_signals[DELETE_EVENT] =
1152 g_signal_new (I_("delete-event"),
1153 G_TYPE_FROM_CLASS (gobject_class),
1155 G_STRUCT_OFFSET (GtkWidgetClass, delete_event),
1156 _gtk_boolean_handled_accumulator, NULL,
1157 _gtk_marshal_BOOLEAN__BOXED,
1159 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1162 * GtkWidget::destroy-event:
1163 * @widget: the object which received the signal.
1164 * @event: the event which triggered this signal
1166 * The ::destroy-event signal is emitted when a #GdkWindow is destroyed.
1167 * You rarely get this signal, because most widgets disconnect themselves
1168 * from their window before they destroy it, so no widget owns the
1169 * window at destroy time.
1171 * To receive this signal, the #GdkWindow associated to the widget needs
1172 * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
1173 * automatically for all new windows.
1175 * Returns: %TRUE to stop other handlers from being invoked for the event.
1176 * %FALSE to propagate the event further.
1178 widget_signals[DESTROY_EVENT] =
1179 g_signal_new (I_("destroy-event"),
1180 G_TYPE_FROM_CLASS (gobject_class),
1182 G_STRUCT_OFFSET (GtkWidgetClass, destroy_event),
1183 _gtk_boolean_handled_accumulator, NULL,
1184 _gtk_marshal_BOOLEAN__BOXED,
1186 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1189 * GtkWidget::expose-event:
1190 * @widget: the object which received the signal.
1191 * @event: the #GdkEventExpose which triggered this signal
1193 * The ::expose-event signal is emitted when an area of a previously
1194 * obscured #GdkWindow is made visible and needs to be redrawn.
1195 * #GTK_NO_WINDOW widgets will get a synthesized event from their parent
1198 * To receive this signal, the #GdkWindow associated to the widget needs
1199 * to enable the #GDK_EXPOSURE_MASK mask.
1201 * Returns: %TRUE to stop other handlers from being invoked for the event.
1202 * %FALSE to propagate the event further.
1204 widget_signals[EXPOSE_EVENT] =
1205 g_signal_new (I_("expose-event"),
1206 G_TYPE_FROM_CLASS (gobject_class),
1208 G_STRUCT_OFFSET (GtkWidgetClass, expose_event),
1209 _gtk_boolean_handled_accumulator, NULL,
1210 _gtk_marshal_BOOLEAN__BOXED,
1212 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1215 * GtkWidget::key-press-event:
1216 * @widget: the object which received the signal
1217 * @event: the #GdkEventKey which triggered this signal
1219 * The ::key-press-event signal is emitted when a key is pressed.
1221 * To receive this signal, the #GdkWindow associated to the widget needs
1222 * to enable the #GDK_KEY_PRESS_MASK mask.
1224 * This signal will be sent to the grab widget if there is one.
1226 * Returns: %TRUE to stop other handlers from being invoked for the event.
1227 * %FALSE to propagate the event further.
1229 widget_signals[KEY_PRESS_EVENT] =
1230 g_signal_new (I_("key-press-event"),
1231 G_TYPE_FROM_CLASS (gobject_class),
1233 G_STRUCT_OFFSET (GtkWidgetClass, key_press_event),
1234 _gtk_boolean_handled_accumulator, NULL,
1235 _gtk_marshal_BOOLEAN__BOXED,
1237 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1240 * GtkWidget::key-release-event:
1241 * @widget: the object which received the signal
1242 * @event: the #GdkEventKey which triggered this signal
1244 * The ::key-release-event signal is emitted when a key is pressed.
1246 * To receive this signal, the #GdkWindow associated to the widget needs
1247 * to enable the #GDK_KEY_RELEASE_MASK mask.
1249 * This signal will be sent to the grab widget if there is one.
1251 * Returns: %TRUE to stop other handlers from being invoked for the event.
1252 * %FALSE to propagate the event further.
1254 widget_signals[KEY_RELEASE_EVENT] =
1255 g_signal_new (I_("key-release-event"),
1256 G_TYPE_FROM_CLASS (gobject_class),
1258 G_STRUCT_OFFSET (GtkWidgetClass, key_release_event),
1259 _gtk_boolean_handled_accumulator, NULL,
1260 _gtk_marshal_BOOLEAN__BOXED,
1262 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1265 * GtkWidget::enter-notify-event:
1266 * @widget: the object which received the signal
1267 * @event: the #GdkEventCrossing which triggered this signal
1269 * The ::enter-notify-event will be emitted when the pointer enters
1270 * the @widget's window.
1272 * To receive this signal, the #GdkWindow associated to the widget needs
1273 * to enable the #GDK_ENTER_NOTIFY_MASK mask.
1275 * This signal will be sent to the grab widget if there is one.
1277 * Returns: %TRUE to stop other handlers from being invoked for the event.
1278 * %FALSE to propagate the event further.
1280 widget_signals[ENTER_NOTIFY_EVENT] =
1281 g_signal_new (I_("enter-notify-event"),
1282 G_TYPE_FROM_CLASS (gobject_class),
1284 G_STRUCT_OFFSET (GtkWidgetClass, enter_notify_event),
1285 _gtk_boolean_handled_accumulator, NULL,
1286 _gtk_marshal_BOOLEAN__BOXED,
1288 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1291 * GtkWidget::leave-notify-event:
1292 * @widget: the object which received the signal
1293 * @event: the #GdkEventCrossing which triggered this signal
1295 * The ::leave-notify-event will be emitted when the pointer leaves
1296 * the @widget's window.
1298 * To receive this signal, the #GdkWindow associated to the widget needs
1299 * to enable the #GDK_LEAVE_NOTIFY_MASK mask.
1301 * This signal will be sent to the grab widget if there is one.
1303 * Returns: %TRUE to stop other handlers from being invoked for the event.
1304 * %FALSE to propagate the event further.
1306 widget_signals[LEAVE_NOTIFY_EVENT] =
1307 g_signal_new (I_("leave-notify-event"),
1308 G_TYPE_FROM_CLASS (gobject_class),
1310 G_STRUCT_OFFSET (GtkWidgetClass, leave_notify_event),
1311 _gtk_boolean_handled_accumulator, NULL,
1312 _gtk_marshal_BOOLEAN__BOXED,
1314 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1317 * GtkWidget::configure-event
1318 * @widget: the object which received the signal
1319 * @event: the #GdkEventConfigure which triggered this signal
1321 * The ::configure-event signal will be emitted when the size, position or
1322 * stacking of the @widget's window has changed.
1324 * To receive this signal, the #GdkWindow associated to the widget needs
1325 * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
1326 * automatically for all new windows.
1328 * Returns: %TRUE to stop other handlers from being invoked for the event.
1329 * %FALSE to propagate the event further.
1331 widget_signals[CONFIGURE_EVENT] =
1332 g_signal_new (I_("configure-event"),
1333 G_TYPE_FROM_CLASS (gobject_class),
1335 G_STRUCT_OFFSET (GtkWidgetClass, configure_event),
1336 _gtk_boolean_handled_accumulator, NULL,
1337 _gtk_marshal_BOOLEAN__BOXED,
1339 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1342 * GtkWidget::focus-in-event
1343 * @widget: the object which received the signal
1344 * @event: the #GdkEventFocus which triggered this signal
1346 * The ::focus-in-event signal will be emitted when the keyboard focus
1347 * enters the @widget's window.
1349 * To receive this signal, the #GdkWindow associated to the widget needs
1350 * to enable the #GDK_FOCUS_CHANGE_MASK mask.
1352 * Returns: %TRUE to stop other handlers from being invoked for the event.
1353 * %FALSE to propagate the event further.
1355 widget_signals[FOCUS_IN_EVENT] =
1356 g_signal_new (I_("focus-in-event"),
1357 G_TYPE_FROM_CLASS (gobject_class),
1359 G_STRUCT_OFFSET (GtkWidgetClass, focus_in_event),
1360 _gtk_boolean_handled_accumulator, NULL,
1361 _gtk_marshal_BOOLEAN__BOXED,
1363 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1366 * GtkWidget::focus-out-event
1367 * @widget: the object which received the signal
1368 * @event: the #GdkEventFocus which triggered this signal
1370 * The ::focus-out-event signal will be emitted when the keyboard focus
1371 * leaves the @widget's window.
1373 * To receive this signal, the #GdkWindow associated to the widget needs
1374 * to enable the #GDK_FOCUS_CHANGE_MASK mask.
1376 * Returns: %TRUE to stop other handlers from being invoked for the event.
1377 * %FALSE to propagate the event further.
1379 widget_signals[FOCUS_OUT_EVENT] =
1380 g_signal_new (I_("focus-out-event"),
1381 G_TYPE_FROM_CLASS (gobject_class),
1383 G_STRUCT_OFFSET (GtkWidgetClass, focus_out_event),
1384 _gtk_boolean_handled_accumulator, NULL,
1385 _gtk_marshal_BOOLEAN__BOXED,
1387 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1390 * GtkWidget::map-event
1391 * @widget: the object which received the signal
1392 * @event: the #GdkEventAny which triggered this signal
1394 * The ::map-event signal will be emitted when the @widget's window is
1395 * mapped. A window is mapped when it becomes visible on the screen.
1397 * To receive this signal, the #GdkWindow associated to the widget needs
1398 * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
1399 * automatically for all new windows.
1401 * Returns: %TRUE to stop other handlers from being invoked for the event.
1402 * %FALSE to propagate the event further.
1404 widget_signals[MAP_EVENT] =
1405 g_signal_new (I_("map-event"),
1406 G_TYPE_FROM_CLASS (gobject_class),
1408 G_STRUCT_OFFSET (GtkWidgetClass, map_event),
1409 _gtk_boolean_handled_accumulator, NULL,
1410 _gtk_marshal_BOOLEAN__BOXED,
1412 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1415 * GtkWidget::unmap-event
1416 * @widget: the object which received the signal
1417 * @event: the #GdkEventAny which triggered this signal
1419 * The ::unmap-event signal will be emitted when the @widget's window is
1420 * unmapped. A window is unmapped when it becomes invisible on the screen.
1422 * To receive this signal, the #GdkWindow associated to the widget needs
1423 * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
1424 * automatically for all new windows.
1426 * Returns: %TRUE to stop other handlers from being invoked for the event.
1427 * %FALSE to propagate the event further.
1429 widget_signals[UNMAP_EVENT] =
1430 g_signal_new (I_("unmap-event"),
1431 G_TYPE_FROM_CLASS (gobject_class),
1433 G_STRUCT_OFFSET (GtkWidgetClass, unmap_event),
1434 _gtk_boolean_handled_accumulator, NULL,
1435 _gtk_marshal_BOOLEAN__BOXED,
1437 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1440 * GtkWidget::property-notify-event
1441 * @widget: the object which received the signal
1442 * @event: the #GdkEventProperty which triggered this signal
1444 * The ::property-notify-event signal will be emitted when a property on
1445 * the @widget's window has been changed or deleted.
1447 * To receive this signal, the #GdkWindow associated to the widget needs
1448 * to enable the #GDK_PROPERTY_CHANGE_MASK mask.
1450 * Returns: %TRUE to stop other handlers from being invoked for the event.
1451 * %FALSE to propagate the event further.
1453 widget_signals[PROPERTY_NOTIFY_EVENT] =
1454 g_signal_new (I_("property-notify-event"),
1455 G_TYPE_FROM_CLASS (gobject_class),
1457 G_STRUCT_OFFSET (GtkWidgetClass, property_notify_event),
1458 _gtk_boolean_handled_accumulator, NULL,
1459 _gtk_marshal_BOOLEAN__BOXED,
1461 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1464 * GtkWidget::selection-clear-event
1465 * @widget: the object which received the signal
1466 * @event: the #GdkEventSelection which triggered this signal
1468 * The ::selection-clear-event signal will be emitted when the
1469 * the @widget's window has lost ownership of a selection.
1471 * Returns: %TRUE to stop other handlers from being invoked for the event.
1472 * %FALSE to propagate the event further.
1474 widget_signals[SELECTION_CLEAR_EVENT] =
1475 g_signal_new (I_("selection-clear-event"),
1476 G_TYPE_FROM_CLASS (gobject_class),
1478 G_STRUCT_OFFSET (GtkWidgetClass, selection_clear_event),
1479 _gtk_boolean_handled_accumulator, NULL,
1480 _gtk_marshal_BOOLEAN__BOXED,
1482 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1485 * GtkWidget::selection-request-event
1486 * @widget: the object which received the signal
1487 * @event: the #GdkEventSelection which triggered this signal
1489 * The ::selection-request-event signal will be emitted when
1490 * another client requests ownership of the selection owned by
1491 * the @widget's window.
1493 * Returns: %TRUE to stop other handlers from being invoked for the event.
1494 * %FALSE to propagate the event further.
1496 widget_signals[SELECTION_REQUEST_EVENT] =
1497 g_signal_new (I_("selection-request-event"),
1498 G_TYPE_FROM_CLASS (gobject_class),
1500 G_STRUCT_OFFSET (GtkWidgetClass, selection_request_event),
1501 _gtk_boolean_handled_accumulator, NULL,
1502 _gtk_marshal_BOOLEAN__BOXED,
1504 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1506 widget_signals[SELECTION_NOTIFY_EVENT] =
1507 g_signal_new (I_("selection-notify-event"),
1508 G_TYPE_FROM_CLASS (gobject_class),
1510 G_STRUCT_OFFSET (GtkWidgetClass, selection_notify_event),
1511 _gtk_boolean_handled_accumulator, NULL,
1512 _gtk_marshal_BOOLEAN__BOXED,
1514 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1516 widget_signals[SELECTION_RECEIVED] =
1517 g_signal_new (I_("selection-received"),
1518 G_TYPE_FROM_CLASS (gobject_class),
1520 G_STRUCT_OFFSET (GtkWidgetClass, selection_received),
1522 _gtk_marshal_VOID__BOXED_UINT,
1524 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
1527 widget_signals[SELECTION_GET] =
1528 g_signal_new (I_("selection-get"),
1529 G_TYPE_FROM_CLASS (gobject_class),
1531 G_STRUCT_OFFSET (GtkWidgetClass, selection_get),
1533 _gtk_marshal_VOID__BOXED_UINT_UINT,
1535 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
1540 * GtkWidget::proximity-in-event
1541 * @widget: the object which received the signal
1542 * @event: the #GdkEventProximity which triggered this signal
1544 * To receive this signal the #GdkWindow associated to the widget needs
1545 * to enable the #GDK_PROXIMITY_IN_MASK mask.
1547 * This signal will be sent to the grab widget if there is one.
1549 * Returns: %TRUE to stop other handlers from being invoked for the event.
1550 * %FALSE to propagate the event further.
1552 widget_signals[PROXIMITY_IN_EVENT] =
1553 g_signal_new (I_("proximity-in-event"),
1554 G_TYPE_FROM_CLASS (gobject_class),
1556 G_STRUCT_OFFSET (GtkWidgetClass, proximity_in_event),
1557 _gtk_boolean_handled_accumulator, NULL,
1558 _gtk_marshal_BOOLEAN__BOXED,
1560 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1563 * GtkWidget::proximity-out-event
1564 * @widget: the object which received the signal
1565 * @event: the #GdkEventProximity which triggered this signal
1567 * To receive this signal the #GdkWindow associated to the widget needs
1568 * to enable the #GDK_PROXIMITY_OUT_MASK mask.
1570 * This signal will be sent to the grab widget if there is one.
1572 * Returns: %TRUE to stop other handlers from being invoked for the event.
1573 * %FALSE to propagate the event further.
1575 widget_signals[PROXIMITY_OUT_EVENT] =
1576 g_signal_new (I_("proximity-out-event"),
1577 G_TYPE_FROM_CLASS (gobject_class),
1579 G_STRUCT_OFFSET (GtkWidgetClass, proximity_out_event),
1580 _gtk_boolean_handled_accumulator, NULL,
1581 _gtk_marshal_BOOLEAN__BOXED,
1583 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1586 * GtkWidget::drag-leave:
1587 * @widget: the object which received the signal.
1588 * @drag_context: the drag context
1589 * @time: the timestamp of the motion event
1591 * The ::drag-leave signal is emitted on the drop site when the cursor
1592 * leaves the widget. A typical reason to connect to this signal is to
1593 * undo things done in #GtkWidget::drag-motion, e.g. undo highlighting
1594 * with gtk_drag_unhighlight()
1596 widget_signals[DRAG_LEAVE] =
1597 g_signal_new (I_("drag-leave"),
1598 G_TYPE_FROM_CLASS (gobject_class),
1600 G_STRUCT_OFFSET (GtkWidgetClass, drag_leave),
1602 _gtk_marshal_VOID__OBJECT_UINT,
1604 GDK_TYPE_DRAG_CONTEXT,
1608 * GtkWidget::drag-begin:
1609 * @widget: the object which received the signal
1610 * @drag_context: the drag context
1612 * The ::drag-begin signal is emitted on the drag source when a drag is
1613 * started. A typical reason to connect to this signal is to set up a
1614 * custom drag icon with gtk_drag_source_set_icon().
1616 * Note that some widgets set up a drag icon in the default handler of
1617 * this signal, so you may have to use g_signal_connect_after() to
1618 * override what the default handler did.
1620 widget_signals[DRAG_BEGIN] =
1621 g_signal_new (I_("drag-begin"),
1622 G_TYPE_FROM_CLASS (gobject_class),
1624 G_STRUCT_OFFSET (GtkWidgetClass, drag_begin),
1626 _gtk_marshal_VOID__OBJECT,
1628 GDK_TYPE_DRAG_CONTEXT);
1631 * GtkWidget::drag-end:
1632 * @widget: the object which received the signal
1633 * @drag_context: the drag context
1635 * The ::drag-end signal is emitted on the drag source when a drag is
1636 * finished. A typical reason to connect to this signal is to undo
1637 * things done in #GtkWidget::drag-begin.
1639 widget_signals[DRAG_END] =
1640 g_signal_new (I_("drag-end"),
1641 G_TYPE_FROM_CLASS (gobject_class),
1643 G_STRUCT_OFFSET (GtkWidgetClass, drag_end),
1645 _gtk_marshal_VOID__OBJECT,
1647 GDK_TYPE_DRAG_CONTEXT);
1650 * GtkWidget::drag-data-delete:
1651 * @widget: the object which received the signal
1652 * @drag_context: the drag context
1654 * The ::drag-data-delete signal is emitted on the drag source when a drag
1655 * with the action %GDK_ACTION_MOVE is successfully completed. The signal
1656 * handler is responsible for deleting the data that has been dropped. What
1657 * "delete" means depends on the context of the drag operation.
1659 widget_signals[DRAG_DATA_DELETE] =
1660 g_signal_new (I_("drag-data-delete"),
1661 G_TYPE_FROM_CLASS (gobject_class),
1663 G_STRUCT_OFFSET (GtkWidgetClass, drag_data_delete),
1665 _gtk_marshal_VOID__OBJECT,
1667 GDK_TYPE_DRAG_CONTEXT);
1670 * GtkWidget::drag-failed:
1671 * @widget: the object which received the signal
1672 * @drag_context: the drag context
1673 * @result: the result of the drag operation
1675 * The ::drag-failed signal is emitted on the drag source when a drag has
1676 * failed. The signal handler may hook custom code to handle a failed DND
1677 * operation based on the type of error, it returns %TRUE is the failure has
1678 * been already handled (not showing the default "drag operation failed"
1679 * animation), otherwise it returns %FALSE.
1681 * Return value: %TRUE if the failed drag operation has been already handled.
1685 widget_signals[DRAG_FAILED] =
1686 g_signal_new (I_("drag-failed"),
1687 G_TYPE_FROM_CLASS (gobject_class),
1689 0, _gtk_boolean_handled_accumulator, NULL,
1690 _gtk_marshal_BOOLEAN__OBJECT_ENUM,
1692 GDK_TYPE_DRAG_CONTEXT,
1693 GTK_TYPE_DRAG_RESULT);
1696 * GtkWidget::drag-motion:
1697 * @widget: the object which received the signal
1698 * @drag_context: the drag context
1699 * @x: the x coordinate of the current cursor position
1700 * @y: the y coordinate of the current cursor position
1701 * @time: the timestamp of the motion event
1702 * @returns: whether the cursor position is in a drop zone
1704 * The drag-motion signal is emitted on the drop site when the user
1705 * moves the cursor over the widget during a drag. The signal handler
1706 * must determine whether the cursor position is in a drop zone or not.
1707 * If it is not in a drop zone, it returns %FALSE and no further processing
1708 * is necessary. Otherwise, the handler returns %TRUE. In this case, the
1709 * handler is responsible for providing the necessary information for
1710 * displaying feedback to the user, by calling gdk_drag_status().
1712 * If the decision whether the drop will be accepted or rejected can't be
1713 * made based solely on the cursor position and the type of the data, the
1714 * handler may inspect the dragged data by calling gtk_drag_get_data() and
1715 * defer the gdk_drag_status() call to the #GtkWidget::drag-data-received
1716 * handler. Note that you cannot not pass #GTK_DEST_DEFAULT_DROP,
1717 * #GTK_DEST_DEFAULT_MOTION or #GTK_DEST_DEFAULT_ALL to gtk_drag_dest_set()
1718 * when using the drag-motion signal that way.
1720 * Also note that there is no drag-enter signal. The drag receiver has to
1721 * keep track of whether he has received any drag-motion signals since the
1722 * last #GtkWidget::drag-leave and if not, treat the drag-motion signal as
1723 * an "enter" signal. Upon an "enter", the handler will typically highlight
1724 * the drop site with gtk_drag_highlight().
1727 * drag_motion (GtkWidget *widget,
1728 * GdkDragContext *context,
1735 * PrivateData *private_data = GET_PRIVATE_DATA (widget);
1737 * if (!private_data->drag_highlight)
1739 * private_data->drag_highlight = 1;
1740 * gtk_drag_highlight (widget);
1743 * target = gtk_drag_dest_find_target (widget, context, NULL);
1744 * if (target == GDK_NONE)
1745 * gdk_drag_status (context, 0, time);
1748 * private_data->pending_status = context->suggested_action;
1749 * gtk_drag_get_data (widget, context, target, time);
1756 * drag_data_received (GtkWidget *widget,
1757 * GdkDragContext *context,
1760 * GtkSelectionData *selection_data,
1764 * PrivateData *private_data = GET_PRIVATE_DATA (widget);
1766 * if (private_data->suggested_action)
1768 * private_data->suggested_action = 0;
1770 * /* We are getting this data due to a request in drag_motion,
1771 * * rather than due to a request in drag_drop, so we are just
1772 * * supposed to call gdk_drag_status (), not actually paste in
1775 * str = gtk_selection_data_get_text (selection_data);
1776 * if (!data_is_acceptable (str))
1777 * gdk_drag_status (context, 0, time);
1779 * gdk_drag_status (context, private_data->suggested_action, time);
1783 * /* accept the drop */
1788 widget_signals[DRAG_MOTION] =
1789 g_signal_new (I_("drag-motion"),
1790 G_TYPE_FROM_CLASS (gobject_class),
1792 G_STRUCT_OFFSET (GtkWidgetClass, drag_motion),
1793 _gtk_boolean_handled_accumulator, NULL,
1794 _gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
1796 GDK_TYPE_DRAG_CONTEXT,
1802 * GtkWidget::drag-drop:
1803 * @widget: the object which received the signal
1804 * @drag_context: the drag context
1805 * @x: the x coordinate of the current cursor position
1806 * @y: the y coordinate of the current cursor position
1807 * @time: the timestamp of the motion event
1808 * @returns: whether the cursor position is in a drop zone
1810 * The ::drag-drop signal is emitted on the drop site when the user drops
1811 * the data onto the widget. The signal handler must determine whether
1812 * the cursor position is in a drop zone or not. If it is not in a drop
1813 * zone, it returns %FALSE and no further processing is necessary.
1814 * Otherwise, the handler returns %TRUE. In this case, the handler must
1815 * ensure that gtk_drag_finish() is called to let the source know that
1816 * the drop is done. The call to gtk_drag_finish() can be done either
1817 * directly or in a #GtkWidget::drag-data-received handler which gets
1818 * triggered by calling gtk_drag_get_data() to receive the data for one
1819 * or more of the supported targets.
1821 widget_signals[DRAG_DROP] =
1822 g_signal_new (I_("drag-drop"),
1823 G_TYPE_FROM_CLASS (gobject_class),
1825 G_STRUCT_OFFSET (GtkWidgetClass, drag_drop),
1826 _gtk_boolean_handled_accumulator, NULL,
1827 _gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
1829 GDK_TYPE_DRAG_CONTEXT,
1835 * GtkWidget::drag-data-get:
1836 * @widget: the object which received the signal
1837 * @drag_context: the drag context
1838 * @data: the #GtkSelectionData to be filled with the dragged data
1839 * @info: the info that has been registered with the target in the
1841 * @time: the timestamp at which the data was requested
1843 * The ::drag-data-get signal is emitted on the drag source when the drop
1844 * site requests the data which is dragged. It is the responsibility of
1845 * the signal handler to fill @data with the data in the format which
1846 * is indicated by @info. See gtk_selection_data_set() and
1847 * gtk_selection_data_set_text().
1849 widget_signals[DRAG_DATA_GET] =
1850 g_signal_new (I_("drag-data-get"),
1851 G_TYPE_FROM_CLASS (gobject_class),
1853 G_STRUCT_OFFSET (GtkWidgetClass, drag_data_get),
1855 _gtk_marshal_VOID__OBJECT_BOXED_UINT_UINT,
1857 GDK_TYPE_DRAG_CONTEXT,
1858 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
1863 * GtkWidget::drag-data-received:
1864 * @widget: the object which received the signal
1865 * @drag_context: the drag context
1866 * @x: where the drop happened
1867 * @y: where the drop happened
1868 * @data: the received data
1869 * @info: the info that has been registered with the target in the
1871 * @time: the timestamp at which the data was received
1873 * The ::drag-data-received signal is emitted on the drop site when the
1874 * dragged data has been received. If the data was received in order to
1875 * determine whether the drop will be accepted, the handler is expected
1876 * to call gdk_drag_status() and <emphasis>not</emphasis> finish the drag.
1877 * If the data was received in response to a #GtkWidget::drag-drop signal
1878 * (and this is the last target to be received), the handler for this
1879 * signal is expected to process the received data and then call
1880 * gtk_drag_finish(), setting the @success parameter depending on whether
1881 * the data was processed successfully.
1883 * The handler may inspect and modify @drag_context->action before calling
1884 * gtk_drag_finish(), e.g. to implement %GDK_ACTION_ASK as shown in the
1885 * following example:
1888 * drag_data_received (GtkWidget *widget,
1889 * GdkDragContext *drag_context,
1892 * GtkSelectionData *data,
1896 * if ((data->length >= 0) && (data->format == 8))
1898 * if (drag_context->action == GDK_ACTION_ASK)
1900 * GtkWidget *dialog;
1903 * dialog = gtk_message_dialog_new (NULL,
1904 * GTK_DIALOG_MODAL |
1905 * GTK_DIALOG_DESTROY_WITH_PARENT,
1907 * GTK_BUTTONS_YES_NO,
1908 * "Move the data ?\n");
1909 * response = gtk_dialog_run (GTK_DIALOG (dialog));
1910 * gtk_widget_destroy (dialog);
1912 * if (response == GTK_RESPONSE_YES)
1913 * drag_context->action = GDK_ACTION_MOVE;
1915 * drag_context->action = GDK_ACTION_COPY;
1918 * gtk_drag_finish (drag_context, TRUE, FALSE, time);
1922 * gtk_drag_finish (drag_context, FALSE, FALSE, time);
1926 widget_signals[DRAG_DATA_RECEIVED] =
1927 g_signal_new (I_("drag-data-received"),
1928 G_TYPE_FROM_CLASS (gobject_class),
1930 G_STRUCT_OFFSET (GtkWidgetClass, drag_data_received),
1932 _gtk_marshal_VOID__OBJECT_INT_INT_BOXED_UINT_UINT,
1934 GDK_TYPE_DRAG_CONTEXT,
1937 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
1942 * GtkWidget::visibility-notify-event:
1943 * @widget: the object which received the signal
1944 * @event: the #GdkEventVisibility which triggered this signal
1946 * The ::visibility-notify-event will be emitted when the @widget's window
1947 * is obscured or unobscured.
1949 * To receive this signal the #GdkWindow associated to the widget needs
1950 * to enable the #GDK_VISIBILITY_NOTIFY_MASK mask.
1952 * Returns: %TRUE to stop other handlers from being invoked for the event.
1953 * %FALSE to propagate the event further.
1955 widget_signals[VISIBILITY_NOTIFY_EVENT] =
1956 g_signal_new (I_("visibility-notify-event"),
1957 G_TYPE_FROM_CLASS (gobject_class),
1959 G_STRUCT_OFFSET (GtkWidgetClass, visibility_notify_event),
1960 _gtk_boolean_handled_accumulator, NULL,
1961 _gtk_marshal_BOOLEAN__BOXED,
1963 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1966 * GtkWidget::client-event:
1967 * @widget: the object which received the signal
1968 * @event: the #GdkEventClient which triggered this signal
1970 * The ::client-event will be emitted when the @widget's window
1971 * receives a message (via a ClientMessage event) from another
1974 * Returns: %TRUE to stop other handlers from being invoked for
1975 * the event. %FALSE to propagate the event further.
1977 widget_signals[CLIENT_EVENT] =
1978 g_signal_new (I_("client-event"),
1979 G_TYPE_FROM_CLASS (gobject_class),
1981 G_STRUCT_OFFSET (GtkWidgetClass, client_event),
1982 _gtk_boolean_handled_accumulator, NULL,
1983 _gtk_marshal_BOOLEAN__BOXED,
1985 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1988 * GtkWidget::no-expose-event:
1989 * @widget: the object which received the signal
1990 * @event: the #GdkEventNoExpose which triggered this signal
1992 * The ::no-expose-event will be emitted when the @widget's window is
1993 * drawn as a copy of another #GdkDrawable (with gdk_draw_drawable() or
1994 * gdk_window_copy_area()) which was completely unobscured. If the source
1995 * window was partially obscured #GdkEventExpose events will be generated
1998 * Returns: %TRUE to stop other handlers from being invoked for the event.
1999 * %FALSE to propagate the event further.
2001 widget_signals[NO_EXPOSE_EVENT] =
2002 g_signal_new (I_("no-expose-event"),
2003 G_TYPE_FROM_CLASS (gobject_class),
2005 G_STRUCT_OFFSET (GtkWidgetClass, no_expose_event),
2006 _gtk_boolean_handled_accumulator, NULL,
2007 _gtk_marshal_BOOLEAN__BOXED,
2009 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2012 * GtkWidget::window-state-event:
2013 * @widget: the object which received the signal
2014 * @event: the #GdkEventWindowState which triggered this signal
2016 * The ::window-state-event will be emitted when the state of the
2017 * toplevel window associated to the @widget changes.
2019 * To receive this signal the #GdkWindow associated to the widget
2020 * needs to enable the #GDK_STRUCTURE_MASK mask. GDK will enable
2021 * this mask automatically for all new windows.
2023 * Returns: %TRUE to stop other handlers from being invoked for the
2024 * event. %FALSE to propagate the event further.
2026 widget_signals[WINDOW_STATE_EVENT] =
2027 g_signal_new (I_("window-state-event"),
2028 G_TYPE_FROM_CLASS (gobject_class),
2030 G_STRUCT_OFFSET (GtkWidgetClass, window_state_event),
2031 _gtk_boolean_handled_accumulator, NULL,
2032 _gtk_marshal_BOOLEAN__BOXED,
2034 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2037 * GtkWidget::damage-event:
2038 * @widget: the object which received the signal
2039 * @event: the #GdkEventExpose event
2041 * Emitted when a redirected window belonging to @widget gets drawn into.
2042 * The region/area members of the event shows what area of the redirected
2043 * drawable was drawn into.
2045 * Returns: %TRUE to stop other handlers from being invoked for the event.
2046 * %FALSE to propagate the event further.
2050 widget_signals[DAMAGE_EVENT] =
2051 g_signal_new (I_("damage-event"),
2052 G_TYPE_FROM_CLASS (gobject_class),
2055 _gtk_boolean_handled_accumulator, NULL,
2056 _gtk_marshal_BOOLEAN__BOXED,
2058 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2060 * GtkWidget::grab-broken-event:
2061 * @widget: the object which received the signal
2062 * @event: the #GdkEventGrabBroken event
2064 * Emitted when a pointer or keyboard grab on a window belonging
2065 * to @widget gets broken.
2067 * On X11, this happens when the grab window becomes unviewable
2068 * (i.e. it or one of its ancestors is unmapped), or if the same
2069 * application grabs the pointer or keyboard again.
2071 * Returns: %TRUE to stop other handlers from being invoked for
2072 * the event. %FALSE to propagate the event further.
2076 widget_signals[GRAB_BROKEN] =
2077 g_signal_new (I_("grab-broken-event"),
2078 G_TYPE_FROM_CLASS (gobject_class),
2080 G_STRUCT_OFFSET (GtkWidgetClass, grab_broken_event),
2081 _gtk_boolean_handled_accumulator, NULL,
2082 _gtk_marshal_BOOLEAN__BOXED,
2084 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2086 * GtkWidget::query-tooltip:
2087 * @widget: the object which received the signal
2088 * @x: the x coordinate of the cursor position where the request has
2089 * been emitted, relative to @widget->window
2090 * @y: the y coordinate of the cursor position where the request has
2091 * been emitted, relative to @widget->window
2092 * @keyboard_mode: %TRUE if the tooltip was trigged using the keyboard
2093 * @tooltip: a #GtkTooltip
2095 * Emitted when #GtkWidget:has-tooltip is %TRUE and the #GtkSettings:gtk-tooltip-timeout
2096 * has expired with the cursor hovering "above" @widget; or emitted when @widget got
2097 * focus in keyboard mode.
2099 * Using the given coordinates, the signal handler should determine
2100 * whether a tooltip should be shown for @widget. If this is the case
2101 * %TRUE should be returned, %FALSE otherwise. Note that if
2102 * @keyboard_mode is %TRUE, the values of @x and @y are undefined and
2103 * should not be used.
2105 * The signal handler is free to manipulate @tooltip with the therefore
2106 * destined function calls.
2108 * Returns: %TRUE if @tooltip should be shown right now, %FALSE otherwise.
2112 widget_signals[QUERY_TOOLTIP] =
2113 g_signal_new (I_("query-tooltip"),
2114 G_TYPE_FROM_CLASS (gobject_class),
2116 G_STRUCT_OFFSET (GtkWidgetClass, query_tooltip),
2117 _gtk_boolean_handled_accumulator, NULL,
2118 _gtk_marshal_BOOLEAN__INT_INT_BOOLEAN_OBJECT,
2126 * GtkWidget::popup-menu
2127 * @widget: the object which received the signal
2129 * This signal gets emitted whenever a widget should pop up a context
2130 * menu. This usually happens through the standard key binding mechanism;
2131 * by pressing a certain key while a widget is focused, the user can cause
2132 * the widget to pop up a menu. For example, the #GtkEntry widget creates
2133 * a menu with clipboard commands. See <xref linkend="checklist-popup-menu"/>
2134 * for an example of how to use this signal.
2136 * Returns: %TRUE if a menu was activated
2138 widget_signals[POPUP_MENU] =
2139 g_signal_new (I_("popup-menu"),
2140 G_TYPE_FROM_CLASS (gobject_class),
2141 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
2142 G_STRUCT_OFFSET (GtkWidgetClass, popup_menu),
2143 _gtk_boolean_handled_accumulator, NULL,
2144 _gtk_marshal_BOOLEAN__VOID,
2146 widget_signals[SHOW_HELP] =
2147 g_signal_new (I_("show-help"),
2148 G_TYPE_FROM_CLASS (gobject_class),
2149 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
2150 G_STRUCT_OFFSET (GtkWidgetClass, show_help),
2151 _gtk_boolean_handled_accumulator, NULL,
2152 _gtk_marshal_BOOLEAN__ENUM,
2154 GTK_TYPE_WIDGET_HELP_TYPE);
2155 widget_signals[ACCEL_CLOSURES_CHANGED] =
2156 g_signal_new (I_("accel-closures-changed"),
2157 G_TYPE_FROM_CLASS (gobject_class),
2161 _gtk_marshal_VOID__VOID,
2165 * GtkWidget::screen-changed:
2166 * @widget: the object on which the signal is emitted
2167 * @previous_screen: the previous screen, or %NULL if the
2168 * widget was not associated with a screen before
2170 * The ::screen-changed signal gets emitted when the
2171 * screen of a widget has changed.
2173 widget_signals[SCREEN_CHANGED] =
2174 g_signal_new (I_("screen-changed"),
2175 G_TYPE_FROM_CLASS (gobject_class),
2177 G_STRUCT_OFFSET (GtkWidgetClass, screen_changed),
2179 _gtk_marshal_VOID__OBJECT,
2183 * GtkWidget::can-activate-accel:
2184 * @widget: the object which received the signal
2185 * @signal_id: the ID of a signal installed on @widget
2187 * Determines whether an accelerator that activates the signal
2188 * identified by @signal_id can currently be activated.
2189 * This signal is present to allow applications and derived
2190 * widgets to override the default #GtkWidget handling
2191 * for determining whether an accelerator can be activated.
2193 * Returns: %TRUE if the signal can be activated.
2195 widget_signals[CAN_ACTIVATE_ACCEL] =
2196 g_signal_new (I_("can-activate-accel"),
2197 G_TYPE_FROM_CLASS (gobject_class),
2199 G_STRUCT_OFFSET (GtkWidgetClass, can_activate_accel),
2200 _gtk_boolean_handled_accumulator, NULL,
2201 _gtk_marshal_BOOLEAN__UINT,
2202 G_TYPE_BOOLEAN, 1, G_TYPE_UINT);
2204 binding_set = gtk_binding_set_by_class (klass);
2205 gtk_binding_entry_add_signal (binding_set, GDK_F10, GDK_SHIFT_MASK,
2207 gtk_binding_entry_add_signal (binding_set, GDK_Menu, 0,
2210 gtk_binding_entry_add_signal (binding_set, GDK_F1, GDK_CONTROL_MASK,
2212 GTK_TYPE_WIDGET_HELP_TYPE,
2213 GTK_WIDGET_HELP_TOOLTIP);
2214 gtk_binding_entry_add_signal (binding_set, GDK_KP_F1, GDK_CONTROL_MASK,
2216 GTK_TYPE_WIDGET_HELP_TYPE,
2217 GTK_WIDGET_HELP_TOOLTIP);
2218 gtk_binding_entry_add_signal (binding_set, GDK_F1, GDK_SHIFT_MASK,
2220 GTK_TYPE_WIDGET_HELP_TYPE,
2221 GTK_WIDGET_HELP_WHATS_THIS);
2222 gtk_binding_entry_add_signal (binding_set, GDK_KP_F1, GDK_SHIFT_MASK,
2224 GTK_TYPE_WIDGET_HELP_TYPE,
2225 GTK_WIDGET_HELP_WHATS_THIS);
2227 gtk_widget_class_install_style_property (klass,
2228 g_param_spec_boolean ("interior-focus",
2229 P_("Interior Focus"),
2230 P_("Whether to draw the focus indicator inside widgets"),
2232 GTK_PARAM_READABLE));
2234 gtk_widget_class_install_style_property (klass,
2235 g_param_spec_int ("focus-line-width",
2236 P_("Focus linewidth"),
2237 P_("Width, in pixels, of the focus indicator line"),
2239 GTK_PARAM_READABLE));
2241 gtk_widget_class_install_style_property (klass,
2242 g_param_spec_string ("focus-line-pattern",
2243 P_("Focus line dash pattern"),
2244 P_("Dash pattern used to draw the focus indicator"),
2246 GTK_PARAM_READABLE));
2247 gtk_widget_class_install_style_property (klass,
2248 g_param_spec_int ("focus-padding",
2249 P_("Focus padding"),
2250 P_("Width, in pixels, between focus indicator and the widget 'box'"),
2252 GTK_PARAM_READABLE));
2253 gtk_widget_class_install_style_property (klass,
2254 g_param_spec_boxed ("cursor-color",
2256 P_("Color with which to draw insertion cursor"),
2258 GTK_PARAM_READABLE));
2259 gtk_widget_class_install_style_property (klass,
2260 g_param_spec_boxed ("secondary-cursor-color",
2261 P_("Secondary cursor color"),
2262 P_("Color with which to draw the secondary insertion cursor when editing mixed right-to-left and left-to-right text"),
2264 GTK_PARAM_READABLE));
2265 gtk_widget_class_install_style_property (klass,
2266 g_param_spec_float ("cursor-aspect-ratio",
2267 P_("Cursor line aspect ratio"),
2268 P_("Aspect ratio with which to draw insertion cursor"),
2270 GTK_PARAM_READABLE));
2273 * GtkWidget:draw-border:
2275 * The "draw-border" style property defines the size of areas outside
2276 * the widget's allocation to draw.
2280 gtk_widget_class_install_style_property (klass,
2281 g_param_spec_boxed ("draw-border",
2283 P_("Size of areas outside the widget's allocation to draw"),
2285 GTK_PARAM_READABLE));
2288 * GtkWidget:link-color:
2290 * The "link-color" style property defines the color of unvisited links.
2294 gtk_widget_class_install_style_property (klass,
2295 g_param_spec_boxed ("link-color",
2296 P_("Unvisited Link Color"),
2297 P_("Color of unvisited links"),
2299 GTK_PARAM_READABLE));
2302 * GtkWidget:visited-link-color:
2304 * The "visited-link-color" style property defines the color of visited links.
2308 gtk_widget_class_install_style_property (klass,
2309 g_param_spec_boxed ("visited-link-color",
2310 P_("Visited Link Color"),
2311 P_("Color of visited links"),
2313 GTK_PARAM_READABLE));
2316 * GtkWidget:wide-separators:
2318 * The "wide-separators" style property defines whether separators have
2319 * configurable width and should be drawn using a box instead of a line.
2323 gtk_widget_class_install_style_property (klass,
2324 g_param_spec_boolean ("wide-separators",
2325 P_("Wide Separators"),
2326 P_("Whether separators have configurable width and should be drawn using a box instead of a line"),
2328 GTK_PARAM_READABLE));
2331 * GtkWidget:separator-width:
2333 * The "separator-width" style property defines the width of separators.
2334 * This property only takes effect if #GtkWidget:wide-separators is %TRUE.
2338 gtk_widget_class_install_style_property (klass,
2339 g_param_spec_int ("separator-width",
2340 P_("Separator Width"),
2341 P_("The width of separators if wide-separators is TRUE"),
2343 GTK_PARAM_READABLE));
2346 * GtkWidget:separator-height:
2348 * The "separator-height" style property defines the height of separators.
2349 * This property only takes effect if #GtkWidget:wide-separators is %TRUE.
2353 gtk_widget_class_install_style_property (klass,
2354 g_param_spec_int ("separator-height",
2355 P_("Separator Height"),
2356 P_("The height of separators if \"wide-separators\" is TRUE"),
2358 GTK_PARAM_READABLE));
2361 * GtkWidget:scroll-arrow-hlength:
2363 * The "scroll-arrow-hlength" style property defines the length of
2364 * horizontal scroll arrows.
2368 gtk_widget_class_install_style_property (klass,
2369 g_param_spec_int ("scroll-arrow-hlength",
2370 P_("Horizontal Scroll Arrow Length"),
2371 P_("The length of horizontal scroll arrows"),
2373 GTK_PARAM_READABLE));
2376 * GtkWidget:scroll-arrow-vlength:
2378 * The "scroll-arrow-vlength" style property defines the length of
2379 * vertical scroll arrows.
2383 gtk_widget_class_install_style_property (klass,
2384 g_param_spec_int ("scroll-arrow-vlength",
2385 P_("Vertical Scroll Arrow Length"),
2386 P_("The length of vertical scroll arrows"),
2388 GTK_PARAM_READABLE));
2392 gtk_widget_base_class_finalize (GtkWidgetClass *klass)
2396 list = g_param_spec_pool_list_owned (style_property_spec_pool, G_OBJECT_CLASS_TYPE (klass));
2397 for (node = list; node; node = node->next)
2399 GParamSpec *pspec = node->data;
2401 g_param_spec_pool_remove (style_property_spec_pool, pspec);
2402 g_param_spec_unref (pspec);
2408 gtk_widget_set_property (GObject *object,
2410 const GValue *value,
2413 GtkWidget *widget = GTK_WIDGET (object);
2418 guint32 saved_flags;
2419 gchar *tooltip_markup;
2420 const gchar *tooltip_text;
2421 GtkWindow *tooltip_window;
2424 gtk_widget_set_name (widget, g_value_get_string (value));
2427 gtk_container_add (GTK_CONTAINER (g_value_get_object (value)), widget);
2429 case PROP_WIDTH_REQUEST:
2430 gtk_widget_set_usize_internal (widget, g_value_get_int (value), -2);
2432 case PROP_HEIGHT_REQUEST:
2433 gtk_widget_set_usize_internal (widget, -2, g_value_get_int (value));
2436 if (g_value_get_boolean (value))
2437 gtk_widget_show (widget);
2439 gtk_widget_hide (widget);
2441 case PROP_SENSITIVE:
2442 gtk_widget_set_sensitive (widget, g_value_get_boolean (value));
2444 case PROP_APP_PAINTABLE:
2445 gtk_widget_set_app_paintable (widget, g_value_get_boolean (value));
2447 case PROP_CAN_FOCUS:
2448 saved_flags = GTK_WIDGET_FLAGS (widget);
2449 if (g_value_get_boolean (value))
2450 GTK_WIDGET_SET_FLAGS (widget, GTK_CAN_FOCUS);
2452 GTK_WIDGET_UNSET_FLAGS (widget, GTK_CAN_FOCUS);
2453 if (saved_flags != GTK_WIDGET_FLAGS (widget))
2454 gtk_widget_queue_resize (widget);
2456 case PROP_HAS_FOCUS:
2457 if (g_value_get_boolean (value))
2458 gtk_widget_grab_focus (widget);
2461 if (g_value_get_boolean (value))
2462 gtk_widget_grab_focus (widget);
2464 case PROP_CAN_DEFAULT:
2465 saved_flags = GTK_WIDGET_FLAGS (widget);
2466 if (g_value_get_boolean (value))
2467 GTK_WIDGET_SET_FLAGS (widget, GTK_CAN_DEFAULT);
2469 GTK_WIDGET_UNSET_FLAGS (widget, GTK_CAN_DEFAULT);
2470 if (saved_flags != GTK_WIDGET_FLAGS (widget))
2471 gtk_widget_queue_resize (widget);
2473 case PROP_HAS_DEFAULT:
2474 if (g_value_get_boolean (value))
2475 gtk_widget_grab_default (widget);
2477 case PROP_RECEIVES_DEFAULT:
2478 if (g_value_get_boolean (value))
2479 GTK_WIDGET_SET_FLAGS (widget, GTK_RECEIVES_DEFAULT);
2481 GTK_WIDGET_UNSET_FLAGS (widget, GTK_RECEIVES_DEFAULT);
2484 gtk_widget_set_style (widget, g_value_get_object (value));
2487 if (!GTK_WIDGET_REALIZED (widget) && !GTK_WIDGET_NO_WINDOW (widget))
2488 gtk_widget_set_events (widget, g_value_get_flags (value));
2490 case PROP_EXTENSION_EVENTS:
2491 gtk_widget_set_extension_events (widget, g_value_get_enum (value));
2493 case PROP_NO_SHOW_ALL:
2494 gtk_widget_set_no_show_all (widget, g_value_get_boolean (value));
2496 case PROP_HAS_TOOLTIP:
2497 gtk_widget_real_set_has_tooltip (widget,
2498 g_value_get_boolean (value), FALSE);
2500 case PROP_TOOLTIP_MARKUP:
2501 tooltip_window = g_object_get_qdata (object, quark_tooltip_window);
2502 tooltip_markup = g_value_dup_string (value);
2504 /* Treat an empty string as a NULL string,
2505 * because an empty string would be useless for a tooltip:
2507 if (tooltip_markup && (strlen (tooltip_markup) == 0))
2509 g_free (tooltip_markup);
2510 tooltip_markup = NULL;
2513 g_object_set_qdata_full (object, quark_tooltip_markup,
2514 tooltip_markup, g_free);
2516 tmp = (tooltip_window != NULL || tooltip_markup != NULL);
2517 gtk_widget_real_set_has_tooltip (widget, tmp, FALSE);
2518 if (GTK_WIDGET_VISIBLE (widget))
2519 gtk_widget_queue_tooltip_query (widget);
2521 case PROP_TOOLTIP_TEXT:
2522 tooltip_window = g_object_get_qdata (object, quark_tooltip_window);
2524 tooltip_text = g_value_get_string (value);
2526 /* Treat an empty string as a NULL string,
2527 * because an empty string would be useless for a tooltip:
2529 if (tooltip_text && (strlen (tooltip_text) == 0))
2530 tooltip_text = NULL;
2532 tooltip_markup = tooltip_text ? g_markup_escape_text (tooltip_text, -1) : NULL;
2534 g_object_set_qdata_full (object, quark_tooltip_markup,
2535 tooltip_markup, g_free);
2537 tmp = (tooltip_window != NULL || tooltip_markup != NULL);
2538 gtk_widget_real_set_has_tooltip (widget, tmp, FALSE);
2539 if (GTK_WIDGET_VISIBLE (widget))
2540 gtk_widget_queue_tooltip_query (widget);
2542 case PROP_DOUBLE_BUFFERED:
2543 gtk_widget_set_double_buffered (widget, g_value_get_boolean (value));
2546 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2552 gtk_widget_get_property (GObject *object,
2557 GtkWidget *widget = GTK_WIDGET (object);
2566 g_value_set_string (value, widget->name);
2568 g_value_set_static_string (value, "");
2571 g_value_set_object (value, widget->parent);
2573 case PROP_WIDTH_REQUEST:
2576 gtk_widget_get_size_request (widget, &w, NULL);
2577 g_value_set_int (value, w);
2580 case PROP_HEIGHT_REQUEST:
2583 gtk_widget_get_size_request (widget, NULL, &h);
2584 g_value_set_int (value, h);
2588 g_value_set_boolean (value, (GTK_WIDGET_VISIBLE (widget) != FALSE));
2590 case PROP_SENSITIVE:
2591 g_value_set_boolean (value, (GTK_WIDGET_SENSITIVE (widget) != FALSE));
2593 case PROP_APP_PAINTABLE:
2594 g_value_set_boolean (value, (GTK_WIDGET_APP_PAINTABLE (widget) != FALSE));
2596 case PROP_CAN_FOCUS:
2597 g_value_set_boolean (value, (GTK_WIDGET_CAN_FOCUS (widget) != FALSE));
2599 case PROP_HAS_FOCUS:
2600 g_value_set_boolean (value, (GTK_WIDGET_HAS_FOCUS (widget) != FALSE));
2603 g_value_set_boolean (value, (gtk_widget_is_focus (widget)));
2605 case PROP_CAN_DEFAULT:
2606 g_value_set_boolean (value, (GTK_WIDGET_CAN_DEFAULT (widget) != FALSE));
2608 case PROP_HAS_DEFAULT:
2609 g_value_set_boolean (value, (GTK_WIDGET_HAS_DEFAULT (widget) != FALSE));
2611 case PROP_RECEIVES_DEFAULT:
2612 g_value_set_boolean (value, (GTK_WIDGET_RECEIVES_DEFAULT (widget) != FALSE));
2614 case PROP_COMPOSITE_CHILD:
2615 g_value_set_boolean (value, (GTK_WIDGET_COMPOSITE_CHILD (widget) != FALSE));
2618 g_value_set_object (value, gtk_widget_get_style (widget));
2621 eventp = g_object_get_qdata (G_OBJECT (widget), quark_event_mask);
2622 g_value_set_flags (value, GPOINTER_TO_INT (eventp));
2624 case PROP_EXTENSION_EVENTS:
2625 modep = g_object_get_qdata (G_OBJECT (widget), quark_extension_event_mode);
2626 g_value_set_enum (value, GPOINTER_TO_INT (modep));
2628 case PROP_NO_SHOW_ALL:
2629 g_value_set_boolean (value, gtk_widget_get_no_show_all (widget));
2631 case PROP_HAS_TOOLTIP:
2632 g_value_set_boolean (value, GPOINTER_TO_UINT (g_object_get_qdata (object, quark_has_tooltip)));
2634 case PROP_TOOLTIP_TEXT:
2636 gchar *escaped = g_object_get_qdata (object, quark_tooltip_markup);
2639 if (escaped && !pango_parse_markup (escaped, -1, 0, NULL, &text, NULL, NULL))
2640 g_assert (NULL == text); /* text should still be NULL in case of markup errors */
2642 g_value_set_string (value, text);
2646 case PROP_TOOLTIP_MARKUP:
2647 g_value_set_string (value, g_object_get_qdata (object, quark_tooltip_markup));
2650 g_value_set_object (value, gtk_widget_get_window (widget));
2652 case PROP_DOUBLE_BUFFERED:
2653 g_value_set_boolean (value, gtk_widget_get_double_buffered (widget));
2656 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2662 gtk_widget_init (GtkWidget *widget)
2664 GTK_PRIVATE_FLAGS (widget) = PRIVATE_GTK_CHILD_VISIBLE;
2665 widget->state = GTK_STATE_NORMAL;
2666 widget->saved_state = GTK_STATE_NORMAL;
2667 widget->name = NULL;
2668 widget->requisition.width = 0;
2669 widget->requisition.height = 0;
2670 widget->allocation.x = -1;
2671 widget->allocation.y = -1;
2672 widget->allocation.width = 1;
2673 widget->allocation.height = 1;
2674 widget->window = NULL;
2675 widget->parent = NULL;
2677 GTK_WIDGET_SET_FLAGS (widget,
2679 GTK_PARENT_SENSITIVE |
2680 (composite_child_stack ? GTK_COMPOSITE_CHILD : 0) |
2681 GTK_DOUBLE_BUFFERED);
2683 GTK_PRIVATE_SET_FLAG (widget, GTK_REDRAW_ON_ALLOC);
2684 GTK_PRIVATE_SET_FLAG (widget, GTK_REQUEST_NEEDED);
2685 GTK_PRIVATE_SET_FLAG (widget, GTK_ALLOC_NEEDED);
2687 widget->style = gtk_widget_get_default_style ();
2688 g_object_ref (widget->style);
2693 gtk_widget_dispatch_child_properties_changed (GtkWidget *widget,
2695 GParamSpec **pspecs)
2697 GtkWidget *container = widget->parent;
2700 for (i = 0; widget->parent == container && i < n_pspecs; i++)
2701 g_signal_emit (widget, widget_signals[CHILD_NOTIFY], g_quark_from_string (pspecs[i]->name), pspecs[i]);
2705 * gtk_widget_freeze_child_notify:
2706 * @widget: a #GtkWidget
2708 * Stops emission of #GtkWidget::child-notify signals on @widget. The
2709 * signals are queued until gtk_widget_thaw_child_notify() is called
2712 * This is the analogue of g_object_freeze_notify() for child properties.
2715 gtk_widget_freeze_child_notify (GtkWidget *widget)
2717 g_return_if_fail (GTK_IS_WIDGET (widget));
2719 if (!G_OBJECT (widget)->ref_count)
2722 g_object_ref (widget);
2723 g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
2724 g_object_unref (widget);
2728 * gtk_widget_child_notify:
2729 * @widget: a #GtkWidget
2730 * @child_property: the name of a child property installed on the
2731 * class of @widget<!-- -->'s parent
2733 * Emits a #GtkWidget::child-notify signal for the
2734 * <link linkend="child-properties">child property</link> @child_property
2737 * This is the analogue of g_object_notify() for child properties.
2740 gtk_widget_child_notify (GtkWidget *widget,
2741 const gchar *child_property)
2745 g_return_if_fail (GTK_IS_WIDGET (widget));
2746 g_return_if_fail (child_property != NULL);
2747 if (!G_OBJECT (widget)->ref_count || !widget->parent)
2750 g_object_ref (widget);
2751 pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
2753 G_OBJECT_TYPE (widget->parent),
2756 g_warning ("%s: container class `%s' has no child property named `%s'",
2758 G_OBJECT_TYPE_NAME (widget->parent),
2762 GObjectNotifyQueue *nqueue = g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
2764 g_object_notify_queue_add (G_OBJECT (widget), nqueue, pspec);
2765 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
2767 g_object_unref (widget);
2771 * gtk_widget_thaw_child_notify:
2772 * @widget: a #GtkWidget
2774 * Reverts the effect of a previous call to gtk_widget_freeze_child_notify().
2775 * This causes all queued #GtkWidget::child-notify signals on @widget to be
2779 gtk_widget_thaw_child_notify (GtkWidget *widget)
2781 GObjectNotifyQueue *nqueue;
2783 g_return_if_fail (GTK_IS_WIDGET (widget));
2785 if (!G_OBJECT (widget)->ref_count)
2788 g_object_ref (widget);
2789 nqueue = g_object_notify_queue_from_object (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
2790 if (!nqueue || !nqueue->freeze_count)
2791 g_warning (G_STRLOC ": child-property-changed notification for %s(%p) is not frozen",
2792 G_OBJECT_TYPE_NAME (widget), widget);
2794 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
2795 g_object_unref (widget);
2801 * @type: type ID of the widget to create
2802 * @first_property_name: name of first property to set
2803 * @Varargs: value of first property, followed by more properties,
2806 * This is a convenience function for creating a widget and setting
2807 * its properties in one go. For example you might write:
2808 * <literal>gtk_widget_new (GTK_TYPE_LABEL, "label", "Hello World", "xalign",
2809 * 0.0, NULL)</literal> to create a left-aligned label. Equivalent to
2810 * g_object_new(), but returns a widget so you don't have to
2811 * cast the object yourself.
2813 * Return value: a new #GtkWidget of type @widget_type
2816 gtk_widget_new (GType type,
2817 const gchar *first_property_name,
2823 g_return_val_if_fail (g_type_is_a (type, GTK_TYPE_WIDGET), NULL);
2825 va_start (var_args, first_property_name);
2826 widget = (GtkWidget *)g_object_new_valist (type, first_property_name, var_args);
2834 * @widget: a #GtkWidget
2835 * @first_property_name: name of first property to set
2836 * @Varargs: value of first property, followed by more properties,
2839 * Precursor of g_object_set().
2841 * Deprecated: 2.0: Use g_object_set() instead.
2844 gtk_widget_set (GtkWidget *widget,
2845 const gchar *first_property_name,
2850 g_return_if_fail (GTK_IS_WIDGET (widget));
2852 va_start (var_args, first_property_name);
2853 g_object_set_valist (G_OBJECT (widget), first_property_name, var_args);
2858 gtk_widget_queue_draw_child (GtkWidget *widget)
2862 parent = widget->parent;
2863 if (parent && GTK_WIDGET_DRAWABLE (parent))
2864 gtk_widget_queue_draw_area (parent,
2865 widget->allocation.x,
2866 widget->allocation.y,
2867 widget->allocation.width,
2868 widget->allocation.height);
2872 * gtk_widget_unparent:
2873 * @widget: a #GtkWidget
2875 * This function is only for use in widget implementations.
2876 * Should be called by implementations of the remove method
2877 * on #GtkContainer, to dissociate a child from the container.
2880 gtk_widget_unparent (GtkWidget *widget)
2882 GObjectNotifyQueue *nqueue;
2883 GtkWidget *toplevel;
2884 GtkWidget *old_parent;
2886 g_return_if_fail (GTK_IS_WIDGET (widget));
2887 if (widget->parent == NULL)
2890 /* keep this function in sync with gtk_menu_detach()
2893 g_object_freeze_notify (G_OBJECT (widget));
2894 nqueue = g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
2896 toplevel = gtk_widget_get_toplevel (widget);
2897 if (GTK_WIDGET_TOPLEVEL (toplevel))
2898 _gtk_window_unset_focus_and_default (GTK_WINDOW (toplevel), widget);
2900 if (GTK_CONTAINER (widget->parent)->focus_child == widget)
2901 gtk_container_set_focus_child (GTK_CONTAINER (widget->parent), NULL);
2903 /* If we are unanchoring the child, we save around the toplevel
2904 * to emit hierarchy changed
2906 if (GTK_WIDGET_ANCHORED (widget->parent))
2907 g_object_ref (toplevel);
2911 gtk_widget_queue_draw_child (widget);
2913 /* Reset the width and height here, to force reallocation if we
2914 * get added back to a new parent. This won't work if our new
2915 * allocation is smaller than 1x1 and we actually want a size of 1x1...
2916 * (would 0x0 be OK here?)
2918 widget->allocation.width = 1;
2919 widget->allocation.height = 1;
2921 if (GTK_WIDGET_REALIZED (widget))
2923 if (GTK_WIDGET_IN_REPARENT (widget))
2924 gtk_widget_unmap (widget);
2926 gtk_widget_unrealize (widget);
2929 /* Removing a widget from a container restores the child visible
2930 * flag to the default state, so it doesn't affect the child
2931 * in the next parent.
2933 GTK_PRIVATE_SET_FLAG (widget, GTK_CHILD_VISIBLE);
2935 old_parent = widget->parent;
2936 widget->parent = NULL;
2937 gtk_widget_set_parent_window (widget, NULL);
2938 g_signal_emit (widget, widget_signals[PARENT_SET], 0, old_parent);
2941 _gtk_widget_propagate_hierarchy_changed (widget, toplevel);
2942 g_object_unref (toplevel);
2945 g_object_notify (G_OBJECT (widget), "parent");
2946 g_object_thaw_notify (G_OBJECT (widget));
2947 if (!widget->parent)
2948 g_object_notify_queue_clear (G_OBJECT (widget), nqueue);
2949 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
2950 g_object_unref (widget);
2954 * gtk_widget_destroy:
2955 * @widget: a #GtkWidget
2957 * Destroys a widget. Equivalent to gtk_object_destroy(), except that
2958 * you don't have to cast the widget to #GtkObject. When a widget is
2959 * destroyed, it will break any references it holds to other objects.
2960 * If the widget is inside a container, the widget will be removed
2961 * from the container. If the widget is a toplevel (derived from
2962 * #GtkWindow), it will be removed from the list of toplevels, and the
2963 * reference GTK+ holds to it will be removed. Removing a
2964 * widget from its container or the list of toplevels results in the
2965 * widget being finalized, unless you've added additional references
2966 * to the widget with g_object_ref().
2968 * In most cases, only toplevel widgets (windows) require explicit
2969 * destruction, because when you destroy a toplevel its children will
2970 * be destroyed as well.
2973 gtk_widget_destroy (GtkWidget *widget)
2975 g_return_if_fail (GTK_IS_WIDGET (widget));
2977 gtk_object_destroy ((GtkObject*) widget);
2981 * gtk_widget_destroyed:
2982 * @widget: a #GtkWidget
2983 * @widget_pointer: address of a variable that contains @widget
2985 * This function sets *@widget_pointer to %NULL if @widget_pointer !=
2986 * %NULL. It's intended to be used as a callback connected to the
2987 * "destroy" signal of a widget. You connect gtk_widget_destroyed()
2988 * as a signal handler, and pass the address of your widget variable
2989 * as user data. Then when the widget is destroyed, the variable will
2990 * be set to %NULL. Useful for example to avoid multiple copies
2991 * of the same dialog.
2994 gtk_widget_destroyed (GtkWidget *widget,
2995 GtkWidget **widget_pointer)
2997 /* Don't make any assumptions about the
2999 * Even check widget_pointer.
3002 *widget_pointer = NULL;
3007 * @widget: a #GtkWidget
3009 * Flags a widget to be displayed. Any widget that isn't shown will
3010 * not appear on the screen. If you want to show all the widgets in a
3011 * container, it's easier to call gtk_widget_show_all() on the
3012 * container, instead of individually showing the widgets.
3014 * Remember that you have to show the containers containing a widget,
3015 * in addition to the widget itself, before it will appear onscreen.
3017 * When a toplevel container is shown, it is immediately realized and
3018 * mapped; other shown widgets are realized and mapped when their
3019 * toplevel container is realized and mapped.
3022 gtk_widget_show (GtkWidget *widget)
3024 g_return_if_fail (GTK_IS_WIDGET (widget));
3026 if (!GTK_WIDGET_VISIBLE (widget))
3028 g_object_ref (widget);
3029 if (!GTK_WIDGET_TOPLEVEL (widget))
3030 gtk_widget_queue_resize (widget);
3031 g_signal_emit (widget, widget_signals[SHOW], 0);
3032 g_object_notify (G_OBJECT (widget), "visible");
3033 g_object_unref (widget);
3038 gtk_widget_real_show (GtkWidget *widget)
3040 if (!GTK_WIDGET_VISIBLE (widget))
3042 GTK_WIDGET_SET_FLAGS (widget, GTK_VISIBLE);
3044 if (widget->parent &&
3045 GTK_WIDGET_MAPPED (widget->parent) &&
3046 GTK_WIDGET_CHILD_VISIBLE (widget) &&
3047 !GTK_WIDGET_MAPPED (widget))
3048 gtk_widget_map (widget);
3053 gtk_widget_show_map_callback (GtkWidget *widget, GdkEvent *event, gint *flag)
3056 g_signal_handlers_disconnect_by_func (widget,
3057 gtk_widget_show_map_callback,
3062 * gtk_widget_show_now:
3063 * @widget: a #GtkWidget
3065 * Shows a widget. If the widget is an unmapped toplevel widget
3066 * (i.e. a #GtkWindow that has not yet been shown), enter the main
3067 * loop and wait for the window to actually be mapped. Be careful;
3068 * because the main loop is running, anything can happen during
3072 gtk_widget_show_now (GtkWidget *widget)
3076 g_return_if_fail (GTK_IS_WIDGET (widget));
3078 /* make sure we will get event */
3079 if (!GTK_WIDGET_MAPPED (widget) &&
3080 GTK_WIDGET_TOPLEVEL (widget))
3082 gtk_widget_show (widget);
3084 g_signal_connect (widget, "map-event",
3085 G_CALLBACK (gtk_widget_show_map_callback),
3089 gtk_main_iteration ();
3092 gtk_widget_show (widget);
3097 * @widget: a #GtkWidget
3099 * Reverses the effects of gtk_widget_show(), causing the widget to be
3100 * hidden (invisible to the user).
3103 gtk_widget_hide (GtkWidget *widget)
3105 g_return_if_fail (GTK_IS_WIDGET (widget));
3107 if (GTK_WIDGET_VISIBLE (widget))
3109 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
3111 g_object_ref (widget);
3112 if (toplevel != widget && GTK_WIDGET_TOPLEVEL (toplevel))
3113 _gtk_window_unset_focus_and_default (GTK_WINDOW (toplevel), widget);
3115 g_signal_emit (widget, widget_signals[HIDE], 0);
3116 if (!GTK_WIDGET_TOPLEVEL (widget))
3117 gtk_widget_queue_resize (widget);
3118 g_object_notify (G_OBJECT (widget), "visible");
3119 g_object_unref (widget);
3124 gtk_widget_real_hide (GtkWidget *widget)
3126 if (GTK_WIDGET_VISIBLE (widget))
3128 GTK_WIDGET_UNSET_FLAGS (widget, GTK_VISIBLE);
3130 if (GTK_WIDGET_MAPPED (widget))
3131 gtk_widget_unmap (widget);
3136 * gtk_widget_hide_on_delete:
3137 * @widget: a #GtkWidget
3139 * Utility function; intended to be connected to the #GtkWidget::delete-event
3140 * signal on a #GtkWindow. The function calls gtk_widget_hide() on its
3141 * argument, then returns %TRUE. If connected to ::delete-event, the
3142 * result is that clicking the close button for a window (on the
3143 * window frame, top right corner usually) will hide but not destroy
3144 * the window. By default, GTK+ destroys windows when ::delete-event
3147 * Return value: %TRUE
3150 gtk_widget_hide_on_delete (GtkWidget *widget)
3152 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
3154 gtk_widget_hide (widget);
3160 * gtk_widget_show_all:
3161 * @widget: a #GtkWidget
3163 * Recursively shows a widget, and any child widgets (if the widget is
3167 gtk_widget_show_all (GtkWidget *widget)
3169 GtkWidgetClass *class;
3171 g_return_if_fail (GTK_IS_WIDGET (widget));
3173 if ((GTK_WIDGET_FLAGS (widget) & GTK_NO_SHOW_ALL) != 0)
3176 class = GTK_WIDGET_GET_CLASS (widget);
3178 if (class->show_all)
3179 class->show_all (widget);
3183 * gtk_widget_hide_all:
3184 * @widget: a #GtkWidget
3186 * Recursively hides a widget and any child widgets.
3189 gtk_widget_hide_all (GtkWidget *widget)
3191 GtkWidgetClass *class;
3193 g_return_if_fail (GTK_IS_WIDGET (widget));
3195 if ((GTK_WIDGET_FLAGS (widget) & GTK_NO_SHOW_ALL) != 0)
3198 class = GTK_WIDGET_GET_CLASS (widget);
3200 if (class->hide_all)
3201 class->hide_all (widget);
3206 * @widget: a #GtkWidget
3208 * This function is only for use in widget implementations. Causes
3209 * a widget to be mapped if it isn't already.
3212 gtk_widget_map (GtkWidget *widget)
3214 g_return_if_fail (GTK_IS_WIDGET (widget));
3215 g_return_if_fail (GTK_WIDGET_VISIBLE (widget));
3216 g_return_if_fail (GTK_WIDGET_CHILD_VISIBLE (widget));
3218 if (!GTK_WIDGET_MAPPED (widget))
3220 if (!GTK_WIDGET_REALIZED (widget))
3221 gtk_widget_realize (widget);
3223 g_signal_emit (widget, widget_signals[MAP], 0);
3225 if (GTK_WIDGET_NO_WINDOW (widget))
3226 gdk_window_invalidate_rect (widget->window, &widget->allocation, FALSE);
3232 * @widget: a #GtkWidget
3234 * This function is only for use in widget implementations. Causes
3235 * a widget to be unmapped if it's currently mapped.
3238 gtk_widget_unmap (GtkWidget *widget)
3240 g_return_if_fail (GTK_IS_WIDGET (widget));
3242 if (GTK_WIDGET_MAPPED (widget))
3244 if (GTK_WIDGET_NO_WINDOW (widget))
3245 gdk_window_invalidate_rect (widget->window, &widget->allocation, FALSE);
3246 _gtk_tooltip_hide (widget);
3247 g_signal_emit (widget, widget_signals[UNMAP], 0);
3252 gtk_widget_set_extension_events_internal (GtkWidget *widget,
3253 GdkExtensionMode mode,
3256 GList *free_list = NULL;
3259 if (window_list == NULL)
3261 if (!GTK_WIDGET_NO_WINDOW (widget))
3262 window_list = g_list_prepend (NULL, widget->window);
3264 window_list = gdk_window_get_children (widget->window);
3266 free_list = window_list;
3269 for (l = window_list; l != NULL; l = l->next)
3271 GdkWindow *window = l->data;
3274 gdk_window_get_user_data (window, &user_data);
3275 if (user_data == widget)
3279 gdk_input_set_extension_events (window,
3280 gdk_window_get_events (window),
3283 children = gdk_window_get_children (window);
3286 gtk_widget_set_extension_events_internal (widget, mode, children);
3287 g_list_free (children);
3293 g_list_free (free_list);
3297 * gtk_widget_realize:
3298 * @widget: a #GtkWidget
3300 * Creates the GDK (windowing system) resources associated with a
3301 * widget. For example, @widget->window will be created when a widget
3302 * is realized. Normally realization happens implicitly; if you show
3303 * a widget and all its parent containers, then the widget will be
3304 * realized and mapped automatically.
3306 * Realizing a widget requires all
3307 * the widget's parent widgets to be realized; calling
3308 * gtk_widget_realize() realizes the widget's parents in addition to
3309 * @widget itself. If a widget is not yet inside a toplevel window
3310 * when you realize it, bad things will happen.
3312 * This function is primarily used in widget implementations, and
3313 * isn't very useful otherwise. Many times when you think you might
3314 * need it, a better approach is to connect to a signal that will be
3315 * called after the widget is realized automatically, such as
3316 * GtkWidget::expose-event. Or simply g_signal_connect () to the
3317 * GtkWidget::realize signal.
3320 gtk_widget_realize (GtkWidget *widget)
3322 GdkExtensionMode mode;
3323 GtkWidgetShapeInfo *shape_info;
3325 g_return_if_fail (GTK_IS_WIDGET (widget));
3326 g_return_if_fail (GTK_WIDGET_ANCHORED (widget) ||
3327 GTK_IS_INVISIBLE (widget));
3329 if (!GTK_WIDGET_REALIZED (widget))
3332 if (GTK_IS_CONTAINER (widget) && !GTK_WIDGET_NO_WINDOW (widget))
3333 g_message ("gtk_widget_realize(%s)", g_type_name (GTK_WIDGET_TYPE (widget)));
3336 if (widget->parent == NULL &&
3337 !GTK_WIDGET_TOPLEVEL (widget))
3338 g_warning ("Calling gtk_widget_realize() on a widget that isn't "
3339 "inside a toplevel window is not going to work very well. "
3340 "Widgets must be inside a toplevel container before realizing them.");
3342 if (widget->parent && !GTK_WIDGET_REALIZED (widget->parent))
3343 gtk_widget_realize (widget->parent);
3345 gtk_widget_ensure_style (widget);
3347 g_signal_emit (widget, widget_signals[REALIZE], 0);
3349 gtk_widget_real_set_has_tooltip (widget,
3350 GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (widget), quark_has_tooltip)),
3353 if (GTK_WIDGET_HAS_SHAPE_MASK (widget))
3355 shape_info = g_object_get_qdata (G_OBJECT (widget), quark_shape_info);
3356 gdk_window_shape_combine_mask (widget->window,
3357 shape_info->shape_mask,
3358 shape_info->offset_x,
3359 shape_info->offset_y);
3362 shape_info = g_object_get_qdata (G_OBJECT (widget), quark_input_shape_info);
3364 gdk_window_input_shape_combine_mask (widget->window,
3365 shape_info->shape_mask,
3366 shape_info->offset_x,
3367 shape_info->offset_y);
3369 mode = gtk_widget_get_extension_events (widget);
3370 if (mode != GDK_EXTENSION_EVENTS_NONE)
3371 gtk_widget_set_extension_events_internal (widget, mode, NULL);
3376 * gtk_widget_unrealize:
3377 * @widget: a #GtkWidget
3379 * This function is only useful in widget implementations.
3380 * Causes a widget to be unrealized (frees all GDK resources
3381 * associated with the widget, such as @widget->window).
3384 gtk_widget_unrealize (GtkWidget *widget)
3386 g_return_if_fail (GTK_IS_WIDGET (widget));
3388 if (GTK_WIDGET_HAS_SHAPE_MASK (widget))
3389 gtk_widget_shape_combine_mask (widget, NULL, 0, 0);
3391 if (g_object_get_qdata (G_OBJECT (widget), quark_input_shape_info))
3392 gtk_widget_input_shape_combine_mask (widget, NULL, 0, 0);
3394 if (GTK_WIDGET_REALIZED (widget))
3396 g_object_ref (widget);
3397 _gtk_tooltip_hide (widget);
3398 g_signal_emit (widget, widget_signals[UNREALIZE], 0);
3399 GTK_WIDGET_UNSET_FLAGS (widget, GTK_REALIZED | GTK_MAPPED);
3400 g_object_unref (widget);
3404 /*****************************************
3406 *****************************************/
3409 * gtk_widget_queue_draw_area:
3410 * @widget: a #GtkWidget
3411 * @x: x coordinate of upper-left corner of rectangle to redraw
3412 * @y: y coordinate of upper-left corner of rectangle to redraw
3413 * @width: width of region to draw
3414 * @height: height of region to draw
3416 * Invalidates the rectangular area of @widget defined by @x, @y,
3417 * @width and @height by calling gdk_window_invalidate_rect() on the
3418 * widget's window and all its child windows. Once the main loop
3419 * becomes idle (after the current batch of events has been processed,
3420 * roughly), the window will receive expose events for the union of
3421 * all regions that have been invalidated.
3423 * Normally you would only use this function in widget
3424 * implementations. You might also use it, or
3425 * gdk_window_invalidate_rect() directly, to schedule a redraw of a
3426 * #GtkDrawingArea or some portion thereof.
3428 * Frequently you can just call gdk_window_invalidate_rect() or
3429 * gdk_window_invalidate_region() instead of this function. Those
3430 * functions will invalidate only a single window, instead of the
3431 * widget and all its children.
3433 * The advantage of adding to the invalidated region compared to
3434 * simply drawing immediately is efficiency; using an invalid region
3435 * ensures that you only have to redraw one time.
3438 gtk_widget_queue_draw_area (GtkWidget *widget,
3444 GdkRectangle invalid_rect;
3447 g_return_if_fail (GTK_IS_WIDGET (widget));
3449 if (!GTK_WIDGET_REALIZED (widget))
3452 /* Just return if the widget or one of its ancestors isn't mapped */
3453 for (w = widget; w != NULL; w = w->parent)
3454 if (!GTK_WIDGET_MAPPED (w))
3457 /* Find the correct widget */
3459 if (!GTK_WIDGET_NO_WINDOW (widget))
3463 /* Translate widget relative to window-relative */
3465 gint wx, wy, wwidth, wheight;
3467 gdk_window_get_position (widget->window, &wx, &wy);
3468 x -= wx - widget->allocation.x;
3469 y -= wy - widget->allocation.y;
3471 gdk_drawable_get_size (widget->window, &wwidth, &wheight);
3473 if (x + width <= 0 || y + height <= 0 ||
3474 x >= wwidth || y >= wheight)
3485 if (x + width > wwidth)
3487 if (y + height > wheight)
3488 height = wheight - y;
3494 invalid_rect.width = width;
3495 invalid_rect.height = height;
3497 gdk_window_invalidate_rect (widget->window, &invalid_rect, TRUE);
3501 widget_add_child_draw_rectangle (GtkWidget *widget,
3504 GdkRectangle child_rect;
3506 if (!GTK_WIDGET_MAPPED (widget) ||
3507 widget->window != widget->parent->window)
3510 gtk_widget_get_draw_rectangle (widget, &child_rect);
3511 gdk_rectangle_union (rect, &child_rect, rect);
3515 gtk_widget_get_draw_rectangle (GtkWidget *widget,
3518 if (GTK_WIDGET_NO_WINDOW (widget))
3520 GtkBorder *draw_border = NULL;
3522 *rect = widget->allocation;
3524 gtk_widget_style_get (widget,
3525 "draw-border", &draw_border,
3529 rect->x -= draw_border->left;
3530 rect->y -= draw_border->top;
3531 rect->width += draw_border->left + draw_border->right;
3532 rect->height += draw_border->top + draw_border->bottom;
3534 gtk_border_free (draw_border);
3537 if (GTK_IS_CONTAINER (widget))
3538 gtk_container_forall (GTK_CONTAINER (widget),
3539 (GtkCallback)widget_add_child_draw_rectangle,
3546 rect->width = widget->allocation.width;
3547 rect->height = widget->allocation.height;
3552 * gtk_widget_queue_draw:
3553 * @widget: a #GtkWidget
3555 * Equivalent to calling gtk_widget_queue_draw_area() for the
3556 * entire area of a widget.
3559 gtk_widget_queue_draw (GtkWidget *widget)
3563 g_return_if_fail (GTK_IS_WIDGET (widget));
3565 gtk_widget_get_draw_rectangle (widget, &rect);
3567 gtk_widget_queue_draw_area (widget,
3569 rect.width, rect.height);
3572 /* Invalidates the given area (allocation-relative-coordinates)
3573 * in all of the widget's windows
3576 * gtk_widget_queue_clear_area:
3577 * @widget: a #GtkWidget
3578 * @x: x coordinate of upper-left corner of rectangle to redraw
3579 * @y: y coordinate of upper-left corner of rectangle to redraw
3580 * @width: width of region to draw
3581 * @height: height of region to draw
3583 * This function is no longer different from
3584 * gtk_widget_queue_draw_area(), though it once was. Now it just calls
3585 * gtk_widget_queue_draw_area(). Originally
3586 * gtk_widget_queue_clear_area() would force a redraw of the
3587 * background for %GTK_NO_WINDOW widgets, and
3588 * gtk_widget_queue_draw_area() would not. Now both functions ensure
3589 * the background will be redrawn.
3591 * Deprecated: 2.2: Use gtk_widget_queue_draw_area() instead.
3594 gtk_widget_queue_clear_area (GtkWidget *widget,
3600 g_return_if_fail (GTK_IS_WIDGET (widget));
3602 gtk_widget_queue_draw_area (widget, x, y, width, height);
3606 * gtk_widget_queue_clear:
3607 * @widget: a #GtkWidget
3609 * This function does the same as gtk_widget_queue_draw().
3611 * Deprecated: 2.2: Use gtk_widget_queue_draw() instead.
3614 gtk_widget_queue_clear (GtkWidget *widget)
3616 g_return_if_fail (GTK_IS_WIDGET (widget));
3618 gtk_widget_queue_draw (widget);
3622 * gtk_widget_queue_resize:
3623 * @widget: a #GtkWidget
3625 * This function is only for use in widget implementations.
3626 * Flags a widget to have its size renegotiated; should
3627 * be called when a widget for some reason has a new size request.
3628 * For example, when you change the text in a #GtkLabel, #GtkLabel
3629 * queues a resize to ensure there's enough space for the new text.
3632 gtk_widget_queue_resize (GtkWidget *widget)
3634 g_return_if_fail (GTK_IS_WIDGET (widget));
3636 if (GTK_WIDGET_REALIZED (widget))
3637 gtk_widget_queue_shallow_draw (widget);
3639 _gtk_size_group_queue_resize (widget);
3643 * gtk_widget_queue_resize_no_redraw:
3644 * @widget: a #GtkWidget
3646 * This function works like gtk_widget_queue_resize(),
3647 * except that the widget is not invalidated.
3652 gtk_widget_queue_resize_no_redraw (GtkWidget *widget)
3654 g_return_if_fail (GTK_IS_WIDGET (widget));
3656 _gtk_size_group_queue_resize (widget);
3661 * @widget: a #GtkWidget
3662 * @area: area to draw
3664 * In GTK+ 1.2, this function would immediately render the
3665 * region @area of a widget, by invoking the virtual draw method of a
3666 * widget. In GTK+ 2.0, the draw method is gone, and instead
3667 * gtk_widget_draw() simply invalidates the specified region of the
3668 * widget, then updates the invalid region of the widget immediately.
3669 * Usually you don't want to update the region immediately for
3670 * performance reasons, so in general gtk_widget_queue_draw_area() is
3671 * a better choice if you want to draw a region of a widget.
3674 gtk_widget_draw (GtkWidget *widget,
3675 const GdkRectangle *area)
3677 g_return_if_fail (GTK_IS_WIDGET (widget));
3679 if (GTK_WIDGET_DRAWABLE (widget))
3682 gtk_widget_queue_draw_area (widget,
3684 area->width, area->height);
3686 gtk_widget_queue_draw (widget);
3688 gdk_window_process_updates (widget->window, TRUE);
3693 * gtk_widget_size_request:
3694 * @widget: a #GtkWidget
3695 * @requisition: a #GtkRequisition to be filled in
3697 * This function is typically used when implementing a #GtkContainer
3698 * subclass. Obtains the preferred size of a widget. The container
3699 * uses this information to arrange its child widgets and decide what
3700 * size allocations to give them with gtk_widget_size_allocate().
3702 * You can also call this function from an application, with some
3703 * caveats. Most notably, getting a size request requires the widget
3704 * to be associated with a screen, because font information may be
3705 * needed. Multihead-aware applications should keep this in mind.
3707 * Also remember that the size request is not necessarily the size
3708 * a widget will actually be allocated.
3710 * See also gtk_widget_get_child_requisition().
3713 gtk_widget_size_request (GtkWidget *widget,
3714 GtkRequisition *requisition)
3716 g_return_if_fail (GTK_IS_WIDGET (widget));
3718 #ifdef G_ENABLE_DEBUG
3719 if (requisition == &widget->requisition)
3720 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.");
3721 #endif /* G_ENABLE_DEBUG */
3723 _gtk_size_group_compute_requisition (widget, requisition);
3727 * gtk_widget_get_child_requisition:
3728 * @widget: a #GtkWidget
3729 * @requisition: a #GtkRequisition to be filled in
3731 * This function is only for use in widget implementations. Obtains
3732 * @widget->requisition, unless someone has forced a particular
3733 * geometry on the widget (e.g. with gtk_widget_set_size_request()),
3734 * in which case it returns that geometry instead of the widget's
3737 * This function differs from gtk_widget_size_request() in that
3738 * it retrieves the last size request value from @widget->requisition,
3739 * while gtk_widget_size_request() actually calls the "size_request" method
3740 * on @widget to compute the size request and fill in @widget->requisition,
3741 * and only then returns @widget->requisition.
3743 * Because this function does not call the "size_request" method, it
3744 * can only be used when you know that @widget->requisition is
3745 * up-to-date, that is, gtk_widget_size_request() has been called
3746 * since the last time a resize was queued. In general, only container
3747 * implementations have this information; applications should use
3748 * gtk_widget_size_request().
3751 gtk_widget_get_child_requisition (GtkWidget *widget,
3752 GtkRequisition *requisition)
3754 _gtk_size_group_get_child_requisition (widget, requisition);
3758 invalidate_predicate (GdkWindow *window,
3763 gdk_window_get_user_data (window, &user_data);
3765 return (user_data == data);
3768 /* Invalidate @region in widget->window and all children
3769 * of widget->window owned by widget. @region is in the
3770 * same coordinates as widget->allocation and will be
3771 * modified by this call.
3774 gtk_widget_invalidate_widget_windows (GtkWidget *widget,
3777 if (!GTK_WIDGET_REALIZED (widget))
3780 if (!GTK_WIDGET_NO_WINDOW (widget) && widget->parent)
3784 gdk_window_get_position (widget->window, &x, &y);
3785 gdk_region_offset (region, -x, -y);
3788 gdk_window_invalidate_maybe_recurse (widget->window, region,
3789 invalidate_predicate, widget);
3793 * gtk_widget_queue_shallow_draw:
3794 * @widget: a #GtkWidget
3796 * Like gtk_widget_queue_draw(), but only windows owned
3797 * by @widget are invalidated.
3800 gtk_widget_queue_shallow_draw (GtkWidget *widget)
3805 if (!GTK_WIDGET_REALIZED (widget))
3808 gtk_widget_get_draw_rectangle (widget, &rect);
3810 /* get_draw_rectangle() gives us window coordinates, we
3811 * need to convert to the coordinates that widget->allocation
3814 if (!GTK_WIDGET_NO_WINDOW (widget) && widget->parent)
3818 gdk_window_get_position (widget->window, &wx, &wy);
3824 region = gdk_region_rectangle (&rect);
3825 gtk_widget_invalidate_widget_windows (widget, region);
3826 gdk_region_destroy (region);
3830 * gtk_widget_size_allocate:
3831 * @widget: a #GtkWidget
3832 * @allocation: position and size to be allocated to @widget
3834 * This function is only used by #GtkContainer subclasses, to assign a size
3835 * and position to their child widgets.
3838 gtk_widget_size_allocate (GtkWidget *widget,
3839 GtkAllocation *allocation)
3841 GtkWidgetAuxInfo *aux_info;
3842 GdkRectangle real_allocation;
3843 GdkRectangle old_allocation;
3844 gboolean alloc_needed;
3845 gboolean size_changed;
3846 gboolean position_changed;
3848 g_return_if_fail (GTK_IS_WIDGET (widget));
3850 #ifdef G_ENABLE_DEBUG
3851 if (gtk_debug_flags & GTK_DEBUG_GEOMETRY)
3862 parent = gtk_widget_get_parent (parent);
3865 name = g_type_name (G_OBJECT_TYPE (G_OBJECT (widget)));
3866 g_print ("gtk_widget_size_allocate: %*s%s %d %d\n",
3867 2 * depth, " ", name,
3868 allocation->width, allocation->height);
3870 #endif /* G_ENABLE_DEBUG */
3872 alloc_needed = GTK_WIDGET_ALLOC_NEEDED (widget);
3873 if (!GTK_WIDGET_REQUEST_NEEDED (widget)) /* Preserve request/allocate ordering */
3874 GTK_PRIVATE_UNSET_FLAG (widget, GTK_ALLOC_NEEDED);
3876 old_allocation = widget->allocation;
3877 real_allocation = *allocation;
3878 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
3882 if (aux_info->x_set)
3883 real_allocation.x = aux_info->x;
3884 if (aux_info->y_set)
3885 real_allocation.y = aux_info->y;
3888 if (real_allocation.width < 0 || real_allocation.height < 0)
3890 g_warning ("gtk_widget_size_allocate(): attempt to allocate widget with width %d and height %d",
3891 real_allocation.width,
3892 real_allocation.height);
3895 real_allocation.width = MAX (real_allocation.width, 1);
3896 real_allocation.height = MAX (real_allocation.height, 1);
3898 size_changed = (old_allocation.width != real_allocation.width ||
3899 old_allocation.height != real_allocation.height);
3900 position_changed = (old_allocation.x != real_allocation.x ||
3901 old_allocation.y != real_allocation.y);
3903 if (!alloc_needed && !size_changed && !position_changed)
3906 g_signal_emit (widget, widget_signals[SIZE_ALLOCATE], 0, &real_allocation);
3908 if (GTK_WIDGET_MAPPED (widget))
3910 if (GTK_WIDGET_NO_WINDOW (widget) && GTK_WIDGET_REDRAW_ON_ALLOC (widget) && position_changed)
3912 /* Invalidate union(old_allaction,widget->allocation) in widget->window
3914 GdkRegion *invalidate = gdk_region_rectangle (&widget->allocation);
3915 gdk_region_union_with_rect (invalidate, &old_allocation);
3917 gdk_window_invalidate_region (widget->window, invalidate, FALSE);
3918 gdk_region_destroy (invalidate);
3923 if (GTK_WIDGET_REDRAW_ON_ALLOC (widget))
3925 /* Invalidate union(old_allaction,widget->allocation) in widget->window and descendents owned by widget
3927 GdkRegion *invalidate = gdk_region_rectangle (&widget->allocation);
3928 gdk_region_union_with_rect (invalidate, &old_allocation);
3930 gtk_widget_invalidate_widget_windows (widget, invalidate);
3931 gdk_region_destroy (invalidate);
3936 if ((size_changed || position_changed) && widget->parent &&
3937 GTK_WIDGET_REALIZED (widget->parent) && GTK_CONTAINER (widget->parent)->reallocate_redraws)
3939 GdkRegion *invalidate = gdk_region_rectangle (&widget->parent->allocation);
3940 gtk_widget_invalidate_widget_windows (widget->parent, invalidate);
3941 gdk_region_destroy (invalidate);
3946 * gtk_widget_common_ancestor:
3947 * @widget_a: a #GtkWidget
3948 * @widget_b: a #GtkWidget
3950 * Find the common ancestor of @widget_a and @widget_b that
3951 * is closest to the two widgets.
3953 * Return value: the closest common ancestor of @widget_a and
3954 * @widget_b or %NULL if @widget_a and @widget_b do not
3955 * share a common ancestor.
3958 gtk_widget_common_ancestor (GtkWidget *widget_a,
3959 GtkWidget *widget_b)
3961 GtkWidget *parent_a;
3962 GtkWidget *parent_b;
3966 parent_a = widget_a;
3967 while (parent_a->parent)
3969 parent_a = parent_a->parent;
3973 parent_b = widget_b;
3974 while (parent_b->parent)
3976 parent_b = parent_b->parent;
3980 if (parent_a != parent_b)
3983 while (depth_a > depth_b)
3985 widget_a = widget_a->parent;
3989 while (depth_b > depth_a)
3991 widget_b = widget_b->parent;
3995 while (widget_a != widget_b)
3997 widget_a = widget_a->parent;
3998 widget_b = widget_b->parent;
4005 * gtk_widget_translate_coordinates:
4006 * @src_widget: a #GtkWidget
4007 * @dest_widget: a #GtkWidget
4008 * @src_x: X position relative to @src_widget
4009 * @src_y: Y position relative to @src_widget
4010 * @dest_x: location to store X position relative to @dest_widget
4011 * @dest_y: location to store Y position relative to @dest_widget
4013 * Translate coordinates relative to @src_widget's allocation to coordinates
4014 * relative to @dest_widget's allocations. In order to perform this
4015 * operation, both widgets must be realized, and must share a common
4018 * Return value: %FALSE if either widget was not realized, or there
4019 * was no common ancestor. In this case, nothing is stored in
4020 * *@dest_x and *@dest_y. Otherwise %TRUE.
4023 gtk_widget_translate_coordinates (GtkWidget *src_widget,
4024 GtkWidget *dest_widget,
4030 GtkWidget *ancestor;
4033 g_return_val_if_fail (GTK_IS_WIDGET (src_widget), FALSE);
4034 g_return_val_if_fail (GTK_IS_WIDGET (dest_widget), FALSE);
4036 ancestor = gtk_widget_common_ancestor (src_widget, dest_widget);
4037 if (!ancestor || !GTK_WIDGET_REALIZED (src_widget) || !GTK_WIDGET_REALIZED (dest_widget))
4040 /* Translate from allocation relative to window relative */
4041 if (!GTK_WIDGET_NO_WINDOW (src_widget) && src_widget->parent)
4044 gdk_window_get_position (src_widget->window, &wx, &wy);
4046 src_x -= wx - src_widget->allocation.x;
4047 src_y -= wy - src_widget->allocation.y;
4051 src_x += src_widget->allocation.x;
4052 src_y += src_widget->allocation.y;
4055 /* Translate to the common ancestor */
4056 window = src_widget->window;
4057 while (window != ancestor->window)
4061 gdk_window_get_position (window, &dx, &dy);
4066 window = gdk_window_get_parent (window);
4068 if (!window) /* Handle GtkHandleBox */
4073 window = dest_widget->window;
4074 while (window != ancestor->window)
4078 gdk_window_get_position (window, &dx, &dy);
4083 window = gdk_window_get_parent (window);
4085 if (!window) /* Handle GtkHandleBox */
4089 /* Translate from window relative to allocation relative */
4090 if (!GTK_WIDGET_NO_WINDOW (dest_widget) && dest_widget->parent)
4093 gdk_window_get_position (dest_widget->window, &wx, &wy);
4095 src_x += wx - dest_widget->allocation.x;
4096 src_y += wy - dest_widget->allocation.y;
4100 src_x -= dest_widget->allocation.x;
4101 src_y -= dest_widget->allocation.y;
4113 gtk_widget_real_size_allocate (GtkWidget *widget,
4114 GtkAllocation *allocation)
4116 widget->allocation = *allocation;
4118 if (GTK_WIDGET_REALIZED (widget) &&
4119 !GTK_WIDGET_NO_WINDOW (widget))
4121 gdk_window_move_resize (widget->window,
4122 allocation->x, allocation->y,
4123 allocation->width, allocation->height);
4128 gtk_widget_real_can_activate_accel (GtkWidget *widget,
4131 /* widgets must be onscreen for accels to take effect */
4132 return GTK_WIDGET_IS_SENSITIVE (widget) && GTK_WIDGET_DRAWABLE (widget) && gdk_window_is_viewable (widget->window);
4136 * gtk_widget_can_activate_accel:
4137 * @widget: a #GtkWidget
4138 * @signal_id: the ID of a signal installed on @widget
4140 * Determines whether an accelerator that activates the signal
4141 * identified by @signal_id can currently be activated.
4142 * This is done by emitting the #GtkWidget::can-activate-accel
4143 * signal on @widget; if the signal isn't overridden by a
4144 * handler or in a derived widget, then the default check is
4145 * that the widget must be sensitive, and the widget and all
4146 * its ancestors mapped.
4148 * Return value: %TRUE if the accelerator can be activated.
4153 gtk_widget_can_activate_accel (GtkWidget *widget,
4156 gboolean can_activate = FALSE;
4157 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4158 g_signal_emit (widget, widget_signals[CAN_ACTIVATE_ACCEL], 0, signal_id, &can_activate);
4159 return can_activate;
4168 closure_accel_activate (GClosure *closure,
4169 GValue *return_value,
4170 guint n_param_values,
4171 const GValue *param_values,
4172 gpointer invocation_hint,
4173 gpointer marshal_data)
4175 AccelClosure *aclosure = (AccelClosure*) closure;
4176 gboolean can_activate = gtk_widget_can_activate_accel (closure->data, aclosure->signal_id);
4179 g_signal_emit (closure->data, aclosure->signal_id, 0);
4181 /* whether accelerator was handled */
4182 g_value_set_boolean (return_value, can_activate);
4186 closures_destroy (gpointer data)
4188 GSList *slist, *closures = data;
4190 for (slist = closures; slist; slist = slist->next)
4192 g_closure_invalidate (slist->data);
4193 g_closure_unref (slist->data);
4195 g_slist_free (closures);
4199 widget_new_accel_closure (GtkWidget *widget,
4202 AccelClosure *aclosure;
4203 GClosure *closure = NULL;
4204 GSList *slist, *closures;
4206 closures = g_object_steal_qdata (G_OBJECT (widget), quark_accel_closures);
4207 for (slist = closures; slist; slist = slist->next)
4208 if (!gtk_accel_group_from_accel_closure (slist->data))
4210 /* reuse this closure */
4211 closure = slist->data;
4216 closure = g_closure_new_object (sizeof (AccelClosure), G_OBJECT (widget));
4217 closures = g_slist_prepend (closures, g_closure_ref (closure));
4218 g_closure_sink (closure);
4219 g_closure_set_marshal (closure, closure_accel_activate);
4221 g_object_set_qdata_full (G_OBJECT (widget), quark_accel_closures, closures, closures_destroy);
4223 aclosure = (AccelClosure*) closure;
4224 g_assert (closure->data == widget);
4225 g_assert (closure->marshal == closure_accel_activate);
4226 aclosure->signal_id = signal_id;
4232 * gtk_widget_add_accelerator
4233 * @widget: widget to install an accelerator on
4234 * @accel_signal: widget signal to emit on accelerator activation
4235 * @accel_group: accel group for this widget, added to its toplevel
4236 * @accel_key: GDK keyval of the accelerator
4237 * @accel_mods: modifier key combination of the accelerator
4238 * @accel_flags: flag accelerators, e.g. %GTK_ACCEL_VISIBLE
4240 * Installs an accelerator for this @widget in @accel_group that causes
4241 * @accel_signal to be emitted if the accelerator is activated.
4242 * The @accel_group needs to be added to the widget's toplevel via
4243 * gtk_window_add_accel_group(), and the signal must be of type %G_RUN_ACTION.
4244 * Accelerators added through this function are not user changeable during
4245 * runtime. If you want to support accelerators that can be changed by the
4246 * user, use gtk_accel_map_add_entry() and gtk_widget_set_accel_path() or
4247 * gtk_menu_item_set_accel_path() instead.
4250 gtk_widget_add_accelerator (GtkWidget *widget,
4251 const gchar *accel_signal,
4252 GtkAccelGroup *accel_group,
4254 GdkModifierType accel_mods,
4255 GtkAccelFlags accel_flags)
4260 g_return_if_fail (GTK_IS_WIDGET (widget));
4261 g_return_if_fail (accel_signal != NULL);
4262 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
4264 g_signal_query (g_signal_lookup (accel_signal, G_OBJECT_TYPE (widget)), &query);
4265 if (!query.signal_id ||
4266 !(query.signal_flags & G_SIGNAL_ACTION) ||
4267 query.return_type != G_TYPE_NONE ||
4270 /* hmm, should be elaborate enough */
4271 g_warning (G_STRLOC ": widget `%s' has no activatable signal \"%s\" without arguments",
4272 G_OBJECT_TYPE_NAME (widget), accel_signal);
4276 closure = widget_new_accel_closure (widget, query.signal_id);
4278 g_object_ref (widget);
4280 /* install the accelerator. since we don't map this onto an accel_path,
4281 * the accelerator will automatically be locked.
4283 gtk_accel_group_connect (accel_group,
4286 accel_flags | GTK_ACCEL_LOCKED,
4289 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
4291 g_object_unref (widget);
4295 * gtk_widget_remove_accelerator:
4296 * @widget: widget to install an accelerator on
4297 * @accel_group: accel group for this widget
4298 * @accel_key: GDK keyval of the accelerator
4299 * @accel_mods: modifier key combination of the accelerator
4300 * @returns: whether an accelerator was installed and could be removed
4302 * Removes an accelerator from @widget, previously installed with
4303 * gtk_widget_add_accelerator().
4306 gtk_widget_remove_accelerator (GtkWidget *widget,
4307 GtkAccelGroup *accel_group,
4309 GdkModifierType accel_mods)
4311 GtkAccelGroupEntry *ag_entry;
4312 GList *slist, *clist;
4315 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4316 g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE);
4318 ag_entry = gtk_accel_group_query (accel_group, accel_key, accel_mods, &n);
4319 clist = gtk_widget_list_accel_closures (widget);
4320 for (slist = clist; slist; slist = slist->next)
4324 for (i = 0; i < n; i++)
4325 if (slist->data == (gpointer) ag_entry[i].closure)
4327 gboolean is_removed = gtk_accel_group_disconnect (accel_group, slist->data);
4329 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
4331 g_list_free (clist);
4336 g_list_free (clist);
4338 g_warning (G_STRLOC ": no accelerator (%u,%u) installed in accel group (%p) for %s (%p)",
4339 accel_key, accel_mods, accel_group,
4340 G_OBJECT_TYPE_NAME (widget), widget);
4346 * gtk_widget_list_accel_closures
4347 * @widget: widget to list accelerator closures for
4348 * @returns: a newly allocated #GList of closures
4350 * Lists the closures used by @widget for accelerator group connections
4351 * with gtk_accel_group_connect_by_path() or gtk_accel_group_connect().
4352 * The closures can be used to monitor accelerator changes on @widget,
4353 * by connecting to the @GtkAccelGroup::accel-changed signal of the
4354 * #GtkAccelGroup of a closure which can be found out with
4355 * gtk_accel_group_from_accel_closure().
4358 gtk_widget_list_accel_closures (GtkWidget *widget)
4361 GList *clist = NULL;
4363 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4365 for (slist = g_object_get_qdata (G_OBJECT (widget), quark_accel_closures); slist; slist = slist->next)
4366 if (gtk_accel_group_from_accel_closure (slist->data))
4367 clist = g_list_prepend (clist, slist->data);
4373 GtkAccelGroup *accel_group;
4378 destroy_accel_path (gpointer data)
4380 AccelPath *apath = data;
4382 gtk_accel_group_disconnect (apath->accel_group, apath->closure);
4384 /* closures_destroy takes care of unrefing the closure */
4385 g_object_unref (apath->accel_group);
4387 g_slice_free (AccelPath, apath);
4392 * gtk_widget_set_accel_path:
4393 * @widget: a #GtkWidget
4394 * @accel_path: path used to look up the accelerator
4395 * @accel_group: a #GtkAccelGroup.
4397 * Given an accelerator group, @accel_group, and an accelerator path,
4398 * @accel_path, sets up an accelerator in @accel_group so whenever the
4399 * key binding that is defined for @accel_path is pressed, @widget
4400 * will be activated. This removes any accelerators (for any
4401 * accelerator group) installed by previous calls to
4402 * gtk_widget_set_accel_path(). Associating accelerators with
4403 * paths allows them to be modified by the user and the modifications
4404 * to be saved for future use. (See gtk_accel_map_save().)
4406 * This function is a low level function that would most likely
4407 * be used by a menu creation system like #GtkUIManager. If you
4408 * use #GtkUIManager, setting up accelerator paths will be done
4411 * Even when you you aren't using #GtkUIManager, if you only want to
4412 * set up accelerators on menu items gtk_menu_item_set_accel_path()
4413 * provides a somewhat more convenient interface.
4415 * Note that @accel_path string will be stored in a #GQuark. Therefore, if you
4416 * pass a static string, you can save some memory by interning it first with
4417 * g_intern_static_string().
4420 gtk_widget_set_accel_path (GtkWidget *widget,
4421 const gchar *accel_path,
4422 GtkAccelGroup *accel_group)
4426 g_return_if_fail (GTK_IS_WIDGET (widget));
4427 g_return_if_fail (GTK_WIDGET_GET_CLASS (widget)->activate_signal != 0);
4431 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
4432 g_return_if_fail (_gtk_accel_path_is_valid (accel_path));
4434 gtk_accel_map_add_entry (accel_path, 0, 0);
4435 apath = g_slice_new (AccelPath);
4436 apath->accel_group = g_object_ref (accel_group);
4437 apath->path_quark = g_quark_from_string (accel_path);
4438 apath->closure = widget_new_accel_closure (widget, GTK_WIDGET_GET_CLASS (widget)->activate_signal);
4443 /* also removes possible old settings */
4444 g_object_set_qdata_full (G_OBJECT (widget), quark_accel_path, apath, destroy_accel_path);
4447 gtk_accel_group_connect_by_path (apath->accel_group, g_quark_to_string (apath->path_quark), apath->closure);
4449 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
4453 _gtk_widget_get_accel_path (GtkWidget *widget,
4458 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4460 apath = g_object_get_qdata (G_OBJECT (widget), quark_accel_path);
4462 *locked = apath ? apath->accel_group->lock_count > 0 : TRUE;
4463 return apath ? g_quark_to_string (apath->path_quark) : NULL;
4467 * gtk_widget_mnemonic_activate:
4468 * @widget: a #GtkWidget
4469 * @group_cycling: %TRUE if there are other widgets with the same mnemonic
4471 * Emits the #GtkWidget::mnemonic-activate signal.
4473 * The default handler for this signal activates the @widget if
4474 * @group_cycling is %FALSE, and just grabs the focus if @group_cycling
4477 * Returns: %TRUE if the signal has been handled
4480 gtk_widget_mnemonic_activate (GtkWidget *widget,
4481 gboolean group_cycling)
4485 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4487 group_cycling = group_cycling != FALSE;
4488 if (!GTK_WIDGET_IS_SENSITIVE (widget))
4491 g_signal_emit (widget,
4492 widget_signals[MNEMONIC_ACTIVATE],
4500 gtk_widget_real_mnemonic_activate (GtkWidget *widget,
4501 gboolean group_cycling)
4503 if (!group_cycling && GTK_WIDGET_GET_CLASS (widget)->activate_signal)
4504 gtk_widget_activate (widget);
4505 else if (GTK_WIDGET_CAN_FOCUS (widget))
4506 gtk_widget_grab_focus (widget);
4509 g_warning ("widget `%s' isn't suitable for mnemonic activation",
4510 G_OBJECT_TYPE_NAME (widget));
4511 gtk_widget_error_bell (widget);
4517 gtk_widget_real_key_press_event (GtkWidget *widget,
4520 return gtk_bindings_activate_event (GTK_OBJECT (widget), event);
4524 gtk_widget_real_key_release_event (GtkWidget *widget,
4527 return gtk_bindings_activate_event (GTK_OBJECT (widget), event);
4531 gtk_widget_real_focus_in_event (GtkWidget *widget,
4532 GdkEventFocus *event)
4534 gtk_widget_queue_shallow_draw (widget);
4540 gtk_widget_real_focus_out_event (GtkWidget *widget,
4541 GdkEventFocus *event)
4543 gtk_widget_queue_shallow_draw (widget);
4548 #define WIDGET_REALIZED_FOR_EVENT(widget, event) \
4549 (event->type == GDK_FOCUS_CHANGE || GTK_WIDGET_REALIZED(widget))
4553 * @widget: a #GtkWidget
4554 * @event: a #GdkEvent
4556 * Rarely-used function. This function is used to emit
4557 * the event signals on a widget (those signals should never
4558 * be emitted without using this function to do so).
4559 * If you want to synthesize an event though, don't use this function;
4560 * instead, use gtk_main_do_event() so the event will behave as if
4561 * it were in the event queue. Don't synthesize expose events; instead,
4562 * use gdk_window_invalidate_rect() to invalidate a region of the
4565 * Return value: return from the event signal emission (%TRUE if
4566 * the event was handled)
4569 gtk_widget_event (GtkWidget *widget,
4572 g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
4573 g_return_val_if_fail (WIDGET_REALIZED_FOR_EVENT (widget, event), TRUE);
4575 if (event->type == GDK_EXPOSE)
4577 g_warning ("Events of type GDK_EXPOSE cannot be synthesized. To get "
4578 "the same effect, call gdk_window_invalidate_rect/region(), "
4579 "followed by gdk_window_process_updates().");
4583 return gtk_widget_event_internal (widget, event);
4588 * gtk_widget_send_expose:
4589 * @widget: a #GtkWidget
4590 * @event: a expose #GdkEvent
4592 * Very rarely-used function. This function is used to emit
4593 * an expose event signals on a widget. This function is not
4594 * normally used directly. The only time it is used is when
4595 * propagating an expose event to a child %NO_WINDOW widget, and
4596 * that is normally done using gtk_container_propagate_expose().
4598 * If you want to force an area of a window to be redrawn,
4599 * use gdk_window_invalidate_rect() or gdk_window_invalidate_region().
4600 * To cause the redraw to be done immediately, follow that call
4601 * with a call to gdk_window_process_updates().
4603 * Return value: return from the event signal emission (%TRUE if
4604 * the event was handled)
4607 gtk_widget_send_expose (GtkWidget *widget,
4610 g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
4611 g_return_val_if_fail (GTK_WIDGET_REALIZED (widget), TRUE);
4612 g_return_val_if_fail (event != NULL, TRUE);
4613 g_return_val_if_fail (event->type == GDK_EXPOSE, TRUE);
4615 return gtk_widget_event_internal (widget, event);
4619 event_window_is_still_viewable (GdkEvent *event)
4621 /* Some programs, such as gnome-theme-manager, fake widgets
4622 * into exposing onto a pixmap by sending expose events with
4623 * event->window pointing to a pixmap
4625 if (GDK_IS_PIXMAP (event->any.window))
4626 return event->type == GDK_EXPOSE;
4628 /* Check that we think the event's window is viewable before
4629 * delivering the event, to prevent suprises. We do this here
4630 * at the last moment, since the event may have been queued
4631 * up behind other events, held over a recursive main loop, etc.
4633 switch (event->type)
4636 case GDK_MOTION_NOTIFY:
4637 case GDK_BUTTON_PRESS:
4638 case GDK_2BUTTON_PRESS:
4639 case GDK_3BUTTON_PRESS:
4641 case GDK_ENTER_NOTIFY:
4642 case GDK_PROXIMITY_IN:
4644 return event->any.window && gdk_window_is_viewable (event->any.window);
4647 /* The following events are the second half of paired events;
4648 * we always deliver them to deal with widgets that clean up
4649 * on the second half.
4651 case GDK_BUTTON_RELEASE:
4652 case GDK_KEY_RELEASE:
4653 case GDK_LEAVE_NOTIFY:
4654 case GDK_PROXIMITY_OUT:
4658 /* Remaining events would make sense on an not-viewable window,
4659 * or don't have an associated window.
4666 gtk_widget_event_internal (GtkWidget *widget,
4669 gboolean return_val = FALSE;
4671 /* We check only once for is-still-visible; if someone
4672 * hides the window in on of the signals on the widget,
4673 * they are responsible for returning TRUE to terminate
4676 if (!event_window_is_still_viewable (event))
4679 g_object_ref (widget);
4681 g_signal_emit (widget, widget_signals[EVENT], 0, event, &return_val);
4682 return_val |= !WIDGET_REALIZED_FOR_EVENT (widget, event);
4687 switch (event->type)
4692 case GDK_BUTTON_PRESS:
4693 case GDK_2BUTTON_PRESS:
4694 case GDK_3BUTTON_PRESS:
4695 signal_num = BUTTON_PRESS_EVENT;
4698 signal_num = SCROLL_EVENT;
4700 case GDK_BUTTON_RELEASE:
4701 signal_num = BUTTON_RELEASE_EVENT;
4703 case GDK_MOTION_NOTIFY:
4704 signal_num = MOTION_NOTIFY_EVENT;
4707 signal_num = DELETE_EVENT;
4710 signal_num = DESTROY_EVENT;
4711 _gtk_tooltip_hide (widget);
4714 signal_num = KEY_PRESS_EVENT;
4716 case GDK_KEY_RELEASE:
4717 signal_num = KEY_RELEASE_EVENT;
4719 case GDK_ENTER_NOTIFY:
4720 signal_num = ENTER_NOTIFY_EVENT;
4722 case GDK_LEAVE_NOTIFY:
4723 signal_num = LEAVE_NOTIFY_EVENT;
4725 case GDK_FOCUS_CHANGE:
4726 signal_num = event->focus_change.in ? FOCUS_IN_EVENT : FOCUS_OUT_EVENT;
4727 if (event->focus_change.in)
4728 _gtk_tooltip_focus_in (widget);
4730 _gtk_tooltip_focus_out (widget);
4733 signal_num = CONFIGURE_EVENT;
4736 signal_num = MAP_EVENT;
4739 signal_num = UNMAP_EVENT;
4741 case GDK_WINDOW_STATE:
4742 signal_num = WINDOW_STATE_EVENT;
4744 case GDK_PROPERTY_NOTIFY:
4745 signal_num = PROPERTY_NOTIFY_EVENT;
4747 case GDK_SELECTION_CLEAR:
4748 signal_num = SELECTION_CLEAR_EVENT;
4750 case GDK_SELECTION_REQUEST:
4751 signal_num = SELECTION_REQUEST_EVENT;
4753 case GDK_SELECTION_NOTIFY:
4754 signal_num = SELECTION_NOTIFY_EVENT;
4756 case GDK_PROXIMITY_IN:
4757 signal_num = PROXIMITY_IN_EVENT;
4759 case GDK_PROXIMITY_OUT:
4760 signal_num = PROXIMITY_OUT_EVENT;
4763 signal_num = NO_EXPOSE_EVENT;
4765 case GDK_CLIENT_EVENT:
4766 signal_num = CLIENT_EVENT;
4769 signal_num = EXPOSE_EVENT;
4771 case GDK_VISIBILITY_NOTIFY:
4772 signal_num = VISIBILITY_NOTIFY_EVENT;
4774 case GDK_GRAB_BROKEN:
4775 signal_num = GRAB_BROKEN;
4778 signal_num = DAMAGE_EVENT;
4781 g_warning ("gtk_widget_event(): unhandled event type: %d", event->type);
4785 if (signal_num != -1)
4786 g_signal_emit (widget, widget_signals[signal_num], 0, event, &return_val);
4788 if (WIDGET_REALIZED_FOR_EVENT (widget, event))
4789 g_signal_emit (widget, widget_signals[EVENT_AFTER], 0, event);
4793 g_object_unref (widget);
4799 * gtk_widget_activate:
4800 * @widget: a #GtkWidget that's activatable
4802 * For widgets that can be "activated" (buttons, menu items, etc.)
4803 * this function activates them. Activation is what happens when you
4804 * press Enter on a widget during key navigation. If @widget isn't
4805 * activatable, the function returns %FALSE.
4807 * Return value: %TRUE if the widget was activatable
4810 gtk_widget_activate (GtkWidget *widget)
4812 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4814 if (WIDGET_CLASS (widget)->activate_signal)
4816 /* FIXME: we should eventually check the signals signature here */
4817 g_signal_emit (widget, WIDGET_CLASS (widget)->activate_signal, 0);
4826 * gtk_widget_set_scroll_adjustments:
4827 * @widget: a #GtkWidget
4828 * @hadjustment: an adjustment for horizontal scrolling, or %NULL
4829 * @vadjustment: an adjustment for vertical scrolling, or %NULL
4831 * For widgets that support scrolling, sets the scroll adjustments and
4832 * returns %TRUE. For widgets that don't support scrolling, does
4833 * nothing and returns %FALSE. Widgets that don't support scrolling
4834 * can be scrolled by placing them in a #GtkViewport, which does
4835 * support scrolling.
4837 * Return value: %TRUE if the widget supports scrolling
4840 gtk_widget_set_scroll_adjustments (GtkWidget *widget,
4841 GtkAdjustment *hadjustment,
4842 GtkAdjustment *vadjustment)
4847 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4850 g_return_val_if_fail (GTK_IS_ADJUSTMENT (hadjustment), FALSE);
4852 g_return_val_if_fail (GTK_IS_ADJUSTMENT (vadjustment), FALSE);
4854 signal_id = WIDGET_CLASS (widget)->set_scroll_adjustments_signal;
4858 g_signal_query (signal_id, &query);
4859 if (!query.signal_id ||
4860 !g_type_is_a (query.itype, GTK_TYPE_WIDGET) ||
4861 query.return_type != G_TYPE_NONE ||
4862 query.n_params != 2 ||
4863 query.param_types[0] != GTK_TYPE_ADJUSTMENT ||
4864 query.param_types[1] != GTK_TYPE_ADJUSTMENT)
4866 g_warning (G_STRLOC ": signal \"%s::%s\" has wrong signature",
4867 G_OBJECT_TYPE_NAME (widget), query.signal_name);
4871 g_signal_emit (widget, signal_id, 0, hadjustment, vadjustment);
4876 gtk_widget_reparent_subwindows (GtkWidget *widget,
4877 GdkWindow *new_window)
4879 if (GTK_WIDGET_NO_WINDOW (widget))
4881 GList *children = gdk_window_get_children (widget->window);
4884 for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
4886 GdkWindow *window = tmp_list->data;
4889 gdk_window_get_user_data (window, &child);
4890 while (child && child != widget)
4891 child = ((GtkWidget*) child)->parent;
4894 gdk_window_reparent (window, new_window, 0, 0);
4897 g_list_free (children);
4902 GList *tmp_list, *children;
4904 parent = gdk_window_get_parent (widget->window);
4907 gdk_window_reparent (widget->window, new_window, 0, 0);
4910 children = gdk_window_get_children (parent);
4912 for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
4914 GdkWindow *window = tmp_list->data;
4917 gdk_window_get_user_data (window, &child);
4919 if (child == widget)
4920 gdk_window_reparent (window, new_window, 0, 0);
4923 g_list_free (children);
4929 gtk_widget_reparent_fixup_child (GtkWidget *widget,
4930 gpointer client_data)
4932 g_assert (client_data != NULL);
4934 if (GTK_WIDGET_NO_WINDOW (widget))
4937 g_object_unref (widget->window);
4938 widget->window = (GdkWindow*) client_data;
4940 g_object_ref (widget->window);
4942 if (GTK_IS_CONTAINER (widget))
4943 gtk_container_forall (GTK_CONTAINER (widget),
4944 gtk_widget_reparent_fixup_child,
4950 * gtk_widget_reparent:
4951 * @widget: a #GtkWidget
4952 * @new_parent: a #GtkContainer to move the widget into
4954 * Moves a widget from one #GtkContainer to another, handling reference
4955 * count issues to avoid destroying the widget.
4958 gtk_widget_reparent (GtkWidget *widget,
4959 GtkWidget *new_parent)
4961 g_return_if_fail (GTK_IS_WIDGET (widget));
4962 g_return_if_fail (GTK_IS_CONTAINER (new_parent));
4963 g_return_if_fail (widget->parent != NULL);
4965 if (widget->parent != new_parent)
4967 /* First try to see if we can get away without unrealizing
4968 * the widget as we reparent it. if so we set a flag so
4969 * that gtk_widget_unparent doesn't unrealize widget
4971 if (GTK_WIDGET_REALIZED (widget) && GTK_WIDGET_REALIZED (new_parent))
4972 GTK_PRIVATE_SET_FLAG (widget, GTK_IN_REPARENT);
4974 g_object_ref (widget);
4975 gtk_container_remove (GTK_CONTAINER (widget->parent), widget);
4976 gtk_container_add (GTK_CONTAINER (new_parent), widget);
4977 g_object_unref (widget);
4979 if (GTK_WIDGET_IN_REPARENT (widget))
4981 GTK_PRIVATE_UNSET_FLAG (widget, GTK_IN_REPARENT);
4983 gtk_widget_reparent_subwindows (widget, gtk_widget_get_parent_window (widget));
4984 gtk_widget_reparent_fixup_child (widget,
4985 gtk_widget_get_parent_window (widget));
4988 g_object_notify (G_OBJECT (widget), "parent");
4993 * gtk_widget_intersect:
4994 * @widget: a #GtkWidget
4995 * @area: a rectangle
4996 * @intersection: rectangle to store intersection of @widget and @area
4998 * Computes the intersection of a @widget's area and @area, storing
4999 * the intersection in @intersection, and returns %TRUE if there was
5000 * an intersection. @intersection may be %NULL if you're only
5001 * interested in whether there was an intersection.
5003 * Return value: %TRUE if there was an intersection
5006 gtk_widget_intersect (GtkWidget *widget,
5007 const GdkRectangle *area,
5008 GdkRectangle *intersection)
5014 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5015 g_return_val_if_fail (area != NULL, FALSE);
5018 dest = intersection;
5022 return_val = gdk_rectangle_intersect (&widget->allocation, area, dest);
5024 if (return_val && intersection && !GTK_WIDGET_NO_WINDOW (widget))
5026 intersection->x -= widget->allocation.x;
5027 intersection->y -= widget->allocation.y;
5034 * gtk_widget_region_intersect:
5035 * @widget: a #GtkWidget
5036 * @region: a #GdkRegion, in the same coordinate system as
5037 * @widget->allocation. That is, relative to @widget->window
5038 * for %NO_WINDOW widgets; relative to the parent window
5039 * of @widget->window for widgets with their own window.
5040 * @returns: A newly allocated region holding the intersection of @widget
5041 * and @region. The coordinates of the return value are
5042 * relative to @widget->window for %NO_WINDOW widgets, and
5043 * relative to the parent window of @widget->window for
5044 * widgets with their own window.
5046 * Computes the intersection of a @widget's area and @region, returning
5047 * the intersection. The result may be empty, use gdk_region_empty() to
5051 gtk_widget_region_intersect (GtkWidget *widget,
5052 const GdkRegion *region)
5057 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5058 g_return_val_if_fail (region != NULL, NULL);
5060 gtk_widget_get_draw_rectangle (widget, &rect);
5062 dest = gdk_region_rectangle (&rect);
5064 gdk_region_intersect (dest, region);
5070 * _gtk_widget_grab_notify:
5071 * @widget: a #GtkWidget
5072 * @was_grabbed: whether a grab is now in effect
5074 * Emits the #GtkWidget::grab-notify signal on @widget.
5079 _gtk_widget_grab_notify (GtkWidget *widget,
5080 gboolean was_grabbed)
5082 g_signal_emit (widget, widget_signals[GRAB_NOTIFY], 0, was_grabbed);
5086 * gtk_widget_grab_focus:
5087 * @widget: a #GtkWidget
5089 * Causes @widget to have the keyboard focus for the #GtkWindow it's
5090 * inside. @widget must be a focusable widget, such as a #GtkEntry;
5091 * something like #GtkFrame won't work.
5093 * More precisely, it must have the %GTK_CAN_FOCUS flag set. Use
5094 * gtk_widget_set_can_focus() to modify that flag.
5097 gtk_widget_grab_focus (GtkWidget *widget)
5099 g_return_if_fail (GTK_IS_WIDGET (widget));
5101 if (!GTK_WIDGET_IS_SENSITIVE (widget))
5104 g_object_ref (widget);
5105 g_signal_emit (widget, widget_signals[GRAB_FOCUS], 0);
5106 g_object_notify (G_OBJECT (widget), "has-focus");
5107 g_object_unref (widget);
5111 reset_focus_recurse (GtkWidget *widget,
5114 if (GTK_IS_CONTAINER (widget))
5116 GtkContainer *container;
5118 container = GTK_CONTAINER (widget);
5119 gtk_container_set_focus_child (container, NULL);
5121 gtk_container_foreach (container,
5122 reset_focus_recurse,
5128 gtk_widget_real_grab_focus (GtkWidget *focus_widget)
5130 if (GTK_WIDGET_CAN_FOCUS (focus_widget))
5132 GtkWidget *toplevel;
5135 /* clear the current focus setting, break if the current widget
5136 * is the focus widget's parent, since containers above that will
5137 * be set by the next loop.
5139 toplevel = gtk_widget_get_toplevel (focus_widget);
5140 if (GTK_WIDGET_TOPLEVEL (toplevel) && GTK_IS_WINDOW (toplevel))
5142 widget = GTK_WINDOW (toplevel)->focus_widget;
5144 if (widget == focus_widget)
5146 /* We call _gtk_window_internal_set_focus() here so that the
5147 * toplevel window can request the focus if necessary.
5148 * This is needed when the toplevel is a GtkPlug
5150 if (!GTK_WIDGET_HAS_FOCUS (widget))
5151 _gtk_window_internal_set_focus (GTK_WINDOW (toplevel), focus_widget);
5158 while (widget->parent && widget->parent != focus_widget->parent)
5160 widget = widget->parent;
5161 gtk_container_set_focus_child (GTK_CONTAINER (widget), NULL);
5165 else if (toplevel != focus_widget)
5167 /* gtk_widget_grab_focus() operates on a tree without window...
5168 * actually, this is very questionable behaviour.
5171 gtk_container_foreach (GTK_CONTAINER (toplevel),
5172 reset_focus_recurse,
5176 /* now propagate the new focus up the widget tree and finally
5177 * set it on the window
5179 widget = focus_widget;
5180 while (widget->parent)
5182 gtk_container_set_focus_child (GTK_CONTAINER (widget->parent), widget);
5183 widget = widget->parent;
5185 if (GTK_IS_WINDOW (widget))
5186 _gtk_window_internal_set_focus (GTK_WINDOW (widget), focus_widget);
5191 gtk_widget_real_query_tooltip (GtkWidget *widget,
5194 gboolean keyboard_tip,
5195 GtkTooltip *tooltip)
5197 gchar *tooltip_markup;
5198 gboolean has_tooltip;
5200 tooltip_markup = g_object_get_qdata (G_OBJECT (widget), quark_tooltip_markup);
5201 has_tooltip = GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (widget), quark_has_tooltip));
5203 if (has_tooltip && tooltip_markup)
5205 gtk_tooltip_set_markup (tooltip, tooltip_markup);
5213 gtk_widget_real_show_help (GtkWidget *widget,
5214 GtkWidgetHelpType help_type)
5216 if (help_type == GTK_WIDGET_HELP_TOOLTIP)
5218 _gtk_tooltip_toggle_keyboard_mode (widget);
5227 gtk_widget_real_focus (GtkWidget *widget,
5228 GtkDirectionType direction)
5230 if (!GTK_WIDGET_CAN_FOCUS (widget))
5233 if (!gtk_widget_is_focus (widget))
5235 gtk_widget_grab_focus (widget);
5243 gtk_widget_real_move_focus (GtkWidget *widget,
5244 GtkDirectionType direction)
5246 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
5248 if (GTK_IS_WINDOW (toplevel) &&
5249 GTK_WINDOW_GET_CLASS (toplevel)->move_focus)
5251 GTK_WINDOW_GET_CLASS (toplevel)->move_focus (GTK_WINDOW (toplevel),
5257 gtk_widget_real_keynav_failed (GtkWidget *widget,
5258 GtkDirectionType direction)
5260 gboolean cursor_only;
5264 case GTK_DIR_TAB_FORWARD:
5265 case GTK_DIR_TAB_BACKWARD:
5272 g_object_get (gtk_widget_get_settings (widget),
5273 "gtk-keynav-cursor-only", &cursor_only,
5280 gtk_widget_error_bell (widget);
5286 * gtk_widget_set_can_focus:
5287 * @widget: a #GtkWidget
5288 * @can_focus: whether or not @widget can own the input focus.
5290 * Specifies whether @widget can own the input focus. See
5291 * gtk_widget_grab_focus() for actually setting the input focus on a
5297 gtk_widget_set_can_focus (GtkWidget *widget,
5300 g_return_if_fail (GTK_IS_WIDGET (widget));
5302 if (can_focus != GTK_WIDGET_CAN_FOCUS (widget))
5305 GTK_WIDGET_SET_FLAGS (widget, GTK_CAN_FOCUS);
5307 GTK_WIDGET_UNSET_FLAGS (widget, GTK_CAN_FOCUS);
5309 gtk_widget_queue_resize (widget);
5310 g_object_notify (G_OBJECT (widget), "can-focus");
5315 * gtk_widget_get_can_focus:
5316 * @widget: a #GtkWidget
5318 * Determines whether @widget can own the input focus. See
5319 * gtk_widget_set_can_focus().
5321 * Return value: %TRUE if @widget can own the input focus, %FALSE otherwise
5326 gtk_widget_get_can_focus (GtkWidget *widget)
5328 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5330 return GTK_WIDGET_CAN_FOCUS (widget);
5334 * gtk_widget_has_focus:
5335 * @widget: a #GtkWidget
5337 * Determines if the widget has the global input focus. See
5338 * gtk_widget_is_focus() for the difference between having the global
5339 * input focus, and only having the focus within a toplevel.
5341 * Return value: %TRUE if the widget has the global input focus.
5346 gtk_widget_has_focus (GtkWidget *widget)
5348 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5350 return GTK_WIDGET_HAS_FOCUS (widget);
5354 * gtk_widget_is_focus:
5355 * @widget: a #GtkWidget
5357 * Determines if the widget is the focus widget within its
5358 * toplevel. (This does not mean that the %HAS_FOCUS flag is
5359 * necessarily set; %HAS_FOCUS will only be set if the
5360 * toplevel widget additionally has the global input focus.)
5362 * Return value: %TRUE if the widget is the focus widget.
5365 gtk_widget_is_focus (GtkWidget *widget)
5367 GtkWidget *toplevel;
5369 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5371 toplevel = gtk_widget_get_toplevel (widget);
5373 if (GTK_IS_WINDOW (toplevel))
5374 return widget == GTK_WINDOW (toplevel)->focus_widget;
5380 * gtk_widget_set_can_default:
5381 * @widget: a #GtkWidget
5382 * @can_default: whether or not @widget can be a default widget.
5384 * Specifies whether @widget can be a default widget. See
5385 * gtk_widget_grab_default() for details about the meaning of
5391 gtk_widget_set_can_default (GtkWidget *widget,
5392 gboolean can_default)
5394 g_return_if_fail (GTK_IS_WIDGET (widget));
5396 if (can_default != GTK_WIDGET_CAN_DEFAULT (widget))
5399 GTK_WIDGET_SET_FLAGS (widget, GTK_CAN_DEFAULT);
5401 GTK_WIDGET_UNSET_FLAGS (widget, GTK_CAN_DEFAULT);
5403 gtk_widget_queue_resize (widget);
5404 g_object_notify (G_OBJECT (widget), "can-default");
5409 * gtk_widget_get_can_default:
5410 * @widget: a #GtkWidget
5412 * Determines whether @widget can be a default widget. See
5413 * gtk_widget_set_can_default().
5415 * Return value: %TRUE if @widget can be a default widget, %FALSE otherwise
5420 gtk_widget_get_can_default (GtkWidget *widget)
5422 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5424 return GTK_WIDGET_CAN_DEFAULT (widget);
5428 * gtk_widget_has_default:
5429 * @widget: a #GtkWidget
5431 * Determines whether @widget is the current default widget within its
5432 * toplevel. See gtk_widget_set_can_default().
5434 * Return value: %TRUE if @widget is the current default widget within
5435 * its toplevel, %FALSE otherwise
5440 gtk_widget_has_default (GtkWidget *widget)
5442 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5444 return GTK_WIDGET_HAS_DEFAULT (widget);
5448 * gtk_widget_grab_default:
5449 * @widget: a #GtkWidget
5451 * Causes @widget to become the default widget. @widget must have the
5452 * %GTK_CAN_DEFAULT flag set; typically you have to set this flag
5453 * yourself by calling <literal>gtk_widget_set_can_default (@widget,
5454 * %TRUE)</literal>. The default widget is activated when
5455 * the user presses Enter in a window. Default widgets must be
5456 * activatable, that is, gtk_widget_activate() should affect them.
5459 gtk_widget_grab_default (GtkWidget *widget)
5463 g_return_if_fail (GTK_IS_WIDGET (widget));
5464 g_return_if_fail (GTK_WIDGET_CAN_DEFAULT (widget));
5466 window = gtk_widget_get_toplevel (widget);
5468 if (window && GTK_WIDGET_TOPLEVEL (window))
5469 gtk_window_set_default (GTK_WINDOW (window), widget);
5471 g_warning (G_STRLOC ": widget not within a GtkWindow");
5475 * gtk_widget_has_grab:
5476 * @widget: a #GtkWidget
5478 * Determines whether the widget is currently grabbing events, so it
5479 * is the only widget receiving input events (keyboard and mouse).
5481 * See also gtk_grab_add().
5483 * Return value: %TRUE if the widget is in the grab_widgets stack
5488 gtk_widget_has_grab (GtkWidget *widget)
5490 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5492 return (GTK_WIDGET_FLAGS (widget) & GTK_HAS_GRAB) != 0;
5496 * gtk_widget_set_name:
5497 * @widget: a #GtkWidget
5498 * @name: name for the widget
5500 * Widgets can be named, which allows you to refer to them from a
5501 * gtkrc file. You can apply a style to widgets with a particular name
5502 * in the gtkrc file. See the documentation for gtkrc files (on the
5503 * same page as the docs for #GtkRcStyle).
5505 * Note that widget names are separated by periods in paths (see
5506 * gtk_widget_path()), so names with embedded periods may cause confusion.
5509 gtk_widget_set_name (GtkWidget *widget,
5514 g_return_if_fail (GTK_IS_WIDGET (widget));
5516 new_name = g_strdup (name);
5517 g_free (widget->name);
5518 widget->name = new_name;
5520 if (GTK_WIDGET_RC_STYLE (widget))
5521 gtk_widget_reset_rc_style (widget);
5523 g_object_notify (G_OBJECT (widget), "name");
5527 * gtk_widget_get_name:
5528 * @widget: a #GtkWidget
5530 * Retrieves the name of a widget. See gtk_widget_set_name() for the
5531 * significance of widget names.
5533 * Return value: name of the widget. This string is owned by GTK+ and
5534 * should not be modified or freed
5536 G_CONST_RETURN gchar*
5537 gtk_widget_get_name (GtkWidget *widget)
5539 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5542 return widget->name;
5543 return g_type_name (GTK_WIDGET_TYPE (widget));
5547 * gtk_widget_set_state:
5548 * @widget: a #GtkWidget
5549 * @state: new state for @widget
5551 * This function is for use in widget implementations. Sets the state
5552 * of a widget (insensitive, prelighted, etc.) Usually you should set
5553 * the state using wrapper functions such as gtk_widget_set_sensitive().
5556 gtk_widget_set_state (GtkWidget *widget,
5559 g_return_if_fail (GTK_IS_WIDGET (widget));
5561 if (state == GTK_WIDGET_STATE (widget))
5564 if (state == GTK_STATE_INSENSITIVE)
5565 gtk_widget_set_sensitive (widget, FALSE);
5571 data.state_restoration = FALSE;
5572 data.use_forall = FALSE;
5574 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget->parent) != FALSE);
5576 data.parent_sensitive = TRUE;
5578 gtk_widget_propagate_state (widget, &data);
5580 if (GTK_WIDGET_DRAWABLE (widget))
5581 gtk_widget_queue_draw (widget);
5586 * gtk_widget_get_state:
5587 * @widget: a #GtkWidget
5589 * Returns the widget's state. See gtk_widget_set_state().
5591 * Returns: the state of @widget.
5596 gtk_widget_get_state (GtkWidget *widget)
5598 g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_STATE_NORMAL);
5600 return widget->state;
5604 * gtk_widget_set_visible:
5605 * @widget: a #GtkWidget
5606 * @visible: whether the widget should be shown or not
5608 * Sets the visibility state of @widget. Note that setting this to
5609 * %TRUE doesn't mean the widget is actually viewable, see
5610 * gtk_widget_get_visible().
5612 * This function simply calls gtk_widget_show() or gtk_widget_hide()
5613 * but is nicer to use when the visibility of the widget depends on
5619 gtk_widget_set_visible (GtkWidget *widget,
5622 g_return_if_fail (GTK_IS_WIDGET (widget));
5624 if (visible != GTK_WIDGET_VISIBLE (widget))
5627 gtk_widget_show (widget);
5629 gtk_widget_hide (widget);
5634 * gtk_widget_get_visible:
5635 * @widget: a #GtkWidget
5637 * Determines whether the widget is visible. Note that this doesn't
5638 * take into account whether the widget's parent is also visible
5639 * or the widget is obscured in any way.
5641 * See gtk_widget_set_visible().
5643 * Return value: %TRUE if the widget is visible
5648 gtk_widget_get_visible (GtkWidget *widget)
5650 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5652 return (GTK_WIDGET_FLAGS (widget) & GTK_VISIBLE) != 0;
5656 * gtk_widget_set_has_window:
5657 * @widget: a #GtkWidget
5658 * @has_window: whether or not @widget has a window.
5660 * Specifies whether @widget has a #GdkWindow of its own. Note that
5661 * all realized widgets have a non-%NULL "window" pointer
5662 * (gtk_widget_get_window() never returns a %NULL window when a widget
5663 * is realized), but for many of them it's actually the #GdkWindow of
5664 * one of its parent widgets. Widgets that create a %window for
5665 * themselves in GtkWidget::realize() however must announce this by
5666 * calling this function with @has_window = %TRUE.
5668 * This function should only be called by widget implementations,
5669 * and they should call it in their init() function.
5674 gtk_widget_set_has_window (GtkWidget *widget,
5675 gboolean has_window)
5677 g_return_if_fail (GTK_IS_WIDGET (widget));
5680 GTK_WIDGET_UNSET_FLAGS (widget, GTK_NO_WINDOW);
5682 GTK_WIDGET_SET_FLAGS (widget, GTK_NO_WINDOW);
5686 * gtk_widget_get_has_window:
5687 * @widget: a #GtkWidget
5689 * Determines whether @widget has a #GdkWindow of its own. See
5690 * gtk_widget_set_has_window().
5692 * Return value: %TRUE if @widget has a window, %FALSE otherwise
5697 gtk_widget_get_has_window (GtkWidget *widget)
5699 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5701 return !GTK_WIDGET_NO_WINDOW (widget);
5705 * gtk_widget_is_toplevel:
5706 * @widget: a #GtkWidget
5708 * Determines whether @widget is a toplevel widget. Currently only
5709 * #GtkWindow and #GtkInvisible are toplevel widgets. Toplevel
5710 * widgets have no parent widget.
5712 * Return value: %TRUE if @widget is a toplevel, %FALSE otherwise
5717 gtk_widget_is_toplevel (GtkWidget *widget)
5719 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5721 return (GTK_WIDGET_FLAGS (widget) & GTK_TOPLEVEL) != 0;
5725 * gtk_widget_is_drawable:
5726 * @widget: a #GtkWidget
5728 * Determines whether @widget can be drawn to. A widget can be drawn
5729 * to if it is mapped and visible.
5731 * Return value: %TRUE if @widget is drawable, %FALSE otherwise
5736 gtk_widget_is_drawable (GtkWidget *widget)
5738 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5740 return ((GTK_WIDGET_FLAGS (wid) & GTK_VISIBLE) != 0 &&
5741 (GTK_WIDGET_FLAGS (wid) & GTK_MAPPED) != 0);
5745 * gtk_widget_set_app_paintable:
5746 * @widget: a #GtkWidget
5747 * @app_paintable: %TRUE if the application will paint on the widget
5749 * Sets whether the application intends to draw on the widget in
5750 * an #GtkWidget::expose-event handler.
5752 * This is a hint to the widget and does not affect the behavior of
5753 * the GTK+ core; many widgets ignore this flag entirely. For widgets
5754 * that do pay attention to the flag, such as #GtkEventBox and #GtkWindow,
5755 * the effect is to suppress default themed drawing of the widget's
5756 * background. (Children of the widget will still be drawn.) The application
5757 * is then entirely responsible for drawing the widget background.
5759 * Note that the background is still drawn when the widget is mapped.
5760 * If this is not suitable (e.g. because you want to make a transparent
5761 * window using an RGBA visual), you can work around this by doing:
5763 * gtk_widget_realize (window);
5764 * gdk_window_set_back_pixmap (window->window, NULL, FALSE);
5765 * gtk_widget_show (window);
5769 gtk_widget_set_app_paintable (GtkWidget *widget,
5770 gboolean app_paintable)
5772 g_return_if_fail (GTK_IS_WIDGET (widget));
5774 app_paintable = (app_paintable != FALSE);
5776 if (GTK_WIDGET_APP_PAINTABLE (widget) != app_paintable)
5779 GTK_WIDGET_SET_FLAGS (widget, GTK_APP_PAINTABLE);
5781 GTK_WIDGET_UNSET_FLAGS (widget, GTK_APP_PAINTABLE);
5783 if (GTK_WIDGET_DRAWABLE (widget))
5784 gtk_widget_queue_draw (widget);
5786 g_object_notify (G_OBJECT (widget), "app-paintable");
5791 * gtk_widget_get_app_paintable:
5792 * @widget: a #GtkWidget
5794 * Determines whether the application intends to draw on the widget in
5795 * an #GtkWidget::expose-event handler.
5797 * See gtk_widget_set_app_paintable()
5799 * Return value: %TRUE if the widget is app paintable
5804 gtk_widget_get_app_paintable (GtkWidget *widget)
5806 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5808 return (GTK_WIDGET_FLAGS (widget) & GTK_APP_PAINTABLE) != 0;
5812 * gtk_widget_set_double_buffered:
5813 * @widget: a #GtkWidget
5814 * @double_buffered: %TRUE to double-buffer a widget
5816 * Widgets are double buffered by default; you can use this function
5817 * to turn off the buffering. "Double buffered" simply means that
5818 * gdk_window_begin_paint_region() and gdk_window_end_paint() are called
5819 * automatically around expose events sent to the
5820 * widget. gdk_window_begin_paint() diverts all drawing to a widget's
5821 * window to an offscreen buffer, and gdk_window_end_paint() draws the
5822 * buffer to the screen. The result is that users see the window
5823 * update in one smooth step, and don't see individual graphics
5824 * primitives being rendered.
5826 * In very simple terms, double buffered widgets don't flicker,
5827 * so you would only use this function to turn off double buffering
5828 * if you had special needs and really knew what you were doing.
5830 * Note: if you turn off double-buffering, you have to handle
5831 * expose events, since even the clearing to the background color or
5832 * pixmap will not happen automatically (as it is done in
5833 * gdk_window_begin_paint()).
5836 gtk_widget_set_double_buffered (GtkWidget *widget,
5837 gboolean double_buffered)
5839 g_return_if_fail (GTK_IS_WIDGET (widget));
5841 if (double_buffered != GTK_WIDGET_DOUBLE_BUFFERED (widget))
5843 if (double_buffered)
5844 GTK_WIDGET_SET_FLAGS (widget, GTK_DOUBLE_BUFFERED);
5846 GTK_WIDGET_UNSET_FLAGS (widget, GTK_DOUBLE_BUFFERED);
5848 g_object_notify (G_OBJECT (widget), "double-buffered");
5853 * gtk_widget_get_double_buffered:
5854 * @widget: a #GtkWidget
5856 * Determines whether the widget is double buffered.
5858 * See gtk_widget_set_double_buffered()
5860 * Return value: %TRUE if the widget is double buffered
5865 gtk_widget_get_double_buffered (GtkWidget *widget)
5867 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5869 return (GTK_WIDGET_FLAGS (widget) & GTK_DOUBLE_BUFFERED) != 0;
5873 * gtk_widget_set_redraw_on_allocate:
5874 * @widget: a #GtkWidget
5875 * @redraw_on_allocate: if %TRUE, the entire widget will be redrawn
5876 * when it is allocated to a new size. Otherwise, only the
5877 * new portion of the widget will be redrawn.
5879 * Sets whether the entire widget is queued for drawing when its size
5880 * allocation changes. By default, this setting is %TRUE and
5881 * the entire widget is redrawn on every size change. If your widget
5882 * leaves the upper left unchanged when made bigger, turning this
5883 * setting off will improve performance.
5885 * Note that for %NO_WINDOW widgets setting this flag to %FALSE turns
5886 * off all allocation on resizing: the widget will not even redraw if
5887 * its position changes; this is to allow containers that don't draw
5888 * anything to avoid excess invalidations. If you set this flag on a
5889 * %NO_WINDOW widget that <emphasis>does</emphasis> draw on @widget->window,
5890 * you are responsible for invalidating both the old and new allocation
5891 * of the widget when the widget is moved and responsible for invalidating
5892 * regions newly when the widget increases size.
5895 gtk_widget_set_redraw_on_allocate (GtkWidget *widget,
5896 gboolean redraw_on_allocate)
5898 g_return_if_fail (GTK_IS_WIDGET (widget));
5900 if (redraw_on_allocate)
5901 GTK_PRIVATE_SET_FLAG (widget, GTK_REDRAW_ON_ALLOC);
5903 GTK_PRIVATE_UNSET_FLAG (widget, GTK_REDRAW_ON_ALLOC);
5907 * gtk_widget_set_sensitive:
5908 * @widget: a #GtkWidget
5909 * @sensitive: %TRUE to make the widget sensitive
5911 * Sets the sensitivity of a widget. A widget is sensitive if the user
5912 * can interact with it. Insensitive widgets are "grayed out" and the
5913 * user can't interact with them. Insensitive widgets are known as
5914 * "inactive", "disabled", or "ghosted" in some other toolkits.
5917 gtk_widget_set_sensitive (GtkWidget *widget,
5922 g_return_if_fail (GTK_IS_WIDGET (widget));
5924 sensitive = (sensitive != FALSE);
5926 if (sensitive == (GTK_WIDGET_SENSITIVE (widget) != FALSE))
5931 GTK_WIDGET_SET_FLAGS (widget, GTK_SENSITIVE);
5932 data.state = GTK_WIDGET_SAVED_STATE (widget);
5936 GTK_WIDGET_UNSET_FLAGS (widget, GTK_SENSITIVE);
5937 data.state = GTK_WIDGET_STATE (widget);
5939 data.state_restoration = TRUE;
5940 data.use_forall = TRUE;
5943 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget->parent) != FALSE);
5945 data.parent_sensitive = TRUE;
5947 gtk_widget_propagate_state (widget, &data);
5948 if (GTK_WIDGET_DRAWABLE (widget))
5949 gtk_widget_queue_draw (widget);
5951 g_object_notify (G_OBJECT (widget), "sensitive");
5955 * gtk_widget_get_sensitive:
5956 * @widget: a #GtkWidget
5958 * Returns the widget's sensitivity (in the sense of returning
5959 * the value that has been set using gtk_widget_set_sensitive()).
5961 * The effective sensitivity of a widget is however determined by both its
5962 * own and its parent widget's sensitivity. See gtk_widget_is_sensitive().
5964 * Returns: %TRUE if the widget is sensitive
5969 gtk_widget_get_sensitive (GtkWidget *widget)
5971 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5973 return GTK_WIDGET_SENSITIVE (widget);
5977 * gtk_widget_is_sensitive:
5978 * @widget: a #GtkWidget
5980 * Returns the widget's effective sensitivity, which means
5981 * it is sensitive itself and also its parent widget is sensntive
5983 * Returns: %TRUE if the widget is effectively sensitive
5988 gtk_widget_is_sensitive (GtkWidget *widget)
5990 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5992 return GTK_WIDGET_IS_SENSITIVE (widget);
5996 * gtk_widget_set_parent:
5997 * @widget: a #GtkWidget
5998 * @parent: parent container
6000 * This function is useful only when implementing subclasses of
6002 * Sets the container as the parent of @widget, and takes care of
6003 * some details such as updating the state and style of the child
6004 * to reflect its new location. The opposite function is
6005 * gtk_widget_unparent().
6008 gtk_widget_set_parent (GtkWidget *widget,
6013 g_return_if_fail (GTK_IS_WIDGET (widget));
6014 g_return_if_fail (GTK_IS_WIDGET (parent));
6015 g_return_if_fail (widget != parent);
6016 if (widget->parent != NULL)
6018 g_warning ("Can't set a parent on widget which has a parent\n");
6021 if (GTK_WIDGET_TOPLEVEL (widget))
6023 g_warning ("Can't set a parent on a toplevel widget\n");
6027 /* keep this function in sync with gtk_menu_attach_to_widget()
6030 g_object_ref_sink (widget);
6031 widget->parent = parent;
6033 if (GTK_WIDGET_STATE (parent) != GTK_STATE_NORMAL)
6034 data.state = GTK_WIDGET_STATE (parent);
6036 data.state = GTK_WIDGET_STATE (widget);
6037 data.state_restoration = FALSE;
6038 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (parent) != FALSE);
6039 data.use_forall = GTK_WIDGET_IS_SENSITIVE (parent) != GTK_WIDGET_IS_SENSITIVE (widget);
6041 gtk_widget_propagate_state (widget, &data);
6043 gtk_widget_reset_rc_styles (widget);
6045 g_signal_emit (widget, widget_signals[PARENT_SET], 0, NULL);
6046 if (GTK_WIDGET_ANCHORED (widget->parent))
6047 _gtk_widget_propagate_hierarchy_changed (widget, NULL);
6048 g_object_notify (G_OBJECT (widget), "parent");
6050 /* Enforce realized/mapped invariants
6052 if (GTK_WIDGET_REALIZED (widget->parent))
6053 gtk_widget_realize (widget);
6055 if (GTK_WIDGET_VISIBLE (widget->parent) &&
6056 GTK_WIDGET_VISIBLE (widget))
6058 if (GTK_WIDGET_CHILD_VISIBLE (widget) &&
6059 GTK_WIDGET_MAPPED (widget->parent))
6060 gtk_widget_map (widget);
6062 gtk_widget_queue_resize (widget);
6067 * gtk_widget_get_parent:
6068 * @widget: a #GtkWidget
6070 * Returns the parent container of @widget.
6072 * Return value: the parent container of @widget, or %NULL
6075 gtk_widget_get_parent (GtkWidget *widget)
6077 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6079 return widget->parent;
6082 /*****************************************
6084 * see docs/styles.txt
6085 *****************************************/
6088 * gtk_widget_set_style:
6089 * @widget: a #GtkWidget
6090 * @style: a #GtkStyle, or %NULL to remove the effect of a previous
6091 * gtk_widget_set_style() and go back to the default style
6093 * Sets the #GtkStyle for a widget (@widget->style). You probably don't
6094 * want to use this function; it interacts badly with themes, because
6095 * themes work by replacing the #GtkStyle. Instead, use
6096 * gtk_widget_modify_style().
6099 gtk_widget_set_style (GtkWidget *widget,
6102 g_return_if_fail (GTK_IS_WIDGET (widget));
6106 gboolean initial_emission;
6108 initial_emission = !GTK_WIDGET_RC_STYLE (widget) && !GTK_WIDGET_USER_STYLE (widget);
6110 GTK_WIDGET_UNSET_FLAGS (widget, GTK_RC_STYLE);
6111 GTK_PRIVATE_SET_FLAG (widget, GTK_USER_STYLE);
6113 gtk_widget_set_style_internal (widget, style, initial_emission);
6117 if (GTK_WIDGET_USER_STYLE (widget))
6118 gtk_widget_reset_rc_style (widget);
6123 * gtk_widget_ensure_style:
6124 * @widget: a #GtkWidget
6126 * Ensures that @widget has a style (@widget->style). Not a very useful
6127 * function; most of the time, if you want the style, the widget is
6128 * realized, and realized widgets are guaranteed to have a style
6132 gtk_widget_ensure_style (GtkWidget *widget)
6134 g_return_if_fail (GTK_IS_WIDGET (widget));
6136 if (!GTK_WIDGET_USER_STYLE (widget) &&
6137 !GTK_WIDGET_RC_STYLE (widget))
6138 gtk_widget_reset_rc_style (widget);
6141 /* Look up the RC style for this widget, unsetting any user style that
6142 * may be in effect currently
6145 gtk_widget_reset_rc_style (GtkWidget *widget)
6147 GtkStyle *new_style = NULL;
6148 gboolean initial_emission;
6150 initial_emission = !GTK_WIDGET_RC_STYLE (widget) && !GTK_WIDGET_USER_STYLE (widget);
6152 GTK_PRIVATE_UNSET_FLAG (widget, GTK_USER_STYLE);
6153 GTK_WIDGET_SET_FLAGS (widget, GTK_RC_STYLE);
6155 if (gtk_widget_has_screen (widget))
6156 new_style = gtk_rc_get_style (widget);
6158 new_style = gtk_widget_get_default_style ();
6160 if (initial_emission || new_style != widget->style)
6161 gtk_widget_set_style_internal (widget, new_style, initial_emission);
6165 * gtk_widget_get_style:
6166 * @widget: a #GtkWidget
6168 * Simply an accessor function that returns @widget->style.
6170 * Return value: the widget's #GtkStyle
6173 gtk_widget_get_style (GtkWidget *widget)
6175 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6177 return widget->style;
6181 * gtk_widget_modify_style:
6182 * @widget: a #GtkWidget
6183 * @style: the #GtkRcStyle holding the style modifications
6185 * Modifies style values on the widget. Modifications made using this
6186 * technique take precedence over style values set via an RC file,
6187 * however, they will be overriden if a style is explicitely set on
6188 * the widget using gtk_widget_set_style(). The #GtkRcStyle structure
6189 * is designed so each field can either be set or unset, so it is
6190 * possible, using this function, to modify some style values and
6191 * leave the others unchanged.
6193 * Note that modifications made with this function are not cumulative
6194 * with previous calls to gtk_widget_modify_style() or with such
6195 * functions as gtk_widget_modify_fg(). If you wish to retain
6196 * previous values, you must first call gtk_widget_get_modifier_style(),
6197 * make your modifications to the returned style, then call
6198 * gtk_widget_modify_style() with that style. On the other hand,
6199 * if you first call gtk_widget_modify_style(), subsequent calls
6200 * to such functions gtk_widget_modify_fg() will have a cumulative
6201 * effect with the initial modifications.
6204 gtk_widget_modify_style (GtkWidget *widget,
6207 g_return_if_fail (GTK_IS_WIDGET (widget));
6208 g_return_if_fail (GTK_IS_RC_STYLE (style));
6210 g_object_set_qdata_full (G_OBJECT (widget),
6212 gtk_rc_style_copy (style),
6213 (GDestroyNotify) g_object_unref);
6215 /* note that "style" may be invalid here if it was the old
6216 * modifier style and the only reference was our own.
6219 if (GTK_WIDGET_RC_STYLE (widget))
6220 gtk_widget_reset_rc_style (widget);
6224 * gtk_widget_get_modifier_style:
6225 * @widget: a #GtkWidget
6227 * Returns the current modifier style for the widget. (As set by
6228 * gtk_widget_modify_style().) If no style has previously set, a new
6229 * #GtkRcStyle will be created with all values unset, and set as the
6230 * modifier style for the widget. If you make changes to this rc
6231 * style, you must call gtk_widget_modify_style(), passing in the
6232 * returned rc style, to make sure that your changes take effect.
6234 * Caution: passing the style back to gtk_widget_modify_style() will
6235 * normally end up destroying it, because gtk_widget_modify_style() copies
6236 * the passed-in style and sets the copy as the new modifier style,
6237 * thus dropping any reference to the old modifier style. Add a reference
6238 * to the modifier style if you want to keep it alive.
6240 * Return value: the modifier style for the widget. This rc style is
6241 * owned by the widget. If you want to keep a pointer to value this
6242 * around, you must add a refcount using g_object_ref().
6245 gtk_widget_get_modifier_style (GtkWidget *widget)
6247 GtkRcStyle *rc_style;
6249 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6251 rc_style = g_object_get_qdata (G_OBJECT (widget), quark_rc_style);
6255 rc_style = gtk_rc_style_new ();
6256 g_object_set_qdata_full (G_OBJECT (widget),
6259 (GDestroyNotify) g_object_unref);
6266 gtk_widget_modify_color_component (GtkWidget *widget,
6267 GtkRcFlags component,
6269 const GdkColor *color)
6271 GtkRcStyle *rc_style = gtk_widget_get_modifier_style (widget);
6278 rc_style->fg[state] = *color;
6281 rc_style->bg[state] = *color;
6284 rc_style->text[state] = *color;
6287 rc_style->base[state] = *color;
6290 g_assert_not_reached();
6293 rc_style->color_flags[state] |= component;
6296 rc_style->color_flags[state] &= ~component;
6298 gtk_widget_modify_style (widget, rc_style);
6302 * gtk_widget_modify_fg:
6303 * @widget: a #GtkWidget
6304 * @state: the state for which to set the foreground color
6305 * @color: the color to assign (does not need to be allocated),
6306 * or %NULL to undo the effect of previous calls to
6307 * of gtk_widget_modify_fg().
6309 * Sets the foreground color for a widget in a particular state.
6310 * All other style values are left untouched. See also
6311 * gtk_widget_modify_style().
6314 gtk_widget_modify_fg (GtkWidget *widget,
6316 const GdkColor *color)
6318 g_return_if_fail (GTK_IS_WIDGET (widget));
6319 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
6321 gtk_widget_modify_color_component (widget, GTK_RC_FG, state, color);
6325 * gtk_widget_modify_bg:
6326 * @widget: a #GtkWidget
6327 * @state: the state for which to set the background color
6328 * @color: the color to assign (does not need to be allocated),
6329 * or %NULL to undo the effect of previous calls to
6330 * of gtk_widget_modify_bg().
6332 * Sets the background color for a widget in a particular state.
6333 * All other style values are left untouched. See also
6334 * gtk_widget_modify_style().
6336 * Note that "no window" widgets (which have the %GTK_NO_WINDOW flag set)
6337 * draw on their parent container's window and thus may not draw any
6338 * background themselves. This is the case for e.g. #GtkLabel. To modify
6339 * the background of such widgets, you have to set the background color
6340 * on their parent; if you want to set the background of a rectangular
6341 * area around a label, try placing the label in a #GtkEventBox widget
6342 * and setting the background color on that.
6345 gtk_widget_modify_bg (GtkWidget *widget,
6347 const GdkColor *color)
6349 g_return_if_fail (GTK_IS_WIDGET (widget));
6350 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
6352 gtk_widget_modify_color_component (widget, GTK_RC_BG, state, color);
6356 * gtk_widget_modify_text:
6357 * @widget: a #GtkWidget
6358 * @state: the state for which to set the text color
6359 * @color: the color to assign (does not need to be allocated),
6360 * or %NULL to undo the effect of previous calls to
6361 * of gtk_widget_modify_text().
6363 * Sets the text color for a widget in a particular state. All other
6364 * style values are left untouched. The text color is the foreground
6365 * color used along with the base color (see gtk_widget_modify_base())
6366 * for widgets such as #GtkEntry and #GtkTextView. See also
6367 * gtk_widget_modify_style().
6370 gtk_widget_modify_text (GtkWidget *widget,
6372 const GdkColor *color)
6374 g_return_if_fail (GTK_IS_WIDGET (widget));
6375 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
6377 gtk_widget_modify_color_component (widget, GTK_RC_TEXT, state, color);
6381 * gtk_widget_modify_base:
6382 * @widget: a #GtkWidget
6383 * @state: the state for which to set the base color
6384 * @color: the color to assign (does not need to be allocated),
6385 * or %NULL to undo the effect of previous calls to
6386 * of gtk_widget_modify_base().
6388 * Sets the base color for a widget in a particular state.
6389 * All other style values are left untouched. The base color
6390 * is the background color used along with the text color
6391 * (see gtk_widget_modify_text()) for widgets such as #GtkEntry
6392 * and #GtkTextView. See also gtk_widget_modify_style().
6394 * Note that "no window" widgets (which have the %GTK_NO_WINDOW flag set)
6395 * draw on their parent container's window and thus may not draw any
6396 * background themselves. This is the case for e.g. #GtkLabel. To modify
6397 * the background of such widgets, you have to set the base color on their
6398 * parent; if you want to set the background of a rectangular area around
6399 * a label, try placing the label in a #GtkEventBox widget and setting
6400 * the base color on that.
6403 gtk_widget_modify_base (GtkWidget *widget,
6405 const GdkColor *color)
6407 g_return_if_fail (GTK_IS_WIDGET (widget));
6408 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
6410 gtk_widget_modify_color_component (widget, GTK_RC_BASE, state, color);
6414 modify_color_property (GtkWidget *widget,
6415 GtkRcStyle *rc_style,
6417 const GdkColor *color)
6419 GQuark type_name = g_type_qname (G_OBJECT_TYPE (widget));
6420 GQuark property_name = g_quark_from_string (name);
6424 GtkRcProperty rc_property = {0};
6427 rc_property.type_name = type_name;
6428 rc_property.property_name = property_name;
6429 rc_property.origin = NULL;
6431 color_name = gdk_color_to_string (color);
6432 g_value_init (&rc_property.value, G_TYPE_STRING);
6433 g_value_take_string (&rc_property.value, color_name);
6435 _gtk_rc_style_set_rc_property (rc_style, &rc_property);
6437 g_value_unset (&rc_property.value);
6440 _gtk_rc_style_unset_rc_property (rc_style, type_name, property_name);
6444 * gtk_widget_modify_cursor:
6445 * @widget: a #GtkWidget
6446 * @primary: the color to use for primary cursor (does not need to be
6447 * allocated), or %NULL to undo the effect of previous calls to
6448 * of gtk_widget_modify_cursor().
6449 * @secondary: the color to use for secondary cursor (does not need to be
6450 * allocated), or %NULL to undo the effect of previous calls to
6451 * of gtk_widget_modify_cursor().
6453 * Sets the cursor color to use in a widget, overriding the
6454 * #GtkWidget:cursor-color and #GtkWidget:secondary-cursor-color
6455 * style properties. All other style values are left untouched.
6456 * See also gtk_widget_modify_style().
6461 gtk_widget_modify_cursor (GtkWidget *widget,
6462 const GdkColor *primary,
6463 const GdkColor *secondary)
6465 GtkRcStyle *rc_style;
6467 g_return_if_fail (GTK_IS_WIDGET (widget));
6469 rc_style = gtk_widget_get_modifier_style (widget);
6471 modify_color_property (widget, rc_style, "cursor-color", primary);
6472 modify_color_property (widget, rc_style, "secondary-cursor-color", secondary);
6474 gtk_widget_modify_style (widget, rc_style);
6478 * gtk_widget_modify_font:
6479 * @widget: a #GtkWidget
6480 * @font_desc: the font description to use, or %NULL to undo
6481 * the effect of previous calls to gtk_widget_modify_font().
6483 * Sets the font to use for a widget. All other style values are left
6484 * untouched. See also gtk_widget_modify_style().
6487 gtk_widget_modify_font (GtkWidget *widget,
6488 PangoFontDescription *font_desc)
6490 GtkRcStyle *rc_style;
6492 g_return_if_fail (GTK_IS_WIDGET (widget));
6494 rc_style = gtk_widget_get_modifier_style (widget);
6496 if (rc_style->font_desc)
6497 pango_font_description_free (rc_style->font_desc);
6500 rc_style->font_desc = pango_font_description_copy (font_desc);
6502 rc_style->font_desc = NULL;
6504 gtk_widget_modify_style (widget, rc_style);
6508 gtk_widget_real_direction_changed (GtkWidget *widget,
6509 GtkTextDirection previous_direction)
6511 gtk_widget_queue_resize (widget);
6515 gtk_widget_real_style_set (GtkWidget *widget,
6516 GtkStyle *previous_style)
6518 if (GTK_WIDGET_REALIZED (widget) &&
6519 !GTK_WIDGET_NO_WINDOW (widget))
6520 gtk_style_set_background (widget->style, widget->window, widget->state);
6524 gtk_widget_set_style_internal (GtkWidget *widget,
6526 gboolean initial_emission)
6528 g_object_ref (widget);
6529 g_object_freeze_notify (G_OBJECT (widget));
6531 if (widget->style != style)
6533 GtkStyle *previous_style;
6535 if (GTK_WIDGET_REALIZED (widget))
6537 gtk_widget_reset_shapes (widget);
6538 gtk_style_detach (widget->style);
6541 previous_style = widget->style;
6542 widget->style = style;
6543 g_object_ref (widget->style);
6545 if (GTK_WIDGET_REALIZED (widget))
6546 widget->style = gtk_style_attach (widget->style, widget->window);
6548 gtk_widget_update_pango_context (widget);
6549 g_signal_emit (widget,
6550 widget_signals[STYLE_SET],
6552 initial_emission ? NULL : previous_style);
6553 g_object_unref (previous_style);
6555 if (GTK_WIDGET_ANCHORED (widget) && !initial_emission)
6556 gtk_widget_queue_resize (widget);
6558 else if (initial_emission)
6560 gtk_widget_update_pango_context (widget);
6561 g_signal_emit (widget,
6562 widget_signals[STYLE_SET],
6566 g_object_notify (G_OBJECT (widget), "style");
6567 g_object_thaw_notify (G_OBJECT (widget));
6568 g_object_unref (widget);
6572 GtkWidget *previous_toplevel;
6573 GdkScreen *previous_screen;
6574 GdkScreen *new_screen;
6575 } HierarchyChangedInfo;
6578 do_screen_change (GtkWidget *widget,
6579 GdkScreen *old_screen,
6580 GdkScreen *new_screen)
6582 if (old_screen != new_screen)
6586 PangoContext *context = g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
6588 g_object_set_qdata (G_OBJECT (widget), quark_pango_context, NULL);
6591 _gtk_tooltip_hide (widget);
6592 g_signal_emit (widget, widget_signals[SCREEN_CHANGED], 0, old_screen);
6597 gtk_widget_propagate_hierarchy_changed_recurse (GtkWidget *widget,
6598 gpointer client_data)
6600 HierarchyChangedInfo *info = client_data;
6601 gboolean new_anchored = GTK_WIDGET_TOPLEVEL (widget) ||
6602 (widget->parent && GTK_WIDGET_ANCHORED (widget->parent));
6604 if (GTK_WIDGET_ANCHORED (widget) != new_anchored)
6606 g_object_ref (widget);
6609 GTK_PRIVATE_SET_FLAG (widget, GTK_ANCHORED);
6611 GTK_PRIVATE_UNSET_FLAG (widget, GTK_ANCHORED);
6613 g_signal_emit (widget, widget_signals[HIERARCHY_CHANGED], 0, info->previous_toplevel);
6614 do_screen_change (widget, info->previous_screen, info->new_screen);
6616 if (GTK_IS_CONTAINER (widget))
6617 gtk_container_forall (GTK_CONTAINER (widget),
6618 gtk_widget_propagate_hierarchy_changed_recurse,
6621 g_object_unref (widget);
6626 * _gtk_widget_propagate_hierarchy_changed:
6627 * @widget: a #GtkWidget
6628 * @previous_toplevel: Previous toplevel
6630 * Propagates changes in the anchored state to a widget and all
6631 * children, unsetting or setting the %ANCHORED flag, and
6632 * emitting #GtkWidget::hierarchy-changed.
6635 _gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
6636 GtkWidget *previous_toplevel)
6638 HierarchyChangedInfo info;
6640 info.previous_toplevel = previous_toplevel;
6641 info.previous_screen = previous_toplevel ? gtk_widget_get_screen (previous_toplevel) : NULL;
6643 if (GTK_WIDGET_TOPLEVEL (widget) ||
6644 (widget->parent && GTK_WIDGET_ANCHORED (widget->parent)))
6645 info.new_screen = gtk_widget_get_screen (widget);
6647 info.new_screen = NULL;
6649 if (info.previous_screen)
6650 g_object_ref (info.previous_screen);
6651 if (previous_toplevel)
6652 g_object_ref (previous_toplevel);
6654 gtk_widget_propagate_hierarchy_changed_recurse (widget, &info);
6656 if (previous_toplevel)
6657 g_object_unref (previous_toplevel);
6658 if (info.previous_screen)
6659 g_object_unref (info.previous_screen);
6663 gtk_widget_propagate_screen_changed_recurse (GtkWidget *widget,
6664 gpointer client_data)
6666 HierarchyChangedInfo *info = client_data;
6668 g_object_ref (widget);
6670 do_screen_change (widget, info->previous_screen, info->new_screen);
6672 if (GTK_IS_CONTAINER (widget))
6673 gtk_container_forall (GTK_CONTAINER (widget),
6674 gtk_widget_propagate_screen_changed_recurse,
6677 g_object_unref (widget);
6681 * gtk_widget_is_composited:
6682 * @widget: a #GtkWidget
6684 * Whether @widget can rely on having its alpha channel
6685 * drawn correctly. On X11 this function returns whether a
6686 * compositing manager is running for @widget's screen.
6688 * Please note that the semantics of this call will change
6689 * in the future if used on a widget that has a composited
6690 * window in its hierarchy (as set by gdk_window_set_composited()).
6692 * Return value: %TRUE if the widget can rely on its alpha
6693 * channel being drawn correctly.
6698 gtk_widget_is_composited (GtkWidget *widget)
6702 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6704 screen = gtk_widget_get_screen (widget);
6706 return gdk_screen_is_composited (screen);
6710 propagate_composited_changed (GtkWidget *widget,
6713 if (GTK_IS_CONTAINER (widget))
6715 gtk_container_forall (GTK_CONTAINER (widget),
6716 propagate_composited_changed,
6720 g_signal_emit (widget, widget_signals[COMPOSITED_CHANGED], 0);
6724 _gtk_widget_propagate_composited_changed (GtkWidget *widget)
6726 propagate_composited_changed (widget, NULL);
6730 * _gtk_widget_propagate_screen_changed:
6731 * @widget: a #GtkWidget
6732 * @previous_screen: Previous screen
6734 * Propagates changes in the screen for a widget to all
6735 * children, emitting #GtkWidget::screen-changed.
6738 _gtk_widget_propagate_screen_changed (GtkWidget *widget,
6739 GdkScreen *previous_screen)
6741 HierarchyChangedInfo info;
6743 info.previous_screen = previous_screen;
6744 info.new_screen = gtk_widget_get_screen (widget);
6746 if (previous_screen)
6747 g_object_ref (previous_screen);
6749 gtk_widget_propagate_screen_changed_recurse (widget, &info);
6751 if (previous_screen)
6752 g_object_unref (previous_screen);
6756 reset_rc_styles_recurse (GtkWidget *widget, gpointer data)
6758 if (GTK_WIDGET_RC_STYLE (widget))
6759 gtk_widget_reset_rc_style (widget);
6761 if (GTK_IS_CONTAINER (widget))
6762 gtk_container_forall (GTK_CONTAINER (widget),
6763 reset_rc_styles_recurse,
6768 gtk_widget_reset_rc_styles (GtkWidget *widget)
6770 g_return_if_fail (GTK_IS_WIDGET (widget));
6772 reset_rc_styles_recurse (widget, NULL);
6776 * gtk_widget_get_default_style:
6778 * Returns the default style used by all widgets initially.
6780 * Returns: the default style. This #GtkStyle object is owned
6781 * by GTK+ and should not be modified or freed.
6784 gtk_widget_get_default_style (void)
6786 if (!gtk_default_style)
6788 gtk_default_style = gtk_style_new ();
6789 g_object_ref (gtk_default_style);
6792 return gtk_default_style;
6795 static PangoContext *
6796 gtk_widget_peek_pango_context (GtkWidget *widget)
6798 return g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
6802 * gtk_widget_get_pango_context:
6803 * @widget: a #GtkWidget
6805 * Gets a #PangoContext with the appropriate font map, font description,
6806 * and base direction for this widget. Unlike the context returned
6807 * by gtk_widget_create_pango_context(), this context is owned by
6808 * the widget (it can be used until the screen for the widget changes
6809 * or the widget is removed from its toplevel), and will be updated to
6810 * match any changes to the widget's attributes.
6812 * If you create and keep a #PangoLayout using this context, you must
6813 * deal with changes to the context by calling pango_layout_context_changed()
6814 * on the layout in response to the #GtkWidget::style-set and
6815 * #GtkWidget::direction-changed signals for the widget.
6817 * Return value: the #PangoContext for the widget.
6820 gtk_widget_get_pango_context (GtkWidget *widget)
6822 PangoContext *context;
6824 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6826 context = g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
6829 context = gtk_widget_create_pango_context (GTK_WIDGET (widget));
6830 g_object_set_qdata_full (G_OBJECT (widget),
6831 quark_pango_context,
6840 update_pango_context (GtkWidget *widget,
6841 PangoContext *context)
6843 pango_context_set_font_description (context, widget->style->font_desc);
6844 pango_context_set_base_dir (context,
6845 gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR ?
6846 PANGO_DIRECTION_LTR : PANGO_DIRECTION_RTL);
6850 gtk_widget_update_pango_context (GtkWidget *widget)
6852 PangoContext *context = gtk_widget_peek_pango_context (widget);
6858 update_pango_context (widget, context);
6860 screen = gtk_widget_get_screen_unchecked (widget);
6863 pango_cairo_context_set_resolution (context,
6864 gdk_screen_get_resolution (screen));
6865 pango_cairo_context_set_font_options (context,
6866 gdk_screen_get_font_options (screen));
6872 * gtk_widget_create_pango_context:
6873 * @widget: a #GtkWidget
6875 * Creates a new #PangoContext with the appropriate font map,
6876 * font description, and base direction for drawing text for
6877 * this widget. See also gtk_widget_get_pango_context().
6879 * Return value: the new #PangoContext
6882 gtk_widget_create_pango_context (GtkWidget *widget)
6885 PangoContext *context;
6887 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6889 screen = gtk_widget_get_screen_unchecked (widget);
6892 GTK_NOTE (MULTIHEAD,
6893 g_warning ("gtk_widget_create_pango_context ()) called without screen"));
6895 screen = gdk_screen_get_default ();
6898 context = gdk_pango_context_get_for_screen (screen);
6900 update_pango_context (widget, context);
6901 pango_context_set_language (context, gtk_get_default_language ());
6907 * gtk_widget_create_pango_layout:
6908 * @widget: a #GtkWidget
6909 * @text: text to set on the layout (can be %NULL)
6911 * Creates a new #PangoLayout with the appropriate font map,
6912 * font description, and base direction for drawing text for
6915 * If you keep a #PangoLayout created in this way around, in order to
6916 * notify the layout of changes to the base direction or font of this
6917 * widget, you must call pango_layout_context_changed() in response to
6918 * the #GtkWidget::style-set and #GtkWidget::direction-changed signals
6921 * Return value: the new #PangoLayout
6924 gtk_widget_create_pango_layout (GtkWidget *widget,
6927 PangoLayout *layout;
6928 PangoContext *context;
6930 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6932 context = gtk_widget_get_pango_context (widget);
6933 layout = pango_layout_new (context);
6936 pango_layout_set_text (layout, text, -1);
6942 * gtk_widget_render_icon:
6943 * @widget: a #GtkWidget
6944 * @stock_id: a stock ID
6945 * @size: a stock size. A size of (GtkIconSize)-1 means render at
6946 * the size of the source and don't scale (if there are multiple
6947 * source sizes, GTK+ picks one of the available sizes).
6948 * @detail: render detail to pass to theme engine
6950 * A convenience function that uses the theme engine and RC file
6951 * settings for @widget to look up @stock_id and render it to
6952 * a pixbuf. @stock_id should be a stock icon ID such as
6953 * #GTK_STOCK_OPEN or #GTK_STOCK_OK. @size should be a size
6954 * such as #GTK_ICON_SIZE_MENU. @detail should be a string that
6955 * identifies the widget or code doing the rendering, so that
6956 * theme engines can special-case rendering for that widget or code.
6958 * The pixels in the returned #GdkPixbuf are shared with the rest of
6959 * the application and should not be modified. The pixbuf should be freed
6960 * after use with g_object_unref().
6962 * Return value: a new pixbuf, or %NULL if the stock ID wasn't known
6965 gtk_widget_render_icon (GtkWidget *widget,
6966 const gchar *stock_id,
6968 const gchar *detail)
6970 GtkIconSet *icon_set;
6973 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6974 g_return_val_if_fail (stock_id != NULL, NULL);
6975 g_return_val_if_fail (size > GTK_ICON_SIZE_INVALID || size == -1, NULL);
6977 gtk_widget_ensure_style (widget);
6979 icon_set = gtk_style_lookup_icon_set (widget->style, stock_id);
6981 if (icon_set == NULL)
6984 retval = gtk_icon_set_render_icon (icon_set,
6986 gtk_widget_get_direction (widget),
6987 GTK_WIDGET_STATE (widget),
6996 * gtk_widget_set_parent_window:
6997 * @widget: a #GtkWidget.
6998 * @parent_window: the new parent window.
7000 * Sets a non default parent window for @widget.
7003 gtk_widget_set_parent_window (GtkWidget *widget,
7004 GdkWindow *parent_window)
7006 GdkWindow *old_parent_window;
7008 g_return_if_fail (GTK_IS_WIDGET (widget));
7010 old_parent_window = g_object_get_qdata (G_OBJECT (widget),
7011 quark_parent_window);
7013 if (parent_window != old_parent_window)
7015 g_object_set_qdata (G_OBJECT (widget), quark_parent_window,
7017 if (old_parent_window)
7018 g_object_unref (old_parent_window);
7020 g_object_ref (parent_window);
7025 * gtk_widget_get_parent_window:
7026 * @widget: a #GtkWidget.
7027 * @returns: the parent window of @widget.
7029 * Gets @widget's parent window.
7032 gtk_widget_get_parent_window (GtkWidget *widget)
7034 GdkWindow *parent_window;
7036 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7038 parent_window = g_object_get_qdata (G_OBJECT (widget), quark_parent_window);
7040 return (parent_window != NULL) ? parent_window :
7041 (widget->parent != NULL) ? widget->parent->window : NULL;
7046 * gtk_widget_set_child_visible:
7047 * @widget: a #GtkWidget
7048 * @is_visible: if %TRUE, @widget should be mapped along with its parent.
7050 * Sets whether @widget should be mapped along with its when its parent
7051 * is mapped and @widget has been shown with gtk_widget_show().
7053 * The child visibility can be set for widget before it is added to
7054 * a container with gtk_widget_set_parent(), to avoid mapping
7055 * children unnecessary before immediately unmapping them. However
7056 * it will be reset to its default state of %TRUE when the widget
7057 * is removed from a container.
7059 * Note that changing the child visibility of a widget does not
7060 * queue a resize on the widget. Most of the time, the size of
7061 * a widget is computed from all visible children, whether or
7062 * not they are mapped. If this is not the case, the container
7063 * can queue a resize itself.
7065 * This function is only useful for container implementations and
7066 * never should be called by an application.
7069 gtk_widget_set_child_visible (GtkWidget *widget,
7070 gboolean is_visible)
7072 g_return_if_fail (GTK_IS_WIDGET (widget));
7073 g_return_if_fail (!GTK_WIDGET_TOPLEVEL (widget));
7075 g_object_ref (widget);
7078 GTK_PRIVATE_SET_FLAG (widget, GTK_CHILD_VISIBLE);
7081 GtkWidget *toplevel;
7083 GTK_PRIVATE_UNSET_FLAG (widget, GTK_CHILD_VISIBLE);
7085 toplevel = gtk_widget_get_toplevel (widget);
7086 if (toplevel != widget && GTK_WIDGET_TOPLEVEL (toplevel))
7087 _gtk_window_unset_focus_and_default (GTK_WINDOW (toplevel), widget);
7090 if (widget->parent && GTK_WIDGET_REALIZED (widget->parent))
7092 if (GTK_WIDGET_MAPPED (widget->parent) &&
7093 GTK_WIDGET_CHILD_VISIBLE (widget) &&
7094 GTK_WIDGET_VISIBLE (widget))
7095 gtk_widget_map (widget);
7097 gtk_widget_unmap (widget);
7100 g_object_unref (widget);
7104 * gtk_widget_get_child_visible:
7105 * @widget: a #GtkWidget
7107 * Gets the value set with gtk_widget_set_child_visible().
7108 * If you feel a need to use this function, your code probably
7109 * needs reorganization.
7111 * This function is only useful for container implementations and
7112 * never should be called by an application.
7114 * Return value: %TRUE if the widget is mapped with the parent.
7117 gtk_widget_get_child_visible (GtkWidget *widget)
7119 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7121 return GTK_WIDGET_CHILD_VISIBLE (widget);
7125 gtk_widget_get_screen_unchecked (GtkWidget *widget)
7127 GtkWidget *toplevel;
7129 toplevel = gtk_widget_get_toplevel (widget);
7131 if (GTK_WIDGET_TOPLEVEL (toplevel))
7133 if (GTK_IS_WINDOW (toplevel))
7134 return GTK_WINDOW (toplevel)->screen;
7135 else if (GTK_IS_INVISIBLE (toplevel))
7136 return GTK_INVISIBLE (widget)->screen;
7143 * gtk_widget_get_screen:
7144 * @widget: a #GtkWidget
7146 * Get the #GdkScreen from the toplevel window associated with
7147 * this widget. This function can only be called after the widget
7148 * has been added to a widget hierarchy with a #GtkWindow
7151 * In general, you should only create screen specific
7152 * resources when a widget has been realized, and you should
7153 * free those resources when the widget is unrealized.
7155 * Return value: the #GdkScreen for the toplevel for this widget.
7160 gtk_widget_get_screen (GtkWidget *widget)
7164 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7166 screen = gtk_widget_get_screen_unchecked (widget);
7173 g_warning (G_STRLOC ": Can't get associated screen"
7174 " for a widget unless it is inside a toplevel GtkWindow\n"
7175 " widget type is %s associated top level type is %s",
7176 g_type_name (G_OBJECT_TYPE(G_OBJECT (widget))),
7177 g_type_name (G_OBJECT_TYPE(G_OBJECT (toplevel))));
7179 return gdk_screen_get_default ();
7184 * gtk_widget_has_screen:
7185 * @widget: a #GtkWidget
7187 * Checks whether there is a #GdkScreen is associated with
7188 * this widget. All toplevel widgets have an associated
7189 * screen, and all widgets added into a hierarchy with a toplevel
7190 * window at the top.
7192 * Return value: %TRUE if there is a #GdkScreen associcated
7198 gtk_widget_has_screen (GtkWidget *widget)
7200 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7202 return (gtk_widget_get_screen_unchecked (widget) != NULL);
7206 * gtk_widget_get_display:
7207 * @widget: a #GtkWidget
7209 * Get the #GdkDisplay for the toplevel window associated with
7210 * this widget. This function can only be called after the widget
7211 * has been added to a widget hierarchy with a #GtkWindow at the top.
7213 * In general, you should only create display specific
7214 * resources when a widget has been realized, and you should
7215 * free those resources when the widget is unrealized.
7217 * Return value: the #GdkDisplay for the toplevel for this widget.
7222 gtk_widget_get_display (GtkWidget *widget)
7224 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7226 return gdk_screen_get_display (gtk_widget_get_screen (widget));
7230 * gtk_widget_get_root_window:
7231 * @widget: a #GtkWidget
7233 * Get the root window where this widget is located. This function can
7234 * only be called after the widget has been added to a widget
7235 * hierarchy with #GtkWindow at the top.
7237 * The root window is useful for such purposes as creating a popup
7238 * #GdkWindow associated with the window. In general, you should only
7239 * create display specific resources when a widget has been realized,
7240 * and you should free those resources when the widget is unrealized.
7242 * Return value: the #GdkWindow root window for the toplevel for this widget.
7247 gtk_widget_get_root_window (GtkWidget *widget)
7249 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7251 return gdk_screen_get_root_window (gtk_widget_get_screen (widget));
7255 * gtk_widget_child_focus:
7256 * @widget: a #GtkWidget
7257 * @direction: direction of focus movement
7259 * This function is used by custom widget implementations; if you're
7260 * writing an app, you'd use gtk_widget_grab_focus() to move the focus
7261 * to a particular widget, and gtk_container_set_focus_chain() to
7262 * change the focus tab order. So you may want to investigate those
7263 * functions instead.
7265 * gtk_widget_child_focus() is called by containers as the user moves
7266 * around the window using keyboard shortcuts. @direction indicates
7267 * what kind of motion is taking place (up, down, left, right, tab
7268 * forward, tab backward). gtk_widget_child_focus() emits the
7269 * #GtkWidget::focus" signal; widgets override the default handler
7270 * for this signal in order to implement appropriate focus behavior.
7272 * The default ::focus handler for a widget should return %TRUE if
7273 * moving in @direction left the focus on a focusable location inside
7274 * that widget, and %FALSE if moving in @direction moved the focus
7275 * outside the widget. If returning %TRUE, widgets normally
7276 * call gtk_widget_grab_focus() to place the focus accordingly;
7277 * if returning %FALSE, they don't modify the current focus location.
7279 * This function replaces gtk_container_focus() from GTK+ 1.2.
7280 * It was necessary to check that the child was visible, sensitive,
7281 * and focusable before calling gtk_container_focus().
7282 * gtk_widget_child_focus() returns %FALSE if the widget is not
7283 * currently in a focusable state, so there's no need for those checks.
7285 * Return value: %TRUE if focus ended up inside @widget
7288 gtk_widget_child_focus (GtkWidget *widget,
7289 GtkDirectionType direction)
7291 gboolean return_val;
7293 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7295 if (!GTK_WIDGET_VISIBLE (widget) ||
7296 !GTK_WIDGET_IS_SENSITIVE (widget))
7299 /* child widgets must set CAN_FOCUS, containers
7300 * don't have to though.
7302 if (!GTK_IS_CONTAINER (widget) &&
7303 !GTK_WIDGET_CAN_FOCUS (widget))
7306 g_signal_emit (widget,
7307 widget_signals[FOCUS],
7309 direction, &return_val);
7315 * gtk_widget_keynav_failed:
7316 * @widget: a #GtkWidget
7317 * @direction: direction of focus movement
7319 * This function should be called whenever keyboard navigation within
7320 * a single widget hits a boundary. The function emits the
7321 * #GtkWidget::keynav-failed signal on the widget and its return
7322 * value should be interpreted in a way similar to the return value of
7323 * gtk_widget_child_focus():
7325 * When %TRUE is returned, stay in the widget, the failed keyboard
7326 * navigation is Ok and/or there is nowhere we can/should move the
7329 * When %FALSE is returned, the caller should continue with keyboard
7330 * navigation outside the widget, e.g. by calling
7331 * gtk_widget_child_focus() on the widget's toplevel.
7333 * The default ::keynav-failed handler returns %TRUE for
7334 * %GTK_DIR_TAB_FORWARD and %GTK_DIR_TAB_BACKWARD. For the other
7335 * values of #GtkDirectionType, it looks at the
7336 * #GtkSettings:gtk-keynav-cursor-only setting and returns %FALSE
7337 * if the setting is %TRUE. This way the entire user interface
7338 * becomes cursor-navigatable on input devices such as mobile phones
7339 * which only have cursor keys but no tab key.
7341 * Whenever the default handler returns %TRUE, it also calls
7342 * gtk_widget_error_bell() to notify the user of the failed keyboard
7345 * A use case for providing an own implementation of ::keynav-failed
7346 * (either by connecting to it or by overriding it) would be a row of
7347 * #GtkEntry widgets where the user should be able to navigate the
7348 * entire row with the cursor keys, as e.g. known from user interfaces
7349 * that require entering license keys.
7351 * Return value: %TRUE if stopping keyboard navigation is fine, %FALSE
7352 * if the emitting widget should try to handle the keyboard
7353 * navigation attempt in its parent container(s).
7358 gtk_widget_keynav_failed (GtkWidget *widget,
7359 GtkDirectionType direction)
7361 gboolean return_val;
7363 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7365 g_signal_emit (widget, widget_signals[KEYNAV_FAILED], 0,
7366 direction, &return_val);
7372 * gtk_widget_error_bell:
7373 * @widget: a #GtkWidget
7375 * Notifies the user about an input-related error on this widget.
7376 * If the #GtkSettings:gtk-error-bell setting is %TRUE, it calls
7377 * gdk_window_beep(), otherwise it does nothing.
7379 * Note that the effect of gdk_window_beep() can be configured in many
7380 * ways, depending on the windowing backend and the desktop environment
7381 * or window manager that is used.
7386 gtk_widget_error_bell (GtkWidget *widget)
7388 GtkSettings* settings;
7391 g_return_if_fail (GTK_IS_WIDGET (widget));
7393 settings = gtk_widget_get_settings (widget);
7397 g_object_get (settings,
7398 "gtk-error-bell", &beep,
7401 if (beep && widget->window)
7402 gdk_window_beep (widget->window);
7406 * gtk_widget_set_uposition:
7407 * @widget: a #GtkWidget
7408 * @x: x position; -1 to unset x; -2 to leave x unchanged
7409 * @y: y position; -1 to unset y; -2 to leave y unchanged
7412 * Sets the position of a widget. The funny "u" in the name comes from
7413 * the "user position" hint specified by the X Window System, and
7414 * exists for legacy reasons. This function doesn't work if a widget
7415 * is inside a container; it's only really useful on #GtkWindow.
7417 * Don't use this function to center dialogs over the main application
7418 * window; most window managers will do the centering on your behalf
7419 * if you call gtk_window_set_transient_for(), and it's really not
7420 * possible to get the centering to work correctly in all cases from
7421 * application code. But if you insist, use gtk_window_set_position()
7422 * to set #GTK_WIN_POS_CENTER_ON_PARENT, don't do the centering
7425 * Note that although @x and @y can be individually unset, the position
7426 * is not honoured unless both @x and @y are set.
7429 gtk_widget_set_uposition (GtkWidget *widget,
7433 /* FIXME this function is the only place that aux_info->x and
7434 * aux_info->y are even used I believe, and this function is
7435 * deprecated. Should be cleaned up.
7437 * (Actually, size_allocate uses them) -Yosh
7440 GtkWidgetAuxInfo *aux_info;
7442 g_return_if_fail (GTK_IS_WIDGET (widget));
7444 aux_info =_gtk_widget_get_aux_info (widget, TRUE);
7449 aux_info->x_set = FALSE;
7452 aux_info->x_set = TRUE;
7460 aux_info->y_set = FALSE;
7463 aux_info->y_set = TRUE;
7468 if (GTK_IS_WINDOW (widget) && aux_info->x_set && aux_info->y_set)
7469 _gtk_window_reposition (GTK_WINDOW (widget), aux_info->x, aux_info->y);
7471 if (GTK_WIDGET_VISIBLE (widget) && widget->parent)
7472 gtk_widget_size_allocate (widget, &widget->allocation);
7476 gtk_widget_set_usize_internal (GtkWidget *widget,
7480 GtkWidgetAuxInfo *aux_info;
7481 gboolean changed = FALSE;
7483 g_object_freeze_notify (G_OBJECT (widget));
7485 aux_info = _gtk_widget_get_aux_info (widget, TRUE);
7487 if (width > -2 && aux_info->width != width)
7489 g_object_notify (G_OBJECT (widget), "width-request");
7490 aux_info->width = width;
7493 if (height > -2 && aux_info->height != height)
7495 g_object_notify (G_OBJECT (widget), "height-request");
7496 aux_info->height = height;
7500 if (GTK_WIDGET_VISIBLE (widget) && changed)
7501 gtk_widget_queue_resize (widget);
7503 g_object_thaw_notify (G_OBJECT (widget));
7507 * gtk_widget_set_usize:
7508 * @widget: a #GtkWidget
7509 * @width: minimum width, or -1 to unset
7510 * @height: minimum height, or -1 to unset
7512 * Sets the minimum size of a widget; that is, the widget's size
7513 * request will be @width by @height. You can use this function to
7514 * force a widget to be either larger or smaller than it is. The
7515 * strange "usize" name dates from the early days of GTK+, and derives
7516 * from X Window System terminology. In many cases,
7517 * gtk_window_set_default_size() is a better choice for toplevel
7518 * windows than this function; setting the default size will still
7519 * allow users to shrink the window. Setting the usize will force them
7520 * to leave the window at least as large as the usize. When dealing
7521 * with window sizes, gtk_window_set_geometry_hints() can be a useful
7524 * Note the inherent danger of setting any fixed size - themes,
7525 * translations into other languages, different fonts, and user action
7526 * can all change the appropriate size for a given widget. So, it's
7527 * basically impossible to hardcode a size that will always be
7530 * Deprecated: 2.2: Use gtk_widget_set_size_request() instead.
7533 gtk_widget_set_usize (GtkWidget *widget,
7537 g_return_if_fail (GTK_IS_WIDGET (widget));
7539 gtk_widget_set_usize_internal (widget, width, height);
7543 * gtk_widget_set_size_request:
7544 * @widget: a #GtkWidget
7545 * @width: width @widget should request, or -1 to unset
7546 * @height: height @widget should request, or -1 to unset
7548 * Sets the minimum size of a widget; that is, the widget's size
7549 * request will be @width by @height. You can use this function to
7550 * force a widget to be either larger or smaller than it normally
7553 * In most cases, gtk_window_set_default_size() is a better choice for
7554 * toplevel windows than this function; setting the default size will
7555 * still allow users to shrink the window. Setting the size request
7556 * will force them to leave the window at least as large as the size
7557 * request. When dealing with window sizes,
7558 * gtk_window_set_geometry_hints() can be a useful function as well.
7560 * Note the inherent danger of setting any fixed size - themes,
7561 * translations into other languages, different fonts, and user action
7562 * can all change the appropriate size for a given widget. So, it's
7563 * basically impossible to hardcode a size that will always be
7566 * The size request of a widget is the smallest size a widget can
7567 * accept while still functioning well and drawing itself correctly.
7568 * However in some strange cases a widget may be allocated less than
7569 * its requested size, and in many cases a widget may be allocated more
7570 * space than it requested.
7572 * If the size request in a given direction is -1 (unset), then
7573 * the "natural" size request of the widget will be used instead.
7575 * Widgets can't actually be allocated a size less than 1 by 1, but
7576 * you can pass 0,0 to this function to mean "as small as possible."
7579 gtk_widget_set_size_request (GtkWidget *widget,
7583 g_return_if_fail (GTK_IS_WIDGET (widget));
7584 g_return_if_fail (width >= -1);
7585 g_return_if_fail (height >= -1);
7592 gtk_widget_set_usize_internal (widget, width, height);
7597 * gtk_widget_get_size_request:
7598 * @widget: a #GtkWidget
7599 * @width: return location for width, or %NULL
7600 * @height: return location for height, or %NULL
7602 * Gets the size request that was explicitly set for the widget using
7603 * gtk_widget_set_size_request(). A value of -1 stored in @width or
7604 * @height indicates that that dimension has not been set explicitly
7605 * and the natural requisition of the widget will be used intead. See
7606 * gtk_widget_set_size_request(). To get the size a widget will
7607 * actually use, call gtk_widget_size_request() instead of
7611 gtk_widget_get_size_request (GtkWidget *widget,
7615 GtkWidgetAuxInfo *aux_info;
7617 g_return_if_fail (GTK_IS_WIDGET (widget));
7619 aux_info = _gtk_widget_get_aux_info (widget, FALSE);
7622 *width = aux_info ? aux_info->width : -1;
7625 *height = aux_info ? aux_info->height : -1;
7629 * gtk_widget_set_events:
7630 * @widget: a #GtkWidget
7631 * @events: event mask
7633 * Sets the event mask (see #GdkEventMask) for a widget. The event
7634 * mask determines which events a widget will receive. Keep in mind
7635 * that different widgets have different default event masks, and by
7636 * changing the event mask you may disrupt a widget's functionality,
7637 * so be careful. This function must be called while a widget is
7638 * unrealized. Consider gtk_widget_add_events() for widgets that are
7639 * already realized, or if you want to preserve the existing event
7640 * mask. This function can't be used with #GTK_NO_WINDOW widgets;
7641 * to get events on those widgets, place them inside a #GtkEventBox
7642 * and receive events on the event box.
7645 gtk_widget_set_events (GtkWidget *widget,
7648 g_return_if_fail (GTK_IS_WIDGET (widget));
7649 g_return_if_fail (!GTK_WIDGET_REALIZED (widget));
7651 g_object_set_qdata (G_OBJECT (widget), quark_event_mask,
7652 GINT_TO_POINTER (events));
7653 g_object_notify (G_OBJECT (widget), "events");
7657 gtk_widget_add_events_internal (GtkWidget *widget,
7663 for (l = window_list; l != NULL; l = l->next)
7665 GdkWindow *window = l->data;
7668 gdk_window_get_user_data (window, &user_data);
7669 if (user_data == widget)
7673 gdk_window_set_events (window, gdk_window_get_events (window) | events);
7675 children = gdk_window_get_children (window);
7676 gtk_widget_add_events_internal (widget, events, children);
7677 g_list_free (children);
7683 * gtk_widget_add_events:
7684 * @widget: a #GtkWidget
7685 * @events: an event mask, see #GdkEventMask
7687 * Adds the events in the bitfield @events to the event mask for
7688 * @widget. See gtk_widget_set_events() for details.
7691 gtk_widget_add_events (GtkWidget *widget,
7696 g_return_if_fail (GTK_IS_WIDGET (widget));
7698 old_events = GPOINTER_TO_INT (g_object_get_qdata (G_OBJECT (widget), quark_event_mask));
7699 g_object_set_qdata (G_OBJECT (widget), quark_event_mask,
7700 GINT_TO_POINTER (old_events | events));
7702 if (GTK_WIDGET_REALIZED (widget))
7706 if (GTK_WIDGET_NO_WINDOW (widget))
7707 window_list = gdk_window_get_children (widget->window);
7709 window_list = g_list_prepend (NULL, widget->window);
7711 gtk_widget_add_events_internal (widget, events, window_list);
7713 g_list_free (window_list);
7716 g_object_notify (G_OBJECT (widget), "events");
7720 * gtk_widget_set_extension_events:
7721 * @widget: a #GtkWidget
7722 * @mode: bitfield of extension events to receive
7724 * Sets the extension events mask to @mode. See #GdkExtensionMode
7725 * and gdk_input_set_extension_events().
7728 gtk_widget_set_extension_events (GtkWidget *widget,
7729 GdkExtensionMode mode)
7731 g_return_if_fail (GTK_IS_WIDGET (widget));
7733 if (GTK_WIDGET_REALIZED (widget))
7734 gtk_widget_set_extension_events_internal (widget, mode, NULL);
7736 g_object_set_qdata (G_OBJECT (widget), quark_extension_event_mode,
7737 GINT_TO_POINTER (mode));
7738 g_object_notify (G_OBJECT (widget), "extension-events");
7742 * gtk_widget_get_toplevel:
7743 * @widget: a #GtkWidget
7745 * This function returns the topmost widget in the container hierarchy
7746 * @widget is a part of. If @widget has no parent widgets, it will be
7747 * returned as the topmost widget. No reference will be added to the
7748 * returned widget; it should not be unreferenced.
7750 * Note the difference in behavior vs. gtk_widget_get_ancestor();
7751 * <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW)</literal>
7753 * %NULL if @widget wasn't inside a toplevel window, and if the
7754 * window was inside a #GtkWindow-derived widget which was in turn
7755 * inside the toplevel #GtkWindow. While the second case may
7756 * seem unlikely, it actually happens when a #GtkPlug is embedded
7757 * inside a #GtkSocket within the same application.
7759 * To reliably find the toplevel #GtkWindow, use
7760 * gtk_widget_get_toplevel() and check if the %TOPLEVEL flags
7761 * is set on the result.
7763 * GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
7764 * if (GTK_WIDGET_TOPLEVEL (toplevel))
7766 * /* Perform action on toplevel. */
7770 * Return value: the topmost ancestor of @widget, or @widget itself
7771 * if there's no ancestor.
7774 gtk_widget_get_toplevel (GtkWidget *widget)
7776 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7778 while (widget->parent)
7779 widget = widget->parent;
7785 * gtk_widget_get_ancestor:
7786 * @widget: a #GtkWidget
7787 * @widget_type: ancestor type
7789 * Gets the first ancestor of @widget with type @widget_type. For example,
7790 * <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)</literal> gets
7791 * the first #GtkBox that's an ancestor of @widget. No reference will be
7792 * added to the returned widget; it should not be unreferenced. See note
7793 * about checking for a toplevel #GtkWindow in the docs for
7794 * gtk_widget_get_toplevel().
7796 * Note that unlike gtk_widget_is_ancestor(), gtk_widget_get_ancestor()
7797 * considers @widget to be an ancestor of itself.
7799 * Return value: the ancestor widget, or %NULL if not found
7802 gtk_widget_get_ancestor (GtkWidget *widget,
7805 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7807 while (widget && !g_type_is_a (GTK_WIDGET_TYPE (widget), widget_type))
7808 widget = widget->parent;
7810 if (!(widget && g_type_is_a (GTK_WIDGET_TYPE (widget), widget_type)))
7817 * gtk_widget_get_colormap:
7818 * @widget: a #GtkWidget
7820 * Gets the colormap that will be used to render @widget. No reference will
7821 * be added to the returned colormap; it should not be unreferenced.
7823 * Return value: the colormap used by @widget
7826 gtk_widget_get_colormap (GtkWidget *widget)
7828 GdkColormap *colormap;
7829 GtkWidget *tmp_widget;
7831 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7835 colormap = gdk_drawable_get_colormap (widget->window);
7836 /* If window was destroyed previously, we'll get NULL here */
7841 tmp_widget = widget;
7844 colormap = g_object_get_qdata (G_OBJECT (tmp_widget), quark_colormap);
7848 tmp_widget= tmp_widget->parent;
7851 return gdk_screen_get_default_colormap (gtk_widget_get_screen (widget));
7855 * gtk_widget_get_visual:
7856 * @widget: a #GtkWidget
7858 * Gets the visual that will be used to render @widget.
7860 * Return value: the visual for @widget
7863 gtk_widget_get_visual (GtkWidget *widget)
7865 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7867 return gdk_colormap_get_visual (gtk_widget_get_colormap (widget));
7871 * gtk_widget_get_settings:
7872 * @widget: a #GtkWidget
7874 * Gets the settings object holding the settings (global property
7875 * settings, RC file information, etc) used for this widget.
7877 * Note that this function can only be called when the #GtkWidget
7878 * is attached to a toplevel, since the settings object is specific
7879 * to a particular #GdkScreen.
7881 * Return value: the relevant #GtkSettings object
7884 gtk_widget_get_settings (GtkWidget *widget)
7886 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7888 return gtk_settings_get_for_screen (gtk_widget_get_screen (widget));
7892 * gtk_widget_set_colormap:
7893 * @widget: a #GtkWidget
7894 * @colormap: a colormap
7896 * Sets the colormap for the widget to the given value. Widget must not
7897 * have been previously realized. This probably should only be used
7898 * from an <function>init()</function> function (i.e. from the constructor
7902 gtk_widget_set_colormap (GtkWidget *widget,
7903 GdkColormap *colormap)
7905 g_return_if_fail (GTK_IS_WIDGET (widget));
7906 g_return_if_fail (!GTK_WIDGET_REALIZED (widget));
7907 g_return_if_fail (GDK_IS_COLORMAP (colormap));
7909 g_object_ref (colormap);
7911 g_object_set_qdata_full (G_OBJECT (widget),
7918 * gtk_widget_get_events:
7919 * @widget: a #GtkWidget
7921 * Returns the event mask for the widget (a bitfield containing flags
7922 * from the #GdkEventMask enumeration). These are the events that the widget
7925 * Return value: event mask for @widget
7928 gtk_widget_get_events (GtkWidget *widget)
7930 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
7932 return GPOINTER_TO_INT (g_object_get_qdata (G_OBJECT (widget), quark_event_mask));
7936 * gtk_widget_get_extension_events:
7937 * @widget: a #GtkWidget
7939 * Retrieves the extension events the widget will receive; see
7940 * gdk_input_set_extension_events().
7942 * Return value: extension events for @widget
7945 gtk_widget_get_extension_events (GtkWidget *widget)
7947 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
7949 return GPOINTER_TO_INT (g_object_get_qdata (G_OBJECT (widget), quark_extension_event_mode));
7953 * gtk_widget_get_pointer:
7954 * @widget: a #GtkWidget
7955 * @x: return location for the X coordinate, or %NULL
7956 * @y: return location for the Y coordinate, or %NULL
7958 * Obtains the location of the mouse pointer in widget coordinates.
7959 * Widget coordinates are a bit odd; for historical reasons, they are
7960 * defined as @widget->window coordinates for widgets that are not
7961 * #GTK_NO_WINDOW widgets, and are relative to @widget->allocation.x,
7962 * @widget->allocation.y for widgets that are #GTK_NO_WINDOW widgets.
7965 gtk_widget_get_pointer (GtkWidget *widget,
7969 g_return_if_fail (GTK_IS_WIDGET (widget));
7976 if (GTK_WIDGET_REALIZED (widget))
7978 gdk_window_get_pointer (widget->window, x, y, NULL);
7980 if (GTK_WIDGET_NO_WINDOW (widget))
7983 *x -= widget->allocation.x;
7985 *y -= widget->allocation.y;
7991 * gtk_widget_is_ancestor:
7992 * @widget: a #GtkWidget
7993 * @ancestor: another #GtkWidget
7995 * Determines whether @widget is somewhere inside @ancestor, possibly with
7996 * intermediate containers.
7998 * Return value: %TRUE if @ancestor contains @widget as a child,
7999 * grandchild, great grandchild, etc.
8002 gtk_widget_is_ancestor (GtkWidget *widget,
8003 GtkWidget *ancestor)
8005 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
8006 g_return_val_if_fail (ancestor != NULL, FALSE);
8010 if (widget->parent == ancestor)
8012 widget = widget->parent;
8018 static GQuark quark_composite_name = 0;
8021 * gtk_widget_set_composite_name:
8022 * @widget: a #GtkWidget.
8023 * @name: the name to set
8025 * Sets a widgets composite name. The widget must be
8026 * a composite child of its parent; see gtk_widget_push_composite_child().
8029 gtk_widget_set_composite_name (GtkWidget *widget,
8032 g_return_if_fail (GTK_IS_WIDGET (widget));
8033 g_return_if_fail (GTK_WIDGET_COMPOSITE_CHILD (widget));
8034 g_return_if_fail (name != NULL);
8036 if (!quark_composite_name)
8037 quark_composite_name = g_quark_from_static_string ("gtk-composite-name");
8039 g_object_set_qdata_full (G_OBJECT (widget),
8040 quark_composite_name,
8046 * gtk_widget_get_composite_name:
8047 * @widget: a #GtkWidget
8049 * Obtains the composite name of a widget.
8051 * Returns: the composite name of @widget, or %NULL if @widget is not
8052 * a composite child. The string should be freed when it is no
8056 gtk_widget_get_composite_name (GtkWidget *widget)
8058 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8060 if (GTK_WIDGET_COMPOSITE_CHILD (widget) && widget->parent)
8061 return _gtk_container_child_composite_name (GTK_CONTAINER (widget->parent),
8068 * gtk_widget_push_composite_child:
8070 * Makes all newly-created widgets as composite children until
8071 * the corresponding gtk_widget_pop_composite_child() call.
8073 * A composite child is a child that's an implementation detail of the
8074 * container it's inside and should not be visible to people using the
8075 * container. Composite children aren't treated differently by GTK (but
8076 * see gtk_container_foreach() vs. gtk_container_forall()), but e.g. GUI
8077 * builders might want to treat them in a different way.
8079 * Here is a simple example:
8081 * gtk_widget_push_composite_child ();
8082 * scrolled_window->hscrollbar = gtk_hscrollbar_new (hadjustment);
8083 * gtk_widget_set_composite_name (scrolled_window->hscrollbar, "hscrollbar");
8084 * gtk_widget_pop_composite_child ();
8085 * gtk_widget_set_parent (scrolled_window->hscrollbar,
8086 * GTK_WIDGET (scrolled_window));
8087 * g_object_ref (scrolled_window->hscrollbar);
8091 gtk_widget_push_composite_child (void)
8093 composite_child_stack++;
8097 * gtk_widget_pop_composite_child:
8099 * Cancels the effect of a previous call to gtk_widget_push_composite_child().
8102 gtk_widget_pop_composite_child (void)
8104 if (composite_child_stack)
8105 composite_child_stack--;
8109 * gtk_widget_push_colormap:
8110 * @cmap: a #GdkColormap
8112 * Pushes @cmap onto a global stack of colormaps; the topmost
8113 * colormap on the stack will be used to create all widgets.
8114 * Remove @cmap with gtk_widget_pop_colormap(). There's little
8115 * reason to use this function.
8118 gtk_widget_push_colormap (GdkColormap *cmap)
8120 g_return_if_fail (!cmap || GDK_IS_COLORMAP (cmap));
8122 colormap_stack = g_slist_prepend (colormap_stack, cmap);
8126 * gtk_widget_pop_colormap:
8128 * Removes a colormap pushed with gtk_widget_push_colormap().
8131 gtk_widget_pop_colormap (void)
8134 colormap_stack = g_slist_delete_link (colormap_stack, colormap_stack);
8138 * gtk_widget_set_default_colormap:
8139 * @colormap: a #GdkColormap
8141 * Sets the default colormap to use when creating widgets.
8142 * gtk_widget_push_colormap() is a better function to use if
8143 * you only want to affect a few widgets, rather than all widgets.
8146 gtk_widget_set_default_colormap (GdkColormap *colormap)
8148 g_return_if_fail (GDK_IS_COLORMAP (colormap));
8150 gdk_screen_set_default_colormap (gdk_colormap_get_screen (colormap),
8155 * gtk_widget_get_default_colormap:
8157 * Obtains the default colormap used to create widgets.
8159 * Return value: default widget colormap
8162 gtk_widget_get_default_colormap (void)
8164 return gdk_screen_get_default_colormap (gdk_screen_get_default ());
8168 * gtk_widget_get_default_visual:
8170 * Obtains the visual of the default colormap. Not really useful;
8171 * used to be useful before gdk_colormap_get_visual() existed.
8173 * Return value: visual of the default colormap
8176 gtk_widget_get_default_visual (void)
8178 return gdk_colormap_get_visual (gtk_widget_get_default_colormap ());
8182 gtk_widget_emit_direction_changed (GtkWidget *widget,
8183 GtkTextDirection old_dir)
8185 gtk_widget_update_pango_context (widget);
8187 g_signal_emit (widget, widget_signals[DIRECTION_CHANGED], 0, old_dir);
8191 * gtk_widget_set_direction:
8192 * @widget: a #GtkWidget
8193 * @dir: the new direction
8195 * Sets the reading direction on a particular widget. This direction
8196 * controls the primary direction for widgets containing text,
8197 * and also the direction in which the children of a container are
8198 * packed. The ability to set the direction is present in order
8199 * so that correct localization into languages with right-to-left
8200 * reading directions can be done. Generally, applications will
8201 * let the default reading direction present, except for containers
8202 * where the containers are arranged in an order that is explicitely
8203 * visual rather than logical (such as buttons for text justification).
8205 * If the direction is set to %GTK_TEXT_DIR_NONE, then the value
8206 * set by gtk_widget_set_default_direction() will be used.
8209 gtk_widget_set_direction (GtkWidget *widget,
8210 GtkTextDirection dir)
8212 GtkTextDirection old_dir;
8214 g_return_if_fail (GTK_IS_WIDGET (widget));
8215 g_return_if_fail (dir >= GTK_TEXT_DIR_NONE && dir <= GTK_TEXT_DIR_RTL);
8217 old_dir = gtk_widget_get_direction (widget);
8219 if (dir == GTK_TEXT_DIR_NONE)
8220 GTK_PRIVATE_UNSET_FLAG (widget, GTK_DIRECTION_SET);
8223 GTK_PRIVATE_SET_FLAG (widget, GTK_DIRECTION_SET);
8224 if (dir == GTK_TEXT_DIR_LTR)
8225 GTK_PRIVATE_SET_FLAG (widget, GTK_DIRECTION_LTR);
8227 GTK_PRIVATE_UNSET_FLAG (widget, GTK_DIRECTION_LTR);
8230 if (old_dir != gtk_widget_get_direction (widget))
8231 gtk_widget_emit_direction_changed (widget, old_dir);
8235 * gtk_widget_get_direction:
8236 * @widget: a #GtkWidget
8238 * Gets the reading direction for a particular widget. See
8239 * gtk_widget_set_direction().
8241 * Return value: the reading direction for the widget.
8244 gtk_widget_get_direction (GtkWidget *widget)
8246 g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_TEXT_DIR_LTR);
8248 if (GTK_WIDGET_DIRECTION_SET (widget))
8249 return GTK_WIDGET_DIRECTION_LTR (widget) ? GTK_TEXT_DIR_LTR : GTK_TEXT_DIR_RTL;
8251 return gtk_default_direction;
8255 gtk_widget_set_default_direction_recurse (GtkWidget *widget, gpointer data)
8257 GtkTextDirection old_dir = GPOINTER_TO_UINT (data);
8259 g_object_ref (widget);
8261 if (!GTK_WIDGET_DIRECTION_SET (widget))
8262 gtk_widget_emit_direction_changed (widget, old_dir);
8264 if (GTK_IS_CONTAINER (widget))
8265 gtk_container_forall (GTK_CONTAINER (widget),
8266 gtk_widget_set_default_direction_recurse,
8269 g_object_unref (widget);
8273 * gtk_widget_set_default_direction:
8274 * @dir: the new default direction. This cannot be
8275 * %GTK_TEXT_DIR_NONE.
8277 * Sets the default reading direction for widgets where the
8278 * direction has not been explicitly set by gtk_widget_set_direction().
8281 gtk_widget_set_default_direction (GtkTextDirection dir)
8283 g_return_if_fail (dir == GTK_TEXT_DIR_RTL || dir == GTK_TEXT_DIR_LTR);
8285 if (dir != gtk_default_direction)
8287 GList *toplevels, *tmp_list;
8288 GtkTextDirection old_dir = gtk_default_direction;
8290 gtk_default_direction = dir;
8292 tmp_list = toplevels = gtk_window_list_toplevels ();
8293 g_list_foreach (toplevels, (GFunc)g_object_ref, NULL);
8297 gtk_widget_set_default_direction_recurse (tmp_list->data,
8298 GUINT_TO_POINTER (old_dir));
8299 g_object_unref (tmp_list->data);
8300 tmp_list = tmp_list->next;
8303 g_list_free (toplevels);
8308 * gtk_widget_get_default_direction:
8310 * Obtains the current default reading direction. See
8311 * gtk_widget_set_default_direction().
8313 * Return value: the current default direction.
8316 gtk_widget_get_default_direction (void)
8318 return gtk_default_direction;
8322 gtk_widget_dispose (GObject *object)
8324 GtkWidget *widget = GTK_WIDGET (object);
8327 gtk_container_remove (GTK_CONTAINER (widget->parent), widget);
8328 else if (GTK_WIDGET_VISIBLE (widget))
8329 gtk_widget_hide (widget);
8331 GTK_WIDGET_UNSET_FLAGS (widget, GTK_VISIBLE);
8332 if (GTK_WIDGET_REALIZED (widget))
8333 gtk_widget_unrealize (widget);
8335 G_OBJECT_CLASS (gtk_widget_parent_class)->dispose (object);
8339 gtk_widget_real_destroy (GtkObject *object)
8341 /* gtk_object_destroy() will already hold a refcount on object */
8342 GtkWidget *widget = GTK_WIDGET (object);
8344 /* wipe accelerator closures (keep order) */
8345 g_object_set_qdata (G_OBJECT (widget), quark_accel_path, NULL);
8346 g_object_set_qdata (G_OBJECT (widget), quark_accel_closures, NULL);
8348 /* Callers of add_mnemonic_label() should disconnect on ::destroy */
8349 g_object_set_qdata (G_OBJECT (widget), quark_mnemonic_labels, NULL);
8351 gtk_grab_remove (widget);
8353 g_object_unref (widget->style);
8354 widget->style = gtk_widget_get_default_style ();
8355 g_object_ref (widget->style);
8357 GTK_OBJECT_CLASS (gtk_widget_parent_class)->destroy (object);
8361 gtk_widget_finalize (GObject *object)
8363 GtkWidget *widget = GTK_WIDGET (object);
8364 GtkWidgetAuxInfo *aux_info;
8365 GtkAccessible *accessible;
8367 gtk_grab_remove (widget);
8369 g_object_unref (widget->style);
8370 widget->style = NULL;
8372 g_free (widget->name);
8374 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
8376 gtk_widget_aux_info_destroy (aux_info);
8378 accessible = g_object_get_qdata (G_OBJECT (widget), quark_accessible_object);
8380 g_object_unref (accessible);
8382 G_OBJECT_CLASS (gtk_widget_parent_class)->finalize (object);
8385 /*****************************************
8386 * gtk_widget_real_map:
8391 *****************************************/
8394 gtk_widget_real_map (GtkWidget *widget)
8396 g_assert (GTK_WIDGET_REALIZED (widget));
8398 if (!GTK_WIDGET_MAPPED (widget))
8400 GTK_WIDGET_SET_FLAGS (widget, GTK_MAPPED);
8402 if (!GTK_WIDGET_NO_WINDOW (widget))
8403 gdk_window_show (widget->window);
8407 /*****************************************
8408 * gtk_widget_real_unmap:
8413 *****************************************/
8416 gtk_widget_real_unmap (GtkWidget *widget)
8418 if (GTK_WIDGET_MAPPED (widget))
8420 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
8422 if (!GTK_WIDGET_NO_WINDOW (widget))
8423 gdk_window_hide (widget->window);
8427 /*****************************************
8428 * gtk_widget_real_realize:
8433 *****************************************/
8436 gtk_widget_real_realize (GtkWidget *widget)
8438 g_assert (GTK_WIDGET_NO_WINDOW (widget));
8440 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
8443 widget->window = gtk_widget_get_parent_window (widget);
8444 g_object_ref (widget->window);
8446 widget->style = gtk_style_attach (widget->style, widget->window);
8449 /*****************************************
8450 * gtk_widget_real_unrealize:
8455 *****************************************/
8458 gtk_widget_real_unrealize (GtkWidget *widget)
8460 if (GTK_WIDGET_MAPPED (widget))
8461 gtk_widget_real_unmap (widget);
8463 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
8465 /* printf ("unrealizing %s\n", g_type_name (G_TYPE_FROM_INSTANCE (widget)));
8468 /* We must do unrealize child widget BEFORE container widget.
8469 * gdk_window_destroy() destroys specified xwindow and its sub-xwindows.
8470 * So, unrealizing container widget bofore its children causes the problem
8471 * (for example, gdk_ic_destroy () with destroyed window causes crash. )
8474 if (GTK_IS_CONTAINER (widget))
8475 gtk_container_forall (GTK_CONTAINER (widget),
8476 (GtkCallback) gtk_widget_unrealize,
8479 gtk_style_detach (widget->style);
8480 if (!GTK_WIDGET_NO_WINDOW (widget))
8482 gdk_window_set_user_data (widget->window, NULL);
8483 gdk_window_destroy (widget->window);
8484 widget->window = NULL;
8488 g_object_unref (widget->window);
8489 widget->window = NULL;
8492 gtk_selection_remove_all (widget);
8494 GTK_WIDGET_UNSET_FLAGS (widget, GTK_REALIZED);
8498 gtk_widget_real_size_request (GtkWidget *widget,
8499 GtkRequisition *requisition)
8501 requisition->width = widget->requisition.width;
8502 requisition->height = widget->requisition.height;
8506 * _gtk_widget_peek_colormap:
8508 * Returns colormap currently pushed by gtk_widget_push_colormap, if any.
8510 * Return value: the currently pushed colormap, or %NULL if there is none.
8513 _gtk_widget_peek_colormap (void)
8516 return (GdkColormap*) colormap_stack->data;
8521 * _gtk_widget_set_pointer_window:
8522 * @widget: a #GtkWidget.
8523 * @pointer_window: the new pointer window.
8525 * Sets pointer window for @widget. Does not ref @pointer_window.
8526 * Actually stores it on the #GdkScreen, but you don't need to know that.
8529 _gtk_widget_set_pointer_window (GtkWidget *widget,
8530 GdkWindow *pointer_window)
8532 g_return_if_fail (GTK_IS_WIDGET (widget));
8534 if (GTK_WIDGET_REALIZED (widget))
8536 GdkScreen *screen = gdk_drawable_get_screen (widget->window);
8538 g_object_set_qdata (G_OBJECT (screen), quark_pointer_window,
8544 * _gtk_widget_get_pointer_window:
8545 * @widget: a #GtkWidget.
8547 * Return value: the pointer window set on the #GdkScreen @widget is attached
8551 _gtk_widget_get_pointer_window (GtkWidget *widget)
8553 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8555 if (GTK_WIDGET_REALIZED (widget))
8557 GdkScreen *screen = gdk_drawable_get_screen (widget->window);
8559 return g_object_get_qdata (G_OBJECT (screen), quark_pointer_window);
8566 synth_crossing (GtkWidget *widget,
8569 GdkCrossingMode mode,
8570 GdkNotifyType detail)
8574 event = gdk_event_new (type);
8576 event->crossing.window = g_object_ref (window);
8577 event->crossing.send_event = TRUE;
8578 event->crossing.subwindow = g_object_ref (window);
8579 event->crossing.time = GDK_CURRENT_TIME;
8580 event->crossing.x = event->crossing.y = 0;
8581 event->crossing.x_root = event->crossing.y_root = 0;
8582 event->crossing.mode = mode;
8583 event->crossing.detail = detail;
8584 event->crossing.focus = FALSE;
8585 event->crossing.state = 0;
8588 widget = gtk_get_event_widget (event);
8591 gtk_widget_event_internal (widget, event);
8593 gdk_event_free (event);
8597 * _gtk_widget_is_pointer_widget:
8598 * @widget: a #GtkWidget
8600 * Returns %TRUE if the pointer window belongs to @widget.
8603 _gtk_widget_is_pointer_widget (GtkWidget *widget)
8605 if (GTK_WIDGET_HAS_POINTER (widget))
8610 win = _gtk_widget_get_pointer_window (widget);
8613 gdk_window_get_user_data (win, (gpointer *)&wid);
8623 * _gtk_widget_synthesize_crossing:
8624 * @from: the #GtkWidget the virtual pointer is leaving.
8625 * @to: the #GtkWidget the virtual pointer is moving to.
8626 * @mode: the #GdkCrossingMode to place on the synthesized events.
8628 * Generate crossing event(s) on widget state (sensitivity) or GTK+ grab change.
8630 * The real pointer window is the window that most recently received an enter notify
8631 * event. Windows that don't select for crossing events can't become the real
8632 * poiner window. The real pointer widget that owns the real pointer window. The
8633 * effective pointer window is the same as the real pointer window unless the real
8634 * pointer widget is either insensitive or there is a grab on a widget that is not
8635 * an ancestor of the real pointer widget (in which case the effective pointer
8636 * window should be the root window).
8638 * When the effective pointer window is the same as the real poiner window, we
8639 * receive crossing events from the windowing system. When the effective pointer
8640 * window changes to become different from the real pointer window we synthesize
8641 * crossing events, attempting to follow X protocol rules:
8643 * When the root window becomes the effective pointer window:
8644 * - leave notify on real pointer window, detail Ancestor
8645 * - leave notify on all of its ancestors, detail Virtual
8646 * - enter notify on root window, detail Inferior
8648 * When the root window ceases to be the effective pointer window:
8649 * - leave notify on root window, detail Inferior
8650 * - enter notify on all ancestors of real pointer window, detail Virtual
8651 * - enter notify on real pointer window, detail Ancestor
8654 _gtk_widget_synthesize_crossing (GtkWidget *from,
8656 GdkCrossingMode mode)
8658 GdkWindow *from_window = NULL, *to_window = NULL;
8660 g_return_if_fail (from != NULL || to != NULL);
8663 from_window = GTK_WIDGET_HAS_POINTER (from)
8664 ? _gtk_widget_get_pointer_window (from) : from->window;
8666 to_window = GTK_WIDGET_HAS_POINTER (to)
8667 ? _gtk_widget_get_pointer_window (to) : to->window;
8669 if (from_window == NULL && to_window == NULL)
8671 else if (from_window != NULL && to_window == NULL)
8673 GList *from_ancestors = NULL, *list;
8674 GdkWindow *from_ancestor = from_window;
8676 while (from_ancestor != NULL)
8678 from_ancestor = gdk_window_get_parent (from_ancestor);
8679 if (from_ancestor == NULL)
8681 from_ancestors = g_list_prepend (from_ancestors, from_ancestor);
8684 synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
8685 mode, GDK_NOTIFY_ANCESTOR);
8686 for (list = g_list_last (from_ancestors); list; list = list->prev)
8688 synth_crossing (NULL, GDK_LEAVE_NOTIFY, (GdkWindow *) list->data,
8689 mode, GDK_NOTIFY_VIRTUAL);
8692 /* XXX: enter/inferior on root window? */
8694 g_list_free (from_ancestors);
8696 else if (from_window == NULL && to_window != NULL)
8698 GList *to_ancestors = NULL, *list;
8699 GdkWindow *to_ancestor = to_window;
8701 while (to_ancestor != NULL)
8703 to_ancestor = gdk_window_get_parent (to_ancestor);
8704 if (to_ancestor == NULL)
8706 to_ancestors = g_list_prepend (to_ancestors, to_ancestor);
8709 /* XXX: leave/inferior on root window? */
8711 for (list = to_ancestors; list; list = list->next)
8713 synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
8714 mode, GDK_NOTIFY_VIRTUAL);
8716 synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
8717 mode, GDK_NOTIFY_ANCESTOR);
8719 g_list_free (to_ancestors);
8721 else if (from_window == to_window)
8725 GList *from_ancestors = NULL, *to_ancestors = NULL, *list;
8726 GdkWindow *from_ancestor = from_window, *to_ancestor = to_window;
8728 while (from_ancestor != NULL || to_ancestor != NULL)
8730 if (from_ancestor != NULL)
8732 from_ancestor = gdk_window_get_parent (from_ancestor);
8733 if (from_ancestor == to_window)
8736 from_ancestors = g_list_prepend (from_ancestors, from_ancestor);
8738 if (to_ancestor != NULL)
8740 to_ancestor = gdk_window_get_parent (to_ancestor);
8741 if (to_ancestor == from_window)
8744 to_ancestors = g_list_prepend (to_ancestors, to_ancestor);
8747 if (to_ancestor == from_window)
8749 if (mode != GDK_CROSSING_GTK_UNGRAB)
8750 synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
8751 mode, GDK_NOTIFY_INFERIOR);
8752 for (list = to_ancestors; list; list = list->next)
8753 synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
8754 mode, GDK_NOTIFY_VIRTUAL);
8755 synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
8756 mode, GDK_NOTIFY_ANCESTOR);
8758 else if (from_ancestor == to_window)
8760 synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
8761 mode, GDK_NOTIFY_ANCESTOR);
8762 for (list = g_list_last (from_ancestors); list; list = list->prev)
8764 synth_crossing (NULL, GDK_LEAVE_NOTIFY, (GdkWindow *) list->data,
8765 mode, GDK_NOTIFY_VIRTUAL);
8767 if (mode != GDK_CROSSING_GTK_GRAB)
8768 synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
8769 mode, GDK_NOTIFY_INFERIOR);
8773 while (from_ancestors != NULL && to_ancestors != NULL
8774 && from_ancestors->data == to_ancestors->data)
8776 from_ancestors = g_list_delete_link (from_ancestors,
8778 to_ancestors = g_list_delete_link (to_ancestors, to_ancestors);
8781 synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
8782 mode, GDK_NOTIFY_NONLINEAR);
8784 for (list = g_list_last (from_ancestors); list; list = list->prev)
8786 synth_crossing (NULL, GDK_LEAVE_NOTIFY, (GdkWindow *) list->data,
8787 mode, GDK_NOTIFY_NONLINEAR_VIRTUAL);
8789 for (list = to_ancestors; list; list = list->next)
8791 synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
8792 mode, GDK_NOTIFY_NONLINEAR_VIRTUAL);
8794 synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
8795 mode, GDK_NOTIFY_NONLINEAR);
8797 g_list_free (from_ancestors);
8798 g_list_free (to_ancestors);
8803 gtk_widget_propagate_state (GtkWidget *widget,
8806 guint8 old_state = GTK_WIDGET_STATE (widget);
8807 guint8 old_saved_state = GTK_WIDGET_SAVED_STATE (widget);
8809 /* don't call this function with state==GTK_STATE_INSENSITIVE,
8810 * parent_sensitive==TRUE on a sensitive widget
8814 if (data->parent_sensitive)
8815 GTK_WIDGET_SET_FLAGS (widget, GTK_PARENT_SENSITIVE);
8817 GTK_WIDGET_UNSET_FLAGS (widget, GTK_PARENT_SENSITIVE);
8819 if (GTK_WIDGET_IS_SENSITIVE (widget))
8821 if (data->state_restoration)
8822 GTK_WIDGET_STATE (widget) = GTK_WIDGET_SAVED_STATE (widget);
8824 GTK_WIDGET_STATE (widget) = data->state;
8828 if (!data->state_restoration)
8830 if (data->state != GTK_STATE_INSENSITIVE)
8831 GTK_WIDGET_SAVED_STATE (widget) = data->state;
8833 else if (GTK_WIDGET_STATE (widget) != GTK_STATE_INSENSITIVE)
8834 GTK_WIDGET_SAVED_STATE (widget) = GTK_WIDGET_STATE (widget);
8835 GTK_WIDGET_STATE (widget) = GTK_STATE_INSENSITIVE;
8838 if (gtk_widget_is_focus (widget) && !GTK_WIDGET_IS_SENSITIVE (widget))
8842 window = gtk_widget_get_toplevel (widget);
8843 if (window && GTK_WIDGET_TOPLEVEL (window))
8844 gtk_window_set_focus (GTK_WINDOW (window), NULL);
8847 if (old_state != GTK_WIDGET_STATE (widget) ||
8848 old_saved_state != GTK_WIDGET_SAVED_STATE (widget))
8850 g_object_ref (widget);
8852 if (!GTK_WIDGET_IS_SENSITIVE (widget) && GTK_WIDGET_HAS_GRAB (widget))
8853 gtk_grab_remove (widget);
8855 g_signal_emit (widget, widget_signals[STATE_CHANGED], 0, old_state);
8857 if (GTK_WIDGET_HAS_POINTER (widget) && !GTK_WIDGET_SHADOWED (widget))
8859 if (!GTK_WIDGET_IS_SENSITIVE (widget))
8860 _gtk_widget_synthesize_crossing (widget, NULL,
8861 GDK_CROSSING_STATE_CHANGED);
8862 else if (old_state == GTK_STATE_INSENSITIVE)
8863 _gtk_widget_synthesize_crossing (NULL, widget,
8864 GDK_CROSSING_STATE_CHANGED);
8867 if (GTK_IS_CONTAINER (widget))
8869 data->parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget) != FALSE);
8870 if (data->use_forall)
8871 gtk_container_forall (GTK_CONTAINER (widget),
8872 (GtkCallback) gtk_widget_propagate_state,
8875 gtk_container_foreach (GTK_CONTAINER (widget),
8876 (GtkCallback) gtk_widget_propagate_state,
8879 g_object_unref (widget);
8884 * _gtk_widget_get_aux_info:
8885 * @widget: a #GtkWidget
8886 * @create: if %TRUE, create the structure if it doesn't exist
8888 * Get the #GtkWidgetAuxInfo structure for the widget.
8890 * Return value: the #GtkAuxInfo structure for the widget, or
8891 * %NULL if @create is %FALSE and one doesn't already exist.
8894 _gtk_widget_get_aux_info (GtkWidget *widget,
8897 GtkWidgetAuxInfo *aux_info;
8899 aux_info = g_object_get_qdata (G_OBJECT (widget), quark_aux_info);
8900 if (!aux_info && create)
8902 aux_info = g_slice_new (GtkWidgetAuxInfo);
8904 aux_info->width = -1;
8905 aux_info->height = -1;
8908 aux_info->x_set = FALSE;
8909 aux_info->y_set = FALSE;
8910 g_object_set_qdata (G_OBJECT (widget), quark_aux_info, aux_info);
8916 /*****************************************
8917 * gtk_widget_aux_info_destroy:
8922 *****************************************/
8925 gtk_widget_aux_info_destroy (GtkWidgetAuxInfo *aux_info)
8927 g_slice_free (GtkWidgetAuxInfo, aux_info);
8931 gtk_widget_shape_info_destroy (GtkWidgetShapeInfo *info)
8933 g_object_unref (info->shape_mask);
8934 g_slice_free (GtkWidgetShapeInfo, info);
8938 * gtk_widget_shape_combine_mask:
8939 * @widget: a #GtkWidget
8940 * @shape_mask: shape to be added, or %NULL to remove an existing shape
8941 * @offset_x: X position of shape mask with respect to @window
8942 * @offset_y: Y position of shape mask with respect to @window
8944 * Sets a shape for this widget's GDK window. This allows for
8945 * transparent windows etc., see gdk_window_shape_combine_mask()
8946 * for more information.
8949 gtk_widget_shape_combine_mask (GtkWidget *widget,
8950 GdkBitmap *shape_mask,
8954 GtkWidgetShapeInfo* shape_info;
8956 g_return_if_fail (GTK_IS_WIDGET (widget));
8957 /* set_shape doesn't work on widgets without gdk window */
8958 g_return_if_fail (!GTK_WIDGET_NO_WINDOW (widget));
8962 GTK_PRIVATE_UNSET_FLAG (widget, GTK_HAS_SHAPE_MASK);
8965 gdk_window_shape_combine_mask (widget->window, NULL, 0, 0);
8967 g_object_set_qdata (G_OBJECT (widget), quark_shape_info, NULL);
8971 GTK_PRIVATE_SET_FLAG (widget, GTK_HAS_SHAPE_MASK);
8973 shape_info = g_slice_new (GtkWidgetShapeInfo);
8974 g_object_set_qdata_full (G_OBJECT (widget), quark_shape_info, shape_info,
8975 (GDestroyNotify) gtk_widget_shape_info_destroy);
8977 shape_info->shape_mask = g_object_ref (shape_mask);
8978 shape_info->offset_x = offset_x;
8979 shape_info->offset_y = offset_y;
8981 /* set shape if widget has a gdk window already.
8982 * otherwise the shape is scheduled to be set by gtk_widget_realize().
8985 gdk_window_shape_combine_mask (widget->window, shape_mask,
8986 offset_x, offset_y);
8991 * gtk_widget_input_shape_combine_mask:
8992 * @widget: a #GtkWidget
8993 * @shape_mask: shape to be added, or %NULL to remove an existing shape
8994 * @offset_x: X position of shape mask with respect to @window
8995 * @offset_y: Y position of shape mask with respect to @window
8997 * Sets an input shape for this widget's GDK window. This allows for
8998 * windows which react to mouse click in a nonrectangular region, see
8999 * gdk_window_input_shape_combine_mask() for more information.
9004 gtk_widget_input_shape_combine_mask (GtkWidget *widget,
9005 GdkBitmap *shape_mask,
9009 GtkWidgetShapeInfo* shape_info;
9011 g_return_if_fail (GTK_IS_WIDGET (widget));
9012 /* set_shape doesn't work on widgets without gdk window */
9013 g_return_if_fail (!GTK_WIDGET_NO_WINDOW (widget));
9018 gdk_window_input_shape_combine_mask (widget->window, NULL, 0, 0);
9020 g_object_set_qdata (G_OBJECT (widget), quark_input_shape_info, NULL);
9024 shape_info = g_slice_new (GtkWidgetShapeInfo);
9025 g_object_set_qdata_full (G_OBJECT (widget), quark_input_shape_info,
9027 (GDestroyNotify) gtk_widget_shape_info_destroy);
9029 shape_info->shape_mask = g_object_ref (shape_mask);
9030 shape_info->offset_x = offset_x;
9031 shape_info->offset_y = offset_y;
9033 /* set shape if widget has a gdk window already.
9034 * otherwise the shape is scheduled to be set by gtk_widget_realize().
9037 gdk_window_input_shape_combine_mask (widget->window, shape_mask,
9038 offset_x, offset_y);
9044 gtk_reset_shapes_recurse (GtkWidget *widget,
9050 gdk_window_get_user_data (window, &data);
9054 gdk_window_shape_combine_mask (window, NULL, 0, 0);
9055 for (list = gdk_window_peek_children (window); list; list = list->next)
9056 gtk_reset_shapes_recurse (widget, list->data);
9060 * gtk_widget_reset_shapes:
9061 * @widget: a #GtkWidget
9063 * Recursively resets the shape on this widget and its descendants.
9066 gtk_widget_reset_shapes (GtkWidget *widget)
9068 g_return_if_fail (GTK_IS_WIDGET (widget));
9069 g_return_if_fail (GTK_WIDGET_REALIZED (widget));
9071 if (!GTK_WIDGET_HAS_SHAPE_MASK (widget))
9072 gtk_reset_shapes_recurse (widget, widget->window);
9077 * @widget: a #GtkWidget
9079 * Adds a reference to a widget. This function is exactly the same
9080 * as calling g_object_ref(), and exists mostly for historical
9081 * reasons. It can still be convenient to avoid casting a widget
9082 * to a #GObject, it saves a small amount of typing.
9084 * Return value: the widget that was referenced
9086 * Deprecated: 2.12: Use g_object_ref() instead.
9089 gtk_widget_ref (GtkWidget *widget)
9091 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9093 return (GtkWidget*) g_object_ref ((GObject*) widget);
9098 * @widget: a #GtkWidget
9100 * Inverse of gtk_widget_ref(). Equivalent to g_object_unref().
9102 * Deprecated: 2.12: Use g_object_unref() instead.
9105 gtk_widget_unref (GtkWidget *widget)
9107 g_return_if_fail (GTK_IS_WIDGET (widget));
9109 g_object_unref ((GObject*) widget);
9113 expose_window (GdkWindow *window)
9116 GList *l, *children;
9118 gboolean is_double_buffered;
9120 gdk_window_get_user_data (window, &user_data);
9123 is_double_buffered = GTK_WIDGET_DOUBLE_BUFFERED (GTK_WIDGET (user_data));
9125 is_double_buffered = FALSE;
9127 event.expose.type = GDK_EXPOSE;
9128 event.expose.window = g_object_ref (window);
9129 event.expose.send_event = FALSE;
9130 event.expose.count = 0;
9131 event.expose.area.x = 0;
9132 event.expose.area.y = 0;
9133 gdk_drawable_get_size (GDK_DRAWABLE (window),
9134 &event.expose.area.width,
9135 &event.expose.area.height);
9136 event.expose.region = gdk_region_rectangle (&event.expose.area);
9138 /* If this is not double buffered, force a double buffer so that
9139 redirection works. */
9140 if (!is_double_buffered)
9141 gdk_window_begin_paint_region (window, event.expose.region);
9143 gtk_main_do_event (&event);
9145 if (!is_double_buffered)
9146 gdk_window_end_paint (window);
9148 children = gdk_window_peek_children (window);
9149 for (l = children; l != NULL; l = l->next)
9151 GdkWindow *child = l->data;
9153 /* Don't expose input-only windows */
9154 if (gdk_drawable_get_depth (GDK_DRAWABLE (child)) != 0)
9155 expose_window (l->data);
9158 g_object_unref (window);
9162 * gtk_widget_get_snapshot:
9163 * @widget: a #GtkWidget
9164 * @clip_rect: a #GdkRectangle or %NULL
9166 * Create a #GdkPixmap of the contents of the widget and its children.
9168 * Works even if the widget is obscured. The depth and visual of the
9169 * resulting pixmap is dependent on the widget being snapshot and likely
9170 * differs from those of a target widget displaying the pixmap.
9171 * The function gdk_pixbuf_get_from_drawable() can be used to convert
9172 * the pixmap to a visual independant representation.
9174 * The snapshot area used by this function is the @widget's allocation plus
9175 * any extra space occupied by additional windows belonging to this widget
9176 * (such as the arrows of a spin button).
9177 * Thus, the resulting snapshot pixmap is possibly larger than the allocation.
9179 * If @clip_rect is non-%NULL, the resulting pixmap is shrunken to
9180 * match the specified clip_rect. The (x,y) coordinates of @clip_rect are
9181 * interpreted widget relative. If width or height of @clip_rect are 0 or
9182 * negative, the width or height of the resulting pixmap will be shrunken
9183 * by the respective amount.
9184 * For instance a @clip_rect <literal>{ +5, +5, -10, -10 }</literal> will
9185 * chop off 5 pixels at each side of the snapshot pixmap.
9186 * If non-%NULL, @clip_rect will contain the exact widget-relative snapshot
9187 * coordinates upon return. A @clip_rect of <literal>{ -1, -1, 0, 0 }</literal>
9188 * can be used to preserve the auto-grown snapshot area and use @clip_rect
9189 * as a pure output parameter.
9191 * The returned pixmap can be %NULL, if the resulting @clip_area was empty.
9193 * Return value: #GdkPixmap snapshot of the widget
9198 gtk_widget_get_snapshot (GtkWidget *widget,
9199 GdkRectangle *clip_rect)
9201 int x, y, width, height;
9202 GdkWindow *parent_window = NULL;
9204 GList *windows = NULL, *list;
9206 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9207 if (!GTK_WIDGET_VISIBLE (widget))
9210 /* the widget (and parent_window) must be realized to be drawable */
9211 if (widget->parent && !GTK_WIDGET_REALIZED (widget->parent))
9212 gtk_widget_realize (widget->parent);
9213 if (!GTK_WIDGET_REALIZED (widget))
9214 gtk_widget_realize (widget);
9216 /* determine snapshot rectangle */
9217 x = widget->allocation.x;
9218 y = widget->allocation.y;
9219 width = widget->allocation.width;
9220 height = widget->allocation.height;
9222 if (widget->parent && !GTK_WIDGET_NO_WINDOW (widget))
9224 /* grow snapshot rectangle to cover all widget windows */
9225 parent_window = gtk_widget_get_parent_window (widget);
9226 for (list = gdk_window_peek_children (parent_window); list; list = list->next)
9228 GdkWindow *subwin = list->data;
9231 gdk_window_get_user_data (subwin, &windata);
9232 if (windata != widget)
9234 windows = g_list_prepend (windows, subwin);
9235 gdk_window_get_position (subwin, &wx, &wy);
9236 gdk_drawable_get_size (subwin, &ww, &wh);
9237 /* grow snapshot rectangle by extra widget sub window */
9248 if (x + width < wx + ww)
9249 width += wx + ww - (x + width);
9250 if (y + height < wy + wh)
9251 height += wy + wh - (y + height);
9254 else if (!widget->parent)
9255 x = y = 0; /* toplevel */
9257 /* at this point, (x,y,width,height) is the parent_window relative
9258 * snapshot area covering all of widget's windows.
9261 /* shrink snapshot size by clip_rectangle */
9264 GdkRectangle snap = { x, y, width, height }, clip = *clip_rect;
9265 clip.x = clip.x < 0 ? x : clip.x;
9266 clip.y = clip.y < 0 ? y : clip.y;
9267 clip.width = clip.width <= 0 ? MAX (0, width + clip.width) : clip.width;
9268 clip.height = clip.height <= 0 ? MAX (0, height + clip.height) : clip.height;
9271 /* offset clip_rect, so it's parent_window relative */
9272 if (clip_rect->x >= 0)
9273 clip.x += widget->allocation.x;
9274 if (clip_rect->y >= 0)
9275 clip.y += widget->allocation.y;
9277 if (!gdk_rectangle_intersect (&snap, &clip, &snap))
9279 g_list_free (windows);
9280 clip_rect->width = clip_rect->height = 0;
9281 return NULL; /* empty snapshot area */
9286 height = snap.height;
9289 /* render snapshot */
9290 pixmap = gdk_pixmap_new (widget->window, width, height, gdk_drawable_get_depth (widget->window));
9291 for (list = windows; list; list = list->next) /* !NO_WINDOW widgets */
9293 GdkWindow *subwin = list->data;
9295 if (gdk_drawable_get_depth (GDK_DRAWABLE (subwin)) == 0)
9296 continue; /* Input only window */
9297 gdk_window_get_position (subwin, &wx, &wy);
9298 gdk_window_redirect_to_drawable (subwin, pixmap, MAX (0, x - wx), MAX (0, y - wy),
9299 MAX (0, wx - x), MAX (0, wy - y), width, height);
9301 expose_window (subwin);
9303 if (!windows) /* NO_WINDOW || toplevel => parent_window == NULL || parent_window == widget->window */
9305 gdk_window_redirect_to_drawable (widget->window, pixmap, x, y, 0, 0, width, height);
9306 expose_window (widget->window);
9308 for (list = windows; list; list = list->next)
9309 gdk_window_remove_redirection (list->data);
9310 if (!windows) /* NO_WINDOW || toplevel */
9311 gdk_window_remove_redirection (widget->window);
9312 g_list_free (windows);
9314 /* return pixmap and snapshot rectangle coordinates */
9319 clip_rect->width = width;
9320 clip_rect->height = height;
9323 /* offset clip_rect from parent_window so it's widget relative */
9324 clip_rect->x -= widget->allocation.x;
9325 clip_rect->y -= widget->allocation.y;
9328 g_printerr ("gtk_widget_get_snapshot: %s (%d,%d, %dx%d)\n",
9329 G_OBJECT_TYPE_NAME (widget),
9330 clip_rect->x, clip_rect->y, clip_rect->width, clip_rect->height);
9339 * gtk_widget_class_install_style_property_parser:
9340 * @klass: a #GtkWidgetClass
9341 * @pspec: the #GParamSpec for the style property
9342 * @parser: the parser for the style property
9344 * Installs a style property on a widget class.
9347 gtk_widget_class_install_style_property_parser (GtkWidgetClass *klass,
9349 GtkRcPropertyParser parser)
9351 g_return_if_fail (GTK_IS_WIDGET_CLASS (klass));
9352 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
9353 g_return_if_fail (pspec->flags & G_PARAM_READABLE);
9354 g_return_if_fail (!(pspec->flags & (G_PARAM_CONSTRUCT_ONLY | G_PARAM_CONSTRUCT)));
9356 if (g_param_spec_pool_lookup (style_property_spec_pool, pspec->name, G_OBJECT_CLASS_TYPE (klass), FALSE))
9358 g_warning (G_STRLOC ": class `%s' already contains a style property named `%s'",
9359 G_OBJECT_CLASS_NAME (klass),
9364 g_param_spec_ref_sink (pspec);
9365 g_param_spec_set_qdata (pspec, quark_property_parser, (gpointer) parser);
9366 g_param_spec_pool_insert (style_property_spec_pool, pspec, G_OBJECT_CLASS_TYPE (klass));
9370 * gtk_widget_class_install_style_property:
9371 * @klass: a #GtkWidgetClass
9372 * @pspec: the #GParamSpec for the property
9374 * Installs a style property on a widget class. The parser for the
9375 * style property is determined by the value type of @pspec.
9378 gtk_widget_class_install_style_property (GtkWidgetClass *klass,
9381 GtkRcPropertyParser parser;
9383 g_return_if_fail (GTK_IS_WIDGET_CLASS (klass));
9384 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
9386 parser = _gtk_rc_property_parser_from_type (G_PARAM_SPEC_VALUE_TYPE (pspec));
9388 gtk_widget_class_install_style_property_parser (klass, pspec, parser);
9392 * gtk_widget_class_find_style_property:
9393 * @klass: a #GtkWidgetClass
9394 * @property_name: the name of the style property to find
9395 * @returns: the #GParamSpec of the style property or %NULL if @class has no
9396 * style property with that name.
9398 * Finds a style property of a widget class by name.
9403 gtk_widget_class_find_style_property (GtkWidgetClass *klass,
9404 const gchar *property_name)
9406 g_return_val_if_fail (property_name != NULL, NULL);
9408 return g_param_spec_pool_lookup (style_property_spec_pool,
9410 G_OBJECT_CLASS_TYPE (klass),
9415 * gtk_widget_class_list_style_properties:
9416 * @klass: a #GtkWidgetClass
9417 * @n_properties: location to return the number of style properties found
9418 * @returns: an newly allocated array of #GParamSpec*. The array must
9419 * be freed with g_free().
9421 * Returns all style properties of a widget class.
9426 gtk_widget_class_list_style_properties (GtkWidgetClass *klass,
9427 guint *n_properties)
9429 GParamSpec **pspecs;
9432 pspecs = g_param_spec_pool_list (style_property_spec_pool,
9433 G_OBJECT_CLASS_TYPE (klass),
9442 * gtk_widget_style_get_property:
9443 * @widget: a #GtkWidget
9444 * @property_name: the name of a style property
9445 * @value: location to return the property value
9447 * Gets the value of a style property of @widget.
9450 gtk_widget_style_get_property (GtkWidget *widget,
9451 const gchar *property_name,
9456 g_return_if_fail (GTK_IS_WIDGET (widget));
9457 g_return_if_fail (property_name != NULL);
9458 g_return_if_fail (G_IS_VALUE (value));
9460 g_object_ref (widget);
9461 pspec = g_param_spec_pool_lookup (style_property_spec_pool,
9463 G_OBJECT_TYPE (widget),
9466 g_warning ("%s: widget class `%s' has no property named `%s'",
9468 G_OBJECT_TYPE_NAME (widget),
9472 const GValue *peek_value;
9474 peek_value = _gtk_style_peek_property_value (widget->style,
9475 G_OBJECT_TYPE (widget),
9477 (GtkRcPropertyParser) g_param_spec_get_qdata (pspec, quark_property_parser));
9479 /* auto-conversion of the caller's value type
9481 if (G_VALUE_TYPE (value) == G_PARAM_SPEC_VALUE_TYPE (pspec))
9482 g_value_copy (peek_value, value);
9483 else if (g_value_type_transformable (G_PARAM_SPEC_VALUE_TYPE (pspec), G_VALUE_TYPE (value)))
9484 g_value_transform (peek_value, value);
9486 g_warning ("can't retrieve style property `%s' of type `%s' as value of type `%s'",
9488 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
9489 G_VALUE_TYPE_NAME (value));
9491 g_object_unref (widget);
9495 * gtk_widget_style_get_valist:
9496 * @widget: a #GtkWidget
9497 * @first_property_name: the name of the first property to get
9498 * @var_args: a <type>va_list</type> of pairs of property names and
9499 * locations to return the property values, starting with the location
9500 * for @first_property_name.
9502 * Non-vararg variant of gtk_widget_style_get(). Used primarily by language
9506 gtk_widget_style_get_valist (GtkWidget *widget,
9507 const gchar *first_property_name,
9512 g_return_if_fail (GTK_IS_WIDGET (widget));
9514 g_object_ref (widget);
9516 name = first_property_name;
9519 const GValue *peek_value;
9523 pspec = g_param_spec_pool_lookup (style_property_spec_pool,
9525 G_OBJECT_TYPE (widget),
9529 g_warning ("%s: widget class `%s' has no property named `%s'",
9531 G_OBJECT_TYPE_NAME (widget),
9535 /* style pspecs are always readable so we can spare that check here */
9537 peek_value = _gtk_style_peek_property_value (widget->style,
9538 G_OBJECT_TYPE (widget),
9540 (GtkRcPropertyParser) g_param_spec_get_qdata (pspec, quark_property_parser));
9541 G_VALUE_LCOPY (peek_value, var_args, 0, &error);
9544 g_warning ("%s: %s", G_STRLOC, error);
9549 name = va_arg (var_args, gchar*);
9552 g_object_unref (widget);
9556 * gtk_widget_style_get:
9557 * @widget: a #GtkWidget
9558 * @first_property_name: the name of the first property to get
9559 * @Varargs: pairs of property names and locations to
9560 * return the property values, starting with the location for
9561 * @first_property_name, terminated by %NULL.
9563 * Gets the values of a multiple style properties of @widget.
9566 gtk_widget_style_get (GtkWidget *widget,
9567 const gchar *first_property_name,
9572 g_return_if_fail (GTK_IS_WIDGET (widget));
9574 va_start (var_args, first_property_name);
9575 gtk_widget_style_get_valist (widget, first_property_name, var_args);
9581 * @widget: a #GtkWidget
9582 * @path_length: location to store length of the path, or %NULL
9583 * @path: location to store allocated path string, or %NULL
9584 * @path_reversed: location to store allocated reverse path string, or %NULL
9586 * Obtains the full path to @widget. The path is simply the name of a
9587 * widget and all its parents in the container hierarchy, separated by
9588 * periods. The name of a widget comes from
9589 * gtk_widget_get_name(). Paths are used to apply styles to a widget
9590 * in gtkrc configuration files. Widget names are the type of the
9591 * widget by default (e.g. "GtkButton") or can be set to an
9592 * application-specific value with gtk_widget_set_name(). By setting
9593 * the name of a widget, you allow users or theme authors to apply
9594 * styles to that specific widget in their gtkrc
9595 * file. @path_reversed_p fills in the path in reverse order,
9596 * i.e. starting with @widget's name instead of starting with the name
9597 * of @widget's outermost ancestor.
9600 gtk_widget_path (GtkWidget *widget,
9603 gchar **path_reversed)
9605 static gchar *rev_path = NULL;
9606 static guint tmp_path_len = 0;
9609 g_return_if_fail (GTK_IS_WIDGET (widget));
9614 const gchar *string;
9619 string = gtk_widget_get_name (widget);
9620 l = strlen (string);
9621 while (tmp_path_len <= len + l + 1)
9623 tmp_path_len += INIT_PATH_SIZE;
9624 rev_path = g_realloc (rev_path, tmp_path_len);
9632 widget = widget->parent;
9635 rev_path[len++] = '.';
9637 rev_path[len++] = 0;
9642 *path_length = len - 1;
9644 *path_reversed = g_strdup (rev_path);
9647 *path = g_strdup (rev_path);
9648 g_strreverse (*path);
9653 * gtk_widget_class_path:
9654 * @widget: a #GtkWidget
9655 * @path_length: location to store the length of the class path, or %NULL
9656 * @path: location to store the class path as an allocated string, or %NULL
9657 * @path_reversed: location to store the reverse class path as an allocated
9660 * Same as gtk_widget_path(), but always uses the name of a widget's type,
9661 * never uses a custom name set with gtk_widget_set_name().
9665 gtk_widget_class_path (GtkWidget *widget,
9668 gchar **path_reversed)
9670 static gchar *rev_path = NULL;
9671 static guint tmp_path_len = 0;
9674 g_return_if_fail (GTK_IS_WIDGET (widget));
9679 const gchar *string;
9684 string = g_type_name (GTK_WIDGET_TYPE (widget));
9685 l = strlen (string);
9686 while (tmp_path_len <= len + l + 1)
9688 tmp_path_len += INIT_PATH_SIZE;
9689 rev_path = g_realloc (rev_path, tmp_path_len);
9697 widget = widget->parent;
9700 rev_path[len++] = '.';
9702 rev_path[len++] = 0;
9707 *path_length = len - 1;
9709 *path_reversed = g_strdup (rev_path);
9712 *path = g_strdup (rev_path);
9713 g_strreverse (*path);
9718 * gtk_requisition_copy:
9719 * @requisition: a #GtkRequisition
9721 * Copies a #GtkRequisition.
9723 * Returns: a copy of @requisition
9726 gtk_requisition_copy (const GtkRequisition *requisition)
9728 return (GtkRequisition *)g_memdup (requisition, sizeof (GtkRequisition));
9732 * gtk_requisition_free:
9733 * @requisition: a #GtkRequisition
9735 * Frees a #GtkRequisition.
9738 gtk_requisition_free (GtkRequisition *requisition)
9740 g_free (requisition);
9744 gtk_requisition_get_type (void)
9746 static GType our_type = 0;
9749 our_type = g_boxed_type_register_static (I_("GtkRequisition"),
9750 (GBoxedCopyFunc) gtk_requisition_copy,
9751 (GBoxedFreeFunc) gtk_requisition_free);
9757 * gtk_widget_get_accessible:
9758 * @widget: a #GtkWidget
9760 * Returns the accessible object that describes the widget to an
9761 * assistive technology.
9763 * If no accessibility library is loaded (i.e. no ATK implementation library is
9764 * loaded via <envar>GTK_MODULES</envar> or via another application library,
9765 * such as libgnome), then this #AtkObject instance may be a no-op. Likewise,
9766 * if no class-specific #AtkObject implementation is available for the widget
9767 * instance in question, it will inherit an #AtkObject implementation from the
9768 * first ancestor class for which such an implementation is defined.
9770 * The documentation of the <ulink url="http://developer.gnome.org/doc/API/2.0/atk/index.html">ATK</ulink>
9771 * library contains more information about accessible objects and their uses.
9773 * Returns: the #AtkObject associated with @widget
9776 gtk_widget_get_accessible (GtkWidget *widget)
9778 GtkWidgetClass *klass;
9780 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9782 klass = GTK_WIDGET_GET_CLASS (widget);
9784 g_return_val_if_fail (klass->get_accessible != NULL, NULL);
9786 return klass->get_accessible (widget);
9790 gtk_widget_real_get_accessible (GtkWidget *widget)
9792 AtkObject* accessible;
9794 accessible = g_object_get_qdata (G_OBJECT (widget),
9795 quark_accessible_object);
9798 AtkObjectFactory *factory;
9799 AtkRegistry *default_registry;
9801 default_registry = atk_get_default_registry ();
9802 factory = atk_registry_get_factory (default_registry,
9803 G_TYPE_FROM_INSTANCE (widget));
9805 atk_object_factory_create_accessible (factory,
9807 g_object_set_qdata (G_OBJECT (widget),
9808 quark_accessible_object,
9815 * Initialize a AtkImplementorIface instance's virtual pointers as
9816 * appropriate to this implementor's class (GtkWidget).
9819 gtk_widget_accessible_interface_init (AtkImplementorIface *iface)
9821 iface->ref_accessible = gtk_widget_ref_accessible;
9825 gtk_widget_ref_accessible (AtkImplementor *implementor)
9827 AtkObject *accessible;
9829 accessible = gtk_widget_get_accessible (GTK_WIDGET (implementor));
9831 g_object_ref (accessible);
9836 * GtkBuildable implementation
9838 static GQuark quark_builder_has_default = 0;
9839 static GQuark quark_builder_has_focus = 0;
9840 static GQuark quark_builder_atk_relations = 0;
9843 gtk_widget_buildable_interface_init (GtkBuildableIface *iface)
9845 quark_builder_has_default = g_quark_from_static_string ("gtk-builder-has-default");
9846 quark_builder_has_focus = g_quark_from_static_string ("gtk-builder-has-focus");
9847 quark_builder_atk_relations = g_quark_from_static_string ("gtk-builder-atk-relations");
9849 iface->set_name = gtk_widget_buildable_set_name;
9850 iface->get_name = gtk_widget_buildable_get_name;
9851 iface->get_internal_child = gtk_widget_buildable_get_internal_child;
9852 iface->set_buildable_property = gtk_widget_buildable_set_buildable_property;
9853 iface->parser_finished = gtk_widget_buildable_parser_finished;
9854 iface->custom_tag_start = gtk_widget_buildable_custom_tag_start;
9855 iface->custom_finished = gtk_widget_buildable_custom_finished;
9859 gtk_widget_buildable_set_name (GtkBuildable *buildable,
9862 gtk_widget_set_name (GTK_WIDGET (buildable), name);
9865 static const gchar *
9866 gtk_widget_buildable_get_name (GtkBuildable *buildable)
9868 return gtk_widget_get_name (GTK_WIDGET (buildable));
9872 gtk_widget_buildable_get_internal_child (GtkBuildable *buildable,
9873 GtkBuilder *builder,
9874 const gchar *childname)
9876 if (strcmp (childname, "accessible") == 0)
9877 return G_OBJECT (gtk_widget_get_accessible (GTK_WIDGET (buildable)));
9883 gtk_widget_buildable_set_buildable_property (GtkBuildable *buildable,
9884 GtkBuilder *builder,
9886 const GValue *value)
9888 if (strcmp (name, "has-default") == 0 && g_value_get_boolean (value))
9889 g_object_set_qdata (G_OBJECT (buildable), quark_builder_has_default,
9890 GINT_TO_POINTER (TRUE));
9891 else if (strcmp (name, "has-focus") == 0 && g_value_get_boolean (value))
9892 g_object_set_qdata (G_OBJECT (buildable), quark_builder_has_focus,
9893 GINT_TO_POINTER (TRUE));
9895 g_object_set_property (G_OBJECT (buildable), name, value);
9901 GString *description;
9903 gboolean translatable;
9913 free_action (AtkActionData *data, gpointer user_data)
9915 g_free (data->action_name);
9916 g_string_free (data->description, TRUE);
9917 g_free (data->context);
9918 g_slice_free (AtkActionData, data);
9922 free_relation (AtkRelationData *data, gpointer user_data)
9924 g_free (data->target);
9925 g_free (data->type);
9926 g_slice_free (AtkRelationData, data);
9930 gtk_widget_buildable_parser_finished (GtkBuildable *buildable,
9931 GtkBuilder *builder)
9933 GSList *atk_relations;
9935 if (g_object_get_qdata (G_OBJECT (buildable), quark_builder_has_default))
9936 gtk_widget_grab_default (GTK_WIDGET (buildable));
9937 if (g_object_get_qdata (G_OBJECT (buildable), quark_builder_has_focus))
9938 gtk_widget_grab_focus (GTK_WIDGET (buildable));
9940 atk_relations = g_object_get_qdata (G_OBJECT (buildable),
9941 quark_builder_atk_relations);
9944 AtkObject *accessible;
9945 AtkRelationSet *relation_set;
9948 AtkRelationType relation_type;
9949 AtkObject *target_accessible;
9951 accessible = gtk_widget_get_accessible (GTK_WIDGET (buildable));
9952 relation_set = atk_object_ref_relation_set (accessible);
9954 for (l = atk_relations; l; l = l->next)
9956 AtkRelationData *relation = (AtkRelationData*)l->data;
9958 target = gtk_builder_get_object (builder, relation->target);
9961 g_warning ("Target object %s in <relation> does not exist",
9965 target_accessible = gtk_widget_get_accessible (GTK_WIDGET (target));
9966 g_assert (target_accessible != NULL);
9968 relation_type = atk_relation_type_for_name (relation->type);
9969 if (relation_type == ATK_RELATION_NULL)
9971 g_warning ("<relation> type %s not found",
9975 atk_relation_set_add_relation_by_type (relation_set, relation_type,
9978 g_object_unref (relation_set);
9980 g_slist_foreach (atk_relations, (GFunc)free_relation, NULL);
9981 g_slist_free (atk_relations);
9982 g_object_set_qdata (G_OBJECT (buildable), quark_builder_atk_relations,
9991 } AccessibilitySubParserData;
9994 accessibility_start_element (GMarkupParseContext *context,
9995 const gchar *element_name,
9996 const gchar **names,
9997 const gchar **values,
10001 AccessibilitySubParserData *data = (AccessibilitySubParserData*)user_data;
10003 gint line_number, char_number;
10005 if (strcmp (element_name, "relation") == 0)
10007 gchar *target = NULL;
10008 gchar *type = NULL;
10009 AtkRelationData *relation;
10011 for (i = 0; names[i]; i++)
10013 if (strcmp (names[i], "target") == 0)
10014 target = g_strdup (values[i]);
10015 else if (strcmp (names[i], "type") == 0)
10016 type = g_strdup (values[i]);
10019 g_markup_parse_context_get_position (context,
10022 g_set_error (error,
10024 GTK_BUILDER_ERROR_INVALID_ATTRIBUTE,
10025 "%s:%d:%d '%s' is not a valid attribute of <%s>",
10027 line_number, char_number, names[i], "relation");
10034 if (!target || !type)
10036 g_markup_parse_context_get_position (context,
10039 g_set_error (error,
10041 GTK_BUILDER_ERROR_MISSING_ATTRIBUTE,
10042 "%s:%d:%d <%s> requires attribute \"%s\"",
10044 line_number, char_number, "relation",
10045 type ? "target" : "type");
10051 relation = g_slice_new (AtkRelationData);
10052 relation->target = target;
10053 relation->type = type;
10055 data->relations = g_slist_prepend (data->relations, relation);
10057 else if (strcmp (element_name, "action") == 0)
10059 const gchar *action_name = NULL;
10060 const gchar *description = NULL;
10061 const gchar *msg_context = NULL;
10062 gboolean translatable = FALSE;
10063 AtkActionData *action;
10065 for (i = 0; names[i]; i++)
10067 if (strcmp (names[i], "action_name") == 0)
10068 action_name = values[i];
10069 else if (strcmp (names[i], "description") == 0)
10070 description = values[i];
10071 else if (strcmp (names[i], "translatable") == 0)
10073 if (!_gtk_builder_boolean_from_string (values[i], &translatable, error))
10076 else if (strcmp (names[i], "comments") == 0)
10078 /* do nothing, comments are for translators */
10080 else if (strcmp (names[i], "context") == 0)
10081 msg_context = values[i];
10084 g_markup_parse_context_get_position (context,
10087 g_set_error (error,
10089 GTK_BUILDER_ERROR_INVALID_ATTRIBUTE,
10090 "%s:%d:%d '%s' is not a valid attribute of <%s>",
10092 line_number, char_number, names[i], "action");
10099 g_markup_parse_context_get_position (context,
10102 g_set_error (error,
10104 GTK_BUILDER_ERROR_MISSING_ATTRIBUTE,
10105 "%s:%d:%d <%s> requires attribute \"%s\"",
10107 line_number, char_number, "action",
10112 action = g_slice_new (AtkActionData);
10113 action->action_name = g_strdup (action_name);
10114 action->description = g_string_new (description);
10115 action->context = g_strdup (msg_context);
10116 action->translatable = translatable;
10118 data->actions = g_slist_prepend (data->actions, action);
10120 else if (strcmp (element_name, "accessibility") == 0)
10123 g_warning ("Unsupported tag for GtkWidget: %s\n", element_name);
10127 accessibility_text (GMarkupParseContext *context,
10130 gpointer user_data,
10133 AccessibilitySubParserData *data = (AccessibilitySubParserData*)user_data;
10135 if (strcmp (g_markup_parse_context_get_element (context), "action") == 0)
10137 AtkActionData *action = data->actions->data;
10139 g_string_append_len (action->description, text, text_len);
10143 static const GMarkupParser accessibility_parser =
10145 accessibility_start_element,
10147 accessibility_text,
10156 } AccelGroupParserData;
10159 accel_group_start_element (GMarkupParseContext *context,
10160 const gchar *element_name,
10161 const gchar **names,
10162 const gchar **values,
10163 gpointer user_data,
10168 guint modifiers = 0;
10169 gchar *signal = NULL;
10170 AccelGroupParserData *parser_data = (AccelGroupParserData*)user_data;
10172 for (i = 0; names[i]; i++)
10174 if (strcmp (names[i], "key") == 0)
10175 key = gdk_keyval_from_name (values[i]);
10176 else if (strcmp (names[i], "modifiers") == 0)
10178 if (!_gtk_builder_flags_from_string (GDK_TYPE_MODIFIER_TYPE,
10184 else if (strcmp (names[i], "signal") == 0)
10185 signal = g_strdup (values[i]);
10188 if (key == 0 || signal == NULL)
10190 g_warning ("<accelerator> requires key and signal attributes");
10193 parser_data->key = key;
10194 parser_data->modifiers = modifiers;
10195 parser_data->signal = signal;
10198 static const GMarkupParser accel_group_parser =
10200 accel_group_start_element,
10204 gtk_widget_buildable_custom_tag_start (GtkBuildable *buildable,
10205 GtkBuilder *builder,
10207 const gchar *tagname,
10208 GMarkupParser *parser,
10211 g_assert (buildable);
10213 if (strcmp (tagname, "accelerator") == 0)
10215 AccelGroupParserData *parser_data;
10217 parser_data = g_slice_new0 (AccelGroupParserData);
10218 parser_data->object = g_object_ref (buildable);
10219 *parser = accel_group_parser;
10220 *data = parser_data;
10223 if (strcmp (tagname, "accessibility") == 0)
10225 AccessibilitySubParserData *parser_data;
10227 parser_data = g_slice_new0 (AccessibilitySubParserData);
10228 *parser = accessibility_parser;
10229 *data = parser_data;
10236 _gtk_widget_buildable_finish_accelerator (GtkWidget *widget,
10237 GtkWidget *toplevel,
10238 gpointer user_data)
10240 AccelGroupParserData *accel_data;
10241 GSList *accel_groups;
10242 GtkAccelGroup *accel_group;
10244 g_return_if_fail (GTK_IS_WIDGET (widget));
10245 g_return_if_fail (GTK_IS_WIDGET (toplevel));
10246 g_return_if_fail (user_data != NULL);
10248 accel_data = (AccelGroupParserData*)user_data;
10249 accel_groups = gtk_accel_groups_from_object (G_OBJECT (toplevel));
10250 if (g_slist_length (accel_groups) == 0)
10252 accel_group = gtk_accel_group_new ();
10253 gtk_window_add_accel_group (GTK_WINDOW (toplevel), accel_group);
10257 g_assert (g_slist_length (accel_groups) == 1);
10258 accel_group = g_slist_nth_data (accel_groups, 0);
10261 gtk_widget_add_accelerator (GTK_WIDGET (accel_data->object),
10262 accel_data->signal,
10265 accel_data->modifiers,
10266 GTK_ACCEL_VISIBLE);
10268 g_object_unref (accel_data->object);
10269 g_free (accel_data->signal);
10270 g_slice_free (AccelGroupParserData, accel_data);
10274 gtk_widget_buildable_custom_finished (GtkBuildable *buildable,
10275 GtkBuilder *builder,
10277 const gchar *tagname,
10278 gpointer user_data)
10280 AccelGroupParserData *accel_data;
10281 AccessibilitySubParserData *a11y_data;
10282 GtkWidget *toplevel;
10284 if (strcmp (tagname, "accelerator") == 0)
10286 accel_data = (AccelGroupParserData*)user_data;
10287 g_assert (accel_data->object);
10289 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (accel_data->object));
10291 _gtk_widget_buildable_finish_accelerator (GTK_WIDGET (buildable), toplevel, user_data);
10293 else if (strcmp (tagname, "accessibility") == 0)
10295 a11y_data = (AccessibilitySubParserData*)user_data;
10297 if (a11y_data->actions)
10299 AtkObject *accessible;
10304 accessible = gtk_widget_get_accessible (GTK_WIDGET (buildable));
10306 action = ATK_ACTION (accessible);
10307 n_actions = atk_action_get_n_actions (action);
10309 for (l = a11y_data->actions; l; l = l->next)
10311 AtkActionData *action_data = (AtkActionData*)l->data;
10313 for (i = 0; i < n_actions; i++)
10314 if (strcmp (atk_action_get_name (action, i),
10315 action_data->action_name) == 0)
10320 gchar *description;
10322 if (action_data->translatable && action_data->description->len)
10323 description = _gtk_builder_parser_translate (gtk_builder_get_translation_domain (builder),
10324 action_data->context,
10325 action_data->description->str);
10327 description = action_data->description->str;
10329 atk_action_set_description (action, i, description);
10333 g_slist_foreach (a11y_data->actions, (GFunc)free_action, NULL);
10334 g_slist_free (a11y_data->actions);
10337 if (a11y_data->relations)
10338 g_object_set_qdata (G_OBJECT (buildable), quark_builder_atk_relations,
10339 a11y_data->relations);
10341 g_slice_free (AccessibilitySubParserData, a11y_data);
10347 * gtk_widget_get_clipboard:
10348 * @widget: a #GtkWidget
10349 * @selection: a #GdkAtom which identifies the clipboard
10350 * to use. %GDK_SELECTION_CLIPBOARD gives the
10351 * default clipboard. Another common value
10352 * is %GDK_SELECTION_PRIMARY, which gives
10353 * the primary X selection.
10355 * Returns the clipboard object for the given selection to
10356 * be used with @widget. @widget must have a #GdkDisplay
10357 * associated with it, so must be attached to a toplevel
10360 * Return value: the appropriate clipboard object. If no
10361 * clipboard already exists, a new one will
10362 * be created. Once a clipboard object has
10363 * been created, it is persistent for all time.
10368 gtk_widget_get_clipboard (GtkWidget *widget, GdkAtom selection)
10370 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10371 g_return_val_if_fail (gtk_widget_has_screen (widget), NULL);
10373 return gtk_clipboard_get_for_display (gtk_widget_get_display (widget),
10378 * gtk_widget_list_mnemonic_labels:
10379 * @widget: a #GtkWidget
10381 * Returns a newly allocated list of the widgets, normally labels, for
10382 * which this widget is a the target of a mnemonic (see for example,
10383 * gtk_label_set_mnemonic_widget()).
10385 * The widgets in the list are not individually referenced. If you
10386 * want to iterate through the list and perform actions involving
10387 * callbacks that might destroy the widgets, you
10388 * <emphasis>must</emphasis> call <literal>g_list_foreach (result,
10389 * (GFunc)g_object_ref, NULL)</literal> first, and then unref all the
10390 * widgets afterwards.
10392 * Return value: the list of mnemonic labels; free this list
10393 * with g_list_free() when you are done with it.
10398 gtk_widget_list_mnemonic_labels (GtkWidget *widget)
10400 GList *list = NULL;
10403 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10405 for (l = g_object_get_qdata (G_OBJECT (widget), quark_mnemonic_labels); l; l = l->next)
10406 list = g_list_prepend (list, l->data);
10412 * gtk_widget_add_mnemonic_label:
10413 * @widget: a #GtkWidget
10414 * @label: a #GtkWidget that acts as a mnemonic label for @widget
10416 * Adds a widget to the list of mnemonic labels for
10417 * this widget. (See gtk_widget_list_mnemonic_labels()). Note the
10418 * list of mnemonic labels for the widget is cleared when the
10419 * widget is destroyed, so the caller must make sure to update
10420 * its internal state at this point as well, by using a connection
10421 * to the #GtkWidget::destroy signal or a weak notifier.
10426 gtk_widget_add_mnemonic_label (GtkWidget *widget,
10429 GSList *old_list, *new_list;
10431 g_return_if_fail (GTK_IS_WIDGET (widget));
10432 g_return_if_fail (GTK_IS_WIDGET (label));
10434 old_list = g_object_steal_qdata (G_OBJECT (widget), quark_mnemonic_labels);
10435 new_list = g_slist_prepend (old_list, label);
10437 g_object_set_qdata_full (G_OBJECT (widget), quark_mnemonic_labels,
10438 new_list, (GDestroyNotify) g_slist_free);
10442 * gtk_widget_remove_mnemonic_label:
10443 * @widget: a #GtkWidget
10444 * @label: a #GtkWidget that was previously set as a mnemnic label for
10445 * @widget with gtk_widget_add_mnemonic_label().
10447 * Removes a widget from the list of mnemonic labels for
10448 * this widget. (See gtk_widget_list_mnemonic_labels()). The widget
10449 * must have previously been added to the list with
10450 * gtk_widget_add_mnemonic_label().
10455 gtk_widget_remove_mnemonic_label (GtkWidget *widget,
10458 GSList *old_list, *new_list;
10460 g_return_if_fail (GTK_IS_WIDGET (widget));
10461 g_return_if_fail (GTK_IS_WIDGET (label));
10463 old_list = g_object_steal_qdata (G_OBJECT (widget), quark_mnemonic_labels);
10464 new_list = g_slist_remove (old_list, label);
10467 g_object_set_qdata_full (G_OBJECT (widget), quark_mnemonic_labels,
10468 new_list, (GDestroyNotify) g_slist_free);
10472 * gtk_widget_get_no_show_all:
10473 * @widget: a #GtkWidget
10475 * Returns the current value of the GtkWidget:no-show-all property,
10476 * which determines whether calls to gtk_widget_show_all() and
10477 * gtk_widget_hide_all() will affect this widget.
10479 * Return value: the current value of the "no-show-all" property.
10484 gtk_widget_get_no_show_all (GtkWidget *widget)
10486 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
10488 return (GTK_WIDGET_FLAGS (widget) & GTK_NO_SHOW_ALL) != 0;
10492 * gtk_widget_set_no_show_all:
10493 * @widget: a #GtkWidget
10494 * @no_show_all: the new value for the "no-show-all" property
10496 * Sets the #GtkWidget:no-show-all property, which determines whether
10497 * calls to gtk_widget_show_all() and gtk_widget_hide_all() will affect
10500 * This is mostly for use in constructing widget hierarchies with externally
10501 * controlled visibility, see #GtkUIManager.
10506 gtk_widget_set_no_show_all (GtkWidget *widget,
10507 gboolean no_show_all)
10509 g_return_if_fail (GTK_IS_WIDGET (widget));
10511 no_show_all = (no_show_all != FALSE);
10513 if (no_show_all == ((GTK_WIDGET_FLAGS (widget) & GTK_NO_SHOW_ALL) != 0))
10517 GTK_WIDGET_SET_FLAGS (widget, GTK_NO_SHOW_ALL);
10519 GTK_WIDGET_UNSET_FLAGS (widget, GTK_NO_SHOW_ALL);
10521 g_object_notify (G_OBJECT (widget), "no-show-all");
10526 gtk_widget_real_set_has_tooltip (GtkWidget *widget,
10527 gboolean has_tooltip,
10530 gboolean priv_has_tooltip;
10532 priv_has_tooltip = GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (widget),
10533 quark_has_tooltip));
10535 if (priv_has_tooltip != has_tooltip || force)
10537 priv_has_tooltip = has_tooltip;
10539 if (priv_has_tooltip)
10541 if (GTK_WIDGET_REALIZED (widget) && GTK_WIDGET_NO_WINDOW (widget))
10542 gdk_window_set_events (widget->window,
10543 gdk_window_get_events (widget->window) |
10544 GDK_LEAVE_NOTIFY_MASK |
10545 GDK_POINTER_MOTION_MASK |
10546 GDK_POINTER_MOTION_HINT_MASK);
10548 if (!GTK_WIDGET_NO_WINDOW (widget))
10549 gtk_widget_add_events (widget,
10550 GDK_LEAVE_NOTIFY_MASK |
10551 GDK_POINTER_MOTION_MASK |
10552 GDK_POINTER_MOTION_HINT_MASK);
10555 g_object_set_qdata (G_OBJECT (widget), quark_has_tooltip,
10556 GUINT_TO_POINTER (priv_has_tooltip));
10561 * gtk_widget_set_tooltip_window:
10562 * @widget: a #GtkWidget
10563 * @custom_window: a #GtkWindow, or %NULL
10565 * Replaces the default, usually yellow, window used for displaying
10566 * tooltips with @custom_window. GTK+ will take care of showing and
10567 * hiding @custom_window at the right moment, to behave likewise as
10568 * the default tooltip window. If @custom_window is %NULL, the default
10569 * tooltip window will be used.
10574 gtk_widget_set_tooltip_window (GtkWidget *widget,
10575 GtkWindow *custom_window)
10577 gboolean has_tooltip;
10578 gchar *tooltip_markup;
10580 g_return_if_fail (GTK_IS_WIDGET (widget));
10581 g_return_if_fail (custom_window == NULL || GTK_IS_WINDOW (custom_window));
10583 tooltip_markup = g_object_get_qdata (G_OBJECT (widget), quark_tooltip_markup);
10586 g_object_ref (custom_window);
10588 g_object_set_qdata_full (G_OBJECT (widget), quark_tooltip_window,
10589 custom_window, g_object_unref);
10591 has_tooltip = (custom_window != NULL || tooltip_markup != NULL);
10592 gtk_widget_real_set_has_tooltip (widget, has_tooltip, FALSE);
10594 if (has_tooltip && GTK_WIDGET_VISIBLE (widget))
10595 gtk_widget_queue_tooltip_query (widget);
10599 * gtk_widget_get_tooltip_window:
10600 * @widget: a #GtkWidget
10602 * Returns the #GtkWindow of the current tooltip. This can be the
10603 * GtkWindow created by default, or the custom tooltip window set
10604 * using gtk_widget_set_tooltip_window().
10606 * Return value: The #GtkWindow of the current tooltip.
10611 gtk_widget_get_tooltip_window (GtkWidget *widget)
10613 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10615 return g_object_get_qdata (G_OBJECT (widget), quark_tooltip_window);
10619 * gtk_widget_trigger_tooltip_query:
10620 * @widget: a #GtkWidget
10622 * Triggers a tooltip query on the display where the toplevel of @widget
10623 * is located. See gtk_tooltip_trigger_tooltip_query() for more
10629 gtk_widget_trigger_tooltip_query (GtkWidget *widget)
10631 gtk_tooltip_trigger_tooltip_query (gtk_widget_get_display (widget));
10634 static guint tooltip_query_id;
10635 static GSList *tooltip_query_displays;
10638 tooltip_query_idle (gpointer data)
10640 g_slist_foreach (tooltip_query_displays, (GFunc)gtk_tooltip_trigger_tooltip_query, NULL);
10641 g_slist_foreach (tooltip_query_displays, (GFunc)g_object_unref, NULL);
10642 g_slist_free (tooltip_query_displays);
10644 tooltip_query_displays = NULL;
10645 tooltip_query_id = 0;
10651 gtk_widget_queue_tooltip_query (GtkWidget *widget)
10653 GdkDisplay *display;
10655 display = gtk_widget_get_display (widget);
10657 if (!g_slist_find (tooltip_query_displays, display))
10658 tooltip_query_displays = g_slist_prepend (tooltip_query_displays, g_object_ref (display));
10660 if (tooltip_query_id == 0)
10661 tooltip_query_id = gdk_threads_add_idle (tooltip_query_idle, NULL);
10665 * gtk_widget_set_tooltip_text:
10666 * @widget: a #GtkWidget
10667 * @text: the contents of the tooltip for @widget
10669 * Sets @text as the contents of the tooltip. This function will take
10670 * care of setting GtkWidget:has-tooltip to %TRUE and of the default
10671 * handler for the GtkWidget::query-tooltip signal.
10673 * See also the GtkWidget:tooltip-text property and gtk_tooltip_set_text().
10678 gtk_widget_set_tooltip_text (GtkWidget *widget,
10681 g_return_if_fail (GTK_IS_WIDGET (widget));
10683 g_object_set (G_OBJECT (widget), "tooltip-text", text, NULL);
10687 * gtk_widget_get_tooltip_text:
10688 * @widget: a #GtkWidget
10690 * Gets the contents of the tooltip for @widget.
10692 * Return value: the tooltip text, or %NULL. You should free the
10693 * returned string with g_free() when done.
10698 gtk_widget_get_tooltip_text (GtkWidget *widget)
10700 gchar *text = NULL;
10702 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10704 g_object_get (G_OBJECT (widget), "tooltip-text", &text, NULL);
10710 * gtk_widget_set_tooltip_markup:
10711 * @widget: a #GtkWidget
10712 * @markup: the contents of the tooltip for @widget, or %NULL
10714 * Sets @markup as the contents of the tooltip, which is marked up with
10715 * the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
10717 * This function will take care of setting GtkWidget:has-tooltip to %TRUE
10718 * and of the default handler for the GtkWidget::query-tooltip signal.
10720 * See also the GtkWidget:tooltip-markup property and
10721 * gtk_tooltip_set_markup().
10726 gtk_widget_set_tooltip_markup (GtkWidget *widget,
10727 const gchar *markup)
10729 g_return_if_fail (GTK_IS_WIDGET (widget));
10731 g_object_set (G_OBJECT (widget), "tooltip-markup", markup, NULL);
10735 * gtk_widget_get_tooltip_markup:
10736 * @widget: a #GtkWidget
10738 * Gets the contents of the tooltip for @widget.
10740 * Return value: the tooltip text, or %NULL. You should free the
10741 * returned string with g_free() when done.
10746 gtk_widget_get_tooltip_markup (GtkWidget *widget)
10748 gchar *text = NULL;
10750 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10752 g_object_get (G_OBJECT (widget), "tooltip-markup", &text, NULL);
10758 * gtk_widget_set_has_tooltip:
10759 * @widget: a #GtkWidget
10760 * @has_tooltip: whether or not @widget has a tooltip.
10762 * Sets the has-tooltip property on @widget to @has_tooltip. See
10763 * GtkWidget:has-tooltip for more information.
10768 gtk_widget_set_has_tooltip (GtkWidget *widget,
10769 gboolean has_tooltip)
10771 g_return_if_fail (GTK_IS_WIDGET (widget));
10773 g_object_set (G_OBJECT (widget), "has-tooltip", has_tooltip, NULL);
10777 * gtk_widget_get_has_tooltip:
10778 * @widget: a #GtkWidget
10780 * Returns the current value of the has-tooltip property. See
10781 * GtkWidget:has-tooltip for more information.
10783 * Return value: current value of has-tooltip on @widget.
10788 gtk_widget_get_has_tooltip (GtkWidget *widget)
10790 gboolean has_tooltip = FALSE;
10792 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
10794 g_object_get (G_OBJECT (widget), "has-tooltip", &has_tooltip, NULL);
10796 return has_tooltip;
10800 * gtk_widget_get_allocation:
10801 * @widget: a #GtkWidget
10802 * @allocation: a pointer to a #GtkAllocation to copy to
10804 * Retrieves the widget's allocation.
10809 gtk_widget_get_allocation (GtkWidget *widget,
10810 GtkAllocation *allocation)
10812 g_return_if_fail (GTK_IS_WIDGET (widget));
10813 g_return_if_fail (allocation != NULL);
10815 *allocation = widget->allocation;
10819 * gtk_widget_set_allocation:
10820 * @widget: a #GtkWidget
10821 * @allocation: a pointer to a #GtkAllocation to copy from
10823 * Sets the widget's allocation. This should not be used
10824 * directly, but from within a widget's size_allocate method.
10829 gtk_widget_set_allocation (GtkWidget *widget,
10830 const GtkAllocation *allocation)
10832 g_return_if_fail (GTK_IS_WIDGET (widget));
10833 g_return_if_fail (allocation != NULL);
10835 widget->allocation = *allocation;
10839 * gtk_widget_get_window:
10840 * @widget: a #GtkWidget
10842 * Returns the widget's window if it is realized, %NULL otherwise
10844 * Return value: @widget's window.
10849 gtk_widget_get_window (GtkWidget *widget)
10851 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10853 return widget->window;
10856 #define __GTK_WIDGET_C__
10857 #include "gtkaliasdef.c"