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/.
30 #include "gtkcontainer.h"
31 #include "gtkaccelmap.h"
32 #include "gtkclipboard.h"
33 #include "gtkiconfactory.h"
36 #include "gtkmarshalers.h"
38 #include "gtkselection.h"
39 #include "gtksettings.h"
40 #include "gtksizegroup.h"
41 #include "gtkwidget.h"
42 #include "gtkwindow.h"
43 #include "gtkbindings.h"
44 #include "gtkprivate.h"
46 #include "gdk/gdkprivate.h" /* Used in gtk_reset_shapes_recurse to avoid copy */
47 #include <gobject/gvaluecollector.h>
48 #include <gobject/gobjectnotifyqueue.c>
49 #include "gdk/gdkkeysyms.h"
51 #include "gtkaccessible.h"
52 #include "gtktooltips.h"
53 #include "gtkinvisible.h"
55 #define WIDGET_CLASS(w) GTK_WIDGET_GET_CLASS (w)
56 #define INIT_PATH_SIZE (512)
96 PROPERTY_NOTIFY_EVENT,
97 SELECTION_CLEAR_EVENT,
98 SELECTION_REQUEST_EVENT,
99 SELECTION_NOTIFY_EVENT,
114 VISIBILITY_NOTIFY_EVENT,
118 ACCEL_CLOSURES_CHANGED,
137 PROP_RECEIVES_DEFAULT,
138 PROP_COMPOSITE_CHILD,
141 PROP_EXTENSION_EVENTS
144 typedef struct _GtkStateData GtkStateData;
149 guint state_restoration : 1;
150 guint parent_sensitive : 1;
151 guint use_forall : 1;
155 /* --- prototypes --- */
156 static void gtk_widget_class_init (GtkWidgetClass *klass);
157 static void gtk_widget_init (GtkWidget *widget);
158 static void gtk_widget_set_property (GObject *object,
162 static void gtk_widget_get_property (GObject *object,
166 static void gtk_widget_dispose (GObject *object);
167 static void gtk_widget_real_destroy (GtkObject *object);
168 static void gtk_widget_finalize (GObject *object);
169 static void gtk_widget_real_show (GtkWidget *widget);
170 static void gtk_widget_real_hide (GtkWidget *widget);
171 static void gtk_widget_real_map (GtkWidget *widget);
172 static void gtk_widget_real_unmap (GtkWidget *widget);
173 static void gtk_widget_real_realize (GtkWidget *widget);
174 static void gtk_widget_real_unrealize (GtkWidget *widget);
175 static void gtk_widget_real_size_request (GtkWidget *widget,
176 GtkRequisition *requisition);
177 static void gtk_widget_real_size_allocate (GtkWidget *widget,
178 GtkAllocation *allocation);
179 static void gtk_widget_style_set (GtkWidget *widget,
180 GtkStyle *previous_style);
181 static void gtk_widget_direction_changed (GtkWidget *widget,
182 GtkTextDirection previous_direction);
184 static void gtk_widget_real_grab_focus (GtkWidget *focus_widget);
185 static gboolean gtk_widget_real_show_help (GtkWidget *widget,
186 GtkWidgetHelpType help_type);
188 static void gtk_widget_dispatch_child_properties_changed (GtkWidget *object,
190 GParamSpec **pspecs);
191 static gboolean gtk_widget_real_key_press_event (GtkWidget *widget,
193 static gboolean gtk_widget_real_key_release_event (GtkWidget *widget,
195 static gboolean gtk_widget_real_focus_in_event (GtkWidget *widget,
196 GdkEventFocus *event);
197 static gboolean gtk_widget_real_focus_out_event (GtkWidget *widget,
198 GdkEventFocus *event);
199 static gboolean gtk_widget_real_focus (GtkWidget *widget,
200 GtkDirectionType direction);
201 static PangoContext* gtk_widget_peek_pango_context (GtkWidget *widget);
202 static void gtk_widget_propagate_state (GtkWidget *widget,
204 static void gtk_widget_reset_rc_style (GtkWidget *widget);
205 static void gtk_widget_set_style_internal (GtkWidget *widget,
207 gboolean initial_emission);
208 static gint gtk_widget_event_internal (GtkWidget *widget,
210 static gboolean gtk_widget_real_mnemonic_activate (GtkWidget *widget,
211 gboolean group_cycling);
212 static void gtk_widget_aux_info_destroy (GtkWidgetAuxInfo *aux_info);
213 static AtkObject* gtk_widget_real_get_accessible (GtkWidget *widget);
214 static void gtk_widget_accessible_interface_init (AtkImplementorIface *iface);
215 static AtkObject* gtk_widget_ref_accessible (AtkImplementor *implementor);
216 static void gtk_widget_invalidate_widget_windows (GtkWidget *widget,
220 /* --- variables --- */
221 static gpointer parent_class = NULL;
222 static guint widget_signals[LAST_SIGNAL] = { 0 };
223 static GMemChunk *aux_info_mem_chunk = NULL;
224 static GtkStyle *gtk_default_style = NULL;
225 static GSList *colormap_stack = NULL;
226 static guint composite_child_stack = 0;
227 static GtkTextDirection gtk_default_direction = GTK_TEXT_DIR_LTR;
228 static GParamSpecPool *style_property_spec_pool = NULL;
230 static GQuark quark_property_parser = 0;
231 static GQuark quark_aux_info = 0;
232 static GQuark quark_accel_path = 0;
233 static GQuark quark_accel_closures = 0;
234 static GQuark quark_event_mask = 0;
235 static GQuark quark_extension_event_mode = 0;
236 static GQuark quark_parent_window = 0;
237 static GQuark quark_shape_info = 0;
238 static GQuark quark_colormap = 0;
239 static GQuark quark_pango_context = 0;
240 static GQuark quark_rc_style = 0;
241 static GQuark quark_accessible_object = 0;
242 GParamSpecPool *_gtk_widget_child_property_pool = NULL;
243 GObjectNotifyContext *_gtk_widget_child_property_notify_context = NULL;
245 /* --- functions --- */
247 gtk_widget_get_type (void)
249 static GType widget_type = 0;
253 static const GTypeInfo widget_info =
255 sizeof (GtkWidgetClass),
256 NULL, /* base_init */
257 NULL, /* base_finalize */
258 (GClassInitFunc) gtk_widget_class_init,
259 NULL, /* class_finalize */
260 NULL, /* class_init */
263 (GInstanceInitFunc) gtk_widget_init,
264 NULL, /* value_table */
267 static const GInterfaceInfo accessibility_info =
269 (GInterfaceInitFunc) gtk_widget_accessible_interface_init,
270 (GInterfaceFinalizeFunc) NULL,
271 NULL /* interface data */
274 widget_type = g_type_register_static (GTK_TYPE_OBJECT, "GtkWidget",
275 &widget_info, G_TYPE_FLAG_ABSTRACT);
277 g_type_add_interface_static (widget_type, ATK_TYPE_IMPLEMENTOR,
278 &accessibility_info) ;
286 child_property_notify_dispatcher (GObject *object,
290 GTK_WIDGET_GET_CLASS (object)->dispatch_child_properties_changed (GTK_WIDGET (object), n_pspecs, pspecs);
294 gtk_widget_class_init (GtkWidgetClass *klass)
296 static GObjectNotifyContext cpn_context = { 0, NULL, NULL };
297 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
298 GtkObjectClass *object_class = GTK_OBJECT_CLASS (klass);
299 GtkBindingSet *binding_set;
301 parent_class = g_type_class_peek_parent (klass);
303 quark_property_parser = g_quark_from_static_string ("gtk-rc-property-parser");
304 quark_aux_info = g_quark_from_static_string ("gtk-aux-info");
305 quark_accel_path = g_quark_from_static_string ("gtk-accel-path");
306 quark_accel_closures = g_quark_from_static_string ("gtk-accel-closures");
307 quark_event_mask = g_quark_from_static_string ("gtk-event-mask");
308 quark_extension_event_mode = g_quark_from_static_string ("gtk-extension-event-mode");
309 quark_parent_window = g_quark_from_static_string ("gtk-parent-window");
310 quark_shape_info = g_quark_from_static_string ("gtk-shape-info");
311 quark_colormap = g_quark_from_static_string ("gtk-colormap");
312 quark_pango_context = g_quark_from_static_string ("gtk-pango-context");
313 quark_rc_style = g_quark_from_static_string ("gtk-rc-style");
314 quark_accessible_object = g_quark_from_static_string ("gtk-accessible-object");
316 style_property_spec_pool = g_param_spec_pool_new (FALSE);
317 _gtk_widget_child_property_pool = g_param_spec_pool_new (TRUE);
318 cpn_context.quark_notify_queue = g_quark_from_static_string ("GtkWidget-child-property-notify-queue");
319 cpn_context.dispatcher = child_property_notify_dispatcher;
320 _gtk_widget_child_property_notify_context = &cpn_context;
322 gobject_class->dispose = gtk_widget_dispose;
323 gobject_class->finalize = gtk_widget_finalize;
324 gobject_class->set_property = gtk_widget_set_property;
325 gobject_class->get_property = gtk_widget_get_property;
327 object_class->destroy = gtk_widget_real_destroy;
329 klass->activate_signal = 0;
330 klass->set_scroll_adjustments_signal = 0;
331 klass->dispatch_child_properties_changed = gtk_widget_dispatch_child_properties_changed;
332 klass->show = gtk_widget_real_show;
333 klass->show_all = gtk_widget_show;
334 klass->hide = gtk_widget_real_hide;
335 klass->hide_all = gtk_widget_hide;
336 klass->map = gtk_widget_real_map;
337 klass->unmap = gtk_widget_real_unmap;
338 klass->realize = gtk_widget_real_realize;
339 klass->unrealize = gtk_widget_real_unrealize;
340 klass->size_request = gtk_widget_real_size_request;
341 klass->size_allocate = gtk_widget_real_size_allocate;
342 klass->state_changed = NULL;
343 klass->parent_set = NULL;
344 klass->hierarchy_changed = NULL;
345 klass->style_set = gtk_widget_style_set;
346 klass->direction_changed = gtk_widget_direction_changed;
347 klass->grab_notify = NULL;
348 klass->child_notify = NULL;
349 klass->mnemonic_activate = gtk_widget_real_mnemonic_activate;
350 klass->grab_focus = gtk_widget_real_grab_focus;
351 klass->focus = gtk_widget_real_focus;
353 klass->button_press_event = NULL;
354 klass->button_release_event = NULL;
355 klass->motion_notify_event = NULL;
356 klass->delete_event = NULL;
357 klass->destroy_event = NULL;
358 klass->expose_event = NULL;
359 klass->key_press_event = gtk_widget_real_key_press_event;
360 klass->key_release_event = gtk_widget_real_key_release_event;
361 klass->enter_notify_event = NULL;
362 klass->leave_notify_event = NULL;
363 klass->configure_event = NULL;
364 klass->focus_in_event = gtk_widget_real_focus_in_event;
365 klass->focus_out_event = gtk_widget_real_focus_out_event;
366 klass->map_event = NULL;
367 klass->unmap_event = NULL;
368 klass->window_state_event = NULL;
369 klass->property_notify_event = _gtk_selection_property_notify;
370 klass->selection_clear_event = gtk_selection_clear;
371 klass->selection_request_event = _gtk_selection_request;
372 klass->selection_notify_event = _gtk_selection_notify;
373 klass->selection_received = NULL;
374 klass->proximity_in_event = NULL;
375 klass->proximity_out_event = NULL;
376 klass->drag_begin = NULL;
377 klass->drag_end = NULL;
378 klass->drag_data_delete = NULL;
379 klass->drag_leave = NULL;
380 klass->drag_motion = NULL;
381 klass->drag_drop = NULL;
382 klass->drag_data_received = NULL;
383 klass->screen_changed = NULL;
385 klass->show_help = gtk_widget_real_show_help;
387 /* Accessibility support */
388 klass->get_accessible = gtk_widget_real_get_accessible;
390 klass->no_expose_event = NULL;
392 g_object_class_install_property (gobject_class,
394 g_param_spec_string ("name",
396 _("The name of the widget"),
399 g_object_class_install_property (gobject_class,
401 g_param_spec_object ("parent",
403 _("The parent widget of this widget. Must be a Container widget"),
407 g_object_class_install_property (gobject_class,
409 g_param_spec_int ("width_request",
411 _("Override for width request of the widget, or -1 if natural request should be used"),
416 g_object_class_install_property (gobject_class,
418 g_param_spec_int ("height_request",
420 _("Override for height request of the widget, or -1 if natural request should be used"),
425 g_object_class_install_property (gobject_class,
427 g_param_spec_boolean ("visible",
429 _("Whether the widget is visible"),
432 g_object_class_install_property (gobject_class,
434 g_param_spec_boolean ("sensitive",
436 _("Whether the widget responds to input"),
439 g_object_class_install_property (gobject_class,
441 g_param_spec_boolean ("app_paintable",
442 _("Application paintable"),
443 _("Whether the application will paint directly on the widget"),
446 g_object_class_install_property (gobject_class,
448 g_param_spec_boolean ("can_focus",
450 _("Whether the widget can accept the input focus"),
453 g_object_class_install_property (gobject_class,
455 g_param_spec_boolean ("has_focus",
457 _("Whether the widget has the input focus"),
460 g_object_class_install_property (gobject_class,
462 g_param_spec_boolean ("is_focus",
464 _("Whether the widget is the focus widget within the toplevel"),
467 g_object_class_install_property (gobject_class,
469 g_param_spec_boolean ("can_default",
471 _("Whether the widget can be the default widget"),
474 g_object_class_install_property (gobject_class,
476 g_param_spec_boolean ("has_default",
478 _("Whether the widget is the default widget"),
481 g_object_class_install_property (gobject_class,
482 PROP_RECEIVES_DEFAULT,
483 g_param_spec_boolean ("receives_default",
484 _("Receives default"),
485 _("If TRUE, the widget will receive the default action when it is focused"),
488 g_object_class_install_property (gobject_class,
489 PROP_COMPOSITE_CHILD,
490 g_param_spec_boolean ("composite_child",
491 _("Composite child"),
492 _("Whether the widget is part of a composite widget"),
495 g_object_class_install_property (gobject_class,
497 g_param_spec_object ("style",
499 _("The style of the widget, which contains information about how it will look (colors etc)"),
502 g_object_class_install_property (gobject_class,
504 g_param_spec_flags ("events",
506 _("The event mask that decides what kind of GdkEvents this widget gets"),
510 g_object_class_install_property (gobject_class,
511 PROP_EXTENSION_EVENTS,
512 g_param_spec_enum ("extension_events",
513 _("Extension events"),
514 _("The mask that decides what kind of extension events this widget gets"),
515 GDK_TYPE_EXTENSION_MODE,
516 GDK_EXTENSION_EVENTS_NONE,
518 widget_signals[SHOW] =
519 g_signal_new ("show",
520 G_TYPE_FROM_CLASS (gobject_class),
522 G_STRUCT_OFFSET (GtkWidgetClass, show),
524 _gtk_marshal_VOID__VOID,
526 widget_signals[HIDE] =
527 g_signal_new ("hide",
528 G_TYPE_FROM_CLASS (gobject_class),
530 G_STRUCT_OFFSET (GtkWidgetClass, hide),
532 _gtk_marshal_VOID__VOID,
534 widget_signals[MAP] =
536 G_TYPE_FROM_CLASS (gobject_class),
538 G_STRUCT_OFFSET (GtkWidgetClass, map),
540 _gtk_marshal_VOID__VOID,
542 widget_signals[UNMAP] =
543 g_signal_new ("unmap",
544 G_TYPE_FROM_CLASS (gobject_class),
546 G_STRUCT_OFFSET (GtkWidgetClass, unmap),
548 _gtk_marshal_VOID__VOID,
550 widget_signals[REALIZE] =
551 g_signal_new ("realize",
552 G_TYPE_FROM_CLASS (gobject_class),
554 G_STRUCT_OFFSET (GtkWidgetClass, realize),
556 _gtk_marshal_VOID__VOID,
558 widget_signals[UNREALIZE] =
559 g_signal_new ("unrealize",
560 G_TYPE_FROM_CLASS (gobject_class),
562 G_STRUCT_OFFSET (GtkWidgetClass, unrealize),
564 _gtk_marshal_VOID__VOID,
566 widget_signals[SIZE_REQUEST] =
567 g_signal_new ("size_request",
568 G_TYPE_FROM_CLASS (gobject_class),
570 G_STRUCT_OFFSET (GtkWidgetClass, size_request),
572 _gtk_marshal_VOID__BOXED,
574 GTK_TYPE_REQUISITION | G_SIGNAL_TYPE_STATIC_SCOPE);
575 widget_signals[SIZE_ALLOCATE] =
576 g_signal_new ("size_allocate",
577 G_TYPE_FROM_CLASS (gobject_class),
579 G_STRUCT_OFFSET (GtkWidgetClass, size_allocate),
581 _gtk_marshal_VOID__BOXED,
583 GDK_TYPE_RECTANGLE | G_SIGNAL_TYPE_STATIC_SCOPE);
584 widget_signals[STATE_CHANGED] =
585 g_signal_new ("state_changed",
586 G_TYPE_FROM_CLASS (gobject_class),
588 G_STRUCT_OFFSET (GtkWidgetClass, state_changed),
590 _gtk_marshal_VOID__ENUM,
592 GTK_TYPE_STATE_TYPE);
593 widget_signals[PARENT_SET] =
594 g_signal_new ("parent_set",
595 G_TYPE_FROM_CLASS (gobject_class),
597 G_STRUCT_OFFSET (GtkWidgetClass, parent_set),
599 _gtk_marshal_VOID__OBJECT,
602 widget_signals[HIERARCHY_CHANGED] =
603 g_signal_new ("hierarchy_changed",
604 G_TYPE_FROM_CLASS (gobject_class),
606 G_STRUCT_OFFSET (GtkWidgetClass, hierarchy_changed),
608 _gtk_marshal_VOID__OBJECT,
611 widget_signals[STYLE_SET] =
612 g_signal_new ("style_set",
613 G_TYPE_FROM_CLASS (gobject_class),
615 G_STRUCT_OFFSET (GtkWidgetClass, style_set),
617 _gtk_marshal_VOID__OBJECT,
620 widget_signals[DIRECTION_CHANGED] =
621 g_signal_new ("direction_changed",
622 G_TYPE_FROM_CLASS (gobject_class),
624 G_STRUCT_OFFSET (GtkWidgetClass, direction_changed),
626 _gtk_marshal_VOID__ENUM,
628 GTK_TYPE_TEXT_DIRECTION);
629 widget_signals[GRAB_NOTIFY] =
630 g_signal_new ("grab_notify",
631 G_TYPE_FROM_CLASS (gobject_class),
633 G_STRUCT_OFFSET (GtkWidgetClass, grab_notify),
635 _gtk_marshal_VOID__BOOLEAN,
638 widget_signals[CHILD_NOTIFY] =
639 g_signal_new ("child_notify",
640 G_TYPE_FROM_CLASS (gobject_class),
641 G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE | G_SIGNAL_DETAILED | G_SIGNAL_NO_HOOKS,
642 G_STRUCT_OFFSET (GtkWidgetClass, child_notify),
644 g_cclosure_marshal_VOID__PARAM,
647 widget_signals[MNEMONIC_ACTIVATE] =
648 g_signal_new ("mnemonic_activate",
649 G_TYPE_FROM_CLASS (gobject_class),
651 G_STRUCT_OFFSET (GtkWidgetClass, mnemonic_activate),
652 _gtk_boolean_handled_accumulator, NULL,
653 _gtk_marshal_BOOLEAN__BOOLEAN,
656 widget_signals[GRAB_FOCUS] =
657 g_signal_new ("grab_focus",
658 G_TYPE_FROM_CLASS (gobject_class),
659 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
660 G_STRUCT_OFFSET (GtkWidgetClass, grab_focus),
662 _gtk_marshal_VOID__VOID,
664 widget_signals[FOCUS] =
665 g_signal_new ("focus",
666 G_TYPE_FROM_CLASS (object_class),
668 G_STRUCT_OFFSET (GtkWidgetClass, focus),
669 _gtk_boolean_handled_accumulator, NULL,
670 _gtk_marshal_BOOLEAN__ENUM,
672 GTK_TYPE_DIRECTION_TYPE);
673 widget_signals[EVENT] =
674 g_signal_new ("event",
675 G_TYPE_FROM_CLASS (gobject_class),
677 G_STRUCT_OFFSET (GtkWidgetClass, event),
678 _gtk_boolean_handled_accumulator, NULL,
679 _gtk_marshal_BOOLEAN__BOXED,
681 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
682 widget_signals[EVENT_AFTER] =
683 g_signal_new ("event-after",
684 G_TYPE_FROM_CLASS (gobject_class),
688 _gtk_marshal_VOID__BOXED,
690 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
691 widget_signals[BUTTON_PRESS_EVENT] =
692 g_signal_new ("button_press_event",
693 G_TYPE_FROM_CLASS (gobject_class),
695 G_STRUCT_OFFSET (GtkWidgetClass, button_press_event),
696 _gtk_boolean_handled_accumulator, NULL,
697 _gtk_marshal_BOOLEAN__BOXED,
699 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
700 widget_signals[BUTTON_RELEASE_EVENT] =
701 g_signal_new ("button_release_event",
702 G_TYPE_FROM_CLASS (gobject_class),
704 G_STRUCT_OFFSET (GtkWidgetClass, button_release_event),
705 _gtk_boolean_handled_accumulator, NULL,
706 _gtk_marshal_BOOLEAN__BOXED,
708 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
709 widget_signals[SCROLL_EVENT] =
710 g_signal_new ("scroll_event",
711 G_TYPE_FROM_CLASS (gobject_class),
713 G_STRUCT_OFFSET (GtkWidgetClass, scroll_event),
714 _gtk_boolean_handled_accumulator, NULL,
715 _gtk_marshal_BOOLEAN__BOXED,
717 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
718 widget_signals[MOTION_NOTIFY_EVENT] =
719 g_signal_new ("motion_notify_event",
720 G_TYPE_FROM_CLASS (gobject_class),
722 G_STRUCT_OFFSET (GtkWidgetClass, motion_notify_event),
723 _gtk_boolean_handled_accumulator, NULL,
724 _gtk_marshal_BOOLEAN__BOXED,
726 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
727 widget_signals[DELETE_EVENT] =
728 g_signal_new ("delete_event",
729 G_TYPE_FROM_CLASS (gobject_class),
731 G_STRUCT_OFFSET (GtkWidgetClass, delete_event),
732 _gtk_boolean_handled_accumulator, NULL,
733 _gtk_marshal_BOOLEAN__BOXED,
735 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
736 widget_signals[DESTROY_EVENT] =
737 g_signal_new ("destroy_event",
738 G_TYPE_FROM_CLASS (gobject_class),
740 G_STRUCT_OFFSET (GtkWidgetClass, destroy_event),
741 _gtk_boolean_handled_accumulator, NULL,
742 _gtk_marshal_BOOLEAN__BOXED,
744 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
745 widget_signals[EXPOSE_EVENT] =
746 g_signal_new ("expose_event",
747 G_TYPE_FROM_CLASS (gobject_class),
749 G_STRUCT_OFFSET (GtkWidgetClass, expose_event),
750 _gtk_boolean_handled_accumulator, NULL,
751 _gtk_marshal_BOOLEAN__BOXED,
753 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
754 widget_signals[KEY_PRESS_EVENT] =
755 g_signal_new ("key_press_event",
756 G_TYPE_FROM_CLASS (gobject_class),
758 G_STRUCT_OFFSET (GtkWidgetClass, key_press_event),
759 _gtk_boolean_handled_accumulator, NULL,
760 _gtk_marshal_BOOLEAN__BOXED,
762 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
763 widget_signals[KEY_RELEASE_EVENT] =
764 g_signal_new ("key_release_event",
765 G_TYPE_FROM_CLASS (gobject_class),
767 G_STRUCT_OFFSET (GtkWidgetClass, key_release_event),
768 _gtk_boolean_handled_accumulator, NULL,
769 _gtk_marshal_BOOLEAN__BOXED,
771 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
772 widget_signals[ENTER_NOTIFY_EVENT] =
773 g_signal_new ("enter_notify_event",
774 G_TYPE_FROM_CLASS (gobject_class),
776 G_STRUCT_OFFSET (GtkWidgetClass, enter_notify_event),
777 _gtk_boolean_handled_accumulator, NULL,
778 _gtk_marshal_BOOLEAN__BOXED,
780 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
781 widget_signals[LEAVE_NOTIFY_EVENT] =
782 g_signal_new ("leave_notify_event",
783 G_TYPE_FROM_CLASS (gobject_class),
785 G_STRUCT_OFFSET (GtkWidgetClass, leave_notify_event),
786 _gtk_boolean_handled_accumulator, NULL,
787 _gtk_marshal_BOOLEAN__BOXED,
789 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
790 widget_signals[CONFIGURE_EVENT] =
791 g_signal_new ("configure_event",
792 G_TYPE_FROM_CLASS (gobject_class),
794 G_STRUCT_OFFSET (GtkWidgetClass, configure_event),
795 _gtk_boolean_handled_accumulator, NULL,
796 _gtk_marshal_BOOLEAN__BOXED,
798 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
799 widget_signals[FOCUS_IN_EVENT] =
800 g_signal_new ("focus_in_event",
801 G_TYPE_FROM_CLASS (gobject_class),
803 G_STRUCT_OFFSET (GtkWidgetClass, focus_in_event),
804 _gtk_boolean_handled_accumulator, NULL,
805 _gtk_marshal_BOOLEAN__BOXED,
807 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
808 widget_signals[FOCUS_OUT_EVENT] =
809 g_signal_new ("focus_out_event",
810 G_TYPE_FROM_CLASS (gobject_class),
812 G_STRUCT_OFFSET (GtkWidgetClass, focus_out_event),
813 _gtk_boolean_handled_accumulator, NULL,
814 _gtk_marshal_BOOLEAN__BOXED,
816 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
817 widget_signals[MAP_EVENT] =
818 g_signal_new ("map_event",
819 G_TYPE_FROM_CLASS (gobject_class),
821 G_STRUCT_OFFSET (GtkWidgetClass, map_event),
822 _gtk_boolean_handled_accumulator, NULL,
823 _gtk_marshal_BOOLEAN__BOXED,
825 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
826 widget_signals[UNMAP_EVENT] =
827 g_signal_new ("unmap_event",
828 G_TYPE_FROM_CLASS (gobject_class),
830 G_STRUCT_OFFSET (GtkWidgetClass, unmap_event),
831 _gtk_boolean_handled_accumulator, NULL,
832 _gtk_marshal_BOOLEAN__BOXED,
834 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
835 widget_signals[PROPERTY_NOTIFY_EVENT] =
836 g_signal_new ("property_notify_event",
837 G_TYPE_FROM_CLASS (gobject_class),
839 G_STRUCT_OFFSET (GtkWidgetClass, property_notify_event),
840 _gtk_boolean_handled_accumulator, NULL,
841 _gtk_marshal_BOOLEAN__BOXED,
843 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
844 widget_signals[SELECTION_CLEAR_EVENT] =
845 g_signal_new ("selection_clear_event",
846 G_TYPE_FROM_CLASS (gobject_class),
848 G_STRUCT_OFFSET (GtkWidgetClass, selection_clear_event),
849 _gtk_boolean_handled_accumulator, NULL,
850 _gtk_marshal_BOOLEAN__BOXED,
852 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
853 widget_signals[SELECTION_REQUEST_EVENT] =
854 g_signal_new ("selection_request_event",
855 G_TYPE_FROM_CLASS (gobject_class),
857 G_STRUCT_OFFSET (GtkWidgetClass, selection_request_event),
858 _gtk_boolean_handled_accumulator, NULL,
859 _gtk_marshal_BOOLEAN__BOXED,
861 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
862 widget_signals[SELECTION_NOTIFY_EVENT] =
863 g_signal_new ("selection_notify_event",
864 G_TYPE_FROM_CLASS (gobject_class),
866 G_STRUCT_OFFSET (GtkWidgetClass, selection_notify_event),
867 _gtk_boolean_handled_accumulator, NULL,
868 _gtk_marshal_BOOLEAN__BOXED,
870 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
871 widget_signals[SELECTION_RECEIVED] =
872 g_signal_new ("selection_received",
873 G_TYPE_FROM_CLASS (gobject_class),
875 G_STRUCT_OFFSET (GtkWidgetClass, selection_received),
877 _gtk_marshal_VOID__BOXED_UINT,
879 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
881 widget_signals[SELECTION_GET] =
882 g_signal_new ("selection_get",
883 G_TYPE_FROM_CLASS (gobject_class),
885 G_STRUCT_OFFSET (GtkWidgetClass, selection_get),
887 _gtk_marshal_VOID__BOXED_UINT_UINT,
889 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
892 widget_signals[PROXIMITY_IN_EVENT] =
893 g_signal_new ("proximity_in_event",
894 G_TYPE_FROM_CLASS (gobject_class),
896 G_STRUCT_OFFSET (GtkWidgetClass, proximity_in_event),
897 _gtk_boolean_handled_accumulator, NULL,
898 _gtk_marshal_BOOLEAN__BOXED,
900 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
901 widget_signals[PROXIMITY_OUT_EVENT] =
902 g_signal_new ("proximity_out_event",
903 G_TYPE_FROM_CLASS (gobject_class),
905 G_STRUCT_OFFSET (GtkWidgetClass, proximity_out_event),
906 _gtk_boolean_handled_accumulator, NULL,
907 _gtk_marshal_BOOLEAN__BOXED,
909 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
910 widget_signals[DRAG_LEAVE] =
911 g_signal_new ("drag_leave",
912 G_TYPE_FROM_CLASS (gobject_class),
914 G_STRUCT_OFFSET (GtkWidgetClass, drag_leave),
916 _gtk_marshal_VOID__OBJECT_UINT,
918 GDK_TYPE_DRAG_CONTEXT,
920 widget_signals[DRAG_BEGIN] =
921 g_signal_new ("drag_begin",
922 G_TYPE_FROM_CLASS (gobject_class),
924 G_STRUCT_OFFSET (GtkWidgetClass, drag_begin),
926 _gtk_marshal_VOID__OBJECT,
928 GDK_TYPE_DRAG_CONTEXT);
929 widget_signals[DRAG_END] =
930 g_signal_new ("drag_end",
931 G_TYPE_FROM_CLASS (gobject_class),
933 G_STRUCT_OFFSET (GtkWidgetClass, drag_end),
935 _gtk_marshal_VOID__OBJECT,
937 GDK_TYPE_DRAG_CONTEXT);
938 widget_signals[DRAG_DATA_DELETE] =
939 g_signal_new ("drag_data_delete",
940 G_TYPE_FROM_CLASS (gobject_class),
942 G_STRUCT_OFFSET (GtkWidgetClass, drag_data_delete),
944 _gtk_marshal_VOID__OBJECT,
946 GDK_TYPE_DRAG_CONTEXT);
947 widget_signals[DRAG_MOTION] =
948 g_signal_new ("drag_motion",
949 G_TYPE_FROM_CLASS (gobject_class),
951 G_STRUCT_OFFSET (GtkWidgetClass, drag_motion),
952 _gtk_boolean_handled_accumulator, NULL,
953 _gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
955 GDK_TYPE_DRAG_CONTEXT,
959 widget_signals[DRAG_DROP] =
960 g_signal_new ("drag_drop",
961 G_TYPE_FROM_CLASS (gobject_class),
963 G_STRUCT_OFFSET (GtkWidgetClass, drag_drop),
964 _gtk_boolean_handled_accumulator, NULL,
965 _gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
967 GDK_TYPE_DRAG_CONTEXT,
971 widget_signals[DRAG_DATA_GET] =
972 g_signal_new ("drag_data_get",
973 G_TYPE_FROM_CLASS (gobject_class),
975 G_STRUCT_OFFSET (GtkWidgetClass, drag_data_get),
977 _gtk_marshal_VOID__OBJECT_BOXED_UINT_UINT,
979 GDK_TYPE_DRAG_CONTEXT,
980 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
983 widget_signals[DRAG_DATA_RECEIVED] =
984 g_signal_new ("drag_data_received",
985 G_TYPE_FROM_CLASS (gobject_class),
987 G_STRUCT_OFFSET (GtkWidgetClass, drag_data_received),
989 _gtk_marshal_VOID__OBJECT_INT_INT_BOXED_UINT_UINT,
991 GDK_TYPE_DRAG_CONTEXT,
994 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
997 widget_signals[VISIBILITY_NOTIFY_EVENT] =
998 g_signal_new ("visibility_notify_event",
999 G_TYPE_FROM_CLASS (gobject_class),
1001 G_STRUCT_OFFSET (GtkWidgetClass, visibility_notify_event),
1002 _gtk_boolean_handled_accumulator, NULL,
1003 _gtk_marshal_BOOLEAN__BOXED,
1005 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1006 widget_signals[CLIENT_EVENT] =
1007 g_signal_new ("client_event",
1008 G_TYPE_FROM_CLASS (gobject_class),
1010 G_STRUCT_OFFSET (GtkWidgetClass, client_event),
1011 _gtk_boolean_handled_accumulator, NULL,
1012 _gtk_marshal_BOOLEAN__BOXED,
1014 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1015 widget_signals[NO_EXPOSE_EVENT] =
1016 g_signal_new ("no_expose_event",
1017 G_TYPE_FROM_CLASS (gobject_class),
1019 G_STRUCT_OFFSET (GtkWidgetClass, no_expose_event),
1020 _gtk_boolean_handled_accumulator, NULL,
1021 _gtk_marshal_BOOLEAN__BOXED,
1023 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1024 widget_signals[WINDOW_STATE_EVENT] =
1025 g_signal_new ("window_state_event",
1026 G_TYPE_FROM_CLASS (gobject_class),
1028 G_STRUCT_OFFSET (GtkWidgetClass, window_state_event),
1029 _gtk_boolean_handled_accumulator, NULL,
1030 _gtk_marshal_BOOLEAN__BOXED,
1032 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1033 widget_signals[POPUP_MENU] =
1034 g_signal_new ("popup_menu",
1035 G_TYPE_FROM_CLASS (gobject_class),
1036 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
1037 G_STRUCT_OFFSET (GtkWidgetClass, popup_menu),
1038 _gtk_boolean_handled_accumulator, NULL,
1039 _gtk_marshal_BOOLEAN__VOID,
1041 widget_signals[SHOW_HELP] =
1042 g_signal_new ("show_help",
1043 G_TYPE_FROM_CLASS (gobject_class),
1044 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
1045 G_STRUCT_OFFSET (GtkWidgetClass, show_help),
1046 _gtk_boolean_handled_accumulator, NULL,
1047 _gtk_marshal_BOOLEAN__ENUM,
1049 GTK_TYPE_WIDGET_HELP_TYPE);
1050 widget_signals[ACCEL_CLOSURES_CHANGED] =
1051 g_signal_new ("accel_closures_changed",
1052 G_TYPE_FROM_CLASS (gobject_class),
1056 _gtk_marshal_NONE__NONE,
1058 widget_signals[SCREEN_CHANGED] =
1059 g_signal_new ("screen_changed",
1060 G_TYPE_FROM_CLASS (gobject_class),
1062 G_STRUCT_OFFSET (GtkWidgetClass, hierarchy_changed),
1064 _gtk_marshal_VOID__OBJECT,
1068 binding_set = gtk_binding_set_by_class (klass);
1069 gtk_binding_entry_add_signal (binding_set, GDK_F10, GDK_SHIFT_MASK,
1071 gtk_binding_entry_add_signal (binding_set, GDK_Menu, 0,
1074 gtk_binding_entry_add_signal (binding_set, GDK_F1, GDK_CONTROL_MASK,
1076 GTK_TYPE_WIDGET_HELP_TYPE,
1077 GTK_WIDGET_HELP_TOOLTIP);
1078 gtk_binding_entry_add_signal (binding_set, GDK_KP_F1, GDK_CONTROL_MASK,
1080 GTK_TYPE_WIDGET_HELP_TYPE,
1081 GTK_WIDGET_HELP_TOOLTIP);
1082 gtk_binding_entry_add_signal (binding_set, GDK_F1, GDK_SHIFT_MASK,
1084 GTK_TYPE_WIDGET_HELP_TYPE,
1085 GTK_WIDGET_HELP_WHATS_THIS);
1086 gtk_binding_entry_add_signal (binding_set, GDK_KP_F1, GDK_SHIFT_MASK,
1088 GTK_TYPE_WIDGET_HELP_TYPE,
1089 GTK_WIDGET_HELP_WHATS_THIS);
1091 gtk_widget_class_install_style_property (klass,
1092 g_param_spec_boolean ("interior_focus",
1093 _("Interior Focus"),
1094 _("Whether to draw the focus indicator inside widgets"),
1098 gtk_widget_class_install_style_property (klass,
1099 g_param_spec_int ("focus-line-width",
1100 _("Focus linewidth"),
1101 _("Width, in pixels, of the focus indicator line"),
1103 G_PARAM_READWRITE));
1105 gtk_widget_class_install_style_property (klass,
1106 g_param_spec_string ("focus-line-pattern",
1107 _("Focus line dash pattern"),
1108 _("Dash pattern used to draw the focus indicator"),
1110 G_PARAM_READWRITE));
1111 gtk_widget_class_install_style_property (klass,
1112 g_param_spec_int ("focus-padding",
1114 _("Width, in pixels, between focus indicator and the widget 'box'"),
1116 G_PARAM_READWRITE));
1117 gtk_widget_class_install_style_property (klass,
1118 g_param_spec_boxed ("cursor-color",
1120 _("Color with which to draw insertion cursor"),
1123 gtk_widget_class_install_style_property (klass,
1124 g_param_spec_boxed ("secondary-cursor-color",
1125 _("Secondary cursor color"),
1126 _("Color with which to draw the secondary insertion cursor when editing mixed right-to-left and left-to-right text"),
1129 gtk_widget_class_install_style_property (klass,
1130 g_param_spec_float ("cursor-aspect-ratio",
1131 _("Cursor line aspect ratio"),
1132 _("Aspect ratio with which to draw insertion cursor"),
1138 gtk_widget_set_property (GObject *object,
1140 const GValue *value,
1143 GtkWidget *widget = GTK_WIDGET (object);
1147 guint32 saved_flags;
1150 gtk_widget_set_name (widget, g_value_get_string (value));
1153 gtk_container_add (GTK_CONTAINER (g_value_get_object (value)), widget);
1155 case PROP_WIDTH_REQUEST:
1156 gtk_widget_set_usize (widget, g_value_get_int (value), -2);
1158 case PROP_HEIGHT_REQUEST:
1159 gtk_widget_set_usize (widget, -2, g_value_get_int (value));
1162 if (g_value_get_boolean (value))
1163 gtk_widget_show (widget);
1165 gtk_widget_hide (widget);
1167 case PROP_SENSITIVE:
1168 gtk_widget_set_sensitive (widget, g_value_get_boolean (value));
1170 case PROP_APP_PAINTABLE:
1171 gtk_widget_set_app_paintable (widget, g_value_get_boolean (value));
1173 case PROP_CAN_FOCUS:
1174 saved_flags = GTK_WIDGET_FLAGS (widget);
1175 if (g_value_get_boolean (value))
1176 GTK_WIDGET_SET_FLAGS (widget, GTK_CAN_FOCUS);
1178 GTK_WIDGET_UNSET_FLAGS (widget, GTK_CAN_FOCUS);
1179 if (saved_flags != GTK_WIDGET_FLAGS (widget))
1180 gtk_widget_queue_resize (widget);
1182 case PROP_HAS_FOCUS:
1183 if (g_value_get_boolean (value))
1184 gtk_widget_grab_focus (widget);
1187 if (g_value_get_boolean (value))
1188 gtk_widget_grab_focus (widget);
1190 case PROP_CAN_DEFAULT:
1191 saved_flags = GTK_WIDGET_FLAGS (widget);
1192 if (g_value_get_boolean (value))
1193 GTK_WIDGET_SET_FLAGS (widget, GTK_CAN_DEFAULT);
1195 GTK_WIDGET_UNSET_FLAGS (widget, GTK_CAN_DEFAULT);
1196 if (saved_flags != GTK_WIDGET_FLAGS (widget))
1197 gtk_widget_queue_resize (widget);
1199 case PROP_HAS_DEFAULT:
1200 if (g_value_get_boolean (value))
1201 gtk_widget_grab_default (widget);
1203 case PROP_RECEIVES_DEFAULT:
1204 if (g_value_get_boolean (value))
1205 GTK_WIDGET_SET_FLAGS (widget, GTK_RECEIVES_DEFAULT);
1207 GTK_WIDGET_UNSET_FLAGS (widget, GTK_RECEIVES_DEFAULT);
1210 gtk_widget_set_style (widget, g_value_get_object (value));
1213 if (!GTK_WIDGET_REALIZED (widget) && !GTK_WIDGET_NO_WINDOW (widget))
1214 gtk_widget_set_events (widget, g_value_get_flags (value));
1216 case PROP_EXTENSION_EVENTS:
1217 gtk_widget_set_extension_events (widget, g_value_get_enum (value));
1225 gtk_widget_get_property (GObject *object,
1230 GtkWidget *widget = GTK_WIDGET (object);
1235 GdkExtensionMode *modep;
1239 g_value_set_string (value, widget->name);
1241 g_value_set_string (value, "");
1245 g_value_set_object (value, widget->parent);
1247 g_value_set_object (value, NULL);
1249 case PROP_WIDTH_REQUEST:
1252 gtk_widget_get_size_request (widget, &w, NULL);
1253 g_value_set_int (value, w);
1256 case PROP_HEIGHT_REQUEST:
1259 gtk_widget_get_size_request (widget, NULL, &h);
1260 g_value_set_int (value, h);
1264 g_value_set_boolean (value, (GTK_WIDGET_VISIBLE (widget) != FALSE));
1266 case PROP_SENSITIVE:
1267 g_value_set_boolean (value, (GTK_WIDGET_SENSITIVE (widget) != FALSE));
1269 case PROP_APP_PAINTABLE:
1270 g_value_set_boolean (value, (GTK_WIDGET_APP_PAINTABLE (widget) != FALSE));
1272 case PROP_CAN_FOCUS:
1273 g_value_set_boolean (value, (GTK_WIDGET_CAN_FOCUS (widget) != FALSE));
1275 case PROP_HAS_FOCUS:
1276 g_value_set_boolean (value, (GTK_WIDGET_HAS_FOCUS (widget) != FALSE));
1279 g_value_set_boolean (value, (gtk_widget_is_focus (widget)));
1281 case PROP_CAN_DEFAULT:
1282 g_value_set_boolean (value, (GTK_WIDGET_CAN_DEFAULT (widget) != FALSE));
1284 case PROP_HAS_DEFAULT:
1285 g_value_set_boolean (value, (GTK_WIDGET_HAS_DEFAULT (widget) != FALSE));
1287 case PROP_RECEIVES_DEFAULT:
1288 g_value_set_boolean (value, (GTK_WIDGET_RECEIVES_DEFAULT (widget) != FALSE));
1290 case PROP_COMPOSITE_CHILD:
1291 g_value_set_boolean (value, (GTK_WIDGET_COMPOSITE_CHILD (widget) != FALSE));
1294 g_value_set_object (value, gtk_widget_get_style (widget));
1297 eventp = g_object_get_qdata (G_OBJECT (widget), quark_event_mask);
1299 g_value_set_flags (value, 0);
1301 g_value_set_flags (value, *eventp);
1303 case PROP_EXTENSION_EVENTS:
1304 modep = g_object_get_qdata (G_OBJECT (widget), quark_extension_event_mode);
1306 g_value_set_enum (value, 0);
1308 g_value_set_enum (value, (GdkExtensionMode) *modep);
1311 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1317 gtk_widget_init (GtkWidget *widget)
1319 GTK_PRIVATE_FLAGS (widget) = PRIVATE_GTK_CHILD_VISIBLE;
1320 widget->state = GTK_STATE_NORMAL;
1321 widget->saved_state = GTK_STATE_NORMAL;
1322 widget->name = NULL;
1323 widget->requisition.width = 0;
1324 widget->requisition.height = 0;
1325 widget->allocation.x = -1;
1326 widget->allocation.y = -1;
1327 widget->allocation.width = 1;
1328 widget->allocation.height = 1;
1329 widget->window = NULL;
1330 widget->parent = NULL;
1332 GTK_WIDGET_SET_FLAGS (widget,
1334 GTK_PARENT_SENSITIVE |
1335 (composite_child_stack ? GTK_COMPOSITE_CHILD : 0) |
1336 GTK_DOUBLE_BUFFERED);
1338 GTK_PRIVATE_SET_FLAG (widget, GTK_REDRAW_ON_ALLOC);
1339 GTK_PRIVATE_SET_FLAG (widget, GTK_REQUEST_NEEDED);
1340 GTK_PRIVATE_SET_FLAG (widget, GTK_ALLOC_NEEDED);
1342 widget->style = gtk_widget_get_default_style ();
1343 g_object_ref (widget->style);
1348 gtk_widget_dispatch_child_properties_changed (GtkWidget *widget,
1350 GParamSpec **pspecs)
1352 GtkWidget *container = widget->parent;
1355 for (i = 0; widget->parent == container && i < n_pspecs; i++)
1356 g_signal_emit (widget, widget_signals[CHILD_NOTIFY], g_quark_from_string (pspecs[i]->name), pspecs[i]);
1360 gtk_widget_freeze_child_notify (GtkWidget *widget)
1362 g_return_if_fail (GTK_IS_WIDGET (widget));
1364 if (!G_OBJECT (widget)->ref_count)
1367 g_object_ref (widget);
1368 g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
1369 g_object_unref (widget);
1373 gtk_widget_child_notify (GtkWidget *widget,
1374 const gchar *child_property)
1378 g_return_if_fail (GTK_IS_WIDGET (widget));
1379 g_return_if_fail (child_property != NULL);
1380 if (!G_OBJECT (widget)->ref_count || !widget->parent)
1383 g_object_ref (widget);
1384 pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
1386 G_OBJECT_TYPE (widget->parent),
1389 g_warning ("%s: container class `%s' has no child property named `%s'",
1391 G_OBJECT_TYPE_NAME (widget->parent),
1395 GObjectNotifyQueue *nqueue = g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
1397 g_object_notify_queue_add (G_OBJECT (widget), nqueue, pspec);
1398 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
1400 g_object_unref (widget);
1404 * gtk_widget_thaw_child_notify:
1405 * @widget: a #GtkWidget
1407 * Reverts the effect of a previous call to gtk_widget_freeze_child_notify().
1410 gtk_widget_thaw_child_notify (GtkWidget *widget)
1412 GObjectNotifyQueue *nqueue;
1414 g_return_if_fail (GTK_IS_WIDGET (widget));
1416 if (!G_OBJECT (widget)->ref_count)
1419 g_object_ref (widget);
1420 nqueue = g_object_notify_queue_from_object (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
1421 if (!nqueue || !nqueue->freeze_count)
1422 g_warning (G_STRLOC ": child-property-changed notification for %s(%p) is not frozen",
1423 G_OBJECT_TYPE_NAME (widget), widget);
1425 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
1426 g_object_unref (widget);
1432 * @type: type ID of the widget to create
1433 * @first_property_name: name of first property to set
1434 * @Varargs: value of first property, followed by more properties, %NULL-terminated
1436 * This is a convenience function for creating a widget and setting
1437 * its properties in one go. For example you might write:
1438 * <literal>gtk_widget_new (GTK_TYPE_LABEL, "label", "Hello World", "xalign",
1439 * 0.0, NULL)</literal> to create a left-aligned label. Equivalent to
1440 * g_object_new(), but returns a widget so you don't have to
1441 * cast the object yourself.
1443 * Return value: a new #GtkWidget of type @widget_type
1446 gtk_widget_new (GType type,
1447 const gchar *first_property_name,
1453 g_return_val_if_fail (g_type_is_a (type, GTK_TYPE_WIDGET), NULL);
1455 va_start (var_args, first_property_name);
1456 widget = (GtkWidget *)g_object_new_valist (type, first_property_name, var_args);
1464 * @widget: a #GtkWidget
1465 * @first_property_name: name of first property to set
1466 * @Varargs: value of first property, followed by more properties, %NULL-terminated
1468 * Like g_object_set() - there's no reason to use this instead of
1472 gtk_widget_set (GtkWidget *widget,
1473 const gchar *first_property_name,
1478 g_return_if_fail (GTK_IS_WIDGET (widget));
1480 va_start (var_args, first_property_name);
1481 g_object_set_valist (G_OBJECT (widget), first_property_name, var_args);
1486 gtk_widget_queue_clear_child (GtkWidget *widget)
1490 parent = widget->parent;
1491 if (parent && GTK_WIDGET_DRAWABLE (parent))
1492 gtk_widget_queue_clear_area (parent,
1493 widget->allocation.x,
1494 widget->allocation.y,
1495 widget->allocation.width,
1496 widget->allocation.height);
1500 * gtk_widget_unparent:
1501 * @widget: a #GtkWidget
1503 * This function is only for use in widget implementations.
1504 * Should be called by implementations of the remove method
1505 * on #GtkContainer, to dissociate a child from the container.
1508 gtk_widget_unparent (GtkWidget *widget)
1510 GObjectNotifyQueue *nqueue;
1511 GtkWidget *toplevel;
1512 GtkWidget *old_parent;
1514 g_return_if_fail (GTK_IS_WIDGET (widget));
1515 if (widget->parent == NULL)
1518 /* keep this function in sync with gtk_menu_detach()
1521 g_object_freeze_notify (G_OBJECT (widget));
1522 nqueue = g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
1524 /* unset focused and default children properly, this code
1525 * should eventually move into some gtk_window_unparent_branch() or
1529 toplevel = gtk_widget_get_toplevel (widget);
1530 if (GTK_CONTAINER (widget->parent)->focus_child == widget)
1532 gtk_container_set_focus_child (GTK_CONTAINER (widget->parent), NULL);
1534 if (GTK_WIDGET_TOPLEVEL (toplevel))
1538 child = GTK_WINDOW (toplevel)->focus_widget;
1540 while (child && child != widget)
1541 child = child->parent;
1543 if (child == widget)
1544 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
1547 if (GTK_WIDGET_TOPLEVEL (toplevel))
1551 child = GTK_WINDOW (toplevel)->default_widget;
1553 while (child && child != widget)
1554 child = child->parent;
1556 if (child == widget)
1557 gtk_window_set_default (GTK_WINDOW (toplevel), NULL);
1560 /* If we are unanchoring the child, we save around the toplevel
1561 * to emit hierarchy changed
1563 if (GTK_WIDGET_ANCHORED (widget->parent))
1564 g_object_ref (toplevel);
1568 gtk_widget_queue_clear_child (widget);
1570 /* Reset the width and height here, to force reallocation if we
1571 * get added back to a new parent. This won't work if our new
1572 * allocation is smaller than 1x1 and we actually want a size of 1x1...
1573 * (would 0x0 be OK here?)
1575 widget->allocation.width = 1;
1576 widget->allocation.height = 1;
1578 if (GTK_WIDGET_REALIZED (widget) && !GTK_WIDGET_IN_REPARENT (widget))
1579 gtk_widget_unrealize (widget);
1581 /* Removing a widget from a container restores the child visible
1582 * flag to the default state, so it doesn't affect the child
1583 * in the next parent.
1585 GTK_PRIVATE_SET_FLAG (widget, GTK_CHILD_VISIBLE);
1587 old_parent = widget->parent;
1588 widget->parent = NULL;
1589 gtk_widget_set_parent_window (widget, NULL);
1590 g_signal_emit (widget, widget_signals[PARENT_SET], 0, old_parent);
1593 _gtk_widget_propagate_hierarchy_changed (widget, toplevel);
1594 g_object_unref (toplevel);
1597 g_object_notify (G_OBJECT (widget), "parent");
1598 g_object_thaw_notify (G_OBJECT (widget));
1599 if (!widget->parent)
1600 g_object_notify_queue_clear (G_OBJECT (widget), nqueue);
1601 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
1602 g_object_unref (widget);
1606 * gtk_widget_destroy:
1607 * @widget: a #GtkWidget
1609 * Destroys a widget. Equivalent to gtk_object_destroy(), except that
1610 * you don't have to cast the widget to #GtkObject. When a widget is
1611 * destroyed, it will break any references it holds to other objects.
1612 * If the widget is inside a container, the widget will be removed
1613 * from the container. If the widget is a toplevel (derived from
1614 * #GtkWindow), it will be removed from the list of toplevels, and the
1615 * reference GTK+ holds to it will be removed. Removing a
1616 * widget from its container or the list of toplevels results in the
1617 * widget being finalized, unless you've added additional references
1618 * to the widget with g_object_ref().
1620 * In most cases, only toplevel widgets (windows) require explicit
1621 * destruction, because when you destroy a toplevel its children will
1622 * be destroyed as well.
1626 gtk_widget_destroy (GtkWidget *widget)
1628 g_return_if_fail (GTK_IS_WIDGET (widget));
1630 gtk_object_destroy ((GtkObject*) widget);
1634 * gtk_widget_destroyed:
1635 * @widget: a #GtkWidget
1636 * @widget_pointer: address of a variable that contains @widget
1638 * This function sets *@widget_pointer to %NULL if @widget_pointer !=
1639 * %NULL. It's intended to be used as a callback connected to the
1640 * "destroy" signal of a widget. You connect gtk_widget_destroyed()
1641 * as a signal handler, and pass the address of your widget variable
1642 * as user data. Then when the widget is destroyed, the variable will
1643 * be set to %NULL. Useful for example to avoid multiple copies
1644 * of the same dialog.
1648 gtk_widget_destroyed (GtkWidget *widget,
1649 GtkWidget **widget_pointer)
1651 /* Don't make any assumptions about the
1653 * Even check widget_pointer.
1656 *widget_pointer = NULL;
1661 * @widget: a #GtkWidget
1663 * Flags a widget to be displayed. Any widget that isn't shown will
1664 * not appear on the screen. If you want to show all the widgets in a
1665 * container, it's easier to call gtk_widget_show_all() on the
1666 * container, instead of individually showing the widgets.
1668 * Remember that you have to show the containers containing a widget,
1669 * in addition to the widget itself, before it will appear onscreen.
1671 * When a toplevel container is shown, it is immediately realized and
1672 * mapped; other shown widgets are realized and mapped when their
1673 * toplevel container is realized and mapped.
1677 gtk_widget_show (GtkWidget *widget)
1679 g_return_if_fail (GTK_IS_WIDGET (widget));
1681 if (!GTK_WIDGET_VISIBLE (widget))
1683 g_object_ref (widget);
1684 if (!GTK_WIDGET_TOPLEVEL (widget))
1685 gtk_widget_queue_resize (widget);
1686 g_signal_emit (widget, widget_signals[SHOW], 0);
1687 g_object_notify (G_OBJECT (widget), "visible");
1688 g_object_unref (widget);
1693 gtk_widget_real_show (GtkWidget *widget)
1695 if (!GTK_WIDGET_VISIBLE (widget))
1697 GTK_WIDGET_SET_FLAGS (widget, GTK_VISIBLE);
1699 if (widget->parent &&
1700 GTK_WIDGET_MAPPED (widget->parent) &&
1701 GTK_WIDGET_CHILD_VISIBLE (widget) &&
1702 !GTK_WIDGET_MAPPED (widget))
1703 gtk_widget_map (widget);
1708 gtk_widget_show_map_callback (GtkWidget *widget, GdkEvent *event, gint *flag)
1711 g_signal_handlers_disconnect_by_func (widget,
1712 gtk_widget_show_map_callback,
1717 * gtk_widget_show_now:
1718 * @widget: a #GtkWidget
1720 * Shows a widget. If the widget is an unmapped toplevel widget
1721 * (i.e. a #GtkWindow that has not yet been shown), enter the main
1722 * loop and wait for the window to actually be mapped. Be careful;
1723 * because the main loop is running, anything can happen during
1727 gtk_widget_show_now (GtkWidget *widget)
1731 g_return_if_fail (GTK_IS_WIDGET (widget));
1733 /* make sure we will get event */
1734 if (!GTK_WIDGET_MAPPED (widget) &&
1735 GTK_WIDGET_TOPLEVEL (widget))
1737 gtk_widget_show (widget);
1739 g_signal_connect (widget, "map_event",
1740 G_CALLBACK (gtk_widget_show_map_callback),
1744 gtk_main_iteration ();
1747 gtk_widget_show (widget);
1752 * @widget: a #GtkWidget
1754 * Reverses the effects of gtk_widget_show(), causing the widget to be
1755 * hidden (invisible to the user).
1758 gtk_widget_hide (GtkWidget *widget)
1760 g_return_if_fail (GTK_IS_WIDGET (widget));
1762 if (GTK_WIDGET_VISIBLE (widget))
1764 g_object_ref (widget);
1765 g_signal_emit (widget, widget_signals[HIDE], 0);
1766 if (!GTK_WIDGET_TOPLEVEL (widget))
1767 gtk_widget_queue_resize (widget);
1768 g_object_notify (G_OBJECT (widget), "visible");
1769 g_object_unref (widget);
1774 gtk_widget_real_hide (GtkWidget *widget)
1776 if (GTK_WIDGET_VISIBLE (widget))
1778 GTK_WIDGET_UNSET_FLAGS (widget, GTK_VISIBLE);
1780 if (GTK_WIDGET_MAPPED (widget))
1781 gtk_widget_unmap (widget);
1786 * gtk_widget_hide_on_delete:
1787 * @widget: a #GtkWidget
1789 * Utility function; intended to be connected to the "delete_event"
1790 * signal on a #GtkWindow. The function calls gtk_widget_hide() on its
1791 * argument, then returns %TRUE. If connected to "delete_event", the
1792 * result is that clicking the close button for a window (on the
1793 * window frame, top right corner usually) will hide but not destroy
1794 * the window. By default, GTK+ destroys windows when "delete_event"
1797 * Return value: %TRUE
1800 gtk_widget_hide_on_delete (GtkWidget *widget)
1802 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
1804 gtk_widget_hide (widget);
1810 * gtk_widget_show_all:
1811 * @widget: a #GtkWidget
1813 * Recursively shows a widget, and any child widgets (if the widget is
1817 gtk_widget_show_all (GtkWidget *widget)
1819 GtkWidgetClass *class;
1821 g_return_if_fail (GTK_IS_WIDGET (widget));
1823 class = GTK_WIDGET_GET_CLASS (widget);
1825 if (class->show_all)
1826 class->show_all (widget);
1830 * gtk_widget_hide_all:
1831 * @widget: a #GtkWidget
1833 * Recursively hides a widget and any child widgets.
1836 gtk_widget_hide_all (GtkWidget *widget)
1838 GtkWidgetClass *class;
1840 g_return_if_fail (GTK_IS_WIDGET (widget));
1842 class = GTK_WIDGET_GET_CLASS (widget);
1844 if (class->hide_all)
1845 class->hide_all (widget);
1850 * @widget: a #GtkWidget
1852 * This function is only for use in widget implementations. Causes
1853 * a widget to be mapped if it isn't already.
1857 gtk_widget_map (GtkWidget *widget)
1859 g_return_if_fail (GTK_IS_WIDGET (widget));
1860 g_return_if_fail (GTK_WIDGET_VISIBLE (widget));
1861 g_return_if_fail (GTK_WIDGET_CHILD_VISIBLE (widget));
1863 if (!GTK_WIDGET_MAPPED (widget))
1865 if (!GTK_WIDGET_REALIZED (widget))
1866 gtk_widget_realize (widget);
1868 g_signal_emit (widget, widget_signals[MAP], 0);
1870 if (GTK_WIDGET_NO_WINDOW (widget))
1871 gdk_window_invalidate_rect (widget->window, &widget->allocation, FALSE);
1877 * @widget: a #GtkWidget
1879 * This function is only for use in widget implementations. Causes
1880 * a widget to be unmapped if it's currently mapped.
1884 gtk_widget_unmap (GtkWidget *widget)
1886 g_return_if_fail (GTK_IS_WIDGET (widget));
1888 if (GTK_WIDGET_MAPPED (widget))
1890 if (GTK_WIDGET_NO_WINDOW (widget))
1891 gdk_window_invalidate_rect (widget->window, &widget->allocation, FALSE);
1892 g_signal_emit (widget, widget_signals[UNMAP], 0);
1897 * gtk_widget_realize:
1898 * @widget: a #GtkWidget
1900 * Creates the GDK (windowing system) resources associated with a
1901 * widget. For example, @widget->window will be created when a widget
1902 * is realized. Normally realization happens implicitly; if you show
1903 * a widget and all its parent containers, then the widget will be
1904 * realized and mapped automatically.
1906 * Realizing a widget requires all
1907 * the widget's parent widgets to be realized; calling
1908 * gtk_widget_realize() realizes the widget's parents in addition to
1909 * @widget itself. If a widget is not yet inside a toplevel window
1910 * when you realize it, bad things will happen.
1912 * This function is primarily used in widget implementations, and
1913 * isn't very useful otherwise. Many times when you think you might
1914 * need it, a better approach is to connect to a signal that will be
1915 * called after the widget is realized automatically, such as
1916 * "expose_event". Or simply g_signal_connect_after() to the
1921 gtk_widget_realize (GtkWidget *widget)
1924 GdkExtensionMode mode;
1925 GtkWidgetShapeInfo *shape_info;
1927 g_return_if_fail (GTK_IS_WIDGET (widget));
1929 if (!GTK_WIDGET_REALIZED (widget))
1932 if (GTK_IS_CONTAINER (widget) && !GTK_WIDGET_NO_WINDOW (widget))
1933 g_message ("gtk_widget_realize(%s)", g_type_name (GTK_WIDGET_TYPE (widget)));
1936 if (widget->parent == NULL &&
1937 !GTK_WIDGET_TOPLEVEL (widget))
1938 g_warning ("Calling gtk_widget_realize() on a widget that isn't "
1939 "inside a toplevel window is not going to work very well. "
1940 "Widgets must be inside a toplevel container before realizing them.");
1942 if (widget->parent && !GTK_WIDGET_REALIZED (widget->parent))
1943 gtk_widget_realize (widget->parent);
1945 gtk_widget_ensure_style (widget);
1947 g_signal_emit (widget, widget_signals[REALIZE], 0);
1949 if (GTK_WIDGET_HAS_SHAPE_MASK (widget))
1951 shape_info = g_object_get_qdata (G_OBJECT (widget), quark_shape_info);
1952 gdk_window_shape_combine_mask (widget->window,
1953 shape_info->shape_mask,
1954 shape_info->offset_x,
1955 shape_info->offset_y);
1958 if (!GTK_WIDGET_NO_WINDOW (widget))
1960 mode = gtk_widget_get_extension_events (widget);
1961 if (mode != GDK_EXTENSION_EVENTS_NONE)
1963 events = gtk_widget_get_events (widget);
1964 gdk_input_set_extension_events (widget->window, events, mode);
1972 * gtk_widget_unrealize:
1973 * @widget: a #GtkWidget
1975 * This function is only useful in widget implementations.
1976 * Causes a widget to be unrealized (frees all GDK resources
1977 * associated with the widget, such as @widget->window).
1981 gtk_widget_unrealize (GtkWidget *widget)
1983 g_return_if_fail (GTK_IS_WIDGET (widget));
1985 if (GTK_WIDGET_HAS_SHAPE_MASK (widget))
1986 gtk_widget_shape_combine_mask (widget, NULL, -1, -1);
1988 if (GTK_WIDGET_REALIZED (widget))
1990 g_object_ref (widget);
1991 g_signal_emit (widget, widget_signals[UNREALIZE], 0);
1992 GTK_WIDGET_UNSET_FLAGS (widget, GTK_REALIZED | GTK_MAPPED);
1993 g_object_unref (widget);
1997 /*****************************************
1999 *****************************************/
2002 * gtk_widget_queue_draw_area:
2003 * @widget: a #GtkWidget
2004 * @x: x coordinate of upper-left corner of rectangle to redraw
2005 * @y: y coordinate of upper-left corner of rectangle to redraw
2006 * @width: width of region to draw
2007 * @height: height of region to draw
2009 * Invalidates the rectangular area of @widget defined by @x, @y,
2010 * @width and @height by calling gdk_window_invalidate_rect() on the
2011 * widget's window and all its child windows. Once the main loop
2012 * becomes idle (after the current batch of events has been processed,
2013 * roughly), the window will receive expose events for the union of
2014 * all regions that have been invalidated.
2016 * Normally you would only use this function in widget
2017 * implementations. You might also use it, or
2018 * gdk_window_invalidate_rect() directly, to schedule a redraw of a
2019 * #GtkDrawingArea or some portion thereof.
2021 * Frequently you can just call gdk_window_invalidate_rect() or
2022 * gdk_window_invalidate_region() instead of this function. Those
2023 * functions will invalidate only a single window, instead of the
2024 * widget and all its children.
2026 * The advantage of adding to the invalidated region compared to
2027 * simply drawing immediately is efficiency; using an invalid region
2028 * ensures that you only have to redraw one time.
2032 gtk_widget_queue_draw_area (GtkWidget *widget,
2038 g_return_if_fail (GTK_IS_WIDGET (widget));
2040 gtk_widget_queue_clear_area (widget, x, y, width, height);
2044 * gtk_widget_queue_draw:
2045 * @widget: a #GtkWidget
2047 * Equivalent to calling gtk_widget_queue_draw_area() for the
2048 * entire area of a widget.
2052 gtk_widget_queue_draw (GtkWidget *widget)
2054 g_return_if_fail (GTK_IS_WIDGET (widget));
2056 gtk_widget_queue_clear (widget);
2059 /* Invalidates the given area (allocation-relative-coordinates)
2060 * in all of the widget's windows
2063 * gtk_widget_queue_clear_area:
2064 * @widget: a #GtkWidget
2065 * @x: x coordinate of upper-left corner of rectangle to redraw
2066 * @y: y coordinate of upper-left corner of rectangle to redraw
2067 * @width: width of region to draw
2068 * @height: height of region to draw
2070 * DEPRECATED. This function is no longer different from
2071 * gtk_widget_queue_draw_area(), though it once was. Now it just calls
2072 * gtk_widget_queue_draw_area(). Originally
2073 * gtk_widget_queue_clear_area() would force a redraw of the
2074 * background for %GTK_NO_WINDOW widgets, and
2075 * gtk_widget_queue_draw_area() would not. Now both functions ensure
2076 * the background will be redrawn.
2080 gtk_widget_queue_clear_area (GtkWidget *widget,
2086 GdkRectangle invalid_rect;
2089 g_return_if_fail (GTK_IS_WIDGET (widget));
2091 if (!GTK_WIDGET_REALIZED (widget))
2094 /* Just return if the widget or one of its ancestors isn't mapped */
2095 for (w = widget; w != NULL; w = w->parent)
2096 if (!GTK_WIDGET_MAPPED (w))
2099 /* Find the correct widget */
2101 if (!GTK_WIDGET_NO_WINDOW (widget))
2105 /* Translate widget relative to window-relative */
2107 gint wx, wy, wwidth, wheight;
2109 gdk_window_get_position (widget->window, &wx, &wy);
2110 x -= wx - widget->allocation.x;
2111 y -= wy - widget->allocation.y;
2113 gdk_drawable_get_size (widget->window, &wwidth, &wheight);
2115 if (x + width <= 0 || y + height <= 0 ||
2116 x >= wwidth || y >= wheight)
2127 if (x + width > wwidth)
2129 if (y + height > wheight)
2130 height = wheight - y;
2136 invalid_rect.width = width;
2137 invalid_rect.height = height;
2139 gdk_window_invalidate_rect (widget->window, &invalid_rect, TRUE);
2143 * gtk_widget_queue_clear:
2144 * @widget: a #GtkWidget
2146 * DEPRECATED. Use gtk_widget_queue_draw() instead.
2149 gtk_widget_queue_clear (GtkWidget *widget)
2151 g_return_if_fail (GTK_IS_WIDGET (widget));
2153 if (widget->allocation.width || widget->allocation.height)
2155 if (GTK_WIDGET_NO_WINDOW (widget))
2156 gtk_widget_queue_clear_area (widget, widget->allocation.x,
2157 widget->allocation.y,
2158 widget->allocation.width,
2159 widget->allocation.height);
2161 gtk_widget_queue_clear_area (widget, 0, 0,
2162 widget->allocation.width,
2163 widget->allocation.height);
2168 * gtk_widget_queue_resize:
2169 * @widget: a #GtkWidget
2171 * This function is only for use in widget implementations.
2172 * Flags a widget to have its size renegotiated; should
2173 * be called when a widget for some reason has a new size request.
2174 * For example, when you change the text in a #GtkLabel, #GtkLabel
2175 * queues a resize to ensure there's enough space for the new text.
2179 gtk_widget_queue_resize (GtkWidget *widget)
2183 g_return_if_fail (GTK_IS_WIDGET (widget));
2185 if (GTK_WIDGET_REALIZED (widget))
2187 region = gdk_region_rectangle (&widget->allocation);
2188 gtk_widget_invalidate_widget_windows (widget, region);
2189 gdk_region_destroy (region);
2192 _gtk_size_group_queue_resize (widget);
2197 * @widget: a #GtkWidget
2198 * @area: area to draw
2200 * DEPRECATED. In GTK+ 1.2, this function would immediately render the
2201 * region @area of a widget, by invoking the virtual draw method of a
2202 * widget. In GTK+ 2.0, the draw method is gone, and instead
2203 * gtk_widget_draw() simply invalidates the specified region of the
2204 * widget, then updates the invalid region of the widget immediately.
2205 * Usually you don't want to update the region immediately for
2206 * performance reasons, so in general gtk_widget_queue_draw_area() is
2207 * a better choice if you want to draw a region of a widget.
2211 gtk_widget_draw (GtkWidget *widget,
2214 g_return_if_fail (GTK_IS_WIDGET (widget));
2216 if (GTK_WIDGET_DRAWABLE (widget))
2219 gtk_widget_queue_draw_area (widget,
2221 area->width, area->height);
2223 gtk_widget_queue_draw (widget);
2225 gdk_window_process_updates (widget->window, TRUE);
2230 * gtk_widget_size_request:
2231 * @widget: a #GtkWidget
2232 * @requisition: a #GtkRequisition to be filled in
2234 * This function is typically used when implementing a #GtkContainer
2235 * subclass. Obtains the preferred size of a widget. The container
2236 * uses this information to arrange its child widgets and decide what
2237 * size allocations to give them with gtk_widget_size_allocate().
2239 * You can also call this function from an application, with some
2240 * caveats. Most notably, getting a size request requires the widget
2241 * to be associated with a screen, because font information may be
2242 * needed. Multihead-aware applications should keep this in mind.
2244 * Also remember that the size request is not necessarily the size
2245 * a widget will actually be allocated.
2247 * See also gtk_widget_get_child_requisition().
2250 gtk_widget_size_request (GtkWidget *widget,
2251 GtkRequisition *requisition)
2253 g_return_if_fail (GTK_IS_WIDGET (widget));
2255 #ifdef G_ENABLE_DEBUG
2256 if (requisition == &widget->requisition)
2257 g_warning ("gtk_widget_size_request() called on child widget with request equal\n to widget->requisition. gtk_widget_set_usize() may not work properly.");
2258 #endif /* G_ENABLE_DEBUG */
2260 _gtk_size_group_compute_requisition (widget, requisition);
2264 * gtk_widget_get_child_requisition:
2265 * @widget: a #GtkWidget
2266 * @requisition: a #GtkRequisition to be filled in
2268 * This function is only for use in widget implementations. Obtains
2269 * @widget->requisition, unless someone has forced a particular
2270 * geometry on the widget (e.g. with gtk_widget_set_usize()), in which
2271 * case it returns that geometry instead of the widget's requisition.
2273 * This function differs from gtk_widget_size_request() in that
2274 * it retrieves the last size request value from @widget->requisition,
2275 * while gtk_widget_size_request() actually calls the "size_request" method
2276 * on @widget to compute the size request and fill in @widget->requisition,
2277 * and only then returns @widget->requisition.
2279 * Because this function does not call the "size_request" method, it
2280 * can only be used when you know that @widget->requisition is
2281 * up-to-date, that is, gtk_widget_size_request() has been called
2282 * since the last time a resize was queued. In general, only container
2283 * implementations have this information; applications should use
2284 * gtk_widget_size_request().
2287 gtk_widget_get_child_requisition (GtkWidget *widget,
2288 GtkRequisition *requisition)
2290 _gtk_size_group_get_child_requisition (widget, requisition);
2294 invalidate_predicate (GdkWindow *window,
2299 gdk_window_get_user_data (window, &user_data);
2301 return (user_data == data);
2304 /* Invalidate @region in widget->window and all children
2305 * of widget->window owned by widget. @region is in the
2306 * same coordinates as widget->allocation and will be
2307 * modified by this call.
2310 gtk_widget_invalidate_widget_windows (GtkWidget *widget,
2313 if (!GTK_WIDGET_NO_WINDOW (widget))
2317 gdk_window_get_position (widget->window, &x, &y);
2318 gdk_region_offset (region, -x, -y);
2321 gdk_window_invalidate_maybe_recurse (widget->window, region,
2322 invalidate_predicate, widget);
2326 * gtk_widget_size_allocate:
2327 * @widget: a #GtkWidget
2328 * @allocation: position and size to be allocated to @widget
2330 * This function is only used by #GtkContainer subclasses, to assign a size
2331 * and position to their child widgets.
2335 gtk_widget_size_allocate (GtkWidget *widget,
2336 GtkAllocation *allocation)
2338 GtkWidgetAuxInfo *aux_info;
2339 GdkRectangle real_allocation;
2340 GdkRectangle old_allocation;
2341 gboolean alloc_needed;
2342 gboolean size_changed;
2343 gboolean position_changed;
2345 g_return_if_fail (GTK_IS_WIDGET (widget));
2347 alloc_needed = GTK_WIDGET_ALLOC_NEEDED (widget);
2348 GTK_PRIVATE_UNSET_FLAG (widget, GTK_ALLOC_NEEDED);
2350 old_allocation = widget->allocation;
2351 real_allocation = *allocation;
2352 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
2356 if (aux_info->x_set)
2357 real_allocation.x = aux_info->x;
2358 if (aux_info->y_set)
2359 real_allocation.y = aux_info->y;
2362 if (real_allocation.width < 0 || real_allocation.height < 0)
2364 g_warning ("gtk_widget_size_allocate(): attempt to allocate widget with width %d and height %d",
2365 real_allocation.width,
2366 real_allocation.height);
2369 real_allocation.width = MAX (real_allocation.width, 1);
2370 real_allocation.height = MAX (real_allocation.height, 1);
2372 size_changed = (old_allocation.width != real_allocation.width ||
2373 old_allocation.height != real_allocation.height);
2374 position_changed = (old_allocation.x != real_allocation.x ||
2375 old_allocation.y != real_allocation.y);
2377 if (!alloc_needed && !size_changed && !position_changed)
2380 g_signal_emit (widget, widget_signals[SIZE_ALLOCATE], 0, &real_allocation);
2382 if (GTK_WIDGET_MAPPED (widget))
2384 if (GTK_WIDGET_NO_WINDOW (widget) && GTK_WIDGET_REDRAW_ON_ALLOC (widget) && position_changed)
2386 /* Invalidate union(old_allaction,widget->allocation) in widget->window
2388 GdkRegion *invalidate = gdk_region_rectangle (&widget->allocation);
2389 gdk_region_union_with_rect (invalidate, &old_allocation);
2391 gdk_window_invalidate_region (widget->window, invalidate, FALSE);
2392 gdk_region_destroy (invalidate);
2397 if (GTK_WIDGET_REDRAW_ON_ALLOC (widget))
2399 /* Invalidate union(old_allaction,widget->allocation) in widget->window and descendents owned by widget
2401 GdkRegion *invalidate = gdk_region_rectangle (&widget->allocation);
2402 gdk_region_union_with_rect (invalidate, &old_allocation);
2404 gtk_widget_invalidate_widget_windows (widget, invalidate);
2405 gdk_region_destroy (invalidate);
2410 if ((size_changed || position_changed) && widget->parent &&
2411 GTK_WIDGET_REALIZED (widget->parent) && GTK_CONTAINER (widget->parent)->reallocate_redraws)
2413 GdkRegion *invalidate = gdk_region_rectangle (&widget->parent->allocation);
2414 gtk_widget_invalidate_widget_windows (widget->parent, invalidate);
2415 gdk_region_destroy (invalidate);
2420 * gtk_widget_common_ancestor:
2421 * @widget_a: a #GtkWidget
2422 * @widget_b: a #GtkWidget
2424 * Find the common ancestor of @widget_a and @widget_b that
2425 * is closest to the two widgets.
2427 * Return value: the closest common ancestor of @widget_a and
2428 * @widget_b or %NULL if @widget_a and @widget_b do not
2429 * share a common ancestor.
2432 gtk_widget_common_ancestor (GtkWidget *widget_a,
2433 GtkWidget *widget_b)
2435 GtkWidget *parent_a;
2436 GtkWidget *parent_b;
2440 parent_a = widget_a;
2441 while (parent_a->parent)
2443 parent_a = parent_a->parent;
2447 parent_b = widget_b;
2448 while (parent_b->parent)
2450 parent_b = parent_b->parent;
2454 if (parent_a != parent_b)
2457 while (depth_a > depth_b)
2459 widget_a = widget_a->parent;
2463 while (depth_b > depth_a)
2465 widget_b = widget_b->parent;
2469 while (widget_a != widget_b)
2471 widget_a = widget_a->parent;
2472 widget_b = widget_b->parent;
2479 * gtk_widget_translate_coordinates:
2480 * @src_widget: a #GtkWidget
2481 * @dest_widget: a #GtkWidget
2482 * @src_x: X position relative to @src_widget
2483 * @src_y: Y position relative to @src_widget
2484 * @dest_x: location to store X position relative to @dest_widget
2485 * @dest_y: location to store Y position relative to @dest_widget
2487 * Translate coordinates relative to @src_widget's allocation to coordinates
2488 * relative to @dest_widget's allocations. In order to perform this
2489 * operation, both widgets must be realized, and must share a common
2492 * Return value: %FALSE if either widget was not realized, or there
2493 * was no common ancestor. In this case, nothing is stored in
2494 * *@dest_x and *@dest_y. Otherwise %TRUE.
2497 gtk_widget_translate_coordinates (GtkWidget *src_widget,
2498 GtkWidget *dest_widget,
2504 GtkWidget *ancestor;
2507 g_return_val_if_fail (GTK_IS_WIDGET (src_widget), FALSE);
2508 g_return_val_if_fail (GTK_IS_WIDGET (dest_widget), FALSE);
2510 ancestor = gtk_widget_common_ancestor (src_widget, dest_widget);
2511 if (!ancestor || !GTK_WIDGET_REALIZED (src_widget) || !GTK_WIDGET_REALIZED (dest_widget))
2514 /* Translate from allocation relative to window relative */
2515 if (!GTK_WIDGET_NO_WINDOW (src_widget) && src_widget->parent)
2518 gdk_window_get_position (src_widget->window, &wx, &wy);
2520 src_x -= wx - src_widget->allocation.x;
2521 src_y -= wy - src_widget->allocation.y;
2525 src_x += src_widget->allocation.x;
2526 src_y += src_widget->allocation.y;
2529 /* Translate to the common ancestor */
2530 window = src_widget->window;
2531 while (window != ancestor->window)
2535 gdk_window_get_position (window, &dx, &dy);
2540 window = gdk_window_get_parent (window);
2542 if (!window) /* Handle GtkHandleBox */
2547 window = dest_widget->window;
2548 while (window != ancestor->window)
2552 gdk_window_get_position (window, &dx, &dy);
2557 window = gdk_window_get_parent (window);
2559 if (!window) /* Handle GtkHandleBox */
2563 /* Translate from window relative to allocation relative */
2564 if (!GTK_WIDGET_NO_WINDOW (dest_widget) && dest_widget->parent)
2567 gdk_window_get_position (dest_widget->window, &wx, &wy);
2569 src_x += wx - dest_widget->allocation.x;
2570 src_y += wy - dest_widget->allocation.y;
2574 src_x -= dest_widget->allocation.x;
2575 src_y -= dest_widget->allocation.y;
2587 gtk_widget_real_size_allocate (GtkWidget *widget,
2588 GtkAllocation *allocation)
2590 widget->allocation = *allocation;
2592 if (GTK_WIDGET_REALIZED (widget) &&
2593 !GTK_WIDGET_NO_WINDOW (widget))
2595 gdk_window_move_resize (widget->window,
2596 allocation->x, allocation->y,
2597 allocation->width, allocation->height);
2607 closure_accel_activate (GClosure *closure,
2608 GValue *return_value,
2609 guint n_param_values,
2610 const GValue *param_values,
2611 gpointer invocation_hint,
2612 gpointer marshal_data)
2614 AccelClosure *aclosure = (AccelClosure*) closure;
2616 if (GTK_WIDGET_IS_SENSITIVE (closure->data))
2617 g_signal_emit (closure->data, aclosure->signal_id, 0);
2619 /* we handled the accelerator */
2620 g_value_set_boolean (return_value, TRUE);
2624 closures_destroy (gpointer data)
2626 GSList *slist, *closures = data;
2628 for (slist = closures; slist; slist = slist->next)
2630 g_closure_invalidate (slist->data);
2631 g_closure_unref (slist->data);
2633 g_slist_free (closures);
2637 widget_new_accel_closure (GtkWidget *widget,
2640 AccelClosure *aclosure;
2641 GClosure *closure = NULL;
2642 GSList *slist, *closures;
2644 closures = g_object_steal_qdata (G_OBJECT (widget), quark_accel_closures);
2645 for (slist = closures; slist; slist = slist->next)
2646 if (!gtk_accel_group_from_accel_closure (slist->data))
2648 /* reuse this closure */
2649 closure = slist->data;
2654 closure = g_closure_new_object (sizeof (AccelClosure), G_OBJECT (widget));
2655 closures = g_slist_prepend (closures, g_closure_ref (closure));
2656 g_closure_sink (closure);
2657 g_closure_set_marshal (closure, closure_accel_activate);
2659 g_object_set_qdata_full (G_OBJECT (widget), quark_accel_closures, closures, closures_destroy);
2661 aclosure = (AccelClosure*) closure;
2662 g_assert (closure->data == widget);
2663 g_assert (closure->marshal == closure_accel_activate);
2664 aclosure->signal_id = signal_id;
2670 * gtk_widget_add_accelerator
2671 * @widget: widget to install an accelerator on
2672 * @accel_signal: widget signal to emit on accelerator activation
2673 * @accel_group: accel group for this widget, added to its toplevel
2674 * @accel_key: GDK keyval of the accelerator
2675 * @accel_mods: modifier key combination of the accelerator
2676 * @accel_flags: flag accelerators, e.g. %GTK_ACCEL_VISIBLE
2678 * Installs an accelerator for this @widget in @accel_group that causes
2679 * @accel_signal to be emitted if the accelerator is activated.
2680 * The @accel_group needs to be added to the widget's toplevel via
2681 * gtk_window_add_accel_group(), and the signal must be of type %G_RUN_ACTION.
2682 * Accelerators added through this function are not user changeable during
2683 * runtime. If you want to support accelerators that can be changed by the
2684 * user, use gtk_accel_map_add_entry() and gtk_widget_set_accel_path() or
2685 * gtk_menu_item_set_accel_path() instead.
2688 gtk_widget_add_accelerator (GtkWidget *widget,
2689 const gchar *accel_signal,
2690 GtkAccelGroup *accel_group,
2692 GdkModifierType accel_mods,
2693 GtkAccelFlags accel_flags)
2698 g_return_if_fail (GTK_IS_WIDGET (widget));
2699 g_return_if_fail (accel_signal != NULL);
2700 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
2702 g_signal_query (g_signal_lookup (accel_signal, G_OBJECT_TYPE (widget)), &query);
2703 if (!query.signal_id ||
2704 !(query.signal_flags & G_SIGNAL_ACTION) ||
2705 query.return_type != G_TYPE_NONE ||
2708 /* hmm, should be elaborate enough */
2709 g_warning (G_STRLOC ": widget `%s' has no activatable signal \"%s\" without arguments",
2710 G_OBJECT_TYPE_NAME (widget), accel_signal);
2714 closure = widget_new_accel_closure (widget, query.signal_id);
2716 g_object_ref (widget);
2718 /* install the accelerator. since we don't map this onto an accel_path,
2719 * the accelerator will automatically be locked.
2721 gtk_accel_group_connect (accel_group,
2724 accel_flags | GTK_ACCEL_LOCKED,
2727 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
2729 g_object_unref (widget);
2733 * gtk_widget_remove_accelerator:
2734 * @widget: widget to install an accelerator on
2735 * @accel_group: accel group for this widget
2736 * @accel_key: GDK keyval of the accelerator
2737 * @accel_mods: modifier key combination of the accelerator
2738 * @returns: whether an accelerator was installed and could be removed
2740 * Removes an accelerator from @widget, previously installed with
2741 * gtk_widget_add_accelerator().
2744 gtk_widget_remove_accelerator (GtkWidget *widget,
2745 GtkAccelGroup *accel_group,
2747 GdkModifierType accel_mods)
2749 GtkAccelGroupEntry *ag_entry;
2750 GList *slist, *clist;
2753 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
2754 g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE);
2756 ag_entry = gtk_accel_group_query (accel_group, accel_key, accel_mods, &n);
2757 clist = gtk_widget_list_accel_closures (widget);
2758 for (slist = clist; slist; slist = slist->next)
2762 for (i = 0; i < n; i++)
2763 if (slist->data == (gpointer) ag_entry[i].closure)
2765 gboolean is_removed = gtk_accel_group_disconnect (accel_group, slist->data);
2767 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
2769 g_list_free (clist);
2774 g_list_free (clist);
2776 g_warning (G_STRLOC ": no accelerator (%u,%u) installed in accel group (%p) for %s (%p)",
2777 accel_key, accel_mods, accel_group,
2778 G_OBJECT_TYPE_NAME (widget), widget);
2784 * gtk_widget_list_accel_closures
2785 * @widget: widget to list accelerator closures for
2786 * @returns: a newly allocated #GList of closures
2788 * Lists the closures used by @widget for accelerator group connections
2789 * with gtk_accel_group_connect_by_path() or gtk_accel_group_connect().
2790 * The closures can be used to monitor accelerator changes on @widget,
2791 * by connecting to the ::accel_changed signal of the #GtkAccelGroup of a
2792 * closure which can be found out with gtk_accel_group_from_accel_closure().
2795 gtk_widget_list_accel_closures (GtkWidget *widget)
2798 GList *clist = NULL;
2800 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
2802 for (slist = g_object_get_qdata (G_OBJECT (widget), quark_accel_closures); slist; slist = slist->next)
2803 if (gtk_accel_group_from_accel_closure (slist->data))
2804 clist = g_list_prepend (clist, slist->data);
2811 GtkAccelGroup *accel_group;
2816 destroy_accel_path (gpointer data)
2818 AccelPath *apath = data;
2820 gtk_accel_group_disconnect (apath->accel_group, apath->closure);
2822 /* closures_destroy takes care of unrefing the closure */
2823 g_object_unref (apath->accel_group);
2830 * gtk_widget_set_accel_path:
2831 * @widget: a #GtkWidget
2832 * @accel_path: path used to look up the the accelerator
2833 * @accel_group: a #GtkAccelGroup.
2835 * Given an accelerator group, @accel_group, and an accelerator path,
2836 * @accel_path, sets up an accelerator in @accel_group so whenever the
2837 * key binding that is defined for @accel_path is pressed, @widget
2838 * will be activated. This removes any accelerators (for any
2839 * accelerator group) installed by previous calls to
2840 * gtk_widget_set_accel_path(). Associating accelerators with
2841 * paths allows them to be modified by the user and the modifications
2842 * to be saved for future use. (See gtk_accel_map_save().)
2844 * This function is a low level function that would most likely
2845 * be used by a menu creation system like #GtkItemFactory. If you
2846 * use #GtkItemFactory, setting up accelerator paths will be done
2849 * Even when you you aren't using #GtkItemFactory, if you only want to
2850 * set up accelerators on menu items gtk_menu_item_set_accel_path()
2851 * provides a somewhat more convenient interface.
2854 gtk_widget_set_accel_path (GtkWidget *widget,
2855 const gchar *accel_path,
2856 GtkAccelGroup *accel_group)
2860 g_return_if_fail (GTK_IS_WIDGET (widget));
2861 g_return_if_fail (GTK_WIDGET_GET_CLASS (widget)->activate_signal != 0);
2865 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
2866 g_return_if_fail (_gtk_accel_path_is_valid (accel_path));
2868 gtk_accel_map_add_entry (accel_path, 0, 0);
2869 apath = g_new (AccelPath, 1);
2870 apath->widget = widget;
2871 apath->accel_group = g_object_ref (accel_group);
2872 apath->path_quark = g_quark_from_string (accel_path);
2873 apath->closure = widget_new_accel_closure (apath->widget, GTK_WIDGET_GET_CLASS (apath->widget)->activate_signal);
2878 /* also removes possible old settings */
2879 g_object_set_qdata_full (G_OBJECT (widget), quark_accel_path, apath, destroy_accel_path);
2882 gtk_accel_group_connect_by_path (apath->accel_group, g_quark_to_string (apath->path_quark), apath->closure);
2884 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
2888 _gtk_widget_get_accel_path (GtkWidget *widget,
2893 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
2895 apath = g_object_get_qdata (G_OBJECT (widget), quark_accel_path);
2897 *locked = apath ? apath->accel_group->lock_count > 0 : TRUE;
2898 return apath ? g_quark_to_string (apath->path_quark) : NULL;
2902 gtk_widget_mnemonic_activate (GtkWidget *widget,
2903 gboolean group_cycling)
2907 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
2909 group_cycling = group_cycling != FALSE;
2910 if (!GTK_WIDGET_IS_SENSITIVE (widget))
2913 g_signal_emit (widget,
2914 widget_signals[MNEMONIC_ACTIVATE],
2922 gtk_widget_real_mnemonic_activate (GtkWidget *widget,
2923 gboolean group_cycling)
2925 if (!group_cycling && GTK_WIDGET_GET_CLASS (widget)->activate_signal)
2926 gtk_widget_activate (widget);
2927 else if (GTK_WIDGET_CAN_FOCUS (widget))
2928 gtk_widget_grab_focus (widget);
2931 g_warning ("widget `%s' isn't suitable for mnemonic activation",
2932 G_OBJECT_TYPE_NAME (widget));
2933 gdk_display_beep (gtk_widget_get_display (widget));
2939 gtk_widget_real_key_press_event (GtkWidget *widget,
2942 return _gtk_bindings_activate_event (GTK_OBJECT (widget), event);
2946 gtk_widget_real_key_release_event (GtkWidget *widget,
2949 return _gtk_bindings_activate_event (GTK_OBJECT (widget), event);
2953 gtk_widget_real_focus_in_event (GtkWidget *widget,
2954 GdkEventFocus *event)
2956 gtk_widget_queue_draw (widget);
2962 gtk_widget_real_focus_out_event (GtkWidget *widget,
2963 GdkEventFocus *event)
2965 gtk_widget_queue_draw (widget);
2970 #define WIDGET_REALIZED_FOR_EVENT(widget, event) \
2971 (event->type == GDK_FOCUS_CHANGE || GTK_WIDGET_REALIZED(widget))
2975 * @widget: a #GtkWidget
2976 * @event: a #GdkEvent
2978 * Rarely-used function. This function is used to emit
2979 * the event signals on a widget (those signals should never
2980 * be emitted without using this function to do so).
2981 * If you want to synthesize an event though, don't use this function;
2982 * instead, use gtk_main_do_event() so the event will behave as if
2983 * it were in the event queue. Don't synthesize expose events; instead,
2984 * use gdk_window_invalidate_rect() to invalidate a region of the
2987 * Return value: return from the event signal emission (%TRUE if the event was handled)
2990 gtk_widget_event (GtkWidget *widget,
2993 g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
2994 g_return_val_if_fail (WIDGET_REALIZED_FOR_EVENT (widget, event), TRUE);
2996 if (event->type == GDK_EXPOSE)
2998 g_warning ("Events of type GDK_EXPOSE cannot be synthesized. To get "
2999 "the same effect, call gdk_window_invalidate_rect/region(), "
3000 "followed by gdk_window_process_updates().");
3004 return gtk_widget_event_internal (widget, event);
3009 * gtk_widget_send_expose:
3010 * @widget: a #GtkWidget
3011 * @event: a expose #GdkEvent
3013 * Very rarely-used function. This function is used to emit
3014 * an expose event signals on a widget. This function is not
3015 * normally used directly. The only time it is used is when
3016 * propagating an expose event to a child %NO_WINDOW widget, and
3017 * that is normally done using gtk_container_propagate_expose().
3019 * If you want to force an area of a window to be redrawn,
3020 * use gdk_window_invalidate_rect() or gdk_window_invalidate_region().
3021 * To cause the redraw to be done immediately, follow that call
3022 * with a call to gdk_window_process_updates().
3024 * Return value: return from the event signal emission (%TRUE if the event was handled)
3027 gtk_widget_send_expose (GtkWidget *widget,
3030 g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
3031 g_return_val_if_fail (GTK_WIDGET_REALIZED (widget), TRUE);
3032 g_return_val_if_fail (event != NULL, TRUE);
3033 g_return_val_if_fail (event->type == GDK_EXPOSE, TRUE);
3035 if (event->type != GDK_EXPOSE)
3038 return gtk_widget_event_internal (widget, event);
3042 gtk_widget_event_internal (GtkWidget *widget,
3045 gboolean return_val = FALSE;
3047 g_object_ref (widget);
3049 g_signal_emit (widget, widget_signals[EVENT], 0, event, &return_val);
3050 return_val |= !WIDGET_REALIZED_FOR_EVENT (widget, event);
3055 switch (event->type)
3060 case GDK_BUTTON_PRESS:
3061 case GDK_2BUTTON_PRESS:
3062 case GDK_3BUTTON_PRESS:
3063 signal_num = BUTTON_PRESS_EVENT;
3066 signal_num = SCROLL_EVENT;
3068 case GDK_BUTTON_RELEASE:
3069 signal_num = BUTTON_RELEASE_EVENT;
3071 case GDK_MOTION_NOTIFY:
3072 signal_num = MOTION_NOTIFY_EVENT;
3075 signal_num = DELETE_EVENT;
3078 signal_num = DESTROY_EVENT;
3081 signal_num = KEY_PRESS_EVENT;
3083 case GDK_KEY_RELEASE:
3084 signal_num = KEY_RELEASE_EVENT;
3086 case GDK_ENTER_NOTIFY:
3087 signal_num = ENTER_NOTIFY_EVENT;
3089 case GDK_LEAVE_NOTIFY:
3090 signal_num = LEAVE_NOTIFY_EVENT;
3092 case GDK_FOCUS_CHANGE:
3093 signal_num = event->focus_change.in ? FOCUS_IN_EVENT : FOCUS_OUT_EVENT;
3096 signal_num = CONFIGURE_EVENT;
3099 signal_num = MAP_EVENT;
3102 signal_num = UNMAP_EVENT;
3104 case GDK_WINDOW_STATE:
3105 signal_num = WINDOW_STATE_EVENT;
3107 case GDK_PROPERTY_NOTIFY:
3108 signal_num = PROPERTY_NOTIFY_EVENT;
3110 case GDK_SELECTION_CLEAR:
3111 signal_num = SELECTION_CLEAR_EVENT;
3113 case GDK_SELECTION_REQUEST:
3114 signal_num = SELECTION_REQUEST_EVENT;
3116 case GDK_SELECTION_NOTIFY:
3117 signal_num = SELECTION_NOTIFY_EVENT;
3119 case GDK_PROXIMITY_IN:
3120 signal_num = PROXIMITY_IN_EVENT;
3122 case GDK_PROXIMITY_OUT:
3123 signal_num = PROXIMITY_OUT_EVENT;
3126 signal_num = NO_EXPOSE_EVENT;
3128 case GDK_CLIENT_EVENT:
3129 signal_num = CLIENT_EVENT;
3132 signal_num = EXPOSE_EVENT;
3134 case GDK_VISIBILITY_NOTIFY:
3135 signal_num = VISIBILITY_NOTIFY_EVENT;
3138 g_warning ("gtk_widget_event(): unhandled event type: %d", event->type);
3142 if (signal_num != -1)
3143 g_signal_emit (widget, widget_signals[signal_num], 0, event, &return_val);
3145 if (WIDGET_REALIZED_FOR_EVENT (widget, event))
3146 g_signal_emit (widget, widget_signals[EVENT_AFTER], 0, event);
3150 g_object_unref (widget);
3156 * gtk_widget_activate:
3157 * @widget: a #GtkWidget that's activatable
3159 * For widgets that can be "activated" (buttons, menu items, etc.)
3160 * this function activates them. Activation is what happens when you
3161 * press Enter on a widget during key navigation; clicking a button,
3162 * selecting a menu item, etc. If @widget isn't activatable,
3163 * the function returns %FALSE.
3165 * Return value: %TRUE if the widget was activatable
3168 gtk_widget_activate (GtkWidget *widget)
3170 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
3172 if (WIDGET_CLASS (widget)->activate_signal)
3174 /* FIXME: we should eventually check the signals signature here */
3175 g_signal_emit (widget, WIDGET_CLASS (widget)->activate_signal, 0);
3184 * gtk_widget_set_scroll_adjustments:
3185 * @widget: a #GtkWidget
3186 * @hadjustment: an adjustment for horizontal scrolling, or %NULL
3187 * @vadjustment: an adjustment for vertical scrolling, or %NULL
3189 * For widgets that support scrolling, sets the scroll adjustments and
3190 * returns %TRUE. For widgets that don't support scrolling, does
3191 * nothing and returns %FALSE. Widgets that don't support scrolling
3192 * can be scrolled by placing them in a #GtkViewport, which does
3193 * support scrolling.
3195 * Return value: %TRUE if the widget supports scrolling
3198 gtk_widget_set_scroll_adjustments (GtkWidget *widget,
3199 GtkAdjustment *hadjustment,
3200 GtkAdjustment *vadjustment)
3202 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
3204 g_return_val_if_fail (GTK_IS_ADJUSTMENT (hadjustment), FALSE);
3206 g_return_val_if_fail (GTK_IS_ADJUSTMENT (vadjustment), FALSE);
3208 if (WIDGET_CLASS (widget)->set_scroll_adjustments_signal)
3210 /* FIXME: we should eventually check the signals signature here */
3211 g_signal_emit (widget,
3212 WIDGET_CLASS (widget)->set_scroll_adjustments_signal, 0,
3213 hadjustment, vadjustment);
3221 gtk_widget_reparent_subwindows (GtkWidget *widget,
3222 GdkWindow *new_window)
3224 if (GTK_WIDGET_NO_WINDOW (widget))
3226 GList *children = gdk_window_get_children (widget->window);
3229 for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
3232 GdkWindow *window = tmp_list->data;
3234 gdk_window_get_user_data (window, (void **)&child);
3235 while (child && child != widget)
3236 child = child->parent;
3239 gdk_window_reparent (window, new_window, 0, 0);
3242 g_list_free (children);
3245 gdk_window_reparent (widget->window, new_window, 0, 0);
3249 gtk_widget_reparent_fixup_child (GtkWidget *widget,
3250 gpointer client_data)
3252 g_return_if_fail (client_data != NULL);
3254 if (GTK_WIDGET_NO_WINDOW (widget))
3257 g_object_unref (widget->window);
3258 widget->window = (GdkWindow*) client_data;
3260 g_object_ref (widget->window);
3262 if (GTK_IS_CONTAINER (widget))
3263 gtk_container_forall (GTK_CONTAINER (widget),
3264 gtk_widget_reparent_fixup_child,
3270 * gtk_widget_reparent:
3271 * @widget: a #GtkWidget
3272 * @new_parent: a #GtkContainer to move the widget into
3274 * Moves a widget from one #GtkContainer to another, handling reference
3275 * count issues to avoid destroying the widget.
3279 gtk_widget_reparent (GtkWidget *widget,
3280 GtkWidget *new_parent)
3282 g_return_if_fail (GTK_IS_WIDGET (widget));
3283 g_return_if_fail (GTK_IS_CONTAINER (new_parent));
3284 g_return_if_fail (widget->parent != NULL);
3286 if (widget->parent != new_parent)
3288 /* First try to see if we can get away without unrealizing
3289 * the widget as we reparent it. if so we set a flag so
3290 * that gtk_widget_unparent doesn't unrealize widget
3292 if (GTK_WIDGET_REALIZED (widget) && GTK_WIDGET_REALIZED (new_parent))
3293 GTK_PRIVATE_SET_FLAG (widget, GTK_IN_REPARENT);
3295 g_object_ref (widget);
3296 gtk_container_remove (GTK_CONTAINER (widget->parent), widget);
3297 gtk_container_add (GTK_CONTAINER (new_parent), widget);
3298 g_object_unref (widget);
3300 if (GTK_WIDGET_IN_REPARENT (widget))
3302 GTK_PRIVATE_UNSET_FLAG (widget, GTK_IN_REPARENT);
3304 gtk_widget_reparent_subwindows (widget, gtk_widget_get_parent_window (widget));
3305 gtk_widget_reparent_fixup_child (widget,
3306 gtk_widget_get_parent_window (widget));
3309 g_object_notify (G_OBJECT (widget), "parent");
3314 * gtk_widget_intersect:
3315 * @widget: a #GtkWidget
3316 * @area: a rectangle
3317 * @intersection: rectangle to store intersection of @widget and @area
3319 * Computes the intersection of a @widget's area and @area, storing
3320 * the intersection in @intersection, and returns %TRUE if there was
3321 * an intersection. @intersection may be %NULL if you're only
3322 * interested in whether there was an intersection.
3324 * Return value: %TRUE if there was an intersection
3327 gtk_widget_intersect (GtkWidget *widget,
3329 GdkRectangle *intersection)
3335 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
3336 g_return_val_if_fail (area != NULL, FALSE);
3339 dest = intersection;
3343 return_val = gdk_rectangle_intersect (&widget->allocation, area, dest);
3345 if (return_val && intersection && !GTK_WIDGET_NO_WINDOW (widget))
3347 intersection->x -= widget->allocation.x;
3348 intersection->y -= widget->allocation.y;
3355 * gtk_widget_region_intersect:
3356 * @widget: a #GtkWidget
3357 * @region: a #GdkRegion, in the same coordinate system as
3358 * @widget->allocation. That is, relative to @widget->window
3359 * for %NO_WINDOW widgets; relative to the parent window
3360 * of @widget->window for widgets with their own window.
3361 * @returns: A newly allocated region holding the intersection of @widget
3362 * and @region. The coordinates of the return value are
3363 * relative to @widget->window for %NO_WINDOW widgets, and
3364 * relative to the parent window of @widget->window for
3365 * widgets with their own window.
3367 * Computes the intersection of a @widget's area and @region, returning
3368 * the intersection. The result may be empty, use gdk_region_empty() to
3372 gtk_widget_region_intersect (GtkWidget *widget,
3377 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
3378 g_return_val_if_fail (region != NULL, NULL);
3380 dest = gdk_region_rectangle (&widget->allocation);
3382 gdk_region_intersect (dest, region);
3388 * gtk_widget_grab_focus:
3389 * @widget: a #GtkWidget
3391 * Causes @widget to have the keyboard focus for the #GtkWindow it's
3392 * inside. @widget must be a focusable widget, such as a #GtkEntry;
3393 * something like #GtkFrame won't work. (More precisely, it must have the
3394 * %GTK_CAN_FOCUS flag set.)
3398 gtk_widget_grab_focus (GtkWidget *widget)
3400 g_return_if_fail (GTK_IS_WIDGET (widget));
3402 if (!GTK_WIDGET_IS_SENSITIVE (widget))
3405 g_object_ref (widget);
3406 g_signal_emit (widget, widget_signals[GRAB_FOCUS], 0);
3407 g_object_notify (G_OBJECT (widget), "has_focus");
3408 g_object_unref (widget);
3412 reset_focus_recurse (GtkWidget *widget,
3415 if (GTK_IS_CONTAINER (widget))
3417 GtkContainer *container;
3419 container = GTK_CONTAINER (widget);
3420 gtk_container_set_focus_child (container, NULL);
3422 gtk_container_foreach (container,
3423 reset_focus_recurse,
3429 gtk_widget_real_grab_focus (GtkWidget *focus_widget)
3431 if (GTK_WIDGET_CAN_FOCUS (focus_widget))
3433 GtkWidget *toplevel;
3436 /* clear the current focus setting, break if the current widget
3437 * is the focus widget's parent, since containers above that will
3438 * be set by the next loop.
3440 toplevel = gtk_widget_get_toplevel (focus_widget);
3441 if (GTK_WIDGET_TOPLEVEL (toplevel))
3443 widget = GTK_WINDOW (toplevel)->focus_widget;
3445 if (widget == focus_widget)
3447 /* We call _gtk_window_internal_set_focus() here so that the
3448 * toplevel window can request the focus if necessary.
3449 * This is needed when the toplevel is a GtkPlug
3451 if (!GTK_WIDGET_HAS_FOCUS (widget))
3452 _gtk_window_internal_set_focus (GTK_WINDOW (toplevel), focus_widget);
3459 while (widget->parent && widget->parent != focus_widget->parent)
3461 widget = widget->parent;
3462 gtk_container_set_focus_child (GTK_CONTAINER (widget), NULL);
3466 else if (toplevel != focus_widget)
3468 /* gtk_widget_grab_focus() operates on a tree without window...
3469 * actually, this is very questionable behaviour.
3472 gtk_container_foreach (GTK_CONTAINER (toplevel),
3473 reset_focus_recurse,
3477 /* now propagate the new focus up the widget tree and finally
3478 * set it on the window
3480 widget = focus_widget;
3481 while (widget->parent)
3483 gtk_container_set_focus_child (GTK_CONTAINER (widget->parent), widget);
3484 widget = widget->parent;
3486 if (GTK_IS_WINDOW (widget))
3487 _gtk_window_internal_set_focus (GTK_WINDOW (widget), focus_widget);
3492 gtk_widget_real_show_help (GtkWidget *widget,
3493 GtkWidgetHelpType help_type)
3495 if (help_type == GTK_WIDGET_HELP_TOOLTIP)
3497 _gtk_tooltips_toggle_keyboard_mode (widget);
3505 gtk_widget_real_focus (GtkWidget *widget,
3506 GtkDirectionType direction)
3508 if (!GTK_WIDGET_CAN_FOCUS (widget))
3511 if (!gtk_widget_is_focus (widget))
3513 gtk_widget_grab_focus (widget);
3521 * gtk_widget_is_focus:
3522 * @widget: a #GtkWidget
3524 * Determines if the widget is the focus widget within its
3525 * toplevel. (This does not mean that the %HAS_FOCUS flag is
3526 * necessarily set; %HAS_FOCUS will only be set if the
3527 * toplevel widget additionally has the global input focus.)
3529 * Return value: %TRUE if the widget is the focus widget.
3532 gtk_widget_is_focus (GtkWidget *widget)
3534 GtkWidget *toplevel;
3536 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
3538 toplevel = gtk_widget_get_toplevel (widget);
3540 if (GTK_IS_WINDOW (toplevel))
3541 return widget == GTK_WINDOW (toplevel)->focus_widget;
3547 * gtk_widget_grab_default:
3548 * @widget: a #GtkWidget
3550 * Causes @widget to become the default widget. @widget must have the
3551 * %GTK_CAN_DEFAULT flag set; typically you have to set this flag
3552 * yourself by calling <literal>GTK_WIDGET_SET_FLAGS (@widget,
3553 * GTK_CAN_DEFAULT)</literal>. The default widget is activated when the user
3554 * presses Enter in a window. Default widgets must be activatable,
3555 * that is, gtk_widget_activate() should affect them.
3559 gtk_widget_grab_default (GtkWidget *widget)
3563 g_return_if_fail (GTK_IS_WIDGET (widget));
3564 g_return_if_fail (GTK_WIDGET_CAN_DEFAULT (widget));
3566 window = gtk_widget_get_toplevel (widget);
3568 if (window && GTK_WIDGET_TOPLEVEL (window))
3569 gtk_window_set_default (GTK_WINDOW (window), widget);
3571 g_warning (G_STRLOC ": widget not within a GtkWindow");
3575 * gtk_widget_set_name:
3576 * @widget: a #GtkWidget
3577 * @name: name for the widget
3579 * Widgets can be named, which allows you to refer to them from a
3580 * gtkrc file. You can apply a style to widgets with a particular name
3581 * in the gtkrc file. See the documentation for gtkrc files (on the
3582 * same page as the docs for #GtkRcStyle).
3586 gtk_widget_set_name (GtkWidget *widget,
3589 g_return_if_fail (GTK_IS_WIDGET (widget));
3592 g_free (widget->name);
3593 widget->name = g_strdup (name);
3595 if (GTK_WIDGET_RC_STYLE (widget))
3596 gtk_widget_reset_rc_style (widget);
3598 g_object_notify (G_OBJECT (widget), "name");
3602 * gtk_widget_get_name:
3603 * @widget: a #GtkWidget
3605 * Retrieves the name of a widget. See gtk_widget_set_name() for the
3606 * significance of widget names.
3608 * Return value: name of the widget. This string is owned by GTK+ and
3609 * should not be modified or freed
3611 G_CONST_RETURN gchar*
3612 gtk_widget_get_name (GtkWidget *widget)
3614 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
3617 return widget->name;
3618 return g_type_name (GTK_WIDGET_TYPE (widget));
3622 * gtk_widget_set_state:
3623 * @widget: a #GtkWidget
3624 * @state: new state for @widget
3626 * This function is for use in widget implementations. Sets the state
3627 * of a widget (insensitive, prelighted, etc.) Usually you should set
3628 * the state using wrapper functions such as gtk_widget_set_sensitive().
3632 gtk_widget_set_state (GtkWidget *widget,
3635 g_return_if_fail (GTK_IS_WIDGET (widget));
3637 if (state == GTK_WIDGET_STATE (widget))
3640 if (state == GTK_STATE_INSENSITIVE)
3641 gtk_widget_set_sensitive (widget, FALSE);
3647 data.state_restoration = FALSE;
3648 data.use_forall = FALSE;
3650 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget->parent) != FALSE);
3652 data.parent_sensitive = TRUE;
3654 gtk_widget_propagate_state (widget, &data);
3656 if (GTK_WIDGET_DRAWABLE (widget))
3657 gtk_widget_queue_clear (widget);
3662 gtk_widget_set_app_paintable (GtkWidget *widget,
3663 gboolean app_paintable)
3665 g_return_if_fail (GTK_IS_WIDGET (widget));
3667 app_paintable = (app_paintable != FALSE);
3669 if (GTK_WIDGET_APP_PAINTABLE (widget) != app_paintable)
3672 GTK_WIDGET_SET_FLAGS (widget, GTK_APP_PAINTABLE);
3674 GTK_WIDGET_UNSET_FLAGS (widget, GTK_APP_PAINTABLE);
3676 if (GTK_WIDGET_DRAWABLE (widget))
3677 gtk_widget_queue_clear (widget);
3679 g_object_notify (G_OBJECT (widget), "app_paintable");
3684 * gtk_widget_set_double_buffered:
3685 * @widget: a #GtkWidget
3686 * @double_buffered: %TRUE to double-buffer a widget
3688 * Widgets are double buffered by default; you can use this function
3689 * to turn off the buffering. "Double buffered" simply means that
3690 * gdk_window_begin_paint_region() and gdk_window_end_paint() are called
3691 * automatically around expose events sent to the
3692 * widget. gdk_window_begin_paint() diverts all drawing to a widget's
3693 * window to an offscreen buffer, and gdk_window_end_paint() draws the
3694 * buffer to the screen. The result is that users see the window
3695 * update in one smooth step, and don't see individual graphics
3696 * primitives being rendered.
3698 * In very simple terms, double buffered widgets don't flicker,
3699 * so you would only use this function to turn off double buffering
3700 * if you had special needs and really knew what you were doing.
3704 gtk_widget_set_double_buffered (GtkWidget *widget,
3705 gboolean double_buffered)
3707 g_return_if_fail (GTK_IS_WIDGET (widget));
3709 if (double_buffered)
3710 GTK_WIDGET_SET_FLAGS (widget, GTK_DOUBLE_BUFFERED);
3712 GTK_WIDGET_UNSET_FLAGS (widget, GTK_DOUBLE_BUFFERED);
3716 * gtk_widget_set_redraw_on_allocate:
3717 * @widget: a #GtkWidget
3718 * @redraw_on_allocate: if %TRUE, the entire widget will be redrawn
3719 * when it is allocated to a new size. Otherwise, only the
3720 * new portion of the widget will be redrawn.
3722 * Sets whether a when a widgets size allocation changes, the entire
3723 * widget is queued for drawing. By default, this setting is %TRUE and
3724 * the entire widget is redrawn on every size change. If your widget
3725 * leaves the upper left are unchanged when made bigger, turning this
3726 * setting on will improve performance.
3728 * Note that for %NO_WINDOW widgets setting this flag to %FALSE turns
3729 * off all allocation on resizing: the widget will not even redraw if
3730 * its position changes; this is to allow containers that don't draw
3731 * anything to avoid excess invalidations. If you set this flag on a
3732 * %NO_WINDOW widget that <emphasis>does</emphasis> draw on @widget->window,
3733 * you are responsible for invalidating both the old and new allocation
3734 * of the widget when the widget is moved and responsible for invalidating
3735 * regions newly when the widget increases size.
3738 gtk_widget_set_redraw_on_allocate (GtkWidget *widget,
3739 gboolean redraw_on_allocate)
3741 g_return_if_fail (GTK_IS_WIDGET (widget));
3743 if (redraw_on_allocate)
3744 GTK_PRIVATE_SET_FLAG (widget, GTK_REDRAW_ON_ALLOC);
3746 GTK_PRIVATE_UNSET_FLAG (widget, GTK_REDRAW_ON_ALLOC);
3750 * gtk_widget_set_sensitive:
3751 * @widget: a #GtkWidget
3752 * @sensitive: %TRUE to make the widget sensitive
3754 * Sets the sensitivity of a widget. A widget is sensitive if the user
3755 * can interact with it. Insensitive widgets are "grayed out" and the
3756 * user can't interact with them. Insensitive widgets are known as
3757 * "inactive", "disabled", or "ghosted" in some other toolkits.
3761 gtk_widget_set_sensitive (GtkWidget *widget,
3766 g_return_if_fail (GTK_IS_WIDGET (widget));
3768 sensitive = (sensitive != FALSE);
3770 if (sensitive == (GTK_WIDGET_SENSITIVE (widget) != FALSE))
3775 GTK_WIDGET_SET_FLAGS (widget, GTK_SENSITIVE);
3776 data.state = GTK_WIDGET_SAVED_STATE (widget);
3780 GTK_WIDGET_UNSET_FLAGS (widget, GTK_SENSITIVE);
3781 data.state = GTK_WIDGET_STATE (widget);
3783 data.state_restoration = TRUE;
3784 data.use_forall = TRUE;
3787 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget->parent) != FALSE);
3789 data.parent_sensitive = TRUE;
3791 gtk_widget_propagate_state (widget, &data);
3792 if (GTK_WIDGET_DRAWABLE (widget))
3793 gtk_widget_queue_clear (widget);
3795 g_object_notify (G_OBJECT (widget), "sensitive");
3799 * gtk_widget_set_parent:
3800 * @widget: a #GtkWidget
3801 * @parent: parent container
3803 * This function is useful only when implementing subclasses of #GtkContainer.
3804 * Sets the container as the parent of @widget, and takes care of
3805 * some details such as updating the state and style of the child
3806 * to reflect its new location. The opposite function is
3807 * gtk_widget_unparent().
3811 gtk_widget_set_parent (GtkWidget *widget,
3816 g_return_if_fail (GTK_IS_WIDGET (widget));
3817 g_return_if_fail (widget->parent == NULL);
3818 g_return_if_fail (!GTK_WIDGET_TOPLEVEL (widget));
3819 g_return_if_fail (GTK_IS_WIDGET (parent));
3820 g_return_if_fail (widget != parent);
3822 /* keep this function in sync with gtk_menu_attach_to_widget()
3825 g_object_ref (widget);
3826 gtk_object_sink (GTK_OBJECT (widget));
3827 widget->parent = parent;
3829 if (GTK_WIDGET_STATE (parent) != GTK_STATE_NORMAL)
3830 data.state = GTK_WIDGET_STATE (parent);
3832 data.state = GTK_WIDGET_STATE (widget);
3833 data.state_restoration = FALSE;
3834 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (parent) != FALSE);
3835 data.use_forall = GTK_WIDGET_IS_SENSITIVE (parent) != GTK_WIDGET_IS_SENSITIVE (widget);
3837 gtk_widget_propagate_state (widget, &data);
3839 gtk_widget_reset_rc_styles (widget);
3841 g_signal_emit (widget, widget_signals[PARENT_SET], 0, NULL);
3842 if (GTK_WIDGET_ANCHORED (widget->parent))
3843 _gtk_widget_propagate_hierarchy_changed (widget, NULL);
3844 g_object_notify (G_OBJECT (widget), "parent");
3846 /* Enforce realized/mapped invariants
3848 if (GTK_WIDGET_REALIZED (widget->parent))
3849 gtk_widget_realize (widget);
3851 if (GTK_WIDGET_VISIBLE (widget->parent) &&
3852 GTK_WIDGET_VISIBLE (widget))
3854 if (GTK_WIDGET_CHILD_VISIBLE (widget) &&
3855 GTK_WIDGET_MAPPED (widget->parent))
3856 gtk_widget_map (widget);
3858 gtk_widget_queue_resize (widget);
3863 * gtk_widget_get_parent:
3864 * @widget: a #GtkWidget
3866 * Returns the parent container of @widget.
3868 * Return value: the parent container of @widget, or %NULL
3871 gtk_widget_get_parent (GtkWidget *widget)
3873 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
3875 return widget->parent;
3878 /*****************************************
3880 * see docs/styles.txt
3881 *****************************************/
3884 * gtk_widget_set_style:
3885 * @widget: a #GtkWidget
3886 * @style: a #GtkStyle, or %NULL to remove the effect of a previous
3887 * gtk_widget_set_style() and go back to the default style
3889 * Sets the #GtkStyle for a widget (@widget->style). You probably don't
3890 * want to use this function; it interacts badly with themes, because
3891 * themes work by replacing the #GtkStyle. Instead, use
3892 * gtk_widget_modify_style().
3896 gtk_widget_set_style (GtkWidget *widget,
3899 g_return_if_fail (GTK_IS_WIDGET (widget));
3903 gboolean initial_emission;
3905 initial_emission = !GTK_WIDGET_RC_STYLE (widget) && !GTK_WIDGET_USER_STYLE (widget);
3907 GTK_WIDGET_UNSET_FLAGS (widget, GTK_RC_STYLE);
3908 GTK_PRIVATE_SET_FLAG (widget, GTK_USER_STYLE);
3910 gtk_widget_set_style_internal (widget, style, initial_emission);
3914 if (GTK_WIDGET_USER_STYLE (widget))
3915 gtk_widget_reset_rc_style (widget);
3920 * gtk_widget_ensure_style:
3921 * @widget: a #GtkWidget
3923 * Ensures that @widget has a style (@widget->style). Not a very useful
3924 * function; most of the time, if you want the style, the widget is
3925 * realized, and realized widgets are guaranteed to have a style
3930 gtk_widget_ensure_style (GtkWidget *widget)
3932 g_return_if_fail (GTK_IS_WIDGET (widget));
3934 if (!GTK_WIDGET_USER_STYLE (widget) &&
3935 !GTK_WIDGET_RC_STYLE (widget))
3936 gtk_widget_reset_rc_style (widget);
3939 /* Look up the RC style for this widget, unsetting any user style that
3940 * may be in effect currently
3943 gtk_widget_reset_rc_style (GtkWidget *widget)
3945 GtkStyle *new_style = NULL;
3946 gboolean initial_emission;
3948 g_return_if_fail (GTK_IS_WIDGET (widget));
3950 initial_emission = !GTK_WIDGET_RC_STYLE (widget) && !GTK_WIDGET_USER_STYLE (widget);
3952 GTK_PRIVATE_UNSET_FLAG (widget, GTK_USER_STYLE);
3953 GTK_WIDGET_SET_FLAGS (widget, GTK_RC_STYLE);
3955 if (gtk_widget_has_screen (widget))
3956 new_style = gtk_rc_get_style (widget);
3958 new_style = gtk_widget_get_default_style ();
3960 if (initial_emission || new_style != widget->style)
3961 gtk_widget_set_style_internal (widget, new_style, initial_emission);
3965 * gtk_widget_get_style:
3966 * @widget: a #GtkWidget
3968 * Simply an accessor function that returns @widget->style.
3970 * Return value: the widget's #GtkStyle
3973 gtk_widget_get_style (GtkWidget *widget)
3975 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
3977 return widget->style;
3981 * gtk_widget_modify_style:
3982 * @widget: a #GtkWidget
3983 * @style: the #GtkRcStyle holding the style modifications
3985 * Modifies style values on the widget. Modifications made using this
3986 * technique take precedence over style values set via an RC file,
3987 * however, they will be overriden if a style is explicitely set on
3988 * the widget using gtk_widget_set_style(). The #GtkRcStyle structure
3989 * is designed so each field can either be set or unset, so it is
3990 * possible, using this function, to modify some style values and
3991 * leave the others unchanged.
3993 * Note that modifications made with this function are not cumulative
3994 * with previous calls to gtk_widget_modify_style() or with such
3995 * functions as gtk_widget_modify_fg(). If you wish to retain
3996 * previous values, you must first call gtk_widget_get_modifier_style(),
3997 * make your modifications to the returned style, then call
3998 * gtk_widget_modify_style() with that style. On the other hand,
3999 * if you first call gtk_widget_modify_style(), subsequent calls
4000 * to such functions gtk_widget_modify_fg() will have a cumulative
4001 * effect with the initial modifications.
4004 gtk_widget_modify_style (GtkWidget *widget,
4007 GtkRcStyle *old_style;
4009 g_return_if_fail (GTK_IS_WIDGET (widget));
4010 g_return_if_fail (GTK_IS_RC_STYLE (style));
4012 old_style = g_object_get_qdata (G_OBJECT (widget), quark_rc_style);
4014 g_object_set_qdata_full (G_OBJECT (widget),
4016 gtk_rc_style_copy (style),
4017 (GDestroyNotify) gtk_rc_style_unref);
4019 /* note that "style" may be invalid here if it was the old
4020 * modifier style and the only reference was our own.
4023 if (GTK_WIDGET_RC_STYLE (widget))
4024 gtk_widget_reset_rc_style (widget);
4028 * gtk_widget_get_modifier_style:
4029 * @widget: a #GtkWidget
4031 * Returns the current modifier style for the widget. (As set by
4032 * gtk_widget_modify_style().) If no style has previously set, a new
4033 * #GtkRcStyle will be created with all values unset, and set as the
4034 * modifier style for the widget. If you make changes to this rc
4035 * style, you must call gtk_widget_modify_style(), passing in the
4036 * returned rc style, to make sure that your changes take effect.
4038 * Caution: passing the style back to gtk_widget_modify_style() will
4039 * normally end up destroying it, because gtk_widget_modify_style() copies
4040 * the passed-in style and sets the copy as the new modifier style,
4041 * thus dropping any reference to the old modifier style. Add a reference
4042 * to the modifier style if you want to keep it alive.
4044 * Return value: the modifier style for the widget. This rc style is
4045 * owned by the widget. If you want to keep a pointer to value this
4046 * around, you must add a refcount using gtk_rc_style_ref().
4049 gtk_widget_get_modifier_style (GtkWidget *widget)
4051 GtkRcStyle *rc_style;
4053 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4055 rc_style = g_object_get_qdata (G_OBJECT (widget), quark_rc_style);
4059 rc_style = gtk_rc_style_new ();
4060 g_object_set_qdata_full (G_OBJECT (widget),
4063 (GDestroyNotify) gtk_rc_style_unref);
4070 gtk_widget_modify_color_component (GtkWidget *widget,
4071 GtkRcFlags component,
4075 GtkRcStyle *rc_style = gtk_widget_get_modifier_style (widget);
4082 rc_style->fg[state] = *color;
4085 rc_style->bg[state] = *color;
4088 rc_style->text[state] = *color;
4091 rc_style->base[state] = *color;
4094 g_assert_not_reached();
4097 rc_style->color_flags[state] |= component;
4100 rc_style->color_flags[state] &= ~component;
4102 gtk_widget_modify_style (widget, rc_style);
4106 * gtk_widget_modify_fg:
4107 * @widget: a #GtkWidget.
4108 * @state: the state for which to set the foreground color.
4109 * @color: the color to assign (does not need to be allocated),
4110 * or %NULL to undo the effect of previous calls to
4111 * of gtk_widget_modify_fg().
4113 * Sets the foreground color for a widget in a particular state. All
4114 * other style values are left untouched. See also
4115 * gtk_widget_modify_style().
4118 gtk_widget_modify_fg (GtkWidget *widget,
4122 g_return_if_fail (GTK_IS_WIDGET (widget));
4123 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
4124 g_return_if_fail (color != NULL);
4126 gtk_widget_modify_color_component (widget, GTK_RC_FG, state, color);
4130 * gtk_widget_modify_bg:
4131 * @widget: a #GtkWidget.
4132 * @state: the state for which to set the background color.
4133 * @color: the color to assign (does not need to be allocated),
4134 * or %NULL to undo the effect of previous calls to
4135 * of gtk_widget_modify_bg().
4137 * Sets the background color for a widget in a particular state. All
4138 * other style values are left untouched. See also
4139 * gtk_widget_modify_style().
4142 gtk_widget_modify_bg (GtkWidget *widget,
4146 g_return_if_fail (GTK_IS_WIDGET (widget));
4147 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
4148 g_return_if_fail (color != NULL);
4150 gtk_widget_modify_color_component (widget, GTK_RC_BG, state, color);
4154 * gtk_widget_modify_text:
4155 * @widget: a #GtkWidget.
4156 * @state: the state for which to set the text color.
4157 * @color: the color to assign (does not need to be allocated),
4158 * or %NULL to undo the effect of previous calls to
4159 * of gtk_widget_modify_text().
4161 * Sets the text color for a widget in a particular state. All other
4162 * style values are left untouched. The text color is the foreground
4163 * color used along with the base color (see gtk_widget_modify_base())
4164 * for widgets such as #GtkEntry and #GtkTextView. See also
4165 * gtk_widget_modify_style().
4168 gtk_widget_modify_text (GtkWidget *widget,
4172 g_return_if_fail (GTK_IS_WIDGET (widget));
4173 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
4174 g_return_if_fail (color != NULL);
4176 gtk_widget_modify_color_component (widget, GTK_RC_TEXT, state, color);
4180 * gtk_widget_modify_base:
4181 * @widget: a #GtkWidget.
4182 * @state: the state for which to set the base color.
4183 * @color: the color to assign (does not need to be allocated),
4184 * or %NULL to undo the effect of previous calls to
4185 * of gtk_widget_modify_base().
4187 * Sets the base color for a widget in a particular state.
4188 * All other style values are left untouched. The base color
4189 * is the background color used along with the text color
4190 * (see gtk_widget_modify_text()) for widgets such as #GtkEntry
4191 * and #GtkTextView. See also gtk_widget_modify_style().
4194 gtk_widget_modify_base (GtkWidget *widget,
4198 g_return_if_fail (GTK_IS_WIDGET (widget));
4199 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
4200 g_return_if_fail (color != NULL);
4202 gtk_widget_modify_color_component (widget, GTK_RC_BASE, state, color);
4206 * gtk_widget_modify_font:
4207 * @widget: a #GtkWidget
4208 * @font_desc: the font description to use, or %NULL to undo
4209 * the effect of previous calls to gtk_widget_modify_font().
4211 * Sets the font to use for a widget. All other style values are left
4212 * untouched. See also gtk_widget_modify_style().
4215 gtk_widget_modify_font (GtkWidget *widget,
4216 PangoFontDescription *font_desc)
4218 GtkRcStyle *rc_style;
4220 g_return_if_fail (GTK_IS_WIDGET (widget));
4221 g_return_if_fail (font_desc != NULL);
4223 rc_style = gtk_widget_get_modifier_style (widget);
4225 if (rc_style->font_desc)
4226 pango_font_description_free (rc_style->font_desc);
4229 rc_style->font_desc = pango_font_description_copy (font_desc);
4231 rc_style->font_desc = NULL;
4233 gtk_widget_modify_style (widget, rc_style);
4237 gtk_widget_direction_changed (GtkWidget *widget,
4238 GtkTextDirection previous_direction)
4240 gtk_widget_queue_resize (widget);
4244 gtk_widget_style_set (GtkWidget *widget,
4245 GtkStyle *previous_style)
4247 if (GTK_WIDGET_REALIZED (widget) &&
4248 !GTK_WIDGET_NO_WINDOW (widget))
4249 gtk_style_set_background (widget->style, widget->window, widget->state);
4253 gtk_widget_set_style_internal (GtkWidget *widget,
4255 gboolean initial_emission)
4257 g_object_ref (widget);
4258 g_object_freeze_notify (G_OBJECT (widget));
4260 if (widget->style != style || initial_emission)
4262 PangoContext *context = gtk_widget_peek_pango_context (widget);
4264 pango_context_set_font_description (context, style->font_desc);
4267 if (widget->style != style)
4269 GtkStyle *previous_style;
4271 if (GTK_WIDGET_REALIZED (widget))
4273 gtk_widget_reset_shapes (widget);
4274 gtk_style_detach (widget->style);
4277 previous_style = widget->style;
4278 widget->style = style;
4279 g_object_ref (widget->style);
4281 if (GTK_WIDGET_REALIZED (widget))
4282 widget->style = gtk_style_attach (widget->style, widget->window);
4284 g_signal_emit (widget,
4285 widget_signals[STYLE_SET],
4287 initial_emission ? NULL : previous_style);
4288 g_object_unref (previous_style);
4290 if (widget->parent && !initial_emission)
4291 gtk_widget_queue_resize (widget);
4293 else if (initial_emission)
4294 g_signal_emit (widget,
4295 widget_signals[STYLE_SET],
4298 g_object_notify (G_OBJECT (widget), "style");
4299 g_object_thaw_notify (G_OBJECT (widget));
4300 g_object_unref (widget);
4304 GtkWidget *previous_toplevel;
4305 GdkScreen *previous_screen;
4306 GdkScreen *new_screen;
4307 } HierarchyChangedInfo;
4310 do_screen_change (GtkWidget *widget,
4311 GdkScreen *old_screen,
4312 GdkScreen *new_screen)
4314 if (old_screen != new_screen)
4315 g_signal_emit (widget, widget_signals[SCREEN_CHANGED], 0, old_screen);
4319 gtk_widget_propagate_hierarchy_changed_recurse (GtkWidget *widget,
4320 gpointer client_data)
4322 gboolean new_anchored;
4323 HierarchyChangedInfo *info = client_data;
4325 new_anchored = GTK_WIDGET_TOPLEVEL (widget) ||
4326 (widget->parent && GTK_WIDGET_ANCHORED (widget->parent));
4328 if (GTK_WIDGET_ANCHORED (widget) != new_anchored)
4330 g_object_ref (widget);
4333 GTK_PRIVATE_SET_FLAG (widget, GTK_ANCHORED);
4335 GTK_PRIVATE_UNSET_FLAG (widget, GTK_ANCHORED);
4337 g_signal_emit (widget, widget_signals[HIERARCHY_CHANGED], 0, info->previous_toplevel);
4338 do_screen_change (widget, info->previous_screen, info->new_screen);
4340 if (GTK_IS_CONTAINER (widget))
4341 gtk_container_forall (GTK_CONTAINER (widget),
4342 gtk_widget_propagate_hierarchy_changed_recurse,
4345 g_object_unref (widget);
4350 * _gtk_widget_propagate_hierarchy_changed:
4351 * @widget: a #GtkWidget
4352 * @previous_toplevel: Previous toplevel
4354 * Propagates changes in the anchored state to a widget and all
4355 * children, unsetting or setting the %ANCHORED flag, and
4356 * emitting ::hierarchy_changed.
4359 _gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
4360 GtkWidget *previous_toplevel)
4362 HierarchyChangedInfo info;
4364 info.previous_toplevel = previous_toplevel;
4365 info.previous_screen = previous_toplevel ? gtk_widget_get_screen (previous_toplevel) : NULL;
4367 if (GTK_WIDGET_TOPLEVEL (widget) ||
4368 (widget->parent && GTK_WIDGET_ANCHORED (widget->parent)))
4369 info.new_screen = gtk_widget_get_screen (widget);
4371 info.new_screen = NULL;
4373 if (info.previous_screen)
4374 g_object_ref (info.previous_screen);
4375 if (previous_toplevel)
4376 g_object_ref (previous_toplevel);
4378 gtk_widget_propagate_hierarchy_changed_recurse (widget, &info);
4380 if (previous_toplevel)
4381 g_object_unref (previous_toplevel);
4382 if (info.previous_screen)
4383 g_object_unref (info.previous_screen);
4387 gtk_widget_propagate_screen_changed_recurse (GtkWidget *widget,
4388 gpointer client_data)
4390 HierarchyChangedInfo *info = client_data;
4392 g_object_ref (widget);
4394 do_screen_change (widget, info->previous_screen, info->new_screen);
4396 if (GTK_IS_CONTAINER (widget))
4397 gtk_container_forall (GTK_CONTAINER (widget),
4398 gtk_widget_propagate_hierarchy_changed_recurse,
4401 g_object_unref (widget);
4405 * _gtk_widget_propagate_screen_changed:
4406 * @widget: a #GtkWidget
4407 * @previous_screen: Previous screen
4409 * Propagates changes in the screen for a widget to all
4410 * children, emitting ::screen_changed.
4413 _gtk_widget_propagate_screen_changed (GtkWidget *widget,
4414 GdkScreen *previous_screen)
4416 HierarchyChangedInfo info;
4418 info.previous_screen = previous_screen;
4419 info.new_screen = gtk_widget_get_screen (widget);
4421 if (previous_screen)
4422 g_object_ref (previous_screen);
4424 gtk_widget_propagate_screen_changed_recurse (widget, &info);
4426 if (previous_screen)
4427 g_object_unref (previous_screen);
4431 reset_rc_styles_recurse (GtkWidget *widget, gpointer data)
4433 if (GTK_WIDGET_RC_STYLE (widget))
4434 gtk_widget_reset_rc_style (widget);
4436 if (GTK_IS_CONTAINER (widget))
4437 gtk_container_forall (GTK_CONTAINER (widget),
4438 reset_rc_styles_recurse,
4443 gtk_widget_reset_rc_styles (GtkWidget *widget)
4445 g_return_if_fail (GTK_IS_WIDGET (widget));
4447 reset_rc_styles_recurse (widget, NULL);
4451 * gtk_widget_get_default_style:
4453 * Returns the default style used by all widgets initially.
4455 * Returns: the default style. This #GtkStyle object is owned by GTK+ and
4456 * should not be modified or freed.
4459 gtk_widget_get_default_style (void)
4461 if (!gtk_default_style)
4463 gtk_default_style = gtk_style_new ();
4464 g_object_ref (gtk_default_style);
4467 return gtk_default_style;
4470 static PangoContext *
4471 gtk_widget_peek_pango_context (GtkWidget *widget)
4473 return g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
4477 * gtk_widget_get_pango_context:
4478 * @widget: a #GtkWidget
4480 * Gets a #PangoContext with the appropriate colormap, font description
4481 * and base direction for this widget. Unlike the context returned
4482 * by gtk_widget_create_pango_context(), this context is owned by
4483 * the widget (it can be used as long as widget exists), and will
4484 * be updated to match any changes to the widget's attributes.
4486 * If you create and keep a #PangoLayout using this context, you must
4487 * deal with changes to the context by calling pango_layout_context_changed()
4488 * on the layout in response to the ::style_set and ::direction_set signals
4491 * Return value: the #PangoContext for the widget.
4494 gtk_widget_get_pango_context (GtkWidget *widget)
4496 PangoContext *context;
4499 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4501 context = g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
4504 screen = g_object_get_data (G_OBJECT (context), "gdk-pango-screen");
4505 if (screen && (screen != gtk_widget_get_screen (widget)))
4511 context = gtk_widget_create_pango_context (GTK_WIDGET (widget));
4512 g_object_set_qdata_full (G_OBJECT (widget),
4513 quark_pango_context,
4522 * gtk_widget_create_pango_context:
4523 * @widget: a #GtkWidget
4525 * Creates a new #PangoContext with the appropriate colormap,
4526 * font description, and base direction for drawing text for
4527 * this widget. See also gtk_widget_get_pango_context().
4529 * Return value: the new #PangoContext
4532 gtk_widget_create_pango_context (GtkWidget *widget)
4534 PangoContext *context;
4536 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4538 context = gdk_pango_context_get_for_screen (gtk_widget_get_screen (widget));
4540 gdk_pango_context_set_colormap (context, gtk_widget_get_colormap (widget));
4541 pango_context_set_base_dir (context,
4542 gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR ?
4543 PANGO_DIRECTION_LTR : PANGO_DIRECTION_RTL);
4544 pango_context_set_font_description (context, widget->style->font_desc);
4545 pango_context_set_language (context, gtk_get_default_language ());
4551 * gtk_widget_create_pango_layout:
4552 * @widget: a #GtkWidget
4553 * @text: text to set on the layout (can be %NULL)
4555 * Creates a new #PangoLayout with the appropriate colormap,
4556 * font description, and base direction for drawing text for
4559 * If you keep a #PangoLayout created in this way around, in order
4560 * notify the layout of changes to the base direction or font of this
4561 * widget, you must call pango_layout_context_changed() in response to
4562 * the ::style_set and ::direction_set signals for the widget.
4564 * Return value: the new #PangoLayout
4567 gtk_widget_create_pango_layout (GtkWidget *widget,
4570 PangoLayout *layout;
4571 PangoContext *context;
4573 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4575 context = gtk_widget_get_pango_context (widget);
4576 layout = pango_layout_new (context);
4579 pango_layout_set_text (layout, text, -1);
4585 * gtk_widget_render_icon:
4586 * @widget: a #GtkWidget
4587 * @stock_id: a stock ID
4588 * @size: a stock size
4589 * @detail: render detail to pass to theme engine
4591 * A convenience function that uses the theme engine and RC file
4592 * settings for @widget to look up @stock_id and render it to
4593 * a pixbuf. @stock_id should be a stock icon ID such as
4594 * #GTK_STOCK_OPEN or #GTK_STOCK_OK. @size should be a size
4595 * such as #GTK_ICON_SIZE_MENU. @detail should be a string that
4596 * identifies the widget or code doing the rendering, so that
4597 * theme engines can special-case rendering for that widget or code.
4599 * The pixels in the returned #GdkPixbuf are shared with the rest of
4600 * the application and should not be modified. The pixbuf should be freed
4601 * after use with g_object_unref().
4603 * Return value: a new pixbuf, or %NULL if the stock ID wasn't known
4606 gtk_widget_render_icon (GtkWidget *widget,
4607 const gchar *stock_id,
4609 const gchar *detail)
4611 GtkIconSet *icon_set;
4614 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4615 g_return_val_if_fail (stock_id != NULL, NULL);
4616 g_return_val_if_fail (size > GTK_ICON_SIZE_INVALID, NULL);
4618 gtk_widget_ensure_style (widget);
4620 icon_set = gtk_style_lookup_icon_set (widget->style, stock_id);
4622 if (icon_set == NULL)
4625 retval = gtk_icon_set_render_icon (icon_set,
4627 gtk_widget_get_direction (widget),
4628 GTK_WIDGET_STATE (widget),
4637 * gtk_widget_set_parent_window:
4638 * @widget: a #GtkWidget.
4639 * @parent_window: the new parent window.
4641 * Sets a non default parent window for @widget.
4644 gtk_widget_set_parent_window (GtkWidget *widget,
4645 GdkWindow *parent_window)
4647 GdkWindow *old_parent_window;
4649 g_return_if_fail (GTK_IS_WIDGET (widget));
4651 old_parent_window = g_object_get_qdata (G_OBJECT (widget),
4652 quark_parent_window);
4654 if (parent_window != old_parent_window)
4656 g_object_set_qdata (G_OBJECT (widget), quark_parent_window,
4658 if (old_parent_window)
4659 g_object_unref (old_parent_window);
4661 g_object_ref (parent_window);
4667 * gtk_widget_set_child_visible:
4668 * @widget: a #GtkWidget
4669 * @is_visible: if %TRUE, @widget should be mapped along with its parent.
4671 * Sets whether @widget should be mapped along with its when its parent
4672 * is mapped and @widget has been shown with gtk_widget_show().
4674 * The child visibility can be set for widget before it is added to
4675 * a container with gtk_widget_set_parent(), to avoid mapping
4676 * children unnecessary before immediately unmapping them. However
4677 * it will be reset to its default state of %TRUE when the widget
4678 * is removed from a container.
4680 * Note that changing the child visibility of a widget does not
4681 * queue a resize on the widget. Most of the time, the size of
4682 * a widget is computed from all visible children, whether or
4683 * not they are mapped. If this is not the case, the container
4684 * can queue a resize itself.
4686 * This function is only useful for container implementations and
4687 * never should be called by an application.
4690 gtk_widget_set_child_visible (GtkWidget *widget,
4691 gboolean is_visible)
4693 g_return_if_fail (GTK_IS_WIDGET (widget));
4694 g_return_if_fail (!GTK_WIDGET_TOPLEVEL (widget));
4697 GTK_PRIVATE_SET_FLAG (widget, GTK_CHILD_VISIBLE);
4699 GTK_PRIVATE_UNSET_FLAG (widget, GTK_CHILD_VISIBLE);
4700 if (widget->parent && GTK_WIDGET_REALIZED (widget->parent))
4702 if (GTK_WIDGET_MAPPED (widget->parent) &&
4703 GTK_WIDGET_CHILD_VISIBLE (widget) &&
4704 GTK_WIDGET_VISIBLE (widget))
4705 gtk_widget_map (widget);
4707 gtk_widget_unmap (widget);
4712 * gtk_widget_get_child_visible:
4713 * @widget: a #GtkWidget
4715 * Gets the value set with gtk_widget_set_child_visible().
4716 * If you feel a need to use this function, your code probably
4717 * needs reorganization.
4719 * This function is only useful for container implementations and
4720 * never should be called by an application.
4722 * Return value: %TRUE if the widget is mapped with the parent.
4725 gtk_widget_get_child_visible (GtkWidget *widget)
4727 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4729 return GTK_WIDGET_CHILD_VISIBLE (widget);
4733 gtk_widget_get_screen_unchecked (GtkWidget *widget)
4735 GtkWidget *toplevel;
4737 toplevel = gtk_widget_get_toplevel (widget);
4739 if (GTK_WIDGET_TOPLEVEL (toplevel))
4741 if (GTK_IS_WINDOW (toplevel))
4742 return GTK_WINDOW (toplevel)->screen;
4743 else if (GTK_IS_INVISIBLE (toplevel))
4744 return GTK_INVISIBLE (widget)->screen;
4751 * gtk_widget_get_screen:
4752 * @widget: a #GtkWidget
4754 * Get the #GdkScreen from the toplevel window associated with
4755 * this widget. This function can only be called after the widget
4756 * has been added to a widget hierarchy with a #GtkWindow
4759 * In general, you should only create screen specific
4760 * resources when a widget has been realized, and you should
4761 * free those resources when the widget is unrealized.
4763 * Return value: the #GdkScreen for the toplevel for this widget.
4766 gtk_widget_get_screen (GtkWidget *widget)
4770 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4772 screen = gtk_widget_get_screen_unchecked (widget);
4779 g_warning (G_STRLOC ": Can't get associated screen"
4780 " for a widget unless it is inside a toplevel GtkWindow\n"
4781 " widget type is %s associated top level type is %s",
4782 g_type_name (G_OBJECT_TYPE(G_OBJECT (widget))),
4783 g_type_name (G_OBJECT_TYPE(G_OBJECT (toplevel))));
4785 return gdk_screen_get_default ();
4790 * gtk_widget_has_screen:
4791 * @widget: a #GtkWidget
4793 * Checks whether there is a #GdkScreen is associated with
4794 * this widget. All toplevel widgets have an associated
4795 * screen, and all widgets added into a heirarchy with a toplevel
4796 * window at the top.
4798 * Return value: %TRUE if there is a #GdkScreen associcated
4802 gtk_widget_has_screen (GtkWidget *widget)
4804 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4806 return (gtk_widget_get_screen_unchecked (widget) != NULL);
4810 * gtk_widget_get_display:
4811 * @widget: a #GtkWidget
4813 * Get the #GdkDisplay for the toplevel window associated with
4814 * this widget. This function can only be called after the widget
4815 * has been added to a widget hierarchy with a #GtkWindow at the top.
4817 * In general, you should only create display specific
4818 * resources when a widget has been realized, and you should
4819 * free those resources when the widget is unrealized.
4821 * Return value: the #GdkDisplay for the toplevel for this widget.
4824 gtk_widget_get_display (GtkWidget *widget)
4826 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4828 return gdk_screen_get_display (gtk_widget_get_screen (widget));
4832 * gtk_widget_get_root_window:
4833 * @widget: a #GtkWidget
4835 * Get the root window where this widget is located. This function can
4836 * only be called after the widget has been added to a widget
4837 * heirarchy with #GtkWindow at the top.
4839 * The root window is useful for such purposes as creating a popup
4840 * #GdkWindow associated with the window. In general, you should only
4841 * create display specific resources when a widget has been realized,
4842 * and you should free those resources when the widget is unrealized.
4844 * Return value: the #GdkWindow root window for the toplevel for this widget.
4847 gtk_widget_get_root_window (GtkWidget *widget)
4849 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4851 return gdk_screen_get_root_window (gtk_widget_get_screen (widget));
4855 * gtk_widget_get_parent_window:
4856 * @widget: a #GtkWidget.
4857 * @returns: the parent window of @widget.
4859 * Gets @widget's parent window.
4862 gtk_widget_get_parent_window (GtkWidget *widget)
4864 GdkWindow *parent_window;
4866 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4867 g_return_val_if_fail (widget->parent != NULL, NULL);
4869 parent_window = g_object_get_qdata (G_OBJECT (widget), quark_parent_window);
4871 return (parent_window != NULL) ? parent_window : widget->parent->window;
4875 * gtk_widget_child_focus:
4876 * @widget: a #GtkWidget
4877 * @direction: direction of focus movement
4879 * This function is used by custom widget implementations; if you're
4880 * writing an app, you'd use gtk_widget_grab_focus() to move the focus
4881 * to a particular widget, and gtk_container_set_focus_chain() to
4882 * change the focus tab order. So you may want to investigate those
4883 * functions instead.
4885 * gtk_widget_child_focus() is called by containers as the user moves
4886 * around the window using keyboard shortcuts. @direction indicates
4887 * what kind of motion is taking place (up, down, left, right, tab
4888 * forward, tab backward). gtk_widget_child_focus() invokes the
4889 * "focus" signal on #GtkWidget; widgets override the default handler
4890 * for this signal in order to implement appropriate focus behavior.
4892 * The "focus" default handler for a widget should return %TRUE if
4893 * moving in @direction left the focus on a focusable location inside
4894 * that widget, and %FALSE if moving in @direction moved the focus
4895 * outside the widget. If returning %TRUE, widgets normally
4896 * call gtk_widget_grab_focus() to place the focus accordingly;
4897 * if returning %FALSE, they don't modify the current focus location.
4899 * This function replaces gtk_container_focus() from GTK+ 1.2. It was
4900 * necessary to check that the child was visible, sensitive, and
4901 * focusable before calling
4902 * gtk_container_focus(). gtk_widget_child_focus() returns %FALSE if
4903 * the widget is not currently in a focusable state, so there's no
4904 * need for those checks.
4906 * Return value: %TRUE if focus ended up inside @widget
4909 gtk_widget_child_focus (GtkWidget *widget,
4910 GtkDirectionType direction)
4912 gboolean return_val;
4914 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4916 if (!GTK_WIDGET_VISIBLE (widget) ||
4917 !GTK_WIDGET_IS_SENSITIVE (widget))
4920 /* child widgets must set CAN_FOCUS, containers
4921 * don't have to though.
4923 if (!GTK_IS_CONTAINER (widget) &&
4924 !GTK_WIDGET_CAN_FOCUS (widget))
4927 g_signal_emit (widget,
4928 widget_signals[FOCUS],
4930 direction, &return_val);
4936 * gtk_widget_set_uposition:
4937 * @widget: a #GtkWidget
4938 * @x: x position; -1 to unset x; -2 to leave x unchanged
4939 * @y: y position; -1 to unset y; -2 to leave y unchanged
4942 * Sets the position of a widget. The funny "u" in the name comes from
4943 * the "user position" hint specified by the X Window System, and
4944 * exists for legacy reasons. This function doesn't work if a widget
4945 * is inside a container; it's only really useful on #GtkWindow.
4947 * Don't use this function to center dialogs over the main application
4948 * window; most window managers will do the centering on your behalf
4949 * if you call gtk_window_set_transient_for(), and it's really not
4950 * possible to get the centering to work correctly in all cases from
4951 * application code. But if you insist, use gtk_window_set_position()
4952 * to set #GTK_WIN_POS_CENTER_ON_PARENT, don't do the centering
4955 * Note that although @x and @y can be individually unset, the position
4956 * is not honoured unless both @x and @y are set.
4959 gtk_widget_set_uposition (GtkWidget *widget,
4963 /* FIXME this function is the only place that aux_info->x and
4964 * aux_info->y are even used I believe, and this function is
4965 * deprecated. Should be cleaned up.
4967 * (Actually, size_allocate uses them) -Yosh
4970 GtkWidgetAuxInfo *aux_info;
4972 g_return_if_fail (GTK_IS_WIDGET (widget));
4974 aux_info =_gtk_widget_get_aux_info (widget, TRUE);
4979 aux_info->x_set = FALSE;
4982 aux_info->x_set = TRUE;
4990 aux_info->y_set = FALSE;
4993 aux_info->y_set = TRUE;
4998 if (GTK_IS_WINDOW (widget) && aux_info->x_set && aux_info->y_set)
4999 _gtk_window_reposition (GTK_WINDOW (widget), aux_info->x, aux_info->y);
5001 if (GTK_WIDGET_VISIBLE (widget) && widget->parent)
5002 gtk_widget_size_allocate (widget, &widget->allocation);
5006 * gtk_widget_set_usize:
5007 * @widget: a #GtkWidget
5008 * @width: minimum width, or -1 to unset
5009 * @height: minimum height, or -1 to unset
5011 * This function is deprecated; use gtk_widget_set_size_request()
5014 * Sets the minimum size of a widget; that is, the widget's size
5015 * request will be @width by @height. You can use this function to
5016 * force a widget to be either larger or smaller than it is. The
5017 * strange "usize" name dates from the early days of GTK+, and derives
5018 * from X Window System terminology. In many cases,
5019 * gtk_window_set_default_size() is a better choice for toplevel
5020 * windows than this function; setting the default size will still
5021 * allow users to shrink the window. Setting the usize will force them
5022 * to leave the window at least as large as the usize. When dealing
5023 * with window sizes, gtk_window_set_geometry_hints() can be a useful
5026 * Note the inherent danger of setting any fixed size - themes,
5027 * translations into other languages, different fonts, and user action
5028 * can all change the appropriate size for a given widget. So, it's
5029 * basically impossible to hardcode a size that will always be
5034 gtk_widget_set_usize (GtkWidget *widget,
5038 GtkWidgetAuxInfo *aux_info;
5040 g_return_if_fail (GTK_IS_WIDGET (widget));
5042 g_object_freeze_notify (G_OBJECT (widget));
5044 aux_info =_gtk_widget_get_aux_info (widget, TRUE);
5048 g_object_notify (G_OBJECT (widget), "width_request");
5049 aux_info->width = width;
5053 g_object_notify (G_OBJECT (widget), "height_request");
5054 aux_info->height = height;
5057 if (GTK_WIDGET_VISIBLE (widget))
5058 gtk_widget_queue_resize (widget);
5060 g_object_thaw_notify (G_OBJECT (widget));
5064 * gtk_widget_set_size_request:
5065 * @widget: a #GtkWidget
5066 * @width: width @widget should request, or -1 to unset
5067 * @height: height @widget should request, or -1 to unset
5069 * Sets the minimum size of a widget; that is, the widget's size
5070 * request will be @width by @height. You can use this function to
5071 * force a widget to be either larger or smaller than it normally
5074 * In most cases, gtk_window_set_default_size() is a better choice for
5075 * toplevel windows than this function; setting the default size will
5076 * still allow users to shrink the window. Setting the size request
5077 * will force them to leave the window at least as large as the size
5078 * request. When dealing with window sizes,
5079 * gtk_window_set_geometry_hints() can be a useful function as well.
5081 * Note the inherent danger of setting any fixed size - themes,
5082 * translations into other languages, different fonts, and user action
5083 * can all change the appropriate size for a given widget. So, it's
5084 * basically impossible to hardcode a size that will always be
5087 * The size request of a widget is the smallest size a widget can
5088 * accept while still functioning well and drawing itself correctly.
5089 * However in some strange cases a widget may be allocated less than
5090 * its requested size, and in many cases a widget may be allocated more
5091 * space than it requested.
5093 * If the size request in a given direction is -1 (unset), then
5094 * the "natural" size request of the widget will be used instead.
5096 * Widgets can't actually be allocated a size less than 1 by 1, but
5097 * you can pass 0,0 to this function to mean "as small as possible."
5100 gtk_widget_set_size_request (GtkWidget *widget,
5104 g_return_if_fail (GTK_IS_WIDGET (widget));
5105 g_return_if_fail (width >= -1);
5106 g_return_if_fail (height >= -1);
5113 gtk_widget_set_usize (widget, width, height);
5118 * gtk_widget_get_size_request:
5119 * @widget: a #GtkWidget
5120 * @width: return location for width, or %NULL
5121 * @height: return location for height, or %NULL
5123 * Gets the size request that was explicitly set for the widget using
5124 * gtk_widget_set_size_request(). A value of -1 stored in @width or
5125 * @height indicates that that dimension has not been set explicitly
5126 * and the natural requisition of the widget will be used intead. See
5127 * gtk_widget_set_size_request(). To get the size a widget will
5128 * actually use, call gtk_widget_size_request() instead of
5134 gtk_widget_get_size_request (GtkWidget *widget,
5138 GtkWidgetAuxInfo *aux_info;
5140 g_return_if_fail (GTK_IS_WIDGET (widget));
5142 aux_info = _gtk_widget_get_aux_info (widget, FALSE);
5145 *width = aux_info ? aux_info->width : -1;
5148 *height = aux_info ? aux_info->height : -1;
5152 * gtk_widget_set_events:
5153 * @widget: a #GtkWidget
5154 * @events: event mask
5156 * Sets the event mask (see #GdkEventMask) for a widget. The event
5157 * mask determines which events a widget will receive. Keep in mind
5158 * that different widgets have different default event masks, and by
5159 * changing the event mask you may disrupt a widget's functionality,
5160 * so be careful. This function must be called while a widget is
5161 * unrealized. Consider gtk_widget_add_events() for widgets that are
5162 * already realized, or if you want to preserve the existing event
5163 * mask. This function can't be used with #GTK_NO_WINDOW widgets;
5164 * to get events on those widgets, place them inside a #GtkEventBox
5165 * and receive events on the event box.
5169 gtk_widget_set_events (GtkWidget *widget,
5174 g_return_if_fail (GTK_IS_WIDGET (widget));
5175 g_return_if_fail (!GTK_WIDGET_REALIZED (widget));
5177 eventp = g_object_get_qdata (G_OBJECT (widget), quark_event_mask);
5182 eventp = g_new (gint, 1);
5185 g_object_set_qdata (G_OBJECT (widget), quark_event_mask, eventp);
5190 g_object_set_qdata (G_OBJECT (widget), quark_event_mask, NULL);
5193 g_object_notify (G_OBJECT (widget), "events");
5197 * gtk_widget_add_events:
5198 * @widget: a #GtkWidget
5199 * @events: an event mask, see #GdkEventMask
5201 * Adds the events in the bitfield @events to the event mask for
5202 * @widget. See gtk_widget_set_events() for details.
5206 gtk_widget_add_events (GtkWidget *widget,
5211 g_return_if_fail (GTK_IS_WIDGET (widget));
5213 eventp = g_object_get_qdata (G_OBJECT (widget), quark_event_mask);
5219 eventp = g_new (gint, 1);
5224 g_object_set_qdata (G_OBJECT (widget), quark_event_mask, eventp);
5229 g_object_set_qdata (G_OBJECT (widget), quark_event_mask, NULL);
5232 if (GTK_WIDGET_REALIZED (widget))
5234 if (GTK_WIDGET_NO_WINDOW (widget))
5236 GList *children = gdk_window_get_children (widget->window);
5237 GList *tmp_list = children;
5241 GdkWindow *window = tmp_list->data;
5244 gdk_window_get_user_data (window, &user_data);
5245 if (user_data == widget)
5246 gdk_window_set_events (window, gdk_window_get_events (window) | events);
5247 tmp_list = tmp_list->next;
5250 g_list_free (children);
5254 gdk_window_set_events (widget->window, gdk_window_get_events (widget->window) | events);
5258 g_object_notify (G_OBJECT (widget), "events");
5262 * gtk_widget_set_extension_events:
5263 * @widget: a #GtkWidget
5264 * @mode: bitfield of extension events to receive
5266 * Sets the extension events mask to @mode. See #GdkExtensionMode
5267 * and gdk_input_set_extension_events().
5271 gtk_widget_set_extension_events (GtkWidget *widget,
5272 GdkExtensionMode mode)
5274 GdkExtensionMode *modep;
5276 g_return_if_fail (GTK_IS_WIDGET (widget));
5278 modep = g_object_get_qdata (G_OBJECT (widget), quark_extension_event_mode);
5281 modep = g_new (GdkExtensionMode, 1);
5284 g_object_set_qdata (G_OBJECT (widget), quark_extension_event_mode, modep);
5285 g_object_notify (G_OBJECT (widget), "extension_events");
5289 * gtk_widget_get_toplevel:
5290 * @widget: a #GtkWidget
5292 * This function returns the topmost widget in the container hierarchy
5293 * @widget is a part of. If @widget has no parent widgets, it will be
5294 * returned as the topmost widget. No reference will be added to the
5295 * returned widget; it should not be unreferenced.
5297 * Note the difference in behavior vs. gtk_widget_get_ancestor();
5298 * <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW)</literal>
5300 * %NULL if @widget wasn't inside a toplevel window, and if the
5301 * window was inside a #GtkWindow-derived widget which was in turn
5302 * inside the toplevel #GtkWindow. While the second case may
5303 * seem unlikely, it actually happens when a #GtkPlug is embedded
5304 * inside a #GtkSocket within the same application.
5306 * To reliably find the toplevel #GtkWindow, use
5307 * gtk_widget_get_toplevel() and check if the %TOPLEVEL flags
5308 * is set on the result.
5309 * <informalexample><programlisting>
5310 * GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
5311 * if (GTK_WIDGET_TOPLEVEL (toplevel))
5313 * [ Perform action on toplevel. ]
5315 * </programlisting></informalexample>
5317 * Return value: the topmost ancestor of @widget, or @widget itself if there's no ancestor.
5320 gtk_widget_get_toplevel (GtkWidget *widget)
5322 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5324 while (widget->parent)
5325 widget = widget->parent;
5331 * gtk_widget_get_ancestor:
5332 * @widget: a #GtkWidget
5333 * @widget_type: ancestor type
5335 * Gets the first ancestor of @widget with type @widget_type. For example,
5336 * <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)</literal> gets the
5337 * first #GtkBox that's
5338 * an ancestor of @widget. No reference will be added to the returned widget;
5339 * it should not be unreferenced. See note about checking for a toplevel
5340 * #GtkWindow in the docs for gtk_widget_get_toplevel().
5342 * Return value: the ancestor widget, or %NULL if not found
5345 gtk_widget_get_ancestor (GtkWidget *widget,
5348 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5350 while (widget && !g_type_is_a (GTK_WIDGET_TYPE (widget), widget_type))
5351 widget = widget->parent;
5353 if (!(widget && g_type_is_a (GTK_WIDGET_TYPE (widget), widget_type)))
5360 * gtk_widget_get_colormap:
5361 * @widget: a #GtkWidget
5363 * Gets the colormap that will be used to render @widget. No reference will
5364 * be added to the returned colormap; it should not be unreferenced.
5366 * Return value: the colormap used by @widget
5369 gtk_widget_get_colormap (GtkWidget *widget)
5371 GdkColormap *colormap;
5372 GtkWidget *tmp_widget;
5374 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5378 colormap = gdk_drawable_get_colormap (widget->window);
5379 /* If window was destroyed previously, we'll get NULL here */
5384 tmp_widget = widget;
5387 colormap = g_object_get_qdata (G_OBJECT (tmp_widget), quark_colormap);
5391 tmp_widget= tmp_widget->parent;
5394 return gdk_screen_get_default_colormap (gtk_widget_get_screen (widget));
5398 * gtk_widget_get_visual:
5399 * @widget: a #GtkWidget
5401 * Gets the visual that will be used to render @widget.
5403 * Return value: the visual for @widget
5406 gtk_widget_get_visual (GtkWidget *widget)
5408 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5410 return gdk_colormap_get_visual (gtk_widget_get_colormap (widget));
5414 * gtk_widget_get_settings:
5415 * @widget: a #GtkWidget
5417 * Gets the settings object holding the settings (global property
5418 * settings, RC file information, etc) used for this widget.
5420 * Note that this function can only be called when the #GtkWidget
5421 * is attached to a toplevel, since the settings object is specific
5422 * to a particular #GdkScreen.
5424 * Return value: the relevant #GtkSettings object
5427 gtk_widget_get_settings (GtkWidget *widget)
5429 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5431 return gtk_settings_get_for_screen (gtk_widget_get_screen (widget));
5435 * gtk_widget_set_colormap:
5436 * @widget: a #GtkWidget
5437 * @colormap: a colormap
5439 * Sets the colormap for the widget to the given value. Widget must not
5440 * have been previously realized. This probably should only be used
5441 * from an <function>init()</function> function (i.e. from the constructor
5446 gtk_widget_set_colormap (GtkWidget *widget,
5447 GdkColormap *colormap)
5449 g_return_if_fail (GTK_IS_WIDGET (widget));
5450 g_return_if_fail (!GTK_WIDGET_REALIZED (widget));
5451 g_return_if_fail (GDK_IS_COLORMAP (colormap));
5453 g_object_ref (colormap);
5455 g_object_set_qdata_full (G_OBJECT (widget),
5462 * gtk_widget_get_events:
5463 * @widget: a #GtkWidget
5465 * Returns the event mask for the widget (a bitfield containing flags
5466 * from the #GdkEventMask enumeration). These are the events that the widget
5469 * Return value: event mask for @widget
5472 gtk_widget_get_events (GtkWidget *widget)
5476 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
5478 events = g_object_get_qdata (G_OBJECT (widget), quark_event_mask);
5486 * gtk_widget_get_extension_events:
5487 * @widget: a #GtkWidget
5489 * Retrieves the extension events the widget will receive; see
5490 * gdk_input_set_extension_events().
5492 * Return value: extension events for @widget
5495 gtk_widget_get_extension_events (GtkWidget *widget)
5497 GdkExtensionMode *mode;
5499 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
5501 mode = g_object_get_qdata (G_OBJECT (widget), quark_extension_event_mode);
5509 * gtk_widget_get_pointer:
5510 * @widget: a #GtkWidget
5511 * @x: return location for the X coordinate, or %NULL
5512 * @y: return location for the Y coordinate, or %NULL
5514 * Obtains the location of the mouse pointer in widget coordinates.
5515 * Widget coordinates are a bit odd; for historical reasons, they are
5516 * defined as @widget->window coordinates for widgets that are not
5517 * #GTK_NO_WINDOW widgets, and are relative to @widget->allocation.x,
5518 * @widget->allocation.y for widgets that are #GTK_NO_WINDOW widgets.
5522 gtk_widget_get_pointer (GtkWidget *widget,
5526 g_return_if_fail (GTK_IS_WIDGET (widget));
5533 if (GTK_WIDGET_REALIZED (widget))
5535 gdk_window_get_pointer (widget->window, x, y, NULL);
5537 if (GTK_WIDGET_NO_WINDOW (widget))
5540 *x -= widget->allocation.x;
5542 *y -= widget->allocation.y;
5548 * gtk_widget_is_ancestor:
5549 * @widget: a #GtkWidget
5550 * @ancestor: another #GtkWidget
5552 * Determines whether @widget is somewhere inside @ancestor, possibly with
5553 * intermediate containers.
5555 * Return value: %TRUE if @ancestor contains @widget as a child, grandchild, great grandchild, etc.
5558 gtk_widget_is_ancestor (GtkWidget *widget,
5559 GtkWidget *ancestor)
5561 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5562 g_return_val_if_fail (ancestor != NULL, FALSE);
5566 if (widget->parent == ancestor)
5568 widget = widget->parent;
5574 static GQuark quark_composite_name = 0;
5577 * gtk_widget_set_composite_name:
5578 * @widget: a #GtkWidget.
5579 * @name: the name to set.
5581 * Sets a widgets composite name. The widget must be
5582 * a composite child of its parent; see gtk_widget_push_composite_child().
5585 gtk_widget_set_composite_name (GtkWidget *widget,
5588 g_return_if_fail (GTK_IS_WIDGET (widget));
5589 g_return_if_fail (GTK_WIDGET_COMPOSITE_CHILD (widget));
5590 g_return_if_fail (name != NULL);
5592 if (!quark_composite_name)
5593 quark_composite_name = g_quark_from_static_string ("gtk-composite-name");
5595 g_object_set_qdata_full (G_OBJECT (widget),
5596 quark_composite_name,
5602 * gtk_widget_get_composite_name:
5603 * @widget: a #GtkWidget.
5604 * @returns: the composite name of @widget, or %NULL if @widget is not
5605 * a composite child. The string should not be freed when it is no
5608 * Obtains the composite name of a widget.
5611 gtk_widget_get_composite_name (GtkWidget *widget)
5613 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5615 if (GTK_WIDGET_COMPOSITE_CHILD (widget) && widget->parent)
5616 return _gtk_container_child_composite_name (GTK_CONTAINER (widget->parent),
5623 * gtk_widget_push_composite_child:
5625 * Makes all newly-created widgets as composite children until
5626 * the corresponding gtk_widget_pop_composite_child() call.
5628 * A composite child is a child that's an implementation detail of the
5629 * container it's inside and should not be visible to people using the
5630 * container. Composite children aren't treated differently by GTK (but
5631 * see gtk_container_foreach() vs. gtk_container_forall()), but e.g. GUI
5632 * builders might want to treat them in a different way.
5634 * Here is a simple example:
5635 * <informalexample><programlisting>
5636 * gtk_widget_push_composite_child (<!-- -->);
5637 * scrolled_window->hscrollbar = gtk_hscrollbar_new (hadjustment);
5638 * gtk_widget_set_composite_name (scrolled_window->hscrollbar, "hscrollbar");
5639 * gtk_widget_pop_composite_child (<!-- -->);
5640 * gtk_widget_set_parent (scrolled_window->hscrollbar,
5641 * GTK_WIDGET (scrolled_window));
5642 * g_object_ref (scrolled_window->hscrollbar);
5643 * </programlisting></informalexample>
5646 gtk_widget_push_composite_child (void)
5648 composite_child_stack++;
5652 * gtk_widget_pop_composite_child:
5654 * Cancels the effect of a previous call to gtk_widget_push_composite_child().
5657 gtk_widget_pop_composite_child (void)
5659 if (composite_child_stack)
5660 composite_child_stack--;
5664 * gtk_widget_push_colormap:
5665 * @cmap: a #GdkColormap
5667 * Pushes @cmap onto a global stack of colormaps; the topmost
5668 * colormap on the stack will be used to create all widgets.
5669 * Remove @cmap with gtk_widget_pop_colormap(). There's little
5670 * reason to use this function.
5674 gtk_widget_push_colormap (GdkColormap *cmap)
5676 g_return_if_fail (!cmap || GDK_IS_COLORMAP (cmap));
5678 colormap_stack = g_slist_prepend (colormap_stack, cmap);
5682 * gtk_widget_pop_colormap:
5684 * Removes a colormap pushed with gtk_widget_push_colormap().
5688 gtk_widget_pop_colormap (void)
5691 colormap_stack = g_slist_delete_link (colormap_stack, colormap_stack);
5695 * gtk_widget_set_default_colormap:
5696 * @colormap: a #GdkColormap
5698 * Sets the default colormap to use when creating widgets.
5699 * gtk_widget_push_colormap() is a better function to use if
5700 * you only want to affect a few widgets, rather than all widgets.
5703 gtk_widget_set_default_colormap (GdkColormap *colormap)
5705 g_return_if_fail (GDK_IS_COLORMAP (colormap));
5707 gdk_screen_set_default_colormap (gdk_colormap_get_screen (colormap),
5712 * gtk_widget_get_default_colormap:
5714 * Obtains the default colormap used to create widgets.
5716 * Return value: default widget colormap
5719 gtk_widget_get_default_colormap (void)
5721 return gdk_screen_get_default_colormap (gdk_screen_get_default ());
5725 * gtk_widget_get_default_visual:
5727 * Obtains the visual of the default colormap. Not really useful;
5728 * used to be useful before gdk_colormap_get_visual() existed.
5730 * Return value: visual of the default colormap
5733 gtk_widget_get_default_visual (void)
5735 return gdk_colormap_get_visual (gtk_widget_get_default_colormap ());
5739 gtk_widget_emit_direction_changed (GtkWidget *widget,
5740 GtkTextDirection old_dir)
5742 PangoContext *context = gtk_widget_peek_pango_context (widget);
5745 pango_context_set_base_dir (context,
5746 gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR ?
5747 PANGO_DIRECTION_LTR : PANGO_DIRECTION_RTL);
5749 g_signal_emit (widget, widget_signals[DIRECTION_CHANGED], 0, old_dir);
5753 * gtk_widget_set_direction:
5754 * @widget: a #GtkWidget
5755 * @dir: the new direction
5757 * Sets the reading direction on a particular widget. This direction
5758 * controls the primary direction for widgets containing text,
5759 * and also the direction in which the children of a container are
5760 * packed. The ability to set the direction is present in order
5761 * so that correct localization into languages with right-to-left
5762 * reading directions can be done. Generally, applications will
5763 * let the default reading direction present, except for containers
5764 * where the containers are arranged in an order that is explicitely
5765 * visual rather than logical (such as buttons for text justification).
5767 * If the direction is set to %GTK_TEXT_DIR_NONE, then the value
5768 * set by gtk_widget_set_default_direction() will be used.
5771 gtk_widget_set_direction (GtkWidget *widget,
5772 GtkTextDirection dir)
5774 GtkTextDirection old_dir;
5776 g_return_if_fail (GTK_IS_WIDGET (widget));
5777 g_return_if_fail (dir >= GTK_TEXT_DIR_NONE && dir <= GTK_TEXT_DIR_RTL);
5779 old_dir = gtk_widget_get_direction (widget);
5781 if (dir == GTK_TEXT_DIR_NONE)
5782 GTK_PRIVATE_UNSET_FLAG (widget, GTK_DIRECTION_SET);
5785 GTK_PRIVATE_SET_FLAG (widget, GTK_DIRECTION_SET);
5786 if (dir == GTK_TEXT_DIR_LTR)
5787 GTK_PRIVATE_SET_FLAG (widget, GTK_DIRECTION_LTR);
5789 GTK_PRIVATE_UNSET_FLAG (widget, GTK_DIRECTION_LTR);
5792 if (old_dir != gtk_widget_get_direction (widget))
5793 gtk_widget_emit_direction_changed (widget, old_dir);
5797 * gtk_widget_get_direction:
5798 * @widget: a #GtkWidget
5800 * Gets the reading direction for a particular widget. See
5801 * gtk_widget_set_direction().
5803 * Return value: the reading direction for the widget.
5806 gtk_widget_get_direction (GtkWidget *widget)
5808 g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_TEXT_DIR_LTR);
5810 if (GTK_WIDGET_DIRECTION_SET (widget))
5811 return GTK_WIDGET_DIRECTION_LTR (widget) ? GTK_TEXT_DIR_LTR : GTK_TEXT_DIR_RTL;
5813 return gtk_default_direction;
5817 gtk_widget_set_default_direction_recurse (GtkWidget *widget, gpointer data)
5819 GtkTextDirection old_dir = GPOINTER_TO_UINT (data);
5821 g_object_ref (widget);
5823 if (!GTK_WIDGET_DIRECTION_SET (widget))
5824 gtk_widget_emit_direction_changed (widget, old_dir);
5826 if (GTK_IS_CONTAINER (widget))
5827 gtk_container_forall (GTK_CONTAINER (widget),
5828 gtk_widget_set_default_direction_recurse,
5831 g_object_unref (widget);
5835 * gtk_widget_set_default_direction:
5836 * @dir: the new default direction. This cannot be
5837 * %GTK_TEXT_DIR_NONE.
5839 * Sets the default reading direction for widgets where the
5840 * direction has not been explicitly set by gtk_widget_set_direction().
5843 gtk_widget_set_default_direction (GtkTextDirection dir)
5845 g_return_if_fail (dir == GTK_TEXT_DIR_RTL || dir == GTK_TEXT_DIR_LTR);
5847 if (dir != gtk_default_direction)
5849 GList *toplevels, *tmp_list;
5850 GtkTextDirection old_dir = gtk_default_direction;
5852 gtk_default_direction = dir;
5854 tmp_list = toplevels = gtk_window_list_toplevels ();
5855 g_list_foreach (toplevels, (GFunc)g_object_ref, NULL);
5859 gtk_widget_set_default_direction_recurse (tmp_list->data,
5860 GUINT_TO_POINTER (old_dir));
5861 g_object_unref (tmp_list->data);
5862 tmp_list = tmp_list->next;
5865 g_list_free (toplevels);
5870 * gtk_widget_get_default_direction:
5872 * Obtains the current default reading direction. See
5873 * gtk_widget_set_default_direction().
5875 * Return value: the current default direction.
5878 gtk_widget_get_default_direction (void)
5880 return gtk_default_direction;
5884 gtk_widget_dispose (GObject *object)
5886 GtkWidget *widget = GTK_WIDGET (object);
5889 gtk_container_remove (GTK_CONTAINER (widget->parent), widget);
5891 GTK_WIDGET_UNSET_FLAGS (widget, GTK_VISIBLE);
5892 if (GTK_WIDGET_REALIZED (widget))
5893 gtk_widget_unrealize (widget);
5895 G_OBJECT_CLASS (parent_class)->dispose (object);
5899 gtk_widget_real_destroy (GtkObject *object)
5901 /* gtk_object_destroy() will already hold a refcount on object */
5902 GtkWidget *widget = GTK_WIDGET (object);
5904 /* wipe accelerator closures (keep order) */
5905 g_object_set_qdata (G_OBJECT (widget), quark_accel_path, NULL);
5906 g_object_set_qdata (G_OBJECT (widget), quark_accel_closures, NULL);
5908 gtk_grab_remove (widget);
5910 g_object_unref (widget->style);
5911 widget->style = gtk_widget_get_default_style ();
5912 g_object_ref (widget->style);
5914 GTK_OBJECT_CLASS (parent_class)->destroy (object);
5918 gtk_widget_finalize (GObject *object)
5920 GtkWidget *widget = GTK_WIDGET (object);
5921 GtkWidgetAuxInfo *aux_info;
5923 GdkExtensionMode *mode;
5924 GtkAccessible *accessible;
5926 gtk_grab_remove (widget);
5928 g_object_unref (widget->style);
5929 widget->style = NULL;
5932 g_free (widget->name);
5934 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
5936 gtk_widget_aux_info_destroy (aux_info);
5938 events = g_object_get_qdata (G_OBJECT (widget), quark_event_mask);
5942 mode = g_object_get_qdata (G_OBJECT (widget), quark_extension_event_mode);
5946 accessible = g_object_get_qdata (G_OBJECT (widget), quark_accessible_object);
5948 g_object_unref (accessible);
5950 G_OBJECT_CLASS (parent_class)->finalize (object);
5953 /*****************************************
5954 * gtk_widget_real_map:
5959 *****************************************/
5962 gtk_widget_real_map (GtkWidget *widget)
5964 g_return_if_fail (GTK_WIDGET_REALIZED (widget) == TRUE);
5966 if (!GTK_WIDGET_MAPPED (widget))
5968 GTK_WIDGET_SET_FLAGS (widget, GTK_MAPPED);
5970 if (!GTK_WIDGET_NO_WINDOW (widget))
5971 gdk_window_show (widget->window);
5975 /*****************************************
5976 * gtk_widget_real_unmap:
5981 *****************************************/
5984 gtk_widget_real_unmap (GtkWidget *widget)
5986 if (GTK_WIDGET_MAPPED (widget))
5988 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
5990 if (!GTK_WIDGET_NO_WINDOW (widget))
5991 gdk_window_hide (widget->window);
5995 /*****************************************
5996 * gtk_widget_real_realize:
6001 *****************************************/
6004 gtk_widget_real_realize (GtkWidget *widget)
6006 g_return_if_fail (GTK_WIDGET_NO_WINDOW (widget));
6008 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
6011 widget->window = gtk_widget_get_parent_window (widget);
6012 g_object_ref (widget->window);
6014 widget->style = gtk_style_attach (widget->style, widget->window);
6017 /*****************************************
6018 * gtk_widget_real_unrealize:
6023 *****************************************/
6026 gtk_widget_real_unrealize (GtkWidget *widget)
6028 if (GTK_WIDGET_MAPPED (widget))
6029 gtk_widget_real_unmap (widget);
6031 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
6033 /* printf ("unrealizing %s\n", g_type_name (G_TYPE_FROM_INSTANCE (widget)));
6036 /* We must do unrealize child widget BEFORE container widget.
6037 * gdk_window_destroy() destroys specified xwindow and its sub-xwindows.
6038 * So, unrealizing container widget bofore its children causes the problem
6039 * (for example, gdk_ic_destroy () with destroyed window causes crash. )
6042 if (GTK_IS_CONTAINER (widget))
6043 gtk_container_forall (GTK_CONTAINER (widget),
6044 (GtkCallback) gtk_widget_unrealize,
6047 gtk_style_detach (widget->style);
6048 if (!GTK_WIDGET_NO_WINDOW (widget))
6050 gdk_window_set_user_data (widget->window, NULL);
6051 gdk_window_destroy (widget->window);
6052 widget->window = NULL;
6056 g_object_unref (widget->window);
6057 widget->window = NULL;
6060 gtk_selection_remove_all (widget);
6062 GTK_WIDGET_UNSET_FLAGS (widget, GTK_REALIZED);
6066 gtk_widget_real_size_request (GtkWidget *widget,
6067 GtkRequisition *requisition)
6069 requisition->width = widget->requisition.width;
6070 requisition->height = widget->requisition.height;
6074 * _gtk_widget_peek_colormap:
6076 * Returns colormap currently pushed by gtk_widget_push_colormap, if any.
6078 * Return value: the currently pushed colormap, or %NULL if there is none.
6081 _gtk_widget_peek_colormap (void)
6084 return (GdkColormap*) colormap_stack->data;
6089 gtk_widget_propagate_state (GtkWidget *widget,
6094 /* don't call this function with state==GTK_STATE_INSENSITIVE,
6095 * parent_sensitive==TRUE on a sensitive widget
6098 old_state = GTK_WIDGET_STATE (widget);
6100 if (data->parent_sensitive)
6102 GTK_WIDGET_SET_FLAGS (widget, GTK_PARENT_SENSITIVE);
6104 if (GTK_WIDGET_IS_SENSITIVE (widget))
6106 if (data->state_restoration)
6107 GTK_WIDGET_STATE (widget) = GTK_WIDGET_SAVED_STATE (widget);
6109 GTK_WIDGET_STATE (widget) = data->state;
6113 GTK_WIDGET_STATE (widget) = GTK_STATE_INSENSITIVE;
6114 if (!data->state_restoration &&
6115 data->state != GTK_STATE_INSENSITIVE)
6116 GTK_WIDGET_SAVED_STATE (widget) = data->state;
6121 GTK_WIDGET_UNSET_FLAGS (widget, GTK_PARENT_SENSITIVE);
6122 if (!data->state_restoration)
6124 if (data->state != GTK_STATE_INSENSITIVE)
6125 GTK_WIDGET_SAVED_STATE (widget) = data->state;
6127 else if (GTK_WIDGET_STATE (widget) != GTK_STATE_INSENSITIVE)
6128 GTK_WIDGET_SAVED_STATE (widget) = GTK_WIDGET_STATE (widget);
6129 GTK_WIDGET_STATE (widget) = GTK_STATE_INSENSITIVE;
6132 if (gtk_widget_is_focus (widget) && !GTK_WIDGET_IS_SENSITIVE (widget))
6136 window = gtk_widget_get_toplevel (widget);
6137 if (window && GTK_WIDGET_TOPLEVEL (window))
6138 gtk_window_set_focus (GTK_WINDOW (window), NULL);
6141 if (old_state != GTK_WIDGET_STATE (widget))
6143 g_object_ref (widget);
6145 if (!GTK_WIDGET_IS_SENSITIVE (widget) && GTK_WIDGET_HAS_GRAB (widget))
6146 gtk_grab_remove (widget);
6148 g_signal_emit (widget, widget_signals[STATE_CHANGED], 0, old_state);
6150 if (GTK_IS_CONTAINER (widget))
6152 data->parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget) != FALSE);
6153 data->state = GTK_WIDGET_STATE (widget);
6154 if (data->use_forall)
6155 gtk_container_forall (GTK_CONTAINER (widget),
6156 (GtkCallback) gtk_widget_propagate_state,
6159 gtk_container_foreach (GTK_CONTAINER (widget),
6160 (GtkCallback) gtk_widget_propagate_state,
6163 g_object_unref (widget);
6168 * _gtk_widget_get_aux_info:
6169 * @widget: a #GtkWidget
6170 * @create: if %TRUE, create the structure if it doesn't exist
6172 * Get the #GtkWidgetAuxInfo structure for the widget.
6174 * Return value: the #GtkAuxInfo structure for the widget, or
6175 * %NULL if @create is %FALSE and one doesn't already exist.
6178 _gtk_widget_get_aux_info (GtkWidget *widget,
6181 GtkWidgetAuxInfo *aux_info;
6183 aux_info = g_object_get_qdata (G_OBJECT (widget), quark_aux_info);
6184 if (!aux_info && create)
6186 if (!aux_info_mem_chunk)
6187 aux_info_mem_chunk = g_mem_chunk_new ("widget aux info mem chunk",
6188 sizeof (GtkWidgetAuxInfo),
6189 1024, G_ALLOC_AND_FREE);
6190 aux_info = g_chunk_new (GtkWidgetAuxInfo, aux_info_mem_chunk);
6192 aux_info->width = -1;
6193 aux_info->height = -1;
6196 aux_info->x_set = FALSE;
6197 aux_info->y_set = FALSE;
6198 g_object_set_qdata (G_OBJECT (widget), quark_aux_info, aux_info);
6204 /*****************************************
6205 * gtk_widget_aux_info_destroy:
6210 *****************************************/
6213 gtk_widget_aux_info_destroy (GtkWidgetAuxInfo *aux_info)
6215 g_mem_chunk_free (aux_info_mem_chunk, aux_info);
6219 gtk_widget_shape_info_destroy (GtkWidgetShapeInfo *info)
6221 g_object_unref (info->shape_mask);
6226 * gtk_widget_shape_combine_mask:
6227 * @widget: a #GtkWidget.
6228 * @shape_mask: shape to be added, or %NULL to remove an existing shape.
6229 * @offset_x: X position of shape mask with respect to @window.
6230 * @offset_y: Y position of shape mask with respect to @window.
6232 * Sets a shape for this widget's GDK window. This allows for
6233 * transparent windows etc., see gdk_window_shape_combine_mask()
6234 * for more information.
6237 gtk_widget_shape_combine_mask (GtkWidget *widget,
6238 GdkBitmap *shape_mask,
6242 GtkWidgetShapeInfo* shape_info;
6244 g_return_if_fail (GTK_IS_WIDGET (widget));
6245 /* set_shape doesn't work on widgets without gdk window */
6246 g_return_if_fail (!GTK_WIDGET_NO_WINDOW (widget));
6250 GTK_PRIVATE_UNSET_FLAG (widget, GTK_HAS_SHAPE_MASK);
6253 gdk_window_shape_combine_mask (widget->window, NULL, 0, 0);
6255 g_object_set_qdata (G_OBJECT (widget), quark_shape_info, NULL);
6259 GTK_PRIVATE_SET_FLAG (widget, GTK_HAS_SHAPE_MASK);
6261 shape_info = g_new (GtkWidgetShapeInfo, 1);
6262 g_object_set_qdata_full (G_OBJECT (widget), quark_shape_info, shape_info,
6263 (GDestroyNotify) gtk_widget_shape_info_destroy);
6265 shape_info->shape_mask = g_object_ref (shape_mask);
6266 shape_info->offset_x = offset_x;
6267 shape_info->offset_y = offset_y;
6269 /* set shape if widget has a gdk window allready.
6270 * otherwise the shape is scheduled to be set by gtk_widget_realize.
6273 gdk_window_shape_combine_mask (widget->window, shape_mask,
6274 offset_x, offset_y);
6279 gtk_reset_shapes_recurse (GtkWidget *widget,
6285 gdk_window_get_user_data (window, &data);
6289 gdk_window_shape_combine_mask (window, NULL, 0, 0);
6290 for (list = gdk_window_peek_children (window); list; list = list->next)
6291 gtk_reset_shapes_recurse (widget, list->data);
6295 * gtk_widget_reset_shapes:
6296 * @widget: a #GtkWidget.
6298 * Recursively resets the shape on this widget and its descendants.
6301 gtk_widget_reset_shapes (GtkWidget *widget)
6303 g_return_if_fail (GTK_IS_WIDGET (widget));
6304 g_return_if_fail (GTK_WIDGET_REALIZED (widget));
6306 if (!GTK_WIDGET_HAS_SHAPE_MASK (widget))
6307 gtk_reset_shapes_recurse (widget, widget->window);
6312 * @widget: a #GtkWidget
6314 * Adds a reference to a widget. This function is exactly the same
6315 * as calling g_object_ref(), and exists mostly for historical
6316 * reasons. It can still be convenient to avoid casting a widget
6317 * to a #GObject, it saves a small amount of typing.
6319 * Return value: the widget that was referenced
6322 gtk_widget_ref (GtkWidget *widget)
6324 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6326 return (GtkWidget*) g_object_ref ((GObject*) widget);
6331 * @widget: a #GtkWidget
6333 * Inverse of gtk_widget_ref(). Equivalent to g_object_unref().
6337 gtk_widget_unref (GtkWidget *widget)
6339 g_return_if_fail (GTK_IS_WIDGET (widget));
6341 g_object_unref ((GObject*) widget);
6349 gtk_widget_class_install_style_property_parser (GtkWidgetClass *class,
6351 GtkRcPropertyParser parser)
6353 g_return_if_fail (GTK_IS_WIDGET_CLASS (class));
6354 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
6355 g_return_if_fail (pspec->flags & G_PARAM_READABLE);
6356 g_return_if_fail (!(pspec->flags & (G_PARAM_CONSTRUCT_ONLY | G_PARAM_CONSTRUCT)));
6358 if (g_param_spec_pool_lookup (style_property_spec_pool, pspec->name, G_OBJECT_CLASS_TYPE (class), FALSE))
6360 g_warning (G_STRLOC ": class `%s' already contains a style property named `%s'",
6361 G_OBJECT_CLASS_NAME (class),
6366 g_param_spec_ref (pspec);
6367 g_param_spec_sink (pspec);
6368 g_param_spec_set_qdata (pspec, quark_property_parser, (gpointer) parser);
6369 g_param_spec_pool_insert (style_property_spec_pool, pspec, G_OBJECT_CLASS_TYPE (class));
6373 gtk_widget_class_install_style_property (GtkWidgetClass *class,
6376 GtkRcPropertyParser parser;
6378 g_return_if_fail (GTK_IS_WIDGET_CLASS (class));
6379 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
6381 parser = _gtk_rc_property_parser_from_type (G_PARAM_SPEC_VALUE_TYPE (pspec));
6383 gtk_widget_class_install_style_property_parser (class, pspec, parser);
6387 * gtk_widget_class_find_style_property:
6388 * @klass: a #GtkWidgetClass
6389 * @property_name: the name of the style property to find
6390 * @returns: the #GParamSpec of the style property or %NULL if @class has ho
6391 * style property with that name.
6393 * Finds a style property of a widget class by name.
6396 gtk_widget_class_find_style_property (GtkWidgetClass *klass,
6397 const gchar *property_name)
6399 g_return_val_if_fail (property_name != NULL, NULL);
6401 return g_param_spec_pool_lookup (style_property_spec_pool,
6403 G_OBJECT_CLASS_TYPE (klass),
6408 * gtk_widget_class_list_style_properties:
6409 * @klass: a #GtkWidgetClass
6410 * @n_properties: location to return the number of style properties found
6411 * @returns: an newly allocated array of #GParamSpec*. The array must be freed with g_free().
6413 * Returns all style properties of a widget class.
6416 gtk_widget_class_list_style_properties (GtkWidgetClass *klass,
6417 guint *n_properties)
6419 GParamSpec **pspecs;
6422 pspecs = g_param_spec_pool_list (style_property_spec_pool,
6423 G_OBJECT_CLASS_TYPE (klass),
6432 * gtk_widget_style_get_property:
6433 * @widget: a #GtkWidget
6434 * @property_name: the name of a style property
6435 * @value: location to return the property value
6437 * Gets the value of a style property of @widget.
6440 gtk_widget_style_get_property (GtkWidget *widget,
6441 const gchar *property_name,
6446 g_return_if_fail (GTK_IS_WIDGET (widget));
6447 g_return_if_fail (property_name != NULL);
6448 g_return_if_fail (G_IS_VALUE (value));
6450 g_object_ref (widget);
6451 pspec = g_param_spec_pool_lookup (style_property_spec_pool,
6453 G_OBJECT_TYPE (widget),
6456 g_warning ("%s: widget class `%s' has no property named `%s'",
6458 G_OBJECT_TYPE_NAME (widget),
6462 const GValue *peek_value;
6464 peek_value = _gtk_style_peek_property_value (widget->style,
6465 G_OBJECT_TYPE (widget),
6467 (GtkRcPropertyParser) g_param_spec_get_qdata (pspec, quark_property_parser));
6469 /* auto-conversion of the caller's value type
6471 if (G_VALUE_TYPE (value) == G_PARAM_SPEC_VALUE_TYPE (pspec))
6472 g_value_copy (peek_value, value);
6473 else if (g_value_type_transformable (G_PARAM_SPEC_VALUE_TYPE (pspec), G_VALUE_TYPE (value)))
6474 g_value_transform (peek_value, value);
6476 g_warning ("can't retrieve style property `%s' of type `%s' as value of type `%s'",
6478 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
6479 G_VALUE_TYPE_NAME (value));
6481 g_object_unref (widget);
6485 * gtk_widget_style_get_valist:
6486 * @widget: a #GtkWidget
6487 * @first_property_name: the name of the first property to get
6488 * @var_args: a <type>va_list</type> of pairs of property names and
6489 * locations to return the property values, starting with the location
6490 * for @first_property_name.
6492 * Non-vararg variant of gtk_widget_style_get(). Used primarily by language
6496 gtk_widget_style_get_valist (GtkWidget *widget,
6497 const gchar *first_property_name,
6502 g_return_if_fail (GTK_IS_WIDGET (widget));
6504 g_object_ref (widget);
6506 name = first_property_name;
6509 const GValue *peek_value;
6513 pspec = g_param_spec_pool_lookup (style_property_spec_pool,
6515 G_OBJECT_TYPE (widget),
6519 g_warning ("%s: widget class `%s' has no property named `%s'",
6521 G_OBJECT_TYPE_NAME (widget),
6525 /* style pspecs are always readable so we can spare that check here */
6527 peek_value = _gtk_style_peek_property_value (widget->style,
6528 G_OBJECT_TYPE (widget),
6530 (GtkRcPropertyParser) g_param_spec_get_qdata (pspec, quark_property_parser));
6531 G_VALUE_LCOPY (peek_value, var_args, 0, &error);
6534 g_warning ("%s: %s", G_STRLOC, error);
6539 name = va_arg (var_args, gchar*);
6542 g_object_unref (widget);
6546 * gtk_widget_style_get:
6547 * @widget: a #GtkWidget
6548 * @first_property_name: the name of the first property to get
6549 * @Varargs: pairs of property names and locations to
6550 * return the property values, starting with the location for
6551 * @first_property_name, terminated by %NULL.
6553 * Gets the values of a multiple style properties of @widget.
6556 gtk_widget_style_get (GtkWidget *widget,
6557 const gchar *first_property_name,
6562 g_return_if_fail (GTK_IS_WIDGET (widget));
6564 va_start (var_args, first_property_name);
6565 gtk_widget_style_get_valist (widget, first_property_name, var_args);
6571 * @widget: a #GtkWidget
6572 * @path_length: location to store length of the path, or %NULL
6573 * @path: location to store allocated path string, or %NULL
6574 * @path_reversed: location to store allocated reverse path string, or %NULL
6576 * Obtains the full path to @widget. The path is simply the name of a
6577 * widget and all its parents in the container hierarchy, separated by
6578 * periods. The name of a widget comes from
6579 * gtk_widget_get_name(). Paths are used to apply styles to a widget
6580 * in gtkrc configuration files. Widget names are the type of the
6581 * widget by default (e.g. "GtkButton") or can be set to an
6582 * application-specific value with gtk_widget_set_name(). By setting
6583 * the name of a widget, you allow users or theme authors to apply
6584 * styles to that specific widget in their gtkrc
6585 * file. @path_reversed_p fills in the path in reverse order,
6586 * i.e. starting with @widget's name instead of starting with the name
6587 * of @widget's outermost ancestor.
6591 gtk_widget_path (GtkWidget *widget,
6594 gchar **path_reversed)
6596 static gchar *rev_path = NULL;
6597 static guint tmp_path_len = 0;
6600 g_return_if_fail (GTK_IS_WIDGET (widget));
6605 const gchar *string;
6610 string = gtk_widget_get_name (widget);
6611 l = strlen (string);
6612 while (tmp_path_len <= len + l + 1)
6614 tmp_path_len += INIT_PATH_SIZE;
6615 rev_path = g_realloc (rev_path, tmp_path_len);
6623 widget = widget->parent;
6626 rev_path[len++] = '.';
6628 rev_path[len++] = 0;
6633 *path_length = len - 1;
6635 *path_reversed = g_strdup (rev_path);
6638 *path = g_strdup (rev_path);
6639 g_strreverse (*path);
6644 * gtk_widget_class_path:
6645 * @widget: a #GtkWidget
6646 * @path_length: location to store the length of the class path, or %NULL
6647 * @path: location to store the class path as an allocated string, or %NULL
6648 * @path_reversed: location to store the reverse class path as an allocated string, or %NULL
6650 * Same as gtk_widget_path(), but always uses the name of a widget's type,
6651 * never uses a custom name set with gtk_widget_set_name().
6655 gtk_widget_class_path (GtkWidget *widget,
6658 gchar **path_reversed)
6660 static gchar *rev_path = NULL;
6661 static guint tmp_path_len = 0;
6664 g_return_if_fail (GTK_IS_WIDGET (widget));
6669 const gchar *string;
6674 string = g_type_name (GTK_WIDGET_TYPE (widget));
6675 l = strlen (string);
6676 while (tmp_path_len <= len + l + 1)
6678 tmp_path_len += INIT_PATH_SIZE;
6679 rev_path = g_realloc (rev_path, tmp_path_len);
6687 widget = widget->parent;
6690 rev_path[len++] = '.';
6692 rev_path[len++] = 0;
6697 *path_length = len - 1;
6699 *path_reversed = g_strdup (rev_path);
6702 *path = g_strdup (rev_path);
6703 g_strreverse (*path);
6708 * gtk_requisition_copy:
6709 * @requisition: a #GtkRequisition.
6710 * @returns: a copy of @requisition.
6712 * Copies a #GtkRequisition.
6715 gtk_requisition_copy (const GtkRequisition *requisition)
6717 return (GtkRequisition *)g_memdup (requisition, sizeof (GtkRequisition));
6721 * gtk_requisition_free:
6722 * @requisition: a #GtkRequisition.
6724 * Frees a #GtkRequisition.
6727 gtk_requisition_free (GtkRequisition *requisition)
6729 g_free (requisition);
6733 gtk_requisition_get_type (void)
6735 static GType our_type = 0;
6738 our_type = g_boxed_type_register_static ("GtkRequisition",
6739 (GBoxedCopyFunc) gtk_requisition_copy,
6740 (GBoxedFreeFunc) gtk_requisition_free);
6746 gtk_widget_get_accessible (GtkWidget *widget)
6748 GtkWidgetClass *klass;
6750 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6752 klass = GTK_WIDGET_GET_CLASS (widget);
6754 g_return_val_if_fail (klass->get_accessible != NULL, NULL);
6756 return klass->get_accessible (widget);
6760 gtk_widget_real_get_accessible (GtkWidget *widget)
6762 AtkObject* accessible;
6764 accessible = g_object_get_qdata (G_OBJECT (widget),
6765 quark_accessible_object);
6768 AtkObjectFactory *factory;
6769 AtkRegistry *default_registry;
6771 default_registry = atk_get_default_registry ();
6772 factory = atk_registry_get_factory (default_registry,
6773 G_TYPE_FROM_INSTANCE (widget));
6775 atk_object_factory_create_accessible (factory,
6777 g_object_set_qdata (G_OBJECT (widget),
6778 quark_accessible_object,
6785 * Initialize a AtkImplementorIface instance's virtual pointers as
6786 * appropriate to this implementor's class (GtkWidget).
6789 gtk_widget_accessible_interface_init (AtkImplementorIface *iface)
6791 iface->ref_accessible = gtk_widget_ref_accessible;
6795 gtk_widget_ref_accessible (AtkImplementor *implementor)
6797 AtkObject *accessible;
6799 accessible = gtk_widget_get_accessible (GTK_WIDGET (implementor));
6801 g_object_ref (accessible);
6806 * gtk_widget_get_clipboard:
6807 * @widget: a #GtkWidget
6808 * @selection: a #GdkAtom which identifies the clipboard
6809 * to use. %GDK_SELECTION_CLIPBOARD gives the
6810 * default clipboard. Another common value
6811 * is %GDK_SELECTION_PRIMARY, which gives
6812 * the primary X selection.
6814 * Returns the clipboard object for the given selection to
6815 * be used with @widget. @widget must have a #GdkDisplay
6816 * associated with it, so must be attached to a toplevel
6819 * Return value: the appropriate clipboard object. If no
6820 * clipboard already exists, a new one will
6821 * be created. Once a clipboard object has
6822 * been created, it is persistent for all time.
6825 gtk_widget_get_clipboard (GtkWidget *widget, GdkAtom selection)
6827 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6828 g_return_val_if_fail (gtk_widget_has_screen (widget), NULL);
6830 return gtk_clipboard_get_for_display (gtk_widget_get_display (widget),