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/gtkadjustment.h>
37 #include <gtk/gtkstyle.h>
38 #include <gtk/gtksettings.h>
39 #include <gtk/gtkstylecontext.h>
40 #include <gtk/gtkwidgetpath.h>
45 /* Kinds of widget-specific help */
48 GTK_WIDGET_HELP_TOOLTIP,
49 GTK_WIDGET_HELP_WHATS_THIS
52 /* Macro for casting a pointer to a GtkWidget or GtkWidgetClass pointer.
53 * Macros for testing whether `widget' or `klass' are of type GTK_TYPE_WIDGET.
55 #define GTK_TYPE_WIDGET (gtk_widget_get_type ())
56 #define GTK_WIDGET(widget) (G_TYPE_CHECK_INSTANCE_CAST ((widget), GTK_TYPE_WIDGET, GtkWidget))
57 #define GTK_WIDGET_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WIDGET, GtkWidgetClass))
58 #define GTK_IS_WIDGET(widget) (G_TYPE_CHECK_INSTANCE_TYPE ((widget), GTK_TYPE_WIDGET))
59 #define GTK_IS_WIDGET_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WIDGET))
60 #define GTK_WIDGET_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WIDGET, GtkWidgetClass))
62 #define GTK_TYPE_REQUISITION (gtk_requisition_get_type ())
64 /* forward declaration to avoid excessive includes (and concurrent includes)
66 typedef struct _GtkRequisition GtkRequisition;
67 typedef struct _GtkSelectionData GtkSelectionData;
68 typedef struct _GtkWidgetPrivate GtkWidgetPrivate;
69 typedef struct _GtkWidgetClass GtkWidgetClass;
70 typedef struct _GtkWidgetAuxInfo GtkWidgetAuxInfo;
71 typedef struct _GtkClipboard GtkClipboard;
72 typedef struct _GtkTooltip GtkTooltip;
73 typedef struct _GtkWindow GtkWindow;
78 * @x: the X position of the widget's area relative to its parents allocation.
79 * @y: the Y position of the widget's area relative to its parents allocation.
80 * @width: the width of the widget's allocated area.
81 * @height: the height of the widget's allocated area.
83 * A <structname>GtkAllocation</structname> of a widget represents region
84 * which has been allocated to the widget by its parent. It is a subregion
85 * of its parents allocation. See <xref linkend="geometry-management"/> for
88 typedef GdkRectangle GtkAllocation;
92 * @widget: the widget to operate on
93 * @data: user-supplied data
95 * The type of the callback functions used for e.g. iterating over
96 * the children of a container, see gtk_container_foreach().
98 typedef void (*GtkCallback) (GtkWidget *widget,
103 * @width: the widget's desired width
104 * @height: the widget's desired height
106 * A <structname>GtkRequisition</structname> represents the desired size of a widget. See
107 * <xref linkend="geometry-management"/> for more information.
109 struct _GtkRequisition
115 /* The widget is the base of the tree for displayable objects.
116 * (A displayable object is one which takes up some amount
117 * of screen real estate). It provides a common base and interface
118 * which actual widgets must adhere to.
122 GInitiallyUnowned parent_instance;
124 GtkWidgetPrivate *priv;
129 * @parent_class: The object class structure needs to be the first
130 * element in the widget class structure in order for the class mechanism
131 * to work correctly. This allows a GtkWidgetClass pointer to be cast to
132 * a GObjectClass pointer.
133 * @activate_signal: The signal to emit when a widget of this class is
134 * activated, gtk_widget_activate() handles the emission.
135 * Implementation of this signal is optional.
136 * @get_request_mode: This allows a widget to tell its parent container whether
137 * it prefers to be allocated in %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH or
138 * %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT mode.
139 * %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH means the widget prefers to have
140 * #GtkWidgetClass.get_preferred_width() called and then
141 * #GtkWidgetClass.get_preferred_height_for_width() and is the default
142 * return for unimplemented cases.
143 * However it's important to note (as described below) that any widget
144 * which trades height-for-width must respond properly to both
145 * #GtkSizeRequestModes since it might be queried in either orientation
146 * by its parent container.
147 * @get_preferred_height: This is called by containers to obtain the minimum
148 * and natural height of a widget. A widget that does not actually trade
149 * any height for width or width for height only has to implement these
150 * two virtual methods (#GtkWidgetClass.get_preferred_width() and
151 * #GtkWidgetClass.get_preferred_height()).
152 * @get_preferred_width_for_height: This is analogous to
153 * #GtkWidgetClass.get_preferred_height_for_width() except that it
154 * operates in the oposite orientation. It's rare that a widget actually
155 * does %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT requests but this can happen
156 * when, for example, a widget or container gets additional columns to
157 * compensate for a smaller allocated height.
158 * @get_preferred_width: This is called by containers to obtain the minimum
159 * and natural width of a widget. A widget will never be allocated a width
160 * less than its minimum and will only ever be allocated a width greater
161 * than the natural width once all of the said widget's siblings have
162 * received their natural widths.
163 * Furthermore, a widget will only ever be allocated a width greater than
164 * its natural width if it was configured to receive extra expand space
165 * from its parent container.
166 * @get_preferred_height_for_width: This is similar to
167 * #GtkWidgetClass.get_preferred_height() except that it is passed a
168 * contextual width to request height for. By implementing this virtual
169 * method it is possible for a #GtkLabel to tell its parent how much height
170 * would be required if the label were to be allocated a said width.
171 * @adjust_size_request: Convert an initial size request from a widget's
172 * #GtkSizeRequest virtual method implementations into a size request to
173 * be used by parent containers in laying out the widget.
174 * adjust_size_request adjusts <emphasis>from</emphasis> a child widget's
175 * original request <emphasis>to</emphasis> what a parent container should
176 * use for layout. The @for_size argument will be -1 if the request should
177 * not be for a particular size in the opposing orientation, i.e. if the
178 * request is not height-for-width or width-for-height. If @for_size is
179 * greater than -1, it is the proposed allocation in the opposing
180 * orientation that we need the request for. Implementations of
181 * adjust_size_request should chain up to the default implementation,
182 * which applies #GtkWidget's margin properties and imposes any values
183 * from gtk_widget_set_size_request(). Chaining up should be last,
184 * <emphasis>after</emphasis> your subclass adjusts the request, so
185 * #GtkWidget can apply constraints and add the margin properly.
186 * @adjust_size_allocation: Convert an initial size allocation assigned
187 * by a #GtkContainer using gtk_widget_size_allocate(), into an actual
188 * size allocation to be used by the widget. adjust_size_allocation
189 * adjusts <emphasis>to</emphasis> a child widget's actual allocation
190 * <emphasis>from</emphasis> what a parent container computed for the
191 * child. The adjusted allocation must be entirely within the original
192 * allocation. In any custom implementation, chain up to the default
193 * #GtkWidget implementation of this method, which applies the margin
194 * and alignment properties of #GtkWidget. Chain up
195 * <emphasis>before</emphasis> performing your own adjustments so your
196 * own adjustments remove more allocation after the #GtkWidget base
197 * class has already removed margin and alignment. The natural size
198 * passed in should be adjusted in the same way as the allocated size,
199 * which allows adjustments to perform alignments or other changes
200 * based on natural size.
202 struct _GtkWidgetClass
204 GInitiallyUnownedClass parent_class;
208 guint activate_signal;
210 /* seldomly overidden */
211 void (*dispatch_child_properties_changed) (GtkWidget *widget,
213 GParamSpec **pspecs);
216 void (* destroy) (GtkWidget *widget);
217 void (* show) (GtkWidget *widget);
218 void (* show_all) (GtkWidget *widget);
219 void (* hide) (GtkWidget *widget);
220 void (* map) (GtkWidget *widget);
221 void (* unmap) (GtkWidget *widget);
222 void (* realize) (GtkWidget *widget);
223 void (* unrealize) (GtkWidget *widget);
224 void (* size_allocate) (GtkWidget *widget,
225 GtkAllocation *allocation);
226 void (* state_changed) (GtkWidget *widget,
227 GtkStateType previous_state);
228 void (* parent_set) (GtkWidget *widget,
229 GtkWidget *previous_parent);
230 void (* hierarchy_changed) (GtkWidget *widget,
231 GtkWidget *previous_toplevel);
232 void (* style_set) (GtkWidget *widget,
233 GtkStyle *previous_style);
234 void (* direction_changed) (GtkWidget *widget,
235 GtkTextDirection previous_direction);
236 void (* grab_notify) (GtkWidget *widget,
237 gboolean was_grabbed);
238 void (* child_notify) (GtkWidget *widget,
240 gboolean (* draw) (GtkWidget *widget,
244 GtkSizeRequestMode (* get_request_mode) (GtkWidget *widget);
246 void (* get_preferred_height) (GtkWidget *widget,
247 gint *minimum_height,
248 gint *natural_height);
249 void (* get_preferred_width_for_height) (GtkWidget *widget,
252 gint *natural_width);
253 void (* get_preferred_width) (GtkWidget *widget,
255 gint *natural_width);
256 void (* get_preferred_height_for_width) (GtkWidget *widget,
258 gint *minimum_height,
259 gint *natural_height);
262 gboolean (* mnemonic_activate) (GtkWidget *widget,
263 gboolean group_cycling);
266 void (* grab_focus) (GtkWidget *widget);
267 gboolean (* focus) (GtkWidget *widget,
268 GtkDirectionType direction);
270 /* keyboard navigation */
271 void (* move_focus) (GtkWidget *widget,
272 GtkDirectionType direction);
273 gboolean (* keynav_failed) (GtkWidget *widget,
274 GtkDirectionType direction);
277 gboolean (* event) (GtkWidget *widget,
279 gboolean (* button_press_event) (GtkWidget *widget,
280 GdkEventButton *event);
281 gboolean (* button_release_event) (GtkWidget *widget,
282 GdkEventButton *event);
283 gboolean (* scroll_event) (GtkWidget *widget,
284 GdkEventScroll *event);
285 gboolean (* motion_notify_event) (GtkWidget *widget,
286 GdkEventMotion *event);
287 gboolean (* delete_event) (GtkWidget *widget,
289 gboolean (* destroy_event) (GtkWidget *widget,
291 gboolean (* key_press_event) (GtkWidget *widget,
293 gboolean (* key_release_event) (GtkWidget *widget,
295 gboolean (* enter_notify_event) (GtkWidget *widget,
296 GdkEventCrossing *event);
297 gboolean (* leave_notify_event) (GtkWidget *widget,
298 GdkEventCrossing *event);
299 gboolean (* configure_event) (GtkWidget *widget,
300 GdkEventConfigure *event);
301 gboolean (* focus_in_event) (GtkWidget *widget,
302 GdkEventFocus *event);
303 gboolean (* focus_out_event) (GtkWidget *widget,
304 GdkEventFocus *event);
305 gboolean (* map_event) (GtkWidget *widget,
307 gboolean (* unmap_event) (GtkWidget *widget,
309 gboolean (* property_notify_event) (GtkWidget *widget,
310 GdkEventProperty *event);
311 gboolean (* selection_clear_event) (GtkWidget *widget,
312 GdkEventSelection *event);
313 gboolean (* selection_request_event) (GtkWidget *widget,
314 GdkEventSelection *event);
315 gboolean (* selection_notify_event) (GtkWidget *widget,
316 GdkEventSelection *event);
317 gboolean (* proximity_in_event) (GtkWidget *widget,
318 GdkEventProximity *event);
319 gboolean (* proximity_out_event) (GtkWidget *widget,
320 GdkEventProximity *event);
321 gboolean (* visibility_notify_event) (GtkWidget *widget,
322 GdkEventVisibility *event);
323 gboolean (* client_event) (GtkWidget *widget,
324 GdkEventClient *event);
325 gboolean (* window_state_event) (GtkWidget *widget,
326 GdkEventWindowState *event);
327 gboolean (* damage_event) (GtkWidget *widget,
328 GdkEventExpose *event);
329 gboolean (* grab_broken_event) (GtkWidget *widget,
330 GdkEventGrabBroken *event);
333 void (* selection_get) (GtkWidget *widget,
334 GtkSelectionData *selection_data,
337 void (* selection_received) (GtkWidget *widget,
338 GtkSelectionData *selection_data,
341 /* Source side drag signals */
342 void (* drag_begin) (GtkWidget *widget,
343 GdkDragContext *context);
344 void (* drag_end) (GtkWidget *widget,
345 GdkDragContext *context);
346 void (* drag_data_get) (GtkWidget *widget,
347 GdkDragContext *context,
348 GtkSelectionData *selection_data,
351 void (* drag_data_delete) (GtkWidget *widget,
352 GdkDragContext *context);
354 /* Target side drag signals */
355 void (* drag_leave) (GtkWidget *widget,
356 GdkDragContext *context,
358 gboolean (* drag_motion) (GtkWidget *widget,
359 GdkDragContext *context,
363 gboolean (* drag_drop) (GtkWidget *widget,
364 GdkDragContext *context,
368 void (* drag_data_received) (GtkWidget *widget,
369 GdkDragContext *context,
372 GtkSelectionData *selection_data,
376 /* Signals used only for keybindings */
377 gboolean (* popup_menu) (GtkWidget *widget);
379 /* If a widget has multiple tooltips/whatsthis, it should show the
380 * one for the current focus location, or if that doesn't make
381 * sense, should cycle through them showing each tip alongside
382 * whatever piece of the widget it applies to.
384 gboolean (* show_help) (GtkWidget *widget,
385 GtkWidgetHelpType help_type);
387 /* accessibility support
389 AtkObject * (* get_accessible) (GtkWidget *widget);
391 void (* screen_changed) (GtkWidget *widget,
392 GdkScreen *previous_screen);
393 gboolean (* can_activate_accel) (GtkWidget *widget,
397 void (* composited_changed) (GtkWidget *widget);
399 gboolean (* query_tooltip) (GtkWidget *widget,
402 gboolean keyboard_tooltip,
403 GtkTooltip *tooltip);
405 void (* compute_expand) (GtkWidget *widget,
407 gboolean *vexpand_p);
409 void (* adjust_size_request) (GtkWidget *widget,
410 GtkOrientation orientation,
413 void (* adjust_size_allocation) (GtkWidget *widget,
414 GtkOrientation orientation,
417 gint *allocated_size);
419 void (* style_updated) (GtkWidget *widget);
423 /* Padding for future expansion */
424 void (*_gtk_reserved1) (void);
425 void (*_gtk_reserved2) (void);
426 void (*_gtk_reserved3) (void);
427 void (*_gtk_reserved4) (void);
428 void (*_gtk_reserved5) (void);
429 void (*_gtk_reserved6) (void);
430 void (*_gtk_reserved7) (void);
431 void (*_gtk_reserved8) (void);
434 struct _GtkWidgetAuxInfo
445 GType gtk_widget_get_type (void) G_GNUC_CONST;
446 GtkWidget* gtk_widget_new (GType type,
447 const gchar *first_property_name,
449 void gtk_widget_destroy (GtkWidget *widget);
450 void gtk_widget_destroyed (GtkWidget *widget,
451 GtkWidget **widget_pointer);
452 void gtk_widget_unparent (GtkWidget *widget);
453 void gtk_widget_show (GtkWidget *widget);
454 void gtk_widget_hide (GtkWidget *widget);
455 void gtk_widget_show_now (GtkWidget *widget);
456 void gtk_widget_show_all (GtkWidget *widget);
457 void gtk_widget_set_no_show_all (GtkWidget *widget,
458 gboolean no_show_all);
459 gboolean gtk_widget_get_no_show_all (GtkWidget *widget);
460 void gtk_widget_map (GtkWidget *widget);
461 void gtk_widget_unmap (GtkWidget *widget);
462 void gtk_widget_realize (GtkWidget *widget);
463 void gtk_widget_unrealize (GtkWidget *widget);
465 void gtk_widget_draw (GtkWidget *widget,
468 void gtk_widget_queue_draw (GtkWidget *widget);
469 void gtk_widget_queue_draw_area (GtkWidget *widget,
474 void gtk_widget_queue_draw_region (GtkWidget *widget,
475 cairo_region_t *region);
476 void gtk_widget_queue_resize (GtkWidget *widget);
477 void gtk_widget_queue_resize_no_redraw (GtkWidget *widget);
478 #ifndef GTK_DISABLE_DEPRECATED
479 void gtk_widget_size_request (GtkWidget *widget,
480 GtkRequisition *requisition);
482 void gtk_widget_size_allocate (GtkWidget *widget,
483 GtkAllocation *allocation);
485 GtkSizeRequestMode gtk_widget_get_request_mode (GtkWidget *widget);
486 void gtk_widget_get_preferred_width (GtkWidget *widget,
488 gint *natural_width);
489 void gtk_widget_get_preferred_height_for_width (GtkWidget *widget,
491 gint *minimum_height,
492 gint *natural_height);
493 void gtk_widget_get_preferred_height (GtkWidget *widget,
494 gint *minimum_height,
495 gint *natural_height);
496 void gtk_widget_get_preferred_width_for_height (GtkWidget *widget,
499 gint *natural_width);
500 void gtk_widget_get_preferred_size (GtkWidget *widget,
501 GtkRequisition *minimum_size,
502 GtkRequisition *natural_size);
504 #ifndef GTK_DISABLE_DEPRECATED
505 void gtk_widget_get_child_requisition (GtkWidget *widget,
506 GtkRequisition *requisition);
508 void gtk_widget_add_accelerator (GtkWidget *widget,
509 const gchar *accel_signal,
510 GtkAccelGroup *accel_group,
512 GdkModifierType accel_mods,
513 GtkAccelFlags accel_flags);
514 gboolean gtk_widget_remove_accelerator (GtkWidget *widget,
515 GtkAccelGroup *accel_group,
517 GdkModifierType accel_mods);
518 void gtk_widget_set_accel_path (GtkWidget *widget,
519 const gchar *accel_path,
520 GtkAccelGroup *accel_group);
521 const gchar* _gtk_widget_get_accel_path (GtkWidget *widget,
523 GList* gtk_widget_list_accel_closures (GtkWidget *widget);
524 gboolean gtk_widget_can_activate_accel (GtkWidget *widget,
526 gboolean gtk_widget_mnemonic_activate (GtkWidget *widget,
527 gboolean group_cycling);
528 gboolean gtk_widget_event (GtkWidget *widget,
530 gint gtk_widget_send_expose (GtkWidget *widget,
532 gboolean gtk_widget_send_focus_change (GtkWidget *widget,
535 gboolean gtk_widget_activate (GtkWidget *widget);
537 void gtk_widget_reparent (GtkWidget *widget,
538 GtkWidget *new_parent);
539 gboolean gtk_widget_intersect (GtkWidget *widget,
540 const GdkRectangle *area,
541 GdkRectangle *intersection);
542 cairo_region_t *gtk_widget_region_intersect (GtkWidget *widget,
543 const cairo_region_t *region);
545 void gtk_widget_freeze_child_notify (GtkWidget *widget);
546 void gtk_widget_child_notify (GtkWidget *widget,
547 const gchar *child_property);
548 void gtk_widget_thaw_child_notify (GtkWidget *widget);
550 void gtk_widget_set_can_focus (GtkWidget *widget,
552 gboolean gtk_widget_get_can_focus (GtkWidget *widget);
553 gboolean gtk_widget_has_focus (GtkWidget *widget);
554 gboolean gtk_widget_is_focus (GtkWidget *widget);
555 void gtk_widget_grab_focus (GtkWidget *widget);
557 void gtk_widget_set_can_default (GtkWidget *widget,
558 gboolean can_default);
559 gboolean gtk_widget_get_can_default (GtkWidget *widget);
560 gboolean gtk_widget_has_default (GtkWidget *widget);
561 void gtk_widget_grab_default (GtkWidget *widget);
563 void gtk_widget_set_receives_default (GtkWidget *widget,
564 gboolean receives_default);
565 gboolean gtk_widget_get_receives_default (GtkWidget *widget);
567 gboolean gtk_widget_has_grab (GtkWidget *widget);
569 gboolean gtk_widget_device_is_shadowed (GtkWidget *widget,
573 void gtk_widget_set_name (GtkWidget *widget,
575 G_CONST_RETURN gchar* gtk_widget_get_name (GtkWidget *widget);
577 void gtk_widget_set_state (GtkWidget *widget,
579 GtkStateType gtk_widget_get_state (GtkWidget *widget);
581 void gtk_widget_set_sensitive (GtkWidget *widget,
583 gboolean gtk_widget_get_sensitive (GtkWidget *widget);
584 gboolean gtk_widget_is_sensitive (GtkWidget *widget);
586 void gtk_widget_set_visible (GtkWidget *widget,
588 gboolean gtk_widget_get_visible (GtkWidget *widget);
590 void gtk_widget_set_has_window (GtkWidget *widget,
591 gboolean has_window);
592 gboolean gtk_widget_get_has_window (GtkWidget *widget);
594 gboolean gtk_widget_is_toplevel (GtkWidget *widget);
595 gboolean gtk_widget_is_drawable (GtkWidget *widget);
596 void gtk_widget_set_realized (GtkWidget *widget,
598 gboolean gtk_widget_get_realized (GtkWidget *widget);
599 void gtk_widget_set_mapped (GtkWidget *widget,
601 gboolean gtk_widget_get_mapped (GtkWidget *widget);
603 void gtk_widget_set_app_paintable (GtkWidget *widget,
604 gboolean app_paintable);
605 gboolean gtk_widget_get_app_paintable (GtkWidget *widget);
607 void gtk_widget_set_double_buffered (GtkWidget *widget,
608 gboolean double_buffered);
609 gboolean gtk_widget_get_double_buffered (GtkWidget *widget);
611 void gtk_widget_set_redraw_on_allocate (GtkWidget *widget,
612 gboolean redraw_on_allocate);
614 void gtk_widget_set_parent (GtkWidget *widget,
616 GtkWidget * gtk_widget_get_parent (GtkWidget *widget);
618 void gtk_widget_set_parent_window (GtkWidget *widget,
619 GdkWindow *parent_window);
620 GdkWindow * gtk_widget_get_parent_window (GtkWidget *widget);
622 void gtk_widget_set_child_visible (GtkWidget *widget,
623 gboolean is_visible);
624 gboolean gtk_widget_get_child_visible (GtkWidget *widget);
626 void gtk_widget_set_window (GtkWidget *widget,
628 GdkWindow * gtk_widget_get_window (GtkWidget *widget);
630 int gtk_widget_get_allocated_width (GtkWidget *widget);
631 int gtk_widget_get_allocated_height (GtkWidget *widget);
633 void gtk_widget_get_allocation (GtkWidget *widget,
634 GtkAllocation *allocation);
635 void gtk_widget_set_allocation (GtkWidget *widget,
636 const GtkAllocation *allocation);
638 void gtk_widget_get_requisition (GtkWidget *widget,
639 GtkRequisition *requisition);
641 gboolean gtk_widget_child_focus (GtkWidget *widget,
642 GtkDirectionType direction);
643 gboolean gtk_widget_keynav_failed (GtkWidget *widget,
644 GtkDirectionType direction);
645 void gtk_widget_error_bell (GtkWidget *widget);
647 void gtk_widget_set_size_request (GtkWidget *widget,
650 void gtk_widget_get_size_request (GtkWidget *widget,
653 void gtk_widget_set_events (GtkWidget *widget,
655 void gtk_widget_add_events (GtkWidget *widget,
657 void gtk_widget_set_device_events (GtkWidget *widget,
659 GdkEventMask events);
660 void gtk_widget_add_device_events (GtkWidget *widget,
662 GdkEventMask events);
663 void gtk_widget_set_extension_events (GtkWidget *widget,
664 GdkExtensionMode mode);
666 GdkExtensionMode gtk_widget_get_extension_events (GtkWidget *widget);
667 GtkWidget* gtk_widget_get_toplevel (GtkWidget *widget);
668 GtkWidget* gtk_widget_get_ancestor (GtkWidget *widget,
670 GdkVisual* gtk_widget_get_visual (GtkWidget *widget);
671 void gtk_widget_set_visual (GtkWidget *widget,
674 GdkScreen * gtk_widget_get_screen (GtkWidget *widget);
675 gboolean gtk_widget_has_screen (GtkWidget *widget);
676 GdkDisplay * gtk_widget_get_display (GtkWidget *widget);
677 GdkWindow * gtk_widget_get_root_window (GtkWidget *widget);
678 GtkSettings* gtk_widget_get_settings (GtkWidget *widget);
679 GtkClipboard *gtk_widget_get_clipboard (GtkWidget *widget,
683 /* Expand flags and related support */
684 gboolean gtk_widget_get_hexpand (GtkWidget *widget);
685 void gtk_widget_set_hexpand (GtkWidget *widget,
687 gboolean gtk_widget_get_hexpand_set (GtkWidget *widget);
688 void gtk_widget_set_hexpand_set (GtkWidget *widget,
690 gboolean gtk_widget_get_vexpand (GtkWidget *widget);
691 void gtk_widget_set_vexpand (GtkWidget *widget,
693 gboolean gtk_widget_get_vexpand_set (GtkWidget *widget);
694 void gtk_widget_set_vexpand_set (GtkWidget *widget,
696 void gtk_widget_queue_compute_expand (GtkWidget *widget);
697 gboolean gtk_widget_compute_expand (GtkWidget *widget,
698 GtkOrientation orientation);
701 /* Multidevice support */
702 gboolean gtk_widget_get_support_multidevice (GtkWidget *widget);
703 void gtk_widget_set_support_multidevice (GtkWidget *widget,
704 gboolean support_multidevice);
706 /* Accessibility support */
707 AtkObject* gtk_widget_get_accessible (GtkWidget *widget);
710 /* Margin and alignment */
711 GtkAlign gtk_widget_get_halign (GtkWidget *widget);
712 void gtk_widget_set_halign (GtkWidget *widget,
714 GtkAlign gtk_widget_get_valign (GtkWidget *widget);
715 void gtk_widget_set_valign (GtkWidget *widget,
717 gint gtk_widget_get_margin_left (GtkWidget *widget);
718 void gtk_widget_set_margin_left (GtkWidget *widget,
720 gint gtk_widget_get_margin_right (GtkWidget *widget);
721 void gtk_widget_set_margin_right (GtkWidget *widget,
723 gint gtk_widget_get_margin_top (GtkWidget *widget);
724 void gtk_widget_set_margin_top (GtkWidget *widget,
726 gint gtk_widget_get_margin_bottom (GtkWidget *widget);
727 void gtk_widget_set_margin_bottom (GtkWidget *widget,
731 gint gtk_widget_get_events (GtkWidget *widget);
732 GdkEventMask gtk_widget_get_device_events (GtkWidget *widget,
734 void gtk_widget_get_pointer (GtkWidget *widget,
738 gboolean gtk_widget_is_ancestor (GtkWidget *widget,
739 GtkWidget *ancestor);
741 gboolean gtk_widget_translate_coordinates (GtkWidget *src_widget,
742 GtkWidget *dest_widget,
748 /* Hide widget and return TRUE.
750 gboolean gtk_widget_hide_on_delete (GtkWidget *widget);
754 void gtk_widget_style_attach (GtkWidget *widget);
756 gboolean gtk_widget_has_rc_style (GtkWidget *widget);
757 void gtk_widget_set_style (GtkWidget *widget,
759 void gtk_widget_ensure_style (GtkWidget *widget);
760 GtkStyle * gtk_widget_get_style (GtkWidget *widget);
762 void gtk_widget_modify_style (GtkWidget *widget,
764 GtkRcStyle *gtk_widget_get_modifier_style (GtkWidget *widget);
765 void gtk_widget_modify_fg (GtkWidget *widget,
767 const GdkColor *color);
768 void gtk_widget_modify_bg (GtkWidget *widget,
770 const GdkColor *color);
771 void gtk_widget_modify_text (GtkWidget *widget,
773 const GdkColor *color);
774 void gtk_widget_modify_base (GtkWidget *widget,
776 const GdkColor *color);
777 void gtk_widget_modify_cursor (GtkWidget *widget,
778 const GdkColor *primary,
779 const GdkColor *secondary);
780 void gtk_widget_modify_font (GtkWidget *widget,
781 PangoFontDescription *font_desc);
782 void gtk_widget_modify_symbolic_color (GtkWidget *widget,
784 const GdkColor *color);
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 (GtkWidget *widget,
792 const gchar *stock_id,
794 const gchar *detail);
796 /* handle composite names for GTK_COMPOSITE_CHILD widgets,
797 * the returned name is newly allocated.
799 void gtk_widget_set_composite_name (GtkWidget *widget,
801 gchar* gtk_widget_get_composite_name (GtkWidget *widget);
803 /* Descend recursively and set rc-style on all widgets without user styles */
804 void gtk_widget_reset_rc_styles (GtkWidget *widget);
806 /* Push/pop pairs, to change default values upon a widget's creation.
807 * This will override the values that got set by the
808 * gtk_widget_set_default_* () functions.
810 void gtk_widget_push_composite_child (void);
811 void gtk_widget_pop_composite_child (void);
813 /* widget style properties
815 void gtk_widget_class_install_style_property (GtkWidgetClass *klass,
817 void gtk_widget_class_install_style_property_parser (GtkWidgetClass *klass,
819 GtkRcPropertyParser parser);
820 GParamSpec* gtk_widget_class_find_style_property (GtkWidgetClass *klass,
821 const gchar *property_name);
822 GParamSpec** gtk_widget_class_list_style_properties (GtkWidgetClass *klass,
823 guint *n_properties);
824 void gtk_widget_style_get_property (GtkWidget *widget,
825 const gchar *property_name,
827 void gtk_widget_style_get_valist (GtkWidget *widget,
828 const gchar *first_property_name,
830 void gtk_widget_style_get (GtkWidget *widget,
831 const gchar *first_property_name,
832 ...) G_GNUC_NULL_TERMINATED;
835 /* Set certain default values to be used at widget creation time.
837 GtkStyle* gtk_widget_get_default_style (void);
839 /* Functions for setting directionality for widgets
842 void gtk_widget_set_direction (GtkWidget *widget,
843 GtkTextDirection dir);
844 GtkTextDirection gtk_widget_get_direction (GtkWidget *widget);
846 void gtk_widget_set_default_direction (GtkTextDirection dir);
847 GtkTextDirection gtk_widget_get_default_direction (void);
849 /* Compositing manager functionality */
850 gboolean gtk_widget_is_composited (GtkWidget *widget);
852 /* Counterpart to gdk_window_shape_combine_region.
854 void gtk_widget_shape_combine_region (GtkWidget *widget,
855 cairo_region_t *region);
856 void gtk_widget_input_shape_combine_region (GtkWidget *widget,
857 cairo_region_t *region);
859 /* internal function */
860 void gtk_widget_reset_shapes (GtkWidget *widget);
862 /* Compute a widget's path in the form "GtkWindow.MyLabel", and
863 * return newly alocated strings.
865 void gtk_widget_path (GtkWidget *widget,
868 gchar **path_reversed);
869 void gtk_widget_class_path (GtkWidget *widget,
872 gchar **path_reversed);
874 GList* gtk_widget_list_mnemonic_labels (GtkWidget *widget);
875 void gtk_widget_add_mnemonic_label (GtkWidget *widget,
877 void gtk_widget_remove_mnemonic_label (GtkWidget *widget,
880 void gtk_widget_set_tooltip_window (GtkWidget *widget,
881 GtkWindow *custom_window);
882 GtkWindow *gtk_widget_get_tooltip_window (GtkWidget *widget);
883 void gtk_widget_trigger_tooltip_query (GtkWidget *widget);
884 void gtk_widget_set_tooltip_text (GtkWidget *widget,
886 gchar * gtk_widget_get_tooltip_text (GtkWidget *widget);
887 void gtk_widget_set_tooltip_markup (GtkWidget *widget,
888 const gchar *markup);
889 gchar * gtk_widget_get_tooltip_markup (GtkWidget *widget);
890 void gtk_widget_set_has_tooltip (GtkWidget *widget,
891 gboolean has_tooltip);
892 gboolean gtk_widget_get_has_tooltip (GtkWidget *widget);
894 gboolean gtk_cairo_should_draw_window (cairo_t *cr,
896 void gtk_cairo_transform_to_window (cairo_t *cr,
900 GType gtk_requisition_get_type (void) G_GNUC_CONST;
901 GtkRequisition *gtk_requisition_new (void) G_GNUC_MALLOC;
902 GtkRequisition *gtk_requisition_copy (const GtkRequisition *requisition);
903 void gtk_requisition_free (GtkRequisition *requisition);
905 GdkEventExpose * _gtk_cairo_get_event (cairo_t *cr);
907 void _gtk_widget_draw_internal (GtkWidget *widget,
909 gboolean clip_to_size);
910 void _gtk_widget_set_has_default (GtkWidget *widget,
911 gboolean has_default);
912 void _gtk_widget_set_has_grab (GtkWidget *widget,
914 void _gtk_widget_set_is_toplevel (GtkWidget *widget,
915 gboolean is_toplevel);
917 void _gtk_widget_grab_notify (GtkWidget *widget,
918 gboolean was_grabbed);
920 GtkWidgetAuxInfo *_gtk_widget_get_aux_info (GtkWidget *widget,
922 void _gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
923 GtkWidget *previous_toplevel);
924 void _gtk_widget_propagate_screen_changed (GtkWidget *widget,
925 GdkScreen *previous_screen);
926 void _gtk_widget_propagate_composited_changed (GtkWidget *widget);
928 void _gtk_widget_set_device_window (GtkWidget *widget,
930 GdkWindow *pointer_window);
931 GdkWindow *_gtk_widget_get_device_window (GtkWidget *widget,
933 GList * _gtk_widget_list_devices (GtkWidget *widget);
935 void _gtk_widget_synthesize_crossing (GtkWidget *from,
938 GdkCrossingMode mode);
940 gpointer _gtk_widget_peek_request_cache (GtkWidget *widget);
942 void _gtk_widget_buildable_finish_accelerator (GtkWidget *widget,
946 gboolean gtk_widget_in_destruction (GtkWidget *widget);
948 GtkStyleContext * gtk_widget_get_style_context (GtkWidget *widget);
950 GtkWidgetPath * gtk_widget_get_path (GtkWidget *widget);
955 #endif /* __GTK_WIDGET_H__ */