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

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