Pileus Git - ~andy/gtk/blob - gtk/gtkwidget.h

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