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