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/gtkadjustment.h>
  37 #include <gtk/gtkborder.h>
  38 #include <gtk/gtksettings.h>
  39 #include <gtk/gtkstylecontext.h>
  40 #include <gtk/gtkwidgetpath.h>
  41 #include <atk/atk.h>
  42
  43 G_BEGIN_DECLS
  44
  45 /* Kinds of widget-specific help */
  46 typedef enum
  47 {
  48   GTK_WIDGET_HELP_TOOLTIP,
  49   GTK_WIDGET_HELP_WHATS_THIS
  50 } GtkWidgetHelpType;
  51
  52 /* Macro for casting a pointer to a GtkWidget or GtkWidgetClass pointer.
  53  * Macros for testing whether `widget' or `klass' are of type GTK_TYPE_WIDGET.
  54  */
  55 #define GTK_TYPE_WIDGET                   (gtk_widget_get_type ())
  56 #define GTK_WIDGET(widget)                (G_TYPE_CHECK_INSTANCE_CAST ((widget), GTK_TYPE_WIDGET, GtkWidget))
  57 #define GTK_WIDGET_CLASS(klass)           (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WIDGET, GtkWidgetClass))
  58 #define GTK_IS_WIDGET(widget)             (G_TYPE_CHECK_INSTANCE_TYPE ((widget), GTK_TYPE_WIDGET))
  59 #define GTK_IS_WIDGET_CLASS(klass)        (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WIDGET))
  60 #define GTK_WIDGET_GET_CLASS(obj)         (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WIDGET, GtkWidgetClass))
  61
  62 #define GTK_TYPE_REQUISITION              (gtk_requisition_get_type ())
  63
  64 /* forward declaration to avoid excessive includes (and concurrent includes)
  65  */
  66 typedef struct _GtkRequisition         GtkRequisition;
  67 typedef struct _GtkSelectionData       GtkSelectionData;
  68 typedef struct _GtkWidgetPrivate       GtkWidgetPrivate;
  69 typedef struct _GtkWidgetClass         GtkWidgetClass;
  70 typedef struct _GtkWidgetClassPrivate  GtkWidgetClassPrivate;
  71 typedef struct _GtkWidgetAuxInfo       GtkWidgetAuxInfo;
  72 typedef struct _GtkClipboard           GtkClipboard;
  73 typedef struct _GtkTooltip             GtkTooltip;
  74 typedef struct _GtkWindow              GtkWindow;
  75
  76 /**
  77  * GtkAllocation:
  78  * @x: the X position of the widget's area relative to its parents allocation.
  79  * @y: the Y position of the widget's area relative to its parents allocation.
  80  * @width: the width of the widget's allocated area.
  81  * @height: the height of the widget's allocated area.
  82  *
  83  * A <structname>GtkAllocation</structname> of a widget represents region
  84  * which has been allocated to the widget by its parent. It is a subregion
  85  * of its parents allocation. See <xref linkend="geometry-management"/> for
  86  * more information.
  87  */
  88 typedef         GdkRectangle       GtkAllocation;
  89
  90 /**
  91  * GtkCallback:
  92  * @widget: the widget to operate on
  93  * @data: user-supplied data
  94  *
  95  * The type of the callback functions used for e.g. iterating over
  96  * the children of a container, see gtk_container_foreach().
  97  */
  98 typedef void    (*GtkCallback)     (GtkWidget        *widget,
  99                                     gpointer          data);
 100
 101 /**
 102  * GtkRequisition:
 103  * @width: the widget's desired width
 104  * @height: the widget's desired height
 105  *
 106  * A <structname>GtkRequisition</structname> represents the desired size of a widget. See
 107  * <xref linkend="geometry-management"/> for more information.
 108  */
 109 struct _GtkRequisition
 110 {
 111   gint width;
 112   gint height;
 113 };
 114
 115 /* The widget is the base of the tree for displayable objects.
 116  *  (A displayable object is one which takes up some amount
 117  *  of screen real estate). It provides a common base and interface
 118  *  which actual widgets must adhere to.
 119  */
 120 struct _GtkWidget
 121 {
 122   GInitiallyUnowned parent_instance;
 123
 124   GtkWidgetPrivate *priv;
 125 };
 126
 127 /**
 128  * GtkWidgetClass:
 129  * @parent_class: The object class structure needs to be the first
 130  *   element in the widget class structure in order for the class mechanism
 131  *   to work correctly. This allows a GtkWidgetClass pointer to be cast to
 132  *   a GObjectClass pointer.
 133  * @activate_signal: The signal to emit when a widget of this class is
 134  *   activated, gtk_widget_activate() handles the emission.
 135  *   Implementation of this signal is optional.
 136  * @get_request_mode: This allows a widget to tell its parent container whether
 137  *   it prefers to be allocated in %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH or
 138  *   %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT mode.
 139  *   %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH means the widget prefers to have
 140  *   #GtkWidgetClass.get_preferred_width() called and then
 141  *   #GtkWidgetClass.get_preferred_height_for_width().
 142  *   %GTK_SIZE_REQUEST_CONSTANT_SIZE disables any height-for-width or
 143  *   width-for-height geometry management for a said widget and is the
 144  *   default return.
 145  *   It's important to note (as described below) that any widget
 146  *   which trades height-for-width or width-for-height must respond properly
 147  *   to both of the virtual methods #GtkWidgetClass.get_preferred_height_for_width()
 148  *   and #GtkWidgetClass.get_preferred_width_for_height() since it might be
 149  *   queried in either #GtkSizeRequestMode by its parent container.
 150  * @get_preferred_height: This is called by containers to obtain the minimum
 151  *   and natural height of a widget. A widget that does not actually trade
 152  *   any height for width or width for height only has to implement these
 153  *   two virtual methods (#GtkWidgetClass.get_preferred_width() and
 154  *   #GtkWidgetClass.get_preferred_height()).
 155  * @get_preferred_width_for_height: This is analogous to
 156  *   #GtkWidgetClass.get_preferred_height_for_width() except that it
 157  *   operates in the oposite orientation. It's rare that a widget actually
 158  *   does %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT requests but this can happen
 159  *   when, for example, a widget or container gets additional columns to
 160  *   compensate for a smaller allocated height.
 161  * @get_preferred_width: This is called by containers to obtain the minimum
 162  *   and natural width of a widget. A widget will never be allocated a width
 163  *   less than its minimum and will only ever be allocated a width greater
 164  *   than the natural width once all of the said widget's siblings have
 165  *   received their natural widths.
 166  *   Furthermore, a widget will only ever be allocated a width greater than
 167  *   its natural width if it was configured to receive extra expand space
 168  *   from its parent container.
 169  * @get_preferred_height_for_width: This is similar to
 170  *   #GtkWidgetClass.get_preferred_height() except that it is passed a
 171  *   contextual width to request height for. By implementing this virtual
 172  *   method it is possible for a #GtkLabel to tell its parent how much height
 173  *   would be required if the label were to be allocated a said width.
 174  * @adjust_size_request: Convert an initial size request from a widget's
 175  *   #GtkSizeRequest virtual method implementations into a size request to
 176  *   be used by parent containers in laying out the widget.
 177  *   adjust_size_request adjusts <emphasis>from</emphasis> a child widget's
 178  *   original request <emphasis>to</emphasis> what a parent container should
 179  *   use for layout. The @for_size argument will be -1 if the request should
 180  *   not be for a particular size in the opposing orientation, i.e. if the
 181  *   request is not height-for-width or width-for-height. If @for_size is
 182  *   greater than -1, it is the proposed allocation in the opposing
 183  *   orientation that we need the request for. Implementations of
 184  *   adjust_size_request should chain up to the default implementation,
 185  *   which applies #GtkWidget's margin properties and imposes any values
 186  *   from gtk_widget_set_size_request(). Chaining up should be last,
 187  *   <emphasis>after</emphasis> your subclass adjusts the request, so
 188  *   #GtkWidget can apply constraints and add the margin properly.
 189  * @adjust_size_allocation: Convert an initial size allocation assigned
 190  *   by a #GtkContainer using gtk_widget_size_allocate(), into an actual
 191  *   size allocation to be used by the widget. adjust_size_allocation
 192  *   adjusts <emphasis>to</emphasis> a child widget's actual allocation
 193  *   <emphasis>from</emphasis> what a parent container computed for the
 194  *   child. The adjusted allocation must be entirely within the original
 195  *   allocation. In any custom implementation, chain up to the default
 196  *   #GtkWidget implementation of this method, which applies the margin
 197  *   and alignment properties of #GtkWidget. Chain up
 198  *   <emphasis>before</emphasis> performing your own adjustments so your
 199  *   own adjustments remove more allocation after the #GtkWidget base
 200  *   class has already removed margin and alignment. The natural size
 201  *   passed in should be adjusted in the same way as the allocated size,
 202  *   which allows adjustments to perform alignments or other changes
 203  *   based on natural size.
 204  */
 205 struct _GtkWidgetClass
 206 {
 207   GInitiallyUnownedClass parent_class;
 208
 209   /*< public >*/
 210
 211   guint activate_signal;
 212
 213   /* seldomly overidden */
 214   void (*dispatch_child_properties_changed) (GtkWidget   *widget,
 215                                              guint        n_pspecs,
 216                                              GParamSpec **pspecs);
 217
 218   /* basics */
 219   void (* destroy)             (GtkWidget        *widget);
 220   void (* show)                (GtkWidget        *widget);
 221   void (* show_all)            (GtkWidget        *widget);
 222   void (* hide)                (GtkWidget        *widget);
 223   void (* map)                 (GtkWidget        *widget);
 224   void (* unmap)               (GtkWidget        *widget);
 225   void (* realize)             (GtkWidget        *widget);
 226   void (* unrealize)           (GtkWidget        *widget);
 227   void (* size_allocate)       (GtkWidget        *widget,
 228                                 GtkAllocation    *allocation);
 229   void (* state_changed)       (GtkWidget        *widget,
 230                                 GtkStateType      previous_state);
 231   void (* state_flags_changed) (GtkWidget        *widget,
 232                                 GtkStateFlags     previous_state_flags);
 233   void (* parent_set)          (GtkWidget        *widget,
 234                                 GtkWidget        *previous_parent);
 235   void (* hierarchy_changed)   (GtkWidget        *widget,
 236                                 GtkWidget        *previous_toplevel);
 237   void (* style_set)           (GtkWidget        *widget,
 238                                 GtkStyle         *previous_style);
 239   void (* direction_changed)   (GtkWidget        *widget,
 240                                 GtkTextDirection  previous_direction);
 241   void (* grab_notify)         (GtkWidget        *widget,
 242                                 gboolean          was_grabbed);
 243   void (* child_notify)        (GtkWidget        *widget,
 244                                 GParamSpec       *pspec);
 245   gboolean (* draw)            (GtkWidget        *widget,
 246                                 cairo_t          *cr);
 247
 248   /* size requests */
 249   GtkSizeRequestMode (* get_request_mode)               (GtkWidget      *widget);
 250
 251   void               (* get_preferred_height)           (GtkWidget       *widget,
 252                                                          gint            *minimum_height,
 253                                                          gint            *natural_height);
 254   void               (* get_preferred_width_for_height) (GtkWidget       *widget,
 255                                                          gint             height,
 256                                                          gint            *minimum_width,
 257                                                          gint            *natural_width);
 258   void               (* get_preferred_width)            (GtkWidget       *widget,
 259                                                          gint            *minimum_width,
 260                                                          gint            *natural_width);
 261   void               (* get_preferred_height_for_width) (GtkWidget       *widget,
 262                                                          gint             width,
 263                                                          gint            *minimum_height,
 264                                                          gint            *natural_height);
 265
 266   /* Mnemonics */
 267   gboolean (* mnemonic_activate)        (GtkWidget           *widget,
 268                                          gboolean             group_cycling);
 269
 270   /* explicit focus */
 271   void     (* grab_focus)               (GtkWidget           *widget);
 272   gboolean (* focus)                    (GtkWidget           *widget,
 273                                          GtkDirectionType     direction);
 274
 275   /* keyboard navigation */
 276   void     (* move_focus)               (GtkWidget           *widget,
 277                                          GtkDirectionType     direction);
 278   gboolean (* keynav_failed)            (GtkWidget           *widget,
 279                                          GtkDirectionType     direction);
 280
 281   /* events */
 282   gboolean (* event)                    (GtkWidget           *widget,
 283                                          GdkEvent            *event);
 284   gboolean (* button_press_event)       (GtkWidget           *widget,
 285                                          GdkEventButton      *event);
 286   gboolean (* button_release_event)     (GtkWidget           *widget,
 287                                          GdkEventButton      *event);
 288   gboolean (* scroll_event)             (GtkWidget           *widget,
 289                                          GdkEventScroll      *event);
 290   gboolean (* motion_notify_event)      (GtkWidget           *widget,
 291                                          GdkEventMotion      *event);
 292   gboolean (* delete_event)             (GtkWidget           *widget,
 293                                          GdkEventAny         *event);
 294   gboolean (* destroy_event)            (GtkWidget           *widget,
 295                                          GdkEventAny         *event);
 296   gboolean (* key_press_event)          (GtkWidget           *widget,
 297                                          GdkEventKey         *event);
 298   gboolean (* key_release_event)        (GtkWidget           *widget,
 299                                          GdkEventKey         *event);
 300   gboolean (* enter_notify_event)       (GtkWidget           *widget,
 301                                          GdkEventCrossing    *event);
 302   gboolean (* leave_notify_event)       (GtkWidget           *widget,
 303                                          GdkEventCrossing    *event);
 304   gboolean (* configure_event)          (GtkWidget           *widget,
 305                                          GdkEventConfigure   *event);
 306   gboolean (* focus_in_event)           (GtkWidget           *widget,
 307                                          GdkEventFocus       *event);
 308   gboolean (* focus_out_event)          (GtkWidget           *widget,
 309                                          GdkEventFocus       *event);
 310   gboolean (* map_event)                (GtkWidget           *widget,
 311                                          GdkEventAny         *event);
 312   gboolean (* unmap_event)              (GtkWidget           *widget,
 313                                          GdkEventAny         *event);
 314   gboolean (* property_notify_event)    (GtkWidget           *widget,
 315                                          GdkEventProperty    *event);
 316   gboolean (* selection_clear_event)    (GtkWidget           *widget,
 317                                          GdkEventSelection   *event);
 318   gboolean (* selection_request_event)  (GtkWidget           *widget,
 319                                          GdkEventSelection   *event);
 320   gboolean (* selection_notify_event)   (GtkWidget           *widget,
 321                                          GdkEventSelection   *event);
 322   gboolean (* proximity_in_event)       (GtkWidget           *widget,
 323                                          GdkEventProximity   *event);
 324   gboolean (* proximity_out_event)      (GtkWidget           *widget,
 325                                          GdkEventProximity   *event);
 326   gboolean (* visibility_notify_event)  (GtkWidget           *widget,
 327                                          GdkEventVisibility  *event);
 328   gboolean (* window_state_event)       (GtkWidget           *widget,
 329                                          GdkEventWindowState *event);
 330   gboolean (* damage_event)             (GtkWidget           *widget,
 331                                          GdkEventExpose      *event);
 332   gboolean (* grab_broken_event)        (GtkWidget           *widget,
 333                                          GdkEventGrabBroken  *event);
 334
 335   /* selection */
 336   void     (* selection_get)       (GtkWidget          *widget,
 337                                     GtkSelectionData   *selection_data,
 338                                     guint               info,
 339                                     guint               time_);
 340   void     (* selection_received)  (GtkWidget          *widget,
 341                                     GtkSelectionData   *selection_data,
 342                                     guint               time_);
 343
 344   /* Source side drag signals */
 345   void     (* drag_begin)          (GtkWidget         *widget,
 346                                     GdkDragContext     *context);
 347   void     (* drag_end)            (GtkWidget          *widget,
 348                                     GdkDragContext     *context);
 349   void     (* drag_data_get)       (GtkWidget          *widget,
 350                                     GdkDragContext     *context,
 351                                     GtkSelectionData   *selection_data,
 352                                     guint               info,
 353                                     guint               time_);
 354   void     (* drag_data_delete)    (GtkWidget          *widget,
 355                                     GdkDragContext     *context);
 356
 357   /* Target side drag signals */
 358   void     (* drag_leave)          (GtkWidget          *widget,
 359                                     GdkDragContext     *context,
 360                                     guint               time_);
 361   gboolean (* drag_motion)         (GtkWidget          *widget,
 362                                     GdkDragContext     *context,
 363                                     gint                x,
 364                                     gint                y,
 365                                     guint               time_);
 366   gboolean (* drag_drop)           (GtkWidget          *widget,
 367                                     GdkDragContext     *context,
 368                                     gint                x,
 369                                     gint                y,
 370                                     guint               time_);
 371   void     (* drag_data_received)  (GtkWidget          *widget,
 372                                     GdkDragContext     *context,
 373                                     gint                x,
 374                                     gint                y,
 375                                     GtkSelectionData   *selection_data,
 376                                     guint               info,
 377                                     guint               time_);
 378   gboolean (* drag_failed)         (GtkWidget          *widget,
 379                                     GdkDragContext     *context,
 380                                     GtkDragResult       result);
 381
 382   /* Signals used only for keybindings */
 383   gboolean (* popup_menu)          (GtkWidget          *widget);
 384
 385   /* If a widget has multiple tooltips/whatsthis, it should show the
 386    * one for the current focus location, or if that doesn't make
 387    * sense, should cycle through them showing each tip alongside
 388    * whatever piece of the widget it applies to.
 389    */
 390   gboolean (* show_help)           (GtkWidget          *widget,
 391                                     GtkWidgetHelpType   help_type);
 392
 393   /* accessibility support
 394    */
 395   AtkObject *  (* get_accessible)     (GtkWidget *widget);
 396
 397   void         (* screen_changed)     (GtkWidget *widget,
 398                                        GdkScreen *previous_screen);
 399   gboolean     (* can_activate_accel) (GtkWidget *widget,
 400                                        guint      signal_id);
 401
 402
 403   void         (* composited_changed) (GtkWidget *widget);
 404
 405   gboolean     (* query_tooltip)      (GtkWidget  *widget,
 406                                        gint        x,
 407                                        gint        y,
 408                                        gboolean    keyboard_tooltip,
 409                                        GtkTooltip *tooltip);
 410
 411   void         (* compute_expand)     (GtkWidget  *widget,
 412                                        gboolean   *hexpand_p,
 413                                        gboolean   *vexpand_p);
 414
 415   void         (* adjust_size_request)    (GtkWidget         *widget,
 416                                            GtkOrientation     orientation,
 417                                            gint              *minimum_size,
 418                                            gint              *natural_size);
 419   void         (* adjust_size_allocation) (GtkWidget         *widget,
 420                                            GtkOrientation     orientation,
 421                                            gint              *minimum_size,
 422                                            gint              *natural_size,
 423                                            gint              *allocated_pos,
 424                                            gint              *allocated_size);
 425
 426   void         (* style_updated)          (GtkWidget *widget);
 427
 428   /*< private >*/
 429
 430   GtkWidgetClassPrivate *priv;
 431
 432   /* Padding for future expansion */
 433   void (*_gtk_reserved2) (void);
 434   void (*_gtk_reserved3) (void);
 435   void (*_gtk_reserved4) (void);
 436   void (*_gtk_reserved5) (void);
 437   void (*_gtk_reserved6) (void);
 438   void (*_gtk_reserved7) (void);
 439   void (*_gtk_reserved8) (void);
 440 };
 441
 442 struct _GtkWidgetAuxInfo
 443 {
 444   gint width;
 445   gint height;
 446
 447   guint   halign : 4;
 448   guint   valign : 4;
 449
 450   GtkBorder margin;
 451 };
 452
 453 GType      gtk_widget_get_type            (void) G_GNUC_CONST;
 454 GtkWidget* gtk_widget_new                 (GType                type,
 455                                            const gchar         *first_property_name,
 456                                            ...);
 457 void       gtk_widget_destroy             (GtkWidget           *widget);
 458 void       gtk_widget_destroyed           (GtkWidget           *widget,
 459                                            GtkWidget          **widget_pointer);
 460 void       gtk_widget_unparent            (GtkWidget           *widget);
 461 void       gtk_widget_show                (GtkWidget           *widget);
 462 void       gtk_widget_hide                (GtkWidget           *widget);
 463 void       gtk_widget_show_now            (GtkWidget           *widget);
 464 void       gtk_widget_show_all            (GtkWidget           *widget);
 465 void       gtk_widget_set_no_show_all     (GtkWidget           *widget,
 466                                            gboolean             no_show_all);
 467 gboolean   gtk_widget_get_no_show_all     (GtkWidget           *widget);
 468 void       gtk_widget_map                 (GtkWidget           *widget);
 469 void       gtk_widget_unmap               (GtkWidget           *widget);
 470 void       gtk_widget_realize             (GtkWidget           *widget);
 471 void       gtk_widget_unrealize           (GtkWidget           *widget);
 472
 473 void       gtk_widget_draw                (GtkWidget           *widget,
 474                                            cairo_t             *cr);
 475 /* Queuing draws */
 476 void       gtk_widget_queue_draw          (GtkWidget           *widget);
 477 void       gtk_widget_queue_draw_area     (GtkWidget           *widget,
 478                                            gint                 x,
 479                                            gint                 y,
 480                                            gint                 width,
 481                                            gint                 height);
 482 void       gtk_widget_queue_draw_region   (GtkWidget           *widget,
 483                                            const cairo_region_t*region);
 484 void       gtk_widget_queue_resize        (GtkWidget           *widget);
 485 void       gtk_widget_queue_resize_no_redraw (GtkWidget *widget);
 486 GDK_DEPRECATED_IN_3_0_FOR(gtk_widget_get_preferred_size)
 487 void       gtk_widget_size_request        (GtkWidget           *widget,
 488                                            GtkRequisition      *requisition);
 489 void       gtk_widget_size_allocate       (GtkWidget           *widget,
 490                                            GtkAllocation       *allocation);
 491
 492 GtkSizeRequestMode  gtk_widget_get_request_mode               (GtkWidget      *widget);
 493 void                gtk_widget_get_preferred_width            (GtkWidget      *widget,
 494                                                                gint           *minimum_width,
 495                                                                gint           *natural_width);
 496 void                gtk_widget_get_preferred_height_for_width (GtkWidget      *widget,
 497                                                                gint            width,
 498                                                                gint           *minimum_height,
 499                                                                gint           *natural_height);
 500 void                gtk_widget_get_preferred_height           (GtkWidget      *widget,
 501                                                                gint           *minimum_height,
 502                                                                gint           *natural_height);
 503 void                gtk_widget_get_preferred_width_for_height (GtkWidget      *widget,
 504                                                                gint            height,
 505                                                                gint           *minimum_width,
 506                                                                gint           *natural_width);
 507 void                gtk_widget_get_preferred_size             (GtkWidget      *widget,
 508                                                                GtkRequisition *minimum_size,
 509                                                                GtkRequisition *natural_size);
 510
 511 GDK_DEPRECATED_IN_3_0_FOR(gtk_widget_get_preferred_size)
 512 void       gtk_widget_get_child_requisition (GtkWidget         *widget,
 513                                              GtkRequisition    *requisition);
 514 void       gtk_widget_add_accelerator     (GtkWidget           *widget,
 515                                            const gchar         *accel_signal,
 516                                            GtkAccelGroup       *accel_group,
 517                                            guint                accel_key,
 518                                            GdkModifierType      accel_mods,
 519                                            GtkAccelFlags        accel_flags);
 520 gboolean   gtk_widget_remove_accelerator  (GtkWidget           *widget,
 521                                            GtkAccelGroup       *accel_group,
 522                                            guint                accel_key,
 523                                            GdkModifierType      accel_mods);
 524 void       gtk_widget_set_accel_path      (GtkWidget           *widget,
 525                                            const gchar         *accel_path,
 526                                            GtkAccelGroup       *accel_group);
 527 GList*     gtk_widget_list_accel_closures (GtkWidget           *widget);
 528 gboolean   gtk_widget_can_activate_accel  (GtkWidget           *widget,
 529                                            guint                signal_id);
 530 gboolean   gtk_widget_mnemonic_activate   (GtkWidget           *widget,
 531                                            gboolean             group_cycling);
 532 gboolean   gtk_widget_event               (GtkWidget           *widget,
 533                                            GdkEvent            *event);
 534 gint       gtk_widget_send_expose         (GtkWidget           *widget,
 535                                            GdkEvent            *event);
 536 gboolean   gtk_widget_send_focus_change   (GtkWidget           *widget,
 537                                            GdkEvent            *event);
 538
 539 gboolean   gtk_widget_activate               (GtkWidget        *widget);
 540
 541 void       gtk_widget_reparent            (GtkWidget           *widget,
 542                                            GtkWidget           *new_parent);
 543 gboolean   gtk_widget_intersect           (GtkWidget           *widget,
 544                                            const GdkRectangle  *area,
 545                                            GdkRectangle        *intersection);
 546 cairo_region_t *gtk_widget_region_intersect       (GtkWidget           *widget,
 547                                            const cairo_region_t     *region);
 548
 549 void    gtk_widget_freeze_child_notify    (GtkWidget           *widget);
 550 void    gtk_widget_child_notify           (GtkWidget           *widget,
 551                                            const gchar         *child_property);
 552 void    gtk_widget_thaw_child_notify      (GtkWidget           *widget);
 553
 554 void       gtk_widget_set_can_focus       (GtkWidget           *widget,
 555                                            gboolean             can_focus);
 556 gboolean   gtk_widget_get_can_focus       (GtkWidget           *widget);
 557 gboolean   gtk_widget_has_focus           (GtkWidget           *widget);
 558 gboolean   gtk_widget_is_focus            (GtkWidget           *widget);
 559 GDK_AVAILABLE_IN_3_2
 560 gboolean   gtk_widget_has_visible_focus   (GtkWidget           *widget);
 561 void       gtk_widget_grab_focus          (GtkWidget           *widget);
 562
 563 void       gtk_widget_set_can_default     (GtkWidget           *widget,
 564                                            gboolean             can_default);
 565 gboolean   gtk_widget_get_can_default     (GtkWidget           *widget);
 566 gboolean   gtk_widget_has_default         (GtkWidget           *widget);
 567 void       gtk_widget_grab_default        (GtkWidget           *widget);
 568
 569 void      gtk_widget_set_receives_default (GtkWidget           *widget,
 570                                            gboolean             receives_default);
 571 gboolean  gtk_widget_get_receives_default (GtkWidget           *widget);
 572
 573 gboolean   gtk_widget_has_grab            (GtkWidget           *widget);
 574
 575 gboolean   gtk_widget_device_is_shadowed  (GtkWidget           *widget,
 576                                            GdkDevice           *device);
 577
 578
 579 void                  gtk_widget_set_name               (GtkWidget    *widget,
 580                                                          const gchar  *name);
 581 const gchar *         gtk_widget_get_name               (GtkWidget    *widget);
 582
 583 void                  gtk_widget_set_state              (GtkWidget    *widget,
 584                                                          GtkStateType  state);
 585 GtkStateType          gtk_widget_get_state              (GtkWidget    *widget);
 586
 587 void                  gtk_widget_set_state_flags        (GtkWidget     *widget,
 588                                                          GtkStateFlags  flags,
 589                                                          gboolean       clear);
 590 void                  gtk_widget_unset_state_flags      (GtkWidget     *widget,
 591                                                          GtkStateFlags  flags);
 592 GtkStateFlags         gtk_widget_get_state_flags        (GtkWidget     *widget);
 593
 594 void                  gtk_widget_set_sensitive          (GtkWidget    *widget,
 595                                                          gboolean      sensitive);
 596 gboolean              gtk_widget_get_sensitive          (GtkWidget    *widget);
 597 gboolean              gtk_widget_is_sensitive           (GtkWidget    *widget);
 598
 599 void                  gtk_widget_set_visible            (GtkWidget    *widget,
 600                                                          gboolean      visible);
 601 gboolean              gtk_widget_get_visible            (GtkWidget    *widget);
 602
 603 void                  gtk_widget_set_has_window         (GtkWidget    *widget,
 604                                                          gboolean      has_window);
 605 gboolean              gtk_widget_get_has_window         (GtkWidget    *widget);
 606
 607 gboolean              gtk_widget_is_toplevel            (GtkWidget    *widget);
 608 gboolean              gtk_widget_is_drawable            (GtkWidget    *widget);
 609 void                  gtk_widget_set_realized           (GtkWidget    *widget,
 610                                                          gboolean      realized);
 611 gboolean              gtk_widget_get_realized           (GtkWidget    *widget);
 612 void                  gtk_widget_set_mapped             (GtkWidget    *widget,
 613                                                          gboolean      mapped);
 614 gboolean              gtk_widget_get_mapped             (GtkWidget    *widget);
 615
 616 void                  gtk_widget_set_app_paintable      (GtkWidget    *widget,
 617                                                          gboolean      app_paintable);
 618 gboolean              gtk_widget_get_app_paintable      (GtkWidget    *widget);
 619
 620 void                  gtk_widget_set_double_buffered    (GtkWidget    *widget,
 621                                                          gboolean      double_buffered);
 622 gboolean              gtk_widget_get_double_buffered    (GtkWidget    *widget);
 623
 624 void                  gtk_widget_set_redraw_on_allocate (GtkWidget    *widget,
 625                                                          gboolean      redraw_on_allocate);
 626
 627 void                  gtk_widget_set_parent             (GtkWidget    *widget,
 628                                                          GtkWidget    *parent);
 629 GtkWidget           * gtk_widget_get_parent             (GtkWidget    *widget);
 630
 631 void                  gtk_widget_set_parent_window      (GtkWidget    *widget,
 632                                                          GdkWindow    *parent_window);
 633 GdkWindow           * gtk_widget_get_parent_window      (GtkWidget    *widget);
 634
 635 void                  gtk_widget_set_child_visible      (GtkWidget    *widget,
 636                                                          gboolean      is_visible);
 637 gboolean              gtk_widget_get_child_visible      (GtkWidget    *widget);
 638
 639 void                  gtk_widget_set_window             (GtkWidget    *widget,
 640                                                          GdkWindow    *window);
 641 GdkWindow           * gtk_widget_get_window             (GtkWidget    *widget);
 642
 643 int                   gtk_widget_get_allocated_width    (GtkWidget     *widget);
 644 int                   gtk_widget_get_allocated_height   (GtkWidget     *widget);
 645
 646 void                  gtk_widget_get_allocation         (GtkWidget     *widget,
 647                                                          GtkAllocation *allocation);
 648 void                  gtk_widget_set_allocation         (GtkWidget     *widget,
 649                                                          const GtkAllocation *allocation);
 650
 651 void                  gtk_widget_get_requisition        (GtkWidget     *widget,
 652                                                          GtkRequisition *requisition);
 653
 654 gboolean   gtk_widget_child_focus         (GtkWidget           *widget,
 655                                            GtkDirectionType     direction);
 656 gboolean   gtk_widget_keynav_failed       (GtkWidget           *widget,
 657                                            GtkDirectionType     direction);
 658 void       gtk_widget_error_bell          (GtkWidget           *widget);
 659
 660 void       gtk_widget_set_size_request    (GtkWidget           *widget,
 661                                            gint                 width,
 662                                            gint                 height);
 663 void       gtk_widget_get_size_request    (GtkWidget           *widget,
 664                                            gint                *width,
 665                                            gint                *height);
 666 void       gtk_widget_set_events          (GtkWidget           *widget,
 667                                            gint                 events);
 668 void       gtk_widget_add_events          (GtkWidget           *widget,
 669                                            gint                 events);
 670 void       gtk_widget_set_device_events   (GtkWidget           *widget,
 671                                            GdkDevice           *device,
 672                                            GdkEventMask         events);
 673 void       gtk_widget_add_device_events   (GtkWidget           *widget,
 674                                            GdkDevice           *device,
 675                                            GdkEventMask         events);
 676
 677 void       gtk_widget_set_device_enabled  (GtkWidget    *widget,
 678                                            GdkDevice    *device,
 679                                            gboolean      enabled);
 680 gboolean   gtk_widget_get_device_enabled  (GtkWidget    *widget,
 681                                            GdkDevice    *device);
 682
 683 GtkWidget*   gtk_widget_get_toplevel    (GtkWidget      *widget);
 684 GtkWidget*   gtk_widget_get_ancestor    (GtkWidget      *widget,
 685                                          GType           widget_type);
 686 GdkVisual*   gtk_widget_get_visual      (GtkWidget      *widget);
 687 void         gtk_widget_set_visual      (GtkWidget      *widget,
 688                                          GdkVisual      *visual);
 689
 690 GdkScreen *   gtk_widget_get_screen      (GtkWidget *widget);
 691 gboolean      gtk_widget_has_screen      (GtkWidget *widget);
 692 GdkDisplay *  gtk_widget_get_display     (GtkWidget *widget);
 693 GdkWindow *   gtk_widget_get_root_window (GtkWidget *widget);
 694 GtkSettings*  gtk_widget_get_settings    (GtkWidget *widget);
 695 GtkClipboard *gtk_widget_get_clipboard   (GtkWidget *widget,
 696                                           GdkAtom    selection);
 697
 698
 699 /* Expand flags and related support */
 700 gboolean gtk_widget_get_hexpand          (GtkWidget      *widget);
 701 void     gtk_widget_set_hexpand          (GtkWidget      *widget,
 702                                           gboolean        expand);
 703 gboolean gtk_widget_get_hexpand_set      (GtkWidget      *widget);
 704 void     gtk_widget_set_hexpand_set      (GtkWidget      *widget,
 705                                           gboolean        set);
 706 gboolean gtk_widget_get_vexpand          (GtkWidget      *widget);
 707 void     gtk_widget_set_vexpand          (GtkWidget      *widget,
 708                                           gboolean        expand);
 709 gboolean gtk_widget_get_vexpand_set      (GtkWidget      *widget);
 710 void     gtk_widget_set_vexpand_set      (GtkWidget      *widget,
 711                                           gboolean        set);
 712 void     gtk_widget_queue_compute_expand (GtkWidget      *widget);
 713 gboolean gtk_widget_compute_expand       (GtkWidget      *widget,
 714                                           GtkOrientation  orientation);
 715
 716
 717 /* Multidevice support */
 718 gboolean         gtk_widget_get_support_multidevice (GtkWidget      *widget);
 719 void             gtk_widget_set_support_multidevice (GtkWidget      *widget,
 720                                                      gboolean        support_multidevice);
 721
 722 /* Accessibility support */
 723 GDK_AVAILABLE_IN_3_2
 724 void             gtk_widget_class_set_accessible_type    (GtkWidgetClass     *widget_class,
 725                                                           GType               type);
 726 GDK_AVAILABLE_IN_3_2
 727 void             gtk_widget_class_set_accessible_role    (GtkWidgetClass     *widget_class,
 728                                                           AtkRole             role);
 729 AtkObject*       gtk_widget_get_accessible               (GtkWidget          *widget);
 730
 731
 732 /* Margin and alignment */
 733 GtkAlign gtk_widget_get_halign        (GtkWidget *widget);
 734 void     gtk_widget_set_halign        (GtkWidget *widget,
 735                                        GtkAlign   align);
 736 GtkAlign gtk_widget_get_valign        (GtkWidget *widget);
 737 void     gtk_widget_set_valign        (GtkWidget *widget,
 738                                        GtkAlign   align);
 739 gint     gtk_widget_get_margin_left   (GtkWidget *widget);
 740 void     gtk_widget_set_margin_left   (GtkWidget *widget,
 741                                        gint       margin);
 742 gint     gtk_widget_get_margin_right  (GtkWidget *widget);
 743 void     gtk_widget_set_margin_right  (GtkWidget *widget,
 744                                        gint       margin);
 745 gint     gtk_widget_get_margin_top    (GtkWidget *widget);
 746 void     gtk_widget_set_margin_top    (GtkWidget *widget,
 747                                        gint       margin);
 748 gint     gtk_widget_get_margin_bottom (GtkWidget *widget);
 749 void     gtk_widget_set_margin_bottom (GtkWidget *widget,
 750                                        gint       margin);
 751
 752
 753 gint         gtk_widget_get_events      (GtkWidget      *widget);
 754 GdkEventMask gtk_widget_get_device_events (GtkWidget    *widget,
 755                                            GdkDevice    *device);
 756 GDK_DEPRECATED_IN_3_0_FOR(gdk_window_get_device_position)
 757 void         gtk_widget_get_pointer     (GtkWidget      *widget,
 758                                          gint           *x,
 759                                          gint           *y);
 760
 761 gboolean     gtk_widget_is_ancestor     (GtkWidget      *widget,
 762                                          GtkWidget      *ancestor);
 763
 764 gboolean     gtk_widget_translate_coordinates (GtkWidget  *src_widget,
 765                                                GtkWidget  *dest_widget,
 766                                                gint        src_x,
 767                                                gint        src_y,
 768                                                gint       *dest_x,
 769                                                gint       *dest_y);
 770
 771 /* Hide widget and return TRUE.
 772  */
 773 gboolean     gtk_widget_hide_on_delete  (GtkWidget      *widget);
 774
 775 /* Functions to override widget styling */
 776 void         gtk_widget_override_color            (GtkWidget     *widget,
 777                                                    GtkStateFlags  state,
 778                                                    const GdkRGBA *color);
 779 void         gtk_widget_override_background_color (GtkWidget     *widget,
 780                                                    GtkStateFlags  state,
 781                                                    const GdkRGBA *color);
 782
 783 void         gtk_widget_override_font             (GtkWidget                  *widget,
 784                                                    const PangoFontDescription *font_desc);
 785
 786 void         gtk_widget_override_symbolic_color   (GtkWidget     *widget,
 787                                                    const gchar   *name,
 788                                                    const GdkRGBA *color);
 789 void         gtk_widget_override_cursor           (GtkWidget       *widget,
 790                                                    const GdkRGBA   *cursor,
 791                                                    const GdkRGBA   *secondary_cursor);
 792
 793 void       gtk_widget_reset_style       (GtkWidget      *widget);
 794
 795 PangoContext *gtk_widget_create_pango_context (GtkWidget   *widget);
 796 PangoContext *gtk_widget_get_pango_context    (GtkWidget   *widget);
 797 PangoLayout  *gtk_widget_create_pango_layout  (GtkWidget   *widget,
 798                                                const gchar *text);
 799
 800 GdkPixbuf    *gtk_widget_render_icon_pixbuf   (GtkWidget   *widget,
 801                                                const gchar *stock_id,
 802                                                GtkIconSize  size);
 803
 804 /* handle composite names for GTK_COMPOSITE_CHILD widgets,
 805  * the returned name is newly allocated.
 806  */
 807 void   gtk_widget_set_composite_name    (GtkWidget      *widget,
 808                                          const gchar    *name);
 809 gchar* gtk_widget_get_composite_name    (GtkWidget      *widget);
 810
 811 /* Push/pop pairs, to change default values upon a widget's creation.
 812  * This will override the values that got set by the
 813  * gtk_widget_set_default_* () functions.
 814  */
 815 void         gtk_widget_push_composite_child (void);
 816 void         gtk_widget_pop_composite_child  (void);
 817
 818 /* widget style properties
 819  */
 820 void gtk_widget_class_install_style_property        (GtkWidgetClass     *klass,
 821                                                      GParamSpec         *pspec);
 822 void gtk_widget_class_install_style_property_parser (GtkWidgetClass     *klass,
 823                                                      GParamSpec         *pspec,
 824                                                      GtkRcPropertyParser parser);
 825 GParamSpec*  gtk_widget_class_find_style_property   (GtkWidgetClass     *klass,
 826                                                      const gchar        *property_name);
 827 GParamSpec** gtk_widget_class_list_style_properties (GtkWidgetClass     *klass,
 828                                                      guint              *n_properties);
 829 void gtk_widget_style_get_property (GtkWidget        *widget,
 830                                     const gchar    *property_name,
 831                                     GValue           *value);
 832 void gtk_widget_style_get_valist   (GtkWidget        *widget,
 833                                     const gchar    *first_property_name,
 834                                     va_list         var_args);
 835 void gtk_widget_style_get          (GtkWidget        *widget,
 836                                     const gchar    *first_property_name,
 837                                     ...) G_GNUC_NULL_TERMINATED;
 838
 839 /* Functions for setting directionality for widgets */
 840
 841 void             gtk_widget_set_direction         (GtkWidget        *widget,
 842                                                    GtkTextDirection  dir);
 843 GtkTextDirection gtk_widget_get_direction         (GtkWidget        *widget);
 844
 845 void             gtk_widget_set_default_direction (GtkTextDirection  dir);
 846 GtkTextDirection gtk_widget_get_default_direction (void);
 847
 848 /* Compositing manager functionality */
 849 gboolean gtk_widget_is_composited (GtkWidget *widget);
 850
 851 /* Counterpart to gdk_window_shape_combine_region.
 852  */
 853 void         gtk_widget_shape_combine_region (GtkWidget *widget,
 854                                               cairo_region_t *region);
 855 void         gtk_widget_input_shape_combine_region (GtkWidget *widget,
 856                                                     cairo_region_t *region);
 857
 858 GList* gtk_widget_list_mnemonic_labels  (GtkWidget *widget);
 859 void   gtk_widget_add_mnemonic_label    (GtkWidget *widget,
 860                                          GtkWidget *label);
 861 void   gtk_widget_remove_mnemonic_label (GtkWidget *widget,
 862                                          GtkWidget *label);
 863
 864 void                  gtk_widget_set_tooltip_window    (GtkWidget   *widget,
 865                                                         GtkWindow   *custom_window);
 866 GtkWindow *gtk_widget_get_tooltip_window    (GtkWidget   *widget);
 867 void       gtk_widget_trigger_tooltip_query (GtkWidget   *widget);
 868 void       gtk_widget_set_tooltip_text      (GtkWidget   *widget,
 869                                              const gchar *text);
 870 gchar *    gtk_widget_get_tooltip_text      (GtkWidget   *widget);
 871 void       gtk_widget_set_tooltip_markup    (GtkWidget   *widget,
 872                                              const gchar *markup);
 873 gchar *    gtk_widget_get_tooltip_markup    (GtkWidget   *widget);
 874 void       gtk_widget_set_has_tooltip       (GtkWidget   *widget,
 875                                              gboolean     has_tooltip);
 876 gboolean   gtk_widget_get_has_tooltip       (GtkWidget   *widget);
 877
 878 gboolean   gtk_cairo_should_draw_window     (cairo_t     *cr,
 879                                              GdkWindow   *window);
 880 void       gtk_cairo_transform_to_window    (cairo_t     *cr,
 881                                              GtkWidget   *widget,
 882                                              GdkWindow   *window);
 883
 884 GType           gtk_requisition_get_type (void) G_GNUC_CONST;
 885 GtkRequisition *gtk_requisition_new      (void) G_GNUC_MALLOC;
 886 GtkRequisition *gtk_requisition_copy     (const GtkRequisition *requisition);
 887 void            gtk_requisition_free     (GtkRequisition       *requisition);
 888
 889 gboolean     gtk_widget_in_destruction (GtkWidget *widget);
 890
 891 GtkStyleContext * gtk_widget_get_style_context (GtkWidget *widget);
 892
 893 GtkWidgetPath *   gtk_widget_get_path (GtkWidget *widget);
 894
 895 GDK_AVAILABLE_IN_3_4
 896 GdkModifierType   gtk_widget_get_modifier_mask (GtkWidget         *widget,
 897                                                 GdkModifierIntent  intent);
 898
 899
 900 G_END_DECLS
 901
 902 #endif /* __GTK_WIDGET_H__ */