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 (* client_event) (GtkWidget *widget,
327 GdkEventClient *event);
328 gboolean (* window_state_event) (GtkWidget *widget,
329 GdkEventWindowState *event);
330 gboolean (* damage_event) (GtkWidget *widget,
331 GdkEventExpose *event);
332 gboolean (* grab_broken_event) (GtkWidget *widget,
333 GdkEventGrabBroken *event);
336 void (* selection_get) (GtkWidget *widget,
337 GtkSelectionData *selection_data,
340 void (* selection_received) (GtkWidget *widget,
341 GtkSelectionData *selection_data,
344 /* Source side drag signals */
345 void (* drag_begin) (GtkWidget *widget,
346 GdkDragContext *context);
347 void (* drag_end) (GtkWidget *widget,
348 GdkDragContext *context);
349 void (* drag_data_get) (GtkWidget *widget,
350 GdkDragContext *context,
351 GtkSelectionData *selection_data,
354 void (* drag_data_delete) (GtkWidget *widget,
355 GdkDragContext *context);
357 /* Target side drag signals */
358 void (* drag_leave) (GtkWidget *widget,
359 GdkDragContext *context,
361 gboolean (* drag_motion) (GtkWidget *widget,
362 GdkDragContext *context,
366 gboolean (* drag_drop) (GtkWidget *widget,
367 GdkDragContext *context,
371 void (* drag_data_received) (GtkWidget *widget,
372 GdkDragContext *context,
375 GtkSelectionData *selection_data,
379 /* Signals used only for keybindings */
380 gboolean (* popup_menu) (GtkWidget *widget);
382 /* If a widget has multiple tooltips/whatsthis, it should show the
383 * one for the current focus location, or if that doesn't make
384 * sense, should cycle through them showing each tip alongside
385 * whatever piece of the widget it applies to.
387 gboolean (* show_help) (GtkWidget *widget,
388 GtkWidgetHelpType help_type);
390 /* accessibility support
392 AtkObject * (* get_accessible) (GtkWidget *widget);
394 void (* screen_changed) (GtkWidget *widget,
395 GdkScreen *previous_screen);
396 gboolean (* can_activate_accel) (GtkWidget *widget,
400 void (* composited_changed) (GtkWidget *widget);
402 gboolean (* query_tooltip) (GtkWidget *widget,
405 gboolean keyboard_tooltip,
406 GtkTooltip *tooltip);
408 void (* compute_expand) (GtkWidget *widget,
410 gboolean *vexpand_p);
412 void (* adjust_size_request) (GtkWidget *widget,
413 GtkOrientation orientation,
416 void (* adjust_size_allocation) (GtkWidget *widget,
417 GtkOrientation orientation,
421 gint *allocated_size);
423 void (* style_updated) (GtkWidget *widget);
427 /* Padding for future expansion */
428 void (*_gtk_reserved1) (void);
429 void (*_gtk_reserved2) (void);
430 void (*_gtk_reserved3) (void);
431 void (*_gtk_reserved4) (void);
432 void (*_gtk_reserved5) (void);
433 void (*_gtk_reserved6) (void);
434 void (*_gtk_reserved7) (void);
435 void (*_gtk_reserved8) (void);
438 struct _GtkWidgetAuxInfo
449 GType gtk_widget_get_type (void) G_GNUC_CONST;
450 GtkWidget* gtk_widget_new (GType type,
451 const gchar *first_property_name,
453 void gtk_widget_destroy (GtkWidget *widget);
454 void gtk_widget_destroyed (GtkWidget *widget,
455 GtkWidget **widget_pointer);
456 void gtk_widget_unparent (GtkWidget *widget);
457 void gtk_widget_show (GtkWidget *widget);
458 void gtk_widget_hide (GtkWidget *widget);
459 void gtk_widget_show_now (GtkWidget *widget);
460 void gtk_widget_show_all (GtkWidget *widget);
461 void gtk_widget_set_no_show_all (GtkWidget *widget,
462 gboolean no_show_all);
463 gboolean gtk_widget_get_no_show_all (GtkWidget *widget);
464 void gtk_widget_map (GtkWidget *widget);
465 void gtk_widget_unmap (GtkWidget *widget);
466 void gtk_widget_realize (GtkWidget *widget);
467 void gtk_widget_unrealize (GtkWidget *widget);
469 void gtk_widget_draw (GtkWidget *widget,
472 void gtk_widget_queue_draw (GtkWidget *widget);
473 void gtk_widget_queue_draw_area (GtkWidget *widget,
478 void gtk_widget_queue_draw_region (GtkWidget *widget,
479 cairo_region_t *region);
480 void gtk_widget_queue_resize (GtkWidget *widget);
481 void gtk_widget_queue_resize_no_redraw (GtkWidget *widget);
482 #ifndef GTK_DISABLE_DEPRECATED
483 void gtk_widget_size_request (GtkWidget *widget,
484 GtkRequisition *requisition);
486 void gtk_widget_size_allocate (GtkWidget *widget,
487 GtkAllocation *allocation);
489 GtkSizeRequestMode gtk_widget_get_request_mode (GtkWidget *widget);
490 void gtk_widget_get_preferred_width (GtkWidget *widget,
492 gint *natural_width);
493 void gtk_widget_get_preferred_height_for_width (GtkWidget *widget,
495 gint *minimum_height,
496 gint *natural_height);
497 void gtk_widget_get_preferred_height (GtkWidget *widget,
498 gint *minimum_height,
499 gint *natural_height);
500 void gtk_widget_get_preferred_width_for_height (GtkWidget *widget,
503 gint *natural_width);
504 void gtk_widget_get_preferred_size (GtkWidget *widget,
505 GtkRequisition *minimum_size,
506 GtkRequisition *natural_size);
508 #ifndef GTK_DISABLE_DEPRECATED
509 void gtk_widget_get_child_requisition (GtkWidget *widget,
510 GtkRequisition *requisition);
512 void gtk_widget_add_accelerator (GtkWidget *widget,
513 const gchar *accel_signal,
514 GtkAccelGroup *accel_group,
516 GdkModifierType accel_mods,
517 GtkAccelFlags accel_flags);
518 gboolean gtk_widget_remove_accelerator (GtkWidget *widget,
519 GtkAccelGroup *accel_group,
521 GdkModifierType accel_mods);
522 void gtk_widget_set_accel_path (GtkWidget *widget,
523 const gchar *accel_path,
524 GtkAccelGroup *accel_group);
525 const gchar* _gtk_widget_get_accel_path (GtkWidget *widget,
527 GList* gtk_widget_list_accel_closures (GtkWidget *widget);
528 gboolean gtk_widget_can_activate_accel (GtkWidget *widget,
530 gboolean gtk_widget_mnemonic_activate (GtkWidget *widget,
531 gboolean group_cycling);
532 gboolean gtk_widget_event (GtkWidget *widget,
534 gint gtk_widget_send_expose (GtkWidget *widget,
536 gboolean gtk_widget_send_focus_change (GtkWidget *widget,
539 gboolean gtk_widget_activate (GtkWidget *widget);
541 void gtk_widget_reparent (GtkWidget *widget,
542 GtkWidget *new_parent);
543 gboolean gtk_widget_intersect (GtkWidget *widget,
544 const GdkRectangle *area,
545 GdkRectangle *intersection);
546 cairo_region_t *gtk_widget_region_intersect (GtkWidget *widget,
547 const cairo_region_t *region);
549 void gtk_widget_freeze_child_notify (GtkWidget *widget);
550 void gtk_widget_child_notify (GtkWidget *widget,
551 const gchar *child_property);
552 void gtk_widget_thaw_child_notify (GtkWidget *widget);
554 void gtk_widget_set_can_focus (GtkWidget *widget,
556 gboolean gtk_widget_get_can_focus (GtkWidget *widget);
557 gboolean gtk_widget_has_focus (GtkWidget *widget);
558 gboolean gtk_widget_is_focus (GtkWidget *widget);
559 void gtk_widget_grab_focus (GtkWidget *widget);
561 void gtk_widget_set_can_default (GtkWidget *widget,
562 gboolean can_default);
563 gboolean gtk_widget_get_can_default (GtkWidget *widget);
564 gboolean gtk_widget_has_default (GtkWidget *widget);
565 void gtk_widget_grab_default (GtkWidget *widget);
567 void gtk_widget_set_receives_default (GtkWidget *widget,
568 gboolean receives_default);
569 gboolean gtk_widget_get_receives_default (GtkWidget *widget);
571 gboolean gtk_widget_has_grab (GtkWidget *widget);
573 gboolean gtk_widget_device_is_shadowed (GtkWidget *widget,
577 void gtk_widget_set_name (GtkWidget *widget,
579 G_CONST_RETURN gchar* gtk_widget_get_name (GtkWidget *widget);
581 void gtk_widget_set_state (GtkWidget *widget,
583 GtkStateType gtk_widget_get_state (GtkWidget *widget);
585 void gtk_widget_set_state_flags (GtkWidget *widget,
588 void gtk_widget_unset_state_flags (GtkWidget *widget,
589 GtkStateFlags flags);
590 GtkStateFlags gtk_widget_get_state_flags (GtkWidget *widget);
592 void gtk_widget_set_sensitive (GtkWidget *widget,
594 gboolean gtk_widget_get_sensitive (GtkWidget *widget);
595 gboolean gtk_widget_is_sensitive (GtkWidget *widget);
597 void gtk_widget_set_visible (GtkWidget *widget,
599 gboolean gtk_widget_get_visible (GtkWidget *widget);
601 void gtk_widget_set_has_window (GtkWidget *widget,
602 gboolean has_window);
603 gboolean gtk_widget_get_has_window (GtkWidget *widget);
605 gboolean gtk_widget_is_toplevel (GtkWidget *widget);
606 gboolean gtk_widget_is_drawable (GtkWidget *widget);
607 void gtk_widget_set_realized (GtkWidget *widget,
609 gboolean gtk_widget_get_realized (GtkWidget *widget);
610 void gtk_widget_set_mapped (GtkWidget *widget,
612 gboolean gtk_widget_get_mapped (GtkWidget *widget);
614 void gtk_widget_set_app_paintable (GtkWidget *widget,
615 gboolean app_paintable);
616 gboolean gtk_widget_get_app_paintable (GtkWidget *widget);
618 void gtk_widget_set_double_buffered (GtkWidget *widget,
619 gboolean double_buffered);
620 gboolean gtk_widget_get_double_buffered (GtkWidget *widget);
622 void gtk_widget_set_redraw_on_allocate (GtkWidget *widget,
623 gboolean redraw_on_allocate);
625 void gtk_widget_set_parent (GtkWidget *widget,
627 GtkWidget * gtk_widget_get_parent (GtkWidget *widget);
629 void gtk_widget_set_parent_window (GtkWidget *widget,
630 GdkWindow *parent_window);
631 GdkWindow * gtk_widget_get_parent_window (GtkWidget *widget);
633 void gtk_widget_set_child_visible (GtkWidget *widget,
634 gboolean is_visible);
635 gboolean gtk_widget_get_child_visible (GtkWidget *widget);
637 void gtk_widget_set_window (GtkWidget *widget,
639 GdkWindow * gtk_widget_get_window (GtkWidget *widget);
641 int gtk_widget_get_allocated_width (GtkWidget *widget);
642 int gtk_widget_get_allocated_height (GtkWidget *widget);
644 void gtk_widget_get_allocation (GtkWidget *widget,
645 GtkAllocation *allocation);
646 void gtk_widget_set_allocation (GtkWidget *widget,
647 const GtkAllocation *allocation);
649 void gtk_widget_get_requisition (GtkWidget *widget,
650 GtkRequisition *requisition);
652 gboolean gtk_widget_child_focus (GtkWidget *widget,
653 GtkDirectionType direction);
654 gboolean gtk_widget_keynav_failed (GtkWidget *widget,
655 GtkDirectionType direction);
656 void gtk_widget_error_bell (GtkWidget *widget);
658 void gtk_widget_set_size_request (GtkWidget *widget,
661 void gtk_widget_get_size_request (GtkWidget *widget,
664 void gtk_widget_set_events (GtkWidget *widget,
666 void gtk_widget_add_events (GtkWidget *widget,
668 void gtk_widget_set_device_events (GtkWidget *widget,
670 GdkEventMask events);
671 void gtk_widget_add_device_events (GtkWidget *widget,
673 GdkEventMask events);
674 void gtk_widget_set_extension_events (GtkWidget *widget,
675 GdkExtensionMode mode);
677 GdkExtensionMode gtk_widget_get_extension_events (GtkWidget *widget);
678 GtkWidget* gtk_widget_get_toplevel (GtkWidget *widget);
679 GtkWidget* gtk_widget_get_ancestor (GtkWidget *widget,
681 GdkVisual* gtk_widget_get_visual (GtkWidget *widget);
682 void gtk_widget_set_visual (GtkWidget *widget,
685 GdkScreen * gtk_widget_get_screen (GtkWidget *widget);
686 gboolean gtk_widget_has_screen (GtkWidget *widget);
687 GdkDisplay * gtk_widget_get_display (GtkWidget *widget);
688 GdkWindow * gtk_widget_get_root_window (GtkWidget *widget);
689 GtkSettings* gtk_widget_get_settings (GtkWidget *widget);
690 GtkClipboard *gtk_widget_get_clipboard (GtkWidget *widget,
694 /* Expand flags and related support */
695 gboolean gtk_widget_get_hexpand (GtkWidget *widget);
696 void gtk_widget_set_hexpand (GtkWidget *widget,
698 gboolean gtk_widget_get_hexpand_set (GtkWidget *widget);
699 void gtk_widget_set_hexpand_set (GtkWidget *widget,
701 gboolean gtk_widget_get_vexpand (GtkWidget *widget);
702 void gtk_widget_set_vexpand (GtkWidget *widget,
704 gboolean gtk_widget_get_vexpand_set (GtkWidget *widget);
705 void gtk_widget_set_vexpand_set (GtkWidget *widget,
707 void gtk_widget_queue_compute_expand (GtkWidget *widget);
708 gboolean gtk_widget_compute_expand (GtkWidget *widget,
709 GtkOrientation orientation);
712 /* Multidevice support */
713 gboolean gtk_widget_get_support_multidevice (GtkWidget *widget);
714 void gtk_widget_set_support_multidevice (GtkWidget *widget,
715 gboolean support_multidevice);
717 /* Accessibility support */
718 AtkObject* gtk_widget_get_accessible (GtkWidget *widget);
721 /* Margin and alignment */
722 GtkAlign gtk_widget_get_halign (GtkWidget *widget);
723 void gtk_widget_set_halign (GtkWidget *widget,
725 GtkAlign gtk_widget_get_valign (GtkWidget *widget);
726 void gtk_widget_set_valign (GtkWidget *widget,
728 gint gtk_widget_get_margin_left (GtkWidget *widget);
729 void gtk_widget_set_margin_left (GtkWidget *widget,
731 gint gtk_widget_get_margin_right (GtkWidget *widget);
732 void gtk_widget_set_margin_right (GtkWidget *widget,
734 gint gtk_widget_get_margin_top (GtkWidget *widget);
735 void gtk_widget_set_margin_top (GtkWidget *widget,
737 gint gtk_widget_get_margin_bottom (GtkWidget *widget);
738 void gtk_widget_set_margin_bottom (GtkWidget *widget,
742 gint gtk_widget_get_events (GtkWidget *widget);
743 GdkEventMask gtk_widget_get_device_events (GtkWidget *widget,
745 void gtk_widget_get_pointer (GtkWidget *widget,
749 gboolean gtk_widget_is_ancestor (GtkWidget *widget,
750 GtkWidget *ancestor);
752 gboolean gtk_widget_translate_coordinates (GtkWidget *src_widget,
753 GtkWidget *dest_widget,
759 /* Hide widget and return TRUE.
761 gboolean gtk_widget_hide_on_delete (GtkWidget *widget);
763 /* Functions to override widget styling */
764 void gtk_widget_override_color (GtkWidget *widget,
766 const GdkRGBA *color);
767 void gtk_widget_override_background_color (GtkWidget *widget,
769 const GdkRGBA *color);
771 void gtk_widget_override_font (GtkWidget *widget,
772 const PangoFontDescription *font_desc);
774 void gtk_widget_override_symbolic_color (GtkWidget *widget,
776 const GdkRGBA *color);
777 void gtk_widget_override_cursor (GtkWidget *widget,
778 const GdkRGBA *cursor,
779 const GdkRGBA *secondary_cursor);
782 void gtk_widget_style_attach (GtkWidget *widget);
784 #if !defined(GTK_DISABLE_DEPRECATED) || defined(GTK_COMPILATION)
788 gboolean gtk_widget_has_rc_style (GtkWidget *widget);
789 void gtk_widget_set_style (GtkWidget *widget,
791 void gtk_widget_ensure_style (GtkWidget *widget);
792 GtkStyle * gtk_widget_get_style (GtkWidget *widget);
794 void gtk_widget_modify_style (GtkWidget *widget,
796 GtkRcStyle *gtk_widget_get_modifier_style (GtkWidget *widget);
797 void gtk_widget_modify_fg (GtkWidget *widget,
799 const GdkColor *color);
800 void gtk_widget_modify_bg (GtkWidget *widget,
802 const GdkColor *color);
803 void gtk_widget_modify_text (GtkWidget *widget,
805 const GdkColor *color);
806 void gtk_widget_modify_base (GtkWidget *widget,
808 const GdkColor *color);
809 void gtk_widget_modify_cursor (GtkWidget *widget,
810 const GdkColor *primary,
811 const GdkColor *secondary);
812 void gtk_widget_modify_font (GtkWidget *widget,
813 PangoFontDescription *font_desc);
815 /* Descend recursively and set rc-style on all widgets without user styles */
816 void gtk_widget_reset_rc_styles (GtkWidget *widget);
817 void gtk_widget_reset_style (GtkWidget *widget);
819 /* Set certain default values to be used at widget creation time */
820 GtkStyle* gtk_widget_get_default_style (void);
822 /* Compute a widget's path in the form "GtkWindow.MyLabel", and
823 * return newly alocated strings.
825 void gtk_widget_path (GtkWidget *widget,
828 gchar **path_reversed);
829 void gtk_widget_class_path (GtkWidget *widget,
832 gchar **path_reversed);
834 #endif /* GTK_DISABLE_DEPRECATED */
836 PangoContext *gtk_widget_create_pango_context (GtkWidget *widget);
837 PangoContext *gtk_widget_get_pango_context (GtkWidget *widget);
838 PangoLayout *gtk_widget_create_pango_layout (GtkWidget *widget,
841 GdkPixbuf *gtk_widget_render_icon (GtkWidget *widget,
842 const gchar *stock_id,
844 const gchar *detail);
846 /* handle composite names for GTK_COMPOSITE_CHILD widgets,
847 * the returned name is newly allocated.
849 void gtk_widget_set_composite_name (GtkWidget *widget,
851 gchar* gtk_widget_get_composite_name (GtkWidget *widget);
853 /* Push/pop pairs, to change default values upon a widget's creation.
854 * This will override the values that got set by the
855 * gtk_widget_set_default_* () functions.
857 void gtk_widget_push_composite_child (void);
858 void gtk_widget_pop_composite_child (void);
860 /* widget style properties
862 void gtk_widget_class_install_style_property (GtkWidgetClass *klass,
864 void gtk_widget_class_install_style_property_parser (GtkWidgetClass *klass,
866 GtkRcPropertyParser parser);
867 GParamSpec* gtk_widget_class_find_style_property (GtkWidgetClass *klass,
868 const gchar *property_name);
869 GParamSpec** gtk_widget_class_list_style_properties (GtkWidgetClass *klass,
870 guint *n_properties);
871 void gtk_widget_style_get_property (GtkWidget *widget,
872 const gchar *property_name,
874 void gtk_widget_style_get_valist (GtkWidget *widget,
875 const gchar *first_property_name,
877 void gtk_widget_style_get (GtkWidget *widget,
878 const gchar *first_property_name,
879 ...) G_GNUC_NULL_TERMINATED;
881 /* Functions for setting directionality for widgets */
883 void gtk_widget_set_direction (GtkWidget *widget,
884 GtkTextDirection dir);
885 GtkTextDirection gtk_widget_get_direction (GtkWidget *widget);
887 void gtk_widget_set_default_direction (GtkTextDirection dir);
888 GtkTextDirection gtk_widget_get_default_direction (void);
890 /* Compositing manager functionality */
891 gboolean gtk_widget_is_composited (GtkWidget *widget);
893 /* Counterpart to gdk_window_shape_combine_region.
895 void gtk_widget_shape_combine_region (GtkWidget *widget,
896 cairo_region_t *region);
897 void gtk_widget_input_shape_combine_region (GtkWidget *widget,
898 cairo_region_t *region);
900 /* internal function */
901 void gtk_widget_reset_shapes (GtkWidget *widget);
903 GList* gtk_widget_list_mnemonic_labels (GtkWidget *widget);
904 void gtk_widget_add_mnemonic_label (GtkWidget *widget,
906 void gtk_widget_remove_mnemonic_label (GtkWidget *widget,
909 void gtk_widget_set_tooltip_window (GtkWidget *widget,
910 GtkWindow *custom_window);
911 GtkWindow *gtk_widget_get_tooltip_window (GtkWidget *widget);
912 void gtk_widget_trigger_tooltip_query (GtkWidget *widget);
913 void gtk_widget_set_tooltip_text (GtkWidget *widget,
915 gchar * gtk_widget_get_tooltip_text (GtkWidget *widget);
916 void gtk_widget_set_tooltip_markup (GtkWidget *widget,
917 const gchar *markup);
918 gchar * gtk_widget_get_tooltip_markup (GtkWidget *widget);
919 void gtk_widget_set_has_tooltip (GtkWidget *widget,
920 gboolean has_tooltip);
921 gboolean gtk_widget_get_has_tooltip (GtkWidget *widget);
923 gboolean gtk_cairo_should_draw_window (cairo_t *cr,
925 void gtk_cairo_transform_to_window (cairo_t *cr,
929 GType gtk_requisition_get_type (void) G_GNUC_CONST;
930 GtkRequisition *gtk_requisition_new (void) G_GNUC_MALLOC;
931 GtkRequisition *gtk_requisition_copy (const GtkRequisition *requisition);
932 void gtk_requisition_free (GtkRequisition *requisition);
934 GdkEventExpose * _gtk_cairo_get_event (cairo_t *cr);
936 void _gtk_widget_draw_internal (GtkWidget *widget,
938 gboolean clip_to_size);
939 void _gtk_widget_set_has_default (GtkWidget *widget,
940 gboolean has_default);
941 void _gtk_widget_set_has_grab (GtkWidget *widget,
943 void _gtk_widget_set_is_toplevel (GtkWidget *widget,
944 gboolean is_toplevel);
946 void _gtk_widget_grab_notify (GtkWidget *widget,
947 gboolean was_grabbed);
949 GtkWidgetAuxInfo *_gtk_widget_get_aux_info (GtkWidget *widget,
951 void _gtk_widget_propagate_hierarchy_changed (GtkWidget *widget,
952 GtkWidget *previous_toplevel);
953 void _gtk_widget_propagate_screen_changed (GtkWidget *widget,
954 GdkScreen *previous_screen);
955 void _gtk_widget_propagate_composited_changed (GtkWidget *widget);
957 void _gtk_widget_set_device_window (GtkWidget *widget,
959 GdkWindow *pointer_window);
960 GdkWindow *_gtk_widget_get_device_window (GtkWidget *widget,
962 GList * _gtk_widget_list_devices (GtkWidget *widget);
964 void _gtk_widget_synthesize_crossing (GtkWidget *from,
967 GdkCrossingMode mode);
969 gpointer _gtk_widget_peek_request_cache (GtkWidget *widget);
971 void _gtk_widget_buildable_finish_accelerator (GtkWidget *widget,
975 gboolean gtk_widget_in_destruction (GtkWidget *widget);
977 GtkStyleContext * gtk_widget_get_style_context (GtkWidget *widget);
979 GtkWidgetPath * gtk_widget_get_path (GtkWidget *widget);
984 #endif /* __GTK_WIDGET_H__ */