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 /* Padding for future expansion */
407 void (*_gtk_reserved2) (void);
408 void (*_gtk_reserved3) (void);
409 void (*_gtk_reserved4) (void);
410 void (*_gtk_reserved5) (void);
411 void (*_gtk_reserved6) (void);
412 void (*_gtk_reserved7) (void);
415 struct _GtkWidgetAuxInfo
425 struct _GtkWidgetShapeInfo
429 GdkBitmap *shape_mask;
432 GType gtk_widget_get_type (void) G_GNUC_CONST;
433 GtkWidget* gtk_widget_new (GType type,
434 const gchar *first_property_name,
435 ...) G_GNUC_NULL_TERMINATED;
436 GtkWidget* gtk_widget_ref (GtkWidget *widget);
437 void gtk_widget_unref (GtkWidget *widget);
438 void gtk_widget_destroy (GtkWidget *widget);
439 void gtk_widget_destroyed (GtkWidget *widget,
440 GtkWidget **widget_pointer);
441 #ifndef GTK_DISABLE_DEPRECATED
442 void gtk_widget_set (GtkWidget *widget,
443 const gchar *first_property_name,
444 ...) G_GNUC_NULL_TERMINATED;
445 #endif /* GTK_DISABLE_DEPRECATED */
446 void gtk_widget_unparent (GtkWidget *widget);
447 void gtk_widget_show (GtkWidget *widget);
448 void gtk_widget_show_now (GtkWidget *widget);
449 void gtk_widget_hide (GtkWidget *widget);
450 void gtk_widget_show_all (GtkWidget *widget);
451 void gtk_widget_hide_all (GtkWidget *widget);
452 void gtk_widget_set_no_show_all (GtkWidget *widget,
453 gboolean no_show_all);
454 gboolean gtk_widget_get_no_show_all (GtkWidget *widget);
455 void gtk_widget_map (GtkWidget *widget);
456 void gtk_widget_unmap (GtkWidget *widget);
457 void gtk_widget_realize (GtkWidget *widget);
458 void gtk_widget_unrealize (GtkWidget *widget);
461 void gtk_widget_queue_draw (GtkWidget *widget);
462 void gtk_widget_queue_draw_area (GtkWidget *widget,
467 #ifndef GTK_DISABLE_DEPRECATED
468 void gtk_widget_queue_clear (GtkWidget *widget);
469 void gtk_widget_queue_clear_area (GtkWidget *widget,
474 #endif /* GTK_DISABLE_DEPRECATED */
477 void gtk_widget_queue_resize (GtkWidget *widget);
478 void gtk_widget_queue_resize_no_redraw (GtkWidget *widget);
479 #ifndef GTK_DISABLE_DEPRECATED
480 void gtk_widget_draw (GtkWidget *widget,
482 #endif /* GTK_DISABLE_DEPRECATED */
483 void gtk_widget_size_request (GtkWidget *widget,
484 GtkRequisition *requisition);
485 void gtk_widget_size_allocate (GtkWidget *widget,
486 GtkAllocation *allocation);
487 void gtk_widget_get_child_requisition (GtkWidget *widget,
488 GtkRequisition *requisition);
489 void gtk_widget_add_accelerator (GtkWidget *widget,
490 const gchar *accel_signal,
491 GtkAccelGroup *accel_group,
493 GdkModifierType accel_mods,
494 GtkAccelFlags accel_flags);
495 gboolean gtk_widget_remove_accelerator (GtkWidget *widget,
496 GtkAccelGroup *accel_group,
498 GdkModifierType accel_mods);
499 void gtk_widget_set_accel_path (GtkWidget *widget,
500 const gchar *accel_path,
501 GtkAccelGroup *accel_group);
502 const gchar* _gtk_widget_get_accel_path (GtkWidget *widget,
504 GList* gtk_widget_list_accel_closures (GtkWidget *widget);
505 gboolean gtk_widget_can_activate_accel (GtkWidget *widget,
507 gboolean gtk_widget_mnemonic_activate (GtkWidget *widget,
508 gboolean group_cycling);
509 gboolean gtk_widget_event (GtkWidget *widget,
511 gint gtk_widget_send_expose (GtkWidget *widget,
514 gboolean gtk_widget_activate (GtkWidget *widget);
515 gboolean gtk_widget_set_scroll_adjustments (GtkWidget *widget,
516 GtkAdjustment *hadjustment,
517 GtkAdjustment *vadjustment);
519 void gtk_widget_reparent (GtkWidget *widget,
520 GtkWidget *new_parent);
521 gboolean gtk_widget_intersect (GtkWidget *widget,
523 GdkRectangle *intersection);
524 GdkRegion *gtk_widget_region_intersect (GtkWidget *widget,
527 void gtk_widget_freeze_child_notify (GtkWidget *widget);
528 void gtk_widget_child_notify (GtkWidget *widget,
529 const gchar *child_property);
530 void gtk_widget_thaw_child_notify (GtkWidget *widget);
532 gboolean gtk_widget_is_focus (GtkWidget *widget);
533 void gtk_widget_grab_focus (GtkWidget *widget);
534 void gtk_widget_grab_default (GtkWidget *widget);
536 void gtk_widget_set_name (GtkWidget *widget,
538 G_CONST_RETURN gchar* gtk_widget_get_name (GtkWidget *widget);
539 void gtk_widget_set_state (GtkWidget *widget,
541 void gtk_widget_set_sensitive (GtkWidget *widget,
543 void gtk_widget_set_app_paintable (GtkWidget *widget,
544 gboolean app_paintable);
545 void gtk_widget_set_double_buffered (GtkWidget *widget,
546 gboolean double_buffered);
547 void gtk_widget_set_redraw_on_allocate (GtkWidget *widget,
548 gboolean redraw_on_allocate);
549 void gtk_widget_set_parent (GtkWidget *widget,
551 void gtk_widget_set_parent_window (GtkWidget *widget,
552 GdkWindow *parent_window);
553 void gtk_widget_set_child_visible (GtkWidget *widget,
554 gboolean is_visible);
555 gboolean gtk_widget_get_child_visible (GtkWidget *widget);
557 GtkWidget *gtk_widget_get_parent (GtkWidget *widget);
558 GdkWindow *gtk_widget_get_parent_window (GtkWidget *widget);
560 gboolean gtk_widget_child_focus (GtkWidget *widget,
561 GtkDirectionType direction);
563 void gtk_widget_set_size_request (GtkWidget *widget,
566 void gtk_widget_get_size_request (GtkWidget *widget,
569 #ifndef GTK_DISABLE_DEPRECATED
570 void gtk_widget_set_uposition (GtkWidget *widget,
573 void gtk_widget_set_usize (GtkWidget *widget,
578 void gtk_widget_set_events (GtkWidget *widget,
580 void gtk_widget_add_events (GtkWidget *widget,
582 void gtk_widget_set_extension_events (GtkWidget *widget,
583 GdkExtensionMode mode);
585 GdkExtensionMode gtk_widget_get_extension_events (GtkWidget *widget);
586 GtkWidget* gtk_widget_get_toplevel (GtkWidget *widget);
587 GtkWidget* gtk_widget_get_ancestor (GtkWidget *widget,
589 GdkColormap* gtk_widget_get_colormap (GtkWidget *widget);
590 GdkVisual* gtk_widget_get_visual (GtkWidget *widget);
592 GdkScreen * gtk_widget_get_screen (GtkWidget *widget);
593 gboolean gtk_widget_has_screen (GtkWidget *widget);
594 GdkDisplay * gtk_widget_get_display (GtkWidget *widget);
595 GdkWindow * gtk_widget_get_root_window (GtkWidget *widget);
596 GtkSettings* gtk_widget_get_settings (GtkWidget *widget);
597 GtkClipboard *gtk_widget_get_clipboard (GtkWidget *widget,
600 #ifndef GTK_DISABLE_DEPRECATED
601 #define gtk_widget_set_visual(widget,visual) ((void) 0)
602 #define gtk_widget_push_visual(visual) ((void) 0)
603 #define gtk_widget_pop_visual() ((void) 0)
604 #define gtk_widget_set_default_visual(visual) ((void) 0)
605 #endif /* GTK_DISABLE_DEPRECATED */
607 /* Accessibility support */
608 AtkObject* gtk_widget_get_accessible (GtkWidget *widget);
610 /* The following functions must not be called on an already
611 * realized widget. Because it is possible that somebody
612 * can call get_colormap() or get_visual() and save the
613 * result, these functions are probably only safe to
614 * call in a widget's init() function.
616 void gtk_widget_set_colormap (GtkWidget *widget,
617 GdkColormap *colormap);
619 gint gtk_widget_get_events (GtkWidget *widget);
620 void gtk_widget_get_pointer (GtkWidget *widget,
624 gboolean gtk_widget_is_ancestor (GtkWidget *widget,
625 GtkWidget *ancestor);
627 gboolean gtk_widget_translate_coordinates (GtkWidget *src_widget,
628 GtkWidget *dest_widget,
634 /* Hide widget and return TRUE.
636 gboolean gtk_widget_hide_on_delete (GtkWidget *widget);
640 void gtk_widget_set_style (GtkWidget *widget,
642 void gtk_widget_ensure_style (GtkWidget *widget);
643 GtkStyle* gtk_widget_get_style (GtkWidget *widget);
645 void gtk_widget_modify_style (GtkWidget *widget,
647 GtkRcStyle *gtk_widget_get_modifier_style (GtkWidget *widget);
648 void gtk_widget_modify_fg (GtkWidget *widget,
650 const GdkColor *color);
651 void gtk_widget_modify_bg (GtkWidget *widget,
653 const GdkColor *color);
654 void gtk_widget_modify_text (GtkWidget *widget,
656 const GdkColor *color);
657 void gtk_widget_modify_base (GtkWidget *widget,
659 const GdkColor *color);
660 void gtk_widget_modify_font (GtkWidget *widget,
661 PangoFontDescription *font_desc);
663 #ifndef GTK_DISABLE_DEPRECATED
664 #define gtk_widget_set_rc_style(widget) (gtk_widget_set_style (widget, NULL))
665 #define gtk_widget_restore_default_style(widget) (gtk_widget_set_style (widget, NULL))
668 PangoContext *gtk_widget_create_pango_context (GtkWidget *widget);
669 PangoContext *gtk_widget_get_pango_context (GtkWidget *widget);
670 PangoLayout *gtk_widget_create_pango_layout (GtkWidget *widget,
673 GdkPixbuf *gtk_widget_render_icon (GtkWidget *widget,
674 const gchar *stock_id,
676 const gchar *detail);
678 /* handle composite names for GTK_COMPOSITE_CHILD widgets,
679 * the returned name is newly allocated.
681 void gtk_widget_set_composite_name (GtkWidget *widget,
683 gchar* gtk_widget_get_composite_name (GtkWidget *widget);
685 /* Descend recursively and set rc-style on all widgets without user styles */
686 void gtk_widget_reset_rc_styles (GtkWidget *widget);
688 /* Push/pop pairs, to change default values upon a widget's creation.
689 * This will override the values that got set by the
690 * gtk_widget_set_default_* () functions.
692 void gtk_widget_push_colormap (GdkColormap *cmap);
693 void gtk_widget_push_composite_child (void);
694 void gtk_widget_pop_composite_child (void);
695 void gtk_widget_pop_colormap (void);
697 /* widget style properties
699 void gtk_widget_class_install_style_property (GtkWidgetClass *klass,
701 void gtk_widget_class_install_style_property_parser (GtkWidgetClass *klass,
703 GtkRcPropertyParser parser);
704 GParamSpec* gtk_widget_class_find_style_property (GtkWidgetClass *klass,
705 const gchar *property_name);
706 GParamSpec** gtk_widget_class_list_style_properties (GtkWidgetClass *klass,
707 guint *n_properties);
708 void gtk_widget_style_get_property (GtkWidget *widget,
709 const gchar *property_name,
711 void gtk_widget_style_get_valist (GtkWidget *widget,
712 const gchar *first_property_name,
714 void gtk_widget_style_get (GtkWidget *widget,
715 const gchar *first_property_name,
716 ...) G_GNUC_NULL_TERMINATED;
719 /* Set certain default values to be used at widget creation time.
721 void gtk_widget_set_default_colormap (GdkColormap *colormap);
722 GtkStyle* gtk_widget_get_default_style (void);
723 #ifndef GDK_MULTIHEAD_SAFE
724 GdkColormap* gtk_widget_get_default_colormap (void);
725 GdkVisual* gtk_widget_get_default_visual (void);
728 /* Functions for setting directionality for widgets
731 void gtk_widget_set_direction (GtkWidget *widget,
732 GtkTextDirection dir);
733 GtkTextDirection gtk_widget_get_direction (GtkWidget *widget);
735 void gtk_widget_set_default_direction (GtkTextDirection dir);
736 GtkTextDirection gtk_widget_get_default_direction (void);
738 /* Counterpart to gdk_window_shape_combine_mask.
740 void gtk_widget_shape_combine_mask (GtkWidget *widget,
741 GdkBitmap *shape_mask,
745 /* internal function */
746 void gtk_widget_reset_shapes (GtkWidget *widget);
748 /* Compute a widget's path in the form "GtkWindow.MyLabel", and
749 * return newly alocated strings.
751 void gtk_widget_path (GtkWidget *widget,
754 gchar **path_reversed);
755 void gtk_widget_class_path (GtkWidget *widget,
758 gchar **path_reversed);
760 GList* gtk_widget_list_mnemonic_labels (GtkWidget *widget);
761 void gtk_widget_add_mnemonic_label (GtkWidget *widget,
763 void gtk_widget_remove_mnemonic_label (GtkWidget *widget,
766 GType gtk_requisition_get_type (void) G_GNUC_CONST;
767 GtkRequisition *gtk_requisition_copy (const GtkRequisition *requisition);
768 void gtk_requisition_free (GtkRequisition *requisition);
770 #if defined (GTK_TRACE_OBJECTS) && defined (__GNUC__)
771 # define gtk_widget_ref gtk_object_ref
772 # define gtk_widget_unref gtk_object_unref
773 #endif /* GTK_TRACE_OBJECTS && __GNUC__ */
775 void _gtk_widget_grab_notify (GtkWidget *widget,
776 gboolean was_grabbed);
778 GtkWidgetAuxInfo *_gtk_widget_get_aux_info (GtkWidget *widget,
780 void _gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
781 GtkWidget *previous_toplevel);
782 void _gtk_widget_propagate_screen_changed (GtkWidget *widget,
783 GdkScreen *previous_screen);
785 GdkColormap* _gtk_widget_peek_colormap (void);
789 #endif /* __GTK_WIDGET_H__ */