]> Pileus Git - ~andy/gtk/blob - gtk/gtkwidget.h
Patch from Padraig O'Briain to add gtk_widget_add/remove_mnemonic_label,
[~andy/gtk] / gtk / gtkwidget.h
1 /* GTK - The GIMP Toolkit
2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3  *
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.
8  *
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.
13  *
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.
18  */
19
20 /*
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/. 
25  */
26
27 #ifndef __GTK_WIDGET_H__
28 #define __GTK_WIDGET_H__
29
30 #include <gdk/gdk.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>
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif /* __cplusplus */
41
42
43 /* The flags that are used by GtkWidget on top of the
44  * flags field of GtkObject.
45  */
46 typedef enum
47 {
48   GTK_TOPLEVEL         = 1 << 4,
49   GTK_NO_WINDOW        = 1 << 5,
50   GTK_REALIZED         = 1 << 6,
51   GTK_MAPPED           = 1 << 7,
52   GTK_VISIBLE          = 1 << 8,
53   GTK_SENSITIVE        = 1 << 9,
54   GTK_PARENT_SENSITIVE = 1 << 10,
55   GTK_CAN_FOCUS        = 1 << 11,
56   GTK_HAS_FOCUS        = 1 << 12,
57
58   /* widget is allowed to receive the default via gtk_widget_grab_default
59    * and will reserve space to draw the default if possible
60    */
61   GTK_CAN_DEFAULT      = 1 << 13,
62
63   /* the widget currently is receiving the default action and should be drawn
64    * appropriately if possible
65    */
66   GTK_HAS_DEFAULT      = 1 << 14,
67
68   GTK_HAS_GRAB         = 1 << 15,
69   GTK_RC_STYLE         = 1 << 16,
70   GTK_COMPOSITE_CHILD  = 1 << 17,
71   GTK_NO_REPARENT      = 1 << 18,
72   GTK_APP_PAINTABLE    = 1 << 19,
73
74   /* the widget when focused will receive the default action and have
75    * HAS_DEFAULT set even if there is a different widget set as default
76    */
77   GTK_RECEIVES_DEFAULT = 1 << 20,
78
79   GTK_DOUBLE_BUFFERED  = 1 << 21,
80   GTK_NO_SHOW_ALL      = 1 << 22
81 } GtkWidgetFlags;
82
83 /* Kinds of widget-specific help */
84 typedef enum
85 {
86   GTK_WIDGET_HELP_TOOLTIP,
87   GTK_WIDGET_HELP_WHATS_THIS
88 } GtkWidgetHelpType;
89
90 /* Macro for casting a pointer to a GtkWidget or GtkWidgetClass pointer.
91  * Macros for testing whether `widget' or `klass' are of type GTK_TYPE_WIDGET.
92  */
93 #define GTK_TYPE_WIDGET                   (gtk_widget_get_type ())
94 #define GTK_WIDGET(widget)                (G_TYPE_CHECK_INSTANCE_CAST ((widget), GTK_TYPE_WIDGET, GtkWidget))
95 #define GTK_WIDGET_CLASS(klass)           (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WIDGET, GtkWidgetClass))
96 #define GTK_IS_WIDGET(widget)             (G_TYPE_CHECK_INSTANCE_TYPE ((widget), GTK_TYPE_WIDGET))
97 #define GTK_IS_WIDGET_CLASS(klass)        (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WIDGET))
98 #define GTK_WIDGET_GET_CLASS(obj)         (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WIDGET, GtkWidgetClass))
99
100 /* Macros for extracting various fields from GtkWidget and GtkWidgetClass.
101  */
102 #define GTK_WIDGET_TYPE(wid)              (GTK_OBJECT_TYPE (wid))
103 #define GTK_WIDGET_STATE(wid)             (GTK_WIDGET (wid)->state)
104 #define GTK_WIDGET_SAVED_STATE(wid)       (GTK_WIDGET (wid)->saved_state)
105
106 /* Macros for extracting the widget flags from GtkWidget.
107  */
108 #define GTK_WIDGET_FLAGS(wid)             (GTK_OBJECT_FLAGS (wid))
109 #define GTK_WIDGET_TOPLEVEL(wid)          ((GTK_WIDGET_FLAGS (wid) & GTK_TOPLEVEL) != 0)
110 #define GTK_WIDGET_NO_WINDOW(wid)         ((GTK_WIDGET_FLAGS (wid) & GTK_NO_WINDOW) != 0)
111 #define GTK_WIDGET_REALIZED(wid)          ((GTK_WIDGET_FLAGS (wid) & GTK_REALIZED) != 0)
112 #define GTK_WIDGET_MAPPED(wid)            ((GTK_WIDGET_FLAGS (wid) & GTK_MAPPED) != 0)
113 #define GTK_WIDGET_VISIBLE(wid)           ((GTK_WIDGET_FLAGS (wid) & GTK_VISIBLE) != 0)
114 #define GTK_WIDGET_DRAWABLE(wid)          (GTK_WIDGET_VISIBLE (wid) && GTK_WIDGET_MAPPED (wid))
115 #define GTK_WIDGET_SENSITIVE(wid)         ((GTK_WIDGET_FLAGS (wid) & GTK_SENSITIVE) != 0)
116 #define GTK_WIDGET_PARENT_SENSITIVE(wid)  ((GTK_WIDGET_FLAGS (wid) & GTK_PARENT_SENSITIVE) != 0)
117 #define GTK_WIDGET_IS_SENSITIVE(wid)      (GTK_WIDGET_SENSITIVE (wid) && \
118                                            GTK_WIDGET_PARENT_SENSITIVE (wid))
119 #define GTK_WIDGET_CAN_FOCUS(wid)         ((GTK_WIDGET_FLAGS (wid) & GTK_CAN_FOCUS) != 0)
120 #define GTK_WIDGET_HAS_FOCUS(wid)         ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_FOCUS) != 0)
121 #define GTK_WIDGET_CAN_DEFAULT(wid)       ((GTK_WIDGET_FLAGS (wid) & GTK_CAN_DEFAULT) != 0)
122 #define GTK_WIDGET_HAS_DEFAULT(wid)       ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_DEFAULT) != 0)
123 #define GTK_WIDGET_HAS_GRAB(wid)          ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_GRAB) != 0)
124 #define GTK_WIDGET_RC_STYLE(wid)          ((GTK_WIDGET_FLAGS (wid) & GTK_RC_STYLE) != 0)
125 #define GTK_WIDGET_COMPOSITE_CHILD(wid)   ((GTK_WIDGET_FLAGS (wid) & GTK_COMPOSITE_CHILD) != 0)
126 #define GTK_WIDGET_APP_PAINTABLE(wid)     ((GTK_WIDGET_FLAGS (wid) & GTK_APP_PAINTABLE) != 0)
127 #define GTK_WIDGET_RECEIVES_DEFAULT(wid)  ((GTK_WIDGET_FLAGS (wid) & GTK_RECEIVES_DEFAULT) != 0)
128 #define GTK_WIDGET_DOUBLE_BUFFERED(wid)   ((GTK_WIDGET_FLAGS (wid) & GTK_DOUBLE_BUFFERED) != 0)
129   
130 /* Macros for setting and clearing widget flags.
131  */
132 #define GTK_WIDGET_SET_FLAGS(wid,flag)    G_STMT_START{ (GTK_WIDGET_FLAGS (wid) |= (flag)); }G_STMT_END
133 #define GTK_WIDGET_UNSET_FLAGS(wid,flag)  G_STMT_START{ (GTK_WIDGET_FLAGS (wid) &= ~(flag)); }G_STMT_END
134
135 #define GTK_TYPE_REQUISITION              (gtk_requisition_get_type ())
136
137 /* forward declaration to avoid excessive includes (and concurrent includes)
138  */
139 typedef struct _GtkRequisition     GtkRequisition;
140 typedef         GdkRectangle       GtkAllocation;
141 typedef struct _GtkSelectionData   GtkSelectionData;
142 typedef struct _GtkWidgetClass     GtkWidgetClass;
143 typedef struct _GtkWidgetAuxInfo   GtkWidgetAuxInfo;
144 typedef struct _GtkWidgetShapeInfo GtkWidgetShapeInfo;
145 typedef struct _GtkClipboard       GtkClipboard;
146 typedef void     (*GtkCallback)        (GtkWidget        *widget,
147                                         gpointer          data);
148
149 /* A requisition is a desired amount of space which a
150  *  widget may request.
151  */
152 struct _GtkRequisition
153 {
154   gint width;
155   gint height;
156 };
157
158 /* The widget is the base of the tree for displayable objects.
159  *  (A displayable object is one which takes up some amount
160  *  of screen real estate). It provides a common base and interface
161  *  which actual widgets must adhere to.
162  */
163 struct _GtkWidget
164 {
165   /* The object structure needs to be the first
166    *  element in the widget structure in order for
167    *  the object mechanism to work correctly. This
168    *  allows a GtkWidget pointer to be cast to a
169    *  GtkObject pointer.
170    */
171   GtkObject object;
172   
173   /* 16 bits of internally used private flags.
174    * this will be packed into the same 4 byte alignment frame that
175    * state and saved_state go. we therefore don't waste any new
176    * space on this.
177    */
178   guint16 private_flags;
179   
180   /* The state of the widget. There are actually only
181    *  5 widget states (defined in "gtkenums.h").
182    */
183   guint8 state;
184   
185   /* The saved state of the widget. When a widgets state
186    *  is changed to GTK_STATE_INSENSITIVE via
187    *  "gtk_widget_set_state" or "gtk_widget_set_sensitive"
188    *  the old state is kept around in this field. The state
189    *  will be restored once the widget gets sensitive again.
190    */
191   guint8 saved_state;
192   
193   /* The widgets name. If the widget does not have a name
194    *  (the name is NULL), then its name (as returned by
195    *  "gtk_widget_get_name") is its classes name.
196    * Among other things, the widget name is used to determine
197    *  the style to use for a widget.
198    */
199   gchar *name;
200   
201   /*< public >*/
202
203   /* The style for the widget. The style contains the
204    *  colors the widget should be drawn in for each state
205    *  along with graphics contexts used to draw with and
206    *  the font to use for text.
207    */
208   GtkStyle *style;
209   
210   /* The widgets desired size.
211    */
212   GtkRequisition requisition;
213   
214   /* The widgets allocated size.
215    */
216   GtkAllocation allocation;
217   
218   /* The widgets window or its parent window if it does
219    *  not have a window. (Which will be indicated by the
220    *  GTK_NO_WINDOW flag being set).
221    */
222   GdkWindow *window;
223   
224   /* The widgets parent.
225    */
226   GtkWidget *parent;
227 };
228
229 struct _GtkWidgetClass
230 {
231   /* The object class structure needs to be the first
232    *  element in the widget class structure in order for
233    *  the class mechanism to work correctly. This allows a
234    *  GtkWidgetClass pointer to be cast to a GtkObjectClass
235    *  pointer.
236    */
237   GtkObjectClass parent_class;
238
239   /*< public >*/
240   
241   guint activate_signal;
242
243   guint set_scroll_adjustments_signal;
244
245   /*< private >*/
246   
247   /* seldomly overidden */
248   void (*dispatch_child_properties_changed) (GtkWidget   *widget,
249                                              guint        n_pspecs,
250                                              GParamSpec **pspecs);
251
252   /* basics */
253   void (* show)                (GtkWidget        *widget);
254   void (* show_all)            (GtkWidget        *widget);
255   void (* hide)                (GtkWidget        *widget);
256   void (* hide_all)            (GtkWidget        *widget);
257   void (* map)                 (GtkWidget        *widget);
258   void (* unmap)               (GtkWidget        *widget);
259   void (* realize)             (GtkWidget        *widget);
260   void (* unrealize)           (GtkWidget        *widget);
261   void (* size_request)        (GtkWidget        *widget,
262                                 GtkRequisition   *requisition);
263   void (* size_allocate)       (GtkWidget        *widget,
264                                 GtkAllocation    *allocation);
265   void (* state_changed)       (GtkWidget        *widget,
266                                 GtkStateType      previous_state);
267   void (* parent_set)          (GtkWidget        *widget,
268                                 GtkWidget        *previous_parent);
269   void (* hierarchy_changed)   (GtkWidget        *widget,
270                                 GtkWidget        *previous_toplevel);
271   void (* style_set)           (GtkWidget        *widget,
272                                 GtkStyle         *previous_style);
273   void (* direction_changed)   (GtkWidget        *widget,
274                                 GtkTextDirection  previous_direction);
275   void (* grab_notify)         (GtkWidget        *widget,
276                                 gboolean          was_grabbed);
277   void (* child_notify)        (GtkWidget        *widget,
278                                 GParamSpec       *pspec);
279   
280   /* Mnemonics */
281   gboolean (* mnemonic_activate) (GtkWidget    *widget,
282                                   gboolean      group_cycling);
283   
284   /* explicit focus */
285   void     (* grab_focus)      (GtkWidget        *widget);
286   gboolean (* focus)           (GtkWidget        *widget,
287                                 GtkDirectionType  direction);
288   
289   /* events */
290   gboolean (* event)                    (GtkWidget           *widget,
291                                          GdkEvent            *event);
292   gboolean (* button_press_event)       (GtkWidget           *widget,
293                                          GdkEventButton      *event);
294   gboolean (* button_release_event)     (GtkWidget           *widget,
295                                          GdkEventButton      *event);
296   gboolean (* scroll_event)             (GtkWidget           *widget,
297                                          GdkEventScroll      *event);
298   gboolean (* motion_notify_event)      (GtkWidget           *widget,
299                                          GdkEventMotion      *event);
300   gboolean (* delete_event)             (GtkWidget           *widget,
301                                          GdkEventAny         *event);
302   gboolean (* destroy_event)            (GtkWidget           *widget,
303                                          GdkEventAny         *event);
304   gboolean (* expose_event)             (GtkWidget           *widget,
305                                          GdkEventExpose      *event);
306   gboolean (* key_press_event)          (GtkWidget           *widget,
307                                          GdkEventKey         *event);
308   gboolean (* key_release_event)        (GtkWidget           *widget,
309                                          GdkEventKey         *event);
310   gboolean (* enter_notify_event)       (GtkWidget           *widget,
311                                          GdkEventCrossing    *event);
312   gboolean (* leave_notify_event)       (GtkWidget           *widget,
313                                          GdkEventCrossing    *event);
314   gboolean (* configure_event)          (GtkWidget           *widget,
315                                          GdkEventConfigure   *event);
316   gboolean (* focus_in_event)           (GtkWidget           *widget,
317                                          GdkEventFocus       *event);
318   gboolean (* focus_out_event)          (GtkWidget           *widget,
319                                          GdkEventFocus       *event);
320   gboolean (* map_event)                (GtkWidget           *widget,
321                                          GdkEventAny         *event);
322   gboolean (* unmap_event)              (GtkWidget           *widget,
323                                          GdkEventAny         *event);
324   gboolean (* property_notify_event)    (GtkWidget           *widget,
325                                          GdkEventProperty    *event);
326   gboolean (* selection_clear_event)    (GtkWidget           *widget,
327                                          GdkEventSelection   *event);
328   gboolean (* selection_request_event)  (GtkWidget           *widget,
329                                          GdkEventSelection   *event);
330   gboolean (* selection_notify_event)   (GtkWidget           *widget,
331                                          GdkEventSelection   *event);
332   gboolean (* proximity_in_event)       (GtkWidget           *widget,
333                                          GdkEventProximity   *event);
334   gboolean (* proximity_out_event)      (GtkWidget           *widget,
335                                          GdkEventProximity   *event);
336   gboolean (* visibility_notify_event)  (GtkWidget           *widget,
337                                          GdkEventVisibility  *event);
338   gboolean (* client_event)             (GtkWidget           *widget,
339                                          GdkEventClient      *event);
340   gboolean (* no_expose_event)          (GtkWidget           *widget,
341                                          GdkEventAny         *event);
342   gboolean (* window_state_event)       (GtkWidget           *widget,
343                                          GdkEventWindowState *event);
344   
345   /* selection */
346   void (* selection_get)           (GtkWidget          *widget,
347                                     GtkSelectionData   *selection_data,
348                                     guint               info,
349                                     guint               time_);
350   void (* selection_received)      (GtkWidget          *widget,
351                                     GtkSelectionData   *selection_data,
352                                     guint               time_);
353
354   /* Source side drag signals */
355   void (* drag_begin)              (GtkWidget          *widget,
356                                     GdkDragContext     *context);
357   void (* drag_end)                (GtkWidget          *widget,
358                                     GdkDragContext     *context);
359   void (* drag_data_get)           (GtkWidget          *widget,
360                                     GdkDragContext     *context,
361                                     GtkSelectionData   *selection_data,
362                                     guint               info,
363                                     guint               time_);
364   void (* drag_data_delete)        (GtkWidget          *widget,
365                                     GdkDragContext     *context);
366
367   /* Target side drag signals */
368   void (* drag_leave)              (GtkWidget          *widget,
369                                     GdkDragContext     *context,
370                                     guint               time_);
371   gboolean (* drag_motion)         (GtkWidget          *widget,
372                                     GdkDragContext     *context,
373                                     gint                x,
374                                     gint                y,
375                                     guint               time_);
376   gboolean (* drag_drop)           (GtkWidget          *widget,
377                                     GdkDragContext     *context,
378                                     gint                x,
379                                     gint                y,
380                                     guint               time_);
381   void (* drag_data_received)      (GtkWidget          *widget,
382                                     GdkDragContext     *context,
383                                     gint                x,
384                                     gint                y,
385                                     GtkSelectionData   *selection_data,
386                                     guint               info,
387                                     guint               time_);
388
389   /* Signals used only for keybindings */
390   gboolean (* popup_menu)          (GtkWidget          *widget);
391
392   /* If a widget has multiple tooltips/whatsthis, it should show the
393    * one for the current focus location, or if that doesn't make
394    * sense, should cycle through them showing each tip alongside
395    * whatever piece of the widget it applies to.
396    */
397   gboolean (* show_help)           (GtkWidget          *widget,
398                                     GtkWidgetHelpType   help_type);
399   
400   /* accessibility support 
401    */
402   AtkObject*   (*get_accessible)     (GtkWidget *widget);
403
404   void         (*screen_changed)     (GtkWidget *widget,
405                                       GdkScreen *previous_screen);
406   gboolean     (*can_activate_accel) (GtkWidget *widget,
407                                       guint      signal_id);
408
409   /* Padding for future expansion */
410   void (*_gtk_reserved2) (void);
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);
416 };
417
418 struct _GtkWidgetAuxInfo
419 {
420   gint x;
421   gint y;
422   gint width;
423   gint height;
424   guint x_set : 1;
425   guint y_set : 1;
426 };
427
428 struct _GtkWidgetShapeInfo
429 {
430   gint16     offset_x;
431   gint16     offset_y;
432   GdkBitmap *shape_mask;
433 };
434
435 GType      gtk_widget_get_type            (void) G_GNUC_CONST;
436 GtkWidget* gtk_widget_new                 (GType                type,
437                                            const gchar         *first_property_name,
438                                            ...);
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                                            ...);
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);
462
463 /* Queuing draws */
464 void       gtk_widget_queue_draw          (GtkWidget           *widget);
465 void       gtk_widget_queue_draw_area     (GtkWidget           *widget,
466                                            gint                 x,
467                                            gint                 y,
468                                            gint                 width,
469                                            gint                 height);
470 #ifndef GTK_DISABLE_DEPRECATED
471 void       gtk_widget_queue_clear         (GtkWidget           *widget);
472 void       gtk_widget_queue_clear_area    (GtkWidget           *widget,
473                                            gint                 x,
474                                            gint                 y,
475                                            gint                 width,
476                                            gint                 height);
477 #endif /* GTK_DISABLE_DEPRECATED */
478
479
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,
484                                            GdkRectangle        *area);
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,
495                                            guint                accel_key,
496                                            GdkModifierType      accel_mods,
497                                            GtkAccelFlags        accel_flags);
498 gboolean   gtk_widget_remove_accelerator  (GtkWidget           *widget,
499                                            GtkAccelGroup       *accel_group,
500                                            guint                accel_key,
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,
506                                            gboolean            *locked);
507 GList*     gtk_widget_list_accel_closures (GtkWidget           *widget);
508 gboolean   gtk_widget_can_activate_accel  (GtkWidget           *widget,
509                                            guint                signal_id);
510 gboolean   gtk_widget_mnemonic_activate   (GtkWidget           *widget,
511                                            gboolean             group_cycling);
512 gboolean   gtk_widget_event               (GtkWidget           *widget,
513                                            GdkEvent            *event);
514 gint       gtk_widget_send_expose         (GtkWidget           *widget,
515                                            GdkEvent            *event);
516
517 gboolean   gtk_widget_activate               (GtkWidget        *widget);
518 gboolean   gtk_widget_set_scroll_adjustments (GtkWidget        *widget,
519                                               GtkAdjustment    *hadjustment,
520                                               GtkAdjustment    *vadjustment);
521      
522 void       gtk_widget_reparent            (GtkWidget           *widget,
523                                            GtkWidget           *new_parent);
524 gboolean   gtk_widget_intersect           (GtkWidget           *widget,
525                                            GdkRectangle        *area,
526                                            GdkRectangle        *intersection);
527 GdkRegion *gtk_widget_region_intersect    (GtkWidget           *widget,
528                                            GdkRegion           *region);
529
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);
534
535 gboolean   gtk_widget_is_focus            (GtkWidget           *widget);
536 void       gtk_widget_grab_focus          (GtkWidget           *widget);
537 void       gtk_widget_grab_default        (GtkWidget           *widget);
538
539 void                  gtk_widget_set_name               (GtkWidget    *widget,
540                                                          const gchar  *name);
541 G_CONST_RETURN gchar* gtk_widget_get_name               (GtkWidget    *widget);
542 void                  gtk_widget_set_state              (GtkWidget    *widget,
543                                                          GtkStateType  state);
544 void                  gtk_widget_set_sensitive          (GtkWidget    *widget,
545                                                          gboolean      sensitive);
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,
553                                                          GtkWidget    *parent);
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);
559
560 GtkWidget *gtk_widget_get_parent          (GtkWidget           *widget);
561 GdkWindow *gtk_widget_get_parent_window   (GtkWidget           *widget);
562
563 gboolean   gtk_widget_child_focus         (GtkWidget           *widget,
564                                            GtkDirectionType     direction);
565
566 void       gtk_widget_set_size_request    (GtkWidget           *widget,
567                                            gint                 width,
568                                            gint                 height);
569 void       gtk_widget_get_size_request    (GtkWidget           *widget,
570                                            gint                *width,
571                                            gint                *height);
572 #ifndef GTK_DISABLE_DEPRECATED
573 void       gtk_widget_set_uposition       (GtkWidget           *widget,
574                                            gint                 x,
575                                            gint                 y);
576 void       gtk_widget_set_usize           (GtkWidget           *widget,
577                                            gint                 width,
578                                            gint                 height);
579 #endif
580
581 void       gtk_widget_set_events          (GtkWidget           *widget,
582                                            gint                 events);
583 void       gtk_widget_add_events          (GtkWidget           *widget,
584                                            gint                 events);
585 void       gtk_widget_set_extension_events (GtkWidget           *widget,
586                                             GdkExtensionMode    mode);
587
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,
591                                          GType           widget_type);
592 GdkColormap* gtk_widget_get_colormap    (GtkWidget      *widget);
593 GdkVisual*   gtk_widget_get_visual      (GtkWidget      *widget);
594
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,
601                                           GdkAtom    selection);
602
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 */
609
610 /* Accessibility support */
611 AtkObject*       gtk_widget_get_accessible               (GtkWidget          *widget);
612
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.
618  */
619 void         gtk_widget_set_colormap    (GtkWidget      *widget,
620                                          GdkColormap    *colormap);
621
622 gint         gtk_widget_get_events      (GtkWidget      *widget);
623 void         gtk_widget_get_pointer     (GtkWidget      *widget,
624                                          gint           *x,
625                                          gint           *y);
626
627 gboolean     gtk_widget_is_ancestor     (GtkWidget      *widget,
628                                          GtkWidget      *ancestor);
629
630 gboolean     gtk_widget_translate_coordinates (GtkWidget  *src_widget,
631                                                GtkWidget  *dest_widget,
632                                                gint        src_x,
633                                                gint        src_y,
634                                                gint       *dest_x,
635                                                gint       *dest_y);
636
637 /* Hide widget and return TRUE.
638  */
639 gboolean     gtk_widget_hide_on_delete  (GtkWidget      *widget);
640
641 /* Widget styles.
642  */
643 void       gtk_widget_set_style         (GtkWidget      *widget,
644                                          GtkStyle       *style);
645 void       gtk_widget_ensure_style      (GtkWidget      *widget);
646 GtkStyle*  gtk_widget_get_style         (GtkWidget      *widget);
647
648 void        gtk_widget_modify_style       (GtkWidget            *widget,
649                                            GtkRcStyle           *style);
650 GtkRcStyle *gtk_widget_get_modifier_style (GtkWidget            *widget);
651 void        gtk_widget_modify_fg          (GtkWidget            *widget,
652                                            GtkStateType          state,
653                                            const GdkColor       *color);
654 void        gtk_widget_modify_bg          (GtkWidget            *widget,
655                                            GtkStateType          state,
656                                            const GdkColor       *color);
657 void        gtk_widget_modify_text        (GtkWidget            *widget,
658                                            GtkStateType          state,
659                                            const GdkColor       *color);
660 void        gtk_widget_modify_base        (GtkWidget            *widget,
661                                            GtkStateType          state,
662                                            const GdkColor       *color);
663 void        gtk_widget_modify_font        (GtkWidget            *widget,
664                                            PangoFontDescription *font_desc);
665
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))
669 #endif
670
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,
674                                                const gchar *text);
675
676 GdkPixbuf    *gtk_widget_render_icon          (GtkWidget   *widget,
677                                                const gchar *stock_id,
678                                                GtkIconSize  size,
679                                                const gchar *detail);
680
681 /* handle composite names for GTK_COMPOSITE_CHILD widgets,
682  * the returned name is newly allocated.
683  */
684 void   gtk_widget_set_composite_name    (GtkWidget      *widget,
685                                          const gchar    *name);
686 gchar* gtk_widget_get_composite_name    (GtkWidget      *widget);
687      
688 /* Descend recursively and set rc-style on all widgets without user styles */
689 void       gtk_widget_reset_rc_styles   (GtkWidget      *widget);
690
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.
694  */
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);
699
700 /* widget style properties
701  */
702 void gtk_widget_class_install_style_property        (GtkWidgetClass     *klass,
703                                                      GParamSpec         *pspec);
704 void gtk_widget_class_install_style_property_parser (GtkWidgetClass     *klass,
705                                                      GParamSpec         *pspec,
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,
713                                     GValue           *value);
714 void gtk_widget_style_get_valist   (GtkWidget        *widget,
715                                     const gchar    *first_property_name,
716                                     va_list         var_args);
717 void gtk_widget_style_get          (GtkWidget        *widget,
718                                     const gchar    *first_property_name,
719                                     ...);
720
721
722 /* Set certain default values to be used at widget creation time.
723  */
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);
729 #endif
730
731 /* Functions for setting directionality for widgets
732  */
733
734 void             gtk_widget_set_direction         (GtkWidget        *widget,
735                                                    GtkTextDirection  dir);
736 GtkTextDirection gtk_widget_get_direction         (GtkWidget        *widget);
737
738 void             gtk_widget_set_default_direction (GtkTextDirection  dir);
739 GtkTextDirection gtk_widget_get_default_direction (void);
740
741 /* Counterpart to gdk_window_shape_combine_mask.
742  */
743 void         gtk_widget_shape_combine_mask (GtkWidget *widget,
744                                             GdkBitmap *shape_mask,
745                                             gint       offset_x,
746                                             gint       offset_y);
747
748 /* internal function */
749 void         gtk_widget_reset_shapes       (GtkWidget *widget);
750
751 /* Compute a widget's path in the form "GtkWindow.MyLabel", and
752  * return newly alocated strings.
753  */
754 void         gtk_widget_path               (GtkWidget *widget,
755                                             guint     *path_length,
756                                             gchar    **path,
757                                             gchar    **path_reversed);
758 void         gtk_widget_class_path         (GtkWidget *widget,
759                                             guint     *path_length,
760                                             gchar    **path,
761                                             gchar    **path_reversed);
762
763 GList* gtk_widget_get_mnemonic_labels   (GtkWidget *widget);
764 void   gtk_widget_add_mnemonic_label    (GtkWidget *widget,
765                                          GtkWidget *label);
766 void   gtk_widget_remove_mnemonic_label (GtkWidget *widget,
767                                          GtkWidget *label);
768
769 GType           gtk_requisition_get_type (void);
770 GtkRequisition *gtk_requisition_copy     (const GtkRequisition *requisition);
771 void            gtk_requisition_free     (GtkRequisition       *requisition);
772
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__ */
777
778 GtkWidgetAuxInfo *_gtk_widget_get_aux_info                (GtkWidget    *widget,
779                                                            gboolean      create);
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);
784
785 GdkColormap* _gtk_widget_peek_colormap (void);
786
787 #ifdef __cplusplus
788 }
789 #endif /* __cplusplus */
790
791
792 #endif /* __GTK_WIDGET_H__ */