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 "gtkmarshalers.h"
32 #include "gtkscrolledwindow.h"
33 #include "gtkwindow.h"
34 #include "gtkprivate.h"
39 /* scrolled window policy and size requisition handling:
41 * gtk size requisition works as follows:
42 * a widget upon size-request reports the width and height that it finds
43 * to be best suited to display its contents, including children.
44 * the width and/or height reported from a widget upon size requisition
45 * may be overidden by the user by specifying a width and/or height
46 * other than 0 through gtk_widget_set_size_request().
48 * a scrolled window needs (for implementing all three policy types) to
49 * request its width and height based on two different rationales.
50 * 1) the user wants the scrolled window to just fit into the space
51 * that it gets allocated for a specifc dimension.
52 * 1.1) this does not apply if the user specified a concrete value
53 * value for that specific dimension by either specifying usize for the
54 * scrolled window or for its child.
55 * 2) the user wants the scrolled window to take as much space up as
56 * is desired by the child for a specifc dimension (i.e. POLICY_NEVER).
58 * also, kinda obvious:
59 * 3) a user would certainly not have choosen a scrolled window as a container
60 * for the child, if the resulting allocation takes up more space than the
61 * child would have allocated without the scrolled window.
64 * A) from 1) follows: the scrolled window shouldn't request more space for a
65 * specifc dimension than is required at minimum.
66 * B) from 1.1) follows: the requisition may be overidden by usize of the scrolled
67 * window (done automatically) or by usize of the child (needs to be checked).
68 * C) from 2) follows: for POLICY_NEVER, the scrolled window simply reports the
70 * D) from 3) follows: the scrolled window child's minimum width and minimum height
71 * under A) at least correspond to the space taken up by its scrollbars.
74 #define DEFAULT_SCROLLBAR_SPACING 3
77 gboolean window_placement_set;
78 GtkCornerType real_window_placement;
79 } GtkScrolledWindowPrivate;
81 #define GTK_SCROLLED_WINDOW_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_SCROLLED_WINDOW, GtkScrolledWindowPrivate))
87 PROP_HSCROLLBAR_POLICY,
88 PROP_VSCROLLBAR_POLICY,
89 PROP_WINDOW_PLACEMENT,
90 PROP_WINDOW_PLACEMENT_SET,
102 static void gtk_scrolled_window_destroy (GtkObject *object);
103 static void gtk_scrolled_window_set_property (GObject *object,
107 static void gtk_scrolled_window_get_property (GObject *object,
112 static void gtk_scrolled_window_screen_changed (GtkWidget *widget,
113 GdkScreen *previous_screen);
114 static gboolean gtk_scrolled_window_expose (GtkWidget *widget,
115 GdkEventExpose *event);
116 static void gtk_scrolled_window_size_request (GtkWidget *widget,
117 GtkRequisition *requisition);
118 static void gtk_scrolled_window_size_allocate (GtkWidget *widget,
119 GtkAllocation *allocation);
120 static gboolean gtk_scrolled_window_scroll_event (GtkWidget *widget,
121 GdkEventScroll *event);
122 static gboolean gtk_scrolled_window_focus (GtkWidget *widget,
123 GtkDirectionType direction);
124 static void gtk_scrolled_window_add (GtkContainer *container,
126 static void gtk_scrolled_window_remove (GtkContainer *container,
128 static void gtk_scrolled_window_forall (GtkContainer *container,
129 gboolean include_internals,
130 GtkCallback callback,
131 gpointer callback_data);
132 static gboolean gtk_scrolled_window_scroll_child (GtkScrolledWindow *scrolled_window,
133 GtkScrollType scroll,
134 gboolean horizontal);
135 static void gtk_scrolled_window_move_focus_out (GtkScrolledWindow *scrolled_window,
136 GtkDirectionType direction_type);
138 static void gtk_scrolled_window_relative_allocation(GtkWidget *widget,
139 GtkAllocation *allocation);
140 static void gtk_scrolled_window_adjustment_changed (GtkAdjustment *adjustment,
143 static void gtk_scrolled_window_update_real_placement (GtkScrolledWindow *scrolled_window);
145 static guint signals[LAST_SIGNAL] = {0};
147 G_DEFINE_TYPE (GtkScrolledWindow, gtk_scrolled_window, GTK_TYPE_BIN)
150 add_scroll_binding (GtkBindingSet *binding_set,
152 GdkModifierType mask,
153 GtkScrollType scroll,
156 guint keypad_keyval = keyval - GDK_Left + GDK_KP_Left;
158 gtk_binding_entry_add_signal (binding_set, keyval, mask,
160 GTK_TYPE_SCROLL_TYPE, scroll,
161 G_TYPE_BOOLEAN, horizontal);
162 gtk_binding_entry_add_signal (binding_set, keypad_keyval, mask,
164 GTK_TYPE_SCROLL_TYPE, scroll,
165 G_TYPE_BOOLEAN, horizontal);
169 add_tab_bindings (GtkBindingSet *binding_set,
170 GdkModifierType modifiers,
171 GtkDirectionType direction)
173 gtk_binding_entry_add_signal (binding_set, GDK_Tab, modifiers,
175 GTK_TYPE_DIRECTION_TYPE, direction);
176 gtk_binding_entry_add_signal (binding_set, GDK_KP_Tab, modifiers,
178 GTK_TYPE_DIRECTION_TYPE, direction);
182 gtk_scrolled_window_class_init (GtkScrolledWindowClass *class)
184 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
185 GtkObjectClass *object_class;
186 GtkWidgetClass *widget_class;
187 GtkContainerClass *container_class;
188 GtkBindingSet *binding_set;
190 object_class = (GtkObjectClass*) class;
191 widget_class = (GtkWidgetClass*) class;
192 container_class = (GtkContainerClass*) class;
194 gobject_class->set_property = gtk_scrolled_window_set_property;
195 gobject_class->get_property = gtk_scrolled_window_get_property;
197 object_class->destroy = gtk_scrolled_window_destroy;
199 widget_class->screen_changed = gtk_scrolled_window_screen_changed;
200 widget_class->expose_event = gtk_scrolled_window_expose;
201 widget_class->size_request = gtk_scrolled_window_size_request;
202 widget_class->size_allocate = gtk_scrolled_window_size_allocate;
203 widget_class->scroll_event = gtk_scrolled_window_scroll_event;
204 widget_class->focus = gtk_scrolled_window_focus;
206 container_class->add = gtk_scrolled_window_add;
207 container_class->remove = gtk_scrolled_window_remove;
208 container_class->forall = gtk_scrolled_window_forall;
210 class->scrollbar_spacing = -1;
212 class->scroll_child = gtk_scrolled_window_scroll_child;
213 class->move_focus_out = gtk_scrolled_window_move_focus_out;
215 g_object_class_install_property (gobject_class,
217 g_param_spec_object ("hadjustment",
218 P_("Horizontal Adjustment"),
219 P_("The GtkAdjustment for the horizontal position"),
221 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
222 g_object_class_install_property (gobject_class,
224 g_param_spec_object ("vadjustment",
225 P_("Vertical Adjustment"),
226 P_("The GtkAdjustment for the vertical position"),
228 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
229 g_object_class_install_property (gobject_class,
230 PROP_HSCROLLBAR_POLICY,
231 g_param_spec_enum ("hscrollbar-policy",
232 P_("Horizontal Scrollbar Policy"),
233 P_("When the horizontal scrollbar is displayed"),
234 GTK_TYPE_POLICY_TYPE,
236 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
237 g_object_class_install_property (gobject_class,
238 PROP_VSCROLLBAR_POLICY,
239 g_param_spec_enum ("vscrollbar-policy",
240 P_("Vertical Scrollbar Policy"),
241 P_("When the vertical scrollbar is displayed"),
242 GTK_TYPE_POLICY_TYPE,
244 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
246 g_object_class_install_property (gobject_class,
247 PROP_WINDOW_PLACEMENT,
248 g_param_spec_enum ("window-placement",
249 P_("Window Placement"),
250 P_("Where the contents are located with respect to the scrollbars. This property only takes effect if \"window-placement-set\" is TRUE."),
251 GTK_TYPE_CORNER_TYPE,
253 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
256 * GtkScrolledWindow:window-placement-set:
258 * Whether "window-placement" should be used to determine the location
259 * of the contents with respect to the scrollbars. Otherwise, the
260 * "gtk-scrolled-window-placement" setting is used.
264 g_object_class_install_property (gobject_class,
265 PROP_WINDOW_PLACEMENT_SET,
266 g_param_spec_boolean ("window-placement-set",
267 P_("Window Placement Set"),
268 P_("Whether \"window-placement\" should be used to determine the location of the contents with respect to the scrollbars."),
270 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
271 g_object_class_install_property (gobject_class,
273 g_param_spec_enum ("shadow-type",
275 P_("Style of bevel around the contents"),
276 GTK_TYPE_SHADOW_TYPE,
278 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
281 * GtkScrolledWindow:scrollbars-within-bevel:
283 * Whether to place scrollbars within the scrolled window's bevel.
287 gtk_widget_class_install_style_property (widget_class,
288 g_param_spec_boolean ("scrollbars-within-bevel",
289 P_("Scrollbars within bevel"),
290 P_("Place scrollbars within the scrolled window's bevel"),
292 GTK_PARAM_READABLE));
294 gtk_widget_class_install_style_property (widget_class,
295 g_param_spec_int ("scrollbar-spacing",
296 P_("Scrollbar spacing"),
297 P_("Number of pixels between the scrollbars and the scrolled window"),
300 DEFAULT_SCROLLBAR_SPACING,
301 GTK_PARAM_READABLE));
304 * GtkSettings:gtk-scrolled-window-placement:
306 * Where the contents of scrolled windows are located with respect to the
307 * scrollbars, if not overridden by the scrolled window's own placement.
311 gtk_settings_install_property (g_param_spec_enum ("gtk-scrolled-window-placement",
312 P_("Scrolled Window Placement"),
313 P_("Where the contents of scrolled windows are located with respect to the scrollbars, if not overridden by the scrolled window's own placement."),
314 GTK_TYPE_CORNER_TYPE,
316 G_PARAM_READABLE | G_PARAM_WRITABLE));
319 signals[SCROLL_CHILD] =
320 g_signal_new (I_("scroll-child"),
321 G_TYPE_FROM_CLASS (object_class),
322 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
323 G_STRUCT_OFFSET (GtkScrolledWindowClass, scroll_child),
325 _gtk_marshal_BOOLEAN__ENUM_BOOLEAN,
327 GTK_TYPE_SCROLL_TYPE,
329 signals[MOVE_FOCUS_OUT] =
330 g_signal_new (I_("move-focus-out"),
331 G_TYPE_FROM_CLASS (object_class),
332 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
333 G_STRUCT_OFFSET (GtkScrolledWindowClass, move_focus_out),
335 _gtk_marshal_VOID__ENUM,
337 GTK_TYPE_DIRECTION_TYPE);
339 binding_set = gtk_binding_set_by_class (class);
341 add_scroll_binding (binding_set, GDK_Left, GDK_CONTROL_MASK, GTK_SCROLL_STEP_BACKWARD, TRUE);
342 add_scroll_binding (binding_set, GDK_Right, GDK_CONTROL_MASK, GTK_SCROLL_STEP_FORWARD, TRUE);
343 add_scroll_binding (binding_set, GDK_Up, GDK_CONTROL_MASK, GTK_SCROLL_STEP_BACKWARD, FALSE);
344 add_scroll_binding (binding_set, GDK_Down, GDK_CONTROL_MASK, GTK_SCROLL_STEP_FORWARD, FALSE);
346 add_scroll_binding (binding_set, GDK_Page_Up, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_BACKWARD, TRUE);
347 add_scroll_binding (binding_set, GDK_Page_Down, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_FORWARD, TRUE);
348 add_scroll_binding (binding_set, GDK_Page_Up, 0, GTK_SCROLL_PAGE_BACKWARD, FALSE);
349 add_scroll_binding (binding_set, GDK_Page_Down, 0, GTK_SCROLL_PAGE_FORWARD, FALSE);
351 add_scroll_binding (binding_set, GDK_Home, GDK_CONTROL_MASK, GTK_SCROLL_START, TRUE);
352 add_scroll_binding (binding_set, GDK_End, GDK_CONTROL_MASK, GTK_SCROLL_END, TRUE);
353 add_scroll_binding (binding_set, GDK_Home, 0, GTK_SCROLL_START, FALSE);
354 add_scroll_binding (binding_set, GDK_End, 0, GTK_SCROLL_END, FALSE);
356 add_tab_bindings (binding_set, GDK_CONTROL_MASK, GTK_DIR_TAB_FORWARD);
357 add_tab_bindings (binding_set, GDK_CONTROL_MASK | GDK_SHIFT_MASK, GTK_DIR_TAB_BACKWARD);
359 g_type_class_add_private (class, sizeof (GtkScrolledWindowPrivate));
363 gtk_scrolled_window_init (GtkScrolledWindow *scrolled_window)
365 GTK_WIDGET_SET_FLAGS (scrolled_window, GTK_NO_WINDOW | GTK_CAN_FOCUS);
367 scrolled_window->hscrollbar = NULL;
368 scrolled_window->vscrollbar = NULL;
369 scrolled_window->hscrollbar_policy = GTK_POLICY_ALWAYS;
370 scrolled_window->vscrollbar_policy = GTK_POLICY_ALWAYS;
371 scrolled_window->hscrollbar_visible = FALSE;
372 scrolled_window->vscrollbar_visible = FALSE;
373 scrolled_window->focus_out = FALSE;
374 scrolled_window->window_placement = GTK_CORNER_TOP_LEFT;
375 gtk_scrolled_window_update_real_placement (scrolled_window);
379 * gtk_scrolled_window_new:
380 * @hadjustment: (allow-none): horizontal adjustment
381 * @vadjustment: (allow-none): vertical adjustment
383 * Creates a new scrolled window.
385 * The two arguments are the scrolled window's adjustments; these will be
386 * shared with the scrollbars and the child widget to keep the bars in sync
387 * with the child. Usually you want to pass %NULL for the adjustments, which
388 * will cause the scrolled window to create them for you.
390 * Returns: a new scrolled window
393 gtk_scrolled_window_new (GtkAdjustment *hadjustment,
394 GtkAdjustment *vadjustment)
396 GtkWidget *scrolled_window;
399 g_return_val_if_fail (GTK_IS_ADJUSTMENT (hadjustment), NULL);
402 g_return_val_if_fail (GTK_IS_ADJUSTMENT (vadjustment), NULL);
404 scrolled_window = g_object_new (GTK_TYPE_SCROLLED_WINDOW,
405 "hadjustment", hadjustment,
406 "vadjustment", vadjustment,
409 return scrolled_window;
413 * gtk_scrolled_window_set_hadjustment:
414 * @scrolled_window: a #GtkScrolledWindow
415 * @hadjustment: horizontal scroll adjustment
417 * Sets the #GtkAdjustment for the horizontal scrollbar.
420 gtk_scrolled_window_set_hadjustment (GtkScrolledWindow *scrolled_window,
421 GtkAdjustment *hadjustment)
425 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
427 g_return_if_fail (GTK_IS_ADJUSTMENT (hadjustment));
429 hadjustment = (GtkAdjustment*) g_object_new (GTK_TYPE_ADJUSTMENT, NULL);
431 bin = GTK_BIN (scrolled_window);
433 if (!scrolled_window->hscrollbar)
435 gtk_widget_push_composite_child ();
436 scrolled_window->hscrollbar = gtk_hscrollbar_new (hadjustment);
437 gtk_widget_set_composite_name (scrolled_window->hscrollbar, "hscrollbar");
438 gtk_widget_pop_composite_child ();
440 gtk_widget_set_parent (scrolled_window->hscrollbar, GTK_WIDGET (scrolled_window));
441 g_object_ref (scrolled_window->hscrollbar);
442 gtk_widget_show (scrolled_window->hscrollbar);
446 GtkAdjustment *old_adjustment;
448 old_adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
449 if (old_adjustment == hadjustment)
452 g_signal_handlers_disconnect_by_func (old_adjustment,
453 gtk_scrolled_window_adjustment_changed,
455 gtk_range_set_adjustment (GTK_RANGE (scrolled_window->hscrollbar),
458 hadjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
459 g_signal_connect (hadjustment,
461 G_CALLBACK (gtk_scrolled_window_adjustment_changed),
463 gtk_scrolled_window_adjustment_changed (hadjustment, scrolled_window);
466 gtk_widget_set_scroll_adjustments (bin->child,
467 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
468 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)));
470 g_object_notify (G_OBJECT (scrolled_window), "hadjustment");
474 * gtk_scrolled_window_set_vadjustment:
475 * @scrolled_window: a #GtkScrolledWindow
476 * @vadjustment: vertical scroll adjustment
478 * Sets the #GtkAdjustment for the vertical scrollbar.
481 gtk_scrolled_window_set_vadjustment (GtkScrolledWindow *scrolled_window,
482 GtkAdjustment *vadjustment)
486 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
488 g_return_if_fail (GTK_IS_ADJUSTMENT (vadjustment));
490 vadjustment = (GtkAdjustment*) g_object_new (GTK_TYPE_ADJUSTMENT, NULL);
492 bin = GTK_BIN (scrolled_window);
494 if (!scrolled_window->vscrollbar)
496 gtk_widget_push_composite_child ();
497 scrolled_window->vscrollbar = gtk_vscrollbar_new (vadjustment);
498 gtk_widget_set_composite_name (scrolled_window->vscrollbar, "vscrollbar");
499 gtk_widget_pop_composite_child ();
501 gtk_widget_set_parent (scrolled_window->vscrollbar, GTK_WIDGET (scrolled_window));
502 g_object_ref (scrolled_window->vscrollbar);
503 gtk_widget_show (scrolled_window->vscrollbar);
507 GtkAdjustment *old_adjustment;
509 old_adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
510 if (old_adjustment == vadjustment)
513 g_signal_handlers_disconnect_by_func (old_adjustment,
514 gtk_scrolled_window_adjustment_changed,
516 gtk_range_set_adjustment (GTK_RANGE (scrolled_window->vscrollbar),
519 vadjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
520 g_signal_connect (vadjustment,
522 G_CALLBACK (gtk_scrolled_window_adjustment_changed),
524 gtk_scrolled_window_adjustment_changed (vadjustment, scrolled_window);
527 gtk_widget_set_scroll_adjustments (bin->child,
528 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
529 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)));
531 g_object_notify (G_OBJECT (scrolled_window), "vadjustment");
535 * gtk_scrolled_window_get_hadjustment:
536 * @scrolled_window: a #GtkScrolledWindow
538 * Returns the horizontal scrollbar's adjustment, used to connect the
539 * horizontal scrollbar to the child widget's horizontal scroll
542 * Returns: the horizontal #GtkAdjustment
545 gtk_scrolled_window_get_hadjustment (GtkScrolledWindow *scrolled_window)
547 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
549 return (scrolled_window->hscrollbar ?
550 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)) :
555 * gtk_scrolled_window_get_vadjustment:
556 * @scrolled_window: a #GtkScrolledWindow
558 * Returns the vertical scrollbar's adjustment, used to connect the
559 * vertical scrollbar to the child widget's vertical scroll
562 * Returns: the vertical #GtkAdjustment
565 gtk_scrolled_window_get_vadjustment (GtkScrolledWindow *scrolled_window)
567 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
569 return (scrolled_window->vscrollbar ?
570 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)) :
575 * gtk_scrolled_window_get_hscrollbar:
576 * @scrolled_window: a #GtkScrolledWindow
578 * Returns the horizontal scrollbar of @scrolled_window.
580 * Returns: the horizontal scrollbar of the scrolled window, or
581 * %NULL if it does not have one.
586 gtk_scrolled_window_get_hscrollbar (GtkScrolledWindow *scrolled_window)
588 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
590 return scrolled_window->hscrollbar;
594 * gtk_scrolled_window_get_vscrollbar:
595 * @scrolled_window: a #GtkScrolledWindow
597 * Returns the vertical scrollbar of @scrolled_window.
599 * Returns: the vertical scrollbar of the scrolled window, or
600 * %NULL if it does not have one.
605 gtk_scrolled_window_get_vscrollbar (GtkScrolledWindow *scrolled_window)
607 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
609 return scrolled_window->vscrollbar;
613 * gtk_scrolled_window_set_policy:
614 * @scrolled_window: a #GtkScrolledWindow
615 * @hscrollbar_policy: policy for horizontal bar
616 * @vscrollbar_policy: policy for vertical bar
618 * Sets the scrollbar policy for the horizontal and vertical scrollbars.
620 * The policy determines when the scrollbar should appear; it is a value
621 * from the #GtkPolicyType enumeration. If %GTK_POLICY_ALWAYS, the
622 * scrollbar is always present; if %GTK_POLICY_NEVER, the scrollbar is
623 * never present; if %GTK_POLICY_AUTOMATIC, the scrollbar is present only
624 * if needed (that is, if the slider part of the bar would be smaller
625 * than the trough - the display is larger than the page size).
628 gtk_scrolled_window_set_policy (GtkScrolledWindow *scrolled_window,
629 GtkPolicyType hscrollbar_policy,
630 GtkPolicyType vscrollbar_policy)
632 GObject *object = G_OBJECT (scrolled_window);
634 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
636 if ((scrolled_window->hscrollbar_policy != hscrollbar_policy) ||
637 (scrolled_window->vscrollbar_policy != vscrollbar_policy))
639 scrolled_window->hscrollbar_policy = hscrollbar_policy;
640 scrolled_window->vscrollbar_policy = vscrollbar_policy;
642 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
644 g_object_freeze_notify (object);
645 g_object_notify (object, "hscrollbar-policy");
646 g_object_notify (object, "vscrollbar-policy");
647 g_object_thaw_notify (object);
652 * gtk_scrolled_window_get_policy:
653 * @scrolled_window: a #GtkScrolledWindow
654 * @hscrollbar_policy: location to store the policy for the horizontal
655 * scrollbar, or %NULL.
656 * @vscrollbar_policy: location to store the policy for the vertical
657 * scrollbar, or %NULL.
659 * Retrieves the current policy values for the horizontal and vertical
660 * scrollbars. See gtk_scrolled_window_set_policy().
663 gtk_scrolled_window_get_policy (GtkScrolledWindow *scrolled_window,
664 GtkPolicyType *hscrollbar_policy,
665 GtkPolicyType *vscrollbar_policy)
667 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
669 if (hscrollbar_policy)
670 *hscrollbar_policy = scrolled_window->hscrollbar_policy;
671 if (vscrollbar_policy)
672 *vscrollbar_policy = scrolled_window->vscrollbar_policy;
676 gtk_scrolled_window_update_real_placement (GtkScrolledWindow *scrolled_window)
678 GtkScrolledWindowPrivate *priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
679 GtkSettings *settings;
681 settings = gtk_widget_get_settings (GTK_WIDGET (scrolled_window));
683 if (priv->window_placement_set || settings == NULL)
684 priv->real_window_placement = scrolled_window->window_placement;
686 g_object_get (settings,
687 "gtk-scrolled-window-placement",
688 &priv->real_window_placement,
693 gtk_scrolled_window_set_placement_internal (GtkScrolledWindow *scrolled_window,
694 GtkCornerType window_placement)
696 if (scrolled_window->window_placement != window_placement)
698 scrolled_window->window_placement = window_placement;
700 gtk_scrolled_window_update_real_placement (scrolled_window);
701 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
703 g_object_notify (G_OBJECT (scrolled_window), "window-placement");
708 gtk_scrolled_window_set_placement_set (GtkScrolledWindow *scrolled_window,
709 gboolean placement_set,
710 gboolean emit_resize)
712 GtkScrolledWindowPrivate *priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
714 if (priv->window_placement_set != placement_set)
716 priv->window_placement_set = placement_set;
718 gtk_scrolled_window_update_real_placement (scrolled_window);
720 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
722 g_object_notify (G_OBJECT (scrolled_window), "window-placement-set");
727 * gtk_scrolled_window_set_placement:
728 * @scrolled_window: a #GtkScrolledWindow
729 * @window_placement: position of the child window
731 * Sets the placement of the contents with respect to the scrollbars
732 * for the scrolled window.
734 * The default is %GTK_CORNER_TOP_LEFT, meaning the child is
735 * in the top left, with the scrollbars underneath and to the right.
736 * Other values in #GtkCornerType are %GTK_CORNER_TOP_RIGHT,
737 * %GTK_CORNER_BOTTOM_LEFT, and %GTK_CORNER_BOTTOM_RIGHT.
739 * See also gtk_scrolled_window_get_placement() and
740 * gtk_scrolled_window_unset_placement().
743 gtk_scrolled_window_set_placement (GtkScrolledWindow *scrolled_window,
744 GtkCornerType window_placement)
746 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
748 gtk_scrolled_window_set_placement_set (scrolled_window, TRUE, FALSE);
749 gtk_scrolled_window_set_placement_internal (scrolled_window, window_placement);
753 * gtk_scrolled_window_get_placement:
754 * @scrolled_window: a #GtkScrolledWindow
756 * Gets the placement of the contents with respect to the scrollbars
757 * for the scrolled window. See gtk_scrolled_window_set_placement().
759 * Return value: the current placement value.
761 * See also gtk_scrolled_window_set_placement() and
762 * gtk_scrolled_window_unset_placement().
765 gtk_scrolled_window_get_placement (GtkScrolledWindow *scrolled_window)
767 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), GTK_CORNER_TOP_LEFT);
769 return scrolled_window->window_placement;
773 * gtk_scrolled_window_unset_placement:
774 * @scrolled_window: a #GtkScrolledWindow
776 * Unsets the placement of the contents with respect to the scrollbars
777 * for the scrolled window. If no window placement is set for a scrolled
778 * window, it obeys the "gtk-scrolled-window-placement" XSETTING.
780 * See also gtk_scrolled_window_set_placement() and
781 * gtk_scrolled_window_get_placement().
786 gtk_scrolled_window_unset_placement (GtkScrolledWindow *scrolled_window)
788 GtkScrolledWindowPrivate *priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
790 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
792 if (priv->window_placement_set)
794 priv->window_placement_set = FALSE;
796 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
798 g_object_notify (G_OBJECT (scrolled_window), "window-placement-set");
803 * gtk_scrolled_window_set_shadow_type:
804 * @scrolled_window: a #GtkScrolledWindow
805 * @type: kind of shadow to draw around scrolled window contents
807 * Changes the type of shadow drawn around the contents of
812 gtk_scrolled_window_set_shadow_type (GtkScrolledWindow *scrolled_window,
815 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
816 g_return_if_fail (type >= GTK_SHADOW_NONE && type <= GTK_SHADOW_ETCHED_OUT);
818 if (scrolled_window->shadow_type != type)
820 scrolled_window->shadow_type = type;
822 if (GTK_WIDGET_DRAWABLE (scrolled_window))
823 gtk_widget_queue_draw (GTK_WIDGET (scrolled_window));
825 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
827 g_object_notify (G_OBJECT (scrolled_window), "shadow-type");
832 * gtk_scrolled_window_get_shadow_type:
833 * @scrolled_window: a #GtkScrolledWindow
835 * Gets the shadow type of the scrolled window. See
836 * gtk_scrolled_window_set_shadow_type().
838 * Return value: the current shadow type
841 gtk_scrolled_window_get_shadow_type (GtkScrolledWindow *scrolled_window)
843 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), GTK_SHADOW_NONE);
845 return scrolled_window->shadow_type;
849 gtk_scrolled_window_destroy (GtkObject *object)
851 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
853 if (scrolled_window->hscrollbar)
855 g_signal_handlers_disconnect_by_func (gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
856 gtk_scrolled_window_adjustment_changed,
858 gtk_widget_unparent (scrolled_window->hscrollbar);
859 gtk_widget_destroy (scrolled_window->hscrollbar);
860 g_object_unref (scrolled_window->hscrollbar);
861 scrolled_window->hscrollbar = NULL;
863 if (scrolled_window->vscrollbar)
865 g_signal_handlers_disconnect_by_func (gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)),
866 gtk_scrolled_window_adjustment_changed,
868 gtk_widget_unparent (scrolled_window->vscrollbar);
869 gtk_widget_destroy (scrolled_window->vscrollbar);
870 g_object_unref (scrolled_window->vscrollbar);
871 scrolled_window->vscrollbar = NULL;
874 GTK_OBJECT_CLASS (gtk_scrolled_window_parent_class)->destroy (object);
878 gtk_scrolled_window_set_property (GObject *object,
883 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
887 case PROP_HADJUSTMENT:
888 gtk_scrolled_window_set_hadjustment (scrolled_window,
889 g_value_get_object (value));
891 case PROP_VADJUSTMENT:
892 gtk_scrolled_window_set_vadjustment (scrolled_window,
893 g_value_get_object (value));
895 case PROP_HSCROLLBAR_POLICY:
896 gtk_scrolled_window_set_policy (scrolled_window,
897 g_value_get_enum (value),
898 scrolled_window->vscrollbar_policy);
900 case PROP_VSCROLLBAR_POLICY:
901 gtk_scrolled_window_set_policy (scrolled_window,
902 scrolled_window->hscrollbar_policy,
903 g_value_get_enum (value));
905 case PROP_WINDOW_PLACEMENT:
906 gtk_scrolled_window_set_placement_internal (scrolled_window,
907 g_value_get_enum (value));
909 case PROP_WINDOW_PLACEMENT_SET:
910 gtk_scrolled_window_set_placement_set (scrolled_window,
911 g_value_get_boolean (value),
914 case PROP_SHADOW_TYPE:
915 gtk_scrolled_window_set_shadow_type (scrolled_window,
916 g_value_get_enum (value));
919 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
925 gtk_scrolled_window_get_property (GObject *object,
930 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
931 GtkScrolledWindowPrivate *priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
935 case PROP_HADJUSTMENT:
936 g_value_set_object (value,
937 G_OBJECT (gtk_scrolled_window_get_hadjustment (scrolled_window)));
939 case PROP_VADJUSTMENT:
940 g_value_set_object (value,
941 G_OBJECT (gtk_scrolled_window_get_vadjustment (scrolled_window)));
943 case PROP_HSCROLLBAR_POLICY:
944 g_value_set_enum (value, scrolled_window->hscrollbar_policy);
946 case PROP_VSCROLLBAR_POLICY:
947 g_value_set_enum (value, scrolled_window->vscrollbar_policy);
949 case PROP_WINDOW_PLACEMENT:
950 g_value_set_enum (value, scrolled_window->window_placement);
952 case PROP_WINDOW_PLACEMENT_SET:
953 g_value_set_boolean (value, priv->window_placement_set);
955 case PROP_SHADOW_TYPE:
956 g_value_set_enum (value, scrolled_window->shadow_type);
959 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
965 traverse_container (GtkWidget *widget,
968 if (GTK_IS_SCROLLED_WINDOW (widget))
970 gtk_scrolled_window_update_real_placement (GTK_SCROLLED_WINDOW (widget));
971 gtk_widget_queue_resize (widget);
973 else if (GTK_IS_CONTAINER (widget))
974 gtk_container_forall (GTK_CONTAINER (widget), traverse_container, NULL);
978 gtk_scrolled_window_settings_changed (GtkSettings *settings)
982 list = gtk_window_list_toplevels ();
984 for (l = list; l; l = l->next)
985 gtk_container_forall (GTK_CONTAINER (l->data),
986 traverse_container, NULL);
992 gtk_scrolled_window_screen_changed (GtkWidget *widget,
993 GdkScreen *previous_screen)
995 GtkSettings *settings;
996 guint window_placement_connection;
998 gtk_scrolled_window_update_real_placement (GTK_SCROLLED_WINDOW (widget));
1000 if (!gtk_widget_has_screen (widget))
1003 settings = gtk_widget_get_settings (widget);
1005 window_placement_connection =
1006 GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (settings),
1007 "gtk-scrolled-window-connection"));
1009 if (window_placement_connection)
1012 window_placement_connection =
1013 g_signal_connect (settings, "notify::gtk-scrolled-window-placement",
1014 G_CALLBACK (gtk_scrolled_window_settings_changed), NULL);
1015 g_object_set_data (G_OBJECT (settings),
1016 I_("gtk-scrolled-window-connection"),
1017 GUINT_TO_POINTER (window_placement_connection));
1021 gtk_scrolled_window_paint (GtkWidget *widget,
1024 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (widget);
1026 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1028 GtkAllocation relative_allocation;
1029 gboolean scrollbars_within_bevel;
1031 gtk_widget_style_get (widget, "scrollbars-within-bevel", &scrollbars_within_bevel, NULL);
1033 if (!scrollbars_within_bevel)
1035 gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
1037 relative_allocation.x -= widget->style->xthickness;
1038 relative_allocation.y -= widget->style->ythickness;
1039 relative_allocation.width += 2 * widget->style->xthickness;
1040 relative_allocation.height += 2 * widget->style->ythickness;
1044 GtkContainer *container = GTK_CONTAINER (widget);
1046 relative_allocation.x = container->border_width;
1047 relative_allocation.y = container->border_width;
1048 relative_allocation.width = widget->allocation.width - 2 * container->border_width;
1049 relative_allocation.height = widget->allocation.height - 2 * container->border_width;
1052 gtk_paint_shadow (widget->style, widget->window,
1053 GTK_STATE_NORMAL, scrolled_window->shadow_type,
1054 area, widget, "scrolled_window",
1055 widget->allocation.x + relative_allocation.x,
1056 widget->allocation.y + relative_allocation.y,
1057 relative_allocation.width,
1058 relative_allocation.height);
1063 gtk_scrolled_window_expose (GtkWidget *widget,
1064 GdkEventExpose *event)
1066 if (GTK_WIDGET_DRAWABLE (widget))
1068 gtk_scrolled_window_paint (widget, &event->area);
1070 GTK_WIDGET_CLASS (gtk_scrolled_window_parent_class)->expose_event (widget, event);
1077 gtk_scrolled_window_forall (GtkContainer *container,
1078 gboolean include_internals,
1079 GtkCallback callback,
1080 gpointer callback_data)
1082 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (container));
1083 g_return_if_fail (callback != NULL);
1085 GTK_CONTAINER_CLASS (gtk_scrolled_window_parent_class)->forall (container,
1089 if (include_internals)
1091 GtkScrolledWindow *scrolled_window;
1093 scrolled_window = GTK_SCROLLED_WINDOW (container);
1095 if (scrolled_window->vscrollbar)
1096 callback (scrolled_window->vscrollbar, callback_data);
1097 if (scrolled_window->hscrollbar)
1098 callback (scrolled_window->hscrollbar, callback_data);
1103 gtk_scrolled_window_scroll_child (GtkScrolledWindow *scrolled_window,
1104 GtkScrollType scroll,
1105 gboolean horizontal)
1107 GtkAdjustment *adjustment = NULL;
1111 case GTK_SCROLL_STEP_UP:
1112 scroll = GTK_SCROLL_STEP_BACKWARD;
1115 case GTK_SCROLL_STEP_DOWN:
1116 scroll = GTK_SCROLL_STEP_FORWARD;
1119 case GTK_SCROLL_STEP_LEFT:
1120 scroll = GTK_SCROLL_STEP_BACKWARD;
1123 case GTK_SCROLL_STEP_RIGHT:
1124 scroll = GTK_SCROLL_STEP_FORWARD;
1127 case GTK_SCROLL_PAGE_UP:
1128 scroll = GTK_SCROLL_PAGE_BACKWARD;
1131 case GTK_SCROLL_PAGE_DOWN:
1132 scroll = GTK_SCROLL_PAGE_FORWARD;
1135 case GTK_SCROLL_PAGE_LEFT:
1136 scroll = GTK_SCROLL_STEP_BACKWARD;
1139 case GTK_SCROLL_PAGE_RIGHT:
1140 scroll = GTK_SCROLL_STEP_FORWARD;
1143 case GTK_SCROLL_STEP_BACKWARD:
1144 case GTK_SCROLL_STEP_FORWARD:
1145 case GTK_SCROLL_PAGE_BACKWARD:
1146 case GTK_SCROLL_PAGE_FORWARD:
1147 case GTK_SCROLL_START:
1148 case GTK_SCROLL_END:
1151 g_warning ("Invalid scroll type %u for GtkScrolledWindow::scroll-child", scroll);
1155 if ((horizontal && (!scrolled_window->hscrollbar || !scrolled_window->hscrollbar_visible)) ||
1156 (!horizontal && (!scrolled_window->vscrollbar || !scrolled_window->vscrollbar_visible)))
1161 if (scrolled_window->hscrollbar)
1162 adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
1166 if (scrolled_window->vscrollbar)
1167 adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
1172 gdouble value = adjustment->value;
1176 case GTK_SCROLL_STEP_FORWARD:
1177 value += adjustment->step_increment;
1179 case GTK_SCROLL_STEP_BACKWARD:
1180 value -= adjustment->step_increment;
1182 case GTK_SCROLL_PAGE_FORWARD:
1183 value += adjustment->page_increment;
1185 case GTK_SCROLL_PAGE_BACKWARD:
1186 value -= adjustment->page_increment;
1188 case GTK_SCROLL_START:
1189 value = adjustment->lower;
1191 case GTK_SCROLL_END:
1192 value = adjustment->upper;
1195 g_assert_not_reached ();
1199 value = CLAMP (value, adjustment->lower, adjustment->upper - adjustment->page_size);
1201 gtk_adjustment_set_value (adjustment, value);
1210 gtk_scrolled_window_move_focus_out (GtkScrolledWindow *scrolled_window,
1211 GtkDirectionType direction_type)
1213 GtkWidget *toplevel;
1215 /* Focus out of the scrolled window entirely. We do this by setting
1216 * a flag, then propagating the focus motion to the notebook.
1218 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (scrolled_window));
1219 if (!gtk_widget_is_toplevel (toplevel))
1222 g_object_ref (scrolled_window);
1224 scrolled_window->focus_out = TRUE;
1225 g_signal_emit_by_name (toplevel, "move-focus", direction_type);
1226 scrolled_window->focus_out = FALSE;
1228 g_object_unref (scrolled_window);
1232 gtk_scrolled_window_size_request (GtkWidget *widget,
1233 GtkRequisition *requisition)
1235 GtkScrolledWindow *scrolled_window;
1239 gint scrollbar_spacing;
1240 GtkRequisition hscrollbar_requisition;
1241 GtkRequisition vscrollbar_requisition;
1242 GtkRequisition child_requisition;
1244 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (widget));
1245 g_return_if_fail (requisition != NULL);
1247 scrolled_window = GTK_SCROLLED_WINDOW (widget);
1248 bin = GTK_BIN (scrolled_window);
1250 scrollbar_spacing = _gtk_scrolled_window_get_scrollbar_spacing (scrolled_window);
1254 requisition->width = 0;
1255 requisition->height = 0;
1257 gtk_widget_size_request (scrolled_window->hscrollbar,
1258 &hscrollbar_requisition);
1259 gtk_widget_size_request (scrolled_window->vscrollbar,
1260 &vscrollbar_requisition);
1262 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
1264 gtk_widget_size_request (bin->child, &child_requisition);
1266 if (scrolled_window->hscrollbar_policy == GTK_POLICY_NEVER)
1267 requisition->width += child_requisition.width;
1270 GtkWidgetAuxInfo *aux_info = _gtk_widget_get_aux_info (bin->child, FALSE);
1272 if (aux_info && aux_info->width > 0)
1274 requisition->width += aux_info->width;
1278 requisition->width += vscrollbar_requisition.width;
1281 if (scrolled_window->vscrollbar_policy == GTK_POLICY_NEVER)
1282 requisition->height += child_requisition.height;
1285 GtkWidgetAuxInfo *aux_info = _gtk_widget_get_aux_info (bin->child, FALSE);
1287 if (aux_info && aux_info->height > 0)
1289 requisition->height += aux_info->height;
1293 requisition->height += hscrollbar_requisition.height;
1297 if (scrolled_window->hscrollbar_policy == GTK_POLICY_AUTOMATIC ||
1298 scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS)
1300 requisition->width = MAX (requisition->width, hscrollbar_requisition.width);
1301 if (!extra_height || scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS)
1302 extra_height = scrollbar_spacing + hscrollbar_requisition.height;
1305 if (scrolled_window->vscrollbar_policy == GTK_POLICY_AUTOMATIC ||
1306 scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS)
1308 requisition->height = MAX (requisition->height, vscrollbar_requisition.height);
1309 if (!extra_height || scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS)
1310 extra_width = scrollbar_spacing + vscrollbar_requisition.width;
1313 requisition->width += GTK_CONTAINER (widget)->border_width * 2 + MAX (0, extra_width);
1314 requisition->height += GTK_CONTAINER (widget)->border_width * 2 + MAX (0, extra_height);
1316 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1318 requisition->width += 2 * widget->style->xthickness;
1319 requisition->height += 2 * widget->style->ythickness;
1324 gtk_scrolled_window_relative_allocation (GtkWidget *widget,
1325 GtkAllocation *allocation)
1327 GtkScrolledWindow *scrolled_window;
1328 GtkScrolledWindowPrivate *priv;
1329 gint scrollbar_spacing;
1331 g_return_if_fail (widget != NULL);
1332 g_return_if_fail (allocation != NULL);
1334 scrolled_window = GTK_SCROLLED_WINDOW (widget);
1335 scrollbar_spacing = _gtk_scrolled_window_get_scrollbar_spacing (scrolled_window);
1337 priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
1339 allocation->x = GTK_CONTAINER (widget)->border_width;
1340 allocation->y = GTK_CONTAINER (widget)->border_width;
1342 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1344 allocation->x += widget->style->xthickness;
1345 allocation->y += widget->style->ythickness;
1348 allocation->width = MAX (1, (gint)widget->allocation.width - allocation->x * 2);
1349 allocation->height = MAX (1, (gint)widget->allocation.height - allocation->y * 2);
1351 if (scrolled_window->vscrollbar_visible)
1353 GtkRequisition vscrollbar_requisition;
1356 gtk_widget_get_child_requisition (scrolled_window->vscrollbar,
1357 &vscrollbar_requisition);
1358 is_rtl = gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL;
1361 (priv->real_window_placement == GTK_CORNER_TOP_RIGHT ||
1362 priv->real_window_placement == GTK_CORNER_BOTTOM_RIGHT)) ||
1364 (priv->real_window_placement == GTK_CORNER_TOP_LEFT ||
1365 priv->real_window_placement == GTK_CORNER_BOTTOM_LEFT)))
1366 allocation->x += (vscrollbar_requisition.width + scrollbar_spacing);
1368 allocation->width = MAX (1, allocation->width - (vscrollbar_requisition.width + scrollbar_spacing));
1370 if (scrolled_window->hscrollbar_visible)
1372 GtkRequisition hscrollbar_requisition;
1373 gtk_widget_get_child_requisition (scrolled_window->hscrollbar,
1374 &hscrollbar_requisition);
1376 if (priv->real_window_placement == GTK_CORNER_BOTTOM_LEFT ||
1377 priv->real_window_placement == GTK_CORNER_BOTTOM_RIGHT)
1378 allocation->y += (hscrollbar_requisition.height + scrollbar_spacing);
1380 allocation->height = MAX (1, allocation->height - (hscrollbar_requisition.height + scrollbar_spacing));
1385 gtk_scrolled_window_size_allocate (GtkWidget *widget,
1386 GtkAllocation *allocation)
1388 GtkScrolledWindow *scrolled_window;
1389 GtkScrolledWindowPrivate *priv;
1391 GtkAllocation relative_allocation;
1392 GtkAllocation child_allocation;
1393 gboolean scrollbars_within_bevel;
1394 gint scrollbar_spacing;
1396 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (widget));
1397 g_return_if_fail (allocation != NULL);
1399 scrolled_window = GTK_SCROLLED_WINDOW (widget);
1400 bin = GTK_BIN (scrolled_window);
1402 scrollbar_spacing = _gtk_scrolled_window_get_scrollbar_spacing (scrolled_window);
1403 gtk_widget_style_get (widget, "scrollbars-within-bevel", &scrollbars_within_bevel, NULL);
1405 priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
1407 widget->allocation = *allocation;
1409 if (scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS)
1410 scrolled_window->hscrollbar_visible = TRUE;
1411 else if (scrolled_window->hscrollbar_policy == GTK_POLICY_NEVER)
1412 scrolled_window->hscrollbar_visible = FALSE;
1413 if (scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS)
1414 scrolled_window->vscrollbar_visible = TRUE;
1415 else if (scrolled_window->vscrollbar_policy == GTK_POLICY_NEVER)
1416 scrolled_window->vscrollbar_visible = FALSE;
1418 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
1420 gboolean previous_hvis;
1421 gboolean previous_vvis;
1426 gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
1428 child_allocation.x = relative_allocation.x + allocation->x;
1429 child_allocation.y = relative_allocation.y + allocation->y;
1430 child_allocation.width = relative_allocation.width;
1431 child_allocation.height = relative_allocation.height;
1433 previous_hvis = scrolled_window->hscrollbar_visible;
1434 previous_vvis = scrolled_window->vscrollbar_visible;
1436 gtk_widget_size_allocate (bin->child, &child_allocation);
1438 /* If, after the first iteration, the hscrollbar and the
1439 * vscrollbar flip visiblity, then we need both.
1442 previous_hvis != scrolled_window->hscrollbar_visible &&
1443 previous_vvis != scrolled_window->vscrollbar_visible)
1445 scrolled_window->hscrollbar_visible = TRUE;
1446 scrolled_window->vscrollbar_visible = TRUE;
1448 /* a new resize is already queued at this point,
1449 * so we will immediatedly get reinvoked
1456 while (previous_hvis != scrolled_window->hscrollbar_visible ||
1457 previous_vvis != scrolled_window->vscrollbar_visible);
1461 scrolled_window->hscrollbar_visible = scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS;
1462 scrolled_window->vscrollbar_visible = scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS;
1463 gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
1466 if (scrolled_window->hscrollbar_visible)
1468 GtkRequisition hscrollbar_requisition;
1469 gtk_widget_get_child_requisition (scrolled_window->hscrollbar,
1470 &hscrollbar_requisition);
1472 if (!GTK_WIDGET_VISIBLE (scrolled_window->hscrollbar))
1473 gtk_widget_show (scrolled_window->hscrollbar);
1475 child_allocation.x = relative_allocation.x;
1476 if (priv->real_window_placement == GTK_CORNER_TOP_LEFT ||
1477 priv->real_window_placement == GTK_CORNER_TOP_RIGHT)
1478 child_allocation.y = (relative_allocation.y +
1479 relative_allocation.height +
1481 (scrolled_window->shadow_type == GTK_SHADOW_NONE ?
1482 0 : widget->style->ythickness));
1484 child_allocation.y = GTK_CONTAINER (scrolled_window)->border_width;
1486 child_allocation.width = relative_allocation.width;
1487 child_allocation.height = hscrollbar_requisition.height;
1488 child_allocation.x += allocation->x;
1489 child_allocation.y += allocation->y;
1491 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1493 if (!scrollbars_within_bevel)
1495 child_allocation.x -= widget->style->xthickness;
1496 child_allocation.width += 2 * widget->style->xthickness;
1498 else if (GTK_CORNER_TOP_RIGHT == priv->real_window_placement ||
1499 GTK_CORNER_TOP_LEFT == priv->real_window_placement)
1501 child_allocation.y -= widget->style->ythickness;
1505 child_allocation.y += widget->style->ythickness;
1509 gtk_widget_size_allocate (scrolled_window->hscrollbar, &child_allocation);
1511 else if (GTK_WIDGET_VISIBLE (scrolled_window->hscrollbar))
1512 gtk_widget_hide (scrolled_window->hscrollbar);
1514 if (scrolled_window->vscrollbar_visible)
1516 GtkRequisition vscrollbar_requisition;
1517 if (!GTK_WIDGET_VISIBLE (scrolled_window->vscrollbar))
1518 gtk_widget_show (scrolled_window->vscrollbar);
1520 gtk_widget_get_child_requisition (scrolled_window->vscrollbar,
1521 &vscrollbar_requisition);
1523 if ((gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL &&
1524 (priv->real_window_placement == GTK_CORNER_TOP_RIGHT ||
1525 priv->real_window_placement == GTK_CORNER_BOTTOM_RIGHT)) ||
1526 (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR &&
1527 (priv->real_window_placement == GTK_CORNER_TOP_LEFT ||
1528 priv->real_window_placement == GTK_CORNER_BOTTOM_LEFT)))
1529 child_allocation.x = (relative_allocation.x +
1530 relative_allocation.width +
1532 (scrolled_window->shadow_type == GTK_SHADOW_NONE ?
1533 0 : widget->style->xthickness));
1535 child_allocation.x = GTK_CONTAINER (scrolled_window)->border_width;
1537 child_allocation.y = relative_allocation.y;
1538 child_allocation.width = vscrollbar_requisition.width;
1539 child_allocation.height = relative_allocation.height;
1540 child_allocation.x += allocation->x;
1541 child_allocation.y += allocation->y;
1543 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1545 if (!scrollbars_within_bevel)
1547 child_allocation.y -= widget->style->ythickness;
1548 child_allocation.height += 2 * widget->style->ythickness;
1550 else if (GTK_CORNER_BOTTOM_LEFT == priv->real_window_placement ||
1551 GTK_CORNER_TOP_LEFT == priv->real_window_placement)
1553 child_allocation.x -= widget->style->xthickness;
1557 child_allocation.x += widget->style->xthickness;
1561 gtk_widget_size_allocate (scrolled_window->vscrollbar, &child_allocation);
1563 else if (GTK_WIDGET_VISIBLE (scrolled_window->vscrollbar))
1564 gtk_widget_hide (scrolled_window->vscrollbar);
1568 gtk_scrolled_window_scroll_event (GtkWidget *widget,
1569 GdkEventScroll *event)
1573 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (widget), FALSE);
1574 g_return_val_if_fail (event != NULL, FALSE);
1576 if (event->direction == GDK_SCROLL_UP || event->direction == GDK_SCROLL_DOWN)
1577 range = GTK_SCROLLED_WINDOW (widget)->vscrollbar;
1579 range = GTK_SCROLLED_WINDOW (widget)->hscrollbar;
1581 if (range && GTK_WIDGET_VISIBLE (range))
1583 GtkAdjustment *adj = GTK_RANGE (range)->adjustment;
1584 gdouble delta, new_value;
1586 delta = _gtk_range_get_wheel_delta (GTK_RANGE (range), event->direction);
1588 new_value = CLAMP (adj->value + delta, adj->lower, adj->upper - adj->page_size);
1590 gtk_adjustment_set_value (adj, new_value);
1599 gtk_scrolled_window_focus (GtkWidget *widget,
1600 GtkDirectionType direction)
1602 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (widget);
1603 gboolean had_focus_child = GTK_CONTAINER (widget)->focus_child != NULL;
1605 if (scrolled_window->focus_out)
1607 scrolled_window->focus_out = FALSE; /* Clear this to catch the wrap-around case */
1611 if (gtk_widget_is_focus (widget))
1614 /* We only put the scrolled window itself in the focus chain if it
1615 * isn't possible to focus any children.
1617 if (GTK_BIN (widget)->child)
1619 if (gtk_widget_child_focus (GTK_BIN (widget)->child, direction))
1623 if (!had_focus_child && GTK_WIDGET_CAN_FOCUS (widget))
1625 gtk_widget_grab_focus (widget);
1633 gtk_scrolled_window_adjustment_changed (GtkAdjustment *adjustment,
1636 GtkScrolledWindow *scrolled_win;
1638 g_return_if_fail (adjustment != NULL);
1639 g_return_if_fail (data != NULL);
1641 scrolled_win = GTK_SCROLLED_WINDOW (data);
1643 if (scrolled_win->hscrollbar &&
1644 adjustment == gtk_range_get_adjustment (GTK_RANGE (scrolled_win->hscrollbar)))
1646 if (scrolled_win->hscrollbar_policy == GTK_POLICY_AUTOMATIC)
1650 visible = scrolled_win->hscrollbar_visible;
1651 scrolled_win->hscrollbar_visible = (adjustment->upper - adjustment->lower >
1652 adjustment->page_size);
1653 if (scrolled_win->hscrollbar_visible != visible)
1654 gtk_widget_queue_resize (GTK_WIDGET (scrolled_win));
1657 else if (scrolled_win->vscrollbar &&
1658 adjustment == gtk_range_get_adjustment (GTK_RANGE (scrolled_win->vscrollbar)))
1660 if (scrolled_win->vscrollbar_policy == GTK_POLICY_AUTOMATIC)
1664 visible = scrolled_win->vscrollbar_visible;
1665 scrolled_win->vscrollbar_visible = (adjustment->upper - adjustment->lower >
1666 adjustment->page_size);
1667 if (scrolled_win->vscrollbar_visible != visible)
1668 gtk_widget_queue_resize (GTK_WIDGET (scrolled_win));
1674 gtk_scrolled_window_add (GtkContainer *container,
1677 GtkScrolledWindow *scrolled_window;
1680 bin = GTK_BIN (container);
1681 g_return_if_fail (bin->child == NULL);
1683 scrolled_window = GTK_SCROLLED_WINDOW (container);
1686 gtk_widget_set_parent (child, GTK_WIDGET (bin));
1688 /* this is a temporary message */
1689 if (!gtk_widget_set_scroll_adjustments (child,
1690 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
1691 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar))))
1692 g_warning ("gtk_scrolled_window_add(): cannot add non scrollable widget "
1693 "use gtk_scrolled_window_add_with_viewport() instead");
1697 gtk_scrolled_window_remove (GtkContainer *container,
1700 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (container));
1701 g_return_if_fail (child != NULL);
1702 g_return_if_fail (GTK_BIN (container)->child == child);
1704 gtk_widget_set_scroll_adjustments (child, NULL, NULL);
1706 /* chain parent class handler to remove child */
1707 GTK_CONTAINER_CLASS (gtk_scrolled_window_parent_class)->remove (container, child);
1711 * gtk_scrolled_window_add_with_viewport:
1712 * @scrolled_window: a #GtkScrolledWindow
1713 * @child: the widget you want to scroll
1715 * Used to add children without native scrolling capabilities. This
1716 * is simply a convenience function; it is equivalent to adding the
1717 * unscrollable child to a viewport, then adding the viewport to the
1718 * scrolled window. If a child has native scrolling, use
1719 * gtk_container_add() instead of this function.
1721 * The viewport scrolls the child by moving its #GdkWindow, and takes
1722 * the size of the child to be the size of its toplevel #GdkWindow.
1723 * This will be very wrong for most widgets that support native scrolling;
1724 * for example, if you add a widget such as #GtkTreeView with a viewport,
1725 * the whole widget will scroll, including the column headings. Thus,
1726 * widgets with native scrolling support should not be used with the
1727 * #GtkViewport proxy.
1729 * A widget supports scrolling natively if the
1730 * set_scroll_adjustments_signal field in #GtkWidgetClass is non-zero,
1731 * i.e. has been filled in with a valid signal identifier.
1734 gtk_scrolled_window_add_with_viewport (GtkScrolledWindow *scrolled_window,
1738 GtkWidget *viewport;
1740 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
1741 g_return_if_fail (GTK_IS_WIDGET (child));
1742 g_return_if_fail (child->parent == NULL);
1744 bin = GTK_BIN (scrolled_window);
1746 if (bin->child != NULL)
1748 g_return_if_fail (GTK_IS_VIEWPORT (bin->child));
1749 g_return_if_fail (GTK_BIN (bin->child)->child == NULL);
1751 viewport = bin->child;
1756 gtk_viewport_new (gtk_scrolled_window_get_hadjustment (scrolled_window),
1757 gtk_scrolled_window_get_vadjustment (scrolled_window));
1758 gtk_container_add (GTK_CONTAINER (scrolled_window), viewport);
1761 gtk_widget_show (viewport);
1762 gtk_container_add (GTK_CONTAINER (viewport), child);
1766 * _gtk_scrolled_window_get_spacing:
1767 * @scrolled_window: a scrolled window
1769 * Gets the spacing between the scrolled window's scrollbars and
1770 * the scrolled widget. Used by GtkCombo
1772 * Return value: the spacing, in pixels.
1775 _gtk_scrolled_window_get_scrollbar_spacing (GtkScrolledWindow *scrolled_window)
1777 GtkScrolledWindowClass *class;
1779 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), 0);
1781 class = GTK_SCROLLED_WINDOW_GET_CLASS (scrolled_window);
1783 if (class->scrollbar_spacing >= 0)
1784 return class->scrollbar_spacing;
1787 gint scrollbar_spacing;
1789 gtk_widget_style_get (GTK_WIDGET (scrolled_window),
1790 "scrollbar-spacing", &scrollbar_spacing,
1793 return scrollbar_spacing;
1797 #define __GTK_SCROLLED_WINDOW_C__
1798 #include "gtkaliasdef.c"