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