1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library 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.
19 #include "gtkscrolledwindow.h"
20 #include "gtksignal.h"
23 #define SCROLLBAR_SPACING(w) (GTK_SCROLLED_WINDOW_CLASS (GTK_OBJECT (w)->klass)->scrollbar_spacing)
26 static void gtk_scrolled_window_class_init (GtkScrolledWindowClass *klass);
27 static void gtk_scrolled_window_init (GtkScrolledWindow *scrolled_window);
28 static void gtk_scrolled_window_destroy (GtkObject *object);
29 static void gtk_scrolled_window_finalize (GtkObject *object);
30 static void gtk_scrolled_window_map (GtkWidget *widget);
31 static void gtk_scrolled_window_unmap (GtkWidget *widget);
32 static void gtk_scrolled_window_draw (GtkWidget *widget,
34 static void gtk_scrolled_window_size_request (GtkWidget *widget,
35 GtkRequisition *requisition);
36 static void gtk_scrolled_window_size_allocate (GtkWidget *widget,
37 GtkAllocation *allocation);
38 static void gtk_scrolled_window_add (GtkContainer *container,
40 static void gtk_scrolled_window_remove (GtkContainer *container,
42 static void gtk_scrolled_window_foreach (GtkContainer *container,
44 gpointer callback_data);
45 static void gtk_scrolled_window_viewport_allocate (GtkWidget *widget,
46 GtkAllocation *allocation);
47 static void gtk_scrolled_window_adjustment_changed (GtkAdjustment *adjustment,
51 static GtkContainerClass *parent_class = NULL;
55 gtk_scrolled_window_get_type (void)
57 static guint scrolled_window_type = 0;
59 if (!scrolled_window_type)
61 GtkTypeInfo scrolled_window_info =
64 sizeof (GtkScrolledWindow),
65 sizeof (GtkScrolledWindowClass),
66 (GtkClassInitFunc) gtk_scrolled_window_class_init,
67 (GtkObjectInitFunc) gtk_scrolled_window_init,
72 scrolled_window_type = gtk_type_unique (gtk_container_get_type (), &scrolled_window_info);
75 return scrolled_window_type;
79 gtk_scrolled_window_class_init (GtkScrolledWindowClass *class)
81 GtkObjectClass *object_class;
82 GtkWidgetClass *widget_class;
83 GtkContainerClass *container_class;
85 object_class = (GtkObjectClass*) class;
86 widget_class = (GtkWidgetClass*) class;
87 container_class = (GtkContainerClass*) class;
89 parent_class = gtk_type_class (gtk_container_get_type ());
91 object_class->destroy = gtk_scrolled_window_destroy;
92 object_class->finalize = gtk_scrolled_window_finalize;
94 widget_class->map = gtk_scrolled_window_map;
95 widget_class->unmap = gtk_scrolled_window_unmap;
96 widget_class->draw = gtk_scrolled_window_draw;
97 widget_class->size_request = gtk_scrolled_window_size_request;
98 widget_class->size_allocate = gtk_scrolled_window_size_allocate;
100 container_class->add = gtk_scrolled_window_add;
101 container_class->remove = gtk_scrolled_window_remove;
102 container_class->foreach = gtk_scrolled_window_foreach;
104 class->scrollbar_spacing = 5;
108 gtk_scrolled_window_init (GtkScrolledWindow *scrolled_window)
110 GTK_WIDGET_SET_FLAGS (scrolled_window, GTK_NO_WINDOW);
112 scrolled_window->hscrollbar = NULL;
113 scrolled_window->vscrollbar = NULL;
114 scrolled_window->hscrollbar_policy = GTK_POLICY_ALWAYS;
115 scrolled_window->vscrollbar_policy = GTK_POLICY_ALWAYS;
119 gtk_scrolled_window_new (GtkAdjustment *hadjustment,
120 GtkAdjustment *vadjustment)
122 GtkWidget *scrolled_window;
124 scrolled_window = gtk_type_new (gtk_scrolled_window_get_type ());
126 gtk_scrolled_window_construct (GTK_SCROLLED_WINDOW (scrolled_window), hadjustment, vadjustment);
128 return scrolled_window;
132 gtk_scrolled_window_construct (GtkScrolledWindow *scrolled_window,
133 GtkAdjustment *hadjustment,
134 GtkAdjustment *vadjustment)
136 g_return_if_fail (scrolled_window != NULL);
137 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
138 g_return_if_fail (scrolled_window->viewport == NULL);
140 scrolled_window->viewport = gtk_viewport_new (hadjustment, vadjustment);
141 hadjustment = gtk_viewport_get_hadjustment (GTK_VIEWPORT (scrolled_window->viewport));
142 vadjustment = gtk_viewport_get_vadjustment (GTK_VIEWPORT (scrolled_window->viewport));
144 gtk_signal_connect (GTK_OBJECT (hadjustment), "changed",
145 (GtkSignalFunc) gtk_scrolled_window_adjustment_changed,
146 (gpointer) scrolled_window);
147 gtk_signal_connect (GTK_OBJECT (vadjustment), "changed",
148 (GtkSignalFunc) gtk_scrolled_window_adjustment_changed,
149 (gpointer) scrolled_window);
151 scrolled_window->hscrollbar = gtk_hscrollbar_new (hadjustment);
152 scrolled_window->vscrollbar = gtk_vscrollbar_new (vadjustment);
154 gtk_widget_set_parent (scrolled_window->viewport, GTK_WIDGET (scrolled_window));
155 gtk_widget_set_parent (scrolled_window->hscrollbar, GTK_WIDGET (scrolled_window));
156 gtk_widget_set_parent (scrolled_window->vscrollbar, GTK_WIDGET (scrolled_window));
158 gtk_widget_show (scrolled_window->viewport);
159 gtk_widget_show (scrolled_window->hscrollbar);
160 gtk_widget_show (scrolled_window->vscrollbar);
162 gtk_widget_ref (scrolled_window->viewport);
163 gtk_widget_ref (scrolled_window->hscrollbar);
164 gtk_widget_ref (scrolled_window->vscrollbar);
168 gtk_scrolled_window_get_hadjustment (GtkScrolledWindow *scrolled_window)
170 g_return_val_if_fail (scrolled_window != NULL, NULL);
171 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
173 return gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
177 gtk_scrolled_window_get_vadjustment (GtkScrolledWindow *scrolled_window)
179 g_return_val_if_fail (scrolled_window != NULL, NULL);
180 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
182 return gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
186 gtk_scrolled_window_set_policy (GtkScrolledWindow *scrolled_window,
187 GtkPolicyType hscrollbar_policy,
188 GtkPolicyType vscrollbar_policy)
190 g_return_if_fail (scrolled_window != NULL);
191 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
193 if ((scrolled_window->hscrollbar_policy != hscrollbar_policy) ||
194 (scrolled_window->vscrollbar_policy != vscrollbar_policy))
196 scrolled_window->hscrollbar_policy = hscrollbar_policy;
197 scrolled_window->vscrollbar_policy = vscrollbar_policy;
199 if (GTK_WIDGET (scrolled_window)->parent)
200 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
206 gtk_scrolled_window_destroy (GtkObject *object)
208 GtkScrolledWindow *scrolled_window;
210 g_return_if_fail (object != NULL);
211 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (object));
213 scrolled_window = GTK_SCROLLED_WINDOW (object);
215 gtk_widget_destroy (scrolled_window->viewport);
216 gtk_widget_destroy (scrolled_window->hscrollbar);
217 gtk_widget_destroy (scrolled_window->vscrollbar);
219 if (GTK_OBJECT_CLASS (parent_class)->destroy)
220 (* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
224 gtk_scrolled_window_finalize (GtkObject *object)
226 GtkScrolledWindow *scrolled_window;
228 scrolled_window = GTK_SCROLLED_WINDOW (object);
229 gtk_widget_unref (scrolled_window->viewport);
230 gtk_widget_unref (scrolled_window->hscrollbar);
231 gtk_widget_unref (scrolled_window->vscrollbar);
233 GTK_OBJECT_CLASS (parent_class)->finalize (object);
237 gtk_scrolled_window_map (GtkWidget *widget)
239 GtkScrolledWindow *scrolled_window;
241 g_return_if_fail (widget != NULL);
242 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (widget));
244 if (!GTK_WIDGET_MAPPED (widget))
246 GTK_WIDGET_SET_FLAGS (widget, GTK_MAPPED);
247 scrolled_window = GTK_SCROLLED_WINDOW (widget);
249 if (GTK_WIDGET_VISIBLE (scrolled_window->viewport) &&
250 !GTK_WIDGET_MAPPED (scrolled_window->viewport))
251 gtk_widget_map (scrolled_window->viewport);
253 if (GTK_WIDGET_VISIBLE (scrolled_window->hscrollbar) &&
254 !GTK_WIDGET_MAPPED (scrolled_window->hscrollbar))
255 gtk_widget_map (scrolled_window->hscrollbar);
257 if (GTK_WIDGET_VISIBLE (scrolled_window->vscrollbar) &&
258 !GTK_WIDGET_MAPPED (scrolled_window->vscrollbar))
259 gtk_widget_map (scrolled_window->vscrollbar);
264 gtk_scrolled_window_unmap (GtkWidget *widget)
266 GtkScrolledWindow *scrolled_window;
268 g_return_if_fail (widget != NULL);
269 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (widget));
271 if (GTK_WIDGET_MAPPED (widget))
273 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
274 scrolled_window = GTK_SCROLLED_WINDOW (widget);
276 if (GTK_WIDGET_MAPPED (scrolled_window->viewport))
277 gtk_widget_unmap (scrolled_window->viewport);
279 if (GTK_WIDGET_MAPPED (scrolled_window->hscrollbar))
280 gtk_widget_unmap (scrolled_window->hscrollbar);
282 if (GTK_WIDGET_MAPPED (scrolled_window->vscrollbar))
283 gtk_widget_unmap (scrolled_window->vscrollbar);
288 gtk_scrolled_window_draw (GtkWidget *widget,
291 GtkScrolledWindow *scrolled_window;
292 GdkRectangle child_area;
294 g_return_if_fail (widget != NULL);
295 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (widget));
296 g_return_if_fail (area != NULL);
298 if (GTK_WIDGET_DRAWABLE (widget))
300 scrolled_window = GTK_SCROLLED_WINDOW (widget);
302 if (gtk_widget_intersect (scrolled_window->viewport, area, &child_area))
303 gtk_widget_draw (scrolled_window->viewport, &child_area);
305 if (gtk_widget_intersect (scrolled_window->hscrollbar, area, &child_area))
306 gtk_widget_draw (scrolled_window->hscrollbar, &child_area);
308 if (gtk_widget_intersect (scrolled_window->vscrollbar, area, &child_area))
309 gtk_widget_draw (scrolled_window->vscrollbar, &child_area);
314 gtk_scrolled_window_size_request (GtkWidget *widget,
315 GtkRequisition *requisition)
317 GtkScrolledWindow *scrolled_window;
321 g_return_if_fail (widget != NULL);
322 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (widget));
323 g_return_if_fail (requisition != NULL);
325 scrolled_window = GTK_SCROLLED_WINDOW (widget);
327 requisition->width = 0;
328 requisition->height = 0;
330 if (GTK_WIDGET_VISIBLE (scrolled_window->viewport))
332 gtk_widget_size_request (scrolled_window->viewport, &scrolled_window->viewport->requisition);
334 requisition->width += scrolled_window->viewport->requisition.width;
335 requisition->height += scrolled_window->viewport->requisition.height;
341 if ((scrolled_window->hscrollbar_policy == GTK_POLICY_AUTOMATIC) ||
342 GTK_WIDGET_VISIBLE (scrolled_window->hscrollbar))
344 gtk_widget_size_request (scrolled_window->hscrollbar,
345 &scrolled_window->hscrollbar->requisition);
347 requisition->width = MAX (requisition->width, scrolled_window->hscrollbar->requisition.width);
348 extra_height = SCROLLBAR_SPACING (scrolled_window) + scrolled_window->hscrollbar->requisition.height;
351 if ((scrolled_window->vscrollbar_policy == GTK_POLICY_AUTOMATIC) ||
352 GTK_WIDGET_VISIBLE (scrolled_window->vscrollbar))
354 gtk_widget_size_request (scrolled_window->vscrollbar,
355 &scrolled_window->vscrollbar->requisition);
357 requisition->height = MAX (requisition->height, scrolled_window->vscrollbar->requisition.height);
358 extra_width = SCROLLBAR_SPACING (scrolled_window) + scrolled_window->vscrollbar->requisition.width;
361 requisition->width += GTK_CONTAINER (widget)->border_width * 2 + extra_width;
362 requisition->height += GTK_CONTAINER (widget)->border_width * 2 + extra_height;
366 gtk_scrolled_window_size_allocate (GtkWidget *widget,
367 GtkAllocation *allocation)
369 GtkScrolledWindow *scrolled_window;
370 GtkAllocation viewport_allocation;
371 GtkAllocation child_allocation;
376 g_return_if_fail (widget != NULL);
377 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (widget));
378 g_return_if_fail (allocation != NULL);
380 scrolled_window = GTK_SCROLLED_WINDOW (widget);
381 widget->allocation = *allocation;
383 gtk_container_disable_resize (GTK_CONTAINER (scrolled_window));
385 if (scrolled_window->hscrollbar_policy == GTK_POLICY_ALWAYS)
386 scrolled_window->hscrollbar_visible = TRUE;
387 if (scrolled_window->vscrollbar_policy == GTK_POLICY_ALWAYS)
388 scrolled_window->vscrollbar_visible = TRUE;
390 if (GTK_WIDGET_VISIBLE (scrolled_window->viewport))
395 gtk_scrolled_window_viewport_allocate (widget, &viewport_allocation);
397 child_allocation.x = viewport_allocation.x + allocation->x;
398 child_allocation.y = viewport_allocation.y + allocation->y;
399 child_allocation.width = viewport_allocation.width;
400 child_allocation.height = viewport_allocation.height;
402 previous_hvis = scrolled_window->hscrollbar_visible;
403 previous_vvis = scrolled_window->vscrollbar_visible;
405 gtk_widget_size_allocate (scrolled_window->viewport, &child_allocation);
406 /* If, after the first iteration, the hscrollbar and the
407 * vscrollbar flip visiblity, then we need both.
410 (previous_hvis != scrolled_window->hscrollbar_visible) &&
411 (previous_vvis != scrolled_window->vscrollbar_visible))
413 scrolled_window->hscrollbar_visible = TRUE;
414 scrolled_window->vscrollbar_visible = TRUE;
419 } while ((previous_hvis != scrolled_window->hscrollbar_visible) ||
420 (previous_vvis != scrolled_window->vscrollbar_visible));
423 if (scrolled_window->hscrollbar_visible)
425 if (!GTK_WIDGET_VISIBLE (scrolled_window->hscrollbar))
426 gtk_widget_show (scrolled_window->hscrollbar);
428 child_allocation.x = viewport_allocation.x;
429 child_allocation.y = viewport_allocation.y + viewport_allocation.height + SCROLLBAR_SPACING (scrolled_window);
430 child_allocation.width = viewport_allocation.width;
431 child_allocation.height = scrolled_window->hscrollbar->requisition.height;
432 child_allocation.x += allocation->x;
433 child_allocation.y += allocation->y;
435 gtk_widget_size_allocate (scrolled_window->hscrollbar, &child_allocation);
439 if (GTK_WIDGET_VISIBLE (scrolled_window->hscrollbar))
440 gtk_widget_hide (scrolled_window->hscrollbar);
443 if (scrolled_window->vscrollbar_visible)
445 if (!GTK_WIDGET_VISIBLE (scrolled_window->vscrollbar))
446 gtk_widget_show (scrolled_window->vscrollbar);
448 child_allocation.x = viewport_allocation.x + viewport_allocation.width + SCROLLBAR_SPACING (scrolled_window);
449 child_allocation.y = viewport_allocation.y;
450 child_allocation.width = scrolled_window->vscrollbar->requisition.width;
451 child_allocation.height = viewport_allocation.height;
452 child_allocation.x += allocation->x;
453 child_allocation.y += allocation->y;
455 gtk_widget_size_allocate (scrolled_window->vscrollbar, &child_allocation);
459 if (GTK_WIDGET_VISIBLE (scrolled_window->vscrollbar))
460 gtk_widget_hide (scrolled_window->vscrollbar);
463 gtk_container_enable_resize (GTK_CONTAINER (scrolled_window));
467 gtk_scrolled_window_add (GtkContainer *container,
470 GtkScrolledWindow *scrolled_window;
472 g_return_if_fail (container != NULL);
473 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (container));
474 g_return_if_fail (widget != NULL);
476 scrolled_window = GTK_SCROLLED_WINDOW (container);
477 gtk_container_add (GTK_CONTAINER (scrolled_window->viewport), widget);
481 gtk_scrolled_window_remove (GtkContainer *container,
484 GtkScrolledWindow *scrolled_window;
486 g_return_if_fail (container != NULL);
487 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (container));
488 g_return_if_fail (widget != NULL);
490 scrolled_window = GTK_SCROLLED_WINDOW (container);
492 if (scrolled_window->viewport == widget ||
493 scrolled_window->hscrollbar == widget ||
494 scrolled_window->vscrollbar == widget)
496 /* this happens during destroy */
497 gtk_widget_unparent (widget);
500 gtk_container_remove (GTK_CONTAINER (scrolled_window->viewport), widget);
504 gtk_scrolled_window_foreach (GtkContainer *container,
505 GtkCallback callback,
506 gpointer callback_data)
508 GtkScrolledWindow *scrolled_window;
510 g_return_if_fail (container != NULL);
511 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (container));
512 g_return_if_fail (callback != NULL);
514 scrolled_window = GTK_SCROLLED_WINDOW (container);
516 if (scrolled_window->viewport)
517 (* callback) (scrolled_window->viewport, callback_data);
519 (* callback) (scrolled_window->vscrollbar, callback_data);
520 (* callback) (scrolled_window->hscrollbar, callback_data);
524 gtk_scrolled_window_viewport_allocate (GtkWidget *widget,
525 GtkAllocation *allocation)
527 GtkScrolledWindow *scrolled_window;
529 g_return_if_fail (widget != NULL);
530 g_return_if_fail (allocation != NULL);
532 scrolled_window = GTK_SCROLLED_WINDOW (widget);
534 allocation->x = GTK_CONTAINER (widget)->border_width;
535 allocation->y = GTK_CONTAINER (widget)->border_width;
536 allocation->width = MAX (1, widget->allocation.width - allocation->x * 2);
537 allocation->height = MAX (1, widget->allocation.height - allocation->y * 2);
539 if (scrolled_window->vscrollbar_visible)
540 allocation->width = MAX (1,
541 allocation->width - (scrolled_window->vscrollbar->requisition.width + SCROLLBAR_SPACING (scrolled_window)));
542 if (scrolled_window->hscrollbar_visible)
543 allocation->height = MAX (1,
544 allocation->height - (scrolled_window->hscrollbar->requisition.height + SCROLLBAR_SPACING (scrolled_window)));
548 gtk_scrolled_window_adjustment_changed (GtkAdjustment *adjustment,
551 GtkScrolledWindow *scrolled_win;
553 g_return_if_fail (adjustment != NULL);
554 g_return_if_fail (data != NULL);
556 scrolled_win = GTK_SCROLLED_WINDOW (data);
558 if (adjustment == gtk_range_get_adjustment (GTK_RANGE (scrolled_win->hscrollbar)))
560 if (scrolled_win->hscrollbar_policy == GTK_POLICY_AUTOMATIC)
562 scrolled_win->hscrollbar_visible =
563 ((adjustment->upper - adjustment->lower) > adjustment->page_size);
566 else if (adjustment == gtk_range_get_adjustment (GTK_RANGE (scrolled_win->vscrollbar)))
568 if (scrolled_win->vscrollbar_policy == GTK_POLICY_AUTOMATIC)
570 scrolled_win->vscrollbar_visible =
571 ((adjustment->upper - adjustment->lower) > adjustment->page_size);
576 g_warning ("could not determine which adjustment scrollbar received change signal for");