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/gtkstyle.h>
  38 #include <gtk/gtkborder.h>
  39 #include <gtk/gtksettings.h>
  40 #include <gtk/gtkstylecontext.h>
  41 #include <gtk/gtkwidgetpath.h>
  42 #include <atk/atk.h>
  43
  44 G_BEGIN_DECLS
  45
  46 /* Kinds of widget-specific help */
  47 typedef enum
  48 {
  49   GTK_WIDGET_HELP_TOOLTIP,
  50   GTK_WIDGET_HELP_WHATS_THIS
  51 } GtkWidgetHelpType;
  52
  53 /* Macro for casting a pointer to a GtkWidget or GtkWidgetClass pointer.
  54  * Macros for testing whether `widget' or `klass' are of type GTK_TYPE_WIDGET.
  55  */
  56 #define GTK_TYPE_WIDGET                   (gtk_widget_get_type ())
  57 #define GTK_WIDGET(widget)                (G_TYPE_CHECK_INSTANCE_CAST ((widget), GTK_TYPE_WIDGET, GtkWidget))
  58 #define GTK_WIDGET_CLASS(klass)           (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WIDGET, GtkWidgetClass))
  59 #define GTK_IS_WIDGET(widget)             (G_TYPE_CHECK_INSTANCE_TYPE ((widget), GTK_TYPE_WIDGET))
  60 #define GTK_IS_WIDGET_CLASS(klass)        (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WIDGET))
  61 #define GTK_WIDGET_GET_CLASS(obj)         (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WIDGET, GtkWidgetClass))
  62
  63 #define GTK_TYPE_REQUISITION              (gtk_requisition_get_type ())
  64
  65 /* forward declaration to avoid excessive includes (and concurrent includes)
  66  */
  67 typedef struct _GtkRequisition     GtkRequisition;
  68 typedef struct _GtkSelectionData   GtkSelectionData;
  69 typedef struct _GtkWidgetPrivate   GtkWidgetPrivate;
  70 typedef struct _GtkWidgetClass     GtkWidgetClass;
  71 typedef struct _GtkWidgetAuxInfo   GtkWidgetAuxInfo;
  72 typedef struct _GtkClipboard       GtkClipboard;
  73 typedef struct _GtkTooltip         GtkTooltip;
  74 typedef struct _GtkWindow          GtkWindow;
  75
  76
  77 /**
  78  * GtkAllocation:
  79  * @x: the X position of the widget's area relative to its parents allocation.
  80  * @y: the Y position of the widget's area relative to its parents allocation.
  81  * @width: the width of the widget's allocated area.
  82  * @height: the height of the widget's allocated area.
  83  *
  84  * A <structname>GtkAllocation</structname> of a widget represents region
  85  * which has been allocated to the widget by its parent. It is a subregion
  86  * of its parents allocation. See <xref linkend="geometry-management"/> for
  87  * more information.
  88  */
  89 typedef         GdkRectangle       GtkAllocation;
  90
  91 /**
  92  * GtkCallback:
  93  * @widget: the widget to operate on
  94  * @data: user-supplied data
  95  *
  96  * The type of the callback functions used for e.g. iterating over
  97  * the children of a container, see gtk_container_foreach().
  98  */
  99 typedef void    (*GtkCallback)     (GtkWidget        *widget,
 100                                     gpointer          data);
 101
 102 /**
 103  * GtkRequisition:
 104  * @width: the widget's desired width
 105  * @height: the widget's desired height
 106  *
 107  * A <structname>GtkRequisition</structname> represents the desired size of a widget. See
 108  * <xref linkend="geometry-management"/> for more information.
 109  */
 110 struct _GtkRequisition
 111 {
 112   gint width;
 113   gint height;
 114 };
 115
 116 /* The widget is the base of the tree for displayable objects.
 117  *  (A displayable object is one which takes up some amount
 118  *  of screen real estate). It provides a common base and interface
 119  *  which actual widgets must adhere to.
 120  */
 121 struct _GtkWidget
 122 {
 123   GInitiallyUnowned parent_instance;
 124
 125   GtkWidgetPrivate *priv;
 126 };
 127
 128 /**
 129  * GtkWidgetClass:
 130  * @parent_class: The object class structure needs to be the first
 131  *   element in the widget class structure in order for the class mechanism
 132  *   to work correctly. This allows a GtkWidgetClass pointer to be cast to
 133  *   a GObjectClass pointer.
 134  * @activate_signal: The signal to emit when a widget of this class is
 135  *   activated, gtk_widget_activate() handles the emission.
 136  *   Implementation of this signal is optional.
 137  * @get_request_mode: This allows a widget to tell its parent container whether
 138  *   it prefers to be allocated in %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH or
 139  *   %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT mode.
 140  *   %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH means the widget prefers to have
 141  *   #GtkWidgetClass.get_preferred_width() called and then
 142  *   #GtkWidgetClass.get_preferred_height_for_width().
 143  *   %GTK_SIZE_REQUEST_CONSTANT_SIZE disables any height-for-width or
 144  *   width-for-height geometry management for a said widget and is the
 145  *   default return.
 146  *   It's important to note (as described below) that any widget
 147  *   which trades height-for-width or width-for-height must respond properly
 148  *   to both of the virtual methods #GtkWidgetClass.get_preferred_height_for_width()
 149  *   and #GtkWidgetClass.get_preferred_width_for_height() since it might be
 150  *   queried in either #GtkSizeRequestMode by its parent container.
 151  * @get_preferred_height: This is called by containers to obtain the minimum
 152  *   and natural height of a widget. A widget that does not actually trade
 153  *   any height for width or width for height only has to implement these
 154  *   two virtual methods (#GtkWidgetClass.get_preferred_width() and
 155  *   #GtkWidgetClass.get_preferred_height()).
 156  * @get_preferred_width_for_height: This is analogous to
 157  *   #GtkWidgetClass.get_preferred_height_for_width() except that it
 158  *   operates in the oposite orientation. It's rare that a widget actually
 159  *   does %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT requests but this can happen
 160  *   when, for example, a widget or container gets additional columns to
 161  *   compensate for a smaller allocated height.
 162  * @get_preferred_width: This is called by containers to obtain the minimum
 163  *   and natural width of a widget. A widget will never be allocated a width
 164  *   less than its minimum and will only ever be allocated a width greater
 165  *   than the natural width once all of the said widget's siblings have
 166  *   received their natural widths.
 167  *   Furthermore, a widget will only ever be allocated a width greater than
 168  *   its natural width if it was configured to receive extra expand space
 169  *   from its parent container.
 170  * @get_preferred_height_for_width: This is similar to
 171  *   #GtkWidgetClass.get_preferred_height() except that it is passed a
 172  *   contextual width to request height for. By implementing this virtual
 173  *   method it is possible for a #GtkLabel to tell its parent how much height
 174  *   would be required if the label were to be allocated a said width.
 175  * @adjust_size_request: Convert an initial size request from a widget's
 176  *   #GtkSizeRequest virtual method implementations into a size request to
 177  *   be used by parent containers in laying out the widget.
 178  *   adjust_size_request adjusts <emphasis>from</emphasis> a child widget's
 179  *   original request <emphasis>to</emphasis> what a parent container should
 180  *   use for layout. The @for_size argument will be -1 if the request should
 181  *   not be for a particular size in the opposing orientation, i.e. if the
 182  *   request is not height-for-width or width-for-height. If @for_size is
 183  *   greater than -1, it is the proposed allocation in the opposing
 184  *   orientation that we need the request for. Implementations of
 185  *   adjust_size_request should chain up to the default implementation,
 186  *   which applies #GtkWidget's margin properties and imposes any values
 187  *   from gtk_widget_set_size_request(). Chaining up should be last,
 188  *   <emphasis>after</emphasis> your subclass adjusts the request, so
 189  *   #GtkWidget can apply constraints and add the margin properly.
 190  * @adjust_size_allocation: Convert an initial size allocation assigned
 191  *   by a #GtkContainer using gtk_widget_size_allocate(), into an actual
 192  *   size allocation to be used by the widget. adjust_size_allocation
 193  *   adjusts <emphasis>to</emphasis> a child widget's actual allocation
 194  *   <emphasis>from</emphasis> what a parent container computed for the
 195  *   child. The adjusted allocation must be entirely within the original
 196  *   allocation. In any custom implementation, chain up to the default
 197  *   #GtkWidget implementation of this method, which applies the margin
 198  *   and alignment properties of #GtkWidget. Chain up
 199  *   <emphasis>before</emphasis> performing your own adjustments so your
 200  *   own adjustments remove more allocation after the #GtkWidget base
 201  *   class has already removed margin and alignment. The natural size
 202  *   passed in should be adjusted in the same way as the allocated size,
 203  *   which allows adjustments to perform alignments or other changes
 204  *   based on natural size.
 205  */
 206 struct _GtkWidgetClass
 207 {
 208   GInitiallyUnownedClass parent_class;
 209
 210   /*< public >*/
 211
 212   guint activate_signal;
 213
 214   /* seldomly overidden */
 215   void (*dispatch_child_properties_changed) (GtkWidget   *widget,
 216                                              guint        n_pspecs,
 217                                              GParamSpec **pspecs);
 218
 219   /* basics */
 220   void (* destroy)             (GtkWidget        *widget);
 221   void (* show)                (GtkWidget        *widget);
 222   void (* show_all)            (GtkWidget        *widget);
 223   void (* hide)                (GtkWidget        *widget);
 224   void (* map)                 (GtkWidget        *widget);
 225   void (* unmap)               (GtkWidget        *widget);
 226   void (* realize)             (GtkWidget        *widget);
 227   void (* unrealize)           (GtkWidget        *widget);
 228   void (* size_allocate)       (GtkWidget        *widget,
 229                                 GtkAllocation    *allocation);
 230   void (* state_changed)       (GtkWidget        *widget,
 231                                 GtkStateType      previous_state);
 232   void (* state_flags_changed) (GtkWidget        *widget,
 233                                 GtkStateFlags     previous_state_flags);
 234   void (* parent_set)          (GtkWidget        *widget,
 235                                 GtkWidget        *previous_parent);
 236   void (* hierarchy_changed)   (GtkWidget        *widget,
 237                                 GtkWidget        *previous_toplevel);
 238   void (* style_set)           (GtkWidget        *widget,
 239                                 GtkStyle         *previous_style);
 240   void (* direction_changed)   (GtkWidget        *widget,
 241                                 GtkTextDirection  previous_direction);
 242   void (* grab_notify)         (GtkWidget        *widget,
 243                                 gboolean          was_grabbed);
 244   void (* child_notify)        (GtkWidget        *widget,
 245                                 GParamSpec       *pspec);
 246   gboolean (* draw)            (GtkWidget        *widget,
 247                                 cairo_t          *cr);
 248
 249   /* size requests */
 250   GtkSizeRequestMode (* get_request_mode)               (GtkWidget      *widget);
 251
 252   void               (* get_preferred_height)           (GtkWidget       *widget,
 253                                                          gint            *minimum_height,
 254                                                          gint            *natural_height);
 255   void               (* get_preferred_width_for_height) (GtkWidget       *widget,
 256                                                          gint             height,
 257                                                          gint            *minimum_width,
 258                                                          gint            *natural_width);
 259   void               (* get_preferred_width)            (GtkWidget       *widget,
 260                                                          gint            *minimum_width,
 261                                                          gint            *natural_width);
 262   void               (* get_preferred_height_for_width) (GtkWidget       *widget,
 263                                                          gint             width,
 264                                                          gint            *minimum_height,
 265                                                          gint            *natural_height);
 266
 267   /* Mnemonics */
 268   gboolean (* mnemonic_activate)        (GtkWidget           *widget,
 269                                          gboolean             group_cycling);
 270
 271   /* explicit focus */
 272   void     (* grab_focus)               (GtkWidget           *widget);
 273   gboolean (* focus)                    (GtkWidget           *widget,
 274                                          GtkDirectionType     direction);
 275
 276   /* keyboard navigation */
 277   void     (* move_focus)               (GtkWidget           *widget,
 278                                          GtkDirectionType     direction);
 279   gboolean (* keynav_failed)            (GtkWidget           *widget,
 280                                          GtkDirectionType     direction);
 281
 282   /* events */
 283   gboolean (* event)                    (GtkWidget           *widget,
 284                                          GdkEvent            *event);
 285   gboolean (* button_press_event)       (GtkWidget           *widget,
 286                                          GdkEventButton      *event);
 287   gboolean (* button_release_event)     (GtkWidget           *widget,
 288                                          GdkEventButton      *event);
 289   gboolean (* scroll_event)             (GtkWidget           *widget,
 290                                          GdkEventScroll      *event);
 291   gboolean (* motion_notify_event)      (GtkWidget           *widget,
 292                                          GdkEventMotion      *event);
 293   gboolean (* delete_event)             (GtkWidget           *widget,
 294                                          GdkEventAny         *event);
 295   gboolean (* destroy_event)            (GtkWidget           *widget,
 296                                          GdkEventAny         *event);
 297   gboolean (* key_press_event)          (GtkWidget           *widget,
 298                                          GdkEventKey         *event);
 299   gboolean (* key_release_event)        (GtkWidget           *widget,
 300                                          GdkEventKey         *event);
 301   gboolean (* enter_notify_event)       (GtkWidget           *widget,
 302                                          GdkEventCrossing    *event);
 303   gboolean (* leave_notify_event)       (GtkWidget           *widget,
 304                                          GdkEventCrossing    *event);
 305   gboolean (* configure_event)          (GtkWidget           *widget,
 306                                          GdkEventConfigure   *event);
 307   gboolean (* focus_in_event)           (GtkWidget           *widget,
 308                                          GdkEventFocus       *event);
 309   gboolean (* focus_out_event)          (GtkWidget           *widget,
 310                                          GdkEventFocus       *event);
 311   gboolean (* map_event)                (GtkWidget           *widget,
 312                                          GdkEventAny         *event);
 313   gboolean (* unmap_event)              (GtkWidget           *widget,
 314                                          GdkEventAny         *event);
 315   gboolean (* property_notify_event)    (GtkWidget           *widget,
 316                                          GdkEventProperty    *event);
 317   gboolean (* selection_clear_event)    (GtkWidget           *widget,
 318                                          GdkEventSelection   *event);
 319   gboolean (* selection_request_event)  (GtkWidget           *widget,
 320                                          GdkEventSelection   *event);
 321   gboolean (* selection_notify_event)   (GtkWidget           *widget,
 322                                          GdkEventSelection   *event);
 323   gboolean (* proximity_in_event)       (GtkWidget           *widget,
 324                                          GdkEventProximity   *event);
 325   gboolean (* proximity_out_event)      (GtkWidget           *widget,
 326                                          GdkEventProximity   *event);
 327   gboolean (* visibility_notify_event)  (GtkWidget           *widget,
 328                                          GdkEventVisibility  *event);
 329   gboolean (* window_state_event)       (GtkWidget           *widget,
 330                                          GdkEventWindowState *event);
 331   gboolean (* damage_event)             (GtkWidget           *widget,
 332                                          GdkEventExpose      *event);
 333   gboolean (* grab_broken_event)        (GtkWidget           *widget,
 334                                          GdkEventGrabBroken  *event);
 335
 336   /* selection */
 337   void     (* selection_get)       (GtkWidget          *widget,
 338                                     GtkSelectionData   *selection_data,
 339                                     guint               info,
 340                                     guint               time_);
 341   void     (* selection_received)  (GtkWidget          *widget,
 342                                     GtkSelectionData   *selection_data,
 343                                     guint               time_);
 344
 345   /* Source side drag signals */
 346   void     (* drag_begin)          (GtkWidget         *widget,
 347                                     GdkDragContext     *context);
 348   void     (* drag_end)            (GtkWidget          *widget,
 349                                     GdkDragContext     *context);
 350   void     (* drag_data_get)       (GtkWidget          *widget,
 351                                     GdkDragContext     *context,
 352                                     GtkSelectionData   *selection_data,
 353                                     guint               info,
 354                                     guint               time_);
 355   void     (* drag_data_delete)    (GtkWidget          *widget,
 356                                     GdkDragContext     *context);
 357
 358   /* Target side drag signals */
 359   void     (* drag_leave)          (GtkWidget          *widget,
 360                                     GdkDragContext     *context,
 361                                     guint               time_);
 362   gboolean (* drag_motion)         (GtkWidget          *widget,
 363                                     GdkDragContext     *context,
 364                                     gint                x,
 365                                     gint                y,
 366                                     guint               time_);
 367   gboolean (* drag_drop)           (GtkWidget          *widget,
 368                                     GdkDragContext     *context,
 369                                     gint                x,
 370                                     gint                y,
 371                                     guint               time_);
 372   void     (* drag_data_received)  (GtkWidget          *widget,
 373                                     GdkDragContext     *context,
 374                                     gint                x,
 375                                     gint                y,
 376                                     GtkSelectionData   *selection_data,
 377                                     guint               info,
 378                                     guint               time_);
 379   gboolean (* drag_failed)         (GtkWidget          *widget,
 380                                     GdkDragContext     *context,
 381                                     GtkDragResult       result);
 382
 383   /* Signals used only for keybindings */
 384   gboolean (* popup_menu)          (GtkWidget          *widget);
 385
 386   /* If a widget has multiple tooltips/whatsthis, it should show the
 387    * one for the current focus location, or if that doesn't make
 388    * sense, should cycle through them showing each tip alongside
 389    * whatever piece of the widget it applies to.
 390    */
 391   gboolean (* show_help)           (GtkWidget          *widget,
 392                                     GtkWidgetHelpType   help_type);
 393
 394   /* accessibility support
 395    */
 396   AtkObject *  (* get_accessible)     (GtkWidget *widget);
 397
 398   void         (* screen_changed)     (GtkWidget *widget,
 399                                        GdkScreen *previous_screen);
 400   gboolean     (* can_activate_accel) (GtkWidget *widget,
 401                                        guint      signal_id);
 402
 403
 404   void         (* composited_changed) (GtkWidget *widget);
 405
 406   gboolean     (* query_tooltip)      (GtkWidget  *widget,
 407                                        gint        x,
 408                                        gint        y,
 409                                        gboolean    keyboard_tooltip,
 410                                        GtkTooltip *tooltip);
 411
 412   void         (* compute_expand)     (GtkWidget  *widget,
 413                                        gboolean   *hexpand_p,
 414                                        gboolean   *vexpand_p);
 415
 416   void         (* adjust_size_request)    (GtkWidget         *widget,
 417                                            GtkOrientation     orientation,
 418                                            gint              *minimum_size,
 419                                            gint              *natural_size);
 420   void         (* adjust_size_allocation) (GtkWidget         *widget,
 421                                            GtkOrientation     orientation,
 422                                            gint              *minimum_size,
 423                                            gint              *natural_size,
 424                                            gint              *allocated_pos,
 425                                            gint              *allocated_size);
 426
 427   void         (* style_updated)          (GtkWidget *widget);
 428
 429   /*< private >*/
 430
 431   /* Padding for future expansion */
 432   void (*_gtk_reserved1) (void);
 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 #ifndef GTK_DISABLE_DEPRECATED
 487 void       gtk_widget_size_request        (GtkWidget           *widget,
 488                                            GtkRequisition      *requisition);
 489 #endif
 490 void       gtk_widget_size_allocate       (GtkWidget           *widget,
 491                                            GtkAllocation       *allocation);
 492
 493 GtkSizeRequestMode  gtk_widget_get_request_mode               (GtkWidget      *widget);
 494 void                gtk_widget_get_preferred_width            (GtkWidget      *widget,
 495                                                                gint           *minimum_width,
 496                                                                gint           *natural_width);
 497 void                gtk_widget_get_preferred_height_for_width (GtkWidget      *widget,
 498                                                                gint            width,
 499                                                                gint           *minimum_height,
 500                                                                gint           *natural_height);
 501 void                gtk_widget_get_preferred_height           (GtkWidget      *widget,
 502                                                                gint           *minimum_height,
 503                                                                gint           *natural_height);
 504 void                gtk_widget_get_preferred_width_for_height (GtkWidget      *widget,
 505                                                                gint            height,
 506                                                                gint           *minimum_width,
 507                                                                gint           *natural_width);
 508 void                gtk_widget_get_preferred_size             (GtkWidget      *widget,
 509                                                                GtkRequisition *minimum_size,
 510                                                                GtkRequisition *natural_size);
 511
 512 #ifndef GTK_DISABLE_DEPRECATED
 513 void       gtk_widget_get_child_requisition (GtkWidget         *widget,
 514                                              GtkRequisition    *requisition);
 515 #endif
 516 void       gtk_widget_add_accelerator     (GtkWidget           *widget,
 517                                            const gchar         *accel_signal,
 518                                            GtkAccelGroup       *accel_group,
 519                                            guint                accel_key,
 520                                            GdkModifierType      accel_mods,
 521                                            GtkAccelFlags        accel_flags);
 522 gboolean   gtk_widget_remove_accelerator  (GtkWidget           *widget,
 523                                            GtkAccelGroup       *accel_group,
 524                                            guint                accel_key,
 525                                            GdkModifierType      accel_mods);
 526 void       gtk_widget_set_accel_path      (GtkWidget           *widget,
 527                                            const gchar         *accel_path,
 528                                            GtkAccelGroup       *accel_group);
 529 GList*     gtk_widget_list_accel_closures (GtkWidget           *widget);
 530 gboolean   gtk_widget_can_activate_accel  (GtkWidget           *widget,
 531                                            guint                signal_id);
 532 gboolean   gtk_widget_mnemonic_activate   (GtkWidget           *widget,
 533                                            gboolean             group_cycling);
 534 gboolean   gtk_widget_event               (GtkWidget           *widget,
 535                                            GdkEvent            *event);
 536 gint       gtk_widget_send_expose         (GtkWidget           *widget,
 537                                            GdkEvent            *event);
 538 gboolean   gtk_widget_send_focus_change   (GtkWidget           *widget,
 539                                            GdkEvent            *event);
 540
 541 gboolean   gtk_widget_activate               (GtkWidget        *widget);
 542
 543 void       gtk_widget_reparent            (GtkWidget           *widget,
 544                                            GtkWidget           *new_parent);
 545 gboolean   gtk_widget_intersect           (GtkWidget           *widget,
 546                                            const GdkRectangle  *area,
 547                                            GdkRectangle        *intersection);
 548 cairo_region_t *gtk_widget_region_intersect       (GtkWidget           *widget,
 549                                            const cairo_region_t     *region);
 550
 551 void    gtk_widget_freeze_child_notify    (GtkWidget           *widget);
 552 void    gtk_widget_child_notify           (GtkWidget           *widget,
 553                                            const gchar         *child_property);
 554 void    gtk_widget_thaw_child_notify      (GtkWidget           *widget);
 555
 556 void       gtk_widget_set_can_focus       (GtkWidget           *widget,
 557                                            gboolean             can_focus);
 558 gboolean   gtk_widget_get_can_focus       (GtkWidget           *widget);
 559 gboolean   gtk_widget_has_focus           (GtkWidget           *widget);
 560 gboolean   gtk_widget_is_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 AtkObject*       gtk_widget_get_accessible               (GtkWidget          *widget);
 724
 725
 726 /* Margin and alignment */
 727 GtkAlign gtk_widget_get_halign        (GtkWidget *widget);
 728 void     gtk_widget_set_halign        (GtkWidget *widget,
 729                                        GtkAlign   align);
 730 GtkAlign gtk_widget_get_valign        (GtkWidget *widget);
 731 void     gtk_widget_set_valign        (GtkWidget *widget,
 732                                        GtkAlign   align);
 733 gint     gtk_widget_get_margin_left   (GtkWidget *widget);
 734 void     gtk_widget_set_margin_left   (GtkWidget *widget,
 735                                        gint       margin);
 736 gint     gtk_widget_get_margin_right  (GtkWidget *widget);
 737 void     gtk_widget_set_margin_right  (GtkWidget *widget,
 738                                        gint       margin);
 739 gint     gtk_widget_get_margin_top    (GtkWidget *widget);
 740 void     gtk_widget_set_margin_top    (GtkWidget *widget,
 741                                        gint       margin);
 742 gint     gtk_widget_get_margin_bottom (GtkWidget *widget);
 743 void     gtk_widget_set_margin_bottom (GtkWidget *widget,
 744                                        gint       margin);
 745
 746
 747 gint         gtk_widget_get_events      (GtkWidget      *widget);
 748 GdkEventMask gtk_widget_get_device_events (GtkWidget    *widget,
 749                                            GdkDevice    *device);
 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 #if !defined(GTK_DISABLE_DEPRECATED) || defined(GTK_COMPILATION)
 789
 790 void        gtk_widget_style_attach               (GtkWidget     *widget);
 791
 792 /* Widget styles.
 793  */
 794 gboolean    gtk_widget_has_rc_style       (GtkWidget            *widget);
 795 void        gtk_widget_set_style          (GtkWidget            *widget,
 796                                            GtkStyle             *style);
 797 void        gtk_widget_ensure_style       (GtkWidget            *widget);
 798 GtkStyle *  gtk_widget_get_style          (GtkWidget            *widget);
 799
 800 void        gtk_widget_modify_style       (GtkWidget            *widget,
 801                                            GtkRcStyle           *style);
 802 GtkRcStyle *gtk_widget_get_modifier_style (GtkWidget            *widget);
 803 void        gtk_widget_modify_fg          (GtkWidget            *widget,
 804                                            GtkStateType          state,
 805                                            const GdkColor       *color);
 806 void        gtk_widget_modify_bg          (GtkWidget            *widget,
 807                                            GtkStateType          state,
 808                                            const GdkColor       *color);
 809 void        gtk_widget_modify_text        (GtkWidget            *widget,
 810                                            GtkStateType          state,
 811                                            const GdkColor       *color);
 812 void        gtk_widget_modify_base        (GtkWidget            *widget,
 813                                            GtkStateType          state,
 814                                            const GdkColor       *color);
 815 void        gtk_widget_modify_cursor      (GtkWidget            *widget,
 816                                            const GdkColor       *primary,
 817                                            const GdkColor       *secondary);
 818 void        gtk_widget_modify_font        (GtkWidget            *widget,
 819                                            PangoFontDescription *font_desc);
 820
 821 /* Descend recursively and set rc-style on all widgets without user styles */
 822 void       gtk_widget_reset_rc_styles   (GtkWidget      *widget);
 823
 824 /* Set certain default values to be used at widget creation time  */
 825 GtkStyle*    gtk_widget_get_default_style    (void);
 826
 827 /* Compute a widget's path in the form "GtkWindow.MyLabel", and
 828  * return newly alocated strings.
 829  */
 830 void         gtk_widget_path               (GtkWidget *widget,
 831                                             guint     *path_length,
 832                                             gchar    **path,
 833                                             gchar    **path_reversed);
 834 void         gtk_widget_class_path         (GtkWidget *widget,
 835                                             guint     *path_length,
 836                                             gchar    **path,
 837                                             gchar    **path_reversed);
 838
 839 GdkPixbuf    *gtk_widget_render_icon          (GtkWidget   *widget,
 840                                                const gchar *stock_id,
 841                                                GtkIconSize  size,
 842                                                const gchar *detail);
 843 #endif  /* GTK_DISABLE_DEPRECATED */
 844
 845 PangoContext *gtk_widget_create_pango_context (GtkWidget   *widget);
 846 PangoContext *gtk_widget_get_pango_context    (GtkWidget   *widget);
 847 PangoLayout  *gtk_widget_create_pango_layout  (GtkWidget   *widget,
 848                                                const gchar *text);
 849
 850 GdkPixbuf    *gtk_widget_render_icon_pixbuf   (GtkWidget   *widget,
 851                                                const gchar *stock_id,
 852                                                GtkIconSize  size);
 853
 854 /* handle composite names for GTK_COMPOSITE_CHILD widgets,
 855  * the returned name is newly allocated.
 856  */
 857 void   gtk_widget_set_composite_name    (GtkWidget      *widget,
 858                                          const gchar    *name);
 859 gchar* gtk_widget_get_composite_name    (GtkWidget      *widget);
 860
 861 /* Push/pop pairs, to change default values upon a widget's creation.
 862  * This will override the values that got set by the
 863  * gtk_widget_set_default_* () functions.
 864  */
 865 void         gtk_widget_push_composite_child (void);
 866 void         gtk_widget_pop_composite_child  (void);
 867
 868 /* widget style properties
 869  */
 870 void gtk_widget_class_install_style_property        (GtkWidgetClass     *klass,
 871                                                      GParamSpec         *pspec);
 872 void gtk_widget_class_install_style_property_parser (GtkWidgetClass     *klass,
 873                                                      GParamSpec         *pspec,
 874                                                      GtkRcPropertyParser parser);
 875 GParamSpec*  gtk_widget_class_find_style_property   (GtkWidgetClass     *klass,
 876                                                      const gchar        *property_name);
 877 GParamSpec** gtk_widget_class_list_style_properties (GtkWidgetClass     *klass,
 878                                                      guint              *n_properties);
 879 void gtk_widget_style_get_property (GtkWidget        *widget,
 880                                     const gchar    *property_name,
 881                                     GValue           *value);
 882 void gtk_widget_style_get_valist   (GtkWidget        *widget,
 883                                     const gchar    *first_property_name,
 884                                     va_list         var_args);
 885 void gtk_widget_style_get          (GtkWidget        *widget,
 886                                     const gchar    *first_property_name,
 887                                     ...) G_GNUC_NULL_TERMINATED;
 888
 889 /* Functions for setting directionality for widgets */
 890
 891 void             gtk_widget_set_direction         (GtkWidget        *widget,
 892                                                    GtkTextDirection  dir);
 893 GtkTextDirection gtk_widget_get_direction         (GtkWidget        *widget);
 894
 895 void             gtk_widget_set_default_direction (GtkTextDirection  dir);
 896 GtkTextDirection gtk_widget_get_default_direction (void);
 897
 898 /* Compositing manager functionality */
 899 gboolean gtk_widget_is_composited (GtkWidget *widget);
 900
 901 /* Counterpart to gdk_window_shape_combine_region.
 902  */
 903 void         gtk_widget_shape_combine_region (GtkWidget *widget,
 904                                               cairo_region_t *region);
 905 void         gtk_widget_input_shape_combine_region (GtkWidget *widget,
 906                                                     cairo_region_t *region);
 907
 908 GList* gtk_widget_list_mnemonic_labels  (GtkWidget *widget);
 909 void   gtk_widget_add_mnemonic_label    (GtkWidget *widget,
 910                                          GtkWidget *label);
 911 void   gtk_widget_remove_mnemonic_label (GtkWidget *widget,
 912                                          GtkWidget *label);
 913
 914 void                  gtk_widget_set_tooltip_window    (GtkWidget   *widget,
 915                                                         GtkWindow   *custom_window);
 916 GtkWindow *gtk_widget_get_tooltip_window    (GtkWidget   *widget);
 917 void       gtk_widget_trigger_tooltip_query (GtkWidget   *widget);
 918 void       gtk_widget_set_tooltip_text      (GtkWidget   *widget,
 919                                              const gchar *text);
 920 gchar *    gtk_widget_get_tooltip_text      (GtkWidget   *widget);
 921 void       gtk_widget_set_tooltip_markup    (GtkWidget   *widget,
 922                                              const gchar *markup);
 923 gchar *    gtk_widget_get_tooltip_markup    (GtkWidget   *widget);
 924 void       gtk_widget_set_has_tooltip       (GtkWidget   *widget,
 925                                              gboolean     has_tooltip);
 926 gboolean   gtk_widget_get_has_tooltip       (GtkWidget   *widget);
 927
 928 gboolean   gtk_cairo_should_draw_window     (cairo_t     *cr,
 929                                              GdkWindow   *window);
 930 void       gtk_cairo_transform_to_window    (cairo_t     *cr,
 931                                              GtkWidget   *widget,
 932                                              GdkWindow   *window);
 933
 934 GType           gtk_requisition_get_type (void) G_GNUC_CONST;
 935 GtkRequisition *gtk_requisition_new      (void) G_GNUC_MALLOC;
 936 GtkRequisition *gtk_requisition_copy     (const GtkRequisition *requisition);
 937 void            gtk_requisition_free     (GtkRequisition       *requisition);
 938
 939 gboolean     gtk_widget_in_destruction (GtkWidget *widget);
 940
 941 GtkStyleContext * gtk_widget_get_style_context (GtkWidget *widget);
 942
 943 GtkWidgetPath *   gtk_widget_get_path (GtkWidget *widget);
 944
 945
 946 G_END_DECLS
 947
 948 #endif /* __GTK_WIDGET_H__ */