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