]> Pileus Git - ~andy/gtk/blob - gtk/gtkwidget.h
Fix ZWJ => ZWN typo. (#83092, Tino Meinen)
[~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 } GtkWidgetFlags;
81
82 /* Kinds of widget-specific help */
83 typedef enum
84 {
85   GTK_WIDGET_HELP_TOOLTIP,
86   GTK_WIDGET_HELP_WHATS_THIS
87 } GtkWidgetHelpType;
88
89 /* Macro for casting a pointer to a GtkWidget or GtkWidgetClass pointer.
90  * Macros for testing whether `widget' or `klass' are of type GTK_TYPE_WIDGET.
91  */
92 #define GTK_TYPE_WIDGET                   (gtk_widget_get_type ())
93 #define GTK_WIDGET(widget)                (GTK_CHECK_CAST ((widget), GTK_TYPE_WIDGET, GtkWidget))
94 #define GTK_WIDGET_CLASS(klass)           (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_WIDGET, GtkWidgetClass))
95 #define GTK_IS_WIDGET(widget)             (GTK_CHECK_TYPE ((widget), GTK_TYPE_WIDGET))
96 #define GTK_IS_WIDGET_CLASS(klass)        (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WIDGET))
97 #define GTK_WIDGET_GET_CLASS(obj)         (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_WIDGET, GtkWidgetClass))
98
99 /* Macros for extracting various fields from GtkWidget and GtkWidgetClass.
100  */
101 #define GTK_WIDGET_TYPE(wid)              (GTK_OBJECT_TYPE (wid))
102 #define GTK_WIDGET_STATE(wid)             (GTK_WIDGET (wid)->state)
103 #define GTK_WIDGET_SAVED_STATE(wid)       (GTK_WIDGET (wid)->saved_state)
104
105 /* Macros for extracting the widget flags from GtkWidget.
106  */
107 #define GTK_WIDGET_FLAGS(wid)             (GTK_OBJECT_FLAGS (wid))
108 #define GTK_WIDGET_TOPLEVEL(wid)          ((GTK_WIDGET_FLAGS (wid) & GTK_TOPLEVEL) != 0)
109 #define GTK_WIDGET_NO_WINDOW(wid)         ((GTK_WIDGET_FLAGS (wid) & GTK_NO_WINDOW) != 0)
110 #define GTK_WIDGET_REALIZED(wid)          ((GTK_WIDGET_FLAGS (wid) & GTK_REALIZED) != 0)
111 #define GTK_WIDGET_MAPPED(wid)            ((GTK_WIDGET_FLAGS (wid) & GTK_MAPPED) != 0)
112 #define GTK_WIDGET_VISIBLE(wid)           ((GTK_WIDGET_FLAGS (wid) & GTK_VISIBLE) != 0)
113 #define GTK_WIDGET_DRAWABLE(wid)          (GTK_WIDGET_VISIBLE (wid) && GTK_WIDGET_MAPPED (wid))
114 #define GTK_WIDGET_SENSITIVE(wid)         ((GTK_WIDGET_FLAGS (wid) & GTK_SENSITIVE) != 0)
115 #define GTK_WIDGET_PARENT_SENSITIVE(wid)  ((GTK_WIDGET_FLAGS (wid) & GTK_PARENT_SENSITIVE) != 0)
116 #define GTK_WIDGET_IS_SENSITIVE(wid)      (GTK_WIDGET_SENSITIVE (wid) && \
117                                            GTK_WIDGET_PARENT_SENSITIVE (wid))
118 #define GTK_WIDGET_CAN_FOCUS(wid)         ((GTK_WIDGET_FLAGS (wid) & GTK_CAN_FOCUS) != 0)
119 #define GTK_WIDGET_HAS_FOCUS(wid)         ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_FOCUS) != 0)
120 #define GTK_WIDGET_CAN_DEFAULT(wid)       ((GTK_WIDGET_FLAGS (wid) & GTK_CAN_DEFAULT) != 0)
121 #define GTK_WIDGET_HAS_DEFAULT(wid)       ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_DEFAULT) != 0)
122 #define GTK_WIDGET_HAS_GRAB(wid)          ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_GRAB) != 0)
123 #define GTK_WIDGET_RC_STYLE(wid)          ((GTK_WIDGET_FLAGS (wid) & GTK_RC_STYLE) != 0)
124 #define GTK_WIDGET_COMPOSITE_CHILD(wid)   ((GTK_WIDGET_FLAGS (wid) & GTK_COMPOSITE_CHILD) != 0)
125 #define GTK_WIDGET_APP_PAINTABLE(wid)     ((GTK_WIDGET_FLAGS (wid) & GTK_APP_PAINTABLE) != 0)
126 #define GTK_WIDGET_RECEIVES_DEFAULT(wid)  ((GTK_WIDGET_FLAGS (wid) & GTK_RECEIVES_DEFAULT) != 0)
127 #define GTK_WIDGET_DOUBLE_BUFFERED(wid)   ((GTK_WIDGET_FLAGS (wid) & GTK_DOUBLE_BUFFERED) != 0)
128   
129 /* Macros for setting and clearing widget flags.
130  */
131 #define GTK_WIDGET_SET_FLAGS(wid,flag)    G_STMT_START{ (GTK_WIDGET_FLAGS (wid) |= (flag)); }G_STMT_END
132 #define GTK_WIDGET_UNSET_FLAGS(wid,flag)  G_STMT_START{ (GTK_WIDGET_FLAGS (wid) &= ~(flag)); }G_STMT_END
133
134 #define GTK_TYPE_REQUISITION              (gtk_requisition_get_type ())
135
136 /* forward declaration to avoid excessive includes (and concurrent includes)
137  */
138 typedef struct _GtkRequisition     GtkRequisition;
139 typedef         GdkRectangle       GtkAllocation;
140 typedef struct _GtkSelectionData   GtkSelectionData;
141 typedef struct _GtkWidgetClass     GtkWidgetClass;
142 typedef struct _GtkWidgetAuxInfo   GtkWidgetAuxInfo;
143 typedef struct _GtkWidgetShapeInfo GtkWidgetShapeInfo;
144 typedef struct _GtkClipboard       GtkClipboard;
145 typedef void     (*GtkCallback)        (GtkWidget        *widget,
146                                         gpointer          data);
147
148 /* A requisition is a desired amount of space which a
149  *  widget may request.
150  */
151 struct _GtkRequisition
152 {
153   gint width;
154   gint height;
155 };
156
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.
161  */
162 struct _GtkWidget
163 {
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
168    *  GtkObject pointer.
169    */
170   GtkObject object;
171   
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
175    * space on this.
176    */
177   guint16 private_flags;
178   
179   /* The state of the widget. There are actually only
180    *  5 widget states (defined in "gtkenums.h").
181    */
182   guint8 state;
183   
184   /* The saved state of the widget. When a widgets 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.
189    */
190   guint8 saved_state;
191   
192   /* The widgets 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 classes name.
195    * Among other things, the widget name is used to determine
196    *  the style to use for a widget.
197    */
198   gchar *name;
199   
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.
204    */
205   GtkStyle *style;
206   
207   /* The widgets desired size.
208    */
209   GtkRequisition requisition;
210   
211   /* The widgets allocated size.
212    */
213   GtkAllocation allocation;
214   
215   /* The widgets 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).
218    */
219   GdkWindow *window;
220   
221   /* The widgets parent.
222    */
223   GtkWidget *parent;
224 };
225
226 struct _GtkWidgetClass
227 {
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
232    *  pointer.
233    */
234   GtkObjectClass parent_class;
235   
236   /* The signal to emit when a widget of this class is activated,
237    * gtk_widget_activate() handles the emission.
238    * Implementation of this signal is optional.
239    */
240   guint activate_signal;
241
242   /* This signal is emitted  when a widget of this class is added
243    * to a scrolling aware parent, gtk_widget_set_scroll_adjustments()
244    * handles the emission.
245    * Implementation of this signal is optional.
246    */
247   guint set_scroll_adjustments_signal;
248
249   /* seldomly overidden */
250   void (*dispatch_child_properties_changed) (GtkWidget   *widget,
251                                              guint        n_pspecs,
252                                              GParamSpec **pspecs);
253
254   /* basics */
255   void (* show)                (GtkWidget        *widget);
256   void (* show_all)            (GtkWidget        *widget);
257   void (* hide)                (GtkWidget        *widget);
258   void (* hide_all)            (GtkWidget        *widget);
259   void (* map)                 (GtkWidget        *widget);
260   void (* unmap)               (GtkWidget        *widget);
261   void (* realize)             (GtkWidget        *widget);
262   void (* unrealize)           (GtkWidget        *widget);
263   void (* size_request)        (GtkWidget        *widget,
264                                 GtkRequisition   *requisition);
265   void (* size_allocate)       (GtkWidget        *widget,
266                                 GtkAllocation    *allocation);
267   void (* state_changed)       (GtkWidget        *widget,
268                                 GtkStateType      previous_state);
269   void (* parent_set)          (GtkWidget        *widget,
270                                 GtkWidget        *previous_parent);
271   void (* hierarchy_changed)   (GtkWidget        *widget,
272                                 GtkWidget        *previous_toplevel);
273   void (* style_set)           (GtkWidget        *widget,
274                                 GtkStyle         *previous_style);
275   void (* direction_changed)   (GtkWidget        *widget,
276                                 GtkTextDirection  previous_direction);
277   void (* grab_notify)         (GtkWidget        *widget,
278                                 gboolean          was_grabbed);
279   void (* child_notify)        (GtkWidget        *widget,
280                                 GParamSpec       *pspec);
281   
282   /* Mnemonics */
283   gboolean (* mnemonic_activate) (GtkWidget    *widget,
284                                   gboolean      group_cycling);
285   
286   /* explicit focus */
287   void     (* grab_focus)      (GtkWidget        *widget);
288   gboolean (* focus)           (GtkWidget        *widget,
289                                 GtkDirectionType  direction);
290   
291   /* events */
292   gboolean (* event)                    (GtkWidget           *widget,
293                                          GdkEvent            *event);
294   gboolean (* button_press_event)       (GtkWidget           *widget,
295                                          GdkEventButton      *event);
296   gboolean (* button_release_event)     (GtkWidget           *widget,
297                                          GdkEventButton      *event);
298   gboolean (* scroll_event)             (GtkWidget           *widget,
299                                          GdkEventScroll      *event);
300   gboolean (* motion_notify_event)      (GtkWidget           *widget,
301                                          GdkEventMotion      *event);
302   gboolean (* delete_event)             (GtkWidget           *widget,
303                                          GdkEventAny         *event);
304   gboolean (* destroy_event)            (GtkWidget           *widget,
305                                          GdkEventAny         *event);
306   gboolean (* expose_event)             (GtkWidget           *widget,
307                                          GdkEventExpose      *event);
308   gboolean (* key_press_event)          (GtkWidget           *widget,
309                                          GdkEventKey         *event);
310   gboolean (* key_release_event)        (GtkWidget           *widget,
311                                          GdkEventKey         *event);
312   gboolean (* enter_notify_event)       (GtkWidget           *widget,
313                                          GdkEventCrossing    *event);
314   gboolean (* leave_notify_event)       (GtkWidget           *widget,
315                                          GdkEventCrossing    *event);
316   gboolean (* configure_event)          (GtkWidget           *widget,
317                                          GdkEventConfigure   *event);
318   gboolean (* focus_in_event)           (GtkWidget           *widget,
319                                          GdkEventFocus       *event);
320   gboolean (* focus_out_event)          (GtkWidget           *widget,
321                                          GdkEventFocus       *event);
322   gboolean (* map_event)                (GtkWidget           *widget,
323                                          GdkEventAny         *event);
324   gboolean (* unmap_event)              (GtkWidget           *widget,
325                                          GdkEventAny         *event);
326   gboolean (* property_notify_event)    (GtkWidget           *widget,
327                                          GdkEventProperty    *event);
328   gboolean (* selection_clear_event)    (GtkWidget           *widget,
329                                          GdkEventSelection   *event);
330   gboolean (* selection_request_event)  (GtkWidget           *widget,
331                                          GdkEventSelection   *event);
332   gboolean (* selection_notify_event)   (GtkWidget           *widget,
333                                          GdkEventSelection   *event);
334   gboolean (* proximity_in_event)       (GtkWidget           *widget,
335                                          GdkEventProximity   *event);
336   gboolean (* proximity_out_event)      (GtkWidget           *widget,
337                                          GdkEventProximity   *event);
338   gboolean (* visibility_notify_event)  (GtkWidget           *widget,
339                                          GdkEventVisibility  *event);
340   gboolean (* client_event)             (GtkWidget           *widget,
341                                          GdkEventClient      *event);
342   gboolean (* no_expose_event)          (GtkWidget           *widget,
343                                          GdkEventAny         *event);
344   gboolean (* window_state_event)       (GtkWidget           *widget,
345                                          GdkEventWindowState *event);
346   
347   /* selection */
348   void (* selection_get)           (GtkWidget          *widget,
349                                     GtkSelectionData   *selection_data,
350                                     guint               info,
351                                     guint               time);
352   void (* selection_received)      (GtkWidget          *widget,
353                                     GtkSelectionData   *selection_data,
354                                     guint               time);
355
356   /* Source side drag signals */
357   void (* drag_begin)              (GtkWidget          *widget,
358                                     GdkDragContext     *context);
359   void (* drag_end)                (GtkWidget          *widget,
360                                     GdkDragContext     *context);
361   void (* drag_data_get)           (GtkWidget          *widget,
362                                     GdkDragContext     *context,
363                                     GtkSelectionData   *selection_data,
364                                     guint               info,
365                                     guint               time);
366   void (* drag_data_delete)        (GtkWidget          *widget,
367                                     GdkDragContext     *context);
368
369   /* Target side drag signals */
370   void (* drag_leave)              (GtkWidget          *widget,
371                                     GdkDragContext     *context,
372                                     guint               time);
373   gboolean (* drag_motion)         (GtkWidget          *widget,
374                                     GdkDragContext     *context,
375                                     gint                x,
376                                     gint                y,
377                                     guint               time);
378   gboolean (* drag_drop)           (GtkWidget          *widget,
379                                     GdkDragContext     *context,
380                                     gint                x,
381                                     gint                y,
382                                     guint               time);
383   void (* drag_data_received)      (GtkWidget          *widget,
384                                     GdkDragContext     *context,
385                                     gint                x,
386                                     gint                y,
387                                     GtkSelectionData   *selection_data,
388                                     guint               info,
389                                     guint               time);
390
391   /* Signals used only for keybindings */
392   gboolean (* popup_menu)          (GtkWidget          *widget);
393
394   /* If a widget has multiple tooltips/whatsthis, it should show the
395    * one for the current focus location, or if that doesn't make
396    * sense, should cycle through them showing each tip alongside
397    * whatever piece of the widget it applies to.
398    */
399   gboolean (* show_help)           (GtkWidget          *widget,
400                                     GtkWidgetHelpType   help_type);
401   
402   /* accessibility support 
403    */
404   AtkObject*   (* get_accessible)  (GtkWidget          *widget);
405
406   /* Padding for future expansion */
407   void (*_gtk_reserved1) (void);
408   void (*_gtk_reserved2) (void);
409   void (*_gtk_reserved3) (void);
410   void (*_gtk_reserved4) (void);
411   void (*_gtk_reserved5) (void);
412   void (*_gtk_reserved6) (void);
413   void (*_gtk_reserved7) (void);
414   void (*_gtk_reserved8) (void);
415 };
416
417 struct _GtkWidgetAuxInfo
418 {
419   gint x;
420   gint y;
421   gint width;
422   gint height;
423   guint x_set : 1;
424   guint y_set : 1;
425 };
426
427 struct _GtkWidgetShapeInfo
428 {
429   gint16     offset_x;
430   gint16     offset_y;
431   GdkBitmap *shape_mask;
432 };
433
434 GtkType    gtk_widget_get_type            (void) G_GNUC_CONST;
435 GtkWidget* gtk_widget_new                 (GtkType              type,
436                                            const gchar         *first_property_name,
437                                            ...);
438 GtkWidget* gtk_widget_ref                 (GtkWidget           *widget);
439 void       gtk_widget_unref               (GtkWidget           *widget);
440 void       gtk_widget_destroy             (GtkWidget           *widget);
441 void       gtk_widget_destroyed           (GtkWidget           *widget,
442                                            GtkWidget          **widget_pointer);
443 #ifndef GTK_DISABLE_DEPRECATED
444 void       gtk_widget_set                 (GtkWidget           *widget,
445                                            const gchar         *first_property_name,
446                                            ...);
447 #endif /* GTK_DISABLE_DEPRECATED */
448 void       gtk_widget_unparent            (GtkWidget           *widget);
449 void       gtk_widget_show                (GtkWidget           *widget);
450 void       gtk_widget_show_now            (GtkWidget           *widget);
451 void       gtk_widget_hide                (GtkWidget           *widget);
452 void       gtk_widget_show_all            (GtkWidget           *widget);
453 void       gtk_widget_hide_all            (GtkWidget           *widget);
454 void       gtk_widget_map                 (GtkWidget           *widget);
455 void       gtk_widget_unmap               (GtkWidget           *widget);
456 void       gtk_widget_realize             (GtkWidget           *widget);
457 void       gtk_widget_unrealize           (GtkWidget           *widget);
458
459 /* Queuing draws */
460 void       gtk_widget_queue_draw          (GtkWidget           *widget);
461 void       gtk_widget_queue_draw_area     (GtkWidget           *widget,
462                                            gint                 x,
463                                            gint                 y,
464                                            gint                 width,
465                                            gint                 height);
466 #ifndef GTK_DISABLE_DEPRECATED
467 void       gtk_widget_queue_clear         (GtkWidget           *widget);
468 void       gtk_widget_queue_clear_area    (GtkWidget           *widget,
469                                            gint                 x,
470                                            gint                 y,
471                                            gint                 width,
472                                            gint                 height);
473 #endif /* GTK_DISABLE_DEPRECATED */
474
475
476 void       gtk_widget_queue_resize        (GtkWidget           *widget);
477 #ifndef GTK_DISABLE_DEPRECATED
478 void       gtk_widget_draw                (GtkWidget           *widget,
479                                            GdkRectangle        *area);
480 #endif /* GTK_DISABLE_DEPRECATED */
481 void       gtk_widget_size_request        (GtkWidget           *widget,
482                                            GtkRequisition      *requisition);
483 void       gtk_widget_size_allocate       (GtkWidget           *widget,
484                                            GtkAllocation       *allocation);
485 void       gtk_widget_get_child_requisition (GtkWidget         *widget,
486                                              GtkRequisition    *requisition);
487 void       gtk_widget_add_accelerator     (GtkWidget           *widget,
488                                            const gchar         *accel_signal,
489                                            GtkAccelGroup       *accel_group,
490                                            guint                accel_key,
491                                            GdkModifierType      accel_mods,
492                                            GtkAccelFlags        accel_flags);
493 gboolean   gtk_widget_remove_accelerator  (GtkWidget           *widget,
494                                            GtkAccelGroup       *accel_group,
495                                            guint                accel_key,
496                                            GdkModifierType      accel_mods);
497 void       gtk_widget_set_accel_path      (GtkWidget           *widget,
498                                            const gchar         *accel_path,
499                                            GtkAccelGroup       *accel_group);
500 const gchar* _gtk_widget_get_accel_path   (GtkWidget           *widget,
501                                            gboolean            *locked);
502 GList*     gtk_widget_list_accel_closures (GtkWidget           *widget);
503 gboolean   gtk_widget_mnemonic_activate   (GtkWidget           *widget,
504                                            gboolean             group_cycling);
505 gboolean   gtk_widget_event               (GtkWidget           *widget,
506                                            GdkEvent            *event);
507 gint       gtk_widget_send_expose         (GtkWidget           *widget,
508                                            GdkEvent            *event);
509
510 gboolean   gtk_widget_activate               (GtkWidget        *widget);
511 gboolean   gtk_widget_set_scroll_adjustments (GtkWidget        *widget,
512                                               GtkAdjustment    *hadjustment,
513                                               GtkAdjustment    *vadjustment);
514      
515 void       gtk_widget_reparent            (GtkWidget           *widget,
516                                            GtkWidget           *new_parent);
517 gboolean   gtk_widget_intersect           (GtkWidget           *widget,
518                                            GdkRectangle        *area,
519                                            GdkRectangle        *intersection);
520 GdkRegion *gtk_widget_region_intersect    (GtkWidget           *widget,
521                                            GdkRegion           *region);
522
523 void    gtk_widget_freeze_child_notify    (GtkWidget           *widget);
524 void    gtk_widget_child_notify           (GtkWidget           *widget,
525                                            const gchar         *child_property);
526 void    gtk_widget_thaw_child_notify      (GtkWidget           *widget);
527
528 gboolean   gtk_widget_is_focus            (GtkWidget           *widget);
529 void       gtk_widget_grab_focus          (GtkWidget           *widget);
530 void       gtk_widget_grab_default        (GtkWidget           *widget);
531
532 void                  gtk_widget_set_name               (GtkWidget    *widget,
533                                                          const gchar  *name);
534 G_CONST_RETURN gchar* gtk_widget_get_name               (GtkWidget    *widget);
535 void                  gtk_widget_set_state              (GtkWidget    *widget,
536                                                          GtkStateType  state);
537 void                  gtk_widget_set_sensitive          (GtkWidget    *widget,
538                                                          gboolean      sensitive);
539 void                  gtk_widget_set_app_paintable      (GtkWidget    *widget,
540                                                          gboolean      app_paintable);
541 void                  gtk_widget_set_double_buffered    (GtkWidget    *widget,
542                                                          gboolean      double_buffered);
543 void                  gtk_widget_set_redraw_on_allocate (GtkWidget    *widget,
544                                                          gboolean      redraw_on_allocate);
545 void                  gtk_widget_set_parent             (GtkWidget    *widget,
546                                                          GtkWidget    *parent);
547 void                  gtk_widget_set_parent_window      (GtkWidget    *widget,
548                                                          GdkWindow    *parent_window);
549 void                  gtk_widget_set_child_visible      (GtkWidget    *widget,
550                                                          gboolean      is_visible);
551 gboolean              gtk_widget_get_child_visible      (GtkWidget    *widget);
552
553 GtkWidget *gtk_widget_get_parent          (GtkWidget           *widget);
554 GdkWindow *gtk_widget_get_parent_window   (GtkWidget           *widget);
555
556 gboolean   gtk_widget_child_focus         (GtkWidget           *widget,
557                                            GtkDirectionType     direction);
558
559 void       gtk_widget_set_size_request    (GtkWidget           *widget,
560                                            gint                 width,
561                                            gint                 height);
562 void       gtk_widget_get_size_request    (GtkWidget           *widget,
563                                            gint                *width,
564                                            gint                *height);
565 #ifndef GTK_DISABLE_DEPRECATED
566 void       gtk_widget_set_uposition       (GtkWidget           *widget,
567                                            gint                 x,
568                                            gint                 y);
569 void       gtk_widget_set_usize           (GtkWidget           *widget,
570                                            gint                 width,
571                                            gint                 height);
572 #endif
573
574 void       gtk_widget_set_events          (GtkWidget           *widget,
575                                            gint                 events);
576 void       gtk_widget_add_events          (GtkWidget           *widget,
577                                            gint                 events);
578 void       gtk_widget_set_extension_events (GtkWidget           *widget,
579                                             GdkExtensionMode    mode);
580
581 GdkExtensionMode gtk_widget_get_extension_events (GtkWidget     *widget);
582 GtkWidget*   gtk_widget_get_toplevel    (GtkWidget      *widget);
583 GtkWidget*   gtk_widget_get_ancestor    (GtkWidget      *widget,
584                                          GtkType        widget_type);
585 GdkColormap* gtk_widget_get_colormap    (GtkWidget      *widget);
586 GdkVisual*   gtk_widget_get_visual      (GtkWidget      *widget);
587
588 GdkScreen *   gtk_widget_get_screen      (GtkWidget *widget);
589 gboolean      gtk_widget_has_screen      (GtkWidget *widget);
590 GdkDisplay *  gtk_widget_get_display     (GtkWidget *widget);
591 GdkWindow *   gtk_widget_get_root_window (GtkWidget *widget);
592 GtkSettings*  gtk_widget_get_settings    (GtkWidget *widget);
593 GtkClipboard *gtk_widget_get_clipboard   (GtkWidget *widget,
594                                           GdkAtom    selection);
595
596 #ifndef GTK_DISABLE_DEPRECATED
597 #define gtk_widget_set_visual(widget,visual)  ((void) 0)
598 #define gtk_widget_push_visual(visual)        ((void) 0)
599 #define gtk_widget_pop_visual()               ((void) 0)
600 #define gtk_widget_set_default_visual(visual) ((void) 0)
601 #endif /* GTK_DISABLE_DEPRECATED */
602
603 /* Accessibility support */
604 AtkObject*       gtk_widget_get_accessible               (GtkWidget          *widget);
605
606 /* The following functions must not be called on an already
607  * realized widget. Because it is possible that somebody
608  * can call get_colormap() or get_visual() and save the
609  * result, these functions are probably only safe to
610  * call in a widget's init() function.
611  */
612 void         gtk_widget_set_colormap    (GtkWidget      *widget,
613                                          GdkColormap    *colormap);
614
615 gint         gtk_widget_get_events      (GtkWidget      *widget);
616 void         gtk_widget_get_pointer     (GtkWidget      *widget,
617                                          gint           *x,
618                                          gint           *y);
619
620 gboolean     gtk_widget_is_ancestor     (GtkWidget      *widget,
621                                          GtkWidget      *ancestor);
622
623 gboolean     gtk_widget_translate_coordinates (GtkWidget  *src_widget,
624                                                GtkWidget  *dest_widget,
625                                                gint        src_x,
626                                                gint        src_y,
627                                                gint       *dest_x,
628                                                gint       *dest_y);
629
630 /* Hide widget and return TRUE.
631  */
632 gboolean     gtk_widget_hide_on_delete  (GtkWidget      *widget);
633
634 /* Widget styles.
635  */
636 void       gtk_widget_set_style         (GtkWidget      *widget,
637                                          GtkStyle       *style);
638 void       gtk_widget_ensure_style      (GtkWidget      *widget);
639 GtkStyle*  gtk_widget_get_style         (GtkWidget      *widget);
640
641 void        gtk_widget_modify_style       (GtkWidget            *widget,
642                                            GtkRcStyle           *style);
643 GtkRcStyle *gtk_widget_get_modifier_style (GtkWidget            *widget);
644 void        gtk_widget_modify_fg          (GtkWidget            *widget,
645                                            GtkStateType          state,
646                                            GdkColor             *color);
647 void        gtk_widget_modify_bg          (GtkWidget            *widget,
648                                            GtkStateType          state,
649                                            GdkColor             *color);
650 void        gtk_widget_modify_text        (GtkWidget            *widget,
651                                            GtkStateType          state,
652                                            GdkColor             *color);
653 void        gtk_widget_modify_base        (GtkWidget            *widget,
654                                            GtkStateType          state,
655                                            GdkColor             *color);
656 void        gtk_widget_modify_font        (GtkWidget            *widget,
657                                            PangoFontDescription *font_desc);
658
659 #ifndef GTK_DISABLE_DEPRECATED
660 #define gtk_widget_set_rc_style(widget)          (gtk_widget_set_style (widget, NULL))
661 #define gtk_widget_restore_default_style(widget) (gtk_widget_set_style (widget, NULL))
662 #endif
663
664 PangoContext *gtk_widget_create_pango_context (GtkWidget   *widget);
665 PangoContext *gtk_widget_get_pango_context    (GtkWidget   *widget);
666 PangoLayout  *gtk_widget_create_pango_layout  (GtkWidget   *widget,
667                                                const gchar *text);
668
669 GdkPixbuf    *gtk_widget_render_icon          (GtkWidget   *widget,
670                                                const gchar *stock_id,
671                                                GtkIconSize  size,
672                                                const gchar *detail);
673
674 /* handle composite names for GTK_COMPOSITE_CHILD widgets,
675  * the returned name is newly allocated.
676  */
677 void   gtk_widget_set_composite_name    (GtkWidget      *widget,
678                                          const gchar    *name);
679 gchar* gtk_widget_get_composite_name    (GtkWidget      *widget);
680      
681 /* Descend recursively and set rc-style on all widgets without user styles */
682 void       gtk_widget_reset_rc_styles   (GtkWidget      *widget);
683
684 /* Push/pop pairs, to change default values upon a widget's creation.
685  * This will override the values that got set by the
686  * gtk_widget_set_default_* () functions.
687  */
688 void         gtk_widget_push_colormap        (GdkColormap *cmap);
689 void         gtk_widget_push_composite_child (void);
690 void         gtk_widget_pop_composite_child  (void);
691 void         gtk_widget_pop_colormap         (void);
692
693 /* widget style properties
694  */
695 void gtk_widget_class_install_style_property        (GtkWidgetClass     *klass,
696                                                      GParamSpec         *pspec);
697 void gtk_widget_class_install_style_property_parser (GtkWidgetClass     *klass,
698                                                      GParamSpec         *pspec,
699                                                      GtkRcPropertyParser parser);
700 GParamSpec*  gtk_widget_class_find_style_property   (GtkWidgetClass     *klass,
701                                                      const gchar        *property_name);
702 GParamSpec** gtk_widget_class_list_style_properties (GtkWidgetClass     *klass,
703                                                      guint              *n_properties);
704 void gtk_widget_style_get_property (GtkWidget        *widget,
705                                     const gchar    *property_name,
706                                     GValue           *value);
707 void gtk_widget_style_get_valist   (GtkWidget        *widget,
708                                     const gchar    *first_property_name,
709                                     va_list         var_args);
710 void gtk_widget_style_get          (GtkWidget        *widget,
711                                     const gchar    *first_property_name,
712                                     ...);
713
714
715 /* Set certain default values to be used at widget creation time.
716  */
717 void         gtk_widget_set_default_colormap (GdkColormap *colormap);
718 GtkStyle*    gtk_widget_get_default_style    (void);
719 #ifndef GDK_MULTIHEAD_SAFE
720 GdkColormap* gtk_widget_get_default_colormap (void);
721 GdkVisual*   gtk_widget_get_default_visual   (void);
722 #endif
723
724 /* Functions for setting directionality for widgets
725  */
726
727 void             gtk_widget_set_direction         (GtkWidget        *widget,
728                                                    GtkTextDirection  dir);
729 GtkTextDirection gtk_widget_get_direction         (GtkWidget        *widget);
730
731 void             gtk_widget_set_default_direction (GtkTextDirection  dir);
732 GtkTextDirection gtk_widget_get_default_direction (void);
733
734 /* Counterpart to gdk_window_shape_combine_mask.
735  */
736 void         gtk_widget_shape_combine_mask (GtkWidget *widget,
737                                             GdkBitmap *shape_mask,
738                                             gint       offset_x,
739                                             gint       offset_y);
740
741 /* internal function */
742 void         gtk_widget_reset_shapes       (GtkWidget *widget);
743
744 /* Compute a widget's path in the form "GtkWindow.MyLabel", and
745  * return newly alocated strings.
746  */
747 void         gtk_widget_path               (GtkWidget *widget,
748                                             guint     *path_length,
749                                             gchar    **path,
750                                             gchar    **path_reversed);
751 void         gtk_widget_class_path         (GtkWidget *widget,
752                                             guint     *path_length,
753                                             gchar    **path,
754                                             gchar    **path_reversed);
755
756 GType           gtk_requisition_get_type (void);
757 GtkRequisition *gtk_requisition_copy     (const GtkRequisition *requisition);
758 void            gtk_requisition_free     (GtkRequisition       *requisition);
759
760 #if     defined (GTK_TRACE_OBJECTS) && defined (__GNUC__)
761 #  define gtk_widget_ref gtk_object_ref
762 #  define gtk_widget_unref gtk_object_unref
763 #endif  /* GTK_TRACE_OBJECTS && __GNUC__ */
764
765 GtkWidgetAuxInfo *_gtk_widget_get_aux_info                (GtkWidget    *widget,
766                                                            gboolean      create);
767 void              _gtk_widget_propagate_hierarchy_changed (GtkWidget    *widget,
768                                                            GtkWidget    *previous_toplevel);
769
770 GdkColormap* _gtk_widget_peek_colormap (void);
771
772
773 #ifdef __cplusplus
774 }
775 #endif /* __cplusplus */
776
777
778 #endif /* __GTK_WIDGET_H__ */