1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
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.
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.
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.
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/.
27 #if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
28 #error "Only <gtk/gtk.h> can be included directly."
31 #ifndef __GTK_WIDGET_H__
32 #define __GTK_WIDGET_H__
35 #include <gtk/gtkaccelgroup.h>
36 #include <gtk/gtkobject.h>
37 #include <gtk/gtkadjustment.h>
38 #include <gtk/gtkstyle.h>
39 #include <gtk/gtksettings.h>
46 * @GTK_TOPLEVEL: widgets without a real parent, as there are #GtkWindow<!-- -->s and
47 * #GtkMenu<!-- -->s have this flag set throughout their lifetime.
48 * Toplevel widgets always contain their own #GdkWindow.
49 * @GTK_NO_WINDOW: Indicative for a widget that does not provide its own #GdkWindow.
50 * Visible action (e.g. drawing) is performed on the parent's #GdkWindow.
51 * @GTK_REALIZED: Set by gtk_widget_realize(), unset by gtk_widget_unrealize().
52 * A realized widget has an associated #GdkWindow.
53 * @GTK_MAPPED: Set by gtk_widget_map(), unset by gtk_widget_unmap().
54 * Only realized widgets can be mapped. It means that gdk_window_show()
55 * has been called on the widgets window(s).
56 * @GTK_VISIBLE: Set by gtk_widget_show(), unset by gtk_widget_hide(). Implies that a
57 * widget will be mapped as soon as its parent is mapped.
58 * @GTK_SENSITIVE: Set and unset by gtk_widget_set_sensitive().
59 * The sensitivity of a widget determines whether it will receive
60 * certain events (e.g. button or key presses). One premise for
61 * the widget's sensitivity is to have this flag set.
62 * @GTK_PARENT_SENSITIVE: Set and unset by gtk_widget_set_sensitive() operations on the
63 * parents of the widget.
64 * This is the second premise for the widget's sensitivity. Once
65 * it has %GTK_SENSITIVE and %GTK_PARENT_SENSITIVE set, its state is
66 * effectively sensitive. This is expressed (and can be examined) by
67 * the #GTK_WIDGET_IS_SENSITIVE macro.
68 * @GTK_CAN_FOCUS: Determines whether a widget is able to handle focus grabs.
69 * @GTK_HAS_FOCUS: Set by gtk_widget_grab_focus() for widgets that also
70 * have %GTK_CAN_FOCUS set. The flag will be unset once another widget
72 * @GTK_CAN_DEFAULT: The widget is allowed to receive the default action via
73 * gtk_widget_grab_default() and will reserve space to draw the default if possible
74 * @GTK_HAS_DEFAULT: The widget currently is receiving the default action and
75 * should be drawn appropriately if possible
76 * @GTK_HAS_GRAB: Set by gtk_grab_add(), unset by gtk_grab_remove(). It means that the
77 * widget is in the grab_widgets stack, and will be the preferred one for
78 * receiving events other than ones of cosmetic value.
79 * @GTK_RC_STYLE: Indicates that the widget's style has been looked up through the rc
80 * mechanism. It does not imply that the widget actually had a style
81 * defined through the rc mechanism.
82 * @GTK_COMPOSITE_CHILD: Indicates that the widget is a composite child of its parent; see
83 * gtk_widget_push_composite_child(), gtk_widget_pop_composite_child().
84 * @GTK_NO_REPARENT: Unused since before GTK+ 1.2, will be removed in a future version.
85 * @GTK_APP_PAINTABLE: Set and unset by gtk_widget_set_app_paintable().
86 * Must be set on widgets whose window the application directly draws on,
87 * in order to keep GTK+ from overwriting the drawn stuff. See
88 * <xref linkend="app-paintable-widgets"/> for a detailed
89 * description of this flag.
90 * @GTK_RECEIVES_DEFAULT: The widget when focused will receive the default action and have
91 * %GTK_HAS_DEFAULT set even if there is a different widget set as default.
92 * @GTK_DOUBLE_BUFFERED: Set and unset by gtk_widget_set_double_buffered().
93 * Indicates that exposes done on the widget should be
94 * double-buffered. See <xref linkend="double-buffering"/> for a
95 * detailed discussion of how double-buffering works in GTK+ and
96 * why you may want to disable it for special cases.
99 * Tells about certain properties of the widget.
103 GTK_TOPLEVEL = 1 << 4,
104 GTK_NO_WINDOW = 1 << 5,
105 GTK_REALIZED = 1 << 6,
107 GTK_VISIBLE = 1 << 8,
108 GTK_SENSITIVE = 1 << 9,
109 GTK_PARENT_SENSITIVE = 1 << 10,
110 GTK_CAN_FOCUS = 1 << 11,
111 GTK_HAS_FOCUS = 1 << 12,
112 GTK_CAN_DEFAULT = 1 << 13,
113 GTK_HAS_DEFAULT = 1 << 14,
114 GTK_HAS_GRAB = 1 << 15,
115 GTK_RC_STYLE = 1 << 16,
116 GTK_COMPOSITE_CHILD = 1 << 17,
117 GTK_NO_REPARENT = 1 << 18,
118 GTK_APP_PAINTABLE = 1 << 19,
119 GTK_RECEIVES_DEFAULT = 1 << 20,
120 GTK_DOUBLE_BUFFERED = 1 << 21,
121 GTK_NO_SHOW_ALL = 1 << 22
124 /* Kinds of widget-specific help */
127 GTK_WIDGET_HELP_TOOLTIP,
128 GTK_WIDGET_HELP_WHATS_THIS
131 /* Macro for casting a pointer to a GtkWidget or GtkWidgetClass pointer.
132 * Macros for testing whether `widget' or `klass' are of type GTK_TYPE_WIDGET.
134 #define GTK_TYPE_WIDGET (gtk_widget_get_type ())
135 #define GTK_WIDGET(widget) (G_TYPE_CHECK_INSTANCE_CAST ((widget), GTK_TYPE_WIDGET, GtkWidget))
136 #define GTK_WIDGET_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WIDGET, GtkWidgetClass))
137 #define GTK_IS_WIDGET(widget) (G_TYPE_CHECK_INSTANCE_TYPE ((widget), GTK_TYPE_WIDGET))
138 #define GTK_IS_WIDGET_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WIDGET))
139 #define GTK_WIDGET_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WIDGET, GtkWidgetClass))
141 /* Macros for extracting various fields from GtkWidget and GtkWidgetClass.
143 #ifndef GTK_DISABLE_DEPRECATED
146 * @wid: a #GtkWidget.
148 * Gets the type of a widget.
150 * Deprecated: 2.20: Use G_OBJECT_TYPE() instead.
152 #define GTK_WIDGET_TYPE(wid) (GTK_OBJECT_TYPE (wid))
157 * @wid: a #GtkWidget.
159 * Returns the current state of the widget, as a #GtkStateType.
161 * Deprecated: 2.20: Use gtk_widget_get_state() instead.
163 #define GTK_WIDGET_STATE(wid) (GTK_WIDGET (wid)->state)
164 /* FIXME: Deprecating GTK_WIDGET_STATE requires fixing GTK internals. */
166 #ifndef GTK_DISABLE_DEPRECATED
168 * GTK_WIDGET_SAVED_STATE:
169 * @wid: a #GtkWidget.
171 * Returns the saved state of the widget, as a #GtkStateType.
173 * The saved state will be restored when a widget gets sensitive
174 * again, after it has been made insensitive with gtk_widget_set_state()
175 * or gtk_widget_set_sensitive().
177 * Deprecated: 2.20: Do not used it.
179 #define GTK_WIDGET_SAVED_STATE(wid) (GTK_WIDGET (wid)->saved_state)
183 /* Macros for extracting the widget flags from GtkWidget.
187 * @wid: a #GtkWidget.
189 * Returns the widget flags from @wid.
191 * Deprecated: 2.20: Do not use it.
193 #define GTK_WIDGET_FLAGS(wid) (GTK_OBJECT_FLAGS (wid))
194 /* FIXME: Deprecating GTK_WIDGET_FLAGS requires fixing GTK internals. */
196 #ifndef GTK_DISABLE_DEPRECATED
198 * GTK_WIDGET_TOPLEVEL:
199 * @wid: a #GtkWidget.
201 * Evaluates to %TRUE if the widget is a toplevel widget.
203 * Deprecated: 2.20: Use gtk_widget_is_toplevel() instead.
205 #define GTK_WIDGET_TOPLEVEL(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_TOPLEVEL) != 0)
209 * GTK_WIDGET_NO_WINDOW:
210 * @wid: a #GtkWidget.
212 * Evaluates to %TRUE if the widget doesn't have an own #GdkWindow.
214 * Deprecated: 2.20: Use gtk_widget_get_has_window() instead.
216 #define GTK_WIDGET_NO_WINDOW(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_NO_WINDOW) != 0)
217 /* FIXME: Deprecating GTK_WIDGET_NO_WINDOW requires fixing GTK internals. */
220 * GTK_WIDGET_REALIZED:
221 * @wid: a #GtkWidget.
223 * Evaluates to %TRUE if the widget is realized.
225 #define GTK_WIDGET_REALIZED(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_REALIZED) != 0)
229 * @wid: a #GtkWidget.
231 * Evaluates to %TRUE if the widget is mapped.
233 #define GTK_WIDGET_MAPPED(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_MAPPED) != 0)
236 * GTK_WIDGET_VISIBLE:
237 * @wid: a #GtkWidget.
239 * Evaluates to %TRUE if the widget is visible.
241 #define GTK_WIDGET_VISIBLE(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_VISIBLE) != 0)
244 * GTK_WIDGET_DRAWABLE:
245 * @wid: a #GtkWidget.
247 * Evaluates to %TRUE if the widget is mapped and visible.
249 #define GTK_WIDGET_DRAWABLE(wid) (GTK_WIDGET_VISIBLE (wid) && GTK_WIDGET_MAPPED (wid))
252 * GTK_WIDGET_SENSITIVE:
253 * @wid: a #GtkWidget.
255 * Evaluates to %TRUE if the #GTK_SENSITIVE flag has be set on the widget.
257 #define GTK_WIDGET_SENSITIVE(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_SENSITIVE) != 0)
260 * GTK_WIDGET_PARENT_SENSITIVE:
261 * @wid: a #GtkWidget.
263 * Evaluates to %TRUE if the #GTK_PARENT_SENSITIVE flag has be set on the widget.
265 #define GTK_WIDGET_PARENT_SENSITIVE(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_PARENT_SENSITIVE) != 0)
268 * GTK_WIDGET_IS_SENSITIVE:
269 * @wid: a #GtkWidget.
271 * Evaluates to %TRUE if the widget is effectively sensitive.
273 #define GTK_WIDGET_IS_SENSITIVE(wid) (GTK_WIDGET_SENSITIVE (wid) && \
274 GTK_WIDGET_PARENT_SENSITIVE (wid))
276 #ifndef GTK_DISABLE_DEPRECATED
278 * GTK_WIDGET_CAN_FOCUS:
279 * @wid: a #GtkWidget.
281 * Evaluates to %TRUE if the widget is able to handle focus grabs.
283 * Deprecated: 2.20: Use gtk_widget_get_can_focus() instead.
285 #define GTK_WIDGET_CAN_FOCUS(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_CAN_FOCUS) != 0)
289 * GTK_WIDGET_HAS_FOCUS:
290 * @wid: a #GtkWidget.
292 * Evaluates to %TRUE if the widget has grabbed the focus and no other
293 * widget has done so more recently.
295 #define GTK_WIDGET_HAS_FOCUS(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_FOCUS) != 0)
297 #ifndef GTK_DISABLE_DEPRECATED
299 * GTK_WIDGET_CAN_DEFAULT:
300 * @wid: a #GtkWidget.
302 * Evaluates to %TRUE if the widget is allowed to receive the default action
303 * via gtk_widget_grab_default().
305 * Deprecated: 2.20: Use gtk_widget_get_can_default() instead.
307 #define GTK_WIDGET_CAN_DEFAULT(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_CAN_DEFAULT) != 0)
310 #ifndef GTK_DISABLE_DEPRECATED
312 * GTK_WIDGET_HAS_DEFAULT:
313 * @wid: a #GtkWidget.
315 * Evaluates to %TRUE if the widget currently is receiving the default action.
317 * Deprecated: 2.20: Use gtk_widget_has_default() instead.
319 #define GTK_WIDGET_HAS_DEFAULT(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_DEFAULT) != 0)
322 #ifndef GTK_DISABLE_DEPRECATED
324 * GTK_WIDGET_HAS_GRAB:
325 * @wid: a #GtkWidget.
327 * Evaluates to %TRUE if the widget is in the grab_widgets stack, and will be
328 * the preferred one for receiving events other than ones of cosmetic value.
330 * Deprecated: 2.20: Use gtk_widget_has_grab() instead.
332 #define GTK_WIDGET_HAS_GRAB(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_GRAB) != 0)
335 #ifndef GTK_DISABLE_DEPRECATED
337 * GTK_WIDGET_RC_STYLE:
338 * @wid: a #GtkWidget.
340 * Evaluates to %TRUE if the widget's style has been looked up through the rc
343 * Deprecated: 2.20: Use gtk_widget_has_rc_style() instead.
345 #define GTK_WIDGET_RC_STYLE(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_RC_STYLE) != 0)
348 #ifndef GTK_DISABLE_DEPRECATED
350 * GTK_WIDGET_COMPOSITE_CHILD:
351 * @wid: a #GtkWidget.
353 * Evaluates to %TRUE if the widget is a composite child of its parent.
355 * Deprecated: 2.20: Use the #GtkWidget:composite-child property instead.
357 #define GTK_WIDGET_COMPOSITE_CHILD(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_COMPOSITE_CHILD) != 0)
360 #ifndef GTK_DISABLE_DEPRECATED
362 * GTK_WIDGET_APP_PAINTABLE:
363 * @wid: a #GtkWidget.
365 * Evaluates to %TRUE if the #GTK_APP_PAINTABLE flag has been set on the widget.
367 * Deprecated: 2.20: Use gtk_widget_get_app_paintable() instead.
369 #define GTK_WIDGET_APP_PAINTABLE(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_APP_PAINTABLE) != 0)
372 #ifndef GTK_DISABLE_DEPRECATED
374 * GTK_WIDGET_RECEIVES_DEFAULT:
375 * @wid: a #GtkWidget.
377 * Evaluates to %TRUE if the widget when focused will receive the default action
378 * even if there is a different widget set as default.
380 * Deprecated: 2.20: Use gtk_widget_get_receives_default() instead.
382 #define GTK_WIDGET_RECEIVES_DEFAULT(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_RECEIVES_DEFAULT) != 0)
385 #ifndef GTK_DISABLE_DEPRECATED
387 * GTK_WIDGET_DOUBLE_BUFFERED:
388 * @wid: a #GtkWidget.
390 * Evaluates to %TRUE if the #GTK_DOUBLE_BUFFERED flag has been set on the widget.
392 * Deprecated: 2.20: Use gtk_widget_get_double_buffered() instead.
394 #define GTK_WIDGET_DOUBLE_BUFFERED(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_DOUBLE_BUFFERED) != 0)
398 /* Macros for setting and clearing widget flags.
401 * GTK_WIDGET_SET_FLAGS:
402 * @wid: a #GtkWidget.
403 * @flag: the flags to set.
405 * Turns on certain widget flags.
407 #define GTK_WIDGET_SET_FLAGS(wid,flag) G_STMT_START{ (GTK_WIDGET_FLAGS (wid) |= (flag)); }G_STMT_END
410 * GTK_WIDGET_UNSET_FLAGS:
411 * @wid: a #GtkWidget.
412 * @flag: the flags to unset.
414 * Turns off certain widget flags.
416 #define GTK_WIDGET_UNSET_FLAGS(wid,flag) G_STMT_START{ (GTK_WIDGET_FLAGS (wid) &= ~(flag)); }G_STMT_END
418 #define GTK_TYPE_REQUISITION (gtk_requisition_get_type ())
420 /* forward declaration to avoid excessive includes (and concurrent includes)
422 typedef struct _GtkRequisition GtkRequisition;
423 typedef struct _GtkSelectionData GtkSelectionData;
424 typedef struct _GtkWidgetClass GtkWidgetClass;
425 typedef struct _GtkWidgetAuxInfo GtkWidgetAuxInfo;
426 typedef struct _GtkWidgetShapeInfo GtkWidgetShapeInfo;
427 typedef struct _GtkClipboard GtkClipboard;
428 typedef struct _GtkTooltip GtkTooltip;
429 typedef struct _GtkWindow GtkWindow;
433 * @x: the X position of the widget's area relative to its parents allocation.
434 * @y: the Y position of the widget's area relative to its parents allocation.
435 * @width: the width of the widget's allocated area.
436 * @height: the height of the widget's allocated area.
438 * A <structname>GtkAllocation</structname> of a widget represents region which has been allocated to the
439 * widget by its parent. It is a subregion of its parents allocation. See
440 * <xref linkend="size-allocation"/> for more information.
442 typedef GdkRectangle GtkAllocation;
446 * @widget: the widget to operate on
447 * @data: user-supplied data
449 * The type of the callback functions used for e.g. iterating over
450 * the children of a container, see gtk_container_foreach().
452 typedef void (*GtkCallback) (GtkWidget *widget,
457 * @width: the widget's desired width
458 * @height: the widget's desired height
460 * A <structname>GtkRequisition</structname> represents the desired size of a widget. See
461 * <xref linkend="size-requisition"/> for more information.
463 struct _GtkRequisition
469 /* The widget is the base of the tree for displayable objects.
470 * (A displayable object is one which takes up some amount
471 * of screen real estate). It provides a common base and interface
472 * which actual widgets must adhere to.
476 /* The object structure needs to be the first
477 * element in the widget structure in order for
478 * the object mechanism to work correctly. This
479 * allows a GtkWidget pointer to be cast to a
484 /* 16 bits of internally used private flags.
485 * this will be packed into the same 4 byte alignment frame that
486 * state and saved_state go. we therefore don't waste any new
489 guint16 GSEAL (private_flags);
491 /* The state of the widget. There are actually only
492 * 5 widget states (defined in "gtkenums.h").
494 guint8 GSEAL (state);
496 /* The saved state of the widget. When a widget's state
497 * is changed to GTK_STATE_INSENSITIVE via
498 * "gtk_widget_set_state" or "gtk_widget_set_sensitive"
499 * the old state is kept around in this field. The state
500 * will be restored once the widget gets sensitive again.
502 guint8 GSEAL (saved_state);
504 /* The widget's name. If the widget does not have a name
505 * (the name is NULL), then its name (as returned by
506 * "gtk_widget_get_name") is its class's name.
507 * Among other things, the widget name is used to determine
508 * the style to use for a widget.
514 /* The style for the widget. The style contains the
515 * colors the widget should be drawn in for each state
516 * along with graphics contexts used to draw with and
517 * the font to use for text.
519 GtkStyle *GSEAL (style);
521 /* The widget's desired size.
523 GtkRequisition GSEAL (requisition);
525 /* The widget's allocated size.
527 GtkAllocation GSEAL (allocation);
529 /* The widget's window or its parent window if it does
530 * not have a window. (Which will be indicated by the
531 * GTK_NO_WINDOW flag being set).
533 GdkWindow *GSEAL (window);
535 /* The widget's parent.
537 GtkWidget *GSEAL (parent);
544 * @set_scroll_adjustments_signal:
546 * <structfield>activate_signal</structfield>
547 * The signal to emit when a widget of this class is activated,
548 * gtk_widget_activate() handles the emission. Implementation of this
549 * signal is optional.
552 * <structfield>set_scroll_adjustment_signal</structfield>
553 * This signal is emitted when a widget of this class is added
554 * to a scrolling aware parent, gtk_widget_set_scroll_adjustments()
555 * handles the emission.
556 * Implementation of this signal is optional.
558 struct _GtkWidgetClass
560 /* The object class structure needs to be the first
561 * element in the widget class structure in order for
562 * the class mechanism to work correctly. This allows a
563 * GtkWidgetClass pointer to be cast to a GtkObjectClass
566 GtkObjectClass parent_class;
570 guint activate_signal;
572 guint set_scroll_adjustments_signal;
576 /* seldomly overidden */
577 void (*dispatch_child_properties_changed) (GtkWidget *widget,
579 GParamSpec **pspecs);
582 void (* show) (GtkWidget *widget);
583 void (* show_all) (GtkWidget *widget);
584 void (* hide) (GtkWidget *widget);
585 void (* hide_all) (GtkWidget *widget);
586 void (* map) (GtkWidget *widget);
587 void (* unmap) (GtkWidget *widget);
588 void (* realize) (GtkWidget *widget);
589 void (* unrealize) (GtkWidget *widget);
590 void (* size_request) (GtkWidget *widget,
591 GtkRequisition *requisition);
592 void (* size_allocate) (GtkWidget *widget,
593 GtkAllocation *allocation);
594 void (* state_changed) (GtkWidget *widget,
595 GtkStateType previous_state);
596 void (* parent_set) (GtkWidget *widget,
597 GtkWidget *previous_parent);
598 void (* hierarchy_changed) (GtkWidget *widget,
599 GtkWidget *previous_toplevel);
600 void (* style_set) (GtkWidget *widget,
601 GtkStyle *previous_style);
602 void (* direction_changed) (GtkWidget *widget,
603 GtkTextDirection previous_direction);
604 void (* grab_notify) (GtkWidget *widget,
605 gboolean was_grabbed);
606 void (* child_notify) (GtkWidget *widget,
610 gboolean (* mnemonic_activate) (GtkWidget *widget,
611 gboolean group_cycling);
614 void (* grab_focus) (GtkWidget *widget);
615 gboolean (* focus) (GtkWidget *widget,
616 GtkDirectionType direction);
619 gboolean (* event) (GtkWidget *widget,
621 gboolean (* button_press_event) (GtkWidget *widget,
622 GdkEventButton *event);
623 gboolean (* button_release_event) (GtkWidget *widget,
624 GdkEventButton *event);
625 gboolean (* scroll_event) (GtkWidget *widget,
626 GdkEventScroll *event);
627 gboolean (* motion_notify_event) (GtkWidget *widget,
628 GdkEventMotion *event);
629 gboolean (* delete_event) (GtkWidget *widget,
631 gboolean (* destroy_event) (GtkWidget *widget,
633 gboolean (* expose_event) (GtkWidget *widget,
634 GdkEventExpose *event);
635 gboolean (* key_press_event) (GtkWidget *widget,
637 gboolean (* key_release_event) (GtkWidget *widget,
639 gboolean (* enter_notify_event) (GtkWidget *widget,
640 GdkEventCrossing *event);
641 gboolean (* leave_notify_event) (GtkWidget *widget,
642 GdkEventCrossing *event);
643 gboolean (* configure_event) (GtkWidget *widget,
644 GdkEventConfigure *event);
645 gboolean (* focus_in_event) (GtkWidget *widget,
646 GdkEventFocus *event);
647 gboolean (* focus_out_event) (GtkWidget *widget,
648 GdkEventFocus *event);
649 gboolean (* map_event) (GtkWidget *widget,
651 gboolean (* unmap_event) (GtkWidget *widget,
653 gboolean (* property_notify_event) (GtkWidget *widget,
654 GdkEventProperty *event);
655 gboolean (* selection_clear_event) (GtkWidget *widget,
656 GdkEventSelection *event);
657 gboolean (* selection_request_event) (GtkWidget *widget,
658 GdkEventSelection *event);
659 gboolean (* selection_notify_event) (GtkWidget *widget,
660 GdkEventSelection *event);
661 gboolean (* proximity_in_event) (GtkWidget *widget,
662 GdkEventProximity *event);
663 gboolean (* proximity_out_event) (GtkWidget *widget,
664 GdkEventProximity *event);
665 gboolean (* visibility_notify_event) (GtkWidget *widget,
666 GdkEventVisibility *event);
667 gboolean (* client_event) (GtkWidget *widget,
668 GdkEventClient *event);
669 gboolean (* no_expose_event) (GtkWidget *widget,
671 gboolean (* window_state_event) (GtkWidget *widget,
672 GdkEventWindowState *event);
675 void (* selection_get) (GtkWidget *widget,
676 GtkSelectionData *selection_data,
679 void (* selection_received) (GtkWidget *widget,
680 GtkSelectionData *selection_data,
683 /* Source side drag signals */
684 void (* drag_begin) (GtkWidget *widget,
685 GdkDragContext *context);
686 void (* drag_end) (GtkWidget *widget,
687 GdkDragContext *context);
688 void (* drag_data_get) (GtkWidget *widget,
689 GdkDragContext *context,
690 GtkSelectionData *selection_data,
693 void (* drag_data_delete) (GtkWidget *widget,
694 GdkDragContext *context);
696 /* Target side drag signals */
697 void (* drag_leave) (GtkWidget *widget,
698 GdkDragContext *context,
700 gboolean (* drag_motion) (GtkWidget *widget,
701 GdkDragContext *context,
705 gboolean (* drag_drop) (GtkWidget *widget,
706 GdkDragContext *context,
710 void (* drag_data_received) (GtkWidget *widget,
711 GdkDragContext *context,
714 GtkSelectionData *selection_data,
718 /* Signals used only for keybindings */
719 gboolean (* popup_menu) (GtkWidget *widget);
721 /* If a widget has multiple tooltips/whatsthis, it should show the
722 * one for the current focus location, or if that doesn't make
723 * sense, should cycle through them showing each tip alongside
724 * whatever piece of the widget it applies to.
726 gboolean (* show_help) (GtkWidget *widget,
727 GtkWidgetHelpType help_type);
729 /* accessibility support
731 AtkObject* (*get_accessible) (GtkWidget *widget);
733 void (*screen_changed) (GtkWidget *widget,
734 GdkScreen *previous_screen);
735 gboolean (*can_activate_accel) (GtkWidget *widget,
738 /* Sent when a grab is broken. */
739 gboolean (*grab_broken_event) (GtkWidget *widget,
740 GdkEventGrabBroken *event);
742 void (* composited_changed) (GtkWidget *widget);
744 gboolean (* query_tooltip) (GtkWidget *widget,
747 gboolean keyboard_tooltip,
748 GtkTooltip *tooltip);
749 /* Signals without a C default handler class slot:
750 * gboolean (*damage_event) (GtkWidget *widget,
751 * GdkEventExpose *event);
754 /* Padding for future expansion */
755 void (*_gtk_reserved5) (void);
756 void (*_gtk_reserved6) (void);
757 void (*_gtk_reserved7) (void);
760 struct _GtkWidgetAuxInfo
770 struct _GtkWidgetShapeInfo
774 GdkBitmap *shape_mask;
777 GType gtk_widget_get_type (void) G_GNUC_CONST;
778 GtkWidget* gtk_widget_new (GType type,
779 const gchar *first_property_name,
781 void gtk_widget_destroy (GtkWidget *widget);
782 void gtk_widget_destroyed (GtkWidget *widget,
783 GtkWidget **widget_pointer);
784 #ifndef GTK_DISABLE_DEPRECATED
785 GtkWidget* gtk_widget_ref (GtkWidget *widget);
786 void gtk_widget_unref (GtkWidget *widget);
787 void gtk_widget_set (GtkWidget *widget,
788 const gchar *first_property_name,
789 ...) G_GNUC_NULL_TERMINATED;
790 #endif /* GTK_DISABLE_DEPRECATED */
791 void gtk_widget_unparent (GtkWidget *widget);
792 void gtk_widget_show (GtkWidget *widget);
793 void gtk_widget_show_now (GtkWidget *widget);
794 void gtk_widget_hide (GtkWidget *widget);
795 void gtk_widget_show_all (GtkWidget *widget);
796 void gtk_widget_hide_all (GtkWidget *widget);
797 void gtk_widget_set_no_show_all (GtkWidget *widget,
798 gboolean no_show_all);
799 gboolean gtk_widget_get_no_show_all (GtkWidget *widget);
800 void gtk_widget_map (GtkWidget *widget);
801 void gtk_widget_unmap (GtkWidget *widget);
802 void gtk_widget_realize (GtkWidget *widget);
803 void gtk_widget_unrealize (GtkWidget *widget);
806 void gtk_widget_queue_draw (GtkWidget *widget);
807 void gtk_widget_queue_draw_area (GtkWidget *widget,
812 #ifndef GTK_DISABLE_DEPRECATED
813 void gtk_widget_queue_clear (GtkWidget *widget);
814 void gtk_widget_queue_clear_area (GtkWidget *widget,
819 #endif /* GTK_DISABLE_DEPRECATED */
822 void gtk_widget_queue_resize (GtkWidget *widget);
823 void gtk_widget_queue_resize_no_redraw (GtkWidget *widget);
824 #ifndef GTK_DISABLE_DEPRECATED
825 void gtk_widget_draw (GtkWidget *widget,
826 const GdkRectangle *area);
827 #endif /* GTK_DISABLE_DEPRECATED */
828 void gtk_widget_size_request (GtkWidget *widget,
829 GtkRequisition *requisition);
830 void gtk_widget_size_allocate (GtkWidget *widget,
831 GtkAllocation *allocation);
832 void gtk_widget_get_child_requisition (GtkWidget *widget,
833 GtkRequisition *requisition);
834 void gtk_widget_add_accelerator (GtkWidget *widget,
835 const gchar *accel_signal,
836 GtkAccelGroup *accel_group,
838 GdkModifierType accel_mods,
839 GtkAccelFlags accel_flags);
840 gboolean gtk_widget_remove_accelerator (GtkWidget *widget,
841 GtkAccelGroup *accel_group,
843 GdkModifierType accel_mods);
844 void gtk_widget_set_accel_path (GtkWidget *widget,
845 const gchar *accel_path,
846 GtkAccelGroup *accel_group);
847 const gchar* _gtk_widget_get_accel_path (GtkWidget *widget,
849 GList* gtk_widget_list_accel_closures (GtkWidget *widget);
850 gboolean gtk_widget_can_activate_accel (GtkWidget *widget,
852 gboolean gtk_widget_mnemonic_activate (GtkWidget *widget,
853 gboolean group_cycling);
854 gboolean gtk_widget_event (GtkWidget *widget,
856 gint gtk_widget_send_expose (GtkWidget *widget,
859 gboolean gtk_widget_activate (GtkWidget *widget);
860 gboolean gtk_widget_set_scroll_adjustments (GtkWidget *widget,
861 GtkAdjustment *hadjustment,
862 GtkAdjustment *vadjustment);
864 void gtk_widget_reparent (GtkWidget *widget,
865 GtkWidget *new_parent);
866 gboolean gtk_widget_intersect (GtkWidget *widget,
867 const GdkRectangle *area,
868 GdkRectangle *intersection);
869 GdkRegion *gtk_widget_region_intersect (GtkWidget *widget,
870 const GdkRegion *region);
872 void gtk_widget_freeze_child_notify (GtkWidget *widget);
873 void gtk_widget_child_notify (GtkWidget *widget,
874 const gchar *child_property);
875 void gtk_widget_thaw_child_notify (GtkWidget *widget);
877 void gtk_widget_set_can_focus (GtkWidget *widget,
879 gboolean gtk_widget_get_can_focus (GtkWidget *widget);
880 gboolean gtk_widget_has_focus (GtkWidget *widget);
881 gboolean gtk_widget_is_focus (GtkWidget *widget);
882 void gtk_widget_grab_focus (GtkWidget *widget);
884 void gtk_widget_set_can_default (GtkWidget *widget,
885 gboolean can_default);
886 gboolean gtk_widget_get_can_default (GtkWidget *widget);
887 gboolean gtk_widget_has_default (GtkWidget *widget);
888 void gtk_widget_grab_default (GtkWidget *widget);
890 void gtk_widget_set_receives_default (GtkWidget *widget,
891 gboolean receives_default);
892 gboolean gtk_widget_get_receives_default (GtkWidget *widget);
894 gboolean gtk_widget_has_grab (GtkWidget *widget);
896 void gtk_widget_set_name (GtkWidget *widget,
898 G_CONST_RETURN gchar* gtk_widget_get_name (GtkWidget *widget);
900 void gtk_widget_set_state (GtkWidget *widget,
902 GtkStateType gtk_widget_get_state (GtkWidget *widget);
904 void gtk_widget_set_sensitive (GtkWidget *widget,
906 gboolean gtk_widget_get_sensitive (GtkWidget *widget);
907 gboolean gtk_widget_is_sensitive (GtkWidget *widget);
909 void gtk_widget_set_visible (GtkWidget *widget,
911 gboolean gtk_widget_get_visible (GtkWidget *widget);
913 void gtk_widget_set_has_window (GtkWidget *widget,
914 gboolean has_window);
915 gboolean gtk_widget_get_has_window (GtkWidget *widget);
917 gboolean gtk_widget_is_toplevel (GtkWidget *widget);
918 gboolean gtk_widget_is_drawable (GtkWidget *widget);
920 void gtk_widget_set_app_paintable (GtkWidget *widget,
921 gboolean app_paintable);
922 gboolean gtk_widget_get_app_paintable (GtkWidget *widget);
924 void gtk_widget_set_double_buffered (GtkWidget *widget,
925 gboolean double_buffered);
926 gboolean gtk_widget_get_double_buffered (GtkWidget *widget);
928 void gtk_widget_set_redraw_on_allocate (GtkWidget *widget,
929 gboolean redraw_on_allocate);
931 void gtk_widget_set_parent (GtkWidget *widget,
933 GtkWidget * gtk_widget_get_parent (GtkWidget *widget);
935 void gtk_widget_set_parent_window (GtkWidget *widget,
936 GdkWindow *parent_window);
937 GdkWindow * gtk_widget_get_parent_window (GtkWidget *widget);
939 void gtk_widget_set_child_visible (GtkWidget *widget,
940 gboolean is_visible);
941 gboolean gtk_widget_get_child_visible (GtkWidget *widget);
943 void gtk_widget_set_window (GtkWidget *widget,
945 GdkWindow * gtk_widget_get_window (GtkWidget *widget);
947 void gtk_widget_get_allocation (GtkWidget *widget,
948 GtkAllocation *allocation);
949 void gtk_widget_set_allocation (GtkWidget *widget,
950 const GtkAllocation *allocation);
952 gboolean gtk_widget_child_focus (GtkWidget *widget,
953 GtkDirectionType direction);
954 gboolean gtk_widget_keynav_failed (GtkWidget *widget,
955 GtkDirectionType direction);
956 void gtk_widget_error_bell (GtkWidget *widget);
958 void gtk_widget_set_size_request (GtkWidget *widget,
961 void gtk_widget_get_size_request (GtkWidget *widget,
964 #ifndef GTK_DISABLE_DEPRECATED
965 void gtk_widget_set_uposition (GtkWidget *widget,
968 void gtk_widget_set_usize (GtkWidget *widget,
973 void gtk_widget_set_events (GtkWidget *widget,
975 void gtk_widget_add_events (GtkWidget *widget,
977 void gtk_widget_set_extension_events (GtkWidget *widget,
978 GdkExtensionMode mode);
980 GdkExtensionMode gtk_widget_get_extension_events (GtkWidget *widget);
981 GtkWidget* gtk_widget_get_toplevel (GtkWidget *widget);
982 GtkWidget* gtk_widget_get_ancestor (GtkWidget *widget,
984 GdkColormap* gtk_widget_get_colormap (GtkWidget *widget);
985 GdkVisual* gtk_widget_get_visual (GtkWidget *widget);
987 GdkScreen * gtk_widget_get_screen (GtkWidget *widget);
988 gboolean gtk_widget_has_screen (GtkWidget *widget);
989 GdkDisplay * gtk_widget_get_display (GtkWidget *widget);
990 GdkWindow * gtk_widget_get_root_window (GtkWidget *widget);
991 GtkSettings* gtk_widget_get_settings (GtkWidget *widget);
992 GtkClipboard *gtk_widget_get_clipboard (GtkWidget *widget,
994 GdkPixmap * gtk_widget_get_snapshot (GtkWidget *widget,
995 GdkRectangle *clip_rect);
997 #ifndef GTK_DISABLE_DEPRECATED
1000 * gtk_widget_set_visual:
1001 * @widget: a #GtkWidget
1004 * This function is deprecated; it does nothing.
1006 #define gtk_widget_set_visual(widget,visual) ((void) 0)
1009 * gtk_widget_push_visual:
1012 * This function is deprecated; it does nothing.
1014 #define gtk_widget_push_visual(visual) ((void) 0)
1017 * gtk_widget_pop_visual:
1019 * This function is deprecated; it does nothing.
1021 #define gtk_widget_pop_visual() ((void) 0)
1024 * gtk_widget_set_default_visual:
1027 * This function is deprecated; it does nothing.
1029 #define gtk_widget_set_default_visual(visual) ((void) 0)
1031 #endif /* GTK_DISABLE_DEPRECATED */
1033 /* Accessibility support */
1034 AtkObject* gtk_widget_get_accessible (GtkWidget *widget);
1036 /* The following functions must not be called on an already
1037 * realized widget. Because it is possible that somebody
1038 * can call get_colormap() or get_visual() and save the
1039 * result, these functions are probably only safe to
1040 * call in a widget's init() function.
1042 void gtk_widget_set_colormap (GtkWidget *widget,
1043 GdkColormap *colormap);
1045 gint gtk_widget_get_events (GtkWidget *widget);
1046 void gtk_widget_get_pointer (GtkWidget *widget,
1050 gboolean gtk_widget_is_ancestor (GtkWidget *widget,
1051 GtkWidget *ancestor);
1053 gboolean gtk_widget_translate_coordinates (GtkWidget *src_widget,
1054 GtkWidget *dest_widget,
1060 /* Hide widget and return TRUE.
1062 gboolean gtk_widget_hide_on_delete (GtkWidget *widget);
1066 gboolean gtk_widget_has_rc_style (GtkWidget *widget);
1067 void gtk_widget_set_style (GtkWidget *widget,
1069 void gtk_widget_ensure_style (GtkWidget *widget);
1070 GtkStyle* gtk_widget_get_style (GtkWidget *widget);
1072 void gtk_widget_modify_style (GtkWidget *widget,
1074 GtkRcStyle *gtk_widget_get_modifier_style (GtkWidget *widget);
1075 void gtk_widget_modify_fg (GtkWidget *widget,
1077 const GdkColor *color);
1078 void gtk_widget_modify_bg (GtkWidget *widget,
1080 const GdkColor *color);
1081 void gtk_widget_modify_text (GtkWidget *widget,
1083 const GdkColor *color);
1084 void gtk_widget_modify_base (GtkWidget *widget,
1086 const GdkColor *color);
1087 void gtk_widget_modify_cursor (GtkWidget *widget,
1088 const GdkColor *primary,
1089 const GdkColor *secondary);
1090 void gtk_widget_modify_font (GtkWidget *widget,
1091 PangoFontDescription *font_desc);
1093 #ifndef GTK_DISABLE_DEPRECATED
1096 * gtk_widget_set_rc_style:
1097 * @widget: a #GtkWidget.
1099 * Equivalent to <literal>gtk_widget_set_style (widget, NULL)</literal>.
1101 * Deprecated: 2.0: Use gtk_widget_set_style() with a %NULL @style argument instead.
1103 #define gtk_widget_set_rc_style(widget) (gtk_widget_set_style (widget, NULL))
1106 * gtk_widget_restore_default_style:
1107 * @widget: a #GtkWidget.
1109 * Equivalent to <literal>gtk_widget_set_style (widget, NULL)</literal>.
1111 * Deprecated: 2.0: Use gtk_widget_set_style() with a %NULL @style argument instead.
1113 #define gtk_widget_restore_default_style(widget) (gtk_widget_set_style (widget, NULL))
1116 PangoContext *gtk_widget_create_pango_context (GtkWidget *widget);
1117 PangoContext *gtk_widget_get_pango_context (GtkWidget *widget);
1118 PangoLayout *gtk_widget_create_pango_layout (GtkWidget *widget,
1121 GdkPixbuf *gtk_widget_render_icon (GtkWidget *widget,
1122 const gchar *stock_id,
1124 const gchar *detail);
1126 /* handle composite names for GTK_COMPOSITE_CHILD widgets,
1127 * the returned name is newly allocated.
1129 void gtk_widget_set_composite_name (GtkWidget *widget,
1131 gchar* gtk_widget_get_composite_name (GtkWidget *widget);
1133 /* Descend recursively and set rc-style on all widgets without user styles */
1134 void gtk_widget_reset_rc_styles (GtkWidget *widget);
1136 /* Push/pop pairs, to change default values upon a widget's creation.
1137 * This will override the values that got set by the
1138 * gtk_widget_set_default_* () functions.
1140 void gtk_widget_push_colormap (GdkColormap *cmap);
1141 void gtk_widget_push_composite_child (void);
1142 void gtk_widget_pop_composite_child (void);
1143 void gtk_widget_pop_colormap (void);
1145 /* widget style properties
1147 void gtk_widget_class_install_style_property (GtkWidgetClass *klass,
1149 void gtk_widget_class_install_style_property_parser (GtkWidgetClass *klass,
1151 GtkRcPropertyParser parser);
1152 GParamSpec* gtk_widget_class_find_style_property (GtkWidgetClass *klass,
1153 const gchar *property_name);
1154 GParamSpec** gtk_widget_class_list_style_properties (GtkWidgetClass *klass,
1155 guint *n_properties);
1156 void gtk_widget_style_get_property (GtkWidget *widget,
1157 const gchar *property_name,
1159 void gtk_widget_style_get_valist (GtkWidget *widget,
1160 const gchar *first_property_name,
1162 void gtk_widget_style_get (GtkWidget *widget,
1163 const gchar *first_property_name,
1164 ...) G_GNUC_NULL_TERMINATED;
1167 /* Set certain default values to be used at widget creation time.
1169 void gtk_widget_set_default_colormap (GdkColormap *colormap);
1170 GtkStyle* gtk_widget_get_default_style (void);
1171 #ifndef GDK_MULTIHEAD_SAFE
1172 GdkColormap* gtk_widget_get_default_colormap (void);
1173 GdkVisual* gtk_widget_get_default_visual (void);
1176 /* Functions for setting directionality for widgets
1179 void gtk_widget_set_direction (GtkWidget *widget,
1180 GtkTextDirection dir);
1181 GtkTextDirection gtk_widget_get_direction (GtkWidget *widget);
1183 void gtk_widget_set_default_direction (GtkTextDirection dir);
1184 GtkTextDirection gtk_widget_get_default_direction (void);
1186 /* Compositing manager functionality */
1187 gboolean gtk_widget_is_composited (GtkWidget *widget);
1189 /* Counterpart to gdk_window_shape_combine_mask.
1191 void gtk_widget_shape_combine_mask (GtkWidget *widget,
1192 GdkBitmap *shape_mask,
1195 void gtk_widget_input_shape_combine_mask (GtkWidget *widget,
1196 GdkBitmap *shape_mask,
1200 /* internal function */
1201 void gtk_widget_reset_shapes (GtkWidget *widget);
1203 /* Compute a widget's path in the form "GtkWindow.MyLabel", and
1204 * return newly alocated strings.
1206 void gtk_widget_path (GtkWidget *widget,
1209 gchar **path_reversed);
1210 void gtk_widget_class_path (GtkWidget *widget,
1213 gchar **path_reversed);
1215 GList* gtk_widget_list_mnemonic_labels (GtkWidget *widget);
1216 void gtk_widget_add_mnemonic_label (GtkWidget *widget,
1218 void gtk_widget_remove_mnemonic_label (GtkWidget *widget,
1221 void gtk_widget_set_tooltip_window (GtkWidget *widget,
1222 GtkWindow *custom_window);
1223 GtkWindow *gtk_widget_get_tooltip_window (GtkWidget *widget);
1224 void gtk_widget_trigger_tooltip_query (GtkWidget *widget);
1225 void gtk_widget_set_tooltip_text (GtkWidget *widget,
1227 gchar * gtk_widget_get_tooltip_text (GtkWidget *widget);
1228 void gtk_widget_set_tooltip_markup (GtkWidget *widget,
1229 const gchar *markup);
1230 gchar * gtk_widget_get_tooltip_markup (GtkWidget *widget);
1231 void gtk_widget_set_has_tooltip (GtkWidget *widget,
1232 gboolean has_tooltip);
1233 gboolean gtk_widget_get_has_tooltip (GtkWidget *widget);
1235 GType gtk_requisition_get_type (void) G_GNUC_CONST;
1236 GtkRequisition *gtk_requisition_copy (const GtkRequisition *requisition);
1237 void gtk_requisition_free (GtkRequisition *requisition);
1239 #if defined (GTK_TRACE_OBJECTS) && defined (__GNUC__)
1240 # define gtk_widget_ref g_object_ref
1241 # define gtk_widget_unref g_object_unref
1242 #endif /* GTK_TRACE_OBJECTS && __GNUC__ */
1244 void _gtk_widget_grab_notify (GtkWidget *widget,
1245 gboolean was_grabbed);
1247 GtkWidgetAuxInfo *_gtk_widget_get_aux_info (GtkWidget *widget,
1249 void _gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
1250 GtkWidget *previous_toplevel);
1251 void _gtk_widget_propagate_screen_changed (GtkWidget *widget,
1252 GdkScreen *previous_screen);
1253 void _gtk_widget_propagate_composited_changed (GtkWidget *widget);
1255 void _gtk_widget_set_pointer_window (GtkWidget *widget,
1256 GdkWindow *pointer_window);
1257 GdkWindow *_gtk_widget_get_pointer_window (GtkWidget *widget);
1258 gboolean _gtk_widget_is_pointer_widget (GtkWidget *widget);
1259 void _gtk_widget_synthesize_crossing (GtkWidget *from,
1261 GdkCrossingMode mode);
1263 GdkColormap* _gtk_widget_peek_colormap (void);
1265 void _gtk_widget_buildable_finish_accelerator (GtkWidget *widget,
1266 GtkWidget *toplevel,
1267 gpointer user_data);
1271 #endif /* __GTK_WIDGET_H__ */