]> Pileus Git - ~andy/gtk/blob - gtk/gtkscrolledwindow.c
New internal function returning a good step value for the mouse wheel. For
[~andy/gtk] / gtk / gtkscrolledwindow.c
1 /* GTK - The GIMP Toolkit
2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3  *
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.
8  *
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.
13  *
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.
18  */
19
20 /*
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/. 
25  */
26
27 #include <math.h>
28 #include <gdk/gdkkeysyms.h>
29 #include "gtkbindings.h"
30 #include "gtkmarshalers.h"
31 #include "gtkscrolledwindow.h"
32 #include "gtkintl.h"
33
34
35 /* scrolled window policy and size requisition handling:
36  *
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().
43  *
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).
53  *
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.
58  *
59  * conclusions:
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
65  *    child's dimension.
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.
68  */
69
70 #define DEFAULT_SCROLLBAR_SPACING  3
71
72 enum {
73   PROP_0,
74   PROP_HADJUSTMENT,
75   PROP_VADJUSTMENT,
76   PROP_HSCROLLBAR_POLICY,
77   PROP_VSCROLLBAR_POLICY,
78   PROP_WINDOW_PLACEMENT,
79   PROP_SHADOW_TYPE,
80   PROP_LAST
81 };
82
83 /* Signals */
84 enum
85 {
86   SCROLL_CHILD,
87   MOVE_FOCUS_OUT,
88   LAST_SIGNAL
89 };
90
91 static void gtk_scrolled_window_class_init         (GtkScrolledWindowClass *klass);
92 static void gtk_scrolled_window_init               (GtkScrolledWindow      *scrolled_window);
93 static void gtk_scrolled_window_destroy            (GtkObject              *object);
94 static void gtk_scrolled_window_finalize           (GObject                *object);
95 static void gtk_scrolled_window_set_property       (GObject                *object,
96                                                     guint                   prop_id,
97                                                     const GValue           *value,
98                                                     GParamSpec             *pspec);
99 static void gtk_scrolled_window_get_property       (GObject                *object,
100                                                     guint                   prop_id,
101                                                     GValue                 *value,
102                                                     GParamSpec             *pspec);
103
104 static gint gtk_scrolled_window_expose             (GtkWidget              *widget,
105                                                     GdkEventExpose         *event);
106 static void gtk_scrolled_window_size_request       (GtkWidget              *widget,
107                                                     GtkRequisition         *requisition);
108 static void gtk_scrolled_window_size_allocate      (GtkWidget              *widget,
109                                                     GtkAllocation          *allocation);
110 static gint gtk_scrolled_window_scroll_event       (GtkWidget              *widget,
111                                                     GdkEventScroll         *event);
112 static gint gtk_scrolled_window_focus              (GtkWidget              *widget,
113                                                     GtkDirectionType        direction);
114 static void gtk_scrolled_window_add                (GtkContainer           *container,
115                                                     GtkWidget              *widget);
116 static void gtk_scrolled_window_remove             (GtkContainer           *container,
117                                                     GtkWidget              *widget);
118 static void gtk_scrolled_window_forall             (GtkContainer           *container,
119                                                     gboolean                include_internals,
120                                                     GtkCallback             callback,
121                                                     gpointer                callback_data);
122 static void gtk_scrolled_window_scroll_child       (GtkScrolledWindow      *scrolled_window,
123                                                     GtkScrollType           scroll,
124                                                     gboolean                horizontal);
125 static void gtk_scrolled_window_move_focus_out     (GtkScrolledWindow      *scrolled_window,
126                                                     GtkDirectionType        direction_type);
127
128 static void gtk_scrolled_window_relative_allocation(GtkWidget              *widget,
129                                                     GtkAllocation          *allocation);
130 static void gtk_scrolled_window_adjustment_changed (GtkAdjustment          *adjustment,
131                                                     gpointer                data);
132
133 static GtkContainerClass *parent_class = NULL;
134
135 static guint signals[LAST_SIGNAL] = {0};
136
137 GType
138 gtk_scrolled_window_get_type (void)
139 {
140   static GType scrolled_window_type = 0;
141
142   if (!scrolled_window_type)
143     {
144       static const GTypeInfo scrolled_window_info =
145       {
146         sizeof (GtkScrolledWindowClass),
147         NULL,           /* base_init */
148         NULL,           /* base_finalize */
149         (GClassInitFunc) gtk_scrolled_window_class_init,
150         NULL,           /* class_finalize */
151         NULL,           /* class_data */
152         sizeof (GtkScrolledWindow),
153         0,              /* n_preallocs */
154         (GInstanceInitFunc) gtk_scrolled_window_init,
155       };
156
157       scrolled_window_type =
158         g_type_register_static (GTK_TYPE_BIN, "GtkScrolledWindow",
159                                 &scrolled_window_info, 0);
160     }
161
162   return scrolled_window_type;
163 }
164
165 static void
166 add_scroll_binding (GtkBindingSet  *binding_set,
167                     guint           keyval,
168                     GdkModifierType mask,
169                     GtkScrollType   scroll,
170                     gboolean        horizontal)
171 {
172   guint keypad_keyval = keyval - GDK_Left + GDK_KP_Left;
173   
174   gtk_binding_entry_add_signal (binding_set, keyval, mask,
175                                 "scroll_child", 2,
176                                 GTK_TYPE_SCROLL_TYPE, scroll,
177                                 G_TYPE_BOOLEAN, horizontal);
178   gtk_binding_entry_add_signal (binding_set, keypad_keyval, mask,
179                                 "scroll_child", 2,
180                                 GTK_TYPE_SCROLL_TYPE, scroll,
181                                 G_TYPE_BOOLEAN, horizontal);
182 }
183
184 static void
185 add_tab_bindings (GtkBindingSet    *binding_set,
186                   GdkModifierType   modifiers,
187                   GtkDirectionType  direction)
188 {
189   gtk_binding_entry_add_signal (binding_set, GDK_Tab, modifiers,
190                                 "move_focus_out", 1,
191                                 GTK_TYPE_DIRECTION_TYPE, direction);
192   gtk_binding_entry_add_signal (binding_set, GDK_KP_Tab, modifiers,
193                                 "move_focus_out", 1,
194                                 GTK_TYPE_DIRECTION_TYPE, direction);
195 }
196
197 static void
198 gtk_scrolled_window_class_init (GtkScrolledWindowClass *class)
199 {
200   GObjectClass *gobject_class = G_OBJECT_CLASS (class);
201   GtkObjectClass *object_class;
202   GtkWidgetClass *widget_class;
203   GtkContainerClass *container_class;
204   GtkBindingSet *binding_set;
205
206   object_class = (GtkObjectClass*) class;
207   widget_class = (GtkWidgetClass*) class;
208   container_class = (GtkContainerClass*) class;
209
210   parent_class = g_type_class_peek_parent (class);
211
212   gobject_class->finalize = gtk_scrolled_window_finalize;
213   gobject_class->set_property = gtk_scrolled_window_set_property;
214   gobject_class->get_property = gtk_scrolled_window_get_property;
215
216   object_class->destroy = gtk_scrolled_window_destroy;
217
218   widget_class->expose_event = gtk_scrolled_window_expose;
219   widget_class->size_request = gtk_scrolled_window_size_request;
220   widget_class->size_allocate = gtk_scrolled_window_size_allocate;
221   widget_class->scroll_event = gtk_scrolled_window_scroll_event;
222   widget_class->focus = gtk_scrolled_window_focus;
223
224   container_class->add = gtk_scrolled_window_add;
225   container_class->remove = gtk_scrolled_window_remove;
226   container_class->forall = gtk_scrolled_window_forall;
227
228   class->scrollbar_spacing = -1;
229
230   class->scroll_child = gtk_scrolled_window_scroll_child;
231   class->move_focus_out = gtk_scrolled_window_move_focus_out;
232   
233   g_object_class_install_property (gobject_class,
234                                    PROP_HADJUSTMENT,
235                                    g_param_spec_object ("hadjustment",
236                                                         P_("Horizontal Adjustment"),
237                                                         P_("The GtkAdjustment for the horizontal position"),
238                                                         GTK_TYPE_ADJUSTMENT,
239                                                         G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
240   g_object_class_install_property (gobject_class,
241                                    PROP_VADJUSTMENT,
242                                    g_param_spec_object ("vadjustment",
243                                                         P_("Vertical Adjustment"),
244                                                         P_("The GtkAdjustment for the vertical position"),
245                                                         GTK_TYPE_ADJUSTMENT,
246                                                         G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
247   g_object_class_install_property (gobject_class,
248                                    PROP_HSCROLLBAR_POLICY,
249                                    g_param_spec_enum ("hscrollbar_policy",
250                                                       P_("Horizontal Scrollbar Policy"),
251                                                       P_("When the horizontal scrollbar is displayed"),
252                                                       GTK_TYPE_POLICY_TYPE,
253                                                       GTK_POLICY_ALWAYS,
254                                                       G_PARAM_READABLE | G_PARAM_WRITABLE));
255   g_object_class_install_property (gobject_class,
256                                    PROP_VSCROLLBAR_POLICY,
257                                    g_param_spec_enum ("vscrollbar_policy",
258                                                       P_("Vertical Scrollbar Policy"),
259                                                       P_("When the vertical scrollbar is displayed"),
260                                                       GTK_TYPE_POLICY_TYPE,
261                                                       GTK_POLICY_ALWAYS,
262                                                       G_PARAM_READABLE | G_PARAM_WRITABLE));
263
264   g_object_class_install_property (gobject_class,
265                                    PROP_WINDOW_PLACEMENT,
266                                    g_param_spec_enum ("window_placement",
267                                                       P_("Window Placement"),
268                                                       P_("Where the contents are located with respect to the scrollbars"),
269                                                       GTK_TYPE_CORNER_TYPE,
270                                                       GTK_CORNER_TOP_LEFT,
271                                                       G_PARAM_READABLE | G_PARAM_WRITABLE));
272   g_object_class_install_property (gobject_class,
273                                    PROP_SHADOW_TYPE,
274                                    g_param_spec_enum ("shadow_type",
275                                                       P_("Shadow Type"),
276                                                       P_("Style of bevel around the contents"),
277                                                       GTK_TYPE_SHADOW_TYPE,
278                                                       GTK_SHADOW_NONE,
279                                                       G_PARAM_READABLE | G_PARAM_WRITABLE));
280
281   gtk_widget_class_install_style_property (widget_class,
282                                            g_param_spec_int ("scrollbar_spacing",
283                                                              P_("Scrollbar spacing"),
284                                                              P_("Number of pixels between the scrollbars and the scrolled window"),
285                                                              0,
286                                                              G_MAXINT,
287                                                              DEFAULT_SCROLLBAR_SPACING,
288                                                              G_PARAM_READABLE));
289
290   signals[SCROLL_CHILD] =
291     g_signal_new ("scroll_child",
292                   G_TYPE_FROM_CLASS (object_class),
293                   G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
294                   G_STRUCT_OFFSET (GtkScrolledWindowClass, scroll_child),
295                   NULL, NULL,
296                   _gtk_marshal_VOID__ENUM_BOOLEAN,
297                   G_TYPE_NONE, 2,
298                   GTK_TYPE_SCROLL_TYPE,
299                   G_TYPE_BOOLEAN);
300   signals[MOVE_FOCUS_OUT] =
301     g_signal_new ("move_focus_out",
302                   G_TYPE_FROM_CLASS (object_class),
303                   G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
304                   G_STRUCT_OFFSET (GtkScrolledWindowClass, move_focus_out),
305                   NULL, NULL,
306                   _gtk_marshal_VOID__ENUM,
307                   G_TYPE_NONE, 1,
308                   GTK_TYPE_DIRECTION_TYPE);
309   
310   binding_set = gtk_binding_set_by_class (class);
311
312   add_scroll_binding (binding_set, GDK_Left,  GDK_CONTROL_MASK, GTK_SCROLL_STEP_BACKWARD, TRUE);
313   add_scroll_binding (binding_set, GDK_Right, GDK_CONTROL_MASK, GTK_SCROLL_STEP_FORWARD,  TRUE);
314   add_scroll_binding (binding_set, GDK_Up,    GDK_CONTROL_MASK, GTK_SCROLL_STEP_BACKWARD, FALSE);
315   add_scroll_binding (binding_set, GDK_Down,  GDK_CONTROL_MASK, GTK_SCROLL_STEP_FORWARD,  FALSE);
316
317   add_scroll_binding (binding_set, GDK_Page_Up,   GDK_CONTROL_MASK, GTK_SCROLL_PAGE_BACKWARD, TRUE);
318   add_scroll_binding (binding_set, GDK_Page_Down, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_FORWARD,  TRUE);
319   add_scroll_binding (binding_set, GDK_Page_Up,   0,                GTK_SCROLL_PAGE_BACKWARD, FALSE);
320   add_scroll_binding (binding_set, GDK_Page_Down, 0,                GTK_SCROLL_PAGE_FORWARD,  FALSE);
321
322   add_scroll_binding (binding_set, GDK_Home, GDK_CONTROL_MASK, GTK_SCROLL_START, TRUE);
323   add_scroll_binding (binding_set, GDK_End,  GDK_CONTROL_MASK, GTK_SCROLL_END,   TRUE);
324   add_scroll_binding (binding_set, GDK_Home, 0,                GTK_SCROLL_START, FALSE);
325   add_scroll_binding (binding_set, GDK_End,  0,                GTK_SCROLL_END,   FALSE);
326
327   add_tab_bindings (binding_set, GDK_CONTROL_MASK, GTK_DIR_TAB_FORWARD);
328   add_tab_bindings (binding_set, GDK_CONTROL_MASK | GDK_SHIFT_MASK, GTK_DIR_TAB_BACKWARD);
329 }
330
331 static void
332 gtk_scrolled_window_init (GtkScrolledWindow *scrolled_window)
333 {
334   GTK_WIDGET_SET_FLAGS (scrolled_window, GTK_NO_WINDOW | GTK_CAN_FOCUS);
335
336   scrolled_window->hscrollbar = NULL;
337   scrolled_window->vscrollbar = NULL;
338   scrolled_window->hscrollbar_policy = GTK_POLICY_ALWAYS;
339   scrolled_window->vscrollbar_policy = GTK_POLICY_ALWAYS;
340   scrolled_window->hscrollbar_visible = FALSE;
341   scrolled_window->vscrollbar_visible = FALSE;
342   scrolled_window->focus_out = FALSE;
343   scrolled_window->window_placement = GTK_CORNER_TOP_LEFT;
344   
345 }
346
347 GtkWidget*
348 gtk_scrolled_window_new (GtkAdjustment *hadjustment,
349                          GtkAdjustment *vadjustment)
350 {
351   GtkWidget *scrolled_window;
352
353   if (hadjustment)
354     g_return_val_if_fail (GTK_IS_ADJUSTMENT (hadjustment), NULL);
355
356   if (vadjustment)
357     g_return_val_if_fail (GTK_IS_ADJUSTMENT (vadjustment), NULL);
358
359   scrolled_window = gtk_widget_new (GTK_TYPE_SCROLLED_WINDOW,
360                                     "hadjustment", hadjustment,
361                                     "vadjustment", vadjustment,
362                                     NULL);
363
364   return scrolled_window;
365 }
366
367 void
368 gtk_scrolled_window_set_hadjustment (GtkScrolledWindow *scrolled_window,
369                                      GtkAdjustment     *hadjustment)
370 {
371   GtkBin *bin;
372
373   g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
374   if (hadjustment)
375     g_return_if_fail (GTK_IS_ADJUSTMENT (hadjustment));
376   else
377     hadjustment = (GtkAdjustment*) g_object_new (GTK_TYPE_ADJUSTMENT, NULL);
378
379   bin = GTK_BIN (scrolled_window);
380
381   if (!scrolled_window->hscrollbar)
382     {
383       gtk_widget_push_composite_child ();
384       scrolled_window->hscrollbar = gtk_hscrollbar_new (hadjustment);
385       gtk_widget_set_composite_name (scrolled_window->hscrollbar, "hscrollbar");
386       gtk_widget_pop_composite_child ();
387
388       gtk_widget_set_parent (scrolled_window->hscrollbar, GTK_WIDGET (scrolled_window));
389       g_object_ref (scrolled_window->hscrollbar);
390       gtk_widget_show (scrolled_window->hscrollbar);
391     }
392   else
393     {
394       GtkAdjustment *old_adjustment;
395       
396       old_adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
397       if (old_adjustment == hadjustment)
398         return;
399
400       g_signal_handlers_disconnect_by_func (old_adjustment,
401                                             gtk_scrolled_window_adjustment_changed,
402                                             scrolled_window);
403       gtk_range_set_adjustment (GTK_RANGE (scrolled_window->hscrollbar),
404                                 hadjustment);
405     }
406   hadjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
407   g_signal_connect (hadjustment,
408                     "changed",
409                     G_CALLBACK (gtk_scrolled_window_adjustment_changed),
410                     scrolled_window);
411   gtk_scrolled_window_adjustment_changed (hadjustment, scrolled_window);
412   
413   if (bin->child)
414     gtk_widget_set_scroll_adjustments (bin->child,
415                                        gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
416                                        gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)));
417
418   g_object_notify (G_OBJECT (scrolled_window), "hadjustment");
419 }
420
421 void
422 gtk_scrolled_window_set_vadjustment (GtkScrolledWindow *scrolled_window,
423                                      GtkAdjustment     *vadjustment)
424 {
425   GtkBin *bin;
426
427   g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
428   if (vadjustment)
429     g_return_if_fail (GTK_IS_ADJUSTMENT (vadjustment));
430   else
431     vadjustment = (GtkAdjustment*) g_object_new (GTK_TYPE_ADJUSTMENT, NULL);
432
433   bin = GTK_BIN (scrolled_window);
434
435   if (!scrolled_window->vscrollbar)
436     {
437       gtk_widget_push_composite_child ();
438       scrolled_window->vscrollbar = gtk_vscrollbar_new (vadjustment);
439       gtk_widget_set_composite_name (scrolled_window->vscrollbar, "vscrollbar");
440       gtk_widget_pop_composite_child ();
441
442       gtk_widget_set_parent (scrolled_window->vscrollbar, GTK_WIDGET (scrolled_window));
443       g_object_ref (scrolled_window->vscrollbar);
444       gtk_widget_show (scrolled_window->vscrollbar);
445     }
446   else
447     {
448       GtkAdjustment *old_adjustment;
449       
450       old_adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
451       if (old_adjustment == vadjustment)
452         return;
453
454       g_signal_handlers_disconnect_by_func (old_adjustment,
455                                             gtk_scrolled_window_adjustment_changed,
456                                             scrolled_window);
457       gtk_range_set_adjustment (GTK_RANGE (scrolled_window->vscrollbar),
458                                 vadjustment);
459     }
460   vadjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
461   g_signal_connect (vadjustment,
462                     "changed",
463                     G_CALLBACK (gtk_scrolled_window_adjustment_changed),
464                     scrolled_window);
465   gtk_scrolled_window_adjustment_changed (vadjustment, scrolled_window);
466
467   if (bin->child)
468     gtk_widget_set_scroll_adjustments (bin->child,
469                                        gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
470                                        gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)));
471
472   g_object_notify (G_OBJECT (scrolled_window), "vadjustment");
473 }
474
475 GtkAdjustment*
476 gtk_scrolled_window_get_hadjustment (GtkScrolledWindow *scrolled_window)
477 {
478   g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
479
480   return (scrolled_window->hscrollbar ?
481           gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)) :
482           NULL);
483 }
484
485 GtkAdjustment*
486 gtk_scrolled_window_get_vadjustment (GtkScrolledWindow *scrolled_window)
487 {
488   g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
489
490   return (scrolled_window->vscrollbar ?
491           gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar)) :
492           NULL);
493 }
494
495 void
496 gtk_scrolled_window_set_policy (GtkScrolledWindow *scrolled_window,
497                                 GtkPolicyType      hscrollbar_policy,
498                                 GtkPolicyType      vscrollbar_policy)
499 {
500   GObject *object = G_OBJECT (scrolled_window);
501   
502   g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
503
504   if ((scrolled_window->hscrollbar_policy != hscrollbar_policy) ||
505       (scrolled_window->vscrollbar_policy != vscrollbar_policy))
506     {
507       scrolled_window->hscrollbar_policy = hscrollbar_policy;
508       scrolled_window->vscrollbar_policy = vscrollbar_policy;
509
510       gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
511
512       g_object_freeze_notify (object);
513       g_object_notify (object, "hscrollbar_policy");
514       g_object_notify (object, "vscrollbar_policy");
515       g_object_thaw_notify (object);
516     }
517 }
518
519 /**
520  * gtk_scrolled_window_get_policy:
521  * @scrolled_window: a #GtkScrolledWindow
522  * @hscrollbar_policy: location to store the policy for the horizontal scrollbar, or %NULL.
523  * @vscrollbar_policy: location to store the policy for the horizontal scrollbar, or %NULL.
524  * 
525  * Retrieves the current policy values for the horizontal and vertical
526  * scrollbars. See gtk_scrolled_window_set_policy().
527  **/
528 void
529 gtk_scrolled_window_get_policy (GtkScrolledWindow *scrolled_window,
530                                 GtkPolicyType     *hscrollbar_policy,
531                                 GtkPolicyType     *vscrollbar_policy)
532 {
533   g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
534
535   if (hscrollbar_policy)
536     *hscrollbar_policy = scrolled_window->hscrollbar_policy;
537   if (vscrollbar_policy)
538     *vscrollbar_policy = scrolled_window->vscrollbar_policy;
539 }
540
541 void
542 gtk_scrolled_window_set_placement (GtkScrolledWindow *scrolled_window,
543                                    GtkCornerType      window_placement)
544 {
545   g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
546
547   if (scrolled_window->window_placement != window_placement)
548     {
549       scrolled_window->window_placement = window_placement;
550
551       gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
552       
553       g_object_notify (G_OBJECT (scrolled_window), "window_placement");
554     }
555 }
556
557 /**
558  * gtk_scrolled_window_get_placement:
559  * @scrolled_window: a #GtkScrolledWindow
560  *
561  * Gets the placement of the scrollbars for the scrolled window. See 
562  * gtk_scrolled_window_set_placement().
563  *
564  * Return value: the current placement value.
565  **/
566 GtkCornerType
567 gtk_scrolled_window_get_placement (GtkScrolledWindow *scrolled_window)
568 {
569   g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), GTK_CORNER_TOP_LEFT);
570
571   return scrolled_window->window_placement;
572 }
573
574 /**
575  * gtk_scrolled_window_set_shadow_type:
576  * @scrolled_window: a #GtkScrolledWindow
577  * @type: kind of shadow to draw around scrolled window contents
578  *
579  * Changes the type of shadow drawn around the contents of
580  * @scrolled_window.
581  * 
582  **/
583 void
584 gtk_scrolled_window_set_shadow_type (GtkScrolledWindow *scrolled_window,
585                                      GtkShadowType      type)
586 {
587   g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
588   g_return_if_fail (type >= GTK_SHADOW_NONE && type <= GTK_SHADOW_ETCHED_OUT);
589   
590   if (scrolled_window->shadow_type != type)
591     {
592       scrolled_window->shadow_type = type;
593
594       if (GTK_WIDGET_DRAWABLE (scrolled_window))
595         gtk_widget_queue_draw (GTK_WIDGET (scrolled_window));
596
597       gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
598
599       g_object_notify (G_OBJECT (scrolled_window), "shadow_type");
600     }
601 }
602
603 /**
604  * gtk_scrolled_window_get_shadow_type:
605  * @scrolled_window: a #GtkScrolledWindow
606  *
607  * Gets the shadow type of the scrolled window. See 
608  * gtk_scrolled_window_set_shadow_type().
609  *
610  * Return value: the current shadow type
611  **/
612 GtkShadowType
613 gtk_scrolled_window_get_shadow_type (GtkScrolledWindow *scrolled_window)
614 {
615   g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), GTK_SHADOW_NONE);
616
617   return scrolled_window->shadow_type;
618 }
619
620 static void
621 gtk_scrolled_window_destroy (GtkObject *object)
622 {
623   GtkScrolledWindow *scrolled_window;
624
625   g_return_if_fail (GTK_IS_SCROLLED_WINDOW (object));
626
627   scrolled_window = GTK_SCROLLED_WINDOW (object);
628
629   gtk_widget_unparent (scrolled_window->hscrollbar);
630   gtk_widget_unparent (scrolled_window->vscrollbar);
631   gtk_widget_destroy (scrolled_window->hscrollbar);
632   gtk_widget_destroy (scrolled_window->vscrollbar);
633
634   GTK_OBJECT_CLASS (parent_class)->destroy (object);
635 }
636
637 static void
638 gtk_scrolled_window_finalize (GObject *object)
639 {
640   GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
641
642   g_object_unref (scrolled_window->hscrollbar);
643   g_object_unref (scrolled_window->vscrollbar);
644
645   G_OBJECT_CLASS (parent_class)->finalize (object);
646 }
647
648 static void
649 gtk_scrolled_window_set_property (GObject      *object,
650                                   guint         prop_id,
651                                   const GValue *value,
652                                   GParamSpec   *pspec)
653 {
654   GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
655   
656   switch (prop_id)
657     {
658     case PROP_HADJUSTMENT:
659       gtk_scrolled_window_set_hadjustment (scrolled_window,
660                                            g_value_get_object (value));
661       break;
662     case PROP_VADJUSTMENT:
663       gtk_scrolled_window_set_vadjustment (scrolled_window,
664                                            g_value_get_object (value));
665       break;
666     case PROP_HSCROLLBAR_POLICY:
667       gtk_scrolled_window_set_policy (scrolled_window,
668                                       g_value_get_enum (value),
669                                       scrolled_window->vscrollbar_policy);
670       break;
671     case PROP_VSCROLLBAR_POLICY:
672       gtk_scrolled_window_set_policy (scrolled_window,
673                                       scrolled_window->hscrollbar_policy,
674                                       g_value_get_enum (value));
675       break;
676     case PROP_WINDOW_PLACEMENT:
677       gtk_scrolled_window_set_placement (scrolled_window,
678                                          g_value_get_enum (value));
679       break;
680     case PROP_SHADOW_TYPE:
681       gtk_scrolled_window_set_shadow_type (scrolled_window,
682                                            g_value_get_enum (value));
683       break;
684     default:
685       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
686       break;
687     }
688 }
689
690 static void
691 gtk_scrolled_window_get_property (GObject    *object,
692                                   guint       prop_id,
693                                   GValue     *value,
694                                   GParamSpec *pspec)
695 {
696   GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (object);
697   
698   switch (prop_id)
699     {
700     case PROP_HADJUSTMENT:
701       g_value_set_object (value,
702                           G_OBJECT (gtk_scrolled_window_get_hadjustment (scrolled_window)));
703       break;
704     case PROP_VADJUSTMENT:
705       g_value_set_object (value,
706                           G_OBJECT (gtk_scrolled_window_get_vadjustment (scrolled_window)));
707       break;
708     case PROP_HSCROLLBAR_POLICY:
709       g_value_set_enum (value, scrolled_window->hscrollbar_policy);
710       break;
711     case PROP_VSCROLLBAR_POLICY:
712       g_value_set_enum (value, scrolled_window->vscrollbar_policy);
713       break;
714     case PROP_WINDOW_PLACEMENT:
715       g_value_set_enum (value, scrolled_window->window_placement);
716       break;
717     case PROP_SHADOW_TYPE:
718       g_value_set_enum (value, scrolled_window->shadow_type);
719       break;
720     default:
721       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
722       break;
723     }
724 }
725
726 static void
727 gtk_scrolled_window_paint (GtkWidget    *widget,
728                            GdkRectangle *area)
729 {
730   GtkAllocation relative_allocation;
731   GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (widget);
732
733   if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
734     {
735       gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
736       
737       relative_allocation.x -= widget->style->xthickness;
738       relative_allocation.y -= widget->style->ythickness;
739       relative_allocation.width += 2 * widget->style->xthickness;
740       relative_allocation.height += 2 * widget->style->ythickness;
741       
742       gtk_paint_shadow (widget->style, widget->window,
743                         GTK_STATE_NORMAL, scrolled_window->shadow_type,
744                         area, widget, "scrolled_window",
745                         widget->allocation.x + relative_allocation.x,
746                         widget->allocation.y + relative_allocation.y,
747                         relative_allocation.width,
748                         relative_allocation.height);
749     }
750 }
751
752 static gint
753 gtk_scrolled_window_expose (GtkWidget      *widget,
754                             GdkEventExpose *event)
755 {
756   if (GTK_WIDGET_DRAWABLE (widget))
757     {
758       gtk_scrolled_window_paint (widget, &event->area);
759
760       (* GTK_WIDGET_CLASS (parent_class)->expose_event) (widget, event);
761     }
762
763   return FALSE;
764 }
765
766 static void
767 gtk_scrolled_window_forall (GtkContainer *container,
768                             gboolean      include_internals,
769                             GtkCallback   callback,
770                             gpointer      callback_data)
771 {
772   g_return_if_fail (GTK_IS_SCROLLED_WINDOW (container));
773   g_return_if_fail (callback != NULL);
774
775   GTK_CONTAINER_CLASS (parent_class)->forall (container,
776                                               include_internals,
777                                               callback,
778                                               callback_data);
779   if (include_internals)
780     {
781       GtkScrolledWindow *scrolled_window;
782
783       scrolled_window = GTK_SCROLLED_WINDOW (container);
784       
785       if (scrolled_window->vscrollbar)
786         callback (scrolled_window->vscrollbar, callback_data);
787       if (scrolled_window->hscrollbar)
788         callback (scrolled_window->hscrollbar, callback_data);
789     }
790 }
791
792 static void
793 gtk_scrolled_window_scroll_child (GtkScrolledWindow *scrolled_window,
794                                   GtkScrollType      scroll,
795                                   gboolean           horizontal)
796 {
797   GtkAdjustment *adjustment = NULL;
798   
799   switch (scroll)
800     {
801     case GTK_SCROLL_STEP_UP:
802       scroll = GTK_SCROLL_STEP_BACKWARD;
803       horizontal = FALSE;
804       break;
805     case GTK_SCROLL_STEP_DOWN:
806       scroll = GTK_SCROLL_STEP_FORWARD;
807       horizontal = FALSE;
808       break;
809     case GTK_SCROLL_STEP_LEFT:
810       scroll = GTK_SCROLL_STEP_BACKWARD;
811       horizontal = TRUE;
812       break;
813     case GTK_SCROLL_STEP_RIGHT:
814       scroll = GTK_SCROLL_STEP_FORWARD;
815       horizontal = TRUE;
816       break;
817     case GTK_SCROLL_PAGE_UP:
818       scroll = GTK_SCROLL_PAGE_BACKWARD;
819       horizontal = FALSE;
820       break;
821     case GTK_SCROLL_PAGE_DOWN:
822       scroll = GTK_SCROLL_PAGE_FORWARD;
823       horizontal = FALSE;
824       break;
825     case GTK_SCROLL_PAGE_LEFT:
826       scroll = GTK_SCROLL_STEP_BACKWARD;
827       horizontal = TRUE;
828       break;
829     case GTK_SCROLL_PAGE_RIGHT:
830       scroll = GTK_SCROLL_STEP_FORWARD;
831       horizontal = TRUE;
832       break;
833     case GTK_SCROLL_STEP_BACKWARD:
834     case GTK_SCROLL_STEP_FORWARD:
835     case GTK_SCROLL_PAGE_BACKWARD:
836     case GTK_SCROLL_PAGE_FORWARD:
837     case GTK_SCROLL_START:
838     case GTK_SCROLL_END:
839       break;
840     default:
841       g_warning ("Invalid scroll type %d for GtkSpinButton::change-value", scroll);
842       return;
843     }
844
845   if (horizontal)
846     {
847       if (scrolled_window->hscrollbar)
848         adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
849     }
850   else
851     {
852       if (scrolled_window->vscrollbar)
853         adjustment = gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
854     }
855
856   if (adjustment)
857     {
858       gdouble value = adjustment->value;
859       
860       switch (scroll)
861         {
862         case GTK_SCROLL_STEP_FORWARD:
863           value += adjustment->step_increment;
864           break;
865         case GTK_SCROLL_STEP_BACKWARD:
866           value -= adjustment->step_increment;
867           break;
868         case GTK_SCROLL_PAGE_FORWARD:
869           value += adjustment->page_increment;
870           break;
871         case GTK_SCROLL_PAGE_BACKWARD:
872           value -= adjustment->page_increment;
873           break;
874         case GTK_SCROLL_START:
875           value = adjustment->lower;
876           break;
877         case GTK_SCROLL_END:
878           value = adjustment->upper;
879           break;
880         default:
881           g_assert_not_reached ();
882           break;
883         }
884
885       value = CLAMP (value, adjustment->lower, adjustment->upper - adjustment->page_size);
886       
887       gtk_adjustment_set_value (adjustment, value);
888     }
889 }
890
891 static void
892 gtk_scrolled_window_move_focus_out (GtkScrolledWindow *scrolled_window,
893                                     GtkDirectionType   direction_type)
894 {
895   GtkWidget *toplevel;
896   
897   /* Focus out of the scrolled window entirely. We do this by setting
898    * a flag, then propagating the focus motion to the notebook.
899    */
900   toplevel = gtk_widget_get_toplevel (GTK_WIDGET (scrolled_window));
901   if (!GTK_WIDGET_TOPLEVEL (toplevel))
902     return;
903
904   g_object_ref (scrolled_window);
905   
906   scrolled_window->focus_out = TRUE;
907   g_signal_emit_by_name (toplevel, "move_focus", direction_type);
908   scrolled_window->focus_out = FALSE;
909   
910   g_object_unref (scrolled_window);
911 }
912
913 static void
914 gtk_scrolled_window_size_request (GtkWidget      *widget,
915                                   GtkRequisition *requisition)
916 {
917   GtkScrolledWindow *scrolled_window;
918   GtkBin *bin;
919   gint extra_width;
920   gint extra_height;
921   gint scrollbar_spacing;
922   GtkRequisition hscrollbar_requisition;
923   GtkRequisition vscrollbar_requisition;
924   GtkRequisition child_requisition;
925
926   g_return_if_fail (GTK_IS_SCROLLED_WINDOW (widget));
927   g_return_if_fail (requisition != NULL);
928
929   scrolled_window = GTK_SCROLLED_WINDOW (widget);
930   bin = GTK_BIN (scrolled_window);
931
932   scrollbar_spacing = _gtk_scrolled_window_get_scrollbar_spacing (scrolled_window);
933
934   extra_width = 0;
935   extra_height = 0;
936   requisition->width = 0;
937   requisition->height = 0;
938   
939   gtk_widget_size_request (scrolled_window->hscrollbar,
940                            &hscrollbar_requisition);
941   gtk_widget_size_request (scrolled_window->vscrollbar,
942                            &vscrollbar_requisition);
943   
944   if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
945     {
946       gtk_widget_size_request (bin->child, &child_requisition);
947
948       if (scrolled_window->hscrollbar_policy == GTK_POLICY_NEVER)
949         requisition->width += child_requisition.width;
950       else
951         {
952           GtkWidgetAuxInfo *aux_info = _gtk_widget_get_aux_info (bin->child, FALSE);
953
954           if (aux_info && aux_info->width > 0)
955             {
956               requisition->width += aux_info->width;
957               extra_width = -1;
958             }
959           else
960             requisition->width += vscrollbar_requisition.width;
961         }
962
963       if (scrolled_window->vscrollbar_policy == GTK_POLICY_NEVER)
964         requisition->height += child_requisition.height;
965       else
966         {
967           GtkWidgetAuxInfo *aux_info = _gtk_widget_get_aux_info (bin->child, FALSE);
968
969           if (aux_info && aux_info->height > 0)
970             {
971               requisition->height += aux_info->height;
972               extra_height = -1;
973             }
974           else
975             requisition->height += hscrollbar_requisition.height;
976         }
977     }
978
979   if (scrolled_window->hscrollbar_policy == GTK_POLICY_AUTOMATIC ||
980       scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS)
981     {
982       requisition->width = MAX (requisition->width, hscrollbar_requisition.width);
983       if (!extra_height || scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS)
984         extra_height = scrollbar_spacing + hscrollbar_requisition.height;
985     }
986
987   if (scrolled_window->vscrollbar_policy == GTK_POLICY_AUTOMATIC ||
988       scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS)
989     {
990       requisition->height = MAX (requisition->height, vscrollbar_requisition.height);
991       if (!extra_height || scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS)
992         extra_width = scrollbar_spacing + vscrollbar_requisition.width;
993     }
994
995   requisition->width += GTK_CONTAINER (widget)->border_width * 2 + MAX (0, extra_width);
996   requisition->height += GTK_CONTAINER (widget)->border_width * 2 + MAX (0, extra_height);
997
998   if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
999     {
1000       requisition->width += 2 * widget->style->xthickness;
1001       requisition->height += 2 * widget->style->ythickness;
1002     }
1003 }
1004
1005 static void
1006 gtk_scrolled_window_relative_allocation (GtkWidget     *widget,
1007                                          GtkAllocation *allocation)
1008 {
1009   GtkScrolledWindow *scrolled_window;
1010   gint scrollbar_spacing;
1011
1012   g_return_if_fail (widget != NULL);
1013   g_return_if_fail (allocation != NULL);
1014
1015   scrolled_window = GTK_SCROLLED_WINDOW (widget);
1016   scrollbar_spacing = _gtk_scrolled_window_get_scrollbar_spacing (scrolled_window);
1017
1018   allocation->x = GTK_CONTAINER (widget)->border_width;
1019   allocation->y = GTK_CONTAINER (widget)->border_width;
1020
1021   if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1022     {
1023       allocation->x += widget->style->xthickness;
1024       allocation->y += widget->style->ythickness;
1025     }
1026   
1027   allocation->width = MAX (1, (gint)widget->allocation.width - allocation->x * 2);
1028   allocation->height = MAX (1, (gint)widget->allocation.height - allocation->y * 2);
1029
1030   if (scrolled_window->vscrollbar_visible)
1031     {
1032       GtkRequisition vscrollbar_requisition;
1033       gboolean is_rtl;
1034
1035       gtk_widget_get_child_requisition (scrolled_window->vscrollbar,
1036                                         &vscrollbar_requisition);
1037       is_rtl = gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL;
1038   
1039       if ((!is_rtl && 
1040            (scrolled_window->window_placement == GTK_CORNER_TOP_RIGHT ||
1041             scrolled_window->window_placement == GTK_CORNER_BOTTOM_RIGHT)) ||
1042           (is_rtl && 
1043            (scrolled_window->window_placement == GTK_CORNER_TOP_LEFT ||
1044             scrolled_window->window_placement == GTK_CORNER_BOTTOM_LEFT)))
1045         allocation->x += (vscrollbar_requisition.width +  scrollbar_spacing);
1046
1047       allocation->width = MAX (1, allocation->width - (vscrollbar_requisition.width + scrollbar_spacing));
1048     }
1049   if (scrolled_window->hscrollbar_visible)
1050     {
1051       GtkRequisition hscrollbar_requisition;
1052       gtk_widget_get_child_requisition (scrolled_window->hscrollbar,
1053                                         &hscrollbar_requisition);
1054   
1055       if (scrolled_window->window_placement == GTK_CORNER_BOTTOM_LEFT ||
1056           scrolled_window->window_placement == GTK_CORNER_BOTTOM_RIGHT)
1057         allocation->y += (hscrollbar_requisition.height + scrollbar_spacing);
1058
1059       allocation->height = MAX (1, allocation->height - (hscrollbar_requisition.height + scrollbar_spacing));
1060     }
1061 }
1062
1063 static void
1064 gtk_scrolled_window_size_allocate (GtkWidget     *widget,
1065                                    GtkAllocation *allocation)
1066 {
1067   GtkScrolledWindow *scrolled_window;
1068   GtkBin *bin;
1069   GtkAllocation relative_allocation;
1070   GtkAllocation child_allocation;
1071   gint scrollbar_spacing;
1072   
1073   g_return_if_fail (GTK_IS_SCROLLED_WINDOW (widget));
1074   g_return_if_fail (allocation != NULL);
1075
1076   scrolled_window = GTK_SCROLLED_WINDOW (widget);
1077   bin = GTK_BIN (scrolled_window);
1078
1079   scrollbar_spacing = _gtk_scrolled_window_get_scrollbar_spacing (scrolled_window);
1080
1081   widget->allocation = *allocation;
1082
1083   if (scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS)
1084     scrolled_window->hscrollbar_visible = TRUE;
1085   else if (scrolled_window->hscrollbar_policy == GTK_POLICY_NEVER)
1086     scrolled_window->hscrollbar_visible = FALSE;
1087   if (scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS)
1088     scrolled_window->vscrollbar_visible = TRUE;
1089   else if (scrolled_window->vscrollbar_policy == GTK_POLICY_NEVER)
1090     scrolled_window->vscrollbar_visible = FALSE;
1091
1092   if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
1093     {
1094       gboolean previous_hvis;
1095       gboolean previous_vvis;
1096       guint count = 0;
1097       
1098       do
1099         {
1100           gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
1101           
1102           child_allocation.x = relative_allocation.x + allocation->x;
1103           child_allocation.y = relative_allocation.y + allocation->y;
1104           child_allocation.width = relative_allocation.width;
1105           child_allocation.height = relative_allocation.height;
1106           
1107           previous_hvis = scrolled_window->hscrollbar_visible;
1108           previous_vvis = scrolled_window->vscrollbar_visible;
1109           
1110           gtk_widget_size_allocate (bin->child, &child_allocation);
1111
1112           /* If, after the first iteration, the hscrollbar and the
1113            * vscrollbar flip visiblity, then we need both.
1114            */
1115           if (count &&
1116               previous_hvis != scrolled_window->hscrollbar_visible &&
1117               previous_vvis != scrolled_window->vscrollbar_visible)
1118             {
1119               scrolled_window->hscrollbar_visible = TRUE;
1120               scrolled_window->vscrollbar_visible = TRUE;
1121
1122               /* a new resize is already queued at this point,
1123                * so we will immediatedly get reinvoked
1124                */
1125               return;
1126             }
1127           
1128           count++;
1129         }
1130       while (previous_hvis != scrolled_window->hscrollbar_visible ||
1131              previous_vvis != scrolled_window->vscrollbar_visible);
1132     }
1133   else
1134     gtk_scrolled_window_relative_allocation (widget, &relative_allocation);
1135   
1136   if (scrolled_window->hscrollbar_visible)
1137     {
1138       GtkRequisition hscrollbar_requisition;
1139       gtk_widget_get_child_requisition (scrolled_window->hscrollbar,
1140                                         &hscrollbar_requisition);
1141   
1142       if (!GTK_WIDGET_VISIBLE (scrolled_window->hscrollbar))
1143         gtk_widget_show (scrolled_window->hscrollbar);
1144
1145       child_allocation.x = relative_allocation.x;
1146       if (scrolled_window->window_placement == GTK_CORNER_TOP_LEFT ||
1147           scrolled_window->window_placement == GTK_CORNER_TOP_RIGHT)
1148         child_allocation.y = (relative_allocation.y +
1149                               relative_allocation.height +
1150                               scrollbar_spacing +
1151                               (scrolled_window->shadow_type == GTK_SHADOW_NONE ?
1152                                0 : widget->style->ythickness));
1153       else
1154         child_allocation.y = GTK_CONTAINER (scrolled_window)->border_width;
1155
1156       child_allocation.width = relative_allocation.width;
1157       child_allocation.height = hscrollbar_requisition.height;
1158       child_allocation.x += allocation->x;
1159       child_allocation.y += allocation->y;
1160
1161       if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1162         {
1163           child_allocation.x -= widget->style->xthickness;
1164           child_allocation.width += 2 * widget->style->xthickness;
1165         }
1166
1167       gtk_widget_size_allocate (scrolled_window->hscrollbar, &child_allocation);
1168     }
1169   else if (GTK_WIDGET_VISIBLE (scrolled_window->hscrollbar))
1170     gtk_widget_hide (scrolled_window->hscrollbar);
1171
1172   if (scrolled_window->vscrollbar_visible)
1173     {
1174       GtkRequisition vscrollbar_requisition;
1175       if (!GTK_WIDGET_VISIBLE (scrolled_window->vscrollbar))
1176         gtk_widget_show (scrolled_window->vscrollbar);
1177
1178       gtk_widget_get_child_requisition (scrolled_window->vscrollbar,
1179                                         &vscrollbar_requisition);
1180
1181       if ((gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL && 
1182            (scrolled_window->window_placement == GTK_CORNER_TOP_RIGHT ||
1183             scrolled_window->window_placement == GTK_CORNER_BOTTOM_RIGHT)) ||
1184           (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR && 
1185            (scrolled_window->window_placement == GTK_CORNER_TOP_LEFT ||
1186             scrolled_window->window_placement == GTK_CORNER_BOTTOM_LEFT)))
1187         child_allocation.x = (relative_allocation.x +
1188                               relative_allocation.width +
1189                               scrollbar_spacing +
1190                               (scrolled_window->shadow_type == GTK_SHADOW_NONE ?
1191                                0 : widget->style->xthickness));
1192       else
1193         child_allocation.x = GTK_CONTAINER (scrolled_window)->border_width;
1194
1195       child_allocation.y = relative_allocation.y;
1196       child_allocation.width = vscrollbar_requisition.width;
1197       child_allocation.height = relative_allocation.height;
1198       child_allocation.x += allocation->x;
1199       child_allocation.y += allocation->y;
1200
1201       if (scrolled_window->shadow_type != GTK_SHADOW_NONE)
1202         {
1203           child_allocation.y -= widget->style->ythickness;
1204           child_allocation.height += 2 * widget->style->ythickness;
1205         }
1206
1207       gtk_widget_size_allocate (scrolled_window->vscrollbar, &child_allocation);
1208     }
1209   else if (GTK_WIDGET_VISIBLE (scrolled_window->vscrollbar))
1210     gtk_widget_hide (scrolled_window->vscrollbar);
1211 }
1212
1213 static gint
1214 gtk_scrolled_window_scroll_event (GtkWidget *widget,
1215                                   GdkEventScroll *event)
1216 {
1217   GtkWidget *range;
1218
1219   g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (widget), FALSE);
1220   g_return_val_if_fail (event != NULL, FALSE);  
1221
1222   if (event->direction == GDK_SCROLL_UP || event->direction == GDK_SCROLL_DOWN)
1223     range = GTK_SCROLLED_WINDOW (widget)->vscrollbar;
1224   else
1225     range = GTK_SCROLLED_WINDOW (widget)->hscrollbar;
1226
1227   if (range && GTK_WIDGET_VISIBLE (range))
1228     {
1229       GtkAdjustment *adj = GTK_RANGE (range)->adjustment;
1230       gdouble delta, new_value;
1231
1232       delta = _gtk_range_get_wheel_delta (GTK_RANGE (range), event->direction);
1233
1234       new_value = CLAMP (adj->value + delta, adj->lower, adj->upper - adj->page_size);
1235       
1236       gtk_adjustment_set_value (adj, new_value);
1237
1238       return TRUE;
1239     }
1240
1241   return FALSE;
1242 }
1243
1244 static gint
1245 gtk_scrolled_window_focus (GtkWidget        *widget,
1246                            GtkDirectionType  direction)
1247 {
1248   GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW (widget);
1249   gboolean had_focus_child = GTK_CONTAINER (widget)->focus_child != NULL;
1250   
1251   if (scrolled_window->focus_out)
1252     {
1253       scrolled_window->focus_out = FALSE; /* Clear this to catch the wrap-around case */
1254       return FALSE;
1255     }
1256   
1257   if (gtk_widget_is_focus (widget))
1258     return FALSE;
1259
1260   /* We only put the scrolled window itself in the focus chain if it
1261    * isn't possible to focus any children.
1262    */
1263   if (GTK_BIN (widget)->child)
1264     {
1265       if (gtk_widget_child_focus (GTK_BIN (widget)->child, direction))
1266         return TRUE;
1267     }
1268
1269   if (!had_focus_child)
1270     {
1271       gtk_widget_grab_focus (widget);
1272       return TRUE;
1273     }
1274   else
1275     return FALSE;
1276 }
1277
1278 static void
1279 gtk_scrolled_window_adjustment_changed (GtkAdjustment *adjustment,
1280                                         gpointer       data)
1281 {
1282   GtkScrolledWindow *scrolled_win;
1283
1284   g_return_if_fail (adjustment != NULL);
1285   g_return_if_fail (data != NULL);
1286
1287   scrolled_win = GTK_SCROLLED_WINDOW (data);
1288
1289   if (scrolled_win->hscrollbar &&
1290       adjustment == gtk_range_get_adjustment (GTK_RANGE (scrolled_win->hscrollbar)))
1291     {
1292       if (scrolled_win->hscrollbar_policy == GTK_POLICY_AUTOMATIC)
1293         {
1294           gboolean visible;
1295           
1296           visible = scrolled_win->hscrollbar_visible;
1297           scrolled_win->hscrollbar_visible = (adjustment->upper - adjustment->lower >
1298                                               adjustment->page_size);
1299           if (scrolled_win->hscrollbar_visible != visible)
1300             gtk_widget_queue_resize (GTK_WIDGET (scrolled_win));
1301         }
1302     }
1303   else if (scrolled_win->vscrollbar &&
1304            adjustment == gtk_range_get_adjustment (GTK_RANGE (scrolled_win->vscrollbar)))
1305     {
1306       if (scrolled_win->vscrollbar_policy == GTK_POLICY_AUTOMATIC)
1307         {
1308           gboolean visible;
1309
1310           visible = scrolled_win->vscrollbar_visible;
1311           scrolled_win->vscrollbar_visible = (adjustment->upper - adjustment->lower >
1312                                               adjustment->page_size);
1313           if (scrolled_win->vscrollbar_visible != visible)
1314             gtk_widget_queue_resize (GTK_WIDGET (scrolled_win));
1315         }
1316     }
1317 }
1318
1319 static void
1320 gtk_scrolled_window_add (GtkContainer *container,
1321                          GtkWidget    *child)
1322 {
1323   GtkScrolledWindow *scrolled_window;
1324   GtkBin *bin;
1325
1326   bin = GTK_BIN (container);
1327   g_return_if_fail (bin->child == NULL);
1328
1329   scrolled_window = GTK_SCROLLED_WINDOW (container);
1330
1331   bin->child = child;
1332   gtk_widget_set_parent (child, GTK_WIDGET (bin));
1333
1334   /* this is a temporary message */
1335   if (!gtk_widget_set_scroll_adjustments (child,
1336                                           gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar)),
1337                                           gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar))))
1338     g_warning ("gtk_scrolled_window_add(): cannot add non scrollable widget "
1339                "use gtk_scrolled_window_add_with_viewport() instead");
1340 }
1341
1342 static void
1343 gtk_scrolled_window_remove (GtkContainer *container,
1344                             GtkWidget    *child)
1345 {
1346   g_return_if_fail (GTK_IS_SCROLLED_WINDOW (container));
1347   g_return_if_fail (child != NULL);
1348   g_return_if_fail (GTK_BIN (container)->child == child);
1349   
1350   gtk_widget_set_scroll_adjustments (child, NULL, NULL);
1351
1352   /* chain parent class handler to remove child */
1353   GTK_CONTAINER_CLASS (parent_class)->remove (container, child);
1354 }
1355
1356 void
1357 gtk_scrolled_window_add_with_viewport (GtkScrolledWindow *scrolled_window,
1358                                        GtkWidget         *child)
1359 {
1360   GtkBin *bin;
1361   GtkWidget *viewport;
1362
1363   g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
1364   g_return_if_fail (GTK_IS_WIDGET (child));
1365   g_return_if_fail (child->parent == NULL);
1366
1367   bin = GTK_BIN (scrolled_window);
1368
1369   if (bin->child != NULL)
1370     {
1371       g_return_if_fail (GTK_IS_VIEWPORT (bin->child));
1372       g_return_if_fail (GTK_BIN (bin->child)->child == NULL);
1373
1374       viewport = bin->child;
1375     }
1376   else
1377     {
1378       viewport =
1379         gtk_viewport_new (gtk_scrolled_window_get_hadjustment (scrolled_window),
1380                           gtk_scrolled_window_get_vadjustment (scrolled_window));
1381       gtk_container_add (GTK_CONTAINER (scrolled_window), viewport);
1382     }
1383
1384   gtk_widget_show (viewport);
1385   gtk_container_add (GTK_CONTAINER (viewport), child);
1386 }
1387
1388 /**
1389  * _gtk_scrolled_window_get_spacing:
1390  * @scrolled_window: a scrolled window
1391  * 
1392  * Gets the spacing between the scrolled window's scrollbars and
1393  * the scrolled widget. Used by GtkCombo
1394  * 
1395  * Return value: the spacing, in pixels.
1396  **/
1397 gint
1398 _gtk_scrolled_window_get_scrollbar_spacing (GtkScrolledWindow *scrolled_window)
1399 {
1400   GtkScrolledWindowClass *class;
1401     
1402   g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), 0);
1403
1404   class = GTK_SCROLLED_WINDOW_GET_CLASS (scrolled_window);
1405
1406   if (class->scrollbar_spacing >= 0)
1407     return class->scrollbar_spacing;
1408   else
1409     {
1410       gint scrollbar_spacing;
1411       
1412       gtk_widget_style_get (GTK_WIDGET (scrolled_window),
1413                             "scrollbar_spacing", &scrollbar_spacing,
1414                             NULL);
1415
1416       return scrollbar_spacing;
1417     }
1418 }