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