]> Pileus Git - ~andy/gtk/blob - gtk/gtkwidget.h
Add dependency on Atk for accessibility support.
[~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 <atk/atkobject.h>
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif /* __cplusplus */
40
41
42 /* The flags that are used by GtkWidget on top of the
43  * flags field of GtkObject.
44  */
45 typedef enum
46 {
47   GTK_TOPLEVEL         = 1 << 4,
48   GTK_NO_WINDOW        = 1 << 5,
49   GTK_REALIZED         = 1 << 6,
50   GTK_MAPPED           = 1 << 7,
51   GTK_VISIBLE          = 1 << 8,
52   GTK_SENSITIVE        = 1 << 9,
53   GTK_PARENT_SENSITIVE = 1 << 10,
54   GTK_CAN_FOCUS        = 1 << 11,
55   GTK_HAS_FOCUS        = 1 << 12,
56
57   /* widget is allowed to receive the default via gtk_widget_grab_default
58    * and will reserve space to draw the default if possible
59    */
60   GTK_CAN_DEFAULT      = 1 << 13,
61
62   /* the widget currently is receiving the default action and should be drawn
63    * appropriately if possible
64    */
65   GTK_HAS_DEFAULT      = 1 << 14,
66
67   GTK_HAS_GRAB         = 1 << 15,
68   GTK_RC_STYLE         = 1 << 16,
69   GTK_COMPOSITE_CHILD  = 1 << 17,
70   GTK_NO_REPARENT      = 1 << 18,
71   GTK_APP_PAINTABLE    = 1 << 19,
72
73   /* the widget when focused will receive the default action and have
74    * HAS_DEFAULT set even if there is a different widget set as default
75    */
76   GTK_RECEIVES_DEFAULT = 1 << 20,
77
78   GTK_DOUBLE_BUFFERED  = 1 << 21
79 } GtkWidgetFlags;
80
81 /* Macro for casting a pointer to a GtkWidget or GtkWidgetClass pointer.
82  * Macros for testing whether `widget' or `klass' are of type GTK_TYPE_WIDGET.
83  */
84 #define GTK_TYPE_WIDGET                   (gtk_widget_get_type ())
85 #define GTK_WIDGET(widget)                (GTK_CHECK_CAST ((widget), GTK_TYPE_WIDGET, GtkWidget))
86 #define GTK_WIDGET_CLASS(klass)           (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_WIDGET, GtkWidgetClass))
87 #define GTK_IS_WIDGET(widget)             (GTK_CHECK_TYPE ((widget), GTK_TYPE_WIDGET))
88 #define GTK_IS_WIDGET_CLASS(klass)        (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WIDGET))
89 #define GTK_WIDGET_GET_CLASS(obj)         (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_WIDGET, GtkWidgetClass))
90
91 /* Macros for extracting various fields from GtkWidget and GtkWidgetClass.
92  */
93 #define GTK_WIDGET_TYPE(wid)              (GTK_OBJECT_TYPE (wid))
94 #define GTK_WIDGET_STATE(wid)             (GTK_WIDGET (wid)->state)
95 #define GTK_WIDGET_SAVED_STATE(wid)       (GTK_WIDGET (wid)->saved_state)
96
97 /* Macros for extracting the widget flags from GtkWidget.
98  */
99 #define GTK_WIDGET_FLAGS(wid)             (GTK_OBJECT_FLAGS (wid))
100 #define GTK_WIDGET_TOPLEVEL(wid)          ((GTK_WIDGET_FLAGS (wid) & GTK_TOPLEVEL) != 0)
101 #define GTK_WIDGET_NO_WINDOW(wid)         ((GTK_WIDGET_FLAGS (wid) & GTK_NO_WINDOW) != 0)
102 #define GTK_WIDGET_REALIZED(wid)          ((GTK_WIDGET_FLAGS (wid) & GTK_REALIZED) != 0)
103 #define GTK_WIDGET_MAPPED(wid)            ((GTK_WIDGET_FLAGS (wid) & GTK_MAPPED) != 0)
104 #define GTK_WIDGET_VISIBLE(wid)           ((GTK_WIDGET_FLAGS (wid) & GTK_VISIBLE) != 0)
105 #define GTK_WIDGET_DRAWABLE(wid)          (GTK_WIDGET_VISIBLE (wid) && GTK_WIDGET_MAPPED (wid))
106 #define GTK_WIDGET_SENSITIVE(wid)         ((GTK_WIDGET_FLAGS (wid) & GTK_SENSITIVE) != 0)
107 #define GTK_WIDGET_PARENT_SENSITIVE(wid)  ((GTK_WIDGET_FLAGS (wid) & GTK_PARENT_SENSITIVE) != 0)
108 #define GTK_WIDGET_IS_SENSITIVE(wid)      (GTK_WIDGET_SENSITIVE (wid) && \
109                                            GTK_WIDGET_PARENT_SENSITIVE (wid))
110 #define GTK_WIDGET_CAN_FOCUS(wid)         ((GTK_WIDGET_FLAGS (wid) & GTK_CAN_FOCUS) != 0)
111 #define GTK_WIDGET_HAS_FOCUS(wid)         ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_FOCUS) != 0)
112 #define GTK_WIDGET_CAN_DEFAULT(wid)       ((GTK_WIDGET_FLAGS (wid) & GTK_CAN_DEFAULT) != 0)
113 #define GTK_WIDGET_HAS_DEFAULT(wid)       ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_DEFAULT) != 0)
114 #define GTK_WIDGET_HAS_GRAB(wid)          ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_GRAB) != 0)
115 #define GTK_WIDGET_RC_STYLE(wid)          ((GTK_WIDGET_FLAGS (wid) & GTK_RC_STYLE) != 0)
116 #define GTK_WIDGET_COMPOSITE_CHILD(wid)   ((GTK_WIDGET_FLAGS (wid) & GTK_COMPOSITE_CHILD) != 0)
117 #define GTK_WIDGET_APP_PAINTABLE(wid)     ((GTK_WIDGET_FLAGS (wid) & GTK_APP_PAINTABLE) != 0)
118 #define GTK_WIDGET_RECEIVES_DEFAULT(wid)  ((GTK_WIDGET_FLAGS (wid) & GTK_RECEIVES_DEFAULT) != 0)
119 #define GTK_WIDGET_DOUBLE_BUFFERED(wid)   ((GTK_WIDGET_FLAGS (wid) & GTK_DOUBLE_BUFFERED) != 0)
120   
121 /* Macros for setting and clearing widget flags.
122  */
123 #define GTK_WIDGET_SET_FLAGS(wid,flag)    G_STMT_START{ (GTK_WIDGET_FLAGS (wid) |= (flag)); }G_STMT_END
124 #define GTK_WIDGET_UNSET_FLAGS(wid,flag)  G_STMT_START{ (GTK_WIDGET_FLAGS (wid) &= ~(flag)); }G_STMT_END
125
126
127 /* forward declaration to avoid excessive includes (and concurrent includes)
128  */
129 typedef struct _GtkRequisition     GtkRequisition;
130 typedef struct _GdkRectangle       GtkAllocation;
131 typedef struct _GtkSelectionData   GtkSelectionData;
132 typedef struct _GtkWidgetClass     GtkWidgetClass;
133 typedef struct _GtkWidgetAuxInfo   GtkWidgetAuxInfo;
134 typedef struct _GtkWidgetShapeInfo GtkWidgetShapeInfo;
135 typedef void     (*GtkCallback)        (GtkWidget        *widget,
136                                         gpointer          data);
137
138 /* A requisition is a desired amount of space which a
139  *  widget may request.
140  */
141 struct _GtkRequisition
142 {
143   gint width;
144   gint height;
145 };
146
147 /* The widget is the base of the tree for displayable objects.
148  *  (A displayable object is one which takes up some amount
149  *  of screen real estate). It provides a common base and interface
150  *  which actual widgets must adhere to.
151  */
152 struct _GtkWidget
153 {
154   /* The object structure needs to be the first
155    *  element in the widget structure in order for
156    *  the object mechanism to work correctly. This
157    *  allows a GtkWidget pointer to be cast to a
158    *  GtkObject pointer.
159    */
160   GtkObject object;
161   
162   /* 16 bits of internally used private flags.
163    * this will be packed into the same 4 byte alignment frame that
164    * state and saved_state go. we therefore don't waste any new
165    * space on this.
166    */
167   guint16 private_flags;
168   
169   /* The state of the widget. There are actually only
170    *  5 widget states (defined in "gtkenums.h").
171    */
172   guint8 state;
173   
174   /* The saved state of the widget. When a widgets state
175    *  is changed to GTK_STATE_INSENSITIVE via
176    *  "gtk_widget_set_state" or "gtk_widget_set_sensitive"
177    *  the old state is kept around in this field. The state
178    *  will be restored once the widget gets sensitive again.
179    */
180   guint8 saved_state;
181   
182   /* The widgets name. If the widget does not have a name
183    *  (the name is NULL), then its name (as returned by
184    *  "gtk_widget_get_name") is its classes name.
185    * Among other things, the widget name is used to determine
186    *  the style to use for a widget.
187    */
188   gchar *name;
189   
190   /* The style for the widget. The style contains the
191    *  colors the widget should be drawn in for each state
192    *  along with graphics contexts used to draw with and
193    *  the font to use for text.
194    */
195   GtkStyle *style;
196   
197   /* The widgets desired size.
198    */
199   GtkRequisition requisition;
200   
201   /* The widgets allocated size.
202    */
203   GtkAllocation allocation;
204   
205   /* The widgets window or its parent window if it does
206    *  not have a window. (Which will be indicated by the
207    *  GTK_NO_WINDOW flag being set).
208    */
209   GdkWindow *window;
210   
211   /* The widgets parent.
212    */
213   GtkWidget *parent;
214 };
215
216 struct _GtkWidgetClass
217 {
218   /* The object class structure needs to be the first
219    *  element in the widget class structure in order for
220    *  the class mechanism to work correctly. This allows a
221    *  GtkWidgetClass pointer to be cast to a GtkObjectClass
222    *  pointer.
223    */
224   GtkObjectClass parent_class;
225   
226   /* The signal to emit when a widget of this class is activated,
227    * gtk_widget_activate() handles the emission.
228    * Implementation of this signal is optional.
229    */
230   guint activate_signal;
231
232   /* This signal is emitted  when a widget of this class is added
233    * to a scrolling aware parent, gtk_widget_set_scroll_adjustments()
234    * handles the emission.
235    * Implementation of this signal is optional.
236    */
237   guint set_scroll_adjustments_signal;
238
239   /* basics */
240   void (* show)                (GtkWidget        *widget);
241   void (* show_all)            (GtkWidget        *widget);
242   void (* hide)                (GtkWidget        *widget);
243   void (* hide_all)            (GtkWidget        *widget);
244   void (* map)                 (GtkWidget        *widget);
245   void (* unmap)               (GtkWidget        *widget);
246   void (* realize)             (GtkWidget        *widget);
247   void (* unrealize)           (GtkWidget        *widget);
248   void (* size_request)        (GtkWidget        *widget,
249                                 GtkRequisition   *requisition);
250   void (* size_allocate)       (GtkWidget        *widget,
251                                 GtkAllocation    *allocation);
252   void (* state_changed)       (GtkWidget        *widget,
253                                 GtkStateType      previous_state);
254   void (* parent_set)          (GtkWidget        *widget,
255                                 GtkWidget        *previous_parent);
256   void (* hierarchy_changed)   (GtkWidget        *widget);
257   void (* style_set)           (GtkWidget        *widget,
258                                 GtkStyle         *previous_style);
259   void (* direction_changed)   (GtkWidget        *widget,
260                                 GtkTextDirection  previous_direction);
261   
262   /* accelerators */
263   void (* add_accelerator)     (GtkWidget      *widget,
264                                 guint           accel_signal_id,
265                                 GtkAccelGroup  *accel_group,
266                                 guint           accel_key,
267                                 GdkModifierType accel_mods,
268                                 GtkAccelFlags   accel_flags);
269   void (* remove_accelerator)  (GtkWidget      *widget,
270                                 GtkAccelGroup  *accel_group,
271                                 guint           accel_key,
272                                 GdkModifierType accel_mods);
273
274   /* Mnemonics */
275   gboolean (* mnemonic_activate) (GtkWidget    *widget,
276                                   gboolean      group_cycling);
277   
278   /* explicit focus */
279   void (* grab_focus)          (GtkWidget      *widget);
280   
281   /* events */
282   gboolean (* event)                    (GtkWidget           *widget,
283                                          GdkEvent            *event);
284   gboolean (* button_press_event)       (GtkWidget           *widget,
285                                          GdkEventButton      *event);
286   gboolean (* button_release_event)     (GtkWidget           *widget,
287                                          GdkEventButton      *event);
288   gboolean (* scroll_event)             (GtkWidget           *widget,
289                                          GdkEventScroll      *event);
290   gboolean (* motion_notify_event)      (GtkWidget           *widget,
291                                          GdkEventMotion      *event);
292   gboolean (* delete_event)             (GtkWidget           *widget,
293                                          GdkEventAny         *event);
294   gboolean (* destroy_event)            (GtkWidget           *widget,
295                                          GdkEventAny         *event);
296   gboolean (* expose_event)             (GtkWidget           *widget,
297                                          GdkEventExpose      *event);
298   gboolean (* key_press_event)          (GtkWidget           *widget,
299                                          GdkEventKey         *event);
300   gboolean (* key_release_event)        (GtkWidget           *widget,
301                                          GdkEventKey         *event);
302   gboolean (* enter_notify_event)       (GtkWidget           *widget,
303                                          GdkEventCrossing    *event);
304   gboolean (* leave_notify_event)       (GtkWidget           *widget,
305                                          GdkEventCrossing    *event);
306   gboolean (* configure_event)          (GtkWidget           *widget,
307                                          GdkEventConfigure   *event);
308   gboolean (* focus_in_event)           (GtkWidget           *widget,
309                                          GdkEventFocus       *event);
310   gboolean (* focus_out_event)          (GtkWidget           *widget,
311                                          GdkEventFocus       *event);
312   gboolean (* map_event)                (GtkWidget           *widget,
313                                          GdkEventAny         *event);
314   gboolean (* unmap_event)              (GtkWidget           *widget,
315                                          GdkEventAny         *event);
316   gboolean (* property_notify_event)    (GtkWidget           *widget,
317                                          GdkEventProperty    *event);
318   gboolean (* selection_clear_event)    (GtkWidget           *widget,
319                                          GdkEventSelection   *event);
320   gboolean (* selection_request_event)  (GtkWidget           *widget,
321                                          GdkEventSelection   *event);
322   gboolean (* selection_notify_event)   (GtkWidget           *widget,
323                                          GdkEventSelection   *event);
324   gboolean (* proximity_in_event)       (GtkWidget           *widget,
325                                          GdkEventProximity   *event);
326   gboolean (* proximity_out_event)      (GtkWidget           *widget,
327                                          GdkEventProximity   *event);
328   gboolean (* visibility_notify_event)  (GtkWidget           *widget,
329                                          GdkEventVisibility  *event);
330   gboolean (* client_event)             (GtkWidget           *widget,
331                                          GdkEventClient      *event);
332   gboolean (* no_expose_event)          (GtkWidget           *widget,
333                                          GdkEventAny         *event);
334   gboolean (* window_state_event)       (GtkWidget           *widget,
335                                          GdkEventWindowState *event);
336   
337   /* selection */
338   void (* selection_get)           (GtkWidget          *widget,
339                                     GtkSelectionData   *selection_data,
340                                     guint               info,
341                                     guint               time);
342   void (* selection_received)      (GtkWidget          *widget,
343                                     GtkSelectionData   *selection_data,
344                                     guint               time);
345
346   /* Source side drag signals */
347   void (* drag_begin)              (GtkWidget          *widget,
348                                     GdkDragContext     *context);
349   void (* drag_end)                (GtkWidget          *widget,
350                                     GdkDragContext     *context);
351   void (* drag_data_get)           (GtkWidget          *widget,
352                                     GdkDragContext     *context,
353                                     GtkSelectionData   *selection_data,
354                                     guint               info,
355                                     guint               time);
356   void (* drag_data_delete)        (GtkWidget          *widget,
357                                     GdkDragContext     *context);
358
359   /* Target side drag signals */
360   void (* drag_leave)              (GtkWidget          *widget,
361                                     GdkDragContext     *context,
362                                     guint               time);
363   gboolean (* drag_motion)         (GtkWidget          *widget,
364                                     GdkDragContext     *context,
365                                     gint                x,
366                                     gint                y,
367                                     guint               time);
368   gboolean (* drag_drop)           (GtkWidget          *widget,
369                                     GdkDragContext     *context,
370                                     gint                x,
371                                     gint                y,
372                                     guint               time);
373   void (* drag_data_received)      (GtkWidget          *widget,
374                                     GdkDragContext     *context,
375                                     gint                x,
376                                     gint                y,
377                                     GtkSelectionData   *selection_data,
378                                     guint               info,
379                                     guint               time);
380
381   /* Signals used only for keybindings */
382   void (* popup_menu)              (GtkWidget          *widget);
383   
384   
385   /* accessibility support 
386    */
387   AtkObject*   (* get_accessible)  (GtkWidget          *widget);
388
389   /* Padding for future expansion */
390   GtkFunction pad1;
391   GtkFunction pad2;
392   GtkFunction pad3;
393   GtkFunction pad4;
394 };
395
396 struct _GtkWidgetAuxInfo
397 {
398   gint x;
399   gint y;
400   gint width;
401   gint height;
402   guint x_set : 1;
403   guint y_set : 1;
404 };
405
406 struct _GtkWidgetShapeInfo
407 {
408   gint16     offset_x;
409   gint16     offset_y;
410   GdkBitmap *shape_mask;
411 };
412
413 GtkType    gtk_widget_get_type            (void) G_GNUC_CONST;
414 GtkWidget* gtk_widget_new                 (GtkType              type,
415                                            const gchar         *first_property_name,
416                                            ...);
417 GtkWidget* gtk_widget_ref                 (GtkWidget           *widget);
418 void       gtk_widget_unref               (GtkWidget           *widget);
419 void       gtk_widget_destroy             (GtkWidget           *widget);
420 void       gtk_widget_destroyed           (GtkWidget           *widget,
421                                            GtkWidget          **widget_pointer);
422 void       gtk_widget_set                 (GtkWidget           *widget,
423                                            const gchar         *first_property_name,
424                                            ...);
425 void       gtk_widget_unparent            (GtkWidget           *widget);
426 void       gtk_widget_show                (GtkWidget           *widget);
427 void       gtk_widget_show_now            (GtkWidget           *widget);
428 void       gtk_widget_hide                (GtkWidget           *widget);
429 void       gtk_widget_show_all            (GtkWidget           *widget);
430 void       gtk_widget_hide_all            (GtkWidget           *widget);
431 void       gtk_widget_map                 (GtkWidget           *widget);
432 void       gtk_widget_unmap               (GtkWidget           *widget);
433 void       gtk_widget_realize             (GtkWidget           *widget);
434 void       gtk_widget_unrealize           (GtkWidget           *widget);
435
436 /* Queuing draws */
437 void       gtk_widget_queue_draw          (GtkWidget           *widget);
438 void       gtk_widget_queue_draw_area     (GtkWidget           *widget,
439                                            gint                 x,
440                                            gint                 y,
441                                            gint                 width,
442                                            gint                 height);
443 #ifndef GTK_DISABLE_DEPRECATED
444 void       gtk_widget_queue_clear         (GtkWidget           *widget);
445 void       gtk_widget_queue_clear_area    (GtkWidget           *widget,
446                                            gint                 x,
447                                            gint                 y,
448                                            gint                 width,
449                                            gint                 height);
450 #endif /* GTK_DISABLE_DEPRECATED */
451
452
453 void       gtk_widget_queue_resize        (GtkWidget           *widget);
454 #ifndef GTK_DISABLE_DEPRECATED
455 void       gtk_widget_draw                (GtkWidget           *widget,
456                                            GdkRectangle        *area);
457 #endif /* GTK_DISABLE_DEPRECATED */
458 void       gtk_widget_size_request        (GtkWidget           *widget,
459                                            GtkRequisition      *requisition);
460 void       gtk_widget_size_allocate       (GtkWidget           *widget,
461                                            GtkAllocation       *allocation);
462 void       gtk_widget_get_child_requisition (GtkWidget         *widget,
463                                              GtkRequisition    *requisition);
464 void       gtk_widget_add_accelerator     (GtkWidget           *widget,
465                                            const gchar         *accel_signal,
466                                            GtkAccelGroup       *accel_group,
467                                            guint                accel_key,
468                                            guint                accel_mods,
469                                            GtkAccelFlags        accel_flags);
470 void       gtk_widget_remove_accelerator  (GtkWidget           *widget,
471                                            GtkAccelGroup       *accel_group,
472                                            guint                accel_key,
473                                            guint                accel_mods);
474 void       gtk_widget_remove_accelerators (GtkWidget           *widget,
475                                            const gchar         *accel_signal,
476                                            gboolean             visible_only);
477 guint      gtk_widget_accelerator_signal  (GtkWidget           *widget,
478                                            GtkAccelGroup       *accel_group,
479                                            guint                accel_key,
480                                            guint                accel_mods);
481 void       gtk_widget_lock_accelerators   (GtkWidget           *widget);
482 void       gtk_widget_unlock_accelerators (GtkWidget           *widget);
483 gboolean   gtk_widget_accelerators_locked (GtkWidget           *widget);
484 gboolean   gtk_widget_mnemonic_activate   (GtkWidget           *widget,
485                                            gboolean             group_cycling);
486 gboolean   gtk_widget_event               (GtkWidget           *widget,
487                                            GdkEvent            *event);
488 gint       gtk_widget_send_expose         (GtkWidget           *widget,
489                                            GdkEvent            *event);
490
491 gboolean   gtk_widget_activate               (GtkWidget        *widget);
492 gboolean   gtk_widget_set_scroll_adjustments (GtkWidget        *widget,
493                                               GtkAdjustment    *hadjustment,
494                                               GtkAdjustment    *vadjustment);
495      
496 void       gtk_widget_reparent            (GtkWidget           *widget,
497                                            GtkWidget           *new_parent);
498 gboolean   gtk_widget_intersect           (GtkWidget           *widget,
499                                            GdkRectangle        *area,
500                                            GdkRectangle        *intersection);
501 GdkRegion *gtk_widget_region_intersect    (GtkWidget           *widget,
502                                            GdkRegion           *region);
503
504 gboolean   gtk_widget_is_focus            (GtkWidget           *widget);
505 void       gtk_widget_grab_focus          (GtkWidget           *widget);
506 void       gtk_widget_grab_default        (GtkWidget           *widget);
507
508 void       gtk_widget_set_name            (GtkWidget           *widget,
509                                            const gchar         *name);
510 G_CONST_RETURN gchar* gtk_widget_get_name (GtkWidget           *widget);
511 void       gtk_widget_set_state           (GtkWidget           *widget,
512                                            GtkStateType         state);
513 void       gtk_widget_set_sensitive       (GtkWidget           *widget,
514                                            gboolean             sensitive);
515 void       gtk_widget_set_app_paintable   (GtkWidget           *widget,
516                                            gboolean             app_paintable);
517 void       gtk_widget_set_double_buffered (GtkWidget           *widget,
518                                            gboolean             double_buffered);
519 void       gtk_widget_set_parent          (GtkWidget           *widget,
520                                            GtkWidget           *parent);
521 void       gtk_widget_set_parent_window   (GtkWidget           *widget,
522                                            GdkWindow           *parent_window);
523 GdkWindow *gtk_widget_get_parent_window   (GtkWidget           *widget);
524 void       gtk_widget_set_uposition       (GtkWidget           *widget,
525                                            gint                 x,
526                                            gint                 y);
527 void       gtk_widget_set_usize           (GtkWidget           *widget,
528                                            gint                 width,
529                                            gint                 height);
530 void       gtk_widget_set_events          (GtkWidget           *widget,
531                                            gint                 events);
532 void       gtk_widget_add_events          (GtkWidget           *widget,
533                                            gint                 events);
534 void       gtk_widget_set_extension_events (GtkWidget           *widget,
535                                             GdkExtensionMode    mode);
536
537 GdkExtensionMode gtk_widget_get_extension_events (GtkWidget     *widget);
538 GtkWidget*   gtk_widget_get_toplevel    (GtkWidget      *widget);
539 GtkWidget*   gtk_widget_get_ancestor    (GtkWidget      *widget,
540                                          GtkType        widget_type);
541 GdkColormap* gtk_widget_get_colormap    (GtkWidget      *widget);
542 GdkVisual*   gtk_widget_get_visual      (GtkWidget      *widget);
543
544
545 /* Accessibility support */
546 AtkObject*       gtk_widget_get_accessible               (GtkWidget          *widget);
547
548 /* The following functions must not be called on an already
549  * realized widget. Because it is possible that somebody
550  * can call get_colormap() or get_visual() and save the
551  * result, these functions are probably only safe to
552  * call in a widget's init() function.
553  */
554 void         gtk_widget_set_colormap    (GtkWidget      *widget,
555                                          GdkColormap    *colormap);
556
557 gint         gtk_widget_get_events      (GtkWidget      *widget);
558 void         gtk_widget_get_pointer     (GtkWidget      *widget,
559                                          gint           *x,
560                                          gint           *y);
561
562 gboolean     gtk_widget_is_ancestor     (GtkWidget      *widget,
563                                          GtkWidget      *ancestor);
564
565 /* Hide widget and return TRUE.
566  */
567 gboolean     gtk_widget_hide_on_delete  (GtkWidget      *widget);
568
569 /* Widget styles.
570  */
571 void       gtk_widget_set_style         (GtkWidget      *widget,
572                                          GtkStyle       *style);
573 void       gtk_widget_set_rc_style      (GtkWidget      *widget);
574 void       gtk_widget_ensure_style      (GtkWidget      *widget);
575 GtkStyle*  gtk_widget_get_style         (GtkWidget      *widget);
576 void       gtk_widget_restore_default_style (GtkWidget  *widget);
577
578 void        gtk_widget_modify_style       (GtkWidget            *widget,
579                                            GtkRcStyle           *style);
580 GtkRcStyle *gtk_widget_get_modifier_style (GtkWidget            *widget);
581 void        gtk_widget_modify_fg          (GtkWidget            *widget,
582                                            GtkStateType          state,
583                                            GdkColor             *color);
584 void        gtk_widget_modify_bg          (GtkWidget            *widget,
585                                            GtkStateType          state,
586                                            GdkColor             *color);
587 void        gtk_widget_modify_text        (GtkWidget            *widget,
588                                            GtkStateType          state,
589                                            GdkColor             *color);
590 void        gtk_widget_modify_base        (GtkWidget            *widget,
591                                            GtkStateType          state,
592                                            GdkColor             *color);
593 void        gtk_widget_modify_font        (GtkWidget            *widget,
594                                            PangoFontDescription *font_desc);
595
596 PangoContext *gtk_widget_create_pango_context (GtkWidget   *widget);
597 PangoContext *gtk_widget_get_pango_context    (GtkWidget   *widget);
598 PangoLayout  *gtk_widget_create_pango_layout  (GtkWidget   *widget,
599                                                const gchar *text);
600
601 GdkPixbuf    *gtk_widget_render_icon          (GtkWidget   *widget,
602                                                const gchar *stock_id,
603                                                GtkIconSize  size,
604                                                const gchar *detail);
605
606 /* handle composite names for GTK_COMPOSITE_CHILD widgets,
607  * the returned name is newly allocated.
608  */
609 void   gtk_widget_set_composite_name    (GtkWidget      *widget,
610                                          const gchar    *name);
611 gchar* gtk_widget_get_composite_name    (GtkWidget      *widget);
612      
613 /* Descend recursively and set rc-style on all widgets without user styles */
614 void       gtk_widget_reset_rc_styles   (GtkWidget      *widget);
615
616 /* Push/pop pairs, to change default values upon a widget's creation.
617  * This will override the values that got set by the
618  * gtk_widget_set_default_* () functions.
619  */
620 void         gtk_widget_push_style           (GtkStyle   *style);
621 void         gtk_widget_push_colormap        (GdkColormap *cmap);
622 void         gtk_widget_push_composite_child (void);
623 void         gtk_widget_pop_composite_child  (void);
624 void         gtk_widget_pop_style            (void);
625 void         gtk_widget_pop_colormap         (void);
626
627 /* widget style properties
628  */
629 void gtk_widget_class_install_style_property        (GtkWidgetClass     *klass,
630                                                      GParamSpec         *pspec);
631 void gtk_widget_class_install_style_property_parser (GtkWidgetClass     *klass,
632                                                      GParamSpec         *pspec,
633                                                      GtkRcPropertyParser parser);
634 void gtk_widget_style_get_property (GtkWidget        *widget,
635                                     const gchar    *property_name,
636                                     GValue           *value);
637 void gtk_widget_style_get_valist   (GtkWidget        *widget,
638                                     const gchar    *first_property_name,
639                                     va_list         var_args);
640 void gtk_widget_style_get          (GtkWidget        *widget,
641                                     const gchar    *first_property_name,
642                                     ...);
643
644
645 /* Set certain default values to be used at widget creation time.
646  */
647 void         gtk_widget_set_default_style    (GtkStyle    *style);
648 void         gtk_widget_set_default_colormap (GdkColormap *colormap);
649 GtkStyle*    gtk_widget_get_default_style    (void);
650 GdkColormap* gtk_widget_get_default_colormap (void);
651 GdkVisual*   gtk_widget_get_default_visual   (void);
652
653 /* Functions for setting directionality for widgets
654  */
655
656 void             gtk_widget_set_direction         (GtkWidget        *widget,
657                                                    GtkTextDirection  dir);
658 GtkTextDirection gtk_widget_get_direction         (GtkWidget        *widget);
659
660 void             gtk_widget_set_default_direction (GtkTextDirection  dir);
661 GtkTextDirection gtk_widget_get_default_direction (void);
662
663 /* Counterpart to gdk_window_shape_combine_mask.
664  */
665 void         gtk_widget_shape_combine_mask (GtkWidget *widget,
666                                             GdkBitmap *shape_mask,
667                                             gint       offset_x,
668                                             gint       offset_y);
669
670 /* internal function */
671 void         gtk_widget_reset_shapes       (GtkWidget *widget);
672
673 /* Compute a widget's path in the form "GtkWindow.MyLabel", and
674  * return newly alocated strings.
675  */
676 void         gtk_widget_path               (GtkWidget *widget,
677                                             guint     *path_length,
678                                             gchar    **path,
679                                             gchar    **path_reversed);
680 void         gtk_widget_class_path         (GtkWidget *widget,
681                                             guint     *path_length,
682                                             gchar    **path,
683                                             gchar    **path_reversed);
684
685 GtkRequisition *gtk_requisition_copy (const GtkRequisition *requisition);
686 void            gtk_requisition_free (GtkRequisition       *requisition);
687
688 #if     defined (GTK_TRACE_OBJECTS) && defined (__GNUC__)
689 #  define gtk_widget_ref gtk_object_ref
690 #  define gtk_widget_unref gtk_object_unref
691 #endif  /* GTK_TRACE_OBJECTS && __GNUC__ */
692
693 GtkWidgetAuxInfo *_gtk_widget_get_aux_info (GtkWidget *widget,
694                                             gboolean   create);
695
696 #ifdef __cplusplus
697 }
698 #endif /* __cplusplus */
699
700
701 #endif /* __GTK_WIDGET_H__ */