1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
29 #include <gdk/gdkkeysyms.h>
30 #include "gtkbindings.h"
31 #include "gtkextendedlayout.h"
32 #include "gtkmarshalers.h"
33 #include "gtkscrolledwindow.h"
34 #include "gtkwindow.h"
35 #include "gtkprivate.h"
40 /* scrolled window policy and size requisition handling:
42 * gtk size requisition works as follows:
43 * a widget upon size-request reports the width and height that it finds
44 * to be best suited to display its contents, including children.
45 * the width and/or height reported from a widget upon size requisition
46 * may be overidden by the user by specifying a width and/or height
47 * other than 0 through gtk_widget_set_size_request().
49 * a scrolled window needs (for implementing all three policy types) to
50 * request its width and height based on two different rationales.
51 * 1) the user wants the scrolled window to just fit into the space
52 * that it gets allocated for a specifc dimension.
53 * 1.1) this does not apply if the user specified a concrete value
54 * value for that specific dimension by either specifying usize for the
55 * scrolled window or for its child.
56 * 2) the user wants the scrolled window to take as much space up as
57 * is desired by the child for a specifc dimension (i.e. POLICY_NEVER).
59 * also, kinda obvious:
60 * 3) a user would certainly not have choosen a scrolled window as a container
61 * for the child, if the resulting allocation takes up more space than the
62 * child would have allocated without the scrolled window.
65 * A) from 1) follows: the scrolled window shouldn't request more space for a
66 * specifc dimension than is required at minimum.
67 * B) from 1.1) follows: the requisition may be overidden by usize of the scrolled
68 * window (done automatically) or by usize of the child (needs to be checked).
69 * C) from 2) follows: for POLICY_NEVER, the scrolled window simply reports the
71 * D) from 3) follows: the scrolled window child's minimum width and minimum height
72 * under A) at least correspond to the space taken up by its scrollbars.
75 #define DEFAULT_SCROLLBAR_SPACING 3
78 gboolean window_placement_set;
79 GtkCornerType real_window_placement;
80 } GtkScrolledWindowPrivate;
82 #define GTK_SCROLLED_WINDOW_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_SCROLLED_WINDOW, GtkScrolledWindowPrivate))
88 PROP_HSCROLLBAR_POLICY,
89 PROP_VSCROLLBAR_POLICY,
90 PROP_WINDOW_PLACEMENT,
91 PROP_WINDOW_PLACEMENT_SET,
103 static void gtk_scrolled_window_destroy (GtkObject *object);
104 static void gtk_scrolled_window_set_property (GObject *object,
108 static void gtk_scrolled_window_get_property (GObject *object,
113 static void gtk_scrolled_window_screen_changed (GtkWidget *widget,
114 GdkScreen *previous_screen);
115 static gboolean gtk_scrolled_window_expose (GtkWidget *widget,
116 GdkEventExpose *event);
117 static void gtk_scrolled_window_size_request (GtkWidget *widget,
118 GtkRequisition *requisition);
119 static void gtk_scrolled_window_size_allocate (GtkWidget *widget,
120 GtkAllocation *allocation);
121 static gboolean gtk_scrolled_window_scroll_event (GtkWidget *widget,
122 GdkEventScroll *event);
123 static gboolean gtk_scrolled_window_focus (GtkWidget *widget,
124 GtkDirectionType direction);
125 static void gtk_scrolled_window_add (GtkContainer *container,
127 static void gtk_scrolled_window_remove (GtkContainer *container,
129 static void gtk_scrolled_window_forall (GtkContainer *container,
130 gboolean include_internals,
131 GtkCallback callback,
132 gpointer callback_data);
133 static gboolean gtk_scrolled_window_scroll_child (GtkScrolledWindow *scrolled_window,
134 GtkScrollType scroll,
135 gboolean horizontal);
136 static void gtk_scrolled_window_move_focus_out (GtkScrolledWindow *scrolled_window,
137 GtkDirectionType direction_type);
139 static void gtk_scrolled_window_relative_allocation(GtkWidget *widget,
140 GtkAllocation *allocation);
141 static void gtk_scrolled_window_adjustment_changed (GtkAdjustment *adjustment,
144 static void gtk_scrolled_window_update_real_placement (GtkScrolledWindow *scrolled_window);
146 static void gtk_scrolled_window_extended_layout_init (GtkExtendedLayoutIface *iface);
148 static guint signals[LAST_SIGNAL] = {0};
150 G_DEFINE_TYPE_WITH_CODE (GtkScrolledWindow, gtk_scrolled_window, GTK_TYPE_BIN,
151 G_IMPLEMENT_INTERFACE (GTK_TYPE_EXTENDED_LAYOUT,
152 gtk_scrolled_window_extended_layout_init))
156 add_scroll_binding (GtkBindingSet *binding_set,
158 GdkModifierType mask,
159 GtkScrollType scroll,
162 guint keypad_keyval = keyval - GDK_Left + GDK_KP_Left;
164 gtk_binding_entry_add_signal (binding_set, keyval, mask,
166 GTK_TYPE_SCROLL_TYPE, scroll,
167 G_TYPE_BOOLEAN, horizontal);
168 gtk_binding_entry_add_signal (binding_set, keypad_keyval, mask,
170 GTK_TYPE_SCROLL_TYPE, scroll,
171 G_TYPE_BOOLEAN, horizontal);
175 add_tab_bindings (GtkBindingSet *binding_set,
176 GdkModifierType modifiers,
177 GtkDirectionType direction)
179 gtk_binding_entry_add_signal (binding_set, GDK_Tab, modifiers,
181 GTK_TYPE_DIRECTION_TYPE, direction);
182 gtk_binding_entry_add_signal (binding_set, GDK_KP_Tab, modifiers,
184 GTK_TYPE_DIRECTION_TYPE, direction);
188 gtk_scrolled_window_class_init (GtkScrolledWindowClass *class)
190 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
191 GtkObjectClass *object_class;
192 GtkWidgetClass *widget_class;
193 GtkContainerClass *container_class;
194 GtkBindingSet *binding_set;
196 object_class = (GtkObjectClass*) class;
197 widget_class = (GtkWidgetClass*) class;
198 container_class = (GtkContainerClass*) class;
200 gobject_class->set_property = gtk_scrolled_window_set_property;
201 gobject_class->get_property = gtk_scrolled_window_get_property;
203 object_class->destroy = gtk_scrolled_window_destroy;
205 widget_class->screen_changed = gtk_scrolled_window_screen_changed;
206 widget_class->expose_event = gtk_scrolled_window_expose;
207 widget_class->size_request = gtk_scrolled_window_size_request;
208 widget_class->size_allocate = gtk_scrolled_window_size_allocate;
209 widget_class->scroll_event = gtk_scrolled_window_scroll_event;
210 widget_class->focus = gtk_scrolled_window_focus;
212 container_class->add = gtk_scrolled_window_add;
213 container_class->remove = gtk_scrolled_window_remove;
214 container_class->forall = gtk_scrolled_window_forall;
216 class->scrollbar_spacing = -1;
218 class->scroll_child = gtk_scrolled_window_scroll_child;
219 class->move_focus_out = gtk_scrolled_window_move_focus_out;
221 g_object_class_install_property (gobject_class,
223 g_param_spec_object ("hadjustment",
224 P_("Horizontal Adjustment"),
225 P_("The GtkAdjustment for the horizontal position"),
227 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
228 g_object_class_install_property (gobject_class,
230 g_param_spec_object ("vadjustment",
231 P_("Vertical Adjustment"),
232 P_("The GtkAdjustment for the vertical position"),
234 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
235 g_object_class_install_property (gobject_class,
236 PROP_HSCROLLBAR_POLICY,
237 g_param_spec_enum ("hscrollbar-policy",
238 P_("Horizontal Scrollbar Policy"),
239 P_("When the horizontal scrollbar is displayed"),
240 GTK_TYPE_POLICY_TYPE,
242 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
243 g_object_class_install_property (gobject_class,
244 PROP_VSCROLLBAR_POLICY,
245 g_param_spec_enum ("vscrollbar-policy",
246 P_("Vertical Scrollbar Policy"),
247 P_("When the vertical scrollbar is displayed"),
248 GTK_TYPE_POLICY_TYPE,
250 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
252 g_object_class_install_property (gobject_class,
253 PROP_WINDOW_PLACEMENT,
254 g_param_spec_enum ("window-placement",
255 P_("Window Placement"),
256 P_("Where the contents are located with respect to the scrollbars. This property only takes effect if \"window-placement-set\" is TRUE."),
257 GTK_TYPE_CORNER_TYPE,
259 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
262 * GtkScrolledWindow:window-placement-set:
264 * Whether "window-placement" should be used to determine the location
265 * of the contents with respect to the scrollbars. Otherwise, the
266 * "gtk-scrolled-window-placement" setting is used.
270 g_object_class_install_property (gobject_class,
271 PROP_WINDOW_PLACEMENT_SET,
272 g_param_spec_boolean ("window-placement-set",
273 P_("Window Placement Set"),
274 P_("Whether \"window-placement\" should be used to determine the location of the contents with respect to the scrollbars."),
276 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
277 g_object_class_install_property (gobject_class,
279 g_param_spec_enum ("shadow-type",
281 P_("Style of bevel around the contents"),
282 GTK_TYPE_SHADOW_TYPE,
284 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
287 * GtkScrolledWindow:scrollbars-within-bevel:
289 * Whether to place scrollbars within the scrolled window's bevel.
293 gtk_widget_class_install_style_property (widget_class,
294 g_param_spec_boolean ("scrollbars-within-bevel",
295 P_("Scrollbars within bevel"),
296 P_("Place scrollbars within the scrolled window's bevel"),
298 GTK_PARAM_READABLE));
300 gtk_widget_class_install_style_property (widget_class,
301 g_param_spec_int ("scrollbar-spacing",
302 P_("Scrollbar spacing"),
303 P_("Number of pixels between the scrollbars and the scrolled window"),
306 DEFAULT_SCROLLBAR_SPACING,
307 GTK_PARAM_READABLE));
310 * GtkSettings:gtk-scrolled-window-placement:
312 * Where the contents of scrolled windows are located with respect to the
313 * scrollbars, if not overridden by the scrolled window's own placement.
317 gtk_settings_install_property (g_param_spec_enum ("gtk-scrolled-window-placement",
318 P_("Scrolled Window Placement"),
319 P_("Where the contents of scrolled windows are located with respect to the scrollbars, if not overridden by the scrolled window's own placement."),
320 GTK_TYPE_CORNER_TYPE,
322 G_PARAM_READABLE | G_PARAM_WRITABLE));
325 signals[SCROLL_CHILD] =
326 g_signal_new (I_("scroll-child"),
327 G_TYPE_FROM_CLASS (object_class),
328 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
329 G_STRUCT_OFFSET (GtkScrolledWindowClass, scroll_child),
331 _gtk_marshal_BOOLEAN__ENUM_BOOLEAN,
333 GTK_TYPE_SCROLL_TYPE,
335 signals[MOVE_FOCUS_OUT] =
336 g_signal_new (I_("move-focus-out"),
337 G_TYPE_FROM_CLASS (object_class),
338 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
339 G_STRUCT_OFFSET (GtkScrolledWindowClass, move_focus_out),
341 _gtk_marshal_VOID__ENUM,
343 GTK_TYPE_DIRECTION_TYPE);
345 binding_set = gtk_binding_set_by_class (class);
347 add_scroll_binding (binding_set, GDK_Left, GDK_CONTROL_MASK, GTK_SCROLL_STEP_BACKWARD, TRUE);
348 add_scroll_binding (binding_set, GDK_Right, GDK_CONTROL_MASK, GTK_SCROLL_STEP_FORWARD, TRUE);
349 add_scroll_binding (binding_set, GDK_Up, GDK_CONTROL_MASK, GTK_SCROLL_STEP_BACKWARD, FALSE);
350 add_scroll_binding (binding_set, GDK_Down, GDK_CONTROL_MASK, GTK_SCROLL_STEP_FORWARD, FALSE);
352 add_scroll_binding (binding_set, GDK_Page_Up, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_BACKWARD, TRUE);
353 add_scroll_binding (binding_set, GDK_Page_Down, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_FORWARD, TRUE);
354 add_scroll_binding (binding_set, GDK_Page_Up, 0, GTK_SCROLL_PAGE_BACKWARD, FALSE);
355 add_scroll_binding (binding_set, GDK_Page_Down, 0, GTK_SCROLL_PAGE_FORWARD, FALSE);
357 add_scroll_binding (binding_set, GDK_Home, GDK_CONTROL_MASK, GTK_SCROLL_START, TRUE);
358 add_scroll_binding (binding_set, GDK_End, GDK_CONTROL_MASK, GTK_SCROLL_END, TRUE);
359 add_scroll_binding (binding_set, GDK_Home, 0, GTK_SCROLL_START, FALSE);
360 add_scroll_binding (binding_set, GDK_End, 0, GTK_SCROLL_END, FALSE);
362 add_tab_bindings (binding_set, GDK_CONTROL_MASK, GTK_DIR_TAB_FORWARD);
363 add_tab_bindings (binding_set, GDK_CONTROL_MASK | GDK_SHIFT_MASK, GTK_DIR_TAB_BACKWARD);
365 g_type_class_add_private (class, sizeof (GtkScrolledWindowPrivate));
369 gtk_scrolled_window_init (GtkScrolledWindow *scrolled_window)
371 GTK_WIDGET_SET_FLAGS (scrolled_window, GTK_NO_WINDOW | GTK_CAN_FOCUS);
373 scrolled_window->hscrollbar = NULL;
374 scrolled_window->vscrollbar = NULL;
375 scrolled_window->hscrollbar_policy = GTK_POLICY_ALWAYS;
376 scrolled_window->vscrollbar_policy = GTK_POLICY_ALWAYS;
377 scrolled_window->hscrollbar_visible = FALSE;
378 scrolled_window->vscrollbar_visible = FALSE;
379 scrolled_window->focus_out = FALSE;
380 scrolled_window->window_placement = GTK_CORNER_TOP_LEFT;
381 gtk_scrolled_window_update_real_placement (scrolled_window);
385 * gtk_scrolled_window_new:
386 * @hadjustment: (allow-none): horizontal adjustment
387 * @vadjustment: (allow-none): vertical adjustment
389 * Creates a new scrolled window.
391 * The two arguments are the scrolled window's adjustments; these will be
392 * shared with the scrollbars and the child widget to keep the bars in sync
393 * with the child. Usually you want to pass %NULL for the adjustments, which
394 * will cause the scrolled window to create them for you.
396 * Returns: a new scrolled window
399 gtk_scrolled_window_new (GtkAdjustment *hadjustment,
400 GtkAdjustment *vadjustment)
402 GtkWidget *scrolled_window;
405 g_return_val_if_fail (GTK_IS_ADJUSTMENT (hadjustment), NULL);
408 g_return_val_if_fail (GTK_IS_ADJUSTMENT (vadjustment), NULL);
410 scrolled_window = g_object_new (GTK_TYPE_SCROLLED_WINDOW,
411 "hadjustment", hadjustment,
412 "vadjustment", vadjustment,
415 return scrolled_window;
419 * gtk_scrolled_window_set_hadjustment:
420 * @scrolled_window: a #GtkScrolledWindow
421 * @hadjustment: horizontal scroll adjustment
423 * Sets the #GtkAdjustment for the horizontal scrollbar.
426 gtk_scrolled_window_set_hadjustment (GtkScrolledWindow *scrolled_window,
427 GtkAdjustment *hadjustment)
431 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
433 g_return_if_fail (GTK_IS_ADJUSTMENT (hadjustment));
435 hadjustment = (GtkAdjustment*) g_object_new (GTK_TYPE_ADJUSTMENT, NULL);
437 bin = GTK_BIN (scrolled_window);
439 if (!scrolled_window->hscrollbar)
441 gtk_widget_push_composite_child ();
442 scrolled_window->hscrollbar = gtk_hscrollbar_new (hadjustment);
443 gtk_widget_set_composite_name (scrolled_window->hscrollbar, "hscrollbar");
444 gtk_widget_pop_composite_child ();
446 gtk_widget_set_parent (scrolled_window->hscrollbar, GTK_WIDGET (scrolled_window));
447 g_object_ref (scrolled_window->hscrollbar);
448 gtk_widget_show (scrolled_window->hscrollbar);
452 GtkAdjustment *old_adjustment;
454 old_adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
455 if (old_adjustment == hadjustment)
458 g_signal_handlers_disconnect_by_func (old_adjustment,
459 gtk_scrolled_window_adjustment_changed,
461 gtk_range_set_adjustment (GTK_RANGE (scrolled_window->hscrollbar),
464 hadjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
465 g_signal_connect (hadjustment,
467 G_CALLBACK (gtk_scrolled_window_adjustment_changed),
469 gtk_scrolled_window_adjustment_changed (hadjustment, scrolled_window);
472 gtk_widget_set_scroll_adjustments (bin->child,
473 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
474 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)));
476 g_object_notify (G_OBJECT (scrolled_window), "hadjustment");
480 * gtk_scrolled_window_set_vadjustment:
481 * @scrolled_window: a #GtkScrolledWindow
482 * @vadjustment: vertical scroll adjustment
484 * Sets the #GtkAdjustment for the vertical scrollbar.
487 gtk_scrolled_window_set_vadjustment (GtkScrolledWindow *scrolled_window,
488 GtkAdjustment *vadjustment)
492 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
494 g_return_if_fail (GTK_IS_ADJUSTMENT (vadjustment));
496 vadjustment = (GtkAdjustment*) g_object_new (GTK_TYPE_ADJUSTMENT, NULL);
498 bin = GTK_BIN (scrolled_window);
500 if (!scrolled_window->vscrollbar)
502 gtk_widget_push_composite_child ();
503 scrolled_window->vscrollbar = gtk_vscrollbar_new (vadjustment);
504 gtk_widget_set_composite_name (scrolled_window->vscrollbar, "vscrollbar");
505 gtk_widget_pop_composite_child ();
507 gtk_widget_set_parent (scrolled_window->vscrollbar, GTK_WIDGET (scrolled_window));
508 g_object_ref (scrolled_window->vscrollbar);
509 gtk_widget_show (scrolled_window->vscrollbar);
513 GtkAdjustment *old_adjustment;
515 old_adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
516 if (old_adjustment == vadjustment)
519 g_signal_handlers_disconnect_by_func (old_adjustment,
520 gtk_scrolled_window_adjustment_changed,
522 gtk_range_set_adjustment (GTK_RANGE (scrolled_window->vscrollbar),
525 vadjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
526 g_signal_connect (vadjustment,
528 G_CALLBACK (gtk_scrolled_window_adjustment_changed),
530 gtk_scrolled_window_adjustment_changed (vadjustment, scrolled_window);
533 gtk_widget_set_scroll_adjustments (bin->child,
534 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
535 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)));
537 g_object_notify (G_OBJECT (scrolled_window), "vadjustment");
541 * gtk_scrolled_window_get_hadjustment:
542 * @scrolled_window: a #GtkScrolledWindow
544 * Returns the horizontal scrollbar's adjustment, used to connect the
545 * horizontal scrollbar to the child widget's horizontal scroll
548 * Returns: the horizontal #GtkAdjustment
551 gtk_scrolled_window_get_hadjustment (GtkScrolledWindow *scrolled_window)
553 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
555 return (scrolled_window->hscrollbar ?
556 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)) :
561 * gtk_scrolled_window_get_vadjustment:
562 * @scrolled_window: a #GtkScrolledWindow
564 * Returns the vertical scrollbar's adjustment, used to connect the
565 * vertical scrollbar to the child widget's vertical scroll
568 * Returns: the vertical #GtkAdjustment
571 gtk_scrolled_window_get_vadjustment (GtkScrolledWindow *scrolled_window)
573 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
575 return (scrolled_window->vscrollbar ?
576 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)) :
581 * gtk_scrolled_window_get_hscrollbar:
582 * @scrolled_window: a #GtkScrolledWindow
584 * Returns the horizontal scrollbar of @scrolled_window.
586 * Returns: the horizontal scrollbar of the scrolled window, or
587 * %NULL if it does not have one.
592 gtk_scrolled_window_get_hscrollbar (GtkScrolledWindow *scrolled_window)
594 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
596 return scrolled_window->hscrollbar;
600 * gtk_scrolled_window_get_vscrollbar:
601 * @scrolled_window: a #GtkScrolledWindow
603 * Returns the vertical scrollbar of @scrolled_window.
605 * Returns: the vertical scrollbar of the scrolled window, or
606 * %NULL if it does not have one.
611 gtk_scrolled_window_get_vscrollbar (GtkScrolledWindow *scrolled_window)
613 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
615 return scrolled_window->vscrollbar;
619 * gtk_scrolled_window_set_policy:
620 * @scrolled_window: a #GtkScrolledWindow
621 * @hscrollbar_policy: policy for horizontal bar
622 * @vscrollbar_policy: policy for vertical bar
624 * Sets the scrollbar policy for the horizontal and vertical scrollbars.
626 * The policy determines when the scrollbar should appear; it is a value
627 * from the #GtkPolicyType enumeration. If %GTK_POLICY_ALWAYS, the
628 * scrollbar is always present; if %GTK_POLICY_NEVER, the scrollbar is
629 * never present; if %GTK_POLICY_AUTOMATIC, the scrollbar is present only
630 * if needed (that is, if the slider part of the bar would be smaller
631 * than the trough - the display is larger than the page size).
634 gtk_scrolled_window_set_policy (GtkScrolledWindow *scrolled_window,
635 GtkPolicyType hscrollbar_policy,
636 GtkPolicyType vscrollbar_policy)
638 GObject *object = G_OBJECT (scrolled_window);
640 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
642 if ((scrolled_window->hscrollbar_policy != hscrollbar_policy) ||
643 (scrolled_window->vscrollbar_policy != vscrollbar_policy))
645 scrolled_window->hscrollbar_policy = hscrollbar_policy;
646 scrolled_window->vscrollbar_policy = vscrollbar_policy;
648 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
650 g_object_freeze_notify (object);
651 g_object_notify (object, "hscrollbar-policy");
652 g_object_notify (object, "vscrollbar-policy");
653 g_object_thaw_notify (object);
658 * gtk_scrolled_window_get_policy:
659 * @scrolled_window: a #GtkScrolledWindow
660 * @hscrollbar_policy: location to store the policy for the horizontal
661 * scrollbar, or %NULL.
662 * @vscrollbar_policy: location to store the policy for the vertical
663 * scrollbar, or %NULL.
665 * Retrieves the current policy values for the horizontal and vertical
666 * scrollbars. See gtk_scrolled_window_set_policy().
669 gtk_scrolled_window_get_policy (GtkScrolledWindow *scrolled_window,
670 GtkPolicyType *hscrollbar_policy,
671 GtkPolicyType *vscrollbar_policy)
673 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
675 if (hscrollbar_policy)
676 *hscrollbar_policy = scrolled_window->hscrollbar_policy;
677 if (vscrollbar_policy)
678 *vscrollbar_policy = scrolled_window->vscrollbar_policy;
682 gtk_scrolled_window_update_real_placement (GtkScrolledWindow *scrolled_window)
684 GtkScrolledWindowPrivate *priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
685 GtkSettings *settings;
687 settings = gtk_widget_get_settings (GTK_WIDGET (scrolled_window));
689 if (priv->window_placement_set || settings == NULL)
690 priv->real_window_placement = scrolled_window->window_placement;
692 g_object_get (settings,
693 "gtk-scrolled-window-placement",
694 &priv->real_window_placement,
699 gtk_scrolled_window_set_placement_internal (GtkScrolledWindow *scrolled_window,
700 GtkCornerType window_placement)
702 if (scrolled_window->window_placement != window_placement)
704 scrolled_window->window_placement = window_placement;
706 gtk_scrolled_window_update_real_placement (scrolled_window);
707 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
709 g_object_notify (G_OBJECT (scrolled_window), "window-placement");
714 gtk_scrolled_window_set_placement_set (GtkScrolledWindow *scrolled_window,
715 gboolean placement_set,
716 gboolean emit_resize)
718 GtkScrolledWindowPrivate *priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
720 if (priv->window_placement_set != placement_set)
722 priv->window_placement_set = placement_set;
724 gtk_scrolled_window_update_real_placement (scrolled_window);
726 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
728 g_object_notify (G_OBJECT (scrolled_window), "window-placement-set");
733 * gtk_scrolled_window_set_placement:
734 * @scrolled_window: a #GtkScrolledWindow
735 * @window_placement: position of the child window
737 * Sets the placement of the contents with respect to the scrollbars
738 * for the scrolled window.
740 * The default is %GTK_CORNER_TOP_LEFT, meaning the child is
741 * in the top left, with the scrollbars underneath and to the right.
742 * Other values in #GtkCornerType are %GTK_CORNER_TOP_RIGHT,
743 * %GTK_CORNER_BOTTOM_LEFT, and %GTK_CORNER_BOTTOM_RIGHT.
745 * See also gtk_scrolled_window_get_placement() and
746 * gtk_scrolled_window_unset_placement().
749 gtk_scrolled_window_set_placement (GtkScrolledWindow *scrolled_window,
750 GtkCornerType window_placement)
752 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
754 gtk_scrolled_window_set_placement_set (scrolled_window, TRUE, FALSE);
755 gtk_scrolled_window_set_placement_internal (scrolled_window, window_placement);
759 * gtk_scrolled_window_get_placement:
760 * @scrolled_window: a #GtkScrolledWindow
762 * Gets the placement of the contents with respect to the scrollbars
763 * for the scrolled window. See gtk_scrolled_window_set_placement().
765 * Return value: the current placement value.
767 * See also gtk_scrolled_window_set_placement() and
768 * gtk_scrolled_window_unset_placement().
771 gtk_scrolled_window_get_placement (GtkScrolledWindow *scrolled_window)
773 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), GTK_CORNER_TOP_LEFT);
775 return scrolled_window->window_placement;
779 * gtk_scrolled_window_unset_placement:
780 * @scrolled_window: a #GtkScrolledWindow
782 * Unsets the placement of the contents with respect to the scrollbars
783 * for the scrolled window. If no window placement is set for a scrolled
784 * window, it obeys the "gtk-scrolled-window-placement" XSETTING.
786 * See also gtk_scrolled_window_set_placement() and
787 * gtk_scrolled_window_get_placement().
792 gtk_scrolled_window_unset_placement (GtkScrolledWindow *scrolled_window)
794 GtkScrolledWindowPrivate *priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
796 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
798 if (priv->window_placement_set)
800 priv->window_placement_set = FALSE;
802 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
804 g_object_notify (G_OBJECT (scrolled_window), "window-placement-set");
809 * gtk_scrolled_window_set_shadow_type:
810 * @scrolled_window: a #GtkScrolledWindow
811 * @type: kind of shadow to draw around scrolled window contents
813 * Changes the type of shadow drawn around the contents of
818 gtk_scrolled_window_set_shadow_type (GtkScrolledWindow *scrolled_window,
821 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
822 g_return_if_fail (type >= GTK_SHADOW_NONE && type <= GTK_SHADOW_ETCHED_OUT);
824 if (scrolled_window->shadow_type != type)
826 scrolled_window->shadow_type = type;
828 if (gtk_widget_is_drawable (GTK_WIDGET (scrolled_window)))
829 gtk_widget_queue_draw (GTK_WIDGET (scrolled_window));
831 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
833 g_object_notify (G_OBJECT (scrolled_window), "shadow-type");
838 * gtk_scrolled_window_get_shadow_type:
839 * @scrolled_window: a #GtkScrolledWindow
841 * Gets the shadow type of the scrolled window. See
842 * gtk_scrolled_window_set_shadow_type().
844 * Return value: the current shadow type
847 gtk_scrolled_window_get_shadow_type (GtkScrolledWindow *scrolled_window)
849 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), GTK_SHADOW_NONE);
851 return scrolled_window->shadow_type;
855 gtk_scrolled_window_destroy (GtkObject *object)
857 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
859 if (scrolled_window->hscrollbar)
861 g_signal_handlers_disconnect_by_func (gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
862 gtk_scrolled_window_adjustment_changed,
864 gtk_widget_unparent (scrolled_window->hscrollbar);
865 gtk_widget_destroy (scrolled_window->hscrollbar);
866 g_object_unref (scrolled_window->hscrollbar);
867 scrolled_window->hscrollbar = NULL;
869 if (scrolled_window->vscrollbar)
871 g_signal_handlers_disconnect_by_func (gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)),
872 gtk_scrolled_window_adjustment_changed,
874 gtk_widget_unparent (scrolled_window->vscrollbar);
875 gtk_widget_destroy (scrolled_window->vscrollbar);
876 g_object_unref (scrolled_window->vscrollbar);
877 scrolled_window->vscrollbar = NULL;
880 GTK_OBJECT_CLASS (gtk_scrolled_window_parent_class)->destroy (object);
884 gtk_scrolled_window_set_property (GObject *object,
889 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
893 case PROP_HADJUSTMENT:
894 gtk_scrolled_window_set_hadjustment (scrolled_window,
895 g_value_get_object (value));
897 case PROP_VADJUSTMENT:
898 gtk_scrolled_window_set_vadjustment (scrolled_window,
899 g_value_get_object (value));
901 case PROP_HSCROLLBAR_POLICY:
902 gtk_scrolled_window_set_policy (scrolled_window,
903 g_value_get_enum (value),
904 scrolled_window->vscrollbar_policy);
906 case PROP_VSCROLLBAR_POLICY:
907 gtk_scrolled_window_set_policy (scrolled_window,
908 scrolled_window->hscrollbar_policy,
909 g_value_get_enum (value));
911 case PROP_WINDOW_PLACEMENT:
912 gtk_scrolled_window_set_placement_internal (scrolled_window,
913 g_value_get_enum (value));
915 case PROP_WINDOW_PLACEMENT_SET:
916 gtk_scrolled_window_set_placement_set (scrolled_window,
917 g_value_get_boolean (value),
920 case PROP_SHADOW_TYPE:
921 gtk_scrolled_window_set_shadow_type (scrolled_window,
922 g_value_get_enum (value));
925 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
931 gtk_scrolled_window_get_property (GObject *object,
936 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
937 GtkScrolledWindowPrivate *priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
941 case PROP_HADJUSTMENT:
942 g_value_set_object (value,
943 G_OBJECT (gtk_scrolled_window_get_hadjustment (scrolled_window)));
945 case PROP_VADJUSTMENT:
946 g_value_set_object (value,
947 G_OBJECT (gtk_scrolled_window_get_vadjustment (scrolled_window)));
949 case PROP_HSCROLLBAR_POLICY:
950 g_value_set_enum (value, scrolled_window->hscrollbar_policy);
952 case PROP_VSCROLLBAR_POLICY:
953 g_value_set_enum (value, scrolled_window->vscrollbar_policy);
955 case PROP_WINDOW_PLACEMENT:
956 g_value_set_enum (value, scrolled_window->window_placement);
958 case PROP_WINDOW_PLACEMENT_SET:
959 g_value_set_boolean (value, priv->window_placement_set);
961 case PROP_SHADOW_TYPE:
962 g_value_set_enum (value, scrolled_window->shadow_type);
965 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
971 traverse_container (GtkWidget *widget,
974 if (GTK_IS_SCROLLED_WINDOW (widget))
976 gtk_scrolled_window_update_real_placement (GTK_SCROLLED_WINDOW (widget));
977 gtk_widget_queue_resize (widget);
979 else if (GTK_IS_CONTAINER (widget))
980 gtk_container_forall (GTK_CONTAINER (widget), traverse_container, NULL);
984 gtk_scrolled_window_settings_changed (GtkSettings *settings)
988 list = gtk_window_list_toplevels ();
990 for (l = list; l; l = l->next)
991 gtk_container_forall (GTK_CONTAINER (l->data),
992 traverse_container, NULL);
998 gtk_scrolled_window_screen_changed (GtkWidget *widget,
999 GdkScreen *previous_screen)
1001 GtkSettings *settings;
1002 guint window_placement_connection;
1004 gtk_scrolled_window_update_real_placement (GTK_SCROLLED_WINDOW (widget));
1006 if (!gtk_widget_has_screen (widget))
1009 settings = gtk_widget_get_settings (widget);
1011 window_placement_connection =
1012 GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (settings),
1013 "gtk-scrolled-window-connection"));
1015 if (window_placement_connection)
1018 window_placement_connection =
1019 g_signal_connect (settings, "notify::gtk-scrolled-window-placement",
1020 G_CALLBACK (gtk_scrolled_window_settings_changed), NULL);
1021 g_object_set_data (G_OBJECT (settings),
1022 I_("gtk-scrolled-window-connection"),
1023 GUINT_TO_POINTER (window_placement_connection));
1027 gtk_scrolled_window_paint (GtkWidget *widget,
1030 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (widget);
1032 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1034 GtkAllocation relative_allocation;
1035 gboolean scrollbars_within_bevel;
1037 gtk_widget_style_get (widget, "scrollbars-within-bevel", &scrollbars_within_bevel, NULL);
1039 if (!scrollbars_within_bevel)
1041 gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
1043 relative_allocation.x -= widget->style->xthickness;
1044 relative_allocation.y -= widget->style->ythickness;
1045 relative_allocation.width += 2 * widget->style->xthickness;
1046 relative_allocation.height += 2 * widget->style->ythickness;
1050 GtkContainer *container = GTK_CONTAINER (widget);
1052 relative_allocation.x = container->border_width;
1053 relative_allocation.y = container->border_width;
1054 relative_allocation.width = widget->allocation.width - 2 * container->border_width;
1055 relative_allocation.height = widget->allocation.height - 2 * container->border_width;
1058 gtk_paint_shadow (widget->style, widget->window,
1059 GTK_STATE_NORMAL, scrolled_window->shadow_type,
1060 area, widget, "scrolled_window",
1061 widget->allocation.x + relative_allocation.x,
1062 widget->allocation.y + relative_allocation.y,
1063 relative_allocation.width,
1064 relative_allocation.height);
1069 gtk_scrolled_window_expose (GtkWidget *widget,
1070 GdkEventExpose *event)
1072 if (gtk_widget_is_drawable (widget))
1074 gtk_scrolled_window_paint (widget, &event->area);
1076 GTK_WIDGET_CLASS (gtk_scrolled_window_parent_class)->expose_event (widget, event);
1083 gtk_scrolled_window_forall (GtkContainer *container,
1084 gboolean include_internals,
1085 GtkCallback callback,
1086 gpointer callback_data)
1088 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (container));
1089 g_return_if_fail (callback != NULL);
1091 GTK_CONTAINER_CLASS (gtk_scrolled_window_parent_class)->forall (container,
1095 if (include_internals)
1097 GtkScrolledWindow *scrolled_window;
1099 scrolled_window = GTK_SCROLLED_WINDOW (container);
1101 if (scrolled_window->vscrollbar)
1102 callback (scrolled_window->vscrollbar, callback_data);
1103 if (scrolled_window->hscrollbar)
1104 callback (scrolled_window->hscrollbar, callback_data);
1109 gtk_scrolled_window_scroll_child (GtkScrolledWindow *scrolled_window,
1110 GtkScrollType scroll,
1111 gboolean horizontal)
1113 GtkAdjustment *adjustment = NULL;
1117 case GTK_SCROLL_STEP_UP:
1118 scroll = GTK_SCROLL_STEP_BACKWARD;
1121 case GTK_SCROLL_STEP_DOWN:
1122 scroll = GTK_SCROLL_STEP_FORWARD;
1125 case GTK_SCROLL_STEP_LEFT:
1126 scroll = GTK_SCROLL_STEP_BACKWARD;
1129 case GTK_SCROLL_STEP_RIGHT:
1130 scroll = GTK_SCROLL_STEP_FORWARD;
1133 case GTK_SCROLL_PAGE_UP:
1134 scroll = GTK_SCROLL_PAGE_BACKWARD;
1137 case GTK_SCROLL_PAGE_DOWN:
1138 scroll = GTK_SCROLL_PAGE_FORWARD;
1141 case GTK_SCROLL_PAGE_LEFT:
1142 scroll = GTK_SCROLL_STEP_BACKWARD;
1145 case GTK_SCROLL_PAGE_RIGHT:
1146 scroll = GTK_SCROLL_STEP_FORWARD;
1149 case GTK_SCROLL_STEP_BACKWARD:
1150 case GTK_SCROLL_STEP_FORWARD:
1151 case GTK_SCROLL_PAGE_BACKWARD:
1152 case GTK_SCROLL_PAGE_FORWARD:
1153 case GTK_SCROLL_START:
1154 case GTK_SCROLL_END:
1157 g_warning ("Invalid scroll type %u for GtkScrolledWindow::scroll-child", scroll);
1161 if ((horizontal && (!scrolled_window->hscrollbar || !scrolled_window->hscrollbar_visible)) ||
1162 (!horizontal && (!scrolled_window->vscrollbar || !scrolled_window->vscrollbar_visible)))
1167 if (scrolled_window->hscrollbar)
1168 adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
1172 if (scrolled_window->vscrollbar)
1173 adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
1178 gdouble value = adjustment->value;
1182 case GTK_SCROLL_STEP_FORWARD:
1183 value += adjustment->step_increment;
1185 case GTK_SCROLL_STEP_BACKWARD:
1186 value -= adjustment->step_increment;
1188 case GTK_SCROLL_PAGE_FORWARD:
1189 value += adjustment->page_increment;
1191 case GTK_SCROLL_PAGE_BACKWARD:
1192 value -= adjustment->page_increment;
1194 case GTK_SCROLL_START:
1195 value = adjustment->lower;
1197 case GTK_SCROLL_END:
1198 value = adjustment->upper;
1201 g_assert_not_reached ();
1205 value = CLAMP (value, adjustment->lower, adjustment->upper - adjustment->page_size);
1207 gtk_adjustment_set_value (adjustment, value);
1216 gtk_scrolled_window_move_focus_out (GtkScrolledWindow *scrolled_window,
1217 GtkDirectionType direction_type)
1219 GtkWidget *toplevel;
1221 /* Focus out of the scrolled window entirely. We do this by setting
1222 * a flag, then propagating the focus motion to the notebook.
1224 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (scrolled_window));
1225 if (!gtk_widget_is_toplevel (toplevel))
1228 g_object_ref (scrolled_window);
1230 scrolled_window->focus_out = TRUE;
1231 g_signal_emit_by_name (toplevel, "move-focus", direction_type);
1232 scrolled_window->focus_out = FALSE;
1234 g_object_unref (scrolled_window);
1238 gtk_scrolled_window_real_size_request (GtkWidget *widget,
1239 GtkRequisition *min_requisition,
1240 GtkRequisition *nat_requisition)
1242 GtkScrolledWindow *scrolled_window;
1246 gint scrollbar_spacing;
1247 GtkRequisition hscrollbar_requisition;
1248 GtkRequisition vscrollbar_requisition;
1249 GtkRequisition min_child_requisition;
1250 GtkRequisition nat_child_requisition;
1252 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (widget));
1254 scrolled_window = GTK_SCROLLED_WINDOW (widget);
1255 bin = GTK_BIN (scrolled_window);
1257 scrollbar_spacing = _gtk_scrolled_window_get_scrollbar_spacing (scrolled_window);
1261 min_requisition->width = 0;
1262 min_requisition->height = 0;
1263 nat_requisition->width = 0;
1264 nat_requisition->height = 0;
1266 gtk_widget_size_request (scrolled_window->hscrollbar,
1267 &hscrollbar_requisition);
1268 gtk_widget_size_request (scrolled_window->vscrollbar,
1269 &vscrollbar_requisition);
1271 if (bin->child && gtk_widget_get_visible (bin->child))
1273 gtk_extended_layout_get_desired_size (GTK_EXTENDED_LAYOUT (bin->child),
1274 &min_child_requisition,
1275 &nat_child_requisition);
1277 if (scrolled_window->hscrollbar_policy == GTK_POLICY_NEVER)
1279 min_requisition->width += min_child_requisition.width;
1280 nat_requisition->width += nat_child_requisition.width;
1284 GtkWidgetAuxInfo *aux_info = _gtk_widget_get_aux_info (bin->child, FALSE);
1286 if (aux_info && aux_info->width > 0)
1288 min_requisition->width += aux_info->width;
1289 nat_requisition->width += aux_info->width;
1294 min_requisition->width += vscrollbar_requisition.width;
1295 nat_requisition->width += vscrollbar_requisition.width;
1299 if (scrolled_window->vscrollbar_policy == GTK_POLICY_NEVER)
1301 min_requisition->height += min_child_requisition.height;
1302 nat_requisition->height += nat_child_requisition.height;
1306 GtkWidgetAuxInfo *aux_info = _gtk_widget_get_aux_info (bin->child, FALSE);
1308 if (aux_info && aux_info->height > 0)
1310 min_requisition->height += aux_info->height;
1311 nat_requisition->height += aux_info->height;
1316 min_requisition->height += hscrollbar_requisition.height;
1317 nat_requisition->height += hscrollbar_requisition.height;
1322 if (scrolled_window->hscrollbar_policy == GTK_POLICY_AUTOMATIC ||
1323 scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS)
1325 min_requisition->width = MAX (min_requisition->width, hscrollbar_requisition.width);
1326 nat_requisition->width = MAX (nat_requisition->width, hscrollbar_requisition.width);
1327 if (!extra_height || scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS)
1328 extra_height = scrollbar_spacing + hscrollbar_requisition.height;
1331 if (scrolled_window->vscrollbar_policy == GTK_POLICY_AUTOMATIC ||
1332 scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS)
1334 min_requisition->height = MAX (min_requisition->height, vscrollbar_requisition.height);
1335 nat_requisition->height = MAX (nat_requisition->height, vscrollbar_requisition.height);
1336 if (!extra_height || scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS)
1337 extra_width = scrollbar_spacing + vscrollbar_requisition.width;
1340 min_requisition->width += GTK_CONTAINER (widget)->border_width * 2 + MAX (0, extra_width);
1341 min_requisition->height += GTK_CONTAINER (widget)->border_width * 2 + MAX (0, extra_height);
1342 nat_requisition->width += GTK_CONTAINER (widget)->border_width * 2 + MAX (0, extra_width);
1343 nat_requisition->height += GTK_CONTAINER (widget)->border_width * 2 + MAX (0, extra_height);
1345 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1347 min_requisition->width += 2 * widget->style->xthickness;
1348 min_requisition->height += 2 * widget->style->ythickness;
1349 nat_requisition->width += 2 * widget->style->xthickness;
1350 nat_requisition->height += 2 * widget->style->ythickness;
1355 gtk_scrolled_window_size_request (GtkWidget *widget,
1356 GtkRequisition *requisition)
1358 GtkRequisition nat_req;
1360 gtk_scrolled_window_real_size_request (widget, requisition, &nat_req);
1364 gtk_scrolled_window_relative_allocation (GtkWidget *widget,
1365 GtkAllocation *allocation)
1367 GtkScrolledWindow *scrolled_window;
1368 GtkScrolledWindowPrivate *priv;
1369 gint scrollbar_spacing;
1371 g_return_if_fail (widget != NULL);
1372 g_return_if_fail (allocation != NULL);
1374 scrolled_window = GTK_SCROLLED_WINDOW (widget);
1375 scrollbar_spacing = _gtk_scrolled_window_get_scrollbar_spacing (scrolled_window);
1377 priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
1379 allocation->x = GTK_CONTAINER (widget)->border_width;
1380 allocation->y = GTK_CONTAINER (widget)->border_width;
1382 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1384 allocation->x += widget->style->xthickness;
1385 allocation->y += widget->style->ythickness;
1388 allocation->width = MAX (1, (gint)widget->allocation.width - allocation->x * 2);
1389 allocation->height = MAX (1, (gint)widget->allocation.height - allocation->y * 2);
1391 if (scrolled_window->vscrollbar_visible)
1393 GtkRequisition vscrollbar_requisition;
1396 gtk_widget_get_child_requisition (scrolled_window->vscrollbar,
1397 &vscrollbar_requisition);
1398 is_rtl = gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL;
1401 (priv->real_window_placement == GTK_CORNER_TOP_RIGHT ||
1402 priv->real_window_placement == GTK_CORNER_BOTTOM_RIGHT)) ||
1404 (priv->real_window_placement == GTK_CORNER_TOP_LEFT ||
1405 priv->real_window_placement == GTK_CORNER_BOTTOM_LEFT)))
1406 allocation->x += (vscrollbar_requisition.width + scrollbar_spacing);
1408 allocation->width = MAX (1, allocation->width - (vscrollbar_requisition.width + scrollbar_spacing));
1410 if (scrolled_window->hscrollbar_visible)
1412 GtkRequisition hscrollbar_requisition;
1413 gtk_widget_get_child_requisition (scrolled_window->hscrollbar,
1414 &hscrollbar_requisition);
1416 if (priv->real_window_placement == GTK_CORNER_BOTTOM_LEFT ||
1417 priv->real_window_placement == GTK_CORNER_BOTTOM_RIGHT)
1418 allocation->y += (hscrollbar_requisition.height + scrollbar_spacing);
1420 allocation->height = MAX (1, allocation->height - (hscrollbar_requisition.height + scrollbar_spacing));
1425 gtk_scrolled_window_size_allocate (GtkWidget *widget,
1426 GtkAllocation *allocation)
1428 GtkScrolledWindow *scrolled_window;
1429 GtkScrolledWindowPrivate *priv;
1431 GtkAllocation relative_allocation;
1432 GtkAllocation child_allocation;
1433 gboolean scrollbars_within_bevel;
1434 gint scrollbar_spacing;
1436 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (widget));
1437 g_return_if_fail (allocation != NULL);
1439 scrolled_window = GTK_SCROLLED_WINDOW (widget);
1440 bin = GTK_BIN (scrolled_window);
1442 scrollbar_spacing = _gtk_scrolled_window_get_scrollbar_spacing (scrolled_window);
1443 gtk_widget_style_get (widget, "scrollbars-within-bevel", &scrollbars_within_bevel, NULL);
1445 priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
1447 widget->allocation = *allocation;
1449 if (scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS)
1450 scrolled_window->hscrollbar_visible = TRUE;
1451 else if (scrolled_window->hscrollbar_policy == GTK_POLICY_NEVER)
1452 scrolled_window->hscrollbar_visible = FALSE;
1453 if (scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS)
1454 scrolled_window->vscrollbar_visible = TRUE;
1455 else if (scrolled_window->vscrollbar_policy == GTK_POLICY_NEVER)
1456 scrolled_window->vscrollbar_visible = FALSE;
1458 if (bin->child && gtk_widget_get_visible (bin->child))
1460 gboolean previous_hvis;
1461 gboolean previous_vvis;
1466 gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
1468 child_allocation.x = relative_allocation.x + allocation->x;
1469 child_allocation.y = relative_allocation.y + allocation->y;
1470 child_allocation.width = relative_allocation.width;
1471 child_allocation.height = relative_allocation.height;
1473 previous_hvis = scrolled_window->hscrollbar_visible;
1474 previous_vvis = scrolled_window->vscrollbar_visible;
1476 gtk_widget_size_allocate (bin->child, &child_allocation);
1478 /* If, after the first iteration, the hscrollbar and the
1479 * vscrollbar flip visiblity, then we need both.
1482 previous_hvis != scrolled_window->hscrollbar_visible &&
1483 previous_vvis != scrolled_window->vscrollbar_visible)
1485 scrolled_window->hscrollbar_visible = TRUE;
1486 scrolled_window->vscrollbar_visible = TRUE;
1488 /* a new resize is already queued at this point,
1489 * so we will immediatedly get reinvoked
1496 while (previous_hvis != scrolled_window->hscrollbar_visible ||
1497 previous_vvis != scrolled_window->vscrollbar_visible);
1501 scrolled_window->hscrollbar_visible = scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS;
1502 scrolled_window->vscrollbar_visible = scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS;
1503 gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
1506 if (scrolled_window->hscrollbar_visible)
1508 GtkRequisition hscrollbar_requisition;
1509 gtk_widget_get_child_requisition (scrolled_window->hscrollbar,
1510 &hscrollbar_requisition);
1512 if (!gtk_widget_get_visible (scrolled_window->hscrollbar))
1513 gtk_widget_show (scrolled_window->hscrollbar);
1515 child_allocation.x = relative_allocation.x;
1516 if (priv->real_window_placement == GTK_CORNER_TOP_LEFT ||
1517 priv->real_window_placement == GTK_CORNER_TOP_RIGHT)
1518 child_allocation.y = (relative_allocation.y +
1519 relative_allocation.height +
1521 (scrolled_window->shadow_type == GTK_SHADOW_NONE ?
1522 0 : widget->style->ythickness));
1524 child_allocation.y = GTK_CONTAINER (scrolled_window)->border_width;
1526 child_allocation.width = relative_allocation.width;
1527 child_allocation.height = hscrollbar_requisition.height;
1528 child_allocation.x += allocation->x;
1529 child_allocation.y += allocation->y;
1531 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1533 if (!scrollbars_within_bevel)
1535 child_allocation.x -= widget->style->xthickness;
1536 child_allocation.width += 2 * widget->style->xthickness;
1538 else if (GTK_CORNER_TOP_RIGHT == priv->real_window_placement ||
1539 GTK_CORNER_TOP_LEFT == priv->real_window_placement)
1541 child_allocation.y -= widget->style->ythickness;
1545 child_allocation.y += widget->style->ythickness;
1549 gtk_widget_size_allocate (scrolled_window->hscrollbar, &child_allocation);
1551 else if (gtk_widget_get_visible (scrolled_window->hscrollbar))
1552 gtk_widget_hide (scrolled_window->hscrollbar);
1554 if (scrolled_window->vscrollbar_visible)
1556 GtkRequisition vscrollbar_requisition;
1557 if (!gtk_widget_get_visible (scrolled_window->vscrollbar))
1558 gtk_widget_show (scrolled_window->vscrollbar);
1560 gtk_widget_get_child_requisition (scrolled_window->vscrollbar,
1561 &vscrollbar_requisition);
1563 if ((gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL &&
1564 (priv->real_window_placement == GTK_CORNER_TOP_RIGHT ||
1565 priv->real_window_placement == GTK_CORNER_BOTTOM_RIGHT)) ||
1566 (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR &&
1567 (priv->real_window_placement == GTK_CORNER_TOP_LEFT ||
1568 priv->real_window_placement == GTK_CORNER_BOTTOM_LEFT)))
1569 child_allocation.x = (relative_allocation.x +
1570 relative_allocation.width +
1572 (scrolled_window->shadow_type == GTK_SHADOW_NONE ?
1573 0 : widget->style->xthickness));
1575 child_allocation.x = GTK_CONTAINER (scrolled_window)->border_width;
1577 child_allocation.y = relative_allocation.y;
1578 child_allocation.width = vscrollbar_requisition.width;
1579 child_allocation.height = relative_allocation.height;
1580 child_allocation.x += allocation->x;
1581 child_allocation.y += allocation->y;
1583 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1585 if (!scrollbars_within_bevel)
1587 child_allocation.y -= widget->style->ythickness;
1588 child_allocation.height += 2 * widget->style->ythickness;
1590 else if (GTK_CORNER_BOTTOM_LEFT == priv->real_window_placement ||
1591 GTK_CORNER_TOP_LEFT == priv->real_window_placement)
1593 child_allocation.x -= widget->style->xthickness;
1597 child_allocation.x += widget->style->xthickness;
1601 gtk_widget_size_allocate (scrolled_window->vscrollbar, &child_allocation);
1603 else if (gtk_widget_get_visible (scrolled_window->vscrollbar))
1604 gtk_widget_hide (scrolled_window->vscrollbar);
1608 gtk_scrolled_window_scroll_event (GtkWidget *widget,
1609 GdkEventScroll *event)
1613 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (widget), FALSE);
1614 g_return_val_if_fail (event != NULL, FALSE);
1616 if (event->direction == GDK_SCROLL_UP || event->direction == GDK_SCROLL_DOWN)
1617 range = GTK_SCROLLED_WINDOW (widget)->vscrollbar;
1619 range = GTK_SCROLLED_WINDOW (widget)->hscrollbar;
1621 if (range && gtk_widget_get_visible (range))
1623 GtkAdjustment *adj = GTK_RANGE (range)->adjustment;
1624 gdouble delta, new_value;
1626 delta = _gtk_range_get_wheel_delta (GTK_RANGE (range), event->direction);
1628 new_value = CLAMP (adj->value + delta, adj->lower, adj->upper - adj->page_size);
1630 gtk_adjustment_set_value (adj, new_value);
1639 gtk_scrolled_window_focus (GtkWidget *widget,
1640 GtkDirectionType direction)
1642 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (widget);
1643 gboolean had_focus_child = GTK_CONTAINER (widget)->focus_child != NULL;
1645 if (scrolled_window->focus_out)
1647 scrolled_window->focus_out = FALSE; /* Clear this to catch the wrap-around case */
1651 if (gtk_widget_is_focus (widget))
1654 /* We only put the scrolled window itself in the focus chain if it
1655 * isn't possible to focus any children.
1657 if (GTK_BIN (widget)->child)
1659 if (gtk_widget_child_focus (GTK_BIN (widget)->child, direction))
1663 if (!had_focus_child && gtk_widget_get_can_focus (widget))
1665 gtk_widget_grab_focus (widget);
1673 gtk_scrolled_window_adjustment_changed (GtkAdjustment *adjustment,
1676 GtkScrolledWindow *scrolled_win;
1678 g_return_if_fail (adjustment != NULL);
1679 g_return_if_fail (data != NULL);
1681 scrolled_win = GTK_SCROLLED_WINDOW (data);
1683 if (scrolled_win->hscrollbar &&
1684 adjustment == gtk_range_get_adjustment (GTK_RANGE (scrolled_win->hscrollbar)))
1686 if (scrolled_win->hscrollbar_policy == GTK_POLICY_AUTOMATIC)
1690 visible = scrolled_win->hscrollbar_visible;
1691 scrolled_win->hscrollbar_visible = (adjustment->upper - adjustment->lower >
1692 adjustment->page_size);
1693 if (scrolled_win->hscrollbar_visible != visible)
1694 gtk_widget_queue_resize (GTK_WIDGET (scrolled_win));
1697 else if (scrolled_win->vscrollbar &&
1698 adjustment == gtk_range_get_adjustment (GTK_RANGE (scrolled_win->vscrollbar)))
1700 if (scrolled_win->vscrollbar_policy == GTK_POLICY_AUTOMATIC)
1704 visible = scrolled_win->vscrollbar_visible;
1705 scrolled_win->vscrollbar_visible = (adjustment->upper - adjustment->lower >
1706 adjustment->page_size);
1707 if (scrolled_win->vscrollbar_visible != visible)
1708 gtk_widget_queue_resize (GTK_WIDGET (scrolled_win));
1714 gtk_scrolled_window_add (GtkContainer *container,
1717 GtkScrolledWindow *scrolled_window;
1720 bin = GTK_BIN (container);
1721 g_return_if_fail (bin->child == NULL);
1723 scrolled_window = GTK_SCROLLED_WINDOW (container);
1726 gtk_widget_set_parent (child, GTK_WIDGET (bin));
1728 /* this is a temporary message */
1729 if (!gtk_widget_set_scroll_adjustments (child,
1730 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
1731 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar))))
1732 g_warning ("gtk_scrolled_window_add(): cannot add non scrollable widget "
1733 "use gtk_scrolled_window_add_with_viewport() instead");
1737 gtk_scrolled_window_remove (GtkContainer *container,
1740 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (container));
1741 g_return_if_fail (child != NULL);
1742 g_return_if_fail (GTK_BIN (container)->child == child);
1744 gtk_widget_set_scroll_adjustments (child, NULL, NULL);
1746 /* chain parent class handler to remove child */
1747 GTK_CONTAINER_CLASS (gtk_scrolled_window_parent_class)->remove (container, child);
1751 * gtk_scrolled_window_add_with_viewport:
1752 * @scrolled_window: a #GtkScrolledWindow
1753 * @child: the widget you want to scroll
1755 * Used to add children without native scrolling capabilities. This
1756 * is simply a convenience function; it is equivalent to adding the
1757 * unscrollable child to a viewport, then adding the viewport to the
1758 * scrolled window. If a child has native scrolling, use
1759 * gtk_container_add() instead of this function.
1761 * The viewport scrolls the child by moving its #GdkWindow, and takes
1762 * the size of the child to be the size of its toplevel #GdkWindow.
1763 * This will be very wrong for most widgets that support native scrolling;
1764 * for example, if you add a widget such as #GtkTreeView with a viewport,
1765 * the whole widget will scroll, including the column headings. Thus,
1766 * widgets with native scrolling support should not be used with the
1767 * #GtkViewport proxy.
1769 * A widget supports scrolling natively if the
1770 * set_scroll_adjustments_signal field in #GtkWidgetClass is non-zero,
1771 * i.e. has been filled in with a valid signal identifier.
1774 gtk_scrolled_window_add_with_viewport (GtkScrolledWindow *scrolled_window,
1778 GtkWidget *viewport;
1780 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
1781 g_return_if_fail (GTK_IS_WIDGET (child));
1782 g_return_if_fail (child->parent == NULL);
1784 bin = GTK_BIN (scrolled_window);
1786 if (bin->child != NULL)
1788 g_return_if_fail (GTK_IS_VIEWPORT (bin->child));
1789 g_return_if_fail (GTK_BIN (bin->child)->child == NULL);
1791 viewport = bin->child;
1796 gtk_viewport_new (gtk_scrolled_window_get_hadjustment (scrolled_window),
1797 gtk_scrolled_window_get_vadjustment (scrolled_window));
1798 gtk_container_add (GTK_CONTAINER (scrolled_window), viewport);
1801 gtk_widget_show (viewport);
1802 gtk_container_add (GTK_CONTAINER (viewport), child);
1806 * _gtk_scrolled_window_get_spacing:
1807 * @scrolled_window: a scrolled window
1809 * Gets the spacing between the scrolled window's scrollbars and
1810 * the scrolled widget. Used by GtkCombo
1812 * Return value: the spacing, in pixels.
1815 _gtk_scrolled_window_get_scrollbar_spacing (GtkScrolledWindow *scrolled_window)
1817 GtkScrolledWindowClass *class;
1819 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), 0);
1821 class = GTK_SCROLLED_WINDOW_GET_CLASS (scrolled_window);
1823 if (class->scrollbar_spacing >= 0)
1824 return class->scrollbar_spacing;
1827 gint scrollbar_spacing;
1829 gtk_widget_style_get (GTK_WIDGET (scrolled_window),
1830 "scrollbar-spacing", &scrollbar_spacing,
1833 return scrollbar_spacing;
1838 gtk_scrolled_window_extended_layout_get_desired_size (GtkExtendedLayout *layout,
1839 GtkRequisition *minimal_size,
1840 GtkRequisition *natural_size)
1842 GtkRequisition min_req, nat_req;
1844 gtk_scrolled_window_real_size_request (GTK_WIDGET (layout), &min_req, &nat_req);
1847 *minimal_size = min_req;
1850 *natural_size = nat_req;
1854 gtk_scrolled_window_extended_layout_init (GtkExtendedLayoutIface *iface)
1856 iface->get_desired_size = gtk_scrolled_window_extended_layout_get_desired_size;
1859 #define __GTK_SCROLLED_WINDOW_C__
1860 #include "gtkaliasdef.c"