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 /* Size of the width-for-height/height-for-width caches */
 463 #define GTK_N_CACHED_SIZES 3
 464
 465 /* forward declaration to avoid excessive includes (and concurrent includes)
 466  */
 467 typedef struct _GtkRequisition     GtkRequisition;
 468 typedef struct _GtkSelectionData   GtkSelectionData;
 469 typedef struct _GtkWidgetClass     GtkWidgetClass;
 470 typedef struct _GtkWidgetAuxInfo   GtkWidgetAuxInfo;
 471 typedef struct _GtkDesiredSize     GtkDesiredSize;
 472 typedef struct _GtkWidgetShapeInfo GtkWidgetShapeInfo;
 473 typedef struct _GtkClipboard       GtkClipboard;
 474 typedef struct _GtkTooltip         GtkTooltip;
 475 typedef struct _GtkWindow          GtkWindow;
 476
 477
 478 /**
 479  * GtkAllocation:
 480  * @x: the X position of the widget's area relative to its parents allocation.
 481  * @y: the Y position of the widget's area relative to its parents allocation.
 482  * @width: the width of the widget's allocated area.
 483  * @height: the height of the widget's allocated area.
 484  *
 485  * A <structname>GtkAllocation</structname> of a widget represents region which has been allocated to the
 486  * widget by its parent. It is a subregion of its parents allocation. See
 487  * <xref linkend="size-allocation"/> for more information.
 488  */
 489 typedef         GdkRectangle       GtkAllocation;
 490
 491 /**
 492  * GtkCallback:
 493  * @widget: the widget to operate on
 494  * @data: user-supplied data
 495  *
 496  * The type of the callback functions used for e.g. iterating over
 497  * the children of a container, see gtk_container_foreach().
 498  */
 499 typedef void    (*GtkCallback)     (GtkWidget        *widget,
 500                                     gpointer          data);
 501
 502 /**
 503  * GtkRequisition:
 504  * @width: the widget's desired width
 505  * @height: the widget's desired height
 506  *
 507  * A <structname>GtkRequisition</structname> represents the desired size of a widget. See
 508  * <xref linkend="size-requisition"/> for more information.
 509  */
 510 struct _GtkRequisition
 511 {
 512   gint width;
 513   gint height;
 514 };
 515
 516 /* The widget is the base of the tree for displayable objects.
 517  *  (A displayable object is one which takes up some amount
 518  *  of screen real estate). It provides a common base and interface
 519  *  which actual widgets must adhere to.
 520  */
 521 struct _GtkWidget
 522 {
 523   /* The object structure needs to be the first
 524    *  element in the widget structure in order for
 525    *  the object mechanism to work correctly. This
 526    *  allows a GtkWidget pointer to be cast to a
 527    *  GtkObject pointer.
 528    */
 529   GtkObject object;
 530
 531   /* 16 bits of internally used private flags.
 532    * this will be packed into the same 4 byte alignment frame that
 533    * state and saved_state go. we therefore don't waste any new
 534    * space on this.
 535    */
 536   guint16 GSEAL (private_flags);
 537
 538   /* The state of the widget. There are actually only
 539    *  5 widget states (defined in "gtkenums.h").
 540    */
 541   guint8 GSEAL (state);
 542
 543   /* The saved state of the widget. When a widget's state
 544    *  is changed to GTK_STATE_INSENSITIVE via
 545    *  "gtk_widget_set_state" or "gtk_widget_set_sensitive"
 546    *  the old state is kept around in this field. The state
 547    *  will be restored once the widget gets sensitive again.
 548    */
 549   guint8 GSEAL (saved_state);
 550
 551   /* The widget's name. If the widget does not have a name
 552    *  (the name is NULL), then its name (as returned by
 553    *  "gtk_widget_get_name") is its class's name.
 554    * Among other things, the widget name is used to determine
 555    *  the style to use for a widget.
 556    */
 557   gchar *GSEAL (name);
 558
 559   /*< public >*/
 560
 561   /* The style for the widget. The style contains the
 562    *  colors the widget should be drawn in for each state
 563    *  along with graphics contexts used to draw with and
 564    *  the font to use for text.
 565    */
 566   GtkStyle *GSEAL (style);
 567
 568   /* The widget's desired size.
 569    */
 570   GtkRequisition GSEAL (requisition);
 571
 572   /* The widget's allocated size.
 573    */
 574   GtkAllocation GSEAL (allocation);
 575
 576   /* The widget's window or its parent window if it does
 577    *  not have a window. (Which will be indicated by the
 578    *  GTK_NO_WINDOW flag being set).
 579    */
 580   GdkWindow *GSEAL (window);
 581
 582   /* The widget's parent.
 583    */
 584   GtkWidget *GSEAL (parent);
 585 };
 586
 587 /**
 588  * GtkWidgetClass:
 589  * @parent_class:
 590  * @activate_signal:
 591  * @set_scroll_adjustments_signal:
 592  *
 593  * <structfield>activate_signal</structfield>
 594  * The signal to emit when a widget of this class is activated,
 595  * gtk_widget_activate() handles the emission. Implementation of this
 596  * signal is optional.
 597  *
 598  *
 599  * <structfield>set_scroll_adjustment_signal</structfield>
 600  * This signal is emitted  when a widget of this class is added
 601  * to a scrolling aware parent, gtk_widget_set_scroll_adjustments()
 602  * handles the emission.
 603  * Implementation of this signal is optional.
 604  */
 605 struct _GtkWidgetClass
 606 {
 607   /* The object class structure needs to be the first
 608    *  element in the widget class structure in order for
 609    *  the class mechanism to work correctly. This allows a
 610    *  GtkWidgetClass pointer to be cast to a GtkObjectClass
 611    *  pointer.
 612    */
 613   GtkObjectClass parent_class;
 614
 615   /*< public >*/
 616
 617   guint activate_signal;
 618
 619   guint set_scroll_adjustments_signal;
 620
 621   /*< private >*/
 622
 623   /* seldomly overidden */
 624   void (*dispatch_child_properties_changed) (GtkWidget   *widget,
 625                                              guint        n_pspecs,
 626                                              GParamSpec **pspecs);
 627
 628   /* basics */
 629   void (* show)                (GtkWidget        *widget);
 630   void (* show_all)            (GtkWidget        *widget);
 631   void (* hide)                (GtkWidget        *widget);
 632   void (* hide_all)            (GtkWidget        *widget);
 633   void (* map)                 (GtkWidget        *widget);
 634   void (* unmap)               (GtkWidget        *widget);
 635   void (* realize)             (GtkWidget        *widget);
 636   void (* unrealize)           (GtkWidget        *widget);
 637   void (* size_request)        (GtkWidget        *widget,
 638                                 GtkRequisition   *requisition);
 639   void (* size_allocate)       (GtkWidget        *widget,
 640                                 GtkAllocation    *allocation);
 641   void (* state_changed)       (GtkWidget        *widget,
 642                                 GtkStateType      previous_state);
 643   void (* parent_set)          (GtkWidget        *widget,
 644                                 GtkWidget        *previous_parent);
 645   void (* hierarchy_changed)   (GtkWidget        *widget,
 646                                 GtkWidget        *previous_toplevel);
 647   void (* style_set)           (GtkWidget        *widget,
 648                                 GtkStyle         *previous_style);
 649   void (* direction_changed)   (GtkWidget        *widget,
 650                                 GtkTextDirection  previous_direction);
 651   void (* grab_notify)         (GtkWidget        *widget,
 652                                 gboolean          was_grabbed);
 653   void (* child_notify)        (GtkWidget        *widget,
 654                                 GParamSpec       *pspec);
 655
 656   /* Mnemonics */
 657   gboolean (* mnemonic_activate) (GtkWidget    *widget,
 658                                   gboolean      group_cycling);
 659
 660   /* explicit focus */
 661   void     (* grab_focus)      (GtkWidget        *widget);
 662   gboolean (* focus)           (GtkWidget        *widget,
 663                                 GtkDirectionType  direction);
 664
 665   /* events */
 666   gboolean (* event)                    (GtkWidget           *widget,
 667                                          GdkEvent            *event);
 668   gboolean (* button_press_event)       (GtkWidget           *widget,
 669                                          GdkEventButton      *event);
 670   gboolean (* button_release_event)     (GtkWidget           *widget,
 671                                          GdkEventButton      *event);
 672   gboolean (* scroll_event)             (GtkWidget           *widget,
 673                                          GdkEventScroll      *event);
 674   gboolean (* motion_notify_event)      (GtkWidget           *widget,
 675                                          GdkEventMotion      *event);
 676   gboolean (* delete_event)             (GtkWidget           *widget,
 677                                          GdkEventAny         *event);
 678   gboolean (* destroy_event)            (GtkWidget           *widget,
 679                                          GdkEventAny         *event);
 680   gboolean (* expose_event)             (GtkWidget           *widget,
 681                                          GdkEventExpose      *event);
 682   gboolean (* key_press_event)          (GtkWidget           *widget,
 683                                          GdkEventKey         *event);
 684   gboolean (* key_release_event)        (GtkWidget           *widget,
 685                                          GdkEventKey         *event);
 686   gboolean (* enter_notify_event)       (GtkWidget           *widget,
 687                                          GdkEventCrossing    *event);
 688   gboolean (* leave_notify_event)       (GtkWidget           *widget,
 689                                          GdkEventCrossing    *event);
 690   gboolean (* configure_event)          (GtkWidget           *widget,
 691                                          GdkEventConfigure   *event);
 692   gboolean (* focus_in_event)           (GtkWidget           *widget,
 693                                          GdkEventFocus       *event);
 694   gboolean (* focus_out_event)          (GtkWidget           *widget,
 695                                          GdkEventFocus       *event);
 696   gboolean (* map_event)                (GtkWidget           *widget,
 697                                          GdkEventAny         *event);
 698   gboolean (* unmap_event)              (GtkWidget           *widget,
 699                                          GdkEventAny         *event);
 700   gboolean (* property_notify_event)    (GtkWidget           *widget,
 701                                          GdkEventProperty    *event);
 702   gboolean (* selection_clear_event)    (GtkWidget           *widget,
 703                                          GdkEventSelection   *event);
 704   gboolean (* selection_request_event)  (GtkWidget           *widget,
 705                                          GdkEventSelection   *event);
 706   gboolean (* selection_notify_event)   (GtkWidget           *widget,
 707                                          GdkEventSelection   *event);
 708   gboolean (* proximity_in_event)       (GtkWidget           *widget,
 709                                          GdkEventProximity   *event);
 710   gboolean (* proximity_out_event)      (GtkWidget           *widget,
 711                                          GdkEventProximity   *event);
 712   gboolean (* visibility_notify_event)  (GtkWidget           *widget,
 713                                          GdkEventVisibility  *event);
 714   gboolean (* client_event)             (GtkWidget           *widget,
 715                                          GdkEventClient      *event);
 716   gboolean (* no_expose_event)          (GtkWidget           *widget,
 717                                          GdkEventAny         *event);
 718   gboolean (* window_state_event)       (GtkWidget           *widget,
 719                                          GdkEventWindowState *event);
 720
 721   /* selection */
 722   void (* selection_get)           (GtkWidget          *widget,
 723                                     GtkSelectionData   *selection_data,
 724                                     guint               info,
 725                                     guint               time_);
 726   void (* selection_received)      (GtkWidget          *widget,
 727                                     GtkSelectionData   *selection_data,
 728                                     guint               time_);
 729
 730   /* Source side drag signals */
 731   void (* drag_begin)              (GtkWidget          *widget,
 732                                     GdkDragContext     *context);
 733   void (* drag_end)                (GtkWidget          *widget,
 734                                     GdkDragContext     *context);
 735   void (* drag_data_get)           (GtkWidget          *widget,
 736                                     GdkDragContext     *context,
 737                                     GtkSelectionData   *selection_data,
 738                                     guint               info,
 739                                     guint               time_);
 740   void (* drag_data_delete)        (GtkWidget          *widget,
 741                                     GdkDragContext     *context);
 742
 743   /* Target side drag signals */
 744   void (* drag_leave)              (GtkWidget          *widget,
 745                                     GdkDragContext     *context,
 746                                     guint               time_);
 747   gboolean (* drag_motion)         (GtkWidget          *widget,
 748                                     GdkDragContext     *context,
 749                                     gint                x,
 750                                     gint                y,
 751                                     guint               time_);
 752   gboolean (* drag_drop)           (GtkWidget          *widget,
 753                                     GdkDragContext     *context,
 754                                     gint                x,
 755                                     gint                y,
 756                                     guint               time_);
 757   void (* drag_data_received)      (GtkWidget          *widget,
 758                                     GdkDragContext     *context,
 759                                     gint                x,
 760                                     gint                y,
 761                                     GtkSelectionData   *selection_data,
 762                                     guint               info,
 763                                     guint               time_);
 764
 765   /* Signals used only for keybindings */
 766   gboolean (* popup_menu)          (GtkWidget          *widget);
 767
 768   /* If a widget has multiple tooltips/whatsthis, it should show the
 769    * one for the current focus location, or if that doesn't make
 770    * sense, should cycle through them showing each tip alongside
 771    * whatever piece of the widget it applies to.
 772    */
 773   gboolean (* show_help)           (GtkWidget          *widget,
 774                                     GtkWidgetHelpType   help_type);
 775
 776   /* accessibility support
 777    */
 778   AtkObject*   (*get_accessible)     (GtkWidget *widget);
 779
 780   void         (*screen_changed)     (GtkWidget *widget,
 781                                       GdkScreen *previous_screen);
 782   gboolean     (*can_activate_accel) (GtkWidget *widget,
 783                                       guint      signal_id);
 784
 785   /* Sent when a grab is broken. */
 786   gboolean (*grab_broken_event) (GtkWidget           *widget,
 787                                  GdkEventGrabBroken  *event);
 788
 789   void         (* composited_changed) (GtkWidget *widget);
 790
 791   gboolean     (* query_tooltip)      (GtkWidget  *widget,
 792                                        gint        x,
 793                                        gint        y,
 794                                        gboolean    keyboard_tooltip,
 795                                        GtkTooltip *tooltip);
 796   /* Signals without a C default handler class slot:
 797    * gboolean   (*damage_event) (GtkWidget      *widget,
 798    *                             GdkEventExpose *event);
 799    */
 800
 801   /* Padding for future expansion */
 802   void (*_gtk_reserved5) (void);
 803   void (*_gtk_reserved6) (void);
 804   void (*_gtk_reserved7) (void);
 805 };
 806
 807 struct _GtkDesiredSize
 808 {
 809   guint  age;
 810   gint   for_size;
 811   gint   minimum_size;
 812   gint   natural_size;
 813 };
 814
 815 struct _GtkWidgetAuxInfo
 816 {
 817   gint x;
 818   gint y;
 819   gint width;
 820   gint height;
 821
 822   guint x_set : 1;
 823   guint y_set : 1;
 824
 825   GtkDesiredSize desired_widths[GTK_N_CACHED_SIZES];
 826   GtkDesiredSize desired_heights[GTK_N_CACHED_SIZES];
 827   guint cached_width_age;
 828   guint cached_height_age;
 829 };
 830
 831 struct _GtkWidgetShapeInfo
 832 {
 833   gint16     offset_x;
 834   gint16     offset_y;
 835   GdkBitmap *shape_mask;
 836 };
 837
 838 GType      gtk_widget_get_type            (void) G_GNUC_CONST;
 839 GtkWidget* gtk_widget_new                 (GType                type,
 840                                            const gchar         *first_property_name,
 841                                            ...);
 842 void       gtk_widget_destroy             (GtkWidget           *widget);
 843 void       gtk_widget_destroyed           (GtkWidget           *widget,
 844                                            GtkWidget          **widget_pointer);
 845 #ifndef GTK_DISABLE_DEPRECATED
 846 GtkWidget* gtk_widget_ref                 (GtkWidget           *widget);
 847 void       gtk_widget_unref               (GtkWidget           *widget);
 848 void       gtk_widget_set                 (GtkWidget           *widget,
 849                                            const gchar         *first_property_name,
 850                                            ...) G_GNUC_NULL_TERMINATED;
 851 #endif /* GTK_DISABLE_DEPRECATED */
 852 void       gtk_widget_unparent            (GtkWidget           *widget);
 853 void       gtk_widget_show                (GtkWidget           *widget);
 854 void       gtk_widget_show_now            (GtkWidget           *widget);
 855 void       gtk_widget_hide                (GtkWidget           *widget);
 856 void       gtk_widget_show_all            (GtkWidget           *widget);
 857 void       gtk_widget_hide_all            (GtkWidget           *widget);
 858 void       gtk_widget_set_no_show_all     (GtkWidget           *widget,
 859                                            gboolean             no_show_all);
 860 gboolean   gtk_widget_get_no_show_all     (GtkWidget           *widget);
 861 void       gtk_widget_map                 (GtkWidget           *widget);
 862 void       gtk_widget_unmap               (GtkWidget           *widget);
 863 void       gtk_widget_realize             (GtkWidget           *widget);
 864 void       gtk_widget_unrealize           (GtkWidget           *widget);
 865
 866 /* Queuing draws */
 867 void       gtk_widget_queue_draw          (GtkWidget           *widget);
 868 void       gtk_widget_queue_draw_area     (GtkWidget           *widget,
 869                                            gint                 x,
 870                                            gint                 y,
 871                                            gint                 width,
 872                                            gint                 height);
 873 #ifndef GTK_DISABLE_DEPRECATED
 874 void       gtk_widget_queue_clear         (GtkWidget           *widget);
 875 void       gtk_widget_queue_clear_area    (GtkWidget           *widget,
 876                                            gint                 x,
 877                                            gint                 y,
 878                                            gint                 width,
 879                                            gint                 height);
 880 #endif /* GTK_DISABLE_DEPRECATED */
 881
 882
 883 void       gtk_widget_queue_resize        (GtkWidget           *widget);
 884 void       gtk_widget_queue_resize_no_redraw (GtkWidget *widget);
 885 #ifndef GTK_DISABLE_DEPRECATED
 886 void       gtk_widget_draw                (GtkWidget           *widget,
 887                                            const GdkRectangle  *area);
 888 #endif /* GTK_DISABLE_DEPRECATED */
 889 void       gtk_widget_size_request        (GtkWidget           *widget,
 890                                            GtkRequisition      *requisition);
 891 void       gtk_widget_size_allocate       (GtkWidget           *widget,
 892                                            GtkAllocation       *allocation);
 893 void       gtk_widget_get_child_requisition (GtkWidget         *widget,
 894                                              GtkRequisition    *requisition);
 895 void       gtk_widget_add_accelerator     (GtkWidget           *widget,
 896                                            const gchar         *accel_signal,
 897                                            GtkAccelGroup       *accel_group,
 898                                            guint                accel_key,
 899                                            GdkModifierType      accel_mods,
 900                                            GtkAccelFlags        accel_flags);
 901 gboolean   gtk_widget_remove_accelerator  (GtkWidget           *widget,
 902                                            GtkAccelGroup       *accel_group,
 903                                            guint                accel_key,
 904                                            GdkModifierType      accel_mods);
 905 void       gtk_widget_set_accel_path      (GtkWidget           *widget,
 906                                            const gchar         *accel_path,
 907                                            GtkAccelGroup       *accel_group);
 908 const gchar* _gtk_widget_get_accel_path   (GtkWidget           *widget,
 909                                            gboolean            *locked);
 910 GList*     gtk_widget_list_accel_closures (GtkWidget           *widget);
 911 gboolean   gtk_widget_can_activate_accel  (GtkWidget           *widget,
 912                                            guint                signal_id);
 913 gboolean   gtk_widget_mnemonic_activate   (GtkWidget           *widget,
 914                                            gboolean             group_cycling);
 915 gboolean   gtk_widget_event               (GtkWidget           *widget,
 916                                            GdkEvent            *event);
 917 gint       gtk_widget_send_expose         (GtkWidget           *widget,
 918                                            GdkEvent            *event);
 919
 920 gboolean   gtk_widget_activate               (GtkWidget        *widget);
 921 gboolean   gtk_widget_set_scroll_adjustments (GtkWidget        *widget,
 922                                               GtkAdjustment    *hadjustment,
 923                                               GtkAdjustment    *vadjustment);
 924
 925 void       gtk_widget_reparent            (GtkWidget           *widget,
 926                                            GtkWidget           *new_parent);
 927 gboolean   gtk_widget_intersect           (GtkWidget           *widget,
 928                                            const GdkRectangle  *area,
 929                                            GdkRectangle        *intersection);
 930 GdkRegion *gtk_widget_region_intersect    (GtkWidget           *widget,
 931                                            const GdkRegion     *region);
 932
 933 void    gtk_widget_freeze_child_notify    (GtkWidget           *widget);
 934 void    gtk_widget_child_notify           (GtkWidget           *widget,
 935                                            const gchar         *child_property);
 936 void    gtk_widget_thaw_child_notify      (GtkWidget           *widget);
 937
 938 void       gtk_widget_set_can_focus       (GtkWidget           *widget,
 939                                            gboolean             can_focus);
 940 gboolean   gtk_widget_get_can_focus       (GtkWidget           *widget);
 941 gboolean   gtk_widget_has_focus           (GtkWidget           *widget);
 942 gboolean   gtk_widget_is_focus            (GtkWidget           *widget);
 943 void       gtk_widget_grab_focus          (GtkWidget           *widget);
 944
 945 void       gtk_widget_set_can_default     (GtkWidget           *widget,
 946                                            gboolean             can_default);
 947 gboolean   gtk_widget_get_can_default     (GtkWidget           *widget);
 948 gboolean   gtk_widget_has_default         (GtkWidget           *widget);
 949 void       gtk_widget_grab_default        (GtkWidget           *widget);
 950
 951 void      gtk_widget_set_receives_default (GtkWidget           *widget,
 952                                            gboolean             receives_default);
 953 gboolean  gtk_widget_get_receives_default (GtkWidget           *widget);
 954
 955 gboolean   gtk_widget_has_grab            (GtkWidget           *widget);
 956
 957 void                  gtk_widget_set_name               (GtkWidget    *widget,
 958                                                          const gchar  *name);
 959 G_CONST_RETURN gchar* gtk_widget_get_name               (GtkWidget    *widget);
 960
 961 void                  gtk_widget_set_state              (GtkWidget    *widget,
 962                                                          GtkStateType  state);
 963 GtkStateType          gtk_widget_get_state              (GtkWidget    *widget);
 964
 965 void                  gtk_widget_set_sensitive          (GtkWidget    *widget,
 966                                                          gboolean      sensitive);
 967 gboolean              gtk_widget_get_sensitive          (GtkWidget    *widget);
 968 gboolean              gtk_widget_is_sensitive           (GtkWidget    *widget);
 969
 970 void                  gtk_widget_set_visible            (GtkWidget    *widget,
 971                                                          gboolean      visible);
 972 gboolean              gtk_widget_get_visible            (GtkWidget    *widget);
 973
 974 void                  gtk_widget_set_has_window         (GtkWidget    *widget,
 975                                                          gboolean      has_window);
 976 gboolean              gtk_widget_get_has_window         (GtkWidget    *widget);
 977
 978 gboolean              gtk_widget_is_toplevel            (GtkWidget    *widget);
 979 gboolean              gtk_widget_is_drawable            (GtkWidget    *widget);
 980 void                  gtk_widget_set_realized           (GtkWidget    *widget,
 981                                                          gboolean      realized);
 982 gboolean              gtk_widget_get_realized           (GtkWidget    *widget);
 983 void                  gtk_widget_set_mapped             (GtkWidget    *widget,
 984                                                          gboolean      mapped);
 985 gboolean              gtk_widget_get_mapped             (GtkWidget    *widget);
 986
 987 void                  gtk_widget_set_app_paintable      (GtkWidget    *widget,
 988                                                          gboolean      app_paintable);
 989 gboolean              gtk_widget_get_app_paintable      (GtkWidget    *widget);
 990
 991 void                  gtk_widget_set_double_buffered    (GtkWidget    *widget,
 992                                                          gboolean      double_buffered);
 993 gboolean              gtk_widget_get_double_buffered    (GtkWidget    *widget);
 994
 995 void                  gtk_widget_set_redraw_on_allocate (GtkWidget    *widget,
 996                                                          gboolean      redraw_on_allocate);
 997
 998 void                  gtk_widget_set_parent             (GtkWidget    *widget,
 999                                                          GtkWidget    *parent);
