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/.
29 #include <gdk/gdkkeysyms.h>
30 #include "gtkbindings.h"
31 #include "gtkextendedlayout.h"
32 #include "gtkmarshalers.h"
33 #include "gtkscrolledwindow.h"
34 #include "gtkwindow.h"
35 #include "gtkprivate.h"
40 /* scrolled window policy and size requisition handling:
42 * gtk size requisition works as follows:
43 * a widget upon size-request reports the width and height that it finds
44 * to be best suited to display its contents, including children.
45 * the width and/or height reported from a widget upon size requisition
46 * may be overidden by the user by specifying a width and/or height
47 * other than 0 through gtk_widget_set_size_request().
49 * a scrolled window needs (for implementing all three policy types) to
50 * request its width and height based on two different rationales.
51 * 1) the user wants the scrolled window to just fit into the space
52 * that it gets allocated for a specifc dimension.
53 * 1.1) this does not apply if the user specified a concrete value
54 * value for that specific dimension by either specifying usize for the
55 * scrolled window or for its child.
56 * 2) the user wants the scrolled window to take as much space up as
57 * is desired by the child for a specifc dimension (i.e. POLICY_NEVER).
59 * also, kinda obvious:
60 * 3) a user would certainly not have choosen a scrolled window as a container
61 * for the child, if the resulting allocation takes up more space than the
62 * child would have allocated without the scrolled window.
65 * A) from 1) follows: the scrolled window shouldn't request more space for a
66 * specifc dimension than is required at minimum.
67 * B) from 1.1) follows: the requisition may be overidden by usize of the scrolled
68 * window (done automatically) or by usize of the child (needs to be checked).
69 * C) from 2) follows: for POLICY_NEVER, the scrolled window simply reports the
71 * D) from 3) follows: the scrolled window child's minimum width and minimum height
72 * under A) at least correspond to the space taken up by its scrollbars.
75 #define DEFAULT_SCROLLBAR_SPACING 3
78 gboolean window_placement_set;
79 GtkCornerType real_window_placement;
80 } GtkScrolledWindowPrivate;
82 #define GTK_SCROLLED_WINDOW_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_SCROLLED_WINDOW, GtkScrolledWindowPrivate))
88 PROP_HSCROLLBAR_POLICY,
89 PROP_VSCROLLBAR_POLICY,
90 PROP_WINDOW_PLACEMENT,
91 PROP_WINDOW_PLACEMENT_SET,
103 static void gtk_scrolled_window_destroy (GtkObject *object);
104 static void gtk_scrolled_window_set_property (GObject *object,
108 static void gtk_scrolled_window_get_property (GObject *object,
113 static void gtk_scrolled_window_screen_changed (GtkWidget *widget,
114 GdkScreen *previous_screen);
115 static gboolean gtk_scrolled_window_expose (GtkWidget *widget,
116 GdkEventExpose *event);
117 static void gtk_scrolled_window_size_allocate (GtkWidget *widget,
118 GtkAllocation *allocation);
119 static gboolean gtk_scrolled_window_scroll_event (GtkWidget *widget,
120 GdkEventScroll *event);
121 static gboolean gtk_scrolled_window_focus (GtkWidget *widget,
122 GtkDirectionType direction);
123 static void gtk_scrolled_window_add (GtkContainer *container,
125 static void gtk_scrolled_window_remove (GtkContainer *container,
127 static void gtk_scrolled_window_forall (GtkContainer *container,
128 gboolean include_internals,
129 GtkCallback callback,
130 gpointer callback_data);
131 static gboolean gtk_scrolled_window_scroll_child (GtkScrolledWindow *scrolled_window,
132 GtkScrollType scroll,
133 gboolean horizontal);
134 static void gtk_scrolled_window_move_focus_out (GtkScrolledWindow *scrolled_window,
135 GtkDirectionType direction_type);
137 static void gtk_scrolled_window_relative_allocation(GtkWidget *widget,
138 GtkAllocation *allocation);
139 static void gtk_scrolled_window_adjustment_changed (GtkAdjustment *adjustment,
142 static void gtk_scrolled_window_update_real_placement (GtkScrolledWindow *scrolled_window);
144 static void gtk_scrolled_window_extended_layout_init (GtkExtendedLayoutIface *iface);
146 static guint signals[LAST_SIGNAL] = {0};
148 G_DEFINE_TYPE_WITH_CODE (GtkScrolledWindow, gtk_scrolled_window, GTK_TYPE_BIN,
149 G_IMPLEMENT_INTERFACE (GTK_TYPE_EXTENDED_LAYOUT,
150 gtk_scrolled_window_extended_layout_init))
154 add_scroll_binding (GtkBindingSet *binding_set,
156 GdkModifierType mask,
157 GtkScrollType scroll,
160 guint keypad_keyval = keyval - GDK_Left + GDK_KP_Left;
162 gtk_binding_entry_add_signal (binding_set, keyval, mask,
164 GTK_TYPE_SCROLL_TYPE, scroll,
165 G_TYPE_BOOLEAN, horizontal);
166 gtk_binding_entry_add_signal (binding_set, keypad_keyval, mask,
168 GTK_TYPE_SCROLL_TYPE, scroll,
169 G_TYPE_BOOLEAN, horizontal);
173 add_tab_bindings (GtkBindingSet *binding_set,
174 GdkModifierType modifiers,
175 GtkDirectionType direction)
177 gtk_binding_entry_add_signal (binding_set, GDK_Tab, modifiers,
179 GTK_TYPE_DIRECTION_TYPE, direction);
180 gtk_binding_entry_add_signal (binding_set, GDK_KP_Tab, modifiers,
182 GTK_TYPE_DIRECTION_TYPE, direction);
186 gtk_scrolled_window_class_init (GtkScrolledWindowClass *class)
188 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
189 GtkObjectClass *object_class;
190 GtkWidgetClass *widget_class;
191 GtkContainerClass *container_class;
192 GtkBindingSet *binding_set;
194 object_class = (GtkObjectClass*) class;
195 widget_class = (GtkWidgetClass*) class;
196 container_class = (GtkContainerClass*) class;
198 gobject_class->set_property = gtk_scrolled_window_set_property;
199 gobject_class->get_property = gtk_scrolled_window_get_property;
201 object_class->destroy = gtk_scrolled_window_destroy;
203 widget_class->screen_changed = gtk_scrolled_window_screen_changed;
204 widget_class->expose_event = gtk_scrolled_window_expose;
205 widget_class->size_allocate = gtk_scrolled_window_size_allocate;
206 widget_class->scroll_event = gtk_scrolled_window_scroll_event;
207 widget_class->focus = gtk_scrolled_window_focus;
209 container_class->add = gtk_scrolled_window_add;
210 container_class->remove = gtk_scrolled_window_remove;
211 container_class->forall = gtk_scrolled_window_forall;
213 class->scrollbar_spacing = -1;
215 class->scroll_child = gtk_scrolled_window_scroll_child;
216 class->move_focus_out = gtk_scrolled_window_move_focus_out;
218 g_object_class_install_property (gobject_class,
220 g_param_spec_object ("hadjustment",
221 P_("Horizontal Adjustment"),
222 P_("The GtkAdjustment for the horizontal position"),
224 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
225 g_object_class_install_property (gobject_class,
227 g_param_spec_object ("vadjustment",
228 P_("Vertical Adjustment"),
229 P_("The GtkAdjustment for the vertical position"),
231 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
232 g_object_class_install_property (gobject_class,
233 PROP_HSCROLLBAR_POLICY,
234 g_param_spec_enum ("hscrollbar-policy",
235 P_("Horizontal Scrollbar Policy"),
236 P_("When the horizontal scrollbar is displayed"),
237 GTK_TYPE_POLICY_TYPE,
239 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
240 g_object_class_install_property (gobject_class,
241 PROP_VSCROLLBAR_POLICY,
242 g_param_spec_enum ("vscrollbar-policy",
243 P_("Vertical Scrollbar Policy"),
244 P_("When the vertical scrollbar is displayed"),
245 GTK_TYPE_POLICY_TYPE,
247 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
249 g_object_class_install_property (gobject_class,
250 PROP_WINDOW_PLACEMENT,
251 g_param_spec_enum ("window-placement",
252 P_("Window Placement"),
253 P_("Where the contents are located with respect to the scrollbars. This property only takes effect if \"window-placement-set\" is TRUE."),
254 GTK_TYPE_CORNER_TYPE,
256 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
259 * GtkScrolledWindow:window-placement-set:
261 * Whether "window-placement" should be used to determine the location
262 * of the contents with respect to the scrollbars. Otherwise, the
263 * "gtk-scrolled-window-placement" setting is used.
267 g_object_class_install_property (gobject_class,
268 PROP_WINDOW_PLACEMENT_SET,
269 g_param_spec_boolean ("window-placement-set",
270 P_("Window Placement Set"),
271 P_("Whether \"window-placement\" should be used to determine the location of the contents with respect to the scrollbars."),
273 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
274 g_object_class_install_property (gobject_class,
276 g_param_spec_enum ("shadow-type",
278 P_("Style of bevel around the contents"),
279 GTK_TYPE_SHADOW_TYPE,
281 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
284 * GtkScrolledWindow:scrollbars-within-bevel:
286 * Whether to place scrollbars within the scrolled window's bevel.
290 gtk_widget_class_install_style_property (widget_class,
291 g_param_spec_boolean ("scrollbars-within-bevel",
292 P_("Scrollbars within bevel"),
293 P_("Place scrollbars within the scrolled window's bevel"),
295 GTK_PARAM_READABLE));
297 gtk_widget_class_install_style_property (widget_class,
298 g_param_spec_int ("scrollbar-spacing",
299 P_("Scrollbar spacing"),
300 P_("Number of pixels between the scrollbars and the scrolled window"),
303 DEFAULT_SCROLLBAR_SPACING,
304 GTK_PARAM_READABLE));
307 * GtkSettings:gtk-scrolled-window-placement:
309 * Where the contents of scrolled windows are located with respect to the
310 * scrollbars, if not overridden by the scrolled window's own placement.
314 gtk_settings_install_property (g_param_spec_enum ("gtk-scrolled-window-placement",
315 P_("Scrolled Window Placement"),
316 P_("Where the contents of scrolled windows are located with respect to the scrollbars, if not overridden by the scrolled window's own placement."),
317 GTK_TYPE_CORNER_TYPE,
319 G_PARAM_READABLE | G_PARAM_WRITABLE));
322 signals[SCROLL_CHILD] =
323 g_signal_new (I_("scroll-child"),
324 G_TYPE_FROM_CLASS (object_class),
325 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
326 G_STRUCT_OFFSET (GtkScrolledWindowClass, scroll_child),
328 _gtk_marshal_BOOLEAN__ENUM_BOOLEAN,
330 GTK_TYPE_SCROLL_TYPE,
332 signals[MOVE_FOCUS_OUT] =
333 g_signal_new (I_("move-focus-out"),
334 G_TYPE_FROM_CLASS (object_class),
335 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
336 G_STRUCT_OFFSET (GtkScrolledWindowClass, move_focus_out),
338 _gtk_marshal_VOID__ENUM,
340 GTK_TYPE_DIRECTION_TYPE);
342 binding_set = gtk_binding_set_by_class (class);
344 add_scroll_binding (binding_set, GDK_Left, GDK_CONTROL_MASK, GTK_SCROLL_STEP_BACKWARD, TRUE);
345 add_scroll_binding (binding_set, GDK_Right, GDK_CONTROL_MASK, GTK_SCROLL_STEP_FORWARD, TRUE);
346 add_scroll_binding (binding_set, GDK_Up, GDK_CONTROL_MASK, GTK_SCROLL_STEP_BACKWARD, FALSE);
347 add_scroll_binding (binding_set, GDK_Down, GDK_CONTROL_MASK, GTK_SCROLL_STEP_FORWARD, FALSE);
349 add_scroll_binding (binding_set, GDK_Page_Up, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_BACKWARD, TRUE);
350 add_scroll_binding (binding_set, GDK_Page_Down, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_FORWARD, TRUE);
351 add_scroll_binding (binding_set, GDK_Page_Up, 0, GTK_SCROLL_PAGE_BACKWARD, FALSE);
352 add_scroll_binding (binding_set, GDK_Page_Down, 0, GTK_SCROLL_PAGE_FORWARD, FALSE);
354 add_scroll_binding (binding_set, GDK_Home, GDK_CONTROL_MASK, GTK_SCROLL_START, TRUE);
355 add_scroll_binding (binding_set, GDK_End, GDK_CONTROL_MASK, GTK_SCROLL_END, TRUE);
356 add_scroll_binding (binding_set, GDK_Home, 0, GTK_SCROLL_START, FALSE);
357 add_scroll_binding (binding_set, GDK_End, 0, GTK_SCROLL_END, FALSE);
359 add_tab_bindings (binding_set, GDK_CONTROL_MASK, GTK_DIR_TAB_FORWARD);
360 add_tab_bindings (binding_set, GDK_CONTROL_MASK | GDK_SHIFT_MASK, GTK_DIR_TAB_BACKWARD);
362 g_type_class_add_private (class, sizeof (GtkScrolledWindowPrivate));
366 gtk_scrolled_window_init (GtkScrolledWindow *scrolled_window)
368 gtk_widget_set_has_window (GTK_WIDGET (scrolled_window), FALSE);
369 gtk_widget_set_can_focus (GTK_WIDGET (scrolled_window), TRUE);
371 scrolled_window->hscrollbar = NULL;
372 scrolled_window->vscrollbar = NULL;
373 scrolled_window->hscrollbar_policy = GTK_POLICY_ALWAYS;
374 scrolled_window->vscrollbar_policy = GTK_POLICY_ALWAYS;
375 scrolled_window->hscrollbar_visible = FALSE;
376 scrolled_window->vscrollbar_visible = FALSE;
377 scrolled_window->focus_out = FALSE;
378 scrolled_window->window_placement = GTK_CORNER_TOP_LEFT;
379 gtk_scrolled_window_update_real_placement (scrolled_window);
383 * gtk_scrolled_window_new:
384 * @hadjustment: (allow-none): horizontal adjustment
385 * @vadjustment: (allow-none): vertical adjustment
387 * Creates a new scrolled window.
389 * The two arguments are the scrolled window's adjustments; these will be
390 * shared with the scrollbars and the child widget to keep the bars in sync
391 * with the child. Usually you want to pass %NULL for the adjustments, which
392 * will cause the scrolled window to create them for you.
394 * Returns: a new scrolled window
397 gtk_scrolled_window_new (GtkAdjustment *hadjustment,
398 GtkAdjustment *vadjustment)
400 GtkWidget *scrolled_window;
403 g_return_val_if_fail (GTK_IS_ADJUSTMENT (hadjustment), NULL);
406 g_return_val_if_fail (GTK_IS_ADJUSTMENT (vadjustment), NULL);
408 scrolled_window = g_object_new (GTK_TYPE_SCROLLED_WINDOW,
409 "hadjustment", hadjustment,
410 "vadjustment", vadjustment,
413 return scrolled_window;
417 * gtk_scrolled_window_set_hadjustment:
418 * @scrolled_window: a #GtkScrolledWindow
419 * @hadjustment: horizontal scroll adjustment
421 * Sets the #GtkAdjustment for the horizontal scrollbar.
424 gtk_scrolled_window_set_hadjustment (GtkScrolledWindow *scrolled_window,
425 GtkAdjustment *hadjustment)
429 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
431 g_return_if_fail (GTK_IS_ADJUSTMENT (hadjustment));
433 hadjustment = (GtkAdjustment*) g_object_new (GTK_TYPE_ADJUSTMENT, NULL);
435 bin = GTK_BIN (scrolled_window);
437 if (!scrolled_window->hscrollbar)
439 gtk_widget_push_composite_child ();
440 scrolled_window->hscrollbar = gtk_hscrollbar_new (hadjustment);
441 gtk_widget_set_composite_name (scrolled_window->hscrollbar, "hscrollbar");
442 gtk_widget_pop_composite_child ();
444 gtk_widget_set_parent (scrolled_window->hscrollbar, GTK_WIDGET (scrolled_window));
445 g_object_ref (scrolled_window->hscrollbar);
446 gtk_widget_show (scrolled_window->hscrollbar);
450 GtkAdjustment *old_adjustment;
452 old_adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
453 if (old_adjustment == hadjustment)
456 g_signal_handlers_disconnect_by_func (old_adjustment,
457 gtk_scrolled_window_adjustment_changed,
459 gtk_range_set_adjustment (GTK_RANGE (scrolled_window->hscrollbar),
462 hadjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
463 g_signal_connect (hadjustment,
465 G_CALLBACK (gtk_scrolled_window_adjustment_changed),
467 gtk_scrolled_window_adjustment_changed (hadjustment, scrolled_window);
470 gtk_widget_set_scroll_adjustments (bin->child,
471 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
472 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)));
474 g_object_notify (G_OBJECT (scrolled_window), "hadjustment");
478 * gtk_scrolled_window_set_vadjustment:
479 * @scrolled_window: a #GtkScrolledWindow
480 * @vadjustment: vertical scroll adjustment
482 * Sets the #GtkAdjustment for the vertical scrollbar.
485 gtk_scrolled_window_set_vadjustment (GtkScrolledWindow *scrolled_window,
486 GtkAdjustment *vadjustment)
490 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
492 g_return_if_fail (GTK_IS_ADJUSTMENT (vadjustment));
494 vadjustment = (GtkAdjustment*) g_object_new (GTK_TYPE_ADJUSTMENT, NULL);
496 bin = GTK_BIN (scrolled_window);
498 if (!scrolled_window->vscrollbar)
500 gtk_widget_push_composite_child ();
501 scrolled_window->vscrollbar = gtk_vscrollbar_new (vadjustment);
502 gtk_widget_set_composite_name (scrolled_window->vscrollbar, "vscrollbar");
503 gtk_widget_pop_composite_child ();
505 gtk_widget_set_parent (scrolled_window->vscrollbar, GTK_WIDGET (scrolled_window));
506 g_object_ref (scrolled_window->vscrollbar);
507 gtk_widget_show (scrolled_window->vscrollbar);
511 GtkAdjustment *old_adjustment;
513 old_adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
514 if (old_adjustment == vadjustment)
517 g_signal_handlers_disconnect_by_func (old_adjustment,
518 gtk_scrolled_window_adjustment_changed,
520 gtk_range_set_adjustment (GTK_RANGE (scrolled_window->vscrollbar),
523 vadjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
524 g_signal_connect (vadjustment,
526 G_CALLBACK (gtk_scrolled_window_adjustment_changed),
528 gtk_scrolled_window_adjustment_changed (vadjustment, scrolled_window);
531 gtk_widget_set_scroll_adjustments (bin->child,
532 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
533 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)));
535 g_object_notify (G_OBJECT (scrolled_window), "vadjustment");
539 * gtk_scrolled_window_get_hadjustment:
540 * @scrolled_window: a #GtkScrolledWindow
542 * Returns the horizontal scrollbar's adjustment, used to connect the
543 * horizontal scrollbar to the child widget's horizontal scroll
546 * Returns: the horizontal #GtkAdjustment
549 gtk_scrolled_window_get_hadjustment (GtkScrolledWindow *scrolled_window)
551 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
553 return (scrolled_window->hscrollbar ?
554 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)) :
559 * gtk_scrolled_window_get_vadjustment:
560 * @scrolled_window: a #GtkScrolledWindow
562 * Returns the vertical scrollbar's adjustment, used to connect the
563 * vertical scrollbar to the child widget's vertical scroll
566 * Returns: the vertical #GtkAdjustment
569 gtk_scrolled_window_get_vadjustment (GtkScrolledWindow *scrolled_window)
571 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
573 return (scrolled_window->vscrollbar ?
574 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)) :
579 * gtk_scrolled_window_get_hscrollbar:
580 * @scrolled_window: a #GtkScrolledWindow
582 * Returns the horizontal scrollbar of @scrolled_window.
584 * Returns: the horizontal scrollbar of the scrolled window, or
585 * %NULL if it does not have one.
590 gtk_scrolled_window_get_hscrollbar (GtkScrolledWindow *scrolled_window)
592 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
594 return scrolled_window->hscrollbar;
598 * gtk_scrolled_window_get_vscrollbar:
599 * @scrolled_window: a #GtkScrolledWindow
601 * Returns the vertical scrollbar of @scrolled_window.
603 * Returns: the vertical scrollbar of the scrolled window, or
604 * %NULL if it does not have one.
609 gtk_scrolled_window_get_vscrollbar (GtkScrolledWindow *scrolled_window)
611 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
613 return scrolled_window->vscrollbar;
617 * gtk_scrolled_window_set_policy:
618 * @scrolled_window: a #GtkScrolledWindow
619 * @hscrollbar_policy: policy for horizontal bar
620 * @vscrollbar_policy: policy for vertical bar
622 * Sets the scrollbar policy for the horizontal and vertical scrollbars.
624 * The policy determines when the scrollbar should appear; it is a value
625 * from the #GtkPolicyType enumeration. If %GTK_POLICY_ALWAYS, the
626 * scrollbar is always present; if %GTK_POLICY_NEVER, the scrollbar is
627 * never present; if %GTK_POLICY_AUTOMATIC, the scrollbar is present only
628 * if needed (that is, if the slider part of the bar would be smaller
629 * than the trough - the display is larger than the page size).
632 gtk_scrolled_window_set_policy (GtkScrolledWindow *scrolled_window,
633 GtkPolicyType hscrollbar_policy,
634 GtkPolicyType vscrollbar_policy)
636 GObject *object = G_OBJECT (scrolled_window);
638 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
640 if ((scrolled_window->hscrollbar_policy != hscrollbar_policy) ||
641 (scrolled_window->vscrollbar_policy != vscrollbar_policy))
643 scrolled_window->hscrollbar_policy = hscrollbar_policy;
644 scrolled_window->vscrollbar_policy = vscrollbar_policy;
646 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
648 g_object_freeze_notify (object);
649 g_object_notify (object, "hscrollbar-policy");
650 g_object_notify (object, "vscrollbar-policy");
651 g_object_thaw_notify (object);
656 * gtk_scrolled_window_get_policy:
657 * @scrolled_window: a #GtkScrolledWindow
658 * @hscrollbar_policy: location to store the policy for the horizontal
659 * scrollbar, or %NULL.
660 * @vscrollbar_policy: location to store the policy for the vertical
661 * scrollbar, or %NULL.
663 * Retrieves the current policy values for the horizontal and vertical
664 * scrollbars. See gtk_scrolled_window_set_policy().
667 gtk_scrolled_window_get_policy (GtkScrolledWindow *scrolled_window,
668 GtkPolicyType *hscrollbar_policy,
669 GtkPolicyType *vscrollbar_policy)
671 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
673 if (hscrollbar_policy)
674 *hscrollbar_policy = scrolled_window->hscrollbar_policy;
675 if (vscrollbar_policy)
676 *vscrollbar_policy = scrolled_window->vscrollbar_policy;
680 gtk_scrolled_window_update_real_placement (GtkScrolledWindow *scrolled_window)
682 GtkScrolledWindowPrivate *priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
683 GtkSettings *settings;
685 settings = gtk_widget_get_settings (GTK_WIDGET (scrolled_window));
687 if (priv->window_placement_set || settings == NULL)
688 priv->real_window_placement = scrolled_window->window_placement;
690 g_object_get (settings,
691 "gtk-scrolled-window-placement",
692 &priv->real_window_placement,
697 gtk_scrolled_window_set_placement_internal (GtkScrolledWindow *scrolled_window,
698 GtkCornerType window_placement)
700 if (scrolled_window->window_placement != window_placement)
702 scrolled_window->window_placement = window_placement;
704 gtk_scrolled_window_update_real_placement (scrolled_window);
705 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
707 g_object_notify (G_OBJECT (scrolled_window), "window-placement");
712 gtk_scrolled_window_set_placement_set (GtkScrolledWindow *scrolled_window,
713 gboolean placement_set,
714 gboolean emit_resize)
716 GtkScrolledWindowPrivate *priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
718 if (priv->window_placement_set != placement_set)
720 priv->window_placement_set = placement_set;
722 gtk_scrolled_window_update_real_placement (scrolled_window);
724 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
726 g_object_notify (G_OBJECT (scrolled_window), "window-placement-set");
731 * gtk_scrolled_window_set_placement:
732 * @scrolled_window: a #GtkScrolledWindow
733 * @window_placement: position of the child window
735 * Sets the placement of the contents with respect to the scrollbars
736 * for the scrolled window.
738 * The default is %GTK_CORNER_TOP_LEFT, meaning the child is
739 * in the top left, with the scrollbars underneath and to the right.
740 * Other values in #GtkCornerType are %GTK_CORNER_TOP_RIGHT,
741 * %GTK_CORNER_BOTTOM_LEFT, and %GTK_CORNER_BOTTOM_RIGHT.
743 * See also gtk_scrolled_window_get_placement() and
744 * gtk_scrolled_window_unset_placement().
747 gtk_scrolled_window_set_placement (GtkScrolledWindow *scrolled_window,
748 GtkCornerType window_placement)
750 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
752 gtk_scrolled_window_set_placement_set (scrolled_window, TRUE, FALSE);
753 gtk_scrolled_window_set_placement_internal (scrolled_window, window_placement);
757 * gtk_scrolled_window_get_placement:
758 * @scrolled_window: a #GtkScrolledWindow
760 * Gets the placement of the contents with respect to the scrollbars
761 * for the scrolled window. See gtk_scrolled_window_set_placement().
763 * Return value: the current placement value.
765 * See also gtk_scrolled_window_set_placement() and
766 * gtk_scrolled_window_unset_placement().
769 gtk_scrolled_window_get_placement (GtkScrolledWindow *scrolled_window)
771 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), GTK_CORNER_TOP_LEFT);
773 return scrolled_window->window_placement;
777 * gtk_scrolled_window_unset_placement:
778 * @scrolled_window: a #GtkScrolledWindow
780 * Unsets the placement of the contents with respect to the scrollbars
781 * for the scrolled window. If no window placement is set for a scrolled
782 * window, it obeys the "gtk-scrolled-window-placement" XSETTING.
784 * See also gtk_scrolled_window_set_placement() and
785 * gtk_scrolled_window_get_placement().
790 gtk_scrolled_window_unset_placement (GtkScrolledWindow *scrolled_window)
792 GtkScrolledWindowPrivate *priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
794 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
796 if (priv->window_placement_set)
798 priv->window_placement_set = FALSE;
800 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
802 g_object_notify (G_OBJECT (scrolled_window), "window-placement-set");
807 * gtk_scrolled_window_set_shadow_type:
808 * @scrolled_window: a #GtkScrolledWindow
809 * @type: kind of shadow to draw around scrolled window contents
811 * Changes the type of shadow drawn around the contents of
816 gtk_scrolled_window_set_shadow_type (GtkScrolledWindow *scrolled_window,
819 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
820 g_return_if_fail (type >= GTK_SHADOW_NONE && type <= GTK_SHADOW_ETCHED_OUT);
822 if (scrolled_window->shadow_type != type)
824 scrolled_window->shadow_type = type;
826 if (gtk_widget_is_drawable (GTK_WIDGET (scrolled_window)))
827 gtk_widget_queue_draw (GTK_WIDGET (scrolled_window));
829 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
831 g_object_notify (G_OBJECT (scrolled_window), "shadow-type");
836 * gtk_scrolled_window_get_shadow_type:
837 * @scrolled_window: a #GtkScrolledWindow
839 * Gets the shadow type of the scrolled window. See
840 * gtk_scrolled_window_set_shadow_type().
842 * Return value: the current shadow type
845 gtk_scrolled_window_get_shadow_type (GtkScrolledWindow *scrolled_window)
847 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), GTK_SHADOW_NONE);
849 return scrolled_window->shadow_type;
853 gtk_scrolled_window_destroy (GtkObject *object)
855 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
857 if (scrolled_window->hscrollbar)
859 g_signal_handlers_disconnect_by_func (gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
860 gtk_scrolled_window_adjustment_changed,
862 gtk_widget_unparent (scrolled_window->hscrollbar);
863 gtk_widget_destroy (scrolled_window->hscrollbar);
864 g_object_unref (scrolled_window->hscrollbar);
865 scrolled_window->hscrollbar = NULL;
867 if (scrolled_window->vscrollbar)
869 g_signal_handlers_disconnect_by_func (gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)),
870 gtk_scrolled_window_adjustment_changed,
872 gtk_widget_unparent (scrolled_window->vscrollbar);
873 gtk_widget_destroy (scrolled_window->vscrollbar);
874 g_object_unref (scrolled_window->vscrollbar);
875 scrolled_window->vscrollbar = NULL;
878 GTK_OBJECT_CLASS (gtk_scrolled_window_parent_class)->destroy (object);
882 gtk_scrolled_window_set_property (GObject *object,
887 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
891 case PROP_HADJUSTMENT:
892 gtk_scrolled_window_set_hadjustment (scrolled_window,
893 g_value_get_object (value));
895 case PROP_VADJUSTMENT:
896 gtk_scrolled_window_set_vadjustment (scrolled_window,
897 g_value_get_object (value));
899 case PROP_HSCROLLBAR_POLICY:
900 gtk_scrolled_window_set_policy (scrolled_window,
901 g_value_get_enum (value),
902 scrolled_window->vscrollbar_policy);
904 case PROP_VSCROLLBAR_POLICY:
905 gtk_scrolled_window_set_policy (scrolled_window,
906 scrolled_window->hscrollbar_policy,
907 g_value_get_enum (value));
909 case PROP_WINDOW_PLACEMENT:
910 gtk_scrolled_window_set_placement_internal (scrolled_window,
911 g_value_get_enum (value));
913 case PROP_WINDOW_PLACEMENT_SET:
914 gtk_scrolled_window_set_placement_set (scrolled_window,
915 g_value_get_boolean (value),
918 case PROP_SHADOW_TYPE:
919 gtk_scrolled_window_set_shadow_type (scrolled_window,
920 g_value_get_enum (value));
923 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
929 gtk_scrolled_window_get_property (GObject *object,
934 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
935 GtkScrolledWindowPrivate *priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
939 case PROP_HADJUSTMENT:
940 g_value_set_object (value,
941 G_OBJECT (gtk_scrolled_window_get_hadjustment (scrolled_window)));
943 case PROP_VADJUSTMENT:
944 g_value_set_object (value,
945 G_OBJECT (gtk_scrolled_window_get_vadjustment (scrolled_window)));
947 case PROP_HSCROLLBAR_POLICY:
948 g_value_set_enum (value, scrolled_window->hscrollbar_policy);
950 case PROP_VSCROLLBAR_POLICY:
951 g_value_set_enum (value, scrolled_window->vscrollbar_policy);
953 case PROP_WINDOW_PLACEMENT:
954 g_value_set_enum (value, scrolled_window->window_placement);
956 case PROP_WINDOW_PLACEMENT_SET:
957 g_value_set_boolean (value, priv->window_placement_set);
959 case PROP_SHADOW_TYPE:
960 g_value_set_enum (value, scrolled_window->shadow_type);
963 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
969 traverse_container (GtkWidget *widget,
972 if (GTK_IS_SCROLLED_WINDOW (widget))
974 gtk_scrolled_window_update_real_placement (GTK_SCROLLED_WINDOW (widget));
975 gtk_widget_queue_resize (widget);
977 else if (GTK_IS_CONTAINER (widget))
978 gtk_container_forall (GTK_CONTAINER (widget), traverse_container, NULL);
982 gtk_scrolled_window_settings_changed (GtkSettings *settings)
986 list = gtk_window_list_toplevels ();
988 for (l = list; l; l = l->next)
989 gtk_container_forall (GTK_CONTAINER (l->data),
990 traverse_container, NULL);
996 gtk_scrolled_window_screen_changed (GtkWidget *widget,
997 GdkScreen *previous_screen)
999 GtkSettings *settings;
1000 guint window_placement_connection;
1002 gtk_scrolled_window_update_real_placement (GTK_SCROLLED_WINDOW (widget));
1004 if (!gtk_widget_has_screen (widget))
1007 settings = gtk_widget_get_settings (widget);
1009 window_placement_connection =
1010 GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (settings),
1011 "gtk-scrolled-window-connection"));
1013 if (window_placement_connection)
1016 window_placement_connection =
1017 g_signal_connect (settings, "notify::gtk-scrolled-window-placement",
1018 G_CALLBACK (gtk_scrolled_window_settings_changed), NULL);
1019 g_object_set_data (G_OBJECT (settings),
1020 I_("gtk-scrolled-window-connection"),
1021 GUINT_TO_POINTER (window_placement_connection));
1025 gtk_scrolled_window_paint (GtkWidget *widget,
1028 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (widget);
1030 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1032 GtkAllocation relative_allocation;
1033 gboolean scrollbars_within_bevel;
1035 gtk_widget_style_get (widget, "scrollbars-within-bevel", &scrollbars_within_bevel, NULL);
1037 if (!scrollbars_within_bevel)
1039 gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
1041 relative_allocation.x -= widget->style->xthickness;
1042 relative_allocation.y -= widget->style->ythickness;
1043 relative_allocation.width += 2 * widget->style->xthickness;
1044 relative_allocation.height += 2 * widget->style->ythickness;
1048 GtkContainer *container = GTK_CONTAINER (widget);
1050 relative_allocation.x = container->border_width;
1051 relative_allocation.y = container->border_width;
1052 relative_allocation.width = widget->allocation.width - 2 * container->border_width;
1053 relative_allocation.height = widget->allocation.height - 2 * container->border_width;
1056 gtk_paint_shadow (widget->style, widget->window,
1057 GTK_STATE_NORMAL, scrolled_window->shadow_type,
1058 area, widget, "scrolled_window",
1059 widget->allocation.x + relative_allocation.x,
1060 widget->allocation.y + relative_allocation.y,
1061 relative_allocation.width,
1062 relative_allocation.height);
1067 gtk_scrolled_window_expose (GtkWidget *widget,
1068 GdkEventExpose *event)
1070 if (gtk_widget_is_drawable (widget))
1072 gtk_scrolled_window_paint (widget, &event->area);
1074 GTK_WIDGET_CLASS (gtk_scrolled_window_parent_class)->expose_event (widget, event);
1081 gtk_scrolled_window_forall (GtkContainer *container,
1082 gboolean include_internals,
1083 GtkCallback callback,
1084 gpointer callback_data)
1086 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (container));
1087 g_return_if_fail (callback != NULL);
1089 GTK_CONTAINER_CLASS (gtk_scrolled_window_parent_class)->forall (container,
1093 if (include_internals)
1095 GtkScrolledWindow *scrolled_window;
1097 scrolled_window = GTK_SCROLLED_WINDOW (container);
1099 if (scrolled_window->vscrollbar)
1100 callback (scrolled_window->vscrollbar, callback_data);
1101 if (scrolled_window->hscrollbar)
1102 callback (scrolled_window->hscrollbar, callback_data);
1107 gtk_scrolled_window_scroll_child (GtkScrolledWindow *scrolled_window,
1108 GtkScrollType scroll,
1109 gboolean horizontal)
1111 GtkAdjustment *adjustment = NULL;
1115 case GTK_SCROLL_STEP_UP:
1116 scroll = GTK_SCROLL_STEP_BACKWARD;
1119 case GTK_SCROLL_STEP_DOWN:
1120 scroll = GTK_SCROLL_STEP_FORWARD;
1123 case GTK_SCROLL_STEP_LEFT:
1124 scroll = GTK_SCROLL_STEP_BACKWARD;
1127 case GTK_SCROLL_STEP_RIGHT:
1128 scroll = GTK_SCROLL_STEP_FORWARD;
1131 case GTK_SCROLL_PAGE_UP:
1132 scroll = GTK_SCROLL_PAGE_BACKWARD;
1135 case GTK_SCROLL_PAGE_DOWN:
1136 scroll = GTK_SCROLL_PAGE_FORWARD;
1139 case GTK_SCROLL_PAGE_LEFT:
1140 scroll = GTK_SCROLL_STEP_BACKWARD;
1143 case GTK_SCROLL_PAGE_RIGHT:
1144 scroll = GTK_SCROLL_STEP_FORWARD;
1147 case GTK_SCROLL_STEP_BACKWARD:
1148 case GTK_SCROLL_STEP_FORWARD:
1149 case GTK_SCROLL_PAGE_BACKWARD:
1150 case GTK_SCROLL_PAGE_FORWARD:
1151 case GTK_SCROLL_START:
1152 case GTK_SCROLL_END:
1155 g_warning ("Invalid scroll type %u for GtkScrolledWindow::scroll-child", scroll);
1159 if ((horizontal && (!scrolled_window->hscrollbar || !scrolled_window->hscrollbar_visible)) ||
1160 (!horizontal && (!scrolled_window->vscrollbar || !scrolled_window->vscrollbar_visible)))
1165 if (scrolled_window->hscrollbar)
1166 adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
1170 if (scrolled_window->vscrollbar)
1171 adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
1176 gdouble value = adjustment->value;
1180 case GTK_SCROLL_STEP_FORWARD:
1181 value += adjustment->step_increment;
1183 case GTK_SCROLL_STEP_BACKWARD:
1184 value -= adjustment->step_increment;
1186 case GTK_SCROLL_PAGE_FORWARD:
1187 value += adjustment->page_increment;
1189 case GTK_SCROLL_PAGE_BACKWARD:
1190 value -= adjustment->page_increment;
1192 case GTK_SCROLL_START:
1193 value = adjustment->lower;
1195 case GTK_SCROLL_END:
1196 value = adjustment->upper;
1199 g_assert_not_reached ();
1203 value = CLAMP (value, adjustment->lower, adjustment->upper - adjustment->page_size);
1205 gtk_adjustment_set_value (adjustment, value);
1214 gtk_scrolled_window_move_focus_out (GtkScrolledWindow *scrolled_window,
1215 GtkDirectionType direction_type)
1217 GtkWidget *toplevel;
1219 /* Focus out of the scrolled window entirely. We do this by setting
1220 * a flag, then propagating the focus motion to the notebook.
1222 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (scrolled_window));
1223 if (!gtk_widget_is_toplevel (toplevel))
1226 g_object_ref (scrolled_window);
1228 scrolled_window->focus_out = TRUE;
1229 g_signal_emit_by_name (toplevel, "move-focus", direction_type);
1230 scrolled_window->focus_out = FALSE;
1232 g_object_unref (scrolled_window);
1236 gtk_scrolled_window_relative_allocation (GtkWidget *widget,
1237 GtkAllocation *allocation)
1239 GtkScrolledWindow *scrolled_window;
1240 GtkScrolledWindowPrivate *priv;
1241 gint scrollbar_spacing;
1243 g_return_if_fail (widget != NULL);
1244 g_return_if_fail (allocation != NULL);
1246 scrolled_window = GTK_SCROLLED_WINDOW (widget);
1247 scrollbar_spacing = _gtk_scrolled_window_get_scrollbar_spacing (scrolled_window);
1249 priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
1251 allocation->x = GTK_CONTAINER (widget)->border_width;
1252 allocation->y = GTK_CONTAINER (widget)->border_width;
1254 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1256 allocation->x += widget->style->xthickness;
1257 allocation->y += widget->style->ythickness;
1260 allocation->width = MAX (1, (gint)widget->allocation.width - allocation->x * 2);
1261 allocation->height = MAX (1, (gint)widget->allocation.height - allocation->y * 2);
1263 if (scrolled_window->vscrollbar_visible)
1265 GtkRequisition vscrollbar_requisition;
1268 gtk_widget_get_child_requisition (scrolled_window->vscrollbar,
1269 &vscrollbar_requisition);
1270 is_rtl = gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL;
1273 (priv->real_window_placement == GTK_CORNER_TOP_RIGHT ||
1274 priv->real_window_placement == GTK_CORNER_BOTTOM_RIGHT)) ||
1276 (priv->real_window_placement == GTK_CORNER_TOP_LEFT ||
1277 priv->real_window_placement == GTK_CORNER_BOTTOM_LEFT)))
1278 allocation->x += (vscrollbar_requisition.width + scrollbar_spacing);
1280 allocation->width = MAX (1, allocation->width - (vscrollbar_requisition.width + scrollbar_spacing));
1282 if (scrolled_window->hscrollbar_visible)
1284 GtkRequisition hscrollbar_requisition;
1285 gtk_widget_get_child_requisition (scrolled_window->hscrollbar,
1286 &hscrollbar_requisition);
1288 if (priv->real_window_placement == GTK_CORNER_BOTTOM_LEFT ||
1289 priv->real_window_placement == GTK_CORNER_BOTTOM_RIGHT)
1290 allocation->y += (hscrollbar_requisition.height + scrollbar_spacing);
1292 allocation->height = MAX (1, allocation->height - (hscrollbar_requisition.height + scrollbar_spacing));
1297 gtk_scrolled_window_size_allocate (GtkWidget *widget,
1298 GtkAllocation *allocation)
1300 GtkScrolledWindow *scrolled_window;
1301 GtkScrolledWindowPrivate *priv;
1303 GtkAllocation relative_allocation;
1304 GtkAllocation child_allocation;
1305 gboolean scrollbars_within_bevel;
1306 gint scrollbar_spacing;
1308 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (widget));
1309 g_return_if_fail (allocation != NULL);
1311 scrolled_window = GTK_SCROLLED_WINDOW (widget);
1312 bin = GTK_BIN (scrolled_window);
1314 scrollbar_spacing = _gtk_scrolled_window_get_scrollbar_spacing (scrolled_window);
1315 gtk_widget_style_get (widget, "scrollbars-within-bevel", &scrollbars_within_bevel, NULL);
1317 priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
1319 widget->allocation = *allocation;
1321 if (scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS)
1322 scrolled_window->hscrollbar_visible = TRUE;
1323 else if (scrolled_window->hscrollbar_policy == GTK_POLICY_NEVER)
1324 scrolled_window->hscrollbar_visible = FALSE;
1325 if (scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS)
1326 scrolled_window->vscrollbar_visible = TRUE;
1327 else if (scrolled_window->vscrollbar_policy == GTK_POLICY_NEVER)
1328 scrolled_window->vscrollbar_visible = FALSE;
1330 if (bin->child && gtk_widget_get_visible (bin->child))
1332 gboolean previous_hvis;
1333 gboolean previous_vvis;
1338 gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
1340 child_allocation.x = relative_allocation.x + allocation->x;
1341 child_allocation.y = relative_allocation.y + allocation->y;
1342 child_allocation.width = relative_allocation.width;
1343 child_allocation.height = relative_allocation.height;
1345 previous_hvis = scrolled_window->hscrollbar_visible;
1346 previous_vvis = scrolled_window->vscrollbar_visible;
1348 gtk_widget_size_allocate (bin->child, &child_allocation);
1350 /* If, after the first iteration, the hscrollbar and the
1351 * vscrollbar flip visiblity, then we need both.
1354 previous_hvis != scrolled_window->hscrollbar_visible &&
1355 previous_vvis != scrolled_window->vscrollbar_visible)
1357 scrolled_window->hscrollbar_visible = TRUE;
1358 scrolled_window->vscrollbar_visible = TRUE;
1360 /* a new resize is already queued at this point,
1361 * so we will immediatedly get reinvoked
1368 while (previous_hvis != scrolled_window->hscrollbar_visible ||
1369 previous_vvis != scrolled_window->vscrollbar_visible);
1373 scrolled_window->hscrollbar_visible = scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS;
1374 scrolled_window->vscrollbar_visible = scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS;
1375 gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
1378 if (scrolled_window->hscrollbar_visible)
1380 GtkRequisition hscrollbar_requisition;
1381 gtk_widget_get_child_requisition (scrolled_window->hscrollbar,
1382 &hscrollbar_requisition);
1384 if (!gtk_widget_get_visible (scrolled_window->hscrollbar))
1385 gtk_widget_show (scrolled_window->hscrollbar);
1387 child_allocation.x = relative_allocation.x;
1388 if (priv->real_window_placement == GTK_CORNER_TOP_LEFT ||
1389 priv->real_window_placement == GTK_CORNER_TOP_RIGHT)
1390 child_allocation.y = (relative_allocation.y +
1391 relative_allocation.height +
1393 (scrolled_window->shadow_type == GTK_SHADOW_NONE ?
1394 0 : widget->style->ythickness));
1396 child_allocation.y = GTK_CONTAINER (scrolled_window)->border_width;
1398 child_allocation.width = relative_allocation.width;
1399 child_allocation.height = hscrollbar_requisition.height;
1400 child_allocation.x += allocation->x;
1401 child_allocation.y += allocation->y;
1403 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1405 if (!scrollbars_within_bevel)
1407 child_allocation.x -= widget->style->xthickness;
1408 child_allocation.width += 2 * widget->style->xthickness;
1410 else if (GTK_CORNER_TOP_RIGHT == priv->real_window_placement ||
1411 GTK_CORNER_TOP_LEFT == priv->real_window_placement)
1413 child_allocation.y -= widget->style->ythickness;
1417 child_allocation.y += widget->style->ythickness;
1421 gtk_widget_size_allocate (scrolled_window->hscrollbar, &child_allocation);
1423 else if (gtk_widget_get_visible (scrolled_window->hscrollbar))
1424 gtk_widget_hide (scrolled_window->hscrollbar);
1426 if (scrolled_window->vscrollbar_visible)
1428 GtkRequisition vscrollbar_requisition;
1429 if (!gtk_widget_get_visible (scrolled_window->vscrollbar))
1430 gtk_widget_show (scrolled_window->vscrollbar);
1432 gtk_widget_get_child_requisition (scrolled_window->vscrollbar,
1433 &vscrollbar_requisition);
1435 if ((gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL &&
1436 (priv->real_window_placement == GTK_CORNER_TOP_RIGHT ||
1437 priv->real_window_placement == GTK_CORNER_BOTTOM_RIGHT)) ||
1438 (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR &&
1439 (priv->real_window_placement == GTK_CORNER_TOP_LEFT ||
1440 priv->real_window_placement == GTK_CORNER_BOTTOM_LEFT)))
1441 child_allocation.x = (relative_allocation.x +
1442 relative_allocation.width +
1444 (scrolled_window->shadow_type == GTK_SHADOW_NONE ?
1445 0 : widget->style->xthickness));
1447 child_allocation.x = GTK_CONTAINER (scrolled_window)->border_width;
1449 child_allocation.y = relative_allocation.y;
1450 child_allocation.width = vscrollbar_requisition.width;
1451 child_allocation.height = relative_allocation.height;
1452 child_allocation.x += allocation->x;
1453 child_allocation.y += allocation->y;
1455 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1457 if (!scrollbars_within_bevel)
1459 child_allocation.y -= widget->style->ythickness;
1460 child_allocation.height += 2 * widget->style->ythickness;
1462 else if (GTK_CORNER_BOTTOM_LEFT == priv->real_window_placement ||
1463 GTK_CORNER_TOP_LEFT == priv->real_window_placement)
1465 child_allocation.x -= widget->style->xthickness;
1469 child_allocation.x += widget->style->xthickness;
1473 gtk_widget_size_allocate (scrolled_window->vscrollbar, &child_allocation);
1475 else if (gtk_widget_get_visible (scrolled_window->vscrollbar))
1476 gtk_widget_hide (scrolled_window->vscrollbar);
1480 gtk_scrolled_window_scroll_event (GtkWidget *widget,
1481 GdkEventScroll *event)
1485 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (widget), FALSE);
1486 g_return_val_if_fail (event != NULL, FALSE);
1488 if (event->direction == GDK_SCROLL_UP || event->direction == GDK_SCROLL_DOWN)
1489 range = GTK_SCROLLED_WINDOW (widget)->vscrollbar;
1491 range = GTK_SCROLLED_WINDOW (widget)->hscrollbar;
1493 if (range && gtk_widget_get_visible (range))
1495 GtkAdjustment *adj = GTK_RANGE (range)->adjustment;
1496 gdouble delta, new_value;
1498 delta = _gtk_range_get_wheel_delta (GTK_RANGE (range), event->direction);
1500 new_value = CLAMP (adj->value + delta, adj->lower, adj->upper - adj->page_size);
1502 gtk_adjustment_set_value (adj, new_value);
1511 gtk_scrolled_window_focus (GtkWidget *widget,
1512 GtkDirectionType direction)
1514 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (widget);
1515 gboolean had_focus_child = GTK_CONTAINER (widget)->focus_child != NULL;
1517 if (scrolled_window->focus_out)
1519 scrolled_window->focus_out = FALSE; /* Clear this to catch the wrap-around case */
1523 if (gtk_widget_is_focus (widget))
1526 /* We only put the scrolled window itself in the focus chain if it
1527 * isn't possible to focus any children.
1529 if (GTK_BIN (widget)->child)
1531 if (gtk_widget_child_focus (GTK_BIN (widget)->child, direction))
1535 if (!had_focus_child && gtk_widget_get_can_focus (widget))
1537 gtk_widget_grab_focus (widget);
1545 gtk_scrolled_window_adjustment_changed (GtkAdjustment *adjustment,
1548 GtkScrolledWindow *scrolled_win;
1550 g_return_if_fail (adjustment != NULL);
1551 g_return_if_fail (data != NULL);
1553 scrolled_win = GTK_SCROLLED_WINDOW (data);
1555 if (scrolled_win->hscrollbar &&
1556 adjustment == gtk_range_get_adjustment (GTK_RANGE (scrolled_win->hscrollbar)))
1558 if (scrolled_win->hscrollbar_policy == GTK_POLICY_AUTOMATIC)
1562 visible = scrolled_win->hscrollbar_visible;
1563 scrolled_win->hscrollbar_visible = (adjustment->upper - adjustment->lower >
1564 adjustment->page_size);
1565 if (scrolled_win->hscrollbar_visible != visible)
1566 gtk_widget_queue_resize (GTK_WIDGET (scrolled_win));
1569 else if (scrolled_win->vscrollbar &&
1570 adjustment == gtk_range_get_adjustment (GTK_RANGE (scrolled_win->vscrollbar)))
1572 if (scrolled_win->vscrollbar_policy == GTK_POLICY_AUTOMATIC)
1576 visible = scrolled_win->vscrollbar_visible;
1577 scrolled_win->vscrollbar_visible = (adjustment->upper - adjustment->lower >
1578 adjustment->page_size);
1579 if (scrolled_win->vscrollbar_visible != visible)
1580 gtk_widget_queue_resize (GTK_WIDGET (scrolled_win));
1586 gtk_scrolled_window_add (GtkContainer *container,
1589 GtkScrolledWindow *scrolled_window;
1592 bin = GTK_BIN (container);
1593 g_return_if_fail (bin->child == NULL);
1595 scrolled_window = GTK_SCROLLED_WINDOW (container);
1598 gtk_widget_set_parent (child, GTK_WIDGET (bin));
1600 /* this is a temporary message */
1601 if (!gtk_widget_set_scroll_adjustments (child,
1602 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
1603 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar))))
1604 g_warning ("gtk_scrolled_window_add(): cannot add non scrollable widget "
1605 "use gtk_scrolled_window_add_with_viewport() instead");
1609 gtk_scrolled_window_remove (GtkContainer *container,
1612 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (container));
1613 g_return_if_fail (child != NULL);
1614 g_return_if_fail (GTK_BIN (container)->child == child);
1616 gtk_widget_set_scroll_adjustments (child, NULL, NULL);
1618 /* chain parent class handler to remove child */
1619 GTK_CONTAINER_CLASS (gtk_scrolled_window_parent_class)->remove (container, child);
1623 * gtk_scrolled_window_add_with_viewport:
1624 * @scrolled_window: a #GtkScrolledWindow
1625 * @child: the widget you want to scroll
1627 * Used to add children without native scrolling capabilities. This
1628 * is simply a convenience function; it is equivalent to adding the
1629 * unscrollable child to a viewport, then adding the viewport to the
1630 * scrolled window. If a child has native scrolling, use
1631 * gtk_container_add() instead of this function.
1633 * The viewport scrolls the child by moving its #GdkWindow, and takes
1634 * the size of the child to be the size of its toplevel #GdkWindow.
1635 * This will be very wrong for most widgets that support native scrolling;
1636 * for example, if you add a widget such as #GtkTreeView with a viewport,
1637 * the whole widget will scroll, including the column headings. Thus,
1638 * widgets with native scrolling support should not be used with the
1639 * #GtkViewport proxy.
1641 * A widget supports scrolling natively if the
1642 * set_scroll_adjustments_signal field in #GtkWidgetClass is non-zero,
1643 * i.e. has been filled in with a valid signal identifier.
1646 gtk_scrolled_window_add_with_viewport (GtkScrolledWindow *scrolled_window,
1650 GtkWidget *viewport;
1652 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
1653 g_return_if_fail (GTK_IS_WIDGET (child));
1654 g_return_if_fail (child->parent == NULL);
1656 bin = GTK_BIN (scrolled_window);
1658 if (bin->child != NULL)
1660 g_return_if_fail (GTK_IS_VIEWPORT (bin->child));
1661 g_return_if_fail (GTK_BIN (bin->child)->child == NULL);
1663 viewport = bin->child;
1668 gtk_viewport_new (gtk_scrolled_window_get_hadjustment (scrolled_window),
1669 gtk_scrolled_window_get_vadjustment (scrolled_window));
1670 gtk_container_add (GTK_CONTAINER (scrolled_window), viewport);
1673 gtk_widget_show (viewport);
1674 gtk_container_add (GTK_CONTAINER (viewport), child);
1678 * _gtk_scrolled_window_get_spacing:
1679 * @scrolled_window: a scrolled window
1681 * Gets the spacing between the scrolled window's scrollbars and
1682 * the scrolled widget. Used by GtkCombo
1684 * Return value: the spacing, in pixels.
1687 _gtk_scrolled_window_get_scrollbar_spacing (GtkScrolledWindow *scrolled_window)
1689 GtkScrolledWindowClass *class;
1691 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), 0);
1693 class = GTK_SCROLLED_WINDOW_GET_CLASS (scrolled_window);
1695 if (class->scrollbar_spacing >= 0)
1696 return class->scrollbar_spacing;
1699 gint scrollbar_spacing;
1701 gtk_widget_style_get (GTK_WIDGET (scrolled_window),
1702 "scrollbar-spacing", &scrollbar_spacing,
1705 return scrollbar_spacing;
1710 gtk_scrolled_window_extended_layout_get_desired_size (GtkExtendedLayout *layout,
1711 GtkRequisition *minimum_size,
1712 GtkRequisition *natural_size)
1714 GtkScrolledWindow *scrolled_window;
1718 gint scrollbar_spacing;
1719 GtkRequisition hscrollbar_requisition;
1720 GtkRequisition vscrollbar_requisition;
1721 GtkRequisition min_child_requisition;
1722 GtkRequisition nat_child_requisition;
1724 scrolled_window = GTK_SCROLLED_WINDOW (layout);
1725 bin = GTK_BIN (scrolled_window);
1727 scrollbar_spacing = _gtk_scrolled_window_get_scrollbar_spacing (scrolled_window);
1731 minimum_size->width = 0;
1732 minimum_size->height = 0;
1733 natural_size->width = 0;
1734 natural_size->height = 0;
1736 gtk_widget_size_request (scrolled_window->hscrollbar,
1737 &hscrollbar_requisition);
1738 gtk_widget_size_request (scrolled_window->vscrollbar,
1739 &vscrollbar_requisition);
1741 if (bin->child && gtk_widget_get_visible (bin->child))
1743 gtk_extended_layout_get_desired_size (GTK_EXTENDED_LAYOUT (bin->child),
1744 &min_child_requisition,
1745 &nat_child_requisition);
1747 if (scrolled_window->hscrollbar_policy == GTK_POLICY_NEVER)
1749 minimum_size->width += min_child_requisition.width;
1750 natural_size->width += nat_child_requisition.width;
1754 GtkWidgetAuxInfo *aux_info = _gtk_widget_get_aux_info (bin->child, FALSE);
1756 if (aux_info && aux_info->width > 0)
1758 minimum_size->width += aux_info->width;
1759 natural_size->width += aux_info->width;
1764 minimum_size->width += vscrollbar_requisition.width;
1765 natural_size->width += vscrollbar_requisition.width;
1769 if (scrolled_window->vscrollbar_policy == GTK_POLICY_NEVER)
1771 minimum_size->height += min_child_requisition.height;
1772 natural_size->height += nat_child_requisition.height;
1776 GtkWidgetAuxInfo *aux_info = _gtk_widget_get_aux_info (bin->child, FALSE);
1778 if (aux_info && aux_info->height > 0)
1780 minimum_size->height += aux_info->height;
1781 natural_size->height += aux_info->height;
1786 minimum_size->height += hscrollbar_requisition.height;
1787 natural_size->height += hscrollbar_requisition.height;
1792 if (scrolled_window->hscrollbar_policy == GTK_POLICY_AUTOMATIC ||
1793 scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS)
1795 minimum_size->width = MAX (minimum_size->width, hscrollbar_requisition.width);
1796 natural_size->width = MAX (natural_size->width, hscrollbar_requisition.width);
1797 if (!extra_height || scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS)
1798 extra_height = scrollbar_spacing + hscrollbar_requisition.height;
1801 if (scrolled_window->vscrollbar_policy == GTK_POLICY_AUTOMATIC ||
1802 scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS)
1804 minimum_size->height = MAX (minimum_size->height, vscrollbar_requisition.height);
1805 natural_size->height = MAX (natural_size->height, vscrollbar_requisition.height);
1806 if (!extra_height || scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS)
1807 extra_width = scrollbar_spacing + vscrollbar_requisition.width;
1810 minimum_size->width += GTK_CONTAINER (layout)->border_width * 2 + MAX (0, extra_width);
1811 minimum_size->height += GTK_CONTAINER (layout)->border_width * 2 + MAX (0, extra_height);
1812 natural_size->width += GTK_CONTAINER (layout)->border_width * 2 + MAX (0, extra_width);
1813 natural_size->height += GTK_CONTAINER (layout)->border_width * 2 + MAX (0, extra_height);
1815 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1817 minimum_size->width += 2 * GTK_WIDGET (layout)->style->xthickness;
1818 minimum_size->height += 2 * GTK_WIDGET (layout)->style->ythickness;
1819 natural_size->width += 2 * GTK_WIDGET (layout)->style->xthickness;
1820 natural_size->height += 2 * GTK_WIDGET (layout)->style->ythickness;
1825 gtk_scrolled_window_extended_layout_get_height_for_width (GtkExtendedLayout *layout,
1827 gint *minimum_height,
1828 gint *natural_height)
1830 GtkRequisition minimum_size;
1831 GtkRequisition natural_size;
1833 g_return_if_fail (GTK_IS_WIDGET (layout));
1836 TODO: integrate height-for-width with size-groups
1838 gtk_extended_layout_get_desired_size (layout,
1839 minimum_height ? &minimum_size : NULL,
1840 natural_height ? &natural_size : NULL);
1843 *minimum_height = minimum_size.height;
1845 *natural_height = natural_size.height;
1850 gtk_scrolled_window_extended_layout_get_width_for_height (GtkExtendedLayout *layout,
1852 gint *minimum_width,
1853 gint *natural_width)
1855 GtkRequisition minimum_size;
1856 GtkRequisition natural_size;
1858 g_return_if_fail (GTK_IS_WIDGET (layout));
1861 TODO: integrate width-for-height with size-groups
1863 gtk_extended_layout_get_desired_size (layout,
1864 minimum_width ? &minimum_size : NULL,
1865 natural_width ? &natural_size : NULL);
1868 *minimum_width = minimum_size.width;
1870 *natural_width = natural_size.width;
1875 gtk_scrolled_window_extended_layout_init (GtkExtendedLayoutIface *iface)
1877 iface->get_desired_size = gtk_scrolled_window_extended_layout_get_desired_size;
1878 iface->get_width_for_height = gtk_scrolled_window_extended_layout_get_width_for_height;
1879 iface->get_height_for_width = gtk_scrolled_window_extended_layout_get_height_for_width;
1882 #define __GTK_SCROLLED_WINDOW_C__
1883 #include "gtkaliasdef.c"