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 struct _GtkTooltip GtkTooltip;
144 typedef struct _GtkWindow GtkWindow;
145 typedef void (*GtkCallback) (GtkWidget *widget,
148 /* A requisition is a desired amount of space which a
149 * widget may request.
151 struct _GtkRequisition
157 /* The widget is the base of the tree for displayable objects.
158 * (A displayable object is one which takes up some amount
159 * of screen real estate). It provides a common base and interface
160 * which actual widgets must adhere to.
164 /* The object structure needs to be the first
165 * element in the widget structure in order for
166 * the object mechanism to work correctly. This
167 * allows a GtkWidget pointer to be cast to a
172 /* 16 bits of internally used private flags.
173 * this will be packed into the same 4 byte alignment frame that
174 * state and saved_state go. we therefore don't waste any new
177 guint16 private_flags;
179 /* The state of the widget. There are actually only
180 * 5 widget states (defined in "gtkenums.h").
184 /* The saved state of the widget. When a widget's state
185 * is changed to GTK_STATE_INSENSITIVE via
186 * "gtk_widget_set_state" or "gtk_widget_set_sensitive"
187 * the old state is kept around in this field. The state
188 * will be restored once the widget gets sensitive again.
192 /* The widget's name. If the widget does not have a name
193 * (the name is NULL), then its name (as returned by
194 * "gtk_widget_get_name") is its class's name.
195 * Among other things, the widget name is used to determine
196 * the style to use for a widget.
202 /* The style for the widget. The style contains the
203 * colors the widget should be drawn in for each state
204 * along with graphics contexts used to draw with and
205 * the font to use for text.
209 /* The widget's desired size.
211 GtkRequisition requisition;
213 /* The widget's allocated size.
215 GtkAllocation allocation;
217 /* The widget's window or its parent window if it does
218 * not have a window. (Which will be indicated by the
219 * GTK_NO_WINDOW flag being set).
223 /* The widget's parent.
228 struct _GtkWidgetClass
230 /* The object class structure needs to be the first
231 * element in the widget class structure in order for
232 * the class mechanism to work correctly. This allows a
233 * GtkWidgetClass pointer to be cast to a GtkObjectClass
236 GtkObjectClass parent_class;
240 guint activate_signal;
242 guint set_scroll_adjustments_signal;
246 /* seldomly overidden */
247 void (*dispatch_child_properties_changed) (GtkWidget *widget,
249 GParamSpec **pspecs);
252 void (* show) (GtkWidget *widget);
253 void (* show_all) (GtkWidget *widget);
254 void (* hide) (GtkWidget *widget);
255 void (* hide_all) (GtkWidget *widget);
256 void (* map) (GtkWidget *widget);
257 void (* unmap) (GtkWidget *widget);
258 void (* realize) (GtkWidget *widget);
259 void (* unrealize) (GtkWidget *widget);
260 void (* size_request) (GtkWidget *widget,
261 GtkRequisition *requisition);
262 void (* size_allocate) (GtkWidget *widget,
263 GtkAllocation *allocation);
264 void (* state_changed) (GtkWidget *widget,
265 GtkStateType previous_state);
266 void (* parent_set) (GtkWidget *widget,
267 GtkWidget *previous_parent);
268 void (* hierarchy_changed) (GtkWidget *widget,
269 GtkWidget *previous_toplevel);
270 void (* style_set) (GtkWidget *widget,
271 GtkStyle *previous_style);
272 void (* direction_changed) (GtkWidget *widget,
273 GtkTextDirection previous_direction);
274 void (* grab_notify) (GtkWidget *widget,
275 gboolean was_grabbed);
276 void (* child_notify) (GtkWidget *widget,
280 gboolean (* mnemonic_activate) (GtkWidget *widget,
281 gboolean group_cycling);
284 void (* grab_focus) (GtkWidget *widget);
285 gboolean (* focus) (GtkWidget *widget,
286 GtkDirectionType direction);
289 gboolean (* event) (GtkWidget *widget,
291 gboolean (* button_press_event) (GtkWidget *widget,
292 GdkEventButton *event);
293 gboolean (* button_release_event) (GtkWidget *widget,
294 GdkEventButton *event);
295 gboolean (* scroll_event) (GtkWidget *widget,
296 GdkEventScroll *event);
297 gboolean (* motion_notify_event) (GtkWidget *widget,
298 GdkEventMotion *event);
299 gboolean (* delete_event) (GtkWidget *widget,
301 gboolean (* destroy_event) (GtkWidget *widget,
303 gboolean (* expose_event) (GtkWidget *widget,
304 GdkEventExpose *event);
305 gboolean (* key_press_event) (GtkWidget *widget,
307 gboolean (* key_release_event) (GtkWidget *widget,
309 gboolean (* enter_notify_event) (GtkWidget *widget,
310 GdkEventCrossing *event);
311 gboolean (* leave_notify_event) (GtkWidget *widget,
312 GdkEventCrossing *event);
313 gboolean (* configure_event) (GtkWidget *widget,
314 GdkEventConfigure *event);
315 gboolean (* focus_in_event) (GtkWidget *widget,
316 GdkEventFocus *event);
317 gboolean (* focus_out_event) (GtkWidget *widget,
318 GdkEventFocus *event);
319 gboolean (* map_event) (GtkWidget *widget,
321 gboolean (* unmap_event) (GtkWidget *widget,
323 gboolean (* property_notify_event) (GtkWidget *widget,
324 GdkEventProperty *event);
325 gboolean (* selection_clear_event) (GtkWidget *widget,
326 GdkEventSelection *event);
327 gboolean (* selection_request_event) (GtkWidget *widget,
328 GdkEventSelection *event);
329 gboolean (* selection_notify_event) (GtkWidget *widget,
330 GdkEventSelection *event);
331 gboolean (* proximity_in_event) (GtkWidget *widget,
332 GdkEventProximity *event);
333 gboolean (* proximity_out_event) (GtkWidget *widget,
334 GdkEventProximity *event);
335 gboolean (* visibility_notify_event) (GtkWidget *widget,
336 GdkEventVisibility *event);
337 gboolean (* client_event) (GtkWidget *widget,
338 GdkEventClient *event);
339 gboolean (* no_expose_event) (GtkWidget *widget,
341 gboolean (* window_state_event) (GtkWidget *widget,
342 GdkEventWindowState *event);
345 void (* selection_get) (GtkWidget *widget,
346 GtkSelectionData *selection_data,
349 void (* selection_received) (GtkWidget *widget,
350 GtkSelectionData *selection_data,
353 /* Source side drag signals */
354 void (* drag_begin) (GtkWidget *widget,
355 GdkDragContext *context);
356 void (* drag_end) (GtkWidget *widget,
357 GdkDragContext *context);
358 void (* drag_data_get) (GtkWidget *widget,
359 GdkDragContext *context,
360 GtkSelectionData *selection_data,
363 void (* drag_data_delete) (GtkWidget *widget,
364 GdkDragContext *context);
366 /* Target side drag signals */
367 void (* drag_leave) (GtkWidget *widget,
368 GdkDragContext *context,
370 gboolean (* drag_motion) (GtkWidget *widget,
371 GdkDragContext *context,
375 gboolean (* drag_drop) (GtkWidget *widget,
376 GdkDragContext *context,
380 void (* drag_data_received) (GtkWidget *widget,
381 GdkDragContext *context,
384 GtkSelectionData *selection_data,
388 /* Signals used only for keybindings */
389 gboolean (* popup_menu) (GtkWidget *widget);
391 /* If a widget has multiple tooltips/whatsthis, it should show the
392 * one for the current focus location, or if that doesn't make
393 * sense, should cycle through them showing each tip alongside
394 * whatever piece of the widget it applies to.
396 gboolean (* show_help) (GtkWidget *widget,
397 GtkWidgetHelpType help_type);
399 /* accessibility support
401 AtkObject* (*get_accessible) (GtkWidget *widget);
403 void (*screen_changed) (GtkWidget *widget,
404 GdkScreen *previous_screen);
405 gboolean (*can_activate_accel) (GtkWidget *widget,
408 /* Sent when a grab is broken. */
409 gboolean (*grab_broken_event) (GtkWidget *widget,
410 GdkEventGrabBroken *event);
412 void (* composited_changed) (GtkWidget *widget);
414 gboolean (* query_tooltip) (GtkWidget *widget,
417 gboolean keyboard_tooltip,
418 GtkTooltip *tooltip);
420 /* Padding for future expansion */
421 void (*_gtk_reserved5) (void);
422 void (*_gtk_reserved6) (void);
423 void (*_gtk_reserved7) (void);
426 struct _GtkWidgetAuxInfo
436 struct _GtkWidgetShapeInfo
440 GdkBitmap *shape_mask;
443 GType gtk_widget_get_type (void) G_GNUC_CONST;
444 GtkWidget* gtk_widget_new (GType type,
445 const gchar *first_property_name,
447 void gtk_widget_destroy (GtkWidget *widget);
448 void gtk_widget_destroyed (GtkWidget *widget,
449 GtkWidget **widget_pointer);
450 #ifndef GTK_DISABLE_DEPRECATED
451 GtkWidget* gtk_widget_ref (GtkWidget *widget);
452 void gtk_widget_unref (GtkWidget *widget);
453 void gtk_widget_set (GtkWidget *widget,
454 const gchar *first_property_name,
455 ...) G_GNUC_NULL_TERMINATED;
456 #endif /* GTK_DISABLE_DEPRECATED */
457 void gtk_widget_unparent (GtkWidget *widget);
458 void gtk_widget_show (GtkWidget *widget);
459 void gtk_widget_show_now (GtkWidget *widget);
460 void gtk_widget_hide (GtkWidget *widget);
461 void gtk_widget_show_all (GtkWidget *widget);
462 void gtk_widget_hide_all (GtkWidget *widget);
463 void gtk_widget_set_no_show_all (GtkWidget *widget,
464 gboolean no_show_all);
465 gboolean gtk_widget_get_no_show_all (GtkWidget *widget);
466 void gtk_widget_map (GtkWidget *widget);
467 void gtk_widget_unmap (GtkWidget *widget);
468 void gtk_widget_realize (GtkWidget *widget);
469 void gtk_widget_unrealize (GtkWidget *widget);
472 void gtk_widget_queue_draw (GtkWidget *widget);
473 void gtk_widget_queue_draw_area (GtkWidget *widget,
478 #ifndef GTK_DISABLE_DEPRECATED
479 void gtk_widget_queue_clear (GtkWidget *widget);
480 void gtk_widget_queue_clear_area (GtkWidget *widget,
485 #endif /* GTK_DISABLE_DEPRECATED */
488 void gtk_widget_queue_resize (GtkWidget *widget);
489 void gtk_widget_queue_resize_no_redraw (GtkWidget *widget);
490 #ifndef GTK_DISABLE_DEPRECATED
491 void gtk_widget_draw (GtkWidget *widget,
492 const GdkRectangle *area);
493 #endif /* GTK_DISABLE_DEPRECATED */
494 void gtk_widget_size_request (GtkWidget *widget,
495 GtkRequisition *requisition);
496 void gtk_widget_size_allocate (GtkWidget *widget,
497 GtkAllocation *allocation);
498 void gtk_widget_get_child_requisition (GtkWidget *widget,
499 GtkRequisition *requisition);
500 void gtk_widget_add_accelerator (GtkWidget *widget,
501 const gchar *accel_signal,
502 GtkAccelGroup *accel_group,
504 GdkModifierType accel_mods,
505 GtkAccelFlags accel_flags);
506 gboolean gtk_widget_remove_accelerator (GtkWidget *widget,
507 GtkAccelGroup *accel_group,
509 GdkModifierType accel_mods);
510 void gtk_widget_set_accel_path (GtkWidget *widget,
511 const gchar *accel_path,
512 GtkAccelGroup *accel_group);
513 const gchar* _gtk_widget_get_accel_path (GtkWidget *widget,
515 GList* gtk_widget_list_accel_closures (GtkWidget *widget);
516 gboolean gtk_widget_can_activate_accel (GtkWidget *widget,
518 gboolean gtk_widget_mnemonic_activate (GtkWidget *widget,
519 gboolean group_cycling);
520 gboolean gtk_widget_event (GtkWidget *widget,
522 gint gtk_widget_send_expose (GtkWidget *widget,
525 gboolean gtk_widget_activate (GtkWidget *widget);
526 gboolean gtk_widget_set_scroll_adjustments (GtkWidget *widget,
527 GtkAdjustment *hadjustment,
528 GtkAdjustment *vadjustment);
530 void gtk_widget_reparent (GtkWidget *widget,
531 GtkWidget *new_parent);
532 gboolean gtk_widget_intersect (GtkWidget *widget,
533 const GdkRectangle *area,
534 GdkRectangle *intersection);
535 GdkRegion *gtk_widget_region_intersect (GtkWidget *widget,
536 const GdkRegion *region);
538 void gtk_widget_freeze_child_notify (GtkWidget *widget);
539 void gtk_widget_child_notify (GtkWidget *widget,
540 const gchar *child_property);
541 void gtk_widget_thaw_child_notify (GtkWidget *widget);
543 gboolean gtk_widget_is_focus (GtkWidget *widget);
544 void gtk_widget_grab_focus (GtkWidget *widget);
545 void gtk_widget_grab_default (GtkWidget *widget);
547 void gtk_widget_set_name (GtkWidget *widget,
549 G_CONST_RETURN gchar* gtk_widget_get_name (GtkWidget *widget);
550 void gtk_widget_set_state (GtkWidget *widget,
552 void gtk_widget_set_sensitive (GtkWidget *widget,
554 void gtk_widget_set_app_paintable (GtkWidget *widget,
555 gboolean app_paintable);
556 void gtk_widget_set_double_buffered (GtkWidget *widget,
557 gboolean double_buffered);
558 void gtk_widget_set_redraw_on_allocate (GtkWidget *widget,
559 gboolean redraw_on_allocate);
560 void gtk_widget_set_parent (GtkWidget *widget,
562 void gtk_widget_set_parent_window (GtkWidget *widget,
563 GdkWindow *parent_window);
564 void gtk_widget_set_child_visible (GtkWidget *widget,
565 gboolean is_visible);
566 gboolean gtk_widget_get_child_visible (GtkWidget *widget);
568 GtkWidget *gtk_widget_get_parent (GtkWidget *widget);
569 GdkWindow *gtk_widget_get_parent_window (GtkWidget *widget);
571 gboolean gtk_widget_child_focus (GtkWidget *widget,
572 GtkDirectionType direction);
573 gboolean gtk_widget_keynav_failed (GtkWidget *widget,
574 GtkDirectionType direction);
575 void gtk_widget_error_bell (GtkWidget *widget);
577 void gtk_widget_set_size_request (GtkWidget *widget,
580 void gtk_widget_get_size_request (GtkWidget *widget,
583 #ifndef GTK_DISABLE_DEPRECATED
584 void gtk_widget_set_uposition (GtkWidget *widget,
587 void gtk_widget_set_usize (GtkWidget *widget,
592 void gtk_widget_set_events (GtkWidget *widget,
594 void gtk_widget_add_events (GtkWidget *widget,
596 void gtk_widget_set_extension_events (GtkWidget *widget,
597 GdkExtensionMode mode);
599 GdkExtensionMode gtk_widget_get_extension_events (GtkWidget *widget);
600 GtkWidget* gtk_widget_get_toplevel (GtkWidget *widget);
601 GtkWidget* gtk_widget_get_ancestor (GtkWidget *widget,
603 GdkColormap* gtk_widget_get_colormap (GtkWidget *widget);
604 GdkVisual* gtk_widget_get_visual (GtkWidget *widget);
606 GdkScreen * gtk_widget_get_screen (GtkWidget *widget);
607 gboolean gtk_widget_has_screen (GtkWidget *widget);
608 GdkDisplay * gtk_widget_get_display (GtkWidget *widget);
609 GdkWindow * gtk_widget_get_root_window (GtkWidget *widget);
610 GtkSettings* gtk_widget_get_settings (GtkWidget *widget);
611 GtkClipboard *gtk_widget_get_clipboard (GtkWidget *widget,
614 #ifndef GTK_DISABLE_DEPRECATED
615 #define gtk_widget_set_visual(widget,visual) ((void) 0)
616 #define gtk_widget_push_visual(visual) ((void) 0)
617 #define gtk_widget_pop_visual() ((void) 0)
618 #define gtk_widget_set_default_visual(visual) ((void) 0)
619 #endif /* GTK_DISABLE_DEPRECATED */
621 /* Accessibility support */
622 AtkObject* gtk_widget_get_accessible (GtkWidget *widget);
624 /* The following functions must not be called on an already
625 * realized widget. Because it is possible that somebody
626 * can call get_colormap() or get_visual() and save the
627 * result, these functions are probably only safe to
628 * call in a widget's init() function.
630 void gtk_widget_set_colormap (GtkWidget *widget,
631 GdkColormap *colormap);
633 gint gtk_widget_get_events (GtkWidget *widget);
634 void gtk_widget_get_pointer (GtkWidget *widget,
638 gboolean gtk_widget_is_ancestor (GtkWidget *widget,
639 GtkWidget *ancestor);
641 gboolean gtk_widget_translate_coordinates (GtkWidget *src_widget,
642 GtkWidget *dest_widget,
648 /* Hide widget and return TRUE.
650 gboolean gtk_widget_hide_on_delete (GtkWidget *widget);
654 void gtk_widget_set_style (GtkWidget *widget,
656 void gtk_widget_ensure_style (GtkWidget *widget);
657 GtkStyle* gtk_widget_get_style (GtkWidget *widget);
659 void gtk_widget_modify_style (GtkWidget *widget,
661 GtkRcStyle *gtk_widget_get_modifier_style (GtkWidget *widget);
662 void gtk_widget_modify_fg (GtkWidget *widget,
664 const GdkColor *color);
665 void gtk_widget_modify_bg (GtkWidget *widget,
667 const GdkColor *color);
668 void gtk_widget_modify_text (GtkWidget *widget,
670 const GdkColor *color);
671 void gtk_widget_modify_base (GtkWidget *widget,
673 const GdkColor *color);
674 void gtk_widget_modify_cursor (GtkWidget *widget,
675 const GdkColor *primary,
676 const GdkColor *secondary);
677 void gtk_widget_modify_font (GtkWidget *widget,
678 PangoFontDescription *font_desc);
680 #ifndef GTK_DISABLE_DEPRECATED
681 #define gtk_widget_set_rc_style(widget) (gtk_widget_set_style (widget, NULL))
682 #define gtk_widget_restore_default_style(widget) (gtk_widget_set_style (widget, NULL))
685 PangoContext *gtk_widget_create_pango_context (GtkWidget *widget);
686 PangoContext *gtk_widget_get_pango_context (GtkWidget *widget);
687 PangoLayout *gtk_widget_create_pango_layout (GtkWidget *widget,
690 GdkPixbuf *gtk_widget_render_icon (GtkWidget *widget,
691 const gchar *stock_id,
693 const gchar *detail);
695 /* handle composite names for GTK_COMPOSITE_CHILD widgets,
696 * the returned name is newly allocated.
698 void gtk_widget_set_composite_name (GtkWidget *widget,
700 gchar* gtk_widget_get_composite_name (GtkWidget *widget);
702 /* Descend recursively and set rc-style on all widgets without user styles */
703 void gtk_widget_reset_rc_styles (GtkWidget *widget);
705 /* Push/pop pairs, to change default values upon a widget's creation.
706 * This will override the values that got set by the
707 * gtk_widget_set_default_* () functions.
709 void gtk_widget_push_colormap (GdkColormap *cmap);
710 void gtk_widget_push_composite_child (void);
711 void gtk_widget_pop_composite_child (void);
712 void gtk_widget_pop_colormap (void);
714 /* widget style properties
716 void gtk_widget_class_install_style_property (GtkWidgetClass *klass,
718 void gtk_widget_class_install_style_property_parser (GtkWidgetClass *klass,
720 GtkRcPropertyParser parser);
721 GParamSpec* gtk_widget_class_find_style_property (GtkWidgetClass *klass,
722 const gchar *property_name);
723 GParamSpec** gtk_widget_class_list_style_properties (GtkWidgetClass *klass,
724 guint *n_properties);
725 void gtk_widget_style_get_property (GtkWidget *widget,
726 const gchar *property_name,
728 void gtk_widget_style_get_valist (GtkWidget *widget,
729 const gchar *first_property_name,
731 void gtk_widget_style_get (GtkWidget *widget,
732 const gchar *first_property_name,
733 ...) G_GNUC_NULL_TERMINATED;
736 /* Set certain default values to be used at widget creation time.
738 void gtk_widget_set_default_colormap (GdkColormap *colormap);
739 GtkStyle* gtk_widget_get_default_style (void);
740 #ifndef GDK_MULTIHEAD_SAFE
741 GdkColormap* gtk_widget_get_default_colormap (void);
742 GdkVisual* gtk_widget_get_default_visual (void);
745 /* Functions for setting directionality for widgets
748 void gtk_widget_set_direction (GtkWidget *widget,
749 GtkTextDirection dir);
750 GtkTextDirection gtk_widget_get_direction (GtkWidget *widget);
752 void gtk_widget_set_default_direction (GtkTextDirection dir);
753 GtkTextDirection gtk_widget_get_default_direction (void);
755 /* Compositing manager functionality */
756 gboolean gtk_widget_is_composited (GtkWidget *widget);
758 /* Counterpart to gdk_window_shape_combine_mask.
760 void gtk_widget_shape_combine_mask (GtkWidget *widget,
761 GdkBitmap *shape_mask,
764 void gtk_widget_input_shape_combine_mask (GtkWidget *widget,
765 GdkBitmap *shape_mask,
769 /* internal function */
770 void gtk_widget_reset_shapes (GtkWidget *widget);
772 /* Compute a widget's path in the form "GtkWindow.MyLabel", and
773 * return newly alocated strings.
775 void gtk_widget_path (GtkWidget *widget,
778 gchar **path_reversed);
779 void gtk_widget_class_path (GtkWidget *widget,
782 gchar **path_reversed);
784 GList* gtk_widget_list_mnemonic_labels (GtkWidget *widget);
785 void gtk_widget_add_mnemonic_label (GtkWidget *widget,
787 void gtk_widget_remove_mnemonic_label (GtkWidget *widget,
790 void gtk_widget_set_tooltip_window (GtkWidget *widget,
791 GtkWindow *custom_window);
792 GtkWindow *gtk_widget_get_tooltip_window (GtkWidget *widget);
793 void gtk_widget_trigger_tooltip_query (GtkWidget *widget);
794 void gtk_widget_set_tooltip_text (GtkWidget *widget,
796 gchar * gtk_widget_get_tooltip_text (GtkWidget *widget);
797 void gtk_widget_set_tooltip_markup (GtkWidget *widget,
798 const gchar *markup);
799 gchar * gtk_widget_get_tooltip_markup (GtkWidget *widget);
800 void gtk_widget_set_has_tooltip (GtkWidget *widget,
801 gboolean has_tooltip);
802 gboolean gtk_widget_get_has_tooltip (GtkWidget *widget);
804 GType gtk_requisition_get_type (void) G_GNUC_CONST;
805 GtkRequisition *gtk_requisition_copy (const GtkRequisition *requisition);
806 void gtk_requisition_free (GtkRequisition *requisition);
808 #if defined (GTK_TRACE_OBJECTS) && defined (__GNUC__)
809 # define gtk_widget_ref gtk_object_ref
810 # define gtk_widget_unref gtk_object_unref
811 #endif /* GTK_TRACE_OBJECTS && __GNUC__ */
813 void _gtk_widget_grab_notify (GtkWidget *widget,
814 gboolean was_grabbed);
816 GtkWidgetAuxInfo *_gtk_widget_get_aux_info (GtkWidget *widget,
818 void _gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
819 GtkWidget *previous_toplevel);
820 void _gtk_widget_propagate_screen_changed (GtkWidget *widget,
821 GdkScreen *previous_screen);
822 void _gtk_widget_propagate_composited_changed (GtkWidget *widget);
824 GdkColormap* _gtk_widget_peek_colormap (void);
828 #endif /* __GTK_WIDGET_H__ */