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_request (GtkWidget *widget,
118 GtkRequisition *requisition);
119 static void gtk_scrolled_window_size_allocate (GtkWidget *widget,
120 GtkAllocation *allocation);
121 static gboolean gtk_scrolled_window_scroll_event (GtkWidget *widget,
122 GdkEventScroll *event);
123 static gboolean gtk_scrolled_window_focus (GtkWidget *widget,
124 GtkDirectionType direction);
125 static void gtk_scrolled_window_add (GtkContainer *container,
127 static void gtk_scrolled_window_remove (GtkContainer *container,
129 static void gtk_scrolled_window_forall (GtkContainer *container,
130 gboolean include_internals,
131 GtkCallback callback,
132 gpointer callback_data);
133 static gboolean gtk_scrolled_window_scroll_child (GtkScrolledWindow *scrolled_window,
134 GtkScrollType scroll,
135 gboolean horizontal);
136 static void gtk_scrolled_window_move_focus_out (GtkScrolledWindow *scrolled_window,
137 GtkDirectionType direction_type);
139 static void gtk_scrolled_window_relative_allocation(GtkWidget *widget,
140 GtkAllocation *allocation);
141 static void gtk_scrolled_window_adjustment_changed (GtkAdjustment *adjustment,
144 static void gtk_scrolled_window_update_real_placement (GtkScrolledWindow *scrolled_window);
146 static void gtk_scrolled_window_extended_layout_init (GtkExtendedLayoutIface *iface);
148 static guint signals[LAST_SIGNAL] = {0};
150 G_DEFINE_TYPE_WITH_CODE (GtkScrolledWindow, gtk_scrolled_window, GTK_TYPE_BIN,
151 G_IMPLEMENT_INTERFACE (GTK_TYPE_EXTENDED_LAYOUT,
152 gtk_scrolled_window_extended_layout_init))
156 add_scroll_binding (GtkBindingSet *binding_set,
158 GdkModifierType mask,
159 GtkScrollType scroll,
162 guint keypad_keyval = keyval - GDK_Left + GDK_KP_Left;
164 gtk_binding_entry_add_signal (binding_set, keyval, mask,
166 GTK_TYPE_SCROLL_TYPE, scroll,
167 G_TYPE_BOOLEAN, horizontal);
168 gtk_binding_entry_add_signal (binding_set, keypad_keyval, mask,
170 GTK_TYPE_SCROLL_TYPE, scroll,
171 G_TYPE_BOOLEAN, horizontal);
175 add_tab_bindings (GtkBindingSet *binding_set,
176 GdkModifierType modifiers,
177 GtkDirectionType direction)
179 gtk_binding_entry_add_signal (binding_set, GDK_Tab, modifiers,
181 GTK_TYPE_DIRECTION_TYPE, direction);
182 gtk_binding_entry_add_signal (binding_set, GDK_KP_Tab, modifiers,
184 GTK_TYPE_DIRECTION_TYPE, direction);
188 gtk_scrolled_window_class_init (GtkScrolledWindowClass *class)
190 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
191 GtkObjectClass *object_class;
192 GtkWidgetClass *widget_class;
193 GtkContainerClass *container_class;
194 GtkBindingSet *binding_set;
196 object_class = (GtkObjectClass*) class;
197 widget_class = (GtkWidgetClass*) class;
198 container_class = (GtkContainerClass*) class;
200 gobject_class->set_property = gtk_scrolled_window_set_property;
201 gobject_class->get_property = gtk_scrolled_window_get_property;
203 object_class->destroy = gtk_scrolled_window_destroy;
205 widget_class->screen_changed = gtk_scrolled_window_screen_changed;
206 widget_class->expose_event = gtk_scrolled_window_expose;
207 widget_class->size_request = gtk_scrolled_window_size_request;
208 widget_class->size_allocate = gtk_scrolled_window_size_allocate;
209 widget_class->scroll_event = gtk_scrolled_window_scroll_event;
210 widget_class->focus = gtk_scrolled_window_focus;
212 container_class->add = gtk_scrolled_window_add;
213 container_class->remove = gtk_scrolled_window_remove;
214 container_class->forall = gtk_scrolled_window_forall;
216 class->scrollbar_spacing = -1;
218 class->scroll_child = gtk_scrolled_window_scroll_child;
219 class->move_focus_out = gtk_scrolled_window_move_focus_out;
221 g_object_class_install_property (gobject_class,
223 g_param_spec_object ("hadjustment",
224 P_("Horizontal Adjustment"),
225 P_("The GtkAdjustment for the horizontal position"),
227 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
228 g_object_class_install_property (gobject_class,
230 g_param_spec_object ("vadjustment",
231 P_("Vertical Adjustment"),
232 P_("The GtkAdjustment for the vertical position"),
234 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
235 g_object_class_install_property (gobject_class,
236 PROP_HSCROLLBAR_POLICY,
237 g_param_spec_enum ("hscrollbar-policy",
238 P_("Horizontal Scrollbar Policy"),
239 P_("When the horizontal scrollbar is displayed"),
240 GTK_TYPE_POLICY_TYPE,
242 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
243 g_object_class_install_property (gobject_class,
244 PROP_VSCROLLBAR_POLICY,
245 g_param_spec_enum ("vscrollbar-policy",
246 P_("Vertical Scrollbar Policy"),
247 P_("When the vertical scrollbar is displayed"),
248 GTK_TYPE_POLICY_TYPE,
250 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
252 g_object_class_install_property (gobject_class,
253 PROP_WINDOW_PLACEMENT,
254 g_param_spec_enum ("window-placement",
255 P_("Window Placement"),
256 P_("Where the contents are located with respect to the scrollbars. This property only takes effect if \"window-placement-set\" is TRUE."),
257 GTK_TYPE_CORNER_TYPE,
259 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
262 * GtkScrolledWindow:window-placement-set:
264 * Whether "window-placement" should be used to determine the location
265 * of the contents with respect to the scrollbars. Otherwise, the
266 * "gtk-scrolled-window-placement" setting is used.
270 g_object_class_install_property (gobject_class,
271 PROP_WINDOW_PLACEMENT_SET,
272 g_param_spec_boolean ("window-placement-set",
273 P_("Window Placement Set"),
274 P_("Whether \"window-placement\" should be used to determine the location of the contents with respect to the scrollbars."),
276 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
277 g_object_class_install_property (gobject_class,
279 g_param_spec_enum ("shadow-type",
281 P_("Style of bevel around the contents"),
282 GTK_TYPE_SHADOW_TYPE,
284 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
287 * GtkScrolledWindow:scrollbars-within-bevel:
289 * Whether to place scrollbars within the scrolled window's bevel.
293 gtk_widget_class_install_style_property (widget_class,
294 g_param_spec_boolean ("scrollbars-within-bevel",
295 P_("Scrollbars within bevel"),
296 P_("Place scrollbars within the scrolled window's bevel"),
298 GTK_PARAM_READABLE));
300 gtk_widget_class_install_style_property (widget_class,
301 g_param_spec_int ("scrollbar-spacing",
302 P_("Scrollbar spacing"),
303 P_("Number of pixels between the scrollbars and the scrolled window"),
306 DEFAULT_SCROLLBAR_SPACING,
307 GTK_PARAM_READABLE));
310 * GtkSettings:gtk-scrolled-window-placement:
312 * Where the contents of scrolled windows are located with respect to the
313 * scrollbars, if not overridden by the scrolled window's own placement.
317 gtk_settings_install_property (g_param_spec_enum ("gtk-scrolled-window-placement",
318 P_("Scrolled Window Placement"),
319 P_("Where the contents of scrolled windows are located with respect to the scrollbars, if not overridden by the scrolled window's own placement."),
320 GTK_TYPE_CORNER_TYPE,
322 G_PARAM_READABLE | G_PARAM_WRITABLE));
325 signals[SCROLL_CHILD] =
326 g_signal_new (I_("scroll-child"),
327 G_TYPE_FROM_CLASS (object_class),
328 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
329 G_STRUCT_OFFSET (GtkScrolledWindowClass, scroll_child),
331 _gtk_marshal_BOOLEAN__ENUM_BOOLEAN,
333 GTK_TYPE_SCROLL_TYPE,
335 signals[MOVE_FOCUS_OUT] =
336 g_signal_new (I_("move-focus-out"),
337 G_TYPE_FROM_CLASS (object_class),
338 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
339 G_STRUCT_OFFSET (GtkScrolledWindowClass, move_focus_out),
341 _gtk_marshal_VOID__ENUM,
343 GTK_TYPE_DIRECTION_TYPE);
345 binding_set = gtk_binding_set_by_class (class);
347 add_scroll_binding (binding_set, GDK_Left, GDK_CONTROL_MASK, GTK_SCROLL_STEP_BACKWARD, TRUE);
348 add_scroll_binding (binding_set, GDK_Right, GDK_CONTROL_MASK, GTK_SCROLL_STEP_FORWARD, TRUE);
349 add_scroll_binding (binding_set, GDK_Up, GDK_CONTROL_MASK, GTK_SCROLL_STEP_BACKWARD, FALSE);
350 add_scroll_binding (binding_set, GDK_Down, GDK_CONTROL_MASK, GTK_SCROLL_STEP_FORWARD, FALSE);
352 add_scroll_binding (binding_set, GDK_Page_Up, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_BACKWARD, TRUE);
353 add_scroll_binding (binding_set, GDK_Page_Down, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_FORWARD, TRUE);
354 add_scroll_binding (binding_set, GDK_Page_Up, 0, GTK_SCROLL_PAGE_BACKWARD, FALSE);
355 add_scroll_binding (binding_set, GDK_Page_Down, 0, GTK_SCROLL_PAGE_FORWARD, FALSE);
357 add_scroll_binding (binding_set, GDK_Home, GDK_CONTROL_MASK, GTK_SCROLL_START, TRUE);
358 add_scroll_binding (binding_set, GDK_End, GDK_CONTROL_MASK, GTK_SCROLL_END, TRUE);
359 add_scroll_binding (binding_set, GDK_Home, 0, GTK_SCROLL_START, FALSE);
360 add_scroll_binding (binding_set, GDK_End, 0, GTK_SCROLL_END, FALSE);
362 add_tab_bindings (binding_set, GDK_CONTROL_MASK, GTK_DIR_TAB_FORWARD);
363 add_tab_bindings (binding_set, GDK_CONTROL_MASK | GDK_SHIFT_MASK, GTK_DIR_TAB_BACKWARD);
365 g_type_class_add_private (class, sizeof (GtkScrolledWindowPrivate));
369 gtk_scrolled_window_init (GtkScrolledWindow *scrolled_window)
371 gtk_widget_set_has_window (GTK_WIDGET (scrolled_window), FALSE);
372 gtk_widget_set_can_focus (GTK_WIDGET (scrolled_window), TRUE);
374 scrolled_window->hscrollbar = NULL;
375 scrolled_window->vscrollbar = NULL;
376 scrolled_window->hscrollbar_policy = GTK_POLICY_ALWAYS;
377 scrolled_window->vscrollbar_policy = GTK_POLICY_ALWAYS;
378 scrolled_window->hscrollbar_visible = FALSE;
379 scrolled_window->vscrollbar_visible = FALSE;
380 scrolled_window->focus_out = FALSE;
381 scrolled_window->window_placement = GTK_CORNER_TOP_LEFT;
382 gtk_scrolled_window_update_real_placement (scrolled_window);
386 * gtk_scrolled_window_new:
387 * @hadjustment: (allow-none): horizontal adjustment
388 * @vadjustment: (allow-none): vertical adjustment
390 * Creates a new scrolled window.
392 * The two arguments are the scrolled window's adjustments; these will be
393 * shared with the scrollbars and the child widget to keep the bars in sync
394 * with the child. Usually you want to pass %NULL for the adjustments, which
395 * will cause the scrolled window to create them for you.
397 * Returns: a new scrolled window
400 gtk_scrolled_window_new (GtkAdjustment *hadjustment,
401 GtkAdjustment *vadjustment)
403 GtkWidget *scrolled_window;
406 g_return_val_if_fail (GTK_IS_ADJUSTMENT (hadjustment), NULL);
409 g_return_val_if_fail (GTK_IS_ADJUSTMENT (vadjustment), NULL);
411 scrolled_window = g_object_new (GTK_TYPE_SCROLLED_WINDOW,
412 "hadjustment", hadjustment,
413 "vadjustment", vadjustment,
416 return scrolled_window;
420 * gtk_scrolled_window_set_hadjustment:
421 * @scrolled_window: a #GtkScrolledWindow
422 * @hadjustment: horizontal scroll adjustment
424 * Sets the #GtkAdjustment for the horizontal scrollbar.
427 gtk_scrolled_window_set_hadjustment (GtkScrolledWindow *scrolled_window,
428 GtkAdjustment *hadjustment)
432 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
434 g_return_if_fail (GTK_IS_ADJUSTMENT (hadjustment));
436 hadjustment = (GtkAdjustment*) g_object_new (GTK_TYPE_ADJUSTMENT, NULL);
438 bin = GTK_BIN (scrolled_window);
440 if (!scrolled_window->hscrollbar)
442 gtk_widget_push_composite_child ();
443 scrolled_window->hscrollbar = gtk_hscrollbar_new (hadjustment);
444 gtk_widget_set_composite_name (scrolled_window->hscrollbar, "hscrollbar");
445 gtk_widget_pop_composite_child ();
447 gtk_widget_set_parent (scrolled_window->hscrollbar, GTK_WIDGET (scrolled_window));
448 g_object_ref (scrolled_window->hscrollbar);
449 gtk_widget_show (scrolled_window->hscrollbar);
453 GtkAdjustment *old_adjustment;
455 old_adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
456 if (old_adjustment == hadjustment)
459 g_signal_handlers_disconnect_by_func (old_adjustment,
460 gtk_scrolled_window_adjustment_changed,
462 gtk_range_set_adjustment (GTK_RANGE (scrolled_window->hscrollbar),
465 hadjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
466 g_signal_connect (hadjustment,
468 G_CALLBACK (gtk_scrolled_window_adjustment_changed),
470 gtk_scrolled_window_adjustment_changed (hadjustment, scrolled_window);
473 gtk_widget_set_scroll_adjustments (bin->child,
474 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
475 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)));
477 g_object_notify (G_OBJECT (scrolled_window), "hadjustment");
481 * gtk_scrolled_window_set_vadjustment:
482 * @scrolled_window: a #GtkScrolledWindow
483 * @vadjustment: vertical scroll adjustment
485 * Sets the #GtkAdjustment for the vertical scrollbar.
488 gtk_scrolled_window_set_vadjustment (GtkScrolledWindow *scrolled_window,
489 GtkAdjustment *vadjustment)
493 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
495 g_return_if_fail (GTK_IS_ADJUSTMENT (vadjustment));
497 vadjustment = (GtkAdjustment*) g_object_new (GTK_TYPE_ADJUSTMENT, NULL);
499 bin = GTK_BIN (scrolled_window);
501 if (!scrolled_window->vscrollbar)
503 gtk_widget_push_composite_child ();
504 scrolled_window->vscrollbar = gtk_vscrollbar_new (vadjustment);
505 gtk_widget_set_composite_name (scrolled_window->vscrollbar, "vscrollbar");
506 gtk_widget_pop_composite_child ();
508 gtk_widget_set_parent (scrolled_window->vscrollbar, GTK_WIDGET (scrolled_window));
509 g_object_ref (scrolled_window->vscrollbar);
510 gtk_widget_show (scrolled_window->vscrollbar);
514 GtkAdjustment *old_adjustment;
516 old_adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
517 if (old_adjustment == vadjustment)
520 g_signal_handlers_disconnect_by_func (old_adjustment,
521 gtk_scrolled_window_adjustment_changed,
523 gtk_range_set_adjustment (GTK_RANGE (scrolled_window->vscrollbar),
526 vadjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
527 g_signal_connect (vadjustment,
529 G_CALLBACK (gtk_scrolled_window_adjustment_changed),
531 gtk_scrolled_window_adjustment_changed (vadjustment, scrolled_window);
534 gtk_widget_set_scroll_adjustments (bin->child,
535 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
536 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)));
538 g_object_notify (G_OBJECT (scrolled_window), "vadjustment");
542 * gtk_scrolled_window_get_hadjustment:
543 * @scrolled_window: a #GtkScrolledWindow
545 * Returns the horizontal scrollbar's adjustment, used to connect the
546 * horizontal scrollbar to the child widget's horizontal scroll
549 * Returns: the horizontal #GtkAdjustment
552 gtk_scrolled_window_get_hadjustment (GtkScrolledWindow *scrolled_window)
554 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
556 return (scrolled_window->hscrollbar ?
557 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)) :
562 * gtk_scrolled_window_get_vadjustment:
563 * @scrolled_window: a #GtkScrolledWindow
565 * Returns the vertical scrollbar's adjustment, used to connect the
566 * vertical scrollbar to the child widget's vertical scroll
569 * Returns: the vertical #GtkAdjustment
572 gtk_scrolled_window_get_vadjustment (GtkScrolledWindow *scrolled_window)
574 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
576 return (scrolled_window->vscrollbar ?
577 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)) :
582 * gtk_scrolled_window_get_hscrollbar:
583 * @scrolled_window: a #GtkScrolledWindow
585 * Returns the horizontal scrollbar of @scrolled_window.
587 * Returns: the horizontal scrollbar of the scrolled window, or
588 * %NULL if it does not have one.
593 gtk_scrolled_window_get_hscrollbar (GtkScrolledWindow *scrolled_window)
595 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
597 return scrolled_window->hscrollbar;
601 * gtk_scrolled_window_get_vscrollbar:
602 * @scrolled_window: a #GtkScrolledWindow
604 * Returns the vertical scrollbar of @scrolled_window.
606 * Returns: the vertical scrollbar of the scrolled window, or
607 * %NULL if it does not have one.
612 gtk_scrolled_window_get_vscrollbar (GtkScrolledWindow *scrolled_window)
614 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
616 return scrolled_window->vscrollbar;
620 * gtk_scrolled_window_set_policy:
621 * @scrolled_window: a #GtkScrolledWindow
622 * @hscrollbar_policy: policy for horizontal bar
623 * @vscrollbar_policy: policy for vertical bar
625 * Sets the scrollbar policy for the horizontal and vertical scrollbars.
627 * The policy determines when the scrollbar should appear; it is a value
628 * from the #GtkPolicyType enumeration. If %GTK_POLICY_ALWAYS, the
629 * scrollbar is always present; if %GTK_POLICY_NEVER, the scrollbar is
630 * never present; if %GTK_POLICY_AUTOMATIC, the scrollbar is present only
631 * if needed (that is, if the slider part of the bar would be smaller
632 * than the trough - the display is larger than the page size).
635 gtk_scrolled_window_set_policy (GtkScrolledWindow *scrolled_window,
636 GtkPolicyType hscrollbar_policy,
637 GtkPolicyType vscrollbar_policy)
639 GObject *object = G_OBJECT (scrolled_window);
641 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
643 if ((scrolled_window->hscrollbar_policy != hscrollbar_policy) ||
644 (scrolled_window->vscrollbar_policy != vscrollbar_policy))
646 scrolled_window->hscrollbar_policy = hscrollbar_policy;
647 scrolled_window->vscrollbar_policy = vscrollbar_policy;
649 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
651 g_object_freeze_notify (object);
652 g_object_notify (object, "hscrollbar-policy");
653 g_object_notify (object, "vscrollbar-policy");
654 g_object_thaw_notify (object);
659 * gtk_scrolled_window_get_policy:
660 * @scrolled_window: a #GtkScrolledWindow
661 * @hscrollbar_policy: location to store the policy for the horizontal
662 * scrollbar, or %NULL.
663 * @vscrollbar_policy: location to store the policy for the vertical
664 * scrollbar, or %NULL.
666 * Retrieves the current policy values for the horizontal and vertical
667 * scrollbars. See gtk_scrolled_window_set_policy().
670 gtk_scrolled_window_get_policy (GtkScrolledWindow *scrolled_window,
671 GtkPolicyType *hscrollbar_policy,
672 GtkPolicyType *vscrollbar_policy)
674 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
676 if (hscrollbar_policy)
677 *hscrollbar_policy = scrolled_window->hscrollbar_policy;
678 if (vscrollbar_policy)
679 *vscrollbar_policy = scrolled_window->vscrollbar_policy;
683 gtk_scrolled_window_update_real_placement (GtkScrolledWindow *scrolled_window)
685 GtkScrolledWindowPrivate *priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
686 GtkSettings *settings;
688 settings = gtk_widget_get_settings (GTK_WIDGET (scrolled_window));
690 if (priv->window_placement_set || settings == NULL)
691 priv->real_window_placement = scrolled_window->window_placement;
693 g_object_get (settings,
694 "gtk-scrolled-window-placement",
695 &priv->real_window_placement,
700 gtk_scrolled_window_set_placement_internal (GtkScrolledWindow *scrolled_window,
701 GtkCornerType window_placement)
703 if (scrolled_window->window_placement != window_placement)
705 scrolled_window->window_placement = window_placement;
707 gtk_scrolled_window_update_real_placement (scrolled_window);
708 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
710 g_object_notify (G_OBJECT (scrolled_window), "window-placement");
715 gtk_scrolled_window_set_placement_set (GtkScrolledWindow *scrolled_window,
716 gboolean placement_set,
717 gboolean emit_resize)
719 GtkScrolledWindowPrivate *priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
721 if (priv->window_placement_set != placement_set)
723 priv->window_placement_set = placement_set;
725 gtk_scrolled_window_update_real_placement (scrolled_window);
727 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
729 g_object_notify (G_OBJECT (scrolled_window), "window-placement-set");
734 * gtk_scrolled_window_set_placement:
735 * @scrolled_window: a #GtkScrolledWindow
736 * @window_placement: position of the child window
738 * Sets the placement of the contents with respect to the scrollbars
739 * for the scrolled window.
741 * The default is %GTK_CORNER_TOP_LEFT, meaning the child is
742 * in the top left, with the scrollbars underneath and to the right.
743 * Other values in #GtkCornerType are %GTK_CORNER_TOP_RIGHT,
744 * %GTK_CORNER_BOTTOM_LEFT, and %GTK_CORNER_BOTTOM_RIGHT.
746 * See also gtk_scrolled_window_get_placement() and
747 * gtk_scrolled_window_unset_placement().
750 gtk_scrolled_window_set_placement (GtkScrolledWindow *scrolled_window,
751 GtkCornerType window_placement)
753 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
755 gtk_scrolled_window_set_placement_set (scrolled_window, TRUE, FALSE);
756 gtk_scrolled_window_set_placement_internal (scrolled_window, window_placement);
760 * gtk_scrolled_window_get_placement:
761 * @scrolled_window: a #GtkScrolledWindow
763 * Gets the placement of the contents with respect to the scrollbars
764 * for the scrolled window. See gtk_scrolled_window_set_placement().
766 * Return value: the current placement value.
768 * See also gtk_scrolled_window_set_placement() and
769 * gtk_scrolled_window_unset_placement().
772 gtk_scrolled_window_get_placement (GtkScrolledWindow *scrolled_window)
774 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), GTK_CORNER_TOP_LEFT);
776 return scrolled_window->window_placement;
780 * gtk_scrolled_window_unset_placement:
781 * @scrolled_window: a #GtkScrolledWindow
783 * Unsets the placement of the contents with respect to the scrollbars
784 * for the scrolled window. If no window placement is set for a scrolled
785 * window, it obeys the "gtk-scrolled-window-placement" XSETTING.
787 * See also gtk_scrolled_window_set_placement() and
788 * gtk_scrolled_window_get_placement().
793 gtk_scrolled_window_unset_placement (GtkScrolledWindow *scrolled_window)
795 GtkScrolledWindowPrivate *priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
797 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
799 if (priv->window_placement_set)
801 priv->window_placement_set = FALSE;
803 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
805 g_object_notify (G_OBJECT (scrolled_window), "window-placement-set");
810 * gtk_scrolled_window_set_shadow_type:
811 * @scrolled_window: a #GtkScrolledWindow
812 * @type: kind of shadow to draw around scrolled window contents
814 * Changes the type of shadow drawn around the contents of
819 gtk_scrolled_window_set_shadow_type (GtkScrolledWindow *scrolled_window,
822 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
823 g_return_if_fail (type >= GTK_SHADOW_NONE && type <= GTK_SHADOW_ETCHED_OUT);
825 if (scrolled_window->shadow_type != type)
827 scrolled_window->shadow_type = type;
829 if (gtk_widget_is_drawable (GTK_WIDGET (scrolled_window)))
830 gtk_widget_queue_draw (GTK_WIDGET (scrolled_window));
832 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
834 g_object_notify (G_OBJECT (scrolled_window), "shadow-type");
839 * gtk_scrolled_window_get_shadow_type:
840 * @scrolled_window: a #GtkScrolledWindow
842 * Gets the shadow type of the scrolled window. See
843 * gtk_scrolled_window_set_shadow_type().
845 * Return value: the current shadow type
848 gtk_scrolled_window_get_shadow_type (GtkScrolledWindow *scrolled_window)
850 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), GTK_SHADOW_NONE);
852 return scrolled_window->shadow_type;
856 gtk_scrolled_window_destroy (GtkObject *object)
858 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
860 if (scrolled_window->hscrollbar)
862 g_signal_handlers_disconnect_by_func (gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
863 gtk_scrolled_window_adjustment_changed,
865 gtk_widget_unparent (scrolled_window->hscrollbar);
866 gtk_widget_destroy (scrolled_window->hscrollbar);
867 g_object_unref (scrolled_window->hscrollbar);
868 scrolled_window->hscrollbar = NULL;
870 if (scrolled_window->vscrollbar)
872 g_signal_handlers_disconnect_by_func (gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)),
873 gtk_scrolled_window_adjustment_changed,
875 gtk_widget_unparent (scrolled_window->vscrollbar);
876 gtk_widget_destroy (scrolled_window->vscrollbar);
877 g_object_unref (scrolled_window->vscrollbar);
878 scrolled_window->vscrollbar = NULL;
881 GTK_OBJECT_CLASS (gtk_scrolled_window_parent_class)->destroy (object);
885 gtk_scrolled_window_set_property (GObject *object,
890 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
894 case PROP_HADJUSTMENT:
895 gtk_scrolled_window_set_hadjustment (scrolled_window,
896 g_value_get_object (value));
898 case PROP_VADJUSTMENT:
899 gtk_scrolled_window_set_vadjustment (scrolled_window,
900 g_value_get_object (value));
902 case PROP_HSCROLLBAR_POLICY:
903 gtk_scrolled_window_set_policy (scrolled_window,
904 g_value_get_enum (value),
905 scrolled_window->vscrollbar_policy);
907 case PROP_VSCROLLBAR_POLICY:
908 gtk_scrolled_window_set_policy (scrolled_window,
909 scrolled_window->hscrollbar_policy,
910 g_value_get_enum (value));
912 case PROP_WINDOW_PLACEMENT:
913 gtk_scrolled_window_set_placement_internal (scrolled_window,
914 g_value_get_enum (value));
916 case PROP_WINDOW_PLACEMENT_SET:
917 gtk_scrolled_window_set_placement_set (scrolled_window,
918 g_value_get_boolean (value),
921 case PROP_SHADOW_TYPE:
922 gtk_scrolled_window_set_shadow_type (scrolled_window,
923 g_value_get_enum (value));
926 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
932 gtk_scrolled_window_get_property (GObject *object,
937 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
938 GtkScrolledWindowPrivate *priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
942 case PROP_HADJUSTMENT:
943 g_value_set_object (value,
944 G_OBJECT (gtk_scrolled_window_get_hadjustment (scrolled_window)));
946 case PROP_VADJUSTMENT:
947 g_value_set_object (value,
948 G_OBJECT (gtk_scrolled_window_get_vadjustment (scrolled_window)));
950 case PROP_HSCROLLBAR_POLICY:
951 g_value_set_enum (value, scrolled_window->hscrollbar_policy);
953 case PROP_VSCROLLBAR_POLICY:
954 g_value_set_enum (value, scrolled_window->vscrollbar_policy);
956 case PROP_WINDOW_PLACEMENT:
957 g_value_set_enum (value, scrolled_window->window_placement);
959 case PROP_WINDOW_PLACEMENT_SET:
960 g_value_set_boolean (value, priv->window_placement_set);
962 case PROP_SHADOW_TYPE:
963 g_value_set_enum (value, scrolled_window->shadow_type);
966 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
972 traverse_container (GtkWidget *widget,
975 if (GTK_IS_SCROLLED_WINDOW (widget))
977 gtk_scrolled_window_update_real_placement (GTK_SCROLLED_WINDOW (widget));
978 gtk_widget_queue_resize (widget);
980 else if (GTK_IS_CONTAINER (widget))
981 gtk_container_forall (GTK_CONTAINER (widget), traverse_container, NULL);
985 gtk_scrolled_window_settings_changed (GtkSettings *settings)
989 list = gtk_window_list_toplevels ();
991 for (l = list; l; l = l->next)
992 gtk_container_forall (GTK_CONTAINER (l->data),
993 traverse_container, NULL);
999 gtk_scrolled_window_screen_changed (GtkWidget *widget,
1000 GdkScreen *previous_screen)
1002 GtkSettings *settings;
1003 guint window_placement_connection;
1005 gtk_scrolled_window_update_real_placement (GTK_SCROLLED_WINDOW (widget));
1007 if (!gtk_widget_has_screen (widget))
1010 settings = gtk_widget_get_settings (widget);
1012 window_placement_connection =
1013 GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (settings),
1014 "gtk-scrolled-window-connection"));
1016 if (window_placement_connection)
1019 window_placement_connection =
1020 g_signal_connect (settings, "notify::gtk-scrolled-window-placement",
1021 G_CALLBACK (gtk_scrolled_window_settings_changed), NULL);
1022 g_object_set_data (G_OBJECT (settings),
1023 I_("gtk-scrolled-window-connection"),
1024 GUINT_TO_POINTER (window_placement_connection));
1028 gtk_scrolled_window_paint (GtkWidget *widget,
1031 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (widget);
1033 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1035 GtkAllocation relative_allocation;
1036 gboolean scrollbars_within_bevel;
1038 gtk_widget_style_get (widget, "scrollbars-within-bevel", &scrollbars_within_bevel, NULL);
1040 if (!scrollbars_within_bevel)
1042 gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
1044 relative_allocation.x -= widget->style->xthickness;
1045 relative_allocation.y -= widget->style->ythickness;
1046 relative_allocation.width += 2 * widget->style->xthickness;
1047 relative_allocation.height += 2 * widget->style->ythickness;
1051 GtkContainer *container = GTK_CONTAINER (widget);
1053 relative_allocation.x = container->border_width;
1054 relative_allocation.y = container->border_width;
1055 relative_allocation.width = widget->allocation.width - 2 * container->border_width;
1056 relative_allocation.height = widget->allocation.height - 2 * container->border_width;
1059 gtk_paint_shadow (widget->style, widget->window,
1060 GTK_STATE_NORMAL, scrolled_window->shadow_type,
1061 area, widget, "scrolled_window",
1062 widget->allocation.x + relative_allocation.x,
1063 widget->allocation.y + relative_allocation.y,
1064 relative_allocation.width,
1065 relative_allocation.height);
1070 gtk_scrolled_window_expose (GtkWidget *widget,
1071 GdkEventExpose *event)
1073 if (gtk_widget_is_drawable (widget))
1075 gtk_scrolled_window_paint (widget, &event->area);
1077 GTK_WIDGET_CLASS (gtk_scrolled_window_parent_class)->expose_event (widget, event);
1084 gtk_scrolled_window_forall (GtkContainer *container,
1085 gboolean include_internals,
1086 GtkCallback callback,
1087 gpointer callback_data)
1089 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (container));
1090 g_return_if_fail (callback != NULL);
1092 GTK_CONTAINER_CLASS (gtk_scrolled_window_parent_class)->forall (container,
1096 if (include_internals)
1098 GtkScrolledWindow *scrolled_window;
1100 scrolled_window = GTK_SCROLLED_WINDOW (container);
1102 if (scrolled_window->vscrollbar)
1103 callback (scrolled_window->vscrollbar, callback_data);
1104 if (scrolled_window->hscrollbar)
1105 callback (scrolled_window->hscrollbar, callback_data);
1110 gtk_scrolled_window_scroll_child (GtkScrolledWindow *scrolled_window,
1111 GtkScrollType scroll,
1112 gboolean horizontal)
1114 GtkAdjustment *adjustment = NULL;
1118 case GTK_SCROLL_STEP_UP:
1119 scroll = GTK_SCROLL_STEP_BACKWARD;
1122 case GTK_SCROLL_STEP_DOWN:
1123 scroll = GTK_SCROLL_STEP_FORWARD;
1126 case GTK_SCROLL_STEP_LEFT:
1127 scroll = GTK_SCROLL_STEP_BACKWARD;
1130 case GTK_SCROLL_STEP_RIGHT:
1131 scroll = GTK_SCROLL_STEP_FORWARD;
1134 case GTK_SCROLL_PAGE_UP:
1135 scroll = GTK_SCROLL_PAGE_BACKWARD;
1138 case GTK_SCROLL_PAGE_DOWN:
1139 scroll = GTK_SCROLL_PAGE_FORWARD;
1142 case GTK_SCROLL_PAGE_LEFT:
1143 scroll = GTK_SCROLL_STEP_BACKWARD;
1146 case GTK_SCROLL_PAGE_RIGHT:
1147 scroll = GTK_SCROLL_STEP_FORWARD;
1150 case GTK_SCROLL_STEP_BACKWARD:
1151 case GTK_SCROLL_STEP_FORWARD:
1152 case GTK_SCROLL_PAGE_BACKWARD:
1153 case GTK_SCROLL_PAGE_FORWARD:
1154 case GTK_SCROLL_START:
1155 case GTK_SCROLL_END:
1158 g_warning ("Invalid scroll type %u for GtkScrolledWindow::scroll-child", scroll);
1162 if ((horizontal && (!scrolled_window->hscrollbar || !scrolled_window->hscrollbar_visible)) ||
1163 (!horizontal && (!scrolled_window->vscrollbar || !scrolled_window->vscrollbar_visible)))
1168 if (scrolled_window->hscrollbar)
1169 adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
1173 if (scrolled_window->vscrollbar)
1174 adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
1179 gdouble value = adjustment->value;
1183 case GTK_SCROLL_STEP_FORWARD:
1184 value += adjustment->step_increment;
1186 case GTK_SCROLL_STEP_BACKWARD:
1187 value -= adjustment->step_increment;
1189 case GTK_SCROLL_PAGE_FORWARD:
1190 value += adjustment->page_increment;
1192 case GTK_SCROLL_PAGE_BACKWARD:
1193 value -= adjustment->page_increment;
1195 case GTK_SCROLL_START:
1196 value = adjustment->lower;
1198 case GTK_SCROLL_END:
1199 value = adjustment->upper;
1202 g_assert_not_reached ();
1206 value = CLAMP (value, adjustment->lower, adjustment->upper - adjustment->page_size);
1208 gtk_adjustment_set_value (adjustment, value);
1217 gtk_scrolled_window_move_focus_out (GtkScrolledWindow *scrolled_window,
1218 GtkDirectionType direction_type)
1220 GtkWidget *toplevel;
1222 /* Focus out of the scrolled window entirely. We do this by setting
1223 * a flag, then propagating the focus motion to the notebook.
1225 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (scrolled_window));
1226 if (!gtk_widget_is_toplevel (toplevel))
1229 g_object_ref (scrolled_window);
1231 scrolled_window->focus_out = TRUE;
1232 g_signal_emit_by_name (toplevel, "move-focus", direction_type);
1233 scrolled_window->focus_out = FALSE;
1235 g_object_unref (scrolled_window);
1239 gtk_scrolled_window_real_size_request (GtkWidget *widget,
1240 GtkRequisition *min_requisition,
1241 GtkRequisition *nat_requisition)
1243 GtkScrolledWindow *scrolled_window;
1247 gint scrollbar_spacing;
1248 GtkRequisition hscrollbar_requisition;
1249 GtkRequisition vscrollbar_requisition;
1250 GtkRequisition min_child_requisition;
1251 GtkRequisition nat_child_requisition;
1253 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (widget));
1255 scrolled_window = GTK_SCROLLED_WINDOW (widget);
1256 bin = GTK_BIN (scrolled_window);
1258 scrollbar_spacing = _gtk_scrolled_window_get_scrollbar_spacing (scrolled_window);
1262 min_requisition->width = 0;
1263 min_requisition->height = 0;
1264 nat_requisition->width = 0;
1265 nat_requisition->height = 0;
1267 gtk_widget_size_request (scrolled_window->hscrollbar,
1268 &hscrollbar_requisition);
1269 gtk_widget_size_request (scrolled_window->vscrollbar,
1270 &vscrollbar_requisition);
1272 if (bin->child && gtk_widget_get_visible (bin->child))
1274 gtk_extended_layout_get_desired_size (GTK_EXTENDED_LAYOUT (bin->child),
1275 &min_child_requisition,
1276 &nat_child_requisition);
1278 if (scrolled_window->hscrollbar_policy == GTK_POLICY_NEVER)
1280 min_requisition->width += min_child_requisition.width;
1281 nat_requisition->width += nat_child_requisition.width;
1285 GtkWidgetAuxInfo *aux_info = _gtk_widget_get_aux_info (bin->child, FALSE);
1287 if (aux_info && aux_info->width > 0)
1289 min_requisition->width += aux_info->width;
1290 nat_requisition->width += aux_info->width;
1295 min_requisition->width += vscrollbar_requisition.width;
1296 nat_requisition->width += vscrollbar_requisition.width;
1300 if (scrolled_window->vscrollbar_policy == GTK_POLICY_NEVER)
1302 min_requisition->height += min_child_requisition.height;
1303 nat_requisition->height += nat_child_requisition.height;
1307 GtkWidgetAuxInfo *aux_info = _gtk_widget_get_aux_info (bin->child, FALSE);
1309 if (aux_info && aux_info->height > 0)
1311 min_requisition->height += aux_info->height;
1312 nat_requisition->height += aux_info->height;
1317 min_requisition->height += hscrollbar_requisition.height;
1318 nat_requisition->height += hscrollbar_requisition.height;
1323 if (scrolled_window->hscrollbar_policy == GTK_POLICY_AUTOMATIC ||
1324 scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS)
1326 min_requisition->width = MAX (min_requisition->width, hscrollbar_requisition.width);
1327 nat_requisition->width = MAX (nat_requisition->width, hscrollbar_requisition.width);
1328 if (!extra_height || scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS)
1329 extra_height = scrollbar_spacing + hscrollbar_requisition.height;
1332 if (scrolled_window->vscrollbar_policy == GTK_POLICY_AUTOMATIC ||
1333 scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS)
1335 min_requisition->height = MAX (min_requisition->height, vscrollbar_requisition.height);
1336 nat_requisition->height = MAX (nat_requisition->height, vscrollbar_requisition.height);
1337 if (!extra_height || scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS)
1338 extra_width = scrollbar_spacing + vscrollbar_requisition.width;
1341 min_requisition->width += GTK_CONTAINER (widget)->border_width * 2 + MAX (0, extra_width);
1342 min_requisition->height += GTK_CONTAINER (widget)->border_width * 2 + MAX (0, extra_height);
1343 nat_requisition->width += GTK_CONTAINER (widget)->border_width * 2 + MAX (0, extra_width);
1344 nat_requisition->height += GTK_CONTAINER (widget)->border_width * 2 + MAX (0, extra_height);
1346 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1348 min_requisition->width += 2 * widget->style->xthickness;
1349 min_requisition->height += 2 * widget->style->ythickness;
1350 nat_requisition->width += 2 * widget->style->xthickness;
1351 nat_requisition->height += 2 * widget->style->ythickness;
1356 gtk_scrolled_window_size_request (GtkWidget *widget,
1357 GtkRequisition *requisition)
1359 GtkRequisition nat_req;
1361 gtk_scrolled_window_real_size_request (widget, requisition, &nat_req);
1365 gtk_scrolled_window_relative_allocation (GtkWidget *widget,
1366 GtkAllocation *allocation)
1368 GtkScrolledWindow *scrolled_window;
1369 GtkScrolledWindowPrivate *priv;
1370 gint scrollbar_spacing;
1372 g_return_if_fail (widget != NULL);
1373 g_return_if_fail (allocation != NULL);
1375 scrolled_window = GTK_SCROLLED_WINDOW (widget);
1376 scrollbar_spacing = _gtk_scrolled_window_get_scrollbar_spacing (scrolled_window);
1378 priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
1380 allocation->x = GTK_CONTAINER (widget)->border_width;
1381 allocation->y = GTK_CONTAINER (widget)->border_width;
1383 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1385 allocation->x += widget->style->xthickness;
1386 allocation->y += widget->style->ythickness;
1389 allocation->width = MAX (1, (gint)widget->allocation.width - allocation->x * 2);
1390 allocation->height = MAX (1, (gint)widget->allocation.height - allocation->y * 2);
1392 if (scrolled_window->vscrollbar_visible)
1394 GtkRequisition vscrollbar_requisition;
1397 gtk_widget_get_child_requisition (scrolled_window->vscrollbar,
1398 &vscrollbar_requisition);
1399 is_rtl = gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL;
1402 (priv->real_window_placement == GTK_CORNER_TOP_RIGHT ||
1403 priv->real_window_placement == GTK_CORNER_BOTTOM_RIGHT)) ||
1405 (priv->real_window_placement == GTK_CORNER_TOP_LEFT ||
1406 priv->real_window_placement == GTK_CORNER_BOTTOM_LEFT)))
1407 allocation->x += (vscrollbar_requisition.width + scrollbar_spacing);
1409 allocation->width = MAX (1, allocation->width - (vscrollbar_requisition.width + scrollbar_spacing));
1411 if (scrolled_window->hscrollbar_visible)
1413 GtkRequisition hscrollbar_requisition;
1414 gtk_widget_get_child_requisition (scrolled_window->hscrollbar,
1415 &hscrollbar_requisition);
1417 if (priv->real_window_placement == GTK_CORNER_BOTTOM_LEFT ||
1418 priv->real_window_placement == GTK_CORNER_BOTTOM_RIGHT)
1419 allocation->y += (hscrollbar_requisition.height + scrollbar_spacing);
1421 allocation->height = MAX (1, allocation->height - (hscrollbar_requisition.height + scrollbar_spacing));
1426 gtk_scrolled_window_size_allocate (GtkWidget *widget,
1427 GtkAllocation *allocation)
1429 GtkScrolledWindow *scrolled_window;
1430 GtkScrolledWindowPrivate *priv;
1432 GtkAllocation relative_allocation;
1433 GtkAllocation child_allocation;
1434 gboolean scrollbars_within_bevel;
1435 gint scrollbar_spacing;
1437 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (widget));
1438 g_return_if_fail (allocation != NULL);
1440 scrolled_window = GTK_SCROLLED_WINDOW (widget);
1441 bin = GTK_BIN (scrolled_window);
1443 scrollbar_spacing = _gtk_scrolled_window_get_scrollbar_spacing (scrolled_window);
1444 gtk_widget_style_get (widget, "scrollbars-within-bevel", &scrollbars_within_bevel, NULL);
1446 priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
1448 widget->allocation = *allocation;
1450 if (scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS)
1451 scrolled_window->hscrollbar_visible = TRUE;
1452 else if (scrolled_window->hscrollbar_policy == GTK_POLICY_NEVER)
1453 scrolled_window->hscrollbar_visible = FALSE;
1454 if (scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS)
1455 scrolled_window->vscrollbar_visible = TRUE;
1456 else if (scrolled_window->vscrollbar_policy == GTK_POLICY_NEVER)
1457 scrolled_window->vscrollbar_visible = FALSE;
1459 if (bin->child && gtk_widget_get_visible (bin->child))
1461 gboolean previous_hvis;
1462 gboolean previous_vvis;
1467 gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
1469 child_allocation.x = relative_allocation.x + allocation->x;
1470 child_allocation.y = relative_allocation.y + allocation->y;
1471 child_allocation.width = relative_allocation.width;
1472 child_allocation.height = relative_allocation.height;
1474 previous_hvis = scrolled_window->hscrollbar_visible;
1475 previous_vvis = scrolled_window->vscrollbar_visible;
1477 gtk_widget_size_allocate (bin->child, &child_allocation);
1479 /* If, after the first iteration, the hscrollbar and the
1480 * vscrollbar flip visiblity, then we need both.
1483 previous_hvis != scrolled_window->hscrollbar_visible &&
1484 previous_vvis != scrolled_window->vscrollbar_visible)
1486 scrolled_window->hscrollbar_visible = TRUE;
1487 scrolled_window->vscrollbar_visible = TRUE;
1489 /* a new resize is already queued at this point,
1490 * so we will immediatedly get reinvoked
1497 while (previous_hvis != scrolled_window->hscrollbar_visible ||
1498 previous_vvis != scrolled_window->vscrollbar_visible);
1502 scrolled_window->hscrollbar_visible = scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS;
1503 scrolled_window->vscrollbar_visible = scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS;
1504 gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
1507 if (scrolled_window->hscrollbar_visible)
1509 GtkRequisition hscrollbar_requisition;
1510 gtk_widget_get_child_requisition (scrolled_window->hscrollbar,
1511 &hscrollbar_requisition);
1513 if (!gtk_widget_get_visible (scrolled_window->hscrollbar))
1514 gtk_widget_show (scrolled_window->hscrollbar);
1516 child_allocation.x = relative_allocation.x;
1517 if (priv->real_window_placement == GTK_CORNER_TOP_LEFT ||
1518 priv->real_window_placement == GTK_CORNER_TOP_RIGHT)
1519 child_allocation.y = (relative_allocation.y +
1520 relative_allocation.height +
1522 (scrolled_window->shadow_type == GTK_SHADOW_NONE ?
1523 0 : widget->style->ythickness));
1525 child_allocation.y = GTK_CONTAINER (scrolled_window)->border_width;
1527 child_allocation.width = relative_allocation.width;
1528 child_allocation.height = hscrollbar_requisition.height;
1529 child_allocation.x += allocation->x;
1530 child_allocation.y += allocation->y;
1532 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1534 if (!scrollbars_within_bevel)
1536 child_allocation.x -= widget->style->xthickness;
1537 child_allocation.width += 2 * widget->style->xthickness;
1539 else if (GTK_CORNER_TOP_RIGHT == priv->real_window_placement ||
1540 GTK_CORNER_TOP_LEFT == priv->real_window_placement)
1542 child_allocation.y -= widget->style->ythickness;
1546 child_allocation.y += widget->style->ythickness;
1550 gtk_widget_size_allocate (scrolled_window->hscrollbar, &child_allocation);
1552 else if (gtk_widget_get_visible (scrolled_window->hscrollbar))
1553 gtk_widget_hide (scrolled_window->hscrollbar);
1555 if (scrolled_window->vscrollbar_visible)
1557 GtkRequisition vscrollbar_requisition;
1558 if (!gtk_widget_get_visible (scrolled_window->vscrollbar))
1559 gtk_widget_show (scrolled_window->vscrollbar);
1561 gtk_widget_get_child_requisition (scrolled_window->vscrollbar,
1562 &vscrollbar_requisition);
1564 if ((gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL &&
1565 (priv->real_window_placement == GTK_CORNER_TOP_RIGHT ||
1566 priv->real_window_placement == GTK_CORNER_BOTTOM_RIGHT)) ||
1567 (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR &&
1568 (priv->real_window_placement == GTK_CORNER_TOP_LEFT ||
1569 priv->real_window_placement == GTK_CORNER_BOTTOM_LEFT)))
1570 child_allocation.x = (relative_allocation.x +
1571 relative_allocation.width +
1573 (scrolled_window->shadow_type == GTK_SHADOW_NONE ?
1574 0 : widget->style->xthickness));
1576 child_allocation.x = GTK_CONTAINER (scrolled_window)->border_width;
1578 child_allocation.y = relative_allocation.y;
1579 child_allocation.width = vscrollbar_requisition.width;
1580 child_allocation.height = relative_allocation.height;
1581 child_allocation.x += allocation->x;
1582 child_allocation.y += allocation->y;
1584 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1586 if (!scrollbars_within_bevel)
1588 child_allocation.y -= widget->style->ythickness;
1589 child_allocation.height += 2 * widget->style->ythickness;
1591 else if (GTK_CORNER_BOTTOM_LEFT == priv->real_window_placement ||
1592 GTK_CORNER_TOP_LEFT == priv->real_window_placement)
1594 child_allocation.x -= widget->style->xthickness;
1598 child_allocation.x += widget->style->xthickness;
1602 gtk_widget_size_allocate (scrolled_window->vscrollbar, &child_allocation);
1604 else if (gtk_widget_get_visible (scrolled_window->vscrollbar))
1605 gtk_widget_hide (scrolled_window->vscrollbar);
1609 gtk_scrolled_window_scroll_event (GtkWidget *widget,
1610 GdkEventScroll *event)
1614 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (widget), FALSE);
1615 g_return_val_if_fail (event != NULL, FALSE);
1617 if (event->direction == GDK_SCROLL_UP || event->direction == GDK_SCROLL_DOWN)
1618 range = GTK_SCROLLED_WINDOW (widget)->vscrollbar;
1620 range = GTK_SCROLLED_WINDOW (widget)->hscrollbar;
1622 if (range && gtk_widget_get_visible (range))
1624 GtkAdjustment *adj = GTK_RANGE (range)->adjustment;
1625 gdouble delta, new_value;
1627 delta = _gtk_range_get_wheel_delta (GTK_RANGE (range), event->direction);
1629 new_value = CLAMP (adj->value + delta, adj->lower, adj->upper - adj->page_size);
1631 gtk_adjustment_set_value (adj, new_value);
1640 gtk_scrolled_window_focus (GtkWidget *widget,
1641 GtkDirectionType direction)
1643 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (widget);
1644 gboolean had_focus_child = GTK_CONTAINER (widget)->focus_child != NULL;
1646 if (scrolled_window->focus_out)
1648 scrolled_window->focus_out = FALSE; /* Clear this to catch the wrap-around case */
1652 if (gtk_widget_is_focus (widget))
1655 /* We only put the scrolled window itself in the focus chain if it
1656 * isn't possible to focus any children.
1658 if (GTK_BIN (widget)->child)
1660 if (gtk_widget_child_focus (GTK_BIN (widget)->child, direction))
1664 if (!had_focus_child && gtk_widget_get_can_focus (widget))
1666 gtk_widget_grab_focus (widget);
1674 gtk_scrolled_window_adjustment_changed (GtkAdjustment *adjustment,
1677 GtkScrolledWindow *scrolled_win;
1679 g_return_if_fail (adjustment != NULL);
1680 g_return_if_fail (data != NULL);
1682 scrolled_win = GTK_SCROLLED_WINDOW (data);
1684 if (scrolled_win->hscrollbar &&
1685 adjustment == gtk_range_get_adjustment (GTK_RANGE (scrolled_win->hscrollbar)))
1687 if (scrolled_win->hscrollbar_policy == GTK_POLICY_AUTOMATIC)
1691 visible = scrolled_win->hscrollbar_visible;
1692 scrolled_win->hscrollbar_visible = (adjustment->upper - adjustment->lower >
1693 adjustment->page_size);
1694 if (scrolled_win->hscrollbar_visible != visible)
1695 gtk_widget_queue_resize (GTK_WIDGET (scrolled_win));
1698 else if (scrolled_win->vscrollbar &&
1699 adjustment == gtk_range_get_adjustment (GTK_RANGE (scrolled_win->vscrollbar)))
1701 if (scrolled_win->vscrollbar_policy == GTK_POLICY_AUTOMATIC)
1705 visible = scrolled_win->vscrollbar_visible;
1706 scrolled_win->vscrollbar_visible = (adjustment->upper - adjustment->lower >
1707 adjustment->page_size);
1708 if (scrolled_win->vscrollbar_visible != visible)
1709 gtk_widget_queue_resize (GTK_WIDGET (scrolled_win));
1715 gtk_scrolled_window_add (GtkContainer *container,
1718 GtkScrolledWindow *scrolled_window;
1721 bin = GTK_BIN (container);
1722 g_return_if_fail (bin->child == NULL);
1724 scrolled_window = GTK_SCROLLED_WINDOW (container);
1727 gtk_widget_set_parent (child, GTK_WIDGET (bin));
1729 /* this is a temporary message */
1730 if (!gtk_widget_set_scroll_adjustments (child,
1731 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
1732 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar))))
1733 g_warning ("gtk_scrolled_window_add(): cannot add non scrollable widget "
1734 "use gtk_scrolled_window_add_with_viewport() instead");
1738 gtk_scrolled_window_remove (GtkContainer *container,
1741 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (container));
1742 g_return_if_fail (child != NULL);
1743 g_return_if_fail (GTK_BIN (container)->child == child);
1745 gtk_widget_set_scroll_adjustments (child, NULL, NULL);
1747 /* chain parent class handler to remove child */
1748 GTK_CONTAINER_CLASS (gtk_scrolled_window_parent_class)->remove (container, child);
1752 * gtk_scrolled_window_add_with_viewport:
1753 * @scrolled_window: a #GtkScrolledWindow
1754 * @child: the widget you want to scroll
1756 * Used to add children without native scrolling capabilities. This
1757 * is simply a convenience function; it is equivalent to adding the
1758 * unscrollable child to a viewport, then adding the viewport to the
1759 * scrolled window. If a child has native scrolling, use
1760 * gtk_container_add() instead of this function.
1762 * The viewport scrolls the child by moving its #GdkWindow, and takes
1763 * the size of the child to be the size of its toplevel #GdkWindow.
1764 * This will be very wrong for most widgets that support native scrolling;
1765 * for example, if you add a widget such as #GtkTreeView with a viewport,
1766 * the whole widget will scroll, including the column headings. Thus,
1767 * widgets with native scrolling support should not be used with the
1768 * #GtkViewport proxy.
1770 * A widget supports scrolling natively if the
1771 * set_scroll_adjustments_signal field in #GtkWidgetClass is non-zero,
1772 * i.e. has been filled in with a valid signal identifier.
1775 gtk_scrolled_window_add_with_viewport (GtkScrolledWindow *scrolled_window,
1779 GtkWidget *viewport;
1781 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
1782 g_return_if_fail (GTK_IS_WIDGET (child));
1783 g_return_if_fail (child->parent == NULL);
1785 bin = GTK_BIN (scrolled_window);
1787 if (bin->child != NULL)
1789 g_return_if_fail (GTK_IS_VIEWPORT (bin->child));
1790 g_return_if_fail (GTK_BIN (bin->child)->child == NULL);
1792 viewport = bin->child;
1797 gtk_viewport_new (gtk_scrolled_window_get_hadjustment (scrolled_window),
1798 gtk_scrolled_window_get_vadjustment (scrolled_window));
1799 gtk_container_add (GTK_CONTAINER (scrolled_window), viewport);
1802 gtk_widget_show (viewport);
1803 gtk_container_add (GTK_CONTAINER (viewport), child);
1807 * _gtk_scrolled_window_get_spacing:
1808 * @scrolled_window: a scrolled window
1810 * Gets the spacing between the scrolled window's scrollbars and
1811 * the scrolled widget. Used by GtkCombo
1813 * Return value: the spacing, in pixels.
1816 _gtk_scrolled_window_get_scrollbar_spacing (GtkScrolledWindow *scrolled_window)
1818 GtkScrolledWindowClass *class;
1820 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), 0);
1822 class = GTK_SCROLLED_WINDOW_GET_CLASS (scrolled_window);
1824 if (class->scrollbar_spacing >= 0)
1825 return class->scrollbar_spacing;
1828 gint scrollbar_spacing;
1830 gtk_widget_style_get (GTK_WIDGET (scrolled_window),
1831 "scrollbar-spacing", &scrollbar_spacing,
1834 return scrollbar_spacing;
1839 gtk_scrolled_window_extended_layout_get_desired_size (GtkExtendedLayout *layout,
1840 GtkRequisition *minimal_size,
1841 GtkRequisition *natural_size)
1843 GtkRequisition min_req, nat_req;
1845 gtk_scrolled_window_real_size_request (GTK_WIDGET (layout), &min_req, &nat_req);
1848 *minimal_size = min_req;
1851 *natural_size = nat_req;
1855 gtk_scrolled_window_extended_layout_init (GtkExtendedLayoutIface *iface)
1857 iface->get_desired_size = gtk_scrolled_window_extended_layout_get_desired_size;
1860 #define __GTK_SCROLLED_WINDOW_C__
1861 #include "gtkaliasdef.c"