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 #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 /**
  45  * GtkWidgetFlags:
  46  * @GTK_TOPLEVEL: widgets without a real parent, as there are #GtkWindow<!-- -->s and
  47  *  #GtkMenu<!-- -->s have this flag set throughout their lifetime.
  48  *  Toplevel widgets always contain their own #GdkWindow.
  49  * @GTK_NO_WINDOW: Indicative for a widget that does not provide its own #GdkWindow.
  50  *  Visible action (e.g. drawing) is performed on the parent's #GdkWindow.
  51  * @GTK_REALIZED: Set by gtk_widget_realize(), unset by gtk_widget_unrealize().
  52  *  A realized widget has an associated #GdkWindow.
  53  * @GTK_MAPPED: Set by gtk_widget_map(), unset by gtk_widget_unmap().
  54  *  Only realized widgets can be mapped. It means that gdk_window_show()
  55  *  has been called on the widgets window(s).
  56  * @GTK_VISIBLE: Set by gtk_widget_show(), unset by gtk_widget_hide(). Implies that a
  57  *  widget will be mapped as soon as its parent is mapped.
  58  * @GTK_SENSITIVE: Set and unset by gtk_widget_set_sensitive().
  59  *  The sensitivity of a widget determines whether it will receive
  60  *  certain events (e.g. button or key presses). One premise for
  61  *  the widget's sensitivity is to have this flag set.
  62  * @GTK_PARENT_SENSITIVE: Set and unset by gtk_widget_set_sensitive() operations on the
  63  *  parents of the widget.
  64  *  This is the second premise for the widget's sensitivity. Once
  65  *  it has %GTK_SENSITIVE and %GTK_PARENT_SENSITIVE set, its state is
  66  *  effectively sensitive. This is expressed (and can be examined) by
  67  *  the #GTK_WIDGET_IS_SENSITIVE macro.
  68  * @GTK_CAN_FOCUS: Determines whether a widget is able to handle focus grabs.
  69  * @GTK_HAS_FOCUS: Set by gtk_widget_grab_focus() for widgets that also
  70  *  have %GTK_CAN_FOCUS set. The flag will be unset once another widget
  71  *  grabs the focus.
  72  * @GTK_CAN_DEFAULT: The widget is allowed to receive the default action via
  73  *  gtk_widget_grab_default() and will reserve space to draw the default if possible
  74  * @GTK_HAS_DEFAULT: The widget currently is receiving the default action and
  75  *  should be drawn appropriately if possible
  76  * @GTK_HAS_GRAB: Set by gtk_grab_add(), unset by gtk_grab_remove(). It means that the
  77  *  widget is in the grab_widgets stack, and will be the preferred one for
  78  *  receiving events other than ones of cosmetic value.
  79  * @GTK_RC_STYLE: Indicates that the widget's style has been looked up through the rc
  80  *  mechanism. It does not imply that the widget actually had a style
  81  *  defined through the rc mechanism.
  82  * @GTK_COMPOSITE_CHILD: Indicates that the widget is a composite child of its parent; see
  83  *  gtk_widget_push_composite_child(), gtk_widget_pop_composite_child().
  84  * @GTK_NO_REPARENT: Unused since before GTK+ 1.2, will be removed in a future version.
  85  * @GTK_APP_PAINTABLE: Set and unset by gtk_widget_set_app_paintable().
  86  *  Must be set on widgets whose window the application directly draws on,
  87  *  in order to keep GTK+ from overwriting the drawn stuff.  See
  88  *  <xref linkend="app-paintable-widgets"/> for a detailed
  89  *  description of this flag.
  90  * @GTK_RECEIVES_DEFAULT: The widget when focused will receive the default action and have
  91  *  %GTK_HAS_DEFAULT set even if there is a different widget set as default.
  92  * @GTK_DOUBLE_BUFFERED: Set and unset by gtk_widget_set_double_buffered().
  93  *  Indicates that exposes done on the widget should be
  94  *  double-buffered.  See <xref linkend="double-buffering"/> for a
  95  *  detailed discussion of how double-buffering works in GTK+ and
  96  *  why you may want to disable it for special cases.
  97  * @GTK_NO_SHOW_ALL:
  98  *
  99  * Tells about certain properties of the widget.
 100  */
 101 typedef enum
 102 {
 103   GTK_TOPLEVEL         = 1 << 4,
 104   GTK_NO_WINDOW        = 1 << 5,
 105   GTK_REALIZED         = 1 << 6,
 106   GTK_MAPPED           = 1 << 7,
 107   GTK_VISIBLE          = 1 << 8,
 108   GTK_SENSITIVE        = 1 << 9,
 109   GTK_PARENT_SENSITIVE = 1 << 10,
 110   GTK_CAN_FOCUS        = 1 << 11,
 111   GTK_HAS_FOCUS        = 1 << 12,
 112   GTK_CAN_DEFAULT      = 1 << 13,
 113   GTK_HAS_DEFAULT      = 1 << 14,
 114   GTK_HAS_GRAB         = 1 << 15,
 115   GTK_RC_STYLE         = 1 << 16,
 116   GTK_COMPOSITE_CHILD  = 1 << 17,
 117   GTK_NO_REPARENT      = 1 << 18,
 118   GTK_APP_PAINTABLE    = 1 << 19,
 119   GTK_RECEIVES_DEFAULT = 1 << 20,
 120   GTK_DOUBLE_BUFFERED  = 1 << 21,
 121   GTK_NO_SHOW_ALL      = 1 << 22
 122 } GtkWidgetFlags;
 123
 124 /* Kinds of widget-specific help */
 125 typedef enum
 126 {
 127   GTK_WIDGET_HELP_TOOLTIP,
 128   GTK_WIDGET_HELP_WHATS_THIS
 129 } GtkWidgetHelpType;
 130
 131 /* Macro for casting a pointer to a GtkWidget or GtkWidgetClass pointer.
 132  * Macros for testing whether `widget' or `klass' are of type GTK_TYPE_WIDGET.
 133  */
 134 #define GTK_TYPE_WIDGET                   (gtk_widget_get_type ())
 135 #define GTK_WIDGET(widget)                (G_TYPE_CHECK_INSTANCE_CAST ((widget), GTK_TYPE_WIDGET, GtkWidget))
 136 #define GTK_WIDGET_CLASS(klass)           (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WIDGET, GtkWidgetClass))
 137 #define GTK_IS_WIDGET(widget)             (G_TYPE_CHECK_INSTANCE_TYPE ((widget), GTK_TYPE_WIDGET))
 138 #define GTK_IS_WIDGET_CLASS(klass)        (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WIDGET))
 139 #define GTK_WIDGET_GET_CLASS(obj)         (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WIDGET, GtkWidgetClass))
 140
 141 /* Macros for extracting various fields from GtkWidget and GtkWidgetClass.
 142  */
 143 #ifndef GTK_DISABLE_DEPRECATED
 144 /**
 145  * GTK_WIDGET_TYPE:
 146  * @wid: a #GtkWidget.
 147  *
 148  * Gets the type of a widget.
 149  *
 150  * Deprecated: 2.20: Use G_OBJECT_TYPE() instead.
 151  */
 152 #define GTK_WIDGET_TYPE(wid)              (GTK_OBJECT_TYPE (wid))
 153 #endif
 154
 155 /**
 156  * GTK_WIDGET_STATE:
 157  * @wid: a #GtkWidget.
 158  *
 159  * Returns the current state of the widget, as a #GtkStateType.
 160  *
 161  * Deprecated: 2.20: Use gtk_widget_get_state() instead.
 162  */
 163 #define GTK_WIDGET_STATE(wid)             (GTK_WIDGET (wid)->state)
 164 /* FIXME: Deprecating GTK_WIDGET_STATE requires fixing GTK internals. */
 165
 166 #ifndef GTK_DISABLE_DEPRECATED
 167 /**
 168  * GTK_WIDGET_SAVED_STATE:
 169  * @wid: a #GtkWidget.
 170  *
 171  * Returns the saved state of the widget, as a #GtkStateType.
 172  *
 173  * The saved state will be restored when a widget gets sensitive
 174  * again, after it has been made insensitive with gtk_widget_set_state()
 175  * or gtk_widget_set_sensitive().
 176  *
 177  * Deprecated: 2.20: Do not used it.
 178  */
 179 #define GTK_WIDGET_SAVED_STATE(wid)       (GTK_WIDGET (wid)->saved_state)
 180 #endif
 181
 182
 183 /* Macros for extracting the widget flags from GtkWidget.
 184  */
 185 /**
 186  * GTK_WIDGET_FLAGS:
 187  * @wid: a #GtkWidget.
 188  *
 189  * Returns the widget flags from @wid.
 190  *
 191  * Deprecated: 2.20: Do not use it.
 192  */
 193 #define GTK_WIDGET_FLAGS(wid)             (GTK_OBJECT_FLAGS (wid))
 194 /* FIXME: Deprecating GTK_WIDGET_FLAGS requires fixing GTK internals. */
 195
 196 #ifndef GTK_DISABLE_DEPRECATED
 197 /**
 198  * GTK_WIDGET_TOPLEVEL:
 199  * @wid: a #GtkWidget.
 200  *
 201  * Evaluates to %TRUE if the widget is a toplevel widget.
 202  *
 203  * Deprecated: 2.20: Use gtk_widget_is_toplevel() instead.
 204  */
 205 #define GTK_WIDGET_TOPLEVEL(wid)          ((GTK_WIDGET_FLAGS (wid) & GTK_TOPLEVEL) != 0)
 206 #endif
 207
 208 #ifndef GTK_DISABLE_DEPRECATED
 209 /**
 210  * GTK_WIDGET_NO_WINDOW:
 211  * @wid: a #GtkWidget.
 212  *
 213  * Evaluates to %TRUE if the widget doesn't have an own #GdkWindow.
 214  *
 215  * Deprecated: 2.20: Use gtk_widget_get_has_window() instead.
 216  */
 217 #define GTK_WIDGET_NO_WINDOW(wid)         ((GTK_WIDGET_FLAGS (wid) & GTK_NO_WINDOW) != 0)
 218 #endif
 219
 220 /**
 221  * GTK_WIDGET_REALIZED:
 222  * @wid: a #GtkWidget.
 223  *
 224  * Evaluates to %TRUE if the widget is realized.
 225  */
 226 #define GTK_WIDGET_REALIZED(wid)          ((GTK_WIDGET_FLAGS (wid) & GTK_REALIZED) != 0)
 227
 228 /**
 229  * GTK_WIDGET_MAPPED:
 230  * @wid: a #GtkWidget.
 231  *
 232  * Evaluates to %TRUE if the widget is mapped.
 233  */
 234 #define GTK_WIDGET_MAPPED(wid)            ((GTK_WIDGET_FLAGS (wid) & GTK_MAPPED) != 0)
 235
 236 /**
 237  * GTK_WIDGET_VISIBLE:
 238  * @wid: a #GtkWidget.
 239  *
 240  * Evaluates to %TRUE if the widget is visible.
 241  */
 242 #define GTK_WIDGET_VISIBLE(wid)           ((GTK_WIDGET_FLAGS (wid) & GTK_VISIBLE) != 0)
 243
 244 #ifndef GTK_DISABLE_DEPRECATED
 245 /**
 246  * GTK_WIDGET_DRAWABLE:
 247  * @wid: a #GtkWidget.
 248  *
 249  * Evaluates to %TRUE if the widget is mapped and visible.
 250  *
 251  * Deprecated: 2.20: Use gtk_widget_is_drawable() instead.
 252  */
 253 #define GTK_WIDGET_DRAWABLE(wid)          (GTK_WIDGET_VISIBLE (wid) && GTK_WIDGET_MAPPED (wid))
 254 #endif
 255
 256 /**
 257  * GTK_WIDGET_SENSITIVE:
 258  * @wid: a #GtkWidget.
 259  *
 260  * Evaluates to %TRUE if the #GTK_SENSITIVE flag has be set on the widget.
 261  */
 262 #define GTK_WIDGET_SENSITIVE(wid)         ((GTK_WIDGET_FLAGS (wid) & GTK_SENSITIVE) != 0)
 263
 264 /**
 265  * GTK_WIDGET_PARENT_SENSITIVE:
 266  * @wid: a #GtkWidget.
 267  *
 268  * Evaluates to %TRUE if the #GTK_PARENT_SENSITIVE flag has be set on the widget.
 269  */
 270 #define GTK_WIDGET_PARENT_SENSITIVE(wid)  ((GTK_WIDGET_FLAGS (wid) & GTK_PARENT_SENSITIVE) != 0)
 271
 272 #ifndef GTK_DISABLE_DEPRECATED
 273 /**
 274  * GTK_WIDGET_IS_SENSITIVE:
 275  * @wid: a #GtkWidget.
 276  *
 277  * Evaluates to %TRUE if the widget is effectively sensitive.
 278  *
 279  * Deprecated: 2.20: Use gtk_widget_is_sensitive() instead.
 280  */
 281 #define GTK_WIDGET_IS_SENSITIVE(wid)      (GTK_WIDGET_SENSITIVE (wid) && \
 282                                            GTK_WIDGET_PARENT_SENSITIVE (wid))
 283 #endif
 284
 285 #ifndef GTK_DISABLE_DEPRECATED
 286 /**
 287  * GTK_WIDGET_CAN_FOCUS:
 288  * @wid: a #GtkWidget.
 289  *
 290  * Evaluates to %TRUE if the widget is able to handle focus grabs.
 291  *
 292  * Deprecated: 2.20: Use gtk_widget_get_can_focus() instead.
 293  */
 294 #define GTK_WIDGET_CAN_FOCUS(wid)         ((GTK_WIDGET_FLAGS (wid) & GTK_CAN_FOCUS) != 0)
 295 #endif
 296
 297 /**
 298  * GTK_WIDGET_HAS_FOCUS:
 299  * @wid: a #GtkWidget.
 300  *
 301  * Evaluates to %TRUE if the widget has grabbed the focus and no other
 302  * widget has done so more recently.
 303  */
 304 #define GTK_WIDGET_HAS_FOCUS(wid)         ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_FOCUS) != 0)
 305
 306 #ifndef GTK_DISABLE_DEPRECATED
 307 /**
 308  * GTK_WIDGET_CAN_DEFAULT:
 309  * @wid: a #GtkWidget.
 310  *
 311  * Evaluates to %TRUE if the widget is allowed to receive the default action
 312  * via gtk_widget_grab_default().
 313  *
 314  * Deprecated: 2.20: Use gtk_widget_get_can_default() instead.
 315  */
 316 #define GTK_WIDGET_CAN_DEFAULT(wid)       ((GTK_WIDGET_FLAGS (wid) & GTK_CAN_DEFAULT) != 0)
 317 #endif
 318
 319 #ifndef GTK_DISABLE_DEPRECATED
 320 /**
 321  * GTK_WIDGET_HAS_DEFAULT:
 322  * @wid: a #GtkWidget.
 323  *
 324  * Evaluates to %TRUE if the widget currently is receiving the default action.
 325  *
 326  * Deprecated: 2.20: Use gtk_widget_has_default() instead.
 327  */
 328 #define GTK_WIDGET_HAS_DEFAULT(wid)       ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_DEFAULT) != 0)
 329 #endif
 330
 331 #ifndef GTK_DISABLE_DEPRECATED
 332 /**
 333  * GTK_WIDGET_HAS_GRAB:
 334  * @wid: a #GtkWidget.
 335  *
 336  * Evaluates to %TRUE if the widget is in the grab_widgets stack, and will be
 337  * the preferred one for receiving events other than ones of cosmetic value.
 338  *
 339  * Deprecated: 2.20: Use gtk_widget_has_grab() instead.
 340  */
 341 #define GTK_WIDGET_HAS_GRAB(wid)          ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_GRAB) != 0)
 342 #endif
 343
 344 #ifndef GTK_DISABLE_DEPRECATED
 345 /**
 346  * GTK_WIDGET_RC_STYLE:
 347  * @wid: a #GtkWidget.
 348  *
 349  * Evaluates to %TRUE if the widget's style has been looked up through the rc
 350  * mechanism.
 351  *
 352  * Deprecated: 2.20: Use gtk_widget_has_rc_style() instead.
 353  */
 354 #define GTK_WIDGET_RC_STYLE(wid)          ((GTK_WIDGET_FLAGS (wid) & GTK_RC_STYLE) != 0)
 355 #endif
 356
 357 #ifndef GTK_DISABLE_DEPRECATED
 358 /**
 359  * GTK_WIDGET_COMPOSITE_CHILD:
 360  * @wid: a #GtkWidget.
 361  *
 362  * Evaluates to %TRUE if the widget is a composite child of its parent.
 363  *
 364  * Deprecated: 2.20: Use the #GtkWidget:composite-child property instead.
 365  */
 366 #define GTK_WIDGET_COMPOSITE_CHILD(wid)   ((GTK_WIDGET_FLAGS (wid) & GTK_COMPOSITE_CHILD) != 0)
 367 #endif
 368
 369 #ifndef GTK_DISABLE_DEPRECATED
 370 /**
 371  * GTK_WIDGET_APP_PAINTABLE:
 372  * @wid: a #GtkWidget.
 373  *
 374  * Evaluates to %TRUE if the #GTK_APP_PAINTABLE flag has been set on the widget.
 375  *
 376  * Deprecated: 2.20: Use gtk_widget_get_app_paintable() instead.
 377  */
 378 #define GTK_WIDGET_APP_PAINTABLE(wid)     ((GTK_WIDGET_FLAGS (wid) & GTK_APP_PAINTABLE) != 0)
 379 #endif
 380
 381 #ifndef GTK_DISABLE_DEPRECATED
 382 /**
 383  * GTK_WIDGET_RECEIVES_DEFAULT:
 384  * @wid: a #GtkWidget.
 385  *
 386  * Evaluates to %TRUE if the widget when focused will receive the default action
 387  * even if there is a different widget set as default.
 388  *
 389  * Deprecated: 2.20: Use gtk_widget_get_receives_default() instead.
 390  */
 391 #define GTK_WIDGET_RECEIVES_DEFAULT(wid)  ((GTK_WIDGET_FLAGS (wid) & GTK_RECEIVES_DEFAULT) != 0)
 392 #endif
 393
 394 #ifndef GTK_DISABLE_DEPRECATED
 395 /**
 396  * GTK_WIDGET_DOUBLE_BUFFERED:
 397  * @wid: a #GtkWidget.
 398  *
 399  * Evaluates to %TRUE if the #GTK_DOUBLE_BUFFERED flag has been set on the widget.
 400  *
 401  * Deprecated: 2.20: Use gtk_widget_get_double_buffered() instead.
 402  */
 403 #define GTK_WIDGET_DOUBLE_BUFFERED(wid)   ((GTK_WIDGET_FLAGS (wid) & GTK_DOUBLE_BUFFERED) != 0)
 404 #endif
 405
 406
 407 /* Macros for setting and clearing widget flags.
 408  */
 409 /**
 410  * GTK_WIDGET_SET_FLAGS:
 411  * @wid: a #GtkWidget.
 412  * @flag: the flags to set.
 413  *
 414  * Turns on certain widget flags.
 415  */
 416 #define GTK_WIDGET_SET_FLAGS(wid,flag)    G_STMT_START{ (GTK_WIDGET_FLAGS (wid) |= (flag)); }G_STMT_END
 417
 418 /**
 419  * GTK_WIDGET_UNSET_FLAGS:
 420  * @wid: a #GtkWidget.
 421  * @flag: the flags to unset.
 422  *
 423  * Turns off certain widget flags.
 424  */
 425 #define GTK_WIDGET_UNSET_FLAGS(wid,flag)  G_STMT_START{ (GTK_WIDGET_FLAGS (wid) &= ~(flag)); }G_STMT_END
 426
 427 #define GTK_TYPE_REQUISITION              (gtk_requisition_get_type ())
 428
 429 /* forward declaration to avoid excessive includes (and concurrent includes)
 430  */
 431 typedef struct _GtkRequisition     GtkRequisition;
 432 typedef struct _GtkSelectionData   GtkSelectionData;
 433 typedef struct _GtkWidgetClass     GtkWidgetClass;
 434 typedef struct _GtkWidgetAuxInfo   GtkWidgetAuxInfo;
 435 typedef struct _GtkWidgetShapeInfo GtkWidgetShapeInfo;
 436 typedef struct _GtkClipboard       GtkClipboard;
 437 typedef struct _GtkTooltip         GtkTooltip;
 438 typedef struct _GtkWindow          GtkWindow;
 439
 440 /**
 441  * GtkAllocation:
 442  * @x: the X position of the widget's area relative to its parents allocation.
 443  * @y: the Y position of the widget's area relative to its parents allocation.
 444  * @width: the width of the widget's allocated area.
 445  * @height: the height of the widget's allocated area.
 446  *
 447  * A <structname>GtkAllocation</structname> of a widget represents region which has been allocated to the
 448  * widget by its parent. It is a subregion of its parents allocation. See
 449  * <xref linkend="size-allocation"/> for more information.
 450  */
 451 typedef         GdkRectangle       GtkAllocation;
 452
 453 /**
 454  * GtkCallback:
 455  * @widget: the widget to operate on
 456  * @data: user-supplied data
 457  *
 458  * The type of the callback functions used for e.g. iterating over
 459  * the children of a container, see gtk_container_foreach().
 460  */
 461 typedef void    (*GtkCallback)     (GtkWidget        *widget,
 462                                     gpointer          data);
 463
 464 /**
 465  * GtkRequisition:
 466  * @width: the widget's desired width
 467  * @height: the widget's desired height
 468  *
 469  * A <structname>GtkRequisition</structname> represents the desired size of a widget. See
 470  * <xref linkend="size-requisition"/> for more information.
 471  */
 472 struct _GtkRequisition
 473 {
 474   gint width;
 475   gint height;
 476 };
 477
 478 /* The widget is the base of the tree for displayable objects.
 479  *  (A displayable object is one which takes up some amount
 480  *  of screen real estate). It provides a common base and interface
 481  *  which actual widgets must adhere to.
 482  */
 483 struct _GtkWidget
 484 {
 485   /* The object structure needs to be the first
 486    *  element in the widget structure in order for
 487    *  the object mechanism to work correctly. This
 488    *  allows a GtkWidget pointer to be cast to a
 489    *  GtkObject pointer.
 490    */
 491   GtkObject object;
 492
 493   /* 16 bits of internally used private flags.
 494    * this will be packed into the same 4 byte alignment frame that
 495    * state and saved_state go. we therefore don't waste any new
 496    * space on this.
 497    */
 498   guint16 GSEAL (private_flags);
 499
 500   /* The state of the widget. There are actually only
 501    *  5 widget states (defined in "gtkenums.h").
 502    */
 503   guint8 GSEAL (state);
 504
 505   /* The saved state of the widget. When a widget's state
 506    *  is changed to GTK_STATE_INSENSITIVE via
 507    *  "gtk_widget_set_state" or "gtk_widget_set_sensitive"
 508    *  the old state is kept around in this field. The state
 509    *  will be restored once the widget gets sensitive again.
 510    */
 511   guint8 GSEAL (saved_state);
 512
 513   /* The widget's name. If the widget does not have a name
 514    *  (the name is NULL), then its name (as returned by
 515    *  "gtk_widget_get_name") is its class's name.
 516    * Among other things, the widget name is used to determine
 517    *  the style to use for a widget.
 518    */
 519   gchar *GSEAL (name);
 520
 521   /*< public >*/
 522
 523   /* The style for the widget. The style contains the
 524    *  colors the widget should be drawn in for each state
 525    *  along with graphics contexts used to draw with and
 526    *  the font to use for text.
 527    */
 528   GtkStyle *GSEAL (style);
 529
 530   /* The widget's desired size.
 531    */
 532   GtkRequisition GSEAL (requisition);
 533
 534   /* The widget's allocated size.
 535    */
 536   GtkAllocation GSEAL (allocation);
 537
 538   /* The widget's window or its parent window if it does
 539    *  not have a window. (Which will be indicated by the
 540    *  GTK_NO_WINDOW flag being set).
 541    */
 542   GdkWindow *GSEAL (window);
 543
 544   /* The widget's parent.
 545    */
 546   GtkWidget *GSEAL (parent);
 547 };
 548
 549 /**
 550  * GtkWidgetClass:
 551  * @parent_class:
 552  * @activate_signal:
 553  * @set_scroll_adjustments_signal:
 554  *
 555  * <structfield>activate_signal</structfield>
 556  * The signal to emit when a widget of this class is activated,
 557  * gtk_widget_activate() handles the emission. Implementation of this
 558  * signal is optional.
 559  *
 560  *
 561  * <structfield>set_scroll_adjustment_signal</structfield>
 562  * This signal is emitted  when a widget of this class is added
 563  * to a scrolling aware parent, gtk_widget_set_scroll_adjustments()
 564  * handles the emission.
 565  * Implementation of this signal is optional.
 566  */
 567 struct _GtkWidgetClass
 568 {
 569   /* The object class structure needs to be the first
 570    *  element in the widget class structure in order for
 571    *  the class mechanism to work correctly. This allows a
 572    *  GtkWidgetClass pointer to be cast to a GtkObjectClass
 573    *  pointer.
 574    */
 575   GtkObjectClass parent_class;
 576
 577   /*< public >*/
 578
 579   guint activate_signal;
 580
 581   guint set_scroll_adjustments_signal;
 582
 583   /*< private >*/
 584
 585   /* seldomly overidden */
 586   void (*dispatch_child_properties_changed) (GtkWidget   *widget,
 587                                              guint        n_pspecs,
 588                                              GParamSpec **pspecs);
 589
 590   /* basics */
 591   void (* show)                (GtkWidget        *widget);
 592   void (* show_all)            (GtkWidget        *widget);
 593   void (* hide)                (GtkWidget        *widget);
 594   void (* hide_all)            (GtkWidget        *widget);
 595   void (* map)                 (GtkWidget        *widget);
 596   void (* unmap)               (GtkWidget        *widget);
 597   void (* realize)             (GtkWidget        *widget);
 598   void (* unrealize)           (GtkWidget        *widget);
 599   void (* size_request)        (GtkWidget        *widget,
 600                                 GtkRequisition   *requisition);
 601   void (* size_allocate)       (GtkWidget        *widget,
 602                                 GtkAllocation    *allocation);
 603   void (* state_changed)       (GtkWidget        *widget,
 604                                 GtkStateType      previous_state);
 605   void (* parent_set)          (GtkWidget        *widget,
 606                                 GtkWidget        *previous_parent);
 607   void (* hierarchy_changed)   (GtkWidget        *widget,
 608                                 GtkWidget        *previous_toplevel);
 609   void (* style_set)           (GtkWidget        *widget,
 610                                 GtkStyle         *previous_style);
 611   void (* direction_changed)   (GtkWidget        *widget,
 612                                 GtkTextDirection  previous_direction);
 613   void (* grab_notify)         (GtkWidget        *widget,
 614                                 gboolean          was_grabbed);
 615   void (* child_notify)        (GtkWidget        *widget,
 616                                 GParamSpec       *pspec);
 617
 618   /* Mnemonics */
 619   gboolean (* mnemonic_activate) (GtkWidget    *widget,
 620                                   gboolean      group_cycling);
 621
 622   /* explicit focus */
 623   void     (* grab_focus)      (GtkWidget        *widget);
 624   gboolean (* focus)           (GtkWidget        *widget,
 625                                 GtkDirectionType  direction);
 626
 627   /* events */
 628   gboolean (* event)                    (GtkWidget           *widget,
 629                                          GdkEvent            *event);
 630   gboolean (* button_press_event)       (GtkWidget           *widget,
 631                                          GdkEventButton      *event);
 632   gboolean (* button_release_event)     (GtkWidget           *widget,
 633                                          GdkEventButton      *event);
 634   gboolean (* scroll_event)             (GtkWidget           *widget,
 635                                          GdkEventScroll      *event);
 636   gboolean (* motion_notify_event)      (GtkWidget           *widget,
 637                                          GdkEventMotion      *event);
 638   gboolean (* delete_event)             (GtkWidget           *widget,
 639                                          GdkEventAny         *event);
 640   gboolean (* destroy_event)            (GtkWidget           *widget,
 641                                          GdkEventAny         *event);
 642   gboolean (* expose_event)             (GtkWidget           *widget,
 643                                          GdkEventExpose      *event);
 644   gboolean (* key_press_event)          (GtkWidget           *widget,
 645                                          GdkEventKey         *event);
 646   gboolean (* key_release_event)        (GtkWidget           *widget,
 647                                          GdkEventKey         *event);
 648   gboolean (* enter_notify_event)       (GtkWidget           *widget,
 649                                          GdkEventCrossing    *event);
 650   gboolean (* leave_notify_event)       (GtkWidget           *widget,
 651                                          GdkEventCrossing    *event);
 652   gboolean (* configure_event)          (GtkWidget           *widget,
 653                                          GdkEventConfigure   *event);
 654   gboolean (* focus_in_event)           (GtkWidget           *widget,
 655                                          GdkEventFocus       *event);
 656   gboolean (* focus_out_event)          (GtkWidget           *widget,
 657                                          GdkEventFocus       *event);
 658   gboolean (* map_event)                (GtkWidget           *widget,
 659                                          GdkEventAny         *event);
 660   gboolean (* unmap_event)              (GtkWidget           *widget,
 661                                          GdkEventAny         *event);
 662   gboolean (* property_notify_event)    (GtkWidget           *widget,
 663                                          GdkEventProperty    *event);
 664   gboolean (* selection_clear_event)    (GtkWidget           *widget,
 665                                          GdkEventSelection   *event);
 666   gboolean (* selection_request_event)  (GtkWidget           *widget,
 667                                          GdkEventSelection   *event);
 668   gboolean (* selection_notify_event)   (GtkWidget           *widget,
 669                                          GdkEventSelection   *event);
 670   gboolean (* proximity_in_event)       (GtkWidget           *widget,
 671                                          GdkEventProximity   *event);
 672   gboolean (* proximity_out_event)      (GtkWidget           *widget,
 673                                          GdkEventProximity   *event);
 674   gboolean (* visibility_notify_event)  (GtkWidget           *widget,
 675                                          GdkEventVisibility  *event);
 676   gboolean (* client_event)             (GtkWidget           *widget,
 677                                          GdkEventClient      *event);
 678   gboolean (* no_expose_event)          (GtkWidget           *widget,
 679                                          GdkEventAny         *event);
 680   gboolean (* window_state_event)       (GtkWidget           *widget,
 681                                          GdkEventWindowState *event);
 682
 683   /* selection */
 684   void (* selection_get)           (GtkWidget          *widget,
 685                                     GtkSelectionData   *selection_data,
 686                                     guint               info,
 687                                     guint               time_);
 688   void (* selection_received)      (GtkWidget          *widget,
 689                                     GtkSelectionData   *selection_data,
 690                                     guint               time_);
 691
 692   /* Source side drag signals */
 693   void (* drag_begin)              (GtkWidget          *widget,
 694                                     GdkDragContext     *context);
 695   void (* drag_end)                (GtkWidget          *widget,
 696                                     GdkDragContext     *context);
 697   void (* drag_data_get)           (GtkWidget          *widget,
 698                                     GdkDragContext     *context,
 699                                     GtkSelectionData   *selection_data,
 700                                     guint               info,
 701                                     guint               time_);
 702   void (* drag_data_delete)        (GtkWidget          *widget,
 703                                     GdkDragContext     *context);
 704
 705   /* Target side drag signals */
 706   void (* drag_leave)              (GtkWidget          *widget,
 707                                     GdkDragContext     *context,
 708                                     guint               time_);
 709   gboolean (* drag_motion)         (GtkWidget          *widget,
 710                                     GdkDragContext     *context,
 711                                     gint                x,
 712                                     gint                y,
 713                                     guint               time_);
 714   gboolean (* drag_drop)           (GtkWidget          *widget,
 715                                     GdkDragContext     *context,
 716                                     gint                x,
 717                                     gint                y,
 718                                     guint               time_);
 719   void (* drag_data_received)      (GtkWidget          *widget,
 720                                     GdkDragContext     *context,
 721                                     gint                x,
 722                                     gint                y,
 723                                     GtkSelectionData   *selection_data,
 724                                     guint               info,
 725                                     guint               time_);
 726
 727   /* Signals used only for keybindings */
 728   gboolean (* popup_menu)          (GtkWidget          *widget);
 729
 730   /* If a widget has multiple tooltips/whatsthis, it should show the
 731    * one for the current focus location, or if that doesn't make
 732    * sense, should cycle through them showing each tip alongside
 733    * whatever piece of the widget it applies to.
 734    */
 735   gboolean (* show_help)           (GtkWidget          *widget,
 736                                     GtkWidgetHelpType   help_type);
 737
 738   /* accessibility support
 739    */
 740   AtkObject*   (*get_accessible)     (GtkWidget *widget);
 741
 742   void         (*screen_changed)     (GtkWidget *widget,
 743                                       GdkScreen *previous_screen);
 744   gboolean     (*can_activate_accel) (GtkWidget *widget,
 745                                       guint      signal_id);
 746
 747   /* Sent when a grab is broken. */
 748   gboolean (*grab_broken_event) (GtkWidget           *widget,
 749                                  GdkEventGrabBroken  *event);
 750
 751   void         (* composited_changed) (GtkWidget *widget);
 752
 753   gboolean     (* query_tooltip)      (GtkWidget  *widget,
 754                                        gint        x,
 755                                        gint        y,
 756                                        gboolean    keyboard_tooltip,
 757                                        GtkTooltip *tooltip);
 758   /* Signals without a C default handler class slot:
 759    * gboolean   (*damage_event) (GtkWidget      *widget,
 760    *                             GdkEventExpose *event);
 761    */
 762
 763   /* Padding for future expansion */
 764   void (*_gtk_reserved5) (void);
 765   void (*_gtk_reserved6) (void);
 766   void (*_gtk_reserved7) (void);
 767 };
 768
 769 struct _GtkWidgetAuxInfo
 770 {
 771   gint x;
 772   gint y;
 773   gint width;
 774   gint height;
 775   guint x_set : 1;
 776   guint y_set : 1;
 777 };
 778
 779 struct _GtkWidgetShapeInfo
 780 {
 781   gint16     offset_x;
 782   gint16     offset_y;
 783   GdkBitmap *shape_mask;
 784 };
 785
 786 GType      gtk_widget_get_type            (void) G_GNUC_CONST;
 787 GtkWidget* gtk_widget_new                 (GType                type,
 788                                            const gchar         *first_property_name,
 789                                            ...);
 790 void       gtk_widget_destroy             (GtkWidget           *widget);
 791 void       gtk_widget_destroyed           (GtkWidget           *widget,
 792                                            GtkWidget          **widget_pointer);
 793 #ifndef GTK_DISABLE_DEPRECATED
 794 GtkWidget* gtk_widget_ref                 (GtkWidget           *widget);
 795 void       gtk_widget_unref               (GtkWidget           *widget);
 796 void       gtk_widget_set                 (GtkWidget           *widget,
 797                                            const gchar         *first_property_name,
 798                                            ...) G_GNUC_NULL_TERMINATED;
 799 #endif /* GTK_DISABLE_DEPRECATED */
 800 void       gtk_widget_unparent            (GtkWidget           *widget);
 801 void       gtk_widget_show                (GtkWidget           *widget);
 802 void       gtk_widget_show_now            (GtkWidget           *widget);
 803 void       gtk_widget_hide                (GtkWidget           *widget);
 804 void       gtk_widget_show_all            (GtkWidget           *widget);
 805 void       gtk_widget_hide_all            (GtkWidget           *widget);
 806 void       gtk_widget_set_no_show_all     (GtkWidget           *widget,
 807                                            gboolean             no_show_all);
 808 gboolean   gtk_widget_get_no_show_all     (GtkWidget           *widget);
 809 void       gtk_widget_map                 (GtkWidget           *widget);
 810 void       gtk_widget_unmap               (GtkWidget           *widget);
 811 void       gtk_widget_realize             (GtkWidget           *widget);
 812 void       gtk_widget_unrealize           (GtkWidget           *widget);
 813
 814 /* Queuing draws */
 815 void       gtk_widget_queue_draw          (GtkWidget           *widget);
 816 void       gtk_widget_queue_draw_area     (GtkWidget           *widget,
 817                                            gint                 x,
 818                                            gint                 y,
 819                                            gint                 width,
 820                                            gint                 height);
 821 #ifndef GTK_DISABLE_DEPRECATED
 822 void       gtk_widget_queue_clear         (GtkWidget           *widget);
 823 void       gtk_widget_queue_clear_area    (GtkWidget           *widget,
 824                                            gint                 x,
 825                                            gint                 y,
 826                                            gint                 width,
 827                                            gint                 height);
 828 #endif /* GTK_DISABLE_DEPRECATED */
 829
 830
 831 void       gtk_widget_queue_resize        (GtkWidget           *widget);
 832 void       gtk_widget_queue_resize_no_redraw (GtkWidget *widget);
 833 #ifndef GTK_DISABLE_DEPRECATED
 834 void       gtk_widget_draw                (GtkWidget           *widget,
 835                                            const GdkRectangle  *area);
 836 #endif /* GTK_DISABLE_DEPRECATED */
 837 void       gtk_widget_size_request        (GtkWidget           *widget,
 838                                            GtkRequisition      *requisition);
 839 void       gtk_widget_size_allocate       (GtkWidget           *widget,
 840                                            GtkAllocation       *allocation);
 841 void       gtk_widget_get_child_requisition (GtkWidget         *widget,
 842                                              GtkRequisition    *requisition);
 843 void       gtk_widget_add_accelerator     (GtkWidget           *widget,
 844                                            const gchar         *accel_signal,
 845                                            GtkAccelGroup       *accel_group,
 846                                            guint                accel_key,
 847                                            GdkModifierType      accel_mods,
 848                                            GtkAccelFlags        accel_flags);
 849 gboolean   gtk_widget_remove_accelerator  (GtkWidget           *widget,
 850                                            GtkAccelGroup       *accel_group,
 851                                            guint                accel_key,
 852                                            GdkModifierType      accel_mods);
 853 void       gtk_widget_set_accel_path      (GtkWidget           *widget,
 854                                            const gchar         *accel_path,
 855                                            GtkAccelGroup       *accel_group);
 856 const gchar* _gtk_widget_get_accel_path   (GtkWidget           *widget,
 857                                            gboolean            *locked);
 858 GList*     gtk_widget_list_accel_closures (GtkWidget           *widget);
 859 gboolean   gtk_widget_can_activate_accel  (GtkWidget           *widget,
 860                                            guint                signal_id);
 861 gboolean   gtk_widget_mnemonic_activate   (GtkWidget           *widget,
 862                                            gboolean             group_cycling);
 863 gboolean   gtk_widget_event               (GtkWidget           *widget,
 864                                            GdkEvent            *event);
 865 gint       gtk_widget_send_expose         (GtkWidget           *widget,
 866                                            GdkEvent            *event);
 867
 868 gboolean   gtk_widget_activate               (GtkWidget        *widget);
 869 gboolean   gtk_widget_set_scroll_adjustments (GtkWidget        *widget,
 870                                               GtkAdjustment    *hadjustment,
 871                                               GtkAdjustment    *vadjustment);
 872
 873 void       gtk_widget_reparent            (GtkWidget           *widget,
 874                                            GtkWidget           *new_parent);
 875 gboolean   gtk_widget_intersect           (GtkWidget           *widget,
 876                                            const GdkRectangle  *area,
 877                                            GdkRectangle        *intersection);
 878 GdkRegion *gtk_widget_region_intersect    (GtkWidget           *widget,
 879                                            const GdkRegion     *region);
 880
 881 void    gtk_widget_freeze_child_notify    (GtkWidget           *widget);
 882 void    gtk_widget_child_notify           (GtkWidget           *widget,
 883                                            const gchar         *child_property);
 884 void    gtk_widget_thaw_child_notify      (GtkWidget           *widget);
 885
 886 void       gtk_widget_set_can_focus       (GtkWidget           *widget,
 887                                            gboolean             can_focus);
 888 gboolean   gtk_widget_get_can_focus       (GtkWidget           *widget);
 889 gboolean   gtk_widget_has_focus           (GtkWidget           *widget);
 890 gboolean   gtk_widget_is_focus            (GtkWidget           *widget);
 891 void       gtk_widget_grab_focus          (GtkWidget           *widget);
 892
 893 void       gtk_widget_set_can_default     (GtkWidget           *widget,
 894                                            gboolean             can_default);
 895 gboolean   gtk_widget_get_can_default     (GtkWidget           *widget);
 896 gboolean   gtk_widget_has_default         (GtkWidget           *widget);
 897 void       gtk_widget_grab_default        (GtkWidget           *widget);
 898
 899 void      gtk_widget_set_receives_default (GtkWidget           *widget,
 900                                            gboolean             receives_default);
 901 gboolean  gtk_widget_get_receives_default (GtkWidget           *widget);
 902
 903 gboolean   gtk_widget_has_grab            (GtkWidget           *widget);
 904
 905 void                  gtk_widget_set_name               (GtkWidget    *widget,
 906                                                          const gchar  *name);
 907 G_CONST_RETURN gchar* gtk_widget_get_name               (GtkWidget    *widget);
 908
 909 void                  gtk_widget_set_state              (GtkWidget    *widget,
 910                                                          GtkStateType  state);
 911 GtkStateType          gtk_widget_get_state              (GtkWidget    *widget);
 912
 913 void                  gtk_widget_set_sensitive          (GtkWidget    *widget,
 914                                                          gboolean      sensitive);
 915 gboolean              gtk_widget_get_sensitive          (GtkWidget    *widget);
 916 gboolean              gtk_widget_is_sensitive           (GtkWidget    *widget);
 917
 918 void                  gtk_widget_set_visible            (GtkWidget    *widget,
 919                                                          gboolean      visible);
 920 gboolean              gtk_widget_get_visible            (GtkWidget    *widget);
 921
 922 void                  gtk_widget_set_has_window         (GtkWidget    *widget,
 923                                                          gboolean      has_window);
 924 gboolean              gtk_widget_get_has_window         (GtkWidget    *widget);
 925
 926 gboolean              gtk_widget_is_toplevel            (GtkWidget    *widget);
 927 gboolean              gtk_widget_is_drawable            (GtkWidget    *widget);
 928 void                  gtk_widget_set_realized           (GtkWidget    *widget,
 929                                                          gboolean      realized);
 930 gboolean              gtk_widget_get_realized           (GtkWidget    *widget);
 931 void                  gtk_widget_set_mapped             (GtkWidget    *widget,
 932                                                          gboolean      mapped);
 933 gboolean              gtk_widget_get_mapped             (GtkWidget    *widget);
 934
 935 void                  gtk_widget_set_app_paintable      (GtkWidget    *widget,
 936                                                          gboolean      app_paintable);
 937 gboolean              gtk_widget_get_app_paintable      (GtkWidget    *widget);
 938
 939 void                  gtk_widget_set_double_buffered    (GtkWidget    *widget,
 940                                                          gboolean      double_buffered);
 941 gboolean              gtk_widget_get_double_buffered    (GtkWidget    *widget);
 942
 943 void                  gtk_widget_set_redraw_on_allocate (GtkWidget    *widget,
 944                                                          gboolean      redraw_on_allocate);
 945
 946 void                  gtk_widget_set_parent             (GtkWidget    *widget,
 947                                                          GtkWidget    *parent);
 948 GtkWidget           * gtk_widget_get_parent             (GtkWidget    *widget);
 949
 950 void                  gtk_widget_set_parent_window      (GtkWidget    *widget,
 951                                                          GdkWindow    *parent_window);
 952 GdkWindow           * gtk_widget_get_parent_window      (GtkWidget    *widget);
 953
 954 void                  gtk_widget_set_child_visible      (GtkWidget    *widget,
 955                                                          gboolean      is_visible);
 956 gboolean              gtk_widget_get_child_visible      (GtkWidget    *widget);
 957
 958 void                  gtk_widget_set_window             (GtkWidget    *widget,
 959                                                          GdkWindow    *window);
 960 GdkWindow           * gtk_widget_get_window             (GtkWidget    *widget);
 961
 962 void                  gtk_widget_get_allocation         (GtkWidget     *widget,
 963                                                          GtkAllocation *allocation);
 964 void                  gtk_widget_set_allocation         (GtkWidget     *widget,
 965                                                          const GtkAllocation *allocation);
 966
 967 void                  gtk_widget_get_requisition        (GtkWidget     *widget,
 968                                                          GtkRequisition *requisition);
 969
 970 gboolean   gtk_widget_child_focus         (GtkWidget           *widget,
 971                                            GtkDirectionType     direction);
 972 gboolean   gtk_widget_keynav_failed       (GtkWidget           *widget,
 973                                            GtkDirectionType     direction);
 974 void       gtk_widget_error_bell          (GtkWidget           *widget);
 975
 976 void       gtk_widget_set_size_request    (GtkWidget           *widget,
 977                                            gint                 width,
 978                                            gint                 height);
 979 void       gtk_widget_get_size_request    (GtkWidget           *widget,
 980                                            gint                *width,
 981                                            gint                *height);
 982 #ifndef GTK_DISABLE_DEPRECATED
 983 void       gtk_widget_set_uposition       (GtkWidget           *widget,
 984                                            gint                 x,
 985                                            gint                 y);
 986 void       gtk_widget_set_usize           (GtkWidget           *widget,
 987                                            gint                 width,
 988                                            gint                 height);
 989 #endif
 990
 991 void       gtk_widget_set_events          (GtkWidget           *widget,
 992                                            gint                 events);
 993 void       gtk_widget_add_events          (GtkWidget           *widget,
 994                                            gint                 events);
 995 void       gtk_widget_set_extension_events (GtkWidget           *widget,
 996                                             GdkExtensionMode    mode);
 997
 998 GdkExtensionMode gtk_widget_get_extension_events (GtkWidget     *widget);
 999 GtkWidget*   gtk_widget_get_toplevel    (GtkWidget      *widget);
