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