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 "gtkiconfactory.h"
36 #include "gtkselection.h"
37 #include "gtksettings.h"
38 #include "gtksizegroup.h"
39 #include "gtksignal.h"
40 #include "gtkwidget.h"
41 #include "gtkwindow.h"
42 #include "gtkbindings.h"
43 #include "gtkprivate.h"
45 #include "gdk/gdkprivate.h" /* Used in gtk_reset_shapes_recurse to avoid copy */
46 #include <gobject/gvaluecollector.h>
47 #include <gobject/gobjectnotifyqueue.c>
48 #include "gdk/gdkkeysyms.h"
50 #include "gtkaccessible.h"
51 #include "gtktooltips.h"
53 #define WIDGET_CLASS(w) GTK_WIDGET_GET_CLASS (w)
54 #define INIT_PATH_SIZE (512)
94 PROPERTY_NOTIFY_EVENT,
95 SELECTION_CLEAR_EVENT,
96 SELECTION_REQUEST_EVENT,
97 SELECTION_NOTIFY_EVENT,
112 VISIBILITY_NOTIFY_EVENT,
116 ACCEL_CLOSURES_CHANGED,
133 PROP_RECEIVES_DEFAULT,
134 PROP_COMPOSITE_CHILD,
137 PROP_EXTENSION_EVENTS
140 typedef struct _GtkStateData GtkStateData;
145 guint state_restoration : 1;
146 guint parent_sensitive : 1;
147 guint use_forall : 1;
151 /* --- prototypes --- */
152 static void gtk_widget_class_init (GtkWidgetClass *klass);
153 static void gtk_widget_init (GtkWidget *widget);
154 static void gtk_widget_set_property (GObject *object,
158 static void gtk_widget_get_property (GObject *object,
162 static void gtk_widget_dispose (GObject *object);
163 static void gtk_widget_real_destroy (GtkObject *object);
164 static void gtk_widget_finalize (GObject *object);
165 static void gtk_widget_real_show (GtkWidget *widget);
166 static void gtk_widget_real_hide (GtkWidget *widget);
167 static void gtk_widget_real_map (GtkWidget *widget);
168 static void gtk_widget_real_unmap (GtkWidget *widget);
169 static void gtk_widget_real_realize (GtkWidget *widget);
170 static void gtk_widget_real_unrealize (GtkWidget *widget);
171 static void gtk_widget_real_size_request (GtkWidget *widget,
172 GtkRequisition *requisition);
173 static void gtk_widget_real_size_allocate (GtkWidget *widget,
174 GtkAllocation *allocation);
175 static void gtk_widget_style_set (GtkWidget *widget,
176 GtkStyle *previous_style);
177 static void gtk_widget_direction_changed (GtkWidget *widget,
178 GtkTextDirection previous_direction);
180 static void gtk_widget_real_grab_focus (GtkWidget *focus_widget);
181 static void gtk_widget_real_show_help (GtkWidget *widget,
182 GtkWidgetHelpType help_type);
184 static void gtk_widget_dispatch_child_properties_changed (GtkWidget *object,
186 GParamSpec **pspecs);
187 static gboolean gtk_widget_real_key_press_event (GtkWidget *widget,
189 static gboolean gtk_widget_real_key_release_event (GtkWidget *widget,
191 static gboolean gtk_widget_real_focus_in_event (GtkWidget *widget,
192 GdkEventFocus *event);
193 static gboolean gtk_widget_real_focus_out_event (GtkWidget *widget,
194 GdkEventFocus *event);
195 static gboolean gtk_widget_real_focus (GtkWidget *widget,
196 GtkDirectionType direction);
197 static PangoContext* gtk_widget_peek_pango_context (GtkWidget *widget);
198 static void gtk_widget_reparent_container_child (GtkWidget *widget,
199 gpointer client_data);
200 static void gtk_widget_propagate_state (GtkWidget *widget,
202 static void gtk_widget_reset_rc_style (GtkWidget *widget);
203 static void gtk_widget_set_style_internal (GtkWidget *widget,
205 gboolean initial_emission);
206 static void gtk_widget_set_style_recurse (GtkWidget *widget,
207 gpointer client_data);
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 GdkColormap *default_colormap = NULL;
225 static GtkStyle *gtk_default_style = NULL;
226 static GSList *colormap_stack = NULL;
227 static guint composite_child_stack = 0;
228 static GtkTextDirection gtk_default_direction = GTK_TEXT_DIR_LTR;
229 static GParamSpecPool *style_property_spec_pool = NULL;
231 static GQuark quark_property_parser = 0;
232 static GQuark quark_aux_info = 0;
233 static GQuark quark_accel_path = 0;
234 static GQuark quark_accel_closures = 0;
235 static GQuark quark_event_mask = 0;
236 static GQuark quark_extension_event_mode = 0;
237 static GQuark quark_parent_window = 0;
238 static GQuark quark_shape_info = 0;
239 static GQuark quark_colormap = 0;
240 static GQuark quark_pango_context = 0;
241 static GQuark quark_rc_style = 0;
242 static GQuark quark_accessible_object = 0;
243 GParamSpecPool *_gtk_widget_child_property_pool = NULL;
244 GObjectNotifyContext *_gtk_widget_child_property_notify_context = NULL;
246 /* --- functions --- */
248 gtk_widget_get_type (void)
250 static GtkType widget_type = 0;
254 static const GtkTypeInfo widget_info =
258 sizeof (GtkWidgetClass),
259 (GtkClassInitFunc) gtk_widget_class_init,
260 (GtkObjectInitFunc) gtk_widget_init,
261 /* reserved_1 */ NULL,
262 /* reserved_2 */ NULL,
263 (GtkClassInitFunc) NULL,
266 static const GInterfaceInfo accessibility_info =
268 (GInterfaceInitFunc) gtk_widget_accessible_interface_init,
269 (GInterfaceFinalizeFunc) NULL,
270 NULL /* interface data */
274 widget_type = gtk_type_unique (GTK_TYPE_OBJECT, &widget_info);
276 g_type_add_interface_static (widget_type, ATK_TYPE_IMPLEMENTOR,
277 &accessibility_info) ;
285 child_property_notify_dispatcher (GObject *object,
289 GTK_WIDGET_GET_CLASS (object)->dispatch_child_properties_changed (GTK_WIDGET (object), n_pspecs, pspecs);
293 gtk_widget_class_init (GtkWidgetClass *klass)
295 static GObjectNotifyContext cpn_context = { 0, NULL, NULL };
296 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
297 GtkObjectClass *object_class = GTK_OBJECT_CLASS (klass);
298 GtkBindingSet *binding_set;
300 parent_class = g_type_class_peek_parent (klass);
302 quark_property_parser = g_quark_from_static_string ("gtk-rc-property-parser");
303 quark_aux_info = g_quark_from_static_string ("gtk-aux-info");
304 quark_accel_path = g_quark_from_static_string ("gtk-accel-path");
305 quark_accel_closures = g_quark_from_static_string ("gtk-accel-closures");
306 quark_event_mask = g_quark_from_static_string ("gtk-event-mask");
307 quark_extension_event_mode = g_quark_from_static_string ("gtk-extension-event-mode");
308 quark_parent_window = g_quark_from_static_string ("gtk-parent-window");
309 quark_shape_info = g_quark_from_static_string ("gtk-shape-info");
310 quark_colormap = g_quark_from_static_string ("gtk-colormap");
311 quark_pango_context = g_quark_from_static_string ("gtk-pango-context");
312 quark_rc_style = g_quark_from_static_string ("gtk-rc-style");
313 quark_accessible_object = g_quark_from_static_string ("gtk-accessible-object");
315 style_property_spec_pool = g_param_spec_pool_new (FALSE);
316 _gtk_widget_child_property_pool = g_param_spec_pool_new (TRUE);
317 cpn_context.quark_notify_queue = g_quark_from_static_string ("GtkWidget-child-property-notify-queue");
318 cpn_context.dispatcher = child_property_notify_dispatcher;
319 _gtk_widget_child_property_notify_context = &cpn_context;
321 gobject_class->dispose = gtk_widget_dispose;
322 gobject_class->finalize = gtk_widget_finalize;
323 gobject_class->set_property = gtk_widget_set_property;
324 gobject_class->get_property = gtk_widget_get_property;
326 object_class->destroy = gtk_widget_real_destroy;
328 klass->activate_signal = 0;
329 klass->set_scroll_adjustments_signal = 0;
330 klass->dispatch_child_properties_changed = gtk_widget_dispatch_child_properties_changed;
331 klass->show = gtk_widget_real_show;
332 klass->show_all = gtk_widget_show;
333 klass->hide = gtk_widget_real_hide;
334 klass->hide_all = gtk_widget_hide;
335 klass->map = gtk_widget_real_map;
336 klass->unmap = gtk_widget_real_unmap;
337 klass->realize = gtk_widget_real_realize;
338 klass->unrealize = gtk_widget_real_unrealize;
339 klass->size_request = gtk_widget_real_size_request;
340 klass->size_allocate = gtk_widget_real_size_allocate;
341 klass->state_changed = NULL;
342 klass->parent_set = NULL;
343 klass->hierarchy_changed = NULL;
344 klass->style_set = gtk_widget_style_set;
345 klass->direction_changed = gtk_widget_direction_changed;
346 klass->grab_notify = NULL;
347 klass->child_notify = NULL;
348 klass->mnemonic_activate = gtk_widget_real_mnemonic_activate;
349 klass->grab_focus = gtk_widget_real_grab_focus;
350 klass->focus = gtk_widget_real_focus;
352 klass->button_press_event = NULL;
353 klass->button_release_event = NULL;
354 klass->motion_notify_event = NULL;
355 klass->delete_event = NULL;
356 klass->destroy_event = NULL;
357 klass->expose_event = NULL;
358 klass->key_press_event = gtk_widget_real_key_press_event;
359 klass->key_release_event = gtk_widget_real_key_release_event;
360 klass->enter_notify_event = NULL;
361 klass->leave_notify_event = NULL;
362 klass->configure_event = NULL;
363 klass->focus_in_event = gtk_widget_real_focus_in_event;
364 klass->focus_out_event = gtk_widget_real_focus_out_event;
365 klass->map_event = NULL;
366 klass->unmap_event = NULL;
367 klass->window_state_event = NULL;
368 klass->property_notify_event = gtk_selection_property_notify;
369 klass->selection_clear_event = gtk_selection_clear;
370 klass->selection_request_event = gtk_selection_request;
371 klass->selection_notify_event = gtk_selection_notify;
372 klass->selection_received = NULL;
373 klass->proximity_in_event = NULL;
374 klass->proximity_out_event = NULL;
375 klass->drag_begin = NULL;
376 klass->drag_end = NULL;
377 klass->drag_data_delete = NULL;
378 klass->drag_leave = NULL;
379 klass->drag_motion = NULL;
380 klass->drag_drop = NULL;
381 klass->drag_data_received = NULL;
383 klass->show_help = gtk_widget_real_show_help;
385 /* Accessibility support */
386 klass->get_accessible = gtk_widget_real_get_accessible;
388 klass->no_expose_event = NULL;
390 g_object_class_install_property (gobject_class,
392 g_param_spec_string ("name",
394 _("The name of the widget"),
397 g_object_class_install_property (gobject_class,
399 g_param_spec_object ("parent",
401 _("The parent widget of this widget. Must be a Container widget."),
405 g_object_class_install_property (gobject_class,
407 g_param_spec_int ("width_request",
409 _("Override for width request of the widget, or -1 if natural request should be used."),
414 g_object_class_install_property (gobject_class,
416 g_param_spec_int ("height_request",
418 _("Override for height request of the widget, or -1 if natural request should be used."),
423 g_object_class_install_property (gobject_class,
425 g_param_spec_boolean ("visible",
427 _("Whether the widget is visible"),
430 g_object_class_install_property (gobject_class,
432 g_param_spec_boolean ("sensitive",
434 _("Whether the widget responds to input"),
437 g_object_class_install_property (gobject_class,
439 g_param_spec_boolean ("app_paintable",
440 _("Application paintable"),
441 _("Whether the application will paint directly on the widget"),
444 g_object_class_install_property (gobject_class,
446 g_param_spec_boolean ("can_focus",
448 _("Whether the widget can accept the input focus"),
451 g_object_class_install_property (gobject_class,
453 g_param_spec_boolean ("has_focus",
455 _("Whether the widget has the input focus"),
458 g_object_class_install_property (gobject_class,
460 g_param_spec_boolean ("can_default",
462 _("Whether the widget can be the default widget"),
465 g_object_class_install_property (gobject_class,
467 g_param_spec_boolean ("has_default",
469 _("Whether the widget is the default widget"),
472 g_object_class_install_property (gobject_class,
473 PROP_RECEIVES_DEFAULT,
474 g_param_spec_boolean ("receives_default",
475 _("Receives default"),
476 _("If TRUE, the widget will receive the default action when it is focused."),
479 g_object_class_install_property (gobject_class,
480 PROP_COMPOSITE_CHILD,
481 g_param_spec_boolean ("composite_child",
482 _("Composite child"),
483 _("Whether the widget is composed of other widgets"),
486 g_object_class_install_property (gobject_class,
488 g_param_spec_object ("style",
490 _("The style of the widget, which contains information about how it will look (colors etc)."),
493 g_object_class_install_property (gobject_class,
495 g_param_spec_flags ("events",
497 _("The event mask that decides what kind of GdkEvents this widget gets."),
501 g_object_class_install_property (gobject_class,
502 PROP_EXTENSION_EVENTS,
503 g_param_spec_enum ("extension_events",
504 _("Extension events"),
505 _("The mask that decides what kind of extension events this widget gets."),
506 GDK_TYPE_EXTENSION_MODE,
507 GDK_EXTENSION_EVENTS_NONE,
509 widget_signals[SHOW] =
510 gtk_signal_new ("show",
512 GTK_CLASS_TYPE (object_class),
513 GTK_SIGNAL_OFFSET (GtkWidgetClass, show),
514 gtk_marshal_VOID__VOID,
516 widget_signals[HIDE] =
517 gtk_signal_new ("hide",
519 GTK_CLASS_TYPE (object_class),
520 GTK_SIGNAL_OFFSET (GtkWidgetClass, hide),
521 gtk_marshal_VOID__VOID,
523 widget_signals[MAP] =
524 gtk_signal_new ("map",
526 GTK_CLASS_TYPE (object_class),
527 GTK_SIGNAL_OFFSET (GtkWidgetClass, map),
528 gtk_marshal_VOID__VOID,
530 widget_signals[UNMAP] =
531 gtk_signal_new ("unmap",
533 GTK_CLASS_TYPE (object_class),
534 GTK_SIGNAL_OFFSET (GtkWidgetClass, unmap),
535 gtk_marshal_VOID__VOID,
537 widget_signals[REALIZE] =
538 gtk_signal_new ("realize",
540 GTK_CLASS_TYPE (object_class),
541 GTK_SIGNAL_OFFSET (GtkWidgetClass, realize),
542 gtk_marshal_VOID__VOID,
544 widget_signals[UNREALIZE] =
545 gtk_signal_new ("unrealize",
547 GTK_CLASS_TYPE (object_class),
548 GTK_SIGNAL_OFFSET (GtkWidgetClass, unrealize),
549 gtk_marshal_VOID__VOID,
551 widget_signals[SIZE_REQUEST] =
552 g_signal_new ("size_request",
553 G_OBJECT_CLASS_TYPE (object_class),
555 G_STRUCT_OFFSET (GtkWidgetClass, size_request),
557 gtk_marshal_VOID__BOXED,
559 GTK_TYPE_REQUISITION | G_SIGNAL_TYPE_STATIC_SCOPE);
560 widget_signals[SIZE_ALLOCATE] =
561 gtk_signal_new ("size_allocate",
563 GTK_CLASS_TYPE (object_class),
564 GTK_SIGNAL_OFFSET (GtkWidgetClass, size_allocate),
565 gtk_marshal_VOID__BOXED,
567 GDK_TYPE_RECTANGLE | G_SIGNAL_TYPE_STATIC_SCOPE);
568 widget_signals[STATE_CHANGED] =
569 gtk_signal_new ("state_changed",
571 GTK_CLASS_TYPE (object_class),
572 GTK_SIGNAL_OFFSET (GtkWidgetClass, state_changed),
573 gtk_marshal_VOID__ENUM,
575 GTK_TYPE_STATE_TYPE);
576 widget_signals[PARENT_SET] =
577 gtk_signal_new ("parent_set",
579 GTK_CLASS_TYPE (object_class),
580 GTK_SIGNAL_OFFSET (GtkWidgetClass, parent_set),
581 gtk_marshal_VOID__OBJECT,
584 widget_signals[HIERARCHY_CHANGED] =
585 gtk_signal_new ("hierarchy_changed",
587 GTK_CLASS_TYPE (object_class),
588 GTK_SIGNAL_OFFSET (GtkWidgetClass, hierarchy_changed),
589 gtk_marshal_VOID__OBJECT,
592 widget_signals[STYLE_SET] =
593 gtk_signal_new ("style_set",
595 GTK_CLASS_TYPE (object_class),
596 GTK_SIGNAL_OFFSET (GtkWidgetClass, style_set),
597 gtk_marshal_VOID__OBJECT,
600 widget_signals[DIRECTION_CHANGED] =
601 gtk_signal_new ("direction_changed",
603 GTK_CLASS_TYPE (object_class),
604 GTK_SIGNAL_OFFSET (GtkWidgetClass, direction_changed),
605 gtk_marshal_VOID__ENUM,
607 GTK_TYPE_TEXT_DIRECTION);
608 widget_signals[GRAB_NOTIFY] =
609 gtk_signal_new ("grab_notify",
611 GTK_CLASS_TYPE (object_class),
612 GTK_SIGNAL_OFFSET (GtkWidgetClass, grab_notify),
613 gtk_marshal_VOID__BOOLEAN,
616 widget_signals[CHILD_NOTIFY] =
617 g_signal_new ("child_notify",
618 G_TYPE_FROM_CLASS (klass),
619 G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE | G_SIGNAL_DETAILED | G_SIGNAL_NO_HOOKS,
620 G_STRUCT_OFFSET (GtkWidgetClass, child_notify),
622 g_cclosure_marshal_VOID__PARAM,
625 widget_signals[MNEMONIC_ACTIVATE] =
626 g_signal_new ("mnemonic_activate",
627 GTK_CLASS_TYPE (object_class),
629 GTK_SIGNAL_OFFSET (GtkWidgetClass, mnemonic_activate),
630 _gtk_boolean_handled_accumulator, NULL,
631 gtk_marshal_BOOLEAN__BOOLEAN,
634 widget_signals[GRAB_FOCUS] =
635 gtk_signal_new ("grab_focus",
636 GTK_RUN_LAST | GTK_RUN_ACTION,
637 GTK_CLASS_TYPE (object_class),
638 GTK_SIGNAL_OFFSET (GtkWidgetClass, grab_focus),
639 gtk_marshal_VOID__VOID,
641 widget_signals[FOCUS] =
642 g_signal_new ("focus",
643 G_TYPE_FROM_CLASS (object_class),
645 G_STRUCT_OFFSET (GtkWidgetClass, focus),
646 _gtk_boolean_handled_accumulator, NULL,
647 gtk_marshal_BOOLEAN__ENUM,
649 GTK_TYPE_DIRECTION_TYPE);
650 widget_signals[EVENT] =
651 g_signal_new ("event",
652 G_TYPE_FROM_CLASS (object_class),
654 G_STRUCT_OFFSET(GtkWidgetClass, event),
655 _gtk_boolean_handled_accumulator, NULL,
656 gtk_marshal_BOOLEAN__BOXED,
658 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
659 widget_signals[EVENT_AFTER] =
660 g_signal_new ("event-after",
661 G_TYPE_FROM_CLASS (object_class),
665 gtk_marshal_VOID__BOXED,
666 G_TYPE_NONE, 1, GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
667 widget_signals[BUTTON_PRESS_EVENT] =
668 g_signal_new ("button_press_event",
669 G_TYPE_FROM_CLASS (object_class),
671 G_STRUCT_OFFSET(GtkWidgetClass, button_press_event),
672 _gtk_boolean_handled_accumulator, NULL,
673 gtk_marshal_BOOLEAN__BOXED,
675 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
676 widget_signals[BUTTON_RELEASE_EVENT] =
677 g_signal_new ("button_release_event",
678 G_TYPE_FROM_CLASS(object_class),
680 G_STRUCT_OFFSET(GtkWidgetClass, button_release_event),
681 _gtk_boolean_handled_accumulator, NULL,
682 gtk_marshal_BOOLEAN__BOXED,
684 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
685 widget_signals[SCROLL_EVENT] =
686 g_signal_new ("scroll_event",
687 G_TYPE_FROM_CLASS(object_class),
689 G_STRUCT_OFFSET(GtkWidgetClass, scroll_event),
690 _gtk_boolean_handled_accumulator, NULL,
691 gtk_marshal_BOOLEAN__BOXED,
693 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
694 widget_signals[MOTION_NOTIFY_EVENT] =
695 g_signal_new ("motion_notify_event",
696 G_TYPE_FROM_CLASS(object_class),
698 G_STRUCT_OFFSET(GtkWidgetClass, motion_notify_event),
699 _gtk_boolean_handled_accumulator, NULL,
700 gtk_marshal_BOOLEAN__BOXED,
702 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
703 widget_signals[DELETE_EVENT] =
704 g_signal_new ("delete_event",
705 G_TYPE_FROM_CLASS(object_class),
707 G_STRUCT_OFFSET(GtkWidgetClass, delete_event),
708 _gtk_boolean_handled_accumulator, NULL,
709 gtk_marshal_BOOLEAN__BOXED,
711 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
712 widget_signals[DESTROY_EVENT] =
713 g_signal_new ("destroy_event",
714 G_TYPE_FROM_CLASS(object_class),
716 G_STRUCT_OFFSET(GtkWidgetClass, destroy_event),
717 _gtk_boolean_handled_accumulator, NULL,
718 gtk_marshal_BOOLEAN__BOXED,
720 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
721 widget_signals[EXPOSE_EVENT] =
722 g_signal_new ("expose_event",
723 G_TYPE_FROM_CLASS(object_class),
725 G_STRUCT_OFFSET(GtkWidgetClass, expose_event),
726 _gtk_boolean_handled_accumulator, NULL,
727 gtk_marshal_BOOLEAN__BOXED,
729 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
730 widget_signals[KEY_PRESS_EVENT] =
731 g_signal_new ("key_press_event",
732 G_TYPE_FROM_CLASS(object_class),
734 G_STRUCT_OFFSET(GtkWidgetClass, key_press_event),
735 _gtk_boolean_handled_accumulator, NULL,
736 gtk_marshal_BOOLEAN__BOXED,
738 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
739 widget_signals[KEY_RELEASE_EVENT] =
740 g_signal_new ("key_release_event",
741 G_TYPE_FROM_CLASS(object_class),
743 G_STRUCT_OFFSET(GtkWidgetClass, key_release_event),
744 _gtk_boolean_handled_accumulator, NULL,
745 gtk_marshal_BOOLEAN__BOXED,
747 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
748 widget_signals[ENTER_NOTIFY_EVENT] =
749 g_signal_new ("enter_notify_event",
750 G_TYPE_FROM_CLASS(object_class),
752 G_STRUCT_OFFSET(GtkWidgetClass, enter_notify_event),
753 _gtk_boolean_handled_accumulator, NULL,
754 gtk_marshal_BOOLEAN__BOXED,
756 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
757 widget_signals[LEAVE_NOTIFY_EVENT] =
758 g_signal_new ("leave_notify_event",
759 G_TYPE_FROM_CLASS(object_class),
761 G_STRUCT_OFFSET(GtkWidgetClass, leave_notify_event),
762 _gtk_boolean_handled_accumulator, NULL,
763 gtk_marshal_BOOLEAN__BOXED,
765 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
766 widget_signals[CONFIGURE_EVENT] =
767 g_signal_new ("configure_event",
768 G_TYPE_FROM_CLASS(object_class),
770 G_STRUCT_OFFSET(GtkWidgetClass, configure_event),
771 _gtk_boolean_handled_accumulator, NULL,
772 gtk_marshal_BOOLEAN__BOXED,
774 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
775 widget_signals[FOCUS_IN_EVENT] =
776 g_signal_new ("focus_in_event",
777 G_TYPE_FROM_CLASS(object_class),
779 G_STRUCT_OFFSET(GtkWidgetClass, focus_in_event),
780 _gtk_boolean_handled_accumulator, NULL,
781 gtk_marshal_BOOLEAN__BOXED,
783 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
784 widget_signals[FOCUS_OUT_EVENT] =
785 g_signal_new ("focus_out_event",
786 G_TYPE_FROM_CLASS(object_class),
788 G_STRUCT_OFFSET(GtkWidgetClass, focus_out_event),
789 _gtk_boolean_handled_accumulator, NULL,
790 gtk_marshal_BOOLEAN__BOXED,
792 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
793 widget_signals[MAP_EVENT] =
794 g_signal_new ("map_event",
795 G_TYPE_FROM_CLASS(object_class),
797 G_STRUCT_OFFSET(GtkWidgetClass, map_event),
798 _gtk_boolean_handled_accumulator, NULL,
799 gtk_marshal_BOOLEAN__BOXED,
801 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
802 widget_signals[UNMAP_EVENT] =
803 g_signal_new ("unmap_event",
804 G_TYPE_FROM_CLASS(object_class),
806 G_STRUCT_OFFSET(GtkWidgetClass, unmap_event),
807 _gtk_boolean_handled_accumulator, NULL,
808 gtk_marshal_BOOLEAN__BOXED,
810 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
811 widget_signals[PROPERTY_NOTIFY_EVENT] =
812 g_signal_new ("property_notify_event",
813 G_TYPE_FROM_CLASS(object_class),
815 G_STRUCT_OFFSET(GtkWidgetClass, property_notify_event),
816 _gtk_boolean_handled_accumulator, NULL,
817 gtk_marshal_BOOLEAN__BOXED,
819 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
820 widget_signals[SELECTION_CLEAR_EVENT] =
821 g_signal_new ("selection_clear_event",
822 G_TYPE_FROM_CLASS(object_class),
824 G_STRUCT_OFFSET(GtkWidgetClass, selection_clear_event),
825 _gtk_boolean_handled_accumulator, NULL,
826 gtk_marshal_BOOLEAN__BOXED,
828 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
829 widget_signals[SELECTION_REQUEST_EVENT] =
830 g_signal_new ("selection_request_event",
831 G_TYPE_FROM_CLASS(object_class),
833 G_STRUCT_OFFSET(GtkWidgetClass, selection_request_event),
834 _gtk_boolean_handled_accumulator, NULL,
835 gtk_marshal_BOOLEAN__BOXED,
837 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
838 widget_signals[SELECTION_NOTIFY_EVENT] =
839 g_signal_new ("selection_notify_event",
840 G_TYPE_FROM_CLASS(object_class),
842 G_STRUCT_OFFSET(GtkWidgetClass, selection_notify_event),
843 _gtk_boolean_handled_accumulator, NULL,
844 gtk_marshal_BOOLEAN__BOXED,
846 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
847 widget_signals[SELECTION_RECEIVED] =
848 g_signal_new ("selection_received",
849 G_TYPE_FROM_CLASS (object_class),
851 G_STRUCT_OFFSET (GtkWidgetClass, selection_received),
853 gtk_marshal_VOID__BOXED_UINT,
855 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
857 widget_signals[SELECTION_GET] =
858 g_signal_new ("selection_get",
859 G_TYPE_FROM_CLASS (object_class),
861 G_STRUCT_OFFSET (GtkWidgetClass, selection_get),
863 gtk_marshal_VOID__BOXED_UINT_UINT,
865 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
868 widget_signals[PROXIMITY_IN_EVENT] =
869 g_signal_new ("proximity_in_event",
870 G_TYPE_FROM_CLASS (object_class),
872 G_STRUCT_OFFSET(GtkWidgetClass, proximity_in_event),
873 _gtk_boolean_handled_accumulator, NULL,
874 gtk_marshal_BOOLEAN__BOXED,
876 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
877 widget_signals[PROXIMITY_OUT_EVENT] =
878 g_signal_new ("proximity_out_event",
879 G_TYPE_FROM_CLASS(object_class),
881 G_STRUCT_OFFSET(GtkWidgetClass, proximity_out_event),
882 _gtk_boolean_handled_accumulator, NULL,
883 gtk_marshal_BOOLEAN__BOXED,
885 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
886 widget_signals[DRAG_LEAVE] =
887 gtk_signal_new ("drag_leave",
889 GTK_CLASS_TYPE (object_class),
890 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_leave),
891 gtk_marshal_VOID__OBJECT_UINT,
893 GDK_TYPE_DRAG_CONTEXT,
895 widget_signals[DRAG_BEGIN] =
896 gtk_signal_new ("drag_begin",
898 GTK_CLASS_TYPE (object_class),
899 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_begin),
900 gtk_marshal_VOID__OBJECT,
902 GDK_TYPE_DRAG_CONTEXT);
903 widget_signals[DRAG_END] =
904 gtk_signal_new ("drag_end",
906 GTK_CLASS_TYPE (object_class),
907 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_end),
908 gtk_marshal_VOID__OBJECT,
910 GDK_TYPE_DRAG_CONTEXT);
911 widget_signals[DRAG_DATA_DELETE] =
912 gtk_signal_new ("drag_data_delete",
914 GTK_CLASS_TYPE (object_class),
915 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_data_delete),
916 gtk_marshal_VOID__OBJECT,
918 GDK_TYPE_DRAG_CONTEXT);
919 widget_signals[DRAG_MOTION] =
920 g_signal_new ("drag_motion",
921 G_TYPE_FROM_CLASS(object_class),
923 G_STRUCT_OFFSET(GtkWidgetClass, drag_motion),
924 _gtk_boolean_handled_accumulator, NULL,
925 gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
927 GDK_TYPE_DRAG_CONTEXT,
931 widget_signals[DRAG_DROP] =
932 g_signal_new ("drag_drop",
933 G_TYPE_FROM_CLASS(object_class),
935 G_STRUCT_OFFSET(GtkWidgetClass, drag_drop),
936 _gtk_boolean_handled_accumulator, NULL,
937 gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
939 GDK_TYPE_DRAG_CONTEXT,
943 widget_signals[DRAG_DATA_GET] =
944 g_signal_new ("drag_data_get",
945 G_TYPE_FROM_CLASS (object_class),
947 G_STRUCT_OFFSET (GtkWidgetClass, drag_data_get),
949 gtk_marshal_VOID__OBJECT_BOXED_UINT_UINT,
951 GDK_TYPE_DRAG_CONTEXT,
952 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
955 widget_signals[DRAG_DATA_RECEIVED] =
956 g_signal_new ("drag_data_received",
957 G_TYPE_FROM_CLASS (object_class),
959 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_data_received),
961 gtk_marshal_VOID__OBJECT_INT_INT_BOXED_UINT_UINT,
963 GDK_TYPE_DRAG_CONTEXT,
966 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
969 widget_signals[VISIBILITY_NOTIFY_EVENT] =
970 g_signal_new ("visibility_notify_event",
971 G_TYPE_FROM_CLASS(object_class),
973 G_STRUCT_OFFSET(GtkWidgetClass, visibility_notify_event),
974 _gtk_boolean_handled_accumulator, NULL,
975 gtk_marshal_BOOLEAN__BOXED,
977 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
978 widget_signals[CLIENT_EVENT] =
979 g_signal_new ("client_event",
980 G_TYPE_FROM_CLASS(object_class),
982 G_STRUCT_OFFSET(GtkWidgetClass, client_event),
983 _gtk_boolean_handled_accumulator, NULL,
984 gtk_marshal_BOOLEAN__BOXED,
986 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
987 widget_signals[NO_EXPOSE_EVENT] =
988 g_signal_new ("no_expose_event",
989 G_TYPE_FROM_CLASS(object_class),
991 G_STRUCT_OFFSET(GtkWidgetClass, no_expose_event),
992 _gtk_boolean_handled_accumulator, NULL,
993 gtk_marshal_BOOLEAN__BOXED,
995 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
996 widget_signals[WINDOW_STATE_EVENT] =
997 g_signal_new ("window_state_event",
998 G_TYPE_FROM_CLASS(object_class),
1000 G_STRUCT_OFFSET(GtkWidgetClass, window_state_event),
1001 _gtk_boolean_handled_accumulator, NULL,
1002 gtk_marshal_BOOLEAN__BOXED,
1004 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1005 widget_signals[POPUP_MENU] =
1006 gtk_signal_new ("popup_menu",
1007 GTK_RUN_LAST | GTK_RUN_ACTION,
1008 GTK_CLASS_TYPE (object_class),
1009 GTK_SIGNAL_OFFSET (GtkWidgetClass, popup_menu),
1010 gtk_marshal_NONE__NONE,
1012 widget_signals[SHOW_HELP] =
1013 gtk_signal_new ("show_help",
1014 GTK_RUN_LAST | GTK_RUN_ACTION,
1015 GTK_CLASS_TYPE (object_class),
1016 GTK_SIGNAL_OFFSET (GtkWidgetClass, show_help),
1017 gtk_marshal_NONE__ENUM,
1018 GTK_TYPE_NONE, 1, GTK_TYPE_WIDGET_HELP_TYPE);
1019 widget_signals[ACCEL_CLOSURES_CHANGED] =
1020 gtk_signal_new ("accel_closures_changed",
1022 GTK_CLASS_TYPE (object_class),
1024 gtk_marshal_NONE__NONE,
1027 binding_set = gtk_binding_set_by_class (klass);
1028 gtk_binding_entry_add_signal (binding_set, GDK_F10, GDK_SHIFT_MASK,
1030 gtk_binding_entry_add_signal (binding_set, GDK_Menu, 0,
1033 gtk_binding_entry_add_signal (binding_set, GDK_F1, GDK_CONTROL_MASK,
1035 GTK_TYPE_WIDGET_HELP_TYPE,
1036 GTK_WIDGET_HELP_TOOLTIP);
1037 gtk_binding_entry_add_signal (binding_set, GDK_KP_F1, GDK_CONTROL_MASK,
1039 GTK_TYPE_WIDGET_HELP_TYPE,
1040 GTK_WIDGET_HELP_TOOLTIP);
1041 gtk_binding_entry_add_signal (binding_set, GDK_F1, GDK_SHIFT_MASK,
1043 GTK_TYPE_WIDGET_HELP_TYPE,
1044 GTK_WIDGET_HELP_WHATS_THIS);
1045 gtk_binding_entry_add_signal (binding_set, GDK_KP_F1, GDK_SHIFT_MASK,
1047 GTK_TYPE_WIDGET_HELP_TYPE,
1048 GTK_WIDGET_HELP_WHATS_THIS);
1050 gtk_widget_class_install_style_property (klass,
1051 g_param_spec_boolean ("interior_focus",
1052 _("Interior Focus"),
1053 _("Whether to draw the focus indicator inside widgets."),
1059 gtk_widget_set_property (GObject *object,
1061 const GValue *value,
1066 widget = GTK_WIDGET (object);
1070 guint32 saved_flags;
1073 gtk_widget_set_name (widget, g_value_get_string (value));
1076 gtk_container_add (GTK_CONTAINER (g_value_get_object (value)), widget);
1078 case PROP_WIDTH_REQUEST:
1079 gtk_widget_set_usize (widget, g_value_get_int (value), -2);
1081 case PROP_HEIGHT_REQUEST:
1082 gtk_widget_set_usize (widget, -2, g_value_get_int (value));
1085 if (g_value_get_boolean (value))
1086 gtk_widget_show (widget);
1088 gtk_widget_hide (widget);
1090 case PROP_SENSITIVE:
1091 gtk_widget_set_sensitive (widget, g_value_get_boolean (value));
1093 case PROP_APP_PAINTABLE:
1094 gtk_widget_set_app_paintable (widget, g_value_get_boolean (value));
1096 case PROP_CAN_FOCUS:
1097 saved_flags = GTK_WIDGET_FLAGS (widget);
1098 if (g_value_get_boolean (value))
1099 GTK_WIDGET_SET_FLAGS (widget, GTK_CAN_FOCUS);
1101 GTK_WIDGET_UNSET_FLAGS (widget, GTK_CAN_FOCUS);
1102 if (saved_flags != GTK_WIDGET_FLAGS (widget))
1103 gtk_widget_queue_resize (widget);
1105 case PROP_HAS_FOCUS:
1106 if (g_value_get_boolean (value))
1107 gtk_widget_grab_focus (widget);
1109 case PROP_CAN_DEFAULT:
1110 saved_flags = GTK_WIDGET_FLAGS (widget);
1111 if (g_value_get_boolean (value))
1112 GTK_WIDGET_SET_FLAGS (widget, GTK_CAN_DEFAULT);
1114 GTK_WIDGET_UNSET_FLAGS (widget, GTK_CAN_DEFAULT);
1115 if (saved_flags != GTK_WIDGET_FLAGS (widget))
1116 gtk_widget_queue_resize (widget);
1118 case PROP_HAS_DEFAULT:
1119 if (g_value_get_boolean (value))
1120 gtk_widget_grab_default (widget);
1122 case PROP_RECEIVES_DEFAULT:
1123 if (g_value_get_boolean (value))
1124 GTK_WIDGET_SET_FLAGS (widget, GTK_RECEIVES_DEFAULT);
1126 GTK_WIDGET_UNSET_FLAGS (widget, GTK_RECEIVES_DEFAULT);
1129 gtk_widget_set_style (widget, g_value_get_object (value));
1132 if (!GTK_WIDGET_REALIZED (widget) && !GTK_WIDGET_NO_WINDOW (widget))
1133 gtk_widget_set_events (widget, g_value_get_flags (value));
1135 case PROP_EXTENSION_EVENTS:
1136 gtk_widget_set_extension_events (widget, g_value_get_enum (value));
1144 gtk_widget_get_property (GObject *object,
1151 widget = GTK_WIDGET (object);
1156 GdkExtensionMode *modep;
1160 g_value_set_string (value, widget->name);
1162 g_value_set_string (value, "");
1166 g_value_set_object (value, G_OBJECT (widget->parent));
1168 g_value_set_object (value, NULL);
1170 case PROP_WIDTH_REQUEST:
1173 gtk_widget_get_size_request (widget, &w, NULL);
1174 g_value_set_int (value, w);
1177 case PROP_HEIGHT_REQUEST:
1180 gtk_widget_get_size_request (widget, NULL, &h);
1181 g_value_set_int (value, h);
1185 g_value_set_boolean (value, (GTK_WIDGET_VISIBLE (widget) != FALSE));
1187 case PROP_SENSITIVE:
1188 g_value_set_boolean (value, (GTK_WIDGET_SENSITIVE (widget) != FALSE));
1190 case PROP_APP_PAINTABLE:
1191 g_value_set_boolean (value, (GTK_WIDGET_APP_PAINTABLE (widget) != FALSE));
1193 case PROP_CAN_FOCUS:
1194 g_value_set_boolean (value, (GTK_WIDGET_CAN_FOCUS (widget) != FALSE));
1196 case PROP_HAS_FOCUS:
1197 g_value_set_boolean (value, (GTK_WIDGET_HAS_FOCUS (widget) != FALSE));
1199 case PROP_CAN_DEFAULT:
1200 g_value_set_boolean (value, (GTK_WIDGET_CAN_DEFAULT (widget) != FALSE));
1202 case PROP_HAS_DEFAULT:
1203 g_value_set_boolean (value, (GTK_WIDGET_HAS_DEFAULT (widget) != FALSE));
1205 case PROP_RECEIVES_DEFAULT:
1206 g_value_set_boolean (value, (GTK_WIDGET_RECEIVES_DEFAULT (widget) != FALSE));
1208 case PROP_COMPOSITE_CHILD:
1209 g_value_set_boolean (value, (GTK_WIDGET_COMPOSITE_CHILD (widget) != FALSE));
1212 g_value_set_object (value, G_OBJECT (gtk_widget_get_style (widget)));
1215 eventp = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_event_mask);
1217 g_value_set_flags (value, 0);
1219 g_value_set_flags (value, *eventp);
1221 case PROP_EXTENSION_EVENTS:
1222 modep = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_extension_event_mode);
1224 g_value_set_enum (value, 0);
1226 g_value_set_enum (value, (GdkExtensionMode) *modep);
1229 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1235 gtk_widget_init (GtkWidget *widget)
1237 GTK_PRIVATE_FLAGS (widget) = PRIVATE_GTK_CHILD_VISIBLE;
1238 widget->state = GTK_STATE_NORMAL;
1239 widget->saved_state = GTK_STATE_NORMAL;
1240 widget->name = NULL;
1241 widget->requisition.width = 0;
1242 widget->requisition.height = 0;
1243 widget->allocation.x = -1;
1244 widget->allocation.y = -1;
1245 widget->allocation.width = 1;
1246 widget->allocation.height = 1;
1247 widget->window = NULL;
1248 widget->parent = NULL;
1250 GTK_WIDGET_SET_FLAGS (widget,
1252 GTK_PARENT_SENSITIVE |
1253 (composite_child_stack ? GTK_COMPOSITE_CHILD : 0) |
1254 GTK_DOUBLE_BUFFERED);
1256 GTK_PRIVATE_SET_FLAG (widget, GTK_REDRAW_ON_ALLOC);
1258 widget->style = gtk_widget_get_default_style ();
1259 g_object_ref (widget->style);
1264 gtk_widget_dispatch_child_properties_changed (GtkWidget *widget,
1266 GParamSpec **pspecs)
1268 GtkWidget *container = widget->parent;
1271 for (i = 0; widget->parent == container && i < n_pspecs; i++)
1272 g_signal_emit (widget, widget_signals[CHILD_NOTIFY], g_quark_from_string (pspecs[i]->name), pspecs[i]);
1276 gtk_widget_freeze_child_notify (GtkWidget *widget)
1278 g_return_if_fail (GTK_IS_WIDGET (widget));
1280 if (!G_OBJECT (widget)->ref_count)
1283 g_object_ref (widget);
1284 g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
1285 g_object_unref (widget);
1289 gtk_widget_child_notify (GtkWidget *widget,
1290 const gchar *child_property)
1294 g_return_if_fail (GTK_IS_WIDGET (widget));
1295 g_return_if_fail (child_property != NULL);
1296 if (!G_OBJECT (widget)->ref_count || !widget->parent)
1299 g_object_ref (widget);
1300 pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
1302 G_OBJECT_TYPE (widget->parent),
1305 g_warning ("%s: container class `%s' has no child property named `%s'",
1307 G_OBJECT_TYPE_NAME (widget->parent),
1311 GObjectNotifyQueue *nqueue = g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
1313 g_object_notify_queue_add (G_OBJECT (widget), nqueue, pspec);
1314 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
1316 g_object_unref (widget);
1320 gtk_widget_thaw_child_notify (GtkWidget *widget)
1322 GObjectNotifyQueue *nqueue;
1324 g_return_if_fail (GTK_IS_WIDGET (widget));
1326 if (!G_OBJECT (widget)->ref_count)
1329 g_object_ref (widget);
1330 nqueue = g_object_notify_queue_from_object (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
1331 if (!nqueue || !nqueue->freeze_count)
1332 g_warning (G_STRLOC ": child-property-changed notification for %s(%p) is not frozen",
1333 G_OBJECT_TYPE_NAME (widget), widget);
1335 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
1336 g_object_unref (widget);
1342 * @type: type ID of the widget to create
1343 * @first_property_name: name of first property to set
1344 * @Varargs: value of first property, followed by more properties, NULL-terminated
1346 * This is a convenience function for creating a widget and setting
1347 * its properties in one go. For example you might write:
1348 * gtk_widget_new (GTK_TYPE_LABEL, "label", "Hello World", "xalign",
1349 * 0.0, NULL) to create a left-aligned label. Equivalent to
1350 * gtk_object_new(), but returns a widget so you don't have to
1351 * cast the object yourself.
1353 * Return value: a new #GtkWidget of type @widget_type
1356 gtk_widget_new (GtkType type,
1357 const gchar *first_property_name,
1363 g_return_val_if_fail (gtk_type_is_a (type, GTK_TYPE_WIDGET), NULL);
1365 va_start (var_args, first_property_name);
1366 widget = (GtkWidget *)g_object_new_valist (type, first_property_name, var_args);
1374 * @widget: a #GtkWidget
1375 * @first_property_name: name of first property to set
1376 * @Varargs: value of first property, followed by more properties, NULL-terminated
1378 * Like gtk_object_set() - there's no reason to use this instead of
1382 gtk_widget_set (GtkWidget *widget,
1383 const gchar *first_property_name,
1388 g_return_if_fail (GTK_IS_WIDGET (widget));
1390 va_start (var_args, first_property_name);
1391 g_object_set_valist (G_OBJECT (widget), first_property_name, var_args);
1396 gtk_widget_queue_clear_child (GtkWidget *widget)
1400 parent = widget->parent;
1401 if (parent && GTK_WIDGET_DRAWABLE (parent))
1402 gtk_widget_queue_clear_area (parent,
1403 widget->allocation.x,
1404 widget->allocation.y,
1405 widget->allocation.width,
1406 widget->allocation.height);
1410 * gtk_widget_unparent:
1411 * @widget: a #GtkWidget
1413 * This function is only for use in widget implementations.
1414 * Should be called by implementations of the remove method
1415 * on #GtkContainer, to dissociate a child from the container.
1418 gtk_widget_unparent (GtkWidget *widget)
1420 GObjectNotifyQueue *nqueue;
1421 GtkWidget *toplevel;
1422 GtkWidget *old_parent;
1424 g_return_if_fail (GTK_IS_WIDGET (widget));
1425 if (widget->parent == NULL)
1428 /* keep this function in sync with gtk_menu_detach()
1431 g_object_freeze_notify (G_OBJECT (widget));
1432 nqueue = g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
1434 /* unset focused and default children properly, this code
1435 * should eventually move into some gtk_window_unparent_branch() or
1439 toplevel = gtk_widget_get_toplevel (widget);
1440 if (GTK_CONTAINER (widget->parent)->focus_child == widget)
1442 gtk_container_set_focus_child (GTK_CONTAINER (widget->parent), NULL);
1444 if (GTK_WIDGET_TOPLEVEL (toplevel))
1448 child = GTK_WINDOW (toplevel)->focus_widget;
1450 while (child && child != widget)
1451 child = child->parent;
1453 if (child == widget)
1454 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
1457 if (GTK_WIDGET_TOPLEVEL (toplevel))
1461 child = GTK_WINDOW (toplevel)->default_widget;
1463 while (child && child != widget)
1464 child = child->parent;
1466 if (child == widget)
1467 gtk_window_set_default (GTK_WINDOW (toplevel), NULL);
1470 /* If we are unanchoring the child, we save around the toplevel
1471 * to emit hierarchy changed
1473 if (GTK_WIDGET_ANCHORED (widget->parent))
1474 g_object_ref (toplevel);
1478 gtk_widget_queue_clear_child (widget);
1480 /* Reset the width and height here, to force reallocation if we
1481 * get added back to a new parent. This won't work if our new
1482 * allocation is smaller than 1x1 and we actually want a size of 1x1...
1483 * (would 0x0 be OK here?)
1485 widget->allocation.width = 1;
1486 widget->allocation.height = 1;
1488 if (GTK_WIDGET_REALIZED (widget) && !GTK_WIDGET_IN_REPARENT (widget))
1489 gtk_widget_unrealize (widget);
1491 /* Removing a widget from a container restores the child visible
1492 * flag to the default state, so it doesn't affect the child
1493 * in the next parent.
1495 GTK_PRIVATE_SET_FLAG (widget, GTK_CHILD_VISIBLE);
1497 old_parent = widget->parent;
1498 widget->parent = NULL;
1499 gtk_widget_set_parent_window (widget, NULL);
1500 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[PARENT_SET], old_parent);
1503 _gtk_widget_propagate_hierarchy_changed (widget, toplevel);
1504 g_object_unref (toplevel);
1507 g_object_notify (G_OBJECT (widget), "parent");
1508 g_object_thaw_notify (G_OBJECT (widget));
1509 if (!widget->parent)
1510 g_object_notify_queue_clear (G_OBJECT (widget), nqueue);
1511 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
1512 gtk_widget_unref (widget);
1516 * gtk_widget_destroy:
1517 * @widget: a #GtkWidget
1519 * Destroys a widget. Equivalent to gtk_object_destroy(), except that
1520 * you don't have to cast the widget to #GtkObject. When a widget is
1521 * destroyed, it will break any references it holds to other objects.
1522 * If the widget is inside a container, the widget will be removed
1523 * from the container. If the widget is a toplevel (derived from
1524 * #GtkWindow), it will be removed from the list of toplevels, and the
1525 * reference GTK+ holds to it will be removed. Removing a
1526 * widget from its container or the list of toplevels results in the
1527 * widget being finalized, unless you've added additional references
1528 * to the widget with gtk_object_ref().
1530 * In most cases, only toplevel widgets (windows) require explicit
1531 * destruction, because when you destroy a toplevel its children will
1532 * be destroyed as well.
1536 gtk_widget_destroy (GtkWidget *widget)
1538 g_return_if_fail (GTK_IS_WIDGET (widget));
1540 gtk_object_destroy ((GtkObject*) widget);
1544 * gtk_widget_destroyed:
1545 * @widget: a #GtkWidget
1546 * @widget_pointer: address of a variable that contains @widget
1548 * This function sets *@widget_pointer to NULL if @widget_pointer !=
1549 * NULL. It's intended to be used as a callback connected to the
1550 * "destroy" signal of a widget. You connect gtk_widget_destroyed()
1551 * as a signal handler, and pass the address of your widget variable
1552 * as user data. Then when the widget is destroyed, the variable will
1553 * be set to NULL. Useful for example to avoid multiple copies
1554 * of the same dialog.
1558 gtk_widget_destroyed (GtkWidget *widget,
1559 GtkWidget **widget_pointer)
1561 /* Don't make any assumptions about the
1563 * Even check widget_pointer.
1566 *widget_pointer = NULL;
1571 * @widget: a #GtkWidget
1573 * Flags a widget to be displayed. Any widget that isn't shown will
1574 * not appear on the screen. If you want to show all the widgets in a
1575 * container, it's easier to call gtk_widget_show_all() on the
1576 * container, instead of individually showing the widgets.
1578 * Remember that you have to show the containers containing a widget,
1579 * in addition to the widget itself, before it will appear onscreen.
1581 * When a toplevel container is shown, it is immediately realized and
1582 * mapped; other shown widgets are realized and mapped when their
1583 * toplevel container is realized and mapped.
1587 gtk_widget_show (GtkWidget *widget)
1589 g_return_if_fail (GTK_IS_WIDGET (widget));
1591 if (!GTK_WIDGET_VISIBLE (widget))
1593 g_object_ref (G_OBJECT (widget));
1594 if (!GTK_WIDGET_TOPLEVEL (widget))
1595 gtk_widget_queue_resize (widget);
1596 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[SHOW]);
1597 g_object_notify (G_OBJECT (widget), "visible");
1598 g_object_unref (G_OBJECT (widget));
1603 gtk_widget_real_show (GtkWidget *widget)
1605 g_return_if_fail (GTK_IS_WIDGET (widget));
1607 if (!GTK_WIDGET_VISIBLE (widget))
1609 GTK_WIDGET_SET_FLAGS (widget, GTK_VISIBLE);
1611 if (widget->parent &&
1612 GTK_WIDGET_MAPPED (widget->parent) &&
1613 GTK_WIDGET_CHILD_VISIBLE (widget) &&
1614 !GTK_WIDGET_MAPPED (widget))
1615 gtk_widget_map (widget);
1620 gtk_widget_show_map_callback (GtkWidget *widget, GdkEvent *event, gint *flag)
1623 gtk_signal_disconnect_by_data (GTK_OBJECT (widget), flag);
1627 * gtk_widget_show_now:
1628 * @widget: a #GtkWidget
1630 * Shows a widget. If the widget is an unmapped toplevel widget
1631 * (i.e. a #GtkWindow that has not yet been shown), enter the main
1632 * loop and wait for the window to actually be mapped. Be careful;
1633 * because the main loop is running, anything can happen during
1637 gtk_widget_show_now (GtkWidget *widget)
1641 g_return_if_fail (GTK_IS_WIDGET (widget));
1643 /* make sure we will get event */
1644 if (!GTK_WIDGET_MAPPED (widget) &&
1645 GTK_WIDGET_TOPLEVEL (widget))
1647 gtk_widget_show (widget);
1649 gtk_signal_connect (GTK_OBJECT (widget), "map_event",
1650 GTK_SIGNAL_FUNC (gtk_widget_show_map_callback),
1654 gtk_main_iteration();
1657 gtk_widget_show (widget);
1662 * @widget: a #GtkWidget
1664 * Reverses the effects of gtk_widget_show(), causing the widget to be
1665 * hidden (invisible to the user).
1668 gtk_widget_hide (GtkWidget *widget)
1670 g_return_if_fail (GTK_IS_WIDGET (widget));
1672 if (GTK_WIDGET_VISIBLE (widget))
1674 gtk_widget_ref (widget);
1675 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[HIDE]);
1676 if (!GTK_WIDGET_TOPLEVEL (widget) && GTK_WIDGET_REALIZED (widget))
1677 gtk_widget_queue_resize (widget);
1678 g_object_notify (G_OBJECT (widget), "visible");
1679 gtk_widget_unref (widget);
1684 gtk_widget_real_hide (GtkWidget *widget)
1686 g_return_if_fail (GTK_IS_WIDGET (widget));
1688 if (GTK_WIDGET_VISIBLE (widget))
1690 GTK_WIDGET_UNSET_FLAGS (widget, GTK_VISIBLE);
1692 if (GTK_WIDGET_MAPPED (widget))
1693 gtk_widget_unmap (widget);
1698 * gtk_widget_hide_on_delete:
1699 * @widget: a #GtkWidget
1701 * Utility function; intended to be connected to the "delete_event"
1702 * signal on a #GtkWindow. The function calls gtk_widget_hide() on its
1703 * argument, then returns %TRUE. If connected to "delete_event",
1704 * the result is that clicking the window manager close button for
1705 * will hide but not destroy the window. By default, GTK+ destroys
1706 * windows when "delete_event" is received.
1708 * Return value: %TRUE
1711 gtk_widget_hide_on_delete (GtkWidget *widget)
1713 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
1715 gtk_widget_hide (widget);
1721 * gtk_widget_show_all:
1722 * @widget: a #GtkWidget
1724 * Recursively shows a widget, and any child widgets (if the widget is
1728 gtk_widget_show_all (GtkWidget *widget)
1730 GtkWidgetClass *class;
1732 g_return_if_fail (GTK_IS_WIDGET (widget));
1734 class = GTK_WIDGET_GET_CLASS (widget);
1736 if (class->show_all)
1737 class->show_all (widget);
1741 * gtk_widget_hide_all:
1742 * @widget: a #GtkWidget
1744 * Recursively hides a widget and any child widgets.
1747 gtk_widget_hide_all (GtkWidget *widget)
1749 GtkWidgetClass *class;
1751 g_return_if_fail (GTK_IS_WIDGET (widget));
1753 class = GTK_WIDGET_GET_CLASS (widget);
1755 if (class->hide_all)
1756 class->hide_all (widget);
1761 * @widget: a #GtkWidget
1763 * This function is only for use in widget implementations. Causes
1764 * a widget to be mapped if it isn't already.
1768 gtk_widget_map (GtkWidget *widget)
1770 g_return_if_fail (GTK_IS_WIDGET (widget));
1771 g_return_if_fail (GTK_WIDGET_VISIBLE (widget));
1772 g_return_if_fail (GTK_WIDGET_CHILD_VISIBLE (widget));
1774 if (!GTK_WIDGET_MAPPED (widget))
1776 if (!GTK_WIDGET_REALIZED (widget))
1777 gtk_widget_realize (widget);
1779 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[MAP]);
1781 if (GTK_WIDGET_NO_WINDOW (widget))
1782 gdk_window_invalidate_rect (widget->window, &widget->allocation, FALSE);
1788 * @widget: a #GtkWidget
1790 * This function is only for use in widget implementations. Causes
1791 * a widget to be unmapped if it's currently mapped.
1795 gtk_widget_unmap (GtkWidget *widget)
1797 g_return_if_fail (GTK_IS_WIDGET (widget));
1799 if (GTK_WIDGET_MAPPED (widget))
1801 if (GTK_WIDGET_NO_WINDOW (widget))
1802 gdk_window_invalidate_rect (widget->window, &widget->allocation, FALSE);
1803 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[UNMAP]);
1808 * gtk_widget_realize:
1809 * @widget: a #GtkWidget
1811 * Creates the GDK (windowing system) resources associated with a
1812 * widget. For example, widget->window will be created when a widget
1813 * is realized. Normally realization happens implicitly; if you show
1814 * a widget and all its parent containers, then the widget will be
1815 * realized and mapped automatically.
1817 * Realizing a widget requires all
1818 * the widget's parent widgets to be realized; calling
1819 * gtk_widget_realize() realizes the widget's parents in addition to
1820 * @widget itself. If a widget is not yet inside a toplevel window
1821 * when you realize it, bad things will happen.
1823 * This function is primarily used in widget implementations, and
1824 * isn't very useful otherwise. Many times when you think you might
1825 * need it, a better approach is to connect to a signal that will be
1826 * called after the widget is realized automatically, such as
1827 * "expose_event". Or simply gtk_signal_connect_after() to the
1832 gtk_widget_realize (GtkWidget *widget)
1835 GdkExtensionMode mode;
1836 GtkWidgetShapeInfo *shape_info;
1838 g_return_if_fail (GTK_IS_WIDGET (widget));
1840 if (!GTK_WIDGET_REALIZED (widget))
1843 if (GTK_IS_CONTAINER (widget) && !GTK_WIDGET_NO_WINDOW (widget))
1844 g_message ("gtk_widget_realize(%s)", gtk_type_name (GTK_WIDGET_TYPE (widget)));
1847 if (widget->parent == NULL &&
1848 !GTK_WIDGET_TOPLEVEL (widget))
1849 g_warning ("Calling gtk_widget_realize() on a widget that isn't "
1850 "inside a toplevel window is not going to work very well. "
1851 "Widgets must be inside a toplevel container before realizing them.");
1853 if (widget->parent && !GTK_WIDGET_REALIZED (widget->parent))
1854 gtk_widget_realize (widget->parent);
1856 gtk_widget_ensure_style (widget);
1858 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[REALIZE]);
1860 if (GTK_WIDGET_HAS_SHAPE_MASK (widget))
1862 shape_info = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_shape_info);
1863 gdk_window_shape_combine_mask (widget->window,
1864 shape_info->shape_mask,
1865 shape_info->offset_x,
1866 shape_info->offset_y);
1869 if (!GTK_WIDGET_NO_WINDOW (widget))
1871 mode = gtk_widget_get_extension_events (widget);
1872 if (mode != GDK_EXTENSION_EVENTS_NONE)
1874 events = gtk_widget_get_events (widget);
1875 gdk_input_set_extension_events (widget->window, events, mode);
1883 * gtk_widget_unrealize:
1884 * @widget: a #GtkWidget
1886 * This function is only useful in widget implementations.
1887 * Causes a widget to be unrealized (frees all GDK resources
1888 * associated with the widget, such as widget->window).
1892 gtk_widget_unrealize (GtkWidget *widget)
1894 g_return_if_fail (GTK_IS_WIDGET (widget));
1896 if (GTK_WIDGET_HAS_SHAPE_MASK (widget))
1897 gtk_widget_shape_combine_mask (widget, NULL, -1, -1);
1899 if (GTK_WIDGET_REALIZED (widget))
1901 gtk_widget_ref (widget);
1902 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[UNREALIZE]);
1903 GTK_WIDGET_UNSET_FLAGS (widget, GTK_REALIZED | GTK_MAPPED);
1904 gtk_widget_unref (widget);
1908 /*****************************************
1910 *****************************************/
1913 * gtk_widget_queue_draw_area:
1914 * @widget: a #GtkWidget
1915 * @x: x coordinate of upper-left corner of rectangle to redraw
1916 * @y: y coordinate of upper-left corner of rectangle to redraw
1917 * @width: width of region to draw
1918 * @height: height of region to draw
1920 * Invalidates the rectangular area of @widget defined by @x, @y,
1921 * @width and @height by calling gdk_window_invalidate_rect() on the
1922 * widget's window and all its child windows. Once the main loop
1923 * becomes idle (after the current batch of events has been processed,
1924 * roughly), the window will receive expose events for the union of
1925 * all regions that have been invalidated.
1927 * Normally you would only use this function in widget
1928 * implementations. You might also use it, or
1929 * gdk_window_invalidate_rect() directly, to schedule a redraw of a
1930 * #GtkDrawingArea or some portion thereof.
1932 * Frequently you can just call gdk_window_invalidate_rect() or
1933 * gdk_window_invalidate_region() instead of this function. Those
1934 * functions will invalidate only a single window, instead of the
1935 * widget and all its children.
1937 * The advantage of adding to the invalidated region compared to
1938 * simply drawing immediately is efficiency; using an invalid region
1939 * ensures that you only have to redraw one time.
1943 gtk_widget_queue_draw_area (GtkWidget *widget,
1949 g_return_if_fail (GTK_IS_WIDGET (widget));
1951 gtk_widget_queue_clear_area (widget, x, y, width, height);
1955 * gtk_widget_queue_draw:
1956 * @widget: a #GtkWidget
1958 * Equivalent to calling gtk_widget_queue_draw_area() for the
1959 * entire area of a widget.
1963 gtk_widget_queue_draw (GtkWidget *widget)
1965 g_return_if_fail (GTK_IS_WIDGET (widget));
1967 gtk_widget_queue_clear (widget);
1970 /* Invalidates the given area (allocation-relative-coordinates)
1971 * in all of the widget's windows
1974 * gtk_widget_queue_clear_area:
1975 * @widget: a #GtkWidget
1976 * @x: x coordinate of upper-left corner of rectangle to redraw
1977 * @y: y coordinate of upper-left corner of rectangle to redraw
1978 * @width: width of region to draw
1979 * @height: height of region to draw
1981 * DEPRECATED. This function is no longer different from
1982 * gtk_widget_queue_draw_area(), though it once was. Now it just calls
1983 * gtk_widget_queue_draw_area(). Originally
1984 * gtk_widget_queue_clear_area() would force a redraw of the
1985 * background for GTK_NO_WINDOW widgets, and
1986 * gtk_widget_queue_draw_area() would not. Now both functions ensure
1987 * the background will be redrawn.
1991 gtk_widget_queue_clear_area (GtkWidget *widget,
1997 GdkRectangle invalid_rect;
1999 g_return_if_fail (GTK_IS_WIDGET (widget));
2001 if (!(widget->window && gdk_window_is_viewable (widget->window)))
2004 /* Find the correct widget */
2006 if (!GTK_WIDGET_NO_WINDOW (widget))
2010 /* Translate widget relative to window-relative */
2012 gint wx, wy, wwidth, wheight;
2014 gdk_window_get_position (widget->window, &wx, &wy);
2015 x -= wx - widget->allocation.x;
2016 y -= wy - widget->allocation.y;
2018 gdk_window_get_size (widget->window, &wwidth, &wheight);
2020 if (x + width <= 0 || y + height <= 0 ||
2021 x >= wwidth || y >= wheight)
2032 if (x + width > wwidth)
2034 if (y + height > wheight)
2035 height = wheight - y;
2041 invalid_rect.width = width;
2042 invalid_rect.height = height;
2044 gdk_window_invalidate_rect (widget->window, &invalid_rect, TRUE);
2048 * gtk_widget_queue_clear:
2049 * @widget: a #GtkWidget
2051 * DEPRECATED. Use gtk_widget_queue_draw() instead.
2054 gtk_widget_queue_clear (GtkWidget *widget)
2056 g_return_if_fail (GTK_IS_WIDGET (widget));
2058 if (widget->allocation.width || widget->allocation.height)
2060 if (GTK_WIDGET_NO_WINDOW (widget))
2061 gtk_widget_queue_clear_area (widget, widget->allocation.x,
2062 widget->allocation.y,
2063 widget->allocation.width,
2064 widget->allocation.height);
2066 gtk_widget_queue_clear_area (widget, 0, 0,
2067 widget->allocation.width,
2068 widget->allocation.height);
2073 * gtk_widget_queue_resize:
2074 * @widget: a #GtkWidget
2076 * This function is only for use in widget implementations.
2077 * Flags a widget to have its size renegotiated; should
2078 * be called when a widget for some reason has a new size request.
2079 * For example, when you change the text in a #GtkLabel, #GtkLabel
2080 * queues a resize to ensure there's enough space for the new text.
2084 gtk_widget_queue_resize (GtkWidget *widget)
2088 g_return_if_fail (GTK_IS_WIDGET (widget));
2090 if (GTK_WIDGET_REALIZED (widget))
2092 region = gdk_region_rectangle (&widget->allocation);
2093 gtk_widget_invalidate_widget_windows (widget, region);
2094 gdk_region_destroy (region);
2097 _gtk_size_group_queue_resize (widget);
2102 * @widget: a #GtkWidget
2103 * @area: area to draw
2105 * DEPRECATED. In GTK+ 1.2, this function would immediately render the
2106 * region @area of a widget, by invoking the virtual draw method of a
2107 * widget. In GTK+ 2.0, the draw method is gone, and instead
2108 * gtk_widget_draw() simply invalidates the specified region of the
2109 * widget, then updates the invalid region of the widget immediately.
2110 * Usually you don't want to update the region immediately for
2111 * performance reasons, so in general gtk_widget_queue_draw_area() is
2112 * a better choice if you want to draw a region of a widget.
2116 gtk_widget_draw (GtkWidget *widget,
2119 g_return_if_fail (GTK_IS_WIDGET (widget));
2121 if (GTK_WIDGET_DRAWABLE (widget))
2124 gtk_widget_queue_draw_area (widget,
2126 area->width, area->height);
2128 gtk_widget_queue_draw (widget);
2130 gdk_window_process_updates (widget->window, TRUE);
2135 * gtk_widget_size_request:
2136 * @widget: a #GtkWidget
2137 * @requisition: a #GtkRequisition to be filled in
2139 * This function is typically used when implementing a #GtkContainer
2140 * subclass. Obtains the preferred size of a widget. The container
2141 * uses this information to arrange its child widgets and decide what
2142 * size allocations to give them with gtk_widget_size_allocate().
2144 * You can also call this function from an application, with some
2145 * caveats. Most notably, getting a size request requires the widget
2146 * to be associated with a screen, because font information may be
2147 * needed. Multihead-aware applications should keep this in mind.
2149 * Also remember that the size request is not necessarily the size
2150 * a widget will actually be allocated.
2152 * See also gtk_widget_get_child_requisition().
2155 gtk_widget_size_request (GtkWidget *widget,
2156 GtkRequisition *requisition)
2158 g_return_if_fail (GTK_IS_WIDGET (widget));
2160 #ifdef G_ENABLE_DEBUG
2161 if (requisition == &widget->requisition)
2162 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.");
2163 #endif /* G_ENABLE_DEBUG */
2165 _gtk_size_group_compute_requisition (widget, requisition);
2169 * gtk_widget_get_child_requisition:
2170 * @widget: a #GtkWidget
2171 * @requisition: a #GtkRequisition to be filled in
2173 * This function is only for use in widget implementations. Obtains
2174 * @widget->requisition, unless someone has forced a particular
2175 * geometry on the widget (e.g. with gtk_widget_set_usize()), in which
2176 * case it returns that geometry instead of the widget's requisition.
2178 * This function differs from gtk_widget_size_request() in that
2179 * it retrieves the last size request value from widget->requisition,
2180 * while gtk_widget_size_request() actually calls the "size_request" method
2181 * on @widget to compute the size request and fill in widget->requisition,
2182 * and only then returns widget->requisition.
2184 * Because this function does not call the "size_request" method, it
2185 * can only be used when you know that widget->requisition is
2186 * up-to-date, that is, gtk_widget_size_request() has been called
2187 * since the last time a resize was queued. In general, only container
2188 * implementations have this information; applications should use
2189 * gtk_widget_size_request().
2192 gtk_widget_get_child_requisition (GtkWidget *widget,
2193 GtkRequisition *requisition)
2195 _gtk_size_group_get_child_requisition (widget, requisition);
2199 invalidate_predicate (GdkWindow *window,
2204 gdk_window_get_user_data (window, &user_data);
2206 return (user_data == data);
2209 /* Invalidate @region in widget->window and all children
2210 * of widget->window owned by widget. @region is in the
2211 * same coordinates as widget->allocation and will be
2212 * modified by this call.
2215 gtk_widget_invalidate_widget_windows (GtkWidget *widget,
2218 if (!GTK_WIDGET_NO_WINDOW (widget))
2222 gdk_window_get_position (widget->window, &x, &y);
2223 gdk_region_offset (region, -x, -y);
2226 gdk_window_invalidate_maybe_recurse (widget->window, region,
2227 invalidate_predicate, widget);
2231 * gtk_widget_size_allocate:
2232 * @widget: a #GtkWidget
2233 * @allocation: position and size to be allocated to @widget
2235 * This function is only used by #GtkContainer subclasses, to assign a size
2236 * and position to their child widgets.
2240 gtk_widget_size_allocate (GtkWidget *widget,
2241 GtkAllocation *allocation)
2243 GtkWidgetAuxInfo *aux_info;
2244 GdkRectangle real_allocation;
2245 GdkRectangle old_allocation;
2246 gboolean alloc_needed;
2247 gboolean size_changed;
2248 gboolean position_changed;
2250 g_return_if_fail (GTK_IS_WIDGET (widget));
2252 alloc_needed = GTK_WIDGET_ALLOC_NEEDED (widget);
2253 GTK_PRIVATE_UNSET_FLAG (widget, GTK_ALLOC_NEEDED);
2255 old_allocation = widget->allocation;
2256 real_allocation = *allocation;
2257 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
2261 if (aux_info->x_set)
2262 real_allocation.x = aux_info->x;
2263 if (aux_info->y_set)
2264 real_allocation.y = aux_info->y;
2267 if (real_allocation.width < 0 || real_allocation.height < 0)
2269 g_warning ("gtk_widget_size_allocate(): attempt to allocate widget with width %d and height %d",
2270 real_allocation.width,
2271 real_allocation.height);
2274 real_allocation.width = MAX (real_allocation.width, 1);
2275 real_allocation.height = MAX (real_allocation.height, 1);
2277 size_changed = (old_allocation.width != real_allocation.width ||
2278 old_allocation.height != real_allocation.height);
2279 position_changed = (old_allocation.x != real_allocation.x ||
2280 old_allocation.y != real_allocation.y);
2282 if (!alloc_needed && !size_changed && !position_changed)
2285 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[SIZE_ALLOCATE], &real_allocation);
2287 if (GTK_WIDGET_MAPPED (widget))
2289 if (GTK_WIDGET_NO_WINDOW (widget) && GTK_WIDGET_REDRAW_ON_ALLOC (widget) && position_changed)
2291 /* Invalidate union(old_allaction,widget->allocation) in widget->window
2293 GdkRegion *invalidate = gdk_region_rectangle (&widget->allocation);
2294 gdk_region_union_with_rect (invalidate, &old_allocation);
2296 gdk_window_invalidate_region (widget->window, invalidate, FALSE);
2297 gdk_region_destroy (invalidate);
2302 if (GTK_WIDGET_REDRAW_ON_ALLOC (widget))
2304 /* Invalidate union(old_allaction,widget->allocation) in widget->window and descendents owned by widget
2306 GdkRegion *invalidate = gdk_region_rectangle (&widget->allocation);
2307 gdk_region_union_with_rect (invalidate, &old_allocation);
2309 gtk_widget_invalidate_widget_windows (widget, invalidate);
2310 gdk_region_destroy (invalidate);
2315 if ((size_changed || position_changed) && widget->parent &&
2316 GTK_WIDGET_REALIZED (widget->parent) && GTK_CONTAINER (widget->parent)->reallocate_redraws)
2318 GdkRegion *invalidate = gdk_region_rectangle (&widget->parent->allocation);
2319 gtk_widget_invalidate_widget_windows (widget->parent, invalidate);
2320 gdk_region_destroy (invalidate);
2325 * gtk_widget_common_ancestor:
2326 * @widget_a: a #GtkWidget
2327 * @widget_b: a #GtkWidget
2329 * Find the common ancestor of @widget_a and @widget_b that
2330 * is closest to the two widgets.
2332 * Return value: the closest common ancestor of @widget_a and
2333 * @widget_b or %NULL if @widget_a and @widget_b do not
2334 * share a common ancestor.
2337 gtk_widget_common_ancestor (GtkWidget *widget_a,
2338 GtkWidget *widget_b)
2340 GtkWidget *parent_a;
2341 GtkWidget *parent_b;
2345 parent_a = widget_a;
2346 while (parent_a->parent)
2348 parent_a = parent_a->parent;
2352 parent_b = widget_b;
2353 while (parent_b->parent)
2355 parent_b = parent_b->parent;
2359 if (parent_a != parent_b)
2362 while (depth_a > depth_b)
2364 widget_a = widget_a->parent;
2368 while (depth_b > depth_a)
2370 widget_b = widget_b->parent;
2374 while (widget_a != widget_b)
2376 widget_a = widget_a->parent;
2377 widget_b = widget_b->parent;
2384 * gtk_widget_translate_coordinates:
2385 * @src_widget: a #GtkWidget
2386 * @dest_widget: a #GtkWidget
2387 * @src_x: X position relative to @src_widget
2388 * @src_y: Y position relative to @src_widget
2389 * @dest_x: location to store X position relative to @dest_widget
2390 * @dest_y: location to store Y position relative to @dest_widget
2392 * Translate coordinates relative to @src_widget's allocation to coordinates
2393 * relative to @dest_widget's allocations. In order to perform this
2394 * operation, both widgets must be realized, and must share a common
2397 * Return value: %FALSE if either widget was not realized, or there
2398 * was no common ancestor. In this case, nothing is stored in
2399 * *@dest_x and *@dest_y. Otherwise %TRUE.
2402 gtk_widget_translate_coordinates (GtkWidget *src_widget,
2403 GtkWidget *dest_widget,
2409 GtkWidget *ancestor;
2412 g_return_val_if_fail (GTK_IS_WIDGET (src_widget), FALSE);
2413 g_return_val_if_fail (GTK_IS_WIDGET (dest_widget), FALSE);
2415 ancestor = gtk_widget_common_ancestor (src_widget, dest_widget);
2416 if (!ancestor || !GTK_WIDGET_REALIZED (src_widget) || !GTK_WIDGET_REALIZED (dest_widget))
2419 /* Translate from allocation relative to window relative */
2420 if (!GTK_WIDGET_NO_WINDOW (src_widget) && src_widget->parent)
2423 gdk_window_get_position (src_widget->window, &wx, &wy);
2425 src_x -= wx - src_widget->allocation.x;
2426 src_y -= wy - src_widget->allocation.y;
2430 src_x += src_widget->allocation.x;
2431 src_y += src_widget->allocation.y;
2434 /* Translate to the common ancestor */
2435 window = src_widget->window;
2436 while (window != ancestor->window)
2440 gdk_window_get_position (window, &dx, &dy);
2445 window = gdk_window_get_parent (window);
2449 window = dest_widget->window;
2450 while (window != ancestor->window)
2454 gdk_window_get_position (window, &dx, &dy);
2459 window = gdk_window_get_parent (window);
2462 /* Translate from window relative to allocation relative */
2463 if (!GTK_WIDGET_NO_WINDOW (dest_widget) && dest_widget->parent)
2466 gdk_window_get_position (dest_widget->window, &wx, &wy);
2468 src_x += wx - dest_widget->allocation.x;
2469 src_y += wy - dest_widget->allocation.y;
2473 src_x -= dest_widget->allocation.x;
2474 src_y -= dest_widget->allocation.y;
2486 gtk_widget_real_size_allocate (GtkWidget *widget,
2487 GtkAllocation *allocation)
2489 g_return_if_fail (GTK_IS_WIDGET (widget));
2491 widget->allocation = *allocation;
2493 if (GTK_WIDGET_REALIZED (widget) &&
2494 !GTK_WIDGET_NO_WINDOW (widget))
2496 gdk_window_move_resize (widget->window,
2497 allocation->x, allocation->y,
2498 allocation->width, allocation->height);
2508 closure_accel_activate (GClosure *closure,
2509 GValue *return_value,
2510 guint n_param_values,
2511 const GValue *param_values,
2512 gpointer invocation_hint,
2513 gpointer marshal_data)
2515 AccelClosure *aclosure = (AccelClosure*) closure;
2517 if (GTK_WIDGET_IS_SENSITIVE (closure->data))
2518 g_signal_emit (closure->data, aclosure->signal_id, 0);
2520 /* we handled the accelerator */
2521 g_value_set_boolean (return_value, TRUE);
2525 closures_destroy (gpointer data)
2527 GSList *slist, *closures = data;
2529 for (slist = closures; slist; slist = slist->next)
2531 g_closure_invalidate (slist->data);
2532 g_closure_unref (slist->data);
2534 g_slist_free (closures);
2538 widget_new_accel_closure (GtkWidget *widget,
2541 AccelClosure *aclosure;
2542 GClosure *closure = NULL;
2543 GSList *slist, *closures;
2545 closures = g_object_steal_qdata (G_OBJECT (widget), quark_accel_closures);
2546 for (slist = closures; slist; slist = slist->next)
2547 if (!gtk_accel_group_from_accel_closure (slist->data))
2549 /* reuse this closure */
2550 closure = slist->data;
2555 closure = g_closure_new_object (sizeof (AccelClosure), G_OBJECT (widget));
2556 closures = g_slist_prepend (closures, g_closure_ref (closure));
2557 g_closure_sink (closure);
2558 g_closure_set_marshal (closure, closure_accel_activate);
2560 g_object_set_qdata_full (G_OBJECT (widget), quark_accel_closures, closures, closures_destroy);
2562 aclosure = (AccelClosure*) closure;
2563 g_assert (closure->data == widget);
2564 g_assert (closure->marshal == closure_accel_activate);
2565 aclosure->signal_id = signal_id;
2571 * gtk_widget_add_accelerator
2572 * @widget: widget to install an accelerator on
2573 * @accel_signal: widget signal to emit on accelerator actiavtion
2574 * @accel_group: accel group for this widget, added to its toplevel
2575 * @accel_key: GDK keyval of the accelerator
2576 * @accel_mods: modifier key combination of the accelerator
2577 * @accel_flags: flag accelerators, e.g. GTK_ACCEL_VISIBLE
2579 * Install an accelerator for this @widget in @accel_group, that causes
2580 * @accel_signal to be emitted if the accelerator is actiavted.
2581 * The @accel_group needs to be added to the widget's toplevel via
2582 * gtk_window_add_accel_group(), and the signal must be of type %G_RUN_ACTION.
2583 * Accelerators added through this function are not user changable during
2584 * runtime. If you want to support accelerators that can be changed by the
2585 * user, use gtk_accel_map_add_entry() and gtk_menu_item_set_accel_path()
2589 gtk_widget_add_accelerator (GtkWidget *widget,
2590 const gchar *accel_signal,
2591 GtkAccelGroup *accel_group,
2594 GtkAccelFlags accel_flags)
2599 g_return_if_fail (GTK_IS_WIDGET (widget));
2600 g_return_if_fail (accel_signal != NULL);
2601 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
2603 g_signal_query (g_signal_lookup (accel_signal, G_OBJECT_TYPE (widget)), &query);
2604 if (!query.signal_id ||
2605 !(query.signal_flags & G_SIGNAL_ACTION) ||
2606 query.return_type != G_TYPE_NONE ||
2609 /* hmm, should be elaborate enough */
2610 g_warning (G_STRLOC ": widget `%s' has no activatable signal \"%s\" without arguments",
2611 G_OBJECT_TYPE_NAME (widget), accel_signal);
2615 closure = widget_new_accel_closure (widget, query.signal_id);
2617 /* install the accelerator. since we don't map this onto an accel_path,
2618 * the accelerator will automatically be locked.
2620 gtk_accel_group_connect (accel_group,
2623 accel_flags | GTK_ACCEL_LOCKED,
2627 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
2631 * gtk_widget_remove_accelerator
2632 * @widget: widget to install an accelerator on
2633 * @accel_group: accel group for this widget
2634 * @accel_key: GDK keyval of the accelerator
2635 * @accel_mods: modifier key combination of the accelerator
2636 * @returns: whether an accelerator was installed and could be removed
2638 * Remove an accelerator from @widget, previously installed with
2639 * gtk_widget_add_accelerator().
2642 gtk_widget_remove_accelerator (GtkWidget *widget,
2643 GtkAccelGroup *accel_group,
2647 GtkAccelGroupEntry *ag_entry;
2651 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
2652 g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE);
2654 ag_entry = gtk_accel_group_query (accel_group, accel_key, accel_mods, &n);
2655 for (slist = _gtk_widget_get_accel_closures (widget); slist; slist = slist->next)
2657 /* paranoid sanity checking */
2658 for (i = 0; i < n; i++)
2659 if (slist->data == (gpointer) ag_entry[i].closure)
2661 gboolean is_removed = gtk_accel_groups_disconnect_closure (slist->data);
2662 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
2667 g_warning (G_STRLOC ": no accelerator (%u,%u) installed in accel group (%p) for %s (%p)",
2668 accel_key, accel_mods, accel_group,
2669 G_OBJECT_TYPE_NAME (widget), widget);
2675 _gtk_widget_get_accel_closures (GtkWidget *widget)
2677 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
2679 return g_object_get_qdata (G_OBJECT (widget), quark_accel_closures);
2684 GtkAccelGroup *accel_group;
2690 accel_path_changed (gpointer data,
2691 GQuark accel_path_quark,
2694 GtkAccelGroup *accel_group,
2695 guint old_accel_key,
2696 guint old_accel_mods)
2698 AccelPath *apath = data;
2699 gboolean notify = FALSE;
2703 /* the closure might have been removed already (due to replacements) */
2704 gtk_accel_groups_disconnect_closure (apath->closure);
2705 g_closure_unref (apath->closure);
2706 apath->closure = NULL;
2711 apath->closure = widget_new_accel_closure (apath->widget, GTK_WIDGET_GET_CLASS (apath->widget)->activate_signal);
2712 g_closure_ref (apath->closure);
2713 /* need to specify path to get an unlocked accelerator */
2714 gtk_accel_group_connect (apath->accel_group,
2723 g_signal_emit (apath->widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
2727 destroy_accel_path (gpointer data)
2729 AccelPath *apath = data;
2731 /* stop notification */
2732 gtk_accel_map_remove_notifer (apath->path, apath, accel_path_changed);
2734 /* if the closure is currently connected, get rid of that connection */
2737 gtk_accel_groups_disconnect_closure (apath->closure);
2738 g_closure_unref (apath->closure);
2740 g_object_unref (apath->accel_group);
2744 /* accel_group: the accel group used to activate this widget
2745 * accel_path: the accel path, associating the accelerator
2746 * to activate this widget
2747 * set accel path through which this widget can be actiavated.
2750 _gtk_widget_set_accel_path (GtkWidget *widget,
2751 const gchar *accel_path,
2752 GtkAccelGroup *accel_group)
2757 g_return_if_fail (GTK_IS_WIDGET (widget));
2758 g_return_if_fail (GTK_WIDGET_GET_CLASS (widget)->activate_signal != 0);
2760 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
2764 GQuark quark_path = gtk_accel_map_add_entry (accel_path, 0, 0);
2767 return; /* pathologic anyway */
2769 apath = g_new (AccelPath, 1);
2770 apath->widget = widget;
2771 apath->accel_group = g_object_ref (accel_group);
2772 apath->path = g_quark_to_string (quark_path);
2773 apath->closure = NULL;
2778 /* also removes possible old settings */
2779 g_object_set_qdata_full (G_OBJECT (widget), quark_accel_path, apath, destroy_accel_path);
2783 /* setup accel path hooks to react to changes */
2784 gtk_accel_map_add_notifer (apath->path, apath, accel_path_changed, apath->accel_group);
2786 /* install accelerators for this path */
2787 if (gtk_accel_map_lookup_entry (apath->path, &key))
2788 accel_path_changed (apath, g_quark_try_string (apath->path), key.accel_key, key.accel_mods, NULL, 0, 0);
2793 _gtk_widget_get_accel_path (GtkWidget *widget)
2797 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
2799 apath = g_object_get_qdata (G_OBJECT (widget), quark_accel_path);
2800 return apath ? apath->path : NULL;
2804 gtk_widget_mnemonic_activate (GtkWidget *widget,
2805 gboolean group_cycling)
2809 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
2811 group_cycling = group_cycling != FALSE;
2812 if (!GTK_WIDGET_IS_SENSITIVE (widget))
2815 gtk_signal_emit (GTK_OBJECT (widget),
2816 widget_signals[MNEMONIC_ACTIVATE],
2823 gtk_widget_real_mnemonic_activate (GtkWidget *widget,
2824 gboolean group_cycling)
2826 if (!group_cycling && GTK_WIDGET_GET_CLASS (widget)->activate_signal)
2827 gtk_widget_activate (widget);
2828 else if (GTK_WIDGET_CAN_FOCUS (widget))
2829 gtk_widget_grab_focus (widget);
2832 g_warning ("widget `%s' isn't suitable for mnemonic activation",
2833 G_OBJECT_TYPE_NAME (widget));
2840 gtk_widget_real_key_press_event (GtkWidget *widget,
2843 gboolean handled = FALSE;
2845 g_return_val_if_fail (GTK_IS_WIDGET (widget), handled);
2846 g_return_val_if_fail (event != NULL, handled);
2849 handled = gtk_bindings_activate (GTK_OBJECT (widget),
2857 gtk_widget_real_key_release_event (GtkWidget *widget,
2860 gboolean handled = FALSE;
2862 g_return_val_if_fail (GTK_IS_WIDGET (widget), handled);
2863 g_return_val_if_fail (event != NULL, handled);
2866 handled = gtk_bindings_activate (GTK_OBJECT (widget),
2868 event->state | GDK_RELEASE_MASK);
2874 gtk_widget_real_focus_in_event (GtkWidget *widget,
2875 GdkEventFocus *event)
2877 GTK_WIDGET_SET_FLAGS (widget, GTK_HAS_FOCUS);
2878 gtk_widget_queue_draw (widget);
2884 gtk_widget_real_focus_out_event (GtkWidget *widget,
2885 GdkEventFocus *event)
2887 GTK_WIDGET_UNSET_FLAGS (widget, GTK_HAS_FOCUS);
2888 gtk_widget_queue_draw (widget);
2895 * @widget: a #GtkWidget
2896 * @event: a #GdkEvent
2898 * Rarely-used function. This function is used to emit
2899 * the event signals on a widget (those signals should never
2900 * be emitted without using this function to do so).
2901 * If you want to synthesize an event though, don't use this function;
2902 * instead, use gtk_main_do_event() so the event will behave as if
2903 * it were in the event queue. Don't synthesize expose events; instead,
2904 * use gdk_window_invalidate_rect() to invalidate a region of the
2907 * Return value: return from the event signal emission (%TRUE if the event was handled)
2910 gtk_widget_event (GtkWidget *widget,
2913 g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
2914 g_return_val_if_fail (GTK_WIDGET_REALIZED (widget), TRUE);
2916 if (event->type == GDK_EXPOSE)
2918 g_warning ("Events of type GDK_EXPOSE cannot be synthesized. To get "
2919 "the same effect, call gdk_window_invalidate_rect/region(), "
2920 "followed by gdk_window_process_updates().");
2924 return gtk_widget_event_internal (widget, event);
2929 * gtk_widget_send_expose:
2930 * @widget: a #GtkWidget
2931 * @event: a expose #GdkEvent
2933 * Very rarely-used function. This function is used to emit
2934 * an expose event signals on a widget. This function is not
2935 * normally used directly. The only time it is used is when
2936 * propagating an expose event to a child NO_WINDOW widget, and
2937 * that is normally done using gtk_container_propagate_expose.
2939 * If you want to force an area of a window to be redrawn,
2940 * use gdk_window_invalidate_rect() or gdk_window_invalidate_region().
2941 * To cause the redraw to be done immediately, follow that call
2942 * with a call to gdk_window_procss_updates().
2944 * Return value: return from the event signal emission (%TRUE if the event was handled)
2947 gtk_widget_send_expose (GtkWidget *widget,
2950 g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
2951 g_return_val_if_fail (GTK_WIDGET_REALIZED (widget), TRUE);
2952 g_return_val_if_fail (event != NULL, TRUE);
2953 g_return_val_if_fail (event->type == GDK_EXPOSE, TRUE);
2955 if (event->type != GDK_EXPOSE)
2958 return gtk_widget_event_internal (widget, event);
2962 gtk_widget_event_internal (GtkWidget *widget,
2965 gboolean return_val = FALSE;
2967 gtk_widget_ref (widget);
2969 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[EVENT], event, &return_val);
2970 return_val |= !GTK_WIDGET_REALIZED (widget);
2975 switch (event->type)
2980 case GDK_BUTTON_PRESS:
2981 case GDK_2BUTTON_PRESS:
2982 case GDK_3BUTTON_PRESS:
2983 signal_num = BUTTON_PRESS_EVENT;
2986 signal_num = SCROLL_EVENT;
2988 case GDK_BUTTON_RELEASE:
2989 signal_num = BUTTON_RELEASE_EVENT;
2991 case GDK_MOTION_NOTIFY:
2992 signal_num = MOTION_NOTIFY_EVENT;
2995 signal_num = DELETE_EVENT;
2998 signal_num = DESTROY_EVENT;
3001 signal_num = KEY_PRESS_EVENT;
3003 case GDK_KEY_RELEASE:
3004 signal_num = KEY_RELEASE_EVENT;
3006 case GDK_ENTER_NOTIFY:
3007 signal_num = ENTER_NOTIFY_EVENT;
3009 case GDK_LEAVE_NOTIFY:
3010 signal_num = LEAVE_NOTIFY_EVENT;
3012 case GDK_FOCUS_CHANGE:
3013 signal_num = event->focus_change.in ? FOCUS_IN_EVENT : FOCUS_OUT_EVENT;
3016 signal_num = CONFIGURE_EVENT;
3019 signal_num = MAP_EVENT;
3022 signal_num = UNMAP_EVENT;
3024 case GDK_WINDOW_STATE:
3025 signal_num = WINDOW_STATE_EVENT;
3027 case GDK_PROPERTY_NOTIFY:
3028 signal_num = PROPERTY_NOTIFY_EVENT;
3030 case GDK_SELECTION_CLEAR:
3031 signal_num = SELECTION_CLEAR_EVENT;
3033 case GDK_SELECTION_REQUEST:
3034 signal_num = SELECTION_REQUEST_EVENT;
3036 case GDK_SELECTION_NOTIFY:
3037 signal_num = SELECTION_NOTIFY_EVENT;
3039 case GDK_PROXIMITY_IN:
3040 signal_num = PROXIMITY_IN_EVENT;
3042 case GDK_PROXIMITY_OUT:
3043 signal_num = PROXIMITY_OUT_EVENT;
3046 signal_num = NO_EXPOSE_EVENT;
3048 case GDK_CLIENT_EVENT:
3049 signal_num = CLIENT_EVENT;
3052 signal_num = EXPOSE_EVENT;
3054 case GDK_VISIBILITY_NOTIFY:
3055 signal_num = VISIBILITY_NOTIFY_EVENT;
3058 g_warning ("gtk_widget_event(): unhandled event type: %d", event->type);
3062 if (signal_num != -1)
3063 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[signal_num], event, &return_val);
3065 if (GTK_WIDGET_REALIZED (widget))
3066 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[EVENT_AFTER], event);
3070 gtk_widget_unref (widget);
3076 * gtk_widget_activate:
3077 * @widget: a #GtkWidget that's activatable
3079 * For widgets that can be "activated" (buttons, menu items, etc.)
3080 * this function activates them. Activation is what happens when you
3081 * press Enter on a widget during key navigation; clicking a button,
3082 * selecting a menu item, etc. If @widget isn't activatable,
3083 * the function returns %FALSE.
3085 * Return value: %TRUE if the widget was activatable
3088 gtk_widget_activate (GtkWidget *widget)
3090 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
3092 if (WIDGET_CLASS (widget)->activate_signal)
3094 /* FIXME: we should eventually check the signals signature here */
3095 gtk_signal_emit (GTK_OBJECT (widget), WIDGET_CLASS (widget)->activate_signal);
3104 * gtk_widget_set_scroll_adjustments:
3105 * @widget: a #GtkWidget
3106 * @hadjustment: an adjustment for horizontal scrolling, or %NULL
3107 * @vadjustment: an adjustment for vertical scrolling, or %NULL
3109 * For widgets that support scrolling, sets the scroll adjustments and
3110 * returns %TRUE. For widgets that don't support scrolling, does
3111 * nothing and returns %FALSE. Widgets that don't support scrolling
3112 * can be scrolled by placing them in a #GtkViewport, which does
3113 * support scrolling.
3115 * Return value: %TRUE if the widget supports scrolling
3118 gtk_widget_set_scroll_adjustments (GtkWidget *widget,
3119 GtkAdjustment *hadjustment,
3120 GtkAdjustment *vadjustment)
3122 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
3124 g_return_val_if_fail (GTK_IS_ADJUSTMENT (hadjustment), FALSE);
3126 g_return_val_if_fail (GTK_IS_ADJUSTMENT (vadjustment), FALSE);
3128 if (WIDGET_CLASS (widget)->set_scroll_adjustments_signal)
3130 /* FIXME: we should eventually check the signals signature here */
3131 gtk_signal_emit (GTK_OBJECT (widget),
3132 WIDGET_CLASS (widget)->set_scroll_adjustments_signal,
3133 hadjustment, vadjustment);
3140 /*****************************************
3141 * gtk_widget_reparent_container_child:
3142 * assistent function to gtk_widget_reparent
3147 *****************************************/
3150 gtk_widget_reparent_container_child (GtkWidget *widget,
3151 gpointer client_data)
3153 g_return_if_fail (GTK_IS_WIDGET (widget));
3154 g_return_if_fail (client_data != NULL);
3156 if (GTK_WIDGET_NO_WINDOW (widget))
3159 gdk_window_unref (widget->window);
3160 widget->window = (GdkWindow*) client_data;
3162 gdk_window_ref (widget->window);
3164 if (GTK_IS_CONTAINER (widget))
3165 gtk_container_forall (GTK_CONTAINER (widget),
3166 gtk_widget_reparent_container_child,
3170 gdk_window_reparent (widget->window,
3171 (GdkWindow*) client_data, 0, 0);
3175 * gtk_widget_reparent:
3176 * @widget: a #GtkWidget
3177 * @new_parent: a #GtkContainer to move the widget into
3179 * Moves a widget from one #GtkContainer to another, handling reference
3180 * count issues to avoid destroying the widget.
3184 gtk_widget_reparent (GtkWidget *widget,
3185 GtkWidget *new_parent)
3187 g_return_if_fail (GTK_IS_WIDGET (widget));
3188 g_return_if_fail (GTK_IS_CONTAINER (new_parent));
3189 g_return_if_fail (widget->parent != NULL);
3191 if (widget->parent != new_parent)
3193 /* First try to see if we can get away without unrealizing
3194 * the widget as we reparent it. if so we set a flag so
3195 * that gtk_widget_unparent doesn't unrealize widget
3197 if (GTK_WIDGET_REALIZED (widget) && GTK_WIDGET_REALIZED (new_parent))
3198 GTK_PRIVATE_SET_FLAG (widget, GTK_IN_REPARENT);
3200 gtk_widget_ref (widget);
3201 gtk_container_remove (GTK_CONTAINER (widget->parent), widget);
3202 gtk_container_add (GTK_CONTAINER (new_parent), widget);
3203 gtk_widget_unref (widget);
3205 if (GTK_WIDGET_IN_REPARENT (widget))
3207 GTK_PRIVATE_UNSET_FLAG (widget, GTK_IN_REPARENT);
3209 gtk_widget_reparent_container_child (widget,
3210 gtk_widget_get_parent_window (widget));
3216 * gtk_widget_intersect:
3217 * @widget: a #GtkWidget
3218 * @area: a rectangle
3219 * @intersection: rectangle to store intersection of @widget and @area
3221 * Computes the intersection of a @widget's area and @area, storing
3222 * the intersection in @intersection, and returns %TRUE if there was
3223 * an intersection. @intersection may be %NULL if you're only
3224 * interested in whether there was an intersection.
3226 * Return value: %TRUE if there was an intersection
3229 gtk_widget_intersect (GtkWidget *widget,
3231 GdkRectangle *intersection)
3237 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
3238 g_return_val_if_fail (area != NULL, FALSE);
3241 dest = intersection;
3245 return_val = gdk_rectangle_intersect (&widget->allocation, area, dest);
3247 if (return_val && intersection && !GTK_WIDGET_NO_WINDOW (widget))
3249 intersection->x -= widget->allocation.x;
3250 intersection->y -= widget->allocation.y;
3257 * gtk_widget_region_intersect:
3258 * @widget: a #GtkWidget
3259 * @region: a #GdkRegion, in the same coordinate system as
3260 * widget->allocation. That is, relative to widget->window
3261 * for NO_WINDOW widgets; relative to the parent window
3262 * of widget->window for widgets with their own window.
3263 * @returns: A newly allocated region holding the intersection of @widget
3264 * and @region. The coordinates of the return value are
3265 * relative to widget->window for NO_WINDOW widgets, and
3266 * relative to the parent window of widget->window for
3267 * widgets with their own window.
3269 * Computes the intersection of a @widget's area and @region, returning
3270 * the intersection. The result may be empty, use #gdk_region_empty to
3274 gtk_widget_region_intersect (GtkWidget *widget,
3279 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
3280 g_return_val_if_fail (region != NULL, NULL);
3282 dest = gdk_region_rectangle (&widget->allocation);
3284 gdk_region_intersect (dest, region);
3290 * gtk_widget_grab_focus:
3291 * @widget: a #GtkWidget
3293 * Causes @widget to have the keyboard focus for the #GtkWindow it's
3294 * inside. @widget must be a focusable widget, such as a #GtkEntry;
3295 * something like #GtkFrame won't work. (More precisely, it must have the
3296 * #GTK_CAN_FOCUS flag set.)
3300 gtk_widget_grab_focus (GtkWidget *widget)
3302 g_return_if_fail (GTK_IS_WIDGET (widget));
3304 g_object_ref (G_OBJECT (widget));
3305 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[GRAB_FOCUS]);
3306 g_object_notify (G_OBJECT (widget), "has_focus");
3307 g_object_unref (G_OBJECT (widget));
3311 reset_focus_recurse (GtkWidget *widget,
3314 if (GTK_IS_CONTAINER (widget))
3316 GtkContainer *container;
3318 container = GTK_CONTAINER (widget);
3319 gtk_container_set_focus_child (container, NULL);
3321 gtk_container_foreach (container,
3322 reset_focus_recurse,
3328 gtk_widget_real_grab_focus (GtkWidget *focus_widget)
3330 g_return_if_fail (GTK_IS_WIDGET (focus_widget));
3332 if (GTK_WIDGET_CAN_FOCUS (focus_widget))
3334 GtkWidget *toplevel;
3337 /* clear the current focus setting, break if the current widget
3338 * is the focus widget's parent, since containers above that will
3339 * be set by the next loop.
3341 toplevel = gtk_widget_get_toplevel (focus_widget);
3342 if (GTK_WIDGET_TOPLEVEL (toplevel))
3344 widget = GTK_WINDOW (toplevel)->focus_widget;
3346 if (widget == focus_widget)
3348 /* We call gtk_window_set_focus() here so that the
3349 * toplevel window can request the focus if necessary.
3350 * This is needed when the toplevel is a GtkPlug
3352 if (!GTK_WIDGET_HAS_FOCUS (widget))
3353 gtk_window_set_focus (GTK_WINDOW (toplevel), focus_widget);
3360 while (widget->parent && widget->parent != focus_widget->parent)
3362 widget = widget->parent;
3363 gtk_container_set_focus_child (GTK_CONTAINER (widget), NULL);
3367 else if (toplevel != focus_widget)
3369 /* gtk_widget_grab_focus() operates on a tree without window...
3370 * actually, this is very questionable behaviour.
3373 gtk_container_foreach (GTK_CONTAINER (toplevel),
3374 reset_focus_recurse,
3378 /* now propagate the new focus up the widget tree and finally
3379 * set it on the window
3381 widget = focus_widget;
3382 while (widget->parent)
3384 gtk_container_set_focus_child (GTK_CONTAINER (widget->parent), widget);
3385 widget = widget->parent;
3387 if (GTK_IS_WINDOW (widget))
3388 gtk_window_set_focus (GTK_WINDOW (widget), focus_widget);
3393 gtk_widget_real_show_help (GtkWidget *widget,
3394 GtkWidgetHelpType help_type)
3396 if (help_type == GTK_WIDGET_HELP_TOOLTIP)
3397 _gtk_tooltips_show_tip (widget);
3401 gtk_widget_real_focus (GtkWidget *widget,
3402 GtkDirectionType direction)
3404 if (!GTK_WIDGET_CAN_FOCUS (widget))
3407 if (!gtk_widget_is_focus (widget))
3409 gtk_widget_grab_focus (widget);
3417 * gtk_widget_is_focus:
3418 * @widget: a #GtkWidget
3420 * Determines if the widget is the focus widget within its
3421 * toplevel. (This does not mean that the HAS_FOCUS flag is
3422 * necessarily set; HAS_FOCUS will only be set if the
3423 * toplevel widget additionally has the global input focus.)
3425 * Return value: %TRUE if the widget is the focus widget.
3428 gtk_widget_is_focus (GtkWidget *widget)
3430 GtkWidget *toplevel;
3432 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
3434 toplevel = gtk_widget_get_toplevel (widget);
3436 if (GTK_IS_WINDOW (toplevel))
3437 return widget == GTK_WINDOW (toplevel)->focus_widget;
3443 * gtk_widget_grab_default:
3444 * @widget: a #GtkWidget
3446 * Causes @widget to become the default widget. @widget must have the
3447 * #GTK_CAN_DEFAULT flag set; typically you have to set this flag
3448 * yourself by calling GTK_WIDGET_SET_FLAGS (@widget,
3449 * GTK_CAN_DEFAULT). The default widget is activated when the user
3450 * presses Enter in a window. Default widgets must be activatable,
3451 * that is, gtk_widget_activate() should affect them.
3455 gtk_widget_grab_default (GtkWidget *widget)
3458 GtkType window_type;
3460 g_return_if_fail (GTK_IS_WIDGET (widget));
3461 g_return_if_fail (GTK_WIDGET_CAN_DEFAULT (widget));
3463 window_type = GTK_TYPE_WINDOW;
3464 window = widget->parent;
3466 while (window && !gtk_type_is_a (GTK_WIDGET_TYPE (window), window_type))
3467 window = window->parent;
3469 if (window && gtk_type_is_a (GTK_WIDGET_TYPE (window), window_type))
3471 gtk_window_set_default (GTK_WINDOW (window), widget);
3472 g_object_notify (G_OBJECT (widget), "has_default");
3475 g_warning (G_STRLOC ": widget not within a GtkWindow");
3479 * gtk_widget_set_name:
3480 * @widget: a #GtkWidget
3481 * @name: name for the widget
3483 * Widgets can be named, which allows you to refer to them from a
3484 * gtkrc file. You can apply a style to widgets with a particular name
3485 * in the gtkrc file. See the documentation for gtkrc files (on the
3486 * same page as the docs for #GtkRcStyle).
3490 gtk_widget_set_name (GtkWidget *widget,
3493 g_return_if_fail (GTK_IS_WIDGET (widget));
3496 g_free (widget->name);
3497 widget->name = g_strdup (name);
3499 if (GTK_WIDGET_RC_STYLE (widget))
3500 gtk_widget_reset_rc_style (widget);
3502 g_object_notify (G_OBJECT (widget), "name");
3506 * gtk_widget_get_name:
3507 * @widget: a #GtkWidget
3509 * Retrieves the name of a widget. The return value should not be
3510 * freed. See gtk_widget_set_name() for the significance of widget
3513 * Return value: name of the widget
3515 G_CONST_RETURN gchar*
3516 gtk_widget_get_name (GtkWidget *widget)
3518 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
3521 return widget->name;
3522 return gtk_type_name (GTK_WIDGET_TYPE (widget));
3526 * gtk_widget_set_state:
3527 * @widget: a #GtkWidget
3528 * @state: new state for @widget
3530 * This function is for use in widget implementations. Sets the state
3531 * of a widget (insensitive, prelighted, etc.) Usually you should set
3532 * the state using wrapper functions such as gtk_widget_set_sensitive().
3536 gtk_widget_set_state (GtkWidget *widget,
3539 g_return_if_fail (GTK_IS_WIDGET (widget));
3541 if (state == GTK_WIDGET_STATE (widget))
3544 if (state == GTK_STATE_INSENSITIVE)
3545 gtk_widget_set_sensitive (widget, FALSE);
3551 data.state_restoration = FALSE;
3552 data.use_forall = FALSE;
3554 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget->parent) != FALSE);
3556 data.parent_sensitive = TRUE;
3558 gtk_widget_propagate_state (widget, &data);
3560 if (GTK_WIDGET_DRAWABLE (widget))
3561 gtk_widget_queue_clear (widget);
3566 gtk_widget_set_app_paintable (GtkWidget *widget,
3567 gboolean app_paintable)
3569 g_return_if_fail (GTK_IS_WIDGET (widget));
3571 app_paintable = (app_paintable != FALSE);
3573 if (GTK_WIDGET_APP_PAINTABLE (widget) != app_paintable)
3576 GTK_WIDGET_SET_FLAGS (widget, GTK_APP_PAINTABLE);
3578 GTK_WIDGET_UNSET_FLAGS (widget, GTK_APP_PAINTABLE);
3580 if (GTK_WIDGET_DRAWABLE (widget))
3581 gtk_widget_queue_clear (widget);
3583 g_object_notify (G_OBJECT (widget), "app_paintable");
3588 * gtk_widget_set_double_buffered:
3589 * @widget: a #GtkWidget
3590 * @double_buffered: %TRUE to double-buffer a widget
3592 * Widgets are double buffered by default; you can use this function
3593 * to turn off the buffering. "Double buffered" simply means that
3594 * gdk_window_begin_paint_region() and gdk_window_end_paint() are called
3595 * automatically around expose events sent to the
3596 * widget. gdk_window_begin_paint() diverts all drawing to a widget's
3597 * window to an offscreen buffer, and gdk_window_end_paint() draws the
3598 * buffer to the screen. The result is that users see the window
3599 * update in one smooth step, and don't see individual graphics
3600 * primitives being rendered.
3602 * In very simple terms, double buffered widgets don't flicker,
3603 * so you would only use this function to turn off double buffering
3604 * if you had special needs and really knew what you were doing.
3608 gtk_widget_set_double_buffered (GtkWidget *widget,
3609 gboolean double_buffered)
3611 g_return_if_fail (GTK_IS_WIDGET (widget));
3613 if (double_buffered)
3614 GTK_WIDGET_SET_FLAGS (widget, GTK_DOUBLE_BUFFERED);
3616 GTK_WIDGET_UNSET_FLAGS (widget, GTK_DOUBLE_BUFFERED);
3620 * gtk_widget_set_redraw_on_allocate:
3621 * @widget: a #GtkWidget
3622 * @redraw_on_allocate: if %TRUE, the entire widget will be redrawn
3623 * when it is allocated to a new size. Otherwise, only the
3624 * new portion of the widget will be redrawn.
3626 * Sets whether a when a widgets size allocation changes, the entire
3627 * widget is queued for drawing. By default, this setting is %TRUE and
3628 * the entire widget is redrawn on every size change. If your widget
3629 * leaves the upper left are unchanged when made bigger, turning this
3630 * setting on will improve performance.
3632 * Note that for NO_WINDOW widgets setting this flag to %FALSE turns
3633 * off all allocation on resizing: the widget will not even redraw if
3634 * its position changes; this is to allow containers that don't draw
3635 * anything to avoid excess invalidations. If you set this flag on a
3636 * NO_WINDOW widget that _does_ draw on widget->window, you are
3637 * responsible for invalidating both the old and new allocation of the
3638 * widget when the widget is moved and responsible for invalidating
3639 * regions newly when the widget increases size.
3642 gtk_widget_set_redraw_on_allocate (GtkWidget *widget,
3643 gboolean redraw_on_allocate)
3645 g_return_if_fail (GTK_IS_WIDGET (widget));
3647 if (redraw_on_allocate)
3648 GTK_PRIVATE_SET_FLAG (widget, GTK_REDRAW_ON_ALLOC);
3650 GTK_PRIVATE_UNSET_FLAG (widget, GTK_REDRAW_ON_ALLOC);
3654 * gtk_widget_set_sensitive:
3655 * @widget: a @widget
3656 * @sensitive: %TRUE to make the widget sensitive
3658 * Sets the sensitivity of a widget. A widget is sensitive if the user
3659 * can interact with it. Insensitive widgets are "grayed out" and the
3660 * user can't interact with them. Insensitive widgets are known as
3661 * "inactive" in some other toolkits.
3665 gtk_widget_set_sensitive (GtkWidget *widget,
3670 g_return_if_fail (GTK_IS_WIDGET (widget));
3672 sensitive = (sensitive != FALSE);
3674 if (sensitive == (GTK_WIDGET_SENSITIVE (widget) != FALSE))
3679 GTK_WIDGET_SET_FLAGS (widget, GTK_SENSITIVE);
3680 data.state = GTK_WIDGET_SAVED_STATE (widget);
3684 GTK_WIDGET_UNSET_FLAGS (widget, GTK_SENSITIVE);
3685 data.state = GTK_WIDGET_STATE (widget);
3687 data.state_restoration = TRUE;
3688 data.use_forall = TRUE;
3691 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget->parent) != FALSE);
3693 data.parent_sensitive = TRUE;
3695 gtk_widget_propagate_state (widget, &data);
3696 if (GTK_WIDGET_DRAWABLE (widget))
3697 gtk_widget_queue_clear (widget);
3699 g_object_notify (G_OBJECT (widget), "sensitive");
3703 * gtk_widget_set_parent:
3704 * @widget: a #GtkWidget
3705 * @parent: parent container
3707 * This function is useful only when implementing subclasses of #GtkContainer.
3708 * Sets the container as the parent of @widget, and takes care of
3709 * some details such as updating the state and style of the child
3710 * to reflect its new location. The opposite function is
3711 * gtk_widget_unparent().
3715 gtk_widget_set_parent (GtkWidget *widget,
3720 g_return_if_fail (GTK_IS_WIDGET (widget));
3721 g_return_if_fail (widget->parent == NULL);
3722 g_return_if_fail (!GTK_WIDGET_TOPLEVEL (widget));
3723 g_return_if_fail (GTK_IS_WIDGET (parent));
3724 g_return_if_fail (widget != parent);
3726 /* keep this function in sync with gtk_menu_attach_to_widget()
3729 gtk_widget_ref (widget);
3730 gtk_object_sink (GTK_OBJECT (widget));
3731 widget->parent = parent;
3733 if (GTK_WIDGET_STATE (parent) != GTK_STATE_NORMAL)
3734 data.state = GTK_WIDGET_STATE (parent);
3736 data.state = GTK_WIDGET_STATE (widget);
3737 data.state_restoration = FALSE;
3738 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (parent) != FALSE);
3739 data.use_forall = GTK_WIDGET_IS_SENSITIVE (parent) != GTK_WIDGET_IS_SENSITIVE (widget);
3741 gtk_widget_propagate_state (widget, &data);
3743 gtk_widget_set_style_recurse (widget, NULL);
3745 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[PARENT_SET], NULL);
3746 if (GTK_WIDGET_ANCHORED (widget->parent))
3747 _gtk_widget_propagate_hierarchy_changed (widget, NULL);
3748 g_object_notify (G_OBJECT (widget), "parent");
3750 /* Enforce realized/mapped invariants
3752 if (GTK_WIDGET_REALIZED (widget->parent))
3753 gtk_widget_realize (widget);
3755 if (GTK_WIDGET_VISIBLE (widget->parent) &&
3756 GTK_WIDGET_VISIBLE (widget))
3758 if (GTK_WIDGET_CHILD_VISIBLE (widget) &&
3759 GTK_WIDGET_MAPPED (widget->parent))
3760 gtk_widget_map (widget);
3762 gtk_widget_queue_resize (widget);
3767 * gtk_widget_get_parent:
3768 * @widget: a #GtkWidget
3770 * Returns the parent container of @widget.
3772 * Return value: the parent container of @widget, or %NULL
3775 gtk_widget_get_parent (GtkWidget *widget)
3777 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
3779 return widget->parent;
3782 /*****************************************
3784 * see docs/styles.txt
3785 *****************************************/
3788 * gtk_widget_set_style:
3789 * @widget: a #GtkWidget
3790 * @style: a #GtkStyle, or %NULL to remove the effect of a previous
3791 * gtk_widget_set_style and go back to the default style
3793 * Sets the #GtkStyle for a widget (widget->style). You probably don't
3794 * want to use this function; it interacts badly with themes, because
3795 * themes work by replacing the #GtkStyle. Instead, use
3796 * gtk_widget_modify_style().
3800 gtk_widget_set_style (GtkWidget *widget,
3803 g_return_if_fail (GTK_IS_WIDGET (widget));
3807 gboolean initial_emission;
3809 initial_emission = !GTK_WIDGET_RC_STYLE (widget) && !GTK_WIDGET_USER_STYLE (widget);
3811 GTK_WIDGET_UNSET_FLAGS (widget, GTK_RC_STYLE);
3812 GTK_PRIVATE_SET_FLAG (widget, GTK_USER_STYLE);
3814 gtk_widget_set_style_internal (widget, style, initial_emission);
3818 if (GTK_WIDGET_USER_STYLE (widget))
3819 gtk_widget_reset_rc_style (widget);
3824 * gtk_widget_ensure_style:
3825 * @widget: a #GtkWidget
3827 * Ensures that @widget has a style (widget->style). Not a very useful
3828 * function; most of the time, if you want the style, the widget is
3829 * realized, and realized widgets are guaranteed to have a style
3834 gtk_widget_ensure_style (GtkWidget *widget)
3836 g_return_if_fail (GTK_IS_WIDGET (widget));
3838 if (!GTK_WIDGET_USER_STYLE (widget) &&
3839 !GTK_WIDGET_RC_STYLE (widget))
3840 gtk_widget_reset_rc_style (widget);
3843 /* Look up the RC style for this widget, unsetting any user style that
3844 * may be in effect currently
3847 gtk_widget_reset_rc_style (GtkWidget *widget)
3849 GtkStyle *new_style;
3850 gboolean initial_emission;
3852 g_return_if_fail (GTK_IS_WIDGET (widget));
3854 initial_emission = !GTK_WIDGET_RC_STYLE (widget) && !GTK_WIDGET_USER_STYLE (widget);
3856 GTK_PRIVATE_UNSET_FLAG (widget, GTK_USER_STYLE);
3857 GTK_WIDGET_SET_FLAGS (widget, GTK_RC_STYLE);
3859 new_style = gtk_rc_get_style (widget);
3861 new_style = gtk_widget_get_default_style ();
3863 if (initial_emission || new_style != widget->style)
3864 gtk_widget_set_style_internal (widget, new_style, initial_emission);
3868 * gtk_widget_get_style:
3869 * @widget: a #GtkWidget
3871 * Simply an accessor function that returns widget->style.
3873 * Return value: the widget's #GtkStyle
3876 gtk_widget_get_style (GtkWidget *widget)
3878 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
3880 return widget->style;
3884 * gtk_widget_modify_style:
3885 * @widget: a #GtkWidget
3886 * @style: the #GtkRcStyle holding the style modifications
3888 * Modify style values on the widget. Modifications made using this
3889 * technique take precedence over style values set via an RC file,
3890 * however, they will be overriden if a style is explicitely set on
3891 * the widget using gtk_widget_set_style(). The #GtkRcStyle structure
3892 * is designed so each field can either be set or unset, so it is
3893 * possible, using this function, to modify some style values and
3894 * leave the others unchanged.
3896 * Note that modifications made with this function are not cumulative
3897 * with previous calls to gtk_widget_modify_style() or with such
3898 * functions as gtk_widget_modify_fg(). If you wish to retain
3899 * previous values, you must first call gtk_widget_get_modifier_style(),
3900 * make your modifications to the returned style, then call
3901 * gtk_widget_modify_style() with that style. On the other hand,
3902 * if you first call gtk_widget_modify_style(), subsequent calls
3903 * to such functions gtk_widget_modify_fg() will have a cumulative
3904 * effect with the initial modifications.
3907 gtk_widget_modify_style (GtkWidget *widget,
3910 GtkRcStyle *old_style;
3912 g_return_if_fail (GTK_IS_RC_STYLE (style));
3914 old_style = gtk_object_get_data_by_id (GTK_OBJECT (widget),
3917 gtk_object_set_data_by_id_full (GTK_OBJECT (widget),
3919 gtk_rc_style_copy (style),
3920 (GtkDestroyNotify)gtk_rc_style_unref);
3922 /* note that "style" may be invalid here if it was the old
3923 * modifier style and the only reference was our own.
3926 if (GTK_WIDGET_RC_STYLE (widget))
3927 gtk_widget_reset_rc_style (widget);
3931 * gtk_widget_get_modifier_style:
3932 * @widget: a #GtkWidget
3934 * Return the current modifier style for the widget. (As set by
3935 * gtk_widget_modify_style().) If no style has previously set, a new
3936 * #GtkRcStyle will be created with all values unset, and set as the
3937 * modifier style for the widget. If you make changes to this rc
3938 * style, you must call gtk_widget_modify_style(), passing in the
3939 * returned rc style, to make sure that your changes take effect.
3941 * Caution: passing the style back to gtk_widget_modify_style() will
3942 * normally end up destroying it, because gtk_widget_modify_style() copies
3943 * the passed-in style and sets the copy as the new modifier style,
3944 * thus dropping any reference to the old modifier style. Add a reference
3945 * to the modifier style if you want to keep it alive.
3947 * Return value: the modifier style for the widget. This rc style is
3948 * owned by the widget. If you want to keep a pointer to value this
3949 * around, you must add a refcount using gtk_rc_style_ref().
3952 gtk_widget_get_modifier_style (GtkWidget *widget)
3954 GtkRcStyle *rc_style;
3956 rc_style = gtk_object_get_data_by_id (GTK_OBJECT (widget),
3961 rc_style = gtk_rc_style_new ();
3962 gtk_object_set_data_by_id_full (GTK_OBJECT (widget),
3965 (GtkDestroyNotify)gtk_rc_style_unref);
3972 gtk_widget_modify_color_component (GtkWidget *widget,
3973 GtkRcFlags component,
3977 GtkRcStyle *rc_style = gtk_widget_get_modifier_style (widget);
3982 rc_style->fg[state] = *color;
3985 rc_style->bg[state] = *color;
3988 rc_style->text[state] = *color;
3991 rc_style->base[state] = *color;
3994 g_assert_not_reached();
3997 rc_style->color_flags[state] |= component;
3999 gtk_widget_modify_style (widget, rc_style);
4003 * gtk_widget_modify_fg:
4004 * @widget: a #GtkWidget.
4005 * @state: the state for which to set the foreground color.
4006 * @color: the color to assign (does not need to be allocated).
4008 * Set the foreground color for a widget in a particular state. All
4009 * other style values are left untouched. See also
4010 * gtk_widget_modify_style().
4013 gtk_widget_modify_fg (GtkWidget *widget,
4017 g_return_if_fail (GTK_IS_WIDGET (widget));
4018 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
4019 g_return_if_fail (color != NULL);
4021 gtk_widget_modify_color_component (widget, GTK_RC_FG, state, color);
4025 * gtk_widget_modify_bg:
4026 * @widget: a #GtkWidget.
4027 * @state: the state for which to set the background color.
4028 * @color: the color to assign (does not need to be allocated).
4030 * Set the background color for a widget in a particular state. All
4031 * other style values are left untouched. See also
4032 * gtk_widget_modify_style().
4035 gtk_widget_modify_bg (GtkWidget *widget,
4039 g_return_if_fail (GTK_IS_WIDGET (widget));
4040 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
4041 g_return_if_fail (color != NULL);
4043 gtk_widget_modify_color_component (widget, GTK_RC_BG, state, color);
4047 * gtk_widget_modify_text:
4048 * @widget: a #GtkWidget.
4049 * @state: the state for which to set the text color.
4050 * @color: the color to assign (does not need to be allocated).
4052 * Set the text color for a widget in a particular state. All other
4053 * style values are left untouched. The text color is the foreground
4054 * color used along with the base color (see gtk_widget_modify_base)
4055 * for widgets such as #GtkEntry and #GtkTextView. See also
4056 * gtk_widget_modify_style().
4059 gtk_widget_modify_text (GtkWidget *widget,
4063 g_return_if_fail (GTK_IS_WIDGET (widget));
4064 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
4065 g_return_if_fail (color != NULL);
4067 gtk_widget_modify_color_component (widget, GTK_RC_TEXT, state, color);
4071 * gtk_widget_modify_base:
4072 * @widget: a #GtkWidget.
4073 * @state: the state for which to set the base color.
4074 * @color: the color to assign (does not need to be allocated).
4076 * Set the base color for a widget in a particular state.
4077 * All other style values are left untouched. The base color
4078 * is the background color used along with the text color
4079 * (see gtk_widget_modify_text) for widgets such as #GtkEntry
4080 * and #GtkTextView. See also gtk_widget_modify_style().
4083 gtk_widget_modify_base (GtkWidget *widget,
4087 g_return_if_fail (GTK_IS_WIDGET (widget));
4088 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
4089 g_return_if_fail (color != NULL);
4091 gtk_widget_modify_color_component (widget, GTK_RC_BASE, state, color);
4095 * gtk_widget_modify_font:
4096 * @widget: a #GtkWidget
4097 * @font_desc: the font description to use
4099 * Set the font to use for a widget. All other style values are left
4100 * untouched. See also gtk_widget_modify_style().
4103 gtk_widget_modify_font (GtkWidget *widget,
4104 PangoFontDescription *font_desc)
4106 GtkRcStyle *rc_style;
4108 g_return_if_fail (GTK_IS_WIDGET (widget));
4109 g_return_if_fail (font_desc != NULL);
4111 rc_style = gtk_widget_get_modifier_style (widget);
4113 if (rc_style->font_desc)
4114 pango_font_description_free (rc_style->font_desc);
4116 rc_style->font_desc = pango_font_description_copy (font_desc);
4118 gtk_widget_modify_style (widget, rc_style);
4122 gtk_widget_direction_changed (GtkWidget *widget,
4123 GtkTextDirection previous_direction)
4125 gtk_widget_queue_resize (widget);
4129 gtk_widget_style_set (GtkWidget *widget,
4130 GtkStyle *previous_style)
4132 if (GTK_WIDGET_REALIZED (widget) &&
4133 !GTK_WIDGET_NO_WINDOW (widget))
4134 gtk_style_set_background (widget->style, widget->window, widget->state);
4138 gtk_widget_set_style_internal (GtkWidget *widget,
4140 gboolean initial_emission)
4142 g_return_if_fail (GTK_IS_WIDGET (widget));
4143 g_return_if_fail (style != NULL);
4145 g_object_ref (G_OBJECT (widget));
4146 g_object_freeze_notify (G_OBJECT (widget));
4148 if (widget->style != style || initial_emission)
4150 PangoContext *context = gtk_widget_peek_pango_context (widget);
4152 pango_context_set_font_description (context, style->font_desc);
4155 if (widget->style != style)
4157 GtkStyle *previous_style;
4159 if (GTK_WIDGET_REALIZED (widget))
4161 gtk_widget_reset_shapes (widget);
4162 gtk_style_detach (widget->style);
4165 previous_style = widget->style;
4166 widget->style = style;
4167 g_object_ref (widget->style);
4169 if (GTK_WIDGET_REALIZED (widget))
4170 widget->style = gtk_style_attach (widget->style, widget->window);
4172 gtk_signal_emit (GTK_OBJECT (widget),
4173 widget_signals[STYLE_SET],
4174 initial_emission ? NULL : previous_style);
4175 g_object_unref (previous_style);
4177 if (widget->parent && !initial_emission)
4179 GtkRequisition old_requisition;
4181 old_requisition = widget->requisition;
4182 gtk_widget_size_request (widget, NULL);
4184 if ((old_requisition.width != widget->requisition.width) ||
4185 (old_requisition.height != widget->requisition.height))
4186 gtk_widget_queue_resize (widget);
4187 else if (GTK_WIDGET_DRAWABLE (widget))
4188 gtk_widget_queue_clear (widget);
4191 else if (initial_emission)
4192 gtk_signal_emit (GTK_OBJECT (widget),
4193 widget_signals[STYLE_SET],
4195 g_object_notify (G_OBJECT (widget), "style");
4196 g_object_thaw_notify (G_OBJECT (widget));
4197 g_object_unref (G_OBJECT (widget));
4201 gtk_widget_set_style_recurse (GtkWidget *widget,
4202 gpointer client_data)
4204 if (GTK_WIDGET_RC_STYLE (widget))
4205 gtk_widget_reset_rc_style (widget);
4207 if (GTK_IS_CONTAINER (widget))
4208 gtk_container_forall (GTK_CONTAINER (widget),
4209 gtk_widget_set_style_recurse,
4214 gtk_widget_propagate_hierarchy_changed_recurse (GtkWidget *widget,
4215 gpointer client_data)
4217 gboolean new_anchored;
4219 new_anchored = GTK_WIDGET_TOPLEVEL (widget) ||
4220 (widget->parent && GTK_WIDGET_ANCHORED (widget->parent));
4222 if (GTK_WIDGET_ANCHORED (widget) != new_anchored)
4224 gtk_widget_ref (widget);
4227 GTK_PRIVATE_SET_FLAG (widget, GTK_ANCHORED);
4229 GTK_PRIVATE_UNSET_FLAG (widget, GTK_ANCHORED);
4231 g_signal_emit (GTK_OBJECT (widget), widget_signals[HIERARCHY_CHANGED],
4234 if (GTK_IS_CONTAINER (widget))
4235 gtk_container_forall (GTK_CONTAINER (widget),
4236 gtk_widget_propagate_hierarchy_changed_recurse,
4239 gtk_widget_unref (widget);
4244 * _gtk_widget_propagate_hierarchy_changed:
4245 * @widget: a #GtkWidget
4246 * @previous_toplevel: Previous toplevel
4248 * Propagate changes in the anchored state to a widget and all
4249 * children, unsetting or setting the ANCHORED flag, and
4250 * emitting hierarchy_changed.
4253 _gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
4254 GtkWidget *previous_toplevel)
4256 if (previous_toplevel)
4257 g_object_ref (previous_toplevel);
4259 gtk_widget_propagate_hierarchy_changed_recurse (widget, previous_toplevel);
4261 if (previous_toplevel)
4262 g_object_unref (previous_toplevel);
4266 gtk_widget_reset_rc_styles (GtkWidget *widget)
4268 g_return_if_fail (GTK_IS_WIDGET (widget));
4270 gtk_widget_set_style_recurse (widget, NULL);
4274 gtk_widget_get_default_style (void)
4276 if (!gtk_default_style)
4278 gtk_default_style = gtk_style_new ();
4279 g_object_ref (gtk_default_style);
4282 return gtk_default_style;
4285 static PangoContext *
4286 gtk_widget_peek_pango_context (GtkWidget *widget)
4288 return gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_pango_context);
4292 * gtk_widget_get_pango_context:
4293 * @widget: a #GtkWidget
4295 * Get a #PangoContext with the appropriate colormap, font description
4296 * and base direction for this widget. Unlike the context returned
4297 * by gtk_widget_create_pango_context(), this context is owned by
4298 * the widget (it can be used as long as widget exists), and will
4299 * be updated to match any changes to the widget's attributes.
4301 * If you create and keep a #PangoLayout using this context, you must
4302 * deal with changes to the context by calling pango_layout_context_changed()
4303 * on the layout in response to the ::style_set and ::direction_set signals
4306 * Return value: the #PangoContext for the widget.
4309 gtk_widget_get_pango_context (GtkWidget *widget)
4311 PangoContext *context;
4313 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4315 context = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_pango_context);
4318 context = gtk_widget_create_pango_context (GTK_WIDGET (widget));
4319 gtk_object_set_data_by_id_full (GTK_OBJECT (widget), quark_pango_context, context,
4320 (GDestroyNotify) g_object_unref);
4327 * gtk_widget_create_pango_context:
4328 * @widget: a #PangoWidget
4330 * Create a new pango context with the appropriate colormap,
4331 * font description, and base direction for drawing text for
4332 * this widget. See also gtk_widget_get_pango_context()
4334 * Return value: the new #PangoContext
4337 gtk_widget_create_pango_context (GtkWidget *widget)
4339 PangoContext *context;
4341 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4343 context = gdk_pango_context_get ();
4345 gdk_pango_context_set_colormap (context, gtk_widget_get_colormap (widget));
4346 pango_context_set_base_dir (context,
4347 gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR ?
4348 PANGO_DIRECTION_LTR : PANGO_DIRECTION_RTL);
4349 pango_context_set_font_description (context, widget->style->font_desc);
4350 pango_context_set_language (context, gtk_get_default_language ());
4356 * gtk_widget_create_pango_layout:
4357 * @widget: a #PangoWidget
4358 * @text: text to set on the layout (can be %NULL)
4360 * Create a new #PangoLayout with the appropriate colormap,
4361 * font description, and base direction for drawing text for
4364 * If you keep a #PangoLayout created in this way around, in order
4365 * notify the layout of changes to the base direction or font of this
4366 * widget, you must call pango_layout_context_changed() in response to
4367 * the ::style_set and ::direction_set signals for the widget.
4369 * Return value: the new #PangoLayout
4372 gtk_widget_create_pango_layout (GtkWidget *widget,
4375 PangoLayout *layout;
4376 PangoContext *context;
4378 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4380 context = gtk_widget_get_pango_context (widget);
4381 layout = pango_layout_new (context);
4384 pango_layout_set_text (layout, text, -1);
4390 * gtk_widget_render_icon:
4391 * @widget: a #GtkWidget
4392 * @stock_id: a stock ID
4393 * @size: a stock size
4394 * @detail: render detail to pass to theme engine
4396 * A convenience function that uses the theme engine and RC file
4397 * settings for @widget to look up @stock_id and render it to
4398 * a pixbuf. @stock_id should be a stock icon ID such as
4399 * #GTK_STOCK_OPEN or #GTK_STOCK_OK. @size should be a size
4400 * such as #GTK_ICON_SIZE_MENU. @detail should be a string that
4401 * identifies the widget or code doing the rendering, so that
4402 * theme engines can special-case rendering for that widget or code.
4404 * Return value: a new pixbuf, or %NULL if the stock ID wasn't known
4407 gtk_widget_render_icon (GtkWidget *widget,
4408 const gchar *stock_id,
4410 const gchar *detail)
4412 GtkIconSet *icon_set;
4415 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4416 g_return_val_if_fail (stock_id != NULL, NULL);
4417 g_return_val_if_fail (size > GTK_ICON_SIZE_INVALID, NULL);
4419 gtk_widget_ensure_style (widget);
4421 icon_set = gtk_style_lookup_icon_set (widget->style, stock_id);
4423 if (icon_set == NULL)
4426 retval = gtk_icon_set_render_icon (icon_set,
4428 gtk_widget_get_direction (widget),
4429 GTK_WIDGET_STATE (widget),
4437 /*************************************************************
4438 * gtk_widget_set_parent_window:
4439 * Set a non default parent window for widget
4446 *************************************************************/
4449 gtk_widget_set_parent_window (GtkWidget *widget,
4450 GdkWindow *parent_window)
4452 GdkWindow *old_parent_window;
4454 g_return_if_fail (GTK_IS_WIDGET (widget));
4456 old_parent_window = gtk_object_get_data_by_id (GTK_OBJECT (widget),
4457 quark_parent_window);
4459 if (parent_window != old_parent_window)
4461 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_parent_window,
4463 if (old_parent_window)
4464 gdk_window_unref (old_parent_window);
4466 gdk_window_ref (parent_window);
4472 * gtk_widget_set_child_visible:
4473 * @widget: a #GtkWidget
4474 * @is_visible: if %TRUE, @widget should be mapped along with its parent.
4476 * Sets whether @widget should be mapped along with its when its parent
4477 * is mapped and @widget has been shown with gtk_widget_show().
4479 * The child visibility can be set for widget before it is added to
4480 * a container with gtk_widget_set_parent(), to avoid mapping
4481 * children unnecessary before immediately unmapping them. However
4482 * it will be reset to its default state of %TRUE when the widget
4483 * is removed from a container.
4485 * Note that changing the child visibility of a widget does not
4486 * queue a resize on the widget. Most of the time, the size of
4487 * a widget is computed from all visible children, whether or
4488 * not they are mapped. If this is not the case, the container
4489 * can queue a resize itself.
4491 * This function is only useful for container implementations and
4492 * never should be called by an application.
4495 gtk_widget_set_child_visible (GtkWidget *widget,
4496 gboolean is_visible)
4498 g_return_if_fail (GTK_IS_WIDGET (widget));
4499 g_return_if_fail (!GTK_WIDGET_TOPLEVEL (widget));
4502 GTK_PRIVATE_SET_FLAG (widget, GTK_CHILD_VISIBLE);
4504 GTK_PRIVATE_UNSET_FLAG (widget, GTK_CHILD_VISIBLE);
4505 if (GTK_WIDGET_REALIZED (widget->parent))
4507 if (GTK_WIDGET_MAPPED (widget->parent) &&
4508 GTK_WIDGET_CHILD_VISIBLE (widget) &&
4509 GTK_WIDGET_VISIBLE (widget))
4510 gtk_widget_map (widget);
4512 gtk_widget_unmap (widget);
4517 * gtk_widget_get_child_visible:
4518 * @widget: a #GtkWidget
4520 * Gets the value set with gtk_widget_set_child_visible().
4521 * If you feel a need to use this function, your code probably
4522 * needs reorganization.
4524 * This function is only useful for container implementations and
4525 * never should be called by an application.
4527 * Return value: %TRUE if the widget is mapped with the parent.
4530 gtk_widget_get_child_visible (GtkWidget *widget)
4532 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4534 return GTK_WIDGET_CHILD_VISIBLE (widget);
4537 /*************************************************************
4538 * gtk_widget_get_parent_window:
4539 * Get widget's parent window
4546 *************************************************************/
4549 gtk_widget_get_parent_window (GtkWidget *widget)
4551 GdkWindow *parent_window;
4553 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4554 g_return_val_if_fail (widget->parent != NULL, NULL);
4556 parent_window = gtk_object_get_data_by_id (GTK_OBJECT (widget),
4557 quark_parent_window);
4559 return (parent_window != NULL) ? parent_window : widget->parent->window;
4563 * gtk_widget_child_focus:
4564 * @widget: a #GtkWidget
4565 * @direction: direction of focus movement
4567 * This function is used by custom widget implementations; if you're
4568 * writing an app, you'd use gtk_widget_grab_focus() to move the focus
4569 * to a particular widget, and gtk_container_set_focus_chain() to
4570 * change the focus tab order. So you may want to investigate those
4571 * functions instead.
4573 * gtk_widget_child_focus() is called by containers as the user moves
4574 * around the window using keyboard shortcuts. @direction indicates
4575 * what kind of motion is taking place (up, down, left, right, tab
4576 * forward, tab backward). gtk_widget_child_focus() invokes the
4577 * "focus" signal on #GtkWidget; widgets override the default handler
4578 * for this signal in order to implement appropriate focus behavior.
4580 * The "focus" default handler for a widget should return %TRUE if
4581 * moving in @direction left the focus on a focusable location inside
4582 * that widget, and %FALSE if moving in @direction moved the focus
4583 * outside the widget. If returning %TRUE, widgets normally
4584 * call gtk_widget_grab_focus() to place the focus accordingly;
4585 * if returning %FALSE, they don't modify the current focus location.
4587 * This function replaces gtk_container_focus() from GTK+ 1.2. It was
4588 * necessary to check that the child was visible, sensitive, and
4589 * focusable before calling
4590 * gtk_container_focus(). gtk_widget_child_focus() returns %FALSE if
4591 * the widget is not currently in a focusable state, so there's no
4592 * need for those checks.
4594 * Return value: %TRUE if focus ended up inside @widget
4597 gtk_widget_child_focus (GtkWidget *widget,
4598 GtkDirectionType direction)
4600 gboolean return_val;
4602 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4604 if (!GTK_WIDGET_VISIBLE (widget) ||
4605 !GTK_WIDGET_IS_SENSITIVE (widget))
4608 /* child widgets must set CAN_FOCUS, containers
4609 * don't have to though.
4611 if (!GTK_IS_CONTAINER (widget) &&
4612 !GTK_WIDGET_CAN_FOCUS (widget))
4615 gtk_signal_emit (GTK_OBJECT (widget),
4616 widget_signals[FOCUS],
4617 direction, &return_val);
4623 * gtk_widget_set_uposition:
4624 * @widget: a #GtkWidget
4625 * @x: x position; -1 to unset x; -2 to leave x unchanged
4626 * @y: y position; -1 to unset y; -2 to leave y unchanged
4629 * Sets the position of a widget. The funny "u" in the name comes from
4630 * the "user position" hint specified by the X window system, and
4631 * exists for legacy reasons. This function doesn't work if a widget
4632 * is inside a container; it's only really useful on #GtkWindow.
4634 * Don't use this function to center dialogs over the main application
4635 * window; most window managers will do the centering on your behalf
4636 * if you call gtk_window_set_transient_for(), and it's really not
4637 * possible to get the centering to work correctly in all cases from
4638 * application code. But if you insist, use gtk_window_set_position()
4639 * to set #GTK_WIN_POS_CENTER_ON_PARENT, don't do the centering
4642 * Note that although x and y can be individually unset, the position
4643 * is not honoured unless both x and y are set.
4646 gtk_widget_set_uposition (GtkWidget *widget,
4650 /* FIXME this function is the only place that aux_info->x and
4651 * aux_info->y are even used I believe, and this function is
4652 * deprecated. Should be cleaned up.
4655 GtkWidgetAuxInfo *aux_info;
4657 g_return_if_fail (GTK_IS_WIDGET (widget));
4659 aux_info =_gtk_widget_get_aux_info (widget, TRUE);
4664 aux_info->x_set = FALSE;
4667 aux_info->x_set = TRUE;
4675 aux_info->y_set = FALSE;
4678 aux_info->y_set = TRUE;
4683 if (GTK_IS_WINDOW (widget) && aux_info->x_set && aux_info->y_set)
4684 _gtk_window_reposition (GTK_WINDOW (widget), aux_info->x, aux_info->y);
4686 if (GTK_WIDGET_VISIBLE (widget) && widget->parent)
4687 gtk_widget_size_allocate (widget, &widget->allocation);
4691 * gtk_widget_set_usize:
4692 * @widget: a #GtkWidget
4693 * @width: minimum width, or -1 to unset
4694 * @height: minimum height, or -1 to unset
4696 * This function is deprecated; use gtk_widget_set_size_request()
4699 * Sets the minimum size of a widget; that is, the widget's size
4700 * request will be @width by @height. You can use this function to
4701 * force a widget to be either larger or smaller than it is. The
4702 * strange "usize" name dates from the early days of GTK+, and derives
4703 * from X Window System terminology. In many cases,
4704 * gtk_window_set_default_size() is a better choice for toplevel
4705 * windows than this function; setting the default size will still
4706 * allow users to shrink the window. Setting the usize will force them
4707 * to leave the window at least as large as the usize. When dealing
4708 * with window sizes, gtk_window_set_geometry_hints() can be a useful
4711 * Note the inherent danger of setting any fixed size - themes,
4712 * translations into other languages, different fonts, and user action
4713 * can all change the appropriate size for a given widget. So, it's
4714 * basically impossible to hardcode a size that will always be
4719 gtk_widget_set_usize (GtkWidget *widget,
4723 GtkWidgetAuxInfo *aux_info;
4725 g_return_if_fail (GTK_IS_WIDGET (widget));
4727 g_object_freeze_notify (G_OBJECT (widget));
4729 aux_info =_gtk_widget_get_aux_info (widget, TRUE);
4733 g_object_notify (G_OBJECT (widget), "width_request");
4734 aux_info->width = width;
4738 g_object_notify (G_OBJECT (widget), "height_request");
4739 aux_info->height = height;
4742 if (GTK_WIDGET_VISIBLE (widget))
4743 gtk_widget_queue_resize (widget);
4745 g_object_thaw_notify (G_OBJECT (widget));
4749 * gtk_widget_set_size_request:
4750 * @widget: a #GtkWidget
4751 * @width: width @widget should request, or -1 to unset
4752 * @height: height @widget should request, or -1 to unset
4754 * Sets the minimum size of a widget; that is, the widget's size
4755 * request will be @width by @height. You can use this function to
4756 * force a widget to be either larger or smaller than it normally
4759 * In most cases, gtk_window_set_default_size() is a better choice for
4760 * toplevel windows than this function; setting the default size will
4761 * still allow users to shrink the window. Setting the size request
4762 * will force them to leave the window at least as large as the size
4763 * request. When dealing with window sizes,
4764 * gtk_window_set_geometry_hints() can be a useful function as well.
4766 * Note the inherent danger of setting any fixed size - themes,
4767 * translations into other languages, different fonts, and user action
4768 * can all change the appropriate size for a given widget. So, it's
4769 * basically impossible to hardcode a size that will always be
4772 * The size request of a widget is the smallest size a widget can
4773 * accept while still functioning well and drawing itself correctly.
4774 * However in some strange cases a widget may be allocated less than
4775 * its requested size, and in many cases a widget may be allocated more
4776 * space than it requested.
4778 * If the size request in a given direction is -1 (unset), then
4779 * the "natural" size request of the widget will be used instead.
4781 * Widgets can't actually be allocated a size less than 1 by 1, but
4782 * you can pass 0,0 to this function to mean "as small as possible."
4785 gtk_widget_set_size_request (GtkWidget *widget,
4789 g_return_if_fail (GTK_IS_WIDGET (widget));
4790 g_return_if_fail (width >= -1);
4791 g_return_if_fail (height >= -1);
4798 gtk_widget_set_usize (widget, width, height);
4803 * gtk_widget_get_size_request:
4804 * @widget: a #GtkWidget
4805 * @width: return location for width, or %NULL
4806 * @height: return location for height, or %NULL
4808 * Gets the size request that was explicitly set for the widget using
4809 * gtk_widget_set_size_request(). A value of -1 stored in @width or
4810 * @height indicates that that dimension has not been set explicitly
4811 * and the natural requisition of the widget will be used intead. See
4812 * gtk_widget_set_size_request(). To get the size a widget will
4813 * actually use, call gtk_widget_size_request() instead of
4819 gtk_widget_get_size_request (GtkWidget *widget,
4823 GtkWidgetAuxInfo *aux_info;
4825 g_return_if_fail (GTK_IS_WIDGET (widget));
4827 aux_info = _gtk_widget_get_aux_info (widget, FALSE);
4830 *width = aux_info ? aux_info->width : -1;
4833 *height = aux_info ? aux_info->height : -1;
4837 * gtk_widget_set_events:
4838 * @widget: a #GtkWidget
4839 * @events: event mask
4841 * Sets the event mask (see #GdkEventMask) for a widget. The event
4842 * mask determines which events a widget will receive. Keep in mind
4843 * that different widgets have different default event masks, and by
4844 * changing the event mask you may disrupt a widget's functionality,
4845 * so be careful. This function must be called while a widget is
4846 * unrealized. Consider gtk_widget_add_events() for widgets that are
4847 * already realized, or if you want to preserve the existing event
4848 * mask. This function can't be used with #GTK_NO_WINDOW widgets;
4849 * to get events on those widgets, place them inside a #GtkEventBox
4850 * and receive events on the event box.
4854 gtk_widget_set_events (GtkWidget *widget,
4859 g_return_if_fail (GTK_IS_WIDGET (widget));
4860 g_return_if_fail (!GTK_WIDGET_NO_WINDOW (widget));
4861 g_return_if_fail (!GTK_WIDGET_REALIZED (widget));
4863 eventp = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_event_mask);
4868 eventp = g_new (gint, 1);
4871 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_event_mask, eventp);
4876 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_event_mask);
4879 g_object_notify (G_OBJECT (widget), "events");
4883 * gtk_widget_add_events:
4884 * @widget: a #GtkWidget
4885 * @events: an event mask, see #GdkEventMask
4887 * Adds the events in the bitfield @events to the event mask for
4888 * @widget. See gtk_widget_set_events() for details.
4892 gtk_widget_add_events (GtkWidget *widget,
4897 g_return_if_fail (GTK_IS_WIDGET (widget));
4898 g_return_if_fail (!GTK_WIDGET_NO_WINDOW (widget));
4900 eventp = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_event_mask);
4906 eventp = g_new (gint, 1);
4911 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_event_mask, eventp);
4916 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_event_mask);
4919 if (GTK_WIDGET_REALIZED (widget))
4921 gdk_window_set_events (widget->window,
4922 gdk_window_get_events (widget->window) | events);
4925 g_object_notify (G_OBJECT (widget), "events");
4929 * gtk_widget_set_extension_events:
4930 * @widget: a #GtkWidget
4931 * @mode: bitfield of extension events to receive
4933 * Sets the extension events mask to @mode. See #GdkExtensionMode
4934 * and gdk_input_set_extension_events().
4938 gtk_widget_set_extension_events (GtkWidget *widget,
4939 GdkExtensionMode mode)
4941 GdkExtensionMode *modep;
4943 g_return_if_fail (GTK_IS_WIDGET (widget));
4945 modep = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_extension_event_mode);
4948 modep = g_new (GdkExtensionMode, 1);
4951 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_extension_event_mode, modep);
4952 g_object_notify (G_OBJECT (widget), "extension_events");
4956 * gtk_widget_get_toplevel:
4957 * @widget: a #GtkWidget
4959 * This function returns the topmost widget in the container hierarchy
4960 * @widget is a part of. If @widget has no parent widgets, it will be
4961 * returned as the topmost widget. No reference will be added to the
4962 * returned widget; it should not be unreferenced.
4964 * Note the difference in behavior vs. gtk_widget_get_ancestor();
4965 * gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW) would return
4966 * %NULL if @widget wasn't inside a toplevel window, and if the
4967 * window was inside a GtkWindow-derived widget which was in turn
4968 * inside the toplevel GtkWindow. While the second case may
4969 * seem unlikely, it actually happens when a GtkPlug is embedded
4970 * inside a GtkSocket within the same application
4972 * To reliably find the toplevel GtkWindow, use
4973 * gtk_widget_get_toplevel() and check if the TOPLEVEL flags
4974 * is set on the result.
4976 * GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
4977 * if (GTK_WIDGET_TOPLEVEL (toplevel))
4979 * [ Perform action on toplevel. ]
4982 * Return value: the topmost ancestor of @widget, or @widget itself if there's no ancestor
4985 gtk_widget_get_toplevel (GtkWidget *widget)
4987 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4989 while (widget->parent)
4990 widget = widget->parent;
4996 * gtk_widget_get_ancestor:
4997 * @widget: a #GtkWidget
4998 * @widget_type: ancestor type
5000 * Gets the first ancestor of @widget with type @widget_type. For example,
5001 * gtk_widget_get_ancestor (widget, GTK_TYPE_BOX) gets the first #GtkBox that's
5002 * an ancestor of @widget. No reference will be added to the returned widget;
5003 * it should not be unreferenced. See note about checking for a toplevel
5004 * GtkWindow in the docs for gtk_widget_get_toplevel().
5006 * Return value: the ancestor widget, or %NULL if not found
5009 gtk_widget_get_ancestor (GtkWidget *widget,
5010 GtkType widget_type)
5012 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5014 while (widget && !gtk_type_is_a (GTK_WIDGET_TYPE (widget), widget_type))
5015 widget = widget->parent;
5017 if (!(widget && gtk_type_is_a (GTK_WIDGET_TYPE (widget), widget_type)))
5024 * gtk_widget_get_colormap:
5025 * @widget: a #GtkWidget
5027 * Gets the colormap that will be used to render @widget. No reference will
5028 * be added to the returned colormap; it should not be unreferenced.
5030 * Return value: the colormap used by @widget
5033 gtk_widget_get_colormap (GtkWidget *widget)
5035 GdkColormap *colormap;
5037 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5041 colormap = gdk_window_get_colormap (widget->window);
5042 /* If window was destroyed previously, we'll get NULL here */
5049 colormap = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_colormap);
5053 widget = widget->parent;
5056 return gtk_widget_get_default_colormap ();
5060 * gtk_widget_get_visual:
5061 * @widget: a #GtkWidget
5063 * Gets the visual that will be used to render @widget.
5065 * Return value: the visual for @widget
5068 gtk_widget_get_visual (GtkWidget *widget)
5070 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5072 return gdk_colormap_get_visual (gtk_widget_get_colormap (widget));
5076 * gtk_widget_get_settings:
5077 * @widget: a #GtkWidget
5079 * Get the settings object holding the settings (global property
5080 * settings, RC file information, etc) used for this widget.
5082 * Return value: the relevant #GtkSettings object
5085 gtk_widget_get_settings (GtkWidget *widget)
5087 return gtk_settings_get_default ();
5091 * gtk_widget_set_colormap:
5092 * @widget: a #GtkWidget
5093 * @colormap: a colormap
5095 * Set the colormap for the widget to the given value. Widget must not
5096 * have been previously realized. This probably should only be used
5097 * from an init() function (i.e. from the constructor for the widget).
5101 gtk_widget_set_colormap (GtkWidget *widget,
5102 GdkColormap *colormap)
5104 g_return_if_fail (GTK_IS_WIDGET (widget));
5105 g_return_if_fail (!GTK_WIDGET_REALIZED (widget));
5106 g_return_if_fail (GDK_IS_COLORMAP (colormap));
5108 g_object_ref (G_OBJECT (colormap));
5110 g_object_set_qdata_full (G_OBJECT (widget),
5113 (GtkDestroyNotify) g_object_unref);
5117 * gtk_widget_get_events:
5118 * @widget: a #GtkWidget
5120 * Returns the event mask for the widget (a bitfield containing flags
5121 * from the #GdkEventMask enumeration). These are the events that the widget
5124 * Return value: event mask for @widget
5127 gtk_widget_get_events (GtkWidget *widget)
5131 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
5133 events = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_event_mask);
5141 * gtk_widget_get_extension_events:
5142 * @widget: a #GtkWidget
5144 * Retrieves the extension events the widget will receive; see
5145 * gdk_input_set_extension_events().
5147 * Return value: extension events for @widget
5150 gtk_widget_get_extension_events (GtkWidget *widget)
5152 GdkExtensionMode *mode;
5154 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
5156 mode = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_extension_event_mode);
5164 * gtk_widget_get_pointer:
5165 * @widget: a #GtkWidget
5166 * @x: return location for the X coordinate, or %NULL
5167 * @y: return location for the Y coordinate, or %NULL
5169 * Obtains the location of the mouse pointer in widget coordinates.
5170 * Widget coordinates are a bit odd; for historical reasons, they are
5171 * defined as widget->window coordinates for widgets that are not
5172 * #GTK_NO_WINDOW widgets, and are relative to widget->allocation.x,
5173 * widget->allocation.y for widgets that are #GTK_NO_WINDOW widgets.
5177 gtk_widget_get_pointer (GtkWidget *widget,
5181 g_return_if_fail (GTK_IS_WIDGET (widget));
5188 if (GTK_WIDGET_REALIZED (widget))
5190 gdk_window_get_pointer (widget->window, x, y, NULL);
5192 if (GTK_WIDGET_NO_WINDOW (widget))
5195 *x -= widget->allocation.x;
5197 *y -= widget->allocation.y;
5203 * gtk_widget_is_ancestor:
5204 * @widget: a #GtkWidget
5205 * @ancestor: another #GtkWidget
5207 * Determines whether @widget is somewhere inside @ancestor, possibly with
5208 * intermediate containers.
5210 * Return value: %TRUE if @ancestor contains @widget as a child, grandchild, great grandchild, etc.
5213 gtk_widget_is_ancestor (GtkWidget *widget,
5214 GtkWidget *ancestor)
5216 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5217 g_return_val_if_fail (ancestor != NULL, FALSE);
5221 if (widget->parent == ancestor)
5223 widget = widget->parent;
5229 static GQuark quark_composite_name = 0;
5232 gtk_widget_set_composite_name (GtkWidget *widget,
5235 g_return_if_fail (GTK_IS_WIDGET (widget));
5236 g_return_if_fail (GTK_WIDGET_COMPOSITE_CHILD (widget));
5237 g_return_if_fail (name != NULL);
5239 if (!quark_composite_name)
5240 quark_composite_name = g_quark_from_static_string ("gtk-composite-name");
5242 gtk_object_set_data_by_id_full (GTK_OBJECT (widget),
5243 quark_composite_name,
5249 gtk_widget_get_composite_name (GtkWidget *widget)
5251 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5253 if (GTK_WIDGET_COMPOSITE_CHILD (widget) && widget->parent)
5254 return _gtk_container_child_composite_name (GTK_CONTAINER (widget->parent),
5261 gtk_widget_push_composite_child (void)
5263 composite_child_stack++;
5267 gtk_widget_pop_composite_child (void)
5269 if (composite_child_stack)
5270 composite_child_stack--;
5274 * gtk_widget_push_colormap:
5275 * @cmap: a #GdkColormap
5277 * Pushes @cmap onto a global stack of colormaps; the topmost
5278 * colormap on the stack will be used to create all widgets.
5279 * Remove @cmap with gtk_widget_pop_colormap(). There's little
5280 * reason to use this function.
5284 gtk_widget_push_colormap (GdkColormap *cmap)
5286 g_return_if_fail (cmap != NULL);
5288 colormap_stack = g_slist_prepend (colormap_stack, cmap);
5292 * gtk_widget_pop_colormap:
5294 * Removes a colormap pushed with gtk_widget_push_colormap().
5298 gtk_widget_pop_colormap (void)
5301 colormap_stack = g_slist_delete_link (colormap_stack, colormap_stack);
5305 * gtk_widget_set_default_colormap:
5306 * @colormap: a #GdkColormap
5308 * Sets the default colormap to use when creating widgets.
5309 * gtk_widget_push_colormap() is a better function to use if
5310 * you only want to affect a few widgets, rather than all widgets.
5314 gtk_widget_set_default_colormap (GdkColormap *colormap)
5316 if (default_colormap != colormap)
5318 if (default_colormap)
5319 gdk_colormap_unref (default_colormap);
5320 default_colormap = colormap;
5321 if (default_colormap)
5322 gdk_colormap_ref (default_colormap);
5327 * gtk_widget_get_default_colormap:
5329 * Obtains the default colormap used to create widgets.
5331 * Return value: default widget colormap
5334 gtk_widget_get_default_colormap (void)
5336 if (!default_colormap)
5337 gtk_widget_set_default_colormap (gdk_rgb_get_colormap ());
5339 return default_colormap;
5343 * gtk_widget_get_default_visual:
5345 * Obtains the visual of the default colormap. Not really useful;
5346 * used to be useful before gdk_colormap_get_visual() existed.
5348 * Return value: visual of the default colormap
5351 gtk_widget_get_default_visual (void)
5353 return gdk_colormap_get_visual (gtk_widget_get_default_colormap ());
5357 gtk_widget_emit_direction_changed (GtkWidget *widget,
5358 GtkTextDirection old_dir)
5360 PangoContext *context = gtk_widget_peek_pango_context (widget);
5363 pango_context_set_base_dir (context,
5364 gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR ?
5365 PANGO_DIRECTION_LTR : PANGO_DIRECTION_RTL);
5367 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[DIRECTION_CHANGED], old_dir);
5371 * gtk_widget_set_direction:
5372 * @widget: a #GtkWidget
5373 * @dir: the new direction
5375 * Set the reading direction on a particular widget. This direction
5376 * controls the primary direction for widgets containing text,
5377 * and also the direction in which the children of a container are
5378 * packed. The ability to set the direction is present in order
5379 * so that correct localization into languages with right-to-left
5380 * reading directions can be done. Generally, applications will
5381 * let the default reading direction present, except for containers
5382 * where the containers are arranged in an order that is explicitely
5383 * visual rather than logical (such as buttons for text justificiation).
5385 * If the direction is set to %GTK_TEXT_DIR_NONE, then the value
5386 * set by gtk_widget_set_default_direction() will be used.
5389 gtk_widget_set_direction (GtkWidget *widget,
5390 GtkTextDirection dir)
5392 GtkTextDirection old_dir;
5394 g_return_if_fail (GTK_IS_WIDGET (widget));
5395 g_return_if_fail (dir >= GTK_TEXT_DIR_NONE && dir <= GTK_TEXT_DIR_RTL);
5397 old_dir = gtk_widget_get_direction (widget);
5399 if (dir == GTK_TEXT_DIR_NONE)
5400 GTK_PRIVATE_UNSET_FLAG (widget, GTK_DIRECTION_SET);
5403 GTK_PRIVATE_SET_FLAG (widget, GTK_DIRECTION_SET);
5404 if (dir == GTK_TEXT_DIR_LTR)
5405 GTK_PRIVATE_SET_FLAG (widget, GTK_DIRECTION_LTR);
5407 GTK_PRIVATE_UNSET_FLAG (widget, GTK_DIRECTION_LTR);
5410 if (old_dir != gtk_widget_get_direction (widget))
5411 gtk_widget_emit_direction_changed (widget, old_dir);
5415 * gtk_widget_get_direction:
5416 * @widget: a #GtkWidget
5418 * Get the reading direction for a particular widget. See
5419 * gtk_widget_set_direction().
5421 * Return value: the reading direction for the widget.
5424 gtk_widget_get_direction (GtkWidget *widget)
5426 g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_TEXT_DIR_LTR);
5428 if (GTK_WIDGET_DIRECTION_SET (widget))
5429 return GTK_WIDGET_DIRECTION_LTR (widget) ? GTK_TEXT_DIR_LTR : GTK_TEXT_DIR_RTL;
5431 return gtk_default_direction;
5435 gtk_widget_set_default_direction_recurse (GtkWidget *widget, gpointer data)
5437 GtkTextDirection old_dir = GPOINTER_TO_UINT (data);
5439 g_object_ref (G_OBJECT (widget));
5441 if (!GTK_WIDGET_DIRECTION_SET (widget))
5442 gtk_widget_emit_direction_changed (widget, old_dir);
5444 if (GTK_IS_CONTAINER (widget))
5445 gtk_container_forall (GTK_CONTAINER (widget),
5446 gtk_widget_set_default_direction_recurse,
5449 g_object_unref (G_OBJECT (widget));
5453 * gtk_widget_set_default_direction:
5454 * @dir: the new default direction. This cannot be
5455 * %GTK_TEXT_DIR_NONE.
5457 * Set the default reading direction for widgets where the
5458 * direction has not been explicitly set by gtk_widget_set_direction().
5461 gtk_widget_set_default_direction (GtkTextDirection dir)
5463 g_return_if_fail (dir == GTK_TEXT_DIR_RTL || dir == GTK_TEXT_DIR_LTR);
5465 if (dir != gtk_default_direction)
5467 GList *toplevels, *tmp_list;
5468 GtkTextDirection old_dir = gtk_default_direction;
5470 gtk_default_direction = dir;
5472 tmp_list = toplevels = gtk_window_list_toplevels ();
5473 g_list_foreach (toplevels, (GFunc)g_object_ref, NULL);
5477 gtk_widget_set_default_direction_recurse (tmp_list->data,
5478 GUINT_TO_POINTER (old_dir));
5479 g_object_unref (tmp_list->data);
5480 tmp_list = tmp_list->next;
5483 g_list_free (toplevels);
5488 * gtk_widget_get_default_direction:
5490 * Return value: the current default direction. See
5491 * gtk_widget_set_direction().
5494 gtk_widget_get_default_direction (void)
5496 return gtk_default_direction;
5500 gtk_widget_dispose (GObject *object)
5502 GtkWidget *widget = GTK_WIDGET (object);
5505 gtk_container_remove (GTK_CONTAINER (widget->parent), widget);
5507 GTK_WIDGET_UNSET_FLAGS (widget, GTK_VISIBLE);
5508 if (GTK_WIDGET_REALIZED (widget))
5509 gtk_widget_unrealize (widget);
5511 G_OBJECT_CLASS (parent_class)->dispose (object);
5515 gtk_widget_real_destroy (GtkObject *object)
5519 /* gtk_object_destroy() will already hold a refcount on object
5521 widget = GTK_WIDGET (object);
5523 /* wipe accelerator closures (keep order) */
5524 g_object_set_qdata (G_OBJECT (widget), quark_accel_path, NULL);
5525 g_object_set_qdata (G_OBJECT (widget), quark_accel_closures, NULL);
5527 gtk_grab_remove (widget);
5528 gtk_selection_remove_all (widget);
5530 g_object_unref (widget->style);
5531 widget->style = gtk_widget_get_default_style ();
5532 g_object_ref (widget->style);
5534 GTK_OBJECT_CLASS (parent_class)->destroy (object);
5538 gtk_widget_finalize (GObject *object)
5540 GtkWidget *widget = GTK_WIDGET (object);
5541 GtkWidgetAuxInfo *aux_info;
5543 GdkExtensionMode *mode;
5544 GtkAccessible *accessible;
5546 gtk_grab_remove (widget);
5547 gtk_selection_remove_all (widget);
5549 g_object_unref (widget->style);
5550 widget->style = NULL;
5553 g_free (widget->name);
5555 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
5557 gtk_widget_aux_info_destroy (aux_info);
5559 events = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_event_mask);
5563 mode = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_extension_event_mode);
5567 accessible = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_accessible_object);
5569 g_object_unref (G_OBJECT (accessible));
5571 G_OBJECT_CLASS (parent_class)->finalize (object);
5574 /*****************************************
5575 * gtk_widget_real_map:
5580 *****************************************/
5583 gtk_widget_real_map (GtkWidget *widget)
5585 g_return_if_fail (GTK_IS_WIDGET (widget));
5586 g_return_if_fail (GTK_WIDGET_REALIZED (widget) == TRUE);
5588 if (!GTK_WIDGET_MAPPED (widget))
5590 GTK_WIDGET_SET_FLAGS (widget, GTK_MAPPED);
5592 if (!GTK_WIDGET_NO_WINDOW (widget))
5593 gdk_window_show (widget->window);
5597 /*****************************************
5598 * gtk_widget_real_unmap:
5603 *****************************************/
5606 gtk_widget_real_unmap (GtkWidget *widget)
5608 g_return_if_fail (GTK_IS_WIDGET (widget));
5610 if (GTK_WIDGET_MAPPED (widget))
5612 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
5614 if (!GTK_WIDGET_NO_WINDOW (widget))
5615 gdk_window_hide (widget->window);
5619 /*****************************************
5620 * gtk_widget_real_realize:
5625 *****************************************/
5628 gtk_widget_real_realize (GtkWidget *widget)
5630 g_return_if_fail (GTK_IS_WIDGET (widget));
5631 g_return_if_fail (GTK_WIDGET_NO_WINDOW (widget));
5633 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
5636 widget->window = gtk_widget_get_parent_window (widget);
5637 gdk_window_ref (widget->window);
5639 widget->style = gtk_style_attach (widget->style, widget->window);
5642 /*****************************************
5643 * gtk_widget_real_unrealize:
5648 *****************************************/
5651 gtk_widget_real_unrealize (GtkWidget *widget)
5653 g_return_if_fail (GTK_IS_WIDGET (widget));
5655 if (GTK_WIDGET_MAPPED (widget))
5656 gtk_widget_real_unmap (widget);
5658 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
5660 /* printf ("unrealizing %s\n", gtk_type_name (GTK_OBJECT (widget)->klass->type));
5663 /* We must do unrealize child widget BEFORE container widget.
5664 * gdk_window_destroy() destroys specified xwindow and its sub-xwindows.
5665 * So, unrealizing container widget bofore its children causes the problem
5666 * (for example, gdk_ic_destroy () with destroyed window causes crash. )
5669 if (GTK_IS_CONTAINER (widget))
5670 gtk_container_forall (GTK_CONTAINER (widget),
5671 (GtkCallback) gtk_widget_unrealize,
5674 gtk_style_detach (widget->style);
5675 if (!GTK_WIDGET_NO_WINDOW (widget))
5677 gdk_window_set_user_data (widget->window, NULL);
5678 gdk_window_destroy (widget->window);
5679 widget->window = NULL;
5683 gdk_window_unref (widget->window);
5684 widget->window = NULL;
5687 GTK_WIDGET_UNSET_FLAGS (widget, GTK_REALIZED);
5691 gtk_widget_real_size_request (GtkWidget *widget,
5692 GtkRequisition *requisition)
5694 g_return_if_fail (GTK_IS_WIDGET (widget));
5696 requisition->width = widget->requisition.width;
5697 requisition->height = widget->requisition.height;
5701 * _gtk_widget_peek_colormap:
5703 * Returns colormap currently pushed by gtk_widget_push_colormap, if any.
5705 * Return value: the currently pushed colormap, or %NULL if there is none.
5708 _gtk_widget_peek_colormap (void)
5711 return (GdkColormap*) colormap_stack->data;
5716 gtk_widget_propagate_state (GtkWidget *widget,
5721 /* don't call this function with state==GTK_STATE_INSENSITIVE,
5722 * parent_sensitive==TRUE on a sensitive widget
5725 old_state = GTK_WIDGET_STATE (widget);
5727 if (data->parent_sensitive)
5729 GTK_WIDGET_SET_FLAGS (widget, GTK_PARENT_SENSITIVE);
5731 if (GTK_WIDGET_IS_SENSITIVE (widget))
5733 if (data->state_restoration)
5734 GTK_WIDGET_STATE (widget) = GTK_WIDGET_SAVED_STATE (widget);
5736 GTK_WIDGET_STATE (widget) = data->state;
5740 GTK_WIDGET_STATE (widget) = GTK_STATE_INSENSITIVE;
5741 if (!data->state_restoration &&
5742 data->state != GTK_STATE_INSENSITIVE)
5743 GTK_WIDGET_SAVED_STATE (widget) = data->state;
5748 GTK_WIDGET_UNSET_FLAGS (widget, GTK_PARENT_SENSITIVE);
5749 if (!data->state_restoration)
5751 if (data->state != GTK_STATE_INSENSITIVE)
5752 GTK_WIDGET_SAVED_STATE (widget) = data->state;
5754 else if (GTK_WIDGET_STATE (widget) != GTK_STATE_INSENSITIVE)
5755 GTK_WIDGET_SAVED_STATE (widget) = GTK_WIDGET_STATE (widget);
5756 GTK_WIDGET_STATE (widget) = GTK_STATE_INSENSITIVE;
5759 if (gtk_widget_is_focus (widget) && !GTK_WIDGET_IS_SENSITIVE (widget))
5763 window = gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW);
5765 gtk_window_set_focus (GTK_WINDOW (window), NULL);
5768 if (old_state != GTK_WIDGET_STATE (widget))
5770 gtk_widget_ref (widget);
5772 if (!GTK_WIDGET_IS_SENSITIVE (widget) && GTK_WIDGET_HAS_GRAB (widget))
5773 gtk_grab_remove (widget);
5775 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[STATE_CHANGED], old_state);
5778 if (GTK_IS_CONTAINER (widget))
5780 data->parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget) != FALSE);
5781 data->state = GTK_WIDGET_STATE (widget);
5782 if (data->use_forall)
5783 gtk_container_forall (GTK_CONTAINER (widget),
5784 (GtkCallback) gtk_widget_propagate_state,
5787 gtk_container_foreach (GTK_CONTAINER (widget),
5788 (GtkCallback) gtk_widget_propagate_state,
5791 gtk_widget_unref (widget);
5796 * _gtk_widget_get_aux_info:
5797 * @widget: a #GtkWidget
5798 * @create: if %TRUE, create the structure if it doesn't exist
5800 * Get the #GtkWidgetAuxInfo structure for the widget.
5802 * Return value: the #GtkAuxInfo structure for the widget, or
5803 * %NULL if @create is %FALSE and one doesn't already exist.
5806 _gtk_widget_get_aux_info (GtkWidget *widget,
5809 GtkWidgetAuxInfo *aux_info;
5811 aux_info = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_aux_info);
5812 if (!aux_info && create)
5814 if (!aux_info_mem_chunk)
5815 aux_info_mem_chunk = g_mem_chunk_new ("widget aux info mem chunk",
5816 sizeof (GtkWidgetAuxInfo),
5817 1024, G_ALLOC_AND_FREE);
5818 aux_info = g_chunk_new (GtkWidgetAuxInfo, aux_info_mem_chunk);
5820 aux_info->width = -1;
5821 aux_info->height = -1;
5824 aux_info->x_set = FALSE;
5825 aux_info->y_set = FALSE;
5826 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_aux_info, aux_info);
5832 /*****************************************
5833 * gtk_widget_aux_info_destroy:
5838 *****************************************/
5841 gtk_widget_aux_info_destroy (GtkWidgetAuxInfo *aux_info)
5843 g_return_if_fail (aux_info != NULL);
5845 g_mem_chunk_free (aux_info_mem_chunk, aux_info);
5849 gtk_widget_shape_info_destroy (GtkWidgetShapeInfo *info)
5851 gdk_drawable_unref (info->shape_mask);
5855 /*****************************************
5856 * gtk_widget_shape_combine_mask:
5857 * set a shape for this widgets' gdk window, this allows for
5858 * transparent windows etc., see gdk_window_shape_combine_mask
5859 * for more information
5864 *****************************************/
5866 gtk_widget_shape_combine_mask (GtkWidget *widget,
5867 GdkBitmap *shape_mask,
5871 GtkWidgetShapeInfo* shape_info;
5873 g_return_if_fail (GTK_IS_WIDGET (widget));
5874 /* set_shape doesn't work on widgets without gdk window */
5875 g_return_if_fail (!GTK_WIDGET_NO_WINDOW (widget));
5879 GTK_PRIVATE_UNSET_FLAG (widget, GTK_HAS_SHAPE_MASK);
5882 gdk_window_shape_combine_mask (widget->window, NULL, 0, 0);
5884 g_object_set_qdata (G_OBJECT (widget), quark_shape_info, NULL);
5888 GTK_PRIVATE_SET_FLAG (widget, GTK_HAS_SHAPE_MASK);
5890 shape_info = g_new (GtkWidgetShapeInfo, 1);
5891 g_object_set_qdata_full (G_OBJECT (widget), quark_shape_info, shape_info,
5892 (GDestroyNotify) gtk_widget_shape_info_destroy);
5894 shape_info->shape_mask = gdk_drawable_ref (shape_mask);
5895 shape_info->offset_x = offset_x;
5896 shape_info->offset_y = offset_y;
5898 /* set shape if widget has a gdk window allready.
5899 * otherwise the shape is scheduled to be set by gtk_widget_realize.
5902 gdk_window_shape_combine_mask (widget->window, shape_mask,
5903 offset_x, offset_y);
5908 gtk_reset_shapes_recurse (GtkWidget *widget,
5914 gdk_window_get_user_data (window, &data);
5918 gdk_window_shape_combine_mask (window, NULL, 0, 0);
5919 for (list = gdk_window_peek_children (window); list; list = list->next)
5920 gtk_reset_shapes_recurse (widget, list->data);
5924 gtk_widget_reset_shapes (GtkWidget *widget)
5926 g_return_if_fail (GTK_IS_WIDGET (widget));
5927 g_return_if_fail (GTK_WIDGET_REALIZED (widget));
5929 if (!GTK_WIDGET_HAS_SHAPE_MASK (widget))
5930 gtk_reset_shapes_recurse (widget, widget->window);
5935 * @widget: a #GtkWidget
5937 * Adds a reference to a widget. This function is exactly the same
5938 * as calling g_object_ref(), and exists mostly for historical
5939 * reasons. It can still be convenient to avoid casting a widget
5940 * to a #GObject, it saves a small amount of typing.
5942 * Return value: the widget that was referenced
5945 gtk_widget_ref (GtkWidget *widget)
5947 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5949 return (GtkWidget*) g_object_ref ((GObject*) widget);
5954 * @widget: a #GtkWidget
5956 * Inverse of gtk_widget_ref(). Equivalent to g_object_unref().
5960 gtk_widget_unref (GtkWidget *widget)
5962 g_return_if_fail (GTK_IS_WIDGET (widget));
5964 g_object_unref ((GObject*) widget);
5972 gtk_widget_class_install_style_property_parser (GtkWidgetClass *class,
5974 GtkRcPropertyParser parser)
5976 g_return_if_fail (GTK_IS_WIDGET_CLASS (class));
5977 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
5978 g_return_if_fail (pspec->flags & G_PARAM_READABLE);
5979 g_return_if_fail (!(pspec->flags & (G_PARAM_CONSTRUCT_ONLY | G_PARAM_CONSTRUCT)));
5981 if (g_param_spec_pool_lookup (style_property_spec_pool, pspec->name, G_OBJECT_CLASS_TYPE (class), FALSE))
5983 g_warning (G_STRLOC ": class `%s' already contains a style property named `%s'",
5984 G_OBJECT_CLASS_NAME (class),
5989 g_param_spec_ref (pspec);
5990 g_param_spec_sink (pspec);
5991 g_param_spec_set_qdata (pspec, quark_property_parser, parser);
5992 g_param_spec_pool_insert (style_property_spec_pool, pspec, G_OBJECT_CLASS_TYPE (class));
5996 gtk_widget_class_install_style_property (GtkWidgetClass *class,
5999 GtkRcPropertyParser parser;
6001 g_return_if_fail (GTK_IS_WIDGET_CLASS (class));
6002 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
6004 parser = _gtk_rc_property_parser_from_type (G_PARAM_SPEC_VALUE_TYPE (pspec));
6006 gtk_widget_class_install_style_property_parser (class, pspec, parser);
6010 gtk_widget_style_get_property (GtkWidget *widget,
6011 const gchar *property_name,
6016 g_return_if_fail (GTK_IS_WIDGET (widget));
6017 g_return_if_fail (property_name != NULL);
6018 g_return_if_fail (G_IS_VALUE (value));
6020 g_object_ref (widget);
6021 pspec = g_param_spec_pool_lookup (style_property_spec_pool,
6023 G_OBJECT_TYPE (widget),
6026 g_warning ("%s: widget class `%s' has no property named `%s'",
6028 G_OBJECT_TYPE_NAME (widget),
6032 const GValue *peek_value;
6034 peek_value = _gtk_style_peek_property_value (widget->style,
6035 G_OBJECT_TYPE (widget),
6037 g_param_spec_get_qdata (pspec, quark_property_parser));
6039 /* auto-conversion of the caller's value type
6041 if (G_VALUE_TYPE (value) == G_PARAM_SPEC_VALUE_TYPE (pspec))
6042 g_value_copy (peek_value, value);
6043 else if (g_value_type_transformable (G_PARAM_SPEC_VALUE_TYPE (pspec), G_VALUE_TYPE (value)))
6044 g_value_transform (peek_value, value);
6046 g_warning ("can't retrieve style property `%s' of type `%s' as value of type `%s'",
6048 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
6049 G_VALUE_TYPE_NAME (value));
6051 g_object_unref (widget);
6055 gtk_widget_style_get_valist (GtkWidget *widget,
6056 const gchar *first_property_name,
6061 g_return_if_fail (GTK_IS_WIDGET (widget));
6063 g_object_ref (widget);
6065 name = first_property_name;
6068 const GValue *peek_value;
6072 pspec = g_param_spec_pool_lookup (style_property_spec_pool,
6074 G_OBJECT_TYPE (widget),
6078 g_warning ("%s: widget class `%s' has no property named `%s'",
6080 G_OBJECT_TYPE_NAME (widget),
6084 /* style pspecs are always readable so we can spare that check here */
6086 peek_value = _gtk_style_peek_property_value (widget->style,
6087 G_OBJECT_TYPE (widget),
6089 g_param_spec_get_qdata (pspec, quark_property_parser));
6090 G_VALUE_LCOPY (peek_value, var_args, 0, &error);
6093 g_warning ("%s: %s", G_STRLOC, error);
6098 name = va_arg (var_args, gchar*);
6101 g_object_unref (widget);
6105 gtk_widget_style_get (GtkWidget *widget,
6106 const gchar *first_property_name,
6111 g_return_if_fail (GTK_IS_WIDGET (widget));
6113 va_start (var_args, first_property_name);
6114 gtk_widget_style_get_valist (widget, first_property_name, var_args);
6120 * @widget: a #GtkWidget
6121 * @path_length: location to store length of the path
6122 * @path: location to store allocated path string
6123 * @path_reversed: location to store allocated reverse path string
6125 * Obtains the full path to @widget. The path is simply the name of a
6126 * widget and all its parents in the container hierarchy, separated by
6127 * periods. The name of a widget comes from
6128 * gtk_widget_get_name(). Paths are used to apply styles to a widget
6129 * in gtkrc configuration files. Widget names are the type of the
6130 * widget by default (e.g. "GtkButton") or can be set to an
6131 * application-specific value with gtk_widget_set_name(). By setting
6132 * the name of a widget, you allow users or theme authors to apply
6133 * styles to that specific widget in their gtkrc
6134 * file. @path_reversed_p fills in the path in reverse order,
6135 * i.e. starting with @widget's name instead of starting with the name
6136 * of @widget's outermost ancestor.
6140 gtk_widget_path (GtkWidget *widget,
6141 guint *path_length_p,
6143 gchar **path_reversed_p)
6145 static gchar *rev_path = NULL;
6146 static guint path_len = 0;
6149 g_return_if_fail (GTK_IS_WIDGET (widget));
6154 const gchar *string;
6159 string = gtk_widget_get_name (widget);
6160 l = strlen (string);
6161 while (path_len <= len + l + 1)
6163 path_len += INIT_PATH_SIZE;
6164 rev_path = g_realloc (rev_path, path_len);
6172 widget = widget->parent;
6175 rev_path[len++] = '.';
6177 rev_path[len++] = 0;
6182 *path_length_p = len - 1;
6183 if (path_reversed_p)
6184 *path_reversed_p = g_strdup (rev_path);
6187 *path_p = g_strdup (rev_path);
6188 g_strreverse (*path_p);
6193 * gtk_widget_class_path:
6194 * @widget: a #GtkWidget
6195 * @path_length: location to store the length of the class path
6196 * @path: location to store the class path as an allocated string
6197 * @path_reversed: location to store the reverse class path as an allocated string
6199 * Same as gtk_widget_path(), but always uses the name of a widget's type,
6200 * never uses a custom name set with gtk_widget_set_name().
6204 gtk_widget_class_path (GtkWidget *widget,
6205 guint *path_length_p,
6207 gchar **path_reversed_p)
6209 static gchar *rev_path = NULL;
6210 static guint path_len = 0;
6213 g_return_if_fail (GTK_IS_WIDGET (widget));
6218 const gchar *string;
6223 string = gtk_type_name (GTK_WIDGET_TYPE (widget));
6224 l = strlen (string);
6225 while (path_len <= len + l + 1)
6227 path_len += INIT_PATH_SIZE;
6228 rev_path = g_realloc (rev_path, path_len);
6236 widget = widget->parent;
6239 rev_path[len++] = '.';
6241 rev_path[len++] = 0;
6246 *path_length_p = len - 1;
6247 if (path_reversed_p)
6248 *path_reversed_p = g_strdup (rev_path);
6251 *path_p = g_strdup (rev_path);
6252 g_strreverse (*path_p);
6257 gtk_requisition_copy (const GtkRequisition *requisition)
6259 return (GtkRequisition *)g_memdup (requisition, sizeof (GtkRequisition));
6263 gtk_requisition_free (GtkRequisition *requisition)
6265 g_free (requisition);
6268 AtkObject* gtk_widget_get_accessible (GtkWidget *widget)
6270 GtkWidgetClass *klass;
6272 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6274 klass = GTK_WIDGET_GET_CLASS (widget);
6276 g_return_val_if_fail (klass->get_accessible != NULL, NULL);
6278 return klass->get_accessible (widget);
6281 AtkObject* gtk_widget_real_get_accessible (GtkWidget *widget)
6283 AtkObject* accessible;
6285 accessible = g_object_get_qdata (G_OBJECT (widget),
6286 quark_accessible_object);
6289 AtkObjectFactory *factory;
6290 AtkRegistry *default_registry;
6292 default_registry = atk_get_default_registry ();
6293 factory = atk_registry_get_factory (default_registry,
6294 GTK_OBJECT_TYPE (widget));
6296 atk_object_factory_create_accessible (factory,
6298 g_object_set_qdata (G_OBJECT (widget),
6299 quark_accessible_object,
6306 * Initialize a AtkImplementorIface instance's virtual pointers as
6307 * appropriate to this implementor's class (GtkWidget).
6310 gtk_widget_accessible_interface_init (AtkImplementorIface *iface)
6312 iface->ref_accessible = gtk_widget_ref_accessible;
6316 gtk_widget_ref_accessible (AtkImplementor *implementor)
6318 AtkObject *accessible;
6320 accessible = gtk_widget_get_accessible (GTK_WIDGET (implementor));
6322 g_object_ref (G_OBJECT (accessible));