1000 GtkWidget*   gtk_widget_get_ancestor    (GtkWidget      *widget,
1001                                          GType           widget_type);
1002 GdkColormap* gtk_widget_get_colormap    (GtkWidget      *widget);
1003 GdkVisual*   gtk_widget_get_visual      (GtkWidget      *widget);
1004
1005 GdkScreen *   gtk_widget_get_screen      (GtkWidget *widget);
1006 gboolean      gtk_widget_has_screen      (GtkWidget *widget);
1007 GdkDisplay *  gtk_widget_get_display     (GtkWidget *widget);
1008 GdkWindow *   gtk_widget_get_root_window (GtkWidget *widget);
1009 GtkSettings*  gtk_widget_get_settings    (GtkWidget *widget);
1010 GtkClipboard *gtk_widget_get_clipboard   (GtkWidget *widget,
1011                                           GdkAtom    selection);
1012 GdkPixmap *   gtk_widget_get_snapshot    (GtkWidget    *widget,
1013                                           GdkRectangle *clip_rect);
1014
1015 #ifndef GTK_DISABLE_DEPRECATED
1016
1017 /**
1018  * gtk_widget_set_visual:
1019  * @widget: a #GtkWidget
1020  * @visual: a visual
1021  *
1022  * This function is deprecated; it does nothing.
1023  */
1024 #define gtk_widget_set_visual(widget,visual)  ((void) 0)
1025
1026 /**
1027  * gtk_widget_push_visual:
1028  * @visual: a visual
1029  *
1030  * This function is deprecated; it does nothing.
1031  */
1032 #define gtk_widget_push_visual(visual)        ((void) 0)
1033
1034 /**
1035  * gtk_widget_pop_visual:
1036  *
1037  * This function is deprecated; it does nothing.
1038  */
1039 #define gtk_widget_pop_visual()               ((void) 0)
1040
1041 /**
1042  * gtk_widget_set_default_visual:
1043  * @visual: a visual
1044  *
1045  * This function is deprecated; it does nothing.
1046  */
1047 #define gtk_widget_set_default_visual(visual) ((void) 0)
1048
1049 #endif /* GTK_DISABLE_DEPRECATED */
1050
1051 /* Accessibility support */
1052 AtkObject*       gtk_widget_get_accessible               (GtkWidget          *widget);
1053
1054 /* The following functions must not be called on an already
1055  * realized widget. Because it is possible that somebody
1056  * can call get_colormap() or get_visual() and save the
1057  * result, these functions are probably only safe to
1058  * call in a widget's init() function.
1059  */
1060 void         gtk_widget_set_colormap    (GtkWidget      *widget,
1061                                          GdkColormap    *colormap);
1062
1063 gint         gtk_widget_get_events      (GtkWidget      *widget);
1064 void         gtk_widget_get_pointer     (GtkWidget      *widget,
1065                                          gint           *x,
1066                                          gint           *y);
1067
1068 gboolean     gtk_widget_is_ancestor     (GtkWidget      *widget,
1069                                          GtkWidget      *ancestor);
1070
1071 gboolean     gtk_widget_translate_coordinates (GtkWidget  *src_widget,
1072                                                GtkWidget  *dest_widget,
1073                                                gint        src_x,
1074                                                gint        src_y,
1075                                                gint       *dest_x,
1076                                                gint       *dest_y);
1077
1078 /* Hide widget and return TRUE.
1079  */
1080 gboolean     gtk_widget_hide_on_delete  (GtkWidget      *widget);
1081
1082 /* Widget styles.
1083  */
1084 void        gtk_widget_style_attach       (GtkWidget            *style);
1085
1086 gboolean    gtk_widget_has_rc_style       (GtkWidget            *widget);
1087 void        gtk_widget_set_style          (GtkWidget            *widget,
1088                                            GtkStyle             *style);
1089 void        gtk_widget_ensure_style       (GtkWidget            *widget);
1090 GtkStyle *  gtk_widget_get_style          (GtkWidget            *widget);
1091
1092 void        gtk_widget_modify_style       (GtkWidget            *widget,
1093                                            GtkRcStyle           *style);
1094 GtkRcStyle *gtk_widget_get_modifier_style (GtkWidget            *widget);
1095 void        gtk_widget_modify_fg          (GtkWidget            *widget,
1096                                            GtkStateType          state,
1097                                            const GdkColor       *color);
1098 void        gtk_widget_modify_bg          (GtkWidget            *widget,
1099                                            GtkStateType          state,
1100                                            const GdkColor       *color);
1101 void        gtk_widget_modify_text        (GtkWidget            *widget,
1102                                            GtkStateType          state,
1103                                            const GdkColor       *color);
1104 void        gtk_widget_modify_base        (GtkWidget            *widget,
1105                                            GtkStateType          state,
1106                                            const GdkColor       *color);
1107 void        gtk_widget_modify_cursor      (GtkWidget            *widget,
1108                                            const GdkColor       *primary,
1109                                            const GdkColor       *secondary);
1110 void        gtk_widget_modify_font        (GtkWidget            *widget,
1111                                            PangoFontDescription *font_desc);
1112
1113 #ifndef GTK_DISABLE_DEPRECATED
1114
1115 /**
1116  * gtk_widget_set_rc_style:
1117  * @widget: a #GtkWidget.
1118  *
1119  * Equivalent to <literal>gtk_widget_set_style (widget, NULL)</literal>.
1120  *
1121  * Deprecated: 2.0: Use gtk_widget_set_style() with a %NULL @style argument instead.
1122  */
1123 #define gtk_widget_set_rc_style(widget)          (gtk_widget_set_style (widget, NULL))
1124
1125 /**
1126  * gtk_widget_restore_default_style:
1127  * @widget: a #GtkWidget.
1128  *
1129  * Equivalent to <literal>gtk_widget_set_style (widget, NULL)</literal>.
1130  *
1131  * Deprecated: 2.0: Use gtk_widget_set_style() with a %NULL @style argument instead.
1132  */
1133 #define gtk_widget_restore_default_style(widget) (gtk_widget_set_style (widget, NULL))
1134 #endif
1135
1136 PangoContext *gtk_widget_create_pango_context (GtkWidget   *widget);
1137 PangoContext *gtk_widget_get_pango_context    (GtkWidget   *widget);
1138 PangoLayout  *gtk_widget_create_pango_layout  (GtkWidget   *widget,
1139                                                const gchar *text);
1140
1141 GdkPixbuf    *gtk_widget_render_icon          (GtkWidget   *widget,
1142                                                const gchar *stock_id,
1143                                                GtkIconSize  size,
1144                                                const gchar *detail);
1145
1146 /* handle composite names for GTK_COMPOSITE_CHILD widgets,
1147  * the returned name is newly allocated.
1148  */
1149 void   gtk_widget_set_composite_name    (GtkWidget      *widget,
1150                                          const gchar    *name);
1151 gchar* gtk_widget_get_composite_name    (GtkWidget      *widget);
1152
1153 /* Descend recursively and set rc-style on all widgets without user styles */
1154 void       gtk_widget_reset_rc_styles   (GtkWidget      *widget);
1155
1156 /* Push/pop pairs, to change default values upon a widget's creation.
1157  * This will override the values that got set by the
1158  * gtk_widget_set_default_* () functions.
1159  */
1160 void         gtk_widget_push_colormap        (GdkColormap *cmap);
1161 void         gtk_widget_push_composite_child (void);
1162 void         gtk_widget_pop_composite_child  (void);
1163 void         gtk_widget_pop_colormap         (void);
1164
1165 /* widget style properties
1166  */
1167 void gtk_widget_class_install_style_property        (GtkWidgetClass     *klass,
1168                                                      GParamSpec         *pspec);
1169 void gtk_widget_class_install_style_property_parser (GtkWidgetClass     *klass,
1170                                                      GParamSpec         *pspec,
1171                                                      GtkRcPropertyParser parser);
1172 GParamSpec*  gtk_widget_class_find_style_property   (GtkWidgetClass     *klass,
1173                                                      const gchar        *property_name);
1174 GParamSpec** gtk_widget_class_list_style_properties (GtkWidgetClass     *klass,
1175                                                      guint              *n_properties);
1176 void gtk_widget_style_get_property (GtkWidget        *widget,
1177                                     const gchar    *property_name,
1178                                     GValue           *value);
1179 void gtk_widget_style_get_valist   (GtkWidget        *widget,
1180                                     const gchar    *first_property_name,
1181                                     va_list         var_args);
1182 void gtk_widget_style_get          (GtkWidget        *widget,
1183                                     const gchar    *first_property_name,
1184                                     ...) G_GNUC_NULL_TERMINATED;
1185
1186
1187 /* Set certain default values to be used at widget creation time.
1188  */
1189 void         gtk_widget_set_default_colormap (GdkColormap *colormap);
1190 GtkStyle*    gtk_widget_get_default_style    (void);
1191 #ifndef GDK_MULTIHEAD_SAFE
1192 GdkColormap* gtk_widget_get_default_colormap (void);
1193 GdkVisual*   gtk_widget_get_default_visual   (void);
1194 #endif
1195
1196 /* Functions for setting directionality for widgets
1197  */
1198
1199 void             gtk_widget_set_direction         (GtkWidget        *widget,
1200                                                    GtkTextDirection  dir);
1201 GtkTextDirection gtk_widget_get_direction         (GtkWidget        *widget);
1202
1203 void             gtk_widget_set_default_direction (GtkTextDirection  dir);
1204 GtkTextDirection gtk_widget_get_default_direction (void);
1205
1206 /* Compositing manager functionality */
1207 gboolean gtk_widget_is_composited (GtkWidget *widget);
1208
1209 /* Counterpart to gdk_window_shape_combine_mask.
1210  */
1211 void         gtk_widget_shape_combine_mask (GtkWidget *widget,
1212                                             GdkBitmap *shape_mask,
1213                                             gint       offset_x,
1214                                             gint       offset_y);
1215 void         gtk_widget_input_shape_combine_mask (GtkWidget *widget,
1216                                                   GdkBitmap *shape_mask,
1217                                                   gint       offset_x,
1218                                                   gint       offset_y);
1219
1220 /* internal function */
1221 void         gtk_widget_reset_shapes       (GtkWidget *widget);
1222
1223 /* Compute a widget's path in the form "GtkWindow.MyLabel", and
1224  * return newly alocated strings.
1225  */
1226 void         gtk_widget_path               (GtkWidget *widget,
1227                                             guint     *path_length,
1228                                             gchar    **path,
1229                                             gchar    **path_reversed);
1230 void         gtk_widget_class_path         (GtkWidget *widget,
1231                                             guint     *path_length,
1232                                             gchar    **path,
1233                                             gchar    **path_reversed);
1234
1235 GList* gtk_widget_list_mnemonic_labels  (GtkWidget *widget);
1236 void   gtk_widget_add_mnemonic_label    (GtkWidget *widget,
1237                                          GtkWidget *label);
1238 void   gtk_widget_remove_mnemonic_label (GtkWidget *widget,
1239                                          GtkWidget *label);
1240
1241 void                  gtk_widget_set_tooltip_window    (GtkWidget   *widget,
1242                                                         GtkWindow   *custom_window);
1243 GtkWindow *gtk_widget_get_tooltip_window    (GtkWidget   *widget);
1244 void       gtk_widget_trigger_tooltip_query (GtkWidget   *widget);
1245 void       gtk_widget_set_tooltip_text      (GtkWidget   *widget,
1246                                              const gchar *text);
1247 gchar *    gtk_widget_get_tooltip_text      (GtkWidget   *widget);
1248 void       gtk_widget_set_tooltip_markup    (GtkWidget   *widget,
1249                                              const gchar *markup);
1250 gchar *    gtk_widget_get_tooltip_markup    (GtkWidget   *widget);
1251 void       gtk_widget_set_has_tooltip       (GtkWidget   *widget,
1252                                              gboolean     has_tooltip);
1253 gboolean   gtk_widget_get_has_tooltip       (GtkWidget   *widget);
1254
1255 GType           gtk_requisition_get_type (void) G_GNUC_CONST;
1256 GtkRequisition *gtk_requisition_copy     (const GtkRequisition *requisition);
1257 void            gtk_requisition_free     (GtkRequisition       *requisition);
1258
1259 #if     defined (GTK_TRACE_OBJECTS) && defined (__GNUC__)
1260 #  define gtk_widget_ref g_object_ref
1261 #  define gtk_widget_unref g_object_unref
1262 #endif  /* GTK_TRACE_OBJECTS && __GNUC__ */
1263
1264 void              _gtk_widget_grab_notify                 (GtkWidget    *widget,
1265                                                            gboolean     was_grabbed);
1266
1267 GtkWidgetAuxInfo *_gtk_widget_get_aux_info                (GtkWidget    *widget,
1268                                                            gboolean      create);
1269 void              _gtk_widget_propagate_hierarchy_changed (GtkWidget    *widget,
1270                                                            GtkWidget    *previous_toplevel);
1271 void              _gtk_widget_propagate_screen_changed    (GtkWidget    *widget,
1272                                                            GdkScreen    *previous_screen);
1273 void              _gtk_widget_propagate_composited_changed (GtkWidget    *widget);
1274
1275 void       _gtk_widget_set_pointer_window  (GtkWidget      *widget,
1276                                             GdkWindow      *pointer_window);
1277 GdkWindow *_gtk_widget_get_pointer_window  (GtkWidget      *widget);
1278 gboolean   _gtk_widget_is_pointer_widget   (GtkWidget      *widget);
1279 void       _gtk_widget_synthesize_crossing (GtkWidget      *from,
1280                                             GtkWidget      *to,
1281                                             GdkCrossingMode mode);
1282
1283 GdkColormap* _gtk_widget_peek_colormap (void);
1284
1285 void         _gtk_widget_buildable_finish_accelerator (GtkWidget *widget,
1286                                                        GtkWidget *toplevel,
1287                                                        gpointer   user_data);
1288
1289 G_END_DECLS
1290
1291 #endif /* __GTK_WIDGET_H__ */