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 "gtksignal.h"
19 #include "gtkviewport.h"
22 static void gtk_viewport_class_init (GtkViewportClass *klass);
23 static void gtk_viewport_init (GtkViewport *viewport);
24 static void gtk_viewport_finalize (GtkObject *object);
25 static void gtk_viewport_map (GtkWidget *widget);
26 static void gtk_viewport_unmap (GtkWidget *widget);
27 static void gtk_viewport_realize (GtkWidget *widget);
28 static void gtk_viewport_unrealize (GtkWidget *widget);
29 static void gtk_viewport_paint (GtkWidget *widget,
31 static void gtk_viewport_draw (GtkWidget *widget,
33 static gint gtk_viewport_expose (GtkWidget *widget,
34 GdkEventExpose *event);
35 static void gtk_viewport_add (GtkContainer *container,
37 static void gtk_viewport_size_request (GtkWidget *widget,
38 GtkRequisition *requisition);
39 static void gtk_viewport_size_allocate (GtkWidget *widget,
40 GtkAllocation *allocation);
41 static gint gtk_viewport_need_resize (GtkContainer *container);
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 ()
52 static guint viewport_type = 0;
56 GtkTypeInfo viewport_info =
60 sizeof (GtkViewportClass),
61 (GtkClassInitFunc) gtk_viewport_class_init,
62 (GtkObjectInitFunc) gtk_viewport_init,
67 viewport_type = gtk_type_unique (gtk_bin_get_type (), &viewport_info);
74 gtk_viewport_class_init (GtkViewportClass *class)
76 GtkObjectClass *object_class;
77 GtkWidgetClass *widget_class;
78 GtkContainerClass *container_class;
80 object_class = (GtkObjectClass*) class;
81 widget_class = (GtkWidgetClass*) class;
82 container_class = (GtkContainerClass*) class;
83 parent_class = (GtkBinClass*) gtk_type_class (gtk_bin_get_type ());
85 object_class->finalize = gtk_viewport_finalize;
87 widget_class->map = gtk_viewport_map;
88 widget_class->unmap = gtk_viewport_unmap;
89 widget_class->realize = gtk_viewport_realize;
90 widget_class->unrealize = gtk_viewport_unrealize;
91 widget_class->draw = gtk_viewport_draw;
92 widget_class->expose_event = gtk_viewport_expose;
93 widget_class->size_request = gtk_viewport_size_request;
94 widget_class->size_allocate = gtk_viewport_size_allocate;
96 container_class->add = gtk_viewport_add;
97 container_class->need_resize = gtk_viewport_need_resize;
101 gtk_viewport_init (GtkViewport *viewport)
103 GTK_WIDGET_UNSET_FLAGS (viewport, GTK_NO_WINDOW);
104 GTK_WIDGET_SET_FLAGS (viewport, GTK_BASIC);
106 viewport->shadow_type = GTK_SHADOW_IN;
107 viewport->view_window = NULL;
108 viewport->bin_window = NULL;
109 viewport->hadjustment = NULL;
110 viewport->vadjustment = NULL;
114 gtk_viewport_new (GtkAdjustment *hadjustment,
115 GtkAdjustment *vadjustment)
117 GtkViewport *viewport;
119 viewport = gtk_type_new (gtk_viewport_get_type ());
122 hadjustment = (GtkAdjustment*) gtk_adjustment_new (0.0, 0.0, 0.0, 0.0, 0.0, 0.0);
125 vadjustment = (GtkAdjustment*) gtk_adjustment_new (0.0, 0.0, 0.0, 0.0, 0.0, 0.0);
127 gtk_viewport_set_hadjustment (viewport, hadjustment);
128 gtk_viewport_set_vadjustment (viewport, vadjustment);
130 return GTK_WIDGET (viewport);
134 gtk_viewport_finalize (GtkObject *object)
136 GtkViewport *viewport = GTK_VIEWPORT (object);
138 gtk_object_unref (GTK_OBJECT (viewport->hadjustment));
139 gtk_object_unref (GTK_OBJECT (viewport->vadjustment));
141 GTK_OBJECT_CLASS(parent_class)->finalize (object);
145 gtk_viewport_get_hadjustment (GtkViewport *viewport)
147 g_return_val_if_fail (viewport != NULL, NULL);
148 g_return_val_if_fail (GTK_IS_VIEWPORT (viewport), NULL);
150 return viewport->hadjustment;
154 gtk_viewport_get_vadjustment (GtkViewport *viewport)
156 g_return_val_if_fail (viewport != NULL, NULL);
157 g_return_val_if_fail (GTK_IS_VIEWPORT (viewport), NULL);
159 return viewport->vadjustment;
163 gtk_viewport_set_hadjustment (GtkViewport *viewport,
164 GtkAdjustment *adjustment)
166 g_return_if_fail (viewport != NULL);
167 g_return_if_fail (GTK_IS_VIEWPORT (viewport));
168 g_return_if_fail (adjustment != NULL);
170 if (viewport->hadjustment != adjustment)
172 if (viewport->hadjustment)
174 gtk_signal_disconnect_by_data (GTK_OBJECT (viewport->hadjustment),
175 (gpointer) viewport);
176 gtk_object_unref (GTK_OBJECT (viewport->hadjustment));
179 viewport->hadjustment = adjustment;
180 gtk_object_ref (GTK_OBJECT (viewport->hadjustment));
181 gtk_object_sink (GTK_OBJECT (viewport->hadjustment));
183 gtk_signal_connect (GTK_OBJECT (adjustment), "changed",
184 (GtkSignalFunc) gtk_viewport_adjustment_changed,
185 (gpointer) viewport);
186 gtk_signal_connect (GTK_OBJECT (adjustment), "value_changed",
187 (GtkSignalFunc)gtk_viewport_adjustment_value_changed,
188 (gpointer) viewport);
190 gtk_viewport_adjustment_changed (adjustment, (gpointer) viewport);
195 gtk_viewport_set_vadjustment (GtkViewport *viewport,
196 GtkAdjustment *adjustment)
198 g_return_if_fail (viewport != NULL);
199 g_return_if_fail (GTK_IS_VIEWPORT (viewport));
200 g_return_if_fail (adjustment != NULL);
202 if (viewport->vadjustment != adjustment)
204 if (viewport->vadjustment)
206 gtk_signal_disconnect_by_data (GTK_OBJECT (viewport->vadjustment),
207 (gpointer) viewport);
208 gtk_object_unref (GTK_OBJECT (viewport->vadjustment));
211 viewport->vadjustment = adjustment;
212 gtk_object_ref (GTK_OBJECT (viewport->vadjustment));
213 gtk_object_sink (GTK_OBJECT (viewport->vadjustment));
215 gtk_signal_connect (GTK_OBJECT (adjustment), "changed",
216 (GtkSignalFunc) gtk_viewport_adjustment_changed,
217 (gpointer) viewport);
218 gtk_signal_connect (GTK_OBJECT (adjustment), "value_changed",
219 (GtkSignalFunc)gtk_viewport_adjustment_value_changed,
220 (gpointer) viewport);
222 gtk_viewport_adjustment_changed (adjustment, (gpointer) viewport);
227 gtk_viewport_set_shadow_type (GtkViewport *viewport,
230 g_return_if_fail (viewport != NULL);
231 g_return_if_fail (GTK_IS_VIEWPORT (viewport));
233 if ((GtkShadowType) viewport->shadow_type != type)
235 viewport->shadow_type = type;
237 if (GTK_WIDGET_VISIBLE (viewport))
239 gtk_widget_size_allocate (GTK_WIDGET (viewport), &(GTK_WIDGET (viewport)->allocation));
240 gtk_widget_queue_draw (GTK_WIDGET (viewport));
247 gtk_viewport_map (GtkWidget *widget)
251 g_return_if_fail (widget != NULL);
252 g_return_if_fail (GTK_IS_VIEWPORT (widget));
254 GTK_WIDGET_SET_FLAGS (widget, GTK_MAPPED);
255 bin = GTK_BIN (widget);
257 gdk_window_show (widget->window);
260 GTK_WIDGET_VISIBLE (bin->child) &&
261 !GTK_WIDGET_MAPPED (bin->child))
262 gtk_widget_map (bin->child);
266 gtk_viewport_unmap (GtkWidget *widget)
268 g_return_if_fail (widget != NULL);
269 g_return_if_fail (GTK_IS_VIEWPORT (widget));
271 GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
273 gdk_window_hide (widget->window);
277 gtk_viewport_realize (GtkWidget *widget)
280 GtkViewport *viewport;
281 GdkWindowAttr attributes;
282 GtkRequisition *child_requisition;
283 gint attributes_mask;
286 g_return_if_fail (widget != NULL);
287 g_return_if_fail (GTK_IS_VIEWPORT (widget));
289 bin = GTK_BIN (widget);
290 viewport = GTK_VIEWPORT (widget);
291 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
293 attributes.x = widget->allocation.x + GTK_CONTAINER (widget)->border_width;
294 attributes.y = widget->allocation.y + GTK_CONTAINER (widget)->border_width;
295 attributes.width = widget->allocation.width - GTK_CONTAINER (widget)->border_width * 2;
296 attributes.height = widget->allocation.height - GTK_CONTAINER (widget)->border_width * 2;
297 attributes.window_type = GDK_WINDOW_CHILD;
298 attributes.wclass = GDK_INPUT_OUTPUT;
299 attributes.visual = gtk_widget_get_visual (widget);
300 attributes.colormap = gtk_widget_get_colormap (widget);
302 event_mask = gtk_widget_get_events (widget) | GDK_EXPOSURE_MASK;
303 attributes.event_mask = event_mask;
305 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
307 widget->window = gdk_window_new (gtk_widget_get_parent_window (widget),
308 &attributes, attributes_mask);
309 gdk_window_set_user_data (widget->window, viewport);
311 attributes.x += widget->style->klass->xthickness;
312 attributes.y += widget->style->klass->ythickness;
313 attributes.width -= widget->style->klass->xthickness * 2;
314 attributes.height -= widget->style->klass->ythickness * 2;
315 attributes.event_mask = 0;
317 viewport->view_window = gdk_window_new (widget->window, &attributes, attributes_mask);
318 gdk_window_set_user_data (viewport->view_window, viewport);
322 attributes.event_mask = event_mask;
324 viewport->bin_window = gdk_window_new (viewport->view_window, &attributes, attributes_mask);
325 gdk_window_set_user_data (viewport->bin_window, viewport);
329 child_requisition = >K_WIDGET (GTK_BIN (viewport)->child)->requisition;
330 attributes.width = child_requisition->width;
331 attributes.height = child_requisition->height;
333 gtk_widget_set_parent_window (bin->child, viewport->bin_window);
336 widget->style = gtk_style_attach (widget->style, widget->window);
337 gtk_style_set_background (widget->style, widget->window, GTK_STATE_NORMAL);
338 gtk_style_set_background (widget->style, viewport->bin_window, GTK_STATE_NORMAL);
340 gdk_window_show (viewport->bin_window);
341 gdk_window_show (viewport->view_window);
345 gtk_viewport_unrealize (GtkWidget *widget)
347 GtkViewport *viewport;
349 g_return_if_fail (widget != NULL);
350 g_return_if_fail (GTK_IS_VIEWPORT (widget));
352 viewport = GTK_VIEWPORT (widget);
354 gdk_window_set_user_data (viewport->view_window, NULL);
355 gdk_window_destroy (viewport->view_window);
356 viewport->view_window = NULL;
358 gdk_window_set_user_data (viewport->bin_window, NULL);
359 gdk_window_destroy (viewport->bin_window);
360 viewport->bin_window = NULL;
362 if (GTK_WIDGET_CLASS (parent_class)->unrealize)
363 (* GTK_WIDGET_CLASS (parent_class)->unrealize) (widget);
367 gtk_viewport_paint (GtkWidget *widget,
370 GtkViewport *viewport;
372 g_return_if_fail (widget != NULL);
373 g_return_if_fail (GTK_IS_VIEWPORT (widget));
374 g_return_if_fail (area != NULL);
376 if (GTK_WIDGET_DRAWABLE (widget))
378 viewport = GTK_VIEWPORT (widget);
380 gtk_draw_shadow (widget->style, widget->window,
381 GTK_STATE_NORMAL, viewport->shadow_type,
387 gtk_viewport_draw (GtkWidget *widget,
390 GtkViewport *viewport;
392 GdkRectangle tmp_area;
393 GdkRectangle child_area;
396 g_return_if_fail (widget != NULL);
397 g_return_if_fail (GTK_IS_VIEWPORT (widget));
398 g_return_if_fail (area != NULL);
400 if (GTK_WIDGET_DRAWABLE (widget))
402 viewport = GTK_VIEWPORT (widget);
403 bin = GTK_BIN (widget);
405 border_width = GTK_CONTAINER (widget)->border_width;
408 tmp_area.x -= border_width;
409 tmp_area.y -= border_width;
411 gtk_viewport_paint (widget, &tmp_area);
415 tmp_area.x += viewport->hadjustment->value - widget->style->klass->xthickness;
416 tmp_area.y += viewport->vadjustment->value - widget->style->klass->ythickness;
418 if (gtk_widget_intersect (bin->child, &tmp_area, &child_area))
419 gtk_widget_draw (bin->child, &child_area);
425 gtk_viewport_expose (GtkWidget *widget,
426 GdkEventExpose *event)
428 GtkViewport *viewport;
430 GdkEventExpose child_event;
432 g_return_val_if_fail (widget != NULL, FALSE);
433 g_return_val_if_fail (GTK_IS_VIEWPORT (widget), FALSE);
434 g_return_val_if_fail (event != NULL, FALSE);
436 if (GTK_WIDGET_DRAWABLE (widget))
438 viewport = GTK_VIEWPORT (widget);
439 bin = GTK_BIN (widget);
441 if (event->window == widget->window)
442 gtk_viewport_paint (widget, &event->area);
444 child_event = *event;
445 if ((event->window == viewport->bin_window) &&
446 (bin->child != NULL) &&
447 GTK_WIDGET_NO_WINDOW (bin->child) &&
448 gtk_widget_intersect (bin->child, &event->area, &child_event.area))
449 gtk_widget_event (bin->child, (GdkEvent*) &child_event);
456 gtk_viewport_add (GtkContainer *container,
461 g_return_if_fail (container != NULL);
462 g_return_if_fail (GTK_IS_VIEWPORT (container));
463 g_return_if_fail (widget != NULL);
465 bin = GTK_BIN (container);
469 gtk_widget_set_parent (widget, GTK_WIDGET (container));
470 gtk_widget_set_parent_window (widget, GTK_VIEWPORT (container)->bin_window);
471 if (GTK_WIDGET_VISIBLE (widget->parent))
473 if (GTK_WIDGET_MAPPED (widget->parent) &&
474 !GTK_WIDGET_MAPPED (widget))
475 gtk_widget_map (widget);
480 if (GTK_WIDGET_VISIBLE (widget) && GTK_WIDGET_VISIBLE (container))
481 gtk_widget_queue_resize (widget);
486 gtk_viewport_size_request (GtkWidget *widget,
487 GtkRequisition *requisition)
489 GtkViewport *viewport;
492 g_return_if_fail (widget != NULL);
493 g_return_if_fail (GTK_IS_VIEWPORT (widget));
494 g_return_if_fail (requisition != NULL);
496 viewport = GTK_VIEWPORT (widget);
497 bin = GTK_BIN (widget);
499 requisition->width = (GTK_CONTAINER (widget)->border_width +
500 GTK_WIDGET (widget)->style->klass->xthickness) * 2 + 5;
502 requisition->height = (GTK_CONTAINER (widget)->border_width * 2 +
503 GTK_WIDGET (widget)->style->klass->ythickness) * 2 + 5;
505 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
506 gtk_widget_size_request (bin->child, &bin->child->requisition);
510 gtk_viewport_size_allocate (GtkWidget *widget,
511 GtkAllocation *allocation)
513 GtkViewport *viewport;
515 GtkAllocation child_allocation;
519 g_return_if_fail (widget != NULL);
520 g_return_if_fail (GTK_IS_VIEWPORT (widget));
521 g_return_if_fail (allocation != NULL);
523 widget->allocation = *allocation;
524 viewport = GTK_VIEWPORT (widget);
525 bin = GTK_BIN (widget);
527 border_width = GTK_CONTAINER (widget)->border_width;
529 child_allocation.x = 0;
530 child_allocation.y = 0;
532 if (viewport->shadow_type != GTK_SHADOW_NONE)
534 child_allocation.x = GTK_WIDGET (viewport)->style->klass->xthickness;
535 child_allocation.y = GTK_WIDGET (viewport)->style->klass->ythickness;
538 child_allocation.width = allocation->width - child_allocation.x * 2 - border_width * 2;
539 child_allocation.height = allocation->height - child_allocation.y * 2 - border_width * 2;
541 if (GTK_WIDGET_REALIZED (widget))
543 gdk_window_move_resize (widget->window,
544 allocation->x + border_width,
545 allocation->y + border_width,
546 allocation->width - border_width * 2,
547 allocation->height - border_width * 2);
549 gdk_window_move_resize (viewport->view_window,
552 child_allocation.width,
553 child_allocation.height);
556 viewport->hadjustment->page_size = child_allocation.width;
557 viewport->hadjustment->page_increment = viewport->hadjustment->page_size / 2;
558 viewport->hadjustment->step_increment = 10;
560 viewport->vadjustment->page_size = child_allocation.height;
561 viewport->vadjustment->page_increment = viewport->vadjustment->page_size / 2;
562 viewport->vadjustment->step_increment = 10;
564 hval = viewport->hadjustment->value;
565 vval = viewport->vadjustment->value;
567 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
569 viewport->hadjustment->lower = 0;
570 viewport->hadjustment->upper = MAX (bin->child->requisition.width,
571 child_allocation.width);
573 hval = CLAMP (hval, 0,
574 viewport->hadjustment->upper -
575 viewport->hadjustment->page_size);
577 viewport->vadjustment->lower = 0;
578 viewport->vadjustment->upper = MAX (bin->child->requisition.height,
579 child_allocation.height);
581 vval = CLAMP (vval, 0,
582 viewport->vadjustment->upper -
583 viewport->vadjustment->page_size);
586 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
588 child_allocation.x = 0;
589 child_allocation.y = 0;
591 child_allocation.width = viewport->hadjustment->upper;
592 child_allocation.height = viewport->vadjustment->upper;
594 if (!GTK_WIDGET_REALIZED (widget))
595 gtk_widget_realize (widget);
597 gdk_window_resize (viewport->bin_window,
598 child_allocation.width,
599 child_allocation.height);
601 child_allocation.x = 0;
602 child_allocation.y = 0;
603 gtk_widget_size_allocate (bin->child, &child_allocation);
606 gtk_signal_emit_by_name (GTK_OBJECT (viewport->hadjustment), "changed");
607 gtk_signal_emit_by_name (GTK_OBJECT (viewport->vadjustment), "changed");
608 if (viewport->hadjustment->value != hval)
610 viewport->hadjustment->value = hval;
611 gtk_signal_emit_by_name (GTK_OBJECT (viewport->hadjustment), "value_changed");
613 if (viewport->vadjustment->value != vval)
615 viewport->vadjustment->value = vval;
616 gtk_signal_emit_by_name (GTK_OBJECT (viewport->vadjustment), "value_changed");
621 gtk_viewport_need_resize (GtkContainer *container)
625 g_return_val_if_fail (container != NULL, FALSE);
626 g_return_val_if_fail (GTK_IS_VIEWPORT (container), FALSE);
628 if (GTK_WIDGET_REALIZED (container))
630 bin = GTK_BIN (container);
632 gtk_widget_size_request (bin->child, &bin->child->requisition);
634 gtk_widget_size_allocate (GTK_WIDGET (container),
635 &(GTK_WIDGET (container)->allocation));
642 gtk_viewport_adjustment_changed (GtkAdjustment *adjustment,
645 GtkViewport *viewport;
647 g_return_if_fail (adjustment != NULL);
648 g_return_if_fail (data != NULL);
649 g_return_if_fail (GTK_IS_VIEWPORT (data));
651 viewport = GTK_VIEWPORT (data);
655 gtk_viewport_adjustment_value_changed (GtkAdjustment *adjustment,
658 GtkViewport *viewport;
660 GtkAllocation child_allocation;
663 g_return_if_fail (adjustment != NULL);
664 g_return_if_fail (data != NULL);
665 g_return_if_fail (GTK_IS_VIEWPORT (data));
667 viewport = GTK_VIEWPORT (data);
668 bin = GTK_BIN (data);
670 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
672 gdk_window_get_size (viewport->view_window, &width, &height);
674 child_allocation.x = 0;
675 child_allocation.y = 0;
677 if (viewport->hadjustment->lower != (viewport->hadjustment->upper -
678 viewport->hadjustment->page_size))
679 child_allocation.x = viewport->hadjustment->lower - viewport->hadjustment->value;
681 if (viewport->vadjustment->lower != (viewport->vadjustment->upper -
682 viewport->vadjustment->page_size))
683 child_allocation.y = viewport->vadjustment->lower - viewport->vadjustment->value;
685 if (GTK_WIDGET_REALIZED (viewport))
686 gdk_window_move (viewport->bin_window,