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 Free
16 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 #include "gtkscrolledwindow.h"
19 #include "gtksignal.h"
22 #define SCROLLBAR_SPACING(w) (GTK_SCROLLED_WINDOW_CLASS (GTK_OBJECT (w)->klass)->scrollbar_spacing)
25 static void gtk_scrolled_window_class_init (GtkScrolledWindowClass *klass);
26 static void gtk_scrolled_window_init (GtkScrolledWindow *scrolled_window);
27 static void gtk_scrolled_window_destroy (GtkObject *object);
28 static void gtk_scrolled_window_finalize (GtkObject *object);
29 static void gtk_scrolled_window_map (GtkWidget *widget);
30 static void gtk_scrolled_window_unmap (GtkWidget *widget);
31 static void gtk_scrolled_window_draw (GtkWidget *widget,
33 static void gtk_scrolled_window_size_request (GtkWidget *widget,
34 GtkRequisition *requisition);
35 static void gtk_scrolled_window_size_allocate (GtkWidget *widget,
36 GtkAllocation *allocation);
37 static void gtk_scrolled_window_add (GtkContainer *container,
39 static void gtk_scrolled_window_remove (GtkContainer *container,
41 static void gtk_scrolled_window_foreach (GtkContainer *container,
43 gpointer callback_data);
44 static void gtk_scrolled_window_viewport_allocate (GtkWidget *widget,
45 GtkAllocation *allocation);
46 static void gtk_scrolled_window_adjustment_changed (GtkAdjustment *adjustment,
50 static GtkContainerClass *parent_class = NULL;
54 gtk_scrolled_window_get_type ()
56 static guint scrolled_window_type = 0;
58 if (!scrolled_window_type)
60 GtkTypeInfo scrolled_window_info =
63 sizeof (GtkScrolledWindow),
64 sizeof (GtkScrolledWindowClass),
65 (GtkClassInitFunc) gtk_scrolled_window_class_init,
66 (GtkObjectInitFunc) gtk_scrolled_window_init,
71 scrolled_window_type = gtk_type_unique (gtk_container_get_type (), &scrolled_window_info);
74 return scrolled_window_type;
78 gtk_scrolled_window_class_init (GtkScrolledWindowClass *class)
80 GtkObjectClass *object_class;
81 GtkWidgetClass *widget_class;
82 GtkContainerClass *container_class;
84 object_class = (GtkObjectClass*) class;
85 widget_class = (GtkWidgetClass*) class;
86 container_class = (GtkContainerClass*) class;
88 parent_class = gtk_type_class (gtk_container_get_type ());
90 object_class->destroy = gtk_scrolled_window_destroy;
91 object_class->finalize = gtk_scrolled_window_finalize;
93 widget_class->map = gtk_scrolled_window_map;
94 widget_class->unmap = gtk_scrolled_window_unmap;
95 widget_class->draw = gtk_scrolled_window_draw;
96 widget_class->size_request = gtk_scrolled_window_size_request;
97 widget_class->size_allocate = gtk_scrolled_window_size_allocate;
99 container_class->add = gtk_scrolled_window_add;
100 container_class->remove = gtk_scrolled_window_remove;
101 container_class->foreach = gtk_scrolled_window_foreach;
103 class->scrollbar_spacing = 5;
107 gtk_scrolled_window_init (GtkScrolledWindow *scrolled_window)
109 GTK_WIDGET_SET_FLAGS (scrolled_window, GTK_NO_WINDOW);
111 scrolled_window->hscrollbar = NULL;
112 scrolled_window->vscrollbar = NULL;
113 scrolled_window->hscrollbar_policy = GTK_POLICY_ALWAYS;
114 scrolled_window->vscrollbar_policy = GTK_POLICY_ALWAYS;
118 gtk_scrolled_window_new (GtkAdjustment *hadjustment,
119 GtkAdjustment *vadjustment)
121 GtkWidget *scrolled_window;
123 scrolled_window = gtk_type_new (gtk_scrolled_window_get_type ());
125 gtk_scrolled_window_construct (GTK_SCROLLED_WINDOW (scrolled_window), hadjustment, vadjustment);
127 return scrolled_window;
131 gtk_scrolled_window_construct (GtkScrolledWindow *scrolled_window,
132 GtkAdjustment *hadjustment,
133 GtkAdjustment *vadjustment)
135 g_return_if_fail (scrolled_window != NULL);
136 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
137 g_return_if_fail (scrolled_window->viewport == NULL);
139 scrolled_window->viewport = gtk_viewport_new (hadjustment, vadjustment);
140 hadjustment = gtk_viewport_get_hadjustment (GTK_VIEWPORT (scrolled_window->viewport));
141 vadjustment = gtk_viewport_get_vadjustment (GTK_VIEWPORT (scrolled_window->viewport));
143 gtk_signal_connect (GTK_OBJECT (hadjustment), "changed",
144 (GtkSignalFunc) gtk_scrolled_window_adjustment_changed,
145 (gpointer) scrolled_window);
146 gtk_signal_connect (GTK_OBJECT (vadjustment), "changed",
147 (GtkSignalFunc) gtk_scrolled_window_adjustment_changed,
148 (gpointer) scrolled_window);
150 scrolled_window->hscrollbar = gtk_hscrollbar_new (hadjustment);
151 scrolled_window->vscrollbar = gtk_vscrollbar_new (vadjustment);
153 gtk_widget_set_parent (scrolled_window->viewport, GTK_WIDGET (scrolled_window));
154 gtk_widget_set_parent (scrolled_window->hscrollbar, GTK_WIDGET (scrolled_window));
155 gtk_widget_set_parent (scrolled_window->vscrollbar, GTK_WIDGET (scrolled_window));
157 gtk_widget_show (scrolled_window->viewport);
158 gtk_widget_show (scrolled_window->hscrollbar);
159 gtk_widget_show (scrolled_window->vscrollbar);
161 gtk_widget_ref (scrolled_window->viewport);
162 gtk_widget_ref (scrolled_window->hscrollbar);
163 gtk_widget_ref (scrolled_window->vscrollbar);
167 gtk_scrolled_window_get_hadjustment (GtkScrolledWindow *scrolled_window)
169 g_return_val_if_fail (scrolled_window != NULL, NULL);
170 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
172 return gtk_range_get_adjustment (GTK_RANGE (scrolled_window->hscrollbar));
176 gtk_scrolled_window_get_vadjustment (GtkScrolledWindow *scrolled_window)
178 g_return_val_if_fail (scrolled_window != NULL, NULL);
179 g_return_val_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window), NULL);
181 return gtk_range_get_adjustment (GTK_RANGE (scrolled_window->vscrollbar));
185 gtk_scrolled_window_set_policy (GtkScrolledWindow *scrolled_window,
186 GtkPolicyType hscrollbar_policy,
187 GtkPolicyType vscrollbar_policy)
189 g_return_if_fail (scrolled_window != NULL);
190 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (scrolled_window));
192 if ((scrolled_window->hscrollbar_policy != hscrollbar_policy) ||
193 (scrolled_window->vscrollbar_policy != vscrollbar_policy))
195 scrolled_window->hscrollbar_policy = hscrollbar_policy;
196 scrolled_window->vscrollbar_policy = vscrollbar_policy;
198 if (GTK_WIDGET (scrolled_window)->parent)
199 gtk_widget_queue_resize (GTK_WIDGET (scrolled_window));
205 gtk_scrolled_window_destroy (GtkObject *object)
207 GtkScrolledWindow *scrolled_window;
209 g_return_if_fail (object != NULL);
210 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (object));
212 scrolled_window = GTK_SCROLLED_WINDOW (object);
214 gtk_widget_destroy (scrolled_window->viewport);
215 gtk_widget_destroy (scrolled_window->hscrollbar);
216 gtk_widget_destroy (scrolled_window->vscrollbar);
218 if (GTK_OBJECT_CLASS (parent_class)->destroy)
219 (* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
223 gtk_scrolled_window_finalize (GtkObject *object)
225 GtkScrolledWindow *scrolled_window;
227 scrolled_window = GTK_SCROLLED_WINDOW (object);
228 gtk_widget_unref (scrolled_window->viewport);
229 gtk_widget_unref (scrolled_window->hscrollbar);
230 gtk_widget_unref (scrolled_window->vscrollbar);
232 GTK_OBJECT_CLASS (parent_class)->finalize (object);
236 gtk_scrolled_window_map (GtkWidget *widget)
238 GtkScrolledWindow *scrolled_window;
240 g_return_if_fail (widget != NULL);
241 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (widget));
243 if (!GTK_WIDGET_MAPPED (widget))
245 GTK_WIDGET_SET_FLAGS (widget, GTK_MAPPED);
246 scrolled_window = GTK_SCROLLED_WINDOW (widget);
248 if (GTK_WIDGET_VISIBLE (scrolled_window->viewport) &&
249 !GTK_WIDGET_MAPPED (scrolled_window->viewport))
250 gtk_widget_map (scrolled_window->viewport);
252 if (GTK_WIDGET_VISIBLE (scrolled_window->hscrollbar) &&
253 !GTK_WIDGET_MAPPED (scrolled_window->hscrollbar))
254 gtk_widget_map (scrolled_window->hscrollbar);
256 if (GTK_WIDGET_VISIBLE (scrolled_window->vscrollbar) &&
257 !GTK_WIDGET_MAPPED (scrolled_window->vscrollbar))
258 gtk_widget_map (scrolled_window->vscrollbar);
263 gtk_scrolled_window_unmap (GtkWidget *widget)
265 GtkScrolledWindow *scrolled_window;
267 g_return_if_fail (widget != NULL);
268 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (widget));
270 if (GTK_WIDGET_MAPPED (widget))
272 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
273 scrolled_window = GTK_SCROLLED_WINDOW (widget);
275 if (GTK_WIDGET_MAPPED (scrolled_window->viewport))
276 gtk_widget_unmap (scrolled_window->viewport);
278 if (GTK_WIDGET_MAPPED (scrolled_window->hscrollbar))
279 gtk_widget_unmap (scrolled_window->hscrollbar);
281 if (GTK_WIDGET_MAPPED (scrolled_window->vscrollbar))
282 gtk_widget_unmap (scrolled_window->vscrollbar);
287 gtk_scrolled_window_draw (GtkWidget *widget,
290 GtkScrolledWindow *scrolled_window;
291 GdkRectangle child_area;
293 g_return_if_fail (widget != NULL);
294 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (widget));
295 g_return_if_fail (area != NULL);
297 if (GTK_WIDGET_DRAWABLE (widget))
299 scrolled_window = GTK_SCROLLED_WINDOW (widget);
301 if (gtk_widget_intersect (scrolled_window->viewport, area, &child_area))
302 gtk_widget_draw (scrolled_window->viewport, &child_area);
304 if (gtk_widget_intersect (scrolled_window->hscrollbar, area, &child_area))
305 gtk_widget_draw (scrolled_window->hscrollbar, &child_area);
307 if (gtk_widget_intersect (scrolled_window->vscrollbar, area, &child_area))
308 gtk_widget_draw (scrolled_window->vscrollbar, &child_area);
313 gtk_scrolled_window_size_request (GtkWidget *widget,
314 GtkRequisition *requisition)
316 GtkScrolledWindow *scrolled_window;
320 g_return_if_fail (widget != NULL);
321 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (widget));
322 g_return_if_fail (requisition != NULL);
324 scrolled_window = GTK_SCROLLED_WINDOW (widget);
326 requisition->width = 0;
327 requisition->height = 0;
329 if (GTK_WIDGET_VISIBLE (scrolled_window->viewport))
331 gtk_widget_size_request (scrolled_window->viewport, &scrolled_window->viewport->requisition);
333 requisition->width += scrolled_window->viewport->requisition.width;
334 requisition->height += scrolled_window->viewport->requisition.height;
340 if ((scrolled_window->hscrollbar_policy == GTK_POLICY_AUTOMATIC) ||
341 GTK_WIDGET_VISIBLE (scrolled_window->hscrollbar))
343 gtk_widget_size_request (scrolled_window->hscrollbar,
344 &scrolled_window->hscrollbar->requisition);
346 requisition->width = MAX (requisition->width, scrolled_window->hscrollbar->requisition.width);
347 extra_height = SCROLLBAR_SPACING (scrolled_window) + scrolled_window->hscrollbar->requisition.height;
350 if ((scrolled_window->vscrollbar_policy == GTK_POLICY_AUTOMATIC) ||
351 GTK_WIDGET_VISIBLE (scrolled_window->vscrollbar))
353 gtk_widget_size_request (scrolled_window->vscrollbar,
354 &scrolled_window->vscrollbar->requisition);
356 requisition->height = MAX (requisition->height, scrolled_window->vscrollbar->requisition.height);
357 extra_width = SCROLLBAR_SPACING (scrolled_window) + scrolled_window->vscrollbar->requisition.width;
360 requisition->width += GTK_CONTAINER (widget)->border_width * 2 + extra_width;
361 requisition->height += GTK_CONTAINER (widget)->border_width * 2 + extra_height;
365 gtk_scrolled_window_size_allocate (GtkWidget *widget,
366 GtkAllocation *allocation)
368 GtkScrolledWindow *scrolled_window;
369 GtkAllocation viewport_allocation;
370 GtkAllocation child_allocation;
374 g_return_if_fail (widget != NULL);
375 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (widget));
376 g_return_if_fail (allocation != NULL);
378 scrolled_window = GTK_SCROLLED_WINDOW (widget);
379 widget->allocation = *allocation;
381 gtk_scrolled_window_viewport_allocate (widget, &viewport_allocation);
383 gtk_container_disable_resize (GTK_CONTAINER (scrolled_window));
385 if (GTK_WIDGET_VISIBLE (scrolled_window->viewport))
388 gtk_scrolled_window_viewport_allocate (widget, &viewport_allocation);
390 child_allocation.x = viewport_allocation.x + allocation->x;
391 child_allocation.y = viewport_allocation.y + allocation->y;
392 child_allocation.width = viewport_allocation.width;
393 child_allocation.height = viewport_allocation.height;
395 previous_hvis = GTK_WIDGET_VISIBLE (scrolled_window->hscrollbar);
396 previous_vvis = GTK_WIDGET_VISIBLE (scrolled_window->vscrollbar);
398 gtk_widget_size_allocate (scrolled_window->viewport, &child_allocation);
399 } while ((previous_hvis != GTK_WIDGET_VISIBLE (scrolled_window->hscrollbar)) ||
400 (previous_vvis != GTK_WIDGET_VISIBLE (scrolled_window->vscrollbar)));
403 if (GTK_WIDGET_VISIBLE (scrolled_window->hscrollbar))
405 child_allocation.x = viewport_allocation.x;
406 child_allocation.y = viewport_allocation.y + viewport_allocation.height + SCROLLBAR_SPACING (scrolled_window);
407 child_allocation.width = viewport_allocation.width;
408 child_allocation.height = scrolled_window->hscrollbar->requisition.height;
409 child_allocation.x += allocation->x;
410 child_allocation.y += allocation->y;
412 gtk_widget_size_allocate (scrolled_window->hscrollbar, &child_allocation);
415 if (GTK_WIDGET_VISIBLE (scrolled_window->vscrollbar))
417 child_allocation.x = viewport_allocation.x + viewport_allocation.width + SCROLLBAR_SPACING (scrolled_window);
418 child_allocation.y = viewport_allocation.y;
419 child_allocation.width = scrolled_window->vscrollbar->requisition.width;
420 child_allocation.height = viewport_allocation.height;
421 child_allocation.x += allocation->x;
422 child_allocation.y += allocation->y;
424 gtk_widget_size_allocate (scrolled_window->vscrollbar, &child_allocation);
427 gtk_container_enable_resize (GTK_CONTAINER (scrolled_window));
431 gtk_scrolled_window_add (GtkContainer *container,
434 GtkScrolledWindow *scrolled_window;
436 g_return_if_fail (container != NULL);
437 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (container));
438 g_return_if_fail (widget != NULL);
440 scrolled_window = GTK_SCROLLED_WINDOW (container);
441 gtk_container_add (GTK_CONTAINER (scrolled_window->viewport), widget);
445 gtk_scrolled_window_remove (GtkContainer *container,
448 GtkScrolledWindow *scrolled_window;
450 g_return_if_fail (container != NULL);
451 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (container));
452 g_return_if_fail (widget != NULL);
454 scrolled_window = GTK_SCROLLED_WINDOW (container);
456 if (scrolled_window->viewport == widget ||
457 scrolled_window->hscrollbar == widget ||
458 scrolled_window->vscrollbar == widget)
460 /* this happens during destroy */
461 gtk_widget_unparent (widget);
464 gtk_container_remove (GTK_CONTAINER (scrolled_window->viewport), widget);
468 gtk_scrolled_window_foreach (GtkContainer *container,
469 GtkCallback callback,
470 gpointer callback_data)
472 GtkScrolledWindow *scrolled_window;
474 g_return_if_fail (container != NULL);
475 g_return_if_fail (GTK_IS_SCROLLED_WINDOW (container));
476 g_return_if_fail (callback != NULL);
478 scrolled_window = GTK_SCROLLED_WINDOW (container);
480 (* callback) (scrolled_window->viewport, callback_data);
484 gtk_scrolled_window_viewport_allocate (GtkWidget *widget,
485 GtkAllocation *allocation)
487 GtkScrolledWindow *scrolled_window;
489 g_return_if_fail (widget != NULL);
490 g_return_if_fail (allocation != NULL);
492 scrolled_window = GTK_SCROLLED_WINDOW (widget);
494 allocation->x = GTK_CONTAINER (widget)->border_width;
495 allocation->y = GTK_CONTAINER (widget)->border_width;
496 allocation->width = MAX (0, widget->allocation.width - allocation->x * 2);
497 allocation->height = MAX (0, widget->allocation.height - allocation->y * 2);
499 if (GTK_WIDGET_VISIBLE (scrolled_window->vscrollbar))
500 allocation->width = MAX (0,
501 allocation->width - (scrolled_window->vscrollbar->requisition.width + SCROLLBAR_SPACING (scrolled_window)));
502 if (GTK_WIDGET_VISIBLE (scrolled_window->hscrollbar))
503 allocation->height = MAX (0,
504 allocation->height - (scrolled_window->hscrollbar->requisition.height + SCROLLBAR_SPACING (scrolled_window)));
508 gtk_scrolled_window_adjustment_changed (GtkAdjustment *adjustment,
511 GtkScrolledWindow *scrolled_win;
512 GtkWidget *scrollbar;
516 g_return_if_fail (adjustment != NULL);
517 g_return_if_fail (data != NULL);
519 scrolled_win = GTK_SCROLLED_WINDOW (data);
521 if (adjustment == gtk_range_get_adjustment (GTK_RANGE (scrolled_win->hscrollbar)))
523 scrollbar = scrolled_win->hscrollbar;
524 policy = scrolled_win->hscrollbar_policy;
526 else if (adjustment == gtk_range_get_adjustment (GTK_RANGE (scrolled_win->vscrollbar)))
528 scrollbar = scrolled_win->vscrollbar;
529 policy = scrolled_win->vscrollbar_policy;
533 g_warning ("could not determine which adjustment scrollbar received change signal for");
537 if (policy == GTK_POLICY_AUTOMATIC)
539 hide_scrollbar = FALSE;
541 if ((adjustment->upper - adjustment->lower) <= adjustment->page_size)
542 hide_scrollbar = TRUE;
546 if (GTK_WIDGET_VISIBLE (scrollbar))
547 gtk_widget_hide (scrollbar);
551 if (!GTK_WIDGET_VISIBLE (scrollbar))
552 gtk_widget_show (scrollbar);