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"
35 #include "gtkmarshalers.h"
37 #include "gtkselection.h"
38 #include "gtksettings.h"
39 #include "gtksizegroup.h"
40 #include "gtksignal.h"
41 #include "gtkwidget.h"
42 #include "gtkwindow.h"
43 #include "gtkbindings.h"
44 #include "gtkprivate.h"
46 #include "gdk/gdkprivate.h" /* Used in gtk_reset_shapes_recurse to avoid copy */
47 #include <gobject/gvaluecollector.h>
48 #include <gobject/gobjectnotifyqueue.c>
49 #include "gdk/gdkkeysyms.h"
51 #include "gtkaccessible.h"
52 #include "gtktooltips.h"
54 #define WIDGET_CLASS(w) GTK_WIDGET_GET_CLASS (w)
55 #define INIT_PATH_SIZE (512)
95 PROPERTY_NOTIFY_EVENT,
96 SELECTION_CLEAR_EVENT,
97 SELECTION_REQUEST_EVENT,
98 SELECTION_NOTIFY_EVENT,
113 VISIBILITY_NOTIFY_EVENT,
117 ACCEL_CLOSURES_CHANGED,
134 PROP_RECEIVES_DEFAULT,
135 PROP_COMPOSITE_CHILD,
138 PROP_EXTENSION_EVENTS
141 typedef struct _GtkStateData GtkStateData;
146 guint state_restoration : 1;
147 guint parent_sensitive : 1;
148 guint use_forall : 1;
152 /* --- prototypes --- */
153 static void gtk_widget_class_init (GtkWidgetClass *klass);
154 static void gtk_widget_init (GtkWidget *widget);
155 static void gtk_widget_set_property (GObject *object,
159 static void gtk_widget_get_property (GObject *object,
163 static void gtk_widget_dispose (GObject *object);
164 static void gtk_widget_real_destroy (GtkObject *object);
165 static void gtk_widget_finalize (GObject *object);
166 static void gtk_widget_real_show (GtkWidget *widget);
167 static void gtk_widget_real_hide (GtkWidget *widget);
168 static void gtk_widget_real_map (GtkWidget *widget);
169 static void gtk_widget_real_unmap (GtkWidget *widget);
170 static void gtk_widget_real_realize (GtkWidget *widget);
171 static void gtk_widget_real_unrealize (GtkWidget *widget);
172 static void gtk_widget_real_size_request (GtkWidget *widget,
173 GtkRequisition *requisition);
174 static void gtk_widget_real_size_allocate (GtkWidget *widget,
175 GtkAllocation *allocation);
176 static void gtk_widget_style_set (GtkWidget *widget,
177 GtkStyle *previous_style);
178 static void gtk_widget_direction_changed (GtkWidget *widget,
179 GtkTextDirection previous_direction);
181 static void gtk_widget_real_grab_focus (GtkWidget *focus_widget);
182 static void gtk_widget_real_show_help (GtkWidget *widget,
183 GtkWidgetHelpType help_type);
185 static void gtk_widget_dispatch_child_properties_changed (GtkWidget *object,
187 GParamSpec **pspecs);
188 static gboolean gtk_widget_real_key_press_event (GtkWidget *widget,
190 static gboolean gtk_widget_real_key_release_event (GtkWidget *widget,
192 static gboolean gtk_widget_real_focus_in_event (GtkWidget *widget,
193 GdkEventFocus *event);
194 static gboolean gtk_widget_real_focus_out_event (GtkWidget *widget,
195 GdkEventFocus *event);
196 static gboolean gtk_widget_real_focus (GtkWidget *widget,
197 GtkDirectionType direction);
198 static PangoContext* gtk_widget_peek_pango_context (GtkWidget *widget);
199 static void gtk_widget_reparent_container_child (GtkWidget *widget,
200 gpointer client_data);
201 static void gtk_widget_propagate_state (GtkWidget *widget,
203 static void gtk_widget_reset_rc_style (GtkWidget *widget);
204 static void gtk_widget_set_style_internal (GtkWidget *widget,
206 gboolean initial_emission);
207 static void gtk_widget_set_style_recurse (GtkWidget *widget,
208 gpointer client_data);
209 static gint gtk_widget_event_internal (GtkWidget *widget,
211 static gboolean gtk_widget_real_mnemonic_activate (GtkWidget *widget,
212 gboolean group_cycling);
213 static void gtk_widget_aux_info_destroy (GtkWidgetAuxInfo *aux_info);
214 static AtkObject* gtk_widget_real_get_accessible (GtkWidget *widget);
215 static void gtk_widget_accessible_interface_init (AtkImplementorIface *iface);
216 static AtkObject* gtk_widget_ref_accessible (AtkImplementor *implementor);
217 static void gtk_widget_invalidate_widget_windows (GtkWidget *widget,
221 /* --- variables --- */
222 static gpointer parent_class = NULL;
223 static guint widget_signals[LAST_SIGNAL] = { 0 };
224 static GMemChunk *aux_info_mem_chunk = NULL;
225 static GdkColormap *default_colormap = NULL;
226 static GtkStyle *gtk_default_style = NULL;
227 static GSList *colormap_stack = NULL;
228 static guint composite_child_stack = 0;
229 static GtkTextDirection gtk_default_direction = GTK_TEXT_DIR_LTR;
230 static GParamSpecPool *style_property_spec_pool = NULL;
232 static GQuark quark_property_parser = 0;
233 static GQuark quark_aux_info = 0;
234 static GQuark quark_accel_path = 0;
235 static GQuark quark_accel_closures = 0;
236 static GQuark quark_event_mask = 0;
237 static GQuark quark_extension_event_mode = 0;
238 static GQuark quark_parent_window = 0;
239 static GQuark quark_shape_info = 0;
240 static GQuark quark_colormap = 0;
241 static GQuark quark_pango_context = 0;
242 static GQuark quark_rc_style = 0;
243 static GQuark quark_accessible_object = 0;
244 GParamSpecPool *_gtk_widget_child_property_pool = NULL;
245 GObjectNotifyContext *_gtk_widget_child_property_notify_context = NULL;
247 /* --- functions --- */
249 gtk_widget_get_type (void)
251 static GtkType widget_type = 0;
255 static const GtkTypeInfo widget_info =
259 sizeof (GtkWidgetClass),
260 (GtkClassInitFunc) gtk_widget_class_init,
261 (GtkObjectInitFunc) gtk_widget_init,
262 /* reserved_1 */ NULL,
263 /* reserved_2 */ NULL,
264 (GtkClassInitFunc) NULL,
267 static const GInterfaceInfo accessibility_info =
269 (GInterfaceInitFunc) gtk_widget_accessible_interface_init,
270 (GInterfaceFinalizeFunc) NULL,
271 NULL /* interface data */
275 widget_type = gtk_type_unique (GTK_TYPE_OBJECT, &widget_info);
277 g_type_add_interface_static (widget_type, ATK_TYPE_IMPLEMENTOR,
278 &accessibility_info) ;
286 child_property_notify_dispatcher (GObject *object,
290 GTK_WIDGET_GET_CLASS (object)->dispatch_child_properties_changed (GTK_WIDGET (object), n_pspecs, pspecs);
294 gtk_widget_class_init (GtkWidgetClass *klass)
296 static GObjectNotifyContext cpn_context = { 0, NULL, NULL };
297 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
298 GtkObjectClass *object_class = GTK_OBJECT_CLASS (klass);
299 GtkBindingSet *binding_set;
301 parent_class = g_type_class_peek_parent (klass);
303 quark_property_parser = g_quark_from_static_string ("gtk-rc-property-parser");
304 quark_aux_info = g_quark_from_static_string ("gtk-aux-info");
305 quark_accel_path = g_quark_from_static_string ("gtk-accel-path");
306 quark_accel_closures = g_quark_from_static_string ("gtk-accel-closures");
307 quark_event_mask = g_quark_from_static_string ("gtk-event-mask");
308 quark_extension_event_mode = g_quark_from_static_string ("gtk-extension-event-mode");
309 quark_parent_window = g_quark_from_static_string ("gtk-parent-window");
310 quark_shape_info = g_quark_from_static_string ("gtk-shape-info");
311 quark_colormap = g_quark_from_static_string ("gtk-colormap");
312 quark_pango_context = g_quark_from_static_string ("gtk-pango-context");
313 quark_rc_style = g_quark_from_static_string ("gtk-rc-style");
314 quark_accessible_object = g_quark_from_static_string ("gtk-accessible-object");
316 style_property_spec_pool = g_param_spec_pool_new (FALSE);
317 _gtk_widget_child_property_pool = g_param_spec_pool_new (TRUE);
318 cpn_context.quark_notify_queue = g_quark_from_static_string ("GtkWidget-child-property-notify-queue");
319 cpn_context.dispatcher = child_property_notify_dispatcher;
320 _gtk_widget_child_property_notify_context = &cpn_context;
322 gobject_class->dispose = gtk_widget_dispose;
323 gobject_class->finalize = gtk_widget_finalize;
324 gobject_class->set_property = gtk_widget_set_property;
325 gobject_class->get_property = gtk_widget_get_property;
327 object_class->destroy = gtk_widget_real_destroy;
329 klass->activate_signal = 0;
330 klass->set_scroll_adjustments_signal = 0;
331 klass->dispatch_child_properties_changed = gtk_widget_dispatch_child_properties_changed;
332 klass->show = gtk_widget_real_show;
333 klass->show_all = gtk_widget_show;
334 klass->hide = gtk_widget_real_hide;
335 klass->hide_all = gtk_widget_hide;
336 klass->map = gtk_widget_real_map;
337 klass->unmap = gtk_widget_real_unmap;
338 klass->realize = gtk_widget_real_realize;
339 klass->unrealize = gtk_widget_real_unrealize;
340 klass->size_request = gtk_widget_real_size_request;
341 klass->size_allocate = gtk_widget_real_size_allocate;
342 klass->state_changed = NULL;
343 klass->parent_set = NULL;
344 klass->hierarchy_changed = NULL;
345 klass->style_set = gtk_widget_style_set;
346 klass->direction_changed = gtk_widget_direction_changed;
347 klass->grab_notify = NULL;
348 klass->child_notify = NULL;
349 klass->mnemonic_activate = gtk_widget_real_mnemonic_activate;
350 klass->grab_focus = gtk_widget_real_grab_focus;
351 klass->focus = gtk_widget_real_focus;
353 klass->button_press_event = NULL;
354 klass->button_release_event = NULL;
355 klass->motion_notify_event = NULL;
356 klass->delete_event = NULL;
357 klass->destroy_event = NULL;
358 klass->expose_event = NULL;
359 klass->key_press_event = gtk_widget_real_key_press_event;
360 klass->key_release_event = gtk_widget_real_key_release_event;
361 klass->enter_notify_event = NULL;
362 klass->leave_notify_event = NULL;
363 klass->configure_event = NULL;
364 klass->focus_in_event = gtk_widget_real_focus_in_event;
365 klass->focus_out_event = gtk_widget_real_focus_out_event;
366 klass->map_event = NULL;
367 klass->unmap_event = NULL;
368 klass->window_state_event = NULL;
369 klass->property_notify_event = gtk_selection_property_notify;
370 klass->selection_clear_event = gtk_selection_clear;
371 klass->selection_request_event = gtk_selection_request;
372 klass->selection_notify_event = gtk_selection_notify;
373 klass->selection_received = NULL;
374 klass->proximity_in_event = NULL;
375 klass->proximity_out_event = NULL;
376 klass->drag_begin = NULL;
377 klass->drag_end = NULL;
378 klass->drag_data_delete = NULL;
379 klass->drag_leave = NULL;
380 klass->drag_motion = NULL;
381 klass->drag_drop = NULL;
382 klass->drag_data_received = NULL;
384 klass->show_help = gtk_widget_real_show_help;
386 /* Accessibility support */
387 klass->get_accessible = gtk_widget_real_get_accessible;
389 klass->no_expose_event = NULL;
391 g_object_class_install_property (gobject_class,
393 g_param_spec_string ("name",
395 _("The name of the widget"),
398 g_object_class_install_property (gobject_class,
400 g_param_spec_object ("parent",
402 _("The parent widget of this widget. Must be a Container widget."),
406 g_object_class_install_property (gobject_class,
408 g_param_spec_int ("width_request",
410 _("Override for width request of the widget, or -1 if natural request should be used."),
415 g_object_class_install_property (gobject_class,
417 g_param_spec_int ("height_request",
419 _("Override for height request of the widget, or -1 if natural request should be used."),
424 g_object_class_install_property (gobject_class,
426 g_param_spec_boolean ("visible",
428 _("Whether the widget is visible"),
431 g_object_class_install_property (gobject_class,
433 g_param_spec_boolean ("sensitive",
435 _("Whether the widget responds to input"),
438 g_object_class_install_property (gobject_class,
440 g_param_spec_boolean ("app_paintable",
441 _("Application paintable"),
442 _("Whether the application will paint directly on the widget"),
445 g_object_class_install_property (gobject_class,
447 g_param_spec_boolean ("can_focus",
449 _("Whether the widget can accept the input focus"),
452 g_object_class_install_property (gobject_class,
454 g_param_spec_boolean ("has_focus",
456 _("Whether the widget has the input focus"),
459 g_object_class_install_property (gobject_class,
461 g_param_spec_boolean ("can_default",
463 _("Whether the widget can be the default widget"),
466 g_object_class_install_property (gobject_class,
468 g_param_spec_boolean ("has_default",
470 _("Whether the widget is the default widget"),
473 g_object_class_install_property (gobject_class,
474 PROP_RECEIVES_DEFAULT,
475 g_param_spec_boolean ("receives_default",
476 _("Receives default"),
477 _("If TRUE, the widget will receive the default action when it is focused."),
480 g_object_class_install_property (gobject_class,
481 PROP_COMPOSITE_CHILD,
482 g_param_spec_boolean ("composite_child",
483 _("Composite child"),
484 _("Whether the widget is composed of other widgets"),
487 g_object_class_install_property (gobject_class,
489 g_param_spec_object ("style",
491 _("The style of the widget, which contains information about how it will look (colors etc)."),
494 g_object_class_install_property (gobject_class,
496 g_param_spec_flags ("events",
498 _("The event mask that decides what kind of GdkEvents this widget gets."),
502 g_object_class_install_property (gobject_class,
503 PROP_EXTENSION_EVENTS,
504 g_param_spec_enum ("extension_events",
505 _("Extension events"),
506 _("The mask that decides what kind of extension events this widget gets."),
507 GDK_TYPE_EXTENSION_MODE,
508 GDK_EXTENSION_EVENTS_NONE,
510 widget_signals[SHOW] =
511 gtk_signal_new ("show",
513 GTK_CLASS_TYPE (object_class),
514 GTK_SIGNAL_OFFSET (GtkWidgetClass, show),
515 _gtk_marshal_VOID__VOID,
517 widget_signals[HIDE] =
518 gtk_signal_new ("hide",
520 GTK_CLASS_TYPE (object_class),
521 GTK_SIGNAL_OFFSET (GtkWidgetClass, hide),
522 _gtk_marshal_VOID__VOID,
524 widget_signals[MAP] =
525 gtk_signal_new ("map",
527 GTK_CLASS_TYPE (object_class),
528 GTK_SIGNAL_OFFSET (GtkWidgetClass, map),
529 _gtk_marshal_VOID__VOID,
531 widget_signals[UNMAP] =
532 gtk_signal_new ("unmap",
534 GTK_CLASS_TYPE (object_class),
535 GTK_SIGNAL_OFFSET (GtkWidgetClass, unmap),
536 _gtk_marshal_VOID__VOID,
538 widget_signals[REALIZE] =
539 gtk_signal_new ("realize",
541 GTK_CLASS_TYPE (object_class),
542 GTK_SIGNAL_OFFSET (GtkWidgetClass, realize),
543 _gtk_marshal_VOID__VOID,
545 widget_signals[UNREALIZE] =
546 gtk_signal_new ("unrealize",
548 GTK_CLASS_TYPE (object_class),
549 GTK_SIGNAL_OFFSET (GtkWidgetClass, unrealize),
550 _gtk_marshal_VOID__VOID,
552 widget_signals[SIZE_REQUEST] =
553 g_signal_new ("size_request",
554 G_OBJECT_CLASS_TYPE (object_class),
556 G_STRUCT_OFFSET (GtkWidgetClass, size_request),
558 _gtk_marshal_VOID__BOXED,
560 GTK_TYPE_REQUISITION | G_SIGNAL_TYPE_STATIC_SCOPE);
561 widget_signals[SIZE_ALLOCATE] =
562 gtk_signal_new ("size_allocate",
564 GTK_CLASS_TYPE (object_class),
565 GTK_SIGNAL_OFFSET (GtkWidgetClass, size_allocate),
566 _gtk_marshal_VOID__BOXED,
568 GDK_TYPE_RECTANGLE | G_SIGNAL_TYPE_STATIC_SCOPE);
569 widget_signals[STATE_CHANGED] =
570 gtk_signal_new ("state_changed",
572 GTK_CLASS_TYPE (object_class),
573 GTK_SIGNAL_OFFSET (GtkWidgetClass, state_changed),
574 _gtk_marshal_VOID__ENUM,
576 GTK_TYPE_STATE_TYPE);
577 widget_signals[PARENT_SET] =
578 gtk_signal_new ("parent_set",
580 GTK_CLASS_TYPE (object_class),
581 GTK_SIGNAL_OFFSET (GtkWidgetClass, parent_set),
582 _gtk_marshal_VOID__OBJECT,
585 widget_signals[HIERARCHY_CHANGED] =
586 gtk_signal_new ("hierarchy_changed",
588 GTK_CLASS_TYPE (object_class),
589 GTK_SIGNAL_OFFSET (GtkWidgetClass, hierarchy_changed),
590 _gtk_marshal_VOID__OBJECT,
593 widget_signals[STYLE_SET] =
594 gtk_signal_new ("style_set",
596 GTK_CLASS_TYPE (object_class),
597 GTK_SIGNAL_OFFSET (GtkWidgetClass, style_set),
598 _gtk_marshal_VOID__OBJECT,
601 widget_signals[DIRECTION_CHANGED] =
602 gtk_signal_new ("direction_changed",
604 GTK_CLASS_TYPE (object_class),
605 GTK_SIGNAL_OFFSET (GtkWidgetClass, direction_changed),
606 _gtk_marshal_VOID__ENUM,
608 GTK_TYPE_TEXT_DIRECTION);
609 widget_signals[GRAB_NOTIFY] =
610 gtk_signal_new ("grab_notify",
612 GTK_CLASS_TYPE (object_class),
613 GTK_SIGNAL_OFFSET (GtkWidgetClass, grab_notify),
614 _gtk_marshal_VOID__BOOLEAN,
617 widget_signals[CHILD_NOTIFY] =
618 g_signal_new ("child_notify",
619 G_TYPE_FROM_CLASS (klass),
620 G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE | G_SIGNAL_DETAILED | G_SIGNAL_NO_HOOKS,
621 G_STRUCT_OFFSET (GtkWidgetClass, child_notify),
623 g_cclosure_marshal_VOID__PARAM,
626 widget_signals[MNEMONIC_ACTIVATE] =
627 g_signal_new ("mnemonic_activate",
628 GTK_CLASS_TYPE (object_class),
630 GTK_SIGNAL_OFFSET (GtkWidgetClass, mnemonic_activate),
631 _gtk_boolean_handled_accumulator, NULL,
632 _gtk_marshal_BOOLEAN__BOOLEAN,
635 widget_signals[GRAB_FOCUS] =
636 gtk_signal_new ("grab_focus",
637 GTK_RUN_LAST | GTK_RUN_ACTION,
638 GTK_CLASS_TYPE (object_class),
639 GTK_SIGNAL_OFFSET (GtkWidgetClass, grab_focus),
640 _gtk_marshal_VOID__VOID,
642 widget_signals[FOCUS] =
643 g_signal_new ("focus",
644 G_TYPE_FROM_CLASS (object_class),
646 G_STRUCT_OFFSET (GtkWidgetClass, focus),
647 _gtk_boolean_handled_accumulator, NULL,
648 _gtk_marshal_BOOLEAN__ENUM,
650 GTK_TYPE_DIRECTION_TYPE);
651 widget_signals[EVENT] =
652 g_signal_new ("event",
653 G_TYPE_FROM_CLASS (object_class),
655 G_STRUCT_OFFSET(GtkWidgetClass, event),
656 _gtk_boolean_handled_accumulator, NULL,
657 _gtk_marshal_BOOLEAN__BOXED,
659 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
660 widget_signals[EVENT_AFTER] =
661 g_signal_new ("event-after",
662 G_TYPE_FROM_CLASS (object_class),
666 _gtk_marshal_VOID__BOXED,
667 G_TYPE_NONE, 1, GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
668 widget_signals[BUTTON_PRESS_EVENT] =
669 g_signal_new ("button_press_event",
670 G_TYPE_FROM_CLASS (object_class),
672 G_STRUCT_OFFSET(GtkWidgetClass, button_press_event),
673 _gtk_boolean_handled_accumulator, NULL,
674 _gtk_marshal_BOOLEAN__BOXED,
676 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
677 widget_signals[BUTTON_RELEASE_EVENT] =
678 g_signal_new ("button_release_event",
679 G_TYPE_FROM_CLASS(object_class),
681 G_STRUCT_OFFSET(GtkWidgetClass, button_release_event),
682 _gtk_boolean_handled_accumulator, NULL,
683 _gtk_marshal_BOOLEAN__BOXED,
685 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
686 widget_signals[SCROLL_EVENT] =
687 g_signal_new ("scroll_event",
688 G_TYPE_FROM_CLASS(object_class),
690 G_STRUCT_OFFSET(GtkWidgetClass, scroll_event),
691 _gtk_boolean_handled_accumulator, NULL,
692 _gtk_marshal_BOOLEAN__BOXED,
694 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
695 widget_signals[MOTION_NOTIFY_EVENT] =
696 g_signal_new ("motion_notify_event",
697 G_TYPE_FROM_CLASS(object_class),
699 G_STRUCT_OFFSET(GtkWidgetClass, motion_notify_event),
700 _gtk_boolean_handled_accumulator, NULL,
701 _gtk_marshal_BOOLEAN__BOXED,
703 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
704 widget_signals[DELETE_EVENT] =
705 g_signal_new ("delete_event",
706 G_TYPE_FROM_CLASS(object_class),
708 G_STRUCT_OFFSET(GtkWidgetClass, delete_event),
709 _gtk_boolean_handled_accumulator, NULL,
710 _gtk_marshal_BOOLEAN__BOXED,
712 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
713 widget_signals[DESTROY_EVENT] =
714 g_signal_new ("destroy_event",
715 G_TYPE_FROM_CLASS(object_class),
717 G_STRUCT_OFFSET(GtkWidgetClass, destroy_event),
718 _gtk_boolean_handled_accumulator, NULL,
719 _gtk_marshal_BOOLEAN__BOXED,
721 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
722 widget_signals[EXPOSE_EVENT] =
723 g_signal_new ("expose_event",
724 G_TYPE_FROM_CLASS(object_class),
726 G_STRUCT_OFFSET(GtkWidgetClass, expose_event),
727 _gtk_boolean_handled_accumulator, NULL,
728 _gtk_marshal_BOOLEAN__BOXED,
730 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
731 widget_signals[KEY_PRESS_EVENT] =
732 g_signal_new ("key_press_event",
733 G_TYPE_FROM_CLASS(object_class),
735 G_STRUCT_OFFSET(GtkWidgetClass, key_press_event),
736 _gtk_boolean_handled_accumulator, NULL,
737 _gtk_marshal_BOOLEAN__BOXED,
739 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
740 widget_signals[KEY_RELEASE_EVENT] =
741 g_signal_new ("key_release_event",
742 G_TYPE_FROM_CLASS(object_class),
744 G_STRUCT_OFFSET(GtkWidgetClass, key_release_event),
745 _gtk_boolean_handled_accumulator, NULL,
746 _gtk_marshal_BOOLEAN__BOXED,
748 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
749 widget_signals[ENTER_NOTIFY_EVENT] =
750 g_signal_new ("enter_notify_event",
751 G_TYPE_FROM_CLASS(object_class),
753 G_STRUCT_OFFSET(GtkWidgetClass, enter_notify_event),
754 _gtk_boolean_handled_accumulator, NULL,
755 _gtk_marshal_BOOLEAN__BOXED,
757 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
758 widget_signals[LEAVE_NOTIFY_EVENT] =
759 g_signal_new ("leave_notify_event",
760 G_TYPE_FROM_CLASS(object_class),
762 G_STRUCT_OFFSET(GtkWidgetClass, leave_notify_event),
763 _gtk_boolean_handled_accumulator, NULL,
764 _gtk_marshal_BOOLEAN__BOXED,
766 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
767 widget_signals[CONFIGURE_EVENT] =
768 g_signal_new ("configure_event",
769 G_TYPE_FROM_CLASS(object_class),
771 G_STRUCT_OFFSET(GtkWidgetClass, configure_event),
772 _gtk_boolean_handled_accumulator, NULL,
773 _gtk_marshal_BOOLEAN__BOXED,
775 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
776 widget_signals[FOCUS_IN_EVENT] =
777 g_signal_new ("focus_in_event",
778 G_TYPE_FROM_CLASS(object_class),
780 G_STRUCT_OFFSET(GtkWidgetClass, focus_in_event),
781 _gtk_boolean_handled_accumulator, NULL,
782 _gtk_marshal_BOOLEAN__BOXED,
784 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
785 widget_signals[FOCUS_OUT_EVENT] =
786 g_signal_new ("focus_out_event",
787 G_TYPE_FROM_CLASS(object_class),
789 G_STRUCT_OFFSET(GtkWidgetClass, focus_out_event),
790 _gtk_boolean_handled_accumulator, NULL,
791 _gtk_marshal_BOOLEAN__BOXED,
793 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
794 widget_signals[MAP_EVENT] =
795 g_signal_new ("map_event",
796 G_TYPE_FROM_CLASS(object_class),
798 G_STRUCT_OFFSET(GtkWidgetClass, map_event),
799 _gtk_boolean_handled_accumulator, NULL,
800 _gtk_marshal_BOOLEAN__BOXED,
802 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
803 widget_signals[UNMAP_EVENT] =
804 g_signal_new ("unmap_event",
805 G_TYPE_FROM_CLASS(object_class),
807 G_STRUCT_OFFSET(GtkWidgetClass, unmap_event),
808 _gtk_boolean_handled_accumulator, NULL,
809 _gtk_marshal_BOOLEAN__BOXED,
811 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
812 widget_signals[PROPERTY_NOTIFY_EVENT] =
813 g_signal_new ("property_notify_event",
814 G_TYPE_FROM_CLASS(object_class),
816 G_STRUCT_OFFSET(GtkWidgetClass, property_notify_event),
817 _gtk_boolean_handled_accumulator, NULL,
818 _gtk_marshal_BOOLEAN__BOXED,
820 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
821 widget_signals[SELECTION_CLEAR_EVENT] =
822 g_signal_new ("selection_clear_event",
823 G_TYPE_FROM_CLASS(object_class),
825 G_STRUCT_OFFSET(GtkWidgetClass, selection_clear_event),
826 _gtk_boolean_handled_accumulator, NULL,
827 _gtk_marshal_BOOLEAN__BOXED,
829 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
830 widget_signals[SELECTION_REQUEST_EVENT] =
831 g_signal_new ("selection_request_event",
832 G_TYPE_FROM_CLASS(object_class),
834 G_STRUCT_OFFSET(GtkWidgetClass, selection_request_event),
835 _gtk_boolean_handled_accumulator, NULL,
836 _gtk_marshal_BOOLEAN__BOXED,
838 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
839 widget_signals[SELECTION_NOTIFY_EVENT] =
840 g_signal_new ("selection_notify_event",
841 G_TYPE_FROM_CLASS(object_class),
843 G_STRUCT_OFFSET(GtkWidgetClass, selection_notify_event),
844 _gtk_boolean_handled_accumulator, NULL,
845 _gtk_marshal_BOOLEAN__BOXED,
847 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
848 widget_signals[SELECTION_RECEIVED] =
849 g_signal_new ("selection_received",
850 G_TYPE_FROM_CLASS (object_class),
852 G_STRUCT_OFFSET (GtkWidgetClass, selection_received),
854 _gtk_marshal_VOID__BOXED_UINT,
856 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
858 widget_signals[SELECTION_GET] =
859 g_signal_new ("selection_get",
860 G_TYPE_FROM_CLASS (object_class),
862 G_STRUCT_OFFSET (GtkWidgetClass, selection_get),
864 _gtk_marshal_VOID__BOXED_UINT_UINT,
866 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
869 widget_signals[PROXIMITY_IN_EVENT] =
870 g_signal_new ("proximity_in_event",
871 G_TYPE_FROM_CLASS (object_class),
873 G_STRUCT_OFFSET(GtkWidgetClass, proximity_in_event),
874 _gtk_boolean_handled_accumulator, NULL,
875 _gtk_marshal_BOOLEAN__BOXED,
877 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
878 widget_signals[PROXIMITY_OUT_EVENT] =
879 g_signal_new ("proximity_out_event",
880 G_TYPE_FROM_CLASS(object_class),
882 G_STRUCT_OFFSET(GtkWidgetClass, proximity_out_event),
883 _gtk_boolean_handled_accumulator, NULL,
884 _gtk_marshal_BOOLEAN__BOXED,
886 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
887 widget_signals[DRAG_LEAVE] =
888 gtk_signal_new ("drag_leave",
890 GTK_CLASS_TYPE (object_class),
891 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_leave),
892 _gtk_marshal_VOID__OBJECT_UINT,
894 GDK_TYPE_DRAG_CONTEXT,
896 widget_signals[DRAG_BEGIN] =
897 gtk_signal_new ("drag_begin",
899 GTK_CLASS_TYPE (object_class),
900 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_begin),
901 _gtk_marshal_VOID__OBJECT,
903 GDK_TYPE_DRAG_CONTEXT);
904 widget_signals[DRAG_END] =
905 gtk_signal_new ("drag_end",
907 GTK_CLASS_TYPE (object_class),
908 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_end),
909 _gtk_marshal_VOID__OBJECT,
911 GDK_TYPE_DRAG_CONTEXT);
912 widget_signals[DRAG_DATA_DELETE] =
913 gtk_signal_new ("drag_data_delete",
915 GTK_CLASS_TYPE (object_class),
916 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_data_delete),
917 _gtk_marshal_VOID__OBJECT,
919 GDK_TYPE_DRAG_CONTEXT);
920 widget_signals[DRAG_MOTION] =
921 g_signal_new ("drag_motion",
922 G_TYPE_FROM_CLASS(object_class),
924 G_STRUCT_OFFSET(GtkWidgetClass, drag_motion),
925 _gtk_boolean_handled_accumulator, NULL,
926 _gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
928 GDK_TYPE_DRAG_CONTEXT,
932 widget_signals[DRAG_DROP] =
933 g_signal_new ("drag_drop",
934 G_TYPE_FROM_CLASS(object_class),
936 G_STRUCT_OFFSET(GtkWidgetClass, drag_drop),
937 _gtk_boolean_handled_accumulator, NULL,
938 _gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
940 GDK_TYPE_DRAG_CONTEXT,
944 widget_signals[DRAG_DATA_GET] =
945 g_signal_new ("drag_data_get",
946 G_TYPE_FROM_CLASS (object_class),
948 G_STRUCT_OFFSET (GtkWidgetClass, drag_data_get),
950 _gtk_marshal_VOID__OBJECT_BOXED_UINT_UINT,
952 GDK_TYPE_DRAG_CONTEXT,
953 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
956 widget_signals[DRAG_DATA_RECEIVED] =
957 g_signal_new ("drag_data_received",
958 G_TYPE_FROM_CLASS (object_class),
960 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_data_received),
962 _gtk_marshal_VOID__OBJECT_INT_INT_BOXED_UINT_UINT,
964 GDK_TYPE_DRAG_CONTEXT,
967 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
970 widget_signals[VISIBILITY_NOTIFY_EVENT] =
971 g_signal_new ("visibility_notify_event",
972 G_TYPE_FROM_CLASS(object_class),
974 G_STRUCT_OFFSET(GtkWidgetClass, visibility_notify_event),
975 _gtk_boolean_handled_accumulator, NULL,
976 _gtk_marshal_BOOLEAN__BOXED,
978 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
979 widget_signals[CLIENT_EVENT] =
980 g_signal_new ("client_event",
981 G_TYPE_FROM_CLASS(object_class),
983 G_STRUCT_OFFSET(GtkWidgetClass, client_event),
984 _gtk_boolean_handled_accumulator, NULL,
985 _gtk_marshal_BOOLEAN__BOXED,
987 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
988 widget_signals[NO_EXPOSE_EVENT] =
989 g_signal_new ("no_expose_event",
990 G_TYPE_FROM_CLASS(object_class),
992 G_STRUCT_OFFSET(GtkWidgetClass, no_expose_event),
993 _gtk_boolean_handled_accumulator, NULL,
994 _gtk_marshal_BOOLEAN__BOXED,
996 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
997 widget_signals[WINDOW_STATE_EVENT] =
998 g_signal_new ("window_state_event",
999 G_TYPE_FROM_CLASS(object_class),
1001 G_STRUCT_OFFSET(GtkWidgetClass, window_state_event),
1002 _gtk_boolean_handled_accumulator, NULL,
1003 _gtk_marshal_BOOLEAN__BOXED,
1005 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
1006 widget_signals[POPUP_MENU] =
1007 gtk_signal_new ("popup_menu",
1008 GTK_RUN_LAST | GTK_RUN_ACTION,
1009 GTK_CLASS_TYPE (object_class),
1010 GTK_SIGNAL_OFFSET (GtkWidgetClass, popup_menu),
1011 _gtk_marshal_NONE__NONE,
1013 widget_signals[SHOW_HELP] =
1014 gtk_signal_new ("show_help",
1015 GTK_RUN_LAST | GTK_RUN_ACTION,
1016 GTK_CLASS_TYPE (object_class),
1017 GTK_SIGNAL_OFFSET (GtkWidgetClass, show_help),
1018 _gtk_marshal_NONE__ENUM,
1019 GTK_TYPE_NONE, 1, GTK_TYPE_WIDGET_HELP_TYPE);
1020 widget_signals[ACCEL_CLOSURES_CHANGED] =
1021 gtk_signal_new ("accel_closures_changed",
1023 GTK_CLASS_TYPE (object_class),
1025 gtk_marshal_NONE__NONE,
1028 binding_set = gtk_binding_set_by_class (klass);
1029 gtk_binding_entry_add_signal (binding_set, GDK_F10, GDK_SHIFT_MASK,
1031 gtk_binding_entry_add_signal (binding_set, GDK_Menu, 0,
1034 gtk_binding_entry_add_signal (binding_set, GDK_F1, GDK_CONTROL_MASK,
1036 GTK_TYPE_WIDGET_HELP_TYPE,
1037 GTK_WIDGET_HELP_TOOLTIP);
1038 gtk_binding_entry_add_signal (binding_set, GDK_KP_F1, GDK_CONTROL_MASK,
1040 GTK_TYPE_WIDGET_HELP_TYPE,
1041 GTK_WIDGET_HELP_TOOLTIP);
1042 gtk_binding_entry_add_signal (binding_set, GDK_F1, GDK_SHIFT_MASK,
1044 GTK_TYPE_WIDGET_HELP_TYPE,
1045 GTK_WIDGET_HELP_WHATS_THIS);
1046 gtk_binding_entry_add_signal (binding_set, GDK_KP_F1, GDK_SHIFT_MASK,
1048 GTK_TYPE_WIDGET_HELP_TYPE,
1049 GTK_WIDGET_HELP_WHATS_THIS);
1051 gtk_widget_class_install_style_property (klass,
1052 g_param_spec_boolean ("interior_focus",
1053 _("Interior Focus"),
1054 _("Whether to draw the focus indicator inside widgets."),
1058 gtk_widget_class_install_style_property (klass,
1059 g_param_spec_int ("focus-line-width",
1060 _("Focus linewidth"),
1061 _("Width, in pixels, of the focus indicator line."),
1063 G_PARAM_READWRITE));
1065 gtk_widget_class_install_style_property (klass,
1066 g_param_spec_string ("focus-line-pattern",
1067 _("Focus line dash pattern"),
1068 _("Dash pattern used to draw the focus indicator."),
1070 G_PARAM_READWRITE));
1071 gtk_widget_class_install_style_property (klass,
1072 g_param_spec_int ("focus-padding",
1074 _("Width, in pixels, between focus indicator and the widget 'box'."),
1076 G_PARAM_READWRITE));
1081 gtk_widget_set_property (GObject *object,
1083 const GValue *value,
1088 widget = GTK_WIDGET (object);
1092 guint32 saved_flags;
1095 gtk_widget_set_name (widget, g_value_get_string (value));
1098 gtk_container_add (GTK_CONTAINER (g_value_get_object (value)), widget);
1100 case PROP_WIDTH_REQUEST:
1101 gtk_widget_set_usize (widget, g_value_get_int (value), -2);
1103 case PROP_HEIGHT_REQUEST:
1104 gtk_widget_set_usize (widget, -2, g_value_get_int (value));
1107 if (g_value_get_boolean (value))
1108 gtk_widget_show (widget);
1110 gtk_widget_hide (widget);
1112 case PROP_SENSITIVE:
1113 gtk_widget_set_sensitive (widget, g_value_get_boolean (value));
1115 case PROP_APP_PAINTABLE:
1116 gtk_widget_set_app_paintable (widget, g_value_get_boolean (value));
1118 case PROP_CAN_FOCUS:
1119 saved_flags = GTK_WIDGET_FLAGS (widget);
1120 if (g_value_get_boolean (value))
1121 GTK_WIDGET_SET_FLAGS (widget, GTK_CAN_FOCUS);
1123 GTK_WIDGET_UNSET_FLAGS (widget, GTK_CAN_FOCUS);
1124 if (saved_flags != GTK_WIDGET_FLAGS (widget))
1125 gtk_widget_queue_resize (widget);
1127 case PROP_HAS_FOCUS:
1128 if (g_value_get_boolean (value))
1129 gtk_widget_grab_focus (widget);
1131 case PROP_CAN_DEFAULT:
1132 saved_flags = GTK_WIDGET_FLAGS (widget);
1133 if (g_value_get_boolean (value))
1134 GTK_WIDGET_SET_FLAGS (widget, GTK_CAN_DEFAULT);
1136 GTK_WIDGET_UNSET_FLAGS (widget, GTK_CAN_DEFAULT);
1137 if (saved_flags != GTK_WIDGET_FLAGS (widget))
1138 gtk_widget_queue_resize (widget);
1140 case PROP_HAS_DEFAULT:
1141 if (g_value_get_boolean (value))
1142 gtk_widget_grab_default (widget);
1144 case PROP_RECEIVES_DEFAULT:
1145 if (g_value_get_boolean (value))
1146 GTK_WIDGET_SET_FLAGS (widget, GTK_RECEIVES_DEFAULT);
1148 GTK_WIDGET_UNSET_FLAGS (widget, GTK_RECEIVES_DEFAULT);
1151 gtk_widget_set_style (widget, g_value_get_object (value));
1154 if (!GTK_WIDGET_REALIZED (widget) && !GTK_WIDGET_NO_WINDOW (widget))
1155 gtk_widget_set_events (widget, g_value_get_flags (value));
1157 case PROP_EXTENSION_EVENTS:
1158 gtk_widget_set_extension_events (widget, g_value_get_enum (value));
1166 gtk_widget_get_property (GObject *object,
1173 widget = GTK_WIDGET (object);
1178 GdkExtensionMode *modep;
1182 g_value_set_string (value, widget->name);
1184 g_value_set_string (value, "");
1188 g_value_set_object (value, G_OBJECT (widget->parent));
1190 g_value_set_object (value, NULL);
1192 case PROP_WIDTH_REQUEST:
1195 gtk_widget_get_size_request (widget, &w, NULL);
1196 g_value_set_int (value, w);
1199 case PROP_HEIGHT_REQUEST:
1202 gtk_widget_get_size_request (widget, NULL, &h);
1203 g_value_set_int (value, h);
1207 g_value_set_boolean (value, (GTK_WIDGET_VISIBLE (widget) != FALSE));
1209 case PROP_SENSITIVE:
1210 g_value_set_boolean (value, (GTK_WIDGET_SENSITIVE (widget) != FALSE));
1212 case PROP_APP_PAINTABLE:
1213 g_value_set_boolean (value, (GTK_WIDGET_APP_PAINTABLE (widget) != FALSE));
1215 case PROP_CAN_FOCUS:
1216 g_value_set_boolean (value, (GTK_WIDGET_CAN_FOCUS (widget) != FALSE));
1218 case PROP_HAS_FOCUS:
1219 g_value_set_boolean (value, (GTK_WIDGET_HAS_FOCUS (widget) != FALSE));
1221 case PROP_CAN_DEFAULT:
1222 g_value_set_boolean (value, (GTK_WIDGET_CAN_DEFAULT (widget) != FALSE));
1224 case PROP_HAS_DEFAULT:
1225 g_value_set_boolean (value, (GTK_WIDGET_HAS_DEFAULT (widget) != FALSE));
1227 case PROP_RECEIVES_DEFAULT:
1228 g_value_set_boolean (value, (GTK_WIDGET_RECEIVES_DEFAULT (widget) != FALSE));
1230 case PROP_COMPOSITE_CHILD:
1231 g_value_set_boolean (value, (GTK_WIDGET_COMPOSITE_CHILD (widget) != FALSE));
1234 g_value_set_object (value, G_OBJECT (gtk_widget_get_style (widget)));
1237 eventp = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_event_mask);
1239 g_value_set_flags (value, 0);
1241 g_value_set_flags (value, *eventp);
1243 case PROP_EXTENSION_EVENTS:
1244 modep = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_extension_event_mode);
1246 g_value_set_enum (value, 0);
1248 g_value_set_enum (value, (GdkExtensionMode) *modep);
1251 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1257 gtk_widget_init (GtkWidget *widget)
1259 GTK_PRIVATE_FLAGS (widget) = PRIVATE_GTK_CHILD_VISIBLE;
1260 widget->state = GTK_STATE_NORMAL;
1261 widget->saved_state = GTK_STATE_NORMAL;
1262 widget->name = NULL;
1263 widget->requisition.width = 0;
1264 widget->requisition.height = 0;
1265 widget->allocation.x = -1;
1266 widget->allocation.y = -1;
1267 widget->allocation.width = 1;
1268 widget->allocation.height = 1;
1269 widget->window = NULL;
1270 widget->parent = NULL;
1272 GTK_WIDGET_SET_FLAGS (widget,
1274 GTK_PARENT_SENSITIVE |
1275 (composite_child_stack ? GTK_COMPOSITE_CHILD : 0) |
1276 GTK_DOUBLE_BUFFERED);
1278 GTK_PRIVATE_SET_FLAG (widget, GTK_REDRAW_ON_ALLOC);
1280 widget->style = gtk_widget_get_default_style ();
1281 g_object_ref (widget->style);
1286 gtk_widget_dispatch_child_properties_changed (GtkWidget *widget,
1288 GParamSpec **pspecs)
1290 GtkWidget *container = widget->parent;
1293 for (i = 0; widget->parent == container && i < n_pspecs; i++)
1294 g_signal_emit (widget, widget_signals[CHILD_NOTIFY], g_quark_from_string (pspecs[i]->name), pspecs[i]);
1298 gtk_widget_freeze_child_notify (GtkWidget *widget)
1300 g_return_if_fail (GTK_IS_WIDGET (widget));
1302 if (!G_OBJECT (widget)->ref_count)
1305 g_object_ref (widget);
1306 g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
1307 g_object_unref (widget);
1311 gtk_widget_child_notify (GtkWidget *widget,
1312 const gchar *child_property)
1316 g_return_if_fail (GTK_IS_WIDGET (widget));
1317 g_return_if_fail (child_property != NULL);
1318 if (!G_OBJECT (widget)->ref_count || !widget->parent)
1321 g_object_ref (widget);
1322 pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
1324 G_OBJECT_TYPE (widget->parent),
1327 g_warning ("%s: container class `%s' has no child property named `%s'",
1329 G_OBJECT_TYPE_NAME (widget->parent),
1333 GObjectNotifyQueue *nqueue = g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
1335 g_object_notify_queue_add (G_OBJECT (widget), nqueue, pspec);
1336 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
1338 g_object_unref (widget);
1342 gtk_widget_thaw_child_notify (GtkWidget *widget)
1344 GObjectNotifyQueue *nqueue;
1346 g_return_if_fail (GTK_IS_WIDGET (widget));
1348 if (!G_OBJECT (widget)->ref_count)
1351 g_object_ref (widget);
1352 nqueue = g_object_notify_queue_from_object (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
1353 if (!nqueue || !nqueue->freeze_count)
1354 g_warning (G_STRLOC ": child-property-changed notification for %s(%p) is not frozen",
1355 G_OBJECT_TYPE_NAME (widget), widget);
1357 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
1358 g_object_unref (widget);
1364 * @type: type ID of the widget to create
1365 * @first_property_name: name of first property to set
1366 * @Varargs: value of first property, followed by more properties, %NULL-terminated
1368 * This is a convenience function for creating a widget and setting
1369 * its properties in one go. For example you might write:
1370 * <literal>gtk_widget_new (GTK_TYPE_LABEL, "label", "Hello World", "xalign",
1371 * 0.0, NULL)</literal> to create a left-aligned label. Equivalent to
1372 * gtk_object_new(), but returns a widget so you don't have to
1373 * cast the object yourself.
1375 * Return value: a new #GtkWidget of type @widget_type
1378 gtk_widget_new (GtkType type,
1379 const gchar *first_property_name,
1385 g_return_val_if_fail (gtk_type_is_a (type, GTK_TYPE_WIDGET), NULL);
1387 va_start (var_args, first_property_name);
1388 widget = (GtkWidget *)g_object_new_valist (type, first_property_name, var_args);
1396 * @widget: a #GtkWidget
1397 * @first_property_name: name of first property to set
1398 * @Varargs: value of first property, followed by more properties, %NULL-terminated
1400 * Like gtk_object_set() - there's no reason to use this instead of
1404 gtk_widget_set (GtkWidget *widget,
1405 const gchar *first_property_name,
1410 g_return_if_fail (GTK_IS_WIDGET (widget));
1412 va_start (var_args, first_property_name);
1413 g_object_set_valist (G_OBJECT (widget), first_property_name, var_args);
1418 gtk_widget_queue_clear_child (GtkWidget *widget)
1422 parent = widget->parent;
1423 if (parent && GTK_WIDGET_DRAWABLE (parent))
1424 gtk_widget_queue_clear_area (parent,
1425 widget->allocation.x,
1426 widget->allocation.y,
1427 widget->allocation.width,
1428 widget->allocation.height);
1432 * gtk_widget_unparent:
1433 * @widget: a #GtkWidget
1435 * This function is only for use in widget implementations.
1436 * Should be called by implementations of the remove method
1437 * on #GtkContainer, to dissociate a child from the container.
1440 gtk_widget_unparent (GtkWidget *widget)
1442 GObjectNotifyQueue *nqueue;
1443 GtkWidget *toplevel;
1444 GtkWidget *old_parent;
1446 g_return_if_fail (GTK_IS_WIDGET (widget));
1447 if (widget->parent == NULL)
1450 /* keep this function in sync with gtk_menu_detach()
1453 g_object_freeze_notify (G_OBJECT (widget));
1454 nqueue = g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
1456 /* unset focused and default children properly, this code
1457 * should eventually move into some gtk_window_unparent_branch() or
1461 toplevel = gtk_widget_get_toplevel (widget);
1462 if (GTK_CONTAINER (widget->parent)->focus_child == widget)
1464 gtk_container_set_focus_child (GTK_CONTAINER (widget->parent), NULL);
1466 if (GTK_WIDGET_TOPLEVEL (toplevel))
1470 child = GTK_WINDOW (toplevel)->focus_widget;
1472 while (child && child != widget)
1473 child = child->parent;
1475 if (child == widget)
1476 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
1479 if (GTK_WIDGET_TOPLEVEL (toplevel))
1483 child = GTK_WINDOW (toplevel)->default_widget;
1485 while (child && child != widget)
1486 child = child->parent;
1488 if (child == widget)
1489 gtk_window_set_default (GTK_WINDOW (toplevel), NULL);
1492 /* If we are unanchoring the child, we save around the toplevel
1493 * to emit hierarchy changed
1495 if (GTK_WIDGET_ANCHORED (widget->parent))
1496 g_object_ref (toplevel);
1500 gtk_widget_queue_clear_child (widget);
1502 /* Reset the width and height here, to force reallocation if we
1503 * get added back to a new parent. This won't work if our new
1504 * allocation is smaller than 1x1 and we actually want a size of 1x1...
1505 * (would 0x0 be OK here?)
1507 widget->allocation.width = 1;
1508 widget->allocation.height = 1;
1510 if (GTK_WIDGET_REALIZED (widget) && !GTK_WIDGET_IN_REPARENT (widget))
1511 gtk_widget_unrealize (widget);
1513 /* Removing a widget from a container restores the child visible
1514 * flag to the default state, so it doesn't affect the child
1515 * in the next parent.
1517 GTK_PRIVATE_SET_FLAG (widget, GTK_CHILD_VISIBLE);
1519 old_parent = widget->parent;
1520 widget->parent = NULL;
1521 gtk_widget_set_parent_window (widget, NULL);
1522 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[PARENT_SET], old_parent);
1525 _gtk_widget_propagate_hierarchy_changed (widget, toplevel);
1526 g_object_unref (toplevel);
1529 g_object_notify (G_OBJECT (widget), "parent");
1530 g_object_thaw_notify (G_OBJECT (widget));
1531 if (!widget->parent)
1532 g_object_notify_queue_clear (G_OBJECT (widget), nqueue);
1533 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
1534 gtk_widget_unref (widget);
1538 * gtk_widget_destroy:
1539 * @widget: a #GtkWidget
1541 * Destroys a widget. Equivalent to gtk_object_destroy(), except that
1542 * you don't have to cast the widget to #GtkObject. When a widget is
1543 * destroyed, it will break any references it holds to other objects.
1544 * If the widget is inside a container, the widget will be removed
1545 * from the container. If the widget is a toplevel (derived from
1546 * #GtkWindow), it will be removed from the list of toplevels, and the
1547 * reference GTK+ holds to it will be removed. Removing a
1548 * widget from its container or the list of toplevels results in the
1549 * widget being finalized, unless you've added additional references
1550 * to the widget with gtk_object_ref().
1552 * In most cases, only toplevel widgets (windows) require explicit
1553 * destruction, because when you destroy a toplevel its children will
1554 * be destroyed as well.
1558 gtk_widget_destroy (GtkWidget *widget)
1560 g_return_if_fail (GTK_IS_WIDGET (widget));
1562 gtk_object_destroy ((GtkObject*) widget);
1566 * gtk_widget_destroyed:
1567 * @widget: a #GtkWidget
1568 * @widget_pointer: address of a variable that contains @widget
1570 * This function sets *@widget_pointer to %NULL if @widget_pointer !=
1571 * %NULL. It's intended to be used as a callback connected to the
1572 * "destroy" signal of a widget. You connect gtk_widget_destroyed()
1573 * as a signal handler, and pass the address of your widget variable
1574 * as user data. Then when the widget is destroyed, the variable will
1575 * be set to %NULL. Useful for example to avoid multiple copies
1576 * of the same dialog.
1580 gtk_widget_destroyed (GtkWidget *widget,
1581 GtkWidget **widget_pointer)
1583 /* Don't make any assumptions about the
1585 * Even check widget_pointer.
1588 *widget_pointer = NULL;
1593 * @widget: a #GtkWidget
1595 * Flags a widget to be displayed. Any widget that isn't shown will
1596 * not appear on the screen. If you want to show all the widgets in a
1597 * container, it's easier to call gtk_widget_show_all() on the
1598 * container, instead of individually showing the widgets.
1600 * Remember that you have to show the containers containing a widget,
1601 * in addition to the widget itself, before it will appear onscreen.
1603 * When a toplevel container is shown, it is immediately realized and
1604 * mapped; other shown widgets are realized and mapped when their
1605 * toplevel container is realized and mapped.
1609 gtk_widget_show (GtkWidget *widget)
1611 g_return_if_fail (GTK_IS_WIDGET (widget));
1613 if (!GTK_WIDGET_VISIBLE (widget))
1615 g_object_ref (G_OBJECT (widget));
1616 if (!GTK_WIDGET_TOPLEVEL (widget))
1617 gtk_widget_queue_resize (widget);
1618 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[SHOW]);
1619 g_object_notify (G_OBJECT (widget), "visible");
1620 g_object_unref (G_OBJECT (widget));
1625 gtk_widget_real_show (GtkWidget *widget)
1627 g_return_if_fail (GTK_IS_WIDGET (widget));
1629 if (!GTK_WIDGET_VISIBLE (widget))
1631 GTK_WIDGET_SET_FLAGS (widget, GTK_VISIBLE);
1633 if (widget->parent &&
1634 GTK_WIDGET_MAPPED (widget->parent) &&
1635 GTK_WIDGET_CHILD_VISIBLE (widget) &&
1636 !GTK_WIDGET_MAPPED (widget))
1637 gtk_widget_map (widget);
1642 gtk_widget_show_map_callback (GtkWidget *widget, GdkEvent *event, gint *flag)
1645 gtk_signal_disconnect_by_data (GTK_OBJECT (widget), flag);
1649 * gtk_widget_show_now:
1650 * @widget: a #GtkWidget
1652 * Shows a widget. If the widget is an unmapped toplevel widget
1653 * (i.e. a #GtkWindow that has not yet been shown), enter the main
1654 * loop and wait for the window to actually be mapped. Be careful;
1655 * because the main loop is running, anything can happen during
1659 gtk_widget_show_now (GtkWidget *widget)
1663 g_return_if_fail (GTK_IS_WIDGET (widget));
1665 /* make sure we will get event */
1666 if (!GTK_WIDGET_MAPPED (widget) &&
1667 GTK_WIDGET_TOPLEVEL (widget))
1669 gtk_widget_show (widget);
1671 gtk_signal_connect (GTK_OBJECT (widget), "map_event",
1672 GTK_SIGNAL_FUNC (gtk_widget_show_map_callback),
1676 gtk_main_iteration();
1679 gtk_widget_show (widget);
1684 * @widget: a #GtkWidget
1686 * Reverses the effects of gtk_widget_show(), causing the widget to be
1687 * hidden (invisible to the user).
1690 gtk_widget_hide (GtkWidget *widget)
1692 g_return_if_fail (GTK_IS_WIDGET (widget));
1694 if (GTK_WIDGET_VISIBLE (widget))
1696 gtk_widget_ref (widget);
1697 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[HIDE]);
1698 if (!GTK_WIDGET_TOPLEVEL (widget) && GTK_WIDGET_REALIZED (widget))
1699 gtk_widget_queue_resize (widget);
1700 g_object_notify (G_OBJECT (widget), "visible");
1701 gtk_widget_unref (widget);
1706 gtk_widget_real_hide (GtkWidget *widget)
1708 g_return_if_fail (GTK_IS_WIDGET (widget));
1710 if (GTK_WIDGET_VISIBLE (widget))
1712 GTK_WIDGET_UNSET_FLAGS (widget, GTK_VISIBLE);
1714 if (GTK_WIDGET_MAPPED (widget))
1715 gtk_widget_unmap (widget);
1720 * gtk_widget_hide_on_delete:
1721 * @widget: a #GtkWidget
1723 * Utility function; intended to be connected to the "delete_event"
1724 * signal on a #GtkWindow. The function calls gtk_widget_hide() on its
1725 * argument, then returns %TRUE. If connected to "delete_event",
1726 * the result is that clicking the window manager close button for
1727 * will hide but not destroy the window. By default, GTK+ destroys
1728 * windows when "delete_event" is received.
1730 * Return value: %TRUE
1733 gtk_widget_hide_on_delete (GtkWidget *widget)
1735 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
1737 gtk_widget_hide (widget);
1743 * gtk_widget_show_all:
1744 * @widget: a #GtkWidget
1746 * Recursively shows a widget, and any child widgets (if the widget is
1750 gtk_widget_show_all (GtkWidget *widget)
1752 GtkWidgetClass *class;
1754 g_return_if_fail (GTK_IS_WIDGET (widget));
1756 class = GTK_WIDGET_GET_CLASS (widget);
1758 if (class->show_all)
1759 class->show_all (widget);
1763 * gtk_widget_hide_all:
1764 * @widget: a #GtkWidget
1766 * Recursively hides a widget and any child widgets.
1769 gtk_widget_hide_all (GtkWidget *widget)
1771 GtkWidgetClass *class;
1773 g_return_if_fail (GTK_IS_WIDGET (widget));
1775 class = GTK_WIDGET_GET_CLASS (widget);
1777 if (class->hide_all)
1778 class->hide_all (widget);
1783 * @widget: a #GtkWidget
1785 * This function is only for use in widget implementations. Causes
1786 * a widget to be mapped if it isn't already.
1790 gtk_widget_map (GtkWidget *widget)
1792 g_return_if_fail (GTK_IS_WIDGET (widget));
1793 g_return_if_fail (GTK_WIDGET_VISIBLE (widget));
1794 g_return_if_fail (GTK_WIDGET_CHILD_VISIBLE (widget));
1796 if (!GTK_WIDGET_MAPPED (widget))
1798 if (!GTK_WIDGET_REALIZED (widget))
1799 gtk_widget_realize (widget);
1801 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[MAP]);
1803 if (GTK_WIDGET_NO_WINDOW (widget))
1804 gdk_window_invalidate_rect (widget->window, &widget->allocation, FALSE);
1810 * @widget: a #GtkWidget
1812 * This function is only for use in widget implementations. Causes
1813 * a widget to be unmapped if it's currently mapped.
1817 gtk_widget_unmap (GtkWidget *widget)
1819 g_return_if_fail (GTK_IS_WIDGET (widget));
1821 if (GTK_WIDGET_MAPPED (widget))
1823 if (GTK_WIDGET_NO_WINDOW (widget))
1824 gdk_window_invalidate_rect (widget->window, &widget->allocation, FALSE);
1825 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[UNMAP]);
1830 * gtk_widget_realize:
1831 * @widget: a #GtkWidget
1833 * Creates the GDK (windowing system) resources associated with a
1834 * widget. For example, @widget->window will be created when a widget
1835 * is realized. Normally realization happens implicitly; if you show
1836 * a widget and all its parent containers, then the widget will be
1837 * realized and mapped automatically.
1839 * Realizing a widget requires all
1840 * the widget's parent widgets to be realized; calling
1841 * gtk_widget_realize() realizes the widget's parents in addition to
1842 * @widget itself. If a widget is not yet inside a toplevel window
1843 * when you realize it, bad things will happen.
1845 * This function is primarily used in widget implementations, and
1846 * isn't very useful otherwise. Many times when you think you might
1847 * need it, a better approach is to connect to a signal that will be
1848 * called after the widget is realized automatically, such as
1849 * "expose_event". Or simply gtk_signal_connect_after() to the
1854 gtk_widget_realize (GtkWidget *widget)
1857 GdkExtensionMode mode;
1858 GtkWidgetShapeInfo *shape_info;
1860 g_return_if_fail (GTK_IS_WIDGET (widget));
1862 if (!GTK_WIDGET_REALIZED (widget))
1865 if (GTK_IS_CONTAINER (widget) && !GTK_WIDGET_NO_WINDOW (widget))
1866 g_message ("gtk_widget_realize(%s)", gtk_type_name (GTK_WIDGET_TYPE (widget)));
1869 if (widget->parent == NULL &&
1870 !GTK_WIDGET_TOPLEVEL (widget))
1871 g_warning ("Calling gtk_widget_realize() on a widget that isn't "
1872 "inside a toplevel window is not going to work very well. "
1873 "Widgets must be inside a toplevel container before realizing them.");
1875 if (widget->parent && !GTK_WIDGET_REALIZED (widget->parent))
1876 gtk_widget_realize (widget->parent);
1878 gtk_widget_ensure_style (widget);
1880 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[REALIZE]);
1882 if (GTK_WIDGET_HAS_SHAPE_MASK (widget))
1884 shape_info = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_shape_info);
1885 gdk_window_shape_combine_mask (widget->window,
1886 shape_info->shape_mask,
1887 shape_info->offset_x,
1888 shape_info->offset_y);
1891 if (!GTK_WIDGET_NO_WINDOW (widget))
1893 mode = gtk_widget_get_extension_events (widget);
1894 if (mode != GDK_EXTENSION_EVENTS_NONE)
1896 events = gtk_widget_get_events (widget);
1897 gdk_input_set_extension_events (widget->window, events, mode);
1905 * gtk_widget_unrealize:
1906 * @widget: a #GtkWidget
1908 * This function is only useful in widget implementations.
1909 * Causes a widget to be unrealized (frees all GDK resources
1910 * associated with the widget, such as @widget->window).
1914 gtk_widget_unrealize (GtkWidget *widget)
1916 g_return_if_fail (GTK_IS_WIDGET (widget));
1918 if (GTK_WIDGET_HAS_SHAPE_MASK (widget))
1919 gtk_widget_shape_combine_mask (widget, NULL, -1, -1);
1921 if (GTK_WIDGET_REALIZED (widget))
1923 gtk_widget_ref (widget);
1924 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[UNREALIZE]);
1925 GTK_WIDGET_UNSET_FLAGS (widget, GTK_REALIZED | GTK_MAPPED);
1926 gtk_widget_unref (widget);
1930 /*****************************************
1932 *****************************************/
1935 * gtk_widget_queue_draw_area:
1936 * @widget: a #GtkWidget
1937 * @x: x coordinate of upper-left corner of rectangle to redraw
1938 * @y: y coordinate of upper-left corner of rectangle to redraw
1939 * @width: width of region to draw
1940 * @height: height of region to draw
1942 * Invalidates the rectangular area of @widget defined by @x, @y,
1943 * @width and @height by calling gdk_window_invalidate_rect() on the
1944 * widget's window and all its child windows. Once the main loop
1945 * becomes idle (after the current batch of events has been processed,
1946 * roughly), the window will receive expose events for the union of
1947 * all regions that have been invalidated.
1949 * Normally you would only use this function in widget
1950 * implementations. You might also use it, or
1951 * gdk_window_invalidate_rect() directly, to schedule a redraw of a
1952 * #GtkDrawingArea or some portion thereof.
1954 * Frequently you can just call gdk_window_invalidate_rect() or
1955 * gdk_window_invalidate_region() instead of this function. Those
1956 * functions will invalidate only a single window, instead of the
1957 * widget and all its children.
1959 * The advantage of adding to the invalidated region compared to
1960 * simply drawing immediately is efficiency; using an invalid region
1961 * ensures that you only have to redraw one time.
1965 gtk_widget_queue_draw_area (GtkWidget *widget,
1971 g_return_if_fail (GTK_IS_WIDGET (widget));
1973 gtk_widget_queue_clear_area (widget, x, y, width, height);
1977 * gtk_widget_queue_draw:
1978 * @widget: a #GtkWidget
1980 * Equivalent to calling gtk_widget_queue_draw_area() for the
1981 * entire area of a widget.
1985 gtk_widget_queue_draw (GtkWidget *widget)
1987 g_return_if_fail (GTK_IS_WIDGET (widget));
1989 gtk_widget_queue_clear (widget);
1992 /* Invalidates the given area (allocation-relative-coordinates)
1993 * in all of the widget's windows
1996 * gtk_widget_queue_clear_area:
1997 * @widget: a #GtkWidget
1998 * @x: x coordinate of upper-left corner of rectangle to redraw
1999 * @y: y coordinate of upper-left corner of rectangle to redraw
2000 * @width: width of region to draw
2001 * @height: height of region to draw
2003 * DEPRECATED. This function is no longer different from
2004 * gtk_widget_queue_draw_area(), though it once was. Now it just calls
2005 * gtk_widget_queue_draw_area(). Originally
2006 * gtk_widget_queue_clear_area() would force a redraw of the
2007 * background for %GTK_NO_WINDOW widgets, and
2008 * gtk_widget_queue_draw_area() would not. Now both functions ensure
2009 * the background will be redrawn.
2013 gtk_widget_queue_clear_area (GtkWidget *widget,
2019 GdkRectangle invalid_rect;
2021 g_return_if_fail (GTK_IS_WIDGET (widget));
2023 if (!(widget->window && gdk_window_is_viewable (widget->window)))
2026 /* Find the correct widget */
2028 if (!GTK_WIDGET_NO_WINDOW (widget))
2032 /* Translate widget relative to window-relative */
2034 gint wx, wy, wwidth, wheight;
2036 gdk_window_get_position (widget->window, &wx, &wy);
2037 x -= wx - widget->allocation.x;
2038 y -= wy - widget->allocation.y;
2040 gdk_window_get_size (widget->window, &wwidth, &wheight);
2042 if (x + width <= 0 || y + height <= 0 ||
2043 x >= wwidth || y >= wheight)
2054 if (x + width > wwidth)
2056 if (y + height > wheight)
2057 height = wheight - y;
2063 invalid_rect.width = width;
2064 invalid_rect.height = height;
2066 gdk_window_invalidate_rect (widget->window, &invalid_rect, TRUE);
2070 * gtk_widget_queue_clear:
2071 * @widget: a #GtkWidget
2073 * DEPRECATED. Use gtk_widget_queue_draw() instead.
2076 gtk_widget_queue_clear (GtkWidget *widget)
2078 g_return_if_fail (GTK_IS_WIDGET (widget));
2080 if (widget->allocation.width || widget->allocation.height)
2082 if (GTK_WIDGET_NO_WINDOW (widget))
2083 gtk_widget_queue_clear_area (widget, widget->allocation.x,
2084 widget->allocation.y,
2085 widget->allocation.width,
2086 widget->allocation.height);
2088 gtk_widget_queue_clear_area (widget, 0, 0,
2089 widget->allocation.width,
2090 widget->allocation.height);
2095 * gtk_widget_queue_resize:
2096 * @widget: a #GtkWidget
2098 * This function is only for use in widget implementations.
2099 * Flags a widget to have its size renegotiated; should
2100 * be called when a widget for some reason has a new size request.
2101 * For example, when you change the text in a #GtkLabel, #GtkLabel
2102 * queues a resize to ensure there's enough space for the new text.
2106 gtk_widget_queue_resize (GtkWidget *widget)
2110 g_return_if_fail (GTK_IS_WIDGET (widget));
2112 if (GTK_WIDGET_REALIZED (widget))
2114 region = gdk_region_rectangle (&widget->allocation);
2115 gtk_widget_invalidate_widget_windows (widget, region);
2116 gdk_region_destroy (region);
2119 _gtk_size_group_queue_resize (widget);
2124 * @widget: a #GtkWidget
2125 * @area: area to draw
2127 * DEPRECATED. In GTK+ 1.2, this function would immediately render the
2128 * region @area of a widget, by invoking the virtual draw method of a
2129 * widget. In GTK+ 2.0, the draw method is gone, and instead
2130 * gtk_widget_draw() simply invalidates the specified region of the
2131 * widget, then updates the invalid region of the widget immediately.
2132 * Usually you don't want to update the region immediately for
2133 * performance reasons, so in general gtk_widget_queue_draw_area() is
2134 * a better choice if you want to draw a region of a widget.
2138 gtk_widget_draw (GtkWidget *widget,
2141 g_return_if_fail (GTK_IS_WIDGET (widget));
2143 if (GTK_WIDGET_DRAWABLE (widget))
2146 gtk_widget_queue_draw_area (widget,
2148 area->width, area->height);
2150 gtk_widget_queue_draw (widget);
2152 gdk_window_process_updates (widget->window, TRUE);
2157 * gtk_widget_size_request:
2158 * @widget: a #GtkWidget
2159 * @requisition: a #GtkRequisition to be filled in
2161 * This function is typically used when implementing a #GtkContainer
2162 * subclass. Obtains the preferred size of a widget. The container
2163 * uses this information to arrange its child widgets and decide what
2164 * size allocations to give them with gtk_widget_size_allocate().
2166 * You can also call this function from an application, with some
2167 * caveats. Most notably, getting a size request requires the widget
2168 * to be associated with a screen, because font information may be
2169 * needed. Multihead-aware applications should keep this in mind.
2171 * Also remember that the size request is not necessarily the size
2172 * a widget will actually be allocated.
2174 * See also gtk_widget_get_child_requisition().
2177 gtk_widget_size_request (GtkWidget *widget,
2178 GtkRequisition *requisition)
2180 g_return_if_fail (GTK_IS_WIDGET (widget));
2182 #ifdef G_ENABLE_DEBUG
2183 if (requisition == &widget->requisition)
2184 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.");
2185 #endif /* G_ENABLE_DEBUG */
2187 _gtk_size_group_compute_requisition (widget, requisition);
2191 * gtk_widget_get_child_requisition:
2192 * @widget: a #GtkWidget
2193 * @requisition: a #GtkRequisition to be filled in
2195 * This function is only for use in widget implementations. Obtains
2196 * @widget->requisition, unless someone has forced a particular
2197 * geometry on the widget (e.g. with gtk_widget_set_usize()), in which
2198 * case it returns that geometry instead of the widget's requisition.
2200 * This function differs from gtk_widget_size_request() in that
2201 * it retrieves the last size request value from @widget->requisition,
2202 * while gtk_widget_size_request() actually calls the "size_request" method
2203 * on @widget to compute the size request and fill in @widget->requisition,
2204 * and only then returns @widget->requisition.
2206 * Because this function does not call the "size_request" method, it
2207 * can only be used when you know that @widget->requisition is
2208 * up-to-date, that is, gtk_widget_size_request() has been called
2209 * since the last time a resize was queued. In general, only container
2210 * implementations have this information; applications should use
2211 * gtk_widget_size_request().
2214 gtk_widget_get_child_requisition (GtkWidget *widget,
2215 GtkRequisition *requisition)
2217 _gtk_size_group_get_child_requisition (widget, requisition);
2221 invalidate_predicate (GdkWindow *window,
2226 gdk_window_get_user_data (window, &user_data);
2228 return (user_data == data);
2231 /* Invalidate @region in widget->window and all children
2232 * of widget->window owned by widget. @region is in the
2233 * same coordinates as widget->allocation and will be
2234 * modified by this call.
2237 gtk_widget_invalidate_widget_windows (GtkWidget *widget,
2240 if (!GTK_WIDGET_NO_WINDOW (widget))
2244 gdk_window_get_position (widget->window, &x, &y);
2245 gdk_region_offset (region, -x, -y);
2248 gdk_window_invalidate_maybe_recurse (widget->window, region,
2249 invalidate_predicate, widget);
2253 * gtk_widget_size_allocate:
2254 * @widget: a #GtkWidget
2255 * @allocation: position and size to be allocated to @widget
2257 * This function is only used by #GtkContainer subclasses, to assign a size
2258 * and position to their child widgets.
2262 gtk_widget_size_allocate (GtkWidget *widget,
2263 GtkAllocation *allocation)
2265 GtkWidgetAuxInfo *aux_info;
2266 GdkRectangle real_allocation;
2267 GdkRectangle old_allocation;
2268 gboolean alloc_needed;
2269 gboolean size_changed;
2270 gboolean position_changed;
2272 g_return_if_fail (GTK_IS_WIDGET (widget));
2274 alloc_needed = GTK_WIDGET_ALLOC_NEEDED (widget);
2275 GTK_PRIVATE_UNSET_FLAG (widget, GTK_ALLOC_NEEDED);
2277 old_allocation = widget->allocation;
2278 real_allocation = *allocation;
2279 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
2283 if (aux_info->x_set)
2284 real_allocation.x = aux_info->x;
2285 if (aux_info->y_set)
2286 real_allocation.y = aux_info->y;
2289 if (real_allocation.width < 0 || real_allocation.height < 0)
2291 g_warning ("gtk_widget_size_allocate(): attempt to allocate widget with width %d and height %d",
2292 real_allocation.width,
2293 real_allocation.height);
2296 real_allocation.width = MAX (real_allocation.width, 1);
2297 real_allocation.height = MAX (real_allocation.height, 1);
2299 size_changed = (old_allocation.width != real_allocation.width ||
2300 old_allocation.height != real_allocation.height);
2301 position_changed = (old_allocation.x != real_allocation.x ||
2302 old_allocation.y != real_allocation.y);
2304 if (!alloc_needed && !size_changed && !position_changed)
2307 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[SIZE_ALLOCATE], &real_allocation);
2309 if (GTK_WIDGET_MAPPED (widget))
2311 if (GTK_WIDGET_NO_WINDOW (widget) && GTK_WIDGET_REDRAW_ON_ALLOC (widget) && position_changed)
2313 /* Invalidate union(old_allaction,widget->allocation) in widget->window
2315 GdkRegion *invalidate = gdk_region_rectangle (&widget->allocation);
2316 gdk_region_union_with_rect (invalidate, &old_allocation);
2318 gdk_window_invalidate_region (widget->window, invalidate, FALSE);
2319 gdk_region_destroy (invalidate);
2324 if (GTK_WIDGET_REDRAW_ON_ALLOC (widget))
2326 /* Invalidate union(old_allaction,widget->allocation) in widget->window and descendents owned by widget
2328 GdkRegion *invalidate = gdk_region_rectangle (&widget->allocation);
2329 gdk_region_union_with_rect (invalidate, &old_allocation);
2331 gtk_widget_invalidate_widget_windows (widget, invalidate);
2332 gdk_region_destroy (invalidate);
2337 if ((size_changed || position_changed) && widget->parent &&
2338 GTK_WIDGET_REALIZED (widget->parent) && GTK_CONTAINER (widget->parent)->reallocate_redraws)
2340 GdkRegion *invalidate = gdk_region_rectangle (&widget->parent->allocation);
2341 gtk_widget_invalidate_widget_windows (widget->parent, invalidate);
2342 gdk_region_destroy (invalidate);
2347 * gtk_widget_common_ancestor:
2348 * @widget_a: a #GtkWidget
2349 * @widget_b: a #GtkWidget
2351 * Find the common ancestor of @widget_a and @widget_b that
2352 * is closest to the two widgets.
2354 * Return value: the closest common ancestor of @widget_a and
2355 * @widget_b or %NULL if @widget_a and @widget_b do not
2356 * share a common ancestor.
2359 gtk_widget_common_ancestor (GtkWidget *widget_a,
2360 GtkWidget *widget_b)
2362 GtkWidget *parent_a;
2363 GtkWidget *parent_b;
2367 parent_a = widget_a;
2368 while (parent_a->parent)
2370 parent_a = parent_a->parent;
2374 parent_b = widget_b;
2375 while (parent_b->parent)
2377 parent_b = parent_b->parent;
2381 if (parent_a != parent_b)
2384 while (depth_a > depth_b)
2386 widget_a = widget_a->parent;
2390 while (depth_b > depth_a)
2392 widget_b = widget_b->parent;
2396 while (widget_a != widget_b)
2398 widget_a = widget_a->parent;
2399 widget_b = widget_b->parent;
2406 * gtk_widget_translate_coordinates:
2407 * @src_widget: a #GtkWidget
2408 * @dest_widget: a #GtkWidget
2409 * @src_x: X position relative to @src_widget
2410 * @src_y: Y position relative to @src_widget
2411 * @dest_x: location to store X position relative to @dest_widget
2412 * @dest_y: location to store Y position relative to @dest_widget
2414 * Translate coordinates relative to @src_widget's allocation to coordinates
2415 * relative to @dest_widget's allocations. In order to perform this
2416 * operation, both widgets must be realized, and must share a common
2419 * Return value: %FALSE if either widget was not realized, or there
2420 * was no common ancestor. In this case, nothing is stored in
2421 * *@dest_x and *@dest_y. Otherwise %TRUE.
2424 gtk_widget_translate_coordinates (GtkWidget *src_widget,
2425 GtkWidget *dest_widget,
2431 GtkWidget *ancestor;
2434 g_return_val_if_fail (GTK_IS_WIDGET (src_widget), FALSE);
2435 g_return_val_if_fail (GTK_IS_WIDGET (dest_widget), FALSE);
2437 ancestor = gtk_widget_common_ancestor (src_widget, dest_widget);
2438 if (!ancestor || !GTK_WIDGET_REALIZED (src_widget) || !GTK_WIDGET_REALIZED (dest_widget))
2441 /* Translate from allocation relative to window relative */
2442 if (!GTK_WIDGET_NO_WINDOW (src_widget) && src_widget->parent)
2445 gdk_window_get_position (src_widget->window, &wx, &wy);
2447 src_x -= wx - src_widget->allocation.x;
2448 src_y -= wy - src_widget->allocation.y;
2452 src_x += src_widget->allocation.x;
2453 src_y += src_widget->allocation.y;
2456 /* Translate to the common ancestor */
2457 window = src_widget->window;
2458 while (window != ancestor->window)
2462 gdk_window_get_position (window, &dx, &dy);
2467 window = gdk_window_get_parent (window);
2471 window = dest_widget->window;
2472 while (window != ancestor->window)
2476 gdk_window_get_position (window, &dx, &dy);
2481 window = gdk_window_get_parent (window);
2484 /* Translate from window relative to allocation relative */
2485 if (!GTK_WIDGET_NO_WINDOW (dest_widget) && dest_widget->parent)
2488 gdk_window_get_position (dest_widget->window, &wx, &wy);
2490 src_x += wx - dest_widget->allocation.x;
2491 src_y += wy - dest_widget->allocation.y;
2495 src_x -= dest_widget->allocation.x;
2496 src_y -= dest_widget->allocation.y;
2508 gtk_widget_real_size_allocate (GtkWidget *widget,
2509 GtkAllocation *allocation)
2511 g_return_if_fail (GTK_IS_WIDGET (widget));
2513 widget->allocation = *allocation;
2515 if (GTK_WIDGET_REALIZED (widget) &&
2516 !GTK_WIDGET_NO_WINDOW (widget))
2518 gdk_window_move_resize (widget->window,
2519 allocation->x, allocation->y,
2520 allocation->width, allocation->height);
2530 closure_accel_activate (GClosure *closure,
2531 GValue *return_value,
2532 guint n_param_values,
2533 const GValue *param_values,
2534 gpointer invocation_hint,
2535 gpointer marshal_data)
2537 AccelClosure *aclosure = (AccelClosure*) closure;
2539 if (GTK_WIDGET_IS_SENSITIVE (closure->data))
2540 g_signal_emit (closure->data, aclosure->signal_id, 0);
2542 /* we handled the accelerator */
2543 g_value_set_boolean (return_value, TRUE);
2547 closures_destroy (gpointer data)
2549 GSList *slist, *closures = data;
2551 for (slist = closures; slist; slist = slist->next)
2553 g_closure_invalidate (slist->data);
2554 g_closure_unref (slist->data);
2556 g_slist_free (closures);
2560 widget_new_accel_closure (GtkWidget *widget,
2563 AccelClosure *aclosure;
2564 GClosure *closure = NULL;
2565 GSList *slist, *closures;
2567 closures = g_object_steal_qdata (G_OBJECT (widget), quark_accel_closures);
2568 for (slist = closures; slist; slist = slist->next)
2569 if (!gtk_accel_group_from_accel_closure (slist->data))
2571 /* reuse this closure */
2572 closure = slist->data;
2577 closure = g_closure_new_object (sizeof (AccelClosure), G_OBJECT (widget));
2578 closures = g_slist_prepend (closures, g_closure_ref (closure));
2579 g_closure_sink (closure);
2580 g_closure_set_marshal (closure, closure_accel_activate);
2582 g_object_set_qdata_full (G_OBJECT (widget), quark_accel_closures, closures, closures_destroy);
2584 aclosure = (AccelClosure*) closure;
2585 g_assert (closure->data == widget);
2586 g_assert (closure->marshal == closure_accel_activate);
2587 aclosure->signal_id = signal_id;
2593 * gtk_widget_add_accelerator
2594 * @widget: widget to install an accelerator on
2595 * @accel_signal: widget signal to emit on accelerator actiavtion
2596 * @accel_group: accel group for this widget, added to its toplevel
2597 * @accel_key: GDK keyval of the accelerator
2598 * @accel_mods: modifier key combination of the accelerator
2599 * @accel_flags: flag accelerators, e.g. %GTK_ACCEL_VISIBLE
2601 * Installs an accelerator for this @widget in @accel_group, that causes
2602 * @accel_signal to be emitted if the accelerator is activated.
2603 * The @accel_group needs to be added to the widget's toplevel via
2604 * gtk_window_add_accel_group(), and the signal must be of type %G_RUN_ACTION.
2605 * Accelerators added through this function are not user changable during
2606 * runtime. If you want to support accelerators that can be changed by the
2607 * user, use gtk_accel_map_add_entry() and gtk_menu_item_set_accel_path()
2611 gtk_widget_add_accelerator (GtkWidget *widget,
2612 const gchar *accel_signal,
2613 GtkAccelGroup *accel_group,
2616 GtkAccelFlags accel_flags)
2621 g_return_if_fail (GTK_IS_WIDGET (widget));
2622 g_return_if_fail (accel_signal != NULL);
2623 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
2625 g_signal_query (g_signal_lookup (accel_signal, G_OBJECT_TYPE (widget)), &query);
2626 if (!query.signal_id ||
2627 !(query.signal_flags & G_SIGNAL_ACTION) ||
2628 query.return_type != G_TYPE_NONE ||
2631 /* hmm, should be elaborate enough */
2632 g_warning (G_STRLOC ": widget `%s' has no activatable signal \"%s\" without arguments",
2633 G_OBJECT_TYPE_NAME (widget), accel_signal);
2637 closure = widget_new_accel_closure (widget, query.signal_id);
2639 g_object_ref (widget);
2641 /* install the accelerator. since we don't map this onto an accel_path,
2642 * the accelerator will automatically be locked.
2644 gtk_accel_group_connect (accel_group,
2647 accel_flags | GTK_ACCEL_LOCKED,
2650 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
2652 g_object_unref (widget);
2656 * gtk_widget_remove_accelerator:
2657 * @widget: widget to install an accelerator on
2658 * @accel_group: accel group for this widget
2659 * @accel_key: GDK keyval of the accelerator
2660 * @accel_mods: modifier key combination of the accelerator
2661 * @returns: whether an accelerator was installed and could be removed
2663 * Removes an accelerator from @widget, previously installed with
2664 * gtk_widget_add_accelerator().
2667 gtk_widget_remove_accelerator (GtkWidget *widget,
2668 GtkAccelGroup *accel_group,
2672 GtkAccelGroupEntry *ag_entry;
2673 GList *slist, *clist;
2676 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
2677 g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE);
2679 ag_entry = gtk_accel_group_query (accel_group, accel_key, accel_mods, &n);
2680 clist = gtk_widget_list_accel_closures (widget);
2681 for (slist = clist; slist; slist = slist->next)
2685 for (i = 0; i < n; i++)
2686 if (slist->data == (gpointer) ag_entry[i].closure)
2688 gboolean is_removed = gtk_accel_group_disconnect (accel_group, slist->data);
2690 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
2692 g_list_free (clist);
2697 g_list_free (clist);
2699 g_warning (G_STRLOC ": no accelerator (%u,%u) installed in accel group (%p) for %s (%p)",
2700 accel_key, accel_mods, accel_group,
2701 G_OBJECT_TYPE_NAME (widget), widget);
2707 * gtk_widget_list_accel_closures
2708 * @widget: widget to list accelerator closures for
2709 * @returns: a newly allocated #GList of closures
2711 * Lists the closures used by @widget for accelerator group connections
2712 * with gtk_accel_group_connect_by_path() or gtk_accel_group_connect().
2713 * The closures can be used to monitor accelerator changes on @widget,
2714 * by connecting to the ::accel_changed signal of the #GtkAccelGroup of a
2715 * closure which can be found out with gtk_accel_group_from_accel_closure().
2718 gtk_widget_list_accel_closures (GtkWidget *widget)
2721 GList *clist = NULL;
2723 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
2725 for (slist = g_object_get_qdata (G_OBJECT (widget), quark_accel_closures); slist; slist = slist->next)
2726 if (gtk_accel_group_from_accel_closure (slist->data))
2727 clist = g_list_prepend (clist, slist->data);
2734 GtkAccelGroup *accel_group;
2739 destroy_accel_path (gpointer data)
2741 AccelPath *apath = data;
2743 gtk_accel_group_disconnect (apath->accel_group, apath->closure);
2745 /* closures_destroy takes care of unrefing the closure */
2746 g_object_unref (apath->accel_group);
2751 /* accel_group: the accel group used to activate this widget
2752 * accel_path: the accel path, associating the accelerator
2753 * to activate this widget
2754 * set accel path through which this widget can be actiavated.
2757 _gtk_widget_set_accel_path (GtkWidget *widget,
2758 const gchar *accel_path,
2759 GtkAccelGroup *accel_group)
2763 g_return_if_fail (GTK_IS_WIDGET (widget));
2764 g_return_if_fail (GTK_WIDGET_GET_CLASS (widget)->activate_signal != 0);
2768 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
2769 g_return_if_fail (_gtk_accel_path_is_valid (accel_path));
2771 gtk_accel_map_add_entry (accel_path, 0, 0);
2772 apath = g_new (AccelPath, 1);
2773 apath->widget = widget;
2774 apath->accel_group = g_object_ref (accel_group);
2775 apath->path_quark = g_quark_from_string (accel_path);
2776 apath->closure = widget_new_accel_closure (apath->widget, GTK_WIDGET_GET_CLASS (apath->widget)->activate_signal);
2781 /* also removes possible old settings */
2782 g_object_set_qdata_full (G_OBJECT (widget), quark_accel_path, apath, destroy_accel_path);
2785 gtk_accel_group_connect_by_path (apath->accel_group, g_quark_to_string (apath->path_quark), apath->closure);
2787 g_signal_emit (widget, widget_signals[ACCEL_CLOSURES_CHANGED], 0);
2791 _gtk_widget_get_accel_path (GtkWidget *widget)
2795 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
2797 apath = g_object_get_qdata (G_OBJECT (widget), quark_accel_path);
2798 return apath ? g_quark_to_string (apath->path_quark) : NULL;
2802 gtk_widget_mnemonic_activate (GtkWidget *widget,
2803 gboolean group_cycling)
2807 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
2809 group_cycling = group_cycling != FALSE;
2810 if (!GTK_WIDGET_IS_SENSITIVE (widget))
2813 gtk_signal_emit (GTK_OBJECT (widget),
2814 widget_signals[MNEMONIC_ACTIVATE],
2821 gtk_widget_real_mnemonic_activate (GtkWidget *widget,
2822 gboolean group_cycling)
2824 if (!group_cycling && GTK_WIDGET_GET_CLASS (widget)->activate_signal)
2825 gtk_widget_activate (widget);
2826 else if (GTK_WIDGET_CAN_FOCUS (widget))
2827 gtk_widget_grab_focus (widget);
2830 g_warning ("widget `%s' isn't suitable for mnemonic activation",
2831 G_OBJECT_TYPE_NAME (widget));
2838 gtk_widget_real_key_press_event (GtkWidget *widget,
2841 gboolean handled = FALSE;
2843 g_return_val_if_fail (GTK_IS_WIDGET (widget), handled);
2844 g_return_val_if_fail (event != NULL, handled);
2847 handled = gtk_bindings_activate (GTK_OBJECT (widget),
2855 gtk_widget_real_key_release_event (GtkWidget *widget,
2858 gboolean handled = FALSE;
2860 g_return_val_if_fail (GTK_IS_WIDGET (widget), handled);
2861 g_return_val_if_fail (event != NULL, handled);
2864 handled = gtk_bindings_activate (GTK_OBJECT (widget),
2866 event->state | GDK_RELEASE_MASK);
2872 gtk_widget_real_focus_in_event (GtkWidget *widget,
2873 GdkEventFocus *event)
2875 GTK_WIDGET_SET_FLAGS (widget, GTK_HAS_FOCUS);
2876 gtk_widget_queue_draw (widget);
2882 gtk_widget_real_focus_out_event (GtkWidget *widget,
2883 GdkEventFocus *event)
2885 GTK_WIDGET_UNSET_FLAGS (widget, GTK_HAS_FOCUS);
2886 gtk_widget_queue_draw (widget);
2893 * @widget: a #GtkWidget
2894 * @event: a #GdkEvent
2896 * Rarely-used function. This function is used to emit
2897 * the event signals on a widget (those signals should never
2898 * be emitted without using this function to do so).
2899 * If you want to synthesize an event though, don't use this function;
2900 * instead, use gtk_main_do_event() so the event will behave as if
2901 * it were in the event queue. Don't synthesize expose events; instead,
2902 * use gdk_window_invalidate_rect() to invalidate a region of the
2905 * Return value: return from the event signal emission (%TRUE if the event was handled)
2908 gtk_widget_event (GtkWidget *widget,
2911 g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
2912 g_return_val_if_fail (GTK_WIDGET_REALIZED (widget), TRUE);
2914 if (event->type == GDK_EXPOSE)
2916 g_warning ("Events of type GDK_EXPOSE cannot be synthesized. To get "
2917 "the same effect, call gdk_window_invalidate_rect/region(), "
2918 "followed by gdk_window_process_updates().");
2922 return gtk_widget_event_internal (widget, event);
2927 * gtk_widget_send_expose:
2928 * @widget: a #GtkWidget
2929 * @event: a expose #GdkEvent
2931 * Very rarely-used function. This function is used to emit
2932 * an expose event signals on a widget. This function is not
2933 * normally used directly. The only time it is used is when
2934 * propagating an expose event to a child %NO_WINDOW widget, and
2935 * that is normally done using gtk_container_propagate_expose().
2937 * If you want to force an area of a window to be redrawn,
2938 * use gdk_window_invalidate_rect() or gdk_window_invalidate_region().
2939 * To cause the redraw to be done immediately, follow that call
2940 * with a call to gdk_window_process_updates().
2942 * Return value: return from the event signal emission (%TRUE if the event was handled)
2945 gtk_widget_send_expose (GtkWidget *widget,
2948 g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
2949 g_return_val_if_fail (GTK_WIDGET_REALIZED (widget), TRUE);
2950 g_return_val_if_fail (event != NULL, TRUE);
2951 g_return_val_if_fail (event->type == GDK_EXPOSE, TRUE);
2953 if (event->type != GDK_EXPOSE)
2956 return gtk_widget_event_internal (widget, event);
2960 gtk_widget_event_internal (GtkWidget *widget,
2963 gboolean return_val = FALSE;
2965 gtk_widget_ref (widget);
2967 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[EVENT], event, &return_val);
2968 return_val |= !GTK_WIDGET_REALIZED (widget);
2973 switch (event->type)
2978 case GDK_BUTTON_PRESS:
2979 case GDK_2BUTTON_PRESS:
2980 case GDK_3BUTTON_PRESS:
2981 signal_num = BUTTON_PRESS_EVENT;
2984 signal_num = SCROLL_EVENT;
2986 case GDK_BUTTON_RELEASE:
2987 signal_num = BUTTON_RELEASE_EVENT;
2989 case GDK_MOTION_NOTIFY:
2990 signal_num = MOTION_NOTIFY_EVENT;
2993 signal_num = DELETE_EVENT;
2996 signal_num = DESTROY_EVENT;
2999 signal_num = KEY_PRESS_EVENT;
3001 case GDK_KEY_RELEASE:
3002 signal_num = KEY_RELEASE_EVENT;
3004 case GDK_ENTER_NOTIFY:
3005 signal_num = ENTER_NOTIFY_EVENT;
3007 case GDK_LEAVE_NOTIFY:
3008 signal_num = LEAVE_NOTIFY_EVENT;
3010 case GDK_FOCUS_CHANGE:
3011 signal_num = event->focus_change.in ? FOCUS_IN_EVENT : FOCUS_OUT_EVENT;
3014 signal_num = CONFIGURE_EVENT;
3017 signal_num = MAP_EVENT;
3020 signal_num = UNMAP_EVENT;
3022 case GDK_WINDOW_STATE:
3023 signal_num = WINDOW_STATE_EVENT;
3025 case GDK_PROPERTY_NOTIFY:
3026 signal_num = PROPERTY_NOTIFY_EVENT;
3028 case GDK_SELECTION_CLEAR:
3029 signal_num = SELECTION_CLEAR_EVENT;
3031 case GDK_SELECTION_REQUEST:
3032 signal_num = SELECTION_REQUEST_EVENT;
3034 case GDK_SELECTION_NOTIFY:
3035 signal_num = SELECTION_NOTIFY_EVENT;
3037 case GDK_PROXIMITY_IN:
3038 signal_num = PROXIMITY_IN_EVENT;
3040 case GDK_PROXIMITY_OUT:
3041 signal_num = PROXIMITY_OUT_EVENT;
3044 signal_num = NO_EXPOSE_EVENT;
3046 case GDK_CLIENT_EVENT:
3047 signal_num = CLIENT_EVENT;
3050 signal_num = EXPOSE_EVENT;
3052 case GDK_VISIBILITY_NOTIFY:
3053 signal_num = VISIBILITY_NOTIFY_EVENT;
3056 g_warning ("gtk_widget_event(): unhandled event type: %d", event->type);
3060 if (signal_num != -1)
3061 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[signal_num], event, &return_val);
3063 if (GTK_WIDGET_REALIZED (widget))
3064 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[EVENT_AFTER], event);
3068 gtk_widget_unref (widget);
3074 * gtk_widget_activate:
3075 * @widget: a #GtkWidget that's activatable
3077 * For widgets that can be "activated" (buttons, menu items, etc.)
3078 * this function activates them. Activation is what happens when you
3079 * press Enter on a widget during key navigation; clicking a button,
3080 * selecting a menu item, etc. If @widget isn't activatable,
3081 * the function returns %FALSE.
3083 * Return value: %TRUE if the widget was activatable
3086 gtk_widget_activate (GtkWidget *widget)
3088 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
3090 if (WIDGET_CLASS (widget)->activate_signal)
3092 /* FIXME: we should eventually check the signals signature here */
3093 gtk_signal_emit (GTK_OBJECT (widget), WIDGET_CLASS (widget)->activate_signal);
3102 * gtk_widget_set_scroll_adjustments:
3103 * @widget: a #GtkWidget
3104 * @hadjustment: an adjustment for horizontal scrolling, or %NULL
3105 * @vadjustment: an adjustment for vertical scrolling, or %NULL
3107 * For widgets that support scrolling, sets the scroll adjustments and
3108 * returns %TRUE. For widgets that don't support scrolling, does
3109 * nothing and returns %FALSE. Widgets that don't support scrolling
3110 * can be scrolled by placing them in a #GtkViewport, which does
3111 * support scrolling.
3113 * Return value: %TRUE if the widget supports scrolling
3116 gtk_widget_set_scroll_adjustments (GtkWidget *widget,
3117 GtkAdjustment *hadjustment,
3118 GtkAdjustment *vadjustment)
3120 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
3122 g_return_val_if_fail (GTK_IS_ADJUSTMENT (hadjustment), FALSE);
3124 g_return_val_if_fail (GTK_IS_ADJUSTMENT (vadjustment), FALSE);
3126 if (WIDGET_CLASS (widget)->set_scroll_adjustments_signal)
3128 /* FIXME: we should eventually check the signals signature here */
3129 gtk_signal_emit (GTK_OBJECT (widget),
3130 WIDGET_CLASS (widget)->set_scroll_adjustments_signal,
3131 hadjustment, vadjustment);
3138 /*****************************************
3139 * gtk_widget_reparent_container_child:
3140 * assistent function to gtk_widget_reparent
3145 *****************************************/
3148 gtk_widget_reparent_container_child (GtkWidget *widget,
3149 gpointer client_data)
3151 g_return_if_fail (GTK_IS_WIDGET (widget));
3152 g_return_if_fail (client_data != NULL);
3154 if (GTK_WIDGET_NO_WINDOW (widget))
3157 gdk_window_unref (widget->window);
3158 widget->window = (GdkWindow*) client_data;
3160 gdk_window_ref (widget->window);
3162 if (GTK_IS_CONTAINER (widget))
3163 gtk_container_forall (GTK_CONTAINER (widget),
3164 gtk_widget_reparent_container_child,
3168 gdk_window_reparent (widget->window,
3169 (GdkWindow*) client_data, 0, 0);
3173 * gtk_widget_reparent:
3174 * @widget: a #GtkWidget
3175 * @new_parent: a #GtkContainer to move the widget into
3177 * Moves a widget from one #GtkContainer to another, handling reference
3178 * count issues to avoid destroying the widget.
3182 gtk_widget_reparent (GtkWidget *widget,
3183 GtkWidget *new_parent)
3185 g_return_if_fail (GTK_IS_WIDGET (widget));
3186 g_return_if_fail (GTK_IS_CONTAINER (new_parent));
3187 g_return_if_fail (widget->parent != NULL);
3189 if (widget->parent != new_parent)
3191 /* First try to see if we can get away without unrealizing
3192 * the widget as we reparent it. if so we set a flag so
3193 * that gtk_widget_unparent doesn't unrealize widget
3195 if (GTK_WIDGET_REALIZED (widget) && GTK_WIDGET_REALIZED (new_parent))
3196 GTK_PRIVATE_SET_FLAG (widget, GTK_IN_REPARENT);
3198 gtk_widget_ref (widget);
3199 gtk_container_remove (GTK_CONTAINER (widget->parent), widget);
3200 gtk_container_add (GTK_CONTAINER (new_parent), widget);
3201 gtk_widget_unref (widget);
3203 if (GTK_WIDGET_IN_REPARENT (widget))
3205 GTK_PRIVATE_UNSET_FLAG (widget, GTK_IN_REPARENT);
3207 gtk_widget_reparent_container_child (widget,
3208 gtk_widget_get_parent_window (widget));
3214 * gtk_widget_intersect:
3215 * @widget: a #GtkWidget
3216 * @area: a rectangle
3217 * @intersection: rectangle to store intersection of @widget and @area
3219 * Computes the intersection of a @widget's area and @area, storing
3220 * the intersection in @intersection, and returns %TRUE if there was
3221 * an intersection. @intersection may be %NULL if you're only
3222 * interested in whether there was an intersection.
3224 * Return value: %TRUE if there was an intersection
3227 gtk_widget_intersect (GtkWidget *widget,
3229 GdkRectangle *intersection)
3235 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
3236 g_return_val_if_fail (area != NULL, FALSE);
3239 dest = intersection;
3243 return_val = gdk_rectangle_intersect (&widget->allocation, area, dest);
3245 if (return_val && intersection && !GTK_WIDGET_NO_WINDOW (widget))
3247 intersection->x -= widget->allocation.x;
3248 intersection->y -= widget->allocation.y;
3255 * gtk_widget_region_intersect:
3256 * @widget: a #GtkWidget
3257 * @region: a #GdkRegion, in the same coordinate system as
3258 * @widget->allocation. That is, relative to @widget->window
3259 * for %NO_WINDOW widgets; relative to the parent window
3260 * of @widget->window for widgets with their own window.
3261 * @returns: A newly allocated region holding the intersection of @widget
3262 * and @region. The coordinates of the return value are
3263 * relative to @widget->window for %NO_WINDOW widgets, and
3264 * relative to the parent window of @widget->window for
3265 * widgets with their own window.
3267 * Computes the intersection of a @widget's area and @region, returning
3268 * the intersection. The result may be empty, use gdk_region_empty() to
3272 gtk_widget_region_intersect (GtkWidget *widget,
3277 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
3278 g_return_val_if_fail (region != NULL, NULL);
3280 dest = gdk_region_rectangle (&widget->allocation);
3282 gdk_region_intersect (dest, region);
3288 * gtk_widget_grab_focus:
3289 * @widget: a #GtkWidget
3291 * Causes @widget to have the keyboard focus for the #GtkWindow it's
3292 * inside. @widget must be a focusable widget, such as a #GtkEntry;
3293 * something like #GtkFrame won't work. (More precisely, it must have the
3294 * %GTK_CAN_FOCUS flag set.)
3298 gtk_widget_grab_focus (GtkWidget *widget)
3300 g_return_if_fail (GTK_IS_WIDGET (widget));
3302 g_object_ref (G_OBJECT (widget));
3303 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[GRAB_FOCUS]);
3304 g_object_notify (G_OBJECT (widget), "has_focus");
3305 g_object_unref (G_OBJECT (widget));
3309 reset_focus_recurse (GtkWidget *widget,
3312 if (GTK_IS_CONTAINER (widget))
3314 GtkContainer *container;
3316 container = GTK_CONTAINER (widget);
3317 gtk_container_set_focus_child (container, NULL);
3319 gtk_container_foreach (container,
3320 reset_focus_recurse,
3326 gtk_widget_real_grab_focus (GtkWidget *focus_widget)
3328 g_return_if_fail (GTK_IS_WIDGET (focus_widget));
3330 if (GTK_WIDGET_CAN_FOCUS (focus_widget))
3332 GtkWidget *toplevel;
3335 /* clear the current focus setting, break if the current widget
3336 * is the focus widget's parent, since containers above that will
3337 * be set by the next loop.
3339 toplevel = gtk_widget_get_toplevel (focus_widget);
3340 if (GTK_WIDGET_TOPLEVEL (toplevel))
3342 widget = GTK_WINDOW (toplevel)->focus_widget;
3344 if (widget == focus_widget)
3346 /* We call _gtk_window_internal_set_focus() here so that the
3347 * toplevel window can request the focus if necessary.
3348 * This is needed when the toplevel is a GtkPlug
3350 if (!GTK_WIDGET_HAS_FOCUS (widget))
3351 _gtk_window_internal_set_focus (GTK_WINDOW (toplevel), focus_widget);
3358 while (widget->parent && widget->parent != focus_widget->parent)
3360 widget = widget->parent;
3361 gtk_container_set_focus_child (GTK_CONTAINER (widget), NULL);
3365 else if (toplevel != focus_widget)
3367 /* gtk_widget_grab_focus() operates on a tree without window...
3368 * actually, this is very questionable behaviour.
3371 gtk_container_foreach (GTK_CONTAINER (toplevel),
3372 reset_focus_recurse,
3376 /* now propagate the new focus up the widget tree and finally
3377 * set it on the window
3379 widget = focus_widget;
3380 while (widget->parent)
3382 gtk_container_set_focus_child (GTK_CONTAINER (widget->parent), widget);
3383 widget = widget->parent;
3385 if (GTK_IS_WINDOW (widget))
3386 _gtk_window_internal_set_focus (GTK_WINDOW (widget), focus_widget);
3391 gtk_widget_real_show_help (GtkWidget *widget,
3392 GtkWidgetHelpType help_type)
3394 if (help_type == GTK_WIDGET_HELP_TOOLTIP)
3395 _gtk_tooltips_show_tip (widget);
3399 gtk_widget_real_focus (GtkWidget *widget,
3400 GtkDirectionType direction)
3402 if (!GTK_WIDGET_CAN_FOCUS (widget))
3405 if (!gtk_widget_is_focus (widget))
3407 gtk_widget_grab_focus (widget);
3415 * gtk_widget_is_focus:
3416 * @widget: a #GtkWidget
3418 * Determines if the widget is the focus widget within its
3419 * toplevel. (This does not mean that the %HAS_FOCUS flag is
3420 * necessarily set; %HAS_FOCUS will only be set if the
3421 * toplevel widget additionally has the global input focus.)
3423 * Return value: %TRUE if the widget is the focus widget.
3426 gtk_widget_is_focus (GtkWidget *widget)
3428 GtkWidget *toplevel;
3430 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
3432 toplevel = gtk_widget_get_toplevel (widget);
3434 if (GTK_IS_WINDOW (toplevel))
3435 return widget == GTK_WINDOW (toplevel)->focus_widget;
3441 * gtk_widget_grab_default:
3442 * @widget: a #GtkWidget
3444 * Causes @widget to become the default widget. @widget must have the
3445 * %GTK_CAN_DEFAULT flag set; typically you have to set this flag
3446 * yourself by calling <literal>GTK_WIDGET_SET_FLAGS (@widget,
3447 * GTK_CAN_DEFAULT)</literal>. The default widget is activated when the user
3448 * presses Enter in a window. Default widgets must be activatable,
3449 * that is, gtk_widget_activate() should affect them.
3453 gtk_widget_grab_default (GtkWidget *widget)
3457 g_return_if_fail (GTK_IS_WIDGET (widget));
3458 g_return_if_fail (GTK_WIDGET_CAN_DEFAULT (widget));
3460 window = gtk_widget_get_toplevel (widget);
3462 if (window && GTK_WIDGET_TOPLEVEL (window))
3463 gtk_window_set_default (GTK_WINDOW (window), widget);
3465 g_warning (G_STRLOC ": widget not within a GtkWindow");
3469 * gtk_widget_set_name:
3470 * @widget: a #GtkWidget
3471 * @name: name for the widget
3473 * Widgets can be named, which allows you to refer to them from a
3474 * gtkrc file. You can apply a style to widgets with a particular name
3475 * in the gtkrc file. See the documentation for gtkrc files (on the
3476 * same page as the docs for #GtkRcStyle).
3480 gtk_widget_set_name (GtkWidget *widget,
3483 g_return_if_fail (GTK_IS_WIDGET (widget));
3486 g_free (widget->name);
3487 widget->name = g_strdup (name);
3489 if (GTK_WIDGET_RC_STYLE (widget))
3490 gtk_widget_reset_rc_style (widget);
3492 g_object_notify (G_OBJECT (widget), "name");
3496 * gtk_widget_get_name:
3497 * @widget: a #GtkWidget
3499 * Retrieves the name of a widget. The return value should not be
3500 * freed. See gtk_widget_set_name() for the significance of widget
3503 * Return value: name of the widget
3505 G_CONST_RETURN gchar*
3506 gtk_widget_get_name (GtkWidget *widget)
3508 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
3511 return widget->name;
3512 return gtk_type_name (GTK_WIDGET_TYPE (widget));
3516 * gtk_widget_set_state:
3517 * @widget: a #GtkWidget
3518 * @state: new state for @widget
3520 * This function is for use in widget implementations. Sets the state
3521 * of a widget (insensitive, prelighted, etc.) Usually you should set
3522 * the state using wrapper functions such as gtk_widget_set_sensitive().
3526 gtk_widget_set_state (GtkWidget *widget,
3529 g_return_if_fail (GTK_IS_WIDGET (widget));
3531 if (state == GTK_WIDGET_STATE (widget))
3534 if (state == GTK_STATE_INSENSITIVE)
3535 gtk_widget_set_sensitive (widget, FALSE);
3541 data.state_restoration = FALSE;
3542 data.use_forall = FALSE;
3544 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget->parent) != FALSE);
3546 data.parent_sensitive = TRUE;
3548 gtk_widget_propagate_state (widget, &data);
3550 if (GTK_WIDGET_DRAWABLE (widget))
3551 gtk_widget_queue_clear (widget);
3556 gtk_widget_set_app_paintable (GtkWidget *widget,
3557 gboolean app_paintable)
3559 g_return_if_fail (GTK_IS_WIDGET (widget));
3561 app_paintable = (app_paintable != FALSE);
3563 if (GTK_WIDGET_APP_PAINTABLE (widget) != app_paintable)
3566 GTK_WIDGET_SET_FLAGS (widget, GTK_APP_PAINTABLE);
3568 GTK_WIDGET_UNSET_FLAGS (widget, GTK_APP_PAINTABLE);
3570 if (GTK_WIDGET_DRAWABLE (widget))
3571 gtk_widget_queue_clear (widget);
3573 g_object_notify (G_OBJECT (widget), "app_paintable");
3578 * gtk_widget_set_double_buffered:
3579 * @widget: a #GtkWidget
3580 * @double_buffered: %TRUE to double-buffer a widget
3582 * Widgets are double buffered by default; you can use this function
3583 * to turn off the buffering. "Double buffered" simply means that
3584 * gdk_window_begin_paint_region() and gdk_window_end_paint() are called
3585 * automatically around expose events sent to the
3586 * widget. gdk_window_begin_paint() diverts all drawing to a widget's
3587 * window to an offscreen buffer, and gdk_window_end_paint() draws the
3588 * buffer to the screen. The result is that users see the window
3589 * update in one smooth step, and don't see individual graphics
3590 * primitives being rendered.
3592 * In very simple terms, double buffered widgets don't flicker,
3593 * so you would only use this function to turn off double buffering
3594 * if you had special needs and really knew what you were doing.
3598 gtk_widget_set_double_buffered (GtkWidget *widget,
3599 gboolean double_buffered)
3601 g_return_if_fail (GTK_IS_WIDGET (widget));
3603 if (double_buffered)
3604 GTK_WIDGET_SET_FLAGS (widget, GTK_DOUBLE_BUFFERED);
3606 GTK_WIDGET_UNSET_FLAGS (widget, GTK_DOUBLE_BUFFERED);
3610 * gtk_widget_set_redraw_on_allocate:
3611 * @widget: a #GtkWidget
3612 * @redraw_on_allocate: if %TRUE, the entire widget will be redrawn
3613 * when it is allocated to a new size. Otherwise, only the
3614 * new portion of the widget will be redrawn.
3616 * Sets whether a when a widgets size allocation changes, the entire
3617 * widget is queued for drawing. By default, this setting is %TRUE and
3618 * the entire widget is redrawn on every size change. If your widget
3619 * leaves the upper left are unchanged when made bigger, turning this
3620 * setting on will improve performance.
3622 * Note that for %NO_WINDOW widgets setting this flag to %FALSE turns
3623 * off all allocation on resizing: the widget will not even redraw if
3624 * its position changes; this is to allow containers that don't draw
3625 * anything to avoid excess invalidations. If you set this flag on a
3626 * %NO_WINDOW widget that <emphasis>does</emphasis> draw on @widget->window,
3627 * you are responsible for invalidating both the old and new allocation
3628 * of the widget when the widget is moved and responsible for invalidating
3629 * regions newly when the widget increases size.
3632 gtk_widget_set_redraw_on_allocate (GtkWidget *widget,
3633 gboolean redraw_on_allocate)
3635 g_return_if_fail (GTK_IS_WIDGET (widget));
3637 if (redraw_on_allocate)
3638 GTK_PRIVATE_SET_FLAG (widget, GTK_REDRAW_ON_ALLOC);
3640 GTK_PRIVATE_UNSET_FLAG (widget, GTK_REDRAW_ON_ALLOC);
3644 * gtk_widget_set_sensitive:
3645 * @widget: a @widget
3646 * @sensitive: %TRUE to make the widget sensitive
3648 * Sets the sensitivity of a widget. A widget is sensitive if the user
3649 * can interact with it. Insensitive widgets are "grayed out" and the
3650 * user can't interact with them. Insensitive widgets are known as
3651 * "inactive" in some other toolkits.
3655 gtk_widget_set_sensitive (GtkWidget *widget,
3660 g_return_if_fail (GTK_IS_WIDGET (widget));
3662 sensitive = (sensitive != FALSE);
3664 if (sensitive == (GTK_WIDGET_SENSITIVE (widget) != FALSE))
3669 GTK_WIDGET_SET_FLAGS (widget, GTK_SENSITIVE);
3670 data.state = GTK_WIDGET_SAVED_STATE (widget);
3674 GTK_WIDGET_UNSET_FLAGS (widget, GTK_SENSITIVE);
3675 data.state = GTK_WIDGET_STATE (widget);
3677 data.state_restoration = TRUE;
3678 data.use_forall = TRUE;
3681 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget->parent) != FALSE);
3683 data.parent_sensitive = TRUE;
3685 gtk_widget_propagate_state (widget, &data);
3686 if (GTK_WIDGET_DRAWABLE (widget))
3687 gtk_widget_queue_clear (widget);
3689 g_object_notify (G_OBJECT (widget), "sensitive");
3693 * gtk_widget_set_parent:
3694 * @widget: a #GtkWidget
3695 * @parent: parent container
3697 * This function is useful only when implementing subclasses of #GtkContainer.
3698 * Sets the container as the parent of @widget, and takes care of
3699 * some details such as updating the state and style of the child
3700 * to reflect its new location. The opposite function is
3701 * gtk_widget_unparent().
3705 gtk_widget_set_parent (GtkWidget *widget,
3710 g_return_if_fail (GTK_IS_WIDGET (widget));
3711 g_return_if_fail (widget->parent == NULL);
3712 g_return_if_fail (!GTK_WIDGET_TOPLEVEL (widget));
3713 g_return_if_fail (GTK_IS_WIDGET (parent));
3714 g_return_if_fail (widget != parent);
3716 /* keep this function in sync with gtk_menu_attach_to_widget()
3719 gtk_widget_ref (widget);
3720 gtk_object_sink (GTK_OBJECT (widget));
3721 widget->parent = parent;
3723 if (GTK_WIDGET_STATE (parent) != GTK_STATE_NORMAL)
3724 data.state = GTK_WIDGET_STATE (parent);
3726 data.state = GTK_WIDGET_STATE (widget);
3727 data.state_restoration = FALSE;
3728 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (parent) != FALSE);
3729 data.use_forall = GTK_WIDGET_IS_SENSITIVE (parent) != GTK_WIDGET_IS_SENSITIVE (widget);
3731 gtk_widget_propagate_state (widget, &data);
3733 gtk_widget_set_style_recurse (widget, NULL);
3735 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[PARENT_SET], NULL);
3736 if (GTK_WIDGET_ANCHORED (widget->parent))
3737 _gtk_widget_propagate_hierarchy_changed (widget, NULL);
3738 g_object_notify (G_OBJECT (widget), "parent");
3740 /* Enforce realized/mapped invariants
3742 if (GTK_WIDGET_REALIZED (widget->parent))
3743 gtk_widget_realize (widget);
3745 if (GTK_WIDGET_VISIBLE (widget->parent) &&
3746 GTK_WIDGET_VISIBLE (widget))
3748 if (GTK_WIDGET_CHILD_VISIBLE (widget) &&
3749 GTK_WIDGET_MAPPED (widget->parent))
3750 gtk_widget_map (widget);
3752 gtk_widget_queue_resize (widget);
3757 * gtk_widget_get_parent:
3758 * @widget: a #GtkWidget
3760 * Returns the parent container of @widget.
3762 * Return value: the parent container of @widget, or %NULL
3765 gtk_widget_get_parent (GtkWidget *widget)
3767 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
3769 return widget->parent;
3772 /*****************************************
3774 * see docs/styles.txt
3775 *****************************************/
3778 * gtk_widget_set_style:
3779 * @widget: a #GtkWidget
3780 * @style: a #GtkStyle, or %NULL to remove the effect of a previous
3781 * gtk_widget_set_style() and go back to the default style
3783 * Sets the #GtkStyle for a widget (@widget->style). You probably don't
3784 * want to use this function; it interacts badly with themes, because
3785 * themes work by replacing the #GtkStyle. Instead, use
3786 * gtk_widget_modify_style().
3790 gtk_widget_set_style (GtkWidget *widget,
3793 g_return_if_fail (GTK_IS_WIDGET (widget));
3797 gboolean initial_emission;
3799 initial_emission = !GTK_WIDGET_RC_STYLE (widget) && !GTK_WIDGET_USER_STYLE (widget);
3801 GTK_WIDGET_UNSET_FLAGS (widget, GTK_RC_STYLE);
3802 GTK_PRIVATE_SET_FLAG (widget, GTK_USER_STYLE);
3804 gtk_widget_set_style_internal (widget, style, initial_emission);
3808 if (GTK_WIDGET_USER_STYLE (widget))
3809 gtk_widget_reset_rc_style (widget);
3814 * gtk_widget_ensure_style:
3815 * @widget: a #GtkWidget
3817 * Ensures that @widget has a style (@widget->style). Not a very useful
3818 * function; most of the time, if you want the style, the widget is
3819 * realized, and realized widgets are guaranteed to have a style
3824 gtk_widget_ensure_style (GtkWidget *widget)
3826 g_return_if_fail (GTK_IS_WIDGET (widget));
3828 if (!GTK_WIDGET_USER_STYLE (widget) &&
3829 !GTK_WIDGET_RC_STYLE (widget))
3830 gtk_widget_reset_rc_style (widget);
3833 /* Look up the RC style for this widget, unsetting any user style that
3834 * may be in effect currently
3837 gtk_widget_reset_rc_style (GtkWidget *widget)
3839 GtkStyle *new_style;
3840 gboolean initial_emission;
3842 g_return_if_fail (GTK_IS_WIDGET (widget));
3844 initial_emission = !GTK_WIDGET_RC_STYLE (widget) && !GTK_WIDGET_USER_STYLE (widget);
3846 GTK_PRIVATE_UNSET_FLAG (widget, GTK_USER_STYLE);
3847 GTK_WIDGET_SET_FLAGS (widget, GTK_RC_STYLE);
3849 new_style = gtk_rc_get_style (widget);
3851 new_style = gtk_widget_get_default_style ();
3853 if (initial_emission || new_style != widget->style)
3854 gtk_widget_set_style_internal (widget, new_style, initial_emission);
3858 * gtk_widget_get_style:
3859 * @widget: a #GtkWidget
3861 * Simply an accessor function that returns @widget->style.
3863 * Return value: the widget's #GtkStyle
3866 gtk_widget_get_style (GtkWidget *widget)
3868 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
3870 return widget->style;
3874 * gtk_widget_modify_style:
3875 * @widget: a #GtkWidget
3876 * @style: the #GtkRcStyle holding the style modifications
3878 * Modifies style values on the widget. Modifications made using this
3879 * technique take precedence over style values set via an RC file,
3880 * however, they will be overriden if a style is explicitely set on
3881 * the widget using gtk_widget_set_style(). The #GtkRcStyle structure
3882 * is designed so each field can either be set or unset, so it is
3883 * possible, using this function, to modify some style values and
3884 * leave the others unchanged.
3886 * Note that modifications made with this function are not cumulative
3887 * with previous calls to gtk_widget_modify_style() or with such
3888 * functions as gtk_widget_modify_fg(). If you wish to retain
3889 * previous values, you must first call gtk_widget_get_modifier_style(),
3890 * make your modifications to the returned style, then call
3891 * gtk_widget_modify_style() with that style. On the other hand,
3892 * if you first call gtk_widget_modify_style(), subsequent calls
3893 * to such functions gtk_widget_modify_fg() will have a cumulative
3894 * effect with the initial modifications.
3897 gtk_widget_modify_style (GtkWidget *widget,
3900 GtkRcStyle *old_style;
3902 g_return_if_fail (GTK_IS_RC_STYLE (style));
3904 old_style = gtk_object_get_data_by_id (GTK_OBJECT (widget),
3907 gtk_object_set_data_by_id_full (GTK_OBJECT (widget),
3909 gtk_rc_style_copy (style),
3910 (GtkDestroyNotify)gtk_rc_style_unref);
3912 /* note that "style" may be invalid here if it was the old
3913 * modifier style and the only reference was our own.
3916 if (GTK_WIDGET_RC_STYLE (widget))
3917 gtk_widget_reset_rc_style (widget);
3921 * gtk_widget_get_modifier_style:
3922 * @widget: a #GtkWidget
3924 * Returns the current modifier style for the widget. (As set by
3925 * gtk_widget_modify_style().) If no style has previously set, a new
3926 * #GtkRcStyle will be created with all values unset, and set as the
3927 * modifier style for the widget. If you make changes to this rc
3928 * style, you must call gtk_widget_modify_style(), passing in the
3929 * returned rc style, to make sure that your changes take effect.
3931 * Caution: passing the style back to gtk_widget_modify_style() will
3932 * normally end up destroying it, because gtk_widget_modify_style() copies
3933 * the passed-in style and sets the copy as the new modifier style,
3934 * thus dropping any reference to the old modifier style. Add a reference
3935 * to the modifier style if you want to keep it alive.
3937 * Return value: the modifier style for the widget. This rc style is
3938 * owned by the widget. If you want to keep a pointer to value this
3939 * around, you must add a refcount using gtk_rc_style_ref().
3942 gtk_widget_get_modifier_style (GtkWidget *widget)
3944 GtkRcStyle *rc_style;
3946 rc_style = gtk_object_get_data_by_id (GTK_OBJECT (widget),
3951 rc_style = gtk_rc_style_new ();
3952 gtk_object_set_data_by_id_full (GTK_OBJECT (widget),
3955 (GtkDestroyNotify)gtk_rc_style_unref);
3962 gtk_widget_modify_color_component (GtkWidget *widget,
3963 GtkRcFlags component,
3967 GtkRcStyle *rc_style = gtk_widget_get_modifier_style (widget);
3972 rc_style->fg[state] = *color;
3975 rc_style->bg[state] = *color;
3978 rc_style->text[state] = *color;
3981 rc_style->base[state] = *color;
3984 g_assert_not_reached();
3987 rc_style->color_flags[state] |= component;
3989 gtk_widget_modify_style (widget, rc_style);
3993 * gtk_widget_modify_fg:
3994 * @widget: a #GtkWidget.
3995 * @state: the state for which to set the foreground color.
3996 * @color: the color to assign (does not need to be allocated).
3998 * Sets the foreground color for a widget in a particular state. All
3999 * other style values are left untouched. See also
4000 * gtk_widget_modify_style().
4003 gtk_widget_modify_fg (GtkWidget *widget,
4007 g_return_if_fail (GTK_IS_WIDGET (widget));
4008 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
4009 g_return_if_fail (color != NULL);
4011 gtk_widget_modify_color_component (widget, GTK_RC_FG, state, color);
4015 * gtk_widget_modify_bg:
4016 * @widget: a #GtkWidget.
4017 * @state: the state for which to set the background color.
4018 * @color: the color to assign (does not need to be allocated).
4020 * Sets the background color for a widget in a particular state. All
4021 * other style values are left untouched. See also
4022 * gtk_widget_modify_style().
4025 gtk_widget_modify_bg (GtkWidget *widget,
4029 g_return_if_fail (GTK_IS_WIDGET (widget));
4030 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
4031 g_return_if_fail (color != NULL);
4033 gtk_widget_modify_color_component (widget, GTK_RC_BG, state, color);
4037 * gtk_widget_modify_text:
4038 * @widget: a #GtkWidget.
4039 * @state: the state for which to set the text color.
4040 * @color: the color to assign (does not need to be allocated).
4042 * Sets the text color for a widget in a particular state. All other
4043 * style values are left untouched. The text color is the foreground
4044 * color used along with the base color (see gtk_widget_modify_base())
4045 * for widgets such as #GtkEntry and #GtkTextView. See also
4046 * gtk_widget_modify_style().
4049 gtk_widget_modify_text (GtkWidget *widget,
4053 g_return_if_fail (GTK_IS_WIDGET (widget));
4054 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
4055 g_return_if_fail (color != NULL);
4057 gtk_widget_modify_color_component (widget, GTK_RC_TEXT, state, color);
4061 * gtk_widget_modify_base:
4062 * @widget: a #GtkWidget.
4063 * @state: the state for which to set the base color.
4064 * @color: the color to assign (does not need to be allocated).
4066 * Sets the base color for a widget in a particular state.
4067 * All other style values are left untouched. The base color
4068 * is the background color used along with the text color
4069 * (see gtk_widget_modify_text()) for widgets such as #GtkEntry
4070 * and #GtkTextView. See also gtk_widget_modify_style().
4073 gtk_widget_modify_base (GtkWidget *widget,
4077 g_return_if_fail (GTK_IS_WIDGET (widget));
4078 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
4079 g_return_if_fail (color != NULL);
4081 gtk_widget_modify_color_component (widget, GTK_RC_BASE, state, color);
4085 * gtk_widget_modify_font:
4086 * @widget: a #GtkWidget
4087 * @font_desc: the font description to use
4089 * Sets the font to use for a widget. All other style values are left
4090 * untouched. See also gtk_widget_modify_style().
4093 gtk_widget_modify_font (GtkWidget *widget,
4094 PangoFontDescription *font_desc)
4096 GtkRcStyle *rc_style;
4098 g_return_if_fail (GTK_IS_WIDGET (widget));
4099 g_return_if_fail (font_desc != NULL);
4101 rc_style = gtk_widget_get_modifier_style (widget);
4103 if (rc_style->font_desc)
4104 pango_font_description_free (rc_style->font_desc);
4106 rc_style->font_desc = pango_font_description_copy (font_desc);
4108 gtk_widget_modify_style (widget, rc_style);
4112 gtk_widget_direction_changed (GtkWidget *widget,
4113 GtkTextDirection previous_direction)
4115 gtk_widget_queue_resize (widget);
4119 gtk_widget_style_set (GtkWidget *widget,
4120 GtkStyle *previous_style)
4122 if (GTK_WIDGET_REALIZED (widget) &&
4123 !GTK_WIDGET_NO_WINDOW (widget))
4124 gtk_style_set_background (widget->style, widget->window, widget->state);
4128 gtk_widget_set_style_internal (GtkWidget *widget,
4130 gboolean initial_emission)
4132 g_return_if_fail (GTK_IS_WIDGET (widget));
4133 g_return_if_fail (style != NULL);
4135 g_object_ref (G_OBJECT (widget));
4136 g_object_freeze_notify (G_OBJECT (widget));
4138 if (widget->style != style || initial_emission)
4140 PangoContext *context = gtk_widget_peek_pango_context (widget);
4142 pango_context_set_font_description (context, style->font_desc);
4145 if (widget->style != style)
4147 GtkStyle *previous_style;
4149 if (GTK_WIDGET_REALIZED (widget))
4151 gtk_widget_reset_shapes (widget);
4152 gtk_style_detach (widget->style);
4155 previous_style = widget->style;
4156 widget->style = style;
4157 g_object_ref (widget->style);
4159 if (GTK_WIDGET_REALIZED (widget))
4160 widget->style = gtk_style_attach (widget->style, widget->window);
4162 gtk_signal_emit (GTK_OBJECT (widget),
4163 widget_signals[STYLE_SET],
4164 initial_emission ? NULL : previous_style);
4165 g_object_unref (previous_style);
4167 if (widget->parent && !initial_emission)
4168 gtk_widget_queue_resize (widget);
4170 else if (initial_emission)
4171 gtk_signal_emit (GTK_OBJECT (widget),
4172 widget_signals[STYLE_SET],
4174 g_object_notify (G_OBJECT (widget), "style");
4175 g_object_thaw_notify (G_OBJECT (widget));
4176 g_object_unref (G_OBJECT (widget));
4180 gtk_widget_set_style_recurse (GtkWidget *widget,
4181 gpointer client_data)
4183 if (GTK_WIDGET_RC_STYLE (widget))
4184 gtk_widget_reset_rc_style (widget);
4186 if (GTK_IS_CONTAINER (widget))
4187 gtk_container_forall (GTK_CONTAINER (widget),
4188 gtk_widget_set_style_recurse,
4193 gtk_widget_propagate_hierarchy_changed_recurse (GtkWidget *widget,
4194 gpointer client_data)
4196 gboolean new_anchored;
4198 new_anchored = GTK_WIDGET_TOPLEVEL (widget) ||
4199 (widget->parent && GTK_WIDGET_ANCHORED (widget->parent));
4201 if (GTK_WIDGET_ANCHORED (widget) != new_anchored)
4203 gtk_widget_ref (widget);
4206 GTK_PRIVATE_SET_FLAG (widget, GTK_ANCHORED);
4208 GTK_PRIVATE_UNSET_FLAG (widget, GTK_ANCHORED);
4210 g_signal_emit (GTK_OBJECT (widget), widget_signals[HIERARCHY_CHANGED],
4213 if (GTK_IS_CONTAINER (widget))
4214 gtk_container_forall (GTK_CONTAINER (widget),
4215 gtk_widget_propagate_hierarchy_changed_recurse,
4218 gtk_widget_unref (widget);
4223 * _gtk_widget_propagate_hierarchy_changed:
4224 * @widget: a #GtkWidget
4225 * @previous_toplevel: Previous toplevel
4227 * Propagates changes in the anchored state to a widget and all
4228 * children, unsetting or setting the %ANCHORED flag, and
4229 * emitting ::hierarchy_changed.
4232 _gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
4233 GtkWidget *previous_toplevel)
4235 if (previous_toplevel)
4236 g_object_ref (previous_toplevel);
4238 gtk_widget_propagate_hierarchy_changed_recurse (widget, previous_toplevel);
4240 if (previous_toplevel)
4241 g_object_unref (previous_toplevel);
4245 gtk_widget_reset_rc_styles (GtkWidget *widget)
4247 g_return_if_fail (GTK_IS_WIDGET (widget));
4249 gtk_widget_set_style_recurse (widget, NULL);
4253 gtk_widget_get_default_style (void)
4255 if (!gtk_default_style)
4257 gtk_default_style = gtk_style_new ();
4258 g_object_ref (gtk_default_style);
4261 return gtk_default_style;
4264 static PangoContext *
4265 gtk_widget_peek_pango_context (GtkWidget *widget)
4267 return gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_pango_context);
4271 * gtk_widget_get_pango_context:
4272 * @widget: a #GtkWidget
4274 * Gets a #PangoContext with the appropriate colormap, font description
4275 * and base direction for this widget. Unlike the context returned
4276 * by gtk_widget_create_pango_context(), this context is owned by
4277 * the widget (it can be used as long as widget exists), and will
4278 * be updated to match any changes to the widget's attributes.
4280 * If you create and keep a #PangoLayout using this context, you must
4281 * deal with changes to the context by calling pango_layout_context_changed()
4282 * on the layout in response to the ::style_set and ::direction_set signals
4285 * Return value: the #PangoContext for the widget.
4288 gtk_widget_get_pango_context (GtkWidget *widget)
4290 PangoContext *context;
4292 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4294 context = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_pango_context);
4297 context = gtk_widget_create_pango_context (GTK_WIDGET (widget));
4298 gtk_object_set_data_by_id_full (GTK_OBJECT (widget), quark_pango_context, context,
4299 (GDestroyNotify) g_object_unref);
4306 * gtk_widget_create_pango_context:
4307 * @widget: a #GtkWidget
4309 * Creates a new #PangoContext with the appropriate colormap,
4310 * font description, and base direction for drawing text for
4311 * this widget. See also gtk_widget_get_pango_context().
4313 * Return value: the new #PangoContext
4316 gtk_widget_create_pango_context (GtkWidget *widget)
4318 PangoContext *context;
4320 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4322 context = gdk_pango_context_get ();
4324 gdk_pango_context_set_colormap (context, gtk_widget_get_colormap (widget));
4325 pango_context_set_base_dir (context,
4326 gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR ?
4327 PANGO_DIRECTION_LTR : PANGO_DIRECTION_RTL);
4328 pango_context_set_font_description (context, widget->style->font_desc);
4329 pango_context_set_language (context, gtk_get_default_language ());
4335 * gtk_widget_create_pango_layout:
4336 * @widget: a #GtkWidget
4337 * @text: text to set on the layout (can be %NULL)
4339 * Creates a new #PangoLayout with the appropriate colormap,
4340 * font description, and base direction for drawing text for
4343 * If you keep a #PangoLayout created in this way around, in order
4344 * notify the layout of changes to the base direction or font of this
4345 * widget, you must call pango_layout_context_changed() in response to
4346 * the ::style_set and ::direction_set signals for the widget.
4348 * Return value: the new #PangoLayout
4351 gtk_widget_create_pango_layout (GtkWidget *widget,
4354 PangoLayout *layout;
4355 PangoContext *context;
4357 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4359 context = gtk_widget_get_pango_context (widget);
4360 layout = pango_layout_new (context);
4363 pango_layout_set_text (layout, text, -1);
4369 * gtk_widget_render_icon:
4370 * @widget: a #GtkWidget
4371 * @stock_id: a stock ID
4372 * @size: a stock size
4373 * @detail: render detail to pass to theme engine
4375 * A convenience function that uses the theme engine and RC file
4376 * settings for @widget to look up @stock_id and render it to
4377 * a pixbuf. @stock_id should be a stock icon ID such as
4378 * #GTK_STOCK_OPEN or #GTK_STOCK_OK. @size should be a size
4379 * such as #GTK_ICON_SIZE_MENU. @detail should be a string that
4380 * identifies the widget or code doing the rendering, so that
4381 * theme engines can special-case rendering for that widget or code.
4383 * Return value: a new pixbuf, or %NULL if the stock ID wasn't known
4386 gtk_widget_render_icon (GtkWidget *widget,
4387 const gchar *stock_id,
4389 const gchar *detail)
4391 GtkIconSet *icon_set;
4394 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4395 g_return_val_if_fail (stock_id != NULL, NULL);
4396 g_return_val_if_fail (size > GTK_ICON_SIZE_INVALID, NULL);
4398 gtk_widget_ensure_style (widget);
4400 icon_set = gtk_style_lookup_icon_set (widget->style, stock_id);
4402 if (icon_set == NULL)
4405 retval = gtk_icon_set_render_icon (icon_set,
4407 gtk_widget_get_direction (widget),
4408 GTK_WIDGET_STATE (widget),
4417 * gtk_widget_set_parent_window:
4418 * @widget: a #GtkWidget.
4419 * @parent_window: the new parent window.
4421 * Sets a non default parent window for @widget.
4424 gtk_widget_set_parent_window (GtkWidget *widget,
4425 GdkWindow *parent_window)
4427 GdkWindow *old_parent_window;
4429 g_return_if_fail (GTK_IS_WIDGET (widget));
4431 old_parent_window = gtk_object_get_data_by_id (GTK_OBJECT (widget),
4432 quark_parent_window);
4434 if (parent_window != old_parent_window)
4436 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_parent_window,
4438 if (old_parent_window)
4439 gdk_window_unref (old_parent_window);
4441 gdk_window_ref (parent_window);
4447 * gtk_widget_set_child_visible:
4448 * @widget: a #GtkWidget
4449 * @is_visible: if %TRUE, @widget should be mapped along with its parent.
4451 * Sets whether @widget should be mapped along with its when its parent
4452 * is mapped and @widget has been shown with gtk_widget_show().
4454 * The child visibility can be set for widget before it is added to
4455 * a container with gtk_widget_set_parent(), to avoid mapping
4456 * children unnecessary before immediately unmapping them. However
4457 * it will be reset to its default state of %TRUE when the widget
4458 * is removed from a container.
4460 * Note that changing the child visibility of a widget does not
4461 * queue a resize on the widget. Most of the time, the size of
4462 * a widget is computed from all visible children, whether or
4463 * not they are mapped. If this is not the case, the container
4464 * can queue a resize itself.
4466 * This function is only useful for container implementations and
4467 * never should be called by an application.
4470 gtk_widget_set_child_visible (GtkWidget *widget,
4471 gboolean is_visible)
4473 g_return_if_fail (GTK_IS_WIDGET (widget));
4474 g_return_if_fail (!GTK_WIDGET_TOPLEVEL (widget));
4477 GTK_PRIVATE_SET_FLAG (widget, GTK_CHILD_VISIBLE);
4479 GTK_PRIVATE_UNSET_FLAG (widget, GTK_CHILD_VISIBLE);
4480 if (GTK_WIDGET_REALIZED (widget->parent))
4482 if (GTK_WIDGET_MAPPED (widget->parent) &&
4483 GTK_WIDGET_CHILD_VISIBLE (widget) &&
4484 GTK_WIDGET_VISIBLE (widget))
4485 gtk_widget_map (widget);
4487 gtk_widget_unmap (widget);
4492 * gtk_widget_get_child_visible:
4493 * @widget: a #GtkWidget
4495 * Gets the value set with gtk_widget_set_child_visible().
4496 * If you feel a need to use this function, your code probably
4497 * needs reorganization.
4499 * This function is only useful for container implementations and
4500 * never should be called by an application.
4502 * Return value: %TRUE if the widget is mapped with the parent.
4505 gtk_widget_get_child_visible (GtkWidget *widget)
4507 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4509 return GTK_WIDGET_CHILD_VISIBLE (widget);
4513 * gtk_widget_get_parent_window:
4514 * @widget: a #GtkWidget.
4515 * @returns: the parent window of @widget.
4517 * Gets @widget's parent window.
4520 gtk_widget_get_parent_window (GtkWidget *widget)
4522 GdkWindow *parent_window;
4524 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4525 g_return_val_if_fail (widget->parent != NULL, NULL);
4527 parent_window = gtk_object_get_data_by_id (GTK_OBJECT (widget),
4528 quark_parent_window);
4530 return (parent_window != NULL) ? parent_window : widget->parent->window;
4534 * gtk_widget_child_focus:
4535 * @widget: a #GtkWidget
4536 * @direction: direction of focus movement
4538 * This function is used by custom widget implementations; if you're
4539 * writing an app, you'd use gtk_widget_grab_focus() to move the focus
4540 * to a particular widget, and gtk_container_set_focus_chain() to
4541 * change the focus tab order. So you may want to investigate those
4542 * functions instead.
4544 * gtk_widget_child_focus() is called by containers as the user moves
4545 * around the window using keyboard shortcuts. @direction indicates
4546 * what kind of motion is taking place (up, down, left, right, tab
4547 * forward, tab backward). gtk_widget_child_focus() invokes the
4548 * "focus" signal on #GtkWidget; widgets override the default handler
4549 * for this signal in order to implement appropriate focus behavior.
4551 * The "focus" default handler for a widget should return %TRUE if
4552 * moving in @direction left the focus on a focusable location inside
4553 * that widget, and %FALSE if moving in @direction moved the focus
4554 * outside the widget. If returning %TRUE, widgets normally
4555 * call gtk_widget_grab_focus() to place the focus accordingly;
4556 * if returning %FALSE, they don't modify the current focus location.
4558 * This function replaces gtk_container_focus() from GTK+ 1.2. It was
4559 * necessary to check that the child was visible, sensitive, and
4560 * focusable before calling
4561 * gtk_container_focus(). gtk_widget_child_focus() returns %FALSE if
4562 * the widget is not currently in a focusable state, so there's no
4563 * need for those checks.
4565 * Return value: %TRUE if focus ended up inside @widget
4568 gtk_widget_child_focus (GtkWidget *widget,
4569 GtkDirectionType direction)
4571 gboolean return_val;
4573 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4575 if (!GTK_WIDGET_VISIBLE (widget) ||
4576 !GTK_WIDGET_IS_SENSITIVE (widget))
4579 /* child widgets must set CAN_FOCUS, containers
4580 * don't have to though.
4582 if (!GTK_IS_CONTAINER (widget) &&
4583 !GTK_WIDGET_CAN_FOCUS (widget))
4586 gtk_signal_emit (GTK_OBJECT (widget),
4587 widget_signals[FOCUS],
4588 direction, &return_val);
4594 * gtk_widget_set_uposition:
4595 * @widget: a #GtkWidget
4596 * @x: x position; -1 to unset x; -2 to leave x unchanged
4597 * @y: y position; -1 to unset y; -2 to leave y unchanged
4600 * Sets the position of a widget. The funny "u" in the name comes from
4601 * the "user position" hint specified by the X Window System, and
4602 * exists for legacy reasons. This function doesn't work if a widget
4603 * is inside a container; it's only really useful on #GtkWindow.
4605 * Don't use this function to center dialogs over the main application
4606 * window; most window managers will do the centering on your behalf
4607 * if you call gtk_window_set_transient_for(), and it's really not
4608 * possible to get the centering to work correctly in all cases from
4609 * application code. But if you insist, use gtk_window_set_position()
4610 * to set #GTK_WIN_POS_CENTER_ON_PARENT, don't do the centering
4613 * Note that although @x and @y can be individually unset, the position
4614 * is not honoured unless both @x and @y are set.
4617 gtk_widget_set_uposition (GtkWidget *widget,
4621 /* FIXME this function is the only place that aux_info->x and
4622 * aux_info->y are even used I believe, and this function is
4623 * deprecated. Should be cleaned up.
4626 GtkWidgetAuxInfo *aux_info;
4628 g_return_if_fail (GTK_IS_WIDGET (widget));
4630 aux_info =_gtk_widget_get_aux_info (widget, TRUE);
4635 aux_info->x_set = FALSE;
4638 aux_info->x_set = TRUE;
4646 aux_info->y_set = FALSE;
4649 aux_info->y_set = TRUE;
4654 if (GTK_IS_WINDOW (widget) && aux_info->x_set && aux_info->y_set)
4655 _gtk_window_reposition (GTK_WINDOW (widget), aux_info->x, aux_info->y);
4657 if (GTK_WIDGET_VISIBLE (widget) && widget->parent)
4658 gtk_widget_size_allocate (widget, &widget->allocation);
4662 * gtk_widget_set_usize:
4663 * @widget: a #GtkWidget
4664 * @width: minimum width, or -1 to unset
4665 * @height: minimum height, or -1 to unset
4667 * This function is deprecated; use gtk_widget_set_size_request()
4670 * Sets the minimum size of a widget; that is, the widget's size
4671 * request will be @width by @height. You can use this function to
4672 * force a widget to be either larger or smaller than it is. The
4673 * strange "usize" name dates from the early days of GTK+, and derives
4674 * from X Window System terminology. In many cases,
4675 * gtk_window_set_default_size() is a better choice for toplevel
4676 * windows than this function; setting the default size will still
4677 * allow users to shrink the window. Setting the usize will force them
4678 * to leave the window at least as large as the usize. When dealing
4679 * with window sizes, gtk_window_set_geometry_hints() can be a useful
4682 * Note the inherent danger of setting any fixed size - themes,
4683 * translations into other languages, different fonts, and user action
4684 * can all change the appropriate size for a given widget. So, it's
4685 * basically impossible to hardcode a size that will always be
4690 gtk_widget_set_usize (GtkWidget *widget,
4694 GtkWidgetAuxInfo *aux_info;
4696 g_return_if_fail (GTK_IS_WIDGET (widget));
4698 g_object_freeze_notify (G_OBJECT (widget));
4700 aux_info =_gtk_widget_get_aux_info (widget, TRUE);
4704 g_object_notify (G_OBJECT (widget), "width_request");
4705 aux_info->width = width;
4709 g_object_notify (G_OBJECT (widget), "height_request");
4710 aux_info->height = height;
4713 if (GTK_WIDGET_VISIBLE (widget))
4714 gtk_widget_queue_resize (widget);
4716 g_object_thaw_notify (G_OBJECT (widget));
4720 * gtk_widget_set_size_request:
4721 * @widget: a #GtkWidget
4722 * @width: width @widget should request, or -1 to unset
4723 * @height: height @widget should request, or -1 to unset
4725 * Sets the minimum size of a widget; that is, the widget's size
4726 * request will be @width by @height. You can use this function to
4727 * force a widget to be either larger or smaller than it normally
4730 * In most cases, gtk_window_set_default_size() is a better choice for
4731 * toplevel windows than this function; setting the default size will
4732 * still allow users to shrink the window. Setting the size request
4733 * will force them to leave the window at least as large as the size
4734 * request. When dealing with window sizes,
4735 * gtk_window_set_geometry_hints() can be a useful function as well.
4737 * Note the inherent danger of setting any fixed size - themes,
4738 * translations into other languages, different fonts, and user action
4739 * can all change the appropriate size for a given widget. So, it's
4740 * basically impossible to hardcode a size that will always be
4743 * The size request of a widget is the smallest size a widget can
4744 * accept while still functioning well and drawing itself correctly.
4745 * However in some strange cases a widget may be allocated less than
4746 * its requested size, and in many cases a widget may be allocated more
4747 * space than it requested.
4749 * If the size request in a given direction is -1 (unset), then
4750 * the "natural" size request of the widget will be used instead.
4752 * Widgets can't actually be allocated a size less than 1 by 1, but
4753 * you can pass 0,0 to this function to mean "as small as possible."
4756 gtk_widget_set_size_request (GtkWidget *widget,
4760 g_return_if_fail (GTK_IS_WIDGET (widget));
4761 g_return_if_fail (width >= -1);
4762 g_return_if_fail (height >= -1);
4769 gtk_widget_set_usize (widget, width, height);
4774 * gtk_widget_get_size_request:
4775 * @widget: a #GtkWidget
4776 * @width: return location for width, or %NULL
4777 * @height: return location for height, or %NULL
4779 * Gets the size request that was explicitly set for the widget using
4780 * gtk_widget_set_size_request(). A value of -1 stored in @width or
4781 * @height indicates that that dimension has not been set explicitly
4782 * and the natural requisition of the widget will be used intead. See
4783 * gtk_widget_set_size_request(). To get the size a widget will
4784 * actually use, call gtk_widget_size_request() instead of
4790 gtk_widget_get_size_request (GtkWidget *widget,
4794 GtkWidgetAuxInfo *aux_info;
4796 g_return_if_fail (GTK_IS_WIDGET (widget));
4798 aux_info = _gtk_widget_get_aux_info (widget, FALSE);
4801 *width = aux_info ? aux_info->width : -1;
4804 *height = aux_info ? aux_info->height : -1;
4808 * gtk_widget_set_events:
4809 * @widget: a #GtkWidget
4810 * @events: event mask
4812 * Sets the event mask (see #GdkEventMask) for a widget. The event
4813 * mask determines which events a widget will receive. Keep in mind
4814 * that different widgets have different default event masks, and by
4815 * changing the event mask you may disrupt a widget's functionality,
4816 * so be careful. This function must be called while a widget is
4817 * unrealized. Consider gtk_widget_add_events() for widgets that are
4818 * already realized, or if you want to preserve the existing event
4819 * mask. This function can't be used with #GTK_NO_WINDOW widgets;
4820 * to get events on those widgets, place them inside a #GtkEventBox
4821 * and receive events on the event box.
4825 gtk_widget_set_events (GtkWidget *widget,
4830 g_return_if_fail (GTK_IS_WIDGET (widget));
4831 g_return_if_fail (!GTK_WIDGET_REALIZED (widget));
4833 eventp = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_event_mask);
4838 eventp = g_new (gint, 1);
4841 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_event_mask, eventp);
4846 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_event_mask);
4849 g_object_notify (G_OBJECT (widget), "events");
4853 * gtk_widget_add_events:
4854 * @widget: a #GtkWidget
4855 * @events: an event mask, see #GdkEventMask
4857 * Adds the events in the bitfield @events to the event mask for
4858 * @widget. See gtk_widget_set_events() for details.
4862 gtk_widget_add_events (GtkWidget *widget,
4867 g_return_if_fail (GTK_IS_WIDGET (widget));
4869 eventp = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_event_mask);
4875 eventp = g_new (gint, 1);
4880 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_event_mask, eventp);
4885 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_event_mask);
4888 if (GTK_WIDGET_REALIZED (widget))
4890 if (GTK_WIDGET_NO_WINDOW (widget))
4892 GList *children = gdk_window_get_children (widget->window);
4893 GList *tmp_list = children;
4897 GdkWindow *window = tmp_list->data;
4900 gdk_window_get_user_data (window, &user_data);
4901 if (user_data == widget)
4902 gdk_window_set_events (window, gdk_window_get_events (window) | events);
4907 gdk_window_set_events (widget->window, gdk_window_get_events (widget->window) | events);
4911 g_object_notify (G_OBJECT (widget), "events");
4915 * gtk_widget_set_extension_events:
4916 * @widget: a #GtkWidget
4917 * @mode: bitfield of extension events to receive
4919 * Sets the extension events mask to @mode. See #GdkExtensionMode
4920 * and gdk_input_set_extension_events().
4924 gtk_widget_set_extension_events (GtkWidget *widget,
4925 GdkExtensionMode mode)
4927 GdkExtensionMode *modep;
4929 g_return_if_fail (GTK_IS_WIDGET (widget));
4931 modep = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_extension_event_mode);
4934 modep = g_new (GdkExtensionMode, 1);
4937 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_extension_event_mode, modep);
4938 g_object_notify (G_OBJECT (widget), "extension_events");
4942 * gtk_widget_get_toplevel:
4943 * @widget: a #GtkWidget
4945 * This function returns the topmost widget in the container hierarchy
4946 * @widget is a part of. If @widget has no parent widgets, it will be
4947 * returned as the topmost widget. No reference will be added to the
4948 * returned widget; it should not be unreferenced.
4950 * Note the difference in behavior vs. gtk_widget_get_ancestor();
4951 * <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW)</literal>
4953 * %NULL if @widget wasn't inside a toplevel window, and if the
4954 * window was inside a #GtkWindow-derived widget which was in turn
4955 * inside the toplevel #GtkWindow. While the second case may
4956 * seem unlikely, it actually happens when a #GtkPlug is embedded
4957 * inside a #GtkSocket within the same application.
4959 * To reliably find the toplevel #GtkWindow, use
4960 * gtk_widget_get_toplevel() and check if the %TOPLEVEL flags
4961 * is set on the result.
4962 * <informalexample><programlisting>
4963 * GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
4964 * if (GTK_WIDGET_TOPLEVEL (toplevel))
4966 * [ Perform action on toplevel. ]
4968 * </programlisting></informalexample>
4970 * Return value: the topmost ancestor of @widget, or @widget itself if there's no ancestor.
4973 gtk_widget_get_toplevel (GtkWidget *widget)
4975 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4977 while (widget->parent)
4978 widget = widget->parent;
4984 * gtk_widget_get_ancestor:
4985 * @widget: a #GtkWidget
4986 * @widget_type: ancestor type
4988 * Gets the first ancestor of @widget with type @widget_type. For example,
4989 * <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)</literal> gets the
4990 * first #GtkBox that's
4991 * an ancestor of @widget. No reference will be added to the returned widget;
4992 * it should not be unreferenced. See note about checking for a toplevel
4993 * #GtkWindow in the docs for gtk_widget_get_toplevel().
4995 * Return value: the ancestor widget, or %NULL if not found
4998 gtk_widget_get_ancestor (GtkWidget *widget,
4999 GtkType widget_type)
5001 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5003 while (widget && !gtk_type_is_a (GTK_WIDGET_TYPE (widget), widget_type))
5004 widget = widget->parent;
5006 if (!(widget && gtk_type_is_a (GTK_WIDGET_TYPE (widget), widget_type)))
5013 * gtk_widget_get_colormap:
5014 * @widget: a #GtkWidget
5016 * Gets the colormap that will be used to render @widget. No reference will
5017 * be added to the returned colormap; it should not be unreferenced.
5019 * Return value: the colormap used by @widget
5022 gtk_widget_get_colormap (GtkWidget *widget)
5024 GdkColormap *colormap;
5026 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5030 colormap = gdk_window_get_colormap (widget->window);
5031 /* If window was destroyed previously, we'll get NULL here */
5038 colormap = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_colormap);
5042 widget = widget->parent;
5045 return gtk_widget_get_default_colormap ();
5049 * gtk_widget_get_visual:
5050 * @widget: a #GtkWidget
5052 * Gets the visual that will be used to render @widget.
5054 * Return value: the visual for @widget
5057 gtk_widget_get_visual (GtkWidget *widget)
5059 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5061 return gdk_colormap_get_visual (gtk_widget_get_colormap (widget));
5065 * gtk_widget_get_settings:
5066 * @widget: a #GtkWidget
5068 * Gets the settings object holding the settings (global property
5069 * settings, RC file information, etc) used for this widget.
5071 * Return value: the relevant #GtkSettings object
5074 gtk_widget_get_settings (GtkWidget *widget)
5076 return gtk_settings_get_default ();
5080 * gtk_widget_set_colormap:
5081 * @widget: a #GtkWidget
5082 * @colormap: a colormap
5084 * Sets the colormap for the widget to the given value. Widget must not
5085 * have been previously realized. This probably should only be used
5086 * from an <function>init()</function> function (i.e. from the constructor
5091 gtk_widget_set_colormap (GtkWidget *widget,
5092 GdkColormap *colormap)
5094 g_return_if_fail (GTK_IS_WIDGET (widget));
5095 g_return_if_fail (!GTK_WIDGET_REALIZED (widget));
5096 g_return_if_fail (GDK_IS_COLORMAP (colormap));
5098 g_object_ref (G_OBJECT (colormap));
5100 g_object_set_qdata_full (G_OBJECT (widget),
5103 (GtkDestroyNotify) g_object_unref);
5107 * gtk_widget_get_events:
5108 * @widget: a #GtkWidget
5110 * Returns the event mask for the widget (a bitfield containing flags
5111 * from the #GdkEventMask enumeration). These are the events that the widget
5114 * Return value: event mask for @widget
5117 gtk_widget_get_events (GtkWidget *widget)
5121 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
5123 events = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_event_mask);
5131 * gtk_widget_get_extension_events:
5132 * @widget: a #GtkWidget
5134 * Retrieves the extension events the widget will receive; see
5135 * gdk_input_set_extension_events().
5137 * Return value: extension events for @widget
5140 gtk_widget_get_extension_events (GtkWidget *widget)
5142 GdkExtensionMode *mode;
5144 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
5146 mode = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_extension_event_mode);
5154 * gtk_widget_get_pointer:
5155 * @widget: a #GtkWidget
5156 * @x: return location for the X coordinate, or %NULL
5157 * @y: return location for the Y coordinate, or %NULL
5159 * Obtains the location of the mouse pointer in widget coordinates.
5160 * Widget coordinates are a bit odd; for historical reasons, they are
5161 * defined as @widget->window coordinates for widgets that are not
5162 * #GTK_NO_WINDOW widgets, and are relative to @widget->allocation.x,
5163 * @widget->allocation.y for widgets that are #GTK_NO_WINDOW widgets.
5167 gtk_widget_get_pointer (GtkWidget *widget,
5171 g_return_if_fail (GTK_IS_WIDGET (widget));
5178 if (GTK_WIDGET_REALIZED (widget))
5180 gdk_window_get_pointer (widget->window, x, y, NULL);
5182 if (GTK_WIDGET_NO_WINDOW (widget))
5185 *x -= widget->allocation.x;
5187 *y -= widget->allocation.y;
5193 * gtk_widget_is_ancestor:
5194 * @widget: a #GtkWidget
5195 * @ancestor: another #GtkWidget
5197 * Determines whether @widget is somewhere inside @ancestor, possibly with
5198 * intermediate containers.
5200 * Return value: %TRUE if @ancestor contains @widget as a child, grandchild, great grandchild, etc.
5203 gtk_widget_is_ancestor (GtkWidget *widget,
5204 GtkWidget *ancestor)
5206 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
5207 g_return_val_if_fail (ancestor != NULL, FALSE);
5211 if (widget->parent == ancestor)
5213 widget = widget->parent;
5219 static GQuark quark_composite_name = 0;
5222 * gtk_widget_set_composite_name:
5223 * @widget: a #GtkWidget.
5224 * @name: the name to set.
5226 * Sets a widgets composite name. The widget must be
5227 * a composite child of its parent; see gtk_widget_push_composite_child().
5230 gtk_widget_set_composite_name (GtkWidget *widget,
5233 g_return_if_fail (GTK_IS_WIDGET (widget));
5234 g_return_if_fail (GTK_WIDGET_COMPOSITE_CHILD (widget));
5235 g_return_if_fail (name != NULL);
5237 if (!quark_composite_name)
5238 quark_composite_name = g_quark_from_static_string ("gtk-composite-name");
5240 gtk_object_set_data_by_id_full (GTK_OBJECT (widget),
5241 quark_composite_name,
5247 * gtk_widget_get_composite_name:
5248 * @widget: a #GtkWidget.
5249 * @returns: the composite name of @widget, or %NULL if @widget is not
5250 * a composite child. The string should not be freed when it is no
5253 * Obtains the composite name of a widget.
5256 gtk_widget_get_composite_name (GtkWidget *widget)
5258 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5260 if (GTK_WIDGET_COMPOSITE_CHILD (widget) && widget->parent)
5261 return _gtk_container_child_composite_name (GTK_CONTAINER (widget->parent),
5268 * gtk_widget_push_composite_child:
5270 * Makes all newly-created widgets as composite children until
5271 * the corresponding gtk_widget_pop_composite_child() call.
5273 * Here is a simple example:
5274 * <informalexample><programlisting>
5275 * gtk_widget_push_composite_child (<!>);
5276 * scrolled_window->hscrollbar = gtk_hscrollbar_new (hadjustment);
5277 * gtk_widget_set_composite_name (scrolled_window->hscrollbar, "hscrollbar");
5278 * gtk_widget_pop_composite_child (<!>);
5279 * gtk_widget_set_parent (scrolled_window->hscrollbar,
5280 * GTK_WIDGET (scrolled_window));
5281 * gtk_widget_ref (scrolled_window->hscrollbar);
5282 * </programlisting></informalexample>
5285 gtk_widget_push_composite_child (void)
5287 composite_child_stack++;
5291 * gtk_widget_pop_composite_child:
5293 * Cancels the effect of a previous call to gtk_widget_push_composite_child().
5296 gtk_widget_pop_composite_child (void)
5298 if (composite_child_stack)
5299 composite_child_stack--;
5303 * gtk_widget_push_colormap:
5304 * @cmap: a #GdkColormap
5306 * Pushes @cmap onto a global stack of colormaps; the topmost
5307 * colormap on the stack will be used to create all widgets.
5308 * Remove @cmap with gtk_widget_pop_colormap(). There's little
5309 * reason to use this function.
5313 gtk_widget_push_colormap (GdkColormap *cmap)
5315 g_return_if_fail (cmap != NULL);
5317 colormap_stack = g_slist_prepend (colormap_stack, cmap);
5321 * gtk_widget_pop_colormap:
5323 * Removes a colormap pushed with gtk_widget_push_colormap().
5327 gtk_widget_pop_colormap (void)
5330 colormap_stack = g_slist_delete_link (colormap_stack, colormap_stack);
5334 * gtk_widget_set_default_colormap:
5335 * @colormap: a #GdkColormap
5337 * Sets the default colormap to use when creating widgets.
5338 * gtk_widget_push_colormap() is a better function to use if
5339 * you only want to affect a few widgets, rather than all widgets.
5343 gtk_widget_set_default_colormap (GdkColormap *colormap)
5345 if (default_colormap != colormap)
5347 if (default_colormap)
5348 gdk_colormap_unref (default_colormap);
5349 default_colormap = colormap;
5350 if (default_colormap)
5351 gdk_colormap_ref (default_colormap);
5356 * gtk_widget_get_default_colormap:
5358 * Obtains the default colormap used to create widgets.
5360 * Return value: default widget colormap
5363 gtk_widget_get_default_colormap (void)
5365 if (!default_colormap)
5366 gtk_widget_set_default_colormap (gdk_rgb_get_colormap ());
5368 return default_colormap;
5372 * gtk_widget_get_default_visual:
5374 * Obtains the visual of the default colormap. Not really useful;
5375 * used to be useful before gdk_colormap_get_visual() existed.
5377 * Return value: visual of the default colormap
5380 gtk_widget_get_default_visual (void)
5382 return gdk_colormap_get_visual (gtk_widget_get_default_colormap ());
5386 gtk_widget_emit_direction_changed (GtkWidget *widget,
5387 GtkTextDirection old_dir)
5389 PangoContext *context = gtk_widget_peek_pango_context (widget);
5392 pango_context_set_base_dir (context,
5393 gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR ?
5394 PANGO_DIRECTION_LTR : PANGO_DIRECTION_RTL);
5396 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[DIRECTION_CHANGED], old_dir);
5400 * gtk_widget_set_direction:
5401 * @widget: a #GtkWidget
5402 * @dir: the new direction
5404 * Sets the reading direction on a particular widget. This direction
5405 * controls the primary direction for widgets containing text,
5406 * and also the direction in which the children of a container are
5407 * packed. The ability to set the direction is present in order
5408 * so that correct localization into languages with right-to-left
5409 * reading directions can be done. Generally, applications will
5410 * let the default reading direction present, except for containers
5411 * where the containers are arranged in an order that is explicitely
5412 * visual rather than logical (such as buttons for text justification).
5414 * If the direction is set to %GTK_TEXT_DIR_NONE, then the value
5415 * set by gtk_widget_set_default_direction() will be used.
5418 gtk_widget_set_direction (GtkWidget *widget,
5419 GtkTextDirection dir)
5421 GtkTextDirection old_dir;
5423 g_return_if_fail (GTK_IS_WIDGET (widget));
5424 g_return_if_fail (dir >= GTK_TEXT_DIR_NONE && dir <= GTK_TEXT_DIR_RTL);
5426 old_dir = gtk_widget_get_direction (widget);
5428 if (dir == GTK_TEXT_DIR_NONE)
5429 GTK_PRIVATE_UNSET_FLAG (widget, GTK_DIRECTION_SET);
5432 GTK_PRIVATE_SET_FLAG (widget, GTK_DIRECTION_SET);
5433 if (dir == GTK_TEXT_DIR_LTR)
5434 GTK_PRIVATE_SET_FLAG (widget, GTK_DIRECTION_LTR);
5436 GTK_PRIVATE_UNSET_FLAG (widget, GTK_DIRECTION_LTR);
5439 if (old_dir != gtk_widget_get_direction (widget))
5440 gtk_widget_emit_direction_changed (widget, old_dir);
5444 * gtk_widget_get_direction:
5445 * @widget: a #GtkWidget
5447 * Gets the reading direction for a particular widget. See
5448 * gtk_widget_set_direction().
5450 * Return value: the reading direction for the widget.
5453 gtk_widget_get_direction (GtkWidget *widget)
5455 g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_TEXT_DIR_LTR);
5457 if (GTK_WIDGET_DIRECTION_SET (widget))
5458 return GTK_WIDGET_DIRECTION_LTR (widget) ? GTK_TEXT_DIR_LTR : GTK_TEXT_DIR_RTL;
5460 return gtk_default_direction;
5464 gtk_widget_set_default_direction_recurse (GtkWidget *widget, gpointer data)
5466 GtkTextDirection old_dir = GPOINTER_TO_UINT (data);
5468 g_object_ref (G_OBJECT (widget));
5470 if (!GTK_WIDGET_DIRECTION_SET (widget))
5471 gtk_widget_emit_direction_changed (widget, old_dir);
5473 if (GTK_IS_CONTAINER (widget))
5474 gtk_container_forall (GTK_CONTAINER (widget),
5475 gtk_widget_set_default_direction_recurse,
5478 g_object_unref (G_OBJECT (widget));
5482 * gtk_widget_set_default_direction:
5483 * @dir: the new default direction. This cannot be
5484 * %GTK_TEXT_DIR_NONE.
5486 * Sets the default reading direction for widgets where the
5487 * direction has not been explicitly set by gtk_widget_set_direction().
5490 gtk_widget_set_default_direction (GtkTextDirection dir)
5492 g_return_if_fail (dir == GTK_TEXT_DIR_RTL || dir == GTK_TEXT_DIR_LTR);
5494 if (dir != gtk_default_direction)
5496 GList *toplevels, *tmp_list;
5497 GtkTextDirection old_dir = gtk_default_direction;
5499 gtk_default_direction = dir;
5501 tmp_list = toplevels = gtk_window_list_toplevels ();
5502 g_list_foreach (toplevels, (GFunc)g_object_ref, NULL);
5506 gtk_widget_set_default_direction_recurse (tmp_list->data,
5507 GUINT_TO_POINTER (old_dir));
5508 g_object_unref (tmp_list->data);
5509 tmp_list = tmp_list->next;
5512 g_list_free (toplevels);
5517 * gtk_widget_get_default_direction:
5519 * Obtains the current default reading direction. See
5520 * gtk_widget_set_default_direction().
5522 * Return value: the current default direction.
5525 gtk_widget_get_default_direction (void)
5527 return gtk_default_direction;
5531 gtk_widget_dispose (GObject *object)
5533 GtkWidget *widget = GTK_WIDGET (object);
5536 gtk_container_remove (GTK_CONTAINER (widget->parent), widget);
5538 GTK_WIDGET_UNSET_FLAGS (widget, GTK_VISIBLE);
5539 if (GTK_WIDGET_REALIZED (widget))
5540 gtk_widget_unrealize (widget);
5542 G_OBJECT_CLASS (parent_class)->dispose (object);
5546 gtk_widget_real_destroy (GtkObject *object)
5550 /* gtk_object_destroy() will already hold a refcount on object
5552 widget = GTK_WIDGET (object);
5554 /* wipe accelerator closures (keep order) */
5555 g_object_set_qdata (G_OBJECT (widget), quark_accel_path, NULL);
5556 g_object_set_qdata (G_OBJECT (widget), quark_accel_closures, NULL);
5558 gtk_grab_remove (widget);
5559 gtk_selection_remove_all (widget);
5561 g_object_unref (widget->style);
5562 widget->style = gtk_widget_get_default_style ();
5563 g_object_ref (widget->style);
5565 GTK_OBJECT_CLASS (parent_class)->destroy (object);
5569 gtk_widget_finalize (GObject *object)
5571 GtkWidget *widget = GTK_WIDGET (object);
5572 GtkWidgetAuxInfo *aux_info;
5574 GdkExtensionMode *mode;
5575 GtkAccessible *accessible;
5577 gtk_grab_remove (widget);
5578 gtk_selection_remove_all (widget);
5580 g_object_unref (widget->style);
5581 widget->style = NULL;
5584 g_free (widget->name);
5586 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
5588 gtk_widget_aux_info_destroy (aux_info);
5590 events = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_event_mask);
5594 mode = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_extension_event_mode);
5598 accessible = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_accessible_object);
5600 g_object_unref (G_OBJECT (accessible));
5602 G_OBJECT_CLASS (parent_class)->finalize (object);
5605 /*****************************************
5606 * gtk_widget_real_map:
5611 *****************************************/
5614 gtk_widget_real_map (GtkWidget *widget)
5616 g_return_if_fail (GTK_IS_WIDGET (widget));
5617 g_return_if_fail (GTK_WIDGET_REALIZED (widget) == TRUE);
5619 if (!GTK_WIDGET_MAPPED (widget))
5621 GTK_WIDGET_SET_FLAGS (widget, GTK_MAPPED);
5623 if (!GTK_WIDGET_NO_WINDOW (widget))
5624 gdk_window_show (widget->window);
5628 /*****************************************
5629 * gtk_widget_real_unmap:
5634 *****************************************/
5637 gtk_widget_real_unmap (GtkWidget *widget)
5639 g_return_if_fail (GTK_IS_WIDGET (widget));
5641 if (GTK_WIDGET_MAPPED (widget))
5643 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
5645 if (!GTK_WIDGET_NO_WINDOW (widget))
5646 gdk_window_hide (widget->window);
5650 /*****************************************
5651 * gtk_widget_real_realize:
5656 *****************************************/
5659 gtk_widget_real_realize (GtkWidget *widget)
5661 g_return_if_fail (GTK_IS_WIDGET (widget));
5662 g_return_if_fail (GTK_WIDGET_NO_WINDOW (widget));
5664 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
5667 widget->window = gtk_widget_get_parent_window (widget);
5668 gdk_window_ref (widget->window);
5670 widget->style = gtk_style_attach (widget->style, widget->window);
5673 /*****************************************
5674 * gtk_widget_real_unrealize:
5679 *****************************************/
5682 gtk_widget_real_unrealize (GtkWidget *widget)
5684 g_return_if_fail (GTK_IS_WIDGET (widget));
5686 if (GTK_WIDGET_MAPPED (widget))
5687 gtk_widget_real_unmap (widget);
5689 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
5691 /* printf ("unrealizing %s\n", gtk_type_name (GTK_OBJECT (widget)->klass->type));
5694 /* We must do unrealize child widget BEFORE container widget.
5695 * gdk_window_destroy() destroys specified xwindow and its sub-xwindows.
5696 * So, unrealizing container widget bofore its children causes the problem
5697 * (for example, gdk_ic_destroy () with destroyed window causes crash. )
5700 if (GTK_IS_CONTAINER (widget))
5701 gtk_container_forall (GTK_CONTAINER (widget),
5702 (GtkCallback) gtk_widget_unrealize,
5705 gtk_style_detach (widget->style);
5706 if (!GTK_WIDGET_NO_WINDOW (widget))
5708 gdk_window_set_user_data (widget->window, NULL);
5709 gdk_window_destroy (widget->window);
5710 widget->window = NULL;
5714 gdk_window_unref (widget->window);
5715 widget->window = NULL;
5718 GTK_WIDGET_UNSET_FLAGS (widget, GTK_REALIZED);
5722 gtk_widget_real_size_request (GtkWidget *widget,
5723 GtkRequisition *requisition)
5725 g_return_if_fail (GTK_IS_WIDGET (widget));
5727 requisition->width = widget->requisition.width;
5728 requisition->height = widget->requisition.height;
5732 * _gtk_widget_peek_colormap:
5734 * Returns colormap currently pushed by gtk_widget_push_colormap, if any.
5736 * Return value: the currently pushed colormap, or %NULL if there is none.
5739 _gtk_widget_peek_colormap (void)
5742 return (GdkColormap*) colormap_stack->data;
5747 gtk_widget_propagate_state (GtkWidget *widget,
5752 /* don't call this function with state==GTK_STATE_INSENSITIVE,
5753 * parent_sensitive==TRUE on a sensitive widget
5756 old_state = GTK_WIDGET_STATE (widget);
5758 if (data->parent_sensitive)
5760 GTK_WIDGET_SET_FLAGS (widget, GTK_PARENT_SENSITIVE);
5762 if (GTK_WIDGET_IS_SENSITIVE (widget))
5764 if (data->state_restoration)
5765 GTK_WIDGET_STATE (widget) = GTK_WIDGET_SAVED_STATE (widget);
5767 GTK_WIDGET_STATE (widget) = data->state;
5771 GTK_WIDGET_STATE (widget) = GTK_STATE_INSENSITIVE;
5772 if (!data->state_restoration &&
5773 data->state != GTK_STATE_INSENSITIVE)
5774 GTK_WIDGET_SAVED_STATE (widget) = data->state;
5779 GTK_WIDGET_UNSET_FLAGS (widget, GTK_PARENT_SENSITIVE);
5780 if (!data->state_restoration)
5782 if (data->state != GTK_STATE_INSENSITIVE)
5783 GTK_WIDGET_SAVED_STATE (widget) = data->state;
5785 else if (GTK_WIDGET_STATE (widget) != GTK_STATE_INSENSITIVE)
5786 GTK_WIDGET_SAVED_STATE (widget) = GTK_WIDGET_STATE (widget);
5787 GTK_WIDGET_STATE (widget) = GTK_STATE_INSENSITIVE;
5790 if (gtk_widget_is_focus (widget) && !GTK_WIDGET_IS_SENSITIVE (widget))
5794 window = gtk_widget_get_toplevel (widget);
5795 if (window && GTK_WIDGET_TOPLEVEL (window))
5796 gtk_window_set_focus (GTK_WINDOW (window), NULL);
5799 if (old_state != GTK_WIDGET_STATE (widget))
5801 gtk_widget_ref (widget);
5803 if (!GTK_WIDGET_IS_SENSITIVE (widget) && GTK_WIDGET_HAS_GRAB (widget))
5804 gtk_grab_remove (widget);
5806 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[STATE_CHANGED], old_state);
5809 if (GTK_IS_CONTAINER (widget))
5811 data->parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget) != FALSE);
5812 data->state = GTK_WIDGET_STATE (widget);
5813 if (data->use_forall)
5814 gtk_container_forall (GTK_CONTAINER (widget),
5815 (GtkCallback) gtk_widget_propagate_state,
5818 gtk_container_foreach (GTK_CONTAINER (widget),
5819 (GtkCallback) gtk_widget_propagate_state,
5822 gtk_widget_unref (widget);
5827 * _gtk_widget_get_aux_info:
5828 * @widget: a #GtkWidget
5829 * @create: if %TRUE, create the structure if it doesn't exist
5831 * Get the #GtkWidgetAuxInfo structure for the widget.
5833 * Return value: the #GtkAuxInfo structure for the widget, or
5834 * %NULL if @create is %FALSE and one doesn't already exist.
5837 _gtk_widget_get_aux_info (GtkWidget *widget,
5840 GtkWidgetAuxInfo *aux_info;
5842 aux_info = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_aux_info);
5843 if (!aux_info && create)
5845 if (!aux_info_mem_chunk)
5846 aux_info_mem_chunk = g_mem_chunk_new ("widget aux info mem chunk",
5847 sizeof (GtkWidgetAuxInfo),
5848 1024, G_ALLOC_AND_FREE);
5849 aux_info = g_chunk_new (GtkWidgetAuxInfo, aux_info_mem_chunk);
5851 aux_info->width = -1;
5852 aux_info->height = -1;
5855 aux_info->x_set = FALSE;
5856 aux_info->y_set = FALSE;
5857 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_aux_info, aux_info);
5863 /*****************************************
5864 * gtk_widget_aux_info_destroy:
5869 *****************************************/
5872 gtk_widget_aux_info_destroy (GtkWidgetAuxInfo *aux_info)
5874 g_return_if_fail (aux_info != NULL);
5876 g_mem_chunk_free (aux_info_mem_chunk, aux_info);
5880 gtk_widget_shape_info_destroy (GtkWidgetShapeInfo *info)
5882 gdk_drawable_unref (info->shape_mask);
5887 * gtk_widget_shape_combine_mask:
5888 * @widget: a #GtkWidget.
5889 * @shape_mask: shape to be added, or %NULL to remove an existing shape.
5890 * @offset_x: X position of shape mask with respect to @window.
5891 * @offset_y: Y position of shape mask with respect to @window.
5893 * Sets a shape for this widget's GDK window. This allows for
5894 * transparent windows etc., see gdk_window_shape_combine_mask()
5895 * for more information.
5898 gtk_widget_shape_combine_mask (GtkWidget *widget,
5899 GdkBitmap *shape_mask,
5903 GtkWidgetShapeInfo* shape_info;
5905 g_return_if_fail (GTK_IS_WIDGET (widget));
5906 /* set_shape doesn't work on widgets without gdk window */
5907 g_return_if_fail (!GTK_WIDGET_NO_WINDOW (widget));
5911 GTK_PRIVATE_UNSET_FLAG (widget, GTK_HAS_SHAPE_MASK);
5914 gdk_window_shape_combine_mask (widget->window, NULL, 0, 0);
5916 g_object_set_qdata (G_OBJECT (widget), quark_shape_info, NULL);
5920 GTK_PRIVATE_SET_FLAG (widget, GTK_HAS_SHAPE_MASK);
5922 shape_info = g_new (GtkWidgetShapeInfo, 1);
5923 g_object_set_qdata_full (G_OBJECT (widget), quark_shape_info, shape_info,
5924 (GDestroyNotify) gtk_widget_shape_info_destroy);
5926 shape_info->shape_mask = gdk_drawable_ref (shape_mask);
5927 shape_info->offset_x = offset_x;
5928 shape_info->offset_y = offset_y;
5930 /* set shape if widget has a gdk window allready.
5931 * otherwise the shape is scheduled to be set by gtk_widget_realize.
5934 gdk_window_shape_combine_mask (widget->window, shape_mask,
5935 offset_x, offset_y);
5940 gtk_reset_shapes_recurse (GtkWidget *widget,
5946 gdk_window_get_user_data (window, &data);
5950 gdk_window_shape_combine_mask (window, NULL, 0, 0);
5951 for (list = gdk_window_peek_children (window); list; list = list->next)
5952 gtk_reset_shapes_recurse (widget, list->data);
5956 * gtk_widget_reset_shapes:
5957 * @widget: a #GtkWidget.
5959 * Recursively resets the shape on this widget and its descendants.
5962 gtk_widget_reset_shapes (GtkWidget *widget)
5964 g_return_if_fail (GTK_IS_WIDGET (widget));
5965 g_return_if_fail (GTK_WIDGET_REALIZED (widget));
5967 if (!GTK_WIDGET_HAS_SHAPE_MASK (widget))
5968 gtk_reset_shapes_recurse (widget, widget->window);
5973 * @widget: a #GtkWidget
5975 * Adds a reference to a widget. This function is exactly the same
5976 * as calling g_object_ref(), and exists mostly for historical
5977 * reasons. It can still be convenient to avoid casting a widget
5978 * to a #GObject, it saves a small amount of typing.
5980 * Return value: the widget that was referenced
5983 gtk_widget_ref (GtkWidget *widget)
5985 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5987 return (GtkWidget*) g_object_ref ((GObject*) widget);
5992 * @widget: a #GtkWidget
5994 * Inverse of gtk_widget_ref(). Equivalent to g_object_unref().
5998 gtk_widget_unref (GtkWidget *widget)
6000 g_return_if_fail (GTK_IS_WIDGET (widget));
6002 g_object_unref ((GObject*) widget);
6010 gtk_widget_class_install_style_property_parser (GtkWidgetClass *class,
6012 GtkRcPropertyParser parser)
6014 g_return_if_fail (GTK_IS_WIDGET_CLASS (class));
6015 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
6016 g_return_if_fail (pspec->flags & G_PARAM_READABLE);
6017 g_return_if_fail (!(pspec->flags & (G_PARAM_CONSTRUCT_ONLY | G_PARAM_CONSTRUCT)));
6019 if (g_param_spec_pool_lookup (style_property_spec_pool, pspec->name, G_OBJECT_CLASS_TYPE (class), FALSE))
6021 g_warning (G_STRLOC ": class `%s' already contains a style property named `%s'",
6022 G_OBJECT_CLASS_NAME (class),
6027 g_param_spec_ref (pspec);
6028 g_param_spec_sink (pspec);
6029 g_param_spec_set_qdata (pspec, quark_property_parser, parser);
6030 g_param_spec_pool_insert (style_property_spec_pool, pspec, G_OBJECT_CLASS_TYPE (class));
6034 gtk_widget_class_install_style_property (GtkWidgetClass *class,
6037 GtkRcPropertyParser parser;
6039 g_return_if_fail (GTK_IS_WIDGET_CLASS (class));
6040 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
6042 parser = _gtk_rc_property_parser_from_type (G_PARAM_SPEC_VALUE_TYPE (pspec));
6044 gtk_widget_class_install_style_property_parser (class, pspec, parser);
6048 gtk_widget_style_get_property (GtkWidget *widget,
6049 const gchar *property_name,
6054 g_return_if_fail (GTK_IS_WIDGET (widget));
6055 g_return_if_fail (property_name != NULL);
6056 g_return_if_fail (G_IS_VALUE (value));
6058 g_object_ref (widget);
6059 pspec = g_param_spec_pool_lookup (style_property_spec_pool,
6061 G_OBJECT_TYPE (widget),
6064 g_warning ("%s: widget class `%s' has no property named `%s'",
6066 G_OBJECT_TYPE_NAME (widget),
6070 const GValue *peek_value;
6072 peek_value = _gtk_style_peek_property_value (widget->style,
6073 G_OBJECT_TYPE (widget),
6075 g_param_spec_get_qdata (pspec, quark_property_parser));
6077 /* auto-conversion of the caller's value type
6079 if (G_VALUE_TYPE (value) == G_PARAM_SPEC_VALUE_TYPE (pspec))
6080 g_value_copy (peek_value, value);
6081 else if (g_value_type_transformable (G_PARAM_SPEC_VALUE_TYPE (pspec), G_VALUE_TYPE (value)))
6082 g_value_transform (peek_value, value);
6084 g_warning ("can't retrieve style property `%s' of type `%s' as value of type `%s'",
6086 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
6087 G_VALUE_TYPE_NAME (value));
6089 g_object_unref (widget);
6093 gtk_widget_style_get_valist (GtkWidget *widget,
6094 const gchar *first_property_name,
6099 g_return_if_fail (GTK_IS_WIDGET (widget));
6101 g_object_ref (widget);
6103 name = first_property_name;
6106 const GValue *peek_value;
6110 pspec = g_param_spec_pool_lookup (style_property_spec_pool,
6112 G_OBJECT_TYPE (widget),
6116 g_warning ("%s: widget class `%s' has no property named `%s'",
6118 G_OBJECT_TYPE_NAME (widget),
6122 /* style pspecs are always readable so we can spare that check here */
6124 peek_value = _gtk_style_peek_property_value (widget->style,
6125 G_OBJECT_TYPE (widget),
6127 g_param_spec_get_qdata (pspec, quark_property_parser));
6128 G_VALUE_LCOPY (peek_value, var_args, 0, &error);
6131 g_warning ("%s: %s", G_STRLOC, error);
6136 name = va_arg (var_args, gchar*);
6139 g_object_unref (widget);
6143 gtk_widget_style_get (GtkWidget *widget,
6144 const gchar *first_property_name,
6149 g_return_if_fail (GTK_IS_WIDGET (widget));
6151 va_start (var_args, first_property_name);
6152 gtk_widget_style_get_valist (widget, first_property_name, var_args);
6158 * @widget: a #GtkWidget
6159 * @path_length: location to store length of the path, or %NULL
6160 * @path: location to store allocated path string, or %NULL
6161 * @path_reversed: location to store allocated reverse path string, or %NULL
6163 * Obtains the full path to @widget. The path is simply the name of a
6164 * widget and all its parents in the container hierarchy, separated by
6165 * periods. The name of a widget comes from
6166 * gtk_widget_get_name(). Paths are used to apply styles to a widget
6167 * in gtkrc configuration files. Widget names are the type of the
6168 * widget by default (e.g. "GtkButton") or can be set to an
6169 * application-specific value with gtk_widget_set_name(). By setting
6170 * the name of a widget, you allow users or theme authors to apply
6171 * styles to that specific widget in their gtkrc
6172 * file. @path_reversed_p fills in the path in reverse order,
6173 * i.e. starting with @widget's name instead of starting with the name
6174 * of @widget's outermost ancestor.
6178 gtk_widget_path (GtkWidget *widget,
6181 gchar **path_reversed)
6183 static gchar *rev_path = NULL;
6184 static guint tmp_path_len = 0;
6187 g_return_if_fail (GTK_IS_WIDGET (widget));
6192 const gchar *string;
6197 string = gtk_widget_get_name (widget);
6198 l = strlen (string);
6199 while (tmp_path_len <= len + l + 1)
6201 tmp_path_len += INIT_PATH_SIZE;
6202 rev_path = g_realloc (rev_path, tmp_path_len);
6210 widget = widget->parent;
6213 rev_path[len++] = '.';
6215 rev_path[len++] = 0;
6220 *path_length = len - 1;
6222 *path_reversed = g_strdup (rev_path);
6225 *path = g_strdup (rev_path);
6226 g_strreverse (*path);
6231 * gtk_widget_class_path:
6232 * @widget: a #GtkWidget
6233 * @path_length: location to store the length of the class path, or %NULL
6234 * @path: location to store the class path as an allocated string, or %NULL
6235 * @path_reversed: location to store the reverse class path as an allocated string, or %NULL
6237 * Same as gtk_widget_path(), but always uses the name of a widget's type,
6238 * never uses a custom name set with gtk_widget_set_name().
6242 gtk_widget_class_path (GtkWidget *widget,
6245 gchar **path_reversed)
6247 static gchar *rev_path = NULL;
6248 static guint tmp_path_len = 0;
6251 g_return_if_fail (GTK_IS_WIDGET (widget));
6256 const gchar *string;
6261 string = gtk_type_name (GTK_WIDGET_TYPE (widget));
6262 l = strlen (string);
6263 while (tmp_path_len <= len + l + 1)
6265 tmp_path_len += INIT_PATH_SIZE;
6266 rev_path = g_realloc (rev_path, tmp_path_len);
6274 widget = widget->parent;
6277 rev_path[len++] = '.';
6279 rev_path[len++] = 0;
6284 *path_length = len - 1;
6286 *path_reversed = g_strdup (rev_path);
6289 *path = g_strdup (rev_path);
6290 g_strreverse (*path);
6295 * gtk_requisition_copy:
6296 * @requisition: a #GtkRequisition.
6297 * @returns: a copy of @requisition.
6299 * Copies a #GtkRequisition.
6302 gtk_requisition_copy (const GtkRequisition *requisition)
6304 return (GtkRequisition *)g_memdup (requisition, sizeof (GtkRequisition));
6308 * gtk_requisition_free:
6309 * @requisition: a #GtkRequisition.
6311 * Frees a #GtkRequisition.
6314 gtk_requisition_free (GtkRequisition *requisition)
6316 g_free (requisition);
6320 gtk_widget_get_accessible (GtkWidget *widget)
6322 GtkWidgetClass *klass;
6324 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
6326 klass = GTK_WIDGET_GET_CLASS (widget);
6328 g_return_val_if_fail (klass->get_accessible != NULL, NULL);
6330 return klass->get_accessible (widget);
6334 gtk_widget_real_get_accessible (GtkWidget *widget)
6336 AtkObject* accessible;
6338 accessible = g_object_get_qdata (G_OBJECT (widget),
6339 quark_accessible_object);
6342 AtkObjectFactory *factory;
6343 AtkRegistry *default_registry;
6345 default_registry = atk_get_default_registry ();
6346 factory = atk_registry_get_factory (default_registry,
6347 GTK_OBJECT_TYPE (widget));
6349 atk_object_factory_create_accessible (factory,
6351 g_object_set_qdata (G_OBJECT (widget),
6352 quark_accessible_object,
6359 * Initialize a AtkImplementorIface instance's virtual pointers as
6360 * appropriate to this implementor's class (GtkWidget).
6363 gtk_widget_accessible_interface_init (AtkImplementorIface *iface)
6365 iface->ref_accessible = gtk_widget_ref_accessible;
6369 gtk_widget_ref_accessible (AtkImplementor *implementor)
6371 AtkObject *accessible;
6373 accessible = gtk_widget_get_accessible (GTK_WIDGET (implementor));
6375 g_object_ref (G_OBJECT (accessible));