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, see <http://www.gnu.org/licenses/>.
19 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
20 * file for a list of people on the GTK+ Team. See the ChangeLog
21 * files for a list of changes. These files are distributed with
22 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
25 #ifndef __GTK_WIDGET_H__
26 #define __GTK_WIDGET_H__
28 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
29 #error "Only <gtk/gtk.h> can be included directly."
33 #include <gtk/gtkaccelgroup.h>
34 #include <gtk/gtkborder.h>
35 #include <gtk/gtktypes.h>
40 /* Kinds of widget-specific help */
43 GTK_WIDGET_HELP_TOOLTIP,
44 GTK_WIDGET_HELP_WHATS_THIS
47 /* Macro for casting a pointer to a GtkWidget or GtkWidgetClass pointer.
48 * Macros for testing whether `widget' or `klass' are of type GTK_TYPE_WIDGET.
50 #define GTK_TYPE_WIDGET (gtk_widget_get_type ())
51 #define GTK_WIDGET(widget) (G_TYPE_CHECK_INSTANCE_CAST ((widget), GTK_TYPE_WIDGET, GtkWidget))
52 #define GTK_WIDGET_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WIDGET, GtkWidgetClass))
53 #define GTK_IS_WIDGET(widget) (G_TYPE_CHECK_INSTANCE_TYPE ((widget), GTK_TYPE_WIDGET))
54 #define GTK_IS_WIDGET_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WIDGET))
55 #define GTK_WIDGET_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WIDGET, GtkWidgetClass))
57 #define GTK_TYPE_REQUISITION (gtk_requisition_get_type ())
59 typedef struct _GtkWidgetPrivate GtkWidgetPrivate;
60 typedef struct _GtkWidgetClass GtkWidgetClass;
61 typedef struct _GtkWidgetClassPrivate GtkWidgetClassPrivate;
62 typedef struct _GtkWidgetAuxInfo GtkWidgetAuxInfo;
66 * @x: the X position of the widget's area relative to its parents allocation.
67 * @y: the Y position of the widget's area relative to its parents allocation.
68 * @width: the width of the widget's allocated area.
69 * @height: the height of the widget's allocated area.
71 * A <structname>GtkAllocation</structname> of a widget represents region
72 * which has been allocated to the widget by its parent. It is a subregion
73 * of its parents allocation. See <xref linkend="geometry-management"/> for
76 typedef GdkRectangle GtkAllocation;
80 * @widget: the widget to operate on
81 * @data: (closure): user-supplied data
83 * The type of the callback functions used for e.g. iterating over
84 * the children of a container, see gtk_container_foreach().
86 typedef void (*GtkCallback) (GtkWidget *widget,
91 * @width: the widget's desired width
92 * @height: the widget's desired height
94 * A <structname>GtkRequisition</structname> represents the desired size of a widget. See
95 * <xref linkend="geometry-management"/> for more information.
97 struct _GtkRequisition
103 /* The widget is the base of the tree for displayable objects.
104 * (A displayable object is one which takes up some amount
105 * of screen real estate). It provides a common base and interface
106 * which actual widgets must adhere to.
110 GInitiallyUnowned parent_instance;
112 GtkWidgetPrivate *priv;
117 * @parent_class: The object class structure needs to be the first
118 * element in the widget class structure in order for the class mechanism
119 * to work correctly. This allows a GtkWidgetClass pointer to be cast to
120 * a GObjectClass pointer.
121 * @activate_signal: The signal to emit when a widget of this class is
122 * activated, gtk_widget_activate() handles the emission.
123 * Implementation of this signal is optional.
124 * @get_request_mode: This allows a widget to tell its parent container whether
125 * it prefers to be allocated in %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH or
126 * %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT mode.
127 * %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH means the widget prefers to have
128 * #GtkWidgetClass.get_preferred_width() called and then
129 * #GtkWidgetClass.get_preferred_height_for_width().
130 * %GTK_SIZE_REQUEST_CONSTANT_SIZE disables any height-for-width or
131 * width-for-height geometry management for a said widget and is the
133 * It's important to note (as described below) that any widget
134 * which trades height-for-width or width-for-height must respond properly
135 * to both of the virtual methods #GtkWidgetClass.get_preferred_height_for_width()
136 * and #GtkWidgetClass.get_preferred_width_for_height() since it might be
137 * queried in either #GtkSizeRequestMode by its parent container.
138 * @get_preferred_height: This is called by containers to obtain the minimum
139 * and natural height of a widget. A widget that does not actually trade
140 * any height for width or width for height only has to implement these
141 * two virtual methods (#GtkWidgetClass.get_preferred_width() and
142 * #GtkWidgetClass.get_preferred_height()).
143 * @get_preferred_width_for_height: This is analogous to
144 * #GtkWidgetClass.get_preferred_height_for_width() except that it
145 * operates in the oposite orientation. It's rare that a widget actually
146 * does %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT requests but this can happen
147 * when, for example, a widget or container gets additional columns to
148 * compensate for a smaller allocated height.
149 * @get_preferred_width: This is called by containers to obtain the minimum
150 * and natural width of a widget. A widget will never be allocated a width
151 * less than its minimum and will only ever be allocated a width greater
152 * than the natural width once all of the said widget's siblings have
153 * received their natural widths.
154 * Furthermore, a widget will only ever be allocated a width greater than
155 * its natural width if it was configured to receive extra expand space
156 * from its parent container.
157 * @get_preferred_height_for_width: This is similar to
158 * #GtkWidgetClass.get_preferred_height() except that it is passed a
159 * contextual width to request height for. By implementing this virtual
160 * method it is possible for a #GtkLabel to tell its parent how much height
161 * would be required if the label were to be allocated a said width.
162 * @adjust_size_request: Convert an initial size request from a widget's
163 * #GtkSizeRequestMode virtual method implementations into a size request to
164 * be used by parent containers in laying out the widget.
165 * adjust_size_request adjusts <emphasis>from</emphasis> a child widget's
166 * original request <emphasis>to</emphasis> what a parent container should
167 * use for layout. The @for_size argument will be -1 if the request should
168 * not be for a particular size in the opposing orientation, i.e. if the
169 * request is not height-for-width or width-for-height. If @for_size is
170 * greater than -1, it is the proposed allocation in the opposing
171 * orientation that we need the request for. Implementations of
172 * adjust_size_request should chain up to the default implementation,
173 * which applies #GtkWidget's margin properties and imposes any values
174 * from gtk_widget_set_size_request(). Chaining up should be last,
175 * <emphasis>after</emphasis> your subclass adjusts the request, so
176 * #GtkWidget can apply constraints and add the margin properly.
177 * @adjust_size_allocation: Convert an initial size allocation assigned
178 * by a #GtkContainer using gtk_widget_size_allocate(), into an actual
179 * size allocation to be used by the widget. adjust_size_allocation
180 * adjusts <emphasis>to</emphasis> a child widget's actual allocation
181 * <emphasis>from</emphasis> what a parent container computed for the
182 * child. The adjusted allocation must be entirely within the original
183 * allocation. In any custom implementation, chain up to the default
184 * #GtkWidget implementation of this method, which applies the margin
185 * and alignment properties of #GtkWidget. Chain up
186 * <emphasis>before</emphasis> performing your own adjustments so your
187 * own adjustments remove more allocation after the #GtkWidget base
188 * class has already removed margin and alignment. The natural size
189 * passed in should be adjusted in the same way as the allocated size,
190 * which allows adjustments to perform alignments or other changes
191 * based on natural size.
193 struct _GtkWidgetClass
195 GInitiallyUnownedClass parent_class;
199 guint activate_signal;
201 /* seldomly overidden */
202 void (*dispatch_child_properties_changed) (GtkWidget *widget,
204 GParamSpec **pspecs);
207 void (* destroy) (GtkWidget *widget);
208 void (* show) (GtkWidget *widget);
209 void (* show_all) (GtkWidget *widget);
210 void (* hide) (GtkWidget *widget);
211 void (* map) (GtkWidget *widget);
212 void (* unmap) (GtkWidget *widget);
213 void (* realize) (GtkWidget *widget);
214 void (* unrealize) (GtkWidget *widget);
215 void (* size_allocate) (GtkWidget *widget,
216 GtkAllocation *allocation);
217 void (* state_changed) (GtkWidget *widget,
218 GtkStateType previous_state);
219 void (* state_flags_changed) (GtkWidget *widget,
220 GtkStateFlags previous_state_flags);
221 void (* parent_set) (GtkWidget *widget,
222 GtkWidget *previous_parent);
223 void (* hierarchy_changed) (GtkWidget *widget,
224 GtkWidget *previous_toplevel);
225 void (* style_set) (GtkWidget *widget,
226 GtkStyle *previous_style);
227 void (* direction_changed) (GtkWidget *widget,
228 GtkTextDirection previous_direction);
229 void (* grab_notify) (GtkWidget *widget,
230 gboolean was_grabbed);
231 void (* child_notify) (GtkWidget *widget,
232 GParamSpec *child_property);
233 gboolean (* draw) (GtkWidget *widget,
237 GtkSizeRequestMode (* get_request_mode) (GtkWidget *widget);
239 void (* get_preferred_height) (GtkWidget *widget,
240 gint *minimum_height,
241 gint *natural_height);
242 void (* get_preferred_width_for_height) (GtkWidget *widget,
245 gint *natural_width);
246 void (* get_preferred_width) (GtkWidget *widget,
248 gint *natural_width);
249 void (* get_preferred_height_for_width) (GtkWidget *widget,
251 gint *minimum_height,
252 gint *natural_height);
255 gboolean (* mnemonic_activate) (GtkWidget *widget,
256 gboolean group_cycling);
259 void (* grab_focus) (GtkWidget *widget);
260 gboolean (* focus) (GtkWidget *widget,
261 GtkDirectionType direction);
263 /* keyboard navigation */
264 void (* move_focus) (GtkWidget *widget,
265 GtkDirectionType direction);
266 gboolean (* keynav_failed) (GtkWidget *widget,
267 GtkDirectionType direction);
270 gboolean (* event) (GtkWidget *widget,
272 gboolean (* button_press_event) (GtkWidget *widget,
273 GdkEventButton *event);
274 gboolean (* button_release_event) (GtkWidget *widget,
275 GdkEventButton *event);
276 gboolean (* scroll_event) (GtkWidget *widget,
277 GdkEventScroll *event);
278 gboolean (* motion_notify_event) (GtkWidget *widget,
279 GdkEventMotion *event);
280 gboolean (* delete_event) (GtkWidget *widget,
282 gboolean (* destroy_event) (GtkWidget *widget,
284 gboolean (* key_press_event) (GtkWidget *widget,
286 gboolean (* key_release_event) (GtkWidget *widget,
288 gboolean (* enter_notify_event) (GtkWidget *widget,
289 GdkEventCrossing *event);
290 gboolean (* leave_notify_event) (GtkWidget *widget,
291 GdkEventCrossing *event);
292 gboolean (* configure_event) (GtkWidget *widget,
293 GdkEventConfigure *event);
294 gboolean (* focus_in_event) (GtkWidget *widget,
295 GdkEventFocus *event);
296 gboolean (* focus_out_event) (GtkWidget *widget,
297 GdkEventFocus *event);
298 gboolean (* map_event) (GtkWidget *widget,
300 gboolean (* unmap_event) (GtkWidget *widget,
302 gboolean (* property_notify_event) (GtkWidget *widget,
303 GdkEventProperty *event);
304 gboolean (* selection_clear_event) (GtkWidget *widget,
305 GdkEventSelection *event);
306 gboolean (* selection_request_event) (GtkWidget *widget,
307 GdkEventSelection *event);
308 gboolean (* selection_notify_event) (GtkWidget *widget,
309 GdkEventSelection *event);
310 gboolean (* proximity_in_event) (GtkWidget *widget,
311 GdkEventProximity *event);
312 gboolean (* proximity_out_event) (GtkWidget *widget,
313 GdkEventProximity *event);
314 gboolean (* visibility_notify_event) (GtkWidget *widget,
315 GdkEventVisibility *event);
316 gboolean (* window_state_event) (GtkWidget *widget,
317 GdkEventWindowState *event);
318 gboolean (* damage_event) (GtkWidget *widget,
319 GdkEventExpose *event);
320 gboolean (* grab_broken_event) (GtkWidget *widget,
321 GdkEventGrabBroken *event);
324 void (* selection_get) (GtkWidget *widget,
325 GtkSelectionData *selection_data,
328 void (* selection_received) (GtkWidget *widget,
329 GtkSelectionData *selection_data,
332 /* Source side drag signals */
333 void (* drag_begin) (GtkWidget *widget,
334 GdkDragContext *context);
335 void (* drag_end) (GtkWidget *widget,
336 GdkDragContext *context);
337 void (* drag_data_get) (GtkWidget *widget,
338 GdkDragContext *context,
339 GtkSelectionData *selection_data,
342 void (* drag_data_delete) (GtkWidget *widget,
343 GdkDragContext *context);
345 /* Target side drag signals */
346 void (* drag_leave) (GtkWidget *widget,
347 GdkDragContext *context,
349 gboolean (* drag_motion) (GtkWidget *widget,
350 GdkDragContext *context,
354 gboolean (* drag_drop) (GtkWidget *widget,
355 GdkDragContext *context,
359 void (* drag_data_received) (GtkWidget *widget,
360 GdkDragContext *context,
363 GtkSelectionData *selection_data,
366 gboolean (* drag_failed) (GtkWidget *widget,
367 GdkDragContext *context,
368 GtkDragResult result);
370 /* Signals used only for keybindings */
371 gboolean (* popup_menu) (GtkWidget *widget);
373 /* If a widget has multiple tooltips/whatsthis, it should show the
374 * one for the current focus location, or if that doesn't make
375 * sense, should cycle through them showing each tip alongside
376 * whatever piece of the widget it applies to.
378 gboolean (* show_help) (GtkWidget *widget,
379 GtkWidgetHelpType help_type);
381 /* accessibility support
383 AtkObject * (* get_accessible) (GtkWidget *widget);
385 void (* screen_changed) (GtkWidget *widget,
386 GdkScreen *previous_screen);
387 gboolean (* can_activate_accel) (GtkWidget *widget,
391 void (* composited_changed) (GtkWidget *widget);
393 gboolean (* query_tooltip) (GtkWidget *widget,
396 gboolean keyboard_tooltip,
397 GtkTooltip *tooltip);
399 void (* compute_expand) (GtkWidget *widget,
401 gboolean *vexpand_p);
403 void (* adjust_size_request) (GtkWidget *widget,
404 GtkOrientation orientation,
407 void (* adjust_size_allocation) (GtkWidget *widget,
408 GtkOrientation orientation,
412 gint *allocated_size);
414 void (* style_updated) (GtkWidget *widget);
416 gboolean (* touch_event) (GtkWidget *widget,
417 GdkEventTouch *event);
421 GtkWidgetClassPrivate *priv;
423 /* Padding for future expansion */
424 void (*_gtk_reserved2) (void);
425 void (*_gtk_reserved3) (void);
426 void (*_gtk_reserved4) (void);
427 void (*_gtk_reserved5) (void);
428 void (*_gtk_reserved6) (void);
429 void (*_gtk_reserved7) (void);
432 struct _GtkWidgetAuxInfo
443 GType gtk_widget_get_type (void) G_GNUC_CONST;
444 GtkWidget* gtk_widget_new (GType type,
445 const gchar *first_property_name,
447 void gtk_widget_destroy (GtkWidget *widget);
448 void gtk_widget_destroyed (GtkWidget *widget,
449 GtkWidget **widget_pointer);
450 void gtk_widget_unparent (GtkWidget *widget);
451 void gtk_widget_show (GtkWidget *widget);
452 void gtk_widget_hide (GtkWidget *widget);
453 void gtk_widget_show_now (GtkWidget *widget);
454 void gtk_widget_show_all (GtkWidget *widget);
455 void gtk_widget_set_no_show_all (GtkWidget *widget,
456 gboolean no_show_all);
457 gboolean gtk_widget_get_no_show_all (GtkWidget *widget);
458 void gtk_widget_map (GtkWidget *widget);
459 void gtk_widget_unmap (GtkWidget *widget);
460 void gtk_widget_realize (GtkWidget *widget);
461 void gtk_widget_unrealize (GtkWidget *widget);
463 void gtk_widget_draw (GtkWidget *widget,
466 void gtk_widget_queue_draw (GtkWidget *widget);
467 void gtk_widget_queue_draw_area (GtkWidget *widget,
472 void gtk_widget_queue_draw_region (GtkWidget *widget,
473 const cairo_region_t*region);
474 void gtk_widget_queue_resize (GtkWidget *widget);
475 void gtk_widget_queue_resize_no_redraw (GtkWidget *widget);
476 GDK_DEPRECATED_IN_3_0_FOR(gtk_widget_get_preferred_size)
477 void gtk_widget_size_request (GtkWidget *widget,
478 GtkRequisition *requisition);
479 void gtk_widget_size_allocate (GtkWidget *widget,
480 GtkAllocation *allocation);
482 GtkSizeRequestMode gtk_widget_get_request_mode (GtkWidget *widget);
483 void gtk_widget_get_preferred_width (GtkWidget *widget,
485 gint *natural_width);
486 void gtk_widget_get_preferred_height_for_width (GtkWidget *widget,
488 gint *minimum_height,
489 gint *natural_height);
490 void gtk_widget_get_preferred_height (GtkWidget *widget,
491 gint *minimum_height,
492 gint *natural_height);
493 void gtk_widget_get_preferred_width_for_height (GtkWidget *widget,
496 gint *natural_width);
497 void gtk_widget_get_preferred_size (GtkWidget *widget,
498 GtkRequisition *minimum_size,
499 GtkRequisition *natural_size);
501 GDK_DEPRECATED_IN_3_0_FOR(gtk_widget_get_preferred_size)
502 void gtk_widget_get_child_requisition (GtkWidget *widget,
503 GtkRequisition *requisition);
504 void gtk_widget_add_accelerator (GtkWidget *widget,
505 const gchar *accel_signal,
506 GtkAccelGroup *accel_group,
508 GdkModifierType accel_mods,
509 GtkAccelFlags accel_flags);
510 gboolean gtk_widget_remove_accelerator (GtkWidget *widget,
511 GtkAccelGroup *accel_group,
513 GdkModifierType accel_mods);
514 void gtk_widget_set_accel_path (GtkWidget *widget,
515 const gchar *accel_path,
516 GtkAccelGroup *accel_group);
517 GList* gtk_widget_list_accel_closures (GtkWidget *widget);
518 gboolean gtk_widget_can_activate_accel (GtkWidget *widget,
520 gboolean gtk_widget_mnemonic_activate (GtkWidget *widget,
521 gboolean group_cycling);
522 gboolean gtk_widget_event (GtkWidget *widget,
524 gint gtk_widget_send_expose (GtkWidget *widget,
526 gboolean gtk_widget_send_focus_change (GtkWidget *widget,
529 gboolean gtk_widget_activate (GtkWidget *widget);
531 void gtk_widget_reparent (GtkWidget *widget,
532 GtkWidget *new_parent);
533 gboolean gtk_widget_intersect (GtkWidget *widget,
534 const GdkRectangle *area,
535 GdkRectangle *intersection);
536 cairo_region_t *gtk_widget_region_intersect (GtkWidget *widget,
537 const cairo_region_t *region);
539 void gtk_widget_freeze_child_notify (GtkWidget *widget);
540 void gtk_widget_child_notify (GtkWidget *widget,
541 const gchar *child_property);
542 void gtk_widget_thaw_child_notify (GtkWidget *widget);
544 void gtk_widget_set_can_focus (GtkWidget *widget,
546 gboolean gtk_widget_get_can_focus (GtkWidget *widget);
547 gboolean gtk_widget_has_focus (GtkWidget *widget);
548 gboolean gtk_widget_is_focus (GtkWidget *widget);
550 gboolean gtk_widget_has_visible_focus (GtkWidget *widget);
551 void gtk_widget_grab_focus (GtkWidget *widget);
553 void gtk_widget_set_can_default (GtkWidget *widget,
554 gboolean can_default);
555 gboolean gtk_widget_get_can_default (GtkWidget *widget);
556 gboolean gtk_widget_has_default (GtkWidget *widget);
557 void gtk_widget_grab_default (GtkWidget *widget);
559 void gtk_widget_set_receives_default (GtkWidget *widget,
560 gboolean receives_default);
561 gboolean gtk_widget_get_receives_default (GtkWidget *widget);
563 gboolean gtk_widget_has_grab (GtkWidget *widget);
565 gboolean gtk_widget_device_is_shadowed (GtkWidget *widget,
569 void gtk_widget_set_name (GtkWidget *widget,
571 const gchar * gtk_widget_get_name (GtkWidget *widget);
573 void gtk_widget_set_state (GtkWidget *widget,
575 GtkStateType gtk_widget_get_state (GtkWidget *widget);
577 void gtk_widget_set_state_flags (GtkWidget *widget,
580 void gtk_widget_unset_state_flags (GtkWidget *widget,
581 GtkStateFlags flags);
582 GtkStateFlags gtk_widget_get_state_flags (GtkWidget *widget);
584 void gtk_widget_set_sensitive (GtkWidget *widget,
586 gboolean gtk_widget_get_sensitive (GtkWidget *widget);
587 gboolean gtk_widget_is_sensitive (GtkWidget *widget);
589 void gtk_widget_set_visible (GtkWidget *widget,
591 gboolean gtk_widget_get_visible (GtkWidget *widget);
592 gboolean gtk_widget_is_visible (GtkWidget *widget);
594 void gtk_widget_set_has_window (GtkWidget *widget,
595 gboolean has_window);
596 gboolean gtk_widget_get_has_window (GtkWidget *widget);
598 gboolean gtk_widget_is_toplevel (GtkWidget *widget);
599 gboolean gtk_widget_is_drawable (GtkWidget *widget);
600 void gtk_widget_set_realized (GtkWidget *widget,
602 gboolean gtk_widget_get_realized (GtkWidget *widget);
603 void gtk_widget_set_mapped (GtkWidget *widget,
605 gboolean gtk_widget_get_mapped (GtkWidget *widget);
607 void gtk_widget_set_app_paintable (GtkWidget *widget,
608 gboolean app_paintable);
609 gboolean gtk_widget_get_app_paintable (GtkWidget *widget);
611 void gtk_widget_set_double_buffered (GtkWidget *widget,
612 gboolean double_buffered);
613 gboolean gtk_widget_get_double_buffered (GtkWidget *widget);
615 void gtk_widget_set_redraw_on_allocate (GtkWidget *widget,
616 gboolean redraw_on_allocate);
618 void gtk_widget_set_parent (GtkWidget *widget,
620 GtkWidget * gtk_widget_get_parent (GtkWidget *widget);
622 void gtk_widget_set_parent_window (GtkWidget *widget,
623 GdkWindow *parent_window);
624 GdkWindow * gtk_widget_get_parent_window (GtkWidget *widget);
626 void gtk_widget_set_child_visible (GtkWidget *widget,
627 gboolean is_visible);
628 gboolean gtk_widget_get_child_visible (GtkWidget *widget);
630 void gtk_widget_set_window (GtkWidget *widget,
632 GdkWindow * gtk_widget_get_window (GtkWidget *widget);
634 int gtk_widget_get_allocated_width (GtkWidget *widget);
635 int gtk_widget_get_allocated_height (GtkWidget *widget);
637 void gtk_widget_get_allocation (GtkWidget *widget,
638 GtkAllocation *allocation);
639 void gtk_widget_set_allocation (GtkWidget *widget,
640 const GtkAllocation *allocation);
642 void gtk_widget_get_requisition (GtkWidget *widget,
643 GtkRequisition *requisition);
645 gboolean gtk_widget_child_focus (GtkWidget *widget,
646 GtkDirectionType direction);
647 gboolean gtk_widget_keynav_failed (GtkWidget *widget,
648 GtkDirectionType direction);
649 void gtk_widget_error_bell (GtkWidget *widget);
651 void gtk_widget_set_size_request (GtkWidget *widget,
654 void gtk_widget_get_size_request (GtkWidget *widget,
657 void gtk_widget_set_events (GtkWidget *widget,
659 void gtk_widget_add_events (GtkWidget *widget,
661 void gtk_widget_set_device_events (GtkWidget *widget,
663 GdkEventMask events);
664 void gtk_widget_add_device_events (GtkWidget *widget,
666 GdkEventMask events);
668 void gtk_widget_set_device_enabled (GtkWidget *widget,
671 gboolean gtk_widget_get_device_enabled (GtkWidget *widget,
674 GtkWidget* gtk_widget_get_toplevel (GtkWidget *widget);
675 GtkWidget* gtk_widget_get_ancestor (GtkWidget *widget,
677 GdkVisual* gtk_widget_get_visual (GtkWidget *widget);
678 void gtk_widget_set_visual (GtkWidget *widget,
681 GdkScreen * gtk_widget_get_screen (GtkWidget *widget);
682 gboolean gtk_widget_has_screen (GtkWidget *widget);
683 GdkDisplay * gtk_widget_get_display (GtkWidget *widget);
684 GdkWindow * gtk_widget_get_root_window (GtkWidget *widget);
685 GtkSettings* gtk_widget_get_settings (GtkWidget *widget);
686 GtkClipboard *gtk_widget_get_clipboard (GtkWidget *widget,
690 /* Expand flags and related support */
691 gboolean gtk_widget_get_hexpand (GtkWidget *widget);
692 void gtk_widget_set_hexpand (GtkWidget *widget,
694 gboolean gtk_widget_get_hexpand_set (GtkWidget *widget);
695 void gtk_widget_set_hexpand_set (GtkWidget *widget,
697 gboolean gtk_widget_get_vexpand (GtkWidget *widget);
698 void gtk_widget_set_vexpand (GtkWidget *widget,
700 gboolean gtk_widget_get_vexpand_set (GtkWidget *widget);
701 void gtk_widget_set_vexpand_set (GtkWidget *widget,
703 void gtk_widget_queue_compute_expand (GtkWidget *widget);
704 gboolean gtk_widget_compute_expand (GtkWidget *widget,
705 GtkOrientation orientation);
708 /* Multidevice support */
709 gboolean gtk_widget_get_support_multidevice (GtkWidget *widget);
710 void gtk_widget_set_support_multidevice (GtkWidget *widget,
711 gboolean support_multidevice);
713 /* Accessibility support */
715 void gtk_widget_class_set_accessible_type (GtkWidgetClass *widget_class,
718 void gtk_widget_class_set_accessible_role (GtkWidgetClass *widget_class,
720 AtkObject* gtk_widget_get_accessible (GtkWidget *widget);
723 /* Margin and alignment */
724 GtkAlign gtk_widget_get_halign (GtkWidget *widget);
725 void gtk_widget_set_halign (GtkWidget *widget,
727 GtkAlign gtk_widget_get_valign (GtkWidget *widget);
728 void gtk_widget_set_valign (GtkWidget *widget,
730 gint gtk_widget_get_margin_left (GtkWidget *widget);
731 void gtk_widget_set_margin_left (GtkWidget *widget,
733 gint gtk_widget_get_margin_right (GtkWidget *widget);
734 void gtk_widget_set_margin_right (GtkWidget *widget,
736 gint gtk_widget_get_margin_top (GtkWidget *widget);
737 void gtk_widget_set_margin_top (GtkWidget *widget,
739 gint gtk_widget_get_margin_bottom (GtkWidget *widget);
740 void gtk_widget_set_margin_bottom (GtkWidget *widget,
744 gint gtk_widget_get_events (GtkWidget *widget);
745 GdkEventMask gtk_widget_get_device_events (GtkWidget *widget,
747 GDK_DEPRECATED_IN_3_4_FOR(gdk_window_get_device_position)
748 void gtk_widget_get_pointer (GtkWidget *widget,
752 gboolean gtk_widget_is_ancestor (GtkWidget *widget,
753 GtkWidget *ancestor);
755 gboolean gtk_widget_translate_coordinates (GtkWidget *src_widget,
756 GtkWidget *dest_widget,
762 /* Hide widget and return TRUE.
764 gboolean gtk_widget_hide_on_delete (GtkWidget *widget);
766 /* Functions to override widget styling */
767 void gtk_widget_override_color (GtkWidget *widget,
769 const GdkRGBA *color);
770 void gtk_widget_override_background_color (GtkWidget *widget,
772 const GdkRGBA *color);
774 void gtk_widget_override_font (GtkWidget *widget,
775 const PangoFontDescription *font_desc);
777 void gtk_widget_override_symbolic_color (GtkWidget *widget,
779 const GdkRGBA *color);
780 void gtk_widget_override_cursor (GtkWidget *widget,
781 const GdkRGBA *cursor,
782 const GdkRGBA *secondary_cursor);
784 void gtk_widget_reset_style (GtkWidget *widget);
786 PangoContext *gtk_widget_create_pango_context (GtkWidget *widget);
787 PangoContext *gtk_widget_get_pango_context (GtkWidget *widget);
788 PangoLayout *gtk_widget_create_pango_layout (GtkWidget *widget,
791 GdkPixbuf *gtk_widget_render_icon_pixbuf (GtkWidget *widget,
792 const gchar *stock_id,
795 /* handle composite names for GTK_COMPOSITE_CHILD widgets,
796 * the returned name is newly allocated.
798 void gtk_widget_set_composite_name (GtkWidget *widget,
800 gchar* gtk_widget_get_composite_name (GtkWidget *widget);
802 /* Push/pop pairs, to change default values upon a widget's creation.
803 * This will override the values that got set by the
804 * gtk_widget_set_default_* () functions.
806 void gtk_widget_push_composite_child (void);
807 void gtk_widget_pop_composite_child (void);
809 /* widget style properties
811 void gtk_widget_class_install_style_property (GtkWidgetClass *klass,
813 void gtk_widget_class_install_style_property_parser (GtkWidgetClass *klass,
815 GtkRcPropertyParser parser);
816 GParamSpec* gtk_widget_class_find_style_property (GtkWidgetClass *klass,
817 const gchar *property_name);
818 GParamSpec** gtk_widget_class_list_style_properties (GtkWidgetClass *klass,
819 guint *n_properties);
820 void gtk_widget_style_get_property (GtkWidget *widget,
821 const gchar *property_name,
823 void gtk_widget_style_get_valist (GtkWidget *widget,
824 const gchar *first_property_name,
826 void gtk_widget_style_get (GtkWidget *widget,
827 const gchar *first_property_name,
828 ...) G_GNUC_NULL_TERMINATED;
830 /* Functions for setting directionality for widgets */
832 void gtk_widget_set_direction (GtkWidget *widget,
833 GtkTextDirection dir);
834 GtkTextDirection gtk_widget_get_direction (GtkWidget *widget);
836 void gtk_widget_set_default_direction (GtkTextDirection dir);
837 GtkTextDirection gtk_widget_get_default_direction (void);
839 /* Compositing manager functionality */
840 gboolean gtk_widget_is_composited (GtkWidget *widget);
842 /* Counterpart to gdk_window_shape_combine_region.
844 void gtk_widget_shape_combine_region (GtkWidget *widget,
845 cairo_region_t *region);
846 void gtk_widget_input_shape_combine_region (GtkWidget *widget,
847 cairo_region_t *region);
849 GList* gtk_widget_list_mnemonic_labels (GtkWidget *widget);
850 void gtk_widget_add_mnemonic_label (GtkWidget *widget,
852 void gtk_widget_remove_mnemonic_label (GtkWidget *widget,
855 void gtk_widget_set_tooltip_window (GtkWidget *widget,
856 GtkWindow *custom_window);
857 GtkWindow *gtk_widget_get_tooltip_window (GtkWidget *widget);
858 void gtk_widget_trigger_tooltip_query (GtkWidget *widget);
859 void gtk_widget_set_tooltip_text (GtkWidget *widget,
861 gchar * gtk_widget_get_tooltip_text (GtkWidget *widget);
862 void gtk_widget_set_tooltip_markup (GtkWidget *widget,
863 const gchar *markup);
864 gchar * gtk_widget_get_tooltip_markup (GtkWidget *widget);
865 void gtk_widget_set_has_tooltip (GtkWidget *widget,
866 gboolean has_tooltip);
867 gboolean gtk_widget_get_has_tooltip (GtkWidget *widget);
869 gboolean gtk_cairo_should_draw_window (cairo_t *cr,
871 void gtk_cairo_transform_to_window (cairo_t *cr,
875 GType gtk_requisition_get_type (void) G_GNUC_CONST;
876 GtkRequisition *gtk_requisition_new (void) G_GNUC_MALLOC;
877 GtkRequisition *gtk_requisition_copy (const GtkRequisition *requisition);
878 void gtk_requisition_free (GtkRequisition *requisition);
880 gboolean gtk_widget_in_destruction (GtkWidget *widget);
882 GtkStyleContext * gtk_widget_get_style_context (GtkWidget *widget);
884 GtkWidgetPath * gtk_widget_get_path (GtkWidget *widget);
887 GdkModifierType gtk_widget_get_modifier_mask (GtkWidget *widget,
888 GdkModifierIntent intent);
891 void gtk_widget_insert_action_group (GtkWidget *widget,
893 GActionGroup *group);
897 #endif /* __GTK_WIDGET_H__ */