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/.
31 #include "gtkbindings.h"
32 #include "gtkmarshalers.h"
33 #include "gtkscrollable.h"
34 #include "gtkscrolledwindow.h"
35 #include "gtkwindow.h"
36 #include "gtkprivate.h"
37 #include "gtktypebuiltins.h"
42 * SECTION:gtkscrolledwindow
43 * @Short_description: Adds scrollbars to its child widget
44 * @Title: GtkScrolledWindow
45 * @See_also: #GtkScrollable, #GtkViewport, #GtkAdjustment
47 * #GtkScrolledWindow is a #GtkBin subclass: it's a container
48 * the accepts a single child widget. #GtkScrolledWindow adds scrollbars
49 * to the child widget and optionally draws a beveled frame around the
52 * The scrolled window can work in two ways. Some widgets have native
53 * scrolling support; these widgets implement the #GtkScrollable interface.
54 * Widgets with native scroll support include #GtkTreeView, #GtkTextView,
57 * For widgets that lack native scrolling support, the #GtkViewport
58 * widget acts as an adaptor class, implementing scrollability for child
59 * widgets that lack their own scrolling capabilities. Use #GtkViewport
60 * to scroll child widgets such as #GtkTable, #GtkBox, and so on.
62 * If a widget has native scrolling abilities, it can be added to the
63 * #GtkScrolledWindow with gtk_container_add(). If a widget does not, you
64 * must first add the widget to a #GtkViewport, then add the #GtkViewport
65 * to the scrolled window. The convenience function
66 * gtk_scrolled_window_add_with_viewport() does exactly this, so you can
67 * ignore the presence of the viewport.
69 * The position of the scrollbars is controlled by the scroll
70 * adjustments. See #GtkAdjustment for the fields in an adjustment - for
71 * #GtkScrollbar, used by #GtkScrolledWindow, the "value" field
72 * represents the position of the scrollbar, which must be between the
73 * "lower" field and "upper - page_size." The "page_size" field
74 * represents the size of the visible scrollable area. The
75 * "step_increment" and "page_increment" fields are used when the user
76 * asks to step down (using the small stepper arrows) or page down (using
77 * for example the PageDown key).
79 * If a #GtkScrolledWindow doesn't behave quite as you would like, or
80 * doesn't have exactly the right layout, it's very possible to set up
81 * your own scrolling with #GtkScrollbar and for example a #GtkTable.
85 /* scrolled window policy and size requisition handling:
87 * gtk size requisition works as follows:
88 * a widget upon size-request reports the width and height that it finds
89 * to be best suited to display its contents, including children.
90 * the width and/or height reported from a widget upon size requisition
91 * may be overidden by the user by specifying a width and/or height
92 * other than 0 through gtk_widget_set_size_request().
94 * a scrolled window needs (for implementing all three policy types) to
95 * request its width and height based on two different rationales.
96 * 1) the user wants the scrolled window to just fit into the space
97 * that it gets allocated for a specifc dimension.
98 * 1.1) this does not apply if the user specified a concrete value
99 * value for that specific dimension by either specifying usize for the
100 * scrolled window or for its child.
101 * 2) the user wants the scrolled window to take as much space up as
102 * is desired by the child for a specifc dimension (i.e. POLICY_NEVER).
104 * also, kinda obvious:
105 * 3) a user would certainly not have choosen a scrolled window as a container
106 * for the child, if the resulting allocation takes up more space than the
107 * child would have allocated without the scrolled window.
110 * A) from 1) follows: the scrolled window shouldn't request more space for a
111 * specifc dimension than is required at minimum.
112 * B) from 1.1) follows: the requisition may be overidden by usize of the scrolled
113 * window (done automatically) or by usize of the child (needs to be checked).
114 * C) from 2) follows: for POLICY_NEVER, the scrolled window simply reports the
116 * D) from 3) follows: the scrolled window child's minimum width and minimum height
117 * under A) at least correspond to the space taken up by its scrollbars.
120 #define DEFAULT_SCROLLBAR_SPACING 3
122 struct _GtkScrolledWindowPrivate
124 GtkCornerType real_window_placement;
125 GtkWidget *hscrollbar;
126 GtkWidget *vscrollbar;
128 gboolean window_placement_set;
132 guint hscrollbar_policy : 2;
133 guint vscrollbar_policy : 2;
134 guint hscrollbar_visible : 1;
135 guint vscrollbar_visible : 1;
136 guint window_placement : 2;
137 guint focus_out : 1; /* Flag used by ::move-focus-out implementation */
139 gint min_content_width;
140 gint min_content_height;
148 PROP_HSCROLLBAR_POLICY,
149 PROP_VSCROLLBAR_POLICY,
150 PROP_WINDOW_PLACEMENT,
151 PROP_WINDOW_PLACEMENT_SET,
153 PROP_MIN_CONTENT_WIDTH,
154 PROP_MIN_CONTENT_HEIGHT
165 static void gtk_scrolled_window_set_property (GObject *object,
169 static void gtk_scrolled_window_get_property (GObject *object,
174 static void gtk_scrolled_window_destroy (GtkWidget *widget);
175 static void gtk_scrolled_window_screen_changed (GtkWidget *widget,
176 GdkScreen *previous_screen);
177 static gboolean gtk_scrolled_window_draw (GtkWidget *widget,
179 static void gtk_scrolled_window_size_allocate (GtkWidget *widget,
180 GtkAllocation *allocation);
181 static gboolean gtk_scrolled_window_scroll_event (GtkWidget *widget,
182 GdkEventScroll *event);
183 static gboolean gtk_scrolled_window_focus (GtkWidget *widget,
184 GtkDirectionType direction);
185 static void gtk_scrolled_window_add (GtkContainer *container,
187 static void gtk_scrolled_window_remove (GtkContainer *container,
189 static void gtk_scrolled_window_forall (GtkContainer *container,
190 gboolean include_internals,
191 GtkCallback callback,
192 gpointer callback_data);
193 static gboolean gtk_scrolled_window_scroll_child (GtkScrolledWindow *scrolled_window,
194 GtkScrollType scroll,
195 gboolean horizontal);
196 static void gtk_scrolled_window_move_focus_out (GtkScrolledWindow *scrolled_window,
197 GtkDirectionType direction_type);
199 static void gtk_scrolled_window_relative_allocation(GtkWidget *widget,
200 GtkAllocation *allocation);
201 static void gtk_scrolled_window_adjustment_changed (GtkAdjustment *adjustment,
204 static void gtk_scrolled_window_update_real_placement (GtkScrolledWindow *scrolled_window);
206 static void gtk_scrolled_window_get_preferred_width (GtkWidget *widget,
209 static void gtk_scrolled_window_get_preferred_height (GtkWidget *widget,
212 static void gtk_scrolled_window_get_preferred_height_for_width (GtkWidget *layout,
214 gint *minimum_height,
215 gint *natural_height);
216 static void gtk_scrolled_window_get_preferred_width_for_height (GtkWidget *layout,
218 gint *minimum_height,
219 gint *natural_height);
221 static guint signals[LAST_SIGNAL] = {0};
223 G_DEFINE_TYPE (GtkScrolledWindow, gtk_scrolled_window, GTK_TYPE_BIN)
227 add_scroll_binding (GtkBindingSet *binding_set,
229 GdkModifierType mask,
230 GtkScrollType scroll,
233 guint keypad_keyval = keyval - GDK_KEY_Left + GDK_KEY_KP_Left;
235 gtk_binding_entry_add_signal (binding_set, keyval, mask,
237 GTK_TYPE_SCROLL_TYPE, scroll,
238 G_TYPE_BOOLEAN, horizontal);
239 gtk_binding_entry_add_signal (binding_set, keypad_keyval, mask,
241 GTK_TYPE_SCROLL_TYPE, scroll,
242 G_TYPE_BOOLEAN, horizontal);
246 add_tab_bindings (GtkBindingSet *binding_set,
247 GdkModifierType modifiers,
248 GtkDirectionType direction)
250 gtk_binding_entry_add_signal (binding_set, GDK_KEY_Tab, modifiers,
252 GTK_TYPE_DIRECTION_TYPE, direction);
253 gtk_binding_entry_add_signal (binding_set, GDK_KEY_KP_Tab, modifiers,
255 GTK_TYPE_DIRECTION_TYPE, direction);
259 gtk_scrolled_window_class_init (GtkScrolledWindowClass *class)
261 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
262 GtkWidgetClass *widget_class;
263 GtkContainerClass *container_class;
264 GtkBindingSet *binding_set;
266 widget_class = (GtkWidgetClass*) class;
267 container_class = (GtkContainerClass*) class;
269 gobject_class->set_property = gtk_scrolled_window_set_property;
270 gobject_class->get_property = gtk_scrolled_window_get_property;
272 widget_class->destroy = gtk_scrolled_window_destroy;
273 widget_class->screen_changed = gtk_scrolled_window_screen_changed;
274 widget_class->draw = gtk_scrolled_window_draw;
275 widget_class->size_allocate = gtk_scrolled_window_size_allocate;
276 widget_class->scroll_event = gtk_scrolled_window_scroll_event;
277 widget_class->focus = gtk_scrolled_window_focus;
278 widget_class->get_preferred_width = gtk_scrolled_window_get_preferred_width;
279 widget_class->get_preferred_height = gtk_scrolled_window_get_preferred_height;
280 widget_class->get_preferred_height_for_width = gtk_scrolled_window_get_preferred_height_for_width;
281 widget_class->get_preferred_width_for_height = gtk_scrolled_window_get_preferred_width_for_height;
283 container_class->add = gtk_scrolled_window_add;
284 container_class->remove = gtk_scrolled_window_remove;
285 container_class->forall = gtk_scrolled_window_forall;
286 gtk_container_class_handle_border_width (container_class);
288 class->scrollbar_spacing = -1;
290 class->scroll_child = gtk_scrolled_window_scroll_child;
291 class->move_focus_out = gtk_scrolled_window_move_focus_out;
293 g_object_class_install_property (gobject_class,
295 g_param_spec_object ("hadjustment",
296 P_("Horizontal Adjustment"),
297 P_("The GtkAdjustment for the horizontal position"),
299 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
300 g_object_class_install_property (gobject_class,
302 g_param_spec_object ("vadjustment",
303 P_("Vertical Adjustment"),
304 P_("The GtkAdjustment for the vertical position"),
306 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
307 g_object_class_install_property (gobject_class,
308 PROP_HSCROLLBAR_POLICY,
309 g_param_spec_enum ("hscrollbar-policy",
310 P_("Horizontal Scrollbar Policy"),
311 P_("When the horizontal scrollbar is displayed"),
312 GTK_TYPE_POLICY_TYPE,
313 GTK_POLICY_AUTOMATIC,
314 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
315 g_object_class_install_property (gobject_class,
316 PROP_VSCROLLBAR_POLICY,
317 g_param_spec_enum ("vscrollbar-policy",
318 P_("Vertical Scrollbar Policy"),
319 P_("When the vertical scrollbar is displayed"),
320 GTK_TYPE_POLICY_TYPE,
321 GTK_POLICY_AUTOMATIC,
322 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
324 g_object_class_install_property (gobject_class,
325 PROP_WINDOW_PLACEMENT,
326 g_param_spec_enum ("window-placement",
327 P_("Window Placement"),
328 P_("Where the contents are located with respect to the scrollbars. This property only takes effect if \"window-placement-set\" is TRUE."),
329 GTK_TYPE_CORNER_TYPE,
331 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
334 * GtkScrolledWindow:window-placement-set:
336 * Whether "window-placement" should be used to determine the location
337 * of the contents with respect to the scrollbars. Otherwise, the
338 * "gtk-scrolled-window-placement" setting is used.
342 g_object_class_install_property (gobject_class,
343 PROP_WINDOW_PLACEMENT_SET,
344 g_param_spec_boolean ("window-placement-set",
345 P_("Window Placement Set"),
346 P_("Whether \"window-placement\" should be used to determine the location of the contents with respect to the scrollbars."),
348 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
349 g_object_class_install_property (gobject_class,
351 g_param_spec_enum ("shadow-type",
353 P_("Style of bevel around the contents"),
354 GTK_TYPE_SHADOW_TYPE,
356 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
359 * GtkScrolledWindow:scrollbars-within-bevel:
361 * Whether to place scrollbars within the scrolled window's bevel.
365 gtk_widget_class_install_style_property (widget_class,
366 g_param_spec_boolean ("scrollbars-within-bevel",
367 P_("Scrollbars within bevel"),
368 P_("Place scrollbars within the scrolled window's bevel"),
370 GTK_PARAM_READABLE));
372 gtk_widget_class_install_style_property (widget_class,
373 g_param_spec_int ("scrollbar-spacing",
374 P_("Scrollbar spacing"),
375 P_("Number of pixels between the scrollbars and the scrolled window"),
378 DEFAULT_SCROLLBAR_SPACING,
379 GTK_PARAM_READABLE));
382 * GtkScrolledWindow:min-content-width:
384 * The minimum content width of @scrolled_window, or -1 if not set.
388 g_object_class_install_property (gobject_class,
389 PROP_MIN_CONTENT_WIDTH,
390 g_param_spec_int ("min-content-width",
391 P_("Minimum Content Width"),
392 P_("The minimum width that the scrolled window will allocate to its content"),
394 GTK_PARAM_READWRITE));
397 * GtkScrolledWindow:min-content-height:
399 * The minimum content height of @scrolled_window, or -1 if not set.
403 g_object_class_install_property (gobject_class,
404 PROP_MIN_CONTENT_HEIGHT,
405 g_param_spec_int ("min-content-height",
406 P_("Minimum Content Height"),
407 P_("The minimum height that the scrolled window will allocate to its content"),
409 GTK_PARAM_READWRITE));
411 * GtkScrolledWindow::scroll-child:
412 * @scrolled_window: a #GtkScrolledWindow
413 * @scroll: a #GtkScrollType describing how much to scroll
414 * @horizontal: whether the keybinding scrolls the child
415 * horizontally or not
417 * The ::scroll-child signal is a
418 * <link linkend="keybinding-signals">keybinding signal</link>
419 * which gets emitted when a keybinding that scrolls is pressed.
420 * The horizontal or vertical adjustment is updated which triggers a
421 * signal that the scrolled windows child may listen to and scroll itself.
423 signals[SCROLL_CHILD] =
424 g_signal_new (I_("scroll-child"),
425 G_TYPE_FROM_CLASS (gobject_class),
426 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
427 G_STRUCT_OFFSET (GtkScrolledWindowClass, scroll_child),
429 _gtk_marshal_BOOLEAN__ENUM_BOOLEAN,
431 GTK_TYPE_SCROLL_TYPE,
435 * GtkScrolledWindow::move-focus-out:
436 * @scrolled_window: a #GtkScrolledWindow
437 * @direction_type: either %GTK_DIR_TAB_FORWARD or
438 * %GTK_DIR_TAB_BACKWARD
440 * The ::move-focus-out signal is a
441 * <link linkend="keybinding-signals">keybinding signal</link>
442 * which gets emitted when focus is moved away from the scrolled
443 * window by a keybinding.
444 * The #GtkWidget::move-focus signal is emitted with @direction_type
445 * on this scrolled windows toplevel parent in the container hierarchy.
446 * The default bindings for this signal are
447 * <keycombo><keycap>Tab</keycap><keycap>Ctrl</keycap></keycombo>
449 * <keycombo><keycap>Tab</keycap><keycap>Ctrl</keycap><keycap>Shift</keycap></keycombo>.
451 signals[MOVE_FOCUS_OUT] =
452 g_signal_new (I_("move-focus-out"),
453 G_TYPE_FROM_CLASS (gobject_class),
454 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
455 G_STRUCT_OFFSET (GtkScrolledWindowClass, move_focus_out),
457 _gtk_marshal_VOID__ENUM,
459 GTK_TYPE_DIRECTION_TYPE);
461 binding_set = gtk_binding_set_by_class (class);
463 add_scroll_binding (binding_set, GDK_KEY_Left, GDK_CONTROL_MASK, GTK_SCROLL_STEP_BACKWARD, TRUE);
464 add_scroll_binding (binding_set, GDK_KEY_Right, GDK_CONTROL_MASK, GTK_SCROLL_STEP_FORWARD, TRUE);
465 add_scroll_binding (binding_set, GDK_KEY_Up, GDK_CONTROL_MASK, GTK_SCROLL_STEP_BACKWARD, FALSE);
466 add_scroll_binding (binding_set, GDK_KEY_Down, GDK_CONTROL_MASK, GTK_SCROLL_STEP_FORWARD, FALSE);
468 add_scroll_binding (binding_set, GDK_KEY_Page_Up, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_BACKWARD, TRUE);
469 add_scroll_binding (binding_set, GDK_KEY_Page_Down, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_FORWARD, TRUE);
470 add_scroll_binding (binding_set, GDK_KEY_Page_Up, 0, GTK_SCROLL_PAGE_BACKWARD, FALSE);
471 add_scroll_binding (binding_set, GDK_KEY_Page_Down, 0, GTK_SCROLL_PAGE_FORWARD, FALSE);
473 add_scroll_binding (binding_set, GDK_KEY_Home, GDK_CONTROL_MASK, GTK_SCROLL_START, TRUE);
474 add_scroll_binding (binding_set, GDK_KEY_End, GDK_CONTROL_MASK, GTK_SCROLL_END, TRUE);
475 add_scroll_binding (binding_set, GDK_KEY_Home, 0, GTK_SCROLL_START, FALSE);
476 add_scroll_binding (binding_set, GDK_KEY_End, 0, GTK_SCROLL_END, FALSE);
478 add_tab_bindings (binding_set, GDK_CONTROL_MASK, GTK_DIR_TAB_FORWARD);
479 add_tab_bindings (binding_set, GDK_CONTROL_MASK | GDK_SHIFT_MASK, GTK_DIR_TAB_BACKWARD);
481 g_type_class_add_private (class, sizeof (GtkScrolledWindowPrivate));
485 gtk_scrolled_window_init (GtkScrolledWindow *scrolled_window)
487 GtkScrolledWindowPrivate *priv;
489 scrolled_window->priv = priv = G_TYPE_INSTANCE_GET_PRIVATE (scrolled_window,
490 GTK_TYPE_SCROLLED_WINDOW,
491 GtkScrolledWindowPrivate);
493 gtk_widget_set_has_window (GTK_WIDGET (scrolled_window), FALSE);
494 gtk_widget_set_can_focus (GTK_WIDGET (scrolled_window), TRUE);
496 priv->hscrollbar = NULL;
497 priv->vscrollbar = NULL;
498 priv->hscrollbar_policy = GTK_POLICY_AUTOMATIC;
499 priv->vscrollbar_policy = GTK_POLICY_AUTOMATIC;
500 priv->hscrollbar_visible = FALSE;
501 priv->vscrollbar_visible = FALSE;
502 priv->focus_out = FALSE;
503 priv->window_placement = GTK_CORNER_TOP_LEFT;
504 gtk_scrolled_window_update_real_placement (scrolled_window);
505 priv->min_content_width = -1;
506 priv->min_content_height = -1;
510 * gtk_scrolled_window_new:
511 * @hadjustment: (allow-none): horizontal adjustment
512 * @vadjustment: (allow-none): vertical adjustment
514 * Creates a new scrolled window.
516 * The two arguments are the scrolled window's adjustments; these will be
517 * shared with the scrollbars and the child widget to keep the bars in sync
518 * with the child. Usually you want to pass %NULL for the adjustments, which
519 * will cause the scrolled window to create them for you.
521 * Returns: a new scrolled window
524 gtk_scrolled_window_new (GtkAdjustment *hadjustment,
525 GtkAdjustment *vadjustment)
527 GtkWidget *scrolled_window;
530 g_return_val_if_fail (GTK_IS_ADJUSTMENT (hadjustment), NULL);
533 g_return_val_if_fail (GTK_IS_ADJUSTMENT (vadjustment), NULL);
535 scrolled_window = g_object_new (GTK_TYPE_SCROLLED_WINDOW,
536 "hadjustment", hadjustment,
537 "vadjustment", vadjustment,
540 return scrolled_window;
544 * gtk_scrolled_window_set_hadjustment:
545 * @scrolled_window: a #GtkScrolledWindow
546 * @hadjustment: horizontal scroll adjustment
548 * Sets the #GtkAdjustment for the horizontal scrollbar.
551 gtk_scrolled_window_set_hadjustment (GtkScrolledWindow *scrolled_window,
552 GtkAdjustment *hadjustment)
554 GtkScrolledWindowPrivate *priv;
558 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
560 g_return_if_fail (GTK_IS_ADJUSTMENT (hadjustment));
562 hadjustment = (GtkAdjustment*) g_object_new (GTK_TYPE_ADJUSTMENT, NULL);
564 bin = GTK_BIN (scrolled_window);
565 priv = scrolled_window->priv;
567 if (!priv->hscrollbar)
569 gtk_widget_push_composite_child ();
570 priv->hscrollbar = gtk_scrollbar_new (GTK_ORIENTATION_HORIZONTAL, hadjustment);
571 gtk_widget_set_composite_name (priv->hscrollbar, "hscrollbar");
572 gtk_widget_pop_composite_child ();
574 gtk_widget_set_parent (priv->hscrollbar, GTK_WIDGET (scrolled_window));
575 g_object_ref (priv->hscrollbar);
576 gtk_widget_show (priv->hscrollbar);
580 GtkAdjustment *old_adjustment;
582 old_adjustment = gtk_range_get_adjustment (GTK_RANGE (priv->hscrollbar));
583 if (old_adjustment == hadjustment)
586 g_signal_handlers_disconnect_by_func (old_adjustment,
587 gtk_scrolled_window_adjustment_changed,
589 gtk_range_set_adjustment (GTK_RANGE (priv->hscrollbar),
592 hadjustment = gtk_range_get_adjustment (GTK_RANGE (priv->hscrollbar));
593 g_signal_connect (hadjustment,
595 G_CALLBACK (gtk_scrolled_window_adjustment_changed),
597 gtk_scrolled_window_adjustment_changed (hadjustment, scrolled_window);
599 child = gtk_bin_get_child (bin);
600 if (GTK_IS_SCROLLABLE (child))
601 gtk_scrollable_set_hadjustment (GTK_SCROLLABLE (child), hadjustment);
603 g_object_notify (G_OBJECT (scrolled_window), "hadjustment");
607 * gtk_scrolled_window_set_vadjustment:
608 * @scrolled_window: a #GtkScrolledWindow
609 * @vadjustment: vertical scroll adjustment
611 * Sets the #GtkAdjustment for the vertical scrollbar.
614 gtk_scrolled_window_set_vadjustment (GtkScrolledWindow *scrolled_window,
615 GtkAdjustment *vadjustment)
617 GtkScrolledWindowPrivate *priv;
621 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
623 g_return_if_fail (GTK_IS_ADJUSTMENT (vadjustment));
625 vadjustment = (GtkAdjustment*) g_object_new (GTK_TYPE_ADJUSTMENT, NULL);
627 bin = GTK_BIN (scrolled_window);
628 priv = scrolled_window->priv;
630 if (!priv->vscrollbar)
632 gtk_widget_push_composite_child ();
633 priv->vscrollbar = gtk_scrollbar_new (GTK_ORIENTATION_VERTICAL, vadjustment);
634 gtk_widget_set_composite_name (priv->vscrollbar, "vscrollbar");
635 gtk_widget_pop_composite_child ();
637 gtk_widget_set_parent (priv->vscrollbar, GTK_WIDGET (scrolled_window));
638 g_object_ref (priv->vscrollbar);
639 gtk_widget_show (priv->vscrollbar);
643 GtkAdjustment *old_adjustment;
645 old_adjustment = gtk_range_get_adjustment (GTK_RANGE (priv->vscrollbar));
646 if (old_adjustment == vadjustment)
649 g_signal_handlers_disconnect_by_func (old_adjustment,
650 gtk_scrolled_window_adjustment_changed,
652 gtk_range_set_adjustment (GTK_RANGE (priv->vscrollbar),
655 vadjustment = gtk_range_get_adjustment (GTK_RANGE (priv->vscrollbar));
656 g_signal_connect (vadjustment,
658 G_CALLBACK (gtk_scrolled_window_adjustment_changed),
660 gtk_scrolled_window_adjustment_changed (vadjustment, scrolled_window);
662 child = gtk_bin_get_child (bin);
663 if (GTK_IS_SCROLLABLE (child))
664 gtk_scrollable_set_vadjustment (GTK_SCROLLABLE (child), vadjustment);
666 g_object_notify (G_OBJECT (scrolled_window), "vadjustment");
670 * gtk_scrolled_window_get_hadjustment:
671 * @scrolled_window: a #GtkScrolledWindow
673 * Returns the horizontal scrollbar's adjustment, used to connect the
674 * horizontal scrollbar to the child widget's horizontal scroll
677 * Returns: (transfer none): the horizontal #GtkAdjustment
680 gtk_scrolled_window_get_hadjustment (GtkScrolledWindow *scrolled_window)
682 GtkScrolledWindowPrivate *priv;
684 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
686 priv = scrolled_window->priv;
688 return (priv->hscrollbar ?
689 gtk_range_get_adjustment (GTK_RANGE (priv->hscrollbar)) :
694 * gtk_scrolled_window_get_vadjustment:
695 * @scrolled_window: a #GtkScrolledWindow
697 * Returns the vertical scrollbar's adjustment, used to connect the
698 * vertical scrollbar to the child widget's vertical scroll functionality.
700 * Returns: (transfer none): the vertical #GtkAdjustment
703 gtk_scrolled_window_get_vadjustment (GtkScrolledWindow *scrolled_window)
705 GtkScrolledWindowPrivate *priv;
707 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
709 priv = scrolled_window->priv;
711 return (priv->vscrollbar ?
712 gtk_range_get_adjustment (GTK_RANGE (priv->vscrollbar)) :
717 * gtk_scrolled_window_get_hscrollbar:
718 * @scrolled_window: a #GtkScrolledWindow
720 * Returns the horizontal scrollbar of @scrolled_window.
722 * Returns: (transfer none): the horizontal scrollbar of the scrolled window,
723 * or %NULL if it does not have one.
728 gtk_scrolled_window_get_hscrollbar (GtkScrolledWindow *scrolled_window)
730 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
732 return scrolled_window->priv->hscrollbar;
736 * gtk_scrolled_window_get_vscrollbar:
737 * @scrolled_window: a #GtkScrolledWindow
739 * Returns the vertical scrollbar of @scrolled_window.
741 * Returns: (transfer none): the vertical scrollbar of the scrolled window,
742 * or %NULL if it does not have one.
747 gtk_scrolled_window_get_vscrollbar (GtkScrolledWindow *scrolled_window)
749 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
751 return scrolled_window->priv->vscrollbar;
755 * gtk_scrolled_window_set_policy:
756 * @scrolled_window: a #GtkScrolledWindow
757 * @hscrollbar_policy: policy for horizontal bar
758 * @vscrollbar_policy: policy for vertical bar
760 * Sets the scrollbar policy for the horizontal and vertical scrollbars.
762 * The policy determines when the scrollbar should appear; it is a value
763 * from the #GtkPolicyType enumeration. If %GTK_POLICY_ALWAYS, the
764 * scrollbar is always present; if %GTK_POLICY_NEVER, the scrollbar is
765 * never present; if %GTK_POLICY_AUTOMATIC, the scrollbar is present only
766 * if needed (that is, if the slider part of the bar would be smaller
767 * than the trough - the display is larger than the page size).
770 gtk_scrolled_window_set_policy (GtkScrolledWindow *scrolled_window,
771 GtkPolicyType hscrollbar_policy,
772 GtkPolicyType vscrollbar_policy)
774 GtkScrolledWindowPrivate *priv;
775 GObject *object = G_OBJECT (scrolled_window);
777 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
779 priv = scrolled_window->priv;
781 if ((priv->hscrollbar_policy != hscrollbar_policy) ||
782 (priv->vscrollbar_policy != vscrollbar_policy))
784 priv->hscrollbar_policy = hscrollbar_policy;
785 priv->vscrollbar_policy = vscrollbar_policy;
787 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
789 g_object_freeze_notify (object);
790 g_object_notify (object, "hscrollbar-policy");
791 g_object_notify (object, "vscrollbar-policy");
792 g_object_thaw_notify (object);
797 * gtk_scrolled_window_get_policy:
798 * @scrolled_window: a #GtkScrolledWindow
799 * @hscrollbar_policy: (out) (allow-none): location to store the policy
800 * for the horizontal scrollbar, or %NULL.
801 * @vscrollbar_policy: (out) (allow-none): location to store the policy
802 * for the vertical scrollbar, or %NULL.
804 * Retrieves the current policy values for the horizontal and vertical
805 * scrollbars. See gtk_scrolled_window_set_policy().
808 gtk_scrolled_window_get_policy (GtkScrolledWindow *scrolled_window,
809 GtkPolicyType *hscrollbar_policy,
810 GtkPolicyType *vscrollbar_policy)
812 GtkScrolledWindowPrivate *priv;
814 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
816 priv = scrolled_window->priv;
818 if (hscrollbar_policy)
819 *hscrollbar_policy = priv->hscrollbar_policy;
820 if (vscrollbar_policy)
821 *vscrollbar_policy = priv->vscrollbar_policy;
825 gtk_scrolled_window_update_real_placement (GtkScrolledWindow *scrolled_window)
827 GtkScrolledWindowPrivate *priv = scrolled_window->priv;
828 GtkSettings *settings;
830 settings = gtk_widget_get_settings (GTK_WIDGET (scrolled_window));
832 if (priv->window_placement_set || settings == NULL)
833 priv->real_window_placement = priv->window_placement;
835 g_object_get (settings,
836 "gtk-scrolled-window-placement",
837 &priv->real_window_placement,
842 gtk_scrolled_window_set_placement_internal (GtkScrolledWindow *scrolled_window,
843 GtkCornerType window_placement)
845 GtkScrolledWindowPrivate *priv = scrolled_window->priv;
847 if (priv->window_placement != window_placement)
849 priv->window_placement = window_placement;
851 gtk_scrolled_window_update_real_placement (scrolled_window);
852 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
854 g_object_notify (G_OBJECT (scrolled_window), "window-placement");
859 gtk_scrolled_window_set_placement_set (GtkScrolledWindow *scrolled_window,
860 gboolean placement_set,
861 gboolean emit_resize)
863 GtkScrolledWindowPrivate *priv = scrolled_window->priv;
865 if (priv->window_placement_set != placement_set)
867 priv->window_placement_set = placement_set;
869 gtk_scrolled_window_update_real_placement (scrolled_window);
871 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
873 g_object_notify (G_OBJECT (scrolled_window), "window-placement-set");
878 * gtk_scrolled_window_set_placement:
879 * @scrolled_window: a #GtkScrolledWindow
880 * @window_placement: position of the child window
882 * Sets the placement of the contents with respect to the scrollbars
883 * for the scrolled window.
885 * The default is %GTK_CORNER_TOP_LEFT, meaning the child is
886 * in the top left, with the scrollbars underneath and to the right.
887 * Other values in #GtkCornerType are %GTK_CORNER_TOP_RIGHT,
888 * %GTK_CORNER_BOTTOM_LEFT, and %GTK_CORNER_BOTTOM_RIGHT.
890 * See also gtk_scrolled_window_get_placement() and
891 * gtk_scrolled_window_unset_placement().
894 gtk_scrolled_window_set_placement (GtkScrolledWindow *scrolled_window,
895 GtkCornerType window_placement)
897 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
899 gtk_scrolled_window_set_placement_set (scrolled_window, TRUE, FALSE);
900 gtk_scrolled_window_set_placement_internal (scrolled_window, window_placement);
904 * gtk_scrolled_window_get_placement:
905 * @scrolled_window: a #GtkScrolledWindow
907 * Gets the placement of the contents with respect to the scrollbars
908 * for the scrolled window. See gtk_scrolled_window_set_placement().
910 * Return value: the current placement value.
912 * See also gtk_scrolled_window_set_placement() and
913 * gtk_scrolled_window_unset_placement().
916 gtk_scrolled_window_get_placement (GtkScrolledWindow *scrolled_window)
918 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), GTK_CORNER_TOP_LEFT);
920 return scrolled_window->priv->window_placement;
924 * gtk_scrolled_window_unset_placement:
925 * @scrolled_window: a #GtkScrolledWindow
927 * Unsets the placement of the contents with respect to the scrollbars
928 * for the scrolled window. If no window placement is set for a scrolled
929 * window, it obeys the "gtk-scrolled-window-placement" XSETTING.
931 * See also gtk_scrolled_window_set_placement() and
932 * gtk_scrolled_window_get_placement().
937 gtk_scrolled_window_unset_placement (GtkScrolledWindow *scrolled_window)
939 GtkScrolledWindowPrivate *priv;
941 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
943 priv = scrolled_window->priv;
945 if (priv->window_placement_set)
947 priv->window_placement_set = FALSE;
949 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
951 g_object_notify (G_OBJECT (scrolled_window), "window-placement-set");
956 * gtk_scrolled_window_set_shadow_type:
957 * @scrolled_window: a #GtkScrolledWindow
958 * @type: kind of shadow to draw around scrolled window contents
960 * Changes the type of shadow drawn around the contents of
965 gtk_scrolled_window_set_shadow_type (GtkScrolledWindow *scrolled_window,
968 GtkScrolledWindowPrivate *priv;
970 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
971 g_return_if_fail (type >= GTK_SHADOW_NONE && type <= GTK_SHADOW_ETCHED_OUT);
973 priv = scrolled_window->priv;
975 if (priv->shadow_type != type)
977 priv->shadow_type = type;
979 if (gtk_widget_is_drawable (GTK_WIDGET (scrolled_window)))
980 gtk_widget_queue_draw (GTK_WIDGET (scrolled_window));
982 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
984 g_object_notify (G_OBJECT (scrolled_window), "shadow-type");
989 * gtk_scrolled_window_get_shadow_type:
990 * @scrolled_window: a #GtkScrolledWindow
992 * Gets the shadow type of the scrolled window. See
993 * gtk_scrolled_window_set_shadow_type().
995 * Return value: the current shadow type
998 gtk_scrolled_window_get_shadow_type (GtkScrolledWindow *scrolled_window)
1000 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), GTK_SHADOW_NONE);
1002 return scrolled_window->priv->shadow_type;
1006 gtk_scrolled_window_destroy (GtkWidget *widget)
1008 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (widget);
1009 GtkScrolledWindowPrivate *priv = scrolled_window->priv;
1011 if (priv->hscrollbar)
1013 g_signal_handlers_disconnect_by_func (gtk_range_get_adjustment (GTK_RANGE (priv->hscrollbar)),
1014 gtk_scrolled_window_adjustment_changed,
1016 gtk_widget_unparent (priv->hscrollbar);
1017 gtk_widget_destroy (priv->hscrollbar);
1018 g_object_unref (priv->hscrollbar);
1019 priv->hscrollbar = NULL;
1021 if (priv->vscrollbar)
1023 g_signal_handlers_disconnect_by_func (gtk_range_get_adjustment (GTK_RANGE (priv->vscrollbar)),
1024 gtk_scrolled_window_adjustment_changed,
1026 gtk_widget_unparent (priv->vscrollbar);
1027 gtk_widget_destroy (priv->vscrollbar);
1028 g_object_unref (priv->vscrollbar);
1029 priv->vscrollbar = NULL;
1032 GTK_WIDGET_CLASS (gtk_scrolled_window_parent_class)->destroy (widget);
1036 gtk_scrolled_window_set_property (GObject *object,
1038 const GValue *value,
1041 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
1042 GtkScrolledWindowPrivate *priv = scrolled_window->priv;
1046 case PROP_HADJUSTMENT:
1047 gtk_scrolled_window_set_hadjustment (scrolled_window,
1048 g_value_get_object (value));
1050 case PROP_VADJUSTMENT:
1051 gtk_scrolled_window_set_vadjustment (scrolled_window,
1052 g_value_get_object (value));
1054 case PROP_HSCROLLBAR_POLICY:
1055 gtk_scrolled_window_set_policy (scrolled_window,
1056 g_value_get_enum (value),
1057 priv->vscrollbar_policy);
1059 case PROP_VSCROLLBAR_POLICY:
1060 gtk_scrolled_window_set_policy (scrolled_window,
1061 priv->hscrollbar_policy,
1062 g_value_get_enum (value));
1064 case PROP_WINDOW_PLACEMENT:
1065 gtk_scrolled_window_set_placement_internal (scrolled_window,
1066 g_value_get_enum (value));
1068 case PROP_WINDOW_PLACEMENT_SET:
1069 gtk_scrolled_window_set_placement_set (scrolled_window,
1070 g_value_get_boolean (value),
1073 case PROP_SHADOW_TYPE:
1074 gtk_scrolled_window_set_shadow_type (scrolled_window,
1075 g_value_get_enum (value));
1077 case PROP_MIN_CONTENT_WIDTH:
1078 gtk_scrolled_window_set_min_content_width (scrolled_window,
1079 g_value_get_int (value));
1081 case PROP_MIN_CONTENT_HEIGHT:
1082 gtk_scrolled_window_set_min_content_height (scrolled_window,
1083 g_value_get_int (value));
1086 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1092 gtk_scrolled_window_get_property (GObject *object,
1097 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
1098 GtkScrolledWindowPrivate *priv = scrolled_window->priv;
1102 case PROP_HADJUSTMENT:
1103 g_value_set_object (value,
1104 G_OBJECT (gtk_scrolled_window_get_hadjustment (scrolled_window)));
1106 case PROP_VADJUSTMENT:
1107 g_value_set_object (value,
1108 G_OBJECT (gtk_scrolled_window_get_vadjustment (scrolled_window)));
1110 case PROP_WINDOW_PLACEMENT:
1111 g_value_set_enum (value, priv->window_placement);
1113 case PROP_WINDOW_PLACEMENT_SET:
1114 g_value_set_boolean (value, priv->window_placement_set);
1116 case PROP_SHADOW_TYPE:
1117 g_value_set_enum (value, priv->shadow_type);
1119 case PROP_HSCROLLBAR_POLICY:
1120 g_value_set_enum (value, priv->hscrollbar_policy);
1122 case PROP_VSCROLLBAR_POLICY:
1123 g_value_set_enum (value, priv->vscrollbar_policy);
1125 case PROP_MIN_CONTENT_WIDTH:
1126 g_value_set_int (value, priv->min_content_width);
1128 case PROP_MIN_CONTENT_HEIGHT:
1129 g_value_set_int (value, priv->min_content_height);
1132 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1138 traverse_container (GtkWidget *widget,
1141 if (GTK_IS_SCROLLED_WINDOW (widget))
1143 gtk_scrolled_window_update_real_placement (GTK_SCROLLED_WINDOW (widget));
1144 gtk_widget_queue_resize (widget);
1146 else if (GTK_IS_CONTAINER (widget))
1147 gtk_container_forall (GTK_CONTAINER (widget), traverse_container, NULL);
1151 gtk_scrolled_window_settings_changed (GtkSettings *settings)
1155 list = gtk_window_list_toplevels ();
1157 for (l = list; l; l = l->next)
1158 gtk_container_forall (GTK_CONTAINER (l->data),
1159 traverse_container, NULL);
1165 gtk_scrolled_window_screen_changed (GtkWidget *widget,
1166 GdkScreen *previous_screen)
1168 GtkSettings *settings;
1169 guint window_placement_connection;
1171 gtk_scrolled_window_update_real_placement (GTK_SCROLLED_WINDOW (widget));
1173 if (!gtk_widget_has_screen (widget))
1176 settings = gtk_widget_get_settings (widget);
1178 window_placement_connection =
1179 GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (settings),
1180 "gtk-scrolled-window-connection"));
1182 if (window_placement_connection)
1185 window_placement_connection =
1186 g_signal_connect (settings, "notify::gtk-scrolled-window-placement",
1187 G_CALLBACK (gtk_scrolled_window_settings_changed), NULL);
1188 g_object_set_data (G_OBJECT (settings),
1189 I_("gtk-scrolled-window-connection"),
1190 GUINT_TO_POINTER (window_placement_connection));
1194 gtk_scrolled_window_draw (GtkWidget *widget,
1197 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (widget);
1198 GtkScrolledWindowPrivate *priv = scrolled_window->priv;
1200 if (priv->shadow_type != GTK_SHADOW_NONE)
1202 GtkAllocation relative_allocation;
1203 GtkStyleContext *context;
1204 gboolean scrollbars_within_bevel;
1206 context = gtk_widget_get_style_context (widget);
1208 gtk_style_context_save (context);
1209 gtk_style_context_add_class (context, GTK_STYLE_CLASS_FRAME);
1211 gtk_widget_style_get (widget, "scrollbars-within-bevel", &scrollbars_within_bevel, NULL);
1213 if (!scrollbars_within_bevel)
1215 GtkStateFlags state;
1216 GtkBorder padding, border;
1218 state = gtk_widget_get_state_flags (widget);
1219 gtk_style_context_get_padding (context, state, &padding);
1220 gtk_style_context_get_border (context, state, &border);
1222 gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
1224 relative_allocation.x -= padding.left + border.left;
1225 relative_allocation.y -= padding.top + border.top;
1226 relative_allocation.width += padding.left + padding.right + border.left + border.right;
1227 relative_allocation.height += padding.top + padding.bottom + border.top + border.bottom;
1231 relative_allocation.x = 0;
1232 relative_allocation.y = 0;
1233 relative_allocation.width = gtk_widget_get_allocated_width (widget);
1234 relative_allocation.height = gtk_widget_get_allocated_height (widget);
1237 gtk_render_frame (context, cr,
1238 relative_allocation.x,
1239 relative_allocation.y,
1240 relative_allocation.width,
1241 relative_allocation.height);
1243 gtk_style_context_restore (context);
1246 GTK_WIDGET_CLASS (gtk_scrolled_window_parent_class)->draw (widget, cr);
1252 gtk_scrolled_window_forall (GtkContainer *container,
1253 gboolean include_internals,
1254 GtkCallback callback,
1255 gpointer callback_data)
1257 GtkScrolledWindowPrivate *priv;
1258 GtkScrolledWindow *scrolled_window;
1260 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (container));
1261 g_return_if_fail (callback != NULL);
1263 GTK_CONTAINER_CLASS (gtk_scrolled_window_parent_class)->forall (container,
1267 if (include_internals)
1269 scrolled_window = GTK_SCROLLED_WINDOW (container);
1270 priv = scrolled_window->priv;
1272 if (priv->vscrollbar)
1273 callback (priv->vscrollbar, callback_data);
1274 if (priv->hscrollbar)
1275 callback (priv->hscrollbar, callback_data);
1280 gtk_scrolled_window_scroll_child (GtkScrolledWindow *scrolled_window,
1281 GtkScrollType scroll,
1282 gboolean horizontal)
1284 GtkScrolledWindowPrivate *priv = scrolled_window->priv;
1285 GtkAdjustment *adjustment = NULL;
1289 case GTK_SCROLL_STEP_UP:
1290 scroll = GTK_SCROLL_STEP_BACKWARD;
1293 case GTK_SCROLL_STEP_DOWN:
1294 scroll = GTK_SCROLL_STEP_FORWARD;
1297 case GTK_SCROLL_STEP_LEFT:
1298 scroll = GTK_SCROLL_STEP_BACKWARD;
1301 case GTK_SCROLL_STEP_RIGHT:
1302 scroll = GTK_SCROLL_STEP_FORWARD;
1305 case GTK_SCROLL_PAGE_UP:
1306 scroll = GTK_SCROLL_PAGE_BACKWARD;
1309 case GTK_SCROLL_PAGE_DOWN:
1310 scroll = GTK_SCROLL_PAGE_FORWARD;
1313 case GTK_SCROLL_PAGE_LEFT:
1314 scroll = GTK_SCROLL_STEP_BACKWARD;
1317 case GTK_SCROLL_PAGE_RIGHT:
1318 scroll = GTK_SCROLL_STEP_FORWARD;
1321 case GTK_SCROLL_STEP_BACKWARD:
1322 case GTK_SCROLL_STEP_FORWARD:
1323 case GTK_SCROLL_PAGE_BACKWARD:
1324 case GTK_SCROLL_PAGE_FORWARD:
1325 case GTK_SCROLL_START:
1326 case GTK_SCROLL_END:
1329 g_warning ("Invalid scroll type %u for GtkScrolledWindow::scroll-child", scroll);
1333 if ((horizontal && (!priv->hscrollbar || !priv->hscrollbar_visible)) ||
1334 (!horizontal && (!priv->vscrollbar || !priv->vscrollbar_visible)))
1339 if (priv->hscrollbar)
1340 adjustment = gtk_range_get_adjustment (GTK_RANGE (priv->hscrollbar));
1344 if (priv->vscrollbar)
1345 adjustment = gtk_range_get_adjustment (GTK_RANGE (priv->vscrollbar));
1350 gdouble value = gtk_adjustment_get_value (adjustment);
1354 case GTK_SCROLL_STEP_FORWARD:
1355 value += gtk_adjustment_get_step_increment (adjustment);
1357 case GTK_SCROLL_STEP_BACKWARD:
1358 value -= gtk_adjustment_get_step_increment (adjustment);
1360 case GTK_SCROLL_PAGE_FORWARD:
1361 value += gtk_adjustment_get_page_increment (adjustment);
1363 case GTK_SCROLL_PAGE_BACKWARD:
1364 value -= gtk_adjustment_get_page_increment (adjustment);
1366 case GTK_SCROLL_START:
1367 value = gtk_adjustment_get_lower (adjustment);
1369 case GTK_SCROLL_END:
1370 value = gtk_adjustment_get_upper (adjustment);
1373 g_assert_not_reached ();
1377 gtk_adjustment_set_value (adjustment, value);
1386 gtk_scrolled_window_move_focus_out (GtkScrolledWindow *scrolled_window,
1387 GtkDirectionType direction_type)
1389 GtkScrolledWindowPrivate *priv = scrolled_window->priv;
1390 GtkWidget *toplevel;
1392 /* Focus out of the scrolled window entirely. We do this by setting
1393 * a flag, then propagating the focus motion to the notebook.
1395 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (scrolled_window));
1396 if (!gtk_widget_is_toplevel (toplevel))
1399 g_object_ref (scrolled_window);
1401 priv->focus_out = TRUE;
1402 g_signal_emit_by_name (toplevel, "move-focus", direction_type);
1403 priv->focus_out = FALSE;
1405 g_object_unref (scrolled_window);
1409 gtk_scrolled_window_relative_allocation (GtkWidget *widget,
1410 GtkAllocation *allocation)
1412 GtkAllocation widget_allocation;
1413 GtkScrolledWindow *scrolled_window;
1414 GtkScrolledWindowPrivate *priv;
1419 g_return_if_fail (widget != NULL);
1420 g_return_if_fail (allocation != NULL);
1422 scrolled_window = GTK_SCROLLED_WINDOW (widget);
1423 priv = scrolled_window->priv;
1425 /* Get possible scrollbar dimensions */
1426 sb_spacing = _gtk_scrolled_window_get_scrollbar_spacing (scrolled_window);
1427 gtk_widget_get_preferred_height (priv->hscrollbar, &sb_height, NULL);
1428 gtk_widget_get_preferred_width (priv->vscrollbar, &sb_width, NULL);
1430 /* Subtract some things from our available allocation size */
1434 if (priv->shadow_type != GTK_SHADOW_NONE)
1436 GtkStyleContext *context;
1437 GtkStateFlags state;
1438 GtkBorder padding, border;
1440 context = gtk_widget_get_style_context (widget);
1441 state = gtk_widget_get_state_flags (widget);
1443 gtk_style_context_save (context);
1444 gtk_style_context_add_class (context, GTK_STYLE_CLASS_FRAME);
1446 gtk_style_context_get_border (context, state, &border);
1447 gtk_style_context_get_padding (context, state, &padding);
1449 allocation->x += padding.left + border.left;
1450 allocation->y += padding.top + border.top;
1452 gtk_style_context_restore (context);
1455 gtk_widget_get_allocation (widget, &widget_allocation);
1456 allocation->width = MAX (1, (gint) widget_allocation.width - allocation->x * 2);
1457 allocation->height = MAX (1, (gint) widget_allocation.height - allocation->y * 2);
1459 if (priv->vscrollbar_visible)
1463 is_rtl = gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL;
1466 (priv->real_window_placement == GTK_CORNER_TOP_RIGHT ||
1467 priv->real_window_placement == GTK_CORNER_BOTTOM_RIGHT)) ||
1469 (priv->real_window_placement == GTK_CORNER_TOP_LEFT ||
1470 priv->real_window_placement == GTK_CORNER_BOTTOM_LEFT)))
1471 allocation->x += (sb_width + sb_spacing);
1473 allocation->width = MAX (1, allocation->width - (sb_width + sb_spacing));
1475 if (priv->hscrollbar_visible)
1478 if (priv->real_window_placement == GTK_CORNER_BOTTOM_LEFT ||
1479 priv->real_window_placement == GTK_CORNER_BOTTOM_RIGHT)
1480 allocation->y += (sb_height + sb_spacing);
1482 allocation->height = MAX (1, allocation->height - (sb_height + sb_spacing));
1487 gtk_scrolled_window_allocate_child (GtkScrolledWindow *swindow,
1488 GtkAllocation *relative_allocation)
1490 GtkWidget *widget = GTK_WIDGET (swindow), *child;
1491 GtkAllocation allocation;
1492 GtkAllocation child_allocation;
1494 child = gtk_bin_get_child (GTK_BIN (widget));
1496 gtk_widget_get_allocation (widget, &allocation);
1498 gtk_scrolled_window_relative_allocation (widget, relative_allocation);
1499 child_allocation.x = relative_allocation->x + allocation.x;
1500 child_allocation.y = relative_allocation->y + allocation.y;
1501 child_allocation.width = relative_allocation->width;
1502 child_allocation.height = relative_allocation->height;
1504 gtk_widget_size_allocate (child, &child_allocation);
1508 gtk_scrolled_window_size_allocate (GtkWidget *widget,
1509 GtkAllocation *allocation)
1511 GtkScrolledWindow *scrolled_window;
1512 GtkScrolledWindowPrivate *priv;
1513 GtkStyleContext *context;
1514 GtkStateFlags state;
1515 GtkBorder padding, border;
1517 GtkAllocation relative_allocation;
1518 GtkAllocation child_allocation;
1520 gboolean scrollbars_within_bevel;
1525 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (widget));
1526 g_return_if_fail (allocation != NULL);
1528 scrolled_window = GTK_SCROLLED_WINDOW (widget);
1529 bin = GTK_BIN (scrolled_window);
1530 priv = scrolled_window->priv;
1532 /* Get possible scrollbar dimensions */
1533 sb_spacing = _gtk_scrolled_window_get_scrollbar_spacing (scrolled_window);
1534 gtk_widget_get_preferred_height (priv->hscrollbar, &sb_height, NULL);
1535 gtk_widget_get_preferred_width (priv->vscrollbar, &sb_width, NULL);
1537 context = gtk_widget_get_style_context (widget);
1538 state = gtk_widget_get_state_flags (widget);
1540 gtk_style_context_save (context);
1541 gtk_style_context_add_class (context, GTK_STYLE_CLASS_FRAME);
1543 gtk_style_context_get_padding (context, state, &padding);
1544 gtk_style_context_get_border (context, state, &border);
1546 gtk_widget_style_get (widget, "scrollbars-within-bevel", &scrollbars_within_bevel, NULL);
1548 gtk_widget_set_allocation (widget, allocation);
1550 gtk_style_context_restore (context);
1552 if (priv->hscrollbar_policy == GTK_POLICY_ALWAYS)
1553 priv->hscrollbar_visible = TRUE;
1554 else if (priv->hscrollbar_policy == GTK_POLICY_NEVER)
1555 priv->hscrollbar_visible = FALSE;
1556 if (priv->vscrollbar_policy == GTK_POLICY_ALWAYS)
1557 priv->vscrollbar_visible = TRUE;
1558 else if (priv->vscrollbar_policy == GTK_POLICY_NEVER)
1559 priv->vscrollbar_visible = FALSE;
1561 child = gtk_bin_get_child (bin);
1562 if (child && gtk_widget_get_visible (child))
1564 gint child_scroll_width;
1565 gint child_scroll_height;
1566 gboolean previous_hvis;
1567 gboolean previous_vvis;
1570 /* Determine scrollbar visibility first via hfw apis */
1571 if (gtk_widget_get_request_mode (child) == GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH)
1573 if (gtk_scrollable_get_hscroll_policy (GTK_SCROLLABLE (child)) == GTK_SCROLL_MINIMUM)
1574 gtk_widget_get_preferred_width (child, &child_scroll_width, NULL);
1576 gtk_widget_get_preferred_width (child, NULL, &child_scroll_width);
1578 if (priv->vscrollbar_policy == GTK_POLICY_AUTOMATIC)
1580 /* First try without a vertical scrollbar if the content will fit the height
1581 * given the extra width of the scrollbar */
1582 if (gtk_scrollable_get_vscroll_policy (GTK_SCROLLABLE (child)) == GTK_SCROLL_MINIMUM)
1583 gtk_widget_get_preferred_height_for_width (child,
1584 MAX (allocation->width, child_scroll_width),
1585 &child_scroll_height, NULL);
1587 gtk_widget_get_preferred_height_for_width (child,
1588 MAX (allocation->width, child_scroll_width),
1589 NULL, &child_scroll_height);
1591 if (priv->hscrollbar_policy == GTK_POLICY_AUTOMATIC)
1593 /* Does the content height fit the allocation height ? */
1594 priv->vscrollbar_visible = child_scroll_height > allocation->height;
1596 /* Does the content width fit the allocation with minus a possible scrollbar ? */
1597 priv->hscrollbar_visible =
1598 child_scroll_width > allocation->width -
1599 (priv->vscrollbar_visible ? sb_width + sb_spacing : 0);
1601 /* Now that we've guessed the hscrollbar, does the content height fit
1602 * the possible new allocation height ? */
1603 priv->vscrollbar_visible =
1604 child_scroll_height > allocation->height -
1605 (priv->hscrollbar_visible ? sb_height + sb_spacing : 0);
1607 /* Now that we've guessed the vscrollbar, does the content width fit
1608 * the possible new allocation width ? */
1609 priv->hscrollbar_visible =
1610 child_scroll_width > allocation->width -
1611 (priv->vscrollbar_visible ? sb_width + sb_spacing : 0);
1613 else /* priv->hscrollbar_policy != GTK_POLICY_AUTOMATIC */
1615 priv->hscrollbar_visible = priv->hscrollbar_policy != GTK_POLICY_NEVER;
1616 priv->vscrollbar_visible = child_scroll_height > allocation->height -
1617 (priv->hscrollbar_visible ? sb_height + sb_spacing : 0);
1620 else /* priv->vscrollbar_policy != GTK_POLICY_AUTOMATIC */
1622 priv->vscrollbar_visible = priv->vscrollbar_policy != GTK_POLICY_NEVER;
1624 if (priv->hscrollbar_policy == GTK_POLICY_AUTOMATIC)
1625 priv->hscrollbar_visible =
1626 child_scroll_width > allocation->width -
1627 (priv->vscrollbar_visible ? 0 : sb_width + sb_spacing);
1629 priv->hscrollbar_visible = priv->hscrollbar_policy != GTK_POLICY_NEVER;
1632 else /* GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT */
1634 if (gtk_scrollable_get_vscroll_policy (GTK_SCROLLABLE (child)) == GTK_SCROLL_MINIMUM)
1635 gtk_widget_get_preferred_height (child, &child_scroll_height, NULL);
1637 gtk_widget_get_preferred_height (child, NULL, &child_scroll_height);
1639 if (priv->hscrollbar_policy == GTK_POLICY_AUTOMATIC)
1641 /* First try without a horizontal scrollbar if the content will fit the width
1642 * given the extra height of the scrollbar */
1643 if (gtk_scrollable_get_hscroll_policy (GTK_SCROLLABLE (child)) == GTK_SCROLL_MINIMUM)
1644 gtk_widget_get_preferred_width_for_height (child,
1645 MAX (allocation->height, child_scroll_height),
1646 &child_scroll_width, NULL);
1648 gtk_widget_get_preferred_width_for_height (child,
1649 MAX (allocation->height, child_scroll_height),
1650 NULL, &child_scroll_width);
1652 if (priv->vscrollbar_policy == GTK_POLICY_AUTOMATIC)
1654 /* Does the content width fit the allocation width ? */
1655 priv->hscrollbar_visible = child_scroll_width > allocation->width;
1657 /* Does the content height fit the allocation with minus a possible scrollbar ? */
1658 priv->vscrollbar_visible =
1659 child_scroll_height > allocation->height -
1660 (priv->hscrollbar_visible ? sb_height + sb_spacing : 0);
1662 /* Now that we've guessed the vscrollbar, does the content width fit
1663 * the possible new allocation width ? */
1664 priv->hscrollbar_visible =
1665 child_scroll_width > allocation->width -
1666 (priv->vscrollbar_visible ? sb_width + sb_spacing : 0);
1668 /* Now that we've guessed the hscrollbar, does the content height fit
1669 * the possible new allocation height ? */
1670 priv->vscrollbar_visible =
1671 child_scroll_height > allocation->height -
1672 (priv->hscrollbar_visible ? sb_height + sb_spacing : 0);
1674 else /* priv->vscrollbar_policy != GTK_POLICY_AUTOMATIC */
1676 priv->vscrollbar_visible = priv->vscrollbar_policy != GTK_POLICY_NEVER;
1677 priv->hscrollbar_visible = child_scroll_width > allocation->width -
1678 (priv->vscrollbar_visible ? sb_width + sb_spacing : 0);
1681 else /* priv->hscrollbar_policy != GTK_POLICY_AUTOMATIC */
1683 priv->hscrollbar_visible = priv->hscrollbar_policy != GTK_POLICY_NEVER;
1685 if (priv->vscrollbar_policy == GTK_POLICY_AUTOMATIC)
1686 priv->vscrollbar_visible =
1687 child_scroll_height > allocation->height -
1688 (priv->hscrollbar_visible ? 0 : sb_height + sb_spacing);
1690 priv->vscrollbar_visible = priv->vscrollbar_policy != GTK_POLICY_NEVER;
1694 /* Now after guessing scrollbar visibility; fall back on the allocation loop which
1695 * observes the adjustments to detect scrollbar visibility and also avoids
1696 * infinite recursion
1700 previous_hvis = priv->hscrollbar_visible;
1701 previous_vvis = priv->vscrollbar_visible;
1702 gtk_scrolled_window_allocate_child (scrolled_window, &relative_allocation);
1704 /* Explicitly force scrollbar visibility checks.
1706 * Since we make a guess above, the child might not decide to update the adjustments
1707 * if they logically did not change since the last configuration
1709 if (priv->hscrollbar)
1710 gtk_scrolled_window_adjustment_changed
1711 (gtk_range_get_adjustment (GTK_RANGE (priv->hscrollbar)), scrolled_window);
1713 if (priv->vscrollbar)
1714 gtk_scrolled_window_adjustment_changed
1715 (gtk_range_get_adjustment (GTK_RANGE (priv->vscrollbar)), scrolled_window);
1717 /* If, after the first iteration, the hscrollbar and the
1718 * vscrollbar flip visiblity... or if one of the scrollbars flip
1719 * on each itteration indefinitly/infinitely, then we just need both
1723 previous_hvis != priv->hscrollbar_visible &&
1724 previous_vvis != priv->vscrollbar_visible) || count > 3)
1726 priv->hscrollbar_visible = TRUE;
1727 priv->vscrollbar_visible = TRUE;
1729 gtk_scrolled_window_allocate_child (scrolled_window, &relative_allocation);
1736 while (previous_hvis != priv->hscrollbar_visible ||
1737 previous_vvis != priv->vscrollbar_visible);
1741 priv->hscrollbar_visible = priv->hscrollbar_policy == GTK_POLICY_ALWAYS;
1742 priv->vscrollbar_visible = priv->vscrollbar_policy == GTK_POLICY_ALWAYS;
1743 gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
1746 if (priv->hscrollbar_visible)
1748 if (!gtk_widget_get_visible (priv->hscrollbar))
1749 gtk_widget_show (priv->hscrollbar);
1751 child_allocation.x = relative_allocation.x;
1752 if (priv->real_window_placement == GTK_CORNER_TOP_LEFT ||
1753 priv->real_window_placement == GTK_CORNER_TOP_RIGHT)
1754 child_allocation.y = (relative_allocation.y +
1755 relative_allocation.height +
1757 (priv->shadow_type == GTK_SHADOW_NONE ?
1758 0 : padding.top + border.top));
1760 child_allocation.y = 0;
1762 child_allocation.width = relative_allocation.width;
1763 child_allocation.height = sb_height;
1764 child_allocation.x += allocation->x;
1765 child_allocation.y += allocation->y;
1767 if (priv->shadow_type != GTK_SHADOW_NONE)
1769 if (!scrollbars_within_bevel)
1771 child_allocation.x -= padding.left + border.left;
1772 child_allocation.width += padding.left + padding.right + border.left + border.right;
1774 else if (GTK_CORNER_TOP_RIGHT == priv->real_window_placement ||
1775 GTK_CORNER_TOP_LEFT == priv->real_window_placement)
1777 child_allocation.y -= padding.top + border.top;
1781 child_allocation.y += padding.top + border.top;
1785 gtk_widget_size_allocate (priv->hscrollbar, &child_allocation);
1787 else if (gtk_widget_get_visible (priv->hscrollbar))
1788 gtk_widget_hide (priv->hscrollbar);
1790 if (priv->vscrollbar_visible)
1792 if (!gtk_widget_get_visible (priv->vscrollbar))
1793 gtk_widget_show (priv->vscrollbar);
1795 if ((gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL &&
1796 (priv->real_window_placement == GTK_CORNER_TOP_RIGHT ||
1797 priv->real_window_placement == GTK_CORNER_BOTTOM_RIGHT)) ||
1798 (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR &&
1799 (priv->real_window_placement == GTK_CORNER_TOP_LEFT ||
1800 priv->real_window_placement == GTK_CORNER_BOTTOM_LEFT)))
1801 child_allocation.x = (relative_allocation.x +
1802 relative_allocation.width +
1804 (priv->shadow_type == GTK_SHADOW_NONE ?
1805 0 : padding.left + border.left));
1807 child_allocation.x = 0;
1809 child_allocation.y = relative_allocation.y;
1810 child_allocation.width = sb_width;
1811 child_allocation.height = relative_allocation.height;
1812 child_allocation.x += allocation->x;
1813 child_allocation.y += allocation->y;
1815 if (priv->shadow_type != GTK_SHADOW_NONE)
1817 if (!scrollbars_within_bevel)
1819 child_allocation.y -= padding.top + border.top;
1820 child_allocation.height += padding.top + padding.bottom + border.top + border.bottom;
1822 else if (GTK_CORNER_BOTTOM_LEFT == priv->real_window_placement ||
1823 GTK_CORNER_TOP_LEFT == priv->real_window_placement)
1825 child_allocation.x -= padding.left + border.left;
1829 child_allocation.x += padding.left + border.left;
1833 gtk_widget_size_allocate (priv->vscrollbar, &child_allocation);
1835 else if (gtk_widget_get_visible (priv->vscrollbar))
1836 gtk_widget_hide (priv->vscrollbar);
1840 gtk_scrolled_window_scroll_event (GtkWidget *widget,
1841 GdkEventScroll *event)
1843 GtkScrolledWindowPrivate *priv;
1844 GtkScrolledWindow *scrolled_window;
1847 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (widget), FALSE);
1848 g_return_val_if_fail (event != NULL, FALSE);
1850 scrolled_window = GTK_SCROLLED_WINDOW (widget);
1851 priv = scrolled_window->priv;
1853 if (event->direction == GDK_SCROLL_UP || event->direction == GDK_SCROLL_DOWN)
1854 range = priv->vscrollbar;
1856 range = priv->hscrollbar;
1858 if (range && gtk_widget_get_visible (range))
1860 GtkAdjustment *adjustment = gtk_range_get_adjustment (GTK_RANGE (range));
1863 delta = _gtk_range_get_wheel_delta (GTK_RANGE (range), event->direction);
1865 gtk_adjustment_set_value (adjustment, gtk_adjustment_get_value (adjustment) + delta);
1874 gtk_scrolled_window_focus (GtkWidget *widget,
1875 GtkDirectionType direction)
1877 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (widget);
1878 GtkScrolledWindowPrivate *priv = scrolled_window->priv;
1880 gboolean had_focus_child;
1882 had_focus_child = gtk_container_get_focus_child (GTK_CONTAINER (widget)) != NULL;
1884 if (priv->focus_out)
1886 priv->focus_out = FALSE; /* Clear this to catch the wrap-around case */
1890 if (gtk_widget_is_focus (widget))
1893 /* We only put the scrolled window itself in the focus chain if it
1894 * isn't possible to focus any children.
1896 child = gtk_bin_get_child (GTK_BIN (widget));
1899 if (gtk_widget_child_focus (child, direction))
1903 if (!had_focus_child && gtk_widget_get_can_focus (widget))
1905 gtk_widget_grab_focus (widget);
1913 gtk_scrolled_window_adjustment_changed (GtkAdjustment *adjustment,
1916 GtkScrolledWindowPrivate *priv;
1917 GtkScrolledWindow *scrolled_window;
1919 g_return_if_fail (adjustment != NULL);
1920 g_return_if_fail (data != NULL);
1922 scrolled_window = GTK_SCROLLED_WINDOW (data);
1923 priv = scrolled_window->priv;
1925 if (priv->hscrollbar &&
1926 adjustment == gtk_range_get_adjustment (GTK_RANGE (priv->hscrollbar)))
1928 if (priv->hscrollbar_policy == GTK_POLICY_AUTOMATIC)
1932 visible = priv->hscrollbar_visible;
1933 priv->hscrollbar_visible = (gtk_adjustment_get_upper (adjustment) - gtk_adjustment_get_lower (adjustment) >
1934 gtk_adjustment_get_page_size (adjustment));
1936 if (priv->hscrollbar_visible != visible)
1937 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
1940 else if (priv->vscrollbar &&
1941 adjustment == gtk_range_get_adjustment (GTK_RANGE (priv->vscrollbar)))
1943 if (priv->vscrollbar_policy == GTK_POLICY_AUTOMATIC)
1947 visible = priv->vscrollbar_visible;
1948 priv->vscrollbar_visible = (gtk_adjustment_get_upper (adjustment) - gtk_adjustment_get_lower (adjustment) >
1949 gtk_adjustment_get_page_size (adjustment));
1951 if (priv->vscrollbar_visible != visible)
1952 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
1958 gtk_scrolled_window_add (GtkContainer *container,
1961 GtkScrolledWindowPrivate *priv;
1962 GtkScrolledWindow *scrolled_window;
1964 GtkWidget *child_widget;
1965 GtkAdjustment *hadj, *vadj;
1967 bin = GTK_BIN (container);
1968 child_widget = gtk_bin_get_child (bin);
1969 g_return_if_fail (child_widget == NULL);
1971 scrolled_window = GTK_SCROLLED_WINDOW (container);
1972 priv = scrolled_window->priv;
1974 _gtk_bin_set_child (bin, child);
1975 gtk_widget_set_parent (child, GTK_WIDGET (bin));
1977 hadj = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->priv->hscrollbar));
1978 vadj = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->priv->vscrollbar));
1980 if (GTK_IS_SCROLLABLE (child))
1981 g_object_set (child, "hadjustment", hadj, "vadjustment", vadj, NULL);
1983 g_warning ("gtk_scrolled_window_add(): cannot add non scrollable widget "
1984 "use gtk_scrolled_window_add_with_viewport() instead");
1988 gtk_scrolled_window_remove (GtkContainer *container,
1991 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (container));
1992 g_return_if_fail (child != NULL);
1993 g_return_if_fail (gtk_bin_get_child (GTK_BIN (container)) == child);
1995 g_object_set (child, "hadjustment", NULL, "vadjustment", NULL, NULL);
1997 /* chain parent class handler to remove child */
1998 GTK_CONTAINER_CLASS (gtk_scrolled_window_parent_class)->remove (container, child);
2002 * gtk_scrolled_window_add_with_viewport:
2003 * @scrolled_window: a #GtkScrolledWindow
2004 * @child: the widget you want to scroll
2006 * Used to add children without native scrolling capabilities. This
2007 * is simply a convenience function; it is equivalent to adding the
2008 * unscrollable child to a viewport, then adding the viewport to the
2009 * scrolled window. If a child has native scrolling, use
2010 * gtk_container_add() instead of this function.
2012 * The viewport scrolls the child by moving its #GdkWindow, and takes
2013 * the size of the child to be the size of its toplevel #GdkWindow.
2014 * This will be very wrong for most widgets that support native scrolling;
2015 * for example, if you add a widget such as #GtkTreeView with a viewport,
2016 * the whole widget will scroll, including the column headings. Thus,
2017 * widgets with native scrolling support should not be used with the
2018 * #GtkViewport proxy.
2020 * A widget supports scrolling natively if it implements the
2021 * #GtkScrollable interface.
2024 gtk_scrolled_window_add_with_viewport (GtkScrolledWindow *scrolled_window,
2028 GtkWidget *viewport;
2029 GtkWidget *child_widget;
2031 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
2032 g_return_if_fail (GTK_IS_WIDGET (child));
2033 g_return_if_fail (gtk_widget_get_parent (child) == NULL);
2035 bin = GTK_BIN (scrolled_window);
2036 child_widget = gtk_bin_get_child (bin);
2040 g_return_if_fail (GTK_IS_VIEWPORT (child_widget));
2041 g_return_if_fail (gtk_bin_get_child (GTK_BIN (child_widget)) == NULL);
2043 viewport = child_widget;
2048 gtk_viewport_new (gtk_scrolled_window_get_hadjustment (scrolled_window),
2049 gtk_scrolled_window_get_vadjustment (scrolled_window));
2050 gtk_container_add (GTK_CONTAINER (scrolled_window), viewport);
2053 gtk_widget_show (viewport);
2054 gtk_container_add (GTK_CONTAINER (viewport), child);
2058 * _gtk_scrolled_window_get_spacing:
2059 * @scrolled_window: a scrolled window
2061 * Gets the spacing between the scrolled window's scrollbars and
2062 * the scrolled widget. Used by GtkCombo
2064 * Return value: the spacing, in pixels.
2067 _gtk_scrolled_window_get_scrollbar_spacing (GtkScrolledWindow *scrolled_window)
2069 GtkScrolledWindowClass *class;
2071 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), 0);
2073 class = GTK_SCROLLED_WINDOW_GET_CLASS (scrolled_window);
2075 if (class->scrollbar_spacing >= 0)
2076 return class->scrollbar_spacing;
2079 gint scrollbar_spacing;
2081 gtk_widget_style_get (GTK_WIDGET (scrolled_window),
2082 "scrollbar-spacing", &scrollbar_spacing,
2085 return scrollbar_spacing;
2091 gtk_scrolled_window_get_preferred_size (GtkWidget *widget,
2092 GtkOrientation orientation,
2096 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (widget);
2097 GtkScrolledWindowPrivate *priv = scrolled_window->priv;
2098 GtkBin *bin = GTK_BIN (scrolled_window);
2101 gint scrollbar_spacing;
2102 GtkRequisition hscrollbar_requisition;
2103 GtkRequisition vscrollbar_requisition;
2104 GtkRequisition minimum_req, natural_req;
2106 gint min_child_size, nat_child_size;
2108 scrollbar_spacing = _gtk_scrolled_window_get_scrollbar_spacing (scrolled_window);
2112 minimum_req.width = 0;
2113 minimum_req.height = 0;
2114 natural_req.width = 0;
2115 natural_req.height = 0;
2117 gtk_widget_get_preferred_size (priv->hscrollbar,
2118 &hscrollbar_requisition, NULL);
2119 gtk_widget_get_preferred_size (priv->vscrollbar,
2120 &vscrollbar_requisition, NULL);
2122 child = gtk_bin_get_child (bin);
2123 if (child && gtk_widget_get_visible (child))
2125 if (orientation == GTK_ORIENTATION_HORIZONTAL)
2127 gtk_widget_get_preferred_width (child,
2131 if (priv->hscrollbar_policy == GTK_POLICY_NEVER)
2133 minimum_req.width += min_child_size;
2134 natural_req.width += nat_child_size;
2138 gint min_content_width = priv->min_content_width;
2140 if (min_content_width >= 0)
2142 minimum_req.width = MAX (minimum_req.width, min_content_width);
2143 natural_req.width = MAX (natural_req.width, min_content_width);
2148 minimum_req.width += vscrollbar_requisition.width;
2149 natural_req.width += vscrollbar_requisition.width;
2153 else /* GTK_ORIENTATION_VERTICAL */
2155 gtk_widget_get_preferred_height (child,
2159 if (priv->vscrollbar_policy == GTK_POLICY_NEVER)
2161 minimum_req.height += min_child_size;
2162 natural_req.height += nat_child_size;
2166 gint min_content_height = priv->min_content_height;
2168 if (min_content_height >= 0)
2170 minimum_req.height = MAX (minimum_req.height, min_content_height);
2171 natural_req.height = MAX (natural_req.height, min_content_height);
2176 minimum_req.height += vscrollbar_requisition.height;
2177 natural_req.height += vscrollbar_requisition.height;
2183 if (priv->hscrollbar_policy == GTK_POLICY_AUTOMATIC ||
2184 priv->hscrollbar_policy == GTK_POLICY_ALWAYS)
2186 minimum_req.width = MAX (minimum_req.width, hscrollbar_requisition.width);
2187 natural_req.width = MAX (natural_req.width, hscrollbar_requisition.width);
2188 if (!extra_height || priv->hscrollbar_policy == GTK_POLICY_ALWAYS)
2189 extra_height = scrollbar_spacing + hscrollbar_requisition.height;
2192 if (priv->vscrollbar_policy == GTK_POLICY_AUTOMATIC ||
2193 priv->vscrollbar_policy == GTK_POLICY_ALWAYS)
2195 minimum_req.height = MAX (minimum_req.height, vscrollbar_requisition.height);
2196 natural_req.height = MAX (natural_req.height, vscrollbar_requisition.height);
2197 if (!extra_width || priv->vscrollbar_policy == GTK_POLICY_ALWAYS)
2198 extra_width = scrollbar_spacing + vscrollbar_requisition.width;
2201 minimum_req.width += MAX (0, extra_width);
2202 minimum_req.height += MAX (0, extra_height);
2203 natural_req.width += MAX (0, extra_width);
2204 natural_req.height += MAX (0, extra_height);
2206 if (priv->shadow_type != GTK_SHADOW_NONE)
2208 GtkStyleContext *context;
2209 GtkStateFlags state;
2210 GtkBorder padding, border;
2212 context = gtk_widget_get_style_context (GTK_WIDGET (widget));
2213 state = gtk_widget_get_state_flags (GTK_WIDGET (widget));
2215 gtk_style_context_save (context);
2216 gtk_style_context_add_class (context, GTK_STYLE_CLASS_FRAME);
2218 gtk_style_context_get_padding (context, state, &padding);
2219 gtk_style_context_get_border (context, state, &border);
2221 minimum_req.width += padding.left + padding.right + border.left + border.right;
2222 minimum_req.height += padding.top + padding.bottom + border.top + border.bottom;
2223 natural_req.width += padding.left + padding.right + border.left + border.right;
2224 natural_req.height += padding.top + padding.bottom + border.top + border.bottom;
2226 gtk_style_context_restore (context);
2229 if (orientation == GTK_ORIENTATION_HORIZONTAL)
2232 *minimum_size = minimum_req.width;
2234 *natural_size = natural_req.width;
2239 *minimum_size = minimum_req.height;
2241 *natural_size = natural_req.height;
2246 gtk_scrolled_window_get_preferred_width (GtkWidget *widget,
2250 gtk_scrolled_window_get_preferred_size (widget, GTK_ORIENTATION_HORIZONTAL, minimum_size, natural_size);
2254 gtk_scrolled_window_get_preferred_height (GtkWidget *widget,
2258 gtk_scrolled_window_get_preferred_size (widget, GTK_ORIENTATION_VERTICAL, minimum_size, natural_size);
2262 gtk_scrolled_window_get_preferred_height_for_width (GtkWidget *widget,
2264 gint *minimum_height,
2265 gint *natural_height)
2267 g_return_if_fail (GTK_IS_WIDGET (widget));
2269 GTK_WIDGET_GET_CLASS (widget)->get_preferred_height (widget, minimum_height, natural_height);
2273 gtk_scrolled_window_get_preferred_width_for_height (GtkWidget *widget,
2275 gint *minimum_width,
2276 gint *natural_width)
2278 g_return_if_fail (GTK_IS_WIDGET (widget));
2280 GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, minimum_width, natural_width);
2284 * gtk_scrolled_window_get_min_content_width:
2285 * @scrolled_window: a #GtkScrolledWindow
2287 * Gets the minimum content width of @scrolled_window, or -1 if not set.
2289 * Returns: the minimum content width
2294 gtk_scrolled_window_get_min_content_width (GtkScrolledWindow *scrolled_window)
2296 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), 0);
2298 return scrolled_window->priv->min_content_width;
2302 * gtk_scrolled_window_set_min_content_width:
2303 * @scrolled_window: a #GtkScrolledWindow
2304 * @width: the minimal content width
2306 * Sets the minimum width that @scrolled_window should keep visible.
2307 * Note that this can and (usually will) be smaller than the minimum
2308 * size of the content.
2313 gtk_scrolled_window_set_min_content_width (GtkScrolledWindow *scrolled_window,
2316 GtkScrolledWindowPrivate *priv;
2318 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
2320 priv = scrolled_window->priv;
2322 if (priv->min_content_width != width)
2324 priv->min_content_width = width;
2326 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
2328 g_object_notify (G_OBJECT (scrolled_window), "min-content-width");
2333 * gtk_scrolled_window_get_min_content_height:
2334 * @scrolled_window: a #GtkScrolledWindow
2336 * Gets the minimal content height of @scrolled_window, or -1 if not set.
2338 * Returns: the minimal content height
2343 gtk_scrolled_window_get_min_content_height (GtkScrolledWindow *scrolled_window)
2345 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), 0);
2347 return scrolled_window->priv->min_content_height;
2351 * gtk_scrolled_window_set_min_content_height:
2352 * @scrolled_window: a #GtkScrolledWindow
2353 * @height: the minimal content height
2355 * Sets the minimum height that @scrolled_window should keep visible.
2356 * Note that this can and (usually will) be smaller than the minimum
2357 * size of the content.
2362 gtk_scrolled_window_set_min_content_height (GtkScrolledWindow *scrolled_window,
2365 GtkScrolledWindowPrivate *priv;
2367 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
2369 priv = scrolled_window->priv;
2371 if (priv->min_content_height != height)
2373 priv->min_content_height = height;
2375 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
2377 g_object_notify (G_OBJECT (scrolled_window), "min-content-height");