]> Pileus Git - ~andy/gtk/blob - gtk/gtkwidget.h
Change popup_menu signal to return gboolean instead of void. This allows
[~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
135 /* forward declaration to avoid excessive includes (and concurrent includes)
136  */
137 typedef struct _GtkRequisition     GtkRequisition;
138 typedef         GdkRectangle       GtkAllocation;
139 typedef struct _GtkSelectionData   GtkSelectionData;
140 typedef struct _GtkWidgetClass     GtkWidgetClass;
141 typedef struct _GtkWidgetAuxInfo   GtkWidgetAuxInfo;
142 typedef struct _GtkWidgetShapeInfo GtkWidgetShapeInfo;
143 typedef void     (*GtkCallback)        (GtkWidget        *widget,
144                                         gpointer          data);
145
146 /* A requisition is a desired amount of space which a
147  *  widget may request.
148  */
149 struct _GtkRequisition
150 {
151   gint width;
152   gint height;
153 };
154
155 /* The widget is the base of the tree for displayable objects.
156  *  (A displayable object is one which takes up some amount
157  *  of screen real estate). It provides a common base and interface
158  *  which actual widgets must adhere to.
159  */
160 struct _GtkWidget
161 {
162   /* The object structure needs to be the first
163    *  element in the widget structure in order for
164    *  the object mechanism to work correctly. This
165    *  allows a GtkWidget pointer to be cast to a
166    *  GtkObject pointer.
167    */
168   GtkObject object;
169   
170   /* 16 bits of internally used private flags.
171    * this will be packed into the same 4 byte alignment frame that
172    * state and saved_state go. we therefore don't waste any new
173    * space on this.
174    */
175   guint16 private_flags;
176   
177   /* The state of the widget. There are actually only
178    *  5 widget states (defined in "gtkenums.h").
179    */
180   guint8 state;
181   
182   /* The saved state of the widget. When a widgets state
183    *  is changed to GTK_STATE_INSENSITIVE via
184    *  "gtk_widget_set_state" or "gtk_widget_set_sensitive"
185    *  the old state is kept around in this field. The state
186    *  will be restored once the widget gets sensitive again.
187    */
188   guint8 saved_state;
189   
190   /* The widgets name. If the widget does not have a name
191    *  (the name is NULL), then its name (as returned by
192    *  "gtk_widget_get_name") is its classes name.
193    * Among other things, the widget name is used to determine
194    *  the style to use for a widget.
195    */
196   gchar *name;
197   
198   /* The style for the widget. The style contains the
199    *  colors the widget should be drawn in for each state
200    *  along with graphics contexts used to draw with and
201    *  the font to use for text.
202    */
203   GtkStyle *style;
204   
205   /* The widgets desired size.
206    */
207   GtkRequisition requisition;
208   
209   /* The widgets allocated size.
210    */
211   GtkAllocation allocation;
212   
213   /* The widgets window or its parent window if it does
214    *  not have a window. (Which will be indicated by the
215    *  GTK_NO_WINDOW flag being set).
216    */
217   GdkWindow *window;
218   
219   /* The widgets parent.
220    */
221   GtkWidget *parent;
222 };
223
224 struct _GtkWidgetClass
225 {
226   /* The object class structure needs to be the first
227    *  element in the widget class structure in order for
228    *  the class mechanism to work correctly. This allows a
229    *  GtkWidgetClass pointer to be cast to a GtkObjectClass
230    *  pointer.
231    */
232   GtkObjectClass parent_class;
233   
234   /* The signal to emit when a widget of this class is activated,
235    * gtk_widget_activate() handles the emission.
236    * Implementation of this signal is optional.
237    */
238   guint activate_signal;
239
240   /* This signal is emitted  when a widget of this class is added
241    * to a scrolling aware parent, gtk_widget_set_scroll_adjustments()
242    * handles the emission.
243    * Implementation of this signal is optional.
244    */
245   guint set_scroll_adjustments_signal;
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   void (* show_help)               (GtkWidget          *widget,
398                                     GtkWidgetHelpType   help_type);
399   
400   /* accessibility support 
401    */
402   AtkObject*   (* get_accessible)  (GtkWidget          *widget);
403
404   /* Padding for future expansion */
405   GtkFunction pad1;
406   GtkFunction pad2;
407   GtkFunction pad3;
408   GtkFunction pad4;
409 };
410
411 struct _GtkWidgetAuxInfo
412 {
413   gint x;
414   gint y;
415   gint width;
416   gint height;
417   guint x_set : 1;
418   guint y_set : 1;
419 };
420
421 struct _GtkWidgetShapeInfo
422 {
423   gint16     offset_x;
424   gint16     offset_y;
425   GdkBitmap *shape_mask;
426 };
427
428 GtkType    gtk_widget_get_type            (void) G_GNUC_CONST;
429 GtkWidget* gtk_widget_new                 (GtkType              type,
430                                            const gchar         *first_property_name,
431                                            ...);
432 GtkWidget* gtk_widget_ref                 (GtkWidget           *widget);
433 void       gtk_widget_unref               (GtkWidget           *widget);
434 void       gtk_widget_destroy             (GtkWidget           *widget);
435 void       gtk_widget_destroyed           (GtkWidget           *widget,
436                                            GtkWidget          **widget_pointer);
437 #ifndef GTK_DISABLE_DEPRECATED
438 void       gtk_widget_set                 (GtkWidget           *widget,
439                                            const gchar         *first_property_name,
440                                            ...);
441 #endif /* GTK_DISABLE_DEPRECATED */
442 void       gtk_widget_unparent            (GtkWidget           *widget);
443 void       gtk_widget_show                (GtkWidget           *widget);
444 void       gtk_widget_show_now            (GtkWidget           *widget);
445 void       gtk_widget_hide                (GtkWidget           *widget);
446 void       gtk_widget_show_all            (GtkWidget           *widget);
447 void       gtk_widget_hide_all            (GtkWidget           *widget);
448 void       gtk_widget_map                 (GtkWidget           *widget);
449 void       gtk_widget_unmap               (GtkWidget           *widget);
450 void       gtk_widget_realize             (GtkWidget           *widget);
451 void       gtk_widget_unrealize           (GtkWidget           *widget);
452
453 /* Queuing draws */
454 void       gtk_widget_queue_draw          (GtkWidget           *widget);
455 void       gtk_widget_queue_draw_area     (GtkWidget           *widget,
456                                            gint                 x,
457                                            gint                 y,
458                                            gint                 width,
459                                            gint                 height);
460 #ifndef GTK_DISABLE_DEPRECATED
461 void       gtk_widget_queue_clear         (GtkWidget           *widget);
462 void       gtk_widget_queue_clear_area    (GtkWidget           *widget,
463                                            gint                 x,
464                                            gint                 y,
465                                            gint                 width,
466                                            gint                 height);
467 #endif /* GTK_DISABLE_DEPRECATED */
468
469
470 void       gtk_widget_queue_resize        (GtkWidget           *widget);
471 #ifndef GTK_DISABLE_DEPRECATED
472 void       gtk_widget_draw                (GtkWidget           *widget,
473                                            GdkRectangle        *area);
474 #endif /* GTK_DISABLE_DEPRECATED */
475 void       gtk_widget_size_request        (GtkWidget           *widget,
476                                            GtkRequisition      *requisition);
477 void       gtk_widget_size_allocate       (GtkWidget           *widget,
478                                            GtkAllocation       *allocation);
479 void       gtk_widget_get_child_requisition (GtkWidget         *widget,
480                                              GtkRequisition    *requisition);
481 void       gtk_widget_add_accelerator     (GtkWidget           *widget,
482                                            const gchar         *accel_signal,
483                                            GtkAccelGroup       *accel_group,
484                                            guint                accel_key,
485                                            GdkModifierType      accel_mods,
486                                            GtkAccelFlags        accel_flags);
487 gboolean   gtk_widget_remove_accelerator  (GtkWidget           *widget,
488                                            GtkAccelGroup       *accel_group,
489                                            guint                accel_key,
490                                            GdkModifierType      accel_mods);
491 void       gtk_widget_set_accel_path      (GtkWidget           *widget,
492                                            const gchar         *accel_path,
493                                            GtkAccelGroup       *accel_group);
494 const gchar* _gtk_widget_get_accel_path   (GtkWidget           *widget);
495 GList*     gtk_widget_list_accel_closures (GtkWidget           *widget);
496 gboolean   gtk_widget_mnemonic_activate   (GtkWidget           *widget,
497                                            gboolean             group_cycling);
498 gboolean   gtk_widget_event               (GtkWidget           *widget,
499                                            GdkEvent            *event);
500 gint       gtk_widget_send_expose         (GtkWidget           *widget,
501                                            GdkEvent            *event);
502
503 gboolean   gtk_widget_activate               (GtkWidget        *widget);
504 gboolean   gtk_widget_set_scroll_adjustments (GtkWidget        *widget,
505                                               GtkAdjustment    *hadjustment,
506                                               GtkAdjustment    *vadjustment);
507      
508 void       gtk_widget_reparent            (GtkWidget           *widget,
509                                            GtkWidget           *new_parent);
510 gboolean   gtk_widget_intersect           (GtkWidget           *widget,
511                                            GdkRectangle        *area,
512                                            GdkRectangle        *intersection);
513 GdkRegion *gtk_widget_region_intersect    (GtkWidget           *widget,
514                                            GdkRegion           *region);
515
516 void    gtk_widget_freeze_child_notify    (GtkWidget           *widget);
517 void    gtk_widget_child_notify           (GtkWidget           *widget,
518                                            const gchar         *child_property);
519 void    gtk_widget_thaw_child_notify      (GtkWidget           *widget);
520
521 gboolean   gtk_widget_is_focus            (GtkWidget           *widget);
522 void       gtk_widget_grab_focus          (GtkWidget           *widget);
523 void       gtk_widget_grab_default        (GtkWidget           *widget);
524
525 void                  gtk_widget_set_name               (GtkWidget    *widget,
526                                                          const gchar  *name);
527 G_CONST_RETURN gchar* gtk_widget_get_name               (GtkWidget    *widget);
528 void                  gtk_widget_set_state              (GtkWidget    *widget,
529                                                          GtkStateType  state);
530 void                  gtk_widget_set_sensitive          (GtkWidget    *widget,
531                                                          gboolean      sensitive);
532 void                  gtk_widget_set_app_paintable      (GtkWidget    *widget,
533                                                          gboolean      app_paintable);
534 void                  gtk_widget_set_double_buffered    (GtkWidget    *widget,
535                                                          gboolean      double_buffered);
536 void                  gtk_widget_set_redraw_on_allocate (GtkWidget    *widget,
537                                                          gboolean      redraw_on_allocate);
538 void                  gtk_widget_set_parent             (GtkWidget    *widget,
539                                                          GtkWidget    *parent);
540 void                  gtk_widget_set_parent_window      (GtkWidget    *widget,
541                                                          GdkWindow    *parent_window);
542 void                  gtk_widget_set_child_visible      (GtkWidget    *widget,
543                                                          gboolean      is_visible);
544 gboolean              gtk_widget_get_child_visible      (GtkWidget    *widget);
545
546 GtkWidget *gtk_widget_get_parent          (GtkWidget           *widget);
547 GdkWindow *gtk_widget_get_parent_window   (GtkWidget           *widget);
548 gboolean   gtk_widget_child_focus         (GtkWidget           *widget,
549                                            GtkDirectionType     direction);
550
551 void       gtk_widget_set_size_request    (GtkWidget           *widget,
552                                            gint                 width,
553                                            gint                 height);
554 void       gtk_widget_get_size_request    (GtkWidget           *widget,
555                                            gint                *width,
556                                            gint                *height);
557 #ifndef GTK_DISABLE_DEPRECATED
558 void       gtk_widget_set_uposition       (GtkWidget           *widget,
559                                            gint                 x,
560                                            gint                 y);
561 void       gtk_widget_set_usize           (GtkWidget           *widget,
562                                            gint                 width,
563                                            gint                 height);
564 #endif
565
566 void       gtk_widget_set_events          (GtkWidget           *widget,
567                                            gint                 events);
568 void       gtk_widget_add_events          (GtkWidget           *widget,
569                                            gint                 events);
570 void       gtk_widget_set_extension_events (GtkWidget           *widget,
571                                             GdkExtensionMode    mode);
572
573 GdkExtensionMode gtk_widget_get_extension_events (GtkWidget     *widget);
574 GtkWidget*   gtk_widget_get_toplevel    (GtkWidget      *widget);
575 GtkWidget*   gtk_widget_get_ancestor    (GtkWidget      *widget,
576                                          GtkType        widget_type);
577 GdkColormap* gtk_widget_get_colormap    (GtkWidget      *widget);
578 GdkVisual*   gtk_widget_get_visual      (GtkWidget      *widget);
579
580 GtkSettings* gtk_widget_get_settings    (GtkWidget      *widget);
581
582 #ifndef GTK_DISABLE_DEPRECATED
583 #define gtk_widget_set_visual(widget,visual)  ((void) 0)
584 #define gtk_widget_push_visual(visual)        ((void) 0)
585 #define gtk_widget_pop_visual()               ((void) 0)
586 #define gtk_widget_set_default_visual(visual) ((void) 0)
587 #endif /* GTK_DISABLE_DEPRECATED */
588
589 /* Accessibility support */
590 AtkObject*       gtk_widget_get_accessible               (GtkWidget          *widget);
591
592 /* The following functions must not be called on an already
593  * realized widget. Because it is possible that somebody
594  * can call get_colormap() or get_visual() and save the
595  * result, these functions are probably only safe to
596  * call in a widget's init() function.
597  */
598 void         gtk_widget_set_colormap    (GtkWidget      *widget,
599                                          GdkColormap    *colormap);
600
601 gint         gtk_widget_get_events      (GtkWidget      *widget);
602 void         gtk_widget_get_pointer     (GtkWidget      *widget,
603                                          gint           *x,
604                                          gint           *y);
605
606 gboolean     gtk_widget_is_ancestor     (GtkWidget      *widget,
607                                          GtkWidget      *ancestor);
608
609 gboolean     gtk_widget_translate_coordinates (GtkWidget  *src_widget,
610                                                GtkWidget  *dest_widget,
611                                                gint        src_x,
612                                                gint        src_y,
613                                                gint       *dest_x,
614                                                gint       *dest_y);
615
616 /* Hide widget and return TRUE.
617  */
618 gboolean     gtk_widget_hide_on_delete  (GtkWidget      *widget);
619
620 /* Widget styles.
621  */
622 void       gtk_widget_set_style         (GtkWidget      *widget,
623                                          GtkStyle       *style);
624 void       gtk_widget_ensure_style      (GtkWidget      *widget);
625 GtkStyle*  gtk_widget_get_style         (GtkWidget      *widget);
626
627 void        gtk_widget_modify_style       (GtkWidget            *widget,
628                                            GtkRcStyle           *style);
629 GtkRcStyle *gtk_widget_get_modifier_style (GtkWidget            *widget);
630 void        gtk_widget_modify_fg          (GtkWidget            *widget,
631                                            GtkStateType          state,
632                                            GdkColor             *color);
633 void        gtk_widget_modify_bg          (GtkWidget            *widget,
634                                            GtkStateType          state,
635                                            GdkColor             *color);
636 void        gtk_widget_modify_text        (GtkWidget            *widget,
637                                            GtkStateType          state,
638                                            GdkColor             *color);
639 void        gtk_widget_modify_base        (GtkWidget            *widget,
640                                            GtkStateType          state,
641                                            GdkColor             *color);
642 void        gtk_widget_modify_font        (GtkWidget            *widget,
643                                            PangoFontDescription *font_desc);
644
645 #ifndef GTK_DISABLE_DEPRECATED
646 #define gtk_widget_set_rc_style(widget)          (gtk_widget_set_style (widget, NULL))
647 #define gtk_widget_restore_default_style(widget) (gtk_widget_set_style (widget, NULL))
648 #endif
649
650 PangoContext *gtk_widget_create_pango_context (GtkWidget   *widget);
651 PangoContext *gtk_widget_get_pango_context    (GtkWidget   *widget);
652 PangoLayout  *gtk_widget_create_pango_layout  (GtkWidget   *widget,
653                                                const gchar *text);
654
655 GdkPixbuf    *gtk_widget_render_icon          (GtkWidget   *widget,
656                                                const gchar *stock_id,
657                                                GtkIconSize  size,
658                                                const gchar *detail);
659
660 /* handle composite names for GTK_COMPOSITE_CHILD widgets,
661  * the returned name is newly allocated.
662  */
663 void   gtk_widget_set_composite_name    (GtkWidget      *widget,
664                                          const gchar    *name);
665 gchar* gtk_widget_get_composite_name    (GtkWidget      *widget);
666      
667 /* Descend recursively and set rc-style on all widgets without user styles */
668 void       gtk_widget_reset_rc_styles   (GtkWidget      *widget);
669
670 /* Push/pop pairs, to change default values upon a widget's creation.
671  * This will override the values that got set by the
672  * gtk_widget_set_default_* () functions.
673  */
674 void         gtk_widget_push_colormap        (GdkColormap *cmap);
675 void         gtk_widget_push_composite_child (void);
676 void         gtk_widget_pop_composite_child  (void);
677 void         gtk_widget_pop_colormap         (void);
678
679 /* widget style properties
680  */
681 void gtk_widget_class_install_style_property        (GtkWidgetClass     *klass,
682                                                      GParamSpec         *pspec);
683 void gtk_widget_class_install_style_property_parser (GtkWidgetClass     *klass,
684                                                      GParamSpec         *pspec,
685                                                      GtkRcPropertyParser parser);
686 void gtk_widget_style_get_property (GtkWidget        *widget,
687                                     const gchar    *property_name,
688                                     GValue           *value);
689 void gtk_widget_style_get_valist   (GtkWidget        *widget,
690                                     const gchar    *first_property_name,
691                                     va_list         var_args);
692 void gtk_widget_style_get          (GtkWidget        *widget,
693                                     const gchar    *first_property_name,
694                                     ...);
695
696
697 /* Set certain default values to be used at widget creation time.
698  */
699 void         gtk_widget_set_default_colormap (GdkColormap *colormap);
700 GtkStyle*    gtk_widget_get_default_style    (void);
701 GdkColormap* gtk_widget_get_default_colormap (void);
702 GdkVisual*   gtk_widget_get_default_visual   (void);
703
704 /* Functions for setting directionality for widgets
705  */
706
707 void             gtk_widget_set_direction         (GtkWidget        *widget,
708                                                    GtkTextDirection  dir);
709 GtkTextDirection gtk_widget_get_direction         (GtkWidget        *widget);
710
711 void             gtk_widget_set_default_direction (GtkTextDirection  dir);
712 GtkTextDirection gtk_widget_get_default_direction (void);
713
714 /* Counterpart to gdk_window_shape_combine_mask.
715  */
716 void         gtk_widget_shape_combine_mask (GtkWidget *widget,
717                                             GdkBitmap *shape_mask,
718                                             gint       offset_x,
719                                             gint       offset_y);
720
721 /* internal function */
722 void         gtk_widget_reset_shapes       (GtkWidget *widget);
723
724 /* Compute a widget's path in the form "GtkWindow.MyLabel", and
725  * return newly alocated strings.
726  */
727 void         gtk_widget_path               (GtkWidget *widget,
728                                             guint     *path_length,
729                                             gchar    **path,
730                                             gchar    **path_reversed);
731 void         gtk_widget_class_path         (GtkWidget *widget,
732                                             guint     *path_length,
733                                             gchar    **path,
734                                             gchar    **path_reversed);
735
736 GtkRequisition *gtk_requisition_copy (const GtkRequisition *requisition);
737 void            gtk_requisition_free (GtkRequisition       *requisition);
738
739 #if     defined (GTK_TRACE_OBJECTS) && defined (__GNUC__)
740 #  define gtk_widget_ref gtk_object_ref
741 #  define gtk_widget_unref gtk_object_unref
742 #endif  /* GTK_TRACE_OBJECTS && __GNUC__ */
743
744 GtkWidgetAuxInfo *_gtk_widget_get_aux_info                (GtkWidget    *widget,
745                                                            gboolean      create);
746 void              _gtk_widget_propagate_hierarchy_changed (GtkWidget    *widget,
747                                                            GtkWidget    *previous_toplevel);
748
749 GdkColormap* _gtk_widget_peek_colormap (void);
750
751 #ifdef __cplusplus
752 }
753 #endif /* __cplusplus */
754
755
756 #endif /* __GTK_WIDGET_H__ */