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 #ifndef __GTK_WIDGET_H__
  28 #define __GTK_WIDGET_H__
  29
  30 #include <gdk/gdk.h>
  31 #include <gtk/gtkaccelgroup.h>
  32 #include <gtk/gtkobject.h>
  33 #include <gtk/gtkadjustment.h>
  34 #include <gtk/gtkstyle.h>
  35 #include <gtk/gtksettings.h>
  36 #include <atk/atk.h>
  37
  38 G_BEGIN_DECLS
  39
  40 /* The flags that are used by GtkWidget on top of the
  41  * flags field of GtkObject.
  42  */
  43 typedef enum
  44 {
  45   GTK_TOPLEVEL         = 1 << 4,
  46   GTK_NO_WINDOW        = 1 << 5,
  47   GTK_REALIZED         = 1 << 6,
  48   GTK_MAPPED           = 1 << 7,
  49   GTK_VISIBLE          = 1 << 8,
  50   GTK_SENSITIVE        = 1 << 9,
  51   GTK_PARENT_SENSITIVE = 1 << 10,
  52   GTK_CAN_FOCUS        = 1 << 11,
  53   GTK_HAS_FOCUS        = 1 << 12,
  54
  55   /* widget is allowed to receive the default via gtk_widget_grab_default
  56    * and will reserve space to draw the default if possible
  57    */
  58   GTK_CAN_DEFAULT      = 1 << 13,
  59
  60   /* the widget currently is receiving the default action and should be drawn
  61    * appropriately if possible
  62    */
  63   GTK_HAS_DEFAULT      = 1 << 14,
  64
  65   GTK_HAS_GRAB         = 1 << 15,
  66   GTK_RC_STYLE         = 1 << 16,
  67   GTK_COMPOSITE_CHILD  = 1 << 17,
  68   GTK_NO_REPARENT      = 1 << 18,
  69   GTK_APP_PAINTABLE    = 1 << 19,
  70
  71   /* the widget when focused will receive the default action and have
  72    * HAS_DEFAULT set even if there is a different widget set as default
  73    */
  74   GTK_RECEIVES_DEFAULT = 1 << 20,
  75
  76   GTK_DOUBLE_BUFFERED  = 1 << 21,
  77   GTK_NO_SHOW_ALL      = 1 << 22
  78 } GtkWidgetFlags;
  79
  80 /* Kinds of widget-specific help */
  81 typedef enum
  82 {
  83   GTK_WIDGET_HELP_TOOLTIP,
  84   GTK_WIDGET_HELP_WHATS_THIS
  85 } GtkWidgetHelpType;
  86
  87 /* Macro for casting a pointer to a GtkWidget or GtkWidgetClass pointer.
  88  * Macros for testing whether `widget' or `klass' are of type GTK_TYPE_WIDGET.
  89  */
  90 #define GTK_TYPE_WIDGET                   (gtk_widget_get_type ())
  91 #define GTK_WIDGET(widget)                (G_TYPE_CHECK_INSTANCE_CAST ((widget), GTK_TYPE_WIDGET, GtkWidget))
  92 #define GTK_WIDGET_CLASS(klass)           (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WIDGET, GtkWidgetClass))
  93 #define GTK_IS_WIDGET(widget)             (G_TYPE_CHECK_INSTANCE_TYPE ((widget), GTK_TYPE_WIDGET))
  94 #define GTK_IS_WIDGET_CLASS(klass)        (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WIDGET))
  95 #define GTK_WIDGET_GET_CLASS(obj)         (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WIDGET, GtkWidgetClass))
  96
  97 /* Macros for extracting various fields from GtkWidget and GtkWidgetClass.
  98  */
  99 #define GTK_WIDGET_TYPE(wid)              (GTK_OBJECT_TYPE (wid))
 100 #define GTK_WIDGET_STATE(wid)             (GTK_WIDGET (wid)->state)
 101 #define GTK_WIDGET_SAVED_STATE(wid)       (GTK_WIDGET (wid)->saved_state)
 102
 103 /* Macros for extracting the widget flags from GtkWidget.
 104  */
 105 #define GTK_WIDGET_FLAGS(wid)             (GTK_OBJECT_FLAGS (wid))
 106 #define GTK_WIDGET_TOPLEVEL(wid)          ((GTK_WIDGET_FLAGS (wid) & GTK_TOPLEVEL) != 0)
 107 #define GTK_WIDGET_NO_WINDOW(wid)         ((GTK_WIDGET_FLAGS (wid) & GTK_NO_WINDOW) != 0)
 108 #define GTK_WIDGET_REALIZED(wid)          ((GTK_WIDGET_FLAGS (wid) & GTK_REALIZED) != 0)
 109 #define GTK_WIDGET_MAPPED(wid)            ((GTK_WIDGET_FLAGS (wid) & GTK_MAPPED) != 0)
 110 #define GTK_WIDGET_VISIBLE(wid)           ((GTK_WIDGET_FLAGS (wid) & GTK_VISIBLE) != 0)
 111 #define GTK_WIDGET_DRAWABLE(wid)          (GTK_WIDGET_VISIBLE (wid) && GTK_WIDGET_MAPPED (wid))
 112 #define GTK_WIDGET_SENSITIVE(wid)         ((GTK_WIDGET_FLAGS (wid) & GTK_SENSITIVE) != 0)
 113 #define GTK_WIDGET_PARENT_SENSITIVE(wid)  ((GTK_WIDGET_FLAGS (wid) & GTK_PARENT_SENSITIVE) != 0)
 114 #define GTK_WIDGET_IS_SENSITIVE(wid)      (GTK_WIDGET_SENSITIVE (wid) && \
 115                                            GTK_WIDGET_PARENT_SENSITIVE (wid))
 116 #define GTK_WIDGET_CAN_FOCUS(wid)         ((GTK_WIDGET_FLAGS (wid) & GTK_CAN_FOCUS) != 0)
 117 #define GTK_WIDGET_HAS_FOCUS(wid)         ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_FOCUS) != 0)
 118 #define GTK_WIDGET_CAN_DEFAULT(wid)       ((GTK_WIDGET_FLAGS (wid) & GTK_CAN_DEFAULT) != 0)
 119 #define GTK_WIDGET_HAS_DEFAULT(wid)       ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_DEFAULT) != 0)
 120 #define GTK_WIDGET_HAS_GRAB(wid)          ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_GRAB) != 0)
 121 #define GTK_WIDGET_RC_STYLE(wid)          ((GTK_WIDGET_FLAGS (wid) & GTK_RC_STYLE) != 0)
 122 #define GTK_WIDGET_COMPOSITE_CHILD(wid)   ((GTK_WIDGET_FLAGS (wid) & GTK_COMPOSITE_CHILD) != 0)
 123 #define GTK_WIDGET_APP_PAINTABLE(wid)     ((GTK_WIDGET_FLAGS (wid) & GTK_APP_PAINTABLE) != 0)
 124 #define GTK_WIDGET_RECEIVES_DEFAULT(wid)  ((GTK_WIDGET_FLAGS (wid) & GTK_RECEIVES_DEFAULT) != 0)
 125 #define GTK_WIDGET_DOUBLE_BUFFERED(wid)   ((GTK_WIDGET_FLAGS (wid) & GTK_DOUBLE_BUFFERED) != 0)
 126
 127 /* Macros for setting and clearing widget flags.
 128  */
 129 #define GTK_WIDGET_SET_FLAGS(wid,flag)    G_STMT_START{ (GTK_WIDGET_FLAGS (wid) |= (flag)); }G_STMT_END
 130 #define GTK_WIDGET_UNSET_FLAGS(wid,flag)  G_STMT_START{ (GTK_WIDGET_FLAGS (wid) &= ~(flag)); }G_STMT_END
 131
 132 #define GTK_TYPE_REQUISITION              (gtk_requisition_get_type ())
 133
 134 /* forward declaration to avoid excessive includes (and concurrent includes)
 135  */
 136 typedef struct _GtkRequisition     GtkRequisition;
 137 typedef         GdkRectangle       GtkAllocation;
 138 typedef struct _GtkSelectionData   GtkSelectionData;
 139 typedef struct _GtkWidgetClass     GtkWidgetClass;
 140 typedef struct _GtkWidgetAuxInfo   GtkWidgetAuxInfo;
 141 typedef struct _GtkWidgetShapeInfo GtkWidgetShapeInfo;
 142 typedef struct _GtkClipboard       GtkClipboard;
 143 typedef struct _GtkTooltip         GtkTooltip;
 144 typedef struct _GtkWindow          GtkWindow;
 145 typedef void     (*GtkCallback)        (GtkWidget        *widget,
 146                                         gpointer          data);
 147
 148 /* A requisition is a desired amount of space which a
 149  *  widget may request.
 150  */
 151 struct _GtkRequisition
 152 {
 153   gint width;
 154   gint height;
 155 };
 156
 157 /* The widget is the base of the tree for displayable objects.
 158  *  (A displayable object is one which takes up some amount
 159  *  of screen real estate). It provides a common base and interface
 160  *  which actual widgets must adhere to.
 161  */
 162 struct _GtkWidget
 163 {
 164   /* The object structure needs to be the first
 165    *  element in the widget structure in order for
 166    *  the object mechanism to work correctly. This
 167    *  allows a GtkWidget pointer to be cast to a
 168    *  GtkObject pointer.
 169    */
 170   GtkObject object;
 171
 172   /* 16 bits of internally used private flags.
 173    * this will be packed into the same 4 byte alignment frame that
 174    * state and saved_state go. we therefore don't waste any new
 175    * space on this.
 176    */
 177   guint16 private_flags;
 178
 179   /* The state of the widget. There are actually only
 180    *  5 widget states (defined in "gtkenums.h").
 181    */
 182   guint8 state;
 183
 184   /* The saved state of the widget. When a widget's state
 185    *  is changed to GTK_STATE_INSENSITIVE via
 186    *  "gtk_widget_set_state" or "gtk_widget_set_sensitive"
 187    *  the old state is kept around in this field. The state
 188    *  will be restored once the widget gets sensitive again.
 189    */
 190   guint8 saved_state;
 191
 192   /* The widget's name. If the widget does not have a name
 193    *  (the name is NULL), then its name (as returned by
 194    *  "gtk_widget_get_name") is its class's name.
 195    * Among other things, the widget name is used to determine
 196    *  the style to use for a widget.
 197    */
 198   gchar *name;
 199
 200   /*< public >*/
 201
 202   /* The style for the widget. The style contains the
 203    *  colors the widget should be drawn in for each state
 204    *  along with graphics contexts used to draw with and
 205    *  the font to use for text.
 206    */
 207   GtkStyle *style;
 208
 209   /* The widget's desired size.
 210    */
 211   GtkRequisition requisition;
 212
 213   /* The widget's allocated size.
 214    */
 215   GtkAllocation allocation;
 216
 217   /* The widget's window or its parent window if it does
 218    *  not have a window. (Which will be indicated by the
 219    *  GTK_NO_WINDOW flag being set).
 220    */
 221   GdkWindow *window;
 222
 223   /* The widget's parent.
 224    */
 225   GtkWidget *parent;
 226 };
 227
 228 struct _GtkWidgetClass
 229 {
 230   /* The object class structure needs to be the first
 231    *  element in the widget class structure in order for
 232    *  the class mechanism to work correctly. This allows a
 233    *  GtkWidgetClass pointer to be cast to a GtkObjectClass
 234    *  pointer.
 235    */
 236   GtkObjectClass parent_class;
 237
 238   /*< public >*/
 239
 240   guint activate_signal;
 241
 242   guint set_scroll_adjustments_signal;
 243
 244   /*< private >*/
 245
 246   /* seldomly overidden */
 247   void (*dispatch_child_properties_changed) (GtkWidget   *widget,
 248                                              guint        n_pspecs,
 249                                              GParamSpec **pspecs);
 250
 251   /* basics */
 252   void (* show)                (GtkWidget        *widget);
 253   void (* show_all)            (GtkWidget        *widget);
 254   void (* hide)                (GtkWidget        *widget);
 255   void (* hide_all)            (GtkWidget        *widget);
 256   void (* map)                 (GtkWidget        *widget);
 257   void (* unmap)               (GtkWidget        *widget);
 258   void (* realize)             (GtkWidget        *widget);
 259   void (* unrealize)           (GtkWidget        *widget);
 260   void (* size_request)        (GtkWidget        *widget,
 261                                 GtkRequisition   *requisition);
 262   void (* size_allocate)       (GtkWidget        *widget,
 263                                 GtkAllocation    *allocation);
 264   void (* state_changed)       (GtkWidget        *widget,
 265                                 GtkStateType      previous_state);
 266   void (* parent_set)          (GtkWidget        *widget,
 267                                 GtkWidget        *previous_parent);
 268   void (* hierarchy_changed)   (GtkWidget        *widget,
 269                                 GtkWidget        *previous_toplevel);
 270   void (* style_set)           (GtkWidget        *widget,
 271                                 GtkStyle         *previous_style);
 272   void (* direction_changed)   (GtkWidget        *widget,
 273                                 GtkTextDirection  previous_direction);
 274   void (* grab_notify)         (GtkWidget        *widget,
 275                                 gboolean          was_grabbed);
 276   void (* child_notify)        (GtkWidget        *widget,
 277                                 GParamSpec       *pspec);
 278
 279   /* Mnemonics */
 280   gboolean (* mnemonic_activate) (GtkWidget    *widget,
 281                                   gboolean      group_cycling);
 282
 283   /* explicit focus */
 284   void     (* grab_focus)      (GtkWidget        *widget);
 285   gboolean (* focus)           (GtkWidget        *widget,
 286                                 GtkDirectionType  direction);
 287
 288   /* events */
 289   gboolean (* event)                    (GtkWidget           *widget,
 290                                          GdkEvent            *event);
 291   gboolean (* button_press_event)       (GtkWidget           *widget,
 292                                          GdkEventButton      *event);
 293   gboolean (* button_release_event)     (GtkWidget           *widget,
 294                                          GdkEventButton      *event);
 295   gboolean (* scroll_event)             (GtkWidget           *widget,
 296                                          GdkEventScroll      *event);
 297   gboolean (* motion_notify_event)      (GtkWidget           *widget,
 298                                          GdkEventMotion      *event);
 299   gboolean (* delete_event)             (GtkWidget           *widget,
 300                                          GdkEventAny         *event);
 301   gboolean (* destroy_event)            (GtkWidget           *widget,
 302                                          GdkEventAny         *event);
 303   gboolean (* expose_event)             (GtkWidget           *widget,
 304                                          GdkEventExpose      *event);
 305   gboolean (* key_press_event)          (GtkWidget           *widget,
 306                                          GdkEventKey         *event);
 307   gboolean (* key_release_event)        (GtkWidget           *widget,
 308                                          GdkEventKey         *event);
 309   gboolean (* enter_notify_event)       (GtkWidget           *widget,
 310                                          GdkEventCrossing    *event);
 311   gboolean (* leave_notify_event)       (GtkWidget           *widget,
 312                                          GdkEventCrossing    *event);
 313   gboolean (* configure_event)          (GtkWidget           *widget,
 314                                          GdkEventConfigure   *event);
 315   gboolean (* focus_in_event)           (GtkWidget           *widget,
 316                                          GdkEventFocus       *event);
 317   gboolean (* focus_out_event)          (GtkWidget           *widget,
 318                                          GdkEventFocus       *event);
 319   gboolean (* map_event)                (GtkWidget           *widget,
 320                                          GdkEventAny         *event);
 321   gboolean (* unmap_event)              (GtkWidget           *widget,
 322                                          GdkEventAny         *event);
 323   gboolean (* property_notify_event)    (GtkWidget           *widget,
 324                                          GdkEventProperty    *event);
 325   gboolean (* selection_clear_event)    (GtkWidget           *widget,
 326                                          GdkEventSelection   *event);
 327   gboolean (* selection_request_event)  (GtkWidget           *widget,
 328                                          GdkEventSelection   *event);
 329   gboolean (* selection_notify_event)   (GtkWidget           *widget,
 330                                          GdkEventSelection   *event);
 331   gboolean (* proximity_in_event)       (GtkWidget           *widget,
 332                                          GdkEventProximity   *event);
 333   gboolean (* proximity_out_event)      (GtkWidget           *widget,
 334                                          GdkEventProximity   *event);
 335   gboolean (* visibility_notify_event)  (GtkWidget           *widget,
 336                                          GdkEventVisibility  *event);
 337   gboolean (* client_event)             (GtkWidget           *widget,
 338                                          GdkEventClient      *event);
 339   gboolean (* no_expose_event)          (GtkWidget           *widget,
 340                                          GdkEventAny         *event);
 341   gboolean (* window_state_event)       (GtkWidget           *widget,
 342                                          GdkEventWindowState *event);
 343
 344   /* selection */
 345   void (* selection_get)           (GtkWidget          *widget,
 346                                     GtkSelectionData   *selection_data,
 347                                     guint               info,
 348                                     guint               time_);
 349   void (* selection_received)      (GtkWidget          *widget,
 350                                     GtkSelectionData   *selection_data,
 351                                     guint               time_);
 352
 353   /* Source side drag signals */
 354   void (* drag_begin)              (GtkWidget          *widget,
 355                                     GdkDragContext     *context);
 356   void (* drag_end)                (GtkWidget          *widget,
 357                                     GdkDragContext     *context);
 358   void (* drag_data_get)           (GtkWidget          *widget,
 359                                     GdkDragContext     *context,
 360                                     GtkSelectionData   *selection_data,
 361                                     guint               info,
 362                                     guint               time_);
 363   void (* drag_data_delete)        (GtkWidget          *widget,
 364                                     GdkDragContext     *context);
 365
 366   /* Target side drag signals */
 367   void (* drag_leave)              (GtkWidget          *widget,
 368                                     GdkDragContext     *context,
 369                                     guint               time_);
 370   gboolean (* drag_motion)         (GtkWidget          *widget,
 371                                     GdkDragContext     *context,
 372                                     gint                x,
 373                                     gint                y,
 374                                     guint               time_);
 375   gboolean (* drag_drop)           (GtkWidget          *widget,
 376                                     GdkDragContext     *context,
 377                                     gint                x,
 378                                     gint                y,
 379                                     guint               time_);
 380   void (* drag_data_received)      (GtkWidget          *widget,
 381                                     GdkDragContext     *context,
 382                                     gint                x,
 383                                     gint                y,
 384                                     GtkSelectionData   *selection_data,
 385                                     guint               info,
 386                                     guint               time_);
 387
 388   /* Signals used only for keybindings */
 389   gboolean (* popup_menu)          (GtkWidget          *widget);
 390
 391   /* If a widget has multiple tooltips/whatsthis, it should show the
 392    * one for the current focus location, or if that doesn't make
 393    * sense, should cycle through them showing each tip alongside
 394    * whatever piece of the widget it applies to.
 395    */
 396   gboolean (* show_help)           (GtkWidget          *widget,
 397                                     GtkWidgetHelpType   help_type);
 398
 399   /* accessibility support
 400    */
 401   AtkObject*   (*get_accessible)     (GtkWidget *widget);
 402
 403   void         (*screen_changed)     (GtkWidget *widget,
 404                                       GdkScreen *previous_screen);
 405   gboolean     (*can_activate_accel) (GtkWidget *widget,
 406                                       guint      signal_id);
 407
 408   /* Sent when a grab is broken. */
 409   gboolean (*grab_broken_event) (GtkWidget           *widget,
 410                                  GdkEventGrabBroken  *event);
 411
 412   void         (* composited_changed) (GtkWidget *widget);
 413
 414   gboolean     (* query_tooltip)      (GtkWidget  *widget,
 415                                        gint        x,
 416                                        gint        y,
 417                                        gboolean    keyboard_tooltip,
 418                                        GtkTooltip *tooltip);
 419   /* Signals without a C default handler class slot:
 420    * gboolean   (*damage_event) (GtkWidget      *widget,
 421    *                             GdkEventExpose *event);
 422    */
 423
 424   /* Padding for future expansion */
 425   void (*_gtk_reserved5) (void);
 426   void (*_gtk_reserved6) (void);
 427   void (*_gtk_reserved7) (void);
 428 };
 429
 430 struct _GtkWidgetAuxInfo
 431 {
 432   gint x;
 433   gint y;
 434   gint width;
 435   gint height;
 436   guint x_set : 1;
 437   guint y_set : 1;
 438 };
 439
 440 struct _GtkWidgetShapeInfo
 441 {
 442   gint16     offset_x;
 443   gint16     offset_y;
 444   GdkBitmap *shape_mask;
 445 };
 446
 447 GType      gtk_widget_get_type            (void) G_GNUC_CONST;
 448 GtkWidget* gtk_widget_new                 (GType                type,
 449                                            const gchar         *first_property_name,
 450                                            ...);
 451 void       gtk_widget_destroy             (GtkWidget           *widget);
 452 void       gtk_widget_destroyed           (GtkWidget           *widget,
 453                                            GtkWidget          **widget_pointer);
 454 #ifndef GTK_DISABLE_DEPRECATED
 455 GtkWidget* gtk_widget_ref                 (GtkWidget           *widget);
 456 void       gtk_widget_unref               (GtkWidget           *widget);
 457 void       gtk_widget_set                 (GtkWidget           *widget,
 458                                            const gchar         *first_property_name,
 459                                            ...) G_GNUC_NULL_TERMINATED;
 460 #endif /* GTK_DISABLE_DEPRECATED */
 461 void       gtk_widget_unparent            (GtkWidget           *widget);
 462 void       gtk_widget_show                (GtkWidget           *widget);
 463 void       gtk_widget_show_now            (GtkWidget           *widget);
 464 void       gtk_widget_hide                (GtkWidget           *widget);
 465 void       gtk_widget_show_all            (GtkWidget           *widget);
 466 void       gtk_widget_hide_all            (GtkWidget           *widget);
 467 void       gtk_widget_set_no_show_all     (GtkWidget           *widget,
 468                                            gboolean             no_show_all);
 469 gboolean   gtk_widget_get_no_show_all     (GtkWidget           *widget);
 470 void       gtk_widget_map                 (GtkWidget           *widget);
 471 void       gtk_widget_unmap               (GtkWidget           *widget);
 472 void       gtk_widget_realize             (GtkWidget           *widget);
 473 void       gtk_widget_unrealize           (GtkWidget           *widget);
 474
 475 /* Queuing draws */
 476 void       gtk_widget_queue_draw          (GtkWidget           *widget);
 477 void       gtk_widget_queue_draw_area     (GtkWidget           *widget,
 478                                            gint                 x,
 479                                            gint                 y,
 480                                            gint                 width,
 481                                            gint                 height);
 482 #ifndef GTK_DISABLE_DEPRECATED
 483 void       gtk_widget_queue_clear         (GtkWidget           *widget);
 484 void       gtk_widget_queue_clear_area    (GtkWidget           *widget,
 485                                            gint                 x,
 486                                            gint                 y,
 487                                            gint                 width,
 488                                            gint                 height);
 489 #endif /* GTK_DISABLE_DEPRECATED */
 490
 491
 492 void       gtk_widget_queue_resize        (GtkWidget           *widget);
 493 void       gtk_widget_queue_resize_no_redraw (GtkWidget *widget);
 494 #ifndef GTK_DISABLE_DEPRECATED
 495 void       gtk_widget_draw                (GtkWidget           *widget,
 496                                            const GdkRectangle  *area);
 497 #endif /* GTK_DISABLE_DEPRECATED */
 498 void       gtk_widget_size_request        (GtkWidget           *widget,
 499                                            GtkRequisition      *requisition);
 500 void       gtk_widget_size_allocate       (GtkWidget           *widget,
 501                                            GtkAllocation       *allocation);
 502 void       gtk_widget_get_child_requisition (GtkWidget         *widget,
 503                                              GtkRequisition    *requisition);
 504 void       gtk_widget_add_accelerator     (GtkWidget           *widget,
 505                                            const gchar         *accel_signal,
 506                                            GtkAccelGroup       *accel_group,
 507                                            guint                accel_key,
 508                                            GdkModifierType      accel_mods,
 509                                            GtkAccelFlags        accel_flags);
 510 gboolean   gtk_widget_remove_accelerator  (GtkWidget           *widget,
 511                                            GtkAccelGroup       *accel_group,
 512                                            guint                accel_key,
 513                                            GdkModifierType      accel_mods);
 514 void       gtk_widget_set_accel_path      (GtkWidget           *widget,
 515                                            const gchar         *accel_path,
 516                                            GtkAccelGroup       *accel_group);
 517 const gchar* _gtk_widget_get_accel_path   (GtkWidget           *widget,
 518                                            gboolean            *locked);
 519 GList*     gtk_widget_list_accel_closures (GtkWidget           *widget);
 520 gboolean   gtk_widget_can_activate_accel  (GtkWidget           *widget,
 521                                            guint                signal_id);
 522 gboolean   gtk_widget_mnemonic_activate   (GtkWidget           *widget,
 523                                            gboolean             group_cycling);
 524 gboolean   gtk_widget_event               (GtkWidget           *widget,
 525                                            GdkEvent            *event);
 526 gint       gtk_widget_send_expose         (GtkWidget           *widget,
 527                                            GdkEvent            *event);
 528
 529 gboolean   gtk_widget_activate               (GtkWidget        *widget);
 530 gboolean   gtk_widget_set_scroll_adjustments (GtkWidget        *widget,
 531                                               GtkAdjustment    *hadjustment,
 532                                               GtkAdjustment    *vadjustment);
 533
 534 void       gtk_widget_reparent            (GtkWidget           *widget,
 535                                            GtkWidget           *new_parent);
 536 gboolean   gtk_widget_intersect           (GtkWidget           *widget,
 537                                            const GdkRectangle  *area,
 538                                            GdkRectangle        *intersection);
 539 GdkRegion *gtk_widget_region_intersect    (GtkWidget           *widget,
 540                                            const GdkRegion     *region);
 541
 542 void    gtk_widget_freeze_child_notify    (GtkWidget           *widget);
 543 void    gtk_widget_child_notify           (GtkWidget           *widget,
 544                                            const gchar         *child_property);
 545 void    gtk_widget_thaw_child_notify      (GtkWidget           *widget);
 546
 547 gboolean   gtk_widget_is_focus            (GtkWidget           *widget);
 548 void       gtk_widget_grab_focus          (GtkWidget           *widget);
 549 void       gtk_widget_grab_default        (GtkWidget           *widget);
 550
 551 void                  gtk_widget_set_name               (GtkWidget    *widget,
 552                                                          const gchar  *name);
 553 G_CONST_RETURN gchar* gtk_widget_get_name               (GtkWidget    *widget);
 554 void                  gtk_widget_set_state              (GtkWidget    *widget,
 555                                                          GtkStateType  state);
 556 void                  gtk_widget_set_sensitive          (GtkWidget    *widget,
 557                                                          gboolean      sensitive);
 558 void                  gtk_widget_set_app_paintable      (GtkWidget    *widget,
 559                                                          gboolean      app_paintable);
 560 void                  gtk_widget_set_double_buffered    (GtkWidget    *widget,
 561                                                          gboolean      double_buffered);
 562 void                  gtk_widget_set_redraw_on_allocate (GtkWidget    *widget,
 563                                                          gboolean      redraw_on_allocate);
 564 void                  gtk_widget_set_parent             (GtkWidget    *widget,
 565                                                          GtkWidget    *parent);
 566 void                  gtk_widget_set_parent_window      (GtkWidget    *widget,
 567                                                          GdkWindow    *parent_window);
 568 void                  gtk_widget_set_child_visible      (GtkWidget    *widget,
 569                                                          gboolean      is_visible);
 570 gboolean              gtk_widget_get_child_visible      (GtkWidget    *widget);
 571
 572 GtkWidget *gtk_widget_get_parent          (GtkWidget           *widget);
 573 GdkWindow *gtk_widget_get_parent_window   (GtkWidget           *widget);
 574
 575 gboolean   gtk_widget_child_focus         (GtkWidget           *widget,
 576                                            GtkDirectionType     direction);
 577 gboolean   gtk_widget_keynav_failed       (GtkWidget           *widget,
 578                                            GtkDirectionType     direction);
 579 void       gtk_widget_error_bell          (GtkWidget           *widget);
 580
 581 void       gtk_widget_set_size_request    (GtkWidget           *widget,
 582                                            gint                 width,
 583                                            gint                 height);
 584 void       gtk_widget_get_size_request    (GtkWidget           *widget,
 585                                            gint                *width,
 586                                            gint                *height);
 587 #ifndef GTK_DISABLE_DEPRECATED
 588 void       gtk_widget_set_uposition       (GtkWidget           *widget,
 589                                            gint                 x,
 590                                            gint                 y);
 591 void       gtk_widget_set_usize           (GtkWidget           *widget,
 592                                            gint                 width,
 593                                            gint                 height);
 594 #endif
 595
 596 void       gtk_widget_set_events          (GtkWidget           *widget,
 597                                            gint                 events);
 598 void       gtk_widget_add_events          (GtkWidget           *widget,
 599                                            gint                 events);
 600 void       gtk_widget_set_extension_events (GtkWidget           *widget,
 601                                             GdkExtensionMode    mode);
 602
 603 GdkExtensionMode gtk_widget_get_extension_events (GtkWidget     *widget);
 604 GtkWidget*   gtk_widget_get_toplevel    (GtkWidget      *widget);
 605 GtkWidget*   gtk_widget_get_ancestor    (GtkWidget      *widget,
 606                                          GType           widget_type);
 607 GdkColormap* gtk_widget_get_colormap    (GtkWidget      *widget);
 608 GdkVisual*   gtk_widget_get_visual      (GtkWidget      *widget);
 609
 610 GdkScreen *   gtk_widget_get_screen      (GtkWidget *widget);
 611 gboolean      gtk_widget_has_screen      (GtkWidget *widget);
 612 GdkDisplay *  gtk_widget_get_display     (GtkWidget *widget);
 613 GdkWindow *   gtk_widget_get_root_window (GtkWidget *widget);
 614 GtkSettings*  gtk_widget_get_settings    (GtkWidget *widget);
 615 GtkClipboard *gtk_widget_get_clipboard   (GtkWidget *widget,
 616                                           GdkAtom    selection);
 617 GdkPixmap *   gtk_widget_get_snapshot    (GtkWidget *widget);
 618
 619 #ifndef GTK_DISABLE_DEPRECATED
 620 #define gtk_widget_set_visual(widget,visual)  ((void) 0)
 621 #define gtk_widget_push_visual(visual)        ((void) 0)
 622 #define gtk_widget_pop_visual()               ((void) 0)
 623 #define gtk_widget_set_default_visual(visual) ((void) 0)
 624 #endif /* GTK_DISABLE_DEPRECATED */
 625
 626 /* Accessibility support */
 627 AtkObject*       gtk_widget_get_accessible               (GtkWidget          *widget);
 628
 629 /* The following functions must not be called on an already
 630  * realized widget. Because it is possible that somebody
 631  * can call get_colormap() or get_visual() and save the
 632  * result, these functions are probably only safe to
 633  * call in a widget's init() function.
 634  */
 635 void         gtk_widget_set_colormap    (GtkWidget      *widget,
 636                                          GdkColormap    *colormap);
 637
 638 gint         gtk_widget_get_events      (GtkWidget      *widget);
 639 void         gtk_widget_get_pointer     (GtkWidget      *widget,
 640                                          gint           *x,
 641                                          gint           *y);
 642
 643 gboolean     gtk_widget_is_ancestor     (GtkWidget      *widget,
 644                                          GtkWidget      *ancestor);
 645
 646 gboolean     gtk_widget_translate_coordinates (GtkWidget  *src_widget,
 647                                                GtkWidget  *dest_widget,
 648                                                gint        src_x,
 649                                                gint        src_y,
 650                                                gint       *dest_x,
 651                                                gint       *dest_y);
 652
 653 /* Hide widget and return TRUE.
 654  */
 655 gboolean     gtk_widget_hide_on_delete  (GtkWidget      *widget);
 656
 657 /* Widget styles.
 658  */
 659 void       gtk_widget_set_style         (GtkWidget      *widget,
 660                                          GtkStyle       *style);
 661 void       gtk_widget_ensure_style      (GtkWidget      *widget);
 662 GtkStyle*  gtk_widget_get_style         (GtkWidget      *widget);
 663
 664 void        gtk_widget_modify_style       (GtkWidget            *widget,
 665                                            GtkRcStyle           *style);
 666 GtkRcStyle *gtk_widget_get_modifier_style (GtkWidget            *widget);
 667 void        gtk_widget_modify_fg          (GtkWidget            *widget,
 668                                            GtkStateType          state,
 669                                            const GdkColor       *color);
 670 void        gtk_widget_modify_bg          (GtkWidget            *widget,
 671                                            GtkStateType          state,
 672                                            const GdkColor       *color);
 673 void        gtk_widget_modify_text        (GtkWidget            *widget,
 674                                            GtkStateType          state,
 675                                            const GdkColor       *color);
 676 void        gtk_widget_modify_base        (GtkWidget            *widget,
 677                                            GtkStateType          state,
 678                                            const GdkColor       *color);
 679 void        gtk_widget_modify_cursor      (GtkWidget            *widget,
 680                                            const GdkColor       *primary,
 681                                            const GdkColor       *secondary);
 682 void        gtk_widget_modify_font        (GtkWidget            *widget,
 683                                            PangoFontDescription *font_desc);
 684
 685 #ifndef GTK_DISABLE_DEPRECATED
 686 #define gtk_widget_set_rc_style(widget)          (gtk_widget_set_style (widget, NULL))
 687 #define gtk_widget_restore_default_style(widget) (gtk_widget_set_style (widget, NULL))
 688 #endif
 689
 690 PangoContext *gtk_widget_create_pango_context (GtkWidget   *widget);
 691 PangoContext *gtk_widget_get_pango_context    (GtkWidget   *widget);
 692 PangoLayout  *gtk_widget_create_pango_layout  (GtkWidget   *widget,
 693                                                const gchar *text);
 694
 695 GdkPixbuf    *gtk_widget_render_icon          (GtkWidget   *widget,
 696                                                const gchar *stock_id,
 697                                                GtkIconSize  size,
 698                                                const gchar *detail);
 699
 700 /* handle composite names for GTK_COMPOSITE_CHILD widgets,
 701  * the returned name is newly allocated.
 702  */
 703 void   gtk_widget_set_composite_name    (GtkWidget      *widget,
 704                                          const gchar    *name);
 705 gchar* gtk_widget_get_composite_name    (GtkWidget      *widget);
 706
 707 /* Descend recursively and set rc-style on all widgets without user styles */
 708 void       gtk_widget_reset_rc_styles   (GtkWidget      *widget);
 709
 710 /* Push/pop pairs, to change default values upon a widget's creation.
 711  * This will override the values that got set by the
 712  * gtk_widget_set_default_* () functions.
 713  */
 714 void         gtk_widget_push_colormap        (GdkColormap *cmap);
 715 void         gtk_widget_push_composite_child (void);
 716 void         gtk_widget_pop_composite_child  (void);
 717 void         gtk_widget_pop_colormap         (void);
 718
 719 /* widget style properties
 720  */
 721 void gtk_widget_class_install_style_property        (GtkWidgetClass     *klass,
 722                                                      GParamSpec         *pspec);
 723 void gtk_widget_class_install_style_property_parser (GtkWidgetClass     *klass,
 724                                                      GParamSpec         *pspec,
 725                                                      GtkRcPropertyParser parser);
 726 GParamSpec*  gtk_widget_class_find_style_property   (GtkWidgetClass     *klass,
 727                                                      const gchar        *property_name);
 728 GParamSpec** gtk_widget_class_list_style_properties (GtkWidgetClass     *klass,
 729                                                      guint              *n_properties);
 730 void gtk_widget_style_get_property (GtkWidget        *widget,
 731                                     const gchar    *property_name,
 732                                     GValue           *value);
 733 void gtk_widget_style_get_valist   (GtkWidget        *widget,
 734                                     const gchar    *first_property_name,
 735                                     va_list         var_args);
 736 void gtk_widget_style_get          (GtkWidget        *widget,
 737                                     const gchar    *first_property_name,
 738                                     ...) G_GNUC_NULL_TERMINATED;
 739
 740
 741 /* Set certain default values to be used at widget creation time.
 742  */
 743 void         gtk_widget_set_default_colormap (GdkColormap *colormap);
 744 GtkStyle*    gtk_widget_get_default_style    (void);
 745 #ifndef GDK_MULTIHEAD_SAFE
 746 GdkColormap* gtk_widget_get_default_colormap (void);
 747 GdkVisual*   gtk_widget_get_default_visual   (void);
 748 #endif
 749
 750 /* Functions for setting directionality for widgets
 751  */
 752
 753 void             gtk_widget_set_direction         (GtkWidget        *widget,
 754                                                    GtkTextDirection  dir);
 755 GtkTextDirection gtk_widget_get_direction         (GtkWidget        *widget);
 756
 757 void             gtk_widget_set_default_direction (GtkTextDirection  dir);
 758 GtkTextDirection gtk_widget_get_default_direction (void);
 759
 760 /* Compositing manager functionality */
 761 gboolean gtk_widget_is_composited (GtkWidget *widget);
 762
 763 /* Counterpart to gdk_window_shape_combine_mask.
 764  */
 765 void         gtk_widget_shape_combine_mask (GtkWidget *widget,
 766                                             GdkBitmap *shape_mask,
 767                                             gint       offset_x,
 768                                             gint       offset_y);
 769 void         gtk_widget_input_shape_combine_mask (GtkWidget *widget,
 770                                                   GdkBitmap *shape_mask,
 771                                                   gint       offset_x,
 772                                                   gint       offset_y);
 773
 774 /* internal function */
 775 void         gtk_widget_reset_shapes       (GtkWidget *widget);
 776
 777 /* Compute a widget's path in the form "GtkWindow.MyLabel", and
 778  * return newly alocated strings.
 779  */
 780 void         gtk_widget_path               (GtkWidget *widget,
 781                                             guint     *path_length,
 782                                             gchar    **path,
 783                                             gchar    **path_reversed);
 784 void         gtk_widget_class_path         (GtkWidget *widget,
 785                                             guint     *path_length,
 786                                             gchar    **path,
 787                                             gchar    **path_reversed);
 788
 789 GList* gtk_widget_list_mnemonic_labels  (GtkWidget *widget);
 790 void   gtk_widget_add_mnemonic_label    (GtkWidget *widget,
 791                                          GtkWidget *label);
 792 void   gtk_widget_remove_mnemonic_label (GtkWidget *widget,
 793                                          GtkWidget *label);
 794
 795 void                  gtk_widget_set_tooltip_window    (GtkWidget   *widget,
 796                                                         GtkWindow   *custom_window);
 797 GtkWindow *gtk_widget_get_tooltip_window    (GtkWidget   *widget);
 798 void       gtk_widget_trigger_tooltip_query (GtkWidget   *widget);
 799 void       gtk_widget_set_tooltip_text      (GtkWidget   *widget,
 800                                              const gchar *text);
 801 gchar *    gtk_widget_get_tooltip_text      (GtkWidget   *widget);
 802 void       gtk_widget_set_tooltip_markup    (GtkWidget   *widget,
 803                                              const gchar *markup);
 804 gchar *    gtk_widget_get_tooltip_markup    (GtkWidget   *widget);
 805 void       gtk_widget_set_has_tooltip       (GtkWidget   *widget,
 806                                              gboolean     has_tooltip);
 807 gboolean   gtk_widget_get_has_tooltip       (GtkWidget   *widget);
 808
 809 GType           gtk_requisition_get_type (void) G_GNUC_CONST;
 810 GtkRequisition *gtk_requisition_copy     (const GtkRequisition *requisition);
 811 void            gtk_requisition_free     (GtkRequisition       *requisition);
 812
 813 #if     defined (GTK_TRACE_OBJECTS) && defined (__GNUC__)
 814 #  define gtk_widget_ref gtk_object_ref
 815 #  define gtk_widget_unref gtk_object_unref
 816 #endif  /* GTK_TRACE_OBJECTS && __GNUC__ */
 817
 818 void              _gtk_widget_grab_notify                 (GtkWidget    *widget,
 819                                                            gboolean     was_grabbed);
 820
 821 GtkWidgetAuxInfo *_gtk_widget_get_aux_info                (GtkWidget    *widget,
 822                                                            gboolean      create);
 823 void              _gtk_widget_propagate_hierarchy_changed (GtkWidget    *widget,
 824                                                            GtkWidget    *previous_toplevel);
 825 void              _gtk_widget_propagate_screen_changed    (GtkWidget    *widget,
 826                                                            GdkScreen    *previous_screen);
 827 void              _gtk_widget_propagate_composited_changed (GtkWidget    *widget);
 828
 829 GdkColormap* _gtk_widget_peek_colormap (void);
 830
 831 G_END_DECLS
 832
 833 #endif /* __GTK_WIDGET_H__ */