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