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