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