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 "gtkiconfactory.h"
35 #include "gtkselection.h"
36 #include "gtksettings.h"
37 #include "gtksizegroup.h"
38 #include "gtksignal.h"
39 #include "gtkwidget.h"
40 #include "gtkwindow.h"
41 #include "gtkbindings.h"
42 #include "gtkprivate.h"
44 #include "gdk/gdkprivate.h" /* Used in gtk_reset_shapes_recurse to avoid copy */
45 #include "gobject/gvaluecollector.h"
46 #include "gdk/gdkkeysyms.h"
48 #include "gtkaccessible.h"
50 #define WIDGET_CLASS(w) GTK_WIDGET_GET_CLASS (w)
51 #define INIT_PATH_SIZE (512)
89 PROPERTY_NOTIFY_EVENT,
90 SELECTION_CLEAR_EVENT,
91 SELECTION_REQUEST_EVENT,
92 SELECTION_NOTIFY_EVENT,
107 VISIBILITY_NOTIFY_EVENT,
128 PROP_RECEIVES_DEFAULT,
129 PROP_COMPOSITE_CHILD,
132 PROP_EXTENSION_EVENTS
135 typedef struct _GtkStateData GtkStateData;
140 guint state_restoration : 1;
141 guint parent_sensitive : 1;
142 guint use_forall : 1;
145 static void gtk_widget_class_init (GtkWidgetClass *klass);
146 static void gtk_widget_init (GtkWidget *widget);
147 static void gtk_widget_set_property (GObject *object,
151 static void gtk_widget_get_property (GObject *object,
155 static void gtk_widget_shutdown (GObject *object);
156 static void gtk_widget_real_destroy (GtkObject *object);
157 static void gtk_widget_finalize (GObject *object);
158 static void gtk_widget_real_show (GtkWidget *widget);
159 static void gtk_widget_real_hide (GtkWidget *widget);
160 static void gtk_widget_real_map (GtkWidget *widget);
161 static void gtk_widget_real_unmap (GtkWidget *widget);
162 static void gtk_widget_real_realize (GtkWidget *widget);
163 static void gtk_widget_real_unrealize (GtkWidget *widget);
164 static void gtk_widget_real_size_request (GtkWidget *widget,
165 GtkRequisition *requisition);
166 static void gtk_widget_real_size_allocate (GtkWidget *widget,
167 GtkAllocation *allocation);
168 static gboolean gtk_widget_real_key_press_event (GtkWidget *widget,
170 static gboolean gtk_widget_real_key_release_event (GtkWidget *widget,
172 static gboolean gtk_widget_real_focus_in_event (GtkWidget *widget,
173 GdkEventFocus *event);
174 static gboolean gtk_widget_real_focus_out_event (GtkWidget *widget,
175 GdkEventFocus *event);
177 static void gtk_widget_style_set (GtkWidget *widget,
178 GtkStyle *previous_style);
179 static void gtk_widget_direction_changed (GtkWidget *widget,
180 GtkTextDirection previous_direction);
181 static void gtk_widget_real_grab_focus (GtkWidget *focus_widget);
183 static GdkColormap* gtk_widget_peek_colormap (void);
184 static GtkStyle* gtk_widget_peek_style (void);
185 static PangoContext *gtk_widget_peek_pango_context (GtkWidget *widget);
187 static void gtk_widget_reparent_container_child (GtkWidget *widget,
188 gpointer client_data);
189 static void gtk_widget_propagate_state (GtkWidget *widget,
191 static void gtk_widget_set_style_internal (GtkWidget *widget,
193 gboolean initial_emission);
194 static void gtk_widget_set_style_recurse (GtkWidget *widget,
195 gpointer client_data);
196 static gint gtk_widget_event_internal (GtkWidget *widget,
199 static void gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
200 gpointer client_data);
201 static gboolean gtk_widget_real_mnemonic_activate (GtkWidget *widget,
202 gboolean group_cycling);
204 static void gtk_widget_aux_info_destroy (GtkWidgetAuxInfo *aux_info);
206 static void gtk_widget_do_uposition (GtkWidget *widget);
208 static AtkObject* gtk_widget_real_get_accessible (GtkWidget *widget);
209 static void gtk_widget_accessible_interface_init (AtkImplementorIface *iface);
210 static AtkObject * gtk_widget_ref_accessible (AtkImplementor *implementor);
212 static gpointer parent_class = NULL;
213 static guint widget_signals[LAST_SIGNAL] = { 0 };
215 static GMemChunk *aux_info_mem_chunk = NULL;
216 static GdkColormap *default_colormap = NULL;
217 static GtkStyle *gtk_default_style = NULL;
218 static GSList *colormap_stack = NULL;
219 static GSList *style_stack = NULL;
220 static guint composite_child_stack = 0;
221 static GtkTextDirection gtk_default_direction = GTK_TEXT_DIR_LTR;
222 static GParamSpecPool *style_property_spec_pool = NULL;
224 static GQuark quark_property_parser = 0;
225 static GQuark quark_aux_info = 0;
226 static GQuark quark_event_mask = 0;
227 static GQuark quark_extension_event_mode = 0;
228 static GQuark quark_parent_window = 0;
229 static GQuark quark_saved_default_style = 0;
230 static GQuark quark_shape_info = 0;
231 static GQuark quark_colormap = 0;
232 static GQuark quark_pango_context = 0;
233 static GQuark quark_rc_style = 0;
234 static GQuark quark_accessible_object = 0;
237 /*****************************************
238 * gtk_widget_get_type:
243 *****************************************/
246 gtk_widget_get_type (void)
248 static GtkType widget_type = 0;
252 static const GtkTypeInfo widget_info =
256 sizeof (GtkWidgetClass),
257 (GtkClassInitFunc) gtk_widget_class_init,
258 (GtkObjectInitFunc) gtk_widget_init,
259 /* reserved_1 */ NULL,
260 /* reserved_2 */ NULL,
261 (GtkClassInitFunc) NULL,
264 static const GInterfaceInfo accessibility_info =
266 (GInterfaceInitFunc) gtk_widget_accessible_interface_init,
267 (GInterfaceFinalizeFunc) NULL,
268 NULL /* interface data */
272 widget_type = gtk_type_unique (GTK_TYPE_OBJECT, &widget_info);
274 g_type_add_interface_static (widget_type, ATK_TYPE_IMPLEMENTOR,
275 &accessibility_info) ;
282 /*****************************************
283 * gtk_widget_class_init:
288 *****************************************/
290 gtk_widget_class_init (GtkWidgetClass *klass)
292 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
293 GtkObjectClass *object_class = GTK_OBJECT_CLASS (klass);
294 GtkBindingSet *binding_set;
296 parent_class = gtk_type_class (GTK_TYPE_OBJECT);
298 gobject_class->shutdown = gtk_widget_shutdown;
299 gobject_class->finalize = gtk_widget_finalize;
300 gobject_class->set_property = gtk_widget_set_property;
301 gobject_class->get_property = gtk_widget_get_property;
303 object_class->destroy = gtk_widget_real_destroy;
305 klass->activate_signal = 0;
306 klass->set_scroll_adjustments_signal = 0;
307 klass->show = gtk_widget_real_show;
308 klass->show_all = gtk_widget_show;
309 klass->hide = gtk_widget_real_hide;
310 klass->hide_all = gtk_widget_hide;
311 klass->map = gtk_widget_real_map;
312 klass->unmap = gtk_widget_real_unmap;
313 klass->realize = gtk_widget_real_realize;
314 klass->unrealize = gtk_widget_real_unrealize;
315 klass->size_request = gtk_widget_real_size_request;
316 klass->size_allocate = gtk_widget_real_size_allocate;
317 klass->state_changed = NULL;
318 klass->parent_set = NULL;
319 klass->hierarchy_changed = NULL;
320 klass->style_set = gtk_widget_style_set;
321 klass->direction_changed = gtk_widget_direction_changed;
322 klass->add_accelerator = (void*) gtk_accel_group_handle_add;
323 klass->remove_accelerator = (void*) gtk_accel_group_handle_remove;
324 klass->mnemonic_activate = gtk_widget_real_mnemonic_activate;
325 klass->grab_focus = gtk_widget_real_grab_focus;
327 klass->button_press_event = NULL;
328 klass->button_release_event = NULL;
329 klass->motion_notify_event = NULL;
330 klass->delete_event = NULL;
331 klass->destroy_event = NULL;
332 klass->expose_event = NULL;
333 klass->key_press_event = gtk_widget_real_key_press_event;
334 klass->key_release_event = gtk_widget_real_key_release_event;
335 klass->enter_notify_event = NULL;
336 klass->leave_notify_event = NULL;
337 klass->configure_event = NULL;
338 klass->focus_in_event = gtk_widget_real_focus_in_event;
339 klass->focus_out_event = gtk_widget_real_focus_out_event;
340 klass->map_event = NULL;
341 klass->unmap_event = NULL;
342 klass->window_state_event = NULL;
343 klass->property_notify_event = gtk_selection_property_notify;
344 klass->selection_clear_event = gtk_selection_clear;
345 klass->selection_request_event = gtk_selection_request;
346 klass->selection_notify_event = gtk_selection_notify;
347 klass->selection_received = NULL;
348 klass->proximity_in_event = NULL;
349 klass->proximity_out_event = NULL;
350 klass->drag_begin = NULL;
351 klass->drag_end = NULL;
352 klass->drag_data_delete = NULL;
353 klass->drag_leave = NULL;
354 klass->drag_motion = NULL;
355 klass->drag_drop = NULL;
356 klass->drag_data_received = NULL;
358 /* Accessibility support */
359 klass->get_accessible = gtk_widget_real_get_accessible;
361 klass->no_expose_event = NULL;
363 quark_property_parser = g_quark_from_static_string ("gtk-rc-property-parser");
364 quark_aux_info = g_quark_from_static_string ("gtk-aux-info");
365 quark_event_mask = g_quark_from_static_string ("gtk-event-mask");
366 quark_extension_event_mode = g_quark_from_static_string ("gtk-extension-event-mode");
367 quark_parent_window = g_quark_from_static_string ("gtk-parent-window");
368 quark_saved_default_style = g_quark_from_static_string ("gtk-saved-default-style");
369 quark_shape_info = g_quark_from_static_string ("gtk-shape-info");
370 quark_colormap = g_quark_from_static_string ("gtk-colormap");
371 quark_pango_context = g_quark_from_static_string ("gtk-pango-context");
372 quark_rc_style = g_quark_from_static_string ("gtk-rc-style");
373 quark_accessible_object = g_quark_from_static_string ("gtk-accessible-object");
375 style_property_spec_pool = g_param_spec_pool_new (FALSE);
377 g_object_class_install_property (gobject_class,
379 g_param_spec_string ("name",
381 _("The name of the widget"),
385 g_object_class_install_property (gobject_class,
387 g_param_spec_object ("parent",
389 _("The parent widget of this widget. Must be a Container widget."),
393 g_object_class_install_property (gobject_class,
395 g_param_spec_int ("x",
397 _("The x coordinate of the top-left corner of the widget, or -1 if not set"),
403 g_object_class_install_property (gobject_class,
405 g_param_spec_int ("y",
407 _("The y coordinate of the top-left corner of the widget, or -1 if not set"),
413 g_object_class_install_property (gobject_class,
415 g_param_spec_int ("width",
417 _("The width of the widget, or -1 if unset."),
423 g_object_class_install_property (gobject_class,
425 g_param_spec_int ("height",
427 _("The height of the widget, or -1 if unset."),
433 g_object_class_install_property (gobject_class,
435 g_param_spec_boolean ("visible",
437 _("Whether the widget is visible"),
441 g_object_class_install_property (gobject_class,
443 g_param_spec_boolean ("sensitive",
445 _("Whether the widget responds to input"),
449 g_object_class_install_property (gobject_class,
451 g_param_spec_boolean ("app_paintable",
452 _("Application paintable"),
453 _("Whether the application will paint directly on the widget"),
457 g_object_class_install_property (gobject_class,
459 g_param_spec_boolean ("can_focus",
461 _("Whether the widget can accept the input focus"),
465 g_object_class_install_property (gobject_class,
467 g_param_spec_boolean ("has_focus",
469 _("Whether the widget has the input focus"),
473 g_object_class_install_property (gobject_class,
475 g_param_spec_boolean ("can_default",
477 _("Whether the widget can be the default widget"),
481 g_object_class_install_property (gobject_class,
483 g_param_spec_boolean ("has_default",
485 _("Whether the widget is the default widget"),
489 g_object_class_install_property (gobject_class,
490 PROP_RECEIVES_DEFAULT,
491 g_param_spec_boolean ("receives_default",
492 _("Receives default"),
493 _("If TRUE, the widget will receive the default action when it is focused."),
497 g_object_class_install_property (gobject_class,
498 PROP_COMPOSITE_CHILD,
499 g_param_spec_boolean ("composite_child",
500 _("Composite child"),
501 _("Whether the widget is composed of other widgets"),
506 g_object_class_install_property (gobject_class,
508 g_param_spec_object ("style",
510 _("The style of the widget, which contains information about how it will look (colors etc)."),
514 g_object_class_install_property (gobject_class,
516 g_param_spec_flags ("events",
518 _("The event mask that decides what kind of GdkEvents this widget gets."),
523 g_object_class_install_property (gobject_class,
524 PROP_EXTENSION_EVENTS,
525 g_param_spec_enum ("extension_events",
526 _("Extension events"),
527 _("The mask that decides what kind of extension events this widget gets."),
528 GDK_TYPE_EXTENSION_MODE,
529 GDK_EXTENSION_EVENTS_NONE,
533 widget_signals[SHOW] =
534 gtk_signal_new ("show",
536 GTK_CLASS_TYPE (object_class),
537 GTK_SIGNAL_OFFSET (GtkWidgetClass, show),
538 gtk_marshal_VOID__VOID,
540 widget_signals[HIDE] =
541 gtk_signal_new ("hide",
543 GTK_CLASS_TYPE (object_class),
544 GTK_SIGNAL_OFFSET (GtkWidgetClass, hide),
545 gtk_marshal_VOID__VOID,
547 widget_signals[MAP] =
548 gtk_signal_new ("map",
550 GTK_CLASS_TYPE (object_class),
551 GTK_SIGNAL_OFFSET (GtkWidgetClass, map),
552 gtk_marshal_VOID__VOID,
554 widget_signals[UNMAP] =
555 gtk_signal_new ("unmap",
557 GTK_CLASS_TYPE (object_class),
558 GTK_SIGNAL_OFFSET (GtkWidgetClass, unmap),
559 gtk_marshal_VOID__VOID,
561 widget_signals[REALIZE] =
562 gtk_signal_new ("realize",
564 GTK_CLASS_TYPE (object_class),
565 GTK_SIGNAL_OFFSET (GtkWidgetClass, realize),
566 gtk_marshal_VOID__VOID,
568 widget_signals[UNREALIZE] =
569 gtk_signal_new ("unrealize",
571 GTK_CLASS_TYPE (object_class),
572 GTK_SIGNAL_OFFSET (GtkWidgetClass, unrealize),
573 gtk_marshal_VOID__VOID,
575 widget_signals[SIZE_REQUEST] =
576 g_signal_newc ("size_request",
577 G_OBJECT_CLASS_TYPE (object_class),
579 G_STRUCT_OFFSET (GtkWidgetClass, size_request),
581 gtk_marshal_VOID__BOXED,
583 GTK_TYPE_REQUISITION | G_SIGNAL_TYPE_STATIC_SCOPE);
584 widget_signals[SIZE_ALLOCATE] =
585 gtk_signal_new ("size_allocate",
587 GTK_CLASS_TYPE (object_class),
588 GTK_SIGNAL_OFFSET (GtkWidgetClass, size_allocate),
589 gtk_marshal_VOID__POINTER,
592 widget_signals[STATE_CHANGED] =
593 gtk_signal_new ("state_changed",
595 GTK_CLASS_TYPE (object_class),
596 GTK_SIGNAL_OFFSET (GtkWidgetClass, state_changed),
597 gtk_marshal_VOID__ENUM,
599 GTK_TYPE_STATE_TYPE);
600 widget_signals[PARENT_SET] =
601 gtk_signal_new ("parent_set",
603 GTK_CLASS_TYPE (object_class),
604 GTK_SIGNAL_OFFSET (GtkWidgetClass, parent_set),
605 gtk_marshal_VOID__OBJECT,
608 widget_signals[HIERARCHY_CHANGED] =
609 gtk_signal_new ("hierarchy_changed",
611 GTK_CLASS_TYPE (object_class),
612 GTK_SIGNAL_OFFSET (GtkWidgetClass, hierarchy_changed),
613 gtk_marshal_NONE__NONE,
615 widget_signals[STYLE_SET] =
616 gtk_signal_new ("style_set",
618 GTK_CLASS_TYPE (object_class),
619 GTK_SIGNAL_OFFSET (GtkWidgetClass, style_set),
620 gtk_marshal_VOID__OBJECT,
623 widget_signals[DIRECTION_CHANGED] =
624 gtk_signal_new ("direction_changed",
626 GTK_CLASS_TYPE (object_class),
627 GTK_SIGNAL_OFFSET (GtkWidgetClass, direction_changed),
628 gtk_marshal_VOID__ENUM,
630 GTK_TYPE_TEXT_DIRECTION);
631 widget_signals[ADD_ACCELERATOR] =
632 gtk_accel_group_create_add (GTK_CLASS_TYPE (object_class), GTK_RUN_LAST,
633 GTK_SIGNAL_OFFSET (GtkWidgetClass, add_accelerator));
634 widget_signals[REMOVE_ACCELERATOR] =
635 gtk_accel_group_create_remove (GTK_CLASS_TYPE (object_class), GTK_RUN_LAST,
636 GTK_SIGNAL_OFFSET (GtkWidgetClass, remove_accelerator));
637 widget_signals[ACTIVATE_MNEMONIC] =
638 g_signal_newc ("mnemonic_activate",
639 GTK_CLASS_TYPE (object_class),
641 GTK_SIGNAL_OFFSET (GtkWidgetClass, mnemonic_activate),
642 _gtk_boolean_handled_accumulator, NULL,
643 gtk_marshal_BOOLEAN__BOOLEAN,
646 widget_signals[GRAB_FOCUS] =
647 gtk_signal_new ("grab_focus",
648 GTK_RUN_LAST | GTK_RUN_ACTION,
649 GTK_CLASS_TYPE (object_class),
650 GTK_SIGNAL_OFFSET (GtkWidgetClass, grab_focus),
651 gtk_marshal_VOID__VOID,
653 widget_signals[EVENT] =
654 g_signal_newc ("event",
655 G_TYPE_FROM_CLASS(object_class),
657 G_STRUCT_OFFSET(GtkWidgetClass, event),
658 _gtk_boolean_handled_accumulator, NULL,
659 gtk_marshal_BOOLEAN__BOXED,
662 widget_signals[BUTTON_PRESS_EVENT] =
663 g_signal_newc ("button_press_event",
664 G_TYPE_FROM_CLASS(object_class),
666 G_STRUCT_OFFSET(GtkWidgetClass, button_press_event),
667 _gtk_boolean_handled_accumulator, NULL,
668 gtk_marshal_BOOLEAN__BOXED,
671 widget_signals[BUTTON_RELEASE_EVENT] =
672 g_signal_newc ("button_release_event",
673 G_TYPE_FROM_CLASS(object_class),
675 G_STRUCT_OFFSET(GtkWidgetClass, button_release_event),
676 _gtk_boolean_handled_accumulator, NULL,
677 gtk_marshal_BOOLEAN__BOXED,
680 widget_signals[SCROLL_EVENT] =
681 g_signal_newc ("scroll_event",
682 G_TYPE_FROM_CLASS(object_class),
684 G_STRUCT_OFFSET(GtkWidgetClass, scroll_event),
685 _gtk_boolean_handled_accumulator, NULL,
686 gtk_marshal_BOOLEAN__BOXED,
689 widget_signals[MOTION_NOTIFY_EVENT] =
690 g_signal_newc ("motion_notify_event",
691 G_TYPE_FROM_CLASS(object_class),
693 G_STRUCT_OFFSET(GtkWidgetClass, motion_notify_event),
694 _gtk_boolean_handled_accumulator, NULL,
695 gtk_marshal_BOOLEAN__BOXED,
698 widget_signals[DELETE_EVENT] =
699 g_signal_newc ("delete_event",
700 G_TYPE_FROM_CLASS(object_class),
702 G_STRUCT_OFFSET(GtkWidgetClass, delete_event),
703 _gtk_boolean_handled_accumulator, NULL,
704 gtk_marshal_BOOLEAN__BOXED,
707 widget_signals[DESTROY_EVENT] =
708 g_signal_newc ("destroy_event",
709 G_TYPE_FROM_CLASS(object_class),
711 G_STRUCT_OFFSET(GtkWidgetClass, destroy_event),
712 _gtk_boolean_handled_accumulator, NULL,
713 gtk_marshal_BOOLEAN__BOXED,
716 widget_signals[EXPOSE_EVENT] =
717 g_signal_newc ("expose_event",
718 G_TYPE_FROM_CLASS(object_class),
720 G_STRUCT_OFFSET(GtkWidgetClass, expose_event),
721 _gtk_boolean_handled_accumulator, NULL,
722 gtk_marshal_BOOLEAN__BOXED,
725 widget_signals[KEY_PRESS_EVENT] =
726 g_signal_newc ("key_press_event",
727 G_TYPE_FROM_CLASS(object_class),
729 G_STRUCT_OFFSET(GtkWidgetClass, key_press_event),
730 _gtk_boolean_handled_accumulator, NULL,
731 gtk_marshal_BOOLEAN__BOXED,
734 widget_signals[KEY_RELEASE_EVENT] =
735 g_signal_newc ("key_release_event",
736 G_TYPE_FROM_CLASS(object_class),
738 G_STRUCT_OFFSET(GtkWidgetClass, key_release_event),
739 _gtk_boolean_handled_accumulator, NULL,
740 gtk_marshal_BOOLEAN__BOXED,
743 widget_signals[ENTER_NOTIFY_EVENT] =
744 g_signal_newc ("enter_notify_event",
745 G_TYPE_FROM_CLASS(object_class),
747 G_STRUCT_OFFSET(GtkWidgetClass, enter_notify_event),
748 _gtk_boolean_handled_accumulator, NULL,
749 gtk_marshal_BOOLEAN__BOXED,
752 widget_signals[LEAVE_NOTIFY_EVENT] =
753 g_signal_newc ("leave_notify_event",
754 G_TYPE_FROM_CLASS(object_class),
756 G_STRUCT_OFFSET(GtkWidgetClass, leave_notify_event),
757 _gtk_boolean_handled_accumulator, NULL,
758 gtk_marshal_BOOLEAN__BOXED,
761 widget_signals[CONFIGURE_EVENT] =
762 g_signal_newc ("configure_event",
763 G_TYPE_FROM_CLASS(object_class),
765 G_STRUCT_OFFSET(GtkWidgetClass, configure_event),
766 _gtk_boolean_handled_accumulator, NULL,
767 gtk_marshal_BOOLEAN__BOXED,
770 widget_signals[FOCUS_IN_EVENT] =
771 g_signal_newc ("focus_in_event",
772 G_TYPE_FROM_CLASS(object_class),
774 G_STRUCT_OFFSET(GtkWidgetClass, focus_in_event),
775 _gtk_boolean_handled_accumulator, NULL,
776 gtk_marshal_BOOLEAN__BOXED,
779 widget_signals[FOCUS_OUT_EVENT] =
780 g_signal_newc ("focus_out_event",
781 G_TYPE_FROM_CLASS(object_class),
783 G_STRUCT_OFFSET(GtkWidgetClass, focus_out_event),
784 _gtk_boolean_handled_accumulator, NULL,
785 gtk_marshal_BOOLEAN__BOXED,
788 widget_signals[MAP_EVENT] =
789 g_signal_newc ("map_event",
790 G_TYPE_FROM_CLASS(object_class),
792 G_STRUCT_OFFSET(GtkWidgetClass, map_event),
793 _gtk_boolean_handled_accumulator, NULL,
794 gtk_marshal_BOOLEAN__BOXED,
797 widget_signals[UNMAP_EVENT] =
798 g_signal_newc ("unmap_event",
799 G_TYPE_FROM_CLASS(object_class),
801 G_STRUCT_OFFSET(GtkWidgetClass, unmap_event),
802 _gtk_boolean_handled_accumulator, NULL,
803 gtk_marshal_BOOLEAN__BOXED,
806 widget_signals[PROPERTY_NOTIFY_EVENT] =
807 g_signal_newc ("property_notify_event",
808 G_TYPE_FROM_CLASS(object_class),
810 G_STRUCT_OFFSET(GtkWidgetClass, property_notify_event),
811 _gtk_boolean_handled_accumulator, NULL,
812 gtk_marshal_BOOLEAN__BOXED,
815 widget_signals[SELECTION_CLEAR_EVENT] =
816 g_signal_newc ("selection_clear_event",
817 G_TYPE_FROM_CLASS(object_class),
819 G_STRUCT_OFFSET(GtkWidgetClass, selection_clear_event),
820 _gtk_boolean_handled_accumulator, NULL,
821 gtk_marshal_BOOLEAN__BOXED,
824 widget_signals[SELECTION_REQUEST_EVENT] =
825 g_signal_newc ("selection_request_event",
826 G_TYPE_FROM_CLASS(object_class),
828 G_STRUCT_OFFSET(GtkWidgetClass, selection_request_event),
829 _gtk_boolean_handled_accumulator, NULL,
830 gtk_marshal_BOOLEAN__BOXED,
833 widget_signals[SELECTION_NOTIFY_EVENT] =
834 g_signal_newc ("selection_notify_event",
835 G_TYPE_FROM_CLASS(object_class),
837 G_STRUCT_OFFSET(GtkWidgetClass, selection_notify_event),
838 _gtk_boolean_handled_accumulator, NULL,
839 gtk_marshal_BOOLEAN__BOXED,
842 widget_signals[SELECTION_RECEIVED] =
843 gtk_signal_new ("selection_received",
845 GTK_CLASS_TYPE (object_class),
846 GTK_SIGNAL_OFFSET (GtkWidgetClass, selection_received),
847 gtk_marshal_VOID__BOXED_UINT,
849 GTK_TYPE_SELECTION_DATA,
851 widget_signals[SELECTION_GET] =
852 gtk_signal_new ("selection_get",
854 GTK_CLASS_TYPE (object_class),
855 GTK_SIGNAL_OFFSET (GtkWidgetClass, selection_get),
856 gtk_marshal_VOID__BOXED_UINT_UINT,
858 GTK_TYPE_SELECTION_DATA,
861 widget_signals[PROXIMITY_IN_EVENT] =
862 g_signal_newc ("proximity_in_event",
863 G_TYPE_FROM_CLASS(object_class),
865 G_STRUCT_OFFSET(GtkWidgetClass, proximity_in_event),
866 _gtk_boolean_handled_accumulator, NULL,
867 gtk_marshal_BOOLEAN__BOXED,
870 widget_signals[PROXIMITY_OUT_EVENT] =
871 g_signal_newc ("proximity_out_event",
872 G_TYPE_FROM_CLASS(object_class),
874 G_STRUCT_OFFSET(GtkWidgetClass, proximity_out_event),
875 _gtk_boolean_handled_accumulator, NULL,
876 gtk_marshal_BOOLEAN__BOXED,
879 widget_signals[DRAG_LEAVE] =
880 gtk_signal_new ("drag_leave",
882 GTK_CLASS_TYPE (object_class),
883 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_leave),
884 gtk_marshal_VOID__OBJECT_UINT,
886 GDK_TYPE_DRAG_CONTEXT,
888 widget_signals[DRAG_BEGIN] =
889 gtk_signal_new ("drag_begin",
891 GTK_CLASS_TYPE (object_class),
892 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_begin),
893 gtk_marshal_VOID__OBJECT,
895 GDK_TYPE_DRAG_CONTEXT);
896 widget_signals[DRAG_END] =
897 gtk_signal_new ("drag_end",
899 GTK_CLASS_TYPE (object_class),
900 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_end),
901 gtk_marshal_VOID__OBJECT,
903 GDK_TYPE_DRAG_CONTEXT);
904 widget_signals[DRAG_DATA_DELETE] =
905 gtk_signal_new ("drag_data_delete",
907 GTK_CLASS_TYPE (object_class),
908 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_data_delete),
909 gtk_marshal_VOID__OBJECT,
911 GDK_TYPE_DRAG_CONTEXT);
912 widget_signals[DRAG_MOTION] =
913 g_signal_newc ("drag_motion",
914 G_TYPE_FROM_CLASS(object_class),
916 G_STRUCT_OFFSET(GtkWidgetClass, drag_motion),
917 _gtk_boolean_handled_accumulator, NULL,
918 gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
920 GDK_TYPE_DRAG_CONTEXT,
924 widget_signals[DRAG_DROP] =
925 g_signal_newc ("drag_drop",
926 G_TYPE_FROM_CLASS(object_class),
928 G_STRUCT_OFFSET(GtkWidgetClass, drag_drop),
929 _gtk_boolean_handled_accumulator, NULL,
930 gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
932 GDK_TYPE_DRAG_CONTEXT,
936 widget_signals[DRAG_DATA_GET] =
937 gtk_signal_new ("drag_data_get",
939 GTK_CLASS_TYPE (object_class),
940 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_data_get),
941 gtk_marshal_VOID__OBJECT_BOXED_UINT_UINT,
943 GDK_TYPE_DRAG_CONTEXT,
944 GTK_TYPE_SELECTION_DATA,
947 widget_signals[DRAG_DATA_RECEIVED] =
948 gtk_signal_new ("drag_data_received",
950 GTK_CLASS_TYPE (object_class),
951 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_data_received),
952 gtk_marshal_VOID__OBJECT_INT_INT_BOXED_UINT_UINT,
954 GDK_TYPE_DRAG_CONTEXT,
957 GTK_TYPE_SELECTION_DATA,
960 widget_signals[VISIBILITY_NOTIFY_EVENT] =
961 g_signal_newc ("visibility_notify_event",
962 G_TYPE_FROM_CLASS(object_class),
964 G_STRUCT_OFFSET(GtkWidgetClass, visibility_notify_event),
965 _gtk_boolean_handled_accumulator, NULL,
966 gtk_marshal_BOOLEAN__BOXED,
969 widget_signals[CLIENT_EVENT] =
970 g_signal_newc ("client_event",
971 G_TYPE_FROM_CLASS(object_class),
973 G_STRUCT_OFFSET(GtkWidgetClass, client_event),
974 _gtk_boolean_handled_accumulator, NULL,
975 gtk_marshal_BOOLEAN__BOXED,
978 widget_signals[NO_EXPOSE_EVENT] =
979 g_signal_newc ("no_expose_event",
980 G_TYPE_FROM_CLASS(object_class),
982 G_STRUCT_OFFSET(GtkWidgetClass, no_expose_event),
983 _gtk_boolean_handled_accumulator, NULL,
984 gtk_marshal_BOOLEAN__BOXED,
987 widget_signals[WINDOW_STATE_EVENT] =
988 g_signal_newc ("window_state_event",
989 G_TYPE_FROM_CLASS(object_class),
991 G_STRUCT_OFFSET(GtkWidgetClass, window_state_event),
992 _gtk_boolean_handled_accumulator, NULL,
993 gtk_marshal_BOOLEAN__BOXED,
996 widget_signals[POPUP_MENU] =
997 gtk_signal_new ("popup_menu",
998 GTK_RUN_LAST | GTK_RUN_ACTION,
999 GTK_CLASS_TYPE (object_class),
1000 GTK_SIGNAL_OFFSET (GtkWidgetClass, popup_menu),
1001 gtk_marshal_NONE__NONE,
1004 binding_set = gtk_binding_set_by_class (klass);
1006 gtk_binding_entry_add_signal (binding_set, GDK_F10, GDK_SHIFT_MASK,
1009 gtk_binding_entry_add_signal (binding_set, GDK_Menu, 0,
1012 gtk_widget_class_install_style_property (klass,
1013 g_param_spec_boolean ("interior_focus",
1014 _("Interior Focus"),
1015 _("Whether to draw the focus indicator inside widgets."),
1021 gtk_widget_set_property (GObject *object,
1023 const GValue *value,
1027 GtkWidgetAuxInfo *aux_info;
1029 widget = GTK_WIDGET (object);
1033 guint32 saved_flags;
1036 gtk_widget_set_name (widget, g_value_get_string (value));
1039 gtk_container_add (GTK_CONTAINER (g_value_get_object (value)), widget);
1042 aux_info = _gtk_widget_get_aux_info (widget, TRUE);
1043 if (g_value_get_int (value) == -1)
1044 aux_info->x_set = FALSE;
1047 aux_info->x_set = TRUE;
1048 aux_info->x = g_value_get_int (value);
1050 gtk_widget_do_uposition (widget);
1053 aux_info = _gtk_widget_get_aux_info (widget, TRUE);
1054 if (g_value_get_int (value) == -1)
1055 aux_info->y_set = FALSE;
1058 aux_info->y_set = TRUE;
1059 aux_info->y = g_value_get_int (value);
1061 gtk_widget_do_uposition (widget);
1064 gtk_widget_set_usize (widget, g_value_get_int (value), -2);
1067 gtk_widget_set_usize (widget, -2, g_value_get_int (value));
1070 if (g_value_get_boolean (value))
1071 gtk_widget_show (widget);
1073 gtk_widget_hide (widget);
1075 case PROP_SENSITIVE:
1076 gtk_widget_set_sensitive (widget, g_value_get_boolean (value));
1078 case PROP_APP_PAINTABLE:
1079 gtk_widget_set_app_paintable (widget, g_value_get_boolean (value));
1081 case PROP_CAN_FOCUS:
1082 saved_flags = GTK_WIDGET_FLAGS (widget);
1083 if (g_value_get_boolean (value))
1084 GTK_WIDGET_SET_FLAGS (widget, GTK_CAN_FOCUS);
1086 GTK_WIDGET_UNSET_FLAGS (widget, GTK_CAN_FOCUS);
1087 if (saved_flags != GTK_WIDGET_FLAGS (widget))
1088 gtk_widget_queue_resize (widget);
1090 case PROP_HAS_FOCUS:
1091 if (g_value_get_boolean (value))
1092 gtk_widget_grab_focus (widget);
1094 case PROP_CAN_DEFAULT:
1095 saved_flags = GTK_WIDGET_FLAGS (widget);
1096 if (g_value_get_boolean (value))
1097 GTK_WIDGET_SET_FLAGS (widget, GTK_CAN_DEFAULT);
1099 GTK_WIDGET_UNSET_FLAGS (widget, GTK_CAN_DEFAULT);
1100 if (saved_flags != GTK_WIDGET_FLAGS (widget))
1101 gtk_widget_queue_resize (widget);
1103 case PROP_HAS_DEFAULT:
1104 if (g_value_get_boolean (value))
1105 gtk_widget_grab_default (widget);
1107 case PROP_RECEIVES_DEFAULT:
1108 if (g_value_get_boolean (value))
1109 GTK_WIDGET_SET_FLAGS (widget, GTK_RECEIVES_DEFAULT);
1111 GTK_WIDGET_UNSET_FLAGS (widget, GTK_RECEIVES_DEFAULT);
1113 case PROP_COMPOSITE_CHILD:
1114 if (g_value_get_boolean (value))
1115 GTK_WIDGET_SET_FLAGS (widget, GTK_COMPOSITE_CHILD);
1117 GTK_WIDGET_UNSET_FLAGS (widget, GTK_COMPOSITE_CHILD);
1120 gtk_widget_set_style (widget, g_value_get_object (value));
1123 if (!GTK_WIDGET_REALIZED (widget) && !GTK_WIDGET_NO_WINDOW (widget))
1124 gtk_widget_set_events (widget, g_value_get_flags (value));
1126 case PROP_EXTENSION_EVENTS:
1127 gtk_widget_set_extension_events (widget, g_value_get_enum (value));
1134 /*****************************************
1135 * gtk_widget_get_property:
1140 *****************************************/
1143 gtk_widget_get_property (GObject *object,
1150 widget = GTK_WIDGET (object);
1154 GtkWidgetAuxInfo *aux_info;
1156 GdkExtensionMode *modep;
1160 g_value_set_string (value, widget->name);
1162 g_value_set_string (value, "");
1165 g_value_set_object (value, G_OBJECT (widget->parent));
1168 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
1169 if (!aux_info || !aux_info->x_set)
1170 g_value_set_int (value, -1);
1172 g_value_set_int (value, aux_info->x);
1175 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
1176 if (!aux_info || !aux_info->y_set)
1177 g_value_set_int (value, -1);
1179 g_value_set_int (value, aux_info->y);
1182 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
1184 g_value_set_int (value, -1);
1186 g_value_set_int (value, aux_info->width);
1189 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
1191 g_value_set_int (value, -1);
1193 g_value_set_int (value, aux_info->height);
1196 g_value_set_boolean (value, (GTK_WIDGET_VISIBLE (widget) != FALSE));
1198 case PROP_SENSITIVE:
1199 g_value_set_boolean (value, (GTK_WIDGET_SENSITIVE (widget) != FALSE));
1201 case PROP_APP_PAINTABLE:
1202 g_value_set_boolean (value, (GTK_WIDGET_APP_PAINTABLE (widget) != FALSE));
1204 case PROP_CAN_FOCUS:
1205 g_value_set_boolean (value, (GTK_WIDGET_CAN_FOCUS (widget) != FALSE));
1207 case PROP_HAS_FOCUS:
1208 g_value_set_boolean (value, (GTK_WIDGET_HAS_FOCUS (widget) != FALSE));
1210 case PROP_CAN_DEFAULT:
1211 g_value_set_boolean (value, (GTK_WIDGET_CAN_DEFAULT (widget) != FALSE));
1213 case PROP_HAS_DEFAULT:
1214 g_value_set_boolean (value, (GTK_WIDGET_HAS_DEFAULT (widget) != FALSE));
1216 case PROP_RECEIVES_DEFAULT:
1217 g_value_set_boolean (value, (GTK_WIDGET_RECEIVES_DEFAULT (widget) != FALSE));
1219 case PROP_COMPOSITE_CHILD:
1220 g_value_set_boolean (value, (GTK_WIDGET_COMPOSITE_CHILD (widget) != FALSE));
1223 g_value_set_object (value, G_OBJECT (gtk_widget_get_style (widget)));
1226 eventp = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_event_mask);
1228 g_value_set_int (value, 0);
1230 g_value_set_int (value, *eventp);
1232 case PROP_EXTENSION_EVENTS:
1233 modep = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_extension_event_mode);
1235 g_value_set_enum (value, 0);
1237 g_value_set_enum (value, (GdkExtensionMode) *modep);
1240 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1245 /*****************************************
1251 *****************************************/
1254 gtk_widget_init (GtkWidget *widget)
1256 GdkColormap *colormap;
1258 GTK_PRIVATE_FLAGS (widget) = 0;
1259 widget->state = GTK_STATE_NORMAL;
1260 widget->saved_state = GTK_STATE_NORMAL;
1261 widget->name = NULL;
1262 widget->requisition.width = 0;
1263 widget->requisition.height = 0;
1264 widget->allocation.x = -1;
1265 widget->allocation.y = -1;
1266 widget->allocation.width = 1;
1267 widget->allocation.height = 1;
1268 widget->window = NULL;
1269 widget->parent = NULL;
1271 GTK_WIDGET_SET_FLAGS (widget,
1273 GTK_PARENT_SENSITIVE |
1274 (composite_child_stack ? GTK_COMPOSITE_CHILD : 0) |
1275 GTK_DOUBLE_BUFFERED);
1277 widget->style = gtk_widget_peek_style ();
1278 gtk_style_ref (widget->style);
1280 colormap = gtk_widget_peek_colormap ();
1282 if (colormap != gtk_widget_get_default_colormap ())
1283 gtk_widget_set_colormap (widget, colormap);
1289 * @type: type ID of the widget to create
1290 * @first_property_name: name of first property to set
1291 * @Varargs: value of first property, followed by more properties, NULL-terminated
1293 * This is a convenience function for creating a widget and setting
1294 * its properties in one go. For example you might write:
1295 * gtk_widget_new (GTK_TYPE_LABEL, "label", "Hello World", "xalign",
1296 * 0.0, NULL) to create a left-aligned label. Equivalent to
1297 * gtk_object_new(), but returns a widget so you don't have to
1298 * cast the object yourself.
1300 * Return value: a new #GtkWidget of type @widget_type
1303 gtk_widget_new (GtkType type,
1304 const gchar *first_property_name,
1310 g_return_val_if_fail (gtk_type_is_a (type, GTK_TYPE_WIDGET), NULL);
1312 va_start (var_args, first_property_name);
1313 widget = g_object_new_valist (type, first_property_name, var_args);
1321 * @widget: a #GtkWidget
1322 * @first_property_name: name of first property to set
1323 * @Varargs: value of first property, followed by more properties, NULL-terminated
1325 * Like gtk_object_set() - there's no reason to use this instead of
1329 gtk_widget_set (GtkWidget *widget,
1330 const gchar *first_property_name,
1335 g_return_if_fail (GTK_IS_WIDGET (widget));
1337 va_start (var_args, first_property_name);
1338 g_object_set_valist (G_OBJECT (widget), first_property_name, var_args);
1343 gtk_widget_queue_clear_child (GtkWidget *widget)
1347 parent = widget->parent;
1348 if (parent && GTK_WIDGET_DRAWABLE (parent))
1349 gtk_widget_queue_clear_area (parent,
1350 widget->allocation.x,
1351 widget->allocation.y,
1352 widget->allocation.width,
1353 widget->allocation.height);
1357 * gtk_widget_unparent:
1358 * @widget: a #GtkWidget
1360 * This function is only for use in widget implementations.
1361 * Should be called by implementations of the remove method
1362 * on #GtkContainer, to dissociate a child from the container.
1365 gtk_widget_unparent (GtkWidget *widget)
1367 GtkWidget *toplevel;
1368 GtkWidget *old_parent;
1370 g_return_if_fail (widget != NULL);
1371 g_return_if_fail (GTK_IS_WIDGET (widget));
1372 if (widget->parent == NULL)
1375 /* keep this function in sync with gtk_menu_detach()
1378 g_object_freeze_notify (G_OBJECT (widget));
1380 /* unset focused and default children properly, this code
1381 * should eventually move into some gtk_window_unparent_branch() or
1385 toplevel = gtk_widget_get_toplevel (widget);
1386 if (GTK_CONTAINER (widget->parent)->focus_child == widget)
1388 gtk_container_set_focus_child (GTK_CONTAINER (widget->parent), NULL);
1390 if (GTK_IS_WINDOW (toplevel))
1394 child = GTK_WINDOW (toplevel)->focus_widget;
1396 while (child && child != widget)
1397 child = child->parent;
1399 if (child == widget)
1400 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
1403 if (GTK_IS_WINDOW (toplevel))
1407 child = GTK_WINDOW (toplevel)->default_widget;
1409 while (child && child != widget)
1410 child = child->parent;
1412 if (child == widget)
1413 gtk_window_set_default (GTK_WINDOW (toplevel), NULL);
1416 if (GTK_IS_RESIZE_CONTAINER (widget))
1417 gtk_container_clear_resize_widgets (GTK_CONTAINER (widget));
1419 /* Remove the widget and all its children from any ->resize_widgets list
1420 * of all the parents in our branch. This code should move into gtkcontainer.c
1421 * somwhen, since we mess around with ->resize_widgets, which is
1422 * actually not of our business.
1424 * Two ways to make this prettier:
1425 * Write a g_slist_conditional_remove (GSList, gboolean (*)(gpointer))
1426 * Change resize_widgets to a GList
1428 toplevel = widget->parent;
1434 if (!GTK_CONTAINER (toplevel)->resize_widgets)
1436 toplevel = toplevel->parent;
1441 slist = GTK_CONTAINER (toplevel)->resize_widgets;
1453 while (parent && (parent != widget))
1454 parent = parent->parent;
1456 if (parent == widget)
1458 GTK_PRIVATE_UNSET_FLAG (child, GTK_RESIZE_NEEDED);
1463 GTK_CONTAINER (toplevel)->resize_widgets = slist;
1465 g_slist_free_1 (last);
1471 toplevel = toplevel->parent;
1474 gtk_widget_queue_clear_child (widget);
1476 /* Reset the width and height here, to force reallocation if we
1477 * get added back to a new parent. This won't work if our new
1478 * allocation is smaller than 1x1 and we actually want a size of 1x1...
1479 * (would 0x0 be OK here?)
1481 widget->allocation.width = 1;
1482 widget->allocation.height = 1;
1484 if (GTK_WIDGET_REALIZED (widget) && !GTK_WIDGET_IN_REPARENT (widget))
1485 gtk_widget_unrealize (widget);
1487 old_parent = widget->parent;
1488 widget->parent = NULL;
1489 gtk_widget_set_parent_window (widget, NULL);
1490 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[PARENT_SET], old_parent);
1491 gtk_widget_propagate_hierarchy_changed (widget, NULL);
1492 g_object_notify (G_OBJECT (widget), "parent");
1493 g_object_thaw_notify (G_OBJECT (widget));
1494 gtk_widget_unref (widget);
1498 * gtk_widget_destroy:
1499 * @widget: a #GtkWidget
1501 * Destroys a widget. Equivalent to gtk_object_destroy(), except that
1502 * you don't have to cast the widget to #GtkObject. When a widget is
1503 * destroyed, it will break any references it holds to other objects.
1504 * If the widget is inside a container, the widget will be removed
1505 * from the container. If the widget is a toplevel (derived from
1506 * #GtkWindow), it will be removed from the list of toplevels, and the
1507 * reference GTK+ holds to it will be removed. Removing a
1508 * widget from its container or the list of toplevels results in the
1509 * widget being finalized, unless you've added additional references
1510 * to the widget with gtk_object_ref().
1512 * In most cases, only toplevel widgets (windows) require explicit
1513 * destruction, because when you destroy a toplevel its children will
1514 * be destroyed as well.
1518 gtk_widget_destroy (GtkWidget *widget)
1520 g_return_if_fail (widget != NULL);
1521 g_return_if_fail (GTK_IS_WIDGET (widget));
1523 gtk_object_destroy ((GtkObject*) widget);
1527 * gtk_widget_destroyed:
1528 * @widget: a #GtkWidget
1529 * @widget_pointer: address of a variable that contains @widget
1531 * This function sets *@widget_pointer to NULL if @widget_pointer !=
1532 * NULL. It's intended to be used as a callback connected to the
1533 * "destroy" signal of a widget. You connect gtk_widget_destroyed()
1534 * as a signal handler, and pass the address of your widget variable
1535 * as user data. Then when the widget is destroyed, the variable will
1536 * be set to NULL. Useful for example to avoid multiple copies
1537 * of the same dialog.
1541 gtk_widget_destroyed (GtkWidget *widget,
1542 GtkWidget **widget_pointer)
1544 /* Don't make any assumptions about the
1546 * Even check widget_pointer.
1549 *widget_pointer = NULL;
1554 * @widget: a #GtkWidget
1556 * Flags a widget to be displayed. Any widget that isn't shown will
1557 * not appear on the screen. If you want to show all the widgets in a
1558 * container, it's easier to call gtk_widget_show_all() on the
1559 * container, instead of individually showing the widgets.
1561 * Remember that you have to show the containers containing a widget,
1562 * in addition to the widget itself, before it will appear onscreen.
1564 * When a toplevel container is shown, it is immediately realized and
1565 * mapped; other shown widgets are realized and mapped when their
1566 * toplevel container is realized and mapped.
1570 gtk_widget_show (GtkWidget *widget)
1572 g_return_if_fail (widget != NULL);
1573 g_return_if_fail (GTK_IS_WIDGET (widget));
1575 if (!GTK_WIDGET_VISIBLE (widget))
1577 g_object_ref (G_OBJECT (widget));
1578 if (!GTK_WIDGET_TOPLEVEL (widget))
1579 gtk_widget_queue_resize (widget);
1580 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[SHOW]);
1581 g_object_notify (G_OBJECT (widget), "visible");
1582 g_object_unref (G_OBJECT (widget));
1587 gtk_widget_real_show (GtkWidget *widget)
1589 g_return_if_fail (widget != NULL);
1590 g_return_if_fail (GTK_IS_WIDGET (widget));
1592 if (!GTK_WIDGET_VISIBLE (widget))
1594 GTK_WIDGET_SET_FLAGS (widget, GTK_VISIBLE);
1596 if (widget->parent &&
1597 GTK_WIDGET_MAPPED (widget->parent) &&
1598 !GTK_WIDGET_MAPPED (widget))
1599 gtk_widget_map (widget);
1604 gtk_widget_show_map_callback (GtkWidget *widget, GdkEvent *event, gint *flag)
1607 gtk_signal_disconnect_by_data (GTK_OBJECT (widget), flag);
1611 * gtk_widget_show_now:
1612 * @widget: a #GtkWidget
1614 * Shows a widget. If the widget is an unmapped toplevel widget
1615 * (i.e. a #GtkWindow that has not yet been shown), enter the main
1616 * loop and wait for the window to actually be mapped. Be careful;
1617 * because the main loop is running, anything can happen during
1621 gtk_widget_show_now (GtkWidget *widget)
1625 g_return_if_fail (widget != NULL);
1626 g_return_if_fail (GTK_IS_WIDGET (widget));
1628 /* make sure we will get event */
1629 if (!GTK_WIDGET_MAPPED (widget) &&
1630 GTK_WIDGET_TOPLEVEL (widget))
1632 gtk_widget_show (widget);
1634 gtk_signal_connect (GTK_OBJECT (widget), "map_event",
1635 GTK_SIGNAL_FUNC (gtk_widget_show_map_callback),
1639 gtk_main_iteration();
1642 gtk_widget_show (widget);
1647 * @widget: a #GtkWidget
1649 * Reverses the effects of gtk_widget_show(), causing the widget to be
1650 * hidden (invisible to the user).
1653 gtk_widget_hide (GtkWidget *widget)
1655 g_return_if_fail (widget != NULL);
1656 g_return_if_fail (GTK_IS_WIDGET (widget));
1658 if (GTK_WIDGET_VISIBLE (widget))
1660 gtk_widget_ref (widget);
1661 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[HIDE]);
1662 if (!GTK_WIDGET_TOPLEVEL (widget) && !GTK_OBJECT_DESTROYED (widget))
1663 gtk_widget_queue_resize (widget);
1664 g_object_notify (G_OBJECT (widget), "visible");
1665 gtk_widget_unref (widget);
1670 gtk_widget_real_hide (GtkWidget *widget)
1672 g_return_if_fail (widget != NULL);
1673 g_return_if_fail (GTK_IS_WIDGET (widget));
1675 if (GTK_WIDGET_VISIBLE (widget))
1677 GTK_WIDGET_UNSET_FLAGS (widget, GTK_VISIBLE);
1679 if (GTK_WIDGET_MAPPED (widget))
1680 gtk_widget_unmap (widget);
1685 * gtk_widget_hide_on_delete:
1686 * @widget: a #GtkWidget
1688 * Utility function; intended to be connected to the "delete_event"
1689 * signal on a #GtkWindow. The function calls gtk_widget_hide() on its
1690 * argument, then returns %TRUE. If connected to "delete_event",
1691 * the result is that clicking the window manager close button for
1692 * will hide but not destroy the window. By default, GTK+ destroys
1693 * windows when "delete_event" is received.
1695 * Return value: %TRUE
1698 gtk_widget_hide_on_delete (GtkWidget *widget)
1700 g_return_val_if_fail (widget != NULL, FALSE);
1701 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
1703 gtk_widget_hide (widget);
1709 * gtk_widget_show_all:
1710 * @widget: a #GtkWidget
1712 * Recursively shows a widget, and any child widgets (if the widget is
1716 gtk_widget_show_all (GtkWidget *widget)
1718 GtkWidgetClass *class;
1720 g_return_if_fail (widget != NULL);
1721 g_return_if_fail (GTK_IS_WIDGET (widget));
1723 class = GTK_WIDGET_GET_CLASS (widget);
1725 if (class->show_all)
1726 class->show_all (widget);
1730 * gtk_widget_hide_all:
1731 * @widget: a #GtkWidget
1733 * Recursively hides a widget and any child widgets.
1736 gtk_widget_hide_all (GtkWidget *widget)
1738 GtkWidgetClass *class;
1740 g_return_if_fail (widget != NULL);
1741 g_return_if_fail (GTK_IS_WIDGET (widget));
1743 class = GTK_WIDGET_GET_CLASS (widget);
1745 if (class->hide_all)
1746 class->hide_all (widget);
1751 * @widget: a #GtkWidget
1753 * This function is only for use in widget implementations. Causes
1754 * a widget to be mapped if it isn't already.
1758 gtk_widget_map (GtkWidget *widget)
1760 g_return_if_fail (GTK_IS_WIDGET (widget));
1761 g_return_if_fail (GTK_WIDGET_VISIBLE (widget) == TRUE);
1763 if (!GTK_WIDGET_MAPPED (widget))
1765 if (!GTK_WIDGET_REALIZED (widget))
1766 gtk_widget_realize (widget);
1768 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[MAP]);
1770 if (GTK_WIDGET_NO_WINDOW (widget))
1771 gtk_widget_queue_draw (widget);
1777 * @widget: a #GtkWidget
1779 * This function is only for use in widget implementations. Causes
1780 * a widget to be unmapped if it's currently mapped.
1784 gtk_widget_unmap (GtkWidget *widget)
1786 g_return_if_fail (widget != NULL);
1787 g_return_if_fail (GTK_IS_WIDGET (widget));
1789 if (GTK_WIDGET_MAPPED (widget))
1791 if (GTK_WIDGET_NO_WINDOW (widget))
1792 gtk_widget_queue_clear_child (widget);
1793 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[UNMAP]);
1798 * gtk_widget_realize:
1799 * @widget: a #GtkWidget
1801 * Creates the GDK (windowing system) resources associated with a
1802 * widget. For example, widget->window will be created when a widget
1803 * is realized. Normally realization happens implicitly; if you show
1804 * a widget and all its parent containers, then the widget will be
1805 * realized and mapped automatically.
1807 * Realizing a widget requires all
1808 * the widget's parent widgets to be realized; calling
1809 * gtk_widget_realize() realizes the widget's parents in addition to
1810 * @widget itself. If a widget is not yet inside a toplevel window
1811 * when you realize it, bad things will happen.
1813 * This function is primarily used in widget implementations, and
1814 * isn't very useful otherwise. Many times when you think you might
1815 * need it, a better approach is to connect to a signal that will be
1816 * called after the widget is realized automatically, such as
1817 * "expose_event". Or simply gtk_signal_connect_after() to the
1822 gtk_widget_realize (GtkWidget *widget)
1825 GdkExtensionMode mode;
1826 GtkWidgetShapeInfo *shape_info;
1828 g_return_if_fail (widget != NULL);
1829 g_return_if_fail (GTK_IS_WIDGET (widget));
1831 if (!GTK_WIDGET_REALIZED (widget))
1834 if (GTK_IS_CONTAINER (widget) && !GTK_WIDGET_NO_WINDOW (widget))
1835 g_message ("gtk_widget_realize(%s)", gtk_type_name (GTK_WIDGET_TYPE (widget)));
1838 if (widget->parent == NULL &&
1839 !GTK_WIDGET_TOPLEVEL (widget))
1840 g_warning ("Calling gtk_widget_realize() on a widget that isn't "
1841 "inside a toplevel window is not going to work very well. "
1842 "Widgets must be inside a toplevel container before realizing them.");
1844 if (widget->parent && !GTK_WIDGET_REALIZED (widget->parent))
1845 gtk_widget_realize (widget->parent);
1847 gtk_widget_ensure_style (widget);
1849 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[REALIZE]);
1851 if (GTK_WIDGET_HAS_SHAPE_MASK (widget))
1853 shape_info = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_shape_info);
1854 gdk_window_shape_combine_mask (widget->window,
1855 shape_info->shape_mask,
1856 shape_info->offset_x,
1857 shape_info->offset_y);
1860 if (!GTK_WIDGET_NO_WINDOW (widget))
1862 mode = gtk_widget_get_extension_events (widget);
1863 if (mode != GDK_EXTENSION_EVENTS_NONE)
1865 events = gtk_widget_get_events (widget);
1866 gdk_input_set_extension_events (widget->window, events, mode);
1874 * gtk_widget_unrealize:
1875 * @widget: a #GtkWidget
1877 * This function is only useful in widget implementations.
1878 * Causes a widget to be unrealized (frees all GDK resources
1879 * associated with the widget, such as widget->window).
1883 gtk_widget_unrealize (GtkWidget *widget)
1885 g_return_if_fail (widget != NULL);
1886 g_return_if_fail (GTK_IS_WIDGET (widget));
1888 if (GTK_WIDGET_HAS_SHAPE_MASK (widget))
1889 gtk_widget_shape_combine_mask (widget, NULL, -1, -1);
1891 if (GTK_WIDGET_REALIZED (widget))
1893 gtk_widget_ref (widget);
1894 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[UNREALIZE]);
1895 GTK_WIDGET_UNSET_FLAGS (widget, GTK_REALIZED | GTK_MAPPED);
1896 gtk_widget_unref (widget);
1900 /*****************************************
1902 *****************************************/
1905 * gtk_widget_queue_draw_area:
1906 * @widget: a #GtkWidget
1907 * @x: x coordinate of upper-left corner of rectangle to redraw
1908 * @y: y coordinate of upper-left corner of rectangle to redraw
1909 * @width: width of region to draw
1910 * @height: height of region to draw
1912 * Invalidates the rectangular area of @widget defined by @x, @y,
1913 * @width and @height by calling gdk_window_invalidate_rect() on the
1914 * widget's window and all its child windows. Once the main loop
1915 * becomes idle (after the current batch of events has been processed,
1916 * roughly), the window will receive expose events for the union of
1917 * all regions that have been invalidated.
1919 * Normally you would only use this function in widget
1920 * implementations. You might also use it, or
1921 * gdk_window_invalidate_rect() directly, to schedule a redraw of a
1922 * #GtkDrawingArea or some portion thereof.
1924 * Frequently you can just call gdk_window_invalidate_rect() or
1925 * gdk_window_invalidate_region() instead of this function. Those
1926 * functions will invalidate only a single window, instead of the
1927 * widget and all its children.
1929 * The advantage of adding to the invalidated region compared to
1930 * simply drawing immediately is efficiency; using an invalid region
1931 * ensures that you only have to redraw one time.
1935 gtk_widget_queue_draw_area (GtkWidget *widget,
1941 g_return_if_fail (widget != NULL);
1942 g_return_if_fail (GTK_IS_WIDGET (widget));
1944 gtk_widget_queue_clear_area (widget, x, y, width, height);
1948 * gtk_widget_queue_draw:
1949 * @widget: a #GtkWidget
1951 * Equivalent to calling gtk_widget_queue_draw_area() for the
1952 * entire area of a widget.
1956 gtk_widget_queue_draw (GtkWidget *widget)
1958 g_return_if_fail (widget != NULL);
1959 g_return_if_fail (GTK_IS_WIDGET (widget));
1961 gtk_widget_queue_clear (widget);
1964 /* Invalidates the given area (allocation-relative-coordinates)
1965 * in all of the widget's windows
1968 * gtk_widget_queue_clear_area:
1969 * @widget: a #GtkWidget
1970 * @x: x coordinate of upper-left corner of rectangle to redraw
1971 * @y: y coordinate of upper-left corner of rectangle to redraw
1972 * @width: width of region to draw
1973 * @height: height of region to draw
1975 * DEPRECATED. This function is no longer different from
1976 * gtk_widget_queue_draw_area(), though it once was. Now it just calls
1977 * gtk_widget_queue_draw_area(). Originally
1978 * gtk_widget_queue_clear_area() would force a redraw of the
1979 * background for GTK_NO_WINDOW widgets, and
1980 * gtk_widget_queue_draw_area() would not. Now both functions ensure
1981 * the background will be redrawn.
1985 gtk_widget_queue_clear_area (GtkWidget *widget,
1991 GdkRectangle invalid_rect;
1993 g_return_if_fail (widget != NULL);
1994 g_return_if_fail (GTK_IS_WIDGET (widget));
1996 if (!(widget->window && gdk_window_is_viewable (widget->window)))
1999 /* Find the correct widget */
2001 if (!GTK_WIDGET_NO_WINDOW (widget))
2005 /* Translate widget relative to window-relative */
2007 gint wx, wy, wwidth, wheight;
2009 gdk_window_get_position (widget->window, &wx, &wy);
2010 x -= wx - widget->allocation.x;
2011 y -= wy - widget->allocation.y;
2013 gdk_window_get_size (widget->window, &wwidth, &wheight);
2015 if (x + width <= 0 || y + height <= 0 ||
2016 x >= wwidth || y >= wheight)
2027 if (x + width > wwidth)
2029 if (y + height > wheight)
2030 height = wheight - y;
2036 invalid_rect.width = width;
2037 invalid_rect.height = height;
2039 gdk_window_invalidate_rect (widget->window, &invalid_rect, TRUE);
2043 * gtk_widget_queue_clear:
2044 * @widget: a #GtkWidget
2046 * DEPRECATED. Use gtk_widget_queue_draw() instead.
2049 gtk_widget_queue_clear (GtkWidget *widget)
2051 g_return_if_fail (widget != NULL);
2052 g_return_if_fail (GTK_IS_WIDGET (widget));
2054 if (widget->allocation.width || widget->allocation.height)
2056 if (GTK_WIDGET_NO_WINDOW (widget))
2057 gtk_widget_queue_clear_area (widget, widget->allocation.x,
2058 widget->allocation.y,
2059 widget->allocation.width,
2060 widget->allocation.height);
2062 gtk_widget_queue_clear_area (widget, 0, 0,
2063 widget->allocation.width,
2064 widget->allocation.height);
2069 * gtk_widget_queue_resize:
2070 * @widget: a #GtkWidget
2072 * This function is only for use in widget implementations.
2073 * Flags a widget to have its size renegotiated; should
2074 * be called when a widget for some reason has a new size request.
2075 * For example, when you change the text in a #GtkLabel, #GtkLabel
2076 * queues a resize to ensure there's enough space for the new text.
2080 gtk_widget_queue_resize (GtkWidget *widget)
2082 g_return_if_fail (widget != NULL);
2083 g_return_if_fail (GTK_IS_WIDGET (widget));
2085 gtk_widget_queue_clear (widget);
2087 _gtk_size_group_queue_resize (widget);
2092 * @widget: a #GtkWidget
2093 * @area: area to draw
2095 * DEPRECATED. In GTK+ 1.2, this function would immediately render the
2096 * region @area of a widget, by invoking the virtual draw method of a
2097 * widget. In GTK+ 2.0, the draw method is gone, and instead
2098 * gtk_widget_draw() simply invalidates the specified region of the
2099 * widget, then updates the invalid region of the widget immediately.
2100 * Usually you don't want to update the region immediately for
2101 * performance reasons, so in general gtk_widget_queue_draw_area() is
2102 * a better choice if you want to draw a region of a widget.
2106 gtk_widget_draw (GtkWidget *widget,
2109 g_return_if_fail (widget != NULL);
2110 g_return_if_fail (GTK_IS_WIDGET (widget));
2112 if (GTK_WIDGET_DRAWABLE (widget))
2115 gtk_widget_queue_draw_area (widget,
2117 area->width, area->height);
2119 gtk_widget_queue_draw (widget);
2121 gdk_window_process_updates (widget->window, TRUE);
2126 * gtk_widget_size_request:
2127 * @widget: a #GtkWidget
2128 * @requisition: a #GtkRequisition to be filled in
2130 * This function is only used when implementing a #GtkContainer subclass.
2131 * Obtains the preferred size of a widget. The container uses this
2132 * information to arrange its child widgets and decide what size allocations
2133 * to give them with gtk_widget_size_allocate().
2136 gtk_widget_size_request (GtkWidget *widget,
2137 GtkRequisition *requisition)
2139 g_return_if_fail (widget != NULL);
2140 g_return_if_fail (GTK_IS_WIDGET (widget));
2142 #ifdef G_ENABLE_DEBUG
2143 if (requisition == &widget->requisition)
2144 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.");
2145 #endif /* G_ENABLE_DEBUG */
2147 _gtk_size_group_compute_requisition (widget, requisition);
2151 gtk_widget_get_child_requisition (widget, requisition);
2153 gtk_widget_unref (widget);
2158 * gtk_widget_get_child_requisition:
2159 * @widget: a #GtkWidget
2160 * @requisition: a #GtkRequisition to be filled in
2162 * This function is only for use in widget implementations. Obtains
2163 * @widget->requisition, unless someone has forced a particular
2164 * geometry on the widget (e.g. with gtk_widget_set_usize()), in which
2165 * case it returns that geometry instead of the widget's requisition.
2168 gtk_widget_get_child_requisition (GtkWidget *widget,
2169 GtkRequisition *requisition)
2171 _gtk_size_group_get_child_requisition (widget, requisition);
2175 * gtk_widget_size_allocate:
2176 * @widget: a #GtkWidget
2177 * @allocation: position and size to be allocated to @widget
2179 * This function is only used by #GtkContainer subclasses, to assign a size
2180 * and position to their child widgets.
2184 gtk_widget_size_allocate (GtkWidget *widget,
2185 GtkAllocation *allocation)
2187 GtkWidgetAuxInfo *aux_info;
2188 GtkAllocation real_allocation;
2189 gboolean needs_draw = FALSE;
2191 g_return_if_fail (widget != NULL);
2192 g_return_if_fail (GTK_IS_WIDGET (widget));
2194 real_allocation = *allocation;
2195 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
2199 if (aux_info->x_set)
2200 real_allocation.x = aux_info->x;
2201 if (aux_info->y_set)
2202 real_allocation.y = aux_info->y;
2205 real_allocation.width = MAX (real_allocation.width, 1);
2206 real_allocation.height = MAX (real_allocation.height, 1);
2208 if (real_allocation.width < 0 || real_allocation.height < 0)
2210 g_warning ("gtk_widget_size_allocate(): attempt to allocate widget with width %d and height %d",
2211 real_allocation.width,
2212 real_allocation.height);
2213 real_allocation.width = 1;
2214 real_allocation.height = 1;
2217 if (GTK_WIDGET_NO_WINDOW (widget))
2219 if (widget->allocation.x != real_allocation.x ||
2220 widget->allocation.y != real_allocation.y ||
2221 widget->allocation.width != real_allocation.width ||
2222 widget->allocation.height != real_allocation.height)
2224 gtk_widget_queue_clear_child (widget);
2228 else if (widget->allocation.width != real_allocation.width ||
2229 widget->allocation.height != real_allocation.height)
2234 if (GTK_IS_RESIZE_CONTAINER (widget))
2235 gtk_container_clear_resize_widgets (GTK_CONTAINER (widget));
2237 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[SIZE_ALLOCATE], &real_allocation);
2241 gtk_widget_queue_draw (widget);
2242 if (widget->parent && GTK_CONTAINER (widget->parent)->reallocate_redraws)
2243 gtk_widget_queue_draw (widget->parent);
2248 gtk_widget_real_size_allocate (GtkWidget *widget,
2249 GtkAllocation *allocation)
2251 g_return_if_fail (widget != NULL);
2252 g_return_if_fail (GTK_IS_WIDGET (widget));
2254 widget->allocation = *allocation;
2256 if (GTK_WIDGET_REALIZED (widget) &&
2257 !GTK_WIDGET_NO_WINDOW (widget))
2259 gdk_window_move_resize (widget->window,
2260 allocation->x, allocation->y,
2261 allocation->width, allocation->height);
2266 gtk_widget_stop_add_accelerator (GtkWidget *widget)
2268 g_return_if_fail (widget != NULL);
2269 g_return_if_fail (GTK_IS_WIDGET (widget));
2271 gtk_signal_emit_stop (GTK_OBJECT (widget), widget_signals[ADD_ACCELERATOR]);
2275 gtk_widget_stop_remove_accelerator (GtkWidget *widget)
2277 g_return_if_fail (widget != NULL);
2278 g_return_if_fail (GTK_IS_WIDGET (widget));
2280 gtk_signal_emit_stop (GTK_OBJECT (widget), widget_signals[REMOVE_ACCELERATOR]);
2284 gtk_widget_lock_accelerators (GtkWidget *widget)
2286 g_return_if_fail (widget != NULL);
2287 g_return_if_fail (GTK_IS_WIDGET (widget));
2289 if (!gtk_widget_accelerators_locked (widget))
2291 gtk_signal_connect (GTK_OBJECT (widget),
2293 GTK_SIGNAL_FUNC (gtk_widget_stop_add_accelerator),
2295 gtk_signal_connect (GTK_OBJECT (widget),
2296 "remove_accelerator",
2297 GTK_SIGNAL_FUNC (gtk_widget_stop_remove_accelerator),
2303 gtk_widget_unlock_accelerators (GtkWidget *widget)
2305 g_return_if_fail (widget != NULL);
2306 g_return_if_fail (GTK_IS_WIDGET (widget));
2308 if (gtk_widget_accelerators_locked (widget))
2310 gtk_signal_disconnect_by_func (GTK_OBJECT (widget),
2311 GTK_SIGNAL_FUNC (gtk_widget_stop_add_accelerator),
2313 gtk_signal_disconnect_by_func (GTK_OBJECT (widget),
2314 GTK_SIGNAL_FUNC (gtk_widget_stop_remove_accelerator),
2320 gtk_widget_accelerators_locked (GtkWidget *widget)
2322 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
2324 return gtk_signal_handler_pending_by_func (GTK_OBJECT (widget),
2325 widget_signals[ADD_ACCELERATOR],
2327 GTK_SIGNAL_FUNC (gtk_widget_stop_add_accelerator),
2332 gtk_widget_add_accelerator (GtkWidget *widget,
2333 const gchar *accel_signal,
2334 GtkAccelGroup *accel_group,
2337 GtkAccelFlags accel_flags)
2339 g_return_if_fail (widget != NULL);
2340 g_return_if_fail (GTK_IS_WIDGET (widget));
2341 g_return_if_fail (accel_group != NULL);
2343 gtk_accel_group_add (accel_group,
2347 (GtkObject*) widget,
2352 gtk_widget_remove_accelerator (GtkWidget *widget,
2353 GtkAccelGroup *accel_group,
2357 g_return_if_fail (widget != NULL);
2358 g_return_if_fail (GTK_IS_WIDGET (widget));
2359 g_return_if_fail (accel_group != NULL);
2361 gtk_accel_group_remove (accel_group,
2364 (GtkObject*) widget);
2368 gtk_widget_remove_accelerators (GtkWidget *widget,
2369 const gchar *accel_signal,
2370 gboolean visible_only)
2375 g_return_if_fail (widget != NULL);
2376 g_return_if_fail (GTK_IS_WIDGET (widget));
2377 g_return_if_fail (accel_signal != NULL);
2379 signal_id = gtk_signal_lookup (accel_signal, GTK_OBJECT_TYPE (widget));
2380 g_return_if_fail (signal_id != 0);
2382 slist = gtk_accel_group_entries_from_object (GTK_OBJECT (widget));
2385 GtkAccelEntry *ac_entry;
2387 ac_entry = slist->data;
2388 slist = slist->next;
2389 if (ac_entry->accel_flags & GTK_ACCEL_VISIBLE &&
2390 ac_entry->signal_id == signal_id)
2391 gtk_widget_remove_accelerator (GTK_WIDGET (widget),
2392 ac_entry->accel_group,
2393 ac_entry->accelerator_key,
2394 ac_entry->accelerator_mods);
2399 gtk_widget_accelerator_signal (GtkWidget *widget,
2400 GtkAccelGroup *accel_group,
2404 GtkAccelEntry *ac_entry;
2406 g_return_val_if_fail (widget != NULL, 0);
2407 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
2408 g_return_val_if_fail (accel_group != NULL, 0);
2410 ac_entry = gtk_accel_group_get_entry (accel_group, accel_key, accel_mods);
2412 if (ac_entry && ac_entry->object == (GtkObject*) widget)
2413 return ac_entry->signal_id;
2418 gtk_widget_mnemonic_activate (GtkWidget *widget,
2419 gboolean group_cycling)
2423 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
2425 group_cycling = group_cycling != FALSE;
2426 if (!GTK_WIDGET_IS_SENSITIVE (widget))
2429 gtk_signal_emit (GTK_OBJECT (widget),
2430 widget_signals[ACTIVATE_MNEMONIC],
2437 gtk_widget_real_mnemonic_activate (GtkWidget *widget,
2438 gboolean group_cycling)
2440 if (!group_cycling && GTK_WIDGET_GET_CLASS (widget)->activate_signal)
2441 gtk_widget_activate (widget);
2442 else if (GTK_WIDGET_CAN_FOCUS (widget))
2443 gtk_widget_grab_focus (widget);
2446 g_warning ("widget `%s' isn't suitable for mnemonic activation",
2447 G_OBJECT_TYPE_NAME (widget));
2454 gtk_widget_real_key_press_event (GtkWidget *widget,
2457 gboolean handled = FALSE;
2459 g_return_val_if_fail (widget != NULL, handled);
2460 g_return_val_if_fail (GTK_IS_WIDGET (widget), handled);
2461 g_return_val_if_fail (event != NULL, handled);
2464 handled = gtk_bindings_activate (GTK_OBJECT (widget),
2472 gtk_widget_real_key_release_event (GtkWidget *widget,
2475 gboolean handled = FALSE;
2477 g_return_val_if_fail (widget != NULL, handled);
2478 g_return_val_if_fail (GTK_IS_WIDGET (widget), handled);
2479 g_return_val_if_fail (event != NULL, handled);
2482 handled = gtk_bindings_activate (GTK_OBJECT (widget),
2484 event->state | GDK_RELEASE_MASK);
2490 gtk_widget_real_focus_in_event (GtkWidget *widget,
2491 GdkEventFocus *event)
2493 GTK_WIDGET_SET_FLAGS (widget, GTK_HAS_FOCUS);
2494 gtk_widget_queue_draw (widget);
2500 gtk_widget_real_focus_out_event (GtkWidget *widget,
2501 GdkEventFocus *event)
2503 GTK_WIDGET_UNSET_FLAGS (widget, GTK_HAS_FOCUS);
2504 gtk_widget_queue_draw (widget);
2511 * @widget: a #GtkWidget
2512 * @event: a #GdkEvent
2514 * Rarely-used function. This function is used to emit
2515 * the event signals on a widget (those signals should never
2516 * be emitted without using this function to do so).
2517 * If you want to synthesize an event though, don't use this function;
2518 * instead, use gtk_main_do_event() so the event will behave as if
2519 * it were in the event queue. Don't synthesize expose events; instead,
2520 * use gdk_window_invalidate_rect() to invalidate a region of the
2523 * Return value: return from the event signal emission (%TRUE if the event was handled)
2526 gtk_widget_event (GtkWidget *widget,
2529 g_return_val_if_fail (widget != NULL, TRUE);
2530 g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
2532 if (event->type == GDK_EXPOSE)
2534 g_warning ("Events of type GDK_EXPOSE cannot be synthesized. To get "
2535 "the same effect, call gdk_window_invalidate_rect/region(), "
2536 "followed by gdk_window_process_updates().");
2540 return gtk_widget_event_internal (widget, event);
2545 * gtk_widget_send_expose:
2546 * @widget: a #GtkWidget
2547 * @event: a expose #GdkEvent
2549 * Very rarely-used function. This function is used to emit
2550 * an expose event signals on a widget. This function is not
2551 * normally used directly. The only time it is used is when
2552 * propagating an expose event to a child NO_WINDOW widget, and
2553 * that is normally done using gtk_container_propagate_expose.
2555 * If you want to force an area of a window to be redrawn,
2556 * use gdk_window_invalidate_rect() or gdk_window_invalidate_region().
2557 * To cause the redraw to be done immediately, follow that call
2558 * with a call to gdk_window_procss_updates().
2560 * Return value: return from the event signal emission (%TRUE if the event was handled)
2563 gtk_widget_send_expose (GtkWidget *widget,
2566 g_return_val_if_fail (widget != NULL, TRUE);
2567 g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
2568 g_return_val_if_fail (event != NULL, TRUE);
2569 g_return_val_if_fail (event->type == GDK_EXPOSE, TRUE);
2571 if (event->type != GDK_EXPOSE)
2574 return gtk_widget_event_internal (widget, event);
2578 gtk_widget_event_internal (GtkWidget *widget,
2581 gboolean return_val;
2584 gtk_widget_ref (widget);
2586 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[EVENT], event,
2588 if (return_val || GTK_OBJECT_DESTROYED (widget))
2591 switch (event->type)
2596 case GDK_BUTTON_PRESS:
2597 case GDK_2BUTTON_PRESS:
2598 case GDK_3BUTTON_PRESS:
2599 signal_num = BUTTON_PRESS_EVENT;
2602 signal_num = SCROLL_EVENT;
2604 case GDK_BUTTON_RELEASE:
2605 signal_num = BUTTON_RELEASE_EVENT;
2607 case GDK_MOTION_NOTIFY:
2608 signal_num = MOTION_NOTIFY_EVENT;
2611 signal_num = DELETE_EVENT;
2614 signal_num = DESTROY_EVENT;
2617 signal_num = KEY_PRESS_EVENT;
2619 case GDK_KEY_RELEASE:
2620 signal_num = KEY_RELEASE_EVENT;
2622 case GDK_ENTER_NOTIFY:
2623 signal_num = ENTER_NOTIFY_EVENT;
2625 case GDK_LEAVE_NOTIFY:
2626 signal_num = LEAVE_NOTIFY_EVENT;
2628 case GDK_FOCUS_CHANGE:
2629 if (event->focus_change.in)
2630 signal_num = FOCUS_IN_EVENT;
2632 signal_num = FOCUS_OUT_EVENT;
2635 signal_num = CONFIGURE_EVENT;
2638 signal_num = MAP_EVENT;
2641 signal_num = UNMAP_EVENT;
2643 case GDK_WINDOW_STATE:
2644 signal_num = WINDOW_STATE_EVENT;
2646 case GDK_PROPERTY_NOTIFY:
2647 signal_num = PROPERTY_NOTIFY_EVENT;
2649 case GDK_SELECTION_CLEAR:
2650 signal_num = SELECTION_CLEAR_EVENT;
2652 case GDK_SELECTION_REQUEST:
2653 signal_num = SELECTION_REQUEST_EVENT;
2655 case GDK_SELECTION_NOTIFY:
2656 signal_num = SELECTION_NOTIFY_EVENT;
2658 case GDK_PROXIMITY_IN:
2659 signal_num = PROXIMITY_IN_EVENT;
2661 case GDK_PROXIMITY_OUT:
2662 signal_num = PROXIMITY_OUT_EVENT;
2665 signal_num = NO_EXPOSE_EVENT;
2667 case GDK_CLIENT_EVENT:
2668 signal_num = CLIENT_EVENT;
2671 if (!event->any.window) /* Why is this necessary */
2674 signal_num = EXPOSE_EVENT;
2676 case GDK_VISIBILITY_NOTIFY:
2677 signal_num = VISIBILITY_NOTIFY_EVENT;
2680 g_warning ("could not determine signal number for event: %d", event->type);
2684 if (signal_num != -1)
2685 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[signal_num], event, &return_val);
2687 return_val |= GTK_OBJECT_DESTROYED (widget);
2690 gtk_widget_unref (widget);
2696 * gtk_widget_activate:
2697 * @widget: a #GtkWidget that's activatable
2699 * For widgets that can be "activated" (buttons, menu items, etc.)
2700 * this function activates them. Activation is what happens when you
2701 * press Enter on a widget during key navigation; clicking a button,
2702 * selecting a menu item, etc. If @widget isn't activatable,
2703 * the function returns %FALSE.
2705 * Return value: %TRUE if the widget was activatable
2708 gtk_widget_activate (GtkWidget *widget)
2710 g_return_val_if_fail (widget != NULL, FALSE);
2711 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
2713 if (WIDGET_CLASS (widget)->activate_signal)
2715 /* FIXME: we should eventually check the signals signature here */
2716 gtk_signal_emit (GTK_OBJECT (widget), WIDGET_CLASS (widget)->activate_signal);
2725 * gtk_widget_set_scroll_adjustments:
2726 * @widget: a #GtkWidget
2727 * @hadjustment: an adjustment for horizontal scrolling, or %NULL
2728 * @vadjustment: an adjustment for vertical scrolling, or %NULL
2730 * For widgets that support scrolling, sets the scroll adjustments and
2731 * returns %TRUE. For widgets that don't support scrolling, does
2732 * nothing and returns %FALSE. Widgets that don't support scrolling
2733 * can be scrolled by placing them in a #GtkViewport, which does
2734 * support scrolling.
2736 * Return value: %TRUE if the widget supports scrolling
2739 gtk_widget_set_scroll_adjustments (GtkWidget *widget,
2740 GtkAdjustment *hadjustment,
2741 GtkAdjustment *vadjustment)
2743 g_return_val_if_fail (widget != NULL, FALSE);
2744 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
2746 g_return_val_if_fail (GTK_IS_ADJUSTMENT (hadjustment), FALSE);
2748 g_return_val_if_fail (GTK_IS_ADJUSTMENT (vadjustment), FALSE);
2750 if (WIDGET_CLASS (widget)->set_scroll_adjustments_signal)
2752 /* FIXME: we should eventually check the signals signature here */
2753 gtk_signal_emit (GTK_OBJECT (widget),
2754 WIDGET_CLASS (widget)->set_scroll_adjustments_signal,
2755 hadjustment, vadjustment);
2762 /*****************************************
2763 * gtk_widget_reparent_container_child:
2764 * assistent function to gtk_widget_reparent
2769 *****************************************/
2772 gtk_widget_reparent_container_child (GtkWidget *widget,
2773 gpointer client_data)
2775 g_return_if_fail (widget != NULL);
2776 g_return_if_fail (GTK_IS_WIDGET (widget));
2777 g_return_if_fail (client_data != NULL);
2779 if (GTK_WIDGET_NO_WINDOW (widget))
2782 gdk_window_unref (widget->window);
2783 widget->window = (GdkWindow*) client_data;
2785 gdk_window_ref (widget->window);
2787 if (GTK_IS_CONTAINER (widget))
2788 gtk_container_forall (GTK_CONTAINER (widget),
2789 gtk_widget_reparent_container_child,
2793 gdk_window_reparent (widget->window,
2794 (GdkWindow*) client_data, 0, 0);
2798 * gtk_widget_reparent:
2799 * @widget: a #GtkWidget
2800 * @new_parent: a #GtkContainer to move the widget into
2802 * Moves a widget from one #GtkContainer to another, handling reference
2803 * count issues to avoid destroying the widget.
2807 gtk_widget_reparent (GtkWidget *widget,
2808 GtkWidget *new_parent)
2810 g_return_if_fail (widget != NULL);
2811 g_return_if_fail (GTK_IS_WIDGET (widget));
2812 g_return_if_fail (new_parent != NULL);
2813 g_return_if_fail (GTK_IS_CONTAINER (new_parent));
2814 g_return_if_fail (widget->parent != NULL);
2816 if (widget->parent != new_parent)
2818 /* First try to see if we can get away without unrealizing
2819 * the widget as we reparent it. if so we set a flag so
2820 * that gtk_widget_unparent doesn't unrealize widget
2822 if (GTK_WIDGET_REALIZED (widget) && GTK_WIDGET_REALIZED (new_parent))
2823 GTK_PRIVATE_SET_FLAG (widget, GTK_IN_REPARENT);
2825 gtk_widget_ref (widget);
2826 gtk_container_remove (GTK_CONTAINER (widget->parent), widget);
2827 gtk_container_add (GTK_CONTAINER (new_parent), widget);
2828 gtk_widget_unref (widget);
2830 if (GTK_WIDGET_IN_REPARENT (widget))
2832 GTK_PRIVATE_UNSET_FLAG (widget, GTK_IN_REPARENT);
2834 gtk_widget_reparent_container_child (widget,
2835 gtk_widget_get_parent_window (widget));
2841 * gtk_widget_intersect:
2842 * @widget: a #GtkWidget
2843 * @area: a rectangle
2844 * @intersection: rectangle to store intersection of @widget and @area
2846 * Computes the intersection of a @widget's area and @area, storing
2847 * the intersection in @intersection, and returns %TRUE if there was
2848 * an intersection. @intersection may be %NULL if you're only
2849 * interested in whether there was an intersection.
2851 * Return value: %TRUE if there was an intersection
2854 gtk_widget_intersect (GtkWidget *widget,
2856 GdkRectangle *intersection)
2862 g_return_val_if_fail (widget != NULL, FALSE);
2863 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
2864 g_return_val_if_fail (area != NULL, FALSE);
2867 dest = intersection;
2871 return_val = gdk_rectangle_intersect (&widget->allocation, area, dest);
2873 if (return_val && intersection && !GTK_WIDGET_NO_WINDOW (widget))
2875 intersection->x -= widget->allocation.x;
2876 intersection->y -= widget->allocation.y;
2883 * gtk_widget_region_intersect:
2884 * @widget: a #GtkWidget
2885 * @region: a #GdkRegion, in the same coordinate system as
2886 * widget->allocation. That is, relative to widget->window
2887 * for NO_WINDOW widgets; relative to the parent window
2888 * of widget->window for widgets with their own window.
2889 * @returns: A newly allocated region holding the intersection of @widget
2890 * and @region. The coordinates of the return value are
2891 * relative to widget->window for NO_WINDOW widgets, and
2892 * relative to the parent window of widget->window for
2893 * widgets with their own window.
2895 * Computes the intersection of a @widget's area and @region, returning
2896 * the intersection. The result may be empty, use #gdk_region_empty to
2900 gtk_widget_region_intersect (GtkWidget *widget,
2905 g_return_val_if_fail (widget != NULL, NULL);
2906 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
2907 g_return_val_if_fail (region != NULL, NULL);
2909 dest = gdk_region_rectangle (&widget->allocation);
2911 gdk_region_intersect (dest, region);
2917 * gtk_widget_grab_focus:
2918 * @widget: a #GtkWidget
2920 * Causes @widget to have the keyboard focus for the #GtkWindow it's
2921 * inside. @widget must be a focusable widget, such as a #GtkEntry;
2922 * something like #GtkFrame won't work. (More precisely, it must have the
2923 * #GTK_CAN_FOCUS flag set.)
2927 gtk_widget_grab_focus (GtkWidget *widget)
2929 g_return_if_fail (widget != NULL);
2930 g_return_if_fail (GTK_IS_WIDGET (widget));
2932 g_object_ref (G_OBJECT (widget));
2933 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[GRAB_FOCUS]);
2934 g_object_notify (G_OBJECT (widget), "has_focus");
2935 g_object_unref (G_OBJECT (widget));
2939 reset_focus_recurse (GtkWidget *widget,
2942 if (GTK_IS_CONTAINER (widget))
2944 GtkContainer *container;
2946 container = GTK_CONTAINER (widget);
2947 gtk_container_set_focus_child (container, NULL);
2949 gtk_container_foreach (container,
2950 reset_focus_recurse,
2956 gtk_widget_real_grab_focus (GtkWidget *focus_widget)
2958 g_return_if_fail (focus_widget != NULL);
2959 g_return_if_fail (GTK_IS_WIDGET (focus_widget));
2961 if (GTK_WIDGET_CAN_FOCUS (focus_widget))
2963 GtkWidget *toplevel;
2966 /* clear the current focus setting, break if the current widget
2967 * is the focus widget's parent, since containers above that will
2968 * be set by the next loop.
2970 toplevel = gtk_widget_get_toplevel (focus_widget);
2971 if (GTK_IS_WINDOW (toplevel))
2973 widget = GTK_WINDOW (toplevel)->focus_widget;
2975 if (widget == focus_widget)
2977 /* We call gtk_window_set_focus() here so that the
2978 * toplevel window can request the focus if necessary.
2979 * This is needed when the toplevel is a GtkPlug
2981 if (!GTK_WIDGET_HAS_FOCUS (widget))
2982 gtk_window_set_focus (GTK_WINDOW (toplevel), focus_widget);
2989 while (widget->parent && widget->parent != focus_widget->parent)
2991 widget = widget->parent;
2992 gtk_container_set_focus_child (GTK_CONTAINER (widget), NULL);
2996 else if (toplevel != focus_widget)
2998 /* gtk_widget_grab_focus() operates on a tree without window...
2999 * actually, this is very questionable behaviour.
3002 gtk_container_foreach (GTK_CONTAINER (toplevel),
3003 reset_focus_recurse,
3007 /* now propagate the new focus up the widget tree and finally
3008 * set it on the window
3010 widget = focus_widget;
3011 while (widget->parent)
3013 gtk_container_set_focus_child (GTK_CONTAINER (widget->parent), widget);
3014 widget = widget->parent;
3016 if (GTK_IS_WINDOW (widget))
3017 gtk_window_set_focus (GTK_WINDOW (widget), focus_widget);
3022 * gtk_widget_is_focus:
3023 * @widget: a #GtkWidget
3025 * Determines if the widget is the focus widget within its
3026 * toplevel. (This does not mean that the HAS_FOCUS flag is
3027 * necessarily set; HAS_FOCUS will only be set if the
3028 * toplevel widget additionally has the global input focus.)
3030 * Return value: %TRUE if the widget is the focus widget.
3033 gtk_widget_is_focus (GtkWidget *widget)
3035 GtkWidget *toplevel;
3037 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
3039 toplevel = gtk_widget_get_toplevel (widget);
3041 if (GTK_IS_WINDOW (toplevel))
3042 return widget == GTK_WINDOW (toplevel)->focus_widget;
3048 * gtk_widget_grab_default:
3049 * @widget: a #GtkWidget
3051 * Causes @widget to become the default widget. @widget must have the
3052 * #GTK_CAN_DEFAULT flag set; typically you have to set this flag
3053 * yourself by calling GTK_WIDGET_SET_FLAGS (@widget,
3054 * GTK_CAN_DEFAULT). The default widget is activated when the user
3055 * presses Enter in a window. Default widgets must be activatable,
3056 * that is, gtk_widget_activate() should affect them.
3060 gtk_widget_grab_default (GtkWidget *widget)
3063 GtkType window_type;
3065 g_return_if_fail (widget != NULL);
3066 g_return_if_fail (GTK_IS_WIDGET (widget));
3067 g_return_if_fail (GTK_WIDGET_CAN_DEFAULT (widget));
3069 window_type = GTK_TYPE_WINDOW;
3070 window = widget->parent;
3072 while (window && !gtk_type_is_a (GTK_WIDGET_TYPE (window), window_type))
3073 window = window->parent;
3075 if (window && gtk_type_is_a (GTK_WIDGET_TYPE (window), window_type))
3077 gtk_window_set_default (GTK_WINDOW (window), widget);
3078 g_object_notify (G_OBJECT (widget), "has_default");
3081 g_warning (G_STRLOC ": widget not within a GtkWindow");
3085 * gtk_widget_set_name:
3086 * @widget: a #GtkWidget
3087 * @name: name for the widget
3089 * Widgets can be named, which allows you to refer to them from a
3090 * gtkrc file. You can apply a style to widgets with a particular name
3091 * in the gtkrc file. See the documentation for gtkrc files (on the
3092 * same page as the docs for #GtkRcStyle).
3096 gtk_widget_set_name (GtkWidget *widget,
3099 g_return_if_fail (widget != NULL);
3100 g_return_if_fail (GTK_IS_WIDGET (widget));
3103 g_free (widget->name);
3104 widget->name = g_strdup (name);
3106 if (GTK_WIDGET_RC_STYLE (widget))
3107 gtk_widget_set_rc_style (widget);
3109 g_object_notify (G_OBJECT (widget), "name");
3113 * gtk_widget_get_name:
3114 * @widget: a #GtkWidget
3116 * Retrieves the name of a widget. The return value should not be
3117 * freed. See gtk_widget_set_name() for the significance of widget
3120 * Return value: name of the widget
3122 G_CONST_RETURN gchar*
3123 gtk_widget_get_name (GtkWidget *widget)
3125 g_return_val_if_fail (widget != NULL, NULL);
3126 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
3129 return widget->name;
3130 return gtk_type_name (GTK_WIDGET_TYPE (widget));
3134 * gtk_widget_set_state:
3135 * @widget: a #GtkWidget
3136 * @state: new state for @widget
3138 * This function is for use in widget implementations. Sets the state
3139 * of a widget (insensitive, prelighted, etc.) Usually you should set
3140 * the state using wrapper functions such as gtk_widget_set_sensitive().
3144 gtk_widget_set_state (GtkWidget *widget,
3147 g_return_if_fail (widget != NULL);
3148 g_return_if_fail (GTK_IS_WIDGET (widget));
3150 if (state == GTK_WIDGET_STATE (widget))
3153 if (state == GTK_STATE_INSENSITIVE)
3154 gtk_widget_set_sensitive (widget, FALSE);
3160 data.state_restoration = FALSE;
3161 data.use_forall = FALSE;
3163 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget->parent) != FALSE);
3165 data.parent_sensitive = TRUE;
3167 gtk_widget_propagate_state (widget, &data);
3169 if (GTK_WIDGET_DRAWABLE (widget))
3170 gtk_widget_queue_clear (widget);
3175 gtk_widget_set_app_paintable (GtkWidget *widget,
3176 gboolean app_paintable)
3178 g_return_if_fail (widget != NULL);
3179 g_return_if_fail (GTK_IS_WIDGET (widget));
3181 app_paintable = (app_paintable != FALSE);
3183 if (GTK_WIDGET_APP_PAINTABLE (widget) != app_paintable)
3186 GTK_WIDGET_SET_FLAGS (widget, GTK_APP_PAINTABLE);
3188 GTK_WIDGET_UNSET_FLAGS (widget, GTK_APP_PAINTABLE);
3190 if (GTK_WIDGET_DRAWABLE (widget))
3191 gtk_widget_queue_clear (widget);
3193 g_object_notify (G_OBJECT (widget), "app_paintable");
3198 * gtk_widget_set_double_buffered:
3199 * @widget: a #GtkWidget
3200 * @double_buffered: %TRUE to double-buffer a widget
3202 * Widgets are double buffered by default; you can use this function
3203 * to turn off the buffering. "Double buffered" simply means that
3204 * gdk_window_begin_paint() and gdk_window_end_paint() are called
3205 * automatically around expose events sent to the
3206 * widget. gdk_window_begin_paint() diverts all drawing to a widget's
3207 * window to an offscreen buffer, and gdk_window_end_paint() draws the
3208 * buffer to the screen. The result is that users see the window
3209 * update in one smooth step, and don't see individual graphics
3210 * primitives being rendered.
3212 * In very simple terms, double buffered widgets don't flicker,
3213 * so you would only use this function to turn off double buffering
3214 * if you had special needs and really knew what you were doing.
3218 gtk_widget_set_double_buffered (GtkWidget *widget,
3219 gboolean double_buffered)
3221 g_return_if_fail (widget != NULL);
3222 g_return_if_fail (GTK_IS_WIDGET (widget));
3224 if (double_buffered)
3225 GTK_WIDGET_SET_FLAGS (widget, GTK_DOUBLE_BUFFERED);
3227 GTK_WIDGET_UNSET_FLAGS (widget, GTK_DOUBLE_BUFFERED);
3231 * gtk_widget_set_sensitive:
3232 * @widget: a @widget
3233 * @sensitive: %TRUE to make the widget sensitive
3235 * Sets the sensitivity of a widget. A widget is sensitive if the user
3236 * can interact with it. Insensitive widgets are "grayed out" and the
3237 * user can't interact with them. Insensitive widgets are known as
3238 * "inactive" in some other toolkits.
3242 gtk_widget_set_sensitive (GtkWidget *widget,
3247 g_return_if_fail (widget != NULL);
3248 g_return_if_fail (GTK_IS_WIDGET (widget));
3250 sensitive = (sensitive != FALSE);
3252 if (sensitive == (GTK_WIDGET_SENSITIVE (widget) != FALSE))
3257 GTK_WIDGET_SET_FLAGS (widget, GTK_SENSITIVE);
3258 data.state = GTK_WIDGET_SAVED_STATE (widget);
3262 GTK_WIDGET_UNSET_FLAGS (widget, GTK_SENSITIVE);
3263 data.state = GTK_WIDGET_STATE (widget);
3265 data.state_restoration = TRUE;
3266 data.use_forall = TRUE;
3269 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget->parent) != FALSE);
3271 data.parent_sensitive = TRUE;
3273 gtk_widget_propagate_state (widget, &data);
3274 if (GTK_WIDGET_DRAWABLE (widget))
3275 gtk_widget_queue_clear (widget);
3277 g_object_notify (G_OBJECT (widget), "sensitive");
3281 * gtk_widget_set_parent:
3282 * @widget: a #GtkWidget
3283 * @parent: parent container
3285 * This function is useful only when implementing subclasses of #GtkContainer.
3286 * Sets the container as the parent of @widget, and takes care of
3287 * some details such as updating the state and style of the child
3288 * to reflect its new location. The opposite function is
3289 * gtk_widget_unparent().
3293 gtk_widget_set_parent (GtkWidget *widget,
3298 g_return_if_fail (widget != NULL);
3299 g_return_if_fail (GTK_IS_WIDGET (widget));
3300 g_return_if_fail (widget->parent == NULL);
3301 g_return_if_fail (!GTK_WIDGET_TOPLEVEL (widget));
3302 g_return_if_fail (parent != NULL);
3303 g_return_if_fail (GTK_IS_WIDGET (parent));
3304 g_return_if_fail (widget != parent);
3306 /* keep this function in sync with gtk_menu_attach_to_widget()
3309 gtk_widget_ref (widget);
3310 gtk_object_sink (GTK_OBJECT (widget));
3311 widget->parent = parent;
3313 if (GTK_WIDGET_STATE (parent) != GTK_STATE_NORMAL)
3314 data.state = GTK_WIDGET_STATE (parent);
3316 data.state = GTK_WIDGET_STATE (widget);
3317 data.state_restoration = FALSE;
3318 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (parent) != FALSE);
3319 data.use_forall = GTK_WIDGET_IS_SENSITIVE (parent) != GTK_WIDGET_IS_SENSITIVE (widget);
3321 gtk_widget_propagate_state (widget, &data);
3323 gtk_widget_set_style_recurse (widget, NULL);
3325 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[PARENT_SET], NULL);
3326 gtk_widget_propagate_hierarchy_changed (widget, NULL);
3327 g_object_notify (G_OBJECT (widget), "parent");
3330 /*****************************************
3332 * see docs/styles.txt
3333 *****************************************/
3336 * gtk_widget_set_style:
3337 * @widget: a #GtkWidget
3338 * @style: a #GtkStyle
3340 * Sets the #GtkStyle for a widget (widget->style). You probably don't
3341 * want to use this function; it interacts badly with themes, because
3342 * themes work by replacing the #GtkStyle. Instead, use
3343 * gtk_widget_modify_style().
3347 gtk_widget_set_style (GtkWidget *widget,
3350 GtkStyle *default_style;
3351 gboolean initial_emission;
3353 g_return_if_fail (widget != NULL);
3354 g_return_if_fail (GTK_IS_WIDGET (widget));
3355 g_return_if_fail (style != NULL);
3357 initial_emission = !GTK_WIDGET_RC_STYLE (widget) && !GTK_WIDGET_USER_STYLE (widget);
3359 GTK_WIDGET_UNSET_FLAGS (widget, GTK_RC_STYLE);
3360 GTK_PRIVATE_SET_FLAG (widget, GTK_USER_STYLE);
3362 default_style = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_saved_default_style);
3365 gtk_style_ref (widget->style);
3366 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_saved_default_style, widget->style);
3369 gtk_widget_set_style_internal (widget, style, initial_emission);
3373 * gtk_widget_ensure_style:
3374 * @widget: a #GtkWidget
3376 * Ensures that @widget has a style (widget->style). Not a very useful
3377 * function; most of the time, if you want the style, the widget is
3378 * realized, and realized widgets are guaranteed to have a style
3383 gtk_widget_ensure_style (GtkWidget *widget)
3385 g_return_if_fail (widget != NULL);
3386 g_return_if_fail (GTK_IS_WIDGET (widget));
3388 if (!GTK_WIDGET_USER_STYLE (widget) &&
3389 !GTK_WIDGET_RC_STYLE (widget))
3390 gtk_widget_set_rc_style (widget);
3394 * gtk_widget_set_rc_style:
3395 * @widget: a #GtkWidget
3400 gtk_widget_set_rc_style (GtkWidget *widget)
3402 GtkStyle *saved_style;
3403 GtkStyle *new_style;
3404 gboolean initial_emission;
3406 g_return_if_fail (widget != NULL);
3407 g_return_if_fail (GTK_IS_WIDGET (widget));
3409 initial_emission = !GTK_WIDGET_RC_STYLE (widget) && !GTK_WIDGET_USER_STYLE (widget);
3411 GTK_PRIVATE_UNSET_FLAG (widget, GTK_USER_STYLE);
3412 GTK_WIDGET_SET_FLAGS (widget, GTK_RC_STYLE);
3414 saved_style = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_saved_default_style);
3415 new_style = gtk_rc_get_style (widget);
3420 gtk_style_ref (widget->style);
3421 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_saved_default_style, widget->style);
3423 gtk_widget_set_style_internal (widget, new_style, initial_emission);
3429 g_assert (initial_emission == FALSE); /* FIXME: remove this line */
3431 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_saved_default_style);
3432 gtk_widget_set_style_internal (widget, saved_style, initial_emission);
3433 gtk_style_unref (saved_style);
3437 if (initial_emission)
3438 gtk_widget_set_style_internal (widget, widget->style, TRUE);
3444 gtk_widget_restore_default_style (GtkWidget *widget)
3446 GtkStyle *default_style;
3448 g_return_if_fail (widget != NULL);
3449 g_return_if_fail (GTK_IS_WIDGET (widget));
3451 GTK_PRIVATE_UNSET_FLAG (widget, GTK_USER_STYLE);
3453 default_style = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_saved_default_style);
3456 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_saved_default_style);
3457 gtk_widget_set_style_internal (widget, default_style, FALSE);
3458 gtk_style_unref (default_style);
3463 * gtk_widget_get_style:
3464 * @widget: a #GtkWidget
3466 * Simply an accessor function that returns widget->style.
3468 * Return value: the widget's #GtkStyle
3471 gtk_widget_get_style (GtkWidget *widget)
3473 g_return_val_if_fail (widget != NULL, NULL);
3474 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
3476 return widget->style;
3480 * gtk_widget_modify_style:
3481 * @widget: a #GtkWidget
3482 * @style: the #GtkRcStyle holding the style modifications
3484 * Modify style values on the widget. Modifications made using this
3485 * technique take precendence over style values set via an RC file,
3486 * however, they will be overriden if a style is explicitely set on
3487 * the widget using gtk_widget_set_style(). The #GtkRcStyle structure
3488 * is designed so each field can either be set or unset, so it is
3489 * possible, using this function, to modify some style values and
3490 * leave the others unchanged.
3492 * Note that modifications made with this function are not cumulative
3493 * with previous calls to gtk_widget_modify_style() or with such
3494 * functions as gtk_widget_modify_fg(). If you wish to retain
3495 * previous values, you must first call gtk_widget_get_modifier_style(),
3496 * make your modifications to the returned style, then call
3497 * gtk_widget_modify_style() with that style. On the other hand,
3498 * if you first call gtk_widget_modify_style(), subsequent calls
3499 * to such functions gtk_widget_modify_fg() will be have a cumulative
3500 * effect with the inital modifications.
3503 gtk_widget_modify_style (GtkWidget *widget,
3506 GtkRcStyle *old_style;
3508 g_return_if_fail (GTK_IS_RC_STYLE (style));
3510 old_style = gtk_object_get_data_by_id (GTK_OBJECT (widget),
3513 gtk_object_set_data_by_id_full (GTK_OBJECT (widget),
3515 gtk_rc_style_copy (style),
3516 (GtkDestroyNotify)gtk_rc_style_unref);
3518 /* note that "style" may be invalid here if it was the old
3519 * modifier style and the only reference was our own.
3522 if (GTK_WIDGET_RC_STYLE (widget))
3523 gtk_widget_set_rc_style (widget);
3527 * gtk_widget_get_modifier_style:
3528 * @widget: a #GtkWidget
3530 * Return the current modifier style for the widget. (As set by
3531 * gtk_widget_modify_style().) If no style has previously set, a new
3532 * #GtkRcStyle will be created with all values unset, and set as the
3533 * modifier style for the widget. If you make changes to this rc
3534 * style, you must call gtk_widget_modify_style(), passing in the
3535 * returned rc style, to make sure that your changes take effect.
3537 * Caution: passing the style back to gtk_widget_modify_style() will
3538 * normally end up destroying it, because gtk_widget_modify_style() copies
3539 * the passed-in style and sets the copy as the new modifier style,
3540 * thus dropping any reference to the old modifier style. Add a reference
3541 * to the modifier style if you want to keep it alive.
3543 * Return value: the modifier style for the widget. This rc style is
3544 * owned by the widget. If you want to keep a pointer to value this
3545 * around, you must add a refcount using gtk_rc_style_ref().
3548 gtk_widget_get_modifier_style (GtkWidget *widget)
3550 GtkRcStyle *rc_style;
3552 rc_style = gtk_object_get_data_by_id (GTK_OBJECT (widget),
3557 rc_style = gtk_rc_style_new();
3558 gtk_object_set_data_by_id_full (GTK_OBJECT (widget),
3561 (GtkDestroyNotify)gtk_rc_style_unref);
3568 gtk_widget_modify_color_component (GtkWidget *widget,
3569 GtkRcFlags component,
3573 GtkRcStyle *rc_style = gtk_widget_get_modifier_style (widget);
3578 rc_style->fg[state] = *color;
3581 rc_style->bg[state] = *color;
3584 rc_style->text[state] = *color;
3587 rc_style->base[state] = *color;
3590 g_assert_not_reached();
3593 rc_style->color_flags[state] |= component;
3595 gtk_widget_modify_style (widget, rc_style);
3599 * gtk_widget_modify_fg:
3600 * @widget: a #GtkWidget
3601 * @state: the state for which to set the foreground color.
3602 * @color: the color to assign (does not need to be allocated)
3604 * Set the foreground color for a widget in a particular state. All
3605 * other style values are left untouched. See also
3606 * gtk_widget_modify_style().
3609 gtk_widget_modify_fg (GtkWidget *widget,
3613 g_return_if_fail (GTK_IS_WIDGET (widget));
3614 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
3615 g_return_if_fail (color != NULL);
3617 gtk_widget_modify_color_component (widget, GTK_RC_FG, state, color);
3621 * gtk_widget_modify_bg:
3622 * @widget: a #GtkWidget
3623 * @state: the state for which to set the foreground color.
3624 * @color: the color to assign (does not need to be allocated)
3626 * Set the background color for a widget in a particular state. All
3627 * other style values are left untouched. See also
3628 * gtk_widget_modify_style().
3631 gtk_widget_modify_bg (GtkWidget *widget,
3635 g_return_if_fail (GTK_IS_WIDGET (widget));
3636 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
3637 g_return_if_fail (color != NULL);
3639 gtk_widget_modify_color_component (widget, GTK_RC_BG, state, color);
3643 * gtk_widget_modify_base:
3644 * @widget: a #GtkWidget
3645 * @state: the state for which to set the foreground color.
3646 * @color: the color to assign (does not need to be allocated)
3648 * Set the text color for a widget in a particular state. All other
3649 * style values are left untouched. The text color is the foreground
3650 * color used along with the base color (see gtk_widget_modify_base)
3651 * for widgets such as #GtkEntry and #GtkTextView. See also
3652 * gtk_widget_modify_style().
3655 gtk_widget_modify_text (GtkWidget *widget,
3659 g_return_if_fail (GTK_IS_WIDGET (widget));
3660 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
3661 g_return_if_fail (color != NULL);
3663 gtk_widget_modify_color_component (widget, GTK_RC_TEXT, state, color);
3667 * gtk_widget_modify_base:
3668 * @widget: a #GtkWidget
3669 * @state: the state for which to set the foreground color.
3670 * @color: the color to assign (does not need to be allocated)
3672 * Set the text color for a widget in a particular state.
3673 * All other style values are left untouched. The base color
3674 * is the background color used along with the text color
3675 * (see gtk_widget_modify_text) for widgets such as #GtkEntry
3676 * and #GtkTextView. See also gtk_widget_modify_style().
3679 gtk_widget_modify_base (GtkWidget *widget,
3683 g_return_if_fail (GTK_IS_WIDGET (widget));
3684 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
3685 g_return_if_fail (color != NULL);
3687 gtk_widget_modify_color_component (widget, GTK_RC_BASE, state, color);
3691 * gtk_widget_modify_font:
3692 * @widget: a #GtkWidget
3693 * @font_desc: the font description to use
3695 * Set the font to use for a widget. All other style values are left
3696 * untouched. See also gtk_widget_modify_style().
3699 gtk_widget_modify_font (GtkWidget *widget,
3700 PangoFontDescription *font_desc)
3702 GtkRcStyle *rc_style;
3704 g_return_if_fail (GTK_IS_WIDGET (widget));
3705 g_return_if_fail (font_desc != NULL);
3707 rc_style = gtk_widget_get_modifier_style (widget);
3709 if (rc_style->font_desc)
3710 pango_font_description_free (rc_style->font_desc);
3712 rc_style->font_desc = pango_font_description_copy (font_desc);
3714 gtk_widget_modify_style (widget, rc_style);
3718 gtk_widget_direction_changed (GtkWidget *widget,
3719 GtkTextDirection previous_direction)
3721 gtk_widget_queue_resize (widget);
3725 gtk_widget_style_set (GtkWidget *widget,
3726 GtkStyle *previous_style)
3728 if (GTK_WIDGET_REALIZED (widget) &&
3729 !GTK_WIDGET_NO_WINDOW (widget))
3730 gtk_style_set_background (widget->style, widget->window, widget->state);
3734 gtk_widget_set_style_internal (GtkWidget *widget,
3736 gboolean initial_emission)
3738 g_return_if_fail (widget != NULL);
3739 g_return_if_fail (GTK_IS_WIDGET (widget));
3740 g_return_if_fail (style != NULL);
3742 g_object_ref (G_OBJECT (widget));
3743 g_object_freeze_notify (G_OBJECT (widget));
3745 if (widget->style != style || initial_emission)
3747 PangoContext *context = gtk_widget_peek_pango_context (widget);
3749 pango_context_set_font_description (context, style->font_desc);
3752 if (widget->style != style)
3754 GtkStyle *previous_style;
3756 if (GTK_WIDGET_REALIZED (widget))
3758 gtk_widget_reset_shapes (widget);
3759 gtk_style_detach (widget->style);
3762 previous_style = widget->style;
3763 widget->style = style;
3764 gtk_style_ref (widget->style);
3766 if (GTK_WIDGET_REALIZED (widget))
3767 widget->style = gtk_style_attach (widget->style, widget->window);
3769 gtk_signal_emit (GTK_OBJECT (widget),
3770 widget_signals[STYLE_SET],
3771 initial_emission ? NULL : previous_style);
3772 gtk_style_unref (previous_style);
3774 if (widget->parent && !initial_emission)
3776 GtkRequisition old_requisition;
3778 old_requisition = widget->requisition;
3779 gtk_widget_size_request (widget, NULL);
3781 if ((old_requisition.width != widget->requisition.width) ||
3782 (old_requisition.height != widget->requisition.height))
3783 gtk_widget_queue_resize (widget);
3784 else if (GTK_WIDGET_DRAWABLE (widget))
3785 gtk_widget_queue_clear (widget);
3788 else if (initial_emission)
3789 gtk_signal_emit (GTK_OBJECT (widget),
3790 widget_signals[STYLE_SET],
3792 g_object_notify (G_OBJECT (widget), "style");
3793 g_object_thaw_notify (G_OBJECT (widget));
3794 g_object_unref (G_OBJECT (widget));
3798 gtk_widget_set_style_recurse (GtkWidget *widget,
3799 gpointer client_data)
3801 if (GTK_WIDGET_RC_STYLE (widget))
3802 gtk_widget_set_rc_style (widget);
3804 if (GTK_IS_CONTAINER (widget))
3805 gtk_container_forall (GTK_CONTAINER (widget),
3806 gtk_widget_set_style_recurse,
3811 gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
3812 gpointer client_data)
3814 gboolean new_anchored;
3816 new_anchored = widget->parent && GTK_WIDGET_ANCHORED (widget->parent);
3818 if (GTK_WIDGET_ANCHORED (widget) != new_anchored)
3820 gtk_widget_ref (widget);
3823 GTK_PRIVATE_SET_FLAG (widget, GTK_ANCHORED);
3825 GTK_PRIVATE_UNSET_FLAG (widget, GTK_ANCHORED);
3827 g_signal_emit (GTK_OBJECT (widget), widget_signals[HIERARCHY_CHANGED], 0);
3829 if (GTK_IS_CONTAINER (widget))
3830 gtk_container_forall (GTK_CONTAINER (widget),
3831 gtk_widget_propagate_hierarchy_changed,
3834 gtk_widget_unref (widget);
3839 gtk_widget_reset_rc_styles (GtkWidget *widget)
3841 g_return_if_fail (widget != NULL);
3842 g_return_if_fail (GTK_IS_WIDGET (widget));
3844 gtk_widget_set_style_recurse (widget, NULL);
3848 gtk_widget_set_default_style (GtkStyle *style)
3850 if (style != gtk_default_style)
3852 if (gtk_default_style)
3853 gtk_style_unref (gtk_default_style);
3854 gtk_default_style = style;
3855 if (gtk_default_style)
3856 gtk_style_ref (gtk_default_style);
3861 gtk_widget_get_default_style (void)
3863 if (!gtk_default_style)
3865 gtk_default_style = gtk_style_new ();
3866 gtk_style_ref (gtk_default_style);
3869 return gtk_default_style;
3873 gtk_widget_push_style (GtkStyle *style)
3875 g_return_if_fail (style != NULL);
3877 gtk_style_ref (style);
3878 style_stack = g_slist_prepend (style_stack, style);
3882 gtk_widget_peek_style (void)
3885 return (GtkStyle*) style_stack->data;
3887 return gtk_widget_get_default_style ();
3891 gtk_widget_pop_style (void)
3898 style_stack = style_stack->next;
3899 gtk_style_unref ((GtkStyle*) tmp->data);
3900 g_slist_free_1 (tmp);
3904 static PangoContext *
3905 gtk_widget_peek_pango_context (GtkWidget *widget)
3907 return gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_pango_context);
3911 * gtk_widget_get_pango_context:
3912 * @widget: a #GtkWidget
3914 * Get a #PangoContext with the appropriate colormap, font description
3915 * and base direction for this widget. Unlike the context returned
3916 * by gtk_widget_create_pango_context(), this context is owned by
3917 * the widget (it can be used as long as widget exists), and will
3918 * be updated to match any changes to the widget's attributes.
3920 * If you create and keep a #PangoLayout using this context, you must
3921 * deal with changes to the context by calling pango_layout_context_changed()
3922 * on the layout in response to the ::style_set and ::direction_set signals
3925 * Return value: the #PangoContext for the widget.
3928 gtk_widget_get_pango_context (GtkWidget *widget)
3930 PangoContext *context;
3932 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
3934 context = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_pango_context);
3937 context = gtk_widget_create_pango_context (GTK_WIDGET (widget));
3938 gtk_object_set_data_by_id_full (GTK_OBJECT (widget), quark_pango_context, context,
3939 (GDestroyNotify) g_object_unref);
3946 * gtk_widget_create_pango_context:
3947 * @widget: a #PangoWidget
3949 * Create a new pango context with the appropriate colormap,
3950 * font description, and base direction for drawing text for
3951 * this widget. See also gtk_widget_get_pango_context()
3953 * Return value: the new #PangoContext
3956 gtk_widget_create_pango_context (GtkWidget *widget)
3958 PangoContext *context;
3961 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
3963 context = gdk_pango_context_get ();
3965 gdk_pango_context_set_colormap (context, gtk_widget_get_colormap (widget));
3966 pango_context_set_base_dir (context,
3967 gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR ?
3968 PANGO_DIRECTION_LTR : PANGO_DIRECTION_RTL);
3969 pango_context_set_font_description (context, widget->style->font_desc);
3971 lang = gtk_get_default_language ();
3972 pango_context_set_lang (context, lang);
3979 * gtk_widget_create_pango_layout:
3980 * @widget: a #PangoWidget
3981 * @text: text to set on the layout (can be %NULL)
3983 * Create a new #PangoLayout with the appropriate colormap,
3984 * font description, and base direction for drawing text for
3987 * If you keep a #PangoLayout created in this way around, in order
3988 * notify the layout of changes to the base direction or font of this
3989 * widget, you must call pango_layout_context_changed() in response to
3990 * the ::style_set and ::direction_set signals for the widget.
3992 * Return value: the new #PangoLayout
3995 gtk_widget_create_pango_layout (GtkWidget *widget,
3998 PangoLayout *layout;
3999 PangoContext *context;
4001 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4003 context = gtk_widget_get_pango_context (widget);
4004 layout = pango_layout_new (context);
4007 pango_layout_set_text (layout, text, -1);
4013 * gtk_widget_render_icon:
4014 * @widget: a #GtkWidget
4015 * @stock_id: a stock ID
4016 * @size: a stock size
4017 * @detail: render detail to pass to theme engine
4019 * A convenience function that uses the theme engine and RC file
4020 * settings for @widget to look up @stock_id and render it to
4021 * a pixbuf. @stock_id should be a stock icon ID such as
4022 * #GTK_STOCK_OPEN or #GTK_STOCK_BUTTON_OK. @size should be a size
4023 * such as #GTK_ICON_SIZE_MENU. @detail should be a string that
4024 * identifies the widget or code doing the rendering, so that
4025 * theme engines can special-case rendering for that widget or code.
4027 * Return value: a new pixbuf, or %NULL if the stock ID wasn't known
4030 gtk_widget_render_icon (GtkWidget *widget,
4031 const gchar *stock_id,
4033 const gchar *detail)
4035 GtkIconSet *icon_set;
4038 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4039 g_return_val_if_fail (stock_id != NULL, NULL);
4040 g_return_val_if_fail (size > GTK_ICON_SIZE_INVALID, NULL);
4042 gtk_widget_ensure_style (widget);
4044 icon_set = gtk_style_lookup_icon_set (widget->style, stock_id);
4046 if (icon_set == NULL)
4049 retval = gtk_icon_set_render_icon (icon_set,
4051 gtk_widget_get_direction (widget),
4052 GTK_WIDGET_STATE (widget),
4060 /*************************************************************
4061 * gtk_widget_set_parent_window:
4062 * Set a non default parent window for widget
4069 *************************************************************/
4072 gtk_widget_set_parent_window (GtkWidget *widget,
4073 GdkWindow *parent_window)
4075 GdkWindow *old_parent_window;
4077 g_return_if_fail (widget != NULL);
4078 g_return_if_fail (GTK_IS_WIDGET (widget));
4080 old_parent_window = gtk_object_get_data_by_id (GTK_OBJECT (widget),
4081 quark_parent_window);
4083 if (parent_window != old_parent_window)
4085 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_parent_window,
4087 if (old_parent_window)
4088 gdk_window_unref (old_parent_window);
4090 gdk_window_ref (parent_window);
4094 /*************************************************************
4095 * gtk_widget_get_parent_window:
4096 * Get widget's parent window
4103 *************************************************************/
4106 gtk_widget_get_parent_window (GtkWidget *widget)
4108 GdkWindow *parent_window;
4110 g_return_val_if_fail (widget != NULL, NULL);
4111 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4112 g_return_val_if_fail (widget->parent != NULL, NULL);
4114 parent_window = gtk_object_get_data_by_id (GTK_OBJECT (widget),
4115 quark_parent_window);
4117 return (parent_window != NULL) ? parent_window : widget->parent->window;
4120 /* Update the position from aux_info. Used from gtk_widget_set_uposition
4121 * and gtk_widget_set_property().
4124 gtk_widget_do_uposition (GtkWidget *widget)
4126 GtkWidgetAuxInfo *aux_info =_gtk_widget_get_aux_info (widget, FALSE);
4128 if (GTK_IS_WINDOW (widget) && aux_info->x_set && aux_info->y_set)
4129 _gtk_window_reposition (GTK_WINDOW (widget), aux_info->x, aux_info->y);
4131 if (GTK_WIDGET_VISIBLE (widget) && widget->parent)
4132 gtk_widget_size_allocate (widget, &widget->allocation);
4134 g_object_freeze_notify (G_OBJECT (widget));
4135 if (aux_info->x_set)
4136 g_object_notify (G_OBJECT (widget), "x");
4137 if (aux_info->y_set)
4138 g_object_notify (G_OBJECT (widget), "y");
4139 g_object_thaw_notify (G_OBJECT (widget));
4143 * gtk_widget_set_uposition:
4144 * @widget: a #GtkWidget
4145 * @x: x position; -1 to unset x; -2 to leave x unchanged
4146 * @y: y position; -1 to unset y; -2 to leave y unchanged
4149 * Sets the position of a widget. The funny "u" in the name comes from
4150 * the "user position" hint specified by the X window system, and
4151 * exists for legacy reasons. This function doesn't work if a widget
4152 * is inside a container; it's only really useful on #GtkWindow.
4154 * Don't use this function to center dialogs over the main application
4155 * window; most window managers will do the centering on your behalf
4156 * if you call gtk_window_set_transient_for(), and it's really not
4157 * possible to get the centering to work correctly in all cases from
4158 * application code. But if you insist, use gtk_window_set_position()
4159 * to set #GTK_WIN_POS_CENTER_ON_PARENT, don't do the centering
4162 * Note that although x and y can be individually unset, the position
4163 * is not honoured unless both x and y are set.
4166 gtk_widget_set_uposition (GtkWidget *widget,
4170 GtkWidgetAuxInfo *aux_info;
4172 g_return_if_fail (widget != NULL);
4173 g_return_if_fail (GTK_IS_WIDGET (widget));
4175 aux_info =_gtk_widget_get_aux_info (widget, TRUE);
4180 aux_info->x_set = FALSE;
4183 aux_info->x_set = TRUE;
4191 aux_info->y_set = FALSE;
4194 aux_info->y_set = TRUE;
4199 gtk_widget_do_uposition (widget);
4203 * gtk_widget_set_usize:
4204 * @widget: a #GtkWidget
4205 * @width: minimum width, or -1 to unset
4206 * @height: minimum height, or -1 to unset
4208 * Sets the minimum size of a widget; that is, the widget's size
4209 * request will be @width by @height. You can use this function to
4210 * force a widget to be either larger or smaller than it is. The
4211 * strange "usize" name dates from the early days of GTK+, and derives
4212 * from X Window System terminology. In many cases,
4213 * gtk_window_set_default_size() is a better choice for toplevel
4214 * windows than this function; setting the default size will still
4215 * allow users to shrink the window. Setting the usize will force them
4216 * to leave the window at least as large as the usize. When dealing
4217 * with window sizes, gtk_window_set_geometry_hints() can be a useful
4220 * Note the inherent danger of setting any fixed size - themes,
4221 * translations into other languages, different fonts, and user action
4222 * can all change the appropriate size for a given widget. So, it's
4223 * basically impossible to hardcode a size that will always be
4228 gtk_widget_set_usize (GtkWidget *widget,
4232 GtkWidgetAuxInfo *aux_info;
4234 g_return_if_fail (widget != NULL);
4235 g_return_if_fail (GTK_IS_WIDGET (widget));
4237 g_object_freeze_notify (G_OBJECT (widget));
4239 aux_info =_gtk_widget_get_aux_info (widget, TRUE);
4243 g_object_notify (G_OBJECT (widget), "width");
4244 aux_info->width = width;
4248 g_object_notify (G_OBJECT (widget), "height");
4249 aux_info->height = height;
4252 if (GTK_WIDGET_VISIBLE (widget))
4253 gtk_widget_queue_resize (widget);
4255 g_object_thaw_notify (G_OBJECT (widget));
4259 * gtk_widget_set_events:
4260 * @widget: a #GtkWidget
4261 * @events: event mask
4263 * Sets the event mask (see #GdkEventMask) for a widget. The event
4264 * mask determines which events a widget will receive. Keep in mind
4265 * that different widgets have different default event masks, and by
4266 * changing the event mask you may disrupt a widget's functionality,
4267 * so be careful. This function must be called while a widget is
4268 * unrealized. Consider gtk_widget_add_events() for widgets that are
4269 * already realized, or if you want to preserve the existing event
4270 * mask. This function can't be used with #GTK_NO_WINDOW widgets;
4271 * to get events on those widgets, place them inside a #GtkEventBox
4272 * and receive events on the event box.
4276 gtk_widget_set_events (GtkWidget *widget,
4281 g_return_if_fail (widget != NULL);
4282 g_return_if_fail (GTK_IS_WIDGET (widget));
4283 g_return_if_fail (!GTK_WIDGET_NO_WINDOW (widget));
4284 g_return_if_fail (!GTK_WIDGET_REALIZED (widget));
4286 eventp = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_event_mask);
4291 eventp = g_new (gint, 1);
4294 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_event_mask, eventp);
4299 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_event_mask);
4302 g_object_notify (G_OBJECT (widget), "events");
4306 * gtk_widget_add_events:
4307 * @widget: a #GtkWidget
4308 * @events: an event mask, see #GdkEventMask
4310 * Adds the events in the bitfield @events to the event mask for
4311 * @widget. See gtk_widget_set_events() for details.
4315 gtk_widget_add_events (GtkWidget *widget,
4320 g_return_if_fail (widget != NULL);
4321 g_return_if_fail (GTK_IS_WIDGET (widget));
4322 g_return_if_fail (!GTK_WIDGET_NO_WINDOW (widget));
4324 eventp = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_event_mask);
4330 eventp = g_new (gint, 1);
4335 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_event_mask, eventp);
4340 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_event_mask);
4343 if (GTK_WIDGET_REALIZED (widget))
4345 gdk_window_set_events (widget->window,
4346 gdk_window_get_events (widget->window) | events);
4349 g_object_notify (G_OBJECT (widget), "events");
4353 * gtk_widget_set_extension_events:
4354 * @widget: a #GtkWidget
4355 * @mode: bitfield of extension events to receive
4357 * Sets the extension events mask to @mode. See #GdkExtensionMode
4358 * and gdk_input_set_extension_events().
4362 gtk_widget_set_extension_events (GtkWidget *widget,
4363 GdkExtensionMode mode)
4365 GdkExtensionMode *modep;
4367 g_return_if_fail (widget != NULL);
4368 g_return_if_fail (GTK_IS_WIDGET (widget));
4370 modep = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_extension_event_mode);
4373 modep = g_new (GdkExtensionMode, 1);
4376 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_extension_event_mode, modep);
4377 g_object_notify (G_OBJECT (widget), "extension_events");
4381 * gtk_widget_get_toplevel:
4382 * @widget: a #GtkWidget
4384 * This function returns the topmost widget in the container hierarchy
4385 * @widget is a part of. If @widget has no parent widgets, it will be
4386 * returned as the topmost widget. No reference will be added to the
4387 * returned widget; it should not be unreferenced.
4389 * Note the difference in behavior vs. gtk_widget_get_ancestor();
4390 * gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW) would return
4391 * %NULL if @widget wasn't inside a toplevel window.
4393 * Return value: the topmost ancestor of @widget, or @widget itself if there's no ancestor
4396 gtk_widget_get_toplevel (GtkWidget *widget)
4398 g_return_val_if_fail (widget != NULL, NULL);
4399 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4401 while (widget->parent)
4402 widget = widget->parent;
4408 * gtk_widget_get_ancestor:
4409 * @widget: a #GtkWidget
4410 * @widget_type: ancestor type
4412 * Gets the first ancestor of @widget with type @widget_type. For example,
4413 * gtk_widget_get_ancestor (widget, GTK_TYPE_BOX) gets the first #GtkBox that's
4414 * an ancestor of @widget. No reference will be added to the returned widget;
4415 * it should not be unreferenced.
4417 * Return value: the ancestor widget, or %NULL if not found
4420 gtk_widget_get_ancestor (GtkWidget *widget,
4421 GtkType widget_type)
4423 g_return_val_if_fail (widget != NULL, NULL);
4424 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4426 while (widget && !gtk_type_is_a (GTK_WIDGET_TYPE (widget), widget_type))
4427 widget = widget->parent;
4429 if (!(widget && gtk_type_is_a (GTK_WIDGET_TYPE (widget), widget_type)))
4436 * gtk_widget_get_colormap:
4437 * @widget: a #GtkWidget
4439 * Gets the colormap that will be used to render @widget. No reference will
4440 * be added to the returned colormap; it should not be unreferenced.
4442 * Return value: the colormap used by @widget
4445 gtk_widget_get_colormap (GtkWidget *widget)
4447 GdkColormap *colormap;
4449 g_return_val_if_fail (widget != NULL, NULL);
4450 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4454 colormap = gdk_window_get_colormap (widget->window);
4455 /* If window was destroyed previously, we'll get NULL here */
4460 colormap = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_colormap);
4464 return gtk_widget_get_default_colormap ();
4468 * gtk_widget_get_visual:
4469 * @widget: a #GtkWidget
4471 * Gets the visual that will be used to render @widget.
4473 * Return value: the visual for @widget
4476 gtk_widget_get_visual (GtkWidget *widget)
4478 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4480 return gdk_colormap_get_visual (gtk_widget_get_colormap (widget));
4485 * gtk_widget_set_colormap:
4486 * @widget: a #GtkWidget
4487 * @colormap: a colormap
4489 * Set the colormap for the widget to the given value. Widget must not
4490 * have been previously realized. This probably should only be used
4491 * from an init() function (i.e. from the constructor for the widget).
4495 gtk_widget_set_colormap (GtkWidget *widget,
4496 GdkColormap *colormap)
4498 g_return_if_fail (widget != NULL);
4499 g_return_if_fail (GTK_IS_WIDGET (widget));
4500 g_return_if_fail (!GTK_WIDGET_REALIZED (widget));
4501 g_return_if_fail (GDK_IS_COLORMAP (colormap));
4503 g_object_ref (G_OBJECT (colormap));
4505 g_object_set_qdata_full (G_OBJECT (widget),
4508 (GtkDestroyNotify) g_object_unref);
4512 * gtk_widget_get_events:
4513 * @widget: a #GtkWidget
4515 * Returns the event mask for the widget (a bitfield containing flags
4516 * from the #GdkEventMask enumeration). These are the events that the widget
4519 * Return value: event mask for @widget
4522 gtk_widget_get_events (GtkWidget *widget)
4526 g_return_val_if_fail (widget != NULL, 0);
4527 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
4529 events = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_event_mask);
4537 * gtk_widget_get_extension_events:
4538 * @widget: a #GtkWidget
4540 * Retrieves the extension events the widget will receive; see
4541 * gdk_input_set_extension_events().
4543 * Return value: extension events for @widget
4546 gtk_widget_get_extension_events (GtkWidget *widget)
4548 GdkExtensionMode *mode;
4550 g_return_val_if_fail (widget != NULL, 0);
4551 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
4553 mode = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_extension_event_mode);
4561 * gtk_widget_get_pointer:
4562 * @widget: a #GtkWidget
4563 * @x: return location for the X coordinate, or %NULL
4564 * @y: return location for the Y coordinate, or %NULL
4566 * Obtains the location of the mouse pointer in widget coordinates.
4567 * Widget coordinates are a bit odd; for historical reasons, they are
4568 * defined as widget->window coordinates for widgets that are not
4569 * #GTK_NO_WINDOW widgets, and are relative to widget->allocation.x,
4570 * widget->allocation.y for widgets that are #GTK_NO_WINDOW widgets.
4574 gtk_widget_get_pointer (GtkWidget *widget,
4578 g_return_if_fail (widget != NULL);
4579 g_return_if_fail (GTK_IS_WIDGET (widget));
4586 if (GTK_WIDGET_REALIZED (widget))
4588 gdk_window_get_pointer (widget->window, x, y, NULL);
4590 if (GTK_WIDGET_NO_WINDOW (widget))
4593 *x -= widget->allocation.x;
4595 *y -= widget->allocation.y;
4601 * gtk_widget_is_ancestor:
4602 * @widget: a #GtkWidget
4603 * @ancestor: another #GtkWidget
4605 * Determines whether @widget is somewhere inside @ancestor, possibly with
4606 * intermediate containers.
4608 * Return value: %TRUE if @ancestor contains @widget as a child, grandchild, great grandchild, etc.
4611 gtk_widget_is_ancestor (GtkWidget *widget,
4612 GtkWidget *ancestor)
4614 g_return_val_if_fail (widget != NULL, FALSE);
4615 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4616 g_return_val_if_fail (ancestor != NULL, FALSE);
4620 if (widget->parent == ancestor)
4622 widget = widget->parent;
4628 static GQuark quark_composite_name = 0;
4631 gtk_widget_set_composite_name (GtkWidget *widget,
4634 g_return_if_fail (widget != NULL);
4635 g_return_if_fail (GTK_IS_WIDGET (widget));
4636 g_return_if_fail (GTK_WIDGET_COMPOSITE_CHILD (widget));
4637 g_return_if_fail (name != NULL);
4639 if (!quark_composite_name)
4640 quark_composite_name = g_quark_from_static_string ("gtk-composite-name");
4642 gtk_object_set_data_by_id_full (GTK_OBJECT (widget),
4643 quark_composite_name,
4649 gtk_widget_get_composite_name (GtkWidget *widget)
4651 g_return_val_if_fail (widget != NULL, NULL);
4652 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4654 if (GTK_WIDGET_COMPOSITE_CHILD (widget) && widget->parent)
4655 return gtk_container_child_composite_name (GTK_CONTAINER (widget->parent),
4662 gtk_widget_push_composite_child (void)
4664 composite_child_stack++;
4668 gtk_widget_pop_composite_child (void)
4670 if (composite_child_stack)
4671 composite_child_stack--;
4675 * gtk_widget_push_colormap:
4676 * @cmap: a #GdkColormap
4678 * Pushes @cmap onto a global stack of colormaps; the topmost
4679 * colormap on the stack will be used to create all widgets.
4680 * Remove @cmap with gtk_widget_pop_colormap(). There's little
4681 * reason to use this function.
4685 gtk_widget_push_colormap (GdkColormap *cmap)
4687 g_return_if_fail (cmap != NULL);
4689 colormap_stack = g_slist_prepend (colormap_stack, cmap);
4693 * gtk_widget_pop_colormap:
4695 * Removes a colormap pushed with gtk_widget_push_colormap().
4699 gtk_widget_pop_colormap (void)
4705 tmp = colormap_stack;
4706 colormap_stack = colormap_stack->next;
4707 g_slist_free_1 (tmp);
4712 * gtk_widget_set_default_colormap:
4713 * @colormap: a #GdkColormap
4715 * Sets the default colormap to use when creating widgets.
4716 * gtk_widget_push_colormap() is a better function to use if
4717 * you only want to affect a few widgets, rather than all widgets.
4721 gtk_widget_set_default_colormap (GdkColormap *colormap)
4723 if (default_colormap != colormap)
4725 if (default_colormap)
4726 gdk_colormap_unref (default_colormap);
4727 default_colormap = colormap;
4728 if (default_colormap)
4729 gdk_colormap_ref (default_colormap);
4734 * gtk_widget_get_default_colormap:
4736 * Obtains the default colormap used to create widgets.
4738 * Return value: default widget colormap
4741 gtk_widget_get_default_colormap (void)
4743 if (!default_colormap)
4744 gtk_widget_set_default_colormap (gdk_colormap_get_system ());
4746 return default_colormap;
4750 * gtk_widget_get_default_visual:
4752 * Obtains the visual of the default colormap. Not really useful;
4753 * used to be useful before gdk_colormap_get_visual() existed.
4755 * Return value: visual of the default colormap
4758 gtk_widget_get_default_visual (void)
4760 return gdk_colormap_get_visual (gtk_widget_get_default_colormap ());
4764 gtk_widget_emit_direction_changed (GtkWidget *widget,
4765 GtkTextDirection old_dir)
4767 PangoContext *context = gtk_widget_peek_pango_context (widget);
4770 pango_context_set_base_dir (context,
4771 gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR ?
4772 PANGO_DIRECTION_LTR : PANGO_DIRECTION_RTL);
4774 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[DIRECTION_CHANGED], old_dir);
4778 * gtk_widget_set_direction:
4779 * @widget: a #GtkWidget
4780 * @dir: the new direction
4782 * Set the reading direction on a particular widget. This direction
4783 * controls the primary direction for widgets containing text,
4784 * and also the direction in which the children of a container are
4785 * packed. The ability to set the direction is present in order
4786 * so that correct localization into languages with right-to-left
4787 * reading directions can be done. Generally, applications will
4788 * let the default reading direction present, except for containers
4789 * where the containers are arranged in an order that is explicitely
4790 * visual rather than logical (such as buttons for text justificiation).
4792 * If the direction is set to %GTK_TEXT_DIR_NONE, then the value
4793 * set by gtk_widget_set_default_direction() will be used.
4796 gtk_widget_set_direction (GtkWidget *widget,
4797 GtkTextDirection dir)
4799 GtkTextDirection old_dir;
4801 g_return_if_fail (widget != NULL);
4802 g_return_if_fail (GTK_IS_WIDGET (widget));
4803 g_return_if_fail (dir >= GTK_TEXT_DIR_NONE && dir <= GTK_TEXT_DIR_RTL);
4805 old_dir = gtk_widget_get_direction (widget);
4807 if (dir == GTK_TEXT_DIR_NONE)
4808 GTK_PRIVATE_UNSET_FLAG (widget, GTK_DIRECTION_SET);
4811 GTK_PRIVATE_SET_FLAG (widget, GTK_DIRECTION_SET);
4812 if (dir == GTK_TEXT_DIR_LTR)
4813 GTK_PRIVATE_SET_FLAG (widget, GTK_DIRECTION_LTR);
4815 GTK_PRIVATE_UNSET_FLAG (widget, GTK_DIRECTION_LTR);
4818 if (old_dir != gtk_widget_get_direction (widget))
4819 gtk_widget_emit_direction_changed (widget, old_dir);
4823 * gtk_widget_get_direction:
4824 * @widget: a #GtkWidget
4826 * Get the reading direction for a particular widget. See
4827 * gtk_widget_set_direction().
4829 * Return value: the reading direction for the widget.
4832 gtk_widget_get_direction (GtkWidget *widget)
4834 g_return_val_if_fail (widget != NULL, GTK_TEXT_DIR_LTR);
4835 g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_TEXT_DIR_LTR);
4837 if (GTK_WIDGET_DIRECTION_SET (widget))
4838 return GTK_WIDGET_DIRECTION_LTR (widget) ? GTK_TEXT_DIR_LTR : GTK_TEXT_DIR_RTL;
4840 return gtk_default_direction;
4844 gtk_widget_set_default_direction_recurse (GtkWidget *widget, gpointer data)
4846 GtkTextDirection old_dir = GPOINTER_TO_UINT (data);
4848 g_object_ref (G_OBJECT (widget));
4850 if (!GTK_WIDGET_DIRECTION_SET (widget))
4851 gtk_widget_emit_direction_changed (widget, old_dir);
4853 if (GTK_IS_CONTAINER (widget))
4854 gtk_container_forall (GTK_CONTAINER (widget),
4855 gtk_widget_set_default_direction_recurse,
4858 g_object_unref (G_OBJECT (widget));
4862 * gtk_widget_set_default_direction:
4863 * @dir: the new default direction. This cannot be
4864 * %GTK_TEXT_DIR_NONE.
4866 * Set the default reading direction for widgets where the
4867 * direction has not been explicitly set by gtk_widget_set_direction().
4870 gtk_widget_set_default_direction (GtkTextDirection dir)
4872 g_return_if_fail (dir == GTK_TEXT_DIR_RTL || dir == GTK_TEXT_DIR_LTR);
4874 if (dir != gtk_default_direction)
4876 GList *toplevels, *tmp_list;
4877 GtkTextDirection old_dir = gtk_default_direction;
4879 gtk_default_direction = dir;
4881 tmp_list = toplevels = gtk_window_list_toplevels ();
4882 g_list_foreach (toplevels, (GFunc)g_object_ref, NULL);
4886 gtk_widget_set_default_direction_recurse (tmp_list->data,
4887 GUINT_TO_POINTER (old_dir));
4888 g_object_unref (tmp_list->data);
4889 tmp_list = tmp_list->next;
4892 g_list_free (toplevels);
4897 * gtk_widget_get_default_direction:
4899 * Return value: the current default direction. See
4900 * gtk_widget_set_direction().
4903 gtk_widget_get_default_direction (void)
4905 return gtk_default_direction;
4909 gtk_widget_shutdown (GObject *object)
4911 GtkWidget *widget = GTK_WIDGET (object);
4914 gtk_container_remove (GTK_CONTAINER (widget->parent), widget);
4916 GTK_WIDGET_UNSET_FLAGS (widget, GTK_VISIBLE);
4917 if (GTK_WIDGET_REALIZED (widget))
4918 gtk_widget_unrealize (widget);
4920 G_OBJECT_CLASS (parent_class)->shutdown (object);
4924 gtk_widget_real_destroy (GtkObject *object)
4927 GtkStyle *saved_style;
4929 /* gtk_object_destroy() will already hold a refcount on object
4931 widget = GTK_WIDGET (object);
4933 gtk_grab_remove (widget);
4934 gtk_selection_remove_all (widget);
4936 saved_style = gtk_object_get_data_by_id (object, quark_saved_default_style);
4939 gtk_style_unref (saved_style);
4940 gtk_object_remove_data_by_id (object, quark_saved_default_style);
4943 gtk_style_unref (widget->style);
4944 widget->style = gtk_widget_peek_style ();
4945 gtk_style_ref (widget->style);
4947 GTK_OBJECT_CLASS (parent_class)->destroy (object);
4951 gtk_widget_finalize (GObject *object)
4953 GtkWidget *widget = GTK_WIDGET (object);
4954 GtkWidgetAuxInfo *aux_info;
4956 GdkExtensionMode *mode;
4957 GtkStyle *saved_style;
4958 GtkAccessible *accessible;
4960 gtk_grab_remove (widget);
4961 gtk_selection_remove_all (widget);
4963 saved_style = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_saved_default_style);
4966 gtk_style_unref (saved_style);
4967 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_saved_default_style);
4970 gtk_style_unref (widget->style);
4971 widget->style = NULL;
4974 g_free (widget->name);
4976 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
4978 gtk_widget_aux_info_destroy (aux_info);
4980 events = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_event_mask);
4984 mode = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_extension_event_mode);
4988 accessible = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_accessible_object);
4990 g_object_unref (G_OBJECT (accessible));
4992 G_OBJECT_CLASS (parent_class)->finalize (object);
4995 /*****************************************
4996 * gtk_widget_real_map:
5001 *****************************************/
5004 gtk_widget_real_map (GtkWidget *widget)
5006 g_return_if_fail (GTK_IS_WIDGET (widget));
5007 g_return_if_fail (GTK_WIDGET_REALIZED (widget) == TRUE);
5009 if (!GTK_WIDGET_MAPPED (widget))
5011 GTK_WIDGET_SET_FLAGS (widget, GTK_MAPPED);
5013 if (!GTK_WIDGET_NO_WINDOW (widget))
5014 gdk_window_show (widget->window);
5018 /*****************************************
5019 * gtk_widget_real_unmap:
5024 *****************************************/
5027 gtk_widget_real_unmap (GtkWidget *widget)
5029 g_return_if_fail (widget != NULL);
5030 g_return_if_fail (GTK_IS_WIDGET (widget));
5032 if (GTK_WIDGET_MAPPED (widget))
5034 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
5036 if (!GTK_WIDGET_NO_WINDOW (widget))
5037 gdk_window_hide (widget->window);
5041 /*****************************************
5042 * gtk_widget_real_realize:
5047 *****************************************/
5050 gtk_widget_real_realize (GtkWidget *widget)
5052 g_return_if_fail (widget != NULL);
5053 g_return_if_fail (GTK_IS_WIDGET (widget));
5054 g_return_if_fail (GTK_WIDGET_NO_WINDOW (widget));
5056 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
5059 widget->window = gtk_widget_get_parent_window (widget);
5060 gdk_window_ref (widget->window);
5062 widget->style = gtk_style_attach (widget->style, widget->window);
5065 /*****************************************
5066 * gtk_widget_real_unrealize:
5071 *****************************************/
5074 gtk_widget_real_unrealize (GtkWidget *widget)
5076 g_return_if_fail (widget != NULL);
5077 g_return_if_fail (GTK_IS_WIDGET (widget));
5079 if (GTK_WIDGET_MAPPED (widget))
5080 gtk_widget_real_unmap (widget);
5082 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
5084 /* printf ("unrealizing %s\n", gtk_type_name (GTK_OBJECT (widget)->klass->type));
5087 /* We must do unrealize child widget BEFORE container widget.
5088 * gdk_window_destroy() destroys specified xwindow and its sub-xwindows.
5089 * So, unrealizing container widget bofore its children causes the problem
5090 * (for example, gdk_ic_destroy () with destroyed window causes crash. )
5093 if (GTK_IS_CONTAINER (widget))
5094 gtk_container_forall (GTK_CONTAINER (widget),
5095 (GtkCallback) gtk_widget_unrealize,
5098 gtk_style_detach (widget->style);
5099 if (!GTK_WIDGET_NO_WINDOW (widget))
5101 gdk_window_set_user_data (widget->window, NULL);
5102 gdk_window_destroy (widget->window);
5103 widget->window = NULL;
5107 gdk_window_unref (widget->window);
5108 widget->window = NULL;
5111 GTK_WIDGET_UNSET_FLAGS (widget, GTK_REALIZED);
5115 gtk_widget_real_size_request (GtkWidget *widget,
5116 GtkRequisition *requisition)
5118 g_return_if_fail (widget != NULL);
5119 g_return_if_fail (GTK_IS_WIDGET (widget));
5121 requisition->width = widget->requisition.width;
5122 requisition->height = widget->requisition.height;
5125 /*****************************************
5126 * gtk_widget_peek_colormap:
5131 *****************************************/
5134 gtk_widget_peek_colormap (void)
5137 return (GdkColormap*) colormap_stack->data;
5138 return gtk_widget_get_default_colormap ();
5142 gtk_widget_propagate_state (GtkWidget *widget,
5147 /* don't call this function with state==GTK_STATE_INSENSITIVE,
5148 * parent_sensitive==TRUE on a sensitive widget
5151 old_state = GTK_WIDGET_STATE (widget);
5153 if (data->parent_sensitive)
5155 GTK_WIDGET_SET_FLAGS (widget, GTK_PARENT_SENSITIVE);
5157 if (GTK_WIDGET_IS_SENSITIVE (widget))
5159 if (data->state_restoration)
5160 GTK_WIDGET_STATE (widget) = GTK_WIDGET_SAVED_STATE (widget);
5162 GTK_WIDGET_STATE (widget) = data->state;
5166 GTK_WIDGET_STATE (widget) = GTK_STATE_INSENSITIVE;
5167 if (!data->state_restoration &&
5168 data->state != GTK_STATE_INSENSITIVE)
5169 GTK_WIDGET_SAVED_STATE (widget) = data->state;
5174 GTK_WIDGET_UNSET_FLAGS (widget, GTK_PARENT_SENSITIVE);
5175 if (!data->state_restoration)
5177 if (data->state != GTK_STATE_INSENSITIVE)
5178 GTK_WIDGET_SAVED_STATE (widget) = data->state;
5180 else if (GTK_WIDGET_STATE (widget) != GTK_STATE_INSENSITIVE)
5181 GTK_WIDGET_SAVED_STATE (widget) = GTK_WIDGET_STATE (widget);
5182 GTK_WIDGET_STATE (widget) = GTK_STATE_INSENSITIVE;
5185 if (GTK_WIDGET_HAS_FOCUS (widget) && !GTK_WIDGET_IS_SENSITIVE (widget))
5189 window = gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW);
5191 gtk_window_set_focus (GTK_WINDOW (window), NULL);
5194 if (old_state != GTK_WIDGET_STATE (widget))
5196 gtk_widget_ref (widget);
5197 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[STATE_CHANGED], old_state);
5199 if (GTK_IS_CONTAINER (widget))
5201 data->parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget) != FALSE);
5202 data->state = GTK_WIDGET_STATE (widget);
5203 if (data->use_forall)
5204 gtk_container_forall (GTK_CONTAINER (widget),
5205 (GtkCallback) gtk_widget_propagate_state,
5208 gtk_container_foreach (GTK_CONTAINER (widget),
5209 (GtkCallback) gtk_widget_propagate_state,
5212 gtk_widget_unref (widget);
5217 * _gtk_widget_get_aux_info:
5218 * @widget: a #GtkWidget
5219 * @create: if %TRUE, create the structure if it doesn't exist
5221 * Get the #GtkWidgetAuxInfo structure for the widget.
5223 * Return value: the #GtkAuxInfo structure for the widget, or
5224 * %NULL if @create is %FALSE and one doesn't already exist.
5227 _gtk_widget_get_aux_info (GtkWidget *widget,
5230 GtkWidgetAuxInfo *aux_info;
5232 aux_info = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_aux_info);
5233 if (!aux_info && create)
5235 if (!aux_info_mem_chunk)
5236 aux_info_mem_chunk = g_mem_chunk_new ("widget aux info mem chunk",
5237 sizeof (GtkWidgetAuxInfo),
5238 1024, G_ALLOC_AND_FREE);
5239 aux_info = g_chunk_new (GtkWidgetAuxInfo, aux_info_mem_chunk);
5241 aux_info->width = -1;
5242 aux_info->height = -1;
5245 aux_info->x_set = FALSE;
5246 aux_info->y_set = FALSE;
5247 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_aux_info, aux_info);
5253 /*****************************************
5254 * gtk_widget_aux_info_destroy:
5259 *****************************************/
5262 gtk_widget_aux_info_destroy (GtkWidgetAuxInfo *aux_info)
5264 g_return_if_fail (aux_info != NULL);
5266 g_mem_chunk_free (aux_info_mem_chunk, aux_info);
5270 gtk_widget_shape_info_destroy (GtkWidgetShapeInfo *info)
5272 gdk_drawable_unref (info->shape_mask);
5276 /*****************************************
5277 * gtk_widget_shape_combine_mask:
5278 * set a shape for this widgets' gdk window, this allows for
5279 * transparent windows etc., see gdk_window_shape_combine_mask
5280 * for more information
5285 *****************************************/
5287 gtk_widget_shape_combine_mask (GtkWidget *widget,
5288 GdkBitmap *shape_mask,
5292 GtkWidgetShapeInfo* shape_info;
5294 g_return_if_fail (widget != NULL);
5295 g_return_if_fail (GTK_IS_WIDGET (widget));
5296 /* set_shape doesn't work on widgets without gdk window */
5297 g_return_if_fail (!GTK_WIDGET_NO_WINDOW (widget));
5301 GTK_PRIVATE_UNSET_FLAG (widget, GTK_HAS_SHAPE_MASK);
5304 gdk_window_shape_combine_mask (widget->window, NULL, 0, 0);
5306 g_object_set_qdata (G_OBJECT (widget), quark_shape_info, NULL);
5310 GTK_PRIVATE_SET_FLAG (widget, GTK_HAS_SHAPE_MASK);
5312 shape_info = g_new (GtkWidgetShapeInfo, 1);
5313 g_object_set_qdata_full (G_OBJECT (widget), quark_shape_info, shape_info,
5314 (GDestroyNotify) gtk_widget_shape_info_destroy);
5316 shape_info->shape_mask = gdk_drawable_ref (shape_mask);
5317 shape_info->offset_x = offset_x;
5318 shape_info->offset_y = offset_y;
5320 /* set shape if widget has a gdk window allready.
5321 * otherwise the shape is scheduled to be set by gtk_widget_realize.
5324 gdk_window_shape_combine_mask (widget->window, shape_mask,
5325 offset_x, offset_y);
5330 gtk_reset_shapes_recurse (GtkWidget *widget,
5336 gdk_window_get_user_data (window, &data);
5340 gdk_window_shape_combine_mask (window, NULL, 0, 0);
5341 for (list = gdk_window_peek_children (window); list; list = list->next)
5342 gtk_reset_shapes_recurse (widget, list->data);
5346 gtk_widget_reset_shapes (GtkWidget *widget)
5348 g_return_if_fail (widget != NULL);
5349 g_return_if_fail (GTK_IS_WIDGET (widget));
5350 g_return_if_fail (GTK_WIDGET_REALIZED (widget));
5352 if (!GTK_WIDGET_HAS_SHAPE_MASK (widget))
5353 gtk_reset_shapes_recurse (widget, widget->window);
5358 * @widget: a #GtkWidget
5360 * Adds a reference to a widget. This function is exactly the same
5361 * as calling g_object_ref(), and exists mostly for historical
5362 * reasons. It can still be convenient to avoid casting a widget
5363 * to a #GObject, it saves a small amount of typing.
5365 * Return value: the widget that was referenced
5368 gtk_widget_ref (GtkWidget *widget)
5370 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5372 return (GtkWidget*) g_object_ref ((GObject*) widget);
5377 * @widget: a #GtkWidget
5379 * Inverse of gtk_widget_ref(). Equivalent to g_object_unref().
5383 gtk_widget_unref (GtkWidget *widget)
5385 g_return_if_fail (GTK_IS_WIDGET (widget));
5387 g_object_unref ((GObject*) widget);
5395 gtk_widget_class_install_style_property_parser (GtkWidgetClass *class,
5397 GtkRcPropertyParser parser)
5399 g_return_if_fail (GTK_IS_WIDGET_CLASS (class));
5400 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
5401 g_return_if_fail (pspec->flags & G_PARAM_READABLE);
5402 g_return_if_fail (!(pspec->flags & (G_PARAM_CONSTRUCT_ONLY | G_PARAM_CONSTRUCT)));
5404 if (g_param_spec_pool_lookup (style_property_spec_pool, pspec->name, G_OBJECT_CLASS_TYPE (class), FALSE))
5406 g_warning (G_STRLOC ": class `%s' already contains a style property named `%s'",
5407 G_OBJECT_CLASS_NAME (class),
5412 g_param_spec_ref (pspec);
5413 g_param_spec_sink (pspec);
5414 g_param_spec_set_qdata (pspec, quark_property_parser, parser);
5415 g_param_spec_pool_insert (style_property_spec_pool, pspec, G_OBJECT_CLASS_TYPE (class));
5419 gtk_widget_class_install_style_property (GtkWidgetClass *class,
5422 GtkRcPropertyParser parser;
5424 g_return_if_fail (GTK_IS_WIDGET_CLASS (class));
5425 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
5427 parser = _gtk_rc_property_parser_from_type (G_PARAM_SPEC_VALUE_TYPE (pspec));
5429 gtk_widget_class_install_style_property_parser (class, pspec, parser);
5433 gtk_widget_style_get_property (GtkWidget *widget,
5434 const gchar *property_name,
5439 g_return_if_fail (GTK_IS_WIDGET (widget));
5440 g_return_if_fail (property_name != NULL);
5441 g_return_if_fail (G_IS_VALUE (value));
5443 g_object_ref (widget);
5444 pspec = g_param_spec_pool_lookup (style_property_spec_pool,
5446 G_OBJECT_TYPE (widget),
5449 g_warning ("%s: widget class `%s' has no property named `%s'",
5451 G_OBJECT_TYPE_NAME (widget),
5455 const GValue *peek_value;
5457 peek_value = _gtk_style_peek_property_value (widget->style,
5458 G_OBJECT_TYPE (widget),
5460 g_param_spec_get_qdata (pspec, quark_property_parser));
5462 /* auto-conversion of the caller's value type
5464 if (G_VALUE_TYPE (value) == G_PARAM_SPEC_VALUE_TYPE (pspec))
5465 g_value_copy (peek_value, value);
5466 else if (g_value_type_transformable (G_PARAM_SPEC_VALUE_TYPE (pspec), G_VALUE_TYPE (value)))
5467 g_value_transform (peek_value, value);
5469 g_warning ("can't retrive style property `%s' of type `%s' as value of type `%s'",
5471 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
5472 G_VALUE_TYPE_NAME (value));
5474 g_object_unref (widget);
5478 gtk_widget_style_get_valist (GtkWidget *widget,
5479 const gchar *first_property_name,
5484 g_return_if_fail (GTK_IS_WIDGET (widget));
5486 g_object_ref (widget);
5488 name = first_property_name;
5491 const GValue *peek_value;
5495 pspec = g_param_spec_pool_lookup (style_property_spec_pool,
5497 G_OBJECT_TYPE (widget),
5501 g_warning ("%s: widget class `%s' has no property named `%s'",
5503 G_OBJECT_TYPE_NAME (widget),
5507 /* style pspecs are always readable so we can spare that check here */
5509 peek_value = _gtk_style_peek_property_value (widget->style,
5510 G_OBJECT_TYPE (widget),
5512 g_param_spec_get_qdata (pspec, quark_property_parser));
5513 G_VALUE_LCOPY (peek_value, var_args, 0, &error);
5516 g_warning ("%s: %s", G_STRLOC, error);
5521 name = va_arg (var_args, gchar*);
5524 g_object_unref (widget);
5528 gtk_widget_style_get (GtkWidget *widget,
5529 const gchar *first_property_name,
5534 g_return_if_fail (GTK_IS_WIDGET (widget));
5536 va_start (var_args, first_property_name);
5537 gtk_widget_style_get_valist (widget, first_property_name, var_args);
5543 * @widget: a #GtkWidget
5544 * @path_length: location to store length of the path
5545 * @path: location to store allocated path string
5546 * @path_reversed: location to store allocated reverse path string
5548 * Obtains the full path to @widget. The path is simply the name of a
5549 * widget and all its parents in the container hierarchy, separated by
5550 * periods. The name of a widget comes from
5551 * gtk_widget_get_name(). Paths are used to apply styles to a widget
5552 * in gtkrc configuration files. Widget names are the type of the
5553 * widget by default (e.g. "GtkButton") or can be set to an
5554 * application-specific value with gtk_widget_set_name(). By setting
5555 * the name of a widget, you allow users or theme authors to apply
5556 * styles to that specific widget in their gtkrc
5557 * file. @path_reversed_p fills in the path in reverse order,
5558 * i.e. starting with @widget's name instead of starting with the name
5559 * of @widget's outermost ancestor.
5563 gtk_widget_path (GtkWidget *widget,
5564 guint *path_length_p,
5566 gchar **path_reversed_p)
5568 static gchar *rev_path = NULL;
5569 static guint path_len = 0;
5572 g_return_if_fail (widget != NULL);
5573 g_return_if_fail (GTK_IS_WIDGET (widget));
5578 const gchar *string;
5583 string = gtk_widget_get_name (widget);
5584 l = strlen (string);
5585 while (path_len <= len + l + 1)
5587 path_len += INIT_PATH_SIZE;
5588 rev_path = g_realloc (rev_path, path_len);
5596 widget = widget->parent;
5599 rev_path[len++] = '.';
5601 rev_path[len++] = 0;
5606 *path_length_p = len - 1;
5607 if (path_reversed_p)
5608 *path_reversed_p = g_strdup (rev_path);
5611 *path_p = g_strdup (rev_path);
5612 g_strreverse (*path_p);
5617 * gtk_widget_class_path:
5618 * @widget: a #GtkWidget
5619 * @path_length: location to store the length of the class path
5620 * @path: location to store the class path as an allocated string
5621 * @path_reversed: location to store the reverse class path as an allocated string
5623 * Same as gtk_widget_path(), but always uses the name of a widget's type,
5624 * never uses a custom name set with gtk_widget_set_name().
5628 gtk_widget_class_path (GtkWidget *widget,
5629 guint *path_length_p,
5631 gchar **path_reversed_p)
5633 static gchar *rev_path = NULL;
5634 static guint path_len = 0;
5637 g_return_if_fail (widget != NULL);
5638 g_return_if_fail (GTK_IS_WIDGET (widget));
5643 const gchar *string;
5648 string = gtk_type_name (GTK_WIDGET_TYPE (widget));
5649 l = strlen (string);
5650 while (path_len <= len + l + 1)
5652 path_len += INIT_PATH_SIZE;
5653 rev_path = g_realloc (rev_path, path_len);
5661 widget = widget->parent;
5664 rev_path[len++] = '.';
5666 rev_path[len++] = 0;
5671 *path_length_p = len - 1;
5672 if (path_reversed_p)
5673 *path_reversed_p = g_strdup (rev_path);
5676 *path_p = g_strdup (rev_path);
5677 g_strreverse (*path_p);
5682 gtk_requisition_copy (const GtkRequisition *requisition)
5684 return (GtkRequisition *)g_memdup (requisition, sizeof (GtkRequisition));
5688 gtk_requisition_free (GtkRequisition *requisition)
5690 g_free (requisition);
5693 AtkObject* gtk_widget_get_accessible (GtkWidget *widget)
5695 GtkWidgetClass *klass;
5697 g_return_val_if_fail (widget != NULL, NULL);
5698 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5700 klass = GTK_WIDGET_GET_CLASS (widget);
5702 g_return_val_if_fail (klass->get_accessible != NULL, NULL);
5704 return klass->get_accessible(widget);
5707 AtkObject* gtk_widget_real_get_accessible (GtkWidget *widget)
5709 AtkObject* accessible;
5711 accessible = g_object_get_qdata (G_OBJECT (widget),
5712 quark_accessible_object);
5715 AtkObjectFactory *factory;
5716 AtkRegistry *default_registry;
5718 default_registry = atk_get_default_registry ();
5719 factory = atk_registry_get_factory (default_registry,
5720 GTK_OBJECT_TYPE (widget));
5722 atk_object_factory_create_accessible (factory,
5724 g_object_set_qdata (G_OBJECT (widget),
5725 quark_accessible_object,
5732 * Initialize a AtkImplementorIface instance's virtual pointers as
5733 * appropriate to this implementor's class (GtkWidget).
5736 gtk_widget_accessible_interface_init (AtkImplementorIface *iface)
5738 iface->ref_accessible = gtk_widget_ref_accessible;
5742 gtk_widget_ref_accessible(AtkImplementor *implementor)
5744 AtkObject *accessible;
5746 accessible = gtk_widget_get_accessible (GTK_WIDGET (implementor));
5748 g_object_ref (G_OBJECT (accessible));