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 * GtkLayout: Widget for scrolling of arbitrary-sized areas.
21 * Copyright Owen Taylor, 1998
25 * Modified by the GTK+ Team and others 1997-1999. See the AUTHORS
26 * file for a list of people on the GTK+ Team. See the ChangeLog
27 * files for a list of changes. These files are distributed with
28 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
31 #include "gdkconfig.h"
33 #include "gtklayout.h"
34 #include "gtksignal.h"
35 #include "gtkprivate.h"
37 typedef struct _GtkLayoutChild GtkLayoutChild;
39 struct _GtkLayoutChild {
45 static void gtk_layout_class_init (GtkLayoutClass *class);
46 static void gtk_layout_init (GtkLayout *layout);
48 static void gtk_layout_finalize (GObject *object);
49 static void gtk_layout_realize (GtkWidget *widget);
50 static void gtk_layout_unrealize (GtkWidget *widget);
51 static void gtk_layout_map (GtkWidget *widget);
52 static void gtk_layout_size_request (GtkWidget *widget,
53 GtkRequisition *requisition);
54 static void gtk_layout_size_allocate (GtkWidget *widget,
55 GtkAllocation *allocation);
56 static void gtk_layout_draw (GtkWidget *widget,
58 static gint gtk_layout_expose (GtkWidget *widget,
59 GdkEventExpose *event);
61 static void gtk_layout_remove (GtkContainer *container,
63 static void gtk_layout_forall (GtkContainer *container,
64 gboolean include_internals,
66 gpointer callback_data);
67 static void gtk_layout_set_adjustments (GtkLayout *layout,
71 static void gtk_layout_allocate_child (GtkLayout *layout,
72 GtkLayoutChild *child);
75 static void gtk_layout_adjustment_changed (GtkAdjustment *adjustment,
78 static GtkWidgetClass *parent_class = NULL;
84 gtk_layout_new (GtkAdjustment *hadjustment,
85 GtkAdjustment *vadjustment)
89 layout = gtk_type_new (GTK_TYPE_LAYOUT);
91 gtk_layout_set_adjustments (layout, hadjustment, vadjustment);
93 return GTK_WIDGET (layout);
97 gtk_layout_get_hadjustment (GtkLayout *layout)
99 g_return_val_if_fail (layout != NULL, NULL);
100 g_return_val_if_fail (GTK_IS_LAYOUT (layout), NULL);
102 return layout->hadjustment;
105 gtk_layout_get_vadjustment (GtkLayout *layout)
107 g_return_val_if_fail (layout != NULL, NULL);
108 g_return_val_if_fail (GTK_IS_LAYOUT (layout), NULL);
110 return layout->vadjustment;
114 gtk_layout_set_adjustments (GtkLayout *layout,
118 gboolean need_adjust = FALSE;
120 g_return_if_fail (layout != NULL);
121 g_return_if_fail (GTK_IS_LAYOUT (layout));
124 g_return_if_fail (GTK_IS_ADJUSTMENT (hadj));
126 hadj = GTK_ADJUSTMENT (gtk_adjustment_new (0.0, 0.0, 0.0, 0.0, 0.0, 0.0));
128 g_return_if_fail (GTK_IS_ADJUSTMENT (vadj));
130 vadj = GTK_ADJUSTMENT (gtk_adjustment_new (0.0, 0.0, 0.0, 0.0, 0.0, 0.0));
132 if (layout->hadjustment && (layout->hadjustment != hadj))
134 gtk_signal_disconnect_by_data (GTK_OBJECT (layout->hadjustment), layout);
135 gtk_object_unref (GTK_OBJECT (layout->hadjustment));
138 if (layout->vadjustment && (layout->vadjustment != vadj))
140 gtk_signal_disconnect_by_data (GTK_OBJECT (layout->vadjustment), layout);
141 gtk_object_unref (GTK_OBJECT (layout->vadjustment));
144 if (layout->hadjustment != hadj)
146 layout->hadjustment = hadj;
147 gtk_object_ref (GTK_OBJECT (layout->hadjustment));
148 gtk_object_sink (GTK_OBJECT (layout->hadjustment));
150 gtk_signal_connect (GTK_OBJECT (layout->hadjustment), "value_changed",
151 (GtkSignalFunc) gtk_layout_adjustment_changed,
156 if (layout->vadjustment != vadj)
158 layout->vadjustment = vadj;
159 gtk_object_ref (GTK_OBJECT (layout->vadjustment));
160 gtk_object_sink (GTK_OBJECT (layout->vadjustment));
162 gtk_signal_connect (GTK_OBJECT (layout->vadjustment), "value_changed",
163 (GtkSignalFunc) gtk_layout_adjustment_changed,
169 gtk_layout_adjustment_changed (NULL, layout);
173 gtk_layout_finalize (GObject *object)
175 GtkLayout *layout = GTK_LAYOUT (object);
177 gtk_object_unref (GTK_OBJECT (layout->hadjustment));
178 gtk_object_unref (GTK_OBJECT (layout->vadjustment));
180 G_OBJECT_CLASS (parent_class)->finalize (object);
184 gtk_layout_set_hadjustment (GtkLayout *layout,
185 GtkAdjustment *adjustment)
187 g_return_if_fail (layout != NULL);
188 g_return_if_fail (GTK_IS_LAYOUT (layout));
190 gtk_layout_set_adjustments (layout, adjustment, layout->vadjustment);
195 gtk_layout_set_vadjustment (GtkLayout *layout,
196 GtkAdjustment *adjustment)
198 g_return_if_fail (layout != NULL);
199 g_return_if_fail (GTK_IS_LAYOUT (layout));
201 gtk_layout_set_adjustments (layout, layout->hadjustment, adjustment);
206 gtk_layout_put (GtkLayout *layout,
207 GtkWidget *child_widget,
211 GtkLayoutChild *child;
213 g_return_if_fail (layout != NULL);
214 g_return_if_fail (GTK_IS_LAYOUT (layout));
215 g_return_if_fail (child_widget != NULL);
216 g_return_if_fail (GTK_IS_WIDGET (child_widget));
218 child = g_new (GtkLayoutChild, 1);
220 child->widget = child_widget;
224 layout->children = g_list_append (layout->children, child);
226 gtk_widget_set_parent (child_widget, GTK_WIDGET (layout));
227 if (GTK_WIDGET_REALIZED (layout))
228 gtk_widget_set_parent_window (child->widget, layout->bin_window);
230 if (GTK_WIDGET_REALIZED (layout))
231 gtk_widget_realize (child_widget);
233 if (GTK_WIDGET_VISIBLE (layout) && GTK_WIDGET_VISIBLE (child_widget))
235 if (GTK_WIDGET_MAPPED (layout))
236 gtk_widget_map (child_widget);
238 gtk_widget_queue_resize (child_widget);
243 gtk_layout_move (GtkLayout *layout,
244 GtkWidget *child_widget,
249 GtkLayoutChild *child;
251 g_return_if_fail (layout != NULL);
252 g_return_if_fail (GTK_IS_LAYOUT (layout));
254 tmp_list = layout->children;
257 child = tmp_list->data;
258 tmp_list = tmp_list->next;
260 if (child->widget == child_widget)
265 if (GTK_WIDGET_VISIBLE (child_widget) && GTK_WIDGET_VISIBLE (layout))
266 gtk_widget_queue_resize (child_widget);
274 gtk_layout_set_adjustment_upper (GtkAdjustment *adj, gfloat upper)
276 if (upper != adj->upper)
278 gfloat min = MAX (0., upper - adj->page_size);
279 gboolean value_changed = FALSE;
283 if (adj->value > min)
286 value_changed = TRUE;
289 gtk_signal_emit_by_name (GTK_OBJECT (adj), "changed");
291 gtk_signal_emit_by_name (GTK_OBJECT (adj), "value_changed");
296 gtk_layout_set_size (GtkLayout *layout,
302 g_return_if_fail (layout != NULL);
303 g_return_if_fail (GTK_IS_LAYOUT (layout));
305 widget = GTK_WIDGET (layout);
307 layout->width = width;
308 layout->height = height;
310 gtk_layout_set_adjustment_upper (layout->hadjustment, layout->width);
311 gtk_layout_set_adjustment_upper (layout->vadjustment, layout->height);
313 if (GTK_WIDGET_REALIZED (layout))
315 width = MAX (width, widget->allocation.width);
316 height = MAX (height, widget->allocation.height);
317 gdk_window_resize (layout->bin_window, width, height);
322 gtk_layout_freeze (GtkLayout *layout)
324 g_return_if_fail (layout != NULL);
325 g_return_if_fail (GTK_IS_LAYOUT (layout));
327 layout->freeze_count++;
331 gtk_layout_thaw (GtkLayout *layout)
333 g_return_if_fail (layout != NULL);
334 g_return_if_fail (GTK_IS_LAYOUT (layout));
336 if (layout->freeze_count)
337 if (!(--layout->freeze_count))
338 gtk_widget_draw (GTK_WIDGET (layout), NULL);
341 /* Basic Object handling procedures
344 gtk_layout_get_type (void)
346 static GtkType layout_type = 0;
350 static const GTypeInfo layout_info =
352 sizeof (GtkLayoutClass),
353 NULL, /* base_init */
354 NULL, /* base_finalize */
355 (GClassInitFunc) gtk_layout_class_init,
356 NULL, /* class_finalize */
357 NULL, /* class_data */
359 16, /* n_preallocs */
360 (GInstanceInitFunc) gtk_layout_init,
363 layout_type = g_type_register_static (GTK_TYPE_CONTAINER, "GtkLayout", &layout_info);
370 gtk_layout_class_init (GtkLayoutClass *class)
372 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
373 GtkObjectClass *object_class;
374 GtkWidgetClass *widget_class;
375 GtkContainerClass *container_class;
377 object_class = (GtkObjectClass*) class;
378 widget_class = (GtkWidgetClass*) class;
379 container_class = (GtkContainerClass*) class;
381 parent_class = gtk_type_class (GTK_TYPE_CONTAINER);
383 gobject_class->finalize = gtk_layout_finalize;
385 widget_class->realize = gtk_layout_realize;
386 widget_class->unrealize = gtk_layout_unrealize;
387 widget_class->map = gtk_layout_map;
388 widget_class->size_request = gtk_layout_size_request;
389 widget_class->size_allocate = gtk_layout_size_allocate;
390 widget_class->draw = gtk_layout_draw;
391 widget_class->expose_event = gtk_layout_expose;
393 container_class->remove = gtk_layout_remove;
394 container_class->forall = gtk_layout_forall;
396 class->set_scroll_adjustments = gtk_layout_set_adjustments;
398 widget_class->set_scroll_adjustments_signal =
399 gtk_signal_new ("set_scroll_adjustments",
401 GTK_CLASS_TYPE (object_class),
402 GTK_SIGNAL_OFFSET (GtkLayoutClass, set_scroll_adjustments),
403 gtk_marshal_NONE__POINTER_POINTER,
404 GTK_TYPE_NONE, 2, GTK_TYPE_ADJUSTMENT, GTK_TYPE_ADJUSTMENT);
408 gtk_layout_init (GtkLayout *layout)
410 layout->children = NULL;
413 layout->height = 100;
415 layout->hadjustment = NULL;
416 layout->vadjustment = NULL;
418 layout->bin_window = NULL;
420 layout->configure_serial = 0;
421 layout->scroll_x = 0;
422 layout->scroll_y = 0;
423 layout->visibility = GDK_VISIBILITY_PARTIAL;
425 layout->freeze_count = 0;
432 gtk_layout_realize (GtkWidget *widget)
436 GdkWindowAttr attributes;
437 gint attributes_mask;
439 g_return_if_fail (widget != NULL);
440 g_return_if_fail (GTK_IS_LAYOUT (widget));
442 layout = GTK_LAYOUT (widget);
443 GTK_WIDGET_SET_FLAGS (layout, GTK_REALIZED);
445 attributes.window_type = GDK_WINDOW_CHILD;
446 attributes.x = widget->allocation.x;
447 attributes.y = widget->allocation.y;
448 attributes.width = widget->allocation.width;
449 attributes.height = widget->allocation.height;
450 attributes.wclass = GDK_INPUT_OUTPUT;
451 attributes.visual = gtk_widget_get_visual (widget);
452 attributes.colormap = gtk_widget_get_colormap (widget);
453 attributes.event_mask = GDK_VISIBILITY_NOTIFY_MASK;
455 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
457 widget->window = gdk_window_new (gtk_widget_get_parent_window (widget),
458 &attributes, attributes_mask);
459 gdk_window_set_user_data (widget->window, widget);
463 attributes.width = MAX (layout->width, widget->allocation.width);
464 attributes.height = MAX (layout->height, widget->allocation.height);
465 attributes.event_mask = GDK_EXPOSURE_MASK | GDK_SCROLL_MASK |
466 gtk_widget_get_events (widget);
468 layout->bin_window = gdk_window_new (widget->window,
469 &attributes, attributes_mask);
470 gdk_window_set_user_data (layout->bin_window, widget);
472 widget->style = gtk_style_attach (widget->style, widget->window);
473 gtk_style_set_background (widget->style, widget->window, GTK_STATE_NORMAL);
474 gtk_style_set_background (widget->style, layout->bin_window, GTK_STATE_NORMAL);
476 tmp_list = layout->children;
479 GtkLayoutChild *child = tmp_list->data;
480 tmp_list = tmp_list->next;
482 gtk_widget_set_parent_window (child->widget, layout->bin_window);
487 gtk_layout_map (GtkWidget *widget)
492 g_return_if_fail (widget != NULL);
493 g_return_if_fail (GTK_IS_LAYOUT (widget));
495 layout = GTK_LAYOUT (widget);
497 GTK_WIDGET_SET_FLAGS (widget, GTK_MAPPED);
499 tmp_list = layout->children;
502 GtkLayoutChild *child = tmp_list->data;
503 tmp_list = tmp_list->next;
505 if (GTK_WIDGET_VISIBLE (child->widget))
507 if (!GTK_WIDGET_MAPPED (child->widget))
508 gtk_widget_map (child->widget);
512 gdk_window_show (layout->bin_window);
513 gdk_window_show (widget->window);
517 gtk_layout_unrealize (GtkWidget *widget)
521 g_return_if_fail (widget != NULL);
522 g_return_if_fail (GTK_IS_LAYOUT (widget));
524 layout = GTK_LAYOUT (widget);
526 gdk_window_set_user_data (layout->bin_window, NULL);
527 gdk_window_destroy (layout->bin_window);
528 layout->bin_window = NULL;
530 if (GTK_WIDGET_CLASS (parent_class)->unrealize)
531 (* GTK_WIDGET_CLASS (parent_class)->unrealize) (widget);
535 gtk_layout_size_request (GtkWidget *widget,
536 GtkRequisition *requisition)
541 g_return_if_fail (widget != NULL);
542 g_return_if_fail (GTK_IS_LAYOUT (widget));
544 layout = GTK_LAYOUT (widget);
546 requisition->width = 0;
547 requisition->height = 0;
549 tmp_list = layout->children;
553 GtkLayoutChild *child = tmp_list->data;
554 GtkRequisition child_requisition;
556 tmp_list = tmp_list->next;
558 gtk_widget_size_request (child->widget, &child_requisition);
563 gtk_layout_size_allocate (GtkWidget *widget,
564 GtkAllocation *allocation)
569 g_return_if_fail (widget != NULL);
570 g_return_if_fail (GTK_IS_LAYOUT (widget));
572 widget->allocation = *allocation;
574 layout = GTK_LAYOUT (widget);
576 tmp_list = layout->children;
580 GtkLayoutChild *child = tmp_list->data;
581 tmp_list = tmp_list->next;
583 gtk_layout_allocate_child (layout, child);
586 if (GTK_WIDGET_REALIZED (widget))
588 gdk_window_move_resize (widget->window,
589 allocation->x, allocation->y,
590 allocation->width, allocation->height);
592 gdk_window_resize (layout->bin_window,
593 MAX (layout->width, allocation->width),
594 MAX (layout->height, allocation->height));
597 layout->hadjustment->page_size = allocation->width;
598 layout->hadjustment->page_increment = allocation->width / 2;
599 layout->hadjustment->lower = 0;
600 layout->hadjustment->upper = MAX (allocation->width, layout->width);
601 gtk_signal_emit_by_name (GTK_OBJECT (layout->hadjustment), "changed");
603 layout->vadjustment->page_size = allocation->height;
604 layout->vadjustment->page_increment = allocation->height / 2;
605 layout->vadjustment->lower = 0;
606 layout->vadjustment->upper = MAX (allocation->height, layout->height);
607 gtk_signal_emit_by_name (GTK_OBJECT (layout->vadjustment), "changed");
611 gtk_layout_draw (GtkWidget *widget, GdkRectangle *area)
615 GdkRectangle child_area;
617 g_return_if_fail (widget != NULL);
618 g_return_if_fail (GTK_IS_LAYOUT (widget));
620 layout = GTK_LAYOUT (widget);
622 /* We don't have any way of telling themes about this properly,
623 * so we just assume a background pixmap
625 if (!GTK_WIDGET_APP_PAINTABLE (widget))
626 gdk_window_clear_area (layout->bin_window,
627 area->x, area->y, area->width, area->height);
629 tmp_list = layout->children;
632 GtkLayoutChild *child = tmp_list->data;
633 tmp_list = tmp_list->next;
635 if (gtk_widget_intersect (child->widget, area, &child_area))
636 gtk_widget_draw (child->widget, &child_area);
641 gtk_layout_expose (GtkWidget *widget, GdkEventExpose *event)
645 GdkEventExpose child_event;
647 g_return_val_if_fail (widget != NULL, FALSE);
648 g_return_val_if_fail (GTK_IS_LAYOUT (widget), FALSE);
650 layout = GTK_LAYOUT (widget);
652 if (event->window != layout->bin_window)
655 tmp_list = layout->children;
658 GtkLayoutChild *child = tmp_list->data;
659 tmp_list = tmp_list->next;
661 child_event = *event;
662 if (GTK_WIDGET_DRAWABLE (child->widget) &&
663 GTK_WIDGET_NO_WINDOW (child->widget) &&
664 gtk_widget_intersect (child->widget, &event->area, &child_event.area))
665 gtk_widget_event (child->widget, (GdkEvent*) &child_event);
674 gtk_layout_remove (GtkContainer *container,
679 GtkLayoutChild *child = NULL;
681 g_return_if_fail (container != NULL);
682 g_return_if_fail (GTK_IS_LAYOUT (container));
684 layout = GTK_LAYOUT (container);
686 tmp_list = layout->children;
689 child = tmp_list->data;
690 if (child->widget == widget)
692 tmp_list = tmp_list->next;
697 gtk_widget_unparent (widget);
699 layout->children = g_list_remove_link (layout->children, tmp_list);
700 g_list_free_1 (tmp_list);
706 gtk_layout_forall (GtkContainer *container,
707 gboolean include_internals,
708 GtkCallback callback,
709 gpointer callback_data)
712 GtkLayoutChild *child;
715 g_return_if_fail (container != NULL);
716 g_return_if_fail (GTK_IS_LAYOUT (container));
717 g_return_if_fail (callback != NULL);
719 layout = GTK_LAYOUT (container);
721 tmp_list = layout->children;
724 child = tmp_list->data;
725 tmp_list = tmp_list->next;
727 (* callback) (child->widget, callback_data);
731 /* Operations on children
735 gtk_layout_allocate_child (GtkLayout *layout,
736 GtkLayoutChild *child)
738 GtkAllocation allocation;
739 GtkRequisition requisition;
741 allocation.x = child->x - layout->xoffset;
742 allocation.y = child->y - layout->yoffset;
743 gtk_widget_get_child_requisition (child->widget, &requisition);
744 allocation.width = requisition.width;
745 allocation.height = requisition.height;
747 gtk_widget_size_allocate (child->widget, &allocation);
753 gtk_layout_adjustment_changed (GtkAdjustment *adjustment,
758 widget = GTK_WIDGET (layout);
760 if (layout->freeze_count)
763 if (GTK_WIDGET_REALIZED (layout))
765 gdk_window_move (layout->bin_window,
766 - layout->hadjustment->value,
767 - layout->vadjustment->value);
769 gdk_window_process_updates (layout->bin_window, TRUE);