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 (* state_flags_changed) (GtkWidget *widget,
229 GtkStateFlags previous_state_flags);
230 void (* parent_set) (GtkWidget *widget,
231 GtkWidget *previous_parent);
232 void (* hierarchy_changed) (GtkWidget *widget,
233 GtkWidget *previous_toplevel);
234 void (* style_set) (GtkWidget *widget,
235 GtkStyle *previous_style);
236 void (* direction_changed) (GtkWidget *widget,
237 GtkTextDirection previous_direction);
238 void (* grab_notify) (GtkWidget *widget,
239 gboolean was_grabbed);
240 void (* child_notify) (GtkWidget *widget,
242 gboolean (* draw) (GtkWidget *widget,
246 GtkSizeRequestMode (* get_request_mode) (GtkWidget *widget);
248 void (* get_preferred_height) (GtkWidget *widget,
249 gint *minimum_height,
250 gint *natural_height);
251 void (* get_preferred_width_for_height) (GtkWidget *widget,
254 gint *natural_width);
255 void (* get_preferred_width) (GtkWidget *widget,
257 gint *natural_width);
258 void (* get_preferred_height_for_width) (GtkWidget *widget,
260 gint *minimum_height,
261 gint *natural_height);
264 gboolean (* mnemonic_activate) (GtkWidget *widget,
265 gboolean group_cycling);
268 void (* grab_focus) (GtkWidget *widget);
269 gboolean (* focus) (GtkWidget *widget,
270 GtkDirectionType direction);
272 /* keyboard navigation */
273 void (* move_focus) (GtkWidget *widget,
274 GtkDirectionType direction);
275 gboolean (* keynav_failed) (GtkWidget *widget,
276 GtkDirectionType direction);
279 gboolean (* event) (GtkWidget *widget,
281 gboolean (* button_press_event) (GtkWidget *widget,
282 GdkEventButton *event);
283 gboolean (* button_release_event) (GtkWidget *widget,
284 GdkEventButton *event);
285 gboolean (* scroll_event) (GtkWidget *widget,
286 GdkEventScroll *event);
287 gboolean (* motion_notify_event) (GtkWidget *widget,
288 GdkEventMotion *event);
289 gboolean (* delete_event) (GtkWidget *widget,
291 gboolean (* destroy_event) (GtkWidget *widget,
293 gboolean (* key_press_event) (GtkWidget *widget,
295 gboolean (* key_release_event) (GtkWidget *widget,
297 gboolean (* enter_notify_event) (GtkWidget *widget,
298 GdkEventCrossing *event);
299 gboolean (* leave_notify_event) (GtkWidget *widget,
300 GdkEventCrossing *event);
301 gboolean (* configure_event) (GtkWidget *widget,
302 GdkEventConfigure *event);
303 gboolean (* focus_in_event) (GtkWidget *widget,
304 GdkEventFocus *event);
305 gboolean (* focus_out_event) (GtkWidget *widget,
306 GdkEventFocus *event);
307 gboolean (* map_event) (GtkWidget *widget,
309 gboolean (* unmap_event) (GtkWidget *widget,
311 gboolean (* property_notify_event) (GtkWidget *widget,
312 GdkEventProperty *event);
313 gboolean (* selection_clear_event) (GtkWidget *widget,
314 GdkEventSelection *event);
315 gboolean (* selection_request_event) (GtkWidget *widget,
316 GdkEventSelection *event);
317 gboolean (* selection_notify_event) (GtkWidget *widget,
318 GdkEventSelection *event);
319 gboolean (* proximity_in_event) (GtkWidget *widget,
320 GdkEventProximity *event);
321 gboolean (* proximity_out_event) (GtkWidget *widget,
322 GdkEventProximity *event);
323 gboolean (* visibility_notify_event) (GtkWidget *widget,
324 GdkEventVisibility *event);
325 gboolean (* client_event) (GtkWidget *widget,
326 GdkEventClient *event);
327 gboolean (* window_state_event) (GtkWidget *widget,
328 GdkEventWindowState *event);
329 gboolean (* damage_event) (GtkWidget *widget,
330 GdkEventExpose *event);
331 gboolean (* grab_broken_event) (GtkWidget *widget,
332 GdkEventGrabBroken *event);
335 void (* selection_get) (GtkWidget *widget,
336 GtkSelectionData *selection_data,
339 void (* selection_received) (GtkWidget *widget,
340 GtkSelectionData *selection_data,
343 /* Source side drag signals */
344 void (* drag_begin) (GtkWidget *widget,
345 GdkDragContext *context);
346 void (* drag_end) (GtkWidget *widget,
347 GdkDragContext *context);
348 void (* drag_data_get) (GtkWidget *widget,
349 GdkDragContext *context,
350 GtkSelectionData *selection_data,
353 void (* drag_data_delete) (GtkWidget *widget,
354 GdkDragContext *context);
356 /* Target side drag signals */
357 void (* drag_leave) (GtkWidget *widget,
358 GdkDragContext *context,
360 gboolean (* drag_motion) (GtkWidget *widget,
361 GdkDragContext *context,
365 gboolean (* drag_drop) (GtkWidget *widget,
366 GdkDragContext *context,
370 void (* drag_data_received) (GtkWidget *widget,
371 GdkDragContext *context,
374 GtkSelectionData *selection_data,
378 /* Signals used only for keybindings */
379 gboolean (* popup_menu) (GtkWidget *widget);
381 /* If a widget has multiple tooltips/whatsthis, it should show the
382 * one for the current focus location, or if that doesn't make
383 * sense, should cycle through them showing each tip alongside
384 * whatever piece of the widget it applies to.
386 gboolean (* show_help) (GtkWidget *widget,
387 GtkWidgetHelpType help_type);
389 /* accessibility support
391 AtkObject * (* get_accessible) (GtkWidget *widget);
393 void (* screen_changed) (GtkWidget *widget,
394 GdkScreen *previous_screen);
395 gboolean (* can_activate_accel) (GtkWidget *widget,
399 void (* composited_changed) (GtkWidget *widget);
401 gboolean (* query_tooltip) (GtkWidget *widget,
404 gboolean keyboard_tooltip,
405 GtkTooltip *tooltip);
407 void (* compute_expand) (GtkWidget *widget,
409 gboolean *vexpand_p);
411 void (* adjust_size_request) (GtkWidget *widget,
412 GtkOrientation orientation,
415 void (* adjust_size_allocation) (GtkWidget *widget,
416 GtkOrientation orientation,
419 gint *allocated_size);
421 void (* style_updated) (GtkWidget *widget);
425 /* Padding for future expansion */
426 void (*_gtk_reserved1) (void);
427 void (*_gtk_reserved2) (void);
428 void (*_gtk_reserved3) (void);
429 void (*_gtk_reserved4) (void);
430 void (*_gtk_reserved5) (void);
431 void (*_gtk_reserved6) (void);
432 void (*_gtk_reserved7) (void);
433 void (*_gtk_reserved8) (void);
436 struct _GtkWidgetAuxInfo
447 GType gtk_widget_get_type (void) G_GNUC_CONST;
448 GtkWidget* gtk_widget_new (GType type,
449 const gchar *first_property_name,
451 void gtk_widget_destroy (GtkWidget *widget);
452 void gtk_widget_destroyed (GtkWidget *widget,
453 GtkWidget **widget_pointer);
454 void gtk_widget_unparent (GtkWidget *widget);
455 void gtk_widget_show (GtkWidget *widget);
456 void gtk_widget_hide (GtkWidget *widget);
457 void gtk_widget_show_now (GtkWidget *widget);
458 void gtk_widget_show_all (GtkWidget *widget);
459 void gtk_widget_set_no_show_all (GtkWidget *widget,
460 gboolean no_show_all);
461 gboolean gtk_widget_get_no_show_all (GtkWidget *widget);
462 void gtk_widget_map (GtkWidget *widget);
463 void gtk_widget_unmap (GtkWidget *widget);
464 void gtk_widget_realize (GtkWidget *widget);
465 void gtk_widget_unrealize (GtkWidget *widget);
467 void gtk_widget_draw (GtkWidget *widget,
470 void gtk_widget_queue_draw (GtkWidget *widget);
471 void gtk_widget_queue_draw_area (GtkWidget *widget,
476 void gtk_widget_queue_draw_region (GtkWidget *widget,
477 cairo_region_t *region);
478 void gtk_widget_queue_resize (GtkWidget *widget);
479 void gtk_widget_queue_resize_no_redraw (GtkWidget *widget);
480 #ifndef GTK_DISABLE_DEPRECATED
481 void gtk_widget_size_request (GtkWidget *widget,
482 GtkRequisition *requisition);
484 void gtk_widget_size_allocate (GtkWidget *widget,
485 GtkAllocation *allocation);
487 GtkSizeRequestMode gtk_widget_get_request_mode (GtkWidget *widget);
488 void gtk_widget_get_preferred_width (GtkWidget *widget,
490 gint *natural_width);
491 void gtk_widget_get_preferred_height_for_width (GtkWidget *widget,
493 gint *minimum_height,
494 gint *natural_height);
495 void gtk_widget_get_preferred_height (GtkWidget *widget,
496 gint *minimum_height,
497 gint *natural_height);
498 void gtk_widget_get_preferred_width_for_height (GtkWidget *widget,
501 gint *natural_width);
502 void gtk_widget_get_preferred_size (GtkWidget *widget,
503 GtkRequisition *minimum_size,
504 GtkRequisition *natural_size);
506 #ifndef GTK_DISABLE_DEPRECATED
507 void gtk_widget_get_child_requisition (GtkWidget *widget,
508 GtkRequisition *requisition);
510 void gtk_widget_add_accelerator (GtkWidget *widget,
511 const gchar *accel_signal,
512 GtkAccelGroup *accel_group,
514 GdkModifierType accel_mods,
515 GtkAccelFlags accel_flags);
516 gboolean gtk_widget_remove_accelerator (GtkWidget *widget,
517 GtkAccelGroup *accel_group,
519 GdkModifierType accel_mods);
520 void gtk_widget_set_accel_path (GtkWidget *widget,
521 const gchar *accel_path,
522 GtkAccelGroup *accel_group);
523 const gchar* _gtk_widget_get_accel_path (GtkWidget *widget,
525 GList* gtk_widget_list_accel_closures (GtkWidget *widget);
526 gboolean gtk_widget_can_activate_accel (GtkWidget *widget,
528 gboolean gtk_widget_mnemonic_activate (GtkWidget *widget,
529 gboolean group_cycling);
530 gboolean gtk_widget_event (GtkWidget *widget,
532 gint gtk_widget_send_expose (GtkWidget *widget,
534 gboolean gtk_widget_send_focus_change (GtkWidget *widget,
537 gboolean gtk_widget_activate (GtkWidget *widget);
539 void gtk_widget_reparent (GtkWidget *widget,
540 GtkWidget *new_parent);
541 gboolean gtk_widget_intersect (GtkWidget *widget,
542 const GdkRectangle *area,
543 GdkRectangle *intersection);
544 cairo_region_t *gtk_widget_region_intersect (GtkWidget *widget,
545 const cairo_region_t *region);
547 void gtk_widget_freeze_child_notify (GtkWidget *widget);
548 void gtk_widget_child_notify (GtkWidget *widget,
549 const gchar *child_property);
550 void gtk_widget_thaw_child_notify (GtkWidget *widget);
552 void gtk_widget_set_can_focus (GtkWidget *widget,
554 gboolean gtk_widget_get_can_focus (GtkWidget *widget);
555 gboolean gtk_widget_has_focus (GtkWidget *widget);
556 gboolean gtk_widget_is_focus (GtkWidget *widget);
557 void gtk_widget_grab_focus (GtkWidget *widget);
559 void gtk_widget_set_can_default (GtkWidget *widget,
560 gboolean can_default);
561 gboolean gtk_widget_get_can_default (GtkWidget *widget);
562 gboolean gtk_widget_has_default (GtkWidget *widget);
563 void gtk_widget_grab_default (GtkWidget *widget);
565 void gtk_widget_set_receives_default (GtkWidget *widget,
566 gboolean receives_default);
567 gboolean gtk_widget_get_receives_default (GtkWidget *widget);
569 gboolean gtk_widget_has_grab (GtkWidget *widget);
571 gboolean gtk_widget_device_is_shadowed (GtkWidget *widget,
575 void gtk_widget_set_name (GtkWidget *widget,
577 G_CONST_RETURN gchar* gtk_widget_get_name (GtkWidget *widget);
579 void gtk_widget_set_state (GtkWidget *widget,
581 GtkStateType gtk_widget_get_state (GtkWidget *widget);
583 void gtk_widget_set_state_flags (GtkWidget *widget,
586 void gtk_widget_unset_state_flags (GtkWidget *widget,
587 GtkStateFlags flags);
588 GtkStateFlags gtk_widget_get_state_flags (GtkWidget *widget);
590 void gtk_widget_set_sensitive (GtkWidget *widget,
592 gboolean gtk_widget_get_sensitive (GtkWidget *widget);
593 gboolean gtk_widget_is_sensitive (GtkWidget *widget);
595 void gtk_widget_set_visible (GtkWidget *widget,
597 gboolean gtk_widget_get_visible (GtkWidget *widget);
599 void gtk_widget_set_has_window (GtkWidget *widget,
600 gboolean has_window);
601 gboolean gtk_widget_get_has_window (GtkWidget *widget);
603 gboolean gtk_widget_is_toplevel (GtkWidget *widget);
604 gboolean gtk_widget_is_drawable (GtkWidget *widget);
605 void gtk_widget_set_realized (GtkWidget *widget,
607 gboolean gtk_widget_get_realized (GtkWidget *widget);
608 void gtk_widget_set_mapped (GtkWidget *widget,
610 gboolean gtk_widget_get_mapped (GtkWidget *widget);
612 void gtk_widget_set_app_paintable (GtkWidget *widget,
613 gboolean app_paintable);
614 gboolean gtk_widget_get_app_paintable (GtkWidget *widget);
616 void gtk_widget_set_double_buffered (GtkWidget *widget,
617 gboolean double_buffered);
618 gboolean gtk_widget_get_double_buffered (GtkWidget *widget);
620 void gtk_widget_set_redraw_on_allocate (GtkWidget *widget,
621 gboolean redraw_on_allocate);
623 void gtk_widget_set_parent (GtkWidget *widget,
625 GtkWidget * gtk_widget_get_parent (GtkWidget *widget);
627 void gtk_widget_set_parent_window (GtkWidget *widget,
628 GdkWindow *parent_window);
629 GdkWindow * gtk_widget_get_parent_window (GtkWidget *widget);
631 void gtk_widget_set_child_visible (GtkWidget *widget,
632 gboolean is_visible);
633 gboolean gtk_widget_get_child_visible (GtkWidget *widget);
635 void gtk_widget_set_window (GtkWidget *widget,
637 GdkWindow * gtk_widget_get_window (GtkWidget *widget);
639 int gtk_widget_get_allocated_width (GtkWidget *widget);
640 int gtk_widget_get_allocated_height (GtkWidget *widget);
642 void gtk_widget_get_allocation (GtkWidget *widget,
643 GtkAllocation *allocation);
644 void gtk_widget_set_allocation (GtkWidget *widget,
645 const GtkAllocation *allocation);
647 void gtk_widget_get_requisition (GtkWidget *widget,
648 GtkRequisition *requisition);
650 gboolean gtk_widget_child_focus (GtkWidget *widget,
651 GtkDirectionType direction);
652 gboolean gtk_widget_keynav_failed (GtkWidget *widget,
653 GtkDirectionType direction);
654 void gtk_widget_error_bell (GtkWidget *widget);
656 void gtk_widget_set_size_request (GtkWidget *widget,
659 void gtk_widget_get_size_request (GtkWidget *widget,
662 void gtk_widget_set_events (GtkWidget *widget,
664 void gtk_widget_add_events (GtkWidget *widget,
666 void gtk_widget_set_device_events (GtkWidget *widget,
668 GdkEventMask events);
669 void gtk_widget_add_device_events (GtkWidget *widget,
671 GdkEventMask events);
672 void gtk_widget_set_extension_events (GtkWidget *widget,
673 GdkExtensionMode mode);
675 GdkExtensionMode gtk_widget_get_extension_events (GtkWidget *widget);
676 GtkWidget* gtk_widget_get_toplevel (GtkWidget *widget);
677 GtkWidget* gtk_widget_get_ancestor (GtkWidget *widget,
679 GdkVisual* gtk_widget_get_visual (GtkWidget *widget);
680 void gtk_widget_set_visual (GtkWidget *widget,
683 GdkScreen * gtk_widget_get_screen (GtkWidget *widget);
684 gboolean gtk_widget_has_screen (GtkWidget *widget);
685 GdkDisplay * gtk_widget_get_display (GtkWidget *widget);
686 GdkWindow * gtk_widget_get_root_window (GtkWidget *widget);
687 GtkSettings* gtk_widget_get_settings (GtkWidget *widget);
688 GtkClipboard *gtk_widget_get_clipboard (GtkWidget *widget,
692 /* Expand flags and related support */
693 gboolean gtk_widget_get_hexpand (GtkWidget *widget);
694 void gtk_widget_set_hexpand (GtkWidget *widget,
696 gboolean gtk_widget_get_hexpand_set (GtkWidget *widget);
697 void gtk_widget_set_hexpand_set (GtkWidget *widget,
699 gboolean gtk_widget_get_vexpand (GtkWidget *widget);
700 void gtk_widget_set_vexpand (GtkWidget *widget,
702 gboolean gtk_widget_get_vexpand_set (GtkWidget *widget);
703 void gtk_widget_set_vexpand_set (GtkWidget *widget,
705 void gtk_widget_queue_compute_expand (GtkWidget *widget);
706 gboolean gtk_widget_compute_expand (GtkWidget *widget,
707 GtkOrientation orientation);
710 /* Multidevice support */
711 gboolean gtk_widget_get_support_multidevice (GtkWidget *widget);
712 void gtk_widget_set_support_multidevice (GtkWidget *widget,
713 gboolean support_multidevice);
715 /* Accessibility support */
716 AtkObject* gtk_widget_get_accessible (GtkWidget *widget);
719 /* Margin and alignment */
720 GtkAlign gtk_widget_get_halign (GtkWidget *widget);
721 void gtk_widget_set_halign (GtkWidget *widget,
723 GtkAlign gtk_widget_get_valign (GtkWidget *widget);
724 void gtk_widget_set_valign (GtkWidget *widget,
726 gint gtk_widget_get_margin_left (GtkWidget *widget);
727 void gtk_widget_set_margin_left (GtkWidget *widget,
729 gint gtk_widget_get_margin_right (GtkWidget *widget);
730 void gtk_widget_set_margin_right (GtkWidget *widget,
732 gint gtk_widget_get_margin_top (GtkWidget *widget);
733 void gtk_widget_set_margin_top (GtkWidget *widget,
735 gint gtk_widget_get_margin_bottom (GtkWidget *widget);
736 void gtk_widget_set_margin_bottom (GtkWidget *widget,
740 gint gtk_widget_get_events (GtkWidget *widget);
741 GdkEventMask gtk_widget_get_device_events (GtkWidget *widget,
743 void gtk_widget_get_pointer (GtkWidget *widget,
747 gboolean gtk_widget_is_ancestor (GtkWidget *widget,
748 GtkWidget *ancestor);
750 gboolean gtk_widget_translate_coordinates (GtkWidget *src_widget,
751 GtkWidget *dest_widget,
757 /* Hide widget and return TRUE.
759 gboolean gtk_widget_hide_on_delete (GtkWidget *widget);
761 /* Functions to override widget styling */
762 void gtk_widget_override_color (GtkWidget *widget,
764 const GdkRGBA *color);
765 void gtk_widget_override_background_color (GtkWidget *widget,
767 const GdkRGBA *color);
769 void gtk_widget_override_font (GtkWidget *widget,
770 const PangoFontDescription *font_desc);
772 void gtk_widget_override_symbolic_color (GtkWidget *widget,
774 const GdkRGBA *color);
778 void gtk_widget_style_attach (GtkWidget *widget);
780 gboolean gtk_widget_has_rc_style (GtkWidget *widget);
781 void gtk_widget_set_style (GtkWidget *widget,
783 void gtk_widget_ensure_style (GtkWidget *widget);
784 GtkStyle * gtk_widget_get_style (GtkWidget *widget);
786 void gtk_widget_modify_style (GtkWidget *widget,
788 GtkRcStyle *gtk_widget_get_modifier_style (GtkWidget *widget);
789 void gtk_widget_modify_fg (GtkWidget *widget,
791 const GdkColor *color);
792 void gtk_widget_modify_bg (GtkWidget *widget,
794 const GdkColor *color);
795 void gtk_widget_modify_text (GtkWidget *widget,
797 const GdkColor *color);
798 void gtk_widget_modify_base (GtkWidget *widget,
800 const GdkColor *color);
801 void gtk_widget_modify_cursor (GtkWidget *widget,
802 const GdkColor *primary,
803 const GdkColor *secondary);
804 void gtk_widget_modify_font (GtkWidget *widget,
805 PangoFontDescription *font_desc);
807 PangoContext *gtk_widget_create_pango_context (GtkWidget *widget);
808 PangoContext *gtk_widget_get_pango_context (GtkWidget *widget);
809 PangoLayout *gtk_widget_create_pango_layout (GtkWidget *widget,
812 GdkPixbuf *gtk_widget_render_icon (GtkWidget *widget,
813 const gchar *stock_id,
815 const gchar *detail);
817 /* handle composite names for GTK_COMPOSITE_CHILD widgets,
818 * the returned name is newly allocated.
820 void gtk_widget_set_composite_name (GtkWidget *widget,
822 gchar* gtk_widget_get_composite_name (GtkWidget *widget);
824 /* Descend recursively and set rc-style on all widgets without user styles */
825 void gtk_widget_reset_rc_styles (GtkWidget *widget);
827 void gtk_widget_reset_style (GtkWidget *widget);
829 /* Push/pop pairs, to change default values upon a widget's creation.
830 * This will override the values that got set by the
831 * gtk_widget_set_default_* () functions.
833 void gtk_widget_push_composite_child (void);
834 void gtk_widget_pop_composite_child (void);
836 /* widget style properties
838 void gtk_widget_class_install_style_property (GtkWidgetClass *klass,
840 void gtk_widget_class_install_style_property_parser (GtkWidgetClass *klass,
842 GtkRcPropertyParser parser);
843 GParamSpec* gtk_widget_class_find_style_property (GtkWidgetClass *klass,
844 const gchar *property_name);
845 GParamSpec** gtk_widget_class_list_style_properties (GtkWidgetClass *klass,
846 guint *n_properties);
847 void gtk_widget_style_get_property (GtkWidget *widget,
848 const gchar *property_name,
850 void gtk_widget_style_get_valist (GtkWidget *widget,
851 const gchar *first_property_name,
853 void gtk_widget_style_get (GtkWidget *widget,
854 const gchar *first_property_name,
855 ...) G_GNUC_NULL_TERMINATED;
858 /* Set certain default values to be used at widget creation time.
860 GtkStyle* gtk_widget_get_default_style (void);
862 /* Functions for setting directionality for widgets
865 void gtk_widget_set_direction (GtkWidget *widget,
866 GtkTextDirection dir);
867 GtkTextDirection gtk_widget_get_direction (GtkWidget *widget);
869 void gtk_widget_set_default_direction (GtkTextDirection dir);
870 GtkTextDirection gtk_widget_get_default_direction (void);
872 /* Compositing manager functionality */
873 gboolean gtk_widget_is_composited (GtkWidget *widget);
875 /* Counterpart to gdk_window_shape_combine_region.
877 void gtk_widget_shape_combine_region (GtkWidget *widget,
878 cairo_region_t *region);
879 void gtk_widget_input_shape_combine_region (GtkWidget *widget,
880 cairo_region_t *region);
882 /* internal function */
883 void gtk_widget_reset_shapes (GtkWidget *widget);
885 /* Compute a widget's path in the form "GtkWindow.MyLabel", and
886 * return newly alocated strings.
888 void gtk_widget_path (GtkWidget *widget,
891 gchar **path_reversed);
892 void gtk_widget_class_path (GtkWidget *widget,
895 gchar **path_reversed);
897 GList* gtk_widget_list_mnemonic_labels (GtkWidget *widget);
898 void gtk_widget_add_mnemonic_label (GtkWidget *widget,
900 void gtk_widget_remove_mnemonic_label (GtkWidget *widget,
903 void gtk_widget_set_tooltip_window (GtkWidget *widget,
904 GtkWindow *custom_window);
905 GtkWindow *gtk_widget_get_tooltip_window (GtkWidget *widget);
906 void gtk_widget_trigger_tooltip_query (GtkWidget *widget);
907 void gtk_widget_set_tooltip_text (GtkWidget *widget,
909 gchar * gtk_widget_get_tooltip_text (GtkWidget *widget);
910 void gtk_widget_set_tooltip_markup (GtkWidget *widget,
911 const gchar *markup);
912 gchar * gtk_widget_get_tooltip_markup (GtkWidget *widget);
913 void gtk_widget_set_has_tooltip (GtkWidget *widget,
914 gboolean has_tooltip);
915 gboolean gtk_widget_get_has_tooltip (GtkWidget *widget);
917 gboolean gtk_cairo_should_draw_window (cairo_t *cr,
919 void gtk_cairo_transform_to_window (cairo_t *cr,
923 GType gtk_requisition_get_type (void) G_GNUC_CONST;
924 GtkRequisition *gtk_requisition_new (void) G_GNUC_MALLOC;
925 GtkRequisition *gtk_requisition_copy (const GtkRequisition *requisition);
926 void gtk_requisition_free (GtkRequisition *requisition);
928 GdkEventExpose * _gtk_cairo_get_event (cairo_t *cr);
930 void _gtk_widget_draw_internal (GtkWidget *widget,
932 gboolean clip_to_size);
933 void _gtk_widget_set_has_default (GtkWidget *widget,
934 gboolean has_default);
935 void _gtk_widget_set_has_grab (GtkWidget *widget,
937 void _gtk_widget_set_is_toplevel (GtkWidget *widget,
938 gboolean is_toplevel);
940 void _gtk_widget_grab_notify (GtkWidget *widget,
941 gboolean was_grabbed);
943 GtkWidgetAuxInfo *_gtk_widget_get_aux_info (GtkWidget *widget,
945 void _gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
946 GtkWidget *previous_toplevel);
947 void _gtk_widget_propagate_screen_changed (GtkWidget *widget,
948 GdkScreen *previous_screen);
949 void _gtk_widget_propagate_composited_changed (GtkWidget *widget);
951 void _gtk_widget_set_device_window (GtkWidget *widget,
953 GdkWindow *pointer_window);
954 GdkWindow *_gtk_widget_get_device_window (GtkWidget *widget,
956 GList * _gtk_widget_list_devices (GtkWidget *widget);
958 void _gtk_widget_synthesize_crossing (GtkWidget *from,
961 GdkCrossingMode mode);
963 gpointer _gtk_widget_peek_request_cache (GtkWidget *widget);
965 void _gtk_widget_buildable_finish_accelerator (GtkWidget *widget,
969 gboolean gtk_widget_in_destruction (GtkWidget *widget);
971 GtkStyleContext * gtk_widget_get_style_context (GtkWidget *widget);
973 GtkWidgetPath * gtk_widget_get_path (GtkWidget *widget);
978 #endif /* __GTK_WIDGET_H__ */