Pileus Git - ~andy/gtk/blob - 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 Library 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  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library 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 #ifndef __GTK_WIDGET_H__
  20 #define __GTK_WIDGET_H__
  21
  22
  23 #include <gdk/gdk.h>
  24 #include <gtk/gtkaccelgroup.h>
  25 #include <gtk/gtkobject.h>
  26 #include <gtk/gtkstyle.h>
  27
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif /* __cplusplus */
  32
  33
  34 /* The flags that are used by GtkWidget on top of the
  35  * flags field of GtkObject.
  36  */
  37 typedef enum
  38 {
  39   GTK_TOPLEVEL         = 1 << 4,
  40   GTK_NO_WINDOW        = 1 << 5,
  41   GTK_REALIZED         = 1 << 6,
  42   GTK_MAPPED           = 1 << 7,
  43   GTK_VISIBLE          = 1 << 8,
  44   GTK_SENSITIVE        = 1 << 9,
  45   GTK_PARENT_SENSITIVE = 1 << 10,
  46   GTK_CAN_FOCUS        = 1 << 11,
  47   GTK_HAS_FOCUS        = 1 << 12,
  48   GTK_CAN_DEFAULT      = 1 << 13,
  49   GTK_HAS_DEFAULT      = 1 << 14,
  50   GTK_HAS_GRAB         = 1 << 15,
  51   GTK_RC_STYLE         = 1 << 16,
  52   GTK_COMPOSITE_CHILD  = 1 << 17,
  53   GTK_BASIC            = 1 << 18
  54 } GtkWidgetFlags;
  55
  56 /* Macro for casting a pointer to a GtkWidget or GtkWidgetClass pointer.
  57  * Macros for testing whether `widget' or `klass' are of type GTK_TYPE_WIDGET.
  58  */
  59 #define GTK_TYPE_WIDGET                   (gtk_widget_get_type ())
  60 #define GTK_WIDGET(widget)                (GTK_CHECK_CAST ((widget), GTK_TYPE_WIDGET, GtkWidget))
  61 #define GTK_WIDGET_CLASS(klass)           (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_WIDGET, GtkWidgetClass))
  62 #define GTK_IS_WIDGET(widget)             (GTK_CHECK_TYPE ((widget), GTK_TYPE_WIDGET))
  63 #define GTK_IS_WIDGET_CLASS(klass)        (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WIDGET))
  64
  65 /* Macros for extracting various fields from GtkWidget and GtkWidgetClass.
  66  */
  67 #define GTK_WIDGET_TYPE(wid)              (GTK_OBJECT_TYPE (wid))
  68 #define GTK_WIDGET_STATE(wid)             (GTK_WIDGET (wid)->state)
  69 #define GTK_WIDGET_SAVED_STATE(wid)       (GTK_WIDGET (wid)->saved_state)
  70
  71 /* Macros for extracting the widget flags from GtkWidget.
  72  */
  73 #define GTK_WIDGET_FLAGS(wid)             (GTK_OBJECT_FLAGS (wid))
  74 #define GTK_WIDGET_TOPLEVEL(wid)          ((GTK_WIDGET_FLAGS (wid) & GTK_TOPLEVEL) != 0)
  75 #define GTK_WIDGET_NO_WINDOW(wid)         ((GTK_WIDGET_FLAGS (wid) & GTK_NO_WINDOW) != 0)
  76 #define GTK_WIDGET_REALIZED(wid)          ((GTK_WIDGET_FLAGS (wid) & GTK_REALIZED) != 0)
  77 #define GTK_WIDGET_MAPPED(wid)            ((GTK_WIDGET_FLAGS (wid) & GTK_MAPPED) != 0)
  78 #define GTK_WIDGET_VISIBLE(wid)           ((GTK_WIDGET_FLAGS (wid) & GTK_VISIBLE) != 0)
  79 #define GTK_WIDGET_DRAWABLE(wid)          ((GTK_WIDGET_VISIBLE (wid) && GTK_WIDGET_MAPPED (wid)) != 0)
  80 #define GTK_WIDGET_SENSITIVE(wid)         ((GTK_WIDGET_FLAGS (wid) & GTK_SENSITIVE) != 0)
  81 #define GTK_WIDGET_PARENT_SENSITIVE(wid)  ((GTK_WIDGET_FLAGS (wid) & GTK_PARENT_SENSITIVE) != 0)
  82 #define GTK_WIDGET_IS_SENSITIVE(wid)      (((GTK_WIDGET_SENSITIVE (wid) && \
  83                                             GTK_WIDGET_PARENT_SENSITIVE (wid)) != 0) != 0)
  84 #define GTK_WIDGET_CAN_FOCUS(wid)         ((GTK_WIDGET_FLAGS (wid) & GTK_CAN_FOCUS) != 0)
  85 #define GTK_WIDGET_HAS_FOCUS(wid)         ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_FOCUS) != 0)
  86 #define GTK_WIDGET_CAN_DEFAULT(wid)       ((GTK_WIDGET_FLAGS (wid) & GTK_CAN_DEFAULT) != 0)
  87 #define GTK_WIDGET_HAS_DEFAULT(wid)       ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_DEFAULT) != 0)
  88 #define GTK_WIDGET_HAS_GRAB(wid)          ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_GRAB) != 0)
  89 #define GTK_WIDGET_RC_STYLE(wid)          ((GTK_WIDGET_FLAGS (wid) & GTK_RC_STYLE) != 0)
  90 #define GTK_WIDGET_COMPOSITE_CHILD(wid)   ((GTK_WIDGET_FLAGS (wid) & GTK_COMPOSITE_CHILD) != 0)
  91 #define GTK_WIDGET_BASIC(wid)             ((GTK_WIDGET_FLAGS (wid) & GTK_BASIC) != 0)
  92
  93 /* Macros for setting and clearing widget flags.
  94  */
  95 #define GTK_WIDGET_SET_FLAGS(wid,flag)    G_STMT_START{ (GTK_WIDGET_FLAGS (wid) |= (flag)); }G_STMT_END
  96 #define GTK_WIDGET_UNSET_FLAGS(wid,flag)  G_STMT_START{ (GTK_WIDGET_FLAGS (wid) &= ~(flag)); }G_STMT_END
  97
  98
  99
 100 typedef struct _GtkRequisition    GtkRequisition;
 101 typedef struct _GtkAllocation     GtkAllocation;
 102 typedef struct _GtkSelectionData GtkSelectionData;
 103 typedef struct _GtkWidget         GtkWidget;
 104 typedef struct _GtkWidgetClass    GtkWidgetClass;
 105 typedef struct _GtkWidgetAuxInfo  GtkWidgetAuxInfo;
 106 typedef struct _GtkWidgetShapeInfo GtkWidgetShapeInfo;
 107
 108 typedef void (*GtkCallback) (GtkWidget *widget,
 109                              gpointer   data);
 110
 111 /* A requisition is a desired amount of space which a
 112  *  widget may request.
 113  */
 114 struct _GtkRequisition
 115 {
 116   guint16 width;
 117   guint16 height;
 118 };
 119
 120 /* An allocation is a size and position. Where a widget
 121  *  can ask for a desired size, it is actually given
 122  *  this amount of space at the specified position.
 123  */
 124 struct _GtkAllocation
 125 {
 126   gint16 x;
 127   gint16 y;
 128   guint16 width;
 129   guint16 height;
 130 };
 131
 132 /* The contents of a selection are returned in a GtkSelectionData
 133    structure. selection/target identify the request.
 134    type specifies the type of the return; if length < 0, and
 135    the data should be ignored. This structure has object semantics -
 136    no fields should be modified directly, they should not be created
 137    directly, and pointers to them should not be stored beyond the duration of
 138    a callback. (If the last is changed, we'll need to add reference
 139    counting.) The time field gives the timestamp at which the data was sent. */
 140
 141 struct _GtkSelectionData
 142 {
 143   GdkAtom selection;
 144   GdkAtom target;
 145   GdkAtom type;
 146   gint    format;
 147   guchar *data;
 148   gint    length;
 149 };
 150
 151 /* The widget is the base of the tree for displayable objects.
 152  *  (A displayable object is one which takes up some amount
 153  *  of screen real estate). It provides a common base and interface
 154  *  which actual widgets must adhere to.
 155  */
 156 struct _GtkWidget
 157 {
 158   /* The object structure needs to be the first
 159    *  element in the widget structure in order for
 160    *  the object mechanism to work correctly. This
 161    *  allows a GtkWidget pointer to be cast to a
 162    *  GtkObject pointer.
 163    */
 164   GtkObject object;
 165
 166   /* 16 bits of internally used private flags.
 167    * this will be packed into the same 4 byte alignment frame that
 168    * state and saved_state go. we therefore don't waste any new
 169    * space on this.
 170    */
 171   guint16 private_flags;
 172
 173   /* The state of the widget. There are actually only
 174    *  5 widget states (defined in "gtkenums.h").
 175    */
 176   guint8 state;
 177
 178   /* The saved state of the widget. When a widgets state
 179    *  is changed to GTK_STATE_INSENSITIVE via
 180    *  "gtk_widget_set_state" or "gtk_widget_set_sensitive"
 181    *  the old state is kept around in this field. The state
 182    *  will be restored once the widget gets sensitive again.
 183    */
 184   guint8 saved_state;
 185
 186   /* The widgets name. If the widget does not have a name
 187    *  (the name is NULL), then its name (as returned by
 188    *  "gtk_widget_get_name") is its classes name.
 189    * Among other things, the widget name is used to determine
 190    *  the style to use for a widget.
 191    */
 192   gchar *name;
 193
 194   /* The style for the widget. The style contains the
 195    *  colors the widget should be drawn in for each state
 196    *  along with graphics contexts used to draw with and
 197    *  the font to use for text.
 198    */
 199   GtkStyle *style;
 200
 201   /* The widgets desired size.
 202    */
 203   GtkRequisition requisition;
 204
 205   /* The widgets allocated size.
 206    */
 207   GtkAllocation allocation;
 208
 209   /* The widgets window or its parent window if it does
 210    *  not have a window. (Which will be indicated by the
 211    *  GTK_NO_WINDOW flag being set).
 212    */
 213   GdkWindow *window;
 214
 215   /* The widgets parent.
 216    */
 217   GtkWidget *parent;
 218 };
 219
 220 struct _GtkWidgetClass
 221 {
 222   /* The object class structure needs to be the first
 223    *  element in the widget class structure in order for
 224    *  the class mechanism to work correctly. This allows a
 225    *  GtkWidgetClass pointer to be cast to a GtkObjectClass
 226    *  pointer.
 227    */
 228   GtkObjectClass parent_class;
 229
 230   /* The signal to emit when an object of this class is activated.
 231    *  This is used when activating the current focus widget and
 232    *  the default widget.
 233    */
 234   guint activate_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 (* draw)                (GtkWidget      *widget,
 246                                 GdkRectangle   *area);
 247   void (* draw_focus)          (GtkWidget      *widget);
 248   void (* draw_default)        (GtkWidget      *widget);
 249   void (* size_request)        (GtkWidget      *widget,
 250                                 GtkRequisition *requisition);
 251   void (* size_allocate)       (GtkWidget      *widget,
 252                                 GtkAllocation  *allocation);
 253   void (* state_changed)       (GtkWidget      *widget,
 254                                 GtkStateType    previous_state);
 255   void (* parent_set)          (GtkWidget      *widget,
 256                                 GtkWidget      *previous_parent);
 257   void (* style_set)           (GtkWidget      *widget,
 258                                 GtkStyle       *previous_style);
 259
 260   /* accelerators */
 261   gint (* add_accelerator)     (GtkWidget      *widget,
 262                                 guint           accel_signal_id,
 263                                 GtkAccelGroup  *accel_group,
 264                                 guint           accel_key,
 265                                 GdkModifierType accel_mods,
 266                                 GtkAccelFlags   accel_flags);
 267   void (* remove_accelerator)  (GtkWidget      *widget,
 268                                 GtkAccelGroup  *accel_group,
 269                                 guint           accel_key,
 270                                 GdkModifierType accel_mods);
 271
 272   /* events */
 273   gint (* event)                   (GtkWidget          *widget,
 274                                     GdkEvent           *event);
 275   gint (* button_press_event)      (GtkWidget          *widget,
 276                                     GdkEventButton     *event);
 277   gint (* button_release_event)    (GtkWidget          *widget,
 278                                     GdkEventButton     *event);
 279   gint (* motion_notify_event)     (GtkWidget          *widget,
 280                                     GdkEventMotion     *event);
 281   gint (* delete_event)            (GtkWidget          *widget,
 282                                     GdkEventAny        *event);
 283   gint (* destroy_event)           (GtkWidget          *widget,
 284                                     GdkEventAny        *event);
 285   gint (* expose_event)            (GtkWidget          *widget,
 286                                     GdkEventExpose     *event);
 287   gint (* key_press_event)         (GtkWidget          *widget,
 288                                     GdkEventKey        *event);
 289   gint (* key_release_event)       (GtkWidget          *widget,
 290                                     GdkEventKey        *event);
 291   gint (* enter_notify_event)      (GtkWidget          *widget,
 292                                     GdkEventCrossing   *event);
 293   gint (* leave_notify_event)      (GtkWidget          *widget,
 294                                     GdkEventCrossing   *event);
 295   gint (* configure_event)         (GtkWidget          *widget,
 296                                     GdkEventConfigure  *event);
 297   gint (* focus_in_event)          (GtkWidget          *widget,
 298                                     GdkEventFocus      *event);
 299   gint (* focus_out_event)         (GtkWidget          *widget,
 300                                     GdkEventFocus      *event);
 301   gint (* map_event)               (GtkWidget          *widget,
 302                                     GdkEventAny        *event);
 303   gint (* unmap_event)             (GtkWidget          *widget,
 304                                     GdkEventAny        *event);
 305   gint (* property_notify_event)   (GtkWidget          *widget,
 306                                     GdkEventProperty   *event);
 307   gint (* selection_clear_event)   (GtkWidget          *widget,
 308                                     GdkEventSelection  *event);
 309   gint (* selection_request_event) (GtkWidget          *widget,
 310                                     GdkEventSelection  *event);
 311   gint (* selection_notify_event)  (GtkWidget          *widget,
 312                                     GdkEventSelection  *event);
 313   gint (* proximity_in_event)      (GtkWidget          *widget,
 314                                     GdkEventProximity  *event);
 315   gint (* proximity_out_event)     (GtkWidget          *widget,
 316                                     GdkEventProximity  *event);
 317   gint (* visibility_notify_event)  (GtkWidget         *widget,
 318                                      GdkEventVisibility *event);
 319   gint (* client_event)            (GtkWidget          *widget,
 320                                     GdkEventClient     *event);
 321   gint (* no_expose_event)         (GtkWidget          *widget,
 322                                     GdkEventAny        *event);
 323
 324   /* selection */
 325   void (* selection_get)           (GtkWidget          *widget,
 326                                     GtkSelectionData   *selection_data,
 327                                     guint               info,
 328                                     guint               time);
 329   void (* selection_received)      (GtkWidget          *widget,
 330                                     GtkSelectionData   *selection_data,
 331                                     guint               time);
 332
 333   /* Source side drag signals */
 334   void (* drag_begin)              (GtkWidget          *widget,
 335                                     GdkDragContext     *context);
 336   void (* drag_end)                (GtkWidget          *widget,
 337                                     GdkDragContext     *context);
 338   void (* drag_data_get)           (GtkWidget          *widget,
 339                                     GdkDragContext     *context,
 340                                     GtkSelectionData   *selection_data,
 341                                     guint               info,
 342                                     guint32             time);
 343   void (* drag_data_delete)        (GtkWidget          *widget,
 344                                     GdkDragContext     *context);
 345
 346   /* Target side drag signals */
 347   void (* drag_leave)              (GtkWidget          *widget,
 348                                     GdkDragContext     *context,
 349                                     guint               time);
 350   gboolean (* drag_motion)         (GtkWidget          *widget,
 351                                     GdkDragContext     *context,
 352                                     gint                x,
 353                                     gint                y,
 354                                     guint               time);
 355   gboolean (* drag_drop)           (GtkWidget          *widget,
 356                                     GdkDragContext     *context,
 357                                     gint                x,
 358                                     gint                y,
 359                                     guint               time);
 360   void (* drag_data_received)      (GtkWidget          *widget,
 361                                     GdkDragContext     *context,
 362                                     GtkSelectionData   *selection_data,
 363                                     guint               info,
 364                                     guint32             time);
 365
 366   /* action signals */
 367   void (* debug_msg)               (GtkWidget          *widget,
 368                                     const gchar        *string);
 369 };
 370
 371 struct _GtkWidgetAuxInfo
 372 {
 373   gint16  x;
 374   gint16  y;
 375   gint16 width;
 376   gint16 height;
 377 };
 378
 379 struct _GtkWidgetShapeInfo
 380 {
 381   gint16     offset_x;
 382   gint16     offset_y;
 383   GdkBitmap *shape_mask;
 384 };
 385
 386
 387 GtkType    gtk_widget_get_type            (void);
 388 GtkWidget* gtk_widget_new                 (GtkType              type,
 389                                            const gchar         *first_arg_name,
 390                                            ...);
 391 GtkWidget* gtk_widget_newv                (GtkType              type,
 392                                            guint                nargs,
 393                                            GtkArg              *args);
 394 void       gtk_widget_ref                 (GtkWidget           *widget);
 395 void       gtk_widget_unref               (GtkWidget           *widget);
 396 void       gtk_widget_destroy             (GtkWidget           *widget);
 397 void       gtk_widget_destroyed           (GtkWidget           *widget,
 398                                            GtkWidget          **widget_pointer);
 399 void       gtk_widget_get                 (GtkWidget           *widget,
 400                                            GtkArg              *arg);
 401 void       gtk_widget_getv                (GtkWidget           *widget,
 402                                            guint                nargs,
 403                                            GtkArg              *args);
 404 void       gtk_widget_set                 (GtkWidget           *widget,
 405                                            const gchar         *first_arg_name,
 406                                            ...);
 407 void       gtk_widget_setv                (GtkWidget           *widget,
 408                                            guint                nargs,
 409                                            GtkArg              *args);
 410 void       gtk_widget_unparent            (GtkWidget           *widget);
 411 void       gtk_widget_show                (GtkWidget           *widget);
 412 void       gtk_widget_show_now            (GtkWidget           *widget);
 413 void       gtk_widget_hide                (GtkWidget           *widget);
 414 void       gtk_widget_show_all            (GtkWidget           *widget);
 415 void       gtk_widget_hide_all            (GtkWidget           *widget);
 416 void       gtk_widget_map                 (GtkWidget           *widget);
 417 void       gtk_widget_unmap               (GtkWidget           *widget);
 418 void       gtk_widget_realize             (GtkWidget           *widget);
 419 void       gtk_widget_unrealize           (GtkWidget           *widget);
 420 void       gtk_widget_queue_draw          (GtkWidget           *widget);
 421 void       gtk_widget_queue_resize        (GtkWidget           *widget);
 422 void       gtk_widget_draw                (GtkWidget           *widget,
 423                                            GdkRectangle        *area);
 424 void       gtk_widget_draw_focus          (GtkWidget           *widget);
 425 void       gtk_widget_draw_default        (GtkWidget           *widget);
 426 void       gtk_widget_draw_children       (GtkWidget           *widget);
 427 void       gtk_widget_size_request        (GtkWidget           *widget,
 428                                            GtkRequisition      *requisition);
 429 void       gtk_widget_size_allocate       (GtkWidget           *widget,
 430                                            GtkAllocation       *allocation);
 431 void       gtk_widget_add_accelerator     (GtkWidget           *widget,
 432                                            const gchar         *accel_signal,
 433                                            GtkAccelGroup       *accel_group,
 434                                            guint                accel_key,
 435                                            guint                accel_mods,
 436                                            GtkAccelFlags        accel_flags);
 437 void       gtk_widget_remove_accelerator  (GtkWidget           *widget,
 438                                            GtkAccelGroup       *accel_group,
 439                                            guint                accel_key,
 440                                            guint                accel_mods);
 441 void       gtk_widget_remove_accelerators (GtkWidget           *widget,
 442                                            const gchar         *accel_signal,
 443                                            gboolean             visible_only);
 444 guint      gtk_widget_accelerator_signal  (GtkWidget           *widget,
 445                                            GtkAccelGroup       *accel_group,
 446                                            guint                accel_key,
 447                                            guint                accel_mods);
 448 void       gtk_widget_freeze_accelerators (GtkWidget           *widget);
 449 void       gtk_widget_thaw_accelerators   (GtkWidget           *widget);
 450 gint       gtk_widget_event               (GtkWidget           *widget,
 451                                            GdkEvent            *event);
 452
 453 void       gtk_widget_activate            (GtkWidget           *widget);
 454 void       gtk_widget_reparent            (GtkWidget           *widget,
 455                                            GtkWidget           *new_parent);
 456 void       gtk_widget_popup               (GtkWidget           *widget,
 457                                            gint                 x,
 458                                            gint                 y);
 459 gint       gtk_widget_intersect           (GtkWidget           *widget,
 460                                            GdkRectangle        *area,
 461                                            GdkRectangle        *intersection);
 462 gint       gtk_widget_basic               (GtkWidget           *widget);
 463
 464 void       gtk_widget_grab_focus          (GtkWidget           *widget);
 465 void       gtk_widget_grab_default        (GtkWidget           *widget);
 466
 467 void       gtk_widget_set_name            (GtkWidget           *widget,
 468                                            const gchar         *name);
 469 gchar*     gtk_widget_get_name            (GtkWidget           *widget);
 470 void       gtk_widget_set_state           (GtkWidget           *widget,
 471                                            GtkStateType         state);
 472 void       gtk_widget_set_sensitive       (GtkWidget           *widget,
 473                                            gint                 sensitive);
 474 void       gtk_widget_set_parent          (GtkWidget           *widget,
 475                                            GtkWidget           *parent);
 476 void       gtk_widget_set_parent_window   (GtkWidget           *widget,
 477                                            GdkWindow           *parent_window);
 478 GdkWindow *gtk_widget_get_parent_window   (GtkWidget           *widget);
 479 void       gtk_widget_set_uposition       (GtkWidget           *widget,
 480                                            gint                 x,
 481                                            gint                 y);
 482 void       gtk_widget_set_usize           (GtkWidget           *widget,
 483                                            gint                 width,
 484                                            gint                 height);
 485 void       gtk_widget_set_events          (GtkWidget           *widget,
 486                                            gint                 events);
 487 void       gtk_widget_add_events          (GtkWidget           *widget,
 488                                            gint                 events);
 489 void       gtk_widget_set_extension_events (GtkWidget           *widget,
 490                                             GdkExtensionMode    mode);
 491
 492 GdkExtensionMode gtk_widget_get_extension_events (GtkWidget     *widget);
 493 GtkWidget*   gtk_widget_get_toplevel    (GtkWidget      *widget);
 494 GtkWidget*   gtk_widget_get_ancestor    (GtkWidget      *widget,
 495                                          GtkType        widget_type);
 496 GdkColormap* gtk_widget_get_colormap    (GtkWidget      *widget);
 497 GdkVisual*   gtk_widget_get_visual      (GtkWidget      *widget);
 498 gint         gtk_widget_get_events      (GtkWidget      *widget);
 499 void         gtk_widget_get_pointer     (GtkWidget      *widget,
 500                                          gint           *x,
 501                                          gint           *y);
 502
 503 gint         gtk_widget_is_ancestor     (GtkWidget      *widget,
 504                                          GtkWidget      *ancestor);
 505 gint         gtk_widget_is_child        (GtkWidget      *widget,
 506                                          GtkWidget      *child);
 507
 508 /* Hide widget and return TRUE.
 509  */
 510 gint       gtk_widget_hide_on_delete    (GtkWidget      *widget);
 511
 512 /* Widget styles.
 513  */
 514 void       gtk_widget_set_style         (GtkWidget      *widget,
 515                                          GtkStyle       *style);
 516 void       gtk_widget_set_rc_style      (GtkWidget      *widget);
 517 void       gtk_widget_ensure_style      (GtkWidget      *widget);
 518 GtkStyle*  gtk_widget_get_style         (GtkWidget      *widget);
 519 void       gtk_widget_restore_default_style (GtkWidget  *widget);
 520
 521 /* Descend recursively and set rc-style on all widgets without user styles */
 522 void       gtk_widget_reset_rc_styles   (GtkWidget      *widget);
 523
 524 /* Push/pop pairs, to change default values upon a widget's creation.
 525  * This will override the values that got set by the
 526  * gtk_widget_set_default_* () functions.
 527  */
 528 void         gtk_widget_push_style          (GtkStyle    *style);
 529 void         gtk_widget_push_colormap       (GdkColormap *cmap);
 530 void         gtk_widget_push_visual         (GdkVisual   *visual);
 531 void         gtk_widget_push_composite_flag (void);
 532 void         gtk_widget_pop_composite_flag  (void);
 533 void         gtk_widget_pop_style           (void);
 534 void         gtk_widget_pop_colormap        (void);
 535 void         gtk_widget_pop_visual          (void);
 536
 537 /* Set certain default values to be used at widget creation time.
 538  */
 539 void         gtk_widget_set_default_style    (GtkStyle    *style);
 540 void         gtk_widget_set_default_colormap (GdkColormap *colormap);
 541 void         gtk_widget_set_default_visual   (GdkVisual   *visual);
 542 GtkStyle*    gtk_widget_get_default_style    (void);
 543 GdkColormap* gtk_widget_get_default_colormap (void);
 544 GdkVisual*   gtk_widget_get_default_visual   (void);
 545
 546 /* Counterpart to gdk_window_shape_combine_mask.
 547  */
 548 void         gtk_widget_shape_combine_mask (GtkWidget *widget,
 549                                             GdkBitmap *shape_mask,
 550                                             gint       offset_x,
 551                                             gint       offset_y);
 552
 553 /* Compute a widget's path in the form "GtkWindow.MyLabel", and
 554  * return newly alocated strings.
 555  */
 556 void         gtk_widget_path               (GtkWidget *widget,
 557                                             guint     *path_length,
 558                                             gchar    **path,
 559                                             gchar    **path_reversed);
 560 void         gtk_widget_class_path         (GtkWidget *widget,
 561                                             guint     *path_length,
 562                                             gchar    **path,
 563                                             gchar    **path_reversed);
 564
 565 #if     defined (GTK_TRACE_OBJECTS) && defined (__GNUC__)
 566 #  define gtk_widget_ref gtk_object_ref
 567 #  define gtk_widget_unref gtk_object_unref
 568 #endif  /* GTK_TRACE_OBJECTS && __GNUC__ */
 569
 570
 571 #ifdef __cplusplus
 572 }
 573 #endif /* __cplusplus */
 574
 575
 576 #endif /* __GTK_WIDGET_H__ */