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