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"
31 static void gtk_viewport_class_init (GtkViewportClass *klass);
32 static void gtk_viewport_init (GtkViewport *viewport);
33 static void gtk_viewport_finalize (GtkObject *object);
34 static void gtk_viewport_set_arg (GtkObject *object,
37 static void gtk_viewport_get_arg (GtkObject *object,
40 static void gtk_viewport_map (GtkWidget *widget);
41 static void gtk_viewport_unmap (GtkWidget *widget);
42 static void gtk_viewport_realize (GtkWidget *widget);
43 static void gtk_viewport_unrealize (GtkWidget *widget);
44 static void gtk_viewport_paint (GtkWidget *widget,
46 static void gtk_viewport_draw (GtkWidget *widget,
48 static gint gtk_viewport_expose (GtkWidget *widget,
49 GdkEventExpose *event);
50 static void gtk_viewport_add (GtkContainer *container,
52 static void gtk_viewport_size_request (GtkWidget *widget,
53 GtkRequisition *requisition);
54 static void gtk_viewport_size_allocate (GtkWidget *widget,
55 GtkAllocation *allocation);
56 static void gtk_viewport_adjustment_changed (GtkAdjustment *adjustment,
58 static void gtk_viewport_adjustment_value_changed (GtkAdjustment *adjustment,
61 static GtkBinClass *parent_class;
64 gtk_viewport_get_type (void)
66 static GtkType viewport_type = 0;
70 GtkTypeInfo viewport_info =
74 sizeof (GtkViewportClass),
75 (GtkClassInitFunc) gtk_viewport_class_init,
76 (GtkObjectInitFunc) gtk_viewport_init,
77 /* reserved_1 */ NULL,
78 /* reserved_2 */ NULL,
79 (GtkClassInitFunc) NULL,
82 viewport_type = gtk_type_unique (GTK_TYPE_BIN, &viewport_info);
89 gtk_viewport_class_init (GtkViewportClass *class)
91 GtkObjectClass *object_class;
92 GtkWidgetClass *widget_class;
93 GtkContainerClass *container_class;
95 object_class = (GtkObjectClass*) class;
96 widget_class = (GtkWidgetClass*) class;
97 container_class = (GtkContainerClass*) class;
98 parent_class = (GtkBinClass*) gtk_type_class (GTK_TYPE_BIN);
100 gtk_object_add_arg_type ("GtkViewport::hadjustment",
102 GTK_ARG_READWRITE | GTK_ARG_CONSTRUCT,
104 gtk_object_add_arg_type ("GtkViewport::vadjustment",
106 GTK_ARG_READWRITE | GTK_ARG_CONSTRUCT,
108 gtk_object_add_arg_type ("GtkViewport::shadow_type",
109 GTK_TYPE_SHADOW_TYPE,
113 object_class->set_arg = gtk_viewport_set_arg;
114 object_class->get_arg = gtk_viewport_get_arg;
115 object_class->finalize = gtk_viewport_finalize;
117 widget_class->map = gtk_viewport_map;
118 widget_class->unmap = gtk_viewport_unmap;
119 widget_class->realize = gtk_viewport_realize;
120 widget_class->unrealize = gtk_viewport_unrealize;
121 widget_class->draw = gtk_viewport_draw;
122 widget_class->expose_event = gtk_viewport_expose;
123 widget_class->size_request = gtk_viewport_size_request;
124 widget_class->size_allocate = gtk_viewport_size_allocate;
126 container_class->add = gtk_viewport_add;
130 gtk_viewport_set_arg (GtkObject *object,
134 GtkViewport *viewport;
136 viewport = GTK_VIEWPORT (object);
140 GtkAdjustment *adjustment;
142 case ARG_HADJUSTMENT:
143 adjustment = GTK_VALUE_POINTER (*arg);
144 gtk_viewport_set_hadjustment (viewport, adjustment);
146 case ARG_VADJUSTMENT:
147 adjustment = GTK_VALUE_POINTER (*arg);
148 gtk_viewport_set_vadjustment (viewport, adjustment);
150 case ARG_SHADOW_TYPE:
151 gtk_viewport_set_shadow_type (viewport, GTK_VALUE_ENUM (*arg));
159 gtk_viewport_get_arg (GtkObject *object,
163 GtkViewport *viewport;
165 viewport = GTK_VIEWPORT (object);
169 case ARG_HADJUSTMENT:
170 GTK_VALUE_POINTER (*arg) = viewport->hadjustment;
172 case ARG_VADJUSTMENT:
173 GTK_VALUE_POINTER (*arg) = viewport->vadjustment;
175 case ARG_SHADOW_TYPE:
176 GTK_VALUE_ENUM (*arg) = viewport->shadow_type;
179 arg->type = GTK_TYPE_INVALID;
185 gtk_viewport_init (GtkViewport *viewport)
187 GTK_WIDGET_UNSET_FLAGS (viewport, GTK_NO_WINDOW);
188 GTK_WIDGET_SET_FLAGS (viewport, GTK_BASIC);
190 gtk_container_set_resize_mode (GTK_CONTAINER (viewport), GTK_RESIZE_QUEUE);
192 viewport->shadow_type = GTK_SHADOW_IN;
193 viewport->view_window = NULL;
194 viewport->bin_window = NULL;
195 viewport->hadjustment = NULL;
196 viewport->vadjustment = NULL;
200 gtk_viewport_new (GtkAdjustment *hadjustment,
201 GtkAdjustment *vadjustment)
203 GtkViewport *viewport;
205 viewport = gtk_type_new (gtk_viewport_get_type ());
207 gtk_viewport_set_hadjustment (viewport, hadjustment);
208 gtk_viewport_set_vadjustment (viewport, vadjustment);
210 return GTK_WIDGET (viewport);
214 gtk_viewport_finalize (GtkObject *object)
216 GtkViewport *viewport = GTK_VIEWPORT (object);
218 gtk_object_unref (GTK_OBJECT (viewport->hadjustment));
219 gtk_object_unref (GTK_OBJECT (viewport->vadjustment));
221 GTK_OBJECT_CLASS(parent_class)->finalize (object);
225 gtk_viewport_get_hadjustment (GtkViewport *viewport)
227 g_return_val_if_fail (viewport != NULL, NULL);
228 g_return_val_if_fail (GTK_IS_VIEWPORT (viewport), NULL);
230 return viewport->hadjustment;
234 gtk_viewport_get_vadjustment (GtkViewport *viewport)
236 g_return_val_if_fail (viewport != NULL, NULL);
237 g_return_val_if_fail (GTK_IS_VIEWPORT (viewport), NULL);
239 return viewport->vadjustment;
243 gtk_viewport_set_hadjustment (GtkViewport *viewport,
244 GtkAdjustment *adjustment)
246 g_return_if_fail (viewport != NULL);
247 g_return_if_fail (GTK_IS_VIEWPORT (viewport));
249 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
251 if (viewport->hadjustment && viewport->hadjustment != adjustment)
253 gtk_signal_disconnect_by_data (GTK_OBJECT (viewport->hadjustment),
254 (gpointer) viewport);
255 gtk_object_unref (GTK_OBJECT (viewport->hadjustment));
259 adjustment = GTK_ADJUSTMENT (gtk_adjustment_new (0.0, 0.0, 0.0,
262 if (viewport->hadjustment != adjustment)
264 viewport->hadjustment = adjustment;
265 gtk_object_ref (GTK_OBJECT (viewport->hadjustment));
266 gtk_object_sink (GTK_OBJECT (viewport->hadjustment));
268 gtk_signal_connect (GTK_OBJECT (adjustment), "changed",
269 (GtkSignalFunc) gtk_viewport_adjustment_changed,
270 (gpointer) viewport);
271 gtk_signal_connect (GTK_OBJECT (adjustment), "value_changed",
272 (GtkSignalFunc) gtk_viewport_adjustment_value_changed,
273 (gpointer) viewport);
275 gtk_viewport_adjustment_changed (adjustment, viewport);
280 gtk_viewport_set_vadjustment (GtkViewport *viewport,
281 GtkAdjustment *adjustment)
283 g_return_if_fail (viewport != NULL);
284 g_return_if_fail (GTK_IS_VIEWPORT (viewport));
286 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
288 if (viewport->vadjustment && viewport->vadjustment != adjustment)
290 gtk_signal_disconnect_by_data (GTK_OBJECT (viewport->vadjustment),
291 (gpointer) viewport);
292 gtk_object_unref (GTK_OBJECT (viewport->vadjustment));
296 adjustment = GTK_ADJUSTMENT (gtk_adjustment_new (0.0, 0.0, 0.0,
299 if (viewport->vadjustment != adjustment)
301 viewport->vadjustment = adjustment;
302 gtk_object_ref (GTK_OBJECT (viewport->vadjustment));
303 gtk_object_sink (GTK_OBJECT (viewport->vadjustment));
305 gtk_signal_connect (GTK_OBJECT (adjustment), "changed",
306 (GtkSignalFunc) gtk_viewport_adjustment_changed,
307 (gpointer) viewport);
308 gtk_signal_connect (GTK_OBJECT (adjustment), "value_changed",
309 (GtkSignalFunc) gtk_viewport_adjustment_value_changed,
310 (gpointer) viewport);
312 gtk_viewport_adjustment_changed (adjustment, viewport);
317 gtk_viewport_set_shadow_type (GtkViewport *viewport,
320 g_return_if_fail (viewport != NULL);
321 g_return_if_fail (GTK_IS_VIEWPORT (viewport));
323 if ((GtkShadowType) viewport->shadow_type != type)
325 viewport->shadow_type = type;
327 if (GTK_WIDGET_VISIBLE (viewport))
329 gtk_widget_size_allocate (GTK_WIDGET (viewport), &(GTK_WIDGET (viewport)->allocation));
330 gtk_widget_queue_draw (GTK_WIDGET (viewport));
337 gtk_viewport_map (GtkWidget *widget)
341 g_return_if_fail (widget != NULL);
342 g_return_if_fail (GTK_IS_VIEWPORT (widget));
344 GTK_WIDGET_SET_FLAGS (widget, GTK_MAPPED);
345 bin = GTK_BIN (widget);
347 gdk_window_show (widget->window);
350 GTK_WIDGET_VISIBLE (bin->child) &&
351 !GTK_WIDGET_MAPPED (bin->child))
352 gtk_widget_map (bin->child);
356 gtk_viewport_unmap (GtkWidget *widget)
358 g_return_if_fail (widget != NULL);
359 g_return_if_fail (GTK_IS_VIEWPORT (widget));
361 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
363 gdk_window_hide (widget->window);
367 gtk_viewport_realize (GtkWidget *widget)
370 GtkViewport *viewport;
371 GdkWindowAttr attributes;
372 gint attributes_mask;
376 g_return_if_fail (widget != NULL);
377 g_return_if_fail (GTK_IS_VIEWPORT (widget));
379 border_width = GTK_CONTAINER (widget)->border_width;
381 bin = GTK_BIN (widget);
382 viewport = GTK_VIEWPORT (widget);
383 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
385 attributes.x = widget->allocation.x + border_width;
386 attributes.y = widget->allocation.y + border_width;
387 attributes.width = widget->allocation.width - border_width * 2;
388 attributes.height = widget->allocation.height - border_width * 2;
389 attributes.window_type = GDK_WINDOW_CHILD;
390 attributes.wclass = GDK_INPUT_OUTPUT;
391 attributes.visual = gtk_widget_get_visual (widget);
392 attributes.colormap = gtk_widget_get_colormap (widget);
394 event_mask = gtk_widget_get_events (widget) | GDK_EXPOSURE_MASK;
395 attributes.event_mask = event_mask;
397 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
399 widget->window = gdk_window_new (gtk_widget_get_parent_window (widget),
400 &attributes, attributes_mask);
401 gdk_window_set_user_data (widget->window, viewport);
403 if (viewport->shadow_type != GTK_SHADOW_NONE)
405 attributes.x = widget->style->klass->xthickness;
406 attributes.y = widget->style->klass->ythickness;
414 attributes.width = MAX (1, widget->allocation.width - attributes.x * 2 - border_width * 2);
415 attributes.height = MAX (1, widget->allocation.height - attributes.y * 2 - border_width * 2);
416 attributes.event_mask = 0;
418 viewport->view_window = gdk_window_new (widget->window, &attributes, attributes_mask);
419 gdk_window_set_user_data (viewport->view_window, viewport);
426 attributes.width = viewport->hadjustment->upper;
427 attributes.height = viewport->vadjustment->upper;
430 attributes.event_mask = event_mask;
432 viewport->bin_window = gdk_window_new (viewport->view_window, &attributes, attributes_mask);
433 gdk_window_set_user_data (viewport->bin_window, viewport);
436 gtk_widget_set_parent_window (bin->child, viewport->bin_window);
438 widget->style = gtk_style_attach (widget->style, widget->window);
439 gtk_style_set_background (widget->style, widget->window, GTK_STATE_NORMAL);
440 gtk_style_set_background (widget->style, viewport->bin_window, GTK_STATE_NORMAL);
442 gdk_window_show (viewport->bin_window);
443 gdk_window_show (viewport->view_window);
447 gtk_viewport_unrealize (GtkWidget *widget)
449 GtkViewport *viewport;
451 g_return_if_fail (widget != NULL);
452 g_return_if_fail (GTK_IS_VIEWPORT (widget));
454 viewport = GTK_VIEWPORT (widget);
456 gdk_window_set_user_data (viewport->view_window, NULL);
457 gdk_window_destroy (viewport->view_window);
458 viewport->view_window = NULL;
460 gdk_window_set_user_data (viewport->bin_window, NULL);
461 gdk_window_destroy (viewport->bin_window);
462 viewport->bin_window = NULL;
464 if (GTK_WIDGET_CLASS (parent_class)->unrealize)
465 (* GTK_WIDGET_CLASS (parent_class)->unrealize) (widget);
469 gtk_viewport_paint (GtkWidget *widget,
472 GtkViewport *viewport;
474 g_return_if_fail (widget != NULL);
475 g_return_if_fail (GTK_IS_VIEWPORT (widget));
476 g_return_if_fail (area != NULL);
478 if (GTK_WIDGET_DRAWABLE (widget))
480 viewport = GTK_VIEWPORT (widget);
482 gtk_draw_shadow (widget->style, widget->window,
483 GTK_STATE_NORMAL, viewport->shadow_type,
489 gtk_viewport_draw (GtkWidget *widget,
492 GtkViewport *viewport;
494 GdkRectangle tmp_area;
495 GdkRectangle child_area;
498 g_return_if_fail (widget != NULL);
499 g_return_if_fail (GTK_IS_VIEWPORT (widget));
500 g_return_if_fail (area != NULL);
502 if (GTK_WIDGET_DRAWABLE (widget))
504 viewport = GTK_VIEWPORT (widget);
505 bin = GTK_BIN (widget);
507 border_width = GTK_CONTAINER (widget)->border_width;
510 tmp_area.x -= border_width;
511 tmp_area.y -= border_width;
513 gtk_viewport_paint (widget, &tmp_area);
517 tmp_area.x += viewport->hadjustment->value - widget->style->klass->xthickness;
518 tmp_area.y += viewport->vadjustment->value - widget->style->klass->ythickness;
520 if (gtk_widget_intersect (bin->child, &tmp_area, &child_area))
521 gtk_widget_draw (bin->child, &child_area);
527 gtk_viewport_expose (GtkWidget *widget,
528 GdkEventExpose *event)
530 GtkViewport *viewport;
532 GdkEventExpose child_event;
534 g_return_val_if_fail (widget != NULL, FALSE);
535 g_return_val_if_fail (GTK_IS_VIEWPORT (widget), FALSE);
536 g_return_val_if_fail (event != NULL, FALSE);
538 if (GTK_WIDGET_DRAWABLE (widget))
540 viewport = GTK_VIEWPORT (widget);
541 bin = GTK_BIN (widget);
543 if (event->window == widget->window)
544 gtk_viewport_paint (widget, &event->area);
546 child_event = *event;
547 if ((event->window == viewport->bin_window) &&
548 (bin->child != NULL) &&
549 GTK_WIDGET_NO_WINDOW (bin->child) &&
550 gtk_widget_intersect (bin->child, &event->area, &child_event.area))
551 gtk_widget_event (bin->child, (GdkEvent*) &child_event);
558 gtk_viewport_add (GtkContainer *container,
563 g_return_if_fail (container != NULL);
564 g_return_if_fail (GTK_IS_VIEWPORT (container));
565 g_return_if_fail (child != NULL);
567 bin = GTK_BIN (container);
568 g_return_if_fail (bin->child == NULL);
570 gtk_widget_set_parent_window (child, GTK_VIEWPORT (bin)->bin_window);
572 GTK_CONTAINER_CLASS (parent_class)->add (container, child);
576 gtk_viewport_size_request (GtkWidget *widget,
577 GtkRequisition *requisition)
579 GtkViewport *viewport;
582 g_return_if_fail (widget != NULL);
583 g_return_if_fail (GTK_IS_VIEWPORT (widget));
584 g_return_if_fail (requisition != NULL);
586 viewport = GTK_VIEWPORT (widget);
587 bin = GTK_BIN (widget);
589 requisition->width = (GTK_CONTAINER (widget)->border_width +
590 GTK_WIDGET (widget)->style->klass->xthickness) * 2 + 5;
592 requisition->height = (GTK_CONTAINER (widget)->border_width * 2 +
593 GTK_WIDGET (widget)->style->klass->ythickness) * 2 + 5;
595 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
596 gtk_widget_size_request (bin->child, &bin->child->requisition);
600 gtk_viewport_size_allocate (GtkWidget *widget,
601 GtkAllocation *allocation)
603 GtkViewport *viewport;
605 GtkAllocation child_allocation;
609 g_return_if_fail (widget != NULL);
610 g_return_if_fail (GTK_IS_VIEWPORT (widget));
611 g_return_if_fail (allocation != NULL);
613 widget->allocation = *allocation;
614 viewport = GTK_VIEWPORT (widget);
615 bin = GTK_BIN (widget);
617 border_width = GTK_CONTAINER (widget)->border_width;
619 child_allocation.x = 0;
620 child_allocation.y = 0;
622 if (viewport->shadow_type != GTK_SHADOW_NONE)
624 child_allocation.x = GTK_WIDGET (viewport)->style->klass->xthickness;
625 child_allocation.y = GTK_WIDGET (viewport)->style->klass->ythickness;
628 child_allocation.width = MAX (1, allocation->width - child_allocation.x * 2 - border_width * 2);
629 child_allocation.height = MAX (1, allocation->height - child_allocation.y * 2 - border_width * 2);
631 if (GTK_WIDGET_REALIZED (widget))
633 gdk_window_move_resize (widget->window,
634 allocation->x + border_width,
635 allocation->y + border_width,
636 allocation->width - border_width * 2,
637 allocation->height - border_width * 2);
639 gdk_window_move_resize (viewport->view_window,
642 child_allocation.width,
643 child_allocation.height);
646 viewport->hadjustment->page_size = child_allocation.width;
647 viewport->hadjustment->page_increment = viewport->hadjustment->page_size / 2;
648 viewport->hadjustment->step_increment = 10;
650 viewport->vadjustment->page_size = child_allocation.height;
651 viewport->vadjustment->page_increment = viewport->vadjustment->page_size / 2;
652 viewport->vadjustment->step_increment = 10;
654 hval = viewport->hadjustment->value;
655 vval = viewport->vadjustment->value;
657 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
659 viewport->hadjustment->lower = 0;
660 viewport->hadjustment->upper = MAX (bin->child->requisition.width,
661 child_allocation.width);
663 hval = CLAMP (hval, 0,
664 viewport->hadjustment->upper -
665 viewport->hadjustment->page_size);
667 viewport->vadjustment->lower = 0;
668 viewport->vadjustment->upper = MAX (bin->child->requisition.height,
669 child_allocation.height);
671 vval = CLAMP (vval, 0,
672 viewport->vadjustment->upper -
673 viewport->vadjustment->page_size);
676 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
678 child_allocation.x = 0;
679 child_allocation.y = 0;
681 child_allocation.width = viewport->hadjustment->upper;
682 child_allocation.height = viewport->vadjustment->upper;
684 if (!GTK_WIDGET_REALIZED (widget))
685 gtk_widget_realize (widget);
687 gdk_window_resize (viewport->bin_window,
688 child_allocation.width,
689 child_allocation.height);
691 child_allocation.x = 0;
692 child_allocation.y = 0;
693 gtk_widget_size_allocate (bin->child, &child_allocation);
696 gtk_signal_emit_by_name (GTK_OBJECT (viewport->hadjustment), "changed");
697 gtk_signal_emit_by_name (GTK_OBJECT (viewport->vadjustment), "changed");
698 if (viewport->hadjustment->value != hval)
700 viewport->hadjustment->value = hval;
701 gtk_signal_emit_by_name (GTK_OBJECT (viewport->hadjustment), "value_changed");
703 if (viewport->vadjustment->value != vval)
705 viewport->vadjustment->value = vval;
706 gtk_signal_emit_by_name (GTK_OBJECT (viewport->vadjustment), "value_changed");
711 gtk_viewport_adjustment_changed (GtkAdjustment *adjustment,
714 GtkViewport *viewport;
716 g_return_if_fail (adjustment != NULL);
717 g_return_if_fail (data != NULL);
718 g_return_if_fail (GTK_IS_VIEWPORT (data));
720 viewport = GTK_VIEWPORT (data);
724 gtk_viewport_adjustment_value_changed (GtkAdjustment *adjustment,
727 GtkViewport *viewport;
729 GtkAllocation child_allocation;
732 g_return_if_fail (adjustment != NULL);
733 g_return_if_fail (data != NULL);
734 g_return_if_fail (GTK_IS_VIEWPORT (data));
736 viewport = GTK_VIEWPORT (data);
737 bin = GTK_BIN (data);
739 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
741 gdk_window_get_size (viewport->view_window, &width, &height);
743 child_allocation.x = 0;
744 child_allocation.y = 0;
746 if (viewport->hadjustment->lower != (viewport->hadjustment->upper -
747 viewport->hadjustment->page_size))
748 child_allocation.x = viewport->hadjustment->lower - viewport->hadjustment->value;
750 if (viewport->vadjustment->lower != (viewport->vadjustment->upper -
751 viewport->vadjustment->page_size))
752 child_allocation.y = viewport->vadjustment->lower - viewport->vadjustment->value;
754 if (GTK_WIDGET_REALIZED (viewport))
755 gdk_window_move (viewport->bin_window,