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/.
27 #ifndef __GTK_WIDGET_H__
28 #define __GTK_WIDGET_H__
31 #include <gtk/gtkaccelgroup.h>
32 #include <gtk/gtkobject.h>
33 #include <gtk/gtkadjustment.h>
34 #include <gtk/gtkstyle.h>
35 #include <gtk/gtksettings.h>
36 #include <atk/atkobject.h>
40 /* The flags that are used by GtkWidget on top of the
41 * flags field of GtkObject.
45 GTK_TOPLEVEL = 1 << 4,
46 GTK_NO_WINDOW = 1 << 5,
47 GTK_REALIZED = 1 << 6,
50 GTK_SENSITIVE = 1 << 9,
51 GTK_PARENT_SENSITIVE = 1 << 10,
52 GTK_CAN_FOCUS = 1 << 11,
53 GTK_HAS_FOCUS = 1 << 12,
55 /* widget is allowed to receive the default via gtk_widget_grab_default
56 * and will reserve space to draw the default if possible
58 GTK_CAN_DEFAULT = 1 << 13,
60 /* the widget currently is receiving the default action and should be drawn
61 * appropriately if possible
63 GTK_HAS_DEFAULT = 1 << 14,
65 GTK_HAS_GRAB = 1 << 15,
66 GTK_RC_STYLE = 1 << 16,
67 GTK_COMPOSITE_CHILD = 1 << 17,
68 GTK_NO_REPARENT = 1 << 18,
69 GTK_APP_PAINTABLE = 1 << 19,
71 /* the widget when focused will receive the default action and have
72 * HAS_DEFAULT set even if there is a different widget set as default
74 GTK_RECEIVES_DEFAULT = 1 << 20,
76 GTK_DOUBLE_BUFFERED = 1 << 21,
77 GTK_NO_SHOW_ALL = 1 << 22
80 /* Kinds of widget-specific help */
83 GTK_WIDGET_HELP_TOOLTIP,
84 GTK_WIDGET_HELP_WHATS_THIS
87 /* Macro for casting a pointer to a GtkWidget or GtkWidgetClass pointer.
88 * Macros for testing whether `widget' or `klass' are of type GTK_TYPE_WIDGET.
90 #define GTK_TYPE_WIDGET (gtk_widget_get_type ())
91 #define GTK_WIDGET(widget) (G_TYPE_CHECK_INSTANCE_CAST ((widget), GTK_TYPE_WIDGET, GtkWidget))
92 #define GTK_WIDGET_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WIDGET, GtkWidgetClass))
93 #define GTK_IS_WIDGET(widget) (G_TYPE_CHECK_INSTANCE_TYPE ((widget), GTK_TYPE_WIDGET))
94 #define GTK_IS_WIDGET_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WIDGET))
95 #define GTK_WIDGET_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WIDGET, GtkWidgetClass))
97 /* Macros for extracting various fields from GtkWidget and GtkWidgetClass.
99 #define GTK_WIDGET_TYPE(wid) (GTK_OBJECT_TYPE (wid))
100 #define GTK_WIDGET_STATE(wid) (GTK_WIDGET (wid)->state)
101 #define GTK_WIDGET_SAVED_STATE(wid) (GTK_WIDGET (wid)->saved_state)
103 /* Macros for extracting the widget flags from GtkWidget.
105 #define GTK_WIDGET_FLAGS(wid) (GTK_OBJECT_FLAGS (wid))
106 #define GTK_WIDGET_TOPLEVEL(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_TOPLEVEL) != 0)
107 #define GTK_WIDGET_NO_WINDOW(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_NO_WINDOW) != 0)
108 #define GTK_WIDGET_REALIZED(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_REALIZED) != 0)
109 #define GTK_WIDGET_MAPPED(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_MAPPED) != 0)
110 #define GTK_WIDGET_VISIBLE(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_VISIBLE) != 0)
111 #define GTK_WIDGET_DRAWABLE(wid) (GTK_WIDGET_VISIBLE (wid) && GTK_WIDGET_MAPPED (wid))
112 #define GTK_WIDGET_SENSITIVE(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_SENSITIVE) != 0)
113 #define GTK_WIDGET_PARENT_SENSITIVE(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_PARENT_SENSITIVE) != 0)
114 #define GTK_WIDGET_IS_SENSITIVE(wid) (GTK_WIDGET_SENSITIVE (wid) && \
115 GTK_WIDGET_PARENT_SENSITIVE (wid))
116 #define GTK_WIDGET_CAN_FOCUS(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_CAN_FOCUS) != 0)
117 #define GTK_WIDGET_HAS_FOCUS(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_FOCUS) != 0)
118 #define GTK_WIDGET_CAN_DEFAULT(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_CAN_DEFAULT) != 0)
119 #define GTK_WIDGET_HAS_DEFAULT(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_DEFAULT) != 0)
120 #define GTK_WIDGET_HAS_GRAB(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_GRAB) != 0)
121 #define GTK_WIDGET_RC_STYLE(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_RC_STYLE) != 0)
122 #define GTK_WIDGET_COMPOSITE_CHILD(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_COMPOSITE_CHILD) != 0)
123 #define GTK_WIDGET_APP_PAINTABLE(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_APP_PAINTABLE) != 0)
124 #define GTK_WIDGET_RECEIVES_DEFAULT(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_RECEIVES_DEFAULT) != 0)
125 #define GTK_WIDGET_DOUBLE_BUFFERED(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_DOUBLE_BUFFERED) != 0)
127 /* Macros for setting and clearing widget flags.
129 #define GTK_WIDGET_SET_FLAGS(wid,flag) G_STMT_START{ (GTK_WIDGET_FLAGS (wid) |= (flag)); }G_STMT_END
130 #define GTK_WIDGET_UNSET_FLAGS(wid,flag) G_STMT_START{ (GTK_WIDGET_FLAGS (wid) &= ~(flag)); }G_STMT_END
132 #define GTK_TYPE_REQUISITION (gtk_requisition_get_type ())
134 /* forward declaration to avoid excessive includes (and concurrent includes)
136 typedef struct _GtkRequisition GtkRequisition;
137 typedef GdkRectangle GtkAllocation;
138 typedef struct _GtkSelectionData GtkSelectionData;
139 typedef struct _GtkWidgetClass GtkWidgetClass;
140 typedef struct _GtkWidgetAuxInfo GtkWidgetAuxInfo;
141 typedef struct _GtkWidgetShapeInfo GtkWidgetShapeInfo;
142 typedef struct _GtkClipboard GtkClipboard;
143 typedef void (*GtkCallback) (GtkWidget *widget,
146 /* A requisition is a desired amount of space which a
147 * widget may request.
149 struct _GtkRequisition
155 /* The widget is the base of the tree for displayable objects.
156 * (A displayable object is one which takes up some amount
157 * of screen real estate). It provides a common base and interface
158 * which actual widgets must adhere to.
162 /* The object structure needs to be the first
163 * element in the widget structure in order for
164 * the object mechanism to work correctly. This
165 * allows a GtkWidget pointer to be cast to a
170 /* 16 bits of internally used private flags.
171 * this will be packed into the same 4 byte alignment frame that
172 * state and saved_state go. we therefore don't waste any new
175 guint16 private_flags;
177 /* The state of the widget. There are actually only
178 * 5 widget states (defined in "gtkenums.h").
182 /* The saved state of the widget. When a widget's state
183 * is changed to GTK_STATE_INSENSITIVE via
184 * "gtk_widget_set_state" or "gtk_widget_set_sensitive"
185 * the old state is kept around in this field. The state
186 * will be restored once the widget gets sensitive again.
190 /* The widget's name. If the widget does not have a name
191 * (the name is NULL), then its name (as returned by
192 * "gtk_widget_get_name") is its class's name.
193 * Among other things, the widget name is used to determine
194 * the style to use for a widget.
200 /* The style for the widget. The style contains the
201 * colors the widget should be drawn in for each state
202 * along with graphics contexts used to draw with and
203 * the font to use for text.
207 /* The widget's desired size.
209 GtkRequisition requisition;
211 /* The widget's allocated size.
213 GtkAllocation allocation;
215 /* The widget's window or its parent window if it does
216 * not have a window. (Which will be indicated by the
217 * GTK_NO_WINDOW flag being set).
221 /* The widget's parent.
226 struct _GtkWidgetClass
228 /* The object class structure needs to be the first
229 * element in the widget class structure in order for
230 * the class mechanism to work correctly. This allows a
231 * GtkWidgetClass pointer to be cast to a GtkObjectClass
234 GtkObjectClass parent_class;
238 guint activate_signal;
240 guint set_scroll_adjustments_signal;
244 /* seldomly overidden */
245 void (*dispatch_child_properties_changed) (GtkWidget *widget,
247 GParamSpec **pspecs);
250 void (* show) (GtkWidget *widget);
251 void (* show_all) (GtkWidget *widget);
252 void (* hide) (GtkWidget *widget);
253 void (* hide_all) (GtkWidget *widget);
254 void (* map) (GtkWidget *widget);
255 void (* unmap) (GtkWidget *widget);
256 void (* realize) (GtkWidget *widget);
257 void (* unrealize) (GtkWidget *widget);
258 void (* size_request) (GtkWidget *widget,
259 GtkRequisition *requisition);
260 void (* size_allocate) (GtkWidget *widget,
261 GtkAllocation *allocation);
262 void (* state_changed) (GtkWidget *widget,
263 GtkStateType previous_state);
264 void (* parent_set) (GtkWidget *widget,
265 GtkWidget *previous_parent);
266 void (* hierarchy_changed) (GtkWidget *widget,
267 GtkWidget *previous_toplevel);
268 void (* style_set) (GtkWidget *widget,
269 GtkStyle *previous_style);
270 void (* direction_changed) (GtkWidget *widget,
271 GtkTextDirection previous_direction);
272 void (* grab_notify) (GtkWidget *widget,
273 gboolean was_grabbed);
274 void (* child_notify) (GtkWidget *widget,
278 gboolean (* mnemonic_activate) (GtkWidget *widget,
279 gboolean group_cycling);
282 void (* grab_focus) (GtkWidget *widget);
283 gboolean (* focus) (GtkWidget *widget,
284 GtkDirectionType direction);
287 gboolean (* event) (GtkWidget *widget,
289 gboolean (* button_press_event) (GtkWidget *widget,
290 GdkEventButton *event);
291 gboolean (* button_release_event) (GtkWidget *widget,
292 GdkEventButton *event);
293 gboolean (* scroll_event) (GtkWidget *widget,
294 GdkEventScroll *event);
295 gboolean (* motion_notify_event) (GtkWidget *widget,
296 GdkEventMotion *event);
297 gboolean (* delete_event) (GtkWidget *widget,
299 gboolean (* destroy_event) (GtkWidget *widget,
301 gboolean (* expose_event) (GtkWidget *widget,
302 GdkEventExpose *event);
303 gboolean (* key_press_event) (GtkWidget *widget,
305 gboolean (* key_release_event) (GtkWidget *widget,
307 gboolean (* enter_notify_event) (GtkWidget *widget,
308 GdkEventCrossing *event);
309 gboolean (* leave_notify_event) (GtkWidget *widget,
310 GdkEventCrossing *event);
311 gboolean (* configure_event) (GtkWidget *widget,
312 GdkEventConfigure *event);
313 gboolean (* focus_in_event) (GtkWidget *widget,
314 GdkEventFocus *event);
315 gboolean (* focus_out_event) (GtkWidget *widget,
316 GdkEventFocus *event);
317 gboolean (* map_event) (GtkWidget *widget,
319 gboolean (* unmap_event) (GtkWidget *widget,
321 gboolean (* property_notify_event) (GtkWidget *widget,
322 GdkEventProperty *event);
323 gboolean (* selection_clear_event) (GtkWidget *widget,
324 GdkEventSelection *event);
325 gboolean (* selection_request_event) (GtkWidget *widget,
326 GdkEventSelection *event);
327 gboolean (* selection_notify_event) (GtkWidget *widget,
328 GdkEventSelection *event);
329 gboolean (* proximity_in_event) (GtkWidget *widget,
330 GdkEventProximity *event);
331 gboolean (* proximity_out_event) (GtkWidget *widget,
332 GdkEventProximity *event);
333 gboolean (* visibility_notify_event) (GtkWidget *widget,
334 GdkEventVisibility *event);
335 gboolean (* client_event) (GtkWidget *widget,
336 GdkEventClient *event);
337 gboolean (* no_expose_event) (GtkWidget *widget,
339 gboolean (* window_state_event) (GtkWidget *widget,
340 GdkEventWindowState *event);
343 void (* selection_get) (GtkWidget *widget,
344 GtkSelectionData *selection_data,
347 void (* selection_received) (GtkWidget *widget,
348 GtkSelectionData *selection_data,
351 /* Source side drag signals */
352 void (* drag_begin) (GtkWidget *widget,
353 GdkDragContext *context);
354 void (* drag_end) (GtkWidget *widget,
355 GdkDragContext *context);
356 void (* drag_data_get) (GtkWidget *widget,
357 GdkDragContext *context,
358 GtkSelectionData *selection_data,
361 void (* drag_data_delete) (GtkWidget *widget,
362 GdkDragContext *context);
364 /* Target side drag signals */
365 void (* drag_leave) (GtkWidget *widget,
366 GdkDragContext *context,
368 gboolean (* drag_motion) (GtkWidget *widget,
369 GdkDragContext *context,
373 gboolean (* drag_drop) (GtkWidget *widget,
374 GdkDragContext *context,
378 void (* drag_data_received) (GtkWidget *widget,
379 GdkDragContext *context,
382 GtkSelectionData *selection_data,
386 /* Signals used only for keybindings */
387 gboolean (* popup_menu) (GtkWidget *widget);
389 /* If a widget has multiple tooltips/whatsthis, it should show the
390 * one for the current focus location, or if that doesn't make
391 * sense, should cycle through them showing each tip alongside
392 * whatever piece of the widget it applies to.
394 gboolean (* show_help) (GtkWidget *widget,
395 GtkWidgetHelpType help_type);
397 /* accessibility support
399 AtkObject* (*get_accessible) (GtkWidget *widget);
401 void (*screen_changed) (GtkWidget *widget,
402 GdkScreen *previous_screen);
403 gboolean (*can_activate_accel) (GtkWidget *widget,
406 /* Sent when a grab is broken. */
407 gboolean (*grab_broken_event) (GtkWidget *widget,
408 GdkEventGrabBroken *event);
410 /* Padding for future expansion */
411 void (*_gtk_reserved3) (void);
412 void (*_gtk_reserved4) (void);
413 void (*_gtk_reserved5) (void);
414 void (*_gtk_reserved6) (void);
415 void (*_gtk_reserved7) (void);
418 struct _GtkWidgetAuxInfo
428 struct _GtkWidgetShapeInfo
432 GdkBitmap *shape_mask;
435 GType gtk_widget_get_type (void) G_GNUC_CONST;
436 GtkWidget* gtk_widget_new (GType type,
437 const gchar *first_property_name,
438 ...) G_GNUC_NULL_TERMINATED;
439 GtkWidget* gtk_widget_ref (GtkWidget *widget);
440 void gtk_widget_unref (GtkWidget *widget);
441 void gtk_widget_destroy (GtkWidget *widget);
442 void gtk_widget_destroyed (GtkWidget *widget,
443 GtkWidget **widget_pointer);
444 #ifndef GTK_DISABLE_DEPRECATED
445 void gtk_widget_set (GtkWidget *widget,
446 const gchar *first_property_name,
447 ...) G_GNUC_NULL_TERMINATED;
448 #endif /* GTK_DISABLE_DEPRECATED */
449 void gtk_widget_unparent (GtkWidget *widget);
450 void gtk_widget_show (GtkWidget *widget);
451 void gtk_widget_show_now (GtkWidget *widget);
452 void gtk_widget_hide (GtkWidget *widget);
453 void gtk_widget_show_all (GtkWidget *widget);
454 void gtk_widget_hide_all (GtkWidget *widget);
455 void gtk_widget_set_no_show_all (GtkWidget *widget,
456 gboolean no_show_all);
457 gboolean gtk_widget_get_no_show_all (GtkWidget *widget);
458 void gtk_widget_map (GtkWidget *widget);
459 void gtk_widget_unmap (GtkWidget *widget);
460 void gtk_widget_realize (GtkWidget *widget);
461 void gtk_widget_unrealize (GtkWidget *widget);
464 void gtk_widget_queue_draw (GtkWidget *widget);
465 void gtk_widget_queue_draw_area (GtkWidget *widget,
470 #ifndef GTK_DISABLE_DEPRECATED
471 void gtk_widget_queue_clear (GtkWidget *widget);
472 void gtk_widget_queue_clear_area (GtkWidget *widget,
477 #endif /* GTK_DISABLE_DEPRECATED */
480 void gtk_widget_queue_resize (GtkWidget *widget);
481 void gtk_widget_queue_resize_no_redraw (GtkWidget *widget);
482 #ifndef GTK_DISABLE_DEPRECATED
483 void gtk_widget_draw (GtkWidget *widget,
485 #endif /* GTK_DISABLE_DEPRECATED */
486 void gtk_widget_size_request (GtkWidget *widget,
487 GtkRequisition *requisition);
488 void gtk_widget_size_allocate (GtkWidget *widget,
489 GtkAllocation *allocation);
490 void gtk_widget_get_child_requisition (GtkWidget *widget,
491 GtkRequisition *requisition);
492 void gtk_widget_add_accelerator (GtkWidget *widget,
493 const gchar *accel_signal,
494 GtkAccelGroup *accel_group,
496 GdkModifierType accel_mods,
497 GtkAccelFlags accel_flags);
498 gboolean gtk_widget_remove_accelerator (GtkWidget *widget,
499 GtkAccelGroup *accel_group,
501 GdkModifierType accel_mods);
502 void gtk_widget_set_accel_path (GtkWidget *widget,
503 const gchar *accel_path,
504 GtkAccelGroup *accel_group);
505 const gchar* _gtk_widget_get_accel_path (GtkWidget *widget,
507 GList* gtk_widget_list_accel_closures (GtkWidget *widget);
508 gboolean gtk_widget_can_activate_accel (GtkWidget *widget,
510 gboolean gtk_widget_mnemonic_activate (GtkWidget *widget,
511 gboolean group_cycling);
512 gboolean gtk_widget_event (GtkWidget *widget,
514 gint gtk_widget_send_expose (GtkWidget *widget,
517 gboolean gtk_widget_activate (GtkWidget *widget);
518 gboolean gtk_widget_set_scroll_adjustments (GtkWidget *widget,
519 GtkAdjustment *hadjustment,
520 GtkAdjustment *vadjustment);
522 void gtk_widget_reparent (GtkWidget *widget,
523 GtkWidget *new_parent);
524 gboolean gtk_widget_intersect (GtkWidget *widget,
526 GdkRectangle *intersection);
527 GdkRegion *gtk_widget_region_intersect (GtkWidget *widget,
530 void gtk_widget_freeze_child_notify (GtkWidget *widget);
531 void gtk_widget_child_notify (GtkWidget *widget,
532 const gchar *child_property);
533 void gtk_widget_thaw_child_notify (GtkWidget *widget);
535 gboolean gtk_widget_is_focus (GtkWidget *widget);
536 void gtk_widget_grab_focus (GtkWidget *widget);
537 void gtk_widget_grab_default (GtkWidget *widget);
539 void gtk_widget_set_name (GtkWidget *widget,
541 G_CONST_RETURN gchar* gtk_widget_get_name (GtkWidget *widget);
542 void gtk_widget_set_state (GtkWidget *widget,
544 void gtk_widget_set_sensitive (GtkWidget *widget,
546 void gtk_widget_set_app_paintable (GtkWidget *widget,
547 gboolean app_paintable);
548 void gtk_widget_set_double_buffered (GtkWidget *widget,
549 gboolean double_buffered);
550 void gtk_widget_set_redraw_on_allocate (GtkWidget *widget,
551 gboolean redraw_on_allocate);
552 void gtk_widget_set_parent (GtkWidget *widget,
554 void gtk_widget_set_parent_window (GtkWidget *widget,
555 GdkWindow *parent_window);
556 void gtk_widget_set_child_visible (GtkWidget *widget,
557 gboolean is_visible);
558 gboolean gtk_widget_get_child_visible (GtkWidget *widget);
560 GtkWidget *gtk_widget_get_parent (GtkWidget *widget);
561 GdkWindow *gtk_widget_get_parent_window (GtkWidget *widget);
563 gboolean gtk_widget_child_focus (GtkWidget *widget,
564 GtkDirectionType direction);
566 void gtk_widget_set_size_request (GtkWidget *widget,
569 void gtk_widget_get_size_request (GtkWidget *widget,
572 #ifndef GTK_DISABLE_DEPRECATED
573 void gtk_widget_set_uposition (GtkWidget *widget,
576 void gtk_widget_set_usize (GtkWidget *widget,
581 void gtk_widget_set_events (GtkWidget *widget,
583 void gtk_widget_add_events (GtkWidget *widget,
585 void gtk_widget_set_extension_events (GtkWidget *widget,
586 GdkExtensionMode mode);
588 GdkExtensionMode gtk_widget_get_extension_events (GtkWidget *widget);
589 GtkWidget* gtk_widget_get_toplevel (GtkWidget *widget);
590 GtkWidget* gtk_widget_get_ancestor (GtkWidget *widget,
592 GdkColormap* gtk_widget_get_colormap (GtkWidget *widget);
593 GdkVisual* gtk_widget_get_visual (GtkWidget *widget);
595 GdkScreen * gtk_widget_get_screen (GtkWidget *widget);
596 gboolean gtk_widget_has_screen (GtkWidget *widget);
597 GdkDisplay * gtk_widget_get_display (GtkWidget *widget);
598 GdkWindow * gtk_widget_get_root_window (GtkWidget *widget);
599 GtkSettings* gtk_widget_get_settings (GtkWidget *widget);
600 GtkClipboard *gtk_widget_get_clipboard (GtkWidget *widget,
603 #ifndef GTK_DISABLE_DEPRECATED
604 #define gtk_widget_set_visual(widget,visual) ((void) 0)
605 #define gtk_widget_push_visual(visual) ((void) 0)
606 #define gtk_widget_pop_visual() ((void) 0)
607 #define gtk_widget_set_default_visual(visual) ((void) 0)
608 #endif /* GTK_DISABLE_DEPRECATED */
610 /* Accessibility support */
611 AtkObject* gtk_widget_get_accessible (GtkWidget *widget);
613 /* The following functions must not be called on an already
614 * realized widget. Because it is possible that somebody
615 * can call get_colormap() or get_visual() and save the
616 * result, these functions are probably only safe to
617 * call in a widget's init() function.
619 void gtk_widget_set_colormap (GtkWidget *widget,
620 GdkColormap *colormap);
622 gint gtk_widget_get_events (GtkWidget *widget);
623 void gtk_widget_get_pointer (GtkWidget *widget,
627 gboolean gtk_widget_is_ancestor (GtkWidget *widget,
628 GtkWidget *ancestor);
630 gboolean gtk_widget_translate_coordinates (GtkWidget *src_widget,
631 GtkWidget *dest_widget,
637 /* Hide widget and return TRUE.
639 gboolean gtk_widget_hide_on_delete (GtkWidget *widget);
643 void gtk_widget_set_style (GtkWidget *widget,
645 void gtk_widget_ensure_style (GtkWidget *widget);
646 GtkStyle* gtk_widget_get_style (GtkWidget *widget);
648 void gtk_widget_modify_style (GtkWidget *widget,
650 GtkRcStyle *gtk_widget_get_modifier_style (GtkWidget *widget);
651 void gtk_widget_modify_fg (GtkWidget *widget,
653 const GdkColor *color);
654 void gtk_widget_modify_bg (GtkWidget *widget,
656 const GdkColor *color);
657 void gtk_widget_modify_text (GtkWidget *widget,
659 const GdkColor *color);
660 void gtk_widget_modify_base (GtkWidget *widget,
662 const GdkColor *color);
663 void gtk_widget_modify_font (GtkWidget *widget,
664 PangoFontDescription *font_desc);
666 #ifndef GTK_DISABLE_DEPRECATED
667 #define gtk_widget_set_rc_style(widget) (gtk_widget_set_style (widget, NULL))
668 #define gtk_widget_restore_default_style(widget) (gtk_widget_set_style (widget, NULL))
671 PangoContext *gtk_widget_create_pango_context (GtkWidget *widget);
672 PangoContext *gtk_widget_get_pango_context (GtkWidget *widget);
673 PangoLayout *gtk_widget_create_pango_layout (GtkWidget *widget,
676 GdkPixbuf *gtk_widget_render_icon (GtkWidget *widget,
677 const gchar *stock_id,
679 const gchar *detail);
681 /* handle composite names for GTK_COMPOSITE_CHILD widgets,
682 * the returned name is newly allocated.
684 void gtk_widget_set_composite_name (GtkWidget *widget,
686 gchar* gtk_widget_get_composite_name (GtkWidget *widget);
688 /* Descend recursively and set rc-style on all widgets without user styles */
689 void gtk_widget_reset_rc_styles (GtkWidget *widget);
691 /* Push/pop pairs, to change default values upon a widget's creation.
692 * This will override the values that got set by the
693 * gtk_widget_set_default_* () functions.
695 void gtk_widget_push_colormap (GdkColormap *cmap);
696 void gtk_widget_push_composite_child (void);
697 void gtk_widget_pop_composite_child (void);
698 void gtk_widget_pop_colormap (void);
700 /* widget style properties
702 void gtk_widget_class_install_style_property (GtkWidgetClass *klass,
704 void gtk_widget_class_install_style_property_parser (GtkWidgetClass *klass,
706 GtkRcPropertyParser parser);
707 GParamSpec* gtk_widget_class_find_style_property (GtkWidgetClass *klass,
708 const gchar *property_name);
709 GParamSpec** gtk_widget_class_list_style_properties (GtkWidgetClass *klass,
710 guint *n_properties);
711 void gtk_widget_style_get_property (GtkWidget *widget,
712 const gchar *property_name,
714 void gtk_widget_style_get_valist (GtkWidget *widget,
715 const gchar *first_property_name,
717 void gtk_widget_style_get (GtkWidget *widget,
718 const gchar *first_property_name,
719 ...) G_GNUC_NULL_TERMINATED;
722 /* Set certain default values to be used at widget creation time.
724 void gtk_widget_set_default_colormap (GdkColormap *colormap);
725 GtkStyle* gtk_widget_get_default_style (void);
726 #ifndef GDK_MULTIHEAD_SAFE
727 GdkColormap* gtk_widget_get_default_colormap (void);
728 GdkVisual* gtk_widget_get_default_visual (void);
731 /* Functions for setting directionality for widgets
734 void gtk_widget_set_direction (GtkWidget *widget,
735 GtkTextDirection dir);
736 GtkTextDirection gtk_widget_get_direction (GtkWidget *widget);
738 void gtk_widget_set_default_direction (GtkTextDirection dir);
739 GtkTextDirection gtk_widget_get_default_direction (void);
741 /* Counterpart to gdk_window_shape_combine_mask.
743 void gtk_widget_shape_combine_mask (GtkWidget *widget,
744 GdkBitmap *shape_mask,
748 /* internal function */
749 void gtk_widget_reset_shapes (GtkWidget *widget);
751 /* Compute a widget's path in the form "GtkWindow.MyLabel", and
752 * return newly alocated strings.
754 void gtk_widget_path (GtkWidget *widget,
757 gchar **path_reversed);
758 void gtk_widget_class_path (GtkWidget *widget,
761 gchar **path_reversed);
763 GList* gtk_widget_list_mnemonic_labels (GtkWidget *widget);
764 void gtk_widget_add_mnemonic_label (GtkWidget *widget,
766 void gtk_widget_remove_mnemonic_label (GtkWidget *widget,
769 GType gtk_requisition_get_type (void) G_GNUC_CONST;
770 GtkRequisition *gtk_requisition_copy (const GtkRequisition *requisition);
771 void gtk_requisition_free (GtkRequisition *requisition);
773 #if defined (GTK_TRACE_OBJECTS) && defined (__GNUC__)
774 # define gtk_widget_ref gtk_object_ref
775 # define gtk_widget_unref gtk_object_unref
776 #endif /* GTK_TRACE_OBJECTS && __GNUC__ */
778 void _gtk_widget_grab_notify (GtkWidget *widget,
779 gboolean was_grabbed);
781 GtkWidgetAuxInfo *_gtk_widget_get_aux_info (GtkWidget *widget,
783 void _gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
784 GtkWidget *previous_toplevel);
785 void _gtk_widget_propagate_screen_changed (GtkWidget *widget,
786 GdkScreen *previous_screen);
788 GdkColormap* _gtk_widget_peek_colormap (void);
792 #endif /* __GTK_WIDGET_H__ */