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 "gtksignal.h"
38 #include "gtkwidget.h"
39 #include "gtkwindow.h"
40 #include "gtkbindings.h"
41 #include "gtkprivate.h"
43 #include "gdk/gdkprivate.h" /* Used in gtk_reset_shapes_recurse to avoid copy */
44 #include "gobject/gvaluecollector.h"
45 #include "gdk/gdkkeysyms.h"
47 #include "gtkaccessible.h"
49 #define WIDGET_CLASS(w) GTK_WIDGET_GET_CLASS (w)
50 #define INIT_PATH_SIZE (512)
88 PROPERTY_NOTIFY_EVENT,
89 SELECTION_CLEAR_EVENT,
90 SELECTION_REQUEST_EVENT,
91 SELECTION_NOTIFY_EVENT,
106 VISIBILITY_NOTIFY_EVENT,
127 PROP_RECEIVES_DEFAULT,
128 PROP_COMPOSITE_CHILD,
131 PROP_EXTENSION_EVENTS
134 typedef struct _GtkStateData GtkStateData;
139 guint state_restoration : 1;
140 guint parent_sensitive : 1;
141 guint use_forall : 1;
144 static void gtk_widget_class_init (GtkWidgetClass *klass);
145 static void gtk_widget_init (GtkWidget *widget);
146 static void gtk_widget_set_property (GObject *object,
150 static void gtk_widget_get_property (GObject *object,
154 static void gtk_widget_shutdown (GObject *object);
155 static void gtk_widget_real_destroy (GtkObject *object);
156 static void gtk_widget_finalize (GObject *object);
157 static void gtk_widget_real_show (GtkWidget *widget);
158 static void gtk_widget_real_hide (GtkWidget *widget);
159 static void gtk_widget_real_map (GtkWidget *widget);
160 static void gtk_widget_real_unmap (GtkWidget *widget);
161 static void gtk_widget_real_realize (GtkWidget *widget);
162 static void gtk_widget_real_unrealize (GtkWidget *widget);
163 static void gtk_widget_real_size_request (GtkWidget *widget,
164 GtkRequisition *requisition);
165 static void gtk_widget_real_size_allocate (GtkWidget *widget,
166 GtkAllocation *allocation);
167 static gboolean gtk_widget_real_key_press_event (GtkWidget *widget,
169 static gboolean gtk_widget_real_key_release_event (GtkWidget *widget,
171 static gboolean gtk_widget_real_focus_in_event (GtkWidget *widget,
172 GdkEventFocus *event);
173 static gboolean gtk_widget_real_focus_out_event (GtkWidget *widget,
174 GdkEventFocus *event);
176 static void gtk_widget_style_set (GtkWidget *widget,
177 GtkStyle *previous_style);
178 static void gtk_widget_direction_changed (GtkWidget *widget,
179 GtkTextDirection previous_direction);
180 static void gtk_widget_real_grab_focus (GtkWidget *focus_widget);
182 static GdkColormap* gtk_widget_peek_colormap (void);
183 static GtkStyle* gtk_widget_peek_style (void);
184 static PangoContext *gtk_widget_peek_pango_context (GtkWidget *widget);
186 static void gtk_widget_reparent_container_child (GtkWidget *widget,
187 gpointer client_data);
188 static void gtk_widget_propagate_state (GtkWidget *widget,
190 static void gtk_widget_set_style_internal (GtkWidget *widget,
192 gboolean initial_emission);
193 static void gtk_widget_set_style_recurse (GtkWidget *widget,
194 gpointer client_data);
195 static gint gtk_widget_event_internal (GtkWidget *widget,
198 static void gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
199 gpointer client_data);
200 static gboolean gtk_widget_real_mnemonic_activate (GtkWidget *widget,
201 gboolean group_cycling);
203 static void gtk_widget_aux_info_destroy (GtkWidgetAuxInfo *aux_info);
205 static void gtk_widget_do_uposition (GtkWidget *widget);
207 static AtkObject* gtk_widget_real_get_accessible (GtkWidget *widget);
208 static void gtk_widget_accessible_interface_init (AtkImplementorIface *iface);
209 static AtkObject * gtk_widget_ref_accessible (AtkImplementor *implementor);
211 static gpointer parent_class = NULL;
212 static guint widget_signals[LAST_SIGNAL] = { 0 };
214 static GMemChunk *aux_info_mem_chunk = NULL;
215 static GdkColormap *default_colormap = NULL;
216 static GtkStyle *gtk_default_style = NULL;
217 static GSList *colormap_stack = NULL;
218 static GSList *style_stack = NULL;
219 static guint composite_child_stack = 0;
220 static GtkTextDirection gtk_default_direction = GTK_TEXT_DIR_LTR;
221 static GParamSpecPool *style_property_spec_pool = NULL;
223 static GQuark quark_property_parser = 0;
224 static GQuark quark_aux_info = 0;
225 static GQuark quark_event_mask = 0;
226 static GQuark quark_extension_event_mode = 0;
227 static GQuark quark_parent_window = 0;
228 static GQuark quark_saved_default_style = 0;
229 static GQuark quark_shape_info = 0;
230 static GQuark quark_colormap = 0;
231 static GQuark quark_pango_context = 0;
232 static GQuark quark_rc_style = 0;
233 static GQuark quark_accessible_object = 0;
236 /*****************************************
237 * gtk_widget_get_type:
242 *****************************************/
245 gtk_widget_get_type (void)
247 static GtkType widget_type = 0;
251 static const GtkTypeInfo widget_info =
255 sizeof (GtkWidgetClass),
256 (GtkClassInitFunc) gtk_widget_class_init,
257 (GtkObjectInitFunc) gtk_widget_init,
258 /* reserved_1 */ NULL,
259 /* reserved_2 */ NULL,
260 (GtkClassInitFunc) NULL,
263 static const GInterfaceInfo accessibility_info =
265 (GInterfaceInitFunc) gtk_widget_accessible_interface_init,
266 (GInterfaceFinalizeFunc) NULL,
267 NULL /* interface data */
271 widget_type = gtk_type_unique (GTK_TYPE_OBJECT, &widget_info);
273 g_type_add_interface_static (widget_type, ATK_TYPE_IMPLEMENTOR,
274 &accessibility_info) ;
281 /*****************************************
282 * gtk_widget_class_init:
287 *****************************************/
289 gtk_widget_class_init (GtkWidgetClass *klass)
291 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
292 GtkObjectClass *object_class = GTK_OBJECT_CLASS (klass);
293 GtkBindingSet *binding_set;
295 parent_class = gtk_type_class (GTK_TYPE_OBJECT);
297 gobject_class->shutdown = gtk_widget_shutdown;
298 gobject_class->finalize = gtk_widget_finalize;
299 gobject_class->set_property = gtk_widget_set_property;
300 gobject_class->get_property = gtk_widget_get_property;
302 object_class->destroy = gtk_widget_real_destroy;
304 klass->activate_signal = 0;
305 klass->set_scroll_adjustments_signal = 0;
306 klass->show = gtk_widget_real_show;
307 klass->show_all = gtk_widget_show;
308 klass->hide = gtk_widget_real_hide;
309 klass->hide_all = gtk_widget_hide;
310 klass->map = gtk_widget_real_map;
311 klass->unmap = gtk_widget_real_unmap;
312 klass->realize = gtk_widget_real_realize;
313 klass->unrealize = gtk_widget_real_unrealize;
314 klass->size_request = gtk_widget_real_size_request;
315 klass->size_allocate = gtk_widget_real_size_allocate;
316 klass->state_changed = NULL;
317 klass->parent_set = NULL;
318 klass->hierarchy_changed = NULL;
319 klass->style_set = gtk_widget_style_set;
320 klass->direction_changed = gtk_widget_direction_changed;
321 klass->add_accelerator = (void*) gtk_accel_group_handle_add;
322 klass->remove_accelerator = (void*) gtk_accel_group_handle_remove;
323 klass->mnemonic_activate = gtk_widget_real_mnemonic_activate;
324 klass->grab_focus = gtk_widget_real_grab_focus;
326 klass->button_press_event = NULL;
327 klass->button_release_event = NULL;
328 klass->motion_notify_event = NULL;
329 klass->delete_event = NULL;
330 klass->destroy_event = NULL;
331 klass->expose_event = NULL;
332 klass->key_press_event = gtk_widget_real_key_press_event;
333 klass->key_release_event = gtk_widget_real_key_release_event;
334 klass->enter_notify_event = NULL;
335 klass->leave_notify_event = NULL;
336 klass->configure_event = NULL;
337 klass->focus_in_event = gtk_widget_real_focus_in_event;
338 klass->focus_out_event = gtk_widget_real_focus_out_event;
339 klass->map_event = NULL;
340 klass->unmap_event = NULL;
341 klass->window_state_event = NULL;
342 klass->property_notify_event = gtk_selection_property_notify;
343 klass->selection_clear_event = gtk_selection_clear;
344 klass->selection_request_event = gtk_selection_request;
345 klass->selection_notify_event = gtk_selection_notify;
346 klass->selection_received = NULL;
347 klass->proximity_in_event = NULL;
348 klass->proximity_out_event = NULL;
349 klass->drag_begin = NULL;
350 klass->drag_end = NULL;
351 klass->drag_data_delete = NULL;
352 klass->drag_leave = NULL;
353 klass->drag_motion = NULL;
354 klass->drag_drop = NULL;
355 klass->drag_data_received = NULL;
357 /* Accessibility support */
358 klass->get_accessible = gtk_widget_real_get_accessible;
360 klass->no_expose_event = NULL;
362 quark_property_parser = g_quark_from_static_string ("gtk-rc-property-parser");
363 quark_aux_info = g_quark_from_static_string ("gtk-aux-info");
364 quark_event_mask = g_quark_from_static_string ("gtk-event-mask");
365 quark_extension_event_mode = g_quark_from_static_string ("gtk-extension-event-mode");
366 quark_parent_window = g_quark_from_static_string ("gtk-parent-window");
367 quark_saved_default_style = g_quark_from_static_string ("gtk-saved-default-style");
368 quark_shape_info = g_quark_from_static_string ("gtk-shape-info");
369 quark_colormap = g_quark_from_static_string ("gtk-colormap");
370 quark_pango_context = g_quark_from_static_string ("gtk-pango-context");
371 quark_rc_style = g_quark_from_static_string ("gtk-rc-style");
372 quark_accessible_object = g_quark_from_static_string ("gtk-accessible-object");
374 style_property_spec_pool = g_param_spec_pool_new (FALSE);
376 g_object_class_install_property (gobject_class,
378 g_param_spec_string ("name",
380 _("The name of the widget"),
384 g_object_class_install_property (gobject_class,
386 g_param_spec_object ("parent",
388 _("The parent widget of this widget. Must be a Container widget."),
392 g_object_class_install_property (gobject_class,
394 g_param_spec_int ("x",
396 _("The x coordinate of the top-left corner of the widget, or -1 if not set"),
402 g_object_class_install_property (gobject_class,
404 g_param_spec_int ("y",
406 _("The y coordinate of the top-left corner of the widget, or -1 if not set"),
412 g_object_class_install_property (gobject_class,
414 g_param_spec_int ("width",
416 _("The width of the widget, or -1 if unset."),
422 g_object_class_install_property (gobject_class,
424 g_param_spec_int ("height",
426 _("The height of the widget, or -1 if unset."),
432 g_object_class_install_property (gobject_class,
434 g_param_spec_boolean ("visible",
436 _("Whether the widget is visible"),
440 g_object_class_install_property (gobject_class,
442 g_param_spec_boolean ("sensitive",
444 _("Whether the widget responds to input"),
448 g_object_class_install_property (gobject_class,
450 g_param_spec_boolean ("app_paintable",
451 _("Application paintable"),
452 _("Whether the application will paint directly on the widget"),
456 g_object_class_install_property (gobject_class,
458 g_param_spec_boolean ("can_focus",
460 _("Whether the widget can accept the input focus"),
464 g_object_class_install_property (gobject_class,
466 g_param_spec_boolean ("has_focus",
468 _("Whether the widget has the input focus"),
472 g_object_class_install_property (gobject_class,
474 g_param_spec_boolean ("can_default",
476 _("Whether the widget can be the default widget"),
480 g_object_class_install_property (gobject_class,
482 g_param_spec_boolean ("has_default",
484 _("Whether the widget is the default widget"),
488 g_object_class_install_property (gobject_class,
489 PROP_RECEIVES_DEFAULT,
490 g_param_spec_boolean ("receives_default",
491 _("Receives default"),
492 _("If TRUE, the widget will receive the default action when it is focused."),
496 g_object_class_install_property (gobject_class,
497 PROP_COMPOSITE_CHILD,
498 g_param_spec_boolean ("composite_child",
499 _("Composite child"),
500 _("Whether the widget is composed of other widgets"),
505 g_object_class_install_property (gobject_class,
507 g_param_spec_object ("style",
509 _("The style of the widget, which contains information about how it will look (colors etc)."),
513 g_object_class_install_property (gobject_class,
515 g_param_spec_flags ("events",
517 _("The event mask that decides what kind of GdkEvents this widget gets."),
522 g_object_class_install_property (gobject_class,
523 PROP_EXTENSION_EVENTS,
524 g_param_spec_enum ("extension_events",
525 _("Extension events"),
526 _("The mask that decides what kind of extension events this widget gets."),
527 GDK_TYPE_EXTENSION_MODE,
528 GDK_EXTENSION_EVENTS_NONE,
532 widget_signals[SHOW] =
533 gtk_signal_new ("show",
535 GTK_CLASS_TYPE (object_class),
536 GTK_SIGNAL_OFFSET (GtkWidgetClass, show),
537 gtk_marshal_VOID__VOID,
539 widget_signals[HIDE] =
540 gtk_signal_new ("hide",
542 GTK_CLASS_TYPE (object_class),
543 GTK_SIGNAL_OFFSET (GtkWidgetClass, hide),
544 gtk_marshal_VOID__VOID,
546 widget_signals[MAP] =
547 gtk_signal_new ("map",
549 GTK_CLASS_TYPE (object_class),
550 GTK_SIGNAL_OFFSET (GtkWidgetClass, map),
551 gtk_marshal_VOID__VOID,
553 widget_signals[UNMAP] =
554 gtk_signal_new ("unmap",
556 GTK_CLASS_TYPE (object_class),
557 GTK_SIGNAL_OFFSET (GtkWidgetClass, unmap),
558 gtk_marshal_VOID__VOID,
560 widget_signals[REALIZE] =
561 gtk_signal_new ("realize",
563 GTK_CLASS_TYPE (object_class),
564 GTK_SIGNAL_OFFSET (GtkWidgetClass, realize),
565 gtk_marshal_VOID__VOID,
567 widget_signals[UNREALIZE] =
568 gtk_signal_new ("unrealize",
570 GTK_CLASS_TYPE (object_class),
571 GTK_SIGNAL_OFFSET (GtkWidgetClass, unrealize),
572 gtk_marshal_VOID__VOID,
574 widget_signals[SIZE_REQUEST] =
575 g_signal_newc ("size_request",
576 G_OBJECT_CLASS_TYPE (object_class),
578 G_STRUCT_OFFSET (GtkWidgetClass, size_request),
580 gtk_marshal_VOID__BOXED,
582 GTK_TYPE_REQUISITION | G_SIGNAL_TYPE_STATIC_SCOPE);
583 widget_signals[SIZE_ALLOCATE] =
584 gtk_signal_new ("size_allocate",
586 GTK_CLASS_TYPE (object_class),
587 GTK_SIGNAL_OFFSET (GtkWidgetClass, size_allocate),
588 gtk_marshal_VOID__POINTER,
591 widget_signals[STATE_CHANGED] =
592 gtk_signal_new ("state_changed",
594 GTK_CLASS_TYPE (object_class),
595 GTK_SIGNAL_OFFSET (GtkWidgetClass, state_changed),
596 gtk_marshal_VOID__ENUM,
598 GTK_TYPE_STATE_TYPE);
599 widget_signals[PARENT_SET] =
600 gtk_signal_new ("parent_set",
602 GTK_CLASS_TYPE (object_class),
603 GTK_SIGNAL_OFFSET (GtkWidgetClass, parent_set),
604 gtk_marshal_VOID__OBJECT,
607 widget_signals[HIERARCHY_CHANGED] =
608 gtk_signal_new ("hierarchy_changed",
610 GTK_CLASS_TYPE (object_class),
611 GTK_SIGNAL_OFFSET (GtkWidgetClass, hierarchy_changed),
612 gtk_marshal_NONE__NONE,
614 widget_signals[STYLE_SET] =
615 gtk_signal_new ("style_set",
617 GTK_CLASS_TYPE (object_class),
618 GTK_SIGNAL_OFFSET (GtkWidgetClass, style_set),
619 gtk_marshal_VOID__OBJECT,
622 widget_signals[DIRECTION_CHANGED] =
623 gtk_signal_new ("direction_changed",
625 GTK_CLASS_TYPE (object_class),
626 GTK_SIGNAL_OFFSET (GtkWidgetClass, direction_changed),
627 gtk_marshal_VOID__ENUM,
629 GTK_TYPE_TEXT_DIRECTION);
630 widget_signals[ADD_ACCELERATOR] =
631 gtk_accel_group_create_add (GTK_CLASS_TYPE (object_class), GTK_RUN_LAST,
632 GTK_SIGNAL_OFFSET (GtkWidgetClass, add_accelerator));
633 widget_signals[REMOVE_ACCELERATOR] =
634 gtk_accel_group_create_remove (GTK_CLASS_TYPE (object_class), GTK_RUN_LAST,
635 GTK_SIGNAL_OFFSET (GtkWidgetClass, remove_accelerator));
636 widget_signals[ACTIVATE_MNEMONIC] =
637 g_signal_newc ("mnemonic_activate",
638 GTK_CLASS_TYPE (object_class),
640 GTK_SIGNAL_OFFSET (GtkWidgetClass, mnemonic_activate),
641 _gtk_boolean_handled_accumulator, NULL,
642 gtk_marshal_BOOLEAN__BOOLEAN,
645 widget_signals[GRAB_FOCUS] =
646 gtk_signal_new ("grab_focus",
647 GTK_RUN_LAST | GTK_RUN_ACTION,
648 GTK_CLASS_TYPE (object_class),
649 GTK_SIGNAL_OFFSET (GtkWidgetClass, grab_focus),
650 gtk_marshal_VOID__VOID,
652 widget_signals[EVENT] =
653 g_signal_newc ("event",
654 G_TYPE_FROM_CLASS(object_class),
656 G_STRUCT_OFFSET(GtkWidgetClass, event),
657 _gtk_boolean_handled_accumulator, NULL,
658 gtk_marshal_BOOLEAN__BOXED,
661 widget_signals[BUTTON_PRESS_EVENT] =
662 g_signal_newc ("button_press_event",
663 G_TYPE_FROM_CLASS(object_class),
665 G_STRUCT_OFFSET(GtkWidgetClass, button_press_event),
666 _gtk_boolean_handled_accumulator, NULL,
667 gtk_marshal_BOOLEAN__BOXED,
670 widget_signals[BUTTON_RELEASE_EVENT] =
671 g_signal_newc ("button_release_event",
672 G_TYPE_FROM_CLASS(object_class),
674 G_STRUCT_OFFSET(GtkWidgetClass, button_release_event),
675 _gtk_boolean_handled_accumulator, NULL,
676 gtk_marshal_BOOLEAN__BOXED,
679 widget_signals[SCROLL_EVENT] =
680 g_signal_newc ("scroll_event",
681 G_TYPE_FROM_CLASS(object_class),
683 G_STRUCT_OFFSET(GtkWidgetClass, scroll_event),
684 _gtk_boolean_handled_accumulator, NULL,
685 gtk_marshal_BOOLEAN__BOXED,
688 widget_signals[MOTION_NOTIFY_EVENT] =
689 g_signal_newc ("motion_notify_event",
690 G_TYPE_FROM_CLASS(object_class),
692 G_STRUCT_OFFSET(GtkWidgetClass, motion_notify_event),
693 _gtk_boolean_handled_accumulator, NULL,
694 gtk_marshal_BOOLEAN__BOXED,
697 widget_signals[DELETE_EVENT] =
698 g_signal_newc ("delete_event",
699 G_TYPE_FROM_CLASS(object_class),
701 G_STRUCT_OFFSET(GtkWidgetClass, delete_event),
702 _gtk_boolean_handled_accumulator, NULL,
703 gtk_marshal_BOOLEAN__BOXED,
706 widget_signals[DESTROY_EVENT] =
707 g_signal_newc ("destroy_event",
708 G_TYPE_FROM_CLASS(object_class),
710 G_STRUCT_OFFSET(GtkWidgetClass, destroy_event),
711 _gtk_boolean_handled_accumulator, NULL,
712 gtk_marshal_BOOLEAN__BOXED,
715 widget_signals[EXPOSE_EVENT] =
716 g_signal_newc ("expose_event",
717 G_TYPE_FROM_CLASS(object_class),
719 G_STRUCT_OFFSET(GtkWidgetClass, expose_event),
720 _gtk_boolean_handled_accumulator, NULL,
721 gtk_marshal_BOOLEAN__BOXED,
724 widget_signals[KEY_PRESS_EVENT] =
725 g_signal_newc ("key_press_event",
726 G_TYPE_FROM_CLASS(object_class),
728 G_STRUCT_OFFSET(GtkWidgetClass, key_press_event),
729 _gtk_boolean_handled_accumulator, NULL,
730 gtk_marshal_BOOLEAN__BOXED,
733 widget_signals[KEY_RELEASE_EVENT] =
734 g_signal_newc ("key_release_event",
735 G_TYPE_FROM_CLASS(object_class),
737 G_STRUCT_OFFSET(GtkWidgetClass, key_release_event),
738 _gtk_boolean_handled_accumulator, NULL,
739 gtk_marshal_BOOLEAN__BOXED,
742 widget_signals[ENTER_NOTIFY_EVENT] =
743 g_signal_newc ("enter_notify_event",
744 G_TYPE_FROM_CLASS(object_class),
746 G_STRUCT_OFFSET(GtkWidgetClass, enter_notify_event),
747 _gtk_boolean_handled_accumulator, NULL,
748 gtk_marshal_BOOLEAN__BOXED,
751 widget_signals[LEAVE_NOTIFY_EVENT] =
752 g_signal_newc ("leave_notify_event",
753 G_TYPE_FROM_CLASS(object_class),
755 G_STRUCT_OFFSET(GtkWidgetClass, leave_notify_event),
756 _gtk_boolean_handled_accumulator, NULL,
757 gtk_marshal_BOOLEAN__BOXED,
760 widget_signals[CONFIGURE_EVENT] =
761 g_signal_newc ("configure_event",
762 G_TYPE_FROM_CLASS(object_class),
764 G_STRUCT_OFFSET(GtkWidgetClass, configure_event),
765 _gtk_boolean_handled_accumulator, NULL,
766 gtk_marshal_BOOLEAN__BOXED,
769 widget_signals[FOCUS_IN_EVENT] =
770 g_signal_newc ("focus_in_event",
771 G_TYPE_FROM_CLASS(object_class),
773 G_STRUCT_OFFSET(GtkWidgetClass, focus_in_event),
774 _gtk_boolean_handled_accumulator, NULL,
775 gtk_marshal_BOOLEAN__BOXED,
778 widget_signals[FOCUS_OUT_EVENT] =
779 g_signal_newc ("focus_out_event",
780 G_TYPE_FROM_CLASS(object_class),
782 G_STRUCT_OFFSET(GtkWidgetClass, focus_out_event),
783 _gtk_boolean_handled_accumulator, NULL,
784 gtk_marshal_BOOLEAN__BOXED,
787 widget_signals[MAP_EVENT] =
788 g_signal_newc ("map_event",
789 G_TYPE_FROM_CLASS(object_class),
791 G_STRUCT_OFFSET(GtkWidgetClass, map_event),
792 _gtk_boolean_handled_accumulator, NULL,
793 gtk_marshal_BOOLEAN__BOXED,
796 widget_signals[UNMAP_EVENT] =
797 g_signal_newc ("unmap_event",
798 G_TYPE_FROM_CLASS(object_class),
800 G_STRUCT_OFFSET(GtkWidgetClass, unmap_event),
801 _gtk_boolean_handled_accumulator, NULL,
802 gtk_marshal_BOOLEAN__BOXED,
805 widget_signals[PROPERTY_NOTIFY_EVENT] =
806 g_signal_newc ("property_notify_event",
807 G_TYPE_FROM_CLASS(object_class),
809 G_STRUCT_OFFSET(GtkWidgetClass, property_notify_event),
810 _gtk_boolean_handled_accumulator, NULL,
811 gtk_marshal_BOOLEAN__BOXED,
814 widget_signals[SELECTION_CLEAR_EVENT] =
815 g_signal_newc ("selection_clear_event",
816 G_TYPE_FROM_CLASS(object_class),
818 G_STRUCT_OFFSET(GtkWidgetClass, selection_clear_event),
819 _gtk_boolean_handled_accumulator, NULL,
820 gtk_marshal_BOOLEAN__BOXED,
823 widget_signals[SELECTION_REQUEST_EVENT] =
824 g_signal_newc ("selection_request_event",
825 G_TYPE_FROM_CLASS(object_class),
827 G_STRUCT_OFFSET(GtkWidgetClass, selection_request_event),
828 _gtk_boolean_handled_accumulator, NULL,
829 gtk_marshal_BOOLEAN__BOXED,
832 widget_signals[SELECTION_NOTIFY_EVENT] =
833 g_signal_newc ("selection_notify_event",
834 G_TYPE_FROM_CLASS(object_class),
836 G_STRUCT_OFFSET(GtkWidgetClass, selection_notify_event),
837 _gtk_boolean_handled_accumulator, NULL,
838 gtk_marshal_BOOLEAN__BOXED,
841 widget_signals[SELECTION_RECEIVED] =
842 gtk_signal_new ("selection_received",
844 GTK_CLASS_TYPE (object_class),
845 GTK_SIGNAL_OFFSET (GtkWidgetClass, selection_received),
846 gtk_marshal_VOID__BOXED_UINT,
848 GTK_TYPE_SELECTION_DATA,
850 widget_signals[SELECTION_GET] =
851 gtk_signal_new ("selection_get",
853 GTK_CLASS_TYPE (object_class),
854 GTK_SIGNAL_OFFSET (GtkWidgetClass, selection_get),
855 gtk_marshal_VOID__BOXED_UINT_UINT,
857 GTK_TYPE_SELECTION_DATA,
860 widget_signals[PROXIMITY_IN_EVENT] =
861 g_signal_newc ("proximity_in_event",
862 G_TYPE_FROM_CLASS(object_class),
864 G_STRUCT_OFFSET(GtkWidgetClass, proximity_in_event),
865 _gtk_boolean_handled_accumulator, NULL,
866 gtk_marshal_BOOLEAN__BOXED,
869 widget_signals[PROXIMITY_OUT_EVENT] =
870 g_signal_newc ("proximity_out_event",
871 G_TYPE_FROM_CLASS(object_class),
873 G_STRUCT_OFFSET(GtkWidgetClass, proximity_out_event),
874 _gtk_boolean_handled_accumulator, NULL,
875 gtk_marshal_BOOLEAN__BOXED,
878 widget_signals[DRAG_LEAVE] =
879 gtk_signal_new ("drag_leave",
881 GTK_CLASS_TYPE (object_class),
882 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_leave),
883 gtk_marshal_VOID__OBJECT_UINT,
885 GDK_TYPE_DRAG_CONTEXT,
887 widget_signals[DRAG_BEGIN] =
888 gtk_signal_new ("drag_begin",
890 GTK_CLASS_TYPE (object_class),
891 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_begin),
892 gtk_marshal_VOID__OBJECT,
894 GDK_TYPE_DRAG_CONTEXT);
895 widget_signals[DRAG_END] =
896 gtk_signal_new ("drag_end",
898 GTK_CLASS_TYPE (object_class),
899 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_end),
900 gtk_marshal_VOID__OBJECT,
902 GDK_TYPE_DRAG_CONTEXT);
903 widget_signals[DRAG_DATA_DELETE] =
904 gtk_signal_new ("drag_data_delete",
906 GTK_CLASS_TYPE (object_class),
907 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_data_delete),
908 gtk_marshal_VOID__OBJECT,
910 GDK_TYPE_DRAG_CONTEXT);
911 widget_signals[DRAG_MOTION] =
912 g_signal_newc ("drag_motion",
913 G_TYPE_FROM_CLASS(object_class),
915 G_STRUCT_OFFSET(GtkWidgetClass, drag_motion),
916 _gtk_boolean_handled_accumulator, NULL,
917 gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
919 GDK_TYPE_DRAG_CONTEXT,
923 widget_signals[DRAG_DROP] =
924 g_signal_newc ("drag_drop",
925 G_TYPE_FROM_CLASS(object_class),
927 G_STRUCT_OFFSET(GtkWidgetClass, drag_drop),
928 _gtk_boolean_handled_accumulator, NULL,
929 gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
931 GDK_TYPE_DRAG_CONTEXT,
935 widget_signals[DRAG_DATA_GET] =
936 gtk_signal_new ("drag_data_get",
938 GTK_CLASS_TYPE (object_class),
939 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_data_get),
940 gtk_marshal_VOID__OBJECT_BOXED_UINT_UINT,
942 GDK_TYPE_DRAG_CONTEXT,
943 GTK_TYPE_SELECTION_DATA,
946 widget_signals[DRAG_DATA_RECEIVED] =
947 gtk_signal_new ("drag_data_received",
949 GTK_CLASS_TYPE (object_class),
950 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_data_received),
951 gtk_marshal_VOID__OBJECT_INT_INT_BOXED_UINT_UINT,
953 GDK_TYPE_DRAG_CONTEXT,
956 GTK_TYPE_SELECTION_DATA,
959 widget_signals[VISIBILITY_NOTIFY_EVENT] =
960 g_signal_newc ("visibility_notify_event",
961 G_TYPE_FROM_CLASS(object_class),
963 G_STRUCT_OFFSET(GtkWidgetClass, visibility_notify_event),
964 _gtk_boolean_handled_accumulator, NULL,
965 gtk_marshal_BOOLEAN__BOXED,
968 widget_signals[CLIENT_EVENT] =
969 g_signal_newc ("client_event",
970 G_TYPE_FROM_CLASS(object_class),
972 G_STRUCT_OFFSET(GtkWidgetClass, client_event),
973 _gtk_boolean_handled_accumulator, NULL,
974 gtk_marshal_BOOLEAN__BOXED,
977 widget_signals[NO_EXPOSE_EVENT] =
978 g_signal_newc ("no_expose_event",
979 G_TYPE_FROM_CLASS(object_class),
981 G_STRUCT_OFFSET(GtkWidgetClass, no_expose_event),
982 _gtk_boolean_handled_accumulator, NULL,
983 gtk_marshal_BOOLEAN__BOXED,
986 widget_signals[WINDOW_STATE_EVENT] =
987 g_signal_newc ("window_state_event",
988 G_TYPE_FROM_CLASS(object_class),
990 G_STRUCT_OFFSET(GtkWidgetClass, window_state_event),
991 _gtk_boolean_handled_accumulator, NULL,
992 gtk_marshal_BOOLEAN__BOXED,
995 widget_signals[POPUP_MENU] =
996 gtk_signal_new ("popup_menu",
997 GTK_RUN_LAST | GTK_RUN_ACTION,
998 GTK_CLASS_TYPE (object_class),
999 GTK_SIGNAL_OFFSET (GtkWidgetClass, popup_menu),
1000 gtk_marshal_NONE__NONE,
1003 binding_set = gtk_binding_set_by_class (klass);
1005 gtk_binding_entry_add_signal (binding_set, GDK_F10, GDK_SHIFT_MASK,
1008 gtk_binding_entry_add_signal (binding_set, GDK_Menu, 0,
1011 gtk_widget_class_install_style_property (klass,
1012 g_param_spec_boolean ("interior_focus",
1013 _("Interior Focus"),
1014 _("Whether to draw the focus indicator inside widgets."),
1020 gtk_widget_set_property (GObject *object,
1022 const GValue *value,
1026 GtkWidgetAuxInfo *aux_info;
1028 widget = GTK_WIDGET (object);
1032 guint32 saved_flags;
1035 gtk_widget_set_name (widget, g_value_get_string (value));
1038 gtk_container_add (GTK_CONTAINER (g_value_get_object (value)), widget);
1041 aux_info = _gtk_widget_get_aux_info (widget, TRUE);
1042 if (g_value_get_int (value) == -1)
1043 aux_info->x_set = FALSE;
1046 aux_info->x_set = TRUE;
1047 aux_info->x = g_value_get_int (value);
1049 gtk_widget_do_uposition (widget);
1052 aux_info = _gtk_widget_get_aux_info (widget, TRUE);
1053 if (g_value_get_int (value) == -1)
1054 aux_info->y_set = FALSE;
1057 aux_info->y_set = TRUE;
1058 aux_info->y = g_value_get_int (value);
1060 gtk_widget_do_uposition (widget);
1063 gtk_widget_set_usize (widget, g_value_get_int (value), -2);
1066 gtk_widget_set_usize (widget, -2, g_value_get_int (value));
1069 if (g_value_get_boolean (value))
1070 gtk_widget_show (widget);
1072 gtk_widget_hide (widget);
1074 case PROP_SENSITIVE:
1075 gtk_widget_set_sensitive (widget, g_value_get_boolean (value));
1077 case PROP_APP_PAINTABLE:
1078 gtk_widget_set_app_paintable (widget, g_value_get_boolean (value));
1080 case PROP_CAN_FOCUS:
1081 saved_flags = GTK_WIDGET_FLAGS (widget);
1082 if (g_value_get_boolean (value))
1083 GTK_WIDGET_SET_FLAGS (widget, GTK_CAN_FOCUS);
1085 GTK_WIDGET_UNSET_FLAGS (widget, GTK_CAN_FOCUS);
1086 if (saved_flags != GTK_WIDGET_FLAGS (widget))
1087 gtk_widget_queue_resize (widget);
1089 case PROP_HAS_FOCUS:
1090 if (g_value_get_boolean (value))
1091 gtk_widget_grab_focus (widget);
1093 case PROP_CAN_DEFAULT:
1094 saved_flags = GTK_WIDGET_FLAGS (widget);
1095 if (g_value_get_boolean (value))
1096 GTK_WIDGET_SET_FLAGS (widget, GTK_CAN_DEFAULT);
1098 GTK_WIDGET_UNSET_FLAGS (widget, GTK_CAN_DEFAULT);
1099 if (saved_flags != GTK_WIDGET_FLAGS (widget))
1100 gtk_widget_queue_resize (widget);
1102 case PROP_HAS_DEFAULT:
1103 if (g_value_get_boolean (value))
1104 gtk_widget_grab_default (widget);
1106 case PROP_RECEIVES_DEFAULT:
1107 if (g_value_get_boolean (value))
1108 GTK_WIDGET_SET_FLAGS (widget, GTK_RECEIVES_DEFAULT);
1110 GTK_WIDGET_UNSET_FLAGS (widget, GTK_RECEIVES_DEFAULT);
1112 case PROP_COMPOSITE_CHILD:
1113 if (g_value_get_boolean (value))
1114 GTK_WIDGET_SET_FLAGS (widget, GTK_COMPOSITE_CHILD);
1116 GTK_WIDGET_UNSET_FLAGS (widget, GTK_COMPOSITE_CHILD);
1119 gtk_widget_set_style (widget, g_value_get_object (value));
1122 if (!GTK_WIDGET_REALIZED (widget) && !GTK_WIDGET_NO_WINDOW (widget))
1123 gtk_widget_set_events (widget, g_value_get_flags (value));
1125 case PROP_EXTENSION_EVENTS:
1126 gtk_widget_set_extension_events (widget, g_value_get_enum (value));
1133 /*****************************************
1134 * gtk_widget_get_property:
1139 *****************************************/
1142 gtk_widget_get_property (GObject *object,
1149 widget = GTK_WIDGET (object);
1153 GtkWidgetAuxInfo *aux_info;
1155 GdkExtensionMode *modep;
1159 g_value_set_string (value, widget->name);
1161 g_value_set_string (value, "");
1164 g_value_set_object (value, G_OBJECT (widget->parent));
1167 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
1168 if (!aux_info || !aux_info->x_set)
1169 g_value_set_int (value, -1);
1171 g_value_set_int (value, aux_info->x);
1174 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
1175 if (!aux_info || !aux_info->y_set)
1176 g_value_set_int (value, -1);
1178 g_value_set_int (value, aux_info->y);
1181 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
1183 g_value_set_int (value, -1);
1185 g_value_set_int (value, aux_info->width);
1188 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
1190 g_value_set_int (value, -1);
1192 g_value_set_int (value, aux_info->height);
1195 g_value_set_boolean (value, (GTK_WIDGET_VISIBLE (widget) != FALSE));
1197 case PROP_SENSITIVE:
1198 g_value_set_boolean (value, (GTK_WIDGET_SENSITIVE (widget) != FALSE));
1200 case PROP_APP_PAINTABLE:
1201 g_value_set_boolean (value, (GTK_WIDGET_APP_PAINTABLE (widget) != FALSE));
1203 case PROP_CAN_FOCUS:
1204 g_value_set_boolean (value, (GTK_WIDGET_CAN_FOCUS (widget) != FALSE));
1206 case PROP_HAS_FOCUS:
1207 g_value_set_boolean (value, (GTK_WIDGET_HAS_FOCUS (widget) != FALSE));
1209 case PROP_CAN_DEFAULT:
1210 g_value_set_boolean (value, (GTK_WIDGET_CAN_DEFAULT (widget) != FALSE));
1212 case PROP_HAS_DEFAULT:
1213 g_value_set_boolean (value, (GTK_WIDGET_HAS_DEFAULT (widget) != FALSE));
1215 case PROP_RECEIVES_DEFAULT:
1216 g_value_set_boolean (value, (GTK_WIDGET_RECEIVES_DEFAULT (widget) != FALSE));
1218 case PROP_COMPOSITE_CHILD:
1219 g_value_set_boolean (value, (GTK_WIDGET_COMPOSITE_CHILD (widget) != FALSE));
1222 g_value_set_object (value, G_OBJECT (gtk_widget_get_style (widget)));
1225 eventp = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_event_mask);
1227 g_value_set_int (value, 0);
1229 g_value_set_int (value, *eventp);
1231 case PROP_EXTENSION_EVENTS:
1232 modep = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_extension_event_mode);
1234 g_value_set_flags (value, 0);
1236 g_value_set_flags (value, (GdkExtensionMode) *modep);
1239 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1244 /*****************************************
1250 *****************************************/
1253 gtk_widget_init (GtkWidget *widget)
1255 GdkColormap *colormap;
1257 GTK_PRIVATE_FLAGS (widget) = 0;
1258 widget->state = GTK_STATE_NORMAL;
1259 widget->saved_state = GTK_STATE_NORMAL;
1260 widget->name = NULL;
1261 widget->requisition.width = 0;
1262 widget->requisition.height = 0;
1263 widget->allocation.x = -1;
1264 widget->allocation.y = -1;
1265 widget->allocation.width = 1;
1266 widget->allocation.height = 1;
1267 widget->window = NULL;
1268 widget->parent = NULL;
1270 GTK_WIDGET_SET_FLAGS (widget,
1272 GTK_PARENT_SENSITIVE |
1273 (composite_child_stack ? GTK_COMPOSITE_CHILD : 0) |
1274 GTK_DOUBLE_BUFFERED);
1276 widget->style = gtk_widget_peek_style ();
1277 gtk_style_ref (widget->style);
1279 colormap = gtk_widget_peek_colormap ();
1281 if (colormap != gtk_widget_get_default_colormap ())
1282 gtk_widget_set_colormap (widget, colormap);
1288 * @type: type ID of the widget to create
1289 * @first_property_name: name of first property to set
1290 * @Varargs: value of first property, followed by more properties, NULL-terminated
1292 * This is a convenience function for creating a widget and setting
1293 * its properties in one go. For example you might write:
1294 * gtk_widget_new (GTK_TYPE_LABEL, "label", "Hello World", "xalign",
1295 * 0.0, NULL) to create a left-aligned label. Equivalent to
1296 * gtk_object_new(), but returns a widget so you don't have to
1297 * cast the object yourself.
1299 * Return value: a new #GtkWidget of type @widget_type
1302 gtk_widget_new (GtkType type,
1303 const gchar *first_property_name,
1309 g_return_val_if_fail (gtk_type_is_a (type, GTK_TYPE_WIDGET), NULL);
1311 va_start (var_args, first_property_name);
1312 widget = g_object_new_valist (type, first_property_name, var_args);
1320 * @widget: a #GtkWidget
1321 * @first_property_name: name of first property to set
1322 * @Varargs: value of first property, followed by more properties, NULL-terminated
1324 * Like gtk_object_set() - there's no reason to use this instead of
1328 gtk_widget_set (GtkWidget *widget,
1329 const gchar *first_property_name,
1334 g_return_if_fail (GTK_IS_WIDGET (widget));
1336 va_start (var_args, first_property_name);
1337 g_object_set_valist (G_OBJECT (widget), first_property_name, var_args);
1342 gtk_widget_queue_clear_child (GtkWidget *widget)
1346 parent = widget->parent;
1347 if (parent && GTK_WIDGET_DRAWABLE (parent))
1348 gtk_widget_queue_clear_area (parent,
1349 widget->allocation.x,
1350 widget->allocation.y,
1351 widget->allocation.width,
1352 widget->allocation.height);
1356 * gtk_widget_unparent:
1357 * @widget: a #GtkWidget
1359 * This function is only for use in widget implementations.
1360 * Should be called by implementations of the remove method
1361 * on #GtkContainer, to dissociate a child from the container.
1364 gtk_widget_unparent (GtkWidget *widget)
1366 GtkWidget *toplevel;
1367 GtkWidget *old_parent;
1369 g_return_if_fail (widget != NULL);
1370 g_return_if_fail (GTK_IS_WIDGET (widget));
1371 if (widget->parent == NULL)
1374 /* keep this function in sync with gtk_menu_detach()
1377 g_object_freeze_notify (G_OBJECT (widget));
1379 /* unset focused and default children properly, this code
1380 * should eventually move into some gtk_window_unparent_branch() or
1384 toplevel = gtk_widget_get_toplevel (widget);
1385 if (GTK_CONTAINER (widget->parent)->focus_child == widget)
1387 gtk_container_set_focus_child (GTK_CONTAINER (widget->parent), NULL);
1389 if (GTK_IS_WINDOW (toplevel))
1393 child = GTK_WINDOW (toplevel)->focus_widget;
1395 while (child && child != widget)
1396 child = child->parent;
1398 if (child == widget)
1399 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
1402 if (GTK_IS_WINDOW (toplevel))
1406 child = GTK_WINDOW (toplevel)->default_widget;
1408 while (child && child != widget)
1409 child = child->parent;
1411 if (child == widget)
1412 gtk_window_set_default (GTK_WINDOW (toplevel), NULL);
1415 if (GTK_IS_RESIZE_CONTAINER (widget))
1416 gtk_container_clear_resize_widgets (GTK_CONTAINER (widget));
1418 /* Remove the widget and all its children from any ->resize_widgets list
1419 * of all the parents in our branch. This code should move into gtkcontainer.c
1420 * somwhen, since we mess around with ->resize_widgets, which is
1421 * actually not of our business.
1423 * Two ways to make this prettier:
1424 * Write a g_slist_conditional_remove (GSList, gboolean (*)(gpointer))
1425 * Change resize_widgets to a GList
1427 toplevel = widget->parent;
1433 if (!GTK_CONTAINER (toplevel)->resize_widgets)
1435 toplevel = toplevel->parent;
1440 slist = GTK_CONTAINER (toplevel)->resize_widgets;
1452 while (parent && (parent != widget))
1453 parent = parent->parent;
1455 if (parent == widget)
1457 GTK_PRIVATE_UNSET_FLAG (child, GTK_RESIZE_NEEDED);
1462 GTK_CONTAINER (toplevel)->resize_widgets = slist;
1464 g_slist_free_1 (last);
1470 toplevel = toplevel->parent;
1473 gtk_widget_queue_clear_child (widget);
1475 /* Reset the width and height here, to force reallocation if we
1476 * get added back to a new parent. This won't work if our new
1477 * allocation is smaller than 1x1 and we actually want a size of 1x1...
1478 * (would 0x0 be OK here?)
1480 widget->allocation.width = 1;
1481 widget->allocation.height = 1;
1483 if (GTK_WIDGET_REALIZED (widget) && !GTK_WIDGET_IN_REPARENT (widget))
1484 gtk_widget_unrealize (widget);
1486 old_parent = widget->parent;
1487 widget->parent = NULL;
1488 gtk_widget_set_parent_window (widget, NULL);
1489 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[PARENT_SET], old_parent);
1490 gtk_widget_propagate_hierarchy_changed (widget, NULL);
1491 g_object_notify (G_OBJECT (widget), "parent");
1492 g_object_thaw_notify (G_OBJECT (widget));
1493 gtk_widget_unref (widget);
1497 * gtk_widget_destroy:
1498 * @widget: a #GtkWidget
1500 * Destroys a widget. Equivalent to gtk_object_destroy(), except that
1501 * you don't have to cast the widget to #GtkObject. When a widget is
1502 * destroyed, it will break any references it holds to other objects.
1503 * If the widget is inside a container, the widget will be removed
1504 * from the container. If the widget is a toplevel (derived from
1505 * #GtkWindow), it will be removed from the list of toplevels, and the
1506 * reference GTK+ holds to it will be removed. Removing a
1507 * widget from its container or the list of toplevels results in the
1508 * widget being finalized, unless you've added additional references
1509 * to the widget with gtk_object_ref().
1511 * In most cases, only toplevel widgets (windows) require explicit
1512 * destruction, because when you destroy a toplevel its children will
1513 * be destroyed as well.
1517 gtk_widget_destroy (GtkWidget *widget)
1519 g_return_if_fail (widget != NULL);
1520 g_return_if_fail (GTK_IS_WIDGET (widget));
1522 gtk_object_destroy ((GtkObject*) widget);
1526 * gtk_widget_destroyed:
1527 * @widget: a #GtkWidget
1528 * @widget_pointer: address of a variable that contains @widget
1530 * This function sets *@widget_pointer to NULL if @widget_pointer !=
1531 * NULL. It's intended to be used as a callback connected to the
1532 * "destroy" signal of a widget. You connect gtk_widget_destroyed()
1533 * as a signal handler, and pass the address of your widget variable
1534 * as user data. Then when the widget is destroyed, the variable will
1535 * be set to NULL. Useful for example to avoid multiple copies
1536 * of the same dialog.
1540 gtk_widget_destroyed (GtkWidget *widget,
1541 GtkWidget **widget_pointer)
1543 /* Don't make any assumptions about the
1545 * Even check widget_pointer.
1548 *widget_pointer = NULL;
1553 * @widget: a #GtkWidget
1555 * Flags a widget to be displayed. Any widget that isn't shown will
1556 * not appear on the screen. If you want to show all the widgets in a
1557 * container, it's easier to call gtk_widget_show_all() on the
1558 * container, instead of individually showing the widgets.
1560 * Remember that you have to show the containers containing a widget,
1561 * in addition to the widget itself, before it will appear onscreen.
1563 * When a toplevel container is shown, it is immediately realized and
1564 * mapped; other shown widgets are realized and mapped when their
1565 * toplevel container is realized and mapped.
1569 gtk_widget_show (GtkWidget *widget)
1571 g_return_if_fail (widget != NULL);
1572 g_return_if_fail (GTK_IS_WIDGET (widget));
1574 if (!GTK_WIDGET_VISIBLE (widget))
1576 g_object_ref (G_OBJECT (widget));
1577 if (!GTK_WIDGET_TOPLEVEL (widget))
1578 gtk_widget_queue_resize (widget);
1579 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[SHOW]);
1580 g_object_notify (G_OBJECT (widget), "visible");
1581 g_object_unref (G_OBJECT (widget));
1586 gtk_widget_real_show (GtkWidget *widget)
1588 g_return_if_fail (widget != NULL);
1589 g_return_if_fail (GTK_IS_WIDGET (widget));
1591 if (!GTK_WIDGET_VISIBLE (widget))
1593 GTK_WIDGET_SET_FLAGS (widget, GTK_VISIBLE);
1595 if (widget->parent &&
1596 GTK_WIDGET_MAPPED (widget->parent) &&
1597 !GTK_WIDGET_MAPPED (widget))
1598 gtk_widget_map (widget);
1603 gtk_widget_show_map_callback (GtkWidget *widget, GdkEvent *event, gint *flag)
1606 gtk_signal_disconnect_by_data (GTK_OBJECT (widget), flag);
1610 * gtk_widget_show_now:
1611 * @widget: a #GtkWidget
1613 * Shows a widget. If the widget is an unmapped toplevel widget
1614 * (i.e. a #GtkWindow that has not yet been shown), enter the main
1615 * loop and wait for the window to actually be mapped. Be careful;
1616 * because the main loop is running, anything can happen during
1620 gtk_widget_show_now (GtkWidget *widget)
1624 g_return_if_fail (widget != NULL);
1625 g_return_if_fail (GTK_IS_WIDGET (widget));
1627 /* make sure we will get event */
1628 if (!GTK_WIDGET_MAPPED (widget) &&
1629 GTK_WIDGET_TOPLEVEL (widget))
1631 gtk_widget_show (widget);
1633 gtk_signal_connect (GTK_OBJECT (widget), "map_event",
1634 GTK_SIGNAL_FUNC (gtk_widget_show_map_callback),
1638 gtk_main_iteration();
1641 gtk_widget_show (widget);
1646 * @widget: a #GtkWidget
1648 * Reverses the effects of gtk_widget_show(), causing the widget to be
1649 * hidden (invisible to the user).
1652 gtk_widget_hide (GtkWidget *widget)
1654 g_return_if_fail (widget != NULL);
1655 g_return_if_fail (GTK_IS_WIDGET (widget));
1657 if (GTK_WIDGET_VISIBLE (widget))
1659 gtk_widget_ref (widget);
1660 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[HIDE]);
1661 if (!GTK_WIDGET_TOPLEVEL (widget) && !GTK_OBJECT_DESTROYED (widget))
1662 gtk_widget_queue_resize (widget);
1663 g_object_notify (G_OBJECT (widget), "visible");
1664 gtk_widget_unref (widget);
1669 gtk_widget_real_hide (GtkWidget *widget)
1671 g_return_if_fail (widget != NULL);
1672 g_return_if_fail (GTK_IS_WIDGET (widget));
1674 if (GTK_WIDGET_VISIBLE (widget))
1676 GTK_WIDGET_UNSET_FLAGS (widget, GTK_VISIBLE);
1678 if (GTK_WIDGET_MAPPED (widget))
1679 gtk_widget_unmap (widget);
1684 * gtk_widget_hide_on_delete:
1685 * @widget: a #GtkWidget
1687 * Utility function; intended to be connected to the "delete_event"
1688 * signal on a #GtkWindow. The function calls gtk_widget_hide() on its
1689 * argument, then returns %TRUE. If connected to "delete_event",
1690 * the result is that clicking the window manager close button for
1691 * will hide but not destroy the window. By default, GTK+ destroys
1692 * windows when "delete_event" is received.
1694 * Return value: %TRUE
1697 gtk_widget_hide_on_delete (GtkWidget *widget)
1699 g_return_val_if_fail (widget != NULL, FALSE);
1700 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
1702 gtk_widget_hide (widget);
1708 * gtk_widget_show_all:
1709 * @widget: a #GtkWidget
1711 * Recursively shows a widget, and any child widgets (if the widget is
1715 gtk_widget_show_all (GtkWidget *widget)
1717 GtkWidgetClass *class;
1719 g_return_if_fail (widget != NULL);
1720 g_return_if_fail (GTK_IS_WIDGET (widget));
1722 class = GTK_WIDGET_GET_CLASS (widget);
1724 if (class->show_all)
1725 class->show_all (widget);
1729 * gtk_widget_hide_all:
1730 * @widget: a #GtkWidget
1732 * Recursively hides a widget and any child widgets.
1735 gtk_widget_hide_all (GtkWidget *widget)
1737 GtkWidgetClass *class;
1739 g_return_if_fail (widget != NULL);
1740 g_return_if_fail (GTK_IS_WIDGET (widget));
1742 class = GTK_WIDGET_GET_CLASS (widget);
1744 if (class->hide_all)
1745 class->hide_all (widget);
1750 * @widget: a #GtkWidget
1752 * This function is only for use in widget implementations. Causes
1753 * a widget to be mapped if it isn't already.
1757 gtk_widget_map (GtkWidget *widget)
1759 g_return_if_fail (GTK_IS_WIDGET (widget));
1760 g_return_if_fail (GTK_WIDGET_VISIBLE (widget) == TRUE);
1762 if (!GTK_WIDGET_MAPPED (widget))
1764 if (!GTK_WIDGET_REALIZED (widget))
1765 gtk_widget_realize (widget);
1767 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[MAP]);
1769 if (GTK_WIDGET_NO_WINDOW (widget))
1770 gtk_widget_queue_draw (widget);
1776 * @widget: a #GtkWidget
1778 * This function is only for use in widget implementations. Causes
1779 * a widget to be unmapped if it's currently mapped.
1783 gtk_widget_unmap (GtkWidget *widget)
1785 g_return_if_fail (widget != NULL);
1786 g_return_if_fail (GTK_IS_WIDGET (widget));
1788 if (GTK_WIDGET_MAPPED (widget))
1790 if (GTK_WIDGET_NO_WINDOW (widget))
1791 gtk_widget_queue_clear_child (widget);
1792 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[UNMAP]);
1797 * gtk_widget_realize:
1798 * @widget: a #GtkWidget
1800 * Creates the GDK (windowing system) resources associated with a
1801 * widget. For example, widget->window will be created when a widget
1802 * is realized. Normally realization happens implicitly; if you show
1803 * a widget and all its parent containers, then the widget will be
1804 * realized and mapped automatically.
1806 * Realizing a widget requires all
1807 * the widget's parent widgets to be realized; calling
1808 * gtk_widget_realize() realizes the widget's parents in addition to
1809 * @widget itself. If a widget is not yet inside a toplevel window
1810 * when you realize it, bad things will happen.
1812 * This function is primarily used in widget implementations, and
1813 * isn't very useful otherwise. Many times when you think you might
1814 * need it, a better approach is to connect to a signal that will be
1815 * called after the widget is realized automatically, such as
1816 * "expose_event". Or simply gtk_signal_connect_after() to the
1821 gtk_widget_realize (GtkWidget *widget)
1824 GdkExtensionMode mode;
1825 GtkWidgetShapeInfo *shape_info;
1827 g_return_if_fail (widget != NULL);
1828 g_return_if_fail (GTK_IS_WIDGET (widget));
1830 if (!GTK_WIDGET_REALIZED (widget))
1833 if (GTK_IS_CONTAINER (widget) && !GTK_WIDGET_NO_WINDOW (widget))
1834 g_message ("gtk_widget_realize(%s)", gtk_type_name (GTK_WIDGET_TYPE (widget)));
1837 if (widget->parent == NULL &&
1838 !GTK_WIDGET_TOPLEVEL (widget))
1839 g_warning ("Calling gtk_widget_realize() on a widget that isn't "
1840 "inside a toplevel window is not going to work very well. "
1841 "Widgets must be inside a toplevel container before realizing them.");
1843 if (widget->parent && !GTK_WIDGET_REALIZED (widget->parent))
1844 gtk_widget_realize (widget->parent);
1846 gtk_widget_ensure_style (widget);
1848 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[REALIZE]);
1850 if (GTK_WIDGET_HAS_SHAPE_MASK (widget))
1852 shape_info = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_shape_info);
1853 gdk_window_shape_combine_mask (widget->window,
1854 shape_info->shape_mask,
1855 shape_info->offset_x,
1856 shape_info->offset_y);
1859 if (!GTK_WIDGET_NO_WINDOW (widget))
1861 mode = gtk_widget_get_extension_events (widget);
1862 if (mode != GDK_EXTENSION_EVENTS_NONE)
1864 events = gtk_widget_get_events (widget);
1865 gdk_input_set_extension_events (widget->window, events, mode);
1873 * gtk_widget_unrealize:
1874 * @widget: a #GtkWidget
1876 * This function is only useful in widget implementations.
1877 * Causes a widget to be unrealized (frees all GDK resources
1878 * associated with the widget, such as widget->window).
1882 gtk_widget_unrealize (GtkWidget *widget)
1884 g_return_if_fail (widget != NULL);
1885 g_return_if_fail (GTK_IS_WIDGET (widget));
1887 if (GTK_WIDGET_HAS_SHAPE_MASK (widget))
1888 gtk_widget_shape_combine_mask (widget, NULL, -1, -1);
1890 if (GTK_WIDGET_REALIZED (widget))
1892 gtk_widget_ref (widget);
1893 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[UNREALIZE]);
1894 GTK_WIDGET_UNSET_FLAGS (widget, GTK_REALIZED | GTK_MAPPED);
1895 gtk_widget_unref (widget);
1899 /*****************************************
1901 *****************************************/
1904 * gtk_widget_queue_draw_area:
1905 * @widget: a #GtkWidget
1906 * @x: x coordinate of upper-left corner of rectangle to redraw
1907 * @y: y coordinate of upper-left corner of rectangle to redraw
1908 * @width: width of region to draw
1909 * @height: height of region to draw
1911 * Invalidates the rectangular area of @widget defined by @x, @y,
1912 * @width and @height by calling gdk_window_invalidate_rect() on the
1913 * widget's window and all its child windows. Once the main loop
1914 * becomes idle (after the current batch of events has been processed,
1915 * roughly), the window will receive expose events for the union of
1916 * all regions that have been invalidated.
1918 * Normally you would only use this function in widget
1919 * implementations. You might also use it, or
1920 * gdk_window_invalidate_rect() directly, to schedule a redraw of a
1921 * #GtkDrawingArea or some portion thereof.
1923 * Frequently you can just call gdk_window_invalidate_rect() or
1924 * gdk_window_invalidate_region() instead of this function. Those
1925 * functions will invalidate only a single window, instead of the
1926 * widget and all its children.
1928 * The advantage of adding to the invalidated region compared to
1929 * simply drawing immediately is efficiency; using an invalid region
1930 * ensures that you only have to redraw one time.
1934 gtk_widget_queue_draw_area (GtkWidget *widget,
1940 g_return_if_fail (widget != NULL);
1941 g_return_if_fail (GTK_IS_WIDGET (widget));
1943 gtk_widget_queue_clear_area (widget, x, y, width, height);
1947 * gtk_widget_queue_draw:
1948 * @widget: a #GtkWidget
1950 * Equivalent to calling gtk_widget_queue_draw_area() for the
1951 * entire area of a widget.
1955 gtk_widget_queue_draw (GtkWidget *widget)
1957 g_return_if_fail (widget != NULL);
1958 g_return_if_fail (GTK_IS_WIDGET (widget));
1960 gtk_widget_queue_clear (widget);
1963 /* Invalidates the given area (allocation-relative-coordinates)
1964 * in all of the widget's windows
1967 * gtk_widget_queue_clear_area:
1968 * @widget: a #GtkWidget
1969 * @x: x coordinate of upper-left corner of rectangle to redraw
1970 * @y: y coordinate of upper-left corner of rectangle to redraw
1971 * @width: width of region to draw
1972 * @height: height of region to draw
1974 * DEPRECATED. This function is no longer different from
1975 * gtk_widget_queue_draw_area(), though it once was. Now it just calls
1976 * gtk_widget_queue_draw_area(). Originally
1977 * gtk_widget_queue_clear_area() would force a redraw of the
1978 * background for GTK_NO_WINDOW widgets, and
1979 * gtk_widget_queue_draw_area() would not. Now both functions ensure
1980 * the background will be redrawn.
1984 gtk_widget_queue_clear_area (GtkWidget *widget,
1990 GdkRectangle invalid_rect;
1992 g_return_if_fail (widget != NULL);
1993 g_return_if_fail (GTK_IS_WIDGET (widget));
1995 if (!(widget->window && gdk_window_is_viewable (widget->window)))
1998 /* Find the correct widget */
2000 if (!GTK_WIDGET_NO_WINDOW (widget))
2004 /* Translate widget relative to window-relative */
2006 gint wx, wy, wwidth, wheight;
2008 gdk_window_get_position (widget->window, &wx, &wy);
2009 x -= wx - widget->allocation.x;
2010 y -= wy - widget->allocation.y;
2012 gdk_window_get_size (widget->window, &wwidth, &wheight);
2014 if (x + width <= 0 || y + height <= 0 ||
2015 x >= wwidth || y >= wheight)
2026 if (x + width > wwidth)
2028 if (y + height > wheight)
2029 height = wheight - y;
2035 invalid_rect.width = width;
2036 invalid_rect.height = height;
2038 gdk_window_invalidate_rect (widget->window, &invalid_rect, TRUE);
2042 * gtk_widget_queue_clear:
2043 * @widget: a #GtkWidget
2045 * DEPRECATED. Use gtk_widget_queue_draw() instead.
2048 gtk_widget_queue_clear (GtkWidget *widget)
2050 g_return_if_fail (widget != NULL);
2051 g_return_if_fail (GTK_IS_WIDGET (widget));
2053 if (widget->allocation.width || widget->allocation.height)
2055 if (GTK_WIDGET_NO_WINDOW (widget))
2056 gtk_widget_queue_clear_area (widget, widget->allocation.x,
2057 widget->allocation.y,
2058 widget->allocation.width,
2059 widget->allocation.height);
2061 gtk_widget_queue_clear_area (widget, 0, 0,
2062 widget->allocation.width,
2063 widget->allocation.height);
2068 * gtk_widget_queue_resize:
2069 * @widget: a #GtkWidget
2071 * This function is only for use in widget implementations.
2072 * Flags a widget to have its size renegotiated; should
2073 * be called when a widget for some reason has a new size request.
2074 * For example, when you change the text in a #GtkLabel, #GtkLabel
2075 * queues a resize to ensure there's enough space for the new text.
2079 gtk_widget_queue_resize (GtkWidget *widget)
2081 g_return_if_fail (widget != NULL);
2082 g_return_if_fail (GTK_IS_WIDGET (widget));
2084 if (GTK_IS_RESIZE_CONTAINER (widget))
2085 gtk_container_clear_resize_widgets (GTK_CONTAINER (widget));
2087 gtk_widget_queue_clear (widget);
2090 gtk_container_queue_resize (GTK_CONTAINER (widget->parent));
2091 else if (GTK_WIDGET_TOPLEVEL (widget) && GTK_IS_CONTAINER (widget))
2092 gtk_container_queue_resize (GTK_CONTAINER (widget));
2097 * @widget: a #GtkWidget
2098 * @area: area to draw
2100 * DEPRECATED. In GTK+ 1.2, this function would immediately render the
2101 * region @area of a widget, by invoking the virtual draw method of a
2102 * widget. In GTK+ 2.0, the draw method is gone, and instead
2103 * gtk_widget_draw() simply invalidates the specified region of the
2104 * widget, then updates the invalid region of the widget immediately.
2105 * Usually you don't want to update the region immediately for
2106 * performance reasons, so in general gtk_widget_queue_draw_area() is
2107 * a better choice if you want to draw a region of a widget.
2111 gtk_widget_draw (GtkWidget *widget,
2114 g_return_if_fail (widget != NULL);
2115 g_return_if_fail (GTK_IS_WIDGET (widget));
2117 if (GTK_WIDGET_DRAWABLE (widget))
2120 gtk_widget_queue_draw_area (widget,
2122 area->width, area->height);
2124 gtk_widget_queue_draw (widget);
2126 gdk_window_process_updates (widget->window, TRUE);
2131 * gtk_widget_size_request:
2132 * @widget: a #GtkWidget
2133 * @requisition: a #GtkRequisition to be filled in
2135 * This function is only used when implementing a #GtkContainer subclass.
2136 * Obtains the preferred size of a widget. The container uses this
2137 * information to arrange its child widgets and decide what size allocations
2138 * to give them with gtk_widget_size_allocate().
2141 gtk_widget_size_request (GtkWidget *widget,
2142 GtkRequisition *requisition)
2144 g_return_if_fail (widget != NULL);
2145 g_return_if_fail (GTK_IS_WIDGET (widget));
2147 #ifdef G_ENABLE_DEBUG
2148 if (requisition == &widget->requisition)
2149 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.");
2150 #endif /* G_ENABLE_DEBUG */
2152 gtk_widget_ref (widget);
2153 gtk_widget_ensure_style (widget);
2154 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[SIZE_REQUEST],
2155 &widget->requisition);
2158 gtk_widget_get_child_requisition (widget, requisition);
2160 gtk_widget_unref (widget);
2164 * gtk_widget_get_child_requisition:
2165 * @widget: a #GtkWidget
2166 * @requisition: a #GtkRequisition to be filled in
2168 * This function is only for use in widget implementations. Obtains
2169 * @widget->requisition, unless someone has forced a particular
2170 * geometry on the widget (e.g. with gtk_widget_set_usize()), in which
2171 * case it returns that geometry instead of the widget's requisition.
2174 gtk_widget_get_child_requisition (GtkWidget *widget,
2175 GtkRequisition *requisition)
2177 GtkWidgetAuxInfo *aux_info;
2179 g_return_if_fail (widget != NULL);
2180 g_return_if_fail (GTK_IS_WIDGET (widget));
2182 *requisition = widget->requisition;
2184 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
2187 if (aux_info->width > 0)
2188 requisition->width = aux_info->width;
2189 if (aux_info->height > 0)
2190 requisition->height = aux_info->height;
2195 * gtk_widget_size_allocate:
2196 * @widget: a #GtkWidget
2197 * @allocation: position and size to be allocated to @widget
2199 * This function is only used by #GtkContainer subclasses, to assign a size
2200 * and position to their child widgets.
2204 gtk_widget_size_allocate (GtkWidget *widget,
2205 GtkAllocation *allocation)
2207 GtkWidgetAuxInfo *aux_info;
2208 GtkAllocation real_allocation;
2209 gboolean needs_draw = FALSE;
2211 g_return_if_fail (widget != NULL);
2212 g_return_if_fail (GTK_IS_WIDGET (widget));
2214 real_allocation = *allocation;
2215 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
2219 if (aux_info->x_set)
2220 real_allocation.x = aux_info->x;
2221 if (aux_info->y_set)
2222 real_allocation.y = aux_info->y;
2225 real_allocation.width = MAX (real_allocation.width, 1);
2226 real_allocation.height = MAX (real_allocation.height, 1);
2228 if (real_allocation.width < 0 || real_allocation.height < 0)
2230 g_warning ("gtk_widget_size_allocate(): attempt to allocate widget with width %d and height %d",
2231 real_allocation.width,
2232 real_allocation.height);
2233 real_allocation.width = 1;
2234 real_allocation.height = 1;
2237 if (GTK_WIDGET_NO_WINDOW (widget))
2239 if (widget->allocation.x != real_allocation.x ||
2240 widget->allocation.y != real_allocation.y ||
2241 widget->allocation.width != real_allocation.width ||
2242 widget->allocation.height != real_allocation.height)
2244 gtk_widget_queue_clear_child (widget);
2248 else if (widget->allocation.width != real_allocation.width ||
2249 widget->allocation.height != real_allocation.height)
2254 if (GTK_IS_RESIZE_CONTAINER (widget))
2255 gtk_container_clear_resize_widgets (GTK_CONTAINER (widget));
2257 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[SIZE_ALLOCATE], &real_allocation);
2261 gtk_widget_queue_draw (widget);
2262 if (widget->parent && GTK_CONTAINER (widget->parent)->reallocate_redraws)
2263 gtk_widget_queue_draw (widget->parent);
2268 gtk_widget_real_size_allocate (GtkWidget *widget,
2269 GtkAllocation *allocation)
2271 g_return_if_fail (widget != NULL);
2272 g_return_if_fail (GTK_IS_WIDGET (widget));
2274 widget->allocation = *allocation;
2276 if (GTK_WIDGET_REALIZED (widget) &&
2277 !GTK_WIDGET_NO_WINDOW (widget))
2279 gdk_window_move_resize (widget->window,
2280 allocation->x, allocation->y,
2281 allocation->width, allocation->height);
2286 gtk_widget_stop_add_accelerator (GtkWidget *widget)
2288 g_return_if_fail (widget != NULL);
2289 g_return_if_fail (GTK_IS_WIDGET (widget));
2291 gtk_signal_emit_stop (GTK_OBJECT (widget), widget_signals[ADD_ACCELERATOR]);
2295 gtk_widget_stop_remove_accelerator (GtkWidget *widget)
2297 g_return_if_fail (widget != NULL);
2298 g_return_if_fail (GTK_IS_WIDGET (widget));
2300 gtk_signal_emit_stop (GTK_OBJECT (widget), widget_signals[REMOVE_ACCELERATOR]);
2304 gtk_widget_lock_accelerators (GtkWidget *widget)
2306 g_return_if_fail (widget != NULL);
2307 g_return_if_fail (GTK_IS_WIDGET (widget));
2309 if (!gtk_widget_accelerators_locked (widget))
2311 gtk_signal_connect (GTK_OBJECT (widget),
2313 GTK_SIGNAL_FUNC (gtk_widget_stop_add_accelerator),
2315 gtk_signal_connect (GTK_OBJECT (widget),
2316 "remove_accelerator",
2317 GTK_SIGNAL_FUNC (gtk_widget_stop_remove_accelerator),
2323 gtk_widget_unlock_accelerators (GtkWidget *widget)
2325 g_return_if_fail (widget != NULL);
2326 g_return_if_fail (GTK_IS_WIDGET (widget));
2328 if (gtk_widget_accelerators_locked (widget))
2330 gtk_signal_disconnect_by_func (GTK_OBJECT (widget),
2331 GTK_SIGNAL_FUNC (gtk_widget_stop_add_accelerator),
2333 gtk_signal_disconnect_by_func (GTK_OBJECT (widget),
2334 GTK_SIGNAL_FUNC (gtk_widget_stop_remove_accelerator),
2340 gtk_widget_accelerators_locked (GtkWidget *widget)
2342 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
2344 return gtk_signal_handler_pending_by_func (GTK_OBJECT (widget),
2345 widget_signals[ADD_ACCELERATOR],
2347 GTK_SIGNAL_FUNC (gtk_widget_stop_add_accelerator),
2352 gtk_widget_add_accelerator (GtkWidget *widget,
2353 const gchar *accel_signal,
2354 GtkAccelGroup *accel_group,
2357 GtkAccelFlags accel_flags)
2359 g_return_if_fail (widget != NULL);
2360 g_return_if_fail (GTK_IS_WIDGET (widget));
2361 g_return_if_fail (accel_group != NULL);
2363 gtk_accel_group_add (accel_group,
2367 (GtkObject*) widget,
2372 gtk_widget_remove_accelerator (GtkWidget *widget,
2373 GtkAccelGroup *accel_group,
2377 g_return_if_fail (widget != NULL);
2378 g_return_if_fail (GTK_IS_WIDGET (widget));
2379 g_return_if_fail (accel_group != NULL);
2381 gtk_accel_group_remove (accel_group,
2384 (GtkObject*) widget);
2388 gtk_widget_remove_accelerators (GtkWidget *widget,
2389 const gchar *accel_signal,
2390 gboolean visible_only)
2395 g_return_if_fail (widget != NULL);
2396 g_return_if_fail (GTK_IS_WIDGET (widget));
2397 g_return_if_fail (accel_signal != NULL);
2399 signal_id = gtk_signal_lookup (accel_signal, GTK_OBJECT_TYPE (widget));
2400 g_return_if_fail (signal_id != 0);
2402 slist = gtk_accel_group_entries_from_object (GTK_OBJECT (widget));
2405 GtkAccelEntry *ac_entry;
2407 ac_entry = slist->data;
2408 slist = slist->next;
2409 if (ac_entry->accel_flags & GTK_ACCEL_VISIBLE &&
2410 ac_entry->signal_id == signal_id)
2411 gtk_widget_remove_accelerator (GTK_WIDGET (widget),
2412 ac_entry->accel_group,
2413 ac_entry->accelerator_key,
2414 ac_entry->accelerator_mods);
2419 gtk_widget_accelerator_signal (GtkWidget *widget,
2420 GtkAccelGroup *accel_group,
2424 GtkAccelEntry *ac_entry;
2426 g_return_val_if_fail (widget != NULL, 0);
2427 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
2428 g_return_val_if_fail (accel_group != NULL, 0);
2430 ac_entry = gtk_accel_group_get_entry (accel_group, accel_key, accel_mods);
2432 if (ac_entry && ac_entry->object == (GtkObject*) widget)
2433 return ac_entry->signal_id;
2438 gtk_widget_mnemonic_activate (GtkWidget *widget,
2439 gboolean group_cycling)
2443 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
2445 group_cycling = group_cycling != FALSE;
2446 if (!GTK_WIDGET_IS_SENSITIVE (widget))
2449 gtk_signal_emit (GTK_OBJECT (widget),
2450 widget_signals[ACTIVATE_MNEMONIC],
2457 gtk_widget_real_mnemonic_activate (GtkWidget *widget,
2458 gboolean group_cycling)
2460 if (!group_cycling && GTK_WIDGET_GET_CLASS (widget)->activate_signal)
2461 gtk_widget_activate (widget);
2462 else if (GTK_WIDGET_CAN_FOCUS (widget))
2463 gtk_widget_grab_focus (widget);
2466 g_warning ("widget `%s' isn't suitable for mnemonic activation",
2467 G_OBJECT_TYPE_NAME (widget));
2474 gtk_widget_real_key_press_event (GtkWidget *widget,
2477 gboolean handled = FALSE;
2479 g_return_val_if_fail (widget != NULL, handled);
2480 g_return_val_if_fail (GTK_IS_WIDGET (widget), handled);
2481 g_return_val_if_fail (event != NULL, handled);
2484 handled = gtk_bindings_activate (GTK_OBJECT (widget),
2492 gtk_widget_real_key_release_event (GtkWidget *widget,
2495 gboolean handled = FALSE;
2497 g_return_val_if_fail (widget != NULL, handled);
2498 g_return_val_if_fail (GTK_IS_WIDGET (widget), handled);
2499 g_return_val_if_fail (event != NULL, handled);
2502 handled = gtk_bindings_activate (GTK_OBJECT (widget),
2504 event->state | GDK_RELEASE_MASK);
2510 gtk_widget_real_focus_in_event (GtkWidget *widget,
2511 GdkEventFocus *event)
2513 GTK_WIDGET_SET_FLAGS (widget, GTK_HAS_FOCUS);
2514 gtk_widget_queue_draw (widget);
2520 gtk_widget_real_focus_out_event (GtkWidget *widget,
2521 GdkEventFocus *event)
2523 GTK_WIDGET_UNSET_FLAGS (widget, GTK_HAS_FOCUS);
2524 gtk_widget_queue_draw (widget);
2531 * @widget: a #GtkWidget
2532 * @event: a #GdkEvent
2534 * Rarely-used function. This function is used to emit
2535 * the event signals on a widget (those signals should never
2536 * be emitted without using this function to do so).
2537 * If you want to synthesize an event though, don't use this function;
2538 * instead, use gtk_main_do_event() so the event will behave as if
2539 * it were in the event queue. Don't synthesize expose events; instead,
2540 * use gdk_window_invalidate_rect() to invalidate a region of the
2543 * Return value: return from the event signal emission (%TRUE if the event was handled)
2546 gtk_widget_event (GtkWidget *widget,
2549 g_return_val_if_fail (widget != NULL, TRUE);
2550 g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
2552 if (event->type == GDK_EXPOSE)
2554 g_warning ("Events of type GDK_EXPOSE cannot be synthesized. To get "
2555 "the same effect, call gdk_window_invalidate_rect/region(), "
2556 "followed by gdk_window_process_updates().");
2560 return gtk_widget_event_internal (widget, event);
2565 * gtk_widget_send_expose:
2566 * @widget: a #GtkWidget
2567 * @event: a expose #GdkEvent
2569 * Very rarely-used function. This function is used to emit
2570 * an expose event signals on a widget. This function is not
2571 * normally used directly. The only time it is used is when
2572 * propagating an expose event to a child NO_WINDOW widget, and
2573 * that is normally done using gtk_container_propagate_expose.
2575 * If you want to force an area of a window to be redrawn,
2576 * use gdk_window_invalidate_rect() or gdk_window_invalidate_region().
2577 * To cause the redraw to be done immediately, follow that call
2578 * with a call to gdk_window_procss_updates().
2580 * Return value: return from the event signal emission (%TRUE if the event was handled)
2583 gtk_widget_send_expose (GtkWidget *widget,
2586 g_return_val_if_fail (widget != NULL, TRUE);
2587 g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
2588 g_return_val_if_fail (event != NULL, TRUE);
2589 g_return_val_if_fail (event->type == GDK_EXPOSE, TRUE);
2591 if (event->type != GDK_EXPOSE)
2594 return gtk_widget_event_internal (widget, event);
2598 gtk_widget_event_internal (GtkWidget *widget,
2601 gboolean return_val;
2604 gtk_widget_ref (widget);
2606 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[EVENT], event,
2608 if (return_val || GTK_OBJECT_DESTROYED (widget))
2611 switch (event->type)
2616 case GDK_BUTTON_PRESS:
2617 case GDK_2BUTTON_PRESS:
2618 case GDK_3BUTTON_PRESS:
2619 signal_num = BUTTON_PRESS_EVENT;
2622 signal_num = SCROLL_EVENT;
2624 case GDK_BUTTON_RELEASE:
2625 signal_num = BUTTON_RELEASE_EVENT;
2627 case GDK_MOTION_NOTIFY:
2628 signal_num = MOTION_NOTIFY_EVENT;
2631 signal_num = DELETE_EVENT;
2634 signal_num = DESTROY_EVENT;
2637 signal_num = KEY_PRESS_EVENT;
2639 case GDK_KEY_RELEASE:
2640 signal_num = KEY_RELEASE_EVENT;
2642 case GDK_ENTER_NOTIFY:
2643 signal_num = ENTER_NOTIFY_EVENT;
2645 case GDK_LEAVE_NOTIFY:
2646 signal_num = LEAVE_NOTIFY_EVENT;
2648 case GDK_FOCUS_CHANGE:
2649 if (event->focus_change.in)
2650 signal_num = FOCUS_IN_EVENT;
2652 signal_num = FOCUS_OUT_EVENT;
2655 signal_num = CONFIGURE_EVENT;
2658 signal_num = MAP_EVENT;
2661 signal_num = UNMAP_EVENT;
2663 case GDK_WINDOW_STATE:
2664 signal_num = WINDOW_STATE_EVENT;
2666 case GDK_PROPERTY_NOTIFY:
2667 signal_num = PROPERTY_NOTIFY_EVENT;
2669 case GDK_SELECTION_CLEAR:
2670 signal_num = SELECTION_CLEAR_EVENT;
2672 case GDK_SELECTION_REQUEST:
2673 signal_num = SELECTION_REQUEST_EVENT;
2675 case GDK_SELECTION_NOTIFY:
2676 signal_num = SELECTION_NOTIFY_EVENT;
2678 case GDK_PROXIMITY_IN:
2679 signal_num = PROXIMITY_IN_EVENT;
2681 case GDK_PROXIMITY_OUT:
2682 signal_num = PROXIMITY_OUT_EVENT;
2685 signal_num = NO_EXPOSE_EVENT;
2687 case GDK_CLIENT_EVENT:
2688 signal_num = CLIENT_EVENT;
2691 if (!event->any.window) /* Why is this necessary */
2694 signal_num = EXPOSE_EVENT;
2696 case GDK_VISIBILITY_NOTIFY:
2697 signal_num = VISIBILITY_NOTIFY_EVENT;
2700 g_warning ("could not determine signal number for event: %d", event->type);
2704 if (signal_num != -1)
2705 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[signal_num], event, &return_val);
2707 return_val |= GTK_OBJECT_DESTROYED (widget);
2710 gtk_widget_unref (widget);
2716 * gtk_widget_activate:
2717 * @widget: a #GtkWidget that's activatable
2719 * For widgets that can be "activated" (buttons, menu items, etc.)
2720 * this function activates them. Activation is what happens when you
2721 * press Enter on a widget during key navigation; clicking a button,
2722 * selecting a menu item, etc. If @widget isn't activatable,
2723 * the function returns %FALSE.
2725 * Return value: %TRUE if the widget was activatable
2728 gtk_widget_activate (GtkWidget *widget)
2730 g_return_val_if_fail (widget != NULL, FALSE);
2731 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
2733 if (WIDGET_CLASS (widget)->activate_signal)
2735 /* FIXME: we should eventually check the signals signature here */
2736 gtk_signal_emit (GTK_OBJECT (widget), WIDGET_CLASS (widget)->activate_signal);
2745 * gtk_widget_set_scroll_adjustments:
2746 * @widget: a #GtkWidget
2747 * @hadjustment: an adjustment for horizontal scrolling, or %NULL
2748 * @vadjustment: an adjustment for vertical scrolling, or %NULL
2750 * For widgets that support scrolling, sets the scroll adjustments and
2751 * returns %TRUE. For widgets that don't support scrolling, does
2752 * nothing and returns %FALSE. Widgets that don't support scrolling
2753 * can be scrolled by placing them in a #GtkViewport, which does
2754 * support scrolling.
2756 * Return value: %TRUE if the widget supports scrolling
2759 gtk_widget_set_scroll_adjustments (GtkWidget *widget,
2760 GtkAdjustment *hadjustment,
2761 GtkAdjustment *vadjustment)
2763 g_return_val_if_fail (widget != NULL, FALSE);
2764 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
2766 g_return_val_if_fail (GTK_IS_ADJUSTMENT (hadjustment), FALSE);
2768 g_return_val_if_fail (GTK_IS_ADJUSTMENT (vadjustment), FALSE);
2770 if (WIDGET_CLASS (widget)->set_scroll_adjustments_signal)
2772 /* FIXME: we should eventually check the signals signature here */
2773 gtk_signal_emit (GTK_OBJECT (widget),
2774 WIDGET_CLASS (widget)->set_scroll_adjustments_signal,
2775 hadjustment, vadjustment);
2782 /*****************************************
2783 * gtk_widget_reparent_container_child:
2784 * assistent function to gtk_widget_reparent
2789 *****************************************/
2792 gtk_widget_reparent_container_child (GtkWidget *widget,
2793 gpointer client_data)
2795 g_return_if_fail (widget != NULL);
2796 g_return_if_fail (GTK_IS_WIDGET (widget));
2797 g_return_if_fail (client_data != NULL);
2799 if (GTK_WIDGET_NO_WINDOW (widget))
2802 gdk_window_unref (widget->window);
2803 widget->window = (GdkWindow*) client_data;
2805 gdk_window_ref (widget->window);
2807 if (GTK_IS_CONTAINER (widget))
2808 gtk_container_forall (GTK_CONTAINER (widget),
2809 gtk_widget_reparent_container_child,
2813 gdk_window_reparent (widget->window,
2814 (GdkWindow*) client_data, 0, 0);
2818 * gtk_widget_reparent:
2819 * @widget: a #GtkWidget
2820 * @new_parent: a #GtkContainer to move the widget into
2822 * Moves a widget from one #GtkContainer to another, handling reference
2823 * count issues to avoid destroying the widget.
2827 gtk_widget_reparent (GtkWidget *widget,
2828 GtkWidget *new_parent)
2830 g_return_if_fail (widget != NULL);
2831 g_return_if_fail (GTK_IS_WIDGET (widget));
2832 g_return_if_fail (new_parent != NULL);
2833 g_return_if_fail (GTK_IS_CONTAINER (new_parent));
2834 g_return_if_fail (widget->parent != NULL);
2836 if (widget->parent != new_parent)
2838 /* First try to see if we can get away without unrealizing
2839 * the widget as we reparent it. if so we set a flag so
2840 * that gtk_widget_unparent doesn't unrealize widget
2842 if (GTK_WIDGET_REALIZED (widget) && GTK_WIDGET_REALIZED (new_parent))
2843 GTK_PRIVATE_SET_FLAG (widget, GTK_IN_REPARENT);
2845 gtk_widget_ref (widget);
2846 gtk_container_remove (GTK_CONTAINER (widget->parent), widget);
2847 gtk_container_add (GTK_CONTAINER (new_parent), widget);
2848 gtk_widget_unref (widget);
2850 if (GTK_WIDGET_IN_REPARENT (widget))
2852 GTK_PRIVATE_UNSET_FLAG (widget, GTK_IN_REPARENT);
2854 gtk_widget_reparent_container_child (widget,
2855 gtk_widget_get_parent_window (widget));
2861 * gtk_widget_intersect:
2862 * @widget: a #GtkWidget
2863 * @area: a rectangle
2864 * @intersection: rectangle to store intersection of @widget and @area
2866 * Computes the intersection of a @widget's area and @area, storing
2867 * the intersection in @intersection, and returns %TRUE if there was
2868 * an intersection. @intersection may be %NULL if you're only
2869 * interested in whether there was an intersection.
2871 * Return value: %TRUE if there was an intersection
2874 gtk_widget_intersect (GtkWidget *widget,
2876 GdkRectangle *intersection)
2882 g_return_val_if_fail (widget != NULL, FALSE);
2883 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
2884 g_return_val_if_fail (area != NULL, FALSE);
2887 dest = intersection;
2891 return_val = gdk_rectangle_intersect (&widget->allocation, area, dest);
2893 if (return_val && intersection && !GTK_WIDGET_NO_WINDOW (widget))
2895 intersection->x -= widget->allocation.x;
2896 intersection->y -= widget->allocation.y;
2903 * gtk_widget_region_intersect:
2904 * @widget: a #GtkWidget
2905 * @region: a #GdkRegion, in the same coordinate system as
2906 * widget->allocation. That is, relative to widget->window
2907 * for NO_WINDOW widgets; relative to the parent window
2908 * of widget->window for widgets with their own window.
2909 * @returns: A newly allocated region holding the intersection of @widget
2910 * and @region. The coordinates of the return value are
2911 * relative to widget->window for NO_WINDOW widgets, and
2912 * relative to the parent window of widget->window for
2913 * widgets with their own window.
2915 * Computes the intersection of a @widget's area and @region, returning
2916 * the intersection. The result may be empty, use #gdk_region_empty to
2920 gtk_widget_region_intersect (GtkWidget *widget,
2925 g_return_val_if_fail (widget != NULL, NULL);
2926 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
2927 g_return_val_if_fail (region != NULL, NULL);
2929 dest = gdk_region_rectangle (&widget->allocation);
2931 gdk_region_intersect (dest, region);
2937 * gtk_widget_grab_focus:
2938 * @widget: a #GtkWidget
2940 * Causes @widget to have the keyboard focus for the #GtkWindow it's
2941 * inside. @widget must be a focusable widget, such as a #GtkEntry;
2942 * something like #GtkFrame won't work. (More precisely, it must have the
2943 * #GTK_CAN_FOCUS flag set.)
2947 gtk_widget_grab_focus (GtkWidget *widget)
2949 g_return_if_fail (widget != NULL);
2950 g_return_if_fail (GTK_IS_WIDGET (widget));
2952 g_object_ref (G_OBJECT (widget));
2953 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[GRAB_FOCUS]);
2954 g_object_notify (G_OBJECT (widget), "has_focus");
2955 g_object_unref (G_OBJECT (widget));
2959 reset_focus_recurse (GtkWidget *widget,
2962 if (GTK_IS_CONTAINER (widget))
2964 GtkContainer *container;
2966 container = GTK_CONTAINER (widget);
2967 gtk_container_set_focus_child (container, NULL);
2969 gtk_container_foreach (container,
2970 reset_focus_recurse,
2976 gtk_widget_real_grab_focus (GtkWidget *focus_widget)
2978 g_return_if_fail (focus_widget != NULL);
2979 g_return_if_fail (GTK_IS_WIDGET (focus_widget));
2981 if (GTK_WIDGET_CAN_FOCUS (focus_widget))
2983 GtkWidget *toplevel;
2986 /* clear the current focus setting, break if the current widget
2987 * is the focus widget's parent, since containers above that will
2988 * be set by the next loop.
2990 toplevel = gtk_widget_get_toplevel (focus_widget);
2991 if (GTK_IS_WINDOW (toplevel))
2993 widget = GTK_WINDOW (toplevel)->focus_widget;
2995 if (widget == focus_widget)
2997 /* We call gtk_window_set_focus() here so that the
2998 * toplevel window can request the focus if necessary.
2999 * This is needed when the toplevel is a GtkPlug
3001 if (!GTK_WIDGET_HAS_FOCUS (widget))
3002 gtk_window_set_focus (GTK_WINDOW (toplevel), focus_widget);
3009 while (widget->parent && widget->parent != focus_widget->parent)
3011 widget = widget->parent;
3012 gtk_container_set_focus_child (GTK_CONTAINER (widget), NULL);
3016 else if (toplevel != focus_widget)
3018 /* gtk_widget_grab_focus() operates on a tree without window...
3019 * actually, this is very questionable behaviour.
3022 gtk_container_foreach (GTK_CONTAINER (toplevel),
3023 reset_focus_recurse,
3027 /* now propagate the new focus up the widget tree and finally
3028 * set it on the window
3030 widget = focus_widget;
3031 while (widget->parent)
3033 gtk_container_set_focus_child (GTK_CONTAINER (widget->parent), widget);
3034 widget = widget->parent;
3036 if (GTK_IS_WINDOW (widget))
3037 gtk_window_set_focus (GTK_WINDOW (widget), focus_widget);
3042 * gtk_widget_is_focus:
3043 * @widget: a #GtkWidget
3045 * Determines if the widget is the focus widget within its
3046 * toplevel. (This does not mean that the HAS_FOCUS flag is
3047 * necessarily set; HAS_FOCUS will only be set if the
3048 * toplevel widget additionally has the global input focus.)
3050 * Return value: %TRUE if the widget is the focus widget.
3053 gtk_widget_is_focus (GtkWidget *widget)
3055 GtkWidget *toplevel;
3057 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
3059 toplevel = gtk_widget_get_toplevel (widget);
3061 if (GTK_IS_WINDOW (toplevel))
3062 return widget == GTK_WINDOW (toplevel)->focus_widget;
3068 * gtk_widget_grab_default:
3069 * @widget: a #GtkWidget
3071 * Causes @widget to become the default widget. @widget must have the
3072 * #GTK_CAN_DEFAULT flag set; typically you have to set this flag
3073 * yourself by calling GTK_WIDGET_SET_FLAGS (@widget,
3074 * GTK_CAN_DEFAULT). The default widget is activated when the user
3075 * presses Enter in a window. Default widgets must be activatable,
3076 * that is, gtk_widget_activate() should affect them.
3080 gtk_widget_grab_default (GtkWidget *widget)
3083 GtkType window_type;
3085 g_return_if_fail (widget != NULL);
3086 g_return_if_fail (GTK_IS_WIDGET (widget));
3087 g_return_if_fail (GTK_WIDGET_CAN_DEFAULT (widget));
3089 window_type = GTK_TYPE_WINDOW;
3090 window = widget->parent;
3092 while (window && !gtk_type_is_a (GTK_WIDGET_TYPE (window), window_type))
3093 window = window->parent;
3095 if (window && gtk_type_is_a (GTK_WIDGET_TYPE (window), window_type))
3097 gtk_window_set_default (GTK_WINDOW (window), widget);
3098 g_object_notify (G_OBJECT (widget), "has_default");
3101 g_warning (G_STRLOC ": widget not within a GtkWindow");
3105 * gtk_widget_set_name:
3106 * @widget: a #GtkWidget
3107 * @name: name for the widget
3109 * Widgets can be named, which allows you to refer to them from a
3110 * gtkrc file. You can apply a style to widgets with a particular name
3111 * in the gtkrc file. See the documentation for gtkrc files (on the
3112 * same page as the docs for #GtkRcStyle).
3116 gtk_widget_set_name (GtkWidget *widget,
3119 g_return_if_fail (widget != NULL);
3120 g_return_if_fail (GTK_IS_WIDGET (widget));
3123 g_free (widget->name);
3124 widget->name = g_strdup (name);
3126 if (GTK_WIDGET_RC_STYLE (widget))
3127 gtk_widget_set_rc_style (widget);
3129 g_object_notify (G_OBJECT (widget), "name");
3133 * gtk_widget_get_name:
3134 * @widget: a #GtkWidget
3136 * Retrieves the name of a widget. The return value should not be
3137 * freed. See gtk_widget_set_name() for the significance of widget
3140 * Return value: name of the widget
3142 G_CONST_RETURN gchar*
3143 gtk_widget_get_name (GtkWidget *widget)
3145 g_return_val_if_fail (widget != NULL, NULL);
3146 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
3149 return widget->name;
3150 return gtk_type_name (GTK_WIDGET_TYPE (widget));
3154 * gtk_widget_set_state:
3155 * @widget: a #GtkWidget
3156 * @state: new state for @widget
3158 * This function is for use in widget implementations. Sets the state
3159 * of a widget (insensitive, prelighted, etc.) Usually you should set
3160 * the state using wrapper functions such as gtk_widget_set_sensitive().
3164 gtk_widget_set_state (GtkWidget *widget,
3167 g_return_if_fail (widget != NULL);
3168 g_return_if_fail (GTK_IS_WIDGET (widget));
3170 if (state == GTK_WIDGET_STATE (widget))
3173 if (state == GTK_STATE_INSENSITIVE)
3174 gtk_widget_set_sensitive (widget, FALSE);
3180 data.state_restoration = FALSE;
3181 data.use_forall = FALSE;
3183 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget->parent) != FALSE);
3185 data.parent_sensitive = TRUE;
3187 gtk_widget_propagate_state (widget, &data);
3189 if (GTK_WIDGET_DRAWABLE (widget))
3190 gtk_widget_queue_clear (widget);
3195 gtk_widget_set_app_paintable (GtkWidget *widget,
3196 gboolean app_paintable)
3198 g_return_if_fail (widget != NULL);
3199 g_return_if_fail (GTK_IS_WIDGET (widget));
3201 app_paintable = (app_paintable != FALSE);
3203 if (GTK_WIDGET_APP_PAINTABLE (widget) != app_paintable)
3206 GTK_WIDGET_SET_FLAGS (widget, GTK_APP_PAINTABLE);
3208 GTK_WIDGET_UNSET_FLAGS (widget, GTK_APP_PAINTABLE);
3210 if (GTK_WIDGET_DRAWABLE (widget))
3211 gtk_widget_queue_clear (widget);
3213 g_object_notify (G_OBJECT (widget), "app_paintable");
3218 * gtk_widget_set_double_buffered:
3219 * @widget: a #GtkWidget
3220 * @double_buffered: %TRUE to double-buffer a widget
3222 * Widgets are double buffered by default; you can use this function
3223 * to turn off the buffering. "Double buffered" simply means that
3224 * gdk_window_begin_paint() and gdk_window_end_paint() are called
3225 * automatically around expose events sent to the
3226 * widget. gdk_window_begin_paint() diverts all drawing to a widget's
3227 * window to an offscreen buffer, and gdk_window_end_paint() draws the
3228 * buffer to the screen. The result is that users see the window
3229 * update in one smooth step, and don't see individual graphics
3230 * primitives being rendered.
3232 * In very simple terms, double buffered widgets don't flicker,
3233 * so you would only use this function to turn off double buffering
3234 * if you had special needs and really knew what you were doing.
3238 gtk_widget_set_double_buffered (GtkWidget *widget,
3239 gboolean double_buffered)
3241 g_return_if_fail (widget != NULL);
3242 g_return_if_fail (GTK_IS_WIDGET (widget));
3244 if (double_buffered)
3245 GTK_WIDGET_SET_FLAGS (widget, GTK_DOUBLE_BUFFERED);
3247 GTK_WIDGET_UNSET_FLAGS (widget, GTK_DOUBLE_BUFFERED);
3251 * gtk_widget_set_sensitive:
3252 * @widget: a @widget
3253 * @sensitive: %TRUE to make the widget sensitive
3255 * Sets the sensitivity of a widget. A widget is sensitive if the user
3256 * can interact with it. Insensitive widgets are "grayed out" and the
3257 * user can't interact with them. Insensitive widgets are known as
3258 * "inactive" in some other toolkits.
3262 gtk_widget_set_sensitive (GtkWidget *widget,
3267 g_return_if_fail (widget != NULL);
3268 g_return_if_fail (GTK_IS_WIDGET (widget));
3270 sensitive = (sensitive != FALSE);
3272 if (sensitive == (GTK_WIDGET_SENSITIVE (widget) != FALSE))
3277 GTK_WIDGET_SET_FLAGS (widget, GTK_SENSITIVE);
3278 data.state = GTK_WIDGET_SAVED_STATE (widget);
3282 GTK_WIDGET_UNSET_FLAGS (widget, GTK_SENSITIVE);
3283 data.state = GTK_WIDGET_STATE (widget);
3285 data.state_restoration = TRUE;
3286 data.use_forall = TRUE;
3289 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget->parent) != FALSE);
3291 data.parent_sensitive = TRUE;
3293 gtk_widget_propagate_state (widget, &data);
3294 if (GTK_WIDGET_DRAWABLE (widget))
3295 gtk_widget_queue_clear (widget);
3297 g_object_notify (G_OBJECT (widget), "sensitive");
3301 * gtk_widget_set_parent:
3302 * @widget: a #GtkWidget
3303 * @parent: parent container
3305 * This function is useful only when implementing subclasses of #GtkContainer.
3306 * Sets the container as the parent of @widget, and takes care of
3307 * some details such as updating the state and style of the child
3308 * to reflect its new location. The opposite function is
3309 * gtk_widget_unparent().
3313 gtk_widget_set_parent (GtkWidget *widget,
3318 g_return_if_fail (widget != NULL);
3319 g_return_if_fail (GTK_IS_WIDGET (widget));
3320 g_return_if_fail (widget->parent == NULL);
3321 g_return_if_fail (!GTK_WIDGET_TOPLEVEL (widget));
3322 g_return_if_fail (parent != NULL);
3323 g_return_if_fail (GTK_IS_WIDGET (parent));
3324 g_return_if_fail (widget != parent);
3326 /* keep this function in sync with gtk_menu_attach_to_widget()
3329 gtk_widget_ref (widget);
3330 gtk_object_sink (GTK_OBJECT (widget));
3331 widget->parent = parent;
3333 if (GTK_WIDGET_STATE (parent) != GTK_STATE_NORMAL)
3334 data.state = GTK_WIDGET_STATE (parent);
3336 data.state = GTK_WIDGET_STATE (widget);
3337 data.state_restoration = FALSE;
3338 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (parent) != FALSE);
3339 data.use_forall = GTK_WIDGET_IS_SENSITIVE (parent) != GTK_WIDGET_IS_SENSITIVE (widget);
3341 gtk_widget_propagate_state (widget, &data);
3343 gtk_widget_set_style_recurse (widget, NULL);
3345 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[PARENT_SET], NULL);
3346 gtk_widget_propagate_hierarchy_changed (widget, NULL);
3347 g_object_notify (G_OBJECT (widget), "parent");
3350 /*****************************************
3352 * see docs/styles.txt
3353 *****************************************/
3356 * gtk_widget_set_style:
3357 * @widget: a #GtkWidget
3358 * @style: a #GtkStyle
3360 * Sets the #GtkStyle for a widget (widget->style). You probably don't
3361 * want to use this function; it interacts badly with themes, because
3362 * themes work by replacing the #GtkStyle. Instead, use
3363 * gtk_widget_modify_style().
3367 gtk_widget_set_style (GtkWidget *widget,
3370 GtkStyle *default_style;
3371 gboolean initial_emission;
3373 g_return_if_fail (widget != NULL);
3374 g_return_if_fail (GTK_IS_WIDGET (widget));
3375 g_return_if_fail (style != NULL);
3377 initial_emission = !GTK_WIDGET_RC_STYLE (widget) && !GTK_WIDGET_USER_STYLE (widget);
3379 GTK_WIDGET_UNSET_FLAGS (widget, GTK_RC_STYLE);
3380 GTK_PRIVATE_SET_FLAG (widget, GTK_USER_STYLE);
3382 default_style = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_saved_default_style);
3385 gtk_style_ref (widget->style);
3386 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_saved_default_style, widget->style);
3389 gtk_widget_set_style_internal (widget, style, initial_emission);
3393 * gtk_widget_ensure_style:
3394 * @widget: a #GtkWidget
3396 * Ensures that @widget has a style (widget->style). Not a very useful
3397 * function; most of the time, if you want the style, the widget is
3398 * realized, and realized widgets are guaranteed to have a style
3403 gtk_widget_ensure_style (GtkWidget *widget)
3405 g_return_if_fail (widget != NULL);
3406 g_return_if_fail (GTK_IS_WIDGET (widget));
3408 if (!GTK_WIDGET_USER_STYLE (widget) &&
3409 !GTK_WIDGET_RC_STYLE (widget))
3410 gtk_widget_set_rc_style (widget);
3414 * gtk_widget_set_rc_style:
3415 * @widget: a #GtkWidget
3420 gtk_widget_set_rc_style (GtkWidget *widget)
3422 GtkStyle *saved_style;
3423 GtkStyle *new_style;
3424 gboolean initial_emission;
3426 g_return_if_fail (widget != NULL);
3427 g_return_if_fail (GTK_IS_WIDGET (widget));
3429 initial_emission = !GTK_WIDGET_RC_STYLE (widget) && !GTK_WIDGET_USER_STYLE (widget);
3431 GTK_PRIVATE_UNSET_FLAG (widget, GTK_USER_STYLE);
3432 GTK_WIDGET_SET_FLAGS (widget, GTK_RC_STYLE);
3434 saved_style = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_saved_default_style);
3435 new_style = gtk_rc_get_style (widget);
3440 gtk_style_ref (widget->style);
3441 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_saved_default_style, widget->style);
3443 gtk_widget_set_style_internal (widget, new_style, initial_emission);
3449 g_assert (initial_emission == FALSE); /* FIXME: remove this line */
3451 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_saved_default_style);
3452 gtk_widget_set_style_internal (widget, saved_style, initial_emission);
3453 gtk_style_unref (saved_style);
3457 if (initial_emission)
3458 gtk_widget_set_style_internal (widget, widget->style, TRUE);
3464 gtk_widget_restore_default_style (GtkWidget *widget)
3466 GtkStyle *default_style;
3468 g_return_if_fail (widget != NULL);
3469 g_return_if_fail (GTK_IS_WIDGET (widget));
3471 GTK_PRIVATE_UNSET_FLAG (widget, GTK_USER_STYLE);
3473 default_style = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_saved_default_style);
3476 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_saved_default_style);
3477 gtk_widget_set_style_internal (widget, default_style, FALSE);
3478 gtk_style_unref (default_style);
3483 * gtk_widget_get_style:
3484 * @widget: a #GtkWidget
3486 * Simply an accessor function that returns widget->style.
3488 * Return value: the widget's #GtkStyle
3491 gtk_widget_get_style (GtkWidget *widget)
3493 g_return_val_if_fail (widget != NULL, NULL);
3494 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
3496 return widget->style;
3500 * gtk_widget_modify_style:
3501 * @widget: a #GtkWidget
3502 * @style: the #GtkRcStyle holding the style modifications
3504 * Modify style values on the widget. Modifications made using this
3505 * technique take precendence over style values set via an RC file,
3506 * however, they will be overriden if a style is explicitely set on
3507 * the widget using gtk_widget_set_style(). The #GtkRcStyle structure
3508 * is designed so each field can either be set or unset, so it is
3509 * possible, using this function, to modify some style values and
3510 * leave the others unchanged.
3512 * Note that modifications made with this function are not cumulative
3513 * with previous calls to gtk_widget_modify_style() or with such
3514 * functions as gtk_widget_modify_fg(). If you wish to retain
3515 * previous values, you must first call gtk_widget_get_modifier_style(),
3516 * make your modifications to the returned style, then call
3517 * gtk_widget_modify_style() with that style. On the other hand,
3518 * if you first call gtk_widget_modify_style(), subsequent calls
3519 * to such functions gtk_widget_modify_fg() will be have a cumulative
3520 * effect with the inital modifications.
3523 gtk_widget_modify_style (GtkWidget *widget,
3526 GtkRcStyle *old_style;
3528 g_return_if_fail (GTK_IS_RC_STYLE (style));
3530 old_style = gtk_object_get_data_by_id (GTK_OBJECT (widget),
3533 gtk_object_set_data_by_id_full (GTK_OBJECT (widget),
3535 gtk_rc_style_copy (style),
3536 (GtkDestroyNotify)gtk_rc_style_unref);
3538 /* note that "style" may be invalid here if it was the old
3539 * modifier style and the only reference was our own.
3542 if (GTK_WIDGET_RC_STYLE (widget))
3543 gtk_widget_set_rc_style (widget);
3547 * gtk_widget_get_modifier_style:
3548 * @widget: a #GtkWidget
3550 * Return the current modifier style for the widget. (As set by
3551 * gtk_widget_modify_style().) If no style has previously set, a new
3552 * #GtkRcStyle will be created with all values unset, and set as the
3553 * modifier style for the widget. If you make changes to this rc
3554 * style, you must call gtk_widget_modify_style(), passing in the
3555 * returned rc style, to make sure that your changes take effect.
3557 * Caution: passing the style back to gtk_widget_modify_style() will
3558 * normally end up destroying it, because gtk_widget_modify_style() copies
3559 * the passed-in style and sets the copy as the new modifier style,
3560 * thus dropping any reference to the old modifier style. Add a reference
3561 * to the modifier style if you want to keep it alive.
3563 * Return value: the modifier style for the widget. This rc style is
3564 * owned by the widget. If you want to keep a pointer to value this
3565 * around, you must add a refcount using gtk_rc_style_ref().
3568 gtk_widget_get_modifier_style (GtkWidget *widget)
3570 GtkRcStyle *rc_style;
3572 rc_style = gtk_object_get_data_by_id (GTK_OBJECT (widget),
3577 rc_style = gtk_rc_style_new();
3578 gtk_object_set_data_by_id_full (GTK_OBJECT (widget),
3581 (GtkDestroyNotify)gtk_rc_style_unref);
3588 gtk_widget_modify_color_component (GtkWidget *widget,
3589 GtkRcFlags component,
3593 GtkRcStyle *rc_style = gtk_widget_get_modifier_style (widget);
3598 rc_style->fg[state] = *color;
3601 rc_style->bg[state] = *color;
3604 rc_style->text[state] = *color;
3607 rc_style->base[state] = *color;
3610 g_assert_not_reached();
3613 rc_style->color_flags[state] |= component;
3615 gtk_widget_modify_style (widget, rc_style);
3619 * gtk_widget_modify_fg:
3620 * @widget: a #GtkWidget
3621 * @state: the state for which to set the foreground color.
3622 * @color: the color to assign (does not need to be allocated)
3624 * Set the foreground color for a widget in a particular state. All
3625 * other style values are left untouched. See also
3626 * gtk_widget_modify_style().
3629 gtk_widget_modify_fg (GtkWidget *widget,
3633 g_return_if_fail (GTK_IS_WIDGET (widget));
3634 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
3635 g_return_if_fail (color != NULL);
3637 gtk_widget_modify_color_component (widget, GTK_RC_FG, state, color);
3641 * gtk_widget_modify_bg:
3642 * @widget: a #GtkWidget
3643 * @state: the state for which to set the foreground color.
3644 * @color: the color to assign (does not need to be allocated)
3646 * Set the background color for a widget in a particular state. All
3647 * other style values are left untouched. See also
3648 * gtk_widget_modify_style().
3651 gtk_widget_modify_bg (GtkWidget *widget,
3655 g_return_if_fail (GTK_IS_WIDGET (widget));
3656 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
3657 g_return_if_fail (color != NULL);
3659 gtk_widget_modify_color_component (widget, GTK_RC_BG, state, color);
3663 * gtk_widget_modify_base:
3664 * @widget: a #GtkWidget
3665 * @state: the state for which to set the foreground color.
3666 * @color: the color to assign (does not need to be allocated)
3668 * Set the text color for a widget in a particular state. All other
3669 * style values are left untouched. The text color is the foreground
3670 * color used along with the base color (see gtk_widget_modify_base)
3671 * for widgets such as #GtkEntry and #GtkTextView. See also
3672 * gtk_widget_modify_style().
3675 gtk_widget_modify_text (GtkWidget *widget,
3679 g_return_if_fail (GTK_IS_WIDGET (widget));
3680 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
3681 g_return_if_fail (color != NULL);
3683 gtk_widget_modify_color_component (widget, GTK_RC_TEXT, state, color);
3687 * gtk_widget_modify_base:
3688 * @widget: a #GtkWidget
3689 * @state: the state for which to set the foreground color.
3690 * @color: the color to assign (does not need to be allocated)
3692 * Set the text color for a widget in a particular state.
3693 * All other style values are left untouched. The base color
3694 * is the background color used along with the text color
3695 * (see gtk_widget_modify_text) for widgets such as #GtkEntry
3696 * and #GtkTextView. See also gtk_widget_modify_style().
3699 gtk_widget_modify_base (GtkWidget *widget,
3703 g_return_if_fail (GTK_IS_WIDGET (widget));
3704 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
3705 g_return_if_fail (color != NULL);
3707 gtk_widget_modify_color_component (widget, GTK_RC_BASE, state, color);
3711 * gtk_widget_modify_font:
3712 * @widget: a #GtkWidget
3713 * @font_desc: the font description to use
3715 * Set the font to use for a widget. All other style values are left
3716 * untouched. See also gtk_widget_modify_style().
3719 gtk_widget_modify_font (GtkWidget *widget,
3720 PangoFontDescription *font_desc)
3722 GtkRcStyle *rc_style;
3724 g_return_if_fail (GTK_IS_WIDGET (widget));
3725 g_return_if_fail (font_desc != NULL);
3727 rc_style = gtk_widget_get_modifier_style (widget);
3729 if (rc_style->font_desc)
3730 pango_font_description_free (rc_style->font_desc);
3732 rc_style->font_desc = pango_font_description_copy (font_desc);
3734 gtk_widget_modify_style (widget, rc_style);
3738 gtk_widget_direction_changed (GtkWidget *widget,
3739 GtkTextDirection previous_direction)
3741 gtk_widget_queue_resize (widget);
3745 gtk_widget_style_set (GtkWidget *widget,
3746 GtkStyle *previous_style)
3748 if (GTK_WIDGET_REALIZED (widget) &&
3749 !GTK_WIDGET_NO_WINDOW (widget))
3750 gtk_style_set_background (widget->style, widget->window, widget->state);
3754 gtk_widget_set_style_internal (GtkWidget *widget,
3756 gboolean initial_emission)
3758 g_return_if_fail (widget != NULL);
3759 g_return_if_fail (GTK_IS_WIDGET (widget));
3760 g_return_if_fail (style != NULL);
3762 g_object_ref (G_OBJECT (widget));
3763 g_object_freeze_notify (G_OBJECT (widget));
3765 if (widget->style != style || initial_emission)
3767 PangoContext *context = gtk_widget_peek_pango_context (widget);
3769 pango_context_set_font_description (context, style->font_desc);
3772 if (widget->style != style)
3774 GtkStyle *previous_style;
3776 if (GTK_WIDGET_REALIZED (widget))
3778 gtk_widget_reset_shapes (widget);
3779 gtk_style_detach (widget->style);
3782 previous_style = widget->style;
3783 widget->style = style;
3784 gtk_style_ref (widget->style);
3786 if (GTK_WIDGET_REALIZED (widget))
3787 widget->style = gtk_style_attach (widget->style, widget->window);
3789 gtk_signal_emit (GTK_OBJECT (widget),
3790 widget_signals[STYLE_SET],
3791 initial_emission ? NULL : previous_style);
3792 gtk_style_unref (previous_style);
3794 if (widget->parent && !initial_emission)
3796 GtkRequisition old_requisition;
3798 old_requisition = widget->requisition;
3799 gtk_widget_size_request (widget, NULL);
3801 if ((old_requisition.width != widget->requisition.width) ||
3802 (old_requisition.height != widget->requisition.height))
3803 gtk_widget_queue_resize (widget);
3804 else if (GTK_WIDGET_DRAWABLE (widget))
3805 gtk_widget_queue_clear (widget);
3808 else if (initial_emission)
3809 gtk_signal_emit (GTK_OBJECT (widget),
3810 widget_signals[STYLE_SET],
3812 g_object_notify (G_OBJECT (widget), "style");
3813 g_object_thaw_notify (G_OBJECT (widget));
3814 g_object_unref (G_OBJECT (widget));
3818 gtk_widget_set_style_recurse (GtkWidget *widget,
3819 gpointer client_data)
3821 if (GTK_WIDGET_RC_STYLE (widget))
3822 gtk_widget_set_rc_style (widget);
3824 if (GTK_IS_CONTAINER (widget))
3825 gtk_container_forall (GTK_CONTAINER (widget),
3826 gtk_widget_set_style_recurse,
3831 gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
3832 gpointer client_data)
3834 gboolean new_anchored;
3836 new_anchored = widget->parent && GTK_WIDGET_ANCHORED (widget->parent);
3838 if (GTK_WIDGET_ANCHORED (widget) != new_anchored)
3840 gtk_widget_ref (widget);
3843 GTK_PRIVATE_SET_FLAG (widget, GTK_ANCHORED);
3845 GTK_PRIVATE_UNSET_FLAG (widget, GTK_ANCHORED);
3847 g_signal_emit (GTK_OBJECT (widget), widget_signals[HIERARCHY_CHANGED], 0);
3849 if (GTK_IS_CONTAINER (widget))
3850 gtk_container_forall (GTK_CONTAINER (widget),
3851 gtk_widget_propagate_hierarchy_changed,
3854 gtk_widget_unref (widget);
3859 gtk_widget_reset_rc_styles (GtkWidget *widget)
3861 g_return_if_fail (widget != NULL);
3862 g_return_if_fail (GTK_IS_WIDGET (widget));
3864 gtk_widget_set_style_recurse (widget, NULL);
3868 gtk_widget_set_default_style (GtkStyle *style)
3870 if (style != gtk_default_style)
3872 if (gtk_default_style)
3873 gtk_style_unref (gtk_default_style);
3874 gtk_default_style = style;
3875 if (gtk_default_style)
3876 gtk_style_ref (gtk_default_style);
3881 gtk_widget_get_default_style (void)
3883 if (!gtk_default_style)
3885 gtk_default_style = gtk_style_new ();
3886 gtk_style_ref (gtk_default_style);
3889 return gtk_default_style;
3893 gtk_widget_push_style (GtkStyle *style)
3895 g_return_if_fail (style != NULL);
3897 gtk_style_ref (style);
3898 style_stack = g_slist_prepend (style_stack, style);
3902 gtk_widget_peek_style (void)
3905 return (GtkStyle*) style_stack->data;
3907 return gtk_widget_get_default_style ();
3911 gtk_widget_pop_style (void)
3918 style_stack = style_stack->next;
3919 gtk_style_unref ((GtkStyle*) tmp->data);
3920 g_slist_free_1 (tmp);
3924 static PangoContext *
3925 gtk_widget_peek_pango_context (GtkWidget *widget)
3927 return gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_pango_context);
3931 * gtk_widget_get_pango_context:
3932 * @widget: a #GtkWidget
3934 * Get a #PangoContext with the appropriate colormap, font description
3935 * and base direction for this widget. Unlike the context returned
3936 * by gtk_widget_create_pango_context(), this context is owned by
3937 * the widget (it can be used as long as widget exists), and will
3938 * be updated to match any changes to the widget's attributes.
3940 * If you create and keep a #PangoLayout using this context, you must
3941 * deal with changes to the context by calling pango_layout_context_changed()
3942 * on the layout in response to the ::style_set and ::direction_set signals
3945 * Return value: the #PangoContext for the widget.
3948 gtk_widget_get_pango_context (GtkWidget *widget)
3950 PangoContext *context;
3952 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
3954 context = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_pango_context);
3957 context = gtk_widget_create_pango_context (GTK_WIDGET (widget));
3958 gtk_object_set_data_by_id_full (GTK_OBJECT (widget), quark_pango_context, context,
3959 (GDestroyNotify) g_object_unref);
3966 * gtk_widget_create_pango_context:
3967 * @widget: a #PangoWidget
3969 * Create a new pango context with the appropriate colormap,
3970 * font description, and base direction for drawing text for
3971 * this widget. See also gtk_widget_get_pango_context()
3973 * Return value: the new #PangoContext
3976 gtk_widget_create_pango_context (GtkWidget *widget)
3978 PangoContext *context;
3981 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
3983 context = gdk_pango_context_get ();
3985 gdk_pango_context_set_colormap (context, gtk_widget_get_colormap (widget));
3986 pango_context_set_base_dir (context,
3987 gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR ?
3988 PANGO_DIRECTION_LTR : PANGO_DIRECTION_RTL);
3989 pango_context_set_font_description (context, widget->style->font_desc);
3991 lang = gtk_get_default_language ();
3992 pango_context_set_lang (context, lang);
3999 * gtk_widget_create_pango_layout:
4000 * @widget: a #PangoWidget
4001 * @text: text to set on the layout (can be %NULL)
4003 * Create a new #PangoLayout with the appropriate colormap,
4004 * font description, and base direction for drawing text for
4007 * If you keep a #PangoLayout created in this way around, in order
4008 * notify the layout of changes to the base direction or font of this
4009 * widget, you must call pango_layout_context_changed() in response to
4010 * the ::style_set and ::direction_set signals for the widget.
4012 * Return value: the new #PangoLayout
4015 gtk_widget_create_pango_layout (GtkWidget *widget,
4018 PangoLayout *layout;
4019 PangoContext *context;
4021 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4023 context = gtk_widget_get_pango_context (widget);
4024 layout = pango_layout_new (context);
4027 pango_layout_set_text (layout, text, -1);
4033 * gtk_widget_render_icon:
4034 * @widget: a #GtkWidget
4035 * @stock_id: a stock ID
4036 * @size: a stock size
4037 * @detail: render detail to pass to theme engine
4039 * A convenience function that uses the theme engine and RC file
4040 * settings for @widget to look up @stock_id and render it to
4041 * a pixbuf. @stock_id should be a stock icon ID such as
4042 * #GTK_STOCK_OPEN or #GTK_STOCK_BUTTON_OK. @size should be a size
4043 * such as #GTK_ICON_SIZE_MENU. @detail should be a string that
4044 * identifies the widget or code doing the rendering, so that
4045 * theme engines can special-case rendering for that widget or code.
4047 * Return value: a new pixbuf, or %NULL if the stock ID wasn't known
4050 gtk_widget_render_icon (GtkWidget *widget,
4051 const gchar *stock_id,
4053 const gchar *detail)
4055 GtkIconSet *icon_set;
4058 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4059 g_return_val_if_fail (stock_id != NULL, NULL);
4060 g_return_val_if_fail (size > GTK_ICON_SIZE_INVALID, NULL);
4062 gtk_widget_ensure_style (widget);
4064 icon_set = gtk_style_lookup_icon_set (widget->style, stock_id);
4066 if (icon_set == NULL)
4069 retval = gtk_icon_set_render_icon (icon_set,
4071 gtk_widget_get_direction (widget),
4072 GTK_WIDGET_STATE (widget),
4080 /*************************************************************
4081 * gtk_widget_set_parent_window:
4082 * Set a non default parent window for widget
4089 *************************************************************/
4092 gtk_widget_set_parent_window (GtkWidget *widget,
4093 GdkWindow *parent_window)
4095 GdkWindow *old_parent_window;
4097 g_return_if_fail (widget != NULL);
4098 g_return_if_fail (GTK_IS_WIDGET (widget));
4100 old_parent_window = gtk_object_get_data_by_id (GTK_OBJECT (widget),
4101 quark_parent_window);
4103 if (parent_window != old_parent_window)
4105 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_parent_window,
4107 if (old_parent_window)
4108 gdk_window_unref (old_parent_window);
4110 gdk_window_ref (parent_window);
4114 /*************************************************************
4115 * gtk_widget_get_parent_window:
4116 * Get widget's parent window
4123 *************************************************************/
4126 gtk_widget_get_parent_window (GtkWidget *widget)
4128 GdkWindow *parent_window;
4130 g_return_val_if_fail (widget != NULL, NULL);
4131 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4132 g_return_val_if_fail (widget->parent != NULL, NULL);
4134 parent_window = gtk_object_get_data_by_id (GTK_OBJECT (widget),
4135 quark_parent_window);
4137 return (parent_window != NULL) ? parent_window : widget->parent->window;
4140 /* Update the position from aux_info. Used from gtk_widget_set_uposition
4141 * and gtk_widget_set_property().
4144 gtk_widget_do_uposition (GtkWidget *widget)
4146 GtkWidgetAuxInfo *aux_info =_gtk_widget_get_aux_info (widget, FALSE);
4148 if (GTK_IS_WINDOW (widget) && aux_info->x_set && aux_info->y_set)
4149 _gtk_window_reposition (GTK_WINDOW (widget), aux_info->x, aux_info->y);
4151 if (GTK_WIDGET_VISIBLE (widget) && widget->parent)
4152 gtk_widget_size_allocate (widget, &widget->allocation);
4154 g_object_freeze_notify (G_OBJECT (widget));
4155 if (aux_info->x_set)
4156 g_object_notify (G_OBJECT (widget), "x");
4157 if (aux_info->y_set)
4158 g_object_notify (G_OBJECT (widget), "y");
4159 g_object_thaw_notify (G_OBJECT (widget));
4163 * gtk_widget_set_uposition:
4164 * @widget: a #GtkWidget
4165 * @x: x position; -1 to unset x; -2 to leave x unchanged
4166 * @y: y position; -1 to unset y; -2 to leave y unchanged
4169 * Sets the position of a widget. The funny "u" in the name comes from
4170 * the "user position" hint specified by the X window system, and
4171 * exists for legacy reasons. This function doesn't work if a widget
4172 * is inside a container; it's only really useful on #GtkWindow.
4174 * Don't use this function to center dialogs over the main application
4175 * window; most window managers will do the centering on your behalf
4176 * if you call gtk_window_set_transient_for(), and it's really not
4177 * possible to get the centering to work correctly in all cases from
4178 * application code. But if you insist, use gtk_window_set_position()
4179 * to set #GTK_WIN_POS_CENTER_ON_PARENT, don't do the centering
4182 * Note that although x and y can be individually unset, the position
4183 * is not honoured unless both x and y are set.
4186 gtk_widget_set_uposition (GtkWidget *widget,
4190 GtkWidgetAuxInfo *aux_info;
4192 g_return_if_fail (widget != NULL);
4193 g_return_if_fail (GTK_IS_WIDGET (widget));
4195 aux_info =_gtk_widget_get_aux_info (widget, TRUE);
4200 aux_info->x_set = FALSE;
4203 aux_info->x_set = TRUE;
4211 aux_info->y_set = FALSE;
4214 aux_info->y_set = TRUE;
4219 gtk_widget_do_uposition (widget);
4223 * gtk_widget_set_usize:
4224 * @widget: a #GtkWidget
4225 * @width: minimum width, or -1 to unset
4226 * @height: minimum height, or -1 to unset
4228 * Sets the minimum size of a widget; that is, the widget's size
4229 * request will be @width by @height. You can use this function to
4230 * force a widget to be either larger or smaller than it is. The
4231 * strange "usize" name dates from the early days of GTK+, and derives
4232 * from X Window System terminology. In many cases,
4233 * gtk_window_set_default_size() is a better choice for toplevel
4234 * windows than this function; setting the default size will still
4235 * allow users to shrink the window. Setting the usize will force them
4236 * to leave the window at least as large as the usize. When dealing
4237 * with window sizes, gtk_window_set_geometry_hints() can be a useful
4240 * Note the inherent danger of setting any fixed size - themes,
4241 * translations into other languages, different fonts, and user action
4242 * can all change the appropriate size for a given widget. So, it's
4243 * basically impossible to hardcode a size that will always be
4248 gtk_widget_set_usize (GtkWidget *widget,
4252 GtkWidgetAuxInfo *aux_info;
4254 g_return_if_fail (widget != NULL);
4255 g_return_if_fail (GTK_IS_WIDGET (widget));
4257 g_object_freeze_notify (G_OBJECT (widget));
4259 aux_info =_gtk_widget_get_aux_info (widget, TRUE);
4263 g_object_notify (G_OBJECT (widget), "width");
4264 aux_info->width = width;
4268 g_object_notify (G_OBJECT (widget), "height");
4269 aux_info->height = height;
4272 if (GTK_WIDGET_VISIBLE (widget))
4273 gtk_widget_queue_resize (widget);
4275 g_object_thaw_notify (G_OBJECT (widget));
4279 * gtk_widget_set_events:
4280 * @widget: a #GtkWidget
4281 * @events: event mask
4283 * Sets the event mask (see #GdkEventMask) for a widget. The event
4284 * mask determines which events a widget will receive. Keep in mind
4285 * that different widgets have different default event masks, and by
4286 * changing the event mask you may disrupt a widget's functionality,
4287 * so be careful. This function must be called while a widget is
4288 * unrealized. Consider gtk_widget_add_events() for widgets that are
4289 * already realized, or if you want to preserve the existing event
4290 * mask. This function can't be used with #GTK_NO_WINDOW widgets;
4291 * to get events on those widgets, place them inside a #GtkEventBox
4292 * and receive events on the event box.
4296 gtk_widget_set_events (GtkWidget *widget,
4301 g_return_if_fail (widget != NULL);
4302 g_return_if_fail (GTK_IS_WIDGET (widget));
4303 g_return_if_fail (!GTK_WIDGET_NO_WINDOW (widget));
4304 g_return_if_fail (!GTK_WIDGET_REALIZED (widget));
4306 eventp = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_event_mask);
4311 eventp = g_new (gint, 1);
4314 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_event_mask, eventp);
4319 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_event_mask);
4322 g_object_notify (G_OBJECT (widget), "events");
4326 * gtk_widget_add_events:
4327 * @widget: a #GtkWidget
4328 * @events: an event mask, see #GdkEventMask
4330 * Adds the events in the bitfield @events to the event mask for
4331 * @widget. See gtk_widget_set_events() for details.
4335 gtk_widget_add_events (GtkWidget *widget,
4340 g_return_if_fail (widget != NULL);
4341 g_return_if_fail (GTK_IS_WIDGET (widget));
4342 g_return_if_fail (!GTK_WIDGET_NO_WINDOW (widget));
4344 eventp = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_event_mask);
4350 eventp = g_new (gint, 1);
4355 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_event_mask, eventp);
4360 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_event_mask);
4363 if (GTK_WIDGET_REALIZED (widget))
4365 gdk_window_set_events (widget->window,
4366 gdk_window_get_events (widget->window) | events);
4369 g_object_notify (G_OBJECT (widget), "events");
4373 * gtk_widget_set_extension_events:
4374 * @widget: a #GtkWidget
4375 * @mode: bitfield of extension events to receive
4377 * Sets the extension events mask to @mode. See #GdkExtensionMode
4378 * and gdk_input_set_extension_events().
4382 gtk_widget_set_extension_events (GtkWidget *widget,
4383 GdkExtensionMode mode)
4385 GdkExtensionMode *modep;
4387 g_return_if_fail (widget != NULL);
4388 g_return_if_fail (GTK_IS_WIDGET (widget));
4390 modep = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_extension_event_mode);
4393 modep = g_new (GdkExtensionMode, 1);
4396 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_extension_event_mode, modep);
4397 g_object_notify (G_OBJECT (widget), "extension_events");
4401 * gtk_widget_get_toplevel:
4402 * @widget: a #GtkWidget
4404 * This function returns the topmost widget in the container hierarchy
4405 * @widget is a part of. If @widget has no parent widgets, it will be
4406 * returned as the topmost widget. No reference will be added to the
4407 * returned widget; it should not be unreferenced.
4409 * Note the difference in behavior vs. gtk_widget_get_ancestor();
4410 * gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW) would return
4411 * %NULL if @widget wasn't inside a toplevel window.
4413 * Return value: the topmost ancestor of @widget, or @widget itself if there's no ancestor
4416 gtk_widget_get_toplevel (GtkWidget *widget)
4418 g_return_val_if_fail (widget != NULL, NULL);
4419 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4421 while (widget->parent)
4422 widget = widget->parent;
4428 * gtk_widget_get_ancestor:
4429 * @widget: a #GtkWidget
4430 * @widget_type: ancestor type
4432 * Gets the first ancestor of @widget with type @widget_type. For example,
4433 * gtk_widget_get_ancestor (widget, GTK_TYPE_BOX) gets the first #GtkBox that's
4434 * an ancestor of @widget. No reference will be added to the returned widget;
4435 * it should not be unreferenced.
4437 * Return value: the ancestor widget, or %NULL if not found
4440 gtk_widget_get_ancestor (GtkWidget *widget,
4441 GtkType widget_type)
4443 g_return_val_if_fail (widget != NULL, NULL);
4444 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4446 while (widget && !gtk_type_is_a (GTK_WIDGET_TYPE (widget), widget_type))
4447 widget = widget->parent;
4449 if (!(widget && gtk_type_is_a (GTK_WIDGET_TYPE (widget), widget_type)))
4456 * gtk_widget_get_colormap:
4457 * @widget: a #GtkWidget
4459 * Gets the colormap that will be used to render @widget. No reference will
4460 * be added to the returned colormap; it should not be unreferenced.
4462 * Return value: the colormap used by @widget
4465 gtk_widget_get_colormap (GtkWidget *widget)
4467 GdkColormap *colormap;
4469 g_return_val_if_fail (widget != NULL, NULL);
4470 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4474 colormap = gdk_window_get_colormap (widget->window);
4475 /* If window was destroyed previously, we'll get NULL here */
4480 colormap = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_colormap);
4484 return gtk_widget_get_default_colormap ();
4488 * gtk_widget_get_visual:
4489 * @widget: a #GtkWidget
4491 * Gets the visual that will be used to render @widget.
4493 * Return value: the visual for @widget
4496 gtk_widget_get_visual (GtkWidget *widget)
4498 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4500 return gdk_colormap_get_visual (gtk_widget_get_colormap (widget));
4505 * gtk_widget_set_colormap:
4506 * @widget: a #GtkWidget
4507 * @colormap: a colormap
4509 * Set the colormap for the widget to the given value. Widget must not
4510 * have been previously realized. This probably should only be used
4511 * from an init() function (i.e. from the constructor for the widget).
4515 gtk_widget_set_colormap (GtkWidget *widget,
4516 GdkColormap *colormap)
4518 g_return_if_fail (widget != NULL);
4519 g_return_if_fail (GTK_IS_WIDGET (widget));
4520 g_return_if_fail (!GTK_WIDGET_REALIZED (widget));
4521 g_return_if_fail (GDK_IS_COLORMAP (colormap));
4523 g_object_ref (G_OBJECT (colormap));
4525 g_object_set_qdata_full (G_OBJECT (widget),
4528 (GtkDestroyNotify) g_object_unref);
4532 * gtk_widget_get_events:
4533 * @widget: a #GtkWidget
4535 * Returns the event mask for the widget (a bitfield containing flags
4536 * from the #GdkEventMask enumeration). These are the events that the widget
4539 * Return value: event mask for @widget
4542 gtk_widget_get_events (GtkWidget *widget)
4546 g_return_val_if_fail (widget != NULL, 0);
4547 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
4549 events = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_event_mask);
4557 * gtk_widget_get_extension_events:
4558 * @widget: a #GtkWidget
4560 * Retrieves the extension events the widget will receive; see
4561 * gdk_input_set_extension_events().
4563 * Return value: extension events for @widget
4566 gtk_widget_get_extension_events (GtkWidget *widget)
4568 GdkExtensionMode *mode;
4570 g_return_val_if_fail (widget != NULL, 0);
4571 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
4573 mode = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_extension_event_mode);
4581 * gtk_widget_get_pointer:
4582 * @widget: a #GtkWidget
4583 * @x: return location for the X coordinate, or %NULL
4584 * @y: return location for the Y coordinate, or %NULL
4586 * Obtains the location of the mouse pointer in widget coordinates.
4587 * Widget coordinates are a bit odd; for historical reasons, they are
4588 * defined as widget->window coordinates for widgets that are not
4589 * #GTK_NO_WINDOW widgets, and are relative to widget->allocation.x,
4590 * widget->allocation.y for widgets that are #GTK_NO_WINDOW widgets.
4594 gtk_widget_get_pointer (GtkWidget *widget,
4598 g_return_if_fail (widget != NULL);
4599 g_return_if_fail (GTK_IS_WIDGET (widget));
4606 if (GTK_WIDGET_REALIZED (widget))
4608 gdk_window_get_pointer (widget->window, x, y, NULL);
4610 if (GTK_WIDGET_NO_WINDOW (widget))
4613 *x -= widget->allocation.x;
4615 *y -= widget->allocation.y;
4621 * gtk_widget_is_ancestor:
4622 * @widget: a #GtkWidget
4623 * @ancestor: another #GtkWidget
4625 * Determines whether @widget is somewhere inside @ancestor, possibly with
4626 * intermediate containers.
4628 * Return value: %TRUE if @ancestor contains @widget as a child, grandchild, great grandchild, etc.
4631 gtk_widget_is_ancestor (GtkWidget *widget,
4632 GtkWidget *ancestor)
4634 g_return_val_if_fail (widget != NULL, FALSE);
4635 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4636 g_return_val_if_fail (ancestor != NULL, FALSE);
4640 if (widget->parent == ancestor)
4642 widget = widget->parent;
4648 static GQuark quark_composite_name = 0;
4651 gtk_widget_set_composite_name (GtkWidget *widget,
4654 g_return_if_fail (widget != NULL);
4655 g_return_if_fail (GTK_IS_WIDGET (widget));
4656 g_return_if_fail (GTK_WIDGET_COMPOSITE_CHILD (widget));
4657 g_return_if_fail (name != NULL);
4659 if (!quark_composite_name)
4660 quark_composite_name = g_quark_from_static_string ("gtk-composite-name");
4662 gtk_object_set_data_by_id_full (GTK_OBJECT (widget),
4663 quark_composite_name,
4669 gtk_widget_get_composite_name (GtkWidget *widget)
4671 g_return_val_if_fail (widget != NULL, NULL);
4672 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4674 if (GTK_WIDGET_COMPOSITE_CHILD (widget) && widget->parent)
4675 return gtk_container_child_composite_name (GTK_CONTAINER (widget->parent),
4682 gtk_widget_push_composite_child (void)
4684 composite_child_stack++;
4688 gtk_widget_pop_composite_child (void)
4690 if (composite_child_stack)
4691 composite_child_stack--;
4695 * gtk_widget_push_colormap:
4696 * @cmap: a #GdkColormap
4698 * Pushes @cmap onto a global stack of colormaps; the topmost
4699 * colormap on the stack will be used to create all widgets.
4700 * Remove @cmap with gtk_widget_pop_colormap(). There's little
4701 * reason to use this function.
4705 gtk_widget_push_colormap (GdkColormap *cmap)
4707 g_return_if_fail (cmap != NULL);
4709 colormap_stack = g_slist_prepend (colormap_stack, cmap);
4713 * gtk_widget_pop_colormap:
4715 * Removes a colormap pushed with gtk_widget_push_colormap().
4719 gtk_widget_pop_colormap (void)
4725 tmp = colormap_stack;
4726 colormap_stack = colormap_stack->next;
4727 g_slist_free_1 (tmp);
4732 * gtk_widget_set_default_colormap:
4733 * @colormap: a #GdkColormap
4735 * Sets the default colormap to use when creating widgets.
4736 * gtk_widget_push_colormap() is a better function to use if
4737 * you only want to affect a few widgets, rather than all widgets.
4741 gtk_widget_set_default_colormap (GdkColormap *colormap)
4743 if (default_colormap != colormap)
4745 if (default_colormap)
4746 gdk_colormap_unref (default_colormap);
4747 default_colormap = colormap;
4748 if (default_colormap)
4749 gdk_colormap_ref (default_colormap);
4754 * gtk_widget_get_default_colormap:
4756 * Obtains the default colormap used to create widgets.
4758 * Return value: default widget colormap
4761 gtk_widget_get_default_colormap (void)
4763 if (!default_colormap)
4764 gtk_widget_set_default_colormap (gdk_colormap_get_system ());
4766 return default_colormap;
4770 * gtk_widget_get_default_visual:
4772 * Obtains the visual of the default colormap. Not really useful;
4773 * used to be useful before gdk_colormap_get_visual() existed.
4775 * Return value: visual of the default colormap
4778 gtk_widget_get_default_visual (void)
4780 return gdk_colormap_get_visual (gtk_widget_get_default_colormap ());
4784 gtk_widget_emit_direction_changed (GtkWidget *widget,
4785 GtkTextDirection old_dir)
4787 PangoContext *context = gtk_widget_peek_pango_context (widget);
4790 pango_context_set_base_dir (context,
4791 gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR ?
4792 PANGO_DIRECTION_LTR : PANGO_DIRECTION_RTL);
4794 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[DIRECTION_CHANGED], old_dir);
4798 * gtk_widget_set_direction:
4799 * @widget: a #GtkWidget
4800 * @dir: the new direction
4802 * Set the reading direction on a particular widget. This direction
4803 * controls the primary direction for widgets containing text,
4804 * and also the direction in which the children of a container are
4805 * packed. The ability to set the direction is present in order
4806 * so that correct localization into languages with right-to-left
4807 * reading directions can be done. Generally, applications will
4808 * let the default reading direction present, except for containers
4809 * where the containers are arranged in an order that is explicitely
4810 * visual rather than logical (such as buttons for text justificiation).
4812 * If the direction is set to %GTK_TEXT_DIR_NONE, then the value
4813 * set by gtk_widget_set_default_direction() will be used.
4816 gtk_widget_set_direction (GtkWidget *widget,
4817 GtkTextDirection dir)
4819 GtkTextDirection old_dir;
4821 g_return_if_fail (widget != NULL);
4822 g_return_if_fail (GTK_IS_WIDGET (widget));
4823 g_return_if_fail (dir >= GTK_TEXT_DIR_NONE && dir <= GTK_TEXT_DIR_RTL);
4825 old_dir = gtk_widget_get_direction (widget);
4827 if (dir == GTK_TEXT_DIR_NONE)
4828 GTK_PRIVATE_UNSET_FLAG (widget, GTK_DIRECTION_SET);
4831 GTK_PRIVATE_SET_FLAG (widget, GTK_DIRECTION_SET);
4832 if (dir == GTK_TEXT_DIR_LTR)
4833 GTK_PRIVATE_SET_FLAG (widget, GTK_DIRECTION_LTR);
4835 GTK_PRIVATE_UNSET_FLAG (widget, GTK_DIRECTION_LTR);
4838 if (old_dir != gtk_widget_get_direction (widget))
4839 gtk_widget_emit_direction_changed (widget, old_dir);
4843 * gtk_widget_get_direction:
4844 * @widget: a #GtkWidget
4846 * Get the reading direction for a particular widget. See
4847 * gtk_widget_set_direction().
4849 * Return value: the reading direction for the widget.
4852 gtk_widget_get_direction (GtkWidget *widget)
4854 g_return_val_if_fail (widget != NULL, GTK_TEXT_DIR_LTR);
4855 g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_TEXT_DIR_LTR);
4857 if (GTK_WIDGET_DIRECTION_SET (widget))
4858 return GTK_WIDGET_DIRECTION_LTR (widget) ? GTK_TEXT_DIR_LTR : GTK_TEXT_DIR_RTL;
4860 return gtk_default_direction;
4864 gtk_widget_set_default_direction_recurse (GtkWidget *widget, gpointer data)
4866 GtkTextDirection old_dir = GPOINTER_TO_UINT (data);
4868 g_object_ref (G_OBJECT (widget));
4870 if (!GTK_WIDGET_DIRECTION_SET (widget))
4871 gtk_widget_emit_direction_changed (widget, old_dir);
4873 if (GTK_IS_CONTAINER (widget))
4874 gtk_container_forall (GTK_CONTAINER (widget),
4875 gtk_widget_set_default_direction_recurse,
4878 g_object_unref (G_OBJECT (widget));
4882 * gtk_widget_set_default_direction:
4883 * @dir: the new default direction. This cannot be
4884 * %GTK_TEXT_DIR_NONE.
4886 * Set the default reading direction for widgets where the
4887 * direction has not been explicitly set by gtk_widget_set_direction().
4890 gtk_widget_set_default_direction (GtkTextDirection dir)
4892 g_return_if_fail (dir == GTK_TEXT_DIR_RTL || dir == GTK_TEXT_DIR_LTR);
4894 if (dir != gtk_default_direction)
4896 GList *toplevels, *tmp_list;
4897 GtkTextDirection old_dir = gtk_default_direction;
4899 gtk_default_direction = dir;
4901 tmp_list = toplevels = gtk_window_list_toplevels ();
4902 g_list_foreach (toplevels, (GFunc)g_object_ref, NULL);
4906 gtk_widget_set_default_direction_recurse (tmp_list->data,
4907 GUINT_TO_POINTER (old_dir));
4908 g_object_unref (tmp_list->data);
4909 tmp_list = tmp_list->next;
4912 g_list_free (toplevels);
4917 * gtk_widget_get_default_direction:
4919 * Return value: the current default direction. See
4920 * gtk_widget_set_direction().
4923 gtk_widget_get_default_direction (void)
4925 return gtk_default_direction;
4929 gtk_widget_shutdown (GObject *object)
4931 GtkWidget *widget = GTK_WIDGET (object);
4934 gtk_container_remove (GTK_CONTAINER (widget->parent), widget);
4936 GTK_WIDGET_UNSET_FLAGS (widget, GTK_VISIBLE);
4937 if (GTK_WIDGET_REALIZED (widget))
4938 gtk_widget_unrealize (widget);
4940 G_OBJECT_CLASS (parent_class)->shutdown (object);
4944 gtk_widget_real_destroy (GtkObject *object)
4947 GtkStyle *saved_style;
4949 /* gtk_object_destroy() will already hold a refcount on object
4951 widget = GTK_WIDGET (object);
4953 gtk_grab_remove (widget);
4954 gtk_selection_remove_all (widget);
4956 saved_style = gtk_object_get_data_by_id (object, quark_saved_default_style);
4959 gtk_style_unref (saved_style);
4960 gtk_object_remove_data_by_id (object, quark_saved_default_style);
4963 gtk_style_unref (widget->style);
4964 widget->style = gtk_widget_peek_style ();
4965 gtk_style_ref (widget->style);
4967 GTK_OBJECT_CLASS (parent_class)->destroy (object);
4971 gtk_widget_finalize (GObject *object)
4973 GtkWidget *widget = GTK_WIDGET (object);
4974 GtkWidgetAuxInfo *aux_info;
4976 GdkExtensionMode *mode;
4977 GtkStyle *saved_style;
4978 GtkAccessible *accessible;
4980 gtk_grab_remove (widget);
4981 gtk_selection_remove_all (widget);
4983 saved_style = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_saved_default_style);
4986 gtk_style_unref (saved_style);
4987 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_saved_default_style);
4990 gtk_style_unref (widget->style);
4991 widget->style = NULL;
4994 g_free (widget->name);
4996 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
4998 gtk_widget_aux_info_destroy (aux_info);
5000 events = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_event_mask);
5004 mode = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_extension_event_mode);
5008 accessible = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_accessible_object);
5010 g_object_unref (G_OBJECT (accessible));
5012 G_OBJECT_CLASS (parent_class)->finalize (object);
5015 /*****************************************
5016 * gtk_widget_real_map:
5021 *****************************************/
5024 gtk_widget_real_map (GtkWidget *widget)
5026 g_return_if_fail (GTK_IS_WIDGET (widget));
5027 g_return_if_fail (GTK_WIDGET_REALIZED (widget) == TRUE);
5029 if (!GTK_WIDGET_MAPPED (widget))
5031 GTK_WIDGET_SET_FLAGS (widget, GTK_MAPPED);
5033 if (!GTK_WIDGET_NO_WINDOW (widget))
5034 gdk_window_show (widget->window);
5038 /*****************************************
5039 * gtk_widget_real_unmap:
5044 *****************************************/
5047 gtk_widget_real_unmap (GtkWidget *widget)
5049 g_return_if_fail (widget != NULL);
5050 g_return_if_fail (GTK_IS_WIDGET (widget));
5052 if (GTK_WIDGET_MAPPED (widget))
5054 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
5056 if (!GTK_WIDGET_NO_WINDOW (widget))
5057 gdk_window_hide (widget->window);
5061 /*****************************************
5062 * gtk_widget_real_realize:
5067 *****************************************/
5070 gtk_widget_real_realize (GtkWidget *widget)
5072 g_return_if_fail (widget != NULL);
5073 g_return_if_fail (GTK_IS_WIDGET (widget));
5074 g_return_if_fail (GTK_WIDGET_NO_WINDOW (widget));
5076 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
5079 widget->window = gtk_widget_get_parent_window (widget);
5080 gdk_window_ref (widget->window);
5082 widget->style = gtk_style_attach (widget->style, widget->window);
5085 /*****************************************
5086 * gtk_widget_real_unrealize:
5091 *****************************************/
5094 gtk_widget_real_unrealize (GtkWidget *widget)
5096 g_return_if_fail (widget != NULL);
5097 g_return_if_fail (GTK_IS_WIDGET (widget));
5099 if (GTK_WIDGET_MAPPED (widget))
5100 gtk_widget_real_unmap (widget);
5102 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
5104 /* printf ("unrealizing %s\n", gtk_type_name (GTK_OBJECT (widget)->klass->type));
5107 /* We must do unrealize child widget BEFORE container widget.
5108 * gdk_window_destroy() destroys specified xwindow and its sub-xwindows.
5109 * So, unrealizing container widget bofore its children causes the problem
5110 * (for example, gdk_ic_destroy () with destroyed window causes crash. )
5113 if (GTK_IS_CONTAINER (widget))
5114 gtk_container_forall (GTK_CONTAINER (widget),
5115 (GtkCallback) gtk_widget_unrealize,
5118 gtk_style_detach (widget->style);
5119 if (!GTK_WIDGET_NO_WINDOW (widget))
5121 gdk_window_set_user_data (widget->window, NULL);
5122 gdk_window_destroy (widget->window);
5123 widget->window = NULL;
5127 gdk_window_unref (widget->window);
5128 widget->window = NULL;
5131 GTK_WIDGET_UNSET_FLAGS (widget, GTK_REALIZED);
5135 gtk_widget_real_size_request (GtkWidget *widget,
5136 GtkRequisition *requisition)
5138 g_return_if_fail (widget != NULL);
5139 g_return_if_fail (GTK_IS_WIDGET (widget));
5141 requisition->width = widget->requisition.width;
5142 requisition->height = widget->requisition.height;
5145 /*****************************************
5146 * gtk_widget_peek_colormap:
5151 *****************************************/
5154 gtk_widget_peek_colormap (void)
5157 return (GdkColormap*) colormap_stack->data;
5158 return gtk_widget_get_default_colormap ();
5162 gtk_widget_propagate_state (GtkWidget *widget,
5167 /* don't call this function with state==GTK_STATE_INSENSITIVE,
5168 * parent_sensitive==TRUE on a sensitive widget
5171 old_state = GTK_WIDGET_STATE (widget);
5173 if (data->parent_sensitive)
5175 GTK_WIDGET_SET_FLAGS (widget, GTK_PARENT_SENSITIVE);
5177 if (GTK_WIDGET_IS_SENSITIVE (widget))
5179 if (data->state_restoration)
5180 GTK_WIDGET_STATE (widget) = GTK_WIDGET_SAVED_STATE (widget);
5182 GTK_WIDGET_STATE (widget) = data->state;
5186 GTK_WIDGET_STATE (widget) = GTK_STATE_INSENSITIVE;
5187 if (!data->state_restoration &&
5188 data->state != GTK_STATE_INSENSITIVE)
5189 GTK_WIDGET_SAVED_STATE (widget) = data->state;
5194 GTK_WIDGET_UNSET_FLAGS (widget, GTK_PARENT_SENSITIVE);
5195 if (!data->state_restoration)
5197 if (data->state != GTK_STATE_INSENSITIVE)
5198 GTK_WIDGET_SAVED_STATE (widget) = data->state;
5200 else if (GTK_WIDGET_STATE (widget) != GTK_STATE_INSENSITIVE)
5201 GTK_WIDGET_SAVED_STATE (widget) = GTK_WIDGET_STATE (widget);
5202 GTK_WIDGET_STATE (widget) = GTK_STATE_INSENSITIVE;
5205 if (GTK_WIDGET_HAS_FOCUS (widget) && !GTK_WIDGET_IS_SENSITIVE (widget))
5209 window = gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW);
5211 gtk_window_set_focus (GTK_WINDOW (window), NULL);
5214 if (old_state != GTK_WIDGET_STATE (widget))
5216 gtk_widget_ref (widget);
5217 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[STATE_CHANGED], old_state);
5219 if (GTK_IS_CONTAINER (widget))
5221 data->parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget) != FALSE);
5222 data->state = GTK_WIDGET_STATE (widget);
5223 if (data->use_forall)
5224 gtk_container_forall (GTK_CONTAINER (widget),
5225 (GtkCallback) gtk_widget_propagate_state,
5228 gtk_container_foreach (GTK_CONTAINER (widget),
5229 (GtkCallback) gtk_widget_propagate_state,
5232 gtk_widget_unref (widget);
5237 * _gtk_widget_get_aux_info:
5238 * @widget: a #GtkWidget
5239 * @create: if %TRUE, create the structure if it doesn't exist
5241 * Get the #GtkWidgetAuxInfo structure for the widget.
5243 * Return value: the #GtkAuxInfo structure for the widget, or
5244 * %NULL if @create is %FALSE and one doesn't already exist.
5247 _gtk_widget_get_aux_info (GtkWidget *widget,
5250 GtkWidgetAuxInfo *aux_info;
5252 aux_info = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_aux_info);
5253 if (!aux_info && create)
5255 if (!aux_info_mem_chunk)
5256 aux_info_mem_chunk = g_mem_chunk_new ("widget aux info mem chunk",
5257 sizeof (GtkWidgetAuxInfo),
5258 1024, G_ALLOC_AND_FREE);
5259 aux_info = g_chunk_new (GtkWidgetAuxInfo, aux_info_mem_chunk);
5261 aux_info->width = -1;
5262 aux_info->height = -1;
5265 aux_info->x_set = FALSE;
5266 aux_info->y_set = FALSE;
5267 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_aux_info, aux_info);
5273 /*****************************************
5274 * gtk_widget_aux_info_destroy:
5279 *****************************************/
5282 gtk_widget_aux_info_destroy (GtkWidgetAuxInfo *aux_info)
5284 g_return_if_fail (aux_info != NULL);
5286 g_mem_chunk_free (aux_info_mem_chunk, aux_info);
5290 gtk_widget_shape_info_destroy (GtkWidgetShapeInfo *info)
5292 gdk_drawable_unref (info->shape_mask);
5296 /*****************************************
5297 * gtk_widget_shape_combine_mask:
5298 * set a shape for this widgets' gdk window, this allows for
5299 * transparent windows etc., see gdk_window_shape_combine_mask
5300 * for more information
5305 *****************************************/
5307 gtk_widget_shape_combine_mask (GtkWidget *widget,
5308 GdkBitmap *shape_mask,
5312 GtkWidgetShapeInfo* shape_info;
5314 g_return_if_fail (widget != NULL);
5315 g_return_if_fail (GTK_IS_WIDGET (widget));
5316 /* set_shape doesn't work on widgets without gdk window */
5317 g_return_if_fail (!GTK_WIDGET_NO_WINDOW (widget));
5321 GTK_PRIVATE_UNSET_FLAG (widget, GTK_HAS_SHAPE_MASK);
5324 gdk_window_shape_combine_mask (widget->window, NULL, 0, 0);
5326 g_object_set_qdata (G_OBJECT (widget), quark_shape_info, NULL);
5330 GTK_PRIVATE_SET_FLAG (widget, GTK_HAS_SHAPE_MASK);
5332 shape_info = g_new (GtkWidgetShapeInfo, 1);
5333 g_object_set_qdata_full (G_OBJECT (widget), quark_shape_info, shape_info,
5334 (GDestroyNotify) gtk_widget_shape_info_destroy);
5336 shape_info->shape_mask = gdk_drawable_ref (shape_mask);
5337 shape_info->offset_x = offset_x;
5338 shape_info->offset_y = offset_y;
5340 /* set shape if widget has a gdk window allready.
5341 * otherwise the shape is scheduled to be set by gtk_widget_realize.
5344 gdk_window_shape_combine_mask (widget->window, shape_mask,
5345 offset_x, offset_y);
5350 gtk_reset_shapes_recurse (GtkWidget *widget,
5356 gdk_window_get_user_data (window, &data);
5360 gdk_window_shape_combine_mask (window, NULL, 0, 0);
5361 for (list = gdk_window_peek_children (window); list; list = list->next)
5362 gtk_reset_shapes_recurse (widget, list->data);
5366 gtk_widget_reset_shapes (GtkWidget *widget)
5368 g_return_if_fail (widget != NULL);
5369 g_return_if_fail (GTK_IS_WIDGET (widget));
5370 g_return_if_fail (GTK_WIDGET_REALIZED (widget));
5372 if (!GTK_WIDGET_HAS_SHAPE_MASK (widget))
5373 gtk_reset_shapes_recurse (widget, widget->window);
5378 * @widget: a #GtkWidget
5380 * Adds a reference to a widget. This function is exactly the same
5381 * as calling g_object_ref(), and exists mostly for historical
5382 * reasons. It can still be convenient to avoid casting a widget
5383 * to a #GObject, it saves a small amount of typing.
5385 * Return value: the widget that was referenced
5388 gtk_widget_ref (GtkWidget *widget)
5390 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5392 return (GtkWidget*) g_object_ref ((GObject*) widget);
5397 * @widget: a #GtkWidget
5399 * Inverse of gtk_widget_ref(). Equivalent to g_object_unref().
5403 gtk_widget_unref (GtkWidget *widget)
5405 g_return_if_fail (GTK_IS_WIDGET (widget));
5407 g_object_unref ((GObject*) widget);
5415 gtk_widget_class_install_style_property_parser (GtkWidgetClass *class,
5417 GtkRcPropertyParser parser)
5419 g_return_if_fail (GTK_IS_WIDGET_CLASS (class));
5420 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
5421 g_return_if_fail (pspec->flags & G_PARAM_READABLE);
5422 g_return_if_fail (!(pspec->flags & (G_PARAM_CONSTRUCT_ONLY | G_PARAM_CONSTRUCT)));
5424 if (g_param_spec_pool_lookup (style_property_spec_pool, pspec->name, G_OBJECT_CLASS_TYPE (class), FALSE))
5426 g_warning (G_STRLOC ": class `%s' already contains a style property named `%s'",
5427 G_OBJECT_CLASS_NAME (class),
5432 g_param_spec_ref (pspec);
5433 g_param_spec_sink (pspec);
5434 g_param_spec_set_qdata (pspec, quark_property_parser, parser);
5435 g_param_spec_pool_insert (style_property_spec_pool, pspec, G_OBJECT_CLASS_TYPE (class));
5439 gtk_widget_class_install_style_property (GtkWidgetClass *class,
5442 GtkRcPropertyParser parser;
5444 g_return_if_fail (GTK_IS_WIDGET_CLASS (class));
5445 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
5447 parser = _gtk_rc_property_parser_from_type (G_PARAM_SPEC_VALUE_TYPE (pspec));
5449 gtk_widget_class_install_style_property_parser (class, pspec, parser);
5453 gtk_widget_style_get_property (GtkWidget *widget,
5454 const gchar *property_name,
5459 g_return_if_fail (GTK_IS_WIDGET (widget));
5460 g_return_if_fail (property_name != NULL);
5461 g_return_if_fail (G_IS_VALUE (value));
5463 g_object_ref (widget);
5464 pspec = g_param_spec_pool_lookup (style_property_spec_pool,
5466 G_OBJECT_TYPE (widget),
5469 g_warning ("%s: widget class `%s' has no property named `%s'",
5471 G_OBJECT_TYPE_NAME (widget),
5475 const GValue *peek_value;
5477 peek_value = _gtk_style_peek_property_value (widget->style,
5478 G_OBJECT_TYPE (widget),
5480 g_param_spec_get_qdata (pspec, quark_property_parser));
5482 /* auto-conversion of the caller's value type
5484 if (G_VALUE_TYPE (value) == G_PARAM_SPEC_VALUE_TYPE (pspec))
5485 g_value_copy (peek_value, value);
5486 else if (g_value_type_transformable (G_PARAM_SPEC_VALUE_TYPE (pspec), G_VALUE_TYPE (value)))
5487 g_value_transform (peek_value, value);
5489 g_warning ("can't retrive style property `%s' of type `%s' as value of type `%s'",
5491 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
5492 G_VALUE_TYPE_NAME (value));
5494 g_object_unref (widget);
5498 gtk_widget_style_get_valist (GtkWidget *widget,
5499 const gchar *first_property_name,
5504 g_return_if_fail (GTK_IS_WIDGET (widget));
5506 g_object_ref (widget);
5508 name = first_property_name;
5511 const GValue *peek_value;
5515 pspec = g_param_spec_pool_lookup (style_property_spec_pool,
5517 G_OBJECT_TYPE (widget),
5521 g_warning ("%s: widget class `%s' has no property named `%s'",
5523 G_OBJECT_TYPE_NAME (widget),
5527 /* style pspecs are always readable so we can spare that check here */
5529 peek_value = _gtk_style_peek_property_value (widget->style,
5530 G_OBJECT_TYPE (widget),
5532 g_param_spec_get_qdata (pspec, quark_property_parser));
5533 G_VALUE_LCOPY (peek_value, var_args, 0, &error);
5536 g_warning ("%s: %s", G_STRLOC, error);
5541 name = va_arg (var_args, gchar*);
5544 g_object_unref (widget);
5548 gtk_widget_style_get (GtkWidget *widget,
5549 const gchar *first_property_name,
5554 g_return_if_fail (GTK_IS_WIDGET (widget));
5556 va_start (var_args, first_property_name);
5557 gtk_widget_style_get_valist (widget, first_property_name, var_args);
5563 * @widget: a #GtkWidget
5564 * @path_length: location to store length of the path
5565 * @path: location to store allocated path string
5566 * @path_reversed: location to store allocated reverse path string
5568 * Obtains the full path to @widget. The path is simply the name of a
5569 * widget and all its parents in the container hierarchy, separated by
5570 * periods. The name of a widget comes from
5571 * gtk_widget_get_name(). Paths are used to apply styles to a widget
5572 * in gtkrc configuration files. Widget names are the type of the
5573 * widget by default (e.g. "GtkButton") or can be set to an
5574 * application-specific value with gtk_widget_set_name(). By setting
5575 * the name of a widget, you allow users or theme authors to apply
5576 * styles to that specific widget in their gtkrc
5577 * file. @path_reversed_p fills in the path in reverse order,
5578 * i.e. starting with @widget's name instead of starting with the name
5579 * of @widget's outermost ancestor.
5583 gtk_widget_path (GtkWidget *widget,
5584 guint *path_length_p,
5586 gchar **path_reversed_p)
5588 static gchar *rev_path = NULL;
5589 static guint path_len = 0;
5592 g_return_if_fail (widget != NULL);
5593 g_return_if_fail (GTK_IS_WIDGET (widget));
5598 const gchar *string;
5603 string = gtk_widget_get_name (widget);
5604 l = strlen (string);
5605 while (path_len <= len + l + 1)
5607 path_len += INIT_PATH_SIZE;
5608 rev_path = g_realloc (rev_path, path_len);
5616 widget = widget->parent;
5619 rev_path[len++] = '.';
5621 rev_path[len++] = 0;
5626 *path_length_p = len - 1;
5627 if (path_reversed_p)
5628 *path_reversed_p = g_strdup (rev_path);
5631 *path_p = g_strdup (rev_path);
5632 g_strreverse (*path_p);
5637 * gtk_widget_class_path:
5638 * @widget: a #GtkWidget
5639 * @path_length: location to store the length of the class path
5640 * @path: location to store the class path as an allocated string
5641 * @path_reversed: location to store the reverse class path as an allocated string
5643 * Same as gtk_widget_path(), but always uses the name of a widget's type,
5644 * never uses a custom name set with gtk_widget_set_name().
5648 gtk_widget_class_path (GtkWidget *widget,
5649 guint *path_length_p,
5651 gchar **path_reversed_p)
5653 static gchar *rev_path = NULL;
5654 static guint path_len = 0;
5657 g_return_if_fail (widget != NULL);
5658 g_return_if_fail (GTK_IS_WIDGET (widget));
5663 const gchar *string;
5668 string = gtk_type_name (GTK_WIDGET_TYPE (widget));
5669 l = strlen (string);
5670 while (path_len <= len + l + 1)
5672 path_len += INIT_PATH_SIZE;
5673 rev_path = g_realloc (rev_path, path_len);
5681 widget = widget->parent;
5684 rev_path[len++] = '.';
5686 rev_path[len++] = 0;
5691 *path_length_p = len - 1;
5692 if (path_reversed_p)
5693 *path_reversed_p = g_strdup (rev_path);
5696 *path_p = g_strdup (rev_path);
5697 g_strreverse (*path_p);
5702 gtk_requisition_copy (const GtkRequisition *requisition)
5704 return (GtkRequisition *)g_memdup (requisition, sizeof (GtkRequisition));
5708 gtk_requisition_free (GtkRequisition *requisition)
5710 g_free (requisition);
5713 AtkObject* gtk_widget_get_accessible (GtkWidget *widget)
5715 GtkWidgetClass *klass;
5717 g_return_val_if_fail (widget != NULL, NULL);
5718 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5720 klass = GTK_WIDGET_GET_CLASS (widget);
5722 g_return_val_if_fail (klass->get_accessible != NULL, NULL);
5724 return klass->get_accessible(widget);
5727 AtkObject* gtk_widget_real_get_accessible (GtkWidget *widget)
5729 AtkObject* accessible;
5731 accessible = g_object_get_qdata (G_OBJECT (widget),
5732 quark_accessible_object);
5735 AtkObjectFactory *factory;
5736 AtkRegistry *default_registry;
5738 default_registry = atk_get_default_registry ();
5739 factory = atk_registry_get_factory (default_registry,
5740 GTK_OBJECT_TYPE (widget));
5742 atk_object_factory_create_accessible (factory,
5744 g_object_set_qdata (G_OBJECT (widget),
5745 quark_accessible_object,
5752 * Initialize a AtkImplementorIface instance's virtual pointers as
5753 * appropriate to this implementor's class (GtkWidget).
5756 gtk_widget_accessible_interface_init (AtkImplementorIface *iface)
5758 iface->ref_accessible = gtk_widget_ref_accessible;
5762 gtk_widget_ref_accessible(AtkImplementor *implementor)
5764 AtkObject *accessible;
5766 accessible = gtk_widget_get_accessible (GTK_WIDGET (implementor));
5768 g_object_ref (G_OBJECT (accessible));