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 _GtkWidgetPrivate GtkWidgetPrivate;
200 typedef struct _GtkWidgetClass GtkWidgetClass;
201 typedef struct _GtkWidgetAuxInfo GtkWidgetAuxInfo;
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 /* internally used private flags. */
261 guint GSEAL (private_flags) : 16;
263 GtkWidgetPrivate *priv;
268 * @parent_class: The object class structure needs to be the first
269 * element in the widget class structure in order for the class mechanism
270 * to work correctly. This allows a GtkWidgetClass pointer to be cast to
271 * a GtkObjectClass pointer.
272 * @activate_signal: The signal to emit when a widget of this class is
273 * activated, gtk_widget_activate() handles the emission.
274 * Implementation of this signal is optional.
275 * @set_scroll_adjustments_signal: This signal is emitted when a widget of
276 * this class is added to a scrolling aware parent,
277 * gtk_widget_set_scroll_adjustments() handles the emission.
278 * Implementation of this signal is optional.
279 * @adjust_size_request: Convert an initial size request from a widget's
280 * #GtkSizeRequest virtual method implementations into a size request to
281 * be used by parent containers in laying out the widget.
282 * adjust_size_request adjusts <emphasis>from</emphasis> a child widget's
283 * original request <emphasis>to</emphasis> what a parent container should
284 * use for layout. The @for_size argument will be -1 if the request should
285 * not be for a particular size in the opposing orientation, i.e. if the
286 * request is not height-for-width or width-for-height. If @for_size is
287 * greater than -1, it is the proposed allocation in the opposing
288 * orientation that we need the request for. Implementations of
289 * adjust_size_request should chain up to the default implementation,
290 * which applies #GtkWidget's margin properties and imposes any values
291 * from gtk_widget_set_size_request(). Chaining up should be last,
292 * <emphasis>after</emphasis> your subclass adjusts the request, so
293 * #GtkWidget can apply constraints and add the margin properly.
294 * @adjust_size_allocation: Convert an initial size allocation assigned
295 * by a #GtkContainer using gtk_widget_size_allocate(), into an actual
296 * size allocation to be used by the widget. adjust_size_allocation
297 * adjusts <emphasis>to</emphasis> a child widget's actual allocation
298 * <emphasis>from</emphasis> what a parent container computed for the
299 * child. The adjusted allocation must be entirely within the original
300 * allocation. In any custom implementation, chain up to the default
301 * #GtkWidget implementation of this method, which applies the margin
302 * and alignment properties of #GtkWidget. Chain up
303 * <emphasis>before</emphasis> performing your own adjustments so your
304 * own adjustments remove more allocation after the #GtkWidget base
305 * class has already removed margin and alignment.
307 struct _GtkWidgetClass
309 GtkObjectClass parent_class;
313 guint activate_signal;
315 guint set_scroll_adjustments_signal;
319 /* seldomly overidden */
320 void (*dispatch_child_properties_changed) (GtkWidget *widget,
322 GParamSpec **pspecs);
325 void (* show) (GtkWidget *widget);
326 void (* show_all) (GtkWidget *widget);
327 void (* hide) (GtkWidget *widget);
328 void (* hide_all) (GtkWidget *widget);
329 void (* map) (GtkWidget *widget);
330 void (* unmap) (GtkWidget *widget);
331 void (* realize) (GtkWidget *widget);
332 void (* unrealize) (GtkWidget *widget);
333 void (* size_request) (GtkWidget *widget,
334 GtkRequisition *requisition);
335 void (* size_allocate) (GtkWidget *widget,
336 GtkAllocation *allocation);
337 void (* state_changed) (GtkWidget *widget,
338 GtkStateType previous_state);
339 void (* parent_set) (GtkWidget *widget,
340 GtkWidget *previous_parent);
341 void (* hierarchy_changed) (GtkWidget *widget,
342 GtkWidget *previous_toplevel);
343 void (* style_set) (GtkWidget *widget,
344 GtkStyle *previous_style);
345 void (* direction_changed) (GtkWidget *widget,
346 GtkTextDirection previous_direction);
347 void (* grab_notify) (GtkWidget *widget,
348 gboolean was_grabbed);
349 void (* child_notify) (GtkWidget *widget,
353 gboolean (* mnemonic_activate) (GtkWidget *widget,
354 gboolean group_cycling);
357 void (* grab_focus) (GtkWidget *widget);
358 gboolean (* focus) (GtkWidget *widget,
359 GtkDirectionType direction);
362 gboolean (* event) (GtkWidget *widget,
364 gboolean (* button_press_event) (GtkWidget *widget,
365 GdkEventButton *event);
366 gboolean (* button_release_event) (GtkWidget *widget,
367 GdkEventButton *event);
368 gboolean (* scroll_event) (GtkWidget *widget,
369 GdkEventScroll *event);
370 gboolean (* motion_notify_event) (GtkWidget *widget,
371 GdkEventMotion *event);
372 gboolean (* delete_event) (GtkWidget *widget,
374 gboolean (* destroy_event) (GtkWidget *widget,
376 gboolean (* expose_event) (GtkWidget *widget,
377 GdkEventExpose *event);
378 gboolean (* key_press_event) (GtkWidget *widget,
380 gboolean (* key_release_event) (GtkWidget *widget,
382 gboolean (* enter_notify_event) (GtkWidget *widget,
383 GdkEventCrossing *event);
384 gboolean (* leave_notify_event) (GtkWidget *widget,
385 GdkEventCrossing *event);
386 gboolean (* configure_event) (GtkWidget *widget,
387 GdkEventConfigure *event);
388 gboolean (* focus_in_event) (GtkWidget *widget,
389 GdkEventFocus *event);
390 gboolean (* focus_out_event) (GtkWidget *widget,
391 GdkEventFocus *event);
392 gboolean (* map_event) (GtkWidget *widget,
394 gboolean (* unmap_event) (GtkWidget *widget,
396 gboolean (* property_notify_event) (GtkWidget *widget,
397 GdkEventProperty *event);
398 gboolean (* selection_clear_event) (GtkWidget *widget,
399 GdkEventSelection *event);
400 gboolean (* selection_request_event) (GtkWidget *widget,
401 GdkEventSelection *event);
402 gboolean (* selection_notify_event) (GtkWidget *widget,
403 GdkEventSelection *event);
404 gboolean (* proximity_in_event) (GtkWidget *widget,
405 GdkEventProximity *event);
406 gboolean (* proximity_out_event) (GtkWidget *widget,
407 GdkEventProximity *event);
408 gboolean (* visibility_notify_event) (GtkWidget *widget,
409 GdkEventVisibility *event);
410 gboolean (* client_event) (GtkWidget *widget,
411 GdkEventClient *event);
412 gboolean (* no_expose_event) (GtkWidget *widget,
414 gboolean (* window_state_event) (GtkWidget *widget,
415 GdkEventWindowState *event);
418 void (* selection_get) (GtkWidget *widget,
419 GtkSelectionData *selection_data,
422 void (* selection_received) (GtkWidget *widget,
423 GtkSelectionData *selection_data,
426 /* Source side drag signals */
427 void (* drag_begin) (GtkWidget *widget,
428 GdkDragContext *context);
429 void (* drag_end) (GtkWidget *widget,
430 GdkDragContext *context);
431 void (* drag_data_get) (GtkWidget *widget,
432 GdkDragContext *context,
433 GtkSelectionData *selection_data,
436 void (* drag_data_delete) (GtkWidget *widget,
437 GdkDragContext *context);
439 /* Target side drag signals */
440 void (* drag_leave) (GtkWidget *widget,
441 GdkDragContext *context,
443 gboolean (* drag_motion) (GtkWidget *widget,
444 GdkDragContext *context,
448 gboolean (* drag_drop) (GtkWidget *widget,
449 GdkDragContext *context,
453 void (* drag_data_received) (GtkWidget *widget,
454 GdkDragContext *context,
457 GtkSelectionData *selection_data,
461 /* Signals used only for keybindings */
462 gboolean (* popup_menu) (GtkWidget *widget);
464 /* If a widget has multiple tooltips/whatsthis, it should show the
465 * one for the current focus location, or if that doesn't make
466 * sense, should cycle through them showing each tip alongside
467 * whatever piece of the widget it applies to.
469 gboolean (* show_help) (GtkWidget *widget,
470 GtkWidgetHelpType help_type);
472 /* accessibility support
474 AtkObject* (*get_accessible) (GtkWidget *widget);
476 void (*screen_changed) (GtkWidget *widget,
477 GdkScreen *previous_screen);
478 gboolean (*can_activate_accel) (GtkWidget *widget,
481 /* Sent when a grab is broken. */
482 gboolean (*grab_broken_event) (GtkWidget *widget,
483 GdkEventGrabBroken *event);
485 void (* composited_changed) (GtkWidget *widget);
487 gboolean (* query_tooltip) (GtkWidget *widget,
490 gboolean keyboard_tooltip,
491 GtkTooltip *tooltip);
495 void (* adjust_size_request) (GtkWidget *widget,
496 GtkOrientation orientation,
500 void (* adjust_size_allocation) (GtkWidget *widget,
501 GtkAllocation *allocation);
505 /* Signals without a C default handler class slot:
506 * gboolean (*damage_event) (GtkWidget *widget,
507 * GdkEventExpose *event);
510 /* Padding for future expansion */
511 void (*_gtk_reserved1) (void);
512 void (*_gtk_reserved2) (void);
513 void (*_gtk_reserved3) (void);
514 void (*_gtk_reserved4) (void);
515 void (*_gtk_reserved5) (void);
516 void (*_gtk_reserved6) (void);
517 void (*_gtk_reserved7) (void);
518 void (*_gtk_reserved8) (void);
521 struct _GtkWidgetAuxInfo
532 GType gtk_widget_get_type (void) G_GNUC_CONST;
533 GtkWidget* gtk_widget_new (GType type,
534 const gchar *first_property_name,
536 void gtk_widget_destroy (GtkWidget *widget);
537 void gtk_widget_destroyed (GtkWidget *widget,
538 GtkWidget **widget_pointer);
539 void gtk_widget_unparent (GtkWidget *widget);
540 void gtk_widget_show (GtkWidget *widget);
541 void gtk_widget_show_now (GtkWidget *widget);
542 void gtk_widget_hide (GtkWidget *widget);
543 void gtk_widget_show_all (GtkWidget *widget);
544 void gtk_widget_hide_all (GtkWidget *widget);
545 void gtk_widget_set_no_show_all (GtkWidget *widget,
546 gboolean no_show_all);
547 gboolean gtk_widget_get_no_show_all (GtkWidget *widget);
548 void gtk_widget_map (GtkWidget *widget);
549 void gtk_widget_unmap (GtkWidget *widget);
550 void gtk_widget_realize (GtkWidget *widget);
551 void gtk_widget_unrealize (GtkWidget *widget);
554 void gtk_widget_queue_draw (GtkWidget *widget);
555 void gtk_widget_queue_draw_area (GtkWidget *widget,
560 void gtk_widget_queue_resize (GtkWidget *widget);
561 void gtk_widget_queue_resize_no_redraw (GtkWidget *widget);
562 #ifndef GTK_DISABLE_DEPRECATED
563 void gtk_widget_size_request (GtkWidget *widget,
564 GtkRequisition *requisition);
566 void gtk_widget_size_allocate (GtkWidget *widget,
567 GtkAllocation *allocation);
568 #ifndef GTK_DISABLE_DEPRECATED
569 void gtk_widget_get_child_requisition (GtkWidget *widget,
570 GtkRequisition *requisition);
572 void gtk_widget_add_accelerator (GtkWidget *widget,
573 const gchar *accel_signal,
574 GtkAccelGroup *accel_group,
576 GdkModifierType accel_mods,
577 GtkAccelFlags accel_flags);
578 gboolean gtk_widget_remove_accelerator (GtkWidget *widget,
579 GtkAccelGroup *accel_group,
581 GdkModifierType accel_mods);
582 void gtk_widget_set_accel_path (GtkWidget *widget,
583 const gchar *accel_path,
584 GtkAccelGroup *accel_group);
585 const gchar* _gtk_widget_get_accel_path (GtkWidget *widget,
587 GList* gtk_widget_list_accel_closures (GtkWidget *widget);
588 gboolean gtk_widget_can_activate_accel (GtkWidget *widget,
590 gboolean gtk_widget_mnemonic_activate (GtkWidget *widget,
591 gboolean group_cycling);
592 gboolean gtk_widget_event (GtkWidget *widget,
594 gint gtk_widget_send_expose (GtkWidget *widget,
596 gboolean gtk_widget_send_focus_change (GtkWidget *widget,
599 gboolean gtk_widget_activate (GtkWidget *widget);
600 gboolean gtk_widget_set_scroll_adjustments (GtkWidget *widget,
601 GtkAdjustment *hadjustment,
602 GtkAdjustment *vadjustment);
604 void gtk_widget_reparent (GtkWidget *widget,
605 GtkWidget *new_parent);
606 gboolean gtk_widget_intersect (GtkWidget *widget,
607 const GdkRectangle *area,
608 GdkRectangle *intersection);
609 cairo_region_t *gtk_widget_region_intersect (GtkWidget *widget,
610 const cairo_region_t *region);
612 void gtk_widget_freeze_child_notify (GtkWidget *widget);
613 void gtk_widget_child_notify (GtkWidget *widget,
614 const gchar *child_property);
615 void gtk_widget_thaw_child_notify (GtkWidget *widget);
617 void gtk_widget_set_can_focus (GtkWidget *widget,
619 gboolean gtk_widget_get_can_focus (GtkWidget *widget);
620 gboolean gtk_widget_has_focus (GtkWidget *widget);
621 gboolean gtk_widget_is_focus (GtkWidget *widget);
622 void gtk_widget_grab_focus (GtkWidget *widget);
624 void gtk_widget_set_can_default (GtkWidget *widget,
625 gboolean can_default);
626 gboolean gtk_widget_get_can_default (GtkWidget *widget);
627 gboolean gtk_widget_has_default (GtkWidget *widget);
628 void gtk_widget_grab_default (GtkWidget *widget);
630 void gtk_widget_set_receives_default (GtkWidget *widget,
631 gboolean receives_default);
632 gboolean gtk_widget_get_receives_default (GtkWidget *widget);
634 gboolean gtk_widget_has_grab (GtkWidget *widget);
636 gboolean gtk_widget_device_is_shadowed (GtkWidget *widget,
640 void gtk_widget_set_name (GtkWidget *widget,
642 G_CONST_RETURN gchar* gtk_widget_get_name (GtkWidget *widget);
644 void gtk_widget_set_state (GtkWidget *widget,
646 GtkStateType gtk_widget_get_state (GtkWidget *widget);
648 void gtk_widget_set_sensitive (GtkWidget *widget,
650 gboolean gtk_widget_get_sensitive (GtkWidget *widget);
651 gboolean gtk_widget_is_sensitive (GtkWidget *widget);
653 void gtk_widget_set_visible (GtkWidget *widget,
655 gboolean gtk_widget_get_visible (GtkWidget *widget);
657 void gtk_widget_set_has_window (GtkWidget *widget,
658 gboolean has_window);
659 gboolean gtk_widget_get_has_window (GtkWidget *widget);
661 gboolean gtk_widget_is_toplevel (GtkWidget *widget);
662 gboolean gtk_widget_is_drawable (GtkWidget *widget);
663 void gtk_widget_set_realized (GtkWidget *widget,
665 gboolean gtk_widget_get_realized (GtkWidget *widget);
666 void gtk_widget_set_mapped (GtkWidget *widget,
668 gboolean gtk_widget_get_mapped (GtkWidget *widget);
670 void gtk_widget_set_app_paintable (GtkWidget *widget,
671 gboolean app_paintable);
672 gboolean gtk_widget_get_app_paintable (GtkWidget *widget);
674 void gtk_widget_set_double_buffered (GtkWidget *widget,
675 gboolean double_buffered);
676 gboolean gtk_widget_get_double_buffered (GtkWidget *widget);
678 void gtk_widget_set_redraw_on_allocate (GtkWidget *widget,
679 gboolean redraw_on_allocate);
681 void gtk_widget_set_parent (GtkWidget *widget,
683 GtkWidget * gtk_widget_get_parent (GtkWidget *widget);
685 void gtk_widget_set_parent_window (GtkWidget *widget,
686 GdkWindow *parent_window);
687 GdkWindow * gtk_widget_get_parent_window (GtkWidget *widget);
689 void gtk_widget_set_child_visible (GtkWidget *widget,
690 gboolean is_visible);
691 gboolean gtk_widget_get_child_visible (GtkWidget *widget);
693 void gtk_widget_set_window (GtkWidget *widget,
695 GdkWindow * gtk_widget_get_window (GtkWidget *widget);
697 void gtk_widget_get_allocation (GtkWidget *widget,
698 GtkAllocation *allocation);
699 void gtk_widget_set_allocation (GtkWidget *widget,
700 const GtkAllocation *allocation);
702 void gtk_widget_get_requisition (GtkWidget *widget,
703 GtkRequisition *requisition);
705 gboolean gtk_widget_child_focus (GtkWidget *widget,
706 GtkDirectionType direction);
707 gboolean gtk_widget_keynav_failed (GtkWidget *widget,
708 GtkDirectionType direction);
709 void gtk_widget_error_bell (GtkWidget *widget);
711 void gtk_widget_set_size_request (GtkWidget *widget,
714 void gtk_widget_get_size_request (GtkWidget *widget,
717 void gtk_widget_set_events (GtkWidget *widget,
719 void gtk_widget_add_events (GtkWidget *widget,
721 void gtk_widget_set_device_events (GtkWidget *widget,
723 GdkEventMask events);
724 void gtk_widget_add_device_events (GtkWidget *widget,
726 GdkEventMask events);
727 void gtk_widget_set_extension_events (GtkWidget *widget,
728 GdkExtensionMode mode);
730 GdkExtensionMode gtk_widget_get_extension_events (GtkWidget *widget);
731 GtkWidget* gtk_widget_get_toplevel (GtkWidget *widget);
732 GtkWidget* gtk_widget_get_ancestor (GtkWidget *widget,
734 GdkVisual* gtk_widget_get_visual (GtkWidget *widget);
736 GdkScreen * gtk_widget_get_screen (GtkWidget *widget);
737 gboolean gtk_widget_has_screen (GtkWidget *widget);
738 GdkDisplay * gtk_widget_get_display (GtkWidget *widget);
739 GdkWindow * gtk_widget_get_root_window (GtkWidget *widget);
740 GtkSettings* gtk_widget_get_settings (GtkWidget *widget);
741 GtkClipboard *gtk_widget_get_clipboard (GtkWidget *widget,
744 /* Multidevice support */
745 gboolean gtk_widget_get_support_multidevice (GtkWidget *widget);
746 void gtk_widget_set_support_multidevice (GtkWidget *widget,
747 gboolean support_multidevice);
749 /* Accessibility support */
750 AtkObject* gtk_widget_get_accessible (GtkWidget *widget);
753 /* Margin and alignment */
754 GtkAlign gtk_widget_get_halign (GtkWidget *widget);
755 void gtk_widget_set_halign (GtkWidget *widget,
757 GtkAlign gtk_widget_get_valign (GtkWidget *widget);
758 void gtk_widget_set_valign (GtkWidget *widget,
760 gint gtk_widget_get_margin_left (GtkWidget *widget);
761 void gtk_widget_set_margin_left (GtkWidget *widget,
763 gint gtk_widget_get_margin_right (GtkWidget *widget);
764 void gtk_widget_set_margin_right (GtkWidget *widget,
766 gint gtk_widget_get_margin_top (GtkWidget *widget);
767 void gtk_widget_set_margin_top (GtkWidget *widget,
769 gint gtk_widget_get_margin_bottom (GtkWidget *widget);
770 void gtk_widget_set_margin_bottom (GtkWidget *widget,
774 gint gtk_widget_get_events (GtkWidget *widget);
775 GdkEventMask gtk_widget_get_device_events (GtkWidget *widget,
777 void gtk_widget_get_pointer (GtkWidget *widget,
781 gboolean gtk_widget_is_ancestor (GtkWidget *widget,
782 GtkWidget *ancestor);
784 gboolean gtk_widget_translate_coordinates (GtkWidget *src_widget,
785 GtkWidget *dest_widget,
791 /* Hide widget and return TRUE.
793 gboolean gtk_widget_hide_on_delete (GtkWidget *widget);
797 void gtk_widget_style_attach (GtkWidget *widget);
799 gboolean gtk_widget_has_rc_style (GtkWidget *widget);
800 void gtk_widget_set_style (GtkWidget *widget,
802 void gtk_widget_ensure_style (GtkWidget *widget);
803 GtkStyle * gtk_widget_get_style (GtkWidget *widget);
805 void gtk_widget_modify_style (GtkWidget *widget,
807 GtkRcStyle *gtk_widget_get_modifier_style (GtkWidget *widget);
808 void gtk_widget_modify_fg (GtkWidget *widget,
810 const GdkColor *color);
811 void gtk_widget_modify_bg (GtkWidget *widget,
813 const GdkColor *color);
814 void gtk_widget_modify_text (GtkWidget *widget,
816 const GdkColor *color);
817 void gtk_widget_modify_base (GtkWidget *widget,
819 const GdkColor *color);
820 void gtk_widget_modify_cursor (GtkWidget *widget,
821 const GdkColor *primary,
822 const GdkColor *secondary);
823 void gtk_widget_modify_font (GtkWidget *widget,
824 PangoFontDescription *font_desc);
825 void gtk_widget_modify_symbolic_color (GtkWidget *widget,
827 const GdkColor *color);
829 PangoContext *gtk_widget_create_pango_context (GtkWidget *widget);
830 PangoContext *gtk_widget_get_pango_context (GtkWidget *widget);
831 PangoLayout *gtk_widget_create_pango_layout (GtkWidget *widget,
834 GdkPixbuf *gtk_widget_render_icon (GtkWidget *widget,
835 const gchar *stock_id,
837 const gchar *detail);
839 /* handle composite names for GTK_COMPOSITE_CHILD widgets,
840 * the returned name is newly allocated.
842 void gtk_widget_set_composite_name (GtkWidget *widget,
844 gchar* gtk_widget_get_composite_name (GtkWidget *widget);
846 /* Descend recursively and set rc-style on all widgets without user styles */
847 void gtk_widget_reset_rc_styles (GtkWidget *widget);
849 /* Push/pop pairs, to change default values upon a widget's creation.
850 * This will override the values that got set by the
851 * gtk_widget_set_default_* () functions.
853 void gtk_widget_push_composite_child (void);
854 void gtk_widget_pop_composite_child (void);
856 /* widget style properties
858 void gtk_widget_class_install_style_property (GtkWidgetClass *klass,
860 void gtk_widget_class_install_style_property_parser (GtkWidgetClass *klass,
862 GtkRcPropertyParser parser);
863 GParamSpec* gtk_widget_class_find_style_property (GtkWidgetClass *klass,
864 const gchar *property_name);
865 GParamSpec** gtk_widget_class_list_style_properties (GtkWidgetClass *klass,
866 guint *n_properties);
867 void gtk_widget_style_get_property (GtkWidget *widget,
868 const gchar *property_name,
870 void gtk_widget_style_get_valist (GtkWidget *widget,
871 const gchar *first_property_name,
873 void gtk_widget_style_get (GtkWidget *widget,
874 const gchar *first_property_name,
875 ...) G_GNUC_NULL_TERMINATED;
878 /* Set certain default values to be used at widget creation time.
880 GtkStyle* gtk_widget_get_default_style (void);
882 /* Functions for setting directionality for widgets
885 void gtk_widget_set_direction (GtkWidget *widget,
886 GtkTextDirection dir);
887 GtkTextDirection gtk_widget_get_direction (GtkWidget *widget);
889 void gtk_widget_set_default_direction (GtkTextDirection dir);
890 GtkTextDirection gtk_widget_get_default_direction (void);
892 /* Compositing manager functionality */
893 gboolean gtk_widget_is_composited (GtkWidget *widget);
895 /* Counterpart to gdk_window_shape_combine_region.
897 void gtk_widget_shape_combine_region (GtkWidget *widget,
898 cairo_region_t *region);
899 void gtk_widget_input_shape_combine_region (GtkWidget *widget,
900 cairo_region_t *region);
902 /* internal function */
903 void gtk_widget_reset_shapes (GtkWidget *widget);
905 /* Compute a widget's path in the form "GtkWindow.MyLabel", and
906 * return newly alocated strings.
908 void gtk_widget_path (GtkWidget *widget,
911 gchar **path_reversed);
912 void gtk_widget_class_path (GtkWidget *widget,
915 gchar **path_reversed);
917 GList* gtk_widget_list_mnemonic_labels (GtkWidget *widget);
918 void gtk_widget_add_mnemonic_label (GtkWidget *widget,
920 void gtk_widget_remove_mnemonic_label (GtkWidget *widget,
923 void gtk_widget_set_tooltip_window (GtkWidget *widget,
924 GtkWindow *custom_window);
925 GtkWindow *gtk_widget_get_tooltip_window (GtkWidget *widget);
926 void gtk_widget_trigger_tooltip_query (GtkWidget *widget);
927 void gtk_widget_set_tooltip_text (GtkWidget *widget,
929 gchar * gtk_widget_get_tooltip_text (GtkWidget *widget);
930 void gtk_widget_set_tooltip_markup (GtkWidget *widget,
931 const gchar *markup);
932 gchar * gtk_widget_get_tooltip_markup (GtkWidget *widget);
933 void gtk_widget_set_has_tooltip (GtkWidget *widget,
934 gboolean has_tooltip);
935 gboolean gtk_widget_get_has_tooltip (GtkWidget *widget);
937 GType gtk_requisition_get_type (void) G_GNUC_CONST;
938 GtkRequisition *gtk_requisition_new (void) G_GNUC_MALLOC;
939 GtkRequisition *gtk_requisition_copy (const GtkRequisition *requisition);
940 void gtk_requisition_free (GtkRequisition *requisition);
942 void _gtk_widget_set_has_default (GtkWidget *widget,
943 gboolean has_default);
944 void _gtk_widget_set_has_grab (GtkWidget *widget,
946 void _gtk_widget_set_is_toplevel (GtkWidget *widget,
947 gboolean is_toplevel);
949 void _gtk_widget_grab_notify (GtkWidget *widget,
950 gboolean was_grabbed);
952 GtkWidgetAuxInfo *_gtk_widget_get_aux_info (GtkWidget *widget,
954 void _gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
955 GtkWidget *previous_toplevel);
956 void _gtk_widget_propagate_screen_changed (GtkWidget *widget,
957 GdkScreen *previous_screen);
958 void _gtk_widget_propagate_composited_changed (GtkWidget *widget);
960 void _gtk_widget_set_device_window (GtkWidget *widget,
962 GdkWindow *pointer_window);
963 GdkWindow *_gtk_widget_get_device_window (GtkWidget *widget,
965 GList * _gtk_widget_list_devices (GtkWidget *widget);
967 void _gtk_widget_synthesize_crossing (GtkWidget *from,
970 GdkCrossingMode mode);
972 gpointer _gtk_widget_peek_request_cache (GtkWidget *widget);
974 void _gtk_widget_buildable_finish_accelerator (GtkWidget *widget,
980 #endif /* __GTK_WIDGET_H__ */