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_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 the widget flags from GtkWidget.
 142  */
 143 /**
 144  * GTK_WIDGET_FLAGS:
 145  * @wid: a #GtkWidget.
 146  *
 147  * Returns the widget flags from @wid.
 148  *
 149  * Deprecated: 2.20: Use the proper function to test individual states:
 150  * gtk_widget_get_app_paintable(), gtk_widget_get_can_default(),
 151  * gtk_widget_get_can_focus(), gtk_widget_get_double_buffered(),
 152  * gtk_widget_has_default(), gtk_widget_is_drawable(),
 153  * gtk_widget_has_focus(), gtk_widget_has_grab(), gtk_widget_get_mapped(),
 154  * gtk_widget_get_has_window(), gtk_widget_has_rc_style(),
 155  * gtk_widget_get_realized(), gtk_widget_get_receives_default(),
 156  * gtk_widget_get_sensitive(), gtk_widget_is_sensitive(),
 157  * gtk_widget_is_toplevel() or gtk_widget_get_visible().
 158  */
 159 #define GTK_WIDGET_FLAGS(wid)             (GTK_OBJECT_FLAGS (wid))
 160 /* FIXME: Deprecating GTK_WIDGET_FLAGS requires fixing GTK internals. */
 161
 162 /* Macros for setting and clearing widget flags.
 163  */
 164 /**
 165  * GTK_WIDGET_SET_FLAGS:
 166  * @wid: a #GtkWidget.
 167  * @flag: the flags to set.
 168  *
 169  * Turns on certain widget flags.
 170  *
 171  * Deprecated: 2.22: Use the proper function instead: gtk_widget_set_app_paintable(),
 172  *   gtk_widget_set_can_default(), gtk_widget_set_can_focus(),
 173  *   gtk_widget_set_double_buffered(), gtk_widget_set_has_window(),
 174  *   gtk_widget_set_mapped(), gtk_widget_set_no_show_all(),
 175  *   gtk_widget_set_realized(), gtk_widget_set_receives_default(),
 176  *   gtk_widget_set_sensitive() or gtk_widget_set_visible().
 177  *
 178  */
 179 #define GTK_WIDGET_SET_FLAGS(wid,flag)    G_STMT_START{ (GTK_WIDGET_FLAGS (wid) |= (flag)); }G_STMT_END
 180 /* FIXME: Deprecating GTK_WIDGET_SET_FLAGS requires fixing GTK internals. */
 181
 182 /**
 183  * GTK_WIDGET_UNSET_FLAGS:
 184  * @wid: a #GtkWidget.
 185  * @flag: the flags to unset.
 186  *
 187  * Turns off certain widget flags.
 188  *
 189  * Deprecated: 2.22: Use the proper function instead. See GTK_WIDGET_SET_FLAGS().
 190  */
 191 #define GTK_WIDGET_UNSET_FLAGS(wid,flag)  G_STMT_START{ (GTK_WIDGET_FLAGS (wid) &= ~(flag)); }G_STMT_END
 192 /* FIXME: Deprecating GTK_WIDGET_UNSET_FLAGS requires fixing GTK internals. */
 193
 194 #define GTK_TYPE_REQUISITION              (gtk_requisition_get_type ())
 195
 196 /* forward declaration to avoid excessive includes (and concurrent includes)
 197  */
 198 typedef struct _GtkRequisition     GtkRequisition;
 199 typedef struct _GtkSelectionData   GtkSelectionData;
 200 typedef struct _GtkWidgetClass     GtkWidgetClass;
 201 typedef struct _GtkWidgetAuxInfo   GtkWidgetAuxInfo;
 202 typedef struct _GtkWidgetShapeInfo GtkWidgetShapeInfo;
 203 typedef struct _GtkClipboard       GtkClipboard;
 204 typedef struct _GtkTooltip         GtkTooltip;
 205 typedef struct _GtkWindow          GtkWindow;
 206
 207
 208 /**
 209  * GtkAllocation:
 210  * @x: the X position of the widget's area relative to its parents allocation.
 211  * @y: the Y position of the widget's area relative to its parents allocation.
 212  * @width: the width of the widget's allocated area.
 213  * @height: the height of the widget's allocated area.
 214  *
 215  * A <structname>GtkAllocation</structname> of a widget represents region which has been allocated to the
 216  * widget by its parent. It is a subregion of its parents allocation. See
 217  * <xref linkend="size-allocation"/> for more information.
 218  */
 219 typedef         GdkRectangle       GtkAllocation;
 220
 221 /**
 222  * GtkCallback:
 223  * @widget: the widget to operate on
 224  * @data: user-supplied data
 225  *
 226  * The type of the callback functions used for e.g. iterating over
 227  * the children of a container, see gtk_container_foreach().
 228  */
 229 typedef void    (*GtkCallback)     (GtkWidget        *widget,
 230                                     gpointer          data);
 231
 232 /**
 233  * GtkRequisition:
 234  * @width: the widget's desired width
 235  * @height: the widget's desired height
 236  *
 237  * A <structname>GtkRequisition</structname> represents the desired size of a widget. See
 238  * <xref linkend="size-requisition"/> for more information.
 239  */
 240 struct _GtkRequisition
 241 {
 242   gint width;
 243   gint height;
 244 };
 245
 246 /* The widget is the base of the tree for displayable objects.
 247  *  (A displayable object is one which takes up some amount
 248  *  of screen real estate). It provides a common base and interface
 249  *  which actual widgets must adhere to.
 250  */
 251 struct _GtkWidget
 252 {
 253   /* The object structure needs to be the first
 254    *  element in the widget structure in order for
 255    *  the object mechanism to work correctly. This
 256    *  allows a GtkWidget pointer to be cast to a
 257    *  GtkObject pointer.
 258    */
 259   GtkObject object;
 260
 261   /* 16 bits of internally used private flags.
 262    * this will be packed into the same 4 byte alignment frame that
 263    * state and saved_state go. we therefore don't waste any new
 264    * space on this.
 265    */
 266   guint16 GSEAL (private_flags);
 267
 268   /* The state of the widget. There are actually only
 269    *  5 widget states (defined in "gtkenums.h").
 270    */
 271   guint8 GSEAL (state);
 272
 273   /* The saved state of the widget. When a widget's state
 274    *  is changed to GTK_STATE_INSENSITIVE via
 275    *  "gtk_widget_set_state" or "gtk_widget_set_sensitive"
 276    *  the old state is kept around in this field. The state
 277    *  will be restored once the widget gets sensitive again.
 278    */
 279   guint8 GSEAL (saved_state);
 280
 281   /* The widget's name. If the widget does not have a name
 282    *  (the name is NULL), then its name (as returned by
 283    *  "gtk_widget_get_name") is its class's name.
 284    * Among other things, the widget name is used to determine
 285    *  the style to use for a widget.
 286    */
 287   gchar *GSEAL (name);
 288
 289   /*< public >*/
 290
 291   /* The style for the widget. The style contains the
 292    *  colors the widget should be drawn in for each state
 293    *  along with graphics contexts used to draw with and
 294    *  the font to use for text.
 295    */
 296   GtkStyle *GSEAL (style);
 297
 298   /* The widget's desired size.
 299    */
 300   GtkRequisition GSEAL (requisition);
 301
 302   /* The widget's allocated size.
 303    */
 304   GtkAllocation GSEAL (allocation);
 305
 306   /* The widget's window or its parent window if it does
 307    *  not have a window. (Which will be indicated by the
 308    *  GTK_NO_WINDOW flag being set).
 309    */
 310   GdkWindow *GSEAL (window);
 311
 312   /* The widget's parent.
 313    */
 314   GtkWidget *GSEAL (parent);
 315 };
 316
 317 /**
 318  * GtkWidgetClass:
 319  * @parent_class:
 320  * @activate_signal:
 321  * @set_scroll_adjustments_signal:
 322  *
 323  * <structfield>activate_signal</structfield>
 324  * The signal to emit when a widget of this class is activated,
 325  * gtk_widget_activate() handles the emission. Implementation of this
 326  * signal is optional.
 327  *
 328  *
 329  * <structfield>set_scroll_adjustment_signal</structfield>
 330  * This signal is emitted  when a widget of this class is added
 331  * to a scrolling aware parent, gtk_widget_set_scroll_adjustments()
 332  * handles the emission.
 333  * Implementation of this signal is optional.
 334  */
 335 struct _GtkWidgetClass
 336 {
 337   /* The object class structure needs to be the first
 338    *  element in the widget class structure in order for
 339    *  the class mechanism to work correctly. This allows a
 340    *  GtkWidgetClass pointer to be cast to a GtkObjectClass
 341    *  pointer.
 342    */
 343   GtkObjectClass parent_class;
 344
 345   /*< public >*/
 346
 347   guint activate_signal;
 348
 349   guint set_scroll_adjustments_signal;
 350
 351   /*< private >*/
 352
 353   /* seldomly overidden */
 354   void (*dispatch_child_properties_changed) (GtkWidget   *widget,
 355                                              guint        n_pspecs,
 356                                              GParamSpec **pspecs);
 357
 358   /* basics */
 359   void (* show)                (GtkWidget        *widget);
 360   void (* show_all)            (GtkWidget        *widget);
 361   void (* hide)                (GtkWidget        *widget);
 362   void (* hide_all)            (GtkWidget        *widget);
 363   void (* map)                 (GtkWidget        *widget);
 364   void (* unmap)               (GtkWidget        *widget);
 365   void (* realize)             (GtkWidget        *widget);
 366   void (* unrealize)           (GtkWidget        *widget);
 367   void (* size_request)        (GtkWidget        *widget,
 368                                 GtkRequisition   *requisition);
 369   void (* size_allocate)       (GtkWidget        *widget,
 370                                 GtkAllocation    *allocation);
 371   void (* state_changed)       (GtkWidget        *widget,
 372                                 GtkStateType      previous_state);
 373   void (* parent_set)          (GtkWidget        *widget,
 374                                 GtkWidget        *previous_parent);
 375   void (* hierarchy_changed)   (GtkWidget        *widget,
 376                                 GtkWidget        *previous_toplevel);
 377   void (* style_set)           (GtkWidget        *widget,
 378                                 GtkStyle         *previous_style);
 379   void (* direction_changed)   (GtkWidget        *widget,
 380                                 GtkTextDirection  previous_direction);
 381   void (* grab_notify)         (GtkWidget        *widget,
 382                                 gboolean          was_grabbed);
 383   void (* child_notify)        (GtkWidget        *widget,
 384                                 GParamSpec       *pspec);
 385
 386   /* Mnemonics */
 387   gboolean (* mnemonic_activate) (GtkWidget    *widget,
 388                                   gboolean      group_cycling);
 389
 390   /* explicit focus */
 391   void     (* grab_focus)      (GtkWidget        *widget);
 392   gboolean (* focus)           (GtkWidget        *widget,
 393                                 GtkDirectionType  direction);
 394
 395   /* events */
 396   gboolean (* event)                    (GtkWidget           *widget,
 397                                          GdkEvent            *event);
 398   gboolean (* button_press_event)       (GtkWidget           *widget,
 399                                          GdkEventButton      *event);
 400   gboolean (* button_release_event)     (GtkWidget           *widget,
 401                                          GdkEventButton      *event);
 402   gboolean (* scroll_event)             (GtkWidget           *widget,
 403                                          GdkEventScroll      *event);
 404   gboolean (* motion_notify_event)      (GtkWidget           *widget,
 405                                          GdkEventMotion      *event);
 406   gboolean (* delete_event)             (GtkWidget           *widget,
 407                                          GdkEventAny         *event);
 408   gboolean (* destroy_event)            (GtkWidget           *widget,
 409                                          GdkEventAny         *event);
 410   gboolean (* expose_event)             (GtkWidget           *widget,
 411                                          GdkEventExpose      *event);
 412   gboolean (* key_press_event)          (GtkWidget           *widget,
 413                                          GdkEventKey         *event);
 414   gboolean (* key_release_event)        (GtkWidget           *widget,
 415                                          GdkEventKey         *event);
 416   gboolean (* enter_notify_event)       (GtkWidget           *widget,
 417                                          GdkEventCrossing    *event);
 418   gboolean (* leave_notify_event)       (GtkWidget           *widget,
 419                                          GdkEventCrossing    *event);
 420   gboolean (* configure_event)          (GtkWidget           *widget,
 421                                          GdkEventConfigure   *event);
 422   gboolean (* focus_in_event)           (GtkWidget           *widget,
 423                                          GdkEventFocus       *event);
 424   gboolean (* focus_out_event)          (GtkWidget           *widget,
 425                                          GdkEventFocus       *event);
 426   gboolean (* map_event)                (GtkWidget           *widget,
 427                                          GdkEventAny         *event);
 428   gboolean (* unmap_event)              (GtkWidget           *widget,
 429                                          GdkEventAny         *event);
 430   gboolean (* property_notify_event)    (GtkWidget           *widget,
 431                                          GdkEventProperty    *event);
 432   gboolean (* selection_clear_event)    (GtkWidget           *widget,
 433                                          GdkEventSelection   *event);
 434   gboolean (* selection_request_event)  (GtkWidget           *widget,
 435                                          GdkEventSelection   *event);
 436   gboolean (* selection_notify_event)   (GtkWidget           *widget,
 437                                          GdkEventSelection   *event);
 438   gboolean (* proximity_in_event)       (GtkWidget           *widget,
 439                                          GdkEventProximity   *event);
 440   gboolean (* proximity_out_event)      (GtkWidget           *widget,
 441                                          GdkEventProximity   *event);
 442   gboolean (* visibility_notify_event)  (GtkWidget           *widget,
 443                                          GdkEventVisibility  *event);
 444   gboolean (* client_event)             (GtkWidget           *widget,
 445                                          GdkEventClient      *event);
 446   gboolean (* no_expose_event)          (GtkWidget           *widget,
 447                                          GdkEventAny         *event);
 448   gboolean (* window_state_event)       (GtkWidget           *widget,
 449                                          GdkEventWindowState *event);
 450
 451   /* selection */
 452   void (* selection_get)           (GtkWidget          *widget,
 453                                     GtkSelectionData   *selection_data,
 454                                     guint               info,
 455                                     guint               time_);
 456   void (* selection_received)      (GtkWidget          *widget,
 457                                     GtkSelectionData   *selection_data,
 458                                     guint               time_);
 459
 460   /* Source side drag signals */
 461   void (* drag_begin)              (GtkWidget          *widget,
 462                                     GdkDragContext     *context);
 463   void (* drag_end)                (GtkWidget          *widget,
 464                                     GdkDragContext     *context);
 465   void (* drag_data_get)           (GtkWidget          *widget,
 466                                     GdkDragContext     *context,
 467                                     GtkSelectionData   *selection_data,
 468                                     guint               info,
 469                                     guint               time_);
 470   void (* drag_data_delete)        (GtkWidget          *widget,
 471                                     GdkDragContext     *context);
 472
 473   /* Target side drag signals */
 474   void (* drag_leave)              (GtkWidget          *widget,
 475                                     GdkDragContext     *context,
 476                                     guint               time_);
 477   gboolean (* drag_motion)         (GtkWidget          *widget,
 478                                     GdkDragContext     *context,
 479                                     gint                x,
 480                                     gint                y,
 481                                     guint               time_);
 482   gboolean (* drag_drop)           (GtkWidget          *widget,
 483                                     GdkDragContext     *context,
 484                                     gint                x,
 485                                     gint                y,
 486                                     guint               time_);
 487   void (* drag_data_received)      (GtkWidget          *widget,
 488                                     GdkDragContext     *context,
 489                                     gint                x,
 490                                     gint                y,
 491                                     GtkSelectionData   *selection_data,
 492                                     guint               info,
 493                                     guint               time_);
 494
 495   /* Signals used only for keybindings */
 496   gboolean (* popup_menu)          (GtkWidget          *widget);
 497
 498   /* If a widget has multiple tooltips/whatsthis, it should show the
 499    * one for the current focus location, or if that doesn't make
 500    * sense, should cycle through them showing each tip alongside
 501    * whatever piece of the widget it applies to.
 502    */
 503   gboolean (* show_help)           (GtkWidget          *widget,
 504                                     GtkWidgetHelpType   help_type);
 505
 506   /* accessibility support
 507    */
 508   AtkObject*   (*get_accessible)     (GtkWidget *widget);
 509
 510   void         (*screen_changed)     (GtkWidget *widget,
 511                                       GdkScreen *previous_screen);
 512   gboolean     (*can_activate_accel) (GtkWidget *widget,
 513                                       guint      signal_id);
 514
 515   /* Sent when a grab is broken. */
 516   gboolean (*grab_broken_event) (GtkWidget           *widget,
 517                                  GdkEventGrabBroken  *event);
 518
 519   void         (* composited_changed) (GtkWidget *widget);
 520
 521   gboolean     (* query_tooltip)      (GtkWidget  *widget,
 522                                        gint        x,
 523                                        gint        y,
 524                                        gboolean    keyboard_tooltip,
 525                                        GtkTooltip *tooltip);
 526   /* Signals without a C default handler class slot:
 527    * gboolean   (*damage_event) (GtkWidget      *widget,
 528    *                             GdkEventExpose *event);
 529    */
 530
 531   /* Padding for future expansion */
 532   void (*_gtk_reserved5) (void);
 533   void (*_gtk_reserved6) (void);
 534   void (*_gtk_reserved7) (void);
 535 };
 536
 537 struct _GtkWidgetAuxInfo
 538 {
 539   gint x;
 540   gint y;
 541   gint width;
 542   gint height;
 543
 544   guint x_set : 1;
 545   guint y_set : 1;
 546 };
 547
 548 struct _GtkWidgetShapeInfo
 549 {
 550   gint16     offset_x;
 551   gint16     offset_y;
 552   GdkBitmap *shape_mask;
 553 };
 554
 555 GType      gtk_widget_get_type            (void) G_GNUC_CONST;
 556 GtkWidget* gtk_widget_new                 (GType                type,
 557                                            const gchar         *first_property_name,
 558                                            ...);
 559 void       gtk_widget_destroy             (GtkWidget           *widget);
 560 void       gtk_widget_destroyed           (GtkWidget           *widget,
 561                                            GtkWidget          **widget_pointer);
 562 void       gtk_widget_unparent            (GtkWidget           *widget);
 563 void       gtk_widget_show                (GtkWidget           *widget);
 564 void       gtk_widget_show_now            (GtkWidget           *widget);
 565 void       gtk_widget_hide                (GtkWidget           *widget);
 566 void       gtk_widget_show_all            (GtkWidget           *widget);
 567 void       gtk_widget_hide_all            (GtkWidget           *widget);
 568 void       gtk_widget_set_no_show_all     (GtkWidget           *widget,
 569                                            gboolean             no_show_all);
 570 gboolean   gtk_widget_get_no_show_all     (GtkWidget           *widget);
 571 void       gtk_widget_map                 (GtkWidget           *widget);
 572 void       gtk_widget_unmap               (GtkWidget           *widget);
 573 void       gtk_widget_realize             (GtkWidget           *widget);
 574 void       gtk_widget_unrealize           (GtkWidget           *widget);
 575
 576 /* Queuing draws */
 577 void       gtk_widget_queue_draw          (GtkWidget           *widget);
 578 void       gtk_widget_queue_draw_area     (GtkWidget           *widget,
 579                                            gint                 x,
 580                                            gint                 y,
 581                                            gint                 width,
 582                                            gint                 height);
 583 void       gtk_widget_queue_resize        (GtkWidget           *widget);
 584 void       gtk_widget_queue_resize_no_redraw (GtkWidget *widget);
 585 void       gtk_widget_size_request        (GtkWidget           *widget,
 586                                            GtkRequisition      *requisition);
 587 void       gtk_widget_size_allocate       (GtkWidget           *widget,
 588                                            GtkAllocation       *allocation);
 589 void       gtk_widget_get_child_requisition (GtkWidget         *widget,
 590                                              GtkRequisition    *requisition);
 591 void       gtk_widget_add_accelerator     (GtkWidget           *widget,
 592                                            const gchar         *accel_signal,
 593                                            GtkAccelGroup       *accel_group,
 594                                            guint                accel_key,
 595                                            GdkModifierType      accel_mods,
 596                                            GtkAccelFlags        accel_flags);
 597 gboolean   gtk_widget_remove_accelerator  (GtkWidget           *widget,
 598                                            GtkAccelGroup       *accel_group,
 599                                            guint                accel_key,
 600                                            GdkModifierType      accel_mods);
 601 void       gtk_widget_set_accel_path      (GtkWidget           *widget,
 602                                            const gchar         *accel_path,
 603                                            GtkAccelGroup       *accel_group);
 604 const gchar* _gtk_widget_get_accel_path   (GtkWidget           *widget,
 605                                            gboolean            *locked);
 606 GList*     gtk_widget_list_accel_closures (GtkWidget           *widget);
 607 gboolean   gtk_widget_can_activate_accel  (GtkWidget           *widget,
 608                                            guint                signal_id);
 609 gboolean   gtk_widget_mnemonic_activate   (GtkWidget           *widget,
 610                                            gboolean             group_cycling);
 611 gboolean   gtk_widget_event               (GtkWidget           *widget,
 612                                            GdkEvent            *event);
 613 gint       gtk_widget_send_expose         (GtkWidget           *widget,
 614                                            GdkEvent            *event);
 615 gboolean   gtk_widget_send_focus_change   (GtkWidget           *widget,
 616                                            GdkEvent            *event);
 617
 618 gboolean   gtk_widget_activate               (GtkWidget        *widget);
 619 gboolean   gtk_widget_set_scroll_adjustments (GtkWidget        *widget,
 620                                               GtkAdjustment    *hadjustment,
 621                                               GtkAdjustment    *vadjustment);
 622
 623 void       gtk_widget_reparent            (GtkWidget           *widget,
 624                                            GtkWidget           *new_parent);
 625 gboolean   gtk_widget_intersect           (GtkWidget           *widget,
 626                                            const GdkRectangle  *area,
 627                                            GdkRectangle        *intersection);
 628 GdkRegion *gtk_widget_region_intersect    (GtkWidget           *widget,
 629                                            const GdkRegion     *region);
 630
 631 void    gtk_widget_freeze_child_notify    (GtkWidget           *widget);
 632 void    gtk_widget_child_notify           (GtkWidget           *widget,
 633                                            const gchar         *child_property);
 634 void    gtk_widget_thaw_child_notify      (GtkWidget           *widget);
 635
 636 void       gtk_widget_set_can_focus       (GtkWidget           *widget,
 637                                            gboolean             can_focus);
 638 gboolean   gtk_widget_get_can_focus       (GtkWidget           *widget);
 639 gboolean   gtk_widget_has_focus           (GtkWidget           *widget);
 640 gboolean   gtk_widget_is_focus            (GtkWidget           *widget);
 641 void       gtk_widget_grab_focus          (GtkWidget           *widget);
 642
 643 void       gtk_widget_set_can_default     (GtkWidget           *widget,
 644                                            gboolean             can_default);
 645 gboolean   gtk_widget_get_can_default     (GtkWidget           *widget);
 646 gboolean   gtk_widget_has_default         (GtkWidget           *widget);
 647 void       gtk_widget_grab_default        (GtkWidget           *widget);
 648
 649 void      gtk_widget_set_receives_default (GtkWidget           *widget,
 650                                            gboolean             receives_default);
 651 gboolean  gtk_widget_get_receives_default (GtkWidget           *widget);
 652
 653 gboolean   gtk_widget_has_grab            (GtkWidget           *widget);
 654
 655 void                  gtk_widget_set_name               (GtkWidget    *widget,
 656                                                          const gchar  *name);
 657 G_CONST_RETURN gchar* gtk_widget_get_name               (GtkWidget    *widget);
 658
 659 void                  gtk_widget_set_state              (GtkWidget    *widget,
 660                                                          GtkStateType  state);
 661 GtkStateType          gtk_widget_get_state              (GtkWidget    *widget);
 662
 663 void                  gtk_widget_set_sensitive          (GtkWidget    *widget,
 664                                                          gboolean      sensitive);
 665 gboolean              gtk_widget_get_sensitive          (GtkWidget    *widget);
 666 gboolean              gtk_widget_is_sensitive           (GtkWidget    *widget);
 667
 668 void                  gtk_widget_set_visible            (GtkWidget    *widget,
 669                                                          gboolean      visible);
 670 gboolean              gtk_widget_get_visible            (GtkWidget    *widget);
 671
 672 void                  gtk_widget_set_has_window         (GtkWidget    *widget,
 673                                                          gboolean      has_window);
 674 gboolean              gtk_widget_get_has_window         (GtkWidget    *widget);
 675
 676 gboolean              gtk_widget_is_toplevel            (GtkWidget    *widget);
 677 gboolean              gtk_widget_is_drawable            (GtkWidget    *widget);
 678 void                  gtk_widget_set_realized           (GtkWidget    *widget,
 679                                                          gboolean      realized);
 680 gboolean              gtk_widget_get_realized           (GtkWidget    *widget);
 681 void                  gtk_widget_set_mapped             (GtkWidget    *widget,
 682                                                          gboolean      mapped);
 683 gboolean              gtk_widget_get_mapped             (GtkWidget    *widget);
 684
 685 void                  gtk_widget_set_app_paintable      (GtkWidget    *widget,
 686                                                          gboolean      app_paintable);
 687 gboolean              gtk_widget_get_app_paintable      (GtkWidget    *widget);
 688
 689 void                  gtk_widget_set_double_buffered    (GtkWidget    *widget,
 690                                                          gboolean      double_buffered);
 691 gboolean              gtk_widget_get_double_buffered    (GtkWidget    *widget);
 692
 693 void                  gtk_widget_set_redraw_on_allocate (GtkWidget    *widget,
 694                                                          gboolean      redraw_on_allocate);
 695
 696 void                  gtk_widget_set_parent             (GtkWidget    *widget,
 697                                                          GtkWidget    *parent);
 698 GtkWidget           * gtk_widget_get_parent             (GtkWidget    *widget);
 699
 700 void                  gtk_widget_set_parent_window      (GtkWidget    *widget,
 701                                                          GdkWindow    *parent_window);
 702 GdkWindow           * gtk_widget_get_parent_window      (GtkWidget    *widget);
 703
 704 void                  gtk_widget_set_child_visible      (GtkWidget    *widget,
 705                                                          gboolean      is_visible);
 706 gboolean              gtk_widget_get_child_visible      (GtkWidget    *widget);
 707
 708 void                  gtk_widget_set_window             (GtkWidget    *widget,
 709                                                          GdkWindow    *window);
 710 GdkWindow           * gtk_widget_get_window             (GtkWidget    *widget);
 711
 712 void                  gtk_widget_get_allocation         (GtkWidget     *widget,
 713                                                          GtkAllocation *allocation);
 714 void                  gtk_widget_set_allocation         (GtkWidget     *widget,
 715                                                          const GtkAllocation *allocation);
 716
 717 void                  gtk_widget_get_requisition        (GtkWidget     *widget,
 718                                                          GtkRequisition *requisition);
 719
 720 gboolean   gtk_widget_child_focus         (GtkWidget           *widget,
 721                                            GtkDirectionType     direction);
 722 gboolean   gtk_widget_keynav_failed       (GtkWidget           *widget,
 723                                            GtkDirectionType     direction);
 724 void       gtk_widget_error_bell          (GtkWidget           *widget);
 725
 726 void       gtk_widget_set_size_request    (GtkWidget           *widget,
 727                                            gint                 width,
 728                                            gint                 height);
 729 void       gtk_widget_get_size_request    (GtkWidget           *widget,
 730                                            gint                *width,
 731                                            gint                *height);
 732 void       gtk_widget_set_events          (GtkWidget           *widget,
 733                                            gint                 events);
 734 void       gtk_widget_add_events          (GtkWidget           *widget,
 735                                            gint                 events);
 736 void       gtk_widget_set_extension_events (GtkWidget           *widget,
 737                                             GdkExtensionMode    mode);
 738
 739 GdkExtensionMode gtk_widget_get_extension_events (GtkWidget     *widget);
 740 GtkWidget*   gtk_widget_get_toplevel    (GtkWidget      *widget);
 741 GtkWidget*   gtk_widget_get_ancestor    (GtkWidget      *widget,
 742                                          GType           widget_type);
 743 GdkColormap* gtk_widget_get_colormap    (GtkWidget      *widget);
 744 GdkVisual*   gtk_widget_get_visual      (GtkWidget      *widget);
 745
 746 GdkScreen *   gtk_widget_get_screen      (GtkWidget *widget);
 747 gboolean      gtk_widget_has_screen      (GtkWidget *widget);
 748 GdkDisplay *  gtk_widget_get_display     (GtkWidget *widget);
 749 GdkWindow *   gtk_widget_get_root_window (GtkWidget *widget);
 750 GtkSettings*  gtk_widget_get_settings    (GtkWidget *widget);
 751 GtkClipboard *gtk_widget_get_clipboard   (GtkWidget *widget,
 752                                           GdkAtom    selection);
 753 GdkPixmap *   gtk_widget_get_snapshot    (GtkWidget    *widget,
 754                                           GdkRectangle *clip_rect);
 755
 756 /* Accessibility support */
 757 AtkObject*       gtk_widget_get_accessible               (GtkWidget          *widget);
 758
 759 /* The following functions must not be called on an already
 760  * realized widget. Because it is possible that somebody
 761  * can call get_colormap() or get_visual() and save the
 762  * result, these functions are probably only safe to
 763  * call in a widget's init() function.
 764  */
 765 void         gtk_widget_set_colormap    (GtkWidget      *widget,
 766                                          GdkColormap    *colormap);
 767
 768 gint         gtk_widget_get_events      (GtkWidget      *widget);
 769 void         gtk_widget_get_pointer     (GtkWidget      *widget,
 770                                          gint           *x,
 771                                          gint           *y);
 772
 773 gboolean     gtk_widget_is_ancestor     (GtkWidget      *widget,
 774                                          GtkWidget      *ancestor);
 775
 776 gboolean     gtk_widget_translate_coordinates (GtkWidget  *src_widget,
 777                                                GtkWidget  *dest_widget,
 778                                                gint        src_x,
 779                                                gint        src_y,
 780                                                gint       *dest_x,
 781                                                gint       *dest_y);
 782
 783 /* Hide widget and return TRUE.
 784  */
 785 gboolean     gtk_widget_hide_on_delete  (GtkWidget      *widget);
 786
 787 /* Widget styles.
 788  */
 789 void        gtk_widget_style_attach       (GtkWidget            *style);
 790
 791 gboolean    gtk_widget_has_rc_style       (GtkWidget            *widget);
 792 void        gtk_widget_set_style          (GtkWidget            *widget,
 793                                            GtkStyle             *style);
 794 void        gtk_widget_ensure_style       (GtkWidget            *widget);
 795 GtkStyle *  gtk_widget_get_style          (GtkWidget            *widget);
 796
 797 void        gtk_widget_modify_style       (GtkWidget            *widget,
 798                                            GtkRcStyle           *style);
 799 GtkRcStyle *gtk_widget_get_modifier_style (GtkWidget            *widget);
 800 void        gtk_widget_modify_fg          (GtkWidget            *widget,
 801                                            GtkStateType          state,
 802                                            const GdkColor       *color);
 803 void        gtk_widget_modify_bg          (GtkWidget            *widget,
 804                                            GtkStateType          state,
 805                                            const GdkColor       *color);
 806 void        gtk_widget_modify_text        (GtkWidget            *widget,
 807                                            GtkStateType          state,
 808                                            const GdkColor       *color);
 809 void        gtk_widget_modify_base        (GtkWidget            *widget,
 810                                            GtkStateType          state,
 811                                            const GdkColor       *color);
 812 void        gtk_widget_modify_cursor      (GtkWidget            *widget,
 813                                            const GdkColor       *primary,
 814                                            const GdkColor       *secondary);
 815 void        gtk_widget_modify_font        (GtkWidget            *widget,
 816                                            PangoFontDescription *font_desc);
 817 void        gtk_widget_modify_symbolic_color (GtkWidget         *widget,
 818                                            const gchar          *name,
 819                                            const GdkColor       *color);
 820
 821 PangoContext *gtk_widget_create_pango_context (GtkWidget   *widget);
 822 PangoContext *gtk_widget_get_pango_context    (GtkWidget   *widget);
 823 PangoLayout  *gtk_widget_create_pango_layout  (GtkWidget   *widget,
 824                                                const gchar *text);
 825
 826 GdkPixbuf    *gtk_widget_render_icon          (GtkWidget   *widget,
 827                                                const gchar *stock_id,
 828                                                GtkIconSize  size,
 829                                                const gchar *detail);
 830
 831 /* handle composite names for GTK_COMPOSITE_CHILD widgets,
 832  * the returned name is newly allocated.
 833  */
 834 void   gtk_widget_set_composite_name    (GtkWidget      *widget,
 835                                          const gchar    *name);
 836 gchar* gtk_widget_get_composite_name    (GtkWidget      *widget);
 837
 838 /* Descend recursively and set rc-style on all widgets without user styles */
 839 void       gtk_widget_reset_rc_styles   (GtkWidget      *widget);
 840
 841 /* Push/pop pairs, to change default values upon a widget's creation.
 842  * This will override the values that got set by the
 843  * gtk_widget_set_default_* () functions.
 844  */
 845 void         gtk_widget_push_colormap        (GdkColormap *cmap);
 846 void         gtk_widget_push_composite_child (void);
 847 void         gtk_widget_pop_composite_child  (void);
 848 void         gtk_widget_pop_colormap         (void);
 849
 850 /* widget style properties
 851  */
 852 void gtk_widget_class_install_style_property        (GtkWidgetClass     *klass,
 853                                                      GParamSpec         *pspec);
 854 void gtk_widget_class_install_style_property_parser (GtkWidgetClass     *klass,
 855                                                      GParamSpec         *pspec,
 856                                                      GtkRcPropertyParser parser);
 857 GParamSpec*  gtk_widget_class_find_style_property   (GtkWidgetClass     *klass,
 858                                                      const gchar        *property_name);
 859 GParamSpec** gtk_widget_class_list_style_properties (GtkWidgetClass     *klass,
 860                                                      guint              *n_properties);
 861 void gtk_widget_style_get_property (GtkWidget        *widget,
 862                                     const gchar    *property_name,
 863                                     GValue           *value);
 864 void gtk_widget_style_get_valist   (GtkWidget        *widget,
 865                                     const gchar    *first_property_name,
 866                                     va_list         var_args);
 867 void gtk_widget_style_get          (GtkWidget        *widget,
 868                                     const gchar    *first_property_name,
 869                                     ...) G_GNUC_NULL_TERMINATED;
 870
 871
 872 /* Set certain default values to be used at widget creation time.
 873  */
 874 void         gtk_widget_set_default_colormap (GdkColormap *colormap);
 875 GtkStyle*    gtk_widget_get_default_style    (void);
 876 #ifndef GDK_MULTIHEAD_SAFE
 877 GdkColormap* gtk_widget_get_default_colormap (void);
 878 GdkVisual*   gtk_widget_get_default_visual   (void);
 879 #endif
 880
 881 /* Functions for setting directionality for widgets
 882  */
 883
 884 void             gtk_widget_set_direction         (GtkWidget        *widget,
 885                                                    GtkTextDirection  dir);
 886 GtkTextDirection gtk_widget_get_direction         (GtkWidget        *widget);
 887
 888 void             gtk_widget_set_default_direction (GtkTextDirection  dir);
 889 GtkTextDirection gtk_widget_get_default_direction (void);
 890
 891 /* Compositing manager functionality */
 892 gboolean gtk_widget_is_composited (GtkWidget *widget);
 893
 894 /* Counterpart to gdk_window_shape_combine_mask.
 895  */
 896 void         gtk_widget_shape_combine_mask (GtkWidget *widget,
 897                                             GdkBitmap *shape_mask,
 898                                             gint       offset_x,
 899                                             gint       offset_y);
 900 void         gtk_widget_input_shape_combine_mask (GtkWidget *widget,
 901                                                   GdkBitmap *shape_mask,
 902                                                   gint       offset_x,
 903                                                   gint       offset_y);
 904
 905 /* internal function */
 906 void         gtk_widget_reset_shapes       (GtkWidget *widget);
 907
 908 /* Compute a widget's path in the form "GtkWindow.MyLabel", and
 909  * return newly alocated strings.
 910  */
 911 void         gtk_widget_path               (GtkWidget *widget,
 912                                             guint     *path_length,
 913                                             gchar    **path,
 914                                             gchar    **path_reversed);
 915 void         gtk_widget_class_path         (GtkWidget *widget,
 916                                             guint     *path_length,
 917                                             gchar    **path,
 918                                             gchar    **path_reversed);
 919
 920 GList* gtk_widget_list_mnemonic_labels  (GtkWidget *widget);
 921 void   gtk_widget_add_mnemonic_label    (GtkWidget *widget,
 922                                          GtkWidget *label);
 923 void   gtk_widget_remove_mnemonic_label (GtkWidget *widget,
 924                                          GtkWidget *label);
 925
 926 void                  gtk_widget_set_tooltip_window    (GtkWidget   *widget,
 927                                                         GtkWindow   *custom_window);
 928 GtkWindow *gtk_widget_get_tooltip_window    (GtkWidget   *widget);
 929 void       gtk_widget_trigger_tooltip_query (GtkWidget   *widget);
 930 void       gtk_widget_set_tooltip_text      (GtkWidget   *widget,
 931                                              const gchar *text);
 932 gchar *    gtk_widget_get_tooltip_text      (GtkWidget   *widget);
 933 void       gtk_widget_set_tooltip_markup    (GtkWidget   *widget,
 934                                              const gchar *markup);
 935 gchar *    gtk_widget_get_tooltip_markup    (GtkWidget   *widget);
 936 void       gtk_widget_set_has_tooltip       (GtkWidget   *widget,
 937                                              gboolean     has_tooltip);
 938 gboolean   gtk_widget_get_has_tooltip       (GtkWidget   *widget);
 939
 940 GType           gtk_requisition_get_type (void) G_GNUC_CONST;
 941 GtkRequisition *gtk_requisition_copy     (const GtkRequisition *requisition);
 942 void            gtk_requisition_free     (GtkRequisition       *requisition);
 943
 944 void              _gtk_widget_set_has_default             (GtkWidget    *widget,
 945                                                            gboolean      has_default);
 946 void              _gtk_widget_set_has_grab                (GtkWidget    *widget,
 947                                                            gboolean      has_grab);
 948 void              _gtk_widget_set_is_toplevel             (GtkWidget    *widget,
 949                                                            gboolean      is_toplevel);
 950
 951 void              _gtk_widget_grab_notify                 (GtkWidget    *widget,
 952                                                            gboolean     was_grabbed);
 953
 954 GtkWidgetAuxInfo *_gtk_widget_get_aux_info                (GtkWidget    *widget,
 955                                                            gboolean      create);
 956 void              _gtk_widget_propagate_hierarchy_changed (GtkWidget    *widget,
 957                                                            GtkWidget    *previous_toplevel);
 958 void              _gtk_widget_propagate_screen_changed    (GtkWidget    *widget,
 959                                                            GdkScreen    *previous_screen);
 960 void              _gtk_widget_propagate_composited_changed (GtkWidget    *widget);
 961
 962 void       _gtk_widget_set_pointer_window  (GtkWidget      *widget,
 963                                             GdkWindow      *pointer_window);
 964 GdkWindow *_gtk_widget_get_pointer_window  (GtkWidget      *widget);
 965 gboolean   _gtk_widget_is_pointer_widget   (GtkWidget      *widget);
 966 void       _gtk_widget_synthesize_crossing (GtkWidget      *from,
 967                                             GtkWidget      *to,
 968                                             GdkCrossingMode mode);
 969
 970 GdkColormap* _gtk_widget_peek_colormap (void);
 971
 972 void         _gtk_widget_buildable_finish_accelerator (GtkWidget *widget,
 973                                                        GtkWidget *toplevel,
 974                                                        gpointer   user_data);
 975
 976 G_END_DECLS
 977
 978 #endif /* __GTK_WIDGET_H__ */