1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
31 #include "gtkcontainer.h"
32 #include "gtkaccelmap.h"
33 #include "gtkclipboard.h"
34 #include "gtkiconfactory.h"
37 #include "gtkmarshalers.h"
39 #include "gtkselection.h"
40 #include "gtksettings.h"
41 #include "gtksizegroup.h"
42 #include "gtkwidget.h"
43 #include "gtkwindow.h"
44 #include "gtkbindings.h"
45 #include "gtkprivate.h"
47 #include "gdk/gdkprivate.h" /* Used in gtk_reset_shapes_recurse to avoid copy */
48 #include <gobject/gvaluecollector.h>
49 #include <gobject/gobjectnotifyqueue.c>
50 #include "gdk/gdkkeysyms.h"
51 #include "gtkaccessible.h"
52 #include "gtktooltip.h"
53 #include "gtkinvisible.h"
54 #include "gtkbuildable.h"
55 #include "gtkbuilderprivate.h"
56 #include "gtkextendedlayout.h"
61 * @Short_description: Base class for all widgets
64 * GtkWidget is the base class all widgets in GTK+ derive from. It manages the
65 * widget lifecycle, states and style.
66 * <refsect2 id="style-properties">
68 * <structname>GtkWidget</structname> introduces <firstterm>style
69 * properties</firstterm> - these are basically object properties that are stored
70 * not on the object, but in the style object associated to the widget. Style
71 * properties are set in <link linkend="gtk-Resource-Files">resource files</link>.
72 * This mechanism is used for configuring such things as the location of the
73 * scrollbar arrows through the theme, giving theme authors more control over the
74 * look of applications without the need to write a theme engine in C.
77 * Use gtk_widget_class_install_style_property() to install style properties for
78 * a widget class, gtk_widget_class_find_style_property() or
79 * gtk_widget_class_list_style_properties() to get information about existing
80 * style properties and gtk_widget_style_get_property(), gtk_widget_style_get() or
81 * gtk_widget_style_get_valist() to obtain the value of a style property.
84 * <refsect2 id="GtkWidget-BUILDER-UI">
85 * <title>GtkWidget as GtkBuildable</title>
87 * The GtkWidget implementation of the GtkBuildable interface supports a
88 * custom <accelerator> element, which has attributes named key,
89 * modifiers and signal and allows to specify accelerators.
92 * <title>A UI definition fragment specifying an accelerator</title>
93 * <programlisting><![CDATA[
94 * <object class="GtkButton">
95 * <accelerator key="q" modifiers="GDK_CONTROL_MASK" signal="clicked"/>
97 * ]]></programlisting>
100 * In addition to accelerators, <structname>GtkWidget</structname> also support a
101 * custom <accessible> element, which supports actions and relations.
102 * Properties on the accessible implementation of an object can be set by accessing the
103 * internal child "accessible" of a <structname>GtkWidget</structname>.
106 * <title>A UI definition fragment specifying an accessible</title>
107 * <programlisting><![CDATA[
108 * <object class="GtkButton" id="label1"/>
109 * <property name="label">I am a Label for a Button</property>
111 * <object class="GtkButton" id="button1">
113 * <action action_name="click" translatable="yes">Click the button.</action>
114 * <relation target="label1" type="labelled-by"/>
116 * <child internal-child="accessible">
117 * <object class="AtkObject" id="a11y-button1">
118 * <property name="AtkObject::name">Clickable Button</property>
122 * ]]></programlisting>
127 #define WIDGET_CLASS(w) GTK_WIDGET_GET_CLASS (w)
128 #define INIT_PATH_SIZE (512)
154 BUTTON_RELEASE_EVENT,
169 PROPERTY_NOTIFY_EVENT,
170 SELECTION_CLEAR_EVENT,
171 SELECTION_REQUEST_EVENT,
172 SELECTION_NOTIFY_EVENT,
187 VISIBILITY_NOTIFY_EVENT,
191 ACCEL_CLOSURES_CHANGED,
217 PROP_RECEIVES_DEFAULT,
218 PROP_COMPOSITE_CHILD,
221 PROP_EXTENSION_EVENTS,
230 typedef struct _GtkStateData GtkStateData;
235 guint state_restoration : 1;
236 guint parent_sensitive : 1;
237 guint use_forall : 1;
240 /* --- prototypes --- */
241 static void gtk_widget_class_init (GtkWidgetClass *klass);
242 static void gtk_widget_base_class_finalize (GtkWidgetClass *klass);
243 static void gtk_widget_init (GtkWidget *widget);
244 static void gtk_widget_set_property (GObject *object,
248 static void gtk_widget_get_property (GObject *object,
252 static void gtk_widget_dispose (GObject *object);
253 static void gtk_widget_real_destroy (GtkObject *object);
254 static void gtk_widget_finalize (GObject *object);
255 static void gtk_widget_real_show (GtkWidget *widget);
256 static void gtk_widget_real_hide (GtkWidget *widget);
257 static void gtk_widget_real_map (GtkWidget *widget);
258 static void gtk_widget_real_unmap (GtkWidget *widget);
259 static void gtk_widget_real_realize (GtkWidget *widget);
260 static void gtk_widget_real_unrealize (GtkWidget *widget);
261 static void gtk_widget_real_size_request (GtkWidget *widget,
262 GtkRequisition *requisition);
263 static void gtk_widget_real_size_allocate (GtkWidget *widget,
264 GtkAllocation *allocation);
265 static void gtk_widget_real_style_set (GtkWidget *widget,
266 GtkStyle *previous_style);
267 static void gtk_widget_real_direction_changed(GtkWidget *widget,
268 GtkTextDirection previous_direction);
270 static void gtk_widget_real_grab_focus (GtkWidget *focus_widget);
271 static gboolean gtk_widget_real_query_tooltip (GtkWidget *widget,
274 gboolean keyboard_tip,
275 GtkTooltip *tooltip);
276 static gboolean gtk_widget_real_show_help (GtkWidget *widget,
277 GtkWidgetHelpType help_type);
279 static void gtk_widget_dispatch_child_properties_changed (GtkWidget *object,
281 GParamSpec **pspecs);
282 static gboolean gtk_widget_real_key_press_event (GtkWidget *widget,
284 static gboolean gtk_widget_real_key_release_event (GtkWidget *widget,
286 static gboolean gtk_widget_real_focus_in_event (GtkWidget *widget,
287 GdkEventFocus *event);
288 static gboolean gtk_widget_real_focus_out_event (GtkWidget *widget,
289 GdkEventFocus *event);
290 static gboolean gtk_widget_real_focus (GtkWidget *widget,
291 GtkDirectionType direction);
292 static void gtk_widget_real_move_focus (GtkWidget *widget,
293 GtkDirectionType direction);
294 static gboolean gtk_widget_real_keynav_failed (GtkWidget *widget,
295 GtkDirectionType direction);
296 static PangoContext* gtk_widget_peek_pango_context (GtkWidget *widget);
297 static void gtk_widget_update_pango_context (GtkWidget *widget);
298 static void gtk_widget_propagate_state (GtkWidget *widget,
300 static void gtk_widget_reset_rc_style (GtkWidget *widget);
301 static void gtk_widget_set_style_internal (GtkWidget *widget,
303 gboolean initial_emission);
304 static gint gtk_widget_event_internal (GtkWidget *widget,
306 static gboolean gtk_widget_real_mnemonic_activate (GtkWidget *widget,
307 gboolean group_cycling);
308 static void gtk_widget_aux_info_destroy (GtkWidgetAuxInfo *aux_info);
309 static AtkObject* gtk_widget_real_get_accessible (GtkWidget *widget);
310 static void gtk_widget_accessible_interface_init (AtkImplementorIface *iface);
311 static AtkObject* gtk_widget_ref_accessible (AtkImplementor *implementor);
312 static void gtk_widget_invalidate_widget_windows (GtkWidget *widget,
314 static GdkScreen * gtk_widget_get_screen_unchecked (GtkWidget *widget);
315 static void gtk_widget_queue_shallow_draw (GtkWidget *widget);
316 static gboolean gtk_widget_real_can_activate_accel (GtkWidget *widget,
319 static void gtk_widget_real_set_has_tooltip (GtkWidget *widget,
320 gboolean has_tooltip,
322 static void gtk_widget_buildable_interface_init (GtkBuildableIface *iface);
323 static void gtk_widget_buildable_set_name (GtkBuildable *buildable,
325 static const gchar * gtk_widget_buildable_get_name (GtkBuildable *buildable);
326 static GObject * gtk_widget_buildable_get_internal_child (GtkBuildable *buildable,
328 const gchar *childname);
329 static void gtk_widget_buildable_set_buildable_property (GtkBuildable *buildable,
332 const GValue *value);
333 static gboolean gtk_widget_buildable_custom_tag_start (GtkBuildable *buildable,
336 const gchar *tagname,
337 GMarkupParser *parser,
339 static void gtk_widget_buildable_custom_finished (GtkBuildable *buildable,
342 const gchar *tagname,
344 static void gtk_widget_buildable_parser_finished (GtkBuildable *buildable,
345 GtkBuilder *builder);
347 static void gtk_widget_layout_interface_init (GtkExtendedLayoutIface *iface);
348 static void gtk_widget_real_get_desired_size (GtkExtendedLayout *layout,
349 GtkRequisition *minimum_size,
350 GtkRequisition *natural_size);
352 static void gtk_widget_queue_tooltip_query (GtkWidget *widget);
354 static void gtk_widget_set_usize_internal (GtkWidget *widget,
357 static void gtk_widget_get_draw_rectangle (GtkWidget *widget,
361 /* --- variables --- */
362 static gpointer gtk_widget_parent_class = NULL;
363 static guint widget_signals[LAST_SIGNAL] = { 0 };
364 static GtkStyle *gtk_default_style = NULL;
365 static GSList *colormap_stack = NULL;
366 static guint composite_child_stack = 0;
367 static GtkTextDirection gtk_default_direction = GTK_TEXT_DIR_LTR;
368 static GParamSpecPool *style_property_spec_pool = NULL;
370 static GQuark quark_property_parser = 0;
371 static GQuark quark_aux_info = 0;
372 static GQuark quark_accel_path = 0;
373 static GQuark quark_accel_closures = 0;
374 static GQuark quark_event_mask = 0;
375 static GQuark quark_extension_event_mode = 0;
376 static GQuark quark_parent_window = 0;
377 static GQuark quark_pointer_window = 0;
378 static GQuark quark_shape_info = 0;
379 static GQuark quark_input_shape_info = 0;
380 static GQuark quark_colormap = 0;
381 static GQuark quark_pango_context = 0;
382 static GQuark quark_rc_style = 0;
383 static GQuark quark_accessible_object = 0;
384 static GQuark quark_mnemonic_labels = 0;
385 static GQuark quark_tooltip_markup = 0;
386 static GQuark quark_has_tooltip = 0;
387 static GQuark quark_tooltip_window = 0;
388 GParamSpecPool *_gtk_widget_child_property_pool = NULL;
389 GObjectNotifyContext *_gtk_widget_child_property_notify_context = NULL;
391 /* --- functions --- */
393 gtk_widget_get_type (void)
395 static GType widget_type = 0;
397 if (G_UNLIKELY (widget_type == 0))
399 const GTypeInfo widget_info =
401 sizeof (GtkWidgetClass),
402 NULL, /* base_init */
403 (GBaseFinalizeFunc) gtk_widget_base_class_finalize,
404 (GClassInitFunc) gtk_widget_class_init,
405 NULL, /* class_finalize */
406 NULL, /* class_init */
409 (GInstanceInitFunc) gtk_widget_init,
410 NULL, /* value_table */
413 const GInterfaceInfo accessibility_info =
415 (GInterfaceInitFunc) gtk_widget_accessible_interface_init,
416 (GInterfaceFinalizeFunc) NULL,
417 NULL /* interface data */
420 const GInterfaceInfo buildable_info =
422 (GInterfaceInitFunc) gtk_widget_buildable_interface_init,
423 (GInterfaceFinalizeFunc) NULL,
424 NULL /* interface data */
427 const GInterfaceInfo layout_info =
429 (GInterfaceInitFunc) gtk_widget_layout_interface_init,
430 (GInterfaceFinalizeFunc) NULL,
431 NULL /* interface data */
434 widget_type = g_type_register_static (GTK_TYPE_OBJECT, "GtkWidget",
435 &widget_info, G_TYPE_FLAG_ABSTRACT);
437 g_type_add_interface_static (widget_type, ATK_TYPE_IMPLEMENTOR,
438 &accessibility_info) ;
439 g_type_add_interface_static (widget_type, GTK_TYPE_BUILDABLE,
441 g_type_add_interface_static (widget_type, GTK_TYPE_EXTENDED_LAYOUT,
449 child_property_notify_dispatcher (GObject *object,
453 GTK_WIDGET_GET_CLASS (object)->dispatch_child_properties_changed (GTK_WIDGET (object), n_pspecs, pspecs);
457 gtk_widget_class_init (GtkWidgetClass *klass)
459 static GObjectNotifyContext cpn_context = { 0, NULL, NULL };
460 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
461 GtkObjectClass *object_class = GTK_OBJECT_CLASS (klass);
462 GtkBindingSet *binding_set;
464 gtk_widget_parent_class = g_type_class_peek_parent (klass);
466 quark_property_parser = g_quark_from_static_string ("gtk-rc-property-parser");
467 quark_aux_info = g_quark_from_static_string ("gtk-aux-info");
468 quark_accel_path = g_quark_from_static_string ("gtk-accel-path");
469 quark_accel_closures = g_quark_from_static_string ("gtk-accel-closures");
470 quark_event_mask = g_quark_from_static_string ("gtk-event-mask");
471 quark_extension_event_mode = g_quark_from_static_string ("gtk-extension-event-mode");
472 quark_parent_window = g_quark_from_static_string ("gtk-parent-window");
473 quark_pointer_window = g_quark_from_static_string ("gtk-pointer-window");
474 quark_shape_info = g_quark_from_static_string ("gtk-shape-info");
475 quark_input_shape_info = g_quark_from_static_string ("gtk-input-shape-info");
476 quark_colormap = g_quark_from_static_string ("gtk-colormap");
477 quark_pango_context = g_quark_from_static_string ("gtk-pango-context");
478 quark_rc_style = g_quark_from_static_string ("gtk-rc-style");
479 quark_accessible_object = g_quark_from_static_string ("gtk-accessible-object");
480 quark_mnemonic_labels = g_quark_from_static_string ("gtk-mnemonic-labels");
481 quark_tooltip_markup = g_quark_from_static_string ("gtk-tooltip-markup");
482 quark_has_tooltip = g_quark_from_static_string ("gtk-has-tooltip");
483 quark_tooltip_window = g_quark_from_static_string ("gtk-tooltip-window");
485 style_property_spec_pool = g_param_spec_pool_new (FALSE);
486 _gtk_widget_child_property_pool = g_param_spec_pool_new (TRUE);
487 cpn_context.quark_notify_queue = g_quark_from_static_string ("GtkWidget-child-property-notify-queue");
488 cpn_context.dispatcher = child_property_notify_dispatcher;
489 _gtk_widget_child_property_notify_context = &cpn_context;
491 gobject_class->dispose = gtk_widget_dispose;
492 gobject_class->finalize = gtk_widget_finalize;
493 gobject_class->set_property = gtk_widget_set_property;
494 gobject_class->get_property = gtk_widget_get_property;
496 object_class->destroy = gtk_widget_real_destroy;
498 klass->activate_signal = 0;
499 klass->set_scroll_adjustments_signal = 0;
500 klass->dispatch_child_properties_changed = gtk_widget_dispatch_child_properties_changed;
501 klass->show = gtk_widget_real_show;
502 klass->show_all = gtk_widget_show;
503 klass->hide = gtk_widget_real_hide;
504 klass->hide_all = gtk_widget_hide;
505 klass->map = gtk_widget_real_map;
506 klass->unmap = gtk_widget_real_unmap;
507 klass->realize = gtk_widget_real_realize;
508 klass->unrealize = gtk_widget_real_unrealize;
509 klass->size_request = gtk_widget_real_size_request;
510 klass->size_allocate = gtk_widget_real_size_allocate;
511 klass->state_changed = NULL;
512 klass->parent_set = NULL;
513 klass->hierarchy_changed = NULL;
514 klass->style_set = gtk_widget_real_style_set;
515 klass->direction_changed = gtk_widget_real_direction_changed;
516 klass->grab_notify = NULL;
517 klass->child_notify = NULL;
518 klass->mnemonic_activate = gtk_widget_real_mnemonic_activate;
519 klass->grab_focus = gtk_widget_real_grab_focus;
520 klass->focus = gtk_widget_real_focus;
522 klass->button_press_event = NULL;
523 klass->button_release_event = NULL;
524 klass->motion_notify_event = NULL;
525 klass->delete_event = NULL;
526 klass->destroy_event = NULL;
527 klass->expose_event = NULL;
528 klass->key_press_event = gtk_widget_real_key_press_event;
529 klass->key_release_event = gtk_widget_real_key_release_event;
530 klass->enter_notify_event = NULL;
531 klass->leave_notify_event = NULL;
532 klass->configure_event = NULL;
533 klass->focus_in_event = gtk_widget_real_focus_in_event;
534 klass->focus_out_event = gtk_widget_real_focus_out_event;
535 klass->map_event = NULL;
536 klass->unmap_event = NULL;
537 klass->window_state_event = NULL;
538 klass->property_notify_event = _gtk_selection_property_notify;
539 klass->selection_clear_event = gtk_selection_clear;
540 klass->selection_request_event = _gtk_selection_request;
541 klass->selection_notify_event = _gtk_selection_notify;
542 klass->selection_received = NULL;
543 klass->proximity_in_event = NULL;
544 klass->proximity_out_event = NULL;
545 klass->drag_begin = NULL;
546 klass->drag_end = NULL;
547 klass->drag_data_delete = NULL;
548 klass->drag_leave = NULL;
549 klass->drag_motion = NULL;
550 klass->drag_drop = NULL;
551 klass->drag_data_received = NULL;
552 klass->screen_changed = NULL;
553 klass->can_activate_accel = gtk_widget_real_can_activate_accel;
554 klass->grab_broken_event = NULL;
555 klass->query_tooltip = gtk_widget_real_query_tooltip;
557 klass->show_help = gtk_widget_real_show_help;
559 /* Accessibility support */
560 klass->get_accessible = gtk_widget_real_get_accessible;
562 klass->no_expose_event = NULL;
564 g_object_class_install_property (gobject_class,
566 g_param_spec_string ("name",
568 P_("The name of the widget"),
570 GTK_PARAM_READWRITE));
571 g_object_class_install_property (gobject_class,
573 g_param_spec_object ("parent",
575 P_("The parent widget of this widget. Must be a Container widget"),
577 GTK_PARAM_READWRITE));
579 g_object_class_install_property (gobject_class,
581 g_param_spec_int ("width-request",
583 P_("Override for width request of the widget, or -1 if natural request should be used"),
587 GTK_PARAM_READWRITE));
588 g_object_class_install_property (gobject_class,
590 g_param_spec_int ("height-request",
591 P_("Height request"),
592 P_("Override for height request of the widget, or -1 if natural request should be used"),
596 GTK_PARAM_READWRITE));
597 g_object_class_install_property (gobject_class,
599 g_param_spec_boolean ("visible",
601 P_("Whether the widget is visible"),
603 GTK_PARAM_READWRITE));
604 g_object_class_install_property (gobject_class,
606 g_param_spec_boolean ("sensitive",
608 P_("Whether the widget responds to input"),
610 GTK_PARAM_READWRITE));
611 g_object_class_install_property (gobject_class,
613 g_param_spec_boolean ("app-paintable",
614 P_("Application paintable"),
615 P_("Whether the application will paint directly on the widget"),
617 GTK_PARAM_READWRITE));
618 g_object_class_install_property (gobject_class,
620 g_param_spec_boolean ("can-focus",
622 P_("Whether the widget can accept the input focus"),
624 GTK_PARAM_READWRITE));
625 g_object_class_install_property (gobject_class,
627 g_param_spec_boolean ("has-focus",
629 P_("Whether the widget has the input focus"),
631 GTK_PARAM_READWRITE));
632 g_object_class_install_property (gobject_class,
634 g_param_spec_boolean ("is-focus",
636 P_("Whether the widget is the focus widget within the toplevel"),
638 GTK_PARAM_READWRITE));
639 g_object_class_install_property (gobject_class,
641 g_param_spec_boolean ("can-default",
643 P_("Whether the widget can be the default widget"),
645 GTK_PARAM_READWRITE));
646 g_object_class_install_property (gobject_class,
648 g_param_spec_boolean ("has-default",
650 P_("Whether the widget is the default widget"),
652 GTK_PARAM_READWRITE));
653 g_object_class_install_property (gobject_class,
654 PROP_RECEIVES_DEFAULT,
655 g_param_spec_boolean ("receives-default",
656 P_("Receives default"),
657 P_("If TRUE, the widget will receive the default action when it is focused"),
659 GTK_PARAM_READWRITE));
660 g_object_class_install_property (gobject_class,
661 PROP_COMPOSITE_CHILD,
662 g_param_spec_boolean ("composite-child",
663 P_("Composite child"),
664 P_("Whether the widget is part of a composite widget"),
666 GTK_PARAM_READABLE));
667 g_object_class_install_property (gobject_class,
669 g_param_spec_object ("style",
671 P_("The style of the widget, which contains information about how it will look (colors etc)"),
673 GTK_PARAM_READWRITE));
674 g_object_class_install_property (gobject_class,
676 g_param_spec_flags ("events",
678 P_("The event mask that decides what kind of GdkEvents this widget gets"),
681 GTK_PARAM_READWRITE));
682 g_object_class_install_property (gobject_class,
683 PROP_EXTENSION_EVENTS,
684 g_param_spec_enum ("extension-events",
685 P_("Extension events"),
686 P_("The mask that decides what kind of extension events this widget gets"),
687 GDK_TYPE_EXTENSION_MODE,
688 GDK_EXTENSION_EVENTS_NONE,
689 GTK_PARAM_READWRITE));
690 g_object_class_install_property (gobject_class,
692 g_param_spec_boolean ("no-show-all",
694 P_("Whether gtk_widget_show_all() should not affect this widget"),
696 GTK_PARAM_READWRITE));
699 * GtkWidget:has-tooltip:
701 * Enables or disables the emission of #GtkWidget::query-tooltip on @widget.
702 * A value of %TRUE indicates that @widget can have a tooltip, in this case
703 * the widget will be queried using #GtkWidget::query-tooltip to determine
704 * whether it will provide a tooltip or not.
706 * Note that setting this property to %TRUE for the first time will change
707 * the event masks of the GdkWindows of this widget to include leave-notify
708 * and motion-notify events. This cannot and will not be undone when the
709 * property is set to %FALSE again.
713 g_object_class_install_property (gobject_class,
715 g_param_spec_boolean ("has-tooltip",
717 P_("Whether this widget has a tooltip"),
719 GTK_PARAM_READWRITE));
721 * GtkWidget:tooltip-text:
723 * Sets the text of tooltip to be the given string.
725 * Also see gtk_tooltip_set_text().
727 * This is a convenience property which will take care of getting the
728 * tooltip shown if the given string is not %NULL: #GtkWidget:has-tooltip
729 * will automatically be set to %TRUE and there will be taken care of
730 * #GtkWidget::query-tooltip in the default signal handler.
734 g_object_class_install_property (gobject_class,
736 g_param_spec_string ("tooltip-text",
738 P_("The contents of the tooltip for this widget"),
740 GTK_PARAM_READWRITE));
742 * GtkWidget:tooltip-markup:
744 * Sets the text of tooltip to be the given string, which is marked up
745 * with the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
746 * Also see gtk_tooltip_set_markup().
748 * This is a convenience property which will take care of getting the
749 * tooltip shown if the given string is not %NULL: #GtkWidget:has-tooltip
750 * will automatically be set to %TRUE and there will be taken care of
751 * #GtkWidget::query-tooltip in the default signal handler.
755 g_object_class_install_property (gobject_class,
757 g_param_spec_string ("tooltip-markup",
758 P_("Tooltip markup"),
759 P_("The contents of the tooltip for this widget"),
761 GTK_PARAM_READWRITE));
766 * The widget's window if it is realized, %NULL otherwise.
770 g_object_class_install_property (gobject_class,
772 g_param_spec_object ("window",
774 P_("The widget's window if it is realized"),
776 GTK_PARAM_READABLE));
779 * GtkWidget:double-buffered
781 * Whether or not the widget is double buffered.
785 g_object_class_install_property (gobject_class,
786 PROP_DOUBLE_BUFFERED,
787 g_param_spec_boolean ("double-buffered",
788 P_("Double Buffered"),
789 P_("Whether or not the widget is double buffered"),
791 GTK_PARAM_READWRITE));
795 * @widget: the object which received the signal.
797 widget_signals[SHOW] =
798 g_signal_new (I_("show"),
799 G_TYPE_FROM_CLASS (gobject_class),
801 G_STRUCT_OFFSET (GtkWidgetClass, show),
803 _gtk_marshal_VOID__VOID,
808 * @widget: the object which received the signal.
810 widget_signals[HIDE] =
811 g_signal_new (I_("hide"),
812 G_TYPE_FROM_CLASS (gobject_class),
814 G_STRUCT_OFFSET (GtkWidgetClass, hide),
816 _gtk_marshal_VOID__VOID,
821 * @widget: the object which received the signal.
823 widget_signals[MAP] =
824 g_signal_new (I_("map"),
825 G_TYPE_FROM_CLASS (gobject_class),
827 G_STRUCT_OFFSET (GtkWidgetClass, map),
829 _gtk_marshal_VOID__VOID,
834 * @widget: the object which received the signal.
836 widget_signals[UNMAP] =
837 g_signal_new (I_("unmap"),
838 G_TYPE_FROM_CLASS (gobject_class),
840 G_STRUCT_OFFSET (GtkWidgetClass, unmap),
842 _gtk_marshal_VOID__VOID,
846 * GtkWidget::realize:
847 * @widget: the object which received the signal.
849 widget_signals[REALIZE] =
850 g_signal_new (I_("realize"),
851 G_TYPE_FROM_CLASS (gobject_class),
853 G_STRUCT_OFFSET (GtkWidgetClass, realize),
855 _gtk_marshal_VOID__VOID,
859 * GtkWidget::unrealize:
860 * @widget: the object which received the signal.
862 widget_signals[UNREALIZE] =
863 g_signal_new (I_("unrealize"),
864 G_TYPE_FROM_CLASS (gobject_class),
866 G_STRUCT_OFFSET (GtkWidgetClass, unrealize),
868 _gtk_marshal_VOID__VOID,
872 * GtkWidget::size-request:
873 * @widget: the object which received the signal.
876 widget_signals[SIZE_REQUEST] =
877 g_signal_new (I_("size-request"),
878 G_TYPE_FROM_CLASS (gobject_class),
880 G_STRUCT_OFFSET (GtkWidgetClass, size_request),
882 _gtk_marshal_VOID__BOXED,
884 GTK_TYPE_REQUISITION | G_SIGNAL_TYPE_STATIC_SCOPE);
887 * GtkWidget::size-allocate:
888 * @widget: the object which received the signal.
891 widget_signals[SIZE_ALLOCATE] =
892 g_signal_new (I_("size-allocate"),
893 G_TYPE_FROM_CLASS (gobject_class),
895 G_STRUCT_OFFSET (GtkWidgetClass, size_allocate),
897 _gtk_marshal_VOID__BOXED,
899 GDK_TYPE_RECTANGLE | G_SIGNAL_TYPE_STATIC_SCOPE);
902 * GtkWidget::state-changed:
903 * @widget: the object which received the signal.
904 * @state: the previous state
906 * The ::state-changed signal is emitted when the widget state changes.
907 * See gtk_widget_get_state().
909 widget_signals[STATE_CHANGED] =
910 g_signal_new (I_("state-changed"),
911 G_TYPE_FROM_CLASS (gobject_class),
913 G_STRUCT_OFFSET (GtkWidgetClass, state_changed),
915 _gtk_marshal_VOID__ENUM,
917 GTK_TYPE_STATE_TYPE);
920 * GtkWidget::parent-set:
921 * @widget: the object on which the signal is emitted
922 * @old_parent: (allow-none): the previous parent, or %NULL if the widget
923 * just got its initial parent.
925 * The ::parent-set signal is emitted when a new parent
926 * has been set on a widget.
928 widget_signals[PARENT_SET] =
929 g_signal_new (I_("parent-set"),
930 G_TYPE_FROM_CLASS (gobject_class),
932 G_STRUCT_OFFSET (GtkWidgetClass, parent_set),
934 _gtk_marshal_VOID__OBJECT,
939 * GtkWidget::hierarchy-changed:
940 * @widget: the object on which the signal is emitted
941 * @previous_toplevel: (allow-none): the previous toplevel ancestor, or %NULL
942 * if the widget was previously unanchored
944 * The ::hierarchy-changed signal is emitted when the
945 * anchored state of a widget changes. A widget is
946 * <firstterm>anchored</firstterm> when its toplevel
947 * ancestor is a #GtkWindow. This signal is emitted when
948 * a widget changes from un-anchored to anchored or vice-versa.
950 widget_signals[HIERARCHY_CHANGED] =
951 g_signal_new (I_("hierarchy-changed"),
952 G_TYPE_FROM_CLASS (gobject_class),
954 G_STRUCT_OFFSET (GtkWidgetClass, hierarchy_changed),
956 _gtk_marshal_VOID__OBJECT,
961 * GtkWidget::style-set:
962 * @widget: the object on which the signal is emitted
963 * @previous_style: (allow-none): the previous style, or %NULL if the widget
964 * just got its initial style
966 * The ::style-set signal is emitted when a new style has been set
967 * on a widget. Note that style-modifying functions like
968 * gtk_widget_modify_base() also cause this signal to be emitted.
970 widget_signals[STYLE_SET] =
971 g_signal_new (I_("style-set"),
972 G_TYPE_FROM_CLASS (gobject_class),
974 G_STRUCT_OFFSET (GtkWidgetClass, style_set),
976 _gtk_marshal_VOID__OBJECT,
980 * GtkWidget::direction-changed:
981 * @widget: the object on which the signal is emitted
982 * @previous_direction: the previous text direction of @widget
984 * The ::direction-changed signal is emitted when the text direction
985 * of a widget changes.
987 widget_signals[DIRECTION_CHANGED] =
988 g_signal_new (I_("direction-changed"),
989 G_TYPE_FROM_CLASS (gobject_class),
991 G_STRUCT_OFFSET (GtkWidgetClass, direction_changed),
993 _gtk_marshal_VOID__ENUM,
995 GTK_TYPE_TEXT_DIRECTION);
998 * GtkWidget::grab-notify:
999 * @widget: the object which received the signal
1000 * @was_grabbed: %FALSE if the widget becomes shadowed, %TRUE
1001 * if it becomes unshadowed
1003 * The ::grab-notify signal is emitted when a widget becomes
1004 * shadowed by a GTK+ grab (not a pointer or keyboard grab) on
1005 * another widget, or when it becomes unshadowed due to a grab
1008 * A widget is shadowed by a gtk_grab_add() when the topmost
1009 * grab widget in the grab stack of its window group is not
1012 widget_signals[GRAB_NOTIFY] =
1013 g_signal_new (I_("grab-notify"),
1014 G_TYPE_FROM_CLASS (gobject_class),
1016 G_STRUCT_OFFSET (GtkWidgetClass, grab_notify),
1018 _gtk_marshal_VOID__BOOLEAN,
1023 * GtkWidget::child-notify:
1024 * @widget: the object which received the signal
1025 * @pspec: the #GParamSpec of the changed child property
1027 * The ::child-notify signal is emitted for each
1028 * <link linkend="child-properties">child property</link> that has
1029 * changed on an object. The signal's detail holds the property name.
1031 widget_signals[CHILD_NOTIFY] =
1032 g_signal_new (I_("child-notify"),
1033 G_TYPE_FROM_CLASS (gobject_class),
1034 G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE | G_SIGNAL_DETAILED | G_SIGNAL_NO_HOOKS,
1035 G_STRUCT_OFFSET (GtkWidgetClass, child_notify),
1037 g_cclosure_marshal_VOID__PARAM,
1042 * GtkWidget::mnemonic-activate:
1043 * @widget: the object which received the signal.
1046 widget_signals[MNEMONIC_ACTIVATE] =
1047 g_signal_new (I_("mnemonic-activate"),
1048 G_TYPE_FROM_CLASS (gobject_class),
1050 G_STRUCT_OFFSET (GtkWidgetClass, mnemonic_activate),
1051 _gtk_boolean_handled_accumulator, NULL,
1052 _gtk_marshal_BOOLEAN__BOOLEAN,
1057 * GtkWidget::grab-focus:
1058 * @widget: the object which received the signal.
1060 widget_signals[GRAB_FOCUS] =
1061 g_signal_new (I_("grab-focus"),
1062 G_TYPE_FROM_CLASS (gobject_class),
1063 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
1064 G_STRUCT_OFFSET (GtkWidgetClass, grab_focus),
1066 _gtk_marshal_VOID__VOID,
1071 * @widget: the object which received the signal.
1074 * Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
1076 widget_signals[FOCUS] =
1077 g_signal_new (I_("focus"),
1078 G_TYPE_FROM_CLASS (object_class),
1080 G_STRUCT_OFFSET (GtkWidgetClass, focus),
1081 _gtk_boolean_handled_accumulator, NULL,
1082 _gtk_marshal_BOOLEAN__ENUM,
1084 GTK_TYPE_DIRECTION_TYPE);
1087 * GtkWidget::move-focus:
1088 * @widget: the object which received the signal.
1091 widget_signals[MOVE_FOCUS] =
1092 g_signal_new_class_handler (I_("move-focus"),
1093 G_TYPE_FROM_CLASS (object_class),
1094 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
1095 G_CALLBACK (gtk_widget_real_move_focus),
1097 _gtk_marshal_VOID__ENUM,
1100 GTK_TYPE_DIRECTION_TYPE);
1103 * @widget: the object which received the signal.
1104 * @event: the #GdkEvent which triggered this signal
1106 * The GTK+ main loop will emit three signals for each GDK event delivered
1107 * to a widget: one generic ::event signal, another, more specific,
1108 * signal that matches the type of event delivered (e.g.
1109 * #GtkWidget::key-press-event) and finally a generic
1110 * #GtkWidget::event-after signal.
1112 * Returns: %TRUE to stop other handlers from being invoked for the event
1113 * and to cancel the emission of the second specific ::event signal.
1114 * %FALSE to propagate the event further and to allow the emission of
1115 * the second signal. The ::event-after signal is emitted regardless of
1118 widget_signals[EVENT] =
1119 g_signal_new (I_("event"),
1120 G_TYPE_FROM_CLASS (gobject_class),
1122 G_STRUCT_OFFSET (GtkWidgetClass, event),
1123 _gtk_boolean_handled_accumulator, NULL,
1124 _gtk_marshal_BOOLEAN__BOXED,
1126 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1129 * GtkWidget::event-after:
1130 * @widget: the object which received the signal.
1131 * @event: the #GdkEvent which triggered this signal
1133 * After the emission of the #GtkWidget::event signal and (optionally)
1134 * the second more specific signal, ::event-after will be emitted
1135 * regardless of the previous two signals handlers return values.
1138 widget_signals[EVENT_AFTER] =
1139 g_signal_new (I_("event-after"),
1140 G_TYPE_FROM_CLASS (gobject_class),
1144 _gtk_marshal_VOID__BOXED,
1146 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1149 * GtkWidget::button-press-event:
1150 * @widget: the object which received the signal.
1151 * @event: the #GdkEventButton which triggered this signal
1153 * The ::button-press-event signal will be emitted when a button
1154 * (typically from a mouse) is pressed.
1156 * To receive this signal, the #GdkWindow associated to the
1157 * widget needs to enable the #GDK_BUTTON_PRESS_MASK mask.
1159 * This signal will be sent to the grab widget if there is one.
1161 * Returns: %TRUE to stop other handlers from being invoked for the event.
1162 * %FALSE to propagate the event further.
1164 widget_signals[BUTTON_PRESS_EVENT] =
1165 g_signal_new (I_("button-press-event"),
1166 G_TYPE_FROM_CLASS (gobject_class),
1168 G_STRUCT_OFFSET (GtkWidgetClass, button_press_event),
1169 _gtk_boolean_handled_accumulator, NULL,
1170 _gtk_marshal_BOOLEAN__BOXED,
1172 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1175 * GtkWidget::button-release-event:
1176 * @widget: the object which received the signal.
1177 * @event: the #GdkEventButton which triggered this signal
1179 * The ::button-release-event signal will be emitted when a button
1180 * (typically from a mouse) is released.
1182 * To receive this signal, the #GdkWindow associated to the
1183 * widget needs to enable the #GDK_BUTTON_RELEASE_MASK mask.
1185 * This signal will be sent to the grab widget if there is one.
1187 * Returns: %TRUE to stop other handlers from being invoked for the event.
1188 * %FALSE to propagate the event further.
1190 widget_signals[BUTTON_RELEASE_EVENT] =
1191 g_signal_new (I_("button-release-event"),
1192 G_TYPE_FROM_CLASS (gobject_class),
1194 G_STRUCT_OFFSET (GtkWidgetClass, button_release_event),
1195 _gtk_boolean_handled_accumulator, NULL,
1196 _gtk_marshal_BOOLEAN__BOXED,
1198 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1201 * GtkWidget::scroll-event:
1202 * @widget: the object which received the signal.
1203 * @event: the #GdkEventScroll which triggered this signal
1205 * The ::scroll-event signal is emitted when a button in the 4 to 7
1206 * range is pressed. Wheel mice are usually configured to generate
1207 * button press events for buttons 4 and 5 when the wheel is turned.
1209 * To receive this signal, the #GdkWindow associated to the widget needs
1210 * to enable the #GDK_BUTTON_PRESS_MASK mask.
1212 * This signal will be sent to the grab widget if there is one.
1214 * Returns: %TRUE to stop other handlers from being invoked for the event.
1215 * %FALSE to propagate the event further.
1217 widget_signals[SCROLL_EVENT] =
1218 g_signal_new (I_("scroll-event"),
1219 G_TYPE_FROM_CLASS (gobject_class),
1221 G_STRUCT_OFFSET (GtkWidgetClass, scroll_event),
1222 _gtk_boolean_handled_accumulator, NULL,
1223 _gtk_marshal_BOOLEAN__BOXED,
1225 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1227 * GtkWidget::motion-notify-event:
1228 * @widget: the object which received the signal.
1229 * @event: the #GdkEventMotion which triggered this signal
1231 * The ::motion-notify-event signal is emitted when the pointer moves
1232 * over the widget's #GdkWindow.
1234 * To receive this signal, the #GdkWindow associated to the widget
1235 * needs to enable the #GDK_POINTER_MOTION_MASK mask.
1237 * This signal will be sent to the grab widget if there is one.
1239 * Returns: %TRUE to stop other handlers from being invoked for the event.
1240 * %FALSE to propagate the event further.
1242 widget_signals[MOTION_NOTIFY_EVENT] =
1243 g_signal_new (I_("motion-notify-event"),
1244 G_TYPE_FROM_CLASS (gobject_class),
1246 G_STRUCT_OFFSET (GtkWidgetClass, motion_notify_event),
1247 _gtk_boolean_handled_accumulator, NULL,
1248 _gtk_marshal_BOOLEAN__BOXED,
1250 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1253 * GtkWidget::composited-changed:
1254 * @widget: the object on which the signal is emitted
1256 * The ::composited-changed signal is emitted when the composited
1257 * status of @widget<!-- -->s screen changes.
1258 * See gdk_screen_is_composited().
1260 widget_signals[COMPOSITED_CHANGED] =
1261 g_signal_new (I_("composited-changed"),
1262 G_TYPE_FROM_CLASS (gobject_class),
1263 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
1264 G_STRUCT_OFFSET (GtkWidgetClass, composited_changed),
1266 _gtk_marshal_VOID__VOID,
1270 * GtkWidget::keynav-failed:
1271 * @widget: the object which received the signal
1272 * @direction: the direction of movement
1274 * Gets emitted if keyboard navigation fails.
1275 * See gtk_widget_keynav_failed() for details.
1277 * Returns: %TRUE if stopping keyboard navigation is fine, %FALSE
1278 * if the emitting widget should try to handle the keyboard
1279 * navigation attempt in its parent container(s).
1283 widget_signals[KEYNAV_FAILED] =
1284 g_signal_new_class_handler (I_("keynav-failed"),
1285 G_TYPE_FROM_CLASS (gobject_class),
1287 G_CALLBACK (gtk_widget_real_keynav_failed),
1288 _gtk_boolean_handled_accumulator, NULL,
1289 _gtk_marshal_BOOLEAN__ENUM,
1291 GTK_TYPE_DIRECTION_TYPE);
1294 * GtkWidget::delete-event:
1295 * @widget: the object which received the signal
1296 * @event: the event which triggered this signal
1298 * The ::delete-event signal is emitted if a user requests that
1299 * a toplevel window is closed. The default handler for this signal
1300 * destroys the window. Connecting gtk_widget_hide_on_delete() to
1301 * this signal will cause the window to be hidden instead, so that
1302 * it can later be shown again without reconstructing it.
1304 * Returns: %TRUE to stop other handlers from being invoked for the event.
1305 * %FALSE to propagate the event further.
1307 widget_signals[DELETE_EVENT] =
1308 g_signal_new (I_("delete-event"),
1309 G_TYPE_FROM_CLASS (gobject_class),
1311 G_STRUCT_OFFSET (GtkWidgetClass, delete_event),
1312 _gtk_boolean_handled_accumulator, NULL,
1313 _gtk_marshal_BOOLEAN__BOXED,
1315 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1318 * GtkWidget::destroy-event:
1319 * @widget: the object which received the signal.
1320 * @event: the event which triggered this signal
1322 * The ::destroy-event signal is emitted when a #GdkWindow is destroyed.
1323 * You rarely get this signal, because most widgets disconnect themselves
1324 * from their window before they destroy it, so no widget owns the
1325 * window at destroy time.
1327 * To receive this signal, the #GdkWindow associated to the widget needs
1328 * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
1329 * automatically for all new windows.
1331 * Returns: %TRUE to stop other handlers from being invoked for the event.
1332 * %FALSE to propagate the event further.
1334 widget_signals[DESTROY_EVENT] =
1335 g_signal_new (I_("destroy-event"),
1336 G_TYPE_FROM_CLASS (gobject_class),
1338 G_STRUCT_OFFSET (GtkWidgetClass, destroy_event),
1339 _gtk_boolean_handled_accumulator, NULL,
1340 _gtk_marshal_BOOLEAN__BOXED,
1342 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1345 * GtkWidget::expose-event:
1346 * @widget: the object which received the signal.
1347 * @event: the #GdkEventExpose which triggered this signal
1349 * The ::expose-event signal is emitted when an area of a previously
1350 * obscured #GdkWindow is made visible and needs to be redrawn.
1351 * #GTK_NO_WINDOW widgets will get a synthesized event from their parent
1354 * To receive this signal, the #GdkWindow associated to the widget needs
1355 * to enable the #GDK_EXPOSURE_MASK mask.
1357 * Returns: %TRUE to stop other handlers from being invoked for the event.
1358 * %FALSE to propagate the event further.
1360 widget_signals[EXPOSE_EVENT] =
1361 g_signal_new (I_("expose-event"),
1362 G_TYPE_FROM_CLASS (gobject_class),
1364 G_STRUCT_OFFSET (GtkWidgetClass, expose_event),
1365 _gtk_boolean_handled_accumulator, NULL,
1366 _gtk_marshal_BOOLEAN__BOXED,
1368 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1371 * GtkWidget::key-press-event:
1372 * @widget: the object which received the signal
1373 * @event: the #GdkEventKey which triggered this signal
1375 * The ::key-press-event signal is emitted when a key is pressed.
1377 * To receive this signal, the #GdkWindow associated to the widget needs
1378 * to enable the #GDK_KEY_PRESS_MASK mask.
1380 * This signal will be sent to the grab widget if there is one.
1382 * Returns: %TRUE to stop other handlers from being invoked for the event.
1383 * %FALSE to propagate the event further.
1385 widget_signals[KEY_PRESS_EVENT] =
1386 g_signal_new (I_("key-press-event"),
1387 G_TYPE_FROM_CLASS (gobject_class),
1389 G_STRUCT_OFFSET (GtkWidgetClass, key_press_event),
1390 _gtk_boolean_handled_accumulator, NULL,
1391 _gtk_marshal_BOOLEAN__BOXED,
1393 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1396 * GtkWidget::key-release-event:
1397 * @widget: the object which received the signal
1398 * @event: the #GdkEventKey which triggered this signal
1400 * The ::key-release-event signal is emitted when a key is pressed.
1402 * To receive this signal, the #GdkWindow associated to the widget needs
1403 * to enable the #GDK_KEY_RELEASE_MASK mask.
1405 * This signal will be sent to the grab widget if there is one.
1407 * Returns: %TRUE to stop other handlers from being invoked for the event.
1408 * %FALSE to propagate the event further.
1410 widget_signals[KEY_RELEASE_EVENT] =
1411 g_signal_new (I_("key-release-event"),
1412 G_TYPE_FROM_CLASS (gobject_class),
1414 G_STRUCT_OFFSET (GtkWidgetClass, key_release_event),
1415 _gtk_boolean_handled_accumulator, NULL,
1416 _gtk_marshal_BOOLEAN__BOXED,
1418 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1421 * GtkWidget::enter-notify-event:
1422 * @widget: the object which received the signal
1423 * @event: the #GdkEventCrossing which triggered this signal
1425 * The ::enter-notify-event will be emitted when the pointer enters
1426 * the @widget's window.
1428 * To receive this signal, the #GdkWindow associated to the widget needs
1429 * to enable the #GDK_ENTER_NOTIFY_MASK mask.
1431 * This signal will be sent to the grab widget if there is one.
1433 * Returns: %TRUE to stop other handlers from being invoked for the event.
1434 * %FALSE to propagate the event further.
1436 widget_signals[ENTER_NOTIFY_EVENT] =
1437 g_signal_new (I_("enter-notify-event"),
1438 G_TYPE_FROM_CLASS (gobject_class),
1440 G_STRUCT_OFFSET (GtkWidgetClass, enter_notify_event),
1441 _gtk_boolean_handled_accumulator, NULL,
1442 _gtk_marshal_BOOLEAN__BOXED,
1444 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1447 * GtkWidget::leave-notify-event:
1448 * @widget: the object which received the signal
1449 * @event: the #GdkEventCrossing which triggered this signal
1451 * The ::leave-notify-event will be emitted when the pointer leaves
1452 * the @widget's window.
1454 * To receive this signal, the #GdkWindow associated to the widget needs
1455 * to enable the #GDK_LEAVE_NOTIFY_MASK mask.
1457 * This signal will be sent to the grab widget if there is one.
1459 * Returns: %TRUE to stop other handlers from being invoked for the event.
1460 * %FALSE to propagate the event further.
1462 widget_signals[LEAVE_NOTIFY_EVENT] =
1463 g_signal_new (I_("leave-notify-event"),
1464 G_TYPE_FROM_CLASS (gobject_class),
1466 G_STRUCT_OFFSET (GtkWidgetClass, leave_notify_event),
1467 _gtk_boolean_handled_accumulator, NULL,
1468 _gtk_marshal_BOOLEAN__BOXED,
1470 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1473 * GtkWidget::configure-event
1474 * @widget: the object which received the signal
1475 * @event: the #GdkEventConfigure which triggered this signal
1477 * The ::configure-event signal will be emitted when the size, position or
1478 * stacking of the @widget's window has changed.
1480 * To receive this signal, the #GdkWindow associated to the widget needs
1481 * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
1482 * automatically for all new windows.
1484 * Returns: %TRUE to stop other handlers from being invoked for the event.
1485 * %FALSE to propagate the event further.
1487 widget_signals[CONFIGURE_EVENT] =
1488 g_signal_new (I_("configure-event"),
1489 G_TYPE_FROM_CLASS (gobject_class),
1491 G_STRUCT_OFFSET (GtkWidgetClass, configure_event),
1492 _gtk_boolean_handled_accumulator, NULL,
1493 _gtk_marshal_BOOLEAN__BOXED,
1495 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1498 * GtkWidget::focus-in-event
1499 * @widget: the object which received the signal
1500 * @event: the #GdkEventFocus which triggered this signal
1502 * The ::focus-in-event signal will be emitted when the keyboard focus
1503 * enters the @widget's window.
1505 * To receive this signal, the #GdkWindow associated to the widget needs
1506 * to enable the #GDK_FOCUS_CHANGE_MASK mask.
1508 * Returns: %TRUE to stop other handlers from being invoked for the event.
1509 * %FALSE to propagate the event further.
1511 widget_signals[FOCUS_IN_EVENT] =
1512 g_signal_new (I_("focus-in-event"),
1513 G_TYPE_FROM_CLASS (gobject_class),
1515 G_STRUCT_OFFSET (GtkWidgetClass, focus_in_event),
1516 _gtk_boolean_handled_accumulator, NULL,
1517 _gtk_marshal_BOOLEAN__BOXED,
1519 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1522 * GtkWidget::focus-out-event
1523 * @widget: the object which received the signal
1524 * @event: the #GdkEventFocus which triggered this signal
1526 * The ::focus-out-event signal will be emitted when the keyboard focus
1527 * leaves the @widget's window.
1529 * To receive this signal, the #GdkWindow associated to the widget needs
1530 * to enable the #GDK_FOCUS_CHANGE_MASK mask.
1532 * Returns: %TRUE to stop other handlers from being invoked for the event.
1533 * %FALSE to propagate the event further.
1535 widget_signals[FOCUS_OUT_EVENT] =
1536 g_signal_new (I_("focus-out-event"),
1537 G_TYPE_FROM_CLASS (gobject_class),
1539 G_STRUCT_OFFSET (GtkWidgetClass, focus_out_event),
1540 _gtk_boolean_handled_accumulator, NULL,
1541 _gtk_marshal_BOOLEAN__BOXED,
1543 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1546 * GtkWidget::map-event
1547 * @widget: the object which received the signal
1548 * @event: the #GdkEventAny which triggered this signal
1550 * The ::map-event signal will be emitted when the @widget's window is
1551 * mapped. A window is mapped when it becomes visible on the screen.
1553 * To receive this signal, the #GdkWindow associated to the widget needs
1554 * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
1555 * automatically for all new windows.
1557 * Returns: %TRUE to stop other handlers from being invoked for the event.
1558 * %FALSE to propagate the event further.
1560 widget_signals[MAP_EVENT] =
1561 g_signal_new (I_("map-event"),
1562 G_TYPE_FROM_CLASS (gobject_class),
1564 G_STRUCT_OFFSET (GtkWidgetClass, map_event),
1565 _gtk_boolean_handled_accumulator, NULL,
1566 _gtk_marshal_BOOLEAN__BOXED,
1568 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1571 * GtkWidget::unmap-event
1572 * @widget: the object which received the signal
1573 * @event: the #GdkEventAny which triggered this signal
1575 * The ::unmap-event signal will be emitted when the @widget's window is
1576 * unmapped. A window is unmapped when it becomes invisible on the screen.
1578 * To receive this signal, the #GdkWindow associated to the widget needs
1579 * to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
1580 * automatically for all new windows.
1582 * Returns: %TRUE to stop other handlers from being invoked for the event.
1583 * %FALSE to propagate the event further.
1585 widget_signals[UNMAP_EVENT] =
1586 g_signal_new (I_("unmap-event"),
1587 G_TYPE_FROM_CLASS (gobject_class),
1589 G_STRUCT_OFFSET (GtkWidgetClass, unmap_event),
1590 _gtk_boolean_handled_accumulator, NULL,
1591 _gtk_marshal_BOOLEAN__BOXED,
1593 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1596 * GtkWidget::property-notify-event
1597 * @widget: the object which received the signal
1598 * @event: the #GdkEventProperty which triggered this signal
1600 * The ::property-notify-event signal will be emitted when a property on
1601 * the @widget's window has been changed or deleted.
1603 * To receive this signal, the #GdkWindow associated to the widget needs
1604 * to enable the #GDK_PROPERTY_CHANGE_MASK mask.
1606 * Returns: %TRUE to stop other handlers from being invoked for the event.
1607 * %FALSE to propagate the event further.
1609 widget_signals[PROPERTY_NOTIFY_EVENT] =
1610 g_signal_new (I_("property-notify-event"),
1611 G_TYPE_FROM_CLASS (gobject_class),
1613 G_STRUCT_OFFSET (GtkWidgetClass, property_notify_event),
1614 _gtk_boolean_handled_accumulator, NULL,
1615 _gtk_marshal_BOOLEAN__BOXED,
1617 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1620 * GtkWidget::selection-clear-event
1621 * @widget: the object which received the signal
1622 * @event: the #GdkEventSelection which triggered this signal
1624 * The ::selection-clear-event signal will be emitted when the
1625 * the @widget's window has lost ownership of a selection.
1627 * Returns: %TRUE to stop other handlers from being invoked for the event.
1628 * %FALSE to propagate the event further.
1630 widget_signals[SELECTION_CLEAR_EVENT] =
1631 g_signal_new (I_("selection-clear-event"),
1632 G_TYPE_FROM_CLASS (gobject_class),
1634 G_STRUCT_OFFSET (GtkWidgetClass, selection_clear_event),
1635 _gtk_boolean_handled_accumulator, NULL,
1636 _gtk_marshal_BOOLEAN__BOXED,
1638 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1641 * GtkWidget::selection-request-event
1642 * @widget: the object which received the signal
1643 * @event: the #GdkEventSelection which triggered this signal
1645 * The ::selection-request-event signal will be emitted when
1646 * another client requests ownership of the selection owned by
1647 * the @widget's window.
1649 * Returns: %TRUE to stop other handlers from being invoked for the event.
1650 * %FALSE to propagate the event further.
1652 widget_signals[SELECTION_REQUEST_EVENT] =
1653 g_signal_new (I_("selection-request-event"),
1654 G_TYPE_FROM_CLASS (gobject_class),
1656 G_STRUCT_OFFSET (GtkWidgetClass, selection_request_event),
1657 _gtk_boolean_handled_accumulator, NULL,
1658 _gtk_marshal_BOOLEAN__BOXED,
1660 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1663 * GtkWidget::selection-notify-event:
1664 * @widget: the object which received the signal.
1667 * Returns: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
1669 widget_signals[SELECTION_NOTIFY_EVENT] =
1670 g_signal_new (I_("selection-notify-event"),
1671 G_TYPE_FROM_CLASS (gobject_class),
1673 G_STRUCT_OFFSET (GtkWidgetClass, selection_notify_event),
1674 _gtk_boolean_handled_accumulator, NULL,
1675 _gtk_marshal_BOOLEAN__BOXED,
1677 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1680 * GtkWidget::selection-received:
1681 * @widget: the object which received the signal.
1685 widget_signals[SELECTION_RECEIVED] =
1686 g_signal_new (I_("selection-received"),
1687 G_TYPE_FROM_CLASS (gobject_class),
1689 G_STRUCT_OFFSET (GtkWidgetClass, selection_received),
1691 _gtk_marshal_VOID__BOXED_UINT,
1693 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
1697 * GtkWidget::selection-get:
1698 * @widget: the object which received the signal.
1703 widget_signals[SELECTION_GET] =
1704 g_signal_new (I_("selection-get"),
1705 G_TYPE_FROM_CLASS (gobject_class),
1707 G_STRUCT_OFFSET (GtkWidgetClass, selection_get),
1709 _gtk_marshal_VOID__BOXED_UINT_UINT,
1711 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
1716 * GtkWidget::proximity-in-event
1717 * @widget: the object which received the signal
1718 * @event: the #GdkEventProximity which triggered this signal
1720 * To receive this signal the #GdkWindow associated to the widget needs
1721 * to enable the #GDK_PROXIMITY_IN_MASK mask.
1723 * This signal will be sent to the grab widget if there is one.
1725 * Returns: %TRUE to stop other handlers from being invoked for the event.
1726 * %FALSE to propagate the event further.
1728 widget_signals[PROXIMITY_IN_EVENT] =
1729 g_signal_new (I_("proximity-in-event"),
1730 G_TYPE_FROM_CLASS (gobject_class),
1732 G_STRUCT_OFFSET (GtkWidgetClass, proximity_in_event),
1733 _gtk_boolean_handled_accumulator, NULL,
1734 _gtk_marshal_BOOLEAN__BOXED,
1736 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1739 * GtkWidget::proximity-out-event
1740 * @widget: the object which received the signal
1741 * @event: the #GdkEventProximity which triggered this signal
1743 * To receive this signal the #GdkWindow associated to the widget needs
1744 * to enable the #GDK_PROXIMITY_OUT_MASK mask.
1746 * This signal will be sent to the grab widget if there is one.
1748 * Returns: %TRUE to stop other handlers from being invoked for the event.
1749 * %FALSE to propagate the event further.
1751 widget_signals[PROXIMITY_OUT_EVENT] =
1752 g_signal_new (I_("proximity-out-event"),
1753 G_TYPE_FROM_CLASS (gobject_class),
1755 G_STRUCT_OFFSET (GtkWidgetClass, proximity_out_event),
1756 _gtk_boolean_handled_accumulator, NULL,
1757 _gtk_marshal_BOOLEAN__BOXED,
1759 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1762 * GtkWidget::drag-leave:
1763 * @widget: the object which received the signal.
1764 * @drag_context: the drag context
1765 * @time: the timestamp of the motion event
1767 * The ::drag-leave signal is emitted on the drop site when the cursor
1768 * leaves the widget. A typical reason to connect to this signal is to
1769 * undo things done in #GtkWidget::drag-motion, e.g. undo highlighting
1770 * with gtk_drag_unhighlight()
1772 widget_signals[DRAG_LEAVE] =
1773 g_signal_new (I_("drag-leave"),
1774 G_TYPE_FROM_CLASS (gobject_class),
1776 G_STRUCT_OFFSET (GtkWidgetClass, drag_leave),
1778 _gtk_marshal_VOID__OBJECT_UINT,
1780 GDK_TYPE_DRAG_CONTEXT,
1784 * GtkWidget::drag-begin:
1785 * @widget: the object which received the signal
1786 * @drag_context: the drag context
1788 * The ::drag-begin signal is emitted on the drag source when a drag is
1789 * started. A typical reason to connect to this signal is to set up a
1790 * custom drag icon with gtk_drag_source_set_icon().
1792 * Note that some widgets set up a drag icon in the default handler of
1793 * this signal, so you may have to use g_signal_connect_after() to
1794 * override what the default handler did.
1796 widget_signals[DRAG_BEGIN] =
1797 g_signal_new (I_("drag-begin"),
1798 G_TYPE_FROM_CLASS (gobject_class),
1800 G_STRUCT_OFFSET (GtkWidgetClass, drag_begin),
1802 _gtk_marshal_VOID__OBJECT,
1804 GDK_TYPE_DRAG_CONTEXT);
1807 * GtkWidget::drag-end:
1808 * @widget: the object which received the signal
1809 * @drag_context: the drag context
1811 * The ::drag-end signal is emitted on the drag source when a drag is
1812 * finished. A typical reason to connect to this signal is to undo
1813 * things done in #GtkWidget::drag-begin.
1815 widget_signals[DRAG_END] =
1816 g_signal_new (I_("drag-end"),
1817 G_TYPE_FROM_CLASS (gobject_class),
1819 G_STRUCT_OFFSET (GtkWidgetClass, drag_end),
1821 _gtk_marshal_VOID__OBJECT,
1823 GDK_TYPE_DRAG_CONTEXT);
1826 * GtkWidget::drag-data-delete:
1827 * @widget: the object which received the signal
1828 * @drag_context: the drag context
1830 * The ::drag-data-delete signal is emitted on the drag source when a drag
1831 * with the action %GDK_ACTION_MOVE is successfully completed. The signal
1832 * handler is responsible for deleting the data that has been dropped. What
1833 * "delete" means depends on the context of the drag operation.
1835 widget_signals[DRAG_DATA_DELETE] =
1836 g_signal_new (I_("drag-data-delete"),
1837 G_TYPE_FROM_CLASS (gobject_class),
1839 G_STRUCT_OFFSET (GtkWidgetClass, drag_data_delete),
1841 _gtk_marshal_VOID__OBJECT,
1843 GDK_TYPE_DRAG_CONTEXT);
1846 * GtkWidget::drag-failed:
1847 * @widget: the object which received the signal
1848 * @drag_context: the drag context
1849 * @result: the result of the drag operation
1851 * The ::drag-failed signal is emitted on the drag source when a drag has
1852 * failed. The signal handler may hook custom code to handle a failed DND
1853 * operation based on the type of error, it returns %TRUE is the failure has
1854 * been already handled (not showing the default "drag operation failed"
1855 * animation), otherwise it returns %FALSE.
1857 * Return value: %TRUE if the failed drag operation has been already handled.
1861 widget_signals[DRAG_FAILED] =
1862 g_signal_new (I_("drag-failed"),
1863 G_TYPE_FROM_CLASS (gobject_class),
1865 0, _gtk_boolean_handled_accumulator, NULL,
1866 _gtk_marshal_BOOLEAN__OBJECT_ENUM,
1868 GDK_TYPE_DRAG_CONTEXT,
1869 GTK_TYPE_DRAG_RESULT);
1872 * GtkWidget::drag-motion:
1873 * @widget: the object which received the signal
1874 * @drag_context: the drag context
1875 * @x: the x coordinate of the current cursor position
1876 * @y: the y coordinate of the current cursor position
1877 * @time: the timestamp of the motion event
1878 * @returns: whether the cursor position is in a drop zone
1880 * The drag-motion signal is emitted on the drop site when the user
1881 * moves the cursor over the widget during a drag. The signal handler
1882 * must determine whether the cursor position is in a drop zone or not.
1883 * If it is not in a drop zone, it returns %FALSE and no further processing
1884 * is necessary. Otherwise, the handler returns %TRUE. In this case, the
1885 * handler is responsible for providing the necessary information for
1886 * displaying feedback to the user, by calling gdk_drag_status().
1888 * If the decision whether the drop will be accepted or rejected can't be
1889 * made based solely on the cursor position and the type of the data, the
1890 * handler may inspect the dragged data by calling gtk_drag_get_data() and
1891 * defer the gdk_drag_status() call to the #GtkWidget::drag-data-received
1892 * handler. Note that you cannot not pass #GTK_DEST_DEFAULT_DROP,
1893 * #GTK_DEST_DEFAULT_MOTION or #GTK_DEST_DEFAULT_ALL to gtk_drag_dest_set()
1894 * when using the drag-motion signal that way.
1896 * Also note that there is no drag-enter signal. The drag receiver has to
1897 * keep track of whether he has received any drag-motion signals since the
1898 * last #GtkWidget::drag-leave and if not, treat the drag-motion signal as
1899 * an "enter" signal. Upon an "enter", the handler will typically highlight
1900 * the drop site with gtk_drag_highlight().
1903 * drag_motion (GtkWidget *widget,
1904 * GdkDragContext *context,
1911 * PrivateData *private_data = GET_PRIVATE_DATA (widget);
1913 * if (!private_data->drag_highlight)
1915 * private_data->drag_highlight = 1;
1916 * gtk_drag_highlight (widget);
1919 * target = gtk_drag_dest_find_target (widget, context, NULL);
1920 * if (target == GDK_NONE)
1921 * gdk_drag_status (context, 0, time);
1924 * private_data->pending_status = context->suggested_action;
1925 * gtk_drag_get_data (widget, context, target, time);
1932 * drag_data_received (GtkWidget *widget,
1933 * GdkDragContext *context,
1936 * GtkSelectionData *selection_data,
1940 * PrivateData *private_data = GET_PRIVATE_DATA (widget);
1942 * if (private_data->suggested_action)
1944 * private_data->suggested_action = 0;
1946 * /* We are getting this data due to a request in drag_motion,
1947 * * rather than due to a request in drag_drop, so we are just
1948 * * supposed to call gdk_drag_status (), not actually paste in
1951 * str = gtk_selection_data_get_text (selection_data);
1952 * if (!data_is_acceptable (str))
1953 * gdk_drag_status (context, 0, time);
1955 * gdk_drag_status (context, private_data->suggested_action, time);
1959 * /* accept the drop */
1964 widget_signals[DRAG_MOTION] =
1965 g_signal_new (I_("drag-motion"),
1966 G_TYPE_FROM_CLASS (gobject_class),
1968 G_STRUCT_OFFSET (GtkWidgetClass, drag_motion),
1969 _gtk_boolean_handled_accumulator, NULL,
1970 _gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
1972 GDK_TYPE_DRAG_CONTEXT,
1978 * GtkWidget::drag-drop:
1979 * @widget: the object which received the signal
1980 * @drag_context: the drag context
1981 * @x: the x coordinate of the current cursor position
1982 * @y: the y coordinate of the current cursor position
1983 * @time: the timestamp of the motion event
1984 * @returns: whether the cursor position is in a drop zone
1986 * The ::drag-drop signal is emitted on the drop site when the user drops
1987 * the data onto the widget. The signal handler must determine whether
1988 * the cursor position is in a drop zone or not. If it is not in a drop
1989 * zone, it returns %FALSE and no further processing is necessary.
1990 * Otherwise, the handler returns %TRUE. In this case, the handler must
1991 * ensure that gtk_drag_finish() is called to let the source know that
1992 * the drop is done. The call to gtk_drag_finish() can be done either
1993 * directly or in a #GtkWidget::drag-data-received handler which gets
1994 * triggered by calling gtk_drag_get_data() to receive the data for one
1995 * or more of the supported targets.
1997 widget_signals[DRAG_DROP] =
1998 g_signal_new (I_("drag-drop"),
1999 G_TYPE_FROM_CLASS (gobject_class),
2001 G_STRUCT_OFFSET (GtkWidgetClass, drag_drop),
2002 _gtk_boolean_handled_accumulator, NULL,
2003 _gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
2005 GDK_TYPE_DRAG_CONTEXT,
2011 * GtkWidget::drag-data-get:
2012 * @widget: the object which received the signal
2013 * @drag_context: the drag context
2014 * @data: the #GtkSelectionData to be filled with the dragged data
2015 * @info: the info that has been registered with the target in the
2017 * @time: the timestamp at which the data was requested
2019 * The ::drag-data-get signal is emitted on the drag source when the drop
2020 * site requests the data which is dragged. It is the responsibility of
2021 * the signal handler to fill @data with the data in the format which
2022 * is indicated by @info. See gtk_selection_data_set() and
2023 * gtk_selection_data_set_text().
2025 widget_signals[DRAG_DATA_GET] =
2026 g_signal_new (I_("drag-data-get"),
2027 G_TYPE_FROM_CLASS (gobject_class),
2029 G_STRUCT_OFFSET (GtkWidgetClass, drag_data_get),
2031 _gtk_marshal_VOID__OBJECT_BOXED_UINT_UINT,
2033 GDK_TYPE_DRAG_CONTEXT,
2034 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
2039 * GtkWidget::drag-data-received:
2040 * @widget: the object which received the signal
2041 * @drag_context: the drag context
2042 * @x: where the drop happened
2043 * @y: where the drop happened
2044 * @data: the received data
2045 * @info: the info that has been registered with the target in the
2047 * @time: the timestamp at which the data was received
2049 * The ::drag-data-received signal is emitted on the drop site when the
2050 * dragged data has been received. If the data was received in order to
2051 * determine whether the drop will be accepted, the handler is expected
2052 * to call gdk_drag_status() and <emphasis>not</emphasis> finish the drag.
2053 * If the data was received in response to a #GtkWidget::drag-drop signal
2054 * (and this is the last target to be received), the handler for this
2055 * signal is expected to process the received data and then call
2056 * gtk_drag_finish(), setting the @success parameter depending on whether
2057 * the data was processed successfully.
2059 * The handler may inspect and modify @drag_context->action before calling
2060 * gtk_drag_finish(), e.g. to implement %GDK_ACTION_ASK as shown in the
2061 * following example:
2064 * drag_data_received (GtkWidget *widget,
2065 * GdkDragContext *drag_context,
2068 * GtkSelectionData *data,
2072 * if ((data->length >= 0) && (data->format == 8))
2074 * if (drag_context->action == GDK_ACTION_ASK)
2076 * GtkWidget *dialog;
2079 * dialog = gtk_message_dialog_new (NULL,
2080 * GTK_DIALOG_MODAL |
2081 * GTK_DIALOG_DESTROY_WITH_PARENT,
2083 * GTK_BUTTONS_YES_NO,
2084 * "Move the data ?\n");
2085 * response = gtk_dialog_run (GTK_DIALOG (dialog));
2086 * gtk_widget_destroy (dialog);
2088 * if (response == GTK_RESPONSE_YES)
2089 * drag_context->action = GDK_ACTION_MOVE;
2091 * drag_context->action = GDK_ACTION_COPY;
2094 * gtk_drag_finish (drag_context, TRUE, FALSE, time);
2098 * gtk_drag_finish (drag_context, FALSE, FALSE, time);
2102 widget_signals[DRAG_DATA_RECEIVED] =
2103 g_signal_new (I_("drag-data-received"),
2104 G_TYPE_FROM_CLASS (gobject_class),
2106 G_STRUCT_OFFSET (GtkWidgetClass, drag_data_received),
2108 _gtk_marshal_VOID__OBJECT_INT_INT_BOXED_UINT_UINT,
2110 GDK_TYPE_DRAG_CONTEXT,
2113 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
2118 * GtkWidget::visibility-notify-event:
2119 * @widget: the object which received the signal
2120 * @event: the #GdkEventVisibility which triggered this signal
2122 * The ::visibility-notify-event will be emitted when the @widget's window
2123 * is obscured or unobscured.
2125 * To receive this signal the #GdkWindow associated to the widget needs
2126 * to enable the #GDK_VISIBILITY_NOTIFY_MASK mask.
2128 * Returns: %TRUE to stop other handlers from being invoked for the event.
2129 * %FALSE to propagate the event further.
2131 widget_signals[VISIBILITY_NOTIFY_EVENT] =
2132 g_signal_new (I_("visibility-notify-event"),
2133 G_TYPE_FROM_CLASS (gobject_class),
2135 G_STRUCT_OFFSET (GtkWidgetClass, visibility_notify_event),
2136 _gtk_boolean_handled_accumulator, NULL,
2137 _gtk_marshal_BOOLEAN__BOXED,
2139 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2142 * GtkWidget::client-event:
2143 * @widget: the object which received the signal
2144 * @event: the #GdkEventClient which triggered this signal
2146 * The ::client-event will be emitted when the @widget's window
2147 * receives a message (via a ClientMessage event) from another
2150 * Returns: %TRUE to stop other handlers from being invoked for
2151 * the event. %FALSE to propagate the event further.
2153 widget_signals[CLIENT_EVENT] =
2154 g_signal_new (I_("client-event"),
2155 G_TYPE_FROM_CLASS (gobject_class),
2157 G_STRUCT_OFFSET (GtkWidgetClass, client_event),
2158 _gtk_boolean_handled_accumulator, NULL,
2159 _gtk_marshal_BOOLEAN__BOXED,
2161 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2164 * GtkWidget::no-expose-event:
2165 * @widget: the object which received the signal
2166 * @event: the #GdkEventNoExpose which triggered this signal
2168 * The ::no-expose-event will be emitted when the @widget's window is
2169 * drawn as a copy of another #GdkDrawable (with gdk_draw_drawable() or
2170 * gdk_window_copy_area()) which was completely unobscured. If the source
2171 * window was partially obscured #GdkEventExpose events will be generated
2174 * Returns: %TRUE to stop other handlers from being invoked for the event.
2175 * %FALSE to propagate the event further.
2177 widget_signals[NO_EXPOSE_EVENT] =
2178 g_signal_new (I_("no-expose-event"),
2179 G_TYPE_FROM_CLASS (gobject_class),
2181 G_STRUCT_OFFSET (GtkWidgetClass, no_expose_event),
2182 _gtk_boolean_handled_accumulator, NULL,
2183 _gtk_marshal_BOOLEAN__BOXED,
2185 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2188 * GtkWidget::window-state-event:
2189 * @widget: the object which received the signal
2190 * @event: the #GdkEventWindowState which triggered this signal
2192 * The ::window-state-event will be emitted when the state of the
2193 * toplevel window associated to the @widget changes.
2195 * To receive this signal the #GdkWindow associated to the widget
2196 * needs to enable the #GDK_STRUCTURE_MASK mask. GDK will enable
2197 * this mask automatically for all new windows.
2199 * Returns: %TRUE to stop other handlers from being invoked for the
2200 * event. %FALSE to propagate the event further.
2202 widget_signals[WINDOW_STATE_EVENT] =
2203 g_signal_new (I_("window-state-event"),
2204 G_TYPE_FROM_CLASS (gobject_class),
2206 G_STRUCT_OFFSET (GtkWidgetClass, window_state_event),
2207 _gtk_boolean_handled_accumulator, NULL,
2208 _gtk_marshal_BOOLEAN__BOXED,
2210 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2213 * GtkWidget::damage-event:
2214 * @widget: the object which received the signal
2215 * @event: the #GdkEventExpose event
2217 * Emitted when a redirected window belonging to @widget gets drawn into.
2218 * The region/area members of the event shows what area of the redirected
2219 * drawable was drawn into.
2221 * Returns: %TRUE to stop other handlers from being invoked for the event.
2222 * %FALSE to propagate the event further.
2226 widget_signals[DAMAGE_EVENT] =
2227 g_signal_new (I_("damage-event"),
2228 G_TYPE_FROM_CLASS (gobject_class),
2231 _gtk_boolean_handled_accumulator, NULL,
2232 _gtk_marshal_BOOLEAN__BOXED,
2234 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2236 * GtkWidget::grab-broken-event:
2237 * @widget: the object which received the signal
2238 * @event: the #GdkEventGrabBroken event
2240 * Emitted when a pointer or keyboard grab on a window belonging
2241 * to @widget gets broken.
2243 * On X11, this happens when the grab window becomes unviewable
2244 * (i.e. it or one of its ancestors is unmapped), or if the same
2245 * application grabs the pointer or keyboard again.
2247 * Returns: %TRUE to stop other handlers from being invoked for
2248 * the event. %FALSE to propagate the event further.
2252 widget_signals[GRAB_BROKEN] =
2253 g_signal_new (I_("grab-broken-event"),
2254 G_TYPE_FROM_CLASS (gobject_class),
2256 G_STRUCT_OFFSET (GtkWidgetClass, grab_broken_event),
2257 _gtk_boolean_handled_accumulator, NULL,
2258 _gtk_marshal_BOOLEAN__BOXED,
2260 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
2262 * GtkWidget::query-tooltip:
2263 * @widget: the object which received the signal
2264 * @x: the x coordinate of the cursor position where the request has
2265 * been emitted, relative to @widget->window
2266 * @y: the y coordinate of the cursor position where the request has
2267 * been emitted, relative to @widget->window
2268 * @keyboard_mode: %TRUE if the tooltip was trigged using the keyboard
2269 * @tooltip: a #GtkTooltip
2271 * Emitted when #GtkWidget:has-tooltip is %TRUE and the #GtkSettings:gtk-tooltip-timeout
2272 * has expired with the cursor hovering "above" @widget; or emitted when @widget got
2273 * focus in keyboard mode.
2275 * Using the given coordinates, the signal handler should determine
2276 * whether a tooltip should be shown for @widget. If this is the case
2277 * %TRUE should be returned, %FALSE otherwise. Note that if
2278 * @keyboard_mode is %TRUE, the values of @x and @y are undefined and
2279 * should not be used.
2281 * The signal handler is free to manipulate @tooltip with the therefore
2282 * destined function calls.
2284 * Returns: %TRUE if @tooltip should be shown right now, %FALSE otherwise.
2288 widget_signals[QUERY_TOOLTIP] =
2289 g_signal_new (I_("query-tooltip"),
2290 G_TYPE_FROM_CLASS (gobject_class),
2292 G_STRUCT_OFFSET (GtkWidgetClass, query_tooltip),
2293 _gtk_boolean_handled_accumulator, NULL,
2294 _gtk_marshal_BOOLEAN__INT_INT_BOOLEAN_OBJECT,
2302 * GtkWidget::popup-menu
2303 * @widget: the object which received the signal
2305 * This signal gets emitted whenever a widget should pop up a context
2306 * menu. This usually happens through the standard key binding mechanism;
2307 * by pressing a certain key while a widget is focused, the user can cause
2308 * the widget to pop up a menu. For example, the #GtkEntry widget creates
2309 * a menu with clipboard commands. See <xref linkend="checklist-popup-menu"/>
2310 * for an example of how to use this signal.
2312 * Returns: %TRUE if a menu was activated
2314 widget_signals[POPUP_MENU] =
2315 g_signal_new (I_("popup-menu"),
2316 G_TYPE_FROM_CLASS (gobject_class),
2317 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
2318 G_STRUCT_OFFSET (GtkWidgetClass, popup_menu),
2319 _gtk_boolean_handled_accumulator, NULL,
2320 _gtk_marshal_BOOLEAN__VOID,
2324 * GtkWidget::show-help:
2325 * @widget: the object which received the signal.
2328 widget_signals[SHOW_HELP] =
2329 g_signal_new (I_("show-help"),
2330 G_TYPE_FROM_CLASS (gobject_class),
2331 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
2332 G_STRUCT_OFFSET (GtkWidgetClass, show_help),
2333 _gtk_boolean_handled_accumulator, NULL,
2334 _gtk_marshal_BOOLEAN__ENUM,
2336 GTK_TYPE_WIDGET_HELP_TYPE);
2339 * GtkWidget::accel-closures-changed:
2340 * @widget: the object which received the signal.
2342 widget_signals[ACCEL_CLOSURES_CHANGED] =
2343 g_signal_new (I_("accel-closures-changed"),
2344 G_TYPE_FROM_CLASS (gobject_class),
2348 _gtk_marshal_VOID__VOID,
2352 * GtkWidget::screen-changed:
2353 * @widget: the object on which the signal is emitted
2354 * @previous_screen: (allow-none): the previous screen, or %NULL if the
2355 * widget was not associated with a screen before
2357 * The ::screen-changed signal gets emitted when the
2358 * screen of a widget has changed.
2360 widget_signals[SCREEN_CHANGED] =
2361 g_signal_new (I_("screen-changed"),
2362 G_TYPE_FROM_CLASS (gobject_class),
2364 G_STRUCT_OFFSET (GtkWidgetClass, screen_changed),
2366 _gtk_marshal_VOID__OBJECT,
2371 * GtkWidget::can-activate-accel:
2372 * @widget: the object which received the signal
2373 * @signal_id: the ID of a signal installed on @widget
2375 * Determines whether an accelerator that activates the signal
2376 * identified by @signal_id can currently be activated.
2377 * This signal is present to allow applications and derived
2378 * widgets to override the default #GtkWidget handling
2379 * for determining whether an accelerator can be activated.
2381 * Returns: %TRUE if the signal can be activated.
2383 widget_signals[CAN_ACTIVATE_ACCEL] =
2384 g_signal_new (I_("can-activate-accel"),
2385 G_TYPE_FROM_CLASS (gobject_class),
2387 G_STRUCT_OFFSET (GtkWidgetClass, can_activate_accel),
2388 _gtk_boolean_handled_accumulator, NULL,
2389 _gtk_marshal_BOOLEAN__UINT,
2390 G_TYPE_BOOLEAN, 1, G_TYPE_UINT);
2392 binding_set = gtk_binding_set_by_class (klass);
2393 gtk_binding_entry_add_signal (binding_set, GDK_F10, GDK_SHIFT_MASK,
2395 gtk_binding_entry_add_signal (binding_set, GDK_Menu, 0,
2398 gtk_binding_entry_add_signal (binding_set, GDK_F1, GDK_CONTROL_MASK,
2400 GTK_TYPE_WIDGET_HELP_TYPE,
2401 GTK_WIDGET_HELP_TOOLTIP);
2402 gtk_binding_entry_add_signal (binding_set, GDK_KP_F1, GDK_CONTROL_MASK,
2404 GTK_TYPE_WIDGET_HELP_TYPE,
2405 GTK_WIDGET_HELP_TOOLTIP);
2406 gtk_binding_entry_add_signal (binding_set, GDK_F1, GDK_SHIFT_MASK,
2408 GTK_TYPE_WIDGET_HELP_TYPE,
2409 GTK_WIDGET_HELP_WHATS_THIS);
2410 gtk_binding_entry_add_signal (binding_set, GDK_KP_F1, GDK_SHIFT_MASK,
2412 GTK_TYPE_WIDGET_HELP_TYPE,
2413 GTK_WIDGET_HELP_WHATS_THIS);
2415 gtk_widget_class_install_style_property (klass,
2416 g_param_spec_boolean ("interior-focus",
2417 P_("Interior Focus"),
2418 P_("Whether to draw the focus indicator inside widgets"),
2420 GTK_PARAM_READABLE));
2422 gtk_widget_class_install_style_property (klass,
2423 g_param_spec_int ("focus-line-width",
2424 P_("Focus linewidth"),
2425 P_("Width, in pixels, of the focus indicator line"),
2427 GTK_PARAM_READABLE));
2429 gtk_widget_class_install_style_property (klass,
2430 g_param_spec_string ("focus-line-pattern",
2431 P_("Focus line dash pattern"),
2432 P_("Dash pattern used to draw the focus indicator"),
2434 GTK_PARAM_READABLE));
2435 gtk_widget_class_install_style_property (klass,
2436 g_param_spec_int ("focus-padding",
2437 P_("Focus padding"),
2438 P_("Width, in pixels, between focus indicator and the widget 'box'"),
2440 GTK_PARAM_READABLE));
2441 gtk_widget_class_install_style_property (klass,
2442 g_param_spec_boxed ("cursor-color",
2444 P_("Color with which to draw insertion cursor"),
2446 GTK_PARAM_READABLE));
2447 gtk_widget_class_install_style_property (klass,
2448 g_param_spec_boxed ("secondary-cursor-color",
2449 P_("Secondary cursor color"),
2450 P_("Color with which to draw the secondary insertion cursor when editing mixed right-to-left and left-to-right text"),
2452 GTK_PARAM_READABLE));
2453 gtk_widget_class_install_style_property (klass,
2454 g_param_spec_float ("cursor-aspect-ratio",
2455 P_("Cursor line aspect ratio"),
2456 P_("Aspect ratio with which to draw insertion cursor"),
2458 GTK_PARAM_READABLE));
2461 * GtkWidget:draw-border:
2463 * The "draw-border" style property defines the size of areas outside
2464 * the widget's allocation to draw.
2468 gtk_widget_class_install_style_property (klass,
2469 g_param_spec_boxed ("draw-border",
2471 P_("Size of areas outside the widget's allocation to draw"),
2473 GTK_PARAM_READABLE));
2476 * GtkWidget:link-color:
2478 * The "link-color" style property defines the color of unvisited links.
2482 gtk_widget_class_install_style_property (klass,
2483 g_param_spec_boxed ("link-color",
2484 P_("Unvisited Link Color"),
2485 P_("Color of unvisited links"),
2487 GTK_PARAM_READABLE));
2490 * GtkWidget:visited-link-color:
2492 * The "visited-link-color" style property defines the color of visited links.
2496 gtk_widget_class_install_style_property (klass,
2497 g_param_spec_boxed ("visited-link-color",
2498 P_("Visited Link Color"),
2499 P_("Color of visited links"),
2501 GTK_PARAM_READABLE));
2504 * GtkWidget:wide-separators:
2506 * The "wide-separators" style property defines whether separators have
2507 * configurable width and should be drawn using a box instead of a line.
2511 gtk_widget_class_install_style_property (klass,
2512 g_param_spec_boolean ("wide-separators",
2513 P_("Wide Separators"),
2514 P_("Whether separators have configurable width and should be drawn using a box instead of a line"),
2516 GTK_PARAM_READABLE));
2519 * GtkWidget:separator-width:
2521 * The "separator-width" style property defines the width of separators.
2522 * This property only takes effect if #GtkWidget:wide-separators is %TRUE.
2526 gtk_widget_class_install_style_property (klass,
2527 g_param_spec_int ("separator-width",
2528 P_("Separator Width"),
2529 P_("The width of separators if wide-separators is TRUE"),
2531 GTK_PARAM_READABLE));
2534 * GtkWidget:separator-height:
2536 * The "separator-height" style property defines the height of separators.
2537 * This property only takes effect if #GtkWidget:wide-separators is %TRUE.
2541 gtk_widget_class_install_style_property (klass,
2542 g_param_spec_int ("separator-height",
2543 P_("Separator Height"),
2544 P_("The height of separators if \"wide-separators\" is TRUE"),
2546 GTK_PARAM_READABLE));
2549 * GtkWidget:scroll-arrow-hlength:
2551 * The "scroll-arrow-hlength" style property defines the length of
2552 * horizontal scroll arrows.
2556 gtk_widget_class_install_style_property (klass,
2557 g_param_spec_int ("scroll-arrow-hlength",
2558 P_("Horizontal Scroll Arrow Length"),
2559 P_("The length of horizontal scroll arrows"),
2561 GTK_PARAM_READABLE));
2564 * GtkWidget:scroll-arrow-vlength:
2566 * The "scroll-arrow-vlength" style property defines the length of
2567 * vertical scroll arrows.
2571 gtk_widget_class_install_style_property (klass,
2572 g_param_spec_int ("scroll-arrow-vlength",
2573 P_("Vertical Scroll Arrow Length"),
2574 P_("The length of vertical scroll arrows"),
2576 GTK_PARAM_READABLE));
2580 gtk_widget_base_class_finalize (GtkWidgetClass *klass)
2584 list = g_param_spec_pool_list_owned (style_property_spec_pool, G_OBJECT_CLASS_TYPE (klass));
2585 for (node = list; node; node = node->next)
2587 GParamSpec *pspec = node->data;
2589 g_param_spec_pool_remove (style_property_spec_pool, pspec);
2590 g_param_spec_unref (pspec);
2596 gtk_widget_set_property (GObject *object,
2598 const GValue *value,
2601 GtkWidget *widget = GTK_WIDGET (object);
2606 gchar *tooltip_markup;
2607 const gchar *tooltip_text;
2608 GtkWindow *tooltip_window;
2611 gtk_widget_set_name (widget, g_value_get_string (value));
2614 gtk_container_add (GTK_CONTAINER (g_value_get_object (value)), widget);
2616 case PROP_WIDTH_REQUEST:
2617 gtk_widget_set_usize_internal (widget, g_value_get_int (value), -2);
2619 case PROP_HEIGHT_REQUEST:
2620 gtk_widget_set_usize_internal (widget, -2, g_value_get_int (value));
2623 gtk_widget_set_visible (widget, g_value_get_boolean (value));
2625 case PROP_SENSITIVE:
2626 gtk_widget_set_sensitive (widget, g_value_get_boolean (value));
2628 case PROP_APP_PAINTABLE:
2629 gtk_widget_set_app_paintable (widget, g_value_get_boolean (value));
2631 case PROP_CAN_FOCUS:
2632 gtk_widget_set_can_focus (widget, g_value_get_boolean (value));
2634 case PROP_HAS_FOCUS:
2635 if (g_value_get_boolean (value))
2636 gtk_widget_grab_focus (widget);
2639 if (g_value_get_boolean (value))
2640 gtk_widget_grab_focus (widget);
2642 case PROP_CAN_DEFAULT:
2643 gtk_widget_set_can_default (widget, g_value_get_boolean (value));
2645 case PROP_HAS_DEFAULT:
2646 if (g_value_get_boolean (value))
2647 gtk_widget_grab_default (widget);
2649 case PROP_RECEIVES_DEFAULT:
2650 gtk_widget_set_receives_default (widget, g_value_get_boolean (value));
2653 gtk_widget_set_style (widget, g_value_get_object (value));
2656 if (!GTK_WIDGET_REALIZED (widget) && !GTK_WIDGET_NO_WINDOW (widget))
2657 gtk_widget_set_events (widget, g_value_get_flags (value));
2659 case PROP_EXTENSION_EVENTS:
2660 gtk_widget_set_extension_events (widget, g_value_get_enum (value));
2662 case PROP_NO_SHOW_ALL:
2663 gtk_widget_set_no_show_all (widget, g_value_get_boolean (value));
2665 case PROP_HAS_TOOLTIP:
2666 gtk_widget_real_set_has_tooltip (widget,
2667 g_value_get_boolean (value), FALSE);
2669 case PROP_TOOLTIP_MARKUP:
2670 tooltip_window = g_object_get_qdata (object, quark_tooltip_window);
2671 tooltip_markup = g_value_dup_string (value);
2673 /* Treat an empty string as a NULL string,
2674 * because an empty string would be useless for a tooltip:
2676 if (tooltip_markup && (strlen (tooltip_markup) == 0))
2678 g_free (tooltip_markup);
2679 tooltip_markup = NULL;
2682 g_object_set_qdata_full (object, quark_tooltip_markup,
2683 tooltip_markup, g_free);
2685 tmp = (tooltip_window != NULL || tooltip_markup != NULL);
2686 gtk_widget_real_set_has_tooltip (widget, tmp, FALSE);
2687 if (GTK_WIDGET_VISIBLE (widget))
2688 gtk_widget_queue_tooltip_query (widget);
2690 case PROP_TOOLTIP_TEXT:
2691 tooltip_window = g_object_get_qdata (object, quark_tooltip_window);
2693 tooltip_text = g_value_get_string (value);
2695 /* Treat an empty string as a NULL string,
2696 * because an empty string would be useless for a tooltip:
2698 if (tooltip_text && (strlen (tooltip_text) == 0))
2699 tooltip_text = NULL;
2701 tooltip_markup = tooltip_text ? g_markup_escape_text (tooltip_text, -1) : NULL;
2703 g_object_set_qdata_full (object, quark_tooltip_markup,
2704 tooltip_markup, g_free);
2706 tmp = (tooltip_window != NULL || tooltip_markup != NULL);
2707 gtk_widget_real_set_has_tooltip (widget, tmp, FALSE);
2708 if (GTK_WIDGET_VISIBLE (widget))
2709 gtk_widget_queue_tooltip_query (widget);
2711 case PROP_DOUBLE_BUFFERED:
2712 gtk_widget_set_double_buffered (widget, g_value_get_boolean (value));
2715 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2721 gtk_widget_get_property (GObject *object,
2726 GtkWidget *widget = GTK_WIDGET (object);
2735 g_value_set_string (value, widget->name);
2737 g_value_set_static_string (value, "");
2740 g_value_set_object (value, widget->parent);
2742 case PROP_WIDTH_REQUEST:
2745 gtk_widget_get_size_request (widget, &w, NULL);
2746 g_value_set_int (value, w);
2749 case PROP_HEIGHT_REQUEST:
2752 gtk_widget_get_size_request (widget, NULL, &h);
2753 g_value_set_int (value, h);
2757 g_value_set_boolean (value, (GTK_WIDGET_VISIBLE (widget) != FALSE));
2759 case PROP_SENSITIVE:
2760 g_value_set_boolean (value, (GTK_WIDGET_SENSITIVE (widget) != FALSE));
2762 case PROP_APP_PAINTABLE:
2763 g_value_set_boolean (value, (gtk_widget_get_app_paintable (widget) != FALSE));
2765 case PROP_CAN_FOCUS:
2766 g_value_set_boolean (value, (gtk_widget_get_can_focus (widget) != FALSE));
2768 case PROP_HAS_FOCUS:
2769 g_value_set_boolean (value, (GTK_WIDGET_HAS_FOCUS (widget) != FALSE));
2772 g_value_set_boolean (value, (gtk_widget_is_focus (widget)));
2774 case PROP_CAN_DEFAULT:
2775 g_value_set_boolean (value, (gtk_widget_get_can_default (widget) != FALSE));
2777 case PROP_HAS_DEFAULT:
2778 g_value_set_boolean (value, (gtk_widget_has_default (widget) != FALSE));
2780 case PROP_RECEIVES_DEFAULT:
2781 g_value_set_boolean (value, (gtk_widget_get_receives_default (widget) != FALSE));
2783 case PROP_COMPOSITE_CHILD:
2784 g_value_set_boolean (value, (GTK_WIDGET_FLAGS (widget) & GTK_COMPOSITE_CHILD) != 0 );
2787 g_value_set_object (value, gtk_widget_get_style (widget));
2790 eventp = g_object_get_qdata (G_OBJECT (widget), quark_event_mask);
2791 g_value_set_flags (value, GPOINTER_TO_INT (eventp));
2793 case PROP_EXTENSION_EVENTS:
2794 modep = g_object_get_qdata (G_OBJECT (widget), quark_extension_event_mode);
2795 g_value_set_enum (value, GPOINTER_TO_INT (modep));
2797 case PROP_NO_SHOW_ALL:
2798 g_value_set_boolean (value, gtk_widget_get_no_show_all (widget));
2800 case PROP_HAS_TOOLTIP:
2801 g_value_set_boolean (value, GPOINTER_TO_UINT (g_object_get_qdata (object, quark_has_tooltip)));
2803 case PROP_TOOLTIP_TEXT:
2805 gchar *escaped = g_object_get_qdata (object, quark_tooltip_markup);
2808 if (escaped && !pango_parse_markup (escaped, -1, 0, NULL, &text, NULL, NULL))
2809 g_assert (NULL == text); /* text should still be NULL in case of markup errors */
2811 g_value_set_string (value, text);
2815 case PROP_TOOLTIP_MARKUP:
2816 g_value_set_string (value, g_object_get_qdata (object, quark_tooltip_markup));
2819 g_value_set_object (value, gtk_widget_get_window (widget));
2821 case PROP_DOUBLE_BUFFERED:
2822 g_value_set_boolean (value, gtk_widget_get_double_buffered (widget));
2825 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2831 gtk_widget_init (GtkWidget *widget)
2833 GTK_PRIVATE_FLAGS (widget) = PRIVATE_GTK_CHILD_VISIBLE;
2834 widget->state = GTK_STATE_NORMAL;
2835 widget->saved_state = GTK_STATE_NORMAL;
2836 widget->name = NULL;
2837 widget->requisition.width = 0;
2838 widget->requisition.height = 0;
2839 widget->allocation.x = -1;
2840 widget->allocation.y = -1;
2841 widget->allocation.width = 1;
2842 widget->allocation.height = 1;
2843 widget->window = NULL;
2844 widget->parent = NULL;
2846 GTK_WIDGET_SET_FLAGS (widget,
2848 GTK_PARENT_SENSITIVE |
2849 (composite_child_stack ? GTK_COMPOSITE_CHILD : 0) |
2850 GTK_DOUBLE_BUFFERED);
2852 GTK_PRIVATE_SET_FLAG (widget, GTK_REDRAW_ON_ALLOC);
2853 GTK_PRIVATE_SET_FLAG (widget, GTK_REQUEST_NEEDED);
2854 GTK_PRIVATE_SET_FLAG (widget, GTK_ALLOC_NEEDED);
2856 widget->style = gtk_widget_get_default_style ();
2857 g_object_ref (widget->style);
2862 gtk_widget_dispatch_child_properties_changed (GtkWidget *widget,
2864 GParamSpec **pspecs)
2866 GtkWidget *container = widget->parent;
2869 for (i = 0; widget->parent == container && i < n_pspecs; i++)
2870 g_signal_emit (widget, widget_signals[CHILD_NOTIFY], g_quark_from_string (pspecs[i]->name), pspecs[i]);
2874 * gtk_widget_freeze_child_notify:
2875 * @widget: a #GtkWidget
2877 * Stops emission of #GtkWidget::child-notify signals on @widget. The
2878 * signals are queued until gtk_widget_thaw_child_notify() is called
2881 * This is the analogue of g_object_freeze_notify() for child properties.
2884 gtk_widget_freeze_child_notify (GtkWidget *widget)
2886 g_return_if_fail (GTK_IS_WIDGET (widget));
2888 if (!G_OBJECT (widget)->ref_count)
2891 g_object_ref (widget);
2892 g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
2893 g_object_unref (widget);
2897 * gtk_widget_child_notify:
2898 * @widget: a #GtkWidget
2899 * @child_property: the name of a child property installed on the
2900 * class of @widget<!-- -->'s parent
2902 * Emits a #GtkWidget::child-notify signal for the
2903 * <link linkend="child-properties">child property</link> @child_property
2906 * This is the analogue of g_object_notify() for child properties.
2909 gtk_widget_child_notify (GtkWidget *widget,
2910 const gchar *child_property)
2914 g_return_if_fail (GTK_IS_WIDGET (widget));
2915 g_return_if_fail (child_property != NULL);
2916 if (!G_OBJECT (widget)->ref_count || !widget->parent)
2919 g_object_ref (widget);
2920 pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
2922 G_OBJECT_TYPE (widget->parent),
2925 g_warning ("%s: container class `%s' has no child property named `%s'",
2927 G_OBJECT_TYPE_NAME (widget->parent),
2931 GObjectNotifyQueue *nqueue = g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
2933 g_object_notify_queue_add (G_OBJECT (widget), nqueue, pspec);
2934 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
2936 g_object_unref (widget);
2940 * gtk_widget_thaw_child_notify:
2941 * @widget: a #GtkWidget
2943 * Reverts the effect of a previous call to gtk_widget_freeze_child_notify().
2944 * This causes all queued #GtkWidget::child-notify signals on @widget to be
2948 gtk_widget_thaw_child_notify (GtkWidget *widget)
2950 GObjectNotifyQueue *nqueue;
2952 g_return_if_fail (GTK_IS_WIDGET (widget));
2954 if (!G_OBJECT (widget)->ref_count)
2957 g_object_ref (widget);
2958 nqueue = g_object_notify_queue_from_object (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
2959 if (!nqueue || !nqueue->freeze_count)
2960 g_warning (G_STRLOC ": child-property-changed notification for %s(%p) is not frozen",
2961 G_OBJECT_TYPE_NAME (widget), widget);
2963 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
2964 g_object_unref (widget);
2970 * @type: type ID of the widget to create
2971 * @first_property_name: name of first property to set
2972 * @Varargs: value of first property, followed by more properties,
2975 * This is a convenience function for creating a widget and setting
2976 * its properties in one go. For example you might write:
2977 * <literal>gtk_widget_new (GTK_TYPE_LABEL, "label", "Hello World", "xalign",
2978 * 0.0, NULL)</literal> to create a left-aligned label. Equivalent to
2979 * g_object_new(), but returns a widget so you don't have to
2980 * cast the object yourself.
2982 * Return value: a new #GtkWidget of type @widget_type
2985 gtk_widget_new (GType type,
2986 const gchar *first_property_name,
2992 g_return_val_if_fail (g_type_is_a (type, GTK_TYPE_WIDGET), NULL);
2994 va_start (var_args, first_property_name);
2995 widget = (GtkWidget *)g_object_new_valist (type, first_property_name, var_args);
3003 * @widget: a #GtkWidget
3004 * @first_property_name: name of first property to set
3005 * @Varargs: value of first property, followed by more properties,
3008 * Precursor of g_object_set().
3010 * Deprecated: 2.0: Use g_object_set() instead.
3013 gtk_widget_set (GtkWidget *widget,
3014 const gchar *first_property_name,
3019 g_return_if_fail (GTK_IS_WIDGET (widget));
3021 va_start (var_args, first_property_name);
3022 g_object_set_valist (G_OBJECT (widget), first_property_name, var_args);
3027 gtk_widget_queue_draw_child (GtkWidget *widget)
3031 parent = widget->parent;
3032 if (parent && GTK_WIDGET_DRAWABLE (parent))
3033 gtk_widget_queue_draw_area (parent,
3034 widget->allocation.x,
3035 widget->allocation.y,
3036 widget->allocation.width,
3037 widget->allocation.height);
3041 * gtk_widget_unparent:
3042 * @widget: a #GtkWidget
3044 * This function is only for use in widget implementations.
3045 * Should be called by implementations of the remove method
3046 * on #GtkContainer, to dissociate a child from the container.
3049 gtk_widget_unparent (GtkWidget *widget)
3051 GObjectNotifyQueue *nqueue;
3052 GtkWidget *toplevel;
3053 GtkWidget *old_parent;
3055 g_return_if_fail (GTK_IS_WIDGET (widget));
3056 if (widget->parent == NULL)
3059 /* keep this function in sync with gtk_menu_detach()
3062 g_object_freeze_notify (G_OBJECT (widget));
3063 nqueue = g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
3065 toplevel = gtk_widget_get_toplevel (widget);
3066 if (gtk_widget_is_toplevel (toplevel))
3067 _gtk_window_unset_focus_and_default (GTK_WINDOW (toplevel), widget);
3069 if (GTK_CONTAINER (widget->parent)->focus_child == widget)
3070 gtk_container_set_focus_child (GTK_CONTAINER (widget->parent), NULL);
3072 /* If we are unanchoring the child, we save around the toplevel
3073 * to emit hierarchy changed
3075 if (GTK_WIDGET_ANCHORED (widget->parent))
3076 g_object_ref (toplevel);
3080 gtk_widget_queue_draw_child (widget);
3082 /* Reset the width and height here, to force reallocation if we
3083 * get added back to a new parent. This won't work if our new
3084 * allocation is smaller than 1x1 and we actually want a size of 1x1...
3085 * (would 0x0 be OK here?)
3087 widget->allocation.width = 1;
3088 widget->allocation.height = 1;
3090 if (GTK_WIDGET_REALIZED (widget))
3092 if (GTK_WIDGET_IN_REPARENT (widget))
3093 gtk_widget_unmap (widget);
3095 gtk_widget_unrealize (widget);
3098 /* Removing a widget from a container restores the child visible
3099 * flag to the default state, so it doesn't affect the child
3100 * in the next parent.
3102 GTK_PRIVATE_SET_FLAG (widget, GTK_CHILD_VISIBLE);
3104 old_parent = widget->parent;
3105 widget->parent = NULL;
3106 gtk_widget_set_parent_window (widget, NULL);
3107 g_signal_emit (widget, widget_signals[PARENT_SET], 0, old_parent);
3110 _gtk_widget_propagate_hierarchy_changed (widget, toplevel);
3111 g_object_unref (toplevel);
3114 g_object_notify (G_OBJECT (widget), "parent");
3115 g_object_thaw_notify (G_OBJECT (widget));
3116 if (!widget->parent)
3117 g_object_notify_queue_clear (G_OBJECT (widget), nqueue);
3118 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
3119 g_object_unref (widget);
3123 * gtk_widget_destroy:
3124 * @widget: a #GtkWidget
3126 * Destroys a widget. Equivalent to gtk_object_destroy(), except that
3127 * you don't have to cast the widget to #GtkObject. When a widget is
3128 * destroyed, it will break any references it holds to other objects.
3129 * If the widget is inside a container, the widget will be removed
3130 * from the container. If the widget is a toplevel (derived from
3131 * #GtkWindow), it will be removed from the list of toplevels, and the
3132 * reference GTK+ holds to it will be removed. Removing a
3133 * widget from its container or the list of toplevels results in the
3134 * widget being finalized, unless you've added additional references
3135 * to the widget with g_object_ref().
3137 * In most cases, only toplevel widgets (windows) require explicit
3138 * destruction, because when you destroy a toplevel its children will
3139 * be destroyed as well.
3142 gtk_widget_destroy (GtkWidget *widget)
3144 g_return_if_fail (GTK_IS_WIDGET (widget));
3146 gtk_object_destroy ((GtkObject*) widget);
3150 * gtk_widget_destroyed:
3151 * @widget: a #GtkWidget
3152 * @widget_pointer: (inout) (transfer none): address of a variable that contains @widget
3154 * This function sets *@widget_pointer to %NULL if @widget_pointer !=
3155 * %NULL. It's intended to be used as a callback connected to the
3156 * "destroy" signal of a widget. You connect gtk_widget_destroyed()
3157 * as a signal handler, and pass the address of your widget variable
3158 * as user data. Then when the widget is destroyed, the variable will
3159 * be set to %NULL. Useful for example to avoid multiple copies
3160 * of the same dialog.
3163 gtk_widget_destroyed (GtkWidget *widget,
3164 GtkWidget **widget_pointer)
3166 /* Don't make any assumptions about the
3168 * Even check widget_pointer.
3171 *widget_pointer = NULL;
3176 * @widget: a #GtkWidget
3178 * Flags a widget to be displayed. Any widget that isn't shown will
3179 * not appear on the screen. If you want to show all the widgets in a
3180 * container, it's easier to call gtk_widget_show_all() on the
3181 * container, instead of individually showing the widgets.
3183 * Remember that you have to show the containers containing a widget,
3184 * in addition to the widget itself, before it will appear onscreen.
3186 * When a toplevel container is shown, it is immediately realized and
3187 * mapped; other shown widgets are realized and mapped when their
3188 * toplevel container is realized and mapped.
3191 gtk_widget_show (GtkWidget *widget)
3193 g_return_if_fail (GTK_IS_WIDGET (widget));
3195 if (!GTK_WIDGET_VISIBLE (widget))
3197 g_object_ref (widget);
3198 if (!gtk_widget_is_toplevel (widget))
3199 gtk_widget_queue_resize (widget);
3200 g_signal_emit (widget, widget_signals[SHOW], 0);
3201 g_object_notify (G_OBJECT (widget), "visible");
3202 g_object_unref (widget);
3207 gtk_widget_real_show (GtkWidget *widget)
3209 if (!GTK_WIDGET_VISIBLE (widget))
3211 GTK_WIDGET_SET_FLAGS (widget, GTK_VISIBLE);
3213 if (widget->parent &&
3214 GTK_WIDGET_MAPPED (widget->parent) &&
3215 GTK_WIDGET_CHILD_VISIBLE (widget) &&
3216 !GTK_WIDGET_MAPPED (widget))
3217 gtk_widget_map (widget);
3222 gtk_widget_show_map_callback (GtkWidget *widget, GdkEvent *event, gint *flag)
3225 g_signal_handlers_disconnect_by_func (widget,
3226 gtk_widget_show_map_callback,
3231 * gtk_widget_show_now:
3232 * @widget: a #GtkWidget
3234 * Shows a widget. If the widget is an unmapped toplevel widget
3235 * (i.e. a #GtkWindow that has not yet been shown), enter the main
3236 * loop and wait for the window to actually be mapped. Be careful;
3237 * because the main loop is running, anything can happen during
3241 gtk_widget_show_now (GtkWidget *widget)
3245 g_return_if_fail (GTK_IS_WIDGET (widget));
3247 /* make sure we will get event */
3248 if (!GTK_WIDGET_MAPPED (widget) &&
3249 gtk_widget_is_toplevel (widget))
3251 gtk_widget_show (widget);
3253 g_signal_connect (widget, "map-event",
3254 G_CALLBACK (gtk_widget_show_map_callback),
3258 gtk_main_iteration ();
3261 gtk_widget_show (widget);
3266 * @widget: a #GtkWidget
3268 * Reverses the effects of gtk_widget_show(), causing the widget to be
3269 * hidden (invisible to the user).
3272 gtk_widget_hide (GtkWidget *widget)
3274 g_return_if_fail (GTK_IS_WIDGET (widget));
3276 if (GTK_WIDGET_VISIBLE (widget))
3278 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
3280 g_object_ref (widget);
3281 if (toplevel != widget && gtk_widget_is_toplevel (toplevel))
3282 _gtk_window_unset_focus_and_default (GTK_WINDOW (toplevel), widget);
3284 g_signal_emit (widget, widget_signals[HIDE], 0);
3285 if (!gtk_widget_is_toplevel (widget))
3286 gtk_widget_queue_resize (widget);
3287 g_object_notify (G_OBJECT (widget), "visible");
3288 g_object_unref (widget);
3293 gtk_widget_real_hide (GtkWidget *widget)
3295 if (GTK_WIDGET_VISIBLE (widget))
3297 GTK_WIDGET_UNSET_FLAGS (widget, GTK_VISIBLE);
3299 if (GTK_WIDGET_MAPPED (widget))
3300 gtk_widget_unmap (widget);
3305 * gtk_widget_hide_on_delete:
3306 * @widget: a #GtkWidget
3308 * Utility function; intended to be connected to the #GtkWidget::delete-event
3309 * signal on a #GtkWindow. The function calls gtk_widget_hide() on its
3310 * argument, then returns %TRUE. If connected to ::delete-event, the
3311 * result is that clicking the close button for a window (on the
3312 * window frame, top right corner usually) will hide but not destroy
3313 * the window. By default, GTK+ destroys windows when ::delete-event
3316 * Return value: %TRUE
3319 gtk_widget_hide_on_delete (GtkWidget *widget)
3321 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
3323 gtk_widget_hide (widget);
3329 * gtk_widget_show_all:
3330 * @widget: a #GtkWidget
3332 * Recursively shows a widget, and any child widgets (if the widget is
3336 gtk_widget_show_all (GtkWidget *widget)
3338 GtkWidgetClass *class;
3340 g_return_if_fail (GTK_IS_WIDGET (widget));
3342 if ((GTK_WIDGET_FLAGS (widget) & GTK_NO_SHOW_ALL) != 0)
3345 class = GTK_WIDGET_GET_CLASS (widget);
3347 if (class->show_all)
3348 class->show_all (widget);
3352 * gtk_widget_hide_all:
3353 * @widget: a #GtkWidget
3355 * Recursively hides a widget and any child widgets.
3358 gtk_widget_hide_all (GtkWidget *widget)
3360 GtkWidgetClass *class;
3362 g_return_if_fail (GTK_IS_WIDGET (widget));
3364 if ((GTK_WIDGET_FLAGS (widget) & GTK_NO_SHOW_ALL) != 0)
3367 class = GTK_WIDGET_GET_CLASS (widget);
3369 if (class->hide_all)
3370 class->hide_all (widget);
3375 * @widget: a #GtkWidget
3377 * This function is only for use in widget implementations. Causes
3378 * a widget to be mapped if it isn't already.
3381 gtk_widget_map (GtkWidget *widget)
3383 g_return_if_fail (GTK_IS_WIDGET (widget));
3384 g_return_if_fail (GTK_WIDGET_VISIBLE (widget));
3385 g_return_if_fail (GTK_WIDGET_CHILD_VISIBLE (widget));
3387 if (!GTK_WIDGET_MAPPED (widget))
3389 if (!GTK_WIDGET_REALIZED (widget))
3390 gtk_widget_realize (widget);
3392 g_signal_emit (widget, widget_signals[MAP], 0);
3394 if (GTK_WIDGET_NO_WINDOW (widget))
3395 gdk_window_invalidate_rect (widget->window, &widget->allocation, FALSE);
3401 * @widget: a #GtkWidget
3403 * This function is only for use in widget implementations. Causes
3404 * a widget to be unmapped if it's currently mapped.
3407 gtk_widget_unmap (GtkWidget *widget)
3409 g_return_if_fail (GTK_IS_WIDGET (widget));
3411 if (GTK_WIDGET_MAPPED (widget))
3413 if (GTK_WIDGET_NO_WINDOW (widget))
3414 gdk_window_invalidate_rect (widget->window, &widget->allocation, FALSE);
3415 _gtk_tooltip_hide (widget);
3416 g_signal_emit (widget, widget_signals[UNMAP], 0);
3421 gtk_widget_set_extension_events_internal (GtkWidget *widget,
3422 GdkExtensionMode mode,
3425 GList *free_list = NULL;
3428 if (window_list == NULL)
3430 if (!GTK_WIDGET_NO_WINDOW (widget))
3431 window_list = g_list_prepend (NULL, widget->window);
3433 window_list = gdk_window_get_children (widget->window);
3435 free_list = window_list;
3438 for (l = window_list; l != NULL; l = l->next)
3440 GdkWindow *window = l->data;
3443 gdk_window_get_user_data (window, &user_data);
3444 if (user_data == widget)
3448 gdk_input_set_extension_events (window,
3449 gdk_window_get_events (window),
3452 children = gdk_window_get_children (window);
3455 gtk_widget_set_extension_events_internal (widget, mode, children);
3456 g_list_free (children);
3462 g_list_free (free_list);
3466 * gtk_widget_realize:
3467 * @widget: a #GtkWidget
3469 * Creates the GDK (windowing system) resources associated with a
3470 * widget. For example, @widget->window will be created when a widget
3471 * is realized. Normally realization happens implicitly; if you show
3472 * a widget and all its parent containers, then the widget will be
3473 * realized and mapped automatically.
3475 * Realizing a widget requires all
3476 * the widget's parent widgets to be realized; calling
3477 * gtk_widget_realize() realizes the widget's parents in addition to
3478 * @widget itself. If a widget is not yet inside a toplevel window
3479 * when you realize it, bad things will happen.
3481 * This function is primarily used in widget implementations, and
3482 * isn't very useful otherwise. Many times when you think you might
3483 * need it, a better approach is to connect to a signal that will be
3484 * called after the widget is realized automatically, such as
3485 * GtkWidget::expose-event. Or simply g_signal_connect () to the
3486 * GtkWidget::realize signal.
3489 gtk_widget_realize (GtkWidget *widget)
3491 GdkExtensionMode mode;
3492 GtkWidgetShapeInfo *shape_info;
3494 g_return_if_fail (GTK_IS_WIDGET (widget));
3495 g_return_if_fail (GTK_WIDGET_ANCHORED (widget) ||
3496 GTK_IS_INVISIBLE (widget));
3498 if (!GTK_WIDGET_REALIZED (widget))
3501 if (GTK_IS_CONTAINER (widget) && !GTK_WIDGET_NO_WINDOW (widget))
3502 g_message ("gtk_widget_realize(%s)", G_OBJECT_TYPE_NAME (widget));
3505 if (widget->parent == NULL &&
3506 !gtk_widget_is_toplevel (widget))
3507 g_warning ("Calling gtk_widget_realize() on a widget that isn't "
3508 "inside a toplevel window is not going to work very well. "
3509 "Widgets must be inside a toplevel container before realizing them.");
3511 if (widget->parent && !GTK_WIDGET_REALIZED (widget->parent))
3512 gtk_widget_realize (widget->parent);
3514 gtk_widget_ensure_style (widget);
3516 g_signal_emit (widget, widget_signals[REALIZE], 0);
3518 gtk_widget_real_set_has_tooltip (widget,
3519 GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (widget), quark_has_tooltip)),
3522 if (GTK_WIDGET_HAS_SHAPE_MASK (widget))
3524 shape_info = g_object_get_qdata (G_OBJECT (widget), quark_shape_info);
3525 gdk_window_shape_combine_mask (widget->window,
3526 shape_info->shape_mask,
3527 shape_info->offset_x,
3528 shape_info->offset_y);
3531 shape_info = g_object_get_qdata (G_OBJECT (widget), quark_input_shape_info);
3533 gdk_window_input_shape_combine_mask (widget->window,
3534 shape_info->shape_mask,
3535 shape_info->offset_x,
3536 shape_info->offset_y);
3538 mode = gtk_widget_get_extension_events (widget);
3539 if (mode != GDK_EXTENSION_EVENTS_NONE)
3540 gtk_widget_set_extension_events_internal (widget, mode, NULL);
3545 * gtk_widget_unrealize:
3546 * @widget: a #GtkWidget
3548 * This function is only useful in widget implementations.
3549 * Causes a widget to be unrealized (frees all GDK resources
3550 * associated with the widget, such as @widget->window).
3553 gtk_widget_unrealize (GtkWidget *widget)
3555 g_return_if_fail (GTK_IS_WIDGET (widget));
3557 if (GTK_WIDGET_HAS_SHAPE_MASK (widget))
3558 gtk_widget_shape_combine_mask (widget, NULL, 0, 0);
3560 if (g_object_get_qdata (G_OBJECT (widget), quark_input_shape_info))
3561 gtk_widget_input_shape_combine_mask (widget, NULL, 0, 0);
3563 if (GTK_WIDGET_REALIZED (widget))
3565 g_object_ref (widget);
3566 _gtk_tooltip_hide (widget);
3567 g_signal_emit (widget, widget_signals[UNREALIZE], 0);
3568 GTK_WIDGET_UNSET_FLAGS (widget, GTK_REALIZED | GTK_MAPPED);
3569 g_object_unref (widget);
3573 /*****************************************
3575 *****************************************/
3578 * gtk_widget_queue_draw_area:
3579 * @widget: a #GtkWidget
3580 * @x: x coordinate of upper-left corner of rectangle to redraw
3581 * @y: y coordinate of upper-left corner of rectangle to redraw
3582 * @width: width of region to draw
3583 * @height: height of region to draw
3585 * Invalidates the rectangular area of @widget defined by @x, @y,
3586 * @width and @height by calling gdk_window_invalidate_rect() on the
3587 * widget's window and all its child windows. Once the main loop
3588 * becomes idle (after the current batch of events has been processed,
3589 * roughly), the window will receive expose events for the union of
3590 * all regions that have been invalidated.
3592 * Normally you would only use this function in widget
3593 * implementations. You might also use it, or
3594 * gdk_window_invalidate_rect() directly, to schedule a redraw of a
3595 * #GtkDrawingArea or some portion thereof.
3597 * Frequently you can just call gdk_window_invalidate_rect() or
3598 * gdk_window_invalidate_region() instead of this function. Those
3599 * functions will invalidate only a single window, instead of the
3600 * widget and all its children.
3602 * The advantage of adding to the invalidated region compared to
3603 * simply drawing immediately is efficiency; using an invalid region
3604 * ensures that you only have to redraw one time.
3607 gtk_widget_queue_draw_area (GtkWidget *widget,
3613 GdkRectangle invalid_rect;
3616 g_return_if_fail (GTK_IS_WIDGET (widget));
3618 if (!GTK_WIDGET_REALIZED (widget))
3621 /* Just return if the widget or one of its ancestors isn't mapped */
3622 for (w = widget; w != NULL; w = w->parent)
3623 if (!GTK_WIDGET_MAPPED (w))
3626 /* Find the correct widget */
3628 if (!GTK_WIDGET_NO_WINDOW (widget))
3632 /* Translate widget relative to window-relative */
3634 gint wx, wy, wwidth, wheight;
3636 gdk_window_get_position (widget->window, &wx, &wy);
3637 x -= wx - widget->allocation.x;
3638 y -= wy - widget->allocation.y;
3640 gdk_drawable_get_size (widget->window, &wwidth, &wheight);
3642 if (x + width <= 0 || y + height <= 0 ||
3643 x >= wwidth || y >= wheight)
3654 if (x + width > wwidth)
3656 if (y + height > wheight)
3657 height = wheight - y;
3663 invalid_rect.width = width;
3664 invalid_rect.height = height;
3666 gdk_window_invalidate_rect (widget->window, &invalid_rect, TRUE);
3670 widget_add_child_draw_rectangle (GtkWidget *widget,
3673 GdkRectangle child_rect;
3675 if (!GTK_WIDGET_MAPPED (widget) ||
3676 widget->window != widget->parent->window)
3679 gtk_widget_get_draw_rectangle (widget, &child_rect);
3680 gdk_rectangle_union (rect, &child_rect, rect);
3684 gtk_widget_get_draw_rectangle (GtkWidget *widget,
3687 if (GTK_WIDGET_NO_WINDOW (widget))
3689 GtkBorder *draw_border = NULL;
3691 *rect = widget->allocation;
3693 gtk_widget_style_get (widget,
3694 "draw-border", &draw_border,
3698 rect->x -= draw_border->left;
3699 rect->y -= draw_border->top;
3700 rect->width += draw_border->left + draw_border->right;
3701 rect->height += draw_border->top + draw_border->bottom;
3703 gtk_border_free (draw_border);
3706 if (GTK_IS_CONTAINER (widget))
3707 gtk_container_forall (GTK_CONTAINER (widget),
3708 (GtkCallback)widget_add_child_draw_rectangle,
3715 rect->width = widget->allocation.width;
3716 rect->height = widget->allocation.height;
3721 * gtk_widget_queue_draw:
3722 * @widget: a #GtkWidget
3724 * Equivalent to calling gtk_widget_queue_draw_area() for the
3725 * entire area of a widget.
3728 gtk_widget_queue_draw (GtkWidget *widget)
3732 g_return_if_fail (GTK_IS_WIDGET (widget));
3734 gtk_widget_get_draw_rectangle (widget, &rect);
3736 gtk_widget_queue_draw_area (widget,
3738 rect.width, rect.height);
3741 /* Invalidates the given area (allocation-relative-coordinates)
3742 * in all of the widget's windows
3745 * gtk_widget_queue_clear_area:
3746 * @widget: a #GtkWidget
3747 * @x: x coordinate of upper-left corner of rectangle to redraw
3748 * @y: y coordinate of upper-left corner of rectangle to redraw
3749 * @width: width of region to draw
3750 * @height: height of region to draw
3752 * This function is no longer different from
3753 * gtk_widget_queue_draw_area(), though it once was. Now it just calls
3754 * gtk_widget_queue_draw_area(). Originally
3755 * gtk_widget_queue_clear_area() would force a redraw of the
3756 * background for %GTK_NO_WINDOW widgets, and
3757 * gtk_widget_queue_draw_area() would not. Now both functions ensure
3758 * the background will be redrawn.
3760 * Deprecated: 2.2: Use gtk_widget_queue_draw_area() instead.
3763 gtk_widget_queue_clear_area (GtkWidget *widget,
3769 g_return_if_fail (GTK_IS_WIDGET (widget));
3771 gtk_widget_queue_draw_area (widget, x, y, width, height);
3775 * gtk_widget_queue_clear:
3776 * @widget: a #GtkWidget
3778 * This function does the same as gtk_widget_queue_draw().
3780 * Deprecated: 2.2: Use gtk_widget_queue_draw() instead.
3783 gtk_widget_queue_clear (GtkWidget *widget)
3785 g_return_if_fail (GTK_IS_WIDGET (widget));
3787 gtk_widget_queue_draw (widget);
3791 * gtk_widget_queue_resize:
3792 * @widget: a #GtkWidget
3794 * This function is only for use in widget implementations.
3795 * Flags a widget to have its size renegotiated; should
3796 * be called when a widget for some reason has a new size request.
3797 * For example, when you change the text in a #GtkLabel, #GtkLabel
3798 * queues a resize to ensure there's enough space for the new text.
3801 gtk_widget_queue_resize (GtkWidget *widget)
3803 g_return_if_fail (GTK_IS_WIDGET (widget));
3805 if (GTK_WIDGET_REALIZED (widget))
3806 gtk_widget_queue_shallow_draw (widget);
3808 _gtk_size_group_queue_resize (widget);
3812 * gtk_widget_queue_resize_no_redraw:
3813 * @widget: a #GtkWidget
3815 * This function works like gtk_widget_queue_resize(),
3816 * except that the widget is not invalidated.
3821 gtk_widget_queue_resize_no_redraw (GtkWidget *widget)
3823 g_return_if_fail (GTK_IS_WIDGET (widget));
3825 _gtk_size_group_queue_resize (widget);
3830 * @widget: a #GtkWidget
3831 * @area: area to draw
3833 * In GTK+ 1.2, this function would immediately render the
3834 * region @area of a widget, by invoking the virtual draw method of a
3835 * widget. In GTK+ 2.0, the draw method is gone, and instead
3836 * gtk_widget_draw() simply invalidates the specified region of the
3837 * widget, then updates the invalid region of the widget immediately.
3838 * Usually you don't want to update the region immediately for
3839 * performance reasons, so in general gtk_widget_queue_draw_area() is
3840 * a better choice if you want to draw a region of a widget.
3843 gtk_widget_draw (GtkWidget *widget,
3844 const GdkRectangle *area)
3846 g_return_if_fail (GTK_IS_WIDGET (widget));
3848 if (GTK_WIDGET_DRAWABLE (widget))
3851 gtk_widget_queue_draw_area (widget,
3853 area->width, area->height);
3855 gtk_widget_queue_draw (widget);
3857 gdk_window_process_updates (widget->window, TRUE);
3862 * gtk_widget_size_request:
3863 * @widget: a #GtkWidget
3864 * @requisition: a #GtkRequisition to be filled in
3866 * This function is typically used when implementing a #GtkContainer
3867 * subclass. Obtains the preferred size of a widget. The container
3868 * uses this information to arrange its child widgets and decide what
3869 * size allocations to give them with gtk_widget_size_allocate().
3871 * You can also call this function from an application, with some
3872 * caveats. Most notably, getting a size request requires the widget
3873 * to be associated with a screen, because font information may be
3874 * needed. Multihead-aware applications should keep this in mind.
3876 * Also remember that the size request is not necessarily the size
3877 * a widget will actually be allocated.
3879 * See also gtk_widget_get_child_requisition().
3882 gtk_widget_size_request (GtkWidget *widget,
3883 GtkRequisition *requisition)
3885 g_return_if_fail (GTK_IS_WIDGET (widget));
3887 #ifdef G_ENABLE_DEBUG
3888 if (requisition == &widget->requisition)
3889 g_warning ("gtk_widget_size_request() called on child widget with request equal\n"
3890 "to widget->requisition. gtk_widget_set_usize() may not work properly.");
3891 #endif /* G_ENABLE_DEBUG */
3893 _gtk_size_group_compute_desired_size (widget, requisition, NULL);
3897 * gtk_widget_get_child_requisition:
3898 * @widget: a #GtkWidget
3899 * @requisition: a #GtkRequisition to be filled in
3901 * This function is only for use in widget implementations. Obtains
3902 * @widget->requisition, unless someone has forced a particular
3903 * geometry on the widget (e.g. with gtk_widget_set_size_request()),
3904 * in which case it returns that geometry instead of the widget's
3907 * This function differs from gtk_widget_size_request() in that
3908 * it retrieves the last size request value from @widget->requisition,
3909 * while gtk_widget_size_request() actually calls the "size_request" method
3910 * on @widget to compute the size request and fill in @widget->requisition,
3911 * and only then returns @widget->requisition.
3913 * Because this function does not call the "size_request" method, it
3914 * can only be used when you know that @widget->requisition is
3915 * up-to-date, that is, gtk_widget_size_request() has been called
3916 * since the last time a resize was queued. In general, only container
3917 * implementations have this information; applications should use
3918 * gtk_widget_size_request().
3921 gtk_widget_get_child_requisition (GtkWidget *widget,
3922 GtkRequisition *requisition)
3924 _gtk_size_group_get_child_requisition (widget, requisition);
3928 invalidate_predicate (GdkWindow *window,
3933 gdk_window_get_user_data (window, &user_data);
3935 return (user_data == data);
3938 /* Invalidate @region in widget->window and all children
3939 * of widget->window owned by widget. @region is in the
3940 * same coordinates as widget->allocation and will be
3941 * modified by this call.
3944 gtk_widget_invalidate_widget_windows (GtkWidget *widget,
3947 if (!GTK_WIDGET_REALIZED (widget))
3950 if (!GTK_WIDGET_NO_WINDOW (widget) && widget->parent)
3954 gdk_window_get_position (widget->window, &x, &y);
3955 gdk_region_offset (region, -x, -y);
3958 gdk_window_invalidate_maybe_recurse (widget->window, region,
3959 invalidate_predicate, widget);
3963 * gtk_widget_queue_shallow_draw:
3964 * @widget: a #GtkWidget
3966 * Like gtk_widget_queue_draw(), but only windows owned
3967 * by @widget are invalidated.
3970 gtk_widget_queue_shallow_draw (GtkWidget *widget)
3975 if (!GTK_WIDGET_REALIZED (widget))
3978 gtk_widget_get_draw_rectangle (widget, &rect);
3980 /* get_draw_rectangle() gives us window coordinates, we
3981 * need to convert to the coordinates that widget->allocation
3984 if (!GTK_WIDGET_NO_WINDOW (widget) && widget->parent)
3988 gdk_window_get_position (widget->window, &wx, &wy);
3994 region = gdk_region_rectangle (&rect);
3995 gtk_widget_invalidate_widget_windows (widget, region);
3996 gdk_region_destroy (region);
4000 * gtk_widget_size_allocate:
4001 * @widget: a #GtkWidget
4002 * @allocation: position and size to be allocated to @widget
4004 * This function is only used by #GtkContainer subclasses, to assign a size
4005 * and position to their child widgets.
4008 gtk_widget_size_allocate (GtkWidget *widget,
4009 GtkAllocation *allocation)
4011 GtkWidgetAuxInfo *aux_info;
4012 GdkRectangle real_allocation;
4013 GdkRectangle old_allocation;
4014 gboolean alloc_needed;
4015 gboolean size_changed;
4016 gboolean position_changed;
4018 g_return_if_fail (GTK_IS_WIDGET (widget));
4020 #ifdef G_ENABLE_DEBUG
4021 if (gtk_debug_flags & GTK_DEBUG_GEOMETRY)
4032 parent = gtk_widget_get_parent (parent);
4035 name = g_type_name (G_OBJECT_TYPE (G_OBJECT (widget)));
4036 g_print ("gtk_widget_size_allocate: %*s%s %d %d\n",
4037 2 * depth, " ", name,
4038 allocation->width, allocation->height);
4040 #endif /* G_ENABLE_DEBUG */
4042 alloc_needed = GTK_WIDGET_ALLOC_NEEDED (widget);
4043 if (!GTK_WIDGET_REQUEST_NEEDED (widget)) /* Preserve request/allocate ordering */
4044 GTK_PRIVATE_UNSET_FLAG (widget, GTK_ALLOC_NEEDED);
4046 old_allocation = widget->allocation;
4047 real_allocation = *allocation;
4048 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
4052 if (aux_info->x_set)
4053 real_allocation.x = aux_info->x;
4054 if (aux_info->y_set)
4055 real_allocation.y = aux_info->y;
4058 if (real_allocation.width < 0 || real_allocation.height < 0)
4060 g_warning ("gtk_widget_size_allocate(): attempt to allocate widget with width %d and height %d",
4061 real_allocation.width,
4062 real_allocation.height);
4065 real_allocation.width = MAX (real_allocation.width, 1);
4066 real_allocation.height = MAX (real_allocation.height, 1);
4068 size_changed = (old_allocation.width != real_allocation.width ||
4069 old_allocation.height != real_allocation.height);
4070 position_changed = (old_allocation.x != real_allocation.x ||
4071 old_allocation.y != real_allocation.y);
4073 if (!alloc_needed && !size_changed && !position_changed)
4076 g_signal_emit (widget, widget_signals[SIZE_ALLOCATE], 0, &real_allocation);
4078 if (GTK_WIDGET_MAPPED (widget))
4080 if (GTK_WIDGET_NO_WINDOW (widget) && GTK_WIDGET_REDRAW_ON_ALLOC (widget) && position_changed)
4082 /* Invalidate union(old_allaction,widget->allocation) in widget->window
4084 GdkRegion *invalidate = gdk_region_rectangle (&widget->allocation);
4085 gdk_region_union_with_rect (invalidate, &old_allocation);
4087 gdk_window_invalidate_region (widget->window, invalidate, FALSE);
4088 gdk_region_destroy (invalidate);
4093 if (GTK_WIDGET_REDRAW_ON_ALLOC (widget))
4095 /* Invalidate union(old_allaction,widget->allocation) in widget->window and descendents owned by widget
4097 GdkRegion *invalidate = gdk_region_rectangle (&widget->allocation);
4098 gdk_region_union_with_rect (invalidate, &old_allocation);
4100 gtk_widget_invalidate_widget_windows (widget, invalidate);
4101 gdk_region_destroy (invalidate);
4106 if ((size_changed || position_changed) && widget->parent &&
4107 GTK_WIDGET_REALIZED (widget->parent) && GTK_CONTAINER (widget->parent)->reallocate_redraws)
4109 GdkRegion *invalidate = gdk_region_rectangle (&widget->parent->allocation);
4110 gtk_widget_invalidate_widget_windows (widget->parent, invalidate);
4111 gdk_region_destroy (invalidate);
4116 * gtk_widget_common_ancestor:
4117 * @widget_a: a #GtkWidget
4118 * @widget_b: a #GtkWidget
4120 * Find the common ancestor of @widget_a and @widget_b that
4121 * is closest to the two widgets.
4123 * Return value: the closest common ancestor of @widget_a and
4124 * @widget_b or %NULL if @widget_a and @widget_b do not
4125 * share a common ancestor.
4128 gtk_widget_common_ancestor (GtkWidget *widget_a,
4129 GtkWidget *widget_b)
4131 GtkWidget *parent_a;
4132 GtkWidget *parent_b;
4136 parent_a = widget_a;
4137 while (parent_a->parent)
4139 parent_a = parent_a->parent;
4143 parent_b = widget_b;
4144 while (parent_b->parent)
4146 parent_b = parent_b->parent;
4150 if (parent_a != parent_b)
4153 while (depth_a > depth_b)
4155 widget_a = widget_a->parent;
4159 while (depth_b > depth_a)
4161 widget_b = widget_b->parent;
4165 while (widget_a != widget_b)
4167 widget_a = widget_a->parent;
4168 widget_b = widget_b->parent;
4175 * gtk_widget_translate_coordinates:
4176 * @src_widget: a #GtkWidget
4177 * @dest_widget: a #GtkWidget
4178 * @src_x: X position relative to @src_widget
4179 * @src_y: Y position relative to @src_widget
4180 * @dest_x: (out): location to store X position relative to @dest_widget
4181 * @dest_y: (out): location to store Y position relative to @dest_widget
4183 * Translate coordinates relative to @src_widget's allocation to coordinates
4184 * relative to @dest_widget's allocations. In order to perform this
4185 * operation, both widgets must be realized, and must share a common
4188 * Return value: %FALSE if either widget was not realized, or there
4189 * was no common ancestor. In this case, nothing is stored in
4190 * *@dest_x and *@dest_y. Otherwise %TRUE.
4193 gtk_widget_translate_coordinates (GtkWidget *src_widget,
4194 GtkWidget *dest_widget,
4200 GtkWidget *ancestor;
4203 g_return_val_if_fail (GTK_IS_WIDGET (src_widget), FALSE);
4204 g_return_val_if_fail (GTK_IS_WIDGET (dest_widget), FALSE);
4206 ancestor = gtk_widget_common_ancestor (src_widget, dest_widget);
4207 if (!ancestor || !GTK_WIDGET_REALIZED (src_widget) || !GTK_WIDGET_REALIZED (dest_widget))
4210 /* Translate from allocation relative to window relative */
4211 if (!GTK_WIDGET_NO_WINDOW (src_widget) && src_widget->parent)
4214 gdk_window_get_position (src_widget->window, &wx, &wy);
4216 src_x -= wx - src_widget->allocation.x;
4217 src_y -= wy - src_widget->allocation.y;
4221 src_x += src_widget->allocation.x;
4222 src_y += src_widget->allocation.y;
4225 /* Translate to the common ancestor */
4226 window = src_widget->window;
4227 while (window != ancestor->window)
4231 gdk_window_get_position (window, &dx, &dy);
4236 window = gdk_window_get_parent (window);
4238 if (!window) /* Handle GtkHandleBox */
4243 window = dest_widget->window;
4244 while (window != ancestor->window)
4248 gdk_window_get_position (window, &dx, &dy);
4253 window = gdk_window_get_parent (window);
4255 if (!window) /* Handle GtkHandleBox */
4259 /* Translate from window relative to allocation relative */
4260 if (!GTK_WIDGET_NO_WINDOW (dest_widget) && dest_widget->parent)
4263 gdk_window_get_position (dest_widget->window, &wx, &wy);
4265 src_x += wx - dest_widget->allocation.x;
4266 src_y += wy - dest_widget->allocation.y;
4270 src_x -= dest_widget->allocation.x;
4271 src_y -= dest_widget->allocation.y;
4283 gtk_widget_real_size_allocate (GtkWidget *widget,
4284 GtkAllocation *allocation)
4286 widget->allocation = *allocation;
4288 if (GTK_WIDGET_REALIZED (widget) &&
4289 !GTK_WIDGET_NO_WINDOW (widget))
4291 gdk_window_move_resize (widget->window,
4292 allocation->x, allocation->y,
4293 allocation->width, allocation->height);
4298 gtk_widget_real_can_activate_accel (GtkWidget *widget,
4301 /* widgets must be onscreen for accels to take effect */
4302 return GTK_WIDGET_IS_SENSITIVE (widget) && GTK_WIDGET_DRAWABLE (widget) && gdk_window_is_viewable (widget->window);
4306 * gtk_widget_can_activate_accel:
4307 * @widget: a #GtkWidget
4308 * @signal_id: the ID of a signal installed on @widget
4310 * Determines whether an accelerator that activates the signal
4311 * identified by @signal_id can currently be activated.
4312 * This is done by emitting the #GtkWidget::can-activate-accel
4313 * signal on @widget; if the signal isn't overridden by a
4314 * handler or in a derived widget, then the default check is
4315 * that the widget must be sensitive, and the widget and all
4316 * its ancestors mapped.
4318 * Return value: %TRUE if the accelerator can be activated.
4323 gtk_widget_can_activate_accel (GtkWidget *widget,
4326 gboolean can_activate = FALSE;
4327 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4328 g_signal_emit (widget, widget_signals[CAN_ACTIVATE_ACCEL], 0, signal_id, &can_activate);
4329 return can_activate;
4338 closure_accel_activate (GClosure *closure,
4339 GValue *return_value,
4340 guint n_param_values,
4341 const GValue *param_values,
4342 gpointer invocation_hint,
4343 gpointer marshal_data)
4345 AccelClosure *aclosure = (AccelClosure*) closure;
4346 gboolean can_activate = gtk_widget_can_activate_accel (closure->data, aclosure->signal_id);
4349 g_signal_emit (closure->data, aclosure->signal_id, 0);
4351 /* whether accelerator was handled */
4352 g_value_set_boolean (return_value, can_activate);
4356 closures_destroy (gpointer data)
4358 GSList *slist, *closures = data;
4360 for (slist = closures; slist; slist = slist->next)
4362 g_closure_invalidate (slist->data);
4363 g_closure_unref (slist->data);
4365 g_slist_free (closures);
4369 widget_new_accel_closure (GtkWidget *widget,
4372 AccelClosure *aclosure;
4373 GClosure *closure = NULL;
4374 GSList *slist, *closures;
4376 closures = g_object_steal_qdata (G_OBJECT (widget), quark_accel_closures);
4377 for (slist = closures; slist; slist = slist->next)
4378 if (!gtk_accel_group_from_accel_closure (slist->data))
4380 /* reuse this closure */
4381 closure = slist->data;
4386 closure = g_closure_new_object (sizeof (AccelClosure), G_OBJECT (widget));
4387 closures = g_slist_prepend (closures, g_closure_ref (closure));
4388 g_closure_sink (closure);
4389 g_closure_set_marshal (closure, closure_accel_activate);
4391 g_object_set_qdata_full (G_OBJECT (widget), quark_accel_closures, closures, closures_destroy);
4393 aclosure = (AccelClosure*) closure;
4394 g_assert (closure->data == widget);
4395 g_assert (closure->marshal == closure_accel_activate);
4396 aclosure->signal_id = signal_id;
4402 * gtk_widget_add_accelerator
4403 * @widget: widget to install an accelerator on
4404 * @accel_signal: widget signal to emit on accelerator activation
4405 * @accel_group: accel group for this widget, added to its toplevel
4406 * @accel_key: GDK keyval of the accelerator
4407 * @accel_mods: modifier key combination of the accelerator
4408 * @accel_flags: flag accelerators, e.g. %GTK_ACCEL_VISIBLE
4410 * Installs an accelerator for this @widget in @accel_group that causes
4411 * @accel_signal to be emitted if the accelerator is activated.
4412 * The @accel_group needs to be added to the widget's toplevel via
4413 * gtk_window_add_accel_group(), and the signal must be of type %G_RUN_ACTION.
4414 * Accelerators added through this function are not user changeable during
4415 * runtime. If you want to support accelerators that can be changed by the
4416 * user, use gtk_accel_map_add_entry() and gtk_widget_set_accel_path() or
4417 * gtk_menu_item_set_accel_path() instead.
4420 gtk_widget_add_accelerator (GtkWidget *widget,
4421 const gchar *accel_signal,
4422 GtkAccelGroup *accel_group,
4424 GdkModifierType accel_mods,
4425 GtkAccelFlags accel_flags)
4430 g_return_if_fail (GTK_IS_WIDGET (widget));
4431 g_return_if_fail (accel_signal != NULL);
4432 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
4434 g_signal_query (g_signal_lookup (accel_signal, G_OBJECT_TYPE (widget)), &query);
4435 if (!query.signal_id ||
4436 !(query.signal_flags & G_SIGNAL_ACTION) ||
4437 query.return_type != G_TYPE_NONE ||
4440 /* hmm, should be elaborate enough */
4441 g_warning (G_STRLOC ": widget `%s' has no activatable signal \"%s\" without arguments",
4442 G_OBJECT_TYPE_NAME (widget), accel_signal);
4446 closure = widget_new_accel_closure (widget, query.signal_id);
4448 g_object_ref (widget);
4450 /* install the accelerator. since we don't map this onto an accel_path,
4451 * the accelerator will automatically be locked.
4453 gtk_accel_group_connect (accel_group,
4456 accel_flags | GTK_ACCEL_LOCKED,
4459 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
4461 g_object_unref (widget);
4465 * gtk_widget_remove_accelerator:
4466 * @widget: widget to install an accelerator on
4467 * @accel_group: accel group for this widget
4468 * @accel_key: GDK keyval of the accelerator
4469 * @accel_mods: modifier key combination of the accelerator
4470 * @returns: whether an accelerator was installed and could be removed
4472 * Removes an accelerator from @widget, previously installed with
4473 * gtk_widget_add_accelerator().
4476 gtk_widget_remove_accelerator (GtkWidget *widget,
4477 GtkAccelGroup *accel_group,
4479 GdkModifierType accel_mods)
4481 GtkAccelGroupEntry *ag_entry;
4482 GList *slist, *clist;
4485 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4486 g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE);
4488 ag_entry = gtk_accel_group_query (accel_group, accel_key, accel_mods, &n);
4489 clist = gtk_widget_list_accel_closures (widget);
4490 for (slist = clist; slist; slist = slist->next)
4494 for (i = 0; i < n; i++)
4495 if (slist->data == (gpointer) ag_entry[i].closure)
4497 gboolean is_removed = gtk_accel_group_disconnect (accel_group, slist->data);
4499 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
4501 g_list_free (clist);
4506 g_list_free (clist);
4508 g_warning (G_STRLOC ": no accelerator (%u,%u) installed in accel group (%p) for %s (%p)",
4509 accel_key, accel_mods, accel_group,
4510 G_OBJECT_TYPE_NAME (widget), widget);
4516 * gtk_widget_list_accel_closures
4517 * @widget: widget to list accelerator closures for
4518 * @returns: a newly allocated #GList of closures
4520 * Lists the closures used by @widget for accelerator group connections
4521 * with gtk_accel_group_connect_by_path() or gtk_accel_group_connect().
4522 * The closures can be used to monitor accelerator changes on @widget,
4523 * by connecting to the @GtkAccelGroup::accel-changed signal of the
4524 * #GtkAccelGroup of a closure which can be found out with
4525 * gtk_accel_group_from_accel_closure().
4528 gtk_widget_list_accel_closures (GtkWidget *widget)
4531 GList *clist = NULL;
4533 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4535 for (slist = g_object_get_qdata (G_OBJECT (widget), quark_accel_closures); slist; slist = slist->next)
4536 if (gtk_accel_group_from_accel_closure (slist->data))
4537 clist = g_list_prepend (clist, slist->data);
4543 GtkAccelGroup *accel_group;
4548 destroy_accel_path (gpointer data)
4550 AccelPath *apath = data;
4552 gtk_accel_group_disconnect (apath->accel_group, apath->closure);
4554 /* closures_destroy takes care of unrefing the closure */
4555 g_object_unref (apath->accel_group);
4557 g_slice_free (AccelPath, apath);
4562 * gtk_widget_set_accel_path:
4563 * @widget: a #GtkWidget
4564 * @accel_path: (allow-none): path used to look up the accelerator
4565 * @accel_group: (allow-none): a #GtkAccelGroup.
4567 * Given an accelerator group, @accel_group, and an accelerator path,
4568 * @accel_path, sets up an accelerator in @accel_group so whenever the
4569 * key binding that is defined for @accel_path is pressed, @widget
4570 * will be activated. This removes any accelerators (for any
4571 * accelerator group) installed by previous calls to
4572 * gtk_widget_set_accel_path(). Associating accelerators with
4573 * paths allows them to be modified by the user and the modifications
4574 * to be saved for future use. (See gtk_accel_map_save().)
4576 * This function is a low level function that would most likely
4577 * be used by a menu creation system like #GtkUIManager. If you
4578 * use #GtkUIManager, setting up accelerator paths will be done
4581 * Even when you you aren't using #GtkUIManager, if you only want to
4582 * set up accelerators on menu items gtk_menu_item_set_accel_path()
4583 * provides a somewhat more convenient interface.
4585 * Note that @accel_path string will be stored in a #GQuark. Therefore, if you
4586 * pass a static string, you can save some memory by interning it first with
4587 * g_intern_static_string().
4590 gtk_widget_set_accel_path (GtkWidget *widget,
4591 const gchar *accel_path,
4592 GtkAccelGroup *accel_group)
4596 g_return_if_fail (GTK_IS_WIDGET (widget));
4597 g_return_if_fail (GTK_WIDGET_GET_CLASS (widget)->activate_signal != 0);
4601 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
4602 g_return_if_fail (_gtk_accel_path_is_valid (accel_path));
4604 gtk_accel_map_add_entry (accel_path, 0, 0);
4605 apath = g_slice_new (AccelPath);
4606 apath->accel_group = g_object_ref (accel_group);
4607 apath->path_quark = g_quark_from_string (accel_path);
4608 apath->closure = widget_new_accel_closure (widget, GTK_WIDGET_GET_CLASS (widget)->activate_signal);
4613 /* also removes possible old settings */
4614 g_object_set_qdata_full (G_OBJECT (widget), quark_accel_path, apath, destroy_accel_path);
4617 gtk_accel_group_connect_by_path (apath->accel_group, g_quark_to_string (apath->path_quark), apath->closure);
4619 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
4623 _gtk_widget_get_accel_path (GtkWidget *widget,
4628 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4630 apath = g_object_get_qdata (G_OBJECT (widget), quark_accel_path);
4632 *locked = apath ? apath->accel_group->lock_count > 0 : TRUE;
4633 return apath ? g_quark_to_string (apath->path_quark) : NULL;
4637 * gtk_widget_mnemonic_activate:
4638 * @widget: a #GtkWidget
4639 * @group_cycling: %TRUE if there are other widgets with the same mnemonic
4641 * Emits the #GtkWidget::mnemonic-activate signal.
4643 * The default handler for this signal activates the @widget if
4644 * @group_cycling is %FALSE, and just grabs the focus if @group_cycling
4647 * Returns: %TRUE if the signal has been handled
4650 gtk_widget_mnemonic_activate (GtkWidget *widget,
4651 gboolean group_cycling)
4655 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4657 group_cycling = group_cycling != FALSE;
4658 if (!GTK_WIDGET_IS_SENSITIVE (widget))
4661 g_signal_emit (widget,
4662 widget_signals[MNEMONIC_ACTIVATE],
4670 gtk_widget_real_mnemonic_activate (GtkWidget *widget,
4671 gboolean group_cycling)
4673 if (!group_cycling && GTK_WIDGET_GET_CLASS (widget)->activate_signal)
4674 gtk_widget_activate (widget);
4675 else if (gtk_widget_get_can_focus (widget))
4676 gtk_widget_grab_focus (widget);
4679 g_warning ("widget `%s' isn't suitable for mnemonic activation",
4680 G_OBJECT_TYPE_NAME (widget));
4681 gtk_widget_error_bell (widget);
4687 gtk_widget_real_key_press_event (GtkWidget *widget,
4690 return gtk_bindings_activate_event (GTK_OBJECT (widget), event);
4694 gtk_widget_real_key_release_event (GtkWidget *widget,
4697 return gtk_bindings_activate_event (GTK_OBJECT (widget), event);
4701 gtk_widget_real_focus_in_event (GtkWidget *widget,
4702 GdkEventFocus *event)
4704 gtk_widget_queue_shallow_draw (widget);
4710 gtk_widget_real_focus_out_event (GtkWidget *widget,
4711 GdkEventFocus *event)
4713 gtk_widget_queue_shallow_draw (widget);
4718 #define WIDGET_REALIZED_FOR_EVENT(widget, event) \
4719 (event->type == GDK_FOCUS_CHANGE || GTK_WIDGET_REALIZED(widget))
4723 * @widget: a #GtkWidget
4724 * @event: a #GdkEvent
4726 * Rarely-used function. This function is used to emit
4727 * the event signals on a widget (those signals should never
4728 * be emitted without using this function to do so).
4729 * If you want to synthesize an event though, don't use this function;
4730 * instead, use gtk_main_do_event() so the event will behave as if
4731 * it were in the event queue. Don't synthesize expose events; instead,
4732 * use gdk_window_invalidate_rect() to invalidate a region of the
4735 * Return value: return from the event signal emission (%TRUE if
4736 * the event was handled)
4739 gtk_widget_event (GtkWidget *widget,
4742 g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
4743 g_return_val_if_fail (WIDGET_REALIZED_FOR_EVENT (widget, event), TRUE);
4745 if (event->type == GDK_EXPOSE)
4747 g_warning ("Events of type GDK_EXPOSE cannot be synthesized. To get "
4748 "the same effect, call gdk_window_invalidate_rect/region(), "
4749 "followed by gdk_window_process_updates().");
4753 return gtk_widget_event_internal (widget, event);
4758 * gtk_widget_send_expose:
4759 * @widget: a #GtkWidget
4760 * @event: a expose #GdkEvent
4762 * Very rarely-used function. This function is used to emit
4763 * an expose event signals on a widget. This function is not
4764 * normally used directly. The only time it is used is when
4765 * propagating an expose event to a child %NO_WINDOW widget, and
4766 * that is normally done using gtk_container_propagate_expose().
4768 * If you want to force an area of a window to be redrawn,
4769 * use gdk_window_invalidate_rect() or gdk_window_invalidate_region().
4770 * To cause the redraw to be done immediately, follow that call
4771 * with a call to gdk_window_process_updates().
4773 * Return value: return from the event signal emission (%TRUE if
4774 * the event was handled)
4777 gtk_widget_send_expose (GtkWidget *widget,
4780 g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
4781 g_return_val_if_fail (GTK_WIDGET_REALIZED (widget), TRUE);
4782 g_return_val_if_fail (event != NULL, TRUE);
4783 g_return_val_if_fail (event->type == GDK_EXPOSE, TRUE);
4785 return gtk_widget_event_internal (widget, event);
4789 event_window_is_still_viewable (GdkEvent *event)
4791 /* Some programs, such as gnome-theme-manager, fake widgets
4792 * into exposing onto a pixmap by sending expose events with
4793 * event->window pointing to a pixmap
4795 if (GDK_IS_PIXMAP (event->any.window))
4796 return event->type == GDK_EXPOSE;
4798 /* Check that we think the event's window is viewable before
4799 * delivering the event, to prevent suprises. We do this here
4800 * at the last moment, since the event may have been queued
4801 * up behind other events, held over a recursive main loop, etc.
4803 switch (event->type)
4806 case GDK_MOTION_NOTIFY:
4807 case GDK_BUTTON_PRESS:
4808 case GDK_2BUTTON_PRESS:
4809 case GDK_3BUTTON_PRESS:
4811 case GDK_ENTER_NOTIFY:
4812 case GDK_PROXIMITY_IN:
4814 return event->any.window && gdk_window_is_viewable (event->any.window);
4817 /* The following events are the second half of paired events;
4818 * we always deliver them to deal with widgets that clean up
4819 * on the second half.
4821 case GDK_BUTTON_RELEASE:
4822 case GDK_KEY_RELEASE:
4823 case GDK_LEAVE_NOTIFY:
4824 case GDK_PROXIMITY_OUT:
4828 /* Remaining events would make sense on an not-viewable window,
4829 * or don't have an associated window.
4836 gtk_widget_event_internal (GtkWidget *widget,
4839 gboolean return_val = FALSE;
4841 /* We check only once for is-still-visible; if someone
4842 * hides the window in on of the signals on the widget,
4843 * they are responsible for returning TRUE to terminate
4846 if (!event_window_is_still_viewable (event))
4849 g_object_ref (widget);
4851 g_signal_emit (widget, widget_signals[EVENT], 0, event, &return_val);
4852 return_val |= !WIDGET_REALIZED_FOR_EVENT (widget, event);
4857 switch (event->type)
4862 case GDK_BUTTON_PRESS:
4863 case GDK_2BUTTON_PRESS:
4864 case GDK_3BUTTON_PRESS:
4865 signal_num = BUTTON_PRESS_EVENT;
4868 signal_num = SCROLL_EVENT;
4870 case GDK_BUTTON_RELEASE:
4871 signal_num = BUTTON_RELEASE_EVENT;
4873 case GDK_MOTION_NOTIFY:
4874 signal_num = MOTION_NOTIFY_EVENT;
4877 signal_num = DELETE_EVENT;
4880 signal_num = DESTROY_EVENT;
4881 _gtk_tooltip_hide (widget);
4884 signal_num = KEY_PRESS_EVENT;
4886 case GDK_KEY_RELEASE:
4887 signal_num = KEY_RELEASE_EVENT;
4889 case GDK_ENTER_NOTIFY:
4890 signal_num = ENTER_NOTIFY_EVENT;
4892 case GDK_LEAVE_NOTIFY:
4893 signal_num = LEAVE_NOTIFY_EVENT;
4895 case GDK_FOCUS_CHANGE:
4896 signal_num = event->focus_change.in ? FOCUS_IN_EVENT : FOCUS_OUT_EVENT;
4897 if (event->focus_change.in)
4898 _gtk_tooltip_focus_in (widget);
4900 _gtk_tooltip_focus_out (widget);
4903 signal_num = CONFIGURE_EVENT;
4906 signal_num = MAP_EVENT;
4909 signal_num = UNMAP_EVENT;
4911 case GDK_WINDOW_STATE:
4912 signal_num = WINDOW_STATE_EVENT;
4914 case GDK_PROPERTY_NOTIFY:
4915 signal_num = PROPERTY_NOTIFY_EVENT;
4917 case GDK_SELECTION_CLEAR:
4918 signal_num = SELECTION_CLEAR_EVENT;
4920 case GDK_SELECTION_REQUEST:
4921 signal_num = SELECTION_REQUEST_EVENT;
4923 case GDK_SELECTION_NOTIFY:
4924 signal_num = SELECTION_NOTIFY_EVENT;
4926 case GDK_PROXIMITY_IN:
4927 signal_num = PROXIMITY_IN_EVENT;
4929 case GDK_PROXIMITY_OUT:
4930 signal_num = PROXIMITY_OUT_EVENT;
4933 signal_num = NO_EXPOSE_EVENT;
4935 case GDK_CLIENT_EVENT:
4936 signal_num = CLIENT_EVENT;
4939 signal_num = EXPOSE_EVENT;
4941 case GDK_VISIBILITY_NOTIFY:
4942 signal_num = VISIBILITY_NOTIFY_EVENT;
4944 case GDK_GRAB_BROKEN:
4945 signal_num = GRAB_BROKEN;
4948 signal_num = DAMAGE_EVENT;
4951 g_warning ("gtk_widget_event(): unhandled event type: %d", event->type);
4955 if (signal_num != -1)
4956 g_signal_emit (widget, widget_signals[signal_num], 0, event, &return_val);
4958 if (WIDGET_REALIZED_FOR_EVENT (widget, event))
4959 g_signal_emit (widget, widget_signals[EVENT_AFTER], 0, event);
4963 g_object_unref (widget);
4969 * gtk_widget_activate:
4970 * @widget: a #GtkWidget that's activatable
4972 * For widgets that can be "activated" (buttons, menu items, etc.)
4973 * this function activates them. Activation is what happens when you
4974 * press Enter on a widget during key navigation. If @widget isn't
4975 * activatable, the function returns %FALSE.
4977 * Return value: %TRUE if the widget was activatable
4980 gtk_widget_activate (GtkWidget *widget)
4982 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4984 if (WIDGET_CLASS (widget)->activate_signal)
4986 /* FIXME: we should eventually check the signals signature here */
4987 g_signal_emit (widget, WIDGET_CLASS (widget)->activate_signal, 0);
4996 * gtk_widget_set_scroll_adjustments:
4997 * @widget: a #GtkWidget
4998 * @hadjustment: (allow-none): an adjustment for horizontal scrolling, or %NULL
4999 * @vadjustment: (allow-none): an adjustment for vertical scrolling, or %NULL
5001 * For widgets that support scrolling, sets the scroll adjustments and
5002 * returns %TRUE. For widgets that don't support scrolling, does
5003 * nothing and returns %FALSE. Widgets that don't support scrolling
5004 * can be scrolled by placing them in a #GtkViewport, which does
5005 * support scrolling.
5007 * Return value: %TRUE if the widget supports scrolling
5010 gtk_widget_set_scroll_adjustments (GtkWidget *widget,
5011 GtkAdjustment *hadjustment,
5012 GtkAdjustment *vadjustment)
5017 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5020 g_return_val_if_fail (GTK_IS_ADJUSTMENT (hadjustment), FALSE);
5022 g_return_val_if_fail (GTK_IS_ADJUSTMENT (vadjustment), FALSE);
5024 signal_id = WIDGET_CLASS (widget)->set_scroll_adjustments_signal;
5028 g_signal_query (signal_id, &query);
5029 if (!query.signal_id ||
5030 !g_type_is_a (query.itype, GTK_TYPE_WIDGET) ||
5031 query.return_type != G_TYPE_NONE ||
5032 query.n_params != 2 ||
5033 query.param_types[0] != GTK_TYPE_ADJUSTMENT ||
5034 query.param_types[1] != GTK_TYPE_ADJUSTMENT)
5036 g_warning (G_STRLOC ": signal \"%s::%s\" has wrong signature",
5037 G_OBJECT_TYPE_NAME (widget), query.signal_name);
5041 g_signal_emit (widget, signal_id, 0, hadjustment, vadjustment);
5046 gtk_widget_reparent_subwindows (GtkWidget *widget,
5047 GdkWindow *new_window)
5049 if (GTK_WIDGET_NO_WINDOW (widget))
5051 GList *children = gdk_window_get_children (widget->window);
5054 for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
5056 GdkWindow *window = tmp_list->data;
5059 gdk_window_get_user_data (window, &child);
5060 while (child && child != widget)
5061 child = ((GtkWidget*) child)->parent;
5064 gdk_window_reparent (window, new_window, 0, 0);
5067 g_list_free (children);
5072 GList *tmp_list, *children;
5074 parent = gdk_window_get_parent (widget->window);
5077 gdk_window_reparent (widget->window, new_window, 0, 0);
5080 children = gdk_window_get_children (parent);
5082 for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
5084 GdkWindow *window = tmp_list->data;
5087 gdk_window_get_user_data (window, &child);
5089 if (child == widget)
5090 gdk_window_reparent (window, new_window, 0, 0);
5093 g_list_free (children);
5099 gtk_widget_reparent_fixup_child (GtkWidget *widget,
5100 gpointer client_data)
5102 g_assert (client_data != NULL);
5104 if (GTK_WIDGET_NO_WINDOW (widget))
5107 g_object_unref (widget->window);
5108 widget->window = (GdkWindow*) client_data;
5110 g_object_ref (widget->window);
5112 if (GTK_IS_CONTAINER (widget))
5113 gtk_container_forall (GTK_CONTAINER (widget),
5114 gtk_widget_reparent_fixup_child,
5120 * gtk_widget_reparent:
5121 * @widget: a #GtkWidget
5122 * @new_parent: a #GtkContainer to move the widget into
5124 * Moves a widget from one #GtkContainer to another, handling reference
5125 * count issues to avoid destroying the widget.
5128 gtk_widget_reparent (GtkWidget *widget,
5129 GtkWidget *new_parent)
5131 g_return_if_fail (GTK_IS_WIDGET (widget));
5132 g_return_if_fail (GTK_IS_CONTAINER (new_parent));
5133 g_return_if_fail (widget->parent != NULL);
5135 if (widget->parent != new_parent)
5137 /* First try to see if we can get away without unrealizing
5138 * the widget as we reparent it. if so we set a flag so
5139 * that gtk_widget_unparent doesn't unrealize widget
5141 if (GTK_WIDGET_REALIZED (widget) && GTK_WIDGET_REALIZED (new_parent))
5142 GTK_PRIVATE_SET_FLAG (widget, GTK_IN_REPARENT);
5144 g_object_ref (widget);
5145 gtk_container_remove (GTK_CONTAINER (widget->parent), widget);
5146 gtk_container_add (GTK_CONTAINER (new_parent), widget);
5147 g_object_unref (widget);
5149 if (GTK_WIDGET_IN_REPARENT (widget))
5151 GTK_PRIVATE_UNSET_FLAG (widget, GTK_IN_REPARENT);
5153 gtk_widget_reparent_subwindows (widget, gtk_widget_get_parent_window (widget));
5154 gtk_widget_reparent_fixup_child (widget,
5155 gtk_widget_get_parent_window (widget));
5158 g_object_notify (G_OBJECT (widget), "parent");
5163 * gtk_widget_intersect:
5164 * @widget: a #GtkWidget
5165 * @area: a rectangle
5166 * @intersection: rectangle to store intersection of @widget and @area
5168 * Computes the intersection of a @widget's area and @area, storing
5169 * the intersection in @intersection, and returns %TRUE if there was
5170 * an intersection. @intersection may be %NULL if you're only
5171 * interested in whether there was an intersection.
5173 * Return value: %TRUE if there was an intersection
5176 gtk_widget_intersect (GtkWidget *widget,
5177 const GdkRectangle *area,
5178 GdkRectangle *intersection)
5184 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5185 g_return_val_if_fail (area != NULL, FALSE);
5188 dest = intersection;
5192 return_val = gdk_rectangle_intersect (&widget->allocation, area, dest);
5194 if (return_val && intersection && !GTK_WIDGET_NO_WINDOW (widget))
5196 intersection->x -= widget->allocation.x;
5197 intersection->y -= widget->allocation.y;
5204 * gtk_widget_region_intersect:
5205 * @widget: a #GtkWidget
5206 * @region: a #GdkRegion, in the same coordinate system as
5207 * @widget->allocation. That is, relative to @widget->window
5208 * for %NO_WINDOW widgets; relative to the parent window
5209 * of @widget->window for widgets with their own window.
5210 * @returns: A newly allocated region holding the intersection of @widget
5211 * and @region. The coordinates of the return value are
5212 * relative to @widget->window for %NO_WINDOW widgets, and
5213 * relative to the parent window of @widget->window for
5214 * widgets with their own window.
5216 * Computes the intersection of a @widget's area and @region, returning
5217 * the intersection. The result may be empty, use gdk_region_empty() to
5221 gtk_widget_region_intersect (GtkWidget *widget,
5222 const GdkRegion *region)
5227 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5228 g_return_val_if_fail (region != NULL, NULL);
5230 gtk_widget_get_draw_rectangle (widget, &rect);
5232 dest = gdk_region_rectangle (&rect);
5234 gdk_region_intersect (dest, region);
5240 * _gtk_widget_grab_notify:
5241 * @widget: a #GtkWidget
5242 * @was_grabbed: whether a grab is now in effect
5244 * Emits the #GtkWidget::grab-notify signal on @widget.
5249 _gtk_widget_grab_notify (GtkWidget *widget,
5250 gboolean was_grabbed)
5252 g_signal_emit (widget, widget_signals[GRAB_NOTIFY], 0, was_grabbed);
5256 * gtk_widget_grab_focus:
5257 * @widget: a #GtkWidget
5259 * Causes @widget to have the keyboard focus for the #GtkWindow it's
5260 * inside. @widget must be a focusable widget, such as a #GtkEntry;
5261 * something like #GtkFrame won't work.
5263 * More precisely, it must have the %GTK_CAN_FOCUS flag set. Use
5264 * gtk_widget_set_can_focus() to modify that flag.
5267 gtk_widget_grab_focus (GtkWidget *widget)
5269 g_return_if_fail (GTK_IS_WIDGET (widget));
5271 if (!GTK_WIDGET_IS_SENSITIVE (widget))
5274 g_object_ref (widget);
5275 g_signal_emit (widget, widget_signals[GRAB_FOCUS], 0);
5276 g_object_notify (G_OBJECT (widget), "has-focus");
5277 g_object_unref (widget);
5281 reset_focus_recurse (GtkWidget *widget,
5284 if (GTK_IS_CONTAINER (widget))
5286 GtkContainer *container;
5288 container = GTK_CONTAINER (widget);
5289 gtk_container_set_focus_child (container, NULL);
5291 gtk_container_foreach (container,
5292 reset_focus_recurse,
5298 gtk_widget_real_grab_focus (GtkWidget *focus_widget)
5300 if (gtk_widget_get_can_focus (focus_widget))
5302 GtkWidget *toplevel;
5305 /* clear the current focus setting, break if the current widget
5306 * is the focus widget's parent, since containers above that will
5307 * be set by the next loop.
5309 toplevel = gtk_widget_get_toplevel (focus_widget);
5310 if (gtk_widget_is_toplevel (toplevel) && GTK_IS_WINDOW (toplevel))
5312 widget = GTK_WINDOW (toplevel)->focus_widget;
5314 if (widget == focus_widget)
5316 /* We call _gtk_window_internal_set_focus() here so that the
5317 * toplevel window can request the focus if necessary.
5318 * This is needed when the toplevel is a GtkPlug
5320 if (!GTK_WIDGET_HAS_FOCUS (widget))
5321 _gtk_window_internal_set_focus (GTK_WINDOW (toplevel), focus_widget);
5328 while (widget->parent && widget->parent != focus_widget->parent)
5330 widget = widget->parent;
5331 gtk_container_set_focus_child (GTK_CONTAINER (widget), NULL);
5335 else if (toplevel != focus_widget)
5337 /* gtk_widget_grab_focus() operates on a tree without window...
5338 * actually, this is very questionable behaviour.
5341 gtk_container_foreach (GTK_CONTAINER (toplevel),
5342 reset_focus_recurse,
5346 /* now propagate the new focus up the widget tree and finally
5347 * set it on the window
5349 widget = focus_widget;
5350 while (widget->parent)
5352 gtk_container_set_focus_child (GTK_CONTAINER (widget->parent), widget);
5353 widget = widget->parent;
5355 if (GTK_IS_WINDOW (widget))
5356 _gtk_window_internal_set_focus (GTK_WINDOW (widget), focus_widget);
5361 gtk_widget_real_query_tooltip (GtkWidget *widget,
5364 gboolean keyboard_tip,
5365 GtkTooltip *tooltip)
5367 gchar *tooltip_markup;
5368 gboolean has_tooltip;
5370 tooltip_markup = g_object_get_qdata (G_OBJECT (widget), quark_tooltip_markup);
5371 has_tooltip = GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (widget), quark_has_tooltip));
5373 if (has_tooltip && tooltip_markup)
5375 gtk_tooltip_set_markup (tooltip, tooltip_markup);
5383 gtk_widget_real_show_help (GtkWidget *widget,
5384 GtkWidgetHelpType help_type)
5386 if (help_type == GTK_WIDGET_HELP_TOOLTIP)
5388 _gtk_tooltip_toggle_keyboard_mode (widget);
5397 gtk_widget_real_focus (GtkWidget *widget,
5398 GtkDirectionType direction)
5400 if (!gtk_widget_get_can_focus (widget))
5403 if (!gtk_widget_is_focus (widget))
5405 gtk_widget_grab_focus (widget);
5413 gtk_widget_real_move_focus (GtkWidget *widget,
5414 GtkDirectionType direction)
5416 GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
5418 if (GTK_IS_WINDOW (toplevel) &&
5419 GTK_WINDOW_GET_CLASS (toplevel)->move_focus)
5421 GTK_WINDOW_GET_CLASS (toplevel)->move_focus (GTK_WINDOW (toplevel),
5427 gtk_widget_real_keynav_failed (GtkWidget *widget,
5428 GtkDirectionType direction)
5430 gboolean cursor_only;
5434 case GTK_DIR_TAB_FORWARD:
5435 case GTK_DIR_TAB_BACKWARD:
5442 g_object_get (gtk_widget_get_settings (widget),
5443 "gtk-keynav-cursor-only", &cursor_only,
5450 gtk_widget_error_bell (widget);
5456 * gtk_widget_set_can_focus:
5457 * @widget: a #GtkWidget
5458 * @can_focus: whether or not @widget can own the input focus.
5460 * Specifies whether @widget can own the input focus. See
5461 * gtk_widget_grab_focus() for actually setting the input focus on a
5467 gtk_widget_set_can_focus (GtkWidget *widget,
5470 g_return_if_fail (GTK_IS_WIDGET (widget));
5472 if (can_focus != gtk_widget_get_can_focus (widget))
5475 GTK_WIDGET_SET_FLAGS (widget, GTK_CAN_FOCUS);
5477 GTK_WIDGET_UNSET_FLAGS (widget, GTK_CAN_FOCUS);
5479 gtk_widget_queue_resize (widget);
5480 g_object_notify (G_OBJECT (widget), "can-focus");
5485 * gtk_widget_get_can_focus:
5486 * @widget: a #GtkWidget
5488 * Determines whether @widget can own the input focus. See
5489 * gtk_widget_set_can_focus().
5491 * Return value: %TRUE if @widget can own the input focus, %FALSE otherwise
5496 gtk_widget_get_can_focus (GtkWidget *widget)
5498 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5500 return (GTK_WIDGET_FLAGS (widget) & GTK_CAN_FOCUS) != 0;
5504 * gtk_widget_has_focus:
5505 * @widget: a #GtkWidget
5507 * Determines if the widget has the global input focus. See
5508 * gtk_widget_is_focus() for the difference between having the global
5509 * input focus, and only having the focus within a toplevel.
5511 * Return value: %TRUE if the widget has the global input focus.
5516 gtk_widget_has_focus (GtkWidget *widget)
5518 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5520 return GTK_WIDGET_HAS_FOCUS (widget);
5524 * gtk_widget_is_focus:
5525 * @widget: a #GtkWidget
5527 * Determines if the widget is the focus widget within its
5528 * toplevel. (This does not mean that the %HAS_FOCUS flag is
5529 * necessarily set; %HAS_FOCUS will only be set if the
5530 * toplevel widget additionally has the global input focus.)
5532 * Return value: %TRUE if the widget is the focus widget.
5535 gtk_widget_is_focus (GtkWidget *widget)
5537 GtkWidget *toplevel;
5539 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5541 toplevel = gtk_widget_get_toplevel (widget);
5543 if (GTK_IS_WINDOW (toplevel))
5544 return widget == GTK_WINDOW (toplevel)->focus_widget;
5550 * gtk_widget_set_can_default:
5551 * @widget: a #GtkWidget
5552 * @can_default: whether or not @widget can be a default widget.
5554 * Specifies whether @widget can be a default widget. See
5555 * gtk_widget_grab_default() for details about the meaning of
5561 gtk_widget_set_can_default (GtkWidget *widget,
5562 gboolean can_default)
5564 g_return_if_fail (GTK_IS_WIDGET (widget));
5566 if (can_default != gtk_widget_get_can_default (widget))
5569 GTK_WIDGET_SET_FLAGS (widget, GTK_CAN_DEFAULT);
5571 GTK_WIDGET_UNSET_FLAGS (widget, GTK_CAN_DEFAULT);
5573 gtk_widget_queue_resize (widget);
5574 g_object_notify (G_OBJECT (widget), "can-default");
5579 * gtk_widget_get_can_default:
5580 * @widget: a #GtkWidget
5582 * Determines whether @widget can be a default widget. See
5583 * gtk_widget_set_can_default().
5585 * Return value: %TRUE if @widget can be a default widget, %FALSE otherwise
5590 gtk_widget_get_can_default (GtkWidget *widget)
5592 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5594 return (GTK_WIDGET_FLAGS (widget) & GTK_CAN_DEFAULT) != 0;
5598 * gtk_widget_has_default:
5599 * @widget: a #GtkWidget
5601 * Determines whether @widget is the current default widget within its
5602 * toplevel. See gtk_widget_set_can_default().
5604 * Return value: %TRUE if @widget is the current default widget within
5605 * its toplevel, %FALSE otherwise
5610 gtk_widget_has_default (GtkWidget *widget)
5612 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5614 return (GTK_WIDGET_FLAGS (widget) & GTK_HAS_DEFAULT) != 0;
5618 * gtk_widget_grab_default:
5619 * @widget: a #GtkWidget
5621 * Causes @widget to become the default widget. @widget must have the
5622 * %GTK_CAN_DEFAULT flag set; typically you have to set this flag
5623 * yourself by calling <literal>gtk_widget_set_can_default (@widget,
5624 * %TRUE)</literal>. The default widget is activated when
5625 * the user presses Enter in a window. Default widgets must be
5626 * activatable, that is, gtk_widget_activate() should affect them.
5629 gtk_widget_grab_default (GtkWidget *widget)
5633 g_return_if_fail (GTK_IS_WIDGET (widget));
5634 g_return_if_fail (gtk_widget_get_can_default (widget));
5636 window = gtk_widget_get_toplevel (widget);
5638 if (window && gtk_widget_is_toplevel (window))
5639 gtk_window_set_default (GTK_WINDOW (window), widget);
5641 g_warning (G_STRLOC ": widget not within a GtkWindow");
5645 * gtk_widget_set_receives_default:
5646 * @widget: a #GtkWidget
5647 * @receives_default: whether or not @widget can be a default widget.
5649 * Specifies whether @widget will be treated as the default widget
5650 * within its toplevel when it has the focus, even if another widget
5653 * See gtk_widget_grab_default() for details about the meaning of
5659 gtk_widget_set_receives_default (GtkWidget *widget,
5660 gboolean receives_default)
5662 g_return_if_fail (GTK_IS_WIDGET (widget));
5664 if (receives_default != gtk_widget_get_receives_default (widget))
5666 if (receives_default)
5667 GTK_WIDGET_SET_FLAGS (widget, GTK_RECEIVES_DEFAULT);
5669 GTK_WIDGET_UNSET_FLAGS (widget, GTK_RECEIVES_DEFAULT);
5671 g_object_notify (G_OBJECT (widget), "receives-default");
5676 * gtk_widget_get_receives_default:
5677 * @widget: a #GtkWidget
5679 * Determines whether @widget is alyways treated as default widget
5680 * withing its toplevel when it has the focus, even if another widget
5683 * See gtk_widget_set_receives_default().
5685 * Return value: %TRUE if @widget acts as default widget when focussed,
5691 gtk_widget_get_receives_default (GtkWidget *widget)
5693 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5695 return (GTK_WIDGET_FLAGS (widget) & GTK_RECEIVES_DEFAULT) != 0;
5699 * gtk_widget_has_grab:
5700 * @widget: a #GtkWidget
5702 * Determines whether the widget is currently grabbing events, so it
5703 * is the only widget receiving input events (keyboard and mouse).
5705 * See also gtk_grab_add().
5707 * Return value: %TRUE if the widget is in the grab_widgets stack
5712 gtk_widget_has_grab (GtkWidget *widget)
5714 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5716 return (GTK_WIDGET_FLAGS (widget) & GTK_HAS_GRAB) != 0;
5720 * gtk_widget_set_name:
5721 * @widget: a #GtkWidget
5722 * @name: name for the widget
5724 * Widgets can be named, which allows you to refer to them from a
5725 * gtkrc file. You can apply a style to widgets with a particular name
5726 * in the gtkrc file. See the documentation for gtkrc files (on the
5727 * same page as the docs for #GtkRcStyle).
5729 * Note that widget names are separated by periods in paths (see
5730 * gtk_widget_path()), so names with embedded periods may cause confusion.
5733 gtk_widget_set_name (GtkWidget *widget,
5738 g_return_if_fail (GTK_IS_WIDGET (widget));
5740 new_name = g_strdup (name);
5741 g_free (widget->name);
5742 widget->name = new_name;
5744 if (gtk_widget_has_rc_style (widget))
5745 gtk_widget_reset_rc_style (widget);
5747 g_object_notify (G_OBJECT (widget), "name");
5751 * gtk_widget_get_name:
5752 * @widget: a #GtkWidget
5754 * Retrieves the name of a widget. See gtk_widget_set_name() for the
5755 * significance of widget names.
5757 * Return value: name of the widget. This string is owned by GTK+ and
5758 * should not be modified or freed
5760 G_CONST_RETURN gchar*
5761 gtk_widget_get_name (GtkWidget *widget)
5763 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5766 return widget->name;
5767 return G_OBJECT_TYPE_NAME (widget);
5771 * gtk_widget_set_state:
5772 * @widget: a #GtkWidget
5773 * @state: new state for @widget
5775 * This function is for use in widget implementations. Sets the state
5776 * of a widget (insensitive, prelighted, etc.) Usually you should set
5777 * the state using wrapper functions such as gtk_widget_set_sensitive().
5780 gtk_widget_set_state (GtkWidget *widget,
5783 g_return_if_fail (GTK_IS_WIDGET (widget));
5785 if (state == GTK_WIDGET_STATE (widget))
5788 if (state == GTK_STATE_INSENSITIVE)
5789 gtk_widget_set_sensitive (widget, FALSE);
5795 data.state_restoration = FALSE;
5796 data.use_forall = FALSE;
5798 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget->parent) != FALSE);
5800 data.parent_sensitive = TRUE;
5802 gtk_widget_propagate_state (widget, &data);
5804 if (GTK_WIDGET_DRAWABLE (widget))
5805 gtk_widget_queue_draw (widget);
5810 * gtk_widget_get_state:
5811 * @widget: a #GtkWidget
5813 * Returns the widget's state. See gtk_widget_set_state().
5815 * Returns: the state of @widget.
5820 gtk_widget_get_state (GtkWidget *widget)
5822 g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_STATE_NORMAL);
5824 return widget->state;
5828 * gtk_widget_set_visible:
5829 * @widget: a #GtkWidget
5830 * @visible: whether the widget should be shown or not
5832 * Sets the visibility state of @widget. Note that setting this to
5833 * %TRUE doesn't mean the widget is actually viewable, see
5834 * gtk_widget_get_visible().
5836 * This function simply calls gtk_widget_show() or gtk_widget_hide()
5837 * but is nicer to use when the visibility of the widget depends on
5843 gtk_widget_set_visible (GtkWidget *widget,
5846 g_return_if_fail (GTK_IS_WIDGET (widget));
5848 if (visible != GTK_WIDGET_VISIBLE (widget))
5851 gtk_widget_show (widget);
5853 gtk_widget_hide (widget);
5858 * gtk_widget_get_visible:
5859 * @widget: a #GtkWidget
5861 * Determines whether the widget is visible. Note that this doesn't
5862 * take into account whether the widget's parent is also visible
5863 * or the widget is obscured in any way.
5865 * See gtk_widget_set_visible().
5867 * Return value: %TRUE if the widget is visible
5872 gtk_widget_get_visible (GtkWidget *widget)
5874 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5876 return (GTK_WIDGET_FLAGS (widget) & GTK_VISIBLE) != 0;
5880 * gtk_widget_set_has_window:
5881 * @widget: a #GtkWidget
5882 * @has_window: whether or not @widget has a window.
5884 * Specifies whether @widget has a #GdkWindow of its own. Note that
5885 * all realized widgets have a non-%NULL "window" pointer
5886 * (gtk_widget_get_window() never returns a %NULL window when a widget
5887 * is realized), but for many of them it's actually the #GdkWindow of
5888 * one of its parent widgets. Widgets that create a %window for
5889 * themselves in GtkWidget::realize() however must announce this by
5890 * calling this function with @has_window = %TRUE.
5892 * This function should only be called by widget implementations,
5893 * and they should call it in their init() function.
5898 gtk_widget_set_has_window (GtkWidget *widget,
5899 gboolean has_window)
5901 g_return_if_fail (GTK_IS_WIDGET (widget));
5904 GTK_WIDGET_UNSET_FLAGS (widget, GTK_NO_WINDOW);
5906 GTK_WIDGET_SET_FLAGS (widget, GTK_NO_WINDOW);
5910 * gtk_widget_get_has_window:
5911 * @widget: a #GtkWidget
5913 * Determines whether @widget has a #GdkWindow of its own. See
5914 * gtk_widget_set_has_window().
5916 * Return value: %TRUE if @widget has a window, %FALSE otherwise
5921 gtk_widget_get_has_window (GtkWidget *widget)
5923 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5925 return !GTK_WIDGET_NO_WINDOW (widget);
5929 * gtk_widget_is_toplevel:
5930 * @widget: a #GtkWidget
5932 * Determines whether @widget is a toplevel widget. Currently only
5933 * #GtkWindow and #GtkInvisible are toplevel widgets. Toplevel
5934 * widgets have no parent widget.
5936 * Return value: %TRUE if @widget is a toplevel, %FALSE otherwise
5941 gtk_widget_is_toplevel (GtkWidget *widget)
5943 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5945 return (GTK_WIDGET_FLAGS (widget) & GTK_TOPLEVEL) != 0;
5949 * gtk_widget_is_drawable:
5950 * @widget: a #GtkWidget
5952 * Determines whether @widget can be drawn to. A widget can be drawn
5953 * to if it is mapped and visible.
5955 * Return value: %TRUE if @widget is drawable, %FALSE otherwise
5960 gtk_widget_is_drawable (GtkWidget *widget)
5962 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5964 return ((GTK_WIDGET_FLAGS (widget) & GTK_VISIBLE) != 0 &&
5965 (GTK_WIDGET_FLAGS (widget) & GTK_MAPPED) != 0);
5969 * gtk_widget_get_realized:
5970 * @widget: a #GtkWidget
5972 * Determines whether @widget is realized.
5974 * Return value: %TRUE if @widget is realized, %FALSE otherwise
5979 gtk_widget_get_realized (GtkWidget *widget)
5981 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5983 return (GTK_WIDGET_FLAGS (widget) & GTK_REALIZED) != 0;
5987 * gtk_widget_set_realized:
5988 * @widget: a #GtkWidget
5989 * @realized: %TRUE to mark the widget as realized
5991 * Marks the widget as being realized.
5993 * This function should only ever be called in a derived widget's
5994 * "realize" or "unrealize" implementation.
5999 gtk_widget_set_realized (GtkWidget *widget,
6002 g_return_if_fail (GTK_IS_WIDGET (widget));
6005 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
6007 GTK_WIDGET_UNSET_FLAGS (widget, GTK_REALIZED);
6011 * gtk_widget_get_mapped:
6012 * @widget: a #GtkWidget
6014 * Whether the widget is mapped.
6016 * Return value: %TRUE if the widget is mapped, %FALSE otherwise.
6021 gtk_widget_get_mapped (GtkWidget *widget)
6023 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6025 return (GTK_WIDGET_FLAGS (widget) & GTK_MAPPED) != 0;
6029 * gtk_widget_set_mapped:
6030 * @widget: a #GtkWidget
6031 * @mapped: %TRUE to mark the widget as mapped
6033 * Marks the widget as being realized.
6035 * This function should only ever be called in a derived widget's
6036 * "map" or "unmap" implementation.
6041 gtk_widget_set_mapped (GtkWidget *widget,
6044 g_return_if_fail (GTK_IS_WIDGET (widget));
6047 GTK_WIDGET_SET_FLAGS (widget, GTK_MAPPED);
6049 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
6053 * gtk_widget_set_app_paintable:
6054 * @widget: a #GtkWidget
6055 * @app_paintable: %TRUE if the application will paint on the widget
6057 * Sets whether the application intends to draw on the widget in
6058 * an #GtkWidget::expose-event handler.
6060 * This is a hint to the widget and does not affect the behavior of
6061 * the GTK+ core; many widgets ignore this flag entirely. For widgets
6062 * that do pay attention to the flag, such as #GtkEventBox and #GtkWindow,
6063 * the effect is to suppress default themed drawing of the widget's
6064 * background. (Children of the widget will still be drawn.) The application
6065 * is then entirely responsible for drawing the widget background.
6067 * Note that the background is still drawn when the widget is mapped.
6068 * If this is not suitable (e.g. because you want to make a transparent
6069 * window using an RGBA visual), you can work around this by doing:
6071 * gtk_widget_realize (window);
6072 * gdk_window_set_back_pixmap (window->window, NULL, FALSE);
6073 * gtk_widget_show (window);
6077 gtk_widget_set_app_paintable (GtkWidget *widget,
6078 gboolean app_paintable)
6080 g_return_if_fail (GTK_IS_WIDGET (widget));
6082 app_paintable = (app_paintable != FALSE);
6084 if (gtk_widget_get_app_paintable (widget) != app_paintable)
6087 GTK_WIDGET_SET_FLAGS (widget, GTK_APP_PAINTABLE);
6089 GTK_WIDGET_UNSET_FLAGS (widget, GTK_APP_PAINTABLE);
6091 if (GTK_WIDGET_DRAWABLE (widget))
6092 gtk_widget_queue_draw (widget);
6094 g_object_notify (G_OBJECT (widget), "app-paintable");
6099 * gtk_widget_get_app_paintable:
6100 * @widget: a #GtkWidget
6102 * Determines whether the application intends to draw on the widget in
6103 * an #GtkWidget::expose-event handler.
6105 * See gtk_widget_set_app_paintable()
6107 * Return value: %TRUE if the widget is app paintable
6112 gtk_widget_get_app_paintable (GtkWidget *widget)
6114 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6116 return (GTK_WIDGET_FLAGS (widget) & GTK_APP_PAINTABLE) != 0;
6120 * gtk_widget_set_double_buffered:
6121 * @widget: a #GtkWidget
6122 * @double_buffered: %TRUE to double-buffer a widget
6124 * Widgets are double buffered by default; you can use this function
6125 * to turn off the buffering. "Double buffered" simply means that
6126 * gdk_window_begin_paint_region() and gdk_window_end_paint() are called
6127 * automatically around expose events sent to the
6128 * widget. gdk_window_begin_paint() diverts all drawing to a widget's
6129 * window to an offscreen buffer, and gdk_window_end_paint() draws the
6130 * buffer to the screen. The result is that users see the window
6131 * update in one smooth step, and don't see individual graphics
6132 * primitives being rendered.
6134 * In very simple terms, double buffered widgets don't flicker,
6135 * so you would only use this function to turn off double buffering
6136 * if you had special needs and really knew what you were doing.
6138 * Note: if you turn off double-buffering, you have to handle
6139 * expose events, since even the clearing to the background color or
6140 * pixmap will not happen automatically (as it is done in
6141 * gdk_window_begin_paint()).
6144 gtk_widget_set_double_buffered (GtkWidget *widget,
6145 gboolean double_buffered)
6147 g_return_if_fail (GTK_IS_WIDGET (widget));
6149 double_buffered = (double_buffered != FALSE);
6151 if (double_buffered != gtk_widget_get_double_buffered (widget))
6153 if (double_buffered)
6154 GTK_WIDGET_SET_FLAGS (widget, GTK_DOUBLE_BUFFERED);
6156 GTK_WIDGET_UNSET_FLAGS (widget, GTK_DOUBLE_BUFFERED);
6158 g_object_notify (G_OBJECT (widget), "double-buffered");
6163 * gtk_widget_get_double_buffered:
6164 * @widget: a #GtkWidget
6166 * Determines whether the widget is double buffered.
6168 * See gtk_widget_set_double_buffered()
6170 * Return value: %TRUE if the widget is double buffered
6175 gtk_widget_get_double_buffered (GtkWidget *widget)
6177 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6179 return (GTK_WIDGET_FLAGS (widget) & GTK_DOUBLE_BUFFERED) != 0;
6183 * gtk_widget_set_redraw_on_allocate:
6184 * @widget: a #GtkWidget
6185 * @redraw_on_allocate: if %TRUE, the entire widget will be redrawn
6186 * when it is allocated to a new size. Otherwise, only the
6187 * new portion of the widget will be redrawn.
6189 * Sets whether the entire widget is queued for drawing when its size
6190 * allocation changes. By default, this setting is %TRUE and
6191 * the entire widget is redrawn on every size change. If your widget
6192 * leaves the upper left unchanged when made bigger, turning this
6193 * setting off will improve performance.
6195 * Note that for %NO_WINDOW widgets setting this flag to %FALSE turns
6196 * off all allocation on resizing: the widget will not even redraw if
6197 * its position changes; this is to allow containers that don't draw
6198 * anything to avoid excess invalidations. If you set this flag on a
6199 * %NO_WINDOW widget that <emphasis>does</emphasis> draw on @widget->window,
6200 * you are responsible for invalidating both the old and new allocation
6201 * of the widget when the widget is moved and responsible for invalidating
6202 * regions newly when the widget increases size.
6205 gtk_widget_set_redraw_on_allocate (GtkWidget *widget,
6206 gboolean redraw_on_allocate)
6208 g_return_if_fail (GTK_IS_WIDGET (widget));
6210 if (redraw_on_allocate)
6211 GTK_PRIVATE_SET_FLAG (widget, GTK_REDRAW_ON_ALLOC);
6213 GTK_PRIVATE_UNSET_FLAG (widget, GTK_REDRAW_ON_ALLOC);
6217 * gtk_widget_set_sensitive:
6218 * @widget: a #GtkWidget
6219 * @sensitive: %TRUE to make the widget sensitive
6221 * Sets the sensitivity of a widget. A widget is sensitive if the user
6222 * can interact with it. Insensitive widgets are "grayed out" and the
6223 * user can't interact with them. Insensitive widgets are known as
6224 * "inactive", "disabled", or "ghosted" in some other toolkits.
6227 gtk_widget_set_sensitive (GtkWidget *widget,
6232 g_return_if_fail (GTK_IS_WIDGET (widget));
6234 sensitive = (sensitive != FALSE);
6236 if (sensitive == (GTK_WIDGET_SENSITIVE (widget) != FALSE))
6241 GTK_WIDGET_SET_FLAGS (widget, GTK_SENSITIVE);
6242 data.state = widget->saved_state;
6246 GTK_WIDGET_UNSET_FLAGS (widget, GTK_SENSITIVE);
6247 data.state = GTK_WIDGET_STATE (widget);
6249 data.state_restoration = TRUE;
6250 data.use_forall = TRUE;
6253 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget->parent) != FALSE);
6255 data.parent_sensitive = TRUE;
6257 gtk_widget_propagate_state (widget, &data);
6258 if (GTK_WIDGET_DRAWABLE (widget))
6259 gtk_widget_queue_draw (widget);
6261 g_object_notify (G_OBJECT (widget), "sensitive");
6265 * gtk_widget_get_sensitive:
6266 * @widget: a #GtkWidget
6268 * Returns the widget's sensitivity (in the sense of returning
6269 * the value that has been set using gtk_widget_set_sensitive()).
6271 * The effective sensitivity of a widget is however determined by both its
6272 * own and its parent widget's sensitivity. See gtk_widget_is_sensitive().
6274 * Returns: %TRUE if the widget is sensitive
6279 gtk_widget_get_sensitive (GtkWidget *widget)
6281 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6283 return GTK_WIDGET_SENSITIVE (widget);
6287 * gtk_widget_is_sensitive:
6288 * @widget: a #GtkWidget
6290 * Returns the widget's effective sensitivity, which means
6291 * it is sensitive itself and also its parent widget is sensntive
6293 * Returns: %TRUE if the widget is effectively sensitive
6298 gtk_widget_is_sensitive (GtkWidget *widget)
6300 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6302 return GTK_WIDGET_IS_SENSITIVE (widget);
6306 * gtk_widget_set_parent:
6307 * @widget: a #GtkWidget
6308 * @parent: parent container
6310 * This function is useful only when implementing subclasses of
6312 * Sets the container as the parent of @widget, and takes care of
6313 * some details such as updating the state and style of the child
6314 * to reflect its new location. The opposite function is
6315 * gtk_widget_unparent().
6318 gtk_widget_set_parent (GtkWidget *widget,
6323 g_return_if_fail (GTK_IS_WIDGET (widget));
6324 g_return_if_fail (GTK_IS_WIDGET (parent));
6325 g_return_if_fail (widget != parent);
6326 if (widget->parent != NULL)
6328 g_warning ("Can't set a parent on widget which has a parent\n");
6331 if (gtk_widget_is_toplevel (widget))
6333 g_warning ("Can't set a parent on a toplevel widget\n");
6337 /* keep this function in sync with gtk_menu_attach_to_widget()
6340 g_object_ref_sink (widget);
6341 widget->parent = parent;
6343 if (GTK_WIDGET_STATE (parent) != GTK_STATE_NORMAL)
6344 data.state = GTK_WIDGET_STATE (parent);
6346 data.state = GTK_WIDGET_STATE (widget);
6347 data.state_restoration = FALSE;
6348 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (parent) != FALSE);
6349 data.use_forall = GTK_WIDGET_IS_SENSITIVE (parent) != GTK_WIDGET_IS_SENSITIVE (widget);
6351 gtk_widget_propagate_state (widget, &data);
6353 gtk_widget_reset_rc_styles (widget);
6355 g_signal_emit (widget, widget_signals[PARENT_SET], 0, NULL);
6356 if (GTK_WIDGET_ANCHORED (widget->parent))
6357 _gtk_widget_propagate_hierarchy_changed (widget, NULL);
6358 g_object_notify (G_OBJECT (widget), "parent");
6360 /* Enforce realized/mapped invariants
6362 if (GTK_WIDGET_REALIZED (widget->parent))
6363 gtk_widget_realize (widget);
6365 if (GTK_WIDGET_VISIBLE (widget->parent) &&
6366 GTK_WIDGET_VISIBLE (widget))
6368 if (GTK_WIDGET_CHILD_VISIBLE (widget) &&
6369 GTK_WIDGET_MAPPED (widget->parent))
6370 gtk_widget_map (widget);
6372 gtk_widget_queue_resize (widget);
6377 * gtk_widget_get_parent:
6378 * @widget: a #GtkWidget
6380 * Returns the parent container of @widget.
6382 * Return value: (transfer none): the parent container of @widget, or %NULL
6385 gtk_widget_get_parent (GtkWidget *widget)
6387 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6389 return widget->parent;
6392 /*****************************************
6394 * see docs/styles.txt
6395 *****************************************/
6398 * gtk_widget_style_attach:
6399 * @widget: a #GtkWidget
6401 * This function attaches the widget's #GtkStyle to the widget's
6402 * #GdkWindow. It is a replacement for
6405 * widget->style = gtk_style_attach (widget->style, widget->window);
6408 * and should only ever be called in a derived widget's "realize"
6409 * implementation which does not chain up to its parent class'
6410 * "realize" implementation, because one of the parent classes
6411 * (finally #GtkWidget) would attach the style itself.
6416 gtk_widget_style_attach (GtkWidget *widget)
6418 g_return_if_fail (GTK_IS_WIDGET (widget));
6419 g_return_if_fail (GTK_WIDGET_REALIZED (widget));
6421 widget->style = gtk_style_attach (widget->style, widget->window);
6425 * gtk_widget_has_rc_style:
6426 * @widget: a #GtkWidget
6428 * Determines if the widget style has been looked up through the rc mechanism.
6430 * Returns: %TRUE if the widget has been looked up through the rc
6431 * mechanism, %FALSE otherwise.
6436 gtk_widget_has_rc_style (GtkWidget *widget)
6438 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
6440 return (GTK_WIDGET_FLAGS (widget) & GTK_RC_STYLE) != 0;
6444 * gtk_widget_set_style:
6445 * @widget: a #GtkWidget
6446 * @style: (allow-none): a #GtkStyle, or %NULL to remove the effect of a previous
6447 * gtk_widget_set_style() and go back to the default style
6449 * Sets the #GtkStyle for a widget (@widget->style). You probably don't
6450 * want to use this function; it interacts badly with themes, because
6451 * themes work by replacing the #GtkStyle. Instead, use
6452 * gtk_widget_modify_style().
6455 gtk_widget_set_style (GtkWidget *widget,
6458 g_return_if_fail (GTK_IS_WIDGET (widget));
6462 gboolean initial_emission;
6464 initial_emission = !gtk_widget_has_rc_style (widget) && !GTK_WIDGET_USER_STYLE (widget);
6466 GTK_WIDGET_UNSET_FLAGS (widget, GTK_RC_STYLE);
6467 GTK_PRIVATE_SET_FLAG (widget, GTK_USER_STYLE);
6469 gtk_widget_set_style_internal (widget, style, initial_emission);
6473 if (GTK_WIDGET_USER_STYLE (widget))
6474 gtk_widget_reset_rc_style (widget);
6479 * gtk_widget_ensure_style:
6480 * @widget: a #GtkWidget
6482 * Ensures that @widget has a style (@widget->style). Not a very useful
6483 * function; most of the time, if you want the style, the widget is
6484 * realized, and realized widgets are guaranteed to have a style
6488 gtk_widget_ensure_style (GtkWidget *widget)
6490 g_return_if_fail (GTK_IS_WIDGET (widget));
6492 if (!GTK_WIDGET_USER_STYLE (widget) &&
6493 !gtk_widget_has_rc_style (widget))
6494 gtk_widget_reset_rc_style (widget);
6497 /* Look up the RC style for this widget, unsetting any user style that
6498 * may be in effect currently
6501 gtk_widget_reset_rc_style (GtkWidget *widget)
6503 GtkStyle *new_style = NULL;
6504 gboolean initial_emission;
6506 initial_emission = !gtk_widget_has_rc_style (widget) && !GTK_WIDGET_USER_STYLE (widget);
6508 GTK_PRIVATE_UNSET_FLAG (widget, GTK_USER_STYLE);
6509 GTK_WIDGET_SET_FLAGS (widget, GTK_RC_STYLE);
6511 if (gtk_widget_has_screen (widget))
6512 new_style = gtk_rc_get_style (widget);
6514 new_style = gtk_widget_get_default_style ();
6516 if (initial_emission || new_style != widget->style)
6517 gtk_widget_set_style_internal (widget, new_style, initial_emission);
6521 * gtk_widget_get_style:
6522 * @widget: a #GtkWidget
6524 * Simply an accessor function that returns @widget->style.
6526 * Return value: (transfer none): the widget's #GtkStyle
6529 gtk_widget_get_style (GtkWidget *widget)
6531 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6533 return widget->style;
6537 * gtk_widget_modify_style:
6538 * @widget: a #GtkWidget
6539 * @style: the #GtkRcStyle holding the style modifications
6541 * Modifies style values on the widget. Modifications made using this
6542 * technique take precedence over style values set via an RC file,
6543 * however, they will be overriden if a style is explicitely set on
6544 * the widget using gtk_widget_set_style(). The #GtkRcStyle structure
6545 * is designed so each field can either be set or unset, so it is
6546 * possible, using this function, to modify some style values and
6547 * leave the others unchanged.
6549 * Note that modifications made with this function are not cumulative
6550 * with previous calls to gtk_widget_modify_style() or with such
6551 * functions as gtk_widget_modify_fg(). If you wish to retain
6552 * previous values, you must first call gtk_widget_get_modifier_style(),
6553 * make your modifications to the returned style, then call
6554 * gtk_widget_modify_style() with that style. On the other hand,
6555 * if you first call gtk_widget_modify_style(), subsequent calls
6556 * to such functions gtk_widget_modify_fg() will have a cumulative
6557 * effect with the initial modifications.
6560 gtk_widget_modify_style (GtkWidget *widget,
6563 g_return_if_fail (GTK_IS_WIDGET (widget));
6564 g_return_if_fail (GTK_IS_RC_STYLE (style));
6566 g_object_set_qdata_full (G_OBJECT (widget),
6568 gtk_rc_style_copy (style),
6569 (GDestroyNotify) g_object_unref);
6571 /* note that "style" may be invalid here if it was the old
6572 * modifier style and the only reference was our own.
6575 if (gtk_widget_has_rc_style (widget))
6576 gtk_widget_reset_rc_style (widget);
6580 * gtk_widget_get_modifier_style:
6581 * @widget: a #GtkWidget
6583 * Returns the current modifier style for the widget. (As set by
6584 * gtk_widget_modify_style().) If no style has previously set, a new
6585 * #GtkRcStyle will be created with all values unset, and set as the
6586 * modifier style for the widget. If you make changes to this rc
6587 * style, you must call gtk_widget_modify_style(), passing in the
6588 * returned rc style, to make sure that your changes take effect.
6590 * Caution: passing the style back to gtk_widget_modify_style() will
6591 * normally end up destroying it, because gtk_widget_modify_style() copies
6592 * the passed-in style and sets the copy as the new modifier style,
6593 * thus dropping any reference to the old modifier style. Add a reference
6594 * to the modifier style if you want to keep it alive.
6596 * Return value: (transfer none): the modifier style for the widget. This rc style is
6597 * owned by the widget. If you want to keep a pointer to value this
6598 * around, you must add a refcount using g_object_ref().
6601 gtk_widget_get_modifier_style (GtkWidget *widget)
6603 GtkRcStyle *rc_style;
6605 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6607 rc_style = g_object_get_qdata (G_OBJECT (widget), quark_rc_style);
6611 rc_style = gtk_rc_style_new ();
6612 g_object_set_qdata_full (G_OBJECT (widget),
6615 (GDestroyNotify) g_object_unref);
6622 gtk_widget_modify_color_component (GtkWidget *widget,
6623 GtkRcFlags component,
6625 const GdkColor *color)
6627 GtkRcStyle *rc_style = gtk_widget_get_modifier_style (widget);
6634 rc_style->fg[state] = *color;
6637 rc_style->bg[state] = *color;
6640 rc_style->text[state] = *color;
6643 rc_style->base[state] = *color;
6646 g_assert_not_reached();
6649 rc_style->color_flags[state] |= component;
6652 rc_style->color_flags[state] &= ~component;
6654 gtk_widget_modify_style (widget, rc_style);
6658 * gtk_widget_modify_fg:
6659 * @widget: a #GtkWidget
6660 * @state: the state for which to set the foreground color
6661 * @color: (allow-none): the color to assign (does not need to be allocated),
6662 * or %NULL to undo the effect of previous calls to
6663 * of gtk_widget_modify_fg().
6665 * Sets the foreground color for a widget in a particular state.
6666 * All other style values are left untouched. See also
6667 * gtk_widget_modify_style().
6670 gtk_widget_modify_fg (GtkWidget *widget,
6672 const GdkColor *color)
6674 g_return_if_fail (GTK_IS_WIDGET (widget));
6675 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
6677 gtk_widget_modify_color_component (widget, GTK_RC_FG, state, color);
6681 * gtk_widget_modify_bg:
6682 * @widget: a #GtkWidget
6683 * @state: the state for which to set the background color
6684 * @color: (allow-none): the color to assign (does not need to be allocated),
6685 * or %NULL to undo the effect of previous calls to
6686 * of gtk_widget_modify_bg().
6688 * Sets the background color for a widget in a particular state.
6689 * All other style values are left untouched. See also
6690 * gtk_widget_modify_style().
6692 * Note that "no window" widgets (which have the %GTK_NO_WINDOW flag set)
6693 * draw on their parent container's window and thus may not draw any
6694 * background themselves. This is the case for e.g. #GtkLabel. To modify
6695 * the background of such widgets, you have to set the background color
6696 * on their parent; if you want to set the background of a rectangular
6697 * area around a label, try placing the label in a #GtkEventBox widget
6698 * and setting the background color on that.
6701 gtk_widget_modify_bg (GtkWidget *widget,
6703 const GdkColor *color)
6705 g_return_if_fail (GTK_IS_WIDGET (widget));
6706 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
6708 gtk_widget_modify_color_component (widget, GTK_RC_BG, state, color);
6712 * gtk_widget_modify_text:
6713 * @widget: a #GtkWidget
6714 * @state: the state for which to set the text color
6715 * @color: (allow-none): the color to assign (does not need to be allocated),
6716 * or %NULL to undo the effect of previous calls to
6717 * of gtk_widget_modify_text().
6719 * Sets the text color for a widget in a particular state. All other
6720 * style values are left untouched. The text color is the foreground
6721 * color used along with the base color (see gtk_widget_modify_base())
6722 * for widgets such as #GtkEntry and #GtkTextView. See also
6723 * gtk_widget_modify_style().
6726 gtk_widget_modify_text (GtkWidget *widget,
6728 const GdkColor *color)
6730 g_return_if_fail (GTK_IS_WIDGET (widget));
6731 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
6733 gtk_widget_modify_color_component (widget, GTK_RC_TEXT, state, color);
6737 * gtk_widget_modify_base:
6738 * @widget: a #GtkWidget
6739 * @state: the state for which to set the base color
6740 * @color: (allow-none): the color to assign (does not need to be allocated),
6741 * or %NULL to undo the effect of previous calls to
6742 * of gtk_widget_modify_base().
6744 * Sets the base color for a widget in a particular state.
6745 * All other style values are left untouched. The base color
6746 * is the background color used along with the text color
6747 * (see gtk_widget_modify_text()) for widgets such as #GtkEntry
6748 * and #GtkTextView. See also gtk_widget_modify_style().
6750 * Note that "no window" widgets (which have the %GTK_NO_WINDOW flag set)
6751 * draw on their parent container's window and thus may not draw any
6752 * background themselves. This is the case for e.g. #GtkLabel. To modify
6753 * the background of such widgets, you have to set the base color on their
6754 * parent; if you want to set the background of a rectangular area around
6755 * a label, try placing the label in a #GtkEventBox widget and setting
6756 * the base color on that.
6759 gtk_widget_modify_base (GtkWidget *widget,
6761 const GdkColor *color)
6763 g_return_if_fail (GTK_IS_WIDGET (widget));
6764 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
6766 gtk_widget_modify_color_component (widget, GTK_RC_BASE, state, color);
6770 modify_color_property (GtkWidget *widget,
6771 GtkRcStyle *rc_style,
6773 const GdkColor *color)
6775 GQuark type_name = g_type_qname (G_OBJECT_TYPE (widget));
6776 GQuark property_name = g_quark_from_string (name);
6780 GtkRcProperty rc_property = {0};
6783 rc_property.type_name = type_name;
6784 rc_property.property_name = property_name;
6785 rc_property.origin = NULL;
6787 color_name = gdk_color_to_string (color);
6788 g_value_init (&rc_property.value, G_TYPE_STRING);
6789 g_value_take_string (&rc_property.value, color_name);
6791 _gtk_rc_style_set_rc_property (rc_style, &rc_property);
6793 g_value_unset (&rc_property.value);
6796 _gtk_rc_style_unset_rc_property (rc_style, type_name, property_name);
6800 * gtk_widget_modify_cursor:
6801 * @widget: a #GtkWidget
6802 * @primary: the color to use for primary cursor (does not need to be
6803 * allocated), or %NULL to undo the effect of previous calls to
6804 * of gtk_widget_modify_cursor().
6805 * @secondary: the color to use for secondary cursor (does not need to be
6806 * allocated), or %NULL to undo the effect of previous calls to
6807 * of gtk_widget_modify_cursor().
6809 * Sets the cursor color to use in a widget, overriding the
6810 * #GtkWidget:cursor-color and #GtkWidget:secondary-cursor-color
6811 * style properties. All other style values are left untouched.
6812 * See also gtk_widget_modify_style().
6817 gtk_widget_modify_cursor (GtkWidget *widget,
6818 const GdkColor *primary,
6819 const GdkColor *secondary)
6821 GtkRcStyle *rc_style;
6823 g_return_if_fail (GTK_IS_WIDGET (widget));
6825 rc_style = gtk_widget_get_modifier_style (widget);
6827 modify_color_property (widget, rc_style, "cursor-color", primary);
6828 modify_color_property (widget, rc_style, "secondary-cursor-color", secondary);
6830 gtk_widget_modify_style (widget, rc_style);
6834 * gtk_widget_modify_font:
6835 * @widget: a #GtkWidget
6836 * @font_desc: (allow-none): the font description to use, or %NULL to undo
6837 * the effect of previous calls to gtk_widget_modify_font().
6839 * Sets the font to use for a widget. All other style values are left
6840 * untouched. See also gtk_widget_modify_style().
6843 gtk_widget_modify_font (GtkWidget *widget,
6844 PangoFontDescription *font_desc)
6846 GtkRcStyle *rc_style;
6848 g_return_if_fail (GTK_IS_WIDGET (widget));
6850 rc_style = gtk_widget_get_modifier_style (widget);
6852 if (rc_style->font_desc)
6853 pango_font_description_free (rc_style->font_desc);
6856 rc_style->font_desc = pango_font_description_copy (font_desc);
6858 rc_style->font_desc = NULL;
6860 gtk_widget_modify_style (widget, rc_style);
6864 gtk_widget_real_direction_changed (GtkWidget *widget,
6865 GtkTextDirection previous_direction)
6867 gtk_widget_queue_resize (widget);
6871 gtk_widget_real_style_set (GtkWidget *widget,
6872 GtkStyle *previous_style)
6874 if (GTK_WIDGET_REALIZED (widget) &&
6875 !GTK_WIDGET_NO_WINDOW (widget))
6876 gtk_style_set_background (widget->style, widget->window, widget->state);
6880 gtk_widget_set_style_internal (GtkWidget *widget,
6882 gboolean initial_emission)
6884 g_object_ref (widget);
6885 g_object_freeze_notify (G_OBJECT (widget));
6887 if (widget->style != style)
6889 GtkStyle *previous_style;
6891 if (GTK_WIDGET_REALIZED (widget))
6893 gtk_widget_reset_shapes (widget);
6894 gtk_style_detach (widget->style);
6897 previous_style = widget->style;
6898 widget->style = style;
6899 g_object_ref (widget->style);
6901 if (GTK_WIDGET_REALIZED (widget))
6902 widget->style = gtk_style_attach (widget->style, widget->window);
6904 gtk_widget_update_pango_context (widget);
6905 g_signal_emit (widget,
6906 widget_signals[STYLE_SET],
6908 initial_emission ? NULL : previous_style);
6909 g_object_unref (previous_style);
6911 if (GTK_WIDGET_ANCHORED (widget) && !initial_emission)
6912 gtk_widget_queue_resize (widget);
6914 else if (initial_emission)
6916 gtk_widget_update_pango_context (widget);
6917 g_signal_emit (widget,
6918 widget_signals[STYLE_SET],
6922 g_object_notify (G_OBJECT (widget), "style");
6923 g_object_thaw_notify (G_OBJECT (widget));
6924 g_object_unref (widget);
6928 GtkWidget *previous_toplevel;
6929 GdkScreen *previous_screen;
6930 GdkScreen *new_screen;
6931 } HierarchyChangedInfo;
6934 do_screen_change (GtkWidget *widget,
6935 GdkScreen *old_screen,
6936 GdkScreen *new_screen)
6938 if (old_screen != new_screen)
6942 PangoContext *context = g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
6944 g_object_set_qdata (G_OBJECT (widget), quark_pango_context, NULL);
6947 _gtk_tooltip_hide (widget);
6948 g_signal_emit (widget, widget_signals[SCREEN_CHANGED], 0, old_screen);
6953 gtk_widget_propagate_hierarchy_changed_recurse (GtkWidget *widget,
6954 gpointer client_data)
6956 HierarchyChangedInfo *info = client_data;
6957 gboolean new_anchored = gtk_widget_is_toplevel (widget) ||
6958 (widget->parent && GTK_WIDGET_ANCHORED (widget->parent));
6960 if (GTK_WIDGET_ANCHORED (widget) != new_anchored)
6962 g_object_ref (widget);
6965 GTK_PRIVATE_SET_FLAG (widget, GTK_ANCHORED);
6967 GTK_PRIVATE_UNSET_FLAG (widget, GTK_ANCHORED);
6969 g_signal_emit (widget, widget_signals[HIERARCHY_CHANGED], 0, info->previous_toplevel);
6970 do_screen_change (widget, info->previous_screen, info->new_screen);
6972 if (GTK_IS_CONTAINER (widget))
6973 gtk_container_forall (GTK_CONTAINER (widget),
6974 gtk_widget_propagate_hierarchy_changed_recurse,
6977 g_object_unref (widget);
6982 * _gtk_widget_propagate_hierarchy_changed:
6983 * @widget: a #GtkWidget
6984 * @previous_toplevel: Previous toplevel
6986 * Propagates changes in the anchored state to a widget and all
6987 * children, unsetting or setting the %ANCHORED flag, and
6988 * emitting #GtkWidget::hierarchy-changed.
6991 _gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
6992 GtkWidget *previous_toplevel)
6994 HierarchyChangedInfo info;
6996 info.previous_toplevel = previous_toplevel;
6997 info.previous_screen = previous_toplevel ? gtk_widget_get_screen (previous_toplevel) : NULL;
6999 if (gtk_widget_is_toplevel (widget) ||
7000 (widget->parent && GTK_WIDGET_ANCHORED (widget->parent)))
7001 info.new_screen = gtk_widget_get_screen (widget);
7003 info.new_screen = NULL;
7005 if (info.previous_screen)
7006 g_object_ref (info.previous_screen);
7007 if (previous_toplevel)
7008 g_object_ref (previous_toplevel);
7010 gtk_widget_propagate_hierarchy_changed_recurse (widget, &info);
7012 if (previous_toplevel)
7013 g_object_unref (previous_toplevel);
7014 if (info.previous_screen)
7015 g_object_unref (info.previous_screen);
7019 gtk_widget_propagate_screen_changed_recurse (GtkWidget *widget,
7020 gpointer client_data)
7022 HierarchyChangedInfo *info = client_data;
7024 g_object_ref (widget);
7026 do_screen_change (widget, info->previous_screen, info->new_screen);
7028 if (GTK_IS_CONTAINER (widget))
7029 gtk_container_forall (GTK_CONTAINER (widget),
7030 gtk_widget_propagate_screen_changed_recurse,
7033 g_object_unref (widget);
7037 * gtk_widget_is_composited:
7038 * @widget: a #GtkWidget
7040 * Whether @widget can rely on having its alpha channel
7041 * drawn correctly. On X11 this function returns whether a
7042 * compositing manager is running for @widget's screen.
7044 * Please note that the semantics of this call will change
7045 * in the future if used on a widget that has a composited
7046 * window in its hierarchy (as set by gdk_window_set_composited()).
7048 * Return value: %TRUE if the widget can rely on its alpha
7049 * channel being drawn correctly.
7054 gtk_widget_is_composited (GtkWidget *widget)
7058 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7060 screen = gtk_widget_get_screen (widget);
7062 return gdk_screen_is_composited (screen);
7066 propagate_composited_changed (GtkWidget *widget,
7069 if (GTK_IS_CONTAINER (widget))
7071 gtk_container_forall (GTK_CONTAINER (widget),
7072 propagate_composited_changed,
7076 g_signal_emit (widget, widget_signals[COMPOSITED_CHANGED], 0);
7080 _gtk_widget_propagate_composited_changed (GtkWidget *widget)
7082 propagate_composited_changed (widget, NULL);
7086 * _gtk_widget_propagate_screen_changed:
7087 * @widget: a #GtkWidget
7088 * @previous_screen: Previous screen
7090 * Propagates changes in the screen for a widget to all
7091 * children, emitting #GtkWidget::screen-changed.
7094 _gtk_widget_propagate_screen_changed (GtkWidget *widget,
7095 GdkScreen *previous_screen)
7097 HierarchyChangedInfo info;
7099 info.previous_screen = previous_screen;
7100 info.new_screen = gtk_widget_get_screen (widget);
7102 if (previous_screen)
7103 g_object_ref (previous_screen);
7105 gtk_widget_propagate_screen_changed_recurse (widget, &info);
7107 if (previous_screen)
7108 g_object_unref (previous_screen);
7112 reset_rc_styles_recurse (GtkWidget *widget, gpointer data)
7114 if (gtk_widget_has_rc_style (widget))
7115 gtk_widget_reset_rc_style (widget);
7117 if (GTK_IS_CONTAINER (widget))
7118 gtk_container_forall (GTK_CONTAINER (widget),
7119 reset_rc_styles_recurse,
7125 * gtk_widget_reset_rc_styles:
7126 * @widget: a #GtkWidget.
7128 * Reset the styles of @widget and all descendents, so when
7129 * they are looked up again, they get the correct values
7130 * for the currently loaded RC file settings.
7132 * This function is not useful for applications.
7135 gtk_widget_reset_rc_styles (GtkWidget *widget)
7137 g_return_if_fail (GTK_IS_WIDGET (widget));
7139 reset_rc_styles_recurse (widget, NULL);
7143 * gtk_widget_get_default_style:
7145 * Returns the default style used by all widgets initially.
7147 * Returns: (transfer none): the default style. This #GtkStyle object is owned
7148 * by GTK+ and should not be modified or freed.
7151 gtk_widget_get_default_style (void)
7153 if (!gtk_default_style)
7155 gtk_default_style = gtk_style_new ();
7156 g_object_ref (gtk_default_style);
7159 return gtk_default_style;
7162 static PangoContext *
7163 gtk_widget_peek_pango_context (GtkWidget *widget)
7165 return g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
7169 * gtk_widget_get_pango_context:
7170 * @widget: a #GtkWidget
7172 * Gets a #PangoContext with the appropriate font map, font description,
7173 * and base direction for this widget. Unlike the context returned
7174 * by gtk_widget_create_pango_context(), this context is owned by
7175 * the widget (it can be used until the screen for the widget changes
7176 * or the widget is removed from its toplevel), and will be updated to
7177 * match any changes to the widget's attributes.
7179 * If you create and keep a #PangoLayout using this context, you must
7180 * deal with changes to the context by calling pango_layout_context_changed()
7181 * on the layout in response to the #GtkWidget::style-set and
7182 * #GtkWidget::direction-changed signals for the widget.
7184 * Return value: (transfer none): the #PangoContext for the widget.
7187 gtk_widget_get_pango_context (GtkWidget *widget)
7189 PangoContext *context;
7191 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7193 context = g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
7196 context = gtk_widget_create_pango_context (GTK_WIDGET (widget));
7197 g_object_set_qdata_full (G_OBJECT (widget),
7198 quark_pango_context,
7207 update_pango_context (GtkWidget *widget,
7208 PangoContext *context)
7210 pango_context_set_font_description (context, widget->style->font_desc);
7211 pango_context_set_base_dir (context,
7212 gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR ?
7213 PANGO_DIRECTION_LTR : PANGO_DIRECTION_RTL);
7217 gtk_widget_update_pango_context (GtkWidget *widget)
7219 PangoContext *context = gtk_widget_peek_pango_context (widget);
7225 update_pango_context (widget, context);
7227 screen = gtk_widget_get_screen_unchecked (widget);
7230 pango_cairo_context_set_resolution (context,
7231 gdk_screen_get_resolution (screen));
7232 pango_cairo_context_set_font_options (context,
7233 gdk_screen_get_font_options (screen));
7239 * gtk_widget_create_pango_context:
7240 * @widget: a #GtkWidget
7242 * Creates a new #PangoContext with the appropriate font map,
7243 * font description, and base direction for drawing text for
7244 * this widget. See also gtk_widget_get_pango_context().
7246 * Return value: the new #PangoContext
7249 gtk_widget_create_pango_context (GtkWidget *widget)
7252 PangoContext *context;
7254 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7256 screen = gtk_widget_get_screen_unchecked (widget);
7259 GTK_NOTE (MULTIHEAD,
7260 g_warning ("gtk_widget_create_pango_context ()) called without screen"));
7262 screen = gdk_screen_get_default ();
7265 context = gdk_pango_context_get_for_screen (screen);
7267 update_pango_context (widget, context);
7268 pango_context_set_language (context, gtk_get_default_language ());
7274 * gtk_widget_create_pango_layout:
7275 * @widget: a #GtkWidget
7276 * @text: text to set on the layout (can be %NULL)
7278 * Creates a new #PangoLayout with the appropriate font map,
7279 * font description, and base direction for drawing text for
7282 * If you keep a #PangoLayout created in this way around, in order to
7283 * notify the layout of changes to the base direction or font of this
7284 * widget, you must call pango_layout_context_changed() in response to
7285 * the #GtkWidget::style-set and #GtkWidget::direction-changed signals
7288 * Return value: the new #PangoLayout
7291 gtk_widget_create_pango_layout (GtkWidget *widget,
7294 PangoLayout *layout;
7295 PangoContext *context;
7297 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7299 context = gtk_widget_get_pango_context (widget);
7300 layout = pango_layout_new (context);
7303 pango_layout_set_text (layout, text, -1);
7309 * gtk_widget_render_icon:
7310 * @widget: a #GtkWidget
7311 * @stock_id: a stock ID
7312 * @size: (type int) a stock size. A size of (GtkIconSize)-1 means
7313 * render at the size of the source and don't scale (if there are
7314 * multiple source sizes, GTK+ picks one of the available sizes).
7315 * @detail: (allow-none): render detail to pass to theme engine
7317 * A convenience function that uses the theme engine and RC file
7318 * settings for @widget to look up @stock_id and render it to
7319 * a pixbuf. @stock_id should be a stock icon ID such as
7320 * #GTK_STOCK_OPEN or #GTK_STOCK_OK. @size should be a size
7321 * such as #GTK_ICON_SIZE_MENU. @detail should be a string that
7322 * identifies the widget or code doing the rendering, so that
7323 * theme engines can special-case rendering for that widget or code.
7325 * The pixels in the returned #GdkPixbuf are shared with the rest of
7326 * the application and should not be modified. The pixbuf should be freed
7327 * after use with g_object_unref().
7329 * Return value: a new pixbuf, or %NULL if the stock ID wasn't known
7332 gtk_widget_render_icon (GtkWidget *widget,
7333 const gchar *stock_id,
7335 const gchar *detail)
7337 GtkIconSet *icon_set;
7340 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7341 g_return_val_if_fail (stock_id != NULL, NULL);
7342 g_return_val_if_fail (size > GTK_ICON_SIZE_INVALID || size == -1, NULL);
7344 gtk_widget_ensure_style (widget);
7346 icon_set = gtk_style_lookup_icon_set (widget->style, stock_id);
7348 if (icon_set == NULL)
7351 retval = gtk_icon_set_render_icon (icon_set,
7353 gtk_widget_get_direction (widget),
7354 GTK_WIDGET_STATE (widget),
7363 * gtk_widget_set_parent_window:
7364 * @widget: a #GtkWidget.
7365 * @parent_window: the new parent window.
7367 * Sets a non default parent window for @widget.
7370 gtk_widget_set_parent_window (GtkWidget *widget,
7371 GdkWindow *parent_window)
7373 GdkWindow *old_parent_window;
7375 g_return_if_fail (GTK_IS_WIDGET (widget));
7377 old_parent_window = g_object_get_qdata (G_OBJECT (widget),
7378 quark_parent_window);
7380 if (parent_window != old_parent_window)
7382 g_object_set_qdata (G_OBJECT (widget), quark_parent_window,
7384 if (old_parent_window)
7385 g_object_unref (old_parent_window);
7387 g_object_ref (parent_window);
7392 * gtk_widget_get_parent_window:
7393 * @widget: a #GtkWidget.
7395 * Gets @widget's parent window.
7397 * Returns: (transfer none): the parent window of @widget.
7400 gtk_widget_get_parent_window (GtkWidget *widget)
7402 GdkWindow *parent_window;
7404 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7406 parent_window = g_object_get_qdata (G_OBJECT (widget), quark_parent_window);
7408 return (parent_window != NULL) ? parent_window :
7409 (widget->parent != NULL) ? widget->parent->window : NULL;
7414 * gtk_widget_set_child_visible:
7415 * @widget: a #GtkWidget
7416 * @is_visible: if %TRUE, @widget should be mapped along with its parent.
7418 * Sets whether @widget should be mapped along with its when its parent
7419 * is mapped and @widget has been shown with gtk_widget_show().
7421 * The child visibility can be set for widget before it is added to
7422 * a container with gtk_widget_set_parent(), to avoid mapping
7423 * children unnecessary before immediately unmapping them. However
7424 * it will be reset to its default state of %TRUE when the widget
7425 * is removed from a container.
7427 * Note that changing the child visibility of a widget does not
7428 * queue a resize on the widget. Most of the time, the size of
7429 * a widget is computed from all visible children, whether or
7430 * not they are mapped. If this is not the case, the container
7431 * can queue a resize itself.
7433 * This function is only useful for container implementations and
7434 * never should be called by an application.
7437 gtk_widget_set_child_visible (GtkWidget *widget,
7438 gboolean is_visible)
7440 g_return_if_fail (GTK_IS_WIDGET (widget));
7441 g_return_if_fail (!gtk_widget_is_toplevel (widget));
7443 g_object_ref (widget);
7446 GTK_PRIVATE_SET_FLAG (widget, GTK_CHILD_VISIBLE);
7449 GtkWidget *toplevel;
7451 GTK_PRIVATE_UNSET_FLAG (widget, GTK_CHILD_VISIBLE);
7453 toplevel = gtk_widget_get_toplevel (widget);
7454 if (toplevel != widget && gtk_widget_is_toplevel (toplevel))
7455 _gtk_window_unset_focus_and_default (GTK_WINDOW (toplevel), widget);
7458 if (widget->parent && GTK_WIDGET_REALIZED (widget->parent))
7460 if (GTK_WIDGET_MAPPED (widget->parent) &&
7461 GTK_WIDGET_CHILD_VISIBLE (widget) &&
7462 GTK_WIDGET_VISIBLE (widget))
7463 gtk_widget_map (widget);
7465 gtk_widget_unmap (widget);
7468 g_object_unref (widget);
7472 * gtk_widget_get_child_visible:
7473 * @widget: a #GtkWidget
7475 * Gets the value set with gtk_widget_set_child_visible().
7476 * If you feel a need to use this function, your code probably
7477 * needs reorganization.
7479 * This function is only useful for container implementations and
7480 * never should be called by an application.
7482 * Return value: %TRUE if the widget is mapped with the parent.
7485 gtk_widget_get_child_visible (GtkWidget *widget)
7487 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7489 return GTK_WIDGET_CHILD_VISIBLE (widget);
7493 gtk_widget_get_screen_unchecked (GtkWidget *widget)
7495 GtkWidget *toplevel;
7497 toplevel = gtk_widget_get_toplevel (widget);
7499 if (gtk_widget_is_toplevel (toplevel))
7501 if (GTK_IS_WINDOW (toplevel))
7502 return GTK_WINDOW (toplevel)->screen;
7503 else if (GTK_IS_INVISIBLE (toplevel))
7504 return GTK_INVISIBLE (widget)->screen;
7511 * gtk_widget_get_screen:
7512 * @widget: a #GtkWidget
7514 * Get the #GdkScreen from the toplevel window associated with
7515 * this widget. This function can only be called after the widget
7516 * has been added to a widget hierarchy with a #GtkWindow
7519 * In general, you should only create screen specific
7520 * resources when a widget has been realized, and you should
7521 * free those resources when the widget is unrealized.
7523 * Return value: (transfer none): the #GdkScreen for the toplevel for this widget.
7528 gtk_widget_get_screen (GtkWidget *widget)
7532 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7534 screen = gtk_widget_get_screen_unchecked (widget);
7541 g_warning (G_STRLOC ": Can't get associated screen"
7542 " for a widget unless it is inside a toplevel GtkWindow\n"
7543 " widget type is %s associated top level type is %s",
7544 g_type_name (G_OBJECT_TYPE(G_OBJECT (widget))),
7545 g_type_name (G_OBJECT_TYPE(G_OBJECT (toplevel))));
7547 return gdk_screen_get_default ();
7552 * gtk_widget_has_screen:
7553 * @widget: a #GtkWidget
7555 * Checks whether there is a #GdkScreen is associated with
7556 * this widget. All toplevel widgets have an associated
7557 * screen, and all widgets added into a hierarchy with a toplevel
7558 * window at the top.
7560 * Return value: %TRUE if there is a #GdkScreen associcated
7566 gtk_widget_has_screen (GtkWidget *widget)
7568 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7570 return (gtk_widget_get_screen_unchecked (widget) != NULL);
7574 * gtk_widget_get_display:
7575 * @widget: a #GtkWidget
7577 * Get the #GdkDisplay for the toplevel window associated with
7578 * this widget. This function can only be called after the widget
7579 * has been added to a widget hierarchy with a #GtkWindow at the top.
7581 * In general, you should only create display specific
7582 * resources when a widget has been realized, and you should
7583 * free those resources when the widget is unrealized.
7585 * Return value: (transfer none): the #GdkDisplay for the toplevel for this widget.
7590 gtk_widget_get_display (GtkWidget *widget)
7592 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7594 return gdk_screen_get_display (gtk_widget_get_screen (widget));
7598 * gtk_widget_get_root_window:
7599 * @widget: a #GtkWidget
7601 * Get the root window where this widget is located. This function can
7602 * only be called after the widget has been added to a widget
7603 * hierarchy with #GtkWindow at the top.
7605 * The root window is useful for such purposes as creating a popup
7606 * #GdkWindow associated with the window. In general, you should only
7607 * create display specific resources when a widget has been realized,
7608 * and you should free those resources when the widget is unrealized.
7610 * Return value: (transfer none): the #GdkWindow root window for the toplevel for this widget.
7615 gtk_widget_get_root_window (GtkWidget *widget)
7617 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
7619 return gdk_screen_get_root_window (gtk_widget_get_screen (widget));
7623 * gtk_widget_child_focus:
7624 * @widget: a #GtkWidget
7625 * @direction: direction of focus movement
7627 * This function is used by custom widget implementations; if you're
7628 * writing an app, you'd use gtk_widget_grab_focus() to move the focus
7629 * to a particular widget, and gtk_container_set_focus_chain() to
7630 * change the focus tab order. So you may want to investigate those
7631 * functions instead.
7633 * gtk_widget_child_focus() is called by containers as the user moves
7634 * around the window using keyboard shortcuts. @direction indicates
7635 * what kind of motion is taking place (up, down, left, right, tab
7636 * forward, tab backward). gtk_widget_child_focus() emits the
7637 * #GtkWidget::focus" signal; widgets override the default handler
7638 * for this signal in order to implement appropriate focus behavior.
7640 * The default ::focus handler for a widget should return %TRUE if
7641 * moving in @direction left the focus on a focusable location inside
7642 * that widget, and %FALSE if moving in @direction moved the focus
7643 * outside the widget. If returning %TRUE, widgets normally
7644 * call gtk_widget_grab_focus() to place the focus accordingly;
7645 * if returning %FALSE, they don't modify the current focus location.
7647 * This function replaces gtk_container_focus() from GTK+ 1.2.
7648 * It was necessary to check that the child was visible, sensitive,
7649 * and focusable before calling gtk_container_focus().
7650 * gtk_widget_child_focus() returns %FALSE if the widget is not
7651 * currently in a focusable state, so there's no need for those checks.
7653 * Return value: %TRUE if focus ended up inside @widget
7656 gtk_widget_child_focus (GtkWidget *widget,
7657 GtkDirectionType direction)
7659 gboolean return_val;
7661 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7663 if (!GTK_WIDGET_VISIBLE (widget) ||
7664 !GTK_WIDGET_IS_SENSITIVE (widget))
7667 /* child widgets must set CAN_FOCUS, containers
7668 * don't have to though.
7670 if (!GTK_IS_CONTAINER (widget) &&
7671 !gtk_widget_get_can_focus (widget))
7674 g_signal_emit (widget,
7675 widget_signals[FOCUS],
7677 direction, &return_val);
7683 * gtk_widget_keynav_failed:
7684 * @widget: a #GtkWidget
7685 * @direction: direction of focus movement
7687 * This function should be called whenever keyboard navigation within
7688 * a single widget hits a boundary. The function emits the
7689 * #GtkWidget::keynav-failed signal on the widget and its return
7690 * value should be interpreted in a way similar to the return value of
7691 * gtk_widget_child_focus():
7693 * When %TRUE is returned, stay in the widget, the failed keyboard
7694 * navigation is Ok and/or there is nowhere we can/should move the
7697 * When %FALSE is returned, the caller should continue with keyboard
7698 * navigation outside the widget, e.g. by calling
7699 * gtk_widget_child_focus() on the widget's toplevel.
7701 * The default ::keynav-failed handler returns %TRUE for
7702 * %GTK_DIR_TAB_FORWARD and %GTK_DIR_TAB_BACKWARD. For the other
7703 * values of #GtkDirectionType, it looks at the
7704 * #GtkSettings:gtk-keynav-cursor-only setting and returns %FALSE
7705 * if the setting is %TRUE. This way the entire user interface
7706 * becomes cursor-navigatable on input devices such as mobile phones
7707 * which only have cursor keys but no tab key.
7709 * Whenever the default handler returns %TRUE, it also calls
7710 * gtk_widget_error_bell() to notify the user of the failed keyboard
7713 * A use case for providing an own implementation of ::keynav-failed
7714 * (either by connecting to it or by overriding it) would be a row of
7715 * #GtkEntry widgets where the user should be able to navigate the
7716 * entire row with the cursor keys, as e.g. known from user interfaces
7717 * that require entering license keys.
7719 * Return value: %TRUE if stopping keyboard navigation is fine, %FALSE
7720 * if the emitting widget should try to handle the keyboard
7721 * navigation attempt in its parent container(s).
7726 gtk_widget_keynav_failed (GtkWidget *widget,
7727 GtkDirectionType direction)
7729 gboolean return_val;
7731 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
7733 g_signal_emit (widget, widget_signals[KEYNAV_FAILED], 0,
7734 direction, &return_val);
7740 * gtk_widget_error_bell:
7741 * @widget: a #GtkWidget
7743 * Notifies the user about an input-related error on this widget.
7744 * If the #GtkSettings:gtk-error-bell setting is %TRUE, it calls
7745 * gdk_window_beep(), otherwise it does nothing.
7747 * Note that the effect of gdk_window_beep() can be configured in many
7748 * ways, depending on the windowing backend and the desktop environment
7749 * or window manager that is used.
7754 gtk_widget_error_bell (GtkWidget *widget)
7756 GtkSettings* settings;
7759 g_return_if_fail (GTK_IS_WIDGET (widget));
7761 settings = gtk_widget_get_settings (widget);
7765 g_object_get (settings,
7766 "gtk-error-bell", &beep,
7769 if (beep && widget->window)
7770 gdk_window_beep (widget->window);
7774 * gtk_widget_set_uposition:
7775 * @widget: a #GtkWidget
7776 * @x: x position; -1 to unset x; -2 to leave x unchanged
7777 * @y: y position; -1 to unset y; -2 to leave y unchanged
7780 * Sets the position of a widget. The funny "u" in the name comes from
7781 * the "user position" hint specified by the X Window System, and
7782 * exists for legacy reasons. This function doesn't work if a widget
7783 * is inside a container; it's only really useful on #GtkWindow.
7785 * Don't use this function to center dialogs over the main application
7786 * window; most window managers will do the centering on your behalf
7787 * if you call gtk_window_set_transient_for(), and it's really not
7788 * possible to get the centering to work correctly in all cases from
7789 * application code. But if you insist, use gtk_window_set_position()
7790 * to set #GTK_WIN_POS_CENTER_ON_PARENT, don't do the centering
7793 * Note that although @x and @y can be individually unset, the position
7794 * is not honoured unless both @x and @y are set.
7797 gtk_widget_set_uposition (GtkWidget *widget,
7801 /* FIXME this function is the only place that aux_info->x and
7802 * aux_info->y are even used I believe, and this function is
7803 * deprecated. Should be cleaned up.
7805 * (Actually, size_allocate uses them) -Yosh
7808 GtkWidgetAuxInfo *aux_info;
7810 g_return_if_fail (GTK_IS_WIDGET (widget));
7812 aux_info =_gtk_widget_get_aux_info (widget, TRUE);
7817 aux_info->x_set = FALSE;
7820 aux_info->x_set = TRUE;
7828 aux_info->y_set = FALSE;
7831 aux_info->y_set = TRUE;
7836 if (GTK_IS_WINDOW (widget) && aux_info->x_set && aux_info->y_set)
7837 _gtk_window_reposition (GTK_WINDOW (widget), aux_info->x, aux_info->y);
7839 if (GTK_WIDGET_VISIBLE (widget) && widget->parent)
7840 gtk_widget_size_allocate (widget, &widget->allocation);
7844 gtk_widget_set_usize_internal (GtkWidget *widget,
7848 GtkWidgetAuxInfo *aux_info;
7849 gboolean changed = FALSE;
7851 g_object_freeze_notify (G_OBJECT (widget));
7853 aux_info = _gtk_widget_get_aux_info (widget, TRUE);
7855 if (width > -2 && aux_info->width != width)
7857 g_object_notify (G_OBJECT (widget), "width-request");
7858 aux_info->width = width;
7861 if (height > -2 && aux_info->height != height)
7863 g_object_notify (G_OBJECT (widget), "height-request");
7864 aux_info->height = height;
7868 if (GTK_WIDGET_VISIBLE (widget) && changed)
7869 gtk_widget_queue_resize (widget);
7871 g_object_thaw_notify (G_OBJECT (widget));
7875 * gtk_widget_set_usize:
7876 * @widget: a #GtkWidget
7877 * @width: minimum width, or -1 to unset
7878 * @height: minimum height, or -1 to unset
7880 * Sets the minimum size of a widget; that is, the widget's size
7881 * request will be @width by @height. You can use this function to
7882 * force a widget to be either larger or smaller than it is. The
7883 * strange "usize" name dates from the early days of GTK+, and derives
7884 * from X Window System terminology. In many cases,
7885 * gtk_window_set_default_size() is a better choice for toplevel
7886 * windows than this function; setting the default size will still
7887 * allow users to shrink the window. Setting the usize will force them
7888 * to leave the window at least as large as the usize. When dealing
7889 * with window sizes, gtk_window_set_geometry_hints() can be a useful
7892 * Note the inherent danger of setting any fixed size - themes,
7893 * translations into other languages, different fonts, and user action
7894 * can all change the appropriate size for a given widget. So, it's
7895 * basically impossible to hardcode a size that will always be
7898 * Deprecated: 2.2: Use gtk_widget_set_size_request() instead.
7901 gtk_widget_set_usize (GtkWidget *widget,
7905 g_return_if_fail (GTK_IS_WIDGET (widget));
7907 gtk_widget_set_usize_internal (widget, width, height);
7911 * gtk_widget_set_size_request:
7912 * @widget: a #GtkWidget
7913 * @width: width @widget should request, or -1 to unset
7914 * @height: height @widget should request, or -1 to unset
7916 * Sets the minimum size of a widget; that is, the widget's size
7917 * request will be @width by @height. You can use this function to
7918 * force a widget to be either larger or smaller than it normally
7921 * In most cases, gtk_window_set_default_size() is a better choice for
7922 * toplevel windows than this function; setting the default size will
7923 * still allow users to shrink the window. Setting the size request
7924 * will force them to leave the window at least as large as the size
7925 * request. When dealing with window sizes,
7926 * gtk_window_set_geometry_hints() can be a useful function as well.
7928 * Note the inherent danger of setting any fixed size - themes,
7929 * translations into other languages, different fonts, and user action
7930 * can all change the appropriate size for a given widget. So, it's
7931 * basically impossible to hardcode a size that will always be
7934 * The size request of a widget is the smallest size a widget can
7935 * accept while still functioning well and drawing itself correctly.
7936 * However in some strange cases a widget may be allocated less than
7937 * its requested size, and in many cases a widget may be allocated more
7938 * space than it requested.
7940 * If the size request in a given direction is -1 (unset), then
7941 * the "natural" size request of the widget will be used instead.
7943 * Widgets can't actually be allocated a size less than 1 by 1, but
7944 * you can pass 0,0 to this function to mean "as small as possible."
7947 gtk_widget_set_size_request (GtkWidget *widget,
7951 g_return_if_fail (GTK_IS_WIDGET (widget));
7952 g_return_if_fail (width >= -1);
7953 g_return_if_fail (height >= -1);
7960 gtk_widget_set_usize_internal (widget, width, height);
7965 * gtk_widget_get_size_request:
7966 * @widget: a #GtkWidget
7967 * @width: (allow-none): (out): return location for width, or %NULL
7968 * @height: (allow-none): (out): return location for height, or %NULL
7970 * Gets the size request that was explicitly set for the widget using
7971 * gtk_widget_set_size_request(). A value of -1 stored in @width or
7972 * @height indicates that that dimension has not been set explicitly
7973 * and the natural requisition of the widget will be used intead. See
7974 * gtk_widget_set_size_request(). To get the size a widget will
7975 * actually use, call gtk_widget_size_request() instead of
7979 gtk_widget_get_size_request (GtkWidget *widget,
7983 GtkWidgetAuxInfo *aux_info;
7985 g_return_if_fail (GTK_IS_WIDGET (widget));
7987 aux_info = _gtk_widget_get_aux_info (widget, FALSE);
7990 *width = aux_info ? aux_info->width : -1;
7993 *height = aux_info ? aux_info->height : -1;
7997 * gtk_widget_set_events:
7998 * @widget: a #GtkWidget
7999 * @events: event mask
8001 * Sets the event mask (see #GdkEventMask) for a widget. The event
8002 * mask determines which events a widget will receive. Keep in mind
8003 * that different widgets have different default event masks, and by
8004 * changing the event mask you may disrupt a widget's functionality,
8005 * so be careful. This function must be called while a widget is
8006 * unrealized. Consider gtk_widget_add_events() for widgets that are
8007 * already realized, or if you want to preserve the existing event
8008 * mask. This function can't be used with #GTK_NO_WINDOW widgets;
8009 * to get events on those widgets, place them inside a #GtkEventBox
8010 * and receive events on the event box.
8013 gtk_widget_set_events (GtkWidget *widget,
8016 g_return_if_fail (GTK_IS_WIDGET (widget));
8017 g_return_if_fail (!GTK_WIDGET_REALIZED (widget));
8019 g_object_set_qdata (G_OBJECT (widget), quark_event_mask,
8020 GINT_TO_POINTER (events));
8021 g_object_notify (G_OBJECT (widget), "events");
8025 gtk_widget_add_events_internal (GtkWidget *widget,
8031 for (l = window_list; l != NULL; l = l->next)
8033 GdkWindow *window = l->data;
8036 gdk_window_get_user_data (window, &user_data);
8037 if (user_data == widget)
8041 gdk_window_set_events (window, gdk_window_get_events (window) | events);
8043 children = gdk_window_get_children (window);
8044 gtk_widget_add_events_internal (widget, events, children);
8045 g_list_free (children);
8051 * gtk_widget_add_events:
8052 * @widget: a #GtkWidget
8053 * @events: an event mask, see #GdkEventMask
8055 * Adds the events in the bitfield @events to the event mask for
8056 * @widget. See gtk_widget_set_events() for details.
8059 gtk_widget_add_events (GtkWidget *widget,
8064 g_return_if_fail (GTK_IS_WIDGET (widget));
8066 old_events = GPOINTER_TO_INT (g_object_get_qdata (G_OBJECT (widget), quark_event_mask));
8067 g_object_set_qdata (G_OBJECT (widget), quark_event_mask,
8068 GINT_TO_POINTER (old_events | events));
8070 if (GTK_WIDGET_REALIZED (widget))
8074 if (GTK_WIDGET_NO_WINDOW (widget))
8075 window_list = gdk_window_get_children (widget->window);
8077 window_list = g_list_prepend (NULL, widget->window);
8079 gtk_widget_add_events_internal (widget, events, window_list);
8081 g_list_free (window_list);
8084 g_object_notify (G_OBJECT (widget), "events");
8088 * gtk_widget_set_extension_events:
8089 * @widget: a #GtkWidget
8090 * @mode: bitfield of extension events to receive
8092 * Sets the extension events mask to @mode. See #GdkExtensionMode
8093 * and gdk_input_set_extension_events().
8096 gtk_widget_set_extension_events (GtkWidget *widget,
8097 GdkExtensionMode mode)
8099 g_return_if_fail (GTK_IS_WIDGET (widget));
8101 if (GTK_WIDGET_REALIZED (widget))
8102 gtk_widget_set_extension_events_internal (widget, mode, NULL);
8104 g_object_set_qdata (G_OBJECT (widget), quark_extension_event_mode,
8105 GINT_TO_POINTER (mode));
8106 g_object_notify (G_OBJECT (widget), "extension-events");
8110 * gtk_widget_get_toplevel:
8111 * @widget: a #GtkWidget
8113 * This function returns the topmost widget in the container hierarchy
8114 * @widget is a part of. If @widget has no parent widgets, it will be
8115 * returned as the topmost widget. No reference will be added to the
8116 * returned widget; it should not be unreferenced.
8118 * Note the difference in behavior vs. gtk_widget_get_ancestor();
8119 * <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW)</literal>
8121 * %NULL if @widget wasn't inside a toplevel window, and if the
8122 * window was inside a #GtkWindow-derived widget which was in turn
8123 * inside the toplevel #GtkWindow. While the second case may
8124 * seem unlikely, it actually happens when a #GtkPlug is embedded
8125 * inside a #GtkSocket within the same application.
8127 * To reliably find the toplevel #GtkWindow, use
8128 * gtk_widget_get_toplevel() and check if the %TOPLEVEL flags
8129 * is set on the result.
8131 * GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
8132 * if (gtk_widget_is_toplevel (toplevel))
8134 * /* Perform action on toplevel. */
8138 * Return value: (transfer none): the topmost ancestor of @widget, or @widget itself
8139 * if there's no ancestor.
8142 gtk_widget_get_toplevel (GtkWidget *widget)
8144 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8146 while (widget->parent)
8147 widget = widget->parent;
8153 * gtk_widget_get_ancestor:
8154 * @widget: a #GtkWidget
8155 * @widget_type: ancestor type
8157 * Gets the first ancestor of @widget with type @widget_type. For example,
8158 * <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)</literal> gets
8159 * the first #GtkBox that's an ancestor of @widget. No reference will be
8160 * added to the returned widget; it should not be unreferenced. See note
8161 * about checking for a toplevel #GtkWindow in the docs for
8162 * gtk_widget_get_toplevel().
8164 * Note that unlike gtk_widget_is_ancestor(), gtk_widget_get_ancestor()
8165 * considers @widget to be an ancestor of itself.
8167 * Return value: (transfer none): the ancestor widget, or %NULL if not found
8170 gtk_widget_get_ancestor (GtkWidget *widget,
8173 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8175 while (widget && !g_type_is_a (G_OBJECT_TYPE (widget), widget_type))
8176 widget = widget->parent;
8178 if (!(widget && g_type_is_a (G_OBJECT_TYPE (widget), widget_type)))
8185 * gtk_widget_get_colormap:
8186 * @widget: a #GtkWidget
8188 * Gets the colormap that will be used to render @widget. No reference will
8189 * be added to the returned colormap; it should not be unreferenced.
8191 * Return value: (transfer none): the colormap used by @widget
8194 gtk_widget_get_colormap (GtkWidget *widget)
8196 GdkColormap *colormap;
8197 GtkWidget *tmp_widget;
8199 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8203 colormap = gdk_drawable_get_colormap (widget->window);
8204 /* If window was destroyed previously, we'll get NULL here */
8209 tmp_widget = widget;
8212 colormap = g_object_get_qdata (G_OBJECT (tmp_widget), quark_colormap);
8216 tmp_widget= tmp_widget->parent;
8219 return gdk_screen_get_default_colormap (gtk_widget_get_screen (widget));
8223 * gtk_widget_get_visual:
8224 * @widget: a #GtkWidget
8226 * Gets the visual that will be used to render @widget.
8228 * Return value: (transfer none): the visual for @widget
8231 gtk_widget_get_visual (GtkWidget *widget)
8233 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8235 return gdk_colormap_get_visual (gtk_widget_get_colormap (widget));
8239 * gtk_widget_get_settings:
8240 * @widget: a #GtkWidget
8242 * Gets the settings object holding the settings (global property
8243 * settings, RC file information, etc) used for this widget.
8245 * Note that this function can only be called when the #GtkWidget
8246 * is attached to a toplevel, since the settings object is specific
8247 * to a particular #GdkScreen.
8249 * Return value: (transfer none): the relevant #GtkSettings object
8252 gtk_widget_get_settings (GtkWidget *widget)
8254 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8256 return gtk_settings_get_for_screen (gtk_widget_get_screen (widget));
8260 * gtk_widget_set_colormap:
8261 * @widget: a #GtkWidget
8262 * @colormap: a colormap
8264 * Sets the colormap for the widget to the given value. Widget must not
8265 * have been previously realized. This probably should only be used
8266 * from an <function>init()</function> function (i.e. from the constructor
8270 gtk_widget_set_colormap (GtkWidget *widget,
8271 GdkColormap *colormap)
8273 g_return_if_fail (GTK_IS_WIDGET (widget));
8274 g_return_if_fail (!GTK_WIDGET_REALIZED (widget));
8275 g_return_if_fail (GDK_IS_COLORMAP (colormap));
8277 g_object_ref (colormap);
8279 g_object_set_qdata_full (G_OBJECT (widget),
8286 * gtk_widget_get_events:
8287 * @widget: a #GtkWidget
8289 * Returns the event mask for the widget (a bitfield containing flags
8290 * from the #GdkEventMask enumeration). These are the events that the widget
8293 * Return value: event mask for @widget
8296 gtk_widget_get_events (GtkWidget *widget)
8298 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
8300 return GPOINTER_TO_INT (g_object_get_qdata (G_OBJECT (widget), quark_event_mask));
8304 * gtk_widget_get_extension_events:
8305 * @widget: a #GtkWidget
8307 * Retrieves the extension events the widget will receive; see
8308 * gdk_input_set_extension_events().
8310 * Return value: extension events for @widget
8313 gtk_widget_get_extension_events (GtkWidget *widget)
8315 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
8317 return GPOINTER_TO_INT (g_object_get_qdata (G_OBJECT (widget), quark_extension_event_mode));
8321 * gtk_widget_get_pointer:
8322 * @widget: a #GtkWidget
8323 * @x: (out) (allow-none): return location for the X coordinate, or %NULL
8324 * @y: (out) (allow-none): return location for the Y coordinate, or %NULL
8326 * Obtains the location of the mouse pointer in widget coordinates.
8327 * Widget coordinates are a bit odd; for historical reasons, they are
8328 * defined as @widget->window coordinates for widgets that are not
8329 * #GTK_NO_WINDOW widgets, and are relative to @widget->allocation.x,
8330 * @widget->allocation.y for widgets that are #GTK_NO_WINDOW widgets.
8333 gtk_widget_get_pointer (GtkWidget *widget,
8337 g_return_if_fail (GTK_IS_WIDGET (widget));
8344 if (GTK_WIDGET_REALIZED (widget))
8346 gdk_window_get_pointer (widget->window, x, y, NULL);
8348 if (GTK_WIDGET_NO_WINDOW (widget))
8351 *x -= widget->allocation.x;
8353 *y -= widget->allocation.y;
8359 * gtk_widget_is_ancestor:
8360 * @widget: a #GtkWidget
8361 * @ancestor: another #GtkWidget
8363 * Determines whether @widget is somewhere inside @ancestor, possibly with
8364 * intermediate containers.
8366 * Return value: %TRUE if @ancestor contains @widget as a child,
8367 * grandchild, great grandchild, etc.
8370 gtk_widget_is_ancestor (GtkWidget *widget,
8371 GtkWidget *ancestor)
8373 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
8374 g_return_val_if_fail (ancestor != NULL, FALSE);
8378 if (widget->parent == ancestor)
8380 widget = widget->parent;
8386 static GQuark quark_composite_name = 0;
8389 * gtk_widget_set_composite_name:
8390 * @widget: a #GtkWidget.
8391 * @name: the name to set
8393 * Sets a widgets composite name. The widget must be
8394 * a composite child of its parent; see gtk_widget_push_composite_child().
8397 gtk_widget_set_composite_name (GtkWidget *widget,
8400 g_return_if_fail (GTK_IS_WIDGET (widget));
8401 g_return_if_fail ((GTK_WIDGET_FLAGS (widget) & GTK_COMPOSITE_CHILD) != 0);
8402 g_return_if_fail (name != NULL);
8404 if (!quark_composite_name)
8405 quark_composite_name = g_quark_from_static_string ("gtk-composite-name");
8407 g_object_set_qdata_full (G_OBJECT (widget),
8408 quark_composite_name,
8414 * gtk_widget_get_composite_name:
8415 * @widget: a #GtkWidget
8417 * Obtains the composite name of a widget.
8419 * Returns: the composite name of @widget, or %NULL if @widget is not
8420 * a composite child. The string should be freed when it is no
8424 gtk_widget_get_composite_name (GtkWidget *widget)
8426 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8428 if (((GTK_WIDGET_FLAGS (widget) & GTK_COMPOSITE_CHILD) != 0) && widget->parent)
8429 return _gtk_container_child_composite_name (GTK_CONTAINER (widget->parent),
8436 * gtk_widget_push_composite_child:
8438 * Makes all newly-created widgets as composite children until
8439 * the corresponding gtk_widget_pop_composite_child() call.
8441 * A composite child is a child that's an implementation detail of the
8442 * container it's inside and should not be visible to people using the
8443 * container. Composite children aren't treated differently by GTK (but
8444 * see gtk_container_foreach() vs. gtk_container_forall()), but e.g. GUI
8445 * builders might want to treat them in a different way.
8447 * Here is a simple example:
8449 * gtk_widget_push_composite_child ();
8450 * scrolled_window->hscrollbar = gtk_hscrollbar_new (hadjustment);
8451 * gtk_widget_set_composite_name (scrolled_window->hscrollbar, "hscrollbar");
8452 * gtk_widget_pop_composite_child ();
8453 * gtk_widget_set_parent (scrolled_window->hscrollbar,
8454 * GTK_WIDGET (scrolled_window));
8455 * g_object_ref (scrolled_window->hscrollbar);
8459 gtk_widget_push_composite_child (void)
8461 composite_child_stack++;
8465 * gtk_widget_pop_composite_child:
8467 * Cancels the effect of a previous call to gtk_widget_push_composite_child().
8470 gtk_widget_pop_composite_child (void)
8472 if (composite_child_stack)
8473 composite_child_stack--;
8477 * gtk_widget_push_colormap:
8478 * @cmap: a #GdkColormap
8480 * Pushes @cmap onto a global stack of colormaps; the topmost
8481 * colormap on the stack will be used to create all widgets.
8482 * Remove @cmap with gtk_widget_pop_colormap(). There's little
8483 * reason to use this function.
8486 gtk_widget_push_colormap (GdkColormap *cmap)
8488 g_return_if_fail (!cmap || GDK_IS_COLORMAP (cmap));
8490 colormap_stack = g_slist_prepend (colormap_stack, cmap);
8494 * gtk_widget_pop_colormap:
8496 * Removes a colormap pushed with gtk_widget_push_colormap().
8499 gtk_widget_pop_colormap (void)
8502 colormap_stack = g_slist_delete_link (colormap_stack, colormap_stack);
8506 * gtk_widget_set_default_colormap:
8507 * @colormap: a #GdkColormap
8509 * Sets the default colormap to use when creating widgets.
8510 * gtk_widget_push_colormap() is a better function to use if
8511 * you only want to affect a few widgets, rather than all widgets.
8514 gtk_widget_set_default_colormap (GdkColormap *colormap)
8516 g_return_if_fail (GDK_IS_COLORMAP (colormap));
8518 gdk_screen_set_default_colormap (gdk_colormap_get_screen (colormap),
8523 * gtk_widget_get_default_colormap:
8525 * Obtains the default colormap used to create widgets.
8527 * Return value: (transfer none): default widget colormap
8530 gtk_widget_get_default_colormap (void)
8532 return gdk_screen_get_default_colormap (gdk_screen_get_default ());
8536 * gtk_widget_get_default_visual:
8538 * Obtains the visual of the default colormap. Not really useful;
8539 * used to be useful before gdk_colormap_get_visual() existed.
8541 * Return value: (transfer none): visual of the default colormap
8544 gtk_widget_get_default_visual (void)
8546 return gdk_colormap_get_visual (gtk_widget_get_default_colormap ());
8550 gtk_widget_emit_direction_changed (GtkWidget *widget,
8551 GtkTextDirection old_dir)
8553 gtk_widget_update_pango_context (widget);
8555 g_signal_emit (widget, widget_signals[DIRECTION_CHANGED], 0, old_dir);
8559 * gtk_widget_set_direction:
8560 * @widget: a #GtkWidget
8561 * @dir: the new direction
8563 * Sets the reading direction on a particular widget. This direction
8564 * controls the primary direction for widgets containing text,
8565 * and also the direction in which the children of a container are
8566 * packed. The ability to set the direction is present in order
8567 * so that correct localization into languages with right-to-left
8568 * reading directions can be done. Generally, applications will
8569 * let the default reading direction present, except for containers
8570 * where the containers are arranged in an order that is explicitely
8571 * visual rather than logical (such as buttons for text justification).
8573 * If the direction is set to %GTK_TEXT_DIR_NONE, then the value
8574 * set by gtk_widget_set_default_direction() will be used.
8577 gtk_widget_set_direction (GtkWidget *widget,
8578 GtkTextDirection dir)
8580 GtkTextDirection old_dir;
8582 g_return_if_fail (GTK_IS_WIDGET (widget));
8583 g_return_if_fail (dir >= GTK_TEXT_DIR_NONE && dir <= GTK_TEXT_DIR_RTL);
8585 old_dir = gtk_widget_get_direction (widget);
8587 if (dir == GTK_TEXT_DIR_NONE)
8588 GTK_PRIVATE_UNSET_FLAG (widget, GTK_DIRECTION_SET);
8591 GTK_PRIVATE_SET_FLAG (widget, GTK_DIRECTION_SET);
8592 if (dir == GTK_TEXT_DIR_LTR)
8593 GTK_PRIVATE_SET_FLAG (widget, GTK_DIRECTION_LTR);
8595 GTK_PRIVATE_UNSET_FLAG (widget, GTK_DIRECTION_LTR);
8598 if (old_dir != gtk_widget_get_direction (widget))
8599 gtk_widget_emit_direction_changed (widget, old_dir);
8603 * gtk_widget_get_direction:
8604 * @widget: a #GtkWidget
8606 * Gets the reading direction for a particular widget. See
8607 * gtk_widget_set_direction().
8609 * Return value: the reading direction for the widget.
8612 gtk_widget_get_direction (GtkWidget *widget)
8614 g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_TEXT_DIR_LTR);
8616 if (GTK_WIDGET_DIRECTION_SET (widget))
8617 return GTK_WIDGET_DIRECTION_LTR (widget) ? GTK_TEXT_DIR_LTR : GTK_TEXT_DIR_RTL;
8619 return gtk_default_direction;
8623 gtk_widget_set_default_direction_recurse (GtkWidget *widget, gpointer data)
8625 GtkTextDirection old_dir = GPOINTER_TO_UINT (data);
8627 g_object_ref (widget);
8629 if (!GTK_WIDGET_DIRECTION_SET (widget))
8630 gtk_widget_emit_direction_changed (widget, old_dir);
8632 if (GTK_IS_CONTAINER (widget))
8633 gtk_container_forall (GTK_CONTAINER (widget),
8634 gtk_widget_set_default_direction_recurse,
8637 g_object_unref (widget);
8641 * gtk_widget_set_default_direction:
8642 * @dir: the new default direction. This cannot be
8643 * %GTK_TEXT_DIR_NONE.
8645 * Sets the default reading direction for widgets where the
8646 * direction has not been explicitly set by gtk_widget_set_direction().
8649 gtk_widget_set_default_direction (GtkTextDirection dir)
8651 g_return_if_fail (dir == GTK_TEXT_DIR_RTL || dir == GTK_TEXT_DIR_LTR);
8653 if (dir != gtk_default_direction)
8655 GList *toplevels, *tmp_list;
8656 GtkTextDirection old_dir = gtk_default_direction;
8658 gtk_default_direction = dir;
8660 tmp_list = toplevels = gtk_window_list_toplevels ();
8661 g_list_foreach (toplevels, (GFunc)g_object_ref, NULL);
8665 gtk_widget_set_default_direction_recurse (tmp_list->data,
8666 GUINT_TO_POINTER (old_dir));
8667 g_object_unref (tmp_list->data);
8668 tmp_list = tmp_list->next;
8671 g_list_free (toplevels);
8676 * gtk_widget_get_default_direction:
8678 * Obtains the current default reading direction. See
8679 * gtk_widget_set_default_direction().
8681 * Return value: the current default direction.
8684 gtk_widget_get_default_direction (void)
8686 return gtk_default_direction;
8690 gtk_widget_dispose (GObject *object)
8692 GtkWidget *widget = GTK_WIDGET (object);
8695 gtk_container_remove (GTK_CONTAINER (widget->parent), widget);
8696 else if (GTK_WIDGET_VISIBLE (widget))
8697 gtk_widget_hide (widget);
8699 GTK_WIDGET_UNSET_FLAGS (widget, GTK_VISIBLE);
8700 if (GTK_WIDGET_REALIZED (widget))
8701 gtk_widget_unrealize (widget);
8703 G_OBJECT_CLASS (gtk_widget_parent_class)->dispose (object);
8707 gtk_widget_real_destroy (GtkObject *object)
8709 /* gtk_object_destroy() will already hold a refcount on object */
8710 GtkWidget *widget = GTK_WIDGET (object);
8712 /* wipe accelerator closures (keep order) */
8713 g_object_set_qdata (G_OBJECT (widget), quark_accel_path, NULL);
8714 g_object_set_qdata (G_OBJECT (widget), quark_accel_closures, NULL);
8716 /* Callers of add_mnemonic_label() should disconnect on ::destroy */
8717 g_object_set_qdata (G_OBJECT (widget), quark_mnemonic_labels, NULL);
8719 gtk_grab_remove (widget);
8721 g_object_unref (widget->style);
8722 widget->style = gtk_widget_get_default_style ();
8723 g_object_ref (widget->style);
8725 GTK_OBJECT_CLASS (gtk_widget_parent_class)->destroy (object);
8729 gtk_widget_finalize (GObject *object)
8731 GtkWidget *widget = GTK_WIDGET (object);
8732 GtkWidgetAuxInfo *aux_info;
8733 GtkAccessible *accessible;
8735 gtk_grab_remove (widget);
8737 g_object_unref (widget->style);
8738 widget->style = NULL;
8740 g_free (widget->name);
8742 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
8744 gtk_widget_aux_info_destroy (aux_info);
8746 accessible = g_object_get_qdata (G_OBJECT (widget), quark_accessible_object);
8748 g_object_unref (accessible);
8750 G_OBJECT_CLASS (gtk_widget_parent_class)->finalize (object);
8753 /*****************************************
8754 * gtk_widget_real_map:
8759 *****************************************/
8762 gtk_widget_real_map (GtkWidget *widget)
8764 g_assert (GTK_WIDGET_REALIZED (widget));
8766 if (!GTK_WIDGET_MAPPED (widget))
8768 GTK_WIDGET_SET_FLAGS (widget, GTK_MAPPED);
8770 if (!GTK_WIDGET_NO_WINDOW (widget))
8771 gdk_window_show (widget->window);
8775 /*****************************************
8776 * gtk_widget_real_unmap:
8781 *****************************************/
8784 gtk_widget_real_unmap (GtkWidget *widget)
8786 if (GTK_WIDGET_MAPPED (widget))
8788 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
8790 if (!GTK_WIDGET_NO_WINDOW (widget))
8791 gdk_window_hide (widget->window);
8795 /*****************************************
8796 * gtk_widget_real_realize:
8801 *****************************************/
8804 gtk_widget_real_realize (GtkWidget *widget)
8806 g_assert (GTK_WIDGET_NO_WINDOW (widget));
8808 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
8811 widget->window = gtk_widget_get_parent_window (widget);
8812 g_object_ref (widget->window);
8814 widget->style = gtk_style_attach (widget->style, widget->window);
8817 /*****************************************
8818 * gtk_widget_real_unrealize:
8823 *****************************************/
8826 gtk_widget_real_unrealize (GtkWidget *widget)
8828 if (GTK_WIDGET_MAPPED (widget))
8829 gtk_widget_real_unmap (widget);
8831 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
8833 /* printf ("unrealizing %s\n", g_type_name (G_TYPE_FROM_INSTANCE (widget)));
8836 /* We must do unrealize child widget BEFORE container widget.
8837 * gdk_window_destroy() destroys specified xwindow and its sub-xwindows.
8838 * So, unrealizing container widget bofore its children causes the problem
8839 * (for example, gdk_ic_destroy () with destroyed window causes crash. )
8842 if (GTK_IS_CONTAINER (widget))
8843 gtk_container_forall (GTK_CONTAINER (widget),
8844 (GtkCallback) gtk_widget_unrealize,
8847 gtk_style_detach (widget->style);
8848 if (!GTK_WIDGET_NO_WINDOW (widget))
8850 gdk_window_set_user_data (widget->window, NULL);
8851 gdk_window_destroy (widget->window);
8852 widget->window = NULL;
8856 g_object_unref (widget->window);
8857 widget->window = NULL;
8860 gtk_selection_remove_all (widget);
8862 GTK_WIDGET_UNSET_FLAGS (widget, GTK_REALIZED);
8866 gtk_widget_real_size_request (GtkWidget *widget,
8867 GtkRequisition *requisition)
8869 requisition->width = widget->requisition.width;
8870 requisition->height = widget->requisition.height;
8874 * _gtk_widget_peek_colormap:
8876 * Returns colormap currently pushed by gtk_widget_push_colormap, if any.
8878 * Return value: the currently pushed colormap, or %NULL if there is none.
8881 _gtk_widget_peek_colormap (void)
8884 return (GdkColormap*) colormap_stack->data;
8889 * _gtk_widget_set_pointer_window:
8890 * @widget: a #GtkWidget.
8891 * @pointer_window: the new pointer window.
8893 * Sets pointer window for @widget. Does not ref @pointer_window.
8894 * Actually stores it on the #GdkScreen, but you don't need to know that.
8897 _gtk_widget_set_pointer_window (GtkWidget *widget,
8898 GdkWindow *pointer_window)
8900 g_return_if_fail (GTK_IS_WIDGET (widget));
8902 if (GTK_WIDGET_REALIZED (widget))
8904 GdkScreen *screen = gdk_drawable_get_screen (widget->window);
8906 g_object_set_qdata (G_OBJECT (screen), quark_pointer_window,
8912 * _gtk_widget_get_pointer_window:
8913 * @widget: a #GtkWidget.
8915 * Return value: the pointer window set on the #GdkScreen @widget is attached
8919 _gtk_widget_get_pointer_window (GtkWidget *widget)
8921 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
8923 if (GTK_WIDGET_REALIZED (widget))
8925 GdkScreen *screen = gdk_drawable_get_screen (widget->window);
8927 return g_object_get_qdata (G_OBJECT (screen), quark_pointer_window);
8934 synth_crossing (GtkWidget *widget,
8937 GdkCrossingMode mode,
8938 GdkNotifyType detail)
8942 event = gdk_event_new (type);
8944 event->crossing.window = g_object_ref (window);
8945 event->crossing.send_event = TRUE;
8946 event->crossing.subwindow = g_object_ref (window);
8947 event->crossing.time = GDK_CURRENT_TIME;
8948 event->crossing.x = event->crossing.y = 0;
8949 event->crossing.x_root = event->crossing.y_root = 0;
8950 event->crossing.mode = mode;
8951 event->crossing.detail = detail;
8952 event->crossing.focus = FALSE;
8953 event->crossing.state = 0;
8956 widget = gtk_get_event_widget (event);
8959 gtk_widget_event_internal (widget, event);
8961 gdk_event_free (event);
8965 * _gtk_widget_is_pointer_widget:
8966 * @widget: a #GtkWidget
8968 * Returns %TRUE if the pointer window belongs to @widget.
8971 _gtk_widget_is_pointer_widget (GtkWidget *widget)
8973 if (GTK_WIDGET_HAS_POINTER (widget))
8978 win = _gtk_widget_get_pointer_window (widget);
8981 gdk_window_get_user_data (win, (gpointer *)&wid);
8991 * _gtk_widget_synthesize_crossing:
8992 * @from: the #GtkWidget the virtual pointer is leaving.
8993 * @to: the #GtkWidget the virtual pointer is moving to.
8994 * @mode: the #GdkCrossingMode to place on the synthesized events.
8996 * Generate crossing event(s) on widget state (sensitivity) or GTK+ grab change.
8998 * The real pointer window is the window that most recently received an enter notify
8999 * event. Windows that don't select for crossing events can't become the real
9000 * poiner window. The real pointer widget that owns the real pointer window. The
9001 * effective pointer window is the same as the real pointer window unless the real
9002 * pointer widget is either insensitive or there is a grab on a widget that is not
9003 * an ancestor of the real pointer widget (in which case the effective pointer
9004 * window should be the root window).
9006 * When the effective pointer window is the same as the real poiner window, we
9007 * receive crossing events from the windowing system. When the effective pointer
9008 * window changes to become different from the real pointer window we synthesize
9009 * crossing events, attempting to follow X protocol rules:
9011 * When the root window becomes the effective pointer window:
9012 * - leave notify on real pointer window, detail Ancestor
9013 * - leave notify on all of its ancestors, detail Virtual
9014 * - enter notify on root window, detail Inferior
9016 * When the root window ceases to be the effective pointer window:
9017 * - leave notify on root window, detail Inferior
9018 * - enter notify on all ancestors of real pointer window, detail Virtual
9019 * - enter notify on real pointer window, detail Ancestor
9022 _gtk_widget_synthesize_crossing (GtkWidget *from,
9024 GdkCrossingMode mode)
9026 GdkWindow *from_window = NULL, *to_window = NULL;
9028 g_return_if_fail (from != NULL || to != NULL);
9031 from_window = GTK_WIDGET_HAS_POINTER (from)
9032 ? _gtk_widget_get_pointer_window (from) : from->window;
9034 to_window = GTK_WIDGET_HAS_POINTER (to)
9035 ? _gtk_widget_get_pointer_window (to) : to->window;
9037 if (from_window == NULL && to_window == NULL)
9039 else if (from_window != NULL && to_window == NULL)
9041 GList *from_ancestors = NULL, *list;
9042 GdkWindow *from_ancestor = from_window;
9044 while (from_ancestor != NULL)
9046 from_ancestor = gdk_window_get_parent (from_ancestor);
9047 if (from_ancestor == NULL)
9049 from_ancestors = g_list_prepend (from_ancestors, from_ancestor);
9052 synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
9053 mode, GDK_NOTIFY_ANCESTOR);
9054 for (list = g_list_last (from_ancestors); list; list = list->prev)
9056 synth_crossing (NULL, GDK_LEAVE_NOTIFY, (GdkWindow *) list->data,
9057 mode, GDK_NOTIFY_VIRTUAL);
9060 /* XXX: enter/inferior on root window? */
9062 g_list_free (from_ancestors);
9064 else if (from_window == NULL && to_window != NULL)
9066 GList *to_ancestors = NULL, *list;
9067 GdkWindow *to_ancestor = to_window;
9069 while (to_ancestor != NULL)
9071 to_ancestor = gdk_window_get_parent (to_ancestor);
9072 if (to_ancestor == NULL)
9074 to_ancestors = g_list_prepend (to_ancestors, to_ancestor);
9077 /* XXX: leave/inferior on root window? */
9079 for (list = to_ancestors; list; list = list->next)
9081 synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
9082 mode, GDK_NOTIFY_VIRTUAL);
9084 synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
9085 mode, GDK_NOTIFY_ANCESTOR);
9087 g_list_free (to_ancestors);
9089 else if (from_window == to_window)
9093 GList *from_ancestors = NULL, *to_ancestors = NULL, *list;
9094 GdkWindow *from_ancestor = from_window, *to_ancestor = to_window;
9096 while (from_ancestor != NULL || to_ancestor != NULL)
9098 if (from_ancestor != NULL)
9100 from_ancestor = gdk_window_get_parent (from_ancestor);
9101 if (from_ancestor == to_window)
9104 from_ancestors = g_list_prepend (from_ancestors, from_ancestor);
9106 if (to_ancestor != NULL)
9108 to_ancestor = gdk_window_get_parent (to_ancestor);
9109 if (to_ancestor == from_window)
9112 to_ancestors = g_list_prepend (to_ancestors, to_ancestor);
9115 if (to_ancestor == from_window)
9117 if (mode != GDK_CROSSING_GTK_UNGRAB)
9118 synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
9119 mode, GDK_NOTIFY_INFERIOR);
9120 for (list = to_ancestors; list; list = list->next)
9121 synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
9122 mode, GDK_NOTIFY_VIRTUAL);
9123 synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
9124 mode, GDK_NOTIFY_ANCESTOR);
9126 else if (from_ancestor == to_window)
9128 synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
9129 mode, GDK_NOTIFY_ANCESTOR);
9130 for (list = g_list_last (from_ancestors); list; list = list->prev)
9132 synth_crossing (NULL, GDK_LEAVE_NOTIFY, (GdkWindow *) list->data,
9133 mode, GDK_NOTIFY_VIRTUAL);
9135 if (mode != GDK_CROSSING_GTK_GRAB)
9136 synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
9137 mode, GDK_NOTIFY_INFERIOR);
9141 while (from_ancestors != NULL && to_ancestors != NULL
9142 && from_ancestors->data == to_ancestors->data)
9144 from_ancestors = g_list_delete_link (from_ancestors,
9146 to_ancestors = g_list_delete_link (to_ancestors, to_ancestors);
9149 synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
9150 mode, GDK_NOTIFY_NONLINEAR);
9152 for (list = g_list_last (from_ancestors); list; list = list->prev)
9154 synth_crossing (NULL, GDK_LEAVE_NOTIFY, (GdkWindow *) list->data,
9155 mode, GDK_NOTIFY_NONLINEAR_VIRTUAL);
9157 for (list = to_ancestors; list; list = list->next)
9159 synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
9160 mode, GDK_NOTIFY_NONLINEAR_VIRTUAL);
9162 synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
9163 mode, GDK_NOTIFY_NONLINEAR);
9165 g_list_free (from_ancestors);
9166 g_list_free (to_ancestors);
9171 gtk_widget_propagate_state (GtkWidget *widget,
9174 guint8 old_state = GTK_WIDGET_STATE (widget);
9175 guint8 old_saved_state = widget->saved_state;
9177 /* don't call this function with state==GTK_STATE_INSENSITIVE,
9178 * parent_sensitive==TRUE on a sensitive widget
9182 if (data->parent_sensitive)
9183 GTK_WIDGET_SET_FLAGS (widget, GTK_PARENT_SENSITIVE);
9185 GTK_WIDGET_UNSET_FLAGS (widget, GTK_PARENT_SENSITIVE);
9187 if (GTK_WIDGET_IS_SENSITIVE (widget))
9189 if (data->state_restoration)
9190 GTK_WIDGET_STATE (widget) = widget->saved_state;
9192 GTK_WIDGET_STATE (widget) = data->state;
9196 if (!data->state_restoration)
9198 if (data->state != GTK_STATE_INSENSITIVE)
9199 widget->saved_state = data->state;
9201 else if (GTK_WIDGET_STATE (widget) != GTK_STATE_INSENSITIVE)
9202 widget->saved_state = GTK_WIDGET_STATE (widget);
9203 GTK_WIDGET_STATE (widget) = GTK_STATE_INSENSITIVE;
9206 if (gtk_widget_is_focus (widget) && !GTK_WIDGET_IS_SENSITIVE (widget))
9210 window = gtk_widget_get_toplevel (widget);
9211 if (window && gtk_widget_is_toplevel (window))
9212 gtk_window_set_focus (GTK_WINDOW (window), NULL);
9215 if (old_state != GTK_WIDGET_STATE (widget) ||
9216 old_saved_state != widget->saved_state)
9218 g_object_ref (widget);
9220 if (!GTK_WIDGET_IS_SENSITIVE (widget) && gtk_widget_has_grab (widget))
9221 gtk_grab_remove (widget);
9223 g_signal_emit (widget, widget_signals[STATE_CHANGED], 0, old_state);
9225 if (GTK_WIDGET_HAS_POINTER (widget) && !GTK_WIDGET_SHADOWED (widget))
9227 if (!GTK_WIDGET_IS_SENSITIVE (widget))
9228 _gtk_widget_synthesize_crossing (widget, NULL,
9229 GDK_CROSSING_STATE_CHANGED);
9230 else if (old_state == GTK_STATE_INSENSITIVE)
9231 _gtk_widget_synthesize_crossing (NULL, widget,
9232 GDK_CROSSING_STATE_CHANGED);
9235 if (GTK_IS_CONTAINER (widget))
9237 data->parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget) != FALSE);
9238 if (data->use_forall)
9239 gtk_container_forall (GTK_CONTAINER (widget),
9240 (GtkCallback) gtk_widget_propagate_state,
9243 gtk_container_foreach (GTK_CONTAINER (widget),
9244 (GtkCallback) gtk_widget_propagate_state,
9247 g_object_unref (widget);
9252 * _gtk_widget_get_aux_info:
9253 * @widget: a #GtkWidget
9254 * @create: if %TRUE, create the structure if it doesn't exist
9256 * Get the #GtkWidgetAuxInfo structure for the widget.
9258 * Return value: the #GtkAuxInfo structure for the widget, or
9259 * %NULL if @create is %FALSE and one doesn't already exist.
9262 _gtk_widget_get_aux_info (GtkWidget *widget,
9265 GtkWidgetAuxInfo *aux_info;
9267 aux_info = g_object_get_qdata (G_OBJECT (widget), quark_aux_info);
9268 if (!aux_info && create)
9270 aux_info = g_slice_new0 (GtkWidgetAuxInfo);
9272 aux_info->width = -1;
9273 aux_info->height = -1;
9275 g_object_set_qdata (G_OBJECT (widget), quark_aux_info, aux_info);
9281 /*****************************************
9282 * gtk_widget_aux_info_destroy:
9287 *****************************************/
9290 gtk_widget_aux_info_destroy (GtkWidgetAuxInfo *aux_info)
9292 g_slice_free (GtkWidgetAuxInfo, aux_info);
9296 gtk_widget_shape_info_destroy (GtkWidgetShapeInfo *info)
9298 g_object_unref (info->shape_mask);
9299 g_slice_free (GtkWidgetShapeInfo, info);
9303 * gtk_widget_shape_combine_mask:
9304 * @widget: a #GtkWidget
9305 * @shape_mask: (allow-none): shape to be added, or %NULL to remove an existing shape
9306 * @offset_x: X position of shape mask with respect to @window
9307 * @offset_y: Y position of shape mask with respect to @window
9309 * Sets a shape for this widget's GDK window. This allows for
9310 * transparent windows etc., see gdk_window_shape_combine_mask()
9311 * for more information.
9314 gtk_widget_shape_combine_mask (GtkWidget *widget,
9315 GdkBitmap *shape_mask,
9319 GtkWidgetShapeInfo* shape_info;
9321 g_return_if_fail (GTK_IS_WIDGET (widget));
9322 /* set_shape doesn't work on widgets without gdk window */
9323 g_return_if_fail (!GTK_WIDGET_NO_WINDOW (widget));
9327 GTK_PRIVATE_UNSET_FLAG (widget, GTK_HAS_SHAPE_MASK);
9330 gdk_window_shape_combine_mask (widget->window, NULL, 0, 0);
9332 g_object_set_qdata (G_OBJECT (widget), quark_shape_info, NULL);
9336 GTK_PRIVATE_SET_FLAG (widget, GTK_HAS_SHAPE_MASK);
9338 shape_info = g_slice_new (GtkWidgetShapeInfo);
9339 g_object_set_qdata_full (G_OBJECT (widget), quark_shape_info, shape_info,
9340 (GDestroyNotify) gtk_widget_shape_info_destroy);
9342 shape_info->shape_mask = g_object_ref (shape_mask);
9343 shape_info->offset_x = offset_x;
9344 shape_info->offset_y = offset_y;
9346 /* set shape if widget has a gdk window already.
9347 * otherwise the shape is scheduled to be set by gtk_widget_realize().
9350 gdk_window_shape_combine_mask (widget->window, shape_mask,
9351 offset_x, offset_y);
9356 * gtk_widget_input_shape_combine_mask:
9357 * @widget: a #GtkWidget
9358 * @shape_mask: (allow-none): shape to be added, or %NULL to remove an existing shape
9359 * @offset_x: X position of shape mask with respect to @window
9360 * @offset_y: Y position of shape mask with respect to @window
9362 * Sets an input shape for this widget's GDK window. This allows for
9363 * windows which react to mouse click in a nonrectangular region, see
9364 * gdk_window_input_shape_combine_mask() for more information.
9369 gtk_widget_input_shape_combine_mask (GtkWidget *widget,
9370 GdkBitmap *shape_mask,
9374 GtkWidgetShapeInfo* shape_info;
9376 g_return_if_fail (GTK_IS_WIDGET (widget));
9377 /* set_shape doesn't work on widgets without gdk window */
9378 g_return_if_fail (!GTK_WIDGET_NO_WINDOW (widget));
9383 gdk_window_input_shape_combine_mask (widget->window, NULL, 0, 0);
9385 g_object_set_qdata (G_OBJECT (widget), quark_input_shape_info, NULL);
9389 shape_info = g_slice_new (GtkWidgetShapeInfo);
9390 g_object_set_qdata_full (G_OBJECT (widget), quark_input_shape_info,
9392 (GDestroyNotify) gtk_widget_shape_info_destroy);
9394 shape_info->shape_mask = g_object_ref (shape_mask);
9395 shape_info->offset_x = offset_x;
9396 shape_info->offset_y = offset_y;
9398 /* set shape if widget has a gdk window already.
9399 * otherwise the shape is scheduled to be set by gtk_widget_realize().
9402 gdk_window_input_shape_combine_mask (widget->window, shape_mask,
9403 offset_x, offset_y);
9409 gtk_reset_shapes_recurse (GtkWidget *widget,
9415 gdk_window_get_user_data (window, &data);
9419 gdk_window_shape_combine_mask (window, NULL, 0, 0);
9420 for (list = gdk_window_peek_children (window); list; list = list->next)
9421 gtk_reset_shapes_recurse (widget, list->data);
9425 * gtk_widget_reset_shapes:
9426 * @widget: a #GtkWidget
9428 * Recursively resets the shape on this widget and its descendants.
9431 gtk_widget_reset_shapes (GtkWidget *widget)
9433 g_return_if_fail (GTK_IS_WIDGET (widget));
9434 g_return_if_fail (GTK_WIDGET_REALIZED (widget));
9436 if (!GTK_WIDGET_HAS_SHAPE_MASK (widget))
9437 gtk_reset_shapes_recurse (widget, widget->window);
9442 * @widget: a #GtkWidget
9444 * Adds a reference to a widget. This function is exactly the same
9445 * as calling g_object_ref(), and exists mostly for historical
9446 * reasons. It can still be convenient to avoid casting a widget
9447 * to a #GObject, it saves a small amount of typing.
9449 * Return value: the widget that was referenced
9451 * Deprecated: 2.12: Use g_object_ref() instead.
9454 gtk_widget_ref (GtkWidget *widget)
9456 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9458 return (GtkWidget*) g_object_ref ((GObject*) widget);
9463 * @widget: a #GtkWidget
9465 * Inverse of gtk_widget_ref(). Equivalent to g_object_unref().
9467 * Deprecated: 2.12: Use g_object_unref() instead.
9470 gtk_widget_unref (GtkWidget *widget)
9472 g_return_if_fail (GTK_IS_WIDGET (widget));
9474 g_object_unref ((GObject*) widget);
9478 expose_window (GdkWindow *window)
9481 GList *l, *children;
9483 gboolean is_double_buffered;
9485 gdk_window_get_user_data (window, &user_data);
9488 is_double_buffered = gtk_widget_get_double_buffered (GTK_WIDGET (user_data));
9490 is_double_buffered = FALSE;
9492 event.expose.type = GDK_EXPOSE;
9493 event.expose.window = g_object_ref (window);
9494 event.expose.send_event = FALSE;
9495 event.expose.count = 0;
9496 event.expose.area.x = 0;
9497 event.expose.area.y = 0;
9498 gdk_drawable_get_size (GDK_DRAWABLE (window),
9499 &event.expose.area.width,
9500 &event.expose.area.height);
9501 event.expose.region = gdk_region_rectangle (&event.expose.area);
9503 /* If this is not double buffered, force a double buffer so that
9504 redirection works. */
9505 if (!is_double_buffered)
9506 gdk_window_begin_paint_region (window, event.expose.region);
9508 gtk_main_do_event (&event);
9510 if (!is_double_buffered)
9511 gdk_window_end_paint (window);
9513 children = gdk_window_peek_children (window);
9514 for (l = children; l != NULL; l = l->next)
9516 GdkWindow *child = l->data;
9518 /* Don't expose input-only windows */
9519 if (gdk_drawable_get_depth (GDK_DRAWABLE (child)) != 0)
9520 expose_window (l->data);
9523 g_object_unref (window);
9527 * gtk_widget_get_snapshot:
9528 * @widget: a #GtkWidget
9529 * @clip_rect: (allow-none): a #GdkRectangle or %NULL
9531 * Create a #GdkPixmap of the contents of the widget and its children.
9533 * Works even if the widget is obscured. The depth and visual of the
9534 * resulting pixmap is dependent on the widget being snapshot and likely
9535 * differs from those of a target widget displaying the pixmap.
9536 * The function gdk_pixbuf_get_from_drawable() can be used to convert
9537 * the pixmap to a visual independant representation.
9539 * The snapshot area used by this function is the @widget's allocation plus
9540 * any extra space occupied by additional windows belonging to this widget
9541 * (such as the arrows of a spin button).
9542 * Thus, the resulting snapshot pixmap is possibly larger than the allocation.
9544 * If @clip_rect is non-%NULL, the resulting pixmap is shrunken to
9545 * match the specified clip_rect. The (x,y) coordinates of @clip_rect are
9546 * interpreted widget relative. If width or height of @clip_rect are 0 or
9547 * negative, the width or height of the resulting pixmap will be shrunken
9548 * by the respective amount.
9549 * For instance a @clip_rect <literal>{ +5, +5, -10, -10 }</literal> will
9550 * chop off 5 pixels at each side of the snapshot pixmap.
9551 * If non-%NULL, @clip_rect will contain the exact widget-relative snapshot
9552 * coordinates upon return. A @clip_rect of <literal>{ -1, -1, 0, 0 }</literal>
9553 * can be used to preserve the auto-grown snapshot area and use @clip_rect
9554 * as a pure output parameter.
9556 * The returned pixmap can be %NULL, if the resulting @clip_area was empty.
9558 * Return value: #GdkPixmap snapshot of the widget
9563 gtk_widget_get_snapshot (GtkWidget *widget,
9564 GdkRectangle *clip_rect)
9566 int x, y, width, height;
9567 GdkWindow *parent_window = NULL;
9569 GList *windows = NULL, *list;
9571 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
9572 if (!GTK_WIDGET_VISIBLE (widget))
9575 /* the widget (and parent_window) must be realized to be drawable */
9576 if (widget->parent && !GTK_WIDGET_REALIZED (widget->parent))
9577 gtk_widget_realize (widget->parent);
9578 if (!GTK_WIDGET_REALIZED (widget))
9579 gtk_widget_realize (widget);
9581 /* determine snapshot rectangle */
9582 x = widget->allocation.x;
9583 y = widget->allocation.y;
9584 width = widget->allocation.width;
9585 height = widget->allocation.height;
9587 if (widget->parent && !GTK_WIDGET_NO_WINDOW (widget))
9589 /* grow snapshot rectangle to cover all widget windows */
9590 parent_window = gtk_widget_get_parent_window (widget);
9591 for (list = gdk_window_peek_children (parent_window); list; list = list->next)
9593 GdkWindow *subwin = list->data;
9596 gdk_window_get_user_data (subwin, &windata);
9597 if (windata != widget)
9599 windows = g_list_prepend (windows, subwin);
9600 gdk_window_get_position (subwin, &wx, &wy);
9601 gdk_drawable_get_size (subwin, &ww, &wh);
9602 /* grow snapshot rectangle by extra widget sub window */
9613 if (x + width < wx + ww)
9614 width += wx + ww - (x + width);
9615 if (y + height < wy + wh)
9616 height += wy + wh - (y + height);
9619 else if (!widget->parent)
9620 x = y = 0; /* toplevel */
9622 /* at this point, (x,y,width,height) is the parent_window relative
9623 * snapshot area covering all of widget's windows.
9626 /* shrink snapshot size by clip_rectangle */
9629 GdkRectangle snap = { x, y, width, height }, clip = *clip_rect;
9630 clip.x = clip.x < 0 ? x : clip.x;
9631 clip.y = clip.y < 0 ? y : clip.y;
9632 clip.width = clip.width <= 0 ? MAX (0, width + clip.width) : clip.width;
9633 clip.height = clip.height <= 0 ? MAX (0, height + clip.height) : clip.height;
9636 /* offset clip_rect, so it's parent_window relative */
9637 if (clip_rect->x >= 0)
9638 clip.x += widget->allocation.x;
9639 if (clip_rect->y >= 0)
9640 clip.y += widget->allocation.y;
9642 if (!gdk_rectangle_intersect (&snap, &clip, &snap))
9644 g_list_free (windows);
9645 clip_rect->width = clip_rect->height = 0;
9646 return NULL; /* empty snapshot area */
9651 height = snap.height;
9654 /* render snapshot */
9655 pixmap = gdk_pixmap_new (widget->window, width, height, gdk_drawable_get_depth (widget->window));
9656 for (list = windows; list; list = list->next) /* !NO_WINDOW widgets */
9658 GdkWindow *subwin = list->data;
9660 if (gdk_drawable_get_depth (GDK_DRAWABLE (subwin)) == 0)
9661 continue; /* Input only window */
9662 gdk_window_get_position (subwin, &wx, &wy);
9663 gdk_window_redirect_to_drawable (subwin, pixmap, MAX (0, x - wx), MAX (0, y - wy),
9664 MAX (0, wx - x), MAX (0, wy - y), width, height);
9666 expose_window (subwin);
9668 if (!windows) /* NO_WINDOW || toplevel => parent_window == NULL || parent_window == widget->window */
9670 gdk_window_redirect_to_drawable (widget->window, pixmap, x, y, 0, 0, width, height);
9671 expose_window (widget->window);
9673 for (list = windows; list; list = list->next)
9674 gdk_window_remove_redirection (list->data);
9675 if (!windows) /* NO_WINDOW || toplevel */
9676 gdk_window_remove_redirection (widget->window);
9677 g_list_free (windows);
9679 /* return pixmap and snapshot rectangle coordinates */
9684 clip_rect->width = width;
9685 clip_rect->height = height;
9688 /* offset clip_rect from parent_window so it's widget relative */
9689 clip_rect->x -= widget->allocation.x;
9690 clip_rect->y -= widget->allocation.y;
9693 g_printerr ("gtk_widget_get_snapshot: %s (%d,%d, %dx%d)\n",
9694 G_OBJECT_TYPE_NAME (widget),
9695 clip_rect->x, clip_rect->y, clip_rect->width, clip_rect->height);
9704 * gtk_widget_class_install_style_property_parser:
9705 * @klass: a #GtkWidgetClass
9706 * @pspec: the #GParamSpec for the style property
9707 * @parser: the parser for the style property
9709 * Installs a style property on a widget class.
9712 gtk_widget_class_install_style_property_parser (GtkWidgetClass *klass,
9714 GtkRcPropertyParser parser)
9716 g_return_if_fail (GTK_IS_WIDGET_CLASS (klass));
9717 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
9718 g_return_if_fail (pspec->flags & G_PARAM_READABLE);
9719 g_return_if_fail (!(pspec->flags & (G_PARAM_CONSTRUCT_ONLY | G_PARAM_CONSTRUCT)));
9721 if (g_param_spec_pool_lookup (style_property_spec_pool, pspec->name, G_OBJECT_CLASS_TYPE (klass), FALSE))
9723 g_warning (G_STRLOC ": class `%s' already contains a style property named `%s'",
9724 G_OBJECT_CLASS_NAME (klass),
9729 g_param_spec_ref_sink (pspec);
9730 g_param_spec_set_qdata (pspec, quark_property_parser, (gpointer) parser);
9731 g_param_spec_pool_insert (style_property_spec_pool, pspec, G_OBJECT_CLASS_TYPE (klass));
9735 * gtk_widget_class_install_style_property:
9736 * @klass: a #GtkWidgetClass
9737 * @pspec: the #GParamSpec for the property
9739 * Installs a style property on a widget class. The parser for the
9740 * style property is determined by the value type of @pspec.
9743 gtk_widget_class_install_style_property (GtkWidgetClass *klass,
9746 GtkRcPropertyParser parser;
9748 g_return_if_fail (GTK_IS_WIDGET_CLASS (klass));
9749 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
9751 parser = _gtk_rc_property_parser_from_type (G_PARAM_SPEC_VALUE_TYPE (pspec));
9753 gtk_widget_class_install_style_property_parser (klass, pspec, parser);
9757 * gtk_widget_class_find_style_property:
9758 * @klass: a #GtkWidgetClass
9759 * @property_name: the name of the style property to find
9760 * @returns: (allow-none): the #GParamSpec of the style property or %NULL if @class has no
9761 * style property with that name.
9763 * Finds a style property of a widget class by name.
9768 gtk_widget_class_find_style_property (GtkWidgetClass *klass,
9769 const gchar *property_name)
9771 g_return_val_if_fail (property_name != NULL, NULL);
9773 return g_param_spec_pool_lookup (style_property_spec_pool,
9775 G_OBJECT_CLASS_TYPE (klass),
9780 * gtk_widget_class_list_style_properties:
9781 * @klass: a #GtkWidgetClass
9782 * @n_properties: location to return the number of style properties found
9783 * @returns: an newly allocated array of #GParamSpec*. The array must
9784 * be freed with g_free().
9786 * Returns all style properties of a widget class.
9791 gtk_widget_class_list_style_properties (GtkWidgetClass *klass,
9792 guint *n_properties)
9794 GParamSpec **pspecs;
9797 pspecs = g_param_spec_pool_list (style_property_spec_pool,
9798 G_OBJECT_CLASS_TYPE (klass),
9807 * gtk_widget_style_get_property:
9808 * @widget: a #GtkWidget
9809 * @property_name: the name of a style property
9810 * @value: location to return the property value
9812 * Gets the value of a style property of @widget.
9815 gtk_widget_style_get_property (GtkWidget *widget,
9816 const gchar *property_name,
9821 g_return_if_fail (GTK_IS_WIDGET (widget));
9822 g_return_if_fail (property_name != NULL);
9823 g_return_if_fail (G_IS_VALUE (value));
9825 g_object_ref (widget);
9826 pspec = g_param_spec_pool_lookup (style_property_spec_pool,
9828 G_OBJECT_TYPE (widget),
9831 g_warning ("%s: widget class `%s' has no property named `%s'",
9833 G_OBJECT_TYPE_NAME (widget),
9837 const GValue *peek_value;
9839 peek_value = _gtk_style_peek_property_value (widget->style,
9840 G_OBJECT_TYPE (widget),
9842 (GtkRcPropertyParser) g_param_spec_get_qdata (pspec, quark_property_parser));
9844 /* auto-conversion of the caller's value type
9846 if (G_VALUE_TYPE (value) == G_PARAM_SPEC_VALUE_TYPE (pspec))
9847 g_value_copy (peek_value, value);
9848 else if (g_value_type_transformable (G_PARAM_SPEC_VALUE_TYPE (pspec), G_VALUE_TYPE (value)))
9849 g_value_transform (peek_value, value);
9851 g_warning ("can't retrieve style property `%s' of type `%s' as value of type `%s'",
9853 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
9854 G_VALUE_TYPE_NAME (value));
9856 g_object_unref (widget);
9860 * gtk_widget_style_get_valist:
9861 * @widget: a #GtkWidget
9862 * @first_property_name: the name of the first property to get
9863 * @var_args: a <type>va_list</type> of pairs of property names and
9864 * locations to return the property values, starting with the location
9865 * for @first_property_name.
9867 * Non-vararg variant of gtk_widget_style_get(). Used primarily by language
9871 gtk_widget_style_get_valist (GtkWidget *widget,
9872 const gchar *first_property_name,
9877 g_return_if_fail (GTK_IS_WIDGET (widget));
9879 g_object_ref (widget);
9881 name = first_property_name;
9884 const GValue *peek_value;
9888 pspec = g_param_spec_pool_lookup (style_property_spec_pool,
9890 G_OBJECT_TYPE (widget),
9894 g_warning ("%s: widget class `%s' has no property named `%s'",
9896 G_OBJECT_TYPE_NAME (widget),
9900 /* style pspecs are always readable so we can spare that check here */
9902 peek_value = _gtk_style_peek_property_value (widget->style,
9903 G_OBJECT_TYPE (widget),
9905 (GtkRcPropertyParser) g_param_spec_get_qdata (pspec, quark_property_parser));
9906 G_VALUE_LCOPY (peek_value, var_args, 0, &error);
9909 g_warning ("%s: %s", G_STRLOC, error);
9914 name = va_arg (var_args, gchar*);
9917 g_object_unref (widget);
9921 * gtk_widget_style_get:
9922 * @widget: a #GtkWidget
9923 * @first_property_name: the name of the first property to get
9924 * @Varargs: pairs of property names and locations to
9925 * return the property values, starting with the location for
9926 * @first_property_name, terminated by %NULL.
9928 * Gets the values of a multiple style properties of @widget.
9931 gtk_widget_style_get (GtkWidget *widget,
9932 const gchar *first_property_name,
9937 g_return_if_fail (GTK_IS_WIDGET (widget));
9939 va_start (var_args, first_property_name);
9940 gtk_widget_style_get_valist (widget, first_property_name, var_args);
9946 * @widget: a #GtkWidget
9947 * @path_length: (out) (allow-none): location to store length of the path, or %NULL
9948 * @path: (out) (allow-none): location to store allocated path string, or %NULL
9949 * @path_reversed: (out) (allow-none): location to store allocated reverse path string, or %NULL
9951 * Obtains the full path to @widget. The path is simply the name of a
9952 * widget and all its parents in the container hierarchy, separated by
9953 * periods. The name of a widget comes from
9954 * gtk_widget_get_name(). Paths are used to apply styles to a widget
9955 * in gtkrc configuration files. Widget names are the type of the
9956 * widget by default (e.g. "GtkButton") or can be set to an
9957 * application-specific value with gtk_widget_set_name(). By setting
9958 * the name of a widget, you allow users or theme authors to apply
9959 * styles to that specific widget in their gtkrc
9960 * file. @path_reversed_p fills in the path in reverse order,
9961 * i.e. starting with @widget's name instead of starting with the name
9962 * of @widget's outermost ancestor.
9965 gtk_widget_path (GtkWidget *widget,
9968 gchar **path_reversed)
9970 static gchar *rev_path = NULL;
9971 static guint tmp_path_len = 0;
9974 g_return_if_fail (GTK_IS_WIDGET (widget));
9979 const gchar *string;
9984 string = gtk_widget_get_name (widget);
9985 l = strlen (string);
9986 while (tmp_path_len <= len + l + 1)
9988 tmp_path_len += INIT_PATH_SIZE;
9989 rev_path = g_realloc (rev_path, tmp_path_len);
9997 widget = widget->parent;
10000 rev_path[len++] = '.';
10002 rev_path[len++] = 0;
10007 *path_length = len - 1;
10009 *path_reversed = g_strdup (rev_path);
10012 *path = g_strdup (rev_path);
10013 g_strreverse (*path);
10018 * gtk_widget_class_path:
10019 * @widget: a #GtkWidget
10020 * @path_length: (out) (allow-none): location to store the length of the class path, or %NULL
10021 * @path: (out) (allow-none) location to store the class path as an allocated string, or %NULL
10022 * @path_reversed: (out) (allow-none) location to store the reverse class path as an allocated
10025 * Same as gtk_widget_path(), but always uses the name of a widget's type,
10026 * never uses a custom name set with gtk_widget_set_name().
10030 gtk_widget_class_path (GtkWidget *widget,
10031 guint *path_length,
10033 gchar **path_reversed)
10035 static gchar *rev_path = NULL;
10036 static guint tmp_path_len = 0;
10039 g_return_if_fail (GTK_IS_WIDGET (widget));
10044 const gchar *string;
10049 string = g_type_name (G_OBJECT_TYPE (widget));
10050 l = strlen (string);
10051 while (tmp_path_len <= len + l + 1)
10053 tmp_path_len += INIT_PATH_SIZE;
10054 rev_path = g_realloc (rev_path, tmp_path_len);
10056 s = string + l - 1;
10057 d = rev_path + len;
10058 while (s >= string)
10062 widget = widget->parent;
10065 rev_path[len++] = '.';
10067 rev_path[len++] = 0;
10072 *path_length = len - 1;
10074 *path_reversed = g_strdup (rev_path);
10077 *path = g_strdup (rev_path);
10078 g_strreverse (*path);
10083 * gtk_requisition_copy:
10084 * @requisition: a #GtkRequisition
10086 * Copies a #GtkRequisition.
10088 * Returns: a copy of @requisition
10091 gtk_requisition_copy (const GtkRequisition *requisition)
10093 return (GtkRequisition *)g_memdup (requisition, sizeof (GtkRequisition));
10097 * gtk_requisition_free:
10098 * @requisition: a #GtkRequisition
10100 * Frees a #GtkRequisition.
10103 gtk_requisition_free (GtkRequisition *requisition)
10105 g_free (requisition);
10109 gtk_requisition_get_type (void)
10111 static GType our_type = 0;
10114 our_type = g_boxed_type_register_static (I_("GtkRequisition"),
10115 (GBoxedCopyFunc) gtk_requisition_copy,
10116 (GBoxedFreeFunc) gtk_requisition_free);
10122 * gtk_widget_get_accessible:
10123 * @widget: a #GtkWidget
10125 * Returns the accessible object that describes the widget to an
10126 * assistive technology.
10128 * If no accessibility library is loaded (i.e. no ATK implementation library is
10129 * loaded via <envar>GTK_MODULES</envar> or via another application library,
10130 * such as libgnome), then this #AtkObject instance may be a no-op. Likewise,
10131 * if no class-specific #AtkObject implementation is available for the widget
10132 * instance in question, it will inherit an #AtkObject implementation from the
10133 * first ancestor class for which such an implementation is defined.
10135 * The documentation of the <ulink url="http://developer.gnome.org/doc/API/2.0/atk/index.html">ATK</ulink>
10136 * library contains more information about accessible objects and their uses.
10138 * Returns: (transfer none): the #AtkObject associated with @widget
10141 gtk_widget_get_accessible (GtkWidget *widget)
10143 GtkWidgetClass *klass;
10145 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10147 klass = GTK_WIDGET_GET_CLASS (widget);
10149 g_return_val_if_fail (klass->get_accessible != NULL, NULL);
10151 return klass->get_accessible (widget);
10155 gtk_widget_real_get_accessible (GtkWidget *widget)
10157 AtkObject* accessible;
10159 accessible = g_object_get_qdata (G_OBJECT (widget),
10160 quark_accessible_object);
10163 AtkObjectFactory *factory;
10164 AtkRegistry *default_registry;
10166 default_registry = atk_get_default_registry ();
10167 factory = atk_registry_get_factory (default_registry,
10168 G_TYPE_FROM_INSTANCE (widget));
10170 atk_object_factory_create_accessible (factory,
10171 G_OBJECT (widget));
10172 g_object_set_qdata (G_OBJECT (widget),
10173 quark_accessible_object,
10180 * Initialize a AtkImplementorIface instance's virtual pointers as
10181 * appropriate to this implementor's class (GtkWidget).
10184 gtk_widget_accessible_interface_init (AtkImplementorIface *iface)
10186 iface->ref_accessible = gtk_widget_ref_accessible;
10190 gtk_widget_ref_accessible (AtkImplementor *implementor)
10192 AtkObject *accessible;
10194 accessible = gtk_widget_get_accessible (GTK_WIDGET (implementor));
10196 g_object_ref (accessible);
10201 * GtkBuildable implementation
10203 static GQuark quark_builder_has_default = 0;
10204 static GQuark quark_builder_has_focus = 0;
10205 static GQuark quark_builder_atk_relations = 0;
10206 static GQuark quark_builder_set_name = 0;
10209 gtk_widget_buildable_interface_init (GtkBuildableIface *iface)
10211 quark_builder_has_default = g_quark_from_static_string ("gtk-builder-has-default");
10212 quark_builder_has_focus = g_quark_from_static_string ("gtk-builder-has-focus");
10213 quark_builder_atk_relations = g_quark_from_static_string ("gtk-builder-atk-relations");
10214 quark_builder_set_name = g_quark_from_static_string ("gtk-builder-set-name");
10216 iface->set_name = gtk_widget_buildable_set_name;
10217 iface->get_name = gtk_widget_buildable_get_name;
10218 iface->get_internal_child = gtk_widget_buildable_get_internal_child;
10219 iface->set_buildable_property = gtk_widget_buildable_set_buildable_property;
10220 iface->parser_finished = gtk_widget_buildable_parser_finished;
10221 iface->custom_tag_start = gtk_widget_buildable_custom_tag_start;
10222 iface->custom_finished = gtk_widget_buildable_custom_finished;
10226 gtk_widget_buildable_set_name (GtkBuildable *buildable,
10229 g_object_set_qdata_full (G_OBJECT (buildable), quark_builder_set_name,
10230 g_strdup (name), g_free);
10233 static const gchar *
10234 gtk_widget_buildable_get_name (GtkBuildable *buildable)
10236 return g_object_get_qdata (G_OBJECT (buildable), quark_builder_set_name);
10240 gtk_widget_buildable_get_internal_child (GtkBuildable *buildable,
10241 GtkBuilder *builder,
10242 const gchar *childname)
10244 if (strcmp (childname, "accessible") == 0)
10245 return G_OBJECT (gtk_widget_get_accessible (GTK_WIDGET (buildable)));
10251 gtk_widget_buildable_set_buildable_property (GtkBuildable *buildable,
10252 GtkBuilder *builder,
10254 const GValue *value)
10256 if (strcmp (name, "has-default") == 0 && g_value_get_boolean (value))
10257 g_object_set_qdata (G_OBJECT (buildable), quark_builder_has_default,
10258 GINT_TO_POINTER (TRUE));
10259 else if (strcmp (name, "has-focus") == 0 && g_value_get_boolean (value))
10260 g_object_set_qdata (G_OBJECT (buildable), quark_builder_has_focus,
10261 GINT_TO_POINTER (TRUE));
10263 g_object_set_property (G_OBJECT (buildable), name, value);
10268 gchar *action_name;
10269 GString *description;
10271 gboolean translatable;
10281 free_action (AtkActionData *data, gpointer user_data)
10283 g_free (data->action_name);
10284 g_string_free (data->description, TRUE);
10285 g_free (data->context);
10286 g_slice_free (AtkActionData, data);
10290 free_relation (AtkRelationData *data, gpointer user_data)
10292 g_free (data->target);
10293 g_free (data->type);
10294 g_slice_free (AtkRelationData, data);
10298 gtk_widget_buildable_parser_finished (GtkBuildable *buildable,
10299 GtkBuilder *builder)
10301 GSList *atk_relations;
10303 if (g_object_get_qdata (G_OBJECT (buildable), quark_builder_has_default))
10304 gtk_widget_grab_default (GTK_WIDGET (buildable));
10305 if (g_object_get_qdata (G_OBJECT (buildable), quark_builder_has_focus))
10306 gtk_widget_grab_focus (GTK_WIDGET (buildable));
10308 atk_relations = g_object_get_qdata (G_OBJECT (buildable),
10309 quark_builder_atk_relations);
10312 AtkObject *accessible;
10313 AtkRelationSet *relation_set;
10316 AtkRelationType relation_type;
10317 AtkObject *target_accessible;
10319 accessible = gtk_widget_get_accessible (GTK_WIDGET (buildable));
10320 relation_set = atk_object_ref_relation_set (accessible);
10322 for (l = atk_relations; l; l = l->next)
10324 AtkRelationData *relation = (AtkRelationData*)l->data;
10326 target = gtk_builder_get_object (builder, relation->target);
10329 g_warning ("Target object %s in <relation> does not exist",
10333 target_accessible = gtk_widget_get_accessible (GTK_WIDGET (target));
10334 g_assert (target_accessible != NULL);
10336 relation_type = atk_relation_type_for_name (relation->type);
10337 if (relation_type == ATK_RELATION_NULL)
10339 g_warning ("<relation> type %s not found",
10343 atk_relation_set_add_relation_by_type (relation_set, relation_type,
10344 target_accessible);
10346 g_object_unref (relation_set);
10348 g_slist_foreach (atk_relations, (GFunc)free_relation, NULL);
10349 g_slist_free (atk_relations);
10350 g_object_set_qdata (G_OBJECT (buildable), quark_builder_atk_relations,
10359 } AccessibilitySubParserData;
10362 accessibility_start_element (GMarkupParseContext *context,
10363 const gchar *element_name,
10364 const gchar **names,
10365 const gchar **values,
10366 gpointer user_data,
10369 AccessibilitySubParserData *data = (AccessibilitySubParserData*)user_data;
10371 gint line_number, char_number;
10373 if (strcmp (element_name, "relation") == 0)
10375 gchar *target = NULL;
10376 gchar *type = NULL;
10377 AtkRelationData *relation;
10379 for (i = 0; names[i]; i++)
10381 if (strcmp (names[i], "target") == 0)
10382 target = g_strdup (values[i]);
10383 else if (strcmp (names[i], "type") == 0)
10384 type = g_strdup (values[i]);
10387 g_markup_parse_context_get_position (context,
10390 g_set_error (error,
10392 GTK_BUILDER_ERROR_INVALID_ATTRIBUTE,
10393 "%s:%d:%d '%s' is not a valid attribute of <%s>",
10395 line_number, char_number, names[i], "relation");
10402 if (!target || !type)
10404 g_markup_parse_context_get_position (context,
10407 g_set_error (error,
10409 GTK_BUILDER_ERROR_MISSING_ATTRIBUTE,
10410 "%s:%d:%d <%s> requires attribute \"%s\"",
10412 line_number, char_number, "relation",
10413 type ? "target" : "type");
10419 relation = g_slice_new (AtkRelationData);
10420 relation->target = target;
10421 relation->type = type;
10423 data->relations = g_slist_prepend (data->relations, relation);
10425 else if (strcmp (element_name, "action") == 0)
10427 const gchar *action_name = NULL;
10428 const gchar *description = NULL;
10429 const gchar *msg_context = NULL;
10430 gboolean translatable = FALSE;
10431 AtkActionData *action;
10433 for (i = 0; names[i]; i++)
10435 if (strcmp (names[i], "action_name") == 0)
10436 action_name = values[i];
10437 else if (strcmp (names[i], "description") == 0)
10438 description = values[i];
10439 else if (strcmp (names[i], "translatable") == 0)
10441 if (!_gtk_builder_boolean_from_string (values[i], &translatable, error))
10444 else if (strcmp (names[i], "comments") == 0)
10446 /* do nothing, comments are for translators */
10448 else if (strcmp (names[i], "context") == 0)
10449 msg_context = values[i];
10452 g_markup_parse_context_get_position (context,
10455 g_set_error (error,
10457 GTK_BUILDER_ERROR_INVALID_ATTRIBUTE,
10458 "%s:%d:%d '%s' is not a valid attribute of <%s>",
10460 line_number, char_number, names[i], "action");
10467 g_markup_parse_context_get_position (context,
10470 g_set_error (error,
10472 GTK_BUILDER_ERROR_MISSING_ATTRIBUTE,
10473 "%s:%d:%d <%s> requires attribute \"%s\"",
10475 line_number, char_number, "action",
10480 action = g_slice_new (AtkActionData);
10481 action->action_name = g_strdup (action_name);
10482 action->description = g_string_new (description);
10483 action->context = g_strdup (msg_context);
10484 action->translatable = translatable;
10486 data->actions = g_slist_prepend (data->actions, action);
10488 else if (strcmp (element_name, "accessibility") == 0)
10491 g_warning ("Unsupported tag for GtkWidget: %s\n", element_name);
10495 accessibility_text (GMarkupParseContext *context,
10498 gpointer user_data,
10501 AccessibilitySubParserData *data = (AccessibilitySubParserData*)user_data;
10503 if (strcmp (g_markup_parse_context_get_element (context), "action") == 0)
10505 AtkActionData *action = data->actions->data;
10507 g_string_append_len (action->description, text, text_len);
10511 static const GMarkupParser accessibility_parser =
10513 accessibility_start_element,
10515 accessibility_text,
10524 } AccelGroupParserData;
10527 accel_group_start_element (GMarkupParseContext *context,
10528 const gchar *element_name,
10529 const gchar **names,
10530 const gchar **values,
10531 gpointer user_data,
10536 guint modifiers = 0;
10537 gchar *signal = NULL;
10538 AccelGroupParserData *parser_data = (AccelGroupParserData*)user_data;
10540 for (i = 0; names[i]; i++)
10542 if (strcmp (names[i], "key") == 0)
10543 key = gdk_keyval_from_name (values[i]);
10544 else if (strcmp (names[i], "modifiers") == 0)
10546 if (!_gtk_builder_flags_from_string (GDK_TYPE_MODIFIER_TYPE,
10552 else if (strcmp (names[i], "signal") == 0)
10553 signal = g_strdup (values[i]);
10556 if (key == 0 || signal == NULL)
10558 g_warning ("<accelerator> requires key and signal attributes");
10561 parser_data->key = key;
10562 parser_data->modifiers = modifiers;
10563 parser_data->signal = signal;
10566 static const GMarkupParser accel_group_parser =
10568 accel_group_start_element,
10572 gtk_widget_buildable_custom_tag_start (GtkBuildable *buildable,
10573 GtkBuilder *builder,
10575 const gchar *tagname,
10576 GMarkupParser *parser,
10579 g_assert (buildable);
10581 if (strcmp (tagname, "accelerator") == 0)
10583 AccelGroupParserData *parser_data;
10585 parser_data = g_slice_new0 (AccelGroupParserData);
10586 parser_data->object = g_object_ref (buildable);
10587 *parser = accel_group_parser;
10588 *data = parser_data;
10591 if (strcmp (tagname, "accessibility") == 0)
10593 AccessibilitySubParserData *parser_data;
10595 parser_data = g_slice_new0 (AccessibilitySubParserData);
10596 *parser = accessibility_parser;
10597 *data = parser_data;
10604 _gtk_widget_buildable_finish_accelerator (GtkWidget *widget,
10605 GtkWidget *toplevel,
10606 gpointer user_data)
10608 AccelGroupParserData *accel_data;
10609 GSList *accel_groups;
10610 GtkAccelGroup *accel_group;
10612 g_return_if_fail (GTK_IS_WIDGET (widget));
10613 g_return_if_fail (GTK_IS_WIDGET (toplevel));
10614 g_return_if_fail (user_data != NULL);
10616 accel_data = (AccelGroupParserData*)user_data;
10617 accel_groups = gtk_accel_groups_from_object (G_OBJECT (toplevel));
10618 if (g_slist_length (accel_groups) == 0)
10620 accel_group = gtk_accel_group_new ();
10621 gtk_window_add_accel_group (GTK_WINDOW (toplevel), accel_group);
10625 g_assert (g_slist_length (accel_groups) == 1);
10626 accel_group = g_slist_nth_data (accel_groups, 0);
10629 gtk_widget_add_accelerator (GTK_WIDGET (accel_data->object),
10630 accel_data->signal,
10633 accel_data->modifiers,
10634 GTK_ACCEL_VISIBLE);
10636 g_object_unref (accel_data->object);
10637 g_free (accel_data->signal);
10638 g_slice_free (AccelGroupParserData, accel_data);
10642 gtk_widget_buildable_custom_finished (GtkBuildable *buildable,
10643 GtkBuilder *builder,
10645 const gchar *tagname,
10646 gpointer user_data)
10648 AccelGroupParserData *accel_data;
10649 AccessibilitySubParserData *a11y_data;
10650 GtkWidget *toplevel;
10652 if (strcmp (tagname, "accelerator") == 0)
10654 accel_data = (AccelGroupParserData*)user_data;
10655 g_assert (accel_data->object);
10657 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (accel_data->object));
10659 _gtk_widget_buildable_finish_accelerator (GTK_WIDGET (buildable), toplevel, user_data);
10661 else if (strcmp (tagname, "accessibility") == 0)
10663 a11y_data = (AccessibilitySubParserData*)user_data;
10665 if (a11y_data->actions)
10667 AtkObject *accessible;
10672 accessible = gtk_widget_get_accessible (GTK_WIDGET (buildable));
10674 action = ATK_ACTION (accessible);
10675 n_actions = atk_action_get_n_actions (action);
10677 for (l = a11y_data->actions; l; l = l->next)
10679 AtkActionData *action_data = (AtkActionData*)l->data;
10681 for (i = 0; i < n_actions; i++)
10682 if (strcmp (atk_action_get_name (action, i),
10683 action_data->action_name) == 0)
10688 gchar *description;
10690 if (action_data->translatable && action_data->description->len)
10691 description = _gtk_builder_parser_translate (gtk_builder_get_translation_domain (builder),
10692 action_data->context,
10693 action_data->description->str);
10695 description = action_data->description->str;
10697 atk_action_set_description (action, i, description);
10701 g_slist_foreach (a11y_data->actions, (GFunc)free_action, NULL);
10702 g_slist_free (a11y_data->actions);
10705 if (a11y_data->relations)
10706 g_object_set_qdata (G_OBJECT (buildable), quark_builder_atk_relations,
10707 a11y_data->relations);
10709 g_slice_free (AccessibilitySubParserData, a11y_data);
10714 * GtkExtendedLayout implementation
10717 gtk_widget_real_get_desired_size (GtkExtendedLayout *layout,
10718 GtkRequisition *minimum_size,
10719 GtkRequisition *natural_size)
10721 GtkWidget *widget = GTK_WIDGET (layout);
10722 GtkRequisition requisition = widget->requisition;
10724 g_signal_emit (widget, widget_signals[SIZE_REQUEST], 0, &requisition);
10727 *minimum_size = requisition;
10729 *natural_size = requisition;
10733 gtk_widget_real_get_height_for_width (GtkExtendedLayout *layout,
10735 gint *minimum_height,
10736 gint *natural_height)
10738 GtkRequisition minimum_size;
10739 GtkRequisition natural_size;
10741 g_return_if_fail (GTK_IS_WIDGET (layout));
10744 TODO: integrate height-for-width with size-groups
10746 gtk_widget_get_desired_size (GTK_WIDGET(layout),
10747 minimum_height ? &minimum_size : NULL,
10748 natural_height ? &natural_size : NULL);
10750 if (minimum_height)
10751 *minimum_height = minimum_size.height;
10752 if (natural_height)
10753 *natural_height = natural_size.height;
10758 gtk_widget_real_get_width_for_height (GtkExtendedLayout *layout,
10760 gint *minimum_width,
10761 gint *natural_width)
10763 GtkRequisition minimum_size;
10764 GtkRequisition natural_size;
10766 g_return_if_fail (GTK_IS_WIDGET (layout));
10769 TODO: integrate width-for-height with size-groups
10771 gtk_widget_get_desired_size (GTK_WIDGET(layout),
10772 minimum_width ? &minimum_size : NULL,
10773 natural_width ? &natural_size : NULL);
10776 *minimum_width = minimum_size.width;
10778 *natural_width = natural_size.width;
10783 * gtk_widget_get_desired_size:
10784 * @widget: a #GtkWidget
10785 * @minimum_size: location for storing the @widget's minimum size, or %NULL
10786 * @natural_size: location for storing the @widget's preferred size, or %NULL
10788 * Retreives a widget's desired size, considering restrictions imposed by
10789 * #GtkSizeGroup<!-- -->s. See also: gtk_extended_layout_get_desired_size().
10794 gtk_widget_get_desired_size (GtkWidget *widget,
10795 GtkRequisition *minimum_size,
10796 GtkRequisition *natural_size)
10798 g_return_if_fail (GTK_IS_WIDGET (widget));
10799 _gtk_size_group_compute_desired_size (widget, minimum_size, natural_size);
10803 gtk_widget_layout_interface_init (GtkExtendedLayoutIface *iface)
10805 iface->get_desired_size = gtk_widget_real_get_desired_size;
10806 iface->get_width_for_height = gtk_widget_real_get_width_for_height;
10807 iface->get_height_for_width = gtk_widget_real_get_height_for_width;
10812 * gtk_widget_get_clipboard:
10813 * @widget: a #GtkWidget
10814 * @selection: a #GdkAtom which identifies the clipboard
10815 * to use. %GDK_SELECTION_CLIPBOARD gives the
10816 * default clipboard. Another common value
10817 * is %GDK_SELECTION_PRIMARY, which gives
10818 * the primary X selection.
10820 * Returns the clipboard object for the given selection to
10821 * be used with @widget. @widget must have a #GdkDisplay
10822 * associated with it, so must be attached to a toplevel
10825 * Return value: (transfer none): the appropriate clipboard object. If no
10826 * clipboard already exists, a new one will
10827 * be created. Once a clipboard object has
10828 * been created, it is persistent for all time.
10833 gtk_widget_get_clipboard (GtkWidget *widget, GdkAtom selection)
10835 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10836 g_return_val_if_fail (gtk_widget_has_screen (widget), NULL);
10838 return gtk_clipboard_get_for_display (gtk_widget_get_display (widget),
10843 * gtk_widget_list_mnemonic_labels:
10844 * @widget: a #GtkWidget
10846 * Returns a newly allocated list of the widgets, normally labels, for
10847 * which this widget is a the target of a mnemonic (see for example,
10848 * gtk_label_set_mnemonic_widget()).
10850 * The widgets in the list are not individually referenced. If you
10851 * want to iterate through the list and perform actions involving
10852 * callbacks that might destroy the widgets, you
10853 * <emphasis>must</emphasis> call <literal>g_list_foreach (result,
10854 * (GFunc)g_object_ref, NULL)</literal> first, and then unref all the
10855 * widgets afterwards.
10857 * Return value: (element-type GtkWidget) (transfer container): the list of
10858 * mnemonic labels; free this list
10859 * with g_list_free() when you are done with it.
10864 gtk_widget_list_mnemonic_labels (GtkWidget *widget)
10866 GList *list = NULL;
10869 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
10871 for (l = g_object_get_qdata (G_OBJECT (widget), quark_mnemonic_labels); l; l = l->next)
10872 list = g_list_prepend (list, l->data);
10878 * gtk_widget_add_mnemonic_label:
10879 * @widget: a #GtkWidget
10880 * @label: a #GtkWidget that acts as a mnemonic label for @widget
10882 * Adds a widget to the list of mnemonic labels for
10883 * this widget. (See gtk_widget_list_mnemonic_labels()). Note the
10884 * list of mnemonic labels for the widget is cleared when the
10885 * widget is destroyed, so the caller must make sure to update
10886 * its internal state at this point as well, by using a connection
10887 * to the #GtkWidget::destroy signal or a weak notifier.
10892 gtk_widget_add_mnemonic_label (GtkWidget *widget,
10895 GSList *old_list, *new_list;
10897 g_return_if_fail (GTK_IS_WIDGET (widget));
10898 g_return_if_fail (GTK_IS_WIDGET (label));
10900 old_list = g_object_steal_qdata (G_OBJECT (widget), quark_mnemonic_labels);
10901 new_list = g_slist_prepend (old_list, label);
10903 g_object_set_qdata_full (G_OBJECT (widget), quark_mnemonic_labels,
10904 new_list, (GDestroyNotify) g_slist_free);
10908 * gtk_widget_remove_mnemonic_label:
10909 * @widget: a #GtkWidget
10910 * @label: a #GtkWidget that was previously set as a mnemnic label for
10911 * @widget with gtk_widget_add_mnemonic_label().
10913 * Removes a widget from the list of mnemonic labels for
10914 * this widget. (See gtk_widget_list_mnemonic_labels()). The widget
10915 * must have previously been added to the list with
10916 * gtk_widget_add_mnemonic_label().
10921 gtk_widget_remove_mnemonic_label (GtkWidget *widget,
10924 GSList *old_list, *new_list;
10926 g_return_if_fail (GTK_IS_WIDGET (widget));
10927 g_return_if_fail (GTK_IS_WIDGET (label));
10929 old_list = g_object_steal_qdata (G_OBJECT (widget), quark_mnemonic_labels);
10930 new_list = g_slist_remove (old_list, label);
10933 g_object_set_qdata_full (G_OBJECT (widget), quark_mnemonic_labels,
10934 new_list, (GDestroyNotify) g_slist_free);
10938 * gtk_widget_get_no_show_all:
10939 * @widget: a #GtkWidget
10941 * Returns the current value of the GtkWidget:no-show-all property,
10942 * which determines whether calls to gtk_widget_show_all() and
10943 * gtk_widget_hide_all() will affect this widget.
10945 * Return value: the current value of the "no-show-all" property.
10950 gtk_widget_get_no_show_all (GtkWidget *widget)
10952 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
10954 return (GTK_WIDGET_FLAGS (widget) & GTK_NO_SHOW_ALL) != 0;
10958 * gtk_widget_set_no_show_all:
10959 * @widget: a #GtkWidget
10960 * @no_show_all: the new value for the "no-show-all" property
10962 * Sets the #GtkWidget:no-show-all property, which determines whether
10963 * calls to gtk_widget_show_all() and gtk_widget_hide_all() will affect
10966 * This is mostly for use in constructing widget hierarchies with externally
10967 * controlled visibility, see #GtkUIManager.
10972 gtk_widget_set_no_show_all (GtkWidget *widget,
10973 gboolean no_show_all)
10975 g_return_if_fail (GTK_IS_WIDGET (widget));
10977 no_show_all = (no_show_all != FALSE);
10979 if (no_show_all == ((GTK_WIDGET_FLAGS (widget) & GTK_NO_SHOW_ALL) != 0))
10983 GTK_WIDGET_SET_FLAGS (widget, GTK_NO_SHOW_ALL);
10985 GTK_WIDGET_UNSET_FLAGS (widget, GTK_NO_SHOW_ALL);
10987 g_object_notify (G_OBJECT (widget), "no-show-all");
10992 gtk_widget_real_set_has_tooltip (GtkWidget *widget,
10993 gboolean has_tooltip,
10996 gboolean priv_has_tooltip;
10998 priv_has_tooltip = GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (widget),
10999 quark_has_tooltip));
11001 if (priv_has_tooltip != has_tooltip || force)
11003 priv_has_tooltip = has_tooltip;
11005 if (priv_has_tooltip)
11007 if (GTK_WIDGET_REALIZED (widget) && GTK_WIDGET_NO_WINDOW (widget))
11008 gdk_window_set_events (widget->window,
11009 gdk_window_get_events (widget->window) |
11010 GDK_LEAVE_NOTIFY_MASK |
11011 GDK_POINTER_MOTION_MASK |
11012 GDK_POINTER_MOTION_HINT_MASK);
11014 if (!GTK_WIDGET_NO_WINDOW (widget))
11015 gtk_widget_add_events (widget,
11016 GDK_LEAVE_NOTIFY_MASK |
11017 GDK_POINTER_MOTION_MASK |
11018 GDK_POINTER_MOTION_HINT_MASK);
11021 g_object_set_qdata (G_OBJECT (widget), quark_has_tooltip,
11022 GUINT_TO_POINTER (priv_has_tooltip));
11027 * gtk_widget_set_tooltip_window:
11028 * @widget: a #GtkWidget
11029 * @custom_window: (allow-none): a #GtkWindow, or %NULL
11031 * Replaces the default, usually yellow, window used for displaying
11032 * tooltips with @custom_window. GTK+ will take care of showing and
11033 * hiding @custom_window at the right moment, to behave likewise as
11034 * the default tooltip window. If @custom_window is %NULL, the default
11035 * tooltip window will be used.
11037 * If the custom window should have the default theming it needs to
11038 * have the name "gtk-tooltip", see gtk_widget_set_name().
11043 gtk_widget_set_tooltip_window (GtkWidget *widget,
11044 GtkWindow *custom_window)
11046 gboolean has_tooltip;
11047 gchar *tooltip_markup;
11049 g_return_if_fail (GTK_IS_WIDGET (widget));
11050 g_return_if_fail (custom_window == NULL || GTK_IS_WINDOW (custom_window));
11052 tooltip_markup = g_object_get_qdata (G_OBJECT (widget), quark_tooltip_markup);
11055 g_object_ref (custom_window);
11057 g_object_set_qdata_full (G_OBJECT (widget), quark_tooltip_window,
11058 custom_window, g_object_unref);
11060 has_tooltip = (custom_window != NULL || tooltip_markup != NULL);
11061 gtk_widget_real_set_has_tooltip (widget, has_tooltip, FALSE);
11063 if (has_tooltip && GTK_WIDGET_VISIBLE (widget))
11064 gtk_widget_queue_tooltip_query (widget);
11068 * gtk_widget_get_tooltip_window:
11069 * @widget: a #GtkWidget
11071 * Returns the #GtkWindow of the current tooltip. This can be the
11072 * GtkWindow created by default, or the custom tooltip window set
11073 * using gtk_widget_set_tooltip_window().
11075 * Return value: (transfer none): The #GtkWindow of the current tooltip.
11080 gtk_widget_get_tooltip_window (GtkWidget *widget)
11082 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
11084 return g_object_get_qdata (G_OBJECT (widget), quark_tooltip_window);
11088 * gtk_widget_trigger_tooltip_query:
11089 * @widget: a #GtkWidget
11091 * Triggers a tooltip query on the display where the toplevel of @widget
11092 * is located. See gtk_tooltip_trigger_tooltip_query() for more
11098 gtk_widget_trigger_tooltip_query (GtkWidget *widget)
11100 gtk_tooltip_trigger_tooltip_query (gtk_widget_get_display (widget));
11103 static guint tooltip_query_id;
11104 static GSList *tooltip_query_displays;
11107 tooltip_query_idle (gpointer data)
11109 g_slist_foreach (tooltip_query_displays, (GFunc)gtk_tooltip_trigger_tooltip_query, NULL);
11110 g_slist_foreach (tooltip_query_displays, (GFunc)g_object_unref, NULL);
11111 g_slist_free (tooltip_query_displays);
11113 tooltip_query_displays = NULL;
11114 tooltip_query_id = 0;
11120 gtk_widget_queue_tooltip_query (GtkWidget *widget)
11122 GdkDisplay *display;
11124 display = gtk_widget_get_display (widget);
11126 if (!g_slist_find (tooltip_query_displays, display))
11127 tooltip_query_displays = g_slist_prepend (tooltip_query_displays, g_object_ref (display));
11129 if (tooltip_query_id == 0)
11130 tooltip_query_id = gdk_threads_add_idle (tooltip_query_idle, NULL);
11134 * gtk_widget_set_tooltip_text:
11135 * @widget: a #GtkWidget
11136 * @text: the contents of the tooltip for @widget
11138 * Sets @text as the contents of the tooltip. This function will take
11139 * care of setting GtkWidget:has-tooltip to %TRUE and of the default
11140 * handler for the GtkWidget::query-tooltip signal.
11142 * See also the GtkWidget:tooltip-text property and gtk_tooltip_set_text().
11147 gtk_widget_set_tooltip_text (GtkWidget *widget,
11150 g_return_if_fail (GTK_IS_WIDGET (widget));
11152 g_object_set (G_OBJECT (widget), "tooltip-text", text, NULL);
11156 * gtk_widget_get_tooltip_text:
11157 * @widget: a #GtkWidget
11159 * Gets the contents of the tooltip for @widget.
11161 * Return value: the tooltip text, or %NULL. You should free the
11162 * returned string with g_free() when done.
11167 gtk_widget_get_tooltip_text (GtkWidget *widget)
11169 gchar *text = NULL;
11171 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
11173 g_object_get (G_OBJECT (widget), "tooltip-text", &text, NULL);
11179 * gtk_widget_set_tooltip_markup:
11180 * @widget: a #GtkWidget
11181 * @markup: (allow-none): the contents of the tooltip for @widget, or %NULL
11183 * Sets @markup as the contents of the tooltip, which is marked up with
11184 * the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
11186 * This function will take care of setting GtkWidget:has-tooltip to %TRUE
11187 * and of the default handler for the GtkWidget::query-tooltip signal.
11189 * See also the GtkWidget:tooltip-markup property and
11190 * gtk_tooltip_set_markup().
11195 gtk_widget_set_tooltip_markup (GtkWidget *widget,
11196 const gchar *markup)
11198 g_return_if_fail (GTK_IS_WIDGET (widget));
11200 g_object_set (G_OBJECT (widget), "tooltip-markup", markup, NULL);
11204 * gtk_widget_get_tooltip_markup:
11205 * @widget: a #GtkWidget
11207 * Gets the contents of the tooltip for @widget.
11209 * Return value: the tooltip text, or %NULL. You should free the
11210 * returned string with g_free() when done.
11215 gtk_widget_get_tooltip_markup (GtkWidget *widget)
11217 gchar *text = NULL;
11219 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
11221 g_object_get (G_OBJECT (widget), "tooltip-markup", &text, NULL);
11227 * gtk_widget_set_has_tooltip:
11228 * @widget: a #GtkWidget
11229 * @has_tooltip: whether or not @widget has a tooltip.
11231 * Sets the has-tooltip property on @widget to @has_tooltip. See
11232 * GtkWidget:has-tooltip for more information.
11237 gtk_widget_set_has_tooltip (GtkWidget *widget,
11238 gboolean has_tooltip)
11240 g_return_if_fail (GTK_IS_WIDGET (widget));
11242 g_object_set (G_OBJECT (widget), "has-tooltip", has_tooltip, NULL);
11246 * gtk_widget_get_has_tooltip:
11247 * @widget: a #GtkWidget
11249 * Returns the current value of the has-tooltip property. See
11250 * GtkWidget:has-tooltip for more information.
11252 * Return value: current value of has-tooltip on @widget.
11257 gtk_widget_get_has_tooltip (GtkWidget *widget)
11259 gboolean has_tooltip = FALSE;
11261 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
11263 g_object_get (G_OBJECT (widget), "has-tooltip", &has_tooltip, NULL);
11265 return has_tooltip;
11269 * gtk_widget_get_allocation:
11270 * @widget: a #GtkWidget
11271 * @allocation: (out): a pointer to a #GtkAllocation to copy to
11273 * Retrieves the widget's allocation.
11278 gtk_widget_get_allocation (GtkWidget *widget,
11279 GtkAllocation *allocation)
11281 g_return_if_fail (GTK_IS_WIDGET (widget));
11282 g_return_if_fail (allocation != NULL);
11284 *allocation = widget->allocation;
11288 * gtk_widget_set_allocation:
11289 * @widget: a #GtkWidget
11290 * @allocation: a pointer to a #GtkAllocation to copy from
11292 * Sets the widget's allocation. This should not be used
11293 * directly, but from within a widget's size_allocate method.
11298 gtk_widget_set_allocation (GtkWidget *widget,
11299 const GtkAllocation *allocation)
11301 g_return_if_fail (GTK_IS_WIDGET (widget));
11302 g_return_if_fail (allocation != NULL);
11304 widget->allocation = *allocation;
11308 * gtk_widget_get_requisition:
11309 * @widget: a #GtkWidget
11310 * @requisition: (out): a pointer to a #GtkRequisition to copy to
11312 * Retrieves the widget's requisition.
11314 * This function should only be used by widget implementations in
11315 * order to figure whether the widget's requisition has actually
11316 * changed after some internal state change (so that they can call
11317 * gtk_widget_queue_resize() instead of gtk_widget_queue_draw()).
11319 * Normally, gtk_widget_size_request() should be used.
11324 gtk_widget_get_requisition (GtkWidget *widget,
11325 GtkRequisition *requisition)
11327 g_return_if_fail (GTK_IS_WIDGET (widget));
11328 g_return_if_fail (requisition != NULL);
11330 *requisition = widget->requisition;
11334 * gtk_widget_set_window:
11335 * @widget: a #GtkWidget
11336 * @window: a #GdkWindow
11338 * Sets a widget's window. This function should only be used in a
11339 * widget's GtkWidget::realize() implementation. The %window passed is
11340 * usually either new window created with gdk_window_new(), or the
11341 * window of its parent widget as returned by
11342 * gtk_widget_get_parent_window().
11344 * Widgets must indicate whether they will create their own #GdkWindow
11345 * by calling gtk_widget_set_has_window(). This is usually done in the
11346 * widget's init() function.
11351 gtk_widget_set_window (GtkWidget *widget,
11354 g_return_if_fail (GTK_IS_WIDGET (widget));
11355 g_return_if_fail (window == NULL || GDK_IS_WINDOW (window));
11357 if (widget->window != window)
11359 widget->window = window;
11360 g_object_notify (G_OBJECT (widget), "window");
11365 * gtk_widget_get_window:
11366 * @widget: a #GtkWidget
11368 * Returns the widget's window if it is realized, %NULL otherwise
11370 * Return value: @widget's window.
11375 gtk_widget_get_window (GtkWidget *widget)
11377 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
11379 return widget->window;
11382 #define __GTK_WIDGET_C__
11383 #include "gtkaliasdef.c"