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_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_APP_PAINTABLE: Set and unset by gtk_widget_set_app_paintable().
85 * Must be set on widgets whose window the application directly draws on,
86 * in order to keep GTK+ from overwriting the drawn stuff. See
87 * <xref linkend="app-paintable-widgets"/> for a detailed
88 * description of this flag.
89 * @GTK_RECEIVES_DEFAULT: The widget when focused will receive the default action and have
90 * %GTK_HAS_DEFAULT set even if there is a different widget set as default.
91 * @GTK_DOUBLE_BUFFERED: Set and unset by gtk_widget_set_double_buffered().
92 * Indicates that exposes done on the widget should be
93 * double-buffered. See <xref linkend="double-buffering"/> for a
94 * detailed discussion of how double-buffering works in GTK+ and
95 * why you may want to disable it for special cases.
98 * Tells about certain properties of the widget.
102 GTK_TOPLEVEL = 1 << 4,
103 GTK_NO_WINDOW = 1 << 5,
104 GTK_REALIZED = 1 << 6,
106 GTK_VISIBLE = 1 << 8,
107 GTK_SENSITIVE = 1 << 9,
108 GTK_PARENT_SENSITIVE = 1 << 10,
109 GTK_CAN_FOCUS = 1 << 11,
110 GTK_HAS_FOCUS = 1 << 12,
111 GTK_CAN_DEFAULT = 1 << 13,
112 GTK_HAS_DEFAULT = 1 << 14,
113 GTK_HAS_GRAB = 1 << 15,
114 GTK_RC_STYLE = 1 << 16,
115 GTK_COMPOSITE_CHILD = 1 << 17,
116 GTK_APP_PAINTABLE = 1 << 18,
117 GTK_RECEIVES_DEFAULT = 1 << 19,
118 GTK_DOUBLE_BUFFERED = 1 << 20,
119 GTK_NO_SHOW_ALL = 1 << 21,
120 GTK_MULTIDEVICE = 1 << 22
123 /* Kinds of widget-specific help */
126 GTK_WIDGET_HELP_TOOLTIP,
127 GTK_WIDGET_HELP_WHATS_THIS
130 /* Macro for casting a pointer to a GtkWidget or GtkWidgetClass pointer.
131 * Macros for testing whether `widget' or `klass' are of type GTK_TYPE_WIDGET.
133 #define GTK_TYPE_WIDGET (gtk_widget_get_type ())
134 #define GTK_WIDGET(widget) (G_TYPE_CHECK_INSTANCE_CAST ((widget), GTK_TYPE_WIDGET, GtkWidget))
135 #define GTK_WIDGET_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WIDGET, GtkWidgetClass))
136 #define GTK_IS_WIDGET(widget) (G_TYPE_CHECK_INSTANCE_TYPE ((widget), GTK_TYPE_WIDGET))
137 #define GTK_IS_WIDGET_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WIDGET))
138 #define GTK_WIDGET_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WIDGET, GtkWidgetClass))
140 /* Macros for extracting the widget flags from GtkWidget.
144 * @wid: a #GtkWidget.
146 * Returns the widget flags from @wid.
148 * Deprecated: 2.20: Use the proper function to test individual states:
149 * gtk_widget_get_app_paintable(), gtk_widget_get_can_default(),
150 * gtk_widget_get_can_focus(), gtk_widget_get_double_buffered(),
151 * gtk_widget_has_default(), gtk_widget_is_drawable(),
152 * gtk_widget_has_focus(), gtk_widget_has_grab(), gtk_widget_get_mapped(),
153 * gtk_widget_get_has_window(), gtk_widget_has_rc_style(),
154 * gtk_widget_get_realized(), gtk_widget_get_receives_default(),
155 * gtk_widget_get_sensitive(), gtk_widget_is_sensitive(),
156 * gtk_widget_is_toplevel() or gtk_widget_get_visible().
158 #define GTK_WIDGET_FLAGS(wid) (GTK_OBJECT_FLAGS (wid))
159 /* FIXME: Deprecating GTK_WIDGET_FLAGS requires fixing GTK internals. */
161 /* Macros for setting and clearing widget flags.
164 * GTK_WIDGET_SET_FLAGS:
165 * @wid: a #GtkWidget.
166 * @flag: the flags to set.
168 * Turns on certain widget flags.
170 * Deprecated: 2.22: Use the proper function instead: gtk_widget_set_app_paintable(),
171 * gtk_widget_set_can_default(), gtk_widget_set_can_focus(),
172 * gtk_widget_set_double_buffered(), gtk_widget_set_has_window(),
173 * gtk_widget_set_mapped(), gtk_widget_set_no_show_all(),
174 * gtk_widget_set_realized(), gtk_widget_set_receives_default(),
175 * gtk_widget_set_sensitive() or gtk_widget_set_visible().
178 #define GTK_WIDGET_SET_FLAGS(wid,flag) G_STMT_START{ (GTK_WIDGET_FLAGS (wid) |= (flag)); }G_STMT_END
179 /* FIXME: Deprecating GTK_WIDGET_SET_FLAGS requires fixing GTK internals. */
182 * GTK_WIDGET_UNSET_FLAGS:
183 * @wid: a #GtkWidget.
184 * @flag: the flags to unset.
186 * Turns off certain widget flags.
188 * Deprecated: 2.22: Use the proper function instead. See GTK_WIDGET_SET_FLAGS().
190 #define GTK_WIDGET_UNSET_FLAGS(wid,flag) G_STMT_START{ (GTK_WIDGET_FLAGS (wid) &= ~(flag)); }G_STMT_END
191 /* FIXME: Deprecating GTK_WIDGET_UNSET_FLAGS requires fixing GTK internals. */
193 #define GTK_TYPE_REQUISITION (gtk_requisition_get_type ())
195 /* forward declaration to avoid excessive includes (and concurrent includes)
197 typedef struct _GtkRequisition GtkRequisition;
198 typedef struct _GtkSelectionData GtkSelectionData;
199 typedef struct _GtkWidgetClass GtkWidgetClass;
200 typedef struct _GtkWidgetAuxInfo GtkWidgetAuxInfo;
201 typedef struct _GtkWidgetShapeInfo GtkWidgetShapeInfo;
202 typedef struct _GtkClipboard GtkClipboard;
203 typedef struct _GtkTooltip GtkTooltip;
204 typedef struct _GtkWindow GtkWindow;
209 * @x: the X position of the widget's area relative to its parents allocation.
210 * @y: the Y position of the widget's area relative to its parents allocation.
211 * @width: the width of the widget's allocated area.
212 * @height: the height of the widget's allocated area.
214 * A <structname>GtkAllocation</structname> of a widget represents region which has been allocated to the
215 * widget by its parent. It is a subregion of its parents allocation. See
216 * <xref linkend="size-allocation"/> for more information.
218 typedef GdkRectangle GtkAllocation;
222 * @widget: the widget to operate on
223 * @data: user-supplied data
225 * The type of the callback functions used for e.g. iterating over
226 * the children of a container, see gtk_container_foreach().
228 typedef void (*GtkCallback) (GtkWidget *widget,
233 * @width: the widget's desired width
234 * @height: the widget's desired height
236 * A <structname>GtkRequisition</structname> represents the desired size of a widget. See
237 * <xref linkend="size-requisition"/> for more information.
239 struct _GtkRequisition
245 /* The widget is the base of the tree for displayable objects.
246 * (A displayable object is one which takes up some amount
247 * of screen real estate). It provides a common base and interface
248 * which actual widgets must adhere to.
252 /* The object structure needs to be the first
253 * element in the widget structure in order for
254 * the object mechanism to work correctly. This
255 * allows a GtkWidget pointer to be cast to a
260 /* 16 bits of internally used private flags.
261 * this will be packed into the same 4 byte alignment frame that
262 * state and saved_state go. we therefore don't waste any new
265 guint16 GSEAL (private_flags);
267 /* The state of the widget. There are actually only
268 * 5 widget states (defined in "gtkenums.h").
270 guint8 GSEAL (state);
272 /* The saved state of the widget. When a widget's state
273 * is changed to GTK_STATE_INSENSITIVE via
274 * "gtk_widget_set_state" or "gtk_widget_set_sensitive"
275 * the old state is kept around in this field. The state
276 * will be restored once the widget gets sensitive again.
278 guint8 GSEAL (saved_state);
280 /* The widget's name. If the widget does not have a name
281 * (the name is NULL), then its name (as returned by
282 * "gtk_widget_get_name") is its class's name.
283 * Among other things, the widget name is used to determine
284 * the style to use for a widget.
290 /* The style for the widget. The style contains the
291 * colors the widget should be drawn in for each state
292 * along with graphics contexts used to draw with and
293 * the font to use for text.
295 GtkStyle *GSEAL (style);
297 /* The widget's desired size.
299 GtkRequisition GSEAL (requisition);
301 /* The widget's allocated size.
303 GtkAllocation GSEAL (allocation);
305 /* The widget's window or its parent window if it does
306 * not have a window. (Which will be indicated by the
307 * GTK_NO_WINDOW flag being set).
309 GdkWindow *GSEAL (window);
311 /* The widget's parent.
313 GtkWidget *GSEAL (parent);
320 * @set_scroll_adjustments_signal:
322 * <structfield>activate_signal</structfield>
323 * The signal to emit when a widget of this class is activated,
324 * gtk_widget_activate() handles the emission. Implementation of this
325 * signal is optional.
328 * <structfield>set_scroll_adjustment_signal</structfield>
329 * This signal is emitted when a widget of this class is added
330 * to a scrolling aware parent, gtk_widget_set_scroll_adjustments()
331 * handles the emission.
332 * Implementation of this signal is optional.
334 struct _GtkWidgetClass
336 /* The object class structure needs to be the first
337 * element in the widget class structure in order for
338 * the class mechanism to work correctly. This allows a
339 * GtkWidgetClass pointer to be cast to a GtkObjectClass
342 GtkObjectClass parent_class;
346 guint activate_signal;
348 guint set_scroll_adjustments_signal;
352 /* seldomly overidden */
353 void (*dispatch_child_properties_changed) (GtkWidget *widget,
355 GParamSpec **pspecs);
358 void (* show) (GtkWidget *widget);
359 void (* show_all) (GtkWidget *widget);
360 void (* hide) (GtkWidget *widget);
361 void (* hide_all) (GtkWidget *widget);
362 void (* map) (GtkWidget *widget);
363 void (* unmap) (GtkWidget *widget);
364 void (* realize) (GtkWidget *widget);
365 void (* unrealize) (GtkWidget *widget);
366 void (* size_request) (GtkWidget *widget,
367 GtkRequisition *requisition);
368 void (* size_allocate) (GtkWidget *widget,
369 GtkAllocation *allocation);
370 void (* state_changed) (GtkWidget *widget,
371 GtkStateType previous_state);
372 void (* parent_set) (GtkWidget *widget,
373 GtkWidget *previous_parent);
374 void (* hierarchy_changed) (GtkWidget *widget,
375 GtkWidget *previous_toplevel);
376 void (* style_set) (GtkWidget *widget,
377 GtkStyle *previous_style);
378 void (* direction_changed) (GtkWidget *widget,
379 GtkTextDirection previous_direction);
380 void (* grab_notify) (GtkWidget *widget,
381 gboolean was_grabbed);
382 void (* child_notify) (GtkWidget *widget,
386 gboolean (* mnemonic_activate) (GtkWidget *widget,
387 gboolean group_cycling);
390 void (* grab_focus) (GtkWidget *widget);
391 gboolean (* focus) (GtkWidget *widget,
392 GtkDirectionType direction);
395 gboolean (* event) (GtkWidget *widget,
397 gboolean (* button_press_event) (GtkWidget *widget,
398 GdkEventButton *event);
399 gboolean (* button_release_event) (GtkWidget *widget,
400 GdkEventButton *event);
401 gboolean (* scroll_event) (GtkWidget *widget,
402 GdkEventScroll *event);
403 gboolean (* motion_notify_event) (GtkWidget *widget,
404 GdkEventMotion *event);
405 gboolean (* delete_event) (GtkWidget *widget,
407 gboolean (* destroy_event) (GtkWidget *widget,
409 gboolean (* expose_event) (GtkWidget *widget,
410 GdkEventExpose *event);
411 gboolean (* key_press_event) (GtkWidget *widget,
413 gboolean (* key_release_event) (GtkWidget *widget,
415 gboolean (* enter_notify_event) (GtkWidget *widget,
416 GdkEventCrossing *event);
417 gboolean (* leave_notify_event) (GtkWidget *widget,
418 GdkEventCrossing *event);
419 gboolean (* configure_event) (GtkWidget *widget,
420 GdkEventConfigure *event);
421 gboolean (* focus_in_event) (GtkWidget *widget,
422 GdkEventFocus *event);
423 gboolean (* focus_out_event) (GtkWidget *widget,
424 GdkEventFocus *event);
425 gboolean (* map_event) (GtkWidget *widget,
427 gboolean (* unmap_event) (GtkWidget *widget,
429 gboolean (* property_notify_event) (GtkWidget *widget,
430 GdkEventProperty *event);
431 gboolean (* selection_clear_event) (GtkWidget *widget,
432 GdkEventSelection *event);
433 gboolean (* selection_request_event) (GtkWidget *widget,
434 GdkEventSelection *event);
435 gboolean (* selection_notify_event) (GtkWidget *widget,
436 GdkEventSelection *event);
437 gboolean (* proximity_in_event) (GtkWidget *widget,
438 GdkEventProximity *event);
439 gboolean (* proximity_out_event) (GtkWidget *widget,
440 GdkEventProximity *event);
441 gboolean (* visibility_notify_event) (GtkWidget *widget,
442 GdkEventVisibility *event);
443 gboolean (* client_event) (GtkWidget *widget,
444 GdkEventClient *event);
445 gboolean (* no_expose_event) (GtkWidget *widget,
447 gboolean (* window_state_event) (GtkWidget *widget,
448 GdkEventWindowState *event);
451 void (* selection_get) (GtkWidget *widget,
452 GtkSelectionData *selection_data,
455 void (* selection_received) (GtkWidget *widget,
456 GtkSelectionData *selection_data,
459 /* Source side drag signals */
460 void (* drag_begin) (GtkWidget *widget,
461 GdkDragContext *context);
462 void (* drag_end) (GtkWidget *widget,
463 GdkDragContext *context);
464 void (* drag_data_get) (GtkWidget *widget,
465 GdkDragContext *context,
466 GtkSelectionData *selection_data,
469 void (* drag_data_delete) (GtkWidget *widget,
470 GdkDragContext *context);
472 /* Target side drag signals */
473 void (* drag_leave) (GtkWidget *widget,
474 GdkDragContext *context,
476 gboolean (* drag_motion) (GtkWidget *widget,
477 GdkDragContext *context,
481 gboolean (* drag_drop) (GtkWidget *widget,
482 GdkDragContext *context,
486 void (* drag_data_received) (GtkWidget *widget,
487 GdkDragContext *context,
490 GtkSelectionData *selection_data,
494 /* Signals used only for keybindings */
495 gboolean (* popup_menu) (GtkWidget *widget);
497 /* If a widget has multiple tooltips/whatsthis, it should show the
498 * one for the current focus location, or if that doesn't make
499 * sense, should cycle through them showing each tip alongside
500 * whatever piece of the widget it applies to.
502 gboolean (* show_help) (GtkWidget *widget,
503 GtkWidgetHelpType help_type);
505 /* accessibility support
507 AtkObject* (*get_accessible) (GtkWidget *widget);
509 void (*screen_changed) (GtkWidget *widget,
510 GdkScreen *previous_screen);
511 gboolean (*can_activate_accel) (GtkWidget *widget,
514 /* Sent when a grab is broken. */
515 gboolean (*grab_broken_event) (GtkWidget *widget,
516 GdkEventGrabBroken *event);
518 void (* composited_changed) (GtkWidget *widget);
520 gboolean (* query_tooltip) (GtkWidget *widget,
523 gboolean keyboard_tooltip,
524 GtkTooltip *tooltip);
525 /* Signals without a C default handler class slot:
526 * gboolean (*damage_event) (GtkWidget *widget,
527 * GdkEventExpose *event);
530 /* Padding for future expansion */
531 void (*_gtk_reserved5) (void);
532 void (*_gtk_reserved6) (void);
533 void (*_gtk_reserved7) (void);
536 struct _GtkWidgetAuxInfo
547 struct _GtkWidgetShapeInfo
551 GdkBitmap *shape_mask;
554 GType gtk_widget_get_type (void) G_GNUC_CONST;
555 GtkWidget* gtk_widget_new (GType type,
556 const gchar *first_property_name,
558 void gtk_widget_destroy (GtkWidget *widget);
559 void gtk_widget_destroyed (GtkWidget *widget,
560 GtkWidget **widget_pointer);
561 void gtk_widget_unparent (GtkWidget *widget);
562 void gtk_widget_show (GtkWidget *widget);
563 void gtk_widget_show_now (GtkWidget *widget);
564 void gtk_widget_hide (GtkWidget *widget);
565 void gtk_widget_show_all (GtkWidget *widget);
566 void gtk_widget_hide_all (GtkWidget *widget);
567 void gtk_widget_set_no_show_all (GtkWidget *widget,
568 gboolean no_show_all);
569 gboolean gtk_widget_get_no_show_all (GtkWidget *widget);
570 void gtk_widget_map (GtkWidget *widget);
571 void gtk_widget_unmap (GtkWidget *widget);
572 void gtk_widget_realize (GtkWidget *widget);
573 void gtk_widget_unrealize (GtkWidget *widget);
576 void gtk_widget_queue_draw (GtkWidget *widget);
577 void gtk_widget_queue_draw_area (GtkWidget *widget,
582 void gtk_widget_queue_resize (GtkWidget *widget);
583 void gtk_widget_queue_resize_no_redraw (GtkWidget *widget);
584 void gtk_widget_size_request (GtkWidget *widget,
585 GtkRequisition *requisition);
586 void gtk_widget_size_allocate (GtkWidget *widget,
587 GtkAllocation *allocation);
588 void gtk_widget_get_child_requisition (GtkWidget *widget,
589 GtkRequisition *requisition);
590 void gtk_widget_add_accelerator (GtkWidget *widget,
591 const gchar *accel_signal,
592 GtkAccelGroup *accel_group,
594 GdkModifierType accel_mods,
595 GtkAccelFlags accel_flags);
596 gboolean gtk_widget_remove_accelerator (GtkWidget *widget,
597 GtkAccelGroup *accel_group,
599 GdkModifierType accel_mods);
600 void gtk_widget_set_accel_path (GtkWidget *widget,
601 const gchar *accel_path,
602 GtkAccelGroup *accel_group);
603 const gchar* _gtk_widget_get_accel_path (GtkWidget *widget,
605 GList* gtk_widget_list_accel_closures (GtkWidget *widget);
606 gboolean gtk_widget_can_activate_accel (GtkWidget *widget,
608 gboolean gtk_widget_mnemonic_activate (GtkWidget *widget,
609 gboolean group_cycling);
610 gboolean gtk_widget_event (GtkWidget *widget,
612 gint gtk_widget_send_expose (GtkWidget *widget,
614 gboolean gtk_widget_send_focus_change (GtkWidget *widget,
617 gboolean gtk_widget_activate (GtkWidget *widget);
618 gboolean gtk_widget_set_scroll_adjustments (GtkWidget *widget,
619 GtkAdjustment *hadjustment,
620 GtkAdjustment *vadjustment);
622 void gtk_widget_reparent (GtkWidget *widget,
623 GtkWidget *new_parent);
624 gboolean gtk_widget_intersect (GtkWidget *widget,
625 const GdkRectangle *area,
626 GdkRectangle *intersection);
627 cairo_region_t *gtk_widget_region_intersect (GtkWidget *widget,
628 const cairo_region_t *region);
630 void gtk_widget_freeze_child_notify (GtkWidget *widget);
631 void gtk_widget_child_notify (GtkWidget *widget,
632 const gchar *child_property);
633 void gtk_widget_thaw_child_notify (GtkWidget *widget);
635 void gtk_widget_set_can_focus (GtkWidget *widget,
637 gboolean gtk_widget_get_can_focus (GtkWidget *widget);
638 gboolean gtk_widget_has_focus (GtkWidget *widget);
639 gboolean gtk_widget_is_focus (GtkWidget *widget);
640 void gtk_widget_grab_focus (GtkWidget *widget);
642 void gtk_widget_set_can_default (GtkWidget *widget,
643 gboolean can_default);
644 gboolean gtk_widget_get_can_default (GtkWidget *widget);
645 gboolean gtk_widget_has_default (GtkWidget *widget);
646 void gtk_widget_grab_default (GtkWidget *widget);
648 void gtk_widget_set_receives_default (GtkWidget *widget,
649 gboolean receives_default);
650 gboolean gtk_widget_get_receives_default (GtkWidget *widget);
652 gboolean gtk_widget_has_grab (GtkWidget *widget);
654 gboolean gtk_widget_device_is_shadowed (GtkWidget *widget,
658 void gtk_widget_set_name (GtkWidget *widget,
660 G_CONST_RETURN gchar* gtk_widget_get_name (GtkWidget *widget);
662 void gtk_widget_set_state (GtkWidget *widget,
664 GtkStateType gtk_widget_get_state (GtkWidget *widget);
666 void gtk_widget_set_sensitive (GtkWidget *widget,
668 gboolean gtk_widget_get_sensitive (GtkWidget *widget);
669 gboolean gtk_widget_is_sensitive (GtkWidget *widget);
671 void gtk_widget_set_visible (GtkWidget *widget,
673 gboolean gtk_widget_get_visible (GtkWidget *widget);
675 void gtk_widget_set_has_window (GtkWidget *widget,
676 gboolean has_window);
677 gboolean gtk_widget_get_has_window (GtkWidget *widget);
679 gboolean gtk_widget_is_toplevel (GtkWidget *widget);
680 gboolean gtk_widget_is_drawable (GtkWidget *widget);
681 void gtk_widget_set_realized (GtkWidget *widget,
683 gboolean gtk_widget_get_realized (GtkWidget *widget);
684 void gtk_widget_set_mapped (GtkWidget *widget,
686 gboolean gtk_widget_get_mapped (GtkWidget *widget);
688 void gtk_widget_set_app_paintable (GtkWidget *widget,
689 gboolean app_paintable);
690 gboolean gtk_widget_get_app_paintable (GtkWidget *widget);
692 void gtk_widget_set_double_buffered (GtkWidget *widget,
693 gboolean double_buffered);
694 gboolean gtk_widget_get_double_buffered (GtkWidget *widget);
696 void gtk_widget_set_redraw_on_allocate (GtkWidget *widget,
697 gboolean redraw_on_allocate);
699 void gtk_widget_set_parent (GtkWidget *widget,
701 GtkWidget * gtk_widget_get_parent (GtkWidget *widget);
703 void gtk_widget_set_parent_window (GtkWidget *widget,
704 GdkWindow *parent_window);
705 GdkWindow * gtk_widget_get_parent_window (GtkWidget *widget);
707 void gtk_widget_set_child_visible (GtkWidget *widget,
708 gboolean is_visible);
709 gboolean gtk_widget_get_child_visible (GtkWidget *widget);
711 void gtk_widget_set_window (GtkWidget *widget,
713 GdkWindow * gtk_widget_get_window (GtkWidget *widget);
715 void gtk_widget_get_allocation (GtkWidget *widget,
716 GtkAllocation *allocation);
717 void gtk_widget_set_allocation (GtkWidget *widget,
718 const GtkAllocation *allocation);
720 void gtk_widget_get_requisition (GtkWidget *widget,
721 GtkRequisition *requisition);
723 gboolean gtk_widget_child_focus (GtkWidget *widget,
724 GtkDirectionType direction);
725 gboolean gtk_widget_keynav_failed (GtkWidget *widget,
726 GtkDirectionType direction);
727 void gtk_widget_error_bell (GtkWidget *widget);
729 void gtk_widget_set_size_request (GtkWidget *widget,
732 void gtk_widget_get_size_request (GtkWidget *widget,
735 void gtk_widget_set_events (GtkWidget *widget,
737 void gtk_widget_add_events (GtkWidget *widget,
739 void gtk_widget_set_device_events (GtkWidget *widget,
741 GdkEventMask events);
742 void gtk_widget_add_device_events (GtkWidget *widget,
744 GdkEventMask events);
745 void gtk_widget_set_extension_events (GtkWidget *widget,
746 GdkExtensionMode mode);
748 GdkExtensionMode gtk_widget_get_extension_events (GtkWidget *widget);
749 GtkWidget* gtk_widget_get_toplevel (GtkWidget *widget);
750 GtkWidget* gtk_widget_get_ancestor (GtkWidget *widget,
752 GdkColormap* gtk_widget_get_colormap (GtkWidget *widget);
753 GdkVisual* gtk_widget_get_visual (GtkWidget *widget);
755 GdkScreen * gtk_widget_get_screen (GtkWidget *widget);
756 gboolean gtk_widget_has_screen (GtkWidget *widget);
757 GdkDisplay * gtk_widget_get_display (GtkWidget *widget);
758 GdkWindow * gtk_widget_get_root_window (GtkWidget *widget);
759 GtkSettings* gtk_widget_get_settings (GtkWidget *widget);
760 GtkClipboard *gtk_widget_get_clipboard (GtkWidget *widget,
762 GdkPixmap * gtk_widget_get_snapshot (GtkWidget *widget,
763 GdkRectangle *clip_rect);
765 /* Multidevice support */
766 gboolean gtk_widget_get_support_multidevice (GtkWidget *widget);
767 void gtk_widget_set_support_multidevice (GtkWidget *widget,
768 gboolean support_multidevice);
770 /* Accessibility support */
771 AtkObject* gtk_widget_get_accessible (GtkWidget *widget);
773 /* The following functions must not be called on an already
774 * realized widget. Because it is possible that somebody
775 * can call get_colormap() or get_visual() and save the
776 * result, these functions are probably only safe to
777 * call in a widget's init() function.
779 void gtk_widget_set_colormap (GtkWidget *widget,
780 GdkColormap *colormap);
782 gint gtk_widget_get_events (GtkWidget *widget);
783 GdkEventMask gtk_widget_get_device_events (GtkWidget *widget,
785 void gtk_widget_get_pointer (GtkWidget *widget,
789 gboolean gtk_widget_is_ancestor (GtkWidget *widget,
790 GtkWidget *ancestor);
792 gboolean gtk_widget_translate_coordinates (GtkWidget *src_widget,
793 GtkWidget *dest_widget,
799 /* Hide widget and return TRUE.
801 gboolean gtk_widget_hide_on_delete (GtkWidget *widget);
805 void gtk_widget_style_attach (GtkWidget *widget);
807 gboolean gtk_widget_has_rc_style (GtkWidget *widget);
808 void gtk_widget_set_style (GtkWidget *widget,
810 void gtk_widget_ensure_style (GtkWidget *widget);
811 GtkStyle * gtk_widget_get_style (GtkWidget *widget);
813 void gtk_widget_modify_style (GtkWidget *widget,
815 GtkRcStyle *gtk_widget_get_modifier_style (GtkWidget *widget);
816 void gtk_widget_modify_fg (GtkWidget *widget,
818 const GdkColor *color);
819 void gtk_widget_modify_bg (GtkWidget *widget,
821 const GdkColor *color);
822 void gtk_widget_modify_text (GtkWidget *widget,
824 const GdkColor *color);
825 void gtk_widget_modify_base (GtkWidget *widget,
827 const GdkColor *color);
828 void gtk_widget_modify_cursor (GtkWidget *widget,
829 const GdkColor *primary,
830 const GdkColor *secondary);
831 void gtk_widget_modify_font (GtkWidget *widget,
832 PangoFontDescription *font_desc);
833 void gtk_widget_modify_symbolic_color (GtkWidget *widget,
835 const GdkColor *color);
837 PangoContext *gtk_widget_create_pango_context (GtkWidget *widget);
838 PangoContext *gtk_widget_get_pango_context (GtkWidget *widget);
839 PangoLayout *gtk_widget_create_pango_layout (GtkWidget *widget,
842 GdkPixbuf *gtk_widget_render_icon (GtkWidget *widget,
843 const gchar *stock_id,
845 const gchar *detail);
847 /* handle composite names for GTK_COMPOSITE_CHILD widgets,
848 * the returned name is newly allocated.
850 void gtk_widget_set_composite_name (GtkWidget *widget,
852 gchar* gtk_widget_get_composite_name (GtkWidget *widget);
854 /* Descend recursively and set rc-style on all widgets without user styles */
855 void gtk_widget_reset_rc_styles (GtkWidget *widget);
857 /* Push/pop pairs, to change default values upon a widget's creation.
858 * This will override the values that got set by the
859 * gtk_widget_set_default_* () functions.
861 void gtk_widget_push_colormap (GdkColormap *cmap);
862 void gtk_widget_push_composite_child (void);
863 void gtk_widget_pop_composite_child (void);
864 void gtk_widget_pop_colormap (void);
866 /* widget style properties
868 void gtk_widget_class_install_style_property (GtkWidgetClass *klass,
870 void gtk_widget_class_install_style_property_parser (GtkWidgetClass *klass,
872 GtkRcPropertyParser parser);
873 GParamSpec* gtk_widget_class_find_style_property (GtkWidgetClass *klass,
874 const gchar *property_name);
875 GParamSpec** gtk_widget_class_list_style_properties (GtkWidgetClass *klass,
876 guint *n_properties);
877 void gtk_widget_style_get_property (GtkWidget *widget,
878 const gchar *property_name,
880 void gtk_widget_style_get_valist (GtkWidget *widget,
881 const gchar *first_property_name,
883 void gtk_widget_style_get (GtkWidget *widget,
884 const gchar *first_property_name,
885 ...) G_GNUC_NULL_TERMINATED;
888 /* Set certain default values to be used at widget creation time.
890 void gtk_widget_set_default_colormap (GdkColormap *colormap);
891 GtkStyle* gtk_widget_get_default_style (void);
892 #ifndef GDK_MULTIHEAD_SAFE
893 GdkColormap* gtk_widget_get_default_colormap (void);
894 GdkVisual* gtk_widget_get_default_visual (void);
897 /* Functions for setting directionality for widgets
900 void gtk_widget_set_direction (GtkWidget *widget,
901 GtkTextDirection dir);
902 GtkTextDirection gtk_widget_get_direction (GtkWidget *widget);
904 void gtk_widget_set_default_direction (GtkTextDirection dir);
905 GtkTextDirection gtk_widget_get_default_direction (void);
907 /* Compositing manager functionality */
908 gboolean gtk_widget_is_composited (GtkWidget *widget);
910 /* Counterpart to gdk_window_shape_combine_mask.
912 void gtk_widget_shape_combine_mask (GtkWidget *widget,
913 GdkBitmap *shape_mask,
916 void gtk_widget_input_shape_combine_mask (GtkWidget *widget,
917 GdkBitmap *shape_mask,
921 /* internal function */
922 void gtk_widget_reset_shapes (GtkWidget *widget);
924 /* Compute a widget's path in the form "GtkWindow.MyLabel", and
925 * return newly alocated strings.
927 void gtk_widget_path (GtkWidget *widget,
930 gchar **path_reversed);
931 void gtk_widget_class_path (GtkWidget *widget,
934 gchar **path_reversed);
936 GList* gtk_widget_list_mnemonic_labels (GtkWidget *widget);
937 void gtk_widget_add_mnemonic_label (GtkWidget *widget,
939 void gtk_widget_remove_mnemonic_label (GtkWidget *widget,
942 void gtk_widget_set_tooltip_window (GtkWidget *widget,
943 GtkWindow *custom_window);
944 GtkWindow *gtk_widget_get_tooltip_window (GtkWidget *widget);
945 void gtk_widget_trigger_tooltip_query (GtkWidget *widget);
946 void gtk_widget_set_tooltip_text (GtkWidget *widget,
948 gchar * gtk_widget_get_tooltip_text (GtkWidget *widget);
949 void gtk_widget_set_tooltip_markup (GtkWidget *widget,
950 const gchar *markup);
951 gchar * gtk_widget_get_tooltip_markup (GtkWidget *widget);
952 void gtk_widget_set_has_tooltip (GtkWidget *widget,
953 gboolean has_tooltip);
954 gboolean gtk_widget_get_has_tooltip (GtkWidget *widget);
956 GType gtk_requisition_get_type (void) G_GNUC_CONST;
957 GtkRequisition *gtk_requisition_new (void) G_GNUC_MALLOC;
958 GtkRequisition *gtk_requisition_copy (const GtkRequisition *requisition);
959 void gtk_requisition_free (GtkRequisition *requisition);
961 void _gtk_widget_set_has_default (GtkWidget *widget,
962 gboolean has_default);
963 void _gtk_widget_set_has_grab (GtkWidget *widget,
965 void _gtk_widget_set_is_toplevel (GtkWidget *widget,
966 gboolean is_toplevel);
968 void _gtk_widget_grab_notify (GtkWidget *widget,
969 gboolean was_grabbed);
971 GtkWidgetAuxInfo *_gtk_widget_get_aux_info (GtkWidget *widget,
973 void _gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
974 GtkWidget *previous_toplevel);
975 void _gtk_widget_propagate_screen_changed (GtkWidget *widget,
976 GdkScreen *previous_screen);
977 void _gtk_widget_propagate_composited_changed (GtkWidget *widget);
979 void _gtk_widget_set_device_window (GtkWidget *widget,
981 GdkWindow *pointer_window);
982 GdkWindow *_gtk_widget_get_device_window (GtkWidget *widget,
984 GList * _gtk_widget_list_devices (GtkWidget *widget);
986 void _gtk_widget_synthesize_crossing (GtkWidget *from,
989 GdkCrossingMode mode);
991 GdkColormap* _gtk_widget_peek_colormap (void);
993 void _gtk_widget_buildable_finish_accelerator (GtkWidget *widget,
999 #endif /* __GTK_WIDGET_H__ */