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/gtkborder.h>
39 #include <gtk/gtksettings.h>
40 #include <gtk/gtkstylecontext.h>
41 #include <gtk/gtkwidgetpath.h>
46 /* Kinds of widget-specific help */
49 GTK_WIDGET_HELP_TOOLTIP,
50 GTK_WIDGET_HELP_WHATS_THIS
53 /* Macro for casting a pointer to a GtkWidget or GtkWidgetClass pointer.
54 * Macros for testing whether `widget' or `klass' are of type GTK_TYPE_WIDGET.
56 #define GTK_TYPE_WIDGET (gtk_widget_get_type ())
57 #define GTK_WIDGET(widget) (G_TYPE_CHECK_INSTANCE_CAST ((widget), GTK_TYPE_WIDGET, GtkWidget))
58 #define GTK_WIDGET_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WIDGET, GtkWidgetClass))
59 #define GTK_IS_WIDGET(widget) (G_TYPE_CHECK_INSTANCE_TYPE ((widget), GTK_TYPE_WIDGET))
60 #define GTK_IS_WIDGET_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WIDGET))
61 #define GTK_WIDGET_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WIDGET, GtkWidgetClass))
63 #define GTK_TYPE_REQUISITION (gtk_requisition_get_type ())
65 /* forward declaration to avoid excessive includes (and concurrent includes)
67 typedef struct _GtkRequisition GtkRequisition;
68 typedef struct _GtkSelectionData GtkSelectionData;
69 typedef struct _GtkWidgetPrivate GtkWidgetPrivate;
70 typedef struct _GtkWidgetClass GtkWidgetClass;
71 typedef struct _GtkWidgetAuxInfo GtkWidgetAuxInfo;
72 typedef struct _GtkClipboard GtkClipboard;
73 typedef struct _GtkTooltip GtkTooltip;
74 typedef struct _GtkWindow GtkWindow;
79 * @x: the X position of the widget's area relative to its parents allocation.
80 * @y: the Y position of the widget's area relative to its parents allocation.
81 * @width: the width of the widget's allocated area.
82 * @height: the height of the widget's allocated area.
84 * A <structname>GtkAllocation</structname> of a widget represents region
85 * which has been allocated to the widget by its parent. It is a subregion
86 * of its parents allocation. See <xref linkend="geometry-management"/> for
89 typedef GdkRectangle GtkAllocation;
93 * @widget: the widget to operate on
94 * @data: user-supplied data
96 * The type of the callback functions used for e.g. iterating over
97 * the children of a container, see gtk_container_foreach().
99 typedef void (*GtkCallback) (GtkWidget *widget,
104 * @width: the widget's desired width
105 * @height: the widget's desired height
107 * A <structname>GtkRequisition</structname> represents the desired size of a widget. See
108 * <xref linkend="geometry-management"/> for more information.
110 struct _GtkRequisition
116 /* The widget is the base of the tree for displayable objects.
117 * (A displayable object is one which takes up some amount
118 * of screen real estate). It provides a common base and interface
119 * which actual widgets must adhere to.
123 GInitiallyUnowned parent_instance;
125 GtkWidgetPrivate *priv;
130 * @parent_class: The object class structure needs to be the first
131 * element in the widget class structure in order for the class mechanism
132 * to work correctly. This allows a GtkWidgetClass pointer to be cast to
133 * a GObjectClass pointer.
134 * @activate_signal: The signal to emit when a widget of this class is
135 * activated, gtk_widget_activate() handles the emission.
136 * Implementation of this signal is optional.
137 * @get_request_mode: This allows a widget to tell its parent container whether
138 * it prefers to be allocated in %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH or
139 * %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT mode.
140 * %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH means the widget prefers to have
141 * #GtkWidgetClass.get_preferred_width() called and then
142 * #GtkWidgetClass.get_preferred_height_for_width() and is the default
143 * return for unimplemented cases.
144 * However it's important to note (as described below) that any widget
145 * which trades height-for-width must respond properly to both
146 * #GtkSizeRequestModes since it might be queried in either orientation
147 * by its parent container.
148 * @get_preferred_height: This is called by containers to obtain the minimum
149 * and natural height of a widget. A widget that does not actually trade
150 * any height for width or width for height only has to implement these
151 * two virtual methods (#GtkWidgetClass.get_preferred_width() and
152 * #GtkWidgetClass.get_preferred_height()).
153 * @get_preferred_width_for_height: This is analogous to
154 * #GtkWidgetClass.get_preferred_height_for_width() except that it
155 * operates in the oposite orientation. It's rare that a widget actually
156 * does %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT requests but this can happen
157 * when, for example, a widget or container gets additional columns to
158 * compensate for a smaller allocated height.
159 * @get_preferred_width: This is called by containers to obtain the minimum
160 * and natural width of a widget. A widget will never be allocated a width
161 * less than its minimum and will only ever be allocated a width greater
162 * than the natural width once all of the said widget's siblings have
163 * received their natural widths.
164 * Furthermore, a widget will only ever be allocated a width greater than
165 * its natural width if it was configured to receive extra expand space
166 * from its parent container.
167 * @get_preferred_height_for_width: This is similar to
168 * #GtkWidgetClass.get_preferred_height() except that it is passed a
169 * contextual width to request height for. By implementing this virtual
170 * method it is possible for a #GtkLabel to tell its parent how much height
171 * would be required if the label were to be allocated a said width.
172 * @adjust_size_request: Convert an initial size request from a widget's
173 * #GtkSizeRequest virtual method implementations into a size request to
174 * be used by parent containers in laying out the widget.
175 * adjust_size_request adjusts <emphasis>from</emphasis> a child widget's
176 * original request <emphasis>to</emphasis> what a parent container should
177 * use for layout. The @for_size argument will be -1 if the request should
178 * not be for a particular size in the opposing orientation, i.e. if the
179 * request is not height-for-width or width-for-height. If @for_size is
180 * greater than -1, it is the proposed allocation in the opposing
181 * orientation that we need the request for. Implementations of
182 * adjust_size_request should chain up to the default implementation,
183 * which applies #GtkWidget's margin properties and imposes any values
184 * from gtk_widget_set_size_request(). Chaining up should be last,
185 * <emphasis>after</emphasis> your subclass adjusts the request, so
186 * #GtkWidget can apply constraints and add the margin properly.
187 * @adjust_size_allocation: Convert an initial size allocation assigned
188 * by a #GtkContainer using gtk_widget_size_allocate(), into an actual
189 * size allocation to be used by the widget. adjust_size_allocation
190 * adjusts <emphasis>to</emphasis> a child widget's actual allocation
191 * <emphasis>from</emphasis> what a parent container computed for the
192 * child. The adjusted allocation must be entirely within the original
193 * allocation. In any custom implementation, chain up to the default
194 * #GtkWidget implementation of this method, which applies the margin
195 * and alignment properties of #GtkWidget. Chain up
196 * <emphasis>before</emphasis> performing your own adjustments so your
197 * own adjustments remove more allocation after the #GtkWidget base
198 * class has already removed margin and alignment. The natural size
199 * passed in should be adjusted in the same way as the allocated size,
200 * which allows adjustments to perform alignments or other changes
201 * based on natural size.
203 struct _GtkWidgetClass
205 GInitiallyUnownedClass parent_class;
209 guint activate_signal;
211 /* seldomly overidden */
212 void (*dispatch_child_properties_changed) (GtkWidget *widget,
214 GParamSpec **pspecs);
217 void (* destroy) (GtkWidget *widget);
218 void (* show) (GtkWidget *widget);
219 void (* show_all) (GtkWidget *widget);
220 void (* hide) (GtkWidget *widget);
221 void (* map) (GtkWidget *widget);
222 void (* unmap) (GtkWidget *widget);
223 void (* realize) (GtkWidget *widget);
224 void (* unrealize) (GtkWidget *widget);
225 void (* size_allocate) (GtkWidget *widget,
226 GtkAllocation *allocation);
227 void (* state_changed) (GtkWidget *widget,
228 GtkStateType previous_state);
229 void (* state_flags_changed) (GtkWidget *widget,
230 GtkStateFlags previous_state_flags);
231 void (* parent_set) (GtkWidget *widget,
232 GtkWidget *previous_parent);
233 void (* hierarchy_changed) (GtkWidget *widget,
234 GtkWidget *previous_toplevel);
235 void (* style_set) (GtkWidget *widget,
236 GtkStyle *previous_style);
237 void (* direction_changed) (GtkWidget *widget,
238 GtkTextDirection previous_direction);
239 void (* grab_notify) (GtkWidget *widget,
240 gboolean was_grabbed);
241 void (* child_notify) (GtkWidget *widget,
243 gboolean (* draw) (GtkWidget *widget,
247 GtkSizeRequestMode (* get_request_mode) (GtkWidget *widget);
249 void (* get_preferred_height) (GtkWidget *widget,
250 gint *minimum_height,
251 gint *natural_height);
252 void (* get_preferred_width_for_height) (GtkWidget *widget,
255 gint *natural_width);
256 void (* get_preferred_width) (GtkWidget *widget,
258 gint *natural_width);
259 void (* get_preferred_height_for_width) (GtkWidget *widget,
261 gint *minimum_height,
262 gint *natural_height);
265 gboolean (* mnemonic_activate) (GtkWidget *widget,
266 gboolean group_cycling);
269 void (* grab_focus) (GtkWidget *widget);
270 gboolean (* focus) (GtkWidget *widget,
271 GtkDirectionType direction);
273 /* keyboard navigation */
274 void (* move_focus) (GtkWidget *widget,
275 GtkDirectionType direction);
276 gboolean (* keynav_failed) (GtkWidget *widget,
277 GtkDirectionType direction);
280 gboolean (* event) (GtkWidget *widget,
282 gboolean (* button_press_event) (GtkWidget *widget,
283 GdkEventButton *event);
284 gboolean (* button_release_event) (GtkWidget *widget,
285 GdkEventButton *event);
286 gboolean (* scroll_event) (GtkWidget *widget,
287 GdkEventScroll *event);
288 gboolean (* motion_notify_event) (GtkWidget *widget,
289 GdkEventMotion *event);
290 gboolean (* delete_event) (GtkWidget *widget,
292 gboolean (* destroy_event) (GtkWidget *widget,
294 gboolean (* key_press_event) (GtkWidget *widget,
296 gboolean (* key_release_event) (GtkWidget *widget,
298 gboolean (* enter_notify_event) (GtkWidget *widget,
299 GdkEventCrossing *event);
300 gboolean (* leave_notify_event) (GtkWidget *widget,
301 GdkEventCrossing *event);
302 gboolean (* configure_event) (GtkWidget *widget,
303 GdkEventConfigure *event);
304 gboolean (* focus_in_event) (GtkWidget *widget,
305 GdkEventFocus *event);
306 gboolean (* focus_out_event) (GtkWidget *widget,
307 GdkEventFocus *event);
308 gboolean (* map_event) (GtkWidget *widget,
310 gboolean (* unmap_event) (GtkWidget *widget,
312 gboolean (* property_notify_event) (GtkWidget *widget,
313 GdkEventProperty *event);
314 gboolean (* selection_clear_event) (GtkWidget *widget,
315 GdkEventSelection *event);
316 gboolean (* selection_request_event) (GtkWidget *widget,
317 GdkEventSelection *event);
318 gboolean (* selection_notify_event) (GtkWidget *widget,
319 GdkEventSelection *event);
320 gboolean (* proximity_in_event) (GtkWidget *widget,
321 GdkEventProximity *event);
322 gboolean (* proximity_out_event) (GtkWidget *widget,
323 GdkEventProximity *event);
324 gboolean (* visibility_notify_event) (GtkWidget *widget,
325 GdkEventVisibility *event);
326 gboolean (* window_state_event) (GtkWidget *widget,
327 GdkEventWindowState *event);
328 gboolean (* damage_event) (GtkWidget *widget,
329 GdkEventExpose *event);
330 gboolean (* grab_broken_event) (GtkWidget *widget,
331 GdkEventGrabBroken *event);
334 void (* selection_get) (GtkWidget *widget,
335 GtkSelectionData *selection_data,
338 void (* selection_received) (GtkWidget *widget,
339 GtkSelectionData *selection_data,
342 /* Source side drag signals */
343 void (* drag_begin) (GtkWidget *widget,
344 GdkDragContext *context);
345 void (* drag_end) (GtkWidget *widget,
346 GdkDragContext *context);
347 void (* drag_data_get) (GtkWidget *widget,
348 GdkDragContext *context,
349 GtkSelectionData *selection_data,
352 void (* drag_data_delete) (GtkWidget *widget,
353 GdkDragContext *context);
355 /* Target side drag signals */
356 void (* drag_leave) (GtkWidget *widget,
357 GdkDragContext *context,
359 gboolean (* drag_motion) (GtkWidget *widget,
360 GdkDragContext *context,
364 gboolean (* drag_drop) (GtkWidget *widget,
365 GdkDragContext *context,
369 void (* drag_data_received) (GtkWidget *widget,
370 GdkDragContext *context,
373 GtkSelectionData *selection_data,
376 gboolean (* drag_failed) (GtkWidget *widget,
377 GdkDragContext *context,
378 GtkDragResult result);
380 /* Signals used only for keybindings */
381 gboolean (* popup_menu) (GtkWidget *widget);
383 /* If a widget has multiple tooltips/whatsthis, it should show the
384 * one for the current focus location, or if that doesn't make
385 * sense, should cycle through them showing each tip alongside
386 * whatever piece of the widget it applies to.
388 gboolean (* show_help) (GtkWidget *widget,
389 GtkWidgetHelpType help_type);
391 /* accessibility support
393 AtkObject * (* get_accessible) (GtkWidget *widget);
395 void (* screen_changed) (GtkWidget *widget,
396 GdkScreen *previous_screen);
397 gboolean (* can_activate_accel) (GtkWidget *widget,
401 void (* composited_changed) (GtkWidget *widget);
403 gboolean (* query_tooltip) (GtkWidget *widget,
406 gboolean keyboard_tooltip,
407 GtkTooltip *tooltip);
409 void (* compute_expand) (GtkWidget *widget,
411 gboolean *vexpand_p);
413 void (* adjust_size_request) (GtkWidget *widget,
414 GtkOrientation orientation,
417 void (* adjust_size_allocation) (GtkWidget *widget,
418 GtkOrientation orientation,
422 gint *allocated_size);
424 void (* style_updated) (GtkWidget *widget);
428 /* Padding for future expansion */
429 void (*_gtk_reserved1) (void);
430 void (*_gtk_reserved2) (void);
431 void (*_gtk_reserved3) (void);
432 void (*_gtk_reserved4) (void);
433 void (*_gtk_reserved5) (void);
434 void (*_gtk_reserved6) (void);
435 void (*_gtk_reserved7) (void);
436 void (*_gtk_reserved8) (void);
439 struct _GtkWidgetAuxInfo
450 GType gtk_widget_get_type (void) G_GNUC_CONST;
451 GtkWidget* gtk_widget_new (GType type,
452 const gchar *first_property_name,
454 void gtk_widget_destroy (GtkWidget *widget);
455 void gtk_widget_destroyed (GtkWidget *widget,
456 GtkWidget **widget_pointer);
457 void gtk_widget_unparent (GtkWidget *widget);
458 void gtk_widget_show (GtkWidget *widget);
459 void gtk_widget_hide (GtkWidget *widget);
460 void gtk_widget_show_now (GtkWidget *widget);
461 void gtk_widget_show_all (GtkWidget *widget);
462 void gtk_widget_set_no_show_all (GtkWidget *widget,
463 gboolean no_show_all);
464 gboolean gtk_widget_get_no_show_all (GtkWidget *widget);
465 void gtk_widget_map (GtkWidget *widget);
466 void gtk_widget_unmap (GtkWidget *widget);
467 void gtk_widget_realize (GtkWidget *widget);
468 void gtk_widget_unrealize (GtkWidget *widget);
470 void gtk_widget_draw (GtkWidget *widget,
473 void gtk_widget_queue_draw (GtkWidget *widget);
474 void gtk_widget_queue_draw_area (GtkWidget *widget,
479 void gtk_widget_queue_draw_region (GtkWidget *widget,
480 cairo_region_t *region);
481 void gtk_widget_queue_resize (GtkWidget *widget);
482 void gtk_widget_queue_resize_no_redraw (GtkWidget *widget);
483 #ifndef GTK_DISABLE_DEPRECATED
484 void gtk_widget_size_request (GtkWidget *widget,
485 GtkRequisition *requisition);
487 void gtk_widget_size_allocate (GtkWidget *widget,
488 GtkAllocation *allocation);
490 GtkSizeRequestMode gtk_widget_get_request_mode (GtkWidget *widget);
491 void gtk_widget_get_preferred_width (GtkWidget *widget,
493 gint *natural_width);
494 void gtk_widget_get_preferred_height_for_width (GtkWidget *widget,
496 gint *minimum_height,
497 gint *natural_height);
498 void gtk_widget_get_preferred_height (GtkWidget *widget,
499 gint *minimum_height,
500 gint *natural_height);
501 void gtk_widget_get_preferred_width_for_height (GtkWidget *widget,
504 gint *natural_width);
505 void gtk_widget_get_preferred_size (GtkWidget *widget,
506 GtkRequisition *minimum_size,
507 GtkRequisition *natural_size);
509 #ifndef GTK_DISABLE_DEPRECATED
510 void gtk_widget_get_child_requisition (GtkWidget *widget,
511 GtkRequisition *requisition);
513 void gtk_widget_add_accelerator (GtkWidget *widget,
514 const gchar *accel_signal,
515 GtkAccelGroup *accel_group,
517 GdkModifierType accel_mods,
518 GtkAccelFlags accel_flags);
519 gboolean gtk_widget_remove_accelerator (GtkWidget *widget,
520 GtkAccelGroup *accel_group,
522 GdkModifierType accel_mods);
523 void gtk_widget_set_accel_path (GtkWidget *widget,
524 const gchar *accel_path,
525 GtkAccelGroup *accel_group);
526 const gchar* _gtk_widget_get_accel_path (GtkWidget *widget,
528 GList* gtk_widget_list_accel_closures (GtkWidget *widget);
529 gboolean gtk_widget_can_activate_accel (GtkWidget *widget,
531 gboolean gtk_widget_mnemonic_activate (GtkWidget *widget,
532 gboolean group_cycling);
533 gboolean gtk_widget_event (GtkWidget *widget,
535 gint gtk_widget_send_expose (GtkWidget *widget,
537 gboolean gtk_widget_send_focus_change (GtkWidget *widget,
540 gboolean gtk_widget_activate (GtkWidget *widget);
542 void gtk_widget_reparent (GtkWidget *widget,
543 GtkWidget *new_parent);
544 gboolean gtk_widget_intersect (GtkWidget *widget,
545 const GdkRectangle *area,
546 GdkRectangle *intersection);
547 cairo_region_t *gtk_widget_region_intersect (GtkWidget *widget,
548 const cairo_region_t *region);
550 void gtk_widget_freeze_child_notify (GtkWidget *widget);
551 void gtk_widget_child_notify (GtkWidget *widget,
552 const gchar *child_property);
553 void gtk_widget_thaw_child_notify (GtkWidget *widget);
555 void gtk_widget_set_can_focus (GtkWidget *widget,
557 gboolean gtk_widget_get_can_focus (GtkWidget *widget);
558 gboolean gtk_widget_has_focus (GtkWidget *widget);
559 gboolean gtk_widget_is_focus (GtkWidget *widget);
560 void gtk_widget_grab_focus (GtkWidget *widget);
562 void gtk_widget_set_can_default (GtkWidget *widget,
563 gboolean can_default);
564 gboolean gtk_widget_get_can_default (GtkWidget *widget);
565 gboolean gtk_widget_has_default (GtkWidget *widget);
566 void gtk_widget_grab_default (GtkWidget *widget);
568 void gtk_widget_set_receives_default (GtkWidget *widget,
569 gboolean receives_default);
570 gboolean gtk_widget_get_receives_default (GtkWidget *widget);
572 gboolean gtk_widget_has_grab (GtkWidget *widget);
574 gboolean gtk_widget_device_is_shadowed (GtkWidget *widget,
578 void gtk_widget_set_name (GtkWidget *widget,
580 G_CONST_RETURN gchar* gtk_widget_get_name (GtkWidget *widget);
582 void gtk_widget_set_state (GtkWidget *widget,
584 GtkStateType gtk_widget_get_state (GtkWidget *widget);
586 void gtk_widget_set_state_flags (GtkWidget *widget,
589 void gtk_widget_unset_state_flags (GtkWidget *widget,
590 GtkStateFlags flags);
591 GtkStateFlags gtk_widget_get_state_flags (GtkWidget *widget);
593 void gtk_widget_set_sensitive (GtkWidget *widget,
595 gboolean gtk_widget_get_sensitive (GtkWidget *widget);
596 gboolean gtk_widget_is_sensitive (GtkWidget *widget);
598 void gtk_widget_set_visible (GtkWidget *widget,
600 gboolean gtk_widget_get_visible (GtkWidget *widget);
602 void gtk_widget_set_has_window (GtkWidget *widget,
603 gboolean has_window);
604 gboolean gtk_widget_get_has_window (GtkWidget *widget);
606 gboolean gtk_widget_is_toplevel (GtkWidget *widget);
607 gboolean gtk_widget_is_drawable (GtkWidget *widget);
608 void gtk_widget_set_realized (GtkWidget *widget,
610 gboolean gtk_widget_get_realized (GtkWidget *widget);
611 void gtk_widget_set_mapped (GtkWidget *widget,
613 gboolean gtk_widget_get_mapped (GtkWidget *widget);
615 void gtk_widget_set_app_paintable (GtkWidget *widget,
616 gboolean app_paintable);
617 gboolean gtk_widget_get_app_paintable (GtkWidget *widget);
619 void gtk_widget_set_double_buffered (GtkWidget *widget,
620 gboolean double_buffered);
621 gboolean gtk_widget_get_double_buffered (GtkWidget *widget);
623 void gtk_widget_set_redraw_on_allocate (GtkWidget *widget,
624 gboolean redraw_on_allocate);
626 void gtk_widget_set_parent (GtkWidget *widget,
628 GtkWidget * gtk_widget_get_parent (GtkWidget *widget);
630 void gtk_widget_set_parent_window (GtkWidget *widget,
631 GdkWindow *parent_window);
632 GdkWindow * gtk_widget_get_parent_window (GtkWidget *widget);
634 void gtk_widget_set_child_visible (GtkWidget *widget,
635 gboolean is_visible);
636 gboolean gtk_widget_get_child_visible (GtkWidget *widget);
638 void gtk_widget_set_window (GtkWidget *widget,
640 GdkWindow * gtk_widget_get_window (GtkWidget *widget);
642 int gtk_widget_get_allocated_width (GtkWidget *widget);
643 int gtk_widget_get_allocated_height (GtkWidget *widget);
645 void gtk_widget_get_allocation (GtkWidget *widget,
646 GtkAllocation *allocation);
647 void gtk_widget_set_allocation (GtkWidget *widget,
648 const GtkAllocation *allocation);
650 void gtk_widget_get_requisition (GtkWidget *widget,
651 GtkRequisition *requisition);
653 gboolean gtk_widget_child_focus (GtkWidget *widget,
654 GtkDirectionType direction);
655 gboolean gtk_widget_keynav_failed (GtkWidget *widget,
656 GtkDirectionType direction);
657 void gtk_widget_error_bell (GtkWidget *widget);
659 void gtk_widget_set_size_request (GtkWidget *widget,
662 void gtk_widget_get_size_request (GtkWidget *widget,
665 void gtk_widget_set_events (GtkWidget *widget,
667 void gtk_widget_add_events (GtkWidget *widget,
669 void gtk_widget_set_device_events (GtkWidget *widget,
671 GdkEventMask events);
672 void gtk_widget_add_device_events (GtkWidget *widget,
674 GdkEventMask events);
676 void gtk_widget_set_device_enabled (GtkWidget *widget,
679 gboolean gtk_widget_get_device_enabled (GtkWidget *widget,
682 GtkWidget* gtk_widget_get_toplevel (GtkWidget *widget);
683 GtkWidget* gtk_widget_get_ancestor (GtkWidget *widget,
685 GdkVisual* gtk_widget_get_visual (GtkWidget *widget);
686 void gtk_widget_set_visual (GtkWidget *widget,
689 GdkScreen * gtk_widget_get_screen (GtkWidget *widget);
690 gboolean gtk_widget_has_screen (GtkWidget *widget);
691 GdkDisplay * gtk_widget_get_display (GtkWidget *widget);
692 GdkWindow * gtk_widget_get_root_window (GtkWidget *widget);
693 GtkSettings* gtk_widget_get_settings (GtkWidget *widget);
694 GtkClipboard *gtk_widget_get_clipboard (GtkWidget *widget,
698 /* Expand flags and related support */
699 gboolean gtk_widget_get_hexpand (GtkWidget *widget);
700 void gtk_widget_set_hexpand (GtkWidget *widget,
702 gboolean gtk_widget_get_hexpand_set (GtkWidget *widget);
703 void gtk_widget_set_hexpand_set (GtkWidget *widget,
705 gboolean gtk_widget_get_vexpand (GtkWidget *widget);
706 void gtk_widget_set_vexpand (GtkWidget *widget,
708 gboolean gtk_widget_get_vexpand_set (GtkWidget *widget);
709 void gtk_widget_set_vexpand_set (GtkWidget *widget,
711 void gtk_widget_queue_compute_expand (GtkWidget *widget);
712 gboolean gtk_widget_compute_expand (GtkWidget *widget,
713 GtkOrientation orientation);
716 /* Multidevice support */
717 gboolean gtk_widget_get_support_multidevice (GtkWidget *widget);
718 void gtk_widget_set_support_multidevice (GtkWidget *widget,
719 gboolean support_multidevice);
721 /* Accessibility support */
722 AtkObject* gtk_widget_get_accessible (GtkWidget *widget);
725 /* Margin and alignment */
726 GtkAlign gtk_widget_get_halign (GtkWidget *widget);
727 void gtk_widget_set_halign (GtkWidget *widget,
729 GtkAlign gtk_widget_get_valign (GtkWidget *widget);
730 void gtk_widget_set_valign (GtkWidget *widget,
732 gint gtk_widget_get_margin_left (GtkWidget *widget);
733 void gtk_widget_set_margin_left (GtkWidget *widget,
735 gint gtk_widget_get_margin_right (GtkWidget *widget);
736 void gtk_widget_set_margin_right (GtkWidget *widget,
738 gint gtk_widget_get_margin_top (GtkWidget *widget);
739 void gtk_widget_set_margin_top (GtkWidget *widget,
741 gint gtk_widget_get_margin_bottom (GtkWidget *widget);
742 void gtk_widget_set_margin_bottom (GtkWidget *widget,
746 gint gtk_widget_get_events (GtkWidget *widget);
747 GdkEventMask gtk_widget_get_device_events (GtkWidget *widget,
749 void gtk_widget_get_pointer (GtkWidget *widget,
753 gboolean gtk_widget_is_ancestor (GtkWidget *widget,
754 GtkWidget *ancestor);
756 gboolean gtk_widget_translate_coordinates (GtkWidget *src_widget,
757 GtkWidget *dest_widget,
763 /* Hide widget and return TRUE.
765 gboolean gtk_widget_hide_on_delete (GtkWidget *widget);
767 /* Functions to override widget styling */
768 void gtk_widget_override_color (GtkWidget *widget,
770 const GdkRGBA *color);
771 void gtk_widget_override_background_color (GtkWidget *widget,
773 const GdkRGBA *color);
775 void gtk_widget_override_font (GtkWidget *widget,
776 const PangoFontDescription *font_desc);
778 void gtk_widget_override_symbolic_color (GtkWidget *widget,
780 const GdkRGBA *color);
781 void gtk_widget_override_cursor (GtkWidget *widget,
782 const GdkRGBA *cursor,
783 const GdkRGBA *secondary_cursor);
785 void gtk_widget_reset_style (GtkWidget *widget);
787 #if !defined(GTK_DISABLE_DEPRECATED) || defined(GTK_COMPILATION)
789 void gtk_widget_style_attach (GtkWidget *widget);
793 gboolean gtk_widget_has_rc_style (GtkWidget *widget);
794 void gtk_widget_set_style (GtkWidget *widget,
796 void gtk_widget_ensure_style (GtkWidget *widget);
797 GtkStyle * gtk_widget_get_style (GtkWidget *widget);
799 void gtk_widget_modify_style (GtkWidget *widget,
801 GtkRcStyle *gtk_widget_get_modifier_style (GtkWidget *widget);
802 void gtk_widget_modify_fg (GtkWidget *widget,
804 const GdkColor *color);
805 void gtk_widget_modify_bg (GtkWidget *widget,
807 const GdkColor *color);
808 void gtk_widget_modify_text (GtkWidget *widget,
810 const GdkColor *color);
811 void gtk_widget_modify_base (GtkWidget *widget,
813 const GdkColor *color);
814 void gtk_widget_modify_cursor (GtkWidget *widget,
815 const GdkColor *primary,
816 const GdkColor *secondary);
817 void gtk_widget_modify_font (GtkWidget *widget,
818 PangoFontDescription *font_desc);
820 /* Descend recursively and set rc-style on all widgets without user styles */
821 void gtk_widget_reset_rc_styles (GtkWidget *widget);
823 /* Set certain default values to be used at widget creation time */
824 GtkStyle* gtk_widget_get_default_style (void);
826 /* Compute a widget's path in the form "GtkWindow.MyLabel", and
827 * return newly alocated strings.
829 void gtk_widget_path (GtkWidget *widget,
832 gchar **path_reversed);
833 void gtk_widget_class_path (GtkWidget *widget,
836 gchar **path_reversed);
838 GdkPixbuf *gtk_widget_render_icon (GtkWidget *widget,
839 const gchar *stock_id,
841 const gchar *detail);
842 #endif /* GTK_DISABLE_DEPRECATED */
844 PangoContext *gtk_widget_create_pango_context (GtkWidget *widget);
845 PangoContext *gtk_widget_get_pango_context (GtkWidget *widget);
846 PangoLayout *gtk_widget_create_pango_layout (GtkWidget *widget,
849 GdkPixbuf *gtk_widget_render_icon_pixbuf (GtkWidget *widget,
850 const gchar *stock_id,
853 /* handle composite names for GTK_COMPOSITE_CHILD widgets,
854 * the returned name is newly allocated.
856 void gtk_widget_set_composite_name (GtkWidget *widget,
858 gchar* gtk_widget_get_composite_name (GtkWidget *widget);
860 /* Push/pop pairs, to change default values upon a widget's creation.
861 * This will override the values that got set by the
862 * gtk_widget_set_default_* () functions.
864 void gtk_widget_push_composite_child (void);
865 void gtk_widget_pop_composite_child (void);
867 /* widget style properties
869 void gtk_widget_class_install_style_property (GtkWidgetClass *klass,
871 void gtk_widget_class_install_style_property_parser (GtkWidgetClass *klass,
873 GtkRcPropertyParser parser);
874 GParamSpec* gtk_widget_class_find_style_property (GtkWidgetClass *klass,
875 const gchar *property_name);
876 GParamSpec** gtk_widget_class_list_style_properties (GtkWidgetClass *klass,
877 guint *n_properties);
878 void gtk_widget_style_get_property (GtkWidget *widget,
879 const gchar *property_name,
881 void gtk_widget_style_get_valist (GtkWidget *widget,
882 const gchar *first_property_name,
884 void gtk_widget_style_get (GtkWidget *widget,
885 const gchar *first_property_name,
886 ...) G_GNUC_NULL_TERMINATED;
888 /* Functions for setting directionality for widgets */
890 void gtk_widget_set_direction (GtkWidget *widget,
891 GtkTextDirection dir);
892 GtkTextDirection gtk_widget_get_direction (GtkWidget *widget);
894 void gtk_widget_set_default_direction (GtkTextDirection dir);
895 GtkTextDirection gtk_widget_get_default_direction (void);
897 /* Compositing manager functionality */
898 gboolean gtk_widget_is_composited (GtkWidget *widget);
900 /* Counterpart to gdk_window_shape_combine_region.
902 void gtk_widget_shape_combine_region (GtkWidget *widget,
903 cairo_region_t *region);
904 void gtk_widget_input_shape_combine_region (GtkWidget *widget,
905 cairo_region_t *region);
907 GList* gtk_widget_list_mnemonic_labels (GtkWidget *widget);
908 void gtk_widget_add_mnemonic_label (GtkWidget *widget,
910 void gtk_widget_remove_mnemonic_label (GtkWidget *widget,
913 void gtk_widget_set_tooltip_window (GtkWidget *widget,
914 GtkWindow *custom_window);
915 GtkWindow *gtk_widget_get_tooltip_window (GtkWidget *widget);
916 void gtk_widget_trigger_tooltip_query (GtkWidget *widget);
917 void gtk_widget_set_tooltip_text (GtkWidget *widget,
919 gchar * gtk_widget_get_tooltip_text (GtkWidget *widget);
920 void gtk_widget_set_tooltip_markup (GtkWidget *widget,
921 const gchar *markup);
922 gchar * gtk_widget_get_tooltip_markup (GtkWidget *widget);
923 void gtk_widget_set_has_tooltip (GtkWidget *widget,
924 gboolean has_tooltip);
925 gboolean gtk_widget_get_has_tooltip (GtkWidget *widget);
927 gboolean gtk_cairo_should_draw_window (cairo_t *cr,
929 void gtk_cairo_transform_to_window (cairo_t *cr,
933 GType gtk_requisition_get_type (void) G_GNUC_CONST;
934 GtkRequisition *gtk_requisition_new (void) G_GNUC_MALLOC;
935 GtkRequisition *gtk_requisition_copy (const GtkRequisition *requisition);
936 void gtk_requisition_free (GtkRequisition *requisition);
938 GdkEventExpose * _gtk_cairo_get_event (cairo_t *cr);
940 void _gtk_widget_draw_internal (GtkWidget *widget,
942 gboolean clip_to_size);
943 void _gtk_widget_set_has_default (GtkWidget *widget,
944 gboolean has_default);
945 void _gtk_widget_set_has_grab (GtkWidget *widget,
947 void _gtk_widget_set_is_toplevel (GtkWidget *widget,
948 gboolean is_toplevel);
950 void _gtk_widget_grab_notify (GtkWidget *widget,
951 gboolean was_grabbed);
953 GtkWidgetAuxInfo *_gtk_widget_get_aux_info (GtkWidget *widget,
955 void _gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
956 GtkWidget *previous_toplevel);
957 void _gtk_widget_propagate_screen_changed (GtkWidget *widget,
958 GdkScreen *previous_screen);
959 void _gtk_widget_propagate_composited_changed (GtkWidget *widget);
961 void _gtk_widget_set_device_window (GtkWidget *widget,
963 GdkWindow *pointer_window);
964 GdkWindow *_gtk_widget_get_device_window (GtkWidget *widget,
966 GList * _gtk_widget_list_devices (GtkWidget *widget);
968 void _gtk_widget_synthesize_crossing (GtkWidget *from,
971 GdkCrossingMode mode);
973 gpointer _gtk_widget_peek_request_cache (GtkWidget *widget);
975 void _gtk_widget_buildable_finish_accelerator (GtkWidget *widget,
979 gboolean gtk_widget_in_destruction (GtkWidget *widget);
981 GtkStyleContext * gtk_widget_get_style_context (GtkWidget *widget);
983 GtkWidgetPath * gtk_widget_get_path (GtkWidget *widget);
988 #endif /* __GTK_WIDGET_H__ */