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