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_finalize (GObject *object);
63 static void gtk_paned_realize (GtkWidget *widget);
64 static void gtk_paned_unrealize (GtkWidget *widget);
65 static void gtk_paned_map (GtkWidget *widget);
66 static void gtk_paned_unmap (GtkWidget *widget);
67 static gboolean gtk_paned_expose (GtkWidget *widget,
68 GdkEventExpose *event);
69 static gboolean gtk_paned_enter (GtkWidget *widget,
70 GdkEventCrossing *event);
71 static gboolean gtk_paned_leave (GtkWidget *widget,
72 GdkEventCrossing *event);
73 static gboolean gtk_paned_button_press (GtkWidget *widget,
74 GdkEventButton *event);
75 static gboolean gtk_paned_button_release (GtkWidget *widget,
76 GdkEventButton *event);
77 static gboolean gtk_paned_motion (GtkWidget *widget,
78 GdkEventMotion *event);
79 static gboolean gtk_paned_focus (GtkWidget *widget,
80 GtkDirectionType direction);
81 static void gtk_paned_add (GtkContainer *container,
83 static void gtk_paned_remove (GtkContainer *container,
85 static void gtk_paned_forall (GtkContainer *container,
86 gboolean include_internals,
88 gpointer callback_data);
89 static void gtk_paned_set_focus_child (GtkContainer *container,
91 static void gtk_paned_set_saved_focus (GtkPaned *paned,
93 static void gtk_paned_set_first_paned (GtkPaned *paned,
94 GtkPaned *first_paned);
95 static void gtk_paned_set_last_child1_focus (GtkPaned *paned,
97 static void gtk_paned_set_last_child2_focus (GtkPaned *paned,
99 static gboolean gtk_paned_cycle_child_focus (GtkPaned *paned,
101 static gboolean gtk_paned_cycle_handle_focus (GtkPaned *paned,
103 static gboolean gtk_paned_move_handle (GtkPaned *paned,
104 GtkScrollType scroll);
105 static gboolean gtk_paned_accept_position (GtkPaned *paned);
106 static gboolean gtk_paned_cancel_position (GtkPaned *paned);
107 static gboolean gtk_paned_toggle_handle_focus (GtkPaned *paned);
109 static GType gtk_paned_child_type (GtkContainer *container);
111 static GtkContainerClass *parent_class = NULL;
113 struct _GtkPanedPrivate
115 GtkWidget *saved_focus;
116 GtkPaned *first_paned;
120 gtk_paned_get_type (void)
122 static GType paned_type = 0;
126 static const GTypeInfo paned_info =
128 sizeof (GtkPanedClass),
129 NULL, /* base_init */
130 NULL, /* base_finalize */
131 (GClassInitFunc) gtk_paned_class_init,
132 NULL, /* class_finalize */
133 NULL, /* class_data */
136 (GInstanceInitFunc) gtk_paned_init,
137 NULL, /* value_table */
140 paned_type = g_type_register_static (GTK_TYPE_CONTAINER, "GtkPaned",
141 &paned_info, G_TYPE_FLAG_ABSTRACT);
147 static guint signals[LAST_SIGNAL] = { 0 };
150 add_tab_bindings (GtkBindingSet *binding_set,
151 GdkModifierType modifiers)
153 gtk_binding_entry_add_signal (binding_set, GDK_Tab, modifiers,
154 "toggle_handle_focus", 0);
155 gtk_binding_entry_add_signal (binding_set, GDK_KP_Tab, modifiers,
156 "toggle_handle_focus", 0);
160 add_move_binding (GtkBindingSet *binding_set,
162 GdkModifierType mask,
163 GtkScrollType scroll)
165 gtk_binding_entry_add_signal (binding_set, keyval, mask,
167 GTK_TYPE_SCROLL_TYPE, scroll);
171 gtk_paned_class_init (GtkPanedClass *class)
173 GObjectClass *object_class;
174 GtkWidgetClass *widget_class;
175 GtkContainerClass *container_class;
176 GtkPanedClass *paned_class;
177 GtkBindingSet *binding_set;
179 object_class = (GObjectClass *) class;
180 widget_class = (GtkWidgetClass *) class;
181 container_class = (GtkContainerClass *) class;
182 paned_class = (GtkPanedClass *) class;
184 parent_class = g_type_class_peek_parent (class);
186 object_class->set_property = gtk_paned_set_property;
187 object_class->get_property = gtk_paned_get_property;
188 object_class->finalize = gtk_paned_finalize;
190 widget_class->realize = gtk_paned_realize;
191 widget_class->unrealize = gtk_paned_unrealize;
192 widget_class->map = gtk_paned_map;
193 widget_class->unmap = gtk_paned_unmap;
194 widget_class->expose_event = gtk_paned_expose;
195 widget_class->focus = gtk_paned_focus;
196 widget_class->enter_notify_event = gtk_paned_enter;
197 widget_class->leave_notify_event = gtk_paned_leave;
198 widget_class->button_press_event = gtk_paned_button_press;
199 widget_class->button_release_event = gtk_paned_button_release;
200 widget_class->motion_notify_event = gtk_paned_motion;
202 container_class->add = gtk_paned_add;
203 container_class->remove = gtk_paned_remove;
204 container_class->forall = gtk_paned_forall;
205 container_class->child_type = gtk_paned_child_type;
206 container_class->set_focus_child = gtk_paned_set_focus_child;
208 paned_class->cycle_child_focus = gtk_paned_cycle_child_focus;
209 paned_class->toggle_handle_focus = gtk_paned_toggle_handle_focus;
210 paned_class->move_handle = gtk_paned_move_handle;
211 paned_class->cycle_handle_focus = gtk_paned_cycle_handle_focus;
212 paned_class->accept_position = gtk_paned_accept_position;
213 paned_class->cancel_position = gtk_paned_cancel_position;
215 g_object_class_install_property (object_class,
217 g_param_spec_int ("position",
219 _("Position of paned separator in pixels (0 means all the way to the left/top)"),
223 G_PARAM_READABLE | G_PARAM_WRITABLE));
224 g_object_class_install_property (object_class,
226 g_param_spec_boolean ("position_set",
228 _("TRUE if the Position property should be used"),
230 G_PARAM_READABLE | G_PARAM_WRITABLE));
232 gtk_widget_class_install_style_property (widget_class,
233 g_param_spec_int ("handle_size",
235 _("Width of handle"),
241 signals [CYCLE_HANDLE_FOCUS] =
242 g_signal_new ("cycle_child_focus",
243 G_TYPE_FROM_CLASS (object_class),
244 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
245 G_STRUCT_OFFSET (GtkPanedClass, cycle_child_focus),
247 _gtk_marshal_BOOLEAN__BOOLEAN,
251 signals [TOGGLE_HANDLE_FOCUS] =
252 g_signal_new ("toggle_handle_focus",
253 G_TYPE_FROM_CLASS (object_class),
254 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
255 G_STRUCT_OFFSET (GtkPanedClass, toggle_handle_focus),
257 _gtk_marshal_BOOLEAN__VOID,
260 signals[MOVE_HANDLE] =
261 g_signal_new ("move_handle",
262 G_TYPE_FROM_CLASS (object_class),
263 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
264 G_STRUCT_OFFSET (GtkPanedClass, move_handle),
266 _gtk_marshal_BOOLEAN__ENUM,
268 GTK_TYPE_SCROLL_TYPE);
270 signals [CYCLE_HANDLE_FOCUS] =
271 g_signal_new ("cycle_handle_focus",
272 G_TYPE_FROM_CLASS (object_class),
273 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
274 G_STRUCT_OFFSET (GtkPanedClass, cycle_handle_focus),
276 _gtk_marshal_BOOLEAN__BOOLEAN,
280 signals [ACCEPT_POSITION] =
281 g_signal_new ("accept_position",
282 G_TYPE_FROM_CLASS (object_class),
283 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
284 G_STRUCT_OFFSET (GtkPanedClass, accept_position),
286 _gtk_marshal_BOOLEAN__VOID,
289 signals [CANCEL_POSITION] =
290 g_signal_new ("cancel_position",
291 G_TYPE_FROM_CLASS (object_class),
292 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
293 G_STRUCT_OFFSET (GtkPanedClass, cancel_position),
295 _gtk_marshal_BOOLEAN__VOID,
298 binding_set = gtk_binding_set_by_class (class);
301 gtk_binding_entry_add_signal (binding_set,
303 "cycle_child_focus", 1,
304 G_TYPE_BOOLEAN, FALSE);
305 gtk_binding_entry_add_signal (binding_set,
306 GDK_F6, GDK_SHIFT_MASK,
307 "cycle_child_focus", 1,
308 G_TYPE_BOOLEAN, TRUE);
311 gtk_binding_entry_add_signal (binding_set,
313 "cycle_handle_focus", 1,
314 G_TYPE_BOOLEAN, FALSE);
316 gtk_binding_entry_add_signal (binding_set,
317 GDK_F8, GDK_SHIFT_MASK,
318 "cycle_handle_focus", 1,
319 G_TYPE_BOOLEAN, TRUE);
321 add_tab_bindings (binding_set, 0);
322 add_tab_bindings (binding_set, GDK_CONTROL_MASK);
323 add_tab_bindings (binding_set, GDK_SHIFT_MASK);
324 add_tab_bindings (binding_set, GDK_CONTROL_MASK | GDK_SHIFT_MASK);
326 /* accept and cancel positions */
327 gtk_binding_entry_add_signal (binding_set,
329 "cancel_position", 0);
331 gtk_binding_entry_add_signal (binding_set,
333 "accept_position", 0);
334 gtk_binding_entry_add_signal (binding_set,
336 "accept_position", 0);
337 gtk_binding_entry_add_signal (binding_set,
339 "accept_position", 0);
340 gtk_binding_entry_add_signal (binding_set,
342 "accept_position", 0);
345 add_move_binding (binding_set, GDK_Left, 0, GTK_SCROLL_STEP_LEFT);
346 add_move_binding (binding_set, GDK_KP_Left, 0, GTK_SCROLL_STEP_LEFT);
347 add_move_binding (binding_set, GDK_Left, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_LEFT);
348 add_move_binding (binding_set, GDK_KP_Left, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_LEFT);
350 add_move_binding (binding_set, GDK_Right, 0, GTK_SCROLL_STEP_RIGHT);
351 add_move_binding (binding_set, GDK_Right, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_RIGHT);
352 add_move_binding (binding_set, GDK_KP_Right, 0, GTK_SCROLL_STEP_RIGHT);
353 add_move_binding (binding_set, GDK_KP_Right, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_RIGHT);
355 add_move_binding (binding_set, GDK_Up, 0, GTK_SCROLL_STEP_UP);
356 add_move_binding (binding_set, GDK_Up, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_UP);
357 add_move_binding (binding_set, GDK_KP_Up, 0, GTK_SCROLL_STEP_UP);
358 add_move_binding (binding_set, GDK_KP_Up, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_UP);
359 add_move_binding (binding_set, GDK_Page_Up, 0, GTK_SCROLL_PAGE_UP);
360 add_move_binding (binding_set, GDK_KP_Page_Up, 0, GTK_SCROLL_PAGE_UP);
362 add_move_binding (binding_set, GDK_Down, 0, GTK_SCROLL_STEP_DOWN);
363 add_move_binding (binding_set, GDK_Down, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_DOWN);
364 add_move_binding (binding_set, GDK_KP_Down, 0, GTK_SCROLL_STEP_DOWN);
365 add_move_binding (binding_set, GDK_KP_Down, GDK_CONTROL_MASK, GTK_SCROLL_PAGE_DOWN);
366 add_move_binding (binding_set, GDK_Page_Down, 0, GTK_SCROLL_PAGE_RIGHT);
367 add_move_binding (binding_set, GDK_KP_Page_Down, 0, GTK_SCROLL_PAGE_RIGHT);
369 add_move_binding (binding_set, GDK_Home, 0, GTK_SCROLL_START);
370 add_move_binding (binding_set, GDK_KP_Home, 0, GTK_SCROLL_START);
371 add_move_binding (binding_set, GDK_End, 0, GTK_SCROLL_END);
372 add_move_binding (binding_set, GDK_KP_End, 0, GTK_SCROLL_END);
376 gtk_paned_child_type (GtkContainer *container)
378 if (!GTK_PANED (container)->child1 || !GTK_PANED (container)->child2)
379 return GTK_TYPE_WIDGET;
385 gtk_paned_init (GtkPaned *paned)
387 GTK_WIDGET_SET_FLAGS (paned, GTK_NO_WINDOW | GTK_CAN_FOCUS);
389 paned->child1 = NULL;
390 paned->child2 = NULL;
391 paned->handle = NULL;
392 paned->xor_gc = NULL;
393 paned->cursor_type = GDK_CROSS;
395 paned->handle_pos.width = 5;
396 paned->handle_pos.height = 5;
397 paned->position_set = FALSE;
398 paned->last_allocation = -1;
399 paned->in_drag = FALSE;
401 paned->priv = g_new0 (GtkPanedPrivate, 1);
402 paned->last_child1_focus = NULL;
403 paned->last_child2_focus = NULL;
404 paned->in_recursion = FALSE;
405 paned->handle_prelit = FALSE;
406 paned->original_position = -1;
408 paned->handle_pos.x = -1;
409 paned->handle_pos.y = -1;
411 paned->drag_pos = -1;
415 gtk_paned_set_property (GObject *object,
420 GtkPaned *paned = GTK_PANED (object);
425 gtk_paned_set_position (paned, g_value_get_int (value));
427 case PROP_POSITION_SET:
428 paned->position_set = g_value_get_boolean (value);
429 gtk_widget_queue_resize (GTK_WIDGET (paned));
432 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
438 gtk_paned_get_property (GObject *object,
443 GtkPaned *paned = GTK_PANED (object);
448 g_value_set_int (value, paned->child1_size);
450 case PROP_POSITION_SET:
451 g_value_set_boolean (value, paned->position_set);
454 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
460 gtk_paned_finalize (GObject *object)
462 GtkPaned *paned = GTK_PANED (object);
464 gtk_paned_set_saved_focus (paned, NULL);
465 gtk_paned_set_first_paned (paned, NULL);
467 g_free (paned->priv);
469 G_OBJECT_CLASS (parent_class)->finalize (object);
473 gtk_paned_realize (GtkWidget *widget)
476 GdkWindowAttr attributes;
477 gint attributes_mask;
479 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
480 paned = GTK_PANED (widget);
482 widget->window = gtk_widget_get_parent_window (widget);
483 g_object_ref (widget->window);
485 attributes.window_type = GDK_WINDOW_CHILD;
486 attributes.wclass = GDK_INPUT_ONLY;
487 attributes.x = paned->handle_pos.x;
488 attributes.y = paned->handle_pos.y;
489 attributes.width = paned->handle_pos.width;
490 attributes.height = paned->handle_pos.height;
491 attributes.cursor = gdk_cursor_new_for_display (gtk_widget_get_display (widget),
493 attributes.event_mask = gtk_widget_get_events (widget);
494 attributes.event_mask |= (GDK_BUTTON_PRESS_MASK |
495 GDK_BUTTON_RELEASE_MASK |
496 GDK_ENTER_NOTIFY_MASK |
497 GDK_LEAVE_NOTIFY_MASK |
498 GDK_POINTER_MOTION_MASK |
499 GDK_POINTER_MOTION_HINT_MASK);
500 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_CURSOR;
502 paned->handle = gdk_window_new (widget->window,
503 &attributes, attributes_mask);
504 gdk_window_set_user_data (paned->handle, paned);
505 gdk_cursor_unref (attributes.cursor);
507 widget->style = gtk_style_attach (widget->style, widget->window);
509 if (paned->child1 && GTK_WIDGET_VISIBLE (paned->child1) &&
510 paned->child2 && GTK_WIDGET_VISIBLE (paned->child2))
511 gdk_window_show (paned->handle);
515 gtk_paned_unrealize (GtkWidget *widget)
517 GtkPaned *paned = GTK_PANED (widget);
521 g_object_unref (paned->xor_gc);
522 paned->xor_gc = NULL;
527 gdk_window_set_user_data (paned->handle, NULL);
528 gdk_window_destroy (paned->handle);
529 paned->handle = NULL;
532 gtk_paned_set_last_child1_focus (paned, NULL);
533 gtk_paned_set_last_child2_focus (paned, NULL);
534 gtk_paned_set_saved_focus (paned, NULL);
535 gtk_paned_set_first_paned (paned, NULL);
537 if (GTK_WIDGET_CLASS (parent_class)->unrealize)
538 (* GTK_WIDGET_CLASS (parent_class)->unrealize) (widget);
542 gtk_paned_map (GtkWidget *widget)
544 GtkPaned *paned = GTK_PANED (widget);
546 gdk_window_show (paned->handle);
548 GTK_WIDGET_CLASS (parent_class)->map (widget);
552 gtk_paned_unmap (GtkWidget *widget)
554 GtkPaned *paned = GTK_PANED (widget);
556 gdk_window_hide (paned->handle);
558 GTK_WIDGET_CLASS (parent_class)->unmap (widget);
562 gtk_paned_expose (GtkWidget *widget,
563 GdkEventExpose *event)
565 GtkPaned *paned = GTK_PANED (widget);
567 if (GTK_WIDGET_VISIBLE (widget) && GTK_WIDGET_MAPPED (widget) &&
568 paned->child1 && GTK_WIDGET_VISIBLE (paned->child1) &&
569 paned->child2 && GTK_WIDGET_VISIBLE (paned->child2))
573 region = gdk_region_rectangle (&paned->handle_pos);
574 gdk_region_intersect (region, event->region);
576 if (!gdk_region_empty (region))
581 gdk_region_get_clipbox (region, &clip);
583 if (gtk_widget_is_focus (widget))
584 state = GTK_STATE_SELECTED;
585 else if (paned->handle_prelit)
586 state = GTK_STATE_PRELIGHT;
588 state = GTK_WIDGET_STATE (widget);
590 gtk_paint_handle (widget->style, widget->window,
591 state, GTK_SHADOW_NONE,
592 &clip, widget, "paned",
593 paned->handle_pos.x, paned->handle_pos.y,
594 paned->handle_pos.width, paned->handle_pos.height,
598 gdk_region_destroy (region);
601 /* Chain up to draw children */
602 GTK_WIDGET_CLASS (parent_class)->expose_event (widget, event);
608 update_drag (GtkPaned *paned)
614 if (paned->orientation == GTK_ORIENTATION_HORIZONTAL)
615 gtk_widget_get_pointer (GTK_WIDGET (paned), NULL, &pos);
617 gtk_widget_get_pointer (GTK_WIDGET (paned), &pos, NULL);
619 gtk_widget_style_get (GTK_WIDGET (paned), "handle_size", &handle_size, NULL);
621 size = pos - GTK_CONTAINER (paned)->border_width - paned->drag_pos;
622 size = CLAMP (size, paned->min_position, paned->max_position);
624 if (size != paned->child1_size)
625 gtk_paned_set_position (paned, size);
629 gtk_paned_enter (GtkWidget *widget,
630 GdkEventCrossing *event)
632 GtkPaned *paned = GTK_PANED (widget);
638 paned->handle_prelit = TRUE;
639 gtk_widget_queue_draw_area (widget,
642 paned->handle_pos.width,
643 paned->handle_pos.height);
650 gtk_paned_leave (GtkWidget *widget,
651 GdkEventCrossing *event)
653 GtkPaned *paned = GTK_PANED (widget);
659 paned->handle_prelit = FALSE;
660 gtk_widget_queue_draw_area (widget,
663 paned->handle_pos.width,
664 paned->handle_pos.height);
671 gtk_paned_focus (GtkWidget *widget,
672 GtkDirectionType direction)
677 /* This is a hack, but how can this be done without
678 * excessive cut-and-paste from gtkcontainer.c?
681 GTK_WIDGET_UNSET_FLAGS (widget, GTK_CAN_FOCUS);
682 retval = (* GTK_WIDGET_CLASS (parent_class)->focus) (widget, direction);
683 GTK_WIDGET_SET_FLAGS (widget, GTK_CAN_FOCUS);
689 gtk_paned_button_press (GtkWidget *widget,
690 GdkEventButton *event)
692 GtkPaned *paned = GTK_PANED (widget);
694 if (!paned->in_drag &&
695 (event->window == paned->handle) && (event->button == 1))
697 paned->in_drag = TRUE;
699 /* We need a server grab here, not gtk_grab_add(), since
700 * we don't want to pass events on to the widget's children */
701 gdk_pointer_grab (paned->handle, FALSE,
702 GDK_POINTER_MOTION_HINT_MASK
703 | GDK_BUTTON1_MOTION_MASK
704 | GDK_BUTTON_RELEASE_MASK
705 | GDK_ENTER_NOTIFY_MASK
706 | GDK_LEAVE_NOTIFY_MASK,
710 if (paned->orientation == GTK_ORIENTATION_HORIZONTAL)
711 paned->drag_pos = event->y;
713 paned->drag_pos = event->x;
722 gtk_paned_button_release (GtkWidget *widget,
723 GdkEventButton *event)
725 GtkPaned *paned = GTK_PANED (widget);
727 if (paned->in_drag && (event->button == 1))
729 paned->in_drag = FALSE;
730 paned->drag_pos = -1;
731 paned->position_set = TRUE;
732 gdk_display_pointer_ungrab (gtk_widget_get_display (widget),
741 gtk_paned_motion (GtkWidget *widget,
742 GdkEventMotion *event)
744 GtkPaned *paned = GTK_PANED (widget);
756 gtk_paned_add1 (GtkPaned *paned,
759 gtk_paned_pack1 (paned, widget, FALSE, TRUE);
763 gtk_paned_add2 (GtkPaned *paned,
766 gtk_paned_pack2 (paned, widget, TRUE, TRUE);
770 gtk_paned_pack1 (GtkPaned *paned,
775 g_return_if_fail (GTK_IS_PANED (paned));
776 g_return_if_fail (GTK_IS_WIDGET (child));
780 paned->child1 = child;
781 paned->child1_resize = resize;
782 paned->child1_shrink = shrink;
784 gtk_widget_set_parent (child, GTK_WIDGET (paned));
789 gtk_paned_pack2 (GtkPaned *paned,
794 g_return_if_fail (GTK_IS_PANED (paned));
795 g_return_if_fail (GTK_IS_WIDGET (child));
799 paned->child2 = child;
800 paned->child2_resize = resize;
801 paned->child2_shrink = shrink;
803 gtk_widget_set_parent (child, GTK_WIDGET (paned));
809 gtk_paned_add (GtkContainer *container,
814 g_return_if_fail (GTK_IS_PANED (container));
816 paned = GTK_PANED (container);
819 gtk_paned_add1 (paned, widget);
820 else if (!paned->child2)
821 gtk_paned_add2 (paned, widget);
825 gtk_paned_remove (GtkContainer *container,
829 gboolean was_visible;
831 paned = GTK_PANED (container);
832 was_visible = GTK_WIDGET_VISIBLE (widget);
834 if (paned->child1 == widget)
836 gtk_widget_unparent (widget);
838 paned->child1 = NULL;
840 if (was_visible && GTK_WIDGET_VISIBLE (container))
841 gtk_widget_queue_resize (GTK_WIDGET (container));
843 else if (paned->child2 == widget)
845 gtk_widget_unparent (widget);
847 paned->child2 = NULL;
849 if (was_visible && GTK_WIDGET_VISIBLE (container))
850 gtk_widget_queue_resize (GTK_WIDGET (container));
855 gtk_paned_forall (GtkContainer *container,
856 gboolean include_internals,
857 GtkCallback callback,
858 gpointer callback_data)
862 g_return_if_fail (callback != NULL);
864 paned = GTK_PANED (container);
867 (*callback) (paned->child1, callback_data);
869 (*callback) (paned->child2, callback_data);
873 * gtk_paned_get_position:
874 * @paned: a #GtkPaned widget
876 * Obtains the position of the divider between the two panes.
878 * Return value: position of the divider
881 gtk_paned_get_position (GtkPaned *paned)
883 g_return_val_if_fail (GTK_IS_PANED (paned), 0);
885 return paned->child1_size;
889 * gtk_paned_set_position:
890 * @paned: a #GtkPaned widget
891 * @position: pixel position of divider, a negative value means that the position
894 * Sets the position of the divider between the two panes.
897 gtk_paned_set_position (GtkPaned *paned,
902 g_return_if_fail (GTK_IS_PANED (paned));
904 object = G_OBJECT (paned);
908 /* We don't clamp here - the assumption is that
909 * if the total allocation changes at the same time
910 * as the position, the position set is with reference
911 * to the new total size. If only the position changes,
912 * then clamping will occur in gtk_paned_compute_position()
915 paned->child1_size = position;
916 paned->position_set = TRUE;
920 paned->position_set = FALSE;
923 g_object_freeze_notify (object);
924 g_object_notify (object, "position");
925 g_object_notify (object, "position_set");
926 g_object_thaw_notify (object);
928 gtk_widget_queue_resize (GTK_WIDGET (paned));
932 gtk_paned_compute_position (GtkPaned *paned,
939 g_return_if_fail (GTK_IS_PANED (paned));
941 old_position = paned->child1_size;
943 paned->min_position = paned->child1_shrink ? 0 : child1_req;
945 paned->max_position = allocation;
946 if (!paned->child2_shrink)
947 paned->max_position = MAX (1, paned->max_position - child2_req);
949 if (!paned->position_set)
951 if (paned->child1_resize && !paned->child2_resize)
952 paned->child1_size = MAX (0, allocation - child2_req);
953 else if (!paned->child1_resize && paned->child2_resize)
954 paned->child1_size = child1_req;
955 else if (child1_req + child2_req != 0)
956 paned->child1_size = allocation * ((gdouble)child1_req / (child1_req + child2_req));
958 paned->child1_size = allocation * 0.5;
962 /* If the position was set before the initial allocation.
963 * (paned->last_allocation <= 0) just clamp it and leave it.
965 if (paned->last_allocation > 0)
967 if (paned->child1_resize && !paned->child2_resize)
968 paned->child1_size += allocation - paned->last_allocation;
969 else if (!(!paned->child1_resize && paned->child2_resize))
970 paned->child1_size = allocation * ((gdouble) paned->child1_size / (paned->last_allocation));
974 paned->child1_size = CLAMP (paned->child1_size,
976 paned->max_position);
978 gtk_widget_set_child_visible (paned->child1, paned->child1_size != 0);
979 gtk_widget_set_child_visible (paned->child2, paned->child1_size != allocation);
981 if (paned->child1_size != old_position)
982 g_object_notify (G_OBJECT (paned), "position");
984 paned->last_allocation = allocation;
988 gtk_paned_set_saved_focus (GtkPaned *paned, GtkWidget *widget)
990 if (paned->priv->saved_focus)
991 g_object_remove_weak_pointer (G_OBJECT (paned->priv->saved_focus),
992 (gpointer *)&(paned->priv->saved_focus));
994 paned->priv->saved_focus = widget;
996 if (paned->priv->saved_focus)
997 g_object_add_weak_pointer (G_OBJECT (paned->priv->saved_focus),
998 (gpointer *)&(paned->priv->saved_focus));
1002 gtk_paned_set_first_paned (GtkPaned *paned, GtkPaned *first_paned)
1004 if (paned->priv->first_paned)
1005 g_object_remove_weak_pointer (G_OBJECT (paned->priv->first_paned),
1006 (gpointer *)&(paned->priv->first_paned));
1008 paned->priv->first_paned = first_paned;
1010 if (paned->priv->first_paned)
1011 g_object_add_weak_pointer (G_OBJECT (paned->priv->first_paned),
1012 (gpointer *)&(paned->priv->first_paned));
1016 gtk_paned_set_last_child1_focus (GtkPaned *paned, GtkWidget *widget)
1018 if (paned->last_child1_focus)
1019 g_object_remove_weak_pointer (G_OBJECT (paned->last_child1_focus),
1020 (gpointer *)&(paned->last_child1_focus));
1022 paned->last_child1_focus = widget;
1024 if (paned->last_child1_focus)
1025 g_object_add_weak_pointer (G_OBJECT (paned->last_child1_focus),
1026 (gpointer *)&(paned->last_child1_focus));
1030 gtk_paned_set_last_child2_focus (GtkPaned *paned, GtkWidget *widget)
1032 if (paned->last_child2_focus)
1033 g_object_remove_weak_pointer (G_OBJECT (paned->last_child2_focus),
1034 (gpointer *)&(paned->last_child2_focus));
1036 paned->last_child2_focus = widget;
1038 if (paned->last_child2_focus)
1039 g_object_add_weak_pointer (G_OBJECT (paned->last_child2_focus),
1040 (gpointer *)&(paned->last_child2_focus));
1044 paned_get_focus_widget (GtkPaned *paned)
1046 GtkWidget *toplevel;
1048 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (paned));
1049 if (GTK_WIDGET_TOPLEVEL (toplevel))
1050 return GTK_WINDOW (toplevel)->focus_widget;
1056 gtk_paned_set_focus_child (GtkContainer *container,
1057 GtkWidget *focus_child)
1061 g_return_if_fail (GTK_IS_PANED (container));
1063 paned = GTK_PANED (container);
1065 if (focus_child == NULL)
1067 GtkWidget *last_focus;
1070 last_focus = paned_get_focus_widget (paned);
1074 /* If there is one or more paned widgets between us and the
1075 * focus widget, we want the topmost of those as last_focus
1077 for (w = last_focus; w != GTK_WIDGET (paned); w = w->parent)
1078 if (GTK_IS_PANED (w))
1081 if (container->focus_child == paned->child1)
1082 gtk_paned_set_last_child1_focus (paned, last_focus);
1083 else if (container->focus_child == paned->child2)
1084 gtk_paned_set_last_child2_focus (paned, last_focus);
1088 if (parent_class->set_focus_child)
1089 (* parent_class->set_focus_child) (container, focus_child);
1093 gtk_paned_get_cycle_chain (GtkPaned *paned,
1094 GtkDirectionType direction,
1097 GtkContainer *container = GTK_CONTAINER (paned);
1098 GtkWidget *ancestor = NULL;
1099 GList *temp_list = NULL;
1102 if (paned->in_recursion)
1105 g_assert (widgets != NULL);
1107 if (paned->last_child1_focus &&
1108 !gtk_widget_is_ancestor (paned->last_child1_focus, GTK_WIDGET (paned)))
1110 gtk_paned_set_last_child1_focus (paned, NULL);
1113 if (paned->last_child2_focus &&
1114 !gtk_widget_is_ancestor (paned->last_child2_focus, GTK_WIDGET (paned)))
1116 gtk_paned_set_last_child2_focus (paned, NULL);
1119 if (GTK_WIDGET (paned)->parent)
1120 ancestor = gtk_widget_get_ancestor (GTK_WIDGET (paned)->parent, GTK_TYPE_PANED);
1122 /* The idea here is that temp_list is a list of widgets we want to cycle
1123 * to. The list is prioritized so that the first element is our first
1124 * choice, the next our second, and so on.
1126 * We can't just use g_list_reverse(), because we want to try
1127 * paned->last_child?_focus before paned->child?, both when we
1128 * are going forward and backward.
1130 if (direction == GTK_DIR_TAB_FORWARD)
1132 if (container->focus_child == paned->child1)
1134 temp_list = g_list_append (temp_list, paned->last_child2_focus);
1135 temp_list = g_list_append (temp_list, paned->child2);
1136 temp_list = g_list_append (temp_list, ancestor);
1138 else if (container->focus_child == paned->child2)
1140 temp_list = g_list_append (temp_list, ancestor);
1141 temp_list = g_list_append (temp_list, paned->last_child1_focus);
1142 temp_list = g_list_append (temp_list, paned->child1);
1146 temp_list = g_list_append (temp_list, paned->last_child1_focus);
1147 temp_list = g_list_append (temp_list, paned->child1);
1148 temp_list = g_list_append (temp_list, paned->last_child2_focus);
1149 temp_list = g_list_append (temp_list, paned->child2);
1150 temp_list = g_list_append (temp_list, ancestor);
1155 if (container->focus_child == paned->child1)
1157 temp_list = g_list_append (temp_list, ancestor);
1158 temp_list = g_list_append (temp_list, paned->last_child2_focus);
1159 temp_list = g_list_append (temp_list, paned->child2);
1161 else if (container->focus_child == paned->child2)
1163 temp_list = g_list_append (temp_list, paned->last_child1_focus);
1164 temp_list = g_list_append (temp_list, paned->child1);
1165 temp_list = g_list_append (temp_list, ancestor);
1169 temp_list = g_list_append (temp_list, paned->last_child2_focus);
1170 temp_list = g_list_append (temp_list, paned->child2);
1171 temp_list = g_list_append (temp_list, paned->last_child1_focus);
1172 temp_list = g_list_append (temp_list, paned->child1);
1173 temp_list = g_list_append (temp_list, ancestor);
1177 /* Walk the list and expand all the paned widgets. */
1178 for (list = temp_list; list != NULL; list = list->next)
1180 GtkWidget *widget = list->data;
1184 if (GTK_IS_PANED (widget))
1186 paned->in_recursion = TRUE;
1187 gtk_paned_get_cycle_chain (GTK_PANED (widget), direction, widgets);
1188 paned->in_recursion = FALSE;
1192 *widgets = g_list_append (*widgets, widget);
1197 g_list_free (temp_list);
1201 gtk_paned_cycle_child_focus (GtkPaned *paned,
1204 GList *cycle_chain = NULL;
1207 GtkDirectionType direction = reversed? GTK_DIR_TAB_BACKWARD : GTK_DIR_TAB_FORWARD;
1209 /* ignore f6 if the handle is focused */
1210 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1213 /* we can't just let the event propagate up the hierarchy,
1214 * because the paned will want to cycle focus _unless_ an
1215 * ancestor paned handles the event
1217 gtk_paned_get_cycle_chain (paned, direction, &cycle_chain);
1219 for (list = cycle_chain; list != NULL; list = list->next)
1220 if (gtk_widget_child_focus (GTK_WIDGET (list->data), direction))
1223 g_list_free (cycle_chain);
1229 get_child_panes (GtkWidget *widget,
1232 if (GTK_IS_PANED (widget))
1234 GtkPaned *paned = GTK_PANED (widget);
1236 get_child_panes (paned->child1, panes);
1237 *panes = g_list_prepend (*panes, widget);
1238 get_child_panes (paned->child2, panes);
1240 else if (GTK_IS_CONTAINER (widget))
1242 gtk_container_foreach (GTK_CONTAINER (widget),
1243 (GtkCallback)get_child_panes, panes);
1248 get_all_panes (GtkPaned *paned)
1250 GtkPaned *topmost = NULL;
1251 GList *result = NULL;
1254 for (w = GTK_WIDGET (paned); w != NULL; w = w->parent)
1256 if (GTK_IS_PANED (w))
1257 topmost = GTK_PANED (w);
1262 get_child_panes (GTK_WIDGET (topmost), &result);
1264 return g_list_reverse (result);
1268 gtk_paned_find_neighbours (GtkPaned *paned,
1275 all_panes = get_all_panes (paned);
1276 g_assert (all_panes);
1278 this_link = g_list_find (all_panes, paned);
1280 g_assert (this_link);
1282 if (this_link->next)
1283 *next = this_link->next->data;
1285 *next = all_panes->data;
1287 if (this_link->prev)
1288 *prev = this_link->prev->data;
1290 *prev = g_list_last (all_panes)->data;
1292 g_list_free (all_panes);
1296 gtk_paned_move_handle (GtkPaned *paned,
1297 GtkScrollType scroll)
1299 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1305 SINGLE_STEP_SIZE = 1,
1309 old_position = gtk_paned_get_position (paned);
1313 case GTK_SCROLL_STEP_LEFT:
1314 case GTK_SCROLL_STEP_UP:
1315 case GTK_SCROLL_STEP_BACKWARD:
1316 new_position = old_position - SINGLE_STEP_SIZE;
1319 case GTK_SCROLL_STEP_RIGHT:
1320 case GTK_SCROLL_STEP_DOWN:
1321 case GTK_SCROLL_STEP_FORWARD:
1322 new_position = old_position + SINGLE_STEP_SIZE;
1325 case GTK_SCROLL_PAGE_LEFT:
1326 case GTK_SCROLL_PAGE_UP:
1327 case GTK_SCROLL_PAGE_BACKWARD:
1328 new_position = old_position - PAGE_STEP_SIZE;
1331 case GTK_SCROLL_PAGE_RIGHT:
1332 case GTK_SCROLL_PAGE_DOWN:
1333 case GTK_SCROLL_PAGE_FORWARD:
1334 new_position = old_position + PAGE_STEP_SIZE;
1337 case GTK_SCROLL_START:
1338 new_position = paned->min_position;
1341 case GTK_SCROLL_END:
1342 new_position = paned->max_position;
1346 new_position = old_position;
1350 new_position = CLAMP (new_position, paned->min_position, paned->max_position);
1352 if (old_position != new_position)
1353 gtk_paned_set_position (paned, new_position);
1362 gtk_paned_restore_focus (GtkPaned *paned)
1364 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1366 if (paned->priv->saved_focus &&
1367 GTK_WIDGET_SENSITIVE (paned->priv->saved_focus))
1369 gtk_widget_grab_focus (paned->priv->saved_focus);
1373 /* the saved focus is somehow not available for focusing,
1375 * 1) tabbing into the paned widget
1376 * if that didn't work,
1377 * 2) unset focus for the window if there is one
1380 if (!gtk_widget_child_focus (GTK_WIDGET (paned), GTK_DIR_TAB_FORWARD))
1382 GtkWidget *toplevel = gtk_widget_get_toplevel (GTK_WIDGET (paned));
1384 if (GTK_IS_WINDOW (toplevel))
1385 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
1389 gtk_paned_set_saved_focus (paned, NULL);
1390 gtk_paned_set_first_paned (paned, NULL);
1395 gtk_paned_accept_position (GtkPaned *paned)
1397 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1399 paned->original_position = -1;
1400 gtk_paned_restore_focus (paned);
1410 gtk_paned_cancel_position (GtkPaned *paned)
1412 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1414 if (paned->original_position != -1)
1416 gtk_paned_set_position (paned, paned->original_position);
1417 paned->original_position = -1;
1420 gtk_paned_restore_focus (paned);
1428 gtk_paned_cycle_handle_focus (GtkPaned *paned,
1431 GtkPaned *next, *prev;
1433 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1435 GtkPaned *focus = NULL;
1437 if (!paned->priv->first_paned)
1439 /* The first_pane has disappeared. As an ad-hoc solution,
1440 * we make the currently focused paned the first_paned. To the
1441 * user this will seem like the paned cycling has been reset.
1444 gtk_paned_set_first_paned (paned, paned);
1447 gtk_paned_find_neighbours (paned, &next, &prev);
1449 if (reversed && prev &&
1450 prev != paned && paned != paned->priv->first_paned)
1454 else if (!reversed && next &&
1455 next != paned && next != paned->priv->first_paned)
1461 gtk_paned_accept_position (paned);
1467 gtk_paned_set_saved_focus (focus, paned->priv->saved_focus);
1468 gtk_paned_set_first_paned (focus, paned->priv->first_paned);
1470 gtk_paned_set_saved_focus (paned, NULL);
1471 gtk_paned_set_first_paned (paned, NULL);
1473 gtk_widget_grab_focus (GTK_WIDGET (focus));
1475 if (!gtk_widget_is_focus (GTK_WIDGET (paned)))
1477 paned->original_position = -1;
1478 focus->original_position = gtk_paned_get_position (focus);
1483 GtkContainer *container = GTK_CONTAINER (paned);
1486 GtkPaned *prev, *next;
1487 GtkWidget *toplevel;
1489 gtk_paned_find_neighbours (paned, &next, &prev);
1491 if (container->focus_child == paned->child1)
1504 else if (container->focus_child == paned->child2)
1519 /* Focus is not inside this paned, and we don't have focus.
1520 * Presumably this happened because the application wants us
1521 * to start keyboard navigating.
1531 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (paned));
1533 if (GTK_IS_WINDOW (toplevel))
1534 gtk_paned_set_saved_focus (focus, GTK_WINDOW (toplevel)->focus_widget);
1535 gtk_paned_set_first_paned (focus, first);
1536 focus->original_position = gtk_paned_get_position (focus);
1538 gtk_widget_grab_focus (GTK_WIDGET (focus));
1545 gtk_paned_toggle_handle_focus (GtkPaned *paned)
1547 /* This function/signal has the wrong name. It is called when you
1548 * press Tab or Shift-Tab and what we do is act as if
1549 * the user pressed Return and then Tab or Shift-Tab
1551 if (gtk_widget_is_focus (GTK_WIDGET (paned)))
1552 gtk_paned_accept_position (paned);