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 _GtkWidgetShapeInfo GtkWidgetShapeInfo;
203 typedef struct _GtkClipboard GtkClipboard;
204 typedef struct _GtkTooltip GtkTooltip;
205 typedef struct _GtkWindow GtkWindow;
210 * @x: the X position of the widget's area relative to its parents allocation.
211 * @y: the Y position of the widget's area relative to its parents allocation.
212 * @width: the width of the widget's allocated area.
213 * @height: the height of the widget's allocated area.
215 * A <structname>GtkAllocation</structname> of a widget represents region which has been allocated to the
216 * widget by its parent. It is a subregion of its parents allocation. See
217 * <xref linkend="size-allocation"/> for more information.
219 typedef GdkRectangle GtkAllocation;
223 * @widget: the widget to operate on
224 * @data: user-supplied data
226 * The type of the callback functions used for e.g. iterating over
227 * the children of a container, see gtk_container_foreach().
229 typedef void (*GtkCallback) (GtkWidget *widget,
234 * @width: the widget's desired width
235 * @height: the widget's desired height
237 * A <structname>GtkRequisition</structname> represents the desired size of a widget. See
238 * <xref linkend="size-requisition"/> for more information.
240 struct _GtkRequisition
246 /* The widget is the base of the tree for displayable objects.
247 * (A displayable object is one which takes up some amount
248 * of screen real estate). It provides a common base and interface
249 * which actual widgets must adhere to.
253 /* The object structure needs to be the first
254 * element in the widget structure in order for
255 * the object mechanism to work correctly. This
256 * allows a GtkWidget pointer to be cast to a
261 /* internally used private flags. */
262 guint GSEAL (private_flags) : 16;
264 GtkWidgetPrivate *priv;
269 * @parent_class: The object class structure needs to be the first
270 * element in the widget class structure in order for the class mechanism
271 * to work correctly. This allows a GtkWidgetClass pointer to be cast to
272 * a GtkObjectClass pointer.
273 * @activate_signal: The signal to emit when a widget of this class is
274 * activated, gtk_widget_activate() handles the emission.
275 * Implementation of this signal is optional.
276 * @set_scroll_adjustments_signal: This signal is emitted when a widget of
277 * this class is added to a scrolling aware parent,
278 * gtk_widget_set_scroll_adjustments() handles the emission.
279 * Implementation of this signal is optional.
280 * @adjust_size_request: Convert an initial size request from a widget's
281 * #GtkSizeRequest virtual method implementations into a size request to
282 * be used by parent containers in laying out the widget.
283 * adjust_size_request adjusts <emphasis>from</emphasis> a child widget's
284 * original request <emphasis>to</emphasis> what a parent container should
285 * use for layout. The @for_size argument will be -1 if the request should
286 * not be for a particular size in the opposing orientation, i.e. if the
287 * request is not height-for-width or width-for-height. If @for_size is
288 * greater than -1, it is the proposed allocation in the opposing
289 * orientation that we need the request for. Implementations of
290 * adjust_size_request should chain up to the default implementation,
291 * which applies #GtkWidget's margin properties and imposes any values
292 * from gtk_widget_set_size_request(). Chaining up should be last,
293 * <emphasis>after</emphasis> your subclass adjusts the request, so
294 * #GtkWidget can apply constraints and add the margin properly.
295 * @adjust_size_allocation: Convert an initial size allocation assigned
296 * by a #GtkContainer using gtk_widget_size_allocate(), into an actual
297 * size allocation to be used by the widget. adjust_size_allocation
298 * adjusts <emphasis>to</emphasis> a child widget's actual allocation
299 * <emphasis>from</emphasis> what a parent container computed for the
300 * child. The adjusted allocation must be entirely within the original
301 * allocation. In any custom implementation, chain up to the default
302 * #GtkWidget implementation of this method, which applies the margin
303 * and alignment properties of #GtkWidget. Chain up
304 * <emphasis>before</emphasis> performing your own adjustments so your
305 * own adjustments remove more allocation after the #GtkWidget base
306 * class has already removed margin and alignment.
308 struct _GtkWidgetClass
310 GtkObjectClass parent_class;
314 guint activate_signal;
316 guint set_scroll_adjustments_signal;
320 /* seldomly overidden */
321 void (*dispatch_child_properties_changed) (GtkWidget *widget,
323 GParamSpec **pspecs);
326 void (* show) (GtkWidget *widget);
327 void (* show_all) (GtkWidget *widget);
328 void (* hide) (GtkWidget *widget);
329 void (* hide_all) (GtkWidget *widget);
330 void (* map) (GtkWidget *widget);
331 void (* unmap) (GtkWidget *widget);
332 void (* realize) (GtkWidget *widget);
333 void (* unrealize) (GtkWidget *widget);
334 void (* size_request) (GtkWidget *widget,
335 GtkRequisition *requisition);
336 void (* size_allocate) (GtkWidget *widget,
337 GtkAllocation *allocation);
338 void (* state_changed) (GtkWidget *widget,
339 GtkStateType previous_state);
340 void (* parent_set) (GtkWidget *widget,
341 GtkWidget *previous_parent);
342 void (* hierarchy_changed) (GtkWidget *widget,
343 GtkWidget *previous_toplevel);
344 void (* style_set) (GtkWidget *widget,
345 GtkStyle *previous_style);
346 void (* direction_changed) (GtkWidget *widget,
347 GtkTextDirection previous_direction);
348 void (* grab_notify) (GtkWidget *widget,
349 gboolean was_grabbed);
350 void (* child_notify) (GtkWidget *widget,
354 gboolean (* mnemonic_activate) (GtkWidget *widget,
355 gboolean group_cycling);
358 void (* grab_focus) (GtkWidget *widget);
359 gboolean (* focus) (GtkWidget *widget,
360 GtkDirectionType direction);
363 gboolean (* event) (GtkWidget *widget,
365 gboolean (* button_press_event) (GtkWidget *widget,
366 GdkEventButton *event);
367 gboolean (* button_release_event) (GtkWidget *widget,
368 GdkEventButton *event);
369 gboolean (* scroll_event) (GtkWidget *widget,
370 GdkEventScroll *event);
371 gboolean (* motion_notify_event) (GtkWidget *widget,
372 GdkEventMotion *event);
373 gboolean (* delete_event) (GtkWidget *widget,
375 gboolean (* destroy_event) (GtkWidget *widget,
377 gboolean (* expose_event) (GtkWidget *widget,
378 GdkEventExpose *event);
379 gboolean (* key_press_event) (GtkWidget *widget,
381 gboolean (* key_release_event) (GtkWidget *widget,
383 gboolean (* enter_notify_event) (GtkWidget *widget,
384 GdkEventCrossing *event);
385 gboolean (* leave_notify_event) (GtkWidget *widget,
386 GdkEventCrossing *event);
387 gboolean (* configure_event) (GtkWidget *widget,
388 GdkEventConfigure *event);
389 gboolean (* focus_in_event) (GtkWidget *widget,
390 GdkEventFocus *event);
391 gboolean (* focus_out_event) (GtkWidget *widget,
392 GdkEventFocus *event);
393 gboolean (* map_event) (GtkWidget *widget,
395 gboolean (* unmap_event) (GtkWidget *widget,
397 gboolean (* property_notify_event) (GtkWidget *widget,
398 GdkEventProperty *event);
399 gboolean (* selection_clear_event) (GtkWidget *widget,
400 GdkEventSelection *event);
401 gboolean (* selection_request_event) (GtkWidget *widget,
402 GdkEventSelection *event);
403 gboolean (* selection_notify_event) (GtkWidget *widget,
404 GdkEventSelection *event);
405 gboolean (* proximity_in_event) (GtkWidget *widget,
406 GdkEventProximity *event);
407 gboolean (* proximity_out_event) (GtkWidget *widget,
408 GdkEventProximity *event);
409 gboolean (* visibility_notify_event) (GtkWidget *widget,
410 GdkEventVisibility *event);
411 gboolean (* client_event) (GtkWidget *widget,
412 GdkEventClient *event);
413 gboolean (* no_expose_event) (GtkWidget *widget,
415 gboolean (* window_state_event) (GtkWidget *widget,
416 GdkEventWindowState *event);
419 void (* selection_get) (GtkWidget *widget,
420 GtkSelectionData *selection_data,
423 void (* selection_received) (GtkWidget *widget,
424 GtkSelectionData *selection_data,
427 /* Source side drag signals */
428 void (* drag_begin) (GtkWidget *widget,
429 GdkDragContext *context);
430 void (* drag_end) (GtkWidget *widget,
431 GdkDragContext *context);
432 void (* drag_data_get) (GtkWidget *widget,
433 GdkDragContext *context,
434 GtkSelectionData *selection_data,
437 void (* drag_data_delete) (GtkWidget *widget,
438 GdkDragContext *context);
440 /* Target side drag signals */
441 void (* drag_leave) (GtkWidget *widget,
442 GdkDragContext *context,
444 gboolean (* drag_motion) (GtkWidget *widget,
445 GdkDragContext *context,
449 gboolean (* drag_drop) (GtkWidget *widget,
450 GdkDragContext *context,
454 void (* drag_data_received) (GtkWidget *widget,
455 GdkDragContext *context,
458 GtkSelectionData *selection_data,
462 /* Signals used only for keybindings */
463 gboolean (* popup_menu) (GtkWidget *widget);
465 /* If a widget has multiple tooltips/whatsthis, it should show the
466 * one for the current focus location, or if that doesn't make
467 * sense, should cycle through them showing each tip alongside
468 * whatever piece of the widget it applies to.
470 gboolean (* show_help) (GtkWidget *widget,
471 GtkWidgetHelpType help_type);
473 /* accessibility support
475 AtkObject* (*get_accessible) (GtkWidget *widget);
477 void (*screen_changed) (GtkWidget *widget,
478 GdkScreen *previous_screen);
479 gboolean (*can_activate_accel) (GtkWidget *widget,
482 /* Sent when a grab is broken. */
483 gboolean (*grab_broken_event) (GtkWidget *widget,
484 GdkEventGrabBroken *event);
486 void (* composited_changed) (GtkWidget *widget);
488 gboolean (* query_tooltip) (GtkWidget *widget,
491 gboolean keyboard_tooltip,
492 GtkTooltip *tooltip);
496 void (* adjust_size_request) (GtkWidget *widget,
497 GtkOrientation orientation,
501 void (* adjust_size_allocation) (GtkWidget *widget,
502 GtkAllocation *allocation);
506 /* Signals without a C default handler class slot:
507 * gboolean (*damage_event) (GtkWidget *widget,
508 * GdkEventExpose *event);
511 /* Padding for future expansion */
512 void (*_gtk_reserved1) (void);
513 void (*_gtk_reserved2) (void);
514 void (*_gtk_reserved3) (void);
515 void (*_gtk_reserved4) (void);
516 void (*_gtk_reserved5) (void);
517 void (*_gtk_reserved6) (void);
518 void (*_gtk_reserved7) (void);
519 void (*_gtk_reserved8) (void);
522 struct _GtkWidgetAuxInfo
533 struct _GtkWidgetShapeInfo
537 GdkBitmap *shape_mask;
540 GType gtk_widget_get_type (void) G_GNUC_CONST;
541 GtkWidget* gtk_widget_new (GType type,
542 const gchar *first_property_name,
544 void gtk_widget_destroy (GtkWidget *widget);
545 void gtk_widget_destroyed (GtkWidget *widget,
546 GtkWidget **widget_pointer);
547 void gtk_widget_unparent (GtkWidget *widget);
548 void gtk_widget_show (GtkWidget *widget);
549 void gtk_widget_show_now (GtkWidget *widget);
550 void gtk_widget_hide (GtkWidget *widget);
551 void gtk_widget_show_all (GtkWidget *widget);
552 void gtk_widget_hide_all (GtkWidget *widget);
553 void gtk_widget_set_no_show_all (GtkWidget *widget,
554 gboolean no_show_all);
555 gboolean gtk_widget_get_no_show_all (GtkWidget *widget);
556 void gtk_widget_map (GtkWidget *widget);
557 void gtk_widget_unmap (GtkWidget *widget);
558 void gtk_widget_realize (GtkWidget *widget);
559 void gtk_widget_unrealize (GtkWidget *widget);
562 void gtk_widget_queue_draw (GtkWidget *widget);
563 void gtk_widget_queue_draw_area (GtkWidget *widget,
568 void gtk_widget_queue_resize (GtkWidget *widget);
569 void gtk_widget_queue_resize_no_redraw (GtkWidget *widget);
570 #ifndef GTK_DISABLE_DEPRECATED
571 void gtk_widget_size_request (GtkWidget *widget,
572 GtkRequisition *requisition);
574 void gtk_widget_size_allocate (GtkWidget *widget,
575 GtkAllocation *allocation);
576 #ifndef GTK_DISABLE_DEPRECATED
577 void gtk_widget_get_child_requisition (GtkWidget *widget,
578 GtkRequisition *requisition);
580 void gtk_widget_add_accelerator (GtkWidget *widget,
581 const gchar *accel_signal,
582 GtkAccelGroup *accel_group,
584 GdkModifierType accel_mods,
585 GtkAccelFlags accel_flags);
586 gboolean gtk_widget_remove_accelerator (GtkWidget *widget,
587 GtkAccelGroup *accel_group,
589 GdkModifierType accel_mods);
590 void gtk_widget_set_accel_path (GtkWidget *widget,
591 const gchar *accel_path,
592 GtkAccelGroup *accel_group);
593 const gchar* _gtk_widget_get_accel_path (GtkWidget *widget,
595 GList* gtk_widget_list_accel_closures (GtkWidget *widget);
596 gboolean gtk_widget_can_activate_accel (GtkWidget *widget,
598 gboolean gtk_widget_mnemonic_activate (GtkWidget *widget,
599 gboolean group_cycling);
600 gboolean gtk_widget_event (GtkWidget *widget,
602 gint gtk_widget_send_expose (GtkWidget *widget,
604 gboolean gtk_widget_send_focus_change (GtkWidget *widget,
607 gboolean gtk_widget_activate (GtkWidget *widget);
608 gboolean gtk_widget_set_scroll_adjustments (GtkWidget *widget,
609 GtkAdjustment *hadjustment,
610 GtkAdjustment *vadjustment);
612 void gtk_widget_reparent (GtkWidget *widget,
613 GtkWidget *new_parent);
614 gboolean gtk_widget_intersect (GtkWidget *widget,
615 const GdkRectangle *area,
616 GdkRectangle *intersection);
617 cairo_region_t *gtk_widget_region_intersect (GtkWidget *widget,
618 const cairo_region_t *region);
620 void gtk_widget_freeze_child_notify (GtkWidget *widget);
621 void gtk_widget_child_notify (GtkWidget *widget,
622 const gchar *child_property);
623 void gtk_widget_thaw_child_notify (GtkWidget *widget);
625 void gtk_widget_set_can_focus (GtkWidget *widget,
627 gboolean gtk_widget_get_can_focus (GtkWidget *widget);
628 gboolean gtk_widget_has_focus (GtkWidget *widget);
629 gboolean gtk_widget_is_focus (GtkWidget *widget);
630 void gtk_widget_grab_focus (GtkWidget *widget);
632 void gtk_widget_set_can_default (GtkWidget *widget,
633 gboolean can_default);
634 gboolean gtk_widget_get_can_default (GtkWidget *widget);
635 gboolean gtk_widget_has_default (GtkWidget *widget);
636 void gtk_widget_grab_default (GtkWidget *widget);
638 void gtk_widget_set_receives_default (GtkWidget *widget,
639 gboolean receives_default);
640 gboolean gtk_widget_get_receives_default (GtkWidget *widget);
642 gboolean gtk_widget_has_grab (GtkWidget *widget);
644 gboolean gtk_widget_device_is_shadowed (GtkWidget *widget,
648 void gtk_widget_set_name (GtkWidget *widget,
650 G_CONST_RETURN gchar* gtk_widget_get_name (GtkWidget *widget);
652 void gtk_widget_set_state (GtkWidget *widget,
654 GtkStateType gtk_widget_get_state (GtkWidget *widget);
656 void gtk_widget_set_sensitive (GtkWidget *widget,
658 gboolean gtk_widget_get_sensitive (GtkWidget *widget);
659 gboolean gtk_widget_is_sensitive (GtkWidget *widget);
661 void gtk_widget_set_visible (GtkWidget *widget,
663 gboolean gtk_widget_get_visible (GtkWidget *widget);
665 void gtk_widget_set_has_window (GtkWidget *widget,
666 gboolean has_window);
667 gboolean gtk_widget_get_has_window (GtkWidget *widget);
669 gboolean gtk_widget_is_toplevel (GtkWidget *widget);
670 gboolean gtk_widget_is_drawable (GtkWidget *widget);
671 void gtk_widget_set_realized (GtkWidget *widget,
673 gboolean gtk_widget_get_realized (GtkWidget *widget);
674 void gtk_widget_set_mapped (GtkWidget *widget,
676 gboolean gtk_widget_get_mapped (GtkWidget *widget);
678 void gtk_widget_set_app_paintable (GtkWidget *widget,
679 gboolean app_paintable);
680 gboolean gtk_widget_get_app_paintable (GtkWidget *widget);
682 void gtk_widget_set_double_buffered (GtkWidget *widget,
683 gboolean double_buffered);
684 gboolean gtk_widget_get_double_buffered (GtkWidget *widget);
686 void gtk_widget_set_redraw_on_allocate (GtkWidget *widget,
687 gboolean redraw_on_allocate);
689 void gtk_widget_set_parent (GtkWidget *widget,
691 GtkWidget * gtk_widget_get_parent (GtkWidget *widget);
693 void gtk_widget_set_parent_window (GtkWidget *widget,
694 GdkWindow *parent_window);
695 GdkWindow * gtk_widget_get_parent_window (GtkWidget *widget);
697 void gtk_widget_set_child_visible (GtkWidget *widget,
698 gboolean is_visible);
699 gboolean gtk_widget_get_child_visible (GtkWidget *widget);
701 void gtk_widget_set_window (GtkWidget *widget,
703 GdkWindow * gtk_widget_get_window (GtkWidget *widget);
705 void gtk_widget_get_allocation (GtkWidget *widget,
706 GtkAllocation *allocation);
707 void gtk_widget_set_allocation (GtkWidget *widget,
708 const GtkAllocation *allocation);
710 void gtk_widget_get_requisition (GtkWidget *widget,
711 GtkRequisition *requisition);
713 gboolean gtk_widget_child_focus (GtkWidget *widget,
714 GtkDirectionType direction);
715 gboolean gtk_widget_keynav_failed (GtkWidget *widget,
716 GtkDirectionType direction);
717 void gtk_widget_error_bell (GtkWidget *widget);
719 void gtk_widget_set_size_request (GtkWidget *widget,
722 void gtk_widget_get_size_request (GtkWidget *widget,
725 void gtk_widget_set_events (GtkWidget *widget,
727 void gtk_widget_add_events (GtkWidget *widget,
729 void gtk_widget_set_device_events (GtkWidget *widget,
731 GdkEventMask events);
732 void gtk_widget_add_device_events (GtkWidget *widget,
734 GdkEventMask events);
735 void gtk_widget_set_extension_events (GtkWidget *widget,
736 GdkExtensionMode mode);
738 GdkExtensionMode gtk_widget_get_extension_events (GtkWidget *widget);
739 GtkWidget* gtk_widget_get_toplevel (GtkWidget *widget);
740 GtkWidget* gtk_widget_get_ancestor (GtkWidget *widget,
742 GdkColormap* gtk_widget_get_colormap (GtkWidget *widget);
743 GdkVisual* gtk_widget_get_visual (GtkWidget *widget);
745 GdkScreen * gtk_widget_get_screen (GtkWidget *widget);
746 gboolean gtk_widget_has_screen (GtkWidget *widget);
747 GdkDisplay * gtk_widget_get_display (GtkWidget *widget);
748 GdkWindow * gtk_widget_get_root_window (GtkWidget *widget);
749 GtkSettings* gtk_widget_get_settings (GtkWidget *widget);
750 GtkClipboard *gtk_widget_get_clipboard (GtkWidget *widget,
752 GdkPixmap * gtk_widget_get_snapshot (GtkWidget *widget,
753 GdkRectangle *clip_rect);
755 /* Multidevice support */
756 gboolean gtk_widget_get_support_multidevice (GtkWidget *widget);
757 void gtk_widget_set_support_multidevice (GtkWidget *widget,
758 gboolean support_multidevice);
760 /* Accessibility support */
761 AtkObject* gtk_widget_get_accessible (GtkWidget *widget);
764 /* Margin and alignment */
765 GtkAlign gtk_widget_get_halign (GtkWidget *widget);
766 void gtk_widget_set_halign (GtkWidget *widget,
768 GtkAlign gtk_widget_get_valign (GtkWidget *widget);
769 void gtk_widget_set_valign (GtkWidget *widget,
771 gint gtk_widget_get_margin_left (GtkWidget *widget);
772 void gtk_widget_set_margin_left (GtkWidget *widget,
774 gint gtk_widget_get_margin_right (GtkWidget *widget);
775 void gtk_widget_set_margin_right (GtkWidget *widget,
777 gint gtk_widget_get_margin_top (GtkWidget *widget);
778 void gtk_widget_set_margin_top (GtkWidget *widget,
780 gint gtk_widget_get_margin_bottom (GtkWidget *widget);
781 void gtk_widget_set_margin_bottom (GtkWidget *widget,
785 /* The following functions must not be called on an already
786 * realized widget. Because it is possible that somebody
787 * can call get_colormap() or get_visual() and save the
788 * result, these functions are probably only safe to
789 * call in a widget's init() function.
791 void gtk_widget_set_colormap (GtkWidget *widget,
792 GdkColormap *colormap);
794 gint gtk_widget_get_events (GtkWidget *widget);
795 GdkEventMask gtk_widget_get_device_events (GtkWidget *widget,
797 void gtk_widget_get_pointer (GtkWidget *widget,
801 gboolean gtk_widget_is_ancestor (GtkWidget *widget,
802 GtkWidget *ancestor);
804 gboolean gtk_widget_translate_coordinates (GtkWidget *src_widget,
805 GtkWidget *dest_widget,
811 /* Hide widget and return TRUE.
813 gboolean gtk_widget_hide_on_delete (GtkWidget *widget);
817 void gtk_widget_style_attach (GtkWidget *widget);
819 gboolean gtk_widget_has_rc_style (GtkWidget *widget);
820 void gtk_widget_set_style (GtkWidget *widget,
822 void gtk_widget_ensure_style (GtkWidget *widget);
823 GtkStyle * gtk_widget_get_style (GtkWidget *widget);
825 void gtk_widget_modify_style (GtkWidget *widget,
827 GtkRcStyle *gtk_widget_get_modifier_style (GtkWidget *widget);
828 void gtk_widget_modify_fg (GtkWidget *widget,
830 const GdkColor *color);
831 void gtk_widget_modify_bg (GtkWidget *widget,
833 const GdkColor *color);
834 void gtk_widget_modify_text (GtkWidget *widget,
836 const GdkColor *color);
837 void gtk_widget_modify_base (GtkWidget *widget,
839 const GdkColor *color);
840 void gtk_widget_modify_cursor (GtkWidget *widget,
841 const GdkColor *primary,
842 const GdkColor *secondary);
843 void gtk_widget_modify_font (GtkWidget *widget,
844 PangoFontDescription *font_desc);
845 void gtk_widget_modify_symbolic_color (GtkWidget *widget,
847 const GdkColor *color);
849 PangoContext *gtk_widget_create_pango_context (GtkWidget *widget);
850 PangoContext *gtk_widget_get_pango_context (GtkWidget *widget);
851 PangoLayout *gtk_widget_create_pango_layout (GtkWidget *widget,
854 GdkPixbuf *gtk_widget_render_icon (GtkWidget *widget,
855 const gchar *stock_id,
857 const gchar *detail);
859 /* handle composite names for GTK_COMPOSITE_CHILD widgets,
860 * the returned name is newly allocated.
862 void gtk_widget_set_composite_name (GtkWidget *widget,
864 gchar* gtk_widget_get_composite_name (GtkWidget *widget);
866 /* Descend recursively and set rc-style on all widgets without user styles */
867 void gtk_widget_reset_rc_styles (GtkWidget *widget);
869 /* Push/pop pairs, to change default values upon a widget's creation.
870 * This will override the values that got set by the
871 * gtk_widget_set_default_* () functions.
873 void gtk_widget_push_colormap (GdkColormap *cmap);
874 void gtk_widget_push_composite_child (void);
875 void gtk_widget_pop_composite_child (void);
876 void gtk_widget_pop_colormap (void);
878 /* widget style properties
880 void gtk_widget_class_install_style_property (GtkWidgetClass *klass,
882 void gtk_widget_class_install_style_property_parser (GtkWidgetClass *klass,
884 GtkRcPropertyParser parser);
885 GParamSpec* gtk_widget_class_find_style_property (GtkWidgetClass *klass,
886 const gchar *property_name);
887 GParamSpec** gtk_widget_class_list_style_properties (GtkWidgetClass *klass,
888 guint *n_properties);
889 void gtk_widget_style_get_property (GtkWidget *widget,
890 const gchar *property_name,
892 void gtk_widget_style_get_valist (GtkWidget *widget,
893 const gchar *first_property_name,
895 void gtk_widget_style_get (GtkWidget *widget,
896 const gchar *first_property_name,
897 ...) G_GNUC_NULL_TERMINATED;
900 /* Set certain default values to be used at widget creation time.
902 void gtk_widget_set_default_colormap (GdkColormap *colormap);
903 GtkStyle* gtk_widget_get_default_style (void);
904 #ifndef GDK_MULTIHEAD_SAFE
905 GdkColormap* gtk_widget_get_default_colormap (void);
906 GdkVisual* gtk_widget_get_default_visual (void);
909 /* Functions for setting directionality for widgets
912 void gtk_widget_set_direction (GtkWidget *widget,
913 GtkTextDirection dir);
914 GtkTextDirection gtk_widget_get_direction (GtkWidget *widget);
916 void gtk_widget_set_default_direction (GtkTextDirection dir);
917 GtkTextDirection gtk_widget_get_default_direction (void);
919 /* Compositing manager functionality */
920 gboolean gtk_widget_is_composited (GtkWidget *widget);
922 /* Counterpart to gdk_window_shape_combine_mask.
924 void gtk_widget_shape_combine_mask (GtkWidget *widget,
925 GdkBitmap *shape_mask,
928 void gtk_widget_input_shape_combine_mask (GtkWidget *widget,
929 GdkBitmap *shape_mask,
933 /* internal function */
934 void gtk_widget_reset_shapes (GtkWidget *widget);
936 /* Compute a widget's path in the form "GtkWindow.MyLabel", and
937 * return newly alocated strings.
939 void gtk_widget_path (GtkWidget *widget,
942 gchar **path_reversed);
943 void gtk_widget_class_path (GtkWidget *widget,
946 gchar **path_reversed);
948 GList* gtk_widget_list_mnemonic_labels (GtkWidget *widget);
949 void gtk_widget_add_mnemonic_label (GtkWidget *widget,
951 void gtk_widget_remove_mnemonic_label (GtkWidget *widget,
954 void gtk_widget_set_tooltip_window (GtkWidget *widget,
955 GtkWindow *custom_window);
956 GtkWindow *gtk_widget_get_tooltip_window (GtkWidget *widget);
957 void gtk_widget_trigger_tooltip_query (GtkWidget *widget);
958 void gtk_widget_set_tooltip_text (GtkWidget *widget,
960 gchar * gtk_widget_get_tooltip_text (GtkWidget *widget);
961 void gtk_widget_set_tooltip_markup (GtkWidget *widget,
962 const gchar *markup);
963 gchar * gtk_widget_get_tooltip_markup (GtkWidget *widget);
964 void gtk_widget_set_has_tooltip (GtkWidget *widget,
965 gboolean has_tooltip);
966 gboolean gtk_widget_get_has_tooltip (GtkWidget *widget);
968 GType gtk_requisition_get_type (void) G_GNUC_CONST;
969 GtkRequisition *gtk_requisition_new (void) G_GNUC_MALLOC;
970 GtkRequisition *gtk_requisition_copy (const GtkRequisition *requisition);
971 void gtk_requisition_free (GtkRequisition *requisition);
973 void _gtk_widget_set_has_default (GtkWidget *widget,
974 gboolean has_default);
975 void _gtk_widget_set_has_grab (GtkWidget *widget,
977 void _gtk_widget_set_is_toplevel (GtkWidget *widget,
978 gboolean is_toplevel);
980 void _gtk_widget_grab_notify (GtkWidget *widget,
981 gboolean was_grabbed);
983 GtkWidgetAuxInfo *_gtk_widget_get_aux_info (GtkWidget *widget,
985 void _gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
986 GtkWidget *previous_toplevel);
987 void _gtk_widget_propagate_screen_changed (GtkWidget *widget,
988 GdkScreen *previous_screen);
989 void _gtk_widget_propagate_composited_changed (GtkWidget *widget);
991 void _gtk_widget_set_device_window (GtkWidget *widget,
993 GdkWindow *pointer_window);
994 GdkWindow *_gtk_widget_get_device_window (GtkWidget *widget,
996 GList * _gtk_widget_list_devices (GtkWidget *widget);
998 void _gtk_widget_synthesize_crossing (GtkWidget *from,
1001 GdkCrossingMode mode);
1003 GdkColormap* _gtk_widget_peek_colormap (void);
1005 gpointer _gtk_widget_peek_request_cache (GtkWidget *widget);
1007 void _gtk_widget_buildable_finish_accelerator (GtkWidget *widget,
1008 GtkWidget *toplevel,
1009 gpointer user_data);
1013 #endif /* __GTK_WIDGET_H__ */