1000 GtkWidget           * gtk_widget_get_parent             (GtkWidget    *widget);
1001
1002 void                  gtk_widget_set_parent_window      (GtkWidget    *widget,
1003                                                          GdkWindow    *parent_window);
1004 GdkWindow           * gtk_widget_get_parent_window      (GtkWidget    *widget);
1005
1006 void                  gtk_widget_set_child_visible      (GtkWidget    *widget,
1007                                                          gboolean      is_visible);
1008 gboolean              gtk_widget_get_child_visible      (GtkWidget    *widget);
1009
1010 void                  gtk_widget_set_window             (GtkWidget    *widget,
1011                                                          GdkWindow    *window);
1012 GdkWindow           * gtk_widget_get_window             (GtkWidget    *widget);
1013
1014 void                  gtk_widget_get_allocation         (GtkWidget     *widget,
1015                                                          GtkAllocation *allocation);
1016 void                  gtk_widget_set_allocation         (GtkWidget     *widget,
1017                                                          const GtkAllocation *allocation);
1018
1019 void                  gtk_widget_get_requisition        (GtkWidget     *widget,
1020                                                          GtkRequisition *requisition);
1021
1022 gboolean   gtk_widget_child_focus         (GtkWidget           *widget,
1023                                            GtkDirectionType     direction);
1024 gboolean   gtk_widget_keynav_failed       (GtkWidget           *widget,
1025                                            GtkDirectionType     direction);
1026 void       gtk_widget_error_bell          (GtkWidget           *widget);
1027
1028 void       gtk_widget_set_size_request    (GtkWidget           *widget,
1029                                            gint                 width,
1030                                            gint                 height);
1031 void       gtk_widget_get_size_request    (GtkWidget           *widget,
1032                                            gint                *width,
1033                                            gint                *height);
1034 #ifndef GTK_DISABLE_DEPRECATED
1035 void       gtk_widget_set_uposition       (GtkWidget           *widget,
1036                                            gint                 x,
1037                                            gint                 y);
1038 void       gtk_widget_set_usize           (GtkWidget           *widget,
1039                                            gint                 width,
1040                                            gint                 height);
1041 #endif
1042
1043 void       gtk_widget_set_events          (GtkWidget           *widget,
1044                                            gint                 events);
1045 void       gtk_widget_add_events          (GtkWidget           *widget,
1046                                            gint                 events);
1047 void       gtk_widget_set_extension_events (GtkWidget           *widget,
1048                                             GdkExtensionMode    mode);
1049
1050 GdkExtensionMode gtk_widget_get_extension_events (GtkWidget     *widget);
1051 GtkWidget*   gtk_widget_get_toplevel    (GtkWidget      *widget);
1052 GtkWidget*   gtk_widget_get_ancestor    (GtkWidget      *widget,
1053                                          GType           widget_type);
1054 GdkColormap* gtk_widget_get_colormap    (GtkWidget      *widget);
1055 GdkVisual*   gtk_widget_get_visual      (GtkWidget      *widget);
1056
1057 GdkScreen *   gtk_widget_get_screen      (GtkWidget *widget);
1058 gboolean      gtk_widget_has_screen      (GtkWidget *widget);
1059 GdkDisplay *  gtk_widget_get_display     (GtkWidget *widget);
1060 GdkWindow *   gtk_widget_get_root_window (GtkWidget *widget);
1061 GtkSettings*  gtk_widget_get_settings    (GtkWidget *widget);
1062 GtkClipboard *gtk_widget_get_clipboard   (GtkWidget *widget,
1063                                           GdkAtom    selection);
1064 GdkPixmap *   gtk_widget_get_snapshot    (GtkWidget    *widget,
1065                                           GdkRectangle *clip_rect);
1066
1067 #ifndef GTK_DISABLE_DEPRECATED
1068
1069 /**
1070  * gtk_widget_set_visual:
1071  * @widget: a #GtkWidget
1072  * @visual: a visual
1073  *
1074  * This function is deprecated; it does nothing.
1075  */
1076 #define gtk_widget_set_visual(widget,visual)  ((void) 0)
1077
1078 /**
1079  * gtk_widget_push_visual:
1080  * @visual: a visual
1081  *
1082  * This function is deprecated; it does nothing.
1083  */
1084 #define gtk_widget_push_visual(visual)        ((void) 0)
1085
1086 /**
1087  * gtk_widget_pop_visual:
1088  *
1089  * This function is deprecated; it does nothing.
1090  */
1091 #define gtk_widget_pop_visual()               ((void) 0)
1092
1093 /**
1094  * gtk_widget_set_default_visual:
1095  * @visual: a visual
1096  *
1097  * This function is deprecated; it does nothing.
1098  */
1099 #define gtk_widget_set_default_visual(visual) ((void) 0)
1100
1101 #endif /* GTK_DISABLE_DEPRECATED */
1102
1103 /* Accessibility support */
1104 AtkObject*       gtk_widget_get_accessible               (GtkWidget          *widget);
1105
1106 /* The following functions must not be called on an already
1107  * realized widget. Because it is possible that somebody
1108  * can call get_colormap() or get_visual() and save the
1109  * result, these functions are probably only safe to
1110  * call in a widget's init() function.
1111  */
1112 void         gtk_widget_set_colormap    (GtkWidget      *widget,
1113                                          GdkColormap    *colormap);
1114
1115 gint         gtk_widget_get_events      (GtkWidget      *widget);
1116 void         gtk_widget_get_pointer     (GtkWidget      *widget,
1117                                          gint           *x,
1118                                          gint           *y);
1119
1120 gboolean     gtk_widget_is_ancestor     (GtkWidget      *widget,
1121                                          GtkWidget      *ancestor);
1122
1123 gboolean     gtk_widget_translate_coordinates (GtkWidget  *src_widget,
1124                                                GtkWidget  *dest_widget,
1125                                                gint        src_x,
1126                                                gint        src_y,
1127                                                gint       *dest_x,
1128                                                gint       *dest_y);
1129
1130 /* Hide widget and return TRUE.
1131  */
1132 gboolean     gtk_widget_hide_on_delete  (GtkWidget      *widget);
1133
1134 /* Widget styles.
1135  */
1136 void        gtk_widget_style_attach       (GtkWidget            *style);
1137
1138 gboolean    gtk_widget_has_rc_style       (GtkWidget            *widget);
1139 void        gtk_widget_set_style          (GtkWidget            *widget,
1140                                            GtkStyle             *style);
1141 void        gtk_widget_ensure_style       (GtkWidget            *widget);
1142 GtkStyle *  gtk_widget_get_style          (GtkWidget            *widget);
1143
1144 void        gtk_widget_modify_style       (GtkWidget            *widget,
1145                                            GtkRcStyle           *style);
1146 GtkRcStyle *gtk_widget_get_modifier_style (GtkWidget            *widget);
1147 void        gtk_widget_modify_fg          (GtkWidget            *widget,
1148                                            GtkStateType          state,
1149                                            const GdkColor       *color);
1150 void        gtk_widget_modify_bg          (GtkWidget            *widget,
1151                                            GtkStateType          state,
1152                                            const GdkColor       *color);
1153 void        gtk_widget_modify_text        (GtkWidget            *widget,
1154                                            GtkStateType          state,
1155                                            const GdkColor       *color);
1156 void        gtk_widget_modify_base        (GtkWidget            *widget,
1157                                            GtkStateType          state,
1158                                            const GdkColor       *color);
1159 void        gtk_widget_modify_cursor      (GtkWidget            *widget,
1160                                            const GdkColor       *primary,
1161                                            const GdkColor       *secondary);
1162 void        gtk_widget_modify_font        (GtkWidget            *widget,
1163                                            PangoFontDescription *font_desc);
1164
1165 #ifndef GTK_DISABLE_DEPRECATED
1166
1167 /**
1168  * gtk_widget_set_rc_style:
1169  * @widget: a #GtkWidget.
1170  *
1171  * Equivalent to <literal>gtk_widget_set_style (widget, NULL)</literal>.
1172  *
1173  * Deprecated: 2.0: Use gtk_widget_set_style() with a %NULL @style argument instead.
1174  */
1175 #define gtk_widget_set_rc_style(widget)          (gtk_widget_set_style (widget, NULL))
1176
1177 /**
1178  * gtk_widget_restore_default_style:
1179  * @widget: a #GtkWidget.
1180  *
1181  * Equivalent to <literal>gtk_widget_set_style (widget, NULL)</literal>.
1182  *
1183  * Deprecated: 2.0: Use gtk_widget_set_style() with a %NULL @style argument instead.
1184  */
1185 #define gtk_widget_restore_default_style(widget) (gtk_widget_set_style (widget, NULL))
1186 #endif
1187
1188 PangoContext *gtk_widget_create_pango_context (GtkWidget   *widget);
1189 PangoContext *gtk_widget_get_pango_context    (GtkWidget   *widget);
1190 PangoLayout  *gtk_widget_create_pango_layout  (GtkWidget   *widget,
1191                                                const gchar *text);
1192
1193 GdkPixbuf    *gtk_widget_render_icon          (GtkWidget   *widget,
1194                                                const gchar *stock_id,
1195                                                GtkIconSize  size,
1196                                                const gchar *detail);
1197
1198 /* handle composite names for GTK_COMPOSITE_CHILD widgets,
1199  * the returned name is newly allocated.
1200  */
1201 void   gtk_widget_set_composite_name    (GtkWidget      *widget,
1202                                          const gchar    *name);
1203 gchar* gtk_widget_get_composite_name    (GtkWidget      *widget);
1204
1205 /* Descend recursively and set rc-style on all widgets without user styles */
1206 void       gtk_widget_reset_rc_styles   (GtkWidget      *widget);
1207
1208 /* Push/pop pairs, to change default values upon a widget's creation.
1209  * This will override the values that got set by the
1210  * gtk_widget_set_default_* () functions.
1211  */
1212 void         gtk_widget_push_colormap        (GdkColormap *cmap);
1213 void         gtk_widget_push_composite_child (void);
1214 void         gtk_widget_pop_composite_child  (void);
1215 void         gtk_widget_pop_colormap         (void);
1216
1217 /* widget style properties
1218  */
1219 void gtk_widget_class_install_style_property        (GtkWidgetClass     *klass,
1220                                                      GParamSpec         *pspec);
1221 void gtk_widget_class_install_style_property_parser (GtkWidgetClass     *klass,
1222                                                      GParamSpec         *pspec,
1223                                                      GtkRcPropertyParser parser);
1224 GParamSpec*  gtk_widget_class_find_style_property   (GtkWidgetClass     *klass,
1225                                                      const gchar        *property_name);
1226 GParamSpec** gtk_widget_class_list_style_properties (GtkWidgetClass     *klass,
1227                                                      guint              *n_properties);
1228 void gtk_widget_style_get_property (GtkWidget        *widget,
1229                                     const gchar    *property_name,
1230                                     GValue           *value);
1231 void gtk_widget_style_get_valist   (GtkWidget        *widget,
1232                                     const gchar    *first_property_name,
1233                                     va_list         var_args);
1234 void gtk_widget_style_get          (GtkWidget        *widget,
1235                                     const gchar    *first_property_name,
1236                                     ...) G_GNUC_NULL_TERMINATED;
1237
1238
1239 /* Set certain default values to be used at widget creation time.
1240  */
1241 void         gtk_widget_set_default_colormap (GdkColormap *colormap);
1242 GtkStyle*    gtk_widget_get_default_style    (void);
1243 #ifndef GDK_MULTIHEAD_SAFE
1244 GdkColormap* gtk_widget_get_default_colormap (void);
1245 GdkVisual*   gtk_widget_get_default_visual   (void);
1246 #endif
1247
1248 /* Functions for setting directionality for widgets
1249  */
1250
1251 void             gtk_widget_set_direction         (GtkWidget        *widget,
1252                                                    GtkTextDirection  dir);
1253 GtkTextDirection gtk_widget_get_direction         (GtkWidget        *widget);
1254
1255 void             gtk_widget_set_default_direction (GtkTextDirection  dir);
1256 GtkTextDirection gtk_widget_get_default_direction (void);
1257
1258 /* Compositing manager functionality */
1259 gboolean gtk_widget_is_composited (GtkWidget *widget);
1260
1261 /* Counterpart to gdk_window_shape_combine_mask.
1262  */
1263 void         gtk_widget_shape_combine_mask (GtkWidget *widget,
1264                                             GdkBitmap *shape_mask,
1265                                             gint       offset_x,
1266                                             gint       offset_y);
1267 void         gtk_widget_input_shape_combine_mask (GtkWidget *widget,
1268                                                   GdkBitmap *shape_mask,
1269                                                   gint       offset_x,
1270                                                   gint       offset_y);
1271
1272 /* internal function */
1273 void         gtk_widget_reset_shapes       (GtkWidget *widget);
1274
1275 /* Compute a widget's path in the form "GtkWindow.MyLabel", and
1276  * return newly alocated strings.
1277  */
1278 void         gtk_widget_path               (GtkWidget *widget,
1279                                             guint     *path_length,
1280                                             gchar    **path,
1281                                             gchar    **path_reversed);
1282 void         gtk_widget_class_path         (GtkWidget *widget,
1283                                             guint     *path_length,
1284                                             gchar    **path,
1285                                             gchar    **path_reversed);
1286
1287 GList* gtk_widget_list_mnemonic_labels  (GtkWidget *widget);
1288 void   gtk_widget_add_mnemonic_label    (GtkWidget *widget,
1289                                          GtkWidget *label);
1290 void   gtk_widget_remove_mnemonic_label (GtkWidget *widget,
1291                                          GtkWidget *label);
1292
1293 void                  gtk_widget_set_tooltip_window    (GtkWidget   *widget,
1294                                                         GtkWindow   *custom_window);
1295 GtkWindow *gtk_widget_get_tooltip_window    (GtkWidget   *widget);
1296 void       gtk_widget_trigger_tooltip_query (GtkWidget   *widget);
1297 void       gtk_widget_set_tooltip_text      (GtkWidget   *widget,
1298                                              const gchar *text);
1299 gchar *    gtk_widget_get_tooltip_text      (GtkWidget   *widget);
1300 void       gtk_widget_set_tooltip_markup    (GtkWidget   *widget,
1301                                              const gchar *markup);
1302 gchar *    gtk_widget_get_tooltip_markup    (GtkWidget   *widget);
1303 void       gtk_widget_set_has_tooltip       (GtkWidget   *widget,
1304                                              gboolean     has_tooltip);
1305 gboolean   gtk_widget_get_has_tooltip       (GtkWidget   *widget);
1306
1307 GType           gtk_requisition_get_type (void) G_GNUC_CONST;
1308 GtkRequisition *gtk_requisition_copy     (const GtkRequisition *requisition);
1309 void            gtk_requisition_free     (GtkRequisition       *requisition);
1310
1311 #if     defined (GTK_TRACE_OBJECTS) && defined (__GNUC__)
1312 #  define gtk_widget_ref g_object_ref
1313 #  define gtk_widget_unref g_object_unref
1314 #endif  /* GTK_TRACE_OBJECTS && __GNUC__ */
1315
1316 void              _gtk_widget_grab_notify                 (GtkWidget    *widget,
1317                                                            gboolean     was_grabbed);
1318
1319 GtkWidgetAuxInfo *_gtk_widget_get_aux_info                (GtkWidget    *widget,
1320                                                            gboolean      create);
1321 void              _gtk_widget_propagate_hierarchy_changed (GtkWidget    *widget,
1322                                                            GtkWidget    *previous_toplevel);
1323 void              _gtk_widget_propagate_screen_changed    (GtkWidget    *widget,
1324                                                            GdkScreen    *previous_screen);
1325 void              _gtk_widget_propagate_composited_changed (GtkWidget    *widget);
1326
1327 void       _gtk_widget_set_pointer_window  (GtkWidget      *widget,
1328                                             GdkWindow      *pointer_window);
1329 GdkWindow *_gtk_widget_get_pointer_window  (GtkWidget      *widget);
1330 gboolean   _gtk_widget_is_pointer_widget   (GtkWidget      *widget);
1331 void       _gtk_widget_synthesize_crossing (GtkWidget      *from,
1332                                             GtkWidget      *to,
1333                                             GdkCrossingMode mode);
1334
1335 GdkColormap* _gtk_widget_peek_colormap (void);
1336
1337 void         _gtk_widget_buildable_finish_accelerator (GtkWidget *widget,
1338                                                        GtkWidget *toplevel,
1339                                                        gpointer   user_data);
1340
1341 G_END_DECLS
1342
1343 #endif /* __GTK_WIDGET_H__ */