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 Lesser 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 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser 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.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
29 #include "gtkbindings.h"
30 #include "gtksignal.h"
31 #include "gdk/gdkkeysyms.h"
32 #include "gtkwindow.h"
34 #include "gtkmarshalers.h"
52 static void gtk_paned_class_init (GtkPanedClass *klass);
53 static void gtk_paned_init (GtkPaned *paned);
54 static void gtk_paned_set_property (GObject *object,
58 static void gtk_paned_get_property (GObject *object,
62 static void gtk_paned_realize (GtkWidget *widget);
63 static void gtk_paned_unrealize (GtkWidget *widget);
64 static void gtk_paned_map (GtkWidget *widget);
65 static void gtk_paned_unmap (GtkWidget *widget);
66 static gboolean gtk_paned_expose (GtkWidget *widget,
67 GdkEventExpose *event);
68 static gboolean gtk_paned_enter (GtkWidget *widget,
69 GdkEventCrossing *event);
70 static gboolean gtk_paned_leave (GtkWidget *widget,
71 GdkEventCrossing *event);
72 static gboolean gtk_paned_button_press (GtkWidget *widget,
73 GdkEventButton *event);
74 static gboolean gtk_paned_button_release (GtkWidget *widget,
75 GdkEventButton *event);
76 static gboolean gtk_paned_motion (GtkWidget *widget,
77 GdkEventMotion *event);
78 static gboolean gtk_paned_focus (GtkWidget *widget,
79 GtkDirectionType direction);
80 static void gtk_paned_add (GtkContainer *container,
82 static void gtk_paned_remove (GtkContainer *container,
84 static void gtk_paned_forall (GtkContainer *container,
85 gboolean include_internals,
87 gpointer callback_data);
88 static void gtk_paned_set_focus_child (GtkContainer *container,
90 static void gtk_paned_set_saved_focus (GtkPaned *paned,
92 static void gtk_paned_set_last_child1_focus (GtkPaned *paned,
94 static void gtk_paned_set_last_child2_focus (GtkPaned *paned,
96 static gboolean gtk_paned_cycle_child_focus (GtkPaned *paned,
98 static gboolean gtk_paned_cycle_handle_focus (GtkPaned *paned,
100 static gboolean gtk_paned_move_handle (GtkPaned *paned,
101 GtkScrollType scroll);
102 static gboolean gtk_paned_accept_position (GtkPaned *paned);
103 static gboolean gtk_paned_cancel_position (GtkPaned *paned);
104 static gboolean gtk_paned_toggle_handle_focus (GtkPaned *paned);
105 static GtkType gtk_paned_child_type (GtkContainer *container);
107 static GtkContainerClass *parent_class = NULL;
111 gtk_paned_get_type (void)
113 static GtkType paned_type = 0;
117 static const GTypeInfo paned_info =
119 sizeof (GtkPanedClass),
120 NULL, /* base_init */
121 NULL, /* base_finalize */
122 (GClassInitFunc) gtk_paned_class_init,
123 NULL, /* class_finalize */
124 NULL, /* class_data */
127 (GInstanceInitFunc) gtk_paned_init,
128 NULL, /* value_table */
131 paned_type = g_type_register_static (GTK_TYPE_CONTAINER, "GtkPaned",
132 &paned_info, G_TYPE_FLAG_ABSTRACT);
138 static guint signals[LAST_SIGNAL] = { 0 };
141 add_tab_bindings (GtkBindingSet *binding_set,
142 GdkModifierType modifiers,
145 gtk_binding_entry_add_signal (binding_set, GDK_Tab, modifiers,
146 "cycle_handle_focus", 1,
147 G_TYPE_BOOLEAN, reverse);
148 gtk_binding_entry_add_signal (binding_set, GDK_KP_Tab, modifiers,
149 "cycle_handle_focus", 1,
150 G_TYPE_BOOLEAN, reverse);
154 add_move_binding (GtkBindingSet *binding_set,
156 GdkModifierType mask,
157 GtkScrollType scroll)
159 gtk_binding_entry_add_signal (binding_set, keyval, mask,
161 GTK_TYPE_SCROLL_TYPE, scroll);
165 gtk_paned_class_init (GtkPanedClass *class)
167 GObjectClass *object_class;
168 GtkWidgetClass *widget_class;
169 GtkContainerClass *container_class;
170 GtkPanedClass *paned_class;
171 GtkBindingSet *binding_set;
173 object_class = (GObjectClass *) class;
174 widget_class = (GtkWidgetClass *) class;
175 container_class = (GtkContainerClass *) class;
176 paned_class = (GtkPanedClass *) class;
178 parent_class = gtk_type_class (GTK_TYPE_CONTAINER);
180 object_class->set_property = gtk_paned_set_property;
181 object_class->get_property = gtk_paned_get_property;
183 widget_class->realize = gtk_paned_realize;
184 widget_class->unrealize = gtk_paned_unrealize;
185 widget_class->map = gtk_paned_map;
186 widget_class->unmap = gtk_paned_unmap;
187 widget_class->expose_event = gtk_paned_expose;
188 widget_class->focus = gtk_paned_focus;
189 widget_class->enter_notify_event = gtk_paned_enter;
190 widget_class->leave_notify_event = gtk_paned_leave;
191 widget_class->button_press_event = gtk_paned_button_press;
192 widget_class->button_release_event = gtk_paned_button_release;
193 widget_class->motion_notify_event = gtk_paned_motion;
195 container_class->add = gtk_paned_add;
196 container_class->remove = gtk_paned_remove;
197 container_class->forall = gtk_paned_forall;
198 container_class->child_type = gtk_paned_child_type;
199 container_class->set_focus_child = gtk_paned_set_focus_child;
201 paned_class->cycle_child_focus = gtk_paned_cycle_child_focus;
202 paned_class->toggle_handle_focus = gtk_paned_toggle_handle_focus;
203 paned_class->move_handle = gtk_paned_move_handle;
204 paned_class->cycle_handle_focus = gtk_paned_cycle_handle_focus;
205 paned_class->accept_position = gtk_paned_accept_position;
206 paned_class->cancel_position = gtk_paned_cancel_position;
208 g_object_class_install_property (object_class,
210 g_param_spec_int ("position",
212 _("Position of paned separator in pixels (0 means all the way to the left/top)"),
216 G_PARAM_READABLE | G_PARAM_WRITABLE));
217 g_object_class_install_property (object_class,
219 g_param_spec_boolean ("position_set",
221 _("TRUE if the Position property should be used"),
223 G_PARAM_READABLE | G_PARAM_WRITABLE));
225 gtk_widget_class_install_style_property (widget_class,
226 g_param_spec_int ("handle_size",
228 _("Width of handle"),
234 signals [CYCLE_HANDLE_FOCUS] =
235 g_signal_new ("cycle_child_focus",
236 G_TYPE_FROM_CLASS (object_class),
237 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
238 G_STRUCT_OFFSET (GtkPanedClass, cycle_child_focus),
240 _gtk_marshal_BOOLEAN__BOOLEAN,
244 signals [TOGGLE_HANDLE_FOCUS] =
245 g_signal_new ("toggle_handle_focus",
246 G_TYPE_FROM_CLASS (object_class),
247 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
248 G_STRUCT_OFFSET (GtkPanedClass, toggle_handle_focus),
250 _gtk_marshal_BOOLEAN__VOID,
253 signals[MOVE_HANDLE] =
254 g_signal_new ("move_handle",
255 G_TYPE_FROM_CLASS (object_class),
256 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
257 G_STRUCT_OFFSET (GtkPanedClass, move_handle),
259 _gtk_marshal_BOOLEAN__ENUM,
261 GTK_TYPE_SCROLL_TYPE);
263 signals [CYCLE_HANDLE_FOCUS] =
264 g_signal_new ("cycle_handle_focus",
265 G_TYPE_FROM_CLASS (object_class),
266 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
267 G_STRUCT_OFFSET (GtkPanedClass, cycle_handle_focus),
269 _gtk_marshal_BOOLEAN__BOOLEAN,
273 signals [ACCEPT_POSITION] =
274 g_signal_new ("accept_position",
275 G_TYPE_FROM_CLASS (object_class),
276 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
277 G_STRUCT_OFFSET (GtkPanedClass, accept_position),
279 _gtk_marshal_BOOLEAN__VOID,
282 signals [CANCEL_POSITION] =
283 g_signal_new ("cancel_position",
284 G_TYPE_FROM_CLASS (object_class),
285 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
286 G_STRUCT_OFFSET (GtkPanedClass, cancel_position),
288 _gtk_marshal_BOOLEAN__VOID,
291 binding_set = gtk_binding_set_by_class (object_class);
294 gtk_binding_entry_add_signal (binding_set,
296 "cycle_child_focus", 1,
297 G_TYPE_BOOLEAN, FALSE);
298 gtk_binding_entry_add_signal (binding_set,
299 GDK_F6, GDK_SHIFT_MASK,
300 "cycle_child_focus", 1,
301 G_TYPE_BOOLEAN, TRUE);
304 gtk_binding_entry_add_signal (binding_set,
306 "toggle_handle_focus", 0);
308 add_tab_bindings (binding_set, 0, GTK_DIR_TAB_FORWARD);
309 add_tab_bindings (binding_set, GDK_CONTROL_MASK, GTK_DIR_TAB_FORWARD);
310 add_tab_bindings (binding_set, GDK_SHIFT_MASK, GTK_DIR_TAB_BACKWARD);
311 add_tab_bindings (binding_set, GDK_CONTROL_MASK | GDK_SHIFT_MASK, GTK_DIR_TAB_BACKWARD);
313 /* accept and cancel positions */
314 gtk_binding_entry_add_signal (binding_set,
316 "cancel_position", 0);
318 gtk_binding_entry_add_signal (binding_set,
320 "accept_position", 0);
321 gtk_binding_entry_add_signal (binding_set,
323 "accept_position", 0);
324 gtk_binding_entry_add_signal (binding_set,
326 "accept_position", 0);
327 gtk_binding_entry_add_signal (binding_set,
329 "accept_position", 0);
332 add_move_binding (binding_set, GDK_Left, 0, GTK_SCROLL_STEP_LEFT);
333 add_move_binding (binding_set, GDK_KP_Left, 0, GTK_SCROLL_STEP_LEFT);
334 add_move_binding (binding_set, GDK_Left, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_LEFT);
335 add_move_binding (binding_set, GDK_KP_Left, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_LEFT);
337 add_move_binding (binding_set, GDK_Right, 0, GTK_SCROLL_STEP_RIGHT);
338 add_move_binding (binding_set, GDK_Right, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_RIGHT);
339 add_move_binding (binding_set, GDK_KP_Right, 0, GTK_SCROLL_STEP_RIGHT);
340 add_move_binding (binding_set, GDK_KP_Right, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_RIGHT);
342 add_move_binding (binding_set, GDK_Up, 0, GTK_SCROLL_STEP_UP);
343 add_move_binding (binding_set, GDK_Up, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_UP);
344 add_move_binding (binding_set, GDK_KP_Up, 0, GTK_SCROLL_STEP_UP);
345 add_move_binding (binding_set, GDK_KP_Up, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_UP);
346 add_move_binding (binding_set, GDK_Page_Up, 0, GTK_SCROLL_PAGE_UP);
347 add_move_binding (binding_set, GDK_KP_Page_Up, 0, GTK_SCROLL_PAGE_UP);
349 add_move_binding (binding_set, GDK_Down, 0, GTK_SCROLL_STEP_DOWN);
350 add_move_binding (binding_set, GDK_Down, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_DOWN);
351 add_move_binding (binding_set, GDK_KP_Down, 0, GTK_SCROLL_STEP_DOWN);
352 add_move_binding (binding_set, GDK_KP_Down, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_DOWN);
353 add_move_binding (binding_set, GDK_Page_Down, 0, GTK_SCROLL_PAGE_RIGHT);
354 add_move_binding (binding_set, GDK_KP_Page_Down, 0, GTK_SCROLL_PAGE_RIGHT);
356 add_move_binding (binding_set, GDK_Home, 0, GTK_SCROLL_START);
357 add_move_binding (binding_set, GDK_KP_Home, 0, GTK_SCROLL_START);
358 add_move_binding (binding_set, GDK_End, 0, GTK_SCROLL_END);
359 add_move_binding (binding_set, GDK_KP_End, 0, GTK_SCROLL_END);
363 gtk_paned_child_type (GtkContainer *container)
365 if (!GTK_PANED (container)->child1 || !GTK_PANED (container)->child2)
366 return GTK_TYPE_WIDGET;
368 return GTK_TYPE_NONE;
372 gtk_paned_init (GtkPaned *paned)
374 GTK_WIDGET_SET_FLAGS (paned, GTK_NO_WINDOW | GTK_CAN_FOCUS);
376 paned->child1 = NULL;
377 paned->child2 = NULL;
378 paned->handle = NULL;
379 paned->xor_gc = NULL;
380 paned->cursor_type = GDK_CROSS;
382 paned->handle_pos.width = 5;
383 paned->handle_pos.height = 5;
384 paned->position_set = FALSE;
385 paned->last_allocation = -1;
386 paned->in_drag = FALSE;
388 paned->saved_focus = NULL;
389 paned->last_child1_focus = NULL;
390 paned->last_child2_focus = NULL;
391 paned->in_recursion = FALSE;
392 paned->handle_prelit = FALSE;
393 paned->original_position = -1;
395 paned->handle_pos.x = -1;
396 paned->handle_pos.y = -1;
398 paned->drag_pos = -1;
402 gtk_paned_set_property (GObject *object,
407 GtkPaned *paned = GTK_PANED (object);
412 gtk_paned_set_position (paned, g_value_get_int (value));
414 case PROP_POSITION_SET:
415 paned->position_set = g_value_get_boolean (value);
416 gtk_widget_queue_resize (GTK_WIDGET (paned));
419 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
425 gtk_paned_get_property (GObject *object,
430 GtkPaned *paned = GTK_PANED (object);
435 g_value_set_int (value, paned->child1_size);
437 case PROP_POSITION_SET:
438 g_value_set_boolean (value, paned->position_set);
441 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
447 gtk_paned_realize (GtkWidget *widget)
450 GdkWindowAttr attributes;
451 gint attributes_mask;
453 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
454 paned = GTK_PANED (widget);
456 widget->window = gtk_widget_get_parent_window (widget);
457 gdk_window_ref (widget->window);
459 attributes.window_type = GDK_WINDOW_CHILD;
460 attributes.wclass = GDK_INPUT_ONLY;
461 attributes.x = paned->handle_pos.x;
462 attributes.y = paned->handle_pos.y;
463 attributes.width = paned->handle_pos.width;
464 attributes.height = paned->handle_pos.height;
465 attributes.cursor = gdk_cursor_new_for_display (gtk_widget_get_display (widget),
467 attributes.event_mask = gtk_widget_get_events (widget);
468 attributes.event_mask |= (GDK_BUTTON_PRESS_MASK |
469 GDK_BUTTON_RELEASE_MASK |
470 GDK_ENTER_NOTIFY_MASK |
471 GDK_LEAVE_NOTIFY_MASK |
472 GDK_POINTER_MOTION_MASK |
473 GDK_POINTER_MOTION_HINT_MASK);
474 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_CURSOR;
476 paned->handle = gdk_window_new (widget->window,
477 &attributes, attributes_mask);
478 gdk_window_set_user_data (paned->handle, paned);
479 gdk_cursor_destroy (attributes.cursor);
481 widget->style = gtk_style_attach (widget->style, widget->window);
483 if (paned->child1 && GTK_WIDGET_VISIBLE (paned->child1) &&
484 paned->child2 && GTK_WIDGET_VISIBLE (paned->child2))
485 gdk_window_show (paned->handle);
489 gtk_paned_unrealize (GtkWidget *widget)
491 GtkPaned *paned = GTK_PANED (widget);
495 gdk_gc_destroy (paned->xor_gc);
496 paned->xor_gc = NULL;
501 gdk_window_set_user_data (paned->handle, NULL);
502 gdk_window_destroy (paned->handle);
503 paned->handle = NULL;
506 gtk_paned_set_last_child1_focus (paned, NULL);
507 gtk_paned_set_last_child2_focus (paned, NULL);
508 gtk_paned_set_saved_focus (paned, NULL);
510 if (GTK_WIDGET_CLASS (parent_class)->unrealize)
511 (* GTK_WIDGET_CLASS (parent_class)->unrealize) (widget);
515 gtk_paned_map (GtkWidget *widget)
517 GtkPaned *paned = GTK_PANED (widget);
519 gdk_window_show (paned->handle);
521 GTK_WIDGET_CLASS (parent_class)->map (widget);
525 gtk_paned_unmap (GtkWidget *widget)
527 GtkPaned *paned = GTK_PANED (widget);
529 gdk_window_hide (paned->handle);
531 GTK_WIDGET_CLASS (parent_class)->unmap (widget);
535 gtk_paned_expose (GtkWidget *widget,
536 GdkEventExpose *event)
538 GtkPaned *paned = GTK_PANED (widget);
540 if (GTK_WIDGET_VISIBLE (widget) && GTK_WIDGET_MAPPED (widget) &&
541 paned->child1 && GTK_WIDGET_VISIBLE (paned->child1) &&
542 paned->child2 && GTK_WIDGET_VISIBLE (paned->child2))
546 region = gdk_region_rectangle (&paned->handle_pos);
547 gdk_region_intersect (region, event->region);
549 if (!gdk_region_empty (region))
554 gdk_region_get_clipbox (region, &clip);
556 if (gtk_widget_is_focus (widget))
557 state = GTK_STATE_SELECTED;
558 else if (paned->handle_prelit)
559 state = GTK_STATE_PRELIGHT;
561 state = GTK_WIDGET_STATE (widget);
563 gtk_paint_handle (widget->style, widget->window,
564 state, GTK_SHADOW_NONE,
565 &clip, widget, "paned",
566 paned->handle_pos.x, paned->handle_pos.y,
567 paned->handle_pos.width, paned->handle_pos.height,
571 gdk_region_destroy (region);
574 /* Chain up to draw children */
575 GTK_WIDGET_CLASS (parent_class)->expose_event (widget, event);
581 update_drag (GtkPaned *paned)
587 if (paned->orientation == GTK_ORIENTATION_HORIZONTAL)
588 gtk_widget_get_pointer (GTK_WIDGET (paned), NULL, &pos);
590 gtk_widget_get_pointer (GTK_WIDGET (paned), &pos, NULL);
592 gtk_widget_style_get (GTK_WIDGET (paned), "handle_size", &handle_size, NULL);
594 size = pos - GTK_CONTAINER (paned)->border_width - paned->drag_pos;
595 size = CLAMP (size, paned->min_position, paned->max_position);
597 if (size != paned->child1_size)
598 gtk_paned_set_position (paned, size);
602 gtk_paned_enter (GtkWidget *widget,
603 GdkEventCrossing *event)
605 GtkPaned *paned = GTK_PANED (widget);
611 paned->handle_prelit = TRUE;
612 gtk_widget_queue_draw_area (widget,
615 paned->handle_pos.width,
616 paned->handle_pos.height);
623 gtk_paned_leave (GtkWidget *widget,
624 GdkEventCrossing *event)
626 GtkPaned *paned = GTK_PANED (widget);
632 paned->handle_prelit = FALSE;
633 gtk_widget_queue_draw_area (widget,
636 paned->handle_pos.width,
637 paned->handle_pos.height);
644 gtk_paned_focus (GtkWidget *widget,
645 GtkDirectionType direction)
650 /* This is a hack, but how can this be done without
651 * excessive cut-and-paste from gtkcontainer.c?
654 GTK_WIDGET_UNSET_FLAGS (widget, GTK_CAN_FOCUS);
655 retval = (* GTK_WIDGET_CLASS (parent_class)->focus) (widget, direction);
656 GTK_WIDGET_SET_FLAGS (widget, GTK_CAN_FOCUS);
662 gtk_paned_button_press (GtkWidget *widget,
663 GdkEventButton *event)
665 GtkPaned *paned = GTK_PANED (widget);
667 if (!paned->in_drag &&
668 (event->window == paned->handle) && (event->button == 1))
670 paned->in_drag = TRUE;
672 /* We need a server grab here, not gtk_grab_add(), since
673 * we don't want to pass events on to the widget's children */
674 gdk_pointer_grab (paned->handle, FALSE,
675 GDK_POINTER_MOTION_HINT_MASK
676 | GDK_BUTTON1_MOTION_MASK
677 | GDK_BUTTON_RELEASE_MASK
678 | GDK_ENTER_NOTIFY_MASK
679 | GDK_LEAVE_NOTIFY_MASK,
683 if (paned->orientation == GTK_ORIENTATION_HORIZONTAL)
684 paned->drag_pos = event->y;
686 paned->drag_pos = event->x;
695 gtk_paned_button_release (GtkWidget *widget,
696 GdkEventButton *event)
698 GtkPaned *paned = GTK_PANED (widget);
700 if (paned->in_drag && (event->button == 1))
702 paned->in_drag = FALSE;
703 paned->drag_pos = -1;
704 paned->position_set = TRUE;
705 gdk_display_pointer_ungrab (gtk_widget_get_display (widget),
714 gtk_paned_motion (GtkWidget *widget,
715 GdkEventMotion *event)
717 GtkPaned *paned = GTK_PANED (widget);
729 gtk_paned_add1 (GtkPaned *paned,
732 gtk_paned_pack1 (paned, widget, FALSE, TRUE);
736 gtk_paned_add2 (GtkPaned *paned,
739 gtk_paned_pack2 (paned, widget, TRUE, TRUE);
743 gtk_paned_pack1 (GtkPaned *paned,
748 g_return_if_fail (GTK_IS_PANED (paned));
749 g_return_if_fail (GTK_IS_WIDGET (child));
753 paned->child1 = child;
754 paned->child1_resize = resize;
755 paned->child1_shrink = shrink;
757 gtk_widget_set_parent (child, GTK_WIDGET (paned));
762 gtk_paned_pack2 (GtkPaned *paned,
767 g_return_if_fail (GTK_IS_PANED (paned));
768 g_return_if_fail (GTK_IS_WIDGET (child));
772 paned->child2 = child;
773 paned->child2_resize = resize;
774 paned->child2_shrink = shrink;
776 gtk_widget_set_parent (child, GTK_WIDGET (paned));
782 gtk_paned_add (GtkContainer *container,
787 g_return_if_fail (GTK_IS_PANED (container));
789 paned = GTK_PANED (container);
792 gtk_paned_add1 (paned, widget);
793 else if (!paned->child2)
794 gtk_paned_add2 (paned, widget);
798 gtk_paned_remove (GtkContainer *container,
802 gboolean was_visible;
804 paned = GTK_PANED (container);
805 was_visible = GTK_WIDGET_VISIBLE (widget);
807 if (paned->child1 == widget)
809 gtk_widget_unparent (widget);
811 paned->child1 = NULL;
813 if (was_visible && GTK_WIDGET_VISIBLE (container))
814 gtk_widget_queue_resize (GTK_WIDGET (container));
816 else if (paned->child2 == widget)
818 gtk_widget_unparent (widget);
820 paned->child2 = NULL;
822 if (was_visible && GTK_WIDGET_VISIBLE (container))
823 gtk_widget_queue_resize (GTK_WIDGET (container));
828 gtk_paned_forall (GtkContainer *container,
829 gboolean include_internals,
830 GtkCallback callback,
831 gpointer callback_data)
835 g_return_if_fail (callback != NULL);
837 paned = GTK_PANED (container);
840 (*callback) (paned->child1, callback_data);
842 (*callback) (paned->child2, callback_data);
846 * gtk_paned_get_position:
847 * @paned: a #GtkPaned widget
849 * Obtains the position of the divider between the two panes.
851 * Return value: position of the divider
854 gtk_paned_get_position (GtkPaned *paned)
856 g_return_val_if_fail (GTK_IS_PANED (paned), 0);
858 return paned->child1_size;
862 * gtk_paned_set_position:
863 * @paned: a #GtkPaned widget
864 * @position: pixel position of divider, a negative value means that the position
867 * Sets the position of the divider between the two panes.
870 gtk_paned_set_position (GtkPaned *paned,
875 g_return_if_fail (GTK_IS_PANED (paned));
877 object = G_OBJECT (paned);
881 /* We don't clamp here - the assumption is that
882 * if the total allocation changes at the same time
883 * as the position, the position set is with reference
884 * to the new total size. If only the position changes,
885 * then clamping will occur in gtk_paned_compute_position()
888 paned->child1_size = position;
889 paned->position_set = TRUE;
893 paned->position_set = FALSE;
896 g_object_freeze_notify (object);
897 g_object_notify (object, "position");
898 g_object_notify (object, "position_set");
899 g_object_thaw_notify (object);
901 gtk_widget_queue_resize (GTK_WIDGET (paned));
905 gtk_paned_compute_position (GtkPaned *paned,
912 g_return_if_fail (GTK_IS_PANED (paned));
914 old_position = paned->child1_size;
916 paned->min_position = paned->child1_shrink ? 0 : child1_req;
918 paned->max_position = allocation;
919 if (!paned->child2_shrink)
920 paned->max_position = MAX (1, paned->max_position - child2_req);
922 if (!paned->position_set)
924 if (paned->child1_resize && !paned->child2_resize)
925 paned->child1_size = MAX (1, allocation - child2_req);
926 else if (!paned->child1_resize && paned->child2_resize)
927 paned->child1_size = child1_req;
928 else if (child1_req + child2_req != 0)
929 paned->child1_size = allocation * ((gdouble)child1_req / (child1_req + child2_req));
931 paned->child1_size = allocation * 0.5;
935 /* If the position was set before the initial allocation.
936 * (paned->last_allocation <= 0) just clamp it and leave it.
938 if (paned->last_allocation > 0)
940 if (paned->child1_resize && !paned->child2_resize)
941 paned->child1_size += allocation - paned->last_allocation;
942 else if (!(!paned->child1_resize && paned->child2_resize))
943 paned->child1_size = allocation * ((gdouble) paned->child1_size / (paned->last_allocation));
947 paned->child1_size = CLAMP (paned->child1_size,
949 paned->max_position);
951 if (paned->child1_size != old_position)
952 g_object_notify (G_OBJECT (paned), "position");
954 paned->last_allocation = allocation;
958 gtk_paned_set_saved_focus (GtkPaned *paned, GtkWidget *widget)
960 if (paned->saved_focus)
961 g_object_remove_weak_pointer (G_OBJECT (paned->saved_focus),
962 (gpointer *)&(paned->saved_focus));
964 paned->saved_focus = widget;
966 if (paned->saved_focus)
967 g_object_add_weak_pointer (G_OBJECT (paned->saved_focus),
968 (gpointer *)&(paned->saved_focus));
972 gtk_paned_set_last_child1_focus (GtkPaned *paned, GtkWidget *widget)
974 if (paned->last_child1_focus)
975 g_object_remove_weak_pointer (G_OBJECT (paned->last_child1_focus),
976 (gpointer *)&(paned->last_child1_focus));
978 paned->last_child1_focus = widget;
980 if (paned->last_child1_focus)
981 g_object_add_weak_pointer (G_OBJECT (paned->last_child1_focus),
982 (gpointer *)&(paned->last_child1_focus));
986 gtk_paned_set_last_child2_focus (GtkPaned *paned, GtkWidget *widget)
988 if (paned->last_child2_focus)
989 g_object_remove_weak_pointer (G_OBJECT (paned->last_child2_focus),
990 (gpointer *)&(paned->last_child2_focus));
992 paned->last_child2_focus = widget;
994 if (paned->last_child2_focus)
995 g_object_add_weak_pointer (G_OBJECT (paned->last_child2_focus),
996 (gpointer *)&(paned->last_child2_focus));
1000 paned_get_focus_widget (GtkPaned *paned)
1002 GtkWidget *toplevel;
1004 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (paned));
1005 if (GTK_WIDGET_TOPLEVEL (toplevel))
1006 return GTK_WINDOW (toplevel)->focus_widget;
1012 gtk_paned_set_focus_child (GtkContainer *container,
1013 GtkWidget *focus_child)
1017 g_return_if_fail (GTK_IS_PANED (container));
1019 paned = GTK_PANED (container);
1021 if (focus_child == NULL)
1023 GtkWidget *last_focus;
1026 last_focus = paned_get_focus_widget (paned);
1030 /* If there is one or more paned widgets between us and the
1031 * focus widget, we want the topmost of those as last_focus
1033 for (w = last_focus; w != GTK_WIDGET (paned); w = w->parent)
1034 if (GTK_IS_PANED (w))
1037 if (container->focus_child == paned->child1)
1038 gtk_paned_set_last_child1_focus (paned, last_focus);
1039 else if (container->focus_child == paned->child2)
1040 gtk_paned_set_last_child2_focus (paned, last_focus);
1044 if (parent_class->set_focus_child)
1045 (* parent_class->set_focus_child) (container, focus_child);
1049 gtk_paned_get_cycle_chain (GtkPaned *paned,
1050 GtkDirectionType direction,
1053 GtkContainer *container = GTK_CONTAINER (paned);
1054 GtkWidget *ancestor = NULL;
1055 GList *temp_list = NULL;
1058 if (paned->in_recursion)
1061 g_assert (widgets != NULL);
1063 if (paned->last_child1_focus &&
1064 !gtk_widget_is_ancestor (paned->last_child1_focus, GTK_WIDGET (paned)))
1066 gtk_paned_set_last_child1_focus (paned, NULL);
1069 if (paned->last_child2_focus &&
1070 !gtk_widget_is_ancestor (paned->last_child2_focus, GTK_WIDGET (paned)))
1072 gtk_paned_set_last_child2_focus (paned, NULL);
1075 if (GTK_WIDGET (paned)->parent)
1076 ancestor = gtk_widget_get_ancestor (GTK_WIDGET (paned)->parent, GTK_TYPE_PANED);
1078 /* The idea here is that temp_list is a list of widgets we want to cycle
1079 * to. The list is prioritized so that the first element is our first
1080 * choice, the next our second, and so on.
1082 * We can't just use g_list_reverse(), because we want to try
1083 * paned->last_child?_focus before paned->child?, both when we
1084 * are going forward and backward.
1086 if (direction == GTK_DIR_TAB_FORWARD)
1088 if (container->focus_child == paned->child1)
1090 temp_list = g_list_append (temp_list, paned->last_child2_focus);
1091 temp_list = g_list_append (temp_list, paned->child2);
1092 temp_list = g_list_append (temp_list, ancestor);
1094 else if (container->focus_child == paned->child2)
1096 temp_list = g_list_append (temp_list, ancestor);
1097 temp_list = g_list_append (temp_list, paned->last_child1_focus);
1098 temp_list = g_list_append (temp_list, paned->child1);
1102 temp_list = g_list_append (temp_list, paned->last_child1_focus);
1103 temp_list = g_list_append (temp_list, paned->child1);
1104 temp_list = g_list_append (temp_list, paned->last_child2_focus);
1105 temp_list = g_list_append (temp_list, paned->child2);
1106 temp_list = g_list_append (temp_list, ancestor);
1111 if (container->focus_child == paned->child1)
1113 temp_list = g_list_append (temp_list, ancestor);
1114 temp_list = g_list_append (temp_list, paned->last_child2_focus);
1115 temp_list = g_list_append (temp_list, paned->child2);
1117 else if (container->focus_child == paned->child2)
1119 temp_list = g_list_append (temp_list, paned->last_child1_focus);
1120 temp_list = g_list_append (temp_list, paned->child1);
1121 temp_list = g_list_append (temp_list, ancestor);
1125 temp_list = g_list_append (temp_list, paned->last_child2_focus);
1126 temp_list = g_list_append (temp_list, paned->child2);
1127 temp_list = g_list_append (temp_list, paned->last_child1_focus);
1128 temp_list = g_list_append (temp_list, paned->child1);
1129 temp_list = g_list_append (temp_list, ancestor);
1133 /* Walk through the list and expand all the paned widgets. */
1134 for (list = temp_list; list != NULL; list = list->next)
1136 GtkWidget *widget = list->data;
1140 if (GTK_IS_PANED (widget))
1142 paned->in_recursion = TRUE;
1143 gtk_paned_get_cycle_chain (GTK_PANED (widget), direction, widgets);
1144 paned->in_recursion = FALSE;
1148 *widgets = g_list_append (*widgets, widget);
1153 g_list_free (temp_list);
1157 gtk_paned_cycle_child_focus (GtkPaned *paned,
1160 GList *cycle_chain = NULL;
1163 GtkDirectionType direction = reversed? GTK_DIR_TAB_BACKWARD : GTK_DIR_TAB_FORWARD;
1165 /* ignore f6 if the handle is focused */
1166 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1169 /* we can't just let the event propagate up the hierarchy,
1170 * because the paned will want to cycle focus _unless_ an
1171 * ancestor paned handles the event
1173 gtk_paned_get_cycle_chain (paned, direction, &cycle_chain);
1175 for (list = cycle_chain; list != NULL; list = list->next)
1176 if (gtk_widget_child_focus (GTK_WIDGET (list->data), direction))
1179 g_list_free (cycle_chain);
1185 get_child_panes (GtkWidget *widget,
1188 if (GTK_IS_PANED (widget))
1190 GtkPaned *paned = GTK_PANED (widget);
1192 get_child_panes (paned->child1, panes);
1193 *panes = g_list_prepend (*panes, widget);
1194 get_child_panes (paned->child2, panes);
1196 else if (GTK_IS_CONTAINER (widget))
1198 gtk_container_foreach (GTK_CONTAINER (widget),
1199 (GtkCallback)get_child_panes, panes);
1204 get_all_panes (GtkPaned *paned)
1206 GtkPaned *topmost = NULL;
1207 GList *result = NULL;
1210 for (w = GTK_WIDGET (paned); w != NULL; w = w->parent)
1212 if (GTK_IS_PANED (w))
1213 topmost = GTK_PANED (w);
1218 get_child_panes (GTK_WIDGET (topmost), &result);
1220 return g_list_reverse (result);
1224 gtk_paned_find_neighbours (GtkPaned *paned,
1228 GList *all_panes = get_all_panes (paned);
1231 g_assert (all_panes);
1233 this_link = g_list_find (all_panes, paned);
1235 g_assert (this_link);
1237 if (this_link->next)
1238 *next = this_link->next->data;
1240 *next = all_panes->data;
1242 if (this_link->prev)
1243 *prev = this_link->prev->data;
1245 *prev = g_list_last (all_panes)->data;
1253 g_list_free (all_panes);
1257 gtk_paned_move_handle (GtkPaned *paned,
1258 GtkScrollType scroll)
1260 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1266 SINGLE_STEP_SIZE = 1,
1270 old_position = gtk_paned_get_position (paned);
1274 case GTK_SCROLL_STEP_LEFT:
1275 case GTK_SCROLL_STEP_UP:
1276 case GTK_SCROLL_STEP_BACKWARD:
1277 new_position = old_position - SINGLE_STEP_SIZE;
1280 case GTK_SCROLL_STEP_RIGHT:
1281 case GTK_SCROLL_STEP_DOWN:
1282 case GTK_SCROLL_STEP_FORWARD:
1283 new_position = old_position + SINGLE_STEP_SIZE;
1286 case GTK_SCROLL_PAGE_LEFT:
1287 case GTK_SCROLL_PAGE_UP:
1288 case GTK_SCROLL_PAGE_BACKWARD:
1289 new_position = old_position - PAGE_STEP_SIZE;
1292 case GTK_SCROLL_PAGE_RIGHT:
1293 case GTK_SCROLL_PAGE_DOWN:
1294 case GTK_SCROLL_PAGE_FORWARD:
1295 new_position = old_position + PAGE_STEP_SIZE;
1298 case GTK_SCROLL_START:
1299 new_position = paned->min_position;
1302 case GTK_SCROLL_END:
1303 new_position = paned->max_position;
1307 new_position = old_position;
1311 new_position = CLAMP (new_position, paned->min_position, paned->max_position);
1313 if (old_position != new_position)
1314 gtk_paned_set_position (paned, new_position);
1323 gtk_paned_restore_focus (GtkPaned *paned)
1325 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1327 if (paned->saved_focus && GTK_WIDGET_SENSITIVE (paned->saved_focus))
1329 gtk_widget_grab_focus (paned->saved_focus);
1333 /* the saved focus is somehow not available for focusing,
1335 * 1) tabbing into the paned widget
1336 * if that didn't work,
1337 * 2) unset focus for the window if there is one
1340 if (!gtk_widget_child_focus (GTK_WIDGET (paned), GTK_DIR_TAB_FORWARD))
1342 GtkWidget *toplevel = gtk_widget_get_toplevel (GTK_WIDGET (paned));
1344 if (GTK_IS_WINDOW (toplevel))
1345 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
1349 gtk_paned_set_saved_focus (paned, NULL);
1354 gtk_paned_accept_position (GtkPaned *paned)
1356 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1358 paned->original_position = -1;
1359 gtk_paned_restore_focus (paned);
1369 gtk_paned_cancel_position (GtkPaned *paned)
1371 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1373 if (paned->original_position != -1)
1375 gtk_paned_set_position (paned, paned->original_position);
1376 paned->original_position = -1;
1379 gtk_paned_restore_focus (paned);
1387 gtk_paned_cycle_handle_focus (GtkPaned *paned,
1390 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1392 GtkPaned *next, *prev;
1393 GtkPaned *focus = NULL;
1395 gtk_paned_find_neighbours (paned, &next, &prev);
1397 if (reversed && prev)
1399 else if (!reversed && next)
1404 gtk_paned_set_saved_focus (focus, paned->saved_focus);
1405 gtk_paned_set_saved_focus (paned, NULL);
1406 gtk_widget_grab_focus (GTK_WIDGET (focus));
1408 if (!gtk_widget_is_focus (GTK_WIDGET (paned)))
1410 paned->original_position = -1;
1411 focus->original_position = gtk_paned_get_position (focus);
1422 gtk_paned_toggle_handle_focus (GtkPaned *paned)
1424 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1426 gtk_paned_accept_position (paned);
1430 GtkWidget *toplevel = gtk_widget_get_toplevel (GTK_WIDGET (paned));
1432 if (GTK_IS_WINDOW (toplevel))
1433 gtk_paned_set_saved_focus (paned, GTK_WINDOW (toplevel)->focus_widget);
1435 gtk_widget_grab_focus (GTK_WIDGET (paned));
1436 paned->original_position = gtk_paned_get_position (paned);