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 void gtk_viewport_adjustment_changed (GtkAdjustment *adjustment,
44 static void gtk_viewport_adjustment_value_changed (GtkAdjustment *adjustment,
47 static GtkBinClass *parent_class;
50 gtk_viewport_get_type (void)
52 static guint viewport_type = 0;
56 GtkTypeInfo viewport_info =
60 sizeof (GtkViewportClass),
61 (GtkClassInitFunc) gtk_viewport_class_init,
62 (GtkObjectInitFunc) gtk_viewport_init,
63 /* reversed_1 */ NULL,
64 /* reversed_2 */ NULL,
65 (GtkClassInitFunc) NULL,
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;
101 gtk_viewport_init (GtkViewport *viewport)
103 GTK_WIDGET_UNSET_FLAGS (viewport, GTK_NO_WINDOW);
104 GTK_WIDGET_SET_FLAGS (viewport, GTK_BASIC);
106 gtk_container_set_resize_mode (GTK_CONTAINER (viewport), GTK_RESIZE_QUEUE);
108 viewport->shadow_type = GTK_SHADOW_IN;
109 viewport->view_window = NULL;
110 viewport->bin_window = NULL;
111 viewport->hadjustment = NULL;
112 viewport->vadjustment = NULL;
116 gtk_viewport_new (GtkAdjustment *hadjustment,
117 GtkAdjustment *vadjustment)
119 GtkViewport *viewport;
121 viewport = gtk_type_new (gtk_viewport_get_type ());
124 hadjustment = (GtkAdjustment*) gtk_adjustment_new (0.0, 0.0, 0.0, 0.0, 0.0, 0.0);
127 vadjustment = (GtkAdjustment*) gtk_adjustment_new (0.0, 0.0, 0.0, 0.0, 0.0, 0.0);
129 gtk_viewport_set_hadjustment (viewport, hadjustment);
130 gtk_viewport_set_vadjustment (viewport, vadjustment);
132 return GTK_WIDGET (viewport);
136 gtk_viewport_finalize (GtkObject *object)
138 GtkViewport *viewport = GTK_VIEWPORT (object);
140 gtk_object_unref (GTK_OBJECT (viewport->hadjustment));
141 gtk_object_unref (GTK_OBJECT (viewport->vadjustment));
143 GTK_OBJECT_CLASS(parent_class)->finalize (object);
147 gtk_viewport_get_hadjustment (GtkViewport *viewport)
149 g_return_val_if_fail (viewport != NULL, NULL);
150 g_return_val_if_fail (GTK_IS_VIEWPORT (viewport), NULL);
152 return viewport->hadjustment;
156 gtk_viewport_get_vadjustment (GtkViewport *viewport)
158 g_return_val_if_fail (viewport != NULL, NULL);
159 g_return_val_if_fail (GTK_IS_VIEWPORT (viewport), NULL);
161 return viewport->vadjustment;
165 gtk_viewport_set_hadjustment (GtkViewport *viewport,
166 GtkAdjustment *adjustment)
168 g_return_if_fail (viewport != NULL);
169 g_return_if_fail (GTK_IS_VIEWPORT (viewport));
170 g_return_if_fail (adjustment != NULL);
172 if (viewport->hadjustment != adjustment)
174 if (viewport->hadjustment)
176 gtk_signal_disconnect_by_data (GTK_OBJECT (viewport->hadjustment),
177 (gpointer) viewport);
178 gtk_object_unref (GTK_OBJECT (viewport->hadjustment));
181 viewport->hadjustment = adjustment;
182 gtk_object_ref (GTK_OBJECT (viewport->hadjustment));
183 gtk_object_sink (GTK_OBJECT (viewport->hadjustment));
185 gtk_signal_connect (GTK_OBJECT (adjustment), "changed",
186 (GtkSignalFunc) gtk_viewport_adjustment_changed,
187 (gpointer) viewport);
188 gtk_signal_connect (GTK_OBJECT (adjustment), "value_changed",
189 (GtkSignalFunc)gtk_viewport_adjustment_value_changed,
190 (gpointer) viewport);
192 gtk_viewport_adjustment_changed (adjustment, (gpointer) viewport);
197 gtk_viewport_set_vadjustment (GtkViewport *viewport,
198 GtkAdjustment *adjustment)
200 g_return_if_fail (viewport != NULL);
201 g_return_if_fail (GTK_IS_VIEWPORT (viewport));
202 g_return_if_fail (adjustment != NULL);
204 if (viewport->vadjustment != adjustment)
206 if (viewport->vadjustment)
208 gtk_signal_disconnect_by_data (GTK_OBJECT (viewport->vadjustment),
209 (gpointer) viewport);
210 gtk_object_unref (GTK_OBJECT (viewport->vadjustment));
213 viewport->vadjustment = adjustment;
214 gtk_object_ref (GTK_OBJECT (viewport->vadjustment));
215 gtk_object_sink (GTK_OBJECT (viewport->vadjustment));
217 gtk_signal_connect (GTK_OBJECT (adjustment), "changed",
218 (GtkSignalFunc) gtk_viewport_adjustment_changed,
219 (gpointer) viewport);
220 gtk_signal_connect (GTK_OBJECT (adjustment), "value_changed",
221 (GtkSignalFunc)gtk_viewport_adjustment_value_changed,
222 (gpointer) viewport);
224 gtk_viewport_adjustment_changed (adjustment, (gpointer) viewport);
229 gtk_viewport_set_shadow_type (GtkViewport *viewport,
232 g_return_if_fail (viewport != NULL);
233 g_return_if_fail (GTK_IS_VIEWPORT (viewport));
235 if ((GtkShadowType) viewport->shadow_type != type)
237 viewport->shadow_type = type;
239 if (GTK_WIDGET_VISIBLE (viewport))
241 gtk_widget_size_allocate (GTK_WIDGET (viewport), &(GTK_WIDGET (viewport)->allocation));
242 gtk_widget_queue_draw (GTK_WIDGET (viewport));
249 gtk_viewport_map (GtkWidget *widget)
253 g_return_if_fail (widget != NULL);
254 g_return_if_fail (GTK_IS_VIEWPORT (widget));
256 GTK_WIDGET_SET_FLAGS (widget, GTK_MAPPED);
257 bin = GTK_BIN (widget);
259 gdk_window_show (widget->window);
262 GTK_WIDGET_VISIBLE (bin->child) &&
263 !GTK_WIDGET_MAPPED (bin->child))
264 gtk_widget_map (bin->child);
268 gtk_viewport_unmap (GtkWidget *widget)
270 g_return_if_fail (widget != NULL);
271 g_return_if_fail (GTK_IS_VIEWPORT (widget));
273 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
275 gdk_window_hide (widget->window);
279 gtk_viewport_realize (GtkWidget *widget)
282 GtkViewport *viewport;
283 GdkWindowAttr attributes;
284 gint attributes_mask;
288 g_return_if_fail (widget != NULL);
289 g_return_if_fail (GTK_IS_VIEWPORT (widget));
291 border_width = GTK_CONTAINER (widget)->border_width;
293 bin = GTK_BIN (widget);
294 viewport = GTK_VIEWPORT (widget);
295 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
297 attributes.x = widget->allocation.x + border_width;
298 attributes.y = widget->allocation.y + border_width;
299 attributes.width = widget->allocation.width - border_width * 2;
300 attributes.height = widget->allocation.height - border_width * 2;
301 attributes.window_type = GDK_WINDOW_CHILD;
302 attributes.wclass = GDK_INPUT_OUTPUT;
303 attributes.visual = gtk_widget_get_visual (widget);
304 attributes.colormap = gtk_widget_get_colormap (widget);
306 event_mask = gtk_widget_get_events (widget) | GDK_EXPOSURE_MASK;
307 attributes.event_mask = event_mask;
309 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
311 widget->window = gdk_window_new (gtk_widget_get_parent_window (widget),
312 &attributes, attributes_mask);
313 gdk_window_set_user_data (widget->window, viewport);
315 if (viewport->shadow_type != GTK_SHADOW_NONE)
317 attributes.x = widget->style->klass->xthickness;
318 attributes.y = widget->style->klass->ythickness;
326 attributes.width = MAX (1, widget->allocation.width - attributes.x * 2 - border_width * 2);
327 attributes.height = MAX (1, widget->allocation.height - attributes.y * 2 - border_width * 2);
328 attributes.event_mask = 0;
330 viewport->view_window = gdk_window_new (widget->window, &attributes, attributes_mask);
331 gdk_window_set_user_data (viewport->view_window, viewport);
338 attributes.width = viewport->hadjustment->upper;
339 attributes.height = viewport->vadjustment->upper;
342 attributes.event_mask = event_mask;
344 viewport->bin_window = gdk_window_new (viewport->view_window, &attributes, attributes_mask);
345 gdk_window_set_user_data (viewport->bin_window, viewport);
348 gtk_widget_set_parent_window (bin->child, viewport->bin_window);
350 widget->style = gtk_style_attach (widget->style, widget->window);
351 gtk_style_set_background (widget->style, widget->window, GTK_STATE_NORMAL);
352 gtk_style_set_background (widget->style, viewport->bin_window, GTK_STATE_NORMAL);
354 gdk_window_show (viewport->bin_window);
355 gdk_window_show (viewport->view_window);
359 gtk_viewport_unrealize (GtkWidget *widget)
361 GtkViewport *viewport;
363 g_return_if_fail (widget != NULL);
364 g_return_if_fail (GTK_IS_VIEWPORT (widget));
366 viewport = GTK_VIEWPORT (widget);
368 gdk_window_set_user_data (viewport->view_window, NULL);
369 gdk_window_destroy (viewport->view_window);
370 viewport->view_window = NULL;
372 gdk_window_set_user_data (viewport->bin_window, NULL);
373 gdk_window_destroy (viewport->bin_window);
374 viewport->bin_window = NULL;
376 if (GTK_WIDGET_CLASS (parent_class)->unrealize)
377 (* GTK_WIDGET_CLASS (parent_class)->unrealize) (widget);
381 gtk_viewport_paint (GtkWidget *widget,
384 GtkViewport *viewport;
386 g_return_if_fail (widget != NULL);
387 g_return_if_fail (GTK_IS_VIEWPORT (widget));
388 g_return_if_fail (area != NULL);
390 if (GTK_WIDGET_DRAWABLE (widget))
392 viewport = GTK_VIEWPORT (widget);
394 gtk_draw_shadow (widget->style, widget->window,
395 GTK_STATE_NORMAL, viewport->shadow_type,
401 gtk_viewport_draw (GtkWidget *widget,
404 GtkViewport *viewport;
406 GdkRectangle tmp_area;
407 GdkRectangle child_area;
410 g_return_if_fail (widget != NULL);
411 g_return_if_fail (GTK_IS_VIEWPORT (widget));
412 g_return_if_fail (area != NULL);
414 if (GTK_WIDGET_DRAWABLE (widget))
416 viewport = GTK_VIEWPORT (widget);
417 bin = GTK_BIN (widget);
419 border_width = GTK_CONTAINER (widget)->border_width;
422 tmp_area.x -= border_width;
423 tmp_area.y -= border_width;
425 gtk_viewport_paint (widget, &tmp_area);
429 tmp_area.x += viewport->hadjustment->value - widget->style->klass->xthickness;
430 tmp_area.y += viewport->vadjustment->value - widget->style->klass->ythickness;
432 if (gtk_widget_intersect (bin->child, &tmp_area, &child_area))
433 gtk_widget_draw (bin->child, &child_area);
439 gtk_viewport_expose (GtkWidget *widget,
440 GdkEventExpose *event)
442 GtkViewport *viewport;
444 GdkEventExpose child_event;
446 g_return_val_if_fail (widget != NULL, FALSE);
447 g_return_val_if_fail (GTK_IS_VIEWPORT (widget), FALSE);
448 g_return_val_if_fail (event != NULL, FALSE);
450 if (GTK_WIDGET_DRAWABLE (widget))
452 viewport = GTK_VIEWPORT (widget);
453 bin = GTK_BIN (widget);
455 if (event->window == widget->window)
456 gtk_viewport_paint (widget, &event->area);
458 child_event = *event;
459 if ((event->window == viewport->bin_window) &&
460 (bin->child != NULL) &&
461 GTK_WIDGET_NO_WINDOW (bin->child) &&
462 gtk_widget_intersect (bin->child, &event->area, &child_event.area))
463 gtk_widget_event (bin->child, (GdkEvent*) &child_event);
470 gtk_viewport_add (GtkContainer *container,
475 g_return_if_fail (container != NULL);
476 g_return_if_fail (GTK_IS_VIEWPORT (container));
477 g_return_if_fail (widget != NULL);
479 bin = GTK_BIN (container);
483 gtk_widget_set_parent (widget, GTK_WIDGET (container));
484 gtk_widget_set_parent_window (widget, GTK_VIEWPORT (container)->bin_window);
485 if (GTK_WIDGET_VISIBLE (widget))
487 if (GTK_WIDGET_MAPPED (widget->parent) &&
488 !GTK_WIDGET_MAPPED (widget))
489 gtk_widget_map (widget);
494 if (GTK_WIDGET_VISIBLE (widget) && GTK_WIDGET_VISIBLE (container))
495 gtk_widget_queue_resize (widget);
500 gtk_viewport_size_request (GtkWidget *widget,
501 GtkRequisition *requisition)
503 GtkViewport *viewport;
506 g_return_if_fail (widget != NULL);
507 g_return_if_fail (GTK_IS_VIEWPORT (widget));
508 g_return_if_fail (requisition != NULL);
510 viewport = GTK_VIEWPORT (widget);
511 bin = GTK_BIN (widget);
513 requisition->width = (GTK_CONTAINER (widget)->border_width +
514 GTK_WIDGET (widget)->style->klass->xthickness) * 2 + 5;
516 requisition->height = (GTK_CONTAINER (widget)->border_width * 2 +
517 GTK_WIDGET (widget)->style->klass->ythickness) * 2 + 5;
519 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
520 gtk_widget_size_request (bin->child, &bin->child->requisition);
524 gtk_viewport_size_allocate (GtkWidget *widget,
525 GtkAllocation *allocation)
527 GtkViewport *viewport;
529 GtkAllocation child_allocation;
533 g_return_if_fail (widget != NULL);
534 g_return_if_fail (GTK_IS_VIEWPORT (widget));
535 g_return_if_fail (allocation != NULL);
537 widget->allocation = *allocation;
538 viewport = GTK_VIEWPORT (widget);
539 bin = GTK_BIN (widget);
541 border_width = GTK_CONTAINER (widget)->border_width;
543 child_allocation.x = 0;
544 child_allocation.y = 0;
546 if (viewport->shadow_type != GTK_SHADOW_NONE)
548 child_allocation.x = GTK_WIDGET (viewport)->style->klass->xthickness;
549 child_allocation.y = GTK_WIDGET (viewport)->style->klass->ythickness;
552 child_allocation.width = MAX (1, allocation->width - child_allocation.x * 2 - border_width * 2);
553 child_allocation.height = MAX (1, allocation->height - child_allocation.y * 2 - border_width * 2);
555 if (GTK_WIDGET_REALIZED (widget))
557 gdk_window_move_resize (widget->window,
558 allocation->x + border_width,
559 allocation->y + border_width,
560 allocation->width - border_width * 2,
561 allocation->height - border_width * 2);
563 gdk_window_move_resize (viewport->view_window,
566 child_allocation.width,
567 child_allocation.height);
570 viewport->hadjustment->page_size = child_allocation.width;
571 viewport->hadjustment->page_increment = viewport->hadjustment->page_size / 2;
572 viewport->hadjustment->step_increment = 10;
574 viewport->vadjustment->page_size = child_allocation.height;
575 viewport->vadjustment->page_increment = viewport->vadjustment->page_size / 2;
576 viewport->vadjustment->step_increment = 10;
578 hval = viewport->hadjustment->value;
579 vval = viewport->vadjustment->value;
581 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
583 viewport->hadjustment->lower = 0;
584 viewport->hadjustment->upper = MAX (bin->child->requisition.width,
585 child_allocation.width);
587 hval = CLAMP (hval, 0,
588 viewport->hadjustment->upper -
589 viewport->hadjustment->page_size);
591 viewport->vadjustment->lower = 0;
592 viewport->vadjustment->upper = MAX (bin->child->requisition.height,
593 child_allocation.height);
595 vval = CLAMP (vval, 0,
596 viewport->vadjustment->upper -
597 viewport->vadjustment->page_size);
600 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
602 child_allocation.x = 0;
603 child_allocation.y = 0;
605 child_allocation.width = viewport->hadjustment->upper;
606 child_allocation.height = viewport->vadjustment->upper;
608 if (!GTK_WIDGET_REALIZED (widget))
609 gtk_widget_realize (widget);
611 gdk_window_resize (viewport->bin_window,
612 child_allocation.width,
613 child_allocation.height);
615 child_allocation.x = 0;
616 child_allocation.y = 0;
617 gtk_widget_size_allocate (bin->child, &child_allocation);
620 gtk_signal_emit_by_name (GTK_OBJECT (viewport->hadjustment), "changed");
621 gtk_signal_emit_by_name (GTK_OBJECT (viewport->vadjustment), "changed");
622 if (viewport->hadjustment->value != hval)
624 viewport->hadjustment->value = hval;
625 gtk_signal_emit_by_name (GTK_OBJECT (viewport->hadjustment), "value_changed");
627 if (viewport->vadjustment->value != vval)
629 viewport->vadjustment->value = vval;
630 gtk_signal_emit_by_name (GTK_OBJECT (viewport->vadjustment), "value_changed");
635 gtk_viewport_adjustment_changed (GtkAdjustment *adjustment,
638 GtkViewport *viewport;
640 g_return_if_fail (adjustment != NULL);
641 g_return_if_fail (data != NULL);
642 g_return_if_fail (GTK_IS_VIEWPORT (data));
644 viewport = GTK_VIEWPORT (data);
648 gtk_viewport_adjustment_value_changed (GtkAdjustment *adjustment,
651 GtkViewport *viewport;
653 GtkAllocation child_allocation;
656 g_return_if_fail (adjustment != NULL);
657 g_return_if_fail (data != NULL);
658 g_return_if_fail (GTK_IS_VIEWPORT (data));
660 viewport = GTK_VIEWPORT (data);
661 bin = GTK_BIN (data);
663 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
665 gdk_window_get_size (viewport->view_window, &width, &height);
667 child_allocation.x = 0;
668 child_allocation.y = 0;
670 if (viewport->hadjustment->lower != (viewport->hadjustment->upper -
671 viewport->hadjustment->page_size))
672 child_allocation.x = viewport->hadjustment->lower - viewport->hadjustment->value;
674 if (viewport->vadjustment->lower != (viewport->vadjustment->upper -
675 viewport->vadjustment->page_size))
676 child_allocation.y = viewport->vadjustment->lower - viewport->vadjustment->value;
678 if (GTK_WIDGET_REALIZED (viewport))
679 gdk_window_move (viewport->bin_window,