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_allocate (GtkWidget *widget,
118 GtkAllocation *allocation);
119 static gboolean gtk_scrolled_window_scroll_event (GtkWidget *widget,
120 GdkEventScroll *event);
121 static gboolean gtk_scrolled_window_focus (GtkWidget *widget,
122 GtkDirectionType direction);
123 static void gtk_scrolled_window_add (GtkContainer *container,
125 static void gtk_scrolled_window_remove (GtkContainer *container,
127 static void gtk_scrolled_window_forall (GtkContainer *container,
128 gboolean include_internals,
129 GtkCallback callback,
130 gpointer callback_data);
131 static gboolean gtk_scrolled_window_scroll_child (GtkScrolledWindow *scrolled_window,
132 GtkScrollType scroll,
133 gboolean horizontal);
134 static void gtk_scrolled_window_move_focus_out (GtkScrolledWindow *scrolled_window,
135 GtkDirectionType direction_type);
137 static void gtk_scrolled_window_relative_allocation(GtkWidget *widget,
138 GtkAllocation *allocation);
139 static void gtk_scrolled_window_adjustment_changed (GtkAdjustment *adjustment,
142 static void gtk_scrolled_window_update_real_placement (GtkScrolledWindow *scrolled_window);
144 static void gtk_scrolled_window_extended_layout_init (GtkExtendedLayoutIface *iface);
145 static void gtk_scrolled_window_get_desired_width (GtkExtendedLayout *layout,
148 static void gtk_scrolled_window_get_desired_height (GtkExtendedLayout *layout,
151 static void gtk_scrolled_window_get_height_for_width (GtkExtendedLayout *layout,
153 gint *minimum_height,
154 gint *natural_height);
155 static void gtk_scrolled_window_get_width_for_height (GtkExtendedLayout *layout,
157 gint *minimum_height,
158 gint *natural_height);
160 static guint signals[LAST_SIGNAL] = {0};
162 G_DEFINE_TYPE_WITH_CODE (GtkScrolledWindow, gtk_scrolled_window, GTK_TYPE_BIN,
163 G_IMPLEMENT_INTERFACE (GTK_TYPE_EXTENDED_LAYOUT,
164 gtk_scrolled_window_extended_layout_init))
168 add_scroll_binding (GtkBindingSet *binding_set,
170 GdkModifierType mask,
171 GtkScrollType scroll,
174 guint keypad_keyval = keyval - GDK_Left + GDK_KP_Left;
176 gtk_binding_entry_add_signal (binding_set, keyval, mask,
178 GTK_TYPE_SCROLL_TYPE, scroll,
179 G_TYPE_BOOLEAN, horizontal);
180 gtk_binding_entry_add_signal (binding_set, keypad_keyval, mask,
182 GTK_TYPE_SCROLL_TYPE, scroll,
183 G_TYPE_BOOLEAN, horizontal);
187 add_tab_bindings (GtkBindingSet *binding_set,
188 GdkModifierType modifiers,
189 GtkDirectionType direction)
191 gtk_binding_entry_add_signal (binding_set, GDK_Tab, modifiers,
193 GTK_TYPE_DIRECTION_TYPE, direction);
194 gtk_binding_entry_add_signal (binding_set, GDK_KP_Tab, modifiers,
196 GTK_TYPE_DIRECTION_TYPE, direction);
200 gtk_scrolled_window_class_init (GtkScrolledWindowClass *class)
202 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
203 GtkObjectClass *object_class;
204 GtkWidgetClass *widget_class;
205 GtkContainerClass *container_class;
206 GtkBindingSet *binding_set;
208 object_class = (GtkObjectClass*) class;
209 widget_class = (GtkWidgetClass*) class;
210 container_class = (GtkContainerClass*) class;
212 gobject_class->set_property = gtk_scrolled_window_set_property;
213 gobject_class->get_property = gtk_scrolled_window_get_property;
215 object_class->destroy = gtk_scrolled_window_destroy;
217 widget_class->screen_changed = gtk_scrolled_window_screen_changed;
218 widget_class->expose_event = gtk_scrolled_window_expose;
219 widget_class->size_allocate = gtk_scrolled_window_size_allocate;
220 widget_class->scroll_event = gtk_scrolled_window_scroll_event;
221 widget_class->focus = gtk_scrolled_window_focus;
223 container_class->add = gtk_scrolled_window_add;
224 container_class->remove = gtk_scrolled_window_remove;
225 container_class->forall = gtk_scrolled_window_forall;
227 class->scrollbar_spacing = -1;
229 class->scroll_child = gtk_scrolled_window_scroll_child;
230 class->move_focus_out = gtk_scrolled_window_move_focus_out;
232 g_object_class_install_property (gobject_class,
234 g_param_spec_object ("hadjustment",
235 P_("Horizontal Adjustment"),
236 P_("The GtkAdjustment for the horizontal position"),
238 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
239 g_object_class_install_property (gobject_class,
241 g_param_spec_object ("vadjustment",
242 P_("Vertical Adjustment"),
243 P_("The GtkAdjustment for the vertical position"),
245 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
246 g_object_class_install_property (gobject_class,
247 PROP_HSCROLLBAR_POLICY,
248 g_param_spec_enum ("hscrollbar-policy",
249 P_("Horizontal Scrollbar Policy"),
250 P_("When the horizontal scrollbar is displayed"),
251 GTK_TYPE_POLICY_TYPE,
253 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
254 g_object_class_install_property (gobject_class,
255 PROP_VSCROLLBAR_POLICY,
256 g_param_spec_enum ("vscrollbar-policy",
257 P_("Vertical Scrollbar Policy"),
258 P_("When the vertical scrollbar is displayed"),
259 GTK_TYPE_POLICY_TYPE,
261 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
263 g_object_class_install_property (gobject_class,
264 PROP_WINDOW_PLACEMENT,
265 g_param_spec_enum ("window-placement",
266 P_("Window Placement"),
267 P_("Where the contents are located with respect to the scrollbars. This property only takes effect if \"window-placement-set\" is TRUE."),
268 GTK_TYPE_CORNER_TYPE,
270 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
273 * GtkScrolledWindow:window-placement-set:
275 * Whether "window-placement" should be used to determine the location
276 * of the contents with respect to the scrollbars. Otherwise, the
277 * "gtk-scrolled-window-placement" setting is used.
281 g_object_class_install_property (gobject_class,
282 PROP_WINDOW_PLACEMENT_SET,
283 g_param_spec_boolean ("window-placement-set",
284 P_("Window Placement Set"),
285 P_("Whether \"window-placement\" should be used to determine the location of the contents with respect to the scrollbars."),
287 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
288 g_object_class_install_property (gobject_class,
290 g_param_spec_enum ("shadow-type",
292 P_("Style of bevel around the contents"),
293 GTK_TYPE_SHADOW_TYPE,
295 GTK_PARAM_READABLE | GTK_PARAM_WRITABLE));
298 * GtkScrolledWindow:scrollbars-within-bevel:
300 * Whether to place scrollbars within the scrolled window's bevel.
304 gtk_widget_class_install_style_property (widget_class,
305 g_param_spec_boolean ("scrollbars-within-bevel",
306 P_("Scrollbars within bevel"),
307 P_("Place scrollbars within the scrolled window's bevel"),
309 GTK_PARAM_READABLE));
311 gtk_widget_class_install_style_property (widget_class,
312 g_param_spec_int ("scrollbar-spacing",
313 P_("Scrollbar spacing"),
314 P_("Number of pixels between the scrollbars and the scrolled window"),
317 DEFAULT_SCROLLBAR_SPACING,
318 GTK_PARAM_READABLE));
321 * GtkSettings:gtk-scrolled-window-placement:
323 * Where the contents of scrolled windows are located with respect to the
324 * scrollbars, if not overridden by the scrolled window's own placement.
328 gtk_settings_install_property (g_param_spec_enum ("gtk-scrolled-window-placement",
329 P_("Scrolled Window Placement"),
330 P_("Where the contents of scrolled windows are located with respect to the scrollbars, if not overridden by the scrolled window's own placement."),
331 GTK_TYPE_CORNER_TYPE,
333 G_PARAM_READABLE | G_PARAM_WRITABLE));
336 signals[SCROLL_CHILD] =
337 g_signal_new (I_("scroll-child"),
338 G_TYPE_FROM_CLASS (object_class),
339 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
340 G_STRUCT_OFFSET (GtkScrolledWindowClass, scroll_child),
342 _gtk_marshal_BOOLEAN__ENUM_BOOLEAN,
344 GTK_TYPE_SCROLL_TYPE,
346 signals[MOVE_FOCUS_OUT] =
347 g_signal_new (I_("move-focus-out"),
348 G_TYPE_FROM_CLASS (object_class),
349 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
350 G_STRUCT_OFFSET (GtkScrolledWindowClass, move_focus_out),
352 _gtk_marshal_VOID__ENUM,
354 GTK_TYPE_DIRECTION_TYPE);
356 binding_set = gtk_binding_set_by_class (class);
358 add_scroll_binding (binding_set, GDK_Left, GDK_CONTROL_MASK, GTK_SCROLL_STEP_BACKWARD, TRUE);
359 add_scroll_binding (binding_set, GDK_Right, GDK_CONTROL_MASK, GTK_SCROLL_STEP_FORWARD, TRUE);
360 add_scroll_binding (binding_set, GDK_Up, GDK_CONTROL_MASK, GTK_SCROLL_STEP_BACKWARD, FALSE);
361 add_scroll_binding (binding_set, GDK_Down, GDK_CONTROL_MASK, GTK_SCROLL_STEP_FORWARD, FALSE);
363 add_scroll_binding (binding_set, GDK_Page_Up, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_BACKWARD, TRUE);
364 add_scroll_binding (binding_set, GDK_Page_Down, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_FORWARD, TRUE);
365 add_scroll_binding (binding_set, GDK_Page_Up, 0, GTK_SCROLL_PAGE_BACKWARD, FALSE);
366 add_scroll_binding (binding_set, GDK_Page_Down, 0, GTK_SCROLL_PAGE_FORWARD, FALSE);
368 add_scroll_binding (binding_set, GDK_Home, GDK_CONTROL_MASK, GTK_SCROLL_START, TRUE);
369 add_scroll_binding (binding_set, GDK_End, GDK_CONTROL_MASK, GTK_SCROLL_END, TRUE);
370 add_scroll_binding (binding_set, GDK_Home, 0, GTK_SCROLL_START, FALSE);
371 add_scroll_binding (binding_set, GDK_End, 0, GTK_SCROLL_END, FALSE);
373 add_tab_bindings (binding_set, GDK_CONTROL_MASK, GTK_DIR_TAB_FORWARD);
374 add_tab_bindings (binding_set, GDK_CONTROL_MASK | GDK_SHIFT_MASK, GTK_DIR_TAB_BACKWARD);
376 g_type_class_add_private (class, sizeof (GtkScrolledWindowPrivate));
380 gtk_scrolled_window_init (GtkScrolledWindow *scrolled_window)
382 gtk_widget_set_has_window (GTK_WIDGET (scrolled_window), FALSE);
383 gtk_widget_set_can_focus (GTK_WIDGET (scrolled_window), TRUE);
385 scrolled_window->hscrollbar = NULL;
386 scrolled_window->vscrollbar = NULL;
387 scrolled_window->hscrollbar_policy = GTK_POLICY_ALWAYS;
388 scrolled_window->vscrollbar_policy = GTK_POLICY_ALWAYS;
389 scrolled_window->hscrollbar_visible = FALSE;
390 scrolled_window->vscrollbar_visible = FALSE;
391 scrolled_window->focus_out = FALSE;
392 scrolled_window->window_placement = GTK_CORNER_TOP_LEFT;
393 gtk_scrolled_window_update_real_placement (scrolled_window);
397 * gtk_scrolled_window_new:
398 * @hadjustment: (allow-none): horizontal adjustment
399 * @vadjustment: (allow-none): vertical adjustment
402 * Creates a new scrolled window.
406 * Creates a new scrolled window.
408 >>>>>>> native-layout-incubator
409 * The two arguments are the scrolled window's adjustments; these will be
410 * shared with the scrollbars and the child widget to keep the bars in sync
411 * with the child. Usually you want to pass %NULL for the adjustments, which
412 * will cause the scrolled window to create them for you.
414 * Returns: a new scrolled window
417 gtk_scrolled_window_new (GtkAdjustment *hadjustment,
418 GtkAdjustment *vadjustment)
420 GtkWidget *scrolled_window;
423 g_return_val_if_fail (GTK_IS_ADJUSTMENT (hadjustment), NULL);
426 g_return_val_if_fail (GTK_IS_ADJUSTMENT (vadjustment), NULL);
428 scrolled_window = g_object_new (GTK_TYPE_SCROLLED_WINDOW,
429 "hadjustment", hadjustment,
430 "vadjustment", vadjustment,
433 return scrolled_window;
437 * gtk_scrolled_window_set_hadjustment:
438 * @scrolled_window: a #GtkScrolledWindow
439 * @hadjustment: horizontal scroll adjustment
441 * Sets the #GtkAdjustment for the horizontal scrollbar.
444 gtk_scrolled_window_set_hadjustment (GtkScrolledWindow *scrolled_window,
445 GtkAdjustment *hadjustment)
449 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
451 g_return_if_fail (GTK_IS_ADJUSTMENT (hadjustment));
453 hadjustment = (GtkAdjustment*) g_object_new (GTK_TYPE_ADJUSTMENT, NULL);
455 bin = GTK_BIN (scrolled_window);
457 if (!scrolled_window->hscrollbar)
459 gtk_widget_push_composite_child ();
460 scrolled_window->hscrollbar = gtk_hscrollbar_new (hadjustment);
461 gtk_widget_set_composite_name (scrolled_window->hscrollbar, "hscrollbar");
462 gtk_widget_pop_composite_child ();
464 gtk_widget_set_parent (scrolled_window->hscrollbar, GTK_WIDGET (scrolled_window));
465 g_object_ref (scrolled_window->hscrollbar);
466 gtk_widget_show (scrolled_window->hscrollbar);
470 GtkAdjustment *old_adjustment;
472 old_adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
473 if (old_adjustment == hadjustment)
476 g_signal_handlers_disconnect_by_func (old_adjustment,
477 gtk_scrolled_window_adjustment_changed,
479 gtk_range_set_adjustment (GTK_RANGE (scrolled_window->hscrollbar),
482 hadjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
483 g_signal_connect (hadjustment,
485 G_CALLBACK (gtk_scrolled_window_adjustment_changed),
487 gtk_scrolled_window_adjustment_changed (hadjustment, scrolled_window);
490 gtk_widget_set_scroll_adjustments (bin->child,
491 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
492 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)));
494 g_object_notify (G_OBJECT (scrolled_window), "hadjustment");
498 * gtk_scrolled_window_set_vadjustment:
499 * @scrolled_window: a #GtkScrolledWindow
500 * @vadjustment: vertical scroll adjustment
502 * Sets the #GtkAdjustment for the vertical scrollbar.
505 gtk_scrolled_window_set_vadjustment (GtkScrolledWindow *scrolled_window,
506 GtkAdjustment *vadjustment)
510 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
512 g_return_if_fail (GTK_IS_ADJUSTMENT (vadjustment));
514 vadjustment = (GtkAdjustment*) g_object_new (GTK_TYPE_ADJUSTMENT, NULL);
516 bin = GTK_BIN (scrolled_window);
518 if (!scrolled_window->vscrollbar)
520 gtk_widget_push_composite_child ();
521 scrolled_window->vscrollbar = gtk_vscrollbar_new (vadjustment);
522 gtk_widget_set_composite_name (scrolled_window->vscrollbar, "vscrollbar");
523 gtk_widget_pop_composite_child ();
525 gtk_widget_set_parent (scrolled_window->vscrollbar, GTK_WIDGET (scrolled_window));
526 g_object_ref (scrolled_window->vscrollbar);
527 gtk_widget_show (scrolled_window->vscrollbar);
531 GtkAdjustment *old_adjustment;
533 old_adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
534 if (old_adjustment == vadjustment)
537 g_signal_handlers_disconnect_by_func (old_adjustment,
538 gtk_scrolled_window_adjustment_changed,
540 gtk_range_set_adjustment (GTK_RANGE (scrolled_window->vscrollbar),
543 vadjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
544 g_signal_connect (vadjustment,
546 G_CALLBACK (gtk_scrolled_window_adjustment_changed),
548 gtk_scrolled_window_adjustment_changed (vadjustment, scrolled_window);
551 gtk_widget_set_scroll_adjustments (bin->child,
552 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
553 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)));
555 g_object_notify (G_OBJECT (scrolled_window), "vadjustment");
559 * gtk_scrolled_window_get_hadjustment:
560 * @scrolled_window: a #GtkScrolledWindow
562 * Returns the horizontal scrollbar's adjustment, used to connect the
563 * horizontal scrollbar to the child widget's horizontal scroll
566 * Returns: the horizontal #GtkAdjustment
569 gtk_scrolled_window_get_hadjustment (GtkScrolledWindow *scrolled_window)
571 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
573 return (scrolled_window->hscrollbar ?
574 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)) :
579 * gtk_scrolled_window_get_vadjustment:
580 * @scrolled_window: a #GtkScrolledWindow
582 * Returns the vertical scrollbar's adjustment, used to connect the
583 * vertical scrollbar to the child widget's vertical scroll
586 * Returns: the vertical #GtkAdjustment
589 gtk_scrolled_window_get_vadjustment (GtkScrolledWindow *scrolled_window)
591 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
593 return (scrolled_window->vscrollbar ?
594 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)) :
599 * gtk_scrolled_window_get_hscrollbar:
600 * @scrolled_window: a #GtkScrolledWindow
602 * Returns the horizontal scrollbar of @scrolled_window.
604 * Returns: the horizontal scrollbar of the scrolled window, or
605 * %NULL if it does not have one.
610 gtk_scrolled_window_get_hscrollbar (GtkScrolledWindow *scrolled_window)
612 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
614 return scrolled_window->hscrollbar;
618 * gtk_scrolled_window_get_vscrollbar:
619 * @scrolled_window: a #GtkScrolledWindow
621 * Returns the vertical scrollbar of @scrolled_window.
623 * Returns: the vertical scrollbar of the scrolled window, or
624 * %NULL if it does not have one.
629 gtk_scrolled_window_get_vscrollbar (GtkScrolledWindow *scrolled_window)
631 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
633 return scrolled_window->vscrollbar;
637 * gtk_scrolled_window_set_policy:
638 * @scrolled_window: a #GtkScrolledWindow
639 * @hscrollbar_policy: policy for horizontal bar
640 * @vscrollbar_policy: policy for vertical bar
642 * Sets the scrollbar policy for the horizontal and vertical scrollbars.
644 * The policy determines when the scrollbar should appear; it is a value
645 * from the #GtkPolicyType enumeration. If %GTK_POLICY_ALWAYS, the
646 * scrollbar is always present; if %GTK_POLICY_NEVER, the scrollbar is
647 * never present; if %GTK_POLICY_AUTOMATIC, the scrollbar is present only
648 * if needed (that is, if the slider part of the bar would be smaller
649 * than the trough - the display is larger than the page size).
652 gtk_scrolled_window_set_policy (GtkScrolledWindow *scrolled_window,
653 GtkPolicyType hscrollbar_policy,
654 GtkPolicyType vscrollbar_policy)
656 GObject *object = G_OBJECT (scrolled_window);
658 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
660 if ((scrolled_window->hscrollbar_policy != hscrollbar_policy) ||
661 (scrolled_window->vscrollbar_policy != vscrollbar_policy))
663 scrolled_window->hscrollbar_policy = hscrollbar_policy;
664 scrolled_window->vscrollbar_policy = vscrollbar_policy;
666 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
668 g_object_freeze_notify (object);
669 g_object_notify (object, "hscrollbar-policy");
670 g_object_notify (object, "vscrollbar-policy");
671 g_object_thaw_notify (object);
676 * gtk_scrolled_window_get_policy:
677 * @scrolled_window: a #GtkScrolledWindow
678 * @hscrollbar_policy: location to store the policy for the horizontal
679 * scrollbar, or %NULL.
680 * @vscrollbar_policy: location to store the policy for the vertical
681 * scrollbar, or %NULL.
683 * Retrieves the current policy values for the horizontal and vertical
684 * scrollbars. See gtk_scrolled_window_set_policy().
687 gtk_scrolled_window_get_policy (GtkScrolledWindow *scrolled_window,
688 GtkPolicyType *hscrollbar_policy,
689 GtkPolicyType *vscrollbar_policy)
691 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
693 if (hscrollbar_policy)
694 *hscrollbar_policy = scrolled_window->hscrollbar_policy;
695 if (vscrollbar_policy)
696 *vscrollbar_policy = scrolled_window->vscrollbar_policy;
700 gtk_scrolled_window_update_real_placement (GtkScrolledWindow *scrolled_window)
702 GtkScrolledWindowPrivate *priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
703 GtkSettings *settings;
705 settings = gtk_widget_get_settings (GTK_WIDGET (scrolled_window));
707 if (priv->window_placement_set || settings == NULL)
708 priv->real_window_placement = scrolled_window->window_placement;
710 g_object_get (settings,
711 "gtk-scrolled-window-placement",
712 &priv->real_window_placement,
717 gtk_scrolled_window_set_placement_internal (GtkScrolledWindow *scrolled_window,
718 GtkCornerType window_placement)
720 if (scrolled_window->window_placement != window_placement)
722 scrolled_window->window_placement = window_placement;
724 gtk_scrolled_window_update_real_placement (scrolled_window);
725 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
727 g_object_notify (G_OBJECT (scrolled_window), "window-placement");
732 gtk_scrolled_window_set_placement_set (GtkScrolledWindow *scrolled_window,
733 gboolean placement_set,
734 gboolean emit_resize)
736 GtkScrolledWindowPrivate *priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
738 if (priv->window_placement_set != placement_set)
740 priv->window_placement_set = placement_set;
742 gtk_scrolled_window_update_real_placement (scrolled_window);
744 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
746 g_object_notify (G_OBJECT (scrolled_window), "window-placement-set");
751 * gtk_scrolled_window_set_placement:
752 * @scrolled_window: a #GtkScrolledWindow
753 * @window_placement: position of the child window
755 * Sets the placement of the contents with respect to the scrollbars
756 * for the scrolled window.
758 * The default is %GTK_CORNER_TOP_LEFT, meaning the child is
759 * in the top left, with the scrollbars underneath and to the right.
760 * Other values in #GtkCornerType are %GTK_CORNER_TOP_RIGHT,
761 * %GTK_CORNER_BOTTOM_LEFT, and %GTK_CORNER_BOTTOM_RIGHT.
763 * See also gtk_scrolled_window_get_placement() and
764 * gtk_scrolled_window_unset_placement().
767 gtk_scrolled_window_set_placement (GtkScrolledWindow *scrolled_window,
768 GtkCornerType window_placement)
770 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
772 gtk_scrolled_window_set_placement_set (scrolled_window, TRUE, FALSE);
773 gtk_scrolled_window_set_placement_internal (scrolled_window, window_placement);
777 * gtk_scrolled_window_get_placement:
778 * @scrolled_window: a #GtkScrolledWindow
780 * Gets the placement of the contents with respect to the scrollbars
781 * for the scrolled window. See gtk_scrolled_window_set_placement().
783 * Return value: the current placement value.
785 * See also gtk_scrolled_window_set_placement() and
786 * gtk_scrolled_window_unset_placement().
789 gtk_scrolled_window_get_placement (GtkScrolledWindow *scrolled_window)
791 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), GTK_CORNER_TOP_LEFT);
793 return scrolled_window->window_placement;
797 * gtk_scrolled_window_unset_placement:
798 * @scrolled_window: a #GtkScrolledWindow
800 * Unsets the placement of the contents with respect to the scrollbars
801 * for the scrolled window. If no window placement is set for a scrolled
802 * window, it obeys the "gtk-scrolled-window-placement" XSETTING.
804 * See also gtk_scrolled_window_set_placement() and
805 * gtk_scrolled_window_get_placement().
810 gtk_scrolled_window_unset_placement (GtkScrolledWindow *scrolled_window)
812 GtkScrolledWindowPrivate *priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
814 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
816 if (priv->window_placement_set)
818 priv->window_placement_set = FALSE;
820 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
822 g_object_notify (G_OBJECT (scrolled_window), "window-placement-set");
827 * gtk_scrolled_window_set_shadow_type:
828 * @scrolled_window: a #GtkScrolledWindow
829 * @type: kind of shadow to draw around scrolled window contents
831 * Changes the type of shadow drawn around the contents of
836 gtk_scrolled_window_set_shadow_type (GtkScrolledWindow *scrolled_window,
839 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
840 g_return_if_fail (type >= GTK_SHADOW_NONE && type <= GTK_SHADOW_ETCHED_OUT);
842 if (scrolled_window->shadow_type != type)
844 scrolled_window->shadow_type = type;
846 if (gtk_widget_is_drawable (GTK_WIDGET (scrolled_window)))
847 gtk_widget_queue_draw (GTK_WIDGET (scrolled_window));
849 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
851 g_object_notify (G_OBJECT (scrolled_window), "shadow-type");
856 * gtk_scrolled_window_get_shadow_type:
857 * @scrolled_window: a #GtkScrolledWindow
859 * Gets the shadow type of the scrolled window. See
860 * gtk_scrolled_window_set_shadow_type().
862 * Return value: the current shadow type
865 gtk_scrolled_window_get_shadow_type (GtkScrolledWindow *scrolled_window)
867 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), GTK_SHADOW_NONE);
869 return scrolled_window->shadow_type;
873 gtk_scrolled_window_destroy (GtkObject *object)
875 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
877 if (scrolled_window->hscrollbar)
879 g_signal_handlers_disconnect_by_func (gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
880 gtk_scrolled_window_adjustment_changed,
882 gtk_widget_unparent (scrolled_window->hscrollbar);
883 gtk_widget_destroy (scrolled_window->hscrollbar);
884 g_object_unref (scrolled_window->hscrollbar);
885 scrolled_window->hscrollbar = NULL;
887 if (scrolled_window->vscrollbar)
889 g_signal_handlers_disconnect_by_func (gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)),
890 gtk_scrolled_window_adjustment_changed,
892 gtk_widget_unparent (scrolled_window->vscrollbar);
893 gtk_widget_destroy (scrolled_window->vscrollbar);
894 g_object_unref (scrolled_window->vscrollbar);
895 scrolled_window->vscrollbar = NULL;
898 GTK_OBJECT_CLASS (gtk_scrolled_window_parent_class)->destroy (object);
902 gtk_scrolled_window_set_property (GObject *object,
907 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
911 case PROP_HADJUSTMENT:
912 gtk_scrolled_window_set_hadjustment (scrolled_window,
913 g_value_get_object (value));
915 case PROP_VADJUSTMENT:
916 gtk_scrolled_window_set_vadjustment (scrolled_window,
917 g_value_get_object (value));
919 case PROP_HSCROLLBAR_POLICY:
920 gtk_scrolled_window_set_policy (scrolled_window,
921 g_value_get_enum (value),
922 scrolled_window->vscrollbar_policy);
924 case PROP_VSCROLLBAR_POLICY:
925 gtk_scrolled_window_set_policy (scrolled_window,
926 scrolled_window->hscrollbar_policy,
927 g_value_get_enum (value));
929 case PROP_WINDOW_PLACEMENT:
930 gtk_scrolled_window_set_placement_internal (scrolled_window,
931 g_value_get_enum (value));
933 case PROP_WINDOW_PLACEMENT_SET:
934 gtk_scrolled_window_set_placement_set (scrolled_window,
935 g_value_get_boolean (value),
938 case PROP_SHADOW_TYPE:
939 gtk_scrolled_window_set_shadow_type (scrolled_window,
940 g_value_get_enum (value));
943 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
949 gtk_scrolled_window_get_property (GObject *object,
954 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
955 GtkScrolledWindowPrivate *priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
959 case PROP_HADJUSTMENT:
960 g_value_set_object (value,
961 G_OBJECT (gtk_scrolled_window_get_hadjustment (scrolled_window)));
963 case PROP_VADJUSTMENT:
964 g_value_set_object (value,
965 G_OBJECT (gtk_scrolled_window_get_vadjustment (scrolled_window)));
967 case PROP_HSCROLLBAR_POLICY:
968 g_value_set_enum (value, scrolled_window->hscrollbar_policy);
970 case PROP_VSCROLLBAR_POLICY:
971 g_value_set_enum (value, scrolled_window->vscrollbar_policy);
973 case PROP_WINDOW_PLACEMENT:
974 g_value_set_enum (value, scrolled_window->window_placement);
976 case PROP_WINDOW_PLACEMENT_SET:
977 g_value_set_boolean (value, priv->window_placement_set);
979 case PROP_SHADOW_TYPE:
980 g_value_set_enum (value, scrolled_window->shadow_type);
983 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
989 traverse_container (GtkWidget *widget,
992 if (GTK_IS_SCROLLED_WINDOW (widget))
994 gtk_scrolled_window_update_real_placement (GTK_SCROLLED_WINDOW (widget));
995 gtk_widget_queue_resize (widget);
997 else if (GTK_IS_CONTAINER (widget))
998 gtk_container_forall (GTK_CONTAINER (widget), traverse_container, NULL);
1002 gtk_scrolled_window_settings_changed (GtkSettings *settings)
1006 list = gtk_window_list_toplevels ();
1008 for (l = list; l; l = l->next)
1009 gtk_container_forall (GTK_CONTAINER (l->data),
1010 traverse_container, NULL);
1016 gtk_scrolled_window_screen_changed (GtkWidget *widget,
1017 GdkScreen *previous_screen)
1019 GtkSettings *settings;
1020 guint window_placement_connection;
1022 gtk_scrolled_window_update_real_placement (GTK_SCROLLED_WINDOW (widget));
1024 if (!gtk_widget_has_screen (widget))
1027 settings = gtk_widget_get_settings (widget);
1029 window_placement_connection =
1030 GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (settings),
1031 "gtk-scrolled-window-connection"));
1033 if (window_placement_connection)
1036 window_placement_connection =
1037 g_signal_connect (settings, "notify::gtk-scrolled-window-placement",
1038 G_CALLBACK (gtk_scrolled_window_settings_changed), NULL);
1039 g_object_set_data (G_OBJECT (settings),
1040 I_("gtk-scrolled-window-connection"),
1041 GUINT_TO_POINTER (window_placement_connection));
1045 gtk_scrolled_window_paint (GtkWidget *widget,
1048 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (widget);
1050 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1052 GtkAllocation relative_allocation;
1053 gboolean scrollbars_within_bevel;
1055 gtk_widget_style_get (widget, "scrollbars-within-bevel", &scrollbars_within_bevel, NULL);
1057 if (!scrollbars_within_bevel)
1059 gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
1061 relative_allocation.x -= widget->style->xthickness;
1062 relative_allocation.y -= widget->style->ythickness;
1063 relative_allocation.width += 2 * widget->style->xthickness;
1064 relative_allocation.height += 2 * widget->style->ythickness;
1068 GtkContainer *container = GTK_CONTAINER (widget);
1070 relative_allocation.x = container->border_width;
1071 relative_allocation.y = container->border_width;
1072 relative_allocation.width = widget->allocation.width - 2 * container->border_width;
1073 relative_allocation.height = widget->allocation.height - 2 * container->border_width;
1076 gtk_paint_shadow (widget->style, widget->window,
1077 GTK_STATE_NORMAL, scrolled_window->shadow_type,
1078 area, widget, "scrolled_window",
1079 widget->allocation.x + relative_allocation.x,
1080 widget->allocation.y + relative_allocation.y,
1081 relative_allocation.width,
1082 relative_allocation.height);
1087 gtk_scrolled_window_expose (GtkWidget *widget,
1088 GdkEventExpose *event)
1090 if (gtk_widget_is_drawable (widget))
1092 gtk_scrolled_window_paint (widget, &event->area);
1094 GTK_WIDGET_CLASS (gtk_scrolled_window_parent_class)->expose_event (widget, event);
1101 gtk_scrolled_window_forall (GtkContainer *container,
1102 gboolean include_internals,
1103 GtkCallback callback,
1104 gpointer callback_data)
1106 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (container));
1107 g_return_if_fail (callback != NULL);
1109 GTK_CONTAINER_CLASS (gtk_scrolled_window_parent_class)->forall (container,
1113 if (include_internals)
1115 GtkScrolledWindow *scrolled_window;
1117 scrolled_window = GTK_SCROLLED_WINDOW (container);
1119 if (scrolled_window->vscrollbar)
1120 callback (scrolled_window->vscrollbar, callback_data);
1121 if (scrolled_window->hscrollbar)
1122 callback (scrolled_window->hscrollbar, callback_data);
1127 gtk_scrolled_window_scroll_child (GtkScrolledWindow *scrolled_window,
1128 GtkScrollType scroll,
1129 gboolean horizontal)
1131 GtkAdjustment *adjustment = NULL;
1135 case GTK_SCROLL_STEP_UP:
1136 scroll = GTK_SCROLL_STEP_BACKWARD;
1139 case GTK_SCROLL_STEP_DOWN:
1140 scroll = GTK_SCROLL_STEP_FORWARD;
1143 case GTK_SCROLL_STEP_LEFT:
1144 scroll = GTK_SCROLL_STEP_BACKWARD;
1147 case GTK_SCROLL_STEP_RIGHT:
1148 scroll = GTK_SCROLL_STEP_FORWARD;
1151 case GTK_SCROLL_PAGE_UP:
1152 scroll = GTK_SCROLL_PAGE_BACKWARD;
1155 case GTK_SCROLL_PAGE_DOWN:
1156 scroll = GTK_SCROLL_PAGE_FORWARD;
1159 case GTK_SCROLL_PAGE_LEFT:
1160 scroll = GTK_SCROLL_STEP_BACKWARD;
1163 case GTK_SCROLL_PAGE_RIGHT:
1164 scroll = GTK_SCROLL_STEP_FORWARD;
1167 case GTK_SCROLL_STEP_BACKWARD:
1168 case GTK_SCROLL_STEP_FORWARD:
1169 case GTK_SCROLL_PAGE_BACKWARD:
1170 case GTK_SCROLL_PAGE_FORWARD:
1171 case GTK_SCROLL_START:
1172 case GTK_SCROLL_END:
1175 g_warning ("Invalid scroll type %u for GtkScrolledWindow::scroll-child", scroll);
1179 if ((horizontal && (!scrolled_window->hscrollbar || !scrolled_window->hscrollbar_visible)) ||
1180 (!horizontal && (!scrolled_window->vscrollbar || !scrolled_window->vscrollbar_visible)))
1185 if (scrolled_window->hscrollbar)
1186 adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
1190 if (scrolled_window->vscrollbar)
1191 adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
1196 gdouble value = adjustment->value;
1200 case GTK_SCROLL_STEP_FORWARD:
1201 value += adjustment->step_increment;
1203 case GTK_SCROLL_STEP_BACKWARD:
1204 value -= adjustment->step_increment;
1206 case GTK_SCROLL_PAGE_FORWARD:
1207 value += adjustment->page_increment;
1209 case GTK_SCROLL_PAGE_BACKWARD:
1210 value -= adjustment->page_increment;
1212 case GTK_SCROLL_START:
1213 value = adjustment->lower;
1215 case GTK_SCROLL_END:
1216 value = adjustment->upper;
1219 g_assert_not_reached ();
1223 gtk_adjustment_set_value (adjustment, value);
1232 gtk_scrolled_window_move_focus_out (GtkScrolledWindow *scrolled_window,
1233 GtkDirectionType direction_type)
1235 GtkWidget *toplevel;
1237 /* Focus out of the scrolled window entirely. We do this by setting
1238 * a flag, then propagating the focus motion to the notebook.
1240 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (scrolled_window));
1241 if (!gtk_widget_is_toplevel (toplevel))
1244 g_object_ref (scrolled_window);
1246 scrolled_window->focus_out = TRUE;
1247 g_signal_emit_by_name (toplevel, "move-focus", direction_type);
1248 scrolled_window->focus_out = FALSE;
1250 g_object_unref (scrolled_window);
1254 gtk_scrolled_window_relative_allocation (GtkWidget *widget,
1255 GtkAllocation *allocation)
1257 GtkScrolledWindow *scrolled_window;
1258 GtkScrolledWindowPrivate *priv;
1259 gint scrollbar_spacing;
1261 g_return_if_fail (widget != NULL);
1262 g_return_if_fail (allocation != NULL);
1264 scrolled_window = GTK_SCROLLED_WINDOW (widget);
1265 scrollbar_spacing = _gtk_scrolled_window_get_scrollbar_spacing (scrolled_window);
1267 priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
1269 allocation->x = GTK_CONTAINER (widget)->border_width;
1270 allocation->y = GTK_CONTAINER (widget)->border_width;
1272 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1274 allocation->x += widget->style->xthickness;
1275 allocation->y += widget->style->ythickness;
1278 allocation->width = MAX (1, (gint)widget->allocation.width - allocation->x * 2);
1279 allocation->height = MAX (1, (gint)widget->allocation.height - allocation->y * 2);
1281 if (scrolled_window->vscrollbar_visible)
1283 GtkRequisition vscrollbar_requisition;
1286 gtk_widget_get_child_requisition (scrolled_window->vscrollbar,
1287 &vscrollbar_requisition);
1288 is_rtl = gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL;
1291 (priv->real_window_placement == GTK_CORNER_TOP_RIGHT ||
1292 priv->real_window_placement == GTK_CORNER_BOTTOM_RIGHT)) ||
1294 (priv->real_window_placement == GTK_CORNER_TOP_LEFT ||
1295 priv->real_window_placement == GTK_CORNER_BOTTOM_LEFT)))
1296 allocation->x += (vscrollbar_requisition.width + scrollbar_spacing);
1298 allocation->width = MAX (1, allocation->width - (vscrollbar_requisition.width + scrollbar_spacing));
1300 if (scrolled_window->hscrollbar_visible)
1302 GtkRequisition hscrollbar_requisition;
1303 gtk_widget_get_child_requisition (scrolled_window->hscrollbar,
1304 &hscrollbar_requisition);
1306 if (priv->real_window_placement == GTK_CORNER_BOTTOM_LEFT ||
1307 priv->real_window_placement == GTK_CORNER_BOTTOM_RIGHT)
1308 allocation->y += (hscrollbar_requisition.height + scrollbar_spacing);
1310 allocation->height = MAX (1, allocation->height - (hscrollbar_requisition.height + scrollbar_spacing));
1315 gtk_scrolled_window_size_allocate (GtkWidget *widget,
1316 GtkAllocation *allocation)
1318 GtkScrolledWindow *scrolled_window;
1319 GtkScrolledWindowPrivate *priv;
1321 GtkAllocation relative_allocation;
1322 GtkAllocation child_allocation;
1323 gboolean scrollbars_within_bevel;
1324 gint scrollbar_spacing;
1326 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (widget));
1327 g_return_if_fail (allocation != NULL);
1329 scrolled_window = GTK_SCROLLED_WINDOW (widget);
1330 bin = GTK_BIN (scrolled_window);
1332 scrollbar_spacing = _gtk_scrolled_window_get_scrollbar_spacing (scrolled_window);
1333 gtk_widget_style_get (widget, "scrollbars-within-bevel", &scrollbars_within_bevel, NULL);
1335 priv = GTK_SCROLLED_WINDOW_GET_PRIVATE (scrolled_window);
1337 widget->allocation = *allocation;
1339 if (scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS)
1340 scrolled_window->hscrollbar_visible = TRUE;
1341 else if (scrolled_window->hscrollbar_policy == GTK_POLICY_NEVER)
1342 scrolled_window->hscrollbar_visible = FALSE;
1343 if (scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS)
1344 scrolled_window->vscrollbar_visible = TRUE;
1345 else if (scrolled_window->vscrollbar_policy == GTK_POLICY_NEVER)
1346 scrolled_window->vscrollbar_visible = FALSE;
1348 if (bin->child && gtk_widget_get_visible (bin->child))
1350 gboolean previous_hvis;
1351 gboolean previous_vvis;
1356 gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
1358 child_allocation.x = relative_allocation.x + allocation->x;
1359 child_allocation.y = relative_allocation.y + allocation->y;
1360 child_allocation.width = relative_allocation.width;
1361 child_allocation.height = relative_allocation.height;
1363 previous_hvis = scrolled_window->hscrollbar_visible;
1364 previous_vvis = scrolled_window->vscrollbar_visible;
1366 gtk_widget_size_allocate (bin->child, &child_allocation);
1368 /* If, after the first iteration, the hscrollbar and the
1369 * vscrollbar flip visiblity, then we need both.
1372 previous_hvis != scrolled_window->hscrollbar_visible &&
1373 previous_vvis != scrolled_window->vscrollbar_visible)
1375 scrolled_window->hscrollbar_visible = TRUE;
1376 scrolled_window->vscrollbar_visible = TRUE;
1378 /* a new resize is already queued at this point,
1379 * so we will immediatedly get reinvoked
1386 while (previous_hvis != scrolled_window->hscrollbar_visible ||
1387 previous_vvis != scrolled_window->vscrollbar_visible);
1391 scrolled_window->hscrollbar_visible = scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS;
1392 scrolled_window->vscrollbar_visible = scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS;
1393 gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
1396 if (scrolled_window->hscrollbar_visible)
1398 GtkRequisition hscrollbar_requisition;
1399 gtk_widget_get_child_requisition (scrolled_window->hscrollbar,
1400 &hscrollbar_requisition);
1402 if (!gtk_widget_get_visible (scrolled_window->hscrollbar))
1403 gtk_widget_show (scrolled_window->hscrollbar);
1405 child_allocation.x = relative_allocation.x;
1406 if (priv->real_window_placement == GTK_CORNER_TOP_LEFT ||
1407 priv->real_window_placement == GTK_CORNER_TOP_RIGHT)
1408 child_allocation.y = (relative_allocation.y +
1409 relative_allocation.height +
1411 (scrolled_window->shadow_type == GTK_SHADOW_NONE ?
1412 0 : widget->style->ythickness));
1414 child_allocation.y = GTK_CONTAINER (scrolled_window)->border_width;
1416 child_allocation.width = relative_allocation.width;
1417 child_allocation.height = hscrollbar_requisition.height;
1418 child_allocation.x += allocation->x;
1419 child_allocation.y += allocation->y;
1421 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1423 if (!scrollbars_within_bevel)
1425 child_allocation.x -= widget->style->xthickness;
1426 child_allocation.width += 2 * widget->style->xthickness;
1428 else if (GTK_CORNER_TOP_RIGHT == priv->real_window_placement ||
1429 GTK_CORNER_TOP_LEFT == priv->real_window_placement)
1431 child_allocation.y -= widget->style->ythickness;
1435 child_allocation.y += widget->style->ythickness;
1439 gtk_widget_size_allocate (scrolled_window->hscrollbar, &child_allocation);
1441 else if (gtk_widget_get_visible (scrolled_window->hscrollbar))
1442 gtk_widget_hide (scrolled_window->hscrollbar);
1444 if (scrolled_window->vscrollbar_visible)
1446 GtkRequisition vscrollbar_requisition;
1447 if (!gtk_widget_get_visible (scrolled_window->vscrollbar))
1448 gtk_widget_show (scrolled_window->vscrollbar);
1450 gtk_widget_get_child_requisition (scrolled_window->vscrollbar,
1451 &vscrollbar_requisition);
1453 if ((gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL &&
1454 (priv->real_window_placement == GTK_CORNER_TOP_RIGHT ||
1455 priv->real_window_placement == GTK_CORNER_BOTTOM_RIGHT)) ||
1456 (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR &&
1457 (priv->real_window_placement == GTK_CORNER_TOP_LEFT ||
1458 priv->real_window_placement == GTK_CORNER_BOTTOM_LEFT)))
1459 child_allocation.x = (relative_allocation.x +
1460 relative_allocation.width +
1462 (scrolled_window->shadow_type == GTK_SHADOW_NONE ?
1463 0 : widget->style->xthickness));
1465 child_allocation.x = GTK_CONTAINER (scrolled_window)->border_width;
1467 child_allocation.y = relative_allocation.y;
1468 child_allocation.width = vscrollbar_requisition.width;
1469 child_allocation.height = relative_allocation.height;
1470 child_allocation.x += allocation->x;
1471 child_allocation.y += allocation->y;
1473 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1475 if (!scrollbars_within_bevel)
1477 child_allocation.y -= widget->style->ythickness;
1478 child_allocation.height += 2 * widget->style->ythickness;
1480 else if (GTK_CORNER_BOTTOM_LEFT == priv->real_window_placement ||
1481 GTK_CORNER_TOP_LEFT == priv->real_window_placement)
1483 child_allocation.x -= widget->style->xthickness;
1487 child_allocation.x += widget->style->xthickness;
1491 gtk_widget_size_allocate (scrolled_window->vscrollbar, &child_allocation);
1493 else if (gtk_widget_get_visible (scrolled_window->vscrollbar))
1494 gtk_widget_hide (scrolled_window->vscrollbar);
1498 gtk_scrolled_window_scroll_event (GtkWidget *widget,
1499 GdkEventScroll *event)
1503 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (widget), FALSE);
1504 g_return_val_if_fail (event != NULL, FALSE);
1506 if (event->direction == GDK_SCROLL_UP || event->direction == GDK_SCROLL_DOWN)
1507 range = GTK_SCROLLED_WINDOW (widget)->vscrollbar;
1509 range = GTK_SCROLLED_WINDOW (widget)->hscrollbar;
1511 if (range && gtk_widget_get_visible (range))
1513 GtkAdjustment *adj = GTK_RANGE (range)->adjustment;
1516 delta = _gtk_range_get_wheel_delta (GTK_RANGE (range), event->direction);
1518 gtk_adjustment_set_value (adj, adj->value + delta);
1527 gtk_scrolled_window_focus (GtkWidget *widget,
1528 GtkDirectionType direction)
1530 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (widget);
1531 gboolean had_focus_child = GTK_CONTAINER (widget)->focus_child != NULL;
1533 if (scrolled_window->focus_out)
1535 scrolled_window->focus_out = FALSE; /* Clear this to catch the wrap-around case */
1539 if (gtk_widget_is_focus (widget))
1542 /* We only put the scrolled window itself in the focus chain if it
1543 * isn't possible to focus any children.
1545 if (GTK_BIN (widget)->child)
1547 if (gtk_widget_child_focus (GTK_BIN (widget)->child, direction))
1551 if (!had_focus_child && gtk_widget_get_can_focus (widget))
1553 gtk_widget_grab_focus (widget);
1561 gtk_scrolled_window_adjustment_changed (GtkAdjustment *adjustment,
1564 GtkScrolledWindow *scrolled_win;
1566 g_return_if_fail (adjustment != NULL);
1567 g_return_if_fail (data != NULL);
1569 scrolled_win = GTK_SCROLLED_WINDOW (data);
1571 if (scrolled_win->hscrollbar &&
1572 adjustment == gtk_range_get_adjustment (GTK_RANGE (scrolled_win->hscrollbar)))
1574 if (scrolled_win->hscrollbar_policy == GTK_POLICY_AUTOMATIC)
1578 visible = scrolled_win->hscrollbar_visible;
1579 scrolled_win->hscrollbar_visible = (adjustment->upper - adjustment->lower >
1580 adjustment->page_size);
1581 if (scrolled_win->hscrollbar_visible != visible)
1582 gtk_widget_queue_resize (GTK_WIDGET (scrolled_win));
1585 else if (scrolled_win->vscrollbar &&
1586 adjustment == gtk_range_get_adjustment (GTK_RANGE (scrolled_win->vscrollbar)))
1588 if (scrolled_win->vscrollbar_policy == GTK_POLICY_AUTOMATIC)
1592 visible = scrolled_win->vscrollbar_visible;
1593 scrolled_win->vscrollbar_visible = (adjustment->upper - adjustment->lower >
1594 adjustment->page_size);
1595 if (scrolled_win->vscrollbar_visible != visible)
1596 gtk_widget_queue_resize (GTK_WIDGET (scrolled_win));
1602 gtk_scrolled_window_add (GtkContainer *container,
1605 GtkScrolledWindow *scrolled_window;
1608 bin = GTK_BIN (container);
1609 g_return_if_fail (bin->child == NULL);
1611 scrolled_window = GTK_SCROLLED_WINDOW (container);
1614 gtk_widget_set_parent (child, GTK_WIDGET (bin));
1616 /* this is a temporary message */
1617 if (!gtk_widget_set_scroll_adjustments (child,
1618 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
1619 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar))))
1620 g_warning ("gtk_scrolled_window_add(): cannot add non scrollable widget "
1621 "use gtk_scrolled_window_add_with_viewport() instead");
1625 gtk_scrolled_window_remove (GtkContainer *container,
1628 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (container));
1629 g_return_if_fail (child != NULL);
1630 g_return_if_fail (GTK_BIN (container)->child == child);
1632 gtk_widget_set_scroll_adjustments (child, NULL, NULL);
1634 /* chain parent class handler to remove child */
1635 GTK_CONTAINER_CLASS (gtk_scrolled_window_parent_class)->remove (container, child);
1639 * gtk_scrolled_window_add_with_viewport:
1640 * @scrolled_window: a #GtkScrolledWindow
1641 * @child: the widget you want to scroll
1643 * Used to add children without native scrolling capabilities. This
1644 * is simply a convenience function; it is equivalent to adding the
1645 * unscrollable child to a viewport, then adding the viewport to the
1646 * scrolled window. If a child has native scrolling, use
1647 * gtk_container_add() instead of this function.
1649 * The viewport scrolls the child by moving its #GdkWindow, and takes
1650 * the size of the child to be the size of its toplevel #GdkWindow.
1651 * This will be very wrong for most widgets that support native scrolling;
1652 * for example, if you add a widget such as #GtkTreeView with a viewport,
1653 * the whole widget will scroll, including the column headings. Thus,
1654 * widgets with native scrolling support should not be used with the
1655 * #GtkViewport proxy.
1657 * A widget supports scrolling natively if the
1658 * set_scroll_adjustments_signal field in #GtkWidgetClass is non-zero,
1659 * i.e. has been filled in with a valid signal identifier.
1662 gtk_scrolled_window_add_with_viewport (GtkScrolledWindow *scrolled_window,
1666 GtkWidget *viewport;
1668 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
1669 g_return_if_fail (GTK_IS_WIDGET (child));
1670 g_return_if_fail (child->parent == NULL);
1672 bin = GTK_BIN (scrolled_window);
1674 if (bin->child != NULL)
1676 g_return_if_fail (GTK_IS_VIEWPORT (bin->child));
1677 g_return_if_fail (GTK_BIN (bin->child)->child == NULL);
1679 viewport = bin->child;
1684 gtk_viewport_new (gtk_scrolled_window_get_hadjustment (scrolled_window),
1685 gtk_scrolled_window_get_vadjustment (scrolled_window));
1686 gtk_container_add (GTK_CONTAINER (scrolled_window), viewport);
1689 gtk_widget_show (viewport);
1690 gtk_container_add (GTK_CONTAINER (viewport), child);
1694 * _gtk_scrolled_window_get_spacing:
1695 * @scrolled_window: a scrolled window
1697 * Gets the spacing between the scrolled window's scrollbars and
1698 * the scrolled widget. Used by GtkCombo
1700 * Return value: the spacing, in pixels.
1703 _gtk_scrolled_window_get_scrollbar_spacing (GtkScrolledWindow *scrolled_window)
1705 GtkScrolledWindowClass *class;
1707 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), 0);
1709 class = GTK_SCROLLED_WINDOW_GET_CLASS (scrolled_window);
1711 if (class->scrollbar_spacing >= 0)
1712 return class->scrollbar_spacing;
1715 gint scrollbar_spacing;
1717 gtk_widget_style_get (GTK_WIDGET (scrolled_window),
1718 "scrollbar-spacing", &scrollbar_spacing,
1721 return scrollbar_spacing;
1727 gtk_scrolled_window_extended_layout_init (GtkExtendedLayoutIface *iface)
1729 iface->get_desired_width = gtk_scrolled_window_get_desired_width;
1730 iface->get_desired_height = gtk_scrolled_window_get_desired_height;
1731 iface->get_height_for_width = gtk_scrolled_window_get_height_for_width;
1732 iface->get_width_for_height = gtk_scrolled_window_get_width_for_height;
1736 gtk_scrolled_window_get_desired_size (GtkExtendedLayout *layout,
1737 GtkOrientation orientation,
1741 GtkScrolledWindow *scrolled_window;
1745 gint scrollbar_spacing;
1746 GtkRequisition hscrollbar_requisition;
1747 GtkRequisition vscrollbar_requisition;
1748 GtkRequisition minimum_req, natural_req;
1749 gint min_child_size, nat_child_size;
1751 scrolled_window = GTK_SCROLLED_WINDOW (layout);
1752 bin = GTK_BIN (scrolled_window);
1754 scrollbar_spacing = _gtk_scrolled_window_get_scrollbar_spacing (scrolled_window);
1758 minimum_req.width = 0;
1759 minimum_req.height = 0;
1760 natural_req.width = 0;
1761 natural_req.height = 0;
1763 gtk_widget_size_request (scrolled_window->hscrollbar,
1764 &hscrollbar_requisition);
1765 gtk_widget_size_request (scrolled_window->vscrollbar,
1766 &vscrollbar_requisition);
1768 if (bin->child && gtk_widget_get_visible (bin->child))
1770 if (orientation == GTK_ORIENTATION_HORIZONTAL)
1772 gtk_extended_layout_get_desired_width (GTK_EXTENDED_LAYOUT (bin->child),
1776 if (scrolled_window->hscrollbar_policy == GTK_POLICY_NEVER)
1778 minimum_req.width += min_child_size;
1779 natural_req.width += nat_child_size;
1783 GtkWidgetAuxInfo *aux_info = _gtk_widget_get_aux_info (bin->child, FALSE);
1785 if (aux_info && aux_info->width > 0)
1787 minimum_req.width += aux_info->width;
1788 natural_req.width += aux_info->width;
1793 minimum_req.width += vscrollbar_requisition.width;
1794 natural_req.width += vscrollbar_requisition.width;
1798 else /* GTK_ORIENTATION_VERTICAL */
1800 gtk_extended_layout_get_desired_height (GTK_EXTENDED_LAYOUT (bin->child),
1804 if (scrolled_window->vscrollbar_policy == GTK_POLICY_NEVER)
1806 minimum_req.height += min_child_size;
1807 natural_req.height += nat_child_size;
1811 GtkWidgetAuxInfo *aux_info = _gtk_widget_get_aux_info (bin->child, FALSE);
1813 if (aux_info && aux_info->height > 0)
1815 minimum_req.height += aux_info->height;
1816 natural_req.height += aux_info->height;
1821 minimum_req.height += hscrollbar_requisition.height;
1822 natural_req.height += hscrollbar_requisition.height;
1828 if (scrolled_window->hscrollbar_policy == GTK_POLICY_AUTOMATIC ||
1829 scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS)
1831 minimum_req.width = MAX (minimum_req.width, hscrollbar_requisition.width);
1832 natural_req.width = MAX (natural_req.width, hscrollbar_requisition.width);
1833 if (!extra_height || scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS)
1834 extra_height = scrollbar_spacing + hscrollbar_requisition.height;
1837 if (scrolled_window->vscrollbar_policy == GTK_POLICY_AUTOMATIC ||
1838 scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS)
1840 minimum_req.height = MAX (minimum_req.height, vscrollbar_requisition.height);
1841 natural_req.height = MAX (natural_req.height, vscrollbar_requisition.height);
1842 if (!extra_height || scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS)
1843 extra_width = scrollbar_spacing + vscrollbar_requisition.width;
1846 minimum_req.width += GTK_CONTAINER (layout)->border_width * 2 + MAX (0, extra_width);
1847 minimum_req.height += GTK_CONTAINER (layout)->border_width * 2 + MAX (0, extra_height);
1848 natural_req.width += GTK_CONTAINER (layout)->border_width * 2 + MAX (0, extra_width);
1849 natural_req.height += GTK_CONTAINER (layout)->border_width * 2 + MAX (0, extra_height);
1851 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1853 minimum_req.width += 2 * GTK_WIDGET (layout)->style->xthickness;
1854 minimum_req.height += 2 * GTK_WIDGET (layout)->style->ythickness;
1855 natural_req.width += 2 * GTK_WIDGET (layout)->style->xthickness;
1856 natural_req.height += 2 * GTK_WIDGET (layout)->style->ythickness;
1859 if (orientation == GTK_ORIENTATION_HORIZONTAL)
1862 *minimum_size = minimum_req.width;
1864 *natural_size = natural_req.width;
1869 *minimum_size = minimum_req.height;
1871 *natural_size = natural_req.height;
1876 gtk_scrolled_window_get_desired_width (GtkExtendedLayout *layout,
1880 gtk_scrolled_window_get_desired_size (layout, GTK_ORIENTATION_HORIZONTAL, minimum_size, natural_size);
1884 gtk_scrolled_window_get_desired_height (GtkExtendedLayout *layout,
1888 gtk_scrolled_window_get_desired_size (layout, GTK_ORIENTATION_VERTICAL, minimum_size, natural_size);
1892 gtk_scrolled_window_get_height_for_width (GtkExtendedLayout *layout,
1894 gint *minimum_height,
1895 gint *natural_height)
1897 g_return_if_fail (GTK_IS_WIDGET (layout));
1899 GTK_EXTENDED_LAYOUT_GET_IFACE (layout)->get_desired_height (layout, minimum_height, natural_height);
1903 gtk_scrolled_window_get_width_for_height (GtkExtendedLayout *layout,
1905 gint *minimum_width,
1906 gint *natural_width)
1908 g_return_if_fail (GTK_IS_WIDGET (layout));
1910 GTK_EXTENDED_LAYOUT_GET_IFACE (layout)->get_desired_width (layout, minimum_width, natural_width);
1913 #define __GTK_SCROLLED_WINDOW_C__
1914 #include "gtkaliasdef.c"