1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
30 #include "gtkcontainer.h"
31 #include "gtkiconfactory.h"
35 #include "gtkselection.h"
36 #include "gtksettings.h"
37 #include "gtksizegroup.h"
38 #include "gtksignal.h"
39 #include "gtkwidget.h"
40 #include "gtkwindow.h"
41 #include "gtkbindings.h"
42 #include "gtkprivate.h"
44 #include "gdk/gdkprivate.h" /* Used in gtk_reset_shapes_recurse to avoid copy */
45 #include <gobject/gvaluecollector.h>
46 #include <gobject/gobjectnotifyqueue.c>
47 #include "gdk/gdkkeysyms.h"
49 #include "gtkaccessible.h"
50 #include "gtktooltips.h"
52 #define WIDGET_CLASS(w) GTK_WIDGET_GET_CLASS (w)
53 #define INIT_PATH_SIZE (512)
95 PROPERTY_NOTIFY_EVENT,
96 SELECTION_CLEAR_EVENT,
97 SELECTION_REQUEST_EVENT,
98 SELECTION_NOTIFY_EVENT,
113 VISIBILITY_NOTIFY_EVENT,
135 PROP_RECEIVES_DEFAULT,
136 PROP_COMPOSITE_CHILD,
139 PROP_EXTENSION_EVENTS
142 typedef struct _GtkStateData GtkStateData;
147 guint state_restoration : 1;
148 guint parent_sensitive : 1;
149 guint use_forall : 1;
153 /* --- prototypes --- */
154 static void gtk_widget_class_init (GtkWidgetClass *klass);
155 static void gtk_widget_init (GtkWidget *widget);
156 static void gtk_widget_set_property (GObject *object,
160 static void gtk_widget_get_property (GObject *object,
164 static void gtk_widget_dispose (GObject *object);
165 static void gtk_widget_real_destroy (GtkObject *object);
166 static void gtk_widget_finalize (GObject *object);
167 static void gtk_widget_real_show (GtkWidget *widget);
168 static void gtk_widget_real_hide (GtkWidget *widget);
169 static void gtk_widget_real_map (GtkWidget *widget);
170 static void gtk_widget_real_unmap (GtkWidget *widget);
171 static void gtk_widget_real_realize (GtkWidget *widget);
172 static void gtk_widget_real_unrealize (GtkWidget *widget);
173 static void gtk_widget_real_size_request (GtkWidget *widget,
174 GtkRequisition *requisition);
175 static void gtk_widget_real_size_allocate (GtkWidget *widget,
176 GtkAllocation *allocation);
177 static void gtk_widget_style_set (GtkWidget *widget,
178 GtkStyle *previous_style);
179 static void gtk_widget_direction_changed (GtkWidget *widget,
180 GtkTextDirection previous_direction);
182 static void gtk_widget_real_grab_focus (GtkWidget *focus_widget);
183 static void gtk_widget_real_show_help (GtkWidget *widget,
184 GtkWidgetHelpType help_type);
186 static void gtk_widget_dispatch_child_properties_changed (GtkWidget *object,
188 GParamSpec **pspecs);
189 static gboolean gtk_widget_real_key_press_event (GtkWidget *widget,
191 static gboolean gtk_widget_real_key_release_event (GtkWidget *widget,
193 static gboolean gtk_widget_real_focus_in_event (GtkWidget *widget,
194 GdkEventFocus *event);
195 static gboolean gtk_widget_real_focus_out_event (GtkWidget *widget,
196 GdkEventFocus *event);
197 static gboolean gtk_widget_real_focus (GtkWidget *widget,
198 GtkDirectionType direction);
199 static GdkColormap* gtk_widget_peek_colormap (void);
200 static PangoContext* gtk_widget_peek_pango_context (GtkWidget *widget);
201 static void gtk_widget_reparent_container_child (GtkWidget *widget,
202 gpointer client_data);
203 static void gtk_widget_propagate_state (GtkWidget *widget,
205 static void gtk_widget_reset_rc_style (GtkWidget *widget);
206 static void gtk_widget_set_style_internal (GtkWidget *widget,
208 gboolean initial_emission);
209 static void gtk_widget_set_style_recurse (GtkWidget *widget,
210 gpointer client_data);
211 static gint gtk_widget_event_internal (GtkWidget *widget,
213 static gboolean gtk_widget_real_mnemonic_activate (GtkWidget *widget,
214 gboolean group_cycling);
215 static void gtk_widget_aux_info_destroy (GtkWidgetAuxInfo *aux_info);
216 static void gtk_widget_do_uposition (GtkWidget *widget);
217 static AtkObject* gtk_widget_real_get_accessible (GtkWidget *widget);
218 static void gtk_widget_accessible_interface_init (AtkImplementorIface *iface);
219 static AtkObject* gtk_widget_ref_accessible (AtkImplementor *implementor);
221 /* --- variables --- */
222 static gpointer parent_class = NULL;
223 static guint widget_signals[LAST_SIGNAL] = { 0 };
224 static GMemChunk *aux_info_mem_chunk = NULL;
225 static GdkColormap *default_colormap = NULL;
226 static GtkStyle *gtk_default_style = NULL;
227 static GSList *colormap_stack = NULL;
228 static guint composite_child_stack = 0;
229 static GtkTextDirection gtk_default_direction = GTK_TEXT_DIR_LTR;
230 static GParamSpecPool *style_property_spec_pool = NULL;
232 static GQuark quark_property_parser = 0;
233 static GQuark quark_aux_info = 0;
234 static GQuark quark_event_mask = 0;
235 static GQuark quark_extension_event_mode = 0;
236 static GQuark quark_parent_window = 0;
237 static GQuark quark_shape_info = 0;
238 static GQuark quark_colormap = 0;
239 static GQuark quark_pango_context = 0;
240 static GQuark quark_rc_style = 0;
241 static GQuark quark_accessible_object = 0;
242 GParamSpecPool *_gtk_widget_child_property_pool = NULL;
243 GObjectNotifyContext *_gtk_widget_child_property_notify_context = NULL;
245 /* --- functions --- */
247 gtk_widget_get_type (void)
249 static GtkType widget_type = 0;
253 static const GtkTypeInfo widget_info =
257 sizeof (GtkWidgetClass),
258 (GtkClassInitFunc) gtk_widget_class_init,
259 (GtkObjectInitFunc) gtk_widget_init,
260 /* reserved_1 */ NULL,
261 /* reserved_2 */ NULL,
262 (GtkClassInitFunc) NULL,
265 static const GInterfaceInfo accessibility_info =
267 (GInterfaceInitFunc) gtk_widget_accessible_interface_init,
268 (GInterfaceFinalizeFunc) NULL,
269 NULL /* interface data */
273 widget_type = gtk_type_unique (GTK_TYPE_OBJECT, &widget_info);
275 g_type_add_interface_static (widget_type, ATK_TYPE_IMPLEMENTOR,
276 &accessibility_info) ;
284 child_property_notify_dispatcher (GObject *object,
288 GTK_WIDGET_GET_CLASS (object)->dispatch_child_properties_changed (GTK_WIDGET (object), n_pspecs, pspecs);
292 gtk_widget_class_init (GtkWidgetClass *klass)
294 static GObjectNotifyContext cpn_context = { 0, NULL, NULL };
295 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
296 GtkObjectClass *object_class = GTK_OBJECT_CLASS (klass);
297 GtkBindingSet *binding_set;
299 parent_class = g_type_class_peek_parent (klass);
301 quark_property_parser = g_quark_from_static_string ("gtk-rc-property-parser");
302 quark_aux_info = g_quark_from_static_string ("gtk-aux-info");
303 quark_event_mask = g_quark_from_static_string ("gtk-event-mask");
304 quark_extension_event_mode = g_quark_from_static_string ("gtk-extension-event-mode");
305 quark_parent_window = g_quark_from_static_string ("gtk-parent-window");
306 quark_shape_info = g_quark_from_static_string ("gtk-shape-info");
307 quark_colormap = g_quark_from_static_string ("gtk-colormap");
308 quark_pango_context = g_quark_from_static_string ("gtk-pango-context");
309 quark_rc_style = g_quark_from_static_string ("gtk-rc-style");
310 quark_accessible_object = g_quark_from_static_string ("gtk-accessible-object");
312 style_property_spec_pool = g_param_spec_pool_new (FALSE);
313 _gtk_widget_child_property_pool = g_param_spec_pool_new (TRUE);
314 cpn_context.quark_notify_queue = g_quark_from_static_string ("GtkWidget-child-property-notify-queue");
315 cpn_context.dispatcher = child_property_notify_dispatcher;
316 _gtk_widget_child_property_notify_context = &cpn_context;
318 gobject_class->dispose = gtk_widget_dispose;
319 gobject_class->finalize = gtk_widget_finalize;
320 gobject_class->set_property = gtk_widget_set_property;
321 gobject_class->get_property = gtk_widget_get_property;
323 object_class->destroy = gtk_widget_real_destroy;
325 klass->activate_signal = 0;
326 klass->set_scroll_adjustments_signal = 0;
327 klass->dispatch_child_properties_changed = gtk_widget_dispatch_child_properties_changed;
328 klass->show = gtk_widget_real_show;
329 klass->show_all = gtk_widget_show;
330 klass->hide = gtk_widget_real_hide;
331 klass->hide_all = gtk_widget_hide;
332 klass->map = gtk_widget_real_map;
333 klass->unmap = gtk_widget_real_unmap;
334 klass->realize = gtk_widget_real_realize;
335 klass->unrealize = gtk_widget_real_unrealize;
336 klass->size_request = gtk_widget_real_size_request;
337 klass->size_allocate = gtk_widget_real_size_allocate;
338 klass->state_changed = NULL;
339 klass->parent_set = NULL;
340 klass->hierarchy_changed = NULL;
341 klass->style_set = gtk_widget_style_set;
342 klass->direction_changed = gtk_widget_direction_changed;
343 klass->grab_notify = NULL;
344 klass->child_notify = NULL;
345 klass->add_accelerator = (void*) gtk_accel_group_handle_add;
346 klass->remove_accelerator = (void*) gtk_accel_group_handle_remove;
347 klass->mnemonic_activate = gtk_widget_real_mnemonic_activate;
348 klass->grab_focus = gtk_widget_real_grab_focus;
349 klass->focus = gtk_widget_real_focus;
351 klass->button_press_event = NULL;
352 klass->button_release_event = NULL;
353 klass->motion_notify_event = NULL;
354 klass->delete_event = NULL;
355 klass->destroy_event = NULL;
356 klass->expose_event = NULL;
357 klass->key_press_event = gtk_widget_real_key_press_event;
358 klass->key_release_event = gtk_widget_real_key_release_event;
359 klass->enter_notify_event = NULL;
360 klass->leave_notify_event = NULL;
361 klass->configure_event = NULL;
362 klass->focus_in_event = gtk_widget_real_focus_in_event;
363 klass->focus_out_event = gtk_widget_real_focus_out_event;
364 klass->map_event = NULL;
365 klass->unmap_event = NULL;
366 klass->window_state_event = NULL;
367 klass->property_notify_event = gtk_selection_property_notify;
368 klass->selection_clear_event = gtk_selection_clear;
369 klass->selection_request_event = gtk_selection_request;
370 klass->selection_notify_event = gtk_selection_notify;
371 klass->selection_received = NULL;
372 klass->proximity_in_event = NULL;
373 klass->proximity_out_event = NULL;
374 klass->drag_begin = NULL;
375 klass->drag_end = NULL;
376 klass->drag_data_delete = NULL;
377 klass->drag_leave = NULL;
378 klass->drag_motion = NULL;
379 klass->drag_drop = NULL;
380 klass->drag_data_received = NULL;
382 klass->show_help = gtk_widget_real_show_help;
384 /* Accessibility support */
385 klass->get_accessible = gtk_widget_real_get_accessible;
387 klass->no_expose_event = NULL;
389 g_object_class_install_property (gobject_class,
391 g_param_spec_string ("name",
393 _("The name of the widget"),
396 g_object_class_install_property (gobject_class,
398 g_param_spec_object ("parent",
400 _("The parent widget of this widget. Must be a Container widget."),
403 g_object_class_install_property (gobject_class,
405 g_param_spec_int ("x",
407 _("The x 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 ("y",
416 _("The y coordinate of the top-left corner of the widget, or -1 if not set"),
421 g_object_class_install_property (gobject_class,
423 g_param_spec_int ("width",
425 _("The width of the widget, or -1 if unset."),
430 g_object_class_install_property (gobject_class,
432 g_param_spec_int ("height",
434 _("The height of the widget, or -1 if unset."),
439 g_object_class_install_property (gobject_class,
441 g_param_spec_boolean ("visible",
443 _("Whether the widget is visible"),
446 g_object_class_install_property (gobject_class,
448 g_param_spec_boolean ("sensitive",
450 _("Whether the widget responds to input"),
453 g_object_class_install_property (gobject_class,
455 g_param_spec_boolean ("app_paintable",
456 _("Application paintable"),
457 _("Whether the application will paint directly on the widget"),
460 g_object_class_install_property (gobject_class,
462 g_param_spec_boolean ("can_focus",
464 _("Whether the widget can accept the input focus"),
467 g_object_class_install_property (gobject_class,
469 g_param_spec_boolean ("has_focus",
471 _("Whether the widget has the input focus"),
474 g_object_class_install_property (gobject_class,
476 g_param_spec_boolean ("can_default",
478 _("Whether the widget can be the default widget"),
481 g_object_class_install_property (gobject_class,
483 g_param_spec_boolean ("has_default",
485 _("Whether the widget is the default widget"),
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."),
495 g_object_class_install_property (gobject_class,
496 PROP_COMPOSITE_CHILD,
497 g_param_spec_boolean ("composite_child",
498 _("Composite child"),
499 _("Whether the widget is composed of other widgets"),
502 g_object_class_install_property (gobject_class,
504 g_param_spec_object ("style",
506 _("The style of the widget, which contains information about how it will look (colors etc)."),
509 g_object_class_install_property (gobject_class,
511 g_param_spec_flags ("events",
513 _("The event mask that decides what kind of GdkEvents this widget gets."),
517 g_object_class_install_property (gobject_class,
518 PROP_EXTENSION_EVENTS,
519 g_param_spec_enum ("extension_events",
520 _("Extension events"),
521 _("The mask that decides what kind of extension events this widget gets."),
522 GDK_TYPE_EXTENSION_MODE,
523 GDK_EXTENSION_EVENTS_NONE,
525 widget_signals[SHOW] =
526 gtk_signal_new ("show",
528 GTK_CLASS_TYPE (object_class),
529 GTK_SIGNAL_OFFSET (GtkWidgetClass, show),
530 gtk_marshal_VOID__VOID,
532 widget_signals[HIDE] =
533 gtk_signal_new ("hide",
535 GTK_CLASS_TYPE (object_class),
536 GTK_SIGNAL_OFFSET (GtkWidgetClass, hide),
537 gtk_marshal_VOID__VOID,
539 widget_signals[MAP] =
540 gtk_signal_new ("map",
542 GTK_CLASS_TYPE (object_class),
543 GTK_SIGNAL_OFFSET (GtkWidgetClass, map),
544 gtk_marshal_VOID__VOID,
546 widget_signals[UNMAP] =
547 gtk_signal_new ("unmap",
549 GTK_CLASS_TYPE (object_class),
550 GTK_SIGNAL_OFFSET (GtkWidgetClass, unmap),
551 gtk_marshal_VOID__VOID,
553 widget_signals[REALIZE] =
554 gtk_signal_new ("realize",
556 GTK_CLASS_TYPE (object_class),
557 GTK_SIGNAL_OFFSET (GtkWidgetClass, realize),
558 gtk_marshal_VOID__VOID,
560 widget_signals[UNREALIZE] =
561 gtk_signal_new ("unrealize",
563 GTK_CLASS_TYPE (object_class),
564 GTK_SIGNAL_OFFSET (GtkWidgetClass, unrealize),
565 gtk_marshal_VOID__VOID,
567 widget_signals[SIZE_REQUEST] =
568 g_signal_new ("size_request",
569 G_OBJECT_CLASS_TYPE (object_class),
571 G_STRUCT_OFFSET (GtkWidgetClass, size_request),
573 gtk_marshal_VOID__BOXED,
575 GTK_TYPE_REQUISITION | G_SIGNAL_TYPE_STATIC_SCOPE);
576 widget_signals[SIZE_ALLOCATE] =
577 gtk_signal_new ("size_allocate",
579 GTK_CLASS_TYPE (object_class),
580 GTK_SIGNAL_OFFSET (GtkWidgetClass, size_allocate),
581 gtk_marshal_VOID__BOXED,
583 GDK_TYPE_RECTANGLE | G_SIGNAL_TYPE_STATIC_SCOPE);
584 widget_signals[STATE_CHANGED] =
585 gtk_signal_new ("state_changed",
587 GTK_CLASS_TYPE (object_class),
588 GTK_SIGNAL_OFFSET (GtkWidgetClass, state_changed),
589 gtk_marshal_VOID__ENUM,
591 GTK_TYPE_STATE_TYPE);
592 widget_signals[PARENT_SET] =
593 gtk_signal_new ("parent_set",
595 GTK_CLASS_TYPE (object_class),
596 GTK_SIGNAL_OFFSET (GtkWidgetClass, parent_set),
597 gtk_marshal_VOID__OBJECT,
600 widget_signals[HIERARCHY_CHANGED] =
601 gtk_signal_new ("hierarchy_changed",
603 GTK_CLASS_TYPE (object_class),
604 GTK_SIGNAL_OFFSET (GtkWidgetClass, hierarchy_changed),
605 gtk_marshal_VOID__OBJECT,
608 widget_signals[STYLE_SET] =
609 gtk_signal_new ("style_set",
611 GTK_CLASS_TYPE (object_class),
612 GTK_SIGNAL_OFFSET (GtkWidgetClass, style_set),
613 gtk_marshal_VOID__OBJECT,
616 widget_signals[DIRECTION_CHANGED] =
617 gtk_signal_new ("direction_changed",
619 GTK_CLASS_TYPE (object_class),
620 GTK_SIGNAL_OFFSET (GtkWidgetClass, direction_changed),
621 gtk_marshal_VOID__ENUM,
623 GTK_TYPE_TEXT_DIRECTION);
624 widget_signals[GRAB_NOTIFY] =
625 gtk_signal_new ("grab_notify",
627 GTK_CLASS_TYPE (object_class),
628 GTK_SIGNAL_OFFSET (GtkWidgetClass, grab_notify),
629 gtk_marshal_VOID__BOOLEAN,
632 widget_signals[CHILD_NOTIFY] =
633 g_signal_new ("child_notify",
634 G_TYPE_FROM_CLASS (klass),
635 G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE | G_SIGNAL_DETAILED | G_SIGNAL_NO_HOOKS,
636 G_STRUCT_OFFSET (GtkWidgetClass, child_notify),
638 g_cclosure_marshal_VOID__PARAM,
641 widget_signals[ADD_ACCELERATOR] =
642 gtk_accel_group_create_add (GTK_CLASS_TYPE (object_class), GTK_RUN_LAST,
643 GTK_SIGNAL_OFFSET (GtkWidgetClass, add_accelerator));
644 widget_signals[REMOVE_ACCELERATOR] =
645 gtk_accel_group_create_remove (GTK_CLASS_TYPE (object_class), GTK_RUN_LAST,
646 GTK_SIGNAL_OFFSET (GtkWidgetClass, remove_accelerator));
647 widget_signals[ACTIVATE_MNEMONIC] =
648 g_signal_new ("mnemonic_activate",
649 GTK_CLASS_TYPE (object_class),
651 GTK_SIGNAL_OFFSET (GtkWidgetClass, mnemonic_activate),
652 _gtk_boolean_handled_accumulator, NULL,
653 gtk_marshal_BOOLEAN__BOOLEAN,
656 widget_signals[GRAB_FOCUS] =
657 gtk_signal_new ("grab_focus",
658 GTK_RUN_LAST | GTK_RUN_ACTION,
659 GTK_CLASS_TYPE (object_class),
660 GTK_SIGNAL_OFFSET (GtkWidgetClass, grab_focus),
661 gtk_marshal_VOID__VOID,
663 widget_signals[FOCUS] =
664 g_signal_new ("focus",
665 G_TYPE_FROM_CLASS (object_class),
667 G_STRUCT_OFFSET (GtkWidgetClass, focus),
668 _gtk_boolean_handled_accumulator, NULL,
669 gtk_marshal_BOOLEAN__ENUM,
671 GTK_TYPE_DIRECTION_TYPE);
672 widget_signals[EVENT] =
673 g_signal_new ("event",
674 G_TYPE_FROM_CLASS (object_class),
676 G_STRUCT_OFFSET(GtkWidgetClass, event),
677 _gtk_boolean_handled_accumulator, NULL,
678 gtk_marshal_BOOLEAN__BOXED,
681 widget_signals[EVENT_AFTER] =
682 g_signal_new ("event-after",
683 G_TYPE_FROM_CLASS (object_class),
687 gtk_marshal_VOID__BOXED,
688 G_TYPE_NONE, 1, GDK_TYPE_EVENT);
689 widget_signals[BUTTON_PRESS_EVENT] =
690 g_signal_new ("button_press_event",
691 G_TYPE_FROM_CLASS (object_class),
693 G_STRUCT_OFFSET(GtkWidgetClass, button_press_event),
694 _gtk_boolean_handled_accumulator, NULL,
695 gtk_marshal_BOOLEAN__BOXED,
698 widget_signals[BUTTON_RELEASE_EVENT] =
699 g_signal_new ("button_release_event",
700 G_TYPE_FROM_CLASS(object_class),
702 G_STRUCT_OFFSET(GtkWidgetClass, button_release_event),
703 _gtk_boolean_handled_accumulator, NULL,
704 gtk_marshal_BOOLEAN__BOXED,
707 widget_signals[SCROLL_EVENT] =
708 g_signal_new ("scroll_event",
709 G_TYPE_FROM_CLASS(object_class),
711 G_STRUCT_OFFSET(GtkWidgetClass, scroll_event),
712 _gtk_boolean_handled_accumulator, NULL,
713 gtk_marshal_BOOLEAN__BOXED,
716 widget_signals[MOTION_NOTIFY_EVENT] =
717 g_signal_new ("motion_notify_event",
718 G_TYPE_FROM_CLASS(object_class),
720 G_STRUCT_OFFSET(GtkWidgetClass, motion_notify_event),
721 _gtk_boolean_handled_accumulator, NULL,
722 gtk_marshal_BOOLEAN__BOXED,
725 widget_signals[DELETE_EVENT] =
726 g_signal_new ("delete_event",
727 G_TYPE_FROM_CLASS(object_class),
729 G_STRUCT_OFFSET(GtkWidgetClass, delete_event),
730 _gtk_boolean_handled_accumulator, NULL,
731 gtk_marshal_BOOLEAN__BOXED,
734 widget_signals[DESTROY_EVENT] =
735 g_signal_new ("destroy_event",
736 G_TYPE_FROM_CLASS(object_class),
738 G_STRUCT_OFFSET(GtkWidgetClass, destroy_event),
739 _gtk_boolean_handled_accumulator, NULL,
740 gtk_marshal_BOOLEAN__BOXED,
743 widget_signals[EXPOSE_EVENT] =
744 g_signal_new ("expose_event",
745 G_TYPE_FROM_CLASS(object_class),
747 G_STRUCT_OFFSET(GtkWidgetClass, expose_event),
748 _gtk_boolean_handled_accumulator, NULL,
749 gtk_marshal_BOOLEAN__BOXED,
752 widget_signals[KEY_PRESS_EVENT] =
753 g_signal_new ("key_press_event",
754 G_TYPE_FROM_CLASS(object_class),
756 G_STRUCT_OFFSET(GtkWidgetClass, key_press_event),
757 _gtk_boolean_handled_accumulator, NULL,
758 gtk_marshal_BOOLEAN__BOXED,
761 widget_signals[KEY_RELEASE_EVENT] =
762 g_signal_new ("key_release_event",
763 G_TYPE_FROM_CLASS(object_class),
765 G_STRUCT_OFFSET(GtkWidgetClass, key_release_event),
766 _gtk_boolean_handled_accumulator, NULL,
767 gtk_marshal_BOOLEAN__BOXED,
770 widget_signals[ENTER_NOTIFY_EVENT] =
771 g_signal_new ("enter_notify_event",
772 G_TYPE_FROM_CLASS(object_class),
774 G_STRUCT_OFFSET(GtkWidgetClass, enter_notify_event),
775 _gtk_boolean_handled_accumulator, NULL,
776 gtk_marshal_BOOLEAN__BOXED,
779 widget_signals[LEAVE_NOTIFY_EVENT] =
780 g_signal_new ("leave_notify_event",
781 G_TYPE_FROM_CLASS(object_class),
783 G_STRUCT_OFFSET(GtkWidgetClass, leave_notify_event),
784 _gtk_boolean_handled_accumulator, NULL,
785 gtk_marshal_BOOLEAN__BOXED,
788 widget_signals[CONFIGURE_EVENT] =
789 g_signal_new ("configure_event",
790 G_TYPE_FROM_CLASS(object_class),
792 G_STRUCT_OFFSET(GtkWidgetClass, configure_event),
793 _gtk_boolean_handled_accumulator, NULL,
794 gtk_marshal_BOOLEAN__BOXED,
797 widget_signals[FOCUS_IN_EVENT] =
798 g_signal_new ("focus_in_event",
799 G_TYPE_FROM_CLASS(object_class),
801 G_STRUCT_OFFSET(GtkWidgetClass, focus_in_event),
802 _gtk_boolean_handled_accumulator, NULL,
803 gtk_marshal_BOOLEAN__BOXED,
806 widget_signals[FOCUS_OUT_EVENT] =
807 g_signal_new ("focus_out_event",
808 G_TYPE_FROM_CLASS(object_class),
810 G_STRUCT_OFFSET(GtkWidgetClass, focus_out_event),
811 _gtk_boolean_handled_accumulator, NULL,
812 gtk_marshal_BOOLEAN__BOXED,
815 widget_signals[MAP_EVENT] =
816 g_signal_new ("map_event",
817 G_TYPE_FROM_CLASS(object_class),
819 G_STRUCT_OFFSET(GtkWidgetClass, map_event),
820 _gtk_boolean_handled_accumulator, NULL,
821 gtk_marshal_BOOLEAN__BOXED,
824 widget_signals[UNMAP_EVENT] =
825 g_signal_new ("unmap_event",
826 G_TYPE_FROM_CLASS(object_class),
828 G_STRUCT_OFFSET(GtkWidgetClass, unmap_event),
829 _gtk_boolean_handled_accumulator, NULL,
830 gtk_marshal_BOOLEAN__BOXED,
833 widget_signals[PROPERTY_NOTIFY_EVENT] =
834 g_signal_new ("property_notify_event",
835 G_TYPE_FROM_CLASS(object_class),
837 G_STRUCT_OFFSET(GtkWidgetClass, property_notify_event),
838 _gtk_boolean_handled_accumulator, NULL,
839 gtk_marshal_BOOLEAN__BOXED,
842 widget_signals[SELECTION_CLEAR_EVENT] =
843 g_signal_new ("selection_clear_event",
844 G_TYPE_FROM_CLASS(object_class),
846 G_STRUCT_OFFSET(GtkWidgetClass, selection_clear_event),
847 _gtk_boolean_handled_accumulator, NULL,
848 gtk_marshal_BOOLEAN__BOXED,
851 widget_signals[SELECTION_REQUEST_EVENT] =
852 g_signal_new ("selection_request_event",
853 G_TYPE_FROM_CLASS(object_class),
855 G_STRUCT_OFFSET(GtkWidgetClass, selection_request_event),
856 _gtk_boolean_handled_accumulator, NULL,
857 gtk_marshal_BOOLEAN__BOXED,
860 widget_signals[SELECTION_NOTIFY_EVENT] =
861 g_signal_new ("selection_notify_event",
862 G_TYPE_FROM_CLASS(object_class),
864 G_STRUCT_OFFSET(GtkWidgetClass, selection_notify_event),
865 _gtk_boolean_handled_accumulator, NULL,
866 gtk_marshal_BOOLEAN__BOXED,
869 widget_signals[SELECTION_RECEIVED] =
870 g_signal_new ("selection_received",
871 G_TYPE_FROM_CLASS (object_class),
873 G_STRUCT_OFFSET (GtkWidgetClass, selection_received),
875 gtk_marshal_VOID__BOXED_UINT,
877 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
879 widget_signals[SELECTION_GET] =
880 g_signal_new ("selection_get",
881 G_TYPE_FROM_CLASS (object_class),
883 G_STRUCT_OFFSET (GtkWidgetClass, selection_get),
885 gtk_marshal_VOID__BOXED_UINT_UINT,
887 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
890 widget_signals[PROXIMITY_IN_EVENT] =
891 g_signal_new ("proximity_in_event",
892 G_TYPE_FROM_CLASS (object_class),
894 G_STRUCT_OFFSET(GtkWidgetClass, proximity_in_event),
895 _gtk_boolean_handled_accumulator, NULL,
896 gtk_marshal_BOOLEAN__BOXED,
899 widget_signals[PROXIMITY_OUT_EVENT] =
900 g_signal_new ("proximity_out_event",
901 G_TYPE_FROM_CLASS(object_class),
903 G_STRUCT_OFFSET(GtkWidgetClass, proximity_out_event),
904 _gtk_boolean_handled_accumulator, NULL,
905 gtk_marshal_BOOLEAN__BOXED,
908 widget_signals[DRAG_LEAVE] =
909 gtk_signal_new ("drag_leave",
911 GTK_CLASS_TYPE (object_class),
912 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_leave),
913 gtk_marshal_VOID__OBJECT_UINT,
915 GDK_TYPE_DRAG_CONTEXT,
917 widget_signals[DRAG_BEGIN] =
918 gtk_signal_new ("drag_begin",
920 GTK_CLASS_TYPE (object_class),
921 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_begin),
922 gtk_marshal_VOID__OBJECT,
924 GDK_TYPE_DRAG_CONTEXT);
925 widget_signals[DRAG_END] =
926 gtk_signal_new ("drag_end",
928 GTK_CLASS_TYPE (object_class),
929 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_end),
930 gtk_marshal_VOID__OBJECT,
932 GDK_TYPE_DRAG_CONTEXT);
933 widget_signals[DRAG_DATA_DELETE] =
934 gtk_signal_new ("drag_data_delete",
936 GTK_CLASS_TYPE (object_class),
937 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_data_delete),
938 gtk_marshal_VOID__OBJECT,
940 GDK_TYPE_DRAG_CONTEXT);
941 widget_signals[DRAG_MOTION] =
942 g_signal_new ("drag_motion",
943 G_TYPE_FROM_CLASS(object_class),
945 G_STRUCT_OFFSET(GtkWidgetClass, drag_motion),
946 _gtk_boolean_handled_accumulator, NULL,
947 gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
949 GDK_TYPE_DRAG_CONTEXT,
953 widget_signals[DRAG_DROP] =
954 g_signal_new ("drag_drop",
955 G_TYPE_FROM_CLASS(object_class),
957 G_STRUCT_OFFSET(GtkWidgetClass, drag_drop),
958 _gtk_boolean_handled_accumulator, NULL,
959 gtk_marshal_BOOLEAN__OBJECT_INT_INT_UINT,
961 GDK_TYPE_DRAG_CONTEXT,
965 widget_signals[DRAG_DATA_GET] =
966 g_signal_new ("drag_data_get",
967 G_TYPE_FROM_CLASS (object_class),
969 G_STRUCT_OFFSET (GtkWidgetClass, drag_data_get),
971 gtk_marshal_VOID__OBJECT_BOXED_UINT_UINT,
973 GDK_TYPE_DRAG_CONTEXT,
974 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
977 widget_signals[DRAG_DATA_RECEIVED] =
978 g_signal_new ("drag_data_received",
979 G_TYPE_FROM_CLASS (object_class),
981 GTK_SIGNAL_OFFSET (GtkWidgetClass, drag_data_received),
983 gtk_marshal_VOID__OBJECT_INT_INT_BOXED_UINT_UINT,
985 GDK_TYPE_DRAG_CONTEXT,
988 GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
991 widget_signals[VISIBILITY_NOTIFY_EVENT] =
992 g_signal_new ("visibility_notify_event",
993 G_TYPE_FROM_CLASS(object_class),
995 G_STRUCT_OFFSET(GtkWidgetClass, visibility_notify_event),
996 _gtk_boolean_handled_accumulator, NULL,
997 gtk_marshal_BOOLEAN__BOXED,
1000 widget_signals[CLIENT_EVENT] =
1001 g_signal_new ("client_event",
1002 G_TYPE_FROM_CLASS(object_class),
1004 G_STRUCT_OFFSET(GtkWidgetClass, client_event),
1005 _gtk_boolean_handled_accumulator, NULL,
1006 gtk_marshal_BOOLEAN__BOXED,
1009 widget_signals[NO_EXPOSE_EVENT] =
1010 g_signal_new ("no_expose_event",
1011 G_TYPE_FROM_CLASS(object_class),
1013 G_STRUCT_OFFSET(GtkWidgetClass, no_expose_event),
1014 _gtk_boolean_handled_accumulator, NULL,
1015 gtk_marshal_BOOLEAN__BOXED,
1018 widget_signals[WINDOW_STATE_EVENT] =
1019 g_signal_new ("window_state_event",
1020 G_TYPE_FROM_CLASS(object_class),
1022 G_STRUCT_OFFSET(GtkWidgetClass, window_state_event),
1023 _gtk_boolean_handled_accumulator, NULL,
1024 gtk_marshal_BOOLEAN__BOXED,
1027 widget_signals[POPUP_MENU] =
1028 gtk_signal_new ("popup_menu",
1029 GTK_RUN_LAST | GTK_RUN_ACTION,
1030 GTK_CLASS_TYPE (object_class),
1031 GTK_SIGNAL_OFFSET (GtkWidgetClass, popup_menu),
1032 gtk_marshal_NONE__NONE,
1034 widget_signals[SHOW_HELP] =
1035 gtk_signal_new ("show_help",
1036 GTK_RUN_LAST | GTK_RUN_ACTION,
1037 GTK_CLASS_TYPE (object_class),
1038 GTK_SIGNAL_OFFSET (GtkWidgetClass, show_help),
1039 gtk_marshal_NONE__ENUM,
1040 GTK_TYPE_NONE, 1, GTK_TYPE_WIDGET_HELP_TYPE);
1042 binding_set = gtk_binding_set_by_class (klass);
1043 gtk_binding_entry_add_signal (binding_set, GDK_F10, GDK_SHIFT_MASK,
1045 gtk_binding_entry_add_signal (binding_set, GDK_Menu, 0,
1048 gtk_binding_entry_add_signal (binding_set, GDK_F1, GDK_CONTROL_MASK,
1050 GTK_TYPE_WIDGET_HELP_TYPE,
1051 GTK_WIDGET_HELP_TOOLTIP);
1052 gtk_binding_entry_add_signal (binding_set, GDK_KP_F1, GDK_CONTROL_MASK,
1054 GTK_TYPE_WIDGET_HELP_TYPE,
1055 GTK_WIDGET_HELP_TOOLTIP);
1057 gtk_binding_entry_add_signal (binding_set, GDK_F1, GDK_SHIFT_MASK,
1059 GTK_TYPE_WIDGET_HELP_TYPE,
1060 GTK_WIDGET_HELP_WHATS_THIS);
1061 gtk_binding_entry_add_signal (binding_set, GDK_KP_F1, GDK_SHIFT_MASK,
1063 GTK_TYPE_WIDGET_HELP_TYPE,
1064 GTK_WIDGET_HELP_WHATS_THIS);
1066 gtk_widget_class_install_style_property (klass,
1067 g_param_spec_boolean ("interior_focus",
1068 _("Interior Focus"),
1069 _("Whether to draw the focus indicator inside widgets."),
1075 gtk_widget_set_property (GObject *object,
1077 const GValue *value,
1081 GtkWidgetAuxInfo *aux_info;
1083 widget = GTK_WIDGET (object);
1087 guint32 saved_flags;
1090 gtk_widget_set_name (widget, g_value_get_string (value));
1093 gtk_container_add (GTK_CONTAINER (g_value_get_object (value)), widget);
1096 aux_info = _gtk_widget_get_aux_info (widget, TRUE);
1097 if (g_value_get_int (value) == -1)
1098 aux_info->x_set = FALSE;
1101 aux_info->x_set = TRUE;
1102 aux_info->x = g_value_get_int (value);
1104 gtk_widget_do_uposition (widget);
1107 aux_info = _gtk_widget_get_aux_info (widget, TRUE);
1108 if (g_value_get_int (value) == -1)
1109 aux_info->y_set = FALSE;
1112 aux_info->y_set = TRUE;
1113 aux_info->y = g_value_get_int (value);
1115 gtk_widget_do_uposition (widget);
1118 gtk_widget_set_usize (widget, g_value_get_int (value), -2);
1121 gtk_widget_set_usize (widget, -2, g_value_get_int (value));
1124 if (g_value_get_boolean (value))
1125 gtk_widget_show (widget);
1127 gtk_widget_hide (widget);
1129 case PROP_SENSITIVE:
1130 gtk_widget_set_sensitive (widget, g_value_get_boolean (value));
1132 case PROP_APP_PAINTABLE:
1133 gtk_widget_set_app_paintable (widget, g_value_get_boolean (value));
1135 case PROP_CAN_FOCUS:
1136 saved_flags = GTK_WIDGET_FLAGS (widget);
1137 if (g_value_get_boolean (value))
1138 GTK_WIDGET_SET_FLAGS (widget, GTK_CAN_FOCUS);
1140 GTK_WIDGET_UNSET_FLAGS (widget, GTK_CAN_FOCUS);
1141 if (saved_flags != GTK_WIDGET_FLAGS (widget))
1142 gtk_widget_queue_resize (widget);
1144 case PROP_HAS_FOCUS:
1145 if (g_value_get_boolean (value))
1146 gtk_widget_grab_focus (widget);
1148 case PROP_CAN_DEFAULT:
1149 saved_flags = GTK_WIDGET_FLAGS (widget);
1150 if (g_value_get_boolean (value))
1151 GTK_WIDGET_SET_FLAGS (widget, GTK_CAN_DEFAULT);
1153 GTK_WIDGET_UNSET_FLAGS (widget, GTK_CAN_DEFAULT);
1154 if (saved_flags != GTK_WIDGET_FLAGS (widget))
1155 gtk_widget_queue_resize (widget);
1157 case PROP_HAS_DEFAULT:
1158 if (g_value_get_boolean (value))
1159 gtk_widget_grab_default (widget);
1161 case PROP_RECEIVES_DEFAULT:
1162 if (g_value_get_boolean (value))
1163 GTK_WIDGET_SET_FLAGS (widget, GTK_RECEIVES_DEFAULT);
1165 GTK_WIDGET_UNSET_FLAGS (widget, GTK_RECEIVES_DEFAULT);
1168 gtk_widget_set_style (widget, g_value_get_object (value));
1171 if (!GTK_WIDGET_REALIZED (widget) && !GTK_WIDGET_NO_WINDOW (widget))
1172 gtk_widget_set_events (widget, g_value_get_flags (value));
1174 case PROP_EXTENSION_EVENTS:
1175 gtk_widget_set_extension_events (widget, g_value_get_enum (value));
1183 gtk_widget_get_property (GObject *object,
1190 widget = GTK_WIDGET (object);
1194 GtkWidgetAuxInfo *aux_info;
1196 GdkExtensionMode *modep;
1200 g_value_set_string (value, widget->name);
1202 g_value_set_string (value, "");
1206 g_value_set_object (value, G_OBJECT (widget->parent));
1208 g_value_set_object (value, NULL);
1211 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
1212 if (!aux_info || !aux_info->x_set)
1213 g_value_set_int (value, -1);
1215 g_value_set_int (value, aux_info->x);
1218 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
1219 if (!aux_info || !aux_info->y_set)
1220 g_value_set_int (value, -1);
1222 g_value_set_int (value, aux_info->y);
1225 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
1227 g_value_set_int (value, -1);
1229 g_value_set_int (value, aux_info->width);
1232 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
1234 g_value_set_int (value, -1);
1236 g_value_set_int (value, aux_info->height);
1239 g_value_set_boolean (value, (GTK_WIDGET_VISIBLE (widget) != FALSE));
1241 case PROP_SENSITIVE:
1242 g_value_set_boolean (value, (GTK_WIDGET_SENSITIVE (widget) != FALSE));
1244 case PROP_APP_PAINTABLE:
1245 g_value_set_boolean (value, (GTK_WIDGET_APP_PAINTABLE (widget) != FALSE));
1247 case PROP_CAN_FOCUS:
1248 g_value_set_boolean (value, (GTK_WIDGET_CAN_FOCUS (widget) != FALSE));
1250 case PROP_HAS_FOCUS:
1251 g_value_set_boolean (value, (GTK_WIDGET_HAS_FOCUS (widget) != FALSE));
1253 case PROP_CAN_DEFAULT:
1254 g_value_set_boolean (value, (GTK_WIDGET_CAN_DEFAULT (widget) != FALSE));
1256 case PROP_HAS_DEFAULT:
1257 g_value_set_boolean (value, (GTK_WIDGET_HAS_DEFAULT (widget) != FALSE));
1259 case PROP_RECEIVES_DEFAULT:
1260 g_value_set_boolean (value, (GTK_WIDGET_RECEIVES_DEFAULT (widget) != FALSE));
1262 case PROP_COMPOSITE_CHILD:
1263 g_value_set_boolean (value, (GTK_WIDGET_COMPOSITE_CHILD (widget) != FALSE));
1266 g_value_set_object (value, G_OBJECT (gtk_widget_get_style (widget)));
1269 eventp = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_event_mask);
1271 g_value_set_flags (value, 0);
1273 g_value_set_flags (value, *eventp);
1275 case PROP_EXTENSION_EVENTS:
1276 modep = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_extension_event_mode);
1278 g_value_set_enum (value, 0);
1280 g_value_set_enum (value, (GdkExtensionMode) *modep);
1283 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1289 gtk_widget_init (GtkWidget *widget)
1291 GdkColormap *colormap;
1293 GTK_PRIVATE_FLAGS (widget) = 0;
1294 widget->state = GTK_STATE_NORMAL;
1295 widget->saved_state = GTK_STATE_NORMAL;
1296 widget->name = NULL;
1297 widget->requisition.width = 0;
1298 widget->requisition.height = 0;
1299 widget->allocation.x = -1;
1300 widget->allocation.y = -1;
1301 widget->allocation.width = 1;
1302 widget->allocation.height = 1;
1303 widget->window = NULL;
1304 widget->parent = NULL;
1306 GTK_WIDGET_SET_FLAGS (widget,
1308 GTK_PARENT_SENSITIVE |
1309 (composite_child_stack ? GTK_COMPOSITE_CHILD : 0) |
1310 GTK_DOUBLE_BUFFERED);
1312 widget->style = gtk_widget_get_default_style ();
1313 gtk_style_ref (widget->style);
1315 colormap = gtk_widget_peek_colormap ();
1317 if (colormap != gtk_widget_get_default_colormap ())
1318 gtk_widget_set_colormap (widget, colormap);
1323 gtk_widget_dispatch_child_properties_changed (GtkWidget *widget,
1325 GParamSpec **pspecs)
1327 GtkWidget *container = widget->parent;
1330 for (i = 0; widget->parent == container && i < n_pspecs; i++)
1331 g_signal_emit (widget, widget_signals[CHILD_NOTIFY], g_quark_from_string (pspecs[i]->name), pspecs[i]);
1335 gtk_widget_freeze_child_notify (GtkWidget *widget)
1337 g_return_if_fail (GTK_IS_WIDGET (widget));
1339 if (!G_OBJECT (widget)->ref_count)
1342 g_object_ref (widget);
1343 g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
1344 g_object_unref (widget);
1348 gtk_widget_child_notify (GtkWidget *widget,
1349 const gchar *child_property)
1353 g_return_if_fail (GTK_IS_WIDGET (widget));
1354 g_return_if_fail (child_property != NULL);
1355 if (!G_OBJECT (widget)->ref_count || !widget->parent)
1358 g_object_ref (widget);
1359 pspec = g_param_spec_pool_lookup (_gtk_widget_child_property_pool,
1361 G_OBJECT_TYPE (widget->parent),
1364 g_warning ("%s: container class `%s' has no child property named `%s'",
1366 G_OBJECT_TYPE_NAME (widget->parent),
1370 GObjectNotifyQueue *nqueue = g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
1372 g_object_notify_queue_add (G_OBJECT (widget), nqueue, pspec);
1373 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
1375 g_object_unref (widget);
1379 gtk_widget_thaw_child_notify (GtkWidget *widget)
1381 GObjectNotifyQueue *nqueue;
1383 g_return_if_fail (GTK_IS_WIDGET (widget));
1385 if (!G_OBJECT (widget)->ref_count)
1388 g_object_ref (widget);
1389 nqueue = g_object_notify_queue_from_object (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
1390 if (!nqueue || !nqueue->freeze_count)
1391 g_warning (G_STRLOC ": child-property-changed notification for %s(%p) is not frozen",
1392 G_OBJECT_TYPE_NAME (widget), widget);
1394 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
1395 g_object_unref (widget);
1401 * @type: type ID of the widget to create
1402 * @first_property_name: name of first property to set
1403 * @Varargs: value of first property, followed by more properties, NULL-terminated
1405 * This is a convenience function for creating a widget and setting
1406 * its properties in one go. For example you might write:
1407 * gtk_widget_new (GTK_TYPE_LABEL, "label", "Hello World", "xalign",
1408 * 0.0, NULL) to create a left-aligned label. Equivalent to
1409 * gtk_object_new(), but returns a widget so you don't have to
1410 * cast the object yourself.
1412 * Return value: a new #GtkWidget of type @widget_type
1415 gtk_widget_new (GtkType type,
1416 const gchar *first_property_name,
1422 g_return_val_if_fail (gtk_type_is_a (type, GTK_TYPE_WIDGET), NULL);
1424 va_start (var_args, first_property_name);
1425 widget = g_object_new_valist (type, first_property_name, var_args);
1433 * @widget: a #GtkWidget
1434 * @first_property_name: name of first property to set
1435 * @Varargs: value of first property, followed by more properties, NULL-terminated
1437 * Like gtk_object_set() - there's no reason to use this instead of
1441 gtk_widget_set (GtkWidget *widget,
1442 const gchar *first_property_name,
1447 g_return_if_fail (GTK_IS_WIDGET (widget));
1449 va_start (var_args, first_property_name);
1450 g_object_set_valist (G_OBJECT (widget), first_property_name, var_args);
1455 gtk_widget_queue_clear_child (GtkWidget *widget)
1459 parent = widget->parent;
1460 if (parent && GTK_WIDGET_DRAWABLE (parent))
1461 gtk_widget_queue_clear_area (parent,
1462 widget->allocation.x,
1463 widget->allocation.y,
1464 widget->allocation.width,
1465 widget->allocation.height);
1469 * gtk_widget_unparent:
1470 * @widget: a #GtkWidget
1472 * This function is only for use in widget implementations.
1473 * Should be called by implementations of the remove method
1474 * on #GtkContainer, to dissociate a child from the container.
1477 gtk_widget_unparent (GtkWidget *widget)
1479 GObjectNotifyQueue *nqueue;
1480 GtkWidget *toplevel;
1481 GtkWidget *ancestor;
1482 GtkWidget *old_parent;
1484 g_return_if_fail (widget != NULL);
1485 g_return_if_fail (GTK_IS_WIDGET (widget));
1486 if (widget->parent == NULL)
1489 /* keep this function in sync with gtk_menu_detach()
1492 g_object_freeze_notify (G_OBJECT (widget));
1493 nqueue = g_object_notify_queue_freeze (G_OBJECT (widget), _gtk_widget_child_property_notify_context);
1495 /* unset focused and default children properly, this code
1496 * should eventually move into some gtk_window_unparent_branch() or
1500 toplevel = gtk_widget_get_toplevel (widget);
1501 if (GTK_CONTAINER (widget->parent)->focus_child == widget)
1503 gtk_container_set_focus_child (GTK_CONTAINER (widget->parent), NULL);
1505 if (GTK_WIDGET_TOPLEVEL (toplevel))
1509 child = GTK_WINDOW (toplevel)->focus_widget;
1511 while (child && child != widget)
1512 child = child->parent;
1514 if (child == widget)
1515 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
1518 if (GTK_WIDGET_TOPLEVEL (toplevel))
1522 child = GTK_WINDOW (toplevel)->default_widget;
1524 while (child && child != widget)
1525 child = child->parent;
1527 if (child == widget)
1528 gtk_window_set_default (GTK_WINDOW (toplevel), NULL);
1531 /* If we are unanchoring the child, we save around the toplevel
1532 * to emit hierarchy changed
1534 if (GTK_WIDGET_ANCHORED (widget->parent))
1535 g_object_ref (toplevel);
1539 if (GTK_IS_RESIZE_CONTAINER (widget))
1540 gtk_container_clear_resize_widgets (GTK_CONTAINER (widget));
1542 /* Remove the widget and all its children from any ->resize_widgets list
1543 * of all the parents in our branch. This code should move into gtkcontainer.c
1544 * somwhen, since we mess around with ->resize_widgets, which is
1545 * actually not of our business.
1547 * Two ways to make this prettier:
1548 * Write a g_slist_conditional_remove (GSList, gboolean (*)(gpointer))
1549 * Change resize_widgets to a GList
1551 ancestor = widget->parent;
1557 if (!GTK_CONTAINER (ancestor)->resize_widgets)
1559 ancestor = ancestor->parent;
1564 slist = GTK_CONTAINER (ancestor)->resize_widgets;
1576 while (parent && (parent != widget))
1577 parent = parent->parent;
1579 if (parent == widget)
1581 GTK_PRIVATE_UNSET_FLAG (child, GTK_RESIZE_NEEDED);
1586 GTK_CONTAINER (ancestor)->resize_widgets = slist;
1588 g_slist_free_1 (last);
1594 ancestor = ancestor->parent;
1597 gtk_widget_queue_clear_child (widget);
1599 /* Reset the width and height here, to force reallocation if we
1600 * get added back to a new parent. This won't work if our new
1601 * allocation is smaller than 1x1 and we actually want a size of 1x1...
1602 * (would 0x0 be OK here?)
1604 widget->allocation.width = 1;
1605 widget->allocation.height = 1;
1607 if (GTK_WIDGET_REALIZED (widget) && !GTK_WIDGET_IN_REPARENT (widget))
1608 gtk_widget_unrealize (widget);
1610 old_parent = widget->parent;
1611 widget->parent = NULL;
1612 gtk_widget_set_parent_window (widget, NULL);
1613 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[PARENT_SET], old_parent);
1616 _gtk_widget_propagate_hierarchy_changed (widget, toplevel);
1617 g_object_unref (toplevel);
1620 g_object_notify (G_OBJECT (widget), "parent");
1621 g_object_thaw_notify (G_OBJECT (widget));
1622 if (!widget->parent)
1623 g_object_notify_queue_clear (G_OBJECT (widget), nqueue);
1624 g_object_notify_queue_thaw (G_OBJECT (widget), nqueue);
1625 gtk_widget_unref (widget);
1629 * gtk_widget_destroy:
1630 * @widget: a #GtkWidget
1632 * Destroys a widget. Equivalent to gtk_object_destroy(), except that
1633 * you don't have to cast the widget to #GtkObject. When a widget is
1634 * destroyed, it will break any references it holds to other objects.
1635 * If the widget is inside a container, the widget will be removed
1636 * from the container. If the widget is a toplevel (derived from
1637 * #GtkWindow), it will be removed from the list of toplevels, and the
1638 * reference GTK+ holds to it will be removed. Removing a
1639 * widget from its container or the list of toplevels results in the
1640 * widget being finalized, unless you've added additional references
1641 * to the widget with gtk_object_ref().
1643 * In most cases, only toplevel widgets (windows) require explicit
1644 * destruction, because when you destroy a toplevel its children will
1645 * be destroyed as well.
1649 gtk_widget_destroy (GtkWidget *widget)
1651 g_return_if_fail (widget != NULL);
1652 g_return_if_fail (GTK_IS_WIDGET (widget));
1654 gtk_object_destroy ((GtkObject*) widget);
1658 * gtk_widget_destroyed:
1659 * @widget: a #GtkWidget
1660 * @widget_pointer: address of a variable that contains @widget
1662 * This function sets *@widget_pointer to NULL if @widget_pointer !=
1663 * NULL. It's intended to be used as a callback connected to the
1664 * "destroy" signal of a widget. You connect gtk_widget_destroyed()
1665 * as a signal handler, and pass the address of your widget variable
1666 * as user data. Then when the widget is destroyed, the variable will
1667 * be set to NULL. Useful for example to avoid multiple copies
1668 * of the same dialog.
1672 gtk_widget_destroyed (GtkWidget *widget,
1673 GtkWidget **widget_pointer)
1675 /* Don't make any assumptions about the
1677 * Even check widget_pointer.
1680 *widget_pointer = NULL;
1685 * @widget: a #GtkWidget
1687 * Flags a widget to be displayed. Any widget that isn't shown will
1688 * not appear on the screen. If you want to show all the widgets in a
1689 * container, it's easier to call gtk_widget_show_all() on the
1690 * container, instead of individually showing the widgets.
1692 * Remember that you have to show the containers containing a widget,
1693 * in addition to the widget itself, before it will appear onscreen.
1695 * When a toplevel container is shown, it is immediately realized and
1696 * mapped; other shown widgets are realized and mapped when their
1697 * toplevel container is realized and mapped.
1701 gtk_widget_show (GtkWidget *widget)
1703 g_return_if_fail (widget != NULL);
1704 g_return_if_fail (GTK_IS_WIDGET (widget));
1706 if (!GTK_WIDGET_VISIBLE (widget))
1708 g_object_ref (G_OBJECT (widget));
1709 if (!GTK_WIDGET_TOPLEVEL (widget))
1710 gtk_widget_queue_resize (widget);
1711 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[SHOW]);
1712 g_object_notify (G_OBJECT (widget), "visible");
1713 g_object_unref (G_OBJECT (widget));
1718 gtk_widget_real_show (GtkWidget *widget)
1720 g_return_if_fail (widget != NULL);
1721 g_return_if_fail (GTK_IS_WIDGET (widget));
1723 if (!GTK_WIDGET_VISIBLE (widget))
1725 GTK_WIDGET_SET_FLAGS (widget, GTK_VISIBLE);
1727 if (widget->parent &&
1728 GTK_WIDGET_MAPPED (widget->parent) &&
1729 !GTK_WIDGET_MAPPED (widget))
1730 gtk_widget_map (widget);
1735 gtk_widget_show_map_callback (GtkWidget *widget, GdkEvent *event, gint *flag)
1738 gtk_signal_disconnect_by_data (GTK_OBJECT (widget), flag);
1742 * gtk_widget_show_now:
1743 * @widget: a #GtkWidget
1745 * Shows a widget. If the widget is an unmapped toplevel widget
1746 * (i.e. a #GtkWindow that has not yet been shown), enter the main
1747 * loop and wait for the window to actually be mapped. Be careful;
1748 * because the main loop is running, anything can happen during
1752 gtk_widget_show_now (GtkWidget *widget)
1756 g_return_if_fail (widget != NULL);
1757 g_return_if_fail (GTK_IS_WIDGET (widget));
1759 /* make sure we will get event */
1760 if (!GTK_WIDGET_MAPPED (widget) &&
1761 GTK_WIDGET_TOPLEVEL (widget))
1763 gtk_widget_show (widget);
1765 gtk_signal_connect (GTK_OBJECT (widget), "map_event",
1766 GTK_SIGNAL_FUNC (gtk_widget_show_map_callback),
1770 gtk_main_iteration();
1773 gtk_widget_show (widget);
1778 * @widget: a #GtkWidget
1780 * Reverses the effects of gtk_widget_show(), causing the widget to be
1781 * hidden (invisible to the user).
1784 gtk_widget_hide (GtkWidget *widget)
1786 g_return_if_fail (widget != NULL);
1787 g_return_if_fail (GTK_IS_WIDGET (widget));
1789 if (GTK_WIDGET_VISIBLE (widget))
1791 gtk_widget_ref (widget);
1792 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[HIDE]);
1793 if (!GTK_WIDGET_TOPLEVEL (widget) && GTK_WIDGET_REALIZED (widget))
1794 gtk_widget_queue_resize (widget);
1795 g_object_notify (G_OBJECT (widget), "visible");
1796 gtk_widget_unref (widget);
1801 gtk_widget_real_hide (GtkWidget *widget)
1803 g_return_if_fail (widget != NULL);
1804 g_return_if_fail (GTK_IS_WIDGET (widget));
1806 if (GTK_WIDGET_VISIBLE (widget))
1808 GTK_WIDGET_UNSET_FLAGS (widget, GTK_VISIBLE);
1810 if (GTK_WIDGET_MAPPED (widget))
1811 gtk_widget_unmap (widget);
1816 * gtk_widget_hide_on_delete:
1817 * @widget: a #GtkWidget
1819 * Utility function; intended to be connected to the "delete_event"
1820 * signal on a #GtkWindow. The function calls gtk_widget_hide() on its
1821 * argument, then returns %TRUE. If connected to "delete_event",
1822 * the result is that clicking the window manager close button for
1823 * will hide but not destroy the window. By default, GTK+ destroys
1824 * windows when "delete_event" is received.
1826 * Return value: %TRUE
1829 gtk_widget_hide_on_delete (GtkWidget *widget)
1831 g_return_val_if_fail (widget != NULL, FALSE);
1832 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
1834 gtk_widget_hide (widget);
1840 * gtk_widget_show_all:
1841 * @widget: a #GtkWidget
1843 * Recursively shows a widget, and any child widgets (if the widget is
1847 gtk_widget_show_all (GtkWidget *widget)
1849 GtkWidgetClass *class;
1851 g_return_if_fail (widget != NULL);
1852 g_return_if_fail (GTK_IS_WIDGET (widget));
1854 class = GTK_WIDGET_GET_CLASS (widget);
1856 if (class->show_all)
1857 class->show_all (widget);
1861 * gtk_widget_hide_all:
1862 * @widget: a #GtkWidget
1864 * Recursively hides a widget and any child widgets.
1867 gtk_widget_hide_all (GtkWidget *widget)
1869 GtkWidgetClass *class;
1871 g_return_if_fail (widget != NULL);
1872 g_return_if_fail (GTK_IS_WIDGET (widget));
1874 class = GTK_WIDGET_GET_CLASS (widget);
1876 if (class->hide_all)
1877 class->hide_all (widget);
1882 * @widget: a #GtkWidget
1884 * This function is only for use in widget implementations. Causes
1885 * a widget to be mapped if it isn't already.
1889 gtk_widget_map (GtkWidget *widget)
1891 g_return_if_fail (GTK_IS_WIDGET (widget));
1892 g_return_if_fail (GTK_WIDGET_VISIBLE (widget) == TRUE);
1894 if (!GTK_WIDGET_MAPPED (widget))
1896 if (!GTK_WIDGET_REALIZED (widget))
1897 gtk_widget_realize (widget);
1899 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[MAP]);
1901 if (GTK_WIDGET_NO_WINDOW (widget))
1902 gtk_widget_queue_draw (widget);
1908 * @widget: a #GtkWidget
1910 * This function is only for use in widget implementations. Causes
1911 * a widget to be unmapped if it's currently mapped.
1915 gtk_widget_unmap (GtkWidget *widget)
1917 g_return_if_fail (widget != NULL);
1918 g_return_if_fail (GTK_IS_WIDGET (widget));
1920 if (GTK_WIDGET_MAPPED (widget))
1922 if (GTK_WIDGET_NO_WINDOW (widget))
1923 gtk_widget_queue_clear_child (widget);
1924 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[UNMAP]);
1929 * gtk_widget_realize:
1930 * @widget: a #GtkWidget
1932 * Creates the GDK (windowing system) resources associated with a
1933 * widget. For example, widget->window will be created when a widget
1934 * is realized. Normally realization happens implicitly; if you show
1935 * a widget and all its parent containers, then the widget will be
1936 * realized and mapped automatically.
1938 * Realizing a widget requires all
1939 * the widget's parent widgets to be realized; calling
1940 * gtk_widget_realize() realizes the widget's parents in addition to
1941 * @widget itself. If a widget is not yet inside a toplevel window
1942 * when you realize it, bad things will happen.
1944 * This function is primarily used in widget implementations, and
1945 * isn't very useful otherwise. Many times when you think you might
1946 * need it, a better approach is to connect to a signal that will be
1947 * called after the widget is realized automatically, such as
1948 * "expose_event". Or simply gtk_signal_connect_after() to the
1953 gtk_widget_realize (GtkWidget *widget)
1956 GdkExtensionMode mode;
1957 GtkWidgetShapeInfo *shape_info;
1959 g_return_if_fail (widget != NULL);
1960 g_return_if_fail (GTK_IS_WIDGET (widget));
1962 if (!GTK_WIDGET_REALIZED (widget))
1965 if (GTK_IS_CONTAINER (widget) && !GTK_WIDGET_NO_WINDOW (widget))
1966 g_message ("gtk_widget_realize(%s)", gtk_type_name (GTK_WIDGET_TYPE (widget)));
1969 if (widget->parent == NULL &&
1970 !GTK_WIDGET_TOPLEVEL (widget))
1971 g_warning ("Calling gtk_widget_realize() on a widget that isn't "
1972 "inside a toplevel window is not going to work very well. "
1973 "Widgets must be inside a toplevel container before realizing them.");
1975 if (widget->parent && !GTK_WIDGET_REALIZED (widget->parent))
1976 gtk_widget_realize (widget->parent);
1978 gtk_widget_ensure_style (widget);
1980 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[REALIZE]);
1982 if (GTK_WIDGET_HAS_SHAPE_MASK (widget))
1984 shape_info = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_shape_info);
1985 gdk_window_shape_combine_mask (widget->window,
1986 shape_info->shape_mask,
1987 shape_info->offset_x,
1988 shape_info->offset_y);
1991 if (!GTK_WIDGET_NO_WINDOW (widget))
1993 mode = gtk_widget_get_extension_events (widget);
1994 if (mode != GDK_EXTENSION_EVENTS_NONE)
1996 events = gtk_widget_get_events (widget);
1997 gdk_input_set_extension_events (widget->window, events, mode);
2005 * gtk_widget_unrealize:
2006 * @widget: a #GtkWidget
2008 * This function is only useful in widget implementations.
2009 * Causes a widget to be unrealized (frees all GDK resources
2010 * associated with the widget, such as widget->window).
2014 gtk_widget_unrealize (GtkWidget *widget)
2016 g_return_if_fail (widget != NULL);
2017 g_return_if_fail (GTK_IS_WIDGET (widget));
2019 if (GTK_WIDGET_HAS_SHAPE_MASK (widget))
2020 gtk_widget_shape_combine_mask (widget, NULL, -1, -1);
2022 if (GTK_WIDGET_REALIZED (widget))
2024 gtk_widget_ref (widget);
2025 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[UNREALIZE]);
2026 GTK_WIDGET_UNSET_FLAGS (widget, GTK_REALIZED | GTK_MAPPED);
2027 gtk_widget_unref (widget);
2031 /*****************************************
2033 *****************************************/
2036 * gtk_widget_queue_draw_area:
2037 * @widget: a #GtkWidget
2038 * @x: x coordinate of upper-left corner of rectangle to redraw
2039 * @y: y coordinate of upper-left corner of rectangle to redraw
2040 * @width: width of region to draw
2041 * @height: height of region to draw
2043 * Invalidates the rectangular area of @widget defined by @x, @y,
2044 * @width and @height by calling gdk_window_invalidate_rect() on the
2045 * widget's window and all its child windows. Once the main loop
2046 * becomes idle (after the current batch of events has been processed,
2047 * roughly), the window will receive expose events for the union of
2048 * all regions that have been invalidated.
2050 * Normally you would only use this function in widget
2051 * implementations. You might also use it, or
2052 * gdk_window_invalidate_rect() directly, to schedule a redraw of a
2053 * #GtkDrawingArea or some portion thereof.
2055 * Frequently you can just call gdk_window_invalidate_rect() or
2056 * gdk_window_invalidate_region() instead of this function. Those
2057 * functions will invalidate only a single window, instead of the
2058 * widget and all its children.
2060 * The advantage of adding to the invalidated region compared to
2061 * simply drawing immediately is efficiency; using an invalid region
2062 * ensures that you only have to redraw one time.
2066 gtk_widget_queue_draw_area (GtkWidget *widget,
2072 g_return_if_fail (widget != NULL);
2073 g_return_if_fail (GTK_IS_WIDGET (widget));
2075 gtk_widget_queue_clear_area (widget, x, y, width, height);
2079 * gtk_widget_queue_draw:
2080 * @widget: a #GtkWidget
2082 * Equivalent to calling gtk_widget_queue_draw_area() for the
2083 * entire area of a widget.
2087 gtk_widget_queue_draw (GtkWidget *widget)
2089 g_return_if_fail (widget != NULL);
2090 g_return_if_fail (GTK_IS_WIDGET (widget));
2092 gtk_widget_queue_clear (widget);
2095 /* Invalidates the given area (allocation-relative-coordinates)
2096 * in all of the widget's windows
2099 * gtk_widget_queue_clear_area:
2100 * @widget: a #GtkWidget
2101 * @x: x coordinate of upper-left corner of rectangle to redraw
2102 * @y: y coordinate of upper-left corner of rectangle to redraw
2103 * @width: width of region to draw
2104 * @height: height of region to draw
2106 * DEPRECATED. This function is no longer different from
2107 * gtk_widget_queue_draw_area(), though it once was. Now it just calls
2108 * gtk_widget_queue_draw_area(). Originally
2109 * gtk_widget_queue_clear_area() would force a redraw of the
2110 * background for GTK_NO_WINDOW widgets, and
2111 * gtk_widget_queue_draw_area() would not. Now both functions ensure
2112 * the background will be redrawn.
2116 gtk_widget_queue_clear_area (GtkWidget *widget,
2122 GdkRectangle invalid_rect;
2124 g_return_if_fail (widget != NULL);
2125 g_return_if_fail (GTK_IS_WIDGET (widget));
2127 if (!(widget->window && gdk_window_is_viewable (widget->window)))
2130 /* Find the correct widget */
2132 if (!GTK_WIDGET_NO_WINDOW (widget))
2136 /* Translate widget relative to window-relative */
2138 gint wx, wy, wwidth, wheight;
2140 gdk_window_get_position (widget->window, &wx, &wy);
2141 x -= wx - widget->allocation.x;
2142 y -= wy - widget->allocation.y;
2144 gdk_window_get_size (widget->window, &wwidth, &wheight);
2146 if (x + width <= 0 || y + height <= 0 ||
2147 x >= wwidth || y >= wheight)
2158 if (x + width > wwidth)
2160 if (y + height > wheight)
2161 height = wheight - y;
2167 invalid_rect.width = width;
2168 invalid_rect.height = height;
2170 gdk_window_invalidate_rect (widget->window, &invalid_rect, TRUE);
2174 * gtk_widget_queue_clear:
2175 * @widget: a #GtkWidget
2177 * DEPRECATED. Use gtk_widget_queue_draw() instead.
2180 gtk_widget_queue_clear (GtkWidget *widget)
2182 g_return_if_fail (widget != NULL);
2183 g_return_if_fail (GTK_IS_WIDGET (widget));
2185 if (widget->allocation.width || widget->allocation.height)
2187 if (GTK_WIDGET_NO_WINDOW (widget))
2188 gtk_widget_queue_clear_area (widget, widget->allocation.x,
2189 widget->allocation.y,
2190 widget->allocation.width,
2191 widget->allocation.height);
2193 gtk_widget_queue_clear_area (widget, 0, 0,
2194 widget->allocation.width,
2195 widget->allocation.height);
2200 * gtk_widget_queue_resize:
2201 * @widget: a #GtkWidget
2203 * This function is only for use in widget implementations.
2204 * Flags a widget to have its size renegotiated; should
2205 * be called when a widget for some reason has a new size request.
2206 * For example, when you change the text in a #GtkLabel, #GtkLabel
2207 * queues a resize to ensure there's enough space for the new text.
2211 gtk_widget_queue_resize (GtkWidget *widget)
2213 g_return_if_fail (widget != NULL);
2214 g_return_if_fail (GTK_IS_WIDGET (widget));
2216 gtk_widget_queue_clear (widget);
2218 _gtk_size_group_queue_resize (widget);
2223 * @widget: a #GtkWidget
2224 * @area: area to draw
2226 * DEPRECATED. In GTK+ 1.2, this function would immediately render the
2227 * region @area of a widget, by invoking the virtual draw method of a
2228 * widget. In GTK+ 2.0, the draw method is gone, and instead
2229 * gtk_widget_draw() simply invalidates the specified region of the
2230 * widget, then updates the invalid region of the widget immediately.
2231 * Usually you don't want to update the region immediately for
2232 * performance reasons, so in general gtk_widget_queue_draw_area() is
2233 * a better choice if you want to draw a region of a widget.
2237 gtk_widget_draw (GtkWidget *widget,
2240 g_return_if_fail (widget != NULL);
2241 g_return_if_fail (GTK_IS_WIDGET (widget));
2243 if (GTK_WIDGET_DRAWABLE (widget))
2246 gtk_widget_queue_draw_area (widget,
2248 area->width, area->height);
2250 gtk_widget_queue_draw (widget);
2252 gdk_window_process_updates (widget->window, TRUE);
2257 * gtk_widget_size_request:
2258 * @widget: a #GtkWidget
2259 * @requisition: a #GtkRequisition to be filled in
2261 * This function is only used when implementing a #GtkContainer subclass.
2262 * Obtains the preferred size of a widget. The container uses this
2263 * information to arrange its child widgets and decide what size allocations
2264 * to give them with gtk_widget_size_allocate().
2267 gtk_widget_size_request (GtkWidget *widget,
2268 GtkRequisition *requisition)
2270 g_return_if_fail (widget != NULL);
2271 g_return_if_fail (GTK_IS_WIDGET (widget));
2273 #ifdef G_ENABLE_DEBUG
2274 if (requisition == &widget->requisition)
2275 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.");
2276 #endif /* G_ENABLE_DEBUG */
2278 _gtk_size_group_compute_requisition (widget, requisition);
2282 gtk_widget_get_child_requisition (widget, requisition);
2284 gtk_widget_unref (widget);
2289 * gtk_widget_get_child_requisition:
2290 * @widget: a #GtkWidget
2291 * @requisition: a #GtkRequisition to be filled in
2293 * This function is only for use in widget implementations. Obtains
2294 * @widget->requisition, unless someone has forced a particular
2295 * geometry on the widget (e.g. with gtk_widget_set_usize()), in which
2296 * case it returns that geometry instead of the widget's requisition.
2299 gtk_widget_get_child_requisition (GtkWidget *widget,
2300 GtkRequisition *requisition)
2302 _gtk_size_group_get_child_requisition (widget, requisition);
2306 * gtk_widget_size_allocate:
2307 * @widget: a #GtkWidget
2308 * @allocation: position and size to be allocated to @widget
2310 * This function is only used by #GtkContainer subclasses, to assign a size
2311 * and position to their child widgets.
2315 gtk_widget_size_allocate (GtkWidget *widget,
2316 GtkAllocation *allocation)
2318 GtkWidgetAuxInfo *aux_info;
2319 GtkAllocation real_allocation;
2320 gboolean needs_draw = FALSE;
2322 g_return_if_fail (widget != NULL);
2323 g_return_if_fail (GTK_IS_WIDGET (widget));
2325 real_allocation = *allocation;
2326 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
2330 if (aux_info->x_set)
2331 real_allocation.x = aux_info->x;
2332 if (aux_info->y_set)
2333 real_allocation.y = aux_info->y;
2336 if (real_allocation.width < 0 || real_allocation.height < 0)
2338 g_warning ("gtk_widget_size_allocate(): attempt to allocate widget with width %d and height %d",
2339 real_allocation.width,
2340 real_allocation.height);
2343 real_allocation.width = MAX (real_allocation.width, 1);
2344 real_allocation.height = MAX (real_allocation.height, 1);
2346 if (GTK_WIDGET_NO_WINDOW (widget))
2348 if (widget->allocation.x != real_allocation.x ||
2349 widget->allocation.y != real_allocation.y ||
2350 widget->allocation.width != real_allocation.width ||
2351 widget->allocation.height != real_allocation.height)
2353 gtk_widget_queue_clear_child (widget);
2357 else if (widget->allocation.width != real_allocation.width ||
2358 widget->allocation.height != real_allocation.height)
2363 if (GTK_IS_RESIZE_CONTAINER (widget))
2364 gtk_container_clear_resize_widgets (GTK_CONTAINER (widget));
2366 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[SIZE_ALLOCATE], &real_allocation);
2370 gtk_widget_queue_draw (widget);
2371 if (widget->parent && GTK_CONTAINER (widget->parent)->reallocate_redraws)
2372 gtk_widget_queue_draw (widget->parent);
2377 gtk_widget_real_size_allocate (GtkWidget *widget,
2378 GtkAllocation *allocation)
2380 g_return_if_fail (widget != NULL);
2381 g_return_if_fail (GTK_IS_WIDGET (widget));
2383 widget->allocation = *allocation;
2385 if (GTK_WIDGET_REALIZED (widget) &&
2386 !GTK_WIDGET_NO_WINDOW (widget))
2388 gdk_window_move_resize (widget->window,
2389 allocation->x, allocation->y,
2390 allocation->width, allocation->height);
2395 gtk_widget_stop_add_accelerator (GtkWidget *widget)
2397 g_return_if_fail (widget != NULL);
2398 g_return_if_fail (GTK_IS_WIDGET (widget));
2400 gtk_signal_emit_stop (GTK_OBJECT (widget), widget_signals[ADD_ACCELERATOR]);
2404 gtk_widget_stop_remove_accelerator (GtkWidget *widget)
2406 g_return_if_fail (widget != NULL);
2407 g_return_if_fail (GTK_IS_WIDGET (widget));
2409 gtk_signal_emit_stop (GTK_OBJECT (widget), widget_signals[REMOVE_ACCELERATOR]);
2413 gtk_widget_lock_accelerators (GtkWidget *widget)
2415 g_return_if_fail (widget != NULL);
2416 g_return_if_fail (GTK_IS_WIDGET (widget));
2418 if (!gtk_widget_accelerators_locked (widget))
2420 gtk_signal_connect (GTK_OBJECT (widget),
2422 GTK_SIGNAL_FUNC (gtk_widget_stop_add_accelerator),
2424 gtk_signal_connect (GTK_OBJECT (widget),
2425 "remove_accelerator",
2426 GTK_SIGNAL_FUNC (gtk_widget_stop_remove_accelerator),
2432 gtk_widget_unlock_accelerators (GtkWidget *widget)
2434 g_return_if_fail (widget != NULL);
2435 g_return_if_fail (GTK_IS_WIDGET (widget));
2437 if (gtk_widget_accelerators_locked (widget))
2439 gtk_signal_disconnect_by_func (GTK_OBJECT (widget),
2440 GTK_SIGNAL_FUNC (gtk_widget_stop_add_accelerator),
2442 gtk_signal_disconnect_by_func (GTK_OBJECT (widget),
2443 GTK_SIGNAL_FUNC (gtk_widget_stop_remove_accelerator),
2449 gtk_widget_accelerators_locked (GtkWidget *widget)
2451 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
2453 return gtk_signal_handler_pending_by_func (GTK_OBJECT (widget),
2454 widget_signals[ADD_ACCELERATOR],
2456 GTK_SIGNAL_FUNC (gtk_widget_stop_add_accelerator),
2461 gtk_widget_add_accelerator (GtkWidget *widget,
2462 const gchar *accel_signal,
2463 GtkAccelGroup *accel_group,
2466 GtkAccelFlags accel_flags)
2468 g_return_if_fail (widget != NULL);
2469 g_return_if_fail (GTK_IS_WIDGET (widget));
2470 g_return_if_fail (accel_group != NULL);
2472 gtk_accel_group_add (accel_group,
2476 (GtkObject*) widget,
2481 gtk_widget_remove_accelerator (GtkWidget *widget,
2482 GtkAccelGroup *accel_group,
2486 g_return_if_fail (widget != NULL);
2487 g_return_if_fail (GTK_IS_WIDGET (widget));
2488 g_return_if_fail (accel_group != NULL);
2490 gtk_accel_group_remove (accel_group,
2493 (GtkObject*) widget);
2497 gtk_widget_remove_accelerators (GtkWidget *widget,
2498 const gchar *accel_signal,
2499 gboolean visible_only)
2504 g_return_if_fail (widget != NULL);
2505 g_return_if_fail (GTK_IS_WIDGET (widget));
2506 g_return_if_fail (accel_signal != NULL);
2508 signal_id = gtk_signal_lookup (accel_signal, GTK_OBJECT_TYPE (widget));
2509 g_return_if_fail (signal_id != 0);
2511 slist = gtk_accel_group_entries_from_object (GTK_OBJECT (widget));
2514 GtkAccelEntry *ac_entry;
2516 ac_entry = slist->data;
2517 slist = slist->next;
2518 if (ac_entry->accel_flags & GTK_ACCEL_VISIBLE &&
2519 ac_entry->signal_id == signal_id)
2520 gtk_widget_remove_accelerator (GTK_WIDGET (widget),
2521 ac_entry->accel_group,
2522 ac_entry->accelerator_key,
2523 ac_entry->accelerator_mods);
2528 gtk_widget_accelerator_signal (GtkWidget *widget,
2529 GtkAccelGroup *accel_group,
2533 GtkAccelEntry *ac_entry;
2535 g_return_val_if_fail (widget != NULL, 0);
2536 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
2537 g_return_val_if_fail (accel_group != NULL, 0);
2539 ac_entry = gtk_accel_group_get_entry (accel_group, accel_key, accel_mods);
2541 if (ac_entry && ac_entry->object == (GtkObject*) widget)
2542 return ac_entry->signal_id;
2547 gtk_widget_mnemonic_activate (GtkWidget *widget,
2548 gboolean group_cycling)
2552 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
2554 group_cycling = group_cycling != FALSE;
2555 if (!GTK_WIDGET_IS_SENSITIVE (widget))
2558 gtk_signal_emit (GTK_OBJECT (widget),
2559 widget_signals[ACTIVATE_MNEMONIC],
2566 gtk_widget_real_mnemonic_activate (GtkWidget *widget,
2567 gboolean group_cycling)
2569 if (!group_cycling && GTK_WIDGET_GET_CLASS (widget)->activate_signal)
2570 gtk_widget_activate (widget);
2571 else if (GTK_WIDGET_CAN_FOCUS (widget))
2572 gtk_widget_grab_focus (widget);
2575 g_warning ("widget `%s' isn't suitable for mnemonic activation",
2576 G_OBJECT_TYPE_NAME (widget));
2583 gtk_widget_real_key_press_event (GtkWidget *widget,
2586 gboolean handled = FALSE;
2588 g_return_val_if_fail (widget != NULL, handled);
2589 g_return_val_if_fail (GTK_IS_WIDGET (widget), handled);
2590 g_return_val_if_fail (event != NULL, handled);
2593 handled = gtk_bindings_activate (GTK_OBJECT (widget),
2601 gtk_widget_real_key_release_event (GtkWidget *widget,
2604 gboolean handled = FALSE;
2606 g_return_val_if_fail (widget != NULL, handled);
2607 g_return_val_if_fail (GTK_IS_WIDGET (widget), handled);
2608 g_return_val_if_fail (event != NULL, handled);
2611 handled = gtk_bindings_activate (GTK_OBJECT (widget),
2613 event->state | GDK_RELEASE_MASK);
2619 gtk_widget_real_focus_in_event (GtkWidget *widget,
2620 GdkEventFocus *event)
2622 GTK_WIDGET_SET_FLAGS (widget, GTK_HAS_FOCUS);
2623 gtk_widget_queue_draw (widget);
2629 gtk_widget_real_focus_out_event (GtkWidget *widget,
2630 GdkEventFocus *event)
2632 GTK_WIDGET_UNSET_FLAGS (widget, GTK_HAS_FOCUS);
2633 gtk_widget_queue_draw (widget);
2640 * @widget: a #GtkWidget
2641 * @event: a #GdkEvent
2643 * Rarely-used function. This function is used to emit
2644 * the event signals on a widget (those signals should never
2645 * be emitted without using this function to do so).
2646 * If you want to synthesize an event though, don't use this function;
2647 * instead, use gtk_main_do_event() so the event will behave as if
2648 * it were in the event queue. Don't synthesize expose events; instead,
2649 * use gdk_window_invalidate_rect() to invalidate a region of the
2652 * Return value: return from the event signal emission (%TRUE if the event was handled)
2655 gtk_widget_event (GtkWidget *widget,
2658 g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
2659 g_return_val_if_fail (GTK_WIDGET_REALIZED (widget), TRUE);
2661 if (event->type == GDK_EXPOSE)
2663 g_warning ("Events of type GDK_EXPOSE cannot be synthesized. To get "
2664 "the same effect, call gdk_window_invalidate_rect/region(), "
2665 "followed by gdk_window_process_updates().");
2669 return gtk_widget_event_internal (widget, event);
2674 * gtk_widget_send_expose:
2675 * @widget: a #GtkWidget
2676 * @event: a expose #GdkEvent
2678 * Very rarely-used function. This function is used to emit
2679 * an expose event signals on a widget. This function is not
2680 * normally used directly. The only time it is used is when
2681 * propagating an expose event to a child NO_WINDOW widget, and
2682 * that is normally done using gtk_container_propagate_expose.
2684 * If you want to force an area of a window to be redrawn,
2685 * use gdk_window_invalidate_rect() or gdk_window_invalidate_region().
2686 * To cause the redraw to be done immediately, follow that call
2687 * with a call to gdk_window_procss_updates().
2689 * Return value: return from the event signal emission (%TRUE if the event was handled)
2692 gtk_widget_send_expose (GtkWidget *widget,
2695 g_return_val_if_fail (GTK_IS_WIDGET (widget), TRUE);
2696 g_return_val_if_fail (GTK_WIDGET_REALIZED (widget), TRUE);
2697 g_return_val_if_fail (event != NULL, TRUE);
2698 g_return_val_if_fail (event->type == GDK_EXPOSE, TRUE);
2700 if (event->type != GDK_EXPOSE)
2703 return gtk_widget_event_internal (widget, event);
2707 gtk_widget_event_internal (GtkWidget *widget,
2710 gboolean return_val = FALSE;
2712 gtk_widget_ref (widget);
2714 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[EVENT], event, &return_val);
2715 return_val |= !GTK_WIDGET_REALIZED (widget);
2720 switch (event->type)
2725 case GDK_BUTTON_PRESS:
2726 case GDK_2BUTTON_PRESS:
2727 case GDK_3BUTTON_PRESS:
2728 signal_num = BUTTON_PRESS_EVENT;
2731 signal_num = SCROLL_EVENT;
2733 case GDK_BUTTON_RELEASE:
2734 signal_num = BUTTON_RELEASE_EVENT;
2736 case GDK_MOTION_NOTIFY:
2737 signal_num = MOTION_NOTIFY_EVENT;
2740 signal_num = DELETE_EVENT;
2743 signal_num = DESTROY_EVENT;
2746 signal_num = KEY_PRESS_EVENT;
2748 case GDK_KEY_RELEASE:
2749 signal_num = KEY_RELEASE_EVENT;
2751 case GDK_ENTER_NOTIFY:
2752 signal_num = ENTER_NOTIFY_EVENT;
2754 case GDK_LEAVE_NOTIFY:
2755 signal_num = LEAVE_NOTIFY_EVENT;
2757 case GDK_FOCUS_CHANGE:
2758 signal_num = event->focus_change.in ? FOCUS_IN_EVENT : FOCUS_OUT_EVENT;
2761 signal_num = CONFIGURE_EVENT;
2764 signal_num = MAP_EVENT;
2767 signal_num = UNMAP_EVENT;
2769 case GDK_WINDOW_STATE:
2770 signal_num = WINDOW_STATE_EVENT;
2772 case GDK_PROPERTY_NOTIFY:
2773 signal_num = PROPERTY_NOTIFY_EVENT;
2775 case GDK_SELECTION_CLEAR:
2776 signal_num = SELECTION_CLEAR_EVENT;
2778 case GDK_SELECTION_REQUEST:
2779 signal_num = SELECTION_REQUEST_EVENT;
2781 case GDK_SELECTION_NOTIFY:
2782 signal_num = SELECTION_NOTIFY_EVENT;
2784 case GDK_PROXIMITY_IN:
2785 signal_num = PROXIMITY_IN_EVENT;
2787 case GDK_PROXIMITY_OUT:
2788 signal_num = PROXIMITY_OUT_EVENT;
2791 signal_num = NO_EXPOSE_EVENT;
2793 case GDK_CLIENT_EVENT:
2794 signal_num = CLIENT_EVENT;
2797 signal_num = EXPOSE_EVENT;
2799 case GDK_VISIBILITY_NOTIFY:
2800 signal_num = VISIBILITY_NOTIFY_EVENT;
2803 g_warning ("gtk_widget_event(): unhandled event type: %d", event->type);
2807 if (signal_num != -1)
2808 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[signal_num], event, &return_val);
2810 if (GTK_WIDGET_REALIZED (widget))
2811 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[EVENT_AFTER], event);
2815 gtk_widget_unref (widget);
2821 * gtk_widget_activate:
2822 * @widget: a #GtkWidget that's activatable
2824 * For widgets that can be "activated" (buttons, menu items, etc.)
2825 * this function activates them. Activation is what happens when you
2826 * press Enter on a widget during key navigation; clicking a button,
2827 * selecting a menu item, etc. If @widget isn't activatable,
2828 * the function returns %FALSE.
2830 * Return value: %TRUE if the widget was activatable
2833 gtk_widget_activate (GtkWidget *widget)
2835 g_return_val_if_fail (widget != NULL, FALSE);
2836 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
2838 if (WIDGET_CLASS (widget)->activate_signal)
2840 /* FIXME: we should eventually check the signals signature here */
2841 gtk_signal_emit (GTK_OBJECT (widget), WIDGET_CLASS (widget)->activate_signal);
2850 * gtk_widget_set_scroll_adjustments:
2851 * @widget: a #GtkWidget
2852 * @hadjustment: an adjustment for horizontal scrolling, or %NULL
2853 * @vadjustment: an adjustment for vertical scrolling, or %NULL
2855 * For widgets that support scrolling, sets the scroll adjustments and
2856 * returns %TRUE. For widgets that don't support scrolling, does
2857 * nothing and returns %FALSE. Widgets that don't support scrolling
2858 * can be scrolled by placing them in a #GtkViewport, which does
2859 * support scrolling.
2861 * Return value: %TRUE if the widget supports scrolling
2864 gtk_widget_set_scroll_adjustments (GtkWidget *widget,
2865 GtkAdjustment *hadjustment,
2866 GtkAdjustment *vadjustment)
2868 g_return_val_if_fail (widget != NULL, FALSE);
2869 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
2871 g_return_val_if_fail (GTK_IS_ADJUSTMENT (hadjustment), FALSE);
2873 g_return_val_if_fail (GTK_IS_ADJUSTMENT (vadjustment), FALSE);
2875 if (WIDGET_CLASS (widget)->set_scroll_adjustments_signal)
2877 /* FIXME: we should eventually check the signals signature here */
2878 gtk_signal_emit (GTK_OBJECT (widget),
2879 WIDGET_CLASS (widget)->set_scroll_adjustments_signal,
2880 hadjustment, vadjustment);
2887 /*****************************************
2888 * gtk_widget_reparent_container_child:
2889 * assistent function to gtk_widget_reparent
2894 *****************************************/
2897 gtk_widget_reparent_container_child (GtkWidget *widget,
2898 gpointer client_data)
2900 g_return_if_fail (widget != NULL);
2901 g_return_if_fail (GTK_IS_WIDGET (widget));
2902 g_return_if_fail (client_data != NULL);
2904 if (GTK_WIDGET_NO_WINDOW (widget))
2907 gdk_window_unref (widget->window);
2908 widget->window = (GdkWindow*) client_data;
2910 gdk_window_ref (widget->window);
2912 if (GTK_IS_CONTAINER (widget))
2913 gtk_container_forall (GTK_CONTAINER (widget),
2914 gtk_widget_reparent_container_child,
2918 gdk_window_reparent (widget->window,
2919 (GdkWindow*) client_data, 0, 0);
2923 * gtk_widget_reparent:
2924 * @widget: a #GtkWidget
2925 * @new_parent: a #GtkContainer to move the widget into
2927 * Moves a widget from one #GtkContainer to another, handling reference
2928 * count issues to avoid destroying the widget.
2932 gtk_widget_reparent (GtkWidget *widget,
2933 GtkWidget *new_parent)
2935 g_return_if_fail (widget != NULL);
2936 g_return_if_fail (GTK_IS_WIDGET (widget));
2937 g_return_if_fail (new_parent != NULL);
2938 g_return_if_fail (GTK_IS_CONTAINER (new_parent));
2939 g_return_if_fail (widget->parent != NULL);
2941 if (widget->parent != new_parent)
2943 /* First try to see if we can get away without unrealizing
2944 * the widget as we reparent it. if so we set a flag so
2945 * that gtk_widget_unparent doesn't unrealize widget
2947 if (GTK_WIDGET_REALIZED (widget) && GTK_WIDGET_REALIZED (new_parent))
2948 GTK_PRIVATE_SET_FLAG (widget, GTK_IN_REPARENT);
2950 gtk_widget_ref (widget);
2951 gtk_container_remove (GTK_CONTAINER (widget->parent), widget);
2952 gtk_container_add (GTK_CONTAINER (new_parent), widget);
2953 gtk_widget_unref (widget);
2955 if (GTK_WIDGET_IN_REPARENT (widget))
2957 GTK_PRIVATE_UNSET_FLAG (widget, GTK_IN_REPARENT);
2959 gtk_widget_reparent_container_child (widget,
2960 gtk_widget_get_parent_window (widget));
2966 * gtk_widget_intersect:
2967 * @widget: a #GtkWidget
2968 * @area: a rectangle
2969 * @intersection: rectangle to store intersection of @widget and @area
2971 * Computes the intersection of a @widget's area and @area, storing
2972 * the intersection in @intersection, and returns %TRUE if there was
2973 * an intersection. @intersection may be %NULL if you're only
2974 * interested in whether there was an intersection.
2976 * Return value: %TRUE if there was an intersection
2979 gtk_widget_intersect (GtkWidget *widget,
2981 GdkRectangle *intersection)
2987 g_return_val_if_fail (widget != NULL, FALSE);
2988 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
2989 g_return_val_if_fail (area != NULL, FALSE);
2992 dest = intersection;
2996 return_val = gdk_rectangle_intersect (&widget->allocation, area, dest);
2998 if (return_val && intersection && !GTK_WIDGET_NO_WINDOW (widget))
3000 intersection->x -= widget->allocation.x;
3001 intersection->y -= widget->allocation.y;
3008 * gtk_widget_region_intersect:
3009 * @widget: a #GtkWidget
3010 * @region: a #GdkRegion, in the same coordinate system as
3011 * widget->allocation. That is, relative to widget->window
3012 * for NO_WINDOW widgets; relative to the parent window
3013 * of widget->window for widgets with their own window.
3014 * @returns: A newly allocated region holding the intersection of @widget
3015 * and @region. The coordinates of the return value are
3016 * relative to widget->window for NO_WINDOW widgets, and
3017 * relative to the parent window of widget->window for
3018 * widgets with their own window.
3020 * Computes the intersection of a @widget's area and @region, returning
3021 * the intersection. The result may be empty, use #gdk_region_empty to
3025 gtk_widget_region_intersect (GtkWidget *widget,
3030 g_return_val_if_fail (widget != NULL, NULL);
3031 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
3032 g_return_val_if_fail (region != NULL, NULL);
3034 dest = gdk_region_rectangle (&widget->allocation);
3036 gdk_region_intersect (dest, region);
3042 * gtk_widget_grab_focus:
3043 * @widget: a #GtkWidget
3045 * Causes @widget to have the keyboard focus for the #GtkWindow it's
3046 * inside. @widget must be a focusable widget, such as a #GtkEntry;
3047 * something like #GtkFrame won't work. (More precisely, it must have the
3048 * #GTK_CAN_FOCUS flag set.)
3052 gtk_widget_grab_focus (GtkWidget *widget)
3054 g_return_if_fail (widget != NULL);
3055 g_return_if_fail (GTK_IS_WIDGET (widget));
3057 g_object_ref (G_OBJECT (widget));
3058 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[GRAB_FOCUS]);
3059 g_object_notify (G_OBJECT (widget), "has_focus");
3060 g_object_unref (G_OBJECT (widget));
3064 reset_focus_recurse (GtkWidget *widget,
3067 if (GTK_IS_CONTAINER (widget))
3069 GtkContainer *container;
3071 container = GTK_CONTAINER (widget);
3072 gtk_container_set_focus_child (container, NULL);
3074 gtk_container_foreach (container,
3075 reset_focus_recurse,
3081 gtk_widget_real_grab_focus (GtkWidget *focus_widget)
3083 g_return_if_fail (focus_widget != NULL);
3084 g_return_if_fail (GTK_IS_WIDGET (focus_widget));
3086 if (GTK_WIDGET_CAN_FOCUS (focus_widget))
3088 GtkWidget *toplevel;
3091 /* clear the current focus setting, break if the current widget
3092 * is the focus widget's parent, since containers above that will
3093 * be set by the next loop.
3095 toplevel = gtk_widget_get_toplevel (focus_widget);
3096 if (GTK_WIDGET_TOPLEVEL (toplevel))
3098 widget = GTK_WINDOW (toplevel)->focus_widget;
3100 if (widget == focus_widget)
3102 /* We call gtk_window_set_focus() here so that the
3103 * toplevel window can request the focus if necessary.
3104 * This is needed when the toplevel is a GtkPlug
3106 if (!GTK_WIDGET_HAS_FOCUS (widget))
3107 gtk_window_set_focus (GTK_WINDOW (toplevel), focus_widget);
3114 while (widget->parent && widget->parent != focus_widget->parent)
3116 widget = widget->parent;
3117 gtk_container_set_focus_child (GTK_CONTAINER (widget), NULL);
3121 else if (toplevel != focus_widget)
3123 /* gtk_widget_grab_focus() operates on a tree without window...
3124 * actually, this is very questionable behaviour.
3127 gtk_container_foreach (GTK_CONTAINER (toplevel),
3128 reset_focus_recurse,
3132 /* now propagate the new focus up the widget tree and finally
3133 * set it on the window
3135 widget = focus_widget;
3136 while (widget->parent)
3138 gtk_container_set_focus_child (GTK_CONTAINER (widget->parent), widget);
3139 widget = widget->parent;
3141 if (GTK_IS_WINDOW (widget))
3142 gtk_window_set_focus (GTK_WINDOW (widget), focus_widget);
3147 gtk_widget_real_show_help (GtkWidget *widget,
3148 GtkWidgetHelpType help_type)
3150 if (help_type == GTK_WIDGET_HELP_TOOLTIP)
3151 _gtk_tooltips_show_tip (widget);
3155 gtk_widget_real_focus (GtkWidget *widget,
3156 GtkDirectionType direction)
3158 if (!GTK_WIDGET_CAN_FOCUS (widget))
3161 if (!gtk_widget_is_focus (widget))
3163 gtk_widget_grab_focus (widget);
3171 * gtk_widget_is_focus:
3172 * @widget: a #GtkWidget
3174 * Determines if the widget is the focus widget within its
3175 * toplevel. (This does not mean that the HAS_FOCUS flag is
3176 * necessarily set; HAS_FOCUS will only be set if the
3177 * toplevel widget additionally has the global input focus.)
3179 * Return value: %TRUE if the widget is the focus widget.
3182 gtk_widget_is_focus (GtkWidget *widget)
3184 GtkWidget *toplevel;
3186 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
3188 toplevel = gtk_widget_get_toplevel (widget);
3190 if (GTK_IS_WINDOW (toplevel))
3191 return widget == GTK_WINDOW (toplevel)->focus_widget;
3197 * gtk_widget_grab_default:
3198 * @widget: a #GtkWidget
3200 * Causes @widget to become the default widget. @widget must have the
3201 * #GTK_CAN_DEFAULT flag set; typically you have to set this flag
3202 * yourself by calling GTK_WIDGET_SET_FLAGS (@widget,
3203 * GTK_CAN_DEFAULT). The default widget is activated when the user
3204 * presses Enter in a window. Default widgets must be activatable,
3205 * that is, gtk_widget_activate() should affect them.
3209 gtk_widget_grab_default (GtkWidget *widget)
3212 GtkType window_type;
3214 g_return_if_fail (widget != NULL);
3215 g_return_if_fail (GTK_IS_WIDGET (widget));
3216 g_return_if_fail (GTK_WIDGET_CAN_DEFAULT (widget));
3218 window_type = GTK_TYPE_WINDOW;
3219 window = widget->parent;
3221 while (window && !gtk_type_is_a (GTK_WIDGET_TYPE (window), window_type))
3222 window = window->parent;
3224 if (window && gtk_type_is_a (GTK_WIDGET_TYPE (window), window_type))
3226 gtk_window_set_default (GTK_WINDOW (window), widget);
3227 g_object_notify (G_OBJECT (widget), "has_default");
3230 g_warning (G_STRLOC ": widget not within a GtkWindow");
3234 * gtk_widget_set_name:
3235 * @widget: a #GtkWidget
3236 * @name: name for the widget
3238 * Widgets can be named, which allows you to refer to them from a
3239 * gtkrc file. You can apply a style to widgets with a particular name
3240 * in the gtkrc file. See the documentation for gtkrc files (on the
3241 * same page as the docs for #GtkRcStyle).
3245 gtk_widget_set_name (GtkWidget *widget,
3248 g_return_if_fail (widget != NULL);
3249 g_return_if_fail (GTK_IS_WIDGET (widget));
3252 g_free (widget->name);
3253 widget->name = g_strdup (name);
3255 if (GTK_WIDGET_RC_STYLE (widget))
3256 gtk_widget_reset_rc_style (widget);
3258 g_object_notify (G_OBJECT (widget), "name");
3262 * gtk_widget_get_name:
3263 * @widget: a #GtkWidget
3265 * Retrieves the name of a widget. The return value should not be
3266 * freed. See gtk_widget_set_name() for the significance of widget
3269 * Return value: name of the widget
3271 G_CONST_RETURN gchar*
3272 gtk_widget_get_name (GtkWidget *widget)
3274 g_return_val_if_fail (widget != NULL, NULL);
3275 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
3278 return widget->name;
3279 return gtk_type_name (GTK_WIDGET_TYPE (widget));
3283 * gtk_widget_set_state:
3284 * @widget: a #GtkWidget
3285 * @state: new state for @widget
3287 * This function is for use in widget implementations. Sets the state
3288 * of a widget (insensitive, prelighted, etc.) Usually you should set
3289 * the state using wrapper functions such as gtk_widget_set_sensitive().
3293 gtk_widget_set_state (GtkWidget *widget,
3296 g_return_if_fail (widget != NULL);
3297 g_return_if_fail (GTK_IS_WIDGET (widget));
3299 if (state == GTK_WIDGET_STATE (widget))
3302 if (state == GTK_STATE_INSENSITIVE)
3303 gtk_widget_set_sensitive (widget, FALSE);
3309 data.state_restoration = FALSE;
3310 data.use_forall = FALSE;
3312 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget->parent) != FALSE);
3314 data.parent_sensitive = TRUE;
3316 gtk_widget_propagate_state (widget, &data);
3318 if (GTK_WIDGET_DRAWABLE (widget))
3319 gtk_widget_queue_clear (widget);
3324 gtk_widget_set_app_paintable (GtkWidget *widget,
3325 gboolean app_paintable)
3327 g_return_if_fail (widget != NULL);
3328 g_return_if_fail (GTK_IS_WIDGET (widget));
3330 app_paintable = (app_paintable != FALSE);
3332 if (GTK_WIDGET_APP_PAINTABLE (widget) != app_paintable)
3335 GTK_WIDGET_SET_FLAGS (widget, GTK_APP_PAINTABLE);
3337 GTK_WIDGET_UNSET_FLAGS (widget, GTK_APP_PAINTABLE);
3339 if (GTK_WIDGET_DRAWABLE (widget))
3340 gtk_widget_queue_clear (widget);
3342 g_object_notify (G_OBJECT (widget), "app_paintable");
3347 * gtk_widget_set_double_buffered:
3348 * @widget: a #GtkWidget
3349 * @double_buffered: %TRUE to double-buffer a widget
3351 * Widgets are double buffered by default; you can use this function
3352 * to turn off the buffering. "Double buffered" simply means that
3353 * gdk_window_begin_paint_region() and gdk_window_end_paint() are called
3354 * automatically around expose events sent to the
3355 * widget. gdk_window_begin_paint() diverts all drawing to a widget's
3356 * window to an offscreen buffer, and gdk_window_end_paint() draws the
3357 * buffer to the screen. The result is that users see the window
3358 * update in one smooth step, and don't see individual graphics
3359 * primitives being rendered.
3361 * In very simple terms, double buffered widgets don't flicker,
3362 * so you would only use this function to turn off double buffering
3363 * if you had special needs and really knew what you were doing.
3367 gtk_widget_set_double_buffered (GtkWidget *widget,
3368 gboolean double_buffered)
3370 g_return_if_fail (widget != NULL);
3371 g_return_if_fail (GTK_IS_WIDGET (widget));
3373 if (double_buffered)
3374 GTK_WIDGET_SET_FLAGS (widget, GTK_DOUBLE_BUFFERED);
3376 GTK_WIDGET_UNSET_FLAGS (widget, GTK_DOUBLE_BUFFERED);
3380 * gtk_widget_set_sensitive:
3381 * @widget: a @widget
3382 * @sensitive: %TRUE to make the widget sensitive
3384 * Sets the sensitivity of a widget. A widget is sensitive if the user
3385 * can interact with it. Insensitive widgets are "grayed out" and the
3386 * user can't interact with them. Insensitive widgets are known as
3387 * "inactive" in some other toolkits.
3391 gtk_widget_set_sensitive (GtkWidget *widget,
3396 g_return_if_fail (widget != NULL);
3397 g_return_if_fail (GTK_IS_WIDGET (widget));
3399 sensitive = (sensitive != FALSE);
3401 if (sensitive == (GTK_WIDGET_SENSITIVE (widget) != FALSE))
3406 GTK_WIDGET_SET_FLAGS (widget, GTK_SENSITIVE);
3407 data.state = GTK_WIDGET_SAVED_STATE (widget);
3411 GTK_WIDGET_UNSET_FLAGS (widget, GTK_SENSITIVE);
3412 data.state = GTK_WIDGET_STATE (widget);
3414 data.state_restoration = TRUE;
3415 data.use_forall = TRUE;
3418 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget->parent) != FALSE);
3420 data.parent_sensitive = TRUE;
3422 gtk_widget_propagate_state (widget, &data);
3423 if (GTK_WIDGET_DRAWABLE (widget))
3424 gtk_widget_queue_clear (widget);
3426 g_object_notify (G_OBJECT (widget), "sensitive");
3430 * gtk_widget_set_parent:
3431 * @widget: a #GtkWidget
3432 * @parent: parent container
3434 * This function is useful only when implementing subclasses of #GtkContainer.
3435 * Sets the container as the parent of @widget, and takes care of
3436 * some details such as updating the state and style of the child
3437 * to reflect its new location. The opposite function is
3438 * gtk_widget_unparent().
3442 gtk_widget_set_parent (GtkWidget *widget,
3447 g_return_if_fail (widget != NULL);
3448 g_return_if_fail (GTK_IS_WIDGET (widget));
3449 g_return_if_fail (widget->parent == NULL);
3450 g_return_if_fail (!GTK_WIDGET_TOPLEVEL (widget));
3451 g_return_if_fail (parent != NULL);
3452 g_return_if_fail (GTK_IS_WIDGET (parent));
3453 g_return_if_fail (widget != parent);
3455 /* keep this function in sync with gtk_menu_attach_to_widget()
3458 gtk_widget_ref (widget);
3459 gtk_object_sink (GTK_OBJECT (widget));
3460 widget->parent = parent;
3462 if (GTK_WIDGET_STATE (parent) != GTK_STATE_NORMAL)
3463 data.state = GTK_WIDGET_STATE (parent);
3465 data.state = GTK_WIDGET_STATE (widget);
3466 data.state_restoration = FALSE;
3467 data.parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (parent) != FALSE);
3468 data.use_forall = GTK_WIDGET_IS_SENSITIVE (parent) != GTK_WIDGET_IS_SENSITIVE (widget);
3470 gtk_widget_propagate_state (widget, &data);
3472 gtk_widget_set_style_recurse (widget, NULL);
3474 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[PARENT_SET], NULL);
3475 if (GTK_WIDGET_ANCHORED (widget->parent))
3476 _gtk_widget_propagate_hierarchy_changed (widget, NULL);
3477 g_object_notify (G_OBJECT (widget), "parent");
3481 * gtk_widget_get_parent:
3482 * @widget: a #GtkWidget
3484 * Returns the parent container of @widget.
3486 * Return value: the parent container of @widget, or %NULL
3489 gtk_widget_get_parent (GtkWidget *widget)
3491 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
3493 return widget->parent;
3496 /*****************************************
3498 * see docs/styles.txt
3499 *****************************************/
3502 * gtk_widget_set_style:
3503 * @widget: a #GtkWidget
3504 * @style: a #GtkStyle, or %NULL to remove the effect of a previous
3505 * gtk_widget_set_style and go back to the default style
3507 * Sets the #GtkStyle for a widget (widget->style). You probably don't
3508 * want to use this function; it interacts badly with themes, because
3509 * themes work by replacing the #GtkStyle. Instead, use
3510 * gtk_widget_modify_style().
3514 gtk_widget_set_style (GtkWidget *widget,
3517 g_return_if_fail (widget != NULL);
3518 g_return_if_fail (GTK_IS_WIDGET (widget));
3522 gboolean initial_emission;
3524 initial_emission = !GTK_WIDGET_RC_STYLE (widget) && !GTK_WIDGET_USER_STYLE (widget);
3526 GTK_WIDGET_UNSET_FLAGS (widget, GTK_RC_STYLE);
3527 GTK_PRIVATE_SET_FLAG (widget, GTK_USER_STYLE);
3529 gtk_widget_set_style_internal (widget, style, initial_emission);
3533 if (GTK_WIDGET_USER_STYLE (widget))
3534 gtk_widget_reset_rc_style (widget);
3539 * gtk_widget_ensure_style:
3540 * @widget: a #GtkWidget
3542 * Ensures that @widget has a style (widget->style). Not a very useful
3543 * function; most of the time, if you want the style, the widget is
3544 * realized, and realized widgets are guaranteed to have a style
3549 gtk_widget_ensure_style (GtkWidget *widget)
3551 g_return_if_fail (widget != NULL);
3552 g_return_if_fail (GTK_IS_WIDGET (widget));
3554 if (!GTK_WIDGET_USER_STYLE (widget) &&
3555 !GTK_WIDGET_RC_STYLE (widget))
3556 gtk_widget_reset_rc_style (widget);
3559 /* Look up the RC style for this widget, unsetting any user style that
3560 * may be in effect currently
3563 gtk_widget_reset_rc_style (GtkWidget *widget)
3565 GtkStyle *new_style;
3566 gboolean initial_emission;
3568 g_return_if_fail (widget != NULL);
3569 g_return_if_fail (GTK_IS_WIDGET (widget));
3571 initial_emission = !GTK_WIDGET_RC_STYLE (widget) && !GTK_WIDGET_USER_STYLE (widget);
3573 GTK_PRIVATE_UNSET_FLAG (widget, GTK_USER_STYLE);
3574 GTK_WIDGET_SET_FLAGS (widget, GTK_RC_STYLE);
3576 new_style = gtk_rc_get_style (widget);
3578 new_style = gtk_widget_get_default_style ();
3580 if (initial_emission || new_style != widget->style)
3581 gtk_widget_set_style_internal (widget, new_style, initial_emission);
3585 * gtk_widget_get_style:
3586 * @widget: a #GtkWidget
3588 * Simply an accessor function that returns widget->style.
3590 * Return value: the widget's #GtkStyle
3593 gtk_widget_get_style (GtkWidget *widget)
3595 g_return_val_if_fail (widget != NULL, NULL);
3596 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
3598 return widget->style;
3602 * gtk_widget_modify_style:
3603 * @widget: a #GtkWidget
3604 * @style: the #GtkRcStyle holding the style modifications
3606 * Modify style values on the widget. Modifications made using this
3607 * technique take precendence over style values set via an RC file,
3608 * however, they will be overriden if a style is explicitely set on
3609 * the widget using gtk_widget_set_style(). The #GtkRcStyle structure
3610 * is designed so each field can either be set or unset, so it is
3611 * possible, using this function, to modify some style values and
3612 * leave the others unchanged.
3614 * Note that modifications made with this function are not cumulative
3615 * with previous calls to gtk_widget_modify_style() or with such
3616 * functions as gtk_widget_modify_fg(). If you wish to retain
3617 * previous values, you must first call gtk_widget_get_modifier_style(),
3618 * make your modifications to the returned style, then call
3619 * gtk_widget_modify_style() with that style. On the other hand,
3620 * if you first call gtk_widget_modify_style(), subsequent calls
3621 * to such functions gtk_widget_modify_fg() will be have a cumulative
3622 * effect with the inital modifications.
3625 gtk_widget_modify_style (GtkWidget *widget,
3628 GtkRcStyle *old_style;
3630 g_return_if_fail (GTK_IS_RC_STYLE (style));
3632 old_style = gtk_object_get_data_by_id (GTK_OBJECT (widget),
3635 gtk_object_set_data_by_id_full (GTK_OBJECT (widget),
3637 gtk_rc_style_copy (style),
3638 (GtkDestroyNotify)gtk_rc_style_unref);
3640 /* note that "style" may be invalid here if it was the old
3641 * modifier style and the only reference was our own.
3644 if (GTK_WIDGET_RC_STYLE (widget))
3645 gtk_widget_reset_rc_style (widget);
3649 * gtk_widget_get_modifier_style:
3650 * @widget: a #GtkWidget
3652 * Return the current modifier style for the widget. (As set by
3653 * gtk_widget_modify_style().) If no style has previously set, a new
3654 * #GtkRcStyle will be created with all values unset, and set as the
3655 * modifier style for the widget. If you make changes to this rc
3656 * style, you must call gtk_widget_modify_style(), passing in the
3657 * returned rc style, to make sure that your changes take effect.
3659 * Caution: passing the style back to gtk_widget_modify_style() will
3660 * normally end up destroying it, because gtk_widget_modify_style() copies
3661 * the passed-in style and sets the copy as the new modifier style,
3662 * thus dropping any reference to the old modifier style. Add a reference
3663 * to the modifier style if you want to keep it alive.
3665 * Return value: the modifier style for the widget. This rc style is
3666 * owned by the widget. If you want to keep a pointer to value this
3667 * around, you must add a refcount using gtk_rc_style_ref().
3670 gtk_widget_get_modifier_style (GtkWidget *widget)
3672 GtkRcStyle *rc_style;
3674 rc_style = gtk_object_get_data_by_id (GTK_OBJECT (widget),
3679 rc_style = gtk_rc_style_new ();
3680 gtk_object_set_data_by_id_full (GTK_OBJECT (widget),
3683 (GtkDestroyNotify)gtk_rc_style_unref);
3690 gtk_widget_modify_color_component (GtkWidget *widget,
3691 GtkRcFlags component,
3695 GtkRcStyle *rc_style = gtk_widget_get_modifier_style (widget);
3700 rc_style->fg[state] = *color;
3703 rc_style->bg[state] = *color;
3706 rc_style->text[state] = *color;
3709 rc_style->base[state] = *color;
3712 g_assert_not_reached();
3715 rc_style->color_flags[state] |= component;
3717 gtk_widget_modify_style (widget, rc_style);
3721 * gtk_widget_modify_fg:
3722 * @widget: a #GtkWidget
3723 * @state: the state for which to set the foreground color.
3724 * @color: the color to assign (does not need to be allocated)
3726 * Set the foreground color for a widget in a particular state. All
3727 * other style values are left untouched. See also
3728 * gtk_widget_modify_style().
3731 gtk_widget_modify_fg (GtkWidget *widget,
3735 g_return_if_fail (GTK_IS_WIDGET (widget));
3736 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
3737 g_return_if_fail (color != NULL);
3739 gtk_widget_modify_color_component (widget, GTK_RC_FG, state, color);
3743 * gtk_widget_modify_bg:
3744 * @widget: a #GtkWidget
3745 * @state: the state for which to set the foreground color.
3746 * @color: the color to assign (does not need to be allocated)
3748 * Set the background color for a widget in a particular state. All
3749 * other style values are left untouched. See also
3750 * gtk_widget_modify_style().
3753 gtk_widget_modify_bg (GtkWidget *widget,
3757 g_return_if_fail (GTK_IS_WIDGET (widget));
3758 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
3759 g_return_if_fail (color != NULL);
3761 gtk_widget_modify_color_component (widget, GTK_RC_BG, state, color);
3765 * gtk_widget_modify_base:
3766 * @widget: a #GtkWidget
3767 * @state: the state for which to set the foreground color.
3768 * @color: the color to assign (does not need to be allocated)
3770 * Set the text color for a widget in a particular state. All other
3771 * style values are left untouched. The text color is the foreground
3772 * color used along with the base color (see gtk_widget_modify_base)
3773 * for widgets such as #GtkEntry and #GtkTextView. See also
3774 * gtk_widget_modify_style().
3777 gtk_widget_modify_text (GtkWidget *widget,
3781 g_return_if_fail (GTK_IS_WIDGET (widget));
3782 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
3783 g_return_if_fail (color != NULL);
3785 gtk_widget_modify_color_component (widget, GTK_RC_TEXT, state, color);
3789 * gtk_widget_modify_base:
3790 * @widget: a #GtkWidget
3791 * @state: the state for which to set the foreground color.
3792 * @color: the color to assign (does not need to be allocated)
3794 * Set the text color for a widget in a particular state.
3795 * All other style values are left untouched. The base color
3796 * is the background color used along with the text color
3797 * (see gtk_widget_modify_text) for widgets such as #GtkEntry
3798 * and #GtkTextView. See also gtk_widget_modify_style().
3801 gtk_widget_modify_base (GtkWidget *widget,
3805 g_return_if_fail (GTK_IS_WIDGET (widget));
3806 g_return_if_fail (state >= GTK_STATE_NORMAL && state <= GTK_STATE_INSENSITIVE);
3807 g_return_if_fail (color != NULL);
3809 gtk_widget_modify_color_component (widget, GTK_RC_BASE, state, color);
3813 * gtk_widget_modify_font:
3814 * @widget: a #GtkWidget
3815 * @font_desc: the font description to use
3817 * Set the font to use for a widget. All other style values are left
3818 * untouched. See also gtk_widget_modify_style().
3821 gtk_widget_modify_font (GtkWidget *widget,
3822 PangoFontDescription *font_desc)
3824 GtkRcStyle *rc_style;
3826 g_return_if_fail (GTK_IS_WIDGET (widget));
3827 g_return_if_fail (font_desc != NULL);
3829 rc_style = gtk_widget_get_modifier_style (widget);
3831 if (rc_style->font_desc)
3832 pango_font_description_free (rc_style->font_desc);
3834 rc_style->font_desc = pango_font_description_copy (font_desc);
3836 gtk_widget_modify_style (widget, rc_style);
3840 gtk_widget_direction_changed (GtkWidget *widget,
3841 GtkTextDirection previous_direction)
3843 gtk_widget_queue_resize (widget);
3847 gtk_widget_style_set (GtkWidget *widget,
3848 GtkStyle *previous_style)
3850 if (GTK_WIDGET_REALIZED (widget) &&
3851 !GTK_WIDGET_NO_WINDOW (widget))
3852 gtk_style_set_background (widget->style, widget->window, widget->state);
3856 gtk_widget_set_style_internal (GtkWidget *widget,
3858 gboolean initial_emission)
3860 g_return_if_fail (widget != NULL);
3861 g_return_if_fail (GTK_IS_WIDGET (widget));
3862 g_return_if_fail (style != NULL);
3864 g_object_ref (G_OBJECT (widget));
3865 g_object_freeze_notify (G_OBJECT (widget));
3867 if (widget->style != style || initial_emission)
3869 PangoContext *context = gtk_widget_peek_pango_context (widget);
3871 pango_context_set_font_description (context, style->font_desc);
3874 if (widget->style != style)
3876 GtkStyle *previous_style;
3878 if (GTK_WIDGET_REALIZED (widget))
3880 gtk_widget_reset_shapes (widget);
3881 gtk_style_detach (widget->style);
3884 previous_style = widget->style;
3885 widget->style = style;
3886 gtk_style_ref (widget->style);
3888 if (GTK_WIDGET_REALIZED (widget))
3889 widget->style = gtk_style_attach (widget->style, widget->window);
3891 gtk_signal_emit (GTK_OBJECT (widget),
3892 widget_signals[STYLE_SET],
3893 initial_emission ? NULL : previous_style);
3894 gtk_style_unref (previous_style);
3896 if (widget->parent && !initial_emission)
3898 GtkRequisition old_requisition;
3900 old_requisition = widget->requisition;
3901 gtk_widget_size_request (widget, NULL);
3903 if ((old_requisition.width != widget->requisition.width) ||
3904 (old_requisition.height != widget->requisition.height))
3905 gtk_widget_queue_resize (widget);
3906 else if (GTK_WIDGET_DRAWABLE (widget))
3907 gtk_widget_queue_clear (widget);
3910 else if (initial_emission)
3911 gtk_signal_emit (GTK_OBJECT (widget),
3912 widget_signals[STYLE_SET],
3914 g_object_notify (G_OBJECT (widget), "style");
3915 g_object_thaw_notify (G_OBJECT (widget));
3916 g_object_unref (G_OBJECT (widget));
3920 gtk_widget_set_style_recurse (GtkWidget *widget,
3921 gpointer client_data)
3923 if (GTK_WIDGET_RC_STYLE (widget))
3924 gtk_widget_reset_rc_style (widget);
3926 if (GTK_IS_CONTAINER (widget))
3927 gtk_container_forall (GTK_CONTAINER (widget),
3928 gtk_widget_set_style_recurse,
3933 gtk_widget_propagate_hierarchy_changed_recurse (GtkWidget *widget,
3934 gpointer client_data)
3936 gboolean new_anchored;
3938 new_anchored = GTK_WIDGET_TOPLEVEL (widget) ||
3939 (widget->parent && GTK_WIDGET_ANCHORED (widget->parent));
3941 if (GTK_WIDGET_ANCHORED (widget) != new_anchored)
3943 gtk_widget_ref (widget);
3946 GTK_PRIVATE_SET_FLAG (widget, GTK_ANCHORED);
3948 GTK_PRIVATE_UNSET_FLAG (widget, GTK_ANCHORED);
3950 g_signal_emit (GTK_OBJECT (widget), widget_signals[HIERARCHY_CHANGED],
3953 if (GTK_IS_CONTAINER (widget))
3954 gtk_container_forall (GTK_CONTAINER (widget),
3955 gtk_widget_propagate_hierarchy_changed_recurse,
3958 gtk_widget_unref (widget);
3963 * _gtk_widget_propagate_hierarchy_changed:
3964 * @widget: a #GtkWidget
3965 * @previous_toplevel: Previous toplevel
3967 * Propagate changes in the anchored state to a widget and all
3968 * children, unsetting or setting the ANCHORED flag, and
3969 * emitting hierarchy_changed.
3972 _gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
3973 GtkWidget *previous_toplevel)
3975 if (previous_toplevel)
3976 g_object_ref (previous_toplevel);
3978 gtk_widget_propagate_hierarchy_changed_recurse (widget, previous_toplevel);
3980 if (previous_toplevel)
3981 g_object_unref (previous_toplevel);
3985 gtk_widget_reset_rc_styles (GtkWidget *widget)
3987 g_return_if_fail (widget != NULL);
3988 g_return_if_fail (GTK_IS_WIDGET (widget));
3990 gtk_widget_set_style_recurse (widget, NULL);
3994 gtk_widget_get_default_style (void)
3996 if (!gtk_default_style)
3998 gtk_default_style = gtk_style_new ();
3999 gtk_style_ref (gtk_default_style);
4002 return gtk_default_style;
4005 static PangoContext *
4006 gtk_widget_peek_pango_context (GtkWidget *widget)
4008 return gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_pango_context);
4012 * gtk_widget_get_pango_context:
4013 * @widget: a #GtkWidget
4015 * Get a #PangoContext with the appropriate colormap, font description
4016 * and base direction for this widget. Unlike the context returned
4017 * by gtk_widget_create_pango_context(), this context is owned by
4018 * the widget (it can be used as long as widget exists), and will
4019 * be updated to match any changes to the widget's attributes.
4021 * If you create and keep a #PangoLayout using this context, you must
4022 * deal with changes to the context by calling pango_layout_context_changed()
4023 * on the layout in response to the ::style_set and ::direction_set signals
4026 * Return value: the #PangoContext for the widget.
4029 gtk_widget_get_pango_context (GtkWidget *widget)
4031 PangoContext *context;
4033 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4035 context = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_pango_context);
4038 context = gtk_widget_create_pango_context (GTK_WIDGET (widget));
4039 gtk_object_set_data_by_id_full (GTK_OBJECT (widget), quark_pango_context, context,
4040 (GDestroyNotify) g_object_unref);
4047 * gtk_widget_create_pango_context:
4048 * @widget: a #PangoWidget
4050 * Create a new pango context with the appropriate colormap,
4051 * font description, and base direction for drawing text for
4052 * this widget. See also gtk_widget_get_pango_context()
4054 * Return value: the new #PangoContext
4057 gtk_widget_create_pango_context (GtkWidget *widget)
4059 PangoContext *context;
4061 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4063 context = gdk_pango_context_get ();
4065 gdk_pango_context_set_colormap (context, gtk_widget_get_colormap (widget));
4066 pango_context_set_base_dir (context,
4067 gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR ?
4068 PANGO_DIRECTION_LTR : PANGO_DIRECTION_RTL);
4069 pango_context_set_font_description (context, widget->style->font_desc);
4070 pango_context_set_language (context, gtk_get_default_language ());
4076 * gtk_widget_create_pango_layout:
4077 * @widget: a #PangoWidget
4078 * @text: text to set on the layout (can be %NULL)
4080 * Create a new #PangoLayout with the appropriate colormap,
4081 * font description, and base direction for drawing text for
4084 * If you keep a #PangoLayout created in this way around, in order
4085 * notify the layout of changes to the base direction or font of this
4086 * widget, you must call pango_layout_context_changed() in response to
4087 * the ::style_set and ::direction_set signals for the widget.
4089 * Return value: the new #PangoLayout
4092 gtk_widget_create_pango_layout (GtkWidget *widget,
4095 PangoLayout *layout;
4096 PangoContext *context;
4098 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4100 context = gtk_widget_get_pango_context (widget);
4101 layout = pango_layout_new (context);
4104 pango_layout_set_text (layout, text, -1);
4110 * gtk_widget_render_icon:
4111 * @widget: a #GtkWidget
4112 * @stock_id: a stock ID
4113 * @size: a stock size
4114 * @detail: render detail to pass to theme engine
4116 * A convenience function that uses the theme engine and RC file
4117 * settings for @widget to look up @stock_id and render it to
4118 * a pixbuf. @stock_id should be a stock icon ID such as
4119 * #GTK_STOCK_OPEN or #GTK_STOCK_OK. @size should be a size
4120 * such as #GTK_ICON_SIZE_MENU. @detail should be a string that
4121 * identifies the widget or code doing the rendering, so that
4122 * theme engines can special-case rendering for that widget or code.
4124 * Return value: a new pixbuf, or %NULL if the stock ID wasn't known
4127 gtk_widget_render_icon (GtkWidget *widget,
4128 const gchar *stock_id,
4130 const gchar *detail)
4132 GtkIconSet *icon_set;
4135 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4136 g_return_val_if_fail (stock_id != NULL, NULL);
4137 g_return_val_if_fail (size > GTK_ICON_SIZE_INVALID, NULL);
4139 gtk_widget_ensure_style (widget);
4141 icon_set = gtk_style_lookup_icon_set (widget->style, stock_id);
4143 if (icon_set == NULL)
4146 retval = gtk_icon_set_render_icon (icon_set,
4148 gtk_widget_get_direction (widget),
4149 GTK_WIDGET_STATE (widget),
4157 /*************************************************************
4158 * gtk_widget_set_parent_window:
4159 * Set a non default parent window for widget
4166 *************************************************************/
4169 gtk_widget_set_parent_window (GtkWidget *widget,
4170 GdkWindow *parent_window)
4172 GdkWindow *old_parent_window;
4174 g_return_if_fail (widget != NULL);
4175 g_return_if_fail (GTK_IS_WIDGET (widget));
4177 old_parent_window = gtk_object_get_data_by_id (GTK_OBJECT (widget),
4178 quark_parent_window);
4180 if (parent_window != old_parent_window)
4182 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_parent_window,
4184 if (old_parent_window)
4185 gdk_window_unref (old_parent_window);
4187 gdk_window_ref (parent_window);
4191 /*************************************************************
4192 * gtk_widget_get_parent_window:
4193 * Get widget's parent window
4200 *************************************************************/
4203 gtk_widget_get_parent_window (GtkWidget *widget)
4205 GdkWindow *parent_window;
4207 g_return_val_if_fail (widget != NULL, NULL);
4208 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4209 g_return_val_if_fail (widget->parent != NULL, NULL);
4211 parent_window = gtk_object_get_data_by_id (GTK_OBJECT (widget),
4212 quark_parent_window);
4214 return (parent_window != NULL) ? parent_window : widget->parent->window;
4218 * gtk_widget_child_focus:
4219 * @widget: a #GtkWidget
4220 * @direction: direction of focus movement
4222 * This function is used by custom widget implementations; if you're
4223 * writing an app, you'd use gtk_widget_grab_focus() to move the focus
4224 * to a particular widget, and gtk_container_set_focus_chain() to
4225 * change the focus tab order. So you may want to investigate those
4226 * functions instead.
4228 * gtk_widget_child_focus() is called by containers as the user moves
4229 * around the window using keyboard shortcuts. @direction indicates
4230 * what kind of motion is taking place (up, down, left, right, tab
4231 * forward, tab backward). gtk_widget_child_focus() invokes the
4232 * "focus" signal on #GtkWidget; widgets override the default handler
4233 * for this signal in order to implement appropriate focus behavior.
4235 * The "focus" default handler for a widget should return %TRUE if
4236 * moving in @direction left the focus on a focusable location inside
4237 * that widget, and %FALSE if moving in @direction moved the focus
4238 * outside the widget. If returning %TRUE, widgets normally
4239 * call gtk_widget_grab_focus() to place the focus accordingly;
4240 * if returning %FALSE, they don't modify the current focus location.
4242 * This function replaces gtk_container_focus() from GTK+ 1.2. It was
4243 * necessary to check that the child was visible, sensitive, and
4244 * focusable before calling
4245 * gtk_container_focus(). gtk_widget_child_focus() returns %FALSE if
4246 * the widget is not currently in a focusable state, so there's no
4247 * need for those checks.
4249 * Return value: %TRUE if focus ended up inside @widget
4252 gtk_widget_child_focus (GtkWidget *widget,
4253 GtkDirectionType direction)
4255 gboolean return_val;
4257 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4259 if (!GTK_WIDGET_VISIBLE (widget) ||
4260 !GTK_WIDGET_IS_SENSITIVE (widget))
4263 /* child widgets must set CAN_FOCUS, containers
4264 * don't have to though.
4266 if (!GTK_IS_CONTAINER (widget) &&
4267 !GTK_WIDGET_CAN_FOCUS (widget))
4270 gtk_signal_emit (GTK_OBJECT (widget),
4271 widget_signals[FOCUS],
4272 direction, &return_val);
4277 /* Update the position from aux_info. Used from gtk_widget_set_uposition
4278 * and gtk_widget_set_property().
4281 gtk_widget_do_uposition (GtkWidget *widget)
4283 GtkWidgetAuxInfo *aux_info =_gtk_widget_get_aux_info (widget, FALSE);
4285 if (GTK_IS_WINDOW (widget) && aux_info->x_set && aux_info->y_set)
4286 _gtk_window_reposition (GTK_WINDOW (widget), aux_info->x, aux_info->y);
4288 if (GTK_WIDGET_VISIBLE (widget) && widget->parent)
4289 gtk_widget_size_allocate (widget, &widget->allocation);
4291 g_object_freeze_notify (G_OBJECT (widget));
4292 if (aux_info->x_set)
4293 g_object_notify (G_OBJECT (widget), "x");
4294 if (aux_info->y_set)
4295 g_object_notify (G_OBJECT (widget), "y");
4296 g_object_thaw_notify (G_OBJECT (widget));
4300 * gtk_widget_set_uposition:
4301 * @widget: a #GtkWidget
4302 * @x: x position; -1 to unset x; -2 to leave x unchanged
4303 * @y: y position; -1 to unset y; -2 to leave y unchanged
4306 * Sets the position of a widget. The funny "u" in the name comes from
4307 * the "user position" hint specified by the X window system, and
4308 * exists for legacy reasons. This function doesn't work if a widget
4309 * is inside a container; it's only really useful on #GtkWindow.
4311 * Don't use this function to center dialogs over the main application
4312 * window; most window managers will do the centering on your behalf
4313 * if you call gtk_window_set_transient_for(), and it's really not
4314 * possible to get the centering to work correctly in all cases from
4315 * application code. But if you insist, use gtk_window_set_position()
4316 * to set #GTK_WIN_POS_CENTER_ON_PARENT, don't do the centering
4319 * Note that although x and y can be individually unset, the position
4320 * is not honoured unless both x and y are set.
4323 gtk_widget_set_uposition (GtkWidget *widget,
4327 GtkWidgetAuxInfo *aux_info;
4329 g_return_if_fail (widget != NULL);
4330 g_return_if_fail (GTK_IS_WIDGET (widget));
4332 aux_info =_gtk_widget_get_aux_info (widget, TRUE);
4337 aux_info->x_set = FALSE;
4340 aux_info->x_set = TRUE;
4348 aux_info->y_set = FALSE;
4351 aux_info->y_set = TRUE;
4356 gtk_widget_do_uposition (widget);
4360 * gtk_widget_set_usize:
4361 * @widget: a #GtkWidget
4362 * @width: minimum width, or -1 to unset
4363 * @height: minimum height, or -1 to unset
4365 * Sets the minimum size of a widget; that is, the widget's size
4366 * request will be @width by @height. You can use this function to
4367 * force a widget to be either larger or smaller than it is. The
4368 * strange "usize" name dates from the early days of GTK+, and derives
4369 * from X Window System terminology. In many cases,
4370 * gtk_window_set_default_size() is a better choice for toplevel
4371 * windows than this function; setting the default size will still
4372 * allow users to shrink the window. Setting the usize will force them
4373 * to leave the window at least as large as the usize. When dealing
4374 * with window sizes, gtk_window_set_geometry_hints() can be a useful
4377 * Note the inherent danger of setting any fixed size - themes,
4378 * translations into other languages, different fonts, and user action
4379 * can all change the appropriate size for a given widget. So, it's
4380 * basically impossible to hardcode a size that will always be
4385 gtk_widget_set_usize (GtkWidget *widget,
4389 GtkWidgetAuxInfo *aux_info;
4391 g_return_if_fail (widget != NULL);
4392 g_return_if_fail (GTK_IS_WIDGET (widget));
4394 g_object_freeze_notify (G_OBJECT (widget));
4396 aux_info =_gtk_widget_get_aux_info (widget, TRUE);
4400 g_object_notify (G_OBJECT (widget), "width");
4401 aux_info->width = width;
4405 g_object_notify (G_OBJECT (widget), "height");
4406 aux_info->height = height;
4409 if (GTK_WIDGET_VISIBLE (widget))
4410 gtk_widget_queue_resize (widget);
4412 g_object_thaw_notify (G_OBJECT (widget));
4416 * gtk_widget_get_usize:
4417 * @widget: a #GtkWidget
4418 * @width: location to store the width, or %NULL
4419 * @height: location to store the height, or %NULL
4421 * Gets the size that has explicitely set for the widget to request,
4422 * if any. A value of -1 stored in @width or @height indicates that
4423 * that dimension has not been set explicitely and the natural
4424 * requisition of the widget will be used intead. See
4425 * gtk_widget_set_usize().
4428 gtk_widget_get_usize (GtkWidget *widget,
4432 GtkWidgetAuxInfo *aux_info;
4434 g_return_if_fail (GTK_IS_WIDGET (widget));
4436 aux_info = _gtk_widget_get_aux_info (widget, FALSE);
4439 *width = aux_info ? aux_info->width : -1;
4442 *height = aux_info ? aux_info->height : -1;
4446 * gtk_widget_set_events:
4447 * @widget: a #GtkWidget
4448 * @events: event mask
4450 * Sets the event mask (see #GdkEventMask) for a widget. The event
4451 * mask determines which events a widget will receive. Keep in mind
4452 * that different widgets have different default event masks, and by
4453 * changing the event mask you may disrupt a widget's functionality,
4454 * so be careful. This function must be called while a widget is
4455 * unrealized. Consider gtk_widget_add_events() for widgets that are
4456 * already realized, or if you want to preserve the existing event
4457 * mask. This function can't be used with #GTK_NO_WINDOW widgets;
4458 * to get events on those widgets, place them inside a #GtkEventBox
4459 * and receive events on the event box.
4463 gtk_widget_set_events (GtkWidget *widget,
4468 g_return_if_fail (widget != NULL);
4469 g_return_if_fail (GTK_IS_WIDGET (widget));
4470 g_return_if_fail (!GTK_WIDGET_NO_WINDOW (widget));
4471 g_return_if_fail (!GTK_WIDGET_REALIZED (widget));
4473 eventp = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_event_mask);
4478 eventp = g_new (gint, 1);
4481 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_event_mask, eventp);
4486 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_event_mask);
4489 g_object_notify (G_OBJECT (widget), "events");
4493 * gtk_widget_add_events:
4494 * @widget: a #GtkWidget
4495 * @events: an event mask, see #GdkEventMask
4497 * Adds the events in the bitfield @events to the event mask for
4498 * @widget. See gtk_widget_set_events() for details.
4502 gtk_widget_add_events (GtkWidget *widget,
4507 g_return_if_fail (widget != NULL);
4508 g_return_if_fail (GTK_IS_WIDGET (widget));
4509 g_return_if_fail (!GTK_WIDGET_NO_WINDOW (widget));
4511 eventp = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_event_mask);
4517 eventp = g_new (gint, 1);
4522 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_event_mask, eventp);
4527 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_event_mask);
4530 if (GTK_WIDGET_REALIZED (widget))
4532 gdk_window_set_events (widget->window,
4533 gdk_window_get_events (widget->window) | events);
4536 g_object_notify (G_OBJECT (widget), "events");
4540 * gtk_widget_set_extension_events:
4541 * @widget: a #GtkWidget
4542 * @mode: bitfield of extension events to receive
4544 * Sets the extension events mask to @mode. See #GdkExtensionMode
4545 * and gdk_input_set_extension_events().
4549 gtk_widget_set_extension_events (GtkWidget *widget,
4550 GdkExtensionMode mode)
4552 GdkExtensionMode *modep;
4554 g_return_if_fail (widget != NULL);
4555 g_return_if_fail (GTK_IS_WIDGET (widget));
4557 modep = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_extension_event_mode);
4560 modep = g_new (GdkExtensionMode, 1);
4563 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_extension_event_mode, modep);
4564 g_object_notify (G_OBJECT (widget), "extension_events");
4568 * gtk_widget_get_toplevel:
4569 * @widget: a #GtkWidget
4571 * This function returns the topmost widget in the container hierarchy
4572 * @widget is a part of. If @widget has no parent widgets, it will be
4573 * returned as the topmost widget. No reference will be added to the
4574 * returned widget; it should not be unreferenced.
4576 * Note the difference in behavior vs. gtk_widget_get_ancestor();
4577 * gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW) would return
4578 * %NULL if @widget wasn't inside a toplevel window, and if the
4579 * window was inside a GtkWindow-derived widget which was in turn
4580 * inside the toplevel GtkWindow. While the second case may
4581 * seem unlikely, it actually happens when a GtkPlug is embedded
4582 * inside a GtkSocket within the same application
4584 * To reliably find the toplevel GtkWindow, use
4585 * gtk_widget_get_toplevel() and check if the TOPLEVEL flags
4586 * is set on the result.
4588 * GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
4589 * if (GTK_WIDGET_TOPLEVEL (toplevel))
4591 * [ Perform action on toplevel. ]
4594 * Return value: the topmost ancestor of @widget, or @widget itself if there's no ancestor
4597 gtk_widget_get_toplevel (GtkWidget *widget)
4599 g_return_val_if_fail (widget != NULL, NULL);
4600 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4602 while (widget->parent)
4603 widget = widget->parent;
4609 * gtk_widget_get_ancestor:
4610 * @widget: a #GtkWidget
4611 * @widget_type: ancestor type
4613 * Gets the first ancestor of @widget with type @widget_type. For example,
4614 * gtk_widget_get_ancestor (widget, GTK_TYPE_BOX) gets the first #GtkBox that's
4615 * an ancestor of @widget. No reference will be added to the returned widget;
4616 * it should not be unreferenced. See note about checking for a toplevel
4617 * GtkWindow in the docs for gtk_widget_get_toplevel().
4619 * Return value: the ancestor widget, or %NULL if not found
4622 gtk_widget_get_ancestor (GtkWidget *widget,
4623 GtkType widget_type)
4625 g_return_val_if_fail (widget != NULL, NULL);
4626 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4628 while (widget && !gtk_type_is_a (GTK_WIDGET_TYPE (widget), widget_type))
4629 widget = widget->parent;
4631 if (!(widget && gtk_type_is_a (GTK_WIDGET_TYPE (widget), widget_type)))
4638 * gtk_widget_get_colormap:
4639 * @widget: a #GtkWidget
4641 * Gets the colormap that will be used to render @widget. No reference will
4642 * be added to the returned colormap; it should not be unreferenced.
4644 * Return value: the colormap used by @widget
4647 gtk_widget_get_colormap (GtkWidget *widget)
4649 GdkColormap *colormap;
4651 g_return_val_if_fail (widget != NULL, NULL);
4652 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4656 colormap = gdk_window_get_colormap (widget->window);
4657 /* If window was destroyed previously, we'll get NULL here */
4662 colormap = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_colormap);
4666 return gtk_widget_get_default_colormap ();
4670 * gtk_widget_get_visual:
4671 * @widget: a #GtkWidget
4673 * Gets the visual that will be used to render @widget.
4675 * Return value: the visual for @widget
4678 gtk_widget_get_visual (GtkWidget *widget)
4680 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4682 return gdk_colormap_get_visual (gtk_widget_get_colormap (widget));
4686 * gtk_widget_get_settings:
4687 * @widget: a #GtkWidget
4689 * Get the settings object holding the settings (global property
4690 * settings, RC file information, etc) used for this widget.
4692 * Return value: the relevant #GtkSettings object
4695 gtk_widget_get_settings (GtkWidget *widget)
4697 return gtk_settings_get_default ();
4701 * gtk_widget_set_colormap:
4702 * @widget: a #GtkWidget
4703 * @colormap: a colormap
4705 * Set the colormap for the widget to the given value. Widget must not
4706 * have been previously realized. This probably should only be used
4707 * from an init() function (i.e. from the constructor for the widget).
4711 gtk_widget_set_colormap (GtkWidget *widget,
4712 GdkColormap *colormap)
4714 g_return_if_fail (widget != NULL);
4715 g_return_if_fail (GTK_IS_WIDGET (widget));
4716 g_return_if_fail (!GTK_WIDGET_REALIZED (widget));
4717 g_return_if_fail (GDK_IS_COLORMAP (colormap));
4719 g_object_ref (G_OBJECT (colormap));
4721 g_object_set_qdata_full (G_OBJECT (widget),
4724 (GtkDestroyNotify) g_object_unref);
4728 * gtk_widget_get_events:
4729 * @widget: a #GtkWidget
4731 * Returns the event mask for the widget (a bitfield containing flags
4732 * from the #GdkEventMask enumeration). These are the events that the widget
4735 * Return value: event mask for @widget
4738 gtk_widget_get_events (GtkWidget *widget)
4742 g_return_val_if_fail (widget != NULL, 0);
4743 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
4745 events = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_event_mask);
4753 * gtk_widget_get_extension_events:
4754 * @widget: a #GtkWidget
4756 * Retrieves the extension events the widget will receive; see
4757 * gdk_input_set_extension_events().
4759 * Return value: extension events for @widget
4762 gtk_widget_get_extension_events (GtkWidget *widget)
4764 GdkExtensionMode *mode;
4766 g_return_val_if_fail (widget != NULL, 0);
4767 g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
4769 mode = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_extension_event_mode);
4777 * gtk_widget_get_pointer:
4778 * @widget: a #GtkWidget
4779 * @x: return location for the X coordinate, or %NULL
4780 * @y: return location for the Y coordinate, or %NULL
4782 * Obtains the location of the mouse pointer in widget coordinates.
4783 * Widget coordinates are a bit odd; for historical reasons, they are
4784 * defined as widget->window coordinates for widgets that are not
4785 * #GTK_NO_WINDOW widgets, and are relative to widget->allocation.x,
4786 * widget->allocation.y for widgets that are #GTK_NO_WINDOW widgets.
4790 gtk_widget_get_pointer (GtkWidget *widget,
4794 g_return_if_fail (widget != NULL);
4795 g_return_if_fail (GTK_IS_WIDGET (widget));
4802 if (GTK_WIDGET_REALIZED (widget))
4804 gdk_window_get_pointer (widget->window, x, y, NULL);
4806 if (GTK_WIDGET_NO_WINDOW (widget))
4809 *x -= widget->allocation.x;
4811 *y -= widget->allocation.y;
4817 * gtk_widget_is_ancestor:
4818 * @widget: a #GtkWidget
4819 * @ancestor: another #GtkWidget
4821 * Determines whether @widget is somewhere inside @ancestor, possibly with
4822 * intermediate containers.
4824 * Return value: %TRUE if @ancestor contains @widget as a child, grandchild, great grandchild, etc.
4827 gtk_widget_is_ancestor (GtkWidget *widget,
4828 GtkWidget *ancestor)
4830 g_return_val_if_fail (widget != NULL, FALSE);
4831 g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
4832 g_return_val_if_fail (ancestor != NULL, FALSE);
4836 if (widget->parent == ancestor)
4838 widget = widget->parent;
4844 static GQuark quark_composite_name = 0;
4847 gtk_widget_set_composite_name (GtkWidget *widget,
4850 g_return_if_fail (widget != NULL);
4851 g_return_if_fail (GTK_IS_WIDGET (widget));
4852 g_return_if_fail (GTK_WIDGET_COMPOSITE_CHILD (widget));
4853 g_return_if_fail (name != NULL);
4855 if (!quark_composite_name)
4856 quark_composite_name = g_quark_from_static_string ("gtk-composite-name");
4858 gtk_object_set_data_by_id_full (GTK_OBJECT (widget),
4859 quark_composite_name,
4865 gtk_widget_get_composite_name (GtkWidget *widget)
4867 g_return_val_if_fail (widget != NULL, NULL);
4868 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
4870 if (GTK_WIDGET_COMPOSITE_CHILD (widget) && widget->parent)
4871 return gtk_container_child_composite_name (GTK_CONTAINER (widget->parent),
4878 gtk_widget_push_composite_child (void)
4880 composite_child_stack++;
4884 gtk_widget_pop_composite_child (void)
4886 if (composite_child_stack)
4887 composite_child_stack--;
4891 * gtk_widget_push_colormap:
4892 * @cmap: a #GdkColormap
4894 * Pushes @cmap onto a global stack of colormaps; the topmost
4895 * colormap on the stack will be used to create all widgets.
4896 * Remove @cmap with gtk_widget_pop_colormap(). There's little
4897 * reason to use this function.
4901 gtk_widget_push_colormap (GdkColormap *cmap)
4903 g_return_if_fail (cmap != NULL);
4905 colormap_stack = g_slist_prepend (colormap_stack, cmap);
4909 * gtk_widget_pop_colormap:
4911 * Removes a colormap pushed with gtk_widget_push_colormap().
4915 gtk_widget_pop_colormap (void)
4921 tmp = colormap_stack;
4922 colormap_stack = colormap_stack->next;
4923 g_slist_free_1 (tmp);
4928 * gtk_widget_set_default_colormap:
4929 * @colormap: a #GdkColormap
4931 * Sets the default colormap to use when creating widgets.
4932 * gtk_widget_push_colormap() is a better function to use if
4933 * you only want to affect a few widgets, rather than all widgets.
4937 gtk_widget_set_default_colormap (GdkColormap *colormap)
4939 if (default_colormap != colormap)
4941 if (default_colormap)
4942 gdk_colormap_unref (default_colormap);
4943 default_colormap = colormap;
4944 if (default_colormap)
4945 gdk_colormap_ref (default_colormap);
4950 * gtk_widget_get_default_colormap:
4952 * Obtains the default colormap used to create widgets.
4954 * Return value: default widget colormap
4957 gtk_widget_get_default_colormap (void)
4959 if (!default_colormap)
4960 gtk_widget_set_default_colormap (gdk_colormap_get_system ());
4962 return default_colormap;
4966 * gtk_widget_get_default_visual:
4968 * Obtains the visual of the default colormap. Not really useful;
4969 * used to be useful before gdk_colormap_get_visual() existed.
4971 * Return value: visual of the default colormap
4974 gtk_widget_get_default_visual (void)
4976 return gdk_colormap_get_visual (gtk_widget_get_default_colormap ());
4980 gtk_widget_emit_direction_changed (GtkWidget *widget,
4981 GtkTextDirection old_dir)
4983 PangoContext *context = gtk_widget_peek_pango_context (widget);
4986 pango_context_set_base_dir (context,
4987 gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR ?
4988 PANGO_DIRECTION_LTR : PANGO_DIRECTION_RTL);
4990 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[DIRECTION_CHANGED], old_dir);
4994 * gtk_widget_set_direction:
4995 * @widget: a #GtkWidget
4996 * @dir: the new direction
4998 * Set the reading direction on a particular widget. This direction
4999 * controls the primary direction for widgets containing text,
5000 * and also the direction in which the children of a container are
5001 * packed. The ability to set the direction is present in order
5002 * so that correct localization into languages with right-to-left
5003 * reading directions can be done. Generally, applications will
5004 * let the default reading direction present, except for containers
5005 * where the containers are arranged in an order that is explicitely
5006 * visual rather than logical (such as buttons for text justificiation).
5008 * If the direction is set to %GTK_TEXT_DIR_NONE, then the value
5009 * set by gtk_widget_set_default_direction() will be used.
5012 gtk_widget_set_direction (GtkWidget *widget,
5013 GtkTextDirection dir)
5015 GtkTextDirection old_dir;
5017 g_return_if_fail (widget != NULL);
5018 g_return_if_fail (GTK_IS_WIDGET (widget));
5019 g_return_if_fail (dir >= GTK_TEXT_DIR_NONE && dir <= GTK_TEXT_DIR_RTL);
5021 old_dir = gtk_widget_get_direction (widget);
5023 if (dir == GTK_TEXT_DIR_NONE)
5024 GTK_PRIVATE_UNSET_FLAG (widget, GTK_DIRECTION_SET);
5027 GTK_PRIVATE_SET_FLAG (widget, GTK_DIRECTION_SET);
5028 if (dir == GTK_TEXT_DIR_LTR)
5029 GTK_PRIVATE_SET_FLAG (widget, GTK_DIRECTION_LTR);
5031 GTK_PRIVATE_UNSET_FLAG (widget, GTK_DIRECTION_LTR);
5034 if (old_dir != gtk_widget_get_direction (widget))
5035 gtk_widget_emit_direction_changed (widget, old_dir);
5039 * gtk_widget_get_direction:
5040 * @widget: a #GtkWidget
5042 * Get the reading direction for a particular widget. See
5043 * gtk_widget_set_direction().
5045 * Return value: the reading direction for the widget.
5048 gtk_widget_get_direction (GtkWidget *widget)
5050 g_return_val_if_fail (widget != NULL, GTK_TEXT_DIR_LTR);
5051 g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_TEXT_DIR_LTR);
5053 if (GTK_WIDGET_DIRECTION_SET (widget))
5054 return GTK_WIDGET_DIRECTION_LTR (widget) ? GTK_TEXT_DIR_LTR : GTK_TEXT_DIR_RTL;
5056 return gtk_default_direction;
5060 gtk_widget_set_default_direction_recurse (GtkWidget *widget, gpointer data)
5062 GtkTextDirection old_dir = GPOINTER_TO_UINT (data);
5064 g_object_ref (G_OBJECT (widget));
5066 if (!GTK_WIDGET_DIRECTION_SET (widget))
5067 gtk_widget_emit_direction_changed (widget, old_dir);
5069 if (GTK_IS_CONTAINER (widget))
5070 gtk_container_forall (GTK_CONTAINER (widget),
5071 gtk_widget_set_default_direction_recurse,
5074 g_object_unref (G_OBJECT (widget));
5078 * gtk_widget_set_default_direction:
5079 * @dir: the new default direction. This cannot be
5080 * %GTK_TEXT_DIR_NONE.
5082 * Set the default reading direction for widgets where the
5083 * direction has not been explicitly set by gtk_widget_set_direction().
5086 gtk_widget_set_default_direction (GtkTextDirection dir)
5088 g_return_if_fail (dir == GTK_TEXT_DIR_RTL || dir == GTK_TEXT_DIR_LTR);
5090 if (dir != gtk_default_direction)
5092 GList *toplevels, *tmp_list;
5093 GtkTextDirection old_dir = gtk_default_direction;
5095 gtk_default_direction = dir;
5097 tmp_list = toplevels = gtk_window_list_toplevels ();
5098 g_list_foreach (toplevels, (GFunc)g_object_ref, NULL);
5102 gtk_widget_set_default_direction_recurse (tmp_list->data,
5103 GUINT_TO_POINTER (old_dir));
5104 g_object_unref (tmp_list->data);
5105 tmp_list = tmp_list->next;
5108 g_list_free (toplevels);
5113 * gtk_widget_get_default_direction:
5115 * Return value: the current default direction. See
5116 * gtk_widget_set_direction().
5119 gtk_widget_get_default_direction (void)
5121 return gtk_default_direction;
5125 gtk_widget_dispose (GObject *object)
5127 GtkWidget *widget = GTK_WIDGET (object);
5130 gtk_container_remove (GTK_CONTAINER (widget->parent), widget);
5132 GTK_WIDGET_UNSET_FLAGS (widget, GTK_VISIBLE);
5133 if (GTK_WIDGET_REALIZED (widget))
5134 gtk_widget_unrealize (widget);
5136 G_OBJECT_CLASS (parent_class)->dispose (object);
5140 gtk_widget_real_destroy (GtkObject *object)
5144 /* gtk_object_destroy() will already hold a refcount on object
5146 widget = GTK_WIDGET (object);
5148 gtk_grab_remove (widget);
5149 gtk_selection_remove_all (widget);
5151 gtk_style_unref (widget->style);
5152 widget->style = gtk_widget_get_default_style ();
5153 gtk_style_ref (widget->style);
5155 GTK_OBJECT_CLASS (parent_class)->destroy (object);
5159 gtk_widget_finalize (GObject *object)
5161 GtkWidget *widget = GTK_WIDGET (object);
5162 GtkWidgetAuxInfo *aux_info;
5164 GdkExtensionMode *mode;
5165 GtkAccessible *accessible;
5167 gtk_grab_remove (widget);
5168 gtk_selection_remove_all (widget);
5170 gtk_style_unref (widget->style);
5171 widget->style = NULL;
5174 g_free (widget->name);
5176 aux_info =_gtk_widget_get_aux_info (widget, FALSE);
5178 gtk_widget_aux_info_destroy (aux_info);
5180 events = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_event_mask);
5184 mode = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_extension_event_mode);
5188 accessible = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_accessible_object);
5190 g_object_unref (G_OBJECT (accessible));
5192 G_OBJECT_CLASS (parent_class)->finalize (object);
5195 /*****************************************
5196 * gtk_widget_real_map:
5201 *****************************************/
5204 gtk_widget_real_map (GtkWidget *widget)
5206 g_return_if_fail (GTK_IS_WIDGET (widget));
5207 g_return_if_fail (GTK_WIDGET_REALIZED (widget) == TRUE);
5209 if (!GTK_WIDGET_MAPPED (widget))
5211 GTK_WIDGET_SET_FLAGS (widget, GTK_MAPPED);
5213 if (!GTK_WIDGET_NO_WINDOW (widget))
5214 gdk_window_show (widget->window);
5218 /*****************************************
5219 * gtk_widget_real_unmap:
5224 *****************************************/
5227 gtk_widget_real_unmap (GtkWidget *widget)
5229 g_return_if_fail (widget != NULL);
5230 g_return_if_fail (GTK_IS_WIDGET (widget));
5232 if (GTK_WIDGET_MAPPED (widget))
5234 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
5236 if (!GTK_WIDGET_NO_WINDOW (widget))
5237 gdk_window_hide (widget->window);
5241 /*****************************************
5242 * gtk_widget_real_realize:
5247 *****************************************/
5250 gtk_widget_real_realize (GtkWidget *widget)
5252 g_return_if_fail (widget != NULL);
5253 g_return_if_fail (GTK_IS_WIDGET (widget));
5254 g_return_if_fail (GTK_WIDGET_NO_WINDOW (widget));
5256 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
5259 widget->window = gtk_widget_get_parent_window (widget);
5260 gdk_window_ref (widget->window);
5262 widget->style = gtk_style_attach (widget->style, widget->window);
5265 /*****************************************
5266 * gtk_widget_real_unrealize:
5271 *****************************************/
5274 gtk_widget_real_unrealize (GtkWidget *widget)
5276 g_return_if_fail (widget != NULL);
5277 g_return_if_fail (GTK_IS_WIDGET (widget));
5279 if (GTK_WIDGET_MAPPED (widget))
5280 gtk_widget_real_unmap (widget);
5282 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
5284 /* printf ("unrealizing %s\n", gtk_type_name (GTK_OBJECT (widget)->klass->type));
5287 /* We must do unrealize child widget BEFORE container widget.
5288 * gdk_window_destroy() destroys specified xwindow and its sub-xwindows.
5289 * So, unrealizing container widget bofore its children causes the problem
5290 * (for example, gdk_ic_destroy () with destroyed window causes crash. )
5293 if (GTK_IS_CONTAINER (widget))
5294 gtk_container_forall (GTK_CONTAINER (widget),
5295 (GtkCallback) gtk_widget_unrealize,
5298 gtk_style_detach (widget->style);
5299 if (!GTK_WIDGET_NO_WINDOW (widget))
5301 gdk_window_set_user_data (widget->window, NULL);
5302 gdk_window_destroy (widget->window);
5303 widget->window = NULL;
5307 gdk_window_unref (widget->window);
5308 widget->window = NULL;
5311 GTK_WIDGET_UNSET_FLAGS (widget, GTK_REALIZED);
5315 gtk_widget_real_size_request (GtkWidget *widget,
5316 GtkRequisition *requisition)
5318 g_return_if_fail (widget != NULL);
5319 g_return_if_fail (GTK_IS_WIDGET (widget));
5321 requisition->width = widget->requisition.width;
5322 requisition->height = widget->requisition.height;
5325 /*****************************************
5326 * gtk_widget_peek_colormap:
5331 *****************************************/
5334 gtk_widget_peek_colormap (void)
5337 return (GdkColormap*) colormap_stack->data;
5338 return gtk_widget_get_default_colormap ();
5342 gtk_widget_propagate_state (GtkWidget *widget,
5347 /* don't call this function with state==GTK_STATE_INSENSITIVE,
5348 * parent_sensitive==TRUE on a sensitive widget
5351 old_state = GTK_WIDGET_STATE (widget);
5353 if (data->parent_sensitive)
5355 GTK_WIDGET_SET_FLAGS (widget, GTK_PARENT_SENSITIVE);
5357 if (GTK_WIDGET_IS_SENSITIVE (widget))
5359 if (data->state_restoration)
5360 GTK_WIDGET_STATE (widget) = GTK_WIDGET_SAVED_STATE (widget);
5362 GTK_WIDGET_STATE (widget) = data->state;
5366 GTK_WIDGET_STATE (widget) = GTK_STATE_INSENSITIVE;
5367 if (!data->state_restoration &&
5368 data->state != GTK_STATE_INSENSITIVE)
5369 GTK_WIDGET_SAVED_STATE (widget) = data->state;
5374 GTK_WIDGET_UNSET_FLAGS (widget, GTK_PARENT_SENSITIVE);
5375 if (!data->state_restoration)
5377 if (data->state != GTK_STATE_INSENSITIVE)
5378 GTK_WIDGET_SAVED_STATE (widget) = data->state;
5380 else if (GTK_WIDGET_STATE (widget) != GTK_STATE_INSENSITIVE)
5381 GTK_WIDGET_SAVED_STATE (widget) = GTK_WIDGET_STATE (widget);
5382 GTK_WIDGET_STATE (widget) = GTK_STATE_INSENSITIVE;
5385 if (gtk_widget_is_focus (widget) && !GTK_WIDGET_IS_SENSITIVE (widget))
5389 window = gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW);
5391 gtk_window_set_focus (GTK_WINDOW (window), NULL);
5394 if (old_state != GTK_WIDGET_STATE (widget))
5396 gtk_widget_ref (widget);
5398 if (!GTK_WIDGET_IS_SENSITIVE (widget) && GTK_WIDGET_HAS_GRAB (widget))
5399 gtk_grab_remove (widget);
5401 gtk_signal_emit (GTK_OBJECT (widget), widget_signals[STATE_CHANGED], old_state);
5404 if (GTK_IS_CONTAINER (widget))
5406 data->parent_sensitive = (GTK_WIDGET_IS_SENSITIVE (widget) != FALSE);
5407 data->state = GTK_WIDGET_STATE (widget);
5408 if (data->use_forall)
5409 gtk_container_forall (GTK_CONTAINER (widget),
5410 (GtkCallback) gtk_widget_propagate_state,
5413 gtk_container_foreach (GTK_CONTAINER (widget),
5414 (GtkCallback) gtk_widget_propagate_state,
5417 gtk_widget_unref (widget);
5422 * _gtk_widget_get_aux_info:
5423 * @widget: a #GtkWidget
5424 * @create: if %TRUE, create the structure if it doesn't exist
5426 * Get the #GtkWidgetAuxInfo structure for the widget.
5428 * Return value: the #GtkAuxInfo structure for the widget, or
5429 * %NULL if @create is %FALSE and one doesn't already exist.
5432 _gtk_widget_get_aux_info (GtkWidget *widget,
5435 GtkWidgetAuxInfo *aux_info;
5437 aux_info = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_aux_info);
5438 if (!aux_info && create)
5440 if (!aux_info_mem_chunk)
5441 aux_info_mem_chunk = g_mem_chunk_new ("widget aux info mem chunk",
5442 sizeof (GtkWidgetAuxInfo),
5443 1024, G_ALLOC_AND_FREE);
5444 aux_info = g_chunk_new (GtkWidgetAuxInfo, aux_info_mem_chunk);
5446 aux_info->width = -1;
5447 aux_info->height = -1;
5450 aux_info->x_set = FALSE;
5451 aux_info->y_set = FALSE;
5452 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_aux_info, aux_info);
5458 /*****************************************
5459 * gtk_widget_aux_info_destroy:
5464 *****************************************/
5467 gtk_widget_aux_info_destroy (GtkWidgetAuxInfo *aux_info)
5469 g_return_if_fail (aux_info != NULL);
5471 g_mem_chunk_free (aux_info_mem_chunk, aux_info);
5475 gtk_widget_shape_info_destroy (GtkWidgetShapeInfo *info)
5477 gdk_drawable_unref (info->shape_mask);
5481 /*****************************************
5482 * gtk_widget_shape_combine_mask:
5483 * set a shape for this widgets' gdk window, this allows for
5484 * transparent windows etc., see gdk_window_shape_combine_mask
5485 * for more information
5490 *****************************************/
5492 gtk_widget_shape_combine_mask (GtkWidget *widget,
5493 GdkBitmap *shape_mask,
5497 GtkWidgetShapeInfo* shape_info;
5499 g_return_if_fail (widget != NULL);
5500 g_return_if_fail (GTK_IS_WIDGET (widget));
5501 /* set_shape doesn't work on widgets without gdk window */
5502 g_return_if_fail (!GTK_WIDGET_NO_WINDOW (widget));
5506 GTK_PRIVATE_UNSET_FLAG (widget, GTK_HAS_SHAPE_MASK);
5509 gdk_window_shape_combine_mask (widget->window, NULL, 0, 0);
5511 g_object_set_qdata (G_OBJECT (widget), quark_shape_info, NULL);
5515 GTK_PRIVATE_SET_FLAG (widget, GTK_HAS_SHAPE_MASK);
5517 shape_info = g_new (GtkWidgetShapeInfo, 1);
5518 g_object_set_qdata_full (G_OBJECT (widget), quark_shape_info, shape_info,
5519 (GDestroyNotify) gtk_widget_shape_info_destroy);
5521 shape_info->shape_mask = gdk_drawable_ref (shape_mask);
5522 shape_info->offset_x = offset_x;
5523 shape_info->offset_y = offset_y;
5525 /* set shape if widget has a gdk window allready.
5526 * otherwise the shape is scheduled to be set by gtk_widget_realize.
5529 gdk_window_shape_combine_mask (widget->window, shape_mask,
5530 offset_x, offset_y);
5535 gtk_reset_shapes_recurse (GtkWidget *widget,
5541 gdk_window_get_user_data (window, &data);
5545 gdk_window_shape_combine_mask (window, NULL, 0, 0);
5546 for (list = gdk_window_peek_children (window); list; list = list->next)
5547 gtk_reset_shapes_recurse (widget, list->data);
5551 gtk_widget_reset_shapes (GtkWidget *widget)
5553 g_return_if_fail (widget != NULL);
5554 g_return_if_fail (GTK_IS_WIDGET (widget));
5555 g_return_if_fail (GTK_WIDGET_REALIZED (widget));
5557 if (!GTK_WIDGET_HAS_SHAPE_MASK (widget))
5558 gtk_reset_shapes_recurse (widget, widget->window);
5563 * @widget: a #GtkWidget
5565 * Adds a reference to a widget. This function is exactly the same
5566 * as calling g_object_ref(), and exists mostly for historical
5567 * reasons. It can still be convenient to avoid casting a widget
5568 * to a #GObject, it saves a small amount of typing.
5570 * Return value: the widget that was referenced
5573 gtk_widget_ref (GtkWidget *widget)
5575 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5577 return (GtkWidget*) g_object_ref ((GObject*) widget);
5582 * @widget: a #GtkWidget
5584 * Inverse of gtk_widget_ref(). Equivalent to g_object_unref().
5588 gtk_widget_unref (GtkWidget *widget)
5590 g_return_if_fail (GTK_IS_WIDGET (widget));
5592 g_object_unref ((GObject*) widget);
5600 gtk_widget_class_install_style_property_parser (GtkWidgetClass *class,
5602 GtkRcPropertyParser parser)
5604 g_return_if_fail (GTK_IS_WIDGET_CLASS (class));
5605 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
5606 g_return_if_fail (pspec->flags & G_PARAM_READABLE);
5607 g_return_if_fail (!(pspec->flags & (G_PARAM_CONSTRUCT_ONLY | G_PARAM_CONSTRUCT)));
5609 if (g_param_spec_pool_lookup (style_property_spec_pool, pspec->name, G_OBJECT_CLASS_TYPE (class), FALSE))
5611 g_warning (G_STRLOC ": class `%s' already contains a style property named `%s'",
5612 G_OBJECT_CLASS_NAME (class),
5617 g_param_spec_ref (pspec);
5618 g_param_spec_sink (pspec);
5619 g_param_spec_set_qdata (pspec, quark_property_parser, parser);
5620 g_param_spec_pool_insert (style_property_spec_pool, pspec, G_OBJECT_CLASS_TYPE (class));
5624 gtk_widget_class_install_style_property (GtkWidgetClass *class,
5627 GtkRcPropertyParser parser;
5629 g_return_if_fail (GTK_IS_WIDGET_CLASS (class));
5630 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
5632 parser = _gtk_rc_property_parser_from_type (G_PARAM_SPEC_VALUE_TYPE (pspec));
5634 gtk_widget_class_install_style_property_parser (class, pspec, parser);
5638 gtk_widget_style_get_property (GtkWidget *widget,
5639 const gchar *property_name,
5644 g_return_if_fail (GTK_IS_WIDGET (widget));
5645 g_return_if_fail (property_name != NULL);
5646 g_return_if_fail (G_IS_VALUE (value));
5648 g_object_ref (widget);
5649 pspec = g_param_spec_pool_lookup (style_property_spec_pool,
5651 G_OBJECT_TYPE (widget),
5654 g_warning ("%s: widget class `%s' has no property named `%s'",
5656 G_OBJECT_TYPE_NAME (widget),
5660 const GValue *peek_value;
5662 peek_value = _gtk_style_peek_property_value (widget->style,
5663 G_OBJECT_TYPE (widget),
5665 g_param_spec_get_qdata (pspec, quark_property_parser));
5667 /* auto-conversion of the caller's value type
5669 if (G_VALUE_TYPE (value) == G_PARAM_SPEC_VALUE_TYPE (pspec))
5670 g_value_copy (peek_value, value);
5671 else if (g_value_type_transformable (G_PARAM_SPEC_VALUE_TYPE (pspec), G_VALUE_TYPE (value)))
5672 g_value_transform (peek_value, value);
5674 g_warning ("can't retrive style property `%s' of type `%s' as value of type `%s'",
5676 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
5677 G_VALUE_TYPE_NAME (value));
5679 g_object_unref (widget);
5683 gtk_widget_style_get_valist (GtkWidget *widget,
5684 const gchar *first_property_name,
5689 g_return_if_fail (GTK_IS_WIDGET (widget));
5691 g_object_ref (widget);
5693 name = first_property_name;
5696 const GValue *peek_value;
5700 pspec = g_param_spec_pool_lookup (style_property_spec_pool,
5702 G_OBJECT_TYPE (widget),
5706 g_warning ("%s: widget class `%s' has no property named `%s'",
5708 G_OBJECT_TYPE_NAME (widget),
5712 /* style pspecs are always readable so we can spare that check here */
5714 peek_value = _gtk_style_peek_property_value (widget->style,
5715 G_OBJECT_TYPE (widget),
5717 g_param_spec_get_qdata (pspec, quark_property_parser));
5718 G_VALUE_LCOPY (peek_value, var_args, 0, &error);
5721 g_warning ("%s: %s", G_STRLOC, error);
5726 name = va_arg (var_args, gchar*);
5729 g_object_unref (widget);
5733 gtk_widget_style_get (GtkWidget *widget,
5734 const gchar *first_property_name,
5739 g_return_if_fail (GTK_IS_WIDGET (widget));
5741 va_start (var_args, first_property_name);
5742 gtk_widget_style_get_valist (widget, first_property_name, var_args);
5748 * @widget: a #GtkWidget
5749 * @path_length: location to store length of the path
5750 * @path: location to store allocated path string
5751 * @path_reversed: location to store allocated reverse path string
5753 * Obtains the full path to @widget. The path is simply the name of a
5754 * widget and all its parents in the container hierarchy, separated by
5755 * periods. The name of a widget comes from
5756 * gtk_widget_get_name(). Paths are used to apply styles to a widget
5757 * in gtkrc configuration files. Widget names are the type of the
5758 * widget by default (e.g. "GtkButton") or can be set to an
5759 * application-specific value with gtk_widget_set_name(). By setting
5760 * the name of a widget, you allow users or theme authors to apply
5761 * styles to that specific widget in their gtkrc
5762 * file. @path_reversed_p fills in the path in reverse order,
5763 * i.e. starting with @widget's name instead of starting with the name
5764 * of @widget's outermost ancestor.
5768 gtk_widget_path (GtkWidget *widget,
5769 guint *path_length_p,
5771 gchar **path_reversed_p)
5773 static gchar *rev_path = NULL;
5774 static guint path_len = 0;
5777 g_return_if_fail (widget != NULL);
5778 g_return_if_fail (GTK_IS_WIDGET (widget));
5783 const gchar *string;
5788 string = gtk_widget_get_name (widget);
5789 l = strlen (string);
5790 while (path_len <= len + l + 1)
5792 path_len += INIT_PATH_SIZE;
5793 rev_path = g_realloc (rev_path, path_len);
5801 widget = widget->parent;
5804 rev_path[len++] = '.';
5806 rev_path[len++] = 0;
5811 *path_length_p = len - 1;
5812 if (path_reversed_p)
5813 *path_reversed_p = g_strdup (rev_path);
5816 *path_p = g_strdup (rev_path);
5817 g_strreverse (*path_p);
5822 * gtk_widget_class_path:
5823 * @widget: a #GtkWidget
5824 * @path_length: location to store the length of the class path
5825 * @path: location to store the class path as an allocated string
5826 * @path_reversed: location to store the reverse class path as an allocated string
5828 * Same as gtk_widget_path(), but always uses the name of a widget's type,
5829 * never uses a custom name set with gtk_widget_set_name().
5833 gtk_widget_class_path (GtkWidget *widget,
5834 guint *path_length_p,
5836 gchar **path_reversed_p)
5838 static gchar *rev_path = NULL;
5839 static guint path_len = 0;
5842 g_return_if_fail (widget != NULL);
5843 g_return_if_fail (GTK_IS_WIDGET (widget));
5848 const gchar *string;
5853 string = gtk_type_name (GTK_WIDGET_TYPE (widget));
5854 l = strlen (string);
5855 while (path_len <= len + l + 1)
5857 path_len += INIT_PATH_SIZE;
5858 rev_path = g_realloc (rev_path, path_len);
5866 widget = widget->parent;
5869 rev_path[len++] = '.';
5871 rev_path[len++] = 0;
5876 *path_length_p = len - 1;
5877 if (path_reversed_p)
5878 *path_reversed_p = g_strdup (rev_path);
5881 *path_p = g_strdup (rev_path);
5882 g_strreverse (*path_p);
5887 gtk_requisition_copy (const GtkRequisition *requisition)
5889 return (GtkRequisition *)g_memdup (requisition, sizeof (GtkRequisition));
5893 gtk_requisition_free (GtkRequisition *requisition)
5895 g_free (requisition);
5898 AtkObject* gtk_widget_get_accessible (GtkWidget *widget)
5900 GtkWidgetClass *klass;
5902 g_return_val_if_fail (widget != NULL, NULL);
5903 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5905 klass = GTK_WIDGET_GET_CLASS (widget);
5907 g_return_val_if_fail (klass->get_accessible != NULL, NULL);
5909 return klass->get_accessible (widget);
5912 AtkObject* gtk_widget_real_get_accessible (GtkWidget *widget)
5914 AtkObject* accessible;
5916 accessible = g_object_get_qdata (G_OBJECT (widget),
5917 quark_accessible_object);
5920 AtkObjectFactory *factory;
5921 AtkRegistry *default_registry;
5923 default_registry = atk_get_default_registry ();
5924 factory = atk_registry_get_factory (default_registry,
5925 GTK_OBJECT_TYPE (widget));
5927 atk_object_factory_create_accessible (factory,
5929 g_object_set_qdata (G_OBJECT (widget),
5930 quark_accessible_object,
5937 * Initialize a AtkImplementorIface instance's virtual pointers as
5938 * appropriate to this implementor's class (GtkWidget).
5941 gtk_widget_accessible_interface_init (AtkImplementorIface *iface)
5943 iface->ref_accessible = gtk_widget_ref_accessible;
5947 gtk_widget_ref_accessible (AtkImplementor *implementor)
5949 AtkObject *accessible;
5951 accessible = gtk_widget_get_accessible (GTK_WIDGET (implementor));
5953 g_object_ref (G_OBJECT (accessible));