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 "gtksignal.h"
20 #include "gtkviewport.h"
23 static void gtk_viewport_class_init (GtkViewportClass *klass);
24 static void gtk_viewport_init (GtkViewport *viewport);
25 static void gtk_viewport_finalize (GtkObject *object);
26 static void gtk_viewport_map (GtkWidget *widget);
27 static void gtk_viewport_unmap (GtkWidget *widget);
28 static void gtk_viewport_realize (GtkWidget *widget);
29 static void gtk_viewport_unrealize (GtkWidget *widget);
30 static void gtk_viewport_paint (GtkWidget *widget,
32 static void gtk_viewport_draw (GtkWidget *widget,
34 static gint gtk_viewport_expose (GtkWidget *widget,
35 GdkEventExpose *event);
36 static void gtk_viewport_add (GtkContainer *container,
38 static void gtk_viewport_size_request (GtkWidget *widget,
39 GtkRequisition *requisition);
40 static void gtk_viewport_size_allocate (GtkWidget *widget,
41 GtkAllocation *allocation);
42 static gint gtk_viewport_need_resize (GtkContainer *container);
43 static void gtk_viewport_adjustment_changed (GtkAdjustment *adjustment,
45 static void gtk_viewport_adjustment_value_changed (GtkAdjustment *adjustment,
48 static GtkBinClass *parent_class;
51 gtk_viewport_get_type ()
53 static guint viewport_type = 0;
57 GtkTypeInfo viewport_info =
61 sizeof (GtkViewportClass),
62 (GtkClassInitFunc) gtk_viewport_class_init,
63 (GtkObjectInitFunc) gtk_viewport_init,
68 viewport_type = gtk_type_unique (gtk_bin_get_type (), &viewport_info);
75 gtk_viewport_class_init (GtkViewportClass *class)
77 GtkObjectClass *object_class;
78 GtkWidgetClass *widget_class;
79 GtkContainerClass *container_class;
81 object_class = (GtkObjectClass*) class;
82 widget_class = (GtkWidgetClass*) class;
83 container_class = (GtkContainerClass*) class;
84 parent_class = (GtkBinClass*) gtk_type_class (gtk_bin_get_type ());
86 object_class->finalize = gtk_viewport_finalize;
88 widget_class->map = gtk_viewport_map;
89 widget_class->unmap = gtk_viewport_unmap;
90 widget_class->realize = gtk_viewport_realize;
91 widget_class->unrealize = gtk_viewport_unrealize;
92 widget_class->draw = gtk_viewport_draw;
93 widget_class->expose_event = gtk_viewport_expose;
94 widget_class->size_request = gtk_viewport_size_request;
95 widget_class->size_allocate = gtk_viewport_size_allocate;
97 container_class->add = gtk_viewport_add;
98 container_class->need_resize = gtk_viewport_need_resize;
102 gtk_viewport_init (GtkViewport *viewport)
104 GTK_WIDGET_UNSET_FLAGS (viewport, GTK_NO_WINDOW);
105 GTK_WIDGET_SET_FLAGS (viewport, GTK_BASIC);
107 viewport->shadow_type = GTK_SHADOW_IN;
108 viewport->view_window = NULL;
109 viewport->bin_window = NULL;
110 viewport->hadjustment = NULL;
111 viewport->vadjustment = NULL;
115 gtk_viewport_new (GtkAdjustment *hadjustment,
116 GtkAdjustment *vadjustment)
118 GtkViewport *viewport;
120 viewport = gtk_type_new (gtk_viewport_get_type ());
123 hadjustment = (GtkAdjustment*) gtk_adjustment_new (0.0, 0.0, 0.0, 0.0, 0.0, 0.0);
126 vadjustment = (GtkAdjustment*) gtk_adjustment_new (0.0, 0.0, 0.0, 0.0, 0.0, 0.0);
128 gtk_viewport_set_hadjustment (viewport, hadjustment);
129 gtk_viewport_set_vadjustment (viewport, vadjustment);
131 return GTK_WIDGET (viewport);
135 gtk_viewport_finalize (GtkObject *object)
137 GtkViewport *viewport = GTK_VIEWPORT (object);
139 gtk_object_unref (GTK_OBJECT (viewport->hadjustment));
140 gtk_object_unref (GTK_OBJECT (viewport->vadjustment));
142 GTK_OBJECT_CLASS(parent_class)->finalize (object);
146 gtk_viewport_get_hadjustment (GtkViewport *viewport)
148 g_return_val_if_fail (viewport != NULL, NULL);
149 g_return_val_if_fail (GTK_IS_VIEWPORT (viewport), NULL);
151 return viewport->hadjustment;
155 gtk_viewport_get_vadjustment (GtkViewport *viewport)
157 g_return_val_if_fail (viewport != NULL, NULL);
158 g_return_val_if_fail (GTK_IS_VIEWPORT (viewport), NULL);
160 return viewport->vadjustment;
164 gtk_viewport_set_hadjustment (GtkViewport *viewport,
165 GtkAdjustment *adjustment)
167 g_return_if_fail (viewport != NULL);
168 g_return_if_fail (GTK_IS_VIEWPORT (viewport));
169 g_return_if_fail (adjustment != NULL);
171 if (viewport->hadjustment != adjustment)
173 if (viewport->hadjustment)
175 gtk_signal_disconnect_by_data (GTK_OBJECT (viewport->hadjustment),
176 (gpointer) viewport);
177 gtk_object_unref (GTK_OBJECT (viewport->hadjustment));
180 viewport->hadjustment = adjustment;
181 gtk_object_ref (GTK_OBJECT (viewport->hadjustment));
182 gtk_object_sink (GTK_OBJECT (viewport->hadjustment));
184 gtk_signal_connect (GTK_OBJECT (adjustment), "changed",
185 (GtkSignalFunc) gtk_viewport_adjustment_changed,
186 (gpointer) viewport);
187 gtk_signal_connect (GTK_OBJECT (adjustment), "value_changed",
188 (GtkSignalFunc)gtk_viewport_adjustment_value_changed,
189 (gpointer) viewport);
191 gtk_viewport_adjustment_changed (adjustment, (gpointer) viewport);
196 gtk_viewport_set_vadjustment (GtkViewport *viewport,
197 GtkAdjustment *adjustment)
199 g_return_if_fail (viewport != NULL);
200 g_return_if_fail (GTK_IS_VIEWPORT (viewport));
201 g_return_if_fail (adjustment != NULL);
203 if (viewport->vadjustment != adjustment)
205 if (viewport->vadjustment)
207 gtk_signal_disconnect_by_data (GTK_OBJECT (viewport->vadjustment),
208 (gpointer) viewport);
209 gtk_object_unref (GTK_OBJECT (viewport->vadjustment));
212 viewport->vadjustment = adjustment;
213 gtk_object_ref (GTK_OBJECT (viewport->vadjustment));
214 gtk_object_sink (GTK_OBJECT (viewport->vadjustment));
216 gtk_signal_connect (GTK_OBJECT (adjustment), "changed",
217 (GtkSignalFunc) gtk_viewport_adjustment_changed,
218 (gpointer) viewport);
219 gtk_signal_connect (GTK_OBJECT (adjustment), "value_changed",
220 (GtkSignalFunc)gtk_viewport_adjustment_value_changed,
221 (gpointer) viewport);
223 gtk_viewport_adjustment_changed (adjustment, (gpointer) viewport);
228 gtk_viewport_set_shadow_type (GtkViewport *viewport,
231 g_return_if_fail (viewport != NULL);
232 g_return_if_fail (GTK_IS_VIEWPORT (viewport));
234 if ((GtkShadowType) viewport->shadow_type != type)
236 viewport->shadow_type = type;
238 if (GTK_WIDGET_VISIBLE (viewport))
240 gtk_widget_size_allocate (GTK_WIDGET (viewport), &(GTK_WIDGET (viewport)->allocation));
241 gtk_widget_queue_draw (GTK_WIDGET (viewport));
248 gtk_viewport_map (GtkWidget *widget)
252 g_return_if_fail (widget != NULL);
253 g_return_if_fail (GTK_IS_VIEWPORT (widget));
255 GTK_WIDGET_SET_FLAGS (widget, GTK_MAPPED);
256 bin = GTK_BIN (widget);
258 gdk_window_show (widget->window);
261 GTK_WIDGET_VISIBLE (bin->child) &&
262 !GTK_WIDGET_MAPPED (bin->child))
263 gtk_widget_map (bin->child);
267 gtk_viewport_unmap (GtkWidget *widget)
269 g_return_if_fail (widget != NULL);
270 g_return_if_fail (GTK_IS_VIEWPORT (widget));
272 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
274 gdk_window_hide (widget->window);
278 gtk_viewport_realize (GtkWidget *widget)
281 GtkViewport *viewport;
282 GdkWindowAttr attributes;
283 gint attributes_mask;
287 g_return_if_fail (widget != NULL);
288 g_return_if_fail (GTK_IS_VIEWPORT (widget));
290 border_width = GTK_CONTAINER (widget)->border_width;
292 bin = GTK_BIN (widget);
293 viewport = GTK_VIEWPORT (widget);
294 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
296 attributes.x = widget->allocation.x + border_width;
297 attributes.y = widget->allocation.y + border_width;
298 attributes.width = widget->allocation.width - border_width * 2;
299 attributes.height = widget->allocation.height - border_width * 2;
300 attributes.window_type = GDK_WINDOW_CHILD;
301 attributes.wclass = GDK_INPUT_OUTPUT;
302 attributes.visual = gtk_widget_get_visual (widget);
303 attributes.colormap = gtk_widget_get_colormap (widget);
305 event_mask = gtk_widget_get_events (widget) | GDK_EXPOSURE_MASK;
306 attributes.event_mask = event_mask;
308 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
310 widget->window = gdk_window_new (gtk_widget_get_parent_window (widget),
311 &attributes, attributes_mask);
312 gdk_window_set_user_data (widget->window, viewport);
314 if (viewport->shadow_type != GTK_SHADOW_NONE)
316 attributes.x = widget->style->klass->xthickness;
317 attributes.y = widget->style->klass->ythickness;
325 attributes.width = MAX (1, widget->allocation.width - attributes.x * 2 - border_width * 2);
326 attributes.height = MAX (1, widget->allocation.height - attributes.y * 2 - border_width * 2);
327 attributes.event_mask = 0;
329 viewport->view_window = gdk_window_new (widget->window, &attributes, attributes_mask);
330 gdk_window_set_user_data (viewport->view_window, viewport);
337 attributes.width = viewport->hadjustment->upper;
338 attributes.height = viewport->vadjustment->upper;
341 attributes.event_mask = event_mask;
343 viewport->bin_window = gdk_window_new (viewport->view_window, &attributes, attributes_mask);
344 gdk_window_set_user_data (viewport->bin_window, viewport);
347 gtk_widget_set_parent_window (bin->child, viewport->bin_window);
349 widget->style = gtk_style_attach (widget->style, widget->window);
350 gtk_style_set_background (widget->style, widget->window, GTK_STATE_NORMAL);
351 gtk_style_set_background (widget->style, viewport->bin_window, GTK_STATE_NORMAL);
353 gdk_window_show (viewport->bin_window);
354 gdk_window_show (viewport->view_window);
358 gtk_viewport_unrealize (GtkWidget *widget)
360 GtkViewport *viewport;
362 g_return_if_fail (widget != NULL);
363 g_return_if_fail (GTK_IS_VIEWPORT (widget));
365 viewport = GTK_VIEWPORT (widget);
367 gdk_window_set_user_data (viewport->view_window, NULL);
368 gdk_window_destroy (viewport->view_window);
369 viewport->view_window = NULL;
371 gdk_window_set_user_data (viewport->bin_window, NULL);
372 gdk_window_destroy (viewport->bin_window);
373 viewport->bin_window = NULL;
375 if (GTK_WIDGET_CLASS (parent_class)->unrealize)
376 (* GTK_WIDGET_CLASS (parent_class)->unrealize) (widget);
380 gtk_viewport_paint (GtkWidget *widget,
383 GtkViewport *viewport;
385 g_return_if_fail (widget != NULL);
386 g_return_if_fail (GTK_IS_VIEWPORT (widget));
387 g_return_if_fail (area != NULL);
389 if (GTK_WIDGET_DRAWABLE (widget))
391 viewport = GTK_VIEWPORT (widget);
393 gtk_draw_shadow (widget->style, widget->window,
394 GTK_STATE_NORMAL, viewport->shadow_type,
400 gtk_viewport_draw (GtkWidget *widget,
403 GtkViewport *viewport;
405 GdkRectangle tmp_area;
406 GdkRectangle child_area;
409 g_return_if_fail (widget != NULL);
410 g_return_if_fail (GTK_IS_VIEWPORT (widget));
411 g_return_if_fail (area != NULL);
413 if (GTK_WIDGET_DRAWABLE (widget))
415 viewport = GTK_VIEWPORT (widget);
416 bin = GTK_BIN (widget);
418 border_width = GTK_CONTAINER (widget)->border_width;
421 tmp_area.x -= border_width;
422 tmp_area.y -= border_width;
424 gtk_viewport_paint (widget, &tmp_area);
428 tmp_area.x += viewport->hadjustment->value - widget->style->klass->xthickness;
429 tmp_area.y += viewport->vadjustment->value - widget->style->klass->ythickness;
431 if (gtk_widget_intersect (bin->child, &tmp_area, &child_area))
432 gtk_widget_draw (bin->child, &child_area);
438 gtk_viewport_expose (GtkWidget *widget,
439 GdkEventExpose *event)
441 GtkViewport *viewport;
443 GdkEventExpose child_event;
445 g_return_val_if_fail (widget != NULL, FALSE);
446 g_return_val_if_fail (GTK_IS_VIEWPORT (widget), FALSE);
447 g_return_val_if_fail (event != NULL, FALSE);
449 if (GTK_WIDGET_DRAWABLE (widget))
451 viewport = GTK_VIEWPORT (widget);
452 bin = GTK_BIN (widget);
454 if (event->window == widget->window)
455 gtk_viewport_paint (widget, &event->area);
457 child_event = *event;
458 if ((event->window == viewport->bin_window) &&
459 (bin->child != NULL) &&
460 GTK_WIDGET_NO_WINDOW (bin->child) &&
461 gtk_widget_intersect (bin->child, &event->area, &child_event.area))
462 gtk_widget_event (bin->child, (GdkEvent*) &child_event);
469 gtk_viewport_add (GtkContainer *container,
474 g_return_if_fail (container != NULL);
475 g_return_if_fail (GTK_IS_VIEWPORT (container));
476 g_return_if_fail (widget != NULL);
478 bin = GTK_BIN (container);
482 gtk_widget_set_parent (widget, GTK_WIDGET (container));
483 gtk_widget_set_parent_window (widget, GTK_VIEWPORT (container)->bin_window);
484 if (GTK_WIDGET_VISIBLE (widget->parent))
486 if (GTK_WIDGET_MAPPED (widget->parent) &&
487 !GTK_WIDGET_MAPPED (widget))
488 gtk_widget_map (widget);
493 if (GTK_WIDGET_VISIBLE (widget) && GTK_WIDGET_VISIBLE (container))
494 gtk_widget_queue_resize (widget);
499 gtk_viewport_size_request (GtkWidget *widget,
500 GtkRequisition *requisition)
502 GtkViewport *viewport;
505 g_return_if_fail (widget != NULL);
506 g_return_if_fail (GTK_IS_VIEWPORT (widget));
507 g_return_if_fail (requisition != NULL);
509 viewport = GTK_VIEWPORT (widget);
510 bin = GTK_BIN (widget);
512 requisition->width = (GTK_CONTAINER (widget)->border_width +
513 GTK_WIDGET (widget)->style->klass->xthickness) * 2 + 5;
515 requisition->height = (GTK_CONTAINER (widget)->border_width * 2 +
516 GTK_WIDGET (widget)->style->klass->ythickness) * 2 + 5;
518 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
519 gtk_widget_size_request (bin->child, &bin->child->requisition);
523 gtk_viewport_size_allocate (GtkWidget *widget,
524 GtkAllocation *allocation)
526 GtkViewport *viewport;
528 GtkAllocation child_allocation;
532 g_return_if_fail (widget != NULL);
533 g_return_if_fail (GTK_IS_VIEWPORT (widget));
534 g_return_if_fail (allocation != NULL);
536 widget->allocation = *allocation;
537 viewport = GTK_VIEWPORT (widget);
538 bin = GTK_BIN (widget);
540 border_width = GTK_CONTAINER (widget)->border_width;
542 child_allocation.x = 0;
543 child_allocation.y = 0;
545 if (viewport->shadow_type != GTK_SHADOW_NONE)
547 child_allocation.x = GTK_WIDGET (viewport)->style->klass->xthickness;
548 child_allocation.y = GTK_WIDGET (viewport)->style->klass->ythickness;
551 child_allocation.width = MAX (1, allocation->width - child_allocation.x * 2 - border_width * 2);
552 child_allocation.height = MAX (1, allocation->height - child_allocation.y * 2 - border_width * 2);
554 if (GTK_WIDGET_REALIZED (widget))
556 gdk_window_move_resize (widget->window,
557 allocation->x + border_width,
558 allocation->y + border_width,
559 allocation->width - border_width * 2,
560 allocation->height - border_width * 2);
562 gdk_window_move_resize (viewport->view_window,
565 child_allocation.width,
566 child_allocation.height);
569 viewport->hadjustment->page_size = child_allocation.width;
570 viewport->hadjustment->page_increment = viewport->hadjustment->page_size / 2;
571 viewport->hadjustment->step_increment = 10;
573 viewport->vadjustment->page_size = child_allocation.height;
574 viewport->vadjustment->page_increment = viewport->vadjustment->page_size / 2;
575 viewport->vadjustment->step_increment = 10;
577 hval = viewport->hadjustment->value;
578 vval = viewport->vadjustment->value;
580 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
582 viewport->hadjustment->lower = 0;
583 viewport->hadjustment->upper = MAX (bin->child->requisition.width,
584 child_allocation.width);
586 hval = CLAMP (hval, 0,
587 viewport->hadjustment->upper -
588 viewport->hadjustment->page_size);
590 viewport->vadjustment->lower = 0;
591 viewport->vadjustment->upper = MAX (bin->child->requisition.height,
592 child_allocation.height);
594 vval = CLAMP (vval, 0,
595 viewport->vadjustment->upper -
596 viewport->vadjustment->page_size);
599 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
601 child_allocation.x = 0;
602 child_allocation.y = 0;
604 child_allocation.width = viewport->hadjustment->upper;
605 child_allocation.height = viewport->vadjustment->upper;
607 if (!GTK_WIDGET_REALIZED (widget))
608 gtk_widget_realize (widget);
610 gdk_window_resize (viewport->bin_window,
611 child_allocation.width,
612 child_allocation.height);
614 child_allocation.x = 0;
615 child_allocation.y = 0;
616 gtk_widget_size_allocate (bin->child, &child_allocation);
619 gtk_signal_emit_by_name (GTK_OBJECT (viewport->hadjustment), "changed");
620 gtk_signal_emit_by_name (GTK_OBJECT (viewport->vadjustment), "changed");
621 if (viewport->hadjustment->value != hval)
623 viewport->hadjustment->value = hval;
624 gtk_signal_emit_by_name (GTK_OBJECT (viewport->hadjustment), "value_changed");
626 if (viewport->vadjustment->value != vval)
628 viewport->vadjustment->value = vval;
629 gtk_signal_emit_by_name (GTK_OBJECT (viewport->vadjustment), "value_changed");
634 gtk_viewport_need_resize (GtkContainer *container)
638 g_return_val_if_fail (container != NULL, FALSE);
639 g_return_val_if_fail (GTK_IS_VIEWPORT (container), FALSE);
641 if (GTK_WIDGET_REALIZED (container))
643 bin = GTK_BIN (container);
645 gtk_widget_size_request (bin->child, &bin->child->requisition);
647 gtk_widget_size_allocate (GTK_WIDGET (container),
648 &(GTK_WIDGET (container)->allocation));
655 gtk_viewport_adjustment_changed (GtkAdjustment *adjustment,
658 GtkViewport *viewport;
660 g_return_if_fail (adjustment != NULL);
661 g_return_if_fail (data != NULL);
662 g_return_if_fail (GTK_IS_VIEWPORT (data));
664 viewport = GTK_VIEWPORT (data);
668 gtk_viewport_adjustment_value_changed (GtkAdjustment *adjustment,
671 GtkViewport *viewport;
673 GtkAllocation child_allocation;
676 g_return_if_fail (adjustment != NULL);
677 g_return_if_fail (data != NULL);
678 g_return_if_fail (GTK_IS_VIEWPORT (data));
680 viewport = GTK_VIEWPORT (data);
681 bin = GTK_BIN (data);
683 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
685 gdk_window_get_size (viewport->view_window, &width, &height);
687 child_allocation.x = 0;
688 child_allocation.y = 0;
690 if (viewport->hadjustment->lower != (viewport->hadjustment->upper -
691 viewport->hadjustment->page_size))
692 child_allocation.x = viewport->hadjustment->lower - viewport->hadjustment->value;
694 if (viewport->vadjustment->lower != (viewport->vadjustment->upper -
695 viewport->vadjustment->page_size))
696 child_allocation.y = viewport->vadjustment->lower - viewport->vadjustment->value;
698 if (GTK_WIDGET_REALIZED (viewport))
699 gdk_window_move (viewport->bin_window,