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_usize().
48 * a scrolled window needs (for imlementing 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,
103 static void gtk_scrolled_window_destroy (GtkObject *object);
104 static void gtk_scrolled_window_finalize (GObject *object);
105 static void gtk_scrolled_window_set_property (GObject *object,
109 static void gtk_scrolled_window_get_property (GObject *object,
114 static void gtk_scrolled_window_screen_changed (GtkWidget *widget,
115 GdkScreen *previous_screen);
116 static gint gtk_scrolled_window_expose (GtkWidget *widget,
117 GdkEventExpose *event);
118 static void gtk_scrolled_window_size_request (GtkWidget *widget,
119 GtkRequisition *requisition);
120 static void gtk_scrolled_window_size_allocate (GtkWidget *widget,
121 GtkAllocation *allocation);
122 static gint gtk_scrolled_window_scroll_event (GtkWidget *widget,
123 GdkEventScroll *event);
124 static gint gtk_scrolled_window_focus (GtkWidget *widget,
125 GtkDirectionType direction);
126 static void gtk_scrolled_window_add (GtkContainer *container,
128 static void gtk_scrolled_window_remove (GtkContainer *container,
130 static void gtk_scrolled_window_forall (GtkContainer *container,
131 gboolean include_internals,
132 GtkCallback callback,
133 gpointer callback_data);
134 static gboolean gtk_scrolled_window_scroll_child (GtkScrolledWindow *scrolled_window,
135 GtkScrollType scroll,
136 gboolean horizontal);
137 static void gtk_scrolled_window_move_focus_out (GtkScrolledWindow *scrolled_window,
138 GtkDirectionType direction_type);
140 static void gtk_scrolled_window_relative_allocation(GtkWidget *widget,
141 GtkAllocation *allocation);
142 static void gtk_scrolled_window_adjustment_changed (GtkAdjustment *adjustment,
145 static void gtk_scrolled_window_update_real_placement (GtkScrolledWindow *scrolled_window);
147 static guint signals[LAST_SIGNAL] = {0};
149 G_DEFINE_TYPE (GtkScrolledWindow, gtk_scrolled_window, GTK_TYPE_BIN)
152 add_scroll_binding (GtkBindingSet *binding_set,
154 GdkModifierType mask,
155 GtkScrollType scroll,
158 guint keypad_keyval = keyval - GDK_Left + GDK_KP_Left;
160 gtk_binding_entry_add_signal (binding_set, keyval, mask,
162 GTK_TYPE_SCROLL_TYPE, scroll,
163 G_TYPE_BOOLEAN, horizontal);
164 gtk_binding_entry_add_signal (binding_set, keypad_keyval, mask,
166 GTK_TYPE_SCROLL_TYPE, scroll,
167 G_TYPE_BOOLEAN, horizontal);
171 add_tab_bindings (GtkBindingSet *binding_set,
172 GdkModifierType modifiers,
173 GtkDirectionType direction)
175 gtk_binding_entry_add_signal (binding_set, GDK_Tab, modifiers,
177 GTK_TYPE_DIRECTION_TYPE, direction);
178 gtk_binding_entry_add_signal (binding_set, GDK_KP_Tab, modifiers,
180 GTK_TYPE_DIRECTION_TYPE, direction);
184 gtk_scrolled_window_class_init (GtkScrolledWindowClass *class)
186 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
187 GtkObjectClass *object_class;
188 GtkWidgetClass *widget_class;
189 GtkContainerClass *container_class;
190 GtkBindingSet *binding_set;
192 object_class = (GtkObjectClass*) class;
193 widget_class = (GtkWidgetClass*) class;
194 container_class = (GtkContainerClass*) class;
196 gobject_class->finalize = gtk_scrolled_window_finalize;
197 gobject_class->set_property = gtk_scrolled_window_set_property;
198 gobject_class->get_property = gtk_scrolled_window_get_property;
200 object_class->destroy = gtk_scrolled_window_destroy;
202 widget_class->screen_changed = gtk_scrolled_window_screen_changed;
203 widget_class->expose_event = gtk_scrolled_window_expose;
204 widget_class->size_request = gtk_scrolled_window_size_request;
205 widget_class->size_allocate = gtk_scrolled_window_size_allocate;
206 widget_class->scroll_event = gtk_scrolled_window_scroll_event;
207 widget_class->focus = gtk_scrolled_window_focus;
209 container_class->add = gtk_scrolled_window_add;
210 container_class->remove = gtk_scrolled_window_remove;
211 container_class->forall = gtk_scrolled_window_forall;
213 class->scrollbar_spacing = -1;
215 class->scroll_child = gtk_scrolled_window_scroll_child;
216 class->move_focus_out = gtk_scrolled_window_move_focus_out;
218 g_object_class_install_property (gobject_class,
220 g_param_spec_object ("hadjustment",
221 P_("Horizontal Adjustment"),
222 P_("The GtkAdjustment for the horizontal position"),
224 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
225 g_object_class_install_property (gobject_class,
227 g_param_spec_object ("vadjustment",
228 P_("Vertical Adjustment"),
229 P_("The GtkAdjustment for the vertical position"),
231 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
232 g_object_class_install_property (gobject_class,
233 PROP_HSCROLLBAR_POLICY,
234 g_param_spec_enum ("hscrollbar-policy",
235 P_("Horizontal Scrollbar Policy"),
236 P_("When the horizontal scrollbar is displayed"),
237 GTK_TYPE_POLICY_TYPE,
239 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
240 g_object_class_install_property (gobject_class,
241 PROP_VSCROLLBAR_POLICY,
242 g_param_spec_enum ("vscrollbar-policy",
243 P_("Vertical Scrollbar Policy"),
244 P_("When the vertical scrollbar is displayed"),
245 GTK_TYPE_POLICY_TYPE,
247 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
249 g_object_class_install_property (gobject_class,
250 PROP_WINDOW_PLACEMENT,
251 g_param_spec_enum ("window-placement",
252 P_("Window Placement"),
253 P_("Where the contents are located with respect to the scrollbars. This property only takes effect if \"window-placement-set\" is TRUE."),
254 GTK_TYPE_CORNER_TYPE,
256 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
259 * GtkScrolledWindow:window-placement-set:
261 * Whether "window-placement" should be used to determine the location
262 * of the contents with respect to the scrollbars. Otherwise, the
263 * "gtk-scrolled-window-placement" setting is used.
267 g_object_class_install_property (gobject_class,
268 PROP_WINDOW_PLACEMENT_SET,
269 g_param_spec_boolean ("window-placement-set",
270 P_("Window Placement Set"),
271 P_("Whether \"window-placement\" should be used to determine the location of the contents with respect to the scrollbars."),
273 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
274 g_object_class_install_property (gobject_class,
276 g_param_spec_enum ("shadow-type",
278 P_("Style of bevel around the contents"),
279 GTK_TYPE_SHADOW_TYPE,
281 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
284 * GtkScrolledWindow:scrollbars-within-bevel:
286 * Whether to place scrollbars within the scrolled window's bevel.
290 gtk_widget_class_install_style_property (widget_class,
291 g_param_spec_boolean ("scrollbars-within-bevel",
292 P_("Scrollbars within bevel"),
293 P_("Place scrollbars within the scrolled window's bevel"),
295 GTK_PARAM_READABLE));
297 gtk_widget_class_install_style_property (widget_class,
298 g_param_spec_int ("scrollbar-spacing",
299 P_("Scrollbar spacing"),
300 P_("Number of pixels between the scrollbars and the scrolled window"),
303 DEFAULT_SCROLLBAR_SPACING,
304 GTK_PARAM_READABLE));
307 * GtkSettings:gtk-scrolled-window-placement:
309 * Where the contents of scrolled windows are located with respect to the
310 * scrollbars, if not overridden by the scrolled window's own placement.
314 gtk_settings_install_property (g_param_spec_enum ("gtk-scrolled-window-placement",
315 P_("Scrolled Window Placement"),
316 P_("Where the contents of scrolled windows are located with respect to the scrollbars, if not overridden by the scrolled window's own placement."),
317 GTK_TYPE_CORNER_TYPE,
319 G_PARAM_READABLE | G_PARAM_WRITABLE));
322 signals[SCROLL_CHILD] =
323 g_signal_new (I_("scroll_child"),
324 G_TYPE_FROM_CLASS (object_class),
325 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
326 G_STRUCT_OFFSET (GtkScrolledWindowClass, scroll_child),
328 _gtk_marshal_BOOLEAN__ENUM_BOOLEAN,
330 GTK_TYPE_SCROLL_TYPE,
332 signals[MOVE_FOCUS_OUT] =
333 g_signal_new (I_("move_focus_out"),
334 G_TYPE_FROM_CLASS (object_class),
335 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
336 G_STRUCT_OFFSET (GtkScrolledWindowClass, move_focus_out),
338 _gtk_marshal_VOID__ENUM,
340 GTK_TYPE_DIRECTION_TYPE);
342 binding_set = gtk_binding_set_by_class (class);
344 add_scroll_binding (binding_set, GDK_Left, GDK_CONTROL_MASK, GTK_SCROLL_STEP_BACKWARD, TRUE);
345 add_scroll_binding (binding_set, GDK_Right, GDK_CONTROL_MASK, GTK_SCROLL_STEP_FORWARD, TRUE);
346 add_scroll_binding (binding_set, GDK_Up, GDK_CONTROL_MASK, GTK_SCROLL_STEP_BACKWARD, FALSE);
347 add_scroll_binding (binding_set, GDK_Down, GDK_CONTROL_MASK, GTK_SCROLL_STEP_FORWARD, FALSE);
349 add_scroll_binding (binding_set, GDK_Page_Up, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_BACKWARD, TRUE);
350 add_scroll_binding (binding_set, GDK_Page_Down, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_FORWARD, TRUE);
351 add_scroll_binding (binding_set, GDK_Page_Up, 0, GTK_SCROLL_PAGE_BACKWARD, FALSE);
352 add_scroll_binding (binding_set, GDK_Page_Down, 0, GTK_SCROLL_PAGE_FORWARD, FALSE);
354 add_scroll_binding (binding_set, GDK_Home, GDK_CONTROL_MASK, GTK_SCROLL_START, TRUE);
355 add_scroll_binding (binding_set, GDK_End, GDK_CONTROL_MASK, GTK_SCROLL_END, TRUE);
356 add_scroll_binding (binding_set, GDK_Home, 0, GTK_SCROLL_START, FALSE);
357 add_scroll_binding (binding_set, GDK_End, 0, GTK_SCROLL_END, FALSE);
359 add_tab_bindings (binding_set, GDK_CONTROL_MASK, GTK_DIR_TAB_FORWARD);
360 add_tab_bindings (binding_set, GDK_CONTROL_MASK | GDK_SHIFT_MASK, GTK_DIR_TAB_BACKWARD);
362 g_type_class_add_private (class, sizeof (GtkScrolledWindowPrivate));
366 gtk_scrolled_window_init (GtkScrolledWindow *scrolled_window)
368 GTK_WIDGET_SET_FLAGS (scrolled_window, GTK_NO_WINDOW | GTK_CAN_FOCUS);
370 scrolled_window->hscrollbar = NULL;
371 scrolled_window->vscrollbar = NULL;
372 scrolled_window->hscrollbar_policy = GTK_POLICY_ALWAYS;
373 scrolled_window->vscrollbar_policy = GTK_POLICY_ALWAYS;
374 scrolled_window->hscrollbar_visible = FALSE;
375 scrolled_window->vscrollbar_visible = FALSE;
376 scrolled_window->focus_out = FALSE;
377 scrolled_window->window_placement = GTK_CORNER_TOP_LEFT;
378 gtk_scrolled_window_update_real_placement (scrolled_window);
382 gtk_scrolled_window_new (GtkAdjustment *hadjustment,
383 GtkAdjustment *vadjustment)
385 GtkWidget *scrolled_window;
388 g_return_val_if_fail (GTK_IS_ADJUSTMENT (hadjustment), NULL);
391 g_return_val_if_fail (GTK_IS_ADJUSTMENT (vadjustment), NULL);
393 scrolled_window = gtk_widget_new (GTK_TYPE_SCROLLED_WINDOW,
394 "hadjustment", hadjustment,
395 "vadjustment", vadjustment,
398 return scrolled_window;
402 gtk_scrolled_window_set_hadjustment (GtkScrolledWindow *scrolled_window,
403 GtkAdjustment *hadjustment)
407 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
409 g_return_if_fail (GTK_IS_ADJUSTMENT (hadjustment));
411 hadjustment = (GtkAdjustment*) g_object_new (GTK_TYPE_ADJUSTMENT, NULL);
413 bin = GTK_BIN (scrolled_window);
415 if (!scrolled_window->hscrollbar)
417 gtk_widget_push_composite_child ();
418 scrolled_window->hscrollbar = gtk_hscrollbar_new (hadjustment);
419 gtk_widget_set_composite_name (scrolled_window->hscrollbar, "hscrollbar");
420 gtk_widget_pop_composite_child ();
422 gtk_widget_set_parent (scrolled_window->hscrollbar, GTK_WIDGET (scrolled_window));
423 g_object_ref (scrolled_window->hscrollbar);
424 gtk_widget_show (scrolled_window->hscrollbar);
428 GtkAdjustment *old_adjustment;
430 old_adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
431 if (old_adjustment == hadjustment)
434 g_signal_handlers_disconnect_by_func (old_adjustment,
435 gtk_scrolled_window_adjustment_changed,
437 gtk_range_set_adjustment (GTK_RANGE (scrolled_window->hscrollbar),
440 hadjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
441 g_signal_connect (hadjustment,
443 G_CALLBACK (gtk_scrolled_window_adjustment_changed),
445 gtk_scrolled_window_adjustment_changed (hadjustment, scrolled_window);
448 gtk_widget_set_scroll_adjustments (bin->child,
449 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
450 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)));
452 g_object_notify (G_OBJECT (scrolled_window), "hadjustment");
456 gtk_scrolled_window_set_vadjustment (GtkScrolledWindow *scrolled_window,
457 GtkAdjustment *vadjustment)
461 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
463 g_return_if_fail (GTK_IS_ADJUSTMENT (vadjustment));
465 vadjustment = (GtkAdjustment*) g_object_new (GTK_TYPE_ADJUSTMENT, NULL);
467 bin = GTK_BIN (scrolled_window);
469 if (!scrolled_window->vscrollbar)
471 gtk_widget_push_composite_child ();
472 scrolled_window->vscrollbar = gtk_vscrollbar_new (vadjustment);
473 gtk_widget_set_composite_name (scrolled_window->vscrollbar, "vscrollbar");
474 gtk_widget_pop_composite_child ();
476 gtk_widget_set_parent (scrolled_window->vscrollbar, GTK_WIDGET (scrolled_window));
477 g_object_ref (scrolled_window->vscrollbar);
478 gtk_widget_show (scrolled_window->vscrollbar);
482 GtkAdjustment *old_adjustment;
484 old_adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
485 if (old_adjustment == vadjustment)
488 g_signal_handlers_disconnect_by_func (old_adjustment,
489 gtk_scrolled_window_adjustment_changed,
491 gtk_range_set_adjustment (GTK_RANGE (scrolled_window->vscrollbar),
494 vadjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
495 g_signal_connect (vadjustment,
497 G_CALLBACK (gtk_scrolled_window_adjustment_changed),
499 gtk_scrolled_window_adjustment_changed (vadjustment, scrolled_window);
502 gtk_widget_set_scroll_adjustments (bin->child,
503 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
504 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)));
506 g_object_notify (G_OBJECT (scrolled_window), "vadjustment");
510 gtk_scrolled_window_get_hadjustment (GtkScrolledWindow *scrolled_window)
512 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
514 return (scrolled_window->hscrollbar ?
515 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)) :
520 gtk_scrolled_window_get_vadjustment (GtkScrolledWindow *scrolled_window)
522 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
524 return (scrolled_window->vscrollbar ?
525 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)) :
530 * gtk_scrolled_window_get_hscrollbar:
531 * @scrolled_window: a #GtkScrolledWindow
533 * Returns the horizontal scrollbar of @scrolled_window.
535 * Returns: the horizontal scrollbar of the scrolled window, or
536 * %NULL if it does not have one.
541 gtk_scrolled_window_get_hscrollbar (GtkScrolledWindow *scrolled_window)
543 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
545 return scrolled_window->hscrollbar;
549 * gtk_scrolled_window_get_vscrollbar:
550 * @scrolled_window: a #GtkScrolledWindow
552 * Returns the vertical scrollbar of @scrolled_window.
554 * Returns: the vertical scrollbar of the scrolled window, or
555 * %NULL if it does not have one.
560 gtk_scrolled_window_get_vscrollbar (GtkScrolledWindow *scrolled_window)
562 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
564 return scrolled_window->vscrollbar;
568 gtk_scrolled_window_set_policy (GtkScrolledWindow *scrolled_window,
569 GtkPolicyType hscrollbar_policy,
570 GtkPolicyType vscrollbar_policy)
572 GObject *object = G_OBJECT (scrolled_window);
574 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
576 if ((scrolled_window->hscrollbar_policy != hscrollbar_policy) ||
577 (scrolled_window->vscrollbar_policy != vscrollbar_policy))
579 scrolled_window->hscrollbar_policy = hscrollbar_policy;
580 scrolled_window->vscrollbar_policy = vscrollbar_policy;
582 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
584 g_object_freeze_notify (object);
585 g_object_notify (object, "hscrollbar-policy");
586 g_object_notify (object, "vscrollbar-policy");
587 g_object_thaw_notify (object);
592 * gtk_scrolled_window_get_policy:
593 * @scrolled_window: a #GtkScrolledWindow
594 * @hscrollbar_policy: location to store the policy for the horizontal scrollbar, or %NULL.
595 * @vscrollbar_policy: location to store the policy for the horizontal scrollbar, or %NULL.
597 * Retrieves the current policy values for the horizontal and vertical
598 * scrollbars. See gtk_scrolled_window_set_policy().
601 gtk_scrolled_window_get_policy (GtkScrolledWindow *scrolled_window,
602 GtkPolicyType *hscrollbar_policy,
603 GtkPolicyType *vscrollbar_policy)
605 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
607 if (hscrollbar_policy)
608 *hscrollbar_policy = scrolled_window->hscrollbar_policy;
609 if (vscrollbar_policy)
610 *vscrollbar_policy = scrolled_window->vscrollbar_policy;
614 gtk_scrolled_window_update_real_placement (GtkScrolledWindow *scrolled_window)
616 GtkScrolledWindowPrivate *priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
617 GtkSettings *settings;
619 settings = gtk_widget_get_settings (GTK_WIDGET (scrolled_window));
621 if (priv->window_placement_set || settings == NULL)
622 priv->real_window_placement = scrolled_window->window_placement;
624 g_object_get (settings,
625 "gtk-scrolled-window-placement",
626 &priv->real_window_placement,
631 gtk_scrolled_window_set_placement_internal (GtkScrolledWindow *scrolled_window,
632 GtkCornerType window_placement)
634 if (scrolled_window->window_placement != window_placement)
636 scrolled_window->window_placement = window_placement;
638 gtk_scrolled_window_update_real_placement (scrolled_window);
639 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
641 g_object_notify (G_OBJECT (scrolled_window), "window-placement");
646 gtk_scrolled_window_set_placement_set (GtkScrolledWindow *scrolled_window,
647 gboolean placement_set,
648 gboolean emit_resize)
650 GtkScrolledWindowPrivate *priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
652 if (priv->window_placement_set != placement_set)
654 priv->window_placement_set = placement_set;
656 gtk_scrolled_window_update_real_placement (scrolled_window);
658 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
660 g_object_notify (G_OBJECT (scrolled_window), "window-placement-set");
665 * gtk_scrolled_window_set_placement:
666 * @scrolled_window: a #GtkScrolledWindow
668 * Sets the placement of the contents with respect to the scrollbars
669 * for the scrolled window.
671 * See also gtk_scrolled_window_get_placement() and
672 * gtk_scrolled_window_unset_placement().
675 gtk_scrolled_window_set_placement (GtkScrolledWindow *scrolled_window,
676 GtkCornerType window_placement)
678 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
680 gtk_scrolled_window_set_placement_set (scrolled_window, TRUE, FALSE);
681 gtk_scrolled_window_set_placement_internal (scrolled_window, window_placement);
685 * gtk_scrolled_window_get_placement:
686 * @scrolled_window: a #GtkScrolledWindow
688 * Gets the placement of the contents with respect to the scrollbars
689 * for the scrolled window. See gtk_scrolled_window_set_placement().
691 * Return value: the current placement value.
693 * See also gtk_scrolled_window_set_placement() and
694 * gtk_scrolled_window_unset_placement().
697 gtk_scrolled_window_get_placement (GtkScrolledWindow *scrolled_window)
699 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), GTK_CORNER_TOP_LEFT);
701 return scrolled_window->window_placement;
705 * gtk_scrolled_window_unset_placement:
706 * @scrolled_window: a #GtkScrolledWindow
708 * Unsets the placement of the contents with respect to the scrollbars
709 * for the scrolled window. If no window placement is set for a scrolled
710 * window, it obeys the "gtk-scrolled-window-placement" XSETTING.
712 * See also gtk_scrolled_window_set_placement() and
713 * gtk_scrolled_window_get_placement().
718 gtk_scrolled_window_unset_placement (GtkScrolledWindow *scrolled_window)
720 GtkScrolledWindowPrivate *priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
722 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
724 if (priv->window_placement_set)
726 priv->window_placement_set = FALSE;
728 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
730 g_object_notify (G_OBJECT (scrolled_window), "window-placement-set");
735 * gtk_scrolled_window_set_shadow_type:
736 * @scrolled_window: a #GtkScrolledWindow
737 * @type: kind of shadow to draw around scrolled window contents
739 * Changes the type of shadow drawn around the contents of
744 gtk_scrolled_window_set_shadow_type (GtkScrolledWindow *scrolled_window,
747 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
748 g_return_if_fail (type >= GTK_SHADOW_NONE && type <= GTK_SHADOW_ETCHED_OUT);
750 if (scrolled_window->shadow_type != type)
752 scrolled_window->shadow_type = type;
754 if (GTK_WIDGET_DRAWABLE (scrolled_window))
755 gtk_widget_queue_draw (GTK_WIDGET (scrolled_window));
757 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
759 g_object_notify (G_OBJECT (scrolled_window), "shadow-type");
764 * gtk_scrolled_window_get_shadow_type:
765 * @scrolled_window: a #GtkScrolledWindow
767 * Gets the shadow type of the scrolled window. See
768 * gtk_scrolled_window_set_shadow_type().
770 * Return value: the current shadow type
773 gtk_scrolled_window_get_shadow_type (GtkScrolledWindow *scrolled_window)
775 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), GTK_SHADOW_NONE);
777 return scrolled_window->shadow_type;
781 gtk_scrolled_window_destroy (GtkObject *object)
783 GtkScrolledWindow *scrolled_window;
785 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (object));
787 scrolled_window = GTK_SCROLLED_WINDOW (object);
789 gtk_widget_unparent (scrolled_window->hscrollbar);
790 gtk_widget_unparent (scrolled_window->vscrollbar);
791 gtk_widget_destroy (scrolled_window->hscrollbar);
792 gtk_widget_destroy (scrolled_window->vscrollbar);
794 GTK_OBJECT_CLASS (gtk_scrolled_window_parent_class)->destroy (object);
798 gtk_scrolled_window_finalize (GObject *object)
800 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
802 g_object_unref (scrolled_window->hscrollbar);
803 g_object_unref (scrolled_window->vscrollbar);
805 G_OBJECT_CLASS (gtk_scrolled_window_parent_class)->finalize (object);
809 gtk_scrolled_window_set_property (GObject *object,
814 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
818 case PROP_HADJUSTMENT:
819 gtk_scrolled_window_set_hadjustment (scrolled_window,
820 g_value_get_object (value));
822 case PROP_VADJUSTMENT:
823 gtk_scrolled_window_set_vadjustment (scrolled_window,
824 g_value_get_object (value));
826 case PROP_HSCROLLBAR_POLICY:
827 gtk_scrolled_window_set_policy (scrolled_window,
828 g_value_get_enum (value),
829 scrolled_window->vscrollbar_policy);
831 case PROP_VSCROLLBAR_POLICY:
832 gtk_scrolled_window_set_policy (scrolled_window,
833 scrolled_window->hscrollbar_policy,
834 g_value_get_enum (value));
836 case PROP_WINDOW_PLACEMENT:
837 gtk_scrolled_window_set_placement_internal (scrolled_window,
838 g_value_get_enum (value));
840 case PROP_WINDOW_PLACEMENT_SET:
841 gtk_scrolled_window_set_placement_set (scrolled_window,
842 g_value_get_boolean (value),
845 case PROP_SHADOW_TYPE:
846 gtk_scrolled_window_set_shadow_type (scrolled_window,
847 g_value_get_enum (value));
850 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
856 gtk_scrolled_window_get_property (GObject *object,
861 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
862 GtkScrolledWindowPrivate *priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
866 case PROP_HADJUSTMENT:
867 g_value_set_object (value,
868 G_OBJECT (gtk_scrolled_window_get_hadjustment (scrolled_window)));
870 case PROP_VADJUSTMENT:
871 g_value_set_object (value,
872 G_OBJECT (gtk_scrolled_window_get_vadjustment (scrolled_window)));
874 case PROP_HSCROLLBAR_POLICY:
875 g_value_set_enum (value, scrolled_window->hscrollbar_policy);
877 case PROP_VSCROLLBAR_POLICY:
878 g_value_set_enum (value, scrolled_window->vscrollbar_policy);
880 case PROP_WINDOW_PLACEMENT:
881 g_value_set_enum (value, scrolled_window->window_placement);
883 case PROP_WINDOW_PLACEMENT_SET:
884 g_value_set_boolean (value, priv->window_placement_set);
886 case PROP_SHADOW_TYPE:
887 g_value_set_enum (value, scrolled_window->shadow_type);
890 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
896 traverse_container (GtkWidget *widget,
899 if (GTK_IS_SCROLLED_WINDOW (widget))
901 gtk_scrolled_window_update_real_placement (GTK_SCROLLED_WINDOW (widget));
902 gtk_widget_queue_draw (widget);
904 else if (GTK_IS_CONTAINER (widget))
905 gtk_container_forall (GTK_CONTAINER (widget), traverse_container, NULL);
909 gtk_scrolled_window_settings_changed (GtkSettings *settings)
913 list = gtk_window_list_toplevels ();
915 for (l = list; l; l = l->next)
916 gtk_container_forall (GTK_CONTAINER (l->data),
917 traverse_container, NULL);
923 gtk_scrolled_window_screen_changed (GtkWidget *widget,
924 GdkScreen *previous_screen)
926 GtkSettings *settings;
927 guint window_placement_connection;
929 gtk_scrolled_window_update_real_placement (GTK_SCROLLED_WINDOW (widget));
931 if (!gtk_widget_has_screen (widget))
934 settings = gtk_widget_get_settings (widget);
936 window_placement_connection =
937 GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (settings),
938 "gtk-scrolled-window-connection"));
940 if (window_placement_connection)
943 window_placement_connection =
944 g_signal_connect (settings, "notify::gtk-scrolled-window-placement",
945 G_CALLBACK (gtk_scrolled_window_settings_changed), NULL);
946 g_object_set_data (G_OBJECT (settings),
947 I_("gtk-scrolled-window-connection"),
948 GUINT_TO_POINTER (window_placement_connection));
952 gtk_scrolled_window_paint (GtkWidget *widget,
955 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (widget);
957 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
959 GtkAllocation relative_allocation;
960 gboolean scrollbars_within_bevel;
962 gtk_widget_style_get (widget, "scrollbars-within-bevel", &scrollbars_within_bevel, NULL);
964 if (!scrollbars_within_bevel)
966 gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
968 relative_allocation.x -= widget->style->xthickness;
969 relative_allocation.y -= widget->style->ythickness;
970 relative_allocation.width += 2 * widget->style->xthickness;
971 relative_allocation.height += 2 * widget->style->ythickness;
975 GtkContainer *container = GTK_CONTAINER (widget);
977 relative_allocation.x = container->border_width;
978 relative_allocation.y = container->border_width;
979 relative_allocation.width = widget->allocation.width - 2 * container->border_width;
980 relative_allocation.height = widget->allocation.height - 2 * container->border_width;
983 gtk_paint_shadow (widget->style, widget->window,
984 GTK_STATE_NORMAL, scrolled_window->shadow_type,
985 area, widget, "scrolled_window",
986 widget->allocation.x + relative_allocation.x,
987 widget->allocation.y + relative_allocation.y,
988 relative_allocation.width,
989 relative_allocation.height);
994 gtk_scrolled_window_expose (GtkWidget *widget,
995 GdkEventExpose *event)
997 if (GTK_WIDGET_DRAWABLE (widget))
999 gtk_scrolled_window_paint (widget, &event->area);
1001 (* GTK_WIDGET_CLASS (gtk_scrolled_window_parent_class)->expose_event) (widget, event);
1008 gtk_scrolled_window_forall (GtkContainer *container,
1009 gboolean include_internals,
1010 GtkCallback callback,
1011 gpointer callback_data)
1013 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (container));
1014 g_return_if_fail (callback != NULL);
1016 GTK_CONTAINER_CLASS (gtk_scrolled_window_parent_class)->forall (container,
1020 if (include_internals)
1022 GtkScrolledWindow *scrolled_window;
1024 scrolled_window = GTK_SCROLLED_WINDOW (container);
1026 if (scrolled_window->vscrollbar)
1027 callback (scrolled_window->vscrollbar, callback_data);
1028 if (scrolled_window->hscrollbar)
1029 callback (scrolled_window->hscrollbar, callback_data);
1034 gtk_scrolled_window_scroll_child (GtkScrolledWindow *scrolled_window,
1035 GtkScrollType scroll,
1036 gboolean horizontal)
1038 GtkAdjustment *adjustment = NULL;
1042 case GTK_SCROLL_STEP_UP:
1043 scroll = GTK_SCROLL_STEP_BACKWARD;
1046 case GTK_SCROLL_STEP_DOWN:
1047 scroll = GTK_SCROLL_STEP_FORWARD;
1050 case GTK_SCROLL_STEP_LEFT:
1051 scroll = GTK_SCROLL_STEP_BACKWARD;
1054 case GTK_SCROLL_STEP_RIGHT:
1055 scroll = GTK_SCROLL_STEP_FORWARD;
1058 case GTK_SCROLL_PAGE_UP:
1059 scroll = GTK_SCROLL_PAGE_BACKWARD;
1062 case GTK_SCROLL_PAGE_DOWN:
1063 scroll = GTK_SCROLL_PAGE_FORWARD;
1066 case GTK_SCROLL_PAGE_LEFT:
1067 scroll = GTK_SCROLL_STEP_BACKWARD;
1070 case GTK_SCROLL_PAGE_RIGHT:
1071 scroll = GTK_SCROLL_STEP_FORWARD;
1074 case GTK_SCROLL_STEP_BACKWARD:
1075 case GTK_SCROLL_STEP_FORWARD:
1076 case GTK_SCROLL_PAGE_BACKWARD:
1077 case GTK_SCROLL_PAGE_FORWARD:
1078 case GTK_SCROLL_START:
1079 case GTK_SCROLL_END:
1082 g_warning ("Invalid scroll type %u for GtkScrolledWindow::scroll-child", scroll);
1086 if ((horizontal && (!scrolled_window->hscrollbar || !scrolled_window->hscrollbar_visible)) ||
1087 (!horizontal && (!scrolled_window->vscrollbar || !scrolled_window->vscrollbar_visible)))
1092 if (scrolled_window->hscrollbar)
1093 adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
1097 if (scrolled_window->vscrollbar)
1098 adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
1103 gdouble value = adjustment->value;
1107 case GTK_SCROLL_STEP_FORWARD:
1108 value += adjustment->step_increment;
1110 case GTK_SCROLL_STEP_BACKWARD:
1111 value -= adjustment->step_increment;
1113 case GTK_SCROLL_PAGE_FORWARD:
1114 value += adjustment->page_increment;
1116 case GTK_SCROLL_PAGE_BACKWARD:
1117 value -= adjustment->page_increment;
1119 case GTK_SCROLL_START:
1120 value = adjustment->lower;
1122 case GTK_SCROLL_END:
1123 value = adjustment->upper;
1126 g_assert_not_reached ();
1130 value = CLAMP (value, adjustment->lower, adjustment->upper - adjustment->page_size);
1132 gtk_adjustment_set_value (adjustment, value);
1141 gtk_scrolled_window_move_focus_out (GtkScrolledWindow *scrolled_window,
1142 GtkDirectionType direction_type)
1144 GtkWidget *toplevel;
1146 /* Focus out of the scrolled window entirely. We do this by setting
1147 * a flag, then propagating the focus motion to the notebook.
1149 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (scrolled_window));
1150 if (!GTK_WIDGET_TOPLEVEL (toplevel))
1153 g_object_ref (scrolled_window);
1155 scrolled_window->focus_out = TRUE;
1156 g_signal_emit_by_name (toplevel, "move_focus", direction_type);
1157 scrolled_window->focus_out = FALSE;
1159 g_object_unref (scrolled_window);
1163 gtk_scrolled_window_size_request (GtkWidget *widget,
1164 GtkRequisition *requisition)
1166 GtkScrolledWindow *scrolled_window;
1170 gint scrollbar_spacing;
1171 GtkRequisition hscrollbar_requisition;
1172 GtkRequisition vscrollbar_requisition;
1173 GtkRequisition child_requisition;
1175 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (widget));
1176 g_return_if_fail (requisition != NULL);
1178 scrolled_window = GTK_SCROLLED_WINDOW (widget);
1179 bin = GTK_BIN (scrolled_window);
1181 scrollbar_spacing = _gtk_scrolled_window_get_scrollbar_spacing (scrolled_window);
1185 requisition->width = 0;
1186 requisition->height = 0;
1188 gtk_widget_size_request (scrolled_window->hscrollbar,
1189 &hscrollbar_requisition);
1190 gtk_widget_size_request (scrolled_window->vscrollbar,
1191 &vscrollbar_requisition);
1193 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
1195 gtk_widget_size_request (bin->child, &child_requisition);
1197 if (scrolled_window->hscrollbar_policy == GTK_POLICY_NEVER)
1198 requisition->width += child_requisition.width;
1201 GtkWidgetAuxInfo *aux_info = _gtk_widget_get_aux_info (bin->child, FALSE);
1203 if (aux_info && aux_info->width > 0)
1205 requisition->width += aux_info->width;
1209 requisition->width += vscrollbar_requisition.width;
1212 if (scrolled_window->vscrollbar_policy == GTK_POLICY_NEVER)
1213 requisition->height += child_requisition.height;
1216 GtkWidgetAuxInfo *aux_info = _gtk_widget_get_aux_info (bin->child, FALSE);
1218 if (aux_info && aux_info->height > 0)
1220 requisition->height += aux_info->height;
1224 requisition->height += hscrollbar_requisition.height;
1228 if (scrolled_window->hscrollbar_policy == GTK_POLICY_AUTOMATIC ||
1229 scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS)
1231 requisition->width = MAX (requisition->width, hscrollbar_requisition.width);
1232 if (!extra_height || scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS)
1233 extra_height = scrollbar_spacing + hscrollbar_requisition.height;
1236 if (scrolled_window->vscrollbar_policy == GTK_POLICY_AUTOMATIC ||
1237 scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS)
1239 requisition->height = MAX (requisition->height, vscrollbar_requisition.height);
1240 if (!extra_height || scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS)
1241 extra_width = scrollbar_spacing + vscrollbar_requisition.width;
1244 requisition->width += GTK_CONTAINER (widget)->border_width * 2 + MAX (0, extra_width);
1245 requisition->height += GTK_CONTAINER (widget)->border_width * 2 + MAX (0, extra_height);
1247 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1249 requisition->width += 2 * widget->style->xthickness;
1250 requisition->height += 2 * widget->style->ythickness;
1255 gtk_scrolled_window_relative_allocation (GtkWidget *widget,
1256 GtkAllocation *allocation)
1258 GtkScrolledWindow *scrolled_window;
1259 GtkScrolledWindowPrivate *priv;
1260 gint scrollbar_spacing;
1262 g_return_if_fail (widget != NULL);
1263 g_return_if_fail (allocation != NULL);
1265 scrolled_window = GTK_SCROLLED_WINDOW (widget);
1266 scrollbar_spacing = _gtk_scrolled_window_get_scrollbar_spacing (scrolled_window);
1268 priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
1270 allocation->x = GTK_CONTAINER (widget)->border_width;
1271 allocation->y = GTK_CONTAINER (widget)->border_width;
1273 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1275 allocation->x += widget->style->xthickness;
1276 allocation->y += widget->style->ythickness;
1279 allocation->width = MAX (1, (gint)widget->allocation.width - allocation->x * 2);
1280 allocation->height = MAX (1, (gint)widget->allocation.height - allocation->y * 2);
1282 if (scrolled_window->vscrollbar_visible)
1284 GtkRequisition vscrollbar_requisition;
1287 gtk_widget_get_child_requisition (scrolled_window->vscrollbar,
1288 &vscrollbar_requisition);
1289 is_rtl = gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL;
1292 (priv->real_window_placement == GTK_CORNER_TOP_RIGHT ||
1293 priv->real_window_placement == GTK_CORNER_BOTTOM_RIGHT)) ||
1295 (priv->real_window_placement == GTK_CORNER_TOP_LEFT ||
1296 priv->real_window_placement == GTK_CORNER_BOTTOM_LEFT)))
1297 allocation->x += (vscrollbar_requisition.width + scrollbar_spacing);
1299 allocation->width = MAX (1, allocation->width - (vscrollbar_requisition.width + scrollbar_spacing));
1301 if (scrolled_window->hscrollbar_visible)
1303 GtkRequisition hscrollbar_requisition;
1304 gtk_widget_get_child_requisition (scrolled_window->hscrollbar,
1305 &hscrollbar_requisition);
1307 if (priv->real_window_placement == GTK_CORNER_BOTTOM_LEFT ||
1308 priv->real_window_placement == GTK_CORNER_BOTTOM_RIGHT)
1309 allocation->y += (hscrollbar_requisition.height + scrollbar_spacing);
1311 allocation->height = MAX (1, allocation->height - (hscrollbar_requisition.height + scrollbar_spacing));
1316 gtk_scrolled_window_size_allocate (GtkWidget *widget,
1317 GtkAllocation *allocation)
1319 GtkScrolledWindow *scrolled_window;
1320 GtkScrolledWindowPrivate *priv;
1322 GtkAllocation relative_allocation;
1323 GtkAllocation child_allocation;
1324 gboolean scrollbars_within_bevel;
1325 gint scrollbar_spacing;
1327 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (widget));
1328 g_return_if_fail (allocation != NULL);
1330 scrolled_window = GTK_SCROLLED_WINDOW (widget);
1331 bin = GTK_BIN (scrolled_window);
1333 scrollbar_spacing = _gtk_scrolled_window_get_scrollbar_spacing (scrolled_window);
1334 gtk_widget_style_get (widget, "scrollbars-within-bevel", &scrollbars_within_bevel, NULL);
1336 priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
1338 widget->allocation = *allocation;
1340 if (scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS)
1341 scrolled_window->hscrollbar_visible = TRUE;
1342 else if (scrolled_window->hscrollbar_policy == GTK_POLICY_NEVER)
1343 scrolled_window->hscrollbar_visible = FALSE;
1344 if (scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS)
1345 scrolled_window->vscrollbar_visible = TRUE;
1346 else if (scrolled_window->vscrollbar_policy == GTK_POLICY_NEVER)
1347 scrolled_window->vscrollbar_visible = FALSE;
1349 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
1351 gboolean previous_hvis;
1352 gboolean previous_vvis;
1357 gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
1359 child_allocation.x = relative_allocation.x + allocation->x;
1360 child_allocation.y = relative_allocation.y + allocation->y;
1361 child_allocation.width = relative_allocation.width;
1362 child_allocation.height = relative_allocation.height;
1364 previous_hvis = scrolled_window->hscrollbar_visible;
1365 previous_vvis = scrolled_window->vscrollbar_visible;
1367 gtk_widget_size_allocate (bin->child, &child_allocation);
1369 /* If, after the first iteration, the hscrollbar and the
1370 * vscrollbar flip visiblity, then we need both.
1373 previous_hvis != scrolled_window->hscrollbar_visible &&
1374 previous_vvis != scrolled_window->vscrollbar_visible)
1376 scrolled_window->hscrollbar_visible = TRUE;
1377 scrolled_window->vscrollbar_visible = TRUE;
1379 /* a new resize is already queued at this point,
1380 * so we will immediatedly get reinvoked
1387 while (previous_hvis != scrolled_window->hscrollbar_visible ||
1388 previous_vvis != scrolled_window->vscrollbar_visible);
1392 scrolled_window->hscrollbar_visible = scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS;
1393 scrolled_window->vscrollbar_visible = scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS;
1394 gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
1397 if (scrolled_window->hscrollbar_visible)
1399 GtkRequisition hscrollbar_requisition;
1400 gtk_widget_get_child_requisition (scrolled_window->hscrollbar,
1401 &hscrollbar_requisition);
1403 if (!GTK_WIDGET_VISIBLE (scrolled_window->hscrollbar))
1404 gtk_widget_show (scrolled_window->hscrollbar);
1406 child_allocation.x = relative_allocation.x;
1407 if (priv->real_window_placement == GTK_CORNER_TOP_LEFT ||
1408 priv->real_window_placement == GTK_CORNER_TOP_RIGHT)
1409 child_allocation.y = (relative_allocation.y +
1410 relative_allocation.height +
1412 (scrolled_window->shadow_type == GTK_SHADOW_NONE ?
1413 0 : widget->style->ythickness));
1415 child_allocation.y = GTK_CONTAINER (scrolled_window)->border_width;
1417 child_allocation.width = relative_allocation.width;
1418 child_allocation.height = hscrollbar_requisition.height;
1419 child_allocation.x += allocation->x;
1420 child_allocation.y += allocation->y;
1422 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1424 if (!scrollbars_within_bevel)
1426 child_allocation.x -= widget->style->xthickness;
1427 child_allocation.width += 2 * widget->style->xthickness;
1429 else if (GTK_CORNER_TOP_RIGHT == priv->real_window_placement ||
1430 GTK_CORNER_TOP_LEFT == priv->real_window_placement)
1432 child_allocation.y -= widget->style->ythickness;
1436 child_allocation.y += widget->style->ythickness;
1440 gtk_widget_size_allocate (scrolled_window->hscrollbar, &child_allocation);
1442 else if (GTK_WIDGET_VISIBLE (scrolled_window->hscrollbar))
1443 gtk_widget_hide (scrolled_window->hscrollbar);
1445 if (scrolled_window->vscrollbar_visible)
1447 GtkRequisition vscrollbar_requisition;
1448 if (!GTK_WIDGET_VISIBLE (scrolled_window->vscrollbar))
1449 gtk_widget_show (scrolled_window->vscrollbar);
1451 gtk_widget_get_child_requisition (scrolled_window->vscrollbar,
1452 &vscrollbar_requisition);
1454 if ((gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL &&
1455 (priv->real_window_placement == GTK_CORNER_TOP_RIGHT ||
1456 priv->real_window_placement == GTK_CORNER_BOTTOM_RIGHT)) ||
1457 (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR &&
1458 (priv->real_window_placement == GTK_CORNER_TOP_LEFT ||
1459 priv->real_window_placement == GTK_CORNER_BOTTOM_LEFT)))
1460 child_allocation.x = (relative_allocation.x +
1461 relative_allocation.width +
1463 (scrolled_window->shadow_type == GTK_SHADOW_NONE ?
1464 0 : widget->style->xthickness));
1466 child_allocation.x = GTK_CONTAINER (scrolled_window)->border_width;
1468 child_allocation.y = relative_allocation.y;
1469 child_allocation.width = vscrollbar_requisition.width;
1470 child_allocation.height = relative_allocation.height;
1471 child_allocation.x += allocation->x;
1472 child_allocation.y += allocation->y;
1474 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1476 if (!scrollbars_within_bevel)
1478 child_allocation.y -= widget->style->ythickness;
1479 child_allocation.height += 2 * widget->style->ythickness;
1481 else if (GTK_CORNER_BOTTOM_LEFT == priv->real_window_placement ||
1482 GTK_CORNER_TOP_LEFT == priv->real_window_placement)
1484 child_allocation.x -= widget->style->xthickness;
1488 child_allocation.x += widget->style->xthickness;
1492 gtk_widget_size_allocate (scrolled_window->vscrollbar, &child_allocation);
1494 else if (GTK_WIDGET_VISIBLE (scrolled_window->vscrollbar))
1495 gtk_widget_hide (scrolled_window->vscrollbar);
1499 gtk_scrolled_window_scroll_event (GtkWidget *widget,
1500 GdkEventScroll *event)
1504 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (widget), FALSE);
1505 g_return_val_if_fail (event != NULL, FALSE);
1507 if (event->direction == GDK_SCROLL_UP || event->direction == GDK_SCROLL_DOWN)
1508 range = GTK_SCROLLED_WINDOW (widget)->vscrollbar;
1510 range = GTK_SCROLLED_WINDOW (widget)->hscrollbar;
1512 if (range && GTK_WIDGET_VISIBLE (range))
1514 GtkAdjustment *adj = GTK_RANGE (range)->adjustment;
1515 gdouble delta, new_value;
1517 delta = _gtk_range_get_wheel_delta (GTK_RANGE (range), event->direction);
1519 new_value = CLAMP (adj->value + delta, adj->lower, adj->upper - adj->page_size);
1521 gtk_adjustment_set_value (adj, new_value);
1530 gtk_scrolled_window_focus (GtkWidget *widget,
1531 GtkDirectionType direction)
1533 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (widget);
1534 gboolean had_focus_child = GTK_CONTAINER (widget)->focus_child != NULL;
1536 if (scrolled_window->focus_out)
1538 scrolled_window->focus_out = FALSE; /* Clear this to catch the wrap-around case */
1542 if (gtk_widget_is_focus (widget))
1545 /* We only put the scrolled window itself in the focus chain if it
1546 * isn't possible to focus any children.
1548 if (GTK_BIN (widget)->child)
1550 if (gtk_widget_child_focus (GTK_BIN (widget)->child, direction))
1554 if (!had_focus_child)
1556 gtk_widget_grab_focus (widget);
1564 gtk_scrolled_window_adjustment_changed (GtkAdjustment *adjustment,
1567 GtkScrolledWindow *scrolled_win;
1569 g_return_if_fail (adjustment != NULL);
1570 g_return_if_fail (data != NULL);
1572 scrolled_win = GTK_SCROLLED_WINDOW (data);
1574 if (scrolled_win->hscrollbar &&
1575 adjustment == gtk_range_get_adjustment (GTK_RANGE (scrolled_win->hscrollbar)))
1577 if (scrolled_win->hscrollbar_policy == GTK_POLICY_AUTOMATIC)
1581 visible = scrolled_win->hscrollbar_visible;
1582 scrolled_win->hscrollbar_visible = (adjustment->upper - adjustment->lower >
1583 adjustment->page_size);
1584 if (scrolled_win->hscrollbar_visible != visible)
1585 gtk_widget_queue_resize (GTK_WIDGET (scrolled_win));
1588 else if (scrolled_win->vscrollbar &&
1589 adjustment == gtk_range_get_adjustment (GTK_RANGE (scrolled_win->vscrollbar)))
1591 if (scrolled_win->vscrollbar_policy == GTK_POLICY_AUTOMATIC)
1595 visible = scrolled_win->vscrollbar_visible;
1596 scrolled_win->vscrollbar_visible = (adjustment->upper - adjustment->lower >
1597 adjustment->page_size);
1598 if (scrolled_win->vscrollbar_visible != visible)
1599 gtk_widget_queue_resize (GTK_WIDGET (scrolled_win));
1605 gtk_scrolled_window_add (GtkContainer *container,
1608 GtkScrolledWindow *scrolled_window;
1611 bin = GTK_BIN (container);
1612 g_return_if_fail (bin->child == NULL);
1614 scrolled_window = GTK_SCROLLED_WINDOW (container);
1617 gtk_widget_set_parent (child, GTK_WIDGET (bin));
1619 /* this is a temporary message */
1620 if (!gtk_widget_set_scroll_adjustments (child,
1621 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
1622 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar))))
1623 g_warning ("gtk_scrolled_window_add(): cannot add non scrollable widget "
1624 "use gtk_scrolled_window_add_with_viewport() instead");
1628 gtk_scrolled_window_remove (GtkContainer *container,
1631 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (container));
1632 g_return_if_fail (child != NULL);
1633 g_return_if_fail (GTK_BIN (container)->child == child);
1635 gtk_widget_set_scroll_adjustments (child, NULL, NULL);
1637 /* chain parent class handler to remove child */
1638 GTK_CONTAINER_CLASS (gtk_scrolled_window_parent_class)->remove (container, child);
1642 gtk_scrolled_window_add_with_viewport (GtkScrolledWindow *scrolled_window,
1646 GtkWidget *viewport;
1648 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
1649 g_return_if_fail (GTK_IS_WIDGET (child));
1650 g_return_if_fail (child->parent == NULL);
1652 bin = GTK_BIN (scrolled_window);
1654 if (bin->child != NULL)
1656 g_return_if_fail (GTK_IS_VIEWPORT (bin->child));
1657 g_return_if_fail (GTK_BIN (bin->child)->child == NULL);
1659 viewport = bin->child;
1664 gtk_viewport_new (gtk_scrolled_window_get_hadjustment (scrolled_window),
1665 gtk_scrolled_window_get_vadjustment (scrolled_window));
1666 gtk_container_add (GTK_CONTAINER (scrolled_window), viewport);
1669 gtk_widget_show (viewport);
1670 gtk_container_add (GTK_CONTAINER (viewport), child);
1674 * _gtk_scrolled_window_get_spacing:
1675 * @scrolled_window: a scrolled window
1677 * Gets the spacing between the scrolled window's scrollbars and
1678 * the scrolled widget. Used by GtkCombo
1680 * Return value: the spacing, in pixels.
1683 _gtk_scrolled_window_get_scrollbar_spacing (GtkScrolledWindow *scrolled_window)
1685 GtkScrolledWindowClass *class;
1687 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), 0);
1689 class = GTK_SCROLLED_WINDOW_GET_CLASS (scrolled_window);
1691 if (class->scrollbar_spacing >= 0)
1692 return class->scrollbar_spacing;
1695 gint scrollbar_spacing;
1697 gtk_widget_style_get (GTK_WIDGET (scrolled_window),
1698 "scrollbar-spacing", &scrollbar_spacing,
1701 return scrollbar_spacing;
1705 #define __GTK_SCROLLED_WINDOW_C__
1706 #include "gtkaliasdef.c"