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/.
27 #include <gdk/gdkkeysyms.h>
28 #include "gtkbindings.h"
29 #include "gtkmarshalers.h"
30 #include "gtkscrolledwindow.h"
31 #include "gtksignal.h"
35 /* scrolled window policy and size requisition handling:
37 * gtk size requisition works as follows:
38 * a widget upon size-request reports the width and height that it finds
39 * to be best suited to display its contents, including children.
40 * the width and/or height reported from a widget upon size requisition
41 * may be overidden by the user by specifying a width and/or height
42 * other than 0 through gtk_widget_set_usize().
44 * a scrolled window needs (for imlementing all three policy types) to
45 * request its width and height based on two different rationales.
46 * 1) the user wants the scrolled window to just fit into the space
47 * that it gets allocated for a specifc dimension.
48 * 1.1) this does not apply if the user specified a concrete value
49 * value for that specific dimension by either specifying usize for the
50 * scrolled window or for its child.
51 * 2) the user wants the scrolled window to take as much space up as
52 * is desired by the child for a specifc dimension (i.e. POLICY_NEVER).
54 * also, kinda obvious:
55 * 3) a user would certainly not have choosen a scrolled window as a container
56 * for the child, if the resulting allocation takes up more space than the
57 * child would have allocated without the scrolled window.
60 * A) from 1) follows: the scrolled window shouldn't request more space for a
61 * specifc dimension than is required at minimum.
62 * B) from 1.1) follows: the requisition may be overidden by usize of the scrolled
63 * window (done automatically) or by usize of the child (needs to be checked).
64 * C) from 2) follows: for POLICY_NEVER, the scrolled window simply reports the
66 * D) from 3) follows: the scrolled window child's minimum width and minimum height
67 * under A) at least correspond to the space taken up by its scrollbars.
70 #define SCROLLBAR_SPACING(w) (GTK_SCROLLED_WINDOW_GET_CLASS (w)->scrollbar_spacing)
72 #define DEFAULT_SCROLLBAR_SPACING 3
78 PROP_HSCROLLBAR_POLICY,
79 PROP_VSCROLLBAR_POLICY,
80 PROP_WINDOW_PLACEMENT,
93 static void gtk_scrolled_window_class_init (GtkScrolledWindowClass *klass);
94 static void gtk_scrolled_window_init (GtkScrolledWindow *scrolled_window);
95 static void gtk_scrolled_window_destroy (GtkObject *object);
96 static void gtk_scrolled_window_finalize (GObject *object);
97 static void gtk_scrolled_window_set_property (GObject *object,
101 static void gtk_scrolled_window_get_property (GObject *object,
106 static gint gtk_scrolled_window_expose (GtkWidget *widget,
107 GdkEventExpose *event);
108 static void gtk_scrolled_window_size_request (GtkWidget *widget,
109 GtkRequisition *requisition);
110 static void gtk_scrolled_window_size_allocate (GtkWidget *widget,
111 GtkAllocation *allocation);
112 static gint gtk_scrolled_window_scroll_event (GtkWidget *widget,
113 GdkEventScroll *event);
114 static gint gtk_scrolled_window_focus (GtkWidget *widget,
115 GtkDirectionType direction);
116 static void gtk_scrolled_window_add (GtkContainer *container,
118 static void gtk_scrolled_window_remove (GtkContainer *container,
120 static void gtk_scrolled_window_forall (GtkContainer *container,
121 gboolean include_internals,
122 GtkCallback callback,
123 gpointer callback_data);
124 static void gtk_scrolled_window_scroll_child (GtkScrolledWindow *scrolled_window,
125 GtkScrollType scroll,
126 gboolean horizontal);
127 static void gtk_scrolled_window_move_focus_out (GtkScrolledWindow *scrolled_window,
128 GtkDirectionType direction_type);
130 static void gtk_scrolled_window_relative_allocation(GtkWidget *widget,
131 GtkAllocation *allocation);
132 static void gtk_scrolled_window_adjustment_changed (GtkAdjustment *adjustment,
135 static GtkContainerClass *parent_class = NULL;
137 static guint signals[LAST_SIGNAL] = {0};
140 gtk_scrolled_window_get_type (void)
142 static GtkType scrolled_window_type = 0;
144 if (!scrolled_window_type)
146 static const GtkTypeInfo scrolled_window_info =
149 sizeof (GtkScrolledWindow),
150 sizeof (GtkScrolledWindowClass),
151 (GtkClassInitFunc) gtk_scrolled_window_class_init,
152 (GtkObjectInitFunc) gtk_scrolled_window_init,
153 /* reserved_1 */ NULL,
154 /* reserved_2 */ NULL,
155 (GtkClassInitFunc) NULL,
158 scrolled_window_type = gtk_type_unique (GTK_TYPE_BIN, &scrolled_window_info);
161 return scrolled_window_type;
165 add_scroll_binding (GtkBindingSet *binding_set,
167 GdkModifierType mask,
168 GtkScrollType scroll,
171 guint keypad_keyval = keyval - GDK_Left + GDK_KP_Left;
173 gtk_binding_entry_add_signal (binding_set, keyval, mask,
175 GTK_TYPE_SCROLL_TYPE, scroll,
176 G_TYPE_BOOLEAN, horizontal);
177 gtk_binding_entry_add_signal (binding_set, keypad_keyval, mask,
179 GTK_TYPE_SCROLL_TYPE, scroll,
180 G_TYPE_BOOLEAN, horizontal);
184 add_tab_bindings (GtkBindingSet *binding_set,
185 GdkModifierType modifiers,
186 GtkDirectionType direction)
188 gtk_binding_entry_add_signal (binding_set, GDK_Tab, modifiers,
190 GTK_TYPE_DIRECTION_TYPE, direction);
191 gtk_binding_entry_add_signal (binding_set, GDK_KP_Tab, modifiers,
193 GTK_TYPE_DIRECTION_TYPE, direction);
197 gtk_scrolled_window_class_init (GtkScrolledWindowClass *class)
199 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
200 GtkObjectClass *object_class;
201 GtkWidgetClass *widget_class;
202 GtkContainerClass *container_class;
203 GtkBindingSet *binding_set;
205 object_class = (GtkObjectClass*) class;
206 widget_class = (GtkWidgetClass*) class;
207 container_class = (GtkContainerClass*) class;
208 parent_class = gtk_type_class (GTK_TYPE_BIN);
210 gobject_class->finalize = gtk_scrolled_window_finalize;
211 gobject_class->set_property = gtk_scrolled_window_set_property;
212 gobject_class->get_property = gtk_scrolled_window_get_property;
214 object_class->destroy = gtk_scrolled_window_destroy;
216 widget_class->expose_event = gtk_scrolled_window_expose;
217 widget_class->size_request = gtk_scrolled_window_size_request;
218 widget_class->size_allocate = gtk_scrolled_window_size_allocate;
219 widget_class->scroll_event = gtk_scrolled_window_scroll_event;
220 widget_class->focus = gtk_scrolled_window_focus;
222 container_class->add = gtk_scrolled_window_add;
223 container_class->remove = gtk_scrolled_window_remove;
224 container_class->forall = gtk_scrolled_window_forall;
226 class->scrollbar_spacing = DEFAULT_SCROLLBAR_SPACING;
228 class->scroll_child = gtk_scrolled_window_scroll_child;
229 class->move_focus_out = gtk_scrolled_window_move_focus_out;
231 g_object_class_install_property (gobject_class,
233 g_param_spec_object ("hadjustment",
234 _("Horizontal Adjustment"),
235 _("The GtkAdjustment for the horizontal position."),
237 G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
238 g_object_class_install_property (gobject_class,
240 g_param_spec_object ("vadjustment",
241 _("Vertical Adjustment"),
242 _("The GtkAdjustment for the vertical position."),
244 G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
245 g_object_class_install_property (gobject_class,
246 PROP_HSCROLLBAR_POLICY,
247 g_param_spec_enum ("hscrollbar_policy",
248 _("Horizontal Scrollbar Policy"),
249 _("When the horizontal scrollbar is displayed"),
250 GTK_TYPE_POLICY_TYPE,
252 G_PARAM_READABLE | G_PARAM_WRITABLE));
253 g_object_class_install_property (gobject_class,
254 PROP_VSCROLLBAR_POLICY,
255 g_param_spec_enum ("vscrollbar_policy",
256 _("Vertical Scrollbar Policy"),
257 _("When the vertical scrollbar is displayed"),
258 GTK_TYPE_POLICY_TYPE,
260 G_PARAM_READABLE | G_PARAM_WRITABLE));
262 g_object_class_install_property (gobject_class,
263 PROP_WINDOW_PLACEMENT,
264 g_param_spec_enum ("window_placement",
265 _("Window Placement"),
266 _("Where the contents are located with respect to the scrollbars"),
267 GTK_TYPE_CORNER_TYPE,
269 G_PARAM_READABLE | G_PARAM_WRITABLE));
270 g_object_class_install_property (gobject_class,
272 g_param_spec_enum ("shadow_type",
274 _("Style of bevel around the contents"),
275 GTK_TYPE_SHADOW_TYPE,
277 G_PARAM_READABLE | G_PARAM_WRITABLE));
279 signals[SCROLL_CHILD] =
280 g_signal_new ("scroll_child",
281 G_TYPE_FROM_CLASS (object_class),
282 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
283 G_STRUCT_OFFSET (GtkScrolledWindowClass, scroll_child),
285 _gtk_marshal_VOID__ENUM_BOOLEAN,
287 GTK_TYPE_SCROLL_TYPE,
289 signals[MOVE_FOCUS_OUT] =
290 g_signal_new ("move_focus_out",
291 G_TYPE_FROM_CLASS (object_class),
292 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
293 G_STRUCT_OFFSET (GtkScrolledWindowClass, move_focus_out),
295 _gtk_marshal_VOID__ENUM,
297 GTK_TYPE_DIRECTION_TYPE);
299 binding_set = gtk_binding_set_by_class (class);
301 add_scroll_binding (binding_set, GDK_Left, GDK_CONTROL_MASK, GTK_SCROLL_STEP_BACKWARD, TRUE);
302 add_scroll_binding (binding_set, GDK_Right, GDK_CONTROL_MASK, GTK_SCROLL_STEP_FORWARD, TRUE);
303 add_scroll_binding (binding_set, GDK_Up, GDK_CONTROL_MASK, GTK_SCROLL_STEP_BACKWARD, FALSE);
304 add_scroll_binding (binding_set, GDK_Down, GDK_CONTROL_MASK, GTK_SCROLL_STEP_FORWARD, FALSE);
306 add_scroll_binding (binding_set, GDK_Page_Up, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_BACKWARD, TRUE);
307 add_scroll_binding (binding_set, GDK_Page_Down, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_FORWARD, TRUE);
308 add_scroll_binding (binding_set, GDK_Page_Up, 0, GTK_SCROLL_PAGE_BACKWARD, FALSE);
309 add_scroll_binding (binding_set, GDK_Page_Down, 0, GTK_SCROLL_PAGE_FORWARD, FALSE);
311 add_scroll_binding (binding_set, GDK_Home, GDK_CONTROL_MASK, GTK_SCROLL_START, TRUE);
312 add_scroll_binding (binding_set, GDK_End, GDK_CONTROL_MASK, GTK_SCROLL_END, TRUE);
313 add_scroll_binding (binding_set, GDK_Home, 0, GTK_SCROLL_START, FALSE);
314 add_scroll_binding (binding_set, GDK_End, 0, GTK_SCROLL_END, FALSE);
316 add_tab_bindings (binding_set, GDK_CONTROL_MASK, GTK_DIR_TAB_FORWARD);
317 add_tab_bindings (binding_set, GDK_CONTROL_MASK | GDK_SHIFT_MASK, GTK_DIR_TAB_BACKWARD);
321 gtk_scrolled_window_init (GtkScrolledWindow *scrolled_window)
323 GTK_WIDGET_SET_FLAGS (scrolled_window, GTK_NO_WINDOW | GTK_CAN_FOCUS);
325 gtk_container_set_resize_mode (GTK_CONTAINER (scrolled_window), GTK_RESIZE_QUEUE);
327 scrolled_window->hscrollbar = NULL;
328 scrolled_window->vscrollbar = NULL;
329 scrolled_window->hscrollbar_policy = GTK_POLICY_ALWAYS;
330 scrolled_window->vscrollbar_policy = GTK_POLICY_ALWAYS;
331 scrolled_window->hscrollbar_visible = FALSE;
332 scrolled_window->vscrollbar_visible = FALSE;
333 scrolled_window->focus_out = FALSE;
334 scrolled_window->window_placement = GTK_CORNER_TOP_LEFT;
339 gtk_scrolled_window_new (GtkAdjustment *hadjustment,
340 GtkAdjustment *vadjustment)
342 GtkWidget *scrolled_window;
345 g_return_val_if_fail (GTK_IS_ADJUSTMENT (hadjustment), NULL);
348 g_return_val_if_fail (GTK_IS_ADJUSTMENT (vadjustment), NULL);
350 scrolled_window = gtk_widget_new (GTK_TYPE_SCROLLED_WINDOW,
351 "hadjustment", hadjustment,
352 "vadjustment", vadjustment,
355 return scrolled_window;
359 gtk_scrolled_window_set_hadjustment (GtkScrolledWindow *scrolled_window,
360 GtkAdjustment *hadjustment)
364 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
366 g_return_if_fail (GTK_IS_ADJUSTMENT (hadjustment));
368 hadjustment = (GtkAdjustment*) gtk_object_new (GTK_TYPE_ADJUSTMENT, NULL);
370 bin = GTK_BIN (scrolled_window);
372 if (!scrolled_window->hscrollbar)
374 gtk_widget_push_composite_child ();
375 scrolled_window->hscrollbar = gtk_hscrollbar_new (hadjustment);
376 gtk_widget_set_composite_name (scrolled_window->hscrollbar, "hscrollbar");
377 gtk_widget_pop_composite_child ();
379 gtk_widget_set_parent (scrolled_window->hscrollbar, GTK_WIDGET (scrolled_window));
380 gtk_widget_ref (scrolled_window->hscrollbar);
381 gtk_widget_show (scrolled_window->hscrollbar);
385 GtkAdjustment *old_adjustment;
387 old_adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
388 if (old_adjustment == hadjustment)
391 gtk_signal_disconnect_by_func (GTK_OBJECT (old_adjustment),
392 GTK_SIGNAL_FUNC (gtk_scrolled_window_adjustment_changed),
394 gtk_range_set_adjustment (GTK_RANGE (scrolled_window->hscrollbar),
397 hadjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
398 gtk_signal_connect (GTK_OBJECT (hadjustment),
400 GTK_SIGNAL_FUNC (gtk_scrolled_window_adjustment_changed),
402 gtk_scrolled_window_adjustment_changed (hadjustment, scrolled_window);
405 gtk_widget_set_scroll_adjustments (bin->child,
406 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
407 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)));
409 g_object_notify (G_OBJECT (scrolled_window), "hadjustment");
413 gtk_scrolled_window_set_vadjustment (GtkScrolledWindow *scrolled_window,
414 GtkAdjustment *vadjustment)
418 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
420 g_return_if_fail (GTK_IS_ADJUSTMENT (vadjustment));
422 vadjustment = (GtkAdjustment*) gtk_object_new (GTK_TYPE_ADJUSTMENT, NULL);
424 bin = GTK_BIN (scrolled_window);
426 if (!scrolled_window->vscrollbar)
428 gtk_widget_push_composite_child ();
429 scrolled_window->vscrollbar = gtk_vscrollbar_new (vadjustment);
430 gtk_widget_set_composite_name (scrolled_window->vscrollbar, "vscrollbar");
431 gtk_widget_pop_composite_child ();
433 gtk_widget_set_parent (scrolled_window->vscrollbar, GTK_WIDGET (scrolled_window));
434 gtk_widget_ref (scrolled_window->vscrollbar);
435 gtk_widget_show (scrolled_window->vscrollbar);
439 GtkAdjustment *old_adjustment;
441 old_adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
442 if (old_adjustment == vadjustment)
445 gtk_signal_disconnect_by_func (GTK_OBJECT (old_adjustment),
446 GTK_SIGNAL_FUNC (gtk_scrolled_window_adjustment_changed),
448 gtk_range_set_adjustment (GTK_RANGE (scrolled_window->vscrollbar),
451 vadjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
452 gtk_signal_connect (GTK_OBJECT (vadjustment),
454 GTK_SIGNAL_FUNC (gtk_scrolled_window_adjustment_changed),
456 gtk_scrolled_window_adjustment_changed (vadjustment, scrolled_window);
459 gtk_widget_set_scroll_adjustments (bin->child,
460 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
461 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)));
463 g_object_notify (G_OBJECT (scrolled_window), "vadjustment");
467 gtk_scrolled_window_get_hadjustment (GtkScrolledWindow *scrolled_window)
469 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
471 return (scrolled_window->hscrollbar ?
472 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)) :
477 gtk_scrolled_window_get_vadjustment (GtkScrolledWindow *scrolled_window)
479 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
481 return (scrolled_window->vscrollbar ?
482 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)) :
487 gtk_scrolled_window_set_policy (GtkScrolledWindow *scrolled_window,
488 GtkPolicyType hscrollbar_policy,
489 GtkPolicyType vscrollbar_policy)
491 GObject *object = G_OBJECT (scrolled_window);
493 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
495 if ((scrolled_window->hscrollbar_policy != hscrollbar_policy) ||
496 (scrolled_window->vscrollbar_policy != vscrollbar_policy))
498 scrolled_window->hscrollbar_policy = hscrollbar_policy;
499 scrolled_window->vscrollbar_policy = vscrollbar_policy;
501 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
503 g_object_freeze_notify (object);
504 g_object_notify (object, "hscrollbar_policy");
505 g_object_notify (object, "vscrollbar_policy");
506 g_object_thaw_notify (object);
511 * gtk_scrolled_window_get_policy:
512 * @scrolled_window: a #GtkScrolledWindow
513 * @hscrollbar_policy: location to store the policy for the horizontal scrollbar, or %NULL.
514 * @vscrollbar_policy: location to store the policy for the horizontal scrollbar, or %NULL.
516 * Retrieves the current policy values for the horizontal and vertical
517 * scrollbars. See gtk_scrolled_window_set_policy().
520 gtk_scrolled_window_get_policy (GtkScrolledWindow *scrolled_window,
521 GtkPolicyType *hscrollbar_policy,
522 GtkPolicyType *vscrollbar_policy)
524 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
526 if (hscrollbar_policy)
527 *hscrollbar_policy = scrolled_window->hscrollbar_policy;
528 if (vscrollbar_policy)
529 *vscrollbar_policy = scrolled_window->vscrollbar_policy;
533 gtk_scrolled_window_set_placement (GtkScrolledWindow *scrolled_window,
534 GtkCornerType window_placement)
536 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
538 if (scrolled_window->window_placement != window_placement)
540 scrolled_window->window_placement = window_placement;
542 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
544 g_object_notify (G_OBJECT (scrolled_window), "window_placement");
549 * gtk_scrolled_window_get_placement:
550 * @scrolled_window: a #GtkScrolledWindow
552 * Gets the placement of the scrollbars for the scrolled window. See
553 * gtk_scrolled_window_set_placement().
555 * Return value: the current placement value.
558 gtk_scrolled_window_get_placement (GtkScrolledWindow *scrolled_window)
560 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), GTK_CORNER_TOP_LEFT);
562 return scrolled_window->window_placement;
566 * gtk_scrolled_window_set_shadow_type:
567 * @scrolled_window: a #GtkScrolledWindow
568 * @type: kind of shadow to draw around scrolled window contents
570 * Changes the type of shadow drawn around the contents of
575 gtk_scrolled_window_set_shadow_type (GtkScrolledWindow *scrolled_window,
578 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
579 g_return_if_fail (type >= GTK_SHADOW_NONE && type <= GTK_SHADOW_ETCHED_OUT);
581 if (scrolled_window->shadow_type != type)
583 scrolled_window->shadow_type = type;
585 if (GTK_WIDGET_DRAWABLE (scrolled_window))
586 gtk_widget_queue_clear (GTK_WIDGET (scrolled_window));
588 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
590 g_object_notify (G_OBJECT (scrolled_window), "shadow_type");
595 * gtk_scrolled_window_get_shadow_type:
596 * @scrolled_window: a #GtkScrolledWindow
598 * Gets the shadow type of the scrolled window. See
599 * gtk_scrolled_window_set_shadow_type().
601 * Return value: the current shadow type
604 gtk_scrolled_window_get_shadow_type (GtkScrolledWindow *scrolled_window)
606 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), GTK_SHADOW_NONE);
608 return scrolled_window->shadow_type;
612 gtk_scrolled_window_destroy (GtkObject *object)
614 GtkScrolledWindow *scrolled_window;
616 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (object));
618 scrolled_window = GTK_SCROLLED_WINDOW (object);
620 gtk_widget_unparent (scrolled_window->hscrollbar);
621 gtk_widget_unparent (scrolled_window->vscrollbar);
622 gtk_widget_destroy (scrolled_window->hscrollbar);
623 gtk_widget_destroy (scrolled_window->vscrollbar);
625 GTK_OBJECT_CLASS (parent_class)->destroy (object);
629 gtk_scrolled_window_finalize (GObject *object)
631 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
633 gtk_widget_unref (scrolled_window->hscrollbar);
634 gtk_widget_unref (scrolled_window->vscrollbar);
636 G_OBJECT_CLASS (parent_class)->finalize (object);
640 gtk_scrolled_window_set_property (GObject *object,
645 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
649 case PROP_HADJUSTMENT:
650 gtk_scrolled_window_set_hadjustment (scrolled_window,
651 g_value_get_object (value));
653 case PROP_VADJUSTMENT:
654 gtk_scrolled_window_set_vadjustment (scrolled_window,
655 g_value_get_object (value));
657 case PROP_HSCROLLBAR_POLICY:
658 gtk_scrolled_window_set_policy (scrolled_window,
659 g_value_get_enum (value),
660 scrolled_window->vscrollbar_policy);
662 case PROP_VSCROLLBAR_POLICY:
663 gtk_scrolled_window_set_policy (scrolled_window,
664 scrolled_window->hscrollbar_policy,
665 g_value_get_enum (value));
667 case PROP_WINDOW_PLACEMENT:
668 gtk_scrolled_window_set_placement (scrolled_window,
669 g_value_get_enum (value));
671 case PROP_SHADOW_TYPE:
672 gtk_scrolled_window_set_shadow_type (scrolled_window,
673 g_value_get_enum (value));
676 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
682 gtk_scrolled_window_get_property (GObject *object,
687 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
691 case PROP_HADJUSTMENT:
692 g_value_set_object (value,
693 G_OBJECT (gtk_scrolled_window_get_hadjustment (scrolled_window)));
695 case PROP_VADJUSTMENT:
696 g_value_set_object (value,
697 G_OBJECT (gtk_scrolled_window_get_vadjustment (scrolled_window)));
699 case PROP_HSCROLLBAR_POLICY:
700 g_value_set_enum (value, scrolled_window->hscrollbar_policy);
702 case PROP_VSCROLLBAR_POLICY:
703 g_value_set_enum (value, scrolled_window->vscrollbar_policy);
705 case PROP_WINDOW_PLACEMENT:
706 g_value_set_enum (value, scrolled_window->window_placement);
708 case PROP_SHADOW_TYPE:
709 g_value_set_enum (value, scrolled_window->shadow_type);
712 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
718 gtk_scrolled_window_paint (GtkWidget *widget,
721 GtkAllocation relative_allocation;
722 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (widget);
724 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
726 gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
728 relative_allocation.x -= widget->style->xthickness;
729 relative_allocation.y -= widget->style->ythickness;
730 relative_allocation.width += 2 * widget->style->xthickness;
731 relative_allocation.height += 2 * widget->style->ythickness;
733 gtk_paint_shadow (widget->style, widget->window,
734 GTK_STATE_NORMAL, scrolled_window->shadow_type,
735 area, widget, "scrolled_window",
736 widget->allocation.x + relative_allocation.x,
737 widget->allocation.y + relative_allocation.y,
738 relative_allocation.width,
739 relative_allocation.height);
744 gtk_scrolled_window_expose (GtkWidget *widget,
745 GdkEventExpose *event)
747 if (GTK_WIDGET_DRAWABLE (widget))
749 gtk_scrolled_window_paint (widget, &event->area);
751 (* GTK_WIDGET_CLASS (parent_class)->expose_event) (widget, event);
758 gtk_scrolled_window_forall (GtkContainer *container,
759 gboolean include_internals,
760 GtkCallback callback,
761 gpointer callback_data)
763 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (container));
764 g_return_if_fail (callback != NULL);
766 GTK_CONTAINER_CLASS (parent_class)->forall (container,
770 if (include_internals)
772 GtkScrolledWindow *scrolled_window;
774 scrolled_window = GTK_SCROLLED_WINDOW (container);
776 if (scrolled_window->vscrollbar)
777 callback (scrolled_window->vscrollbar, callback_data);
778 if (scrolled_window->hscrollbar)
779 callback (scrolled_window->hscrollbar, callback_data);
784 gtk_scrolled_window_scroll_child (GtkScrolledWindow *scrolled_window,
785 GtkScrollType scroll,
788 GtkAdjustment *adjustment = NULL;
792 case GTK_SCROLL_STEP_UP:
793 scroll = GTK_SCROLL_STEP_BACKWARD;
796 case GTK_SCROLL_STEP_DOWN:
797 scroll = GTK_SCROLL_STEP_FORWARD;
800 case GTK_SCROLL_STEP_LEFT:
801 scroll = GTK_SCROLL_STEP_BACKWARD;
804 case GTK_SCROLL_STEP_RIGHT:
805 scroll = GTK_SCROLL_STEP_FORWARD;
808 case GTK_SCROLL_PAGE_UP:
809 scroll = GTK_SCROLL_PAGE_BACKWARD;
812 case GTK_SCROLL_PAGE_DOWN:
813 scroll = GTK_SCROLL_PAGE_FORWARD;
816 case GTK_SCROLL_PAGE_LEFT:
817 scroll = GTK_SCROLL_STEP_BACKWARD;
820 case GTK_SCROLL_PAGE_RIGHT:
821 scroll = GTK_SCROLL_STEP_FORWARD;
824 case GTK_SCROLL_STEP_BACKWARD:
825 case GTK_SCROLL_STEP_FORWARD:
826 case GTK_SCROLL_PAGE_BACKWARD:
827 case GTK_SCROLL_PAGE_FORWARD:
828 case GTK_SCROLL_START:
832 g_warning ("Invalid scroll type %d for GtkSpinButton::change-value", scroll);
838 if (scrolled_window->hscrollbar)
839 adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
843 if (scrolled_window->vscrollbar)
844 adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
849 gdouble value = adjustment->value;
853 case GTK_SCROLL_STEP_FORWARD:
854 value += adjustment->step_increment;
856 case GTK_SCROLL_STEP_BACKWARD:
857 value -= adjustment->step_increment;
859 case GTK_SCROLL_PAGE_FORWARD:
860 value += adjustment->page_increment;
862 case GTK_SCROLL_PAGE_BACKWARD:
863 value -= adjustment->page_increment;
865 case GTK_SCROLL_START:
866 value = adjustment->lower;
869 value = adjustment->upper;
872 g_assert_not_reached ();
876 value = CLAMP (value, adjustment->lower, adjustment->upper - adjustment->page_size);
878 gtk_adjustment_set_value (adjustment, value);
883 gtk_scrolled_window_move_focus_out (GtkScrolledWindow *scrolled_window,
884 GtkDirectionType direction_type)
888 /* Focus out of the scrolled window entirely. We do this by setting
889 * a flag, then propagating the focus motion to the notebook.
891 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (scrolled_window));
892 if (!GTK_WIDGET_TOPLEVEL (toplevel))
895 g_object_ref (scrolled_window);
897 scrolled_window->focus_out = TRUE;
898 g_signal_emit_by_name (G_OBJECT (toplevel), "move_focus", direction_type);
899 scrolled_window->focus_out = FALSE;
901 g_object_unref (scrolled_window);
905 gtk_scrolled_window_size_request (GtkWidget *widget,
906 GtkRequisition *requisition)
908 GtkScrolledWindow *scrolled_window;
912 GtkRequisition hscrollbar_requisition;
913 GtkRequisition vscrollbar_requisition;
914 GtkRequisition child_requisition;
916 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (widget));
917 g_return_if_fail (requisition != NULL);
919 scrolled_window = GTK_SCROLLED_WINDOW (widget);
920 bin = GTK_BIN (scrolled_window);
924 requisition->width = 0;
925 requisition->height = 0;
927 gtk_widget_size_request (scrolled_window->hscrollbar,
928 &hscrollbar_requisition);
929 gtk_widget_size_request (scrolled_window->vscrollbar,
930 &vscrollbar_requisition);
932 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
934 gtk_widget_size_request (bin->child, &child_requisition);
936 if (scrolled_window->hscrollbar_policy == GTK_POLICY_NEVER)
937 requisition->width += child_requisition.width;
940 GtkWidgetAuxInfo *aux_info = _gtk_widget_get_aux_info (bin->child, FALSE);
942 if (aux_info && aux_info->width > 0)
944 requisition->width += aux_info->width;
948 requisition->width += vscrollbar_requisition.width;
951 if (scrolled_window->vscrollbar_policy == GTK_POLICY_NEVER)
952 requisition->height += child_requisition.height;
955 GtkWidgetAuxInfo *aux_info = _gtk_widget_get_aux_info (bin->child, FALSE);
957 if (aux_info && aux_info->height > 0)
959 requisition->height += aux_info->height;
963 requisition->height += hscrollbar_requisition.height;
967 if (scrolled_window->hscrollbar_policy == GTK_POLICY_AUTOMATIC ||
968 scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS)
970 requisition->width = MAX (requisition->width, hscrollbar_requisition.width);
971 if (!extra_height || scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS)
972 extra_height = SCROLLBAR_SPACING (scrolled_window) + hscrollbar_requisition.height;
975 if (scrolled_window->vscrollbar_policy == GTK_POLICY_AUTOMATIC ||
976 scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS)
978 requisition->height = MAX (requisition->height, vscrollbar_requisition.height);
979 if (!extra_height || scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS)
980 extra_width = SCROLLBAR_SPACING (scrolled_window) + vscrollbar_requisition.width;
983 requisition->width += GTK_CONTAINER (widget)->border_width * 2 + MAX (0, extra_width);
984 requisition->height += GTK_CONTAINER (widget)->border_width * 2 + MAX (0, extra_height);
986 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
988 requisition->width += 2 * widget->style->xthickness;
989 requisition->height += 2 * widget->style->ythickness;
994 gtk_scrolled_window_relative_allocation (GtkWidget *widget,
995 GtkAllocation *allocation)
997 GtkScrolledWindow *scrolled_window;
999 g_return_if_fail (widget != NULL);
1000 g_return_if_fail (allocation != NULL);
1002 scrolled_window = GTK_SCROLLED_WINDOW (widget);
1004 allocation->x = GTK_CONTAINER (widget)->border_width;
1005 allocation->y = GTK_CONTAINER (widget)->border_width;
1007 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1009 allocation->x += widget->style->xthickness;
1010 allocation->y += widget->style->ythickness;
1013 allocation->width = MAX (1, (gint)widget->allocation.width - allocation->x * 2);
1014 allocation->height = MAX (1, (gint)widget->allocation.height - allocation->y * 2);
1016 if (scrolled_window->vscrollbar_visible)
1018 GtkRequisition vscrollbar_requisition;
1019 gtk_widget_get_child_requisition (scrolled_window->vscrollbar,
1020 &vscrollbar_requisition);
1022 if (scrolled_window->window_placement == GTK_CORNER_TOP_RIGHT ||
1023 scrolled_window->window_placement == GTK_CORNER_BOTTOM_RIGHT)
1024 allocation->x += (vscrollbar_requisition.width +
1025 SCROLLBAR_SPACING (scrolled_window));
1027 allocation->width = MAX (1, (gint)allocation->width -
1028 ((gint)vscrollbar_requisition.width +
1029 (gint)SCROLLBAR_SPACING (scrolled_window)));
1031 if (scrolled_window->hscrollbar_visible)
1033 GtkRequisition hscrollbar_requisition;
1034 gtk_widget_get_child_requisition (scrolled_window->hscrollbar,
1035 &hscrollbar_requisition);
1037 if (scrolled_window->window_placement == GTK_CORNER_BOTTOM_LEFT ||
1038 scrolled_window->window_placement == GTK_CORNER_BOTTOM_RIGHT)
1039 allocation->y += (hscrollbar_requisition.height +
1040 SCROLLBAR_SPACING (scrolled_window));
1042 allocation->height = MAX (1, (gint)allocation->height -
1043 ((gint)hscrollbar_requisition.height +
1044 (gint)SCROLLBAR_SPACING (scrolled_window)));
1049 gtk_scrolled_window_size_allocate (GtkWidget *widget,
1050 GtkAllocation *allocation)
1052 GtkScrolledWindow *scrolled_window;
1054 GtkAllocation relative_allocation;
1055 GtkAllocation child_allocation;
1057 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (widget));
1058 g_return_if_fail (allocation != NULL);
1060 scrolled_window = GTK_SCROLLED_WINDOW (widget);
1061 bin = GTK_BIN (scrolled_window);
1063 widget->allocation = *allocation;
1065 if (scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS)
1066 scrolled_window->hscrollbar_visible = TRUE;
1067 else if (scrolled_window->hscrollbar_policy == GTK_POLICY_NEVER)
1068 scrolled_window->hscrollbar_visible = FALSE;
1069 if (scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS)
1070 scrolled_window->vscrollbar_visible = TRUE;
1071 else if (scrolled_window->vscrollbar_policy == GTK_POLICY_NEVER)
1072 scrolled_window->vscrollbar_visible = FALSE;
1074 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
1076 gboolean previous_hvis;
1077 gboolean previous_vvis;
1082 gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
1084 child_allocation.x = relative_allocation.x + allocation->x;
1085 child_allocation.y = relative_allocation.y + allocation->y;
1086 child_allocation.width = relative_allocation.width;
1087 child_allocation.height = relative_allocation.height;
1089 previous_hvis = scrolled_window->hscrollbar_visible;
1090 previous_vvis = scrolled_window->vscrollbar_visible;
1092 gtk_widget_size_allocate (bin->child, &child_allocation);
1094 /* If, after the first iteration, the hscrollbar and the
1095 * vscrollbar flip visiblity, then we need both.
1098 previous_hvis != scrolled_window->hscrollbar_visible &&
1099 previous_vvis != scrolled_window->vscrollbar_visible)
1101 scrolled_window->hscrollbar_visible = TRUE;
1102 scrolled_window->vscrollbar_visible = TRUE;
1104 /* a new resize is already queued at this point,
1105 * so we will immediatedly get reinvoked
1112 while (previous_hvis != scrolled_window->hscrollbar_visible ||
1113 previous_vvis != scrolled_window->vscrollbar_visible);
1116 gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
1118 if (scrolled_window->hscrollbar_visible)
1120 GtkRequisition hscrollbar_requisition;
1121 gtk_widget_get_child_requisition (scrolled_window->hscrollbar,
1122 &hscrollbar_requisition);
1124 if (!GTK_WIDGET_VISIBLE (scrolled_window->hscrollbar))
1125 gtk_widget_show (scrolled_window->hscrollbar);
1127 child_allocation.x = relative_allocation.x;
1128 if (scrolled_window->window_placement == GTK_CORNER_TOP_LEFT ||
1129 scrolled_window->window_placement == GTK_CORNER_TOP_RIGHT)
1130 child_allocation.y = (relative_allocation.y +
1131 relative_allocation.height +
1132 SCROLLBAR_SPACING (scrolled_window) +
1133 (scrolled_window->shadow_type == GTK_SHADOW_NONE ?
1134 0 : widget->style->ythickness));
1136 child_allocation.y = GTK_CONTAINER (scrolled_window)->border_width;
1138 child_allocation.width = relative_allocation.width;
1139 child_allocation.height = hscrollbar_requisition.height;
1140 child_allocation.x += allocation->x;
1141 child_allocation.y += allocation->y;
1143 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1145 child_allocation.x -= widget->style->xthickness;
1146 child_allocation.width += 2 * widget->style->xthickness;
1149 gtk_widget_size_allocate (scrolled_window->hscrollbar, &child_allocation);
1151 else if (GTK_WIDGET_VISIBLE (scrolled_window->hscrollbar))
1152 gtk_widget_hide (scrolled_window->hscrollbar);
1154 if (scrolled_window->vscrollbar_visible)
1156 GtkRequisition vscrollbar_requisition;
1157 if (!GTK_WIDGET_VISIBLE (scrolled_window->vscrollbar))
1158 gtk_widget_show (scrolled_window->vscrollbar);
1160 gtk_widget_get_child_requisition (scrolled_window->vscrollbar,
1161 &vscrollbar_requisition);
1163 if (scrolled_window->window_placement == GTK_CORNER_TOP_LEFT ||
1164 scrolled_window->window_placement == GTK_CORNER_BOTTOM_LEFT)
1165 child_allocation.x = (relative_allocation.x +
1166 relative_allocation.width +
1167 SCROLLBAR_SPACING (scrolled_window) +
1168 (scrolled_window->shadow_type == GTK_SHADOW_NONE ?
1169 0 : widget->style->xthickness));
1171 child_allocation.x = GTK_CONTAINER (scrolled_window)->border_width;
1173 child_allocation.y = relative_allocation.y;
1174 child_allocation.width = vscrollbar_requisition.width;
1175 child_allocation.height = relative_allocation.height;
1176 child_allocation.x += allocation->x;
1177 child_allocation.y += allocation->y;
1179 if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1181 child_allocation.y -= widget->style->ythickness;
1182 child_allocation.height += 2 * widget->style->ythickness;
1185 gtk_widget_size_allocate (scrolled_window->vscrollbar, &child_allocation);
1187 else if (GTK_WIDGET_VISIBLE (scrolled_window->vscrollbar))
1188 gtk_widget_hide (scrolled_window->vscrollbar);
1192 gtk_scrolled_window_scroll_event (GtkWidget *widget,
1193 GdkEventScroll *event)
1197 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (widget), FALSE);
1198 g_return_val_if_fail (event != NULL, FALSE);
1200 if (event->direction == GDK_SCROLL_UP || event->direction == GDK_SCROLL_DOWN)
1201 range = GTK_SCROLLED_WINDOW (widget)->vscrollbar;
1203 range = GTK_SCROLLED_WINDOW (widget)->hscrollbar;
1205 if (range && GTK_WIDGET_VISIBLE (range))
1207 GtkAdjustment *adj = GTK_RANGE (range)->adjustment;
1210 if (event->direction == GDK_SCROLL_UP || event->direction == GDK_SCROLL_LEFT)
1211 new_value = adj->value - adj->page_increment / 2;
1213 new_value = adj->value + adj->page_increment / 2;
1215 new_value = CLAMP (new_value, adj->lower, adj->upper - adj->page_size);
1216 gtk_adjustment_set_value (adj, new_value);
1225 gtk_scrolled_window_focus (GtkWidget *widget,
1226 GtkDirectionType direction)
1228 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (widget);
1229 gboolean had_focus_child = GTK_CONTAINER (widget)->focus_child != NULL;
1231 if (scrolled_window->focus_out)
1233 scrolled_window->focus_out = FALSE; /* Clear this to catch the wrap-around case */
1237 if (gtk_widget_is_focus (widget))
1240 /* We only put the scrolled window itself in the focus chain if it
1241 * isn't possible to focus any children.
1243 if (GTK_BIN (widget)->child)
1245 if (gtk_widget_child_focus (GTK_BIN (widget)->child, direction))
1249 if (!had_focus_child)
1251 gtk_widget_grab_focus (widget);
1259 gtk_scrolled_window_adjustment_changed (GtkAdjustment *adjustment,
1262 GtkScrolledWindow *scrolled_win;
1264 g_return_if_fail (adjustment != NULL);
1265 g_return_if_fail (data != NULL);
1267 scrolled_win = GTK_SCROLLED_WINDOW (data);
1269 if (scrolled_win->hscrollbar &&
1270 adjustment == gtk_range_get_adjustment (GTK_RANGE (scrolled_win->hscrollbar)))
1272 if (scrolled_win->hscrollbar_policy == GTK_POLICY_AUTOMATIC)
1276 visible = scrolled_win->hscrollbar_visible;
1277 scrolled_win->hscrollbar_visible = (adjustment->upper - adjustment->lower >
1278 adjustment->page_size);
1279 if (scrolled_win->hscrollbar_visible != visible)
1280 gtk_widget_queue_resize (GTK_WIDGET (scrolled_win));
1283 else if (scrolled_win->vscrollbar &&
1284 adjustment == gtk_range_get_adjustment (GTK_RANGE (scrolled_win->vscrollbar)))
1286 if (scrolled_win->vscrollbar_policy == GTK_POLICY_AUTOMATIC)
1290 visible = scrolled_win->vscrollbar_visible;
1291 scrolled_win->vscrollbar_visible = (adjustment->upper - adjustment->lower >
1292 adjustment->page_size);
1293 if (scrolled_win->vscrollbar_visible != visible)
1294 gtk_widget_queue_resize (GTK_WIDGET (scrolled_win));
1300 gtk_scrolled_window_add (GtkContainer *container,
1303 GtkScrolledWindow *scrolled_window;
1306 bin = GTK_BIN (container);
1307 g_return_if_fail (bin->child == NULL);
1309 scrolled_window = GTK_SCROLLED_WINDOW (container);
1312 gtk_widget_set_parent (child, GTK_WIDGET (bin));
1314 /* this is a temporary message */
1315 if (!gtk_widget_set_scroll_adjustments (child,
1316 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
1317 gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar))))
1318 g_warning ("gtk_scrolled_window_add(): cannot add non scrollable widget "
1319 "use gtk_scrolled_window_add_with_viewport() instead");
1323 gtk_scrolled_window_remove (GtkContainer *container,
1326 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (container));
1327 g_return_if_fail (child != NULL);
1328 g_return_if_fail (GTK_BIN (container)->child == child);
1330 gtk_widget_set_scroll_adjustments (child, NULL, NULL);
1332 /* chain parent class handler to remove child */
1333 GTK_CONTAINER_CLASS (parent_class)->remove (container, child);
1337 gtk_scrolled_window_add_with_viewport (GtkScrolledWindow *scrolled_window,
1341 GtkWidget *viewport;
1343 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
1344 g_return_if_fail (GTK_IS_WIDGET (child));
1345 g_return_if_fail (child->parent == NULL);
1347 bin = GTK_BIN (scrolled_window);
1349 if (bin->child != NULL)
1351 g_return_if_fail (GTK_IS_VIEWPORT (bin->child));
1352 g_return_if_fail (GTK_BIN (bin->child)->child == NULL);
1354 viewport = bin->child;
1359 gtk_viewport_new (gtk_scrolled_window_get_hadjustment (scrolled_window),
1360 gtk_scrolled_window_get_vadjustment (scrolled_window));
1361 gtk_container_add (GTK_CONTAINER (scrolled_window), viewport);
1364 gtk_widget_show (viewport);
1365 gtk_container_add (GTK_CONTAINER (viewport), child);